Mini Shell

.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SALT" "7" "Generated on May 19, 2024 at 12:51:08 PM UTC." "3007.1" "Salt"
.SH NAME
salt \- Salt Documentation
.SH SALT PROJECT
\fI\%Salt Project License: Apache v2.0\fP\fI\%PyPi Package Downloads\fP\fI\%PyPi Package Downloads\fP\fI\%Salt Project Slack Community\fP\fI\%Salt Project Twitch Channel\fP\fI\%Salt Project subreddit\fP\fI\%Follow SaltStack on Twitter\fP.INDENT 0.0
.INDENT 2.5
[image: Salt Project Logo]
[image]
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
\fI\%Latest Salt Documentation\fP
.IP \(bu 2
\fI\%Open an issue\fP (bug report, feature request, etc.)
.UNINDENT
.sp
\fISalt is the world\(aqs fastest, most intelligent and scalable automation\fP
\fIengine.\fP
.SS About Salt
.sp
Built on Python, Salt is an event\-driven automation tool and framework to
deploy, configure, and manage complex IT systems. Use Salt to automate common
infrastructure administration tasks and ensure that all the components of your
infrastructure are operating in a consistent desired state.
.sp
Salt has many possible uses, including configuration management, which involves:
.INDENT 0.0
.IP \(bu 2
Managing operating system deployment and configuration.
.IP \(bu 2
Installing and configuring software applications and services.
.IP \(bu 2
Managing servers, virtual machines, containers, databases, web servers,
network devices, and more.
.IP \(bu 2
Ensuring consistent configuration and preventing configuration drift.
.UNINDENT
.sp
Salt is ideal for configuration management because it is pluggable,
customizable, and plays well with many existing technologies. Salt enables you
to deploy and manage applications that use any tech stack running on nearly any
\fI\%operating system\fP,
including different types of network devices such as switches and routers from a
variety of vendors.
.sp
In addition to configuration management Salt can also:
.INDENT 0.0
.IP \(bu 2
Automate and orchestrate routine IT processes, such as common required tasks
for scheduled server downtimes or upgrading operating systems or applications.
.IP \(bu 2
Create self\-aware, self\-healing systems that can automatically respond to
outages, common administration problems, or other important events.
.UNINDENT
.SS About our sponsors
.sp
Salt powers VMware\(aqs \fI\%VMware Aria Automation Config\fP
(previously vRealize Automation SaltStack Config / SaltStack Enterprise), and can be found
under the hood of products from Juniper, Cisco, Cloudflare, Nutanix, SUSE, and
Tieto, to name a few.
.sp
The original sponsor of our community, SaltStack, was \fI\%acquired by VMware in 2020\fP\&.
The Salt Project remains an open source ecosystem that VMware supports and
contributes to. VMware ensures the code integrity and quality of the Salt
modules by acting as the official sponsor and manager of the Salt project. Many
of the core Salt Project contributors are also VMware employees. This team
carefully reviews and enhances the Salt modules to ensure speed, quality, and
security.
.SS Download and install Salt
.sp
Salt is tested and packaged to run on CentOS, Debian, RHEL, Ubuntu, MacOS,
Windows, and more. Download Salt and get started now. See
\fI\%supported operating systems\fP
for more information.
.sp
To download and install Salt, see:
* \fI\%The Salt install guide\fP
* \fI\%Salt Project repository\fP
.SS Technical support
.sp
Report bugs or problems using Salt by opening an issue: \fI\%https://github.com/saltstack/salt/issues\fP
.sp
To join our community forum where you can exchange ideas, best practices,
discuss technical support questions, and talk to project maintainers, join our
Slack workspace: \fI\%Salt Project Community Slack\fP
.SS Salt Project documentation
.sp
Installation instructions, tutorials, in\-depth API and module documentation:
.INDENT 0.0
.IP \(bu 2
\fI\%The Salt install guide\fP
.IP \(bu 2
\fI\%The Salt user guide\fP
.IP \(bu 2
\fI\%Latest Salt documentation\fP
.IP \(bu 2
\fI\%Salt\(aqs contributing guide\fP
.UNINDENT
.SS Security advisories
.sp
Keep an eye on the Salt Project
\fI\%Security Announcements\fP
landing page. Salt Project recommends subscribing to the
\fI\%Salt Project Security RSS feed\fP
to receive notification when new information is available regarding security
announcements.
.sp
Other channels to receive security announcements include the
\fI\%Salt Community mailing list\fP
and the \fI\%Salt Project Community Slack\fP\&.
.SS Responsibly reporting security vulnerabilities
.sp
When reporting security vulnerabilities for Salt or other SaltStack projects,
refer to the \fI\%SECURITY.md\fP file found in this repository.
.SS Join our community
.sp
Salt is built by the Salt Project community, which includes more than 3,000
contributors working in roles just like yours. This well\-known and trusted
community works together to improve the underlying technology and extend Salt by
creating a variety of execution and state modules to accomplish the most common
tasks or solve the most important problems that people in your role are likely
to face.
.sp
If you want to help extend Salt or solve a problem with Salt, you can join our
community and contribute today.
.sp
Please be sure to review our
\fI\%Code of Conduct\fP\&.
Also, check out some of our community resources including:
.INDENT 0.0
.IP \(bu 2
\fI\%Salt Project Community Wiki\fP
.IP \(bu 2
\fI\%Salt Project Community Slack\fP
.IP \(bu 2
\fI\%Salt Project: IRC on LiberaChat\fP
.IP \(bu 2
\fI\%Salt Project YouTube channel\fP
.IP \(bu 2
\fI\%Salt Project Twitch channel\fP
.UNINDENT
.sp
There are lots of ways to get involved in our community. Every month, there are
around a dozen opportunities to meet with other contributors and the Salt Core
team and collaborate in real time. The best way to keep track is by subscribing
to the \fBSalt Project Community Events Calendar\fP on the main
\fI\%https://saltproject.io\fP website.
.sp
If you have additional questions, email us at \fI\%saltproject@vmware.com\fP or reach out
directly to the Community Manager, Jimmy Chunga via Slack. We\(aqd be glad to
have you join our community!
.SS License
.sp
Salt is licensed under the Apache 2.0 license. Please
see the
\fI\%LICENSE file\fP for the
full text of the Apache license, followed by a full summary of the licensing
used by external modules.
.sp
A complete list of attributions and dependencies can be found here:
\fI\%salt/DEPENDENCIES.md\fP
.SH INTRODUCTION TO SALT
.sp
We’re not just talking about NaCl.
.SS The 30 second summary
.sp
Salt is:
.INDENT 0.0
.IP \(bu 2
\fBA configuration management system.\fP Salt is capable of maintaining remote
nodes in defined states. For example, it can ensure that specific packages are
installed and that specific services are running.
.IP \(bu 2
\fBA distributed remote execution system used to execute commands and
query data on remote nodes.\fP Salt can query and execute commands either on
individual nodes or by using an arbitrary selection criteria.
.UNINDENT
.sp
It was developed in order to bring the best solutions found in the
world of remote execution together and make them better, faster, and more
malleable. Salt accomplishes this through its ability to handle large loads of
information, and not just dozens but hundreds and even thousands of individual
servers quickly through a simple and manageable interface.
.SS Simplicity
.sp
Providing versatility between massive scale deployments and smaller systems may seem
daunting, but Salt is very simple to set up and maintain, regardless of the
size of the project. The architecture of Salt is designed to work with any
number of servers, from a handful of local network systems to international
deployments across different data centers. The topology is a simple
server/client model with the needed functionality built into a single set of
daemons. While the default configuration will work with little to no
modification, Salt can be fine tuned to meet specific needs.
.SS Parallel execution
.sp
The core functions of Salt:
.INDENT 0.0
.IP \(bu 2
enable commands to remote systems to be called in parallel rather than serially
.IP \(bu 2
use a secure and encrypted protocol
.IP \(bu 2
use the smallest and fastest network payloads possible
.IP \(bu 2
provide a simple programming interface
.UNINDENT
.sp
Salt also introduces more granular controls to the realm of remote
execution, allowing systems to be targeted not just by hostname, but
also by system properties.
.SS Builds on proven technology
.sp
Salt takes advantage of a number of technologies and techniques. The
networking layer is built with the excellent \fI\%ZeroMQ\fP networking
library, so the Salt daemon includes a viable and transparent AMQ
broker. Salt uses public keys for authentication with the master
daemon, then uses faster \fI\%AES\fP encryption for payload communication;
authentication and encryption are integral to Salt.  Salt takes
advantage of communication via \fI\%msgpack\fP, enabling fast and light
network traffic.
.SS Python client interface
.sp
In order to allow for simple expansion, Salt execution routines can be written
as plain Python modules. The data collected from Salt executions can be sent
back to the master server, or to any arbitrary program. Salt can be called from
a simple Python API, or from the command line, so that Salt can be used to
execute one\-off commands as well as operate as an integral part of a larger
application.
.SS Fast, flexible, scalable
.sp
The result is a system that can execute commands at high speed on
target server groups ranging from one to very many servers. Salt is
very fast, easy to set up, amazingly malleable and provides a single
remote execution architecture that can manage the diverse
requirements of any number of servers.  The Salt infrastructure
brings together the best of the remote execution world, amplifies its
capabilities and expands its range, resulting in a system that is as
versatile as it is practical, suitable for any network.
.SS Open
.sp
Salt is developed under the \fI\%Apache 2.0 license\fP, and can be used for
open and proprietary projects. Please submit your expansions back to
the Salt project so that we can all benefit together as Salt grows.
Please feel free to sprinkle Salt around your systems and let the
deliciousness come forth.
.SH SALT SYSTEM ARCHITECTURE
.SS Overview
.sp
This page provides a high\-level overview of the Salt system architecture and its
different components.
.SS What is Salt?
.sp
Salt is a Python\-based open\-source remote execution framework used for:
.INDENT 0.0
.IP \(bu 2
Configuration management
.IP \(bu 2
Automation
.IP \(bu 2
Provisioning
.IP \(bu 2
Orchestration
.UNINDENT
.SS The Salt system architecture
.sp
The following diagram shows the primary components of the basic Salt
architecture:
[image]
.sp
The following sections describe some of the core components of the Salt
architecture.
.SS Salt Masters and Salt Minions
.sp
Salt uses the master\-client model in which a master issues commands to a client
and the client executes the command. In the Salt ecosystem, the Salt Master is a
server that is running the \fBsalt\-master\fP service. It issues commands to one or
more Salt Minions, which are servers that are running the \fBsalt\-minion\fP
service and that are registered with that particular Salt Master.
.sp
Another way to describe Salt is as a publisher\-subscriber model. The master
publishes jobs that need to be executed and Salt Minions subscribe to those
jobs. When a specific job applies to that minion, it will execute the job.
.sp
When a minion finishes executing a job, it sends job return data back to the
master. Salt has two ports used by default for the minions to communicate with
their master(s). These ports work in concert to receive and deliver data to the
Message Bus. Salt’s message bus is ZeroMQ, which creates an asynchronous network
topology to provide the fastest communication possible.
.SS Targets and grains
.sp
The master indicates which minions should execute the job by defining a
\fItarget\fP\&. A target is the group of minions, across one or many masters, that a
job\(aqs Salt command applies to.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
A master can also be managed like a minion and can be a target if it is
running the \fBsalt\-minion\fP service.
.UNINDENT
.UNINDENT
.sp
The following is an example of one of the many kinds of commands that a master
might issue to a minion. This command indicates that all minions should install
the Vim application:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-v \(aq*\(aq pkg.install vim
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this case the glob \fB\(aq*\(aq\fP is the target, which indicates that all minions
should execute this command. Many other targeting options are available,
including targeting a specific minion by its ID or targeting minions by their
shared traits or characteristics (called \fIgrains\fP in Salt).
.sp
Salt comes with an interface to derive information about the underlying system.
This is called the \fIgrains interface\fP, because it presents Salt with grains of
information. Grains are collected for the operating system, domain name,
IP address, kernel, OS type, memory, and many other system properties. You can
also create your own custom grain data.
.sp
Grain data is relatively static. However, grain data is refreshed when system
information changes (such as network settings) or when a new value is assigned
to a custom grain.
.SS Open event system (event bus)
.sp
The event system is used for inter\-process communication between the Salt Master
and Salt Minions. In the event system:
.INDENT 0.0
.IP \(bu 2
Events are seen by both the master and minions.
.IP \(bu 2
Events can be monitored and evaluated by both.
.UNINDENT
.sp
The event bus lays the groundwork for orchestration and real\-time monitoring.
.sp
All minions see jobs and results by subscribing to events published on the event
system. Salt uses a pluggable event system with two layers:
.INDENT 0.0
.IP \(bu 2
\fBZeroMQ (0MQ)\fP \- The current default socket\-level library providing a
flexible transport layer.
.IP \(bu 2
\fBTornado\fP \- Full TCP\-based transport layer event system.
.UNINDENT
.sp
One of the greatest strengths of Salt is the speed of execution. The event
system’s communication bus is more efficient than running a higher\-level web
service (http). The remote execution system is the component that all components
are built upon, allowing for decentralized remote execution to spread load
across resources.
.SS Salt states
.sp
In addition to remote execution, Salt provides another method for configuring
minions by declaring which \fIstate\fP a minion should be in, otherwise referred to
as \fISalt states\fP\&. Salt states make configuration management possible. You can
use Salt states to deploy and manage infrastructure with simple YAML files.
Using states, you can automate recursive and predictable tasks by queueing jobs
for Salt to implement without needing user input. You can also add more complex
conditional logic to state files with Jinja.
.sp
To illustrate the subtle differences between remote execution and configuration
management, take the command referenced in the previous section about
\fI\%Targets and grains\fP in which Salt installed the application Vim on all
minions:
.TS
center;
|l|l|l|.
_
T{
Methodology
T}	T{
Implementation
T}	T{
Result
T}
_
T{
Remote execution
T}	T{
.INDENT 0.0
.IP \(bu 2
Run \fBsalt \-v \(aq*\(aq pkg.install vim\fP from the terminal
.UNINDENT
T}	T{
.INDENT 0.0
.IP \(bu 2
Remotely installs Vim on the targeted minions
.UNINDENT
T}
_
T{
Configuration management
T}	T{
.INDENT 0.0
.IP \(bu 2
Write a YAML state file that checks whether Vim is installed
.IP \(bu 2
This state file is then applied to the targeted minions
.UNINDENT
T}	T{
.INDENT 0.0
.IP \(bu 2
Ensures that Vim is always installed on the targeted minions
.IP \(bu 2
Salt analyzes the state file and determines what actions need to be
taken to ensure the minion complies with the state declarations
.IP \(bu 2
If Vim is not installed, it automates the processes to install Vim on
the targeted minions
.UNINDENT
T}
_
.TE
.sp
The state file that verifies Vim is installed might look like the following
example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# File:/srv/salt/vim_install.sls

install_vim_now:
  pkg.installed:
    \- pkgs:
      \- vim
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To apply this state to a minion, you would use the \fBstate.apply\fP module, such
as in the following example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply vim_install
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This command applies the \fBvim_install\fP state to all minions.
.sp
\fIFormulas\fP are collections of states that work in harmony to configure a minion
or application. For example, one state might trigger another state.
.SS The Top file
.sp
It is not practical to manually run each state individually targeting specific
minions each time. Some environments have hundreds of state files targeting
thousands of minions.
.sp
Salt offers two features to help with this scaling problem:
.INDENT 0.0
.IP \(bu 2
\fBThe top.sls file\fP \- Maps Salt states to their applicable minions.
.IP \(bu 2
\fBHighstate execution\fP \- Runs all Salt states outlined in \fBtop.sls\fP in a
single execution.
.UNINDENT
.sp
The top file maps which states should be applied to different minions in certain
environments. The following is an example of a simple top file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# File: /srv/salt/top.sls

base:
  \(aq*\(aq:
    \- all_server_setup

  \(aq01webserver\(aq:
    \- web_server_setup
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example, \fBbase\fP refers to the Salt environment, which is the default.
You can specify more than one environment as needed, such as prod, dev, QA, etc.
.sp
Groups of minions are specified under the environment, and states are listed for
each set of minions. This top file indicates that a state called
\fBall_server_setup\fP should be applied to all minions \fB\(aq*\(aq\fP and the state
called \fBweb_server_setup\fP should be applied to the \fB01webserver\fP minion.
.sp
To run the Salt command, you would use the state.highstate function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \e* state.highstate
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This command applies the top file to the targeted minions.
.SS Salt pillar
.sp
Salt’s pillar feature takes data defined on the Salt Master and distributes it
to minions as needed. Pillar is primarily used to store secrets or other highly
sensitive data, such as account credentials, cryptographic keys, or passwords.
Pillar is also useful for storing non\-secret data that you don\(aqt want to place
directly in your state files, such as configuration data.
.sp
Salt pillar brings data into the cluster from the opposite direction as grains.
While grains are data generated from the minion, the pillar is data generated
from the master.
.sp
Pillars are organized similarly to states in a Pillar state tree, where
\fBtop.sls\fP acts to coordinate pillar data to environments and minions privy to
the data. Information transferred using pillar has a dictionary generated for
the targeted minion and encrypted with that minion’s key for secure data
transfer. Pillar data is encrypted on a per\-minion basis, which makes it useful
for storing sensitive data specific to a particular minion.
.SS Beacons and reactors
.sp
The beacon system is a monitoring tool that can listen for a variety of system
processes on Salt Minions. Beacons can trigger reactors which can then help
implement a change or troubleshoot an issue. For example, if a service’s
response times out, the reactor system can restart the service.
.sp
Beacons are used for a variety of purposes, including:
.INDENT 0.0
.IP \(bu 2
Automated reporting
.IP \(bu 2
Error log delivery
.IP \(bu 2
Microservice monitoring
.IP \(bu 2
User shell activity
.IP \(bu 2
Resource monitoring
.UNINDENT
.sp
When coupled with reactors, beacons can create automated pre\-written responses
to infrastructure and application issues. Reactors expand Salt with automated
responses using pre\-written remediation states.
.sp
Reactors can be applied in a variety of scenarios:
.INDENT 0.0
.IP \(bu 2
Infrastructure scaling
.IP \(bu 2
Notifying administrators
.IP \(bu 2
Restarting failed applications
.IP \(bu 2
Automatic rollback
.UNINDENT
.sp
When both beacons and reactors are used together , you can create unique states
customized to your specific needs.
.SS Salt runners and orchestration
.sp
Salt runners are convenience applications executed with the \fBsalt\-run\fP
command. Salt runners work similarly to Salt execution modules. However, they
execute on the Salt Master instead of the Salt Minions. A Salt runner can be a
simple client call or a complex application.
.sp
Salt provides the ability to orchestrate system administrative tasks throughout
the enterprise. Orchestration makes it possible to coordinate the activities of
multiple machines from a central place. It has the added advantage of being able
to control the sequence of when certain configuration events occur.
Orchestration states execute on the master using the state runner module.
.SH CONTRIBUTING
.sp
So you want to contribute to the Salt project? Excellent! You can help
in a number of ways:
.INDENT 0.0
.IP \(bu 2
Use Salt and open well\-written bug reports.
.IP \(bu 2
Join a \fI\%working group\fP\&.
.IP \(bu 2
Answer questions on \fI\%irc\fP,
the \fI\%community Slack\fP,
the \fI\%salt\-users mailing
list\fP,
\fI\%Server Fault\fP,
or \fI\%r/saltstack on Reddit\fP\&.
.IP \(bu 2
Fix bugs.
.IP \(bu 2
\fI\%Improve the documentation\fP\&.
.IP \(bu 2
Provide workarounds, patches, or other code without tests.
.IP \(bu 2
Tell other people about problems you solved using Salt.
.UNINDENT
.sp
If you\(aqd like to update docs or fix an issue, you\(aqre going to need the
Salt repo. The best way to contribute is using
\fI\%Git\fP\&.
.SS Environment setup
.sp
To hack on Salt or the docs you\(aqre going to need to set up your
development environment. If you already have a workflow that you\(aqre
comfortable with, you can use that, but otherwise this is an opinionated
guide for setting up your dev environment. Follow these steps and you\(aqll
end out with a functioning dev environment and be able to submit your
first PR.
.sp
This guide assumes at least a passing familiarity with
\fI\%Git\fP, a common version control tool used
across many open source projects, and is necessary for contributing to
Salt. For an introduction to Git, watch \fI\%Salt Docs Clinic \- Git For the
True
Beginner\fP\&.
Because of its widespread use, there are many resources for learning
more about Git. One popular resource is the free online book \fI\%Learn Git
in a Month of
Lunches\fP\&.
.SS pyenv, Virtual Environments, and you
.sp
We recommend \fI\%pyenv\fP, since it allows
installing multiple different Python versions, which is important for
testing Salt across all the versions of Python that we support.
.SS On Linux
.sp
Install pyenv:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git clone https://github.com/pyenv/pyenv.git ~/.pyenv
export PATH=\(dq$HOME/.pyenv/bin:$PATH\(dq
git clone https://github.com/pyenv/pyenv\-virtualenv.git $(pyenv root)/plugins/pyenv\-virtualenv
.ft P
.fi
.UNINDENT
.UNINDENT
.SS On Mac
.sp
Install pyenv using brew:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
brew update
brew install pyenv
brew install pyenv\-virtualenv
.ft P
.fi
.UNINDENT
.UNINDENT

.sp
.ce
----

.ce 0
.sp
.sp
Now add pyenv to your \fB\&.bashrc\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
echo \(aqexport PATH=\(dq$HOME/.pyenv/bin:$PATH\(dq\(aq >> ~/.bashrc
pyenv init 2>> ~/.bashrc
pyenv virtualenv\-init 2>> ~/.bashrc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For other shells, see \fI\%the pyenv
instructions\fP\&.
.sp
Go ahead and restart your shell. Now you should be able to install a new
version of Python:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pyenv install 3.9.18
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If that fails, don\(aqt panic! You\(aqre probably just missing some build
dependencies. Check out \fI\%pyenv common build
problems\fP\&.
.sp
Now that you\(aqve got your version of Python installed, you can create a
new virtual environment with this command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pyenv virtualenv 3.9.18 salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then activate it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pyenv activate salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Sweet! Now you\(aqre ready to clone Salt so you can start hacking away! If
you get stuck at any point, check out the resources at the beginning of
this guide. IRC and Slack are particularly helpful places to go.
.SS Get the source!
.sp
Salt uses the fork and clone workflow for Git contributions. See \fI\%Using
the Fork\-and\-Branch Git
Workflow\fP
for how to implement it. But if you just want to hurry and get started
you can go ahead and follow these steps:
.sp
Clones are so shallow. Well, this one is anyway:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git clone \-\-depth=1 \-\-origin salt https://github.com/saltstack/salt.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This creates a shallow clone of Salt, which should be fast. Most of the
time that\(aqs all you\(aqll need, and you can start building out other
commits as you go. If you \fIreally\fP want all 108,300+ commits you can
just run \fBgit fetch \-\-unshallow\fP\&. Then go make a sandwich because it\(aqs
gonna be a while.
.sp
You\(aqre also going to want to head over to GitHub and create your own
\fI\%fork of Salt\fP\&. Once you\(aqve
got that set up you can add it as a remote:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git remote add yourname <YOUR SALT REMOTE>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you use your name to refer to your fork, and \fBsalt\fP to refer to the
official Salt repo you\(aqll never get \fBupstream\fP or \fBorigin\fP confused.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Each time you start work on a new issue you should fetch the most recent
changes from \fBsalt/upstream\fP\&.
.UNINDENT
.UNINDENT
.SS Set up \fBpre\-commit\fP and \fBnox\fP
.sp
Here at Salt we use \fI\%pre\-commit\fP and
\fI\%nox\fP to make it easier for
contributors to get quick feedback, for quality control, and to increase
the chance that your merge request will get reviewed and merged. Nox
enables us to run multiple different test configurations, as well as
other common tasks. You can think of it as Make with superpowers.
Pre\-commit does what it sounds like: it configures some Git pre\-commit
hooks to run \fBblack\fP for formatting, \fBisort\fP for keeping our imports
sorted, and \fBpylint\fP to catch issues like unused imports, among
others. You can easily install them in your virtualenv with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m pip install pre\-commit nox
pre\-commit install
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Currently there is an issue with the pip\-tools\-compile pre\-commit hook on Windows.
The details around this issue are included here:
\fI\%https://github.com/saltstack/salt/issues/56642\fP\&.
Please ensure you export \fBSKIP=pip\-tools\-compile\fP to skip pip\-tools\-compile.
.UNINDENT
.UNINDENT
.sp
Now before each commit, it will ensure that your code at least \fIlooks\fP
right before you open a pull request. And with that step, it\(aqs time to
start hacking on Salt!
.SS Set up imagemagick
.sp
One last prerequisite is to have \fBimagemagick\fP installed, as it is required
by Sphinx for generating the HTML documentation.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# On Mac, via homebrew
brew install imagemagick
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Example Linux installation: Debian\-based
sudo apt install imagemagick
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Salt issues
.SS Create your own
.sp
Perhaps you\(aqve come to this guide because you found a problem in Salt,
and you\(aqve diagnosed the cause. Maybe you need some help figuring out
the problem. In any case, creating quality bug reports is a great way to
contribute to Salt even if you lack the skills, time, or inclination to
fix it yourself. If that\(aqs the case, head on over to \fI\%Salt\(aqs issue
tracker on
GitHub\fP\&.
.sp
Creating a \fBgood\fP report can take a little bit of time \- but every
minute you invest in making it easier for others to reproduce and
understand your issue is time well spent. The faster someone can
understand your issue, the faster it will be able to get fixed
correctly.
.sp
The thing that every issue needs goes by many names, but one at least as
good as any other is MCVE \- \fBM\fPinimum \fBC\fPomplete
\fBV\fPerifiable \fBE\fPxample.
.sp
In a nutshell:
.INDENT 0.0
.IP \(bu 2
\fBMinimum\fP: All of the \fBextra\fP information has been removed. Will
2 or 3 lines of master/minion config still exhibit the behavior?
.IP \(bu 2
\fBComplete\fP: Minimum also means complete. If your example is missing
information, then it\(aqs not complete. Salt, Python, and OS versions
are all bits of information that make your example complete. Have you
provided the commands that you ran?
.IP \(bu 2
\fBVerifiable\fP: Can someone take your report and reproduce it?
.UNINDENT
.sp
Slow is smooth, and smooth is fast \- it may feel like you\(aqre taking a
long time to create your issue if you\(aqre creating a proper MCVE, but a
MCVE eliminates back and forth required to reproduce/verify the issue so
someone can actually create a fix.
.SS Pick an issue
.sp
If you don\(aqt already have an issue in mind, you can search for \fI\%help
wanted\fP
issues. If you also search for \fI\%good first
issue\fP
then you should be able to find some issues that are good for getting
started contributing to Salt. \fI\%Documentation
issues\fP
are also good starter issues. When you find an issue that catches your
eye (or one of your own), it\(aqs a good idea to comment on the issue and
mention that you\(aqre working on it. Good communication is key to
collaboration \- so if you don\(aqt have time to complete work on the issue,
just leaving some information about when you expect to pick things up
again is a great idea!
.SS Hacking away
.SS Salt, tests, documentation, and you
.sp
Before approving code contributions, Salt requires:
.INDENT 0.0
.IP \(bu 2
documentation
.IP \(bu 2
meaningful passing tests
.IP \(bu 2
correct code
.UNINDENT
.sp
Documentation fixes just require correct documentation.
.SS What if I don\(aqt write tests or docs?
.sp
If you aren\(aqt into writing documentation or tests, we still welcome your
contributions! But your PR will be labeled \fBNeeds Testcase\fP and
\fBHelp Wanted\fP until someone can get to write the tests/documentation.
Of course, if you have a desire but just lack the skill we are more than
happy to collaborate and help out! There\(aqs the \fI\%documentation working
group\fP
and the \fI\%testing working group\fP\&.
We also regularly stream our test clinic \fI\%live on
Twitch\fP every Tuesday afternoon
and Thursday morning, Central Time. If you\(aqd like specific help with
tests, bring them to the clinic. If no community members need help, you
can also just watch tests written in real time.
.SS Documentation
.sp
Salt uses both docstrings, as well as normal reStructuredText files in
the \fBsalt/doc\fP folder for documentation. Sphinx is used to generate the
documentation, and does require \fBimagemagick\fP\&. See \fI\%Set up imagemagick\fP for
more information.
.sp
Before submitting a documentation PR, it helps to first build the Salt docs
locally on your machine and preview them. Local previews helps you:
.INDENT 0.0
.IP \(bu 2
Debug potential documentation output errors before submitting a PR.
.IP \(bu 2
Saves you time by not needing to use the Salt CI/CD test suite to debug, which takes
more than 30 minutes to run on a PR.
.IP \(bu 2
Ensures the final output looks the way you intended it to look.
.UNINDENT
.sp
To set up your local environment to preview the core Salt and module
documentation:
.INDENT 0.0
.IP 1. 3
Install the documentation dependencies. For example, on Ubuntu:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
sudo apt\-get update

sudo apt\-get install \-y enchant\-2 git gcc imagemagick make zlib1g\-dev libc\-dev libffi\-dev g++ libxml2 libxml2\-dev libxslt\-dev libcurl4\-openssl\-dev libssl\-dev libgnutls28\-dev xz\-utils inkscape
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
Navigate to the folder where you store your Salt repository and remove any
\fI\&.nox\fP directories that might be in that folder:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
rm \-rf .nox
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
Install \fIpyenv\fP for the version of Python needed to run the docs. As of the
time of writing, the Salt docs theme is not compatible with Python 3.10, so
you\(aqll need to run 3.9 or earlier. For example:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
pyenv install 3.9.18
pyenv virtualenv 3.9.18 salt\-docs
echo \(aqsalt\-docs\(aq > .python\-version
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 4. 3
Activate \fIpyenv\fP if it\(aqs not auto\-activated:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
pyenv exec pip install \-U pip setuptools wheel
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 5. 3
Install \fInox\fP into your pyenv environment, which is the utility that will
build the Salt documentation:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
pyenv exec pip install nox
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Since we use \fBnox\fP, you can build your docs and view them in your browser
with this one\-liner:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m nox \-e \(aqdocs\-html(compress=False, clean=False)\(aq; cd doc/_build/html; python \-m webbrowser http://localhost:8000/contents.html; python \-m http.server
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The first time you build the docs, it will take a while because there are a
\fIlot\fP of modules. Maybe you should go grab some dessert if you already finished
that sandwich. But once nox and Sphinx are done building the docs, python should
launch your default browser with the URL
\fI\%http://localhost:8000/contents.html\fP\&. Now you can navigate to your docs
and ensure your changes exist. If you make changes, you can simply run
this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cd \-; python \-m nox \-e \(aqdocs\-html(compress=False, clean=False)\(aq; cd doc/_build/html; python \-m http.server
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And then refresh your browser to get your updated docs. This one should
be quite a bit faster since Sphinx won\(aqt need to rebuild everything.
.sp
Alternatively, you could build the docs on your local machine and then preview
the build output. To build the docs locally:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pyenv exec nox \-e \(aqdocs\-html(compress=False, clean=True)\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The output from this command will put the preview files in: \fBdoc > _build > html\fP\&.
.sp
If your change is a docs\-only change, you can go ahead and commit/push
your code and open a PR. You can indicate that it\(aqs a docs\-only change by
adding \fB[Documentation]\fP to the title of your PR. Otherwise, you\(aqll
want to write some tests and code.
.SS Running development Salt
.sp
Note: If you run into any issues in this section, check the
Troubleshooting section.
.sp
If you\(aqre going to hack on the Salt codebase you\(aqre going to want to be
able to run Salt locally. The first thing you need to do is install Salt
as an editable pip install:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m pip install \-e .
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will let you make changes to Salt without having to re\-install it.
.sp
After all of the dependencies and Salt are installed, it\(aqs time to set
up the config for development. Typically Salt runs as \fBroot\fP, but you
can specify which user to run as. To configure that, just copy the
master and minion configs. We have .gitignore setup to ignore the
\fBlocal/\fP directory, so we can put all of our personal files there.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mkdir \-p local/etc/salt/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Create a master config file as \fBlocal/etc/salt/master\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cat <<EOF >local/etc/salt/master
user: $(whoami)
root_dir: $PWD/local/
publish_port: 55505
ret_port: 55506
EOF
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And a minion config as \fBlocal/etc/salt/minion\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cat <<EOF >local/etc/salt/minion
user: $(whoami)
root_dir: $PWD/local/
master: localhost
id: saltdev
master_port: 55506
EOF
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now you can start your Salt master and minion, specifying the config
dir.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-master \-\-config\-dir=local/etc/salt/ \-\-log\-level=debug \-\-daemon
salt\-minion \-\-config\-dir=local/etc/salt/ \-\-log\-level=debug \-\-daemon
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now you should be able to accept the minion key:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-c local/etc/salt \-Ay
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And check that your master/minion are communicating:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-c local/etc/salt \e* test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Rather than running \fBtest.version\fP from your master, you can run it
from the minion instead:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-c local/etc/salt test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that you\(aqre running \fBsalt\-call\fP instead of \fBsalt\fP, and you\(aqre
not specifying the minion (\fB\e*\fP), but if you\(aqre running the dev
version then you still will need to pass in the config dir. Now that
you\(aqve got Salt running, you can hack away on the Salt codebase!
.sp
If you need to restart Salt for some reason, if you\(aqve made changes and
they don\(aqt appear to be reflected, this is one option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
kill \-INT $(pgrep salt\-master)
kill \-INT $(pgrep salt\-minion)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you\(aqd rather not use \fBkill\fP, you can have a couple of terminals
open with your salt virtualenv activated and omit the \fB\-\-daemon\fP
argument. Salt will run in the foreground, so you can just use ctrl+c to
quit.
.SS Test first? Test last? Test meaningfully!
.sp
You can write tests first or tests last, as long as your tests are
meaningful and complete! \fITypically\fP the best tests for Salt are going
to be unit tests. Testing is \fI\%a whole topic on its
own\fP,
But you may also want to write functional or integration tests. You\(aqll
find those in the \fBtests/\fP directory.
.sp
When you\(aqre thinking about tests to write, the most important thing to
keep in mind is, “What, exactly, am I testing?” When a test fails, you
should know:
.INDENT 0.0
.IP \(bu 2
What, specifically, failed?
.IP \(bu 2
Why did it fail?
.IP \(bu 2
As much as possible, what do I need to do to fix this failure?
.UNINDENT
.sp
If you can\(aqt answer those questions then you might need to refactor your
tests.
.sp
When you\(aqre running tests locally, you should make sure that if you
remove your code changes your tests are failing. If your tests \fIaren\(aqt\fP
failing when you haven\(aqt yet made changes, then it\(aqs possible that
you\(aqre testing the wrong thing.
.sp
But whether you adhere to TDD/BDD, or you write your code first and your
tests last, ensure that your tests are meaningful.
.SS Running tests
.sp
As previously mentioned, we use \fBnox\fP, and that\(aqs how we run our
tests. You should have it installed by this point but if not you can
install it with this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m pip install nox
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now you can run your tests:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m nox \-e \(dqtest\-3(coverage=False)\(dq \-\- tests/unit/cli/test_batch.py
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs a good idea to install
\fI\%espeak\fP or use \fBsay\fP on
Mac if you\(aqre running some long\-running tests. You can do something like
this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m nox \-e \(dqtest\-3(coverage=False)\(dq \-\- tests/unit/cli/test_batch.py; espeak \(dqTests done, woohoo!\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
That way you don\(aqt have to keep monitoring the actual test run.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m nox \-e \(dqtest\-3(coverage=False)\(dq \-\- \-\-core\-tests
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can enable or disable test groups locally by passing their respected flag:
.INDENT 0.0
.IP \(bu 2
\-\-no\-fast\-tests \- Tests that are ~10s or faster. Fast tests make up ~75% of tests and can run in 10 to 20 minutes.
.IP \(bu 2
\-\-slow\-tests \- Tests that are ~10s or slower.
.IP \(bu 2
\-\-core\-tests \- Tests of any speed that test the root parts of salt.
.IP \(bu 2
\-\-flaky\-jail \- Test that need to be temporarily skipped.
.UNINDENT
.sp
In your PR, you can enable or disable test groups by setting a label.
All fast, slow, and core tests specified in the change file will always run.
.INDENT 0.0
.IP \(bu 2
test:no\-fast
.IP \(bu 2
test:core
.IP \(bu 2
test:slow
.IP \(bu 2
test:flaky\-jail
.UNINDENT
.SS Changelog and commit!
.sp
When you write your commit message you should use imperative style. Do
this:
.INDENT 0.0
.INDENT 3.5
Add frobnosticate capability
.UNINDENT
.UNINDENT
.sp
Don\(aqt do this:
.INDENT 0.0
.INDENT 3.5
Added frobnosticate capability
.UNINDENT
.UNINDENT
.sp
But that advice is backwards for the changelog. We follow the
\fI\%keepachangelog\fP approach for
our changelog, and use towncrier to generate it for each release. As a
contributor, all that means is that you need to add a file to the
\fBsalt/changelog\fP directory, using the \fB<issue #>.<type>\fP format. For
instance, if you fixed issue 123, you would do:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
echo \(dqMade sys.doc inform when no minions return\(dq > changelog/123.fixed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And that\(aqs all that would go into your file. When it comes to your
commit message, it\(aqs usually a good idea to add other information, such as
.INDENT 0.0
.IP \(bu 2
What does a reviewer need to know about the change that you made?
.IP \(bu 2
If someone isn\(aqt an expert in this area, what will they need to know?
.UNINDENT
.sp
This will also help you out, because when you go to create the PR it
will automatically insert the body of your commit messages.
.sp
See the \fI\%changelog\fP
docs for more information.
.SS Pull request time!
.sp
Once you\(aqve done all your dev work and tested locally, you should check
out our \fI\%PR
guidelines\fP\&.
After you read that page, it\(aqs time to \fI\%open a new
PR\fP\&. Fill out the PR
template \- you should have updated or created any necessary docs, and
written tests if you\(aqre providing a code change. When you submit your
PR, we have a suite of tests that will run across different platforms to
help ensure that no known bugs were introduced.
.SS Now what?
.sp
You\(aqve made your changes, added documentation, opened your PR, and have
passing tests… now what? When can you expect your code to be merged?
.sp
When you open your PR, a reviewer will get automatically assigned. If
your PR is submitted during the week you should be able to expect some
kind of communication within that business day. If your tests are
passing and we\(aqre not in a code freeze, ideally your code will be merged
that week or month. If you haven\(aqt heard from your assigned reviewer, ping them
on GitHub, \fI\%irc\fP, or Community Slack.
.sp
It\(aqs likely that your reviewer will leave some comments that need
addressing \- it may be a style change, or you forgot a changelog entry,
or need to update the docs. Maybe it\(aqs something more fundamental \-
perhaps you encountered the rare case where your PR has a much larger
scope than initially assumed.
.sp
Whatever the case, simply make the requested changes (or discuss why the
requests are incorrect), and push up your new commits. If your PR is
open for a significant period of time it may be worth rebasing your
changes on the most recent changes to Salt. If you need help, the
previously linked Git resources will be valuable.
.sp
But if, for whatever reason, you\(aqre not interested in driving your PR to
completion then just note that in your PR. Something like, “I\(aqm not
interested in writing docs/tests, I just wanted to provide this fix \-
someone else will need to complete this PR.” If you do that then we\(aqll
add a “Help Wanted” label and someone will be able to pick up the PR,
make the required changes, and it can eventually get merged in.
.sp
In any case, now that you have a PR open, congrats! You\(aqre a Salt
developer! You rock!
.SS Troubleshooting
.SS zmq.core.error.ZMQError
.sp
Once the minion starts, you may see an error like the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
::
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
zmq.core.error.ZMQError: ipc path \(dq/path/to/your/virtualenv/var/run/salt/minion/minion_event_7824dcbcfd7a8f6755939af70b96249f_pub.ipc\(dq is longer than 107 characters (sizeof(sockaddr_un.sun_path)).
.UNINDENT
.UNINDENT
.sp
This means that the path to the socket the minion is using is too long.
This is a system limitation, so the only workaround is to reduce the
length of this path. This can be done in a couple different ways:
.INDENT 0.0
.IP 1. 3
Create your virtualenv in a path that is short enough.
.IP 2. 3
Edit the :conf_minion:\fBsock_dir\fP minion config variable and reduce
its length. Remember that this path is relative to the value you set
in :conf_minion:\fBroot_dir\fP\&.
.UNINDENT
.sp
NOTE: The socket path is limited to 107 characters on Solaris and Linux,
and 103 characters on BSD\-based systems.
.SS No permissions to access ...
.sp
If you forget to pass your config path to any of the \fBsalt*\fP commands,
you might see
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
No permissions to access \(dq/var/log/salt/master\(dq, are you running as the
correct user?
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Just pass \fB\-c local/etc/salt\fP (or whatever you named it)
.SS File descriptor limit
.sp
You might need to raise your file descriptor limit. You can check it
with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ulimit \-n
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the value is less than 3072, you should increase it with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ulimit \-n 3072
# For c\-shell:
limit descriptors 3072
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Pygit2 or other dependency install fails
.sp
You may see some failure messages when installing requirements. You can
directly access your nox environment and possibly install pygit (or
other dependency) that way. When you run nox, you\(aqll see a message like
this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox > Re\-using existing virtual environment at .nox/pytest\-parametrized\-3\-crypto\-none\-transport\-zeromq\-coverage\-false.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For this, you would be able to install with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\&.nox/pytest\-parametrized\-3\-crypto\-none\-transport\-zeromq\-coverage\-false/bin/python \-m pip install pygit2
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SALT PROJECT MAINTENANCE POLICIES
.sp
This document explains the current project maintenance policies. The goal of
these policies are to reduce the maintenance burden on core maintainers of the
Salt Project and to encourage more active engagement from the Salt community.
.INDENT 0.0
.IP \(bu 2
\fI\%Issue management\fP
.IP \(bu 2
\fI\%Pull request management\fP
.IP \(bu 2
\fI\%Salt Enhancement Proposals (SEP) process\fP
.UNINDENT
.SS Issue management
.sp
Issues for the Salt Project are critical to Salt community communication and to
find and resolve issues in the Salt Project. As such, the issue tracker needs to
be kept clean and current to the currently supported releases of Salt. They also
need to be free of feature requests, arguments, and trolling.
.sp
We have decided to update our issue policy to be similar to RedHat community
project policies.
.sp
Community members who repeatedly violate these policies are subject to bans.
.INDENT 0.0
.IP 1. 3
All issues that were not opened against a currently supported release of Salt
will be closed.
.INDENT 3.0
.IP \(bu 2
When an old release of Salt is marked out of support, all issues opened
against the now defunct release will be closed.
.IP \(bu 2
If the issue is still present in the current release of Salt, submit a new
issue. Do not re\-open the old issue after it has been closed.
.IP \(bu 2
When opening a new issue that was a bug in a previous release of Salt, you
must validate it against a currently supported release of Salt for
consideration. Issues that do not show the problem against a current
release will be closed without consideration.
.UNINDENT
.IP 2. 3
Only defects can be submitted to the issue tracker.
.INDENT 3.0
.IP \(bu 2
Feature requests without a PR will be immediately closed.
.IP \(bu 2
Feature requests must be designated as a feature being developed and owned
by the issue submitter and assigned to a release. Otherwise they will be
immediately closed.
.IP \(bu 2
Discussions about features can be held in the GitHub
\fI\%Discussions\fP tab or in
the community \fI\%Open Hour\fP\&.
.IP \(bu 2
Questions will be immediately closed.
.UNINDENT
.IP 3. 3
Issues must submit sufficient information.
.INDENT 3.0
.IP \(bu 2
Issues must follow the relevant template for information.
.IP \(bu 2
Issues that do not give sufficient information about the nature of the
issue \fBand how to reproduce the issue\fP will be immediately closed.
.IP \(bu 2
Issues that do not comply will be immediately closed.
.UNINDENT
.UNINDENT
.SS Pull request management
.sp
The Salt pull request (PR) queue has been a challenge to maintain for the entire
life of the project. This is in large part due to the incredibly active and
vibrant community around Salt.
.sp
Unfortunately, it has proven to be too much for the core team and the greater
Salt community to manage. As such, we deem it necessary to make fundamental
changes to how we manage the PR queue:
.INDENT 0.0
.IP 1. 3
All PRs opened against releases of Salt that are no longer supported will be
closed immediately.
.IP 2. 3
Closed PRs can be resubmitted, NOT re\-opened.
.IP 3. 3
PRs need to provide full tests for all of the code affected, regardless of
whether the PR author wrote the code affected.
.IP 4. 3
PR tests need to be written using the current test mechanism (pytest).
.IP 5. 3
PRs need to pass tests.
.IP 6. 3
PRs must NOT increase the overall test time by a noticeable length.
.IP 7. 3
PRs must NOT add new plugins directly to Salt unless sanctioned by the Salt
core team. New plugins should be made into Salt Extensions.
.IP 8. 3
PRs that have not been updated due to inactivity will be closed. Inactivity
is determined by a lack of submitter activity for the space of 1 month.
.IP 9. 3
PR tests should always maintain or increase total code coverage.
.UNINDENT
.SS Salt Enhancement Proposals (SEP) process
.sp
\fBA message from Thomas Hatch, creator of Salt:\fP
.sp
In 2019, we decided to create a community process to discuss and review Salt
Enhancement Proposals (SEPs). Unfortunately, I feel that this process has not
proven to be an effective way to solve the core issues around Salt Enhancements.
Overall, the Salt enhancement process has proven itself to be more of a burden
than an accelerant to Salt stability, security, and progress. As such, I feel
that the current optimal course of action is to shut the process down.
.sp
Instead of the Salt Enhancement Proposal process, we will add a time in the
\fI\%Open Hour\fP for people to present ideas and
concepts to better understand if they are worth their effort to develop.
Extensive documentation around more intrusive or involved enhancements should
be included in pull requests (PRs). Conversations about enhancements can also be
held in the \fI\%Discussions\fP tab
in GitHub.
.sp
By migrating the conversation into the PR process, we ensure that we are only
reviewing viable proposals instead of being burdened with requests that the core
team is expected to fulfill.
.sp
Effective immediately (January 2024), we are archiving and freezing the SEP
repo.
.SH INSTALLATION
.sp
See the \fI\%Salt Install Guide\fP
for the current installation instructions.
.SH CONFIGURING SALT
.sp
This section explains how to configure user access, view and store job results,
secure and troubleshoot, and how to perform many other administrative tasks.
.SS Configuring Salt
.sp
Salt configuration is very simple. The default configuration for the
\fI\%master\fP will work for most installations and the only requirement for
setting up a \fI\%minion\fP is to set the location of the master in the minion
configuration file.
.sp
The configuration files will be installed to \fB/etc/salt\fP and are named
after the respective components, \fB/etc/salt/master\fP, and
\fB/etc/salt/minion\fP\&.
.SS Master Configuration
.sp
By default the Salt master listens on ports 4505 and 4506 on all
interfaces (0.0.0.0). To bind Salt to a specific IP, redefine the
\(dqinterface\(dq directive in the master configuration file, typically
\fB/etc/salt/master\fP, as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- #interface: 0.0.0.0
+ interface: 10.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
After updating the configuration file, restart the Salt master.
See the \fI\%master configuration reference\fP
for more details about other configurable options.
.SS Minion Configuration
.sp
Although there are many Salt Minion configuration options, configuring
a Salt Minion is very simple. By default a Salt Minion will
try to connect to the DNS name \(dqsalt\(dq; if the Minion is able to
resolve that name correctly, no configuration is needed.
.sp
If the DNS name \(dqsalt\(dq does not resolve to point to the correct
location of the Master, redefine the \(dqmaster\(dq directive in the minion
configuration file, typically \fB/etc/salt/minion\fP, as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- #master: salt
+ master: 10.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
After updating the configuration file, restart the Salt minion.
See the \fI\%minion configuration reference\fP
for more details about other configurable options.
.SS Proxy Minion Configuration
.sp
A proxy minion emulates the behaviour of a regular minion
and inherits their options.
.sp
Similarly, the configuration file is \fB/etc/salt/proxy\fP and the proxy
tries to connect to the DNS name \(dqsalt\(dq.
.sp
In addition to the regular minion options,
there are several proxy\-specific \- see the
\fI\%proxy minion configuration reference\fP\&.
.SS Running Salt
.INDENT 0.0
.IP 1. 3
Start the master in the foreground (to daemonize the process, pass the
\fI\%\-d flag\fP):
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-master
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
Start the minion in the foreground (to daemonize the process, pass the
\fI\%\-d flag\fP):
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-minion
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.IP "Having trouble?"
.sp
The simplest way to troubleshoot Salt is to run the master and minion in
the foreground with \fI\%log level\fP set to \fBdebug\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-master \-\-log\-level=debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For information on salt\(aqs logging system please see the \fI\%logging
document\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.IP "Run as an unprivileged (non\-root) user"
.sp
To run Salt as another user, set the \fI\%user\fP parameter in the
master config file.
.sp
Additionally, ownership, and permissions need to be set such that the
desired user can read from and write to the following directories (and
their subdirectories, where applicable):
.INDENT 0.0
.IP \(bu 2
/etc/salt
.IP \(bu 2
/var/cache/salt
.IP \(bu 2
/var/log/salt
.IP \(bu 2
/var/run/salt
.UNINDENT
.sp
More information about running salt as a non\-privileged user can be found
\fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
There is also a full \fI\%troubleshooting guide\fP
available.
.SS Key Identity
.sp
Salt provides commands to validate the identity of your Salt master
and Salt minions before the initial key exchange. Validating key identity helps
avoid inadvertently connecting to the wrong Salt master, and helps prevent
a potential MiTM attack when establishing the initial connection.
.SS Master Key Fingerprint
.sp
Print the master key fingerprint by running the following command on the Salt master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-F master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Copy the \fBmaster.pub\fP fingerprint from the \fILocal Keys\fP section, and then set this value
as the \fI\%master_finger\fP in the minion configuration file. Save the configuration
file and then restart the Salt minion.
.SS Minion Key Fingerprint
.sp
Run the following command on each Salt minion to view the minion key fingerprint:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local key.finger
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Compare this value to the value that is displayed when you run the
\fBsalt\-key \-\-finger <MINION_ID>\fP command on the Salt master.
.SS Key Management
.sp
Salt uses AES encryption for all communication between the Master and
the Minion. This ensures that the commands sent to the Minions cannot
be tampered with, and that communication between Master and Minion is
authenticated through trusted, accepted keys.
.sp
Before commands can be sent to a Minion, its key must be accepted on
the Master. Run the \fBsalt\-key\fP command to list the keys known to
the Salt Master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[root@master ~]# salt\-key \-L
Unaccepted Keys:
alpha
bravo
charlie
delta
Accepted Keys:
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example shows that the Salt Master is aware of four Minions, but none of
the keys has been accepted. To accept the keys and allow the Minions to be
controlled by the Master, again use the \fBsalt\-key\fP command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[root@master ~]# salt\-key \-A
[root@master ~]# salt\-key \-L
Unaccepted Keys:
Accepted Keys:
alpha
bravo
charlie
delta
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBsalt\-key\fP command allows for signing keys individually or in bulk. The
example above, using \fB\-A\fP bulk\-accepts all pending keys. To accept keys
individually use the lowercase of the same option, \fB\-a keyname\fP\&.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%salt\-key manpage\fP
.UNINDENT
.UNINDENT
.SS Sending Commands
.sp
Communication between the Master and a Minion may be verified by running
the \fBtest.version\fP command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[root@master ~]# salt alpha test.version
alpha:
    2018.3.4
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Communication between the Master and all Minions may be tested in a
similar way:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[root@master ~]# salt \(aq*\(aq test.version
alpha:
    2018.3.4
bravo:
    2018.3.4
charlie:
    2018.3.4
delta:
    2018.3.4
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Each of the Minions should send a \fB2018.3.4\fP response as shown above,
or any other salt version installed.
.SS What\(aqs Next?
.sp
Understanding \fI\%targeting\fP is important. From there, depending
on the way you wish to use Salt, you should also proceed to learn about
\fI\%Remote Execution\fP and \fI\%Configuration Management\fP\&.
.SS Configuring the Salt Master
.sp
The Salt system is amazingly simple and easy to configure, the two components
of the Salt system each have a respective configuration file. The
\fBsalt\-master\fP is configured via the master configuration file, and the
\fBsalt\-minion\fP is configured via the minion configuration file.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Example master configuration file\fP\&.
.UNINDENT
.UNINDENT
.sp
The configuration file for the salt\-master is located at \fB/etc/salt/master\fP
by default. Atomic included configuration files can be placed in
\fB/etc/salt/master.d/*.conf\fP\&. Warning: files with other suffixes than .conf will
not be included. A notable exception is FreeBSD, where the configuration file is
located at \fB/usr/local/etc/salt\fP\&. The available options are as follows:
.SS Primary Master Configuration
.SS \fBinterface\fP
.sp
Default: \fB0.0.0.0\fP (all interfaces)
.sp
The local interface to bind to, must be an IP address.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
interface: 192.168.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBipv6\fP
.sp
Default: \fBFalse\fP
.sp
Whether the master should listen for IPv6 connections. If this is set to True,
the interface option must be adjusted too (for example: \fBinterface: \(aq::\(aq\fP)
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ipv6: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpublish_port\fP
.sp
Default: \fB4505\fP
.sp
The network port to set up the publication interface.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publish_port: 4505
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_id\fP
.sp
Default: \fBNone\fP
.sp
The id to be passed in the publish job to minions. This is used for MultiSyndics
to return the job to the requesting master.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This must be the same string as the syndic is configured with.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_id: MasterOfMaster
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBuser\fP
.sp
Default: \fBroot\fP
.sp
The user to run the Salt processes
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
user: root
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBenable_ssh_minions\fP
.sp
Default: \fBFalse\fP
.sp
Tell the master to also use salt\-ssh when running commands against minions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
enable_ssh_minions: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Enabling this does not influence the limitations on cross\-minion communication.
The Salt mine and \fBpublish.publish\fP do not work from regular minions
to SSH minions, the other way around is partly possible since 3007.0
(during state rendering on the master).
This means you can use the mentioned functions to call out to regular minions
in \fBsls\fP templates and wrapper modules, but state modules
(which are executed on the remote) relying on them still do not work.
.UNINDENT
.UNINDENT
.SS \fBret_port\fP
.sp
Default: \fB4506\fP
.sp
The port used by the return server, this is the server used by Salt to receive
execution returns and command executions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ret_port: 4506
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpidfile\fP
.sp
Default: \fB/var/run/salt\-master.pid\fP
.sp
Specify the location of the master pidfile.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pidfile: /var/run/salt\-master.pid
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBroot_dir\fP
.sp
Default: \fB/\fP
.sp
The system root directory to operate from, change this to make Salt run from
an alternative root.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
root_dir: /
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This directory is prepended to the following options:
\fI\%pki_dir\fP, \fI\%cachedir\fP, \fI\%sock_dir\fP,
\fI\%log_file\fP, \fI\%autosign_file\fP,
\fI\%autoreject_file\fP, \fI\%pidfile\fP,
\fI\%autosign_grains_dir\fP\&.
.UNINDENT
.UNINDENT
.SS \fBconf_file\fP
.sp
Default: \fB/etc/salt/master\fP
.sp
The path to the master\(aqs configuration file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
conf_file: /etc/salt/master
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpki_dir\fP
.sp
Default: \fB<LIB_STATE_DIR>/pki/master\fP
.sp
The directory to store the pki authentication keys.
.sp
\fB<LIB_STATE_DIR>\fP is the pre\-configured variable state directory set during
installation via \fB\-\-salt\-lib\-state\-dir\fP\&. It defaults to \fB/etc/salt\fP\&. Systems
following the Filesystem Hierarchy Standard (FHS) might set it to
\fB/var/lib/salt\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pki_dir: /etc/salt/pki/master
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcluster_id\fP
.sp
New in version 3007.

.sp
When defined, the master will operate in cluster mode. The master will send the
cluster key and id to minions instead of its own key and id. The master will
also forward its local event bus to other masters defined by \fBcluster_peers\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cluster_id: master
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcluster_peers\fP
.sp
New in version 3007.

.sp
When \fBcluster_id\fP is defined, this setting is a list of other master
(hostnames or ips) that will be in the cluster.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cluster_peers:
   \- master2
   \- master3
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcluster_pki_dir\fP
.sp
New in version 3007.

.sp
When \fBcluster_id\fP is defined, this sets the location of where this cluster
will store its cluster public and private key as well as any minion keys. This
setting will default to the value of \fBpki_dir\fP, but should be changed
to the filesystem location shared between peers in the cluster.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cluster_pki: /my/gluster/share/pki
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBextension_modules\fP
.sp
Changed in version 2016.3.0: The default location for this directory has been moved. Prior to this
version, the location was a directory named \fBextmods\fP in the Salt
cachedir (on most platforms, \fB/var/cache/salt/extmods\fP). It has been
moved into the master cachedir (on most platforms,
\fB/var/cache/salt/master/extmods\fP).

.sp
Directory where custom modules are synced to. This directory can contain
subdirectories for each of Salt\(aqs module types such as \fBrunners\fP,
\fBoutput\fP, \fBwheel\fP, \fBmodules\fP, \fBstates\fP, \fBreturners\fP, \fBengines\fP,
\fButils\fP, etc.  This path is appended to \fI\%root_dir\fP\&.
.sp
Note, any directories or files not found in the \fImodule_dirs\fP location
will be removed from the extension_modules path.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
extension_modules: /root/salt_extmods
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBextmod_whitelist/extmod_blacklist\fP
.sp
New in version 2017.7.0.

.sp
By using this dictionary, the modules that are synced to the master\(aqs extmod cache using \fIsaltutil.sync_*\fP can be
limited.  If nothing is set to a specific type, then all modules are accepted.  To block all modules of a specific type,
whitelist an empty list.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
extmod_whitelist:
  modules:
    \- custom_module
  engines:
    \- custom_engine
  pillars: []

extmod_blacklist:
  modules:
    \- specific_module
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B Valid options:
.INDENT 7.0
.IP \(bu 2
modules
.IP \(bu 2
states
.IP \(bu 2
grains
.IP \(bu 2
renderers
.IP \(bu 2
returners
.IP \(bu 2
output
.IP \(bu 2
proxy
.IP \(bu 2
runners
.IP \(bu 2
wheel
.IP \(bu 2
engines
.IP \(bu 2
queues
.IP \(bu 2
pillar
.IP \(bu 2
utils
.IP \(bu 2
sdb
.IP \(bu 2
cache
.IP \(bu 2
clouds
.IP \(bu 2
tops
.IP \(bu 2
roster
.IP \(bu 2
tokens
.UNINDENT
.UNINDENT
.SS \fBmodule_dirs\fP
.sp
Default: \fB[]\fP
.sp
Like \fBextension_modules\fP, but a list of extra directories to search
for Salt modules.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
module_dirs:
  \- /var/cache/salt/minion/extmods
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcachedir\fP
.sp
Default: \fB/var/cache/salt/master\fP
.sp
The location used to store cache information, particularly the job information
for executed salt commands.
.sp
This directory may contain sensitive data and should be protected accordingly.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cachedir: /var/cache/salt/master
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBverify_env\fP
.sp
Default: \fBTrue\fP
.sp
Verify and set permissions on configuration directories at startup.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
verify_env: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBkeep_jobs\fP
.sp
Default: \fB24\fP
.sp
Set the number of hours to keep old job information. Note that setting this option
to \fB0\fP disables the cache cleaner.
.sp
Deprecated since version 3006: Replaced by \fI\%keep_jobs_seconds\fP

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
keep_jobs: 24
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBkeep_jobs_seconds\fP
.sp
Default: \fB86400\fP
.sp
Set the number of seconds to keep old job information. Note that setting this option
to \fB0\fP disables the cache cleaner.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
keep_jobs_seconds: 86400
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgather_job_timeout\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB10\fP
.sp
The number of seconds to wait when the client is requesting information
about running jobs.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gather_job_timeout: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtimeout\fP
.sp
Default: \fB5\fP
.sp
Set the default timeout for the salt command and api.
.SS \fBloop_interval\fP
.sp
Default: \fB60\fP
.sp
The loop_interval option controls the seconds for the master\(aqs Maintenance
process check cycle. This process updates file server backends, cleans the
job cache and executes the scheduler.
.SS \fBmaintenance_interval\fP
.sp
New in version 3006.0.

.sp
Default: \fB3600\fP
.sp
Defines how often to restart the master\(aqs Maintenance process.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
maintenance_interval: 9600
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBoutput\fP
.sp
Default: \fBnested\fP
.sp
Set the default outputter used by the salt command.
.SS \fBoutputter_dirs\fP
.sp
Default: \fB[]\fP
.sp
A list of additional directories to search for salt outputters in.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
outputter_dirs: []
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBoutput_file\fP
.sp
Default: None
.sp
Set the default output file used by the salt command. Default is to output
to the CLI and not to a file. Functions the same way as the \(dq\-\-out\-file\(dq
CLI option, only sets this to a single file for all salt commands.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
output_file: /path/output/file
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBshow_timeout\fP
.sp
Default: \fBTrue\fP
.sp
Tell the client to show minions that have timed out.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
show_timeout: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBshow_jid\fP
.sp
Default: \fBFalse\fP
.sp
Tell the client to display the jid when a job is published.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
show_jid: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcolor\fP
.sp
Default: \fBTrue\fP
.sp
By default output is colored, to disable colored output set the color value
to False.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
color: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcolor_theme\fP
.sp
Default: \fB\(dq\(dq\fP
.sp
Specifies a path to the color theme to use for colored command line output.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
color_theme: /etc/salt/color_theme
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcli_summary\fP
.sp
Default: \fBFalse\fP
.sp
When set to \fBTrue\fP, displays a summary of the number of minions targeted,
the number of minions returned, and the number of minions that did not
return.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cli_summary: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsock_dir\fP
.sp
Default: \fB/var/run/salt/master\fP
.sp
Set the location to use for creating Unix sockets for master process
communication.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sock_dir: /var/run/salt/master
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBenable_gpu_grains\fP
.sp
Default: \fBFalse\fP
.sp
Enable GPU hardware data for your master. Be aware that the master can
take a while to start up when lspci and/or dmidecode is used to populate the
grains for the master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
enable_gpu_grains: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBskip_grains\fP
.sp
Default: \fBFalse\fP
.sp
MasterMinions should omit grains. A MasterMinion is \(dqa minion function object
for generic use on the master\(dq that omit pillar. A RunnerClient creates a
MasterMinion omitting states and renderer. Setting to True can improve master
performance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
skip_grains: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBjob_cache\fP
.sp
Default: \fBTrue\fP
.sp
The master maintains a temporary job cache. While this is a great addition, it
can be a burden on the master for larger deployments (over 5000 minions).
Disabling the job cache will make previously executed jobs unavailable to
the jobs system and is not generally recommended. Normally it is wise to make
sure the master has access to a faster IO system or a tmpfs is mounted to the
jobs dir.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job_cache: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Setting the \fBjob_cache\fP to \fBFalse\fP will not cache minion returns, but
the JID directory for each job is still created. The creation of the JID
directories is necessary because Salt uses those directories to check for
JID collisions. By setting this option to \fBFalse\fP, the job cache
directory, which is \fB/var/cache/salt/master/jobs/\fP by default, will be
smaller, but the JID directories will still be present.
.sp
Note that the \fI\%keep_jobs_seconds\fP option can be set to a lower
value, such as \fB3600\fP, to limit the number of seconds jobs are stored in
the job cache. (The default is 86400 seconds.)
.sp
Please see the \fI\%Managing the Job Cache\fP
documentation for more information.
.UNINDENT
.UNINDENT
.SS \fBminion_data_cache\fP
.sp
Default: \fBTrue\fP
.sp
The minion data cache is a cache of information about the minions stored on the
master, this information is primarily the pillar, grains and mine data. The data
is cached via the cache subsystem in the Master cachedir under the name of the
minion or in a supported database. The data is used to predetermine what minions
are expected to reply from executions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minion_data_cache: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcache\fP
.sp
Default: \fBlocalfs\fP
.sp
Cache subsystem module to use for minion data cache.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cache: consul
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmemcache_expire_seconds\fP
.sp
Default: \fB0\fP
.sp
Memcache is an additional cache layer that keeps a limited amount of data
fetched from the minion data cache for a limited period of time in memory that
makes cache operations faster. It doesn\(aqt make much sense for the \fBlocalfs\fP
cache driver but helps for more complex drivers like \fBconsul\fP\&.
.sp
This option sets the memcache items expiration time. By default is set to \fB0\fP
that disables the memcache.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
memcache_expire_seconds: 30
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmemcache_max_items\fP
.sp
Default: \fB1024\fP
.sp
Set memcache limit in items that are bank\-key pairs. I.e the list of
minion_0/data, minion_0/mine, minion_1/data contains 3 items. This value depends
on the count of minions usually targeted in your environment. The best one could
be found by analyzing the cache log with \fBmemcache_debug\fP enabled.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
memcache_max_items: 1024
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmemcache_full_cleanup\fP
.sp
Default: \fBFalse\fP
.sp
If cache storage got full, i.e. the items count exceeds the
\fBmemcache_max_items\fP value, memcache cleans up its storage. If this option
set to \fBFalse\fP memcache removes the only one oldest value from its storage.
If this set set to \fBTrue\fP memcache removes all the expired items and also
removes the oldest one if there are no expired items.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
memcache_full_cleanup: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmemcache_debug\fP
.sp
Default: \fBFalse\fP
.sp
Enable collecting the memcache stats and log it on \fIdebug\fP log level. If enabled
memcache collect information about how many \fBfetch\fP calls has been done and
how many of them has been hit by memcache. Also it outputs the rate value that
is the result of division of the first two values. This should help to choose
right values for the expiration time and the cache size.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
memcache_debug: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBext_job_cache\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
Used to specify a default returner for all minions. When this option is set,
the specified returner needs to be properly configured and the minions will
always default to sending returns to this returner. This will also disable the
local job cache on the master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_job_cache: redis
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBevent_return\fP
.sp
New in version 2015.5.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Specify the returner(s) to use to log events. Each returner may have
installation and configuration requirements. Read the returner\(aqs
documentation.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Not all returners support event returns. Verify that a returner has an
\fBevent_return()\fP function before configuring this option with a returner.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
event_return:
  \- syslog
  \- splunk
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBevent_return_queue\fP
.sp
New in version 2015.5.0.

.sp
Default: \fB0\fP
.sp
On busy systems, enabling event_returns can cause a considerable load on
the storage system for returners. Events can be queued on the master and
stored in a batched fashion using a single transaction for multiple events.
By default, events are not queued.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
event_return_queue: 0
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBevent_return_whitelist\fP
.sp
New in version 2015.5.0.

.sp
Default: \fB[]\fP
.sp
Only return events matching tags in a whitelist.
.sp
Changed in version 2016.11.0: Supports glob matching patterns.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
event_return_whitelist:
  \- salt/master/a_tag
  \- salt/run/*/ret
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBevent_return_blacklist\fP
.sp
New in version 2015.5.0.

.sp
Default: \fB[]\fP
.sp
Store all event returns _except_ the tags in a blacklist.
.sp
Changed in version 2016.11.0: Supports glob matching patterns.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
event_return_blacklist:
  \- salt/master/not_this_tag
  \- salt/wheel/*/ret
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmax_event_size\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB1048576\fP
.sp
Passing very large events can cause the minion to consume large amounts of
memory. This value tunes the maximum size of a message allowed onto the
master event bus. The value is expressed in bytes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
max_event_size: 1048576
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_job_cache\fP
.sp
New in version 2014.7.0.

.sp
Default: \fBlocal_cache\fP
.sp
Specify the returner to use for the job cache. The job cache will only be
interacted with from the salt master and therefore does not need to be
accessible from the minions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_job_cache: redis
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBjob_cache_store_endtime\fP
.sp
New in version 2015.8.0.

.sp
Default: \fBFalse\fP
.sp
Specify whether the Salt Master should store end times for jobs as returns
come in.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job_cache_store_endtime: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBenforce_mine_cache\fP
.sp
Default: False
.sp
By\-default when disabling the minion_data_cache mine will stop working since
it is based on cached data, by enabling this option we explicitly enabling
only the cache for the mine system.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
enforce_mine_cache: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmax_minions\fP
.sp
Default: 0
.sp
The maximum number of minion connections allowed by the master. Use this to
accommodate the number of minions per master if you have different types of
hardware serving your minions. The default of \fB0\fP means unlimited connections.
Please note that this can slow down the authentication process a bit in large
setups.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
max_minions: 100
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcon_cache\fP
.sp
Default: False
.sp
If max_minions is used in large installations, the master might experience
high\-load situations because of having to check the number of connected
minions for every authentication. This cache provides the minion\-ids of
all connected minions to all MWorker\-processes and greatly improves the
performance of max_minions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
con_cache: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpresence_events\fP
.sp
Default: False
.sp
Causes the master to periodically look for actively connected minions.
\fI\%Presence events\fP are fired on the event bus on a
regular interval with a list of connected minions, as well as events with lists
of newly connected or disconnected minions. This is a master\-only operation
that does not send executions to minions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
presence_events: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBdetect_remote_minions\fP
.sp
Default: False
.sp
When checking the minions connected to a master, also include the master\(aqs
connections to minions on the port specified in the setting \fIremote_minions_port\fP\&.
This is particularly useful when checking if the master is connected to any Heist\-Salt
minions. If this setting is set to True, the master will check all connections on port 22
by default unless a user also configures a different port with the setting
\fIremote_minions_port\fP\&.
.sp
Changing this setting will check the remote minions the master is connected to when using
presence events, the manage runner, and any other parts of the code that call the
\fIconnected_ids\fP method to check the status of connected minions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
detect_remote_minions: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBremote_minions_port\fP
.sp
Default: 22
.sp
The port to use when checking for remote minions when \fIdetect_remote_minions\fP is set
to True.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
remote_minions_port: 2222
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBping_on_rotate\fP
.sp
New in version 2014.7.0.

.sp
Default: \fBFalse\fP
.sp
By default, the master AES key rotates every 24 hours. The next command
following a key rotation will trigger a key refresh from the minion which may
result in minions which do not respond to the first command after a key refresh.
.sp
To tell the master to ping all minions immediately after an AES key refresh,
set \fBping_on_rotate\fP to \fBTrue\fP\&. This should mitigate the issue where a
minion does not appear to initially respond after a key is rotated.
.sp
Note that enabling this may cause high load on the master immediately after the
key rotation event as minions reconnect. Consider this carefully if this salt
master is managing a large number of minions.
.sp
If disabled, it is recommended to handle this event by listening for the
\fBaes_key_rotate\fP event with the \fBkey\fP tag and acting appropriately.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ping_on_rotate: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtransport\fP
.sp
Default: \fBzeromq\fP
.sp
Changes the underlying transport layer. ZeroMQ is the recommended transport
while additional transport layers are under development. Supported values are
\fBzeromq\fP and \fBtcp\fP (experimental). This setting has a significant impact on
performance and should not be changed unless you know what you are doing!
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
transport: zeromq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtransport_opts\fP
.sp
Default: \fB{}\fP
.sp
(experimental) Starts multiple transports and overrides options for each
transport with the provided dictionary This setting has a significant impact on
performance and should not be changed unless you know what you are doing!  The
following example shows how to start a TCP transport alongside a ZMQ transport.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
transport_opts:
  tcp:
    publish_port: 4605
    ret_port: 4606
  zeromq: []
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_stats\fP
.sp
Default: False
.sp
Turning on the master stats enables runtime throughput and statistics events
to be fired from the master event bus. These events will report on what
functions have been run on the master and how long these runs have, on
average, taken over a given period of time.
.SS \fBmaster_stats_event_iter\fP
.sp
Default: 60
.sp
The time in seconds to fire master_stats events. This will only fire in
conjunction with receiving a request to the master, idle masters will not
fire these events.
.SS \fBsock_pool_size\fP
.sp
Default: 1
.sp
To avoid blocking waiting while writing a data to a socket, we support
socket pool for Salt applications. For example, a job with a large number
of target host list can cause long period blocking waiting. The option
is used by ZMQ and TCP transports, and the other transport methods don\(aqt
need the socket pool by definition. Most of Salt tools, including CLI,
are enough to use a single bucket of socket pool. On the other hands,
it is highly recommended to set the size of socket pool larger than 1
for other Salt applications, especially Salt API, which must write data
to socket concurrently.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sock_pool_size: 15
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBipc_mode\fP
.sp
Default: \fBipc\fP
.sp
The ipc strategy. (i.e., sockets versus tcp, etc.) Windows platforms lack
POSIX IPC and must rely on TCP based inter\-process communications. \fBipc_mode\fP
is set to \fBtcp\fP by default on Windows.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ipc_mode: ipc
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBipc_write_buffer\fP
.sp
Default: \fB0\fP
.sp
The maximum size of a message sent via the IPC transport module can be limited
dynamically or by sharing an integer value lower than the total memory size. When
the value \fBdynamic\fP is set, salt will use 2.5% of the total memory as
\fBipc_write_buffer\fP value (rounded to an integer). A value of \fB0\fP disables
this option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ipc_write_buffer: 10485760
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtcp_master_pub_port\fP
.sp
Default: \fB4512\fP
.sp
The TCP port on which events for the master should be published if \fBipc_mode\fP is TCP.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tcp_master_pub_port: 4512
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtcp_master_pull_port\fP
.sp
Default: \fB4513\fP
.sp
The TCP port on which events for the master should be pulled if \fBipc_mode\fP is TCP.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tcp_master_pull_port: 4513
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtcp_master_publish_pull\fP
.sp
Default: \fB4514\fP
.sp
The TCP port on which events for the master should be pulled fom and then republished onto
the event bus on the master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tcp_master_publish_pull: 4514
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtcp_master_workers\fP
.sp
Default: \fB4515\fP
.sp
The TCP port for \fBmworkers\fP to connect to on the master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tcp_master_workers: 4515
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBauth_events\fP
.sp
New in version 2017.7.3.

.sp
Default: \fBTrue\fP
.sp
Determines whether the master will fire authentication events.
\fI\%Authentication events\fP are fired when
a minion performs an authentication check with the master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
auth_events: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBminion_data_cache_events\fP
.sp
New in version 2017.7.3.

.sp
Default: \fBTrue\fP
.sp
Determines whether the master will fire minion data cache events.  Minion data
cache events are fired when a minion requests a minion data cache refresh.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minion_data_cache_events: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBhttp_connect_timeout\fP
.sp
New in version 2019.2.0.

.sp
Default: \fB20\fP
.sp
HTTP connection timeout in seconds.
Applied when fetching files using tornado back\-end.
Should be greater than overall download time.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
http_connect_timeout: 20
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBhttp_request_timeout\fP
.sp
New in version 2015.8.0.

.sp
Default: \fB3600\fP
.sp
HTTP request timeout in seconds.
Applied when fetching files using tornado back\-end.
Should be greater than overall download time.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
http_request_timeout: 3600
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBuse_yamlloader_old\fP
.sp
New in version 2019.2.1.

.sp
Default: \fBFalse\fP
.sp
Use the pre\-2019.2 YAML renderer.
Uses legacy YAML rendering to support some legacy inline data structures.
See the \fI\%2019.2.1 release notes\fP for more details.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
use_yamlloader_old: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBreq_server_niceness\fP
.sp
New in version 3001.

.sp
Default: \fBNone\fP
.sp
Process priority level of the ReqServer subprocess of the master.
Supported on POSIX platforms only.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
req_server_niceness: 9
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpub_server_niceness\fP
.sp
New in version 3001.

.sp
Default: \fBNone\fP
.sp
Process priority level of the PubServer subprocess of the master.
Supported on POSIX platforms only.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pub_server_niceness: 9
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfileserver_update_niceness\fP
.sp
New in version 3001.

.sp
Default: \fBNone\fP
.sp
Process priority level of the FileServerUpdate subprocess of the master.
Supported on POSIX platforms only.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_update_niceness: 9
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaintenance_niceness\fP
.sp
New in version 3001.

.sp
Default: \fBNone\fP
.sp
Process priority level of the Maintenance subprocess of the master.
Supported on POSIX platforms only.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
maintenance_niceness: 9
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmworker_niceness\fP
.sp
New in version 3001.

.sp
Default: \fBNone\fP
.sp
Process priority level of the MWorker subprocess of the master.
Supported on POSIX platforms only.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mworker_niceness: 9
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmworker_queue_niceness\fP
.sp
New in version 3001.

.sp
default: \fBNone\fP
.sp
process priority level of the MWorkerQueue subprocess of the master.
supported on POSIX platforms only.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mworker_queue_niceness: 9
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBevent_return_niceness\fP
.sp
New in version 3001.

.sp
default: \fBNone\fP
.sp
process priority level of the EventReturn subprocess of the master.
supported on POSIX platforms only.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
event_return_niceness: 9
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBevent_publisher_niceness\fP
.sp
New in version 3001.

.sp
default: \fBnone\fP
.sp
process priority level of the EventPublisher subprocess of the master.
supported on POSIX platforms only.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
event_publisher_niceness: 9
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBreactor_niceness\fP
.sp
New in version 3001.

.sp
default: \fBNone\fP
.sp
process priority level of the Reactor subprocess of the master.
supported on POSIX platforms only.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor_niceness: 9
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Salt\-SSH Configuration
.SS \fBroster\fP
.sp
Default: \fBflat\fP
.sp
Define the default salt\-ssh roster module to use
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
roster: cache
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBroster_defaults\fP
.sp
New in version 2017.7.0.

.sp
Default settings which will be inherited by all rosters.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
roster_defaults:
  user: daniel
  sudo: True
  priv: /root/.ssh/id_rsa
  tty: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBroster_file\fP
.sp
Default: \fB/etc/salt/roster\fP
.sp
Pass in an alternative location for the salt\-ssh \fI\%flat\fP roster file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
roster_file: /root/roster
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrosters\fP
.sp
Default: \fBNone\fP
.sp
Define locations for \fI\%flat\fP roster files so they can
be chosen when using Salt API. An administrator can place roster files into
these locations. Then, when calling Salt API, the \fI\%roster_file\fP
parameter should contain a relative path to these locations. That is,
\fBroster_file=/foo/roster\fP will be resolved as
\fB/etc/salt/roster.d/foo/roster\fP etc. This feature prevents passing insecure
custom rosters through the Salt API.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rosters:
 \- /etc/salt/roster.d
 \- /opt/salt/some/more/rosters
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssh_passwd\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
The ssh password to log in with.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_passwd: \(aq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssh_priv_passwd\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
Passphrase for ssh private key file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_priv_passwd: \(aq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssh_port\fP
.sp
Default: \fB22\fP
.sp
The target system\(aqs ssh port number.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_port: 22
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssh_scan_ports\fP
.sp
Default: \fB22\fP
.sp
Comma\-separated list of ports to scan.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_scan_ports: 22
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssh_scan_timeout\fP
.sp
Default: \fB0.01\fP
.sp
Scanning socket timeout for salt\-ssh.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_scan_timeout: 0.01
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssh_sudo\fP
.sp
Default: \fBFalse\fP
.sp
Boolean to run command via sudo.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_sudo: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssh_timeout\fP
.sp
Default: \fB60\fP
.sp
Number of seconds to wait for a response when establishing an SSH connection.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_timeout: 60
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssh_user\fP
.sp
Default: \fBroot\fP
.sp
The user to log in as.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_user: root
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssh_log_file\fP
.sp
New in version 2016.3.5.

.sp
Default: \fB/var/log/salt/ssh\fP
.sp
Specify the log file of the \fBsalt\-ssh\fP command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_log_file: /var/log/salt/ssh
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssh_minion_opts\fP
.sp
Default: None
.sp
Pass in minion option overrides that will be inserted into the SHIM for
salt\-ssh calls. The local minion config is not used for salt\-ssh. Can be
overridden on a per\-minion basis in the roster (\fBminion_opts\fP)
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_minion_opts:
  gpg_keydir: /root/gpg
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssh_use_home_key\fP
.sp
Default: False
.sp
Set this to True to default to using \fB~/.ssh/id_rsa\fP for salt\-ssh
authentication with minions
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_use_home_key: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssh_identities_only\fP
.sp
Default: \fBFalse\fP
.sp
Set this to \fBTrue\fP to default salt\-ssh to run with \fB\-o IdentitiesOnly=yes\fP\&. This
option is intended for situations where the ssh\-agent offers many different identities
and allows ssh to ignore those identities and use the only one specified in options.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_identities_only: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssh_list_nodegroups\fP
.sp
Default: \fB{}\fP
.sp
List\-only nodegroups for salt\-ssh. Each group must be formed as either a comma\-separated
list, or a YAML list. This option is useful to group minions into easy\-to\-target groups
when using salt\-ssh. These groups can then be targeted with the normal \-N argument to
salt\-ssh.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_list_nodegroups:
  groupA: minion1,minion2
  groupB: minion1,minion3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Default: False
.sp
Run the ssh_pre_flight script defined in the salt\-ssh roster. By default
the script will only run when the thin dir does not exist on the targeted
minion. This will force the script to run and not check if the thin dir
exists first.
.SS \fBthin_extra_mods\fP
.sp
Default: None
.sp
List of additional modules, needed to be included into the Salt Thin.
Pass a list of importable Python modules that are typically located in
the \fIsite\-packages\fP Python directory so they will be also always included
into the Salt Thin, once generated.
.SS \fBmin_extra_mods\fP
.sp
Default: None
.sp
Identical as \fIthin_extra_mods\fP, only applied to the Salt Minimal.
.SS Master Security Settings
.SS \fBopen_mode\fP
.sp
Default: \fBFalse\fP
.sp
Open mode is a dangerous security feature. One problem encountered with pki
authentication systems is that keys can become \(dqmixed up\(dq and authentication
begins to fail. Open mode turns off authentication and tells the master to
accept all authentication. This will clean up the pki keys received from the
minions. Open mode should not be turned on for general use. Open mode should
only be used for a short period of time to clean up pki keys. To turn on open
mode set this value to \fBTrue\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
open_mode: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBauto_accept\fP
.sp
Default: \fBFalse\fP
.sp
Enable auto_accept. This setting will automatically accept all incoming
public keys from minions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
auto_accept: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBkeysize\fP
.sp
Default: \fB2048\fP
.sp
The size of key that should be generated when creating new keys.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
keysize: 2048
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBautosign_timeout\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB120\fP
.sp
Time in minutes that a incoming public key with a matching name found in
pki_dir/minion_autosign/keyid is automatically accepted. Expired autosign keys
are removed when the master checks the minion_autosign directory. This method
to auto accept minions can be safer than an autosign_file because the
keyid record can expire and is limited to being an exact name match.
This should still be considered a less than secure option, due to the fact
that trust is based on just the requesting minion id.
.SS \fBautosign_file\fP
.sp
Default: \fBnot defined\fP
.sp
If the \fBautosign_file\fP is specified incoming keys specified in the autosign_file
will be automatically accepted. Matches will be searched for first by string
comparison, then by globbing, then by full\-string regex matching.
This should still be considered a less than secure option, due to the fact
that trust is based on just the requesting minion id.
.sp
Changed in version 2018.3.0: For security reasons the file must be readonly except for its owner.
If \fI\%permissive_pki_access\fP is \fBTrue\fP the owning group can also
have write access, but if Salt is running as \fBroot\fP it must be a member of that group.
A less strict requirement also existed in previous version.

.SS \fBautoreject_file\fP
.sp
New in version 2014.1.0.

.sp
Default: \fBnot defined\fP
.sp
Works like \fI\%autosign_file\fP, but instead allows you to specify
minion IDs for which keys will automatically be rejected. Will override both
membership in the \fI\%autosign_file\fP and the
\fI\%auto_accept\fP setting.
.SS \fBautosign_grains_dir\fP
.sp
New in version 2018.3.0.

.sp
Default: \fBnot defined\fP
.sp
If the \fBautosign_grains_dir\fP is specified, incoming keys from minions with
grain values that match those defined in files in the autosign_grains_dir
will be accepted automatically. Grain values that should be accepted automatically
can be defined by creating a file named like the corresponding grain in the
autosign_grains_dir and writing the values into that file, one value per line.
Lines starting with a \fB#\fP will be ignored.
Minion must be configured to send the corresponding grains on authentication.
This should still be considered a less than secure option, due to the fact
that trust is based on just the requesting minion.
.sp
Please see the \fI\%Autoaccept Minions from Grains\fP
documentation for more information.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
autosign_grains_dir: /etc/salt/autosign_grains
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpermissive_pki_access\fP
.sp
Default: \fBFalse\fP
.sp
Enable permissive access to the salt keys. This allows you to run the
master or minion as root, but have a non\-root group be given access to
your pki_dir. To make the access explicit, root must belong to the group
you\(aqve given access to. This is potentially quite insecure. If an autosign_file
is specified, enabling permissive_pki_access will allow group access to that
specific file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
permissive_pki_access: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpublisher_acl\fP
.sp
Default: \fB{}\fP
.sp
Enable user accounts on the master to execute specific modules. These modules
can be expressed as regular expressions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publisher_acl:
  fred:
    \- test.ping
    \- pkg.*
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpublisher_acl_blacklist\fP
.sp
Default: \fB{}\fP
.sp
Blacklist users or modules
.sp
This example would blacklist all non sudo users, including root from
running any commands. It would also blacklist any use of the \(dqcmd\(dq
module.
.sp
This is completely disabled by default.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publisher_acl_blacklist:
  users:
    \- root
    \- \(aq^(?!sudo_).*$\(aq   #  all non sudo users
  modules:
    \- cmd.*
    \- test.echo
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsudo_acl\fP
.sp
Default: \fBFalse\fP
.sp
Enforce \fBpublisher_acl\fP and \fBpublisher_acl_blacklist\fP when users have sudo
access to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo_acl: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBexternal_auth\fP
.sp
Default: \fB{}\fP
.sp
The external auth system uses the Salt auth modules to authenticate and
validate users to access areas of the Salt system.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  pam:
    fred:
      \- test.*
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtoken_expire\fP
.sp
Default: \fB43200\fP
.sp
Time (in seconds) for a newly generated token to live.
.sp
Default: 12 hours
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
token_expire: 43200
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtoken_expire_user_override\fP
.sp
Default: \fBFalse\fP
.sp
Allow eauth users to specify the expiry time of the tokens they generate.
.sp
A boolean applies to all users or a dictionary of whitelisted eauth backends
and usernames may be given:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
token_expire_user_override:
  pam:
    \- fred
    \- tom
  ldap:
    \- gary
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBkeep_acl_in_token\fP
.sp
Default: \fBFalse\fP
.sp
Set to True to enable keeping the calculated user\(aqs auth list in the token
file. This is disabled by default and the auth list is calculated or requested
from the eauth driver each time.
.sp
Note: \fIkeep_acl_in_token\fP will be forced to True when using external authentication
for REST API (\fIrest\fP is present under \fIexternal_auth\fP). This is because the REST API
does not store the password, and can therefore not retroactively fetch the ACL, so
the ACL must be stored in the token.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
keep_acl_in_token: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBeauth_acl_module\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
Auth subsystem module to use to get authorized access list for a user. By default it\(aqs
the same module used for external authentication.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
eauth_acl_module: django
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfile_recv\fP
.sp
Default: \fBFalse\fP
.sp
Allow minions to push files to the master. This is disabled by default, for
security purposes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_recv: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfile_recv_max_size\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB100\fP
.sp
Set a hard\-limit on the size of the files that can be pushed to the master.
It will be interpreted as megabytes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_recv_max_size: 100
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_sign_pubkey\fP
.sp
Default: \fBFalse\fP
.sp
Sign the master auth\-replies with a cryptographic signature of the master\(aqs
public key. Please see the tutorial how to use these settings in the
\fI\%Multimaster\-PKI with Failover Tutorial\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_sign_pubkey: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_sign_key_name\fP
.sp
Default: \fBmaster_sign\fP
.sp
The customizable name of the signing\-key\-pair without suffix.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_sign_key_name: <filename_without_suffix>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_pubkey_signature\fP
.sp
Default: \fBmaster_pubkey_signature\fP
.sp
The name of the file in the master\(aqs pki\-directory that holds the pre\-calculated
signature of the master\(aqs public\-key.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_pubkey_signature: <filename>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_use_pubkey_signature\fP
.sp
Default: \fBFalse\fP
.sp
Instead of computing the signature for each auth\-reply, use a pre\-calculated
signature. The \fI\%master_pubkey_signature\fP must also be set for this.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_use_pubkey_signature: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrotate_aes_key\fP
.sp
Default: \fBTrue\fP
.sp
Rotate the salt\-masters AES\-key when a minion\-public is deleted with salt\-key.
This is a very important security\-setting. Disabling it will enable deleted
minions to still listen in on the messages published by the salt\-master.
Do not disable this unless it is absolutely clear what this does.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rotate_aes_key: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpublish_session\fP
.sp
Default: \fB86400\fP
.sp
The number of seconds between AES key rotations on the master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publish_session: Default: 86400
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssl\fP
.sp
New in version 2016.11.0.

.sp
Default: \fBNone\fP
.sp
TLS/SSL connection options. This could be set to a dictionary containing
arguments corresponding to python \fBssl.wrap_socket\fP method. For details see
\fI\%Tornado\fP
and \fI\%Python\fP
documentation.
.sp
Note: to set enum arguments values like \fBcert_reqs\fP and \fBssl_version\fP use
constant names without ssl module prefix: \fBCERT_REQUIRED\fP or \fBPROTOCOL_SSLv23\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssl:
    keyfile: <path_to_keyfile>
    certfile: <path_to_certfile>
    ssl_version: PROTOCOL_TLSv1_2
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpreserve_minion_cache\fP
.sp
Default: \fBFalse\fP
.sp
By default, the master deletes its cache of minion data when the key for that
minion is removed. To preserve the cache after key deletion, set
\fBpreserve_minion_cache\fP to True.
.sp
WARNING: This may have security implications if compromised minions auth with
a previous deleted minion ID.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
preserve_minion_cache: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBallow_minion_key_revoke\fP
.sp
Default: \fBTrue\fP
.sp
Controls whether a minion can request its own key revocation.  When True
the master will honor the minion\(aqs request and revoke its key.  When False,
the master will drop the request and the minion\(aqs key will remain accepted.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
allow_minion_key_revoke: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBoptimization_order\fP
.sp
Default: \fB[0, 1, 2]\fP
.sp
In cases where Salt is distributed without .py files, this option determines
the priority of optimization level(s) Salt\(aqs module loader should prefer.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This option is only supported on Python 3.5+.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
optimization_order:
  \- 2
  \- 0
  \- 1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Master Large Scale Tuning Settings
.SS \fBmax_open_files\fP
.sp
Default: \fB100000\fP
.sp
Each minion connecting to the master uses AT LEAST one file descriptor, the
master subscription connection. If enough minions connect you might start
seeing on the console(and then salt\-master crashes):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Too many open files (tcp_listener.cpp:335)
Aborted (core dumped)
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
max_open_files: 100000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default this value will be the one of \fIulimit \-Hn\fP, i.e., the hard limit for
max open files.
.sp
To set a different value than the default one, uncomment, and configure this
setting. Remember that this value CANNOT be higher than the hard limit. Raising
the hard limit depends on the OS and/or distribution, a good way to find the
limit is to search the internet for something like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
raise max open files hard limit debian
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBworker_threads\fP
.sp
Default: \fB5\fP
.sp
The number of threads to start for receiving commands and replies from minions.
If minions are stalling on replies because you have many minions, raise the
worker_threads value.
.sp
Worker threads should not be put below 3 when using the peer system, but can
drop down to 1 worker otherwise.
.sp
Standards for busy environments:
.INDENT 0.0
.IP \(bu 2
Use one worker thread per 200 minions.
.IP \(bu 2
The value of worker_threads should not exceed 1½ times the available CPU cores.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When the master daemon starts, it is expected behaviour to see
multiple salt\-master processes, even if \(aqworker_threads\(aq is set to \(aq1\(aq. At
a minimum, a controlling process will start along with a Publisher, an
EventPublisher, and a number of MWorker processes will be started. The
number of MWorker processes is tuneable by the \(aqworker_threads\(aq
configuration value while the others are not.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
worker_threads: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpub_hwm\fP
.sp
Default: \fB1000\fP
.sp
The zeromq high water mark on the publisher interface.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pub_hwm: 1000
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBzmq_backlog\fP
.sp
Default: \fB1000\fP
.sp
The listen queue size of the ZeroMQ backlog.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
zmq_backlog: 1000
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Master Module Management
.SS \fBrunner_dirs\fP
.sp
Default: \fB[]\fP
.sp
Set additional directories to search for runner modules.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
runner_dirs:
  \- /var/lib/salt/runners
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fButils_dirs\fP
.sp
New in version 2018.3.0.

.sp
Default: \fB[]\fP
.sp
Set additional directories to search for util modules.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
utils_dirs:
  \- /var/lib/salt/utils
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcython_enable\fP
.sp
Default: \fBFalse\fP
.sp
Set to true to enable Cython modules (.pyx files) to be compiled on the fly on
the Salt master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cython_enable: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Master State System Settings
.SS \fBstate_top\fP
.sp
Default: \fBtop.sls\fP
.sp
The state system uses a \(dqtop\(dq file to tell the minions what environment to
use and what modules to use. The state_top file is defined relative to the
root of the base environment. The value of \(dqstate_top\(dq is also used for the
pillar top file
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_top: top.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_top_saltenv\fP
.sp
This option has no default value. Set it to an environment name to ensure that
\fIonly\fP the top file from that environment is considered during a
\fI\%highstate\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Using this value does not change the merging strategy. For instance, if
\fI\%top_file_merging_strategy\fP is set to \fBmerge\fP, and
\fI\%state_top_saltenv\fP is set to \fBfoo\fP, then any sections for
environments other than \fBfoo\fP in the top file for the \fBfoo\fP environment
will be ignored. With \fI\%state_top_saltenv\fP set to \fBbase\fP, all
states from all environments in the \fBbase\fP top file will be applied,
while all other top files are ignored. The only way to set
\fI\%state_top_saltenv\fP to something other than \fBbase\fP and not
have the other environments in the targeted top file ignored, would be to
set \fI\%top_file_merging_strategy\fP to \fBmerge_all\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_top_saltenv: dev
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtop_file_merging_strategy\fP
.sp
Changed in version 2016.11.0: A \fBmerge_all\fP strategy has been added.

.sp
Default: \fBmerge\fP
.sp
When no specific fileserver environment (a.k.a. \fBsaltenv\fP) has been specified
for a \fI\%highstate\fP, all environments\(aq top files are
inspected. This config option determines how the SLS targets in those top files
are handled.
.sp
When set to \fBmerge\fP, the \fBbase\fP environment\(aqs top file is evaluated first,
followed by the other environments\(aq top files. The first target expression
(e.g. \fB\(aq*\(aq\fP) for a given environment is kept, and when the same target
expression is used in a different top file evaluated later, it is ignored.
Because \fBbase\fP is evaluated first, it is authoritative. For example, if there
is a target for \fB\(aq*\(aq\fP for the \fBfoo\fP environment in both the \fBbase\fP and
\fBfoo\fP environment\(aqs top files, the one in the \fBfoo\fP environment would be
ignored. The environments will be evaluated in no specific order (aside from
\fBbase\fP coming first). For greater control over the order in which the
environments are evaluated, use \fI\%env_order\fP\&. Note that, aside from
the \fBbase\fP environment\(aqs top file, any sections in top files that do not
match that top file\(aqs environment will be ignored. So, for example, a section
for the \fBqa\fP environment would be ignored if it appears in the \fBdev\fP
environment\(aqs top file. To keep use cases like this from being ignored, use the
\fBmerge_all\fP strategy.
.sp
When set to \fBsame\fP, then for each environment, only that environment\(aqs top
file is processed, with the others being ignored. For example, only the \fBdev\fP
environment\(aqs top file will be processed for the \fBdev\fP environment, and any
SLS targets defined for \fBdev\fP in the \fBbase\fP environment\(aqs (or any other
environment\(aqs) top file will be ignored. If an environment does not have a top
file, then the top file from the \fBdefault_top\fP config parameter
will be used as a fallback.
.sp
When set to \fBmerge_all\fP, then all states in all environments in all top files
will be applied. The order in which individual SLS files will be executed will
depend on the order in which the top files were evaluated, and the environments
will be evaluated in no specific order. For greater control over the order in
which the environments are evaluated, use \fI\%env_order\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
top_file_merging_strategy: same
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBenv_order\fP
.sp
Default: \fB[]\fP
.sp
When \fI\%top_file_merging_strategy\fP is set to \fBmerge\fP, and no
environment is specified for a \fI\%highstate\fP, this
config option allows for the order in which top files are evaluated to be
explicitly defined.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
env_order:
  \- base
  \- dev
  \- qa
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_tops\fP
.sp
Default: \fB{}\fP
.sp
The master_tops option replaces the external_nodes option by creating
a pluggable system for the generation of external top data. The external_nodes
option is deprecated by the master_tops option.
To gain the capabilities of the classic external_nodes system, use the
following configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_tops:
  ext_nodes: <Shell command which returns yaml>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrenderer\fP
.sp
Default: \fBjinja|yaml\fP
.sp
The renderer to use on the minions to render the state data.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
renderer: jinja|json
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBuserdata_template\fP
.sp
New in version 2016.11.4.

.sp
Default: \fBNone\fP
.sp
The renderer to use for templating userdata files in salt\-cloud, if the
\fBuserdata_template\fP is not set in the cloud profile. If no value is set in
the cloud profile or master config file, no templating will be performed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
userdata_template: jinja
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBjinja_env\fP
.sp
New in version 2018.3.0.

.sp
Default: \fB{}\fP
.sp
jinja_env overrides the default Jinja environment options for
\fBall templates except sls templates\fP\&.
To set the options for sls templates use \fI\%jinja_sls_env\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fI\%Jinja2 Environment documentation\fP is the official source for the default values.
Not all the options listed in the jinja documentation can be overridden using \fI\%jinja_env\fP or \fI\%jinja_sls_env\fP\&.
.UNINDENT
.UNINDENT
.sp
The default options are:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jinja_env:
  block_start_string: \(aq{%\(aq
  block_end_string: \(aq%}\(aq
  variable_start_string: \(aq{{\(aq
  variable_end_string: \(aq}}\(aq
  comment_start_string: \(aq{#\(aq
  comment_end_string: \(aq#}\(aq
  line_statement_prefix:
  line_comment_prefix:
  trim_blocks: False
  lstrip_blocks: False
  newline_sequence: \(aq\en\(aq
  keep_trailing_newline: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBjinja_sls_env\fP
.sp
New in version 2018.3.0.

.sp
Default: \fB{}\fP
.sp
jinja_sls_env sets the Jinja environment options for \fBsls templates\fP\&.
The defaults and accepted options are exactly the same as they are
for \fI\%jinja_env\fP\&.
.sp
The default options are:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jinja_sls_env:
  block_start_string: \(aq{%\(aq
  block_end_string: \(aq%}\(aq
  variable_start_string: \(aq{{\(aq
  variable_end_string: \(aq}}\(aq
  comment_start_string: \(aq{#\(aq
  comment_end_string: \(aq#}\(aq
  line_statement_prefix:
  line_comment_prefix:
  trim_blocks: False
  lstrip_blocks: False
  newline_sequence: \(aq\en\(aq
  keep_trailing_newline: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example using line statements and line comments to increase ease of use:
.sp
If your configuration options are
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jinja_sls_env:
  line_statement_prefix: \(aq%\(aq
  line_comment_prefix: \(aq##\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With these options jinja will interpret anything after a \fB%\fP at the start of a line (ignoreing whitespace)
as a jinja statement and will interpret anything after a \fB##\fP as a comment.
.sp
This allows the following more convenient syntax to be used:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
## (this comment will not stay once rendered)
# (this comment remains in the rendered template)
## ensure all the formula services are running
% for service in formula_services:
enable_service_{{ service }}:
  service.running:
    name: {{ service }}
% endfor
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following less convenient but equivalent syntax would have to
be used if you had not set the line_statement and line_comment options:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{# (this comment will not stay once rendered) #}
# (this comment remains in the rendered template)
{# ensure all the formula services are running #}
{% for service in formula_services %}
enable_service_{{ service }}:
  service.running:
    name: {{ service }}
{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBjinja_trim_blocks\fP
.sp
Deprecated since version 2018.3.0: Replaced by \fI\%jinja_env\fP and \fI\%jinja_sls_env\fP

.sp
New in version 2014.1.0.

.sp
Default: \fBFalse\fP
.sp
If this is set to \fBTrue\fP, the first newline after a Jinja block is
removed (block, not variable tag!). Defaults to \fBFalse\fP and corresponds
to the Jinja environment init variable \fBtrim_blocks\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jinja_trim_blocks: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBjinja_lstrip_blocks\fP
.sp
Deprecated since version 2018.3.0: Replaced by \fI\%jinja_env\fP and \fI\%jinja_sls_env\fP

.sp
New in version 2014.1.0.

.sp
Default: \fBFalse\fP
.sp
If this is set to \fBTrue\fP, leading spaces and tabs are stripped from the
start of a line to a block. Defaults to \fBFalse\fP and corresponds to the
Jinja environment init variable \fBlstrip_blocks\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jinja_lstrip_blocks: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfailhard\fP
.sp
Default: \fBFalse\fP
.sp
Set the global failhard flag. This informs all states to stop running states
at the moment a single state fails.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
failhard: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_verbose\fP
.sp
Default: \fBTrue\fP
.sp
Controls the verbosity of state runs. By default, the results of all states are
returned, but setting this value to \fBFalse\fP will cause salt to only display
output for states that failed or states that have changes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_verbose: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_output\fP
.sp
Default: \fBfull\fP
.sp
The state_output setting controls which results will be output full multi line:
.INDENT 0.0
.IP \(bu 2
\fBfull\fP, \fBterse\fP \- each state will be full/terse
.IP \(bu 2
\fBmixed\fP \- only states with errors will be full
.IP \(bu 2
\fBchanges\fP \- states with changes and errors will be full
.UNINDENT
.sp
\fBfull_id\fP, \fBmixed_id\fP, \fBchanges_id\fP and \fBterse_id\fP are also allowed;
when set, the state ID will be used as name in the output.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_output: full
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_output_diff\fP
.sp
Default: \fBFalse\fP
.sp
The state_output_diff setting changes whether or not the output from
successful states is returned. Useful when even the terse output of these
states is cluttering the logs. Set it to True to ignore them.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_output_diff: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_output_profile\fP
.sp
Default: \fBTrue\fP
.sp
The \fBstate_output_profile\fP setting changes whether profile information
will be shown for each state run.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_output_profile: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_output_pct\fP
.sp
Default: \fBFalse\fP
.sp
The \fBstate_output_pct\fP setting changes whether success and failure information
as a percent of total actions will be shown for each state run.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_output_pct: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_compress_ids\fP
.sp
Default: \fBFalse\fP
.sp
The \fBstate_compress_ids\fP setting aggregates information about states which
have multiple \(dqnames\(dq under the same state ID in the highstate output.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_compress_ids: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_aggregate\fP
.sp
Default: \fBFalse\fP
.sp
Automatically aggregate all states that have support for \fBmod_aggregate\fP by
setting to \fBTrue\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_aggregate: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or pass a list of state module names to automatically
aggregate just those types.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_aggregate:
  \- pkg
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_events\fP
.sp
Default: \fBFalse\fP
.sp
Send progress events as each function in a state run completes execution
by setting to \fBTrue\fP\&. Progress events are in the format
\fBsalt/job/<JID>/prog/<MID>/<RUN NUM>\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_events: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fByaml_utf8\fP
.sp
Default: \fBFalse\fP
.sp
Enable extra routines for YAML renderer used states containing UTF characters.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
yaml_utf8: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrunner_returns\fP
.sp
Default: \fBTrue\fP
.sp
If set to \fBFalse\fP, runner jobs will not be saved to job cache (defined by
\fI\%master_job_cache\fP).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
runner_returns: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Master File Server Settings
.SS \fBfileserver_backend\fP
.sp
Default: \fB[\(aqroots\(aq]\fP
.sp
Salt supports a modular fileserver backend system, this system allows the salt
master to link directly to third party systems to gather and manage the files
available to minions. Multiple backends can be configured and will be searched
for the requested file in the order in which they are defined here. The default
setting only enables the standard backend \fBroots\fP, which is configured using
the \fI\%file_roots\fP option.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_backend:
  \- roots
  \- gitfs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For masterless Salt, this parameter must be specified in the minion config
file.
.UNINDENT
.UNINDENT
.SS \fBfileserver_followsymlinks\fP
.sp
New in version 2014.1.0.

.sp
Default: \fBTrue\fP
.sp
By default, the file_server follows symlinks when walking the filesystem tree.
Currently this only applies to the default roots fileserver_backend.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_followsymlinks: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfileserver_ignoresymlinks\fP
.sp
New in version 2014.1.0.

.sp
Default: \fBFalse\fP
.sp
If you do not want symlinks to be treated as the files they are pointing to,
set \fBfileserver_ignoresymlinks\fP to \fBTrue\fP\&. By default this is set to
False. When set to \fBTrue\fP, any detected symlink while listing files on the
Master will not be returned to the Minion.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_ignoresymlinks: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfileserver_list_cache_time\fP
.sp
New in version 2014.1.0.

.sp
Changed in version 2016.11.0: The default was changed from \fB30\fP seconds to \fB20\fP\&.

.sp
Default: \fB20\fP
.sp
Salt caches the list of files/symlinks/directories for each fileserver backend
and environment as they are requested, to guard against a performance
bottleneck at scale when many minions all ask the fileserver which files are
available simultaneously. This configuration parameter allows for the max age
of that cache to be altered.
.sp
Set this value to \fB0\fP to disable use of this cache altogether, but keep in
mind that this may increase the CPU load on the master when running a highstate
on a large number of minions.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Rather than altering this configuration parameter, it may be advisable to
use the \fI\%fileserver.clear_file_list_cache\fP runner to clear these
caches.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_list_cache_time: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfileserver_verify_config\fP
.sp
New in version 2017.7.0.

.sp
Default: \fBTrue\fP
.sp
By default, as the master starts it performs some sanity checks on the
configured fileserver backends. If any of these sanity checks fail (such as
when an invalid configuration is used), the master daemon will abort.
.sp
To skip these sanity checks, set this option to \fBFalse\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_verify_config: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBhash_type\fP
.sp
Default: \fBsha256\fP
.sp
The hash_type is the hash to use when discovering the hash of a file on
the master server. The default is sha256, but md5, sha1, sha224, sha384, and
sha512 are also supported.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hash_type: sha256
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfile_buffer_size\fP
.sp
Default: \fB1048576\fP
.sp
The buffer size in the file server in bytes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_buffer_size: 1048576
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfile_ignore_regex\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
A regular expression (or a list of expressions) that will be matched
against the file path before syncing the modules and states to the minions.
This includes files affected by the file.recurse state.
For example, if you manage your custom modules and states in subversion
and don\(aqt want all the \(aq.svn\(aq folders and content synced to your minions,
you could set this to \(aq/.svn($|/)\(aq. By default nothing is ignored.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_ignore_regex:
  \- \(aq/\e.svn($|/)\(aq
  \- \(aq/\e.git($|/)\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfile_ignore_glob\fP
.sp
Default \fB\(aq\(aq\fP
.sp
A file glob (or list of file globs) that will be matched against the file
path before syncing the modules and states to the minions. This is similar
to file_ignore_regex above, but works on globs instead of regex. By default
nothing is ignored.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_ignore_glob:
  \- \(aq\e*.pyc\(aq
  \- \(aq\e*/somefolder/\e*.bak\(aq
  \- \(aq\e*.swp\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Vim\(aqs .swp files are a common cause of Unicode errors in
\fI\%file.recurse\fP states which use
templating. Unless there is a good reason to distribute them via the
fileserver, it is good practice to include \fB\(aq\e*.swp\(aq\fP in the
\fI\%file_ignore_glob\fP\&.
.UNINDENT
.UNINDENT
.SS \fBmaster_roots\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
A master\-only copy of the \fI\%file_roots\fP dictionary, used by the
state compiler.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_roots:
  base:
    \- /srv/salt\-master
.ft P
.fi
.UNINDENT
.UNINDENT
.SS roots: Master\(aqs Local File Server
.SS \fBfile_roots\fP
.sp
Changed in version 3005.

.sp
Default:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \- /srv/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt runs a lightweight file server written in ZeroMQ to deliver files to
minions. This file server is built into the master daemon and does not
require a dedicated port.
.sp
The file server works on environments passed to the master. Each environment
can have multiple root directories. The subdirectories in the multiple file
roots cannot match, otherwise the downloaded files will not be able to be
reliably ensured. A base environment is required to house the top file.
.sp
As of 2018.3.5 and 2019.2.1, it is possible to have \fI__env__\fP as a catch\-all environment.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt
  dev:
    \- /srv/salt/dev/services
    \- /srv/salt/dev/states
  prod:
    \- /srv/salt/prod/services
    \- /srv/salt/prod/states
  __env__:
    \- /srv/salt/default
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Taking dynamic environments one step further, \fB__env__\fP can also be used in
the \fBfile_roots\fP filesystem path as of version 3005. It will be replaced with
the actual \fBsaltenv\fP and searched for states and data to provide to the
minion. Note this substitution ONLY occurs for the \fB__env__\fP environment. For
instance, this configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  __env__:
    \- /srv/__env__/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
is equivalent to this static configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  dev:
    \- /srv/dev/salt
  test:
    \- /srv/test/salt
  prod:
    \- /srv/prod/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For masterless Salt, this parameter must be specified in the minion config
file.
.UNINDENT
.UNINDENT
.SS \fBroots_update_interval\fP
.sp
New in version 2018.3.0.

.sp
Default: \fB60\fP
.sp
This option defines the update interval (in seconds) for
\fI\%file_roots\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Since \fBfile_roots\fP consists of files local to the minion, the update
process for this fileserver backend just reaps the cache for this backend.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
roots_update_interval: 120
.ft P
.fi
.UNINDENT
.UNINDENT
.SS gitfs: Git Remote File Server Backend
.SS \fBgitfs_remotes\fP
.sp
Default: \fB[]\fP
.sp
When using the \fBgit\fP fileserver backend at least one git remote needs to be
defined. The user running the salt master will need read access to the repo.
.sp
The repos will be searched in order to find the file requested by a client and
the first repo to have the file will return it. Branches and tags are
translated into salt environments.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- git://github.com/saltstack/salt\-states.git
  \- file:///var/git/saltmaster
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBfile://\fP repos will be treated as a remote and copied into the master\(aqs
gitfs cache, so only the \fIlocal\fP refs for those repos will be exposed as
fileserver environments.
.UNINDENT
.UNINDENT
.sp
As of 2014.7.0, it is possible to have per\-repo versions of several of the
gitfs configuration parameters. For more information, see the \fI\%GitFS
Walkthrough\fP\&.
.SS \fBgitfs_provider\fP
.sp
New in version 2014.7.0.

.sp
Optional parameter used to specify the provider to be used for gitfs. More
information can be found in the \fI\%GitFS Walkthrough\fP\&.
.sp
Must be either \fBpygit2\fP or \fBgitpython\fP\&. If unset, then each will be tried
in that same order, and the first one with a compatible version installed will
be the provider that is used.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_provider: gitpython
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgitfs_ssl_verify\fP
.sp
Default: \fBTrue\fP
.sp
Specifies whether or not to ignore SSL certificate errors when fetching from
the repositories configured in \fI\%gitfs_remotes\fP\&. The \fBFalse\fP
setting is useful if you\(aqre using a git repo that uses a self\-signed
certificate. However, keep in mind that setting this to anything other \fBTrue\fP
is a considered insecure, and using an SSH\-based transport (if available) may
be a better option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_ssl_verify: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
pygit2 only supports disabling SSL verification in versions 0.23.2 and
newer.
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.0: This option can now be configured on individual repositories as well. See
\fI\%here\fP for more info.

.sp
Changed in version 2016.11.0: The default config value changed from \fBFalse\fP to \fBTrue\fP\&.

.SS \fBgitfs_mountpoint\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Specifies a path on the salt fileserver which will be prepended to all files
served by gitfs. This option can be used in conjunction with
\fI\%gitfs_root\fP\&. It can also be configured for an individual
repository, see \fI\%here\fP for more info.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_mountpoint: salt://foo/bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBsalt://\fP protocol designation can be left off (in other words,
\fBfoo/bar\fP and \fBsalt://foo/bar\fP are equivalent). Assuming a file
\fBbaz.sh\fP in the root of a gitfs remote, and the above example mountpoint,
this file would be served up via \fBsalt://foo/bar/baz.sh\fP\&.
.UNINDENT
.UNINDENT
.SS \fBgitfs_root\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
Relative path to a subdirectory within the repository from which Salt should
begin to serve files. This is useful when there are files in the repository
that should not be available to the Salt fileserver. Can be used in conjunction
with \fI\%gitfs_mountpoint\fP\&. If used, then from Salt\(aqs perspective the
directories above the one specified will be ignored and the relative path will
(for the purposes of gitfs) be considered as the root of the repo.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_root: somefolder/otherfolder
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.7.0: This option can now be configured on individual repositories as well. See
\fI\%here\fP for more info.

.SS \fBgitfs_base\fP
.sp
Default: \fBmaster\fP
.sp
Defines which branch/tag should be used as the \fBbase\fP environment.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_base: salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.7.0: This option can now be configured on individual repositories as well. See
\fI\%here\fP for more info.

.SS \fBgitfs_saltenv\fP
.sp
New in version 2016.11.0.

.sp
Default: \fB[]\fP
.sp
Global settings for \fI\%per\-saltenv configuration parameters\fP\&. Though per\-saltenv configuration parameters are
typically one\-off changes specific to a single gitfs remote, and thus more
often configured on a per\-remote basis, this parameter can be used to specify
per\-saltenv changes which should apply to all remotes. For example, the below
configuration will map the \fBdevelop\fP branch to the \fBdev\fP saltenv for all
gitfs remotes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_saltenv:
  \- dev:
    \- ref: develop
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgitfs_disable_saltenv_mapping\fP
.sp
New in version 2018.3.0.

.sp
Default: \fBFalse\fP
.sp
When set to \fBTrue\fP, all saltenv mapping logic is disregarded (aside from
which branch/tag is mapped to the \fBbase\fP saltenv). To use any other
environments, they must then be defined using \fI\%per\-saltenv configuration
parameters\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_disable_saltenv_mapping: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is is a global configuration option, see \fI\%here\fP for examples of configuring it for individual
repositories.
.UNINDENT
.UNINDENT
.SS \fBgitfs_ref_types\fP
.sp
New in version 2018.3.0.

.sp
Default: \fB[\(aqbranch\(aq, \(aqtag\(aq, \(aqsha\(aq]\fP
.sp
This option defines what types of refs are mapped to fileserver environments
(i.e. saltenvs). It also sets the order of preference when there are
ambiguously\-named refs (i.e. when a branch and tag both have the same name).
The below example disables mapping of both tags and SHAs, so that only branches
are mapped as saltenvs:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_ref_types:
  \- branch
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is is a global configuration option, see \fI\%here\fP for examples of configuring it for individual
repositories.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBsha\fP is special in that it will not show up when listing saltenvs (e.g.
with the \fI\%fileserver.envs\fP runner),
but works within states and with \fI\%cp.cache_file\fP to retrieve a file from a specific git SHA.
.UNINDENT
.UNINDENT
.SS \fBgitfs_saltenv_whitelist\fP
.sp
New in version 2014.7.0.

.sp
Changed in version 2018.3.0: Renamed from \fBgitfs_env_whitelist\fP to \fBgitfs_saltenv_whitelist\fP

.sp
Default: \fB[]\fP
.sp
Used to restrict which environments are made available. Can speed up state runs
if the repos in \fI\%gitfs_remotes\fP contain many branches/tags.  More
information can be found in the \fI\%GitFS Walkthrough\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_saltenv_whitelist:
  \- base
  \- v1.*
  \- \(aqmybranch\ed+\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgitfs_saltenv_blacklist\fP
.sp
New in version 2014.7.0.

.sp
Changed in version 2018.3.0: Renamed from \fBgitfs_env_blacklist\fP to \fBgitfs_saltenv_blacklist\fP

.sp
Default: \fB[]\fP
.sp
Used to restrict which environments are made available. Can speed up state runs
if the repos in \fI\%gitfs_remotes\fP contain many branches/tags. More
information can be found in the \fI\%GitFS Walkthrough\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_saltenv_blacklist:
  \- base
  \- v1.*
  \- \(aqmybranch\ed+\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgitfs_global_lock\fP
.sp
New in version 2015.8.9.

.sp
Default: \fBTrue\fP
.sp
When set to \fBFalse\fP, if there is an update lock for a gitfs remote and the
pid written to it is not running on the master, the lock file will be
automatically cleared and a new lock will be obtained. When set to \fBTrue\fP,
Salt will simply log a warning when there is an update lock present.
.sp
On single\-master deployments, disabling this option can help automatically deal
with instances where the master was shutdown/restarted during the middle of a
gitfs update, leaving a update lock in place.
.sp
However, on multi\-master deployments with the gitfs cachedir shared via
\fI\%GlusterFS\fP, nfs, or another network filesystem, it is strongly recommended
not to disable this option as doing so will cause lock files to be removed if
they were created by a different master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Disable global lock
gitfs_global_lock: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgitfs_update_interval\fP
.sp
New in version 2018.3.0.

.sp
Default: \fB60\fP
.sp
This option defines the default update interval (in seconds) for gitfs remotes.
The update interval can also be set for a single repository via a
\fI\%per\-remote config option\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_update_interval: 120
.ft P
.fi
.UNINDENT
.UNINDENT
.SS GitFS Authentication Options
.sp
These parameters only currently apply to the pygit2 gitfs provider. Examples of
how to use these can be found in the \fI\%GitFS Walkthrough\fP\&.
.SS \fBgitfs_user\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Along with \fI\%gitfs_password\fP, is used to authenticate to HTTPS
remotes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_user: git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is is a global configuration option, see \fI\%here\fP for examples of configuring it for individual
repositories.
.UNINDENT
.UNINDENT
.SS \fBgitfs_password\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Along with \fI\%gitfs_user\fP, is used to authenticate to HTTPS remotes.
This parameter is not required if the repository does not use authentication.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_password: mypassword
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is is a global configuration option, see \fI\%here\fP for examples of configuring it for individual
repositories.
.UNINDENT
.UNINDENT
.SS \fBgitfs_insecure_auth\fP
.sp
New in version 2014.7.0.

.sp
Default: \fBFalse\fP
.sp
By default, Salt will not authenticate to an HTTP (non\-HTTPS) remote. This
parameter enables authentication over HTTP. \fBEnable this at your own risk.\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_insecure_auth: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is is a global configuration option, see \fI\%here\fP for examples of configuring it for individual
repositories.
.UNINDENT
.UNINDENT
.SS \fBgitfs_pubkey\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Along with \fI\%gitfs_privkey\fP (and optionally
\fI\%gitfs_passphrase\fP), is used to authenticate to SSH remotes.
Required for SSH remotes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_pubkey: /path/to/key.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is is a global configuration option, see \fI\%here\fP for examples of configuring it for individual
repositories.
.UNINDENT
.UNINDENT
.SS \fBgitfs_privkey\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Along with \fI\%gitfs_pubkey\fP (and optionally
\fI\%gitfs_passphrase\fP), is used to authenticate to SSH remotes.
Required for SSH remotes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_privkey: /path/to/key
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is is a global configuration option, see \fI\%here\fP for examples of configuring it for individual
repositories.
.UNINDENT
.UNINDENT
.SS \fBgitfs_passphrase\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
This parameter is optional, required only when the SSH key being used to
authenticate is protected by a passphrase.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_passphrase: mypassphrase
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is is a global configuration option, see \fI\%here\fP for examples of configuring it for individual
repositories.
.UNINDENT
.UNINDENT
.SS \fBgitfs_refspecs\fP
.sp
New in version 2017.7.0.

.sp
Default: \fB[\(aq+refs/heads/*:refs/remotes/origin/*\(aq, \(aq+refs/tags/*:refs/tags/*\(aq]\fP
.sp
When fetching from remote repositories, by default Salt will fetch branches and
tags. This parameter can be used to override the default and specify
alternate refspecs to be fetched. More information on how this feature works
can be found in the \fI\%GitFS Walkthrough\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_refspecs:
  \- \(aq+refs/heads/*:refs/remotes/origin/*\(aq
  \- \(aq+refs/tags/*:refs/tags/*\(aq
  \- \(aq+refs/pull/*/head:refs/remotes/origin/pr/*\(aq
  \- \(aq+refs/pull/*/merge:refs/remotes/origin/merge/*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS hgfs: Mercurial Remote File Server Backend
.SS \fBhgfs_remotes\fP
.sp
New in version 0.17.0.

.sp
Default: \fB[]\fP
.sp
When using the \fBhg\fP fileserver backend at least one mercurial remote needs to
be defined. The user running the salt master will need read access to the repo.
.sp
The repos will be searched in order to find the file requested by a client and
the first repo to have the file will return it. Branches and/or bookmarks are
translated into salt environments, as defined by the
\fI\%hgfs_branch_method\fP parameter.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hgfs_remotes:
  \- https://username@bitbucket.org/username/reponame
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
As of 2014.7.0, it is possible to have per\-repo versions of the
\fI\%hgfs_root\fP, \fI\%hgfs_mountpoint\fP,
\fI\%hgfs_base\fP, and \fI\%hgfs_branch_method\fP parameters.
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hgfs_remotes:
  \- https://username@bitbucket.org/username/repo1
    \- base: saltstates
  \- https://username@bitbucket.org/username/repo2:
    \- root: salt
    \- mountpoint: salt://foo/bar/baz
  \- https://username@bitbucket.org/username/repo3:
    \- root: salt/states
    \- branch_method: mixed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fBhgfs_branch_method\fP
.sp
New in version 0.17.0.

.sp
Default: \fBbranches\fP
.sp
Defines the objects that will be used as fileserver environments.
.INDENT 0.0
.IP \(bu 2
\fBbranches\fP \- Only branches and tags will be used
.IP \(bu 2
\fBbookmarks\fP \- Only bookmarks and tags will be used
.IP \(bu 2
\fBmixed\fP \- Branches, bookmarks, and tags will be used
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hgfs_branch_method: mixed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Starting in version 2014.1.0, the value of the \fI\%hgfs_base\fP
parameter defines which branch is used as the \fBbase\fP environment,
allowing for a \fBbase\fP environment to be used with an
\fI\%hgfs_branch_method\fP of \fBbookmarks\fP\&.
.sp
Prior to this release, the \fBdefault\fP branch will be used as the \fBbase\fP
environment.
.UNINDENT
.UNINDENT
.SS \fBhgfs_mountpoint\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Specifies a path on the salt fileserver which will be prepended to all files
served by hgfs. This option can be used in conjunction with
\fI\%hgfs_root\fP\&. It can also be configured on a per\-remote basis, see
\fI\%here\fP for more info.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hgfs_mountpoint: salt://foo/bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBsalt://\fP protocol designation can be left off (in other words,
\fBfoo/bar\fP and \fBsalt://foo/bar\fP are equivalent). Assuming a file
\fBbaz.sh\fP in the root of an hgfs remote, this file would be served up via
\fBsalt://foo/bar/baz.sh\fP\&.
.UNINDENT
.UNINDENT
.SS \fBhgfs_root\fP
.sp
New in version 0.17.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Relative path to a subdirectory within the repository from which Salt should
begin to serve files. This is useful when there are files in the repository
that should not be available to the Salt fileserver. Can be used in conjunction
with \fI\%hgfs_mountpoint\fP\&. If used, then from Salt\(aqs perspective the
directories above the one specified will be ignored and the relative path will
(for the purposes of hgfs) be considered as the root of the repo.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hgfs_root: somefolder/otherfolder
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.7.0: Ability to specify hgfs roots on a per\-remote basis was added. See
\fI\%here\fP for more info.

.SS \fBhgfs_base\fP
.sp
New in version 2014.1.0.

.sp
Default: \fBdefault\fP
.sp
Defines which branch should be used as the \fBbase\fP environment. Change this if
\fI\%hgfs_branch_method\fP is set to \fBbookmarks\fP to specify which
bookmark should be used as the \fBbase\fP environment.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hgfs_base: salt
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBhgfs_saltenv_whitelist\fP
.sp
New in version 2014.7.0.

.sp
Changed in version 2018.3.0: Renamed from \fBhgfs_env_whitelist\fP to \fBhgfs_saltenv_whitelist\fP

.sp
Default: \fB[]\fP
.sp
Used to restrict which environments are made available. Can speed up state runs
if your hgfs remotes contain many branches/bookmarks/tags. Full names, globs,
and regular expressions are supported. If using a regular expression, the
expression must match the entire minion ID.
.sp
If used, only branches/bookmarks/tags which match one of the specified
expressions will be exposed as fileserver environments.
.sp
If used in conjunction with \fI\%hgfs_saltenv_blacklist\fP, then the subset
of branches/bookmarks/tags which match the whitelist but do \fInot\fP match the
blacklist will be exposed as fileserver environments.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hgfs_saltenv_whitelist:
  \- base
  \- v1.*
  \- \(aqmybranch\ed+\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBhgfs_saltenv_blacklist\fP
.sp
New in version 2014.7.0.

.sp
Changed in version 2018.3.0: Renamed from \fBhgfs_env_blacklist\fP to \fBhgfs_saltenv_blacklist\fP

.sp
Default: \fB[]\fP
.sp
Used to restrict which environments are made available. Can speed up state runs
if your hgfs remotes contain many branches/bookmarks/tags. Full names, globs,
and regular expressions are supported. If using a regular expression, the
expression must match the entire minion ID.
.sp
If used, branches/bookmarks/tags which match one of the specified expressions
will \fInot\fP be exposed as fileserver environments.
.sp
If used in conjunction with \fI\%hgfs_saltenv_whitelist\fP, then the subset
of branches/bookmarks/tags which match the whitelist but do \fInot\fP match the
blacklist will be exposed as fileserver environments.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hgfs_saltenv_blacklist:
  \- base
  \- v1.*
  \- \(aqmybranch\ed+\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBhgfs_update_interval\fP
.sp
New in version 2018.3.0.

.sp
Default: \fB60\fP
.sp
This option defines the update interval (in seconds) for
\fI\%hgfs_remotes\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hgfs_update_interval: 120
.ft P
.fi
.UNINDENT
.UNINDENT
.SS svnfs: Subversion Remote File Server Backend
.SS \fBsvnfs_remotes\fP
.sp
New in version 0.17.0.

.sp
Default: \fB[]\fP
.sp
When using the \fBsvn\fP fileserver backend at least one subversion remote needs
to be defined. The user running the salt master will need read access to the
repo.
.sp
The repos will be searched in order to find the file requested by a client and
the first repo to have the file will return it. The trunk, branches, and tags
become environments, with the trunk being the \fBbase\fP environment.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
svnfs_remotes:
  \- svn://foo.com/svn/myproject
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
As of 2014.7.0, it is possible to have per\-repo versions of the following
configuration parameters:
.INDENT 0.0
.IP \(bu 2
\fI\%svnfs_root\fP
.IP \(bu 2
\fI\%svnfs_mountpoint\fP
.IP \(bu 2
\fI\%svnfs_trunk\fP
.IP \(bu 2
\fI\%svnfs_branches\fP
.IP \(bu 2
\fI\%svnfs_tags\fP
.UNINDENT
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
svnfs_remotes:
  \- svn://foo.com/svn/project1
  \- svn://foo.com/svn/project2:
    \- root: salt
    \- mountpoint: salt://foo/bar/baz
  \- svn//foo.com/svn/project3:
    \- root: salt/states
    \- branches: branch
    \- tags: tag
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fBsvnfs_mountpoint\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Specifies a path on the salt fileserver which will be prepended to all files
served by hgfs. This option can be used in conjunction with
\fI\%svnfs_root\fP\&. It can also be configured on a per\-remote basis, see
\fI\%here\fP for more info.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
svnfs_mountpoint: salt://foo/bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBsalt://\fP protocol designation can be left off (in other words,
\fBfoo/bar\fP and \fBsalt://foo/bar\fP are equivalent). Assuming a file
\fBbaz.sh\fP in the root of an svnfs remote, this file would be served up via
\fBsalt://foo/bar/baz.sh\fP\&.
.UNINDENT
.UNINDENT
.SS \fBsvnfs_root\fP
.sp
New in version 0.17.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Relative path to a subdirectory within the repository from which Salt should
begin to serve files. This is useful when there are files in the repository
that should not be available to the Salt fileserver. Can be used in conjunction
with \fI\%svnfs_mountpoint\fP\&. If used, then from Salt\(aqs perspective the
directories above the one specified will be ignored and the relative path will
(for the purposes of svnfs) be considered as the root of the repo.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
svnfs_root: somefolder/otherfolder
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.7.0: Ability to specify svnfs roots on a per\-remote basis was added. See
\fI\%here\fP for more info.

.SS \fBsvnfs_trunk\fP
.sp
New in version 2014.7.0.

.sp
Default: \fBtrunk\fP
.sp
Path relative to the root of the repository where the trunk is located. Can
also be configured on a per\-remote basis, see \fI\%here\fP for more info.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
svnfs_trunk: trunk
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsvnfs_branches\fP
.sp
New in version 2014.7.0.

.sp
Default: \fBbranches\fP
.sp
Path relative to the root of the repository where the branches are located. Can
also be configured on a per\-remote basis, see \fI\%here\fP for more info.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
svnfs_branches: branches
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsvnfs_tags\fP
.sp
New in version 2014.7.0.

.sp
Default: \fBtags\fP
.sp
Path relative to the root of the repository where the tags are located. Can
also be configured on a per\-remote basis, see \fI\%here\fP for more info.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
svnfs_tags: tags
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsvnfs_saltenv_whitelist\fP
.sp
New in version 2014.7.0.

.sp
Changed in version 2018.3.0: Renamed from \fBsvnfs_env_whitelist\fP to \fBsvnfs_saltenv_whitelist\fP

.sp
Default: \fB[]\fP
.sp
Used to restrict which environments are made available. Can speed up state runs
if your svnfs remotes contain many branches/tags. Full names, globs, and
regular expressions are supported. If using a regular expression, the expression
must match the entire minion ID.
.sp
If used, only branches/tags which match one of the specified expressions will
be exposed as fileserver environments.
.sp
If used in conjunction with \fI\%svnfs_saltenv_blacklist\fP, then the subset
of branches/tags which match the whitelist but do \fInot\fP match the blacklist
will be exposed as fileserver environments.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
svnfs_saltenv_whitelist:
  \- base
  \- v1.*
  \- \(aqmybranch\ed+\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsvnfs_saltenv_blacklist\fP
.sp
New in version 2014.7.0.

.sp
Changed in version 2018.3.0: Renamed from \fBsvnfs_env_blacklist\fP to \fBsvnfs_saltenv_blacklist\fP

.sp
Default: \fB[]\fP
.sp
Used to restrict which environments are made available. Can speed up state runs
if your svnfs remotes contain many branches/tags. Full names, globs, and
regular expressions are supported. If using a regular expression, the
expression must match the entire minion ID.
.sp
If used, branches/tags which match one of the specified expressions will \fInot\fP
be exposed as fileserver environments.
.sp
If used in conjunction with \fI\%svnfs_saltenv_whitelist\fP, then the subset
of branches/tags which match the whitelist but do \fInot\fP match the blacklist
will be exposed as fileserver environments.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
svnfs_saltenv_blacklist:
  \- base
  \- v1.*
  \- \(aqmybranch\ed+\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsvnfs_update_interval\fP
.sp
New in version 2018.3.0.

.sp
Default: \fB60\fP
.sp
This option defines the update interval (in seconds) for
\fI\%svnfs_remotes\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
svnfs_update_interval: 120
.ft P
.fi
.UNINDENT
.UNINDENT
.SS minionfs: MinionFS Remote File Server Backend
.SS \fBminionfs_env\fP
.sp
New in version 2014.7.0.

.sp
Default: \fBbase\fP
.sp
Environment from which MinionFS files are made available.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minionfs_env: minionfs
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBminionfs_mountpoint\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Specifies a path on the salt fileserver from which minionfs files are served.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minionfs_mountpoint: salt://foo/bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBsalt://\fP protocol designation can be left off (in other words,
\fBfoo/bar\fP and \fBsalt://foo/bar\fP are equivalent).
.UNINDENT
.UNINDENT
.SS \fBminionfs_whitelist\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB[]\fP
.sp
Used to restrict which minions\(aq pushed files are exposed via minionfs. If using
a regular expression, the expression must match the entire minion ID.
.sp
If used, only the pushed files from minions which match one of the specified
expressions will be exposed.
.sp
If used in conjunction with \fI\%minionfs_blacklist\fP, then the subset
of hosts which match the whitelist but do \fInot\fP match the blacklist will be
exposed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minionfs_whitelist:
  \- server01
  \- dev*
  \- \(aqmail\ed+.mydomain.tld\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBminionfs_blacklist\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB[]\fP
.sp
Used to restrict which minions\(aq pushed files are exposed via minionfs. If using
a regular expression, the expression must match the entire minion ID.
.sp
If used, only the pushed files from minions which match one of the specified
expressions will \fInot\fP be exposed.
.sp
If used in conjunction with \fI\%minionfs_whitelist\fP, then the subset
of hosts which match the whitelist but do \fInot\fP match the blacklist will be
exposed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minionfs_blacklist:
  \- server01
  \- dev*
  \- \(aqmail\ed+.mydomain.tld\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBminionfs_update_interval\fP
.sp
New in version 2018.3.0.

.sp
Default: \fB60\fP
.sp
This option defines the update interval (in seconds) for \fI\%MinionFS\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Since \fI\%MinionFS\fP consists of files local to the
master, the update process for this fileserver backend just reaps the cache
for this backend.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minionfs_update_interval: 120
.ft P
.fi
.UNINDENT
.UNINDENT
.SS s3fs: S3 File Server Backend
.sp
New in version 0.16.0.

.sp
See the \fI\%s3fs documentation\fP for usage examples.
.SS \fBs3fs_update_interval\fP
.sp
New in version 2018.3.0.

.sp
Default: \fB60\fP
.sp
This option defines the update interval (in seconds) for s3fs.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
s3fs_update_interval: 120
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfileserver_interval\fP
.sp
New in version 3006.0.

.sp
Default: \fB3600\fP
.sp
Defines how often to restart the master\(aqs FilesServerUpdate process.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_interval: 9600
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Pillar Configuration
.SS \fBpillar_roots\fP
.sp
Changed in version 3005.

.sp
Default:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \- /srv/pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Set the environments and directories used to hold pillar sls data. This
configuration is the same as \fI\%file_roots\fP:
.sp
As of 2017.7.5 and 2018.3.1, it is possible to have \fI__env__\fP as a catch\-all environment.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_roots:
  base:
    \- /srv/pillar
  dev:
    \- /srv/pillar/dev
  prod:
    \- /srv/pillar/prod
  __env__:
    \- /srv/pillar/others
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Taking dynamic environments one step further, \fB__env__\fP can also be used in
the \fBpillar_roots\fP filesystem path as of version 3005. It will be replaced
with the actual \fBpillarenv\fP and searched for Pillar data to provide to the
minion. Note this substitution ONLY occurs for the \fB__env__\fP environment. For
instance, this configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_roots:
  __env__:
    \- /srv/__env__/pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
is equivalent to this static configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_roots:
  dev:
    \- /srv/dev/pillar
  test:
    \- /srv/test/pillar
  prod:
    \- /srv/prod/pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBon_demand_ext_pillar\fP
.sp
New in version 2016.3.6,2016.11.3,2017.7.0.

.sp
Default: \fB[\(aqlibvirt\(aq, \(aqvirtkey\(aq]\fP
.sp
The external pillars permitted to be used on\-demand using \fI\%pillar.ext\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
on_demand_ext_pillar:
  \- libvirt
  \- virtkey
  \- git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This will allow minions to request specific pillar data via
\fI\%pillar.ext\fP, and may be considered a
security risk. However, pillar data generated in this way will not affect
the \fI\%in\-memory pillar data\fP, so this risk is
limited to instances in which states/modules/etc. (built\-in or custom) rely
upon pillar data generated by \fI\%pillar.ext\fP\&.
.UNINDENT
.UNINDENT
.SS \fBdecrypt_pillar\fP
.sp
New in version 2017.7.0.

.sp
Default: \fB[]\fP
.sp
A list of paths to be recursively decrypted during pillar compilation.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
decrypt_pillar:
  \- \(aqfoo:bar\(aq: gpg
  \- \(aqlorem:ipsum:dolor\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Entries in this list can be formatted either as a simple string, or as a
key/value pair, with the key being the pillar location, and the value being the
renderer to use for pillar decryption. If the former is used, the renderer
specified by \fI\%decrypt_pillar_default\fP will be used.
.SS \fBdecrypt_pillar_delimiter\fP
.sp
New in version 2017.7.0.

.sp
Default: \fB:\fP
.sp
The delimiter used to distinguish nested data structures in the
\fI\%decrypt_pillar\fP option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
decrypt_pillar_delimiter: \(aq|\(aq
decrypt_pillar:
  \- \(aqfoo|bar\(aq: gpg
  \- \(aqlorem|ipsum|dolor\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBdecrypt_pillar_default\fP
.sp
New in version 2017.7.0.

.sp
Default: \fBgpg\fP
.sp
The default renderer used for decryption, if one is not specified for a given
pillar key in \fI\%decrypt_pillar\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
decrypt_pillar_default: my_custom_renderer
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBdecrypt_pillar_renderers\fP
.sp
New in version 2017.7.0.

.sp
Default: \fB[\(aqgpg\(aq]\fP
.sp
List of renderers which are permitted to be used for pillar decryption.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
decrypt_pillar_renderers:
  \- gpg
  \- my_custom_renderer
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgpg_decrypt_must_succeed\fP
.sp
New in version 3005.

.sp
Default: \fBFalse\fP
.sp
If this is \fBTrue\fP and the ciphertext could not be decrypted, then an error is
raised.
.sp
Sending the ciphertext through basically is \fInever\fP desired, for example if a
state is setting a database password from pillar and gpg rendering fails, then
the state will update the password to the ciphertext, which by definition is
not encrypted.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
The value defaults to \fBFalse\fP for backwards compatibility.  In the
\fBChlorine\fP release, this option will default to \fBTrue\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gpg_decrypt_must_succeed: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpillar_opts\fP
.sp
Default: \fBFalse\fP
.sp
The \fBpillar_opts\fP option adds the master configuration file data to a dict in
the pillar called \fBmaster\fP\&. This can be used to set simple configurations in
the master config file that can then be used on minions.
.sp
Note that setting this option to \fBTrue\fP means the master config file will be
included in all minion\(aqs pillars. While this makes global configuration of services
and systems easy, it may not be desired if sensitive data is stored in the master
configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_opts: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpillar_safe_render_error\fP
.sp
Default: \fBTrue\fP
.sp
The pillar_safe_render_error option prevents the master from passing pillar
render errors to the minion. This is set on by default because the error could
contain templating data which would give that minion information it shouldn\(aqt
have, like a password! When set \fBTrue\fP the error message will only show:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Rendering SLS \(aqmy.sls\(aq failed. Please see master log for details.
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_safe_render_error: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBext_pillar\fP
.sp
The ext_pillar option allows for any number of external pillar interfaces to be
called when populating pillar data. The configuration is based on ext_pillar
functions. The available ext_pillar functions can be found herein:
.sp
\fI\%salt/pillar\fP
.sp
By default, the ext_pillar interface is not configured to run.
.sp
Default: \fB[]\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- hiera: /etc/hiera.yaml
  \- cmd_yaml: cat /etc/salt/yaml
  \- reclass:
      inventory_base_uri: /etc/reclass
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There are additional details at \fI\%Pillars\fP
.SS \fBext_pillar_first\fP
.sp
New in version 2015.5.0.

.sp
Default: \fBFalse\fP
.sp
This option allows for external pillar sources to be evaluated before
\fI\%pillar_roots\fP\&. External pillar data is evaluated separately from
\fI\%pillar_roots\fP pillar data, and then both sets of pillar data are
merged into a single pillar dictionary, so the value of this config option will
have an impact on which key \(dqwins\(dq when there is one of the same name in both
the external pillar data and \fI\%pillar_roots\fP pillar data. By
setting this option to \fBTrue\fP, ext_pillar keys will be overridden by
\fI\%pillar_roots\fP, while leaving it as \fBFalse\fP will allow
ext_pillar keys to override those from \fI\%pillar_roots\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For a while, this config option did not work as specified above, because of
a bug in Pillar compilation. This bug has been resolved in version 2016.3.4
and later.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar_first: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpillarenv_from_saltenv\fP
.sp
Default: \fBFalse\fP
.sp
When set to \fBTrue\fP, the \fBpillarenv\fP value will assume the value
of the effective saltenv when running states. This essentially makes \fBsalt\-run
pillar.show_pillar saltenv=dev\fP equivalent to \fBsalt\-run pillar.show_pillar
saltenv=dev pillarenv=dev\fP\&. If \fBpillarenv\fP is set on the CLI, it
will override this option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillarenv_from_saltenv: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For salt remote execution commands this option should be set in the Minion
configuration instead.
.UNINDENT
.UNINDENT
.SS \fBpillar_raise_on_missing\fP
.sp
New in version 2015.5.0.

.sp
Default: \fBFalse\fP
.sp
Set this option to \fBTrue\fP to force a \fBKeyError\fP to be raised whenever an
attempt to retrieve a named value from pillar fails. When this option is set
to \fBFalse\fP, the failed attempt returns an empty string.
.SS Git External Pillar (git_pillar) Configuration Options
.SS \fBgit_pillar_provider\fP
.sp
New in version 2015.8.0.

.sp
Specify the provider to be used for git_pillar. Must be either \fBpygit2\fP or
\fBgitpython\fP\&. If unset, then both will be tried in that same order, and the
first one with a compatible version installed will be the provider that is
used.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_provider: gitpython
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgit_pillar_base\fP
.sp
New in version 2015.8.0.

.sp
Default: \fBmaster\fP
.sp
If the desired branch matches this value, and the environment is omitted from
the git_pillar configuration, then the environment for that git_pillar remote
will be \fBbase\fP\&. For example, in the configuration below, the \fBfoo\fP
branch/tag would be assigned to the \fBbase\fP environment, while \fBbar\fP would
be mapped to the \fBbar\fP environment.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_base: foo

ext_pillar:
  \- git:
    \- foo https://mygitserver/git\-pillar.git
    \- bar https://mygitserver/git\-pillar.git
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgit_pillar_branch\fP
.sp
New in version 2015.8.0.

.sp
Default: \fBmaster\fP
.sp
If the branch is omitted from a git_pillar remote, then this branch will be
used instead. For example, in the configuration below, the first two remotes
would use the \fBpillardata\fP branch/tag, while the third would use the \fBfoo\fP
branch/tag.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_branch: pillardata

ext_pillar:
  \- git:
    \- https://mygitserver/pillar1.git
    \- https://mygitserver/pillar2.git:
      \- root: pillar
    \- foo https://mygitserver/pillar3.git
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgit_pillar_env\fP
.sp
New in version 2015.8.0.

.sp
Default: \fB\(aq\(aq\fP (unset)
.sp
Environment to use for git_pillar remotes. This is normally derived from the
branch/tag (or from a per\-remote \fBenv\fP parameter), but if set this will
override the process of deriving the env from the branch/tag name. For example,
in the configuration below the \fBfoo\fP branch would be assigned to the \fBbase\fP
environment, while the \fBbar\fP branch would need to explicitly have \fBbar\fP
configured as its environment to keep it from also being mapped to the
\fBbase\fP environment.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_env: base

ext_pillar:
  \- git:
    \- foo https://mygitserver/git\-pillar.git
    \- bar https://mygitserver/git\-pillar.git:
      \- env: bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For this reason, this option is recommended to be left unset, unless the use
case calls for all (or almost all) of the git_pillar remotes to use the same
environment irrespective of the branch/tag being used.
.SS \fBgit_pillar_root\fP
.sp
New in version 2015.8.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Path relative to the root of the repository where the git_pillar top file and
SLS files are located. In the below configuration, the pillar top file and SLS
files would be looked for in a subdirectory called \fBpillar\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_root: pillar

ext_pillar:
  \- git:
    \- master https://mygitserver/pillar1.git
    \- master https://mygitserver/pillar2.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is a global option. If only one or two repos need to have their files
sourced from a subdirectory, then \fI\%git_pillar_root\fP can be
omitted and the root can be specified on a per\-remote basis, like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- git:
    \- master https://mygitserver/pillar1.git
    \- master https://mygitserver/pillar2.git:
      \- root: pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example, for the first remote the top file and SLS files would be
looked for in the root of the repository, while in the second remote the
pillar data would be retrieved from the \fBpillar\fP subdirectory.
.UNINDENT
.UNINDENT
.SS \fBgit_pillar_ssl_verify\fP
.sp
New in version 2015.8.0.

.sp
Changed in version 2016.11.0.

.sp
Default: \fBFalse\fP
.sp
Specifies whether or not to ignore SSL certificate errors when contacting the
remote repository. The \fBFalse\fP setting is useful if you\(aqre using a
git repo that uses a self\-signed certificate. However, keep in mind that
setting this to anything other \fBTrue\fP is a considered insecure, and using an
SSH\-based transport (if available) may be a better option.
.sp
In the 2016.11.0 release, the default config value changed from \fBFalse\fP to
\fBTrue\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_ssl_verify: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
pygit2 only supports disabling SSL verification in versions 0.23.2 and
newer.
.UNINDENT
.UNINDENT
.SS \fBgit_pillar_global_lock\fP
.sp
New in version 2015.8.9.

.sp
Default: \fBTrue\fP
.sp
When set to \fBFalse\fP, if there is an update/checkout lock for a git_pillar
remote and the pid written to it is not running on the master, the lock file
will be automatically cleared and a new lock will be obtained. When set to
\fBTrue\fP, Salt will simply log a warning when there is an lock present.
.sp
On single\-master deployments, disabling this option can help automatically deal
with instances where the master was shutdown/restarted during the middle of a
git_pillar update/checkout, leaving a lock in place.
.sp
However, on multi\-master deployments with the git_pillar cachedir shared via
\fI\%GlusterFS\fP, nfs, or another network filesystem, it is strongly recommended
not to disable this option as doing so will cause lock files to be removed if
they were created by a different master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Disable global lock
git_pillar_global_lock: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgit_pillar_includes\fP
.sp
New in version 2017.7.0.

.sp
Default: \fBTrue\fP
.sp
Normally, when processing \fI\%git_pillar remotes\fP, if more than one repo under the same \fBgit\fP
section in the \fBext_pillar\fP configuration refers to the same pillar
environment, then each repo in a given environment will have access to the
other repos\(aq files to be referenced in their top files. However, it may be
desirable to disable this behavior. If so, set this value to \fBFalse\fP\&.
.sp
For a more detailed examination of how includes work, see \fI\%this
explanation\fP from the git_pillar documentation.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_includes: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgit_pillar_update_interval\fP
.sp
New in version 3000.

.sp
Default: \fB60\fP
.sp
This option defines the default update interval (in seconds) for git_pillar
remotes. The update is handled within the global loop, hence
\fBgit_pillar_update_interval\fP should be a multiple of \fBloop_interval\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_update_interval: 120
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Git External Pillar Authentication Options
.sp
These parameters only currently apply to the \fBpygit2\fP
\fI\%git_pillar_provider\fP\&. Authentication works the same as it does
in gitfs, as outlined in the \fI\%GitFS Walkthrough\fP,
though the global configuration options are named differently to reflect that
they are for git_pillar instead of gitfs.
.SS \fBgit_pillar_user\fP
.sp
New in version 2015.8.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Along with \fI\%git_pillar_password\fP, is used to authenticate to HTTPS
remotes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_user: git
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgit_pillar_password\fP
.sp
New in version 2015.8.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Along with \fI\%git_pillar_user\fP, is used to authenticate to HTTPS
remotes. This parameter is not required if the repository does not use
authentication.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_password: mypassword
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgit_pillar_insecure_auth\fP
.sp
New in version 2015.8.0.

.sp
Default: \fBFalse\fP
.sp
By default, Salt will not authenticate to an HTTP (non\-HTTPS) remote. This
parameter enables authentication over HTTP. \fBEnable this at your own risk.\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_insecure_auth: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgit_pillar_pubkey\fP
.sp
New in version 2015.8.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Along with \fI\%git_pillar_privkey\fP (and optionally
\fI\%git_pillar_passphrase\fP), is used to authenticate to SSH remotes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_pubkey: /path/to/key.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgit_pillar_privkey\fP
.sp
New in version 2015.8.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Along with \fI\%git_pillar_pubkey\fP (and optionally
\fI\%git_pillar_passphrase\fP), is used to authenticate to SSH remotes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_privkey: /path/to/key
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgit_pillar_passphrase\fP
.sp
New in version 2015.8.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
This parameter is optional, required only when the SSH key being used to
authenticate is protected by a passphrase.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_passphrase: mypassphrase
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgit_pillar_refspecs\fP
.sp
New in version 2017.7.0.

.sp
Default: \fB[\(aq+refs/heads/*:refs/remotes/origin/*\(aq, \(aq+refs/tags/*:refs/tags/*\(aq]\fP
.sp
When fetching from remote repositories, by default Salt will fetch branches and
tags. This parameter can be used to override the default and specify
alternate refspecs to be fetched. This parameter works similarly to its
\fI\%GitFS counterpart\fP, in that it can be
configured both globally and for individual remotes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_refspecs:
  \- \(aq+refs/heads/*:refs/remotes/origin/*\(aq
  \- \(aq+refs/tags/*:refs/tags/*\(aq
  \- \(aq+refs/pull/*/head:refs/remotes/origin/pr/*\(aq
  \- \(aq+refs/pull/*/merge:refs/remotes/origin/merge/*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgit_pillar_verify_config\fP
.sp
New in version 2017.7.0.

.sp
Default: \fBTrue\fP
.sp
By default, as the master starts it performs some sanity checks on the
configured git_pillar repositories. If any of these sanity checks fail (such as
when an invalid configuration is used), the master daemon will abort.
.sp
To skip these sanity checks, set this option to \fBFalse\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_verify_config: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Pillar Merging Options
.SS \fBpillar_source_merging_strategy\fP
.sp
New in version 2014.7.0.

.sp
Default: \fBsmart\fP
.sp
The pillar_source_merging_strategy option allows you to configure merging
strategy between different sources. It accepts 5 values:
.INDENT 0.0
.IP \(bu 2
\fBnone\fP:
.sp
It will not do any merging at all and only parse the pillar data from the passed environment and \(aqbase\(aq if no environment was specified.
.sp
New in version 2016.3.4.

.IP \(bu 2
\fBrecurse\fP:
.sp
It will recursively merge data. For example, theses 2 sources:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
foo: 42
bar:
    element1: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
bar:
    element2: True
baz: quux
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will be merged as:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
foo: 42
bar:
    element1: True
    element2: True
baz: quux
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBaggregate\fP:
.sp
instructs aggregation of elements between sources that use the #!yamlex renderer.
.sp
For example, these two documents:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
foo: 42
bar: !aggregate {
  element1: True
}
baz: !aggregate quux
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
bar: !aggregate {
  element2: True
}
baz: !aggregate quux2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will be merged as:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
foo: 42
bar:
  element1: True
  element2: True
baz:
  \- quux
  \- quux2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This requires that the \fI\%render pipeline\fP
defined in the \fI\%renderer\fP master configuration ends in
\fByamlex\fP\&.
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBoverwrite\fP:
.sp
Will use the behaviour of the 2014.1 branch and earlier.
.sp
Overwrites elements according the order in which they are processed.
.sp
First pillar processed:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
A:
  first_key: blah
  second_key: blah
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Second pillar processed:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
A:
  third_key: blah
  fourth_key: blah
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will be merged as:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
A:
  third_key: blah
  fourth_key: blah
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBsmart\fP (default):
.sp
Guesses the best strategy based on the \(dqrenderer\(dq setting.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In order for yamlex based features such as \fB!aggregate\fP to work as expected
across documents using the default \fBsmart\fP merge strategy, the \fI\%renderer\fP
config option must be set to \fBjinja|yamlex\fP or similar.
.UNINDENT
.UNINDENT
.SS \fBpillar_merge_lists\fP
.sp
New in version 2015.8.0.

.sp
Default: \fBFalse\fP
.sp
Recursively merge lists by aggregating them instead of replacing them.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_merge_lists: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpillar_includes_override_sls\fP
.sp
New in version 2017.7.6,2018.3.1.

.sp
Default: \fBFalse\fP
.sp
Prior to version 2017.7.3, keys from \fI\%pillar includes\fP
would be merged on top of the pillar SLS. Since 2017.7.3, the includes are
merged together and then the pillar SLS is merged on top of that.
.sp
Set this option to \fBTrue\fP to return to the old behavior.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_includes_override_sls: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Pillar Cache Options
.SS \fBpillar_cache\fP
.sp
New in version 2015.8.8.

.sp
Default: \fBFalse\fP
.sp
A master can cache pillars locally to bypass the expense of having to render them
for each minion on every request. This feature should only be enabled in cases
where pillar rendering time is known to be unsatisfactory and any attendant security
concerns about storing pillars in a master cache have been addressed.
.sp
When enabling this feature, be certain to read through the additional \fBpillar_cache_*\fP
configuration options to fully understand the tunable parameters and their implications.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_cache: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Setting \fBpillar_cache: True\fP has no effect on
\fI\%targeting minions with pillar\fP\&.
.UNINDENT
.UNINDENT
.SS \fBpillar_cache_ttl\fP
.sp
New in version 2015.8.8.

.sp
Default: \fB3600\fP
.sp
If and only if a master has set \fBpillar_cache: True\fP, the cache TTL controls the amount
of time, in seconds, before the cache is considered invalid by a master and a fresh
pillar is recompiled and stored.
The cache TTL does not prevent pillar cache from being refreshed before its TTL expires.
.SS \fBpillar_cache_backend\fP
.sp
New in version 2015.8.8.

.sp
Default: \fBdisk\fP
.sp
If an only if a master has set \fBpillar_cache: True\fP, one of several storage providers
can be utilized:
.INDENT 0.0
.IP \(bu 2
\fBdisk\fP (default):
.sp
The default storage backend. This caches rendered pillars to the master cache.
Rendered pillars are serialized and deserialized as \fBmsgpack\fP structures for speed.
Note that pillars are stored UNENCRYPTED. Ensure that the master cache has permissions
set appropriately (sane defaults are provided).
.IP \(bu 2
\fBmemory\fP [EXPERIMENTAL]:
.sp
An optional backend for pillar caches which uses a pure\-Python
in\-memory data structure for maximal performance. There are several caveats,
however. First, because each master worker contains its own in\-memory cache,
there is no guarantee of cache consistency between minion requests. This
works best in situations where the pillar rarely if ever changes. Secondly,
and perhaps more importantly, this means that unencrypted pillars will
be accessible to any process which can examine the memory of the \fBsalt\-master\fP!
This may represent a substantial security risk.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_cache_backend: disk
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Master Reactor Settings
.SS \fBreactor\fP
.sp
Default: \fB[]\fP
.sp
Defines a salt reactor. See the \fI\%Reactor\fP documentation for more
information.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor:
  \- \(aqsalt/minion/*/start\(aq:
    \- salt://reactor/startup_tasks.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBreactor_refresh_interval\fP
.sp
Default: \fB60\fP
.sp
The TTL for the cache of the reactor configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor_refresh_interval: 60
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBreactor_worker_threads\fP
.sp
Default: \fB10\fP
.sp
The number of workers for the runner/wheel in the reactor.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor_worker_threads: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBreactor_worker_hwm\fP
.sp
Default: \fB10000\fP
.sp
The queue size for workers in the reactor.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor_worker_hwm: 10000
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Salt\-API Master Settings
.sp
There are some settings for \fI\%salt\-api\fP that can be
configured on the Salt Master.
.SS \fBapi_logfile\fP
.sp
Default: \fB/var/log/salt/api\fP
.sp
The logfile location for \fBsalt\-api\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
api_logfile: /var/log/salt/api
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBapi_pidfile\fP
.sp
Default: /var/run/salt\-api.pid
.sp
If this master will be running \fBsalt\-api\fP, specify the pidfile of the
\fBsalt\-api\fP daemon.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
api_pidfile: /var/run/salt\-api.pid
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrest_timeout\fP
.sp
Default: \fB300\fP
.sp
Used by \fBsalt\-api\fP for the master requests timeout.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rest_timeout: 300
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBnetapi_enable_clients\fP
.sp
New in version 3006.0.

.sp
Default: \fB[]\fP
.sp
Used by \fBsalt\-api\fP to enable access to the listed clients. Unless a
client is addded to this list, requests will be rejected before
authentication is attempted or processing of the low state occurs.
.sp
This can be used to only expose the required functionality via
\fBsalt\-api\fP\&.
.sp
Configuration with all possible clients enabled:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
netapi_enable_clients:
  \- local
  \- local_async
  \- local_batch
  \- local_subset
  \- runner
  \- runner_async
  \- ssh
  \- wheel
  \- wheel_async
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Enabling all clients is not recommended \- only enable the
clients that provide the functionality required.
.UNINDENT
.UNINDENT
.SS Syndic Server Settings
.sp
A Salt syndic is a Salt master used to pass commands from a higher Salt master
to minions below the syndic. Using the syndic is simple. If this is a master
that will have syndic servers(s) below it, set the \fBorder_masters\fP setting to
\fBTrue\fP\&.
.sp
If this is a master that will be running a syndic daemon for passthrough the
\fBsyndic_master\fP setting needs to be set to the location of the master server.
.sp
Do not forget that, in other words, it means that it shares with the local minion
its ID and PKI directory.
.SS \fBorder_masters\fP
.sp
Default: \fBFalse\fP
.sp
Extra data needs to be sent with publications if the master is controlling a
lower level master via a syndic minion. If this is the case the order_masters
value must be set to True
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
order_masters: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsyndic_master\fP
.sp
Changed in version 2016.3.5,2016.11.1: Set default higher level master address.

.sp
Default: \fBmasterofmasters\fP
.sp
If this master will be running the \fBsalt\-syndic\fP to connect to a higher level
master, specify the higher level master with this configuration value.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
syndic_master: masterofmasters
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can optionally connect a syndic to multiple higher level masters by
setting the \fBsyndic_master\fP value to a list:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
syndic_master:
  \- masterofmasters1
  \- masterofmasters2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Each higher level master must be set up in a multi\-master configuration.
.SS \fBsyndic_master_port\fP
.sp
Default: \fB4506\fP
.sp
If this master will be running the \fBsalt\-syndic\fP to connect to a higher level
master, specify the higher level master port with this configuration value.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
syndic_master_port: 4506
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsyndic_pidfile\fP
.sp
Default: \fB/var/run/salt\-syndic.pid\fP
.sp
If this master will be running the \fBsalt\-syndic\fP to connect to a higher level
master, specify the pidfile of the syndic daemon.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
syndic_pidfile: /var/run/syndic.pid
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsyndic_log_file\fP
.sp
Default: \fB/var/log/salt/syndic\fP
.sp
If this master will be running the \fBsalt\-syndic\fP to connect to a higher level
master, specify the log file of the syndic daemon.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
syndic_log_file: /var/log/salt\-syndic.log
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsyndic_failover\fP
.sp
New in version 2016.3.0.

.sp
Default: \fBrandom\fP
.sp
The behaviour of the multi\-syndic when connection to a master of masters failed.
Can specify \fBrandom\fP (default) or \fBordered\fP\&. If set to \fBrandom\fP, masters
will be iterated in random order. If \fBordered\fP is specified, the configured
order will be used.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
syndic_failover: random
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsyndic_wait\fP
.sp
Default: \fB5\fP
.sp
The number of seconds for the salt client to wait for additional syndics to
check in with their lists of expected minions before giving up.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
syndic_wait: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsyndic_forward_all_events\fP
.sp
New in version 2017.7.0.

.sp
Default: \fBFalse\fP
.sp
Option on multi\-syndic or single when connected to multiple masters to be able to
send events to all connected masters.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
syndic_forward_all_events: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Peer Publish Settings
.sp
Salt minions can send commands to other minions, but only if the minion is
allowed to. By default \(dqPeer Publication\(dq is disabled, and when enabled it
is enabled for specific minions and specific commands. This allows secure
compartmentalization of commands based on individual minions.
.SS \fBpeer\fP
.sp
Default: \fB{}\fP
.sp
The configuration uses regular expressions to match minions and then a list
of regular expressions to match functions. The following will allow the
minion authenticated as foo.example.com to execute functions from the test
and pkg modules.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
peer:
  foo\e.example\e.com:
      \- test\e..*
      \- pkg\e..*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will allow all minions to execute all commands:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
peer:
  .*:
      \- .*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is not recommended, since it would allow anyone who gets root on any
single minion to instantly have root on all of the minions!
.sp
It is also possible to limit target hosts with the \fI\%Compound Matcher\fP\&.
You can achieve this by adding another layer in between the source and the
allowed functions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
peer:
  \(aq.*\e.example\e.com\(aq:
    \- \(aqG@role:db\(aq:
      \- test\e..*
      \- pkg\e..*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Notice that the source hosts are matched by a regular expression
on their minion ID, while target hosts can be matched by any of
the \fI\%available matchers\fP\&.
.sp
Note that globbing and regex matching on pillar values is not supported. You can only match exact values.
.UNINDENT
.UNINDENT
.SS \fBpeer_run\fP
.sp
Default: \fB{}\fP
.sp
The peer_run option is used to open up runners on the master to access from the
minions. The peer_run configuration matches the format of the peer
configuration.
.sp
The following example would allow foo.example.com to execute the manage.up
runner:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
peer_run:
  foo.example.com:
      \- manage.up
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Master Logging Settings
.SS \fBlog_file\fP
.sp
Default: \fB/var/log/salt/master\fP
.sp
The master log can be sent to a regular file, local path name, or network
location. See also \fI\%log_file\fP\&.
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_file: /var/log/salt/master
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_file: file:///dev/log
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_file: udp://loghost:10514
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_level\fP
.sp
Default: \fBwarning\fP
.sp
The level of messages to send to the console. See also \fI\%log_level\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_level: warning
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Any log level below the \fIinfo\fP level is INSECURE and may log sensitive data. This currently includes:
#. profile
#. debug
#. trace
#. garbage
#. all
.SS \fBlog_level_logfile\fP
.sp
Default: \fBwarning\fP
.sp
The level of messages to send to the log file. See also
\fI\%log_level_logfile\fP\&. When it is not set explicitly
it will inherit the level set by \fI\%log_level\fP option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_level_logfile: warning
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Any log level below the \fIinfo\fP level is INSECURE and may log sensitive data. This currently includes:
#. profile
#. debug
#. trace
#. garbage
#. all
.SS \fBlog_datefmt\fP
.sp
Default: \fB%H:%M:%S\fP
.sp
The date and time format used in console log messages. See also
\fI\%log_datefmt\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_datefmt: \(aq%H:%M:%S\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_datefmt_logfile\fP
.sp
Default: \fB%Y\-%m\-%d %H:%M:%S\fP
.sp
The date and time format used in log file messages. See also
\fI\%log_datefmt_logfile\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_datefmt_logfile: \(aq%Y\-%m\-%d %H:%M:%S\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_fmt_console\fP
.sp
Default: \fB[%(levelname)\-8s] %(message)s\fP
.sp
The format of the console logging messages. See also
\fI\%log_fmt_console\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Log colors are enabled in \fBlog_fmt_console\fP rather than the
\fI\%color\fP config since the logging system is loaded before the
master config.
.sp
Console log colors are specified by these additional formatters:
.sp
%(colorlevel)s
%(colorname)s
%(colorprocess)s
%(colormsg)s
.sp
Since it is desirable to include the surrounding brackets, \(aq[\(aq and \(aq]\(aq, in
the coloring of the messages, these color formatters also include padding
as well.  Color LogRecord attributes are only available for console
logging.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_fmt_console: \(aq%(colorlevel)s %(colormsg)s\(aq
log_fmt_console: \(aq[%(levelname)\-8s] %(message)s\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_fmt_logfile\fP
.sp
Default: \fB%(asctime)s,%(msecs)03d [%(name)\-17s][%(levelname)\-8s] %(message)s\fP
.sp
The format of the log file logging messages. See also
\fI\%log_fmt_logfile\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_fmt_logfile: \(aq%(asctime)s,%(msecs)03d [%(name)\-17s][%(levelname)\-8s] %(message)s\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_granular_levels\fP
.sp
Default: \fB{}\fP
.sp
This can be used to control logging levels more specifically. See also
\fI\%log_granular_levels\fP\&.
.SS \fBlog_rotate_max_bytes\fP
.sp
Default:  \fB0\fP
.sp
The maximum number of bytes a single log file may contain before it is rotated.
A value of 0 disables this feature. Currently only supported on Windows. On
other platforms, use an external tool such as \(aqlogrotate\(aq to manage log files.
\fBlog_rotate_max_bytes\fP
.SS \fBlog_rotate_backup_count\fP
.sp
Default:  \fB0\fP
.sp
The number of backup files to keep when rotating log files. Only used if
\fI\%log_rotate_max_bytes\fP is greater than 0. Currently only supported
on Windows. On other platforms, use an external tool such as \(aqlogrotate\(aq to
manage log files.
\fBlog_rotate_backup_count\fP
.SS Node Groups
.SS \fBnodegroups\fP
.sp
Default: \fB{}\fP
.sp
Node groups allow for logical groupings of minion nodes.
A group consists of a group name and a compound target.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nodegroups:
  group1: \(aqL@foo.domain.com,bar.domain.com,baz.domain.com or bl*.domain.com\(aq
  group2: \(aqG@os:Debian and foo.domain.com\(aq
  group3: \(aqG@os:Debian and N@group1\(aq
  group4:
    \- \(aqG@foo:bar\(aq
    \- \(aqor\(aq
    \- \(aqG@foo:baz\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
More information on using nodegroups can be found \fI\%here\fP\&.
.SS Range Cluster Settings
.SS \fBrange_server\fP
.sp
Default: \fB\(aqrange:80\(aq\fP
.sp
The range server (and optional port) that serves your cluster information
\fI\%https://github.com/ytoolshed/range/wiki/%22yamlfile%22\-module\-file\-spec\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
range_server: range:80
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Include Configuration
.sp
Configuration can be loaded from multiple files. The order in which this is
done is:
.INDENT 0.0
.IP 1. 3
The master config file itself
.IP 2. 3
The files matching the glob in \fI\%default_include\fP
.IP 3. 3
The files matching the glob in \fI\%include\fP (if defined)
.UNINDENT
.sp
Each successive step overrides any values defined in the previous steps.
Therefore, any config options defined in one of the
\fI\%default_include\fP files would override the same value in the
master config file, and any options defined in \fI\%include\fP would
override both.
.SS \fBdefault_include\fP
.sp
Default: \fBmaster.d/*.conf\fP
.sp
The master can include configuration from other files. Per default the
master will automatically include all config files from \fBmaster.d/*.conf\fP
where \fBmaster.d\fP is relative to the directory of the master configuration
file.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Salt creates files in the \fBmaster.d\fP directory for its own use. These
files are prefixed with an underscore. A common example of this is the
\fB_schedule.conf\fP file.
.UNINDENT
.UNINDENT
.SS \fBinclude\fP
.sp
Default: \fBnot defined\fP
.sp
The master can include configuration from other files. To enable this,
pass a list of paths to this option. The paths can be either relative or
absolute; if relative, they are considered to be relative to the directory
the main minion configuration file lives in. Paths can make use of
shell\-style globbing. If no files are matched by a path passed to this
option then the master will log a warning message.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Include files from a master.d directory in the same
# directory as the master config file
include: master.d/*

# Include a single extra file into the configuration
include: /etc/roles/webserver

# Include several files and the master.d directory
include:
  \- extra_config
  \- master.d/*
  \- /etc/roles/webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Keepalive Settings
.SS \fBtcp_keepalive\fP
.sp
Default: \fBTrue\fP
.sp
The tcp keepalive interval to set on TCP ports. This setting can be used to tune Salt
connectivity issues in messy network environments with misbehaving firewalls.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tcp_keepalive: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtcp_keepalive_cnt\fP
.sp
Default: \fB\-1\fP
.sp
Sets the ZeroMQ TCP keepalive count. May be used to tune issues with minion disconnects.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tcp_keepalive_cnt: \-1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtcp_keepalive_idle\fP
.sp
Default: \fB300\fP
.sp
Sets ZeroMQ TCP keepalive idle. May be used to tune issues with minion disconnects.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tcp_keepalive_idle: 300
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtcp_keepalive_intvl\fP
.sp
Default: \fB\-1\fP
.sp
Sets ZeroMQ TCP keepalive interval. May be used to tune issues with minion disconnects.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tcp_keepalive_intvl\(aq: \-1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Windows Software Repo Settings
.SS \fBwinrepo_provider\fP
.sp
New in version 2015.8.0.

.sp
Specify the provider to be used for winrepo. Must be either \fBpygit2\fP or
\fBgitpython\fP\&. If unset, then both will be tried in that same order, and the
first one with a compatible version installed will be the provider that is
used.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_provider: gitpython
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_dir\fP
.sp
Changed in version 2015.8.0: Renamed from \fBwin_repo\fP to \fBwinrepo_dir\fP\&.

.sp
Default: \fB/srv/salt/win/repo\fP
.sp
Location on the master where the \fI\%winrepo_remotes\fP are checked out
for pre\-2015.8.0 minions. 2015.8.0 and later minions use
\fI\%winrepo_remotes_ng\fP instead.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_dir: /srv/salt/win/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_dir_ng\fP
.sp
New in version 2015.8.0: A new \fI\%ng\fP repo was added.

.sp
Default: \fB/srv/salt/win/repo\-ng\fP
.sp
Location on the master where the \fI\%winrepo_remotes_ng\fP are checked
out for 2015.8.0 and later minions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_dir_ng: /srv/salt/win/repo\-ng
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_cachefile\fP
.sp
Changed in version 2015.8.0: Renamed from \fBwin_repo_mastercachefile\fP to \fBwinrepo_cachefile\fP

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
2015.8.0 and later minions do not use this setting since the cachefile
is now generated by the minion.
.UNINDENT
.UNINDENT
.sp
Default: \fBwinrepo.p\fP
.sp
Path relative to \fI\%winrepo_dir\fP where the winrepo cache should be
created.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_cachefile: winrepo.p
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_remotes\fP
.sp
Changed in version 2015.8.0: Renamed from \fBwin_gitrepos\fP to \fBwinrepo_remotes\fP\&.

.sp
Default: \fB[\(aqhttps://github.com/saltstack/salt\-winrepo.git\(aq]\fP
.sp
List of git repositories to checkout and include in the winrepo for
pre\-2015.8.0 minions. 2015.8.0 and later minions use
\fI\%winrepo_remotes_ng\fP instead.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_remotes:
  \- https://github.com/saltstack/salt\-winrepo.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To specify a specific revision of the repository, prepend a commit ID to the
URL of the repository:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_remotes:
  \- \(aq<commit_id> https://github.com/saltstack/salt\-winrepo.git\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Replace \fB<commit_id>\fP with the SHA1 hash of a commit ID. Specifying a commit
ID is useful in that it allows one to revert back to a previous version in the
event that an error is introduced in the latest revision of the repo.
.SS \fBwinrepo_remotes_ng\fP
.sp
New in version 2015.8.0: A new \fI\%ng\fP repo was added.

.sp
Default: \fB[\(aqhttps://github.com/saltstack/salt\-winrepo\-ng.git\(aq]\fP
.sp
List of git repositories to checkout and include in the winrepo for
2015.8.0 and later minions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_remotes_ng:
  \- https://github.com/saltstack/salt\-winrepo\-ng.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To specify a specific revision of the repository, prepend a commit ID to the
URL of the repository:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_remotes_ng:
  \- \(aq<commit_id> https://github.com/saltstack/salt\-winrepo\-ng.git\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Replace \fB<commit_id>\fP with the SHA1 hash of a commit ID. Specifying a commit
ID is useful in that it allows one to revert back to a previous version in the
event that an error is introduced in the latest revision of the repo.
.SS \fBwinrepo_branch\fP
.sp
New in version 2015.8.0.

.sp
Default: \fBmaster\fP
.sp
If the branch is omitted from a winrepo remote, then this branch will be
used instead. For example, in the configuration below, the first two remotes
would use the \fBwinrepo\fP branch/tag, while the third would use the \fBfoo\fP
branch/tag.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_branch: winrepo

winrepo_remotes:
  \- https://mygitserver/winrepo1.git
  \- https://mygitserver/winrepo2.git:
  \- foo https://mygitserver/winrepo3.git
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_ssl_verify\fP
.sp
New in version 2015.8.0.

.sp
Changed in version 2016.11.0.

.sp
Default: \fBFalse\fP
.sp
Specifies whether or not to ignore SSL certificate errors when contacting the
remote repository. The  \fBFalse\fP setting is useful if you\(aqre using a
git repo that uses a self\-signed certificate. However, keep in mind that
setting this to anything other \fBTrue\fP is a considered insecure, and using an
SSH\-based transport (if available) may be a better option.
.sp
In the 2016.11.0 release, the default config value changed from \fBFalse\fP to
\fBTrue\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_ssl_verify: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Winrepo Authentication Options
.sp
These parameters only currently apply to the \fBpygit2\fP
\fI\%winrepo_provider\fP\&. Authentication works the same as it does in
gitfs, as outlined in the \fI\%GitFS Walkthrough\fP,
though the global configuration options are named differently to reflect that
they are for winrepo instead of gitfs.
.SS \fBwinrepo_user\fP
.sp
New in version 2015.8.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Along with \fI\%winrepo_password\fP, is used to authenticate to HTTPS
remotes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_user: git
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_password\fP
.sp
New in version 2015.8.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Along with \fI\%winrepo_user\fP, is used to authenticate to HTTPS
remotes. This parameter is not required if the repository does not use
authentication.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_password: mypassword
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_insecure_auth\fP
.sp
New in version 2015.8.0.

.sp
Default: \fBFalse\fP
.sp
By default, Salt will not authenticate to an HTTP (non\-HTTPS) remote. This
parameter enables authentication over HTTP. \fBEnable this at your own risk.\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_insecure_auth: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_pubkey\fP
.sp
New in version 2015.8.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Along with \fI\%winrepo_privkey\fP (and optionally
\fI\%winrepo_passphrase\fP), is used to authenticate to SSH remotes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_pubkey: /path/to/key.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_privkey\fP
.sp
New in version 2015.8.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
Along with \fI\%winrepo_pubkey\fP (and optionally
\fI\%winrepo_passphrase\fP), is used to authenticate to SSH remotes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_privkey: /path/to/key
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_passphrase\fP
.sp
New in version 2015.8.0.

.sp
Default: \fB\(aq\(aq\fP
.sp
This parameter is optional, required only when the SSH key being used to
authenticate is protected by a passphrase.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_passphrase: mypassphrase
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_refspecs\fP
.sp
New in version 2017.7.0.

.sp
Default: \fB[\(aq+refs/heads/*:refs/remotes/origin/*\(aq, \(aq+refs/tags/*:refs/tags/*\(aq]\fP
.sp
When fetching from remote repositories, by default Salt will fetch branches and
tags. This parameter can be used to override the default and specify
alternate refspecs to be fetched. This parameter works similarly to its
\fI\%GitFS counterpart\fP, in that it can be
configured both globally and for individual remotes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_refspecs:
  \- \(aq+refs/heads/*:refs/remotes/origin/*\(aq
  \- \(aq+refs/tags/*:refs/tags/*\(aq
  \- \(aq+refs/pull/*/head:refs/remotes/origin/pr/*\(aq
  \- \(aq+refs/pull/*/merge:refs/remotes/origin/merge/*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configure Master on Windows
.sp
The master on Windows requires no additional configuration. You can modify the
master configuration by creating/editing the master config file located at
\fBc:\esalt\econf\emaster\fP\&. The same configuration options available on Linux are
available in Windows, as long as they apply. For example, SSH options wouldn\(aqt
apply in Windows. The main differences are the file paths. If you are familiar
with common salt paths, the following table may be useful:
.TS
center;
|l|l|l|.
_
T{
linux Paths
T}	T{
T}	T{
Windows Paths
T}
_
T{
\fB/etc/salt\fP
T}	T{
\fB<\-\-\->\fP
T}	T{
\fBc:\esalt\econf\fP
T}
_
T{
\fB/\fP
T}	T{
\fB<\-\-\->\fP
T}	T{
\fBc:\esalt\fP
T}
_
.TE
.sp
So, for example, the master config file in Linux is \fB/etc/salt/master\fP\&. In
Windows the master config file is \fBc:\esalt\econf\emaster\fP\&. The Linux path
\fB/etc/salt\fP becomes \fBc:\esalt\econf\fP in Windows.
.SS Common File Locations
.TS
center;
|l|l|.
_
T{
Linux Paths
T}	T{
Windows Paths
T}
_
T{
\fBconf_file: /etc/salt/master\fP
T}	T{
\fBconf_file: c:\esalt\econf\emaster\fP
T}
_
T{
\fBlog_file: /var/log/salt/master\fP
T}	T{
\fBlog_file: c:\esalt\evar\elog\esalt\emaster\fP
T}
_
T{
\fBpidfile: /var/run/salt\-master.pid\fP
T}	T{
\fBpidfile: c:\esalt\evar\erun\esalt\-master.pid\fP
T}
_
.TE
.SS Common Directories
.TS
center;
|l|l|.
_
T{
Linux Paths
T}	T{
Windows Paths
T}
_
T{
\fBcachedir: /var/cache/salt/master\fP
T}	T{
\fBcachedir: c:\esalt\evar\ecache\esalt\emaster\fP
T}
_
T{
\fBextension_modules: /var/cache/salt/master/extmods\fP
T}	T{
\fBc:\esalt\evar\ecache\esalt\emaster\eextmods\fP
T}
_
T{
\fBpki_dir: /etc/salt/pki/master\fP
T}	T{
\fBpki_dir: c:\esalt\econf\epki\emaster\fP
T}
_
T{
\fBroot_dir: /\fP
T}	T{
\fBroot_dir: c:\esalt\fP
T}
_
T{
\fBsock_dir: /var/run/salt/master\fP
T}	T{
\fBsock_dir: c:\esalt\evar\erun\esalt\emaster\fP
T}
_
.TE
.SS Roots
.sp
\fBfile_roots\fP
.TS
center;
|l|l|.
_
T{
Linux Paths
T}	T{
Windows Paths
T}
_
T{
\fB/srv/salt\fP
T}	T{
\fBc:\esalt\esrv\esalt\fP
T}
_
T{
\fB/srv/spm/salt\fP
T}	T{
\fBc:\esalt\esrv\espm\esalt\fP
T}
_
.TE
.sp
\fBpillar_roots\fP
.TS
center;
|l|l|.
_
T{
Linux Paths
T}	T{
Windows Paths
T}
_
T{
\fB/srv/pillar\fP
T}	T{
\fBc:\esalt\esrv\epillar\fP
T}
_
T{
\fB/srv/spm/pillar\fP
T}	T{
\fBc:\esalt\esrv\espm\epillar\fP
T}
_
.TE
.SS Win Repo Settings
.TS
center;
|l|l|.
_
T{
Linux Paths
T}	T{
Windows Paths
T}
_
T{
\fBwinrepo_dir: /srv/salt/win/repo\fP
T}	T{
\fBwinrepo_dir: c:\esalt\esrv\esalt\ewin\erepo\fP
T}
_
T{
\fBwinrepo_dir_ng: /srv/salt/win/repo\-ng\fP
T}	T{
\fBwinrepo_dir_ng: c:\esalt\esrv\esalt\ewin\erepo\-ng\fP
T}
_
.TE
.SS Configuring the Salt Minion
.sp
The Salt system is amazingly simple and easy to configure. The two components
of the Salt system each have a respective configuration file. The
\fBsalt\-master\fP is configured via the master configuration file, and the
\fBsalt\-minion\fP is configured via the minion configuration file.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%example minion configuration file\fP
.UNINDENT
.UNINDENT
.sp
The Salt Minion configuration is very simple. Typically, the only value that
needs to be set is the master value so the minion knows where to locate its master.
.sp
By default, the salt\-minion configuration will be in \fB/etc/salt/minion\fP\&.
A notable exception is FreeBSD, where the configuration will be in
\fB/usr/local/etc/salt/minion\fP\&.
.SS Minion Primary Configuration
.SS \fBmaster\fP
.sp
Default: \fBsalt\fP
.sp
The hostname or IP address of the master. See \fI\%ipv6\fP for IPv6
connections to the master.
.sp
Default: \fBsalt\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: salt
.ft P
.fi
.UNINDENT
.UNINDENT
.SS master:port Syntax
.sp
New in version 2015.8.0.

.sp
The \fBmaster\fP config option can also be set to use the master\(aqs IP in
conjunction with a port number by default.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: localhost:1234
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For IPv6 formatting with a port, remember to add brackets around the IP address
before adding the port and enclose the line in single quotes to make it a string:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: \(aq[2001:db8:85a3:8d3:1319:8a2e:370:7348]:1234\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If a port is specified in the \fBmaster\fP as well as \fI\%master_port\fP,
the \fBmaster_port\fP setting will be overridden by the \fBmaster\fP configuration.
.UNINDENT
.UNINDENT
.SS List of Masters Syntax
.sp
The option can also be set to a list of masters, enabling
\fI\%multi\-master\fP mode.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master:
  \- address1
  \- address2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.7.0: The master can be dynamically configured. The \fI\%master\fP value
can be set to an module function which will be executed and will assume
that the returning value is the ip or hostname of the desired master. If a
function is being specified, then the \fI\%master_type\fP option
must be set to \fBfunc\fP, to tell the minion that the value is a function to
be run and not a fully\-qualified domain name.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: module.function
master_type: func
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In addition, instead of using multi\-master mode, the minion can be
configured to use the list of master addresses as a failover list, trying
the first address, then the second, etc. until the minion successfully
connects. To enable this behavior, set \fI\%master_type\fP to
\fBfailover\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master:
  \- address1
  \- address2
master_type: failover
.ft P
.fi
.UNINDENT
.UNINDENT

.SS \fBcolor\fP
.sp
Default: \fBTrue\fP
.sp
By default output is colored. To disable colored output, set the color value to
\fBFalse\fP\&.
.SS \fBipv6\fP
.sp
Default: \fBNone\fP
.sp
Whether the master should be connected over IPv6. By default salt minion
will try to automatically detect IPv6 connectivity to master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ipv6: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_uri_format\fP
.sp
New in version 2015.8.0.

.sp
Specify the format in which the master address will be evaluated. Valid options
are \fBdefault\fP or \fBip_only\fP\&. If \fBip_only\fP is specified, then the master
address will not be split into IP and PORT, so be sure that only an IP (or domain
name) is set in the \fI\%master\fP configuration setting.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_uri_format: ip_only
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_tops_first\fP
.sp
New in version 2018.3.0.

.sp
Default: \fBFalse\fP
.sp
SLS targets defined using the \fI\%Master Tops\fP system
are normally executed \fIafter\fP any matches defined in the \fI\%Top File\fP\&. Set this option to \fBTrue\fP to have the minion execute the
\fI\%Master Tops\fP states first.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_tops_first: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_type\fP
.sp
New in version 2014.7.0.

.sp
Default: \fBstr\fP
.sp
The type of the \fI\%master\fP variable. Can be \fBstr\fP, \fBfailover\fP,
\fBfunc\fP or \fBdisable\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_type: str
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If this option is \fBstr\fP (default), multiple hot masters are configured.
Minions can connect to multiple masters simultaneously (all master are \(dqhot\(dq).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_type: failover
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If this option is set to \fBfailover\fP, \fI\%master\fP must be a list of
master addresses. The minion will then try each master in the order specified
in the list until it successfully connects.  \fI\%master_alive_interval\fP
must also be set, this determines how often the minion will verify the presence
of the master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_type: func
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the master needs to be dynamically assigned by executing a function instead
of reading in the static master value, set this to \fBfunc\fP\&. This can be used
to manage the minion\(aqs master setting from an execution module. By simply
changing the algorithm in the module to return a new master ip/fqdn, restart
the minion and it will connect to the new master.
.sp
As of version 2016.11.0 this option can be set to \fBdisable\fP and the minion
will never attempt to talk to the master. This is useful for running a
masterless minion daemon.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_type: disable
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmax_event_size\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB1048576\fP
.sp
Passing very large events can cause the minion to consume large amounts of
memory. This value tunes the maximum size of a message allowed onto the
minion event bus. The value is expressed in bytes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
max_event_size: 1048576
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBenable_legacy_startup_events\fP
.sp
New in version 2019.2.0.

.sp
Default: \fBTrue\fP
.sp
When a minion starts up it sends a notification on the event bus with a tag
that looks like this: \fBsalt/minion/<minion_id>/start\fP\&. For historical reasons
the minion also sends a similar event with an event tag like this:
\fBminion_start\fP\&. This duplication can cause a lot of clutter on the event bus
when there are many minions. Set \fBenable_legacy_startup_events: False\fP in the
minion config to ensure only the \fBsalt/minion/<minion_id>/start\fP events are
sent. Beginning with the \fB3001\fP Salt release this option will default to
\fBFalse\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
enable_legacy_startup_events: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_failback\fP
.sp
New in version 2016.3.0.

.sp
Default: \fBFalse\fP
.sp
If the minion is in multi\-master mode and the :conf_minion\(gamaster_type\(ga
configuration option is set to \fBfailover\fP, this setting can be set to \fBTrue\fP
to force the minion to fail back to the first master in the list if the first
master is back online.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_failback: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_failback_interval\fP
.sp
New in version 2016.3.0.

.sp
Default: \fB0\fP
.sp
If the minion is in multi\-master mode, the :conf_minion\(gamaster_type\(ga configuration
is set to \fBfailover\fP, and the \fBmaster_failback\fP option is enabled, the master
failback interval can be set to ping the top master with this interval, in seconds.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_failback_interval: 0
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_alive_interval\fP
.sp
Default: \fB0\fP
.sp
Configures how often, in seconds, the minion will verify that the current
master is alive and responding.  The minion will try to establish a connection
to the next master in the list if it finds the existing one is dead. This
setting can also be used to detect master DNS record changes when a minion has
been disconnected.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_alive_interval: 30
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_shuffle\fP
.sp
New in version 2014.7.0.

.sp
Deprecated since version 2019.2.0.

.sp
Default: \fBFalse\fP
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This option has been deprecated in Salt \fB2019.2.0\fP\&. Please use
\fI\%random_master\fP instead.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_shuffle: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrandom_master\fP
.sp
New in version 2014.7.0.

.sp
Changed in version 2019.2.0: The \fI\%master_failback\fP option can be used in conjunction with
\fBrandom_master\fP to force the minion to fail back to the first master in the
list if the first master is back online. Note that \fI\%master_type\fP
must be set to \fBfailover\fP in order for the \fBmaster_failback\fP setting to
work.

.sp
Default: \fBFalse\fP
.sp
If \fI\%master\fP is a list of addresses, shuffle them before trying to
connect to distribute the minions over all available masters. This uses Python\(aqs
\fBrandom.shuffle\fP method.
.sp
If multiple masters are specified in the \(aqmaster\(aq setting as a list, the default
behavior is to always try to connect to them in the order they are listed. If
\fBrandom_master\fP is set to True, the order will be randomized instead upon Minion
startup. This can be helpful in distributing the load of many minions executing
\fBsalt\-call\fP requests, for example, from a cron job. If only one master is listed,
this setting is ignored and a warning is logged.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
random_master: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When the \fBfailover\fP, \fBmaster_failback\fP, and \fBrandom_master\fP options are
used together, only the \(dqsecondary masters\(dq will be shuffled. The first master
in the list is ignored in the \fBrandom.shuffle\fP
call. See \fI\%master_failback\fP for more information.
.UNINDENT
.UNINDENT
.SS \fBretry_dns\fP
.sp
Default: \fB30\fP
.sp
Set the number of seconds to wait before attempting to resolve
the master hostname if name resolution fails. Defaults to 30 seconds.
Set to zero if the minion should shutdown and not retry.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
retry_dns: 30
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBretry_dns_count\fP
.sp
New in version 2018.3.4.

.sp
Default: \fBNone\fP
.sp
Set the number of attempts to perform when resolving
the master hostname if name resolution fails.
By default the minion will retry indefinitely.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
retry_dns_count: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_port\fP
.sp
Default: \fB4506\fP
.sp
The port of the master ret server, this needs to coincide with the ret_port
option on the Salt master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_port: 4506
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpublish_port\fP
.sp
Default: \fB4505\fP
.sp
The port of the master publish server, this needs to coincide with the publish_port
option on the Salt master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publish_port: 4505
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsource_interface_name\fP
.sp
New in version 2018.3.0.

.sp
The name of the interface to use when establishing the connection to the Master.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If multiple IP addresses are configured on the named interface,
the first one will be selected. In that case, for a better selection,
consider using the \fI\%source_address\fP option.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To use an IPv6 address from the named interface, make sure the option
\fI\%ipv6\fP is enabled, i.e., \fBipv6: true\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If the interface is down, it will avoid using it, and the Minion
will bind to \fB0.0.0.0\fP (all interfaces).
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This option requires modern version of the underlying libraries used by
the selected transport:
.INDENT 0.0
.IP \(bu 2
\fBzeromq\fP requires \fBpyzmq\fP >= 16.0.1 and \fBlibzmq\fP >= 4.1.6
.IP \(bu 2
\fBtcp\fP requires \fBtornado\fP >= 4.5
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
source_interface_name: bond0.1234
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsource_address\fP
.sp
New in version 2018.3.0.

.sp
The source IP address or the domain name to be used when connecting the Minion
to the Master.
See \fI\%ipv6\fP for IPv6 connections to the Master.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This option requires modern version of the underlying libraries used by
the selected transport:
.INDENT 0.0
.IP \(bu 2
\fBzeromq\fP requires \fBpyzmq\fP >= 16.0.1 and \fBlibzmq\fP >= 4.1.6
.IP \(bu 2
\fBtcp\fP requires \fBtornado\fP >= 4.5
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
source_address: if\-bond0\-1234.sjc.us\-west.internal
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsource_ret_port\fP
.sp
New in version 2018.3.0.

.sp
The source port to be used when connecting the Minion to the Master ret server.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This option requires modern version of the underlying libraries used by
the selected transport:
.INDENT 0.0
.IP \(bu 2
\fBzeromq\fP requires \fBpyzmq\fP >= 16.0.1 and \fBlibzmq\fP >= 4.1.6
.IP \(bu 2
\fBtcp\fP requires \fBtornado\fP >= 4.5
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
source_ret_port: 49017
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsource_publish_port\fP
.sp
New in version 2018.3.0.

.sp
The source port to be used when connecting the Minion to the Master publish
server.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This option requires modern version of the underlying libraries used by
the selected transport:
.INDENT 0.0
.IP \(bu 2
\fBzeromq\fP requires \fBpyzmq\fP >= 16.0.1 and \fBlibzmq\fP >= 4.1.6
.IP \(bu 2
\fBtcp\fP requires \fBtornado\fP >= 4.5
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
source_publish_port: 49018
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBuser\fP
.sp
Default: \fBroot\fP
.sp
The user to run the Salt processes
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
user: root
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsudo_user\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
The user to run salt remote execution commands as via sudo. If this option is
enabled then sudo will be used to change the active user executing the remote
command. If enabled the user will need to be allowed access via the sudoers file
for the user that the salt minion is configured to run as. The most common
option would be to use the root user. If this option is set the \fBuser\fP option
should also be set to a non\-root user. If migrating from a root minion to a non
root minion the minion cache should be cleared and the minion pki directory will
need to be changed to the ownership of the new user.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo_user: root
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpidfile\fP
.sp
Default: \fB/var/run/salt\-minion.pid\fP
.sp
The location of the daemon\(aqs process ID file
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pidfile: /var/run/salt\-minion.pid
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBroot_dir\fP
.sp
Default: \fB/\fP
.sp
This directory is prepended to the following options: \fI\%pki_dir\fP,
\fI\%cachedir\fP, \fI\%log_file\fP, \fI\%sock_dir\fP, and
\fBpidfile\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
root_dir: /
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBconf_file\fP
.sp
Default: \fB/etc/salt/minion\fP
.sp
The path to the minion\(aqs configuration file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
conf_file: /etc/salt/minion
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpki_dir\fP
.sp
Default: \fB<LIB_STATE_DIR>/pki/minion\fP
.sp
The directory used to store the minion\(aqs public and private keys.
.sp
\fB<LIB_STATE_DIR>\fP is the pre\-configured variable state directory set during
installation via \fB\-\-salt\-lib\-state\-dir\fP\&. It defaults to \fB/etc/salt\fP\&. Systems
following the Filesystem Hierarchy Standard (FHS) might set it to
\fB/var/lib/salt\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pki_dir: /etc/salt/pki/minion
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBid\fP
.sp
Default: the system\(aqs hostname
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Salt Walkthrough\fP
.sp
The \fBSetting up a Salt Minion\fP section contains detailed
information on how the hostname is determined.
.UNINDENT
.UNINDENT
.sp
Explicitly declare the id for this minion to use. Since Salt uses detached ids
it is possible to run multiple minions on the same machine but with different
ids.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
id: foo.bar.com
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBminion_id_caching\fP
.sp
New in version 0.17.2.

.sp
Default: \fBTrue\fP
.sp
Caches the minion id to a file when the minion\(aqs \fI\%id\fP is not
statically defined in the minion config. This setting prevents potential
problems when automatic minion id resolution changes, which can cause the
minion to lose connection with the master. To turn off minion id caching,
set this config to \fBFalse\fP\&.
.sp
For more information, please see \fI\%Issue #7558\fP and \fI\%Pull Request #8488\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minion_id_caching: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBappend_domain\fP
.sp
Default: \fBNone\fP
.sp
Append a domain to a hostname in the event that it does not exist. This is
useful for systems where \fBsocket.getfqdn()\fP does not actually result in a
FQDN (for instance, Solaris).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
append_domain: foo.org
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBminion_id_remove_domain\fP
.sp
New in version 3000.

.sp
Default: \fBFalse\fP
.sp
Remove a domain when the minion id is generated as a fully qualified domain
name (either by the user provided \fBid_function\fP, or by Salt). This is useful
when the minions shall be named like hostnames. Can be a single domain (to
prevent name clashes), or True, to remove all domains.
.INDENT 0.0
.TP
.B Examples:
.INDENT 7.0
.IP \(bu 2
minion_id_remove_domain = foo.org
\- FQDN = king_bob.foo.org \-\-> minion_id = king_bob
\- FQDN = king_bob.bar.org \-\-> minion_id = king_bob.bar.org
.IP \(bu 2
minion_id_remove_domain = True
\- FQDN = king_bob.foo.org \-\-> minion_id = king_bob
\- FQDN = king_bob.bar.org \-\-> minion_id = king_bob
.UNINDENT
.UNINDENT
.sp
For more information, please see \fI\%issue 49212\fP and  \fI\%PR 49378\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minion_id_remove_domain: foo.org
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBminion_id_lowercase\fP
.sp
Default: \fBFalse\fP
.sp
Convert minion id to lowercase when it is being generated. Helpful when some hosts
get the minion id in uppercase. Cached ids will remain the same and not converted.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minion_id_lowercase: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcachedir\fP
.sp
Default: \fB/var/cache/salt/minion\fP
.sp
The location for minion cache data.
.sp
This directory may contain sensitive data and should be protected accordingly.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cachedir: /var/cache/salt/minion
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcolor_theme\fP
.sp
Default: \fB\(dq\(dq\fP
.sp
Specifies a path to the color theme to use for colored command line output.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
color_theme: /etc/salt/color_theme
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBappend_minionid_config_dirs\fP
.sp
Default: \fB[]\fP (the empty list) for regular minions, \fB[\(aqcachedir\(aq]\fP for proxy minions.
.sp
Append minion_id to these configuration directories.  Helps with multiple proxies
and minions running on the same machine. Allowed elements in the list:
\fBpki_dir\fP, \fBcachedir\fP, \fBextension_modules\fP\&.
Normally not needed unless running several proxies and/or minions on the same machine.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
append_minionid_config_dirs:
  \- pki_dir
  \- cachedir
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBverify_env\fP
.sp
Default: \fBTrue\fP
.sp
Verify and set permissions on configuration directories at startup.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
verify_env: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When set to \fBTrue\fP the verify_env option requires WRITE access to the
configuration directory (/etc/salt/). In certain situations such as
mounting /etc/salt/ as read\-only for templating this will create a stack
trace when \fI\%state.apply\fP is called.
.UNINDENT
.UNINDENT
.SS \fBcache_jobs\fP
.sp
Default: \fBFalse\fP
.sp
The minion can locally cache the return data from jobs sent to it, this can be
a good way to keep track of the minion side of the jobs the minion has
executed. By default this feature is disabled, to enable set cache_jobs to
\fBTrue\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cache_jobs: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgrains\fP
.sp
Default: (empty)
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Using grains in a state\fP
.UNINDENT
.UNINDENT
.sp
Statically assigns grains to the minion.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grains:
  roles:
    \- webserver
    \- memcache
  deployment: datacenter4
  cabinet: 13
  cab_u: 14\-15
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgrains_blacklist\fP
.sp
Default: \fB[]\fP
.sp
Each grains key will be compared against each of the expressions in this list.
Any keys which match will be filtered from the grains. Exact matches, glob
matches, and regular expressions are supported.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Some states and execution modules depend on grains. Filtering may cause
them to be unavailable or run unreliably.
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grains_blacklist:
  \- cpu_flags
  \- zmq*
  \- ipv[46]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgrains_cache\fP
.sp
Default: \fBFalse\fP
.sp
The minion can locally cache grain data instead of refreshing the data
each time the grain is referenced. By default this feature is disabled,
to enable set \fBgrains_cache\fP to \fBTrue\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grains_cache: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgrains_cache_expiration\fP
.sp
Default: \fB300\fP
.sp
Grains cache expiration, in seconds. If the cache file is older than this number
of seconds then the grains cache will be dumped and fully re\-populated with
fresh data. Defaults to 5 minutes. Will have no effect if
\fI\%grains_cache\fP is not enabled.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grains_cache_expiration: 300
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgrains_deep_merge\fP
.sp
New in version 2016.3.0.

.sp
Default: \fBFalse\fP
.sp
The grains can be merged, instead of overridden, using this option.
This allows custom grains to defined different subvalues of a dictionary
grain. By default this feature is disabled, to enable set grains_deep_merge
to \fBTrue\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grains_deep_merge: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For example, with these custom grains functions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def custom1_k1():
    return {\(dqcustom1\(dq: {\(dqk1\(dq: \(dqv1\(dq}}


def custom1_k2():
    return {\(dqcustom1\(dq: {\(dqk2\(dq: \(dqv2\(dq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Without \fBgrains_deep_merge\fP, the result would be:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
custom1:
  k1: v1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With \fBgrains_deep_merge\fP, the result will be:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
custom1:
  k1: v1
  k2: v2
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgrains_refresh_every\fP
.sp
Default: \fB0\fP
.sp
The \fBgrains_refresh_every\fP setting allows for a minion to periodically
check its grains to see if they have changed and, if so, to inform the master
of the new grains. This operation is moderately expensive, therefore care
should be taken not to set this value too low.
.sp
Note: This value is expressed in minutes.
.sp
A value of 10 minutes is a reasonable default.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grains_refresh_every: 0
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgrains_refresh_pre_exec\fP
.sp
New in version 3005.

.sp
Default: \fBFalse\fP
.sp
The \fBgrains_refresh_pre_exec\fP setting allows for a minion to check its grains
prior to the execution of any operation to see if they have changed and, if
so, to inform the master of the new grains. This operation is moderately
expensive, therefore care should be taken before enabling this behavior.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grains_refresh_pre_exec: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmetadata_server_grains\fP
.sp
New in version 2017.7.0.

.sp
Default: \fBFalse\fP
.sp
Set this option to enable gathering of cloud metadata from
\fBhttp://169.254.169.254/latest\fP for use in grains (see \fI\%here\fP for more information).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
metadata_server_grains: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfibre_channel_grains\fP
.sp
Default: \fBFalse\fP
.sp
The \fBfibre_channel_grains\fP setting will enable the \fBfc_wwn\fP grain for
Fibre Channel WWN\(aqs on the minion. Since this grain is expensive, it is
disabled by default.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fibre_channel_grains: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBiscsi_grains\fP
.sp
Default: \fBFalse\fP
.sp
The \fBiscsi_grains\fP setting will enable the \fBiscsi_iqn\fP grain on the
minion. Since this grain is expensive, it is disabled by default.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
iscsi_grains: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBnvme_grains\fP
.sp
Default: \fBFalse\fP
.sp
The \fBnvme_grains\fP setting will enable the \fBnvme_nqn\fP grain on the
minion. Since this grain is expensive, it is disabled by default.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nvme_grains: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmine_enabled\fP
.sp
New in version 2015.8.10.

.sp
Default: \fBTrue\fP
.sp
Determines whether or not the salt minion should run scheduled mine updates.  If this is set to
False then the mine update function will not get added to the scheduler for the minion.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_enabled: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmine_return_job\fP
.sp
New in version 2015.8.10.

.sp
Default: \fBFalse\fP
.sp
Determines whether or not scheduled mine updates should be accompanied by a job
return for the job cache.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_return_job: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmine_functions\fP
.sp
Default: Empty
.sp
Designate which functions should be executed at mine_interval intervals on each minion.
\fI\%See this documentation on the Salt Mine\fP for more information.
Note these can be defined in the pillar for a minion as well.
.INDENT 0.0
.INDENT 3.5
\fI\%example minion configuration file\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_functions:
  test.ping: []
  network.ip_addrs:
    interface: eth0
    cidr: \(aq10.0.0.0/8\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmine_interval\fP
.sp
Default: \fB60\fP
.sp
The number of minutes between mine updates.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_interval: 60
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsock_dir\fP
.sp
Default: \fB/var/run/salt/minion\fP
.sp
The directory where Unix sockets will be kept.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sock_dir: /var/run/salt/minion
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBenable_fqdns_grains\fP
.sp
Default: \fBTrue\fP
.sp
In order to calculate the fqdns grain, all the IP addresses from the minion are
processed with underlying calls to \fBsocket.gethostbyaddr\fP which can take 5 seconds
to be released (after reaching \fBsocket.timeout\fP) when there is no fqdn for that IP.
These calls to \fBsocket.gethostbyaddr\fP are processed asynchronously, however, it still
adds 5 seconds every time grains are generated if an IP does not resolve. In Windows
grains are regenerated each time a new process is spawned. Therefore, the default for
Windows is \fBFalse\fP\&. In many cases this value does not make sense to include for proxy
minions as it will be FQDN for the host running the proxy minion process, so the default
for proxy minions is \fBFalse\(ga\fP\&. On macOS, FQDN resolution can be very slow, therefore
the default for macOS is \fBFalse\fP as well. All other OSes default to \fBTrue\fP\&.
This option was added \fI\%here\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
enable_fqdns_grains: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBenable_gpu_grains\fP
.sp
Default: \fBTrue\fP
.sp
Enable GPU hardware data for your master. Be aware that the minion can
take a while to start up when lspci and/or dmidecode is used to populate the
grains for the minion, so this can be set to \fBFalse\fP if you do not need these
grains.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
enable_gpu_grains: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBoutputter_dirs\fP
.sp
Default: \fB[]\fP
.sp
A list of additional directories to search for salt outputters in.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
outputter_dirs: []
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBbackup_mode\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
Make backups of files replaced by \fBfile.managed\fP and \fBfile.recurse\fP state modules under
\fI\%cachedir\fP in \fBfile_backup\fP subdirectory preserving original paths.
Refer to \fI\%File State Backups documentation\fP for more details.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
backup_mode: minion
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBacceptance_wait_time\fP
.sp
Default: \fB10\fP
.sp
The number of seconds to wait until attempting to re\-authenticate with the
master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
acceptance_wait_time: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBacceptance_wait_time_max\fP
.sp
Default: \fB0\fP
.sp
The maximum number of seconds to wait until attempting to re\-authenticate
with the master. If set, the wait will increase by \fI\%acceptance_wait_time\fP
seconds each iteration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
acceptance_wait_time_max: 0
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrejected_retry\fP
.sp
Default: \fBFalse\fP
.sp
If the master denies or rejects the minion\(aqs public key, retry instead of
exiting.  These keys will be handled the same as waiting on acceptance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rejected_retry: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrandom_reauth_delay\fP
.sp
Default: \fB10\fP
.sp
When the master key changes, the minion will try to re\-auth itself to
receive the new master key. In larger environments this can cause a syn\-flood
on the master because all minions try to re\-auth immediately. To prevent this
and have a minion wait for a random amount of time, use this optional
parameter. The wait\-time will be a random number of seconds between
0 and the defined value.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
random_reauth_delay: 60
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_tries\fP
.sp
New in version 2016.3.0.

.sp
Default: \fB1\fP
.sp
The number of attempts to connect to a master before giving up. Set this to
\fB\-1\fP for unlimited attempts. This allows for a master to have downtime and the
minion to reconnect to it later when it comes back up. In \(aqfailover\(aq mode, which
is set in the \fI\%master_type\fP configuration, this value is the number
of attempts for each set of masters. In this mode, it will cycle through the list
of masters for each attempt.
.sp
\fBmaster_tries\fP is different than \fI\%auth_tries\fP because \fBauth_tries\fP
attempts to retry auth attempts with a single master. \fBauth_tries\fP is under the
assumption that you can connect to the master but not gain authorization from it.
\fBmaster_tries\fP will still cycle through all of the masters in a given try, so it
is appropriate if you expect occasional downtime from the master(s).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_tries: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBauth_tries\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB7\fP
.sp
The number of attempts to authenticate to a master before giving up. Or, more
technically, the number of consecutive SaltReqTimeoutErrors that are acceptable
when trying to authenticate to the master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
auth_tries: 7
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBauth_timeout\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB5\fP
.sp
When waiting for a master to accept the minion\(aqs public key, salt will
continuously attempt to reconnect until successful. This is the timeout value,
in seconds, for each individual attempt. After this timeout expires, the minion
will wait for \fI\%acceptance_wait_time\fP seconds before trying again.
Unless your master is under unusually heavy load, this should be left at the
default.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For high latency networks try increasing this value
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
auth_timeout: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBauth_safemode\fP
.sp
New in version 2014.7.0.

.sp
Default: \fBFalse\fP
.sp
If authentication fails due to SaltReqTimeoutError during a ping_interval,
this setting, when set to \fBTrue\fP, will cause a sub\-minion process to
restart.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
auth_safemode: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrequest_channel_timeout\fP
.sp
New in version 3006.2.

.sp
Default: \fB30\fP
.sp
The default timeout timeout for request channel requests. This setting can be used to tune minions to better handle long running pillar and file client requests.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
request_channel_timeout: 30
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrequest_channel_tries\fP
.sp
New in version 3006.2.

.sp
Default: \fB3\fP
.sp
The default number of times the minion will try request channel requests. This
setting can be used to tune minions to better handle long running pillar and
file client requests by retrying them after a timeout happens.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
request_channel_tries: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBping_interval\fP
.sp
Default: \fB0\fP
.sp
Instructs the minion to ping its master(s) every n number of minutes. Used
primarily as a mitigation technique against minion disconnects.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ping_interval: 0
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrandom_startup_delay\fP
.sp
Default: \fB0\fP
.sp
The maximum bound for an interval in which a minion will randomly sleep upon starting
up prior to attempting to connect to a master. This can be used to splay connection attempts
for cases where many minions starting up at once may place undue load on a master.
.sp
For example, setting this to \fB5\fP will tell a minion to sleep for a value between \fB0\fP
and \fB5\fP seconds.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
random_startup_delay: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrecon_default\fP
.sp
Default: \fB1000\fP
.sp
The interval in milliseconds that the socket should wait before trying to
reconnect to the master (1000ms = 1 second).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
recon_default: 1000
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrecon_max\fP
.sp
Default: \fB10000\fP
.sp
The maximum time a socket should wait. Each interval the time to wait is calculated
by doubling the previous time. If recon_max is reached, it starts again at
the recon_default.
.INDENT 0.0
.TP
.B Short example:
.INDENT 7.0
.IP \(bu 2
reconnect 1: the socket will wait \(aqrecon_default\(aq milliseconds
.IP \(bu 2
reconnect 2: \(aqrecon_default\(aq * 2
.IP \(bu 2
reconnect 3: (\(aqrecon_default\(aq * 2) * 2
.IP \(bu 2
reconnect 4: value from previous interval * 2
.IP \(bu 2
reconnect 5: value from previous interval * 2
.IP \(bu 2
reconnect x: if value >= recon_max, it starts again with recon_default
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
recon_max: 10000
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrecon_randomize\fP
.sp
Default: \fBTrue\fP
.sp
Generate a random wait time on minion start. The wait time will be a random value
between recon_default and recon_default + recon_max. Having all minions reconnect
with the same recon_default and recon_max value kind of defeats the purpose of being
able to change these settings. If all minions have the same values and the setup is
quite large (several thousand minions), they will still flood the master. The desired
behavior is to have time\-frame within all minions try to reconnect.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
recon_randomize: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBloop_interval\fP
.sp
Default: \fB1\fP
.sp
The loop_interval sets how long in seconds the minion will wait between
evaluating the scheduler and running cleanup tasks. This defaults to 1
second on the minion scheduler.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
loop_interval: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpub_ret\fP
.sp
Default: True
.sp
Some installations choose to start all job returns in a cache or a returner
and forgo sending the results back to a master. In this workflow, jobs
are most often executed with \-\-async from the Salt CLI and then results
are evaluated by examining job caches on the minions or any configured returners.
WARNING: Setting this to False will \fBdisable\fP returns back to the master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pub_ret: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBreturn_retry_timer\fP
.sp
Default: \fB5\fP
.sp
The default timeout for a minion return attempt.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
return_retry_timer: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBreturn_retry_timer_max\fP
.sp
Default: \fB10\fP
.sp
The maximum timeout for a minion return attempt. If non\-zero the minion return
retry timeout will be a random int between \fBreturn_retry_timer\fP and
\fBreturn_retry_timer_max\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
return_retry_timer_max: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBreturn_retry_tries\fP
.sp
Default: \fB3\fP
.sp
The maximum number of retries for a minion return attempt.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
return_retry_tries: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcache_sreqs\fP
.sp
Default: \fBTrue\fP
.sp
The connection to the master ret_port is kept open. When set to False, the minion
creates a new connection for every return to the master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cache_sreqs: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBipc_mode\fP
.sp
Default: \fBipc\fP
.sp
Windows platforms lack POSIX IPC and must rely on slower TCP based inter\-
process communications. \fBipc_mode\fP is set to \fBtcp\fP on such systems.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ipc_mode: ipc
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBipc_write_buffer\fP
.sp
Default: \fB0\fP
.sp
The maximum size of a message sent via the IPC transport module can be limited
dynamically or by sharing an integer value lower than the total memory size. When
the value \fBdynamic\fP is set, salt will use 2.5% of the total memory as
\fBipc_write_buffer\fP value (rounded to an integer). A value of \fB0\fP disables
this option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ipc_write_buffer: 10485760
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtcp_pub_port\fP
.sp
Default: \fB4510\fP
.sp
Publish port used when \fI\%ipc_mode\fP is set to \fBtcp\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tcp_pub_port: 4510
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtcp_pull_port\fP
.sp
Default: \fB4511\fP
.sp
Pull port used when \fI\%ipc_mode\fP is set to \fBtcp\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tcp_pull_port: 4511
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtransport\fP
.sp
Default: \fBzeromq\fP
.sp
Changes the underlying transport layer. ZeroMQ is the recommended transport
while additional transport layers are under development. Supported values are
\fBzeromq\fP and \fBtcp\fP (experimental). This setting has a significant impact
on performance and should not be changed unless you know what you are doing!
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
transport: zeromq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsyndic_finger\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
The key fingerprint of the higher\-level master for the syndic to verify it is
talking to the intended master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
syndic_finger: \(aqab:30:65:2a:d6:9e:20:4f:d8:b2:f3:a7:d4:65:50:10\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBhttp_connect_timeout\fP
.sp
New in version 2019.2.0.

.sp
Default: \fB20\fP
.sp
HTTP connection timeout in seconds.
Applied when fetching files using tornado back\-end.
Should be greater than overall download time.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
http_connect_timeout: 20
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBhttp_request_timeout\fP
.sp
New in version 2015.8.0.

.sp
Default: \fB3600\fP
.sp
HTTP request timeout in seconds.
Applied when fetching files using tornado back\-end.
Should be greater than overall download time.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
http_request_timeout: 3600
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBproxy_host\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
The hostname used for HTTP proxy access.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy_host: proxy.my\-domain
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBproxy_port\fP
.sp
Default: \fB0\fP
.sp
The port number used for HTTP proxy access.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy_port: 31337
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBproxy_username\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
The username used for HTTP proxy access.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy_username: charon
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBproxy_password\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
The password used for HTTP proxy access.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy_password: obolus
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBno_proxy\fP
.sp
New in version 2019.2.0.

.sp
Default: \fB[]\fP
.sp
List of hosts to bypass HTTP proxy
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This key does nothing unless proxy_host etc is configured, it does not
support any kind of wildcards.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
no_proxy: [ \(aq127.0.0.1\(aq, \(aqfoo.tld\(aq ]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBuse_yamlloader_old\fP
.sp
New in version 2019.2.1.

.sp
Default: \fBFalse\fP
.sp
Use the pre\-2019.2 YAML renderer.
Uses legacy YAML rendering to support some legacy inline data structures.
See the \fI\%2019.2.1 release notes\fP for more details.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
use_yamlloader_old: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Docker Configuration
.SS \fBdocker.update_mine\fP
.sp
New in version 2017.7.8,2018.3.3.

.sp
Changed in version 2019.2.0: The default value is now \fBFalse\fP

.sp
Default: \fBTrue\fP
.sp
If enabled, when containers are added, removed, stopped, started, etc., the
\fI\%mine\fP will be updated with the results of \fBdocker.ps
verbose=True all=True host=True\fP\&. This mine data is
used by \fI\%mine.get_docker\fP\&. Set this
option to \fBFalse\fP to keep Salt from updating the mine with this information.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This option can also be set in Grains or Pillar data, with Grains
overriding Pillar and the minion config file overriding Grains.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Disabling this will of course keep \fI\%mine.get_docker\fP from returning any information for a given
minion.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
docker.update_mine: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBdocker.compare_container_networks\fP
.sp
New in version 2018.3.0.

.sp
Default: \fB{\(aqstatic\(aq: [\(aqAliases\(aq, \(aqLinks\(aq, \(aqIPAMConfig\(aq], \(aqautomatic\(aq: [\(aqIPAddress\(aq, \(aqGateway\(aq, \(aqGlobalIPv6Address\(aq, \(aqIPv6Gateway\(aq]}\fP
.sp
Specifies which keys are examined by
\fI\%docker.compare_container_networks\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This should not need to be modified unless new features added to Docker
result in new keys added to the network configuration which must be
compared to determine if two containers have different network configs.
This config option exists solely as a way to allow users to continue using
Salt to manage their containers after an API change, without waiting for a
new Salt release to catch up to the changes in the Docker API.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
docker.compare_container_networks:
  static:
    \- Aliases
    \- Links
    \- IPAMConfig
  automatic:
    \- IPAddress
    \- Gateway
    \- GlobalIPv6Address
    \- IPv6Gateway
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBoptimization_order\fP
.sp
Default: \fB[0, 1, 2]\fP
.sp
In cases where Salt is distributed without .py files, this option determines
the priority of optimization level(s) Salt\(aqs module loader should prefer.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This option is only supported on Python 3.5+.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
optimization_order:
  \- 2
  \- 0
  \- 1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Minion Execution Module Management
.SS \fBdisable_modules\fP
.sp
Default: \fB[]\fP (all execution modules are enabled by default)
.sp
The event may occur in which the administrator desires that a minion should not
be able to execute a certain module.
.sp
However, the \fBsys\fP module is built into the minion and cannot be disabled.
.sp
This setting can also tune the minion. Because all modules are loaded into system
memory, disabling modules will lower the minion\(aqs memory footprint.
.sp
Modules should be specified according to their file name on the system and not by
their virtual name. For example, to disable \fBcmd\fP, use the string \fBcmdmod\fP which
corresponds to \fBsalt.modules.cmdmod\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
disable_modules:
  \- test
  \- solr
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBdisable_returners\fP
.sp
Default: \fB[]\fP (all returners are enabled by default)
.sp
If certain returners should be disabled, this is the place
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
disable_returners:
  \- mongo_return
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwhitelist_modules\fP
.sp
Default: \fB[]\fP (Module whitelisting is disabled.  Adding anything to the config option
will cause only the listed modules to be enabled.  Modules not in the list will
not be loaded.)
.sp
This option is the reverse of disable_modules. If enabled, only execution modules in this
list will be loaded and executed on the minion.
.sp
Note that this is a very large hammer and it can be quite difficult to keep the minion working
the way you think it should since Salt uses many modules internally itself.  At a bare minimum
you need the following enabled or else the minion won\(aqt start.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
whitelist_modules:
  \- cmdmod
  \- test
  \- config
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmodule_dirs\fP
.sp
Default: \fB[]\fP
.sp
A list of extra directories to search for Salt modules
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
module_dirs:
  \- /var/lib/salt/modules
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBreturner_dirs\fP
.sp
Default: \fB[]\fP
.sp
A list of extra directories to search for Salt returners
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
returner_dirs:
  \- /var/lib/salt/returners
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstates_dirs\fP
.sp
Default: \fB[]\fP
.sp
A list of extra directories to search for Salt states
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
states_dirs:
  \- /var/lib/salt/states
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgrains_dirs\fP
.sp
Default: \fB[]\fP
.sp
A list of extra directories to search for Salt grains
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grains_dirs:
  \- /var/lib/salt/grains
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrender_dirs\fP
.sp
Default: \fB[]\fP
.sp
A list of extra directories to search for Salt renderers
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
render_dirs:
  \- /var/lib/salt/renderers
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fButils_dirs\fP
.sp
Default: \fB[]\fP
.sp
A list of extra directories to search for Salt utilities
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
utils_dirs:
  \- /var/lib/salt/utils
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcython_enable\fP
.sp
Default: \fBFalse\fP
.sp
Set this value to true to enable auto\-loading and compiling of \fB\&.pyx\fP modules,
This setting requires that \fBgcc\fP and \fBcython\fP are installed on the minion.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cython_enable: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBenable_zip_modules\fP
.sp
New in version 2015.8.0.

.sp
Default: \fBFalse\fP
.sp
Set this value to true to enable loading of zip archives as extension modules.
This allows for packing module code with specific dependencies to avoid conflicts
and/or having to install specific modules\(aq dependencies in system libraries.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
enable_zip_modules: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBproviders\fP
.sp
Default: (empty)
.sp
A module provider can be statically overwritten or extended for the minion via
the \fBproviders\fP option. This can be done \fI\%on an individual basis in an
SLS file\fP, or globally here in the minion config, like
below.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
providers:
  service: systemd
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmodules_max_memory\fP
.sp
Default: \fB\-1\fP
.sp
Specify a max size (in bytes) for modules on import. This feature is currently
only supported on *NIX operating systems and requires psutil.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
modules_max_memory: \-1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBextmod_whitelist/extmod_blacklist\fP
.sp
New in version 2017.7.0.

.sp
By using this dictionary, the modules that are synced to the minion\(aqs extmod cache using \fIsaltutil.sync_*\fP can be
limited.  If nothing is set to a specific type, then all modules are accepted.  To block all modules of a specific type,
whitelist an empty list.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
extmod_whitelist:
  modules:
    \- custom_module
  engines:
    \- custom_engine
  pillars: []

extmod_blacklist:
  modules:
    \- specific_module
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Valid options:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
beacons
.IP \(bu 2
clouds
.IP \(bu 2
sdb
.IP \(bu 2
modules
.IP \(bu 2
states
.IP \(bu 2
grains
.IP \(bu 2
renderers
.IP \(bu 2
returners
.IP \(bu 2
proxy
.IP \(bu 2
engines
.IP \(bu 2
output
.IP \(bu 2
utils
.IP \(bu 2
pillar
.UNINDENT
.UNINDENT
.UNINDENT
.SS Top File Settings
.SS \fBstate_top\fP
.sp
Default: \fBtop.sls\fP
.sp
The state system uses a \(dqtop\(dq file to tell the minions what environment to
use and what modules to use. The state_top file is defined relative to the
root of the base environment.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_top: top.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_top_saltenv\fP
.sp
This option has no default value. Set it to an environment name to ensure that
\fIonly\fP the top file from that environment is considered during a
\fI\%highstate\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Using this value does not change the merging strategy. For instance, if
\fI\%top_file_merging_strategy\fP is set to \fBmerge\fP, and
\fI\%state_top_saltenv\fP is set to \fBfoo\fP, then any sections for
environments other than \fBfoo\fP in the top file for the \fBfoo\fP environment
will be ignored. With \fI\%state_top_saltenv\fP set to \fBbase\fP, all
states from all environments in the \fBbase\fP top file will be applied,
while all other top files are ignored. The only way to set
\fI\%state_top_saltenv\fP to something other than \fBbase\fP and not
have the other environments in the targeted top file ignored, would be to
set \fI\%top_file_merging_strategy\fP to \fBmerge_all\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_top_saltenv: dev
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtop_file_merging_strategy\fP
.sp
Changed in version 2016.11.0: A \fBmerge_all\fP strategy has been added.

.sp
Default: \fBmerge\fP
.sp
When no specific fileserver environment (a.k.a. \fBsaltenv\fP) has been specified
for a \fI\%highstate\fP, all environments\(aq top files are
inspected. This config option determines how the SLS targets in those top files
are handled.
.sp
When set to \fBmerge\fP, the \fBbase\fP environment\(aqs top file is evaluated first,
followed by the other environments\(aq top files. The first target expression
(e.g. \fB\(aq*\(aq\fP) for a given environment is kept, and when the same target
expression is used in a different top file evaluated later, it is ignored.
Because \fBbase\fP is evaluated first, it is authoritative. For example, if there
is a target for \fB\(aq*\(aq\fP for the \fBfoo\fP environment in both the \fBbase\fP and
\fBfoo\fP environment\(aqs top files, the one in the \fBfoo\fP environment would be
ignored. The environments will be evaluated in no specific order (aside from
\fBbase\fP coming first). For greater control over the order in which the
environments are evaluated, use \fI\%env_order\fP\&. Note that, aside from
the \fBbase\fP environment\(aqs top file, any sections in top files that do not
match that top file\(aqs environment will be ignored. So, for example, a section
for the \fBqa\fP environment would be ignored if it appears in the \fBdev\fP
environment\(aqs top file. To keep use cases like this from being ignored, use the
\fBmerge_all\fP strategy.
.sp
When set to \fBsame\fP, then for each environment, only that environment\(aqs top
file is processed, with the others being ignored. For example, only the \fBdev\fP
environment\(aqs top file will be processed for the \fBdev\fP environment, and any
SLS targets defined for \fBdev\fP in the \fBbase\fP environment\(aqs (or any other
environment\(aqs) top file will be ignored. If an environment does not have a top
file, then the top file from the \fI\%default_top\fP config parameter
will be used as a fallback.
.sp
When set to \fBmerge_all\fP, then all states in all environments in all top files
will be applied. The order in which individual SLS files will be executed will
depend on the order in which the top files were evaluated, and the environments
will be evaluated in no specific order. For greater control over the order in
which the environments are evaluated, use \fI\%env_order\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
top_file_merging_strategy: same
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBenv_order\fP
.sp
Default: \fB[]\fP
.sp
When \fI\%top_file_merging_strategy\fP is set to \fBmerge\fP, and no
environment is specified for a \fI\%highstate\fP, this
config option allows for the order in which top files are evaluated to be
explicitly defined.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
env_order:
  \- base
  \- dev
  \- qa
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBdefault_top\fP
.sp
Default: \fBbase\fP
.sp
When \fI\%top_file_merging_strategy\fP is set to \fBsame\fP, and no
environment is specified for a \fI\%highstate\fP (i.e.
\fI\%environment\fP is not set for the minion), this config option
specifies a fallback environment in which to look for a top file if an
environment lacks one.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
default_top: dev
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstartup_states\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
States to run when the minion daemon starts. To enable, set \fBstartup_states\fP to:
.INDENT 0.0
.IP \(bu 2
\fBhighstate\fP: Execute state.highstate
.IP \(bu 2
\fBsls\fP: Read in the sls_list option and execute the named sls files
.IP \(bu 2
\fBtop\fP: Read top_file option and execute based on that file on the Master
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
startup_states: \(aq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsls_list\fP
.sp
Default: \fB[]\fP
.sp
List of states to run when the minion starts up if \fBstartup_states\fP is set to \fBsls\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sls_list:
  \- edit.vim
  \- hyper
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstart_event_grains\fP
.sp
Default: \fB[]\fP
.sp
List of grains to pass in start event when minion starts up.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
start_event_grains:
  \- machine_id
  \- uuid
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtop_file\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
Top file to execute if \fBstartup_states\fP is set to \fBtop\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
top_file: \(aq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS State Management Settings
.SS \fBrenderer\fP
.sp
Default: \fBjinja|yaml\fP
.sp
The default renderer used for local state executions
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
renderer: jinja|json
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtest\fP
.sp
Default: \fBFalse\fP
.sp
Set all state calls to only test if they are going to actually make changes
or just post what changes are going to be made.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
test: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_aggregate\fP
.sp
Default: \fBFalse\fP
.sp
Automatically aggregate all states that have support for \fBmod_aggregate\fP by
setting to \fBTrue\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_aggregate: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or pass a list of state module names to automatically
aggregate just those types.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_aggregate:
  \- pkg
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_queue\fP
.sp
Default: \fBFalse\fP
.sp
Instead of failing immediately when another state run is in progress, a value
of \fBTrue\fP will queue the new state run to begin running once the other has
finished. This option starts a new thread for each queued state run, so use
this option sparingly.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_queue: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Additionally, it can be set to an integer representing the maximum queue size
which can be attained before the state runs will fail to be queued. This can
prevent runaway conditions where new threads are started until system
performance is hampered.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_queue: 2
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_verbose\fP
.sp
Default: \fBTrue\fP
.sp
Controls the verbosity of state runs. By default, the results of all states are
returned, but setting this value to \fBFalse\fP will cause salt to only display
output for states that failed or states that have changes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_verbose: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_output\fP
.sp
Default: \fBfull\fP
.sp
The state_output setting controls which results will be output full multi line:
.INDENT 0.0
.IP \(bu 2
\fBfull\fP, \fBterse\fP \- each state will be full/terse
.IP \(bu 2
\fBmixed\fP \- only states with errors will be full
.IP \(bu 2
\fBchanges\fP \- states with changes and errors will be full
.UNINDENT
.sp
\fBfull_id\fP, \fBmixed_id\fP, \fBchanges_id\fP and \fBterse_id\fP are also allowed;
when set, the state ID will be used as name in the output.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_output: full
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_output_diff\fP
.sp
Default: \fBFalse\fP
.sp
The state_output_diff setting changes whether or not the output from
successful states is returned. Useful when even the terse output of these
states is cluttering the logs. Set it to True to ignore them.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_output_diff: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_output_profile\fP
.sp
Default: \fBTrue\fP
.sp
The \fBstate_output_profile\fP setting changes whether profile information
will be shown for each state run.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_output_profile: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_output_pct\fP
.sp
Default: \fBFalse\fP
.sp
The \fBstate_output_pct\fP setting changes whether success and failure information
as a percent of total actions will be shown for each state run.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_output_pct: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBstate_compress_ids\fP
.sp
Default: \fBFalse\fP
.sp
The \fBstate_compress_ids\fP setting aggregates information about states which
have multiple \(dqnames\(dq under the same state ID in the highstate output.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_compress_ids: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBautoload_dynamic_modules\fP
.sp
Default: \fBTrue\fP
.sp
autoload_dynamic_modules turns on automatic loading of modules found in the
environments on the master. This is turned on by default. To turn off
auto\-loading modules when states run, set this value to \fBFalse\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
autoload_dynamic_modules: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBclean_dynamic_modules\fP
.sp
Default: \fBTrue\fP
.sp
clean_dynamic_modules keeps the dynamic modules on the minion in sync with
the dynamic modules on the master. This means that if a dynamic module is
not on the master it will be deleted from the minion. By default this is
enabled and can be disabled by changing this value to \fBFalse\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
clean_dynamic_modules: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If \fBextmod_whitelist\fP is specified, modules which are not whitelisted will also be cleaned here.
.UNINDENT
.UNINDENT
.SS \fBsaltenv\fP
.sp
Changed in version 2018.3.0: Renamed from \fBenvironment\fP to \fBsaltenv\fP\&. If \fBenvironment\fP is used,
\fBsaltenv\fP will take its value. If both are used, \fBenvironment\fP will be
ignored and \fBsaltenv\fP will be used.

.sp
The default fileserver environment to use when copying files and applying states.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
saltenv: dev
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlock_saltenv\fP
.sp
New in version 2018.3.0.

.sp
Default: \fBFalse\fP
.sp
For purposes of running states, this option prevents using the \fBsaltenv\fP
argument to manually set the environment. This is useful to keep a minion which
has the \fI\%saltenv\fP option set to \fBdev\fP from running states from
an environment other than \fBdev\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lock_saltenv: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsnapper_states\fP
.sp
Default: False
.sp
The \fIsnapper_states\fP value is used to enable taking snapper snapshots before
and after salt state runs. This allows for state runs to be rolled back.
.sp
For snapper states to function properly snapper needs to be installed and
enabled.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
snapper_states: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsnapper_states_config\fP
.sp
Default: \fBroot\fP
.sp
Snapper can execute based on a snapper configuration. The configuration
needs to be set up before snapper can use it. The default configuration
is \fBroot\fP, this default makes snapper run on SUSE systems using the
default configuration set up at install time.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
snapper_states_config: root
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBglobal_state_conditions\fP
.sp
Default: \fBNone\fP
.sp
If set, this parameter expects a dictionary of state module names as keys and a
list of conditions which must be satisfied in order to run any functions in that
state module.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
global_state_conditions:
  \(dq*\(dq: [\(dqG@global_noop:false\(dq]
  service: [\(dqnot G@virtual_subtype:chroot\(dq]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS File Directory Settings
.SS \fBfile_client\fP
.sp
Default: \fBremote\fP
.sp
The client defaults to looking on the master server for files, but can be
directed to look on the minion by setting this parameter to \fBlocal\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_client: remote
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBuse_master_when_local\fP
.sp
Default: \fBFalse\fP
.sp
When using a local \fI\%file_client\fP, this parameter is used to allow
the client to connect to a master for remote execution.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
use_master_when_local: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfile_roots\fP
.sp
Default:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \- /srv/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When using a local \fI\%file_client\fP, this parameter is used to setup
the fileserver\(aqs environments. This parameter operates identically to the
\fI\%master config parameter\fP of the same name.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt
  dev:
    \- /srv/salt/dev/services
    \- /srv/salt/dev/states
  prod:
    \- /srv/salt/prod/services
    \- /srv/salt/prod/states
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfileserver_followsymlinks\fP
.sp
New in version 2014.1.0.

.sp
Default: \fBTrue\fP
.sp
By default, the file_server follows symlinks when walking the filesystem tree.
Currently this only applies to the default roots fileserver_backend.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_followsymlinks: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfileserver_ignoresymlinks\fP
.sp
New in version 2014.1.0.

.sp
Default: \fBFalse\fP
.sp
If you do not want symlinks to be treated as the files they are pointing to,
set \fBfileserver_ignoresymlinks\fP to \fBTrue\fP\&. By default this is set to
False. When set to \fBTrue\fP, any detected symlink while listing files on the
Master will not be returned to the Minion.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_ignoresymlinks: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBhash_type\fP
.sp
Default: \fBsha256\fP
.sp
The hash_type is the hash to use when discovering the hash of a file on the
local fileserver. The default is sha256, but md5, sha1, sha224, sha384, and
sha512 are also supported.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hash_type: sha256
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Pillar Configuration
.SS \fBpillar_roots\fP
.sp
Default:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \- /srv/pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When using a local \fI\%file_client\fP, this parameter is used to setup
the pillar environments.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_roots:
  base:
    \- /srv/pillar
  dev:
    \- /srv/pillar/dev
  prod:
    \- /srv/pillar/prod
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBon_demand_ext_pillar\fP
.sp
New in version 2016.3.6,2016.11.3,2017.7.0.

.sp
Default: \fB[\(aqlibvirt\(aq, \(aqvirtkey\(aq]\fP
.sp
When using a local \fI\%file_client\fP, this option controls which
external pillars are permitted to be used on\-demand using \fI\%pillar.ext\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
on_demand_ext_pillar:
  \- libvirt
  \- virtkey
  \- git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This will allow a masterless minion to request specific pillar data via
\fI\%pillar.ext\fP, and may be considered a
security risk. However, pillar data generated in this way will not affect
the \fI\%in\-memory pillar data\fP, so this risk is
limited to instances in which states/modules/etc. (built\-in or custom) rely
upon pillar data generated by \fI\%pillar.ext\fP\&.
.UNINDENT
.UNINDENT
.SS \fBdecrypt_pillar\fP
.sp
New in version 2017.7.0.

.sp
Default: \fB[]\fP
.sp
A list of paths to be recursively decrypted during pillar compilation.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
decrypt_pillar:
  \- \(aqfoo:bar\(aq: gpg
  \- \(aqlorem:ipsum:dolor\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Entries in this list can be formatted either as a simple string, or as a
key/value pair, with the key being the pillar location, and the value being the
renderer to use for pillar decryption. If the former is used, the renderer
specified by \fI\%decrypt_pillar_default\fP will be used.
.SS \fBdecrypt_pillar_delimiter\fP
.sp
New in version 2017.7.0.

.sp
Default: \fB:\fP
.sp
The delimiter used to distinguish nested data structures in the
\fI\%decrypt_pillar\fP option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
decrypt_pillar_delimiter: \(aq|\(aq
decrypt_pillar:
  \- \(aqfoo|bar\(aq: gpg
  \- \(aqlorem|ipsum|dolor\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBdecrypt_pillar_default\fP
.sp
New in version 2017.7.0.

.sp
Default: \fBgpg\fP
.sp
The default renderer used for decryption, if one is not specified for a given
pillar key in \fI\%decrypt_pillar\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
decrypt_pillar_default: my_custom_renderer
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBdecrypt_pillar_renderers\fP
.sp
New in version 2017.7.0.

.sp
Default: \fB[\(aqgpg\(aq]\fP
.sp
List of renderers which are permitted to be used for pillar decryption.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
decrypt_pillar_renderers:
  \- gpg
  \- my_custom_renderer
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgpg_decrypt_must_succeed\fP
.sp
New in version 3005.

.sp
Default: \fBFalse\fP
.sp
If this is \fBTrue\fP and the ciphertext could not be decrypted, then an error is
raised.
.sp
Sending the ciphertext through basically is \fInever\fP desired, for example if a
state is setting a database password from pillar and gpg rendering fails, then
the state will update the password to the ciphertext, which by definition is
not encrypted.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
The value defaults to \fBFalse\fP for backwards compatibility.  In the
\fBChlorine\fP release, this option will default to \fBTrue\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gpg_decrypt_must_succeed: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpillarenv\fP
.sp
Default: \fBNone\fP
.sp
Isolates the pillar environment on the minion side. This functions the same as
the environment setting, but for pillar instead of states.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillarenv: dev
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpillarenv_from_saltenv\fP
.sp
New in version 2017.7.0.

.sp
Default: \fBFalse\fP
.sp
When set to \fBTrue\fP, the \fI\%pillarenv\fP value will assume the value
of the effective saltenv when running states. This essentially makes \fBsalt \(aq*\(aq
state.sls mysls saltenv=dev\fP equivalent to \fBsalt \(aq*\(aq state.sls mysls
saltenv=dev pillarenv=dev\fP\&. If \fI\%pillarenv\fP is set, either in the
minion config file or via the CLI, it will override this option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillarenv_from_saltenv: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpillar_raise_on_missing\fP
.sp
New in version 2015.5.0.

.sp
Default: \fBFalse\fP
.sp
Set this option to \fBTrue\fP to force a \fBKeyError\fP to be raised whenever an
attempt to retrieve a named value from pillar fails. When this option is set
to \fBFalse\fP, the failed attempt returns an empty string.
.SS \fBminion_pillar_cache\fP
.sp
New in version 2016.3.0.

.sp
Default: \fBFalse\fP
.sp
The minion can locally cache rendered pillar data under
\fI\%cachedir\fP/pillar. This allows a temporarily disconnected minion
to access previously cached pillar data by invoking salt\-call with the \-\-local
and \-\-pillar_root=:conf_minion:\fIcachedir\fP/pillar options. Before enabling this
setting consider that the rendered pillar may contain security sensitive data.
Appropriate access restrictions should be in place. By default the saved pillar
data will be readable only by the user account running salt. By default this
feature is disabled, to enable set minion_pillar_cache to \fBTrue\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minion_pillar_cache: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfile_recv_max_size\fP
.sp
New in version 2014.7.0.

.sp
Default: \fB100\fP
.sp
Set a hard\-limit on the size of the files that can be pushed to the master.
It will be interpreted as megabytes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_recv_max_size: 100
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpass_to_ext_pillars\fP
.sp
Specify a list of configuration keys whose values are to be passed to
external pillar functions.
.sp
Suboptions can be specified using the \(aq:\(aq notation (i.e. \fBoption:suboption\fP)
.sp
The values are merged and included in the \fBextra_minion_data\fP optional
parameter of the external pillar function.  The \fBextra_minion_data\fP parameter
is passed only to the external pillar functions that have it explicitly
specified in their definition.
.sp
If the config contains
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
opt1: value1
opt2:
  subopt1: value2
  subopt2: value3

pass_to_ext_pillars:
  \- opt1
  \- opt2: subopt1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
the \fBextra_minion_data\fP parameter will be
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqopt1\(dq: \(dqvalue1\(dq, \(dqopt2\(dq: {\(dqsubopt1\(dq: \(dqvalue2\(dq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssh_merge_pillar\fP
.sp
New in version 2018.3.2.

.sp
Default: \fBTrue\fP
.sp
Merges the compiled pillar data with the pillar data already available globally.
This is useful when using \fBsalt\-ssh\fP or \fBsalt\-call \-\-local\fP and overriding the pillar
data in a state file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apply_showpillar:
  module.run:
    \- name: state.apply
    \- mods:
      \- showpillar
    \- kwargs:
          pillar:
              test: \(dqfoo bar\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If set to \fBTrue\fP, the \fBshowpillar\fP state will have access to the
global pillar data.
.sp
If set to \fBFalse\fP, only the overriding pillar data will be available
to the \fBshowpillar\fP state.
.SS Security Settings
.SS \fBopen_mode\fP
.sp
Default: \fBFalse\fP
.sp
Open mode can be used to clean out the PKI key received from the Salt master,
turn on open mode, restart the minion, then turn off open mode and restart the
minion to clean the keys.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
open_mode: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmaster_finger\fP
.sp
Default: \fB\(aq\(aq\fP
.sp
Fingerprint of the master public key to validate the identity of your Salt master
before the initial key exchange. The master fingerprint can be found as \fBmaster.pub\fP by running
\(dqsalt\-key \-F master\(dq on the Salt master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_finger: \(aqba:30:65:2a:d6:9e:20:4f:d8:b2:f3:a7:d4:65:11:13\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBkeysize\fP
.sp
Default: \fB2048\fP
.sp
The size of key that should be generated when creating new keys.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
keysize: 2048
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpermissive_pki_access\fP
.sp
Default: \fBFalse\fP
.sp
Enable permissive access to the salt keys. This allows you to run the
master or minion as root, but have a non\-root group be given access to
your pki_dir. To make the access explicit, root must belong to the group
you\(aqve given access to. This is potentially quite insecure.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
permissive_pki_access: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBverify_master_pubkey_sign\fP
.sp
Default: \fBFalse\fP
.sp
Enables verification of the master\-public\-signature returned by the master in
auth\-replies. Please see the tutorial on how to configure this properly
\fI\%Multimaster\-PKI with Failover Tutorial\fP
.sp
New in version 2014.7.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
verify_master_pubkey_sign: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If this is set to \fBTrue\fP, \fI\%master_sign_pubkey\fP must be also set
to \fBTrue\fP in the master configuration file.
.SS \fBmaster_sign_key_name\fP
.sp
Default: \fBmaster_sign\fP
.sp
The filename without the \fI\&.pub\fP suffix of the public key that should be used
for verifying the signature from the master. The file must be located in the
minion\(aqs pki directory.
.sp
New in version 2014.7.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_sign_key_name: <filename_without_suffix>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBautosign_grains\fP
.sp
New in version 2018.3.0.

.sp
Default: \fBnot defined\fP
.sp
The grains that should be sent to the master on authentication to decide if
the minion\(aqs key should be accepted automatically.
.sp
Please see the \fI\%Autoaccept Minions from Grains\fP
documentation for more information.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
autosign_grains:
  \- uuid
  \- server_id
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBalways_verify_signature\fP
.sp
Default: \fBFalse\fP
.sp
If \fI\%verify_master_pubkey_sign\fP is enabled, the signature is only verified
if the public\-key of the master changes. If the signature should always be verified,
this can be set to \fBTrue\fP\&.
.sp
New in version 2014.7.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
always_verify_signature: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcmd_blacklist_glob\fP
.sp
Default: \fB[]\fP
.sp
If \fI\%cmd_blacklist_glob\fP is enabled then any shell command called over
remote execution or via salt\-call will be checked against the glob matches found in
the \fIcmd_blacklist_glob\fP list and any matched shell command will be blocked.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This blacklist is only applied to direct executions made by the \fIsalt\fP and
\fIsalt\-call\fP commands. This does NOT blacklist commands called from states
or shell commands executed from other modules.
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cmd_blacklist_glob:
  \- \(aqrm * \(aq
  \- \(aqcat /etc/* \(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcmd_whitelist_glob\fP
.sp
Default: \fB[]\fP
.sp
If \fI\%cmd_whitelist_glob\fP is enabled then any shell command called over
remote execution or via salt\-call will be checked against the glob matches found in
the \fIcmd_whitelist_glob\fP list and any shell command NOT found in the list will be
blocked. If \fIcmd_whitelist_glob\fP is NOT SET, then all shell commands are permitted.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This whitelist is only applied to direct executions made by the \fIsalt\fP and
\fIsalt\-call\fP commands. This does NOT restrict commands called from states
or shell commands executed from other modules.
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cmd_whitelist_glob:
  \- \(aqls * \(aq
  \- \(aqcat /etc/fstab\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBssl\fP
.sp
New in version 2016.11.0.

.sp
Default: \fBNone\fP
.sp
TLS/SSL connection options. This could be set to a dictionary containing
arguments corresponding to python \fBssl.wrap_socket\fP method. For details see
\fI\%Tornado\fP
and \fI\%Python\fP
documentation.
.sp
Note: to set enum arguments values like \fBcert_reqs\fP and \fBssl_version\fP use
constant names without ssl module prefix: \fBCERT_REQUIRED\fP or \fBPROTOCOL_SSLv23\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssl:
    keyfile: <path_to_keyfile>
    certfile: <path_to_certfile>
    ssl_version: PROTOCOL_TLSv1_2
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Reactor Settings
.SS \fBreactor\fP
.sp
Default: \fB[]\fP
.sp
Defines a salt reactor. See the \fI\%Reactor\fP documentation for more
information.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor: []
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBreactor_refresh_interval\fP
.sp
Default: \fB60\fP
.sp
The TTL for the cache of the reactor configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor_refresh_interval: 60
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBreactor_worker_threads\fP
.sp
Default: \fB10\fP
.sp
The number of workers for the runner/wheel in the reactor.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor_worker_threads: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBreactor_worker_hwm\fP
.sp
Default: \fB10000\fP
.sp
The queue size for workers in the reactor.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor_worker_hwm: 10000
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Thread Settings
.SS \fBmultiprocessing\fP
.sp
Default: \fBTrue\fP
.sp
If \fBmultiprocessing\fP is enabled when a minion receives a
publication a new process is spawned and the command is executed therein.
Conversely, if \fBmultiprocessing\fP is disabled the new publication will be run
executed in a thread.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
multiprocessing: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBprocess_count_max\fP
.sp
New in version 2018.3.0.

.sp
Default: \fB\-1\fP
.sp
Limit the maximum amount of processes or threads created by \fBsalt\-minion\fP\&.
This is useful to avoid resource exhaustion in case the minion receives more
publications than it is able to handle, as it limits the number of spawned
processes or threads. \fB\-1\fP is the default and disables the limit.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
process_count_max: \-1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Minion Logging Settings
.SS \fBlog_file\fP
.sp
Default: \fB/var/log/salt/minion\fP
.sp
The minion log can be sent to a regular file, local path name, or network
location.  See also \fI\%log_file\fP\&.
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_file: /var/log/salt/minion
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_file: file:///dev/log
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_file: udp://loghost:10514
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_level\fP
.sp
Default: \fBwarning\fP
.sp
The level of messages to send to the console. See also \fI\%log_level\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_level: warning
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Any log level below the \fIinfo\fP level is INSECURE and may log sensitive data. This currently includes:
#. profile
#. debug
#. trace
#. garbage
#. all
.SS \fBlog_level_logfile\fP
.sp
Default: \fBwarning\fP
.sp
The level of messages to send to the log file. See also
\fI\%log_level_logfile\fP\&. When it is not set explicitly
it will inherit the level set by \fI\%log_level\fP option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_level_logfile: warning
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Any log level below the \fIinfo\fP level is INSECURE and may log sensitive data. This currently includes:
#. profile
#. debug
#. trace
#. garbage
#. all
.SS \fBlog_datefmt\fP
.sp
Default: \fB%H:%M:%S\fP
.sp
The date and time format used in console log messages. See also
\fI\%log_datefmt\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_datefmt: \(aq%H:%M:%S\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_datefmt_logfile\fP
.sp
Default: \fB%Y\-%m\-%d %H:%M:%S\fP
.sp
The date and time format used in log file messages. See also
\fI\%log_datefmt_logfile\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_datefmt_logfile: \(aq%Y\-%m\-%d %H:%M:%S\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_fmt_console\fP
.sp
Default: \fB[%(levelname)\-8s] %(message)s\fP
.sp
The format of the console logging messages. See also
\fI\%log_fmt_console\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Log colors are enabled in \fBlog_fmt_console\fP rather than the
\fI\%color\fP config since the logging system is loaded before the
minion config.
.sp
Console log colors are specified by these additional formatters:
.sp
%(colorlevel)s
%(colorname)s
%(colorprocess)s
%(colormsg)s
.sp
Since it is desirable to include the surrounding brackets, \(aq[\(aq and \(aq]\(aq, in
the coloring of the messages, these color formatters also include padding
as well.  Color LogRecord attributes are only available for console
logging.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_fmt_console: \(aq%(colorlevel)s %(colormsg)s\(aq
log_fmt_console: \(aq[%(levelname)\-8s] %(message)s\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_fmt_logfile\fP
.sp
Default: \fB%(asctime)s,%(msecs)03d [%(name)\-17s][%(levelname)\-8s] %(message)s\fP
.sp
The format of the log file logging messages. See also
\fI\%log_fmt_logfile\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_fmt_logfile: \(aq%(asctime)s,%(msecs)03d [%(name)\-17s][%(levelname)\-8s] %(message)s\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_granular_levels\fP
.sp
Default: \fB{}\fP
.sp
This can be used to control logging levels more specifically. See also
\fI\%log_granular_levels\fP\&.
.SS \fBlog_rotate_max_bytes\fP
.sp
Default:  \fB0\fP
.sp
The maximum number of bytes a single log file may contain before it is rotated.
A value of 0 disables this feature. Currently only supported on Windows. On
other platforms, use an external tool such as \(aqlogrotate\(aq to manage log files.
\fBlog_rotate_max_bytes\fP
.SS \fBlog_rotate_backup_count\fP
.sp
Default:  \fB0\fP
.sp
The number of backup files to keep when rotating log files. Only used if
\fI\%log_rotate_max_bytes\fP is greater than 0. Currently only supported
on Windows. On other platforms, use an external tool such as \(aqlogrotate\(aq to
manage log files.
\fBlog_rotate_backup_count\fP
.SS \fBzmq_monitor\fP
.sp
Default: \fBFalse\fP
.sp
To diagnose issues with minions disconnecting or missing returns, ZeroMQ
supports the use of monitor sockets to log connection events. This
feature requires ZeroMQ 4.0 or higher.
.sp
To enable ZeroMQ monitor sockets, set \(aqzmq_monitor\(aq to \(aqTrue\(aq and log at a
debug level or higher.
.sp
A sample log event is as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[DEBUG   ] ZeroMQ event: {\(aqendpoint\(aq: \(aqtcp://127.0.0.1:4505\(aq, \(aqevent\(aq: 512,
\(aqvalue\(aq: 27, \(aqdescription\(aq: \(aqEVENT_DISCONNECTED\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
All events logged will include the string \fBZeroMQ event\fP\&. A connection event
should be logged as the minion starts up and initially connects to the
master. If not, check for debug log level and that the necessary version of
ZeroMQ is installed.
.SS \fBtcp_authentication_retries\fP
.sp
Default: \fB5\fP
.sp
The number of times to retry authenticating with the salt master when it comes
back online.
.sp
Zeromq does a lot to make sure when connections come back online that they
reauthenticate. The tcp transport should try to connect with a new connection
if the old one times out on reauthenticating.
.sp
\fI\-1\fP for infinite tries.
.SS \fBtcp_reconnect_backoff\fP
.sp
Default: \fB1\fP
.sp
The time in seconds to wait before attempting another connection with salt master
when the previous connection fails while on TCP transport.
.SS \fBfailhard\fP
.sp
Default: \fBFalse\fP
.sp
Set the global failhard flag. This informs all states to stop running states
at the moment a single state fails
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
failhard: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Include Configuration
.sp
Configuration can be loaded from multiple files. The order in which this is
done is:
.INDENT 0.0
.IP 1. 3
The minion config file itself
.IP 2. 3
The files matching the glob in \fI\%default_include\fP
.IP 3. 3
The files matching the glob in \fI\%include\fP (if defined)
.UNINDENT
.sp
Each successive step overrides any values defined in the previous steps.
Therefore, any config options defined in one of the
\fI\%default_include\fP files would override the same value in the
minion config file, and any options defined in \fI\%include\fP would
override both.
.SS \fBdefault_include\fP
.sp
Default: \fBminion.d/*.conf\fP
.sp
The minion can include configuration from other files. Per default the
minion will automatically include all config files from \fIminion.d/*.conf\fP
where minion.d is relative to the directory of the minion configuration
file.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Salt creates files in the \fBminion.d\fP directory for its own use. These
files are prefixed with an underscore. A common example of this is the
\fB_schedule.conf\fP file.
.UNINDENT
.UNINDENT
.SS \fBinclude\fP
.sp
Default: \fBnot defined\fP
.sp
The minion can include configuration from other files. To enable this,
pass a list of paths to this option. The paths can be either relative or
absolute; if relative, they are considered to be relative to the directory
the main minion configuration file lives in. Paths can make use of
shell\-style globbing. If no files are matched by a path passed to this
option then the minion will log a warning message.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Include files from a minion.d directory in the same
# directory as the minion config file
include: minion.d/*.conf

# Include a single extra file into the configuration
include: /etc/roles/webserver

# Include several files and the minion.d directory
include:
  \- extra_config
  \- minion.d/*
  \- /etc/roles/webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Keepalive Settings
.SS \fBtcp_keepalive\fP
.sp
Default: \fBTrue\fP
.sp
The tcp keepalive interval to set on TCP ports. This setting can be used to tune Salt
connectivity issues in messy network environments with misbehaving firewalls.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tcp_keepalive: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtcp_keepalive_cnt\fP
.sp
Default: \fB\-1\fP
.sp
Sets the ZeroMQ TCP keepalive count. May be used to tune issues with minion disconnects.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tcp_keepalive_cnt: \-1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtcp_keepalive_idle\fP
.sp
Default: \fB300\fP
.sp
Sets ZeroMQ TCP keepalive idle. May be used to tune issues with minion disconnects.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tcp_keepalive_idle: 300
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtcp_keepalive_intvl\fP
.sp
Default: \fB\-1\fP
.sp
Sets ZeroMQ TCP keepalive interval. May be used to tune issues with minion disconnects.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tcp_keepalive_intvl\(aq: \-1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Frozen Build Update Settings
.sp
These options control how \fI\%salt.modules.saltutil.update()\fP works with esky
frozen apps. For more information look at \fI\%https://github.com/cloudmatrix/esky/\fP\&.
.SS \fBupdate_url\fP
.sp
Default: \fBFalse\fP (Update feature is disabled)
.sp
The url to use when looking for application updates. Esky depends on directory
listings to search for new versions. A webserver running on your Master is a
good starting point for most setups.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
update_url: \(aqhttp://salt.example.com/minion\-updates\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBupdate_restart_services\fP
.sp
Default: \fB[]\fP (service restarting on update is disabled)
.sp
A list of services to restart when the minion software is updated. This would
typically just be a list containing the minion\(aqs service name, but you may
have other services that need to go with it.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
update_restart_services: [\(aqsalt\-minion\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Windows Software Repo Settings
.sp
These settings apply to all minions, whether running in masterless or
master\-minion mode.
.SS \fBwinrepo_cache_expire_min\fP
.sp
New in version 2016.11.0.

.sp
Default: \fB1800\fP
.sp
If set to a nonzero integer, then passing \fBrefresh=True\fP to functions in the
\fI\%windows pkg module\fP will not refresh the windows
repo metadata if the age of the metadata is less than this value. The exception
to this is \fI\%pkg.refresh_db\fP, which
will always refresh the metadata, regardless of age.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_cache_expire_min: 1800
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_cache_expire_max\fP
.sp
New in version 2016.11.0.

.sp
Default: \fB21600\fP
.sp
If the windows repo metadata is older than this value, and the metadata is
needed by a function in the \fI\%windows pkg module\fP,
the metadata will be refreshed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_cache_expire_max: 86400
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_source_dir\fP
.sp
Default: \fBsalt://win/repo\-ng/\fP
.sp
The source location for the winrepo sls files.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_source_dir: salt://win/repo\-ng/
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Standalone Minion Windows Software Repo Settings
.sp
The following settings are for configuring the Windows Software Repository
(winrepo) on a masterless minion. To run in masterless minion mode, set the
\fI\%file_client\fP to \fBlocal\fP or run \fBsalt\-call\fP with the
\fB\-\-local\fP option
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
These config options are only valid for minions running in masterless mode
.UNINDENT
.UNINDENT
.SS \fBwinrepo_dir\fP
.sp
Changed in version 2015.8.0: Renamed from \fBwin_repo\fP to \fBwinrepo_dir\fP\&. This option did not have a
default value until this version.

.sp
Default: \fBC:\esalt\esrv\esalt\ewin\erepo\fP
.sp
Location on the minion \fI\%file_roots\fP where winrepo files are kept.
This is also where the \fI\%winrepo_remotes\fP are cloned to by
\fBwinrepo.update_git_repos\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_dir: \(aqD:\ewinrepo\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_dir_ng\fP
.sp
New in version 2015.8.0: A new \fI\%ng\fP repo was added.

.sp
Default: \fBC:\esalt\esrv\esalt\ewin\erepo\-ng\fP
.sp
Location on the minion \fI\%file_roots\fP where winrepo files are kept
for 2018.8.0 and later minions. This is also where the
\fI\%winrepo_remotes\fP are cloned to by \fBwinrepo.update_git_repos\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_dir_ng: /srv/salt/win/repo\-ng
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_cachefile\fP
.sp
Changed in version 2015.8.0: Renamed from \fBwin_repo_cachefile\fP to \fBwinrepo_cachefile\fP\&. Also,
this option did not have a default value until this version.

.sp
Default: \fBwinrepo.p\fP
.sp
The name of the winrepo cache file. The file will be created at root of
the directory specified by \fI\%winrepo_dir_ng\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_cachefile: winrepo.p
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwinrepo_remotes\fP
.sp
Changed in version 2015.8.0: Renamed from \fBwin_gitrepos\fP to \fBwinrepo_remotes\fP\&. Also, this option did
not have a default value until this version.

.sp
New in version 2015.8.0.

.sp
Default: \fB[\(aqhttps://github.com/saltstack/salt\-winrepo.git\(aq]\fP
.sp
List of git repositories to checkout and include in the winrepo
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_remotes:
  \- https://github.com/saltstack/salt\-winrepo.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To specify a specific revision of the repository, prepend a commit ID to the
URL of the repository:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_remotes:
  \- \(aq<commit_id> https://github.com/saltstack/salt\-winrepo.git\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Replace \fB<commit_id>\fP with the SHA1 hash of a commit ID. Specifying a commit
ID is useful in that it allows one to revert back to a previous version in the
event that an error is introduced in the latest revision of the repo.
.SS \fBwinrepo_remotes_ng\fP
.sp
New in version 2015.8.0: A new \fI\%ng\fP repo was added.

.sp
Default: \fB[\(aqhttps://github.com/saltstack/salt\-winrepo\-ng.git\(aq]\fP
.sp
List of git repositories to checkout and include in the winrepo for
2015.8.0 and later minions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_remotes_ng:
  \- https://github.com/saltstack/salt\-winrepo\-ng.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To specify a specific revision of the repository, prepend a commit ID to the
URL of the repository:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_remotes_ng:
  \- \(aq<commit_id> https://github.com/saltstack/salt\-winrepo\-ng.git\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Replace \fB<commit_id>\fP with the SHA1 hash of a commit ID. Specifying a commit
ID is useful in that it allows one to revert back to a previous version in the
event that an error is introduced in the latest revision of the repo.
.SS Configuring the Salt Proxy Minion
.sp
The Salt system is amazingly simple and easy to configure. The two components
of the Salt system each have a respective configuration file. The
\fBsalt\-master\fP is configured via the master configuration file, and the
\fBsalt\-proxy\fP is configured via the proxy configuration file.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%example proxy minion configuration file\fP
.UNINDENT
.UNINDENT
.sp
The Salt Minion configuration is very simple. Typically, the only value that
needs to be set is the master value so the proxy knows where to locate its master.
.sp
By default, the salt\-proxy configuration will be in \fB/etc/salt/proxy\fP\&.
A notable exception is FreeBSD, where the configuration will be in
\fB/usr/local/etc/salt/proxy\fP\&.
.sp
With the Salt 3004 release, the ability to configure proxy minions using the delta proxy
was introduced.  The delta proxy provides the ability for a single control proxy
minion to manage multiple proxy minions.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Installing and Using Deltaproxy\fP
.UNINDENT
.UNINDENT
.SS Proxy\-specific Configuration Options
.SS \fBadd_proxymodule_to_opts\fP
.sp
New in version 2015.8.2.

.sp
Changed in version 2016.3.0.

.sp
Default: \fBFalse\fP
.sp
Add the proxymodule LazyLoader object to opts.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
add_proxymodule_to_opts: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBproxy_merge_grains_in_module\fP
.sp
New in version 2016.3.0.

.sp
Changed in version 2017.7.0.

.sp
Default: \fBTrue\fP
.sp
If a proxymodule has a function called \fBgrains\fP, then call it during
regular grains loading and merge the results with the proxy\(aqs grains
dictionary.  Otherwise it is assumed that the module calls the grains
function in a custom way and returns the data elsewhere.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy_merge_grains_in_module: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBproxy_keep_alive\fP
.sp
New in version 2017.7.0.

.sp
Default: \fBTrue\fP
.sp
Whether the connection with the remote device should be restarted
when dead. The proxy module must implement the \fBalive\fP function,
otherwise the connection is considered alive.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy_keep_alive: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBproxy_keep_alive_interval\fP
.sp
New in version 2017.7.0.

.sp
Default: \fB1\fP
.sp
The frequency of keepalive checks, in minutes. It requires the
\fI\%proxy_keep_alive\fP option to be enabled
(and the proxy module to implement the \fBalive\fP function).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy_keep_alive_interval: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBproxy_always_alive\fP
.sp
New in version 2017.7.0.

.sp
Default: \fBTrue\fP
.sp
Whether the proxy should maintain the connection with the remote
device. Similarly to \fI\%proxy_keep_alive\fP, this option
is very specific to the design of the proxy module.
When \fI\%proxy_always_alive\fP is set to \fBFalse\fP,
the connection with the remote device is not maintained and
has to be closed after every command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy_always_alive: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBproxy_merge_pillar_in_opts\fP
.sp
New in version 2017.7.3.

.sp
Default: \fBFalse\fP\&.
.sp
Whether the pillar data to be merged into the proxy configuration options.
As multiple proxies can run on the same server, we may need different
configuration options for each, while there\(aqs one single configuration file.
The solution is merging the pillar data of each proxy minion into the opts.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy_merge_pillar_in_opts: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBproxy_deep_merge_pillar_in_opts\fP
.sp
New in version 2017.7.3.

.sp
Default: \fBFalse\fP\&.
.sp
Deep merge of pillar data into configuration opts.
This option is evaluated only when \fBproxy_merge_pillar_in_opts\fP is
enabled.
.SS \fBproxy_merge_pillar_in_opts_strategy\fP
.sp
New in version 2017.7.3.

.sp
Default: \fBsmart\fP\&.
.sp
The strategy used when merging pillar configuration into opts.
This option is evaluated only when \fBproxy_merge_pillar_in_opts\fP is
enabled.
.SS \fBproxy_mines_pillar\fP
.sp
New in version 2017.7.3.

.sp
Default: \fBTrue\fP\&.
.sp
Allow enabling mine details using pillar data. This evaluates the mine
configuration under the pillar, for the following regular minion options that
are also equally available on the proxy minion: \fI\%mine_interval\fP,
and \fBmine_functions\fP\&.
.SS Delta proxy minions
.sp
Welcome to the delta proxy minion installation guide. This installation
guide explains the process for installing and using delta proxy minion
which is available beginning in version 3004.
.sp
This guide is intended for system and network administrators with the general
knowledge and experience required in the field. This guide is also intended for
users that have ideally already tested and used standard Salt proxy minions in
their environment before deciding to move to a delta proxy minion environment.
See \fI\%Salt proxy minions\fP for more information.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you have not used standard Salt proxy minions before, consider testing
and deploying standard Salt proxy minions in your environment first.
.UNINDENT
.UNINDENT
.SS Proxy minions vs. delta proxy minions
.sp
Salt can target network devices through \fI\%Salt proxy minions\fP,
Proxy minions allow you to control network devices that, for whatever reason,
cannot run the standard Salt minion. Examples include:
.INDENT 0.0
.IP \(bu 2
Network gear that has an API but runs a proprietary operating system
.IP \(bu 2
Devices with limited CPU or memory
.IP \(bu 2
Devices that could run a minion but will not for security reasons
.UNINDENT
.sp
A proxy minion acts as an intermediary between the Salt master and the
device it represents. The proxy minion runs on the Salt master and then
translates commands from the Salt master to the device as needed.
.sp
By acting as an intermediary for the actual minion, proxy minions eliminate
the need to establish a constant connection from a Salt master to a minion. Proxy
minions generally only open a connection to the actual minion when necessary.
.sp
Proxy minions also reduce the amount of CPU or memory the minion must spend
checking for commands from the Salt master. Proxy minions use the Salt master\(aqs CPU
or memory to check for commands. The actual minion only needs to use CPU or
memory to run commands when needed.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For more information about Salt proxy minions, see:
.INDENT 0.0
.IP \(bu 2
\fI\%Salt proxy minions\fP
.IP \(bu 2
\fI\%Salt proxy modules\fP
.UNINDENT
.UNINDENT
.UNINDENT
.SS When delta proxy minions are needed
.sp
Normally, you would create a separate instance of proxy minion for each device
that needs to be managed. However, this doesn\(aqt always scale well if you have
thousands of devices. Running several thousand proxy minions can require a lot
of memory and CPU.
.sp
A delta proxy minion can solve this problem: it makes it possible to run one
minion that acts as the intermediary between the Salt master and the many network
devices it can represent. In this scenario, one device (the delta proxy minion
on the Salt master) runs several proxies. This configuration boosts performance and
improves the overall scalability of the network.
.SS Key terms
.sp
The following lists some important terminology that is used throughout this
guide:
.TS
center;
|l|l|.
_
T{
Term
T}	T{
Definition
T}
_
T{
Salt master
T}	T{
The Salt master is a central node running the Salt master server.
The Salt master issues commands to minions.
T}
_
T{
minion
T}	T{
Minions are nodes running the Salt minion service. Minions listen
to commands from a Salt master and perform the requested tasks, then return
data back to the Salt master as needed.
T}
_
T{
proxy minion
T}	T{
A Salt master that is running the proxy\-minion service. The proxy minion
acts as an intermediary between the Salt master and the device it represents.
The proxy minion runs on the Salt master and then translates commands from
the Salt master to the device. A separate instance of proxy minion is
needed for each device that is managed.
T}
_
T{
delta proxy minion
T}	T{
A Salt master that is running the delta proxy\-minion service. The
delta proxy minion acts as the intermediary between the Salt master and the
many network devices it can represent. Only one instance of the delta
proxy service is needed to run several proxies.
T}
_
T{
control proxy
T}	T{
The control proxy runs on the Salt master. It manages a list of devices and
issues commands to the network devices it represents. The Salt master needs
at least one control proxy, but it is possible to have more than one
control proxy, each managing a different set of devices.
T}
_
T{
managed device
T}	T{
A device (such as Netmiko) that is managed by proxy minions or by a
control proxy minion. The proxy minion or control proxy only creates
a connection to the actual minion it needs to issue a command.
T}
_
T{
pillar file
T}	T{
Pillars are structures of data (files) defined on the Salt master and passed
through to one or more minions when the minion needs access to the
pillar file. Pillars allow confidential, targeted data to be securely sent
only to the relevant minion. Because all configurations for
delta proxy minions are done on the Salt master (not on the minions), you
use pillar files to configure the delta proxy\-minion service.
T}
_
T{
top file
T}	T{
The top file is a pillar file that maps which states should be applied to
different minions in certain environments.
T}
_
.TE
.SS Pre\-installation
.SS Before you start
.sp
Before installing the delta proxy minion, ensure that:
.INDENT 0.0
.IP \(bu 2
Your network device and firmware are supported.
.IP \(bu 2
The Salt master that is acting as the control proxy minion has network
access to the devices it is managing.
.IP \(bu 2
You have installed, configured, and tested standard Salt proxy minions in
your environment before introducing delta proxy minions into your
environment.
.UNINDENT
.SS Install or upgrade Salt
.sp
Ensure your Salt masters are running at least Salt version 3004. For instructions
on installing or upgrading Salt, see \fI\%repo.saltproject.io\fP\&. For RedHat systems, see \fI\%Install or Upgrade Salt\fP\&.
.SS Installation
.sp
Before you begin the delta proxy minion installation process, ensure you
have read and completed the \fI\%Pre\-installation\fP steps.
.SS Overview of the installation process
.sp
Similar to proxy minions, all the delta proxy minion configurations are done
on the Salt master rather than on the minions that will be managed. The
installation process has the following phases:
.INDENT 0.0
.IP 1. 3
\fI\%Configure the master to use delta proxy\fP \- Create a
configuration file on the Salt master that defines its proxy settings.
.IP 2. 3
\fI\%Create a pillar file for each managed device\fP \- Create a
pillar file for each device that will be managed by the delta proxy minion
and reference these minions in the top file.
.IP 3. 3
\fI\%Create a control proxy configuration file\fP \- Create a control proxy file
that lists the devices that it will manage. Then, reference this file in the
top file.
.IP 4. 3
\fI\%Start the delta proxy minion\fP \- Start the delta proxy\-minion service and
validate that it has been set up correctly.
.UNINDENT
.SS Configure the master to use delta proxy
.sp
In this step, you\(aqll create a configuration file on the Salt master that defines
its proxy settings. This is a general configuration file that tells the Salt master
how to handle all proxy minions.
.sp
To create this configuration:
.INDENT 0.0
.IP 1. 3
On the Salt master, navigate to the \fB/etc/salt\fP directory. In this directory,
create a file named \fBproxy\fP if one doesn\(aqt already exist.
.IP 2. 3
Open the file in your preferred editor and add the following configuration
information:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
# Use delta proxy metaproxy
metaproxy: deltaproxy

# Disable the FQDNS grain
enable_fqdns_grains: False

# Enabled multprocessing
multiprocessing: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
See the following section about \fI\%delta proxy configuration options\fP for
a more detailed description of these configuration options.
.UNINDENT
.UNINDENT
.IP 3. 3
Save the file.
.UNINDENT
.sp
Your Salt master is now configured to use delta proxy. Next, you need to
\fI\%Create a pillar file for each managed device\fP\&.
.SS Delta proxy configuration options
.sp
The following table describes the configuration options used in the delta
proxy configuration file:
.TS
center;
|l|l|.
_
T{
Field
T}	T{
Description
T}
_
T{
metaproxy
T}	T{
Set this configuration option to \fBdeltaproxy\fP\&. If this option is set to
\fBproxy\fP or if this line is not included in the file, the Salt master will
use the standard proxy service instead of the delta proxy service.
T}
_
T{
enable_fqdns_grains
T}	T{
If your router does not have the ability to use Reverse DNS lookup to
obtain the Fully Qualified Domain Name (fqdn) for an IP address, you\(aqll
need to change the \fBenable_fqdns_grains\fP setting in the pillar
configuration file to \fBFalse\fP instead.
T}
_
T{
multiprocessing
T}	T{
Multi\-processing is the ability to run more than one task or process at
the same time. A delta proxy minion has the ability to run with
multi\-processing turned off.
.sp
If you plan to run with multi\-processing enabled, you should also enable
the \fBskip_connect_on_init\fP setting to \fBTrue\fP\&.
T}
_
T{
skip_connect_on_init
T}	T{
This setting tells the control proxy whether or not it should make a
connection to the managed device when it starts. When set to \fBTrue\fP, the
delta proxy minion will only connect when it needs to issue commands to
the managed devices.
T}
_
.TE
.SS Create a pillar file for each managed device
.sp
Each device that needs to be managed by delta proxy needs a separate pillar
file on the Salt master. To create this file:
.INDENT 0.0
.IP 1. 3
Navigate to the \fB/srv/pillar\fP directory.
.IP 2. 3
In this directory create a new pillar file for a minion. For example,
\fBmy_managed_device_pillar_file_01.sls\fP\&.
.IP 3. 3
Open the new file in your preferred editor and add the necessary
configuration information for that minion and your environment. The
following is an example pillar file for a Netmiko device:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: netmiko
  device_type: arista_eos
  host: 192.0.2.1
  username: myusername
  password: mypassword
  always_alive: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
The available configuration options vary depending on the proxy type (in
other words, the type of device it is). To read a detailed explanation of
the configuration options, refer to the proxy module documentation for
the type of device you need to manage. See:
.INDENT 0.0
.IP \(bu 2
\fI\%Salt proxy modules\fP
.IP \(bu 2
\fI\%Netmiko Salt proxy module\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP 4. 3
Save the file.
.IP 5. 3
In an editor, open the top file: \fB/srv/pillar/top.sls\fP\&.
.IP 6. 3
Add a section to the top file that indicates the minion ID of the device
that will be managed. Then, list the name of the pillar file you created in
the previous steps. For example:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
my_managed_device_minion_ID:
  \- my_managed_device_pillar_file_01
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 7. 3
Repeat the previous steps for each minion that needs to be managed.
.UNINDENT
.sp
You\(aqve now created the pillar file for the minions that will be managed by the
delta proxy minion and you have referenced these files in the top file.
Proceed to the next section.
.SS Create a control proxy configuration file
.sp
On the Salt master, you\(aqll need to create or edit a control proxy file for each
control proxy. The control proxy manages several devices and issues commands to
the network devices it represents. The Salt master needs at least one control
proxy, but it is possible to have more than one control proxy, each managing a
different set of devices.
.sp
To configure a control proxy, you\(aqll create a file that lists the minion IDs
of the minions that it will manage. Then you will reference this control proxy
configuration file in the top file.
.sp
To create a control proxy configuration file:
.INDENT 0.0
.IP 1. 3
On the Salt master, navigate to the \fB/srv/pillar\fP directory. In this
directory, create a new proxy configuration file. Give this file a
descriptive name, such as \fBcontrol_proxy_01_configuration.sls\fP\&.
.IP 2. 3
Open the file in your preferred editor and add a list of the minion IDs for
each device that needs to be managed. For example:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: deltaproxy
  ids:
    \- my_managed_device_01
    \- my_managed_device_02
    \- my_managed_device_03
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
Save the file.
.IP 4. 3
In an editor, open the top file: \fB/srv/pillar/top.sls\fP\&.
.IP 5. 3
Add a section to the top file that indicates references the delta proxy
control proxy. For example:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  my_managed_device_minion_01:
    \- my_managed_device_pillar_file_01
  my_managed_device_minion_02:
    \- my_managed_device_pillar_file_02
  my_managed_device_minion_03:
    \- my_managed_device_pillar_file_03
  delta_proxy_control:
    \- control_proxy_01_configuration
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 6. 3
Repeat the previous steps for each control proxy if needed.
.IP 7. 3
In an editor, open the proxy config file: \fB/etc/salt/proxy\fP\&.
Add a section for metaproxy and set it\(aqs value to deltaproxy.
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
metaproxy: deltaproxy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Now that you have created the necessary configurations, proceed to the next
section.
.SS Start the delta proxy minion
.sp
After you\(aqve successfully configured the delta proxy minion, you need to
start the proxy minion service for each managed device and validate that it is
working correctly.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This step explains the process for starting a single instance of a
delta proxy minion. Because starting each minion individually can
potentially be very time\-consuming, most organizations use a script to start
their delta proxy minions since there are typically many devices being
managed. Consider implementing a similar script for your environment to save
time in deployment.
.UNINDENT
.UNINDENT
.sp
To start a single instance of a delta proxy minion and test that it is
configured correctly:
.INDENT 0.0
.IP 1. 3
In the terminal for the Salt master, run the following command, replacing the
placeholder text with the actual minion ID:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
sudo salt\-proxy \-\-proxyid=<control_proxy_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
To test the delta proxy minion, run the following \fBtest.version\fP command
on the Salt master and target a specific minion. For example:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
salt my_managed_device_minion_ID test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This command returns an output similar to the following:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
local:
    3004
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
After you\(aqve successfully started the delta proxy minions and verified that
they are working correctly, you can now use these minions the same as standard
proxy minions.
.SS Additional resources
.sp
This reference section includes additional resources for delta proxy minions.
.sp
For reference, see:
.INDENT 0.0
.IP \(bu 2
\fI\%Salt proxy minions\fP
.IP \(bu 2
\fI\%Salt proxy modules\fP
.IP \(bu 2
\fI\%Netmiko Salt proxy module\fP
.UNINDENT
.SS Configuration file examples
.INDENT 0.0
.IP \(bu 2
\fI\%Example master configuration file\fP
.IP \(bu 2
\fI\%Example minion configuration file\fP
.IP \(bu 2
\fI\%Example proxy minion configuration file\fP
.UNINDENT
.SS Example master configuration file
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
##### Primary configuration settings #####
##########################################
# This configuration file is used to manage the behavior of the Salt Master.
# Values that are commented out but have an empty line after the comment are
# defaults that do not need to be set in the config. If there is no blank line
# after the comment then the value is presented as an example and is not the
# default.

# Per default, the master will automatically include all config files
# from master.d/*.conf (master.d is a directory in the same directory
# as the main master config file).
#default_include: master.d/*.conf

# The address of the interface to bind to:
#interface: 0.0.0.0

# Whether the master should listen for IPv6 connections. If this is set to True,
# the interface option must be adjusted, too. (For example: \(dqinterface: \(aq::\(aq\(dq)
#ipv6: False

# The tcp port used by the publisher:
#publish_port: 4505

# The user under which the salt master will run. Salt will update all
# permissions to allow the specified user to run the master. The exception is
# the job cache, which must be deleted if this user is changed. If the
# modified files cause conflicts, set verify_env to False.
#user: root

# Tell the master to also use salt\-ssh when running commands against minions.
#enable_ssh_minions: False

# The port used by the communication interface. The ret (return) port is the
# interface used for the file server, authentication, job returns, etc.
#ret_port: 4506

# Specify the location of the daemon process ID file:
#pidfile: /var/run/salt\-master.pid

# The root directory prepended to these options: pki_dir, cachedir,
# sock_dir, log_file, autosign_file, autoreject_file, extension_modules,
# key_logfile, pidfile, autosign_grains_dir:
#root_dir: /

# The path to the master\(aqs configuration file.
#conf_file: /etc/salt/master

# Directory used to store public key data:
#pki_dir: /etc/salt/pki/master

# Key cache. Increases master speed for large numbers of accepted
# keys. Available options: \(aqsched\(aq. (Updates on a fixed schedule.)
# Note that enabling this feature means that minions will not be
# available to target for up to the length of the maintenance loop
# which by default is 60s.
#key_cache: \(aq\(aq

# Directory to store job and cache data:
# This directory may contain sensitive data and should be protected accordingly.
#
#cachedir: /var/cache/salt/master

# Directory where custom modules sync to. This directory can contain
# subdirectories for each of Salt\(aqs module types such as \(dqrunners\(dq,
# \(dqoutput\(dq, \(dqwheel\(dq, \(dqmodules\(dq, \(dqstates\(dq, \(dqreturners\(dq, \(dqengines\(dq,
# \(dqutils\(dq, etc.
#
# Note, any directories or files not found in the \(gamodule_dirs\(ga
# location will be removed from the extension_modules path.

#extension_modules: /var/cache/salt/master/extmods

# Directory for custom modules. This directory can contain subdirectories for
# each of Salt\(aqs module types such as \(dqrunners\(dq, \(dqoutput\(dq, \(dqwheel\(dq, \(dqmodules\(dq,
# \(dqstates\(dq, \(dqreturners\(dq, \(dqengines\(dq, \(dqutils\(dq, etc.
#module_dirs: []

# Verify and set permissions on configuration directories at startup:
#verify_env: True

# Set the number of hours to keep old job information in the job cache.
# This option is deprecated by the keep_jobs_seconds option.
#keep_jobs: 24

# Set the number of seconds to keep old job information in the job cache:
#keep_jobs_seconds: 86400

# The number of seconds to wait when the client is requesting information
# about running jobs.
#gather_job_timeout: 10

# Set the default timeout for the salt command and api. The default is 5
# seconds.
#timeout: 5

# The loop_interval option controls the seconds for the master\(aqs maintenance
# process check cycle. This process updates file server backends, cleans the
# job cache and executes the scheduler.
#loop_interval: 60

# Set the default outputter used by the salt command. The default is \(dqnested\(dq.
#output: nested

# To set a list of additional directories to search for salt outputters, set the
# outputter_dirs option.
#outputter_dirs: []

# Set the default output file used by the salt command. Default is to output
# to the CLI and not to a file. Functions the same way as the \(dq\-\-out\-file\(dq
# CLI option, only sets this to a single file for all salt commands.
#output_file: None

# Return minions that timeout when running commands like test.ping
#show_timeout: True

# Tell the client to display the jid when a job is published.
#show_jid: False

# By default, output is colored. To disable colored output, set the color value
# to False.
#color: True

# Do not strip off the colored output from nested results and state outputs
# (true by default).
# strip_colors: False

# To display a summary of the number of minions targeted, the number of
# minions returned, and the number of minions that did not return, set the
# cli_summary value to True. (False by default.)
#
#cli_summary: False

# Set the directory used to hold unix sockets:
#sock_dir: /var/run/salt/master

# The master can take a while to start up when lspci and/or dmidecode is used
# to populate the grains for the master. Enable if you want to see GPU hardware
# data for your master.
# enable_gpu_grains: False

# The master maintains a job cache. While this is a great addition, it can be
# a burden on the master for larger deployments (over 5000 minions).
# Disabling the job cache will make previously executed jobs unavailable to
# the jobs system and is not generally recommended.
#job_cache: True

# Cache minion grains, pillar and mine data via the cache subsystem in the
# cachedir or a database.
#minion_data_cache: True

# Cache subsystem module to use for minion data cache.
#cache: localfs
# Enables a fast in\-memory cache booster and sets the expiration time.
#memcache_expire_seconds: 0
# Set a memcache limit in items (bank + key) per cache storage (driver + driver_opts).
#memcache_max_items: 1024
# Each time a cache storage got full cleanup all the expired items not just the oldest one.
#memcache_full_cleanup: False
# Enable collecting the memcache stats and log it on \(gadebug\(ga log level.
#memcache_debug: False

# Store all returns in the given returner.
# Setting this option requires that any returner\-specific configuration also
# be set. See various returners in salt/returners for details on required
# configuration values. (See also, event_return_queue, and event_return_queue_max_seconds below.)
#
#event_return: mysql

# On busy systems, enabling event_returns can cause a considerable load on
# the storage system for returners. Events can be queued on the master and
# stored in a batched fashion using a single transaction for multiple events.
# By default, events are not queued.
#event_return_queue: 0

# In some cases enabling event return queueing can be very helpful, but the bus
# may not busy enough to flush the queue consistently.  Setting this to a reasonable
# value (1\-30 seconds) will cause the queue to be flushed when the oldest event is older
# than \(gaevent_return_queue_max_seconds\(ga regardless of how many events are in the queue.
#event_return_queue_max_seconds: 0

# Only return events matching tags in a whitelist, supports glob matches.
#event_return_whitelist:
#  \- salt/master/a_tag
#  \- salt/run/*/ret

# Store all event returns **except** the tags in a blacklist, supports globs.
#event_return_blacklist:
#  \- salt/master/not_this_tag
#  \- salt/wheel/*/ret

# Passing very large events can cause the minion to consume large amounts of
# memory. This value tunes the maximum size of a message allowed onto the
# master event bus. The value is expressed in bytes.
#max_event_size: 1048576

# Windows platforms lack posix IPC and must rely on slower TCP based inter\-
# process communications. Set ipc_mode to \(aqtcp\(aq on such systems
#ipc_mode: ipc

# Overwrite the default tcp ports used by the minion when ipc_mode is set to \(aqtcp\(aq
#tcp_master_pub_port: 4510
#tcp_master_pull_port: 4511

# By default, the master AES key rotates every 24 hours. The next command
# following a key rotation will trigger a key refresh from the minion which may
# result in minions which do not respond to the first command after a key refresh.
#
# To tell the master to ping all minions immediately after an AES key refresh, set
# ping_on_rotate to True. This should mitigate the issue where a minion does not
# appear to initially respond after a key is rotated.
#
# Note that ping_on_rotate may cause high load on the master immediately after
# the key rotation event as minions reconnect. Consider this carefully if this
# salt master is managing a large number of minions.
#
# If disabled, it is recommended to handle this event by listening for the
# \(aqaes_key_rotate\(aq event with the \(aqkey\(aq tag and acting appropriately.
# ping_on_rotate: False

# By default, the master deletes its cache of minion data when the key for that
# minion is removed. To preserve the cache after key deletion, set
# \(aqpreserve_minion_cache\(aq to True.
#
# WARNING: This may have security implications if compromised minions auth with
# a previous deleted minion ID.
#preserve_minion_cache: False

# Allow or deny minions from requesting their own key revocation
#allow_minion_key_revoke: True

# If max_minions is used in large installations, the master might experience
# high\-load situations because of having to check the number of connected
# minions for every authentication. This cache provides the minion\-ids of
# all connected minions to all MWorker\-processes and greatly improves the
# performance of max_minions.
# con_cache: False

# The master can include configuration from other files. To enable this,
# pass a list of paths to this option. The paths can be either relative or
# absolute; if relative, they are considered to be relative to the directory
# the main master configuration file lives in (this file). Paths can make use
# of shell\-style globbing. If no files are matched by a path passed to this
# option, then the master will log a warning message.
#
# Include a config file from some other path:
# include: /etc/salt/extra_config
#
# Include config from several files and directories:
# include:
#   \- /etc/salt/extra_config


#####  Large\-scale tuning settings   #####
##########################################
# Max open files
#
# Each minion connecting to the master uses AT LEAST one file descriptor, the
# master subscription connection. If enough minions connect you might start
# seeing on the console (and then salt\-master crashes):
#   Too many open files (tcp_listener.cpp:335)
#   Aborted (core dumped)
#
# By default this value will be the one of \(gaulimit \-Hn\(ga, ie, the hard limit for
# max open files.
#
# If you wish to set a different value than the default one, uncomment and
# configure this setting. Remember that this value CANNOT be higher than the
# hard limit. Raising the hard limit depends on your OS and/or distribution,
# a good way to find the limit is to search the internet. For example:
#   raise max open files hard limit debian
#
#max_open_files: 100000

# The number of worker threads to start. These threads are used to manage
# return calls made from minions to the master. If the master seems to be
# running slowly, increase the number of threads. This setting can not be
# set lower than 3.
#worker_threads: 5

# Set the ZeroMQ high water marks
# http://api.zeromq.org/3\-2:zmq\-setsockopt

# The listen queue size / backlog
#zmq_backlog: 1000

# The publisher interface ZeroMQPubServerChannel
#pub_hwm: 1000

# The master may allocate memory per\-event and not
# reclaim it.
# To set a high\-water mark for memory allocation, use
# ipc_write_buffer to set a high\-water mark for message
# buffering.
# Value: In bytes. Set to \(aqdynamic\(aq to have Salt select
# a value for you. Default is disabled.
# ipc_write_buffer: \(aqdynamic\(aq

# These two batch settings, batch_safe_limit and batch_safe_size, are used to
# automatically switch to a batch mode execution. If a command would have been
# sent to more than <batch_safe_limit> minions, then run the command in
# batches of <batch_safe_size>. If no batch_safe_size is specified, a default
# of 8 will be used. If no batch_safe_limit is specified, then no automatic
# batching will occur.
#batch_safe_limit: 100
#batch_safe_size: 8

# Master stats enables stats events to be fired from the master at close
# to the defined interval
#master_stats: False
#master_stats_event_iter: 60


#####        Security settings       #####
##########################################
# Enable passphrase protection of Master private key.  Although a string value
# is acceptable; passwords should be stored in an external vaulting mechanism
# and retrieved via sdb. See https://docs.saltproject.io/en/latest/topics/sdb/.
# Passphrase protection is off by default but an example of an sdb profile and
# query is as follows.
# masterkeyring:
#  driver: keyring
#  service: system
#
# key_pass: sdb://masterkeyring/key_pass

# Enable passphrase protection of the Master signing_key. This only applies if
# master_sign_pubkey is set to True.  This is disabled by default.
# master_sign_pubkey: True
# signing_key_pass: sdb://masterkeyring/signing_pass

# Enable \(dqopen mode\(dq, this mode still maintains encryption, but turns off
# authentication, this is only intended for highly secure environments or for
# the situation where your keys end up in a bad state. If you run in open mode
# you do so at your own risk!
#open_mode: False

# Enable auto_accept, this setting will automatically accept all incoming
# public keys from the minions. Note that this is insecure.
#auto_accept: False

# The size of key that should be generated when creating new keys.
#keysize: 2048

# Time in minutes that an incoming public key with a matching name found in
# pki_dir/minion_autosign/keyid is automatically accepted. Expired autosign keys
# are removed when the master checks the minion_autosign directory.
# 0 equals no timeout
# autosign_timeout: 120

# If the autosign_file is specified, incoming keys specified in the
# autosign_file will be automatically accepted. This is insecure.  Regular
# expressions as well as globing lines are supported. The file must be readonly
# except for the owner. Use permissive_pki_access to allow the group write access.
#autosign_file: /etc/salt/autosign.conf

# Works like autosign_file, but instead allows you to specify minion IDs for
# which keys will automatically be rejected. Will override both membership in
# the autosign_file and the auto_accept setting.
#autoreject_file: /etc/salt/autoreject.conf

# If the autosign_grains_dir is specified, incoming keys from minions with grain
# values matching those defined in files in this directory will be accepted
# automatically. This is insecure. Minions need to be configured to send the grains.
#autosign_grains_dir: /etc/salt/autosign_grains

# Enable permissive access to the salt keys. This allows you to run the
# master or minion as root, but have a non\-root group be given access to
# your pki_dir. To make the access explicit, root must belong to the group
# you\(aqve given access to. This is potentially quite insecure. If an autosign_file
# is specified, enabling permissive_pki_access will allow group access to that
# specific file.
#permissive_pki_access: False

# Allow users on the master access to execute specific commands on minions.
# This setting should be treated with care since it opens up execution
# capabilities to non root users. By default this capability is completely
# disabled.
#publisher_acl:
#  larry:
#    \- test.ping
#    \- network.*
#
# Blacklist any of the following users or modules
#
# This example would blacklist all non sudo users, including root from
# running any commands. It would also blacklist any use of the \(dqcmd\(dq
# module. This is completely disabled by default.
#
#
# Check the list of configured users in client ACL against users on the
# system and throw errors if they do not exist.
#client_acl_verify: True
#
#publisher_acl_blacklist:
#  users:
#    \- root
#    \- \(aq^(?!sudo_).*$\(aq   #  all non sudo users
#  modules:
#    \- cmd

# Enforce publisher_acl & publisher_acl_blacklist when users have sudo
# access to the salt command.
#
#sudo_acl: False

# The external auth system uses the Salt auth modules to authenticate and
# validate users to access areas of the Salt system.
#external_auth:
#  pam:
#    fred:
#      \- test.*
#
# Time (in seconds) for a newly generated token to live. Default: 12 hours
#token_expire: 43200
#
# Allow eauth users to specify the expiry time of the tokens they generate.
# A boolean applies to all users or a dictionary of whitelisted eauth backends
# and usernames may be given.
# token_expire_user_override:
#   pam:
#     \- fred
#     \- tom
#   ldap:
#     \- gary
#
#token_expire_user_override: False

# Set to True to enable keeping the calculated user\(aqs auth list in the token
# file. This is disabled by default and the auth list is calculated or requested
# from the eauth driver each time.
#
# Note: \(gakeep_acl_in_token\(ga will be forced to True when using external authentication
# for REST API (\(garest\(ga is present under \(gaexternal_auth\(ga). This is because the REST API
# does not store the password, and can therefore not retroactively fetch the ACL, so
# the ACL must be stored in the token.
#keep_acl_in_token: False

# Auth subsystem module to use to get authorized access list for a user. By default it\(aqs
# the same module used for external authentication.
#eauth_acl_module: django

# Allow minions to push files to the master. This is disabled by default, for
# security purposes.
#file_recv: False

# Set a hard\-limit on the size of the files that can be pushed to the master.
# It will be interpreted as megabytes. Default: 100
#file_recv_max_size: 100

# Signature verification on messages published from the master.
# This causes the master to cryptographically sign all messages published to its event
# bus, and minions then verify that signature before acting on the message.
#
# This is False by default.
#
# Note that to facilitate interoperability with masters and minions that are different
# versions, if sign_pub_messages is True but a message is received by a minion with
# no signature, it will still be accepted, and a warning message will be logged.
# Conversely, if sign_pub_messages is False, but a minion receives a signed
# message it will be accepted, the signature will not be checked, and a warning message
# will be logged. This behavior went away in Salt 2014.1.0 and these two situations
# will cause minion to throw an exception and drop the message.
# sign_pub_messages: False

# Signature verification on messages published from minions
# This requires that minions cryptographically sign the messages they
# publish to the master.  If minions are not signing, then log this information
# at loglevel \(aqINFO\(aq and drop the message without acting on it.
# require_minion_sign_messages: False

# The below will drop messages when their signatures do not validate.
# Note that when this option is False but \(garequire_minion_sign_messages\(ga is True
# minions MUST sign their messages but the validity of their signatures
# is ignored.
# These two config options exist so a Salt infrastructure can be moved
# to signing minion messages gradually.
# drop_messages_signature_fail: False

# Use TLS/SSL encrypted connection between master and minion.
# Can be set to a dictionary containing keyword arguments corresponding to Python\(aqs
# \(aqssl.wrap_socket\(aq method.
# Default is None.
#ssl:
#    keyfile: <path_to_keyfile>
#    certfile: <path_to_certfile>
#    ssl_version: PROTOCOL_TLSv1_2

#####     Salt\-SSH Configuration     #####
##########################################
# Define the default salt\-ssh roster module to use
#roster: flat

# Pass in an alternative location for the salt\-ssh \(gaflat\(ga roster file
#roster_file: /etc/salt/roster

# Define locations for \(gaflat\(ga roster files so they can be chosen when using Salt API.
# An administrator can place roster files into these locations. Then when
# calling Salt API, parameter \(aqroster_file\(aq should contain a relative path to
# these locations. That is, \(dqroster_file=/foo/roster\(dq will be resolved as
# \(dq/etc/salt/roster.d/foo/roster\(dq etc. This feature prevents passing insecure
# custom rosters through the Salt API.
#
#rosters:
# \- /etc/salt/roster.d
# \- /opt/salt/some/more/rosters

# The ssh password to log in with.
#ssh_passwd: \(aq\(aq

#The target system\(aqs ssh port number.
#ssh_port: 22

# Comma\-separated list of ports to scan.
#ssh_scan_ports: 22

# Scanning socket timeout for salt\-ssh.
#ssh_scan_timeout: 0.01

# Boolean to run command via sudo.
#ssh_sudo: False

# Boolean to run ssh_pre_flight script defined in roster. By default
# the script will only run if the thin_dir does not exist on the targeted
# minion. This forces the script to run regardless of the thin dir existing
# or not.
#ssh_run_pre_flight: True

# Number of seconds to wait for a response when establishing an SSH connection.
#ssh_timeout: 60

# The user to log in as.
#ssh_user: root

# The log file of the salt\-ssh command:
#ssh_log_file: /var/log/salt/ssh

# Pass in minion option overrides that will be inserted into the SHIM for
# salt\-ssh calls. The local minion config is not used for salt\-ssh. Can be
# overridden on a per\-minion basis in the roster (\(gaminion_opts\(ga)
#ssh_minion_opts:
#  gpg_keydir: /root/gpg

# Set this to True to default to using ~/.ssh/id_rsa for salt\-ssh
# authentication with minions
#ssh_use_home_key: False

# Set this to True to default salt\-ssh to run with \(ga\(ga\-o IdentitiesOnly=yes\(ga\(ga.
# This option is intended for situations where the ssh\-agent offers many
# different identities and allows ssh to ignore those identities and use the
# only one specified in options.
#ssh_identities_only: False

# List\-only nodegroups for salt\-ssh. Each group must be formed as either a
# comma\-separated list, or a YAML list. This option is useful to group minions
# into easy\-to\-target groups when using salt\-ssh. These groups can then be
# targeted with the normal \-N argument to salt\-ssh.
#ssh_list_nodegroups: {}

# salt\-ssh has the ability to update the flat roster file if a minion is not
# found in the roster.  Set this to True to enable it.
#ssh_update_roster: False

#####    Master Module Management    #####
##########################################
# Manage how master side modules are loaded.

# Add any additional locations to look for master runners:
#runner_dirs: []

# Add any additional locations to look for master utils:
#utils_dirs: []

# Enable Cython for master side modules:
#cython_enable: False


#####      State System settings     #####
##########################################
# The state system uses a \(dqtop\(dq file to tell the minions what environment to
# use and what modules to use. The state_top file is defined relative to the
# root of the base environment as defined in \(dqFile Server settings\(dq below.
#state_top: top.sls

# The master_tops option replaces the external_nodes option by creating
# a plugable system for the generation of external top data. The external_nodes
# option is deprecated by the master_tops option.
#
# To gain the capabilities of the classic external_nodes system, use the
# following configuration:
# master_tops:
#   ext_nodes: <Shell command which returns yaml>
#
#master_tops: {}

# The renderer to use on the minions to render the state data
#renderer: jinja|yaml

# Default Jinja environment options for all templates except sls templates
#jinja_env:
#  block_start_string: \(aq{%\(aq
#  block_end_string: \(aq%}\(aq
#  variable_start_string: \(aq{{\(aq
#  variable_end_string: \(aq}}\(aq
#  comment_start_string: \(aq{#\(aq
#  comment_end_string: \(aq#}\(aq
#  line_statement_prefix:
#  line_comment_prefix:
#  trim_blocks: False
#  lstrip_blocks: False
#  newline_sequence: \(aq\en\(aq
#  keep_trailing_newline: False

# Jinja environment options for sls templates
#jinja_sls_env:
#  block_start_string: \(aq{%\(aq
#  block_end_string: \(aq%}\(aq
#  variable_start_string: \(aq{{\(aq
#  variable_end_string: \(aq}}\(aq
#  comment_start_string: \(aq{#\(aq
#  comment_end_string: \(aq#}\(aq
#  line_statement_prefix:
#  line_comment_prefix:
#  trim_blocks: False
#  lstrip_blocks: False
#  newline_sequence: \(aq\en\(aq
#  keep_trailing_newline: False

# The failhard option tells the minions to stop immediately after the first
# failure detected in the state execution, defaults to False
#failhard: False

# The state_verbose and state_output settings can be used to change the way
# state system data is printed to the display. By default all data is printed.
# The state_verbose setting can be set to True or False, when set to False
# all data that has a result of True and no changes will be suppressed.
#state_verbose: True

# The state_output setting controls which results will be output full multi line
# full, terse \- each state will be full/terse
# mixed \- only states with errors will be full
# changes \- states with changes and errors will be full
# full_id, mixed_id, changes_id and terse_id are also allowed;
# when set, the state ID will be used as name in the output
#state_output: full

# The state_output_diff setting changes whether or not the output from
# successful states is returned. Useful when even the terse output of these
# states is cluttering the logs. Set it to True to ignore them.
#state_output_diff: False

# The state_output_profile setting changes whether profile information
# will be shown for each state run.
#state_output_profile: True

# The state_output_pct setting changes whether success and failure information
# as a percent of total actions will be shown for each state run.
#state_output_pct: False

# The state_compress_ids setting aggregates information about states which have
# multiple \(dqnames\(dq under the same state ID in the highstate output.
#state_compress_ids: False

# Automatically aggregate all states that have support for mod_aggregate by
# setting to \(aqTrue\(aq. Or pass a list of state module names to automatically
# aggregate just those types.
#
# state_aggregate:
#   \- pkg
#
#state_aggregate: False

# Send progress events as each function in a state run completes execution
# by setting to \(aqTrue\(aq. Progress events are in the format
# \(aqsalt/job/<JID>/prog/<MID>/<RUN NUM>\(aq.
#state_events: False

#####      File Server settings      #####
##########################################
# Salt runs a lightweight file server written in zeromq to deliver files to
# minions. This file server is built into the master daemon and does not
# require a dedicated port.

# The file server works on environments passed to the master, each environment
# can have multiple root directories, the subdirectories in the multiple file
# roots cannot match, otherwise the downloaded files will not be able to be
# reliably ensured. A base environment is required to house the top file.
# Example:
# file_roots:
#   base:
#     \- /srv/salt/
#   dev:
#     \- /srv/salt/dev/services
#     \- /srv/salt/dev/states
#   prod:
#     \- /srv/salt/prod/services
#     \- /srv/salt/prod/states
#
#file_roots:
#  base:
#    \- /srv/salt
#

# The master_roots setting configures a master\-only copy of the file_roots dictionary,
# used by the state compiler.
#master_roots:
#  base:
#    \- /srv/salt\-master

# When using multiple environments, each with their own top file, the
# default behaviour is an unordered merge. To prevent top files from
# being merged together and instead to only use the top file from the
# requested environment, set this value to \(aqsame\(aq.
#top_file_merging_strategy: merge

# To specify the order in which environments are merged, set the ordering
# in the env_order option. Given a conflict, the last matching value will
# win.
#env_order: [\(aqbase\(aq, \(aqdev\(aq, \(aqprod\(aq]

# If top_file_merging_strategy is set to \(aqsame\(aq and an environment does not
# contain a top file, the top file in the environment specified by default_top
# will be used instead.
#default_top: base

# The hash_type is the hash to use when discovering the hash of a file on
# the master server. The default is sha256, but md5, sha1, sha224, sha384 and
# sha512 are also supported.
#
# WARNING: While md5 and sha1 are also supported, do not use them due to the
# high chance of possible collisions and thus security breach.
#
# Prior to changing this value, the master should be stopped and all Salt
# caches should be cleared.
#hash_type: sha256

# The buffer size in the file server can be adjusted here:
#file_buffer_size: 1048576

# A regular expression (or a list of expressions) that will be matched
# against the file path before syncing the modules and states to the minions.
# This includes files affected by the file.recurse state.
# For example, if you manage your custom modules and states in subversion
# and don\(aqt want all the \(aq.svn\(aq folders and content synced to your minions,
# you could set this to \(aq/\e.svn($|/)\(aq. By default nothing is ignored.
#file_ignore_regex:
#  \- \(aq/\e.svn($|/)\(aq
#  \- \(aq/\e.git($|/)\(aq

# A file glob (or list of file globs) that will be matched against the file
# path before syncing the modules and states to the minions. This is similar
# to file_ignore_regex above, but works on globs instead of regex. By default
# nothing is ignored.
# file_ignore_glob:
#  \- \(aq*.pyc\(aq
#  \- \(aq*/somefolder/*.bak\(aq
#  \- \(aq*.swp\(aq

# File Server Backend
#
# Salt supports a modular fileserver backend system, this system allows
# the salt master to link directly to third party systems to gather and
# manage the files available to minions. Multiple backends can be
# configured and will be searched for the requested file in the order in which
# they are defined here. The default setting only enables the standard backend
# \(dqroots\(dq which uses the \(dqfile_roots\(dq option.
#fileserver_backend:
#  \- roots
#
# To use multiple backends list them in the order they are searched:
#fileserver_backend:
#  \- git
#  \- roots
#
# Uncomment the line below if you do not want the file_server to follow
# symlinks when walking the filesystem tree. This is set to True
# by default. Currently this only applies to the default roots
# fileserver_backend.
#fileserver_followsymlinks: False
#
# Uncomment the line below if you do not want symlinks to be
# treated as the files they are pointing to. By default this is set to
# False. By uncommenting the line below, any detected symlink while listing
# files on the Master will not be returned to the Minion.
#fileserver_ignoresymlinks: True
#
# The fileserver can fire events off every time the fileserver is updated,
# these are disabled by default, but can be easily turned on by setting this
# flag to True
#fileserver_events: False

# Git File Server Backend Configuration
#
# Optional parameter used to specify the provider to be used for gitfs. Must be
# either pygit2 or gitpython. If unset, then both will be tried (in that
# order), and the first one with a compatible version installed will be the
# provider that is used.
#
#gitfs_provider: pygit2

# Along with gitfs_password, is used to authenticate to HTTPS remotes.
# gitfs_user: \(aq\(aq

# Along with gitfs_user, is used to authenticate to HTTPS remotes.
# This parameter is not required if the repository does not use authentication.
#gitfs_password: \(aq\(aq

# By default, Salt will not authenticate to an HTTP (non\-HTTPS) remote.
# This parameter enables authentication over HTTP. Enable this at your own risk.
#gitfs_insecure_auth: False

# Along with gitfs_privkey (and optionally gitfs_passphrase), is used to
# authenticate to SSH remotes. This parameter (or its per\-remote counterpart)
# is required for SSH remotes.
#gitfs_pubkey: \(aq\(aq

# Along with gitfs_pubkey (and optionally gitfs_passphrase), is used to
# authenticate to SSH remotes. This parameter (or its per\-remote counterpart)
# is required for SSH remotes.
#gitfs_privkey: \(aq\(aq

# This parameter is optional, required only when the SSH key being used to
# authenticate is protected by a passphrase.
#gitfs_passphrase: \(aq\(aq

# When using the git fileserver backend at least one git remote needs to be
# defined. The user running the salt master will need read access to the repo.
#
# The repos will be searched in order to find the file requested by a client
# and the first repo to have the file will return it.
# When using the git backend branches and tags are translated into salt
# environments.
# Note: file:// repos will be treated as a remote, so refs you want used must
# exist in that repo as *local* refs.
#gitfs_remotes:
#  \- git://github.com/saltstack/salt\-states.git
#  \- file:///var/git/saltmaster
#
# The gitfs_ssl_verify option specifies whether to ignore ssl certificate
# errors when contacting the gitfs backend. You might want to set this to
# false if you\(aqre using a git backend that uses a self\-signed certificate but
# keep in mind that setting this flag to anything other than the default of True
# is a security concern, you may want to try using the ssh transport.
#gitfs_ssl_verify: True
#
# The gitfs_root option gives the ability to serve files from a subdirectory
# within the repository. The path is defined relative to the root of the
# repository and defaults to the repository root.
#gitfs_root: somefolder/otherfolder
#
# The refspecs fetched by gitfs remotes
#gitfs_refspecs:
#  \- \(aq+refs/heads/*:refs/remotes/origin/*\(aq
#  \- \(aq+refs/tags/*:refs/tags/*\(aq
#
#
#####         Pillar settings        #####
##########################################
# Salt Pillars allow for the building of global data that can be made selectively
# available to different minions based on minion grain filtering. The Salt
# Pillar is laid out in the same fashion as the file server, with environments,
# a top file and sls files. However, pillar data does not need to be in the
# highstate format, and is generally just key/value pairs.
#pillar_roots:
#  base:
#    \- /srv/pillar
#
#ext_pillar:
#  \- hiera: /etc/hiera.yaml
#  \- cmd_yaml: cat /etc/salt/yaml


# A list of paths to be recursively decrypted during pillar compilation.
# Entries in this list can be formatted either as a simple string, or as a
# key/value pair, with the key being the pillar location, and the value being
# the renderer to use for pillar decryption. If the former is used, the
# renderer specified by decrypt_pillar_default will be used.
#decrypt_pillar:
#  \- \(aqfoo:bar\(aq: gpg
#  \- \(aqlorem:ipsum:dolor\(aq

# The delimiter used to distinguish nested data structures in the
# decrypt_pillar option.
#decrypt_pillar_delimiter: \(aq:\(aq

# The default renderer used for decryption, if one is not specified for a given
# pillar key in decrypt_pillar.
#decrypt_pillar_default: gpg

# List of renderers which are permitted to be used for pillar decryption.
#decrypt_pillar_renderers:
#  \- gpg

# If this is \(gaTrue\(ga and the ciphertext could not be decrypted, then an error is
# raised.
#gpg_decrypt_must_succeed: False

# The ext_pillar_first option allows for external pillar sources to populate
# before file system pillar. This allows for targeting file system pillar from
# ext_pillar.
#ext_pillar_first: False

# The external pillars permitted to be used on\-demand using pillar.ext
#on_demand_ext_pillar:
#  \- libvirt
#  \- virtkey

# The pillar_gitfs_ssl_verify option specifies whether to ignore ssl certificate
# errors when contacting the pillar gitfs backend. You might want to set this to
# false if you\(aqre using a git backend that uses a self\-signed certificate but
# keep in mind that setting this flag to anything other than the default of True
# is a security concern, you may want to try using the ssh transport.
#pillar_gitfs_ssl_verify: True

# The pillar_opts option adds the master configuration file data to a dict in
# the pillar called \(dqmaster\(dq. This is used to set simple configurations in the
# master config file that can then be used on minions.
#pillar_opts: False

# The pillar_safe_render_error option prevents the master from passing pillar
# render errors to the minion. This is set on by default because the error could
# contain templating data which would give that minion information it shouldn\(aqt
# have, like a password! When set true the error message will only show:
#   Rendering SLS \(aqmy.sls\(aq failed. Please see master log for details.
#pillar_safe_render_error: True

# The pillar_source_merging_strategy option allows you to configure merging strategy
# between different sources. It accepts five values: none, recurse, aggregate, overwrite,
# or smart. None will not do any merging at all. Recurse will merge recursively mapping of data.
# Aggregate instructs aggregation of elements between sources that use the #!yamlex renderer. Overwrite
# will overwrite elements according the order in which they are processed. This is
# behavior of the 2014.1 branch and earlier. Smart guesses the best strategy based
# on the \(dqrenderer\(dq setting and is the default value.
#pillar_source_merging_strategy: smart

# Recursively merge lists by aggregating them instead of replacing them.
#pillar_merge_lists: False

# Set this option to True to force the pillarenv to be the same as the effective
# saltenv when running states. If pillarenv is specified this option will be
# ignored.
#pillarenv_from_saltenv: False

# Set this option to \(aqTrue\(aq to force a \(aqKeyError\(aq to be raised whenever an
# attempt to retrieve a named value from pillar fails. When this option is set
# to \(aqFalse\(aq, the failed attempt returns an empty string. Default is \(aqFalse\(aq.
#pillar_raise_on_missing: False

# Git External Pillar (git_pillar) Configuration Options
#
# Specify the provider to be used for git_pillar. Must be either pygit2 or
# gitpython. If unset, then both will be tried in that same order, and the
# first one with a compatible version installed will be the provider that
# is used.
#git_pillar_provider: pygit2

# If the desired branch matches this value, and the environment is omitted
# from the git_pillar configuration, then the environment for that git_pillar
# remote will be base.
#git_pillar_base: master

# If the branch is omitted from a git_pillar remote, then this branch will
# be used instead
#git_pillar_branch: master

# Environment to use for git_pillar remotes. This is normally derived from
# the branch/tag (or from a per\-remote env parameter), but if set this will
# override the process of deriving the env from the branch/tag name.
#git_pillar_env: \(aq\(aq

# Path relative to the root of the repository where the git_pillar top file
# and SLS files are located.
#git_pillar_root: \(aq\(aq

# Specifies whether or not to ignore SSL certificate errors when contacting
# the remote repository.
#git_pillar_ssl_verify: False

# When set to False, if there is an update/checkout lock for a git_pillar
# remote and the pid written to it is not running on the master, the lock
# file will be automatically cleared and a new lock will be obtained.
#git_pillar_global_lock: True

# Git External Pillar Authentication Options
#
# Along with git_pillar_password, is used to authenticate to HTTPS remotes.
#git_pillar_user: \(aq\(aq

# Along with git_pillar_user, is used to authenticate to HTTPS remotes.
# This parameter is not required if the repository does not use authentication.
#git_pillar_password: \(aq\(aq

# By default, Salt will not authenticate to an HTTP (non\-HTTPS) remote.
# This parameter enables authentication over HTTP.
#git_pillar_insecure_auth: False

# Along with git_pillar_privkey (and optionally git_pillar_passphrase),
# is used to authenticate to SSH remotes.
#git_pillar_pubkey: \(aq\(aq

# Along with git_pillar_pubkey (and optionally git_pillar_passphrase),
# is used to authenticate to SSH remotes.
#git_pillar_privkey: \(aq\(aq

# This parameter is optional, required only when the SSH key being used
# to authenticate is protected by a passphrase.
#git_pillar_passphrase: \(aq\(aq

# The refspecs fetched by git_pillar remotes
#git_pillar_refspecs:
#  \- \(aq+refs/heads/*:refs/remotes/origin/*\(aq
#  \- \(aq+refs/tags/*:refs/tags/*\(aq

# A master can cache pillars locally to bypass the expense of having to render them
# for each minion on every request. This feature should only be enabled in cases
# where pillar rendering time is known to be unsatisfactory and any attendant security
# concerns about storing pillars in a master cache have been addressed.
#
# When enabling this feature, be certain to read through the additional \(ga\(gapillar_cache_*\(ga\(ga
# configuration options to fully understand the tunable parameters and their implications.
#
# Note: setting \(ga\(gapillar_cache: True\(ga\(ga has no effect on targeting Minions with Pillars.
# See https://docs.saltproject.io/en/latest/topics/targeting/pillar.html
#pillar_cache: False

# If and only if a master has set \(ga\(gapillar_cache: True\(ga\(ga, the cache TTL controls the amount
# of time, in seconds, before the cache is considered invalid by a master and a fresh
# pillar is recompiled and stored.
# The cache TTL does not prevent pillar cache from being refreshed before its TTL expires.
#pillar_cache_ttl: 3600

# If and only if a master has set \(gapillar_cache: True\(ga, one of several storage providers
# can be utilized.
#
# \(gadisk\(ga: The default storage backend. This caches rendered pillars to the master cache.
#         Rendered pillars are serialized and deserialized as msgpack structures for speed.
#         Note that pillars are stored UNENCRYPTED. Ensure that the master cache
#         has permissions set appropriately. (Same defaults are provided.)
#
# memory: [EXPERIMENTAL] An optional backend for pillar caches which uses a pure\-Python
#         in\-memory data structure for maximal performance. There are several caveats,
#         however. First, because each master worker contains its own in\-memory cache,
#         there is no guarantee of cache consistency between minion requests. This
#         works best in situations where the pillar rarely if ever changes. Secondly,
#         and perhaps more importantly, this means that unencrypted pillars will
#         be accessible to any process which can examine the memory of the \(ga\(gasalt\-master\(ga\(ga!
#         This may represent a substantial security risk.
#
#pillar_cache_backend: disk

# A master can also cache GPG data locally to bypass the expense of having to render them
# for each minion on every request. This feature should only be enabled in cases
# where pillar rendering time is known to be unsatisfactory and any attendant security
# concerns about storing decrypted GPG data in a master cache have been addressed.
#
# When enabling this feature, be certain to read through the additional \(ga\(gagpg_cache_*\(ga\(ga
# configuration options to fully understand the tunable parameters and their implications.
#gpg_cache: False

# If and only if a master has set \(ga\(gagpg_cache: True\(ga\(ga, the cache TTL controls the amount
# of time, in seconds, before the cache is considered invalid by a master and a fresh
# pillar is recompiled and stored.
#gpg_cache_ttl: 86400

# If and only if a master has set \(gagpg_cache: True\(ga, one of several storage providers
# can be utilized. Available options are the same as \(ga\(gapillar_cache_backend\(ga\(ga.
#gpg_cache_backend: disk


######        Reactor Settings        #####
###########################################
# Define a salt reactor. See https://docs.saltproject.io/en/latest/topics/reactor/
#reactor: []

#Set the TTL for the cache of the reactor configuration.
#reactor_refresh_interval: 60

#Configure the number of workers for the runner/wheel in the reactor.
#reactor_worker_threads: 10

#Define the queue size for workers in the reactor.
#reactor_worker_hwm: 10000


#####          Syndic settings       #####
##########################################
# The Salt syndic is used to pass commands through a master from a higher
# master. Using the syndic is simple. If this is a master that will have
# syndic servers(s) below it, then set the \(dqorder_masters\(dq setting to True.
#
# If this is a master that will be running a syndic daemon for passthrough, then
# the \(dqsyndic_master\(dq setting needs to be set to the location of the master server
# to receive commands from.

# Set the order_masters setting to True if this master will command lower
# masters\(aq syndic interfaces.
#order_masters: False

# If this master will be running a salt syndic daemon, syndic_master tells
# this master where to receive commands from.
#syndic_master: masterofmasters

# This is the \(aqret_port\(aq of the MasterOfMaster:
#syndic_master_port: 4506

# PID file of the syndic daemon:
#syndic_pidfile: /var/run/salt\-syndic.pid

# The log file of the salt\-syndic daemon:
#syndic_log_file: /var/log/salt/syndic

# The behaviour of the multi\-syndic when connection to a master of masters failed.
# Can specify \(ga\(garandom\(ga\(ga (default) or \(ga\(gaordered\(ga\(ga. If set to \(ga\(garandom\(ga\(ga, masters
# will be iterated in random order. If \(ga\(gaordered\(ga\(ga is specified, the configured
# order will be used.
#syndic_failover: random

# The number of seconds for the salt client to wait for additional syndics to
# check in with their lists of expected minions before giving up.
#syndic_wait: 5


#####      Peer Publish settings     #####
##########################################
# Salt minions can send commands to other minions, but only if the minion is
# allowed to. By default \(dqPeer Publication\(dq is disabled, and when enabled it
# is enabled for specific minions and specific commands. This allows secure
# compartmentalization of commands based on individual minions.

# The configuration uses regular expressions to match minions and then a list
# of regular expressions to match functions. The following will allow the
# minion authenticated as foo.example.com to execute functions from the test
# and pkg modules.
#peer:
#  foo.example.com:
#    \- test.*
#    \- pkg.*
#
# This will allow all minions to execute all commands:
#peer:
#  .*:
#    \- .*
#
# This is not recommended, since it would allow anyone who gets root on any
# single minion to instantly have root on all of the minions!

# Minions can also be allowed to execute runners from the salt master.
# Since executing a runner from the minion could be considered a security risk,
# it needs to be enabled. This setting functions just like the peer setting
# except that it opens up runners instead of module functions.
#
# All peer runner support is turned off by default and must be enabled before
# using. This will enable all peer runners for all minions:
#peer_run:
#  .*:
#    \- .*
#
# To enable just the manage.up runner for the minion foo.example.com:
#peer_run:
#  foo.example.com:
#    \- manage.up
#
#
#####         Mine settings     #####
#####################################
# Restrict mine.get access from minions. By default any minion has a full access
# to get all mine data from master cache. In acl definion below, only pcre matches
# are allowed.
# mine_get:
#   .*:
#     \- .*
#
# The example below enables minion foo.example.com to get \(aqnetwork.interfaces\(aq mine
# data only, minions web* to get all network.* and disk.* mine data and all other
# minions won\(aqt get any mine data.
# mine_get:
#   foo.example.com:
#     \- network.interfaces
#   web.*:
#     \- network.*
#     \- disk.*


#####         Logging settings       #####
##########################################
# The location of the master log file
# The master log can be sent to a regular file, local path name, or network
# location. Remote logging works best when configured to use rsyslogd(8) (e.g.:
# \(ga\(gafile:///dev/log\(ga\(ga), with rsyslogd(8) configured for network logging. The URI
# format is: <file|udp|tcp>://<host|socketpath>:<port\-if\-required>/<log\-facility>
#log_file: /var/log/salt/master
#log_file: file:///dev/log
#log_file: udp://loghost:10514

#log_file: /var/log/salt/master
#key_logfile: /var/log/salt/key

# The level of messages to send to the console.
# One of \(aqgarbage\(aq, \(aqtrace\(aq, \(aqdebug\(aq, info\(aq, \(aqwarning\(aq, \(aqerror\(aq, \(aqcritical\(aq.
#
# The following log levels are considered INSECURE and may log sensitive data:
# [\(aqprofile\(aq, \(aqgarbage\(aq, \(aqtrace\(aq, \(aqdebug\(aq, \(aqall\(aq]
#
#log_level: warning

# The level of messages to send to the log file.
# One of \(aqgarbage\(aq, \(aqtrace\(aq, \(aqdebug\(aq, \(aqinfo\(aq, \(aqwarning\(aq, \(aqerror\(aq, \(aqcritical\(aq.
# If using \(aqlog_granular_levels\(aq this must be set to the highest desired level.
#log_level_logfile: warning

# The date and time format used in log messages. Allowed date/time formatting
# can be seen here: http://docs.python.org/library/time.html#time.strftime
#log_datefmt: \(aq%H:%M:%S\(aq
#log_datefmt_logfile: \(aq%Y\-%m\-%d %H:%M:%S\(aq

# The format of the console logging messages. Allowed formatting options can
# be seen here: http://docs.python.org/library/logging.html#logrecord\-attributes
#
# Console log colors are specified by these additional formatters:
#
# %(colorlevel)s
# %(colorname)s
# %(colorprocess)s
# %(colormsg)s
#
# Since it is desirable to include the surrounding brackets, \(aq[\(aq and \(aq]\(aq, in
# the coloring of the messages, these color formatters also include padding as
# well.  Color LogRecord attributes are only available for console logging.
#
#log_fmt_console: \(aq%(colorlevel)s %(colormsg)s\(aq
#log_fmt_console: \(aq[%(levelname)\-8s] %(message)s\(aq
#
#log_fmt_logfile: \(aq%(asctime)s,%(msecs)03d [%(name)\-17s][%(levelname)\-8s] %(message)s\(aq

# This can be used to control logging levels more specificically.  This
# example sets the main salt library at the \(aqwarning\(aq level, but sets
# \(aqsalt.modules\(aq to log at the \(aqdebug\(aq level:
#   log_granular_levels:
#     \(aqsalt\(aq: \(aqwarning\(aq
#     \(aqsalt.modules\(aq: \(aqdebug\(aq
#
#log_granular_levels: {}


#####         Node Groups           ######
##########################################
# Node groups allow for logical groupings of minion nodes. A group consists of
# a group name and a compound target. Nodgroups can reference other nodegroups
# with \(aqN@\(aq classifier. Ensure that you do not have circular references.
#
#nodegroups:
#  group1: \(aqL@foo.domain.com,bar.domain.com,baz.domain.com or bl*.domain.com\(aq
#  group2: \(aqG@os:Debian and foo.domain.com\(aq
#  group3: \(aqG@os:Debian and N@group1\(aq
#  group4:
#    \- \(aqG@foo:bar\(aq
#    \- \(aqor\(aq
#    \- \(aqG@foo:baz\(aq


#####     Range Cluster settings     #####
##########################################
# The range server (and optional port) that serves your cluster information
# https://github.com/ytoolshed/range/wiki/%22yamlfile%22\-module\-file\-spec
#
#range_server: range:80


#####  Windows Software Repo settings #####
###########################################
# Location of the repo on the master:
#winrepo_dir_ng: \(aq/srv/salt/win/repo\-ng\(aq
#
# List of git repositories to include with the local repo:
#winrepo_remotes_ng:
#  \- \(aqhttps://github.com/saltstack/salt\-winrepo\-ng.git\(aq


#####  Windows Software Repo settings \- Pre 2015.8 #####
########################################################
# Legacy repo settings for pre\-2015.8 Windows minions.
#
# Location of the repo on the master:
#winrepo_dir: \(aq/srv/salt/win/repo\(aq
#
# Location of the master\(aqs repo cache file:
#winrepo_mastercachefile: \(aq/srv/salt/win/repo/winrepo.p\(aq
#
# List of git repositories to include with the local repo:
#winrepo_remotes:
#  \- \(aqhttps://github.com/saltstack/salt\-winrepo.git\(aq

# The refspecs fetched by winrepo remotes
#winrepo_refspecs:
#  \- \(aq+refs/heads/*:refs/remotes/origin/*\(aq
#  \- \(aq+refs/tags/*:refs/tags/*\(aq
#

#####      Returner settings          ######
############################################
# Which returner(s) will be used for minion\(aqs result:
#return: mysql


######    Miscellaneous  settings     ######
############################################
# Default match type for filtering events tags: startswith, endswith, find, regex, fnmatch
#event_match_type: startswith

# Save runner returns to the job cache
#runner_returns: True

# Permanently include any available Python 3rd party modules into thin and minimal Salt
# when they are generated for Salt\-SSH or other purposes.
# The modules should be named by the names they are actually imported inside the Python.
# The value of the parameters can be either one module or a comma separated list of them.
#thin_extra_mods: foo,bar
#min_extra_mods: foo,bar,baz


######      Keepalive settings        ######
############################################
# Warning: Failure to set TCP keepalives on the salt\-master can result in
# not detecting the loss of a minion when the connection is lost or when
# its host has been terminated without first closing the socket.
# Salt\(aqs Presence System depends on this connection status to know if a minion
# is \(dqpresent\(dq.
# ZeroMQ now includes support for configuring SO_KEEPALIVE if supported by
# the OS. If connections between the minion and the master pass through
# a state tracking device such as a firewall or VPN gateway, there is
# the risk that it could tear down the connection the master and minion
# without informing either party that their connection has been taken away.
# Enabling TCP Keepalives prevents this from happening.

# Overall state of TCP Keepalives, enable (1 or True), disable (0 or False)
# or leave to the OS defaults (\-1), on Linux, typically disabled. Default True, enabled.
#tcp_keepalive: True

# How long before the first keepalive should be sent in seconds. Default 300
# to send the first keepalive after 5 minutes, OS default (\-1) is typically 7200 seconds
# on Linux see /proc/sys/net/ipv4/tcp_keepalive_time.
#tcp_keepalive_idle: 300

# How many lost probes are needed to consider the connection lost. Default \-1
# to use OS defaults, typically 9 on Linux, see /proc/sys/net/ipv4/tcp_keepalive_probes.
#tcp_keepalive_cnt: \-1

# How often, in seconds, to send keepalives after the first one. Default \-1 to
# use OS defaults, typically 75 seconds on Linux, see
# /proc/sys/net/ipv4/tcp_keepalive_intvl.
#tcp_keepalive_intvl: \-1


#####         NetAPI settings          #####
############################################
# Allow the raw_shell parameter to be used when calling Salt SSH client via API
#netapi_allow_raw_shell: True

# Set a list of clients to enable in in the API
#netapi_enable_clients: []

.ft P
.fi
.UNINDENT
.UNINDENT
.SS Example minion configuration file
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
##### Primary configuration settings #####
##########################################
# This configuration file is used to manage the behavior of the Salt Minion.
# With the exception of the location of the Salt Master Server, values that are
# commented out but have an empty line after the comment are defaults that need
# not be set in the config. If there is no blank line after the comment, the
# value is presented as an example and is not the default.

# Per default the minion will automatically include all config files
# from minion.d/*.conf (minion.d is a directory in the same directory
# as the main minion config file).
#default_include: minion.d/*.conf

# Set the location of the salt master server. If the master server cannot be
# resolved, then the minion will fail to start.
#master: salt

# Set http proxy information for the minion when doing requests
#proxy_host:
#proxy_port:
#proxy_username:
#proxy_password:

# List of hosts to bypass HTTP proxy. This key does nothing unless proxy_host etc is
# configured, it does not support any kind of wildcards.
#no_proxy: []

# If multiple masters are specified in the \(aqmaster\(aq setting, the default behavior
# is to always try to connect to them in the order they are listed. If random_master
# is set to True, the order will be randomized upon Minion startup instead. This can
# be helpful in distributing the load of many minions executing salt\-call requests,
# for example, from a cron job. If only one master is listed, this setting is ignored
# and a warning will be logged.
#random_master: False

# NOTE: Deprecated in Salt 2019.2.0. Use \(aqrandom_master\(aq instead.
#master_shuffle: False

# Minions can connect to multiple masters simultaneously (all masters
# are \(dqhot\(dq), or can be configured to failover if a master becomes
# unavailable.  Multiple hot masters are configured by setting this
# value to \(dqstr\(dq.  Failover masters can be requested by setting
# to \(dqfailover\(dq.  MAKE SURE TO SET master_alive_interval if you are
# using failover.
# Setting master_type to \(aqdisable\(aq lets you have a running minion (with engines and
# beacons) without a master connection
# master_type: str

# Poll interval in seconds for checking if the master is still there.  Only
# respected if master_type above is \(dqfailover\(dq. To disable the interval entirely,
# set the value to \-1. (This may be necessary on machines which have high numbers
# of TCP connections, such as load balancers.)
# master_alive_interval: 30

# If the minion is in multi\-master mode and the master_type configuration option
# is set to \(dqfailover\(dq, this setting can be set to \(dqTrue\(dq to force the minion
# to fail back to the first master in the list if the first master is back online.
#master_failback: False

# If the minion is in multi\-master mode, the \(dqmaster_type\(dq configuration is set to
# \(dqfailover\(dq, and the \(dqmaster_failback\(dq option is enabled, the master failback
# interval can be set to ping the top master with this interval, in seconds.
#master_failback_interval: 0

# Set whether the minion should connect to the master via IPv6:
#ipv6: False

# Set the number of seconds to wait before attempting to resolve
# the master hostname if name resolution fails. Defaults to 30 seconds.
# Set to zero if the minion should shutdown and not retry.
# retry_dns: 30

# Set the number of times to attempt to resolve
# the master hostname if name resolution fails. Defaults to None,
# which will attempt the resolution indefinitely.
# retry_dns_count: 3

# Set the port used by the master reply and authentication server.
#master_port: 4506

# The user to run salt.
#user: root

# The user to run salt remote execution commands as via sudo. If this option is
# enabled then sudo will be used to change the active user executing the remote
# command. If enabled the user will need to be allowed access via the sudoers
# file for the user that the salt minion is configured to run as. The most
# common option would be to use the root user. If this option is set the user
# option should also be set to a non\-root user. If migrating from a root minion
# to a non root minion the minion cache should be cleared and the minion pki
# directory will need to be changed to the ownership of the new user.
#sudo_user: root

# Specify the location of the daemon process ID file.
#pidfile: /var/run/salt\-minion.pid

# The root directory prepended to these options: pki_dir, cachedir, log_file,
# sock_dir, pidfile.
#root_dir: /

# The path to the minion\(aqs configuration file.
#conf_file: /etc/salt/minion

# The directory to store the pki information in
#pki_dir: /etc/salt/pki/minion

# Explicitly declare the id for this minion to use, if left commented the id
# will be the hostname as returned by the python call: socket.getfqdn()
# Since salt uses detached ids it is possible to run multiple minions on the
# same machine but with different ids, this can be useful for salt compute
# clusters.
#id:

# Cache the minion id to a file when the minion\(aqs id is not statically defined
# in the minion config. Defaults to \(dqTrue\(dq. This setting prevents potential
# problems when automatic minion id resolution changes, which can cause the
# minion to lose connection with the master. To turn off minion id caching,
# set this config to \(ga\(gaFalse\(ga\(ga.
#minion_id_caching: True

# Convert minion id to lowercase when it is being generated. Helpful when some
# hosts get the minion id in uppercase. Cached ids will remain the same and
# not converted. For example, Windows minions often have uppercase minion
# names when they are set up but not always. To turn on, set this config to
# \(ga\(gaTrue\(ga\(ga.
#minion_id_lowercase: False

# Append a domain to a hostname in the event that it does not exist.  This is
# useful for systems where socket.getfqdn() does not actually result in a
# FQDN (for instance, Solaris).
#append_domain:

# Custom static grains for this minion can be specified here and used in SLS
# files just like all other grains. This example sets 4 custom grains, with
# the \(aqroles\(aq grain having two values that can be matched against.
#grains:
#  roles:
#    \- webserver
#    \- memcache
#  deployment: datacenter4
#  cabinet: 13
#  cab_u: 14\-15
#
# Where cache data goes.
# This data may contain sensitive data and should be protected accordingly.
#cachedir: /var/cache/salt/minion

# Append minion_id to these directories.  Helps with
# multiple proxies and minions running on the same machine.
# Allowed elements in the list: pki_dir, cachedir, extension_modules
# Normally not needed unless running several proxies and/or minions on the same machine
# Defaults to [\(aqcachedir\(aq] for proxies, [] (empty list) for regular minions
#append_minionid_config_dirs:

# Verify and set permissions on configuration directories at startup.
#verify_env: True

# The minion can locally cache the return data from jobs sent to it, this
# can be a good way to keep track of jobs the minion has executed
# (on the minion side). By default this feature is disabled, to enable, set
# cache_jobs to True.
#cache_jobs: False

# Set the directory used to hold unix sockets.
#sock_dir: /var/run/salt/minion

# In order to calculate the fqdns grain, all the IP addresses from the minion
# are processed with underlying calls to \(gasocket.gethostbyaddr\(ga which can take
# 5 seconds to be released (after reaching \(gasocket.timeout\(ga) when there is no
# fqdn for that IP. These calls to \(gasocket.gethostbyaddr\(ga are processed
# asynchronously, however, it still adds 5 seconds every time grains are
# generated if an IP does not resolve. In Windows grains are regenerated each
# time a new process is spawned. Therefore, the default for Windows is \(gaFalse\(ga.
# On macOS, FQDN resolution can be very slow, therefore the default for macOS is
# \(gaFalse\(ga as well. All other OSes default to \(gaTrue\(ga
# enable_fqdns_grains: True

# The minion can take a while to start up when lspci and/or dmidecode is used
# to populate the grains for the minion. Set this to False if you do not need
# GPU hardware grains for your minion.
# enable_gpu_grains: True

# Set the default outputter used by the salt\-call command. The default is
# \(dqnested\(dq.
#output: nested

# To set a list of additional directories to search for salt outputters, set the
# outputter_dirs option.
#outputter_dirs: []

# By default output is colored. To disable colored output, set the color value
# to False.
#color: True

# Do not strip off the colored output from nested results and state outputs
# (true by default).
# strip_colors: False

# Backup files that are replaced by file.managed and file.recurse under
# \(aqcachedir\(aq/file_backup relative to their original location and appended
# with a timestamp. The only valid setting is \(dqminion\(dq. Disabled by default.
#
# Alternatively this can be specified for each file in state files:
# /etc/ssh/sshd_config:
#   file.managed:
#     \- source: salt://ssh/sshd_config
#     \- backup: minion
#
#backup_mode: minion

# When waiting for a master to accept the minion\(aqs public key, salt will
# continuously attempt to reconnect until successful. This is the time, in
# seconds, between those reconnection attempts.
#acceptance_wait_time: 10

# If this is nonzero, the time between reconnection attempts will increase by
# acceptance_wait_time seconds per iteration, up to this maximum. If this is
# set to zero, the time between reconnection attempts will stay constant.
#acceptance_wait_time_max: 0

# If the master rejects the minion\(aqs public key, retry instead of exiting.
# Rejected keys will be handled the same as waiting on acceptance.
#rejected_retry: False

# When the master key changes, the minion will try to re\-auth itself to receive
# the new master key. In larger environments this can cause a SYN flood on the
# master because all minions try to re\-auth immediately. To prevent this and
# have a minion wait for a random amount of time, use this optional parameter.
# The wait\-time will be a random number of seconds between 0 and the defined value.
#random_reauth_delay: 60


# To avoid overloading a master when many minions startup at once, a randomized
# delay may be set to tell the minions to wait before connecting to the master.
# This value is the number of seconds to choose from for a random number. For
# example, setting this value to 60 will choose a random number of seconds to delay
# on startup between zero seconds and sixty seconds. Setting to \(aq0\(aq will disable
# this feature.
#random_startup_delay: 0

# When waiting for a master to accept the minion\(aqs public key, salt will
# continuously attempt to reconnect until successful. This is the timeout value,
# in seconds, for each individual attempt. After this timeout expires, the minion
# will wait for acceptance_wait_time seconds before trying again. Unless your master
# is under unusually heavy load, this should be left at the default.
#auth_timeout: 60

# Number of consecutive SaltReqTimeoutError that are acceptable when trying to
# authenticate.
#auth_tries: 7

# The number of attempts to connect to a master before giving up.
# Set this to \-1 for unlimited attempts. This allows for a master to have
# downtime and the minion to reconnect to it later when it comes back up.
# In \(aqfailover\(aq mode, it is the number of attempts for each set of masters.
# In this mode, it will cycle through the list of masters for each attempt.
#
# This is different than auth_tries because auth_tries attempts to
# retry auth attempts with a single master. auth_tries is under the
# assumption that you can connect to the master but not gain
# authorization from it. master_tries will still cycle through all
# the masters in a given try, so it is appropriate if you expect
# occasional downtime from the master(s).
#master_tries: 1

# If authentication fails due to SaltReqTimeoutError during a ping_interval,
# cause sub minion process to restart.
#auth_safemode: False

# Ping Master to ensure connection is alive (minutes).
#ping_interval: 0

# To auto recover minions if master changes IP address (DDNS)
#    master_alive_interval: 10
#    master_tries: \-1
#
# Minions won\(aqt know master is missing until a ping fails. After the ping fail,
# the minion will attempt authentication and likely fails out and cause a restart.
# When the minion restarts it will resolve the masters IP and attempt to reconnect.

# If you don\(aqt have any problems with syn\-floods, don\(aqt bother with the
# three recon_* settings described below, just leave the defaults!
#
# The ZeroMQ pull\-socket that binds to the masters publishing interface tries
# to reconnect immediately, if the socket is disconnected (for example if
# the master processes are restarted). In large setups this will have all
# minions reconnect immediately which might flood the master (the ZeroMQ\-default
# is usually a 100ms delay). To prevent this, these three recon_* settings
# can be used.
# recon_default: the interval in milliseconds that the socket should wait before
#                trying to reconnect to the master (1000ms = 1 second)
#
# recon_max: the maximum time a socket should wait. each interval the time to wait
#            is calculated by doubling the previous time. if recon_max is reached,
#            it starts again at recon_default. Short example:
#
#            reconnect 1: the socket will wait \(aqrecon_default\(aq milliseconds
#            reconnect 2: \(aqrecon_default\(aq * 2
#            reconnect 3: (\(aqrecon_default\(aq * 2) * 2
#            reconnect 4: value from previous interval * 2
#            reconnect 5: value from previous interval * 2
#            reconnect x: if value >= recon_max, it starts again with recon_default
#
# recon_randomize: generate a random wait time on minion start. The wait time will
#                  be a random value between recon_default and recon_default +
#                  recon_max. Having all minions reconnect with the same recon_default
#                  and recon_max value kind of defeats the purpose of being able to
#                  change these settings. If all minions have the same values and your
#                  setup is quite large (several thousand minions), they will still
#                  flood the master. The desired behavior is to have timeframe within
#                  all minions try to reconnect.
#
# Example on how to use these settings. The goal: have all minions reconnect within a
# 60 second timeframe on a disconnect.
# recon_default: 1000
# recon_max: 59000
# recon_randomize: True
#
# Each minion will have a randomized reconnect value between \(aqrecon_default\(aq
# and \(aqrecon_default + recon_max\(aq, which in this example means between 1000ms
# 60000ms (or between 1 and 60 seconds). The generated random\-value will be
# doubled after each attempt to reconnect. Lets say the generated random
# value is 11 seconds (or 11000ms).
# reconnect 1: wait 11 seconds
# reconnect 2: wait 22 seconds
# reconnect 3: wait 33 seconds
# reconnect 4: wait 44 seconds
# reconnect 5: wait 55 seconds
# reconnect 6: wait time is bigger than 60 seconds (recon_default + recon_max)
# reconnect 7: wait 11 seconds
# reconnect 8: wait 22 seconds
# reconnect 9: wait 33 seconds
# reconnect x: etc.
#
# In a setup with ~6000 hosts these settings would average the reconnects
# to about 100 per second and all hosts would be reconnected within 60 seconds.
# recon_default: 100
# recon_max: 5000
# recon_randomize: False
#
#
# The loop_interval sets how long in seconds the minion will wait between
# evaluating the scheduler and running cleanup tasks.  This defaults to 1
# second on the minion scheduler.
#loop_interval: 1

# Some installations choose to start all job returns in a cache or a returner
# and forgo sending the results back to a master. In this workflow, jobs
# are most often executed with \-\-async from the Salt CLI and then results
# are evaluated by examining job caches on the minions or any configured returners.
# WARNING: Setting this to False will **disable** returns back to the master.
#pub_ret: True


# The grains can be merged, instead of overridden, using this option.
# This allows custom grains to defined different subvalues of a dictionary
# grain. By default this feature is disabled, to enable set grains_deep_merge
# to \(ga\(gaTrue\(ga\(ga.
#grains_deep_merge: False

# The grains_refresh_every setting allows for a minion to periodically check
# its grains to see if they have changed and, if so, to inform the master
# of the new grains. This operation is moderately expensive, therefore
# care should be taken not to set this value too low.
#
# Note: This value is expressed in __minutes__!
#
# A value of 10 minutes is a reasonable default.
#
# If the value is set to zero, this check is disabled.
#grains_refresh_every: 1

# The grains_refresh_pre_exec setting allows for a minion to check its grains
# prior to the execution of any operation to see if they have changed and, if
# so, to inform the master of the new grains. This operation is moderately
# expensive, therefore care should be taken before enabling this behavior.
#grains_refresh_pre_exec: False

# Cache grains on the minion. Default is False.
#grains_cache: False

# Cache rendered pillar data on the minion. Default is False.
# This may cause \(aqcachedir\(aq/pillar to contain sensitive data that should be
# protected accordingly.
#minion_pillar_cache: False

# Grains cache expiration, in seconds. If the cache file is older than this
# number of seconds then the grains cache will be dumped and fully re\-populated
# with fresh data. Defaults to 5 minutes. Will have no effect if \(aqgrains_cache\(aq
# is not enabled.
# grains_cache_expiration: 300

# Determines whether or not the salt minion should run scheduled mine updates.
# Defaults to \(dqTrue\(dq. Set to \(dqFalse\(dq to disable the scheduled mine updates
# (this essentially just does not add the mine update function to the minion\(aqs
# scheduler).
#mine_enabled: True

# Determines whether or not scheduled mine updates should be accompanied by a job
# return for the job cache. Defaults to \(dqFalse\(dq. Set to \(dqTrue\(dq to include job
# returns in the job cache for mine updates.
#mine_return_job: False

# Example functions that can be run via the mine facility
# NO mine functions are established by default.
# Note these can be defined in the minion\(aqs pillar as well.
#mine_functions:
#  test.ping: []
#  network.ip_addrs:
#    interface: eth0
#    cidr: \(aq10.0.0.0/8\(aq

# The number of minutes between mine updates.
#mine_interval: 60

# Windows platforms lack posix IPC and must rely on slower TCP based inter\-
# process communications.  ipc_mode is set to \(aqtcp\(aq on such systems.
#ipc_mode: ipc

# Overwrite the default tcp ports used by the minion when ipc_mode is set to \(aqtcp\(aq
#tcp_pub_port: 4510
#tcp_pull_port: 4511

# Passing very large events can cause the minion to consume large amounts of
# memory. This value tunes the maximum size of a message allowed onto the
# minion event bus. The value is expressed in bytes.
#max_event_size: 1048576

# When a minion starts up it sends a notification on the event bus with a tag
# that looks like this: \(gasalt/minion/<minion_id>/start\(ga. For historical reasons
# the minion also sends a similar event with an event tag like this:
# \(gaminion_start\(ga. This duplication can cause a lot of clutter on the event bus
# when there are many minions. Set \(gaenable_legacy_startup_events: False\(ga in the
# minion config to ensure only the \(gasalt/minion/<minion_id>/start\(ga events are
# sent. Beginning with the \(gaSodium\(ga Salt release this option will default to
# \(gaFalse\(ga
#enable_legacy_startup_events: True

# To detect failed master(s) and fire events on connect/disconnect, set
# master_alive_interval to the number of seconds to poll the masters for
# connection events.
#
#master_alive_interval: 30

# The minion can include configuration from other files. To enable this,
# pass a list of paths to this option. The paths can be either relative or
# absolute; if relative, they are considered to be relative to the directory
# the main minion configuration file lives in (this file). Paths can make use
# of shell\-style globbing. If no files are matched by a path passed to this
# option then the minion will log a warning message.
#
# Include a config file from some other path:
# include: /etc/salt/extra_config
#
# Include config from several files and directories:
#include:
#  \- /etc/salt/extra_config
#  \- /etc/roles/webserver

# The syndic minion can verify that it is talking to the correct master via the
# key fingerprint of the higher\-level master with the \(dqsyndic_finger\(dq config.
#syndic_finger: \(aq\(aq
#
#
#
#####   Minion module management     #####
##########################################
# Disable specific modules. This allows the admin to limit the level of
# access the master has to the minion.  The default here is the empty list,
# below is an example of how this needs to be formatted in the config file
#disable_modules:
#  \- cmdmod
#  \- test
#disable_returners: []

# This is the reverse of disable_modules.  The default, like disable_modules, is the empty list,
# but if this option is set to *anything* then *only* those modules will load.
# Note that this is a very large hammer and it can be quite difficult to keep the minion working
# the way you think it should since Salt uses many modules internally itself.  At a bare minimum
# you need the following enabled or else the minion won\(aqt start.
#whitelist_modules:
#  \- cmdmod
#  \- test
#  \- config

# Modules can be loaded from arbitrary paths. This enables the easy deployment
# of third party modules. Modules for returners and minions can be loaded.
# Specify a list of extra directories to search for minion modules and
# returners. These paths must be fully qualified!
#module_dirs: []
#returner_dirs: []
#states_dirs: []
#render_dirs: []
#utils_dirs: []
#
# A module provider can be statically overwritten or extended for the minion
# via the providers option, in this case the default module will be
# overwritten by the specified module. In this example the pkg module will
# be provided by the yumpkg5 module instead of the system default.
#providers:
#  pkg: yumpkg5
#
# Enable Cython modules searching and loading. (Default: False)
#cython_enable: False
#
# Specify a max size (in bytes) for modules on import. This feature is currently
# only supported on *nix operating systems and requires psutil.
# modules_max_memory: \-1


#####    State Management Settings    #####
###########################################
# The default renderer to use in SLS files. This is configured as a
# pipe\-delimited expression. For example, jinja|yaml will first run jinja
# templating on the SLS file, and then load the result as YAML. This syntax is
# documented in further depth at the following URL:
#
# https://docs.saltproject.io/en/latest/ref/renderers/#composing\-renderers
#
# NOTE: The \(dqshebang\(dq prefix (e.g. \(dq#!jinja|yaml\(dq) described in the
# documentation linked above is for use in an SLS file to override the default
# renderer, it should not be used when configuring the renderer here.
#
#renderer: jinja|yaml
#
# The failhard option tells the minions to stop immediately after the first
# failure detected in the state execution. Defaults to False.
#failhard: False
#
# Reload the modules prior to a highstate run.
#autoload_dynamic_modules: True
#
# clean_dynamic_modules keeps the dynamic modules on the minion in sync with
# the dynamic modules on the master, this means that if a dynamic module is
# not on the master it will be deleted from the minion. By default, this is
# enabled and can be disabled by changing this value to False.
#clean_dynamic_modules: True
#
# Renamed from \(ga\(gaenvironment\(ga\(ga to \(ga\(gasaltenv\(ga\(ga. If \(ga\(gaenvironment\(ga\(ga is used,
# \(ga\(gasaltenv\(ga\(ga will take its value. If both are used, \(ga\(gaenvironment\(ga\(ga will be
# ignored and \(ga\(gasaltenv\(ga\(ga will be used.
# Normally the minion is not isolated to any single environment on the master
# when running states, but the environment can be isolated on the minion side
# by statically setting it. Remember that the recommended way to manage
# environments is to isolate via the top file.
#saltenv: None
#
# Isolates the pillar environment on the minion side. This functions the same
# as the environment setting, but for pillar instead of states.
#pillarenv: None
#
# Set this option to True to force the pillarenv to be the same as the
# effective saltenv when running states. Note that if pillarenv is specified,
# this option will be ignored.
#pillarenv_from_saltenv: False
#
# Set this option to \(aqTrue\(aq to force a \(aqKeyError\(aq to be raised whenever an
# attempt to retrieve a named value from pillar fails. When this option is set
# to \(aqFalse\(aq, the failed attempt returns an empty string. Default is \(aqFalse\(aq.
#pillar_raise_on_missing: False
#
# If using the local file directory, then the state top file name needs to be
# defined, by default this is top.sls.
#state_top: top.sls
#
# Run states when the minion daemon starts. To enable, set startup_states to:
# \(aqhighstate\(aq \-\- Execute state.highstate
# \(aqsls\(aq \-\- Read in the sls_list option and execute the named sls files
# \(aqtop\(aq \-\- Read top_file option and execute based on that file on the Master
#startup_states: \(aq\(aq
#
# List of states to run when the minion starts up if startup_states is \(aqsls\(aq:
#sls_list:
#  \- edit.vim
#  \- hyper
#
# List of grains to pass in start event when minion starts up:
#start_event_grains:
#  \- machine_id
#  \- uuid
#
# Top file to execute if startup_states is \(aqtop\(aq:
#top_file: \(aq\(aq

# Automatically aggregate all states that have support for mod_aggregate by
# setting to True. Or pass a list of state module names to automatically
# aggregate just those types.
#
# state_aggregate:
#   \- pkg
#
#state_aggregate: False

# Instead of failing immediately when another state run is in progress, a value
# of True will queue the new state run to begin running once the other has
# finished. This option starts a new thread for each queued state run, so use
# this option sparingly. Additionally, it can be set to an integer representing
# the maximum queue size which can be attained before the state runs will fail
# to be queued. This can prevent runaway conditions where new threads are
# started until system performance is hampered.
#
#state_queue: False

# Disable requisites during state runs by specifying a single requisite
# or a list of requisites to disable.
#
# disabled_requisites: require_in
#
# disabled_requisites:
#     \- require
#     \- require_in

# If set, this parameter expects a dictionary of state module names as keys
# and list of conditions which must be satisfied in order to run any functions
# in that state module.
#
#global_state_conditions:
#  \(dq*\(dq: [\(dqG@global_noop:false\(dq]
#  service: [\(dqnot G@virtual_subtype:chroot\(dq]

#####     File Directory Settings    #####
##########################################
# The Salt Minion can redirect all file server operations to a local directory,
# this allows for the same state tree that is on the master to be used if
# copied completely onto the minion. This is a literal copy of the settings on
# the master but used to reference a local directory on the minion.

# Set the file client. The client defaults to looking on the master server for
# files, but can be directed to look at the local file directory setting
# defined below by setting it to \(dqlocal\(dq. Setting a local file_client runs the
# minion in masterless mode.
#file_client: remote

# The file directory works on environments passed to the minion, each environment
# can have multiple root directories, the subdirectories in the multiple file
# roots cannot match, otherwise the downloaded files will not be able to be
# reliably ensured. A base environment is required to house the top file.
# Example:
# file_roots:
#   base:
#     \- /srv/salt/
#   dev:
#     \- /srv/salt/dev/services
#     \- /srv/salt/dev/states
#   prod:
#     \- /srv/salt/prod/services
#     \- /srv/salt/prod/states
#
#file_roots:
#  base:
#    \- /srv/salt

# Uncomment the line below if you do not want the file_server to follow
# symlinks when walking the filesystem tree. This is set to True
# by default. Currently this only applies to the default roots
# fileserver_backend.
#fileserver_followsymlinks: False
#
# Uncomment the line below if you do not want symlinks to be
# treated as the files they are pointing to. By default this is set to
# False. By uncommenting the line below, any detected symlink while listing
# files on the Master will not be returned to the Minion.
#fileserver_ignoresymlinks: True
#
# The hash_type is the hash to use when discovering the hash of a file on
# the local fileserver. The default is sha256, but md5, sha1, sha224, sha384
# and sha512 are also supported.
#
# WARNING: While md5 and sha1 are also supported, do not use them due to the
# high chance of possible collisions and thus security breach.
#
# Warning: Prior to changing this value, the minion should be stopped and all
# Salt caches should be cleared.
#hash_type: sha256

# The Salt pillar is searched for locally if file_client is set to local. If
# this is the case, and pillar data is defined, then the pillar_roots need to
# also be configured on the minion:
#pillar_roots:
#  base:
#    \- /srv/pillar

# If this is \(gaTrue\(ga and the ciphertext could not be decrypted, then an error is
# raised.
#gpg_decrypt_must_succeed: False

# Set a hard\-limit on the size of the files that can be pushed to the master.
# It will be interpreted as megabytes. Default: 100
#file_recv_max_size: 100
#
#
######        Security settings       #####
###########################################
# Enable \(dqopen mode\(dq, this mode still maintains encryption, but turns off
# authentication, this is only intended for highly secure environments or for
# the situation where your keys end up in a bad state. If you run in open mode
# you do so at your own risk!
#open_mode: False

# The size of key that should be generated when creating new keys.
#keysize: 2048

# Enable permissive access to the salt keys.  This allows you to run the
# master or minion as root, but have a non\-root group be given access to
# your pki_dir.  To make the access explicit, root must belong to the group
# you\(aqve given access to. This is potentially quite insecure.
#permissive_pki_access: False

# The state_verbose and state_output settings can be used to change the way
# state system data is printed to the display. By default all data is printed.
# The state_verbose setting can be set to True or False, when set to False
# all data that has a result of True and no changes will be suppressed.
#state_verbose: True

# The state_output setting controls which results will be output full multi line
# full, terse \- each state will be full/terse
# mixed \- only states with errors will be full
# changes \- states with changes and errors will be full
# full_id, mixed_id, changes_id and terse_id are also allowed;
# when set, the state ID will be used as name in the output
#state_output: full

# The state_output_diff setting changes whether or not the output from
# successful states is returned. Useful when even the terse output of these
# states is cluttering the logs. Set it to True to ignore them.
#state_output_diff: False

# The state_output_profile setting changes whether profile information
# will be shown for each state run.
#state_output_profile: True

# The state_output_pct setting changes whether success and failure information
# as a percent of total actions will be shown for each state run.
#state_output_pct: False

# The state_compress_ids setting aggregates information about states which have
# multiple \(dqnames\(dq under the same state ID in the highstate output.
#state_compress_ids: False

# Fingerprint of the master public key to validate the identity of your Salt master
# before the initial key exchange. The master fingerprint can be found by running
# \(dqsalt\-key \-f master.pub\(dq on the Salt master.
#master_finger: \(aq\(aq

# Use TLS/SSL encrypted connection between master and minion.
# Can be set to a dictionary containing keyword arguments corresponding to Python\(aqs
# \(aqssl.wrap_socket\(aq method.
# Default is None.
#ssl:
#    keyfile: <path_to_keyfile>
#    certfile: <path_to_certfile>
#    ssl_version: PROTOCOL_TLSv1_2

# Grains to be sent to the master on authentication to check if the minion\(aqs key
# will be accepted automatically. Needs to be configured on the master.
#autosign_grains:
#  \- uuid
#  \- server_id


######        Reactor Settings        #####
###########################################
# Define a salt reactor. See https://docs.saltproject.io/en/latest/topics/reactor/
#reactor: []

#Set the TTL for the cache of the reactor configuration.
#reactor_refresh_interval: 60

#Configure the number of workers for the runner/wheel in the reactor.
#reactor_worker_threads: 10

#Define the queue size for workers in the reactor.
#reactor_worker_hwm: 10000


######         Thread settings        #####
###########################################
# Disable multiprocessing support, by default when a minion receives a
# publication a new process is spawned and the command is executed therein.
#
# WARNING: Disabling multiprocessing may result in substantial slowdowns
# when processing large pillars. See https://github.com/saltstack/salt/issues/38758
# for a full explanation.
#multiprocessing: True

# Limit the maximum amount of processes or threads created by salt\-minion.
# This is useful to avoid resource exhaustion in case the minion receives more
# publications than it is able to handle, as it limits the number of spawned
# processes or threads. \-1 is the default and disables the limit.
#process_count_max: \-1


#####         Logging settings       #####
##########################################
# The location of the minion log file
# The minion log can be sent to a regular file, local path name, or network
# location. Remote logging works best when configured to use rsyslogd(8) (e.g.:
# \(ga\(gafile:///dev/log\(ga\(ga), with rsyslogd(8) configured for network logging. The URI
# format is: <file|udp|tcp>://<host|socketpath>:<port\-if\-required>/<log\-facility>
#log_file: /var/log/salt/minion
#log_file: file:///dev/log
#log_file: udp://loghost:10514
#
#log_file: /var/log/salt/minion
#key_logfile: /var/log/salt/key

# The level of messages to send to the console.
# One of \(aqgarbage\(aq, \(aqtrace\(aq, \(aqdebug\(aq, \(aqinfo\(aq, \(aqwarning\(aq, \(aqerror\(aq, \(aqcritical\(aq.
#
# The following log levels are considered INSECURE and may log sensitive data:
# [\(aqprofile\(aq, \(aqgarbage\(aq, \(aqtrace\(aq, \(aqdebug\(aq, \(aqall\(aq]
#
# Default: \(aqwarning\(aq
#log_level: warning

# The level of messages to send to the log file.
# One of \(aqgarbage\(aq, \(aqtrace\(aq, \(aqdebug\(aq, info\(aq, \(aqwarning\(aq, \(aqerror\(aq, \(aqcritical\(aq.
# If using \(aqlog_granular_levels\(aq this must be set to the highest desired level.
# Default: \(aqwarning\(aq
#log_level_logfile:

# The date and time format used in log messages. Allowed date/time formatting
# can be seen here: http://docs.python.org/library/time.html#time.strftime
#log_datefmt: \(aq%H:%M:%S\(aq
#log_datefmt_logfile: \(aq%Y\-%m\-%d %H:%M:%S\(aq

# The format of the console logging messages. Allowed formatting options can
# be seen here: http://docs.python.org/library/logging.html#logrecord\-attributes
#
# Console log colors are specified by these additional formatters:
#
# %(colorlevel)s
# %(colorname)s
# %(colorprocess)s
# %(colormsg)s
#
# Since it is desirable to include the surrounding brackets, \(aq[\(aq and \(aq]\(aq, in
# the coloring of the messages, these color formatters also include padding as
# well.  Color LogRecord attributes are only available for console logging.
#
#log_fmt_console: \(aq%(colorlevel)s %(colormsg)s\(aq
#log_fmt_console: \(aq[%(levelname)\-8s] %(message)s\(aq
#
#log_fmt_logfile: \(aq%(asctime)s,%(msecs)03d [%(name)\-17s][%(levelname)\-8s] %(message)s\(aq

# This can be used to control logging levels more specificically.  This
# example sets the main salt library at the \(aqwarning\(aq level, but sets
# \(aqsalt.modules\(aq to log at the \(aqdebug\(aq level:
#   log_granular_levels:
#     \(aqsalt\(aq: \(aqwarning\(aq
#     \(aqsalt.modules\(aq: \(aqdebug\(aq
#
#log_granular_levels: {}

# To diagnose issues with minions disconnecting or missing returns, ZeroMQ
# supports the use of monitor sockets to log connection events. This
# feature requires ZeroMQ 4.0 or higher.
#
# To enable ZeroMQ monitor sockets, set \(aqzmq_monitor\(aq to \(aqTrue\(aq and log at a
# debug level or higher.
#
# A sample log event is as follows:
#
# [DEBUG   ] ZeroMQ event: {\(aqendpoint\(aq: \(aqtcp://127.0.0.1:4505\(aq, \(aqevent\(aq: 512,
# \(aqvalue\(aq: 27, \(aqdescription\(aq: \(aqEVENT_DISCONNECTED\(aq}
#
# All events logged will include the string \(aqZeroMQ event\(aq. A connection event
# should be logged as the minion starts up and initially connects to the
# master. If not, check for debug log level and that the necessary version of
# ZeroMQ is installed.
#
#zmq_monitor: False

# Number of times to try to authenticate with the salt master when reconnecting
# to the master
#tcp_authentication_retries: 5

######      Module configuration      #####
###########################################
# Salt allows for modules to be passed arbitrary configuration data, any data
# passed here in valid yaml format will be passed on to the salt minion modules
# for use. It is STRONGLY recommended that a naming convention be used in which
# the module name is followed by a . and then the value. Also, all top level
# data must be applied via the yaml dict construct, some examples:
#
# You can specify that all modules should run in test mode:
#test: True
#
# A simple value for the test module:
#test.foo: foo
#
# A list for the test module:
#test.bar: [baz,quo]
#
# A dict for the test module:
#test.baz: {spam: sausage, cheese: bread}
#
#
######      Update settings          ######
###########################################
# Using the features in Esky, a salt minion can both run as a frozen app and
# be updated on the fly. These options control how the update process
# (saltutil.update()) behaves.
#
# The url for finding and downloading updates. Disabled by default.
#update_url: False
#
# The list of services to restart after a successful update. Empty by default.
#update_restart_services: []


######      Keepalive settings        ######
############################################
# ZeroMQ now includes support for configuring SO_KEEPALIVE if supported by
# the OS. If connections between the minion and the master pass through
# a state tracking device such as a firewall or VPN gateway, there is
# the risk that it could tear down the connection the master and minion
# without informing either party that their connection has been taken away.
# Enabling TCP Keepalives prevents this from happening.

# Overall state of TCP Keepalives, enable (1 or True), disable (0 or False)
# or leave to the OS defaults (\-1), on Linux, typically disabled. Default True, enabled.
#tcp_keepalive: True

# How long before the first keepalive should be sent in seconds. Default 300
# to send the first keepalive after 5 minutes, OS default (\-1) is typically 7200 seconds
# on Linux see /proc/sys/net/ipv4/tcp_keepalive_time.
#tcp_keepalive_idle: 300

# How many lost probes are needed to consider the connection lost. Default \-1
# to use OS defaults, typically 9 on Linux, see /proc/sys/net/ipv4/tcp_keepalive_probes.
#tcp_keepalive_cnt: \-1

# How often, in seconds, to send keepalives after the first one. Default \-1 to
# use OS defaults, typically 75 seconds on Linux, see
# /proc/sys/net/ipv4/tcp_keepalive_intvl.
#tcp_keepalive_intvl: \-1


######   Windows Software settings    ######
############################################
# Location of the repository cache file on the master:
#win_repo_cachefile: \(aqsalt://win/repo/winrepo.p\(aq


######      Returner  settings        ######
############################################
# Default Minion returners. Can be a comma delimited string or a list:
#
#return: mysql
#
#return: mysql,slack,redis
#
#return:
#  \- mysql
#  \- hipchat
#  \- slack


######    Miscellaneous  settings     ######
############################################
# Default match type for filtering events tags: startswith, endswith, find, regex, fnmatch
#event_match_type: startswith

.ft P
.fi
.UNINDENT
.UNINDENT
.SS Example proxy minion configuration file
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
##### Primary configuration settings #####
##########################################
# This configuration file is used to manage the behavior of all Salt Proxy
# Minions on this host.
# With the exception of the location of the Salt Master Server, values that are
# commented out but have an empty line after the comment are defaults that need
# not be set in the config. If there is no blank line after the comment, the
# value is presented as an example and is not the default.

# Per default the proxy minion will automatically include all config files
# from proxy.d/*.conf (proxy.d is a directory in the same directory
# as the main minion config file).
#default_include: proxy.d/*.conf

# Backwards compatibility option for proxymodules created before 2015.8.2
# This setting will default to \(aqFalse\(aq in the 2016.3.0 release
# Setting this to True adds proxymodules to the __opts__ dictionary.
# This breaks several Salt features (basically anything that serializes
# __opts__ over the wire) but retains backwards compatibility.
#add_proxymodule_to_opts: True

# Set the location of the salt master server. If the master server cannot be
# resolved, then the minion will fail to start.
#master: salt

# If a proxymodule has a function called \(aqgrains\(aq, then call it during
# regular grains loading and merge the results with the proxy\(aqs grains
# dictionary.  Otherwise it is assumed that the module calls the grains
# function in a custom way and returns the data elsewhere
#
# Default to False for 2016.3 and 2016.11. Switch to True for 2017.7.0.
# proxy_merge_grains_in_module: True

# If a proxymodule has a function called \(aqalive\(aq returning a boolean
# flag reflecting the state of the connection with the remove device,
# when this option is set as True, a scheduled job on the proxy will
# try restarting the connection. The polling frequency depends on the
# next option, \(aqproxy_keep_alive_interval\(aq. Added in 2017.7.0.
# proxy_keep_alive: True

# The polling interval (in minutes) to check if the underlying connection
# with the remote device is still alive. This option requires
# \(aqproxy_keep_alive\(aq to be configured as True and the proxymodule to
# implement the \(aqalive\(aq function. Added in 2017.7.0.
# proxy_keep_alive_interval: 1

# By default, any proxy opens the connection with the remote device when
# initialized. Some proxymodules allow through this option to open/close
# the session per command. This requires the proxymodule to have this
# capability. Please consult the documentation to see if the proxy type
# used can be that flexible. Added in 2017.7.0.
# proxy_always_alive: True

# If multiple masters are specified in the \(aqmaster\(aq setting, the default behavior
# is to always try to connect to them in the order they are listed. If random_master is
# set to True, the order will be randomized instead. This can be helpful in distributing
# the load of many minions executing salt\-call requests, for example, from a cron job.
# If only one master is listed, this setting is ignored and a warning will be logged.
#random_master: False

# Minions can connect to multiple masters simultaneously (all masters
# are \(dqhot\(dq), or can be configured to failover if a master becomes
# unavailable.  Multiple hot masters are configured by setting this
# value to \(dqstr\(dq.  Failover masters can be requested by setting
# to \(dqfailover\(dq.  MAKE SURE TO SET master_alive_interval if you are
# using failover.
# master_type: str

# Poll interval in seconds for checking if the master is still there.  Only
# respected if master_type above is \(dqfailover\(dq.
# master_alive_interval: 30

# Set whether the minion should connect to the master via IPv6:
#ipv6: False

# Set the number of seconds to wait before attempting to resolve
# the master hostname if name resolution fails. Defaults to 30 seconds.
# Set to zero if the minion should shutdown and not retry.
# retry_dns: 30

# Set the port used by the master reply and authentication server.
#master_port: 4506

# The user to run salt.
#user: root

# Setting sudo_user will cause salt to run all execution modules under an sudo
# to the user given in sudo_user.  The user under which the salt minion process
# itself runs will still be that provided in the user config above, but all
# execution modules run by the minion will be rerouted through sudo.
#sudo_user: saltdev

# Specify the location of the daemon process ID file.
#pidfile: /var/run/salt\-minion.pid

# The root directory prepended to these options: pki_dir, cachedir, log_file,
# sock_dir, pidfile.
#root_dir: /

# The directory to store the pki information in
#pki_dir: /etc/salt/pki/minion

# Where cache data goes.
# This data may contain sensitive data and should be protected accordingly.
#cachedir: /var/cache/salt/minion

# Append minion_id to these directories.  Helps with
# multiple proxies and minions running on the same machine.
# Allowed elements in the list: pki_dir, cachedir, extension_modules
# Normally not needed unless running several proxies and/or minions on the same machine
# Defaults to [\(aqcachedir\(aq] for proxies, [] (empty list) for regular minions
# append_minionid_config_dirs:
#   \- cachedir



# Verify and set permissions on configuration directories at startup.
#verify_env: True

# The minion can locally cache the return data from jobs sent to it, this
# can be a good way to keep track of jobs the minion has executed
# (on the minion side). By default this feature is disabled, to enable, set
# cache_jobs to True.
#cache_jobs: False

# Set the directory used to hold unix sockets.
#sock_dir: /var/run/salt/minion

# Set the default outputter used by the salt\-call command. The default is
# \(dqnested\(dq.
#output: nested
#
# By default output is colored. To disable colored output, set the color value
# to False.
#color: True

# Do not strip off the colored output from nested results and state outputs
# (true by default).
# strip_colors: False

# Backup files that are replaced by file.managed and file.recurse under
# \(aqcachedir\(aq/file_backup relative to their original location and appended
# with a timestamp. The only valid setting is \(dqminion\(dq. Disabled by default.
#
# Alternatively this can be specified for each file in state files:
# /etc/ssh/sshd_config:
#   file.managed:
#     \- source: salt://ssh/sshd_config
#     \- backup: minion
#
#backup_mode: minion

# When waiting for a master to accept the minion\(aqs public key, salt will
# continuously attempt to reconnect until successful. This is the time, in
# seconds, between those reconnection attempts.
#acceptance_wait_time: 10

# If this is nonzero, the time between reconnection attempts will increase by
# acceptance_wait_time seconds per iteration, up to this maximum. If this is
# set to zero, the time between reconnection attempts will stay constant.
#acceptance_wait_time_max: 0

# If the master rejects the minion\(aqs public key, retry instead of exiting.
# Rejected keys will be handled the same as waiting on acceptance.
#rejected_retry: False

# When the master key changes, the minion will try to re\-auth itself to receive
# the new master key. In larger environments this can cause a SYN flood on the
# master because all minions try to re\-auth immediately. To prevent this and
# have a minion wait for a random amount of time, use this optional parameter.
# The wait\-time will be a random number of seconds between 0 and the defined value.
#random_reauth_delay: 60

# When waiting for a master to accept the minion\(aqs public key, salt will
# continuously attempt to reconnect until successful. This is the timeout value,
# in seconds, for each individual attempt. After this timeout expires, the minion
# will wait for acceptance_wait_time seconds before trying again. Unless your master
# is under unusually heavy load, this should be left at the default.
#auth_timeout: 60

# Number of consecutive SaltReqTimeoutError that are acceptable when trying to
# authenticate.
#auth_tries: 7

# If authentication fails due to SaltReqTimeoutError during a ping_interval,
# cause sub minion process to restart.
#auth_safemode: False

# Ping Master to ensure connection is alive (minutes).
#ping_interval: 0

# To auto recover minions if master changes IP address (DDNS)
#    auth_tries: 10
#    auth_safemode: False
#    ping_interval: 90
#
# Minions won\(aqt know master is missing until a ping fails. After the ping fail,
# the minion will attempt authentication and likely fails out and cause a restart.
# When the minion restarts it will resolve the masters IP and attempt to reconnect.

# If you don\(aqt have any problems with syn\-floods, don\(aqt bother with the
# three recon_* settings described below, just leave the defaults!
#
# The ZeroMQ pull\-socket that binds to the masters publishing interface tries
# to reconnect immediately, if the socket is disconnected (for example if
# the master processes are restarted). In large setups this will have all
# minions reconnect immediately which might flood the master (the ZeroMQ\-default
# is usually a 100ms delay). To prevent this, these three recon_* settings
# can be used.
# recon_default: the interval in milliseconds that the socket should wait before
#                trying to reconnect to the master (1000ms = 1 second)
#
# recon_max: the maximum time a socket should wait. each interval the time to wait
#            is calculated by doubling the previous time. if recon_max is reached,
#            it starts again at recon_default. Short example:
#
#            reconnect 1: the socket will wait \(aqrecon_default\(aq milliseconds
#            reconnect 2: \(aqrecon_default\(aq * 2
#            reconnect 3: (\(aqrecon_default\(aq * 2) * 2
#            reconnect 4: value from previous interval * 2
#            reconnect 5: value from previous interval * 2
#            reconnect x: if value >= recon_max, it starts again with recon_default
#
# recon_randomize: generate a random wait time on minion start. The wait time will
#                  be a random value between recon_default and recon_default +
#                  recon_max. Having all minions reconnect with the same recon_default
#                  and recon_max value kind of defeats the purpose of being able to
#                  change these settings. If all minions have the same values and your
#                  setup is quite large (several thousand minions), they will still
#                  flood the master. The desired behavior is to have timeframe within
#                  all minions try to reconnect.
#
# Example on how to use these settings. The goal: have all minions reconnect within a
# 60 second timeframe on a disconnect.
# recon_default: 1000
# recon_max: 59000
# recon_randomize: True
#
# Each minion will have a randomized reconnect value between \(aqrecon_default\(aq
# and \(aqrecon_default + recon_max\(aq, which in this example means between 1000ms
# 60000ms (or between 1 and 60 seconds). The generated random\-value will be
# doubled after each attempt to reconnect. Lets say the generated random
# value is 11 seconds (or 11000ms).
# reconnect 1: wait 11 seconds
# reconnect 2: wait 22 seconds
# reconnect 3: wait 33 seconds
# reconnect 4: wait 44 seconds
# reconnect 5: wait 55 seconds
# reconnect 6: wait time is bigger than 60 seconds (recon_default + recon_max)
# reconnect 7: wait 11 seconds
# reconnect 8: wait 22 seconds
# reconnect 9: wait 33 seconds
# reconnect x: etc.
#
# In a setup with ~6000 thousand hosts these settings would average the reconnects
# to about 100 per second and all hosts would be reconnected within 60 seconds.
# recon_default: 100
# recon_max: 5000
# recon_randomize: False
#
#
# The loop_interval sets how long in seconds the minion will wait between
# evaluating the scheduler and running cleanup tasks. This defaults to a
# sane 60 seconds, but if the minion scheduler needs to be evaluated more
# often lower this value
#loop_interval: 60

# The grains_refresh_every setting allows for a minion to periodically check
# its grains to see if they have changed and, if so, to inform the master
# of the new grains. This operation is moderately expensive, therefore
# care should be taken not to set this value too low.
#
# Note: This value is expressed in __minutes__!
#
# A value of 10 minutes is a reasonable default.
#
# If the value is set to zero, this check is disabled.
#grains_refresh_every: 1

# Cache grains on the minion. Default is False.
#grains_cache: False

# Grains cache expiration, in seconds. If the cache file is older than this
# number of seconds then the grains cache will be dumped and fully re\-populated
# with fresh data. Defaults to 5 minutes. Will have no effect if \(aqgrains_cache\(aq
# is not enabled.
# grains_cache_expiration: 300

# Windows platforms lack posix IPC and must rely on slower TCP based inter\-
# process communications. Set ipc_mode to \(aqtcp\(aq on such systems
#ipc_mode: ipc

# Overwrite the default tcp ports used by the minion when in tcp mode
#tcp_pub_port: 4510
#tcp_pull_port: 4511

# Passing very large events can cause the minion to consume large amounts of
# memory. This value tunes the maximum size of a message allowed onto the
# minion event bus. The value is expressed in bytes.
#max_event_size: 1048576

# To detect failed master(s) and fire events on connect/disconnect, set
# master_alive_interval to the number of seconds to poll the masters for
# connection events.
#
#master_alive_interval: 30

# The minion can include configuration from other files. To enable this,
# pass a list of paths to this option. The paths can be either relative or
# absolute; if relative, they are considered to be relative to the directory
# the main minion configuration file lives in (this file). Paths can make use
# of shell\-style globbing. If no files are matched by a path passed to this
# option then the minion will log a warning message.
#
# Include a config file from some other path:
# include: /etc/salt/extra_config
#
# Include config from several files and directories:
#include:
#  \- /etc/salt/extra_config
#  \- /etc/roles/webserver
#
#
#
#####   Minion module management     #####
##########################################
# Disable specific modules. This allows the admin to limit the level of
# access the master has to the minion.
#disable_modules: [cmd,test]
#disable_returners: []
#
# Modules can be loaded from arbitrary paths. This enables the easy deployment
# of third party modules. Modules for returners and minions can be loaded.
# Specify a list of extra directories to search for minion modules and
# returners. These paths must be fully qualified!
#module_dirs: []
#returner_dirs: []
#states_dirs: []
#render_dirs: []
#utils_dirs: []
#
# A module provider can be statically overwritten or extended for the minion
# via the providers option, in this case the default module will be
# overwritten by the specified module. In this example the pkg module will
# be provided by the yumpkg5 module instead of the system default.
#providers:
#  pkg: yumpkg5
#
# Enable Cython modules searching and loading. (Default: False)
#cython_enable: False
#
# Specify a max size (in bytes) for modules on import. This feature is currently
# only supported on *nix operating systems and requires psutil.
# modules_max_memory: \-1


#####    State Management Settings    #####
###########################################
# The default renderer to use in SLS files. This is configured as a
# pipe\-delimited expression. For example, jinja|yaml will first run jinja
# templating on the SLS file, and then load the result as YAML. This syntax is
# documented in further depth at the following URL:
#
# https://docs.saltproject.io/en/latest/ref/renderers/#composing\-renderers
#
# NOTE: The \(dqshebang\(dq prefix (e.g. \(dq#!jinja|yaml\(dq) described in the
# documentation linked above is for use in an SLS file to override the default
# renderer, it should not be used when configuring the renderer here.
#
#renderer: jinja|yaml
#
# The failhard option tells the minions to stop immediately after the first
# failure detected in the state execution. Defaults to False.
#failhard: False
#
# Reload the modules prior to a highstate run.
#autoload_dynamic_modules: True
#
# clean_dynamic_modules keeps the dynamic modules on the minion in sync with
# the dynamic modules on the master, this means that if a dynamic module is
# not on the master it will be deleted from the minion. By default, this is
# enabled and can be disabled by changing this value to False.
#clean_dynamic_modules: True
#
# Normally, the minion is not isolated to any single environment on the master
# when running states, but the environment can be isolated on the minion side
# by statically setting it. Remember that the recommended way to manage
# environments is to isolate via the top file.
#environment: None
#
# If using the local file directory, then the state top file name needs to be
# defined, by default this is top.sls.
#state_top: top.sls
#
# Run states when the minion daemon starts. To enable, set startup_states to:
# \(aqhighstate\(aq \-\- Execute state.highstate
# \(aqsls\(aq \-\- Read in the sls_list option and execute the named sls files
# \(aqtop\(aq \-\- Read top_file option and execute based on that file on the Master
#startup_states: \(aq\(aq
#
# List of states to run when the minion starts up if startup_states is \(aqsls\(aq:
#sls_list:
#  \- edit.vim
#  \- hyper
#
# Top file to execute if startup_states is \(aqtop\(aq:
#top_file: \(aq\(aq

# Automatically aggregate all states that have support for mod_aggregate by
# setting to True. Or pass a list of state module names to automatically
# aggregate just those types.
#
# state_aggregate:
#   \- pkg
#
#state_aggregate: False

#####     File Directory Settings    #####
##########################################
# The Salt Minion can redirect all file server operations to a local directory,
# this allows for the same state tree that is on the master to be used if
# copied completely onto the minion. This is a literal copy of the settings on
# the master but used to reference a local directory on the minion.

# Set the file client. The client defaults to looking on the master server for
# files, but can be directed to look at the local file directory setting
# defined below by setting it to \(dqlocal\(dq. Setting a local file_client runs the
# minion in masterless mode.
#file_client: remote

# The file directory works on environments passed to the minion, each environment
# can have multiple root directories, the subdirectories in the multiple file
# roots cannot match, otherwise the downloaded files will not be able to be
# reliably ensured. A base environment is required to house the top file.
# Example:
# file_roots:
#   base:
#     \- /srv/salt/
#   dev:
#     \- /srv/salt/dev/services
#     \- /srv/salt/dev/states
#   prod:
#     \- /srv/salt/prod/services
#     \- /srv/salt/prod/states
#
#file_roots:
#  base:
#    \- /srv/salt

# The hash_type is the hash to use when discovering the hash of a file in
# the local fileserver. The default is sha256 but sha224, sha384 and sha512
# are also supported.
#
# WARNING: While md5 and sha1 are also supported, do not use it due to the high chance
# of possible collisions and thus security breach.
#
# WARNING: While md5 is also supported, do not use it due to the high chance
# of possible collisions and thus security breach.
#
# Warning: Prior to changing this value, the minion should be stopped and all
# Salt caches should be cleared.
#hash_type: sha256

# The Salt pillar is searched for locally if file_client is set to local. If
# this is the case, and pillar data is defined, then the pillar_roots need to
# also be configured on the minion:
#pillar_roots:
#  base:
#    \- /srv/pillar
#
#
######        Security settings       #####
###########################################
# Enable \(dqopen mode\(dq, this mode still maintains encryption, but turns off
# authentication, this is only intended for highly secure environments or for
# the situation where your keys end up in a bad state. If you run in open mode
# you do so at your own risk!
#open_mode: False

# Enable permissive access to the salt keys.  This allows you to run the
# master or minion as root, but have a non\-root group be given access to
# your pki_dir.  To make the access explicit, root must belong to the group
# you\(aqve given access to. This is potentially quite insecure.
#permissive_pki_access: False

# The state_verbose and state_output settings can be used to change the way
# state system data is printed to the display. By default all data is printed.
# The state_verbose setting can be set to True or False, when set to False
# all data that has a result of True and no changes will be suppressed.
#state_verbose: True

# The state_output setting controls which results will be output full multi line
# full, terse \- each state will be full/terse
# mixed \- only states with errors will be full
# changes \- states with changes and errors will be full
# full_id, mixed_id, changes_id and terse_id are also allowed;
# when set, the state ID will be used as name in the output
#state_output: full

# The state_output_diff setting changes whether or not the output from
# successful states is returned. Useful when even the terse output of these
# states is cluttering the logs. Set it to True to ignore them.
#state_output_diff: False

# The state_output_profile setting changes whether profile information
# will be shown for each state run.
#state_output_profile: True

# The state_output_pct setting changes whether success and failure information
# as a percent of total actions will be shown for each state run.
#state_output_pct: False

# The state_compress_ids setting aggregates information about states which have
# multiple \(dqnames\(dq under the same state ID in the highstate output.
#state_compress_ids: False

# Fingerprint of the master public key to validate the identity of your Salt master
# before the initial key exchange. The master fingerprint can be found by running
# \(dqsalt\-key \-F master\(dq on the Salt master.
#master_finger: \(aq\(aq


######         Thread settings        #####
###########################################
# Disable multiprocessing support, by default when a minion receives a
# publication a new process is spawned and the command is executed therein.
#multiprocessing: True


#####         Logging settings       #####
##########################################
# The location of the minion log file
# The minion log can be sent to a regular file, local path name, or network
# location. Remote logging works best when configured to use rsyslogd(8) (e.g.:
# \(ga\(gafile:///dev/log\(ga\(ga), with rsyslogd(8) configured for network logging. The URI
# format is: <file|udp|tcp>://<host|socketpath>:<port\-if\-required>/<log\-facility>
#log_file: /var/log/salt/minion
#log_file: file:///dev/log
#log_file: udp://loghost:10514
#
#log_file: /var/log/salt/minion
#key_logfile: /var/log/salt/key

# The level of messages to send to the console.
# One of \(aqgarbage\(aq, \(aqtrace\(aq, \(aqdebug\(aq, \(aqinfo\(aq, \(aqwarning\(aq, \(aqerror\(aq, \(aqcritical\(aq.
#
# The following log levels are considered INSECURE and may log sensitive data:
# [\(aqprofile\(aq, \(aqgarbage\(aq, \(aqtrace\(aq, \(aqdebug\(aq, \(aqall\(aq]
#
# Default: \(aqwarning\(aq
#log_level: warning

# The level of messages to send to the log file.
# One of \(aqgarbage\(aq, \(aqtrace\(aq, \(aqdebug\(aq, info\(aq, \(aqwarning\(aq, \(aqerror\(aq, \(aqcritical\(aq.
# If using \(aqlog_granular_levels\(aq this must be set to the highest desired level.
# Default: \(aqwarning\(aq
#log_level_logfile:

# The date and time format used in log messages. Allowed date/time formatting
# can be seen here: http://docs.python.org/library/time.html#time.strftime
#log_datefmt: \(aq%H:%M:%S\(aq
#log_datefmt_logfile: \(aq%Y\-%m\-%d %H:%M:%S\(aq

# The format of the console logging messages. Allowed formatting options can
# be seen here: http://docs.python.org/library/logging.html#logrecord\-attributes
#
# Console log colors are specified by these additional formatters:
#
# %(colorlevel)s
# %(colorname)s
# %(colorprocess)s
# %(colormsg)s
#
# Since it is desirable to include the surrounding brackets, \(aq[\(aq and \(aq]\(aq, in
# the coloring of the messages, these color formatters also include padding as
# well.  Color LogRecord attributes are only available for console logging.
#
#log_fmt_console: \(aq%(colorlevel)s %(colormsg)s\(aq
#log_fmt_console: \(aq[%(levelname)\-8s] %(message)s\(aq
#
#log_fmt_logfile: \(aq%(asctime)s,%(msecs)03d [%(name)\-17s][%(levelname)\-8s] %(message)s\(aq

# This can be used to control logging levels more specificically.  This
# example sets the main salt library at the \(aqwarning\(aq level, but sets
# \(aqsalt.modules\(aq to log at the \(aqdebug\(aq level:
#   log_granular_levels:
#     \(aqsalt\(aq: \(aqwarning\(aq
#     \(aqsalt.modules\(aq: \(aqdebug\(aq
#
#log_granular_levels: {}

# To diagnose issues with minions disconnecting or missing returns, ZeroMQ
# supports the use of monitor sockets # to log connection events. This
# feature requires ZeroMQ 4.0 or higher.
#
# To enable ZeroMQ monitor sockets, set \(aqzmq_monitor\(aq to \(aqTrue\(aq and log at a
# debug level or higher.
#
# A sample log event is as follows:
#
# [DEBUG   ] ZeroMQ event: {\(aqendpoint\(aq: \(aqtcp://127.0.0.1:4505\(aq, \(aqevent\(aq: 512,
# \(aqvalue\(aq: 27, \(aqdescription\(aq: \(aqEVENT_DISCONNECTED\(aq}
#
# All events logged will include the string \(aqZeroMQ event\(aq. A connection event
# should be logged on the as the minion starts up and initially connects to the
# master. If not, check for debug log level and that the necessary version of
# ZeroMQ is installed.
#
#zmq_monitor: False

######      Module configuration      #####
###########################################
# Salt allows for modules to be passed arbitrary configuration data, any data
# passed here in valid yaml format will be passed on to the salt minion modules
# for use. It is STRONGLY recommended that a naming convention be used in which
# the module name is followed by a . and then the value. Also, all top level
# data must be applied via the yaml dict construct, some examples:
#
# You can specify that all modules should run in test mode:
#test: True
#
# A simple value for the test module:
#test.foo: foo
#
# A list for the test module:
#test.bar: [baz,quo]
#
# A dict for the test module:
#test.baz: {spam: sausage, cheese: bread}
#
#
######      Update settings          ######
###########################################
# Using the features in Esky, a salt minion can both run as a frozen app and
# be updated on the fly. These options control how the update process
# (saltutil.update()) behaves.
#
# The url for finding and downloading updates. Disabled by default.
#update_url: False
#
# The list of services to restart after a successful update. Empty by default.
#update_restart_services: []


######      Keepalive settings        ######
############################################
# ZeroMQ now includes support for configuring SO_KEEPALIVE if supported by
# the OS. If connections between the minion and the master pass through
# a state tracking device such as a firewall or VPN gateway, there is
# the risk that it could tear down the connection the master and minion
# without informing either party that their connection has been taken away.
# Enabling TCP Keepalives prevents this from happening.

# Overall state of TCP Keepalives, enable (1 or True), disable (0 or False)
# or leave to the OS defaults (\-1), on Linux, typically disabled. Default True, enabled.
#tcp_keepalive: True

# How long before the first keepalive should be sent in seconds. Default 300
# to send the first keepalive after 5 minutes, OS default (\-1) is typically 7200 seconds
# on Linux see /proc/sys/net/ipv4/tcp_keepalive_time.
#tcp_keepalive_idle: 300

# How many lost probes are needed to consider the connection lost. Default \-1
# to use OS defaults, typically 9 on Linux, see /proc/sys/net/ipv4/tcp_keepalive_probes.
#tcp_keepalive_cnt: \-1

# How often, in seconds, to send keepalives after the first one. Default \-1 to
# use OS defaults, typically 75 seconds on Linux, see
# /proc/sys/net/ipv4/tcp_keepalive_intvl.
#tcp_keepalive_intvl: \-1


######   Windows Software settings    ######
############################################
# Location of the repository cache file on the master:
#win_repo_cachefile: \(aqsalt://win/repo/winrepo.p\(aq


######      Returner  settings        ######
############################################
# Which returner(s) will be used for minion\(aqs result:
#return: mysql

.ft P
.fi
.UNINDENT
.UNINDENT
.SS Minion Blackout Configuration
.sp
New in version 2016.3.0.

.sp
Salt supports minion blackouts. When a minion is in blackout mode, all remote
execution commands are disabled. This allows production minions to be put
\(dqon hold\(dq, eliminating the risk of an untimely configuration change.
.sp
Minion blackouts are configured via a special pillar key, \fBminion_blackout\fP\&.
If this key is set to \fBTrue\fP, then the minion will reject all incoming
commands, except for \fBsaltutil.refresh_pillar\fP\&. (The exception is important,
so minions can be brought out of blackout mode)
.sp
Salt also supports an explicit whitelist of additional functions that will be
allowed during blackout. This is configured with the special pillar key
\fBminion_blackout_whitelist\fP, which is formed as a list:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minion_blackout_whitelist:
 \- test.version
 \- pillar.get
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Access Control System
.sp
New in version 0.10.4.

.sp
Salt maintains a standard system used to open granular control to non
administrative users to execute Salt commands. The access control system
has been applied to all systems used to configure access to non administrative
control interfaces in Salt.
.sp
These interfaces include, the \fBpeer\fP system, the
\fBexternal auth\fP system and the \fBpublisher acl\fP system.
.sp
The access control system mandated a standard configuration syntax used in
all of the three aforementioned systems. While this adds functionality to the
configuration in 0.10.4, it does not negate the old configuration.
.sp
Now specific functions can be opened up to specific minions from specific users
in the case of external auth and publisher ACLs, and for specific minions in the
case of the peer system.
.SS Publisher ACL system
.sp
The salt publisher ACL system is a means to allow system users other than root
to have access to execute select salt commands on minions from the master.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBpublisher_acl\fP is useful for allowing local system users to run Salt
commands without giving them root access. If you can log into the Salt
master directly, then \fBpublisher_acl\fP allows you to use Salt without
root privileges. If the local system is configured to authenticate against
a remote system, like LDAP or Active Directory, then \fBpublisher_acl\fP will
interact with the remote system transparently.
.sp
\fBexternal_auth\fP is useful for \fBsalt\-api\fP or for making your own scripts
that use Salt\(aqs Python API. It can be used at the CLI (with the \fB\-a\fP
flag) but it is more cumbersome as there are more steps involved.  The only
time it is useful at the CLI is when the local system is \fInot\fP configured
to authenticate against an external service \fIbut\fP you still want Salt to
authenticate against an external service.
.sp
For more information and examples, see \fI\%this Access Control System\fP section.
.UNINDENT
.UNINDENT
.sp
The publisher ACL system is configured in the master configuration file via the
\fBpublisher_acl\fP configuration option. Under the \fBpublisher_acl\fP
configuration option the users open to send commands are specified and then a
list of the minion functions which will be made available to specified user.
Both users and functions could be specified by exact match, shell glob or
regular expression. This configuration is much like the \fI\%external_auth\fP configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publisher_acl:
  # Allow thatch to execute anything.
  thatch:
    \- .*
  # Allow fred to use test and pkg, but only on \(dqweb*\(dq minions.
  fred:
    \- web*:
      \- test.*
      \- pkg.*
  # Allow admin and managers to use saltutil module functions
  admin|manager_.*:
    \- saltutil.*
  # Allow users to use only my_mod functions on \(dqweb*\(dq minions with specific arguments.
  user_.*:
    \- web*:
      \- \(aqmy_mod.*\(aq:
          args:
            \- \(aqa.*\(aq
            \- \(aqb.*\(aq
          kwargs:
            \(aqkwa\(aq: \(aqkwa.*\(aq
            \(aqkwb\(aq: \(aqkwb\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Permission Issues
.sp
Directories required for \fBpublisher_acl\fP must be modified to be readable by
the users specified:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
chmod 755 /var/cache/salt /var/cache/salt/master /var/cache/salt/master/jobs /var/run/salt /var/run/salt/master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In addition to the changes above you will also need to modify the
permissions of /var/log/salt and the existing log file to be writable by
the user(s) which will be running the commands. If you do not wish to do
this then you must disable logging or Salt will generate errors as it
cannot write to the logs as the system users.
.UNINDENT
.UNINDENT
.sp
If you are upgrading from earlier versions of salt you must also remove any
existing user keys and re\-start the Salt master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rm /var/cache/salt/.*key
service salt\-master restart
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Whitelist and Blacklist
.sp
Salt\(aqs authentication systems can be configured by specifying what is allowed
using a whitelist, or by specifying what is disallowed using a blacklist. If
you specify a whitelist, only specified operations are allowed. If you specify
a blacklist, all operations are allowed except those that are blacklisted.
.sp
See \fI\%publisher_acl\fP and \fI\%publisher_acl_blacklist\fP\&.
.SS External Authentication System
.sp
Salt\(aqs External Authentication System (eAuth) allows for Salt to pass through
command authorization to any external authentication system, such as PAM or LDAP.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
eAuth using the PAM external auth system requires salt\-master to be run as
root as this system needs root access to check authentication.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBpublisher_acl\fP is useful for allowing local system users to run Salt
commands without giving them root access. If you can log into the Salt
master directly, then \fBpublisher_acl\fP allows you to use Salt without
root privileges. If the local system is configured to authenticate against
a remote system, like LDAP or Active Directory, then \fBpublisher_acl\fP will
interact with the remote system transparently.
.sp
\fBexternal_auth\fP is useful for \fBsalt\-api\fP or for making your own scripts
that use Salt\(aqs Python API. It can be used at the CLI (with the \fB\-a\fP
flag) but it is more cumbersome as there are more steps involved.  The only
time it is useful at the CLI is when the local system is \fInot\fP configured
to authenticate against an external service \fIbut\fP you still want Salt to
authenticate against an external service.
.sp
For more information and examples, see \fI\%this Access Control System\fP section.
.UNINDENT
.UNINDENT
.SS External Authentication System Configuration
.sp
The external authentication system allows for specific users to be granted
access to execute specific functions on specific minions. Access is configured
in the master configuration file and uses the \fI\%access control system\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  pam:
    thatch:
      \- \(aqweb*\(aq:
        \- test.*
        \- network.*
    steve|admin.*:
      \- .*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above configuration allows the user \fBthatch\fP to execute functions in the
test and network modules on the minions that match the web* target.  User
\fBsteve\fP and the users whose logins start with \fBadmin\fP, are granted
unrestricted access to minion commands.
.sp
Salt respects the current PAM configuration in place, and uses the \(aqlogin\(aq
service to authenticate.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The PAM module does not allow authenticating as \fBroot\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
state.sls and state.highstate will return \(dqFailed to authenticate!\(dq
if the request timeout is reached.  Use \-t flag to increase the timeout
.UNINDENT
.UNINDENT
.sp
To allow access to \fI\%wheel modules\fP or \fI\%runner
modules\fP the following \fB@\fP syntax must be used:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  pam:
    thatch:
      \- \(aq@wheel\(aq   # to allow access to all wheel modules
      \- \(aq@runner\(aq  # to allow access to all runner modules
      \- \(aq@jobs\(aq    # to allow access to the jobs runner and/or wheel module
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The runner/wheel markup is different, since there are no minions to scope the
acl to.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Globs will not match wheel or runners! They must be explicitly
allowed with @wheel or @runner.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
All users that have external authentication privileges are allowed to run
\fI\%saltutil.findjob\fP\&. Be aware
that this could inadvertently expose some data such as minion IDs.
.UNINDENT
.UNINDENT
.SS Matching syntax
.sp
The structure of the \fBexternal_auth\fP dictionary can take the following
shapes. User and function matches are exact matches, shell glob patterns or
regular expressions; minion matches are compound targets.
.sp
By user:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  <eauth backend>:
    <user or group%>:
      \- <regex to match function>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By user, by minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  <eauth backend>:
    <user or group%>:
      <minion compound target>:
        \- <regex to match function>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By user, by runner/wheel:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  <eauth backend>:
    <user or group%>:
      <@runner or @wheel>:
        \- <regex to match function>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By user, by runner+wheel module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  <eauth backend>:
    <user or group%>:
      <@module_name>:
        \- <regex to match function without module_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Groups
.sp
To apply permissions to a group of users in an external authentication system,
append a \fB%\fP to the ID:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  pam:
    admins%:
      \- \(aq*\(aq:
        \- \(aqpkg.*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Limiting by function arguments
.sp
Positional arguments or keyword arguments to functions can also be whitelisted.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  pam:
    my_user:
      \- \(aq*\(aq:
        \- \(aqmy_mod.*\(aq:
            args:
              \- \(aqa.*\(aq
              \- \(aqb.*\(aq
            kwargs:
              \(aqkwa\(aq: \(aqkwa.*\(aq
              \(aqkwb\(aq: \(aqkwb\(aq
      \- \(aq@runner\(aq:
        \- \(aqrunner_mod.*\(aq:
            args:
            \- \(aqa.*\(aq
            \- \(aqb.*\(aq
            kwargs:
              \(aqkwa\(aq: \(aqkwa.*\(aq
              \(aqkwb\(aq: \(aqkwb\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The rules:
.INDENT 0.0
.IP 1. 3
The arguments values are matched as regexp.
.IP 2. 3
If arguments restrictions are specified the only matched are allowed.
.IP 3. 3
If an argument isn\(aqt specified any value is allowed.
.IP 4. 3
To skip an arg use \(dqeverything\(dq regexp \fB\&.*\fP\&. I.e. if \fBarg0\fP and \fBarg2\fP
should be limited but \fBarg1\fP and other arguments could have any value use:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
args:
  \- \(aqvalue0\(aq
  \- \(aq.*\(aq
  \- \(aqvalue2\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Usage
.sp
The external authentication system can then be used from the command\-line by
any user on the same system as the master with the \fB\-a\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt \-a pam web\e* test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The system will ask the user for the credentials required by the
authentication system and then publish the command.
.SS Tokens
.sp
With external authentication alone, the authentication credentials will be
required with every call to Salt. This can be alleviated with Salt tokens.
.sp
Tokens are short term authorizations and can be easily created by just
adding a \fB\-T\fP option when authenticating:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt \-T \-a pam web\e* test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now a token will be created that has an expiration of 12 hours (by default).
This token is stored in a file named \fBsalt_token\fP in the active user\(aqs home
directory.
.sp
Once the token is created, it is sent with all subsequent communications.
User authentication does not need to be entered again until the token expires.
.sp
Token expiration time can be set in the Salt master config file.
.SS LDAP and Active Directory
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
LDAP usage requires that you have installed python\-ldap.
.UNINDENT
.UNINDENT
.sp
Salt supports both user and group authentication for LDAP (and Active Directory
accessed via its LDAP interface)
.SS OpenLDAP and similar systems
.sp
LDAP configuration happens in the Salt master configuration file.
.sp
Server configuration values and their defaults:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Server to auth against
auth.ldap.server: localhost

# Port to connect via
auth.ldap.port: 389

# Use TLS when connecting
auth.ldap.tls: False

# Use STARTTLS when connecting
auth.ldap.starttls: False

# LDAP scope level, almost always 2
auth.ldap.scope: 2

# Server specified in URI format
auth.ldap.uri: \(aq\(aq    # Overrides .ldap.server, .ldap.port, .ldap.tls above

# Verify server\(aqs TLS certificate
auth.ldap.no_verify: False

# Bind to LDAP anonymously to determine group membership
# Active Directory does not allow anonymous binds without special configuration
# In addition, if auth.ldap.anonymous is True, empty bind passwords are not permitted.
auth.ldap.anonymous: False

# FOR TESTING ONLY, this is a VERY insecure setting.
# If this is True, the LDAP bind password will be ignored and
# access will be determined by group membership alone with
# the group memberships being retrieved via anonymous bind
auth.ldap.auth_by_group_membership_only: False

# Require authenticating user to be part of this Organizational Unit
# This can be blank if your LDAP schema does not use this kind of OU
auth.ldap.groupou: \(aqGroups\(aq

# Object Class for groups.  An LDAP search will be done to find all groups of this
# class to which the authenticating user belongs.
auth.ldap.groupclass: \(aqposixGroup\(aq

# Unique ID attribute name for the user
auth.ldap.accountattributename: \(aqmemberUid\(aq

# These are only for Active Directory
auth.ldap.activedirectory: False
auth.ldap.persontype: \(aqperson\(aq

auth.ldap.minion_stripdomains: []

# Redhat Identity Policy Audit
auth.ldap.freeipa: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Authenticating to the LDAP Server
.sp
There are two phases to LDAP authentication.  First, Salt authenticates to search for a users\(aq Distinguished Name
and group membership.  The user it authenticates as in this phase is often a special LDAP system user with
read\-only access to the LDAP directory.  After Salt searches the directory to determine the actual user\(aqs DN
and groups, it re\-authenticates as the user running the Salt commands.
.sp
If you are already aware of the structure of your DNs and permissions in your LDAP store are set such that
users can look up their own group memberships, then the first and second users can be the same.  To tell Salt this is
the case, omit the \fBauth.ldap.bindpw\fP parameter.  Note this is not the same thing as using an anonymous bind.
Most LDAP servers will not permit anonymous bind, and as mentioned above, if \fIauth.ldap.anonymous\fP is False you
cannot use an empty password.
.sp
You can template the \fBbinddn\fP like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
auth.ldap.basedn: dc=saltstack,dc=com
auth.ldap.binddn: uid={{ username }},cn=users,cn=accounts,dc=saltstack,dc=com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt will use the password entered on the salt command line in place of the bindpw.
.sp
To use two separate users, specify the LDAP lookup user in the binddn directive, and include a bindpw like so
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
auth.ldap.binddn: uid=ldaplookup,cn=sysaccounts,cn=etc,dc=saltstack,dc=com
auth.ldap.bindpw: mypassword
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As mentioned before, Salt uses a filter to find the DN associated with a user. Salt
substitutes the \fB{{ username }}\fP value for the username when querying LDAP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
auth.ldap.filter: uid={{ username }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Determining Group Memberships (OpenLDAP / non\-Active Directory)
.sp
For OpenLDAP, to determine group membership, one can specify an OU that contains
group data. This is prepended to the basedn to create a search path.  Then
the results are filtered against \fBauth.ldap.groupclass\fP, default
\fBposixGroup\fP, and the account\(aqs \(aqname\(aq attribute, \fBmemberUid\fP by default.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
auth.ldap.groupou: Groups
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that as of 2017.7, auth.ldap.groupclass can refer to either a groupclass or an objectClass.
For some LDAP servers (notably OpenLDAP without the \fBmemberOf\fP overlay enabled) to determine group
membership we need to know both the \fBobjectClass\fP and the \fBmemberUid\fP attributes.  Usually for these
servers you will want a \fBauth.ldap.groupclass\fP of \fBposixGroup\fP and an \fBauth.ldap.groupattribute\fP of
\fBmemberUid\fP\&.
.sp
LDAP servers with the \fBmemberOf\fP overlay will have entries similar to \fBauth.ldap.groupclass: person\fP and
\fBauth.ldap.groupattribute: memberOf\fP\&.
.sp
When using the \fBldap(\(aqDC=domain,DC=com\(aq)\fP eauth operator, sometimes the records returned
from LDAP or Active Directory have fully\-qualified domain names attached, while minion IDs
instead are simple hostnames.  The parameter below allows the administrator to strip
off a certain set of domain names so the hostnames looked up in the directory service
can match the minion IDs.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
auth.ldap.minion_stripdomains: [\(aq.external.bigcorp.com\(aq, \(aq.internal.bigcorp.com\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Determining Group Memberships (Active Directory)
.sp
Active Directory handles group membership differently, and does not utilize the
\fBgroupou\fP configuration variable.  AD needs the following options in
the master config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
auth.ldap.activedirectory: True
auth.ldap.filter: sAMAccountName={{username}}
auth.ldap.accountattributename: sAMAccountName
auth.ldap.groupclass: group
auth.ldap.persontype: person
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To determine group membership in AD, the username and password that is entered
when LDAP is requested as the eAuth mechanism on the command line is used to
bind to AD\(aqs LDAP interface. If this fails, then it doesn\(aqt matter what groups
the user belongs to, he or she is denied access. Next, the \fBdistinguishedName\fP
of the user is looked up with the following LDAP search:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(&(<value of auth.ldap.accountattributename>={{username}})
  (objectClass=<value of auth.ldap.persontype>)
)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This should return a distinguishedName that we can use to filter for group
membership.  Then the following LDAP query is executed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(&(member=<distinguishedName from search above>)
  (objectClass=<value of auth.ldap.groupclass>)
)
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  ldap:
    test_ldap_user:
        \- \(aq*\(aq:
            \- test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To configure a LDAP group, append a \fB%\fP to the ID:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  ldap:
    test_ldap_group%:
      \- \(aq*\(aq:
        \- test.echo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In addition, if there are a set of computers in the directory service that should
be part of the eAuth definition, they can be specified like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  ldap:
    test_ldap_group%:
      \- ldap(\(aqDC=corp,DC=example,DC=com\(aq):
        \- test.echo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The string inside \fBldap()\fP above is any valid LDAP/AD tree limiter.  \fBOU=\fP in
particular is permitted as long as it would return a list of computer objects.
.SS Peer Communication
.sp
Salt 0.9.0 introduced the capability for Salt minions to publish commands. The
intent of this feature is not for Salt minions to act as independent brokers
one with another, but to allow Salt minions to pass commands to each other.
.sp
In Salt 0.10.0 the ability to execute runners from the master was added. This
allows for the master to return collective data from runners back to the
minions via the peer interface.
.sp
The peer interface is configured through two options in the master
configuration file. For minions to send commands from the master the \fBpeer\fP
configuration is used. To allow for minions to execute runners from the master
the \fBpeer_run\fP configuration is used.
.sp
Since this presents a viable security risk by allowing minions access to the
master publisher the capability is turned off by default. The minions can be
allowed access to the master publisher on a per minion basis based on regular
expressions. Minions with specific ids can be allowed access to certain Salt
modules and functions.
.SS Peer Configuration
.sp
The configuration is done under the \fBpeer\fP setting in the Salt master
configuration file, here are a number of configuration possibilities.
.sp
The simplest approach is to enable all communication for all minions, this is
only recommended for very secure environments.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
peer:
  .*:
    \- .*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This configuration allows minions with IDs ending in \fB\&.example.com\fP access
to the test, ps, and pkg module functions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
peer:
  .*\e.example.com:
    \- test\e..*
    \- ps\e..*
    \- pkg\e..*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The configuration logic is simple, a regular expression is passed for matching
minion ids, and then a list of expressions matching minion functions is
associated with the named minion. For instance, this configuration will also
allow minions ending with foo.org access to the publisher.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
peer:
  .*\e.example.com:
    \- test\e..*
    \- ps\e..*
    \- pkg\e..*
  .*\e.foo.org:
    \- test\e..*
    \- ps\e..*
    \- pkg\e..*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Functions are matched using regular expressions as well.
.UNINDENT
.UNINDENT
.sp
It is also possible to limit target hosts with the \fI\%Compound Matcher\fP\&.
You can achieve this by adding another layer in between the source and the
allowed functions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
peer:
  \(aq.*\e.example\e.com\(aq:
    \- \(aqG@role:db\(aq:
      \- test\e..*
      \- pkg\e..*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Notice that the source hosts are matched by a regular expression
on their minion ID, while target hosts can be matched by any of
the \fI\%available matchers\fP\&.
.sp
Note that globbing and regex matching on pillar values is not supported. You can only match exact values.
.UNINDENT
.UNINDENT
.SS Peer Runner Communication
.sp
Configuration to allow minions to execute runners from the master is done via
the \fBpeer_run\fP option on the master. The \fBpeer_run\fP configuration follows
the same logic as the \fBpeer\fP option. The only difference is that access is
granted to runner modules.
.sp
To open up access to all minions to all runners:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
peer_run:
  .*:
    \- .*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This configuration will allow minions with IDs ending in example.com access
to the manage and jobs runner functions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
peer_run:
  .*example.com:
    \- manage.*
    \- jobs.*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Functions are matched using regular expressions.
.UNINDENT
.UNINDENT
.SS Using Peer Communication
.sp
The publish module was created to manage peer communication. The publish module
comes with a number of functions to execute peer communication in different
ways. Currently there are three functions in the publish module. These examples
will show how to test the peer system via the salt\-call command.
.sp
To execute test.version on all minions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call publish.publish \e* test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To execute the manage.up runner:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call publish.runner manage.up
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To match minions using other matchers, use \fBtgt_type\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call publish.publish \(aqwebserv* and not G@os:Ubuntu\(aq test.version tgt_type=\(aqcompound\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In pre\-2017.7.0 releases, use \fBexpr_form\fP instead of \fBtgt_type\fP\&.
.UNINDENT
.UNINDENT
.SS When to Use Each Authentication System
.sp
\fBpublisher_acl\fP is useful for allowing local system users to run Salt
commands without giving them root access. If you can log into the Salt
master directly, then \fBpublisher_acl\fP allows you to use Salt without
root privileges. If the local system is configured to authenticate against
a remote system, like LDAP or Active Directory, then \fBpublisher_acl\fP will
interact with the remote system transparently.
.sp
\fBexternal_auth\fP is useful for \fBsalt\-api\fP or for making your own scripts
that use Salt\(aqs Python API. It can be used at the CLI (with the \fB\-a\fP
flag) but it is more cumbersome as there are more steps involved.  The only
time it is useful at the CLI is when the local system is \fInot\fP configured
to authenticate against an external service \fIbut\fP you still want Salt to
authenticate against an external service.
.SS Examples
.sp
The access controls are manifested using matchers in these configurations:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publisher_acl:
  fred:
    \- web\e*:
      \- pkg.list_pkgs
      \- test.*
      \- apache.*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above example, fred is able to send commands only to minions which match
the specified glob target. This can be expanded to include other functions for
other minions based on standard targets (all matchers are supported except the compound one).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  pam:
    dave:
      \- test.version
      \- mongo\e*:
        \- network.*
      \- log\e*:
        \- network.*
        \- pkg.*
      \- \(aqG@os:RedHat\(aq:
        \- kmod.*
    steve:
      \- .*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above allows for all minions to be hit by test.version by dave, and adds a
few functions that dave can execute on other minions. It also allows steve
unrestricted access to salt commands.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Functions are matched using regular expressions.
.UNINDENT
.UNINDENT
.SS Job Management
.sp
New in version 0.9.7.

.sp
Since Salt executes jobs running on many systems, Salt needs to be able to
manage jobs running on many systems.
.SS The Minion proc System
.sp
Salt Minions maintain a \fIproc\fP directory in the Salt \fBcachedir\fP\&. The \fIproc\fP
directory maintains files named after the executed job ID. These files contain
the information about the current running jobs on the minion and allow for
jobs to be looked up. This is located in the \fIproc\fP directory under the
cachedir, with a default configuration it is under \fB/var/cache/salt/{master|minion}/proc\fP\&.
.SS Functions in the saltutil Module
.sp
Salt 0.9.7 introduced a few new functions to the
\fI\%saltutil\fP module for managing
jobs. These functions are:
.INDENT 0.0
.IP 1. 3
\fBrunning\fP
Returns the data of all running jobs that are found in the \fIproc\fP directory.
.IP 2. 3
\fBfind_job\fP
Returns specific data about a certain job based on job id.
.IP 3. 3
\fBsignal_job\fP
Allows for a given jid to be sent a signal.
.IP 4. 3
\fBterm_job\fP
Sends a termination signal (SIGTERM, 15) to the process controlling the
specified job.
.IP 5. 3
\fBkill_job\fP
Sends a kill signal (SIGKILL, 9) to the process controlling the
specified job.
.UNINDENT
.sp
These functions make up the core of the back end used to manage jobs at the
minion level.
.SS The jobs Runner
.sp
A convenience runner front end and reporting system has been added as well.
The jobs runner contains functions to make viewing data easier and cleaner.
.sp
The jobs runner contains a number of functions...
.SS active
.sp
The active function runs saltutil.running on all minions and formats the
return data about all running jobs in a much more usable and compact format.
The active function will also compare jobs that have returned and jobs that
are still running, making it easier to see what systems have completed a job
and what systems are still being waited on.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-run jobs.active
.ft P
.fi
.UNINDENT
.UNINDENT
.SS lookup_jid
.sp
When jobs are executed the return data is sent back to the master and cached.
By default it is cached for 86400 seconds, but this can be configured via the
\fBkeep_jobs_seconds\fP option in the master configuration.
Using the lookup_jid runner will display the same return data that the initial
job invocation with the salt command would display.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-run jobs.lookup_jid <job id number>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS list_jobs
.sp
Before finding a historic job, it may be required to find the job id. \fBlist_jobs\fP
will parse the cached execution data and display all of the job data for jobs
that have already, or partially returned.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-run jobs.list_jobs
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Scheduling Jobs
.sp
Salt\(aqs scheduling system allows incremental executions on minions or the
master. The schedule system exposes the execution of any execution function on
minions or any runner on the master.
.sp
Scheduling can be enabled by multiple methods:
.INDENT 0.0
.IP \(bu 2
\fBschedule\fP option in either the master or minion config files.  These
require the master or minion application to be restarted in order for the
schedule to be implemented.
.IP \(bu 2
Minion pillar data.  Schedule is implemented by refreshing the minion\(aqs pillar data,
for example by using \fBsaltutil.refresh_pillar\fP\&.
.IP \(bu 2
The \fI\%schedule state\fP or
\fI\%schedule module\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The scheduler executes different functions on the master and minions. When
running on the master the functions reference runner functions, when
running on the minion the functions specify execution functions.
.UNINDENT
.UNINDENT
.sp
A scheduled run has no output on the minion unless the config is set to info level
or higher. Refer to \fBminion\-logging\-settings\fP\&.
.sp
States are executed on the minion, as all states are. You can pass positional
arguments and provide a YAML dict of named arguments.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: state.sls
    seconds: 3600
    args:
      \- httpd
    kwargs:
      test: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will schedule the command: \fBstate.sls httpd test=True\fP every 3600 seconds
(every hour).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: state.sls
    seconds: 3600
    args:
      \- httpd
    kwargs:
      test: True
    splay: 15
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will schedule the command: \fBstate.sls httpd test=True\fP every 3600 seconds
(every hour) splaying the time between 0 and 15 seconds.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: state.sls
    seconds: 3600
    args:
      \- httpd
    kwargs:
      test: True
    splay:
      start: 10
      end: 15
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will schedule the command: \fBstate.sls httpd test=True\fP every 3600 seconds
(every hour) splaying the time between 10 and 15 seconds.
.SS Schedule by Date and Time
.sp
New in version 2014.7.0.

.sp
Frequency of jobs can also be specified using date strings supported by
the Python \fBdateutil\fP library. This requires the Python \fBdateutil\fP library
to be installed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: state.sls
    args:
      \- httpd
    kwargs:
      test: True
    when: 5:00pm
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will schedule the command: \fBstate.sls httpd test=True\fP at 5:00 PM minion
localtime.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: state.sls
    args:
      \- httpd
    kwargs:
      test: True
    when:
      \- Monday 5:00pm
      \- Tuesday 3:00pm
      \- Wednesday 5:00pm
      \- Thursday 3:00pm
      \- Friday 5:00pm
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will schedule the command: \fBstate.sls httpd test=True\fP at 5:00 PM on
Monday, Wednesday and Friday, and 3:00 PM on Tuesday and Thursday.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: state.sls
    args:
      \- httpd
    kwargs:
      test: True
    when:
      \- \(aqtea time\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
whens:
  tea time: 1:40pm
  deployment time: Friday 5:00pm
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The Salt scheduler also allows custom phrases to be used for the \fIwhen\fP
parameter.  These \fIwhens\fP can be stored as either pillar values or
grain values.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: state.sls
    seconds: 3600
    args:
      \- httpd
    kwargs:
      test: True
    range:
      start: 8:00am
      end: 5:00pm
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will schedule the command: \fBstate.sls httpd test=True\fP every 3600 seconds
(every hour) between the hours of 8:00 AM and 5:00 PM. The range parameter must
be a dictionary with the date strings using the \fBdateutil\fP format.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: state.sls
    seconds: 3600
    args:
      \- httpd
    kwargs:
      test: True
    range:
      invert: True
      start: 8:00am
      end: 5:00pm
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using the invert option for range, this will schedule the command
\fBstate.sls httpd test=True\fP every 3600 seconds (every hour) until the current
time is between the hours of 8:00 AM and 5:00 PM. The range parameter must be
a dictionary with the date strings using the \fBdateutil\fP format.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: pkg.install
    kwargs:
      pkgs: [{\(aqbar\(aq: \(aq>1.2.3\(aq}]
      refresh: true
    once: \(aq2016\-01\-07T14:30:00\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will schedule the function \fBpkg.install\fP to be executed once at the
specified time. The schedule entry \fBjob1\fP will not be removed after the job
completes, therefore use \fBschedule.delete\fP to manually remove it afterwards.
.sp
The default date format is ISO 8601 but can be overridden by also specifying the
\fBonce_fmt\fP option, like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: test.ping
    once: 2015\-04\-22T20:21:00
    once_fmt: \(aq%Y\-%m\-%dT%H:%M:%S\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Maximum Parallel Jobs Running
.sp
New in version 2014.7.0.

.sp
The scheduler also supports ensuring that there are no more than N copies of
a particular routine running. Use this for jobs that may be long\-running
and could step on each other or pile up in case of infrastructure outage.
.sp
The default for \fBmaxrunning\fP is 1.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  long_running_job:
    function: big_file_transfer
    jid_include: True
    maxrunning: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Cron\-like Schedule
.sp
New in version 2014.7.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: state.sls
    cron: \(aq*/15 * * * *\(aq
    args:
      \- httpd
    kwargs:
      test: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The scheduler also supports scheduling jobs using a cron like format.
This requires the Python \fBcroniter\fP library.
.SS Job Data Return
.sp
New in version 2015.5.0.

.sp
By default, data about jobs runs from the Salt scheduler is returned to the
master. Setting the \fBreturn_job\fP parameter to False will prevent the data
from being sent back to the Salt master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: scheduled_job_function
    return_job: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Job Metadata
.sp
New in version 2015.5.0.

.sp
It can be useful to include specific data to differentiate a job from other
jobs. Using the metadata parameter special values can be associated with
a scheduled job. These values are not used in the execution of the job,
but can be used to search for specific jobs later if combined with the
\fBreturn_job\fP parameter. The metadata parameter must be specified as a
dictionary, othewise it will be ignored.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: scheduled_job_function
    metadata:
      foo: bar
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Run on Start
.sp
New in version 2015.5.0.

.sp
By default, any job scheduled based on the startup time of the minion will run
the scheduled job when the minion starts up. Sometimes this is not the desired
situation. Using the \fBrun_on_start\fP parameter set to \fBFalse\fP will cause the
scheduler to skip this first run and wait until the next scheduled run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: state.sls
    seconds: 3600
    run_on_start: False
    args:
      \- httpd
    kwargs:
      test: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Until and After
.sp
New in version 2015.8.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: state.sls
    seconds: 15
    until: \(aq12/31/2015 11:59pm\(aq
    args:
      \- httpd
    kwargs:
      test: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using the until argument, the Salt scheduler allows you to specify
an end time for a scheduled job. If this argument is specified, jobs
will not run once the specified time has passed. Time should be specified
in a format supported by the \fBdateutil\fP library.
This requires the Python \fBdateutil\fP library to be installed.
.sp
New in version 2015.8.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  job1:
    function: state.sls
    seconds: 15
    after: \(aq12/31/2015 11:59pm\(aq
    args:
      \- httpd
    kwargs:
      test: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using the after argument, the Salt scheduler allows you to specify
an start time for a scheduled job.  If this argument is specified, jobs
will not run until the specified time has passed. Time should be specified
in a format supported by the \fBdateutil\fP library.
This requires the Python \fBdateutil\fP library to be installed.
.SS Scheduling States
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  log\-loadavg:
    function: cmd.run
    seconds: 3660
    args:
      \- \(aqlogger \-t salt < /proc/loadavg\(aq
    kwargs:
      stateful: False
      shell: /bin/sh
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Scheduling Highstates
.sp
To set up a highstate to run on a minion every 60 minutes set this in the
minion config or pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  highstate:
    function: state.highstate
    minutes: 60
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Time intervals can be specified as seconds, minutes, hours, or days.
.SS Scheduling Runners
.sp
Runner executions can also be specified on the master within the master
configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  run_my_orch:
    function: state.orchestrate
    hours: 6
    splay: 600
    args:
      \- orchestration.my_orch
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above configuration is analogous to running
\fBsalt\-run state.orch orchestration.my_orch\fP every 6 hours.
.SS Scheduler With Returner
.sp
The scheduler is also useful for tasks like gathering monitoring data about
a minion, this schedule option will gather status data and send it to a MySQL
returner database:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  uptime:
    function: status.uptime
    seconds: 60
    returner: mysql
  meminfo:
    function: status.meminfo
    minutes: 5
    returner: mysql
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Since specifying the returner repeatedly can be tiresome, the
\fBschedule_returner\fP option is available to specify one or a list of global
returners to be used by the minions when scheduling.
.SS Managing the Job Cache
.sp
The Salt Master maintains a job cache of all job executions which can be
queried via the jobs runner. This job cache is called the Default Job Cache.
.SS Default Job Cache
.sp
A number of options are available when configuring the job cache. The default
caching system uses local storage on the Salt Master and can be found in the
job cache directory (on Linux systems this is typically
\fB/var/cache/salt/master/jobs\fP). The default caching system is suitable for most
deployments as it does not typically require any further configuration or
management.
.sp
The default job cache is a temporary cache and jobs will be stored for 86400
seconds. If the default cache needs to store jobs for a different period the
time can be easily adjusted by changing the \fBkeep_jobs_seconds\fP parameter
in the Salt Master configuration file. The value passed in is measured in seconds:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
keep_jobs_seconds: 86400
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Reducing the Size of the Default Job Cache
.sp
The Default Job Cache can sometimes be a burden on larger deployments (over 5000
minions). Disabling the job cache will make previously executed jobs unavailable
to the jobs system and is not generally recommended. Normally it is wise to make
sure the master has access to a faster IO system or a tmpfs is mounted to the
jobs dir.
.sp
However, you can disable the \fI\%job_cache\fP by setting it to \fBFalse\fP
in the Salt Master configuration file. Setting this value to \fBFalse\fP means that
the Salt Master will no longer cache minion returns, but a JID directory and \fBjid\fP
file for each job will still be created. This JID directory is necessary for
checking for and preventing JID collisions.
.sp
The default location for the job cache is in the \fB/var/cache/salt/master/jobs/\fP
directory.
.sp
Setting the \fI\%job_cache\fP to \fBFalse\fP in addition to setting
the \fI\%keep_jobs_seconds\fP option to a smaller value, such as \fB3600\fP,
in the Salt Master configuration file will reduce the size of the Default Job Cache,
and thus the burden on the Salt Master.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changing the \fBkeep_jobs_seconds\fP option sets the number of seconds to keep
old job information and defaults to \fB86400\fP seconds. Do not set this value
to \fB0\fP when trying to make the cache cleaner run more frequently, as this
means the cache cleaner will never run.
.UNINDENT
.UNINDENT
.SS Additional Job Cache Options
.sp
Many deployments may wish to use an external database to maintain a long term
register of executed jobs. Salt comes with two main mechanisms to do this, the
master job cache and the external job cache.
.sp
See \fI\%Storing Job Results in an External System\fP\&.
.SS Storing Job Results in an External System
.sp
After a job executes, job results are returned
to the Salt Master by each Salt Minion. These results are stored in the
\fI\%Default Job Cache\fP\&.
.sp
In addition to the Default Job Cache, Salt provides two additional
mechanisms to send job results to other systems (databases, local syslog,
and others):
.INDENT 0.0
.IP \(bu 2
External Job Cache
.IP \(bu 2
Master Job Cache
.UNINDENT
.sp
The major difference between these two mechanism is from where results are
returned (from the Salt Master or Salt Minion). Configuring either of these
options will also make the \fI\%Jobs Runner functions\fP
to automatically query the remote stores for information.
.SS External Job Cache \- Minion\-Side Returner
.sp
When an External Job Cache is configured, data is returned to the Default Job
Cache on the Salt Master like usual, and then results are also sent to an
External Job Cache using a Salt returner module running on the Salt Minion.
[image]
.INDENT 0.0
.IP \(bu 2
Advantages: Data is stored without placing additional load on the Salt Master.
.IP \(bu 2
Disadvantages: Each Salt Minion connects to the external job cache, which can
result in a large number of connections.  Also requires additional configuration to
get returner module settings on all Salt Minions.
.UNINDENT
.SS Master Job Cache \- Master\-Side Returner
.sp
New in version 2014.7.0.

.sp
Instead of configuring an External Job Cache on each Salt Minion, you can
configure the Master Job Cache to send job results from the Salt Master
instead. In this configuration, Salt Minions send data to the Default Job Cache
as usual, and then the Salt Master sends the data to the external system using
a Salt returner module running on the Salt Master.
[image]
.INDENT 0.0
.IP \(bu 2
Advantages: A single connection is required to the external system. This is
preferred for databases and similar systems.
.IP \(bu 2
Disadvantages: Places additional load on your Salt Master.
.UNINDENT
.SS Configure an External or Master Job Cache
.SS Step 1: Understand Salt Returners
.sp
Before you configure a job cache, it is essential to understand Salt returner
modules (\(dqreturners\(dq). Returners are pluggable Salt Modules that take the data
returned by jobs, and then perform any necessary steps to send the data to an
external system. For example, a returner might establish a connection,
authenticate, and then format and transfer data.
.sp
The Salt Returner system provides the core functionality used by the External
and Master Job Cache systems, and the same returners are used by both systems.
.sp
Salt currently provides many different returners that let you connect to a
wide variety of systems. A complete list is available at
\fI\%all Salt returners\fP\&.
Each returner is configured differently, so make sure you read and follow the
instructions linked from that page.
.sp
For example, the MySQL returner requires:
.INDENT 0.0
.IP \(bu 2
A database created using provided schema (structure is available at
\fI\%MySQL returner\fP)
.IP \(bu 2
A user created with privileges to the database
.IP \(bu 2
Optional SSL configuration
.UNINDENT
.sp
A simpler returner, such as Slack or HipChat, requires:
.INDENT 0.0
.IP \(bu 2
An API key/version
.IP \(bu 2
The target channel/room
.IP \(bu 2
The username that should be used to send the message
.UNINDENT
.SS Step 2: Configure the Returner
.sp
After you understand the configuration and have the external system ready, the
configuration requirements must be declared.
.SS External Job Cache
.sp
The returner configuration settings can be declared in the Salt Minion
configuration file, the Minion\(aqs pillar data, or the Minion\(aqs grains.
.sp
If \fBexternal_job_cache\fP configuration settings are specified in more than
one place, the options are retrieved in the following order. The first
configuration location that is found is the one that will be used.
.INDENT 0.0
.IP \(bu 2
Minion configuration file
.IP \(bu 2
Minion\(aqs grains
.IP \(bu 2
Minion\(aqs pillar data
.UNINDENT
.SS Master Job Cache
.sp
The returner configuration settings for the Master Job Cache should be
declared in the Salt Master\(aqs configuration file.
.SS Configuration File Examples
.sp
MySQL requires:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql.host: \(aqsalt\(aq
mysql.user: \(aqsalt\(aq
mysql.pass: \(aqsalt\(aq
mysql.db: \(aqsalt\(aq
mysql.port: 3306
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Slack requires:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
slack.channel: \(aqchannel\(aq
slack.api_key: \(aqkey\(aq
slack.from_name: \(aqname\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
After you have configured the returner and added settings to the configuration
file, you can enable the External or Master Job Cache.
.SS Step 3: Enable the External or Master Job Cache
.sp
Configuration is a single line that specifies an
already\-configured returner to use to send all job data to an external system.
.SS External Job Cache
.sp
To enable a returner as the External Job Cache (Minion\-side), add the following
line to the Salt Master configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_job_cache: <returner>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_job_cache: mysql
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When configuring an External Job Cache (Minion\-side), the returner settings are
added to the Minion configuration file, but the External Job Cache setting
is configured in the Master configuration file.
.UNINDENT
.UNINDENT
.SS Master Job Cache
.sp
To enable a returner as a Master Job Cache (Master\-side), add the following
line to the Salt Master configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_job_cache: <returner>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_job_cache: mysql
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Verify that the returner configuration settings are in the Master configuration
file, and be sure to restart the salt\-master service after you make
configuration changes. (\fBservice salt\-master restart\fP).
.SS Logging
.sp
The Salt Project tries to get the logging to work for you and help us solve any
issues you might find along the way.
.sp
If you want to get some more information on the nitty\-gritty of salt\(aqs logging
system, please head over to the \fI\%logging development
document\fP, if all you\(aqre after is salt\(aqs logging
configurations, please continue reading.
.SS Log Levels
.sp
The log levels are ordered numerically such that setting the log level to a
specific level will record all log statements at that level and higher.  For
example, setting \fBlog_level: error\fP will log statements at \fBerror\fP,
\fBcritical\fP, and \fBquiet\fP levels, although nothing \fIshould\fP be logged at
\fBquiet\fP level.
.sp
Most of the logging levels are defined by default in Python\(aqs logging library
and can be found in the official \fI\%Python documentation\fP\&.
Salt uses some more levels in addition to the standard levels.  All levels
available in salt are shown in the table below.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Python dependencies used by salt may define and use additional logging
levels.  For example, the Python 2 version of the \fBmultiprocessing\fP
standard Python library \fI\%uses the levels\fP
\fBsubwarning\fP, 25 and \fBsubdebug\fP, 5.
.UNINDENT
.UNINDENT
.TS
center;
|l|l|l|.
_
T{
Level
T}	T{
Numeric value
T}	T{
Description
T}
_
T{
quiet
T}	T{
1000
T}	T{
Nothing should be logged at this level
T}
_
T{
critical
T}	T{
50
T}	T{
Critical errors
T}
_
T{
error
T}	T{
40
T}	T{
Errors
T}
_
T{
warning
T}	T{
30
T}	T{
Warnings
T}
_
T{
info
T}	T{
20
T}	T{
Normal log information
T}
_
T{
profile
T}	T{
15
T}	T{
Profiling information on salt performance
T}
_
T{
debug
T}	T{
10
T}	T{
Information useful for debugging both salt implementations and salt code
T}
_
T{
trace
T}	T{
5
T}	T{
More detailed code debugging information
T}
_
T{
garbage
T}	T{
1
T}	T{
Even more debugging information
T}
_
T{
all
T}	T{
0
T}	T{
Everything
T}
_
.TE
.sp
Any log level below the \fIinfo\fP level is INSECURE and may log sensitive data. This currently includes:
#. profile
#. debug
#. trace
#. garbage
#. all
.SS Available Configuration Settings
.SS \fBlog_file\fP
.sp
The log records can be sent to a regular file, local path name, or network
location.  Remote logging works best when configured to use rsyslogd(8) (e.g.:
\fBfile:///dev/log\fP), with rsyslogd(8) configured for network logging.  The
format for remote addresses is:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<file|udp|tcp>://<host|socketpath>:<port\-if\-required>/<log\-facility>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Where \fBlog\-facility\fP is the symbolic name of a syslog facility as defined in
the \fI\%SysLogHandler documentation\fP\&. It defaults to \fBLOG_USER\fP\&.
.sp
Default: Dependent of the binary being executed, for example, for
\fBsalt\-master\fP, \fB/var/log/salt/master\fP\&.
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_file: /var/log/salt/master
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_file: /var/log/salt/minion
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_file: file:///dev/log
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_file: file:///dev/log/LOG_DAEMON
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_file: udp://loghost:10514
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_level\fP
.sp
Default: \fBwarning\fP
.sp
The level of log record messages to send to the console. One of \fBall\fP,
\fBgarbage\fP, \fBtrace\fP, \fBdebug\fP, \fBprofile\fP, \fBinfo\fP, \fBwarning\fP,
\fBerror\fP, \fBcritical\fP, \fBquiet\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_level: warning
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Add \fBlog_level: quiet\fP in salt configuration file to completely disable
logging. In case of running salt in command line use \fB\-\-log\-level=quiet\fP
instead.
.UNINDENT
.UNINDENT
.SS \fBlog_level_logfile\fP
.sp
Default: \fBinfo\fP
.sp
The level of messages to send to the log file. One of \fBall\fP, \fBgarbage\fP,
\fBtrace\fP, \fBdebug\fP, \fBprofile\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP,
\fBcritical\fP, \fBquiet\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_level_logfile: warning
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_datefmt\fP
.sp
Default: \fB%H:%M:%S\fP
.sp
The date and time format used in console log messages. Allowed date/time
formatting matches those used in \fI\%time.strftime()\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_datefmt: \(aq%H:%M:%S\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_datefmt_logfile\fP
.sp
Default: \fB%Y\-%m\-%d %H:%M:%S\fP
.sp
The date and time format used in log file messages. Allowed date/time
formatting matches those used in \fI\%time.strftime()\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_datefmt_logfile: \(aq%Y\-%m\-%d %H:%M:%S\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_fmt_console\fP
.sp
Default: \fB[%(levelname)\-8s] %(message)s\fP
.sp
The format of the console logging messages. All standard python logging
\fI\%LogRecord\fP attributes can be used. Salt also provides these
custom LogRecord attributes to colorize console log output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(dq%(colorlevel)s\(dq  # log level name colorized by level
\(dq%(colorname)s\(dq  # colorized module name
\(dq%(colorprocess)s\(dq  # colorized process number
\(dq%(colormsg)s\(dq  # log message colorized by level
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fB%(colorlevel)s\fP, \fB%(colorname)s\fP, and \fB%(colorprocess)\fP
LogRecord attributes also include padding and enclosing brackets, \fB[\fP and
\fB]\fP to match the default values of their collateral non\-colorized
LogRecord attributes.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_fmt_console: \(aq[%(levelname)\-8s] %(message)s\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_fmt_logfile\fP
.sp
Default: \fB%(asctime)s,%(msecs)03d [%(name)\-17s][%(levelname)\-8s] %(message)s\fP
.sp
The format of the log file logging messages. All standard python logging
\fI\%LogRecord\fP attributes can be used.  Salt also provides
these custom LogRecord attributes that include padding and enclosing brackets
\fB[\fP and \fB]\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(dq%(bracketlevel)s\(dq  # equivalent to [%(levelname)\-8s]
\(dq%(bracketname)s\(dq  # equivalent to [%(name)\-17s]
\(dq%(bracketprocess)s\(dq  # equivalent to [%(process)5s]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_fmt_logfile: \(aq%(asctime)s,%(msecs)03d [%(name)\-17s][%(levelname)\-8s] %(message)s\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlog_granular_levels\fP
.sp
Default: \fB{}\fP
.sp
This can be used to control logging levels more specifically, based on log call name.  The example sets
the main salt library at the \(aqwarning\(aq level, sets \fBsalt.modules\fP to log
at the \fBdebug\fP level, and sets a custom module to the \fBall\fP level:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_granular_levels:
  \(aqsalt\(aq: \(aqwarning\(aq
  \(aqsalt.modules\(aq: \(aqdebug\(aq
  \(aqsalt.loader.saltmaster.ext.module.custom_module\(aq: \(aqall\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can determine what log call name to use here by adding \fB%(module)s\fP to the
log format. Typically, it is the path of the file which generates the log
without the trailing \fB\&.py\fP and with path separators replaced with \fB\&.\fP
.SS \fBlog_fmt_jid\fP
.sp
Default: \fB[JID: %(jid)s]\fP
.sp
The format of the JID when added to logging messages.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_fmt_jid: \(aq[JID: %(jid)s]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS External Logging Handlers
.sp
Besides the internal logging handlers used by salt, there are some external
which can be used, see the \fI\%external logging handlers\fP
document.
.SS External Logging Handlers
.TS
center;
|l|l|.
_
T{
\fI\%fluent_mod\fP
T}	T{
Fluent Logging Handler
T}
_
T{
\fI\%log4mongo_mod\fP
T}	T{
Log4Mongo Logging Handler
T}
_
T{
\fI\%logstash_mod\fP
T}	T{
Logstash Logging Handler
T}
_
T{
\fI\%sentry_mod\fP
T}	T{
Sentry Logging Handler
T}
_
.TE
.SS salt.log_handlers.fluent_mod
.SS Fluent Logging Handler
.sp
New in version 2015.8.0.

.sp
This module provides some \fI\%fluentd\fP logging handlers.
.SS Fluent Logging Handler
.sp
In the \fIfluent\fP configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<source>
  type forward
  bind localhost
  port 24224
</source>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then, to send logs via fluent in Logstash format, add the
following to the salt (master and/or minion) configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fluent_handler:
  host: localhost
  port: 24224
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To send logs via fluent in the Graylog raw json format, add the
following to the salt (master and/or minion) configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fluent_handler:
  host: localhost
  port: 24224
  payload_type: graylog
  tags:
  \- salt_master.SALT
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above also illustrates the \fItags\fP option, which allows
one to set descriptive (or useful) tags on records being
sent.  If not provided, this defaults to the single tag:
\(aqsalt\(aq.  Also note that, via Graylog \(dqmagic\(dq, the \(aqfacility\(aq
of the logged message is set to \(aqSALT\(aq (the portion of the
tag after the first period), while the tag itself will be
set to simply \(aqsalt_master\(aq.  This is a feature, not a bug :)
.sp
Note:
There is a third emitter, for the GELF format, but it is
largely untested, and I don\(aqt currently have a setup supporting
this config, so while it runs cleanly and outputs what LOOKS to
be valid GELF, any real\-world feedback on its usefulness, and
correctness, will be appreciated.
.SS Log Level
.sp
The \fBfluent_handler\fP configuration section accepts an additional setting
\fBlog_level\fP\&. If not set, the logging level used will be the one defined
for \fBlog_level\fP in the global configuration file section.
.INDENT 0.0
.INDENT 3.5
.IP "Inspiration"
.sp
This work was inspired in \fI\%fluent\-logger\-python\fP
.UNINDENT
.UNINDENT
.SS salt.log_handlers.log4mongo_mod
.SS Log4Mongo Logging Handler
.sp
This module provides a logging handler for sending salt logs to MongoDB
.SS Configuration
.sp
In the salt configuration file (e.g. /etc/salt/{master,minion}):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log4mongo_handler:
  host: mongodb_host
  port: 27017
  database_name: logs
  collection: salt_logs
  username: logging
  password: reindeerflotilla
  write_concern: 0
  log_level: warning
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Log Level
.sp
If not set, the log_level will be set to the level defined in the global
configuration file setting.
.INDENT 0.0
.INDENT 3.5
.IP "Inspiration"
.sp
This work was inspired by the Salt logging handlers for LogStash and
Sentry and by the log4mongo Python implementation.
.UNINDENT
.UNINDENT
.SS salt.log_handlers.logstash_mod
.SS Logstash Logging Handler
.sp
New in version 0.17.0.

.sp
This module provides some \fI\%Logstash\fP logging handlers.
.SS UDP Logging Handler
.sp
For versions of \fI\%Logstash\fP before 1.2.0:
.sp
In the salt configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
logstash_udp_handler:
  host: 127.0.0.1
  port: 9999
  version: 0
  msg_type: logstash
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the \fI\%Logstash\fP configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
input {
  udp {
    type => \(dqudp\-type\(dq
    format => \(dqjson_event\(dq
  }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For version 1.2.0 of \fI\%Logstash\fP and newer:
.sp
In the salt configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
logstash_udp_handler:
  host: 127.0.0.1
  port: 9999
  version: 1
  msg_type: logstash
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the \fI\%Logstash\fP configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
input {
  udp {
    port => 9999
    codec => json
  }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Please read the \fI\%UDP input\fP configuration page for additional information.
.SS ZeroMQ Logging Handler
.sp
For versions of \fI\%Logstash\fP before 1.2.0:
.sp
In the salt configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
logstash_zmq_handler:
  address: tcp://127.0.0.1:2021
  version: 0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the \fI\%Logstash\fP configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
input {
  zeromq {
    type => \(dqzeromq\-type\(dq
    mode => \(dqserver\(dq
    topology => \(dqpubsub\(dq
    address => \(dqtcp://0.0.0.0:2021\(dq
    charset => \(dqUTF\-8\(dq
    format => \(dqjson_event\(dq
  }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For version 1.2.0 of \fI\%Logstash\fP and newer:
.sp
In the salt configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
logstash_zmq_handler:
  address: tcp://127.0.0.1:2021
  version: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the \fI\%Logstash\fP configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
input {
  zeromq {
    topology => \(dqpubsub\(dq
    address => \(dqtcp://0.0.0.0:2021\(dq
    codec => json
  }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Please read the \fI\%ZeroMQ input\fP configuration page for additional
information.
.INDENT 0.0
.INDENT 3.5
.IP "Important Logstash Setting"
.sp
One of the most important settings that you should not forget on your
\fI\%Logstash\fP configuration file regarding these logging handlers is
\fBformat\fP\&.
Both the \fIUDP\fP and \fIZeroMQ\fP inputs need to have \fBformat\fP as
\fBjson_event\fP which is what we send over the wire.
.UNINDENT
.UNINDENT
.SS Log Level
.sp
Both the \fBlogstash_udp_handler\fP and the \fBlogstash_zmq_handler\fP
configuration sections accept an additional setting \fBlog_level\fP\&. If not
set, the logging level used will be the one defined for \fBlog_level\fP in
the global configuration file section.
.SS HWM
.sp
The \fI\%high water mark\fP for the ZMQ socket setting. Only applicable for the
\fBlogstash_zmq_handler\fP\&.
.INDENT 0.0
.INDENT 3.5
.IP "Inspiration"
.sp
This work was inspired in \fI\%pylogstash\fP, \fI\%python\-logstash\fP, \fI\%canary\fP
and the \fI\%PyZMQ logging handler\fP\&.
.UNINDENT
.UNINDENT
.SS salt.log_handlers.sentry_mod
.SS Sentry Logging Handler
.sp
New in version 0.17.0.

.sp
This module provides a \fI\%Sentry\fP logging handler. Sentry is an open source
error tracking platform that provides deep context about exceptions that
happen in production. Details about stack traces along with the context
variables available at the time of the exception are easily browsable and
filterable from the online interface. For more details please see
\fI\%Sentry\fP\&.
.INDENT 0.0
.INDENT 3.5
.IP "Note"
.sp
The \fI\%Raven\fP library needs to be installed on the system for this
logging handler to be available.
.UNINDENT
.UNINDENT
.sp
Configuring the python \fI\%Sentry\fP client, \fI\%Raven\fP, should be done under the
\fBsentry_handler\fP configuration key. Additional \fIcontext\fP may be provided
for corresponding grain item(s).
At the bare minimum, you need to define the \fI\%DSN\fP\&. As an example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sentry_handler:
  dsn: https://pub\-key:secret\-key@app.getsentry.com/app\-id
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
More complex configurations can be achieved, for example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sentry_handler:
  servers:
    \- https://sentry.example.com
    \- http://192.168.1.1
  project: app\-id
  public_key: deadbeefdeadbeefdeadbeefdeadbeef
  secret_key: beefdeadbeefdeadbeefdeadbeefdead
  context:
    \- os
    \- master
    \- saltversion
    \- cpuarch
    \- ec2.tags.environment
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.IP "Note"
.sp
The \fBpublic_key\fP and \fBsecret_key\fP variables are not supported with
Sentry > 3.0. The \fI\%DSN\fP key should be used instead.
.UNINDENT
.UNINDENT
.sp
All the client configuration keys are supported, please see the
\fI\%Raven client documentation\fP\&.
.sp
The default logging level for the sentry handler is \fBERROR\fP\&. If you wish
to define a different one, define \fBlog_level\fP under the
\fBsentry_handler\fP configuration key:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sentry_handler:
  dsn: https://pub\-key:secret\-key@app.getsentry.com/app\-id
  log_level: warning
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The available log levels are those also available for the salt \fBcli\fP
tools and configuration; \fBsalt \-\-help\fP should give you the required
information.
.SS Threaded Transports
.sp
Raven\(aqs documents rightly suggest using its threaded transport for
critical applications. However, don\(aqt forget that if you start having
troubles with Salt after enabling the threaded transport, please try
switching to a non\-threaded transport to see if that fixes your problem.
.SS Salt File Server
.sp
Salt comes with a simple file server suitable for distributing files to the
Salt minions. The file server is a stateless ZeroMQ server that is built into
the Salt master.
.sp
The main intent of the Salt file server is to present files for use in the
Salt state system. With this said, the Salt file server can be used for any
general file transfer from the master to the minions.
.SS File Server Backends
.sp
In Salt 0.12.0, the modular fileserver was introduced. This feature added the
ability for the Salt Master to integrate different file server backends. File
server backends allow the Salt file server to act as a transparent bridge to
external resources. A good example of this is the \fBgit\fP backend, which allows Salt to serve files sourced from
one or more git repositories, but there are several others as well. Click
\fI\%here\fP for a full list of Salt\(aqs fileserver
backends.
.SS Enabling a Fileserver Backend
.sp
Fileserver backends can be enabled with the \fI\%fileserver_backend\fP
option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_backend:
  \- git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See the \fI\%documentation\fP for each backend to find the
correct value to add to \fI\%fileserver_backend\fP in order to enable
them.
.SS Using Multiple Backends
.sp
If \fI\%fileserver_backend\fP is not defined in the Master config file,
Salt will use the \fI\%roots\fP backend, but the
\fI\%fileserver_backend\fP option supports multiple backends. When more
than one backend is in use, the files from the enabled backends are merged into a
single virtual filesystem. When a file is requested, the backends will be
searched in order for that file, and the first backend to match will be the one
which returns the file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_backend:
  \- roots
  \- git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With this configuration, the environments and files defined in the
\fI\%file_roots\fP parameter will be searched first, and if the file is
not found then the git repositories defined in \fI\%gitfs_remotes\fP
will be searched.
.SS Defining Environments
.sp
Just as the order of the values in \fI\%fileserver_backend\fP matters,
so too does the order in which different sources are defined within a
fileserver environment. For example, given the below \fI\%file_roots\fP
configuration, if both \fB/srv/salt/dev/foo.txt\fP and \fB/srv/salt/prod/foo.txt\fP
exist on the Master, then \fBsalt://foo.txt\fP would point to
\fB/srv/salt/dev/foo.txt\fP in the \fBdev\fP environment, but it would point to
\fB/srv/salt/prod/foo.txt\fP in the \fBbase\fP environment.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt/prod
  qa:
    \- /srv/salt/qa
    \- /srv/salt/prod
  dev:
    \- /srv/salt/dev
    \- /srv/salt/qa
    \- /srv/salt/prod
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Similarly, when using the \fI\%git\fP backend, if both
repositories defined below have a \fBhotfix23\fP branch/tag, and both of them
also contain the file \fBbar.txt\fP in the root of the repository at that
branch/tag, then \fBsalt://bar.txt\fP in the \fBhotfix23\fP environment would be
served from the \fBfirst\fP repository.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- https://mydomain.tld/repos/first.git
  \- https://mydomain.tld/repos/second.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Environments map differently based on the fileserver backend. For instance,
the mappings are explicitly defined in \fI\%roots\fP
backend, while in the VCS backends (\fI\%git\fP,
\fI\%hg\fP, \fI\%svn\fP) the
environments are created from branches/tags/bookmarks/etc. For the
\fI\%minion\fP backend, the files are all in a
single environment, which is specified by the \fI\%minionfs_env\fP
option.
.sp
See the documentation for each backend for a more detailed explanation of
how environments are mapped.
.UNINDENT
.UNINDENT
.SS Requesting Files from Specific Environments
.sp
The Salt fileserver supports multiple environments, allowing for SLS files and
other files to be isolated for better organization.
.sp
For the default backend (called \fI\%roots\fP),
environments are defined using the \fI\%roots\fP option.
Other backends (such as \fI\%gitfs\fP) define
environments in their own ways. For a list of available fileserver backends,
see \fI\%here\fP\&.
.SS Querystring Syntax
.sp
Any \fBsalt://\fP file URL can specify its fileserver environment using a
querystring syntax, like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt://path/to/file?saltenv=foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In \fI\%Reactor\fP configurations, this method must be used to pull
files from an environment other than \fBbase\fP\&.
.SS In States
.sp
Minions can be instructed which environment to use both globally, and for a
single state, and multiple methods for each are available:
.SS Globally
.sp
A minion can be pinned to an environment using the \fI\%environment\fP
option in the minion config file.
.sp
Additionally, the environment can be set for a single call to the following
functions:
.INDENT 0.0
.IP \(bu 2
\fBstate.apply\fP
.IP \(bu 2
\fI\%state.highstate\fP
.IP \(bu 2
\fI\%state.sls\fP
.IP \(bu 2
\fI\%state.top\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When the \fBsaltenv\fP parameter is used to trigger a \fI\%highstate\fP using either \fBstate.apply\fP or \fI\%state.highstate\fP, only states from that environment will be
applied.
.UNINDENT
.UNINDENT
.SS On a Per\-State Basis
.sp
Within an individual state, there are two ways of specifying the environment.
The first is to add a \fBsaltenv\fP argument to the state. This example will pull
the file from the \fBconfig\fP environment:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo/bar.conf:
  file.managed:
    \- source: salt://foo/bar.conf
    \- user: foo
    \- mode: 600
    \- saltenv: config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Another way of doing the same thing is to use the \fI\%querystring syntax\fP described above:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo/bar.conf:
  file.managed:
    \- source: salt://foo/bar.conf?saltenv=config
    \- user: foo
    \- mode: 600
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Specifying the environment using either of the above methods is only
necessary in cases where a state from one environment needs to access files
from another environment. If the SLS file containing this state was in the
\fBconfig\fP environment, then it would look in that environment by default.
.UNINDENT
.UNINDENT
.SS File Server Configuration
.sp
The Salt file server is a high performance file server written in ZeroMQ. It
manages large files quickly and with little overhead, and has been optimized
to handle small files in an extremely efficient manner.
.sp
The Salt file server is an environment aware file server. This means that
files can be allocated within many root directories and accessed by
specifying both the file path and the environment to search. The
individual environments can span across multiple directory roots
to create overlays and to allow for files to be organized in many flexible
ways.
.SS Periodic Restarts
.sp
The file server will restart periodically. The reason for this is to prevent any
files erver backends which may not properly handle resources from endlessly
consuming memory. A notable example of this is using a git backend with the
pygit2 library. How often the file server restarts can be controlled with the
\fBfileserver_interval\fP in your master\(aqs config file.
.SS Environments
.sp
The Salt file server defaults to the mandatory \fBbase\fP environment. This
environment \fBMUST\fP be defined and is used to download files when no
environment is specified.
.sp
Environments allow for files and sls data to be logically separated, but
environments are not isolated from each other. This allows for logical
isolation of environments by the engineer using Salt, but also allows
for information to be used in multiple environments.
.SS Directory Overlay
.sp
The \fBenvironment\fP setting is a list of directories to publish files from.
These directories are searched in order to find the specified file and the
first file found is returned.
.sp
This means that directory data is prioritized based on the order in which they
are listed. In the case of this \fBfile_roots\fP configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt/base
    \- /srv/salt/failover
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a file\(aqs URI is \fBsalt://httpd/httpd.conf\fP, it will first search for the
file at \fB/srv/salt/base/httpd/httpd.conf\fP\&. If the file is found there it
will be returned. If the file is not found there, then
\fB/srv/salt/failover/httpd/httpd.conf\fP will be used for the source.
.sp
This allows for directories to be overlaid and prioritized based on the order
they are defined in the configuration.
.sp
It is also possible to have \fBfile_roots\fP which supports multiple
environments:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt/base
  dev:
    \- /srv/salt/dev
    \- /srv/salt/base
  prod:
    \- /srv/salt/prod
    \- /srv/salt/base
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example ensures that each environment will check the associated
environment directory for files first. If a file is not found in the
appropriate directory, the system will default to using the base directory.
.SS Local File Server
.sp
New in version 0.9.8.

.sp
The file server can be rerouted to run from the minion. This is primarily to
enable running Salt states without a Salt master. To use the local file server
interface, copy the file server data to the minion and set the file_roots
option on the minion to point to the directories copied from the master.
Once the minion \fBfile_roots\fP option has been set, change the \fBfile_client\fP
option to local to make sure that the local file server interface is used.
.SS The cp Module
.sp
The cp module is the home of minion side file server operations. The cp module
is used by the Salt state system, salt\-cp, and can be used to distribute files
presented by the Salt file server.
.SS Escaping Special Characters
.sp
The \fBsalt://\fP url format can potentially contain a query string, for example
\fBsalt://dir/file.txt?saltenv=base\fP\&. You can prevent the fileclient/fileserver from
interpreting \fB?\fP as the initial token of a query string by referencing the file
with \fBsalt://|\fP rather than \fBsalt://\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/marathon/conf/?checkpoint:
  file.managed:
    \- source: salt://|hw/config/?checkpoint
    \- makedirs: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Environments
.sp
Since the file server is made to work with the Salt state system, it supports
environments. The environments are defined in the master config file and
when referencing an environment the file specified will be based on the root
directory of the environment.
.SS get_file
.sp
The cp.get_file function can be used on the minion to download a file from
the master, the syntax looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.get_file salt://vimrc /etc/vimrc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will instruct all Salt minions to download the vimrc file and copy it
to /etc/vimrc
.sp
Template rendering can be enabled on both the source and destination file names
like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.get_file \(dqsalt://{{grains.os}}/vimrc\(dq /etc/vimrc template=jinja
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example would instruct all Salt minions to download the vimrc from a
directory with the same name as their OS grain and copy it to /etc/vimrc
.sp
For larger files, the cp.get_file module also supports gzip compression.
Because gzip is CPU\-intensive, this should only be used in
scenarios where the compression ratio is very high (e.g. pretty\-printed JSON
or YAML files).
.sp
To use compression, use the \fBgzip\fP named argument. Valid values are integers
from 1 to 9, where 1 is the lightest compression and 9 the heaviest. In other
words, 1 uses the least CPU on the master (and minion), while 9 uses the most.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.get_file salt://vimrc /etc/vimrc gzip=5
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Finally, note that by default cp.get_file does \fInot\fP create new destination
directories if they do not exist.  To change this, use the \fBmakedirs\fP
argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.get_file salt://vimrc /etc/vim/vimrc makedirs=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example, /etc/vim/ would be created if it didn\(aqt already exist.
.SS get_dir
.sp
The cp.get_dir function can be used on the minion to download an entire
directory from the master.  The syntax is very similar to get_file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.get_dir salt://etc/apache2 /etc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
cp.get_dir supports template rendering and gzip compression arguments just like
get_file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.get_dir salt://etc/{{pillar.webserver}} /etc gzip=5 template=jinja
.ft P
.fi
.UNINDENT
.UNINDENT
.SS File Server Client Instance
.sp
A client instance is available which allows for modules and applications to be
written which make use of the Salt file server.
.sp
The file server uses the same authentication and encryption used by the rest
of the Salt system for network communication.
.SS fileclient Module
.sp
The \fBsalt/fileclient.py\fP module is used to set up the communication from the
minion to the master. When creating a client instance using the fileclient module,
the minion configuration needs to be passed in. When using the fileclient module
from within a minion module the built in \fB__opts__\fP data can be passed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.minion
import salt.fileclient


def get_file(path, dest, saltenv=\(dqbase\(dq):
    \(dq\(dq\(dq
    Used to get a single file from the Salt master

    CLI Example:
    salt \(aq*\(aq cp.get_file salt://vimrc /etc/vimrc
    \(dq\(dq\(dq
    # Get the fileclient object
    client = salt.fileclient.get_file_client(__opts__)
    # Call get_file
    return client.get_file(path, dest, False, saltenv)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Creating a fileclient instance outside of a minion module where the \fB__opts__\fP
data is not available, it needs to be generated:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.fileclient
import salt.config


def get_file(path, dest, saltenv=\(dqbase\(dq):
    \(dq\(dq\(dq
    Used to get a single file from the Salt master
    \(dq\(dq\(dq
    # Get the configuration data
    opts = salt.config.minion_config(\(dq/etc/salt/minion\(dq)
    # Get the fileclient object
    client = salt.fileclient.get_file_client(opts)
    # Call get_file
    return client.get_file(path, dest, False, saltenv)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Git Fileserver Backend Walkthrough
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This walkthrough assumes basic knowledge of Salt. To get up to speed, check
out the \fI\%Salt Walkthrough\fP\&.
.UNINDENT
.UNINDENT
.sp
The gitfs backend allows Salt to serve files from git repositories. It can be
enabled by adding \fBgit\fP to the \fI\%fileserver_backend\fP list, and
configuring one or more repositories in \fI\%gitfs_remotes\fP\&.
.sp
Branches and tags become Salt fileserver environments.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Branching and tagging can result in a lot of potentially\-conflicting
\fI\%top files\fP, for this reason it may be useful to set
\fI\%top_file_merging_strategy\fP to \fBsame\fP in the minions\(aq config
files if the top files are being managed in a GitFS repo.
.UNINDENT
.UNINDENT
.SS Installing Dependencies
.sp
Both \fI\%pygit2\fP and \fI\%GitPython\fP are supported Python interfaces to git. If
compatible versions of both are installed, \fI\%pygit2\fP will be preferred. In these
cases, \fI\%GitPython\fP can be forced using the \fI\%gitfs_provider\fP
parameter in the master config file.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
It is recommended to always run the most recent version of any the below
dependencies. Certain features of GitFS may not be available without
the most recent version of the chosen library.
.UNINDENT
.UNINDENT
.SS pygit2
.sp
The minimum supported version of \fI\%pygit2\fP is 0.20.3. Availability for this
version of \fI\%pygit2\fP is still limited, though the SaltStack team is working to
get compatible versions available for as many platforms as possible.
.sp
For the Fedora/EPEL versions which have a new enough version packaged, the
following command would be used to install \fI\%pygit2\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# yum install python\-pygit2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Provided a valid version is packaged for Debian/Ubuntu (which is not currently
the case), the package name would be the same, and the following command would
be used to install it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# apt\-get install python\-pygit2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If \fI\%pygit2\fP is not packaged for the platform on which the Master is running, the
\fI\%pygit2\fP website has installation instructions
\fI\%here\fP\&. Keep in mind however that
following these instructions will install \fI\%libgit2\fP and \fI\%pygit2\fP without system
packages. Additionally, keep in mind that \fI\%SSH authentication in pygit2\fP requires \fI\%libssh2\fP (\fInot\fP libssh) development
libraries to be present before \fI\%libgit2\fP is built. On some Debian\-based distros
\fBpkg\-config\fP is also required to link \fI\%libgit2\fP with libssh2.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you are receiving the error \(dqUnsupported URL Protocol\(dq in the Salt Master
log when making a connection using SSH, review the libssh2 details listed
above.
.UNINDENT
.UNINDENT
.sp
Additionally, version 0.21.0 of pygit2 introduced a dependency on \fI\%python\-cffi\fP,
which in turn depends on newer releases of \fI\%libffi\fP\&. Upgrading \fI\%libffi\fP is not
advisable as several other applications depend on it, so on older LTS linux
releases \fI\%pygit2\fP 0.20.3 and \fI\%libgit2\fP 0.20.0 is the recommended combination.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%pygit2\fP is actively developed and \fI\%frequently makes non\-backwards\-compatible
API changes\fP, even in minor releases.  It is not uncommon for \fI\%pygit2\fP
upgrades to result in errors in Salt. Please take care when upgrading
\fI\%pygit2\fP, and pay close attention to the \fI\%changelog\fP, keeping an eye out for
API changes. Errors can be reported on the \fI\%SaltStack issue tracker\fP\&.
.UNINDENT
.UNINDENT
.SS RedHat Pygit2 Issues
.sp
The release of RedHat/CentOS 7.3 upgraded both \fBpython\-cffi\fP and
\fBhttp\-parser\fP, both of which are dependencies for \fI\%pygit2\fP/\fI\%libgit2\fP\&. Both
\fBpygit2\fP and \fBlibgit2\fP packages (which are from the EPEL repository) should
be upgraded to the most recent versions, at least to \fB0.24.2\fP\&.
.sp
The below errors will show up in the master log if an incompatible
\fBpython\-pygit2\fP package is installed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
2017\-02\-10 09:07:34,892 [salt.utils.gitfs ][ERROR ][11211] Import pygit2 failed: CompileError: command \(aqgcc\(aq failed with exit status 1
2017\-02\-10 09:07:34,907 [salt.utils.gitfs ][ERROR ][11211] gitfs is configured but could not be loaded, are pygit2 and libgit2 installed?
2017\-02\-10 09:07:34,907 [salt.utils.gitfs ][CRITICAL][11211] No suitable gitfs provider module is installed.
2017\-02\-10 09:07:34,912 [salt.master ][CRITICAL][11211] Master failed pre flight checks, exiting
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The below errors will show up in the master log if an incompatible \fBlibgit2\fP
package is installed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
2017\-02\-15 18:04:45,211 [salt.utils.gitfs ][ERROR   ][6211] Error occurred fetching gitfs remote \(aqhttps://foo.com/bar.git\(aq: No Content\-Type header in response
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A restart of the \fBsalt\-master\fP daemon and gitfs cache directory clean up may
be required to allow http(s) repositories to continue to be fetched.
.SS Debian Pygit2 Issues
.sp
The Debian repos currently have older versions of pygit2 (package
\fBpython3\-pygit2\fP). These older versions may have issues using newer SSH keys
(see [this issue](\fI\%https://github.com/saltstack/salt/issues/61790\fP)). Instead,
\fBpygit2\fP can be installed from Pypi, but you will need a version that
matches the \fBlibgit2\fP version from Debian. This is version 1.6.1.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# apt\-get install libgit2
# salt\-pip install pygit2==1.6.1 \-\-no\-deps
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that the above instructions assume a onedir installation. The need for
\fI\-\-no\-deps\fP is to prevent the CFFI package from mismatching with Salt.
.SS GitPython
.sp
\fI\%GitPython\fP 0.3.0 or newer is required to use GitPython for gitfs. For
RHEL\-based Linux distros, a compatible version is available in EPEL, and can be
easily installed on the master using yum:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# yum install GitPython
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Ubuntu 14.04 LTS and Debian Wheezy (7.x) also have a compatible version packaged:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# apt\-get install python\-git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fI\%GitPython\fP requires the \fBgit\fP CLI utility to work. If installed from a system
package, then git should already be installed, but if installed via \fI\%pip\fP then
it may still be necessary to install git separately. For MacOS users,
\fI\%GitPython\fP comes bundled in with the Salt installer, but git must still be
installed for it to work properly. Git can be installed in several ways,
including by installing \fI\%XCode\fP\&.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
GitPython advises against the use of its library for long\-running processes
(such as a salt\-master or salt\-minion). Please see their warning on potential
leaks of system resources:
\fI\%https://github.com/gitpython\-developers/GitPython#leakage\-of\-system\-resources\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Keep in mind that if GitPython has been previously installed on the master
using pip (even if it was subsequently uninstalled), then it may still
exist in the build cache (typically \fB/tmp/pip\-build\-root/GitPython\fP) if
the cache is not cleared after installation. The package in the build cache
will override any requirement specifiers, so if you try upgrading to
version 0.3.2.RC1 by running \fBpip install \(aqGitPython==0.3.2.RC1\(aq\fP then it
will ignore this and simply install the version from the cache directory.
Therefore, it may be necessary to delete the GitPython directory from the
build cache in order to ensure that the specified version is installed.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%GitPython\fP 2.0.9 and newer is not compatible with Python 2.6. If installing
\fI\%GitPython\fP using pip on a machine running Python 2.6, make sure that a
version earlier than 2.0.9 is installed. This can be done on the CLI by
running \fBpip install \(aqGitPython<2.0.9\(aq\fP, or in a \fI\%pip.installed\fP state using the following SLS:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
GitPython:
  pip.installed:
    \- name: \(aqGitPython < 2.0.9\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Simple Configuration
.sp
To use the gitfs backend, only two configuration changes are required on the
master:
.INDENT 0.0
.IP 1. 3
Include \fBgitfs\fP in the \fI\%fileserver_backend\fP list in the
master config file:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_backend:
  \- gitfs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
\fBgit\fP also works here. Prior to the 2018.3.0 release, \fIonly\fP \fBgit\fP
would work.
.UNINDENT
.UNINDENT
.IP 2. 3
Specify one or more \fBgit://\fP, \fBhttps://\fP, \fBfile://\fP, or \fBssh://\fP
URLs in \fI\%gitfs_remotes\fP to configure which repositories to
cache and search for requested files:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- https://github.com/saltstack\-formulas/salt\-formula.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
SSH remotes can also be configured using scp\-like syntax:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- git@github.com:user/repo.git
  \- ssh://user@domain.tld/path/to/repo.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Information on how to authenticate to SSH remotes can be found \fI\%here\fP\&.
.IP 3. 3
Restart the master to load the new configuration.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In a master/minion setup, files from a gitfs remote are cached once by the
master, so minions do not need direct access to the git repository.
.UNINDENT
.UNINDENT
.SS Multiple Remotes
.sp
The \fBgitfs_remotes\fP option accepts an ordered list of git remotes to
cache and search, in listed order, for requested files.
.sp
A simple scenario illustrates this cascading lookup behavior:
.sp
If the \fBgitfs_remotes\fP option specifies three remotes:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- git://github.com/example/first.git
  \- https://github.com/example/second.git
  \- file:///root/third
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And each repository contains some files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
first.git:
    top.sls
    edit/vim.sls
    edit/vimrc
    nginx/init.sls
    shell/init.sls

second.git:
    edit/dev_vimrc
    haproxy/init.sls
    shell.sls

third:
    haproxy/haproxy.conf
    edit/dev_vimrc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt will attempt to lookup the requested file from each gitfs remote
repository in the order in which they are defined in the configuration. The
\fBgit://github.com/example/first.git\fP remote will be searched first.
If the requested file is found, then it is served and no further searching
is executed. For example:
.INDENT 0.0
.IP \(bu 2
A request for the file \fBsalt://haproxy/init.sls\fP will be served from
the \fBhttps://github.com/example/second.git\fP git repo.
.IP \(bu 2
A request for the file \fBsalt://haproxy/haproxy.conf\fP will be served from the
\fBfile:///root/third\fP repo.
.UNINDENT
.sp
Also a requested state file overrules a directory with an \fIinit.sls\fP\-file.
For example:
.INDENT 0.0
.IP \(bu 2
A request for \fBstate.apply shell\fP will be served from the
\fBhttps://github.com/example/second.git\fP git repo.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This example is purposefully contrived to illustrate the behavior of the
gitfs backend. This example should not be read as a recommended way to lay
out files and git repos.
.sp
The \fBfile://\fP prefix denotes a git repository in a local directory.
However, it will still use the given \fBfile://\fP URL as a remote,
rather than copying the git repo to the salt cache.  This means that any
refs you want accessible must exist as \fIlocal\fP refs in the specified repo.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Salt versions prior to 2014.1.0 are not tolerant of changing the
order of remotes or modifying the URI of existing remotes. In those
versions, when modifying remotes it is a good idea to remove the gitfs
cache directory (\fB/var/cache/salt/master/gitfs\fP) before restarting the
salt\-master service.
.UNINDENT
.UNINDENT
.SS Per\-remote Configuration Parameters
.sp
New in version 2014.7.0.

.sp
The following master config parameters are global (that is, they apply to all
configured gitfs remotes):
.INDENT 0.0
.IP \(bu 2
\fI\%gitfs_base\fP
.IP \(bu 2
\fI\%gitfs_root\fP
.IP \(bu 2
\fI\%gitfs_ssl_verify\fP
.IP \(bu 2
\fI\%gitfs_mountpoint\fP (new in 2014.7.0)
.IP \(bu 2
\fI\%gitfs_user\fP (\fBpygit2 only\fP, new in 2014.7.0)
.IP \(bu 2
\fI\%gitfs_password\fP (\fBpygit2 only\fP, new in 2014.7.0)
.IP \(bu 2
\fI\%gitfs_insecure_auth\fP (\fBpygit2 only\fP, new in 2014.7.0)
.IP \(bu 2
\fI\%gitfs_pubkey\fP (\fBpygit2 only\fP, new in 2014.7.0)
.IP \(bu 2
\fI\%gitfs_privkey\fP (\fBpygit2 only\fP, new in 2014.7.0)
.IP \(bu 2
\fI\%gitfs_passphrase\fP (\fBpygit2 only\fP, new in 2014.7.0)
.IP \(bu 2
\fI\%gitfs_refspecs\fP (new in 2017.7.0)
.IP \(bu 2
\fI\%gitfs_disable_saltenv_mapping\fP (new in 2018.3.0)
.IP \(bu 2
\fI\%gitfs_ref_types\fP (new in 2018.3.0)
.IP \(bu 2
\fI\%gitfs_update_interval\fP (new in 2018.3.0)
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
pygit2 only supports disabling SSL verification in versions 0.23.2 and
newer.
.UNINDENT
.UNINDENT
.sp
These parameters can now be overridden on a per\-remote basis. This allows for a
tremendous amount of customization. Here\(aqs some example usage:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_provider: pygit2
gitfs_base: develop

gitfs_remotes:
  \- https://foo.com/foo.git
  \- https://foo.com/bar.git:
    \- root: salt
    \- mountpoint: salt://bar
    \- base: salt\-base
    \- ssl_verify: False
    \- update_interval: 120
  \- https://foo.com/bar.git:
    \- name: second_bar_repo
    \- root: other/salt
    \- mountpoint: salt://other/bar
    \- base: salt\-base
    \- ref_types:
      \- branch
  \- http://foo.com/baz.git:
    \- root: salt/states
    \- user: joe
    \- password: mysupersecretpassword
    \- insecure_auth: True
    \- disable_saltenv_mapping: True
    \- saltenv:
      \- foo:
        \- ref: foo
  \- http://foo.com/quux.git:
    \- all_saltenvs: master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
There are two important distinctions which should be noted for per\-remote
configuration:
.INDENT 0.0
.IP 1. 3
The URL of a remote which has per\-remote configuration must be suffixed
with a colon.
.IP 2. 3
Per\-remote configuration parameters are named like the global versions,
with the \fBgitfs_\fP removed from the beginning. The exception being the
\fBname\fP, \fBsaltenv\fP, and \fBall_saltenvs\fP parameters, which are only
available to per\-remote configurations.
.UNINDENT
.sp
The \fBall_saltenvs\fP parameter is new in the 2018.3.0 release.
.UNINDENT
.UNINDENT
.sp
In the example configuration above, the following is true:
.INDENT 0.0
.IP 1. 3
The first and fourth gitfs remotes will use the \fBdevelop\fP branch/tag as the
\fBbase\fP environment, while the second and third will use the \fBsalt\-base\fP
branch/tag as the \fBbase\fP environment.
.IP 2. 3
The first remote will serve all files in the repository. The second
remote will only serve files from the \fBsalt\fP directory (and its
subdirectories). The third remote will only server files from the
\fBother/salt\fP directory (and its subdirectories), while the fourth remote
will only serve files from the \fBsalt/states\fP directory (and its
subdirectories).
.IP 3. 3
The third remote will only serve files from branches, and not from tags or
SHAs.
.IP 4. 3
The fourth remote will only have two saltenvs available: \fBbase\fP (pointed
at \fBdevelop\fP), and \fBfoo\fP (pointed at \fBfoo\fP).
.IP 5. 3
The first and fourth remotes will have files located under the root of the
Salt fileserver namespace (\fBsalt://\fP). The files from the second remote
will be located under \fBsalt://bar\fP, while the files from the third remote
will be located under \fBsalt://other/bar\fP\&.
.IP 6. 3
The second and third remotes reference the same repository and unique names
need to be declared for duplicate gitfs remotes.
.IP 7. 3
The fourth remote overrides the default behavior of \fI\%not authenticating
to insecure (non\-HTTPS) remotes\fP\&.
.IP 8. 3
Because \fBall_saltenvs\fP is configured for the fifth remote, files from the
branch/tag \fBmaster\fP will appear in every fileserver environment.
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
The use of \fBhttp://\fP (instead of \fBhttps://\fP) is permitted here
\fIonly\fP because authentication is not being used. Otherwise, the
\fBinsecure_auth\fP parameter must be used (as in the fourth remote) to
force Salt to authenticate to an \fBhttp://\fP remote.
.UNINDENT
.UNINDENT
.IP 9. 3
The first remote will wait 120 seconds between updates instead of 60.
.UNINDENT
.SS Per\-Saltenv Configuration Parameters
.sp
New in version 2016.11.0.

.sp
For more granular control, Salt allows the following three things to be
overridden for individual saltenvs within a given repo:
.INDENT 0.0
.IP \(bu 2
The \fI\%mountpoint\fP
.IP \(bu 2
The \fI\%root\fP
.IP \(bu 2
The branch/tag to be used for a given saltenv
.UNINDENT
.sp
Here is an example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_root: salt

gitfs_saltenv:
  \- dev:
    \- mountpoint: salt://gitfs\-dev
    \- ref: develop

gitfs_remotes:
  \- https://foo.com/bar.git:
    \- saltenv:
      \- staging:
        \- ref: qa
        \- mountpoint: salt://bar\-staging
      \- dev:
        \- ref: development
  \- https://foo.com/baz.git:
    \- saltenv:
      \- staging:
        \- mountpoint: salt://baz\-staging
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Given the above configuration, the following is true:
.INDENT 0.0
.IP 1. 3
For all gitfs remotes, files for the \fBdev\fP saltenv will be located under
\fBsalt://gitfs\-dev\fP\&.
.IP 2. 3
For the \fBdev\fP saltenv, files from the first remote will be sourced from
the \fBdevelopment\fP branch, while files from the second remote will be
sourced from the \fBdevelop\fP branch.
.IP 3. 3
For the \fBstaging\fP saltenv, files from the first remote will be located
under \fBsalt://bar\-staging\fP, while files from the second remote will be
located under \fBsalt://baz\-staging\fP\&.
.IP 4. 3
For all gitfs remotes, and in all saltenvs, files will be served from the
\fBsalt\fP directory (and its subdirectories).
.UNINDENT
.SS Custom Refspecs
.sp
New in version 2017.7.0.

.sp
GitFS will by default fetch remote branches and tags. However, sometimes it can
be useful to fetch custom refs (such as those created for \fI\%GitHub pull
requests\fP). To change the refspecs GitFS fetches, use the
\fI\%gitfs_refspecs\fP config option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_refspecs:
  \- \(aq+refs/heads/*:refs/remotes/origin/*\(aq
  \- \(aq+refs/tags/*:refs/tags/*\(aq
  \- \(aq+refs/pull/*/head:refs/remotes/origin/pr/*\(aq
  \- \(aq+refs/pull/*/merge:refs/remotes/origin/merge/*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above example, in addition to fetching remote branches and tags,
GitHub\(aqs custom refs for pull requests and merged pull requests will also be
fetched. These special \fBhead\fP refs represent the head of the branch which is
requesting to be merged, and the \fBmerge\fP refs represent the result of the
base branch after the merge.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
When using custom refspecs, the destination of the fetched refs \fImust\fP be
under \fBrefs/remotes/origin/\fP, preferably in a subdirectory like in the
example above. These custom refspecs will map as environment names using
their relative path underneath \fBrefs/remotes/origin/\fP\&. For example,
assuming the configuration above, the head branch for pull request 12345
would map to fileserver environment \fBpr/12345\fP (slash included).
.UNINDENT
.UNINDENT
.sp
Refspecs can be configured on a \fI\%per\-remote basis\fP\&. For example, the below configuration would only
alter the default refspecs for the \fIsecond\fP GitFS remote. The first remote
would only fetch branches and tags (the default).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- https://domain.tld/foo.git
  \- https://domain.tld/bar.git:
    \- refspecs:
      \- \(aq+refs/heads/*:refs/remotes/origin/*\(aq
      \- \(aq+refs/tags/*:refs/tags/*\(aq
      \- \(aq+refs/pull/*/head:refs/remotes/origin/pr/*\(aq
      \- \(aq+refs/pull/*/merge:refs/remotes/origin/merge/*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Global Remotes
.sp
New in version 2018.3.0: for all_saltenvs, 3001 for fallback

.sp
The \fBall_saltenvs\fP per\-remote configuration parameter overrides the logic
Salt uses to map branches/tags to fileserver environments (i.e. saltenvs). This
allows a single branch/tag to appear in \fIall\fP GitFS saltenvs.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBall_saltenvs\fP only works \fIwithin\fP GitFS. That is, files in a branch
configured using \fBall_saltenvs\fP will \fInot\fP show up in a fileserver
environment defined via some other fileserver backend (e.g.
\fI\%file_roots\fP).
.UNINDENT
.UNINDENT
.sp
The \fBfallback\fP global or per\-remote configuration can also be used.
.sp
This is very useful in particular when working with \fI\%salt formulas\fP\&. Prior to the addition of this feature, it was necessary
to push a branch/tag to the remote repo for each saltenv in which that formula
was to be used. If the formula needed to be updated, this update would need to
be reflected in all of the other branches/tags. This is both inconvenient and
not scalable.
.sp
With \fBall_saltenvs\fP, it is now possible to define your formula once, in a
single branch.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- http://foo.com/quux.git:
    \- all_saltenvs: anything
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you want to also test working branches of the formula repository, use
\fBfallback\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- http://foo.com/quux.git:
    \- fallback: anything
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Update Intervals
.sp
Prior to the 2018.3.0 release, GitFS would update its fileserver backends as part
of a dedicated \(dqmaintenance\(dq process, in which various routine maintenance
tasks were performed. This tied the update interval to the
\fI\%loop_interval\fP config option, and also forced all fileservers to
update at the same interval.
.sp
Now it is possible to make GitFS update at its own interval, using
\fI\%gitfs_update_interval\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_update_interval: 180

gitfs_remotes:
  \- https://foo.com/foo.git
  \- https://foo.com/bar.git:
    \- update_interval: 120
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using the above configuration, the first remote would update every three
minutes, while the second remote would update every two minutes.
.SS Configuration Order of Precedence
.sp
The order of precedence for GitFS configuration is as follows (each level
overrides all levels below it):
.INDENT 0.0
.IP 1. 3
Per\-saltenv configuration (defined under a per\-remote \fBsaltenv\fP
param)
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- https://foo.com/bar.git:
    \- saltenv:
      \- dev:
        \- mountpoint: salt://bar
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
Global per\-saltenv configuration (defined in \fI\%gitfs_saltenv\fP)
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_saltenv:
  \- dev:
    \- mountpoint: salt://bar
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
Per\-remote configuration parameter
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- https://foo.com/bar.git:
    \- mountpoint: salt://bar
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 4. 3
Global configuration parameter
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_mountpoint: salt://bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The one exception to the above is when \fI\%all_saltenvs\fP is used. This value overrides all logic for mapping
branches/tags to fileserver environments. So, even if
\fI\%gitfs_saltenv\fP is used to globally override the mapping for a
given saltenv, \fI\%all_saltenvs\fP would take
precedence for any remote which uses it.
.sp
It\(aqs important to note however that any \fBroot\fP and \fBmountpoint\fP values
configured in \fI\%gitfs_saltenv\fP (or \fI\%per\-saltenv
configuration\fP) would be unaffected by this.
.UNINDENT
.UNINDENT
.SS Serving from a Subdirectory
.sp
The \fI\%gitfs_root\fP parameter allows files to be served from a
subdirectory within the repository. This allows for only part of a repository
to be exposed to the Salt fileserver.
.sp
Assume the below layout:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\&.gitignore
README.txt
foo/
foo/bar/
foo/bar/one.txt
foo/bar/two.txt
foo/bar/three.txt
foo/baz/
foo/baz/top.sls
foo/baz/edit/vim.sls
foo/baz/edit/vimrc
foo/baz/nginx/init.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The below configuration would serve only the files under \fBfoo/baz\fP, ignoring
the other files in the repository:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- git://mydomain.com/stuff.git

gitfs_root: foo/baz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The root can also be configured on a \fI\%per\-remote basis\fP\&.
.SS Mountpoints
.sp
New in version 2014.7.0.

.sp
The \fI\%gitfs_mountpoint\fP parameter will prepend the specified path
to the files served from gitfs. This allows an existing repository to be used,
rather than needing to reorganize a repository or design it around the layout
of the Salt fileserver.
.sp
Before the addition of this feature, if a file being served up via gitfs was
deeply nested within the root directory (for example,
\fBsalt://webapps/foo/files/foo.conf\fP, it would be necessary to ensure that the
file was properly located in the remote repository, and that all of the
parent directories were present (for example, the directories
\fBwebapps/foo/files/\fP would need to exist at the root of the repository).
.sp
The below example would allow for a file \fBfoo.conf\fP at the root of the
repository to be served up from the Salt fileserver path
\fBsalt://webapps/foo/files/foo.conf\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- https://mydomain.com/stuff.git

gitfs_mountpoint: salt://webapps/foo/files
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Mountpoints can also be configured on a \fI\%per\-remote basis\fP\&.
.SS Using gitfs in Masterless Mode
.sp
Since 2014.7.0, gitfs can be used in masterless mode. To do so, simply add the
gitfs configuration parameters (and set \fI\%fileserver_backend\fP) in
the _minion_ config file instead of the master config file.
.SS Using gitfs Alongside Other Backends
.sp
Sometimes it may make sense to use multiple backends; for instance, if \fBsls\fP
files are stored in git but larger files are stored directly on the master.
.sp
The cascading lookup logic used for multiple remotes is also used with multiple
backends. If the \fI\%fileserver_backend\fP option contains multiple
backends:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_backend:
  \- roots
  \- git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then the \fBroots\fP backend (the default backend of files in \fB/srv/salt\fP) will
be searched first for the requested file; then, if it is not found on the
master, each configured git remote will be searched.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This can be used together with \fIfile_roots\fP accepting \fI__env__\fP as a catch\-all
environment, since 2018.3.5 and 2019.2.1:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt
  __env__:
    \- /srv/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Branches, Environments, and Top Files
.sp
When using the GitFS backend, branches, and tags will be mapped to environments
using the branch/tag name as an identifier.
.sp
There is one exception to this rule: the \fBmaster\fP branch is implicitly mapped
to the \fBbase\fP environment.
.sp
So, for a typical \fBbase\fP, \fBqa\fP, \fBdev\fP setup, the following branches could
be used:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master
qa
dev
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To map a branch other than \fBmaster\fP as the \fBbase\fP environment, use the
\fI\%gitfs_base\fP parameter.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_base: salt\-base
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The base can also be configured on a \fI\%per\-remote basis\fP\&.
.SS Use Case: Code Promotion (dev \-> qa \-> base)
.sp
When running a \fI\%highstate\fP, the \fBtop.sls\fP files from
all of the different branches and tags will be merged into one. This does not
work well with the use case where changes are tested in development branches
before being merged upstream towards production, because if the same SLS file
from multiple environments is part of the \fI\%highstate\fP,
it can result in non\-unique state IDs, which will cause an error in the state
compiler and not allow the \fI\%highstate\fP to proceed.
.sp
To accomplish this use case, you should do three things:
.INDENT 0.0
.IP 1. 3
Use \fB{{ saltenv }}\fP in place of your environment in your \fBtop.sls\fP\&. This
will let you use the same top file in all branches, because \fB{{ saltenv
}}\fP gets replaced with the effective saltenv of the environment being
processed.
.IP 2. 3
Set \fI\%top_file_merging_strategy\fP to \fBsame\fP in the minion
configuration. This will keep the \fBbase\fP environment from looking at the
\fBtop.sls\fP from the \fBdev\fP or \fBqa\fP branches, etc.
.IP 3. 3
Explicitly define your \fI\%saltenv\fP\&. (More on this below.)
.UNINDENT
.sp
Consider the following example top file and SLS file:
.sp
\fBtop.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ saltenv }}:
  \(aq*\(aq:
    \- mystuff
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBmystuff.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
manage_mystuff:
  pkg.installed:
    \- name: mystuff
  file.managed:
    \- name: /etc/mystuff.conf
    \- source: salt://mystuff/files/mystuff.conf
  service.running:
    \- name: mystuffd
    \- enable: True
    \- watch:
      \- file: /etc/mystuff.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Imagine for a moment that you need to change your \fBmystuff.conf\fP\&. So, you go
to your \fBdev\fP branch, edit \fBmystuff/files/mystuff.conf\fP, and commit and
push.
.sp
If you have only done the first two steps recommended above, and you run your
\fI\%highstate\fP, you will end up with conflicting IDs:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myminion:
    Data failed to compile:
\-\-\-\-\-\-\-\-\-\-
    Detected conflicting IDs, SLS IDs need to be globally unique.
    The conflicting ID is \(aqmanage_mystuff\(aq and is found in SLS \(aqbase:mystuff\(aq and SLS \(aqdev:mystuff\(aq
\-\-\-\-\-\-\-\-\-\-
    Detected conflicting IDs, SLS IDs need to be globally unique.
    The conflicting ID is \(aqmanage_mystuff\(aq and is found in SLS \(aqdev:mystuff\(aq and SLS \(aqqa:mystuff\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is because, in the absence of an explicit \fI\%saltenv\fP, all
environments\(aq top files are considered. Each environment looks at only its own
\fBtop.sls\fP, but because the \fBmystuff.sls\fP exists in each branch, they all
get pulled into the highstate, resulting in these conflicting IDs. This is why
explicitly setting your \fI\%saltenv\fP is important for this use case.
.sp
There are two ways of explicitly defining the \fI\%saltenv\fP:
.INDENT 0.0
.IP 1. 3
Set the \fI\%saltenv\fP in your minion configuration file. This
allows you to isolate which states are run to a specific branch/tag on a
given minion. This also works nicely if you have different salt deployments
for dev, qa, and prod. Boxes in dev can have \fI\%saltenv\fP set to
\fBdev\fP, boxes in \fBqa\fP can have the \fI\%saltenv\fP set to \fBqa\fP,
and boxes in prod can have the \fI\%saltenv\fP set to \fBbase\fP\&.
.IP 2. 3
At runtime, you can set the \fBsaltenv\fP like so:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion state.apply saltenv=dev
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A couple notes about setting the saltenv at runtime:
.INDENT 3.0
.IP \(bu 2
It will take precedence over the \fI\%saltenv\fP setting from the
minion config file, and pairs nicely with cases where you do not have
separate salt deployments for dev/qa/prod. You can have a box with
\fI\%saltenv\fP set to \fBbase\fP, which you can test your dev
changes on by running your \fBstate.apply\fP with \fBsaltenv=dev\fP\&.
.IP \(bu 2
If you don\(aqt set \fI\%saltenv\fP in the minion config file, you
_must_ specify it at runtime to avoid conflicting IDs.
.UNINDENT
.UNINDENT
.sp
If you branched \fBqa\fP off of \fBmaster\fP, and \fBdev\fP off of \fBqa\fP, you can
merge changes from \fBdev\fP into \fBqa\fP, and then merge \fBqa\fP into master to
promote your changes to from dev to qa to prod.
.SS Environment Whitelist/Blacklist
.sp
New in version 2014.7.0.

.sp
The \fI\%gitfs_saltenv_whitelist\fP and
\fI\%gitfs_saltenv_blacklist\fP parameters allow for greater control
over which branches/tags are exposed as fileserver environments. Exact matches,
globs, and regular expressions are supported, and are evaluated in that order.
If using a regular expression, \fB^\fP and \fB$\fP must be omitted, and the
expression must match the entire branch/tag.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_saltenv_whitelist:
  \- base
  \- v1.*
  \- \(aqmybranch\ed+\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBv1.*\fP, in this example, will match as both a glob and a regular
expression (though it will have been matched as a glob, since globs are
evaluated before regular expressions).
.UNINDENT
.UNINDENT
.sp
The behavior of the blacklist/whitelist will differ depending on which
combination of the two options is used:
.INDENT 0.0
.IP \(bu 2
If only \fI\%gitfs_saltenv_whitelist\fP is used, then \fBonly\fP
branches/tags which match the whitelist will be available as environments
.IP \(bu 2
If only \fI\%gitfs_saltenv_blacklist\fP is used, then the
branches/tags which match the blacklist will \fBnot\fP be available as
environments
.IP \(bu 2
If both are used, then the branches/tags which match the whitelist, but do
\fBnot\fP match the blacklist, will be available as environments.
.UNINDENT
.SS Authentication
.SS pygit2
.sp
New in version 2014.7.0.

.sp
Both HTTPS and SSH authentication are supported as of version 0.20.3, which is
the earliest version of \fI\%pygit2\fP supported by Salt for gitfs.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The examples below make use of per\-remote configuration parameters, a
feature new to Salt 2014.7.0. More information on these can be found
\fI\%here\fP\&.
.UNINDENT
.UNINDENT
.SS HTTPS
.sp
For HTTPS repositories which require authentication, the username and password
can be provided like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- https://domain.tld/myrepo.git:
    \- user: git
    \- password: mypassword
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the repository is served over HTTP instead of HTTPS, then Salt will by
default refuse to authenticate to it. This behavior can be overridden by adding
an \fBinsecure_auth\fP parameter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- http://domain.tld/insecure_repo.git:
    \- user: git
    \- password: mypassword
    \- insecure_auth: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS SSH
.sp
SSH repositories can be configured using the \fBssh://\fP protocol designation,
or using scp\-like syntax. So, the following two configurations are equivalent:
.INDENT 0.0
.IP \(bu 2
\fBssh://git@github.com/user/repo.git\fP
.IP \(bu 2
\fBgit@github.com:user/repo.git\fP
.UNINDENT
.sp
Both \fI\%gitfs_pubkey\fP and \fI\%gitfs_privkey\fP (or their
\fI\%per\-remote counterparts\fP) must be configured in
order to authenticate to SSH\-based repos. If the private key is protected with
a passphrase, it can be configured using \fI\%gitfs_passphrase\fP (or
simply \fBpassphrase\fP if being configured \fI\%per\-remote\fP). For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- git@github.com:user/repo.git:
    \- pubkey: /root/.ssh/id_rsa.pub
    \- privkey: /root/.ssh/id_rsa
    \- passphrase: myawesomepassphrase
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Finally, the SSH host key must be \fI\%added to the known_hosts file\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
There is a known issue with public\-key SSH authentication to Microsoft
Visual Studio (VSTS) with pygit2. This is due to a bug or lack of support
for VSTS in older libssh2 releases. Known working releases include libssh2
1.7.0 and later, and known incompatible releases include 1.5.0 and older.
At the time of this writing, 1.6.0 has not been tested.
.sp
Since upgrading libssh2 would require rebuilding many other packages (curl,
etc.), followed by a rebuild of libgit2 and a reinstall of pygit2, an
easier workaround for systems with older libssh2 is to use GitPython with a
passphraseless key for authentication.
.UNINDENT
.UNINDENT
.SS GitPython
.SS HTTPS
.sp
For HTTPS repositories which require authentication, the username and password
can be configured in one of two ways. The first way is to include them in the
URL using the format \fBhttps://<user>:<password>@<url>\fP, like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- https://git:mypassword@domain.tld/myrepo.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The other way would be to configure the authentication in \fB/var/lib/salt/.netrc\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
machine domain.tld
login git
password mypassword
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the repository is served over HTTP instead of HTTPS, then Salt will by
default refuse to authenticate to it. This behavior can be overridden by adding
an \fBinsecure_auth\fP parameter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- http://git:mypassword@domain.tld/insecure_repo.git:
    \- insecure_auth: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS SSH
.sp
Only passphrase\-less SSH public key authentication is supported using
GitPython. \fBThe auth parameters (pubkey, privkey, etc.) shown in the pygit2
authentication examples above do not work with GitPython.\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- ssh://git@github.com/example/salt\-states.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Since \fI\%GitPython\fP wraps the git CLI, the private key must be located in
\fB~/.ssh/id_rsa\fP for the user under which the Master is running, and should
have permissions of \fB0600\fP\&. Also, in the absence of a user in the repo URL,
\fI\%GitPython\fP will (just as SSH does) attempt to login as the current user (in
other words, the user under which the Master is running, usually \fBroot\fP).
.sp
If a key needs to be used, then \fB~/.ssh/config\fP can be configured to use
the desired key. Information on how to do this can be found by viewing the
manpage for \fBssh_config\fP\&. Here\(aqs an example entry which can be added to the
\fB~/.ssh/config\fP to use an alternate key for gitfs:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Host github.com
    IdentityFile /root/.ssh/id_rsa_gitfs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBHost\fP parameter should be a hostname (or hostname glob) that matches the
domain name of the git repository.
.sp
It is also necessary to \fI\%add the SSH host key to the known_hosts file\fP\&. The exception to this would be if strict host key
checking is disabled, which can be done by adding \fBStrictHostKeyChecking no\fP
to the entry in \fB~/.ssh/config\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Host github.com
    IdentityFile /root/.ssh/id_rsa_gitfs
    StrictHostKeyChecking no
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, this is generally regarded as insecure, and is not recommended.
.SS Adding the SSH Host Key to the known_hosts File
.sp
To use SSH authentication, it is necessary to have the remote repository\(aqs SSH
host key in the \fB~/.ssh/known_hosts\fP file. If the master is also a minion,
this can be done using the \fI\%ssh.set_known_host\fP function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt mymaster ssh.set_known_host user=root hostname=github.com
mymaster:
    \-\-\-\-\-\-\-\-\-\-
    new:
        \-\-\-\-\-\-\-\-\-\-
        enc:
            ssh\-rsa
        fingerprint:
            16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48
        hostname:
            |1|OiefWWqOD4kwO3BhoIGa0loR5AA=|BIXVtmcTbPER+68HvXmceodDcfI=
        key:
            AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==
    old:
        None
    status:
        updated
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If not, then the easiest way to add the key is to su to the user (usually
\fBroot\fP) under which the salt\-master runs and attempt to login to the
server via SSH:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ su \-
Password:
# ssh github.com
The authenticity of host \(aqgithub.com (192.30.252.128)\(aq can\(aqt be established.
RSA key fingerprint is 16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added \(aqgithub.com,192.30.252.128\(aq (RSA) to the list of known hosts.
Permission denied (publickey).
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It doesn\(aqt matter if the login was successful, as answering \fByes\fP will write
the fingerprint to the known_hosts file.
.SS Verifying the Fingerprint
.sp
To verify that the correct fingerprint was added, it is a good idea to look it
up. One way to do this is to use \fBnmap\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ nmap \-p 22 github.com \-\-script ssh\-hostkey

Starting Nmap 5.51 ( http://nmap.org ) at 2014\-08\-18 17:47 CDT
Nmap scan report for github.com (192.30.252.129)
Host is up (0.17s latency).
Not shown: 996 filtered ports
PORT     STATE SERVICE
22/tcp   open  ssh
| ssh\-hostkey: 1024 ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c (DSA)
|_2048 16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48 (RSA)
80/tcp   open  http
443/tcp  open  https
9418/tcp open  git

Nmap done: 1 IP address (1 host up) scanned in 28.78 seconds
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Another way is to check one\(aqs own \fBknown_hosts\fP file, using this one\-liner:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ ssh\-keygen \-l \-f /dev/stdin <<<\(gassh\-keyscan github.com 2>/dev/null\(ga | awk \(aq{print $2}\(aq
16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
AWS tracks usage of nmap and may flag it as abuse. On AWS hosts, the
\fBssh\-keygen\fP method is recommended for host key verification.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
As of \fI\%OpenSSH 6.8\fP the SSH fingerprint is now shown as a base64\-encoded
SHA256 checksum of the host key. So, instead of the fingerprint looking
like \fB16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48\fP, it would look
like \fBSHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8\fP\&.
.UNINDENT
.UNINDENT
.SS Refreshing gitfs Upon Push
.sp
By default, Salt updates the remote fileserver backends every 60 seconds.
However, if it is desirable to refresh quicker than that, the \fI\%Reactor
System\fP can be used to signal the master to update the fileserver on
each push, provided that the git server is also a Salt minion. There are three
steps to this process:
.INDENT 0.0
.IP 1. 3
On the master, create a file \fB/srv/reactor/update_fileserver.sls\fP, with
the following contents:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
update_fileserver:
  runner.fileserver.update
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
Add the following reactor configuration to the master config file:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
reactor:
  \- \(aqsalt/fileserver/gitfs/update\(aq:
    \- /srv/reactor/update_fileserver.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
On the git server, add a \fI\%post\-receive hook\fP
.INDENT 3.0
.IP a. 3
If the user executing \fIgit push\fP is the same as the minion user, use the following hook:
.UNINDENT
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!/usr/bin/env sh
salt\-call event.fire_master update salt/fileserver/gitfs/update
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 3.0
.IP b. 3
To enable other git users to run the hook after a \fIpush\fP, use sudo in the hook script:
.UNINDENT
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!/usr/bin/env sh
sudo \-u root salt\-call event.fire_master update salt/fileserver/gitfs/update
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 4. 3
If using sudo in the git hook (above), the policy must be changed to permit
all users to fire the event.  Add the following policy to the sudoers file
on the git server.
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
Cmnd_Alias SALT_GIT_HOOK = /bin/salt\-call event.fire_master update salt/fileserver/gitfs/update
Defaults!SALT_GIT_HOOK !requiretty
ALL ALL=(root) NOPASSWD: SALT_GIT_HOOK
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The \fBupdate\fP argument right after \fI\%event.fire_master\fP in this example can really be anything, as it
represents the data being passed in the event, and the passed data is ignored
by this reactor.
.sp
Similarly, the tag name \fBsalt/fileserver/gitfs/update\fP can be replaced by
anything, so long as the usage is consistent.
.sp
The \fBroot\fP user name in the hook script and sudo policy should be changed to
match the user under which the minion is running.
.SS Using Git as an External Pillar Source
.sp
The git external pillar (a.k.a. git_pillar) has been rewritten for the 2015.8.0
release. This rewrite brings with it \fI\%pygit2\fP support (allowing for access to
authenticated repositories), as well as more granular support for per\-remote
configuration. This configuration schema is detailed \fI\%here\fP\&.
.SS Why aren\(aqt my custom modules/states/etc. syncing to my Minions?
.sp
In versions 0.16.3 and older, when using the \fI\%git fileserver backend\fP, certain versions of GitPython may generate errors
when fetching, which Salt fails to catch. While not fatal to the fetch process,
these interrupt the fileserver update that takes place before custom types are
synced, and thus interrupt the sync itself. Try disabling the git fileserver
backend in the master config, restarting the master, and attempting the sync
again.
.sp
This issue is worked around in Salt 0.16.4 and newer.
.SS MinionFS Backend Walkthrough
.sp
New in version 2014.1.0.

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This walkthrough assumes basic knowledge of Salt and \fI\%cp.push\fP\&. To get up to speed, check out the
\fI\%Salt Walkthrough\fP\&.
.UNINDENT
.UNINDENT
.sp
Sometimes it is desirable to deploy a file located on one minion to one or more
other minions. This is supported in Salt, and can be accomplished in two parts:
.INDENT 0.0
.IP 1. 3
Minion support for pushing files to the master (using \fI\%cp.push\fP)
.IP 2. 3
The \fI\%minionfs\fP fileserver backend
.UNINDENT
.sp
This walkthrough will show how to use both of these features.
.SS Enabling File Push
.sp
To set the master to accept files pushed from minions, the
\fI\%file_recv\fP option in the master config file must be set to
\fBTrue\fP (the default is \fBFalse\fP).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_recv: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This change requires a restart of the salt\-master service.
.UNINDENT
.UNINDENT
.SS Pushing Files
.sp
Once this has been done, files can be pushed to the master using the
\fI\%cp.push\fP function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq cp.push /path/to/the/file
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This command will store the file in a subdirectory named \fBminions\fP under the
master\(aqs \fI\%cachedir\fP\&. On most masters, this path will be
\fB/var/cache/salt/master/minions\fP\&. Within this directory will be one directory
for each minion which has pushed a file to the master, and underneath that the
full path to the file on the minion. So, for example, if a minion with an ID of
\fBdev1\fP pushed a file \fB/var/log/myapp.log\fP to the master, it would be saved
to \fB/var/cache/salt/master/minions/dev1/var/log/myapp.log\fP\&.
.SS Serving Pushed Files Using MinionFS
.sp
While it is certainly possible to add \fB/var/cache/salt/master/minions\fP to the
master\(aqs \fI\%file_roots\fP and serve these files, it may only be
desirable to expose files pushed from certain minions. Adding
\fB/var/cache/salt/master/minions/<minion\-id>\fP for each minion that needs to be
exposed can be cumbersome and prone to errors.
.sp
Enter \fI\%minionfs\fP\&. This fileserver backend will
make files pushed using \fI\%cp.push\fP available to
the Salt fileserver, and provides an easy mechanism to restrict which minions\(aq
pushed files are made available.
.SS Simple Configuration
.sp
To use the \fI\%minionfs\fP backend, add \fBminionfs\fP
to the list of backends in the \fI\%fileserver_backend\fP configuration
option on the master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_recv: True

fileserver_backend:
  \- roots
  \- minionfs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBminion\fP also works here. Prior to the 2018.3.0 release, \fIonly\fP
\fBminion\fP would work.
.sp
Also, as described earlier, \fBfile_recv: True\fP is needed to enable the
master to receive files pushed from minions. As always, changes to the
master configuration require a restart of the \fBsalt\-master\fP service.
.UNINDENT
.UNINDENT
.sp
Files made available via \fI\%minionfs\fP are by
default located at \fBsalt://<minion\-id>/path/to/file\fP\&. Think back to the
earlier example, in which \fBdev1\fP pushed a file \fB/var/log/myapp.log\fP to the
master. With \fI\%minionfs\fP enabled, this file
would be addressable in Salt at \fBsalt://dev1/var/log/myapp.log\fP\&.
.sp
If many minions have pushed to the master, this will result in many directories
in the root of the Salt fileserver. For this reason, it is recommended to use
the \fI\%minionfs_mountpoint\fP config option to organize these files
underneath a subdirectory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minionfs_mountpoint: salt://minionfs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using the above mountpoint, the file in the example would be located at
\fBsalt://minionfs/dev1/var/log/myapp.log\fP\&.
.SS Restricting Certain Minions\(aq Files from Being Available Via MinionFS
.sp
A whitelist and blacklist can be used to restrict the minions whose pushed
files are available via \fI\%minionfs\fP\&. These lists
can be managed using the \fI\%minionfs_whitelist\fP and
\fI\%minionfs_blacklist\fP config options. Click the links for both of
them for a detailed explanation of how to use them.
.sp
A more complex configuration example, which uses both a whitelist and
blacklist, can be found below:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_recv: True

fileserver_backend:
  \- roots
  \- minionfs

minionfs_mountpoint: salt://minionfs

minionfs_whitelist:
  \- host04
  \- web*
  \- \(aqmail\ed+\e.domain\e.tld\(aq

minionfs_blacklist:
  \- web21
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Potential Concerns
.INDENT 0.0
.IP \(bu 2
There is no access control in place to restrict which minions have access to
files served up by \fI\%minionfs\fP\&. All minions
will have access to these files.
.IP \(bu 2
Unless the \fI\%minionfs_whitelist\fP and/or
\fI\%minionfs_blacklist\fP config options are used, all minions which
push files to the master will have their files made available via
\fI\%minionfs\fP\&.
.UNINDENT
.SS Salt Package Manager
.sp
The Salt Package Manager, or \fI\%SPM\fP, enables Salt formulas to be packaged to simplify
distribution to Salt masters. The design of SPM was influenced by other existing packaging
systems including RPM, Yum, and Pacman.
[image]
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The previous diagram shows each SPM component as a different system, but this
is not required. You can build packages and host the SPM repo on
a single Salt master if you\(aqd like.
.UNINDENT
.UNINDENT
.sp
\fBPackaging System\fP
.sp
The packaging system is used to package the state, pillar, file templates, and other
files used by your formula into a single file. After a formula package is
created, it is copied to the Repository System where it is made available to
Salt masters.
.sp
See \fI\%Building SPM Packages\fP
.sp
\fBRepo System\fP
.sp
The Repo system stores the SPM package and metadata files and makes them
available to Salt masters via http(s), ftp, or file URLs. SPM repositories can be
hosted on a Salt Master, a Salt Minion, or on another system.
.sp
See \fI\%Distributing SPM Packages\fP
.sp
\fBSalt Master\fP
.sp
SPM provides Salt master settings that let you configure the URL of one or more
SPM repos. You can then quickly install packages that contain entire formulas
to your Salt masters using SPM.
.sp
See \fI\%Installing SPM Packages\fP
.sp
\fBContents\fP
.SS Building SPM Packages
.sp
The first step when using Salt Package Manager is to build packages for each of
of the formulas that you want to distribute. Packages can be built on any
system where you can install Salt.
.SS Package Build Overview
.sp
To build a package, all state, pillar, jinja, and file templates used by your
formula are assembled into a folder on the build system. These files can be
cloned from a Git repository, such as those found at the \fI\%saltstack\-formulas\fP organization on GitHub, or copied
directly to the folder.
.sp
The following diagram demonstrates
a typical formula layout on the build system:
[image]
.sp
In this example, all formula files are placed in a \fBmyapp\-formula\fP folder.
This is the folder that is targeted by the \fBspm build\fP command when this
package is built.
.sp
Within this folder, pillar data is placed in
a \fBpillar.example\fP file at the root, and all state, jinja, and template files
are placed within a subfolder that is named after the application being
packaged. State files are typically contained within a subfolder, similar to
how state files are organized in the state tree. Any non\-pillar files
in your package that are not contained in a subfolder are placed at the root
of the spm state tree.
.sp
Additionally, a \fI\%FORMULA\fP file is created and placed in the
root of the folder. This file contains package metadata that is used by SPM.
.SS Package Installation Overview
.sp
When building packages, it is useful to know where files are installed on the
Salt master. During installation, all files except \fBpillar.example\fP and \fBFORMULA\fP are copied
directly to the spm state tree on the Salt master (located at
\fB\esrv\espm\esalt\fP).
.sp
If a \fBpillar.example\fP file is present in the root, it is renamed to
\fB<formula name>.sls.orig\fP and placed in the \fBpillar_path\fP\&.
[image]
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Even though the pillar data file is copied to the pillar root, you still
need to manually assign this pillar data to systems using the pillar top
file. This file can also be duplicated and renamed so the \fB\&.orig\fP
version is left intact in case you need to restore it later.
.UNINDENT
.UNINDENT
.SS Building an SPM Formula Package
.INDENT 0.0
.IP 1. 3
Assemble formula files in a folder on the build system.
.IP 2. 3
Create a \fI\%FORMULA\fP file and place it in the root of the package folder.
.IP 3. 3
Run \fBspm build <folder name>\fP\&. The package is built and placed in the \fB/srv/spm_build\fP folder.
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
spm build /path/to/salt\-packages\-source/myapp\-formula
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 4. 3
Copy the \fB\&.spm\fP file to a folder on the \fI\%repository system\fP\&.
.UNINDENT
.SS Types of Packages
.sp
SPM supports different types of packages. The function of each package
is denoted by its name. For instance, packages which end in \fB\-formula\fP are
considered to be Salt States (the most common type of formula). Packages which
end in \fB\-conf\fP contain configuration which is to be placed in the
\fB/etc/salt/\fP directory. Packages which do not contain one of these names are
treated as if they have a \fB\-formula\fP name.
.SS formula
.sp
By default, most files from this type of package live in the \fB/srv/spm/salt/\fP
directory. The exception is the \fBpillar.example\fP file, which will be renamed
to \fB<package_name>.sls\fP and placed in the pillar directory (\fB/srv/spm/pillar/\fP
by default).
.SS reactor
.sp
By default, files from this type of package live in the \fB/srv/spm/reactor/\fP
directory.
.SS conf
.sp
The files in this type of package are configuration files for Salt, which
normally live in the \fB/etc/salt/\fP directory. Configuration files for packages
other than Salt can and should be handled with a Salt State (using a \fBformula\fP
type of package).
.SS Technical Information
.sp
Packages are built using BZ2\-compressed tarballs. By default, the package
database is stored using the \fBsqlite3\fP driver (see Loader Modules below).
.sp
Support for these are built into Python, and so no external dependencies are
needed.
.sp
All other files belonging to SPM use YAML, for portability and ease of use and
maintainability.
.SS SPM\-Specific Loader Modules
.sp
SPM was designed to behave like traditional package managers, which apply files
to the filesystem and store package metadata in a local database. However,
because modern infrastructures often extend beyond those use cases, certain
parts of SPM have been broken out into their own set of modules.
.SS Package Database
.sp
By default, the package database is stored using the \fBsqlite3\fP module. This
module was chosen because support for SQLite3 is built into Python itself.
.sp
Please see the SPM Development Guide for information on creating new modules
for package database management.
.SS Package Files
.sp
By default, package files are installed using the \fBlocal\fP module. This module
applies files to the local filesystem, on the machine that the package is
installed on.
.sp
Please see the \fI\%SPM Development Guide\fP for information
on creating new modules for package file management.
.SS Distributing SPM Packages
.sp
SPM packages can be distributed to Salt masters over HTTP(S), FTP, or through the
file system. The SPM repo can be hosted on any system where you can install
Salt. Salt is installed so you can run the \fBspm create_repo\fP command when you
update or add a package to the repo. SPM repos do not require the salt\-master,
salt\-minion, or any other process running on the system.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you are hosting the SPM repo on a system where you can not or do not
want to install Salt, you can run the \fBspm create_repo\fP command on the
build system and then copy the packages and the generated \fBSPM\-METADATA\fP
file to the repo. You can also install SPM files \fI\%directly on a Salt
master\fP, bypassing the repository completely.
.UNINDENT
.UNINDENT
.SS Setting up a Package Repository
.sp
After packages are built, the generated SPM files are placed in the
\fBsrv/spm_build\fP folder.
.sp
Where you place the built SPM files on your repository server depends on how
you plan to make them available to your Salt masters.
.sp
You can share the \fBsrv/spm_build\fP folder on the network, or copy the files to
your FTP or Web server.
.SS Adding a Package to the repository
.sp
New packages are added by simply copying the SPM file to the repo folder, and then
generating repo metadata.
.SS Generate Repo Metadata
.sp
Each time you update or add an SPM package to your repository, issue an \fBspm
create_repo\fP command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
spm create_repo /srv/spm_build
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
SPM generates the repository metadata for all of the packages in that directory
and places it in an \fBSPM\-METADATA\fP file at the folder root. This command is
used even if repository metadata already exists in that directory.
.SS Installing SPM Packages
.sp
SPM packages are installed to your Salt master, where they are available to Salt minions
using all of Salt\(aqs package management functions.
.SS Configuring Remote Repositories
.sp
Before SPM can use a repository, two things need to happen. First, the Salt master needs to
know where the repository is through a configuration process. Then it needs to pull down the repository
metadata.
.SS Repository Configuration Files
.sp
Repositories are configured by adding each of them to the
\fB/etc/salt/spm.repos.d/spm.repo\fP file on each Salt master. This file contains
the name of the repository, and the link to the repository:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_repo:
  url: https://spm.example.com/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For HTTP/HTTPS Basic authorization you can define credentials:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_repo:
  url: https://spm.example.com/
  username: user
  password: pass
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Beware of unauthorized access to this file, please set at least 0640 permissions for this configuration file:
.sp
The URL can use \fBhttp\fP, \fBhttps\fP, \fBftp\fP, or \fBfile\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_repo:
  url: file:///srv/spm_build
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Updating Local Repository Metadata
.sp
After the repository is configured on the Salt master, repository metadata is
downloaded using the \fBspm update_repo\fP command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
spm update_repo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
A file for each repo is placed in \fB/var/cache/salt/spm\fP on the Salt master
after you run the \fIupdate_repo\fP command. If you add a repository and it
does not seem to be showing up, check this path to verify that the
repository was found.
.UNINDENT
.UNINDENT
.SS Update File Roots
.sp
SPM packages are installed to the \fBsrv/spm/salt\fP folder on your Salt master.
This path needs to be added to the file roots on your Salt master
manually.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt
    \- /srv/spm/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Restart the salt\-master service after updating the \fBfile_roots\fP setting.
.SS Installing Packages
.sp
To install a package, use the \fBspm install\fP command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
spm install apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Currently, SPM does not check to see if files are already in place before
installing them. That means that existing files will be overwritten without
warning.
.UNINDENT
.UNINDENT
.SS Installing directly from an SPM file
.sp
You can also install SPM packages using a local SPM file using the \fBspm local
install\fP command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
spm local install /srv/spm/apache\-201506\-1.spm
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
An SPM repository is not required when using \fIspm local install\fP\&.
.SS Pillars
.sp
If an installed package includes Pillar data, be sure to target the installed
pillar to the necessary systems using the pillar Top file.
.SS Removing Packages
.sp
Packages may be removed after they are installed using the \fBspm remove\fP
command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
spm remove apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If files have been modified, they will not be removed. Empty directories will
also be removed.
.SS SPM Configuration
.sp
There are a number of options that are specific to SPM. They may be configured
in the \fBmaster\fP configuration file, or in SPM\(aqs own \fBspm\fP configuration
file (normally located at \fB/etc/salt/spm\fP). If configured in both places, the
\fBspm\fP file takes precedence. In general, these values will not need to be
changed from the defaults.
.SS spm_logfile
.sp
Default: \fB/var/log/salt/spm\fP
.sp
Where SPM logs messages.
.SS spm_repos_config
.sp
Default: \fB/etc/salt/spm.repos\fP
.sp
SPM repositories are configured with this file. There is also a directory which
corresponds to it, which ends in \fB\&.d\fP\&. For instance, if the filename is
\fB/etc/salt/spm.repos\fP, the directory will be \fB/etc/salt/spm.repos.d/\fP\&.
.SS spm_cache_dir
.sp
Default: \fB/var/cache/salt/spm\fP
.sp
When SPM updates package repository metadata and downloads packaged, they will
be placed in this directory. The package database, normally called
\fBpackages.db\fP, also lives in this directory.
.SS spm_db
.sp
Default: \fB/var/cache/salt/spm/packages.db\fP
.sp
The location and name of the package database. This database stores the names of
all of the SPM packages installed on the system, the files that belong to them,
and the metadata for those files.
.SS spm_build_dir
.sp
Default: \fB/srv/spm_build\fP
.sp
When packages are built, they will be placed in this directory.
.SS spm_build_exclude
.sp
Default: \fB[\(aq.git\(aq]\fP
.sp
When SPM builds a package, it normally adds all files in the formula directory
to the package. Files listed here will be excluded from that package. This
option requires a list to be specified.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
spm_build_exclude:
  \- .git
  \- .svn
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Types of Packages
.sp
SPM supports different types of formula packages. The function of each package
is denoted by its name. For instance, packages which end in \fB\-formula\fP are
considered to be Salt States (the most common type of formula). Packages which
end in \fB\-conf\fP contain configuration which is to be placed in the
\fB/etc/salt/\fP directory. Packages which do not contain one of these names are
treated as if they have a \fB\-formula\fP name.
.SS formula
.sp
By default, most files from this type of package live in the \fB/srv/spm/salt/\fP
directory. The exception is the \fBpillar.example\fP file, which will be renamed
to \fB<package_name>.sls\fP and placed in the pillar directory (\fB/srv/spm/pillar/\fP
by default).
.SS reactor
.sp
By default, files from this type of package live in the \fB/srv/spm/reactor/\fP
directory.
.SS conf
.sp
The files in this type of package are configuration files for Salt, which
normally live in the \fB/etc/salt/\fP directory. Configuration files for packages
other than Salt can and should be handled with a Salt State (using a \fBformula\fP
type of package).
.SS FORMULA File
.sp
In addition to the formula itself, a \fBFORMULA\fP file must exist which
describes the package. An example of this file is:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: apache
os: RedHat, Debian, Ubuntu, SUSE, FreeBSD
os_family: RedHat, Debian, Suse, FreeBSD
version: 201506
release: 2
summary: Formula for installing Apache
description: Formula for installing Apache
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Required Fields
.sp
This file must contain at least the following fields:
.SS name
.sp
The name of the package, as it will appear in the package filename, in the
repository metadata, and the package database. Even if the source formula has
\fB\-formula\fP in its name, this name should probably not include that. For
instance, when packaging the \fBapache\-formula\fP, the name should be set to
\fBapache\fP\&.
.SS os
.sp
The value of the \fBos\fP grain that this formula supports. This is used to
help users know which operating systems can support this package.
.SS os_family
.sp
The value of the \fBos_family\fP grain that this formula supports. This is used to
help users know which operating system families can support this package.
.SS version
.sp
The version of the package. While it is up to the organization that manages this
package, it is suggested that this version is specified in a \fBYYYYMM\fP format.
For instance, if this version was released in June 2015, the package version
should be \fB201506\fP\&. If multiple releases are made in a month, the \fBrelease\fP
field should be used.
.SS minimum_version
.sp
Minimum recommended version of Salt to use this formula. Not currently enforced.
.SS release
.sp
This field refers primarily to a release of a version, but also to multiple
versions within a month. In general, if a version has been made public, and
immediate updates need to be made to it, this field should also be updated.
.SS summary
.sp
A one\-line description of the package.
.SS description
.sp
A more detailed description of the package which can contain more than one line.
.SS Optional Fields
.sp
The following fields may also be present.
.SS top_level_dir
.sp
This field is optional, but highly recommended. If it is not specified, the
package name will be used.
.sp
Formula repositories typically do not store \fB\&.sls\fP files in the root of the
repository; instead they are stored in a subdirectory. For instance, an
\fBapache\-formula\fP repository would contain a directory called \fBapache\fP, which
would contain an \fBinit.sls\fP, plus a number of other related files. In this
instance, the \fBtop_level_dir\fP should be set to \fBapache\fP\&.
.sp
Files outside the \fBtop_level_dir\fP, such as \fBREADME.rst\fP, \fBFORMULA\fP, and
\fBLICENSE\fP will not be installed. The exceptions to this rule are files that
are already treated specially, such as \fBpillar.example\fP and \fB_modules/\fP\&.
.SS dependencies
.sp
A comma\-separated list of packages that must be installed along with this
package. When this package is installed, SPM will attempt to discover and
install these packages as well. If it is unable to, then it will refuse to
install this package.
.sp
This is useful for creating packages which tie together other packages. For
instance, a package called wordpress\-mariadb\-apache would depend upon
wordpress, mariadb, and apache.
.SS optional
.sp
A comma\-separated list of packages which are related to this package, but are
neither required nor necessarily recommended. This list is displayed in an
informational message when the package is installed to SPM.
.SS recommended
.sp
A comma\-separated list of optional packages that are recommended to be
installed with the package. This list is displayed in an informational message
when the package is installed to SPM.
.SS files
.sp
A files section can be added, to specify a list of files to add to the SPM.
Such a section might look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
files:
  \- _pillar
  \- FORMULA
  \- _runners
  \- d|mymodule/index.rst
  \- r|README.rst
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When \fBfiles\fP are specified, then only those files will be added to the SPM,
regardless of what other files exist in the directory. They will also be added
in the order specified, which is useful if you have a need to lay down files in
a specific order.
.sp
As can be seen in the example above, you may also tag files as being a specific
type. This is done by pre\-pending a filename with its type, followed by a pipe
(\fB|\fP) character. The above example contains a document file and a readme. The
available file types are:
.INDENT 0.0
.IP \(bu 2
\fBc\fP: config file
.IP \(bu 2
\fBd\fP: documentation file
.IP \(bu 2
\fBg\fP: ghost file (i.e. the file contents are not included in the package payload)
.IP \(bu 2
\fBl\fP: license file
.IP \(bu 2
\fBr\fP: readme file
.IP \(bu 2
\fBs\fP: SLS file
.IP \(bu 2
\fBm\fP: Salt module
.UNINDENT
.sp
The first 5 of these types (\fBc\fP, \fBd\fP, \fBg\fP, \fBl\fP, \fBr\fP) will be placed in
\fB/usr/share/salt/spm/\fP by default. This can be changed by setting an
\fBspm_share_dir\fP value in your \fB/etc/salt/spm\fP configuration file.
.sp
The last two types (\fBs\fP and \fBm\fP) are currently ignored, but they are
reserved for future use.
.SS Pre and Post States
.sp
It is possible to run Salt states before and after installing a package by
using pre and post states. The following sections may be declared in a
\fBFORMULA\fP:
.INDENT 0.0
.IP \(bu 2
\fBpre_local_state\fP
.IP \(bu 2
\fBpre_tgt_state\fP
.IP \(bu 2
\fBpost_local_state\fP
.IP \(bu 2
\fBpost_tgt_state\fP
.UNINDENT
.sp
Sections with \fBpre\fP in their name are evaluated before a package is installed
and sections with \fBpost\fP are evaluated after a package is installed. \fBlocal\fP
states are evaluated before \fBtgt\fP states.
.sp
Each of these sections needs to be evaluated as text, rather than as YAML.
Consider the following block:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pre_local_state: >
  echo test > /tmp/spmtest:
    cmd:
      \- run
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that this declaration uses \fB>\fP after \fBpre_local_state\fP\&. This is a YAML
marker that marks the next multi\-line block as text, including newlines. It is
important to use this marker whenever declaring \fBpre\fP or \fBpost\fP states, so
that the text following it can be evaluated properly.
.SS local States
.sp
\fBlocal\fP states are evaluated locally; this is analogous to issuing a state
run using a \fBsalt\-call \-\-local\fP command. These commands will be issued on the
local machine running the \fBspm\fP command, whether that machine is a master or
a minion.
.sp
\fBlocal\fP states do not require any special arguments, but they must still use
the \fB>\fP marker to denote that the state is evaluated as text, not a data
structure.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pre_local_state: >
  echo test > /tmp/spmtest:
    cmd:
      \- run
.ft P
.fi
.UNINDENT
.UNINDENT
.SS tgt States
.sp
\fBtgt\fP states are issued against a remote target. This is analogous to issuing
a state using the \fBsalt\fP command. As such it requires that the machine that
the \fBspm\fP command is running on is a master.
.sp
Because \fBtgt\fP states require that a target be specified, their code blocks
are a little different. Consider the following state:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pre_tgt_state:
  tgt: \(aq*\(aq
  data: >
    echo test > /tmp/spmtest:
      cmd:
        \- run
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With \fBtgt\fP states, the state data is placed under a \fBdata\fP section, inside
the \fB*_tgt_state\fP code block. The target is of course specified as a \fBtgt\fP
and you may also optionally specify a \fBtgt_type\fP (the default is \fBglob\fP).
.sp
You still need to use the \fB>\fP marker, but this time it follows the \fBdata\fP
line, rather than the \fB*_tgt_state\fP line.
.SS Templating States
.sp
The reason that state data must be evaluated as text rather than a data
structure is because that state data is first processed through the rendering
engine, as it would be with a standard state run.
.sp
This means that you can use Jinja or any other supported renderer inside of
Salt. All formula variables are available to the renderer, so you can reference
\fBFORMULA\fP data inside your state if you need to:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pre_tgt_state:
  tgt: \(aq*\(aq
  data: >
     echo {{ name }} > /tmp/spmtest:
      cmd:
        \- run
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You may also declare your own variables inside the \fBFORMULA\fP\&. If SPM doesn\(aqt
recognize them then it will ignore them, so there are no restrictions on
variable names, outside of avoiding reserved words.
.sp
By default the renderer is set to \fBjinja|yaml\fP\&. You may change this by
changing the \fBrenderer\fP setting in the \fBFORMULA\fP itself.
.SS Building a Package
.sp
Once a \fBFORMULA\fP file has been created, it is placed into the root of the
formula that is to be turned into a package. The \fBspm build\fP command is
used to turn that formula into a package:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
spm build /path/to/saltstack\-formulas/apache\-formula
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The resulting file will be placed in the build directory. By default this
directory is located at \fB/srv/spm/\fP\&.
.SS Loader Modules
.sp
When an execution module is placed in \fB<file_roots>/_modules/\fP on the master,
it will automatically be synced to minions, the next time a sync operation takes
place. Other modules are also propagated this way: state modules can be placed
in \fB_states/\fP, and so on.
.sp
When SPM detects a file in a package which resides in one of these directories,
that directory will be placed in \fB<file_roots>\fP instead of in the formula
directory with the rest of the files.
.SS Removing Packages
.sp
Packages may be removed once they are installed using the \fBspm remove\fP
command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
spm remove apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If files have been modified, they will not be removed. Empty directories will
also be removed.
.SS Technical Information
.sp
Packages are built using BZ2\-compressed tarballs. By default, the package
database is stored using the \fBsqlite3\fP driver (see Loader Modules below).
.sp
Support for these are built into Python, and so no external dependencies are
needed.
.sp
All other files belonging to SPM use YAML, for portability and ease of use and
maintainability.
.SS SPM\-Specific Loader Modules
.sp
SPM was designed to behave like traditional package managers, which apply files
to the filesystem and store package metadata in a local database. However,
because modern infrastructures often extend beyond those use cases, certain
parts of SPM have been broken out into their own set of modules.
.SS Package Database
.sp
By default, the package database is stored using the \fBsqlite3\fP module. This
module was chosen because support for SQLite3 is built into Python itself.
.sp
Please see the SPM Development Guide for information on creating new modules
for package database management.
.SS Package Files
.sp
By default, package files are installed using the \fBlocal\fP module. This module
applies files to the local filesystem, on the machine that the package is
installed on.
.sp
Please see the \fI\%SPM Development Guide\fP for information
on creating new modules for package file management.
.SS Types of Packages
.sp
SPM supports different types of formula packages. The function of each package
is denoted by its name. For instance, packages which end in \fB\-formula\fP are
considered to be Salt States (the most common type of formula). Packages which
end in \fB\-conf\fP contain configuration which is to be placed in the
\fB/etc/salt/\fP directory. Packages which do not contain one of these names are
treated as if they have a \fB\-formula\fP name.
.SS formula
.sp
By default, most files from this type of package live in the \fB/srv/spm/salt/\fP
directory. The exception is the \fBpillar.example\fP file, which will be renamed
to \fB<package_name>.sls\fP and placed in the pillar directory (\fB/srv/spm/pillar/\fP
by default).
.SS reactor
.sp
By default, files from this type of package live in the \fB/srv/spm/reactor/\fP
directory.
.SS conf
.sp
The files in this type of package are configuration files for Salt, which
normally live in the \fB/etc/salt/\fP directory. Configuration files for packages
other than Salt can and should be handled with a Salt State (using a \fBformula\fP
type of package).
.SS SPM Development Guide
.sp
This document discusses developing additional code for SPM.
.SS SPM\-Specific Loader Modules
.sp
SPM was designed to behave like traditional package managers, which apply files
to the filesystem and store package metadata in a local database. However,
because modern infrastructures often extend beyond those use cases, certain
parts of SPM have been broken out into their own set of modules.
.sp
Each function that accepts arguments has a set of required and optional
arguments. Take note that SPM will pass all arguments in, and therefore each
function must accept each of those arguments. However, arguments that are
marked as required are crucial to SPM\(aqs core functionality, while arguments that
are marked as optional are provided as a benefit to the module, if it needs to
use them.
.SS Package Database
.sp
By default, the package database is stored using the \fBsqlite3\fP module. This
module was chosen because support for SQLite3 is built into Python itself.
.sp
Modules for managing the package database are stored in the \fBsalt/spm/pkgdb/\fP
directory. A number of functions must exist to support database management.
.SS init()
.sp
Get a database connection, and initialize the package database if necessary.
.sp
This function accepts no arguments. If a database is used which supports a
connection object, then that connection object is returned. For instance, the
\fBsqlite3\fP module returns a \fBconnect()\fP object from the \fBsqlite3\fP library:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def myfunc():
    conn = sqlite3.connect(__opts__[\(dqspm_db\(dq], isolation_level=None)
    ...
    return conn
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
SPM itself will not use this connection object; it will be passed in as\-is to
the other functions in the module. Therefore, when you set up this object, make
sure to do so in a way that is easily usable throughout the module.
.SS info()
.sp
Return information for a package. This generally consists of the information
that is stored in the \fBFORMULA\fP file in the package.
.sp
The arguments that are passed in, in order, are \fBpackage\fP (required) and
\fBconn\fP (optional).
.sp
\fBpackage\fP is the name of the package, as specified in the \fBFORMULA\fP\&.
\fBconn\fP is the connection object returned from \fBinit()\fP\&.
.SS list_files()
.sp
Return a list of files for an installed package. Only the filename should be
returned, and no other information.
.sp
The arguments that are passed in, in order, are \fBpackage\fP (required) and
\fBconn\fP (optional).
.sp
\fBpackage\fP is the name of the package, as specified in the \fBFORMULA\fP\&.
\fBconn\fP is the connection object returned from \fBinit()\fP\&.
.SS register_pkg()
.sp
Register a package in the package database. Nothing is expected to be returned
from this function.
.sp
The arguments that are passed in, in order, are \fBname\fP (required),
\fBformula_def\fP (required), and \fBconn\fP (optional).
.sp
\fBname\fP is the name of the package, as specified in the \fBFORMULA\fP\&.
\fBformula_def\fP is the contents of the \fBFORMULA\fP file, as a \fBdict\fP\&. \fBconn\fP
is the connection object returned from \fBinit()\fP\&.
.SS register_file()
.sp
Register a file in the package database. Nothing is expected to be returned
from this function.
.sp
The arguments that are passed in are \fBname\fP (required), \fBmember\fP (required),
\fBpath\fP (required), \fBdigest\fP (optional), and \fBconn\fP (optional).
.sp
\fBname\fP is the name of the package.
.sp
\fBmember\fP is a \fBtarfile\fP object for the
package file. It is included, because it contains most of the information for
the file.
.sp
\fBpath\fP is the location of the file on the local filesystem.
.sp
\fBdigest\fP is the SHA1 checksum of the file.
.sp
\fBconn\fP is the connection object returned from \fBinit()\fP\&.
.SS unregister_pkg()
.sp
Unregister a package from the package database. This usually only involves
removing the package\(aqs record from the database. Nothing is expected to be
returned from this function.
.sp
The arguments that are passed in, in order, are \fBname\fP (required) and
\fBconn\fP (optional).
.sp
\fBname\fP is the name of the package, as specified in the \fBFORMULA\fP\&. \fBconn\fP
is the connection object returned from \fBinit()\fP\&.
.SS unregister_file()
.sp
Unregister a package from the package database. This usually only involves
removing the package\(aqs record from the database. Nothing is expected to be
returned from this function.
.sp
The arguments that are passed in, in order, are \fBname\fP (required), \fBpkg\fP
(optional) and \fBconn\fP (optional).
.sp
\fBname\fP is the path of the file, as it was installed on the filesystem.
.sp
\fBpkg\fP is the name of the package that the file belongs to.
.sp
\fBconn\fP is the connection object returned from \fBinit()\fP\&.
.SS db_exists()
.sp
Check to see whether the package database already exists. This is the path to
the package database file. This function will return \fBTrue\fP or \fBFalse\fP\&.
.sp
The only argument that is expected is \fBdb_\fP, which is the package database
file.
.SS Package Files
.sp
By default, package files are installed using the \fBlocal\fP module. This module
applies files to the local filesystem, on the machine that the package is
installed on.
.sp
Modules for managing the package database are stored in the
\fBsalt/spm/pkgfiles/\fP directory. A number of functions must exist to support
file management.
.SS init()
.sp
Initialize the installation location for the package files. Normally these will
be directory paths, but other external destinations such as databases can be
used. For this reason, this function will return a connection object, which can
be a database object. However, in the default \fBlocal\fP module, this object is a
dict containing the paths. This object will be passed into all other functions.
.sp
Three directories are used for the destinations: \fBformula_path\fP,
\fBpillar_path\fP, and \fBreactor_path\fP\&.
.sp
\fBformula_path\fP is the location of most of the files that will be installed.
The default is specific to the operating system, but is normally \fB/srv/salt/\fP\&.
.sp
\fBpillar_path\fP is the location that the \fBpillar.example\fP file will be
installed to.  The default is specific to the operating system, but is normally
\fB/srv/pillar/\fP\&.
.sp
\fBreactor_path\fP is the location that reactor files will be installed to. The
default is specific to the operating system, but is normally \fB/srv/reactor/\fP\&.
.SS check_existing()
.sp
Check the filesystem for existing files. All files for the package will be
checked, and if any are existing, then this function will normally state that
SPM will refuse to install the package.
.sp
This function returns a list of the files that exist on the system.
.sp
The arguments that are passed into this function are, in order: \fBpackage\fP
(required), \fBpkg_files\fP (required), \fBformula_def\fP (formula_def), and
\fBconn\fP (optional).
.sp
\fBpackage\fP is the name of the package that is to be installed.
.sp
\fBpkg_files\fP is a list of the files to be checked.
.sp
\fBformula_def\fP is a copy of the information that is stored in the \fBFORMULA\fP
file.
.sp
\fBconn\fP is the file connection object.
.SS install_file()
.sp
Install a single file to the destination (normally on the filesystem). Nothing
is expected to be returned from this function.
.sp
This function returns the final location that the file was installed to.
.sp
The arguments that are passed into this function are, in order, \fBpackage\fP
(required), \fBformula_tar\fP (required), \fBmember\fP (required), \fBformula_def\fP
(required), and \fBconn\fP (optional).
.sp
\fBpackage\fP is the name of the package that is to be installed.
.sp
\fBformula_tar\fP is the tarfile object for the package. This is passed in so that
the function can call \fBformula_tar.extract()\fP for the file.
.sp
\fBmember\fP is the tarfile object which represents the individual file. This may
be modified as necessary, before being passed into \fBformula_tar.extract()\fP\&.
.sp
\fBformula_def\fP is a copy of the information from the \fBFORMULA\fP file.
.sp
\fBconn\fP is the file connection object.
.SS remove_file()
.sp
Remove a single file from file system. Normally this will be little more than an
\fBos.remove()\fP\&. Nothing is expected to be returned from this function.
.sp
The arguments that are passed into this function are, in order, \fBpath\fP
(required) and \fBconn\fP (optional).
.sp
\fBpath\fP is the absolute path to the file to be removed.
.sp
\fBconn\fP is the file connection object.
.SS hash_file()
.sp
Returns the hexdigest hash value of a file.
.sp
The arguments that are passed into this function are, in order, \fBpath\fP
(required), \fBhashobj\fP (required), and \fBconn\fP (optional).
.sp
\fBpath\fP is the absolute path to the file.
.sp
\fBhashobj\fP is a reference to \fBhashlib.sha1()\fP, which is used to pull the
\fBhexdigest()\fP for the file.
.sp
\fBconn\fP is the file connection object.
.sp
This function will not generally be more complex than:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def hash_file(path, hashobj, conn=None):
    with salt.utils.files.fopen(path, \(dqr\(dq) as f:
        hashobj.update(f.read())
        return hashobj.hexdigest()
.ft P
.fi
.UNINDENT
.UNINDENT
.SS path_exists()
.sp
Check to see whether the file already exists on the filesystem. Returns \fBTrue\fP
or \fBFalse\fP\&.
.sp
This function expects a \fBpath\fP argument, which is the absolute path to the
file to be checked.
.SS path_isdir()
.sp
Check to see whether the path specified is a directory. Returns \fBTrue\fP or
\fBFalse\fP\&.
.sp
This function expects a \fBpath\fP argument, which is the absolute path to be
checked.
.SS Storing Data in Other Databases
.sp
The SDB interface is designed to store and retrieve data that, unlike pillars
and grains, is not necessarily minion\-specific. The initial design goal was to
allow passwords to be stored in a secure database, such as one managed by the
keyring package, rather than as plain\-text files. However, as a generic database
interface, it could conceptually be used for a number of other purposes.
.sp
SDB was added to Salt in version 2014.7.0.
.SS SDB Configuration
.sp
In order to use the SDB interface, a configuration profile must be set up.
To be available for master commands, such as runners, it needs to be
configured in the master configuration. For modules executed on a minion, it
can be set either in the minion configuration file, or as a pillar. The
configuration stanza includes the name/ID that the profile will be referred to
as, a \fBdriver\fP setting, and any other arguments that are necessary for the SDB
module that will be used. For instance, a profile called \fBmykeyring\fP, which
uses the \fBsystem\fP service in the \fBkeyring\fP module would look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mykeyring:
  driver: keyring
  service: system
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is recommended to keep the name of the profile simple, as it is used in the
SDB URI as well.
.SS SDB URIs
.sp
SDB is designed to make small database queries (hence the name, SDB) using a
compact URL. This allows users to reference a database value quickly inside
a number of Salt configuration areas, without a lot of overhead. The basic
format of an SDB URI is:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sdb://<profile>/<args>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The profile refers to the configuration profile defined in either the master or
the minion configuration file. The args are specific to the module referred to
in the profile, but will typically only need to refer to the key of a
key/value pair inside the database. This is because the profile itself should
define as many other parameters as possible.
.sp
For example, a profile might be set up to reference credentials for a specific
OpenStack account. The profile might look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
kevinopenstack:
  driver: keyring
  service: salt.cloud.openstack.kevin
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And the URI used to reference the password might look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sdb://kevinopenstack/password
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Getting, Setting and Deleting SDB Values
.sp
Once an SDB driver is configured, you can use the \fBsdb\fP execution module to
get, set and delete values from it. There are two functions that may appear in
most SDB modules: \fBget\fP, \fBset\fP and \fBdelete\fP\&.
.sp
Getting a value requires only the SDB URI to be specified. To retrieve a value
from the \fBkevinopenstack\fP profile above, you would use:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call sdb.get sdb://kevinopenstack/password
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For SDB sub\-keys, ie users[\(aquser1\(aq][\(aqid\(aq]
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  user1:
    id: 12345
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To get SDB sub\-keys from the CLI, use a colon to separate sub key values. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call sdb.get sdb://users:user1:id
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To get SDB sub\-keys in a state file, use this syntax:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  user1:
    id: sdb.get sdb://users:user1:id
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
The \fBvault\fP driver previously only supported splitting the path and key with
a question mark. This has since been deprecated in favor of using the standard
/ to split the path and key. The use of the questions mark will still be supported
to ensure backwards compatibility, but please use the preferred method using /.
The deprecated approach required the full path to where the key is stored,
followed by a question mark, followed by the key to be retrieved.  If you were
using a profile called \fBmyvault\fP, you would use a URI that looks like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call sdb.get \(aqsdb://myvault/secret/salt?saltstack\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Instead of the above please use the preferred URI using / instead:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call sdb.get \(aqsdb://myvault/secret/salt/saltstack\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Setting a value uses the same URI as would be used to retrieve it, followed
by the value as another argument.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call sdb.set \(aqsdb://myvault/secret/salt/saltstack\(aq \(aqsuper awesome\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Deleting values (if supported by the driver) is done pretty much the same way as
getting them. Provided that you have a profile called \fBmykvstore\fP that uses
a driver allowing to delete values you would delete a value as shown below:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call sdb.delete \(aqsdb://mykvstore/foobar\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBsdb.get\fP, \fBsdb.set\fP and \fBsdb.delete\fP functions are also available in
the runner system:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run sdb.get \(aqsdb://myvault/secret/salt/saltstack\(aq
salt\-run sdb.set \(aqsdb://myvault/secret/salt/saltstack\(aq \(aqsuper awesome\(aq
salt\-run sdb.delete \(aqsdb://mykvstore/foobar\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Using SDB URIs in Files
.sp
SDB URIs can be used in both configuration files, and files that are processed
by the renderer system (jinja, mako, etc.). In a configuration file (such as
\fB/etc/salt/master\fP, \fB/etc/salt/minion\fP, \fB/etc/salt/cloud\fP, etc.), make an
entry as usual, and set the value to the SDB URI. For instance:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mykey: sdb://myetcd/mykey
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To retrieve this value using a module, the module in question must use the
\fBconfig.get\fP function to retrieve configuration values. This would look
something like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mykey = __salt__[\(dqconfig.get\(dq](\(dqmykey\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Templating renderers use a similar construct. To get the \fBmykey\fP value from
above in Jinja, you would use:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt[\(aqconfig.get\(aq](\(aqmykey\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When retrieving data from configuration files using \fBconfig.get\fP, the SDB
URI need only appear in the configuration file itself.
.sp
If you would like to retrieve a key directly from SDB, you would call the
\fBsdb.get\fP function directly, using the SDB URI. For instance, in Jinja:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt[\(aqsdb.get\(aq](\(aqsdb://myetcd/mykey\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When writing Salt modules, it is not recommended to call \fBsdb.get\fP directly,
as it requires the user to provide values in SDB, using a specific URI. Use
\fBconfig.get\fP instead.
.SS Writing SDB Modules
.sp
There is currently one function that MUST exist in any SDB module (\fBget()\fP),
one that SHOULD exist (\fBset_()\fP) and one that MAY exist (\fBdelete()\fP). If
using a (\fBset_()\fP) function, a \fB__func_alias__\fP dictionary MUST be declared
in the module as well:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__func_alias__ = {
    \(dqset_\(dq: \(dqset\(dq,
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is because \fBset\fP is a Python built\-in, and therefore functions should not
be created which are called \fBset()\fP\&. The \fB__func_alias__\fP functionality is
provided via Salt\(aqs loader interfaces, and allows legally\-named functions to be
referred to using names that would otherwise be unwise to use.
.sp
The \fBget()\fP function is required, as it will be called via functions in other
areas of the code which make use of the \fBsdb://\fP URI. For example, the
\fBconfig.get\fP function in the \fBconfig\fP execution module uses this function.
.sp
The \fBset_()\fP function may be provided, but is not required, as some sources
may be read\-only, or may be otherwise unwise to access via a URI (for instance,
because of SQL injection attacks).
.sp
The \fBdelete()\fP function may be provided as well, but is not required, as many
sources may be read\-only or restrict such operations.
.sp
A simple example of an SDB module is \fBsalt/sdb/keyring_db.py\fP, as it provides
basic examples of most, if not all, of the types of functionality that are
available not only for SDB modules, but for Salt modules in general.
.SS Running the Salt Master/Minion as an Unprivileged User
.sp
While the default setup runs the master and minion as the root user, some
may consider it an extra measure of security to run the master as a non\-root
user. Keep in mind that doing so does not change the master\(aqs capability
to access minions as the user they are running as. Due to this many feel that
running the master as a non\-root user does not grant any real security advantage
which is why the master has remained as root by default.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Some of Salt\(aqs operations cannot execute correctly when the master is not
running as root, specifically the pam external auth system, as this system
needs root access to check authentication.
.UNINDENT
.UNINDENT
.sp
As of Salt 0.9.10 it is possible to run Salt as a non\-root user. This can be
done by setting the \fI\%user\fP parameter in the master configuration
file. and restarting the \fBsalt\-master\fP service.
.sp
The minion has its own \fI\%user\fP parameter as well, but running the
minion as an unprivileged user will keep it from making changes to things like
users, installed packages, etc. unless access controls (sudo, etc.) are setup
on the minion to permit the non\-root user to make the needed changes.
.sp
In order to allow Salt to successfully run as a non\-root user, ownership, and
permissions need to be set such that the desired user can read from and write
to the following directories (and their subdirectories, where applicable):
.INDENT 0.0
.IP \(bu 2
/etc/salt
.IP \(bu 2
/var/cache/salt
.IP \(bu 2
/var/log/salt
.IP \(bu 2
/var/run/salt
.UNINDENT
.sp
Ownership can be easily changed with \fBchown\fP, like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# chown \-R user /etc/salt /var/cache/salt /var/log/salt /var/run/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Running either the master or minion with the \fI\%root_dir\fP
parameter specified will affect these paths, as will setting options like
\fI\%pki_dir\fP, \fI\%cachedir\fP, \fI\%log_file\fP,
and other options that normally live in the above directories.
.UNINDENT
.UNINDENT
.SS Using cron with Salt
.sp
The Salt Minion can initiate its own \fI\%highstate\fP using
the \fBsalt\-call\fP command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-call state.apply
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will cause the minion to check in with the master and ensure it is in the
correct \(dqstate\(dq.
.SS Use cron to initiate a highstate
.sp
If you would like the Salt Minion to regularly check in with the master you can
use cron to run the \fBsalt\-call\fP command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
0 0 * * * salt\-call state.apply
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above cron entry will run a \fI\%highstate\fP every day
at midnight.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When executing Salt using cron, keep in mind that the default PATH for cron
may not include the path for any scripts or commands used by Salt, and it
may be necessary to set the PATH accordingly in the crontab:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin

0 0 * * * salt\-call state.apply
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Hardening Salt
.sp
This topic contains tips you can use to secure and harden your Salt
environment. How you best secure and harden your Salt environment depends
heavily on how you use Salt, where you use Salt, how your team is structured,
where you get data from, and what kinds of access (internal and external) you
require.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
The guidance here should be taken in combination with \fI\%Salt Best Practices\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
Refer to the \fI\%Receiving security announcements\fP documentation in order to stay updated
and secure.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
For historical reasons, Salt requires PyCrypto as a \(dqlowest common
denominator\(dq. However, \fI\%PyCrypto is unmaintained\fP and best practice is to
manually upgrade to use a more maintained library such as \fI\%PyCryptodome\fP\&. See
\fI\%Issue #52674\fP and \fI\%Issue #54115\fP for more info
.UNINDENT
.UNINDENT
.SS General hardening tips
.INDENT 0.0
.IP \(bu 2
Restrict who can directly log into your Salt master system.
.IP \(bu 2
Use SSH keys secured with a passphrase to gain access to the Salt master system.
.IP \(bu 2
Track and secure SSH keys and any other login credentials you and your team
need to gain access to the Salt master system.
.IP \(bu 2
Use a hardened bastion server or a VPN to restrict direct access to the Salt
master from the internet.
.IP \(bu 2
Don\(aqt expose the Salt master any more than what is required.
.IP \(bu 2
Harden the system as you would with any high\-priority target.
.IP \(bu 2
Keep the system patched and up\-to\-date.
.IP \(bu 2
Use tight firewall rules. Pay particular attention to TCP/4505 and TCP/4506
on the salt master and avoid exposing these ports unnecessarily.
.UNINDENT
.SS Salt hardening tips
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Grains can be set by users that have access to the minion configuration files on
the local system, making them less secure than other identifiers in Salt. Avoid
storing sensitive data, such as passwords or keys, on minions. Instead, make
use of \fI\%Storing Static Data in the Pillar\fP and/or \fI\%Storing Data in Other Databases\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Jinja\fP supports a \fI\%secure, sandboxed template execution environment\fP that Salt
takes advantage of. Other text \fI\%Renderers\fP do not support this
functionality, so Salt highly recommends usage of \fBjinja\fP / \fBjinja|yaml\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
Subscribe to \fI\%salt\-users\fP or \fI\%salt\-announce\fP so you know when new Salt
releases are available.
.IP \(bu 2
Keep your systems up\-to\-date with the latest patches.
.IP \(bu 2
Use Salt\(aqs Client \fI\%ACL system\fP to avoid having to give out root
access in order to run Salt commands.
.IP \(bu 2
Use Salt\(aqs Client \fI\%ACL system\fP to restrict which users can run what commands.
.IP \(bu 2
Use \fI\%external Pillar\fP to pull data into Salt from
external sources so that non\-sysadmins (other teams, junior admins,
developers, etc) can provide configuration data without needing access to the
Salt master.
.IP \(bu 2
Make heavy use of SLS files that are version\-controlled and go through
a peer\-review/code\-review process before they\(aqre deployed and run in
production. This is good advice even for \(dqone\-off\(dq CLI commands because it
helps mitigate typos and mistakes.
.IP \(bu 2
Use salt\-api, SSL, and restrict authentication with the \fI\%external auth\fP system if you need to expose your Salt master to external
services.
.IP \(bu 2
Make use of Salt\(aqs event system and \fI\%reactor\fP to allow minions
to signal the Salt master without requiring direct access.
.IP \(bu 2
Run the \fBsalt\-master\fP daemon as non\-root.
.IP \(bu 2
Disable which modules are loaded onto minions with the
\fI\%disable_modules\fP setting. (for example, disable the \fBcmd\fP
module if it makes sense in your environment.)
.IP \(bu 2
Look through the fully\-commented sample \fI\%master\fP and \fI\%minion\fP config files. There are many options for
securing an installation.
.IP \(bu 2
Run \fI\%masterless\-mode\fP minions on
particularly sensitive minions. There is also \fI\%Salt SSH\fP or the
\fBmodules.sudo\fP if you need to further restrict
a minion.
.IP \(bu 2
Monitor specific security related log messages. Salt \fBsalt\-master\fP logs
attempts to access methods which are not exposed to network clients. These log
messages are logged at the \fBerror\fP log level and start with \fBRequested
method not exposed\fP\&.
.UNINDENT
.SS Rotating keys
.sp
There are several reasons to rotate keys. One example is exposure or a
compromised key. An easy way to rotate a key is to remove the existing keys and
let the \fBsalt\-master\fP or \fBsalt\-minion\fP process generate new keys on
restart.
.SS Rotate a minion key
.sp
Run the following on the Salt minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call saltutil.regen_keys
systemctl stop salt\-minion
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Run the following on the Salt master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-d <minion\-id>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Run the following on the Salt minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
systemctl start salt\-minion
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Run the following on the Salt master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-a <minion\-id>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Rotate a master key
.sp
Run the following on the Salt master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
systemctl stop salt\-master
rm <pki_dir>/master.{pem,pub}
systemctl start salt\-master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Run the following on the Salt minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
systemctl stop salt\-minion
rm <pki_dir>/minion_master.pub
systemctl start salt\-minion
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Hardening of syndic setups
.sp
Syndics must be run as the same user as their syndic master process. The master
of master\(aqs will include publisher ACL information in jobs sent to downstream
masters via syndics. This means that any minions connected directly to a master
of masters will also receive ACL information in jobs being published. For the
most secure setup, only connect syndics directly to master of masters.
.SS Security disclosure policy
.INDENT 0.0
.TP
.B email
\fI\%saltproject\-security.pdl@broadcom.com\fP
.TP
.B gpg key ID
4EA0793D
.TP
.B gpg key fingerprint
\fB8ABE 4EFC F0F4 B24B FF2A  AF90 D570 F2D3 4EA0 793D\fP
.UNINDENT
.sp
\fBgpg public key:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-\-\-\-BEGIN PGP PUBLIC KEY BLOCK\-\-\-\-\-

mQINBFO15mMBEADa3CfQwk5ED9wAQ8fFDku277CegG3U1hVGdcxqKNvucblwoKCb
hRK6u9ihgaO9V9duV2glwgjytiBI/z6lyWqdaD37YXG/gTL+9Md+qdSDeaOa/9eg
7y+g4P+FvU9HWUlujRVlofUn5Dj/IZgUywbxwEybutuzvvFVTzsn+DFVwTH34Qoh
QIuNzQCSEz3Lhh8zq9LqkNy91ZZQO1ZIUrypafspH6GBHHcE8msBFgYiNBnVcUFH
u0r4j1Rav+621EtD5GZsOt05+NJI8pkaC/dDKjURcuiV6bhmeSpNzLaXUhwx6f29
Vhag5JhVGGNQxlRTxNEM86HEFp+4zJQ8m/wRDrGX5IAHsdESdhP+ljDVlAAX/ttP
/Ucl2fgpTnDKVHOA00E515Q87ZHv6awJ3GL1veqi8zfsLaag7rw1TuuHyGLOPkDt
t5PAjsS9R3KI7pGnhqI6bTOi591odUdgzUhZChWUUX1VStiIDi2jCvyoOOLMOGS5
AEYXuWYP7KgujZCDRaTNqRDdgPd93Mh9JI8UmkzXDUgijdzVpzPjYgFaWtyK8lsc
Fizqe3/Yzf9RCVX/lmRbiEH+ql/zSxcWlBQd17PKaL+TisQFXcmQzccYgAxFbj2r
QHp5ABEu9YjFme2Jzun7Mv9V4qo3JF5dmnUk31yupZeAOGZkirIsaWC3hwARAQAB
tDBTYWx0U3RhY2sgU2VjdXJpdHkgVGVhbSA8c2VjdXJpdHlAc2FsdHN0YWNrLmNv
bT6JAj4EEwECACgFAlO15mMCGwMFCQeGH4AGCwkIBwMCBhUIAgkKCwQWAgMBAh4B
AheAAAoJENVw8tNOoHk9z/MP/2vzY27fmVxU5X8joiiturjlgEqQw41IYEmWv1Bw
4WVXYCHP1yu/1MC1uuvOmOd5BlI8YO2C2oyW7d1B0NorguPtz55b7jabCElekVCh
h/H4ZVThiwqgPpthRv/2npXjIm7SLSs/kuaXo6Qy2JpszwDVFw+xCRVL0tH9KJxz
HuNBeVq7abWD5fzIWkmGM9hicG/R2D0RIlco1Q0VNKy8klG+pOFOW886KnwkSPc7
JUYp1oUlHsSlhTmkLEG54cyVzrTP/XuZuyMTdtyTc3mfgW0adneAL6MARtC5UB/h
q+v9dqMf4iD3wY6ctu8KWE8Vo5MUEsNNO9EA2dUR88LwFZ3ZnnXdQkizgR/Aa515
dm17vlNkSoomYCo84eN7GOTfxWcq+iXYSWcKWT4X+h/ra+LmNndQWQBRebVUtbKE
ZDwKmiQz/5LY5EhlWcuU4lVmMSFpWXt5FR/PtzgTdZAo9QKkBjcv97LYbXvsPI69
El1BLAg+m+1UpE1L7zJT1il6PqVyEFAWBxW46wXCCkGssFsvz2yRp0PDX8A6u4yq
rTkt09uYht1is61joLDJ/kq3+6k8gJWkDOW+2NMrmf+/qcdYCMYXmrtOpg/wF27W
GMNAkbdyzgeX/MbUBCGCMdzhevRuivOI5bu4vT5s3KdshG+yhzV45bapKRd5VN+1
mZRqiQJVBBMBAgA/AhsDBgsJCAcDAgYVCAIJCgsEFgIDAQIeAQIXgBYhBIq+Tvzw
9LJL/yqvkNVw8tNOoHk9BQJb0e5rBQkL3m8IAAoJENVw8tNOoHk9fzMP/ApQtkQD
BmoYEBTF6BH1bywzDw5OHpnBSLbuoYtA3gkhnm/83MzFDcGn22pgo2Fv0MuHltWI
G2oExzje7szmcM6Xg3ZTKapJ3/p2J+P33tkJA1LWpg+DdgdQlqrjlXKwEnikszuB
9IMhbjoPeBzwiUtsBQmcwbVgwMzbscwoV5DJ/gLDCkgF4rp2uKEYAcBi8s9NGX6p
zQsb9Sb0/bKdCrszAcvUn4WYB6WbAPttvutYHtg/nZfXEeX/SgBueXo3lO9vzFlO
r3Zgk7WeucsEqa9Qo0VLOq28HykixM5mEJKsAQrNIqM1DqXgfDch8RJAHzgMBHFH
Qi9hJXk1/6OA2FPXQGcA9Td5Dt0i1Z7wMrAUMj3s9gNMVCD0hQqEKfUtpyV7KBAj
AO5j8Wr8KafnRm6czBCkcV0SRzHQSHdYyncozWwPgWOaRC9AY9fEDz8lBaSoB/C+
dyO/xZMTWoaWqkHozVoHIrCc4CAtZTye/5mxFhq15Q1Iy/NjelrMTCD1kql1dNIP
oOgfOYl1xLMQIBwrrCrgeRIvxEgKRf9KOLbSrS7+3vOKoxf+LD4AQfLci8dFyH+I
t0Z43nk93yTOI82RTdz5GwUXIKcvGhsJ8bgNlGTxM1R/Sl8Sg8diE2PRAp/fk7+g
CwOM8VkeyrDM2k1cy64d8USkbR7YtT3otyFQiQJVBBMBCAA/AhsDBgsJCAcDAgYV
CAIJCgsEFgIDAQIeAQIXgBYhBIq+Tvzw9LJL/yqvkNVw8tNOoHk9BQJeapbNBQkN
v4KKAAoJENVw8tNOoHk9BFQP/04a1yQb3aOYbNgx+ER9l54wZbUUlReU+ujmlW03
12ZW8fFZ0SN2q7xKtE/I9nNl1gjJ7NHTP3FhZ0eNyG+mJeGyrscVKxaAkTV+71e3
7n94/qC2bM753X+2160eR7Md+R/itoljStwmib1583rSTTUld1i4FnUTrEhF7MBt
I/+5l7vUK4Hj1RPovHVeHXYfdbrS6wCBi6GsdOfYGfGacZIfM4XLXTkyjVt4Zg0j
rwZ36P1amHky1QyvQ2stkXjCEtP04h3o3EfC1yupNXarO1VXj10/wWYhoGAz6AT2
Usk6DiaiJqHPy2RwPfKzv7ZrUlMxKrqjPUHcoBf++EjzFtR3LJ0pY2fLwp6Pk4s4
18Xwi7r16HnCH/BZgqZVyXAhDV6+U9rAHab/n4b0hcWWaT2SIhsyZKtEMiTMJeq5
aAMcRSWX+dHO+MzMIBzNu7BO3b+zODD0+XSMsPqeHp3cqfZ3EHobKQPPFucdfjug
Hx2+dbPD3IwJVIilc9Otfz/+JYG4im5p4N6UCwXHbtiuuREC1SQpU9BqEjQAyIiL
gXlE5MSVqXijkrIpYB+K8cR+44nQ4K2kc4ievNqXR6D7XQ3AE76QN84Lby2b5W86
bbboIy0Bgy+9jgCx0CS7fk1P8zx1dw2FNDVfxZ+s473ZvwP1wdSRZICjZUvM8hx4
4kPCiQJVBBMBCAA/AhsDBgsJCAcDAgYVCAIJCgsEFgIDAQIeAQIXgBYhBIq+Tvzw
9LJL/yqvkNVw8tNOoHk9BQJiOkMeBQkUJ/c7AAoJENVw8tNOoHk9Xx8P/26W8v/v
Exmttzcqh7MlihddXfr2lughSuUBQ8aLsffGHSGIgyqSPlq0Fl5qOCoJ8hYZSBqV
yEfo7iRY7E3K1LGXKDkpup9hC1wMjR0A25eoXwEnD2vEQ/upXXueH05vkcMc165B
cK0kNxas+2amCc3nHJOlfWILXQk4OS+nB0lBWe8H96ppfAaX/G0JiYsa0hjNycZq
0ftEdCkAJRvSFuu6d3gXH69KLxoNcJOE+99f3wMOuOcX3Xf1k/cwqdJRdEiW8oz8
Gf5ZRzWcpsXXg6nB2mkahLoRDMM2U+1C6fHbUg4yTvU1AB+F/OYqe1d0hedho0o5
+WWoTuM/U79+m3NM14qvr0iJP7ytABiEE96nNAz+Q0NDZqA6JoUd7obo8KVjGHEt
9bRl/8K/zWkdNLoF84tWjEiBCzCKXGEay7lgiIx5f3OvP91CfGL+ILHrk/AZR1eE
M+KI7wB8sJEFF95UoKVua3YzLIFScB4bUEOg6bz8xSSP4a0BWktSm5ws8iCWqOE6
S9haCppZ7a6k5czQNPJV2bp2eTS4ykFAQLv/mHMS5awIvb8b630Rufn1vZHKCrMf
WdSbBZD7oojxYo1psPlfzN2KUrNXgl7vAUNagJEogMoiYAZ2ML7rTVAC1qnbxQb+
DeC+r0I98AIY6igIgRbcybH3ccfXYNtcxLUJuQINBFO15mMBEAC5UuLii9ZLz6qH
fIJp35IOW9U8SOf7QFhzXR7NZ3DmJsd3f6Nb/habQFIHjm3K9wbpj+FvaW2oWRlF
VvYdzjUq6c82GUUjW1dnqgUvFwdmM8351n0YQ2TonmyaF882RvsRZrbJ65uvy7SQ
xlouXaAYOdqwLsPxBEOyOnMPSktW5V2UIWyxsNP3sADchWIGq9p5D3Y/loyIMsS1
dj+TjoQZOKSj7CuRT98+8yhGAY8YBEXu9r3I9o6mDkuPpAljuMc8r09Im6az2egt
K/szKt4Hy1bpSSBZU4W/XR7XwQNywmb3wxjmYT6Od3Mwj0jtzc3gQiH8hcEy3+BO
+NNmyzFVyIwOLziwjmEcw62S57wYKUVnHD2nglMsQa8Ve0e6ABBMEY7zGEGStva5
9rfgeh0jUMJiccGiUDTMs0tdkC6knYKbu/fdRqNYFoNuDcSeLEw4DdCuP01l2W4y
Y+fiK6hAcL25amjzc+yYo9eaaqTn6RATbzdhHQZdpAMxY+vNT0+NhP1Zo5gYBMR6
5Zp/VhFsf67ijb03FUtdw9N8dHwiR2m8vVA8kO/gCD6wS2p9RdXqrJ9JhnHYWjiV
uXR+f755ZAndyQfRtowMdQIoiXuJEXYw6XN+/BX81gJaynJYc0uw0MnxWQX+A5m8
HqEsbIFUXBYXPgbwXTm7c4IHGgXXdwARAQABiQI8BBgBAgAmAhsMFiEEir5O/PD0
skv/Kq+Q1XDy006geT0FAlvR7oMFCQvebyAACgkQ1XDy006geT2Hxw//Zha8j8Uc
4B+DmHhZIvPmHp9aFI4DWhC7CBDrYKztBz42H6eX+UsBu4p+uBDKdW9xJH+Qt/zF
nf/zB5Bhc/wFceVRCAkWxPdiIQeo5XQGjZeORjle7E9iunTko+5q1q9I7IgqWYrn
jRmulDvRhO7AoUrqGACDrV6t0F1/XPB8seR2i6axFmFlt1qBHasRq11yksdgNYiD
KXaovf7csDGPGOCWEKMX7BFGpdK/dWdNYfH0Arfom0U5TqNfvGtP4yRPx2bcs7/1
VXPj7IqhBgOtA9pwtMjFki8HGkqj7bB2ErFBOnSwqqNnNcbnhiO6D74SHVGAHhKZ
whaMPDg76EvjAezoLHg7KWYOyUkWJSLa+YoM9r4+PJuEuW/XuaZCNbrAhek+p3pD
ywhElvZe/2UFk619qKzwSbTzk7a90rxLQ2wwtd0vxAW/GyjWl4/kOMZhI5+LAk1l
REucE0fSQxzCTeXu2ObvFR9ic02IYGH3Koz8CrGReEI1J05041Y5IhKxdsvGOD2W
e7ymcblYW4Gz8eYFlLeNJkj/38R7qmNZ028XHzAZDCAWDiTFrnCoglyk+U0JRHfg
HTsdvoc8mBdT/s24LhnfAbpLizlrZZquuOF6NLQSkbuLtmIwf+h9ynEEJxEkGGWg
7JqB1tMjNHLkRpveO/DTYB+iffpba1nCgumJAjwEGAEIACYCGwwWIQSKvk788PSy
S/8qr5DVcPLTTqB5PQUCYjpDOQUJFCf3VgAKCRDVcPLTTqB5PYDiEADaj1aAdXDb
+XrlhzlGCT3e16RDiE4BjSD1KHZX8ZDABI79JDG0iMN2PpWuViXq7AvWuwgNYdac
WjHsZGgHW82UoPVGKnfEVjjf0lQQIIcgdS5dEV8LamkeIo4vKUX/MZY+Mivk6luP
vCec9Euj/XU1nY6gGq6inpwDtZkNoJlCBune/IIGS82dU8RrSGAHNRZoaDJfdfQm
j7YAOWCUqyzn747yMyuMUOc15iJIgOz1dKN5YwDmFkzjlw+616Aswcp8UA0OfOQ+
e4THli32BgKTSNeOGhGgx1xCDkt+0gP1L0L2Sqhlr6BnqNF65mQ4j2v6UGY1noCo
jYxFchoa1zEdEiZRr/sRO91XlJtK7HyIAI0cUHKVU+Cayoh//OBQBJnbeZlfh9Qn
4ead1pTz9bcKIeZleAjlzNG249bGY+82WsFghb4/7U9MYJVePz0m1zJKPkdABZ+R
lSDvhf4ImesfH5UuofZFv1UXmQL4yV7PDXXdy2xhma7YLznyZTUobDoJiZbuO72O
g5HJCpYoNfvGx++Z9naomUWufqi9PWigEMxU8lUtiGaLQrDW3inTOZTTmTnsJiAI
Lhku0Jr4SjCqxoEFydXOGvNV5XB4WXvf+A6JhcZI+/S72ai1CeSgMFiJLAEb2MZ+
fwPKmQ2cKnCBs5ASj1DkgUcz2c8DTUPVqg==
=i1Tf
\-\-\-\-\-END PGP PUBLIC KEY BLOCK\-\-\-\-\-
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The SaltStack Security Team is available at \fI\%saltproject\-security.pdl@broadcom.com\fP for
security\-related bug reports or questions.
.sp
We request the disclosure of any security\-related bugs or issues be reported
non\-publicly until such time as the issue can be resolved and a security\-fix
release can be prepared. At that time we will release the fix and make a public
announcement with upgrade instructions and download locations.
.SS Security response procedure
.sp
SaltStack takes security and the trust of our customers and users very
seriously. Our disclosure policy is intended to resolve security issues as
quickly and safely as is possible.
.INDENT 0.0
.IP 1. 3
A security report sent to \fI\%saltproject\-security.pdl@broadcom.com\fP is assigned to a team
member. This person is the primary contact for questions and will
coordinate the fix, release, and announcement.
.IP 2. 3
The reported issue is reproduced and confirmed. A list of affected projects
and releases is made.
.IP 3. 3
Fixes are implemented for all affected projects and releases that are
actively supported. Back\-ports of the fix are made to any old releases that
are actively supported.
.IP 4. 3
Packagers are notified via the \fI\%salt\-packagers\fP mailing list that an issue
was reported and resolved, and that an announcement is incoming.
.IP 5. 3
A pre\-announcement is sent out to the \fI\%salt\-announce\fP mailing list approximately
a week before the CVE release. This announcement does not include details
of the vulnerability. The pre\-announcement will include the date the release
will occur and the vulnerability rating.
.IP 6. 3
A new release is created and pushed to all affected repositories. The
release documentation provides a full description of the issue, plus any
upgrade instructions or other relevant details.
.IP 7. 3
An announcement is made to the \fI\%salt\-users\fP and \fI\%salt\-announce\fP mailing
lists. The announcement contains a description of the issue and a link to
the full release documentation and download locations.
.UNINDENT
.SS Receiving security announcements
.sp
The following mailing lists, per the previous tasks identified in our response
procedure, will receive security\-relevant notifications:
.INDENT 0.0
.IP \(bu 2
\fI\%salt\-packagers\fP
.IP \(bu 2
\fI\%salt\-users\fP
.IP \(bu 2
\fI\%salt\-announce\fP
.UNINDENT
.sp
In addition to the mailing lists, SaltStack also provides the following resources:
.INDENT 0.0
.IP \(bu 2
\fI\%SaltStack Security Announcements\fP landing page
.IP \(bu 2
\fI\%SaltStack Security RSS Feed\fP
.IP \(bu 2
\fI\%SaltStack Community Slack Workspace\fP
.UNINDENT
.SS Salt Channels
.sp
One of the fundamental features of Salt is remote execution. Salt has two basic
\(dqchannels\(dq for communicating with minions. Each channel requires a client
(minion) and a server (master) implementation to work within Salt. These pairs
of channels will work together to implement the specific message passing
required by the channel interface. Channels use \fI\%Transports\fP
for sending and receiving messages.
.SS Pub Channel
.sp
The pub (or pubish) channel is how a master sends a job (payload) to a
minion. This is a basic pub/sub paradigm, which has specific targeting semantics.
All data which goes across the publish system should be encrypted such that only
members of the Salt cluster can decrypt the published payloads.
.SS Req Channel
.sp
The req channel is how the minions send data to the master. This interface is
primarily used for fetching files and returning job returns. The req channels
have two basic interfaces when talking to the master. \fBsend\fP is the basic
method that guarantees the message is encrypted at least so that only minions
attached to the same master can read it\-\- but no guarantee of minion\-master
confidentiality, whereas the \fBcrypted_transfer_decode_dictentry\fP method does
guarantee minion\-master confidentiality. The req channel is also used by the
salt cli to publish jobs to the master.
.SS Salt Transport
.sp
Transports in Salt are used by \fI\%Channels\fP to send messages between Masters, Minions,
and the Salt CLI. Transports can be brokerless or brokered. There are two types
of server / client implementations needed to implement a channel.
.SS Publish Server
.sp
The publish server implements a publish / subscribe paradigm and is used by
Minions to receive jobs from Masters.
.SS Publish Client
.sp
The publish client subscribes to, and receives messages from a Publish Server.
.SS Request Server
.sp
The request server implements a request / reply paradigm. Every request sent by
the client must receive exactly one reply.
.SS Request Client
.sp
The request client sends requests to a Request Server and receives a reply message.
.SS ZeroMQ Transport
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
ZeroMQ is the current default transport within Salt
.UNINDENT
.UNINDENT
.sp
ZeroMQ is a messaging library with bindings into many languages. ZeroMQ implements
a socket interface for message passing, with specific semantics for the socket type.
.SS Publish Server and Client
.sp
The publish server and client are implemented using ZeroMQ\(aqs pub/sub sockets. By
default we don\(aqt use ZeroMQ\(aqs filtering, which means that all publish jobs are
sent to all minions and filtered minion side. ZeroMQ does have publisher side
filtering which can be enabled in salt using \fBzmq_filtering\fP\&.
.SS Request Server and Client
.sp
The request server and client are implemented using ZeroMQ\(aqs req/rep sockets.
These sockets enforce a send/recv pattern, which forces salt to serialize
messages through these socket pairs. This means that although the interface is
asynchronous on the minion we cannot send a second message until we have
received the reply of the first message.
.SS TCP Transport
.sp
The tcp transport is an implementation of Salt\(aqs transport using raw tcp sockets.
Since this isn\(aqt using a pre\-defined messaging library we will describe the wire
protocol, message semantics, etc. in this document.
.sp
The tcp transport is enabled by changing the \fI\%transport\fP setting
to \fBtcp\fP on each Salt minion and Salt master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
transport: tcp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
We currently recommend that when using Syndics that all Masters and Minions
use the same transport. We\(aqre investigating a report of an error when using
mixed transport types at very heavy loads.
.UNINDENT
.UNINDENT
.SS TLS Support
.sp
The TLS transport supports full encryption and verification using both server
and client certificates. See \fI\%Transport TLS Support\fP for more details.
.SS Wire Protocol
.sp
This implementation over TCP focuses on flexibility over absolute efficiency.
This means we are okay to spend a couple of bytes of wire space for flexibility
in the future. That being said, the wire framing is quite efficient and looks
like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
msgpack({\(aqhead\(aq: SOMEHEADER, \(aqbody\(aq: SOMEBODY})
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Since msgpack is an iterably parsed serialization, we can simply write the serialized
payload to the wire. Within that payload we have two items \(dqhead\(dq and \(dqbody\(dq.
Head contains header information (such as \(dqmessage id\(dq). The Body contains the
actual message that we are sending. With this flexible wire protocol we can
implement any message semantics that we\(aqd like\-\- including multiplexed message
passing on a single socket.
.SS Crypto
.sp
The current implementation uses the same crypto as the \fBzeromq\fP transport.
.SS Publish Server and Client
.sp
For the publish server and client we send messages without \(dqmessage ids\(dq which
the remote end interprets as a one\-way send.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
As of Salt \fI\%2016.3.0\fP, publishes using \fBlist\fP targeting are sent only to relevant minions and not broadcasted.
.sp
As of Salt \fI\%3005\fP, publishes using \fBpcre\fP and \fBglob\fP targeting are also sent only to relevant minions and not broadcasted. Other targeting types are always sent to all minions and rely on minion\-side filtering.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Salt CLI defaults to \fBglob\fP targeting type, so in order to target specific minions without broadcast, you need to use \fI\-L\fP option, such as \fBsalt \-L my.minion test.ping\fP, for masters before 3005.
.UNINDENT
.UNINDENT
.SS Request Server and Client
.sp
For the request server and client we send messages with a \(dqmessage id\(dq. This
\(dqmessage id\(dq allows us to multiplex messages across the socket.
.SS Websocket Transport
.sp
The Websocket transport is an implementation of Salt\(aqs transport using the websocket protocol.
The Websocket transport is enabled by changing the \fI\%transport\fP setting
to \fBws\fP on each Salt minion and Salt master.
.SS TLS Support
.sp
The Websocket transport supports full encryption and verification using both server
and client certificates. See \fI\%Transport TLS Support\fP for more details.
.SS Publish Server and Client
.sp
The publish server and client are implemented using aiohttp.
.SS Request Server and Client
.sp
The request server and client are implemented using aiohttp.
.SS Transport TLS Support
.sp
Whenever possible transports should provide TLS Support. Currently the \fI\%TCP Transport\fP and
\fI\%Websocket Transport\fP transports support encryption and verification using TLS.
.sp
New in version 2016.11.1.

.sp
The TCP transport allows for the master/minion communication to be optionally
wrapped in a TLS connection. Enabling this is simple, the master and minion need
to be using the tcp connection, then the \fBssl\fP  option is enabled. The \fBssl\fP
option is passed as a dict and roughly corresponds to the options passed to the
Python \fI\%ssl.wrap_socket\fP
function for backwards compatability.
.sp
New in version 3007.0.

.sp
The \fBssl\fP option accepts \fBverify_locations\fP and \fBverify_flags\fP\&. The
\fBverify_locations\fP option is a list of strings or dictionaries. Strings are
passed as a single argument to the SSL context\(aqs \fBload_verify_locations\fP
method. Dictionary keys are expected to be one of \fBcafile\fP, \fBcapath\fP,
\fBcadata\fP\&. For each corresponding key, the key and value will be passed as a
keyword argument to \fBload_verify_locations\fP\&. The \fBverify_flags\fP option is
a list of string names of verification flags which will be set on the SSL
context. All paths are assumed to be the full path to the file or directory.
.sp
A simple setup looks like this, on the Salt Master add the \fBssl\fP option to the
master configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssl:
  keyfile: <path_to_keyfile>
  certfile: <path_to_certfile>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A more complex setup looks like this, on the Salt Master add the \fBssl\fP
option to the master\(aqs configuration file. In this example the Salt Master will
require valid client side certificates from Minions by setting \fBcert_reqs\fP to
\fBCERT_REQUIRED\fP\&. The Salt Master will also check a certificate revocation list
if one is provided in \fBverify_locations\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssl:
  keyfile: <path_to_keyfile>
  certfile: <path_to_certfile>
  cert_reqs: CERT_REQUIRED
  verify_locations:
    \- <path_to_ca_cert>
    \- capath: <directory_of_certs>
    \- cafile: <path_to_crl>
  verify_flags:
    \- VERIFY_CRL_CHECK_CHAIN
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The minimal \fIssl\fP option in the minion configuration file looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssl: True
# Versions below 2016.11.4:
ssl: {}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A Minion can be configured to present a client certificate to the master like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssl:
  keyfile: <path_to_keyfile>
  certfile: <path_to_certfile>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Specific options can be sent to the minion also, as defined in the Python
\fIssl.wrap_socket\fP function.
.SS Master Tops System
.sp
In 0.10.4 the \fIexternal_nodes\fP system was upgraded to allow for modular
subsystems to be used to generate the top file data for a \fI\%highstate\fP run on the master.
.sp
The old \fIexternal_nodes\fP option has been removed. The master tops system
provides a pluggable and extendable replacement for it, allowing for multiple
different subsystems to provide top file data.
.sp
Changed in version 3007.0: Masterless minions now support master top modules as well.

.sp
Using the new \fImaster_tops\fP option is simple:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_tops:
  ext_nodes: cobbler\-external\-nodes
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
for \fI\%Cobbler\fP or:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_tops:
  reclass:
    inventory_base_uri: /etc/reclass
    classes_uri: roles
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
for \fI\%Reclass\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_tops:
  varstack: /path/to/the/config/file/varstack.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
for \fBVarstack\fP\&.
.sp
It\(aqs also possible to create custom master_tops modules. Simply place them into
\fBsalt://_tops\fP in the Salt fileserver and use the
\fI\%saltutil.sync_tops\fP runner to sync
them. If this runner function is not available, they can manually be placed
into \fBextmods/tops\fP, relative to the master cachedir (in most cases the full
path will be \fB/var/cache/salt/master/extmods/tops\fP).
.sp
Custom tops modules are written like any other execution module, see the source
for the two modules above for examples of fully functional ones. Below is a
bare\-bones example:
.sp
\fB/etc/salt/master:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_tops:
  customtop: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBcustomtop.py:\fP (custom master_tops module)
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import logging
import sys

# Define the module\(aqs virtual name
__virtualname__ = \(dqcustomtop\(dq

log = logging.getLogger(__name__)


def __virtual__():
    return __virtualname__


def top(**kwargs):
    log.debug(\(dqCalling top in customtop\(dq)
    return {\(dqbase\(dq: [\(dqtest\(dq]}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fIsalt minion state.show_top\fP should then display something like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt minion state.show_top

minion
    \-\-\-\-\-\-\-\-\-\-
    base:
      \- test
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If a master_tops module returns \fI\%top file\fP data for a
given minion, it will be added to the states configured in the top file. It
will \fInot\fP replace it altogether. The 2018.3.0 release adds additional
functionality allowing a minion to treat master_tops as the single source
of truth, irrespective of the top file.
.UNINDENT
.UNINDENT
.SS Renderers
.sp
The Salt state system operates by gathering information from common data types
such as lists, dictionaries, and strings that would be familiar to any
developer.
.sp
Salt Renderers translate input from the format in which it is written into
Python data structures.
.sp
The default renderer is set in the master/minion configuration file using the
\fI\%renderer\fP config option, which defaults to \fBjinja|yaml\fP\&.
.SS Two Kinds of Renderers
.sp
Renderers fall into one of two categories, based on what they output: text or
data. Some exceptions to this would be the \fI\%pure python\fP and \fI\%gpg\fP renderers which could be used in either capacity.
.SS Text Renderers
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Jinja\fP supports a \fI\%secure, sandboxed template execution environment\fP that Salt
takes advantage of. Other text \fI\%Renderers\fP do not support this
functionality, so Salt highly recommends usage of \fBjinja\fP / \fBjinja|yaml\fP\&.
.UNINDENT
.UNINDENT
.sp
A text renderer returns text. These include templating engines such as
\fI\%jinja\fP, \fI\%mako\fP, and
\fI\%genshi\fP, as well as the \fI\%gpg\fP renderer. The following are all text renderers:
.INDENT 0.0
.IP \(bu 2
\fI\%aws_kms\fP
.IP \(bu 2
\fI\%cheetah\fP
.IP \(bu 2
\fI\%genshi\fP
.IP \(bu 2
\fI\%gpg\fP
.IP \(bu 2
\fI\%jinja\fP
.IP \(bu 2
\fI\%mako\fP
.IP \(bu 2
\fI\%nacl\fP
.IP \(bu 2
\fI\%pass\fP
.IP \(bu 2
\fI\%py\fP
.IP \(bu 2
\fI\%wempy\fP
.UNINDENT
.SS Data Renderers
.sp
A data renderer returns a Python data structure (typically a dictionary). The
following are all data renderers:
.INDENT 0.0
.IP \(bu 2
\fI\%dson\fP
.IP \(bu 2
\fI\%hjson\fP
.IP \(bu 2
\fI\%json5\fP
.IP \(bu 2
\fI\%json\fP
.IP \(bu 2
\fI\%pydsl\fP
.IP \(bu 2
\fI\%pyobjects\fP
.IP \(bu 2
\fI\%py\fP
.IP \(bu 2
\fI\%stateconf\fP
.IP \(bu 2
\fI\%yamlex\fP
.IP \(bu 2
\fI\%yaml\fP
.IP \(bu 2
\fI\%gpg\fP
.UNINDENT
.SS Overriding the Default Renderer
.sp
It can sometimes be beneficial to write an SLS file using a renderer other than
the default one. This can be done by using a \(dqshebang\(dq\-like syntax on the first
line of the SLS file:
.sp
Here is an example of using the \fI\%pure python\fP renderer
to install a package:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!py


def run():
    \(dq\(dq\(dq
    Install version 1.5\-1.el7 of package \(dqpython\-foo\(dq
    \(dq\(dq\(dq
    return {
        \(dqinclude\(dq: [\(dqpython\(dq],
        \(dqpython\-foo\(dq: {\(dqpkg.installed\(dq: [{\(dqversion\(dq: \(dq1.5\-1.el7\(dq}]},
    }
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This would be equivalent to the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- python

python\-foo:
  pkg.installed:
    \- version: \(aq1.5\-1.el7\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Composing Renderers (a.k.a. The \(dqRender Pipeline\(dq)
.sp
A render pipeline can be composed from other renderers by connecting them in a
series of \(dqpipes\(dq (i.e. \fB|\fP). The renderers will be evaluated from left to
right, with each renderer receiving the result of the previous renderer\(aqs
execution.
.sp
Take for example the default renderer (\fBjinja|yaml\fP). The file is evaluated
first a jinja template, and the result of that template is evaluated as a YAML
document.
.sp
Other render pipeline combinations include:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \fByaml\fP
Just YAML, no templating.
.TP
.B \fBmako|yaml\fP
This passes the input to the \fBmako\fP renderer, with its output fed into
the \fByaml\fP renderer.
.TP
.B \fBjinja|mako|yaml\fP
This one allows you to use both jinja and mako templating syntax in the
input and then parse the final rendered output as YAML.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The following is a contrived example SLS file using the \fBjinja|mako|yaml\fP
render pipeline:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!jinja|mako|yaml

An_Example:
  cmd.run:
    \- name: |
        echo \(dqUsing Salt ${grains[\(aqsaltversion\(aq]}\(dq \e
             \(dqfrom path {{grains[\(aqsaltpath\(aq]}}.\(dq
    \- cwd: /

<%doc> ${...} is Mako\(aqs notation, and so is this comment. </%doc>
{#     Similarly, {{...}} is Jinja\(aqs notation, and so is this comment. #}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
Keep in mind that not all renderers can be used alone or with any other
renderers. For example, text renderers shouldn\(aqt be used alone as their
outputs are just strings, which still need to be parsed by another renderer
to turn them into Python data structures.
.sp
For example, it would not make sense to use \fByaml|jinja\fP because the
output of the \fI\%yaml\fP renderer is a Python data
structure, and the \fI\%jinja\fP renderer only
accepts text as input.
.sp
Therefore, when combining renderers, you should know what each renderer
accepts as input and what it returns as output. One way of thinking about
it is that you can chain together multiple text renderers, but the pipeline
\fImust\fP end in a data renderer. Similarly, since the text renderers in Salt
don\(aqt accept data structures as input, a text renderer should usually not
come after a data renderer. It\(aqs technically \fIpossible\fP to write a renderer
that takes a data structure as input and returns a string, but no such
renderer is distributed with Salt.
.UNINDENT
.UNINDENT
.SS Writing Renderers
.sp
A custom renderer must be a Python module which implements a \fBrender\fP
function. This function must implement three positional arguments:
.INDENT 0.0
.IP 1. 3
\fBdata\fP \- Can be called whatever you like. This is the input to be
rendered.
.IP 2. 3
\fBsaltenv\fP
.IP 3. 3
\fBsls\fP
.UNINDENT
.sp
The first is the important one, and the 2nd and 3rd must be included since Salt
needs to pass this info to each render, even though it is only used by template
renderers.
.sp
Renderers should be written so that the \fBdata\fP argument can accept either
strings or file\-like objects as input. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import mycoolmodule
from salt.ext import six


def render(data, saltenv=\(dqbase\(dq, sls=\(dq\(dq, **kwargs):
    if not isinstance(data, six.string_types):
        # Read from file\-like object
        data = data.read()

    return mycoolmodule.do_something(data)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Custom renderers should be placed within \fBsalt://_renderers/\fP, so that they
can be synced to minions. They are synced when any of the following are run:
.INDENT 0.0
.IP \(bu 2
\fI\%state.apply\fP
.IP \(bu 2
\fI\%saltutil.sync_renderers\fP
.IP \(bu 2
\fI\%saltutil.sync_all\fP
.UNINDENT
.sp
Any custom renderers which have been synced to a minion, that are named the
same as one of Salt\(aqs default set of renderers, will take the place of the
default renderer with the same name.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Renderers can also be synced from \fBsalt://_renderers/\fP to the Master
using either the \fI\%saltutil.sync_renderers\fP or \fI\%saltutil.sync_all\fP runner function.
.UNINDENT
.UNINDENT
.SS Examples
.sp
The best place to find examples of renderers is in the Salt source code.
.sp
Documentation for renderers included with Salt can be found here:
.sp
\fI\%salt/renderers\fP
.sp
Here is a simple YAML renderer example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.utils.yaml
from salt.utils.yamlloader import SaltYamlSafeLoader
from salt.ext import six


def render(yaml_data, saltenv=\(dq\(dq, sls=\(dq\(dq, **kws):
    if not isinstance(yaml_data, six.string_types):
        yaml_data = yaml_data.read()
    data = salt.utils.yaml.safe_load(yaml_data)
    return data if data else {}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Full List of Renderers
.SS renderer modules
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Jinja\fP supports a \fI\%secure, sandboxed template execution environment\fP that Salt
takes advantage of. Other text \fI\%Renderers\fP do not support this
functionality, so Salt highly recommends usage of \fBjinja\fP / \fBjinja|yaml\fP\&.
.UNINDENT
.UNINDENT
.TS
center;
|l|l|.
_
T{
\fI\%aws_kms\fP
T}	T{
T}
_
T{
\fI\%cheetah\fP
T}	T{
Cheetah Renderer for Salt
T}
_
T{
\fI\%dson\fP
T}	T{
DSON Renderer for Salt
T}
_
T{
\fI\%genshi\fP
T}	T{
Genshi Renderer for Salt
T}
_
T{
\fI\%gpg\fP
T}	T{
Renderer that will decrypt GPG ciphers
T}
_
T{
\fI\%hjson\fP
T}	T{
hjson renderer for Salt
T}
_
T{
\fI\%jinja\fP
T}	T{
Jinja loading utils to enable a more powerful backend for jinja templates
T}
_
T{
\fI\%json\fP
T}	T{
JSON Renderer for Salt
T}
_
T{
\fI\%json5\fP
T}	T{
JSON5 Renderer for Salt
T}
_
T{
\fI\%mako\fP
T}	T{
Mako Renderer for Salt
T}
_
T{
\fI\%msgpack\fP
T}	T{
T}
_
T{
\fI\%nacl\fP
T}	T{
Renderer that will decrypt NACL ciphers
T}
_
T{
\fI\%pass\fP
T}	T{
Pass Renderer for Salt
T}
_
T{
\fI\%py\fP
T}	T{
Pure python state renderer
T}
_
T{
\fI\%pydsl\fP
T}	T{
A Python\-based DSL
T}
_
T{
\fI\%pyobjects\fP
T}	T{
Python renderer that includes a Pythonic Object based interface
T}
_
T{
\fI\%stateconf\fP
T}	T{
A flexible renderer that takes a templating engine and a data format
T}
_
T{
\fI\%tomlmod\fP
T}	T{
T}
_
T{
\fI\%wempy\fP
T}	T{
T}
_
T{
\fI\%yaml\fP
T}	T{
YAML Renderer for Salt
T}
_
T{
\fI\%yamlex\fP
T}	T{
T}
_
.TE
.SS salt.renderers.aws_kms
.sp
Renderer that will decrypt ciphers encrypted using \fI\%AWS KMS Envelope Encryption\fP\&.
.sp
Any key in the data to be rendered can be a urlsafe_b64encoded string, and this renderer will attempt
to decrypt it before passing it off to Salt. This allows you to safely store secrets in
source control, in such a way that only your Salt master can decrypt them and
distribute them only to the minions that need them.
.sp
The typical use\-case would be to use ciphers in your pillar data, and keep the encrypted
data key on your master. This way developers with appropriate AWS IAM privileges can add new secrets
quickly and easily.
.sp
This renderer requires the \fI\%boto3\fP Python library.
.SS Setup
.sp
First, set up your AWS client. For complete instructions on configuration the AWS client,
please read the \fI\%boto3 configuration documentation\fP\&. By default, this renderer will use
the default AWS profile. You can override the profile name in salt configuration.
For example, if you have a profile in your aws client configuration named \(dqsalt\(dq,
you can add the following salt configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
aws_kms:
  profile_name: salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The rest of these instructions assume that you will use the default profile for key generation
and setup. If not, export AWS_PROFILE and set it to the desired value.
.sp
Once the aws client is configured, generate a KMS customer master key and use that to generate
a local data key.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# data_key=$(aws kms generate\-data\-key \-\-key\-id your\-key\-id \-\-key\-spec AES_256
             \-\-query \(aqCiphertextBlob\(aq \-\-output text)
# echo \(aqaws_kms:\(aq
# echo \(aq  data_key: !!binary \(dq%s\(dq\en\(aq \(dq$data_key\(dq >> config/master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To apply the renderer on a file\-by\-file basis add the following line to the
top of any pillar with gpg data in it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!yaml|aws_kms
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now with your renderer configured, you can include your ciphers in your pillar
data like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!yaml|aws_kms

a\-secret: gAAAAABaj5uzShPI3PEz6nL5Vhk2eEHxGXSZj8g71B84CZsVjAAtDFY1mfjNRl\-1Su9YVvkUzNjI4lHCJJfXqdcTvwczBYtKy0Pa7Ri02s10Wn1tF0tbRwk=
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.renderers.aws_kms.render(data, saltenv=\(aqbase\(aq, sls=\(aq\(aq, argline=\(aq\(aq, **kwargs)
Decrypt the data to be rendered that was encrypted using AWS KMS envelope encryption.
.UNINDENT
.SS salt.renderers.cheetah
.sp
Cheetah Renderer for Salt
.INDENT 0.0
.TP
.B salt.renderers.cheetah.render(cheetah_data, saltenv=\(aqbase\(aq, sls=\(aq\(aq, method=\(aqxml\(aq, **kws)
Render a Cheetah template.
.INDENT 7.0
.TP
.B Return type
A Python data structure
.UNINDENT
.UNINDENT
.SS salt.renderers.dson
.sp
DSON Renderer for Salt
.sp
This renderer is intended for demonstration purposes. Information on the DSON
spec can be found \fI\%here\fP\&.
.sp
This renderer requires \fI\%Dogeon\fP (installable via pip)
.INDENT 0.0
.TP
.B salt.renderers.dson.render(dson_input, saltenv=\(aqbase\(aq, sls=\(aq\(aq, **kwargs)
Accepts DSON data as a string or as a file object and runs it through the
JSON parser.
.INDENT 7.0
.TP
.B Return type
A Python data structure
.UNINDENT
.UNINDENT
.SS salt.renderers.genshi
.sp
Genshi Renderer for Salt
.INDENT 0.0
.TP
.B salt.renderers.genshi.render(genshi_data, saltenv=\(aqbase\(aq, sls=\(aq\(aq, method=\(aqxml\(aq, **kws)
Render a Genshi template. A method should be passed in as part of the
kwargs. If no method is passed in, xml is assumed. Valid methods are:
.sp
Note that the \fBtext\fP method will call \fBNewTextTemplate\fP\&. If \fBoldtext\fP
is desired, it must be called explicitly
.INDENT 7.0
.TP
.B Return type
A Python data structure
.UNINDENT
.UNINDENT
.SS salt.renderers.gpg
.sp
Renderer that will decrypt GPG ciphers
.sp
Any value in the SLS file can be a GPG cipher, and this renderer will decrypt it
before passing it off to Salt. This allows you to safely store secrets in
source control, in such a way that only your Salt master can decrypt them and
distribute them only to the minions that need them.
.sp
The typical use\-case would be to use ciphers in your pillar data, and keep a
secret key on your master. You can put the public key in source control so that
developers can add new secrets quickly and easily.
.sp
This renderer requires the \fI\%gpg\fP binary. No python libraries are required as of
the 2015.8.0 release.
.SS GPG Homedir
.sp
The default \fIGPG Homedir <gpg\-homedir>\fP is \fB~/.gnupg\fP and needs to be set using
\fBgpg \-\-homedir\fP\&. Be very careful to not forget this option. It is also important
to run \fBgpg\fP commands as the user that owns the keys directory. If the salt\-master
runs as user \fBsalt\fP, then use \fBsu \- salt\fP before running any gpg commands.
.sp
In some cases, it\(aqs preferable to have gpg keys stored on removable media or
other non\-standard locations. This can be done using the \fBgpg_keydir\fP option
on the salt master. This will also require using a different path to \fB\-\-homedir\fP\&.
.sp
The \fB\-\-homedir\fP argument can be configured for the current user using
\fBecho \(aqhomedir /etc/salt/gpgkeys\(aq >> ~/.gnupg\fP, but this should be used with
caution to avoid potential confusion.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gpg_keydir: <path/to/homedir>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS GPG Keys
.sp
GPG key pairs include both a public and private key. The private key is akin to
a password and should be kept secure by the owner. A public key is used to
encrypt data being sent to the owner of the private key.
.sp
This means that the public key will be freely distributed so that others can
encrypt pillar data without access to the secret key.
.SS New Key Pair
.sp
To create a new GPG key pair for encrypting data, log in to the master as root
and run the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# mkdir \-p /etc/salt/gpgkeys
# chmod 0700 /etc/salt/gpgkeys
# gpg \-\-homedir /etc/salt/gpgkeys \-\-gen\-key
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Do not supply a password for the keypair and use a name that makes sense for
your application.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In some situations, gpg may be starved of entropy and will take an incredibly
long time to finish. Two common tools to generate (less secure) pseudo\-random
data are \fBrng\-tools\fP and \fBhaveged\fP\&.
.UNINDENT
.UNINDENT
.sp
The new keys can be seen and verified using \fB\-\-list\-secret\-keys\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# gpg \-\-homedir /etc/salt/gpgkeys \-\-list\-secret\-keys
/etc/salt/gpgkeys/pubring.kbx
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
sec   rsa4096 2002\-05\-12 [SC] [expires: 2012\-05\-10]
      2DC47B416EE8C3484450B450A4D44406274AF44E
uid           [ultimate] salt\-master (gpg key for salt) <salt@cm.domain.tld>
ssb   rsa4096 2002\-05\-12 [E] [expires: 2012\-05\-10]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the example above, our KEY\-ID is \fB2DC47B416EE8C3484450B450A4D44406274AF44E\fP\&.
.SS Export Public Key
.sp
To export a public key suitable for public distribution:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# gpg \-\-homedir /etc/salt/gpgkeys \-\-armor \-\-export <KEY\-ID> > exported_pubkey.asc
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Import Public Key
.sp
Users wishing to import the public key into their local keychain may run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ gpg \-\-import exported_pubkey.asc
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Export (Save) Private Key
.sp
This key protects all gpg\-encrypted pillar data and should be backed up to a
safe and secure location. This command will generate a backup of secret keys
in the \fB/etc/salt/gpgkeys\fP directory to the \fBgpgkeys.secret\fP file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# gpg \-\-homedir /etc/salt/gpgkeys \-\-export\-secret\-keys \-\-export\-options export\-backup \-o gpgkeys.secret
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt does not support password\-protected private keys, which means this file
is essentially a clear\-text password (just add \fB\-\-armor\fP). Fortunately, it
is trivial to pass this export back to gpg to be encrypted with symmetric key:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# gpg \-\-homedir /etc/salt/gpgkeys \-\-export\-secret\-keys \-\-export\-options export\-backup | gpg \-\-symmetric \-o gpgkeys.gpg
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In some cases, particularly when using su/sudo, gpg gets confused and needs
to be told which TTY to use; this can be done with: \fBexport GPG_TTY=$(tty)\fP\&.
.UNINDENT
.UNINDENT
.SS Import (Restore) Private Key
.sp
To import/restore a private key, create a directory with the correct permissions
and import using gpg.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# mkdir \-p /etc/salt/gpgkeys
# chmod 0700 /etc/salt/gpgkeys
# gpg \-\-homedir /etc/salt/gpgkeys \-\-import gpgkeys.secret
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the export was encrypted using a symmetric key, then decrypt first with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# gpg \-\-decrypt gpgkeys.gpg | gpg \-\-homedir /etc/salt/gpgkeys \-\-import
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Adjust trust level of imported keys
.sp
In some cases, importing existing keys may not be enough and the trust level of
the key needs to be adjusted. This can be done by editing the key. The \fBKEY\-ID\fP
and the actual trust level of the key can be seen by listing the already imported
keys.
.sp
If the trust\-level is not \fBultimate\fP it needs to be changed by running
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gpg \-\-homedir /etc/salt/gpgkeys \-\-edit\-key <KEY\-ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will open an interactive shell for the management of the GPG encryption key.
Type \fBtrust\fP to be able to set the trust level for the key and then select \fB5
(I trust ultimately)\fP\&. Then quit the shell by typing \fBsave\fP\&.
.SS Encrypting Data
.sp
In order to encrypt data to a recipient (salt), the public key must be imported
into the local keyring. Importing the public key is described above in the
\fIImport Public Key <gpg\-importpubkey:>\fP section.
.sp
To generate a cipher from a secret:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ echo \-n \(aqsupersecret\(aq | gpg \-\-trust\-model always \-ear <KEY\-ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To apply the renderer on a file\-by\-file basis add the following line to the
top of any pillar with gpg data in it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!yaml|gpg
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now with your renderer configured, you can include your ciphers in your pillar
data like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!yaml|gpg

a\-secret: |
  \-\-\-\-\-BEGIN PGP MESSAGE\-\-\-\-\-
  Version: GnuPG v1

  hQEMAweRHKaPCfNeAQf9GLTN16hCfXAbPwU6BbBK0unOc7i9/etGuVc5CyU9Q6um
  QuetdvQVLFO/HkrC4lgeNQdM6D9E8PKonMlgJPyUvC8ggxhj0/IPFEKmrsnv2k6+
  cnEfmVexS7o/U1VOVjoyUeliMCJlAz/30RXaME49Cpi6No2+vKD8a4q4nZN1UZcG
  RhkhC0S22zNxOXQ38TBkmtJcqxnqT6YWKTUsjVubW3bVC+u2HGqJHu79wmwuN8tz
  m4wBkfCAd8Eyo2jEnWQcM4TcXiF01XPL4z4g1/9AAxh+Q4d8RIRP4fbw7ct4nCJv
  Gr9v2DTF7HNigIMl4ivMIn9fp+EZurJNiQskLgNbktJGAeEKYkqX5iCuB1b693hJ
  FKlwHiJt5yA8X2dDtfk8/Ph1Jx2TwGS+lGjlZaNqp3R1xuAZzXzZMLyZDe5+i3RJ
  skqmFTbOiA===Eqsm
  \-\-\-\-\-END PGP MESSAGE\-\-\-\-\-
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Encrypted CLI Pillar Data
.sp
New in version 2016.3.0.

.sp
Functions like \fI\%state.highstate\fP and
\fI\%state.sls\fP allow for pillar data to be
passed on the CLI.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion state.highstate pillar=\(dq{\(aqmypillar\(aq: \(aqfoo\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Starting with the 2016.3.0 release of Salt, it is now possible for this pillar
data to be GPG\-encrypted, and to use the GPG renderer to decrypt it.
.SS Replacing Newlines
.sp
To pass encrypted pillar data on the CLI, the ciphertext must have its newlines
replaced with a literal backslash\-n (\fB\en\fP), as newlines are not supported
within Salt CLI arguments. There are a number of ways to do this:
.sp
With awk or Perl:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# awk
ciphertext=\(gaecho \-n \(dqsupersecret\(dq | gpg \-\-armor \-\-batch \-\-trust\-model always \-\-encrypt \-r user@domain.com | awk \(aq{printf \(dq%s\e\en\(dq,$0} END {print \(dq\(dq}\(aq\(ga
# Perl
ciphertext=\(gaecho \-n \(dqsupersecret\(dq | gpg \-\-armor \-\-batch \-\-trust\-model always \-\-encrypt \-r user@domain.com | perl \-pe \(aqs/\en/\e\en/g\(aq\(ga
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With Python:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import subprocess

secret, stderr = subprocess.Popen(
    [\(aqgpg\(aq, \(aq\-\-armor\(aq, \(aq\-\-batch\(aq, \(aq\-\-trust\-model\(aq, \(aqalways\(aq, \(aq\-\-encrypt\(aq,
     \(aq\-r\(aq, \(aquser@domain.com\(aq],
    stdin=subprocess.PIPE,
    stdout=subprocess.PIPE,
    stderr=subprocess.PIPE).communicate(input=\(aqsupersecret\(aq)

if secret:
    print(secret.replace(\(aq\en\(aq, r\(aq\en\(aq))
else:
    raise ValueError(\(aqNo ciphertext found: {0}\(aq.format(stderr))
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ciphertext=\(gapython /path/to/script.py\(ga
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The ciphertext can be included in the CLI pillar data like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion state.sls secretstuff pillar_enc=gpg pillar=\(dq{secret_pillar: \(aq$ciphertext\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBpillar_enc=gpg\fP argument tells Salt that there is GPG\-encrypted pillar
data, so that the CLI pillar data is passed through the GPG renderer, which
will iterate recursively though the CLI pillar dictionary to decrypt any
encrypted values.
.SS Encrypting the Entire CLI Pillar Dictionary
.sp
If several values need to be encrypted, it may be more convenient to encrypt
the entire CLI pillar dictionary. Again, this can be done in several ways:
.sp
With awk or Perl:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# awk
ciphertext=\(gaecho \-n \(dq{\(aqsecret_a\(aq: \(aqCorrectHorseBatteryStaple\(aq, \(aqsecret_b\(aq: \(aqGPG is fun!\(aq}\(dq | gpg \-\-armor \-\-batch \-\-trust\-model always \-\-encrypt \-r user@domain.com | awk \(aq{printf \(dq%s\e\en\(dq,$0} END {print \(dq\(dq}\(aq\(ga
# Perl
ciphertext=\(gaecho \-n \(dq{\(aqsecret_a\(aq: \(aqCorrectHorseBatteryStaple\(aq, \(aqsecret_b\(aq: \(aqGPG is fun!\(aq}\(dq | gpg \-\-armor \-\-batch \-\-trust\-model always \-\-encrypt \-r user@domain.com | perl \-pe \(aqs/\en/\e\en/g\(aq\(ga
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With Python:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import subprocess

pillar_data = {\(aqsecret_a\(aq: \(aqCorrectHorseBatteryStaple\(aq,
               \(aqsecret_b\(aq: \(aqGPG is fun!\(aq}

secret, stderr = subprocess.Popen(
    [\(aqgpg\(aq, \(aq\-\-armor\(aq, \(aq\-\-batch\(aq, \(aq\-\-trust\-model\(aq, \(aqalways\(aq, \(aq\-\-encrypt\(aq,
     \(aq\-r\(aq, \(aquser@domain.com\(aq],
    stdin=subprocess.PIPE,
    stdout=subprocess.PIPE,
    stderr=subprocess.PIPE).communicate(input=repr(pillar_data))

if secret:
    print(secret.replace(\(aq\en\(aq, r\(aq\en\(aq))
else:
    raise ValueError(\(aqNo ciphertext found: {0}\(aq.format(stderr))
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ciphertext=\(gapython /path/to/script.py\(ga
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With the entire pillar dictionary now encrypted, it can be included in the CLI
pillar data like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion state.sls secretstuff pillar_enc=gpg pillar=\(dq$ciphertext\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configuration
.sp
The default behaviour of this renderer is to log a warning if a block could not
be decrypted; in other words, it just returns the ciphertext rather than the
encrypted secret.
.sp
This behaviour can be changed via the \fIgpg_decrypt_must_succeed\fP configuration
option.  If set to \fITrue\fP, any gpg block that cannot be decrypted raises a
\fISaltRenderError\fP exception, which registers an error in \fB_errors\fP during
rendering.
.sp
In the Chlorine release, the default behavior will be reversed and an error
message will be added to \fB_errors\fP by default.
.INDENT 0.0
.TP
.B salt.renderers.gpg.render(gpg_data, saltenv=\(aqbase\(aq, sls=\(aq\(aq, argline=\(aq\(aq, **kwargs)
Create a gpg object given a gpg_keydir, and then use it to try to decrypt
the data to be rendered.
.UNINDENT
.SS salt.renderers.hjson
.sp
hjson renderer for Salt
.sp
See the \fI\%hjson\fP documentation for more information
.INDENT 0.0
.TP
.B salt.renderers.hjson.render(hjson_data, saltenv=\(aqbase\(aq, sls=\(aq\(aq, **kws)
Accepts HJSON as a string or as a file object and runs it through the HJSON
parser.
.INDENT 7.0
.TP
.B Return type
A Python data structure
.UNINDENT
.UNINDENT
.SS salt.renderers.jinja
.sp
Jinja loading utils to enable a more powerful backend for jinja templates
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Jinja\fP supports a \fI\%secure, sandboxed template execution environment\fP that Salt
takes advantage of. Other text \fI\%Renderers\fP do not support this
functionality, so Salt highly recommends usage of \fBjinja\fP / \fBjinja|yaml\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.renderers.jinja.render(template_file, saltenv=\(aqbase\(aq, sls=\(aq\(aq, argline=\(aq\(aq, context=None, tmplpath=None, **kws)
Render the template_file, passing the functions and grains into the
Jinja rendering system.
.INDENT 7.0
.TP
.B Return type
string
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.utils.jinja.SerializerExtension(environment)
Yaml and Json manipulation.
.sp
\fBFormat filters\fP
.sp
Allows jsonifying or yamlifying any data structure. For example, this dataset:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
data = {
    \(aqfoo\(aq: True,
    \(aqbar\(aq: 42,
    \(aqbaz\(aq: [1, 2, 3],
    \(aqqux\(aq: 2.0
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
yaml = {{ data|yaml }}
json = {{ data|json }}
python = {{ data|python }}
xml  = {{ {\(aqroot_node\(aq: data}|xml }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will be rendered as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
yaml = {bar: 42, baz: [1, 2, 3], foo: true, qux: 2.0}
json = {\(dqbaz\(dq: [1, 2, 3], \(dqfoo\(dq: true, \(dqbar\(dq: 42, \(dqqux\(dq: 2.0}
python = {\(aqbar\(aq: 42, \(aqbaz\(aq: [1, 2, 3], \(aqfoo\(aq: True, \(aqqux\(aq: 2.0}
xml = \(dq\(dq\(dq<<?xml version=\(dq1.0\(dq ?>
         <root_node bar=\(dq42\(dq foo=\(dqTrue\(dq qux=\(dq2.0\(dq>
          <baz>1</baz>
          <baz>2</baz>
          <baz>3</baz>
         </root_node>\(dq\(dq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The yaml filter takes an optional flow_style parameter to control the
default\-flow\-style parameter of the YAML dumper.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{{ data|yaml(False) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will be rendered as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
bar: 42
baz:
  \- 1
  \- 2
  \- 3
foo: true
qux: 2.0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBLoad filters\fP
.sp
Strings and variables can be deserialized with \fBload_yaml\fP and
\fBload_json\fP tags and filters. It allows one to manipulate data directly
in templates, easily:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set yaml_src = \(dq{foo: it works}\(dq|load_yaml %}
{%\- set json_src = \(aq{\(dqbar\(dq: \(dqfor real\(dq}\(aq|load_json %}
Dude, {{ yaml_src.foo }} {{ json_src.bar }}!
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will be rendered as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Dude, it works for real!
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBLoad tags\fP
.sp
Salt implements \fBload_yaml\fP and \fBload_json\fP tags. They work like
the \fI\%import tag\fP, except that the document is also deserialized.
.sp
Syntaxes are \fB{% load_yaml as [VARIABLE] %}[YOUR DATA]{% endload %}\fP
and \fB{% load_json as [VARIABLE] %}[YOUR DATA]{% endload %}\fP
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% load_yaml as yaml_src %}
    foo: it works
{% endload %}
{% load_json as json_src %}
    {
        \(dqbar\(dq: \(dqfor real\(dq
    }
{% endload %}
Dude, {{ yaml_src.foo }} {{ json_src.bar }}!
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will be rendered as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Dude, it works for real!
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBImport tags\fP
.sp
External files can be imported and made available as a Jinja variable.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% import_yaml \(dqmyfile.yml\(dq as myfile %}
{% import_json \(dqdefaults.json\(dq as defaults %}
{% import_text \(dqcompleteworksofshakespeare.txt\(dq as poems %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBCatalog\fP
.sp
\fBimport_*\fP and \fBload_*\fP tags will automatically expose their
target variable to import. This feature makes catalog of data to
handle.
.sp
for example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# doc1.sls
{% load_yaml as var1 %}
    foo: it works
{% endload %}
{% load_yaml as var2 %}
    bar: for real
{% endload %}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# doc2.sls
{% from \(dqdoc1.sls\(dq import var1, var2 as local2 %}
{{ var1.foo }} {{ local2.bar }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
** Escape Filters **
.sp
New in version 2017.7.0.

.sp
Allows escaping of strings so they can be interpreted literally by another
function.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
regex_escape = {{ \(aqhttps://example.com?foo=bar%20baz\(aq | regex_escape }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will be rendered as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
regex_escape = https\e:\e/\e/example\e.com\e?foo\e=bar\e%20baz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
** Set Theory Filters **
.sp
New in version 2017.7.0.

.sp
Performs set math using Jinja filters.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
unique = {{ [\(aqfoo\(aq, \(aqfoo\(aq, \(aqbar\(aq] | unique }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will be rendered as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
unique = [\(aqfoo\(aq, \(aqbar\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
** Salt State Parameter Format Filters **
.sp
New in version 3005.

.sp
Renders a formatted multi\-line YAML string from a Python dictionary. Each
key/value pair in the dictionary will be added as a single\-key dictionary
to a list that will then be sent to the YAML formatter.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set thing_params = {
    \(dqname\(dq: \(dqthing\(dq,
    \(dqchanges\(dq: True,
    \(dqwarnings\(dq: \(dqOMG! Stuff is happening!\(dq
   }
%}

thing:
  test.configurable_test_state:
    {{ thing_params | dict_to_sls_yaml_params | indent }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will be rendered as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\&.. code\-block:: yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B thing:
.INDENT 7.0
.TP
.B test.configurable_test_state:
.INDENT 7.0
.IP \(bu 2
name: thing
.IP \(bu 2
changes: true
.IP \(bu 2
warnings: OMG! Stuff is happening!
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.renderers.json
.sp
JSON Renderer for Salt
.INDENT 0.0
.TP
.B salt.renderers.json.render(json_data, saltenv=\(aqbase\(aq, sls=\(aq\(aq, **kws)
Accepts JSON as a string or as a file object and runs it through the JSON
parser.
.INDENT 7.0
.TP
.B Return type
A Python data structure
.UNINDENT
.UNINDENT
.SS salt.renderers.json5
.sp
JSON5 Renderer for Salt
.sp
New in version 2016.3.0.

.sp
JSON5 is an unofficial extension to JSON. See \fI\%http://json5.org/\fP for more
information.
.sp
This renderer requires the \fI\%json5 python bindings\fP, installable via pip.
.INDENT 0.0
.TP
.B salt.renderers.json5.render(json_data, saltenv=\(aqbase\(aq, sls=\(aq\(aq, **kws)
Accepts JSON as a string or as a file object and runs it through the JSON
parser.
.INDENT 7.0
.TP
.B Return type
A Python data structure
.UNINDENT
.UNINDENT
.SS salt.renderers.mako
.sp
Mako Renderer for Salt
.sp
This renderer requires the Mako library.
.sp
To install Mako, do the following:
.INDENT 0.0
.TP
.B salt.renderers.mako.render(template_file, saltenv=\(aqbase\(aq, sls=\(aq\(aq, context=None, tmplpath=None, **kws)
Render the template_file, passing the functions and grains into the
Mako rendering system.
.INDENT 7.0
.TP
.B Return type
string
.UNINDENT
.UNINDENT
.SS salt.renderers.msgpack
.INDENT 0.0
.TP
.B salt.renderers.msgpack.render(msgpack_data, saltenv=\(aqbase\(aq, sls=\(aq\(aq, **kws)
Accepts a message pack string or a file object, renders said data back to
a python dict.
.INDENT 7.0
.TP
.B Return type
A Python data structure
.UNINDENT
.UNINDENT
.SS salt.renderers.nacl
.sp
Renderer that will decrypt NACL ciphers
.sp
Any key in the SLS file can be an NACL cipher, and this renderer will decrypt it
before passing it off to Salt. This allows you to safely store secrets in
source control, in such a way that only your Salt master can decrypt them and
distribute them only to the minions that need them.
.sp
The typical use\-case would be to use ciphers in your pillar data, and keep a
secret key on your master. You can put the public key in source control so that
developers can add new secrets quickly and easily.
.sp
This renderer requires the libsodium library binary and PyNacl >= 1.0
.SS Setup
.sp
To set things up, first generate a keypair. On the master, run the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call \-\-local nacl.keygen sk_file=/root/.nacl
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Using encrypted pillar
.sp
To encrypt secrets, copy the public key to your local machine and run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-call \-\-local nacl.enc datatoenc pk_file=/root/.nacl.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To apply the renderer on a file\-by\-file basis add the following line to the
top of any pillar with nacl encrypted data in it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!yaml|nacl
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now with your renderer configured, you can include your ciphers in your pillar
data like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!yaml|nacl

a\-secret: \(dqNACL[MRN3cc+fmdxyQbz6WMF+jq1hKdU5X5BBI7OjK+atvHo1ll+w1gZ7XyWtZVfq9gK9rQaMfkDxmidJKwE0Mw==]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.renderers.nacl.render(nacl_data, saltenv=\(aqbase\(aq, sls=\(aq\(aq, argline=\(aq\(aq, **kwargs)
Decrypt the data to be rendered using the given nacl key or the one given
in config
.UNINDENT
.SS salt.renderers.pass
.SS Pass Renderer for Salt
.sp
\fI\%pass\fP is an encrypted on\-disk password store.
.sp
New in version 2017.7.0.

.SS Setup
.sp
\fINote\fP: \fB<user>\fP needs to be replaced with the user salt\-master will be
running as.
.sp
Have private gpg loaded into \fBuser\fP\(aqs gpg keyring
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
load_private_gpg_key:
  cmd.run:
    \- name: gpg \-\-import <location_of_private_gpg_key>
    \- unless: gpg \-\-list\-keys \(aq<gpg_name>\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Said private key\(aqs public key should have been used when encrypting pass entries
that are of interest for pillar data.
.sp
Fetch and keep local pass git repo up\-to\-date
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
update_pass:
  git.latest:
    \- force_reset: True
    \- name: <git_repo>
    \- target: /<user>/.password\-store
    \- identity: <location_of_ssh_private_key>
    \- require:
      \- cmd: load_private_gpg_key
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Install pass binary
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pass:
  pkg.installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt master configuration options
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# If the prefix is *not* set (default behavior), all template variables are
# considered for fetching secrets from Pass. Those that cannot be resolved
# to a secret are passed through.
#
# If the prefix is set, only the template variables with matching prefix are
# considered for fetching the secrets, other variables are passed through.
#
# For ease of use it is recommended to set the following options as well:
#       renderer: \(aqjinja|yaml|pass\(aq
#       pass_strict_fetch: true
#
pass_variable_prefix: \(aqpass:\(aq

# If set to \(aqtrue\(aq, error out when unable to fetch a secret for a template variable.
pass_strict_fetch: true

# Set GNUPGHOME env for Pass.
# Defaults to: ~/.gnupg
pass_gnupghome: <path>

# Set PASSWORD_STORE_DIR env for Pass.
# Defaults to: ~/.password\-store
pass_dir: <path>
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.renderers.pass.render(pass_info, saltenv=\(aqbase\(aq, sls=\(aq\(aq, argline=\(aq\(aq, **kwargs)
Fetch secret from pass based on pass_path
.UNINDENT
.SS salt.renderers.py
.SS Pure python state renderer
.sp
To use this renderer, the SLS file should contain a function called \fBrun\fP
which returns highstate data.
.sp
The highstate data is a dictionary containing identifiers as keys, and execution
dictionaries as values. For example the following state declaration in YAML:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
common_packages:
  pkg.installed:
   \- pkgs:
      \- curl
      \- vim
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
translates to:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqcommon_packages\(aq: {\(aqpkg.installed\(aq: [{\(aqpkgs\(aq: [\(aqcurl\(aq, \(aqvim\(aq]}]}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this module, a few objects are defined for you, giving access to Salt\(aqs
execution functions, grains, pillar, etc. They are:
.INDENT 0.0
.IP \(bu 2
\fB__salt__\fP \- \fI\%Execution functions\fP (i.e.
\fB__salt__[\(aqtest.echo\(aq](\(aqfoo\(aq)\fP)
.IP \(bu 2
\fB__grains__\fP \- \fI\%Grains\fP (i.e. \fB__grains__[\(aqos\(aq]\fP)
.IP \(bu 2
\fB__pillar__\fP \- \fI\%Pillar data\fP (i.e. \fB__pillar__[\(aqfoo\(aq]\fP)
.IP \(bu 2
\fB__opts__\fP \- Minion configuration options
.IP \(bu 2
\fB__env__\fP \- The effective salt fileserver environment (i.e. \fBbase\fP). Also
referred to as a \(dqsaltenv\(dq. \fB__env__\fP should not be modified in a pure
python SLS file. To use a different environment, the environment should be
set when executing the state. This can be done in a couple different ways:
.INDENT 2.0
.IP \(bu 2
Using the \fBsaltenv\fP argument on the salt CLI (i.e. \fBsalt \(aq*\(aq state.sls
foo.bar.baz saltenv=env_name\fP).
.IP \(bu 2
By adding a \fBsaltenv\fP argument to an individual state within the SLS
file. In other words, adding a line like this to the state\(aqs data
structure: \fB{\(aqsaltenv\(aq: \(aqenv_name\(aq}\fP
.UNINDENT
.IP \(bu 2
\fB__sls__\fP \- The SLS path of the file. For example, if the root of the base
environment is \fB/srv/salt\fP, and the SLS file is
\fB/srv/salt/foo/bar/baz.sls\fP, then \fB__sls__\fP in that file will be
\fBfoo.bar.baz\fP\&.
.UNINDENT
.sp
When used in a scenario where additional user\-provided context data is supplied
(such as with \fI\%file.managed\fP), the additional
data will typically be injected into the script as one or more global
variables:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/http/conf/http.conf:
  file.managed:
    \- source: salt://apache/generate_http_conf.py
    \- template: py
    \- context:
        # Will be injected as the global variable \(dqsite_name\(dq.
        site_name: {{ site_name }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When writing a reactor SLS file the global context \fBdata\fP (same as context
\fB{{ data }}\fP for states written with Jinja + YAML) is available. The
following YAML + Jinja state declaration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% if data[\(aqid\(aq] == \(aqmysql1\(aq %}
highstate_run:
  local.state.apply:
    \- tgt: mysql1
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
translates to:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
if data[\(aqid\(aq] == \(aqmysql1\(aq:
    return {\(aqhighstate_run\(aq: {\(aqlocal.state.apply\(aq: [{\(aqtgt\(aq: \(aqmysql1\(aq}]}}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Full Example
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
 #!py

 def run():
     config = {}

     if __grains__[\(aqos\(aq] == \(aqUbuntu\(aq:
         user = \(aqubuntu\(aq
         group = \(aqubuntu\(aq
         home = \(aq/home/{0}\(aq.format(user)
     else:
         user = \(aqroot\(aq
         group = \(aqroot\(aq
         home = \(aq/root/\(aq

     config[\(aqs3cmd\(aq] = {
         \(aqpkg\(aq: [
             \(aqinstalled\(aq,
             {\(aqname\(aq: \(aqs3cmd\(aq},
         ],
     }

     config[home + \(aq/.s3cfg\(aq] = {
         \(aqfile.managed\(aq: [
             {\(aqsource\(aq: \(aqsalt://s3cfg/templates/s3cfg\(aq},
             {\(aqtemplate\(aq: \(aqjinja\(aq},
             {\(aquser\(aq: user},
             {\(aqgroup\(aq: group},
             {\(aqmode\(aq: 600},
             {\(aqcontext\(aq: {
                 \(aqaws_key\(aq: __pillar__[\(aqAWS_ACCESS_KEY_ID\(aq],
                 \(aqaws_secret_key\(aq: __pillar__[\(aqAWS_SECRET_ACCESS_KEY\(aq],
                 },
             },
         ],
     }

     return config
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.renderers.py.render(template, saltenv=\(aqbase\(aq, sls=\(aq\(aq, tmplpath=None, **kws)
Render the python module\(aqs components
.INDENT 7.0
.TP
.B Return type
string
.UNINDENT
.UNINDENT
.SS salt.renderers.pydsl
.sp
A Python\-based DSL
.INDENT 0.0
.TP
.B maintainer
Jack Kuan <\fI\%kjkuan@gmail.com\fP>
.TP
.B maturity
new
.TP
.B platform
all
.UNINDENT
.sp
The \fIpydsl\fP renderer allows one to author salt formulas (.sls files) in pure
Python using a DSL that\(aqs easy to write and easy to read. Here\(aqs an example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!pydsl

apache = state(\(aqapache\(aq)
apache.pkg.installed()
apache.service.running()
state(\(aq/var/www/index.html\(aq) \e
    .file(\(aqmanaged\(aq,
          source=\(aqsalt://webserver/index.html\(aq) \e
    .require(pkg=\(aqapache\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Notice that any Python code is allow in the file as it\(aqs really a Python
module, so you have the full power of Python at your disposal. In this module,
a few objects are defined for you, including the usual (with \fB__\fP added)
\fB__salt__\fP dictionary, \fB__grains__\fP, \fB__pillar__\fP, \fB__opts__\fP,
\fB__env__\fP, and \fB__sls__\fP, plus a few more:
.INDENT 0.0
.INDENT 3.5
\fB__file__\fP
.INDENT 0.0
.INDENT 3.5
local file system path to the sls module.
.UNINDENT
.UNINDENT
.sp
\fB__pydsl__\fP
.INDENT 0.0
.INDENT 3.5
Salt PyDSL object, useful for configuring DSL behavior per sls rendering.
.UNINDENT
.UNINDENT
.sp
\fBinclude\fP
.INDENT 0.0
.INDENT 3.5
Salt PyDSL function for creating \fI\%Include declaration\fP\(aqs.
.UNINDENT
.UNINDENT
.sp
\fBextend\fP
.INDENT 0.0
.INDENT 3.5
Salt PyDSL function for creating \fI\%Extend declaration\fP\(aqs.
.UNINDENT
.UNINDENT
.sp
\fBstate\fP
.INDENT 0.0
.INDENT 3.5
Salt PyDSL function for creating \fI\%ID declaration\fP\(aqs.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
A state \fI\%ID declaration\fP is created with a \fBstate(id)\fP function call.
Subsequent \fBstate(id)\fP call with the same id returns the same object. This
singleton access pattern applies to all declaration objects created with the
DSL.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state(\(aqexample\(aq)
assert state(\(aqexample\(aq) is state(\(aqexample\(aq)
assert state(\(aqexample\(aq).cmd is state(\(aqexample\(aq).cmd
assert state(\(aqexample\(aq).cmd.running is state(\(aqexample\(aq).cmd.running
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fIid\fP argument is optional. If omitted, an UUID will be generated and used as
the \fIid\fP\&.
.sp
\fBstate(id)\fP returns an object under which you can create a
\fI\%State declaration\fP object by accessing an attribute named after \fIany\fP
state module available in Salt.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state(\(aqexample\(aq).cmd
state(\(aqexample\(aq).file
state(\(aqexample\(aq).pkg
\&...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then, a \fI\%Function declaration\fP object can be created from a
\fI\%State declaration\fP object by one of the following two ways:
.INDENT 0.0
.IP 1. 3
by calling a method named after the state function on the \fI\%State declaration\fP object.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state(\(aqexample\(aq).file.managed(...)
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 2. 3
by directly calling the attribute named for the \fI\%State declaration\fP, and
supplying the state function name as the first argument.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state(\(aqexample\(aq).file(\(aqmanaged\(aq, ...)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With either way of creating a \fI\%Function declaration\fP object, any
\fI\%Function arg declaration\fP\(aqs can be passed as keyword arguments to the
call. Subsequent calls of a \fI\%Function declaration\fP will update the arg
declarations.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state(\(aqexample\(aq).file(\(aqmanaged\(aq, source=\(aqsalt://webserver/index.html\(aq)
state(\(aqexample\(aq).file.managed(source=\(aqsalt://webserver/index.html\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As a shortcut, the special \fIname\fP argument can also be passed as the
first or second positional argument depending on the first or second
way of calling the \fI\%State declaration\fP object. In the following
two examples \fIls \-la\fP is the \fIname\fP argument.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state(\(aqexample\(aq).cmd.run(\(aqls \-la\(aq, cwd=\(aq/\(aq)
state(\(aqexample\(aq).cmd(\(aqrun\(aq, \(aqls \-la\(aq, cwd=\(aq/\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Finally, a \fI\%Requisite declaration\fP object with its
\fI\%Requisite reference\fP\(aqs can be created by invoking one of the
requisite methods (see \fI\%State Requisites\fP) on either a
\fI\%Function declaration\fP object or a \fI\%State declaration\fP object.
The return value of a requisite call is also a \fI\%Function declaration\fP
object, so you can chain several requisite calls together.
.sp
Arguments to a requisite call can be a list of \fI\%State declaration\fP objects
and/or a set of keyword arguments whose names are state modules and values are
IDs of \fI\%ID declaration\fP\(aqs or names of \fI\%Name declaration\fP\(aqs.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache2 = state(\(aqapache2\(aq)
apache2.pkg.installed()
state(\(aqlibapache2\-mod\-wsgi\(aq).pkg.installed()

# you can call requisites on function declaration
apache2.service.running() \e
               .require(apache2.pkg,
                        pkg=\(aqlibapache2\-mod\-wsgi\(aq) \e
               .watch(file=\(aq/etc/apache2/httpd.conf\(aq)

# or you can call requisites on state declaration.
# this actually creates an anonymous function declaration object
# to add the requisites.
apache2.service.require(state(\(aqlibapache2\-mod\-wsgi\(aq).pkg,
                        pkg=\(aqapache2\(aq) \e
               .watch(file=\(aq/etc/apache2/httpd.conf\(aq)

# we still need to set the name of the function declaration.
apache2.service.running()
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fI\%Include declaration\fP objects can be created with the \fBinclude\fP function,
while \fI\%Extend declaration\fP objects can be created with the \fBextend\fP function,
whose arguments are just \fI\%Function declaration\fP objects.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include(\(aqedit.vim\(aq, \(aqhttp.server\(aq)
extend(state(\(aqapache2\(aq).service.watch(file=\(aq/etc/httpd/httpd.conf\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBinclude\fP function, by default, causes the included sls file to be rendered
as soon as the \fBinclude\fP function is called. It returns a list of rendered module
objects; sls files not rendered with the pydsl renderer return \fBNone\fP\(aqs.
This behavior creates no \fI\%Include declaration\fP\(aqs in the resulting high state
data structure.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import types

# including multiple sls returns a list.
_, mod = include(\(aqa\-non\-pydsl\-sls\(aq, \(aqa\-pydsl\-sls\(aq)

assert _ is None
assert isinstance(slsmods[1], types.ModuleType)

# including a single sls returns a single object
mod = include(\(aqa\-pydsl\-sls\(aq)

# myfunc is a function that calls state(...) to create more states.
mod.myfunc(1, 2, \(dqthree\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Notice how you can define a reusable function in your pydsl sls module and then
call it via the module returned by \fBinclude\fP\&.
.sp
It\(aqs still possible to do late includes by passing the \fBdelayed=True\fP keyword
argument to \fBinclude\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include(\(aqedit.vim\(aq, \(aqhttp.server\(aq, delayed=True)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Above will just create a \fI\%Include declaration\fP in the rendered result, and
such call always returns \fBNone\fP\&.
.SS Special integration with the \fIcmd\fP state
.sp
Taking advantage of rendering a Python module, PyDSL allows you to declare a
state that calls a pre\-defined Python function when the state is executed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
greeting = \(dqhello world\(dq
def helper(something, *args, **kws):
    print greeting                # hello world
    print something, args, kws    # test123 [\(aqa\(aq, \(aqb\(aq, \(aqc\(aq] {\(aqx\(aq: 1, \(aqy\(aq: 2}

state().cmd.call(helper, \(dqtest123\(dq, \(aqa\(aq, \(aqb\(aq, \(aqc\(aq, x=1, y=2)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fIcmd.call\fP state function takes care of calling our \fBhelper\fP function
with the arguments we specified in the states, and translates the return value
of our function into a structure expected by the state system.
See \fI\%salt.states.cmd.call()\fP for more information.
.SS Implicit ordering of states
.sp
Salt states are explicitly ordered via \fI\%Requisite declaration\fP\(aqs.
However, with \fIpydsl\fP it\(aqs possible to let the renderer track the order
of creation for \fI\%Function declaration\fP objects, and implicitly add
\fBrequire\fP requisites for your states to enforce the ordering. This feature
is enabled by setting the \fBordered\fP option on \fB__pydsl__\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
this feature is only available if your minions are using Python >= 2.7.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include(\(aqsome.sls.file\(aq)

A = state(\(aqA\(aq).cmd.run(cwd=\(aq/var/tmp\(aq)
extend(A)

__pydsl__.set(ordered=True)

for i in range(10):
    i = str(i)
    state(i).cmd.run(\(aqecho \(aq+i, cwd=\(aq/\(aq)
state(\(aq1\(aq).cmd.run(\(aqecho one\(aq)
state(\(aq2\(aq).cmd.run(name=\(aqecho two\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Notice that the \fBordered\fP option needs to be set after any \fBextend\fP calls.
This is to prevent \fIpydsl\fP from tracking the creation of a state function that\(aqs
passed to an \fBextend\fP call.
.sp
Above example should create states from \fB0\fP to \fB9\fP that will output \fB0\fP,
\fBone\fP, \fBtwo\fP, \fB3\fP, ... \fB9\fP, in that order.
.sp
It\(aqs important to know that \fIpydsl\fP tracks the \fIcreations\fP of
\fI\%Function declaration\fP objects, and automatically adds a \fBrequire\fP requisite
to a \fI\%Function declaration\fP object that requires the last
\fI\%Function declaration\fP object created before it in the sls file.
.sp
This means later calls (perhaps to update the function\(aqs \fI\%Function arg declaration\fP) to a previously created function declaration will not change the
order.
.SS Render time state execution
.sp
When Salt processes a salt formula file, the file is rendered to salt\(aqs
high state data representation by a renderer before the states can be executed.
In the case of the \fIpydsl\fP renderer, the .sls file is executed as a python module
as it is being rendered which makes it easy to execute a state at render time.
In \fIpydsl\fP, executing one or more states at render time can be done by calling a
configured \fI\%ID declaration\fP object.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!pydsl

s = state() # save for later invocation

# configure it
s.cmd.run(\(aqecho at render time\(aq, cwd=\(aq/\(aq)
s.file.managed(\(aqtarget.txt\(aq, source=\(aqsalt://source.txt\(aq)

s() # execute the two states now
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once an \fI\%ID declaration\fP is called at render time it is detached from the
sls module as if it was never defined.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If \fIimplicit ordering\fP is enabled (i.e., via \fB__pydsl__.set(ordered=True)\fP) then
the \fIfirst\fP invocation of a \fI\%ID declaration\fP object must be done before a
new \fI\%Function declaration\fP is created.
.UNINDENT
.UNINDENT
.SS Integration with the stateconf renderer
.sp
The \fI\%salt.renderers.stateconf\fP renderer offers a few interesting features that
can be leveraged by the \fIpydsl\fP renderer. In particular, when using with the \fIpydsl\fP
renderer, we are interested in \fIstateconf\fP\(aqs sls namespacing feature (via dot\-prefixed
id declarations), as well as, the automatic \fIstart\fP and \fIgoal\fP states generation.
.sp
Now you can use \fIpydsl\fP with \fIstateconf\fP like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!pydsl|stateconf \-ps

include(\(aqxxx\(aq, \(aqyyy\(aq)

# ensure that states in xxx run BEFORE states in this file.
extend(state(\(aq.start\(aq).stateconf.require(stateconf=\(aqxxx::goal\(aq))

# ensure that states in yyy run AFTER states in this file.
extend(state(\(aq.goal\(aq).stateconf.require_in(stateconf=\(aqyyy::start\(aq))

__pydsl__.set(ordered=True)

\&...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP enables the generation of a stateconf \fIstart\fP state, and \fB\-p\fP lets us pipe
high state data rendered by \fIpydsl\fP to \fIstateconf\fP\&. This example shows that by
\fBrequire\fP\-ing or \fBrequire_in\fP\-ing the included sls\(aq \fIstart\fP or \fIgoal\fP states,
it\(aqs possible to ensure that the included sls files can be made to execute before
or after a state in the including sls file.
.SS Importing custom Python modules
.sp
To use a custom Python module inside a PyDSL state, place the module somewhere that
it can be loaded by the Salt loader, such as \fI_modules\fP in the \fI/srv/salt\fP directory.
.sp
Then, copy it to any minions as necessary by using \fIsaltutil.sync_modules\fP\&.
.sp
To import into a PyDSL SLS, one must bypass the Python importer and insert it manually
by getting a reference from Python\(aqs \fIsys.modules\fP dictionary.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!pydsl|stateconf \-ps

def main():
    my_mod = sys.modules[\(aqsalt.loaded.ext.module.my_mod\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.renderers.pydsl.PyDslError
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.renderers.pydsl.SaltRenderError(message, line_num=None, buf=\(aq\(aq, marker=\(aq    <======================\(aq, trace=None)
Used when a renderer needs to raise an explicit error. If a line number and
buffer string are passed, get_context will be invoked to get the location
of the error.
.UNINDENT
.INDENT 0.0
.TP
.B salt.renderers.pydsl.render(template, saltenv=\(aqbase\(aq, sls=\(aq\(aq, tmplpath=None, rendered_sls=None, **kws)
.UNINDENT
.SS salt.renderers.pyobjects
.sp
Python renderer that includes a Pythonic Object based interface
.INDENT 0.0
.TP
.B maintainer
Evan Borgstrom <\fI\%evan@borgstrom.ca\fP>
.UNINDENT
.sp
Let\(aqs take a look at how you use pyobjects in a state file. Here\(aqs a quick
example that ensures the \fB/tmp\fP directory is in the correct state.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
 #!pyobjects

 File.managed(\(dq/tmp\(dq, user=\(aqroot\(aq, group=\(aqroot\(aq, mode=\(aq1777\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Nice and Pythonic!
.sp
By using the \(dqshebang\(dq syntax to switch to the pyobjects renderer we can now
write our state data using an object based interface that should feel at home
to python developers. You can import any module and do anything that you\(aqd
like (with caution, importing sqlalchemy, django or other large frameworks has
not been tested yet). Using the pyobjects renderer is exactly the same as
using the built\-in Python renderer with the exception that pyobjects provides
you with an object based interface for generating state data.
.SS Creating state data
.sp
Pyobjects takes care of creating an object for each of the available states on
the minion. Each state is represented by an object that is the CamelCase
version of its name (i.e. \fBFile\fP, \fBService\fP, \fBUser\fP, etc), and these
objects expose all of their available state functions (i.e. \fBFile.managed\fP,
\fBService.running\fP, etc).
.sp
The name of the state is split based upon underscores (\fB_\fP), then each part
is capitalized and finally the parts are joined back together.
.sp
Some examples:
.INDENT 0.0
.IP \(bu 2
\fBpostgres_user\fP becomes \fBPostgresUser\fP
.IP \(bu 2
\fBssh_known_hosts\fP becomes \fBSshKnownHosts\fP
.UNINDENT
.SS Context Managers and requisites
.sp
How about something a little more complex. Here we\(aqre going to get into the
core of how to use pyobjects to write states.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
 #!pyobjects

 with Pkg.installed(\(dqnginx\(dq):
     Service.running(\(dqnginx\(dq, enable=True)

     with Service(\(dqnginx\(dq, \(dqwatch_in\(dq):
         File.managed(\(dq/etc/nginx/conf.d/mysite.conf\(dq,
                      owner=\(aqroot\(aq, group=\(aqroot\(aq, mode=\(aq0444\(aq,
                      source=\(aqsalt://nginx/mysite.conf\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The objects that are returned from each of the magic method calls are setup to
be used a Python context managers (\fBwith\fP) and when you use them as such all
declarations made within the scope will \fBautomatically\fP use the enclosing
state as a requisite!
.sp
The above could have also been written use direct requisite statements as.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
 #!pyobjects

 Pkg.installed(\(dqnginx\(dq)
 Service.running(\(dqnginx\(dq, enable=True, require=Pkg(\(dqnginx\(dq))
 File.managed(\(dq/etc/nginx/conf.d/mysite.conf\(dq,
              owner=\(aqroot\(aq, group=\(aqroot\(aq, mode=\(aq0444\(aq,
              source=\(aqsalt://nginx/mysite.conf\(aq,
              watch_in=Service(\(dqnginx\(dq))
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can use the direct requisite statement for referencing states that are
generated outside of the current file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
 #!pyobjects

 # some\-other\-package is defined in some other state file
 Pkg.installed(\(dqnginx\(dq, require=Pkg(\(dqsome\-other\-package\(dq))
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The last thing that direct requisites provide is the ability to select which
of the SaltStack requisites you want to use (require, require_in, watch,
watch_in, use & use_in) when using the requisite as a context manager.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
 #!pyobjects

 with Service(\(dqmy\-service\(dq, \(dqwatch_in\(dq):
     ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above example would cause all declarations inside the scope of the context
manager to automatically have their \fBwatch_in\fP set to
\fBService(\(dqmy\-service\(dq)\fP\&.
.SS Including and Extending
.sp
To include other states use the \fBinclude()\fP function. It takes one name per
state to include.
.sp
To extend another state use the \fBextend()\fP function on the name when creating
a state.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
 #!pyobjects

 include(\(aqhttp\(aq, \(aqssh\(aq)

 Service.running(extend(\(aqapache\(aq),
                 watch=[File(\(aq/etc/httpd/extra/httpd\-vhosts.conf\(aq)])
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Importing from other state files
.sp
Like any Python project that grows you will likely reach a point where you want
to create reusability in your state tree and share objects between state files,
Map Data (described below) is a perfect example of this.
.sp
To facilitate this Python\(aqs \fBimport\fP statement has been augmented to allow
for a special case when working with a Salt state tree. If you specify a Salt
url (\fBsalt://...\fP) as the target for importing from then the pyobjects
renderer will take care of fetching the file for you, parsing it with all of
the pyobjects features available and then place the requested objects in the
global scope of the template being rendered.
.sp
This works for all types of import statements; \fBimport X\fP,
\fBfrom X import Y\fP, and \fBfrom X import Y as Z\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
 #!pyobjects

 import salt://myfile.sls
 from salt://something/data.sls import Object
 from salt://something/data.sls import Object as Other
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See the Map Data section for a more practical use.
.sp
Caveats:
.INDENT 0.0
.IP \(bu 2
Imported objects are ALWAYS put into the global scope of your template,
regardless of where your import statement is.
.UNINDENT
.SS Salt object
.sp
In the spirit of the object interface for creating state data pyobjects also
provides a simple object interface to the \fB__salt__\fP object.
.sp
A function named \fBsalt\fP exists in scope for your sls files and will dispatch
its attributes to the \fB__salt__\fP dictionary.
.sp
The following lines are functionally equivalent:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
 #!pyobjects

 ret = salt.cmd.run(bar)
 ret = __salt__[\(aqcmd.run\(aq](bar)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Pillar, grain, mine & config data
.sp
Pyobjects provides shortcut functions for calling \fBpillar.get\fP,
\fBgrains.get\fP, \fBmine.get\fP & \fBconfig.get\fP on the \fB__salt__\fP object. This
helps maintain the readability of your state files.
.sp
Each type of data can be access by a function of the same name: \fBpillar()\fP,
\fBgrains()\fP, \fBmine()\fP and \fBconfig()\fP\&.
.sp
The following pairs of lines are functionally equivalent:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
 #!pyobjects

 value = pillar(\(aqfoo:bar:baz\(aq, \(aqqux\(aq)
 value = __salt__[\(aqpillar.get\(aq](\(aqfoo:bar:baz\(aq, \(aqqux\(aq)

 value = grains(\(aqpkg:apache\(aq)
 value = __salt__[\(aqgrains.get\(aq](\(aqpkg:apache\(aq)

 value = mine(\(aqos:Fedora\(aq, \(aqnetwork.interfaces\(aq, \(aqgrain\(aq)
 value = __salt__[\(aqmine.get\(aq](\(aqos:Fedora\(aq, \(aqnetwork.interfaces\(aq, \(aqgrain\(aq)

 value = config(\(aqfoo:bar:baz\(aq, \(aqqux\(aq)
 value = __salt__[\(aqconfig.get\(aq](\(aqfoo:bar:baz\(aq, \(aqqux\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Opts dictionary and SLS name
.sp
Pyobjects provides variable access to the minion options dictionary and the SLS
name that the code resides in. These variables are the same as the \fIopts\fP and
\fIsls\fP variables available in the Jinja renderer.
.sp
The following lines show how to access that information.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
 #!pyobjects

 test_mode = __opts__[\(dqtest\(dq]
 sls_name = __sls__
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Map Data
.sp
When building complex states or formulas you often need a way of building up a
map of data based on grain data. The most common use of this is tracking the
package and service name differences between distributions.
.sp
To build map data using pyobjects we provide a class named Map that you use to
build your own classes with inner classes for each set of values for the
different grain matches.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
 #!pyobjects

 class Samba(Map):
     merge = \(aqsamba:lookup\(aq
     # NOTE: priority is new to 2017.7.0
     priority = (\(aqos_family\(aq, \(aqos\(aq)

     class Ubuntu:
         __grain__ = \(aqos\(aq
         service = \(aqsmbd\(aq

     class Debian:
         server = \(aqsamba\(aq
         client = \(aqsamba\-client\(aq
         service = \(aqsamba\(aq

     class RHEL:
         __match__ = \(aqRedHat\(aq
         server = \(aqsamba\(aq
         client = \(aqsamba\(aq
         service = \(aqsmb\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
By default, the \fBos_family\fP grain will be used as the target for
matching. This can be overridden by specifying a \fB__grain__\fP attribute.
.sp
If a \fB__match__\fP attribute is defined for a given class, then that value
will be matched against the targeted grain, otherwise the class name\(aqs
value will be be matched.
.sp
Given the above example, the following is true:
.INDENT 0.0
.IP 1. 3
Minions with an \fBos_family\fP of \fBDebian\fP will be assigned the
attributes defined in the \fBDebian\fP class.
.IP 2. 3
Minions with an \fBos\fP grain of \fBUbuntu\fP will be assigned the
attributes defined in the \fBUbuntu\fP class.
.IP 3. 3
Minions with an \fBos_family\fP grain of \fBRedHat\fP will be assigned the
attributes defined in the \fBRHEL\fP class.
.UNINDENT
.sp
That said, sometimes a minion may match more than one class. For instance,
in the above example, Ubuntu minions will match both the \fBDebian\fP and
\fBUbuntu\fP classes, since Ubuntu has an \fBos_family\fP grain of \fBDebian\fP
and an \fBos\fP grain of \fBUbuntu\fP\&. As of the 2017.7.0 release, the order is
dictated by the order of declaration, with classes defined later overriding
earlier ones. Additionally, 2017.7.0 adds support for explicitly defining
the ordering using an optional attribute called \fBpriority\fP\&.
.sp
Given the above example, \fBos_family\fP matches will be processed first,
with \fBos\fP matches processed after. This would have the effect of
assigning \fBsmbd\fP as the \fBservice\fP attribute on Ubuntu minions. If the
\fBpriority\fP item was not defined, or if the order of the items in the
\fBpriority\fP tuple were reversed, Ubuntu minions would have a \fBservice\fP
attribute of \fBsamba\fP, since \fBos_family\fP matches would have been
processed second.
.UNINDENT
.UNINDENT
.sp
To use this new data you can import it into your state file and then access
your attributes. To access the data in the map you simply access the attribute
name on the base class that is extending Map. Assuming the above Map was in the
file \fBsamba/map.sls\fP, you could do the following.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
 #!pyobjects

 from salt://samba/map.sls import Samba

 with Pkg.installed(\(dqsamba\(dq, names=[Samba.server, Samba.client]):
     Service.running(\(dqsamba\(dq, name=Samba.service)
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.renderers.pyobjects.PyobjectsModule(name, attrs)
This provides a wrapper for bare imports.
.UNINDENT
.INDENT 0.0
.TP
.B salt.renderers.pyobjects.load_states()
This loads our states into the salt __context__
.UNINDENT
.INDENT 0.0
.TP
.B salt.renderers.pyobjects.render(template, saltenv=\(aqbase\(aq, sls=\(aq\(aq, salt_data=True, **kwargs)
.UNINDENT
.SS salt.renderers.stateconf
.INDENT 0.0
.TP
.B maintainer
Jack Kuan <\fI\%kjkuan@gmail.com\fP>
.TP
.B maturity
new
.TP
.B platform
all
.UNINDENT
.sp
This module provides a custom renderer that processes a salt file with a
specified templating engine (e.g. Jinja) and a chosen data renderer (e.g. YAML),
extracts arguments for any \fBstateconf.set\fP state, and provides the extracted
arguments (including Salt\-specific args, such as \fBrequire\fP, etc) as template
context. The goal is to make writing reusable/configurable/parameterized
salt files easier and cleaner.
.sp
To use this renderer, either set it as the default renderer via the
\fBrenderer\fP option in master/minion\(aqs config, or use the shebang line in each
individual sls file, like so: \fB#!stateconf\fP\&. Note, due to the way this
renderer works, it must be specified as the first renderer in a render
pipeline. That is, you cannot specify \fB#!mako|yaml|stateconf\fP, for example.
Instead, you specify them as renderer arguments: \fB#!stateconf mako . yaml\fP\&.
.sp
Here\(aqs a list of features enabled by this renderer.
.INDENT 0.0
.IP \(bu 2
Prefixes any state id (declaration or reference) that starts with a dot (\fB\&.\fP)
to avoid duplicated state ids when the salt file is included by other salt
files.
.sp
For example, in the \fIsalt://some/file.sls\fP, a state id such as \fB\&.sls_params\fP
will be turned into \fBsome.file::sls_params\fP\&. Example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
#!stateconf yaml . jinja

\&.vim:
  pkg.installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Above will be translated into:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
some.file::vim:
  pkg.installed:
    \- name: vim
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Notice how that if a state under a dot\-prefixed state id has no \fBname\fP
argument then one will be added automatically by using the state id with
the leading dot stripped off.
.sp
The leading dot trick can be used with extending state ids as well,
so you can include relatively and extend relatively. For example, when
extending a state in \fIsalt://some/other_file.sls\fP, e.g.:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
#!stateconf yaml . jinja

include:
  \- .file

extend:
  .file::sls_params:
    stateconf.set:
      \- name1: something
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Above will be pre\-processed into:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- some.file

extend:
  some.file::sls_params:
    stateconf.set:
      \- name1: something
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
Adds a \fBsls_dir\fP context variable that expands to the directory containing
the rendering salt file. So, you can write \fBsalt://{{sls_dir}}/...\fP to
reference templates files used by your salt file.
.IP \(bu 2
Recognizes the special state function, \fBstateconf.set\fP, that configures a
default list of named arguments usable within the template context of
the salt file. Example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
#!stateconf yaml . jinja

\&.sls_params:
  stateconf.set:
    \- name1: value1
    \- name2: value2
    \- name3:
      \- value1
      \- value2
      \- value3
    \- require_in:
      \- cmd: output

# \-\-\- end of state config \-\-\-

\&.output:
  cmd.run:
    \- name: |
        echo \(aqname1={{sls_params.name1}}
              name2={{sls_params.name2}}
              name3[1]={{sls_params.name3[1]}}
        \(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This even works with \fBinclude\fP + \fBextend\fP so that you can override
the default configured arguments by including the salt file and then
\fBextend\fP the \fBstateconf.set\fP states that come from the included salt
file. (\fIIMPORTANT: Both the included and the extending sls files must use the
stateconf renderer for this \(ga\(gaextend\(ga\(ga to work!\fP)
.sp
Notice that the end of configuration marker (\fB# \-\-\- end of state config \-\-\fP)
is needed to separate the use of \(aqstateconf.set\(aq form the rest of your salt
file. The regex that matches such marker can be configured via the
\fBstateconf_end_marker\fP option in your master or minion config file.
.sp
Sometimes, it is desirable to set a default argument value that\(aqs based on
earlier arguments in the same \fBstateconf.set\fP\&. For example, it may be
tempting to do something like this:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
#!stateconf yaml . jinja

\&.apache:
  stateconf.set:
    \- host: localhost
    \- port: 1234
    \- url: \(aqhttp://{{host}}:{{port}}/\(aq

# \-\-\- end of state config \-\-\-

\&.test:
  cmd.run:
    \- name: echo \(aq{{apache.url}}\(aq
    \- cwd: /
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, this won\(aqt work. It can however be worked around like so:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
#!stateconf yaml . jinja

\&.apache:
  stateconf.set:
    \- host: localhost
    \- port: 1234
{#  \- url: \(aqhttp://{{host}}:{{port}}/\(aq #}

# \-\-\- end of state config \-\-\-
# {{ apache.setdefault(\(aqurl\(aq, \(dqhttp://%(host)s:%(port)s/\(dq % apache) }}

\&.test:
  cmd.run:
    \- name: echo \(aq{{apache.url}}\(aq
    \- cwd: /
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
Adds support for relative include and exclude of .sls files. Example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
#!stateconf yaml . jinja

include:
  \- .apache
  \- .db.mysql
  \- ..app.django

exclude:
  \- sls: .users
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the above is written in a salt file at \fIsalt://some/where.sls\fP then
it will include \fIsalt://some/apache.sls\fP, \fIsalt://some/db/mysql.sls\fP and
\fIsalt://app/django.sls\fP, and exclude \fIsalt://some/users.ssl\fP\&. Actually,
it does that by rewriting the above \fBinclude\fP and \fBexclude\fP into:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- some.apache
  \- some.db.mysql
  \- app.django

exclude:
  \- sls: some.users
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
Optionally (enabled by default, \fIdisable\fP via the \fI\-G\fP renderer option,
e.g. in the shebang line: \fB#!stateconf \-G\fP), generates a
\fBstateconf.set\fP goal state (state id named as \fB\&.goal\fP by default,
configurable via the master/minion config option, \fBstateconf_goal_state\fP)
that requires all other states in the salt file. Note, the \fB\&.goal\fP
state id is subject to dot\-prefix rename rule mentioned earlier.
.sp
Such goal state is intended to be required by some state in an including
salt file. For example, in your webapp salt file, if you include a
sls file that is supposed to setup Tomcat, you might want to make sure that
all states in the Tomcat sls file will be executed before some state in
the webapp sls file.
.IP \(bu 2
Optionally (enable via the \fI\-o\fP renderer option, e.g. in the shebang line:
\fB#!stateconf \-o\fP), orders the states in a sls file by adding a
\fBrequire\fP requisite to each state such that every state requires the
state defined just before it. The order of the states here is the order
they are defined in the sls file. (Note: this feature is only available
if your minions are using Python >= 2.7. For Python2.6, it should also
work if you install the \fIordereddict\fP module from PyPI)
.sp
By enabling this feature, you are basically agreeing to author your sls
files in a way that gives up the explicit (or implicit?) ordering imposed
by the use of \fBrequire\fP, \fBwatch\fP, \fBrequire_in\fP or \fBwatch_in\fP
requisites, and instead, you rely on the order of states you define in
the sls files. This may or may not be a better way for you. However, if
there are many states defined in a sls file, then it tends to be easier
to see the order they will be executed with this feature.
.sp
You are still allowed to use all the requisites, with a few restrictions.
You cannot \fBrequire\fP or \fBwatch\fP a state defined \fIafter\fP the current
state. Similarly, in a state, you cannot \fBrequire_in\fP or \fBwatch_in\fP
a state defined \fIbefore\fP it. Breaking any of the two restrictions above
will result in a state loop. The renderer will check for such incorrect
uses if this feature is enabled.
.sp
Additionally, \fBnames\fP declarations cannot be used with this feature
because the way they are compiled into low states make it impossible to
guarantee the order in which they will be executed. This is also checked
by the renderer. As a workaround for not being able to use \fBnames\fP,
you can achieve the same effect, by generate your states with the
template engine available within your sls file.
.sp
Finally, with the use of this feature, it becomes possible to easily make
an included sls file execute all its states \fIafter\fP some state (say, with
id \fBX\fP) in the including sls file.  All you have to do is to make state,
\fBX\fP, \fBrequire_in\fP the first state defined in the included sls file.
.UNINDENT
.sp
When writing sls files with this renderer, one should avoid using what can be
defined in a \fBname\fP argument of a state as the state\(aqs id. That is, avoid
writing states like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/path/to/some/file:
  file.managed:
    \- source: salt://some/file

cp /path/to/some/file file2:
  cmd.run:
    \- cwd: /
    \- require:
      \- file: /path/to/some/file
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Instead, define the state id and the \fBname\fP argument separately for each
state. Also, the ID should be something meaningful and easy to reference within
a requisite (which is a good habit anyway, and such extra indirection would
also makes the sls file easier to modify later). Thus, the above states should
be written like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
add\-some\-file:
  file.managed:
    \- name: /path/to/some/file
    \- source: salt://some/file

copy\-files:
  cmd.run:
    \- name: cp /path/to/some/file file2
    \- cwd: /
    \- require:
      \- file: add\-some\-file
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Moreover, when referencing a state from a requisite, you should reference the
state\(aqs id plus the state name rather than the state name plus its \fBname\fP
argument. (Yes, in the above example, you can actually \fBrequire\fP the
\fBfile: /path/to/some/file\fP, instead of the \fBfile: add\-some\-file\fP). The
reason is that this renderer will re\-write or rename state id\(aqs and their
references for state id\(aqs prefixed with \fB\&.\fP\&. So, if you reference \fBname\fP
then there\(aqs no way to reliably rewrite such reference.
.SS salt.renderers.toml
.INDENT 0.0
.TP
.B salt.renderers.tomlmod.render(sls_data, saltenv=\(aqbase\(aq, sls=\(aq\(aq, **kws)
Accepts TOML as a string or as a file object and runs it through the
parser.
.INDENT 7.0
.TP
.B Return type
A Python data structure
.UNINDENT
.UNINDENT
.SS salt.renderers.wempy
.INDENT 0.0
.TP
.B salt.renderers.wempy.render(template_file, saltenv=\(aqbase\(aq, sls=\(aq\(aq, argline=\(aq\(aq, context=None, **kws)
Render the data passing the functions and grains into the rendering system
.INDENT 7.0
.TP
.B Return type
string
.UNINDENT
.UNINDENT
.SS salt.renderers.yaml
.SS Understanding YAML
.sp
The default renderer for SLS files is the YAML renderer. YAML is a
markup language with many powerful features. However, Salt uses
a small subset of YAML that maps over very commonly used data structures,
like lists and dictionaries. It is the job of the YAML renderer to take
the YAML data structure and compile it into a Python data structure for
use by Salt.
.sp
Though YAML syntax may seem daunting and terse at first, there are only
three very simple rules to remember when writing YAML for SLS files.
.SS Rule One: Indentation
.sp
YAML uses a fixed indentation scheme to represent relationships between
data layers. Salt requires that the indentation for each level consists
of exactly two spaces. Do not use tabs.
.SS Rule Two: Colons
.sp
Python dictionaries are, of course, simply key\-value pairs. Users from other
languages may recognize this data type as hashes or associative arrays.
.sp
Dictionary keys are represented in YAML as strings terminated by a trailing colon.
Values are represented by either a string following the colon, separated by a space:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_key: my_value
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In Python, the above maps to:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqmy_key\(dq: \(dqmy_value\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Dictionaries can be nested:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
first_level_dict_key:
  second_level_dict_key: value_in_second_level_dict
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And in Python:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqfirst_level_dict_key\(dq: {\(dqsecond_level_dict_key\(dq: \(dqvalue_in_second_level_dict\(dq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Rule Three: Dashes
.sp
To represent lists of items, a single dash followed by a space is used. Multiple
items are a part of the same list as a function of their having the same level of indentation.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- list_value_one
\- list_value_two
\- list_value_three
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Lists can be the value of a key\-value pair. This is quite common in Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_dictionary:
  \- list_value_one
  \- list_value_two
  \- list_value_three
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Reference
.sp
YAML Renderer for Salt
.sp
For YAML usage information see \fI\%Understanding YAML\fP\&.
.INDENT 0.0
.TP
.B salt.renderers.yaml.get_yaml_loader(argline)
Return the ordered dict yaml loader
.UNINDENT
.INDENT 0.0
.TP
.B salt.renderers.yaml.render(yaml_data, saltenv=\(aqbase\(aq, sls=\(aq\(aq, argline=\(aq\(aq, **kws)
Accepts YAML as a string or as a file object and runs it through the YAML
parser.
.INDENT 7.0
.TP
.B Return type
A Python data structure
.UNINDENT
.UNINDENT
.SS salt.renderers.yamlex
.sp
YAMLEX renderer is a replacement of the YAML renderer.
It\(aqs 100% YAML with a pinch of Salt magic:
.INDENT 0.0
.IP \(bu 2
All mappings are automatically OrderedDict
.IP \(bu 2
All strings are automatically str obj
.IP \(bu 2
data aggregation with !aggregation yaml tag, based on the \fBsalt.utils.aggregation\fP module.
.IP \(bu 2
data aggregation over documents for pillar
.UNINDENT
.sp
Instructed aggregation within the \fB!aggregation\fP and the \fB!reset\fP tags:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!yamlex
foo: !aggregate first
foo: !aggregate second
bar: !aggregate {first: foo}
bar: !aggregate {second: bar}
baz: !aggregate 42
qux: !aggregate default
!reset qux: !aggregate my custom data
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
is roughly equivalent to
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo: [first, second]
bar: {first: foo, second: bar}
baz: [42]
qux: [my custom data]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Reference
.INDENT 0.0
.TP
.B salt.renderers.yamlex.render(sls_data, saltenv=\(aqbase\(aq, sls=\(aq\(aq, **kws)
Accepts YAML_EX as a string or as a file object and runs it through the YAML_EX
parser.
.INDENT 7.0
.TP
.B Return type
A Python data structure
.UNINDENT
.UNINDENT
.SH USING SALT
.sp
This section describes the fundamental components and concepts that you need to understand to use Salt.
.SS Grains
.sp
Salt comes with an interface to derive information about the underlying system.
This is called the grains interface, because it presents salt with grains of
information. Grains are collected for the operating system, domain name,
IP address, kernel, OS type, memory, and many other system properties.
.sp
The grains interface is made available to Salt modules and components so that
the right salt minion commands are automatically available on the right
systems.
.sp
Grain data is relatively static, though if system information changes
(for example, if network settings are changed), or if a new value is assigned
to a custom grain, grain data is refreshed.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Grains resolve to lowercase letters. For example, \fBFOO\fP, and \fBfoo\fP
target the same grain.
.UNINDENT
.UNINDENT
.SS Listing Grains
.sp
Available grains can be listed by using the \(aqgrains.ls\(aq module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.ls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Grains data can be listed by using the \(aqgrains.items\(aq module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.items
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Using grains in a state
.sp
To use a grain in a state you can access it via \fI{{ grains[\(aqkey\(aq] }}\fP\&.
.SS Grains in the Minion Config
.sp
Grains can also be statically assigned within the minion configuration file.
Just add the option \fI\%grains\fP and pass options to it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grains:
  roles:
    \- webserver
    \- memcache
  deployment: datacenter4
  cabinet: 13
  cab_u: 14\-15
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then status data specific to your servers can be retrieved via Salt, or used
inside of the State system for matching. It also makes it possible to target based on specific data about your deployment, as in the example above.
.SS Grains in /etc/salt/grains
.sp
If you do not want to place your custom static grains in the minion config
file, you can also put them in \fB/etc/salt/grains\fP on the minion. They are configured in the
same way as in the above example, only without a top\-level \fBgrains:\fP key:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
roles:
  \- webserver
  \- memcache
deployment: datacenter4
cabinet: 13
cab_u: 14\-15
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Grains in \fB/etc/salt/grains\fP are ignored if you specify the same grains in the minion config.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Grains are static, and since they are not often changed, they will need a grains refresh when they are updated. You can do this by calling: \fBsalt minion saltutil.refresh_modules\fP
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
You can equally configure static grains for Proxy Minions.
As multiple Proxy Minion processes can run on the same machine, you need
to index the files using the Minion ID, under \fB/etc/salt/proxy.d/<minion ID>/grains\fP\&.
For example, the grains for the Proxy Minion \fBrouter1\fP can be defined
under \fB/etc/salt/proxy.d/router1/grains\fP, while the grains for the
Proxy Minion \fBswitch7\fP can be put in \fB/etc/salt/proxy.d/switch7/grains\fP\&.
.UNINDENT
.UNINDENT
.SS Matching Grains in the Top File
.sp
With correctly configured grains on the Minion, the \fI\%top file\fP used in
Pillar or during Highstate can be made very efficient. For example, consider
the following configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(aqroles:webserver\(aq:
  \- match: grain
  \- state0

\(aqroles:memcache\(aq:
  \- match: grain
  \- state1
  \- state2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For this example to work, you would need to have defined the grain
\fBrole\fP for the minions you wish to match.
.SS Writing Grains
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Grains can be set by users that have access to the minion configuration files on
the local system, making them less secure than other identifiers in Salt. Avoid
storing sensitive data, such as passwords or keys, on minions. Instead, make
use of \fI\%Storing Static Data in the Pillar\fP and/or \fI\%Storing Data in Other Databases\fP\&.
.UNINDENT
.UNINDENT
.sp
The grains are derived by executing all of the \(dqpublic\(dq functions (i.e. those
which do not begin with an underscore) found in the modules located in the
Salt\(aqs core grains code, followed by those in any custom grains modules. The
functions in a grains module must return a \fI\%Python dictionary\fP, where the dictionary keys are the names of grains, and
each key\(aqs value is that value for that grain.
.sp
Custom grains modules should be placed in a subdirectory named \fB_grains\fP
located under the \fI\%file_roots\fP specified by the master config
file. The default path would be \fB/srv/salt/_grains\fP\&. Custom grains modules
will be distributed to the minions when \fI\%state.highstate\fP is run, or by executing the
\fI\%saltutil.sync_grains\fP or
\fI\%saltutil.sync_all\fP functions.
.sp
Grains modules are easy to write, and (as noted above) only need to return a
dictionary. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def yourfunction():
    # initialize a grains dictionary
    grains = {}
    # Some code for logic that sets grains like
    grains[\(dqyourcustomgrain\(dq] = True
    grains[\(dqanothergrain\(dq] = \(dqsomevalue\(dq
    return grains
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The name of the function does not matter and will not factor into the grains
data at all; only the keys/values returned become part of the grains.
.SS When to Use a Custom Grain
.sp
Before adding new grains, consider what the data is and remember that grains
should (for the most part) be static data.
.sp
If the data is something that is likely to change, consider using \fI\%Pillar\fP or an execution module instead. If it\(aqs a simple set of
key/value pairs, pillar is a good match. If compiling the information requires
that system commands be run, then putting this information in an execution
module is likely a better idea.
.sp
Good candidates for grains are data that is useful for targeting minions in the
\fI\%top file\fP or the Salt CLI. The name and data structure of
the grain should be designed to support many platforms, operating systems or
applications. Also, keep in mind that Jinja templating in Salt supports
referencing pillar data as well as invoking functions from execution modules,
so there\(aqs no need to place information in grains to make it available to Jinja
templates. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\&...
\&...
{{ salt[\(aqmodule.function_name\(aq](\(aqargument_1\(aq, \(aqargument_2\(aq) }}
{{ pillar[\(aqmy_pillar_key\(aq] }}
\&...
\&...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Custom grains will not be available in the top file until after the first
\fI\%highstate\fP\&. To make custom grains available on a
minion\(aqs first highstate, it is recommended to use \fI\%this example\fP to ensure that the custom grains are synced when
the minion starts.
.UNINDENT
.UNINDENT
.SS Loading Custom Grains
.sp
If you have multiple functions specifying grains that are called from a \fBmain\fP
function, be sure to prepend grain function names with an underscore. This prevents
Salt from including the loaded grains from the grain functions in the final
grain data structure. For example, consider this custom grain file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!/usr/bin/env python
def _my_custom_grain():
    my_grain = {\(dqfoo\(dq: \(dqbar\(dq, \(dqhello\(dq: \(dqworld\(dq}
    return my_grain


def main():
    # initialize a grains dictionary
    grains = {}
    grains[\(dqmy_grains\(dq] = _my_custom_grain()
    return grains
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The output of this example renders like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call \-\-local grains.items
local:
    \-\-\-\-\-\-\-\-\-\-
    <Snipped for brevity>
    my_grains:
        \-\-\-\-\-\-\-\-\-\-
        foo:
            bar
        hello:
            world
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, if you don\(aqt prepend the \fBmy_custom_grain\fP function with an underscore,
the function will be rendered twice by Salt in the items output: once for the
\fBmy_custom_grain\fP call itself, and again when it is called in the \fBmain\fP
function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call \-\-local grains.items
local:
\-\-\-\-\-\-\-\-\-\-
    <Snipped for brevity>
    foo:
        bar
    <Snipped for brevity>
    hello:
        world
    <Snipped for brevity>
    my_grains:
        \-\-\-\-\-\-\-\-\-\-
        foo:
            bar
        hello:
            world
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Precedence
.sp
Core grains can be overridden by custom grains. As there are several ways of
defining custom grains, there is an order of precedence which should be kept in
mind when defining them. The order of evaluation is as follows:
.INDENT 0.0
.IP 1. 3
Core grains.
.IP 2. 3
Custom grains in \fB/etc/salt/grains\fP\&.
.IP 3. 3
Custom grains in \fB/etc/salt/minion\fP\&.
.IP 4. 3
Custom grain modules in \fB_grains\fP directory, synced to minions.
.UNINDENT
.sp
Each successive evaluation overrides the previous ones, so any grains defined
by custom grains modules synced to minions that have the same name as a core
grain will override that core grain. Similarly, grains from
\fB/etc/salt/minion\fP override both core grains and custom grain modules, and
grains in \fB_grains\fP will override \fIany\fP grains of the same name.
.sp
For custom grains, if the function takes an argument \fBgrains\fP, then the
previously rendered grains will be passed in.  Because the rest of the grains
could be rendered in any order, the only grains that can be relied upon to be
passed in are \fBcore\fP grains. This was added in the 2019.2.0 release.
.SS Examples of Grains
.sp
The core module in the grains package is where the main grains are loaded by
the Salt minion and provides the principal example of how to write grains:
.sp
\fI\%salt/grains/core.py\fP
.SS Syncing Grains
.sp
Syncing grains can be done a number of ways. They are automatically synced when
\fI\%state.highstate\fP is called, or (as noted
above) the grains can be manually synced and reloaded by calling the
\fI\%saltutil.sync_grains\fP or
\fI\%saltutil.sync_all\fP functions.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When the \fI\%grains_cache\fP is set to False, the grains dictionary is built
and stored in memory on the minion. Every time the minion restarts or
\fBsaltutil.refresh_grains\fP is run, the grain dictionary is rebuilt from scratch.
.UNINDENT
.UNINDENT
.SS Storing Static Data in the Pillar
.sp
Pillar is an interface for Salt designed to offer global values that can be
distributed to minions. Pillar data is managed in a similar way as
the Salt State Tree.
.sp
Pillar was added to Salt in version 0.9.8
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Storing sensitive data
.sp
Pillar data is compiled on the master. Additionally, pillar data for a
given minion is only accessible by the minion for which it is targeted in
the pillar configuration. This makes pillar useful for storing sensitive
data specific to a particular minion.
.UNINDENT
.UNINDENT
.SS Declaring the Master Pillar
.sp
The Salt Master server maintains a \fI\%pillar_roots\fP setup that
matches the structure of the \fI\%file_roots\fP used in the Salt file
server. Like \fI\%file_roots\fP, the \fI\%pillar_roots\fP option
maps environments to directories. The pillar data is then mapped to minions
based on matchers in a top file which is laid out in the same way as the state
top file. Salt pillars can use the same matcher types as the standard \fI\%top
file\fP\&.
.sp
conf_master:\fIpillar_roots\fP is configured just like \fI\%file_roots\fP\&.
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_roots:
  base:
    \- /srv/pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example configuration declares that the base environment will be located
in the \fB/srv/pillar\fP directory. It must not be in a subdirectory of the
state tree.
.sp
The top file used matches the name of the top file used for States,
and has the same structure:
.sp
\fB/srv/pillar/top.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- packages
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above top file, it is declared that in the \fBbase\fP environment, the
glob matching all minions will have the pillar data found in the \fBpackages\fP
pillar available to it. Assuming the \fBpillar_roots\fP value of \fB/srv/pillar\fP
taken from above, the \fBpackages\fP pillar would be located at
\fB/srv/pillar/packages.sls\fP\&.
.sp
Any number of matchers can be added to the base environment. For example, here
is an expanded version of the Pillar top file stated above:
.sp
/srv/pillar/top.sls:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- packages
  \(aqweb*\(aq:
    \- vim
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this expanded top file, minions that match \fBweb*\fP will have access to the
\fB/srv/pillar/packages.sls\fP file, as well as the \fB/srv/pillar/vim.sls\fP file.
.sp
Another example shows how to use other standard top matching types
to deliver specific salt pillar data to minions with different properties.
.sp
Here is an example using the \fBgrains\fP matcher to target pillars to minions
by their \fBos\fP grain:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
dev:
  \(aqos:Debian\(aq:
    \- match: grain
    \- servers
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pillar definitions can also take a keyword argument \fBignore_missing\fP\&.
When the value of \fBignore_missing\fP is \fBTrue\fP, all errors for missing
pillar files are ignored. The default value for \fBignore_missing\fP is
\fBFalse\fP\&.
.sp
Here is an example using the \fBignore_missing\fP keyword parameter to ignore
errors for missing pillar files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- servers
    \- systems
    \- ignore_missing: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Assuming that the pillar \fBservers\fP exists in the fileserver backend
and the pillar \fBsystems\fP doesn\(aqt, all pillar data from \fBservers\fP
pillar is delivered to minions and no error for the missing pillar
\fBsystems\fP is noted under the key \fB_errors\fP in the pillar data
delivered to minions.
.sp
Should the \fBignore_missing\fP keyword parameter have the value \fBFalse\fP,
an error for the missing pillar \fBsystems\fP would produce the value
\fBSpecified SLS \(aqservers\(aq in environment \(aqbase\(aq is not available on the salt master\fP
under the key \fB_errors\fP in the pillar data delivered to minions.
.sp
\fB/srv/pillar/packages.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% if grains[\(aqos\(aq] == \(aqRedHat\(aq %}
apache: httpd
git: git
{% elif grains[\(aqos\(aq] == \(aqDebian\(aq %}
apache: apache2
git: git\-core
{% endif %}

company: Foo Industries
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
See \fI\%Is Targeting using Grain Data Secure?\fP for
important security information.
.UNINDENT
.UNINDENT
.sp
The above pillar sets two key/value pairs. If a minion is running RedHat, then
the \fBapache\fP key is set to \fBhttpd\fP and the \fBgit\fP key is set to the value
of \fBgit\fP\&. If the minion is running Debian, those values are changed to
\fBapache2\fP and \fBgit\-core\fP respectively. All minions that have this pillar
targeting to them via a top file will have the key of \fBcompany\fP with a value
of \fBFoo Industries\fP\&.
.sp
Consequently this data can be used from within modules, renderers, State SLS
files, and more via the shared pillar dictionary:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  pkg.installed:
    \- name: {{ pillar[\(aqapache\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git:
  pkg.installed:
    \- name: {{ pillar[\(aqgit\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Finally, the above states can utilize the values provided to them via Pillar.
All pillar values targeted to a minion are available via the \(aqpillar\(aq
dictionary. As seen in the above example, Jinja substitution can then be
utilized to access the keys and values in the Pillar dictionary.
.sp
Note that you cannot just list key/value\-information in \fBtop.sls\fP\&. Instead,
target a minion to a pillar file and then list the keys and values in the
pillar. Here is an example top file that illustrates this point:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
     \- common_pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And the actual pillar file at \(aq/srv/pillar/common_pillar.sls\(aq:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo: bar
boo: baz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When working with multiple pillar environments, assuming that each pillar
environment has its own top file, the jinja placeholder \fB{{ saltenv }}\fP
can be used in place of the environment name:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ saltenv }}:
  \(aq*\(aq:
     \- common_pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Yes, this is \fB{{ saltenv }}\fP, and not \fB{{ pillarenv }}\fP\&. The reason for
this is because the Pillar top files are parsed using some of the same code
which parses top files when \fI\%running states\fP, so
the pillar environment takes the place of \fB{{ saltenv }}\fP in the jinja
context.
.UNINDENT
.UNINDENT
.SS Dynamic Pillar Environments
.sp
If environment \fB__env__\fP is specified in \fI\%pillar_roots\fP, all
environments that are not explicitly specified in \fI\%pillar_roots\fP
will map to the directories from \fB__env__\fP\&. This allows one to use dynamic
git branch based environments for state/pillar files with the same file\-based
pillar applying to all environments. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_roots:
  __env__:
    \- /srv/pillar

ext_pillar:
  \- git:
    \- __env__ https://example.com/git\-pillar.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.5,2018.3.1.

.sp
Taking it one step further, \fB__env__\fP can also be used in the \fBpillar_root\fP
filesystem path. It will be replaced with the actual \fBpillarenv\fP and searched
for Pillar data to provide to the minion. Note this substitution ONLY occurs for
the \fB__env__\fP environment. For instance, this configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_roots:
  __env__:
    \- /srv/__env__/pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
is equivalent to this static configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_roots:
  dev:
    \- /srv/dev/pillar
  test:
    \- /srv/test/pillar
  prod:
    \- /srv/prod/pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3005.

.SS Pillar Namespace Flattening
.sp
The separate pillar SLS files all merge down into a single dictionary of
key\-value pairs. When the same key is defined in multiple SLS files, this can
result in unexpected behavior if care is not taken to how the pillar SLS files
are laid out.
.sp
For example, given a \fBtop.sls\fP containing the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- packages
    \- services
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
with \fBpackages.sls\fP containing:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
bind: bind9
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
and \fBservices.sls\fP containing:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
bind: named
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then a request for the \fBbind\fP pillar key will only return \fBnamed\fP\&. The
\fBbind9\fP value will be lost, because \fBservices.sls\fP was evaluated later.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Pillar files are applied in the order they are listed in the top file.
Therefore conflicting keys will be overwritten in a \(aqlast one wins\(aq manner!
For example, in the above scenario conflicting key values in \fBservices\fP
will overwrite those in \fBpackages\fP because it\(aqs at the bottom of the list.
.UNINDENT
.UNINDENT
.sp
It can be better to structure your pillar files with more hierarchy. For
example the \fBpackage.sls\fP file could be configured like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
packages:
  bind: bind9
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This would make the \fBpackages\fP pillar key a nested dictionary containing a
\fBbind\fP key.
.SS Pillar Dictionary Merging
.sp
If the same pillar key is defined in multiple pillar SLS files, and the keys in
both files refer to nested dictionaries, then the content from these
dictionaries will be recursively merged.
.sp
For example, keeping the \fBtop.sls\fP the same, assume the following
modifications to the pillar SLS files:
.sp
\fBpackages.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
bind:
  package\-name: bind9
  version: 9.9.5
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBservices.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
bind:
  port: 53
  listen\-on: any
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The resulting pillar dictionary will be:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-call pillar.get bind
local:
    \-\-\-\-\-\-\-\-\-\-
    listen\-on:
        any
    package\-name:
        bind9
    port:
        53
    version:
        9.9.5
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Since both pillar SLS files contained a \fBbind\fP key which contained a nested
dictionary, the pillar dictionary\(aqs \fBbind\fP key contains the combined contents
of both SLS files\(aq \fBbind\fP keys.
.SS Including Other Pillars
.sp
New in version 0.16.0.

.sp
Pillar SLS files may include other pillar files, similar to State files. Two
syntaxes are available for this purpose. The simple form simply includes the
additional pillar as if it were part of the same file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- users
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The full include form allows two additional options \-\- passing default values
to the templating engine for the included pillar file as well as an optional
key under which to nest the results of the included pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- users:
      defaults:
          sudo: [\(aqbob\(aq, \(aqpaul\(aq]
      key: users
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With this form, the included file (users.sls) will be nested within the \(aqusers\(aq
key of the compiled pillar. Additionally, the \(aqsudo\(aq value will be available
as a template variable to users.sls.
.SS In\-Memory Pillar Data vs. On\-Demand Pillar Data
.sp
Since compiling pillar data is computationally expensive, the minion will
maintain a copy of the pillar data in memory to avoid needing to ask the master
to recompile and send it a copy of the pillar data each time pillar data is
requested. This in\-memory pillar data is what is returned by the
\fI\%pillar.item\fP, \fI\%pillar.get\fP, and \fI\%pillar.raw\fP
functions.
.sp
Also, for those writing custom execution modules, or contributing to Salt\(aqs
existing execution modules, the in\-memory pillar data is available as the
\fB__pillar__\fP dunder dictionary.
.sp
The in\-memory pillar data is generated on minion start, and can be refreshed
using the \fI\%saltutil.refresh_pillar\fP function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.refresh_pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This function triggers the minion to asynchronously refresh the in\-memory
pillar data and will always return \fBNone\fP\&.
.sp
In contrast to in\-memory pillar data, certain actions trigger pillar data to be
compiled to ensure that the most up\-to\-date pillar data is available. These
actions include:
.INDENT 0.0
.IP \(bu 2
Running states
.IP \(bu 2
Running \fI\%pillar.items\fP
.UNINDENT
.sp
Performing these actions will \fInot\fP refresh the in\-memory pillar data. So, if
pillar data is modified, and then states are run, the states will see the
updated pillar data, but \fI\%pillar.item\fP,
\fI\%pillar.get\fP, and \fI\%pillar.raw\fP will not see this data unless refreshed using
\fI\%saltutil.refresh_pillar\fP\&.
.sp
If you are using the Pillar Cache and have set \fI\%pillar_cache\fP to \fITrue\fP,
the pillar cache can be updated either when you run \fI\%saltutil.refresh_pillar\fP, or using the pillar runner function
\fI\%pillar.clear_pillar_cache\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run pillar.clear_pillar_cache \(aqminion\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The pillar will not be updated when running \fI\%pillar.items\fP or a state for example. If you are
using a Salt version before 3003, you would need to manually delete the cache
file, located in Salt\(aqs master cache. For example, on linux the file would be
in this directory: /var/cache/salt/master/pillar_cache/
.SS How Pillar Environments Are Handled
.sp
When multiple pillar environments are used, the default behavior is for the
pillar data from all environments to be merged together. The pillar dictionary
will therefore contain keys from all configured environments.
.sp
The \fI\%pillarenv\fP minion config option can be used to force the
minion to only consider pillar configuration from a single environment. This
can be useful in cases where one needs to run states with alternate pillar
data, either in a testing/QA environment or to test changes to the pillar data
before pushing them live.
.sp
For example, assume that the following is set in the minion config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillarenv: base
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This would cause that minion to ignore all other pillar environments besides
\fBbase\fP when compiling the in\-memory pillar data. Then, when running states,
the \fBpillarenv\fP CLI argument can be used to override the minion\(aqs
\fI\%pillarenv\fP config value:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply mystates pillarenv=testing
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above command will run the states with pillar data sourced exclusively from
the \fBtesting\fP environment, without modifying the in\-memory pillar data.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When running states, the \fBpillarenv\fP CLI option does not require a
\fI\%pillarenv\fP option to be set in the minion config file. When
\fI\%pillarenv\fP is left unset, as mentioned above all configured
environments will be combined. Running states with \fBpillarenv=testing\fP in
this case would still restrict the states\(aq pillar data to just that of the
\fBtesting\fP pillar environment.
.UNINDENT
.UNINDENT
.sp
Starting in the 2017.7.0 release, it is possible to pin the pillarenv to the
effective saltenv, using the \fI\%pillarenv_from_saltenv\fP minion
config option. When this is set to \fBTrue\fP, if a specific saltenv is specified
when running states, the \fBpillarenv\fP will be the same. This essentially makes
the following two commands equivalent:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply mystates saltenv=dev
salt \(aq*\(aq state.apply mystates saltenv=dev pillarenv=dev
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, if a pillarenv is specified, it will override this behavior. So, the
following command will use the \fBqa\fP pillar environment but source the SLS
files from the \fBdev\fP saltenv:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply mystates saltenv=dev pillarenv=qa
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
So, if a \fBpillarenv\fP is set in the minion config file,
\fI\%pillarenv_from_saltenv\fP will be ignored, and passing a
\fBpillarenv\fP on the CLI will temporarily override
\fI\%pillarenv_from_saltenv\fP\&.
.SS Viewing Pillar Data
.sp
To view pillar data, use the \fI\%pillar\fP execution
module. This module includes several functions, each of them with their own
use. These functions include:
.INDENT 0.0
.IP \(bu 2
\fI\%pillar.item\fP \- Retrieves the value of
one or more keys from the \fI\%in\-memory pillar data\fP\&.
.IP \(bu 2
\fI\%pillar.items\fP \- Compiles a fresh pillar
dictionary and returns it, leaving the \fI\%in\-memory pillar data\fP untouched. If pillar keys are passed to this function
however, this function acts like \fI\%pillar.item\fP and returns their values from the \fI\%in\-memory
pillar data\fP\&.
.IP \(bu 2
\fI\%pillar.raw\fP \- Like \fI\%pillar.items\fP, it returns the entire pillar dictionary, but
from the \fI\%in\-memory pillar data\fP instead of compiling
fresh pillar data.
.IP \(bu 2
\fI\%pillar.get\fP \- Described in detail below.
.UNINDENT
.SS The \fI\%pillar.get\fP Function
.sp
New in version 0.14.0.

.sp
The \fI\%pillar.get\fP function works much in the same
way as the \fBget\fP method in a python dict, but with an enhancement: nested
dictionaries can be traversed using a colon as a delimiter.
.sp
If a structure like this is in pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  bar:
    baz: qux
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Extracting it from the raw pillar in an sls formula or file template is done
this way:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ pillar[\(aqfoo\(aq][\(aqbar\(aq][\(aqbaz\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now, with the new \fI\%pillar.get\fP function the data
can be safely gathered and a default can be set, allowing the template to fall
back if the value is not available:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt[\(aqpillar.get\(aq](\(aqfoo:bar:baz\(aq, \(aqqux\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This makes handling nested structures much easier.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBpillar.get()\fP vs \fBsalt[\(aqpillar.get\(aq]()\fP
.sp
It should be noted that within templating, the \fBpillar\fP variable is just
a dictionary.  This means that calling \fBpillar.get()\fP inside of a
template will just use the default dictionary \fB\&.get()\fP function which
does not include the extra \fB:\fP delimiter functionality.  It must be
called using the above syntax (\fBsalt[\(aqpillar.get\(aq](\(aqfoo:bar:baz\(aq,
\(aqqux\(aq)\fP) to get the salt function, instead of the default dictionary
behavior.
.UNINDENT
.UNINDENT
.SS Setting Pillar Data at the Command Line
.sp
Pillar data can be set at the command line like the following example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply pillar=\(aq{\(dqcheese\(dq: \(dqspam\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will add a pillar key of \fBcheese\fP with its value set to \fBspam\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Be aware that when sending sensitive data via pillar on the command\-line
that the publication containing that data will be received by all minions
and will not be restricted to the targeted minions. This may represent
a security concern in some cases.
.UNINDENT
.UNINDENT
.SS Pillar Encryption
.sp
Salt\(aqs renderer system can be used to decrypt pillar data. This allows for
pillar items to be stored in an encrypted state, and decrypted during pillar
compilation.
.SS Encrypted Pillar SLS
.sp
New in version 2017.7.0.

.sp
Consider the following pillar SLS file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
secrets:
  vault:
    foo: |
      \-\-\-\-\-BEGIN PGP MESSAGE\-\-\-\-\-

      hQEMAw2B674HRhwSAQgAhTrN8NizwUv/VunVrqa4/X8t6EUulrnhKcSeb8sZS4th
      W1Qz3K2NjL4lkUHCQHKZVx/VoZY7zsddBIFvvoGGfj8+2wjkEDwFmFjGE4DEsS74
      ZLRFIFJC1iB/O0AiQ+oU745skQkU6OEKxqavmKMrKo3rvJ8ZCXDC470+i2/Hqrp7
      +KWGmaDOO422JaSKRm5D9bQZr9oX7KqnrPG9I1+UbJyQSJdsdtquPWmeIpamEVHb
      VMDNQRjSezZ1yKC4kCWm3YQbBF76qTHzG1VlLF5qOzuGI9VkyvlMaLfMibriqY73
      zBbPzf6Bkp2+Y9qyzuveYMmwS4sEOuZL/PetqisWe9JGAWD/O+slQ2KRu9hNww06
      KMDPJRdyj5bRuBVE4hHkkP23KrYr7SuhW2vpe7O/MvWEJ9uDNegpMLhTWruGngJh
      iFndxegN9w==
      =bAuo
      \-\-\-\-\-END PGP MESSAGE\-\-\-\-\-
    bar: this was unencrypted already
    baz: |
      \-\-\-\-\-BEGIN PGP MESSAGE\-\-\-\-\-

      hQEMAw2B674HRhwSAQf+Ne+IfsP2IcPDrUWct8sTJrga47jQvlPCmO+7zJjOVcqz
      gLjUKvMajrbI/jorBWxyAbF+5E7WdG9WHHVnuoywsyTB9rbmzuPqYCJCe+ZVyqWf
      9qgJ+oUjcvYIFmH3h7H68ldqbxaAUkAOQbTRHdr253wwaTIC91ZeX0SCj64HfTg7
      Izwk383CRWonEktXJpientApQFSUWNeLUWagEr/YPNFA3vzpPF5/Ia9X8/z/6oO2
      q+D5W5mVsns3i2HHbg2A8Y+pm4TWnH6mTSh/gdxPqssi9qIrzGQ6H1tEoFFOEq1V
      kJBe0izlfudqMq62XswzuRB4CYT5Iqw1c97T+1RqENJCASG0Wz8AGhinTdlU5iQl
      JkLKqBxcBz4L70LYWyHhYwYROJWjHgKAywX5T67ftq0wi8APuZl9olnOkwSK+wrY
      1OZi
      =7epf
      \-\-\-\-\-END PGP MESSAGE\-\-\-\-\-
    qux:
      \- foo
      \- bar
      \- |
        \-\-\-\-\-BEGIN PGP MESSAGE\-\-\-\-\-

        hQEMAw2B674HRhwSAQgAg1YCmokrweoOI1c9HO0BLamWBaFPTMblOaTo0WJLZoTS
        ksbQ3OJAMkrkn3BnnM/djJc5C7vNs86ZfSJ+pvE8Sp1Rhtuxh25EKMqGOn/SBedI
        gR6N5vGUNiIpG5Tf3DuYAMNFDUqw8uY0MyDJI+ZW3o3xrMUABzTH0ew+Piz85FDA
        YrVgwZfqyL+9OQuu6T66jOIdwQNRX2NPFZqvon8liZUPus5VzD8E5cAL9OPxQ3sF
        f7/zE91YIXUTimrv3L7eCgU1dSxKhhfvA2bEUi+AskMWFXFuETYVrIhFJAKnkFmE
        uZx+O9R9hADW3hM5hWHKH9/CRtb0/cC84I9oCWIQPdI+AaPtICxtsD2N8Q98hhhd
        4M7I0sLZhV+4ZJqzpUsOnSpaGyfh1Zy/1d3ijJi99/l+uVHuvmMllsNmgR+ZTj0=
        =LrCQ
        \-\-\-\-\-END PGP MESSAGE\-\-\-\-\-
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When the pillar data is compiled, the results will be decrypted:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt myminion pillar.items
myminion:
    \-\-\-\-\-\-\-\-\-\-
    secrets:
        \-\-\-\-\-\-\-\-\-\-
        vault:
            \-\-\-\-\-\-\-\-\-\-
            bar:
                this was unencrypted already
            baz:
                rosebud
            foo:
                supersecret
            qux:
                \- foo
                \- bar
                \- baz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt must be told what portions of the pillar data to decrypt. This is done
using the \fI\%decrypt_pillar\fP config option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
decrypt_pillar:
  \- \(aqsecrets:vault\(aq: gpg
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The notation used to specify the pillar item(s) to be decrypted is the same as
the one used in \fI\%pillar.get\fP function.
.sp
If a different delimiter is needed, it can be specified using the
\fI\%decrypt_pillar_delimiter\fP config option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
decrypt_pillar:
  \- \(aqsecrets|vault\(aq: gpg

decrypt_pillar_delimiter: \(aq|\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The name of the renderer used to decrypt a given pillar item can be omitted,
and if so it will fall back to the value specified by the
\fI\%decrypt_pillar_default\fP config option, which defaults to \fBgpg\fP\&.
So, the first example above could be rewritten as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
decrypt_pillar:
  \- \(aqsecrets:vault\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Encrypted Pillar Data on the CLI
.sp
New in version 2016.3.0.

.sp
The following functions support passing pillar data on the CLI via the
\fBpillar\fP argument:
.INDENT 0.0
.IP \(bu 2
\fI\%pillar.items\fP
.IP \(bu 2
\fI\%state.apply\fP
.IP \(bu 2
\fI\%state.highstate\fP
.IP \(bu 2
\fI\%state.sls\fP
.UNINDENT
.sp
Triggering decryption of this CLI pillar data can be done in one of two ways:
.INDENT 0.0
.IP 1. 3
Using the \fBpillar_enc\fP argument:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
# salt myminion pillar.items pillar_enc=gpg pillar=\(aq{foo: \(dq\-\-\-\-\-BEGIN PGP MESSAGE\-\-\-\-\-\en\enhQEMAw2B674HRhwSAQf+OvPqEdDoA2fk15I5dYUTDoj1yf/pVolAma6iU4v8Zixn\enRDgWsaAnFz99FEiFACsAGDEFdZaVOxG80T0Lj+PnW4pVy0OXmXHnY2KjV9zx8FLS\enQxfvmhRR4t23WSFybozfMm0lsN8r1vfBBjbK+A72l0oxN78d1rybJ6PWNZiXi+aC\enmqIeunIbAKQ21w/OvZHhxH7cnIiGQIHc7N9nQH7ibyoKQzQMSZeilSMGr2abAHun\enmLzscr4wKMb+81Z0/fdBfP6g3bLWMJga3hSzSldU9ovu7KR8rDJI1qOlENj3Wm8C\enwTpDOB33kWIKMqiAjY3JFtb5MCHrafyggwQL7cX1+tI+AbSO6kZpbcDfzetb77LZ\enxc5NWnnGK4pGoqq4MAmZshw98RpecSHKMosto2gtiuWCuo9Zn5cV/FbjZ9CTWrQ=\en=0hO/\en\-\-\-\-\-END PGP MESSAGE\-\-\-\-\-\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The newlines in this example are specified using a literal \fB\en\fP\&. Newlines
can be replaced with a literal \fB\en\fP using \fBsed\fP:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
$ echo \-n bar | gpg \-\-armor \-\-trust\-model always \-\-encrypt \-r user@domain.tld | sed \(aq:a;N;$!ba;s/\en/\e\en/g\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
Using \fBpillar_enc\fP will perform the decryption minion\-side, so for
this to work it will be necessary to set up the keyring in
\fB/etc/salt/gpgkeys\fP on the minion just as one would typically do on
the master. The easiest way to do this is to first export the keys from
the master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# gpg \-\-homedir /etc/salt/gpgkeys \-\-export\-secret\-key \-a user@domain.tld >/tmp/keypair.gpg
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then, copy the file to the minion, setup the keyring, and import:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# mkdir \-p /etc/salt/gpgkeys
# chmod 0700 /etc/salt/gpgkeys
# gpg \-\-homedir /etc/salt/gpgkeys \-\-list\-keys
# gpg \-\-homedir /etc/salt/gpgkeys \-\-import \-\-allow\-secret\-key\-import keypair.gpg
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fB\-\-list\-keys\fP command is run create a keyring in the newly\-created
directory.
.UNINDENT
.UNINDENT
.sp
Pillar data which is decrypted minion\-side will still be securely
transferred to the master, since the data sent between minion and master is
encrypted with the master\(aqs public key.
.IP 2. 3
Use the \fI\%decrypt_pillar\fP option. This is less flexible in that
the pillar key passed on the CLI must be pre\-configured on the master, but
it doesn\(aqt require a keyring to be setup on the minion. One other caveat to
this method is that pillar decryption on the master happens at the end of
pillar compilation, so if the encrypted pillar data being passed on the CLI
needs to be referenced by pillar or ext_pillar \fIduring pillar compilation\fP,
it \fImust\fP be decrypted minion\-side.
.UNINDENT
.SS Adding New Renderers for Decryption
.sp
Those looking to add new renderers for decryption should look at the \fI\%gpg\fP renderer for an example of how to do so. The function
that performs the decryption should be recursive and be able to traverse a
mutable type such as a dictionary, and modify the values in\-place.
.sp
Once the renderer has been written, \fI\%decrypt_pillar_renderers\fP
should be modified so that Salt allows it to be used for decryption.
.sp
If the renderer is being submitted upstream to the Salt project, the renderer
should be added in \fI\%salt/renderers/\fP\&. Additionally, the following should be
done:
.INDENT 0.0
.IP \(bu 2
Both occurrences of \fI\%decrypt_pillar_renderers\fP in
\fI\%salt/config/__init__.py\fP should be updated to include the name of the new
renderer so that it is included in the default value for this config option.
.IP \(bu 2
The documentation for the \fI\%decrypt_pillar_renderers\fP config
option in the \fI\%master config file\fP and \fI\%minion config file\fP should be
updated to show the correct new default value.
.IP \(bu 2
The commented example for the \fI\%decrypt_pillar_renderers\fP config
option in the \fI\%master config template\fP should be updated to show the correct
new default value.
.UNINDENT
.SS Binary Data in the Pillar
.sp
Salt has partial support for binary pillar data.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
There are some situations (such as salt\-ssh) where only text (ASCII or
Unicode) is allowed.
.UNINDENT
.UNINDENT
.sp
The simplest way to embed binary data in your pillar is to make use of YAML\(aqs
built\-in binary data type, which requires base64 encoded data.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt_pic: !!binary
    iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAMAAAC67D+PAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAA
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then you can use it as a \fBcontents_pillar\fP in a state:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/tmp/salt.png:
  file.managed:
    \- contents_pillar: salt_pic
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is also possible to add ASCII\-armored encrypted data to pillars, as
mentioned in the Pillar Encryption section.
.SS Master Config in Pillar
.sp
For convenience the data stored in the master configuration file can be made
available in all minion\(aqs pillars. This makes global configuration of services
and systems very easy but may not be desired if sensitive data is stored in the
master configuration. This option is disabled by default.
.sp
To enable the master config from being added to the pillar set
\fBpillar_opts\fP to \fBTrue\fP in the minion config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_opts: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Minion Config in Pillar
.sp
Minion configuration options can be set on pillars. Any option that you want
to modify, should be in the first level of the pillars, in the same way you set
the options in the config file. For example, to configure the MySQL root
password to be used by MySQL Salt execution module, set the following pillar
variable:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql.pass: hardtoguesspassword
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Master Provided Pillar Error
.sp
By default if there is an error rendering a pillar, the detailed error is
hidden and replaced with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Rendering SLS \(aqmy.sls\(aq failed. Please see master log for details.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The error is protected because it\(aqs possible to contain templating data
which would give that minion information it shouldn\(aqt know, like a password!
.sp
To have the master provide the detailed error that could potentially carry
protected data set \fBpillar_safe_render_error\fP to \fBFalse\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_safe_render_error: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Pillar Walkthrough
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This walkthrough assumes that the reader has already completed the initial
Salt \fI\%walkthrough\fP\&.
.UNINDENT
.UNINDENT
.sp
Pillars are tree\-like structures of data defined on the Salt Master and passed
through to minions. They allow confidential, targeted data to be securely sent
only to the relevant minion.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Grains and Pillar are sometimes confused, just remember that Grains
are data about a minion which is stored or generated from the minion.
This is why information like the OS and CPU type are found in Grains.
Pillar is information about a minion or many minions stored or generated
on the Salt Master.
.UNINDENT
.UNINDENT
.sp
Pillar data is useful for:
.INDENT 0.0
.TP
.B Highly Sensitive Data:
Information transferred via pillar is guaranteed to only be presented to
the minions that are targeted, making Pillar suitable
for managing security information, such as cryptographic keys and
passwords.
.TP
.B Minion Configuration:
Minion modules such as the execution modules, states, and returners can
often be configured via data stored in pillar.
.TP
.B Variables:
Variables which need to be assigned to specific minions or groups of
minions can be defined in pillar and then accessed inside sls formulas
and template files.
.TP
.B Arbitrary Data:
Pillar can contain any basic data structure in dictionary format,
so a key/value store can be defined making it easy to iterate over a group
of values in sls formulas.
.UNINDENT
.sp
Pillar is therefore one of the most important systems when using Salt. This
walkthrough is designed to get a simple Pillar up and running in a few minutes
and then to dive into the capabilities of Pillar and where the data is
available.
.SS Setting Up Pillar
.sp
The pillar is already running in Salt by default. To see the minion\(aqs
pillar data:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.items
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Prior to version 0.16.2, this function is named \fBpillar.data\fP\&. This
function name is still supported for backwards compatibility.
.UNINDENT
.UNINDENT
.sp
By default, the contents of the master configuration file are not loaded into
pillar for all minions. This default is stored in the \fBpillar_opts\fP setting,
which defaults to \fBFalse\fP\&.
.sp
The contents of the master configuration file can be made available to minion
pillar files. This makes global configuration of services and systems very easy,
but note that this may not be desired or appropriate if sensitive data is stored
in the master\(aqs configuration file. To enable the master configuration file to be
available to minion as pillar, set \fBpillar_opts: True\fP in the master
configuration file, and then for appropriate minions also set \fBpillar_opts: True\fP
in the minion(s) configuration file.
.sp
Similar to the state tree, the pillar is comprised of sls files and has a top file.
The default location for the pillar is in /srv/pillar.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The pillar location can be configured via the \fBpillar_roots\fP option inside
the master configuration file. It must not be in a subdirectory of the state
tree or file_roots. If the pillar is under file_roots, any pillar targeting
can be bypassed by minions.
.UNINDENT
.UNINDENT
.sp
To start setting up the pillar, the /srv/pillar directory needs to be present:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mkdir /srv/pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now create a simple top file, following the same format as the top file used for
states:
.sp
\fB/srv/pillar/top.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- data
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This top file associates the data.sls file to all minions. Now the
\fB/srv/pillar/data.sls\fP file needs to be populated:
.sp
\fB/srv/pillar/data.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
info: some data
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To ensure that the minions have the new pillar data, issue a command
to them asking that they fetch their pillars from the master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.refresh_pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now that the minions have the new pillar, it can be retrieved:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.items
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The key \fBinfo\fP should now appear in the returned pillar data.
.SS More Complex Data
.sp
Unlike states, pillar files do not need to define \fBformulas\fP\&.
This example sets up user data with a UID:
.sp
\fB/srv/pillar/users/init.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  thatch: 1000
  shouse: 1001
  utahdave: 1002
  redbeard: 1003
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The same directory lookups that exist in states exist in pillar, so the
file \fBusers/init.sls\fP can be referenced with \fBusers\fP in the \fI\%top
file\fP\&.
.UNINDENT
.UNINDENT
.sp
The top file will need to be updated to include this sls file:
.sp
\fB/srv/pillar/top.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- data
    \- users
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now the data will be available to the minions. To use the pillar data in a
state, you can use Jinja:
.sp
\fB/srv/salt/users/init.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% for user, uid in pillar.get(\(aqusers\(aq, {}).items() %}
{{user}}:
  user.present:
    \- uid: {{uid}}
{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This approach allows for users to be safely defined in a pillar and then the
user data is applied in an sls file.
.SS Parameterizing States With Pillar
.sp
Pillar data can be accessed in state files to customise behavior for each
minion. All pillar (and grain) data applicable to each minion is substituted
into the state files through templating before being run. Typical uses
include setting directories appropriate for the minion and skipping states
that don\(aqt apply.
.sp
A simple example is to set up a mapping of package names in pillar for
separate Linux distributions:
.sp
\fB/srv/pillar/pkg/init.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pkgs:
  {% if grains[\(aqos_family\(aq] == \(aqRedHat\(aq %}
  apache: httpd
  vim: vim\-enhanced
  {% elif grains[\(aqos_family\(aq] == \(aqDebian\(aq %}
  apache: apache2
  vim: vim
  {% elif grains[\(aqos\(aq] == \(aqArch\(aq %}
  apache: apache
  vim: vim
  {% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The new \fBpkg\fP sls needs to be added to the top file:
.sp
\fB/srv/pillar/top.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- data
    \- users
    \- pkg
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now the minions will auto map values based on respective operating systems
inside of the pillar, so sls files can be safely parameterized:
.sp
\fB/srv/salt/apache/init.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  pkg.installed:
    \- name: {{ pillar[\(aqpkgs\(aq][\(aqapache\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or, if no pillar is available a default can be set as well:
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The function \fBpillar.get\fP used in this example was added to Salt in
version 0.14.0
.UNINDENT
.UNINDENT
.sp
\fB/srv/salt/apache/init.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  pkg.installed:
    \- name: {{ salt[\(aqpillar.get\(aq](\(aqpkgs:apache\(aq, \(aqhttpd\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above example, if the pillar value \fBpillar[\(aqpkgs\(aq][\(aqapache\(aq]\fP is not
set in the minion\(aqs pillar, then the default of \fBhttpd\fP will be used.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Under the hood, pillar is just a Python dict, so Python dict methods such
as \fBget\fP and \fBitems\fP can be used.
.UNINDENT
.UNINDENT
.SS Pillar Makes Simple States Grow Easily
.sp
One of the design goals of pillar is to make simple sls formulas easily grow
into more flexible formulas without refactoring or complicating the states.
.sp
A simple formula:
.sp
\fB/srv/salt/edit/vim.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed: []

/etc/vimrc:
  file.managed:
    \- source: salt://edit/vimrc
    \- mode: 644
    \- user: root
    \- group: root
    \- require:
      \- pkg: vim
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Can be easily transformed into a powerful, parameterized formula:
.sp
\fB/srv/salt/edit/vim.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed:
    \- name: {{ pillar[\(aqpkgs\(aq][\(aqvim\(aq] }}

/etc/vimrc:
  file.managed:
    \- source: {{ pillar[\(aqvimrc\(aq] }}
    \- mode: 644
    \- user: root
    \- group: root
    \- require:
      \- pkg: vim
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Where the vimrc source location can now be changed via pillar:
.sp
\fB/srv/pillar/edit/vim.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% if grains[\(aqid\(aq].startswith(\(aqdev\(aq) %}
vimrc: salt://edit/dev_vimrc
{% elif grains[\(aqid\(aq].startswith(\(aqqa\(aq) %}
vimrc: salt://edit/qa_vimrc
{% else %}
vimrc: salt://edit/vimrc
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Ensuring that the right vimrc is sent out to the correct minions.
.sp
The pillar top file must include a reference to the new sls pillar file:
.sp
\fB/srv/pillar/top.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- pkg
    \- edit.vim
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Setting Pillar Data on the Command Line
.sp
Pillar data can be set on the command line when running \fBstate.apply
<salt.modules.state.apply_()\fP like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply pillar=\(aq{\(dqfoo\(dq: \(dqbar\(dq}\(aq
salt \(aq*\(aq state.apply my_sls_file pillar=\(aq{\(dqhello\(dq: \(dqworld\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Nested pillar values can also be set via the command line:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.sls my_sls_file pillar=\(aq{\(dqfoo\(dq: {\(dqbar\(dq: \(dqbaz\(dq}}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Lists can be passed via command line pillar data as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.sls my_sls_file pillar=\(aq{\(dqsome_list\(dq: [\(dqfoo\(dq, \(dqbar\(dq, \(dqbaz\(dq]}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If a key is passed on the command line that already exists on the minion,
the key that is passed in will overwrite the entire value of that key,
rather than merging only the specified value set via the command line.
.UNINDENT
.UNINDENT
.sp
The example below will swap the value for vim with telnet in the previously
specified list, notice the nested pillar dict:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply edit.vim pillar=\(aq{\(dqpkgs\(dq: {\(dqvim\(dq: \(dqtelnet\(dq}}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will attempt to install telnet on your minions, feel free to
uninstall the package or replace telnet value with anything else.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Be aware that when sending sensitive data via pillar on the command\-line
that the publication containing that data will be received by all minions
and will not be restricted to the targeted minions. This may represent
a security concern in some cases.
.UNINDENT
.UNINDENT
.SS More On Pillar
.sp
Pillar data is generated on the Salt master and securely distributed to
minions. Salt is not restricted to the pillar sls files when defining the
pillar but can retrieve data from external sources. This can be useful when
information about an infrastructure is stored in a separate location.
.sp
Reference information on pillar and the external pillar interface can be found
in the Salt documentation:
.sp
\fI\%Pillar\fP
.SS Minion Config in Pillar
.sp
Minion configuration options can be set on pillars. Any option that you want
to modify, should be in the first level of the pillars, in the same way you set
the options in the config file. For example, to configure the MySQL root
password to be used by MySQL Salt execution module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql.pass: hardtoguesspassword
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is very convenient when you need some dynamic configuration change that
you want to be applied on the fly. For example, there is a chicken and the egg
problem if you do this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql\-admin\-passwd:
  mysql_user.present:
    \- name: root
    \- password: somepasswd

mydb:
  mysql_db.present
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The second state will fail, because you changed the root password and the
minion didn\(aqt notice it. Setting mysql.pass in the pillar, will help to sort
out the issue. But always change the root admin password in the first place.
.sp
This is very helpful for any module that needs credentials to apply state
changes: mysql, keystone, etc.
.SS Targeting Minions
.sp
Targeting minions is specifying which minions should run a command or execute a
state by matching against hostnames, or system information, or defined groups,
or even combinations thereof.
.sp
For example the command \fBsalt web1 apache.signal restart\fP to restart the
Apache httpd server specifies the machine \fBweb1\fP as the target and the
command will only be run on that one minion.
.sp
Similarly when using States, the following \fI\%top file\fP specifies that only
the \fBweb1\fP minion should execute the contents of \fBwebserver.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqweb1\(aq:
    \- webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The simple target specifications, glob, regex, and list will cover many use
cases, and for some will cover all use cases, but more powerful options exist.
.SS Targeting with Grains
.sp
The Grains interface was built into Salt to allow minions to be targeted by
system properties. So minions running on a particular operating system can
be called to execute a function, or a specific kernel.
.sp
Calling via a grain is done by passing the \-G option to salt, specifying
a grain and a glob expression to match the value of the grain. The syntax for
the target is the grain key followed by a glob expression: \(dqos:Arch*\(dq.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos:Fedora\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Will return True from all of the minions running Fedora.
.sp
To discover what grains are available and what the values are, execute the
grains.item salt function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.items
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
More info on using targeting with grains can be found \fI\%here\fP\&.
.SS Compound Targeting
.sp
New in version 0.9.5.

.sp
Multiple target interfaces can be used in conjunction to determine the command
targets. These targets can then be combined using \fBand\fP or \fBor\fP statements.
This is well defined with an example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-C \(aqG@os:Debian and webser* or E@db.*\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example any minion who\(aqs id starts with \fBwebser\fP and is running
Debian, or any minion who\(aqs id starts with db will be matched.
.sp
The type of matcher defaults to glob, but can be specified with the
corresponding letter followed by the \fB@\fP symbol. In the above example a grain
is used with \fBG@\fP as well as a regular expression with \fBE@\fP\&. The
\fBwebser*\fP target does not need to be prefaced with a target type specifier
because it is a glob.
.sp
More info on using compound targeting can be found \fI\%here\fP\&.
.SS Node Group Targeting
.sp
New in version 0.9.5.

.sp
For certain cases, it can be convenient to have a predefined group of minions
on which to execute commands. This can be accomplished using what are called
\fI\%nodegroups\fP\&. Nodegroups allow for predefined
compound targets to be declared in the master configuration file, as a sort of
shorthand for having to type out complicated compound expressions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nodegroups:
  group1: \(aqL@foo.domain.com,bar.domain.com,baz.domain.com and bl*.domain.com\(aq
  group2: \(aqG@os:Debian and foo.domain.com\(aq
  group3: \(aqG@os:Debian and N@group1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Advanced Targeting Methods
.sp
There are many ways to target individual minions or groups of minions in Salt:
.SS Matching the \fBminion id\fP
.sp
Each minion needs a unique identifier. By default when a minion starts for the
first time it chooses its FQDN as that
identifier. The minion id can be overridden via the minion\(aqs \fI\%id\fP
configuration setting.
.sp
\fBTIP:\fP
.INDENT 0.0
.INDENT 3.5
minion id and minion keys
.sp
The \fI\%minion id\fP is used to generate the minion\(aqs public/private keys
and if it ever changes the master must then accept the new key as though
the minion was a new host.
.UNINDENT
.UNINDENT
.SS Globbing
.sp
The default matching that Salt utilizes is \fBshell\-style globbing\fP around the \fI\%minion id\fP\&. This also works for states
in the \fI\%top file\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
You must wrap \fBsalt\fP calls that use globbing in single\-quotes to
prevent the shell from expanding the globs before Salt is invoked.
.UNINDENT
.UNINDENT
.sp
Match all minions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Match all minions in the example.net domain or any of the example domains:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*.example.net\(aq test.version
salt \(aq*.example.*\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Match all the \fBwebN\fP minions in the example.net domain (\fBweb1.example.net\fP,
\fBweb2.example.net\fP … \fBwebN.example.net\fP):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqweb?.example.net\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Match the \fBweb1\fP through \fBweb5\fP minions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqweb[1\-5]\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Match the \fBweb1\fP and \fBweb3\fP minions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqweb[1,3]\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Match the \fBweb\-x\fP, \fBweb\-y\fP, and \fBweb\-z\fP minions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqweb\-[x\-z]\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For additional targeting methods please review the
\fI\%compound matchers\fP documentation.
.UNINDENT
.UNINDENT
.SS Regular Expressions
.sp
Minions can be matched using Perl\-compatible \fBregular expressions\fP (which is globbing on steroids and a ton of caffeine).
.sp
Match both \fBweb1\-prod\fP and \fBweb1\-devel\fP minions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-E \(aqweb1\-(prod|devel)\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When using regular expressions in a State\(aqs \fI\%top file\fP, you must specify
the matcher as the first option. The following example executes the contents of
\fBwebserver.sls\fP on the above\-mentioned minions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqweb1\-(prod|devel)\(aq:
  \- match: pcre
  \- webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Lists
.sp
At the most basic level, you can specify a flat list of minion IDs:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-L \(aqweb1,web2,web3\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Targeting using Grains
.sp
Grain data can be used when targeting minions.
.sp
For example, the following matches all CentOS minions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos:CentOS\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Match all minions with 64\-bit CPUs, and return number of CPU cores for each
matching minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqcpuarch:x86_64\(aq grains.item num_cpus
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Additionally, globs can be used in grain matches, and grains that are nested in
a dictionary can be matched by adding a colon for each level that is traversed.
For example, the following will match hosts that have a grain called
\fBec2_tags\fP, which itself is a dictionary with a key named \fBenvironment\fP,
which has a value that contains the word \fBproduction\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqec2_tags:environment:*production*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
See \fI\%Is Targeting using Grain Data Secure?\fP for
important security information.
.UNINDENT
.UNINDENT
.SS Targeting using Pillar
.sp
Pillar data can be used when targeting minions. This allows for ultimate
control and flexibility when targeting minions.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To start using Pillar targeting it is required to make a Pillar
data cache on Salt Master for each Minion via following commands:
\fBsalt \(aq*\(aq saltutil.refresh_pillar\fP or \fBsalt \(aq*\(aq saltutil.sync_all\fP\&.
Also Pillar data cache will be populated during the
\fI\%highstate\fP run. Once Pillar data changes, you
must refresh the cache by running above commands for this targeting
method to work correctly.
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-I \(aqsomekey:specialvalue\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Like with \fI\%Grains\fP, it is possible to use globbing
as well as match nested values in Pillar, by adding colons for each level that
is being traversed. The below example would match minions with a pillar named
\fBfoo\fP, which is a dict containing a key \fBbar\fP, with a value beginning with
\fBbaz\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-I \(aqfoo:bar:baz*\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Subnet/IP Address Matching
.sp
Minions can easily be matched based on IP address, or by subnet (using \fI\%CIDR\fP
notation).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-S 192.168.40.20 test.version
salt \-S 2001:db8::/64 test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Ipcidr matching can also be used in compound matches
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-C \(aqS@10.0.0.0/24 and G@os:Debian\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is also possible to use in both pillar and state\-matching
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(aq172.16.0.0/12\(aq:
   \- match: ipcidr
   \- internal
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Compound matchers
.sp
Compound matchers allow very granular minion targeting using any of Salt\(aqs
matchers. The default matcher is a \fBglob\fP match, just as
with CLI and \fI\%top file\fP matching. To match using anything other than a
glob, prefix the match string with the appropriate letter from the table below,
followed by an \fB@\fP sign.
.TS
center;
|l|l|l|l|.
_
T{
Letter
T}	T{
Match Type
T}	T{
Example
T}	T{
\fI\%Alt Delimiter?\fP
T}
_
T{
G
T}	T{
Grains glob
T}	T{
\fBG@os:Ubuntu\fP
T}	T{
Yes
T}
_
T{
E
T}	T{
PCRE Minion ID
T}	T{
\fBE@web\ed+\e.(dev|qa|prod)\e.loc\fP
T}	T{
No
T}
_
T{
P
T}	T{
Grains PCRE
T}	T{
\fBP@os:(RedHat|Fedora|CentOS)\fP
T}	T{
Yes
T}
_
T{
L
T}	T{
List of minions
T}	T{
\fBL@minion1.example.com,minion3.domain.com or bl*.domain.com\fP
T}	T{
No
T}
_
T{
I
T}	T{
Pillar glob
T}	T{
\fBI@pdata:foobar\fP
T}	T{
Yes
T}
_
T{
J
T}	T{
Pillar PCRE
T}	T{
\fBJ@pdata:^(foo|bar)$\fP
T}	T{
Yes
T}
_
T{
S
T}	T{
Subnet/IP address
T}	T{
\fBS@192.168.1.0/24\fP or \fBS@192.168.1.100\fP
T}	T{
No
T}
_
T{
R
T}	T{
Range cluster
T}	T{
\fBR@%foo.bar\fP
T}	T{
No
T}
_
T{
N
T}	T{
Nodegroups
T}	T{
\fBN@group1\fP
T}	T{
No
T}
_
.TE
.sp
Matchers can be joined using boolean \fBand\fP, \fBor\fP, and \fBnot\fP operators.
.sp
For example, the following string matches all Debian minions with a hostname
that begins with \fBwebserv\fP, as well as any minions that have a hostname which
matches the \fBregular expression\fP \fBweb\-dc1\-srv.*\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-C \(aqwebserv* and G@os:Debian or E@web\-dc1\-srv.*\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
That same example expressed in a \fI\%top file\fP looks like the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqwebserv* and G@os:Debian or E@web\-dc1\-srv.*\(aq:
    \- match: compound
    \- webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.sp
Excluding a minion based on its ID is also possible:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-C \(aqnot web\-dc1\-srv\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Versions prior to 2015.8.0 a leading \fBnot\fP was not supported in compound
matches. Instead, something like the following was required:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-C \(aq* and not G@kernel:Darwin\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Excluding a minion based on its ID was also possible:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-C \(aq* and not web\-dc1\-srv\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Precedence Matching
.sp
Matchers can be grouped together with parentheses to explicitly declare precedence amongst groups.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-C \(aq( ms\-1 or G@id:ms\-3 ) and G@id:ms\-3\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Be certain to note that spaces are required between the parentheses and targets. Failing to obey this
rule may result in incorrect targeting!
.UNINDENT
.UNINDENT
.SS Alternate Delimiters
.sp
New in version 2015.8.0.

.sp
Matchers that target based on a key value pair use a colon (\fB:\fP) as
a delimiter. Matchers with a \fBYes\fP in the \fBAlt Delimiters\fP column
in the previous table support specifying an alternate delimiter character.
.sp
This is done by specifying an alternate delimiter character between the leading
matcher character and the \fB@\fP pattern separator character. This avoids
incorrect interpretation of the pattern in the case that \fB:\fP is part of the
grain or pillar data structure traversal.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-C \(aqJ|@foo|bar|^foo:bar$ or J!@gitrepo!https://github.com:example/project.git\(aq test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Node groups
.sp
Nodegroups are declared using a compound target specification. The compound
target documentation can be found \fI\%here\fP\&.
.sp
The \fI\%nodegroups\fP master config file parameter is used to define
nodegroups. Here\(aqs an example nodegroup configuration within
\fB/etc/salt/master\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nodegroups:
  group1: \(aqL@foo.domain.com,bar.domain.com,baz.domain.com or bl*.domain.com\(aq
  group2: \(aqG@os:Debian and foo.domain.com\(aq
  group3: \(aqG@os:Debian and N@group1\(aq
  group4:
    \- \(aqG@foo:bar\(aq
    \- \(aqor\(aq
    \- \(aqG@foo:baz\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBL\fP within group1 is matching a list of minions, while the \fBG\fP in
group2 is matching specific grains. See the \fI\%compound matchers\fP documentation for more details.
.sp
As of the 2017.7.0 release of Salt, group names can also be prepended with
a dash. This brings the usage in line with many other areas of Salt. For
example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nodegroups:
  \- group1: \(aqL@foo.domain.com,bar.domain.com,baz.domain.com or bl*.domain.com\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Nodegroups can reference other nodegroups as seen in \fBgroup3\fP\&.  Ensure
that you do not have circular references.  Circular references will be
detected and cause partial expansion with a logged error message.
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.sp
Compound nodegroups can be either string values or lists of string values.
When the nodegroup is A string value will be tokenized by splitting on
whitespace.  This may be a problem if whitespace is necessary as part of a
pattern.  When a nodegroup is a list of strings then tokenization will
happen for each list element as a whole.
.sp
To match a nodegroup on the CLI, use the \fB\-N\fP command\-line option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-N group1 test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBN@\fP classifier historically could not be used in compound matches
within the CLI or \fI\%top file\fP, it was only recognized in the
\fI\%nodegroups\fP master config file parameter. As of the 2019.2.0
release, this limitation no longer exists.
.UNINDENT
.UNINDENT
.sp
To match a nodegroup in your \fI\%top file\fP, make sure to put \fB\- match:
nodegroup\fP on the line directly following the nodegroup name.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  group1:
    \- match: nodegroup
    \- webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When adding or modifying nodegroups to a master configuration file, the
master must be restarted for those changes to be fully recognized.
.sp
A limited amount of functionality, such as targeting with \-N from the
command\-line may be available without a restart.
.UNINDENT
.UNINDENT
.SS Defining Nodegroups as Lists of Minion IDs
.sp
A simple list of minion IDs would traditionally be defined like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nodegroups:
  group1: L@host1,host2,host3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
They can now also be defined as a YAML list, like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nodegroups:
  group1:
    \- host1
    \- host2
    \- host3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.SS Batch Size
.sp
The \fB\-b\fP (or \fB\-\-batch\-size\fP) option allows commands to be executed on only
a specified number of minions at a time. Both percentages and finite numbers are
supported.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq \-b 10 test.version

salt \-G \(aqos:RedHat\(aq \-\-batch\-size 25% apache.signal restart
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will only run test.version on 10 of the targeted minions at a time and then
restart apache on 25% of the minions matching \fBos:RedHat\fP at a time and work
through them all until the task is complete. This makes jobs like rolling web
server restarts behind a load balancer or doing maintenance on BSD firewalls
using carp much easier with salt.
.sp
The batch system maintains a window of running minions, so, if there are a
total of 150 minions targeted and the batch size is 10, then the command is
sent to 10 minions, when one minion returns then the command is sent to one
additional minion, so that the job is constantly running on 10 minions.
.sp
New in version 2016.3.

.sp
The \fB\-\-batch\-wait\fP argument can be used to specify a number of seconds to
wait after a minion returns, before sending the command to a new minion.
.SS SECO Range
.sp
SECO range is a cluster\-based metadata store developed and maintained by Yahoo!
.sp
The Range project is hosted here:
.sp
\fI\%https://github.com/ytoolshed/range\fP
.sp
Learn more about range here:
.sp
\fI\%https://github.com/ytoolshed/range/wiki/\fP
.SS Prerequisites
.sp
To utilize range support in Salt, a range server is required. Setting up a
range server is outside the scope of this document. Apache modules are included
in the range distribution.
.sp
With a working range server, cluster files must be defined. These files are
written in YAML and define hosts contained inside a cluster. Full documentation
on writing YAML range files is here:
.sp
\fI\%https://github.com/ytoolshed/range/wiki/%22yamlfile%22\-module\-file\-spec\fP
.sp
Additionally, the Python seco range libraries must be installed on the salt
master. One can verify that they have been installed correctly via the
following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-c \(aqimport seco.range\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If no errors are returned, range is installed successfully on the salt master.
.SS Preparing Salt
.sp
Range support must be enabled on the salt master by setting the hostname and
port of the range server inside the master configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
range_server: my.range.server.com:80
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Following this, the master must be restarted for the change to have an effect.
.SS Targeting with Range
.sp
Once a cluster has been defined, it can be targeted with a salt command by
using the \fB\-R\fP or \fB\-\-range\fP flags.
.sp
For example, given the following range YAML file being served from a range
server:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ cat /etc/range/test.yaml
CLUSTER: host1..100.test.com
APPS:
  \- frontend
  \- backend
  \- mysql
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
One might target host1 through host100 in the test.com domain with Salt as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-\-range %test:CLUSTER test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following salt command would target three hosts: \fBfrontend\fP, \fBbackend\fP, and \fBmysql\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-\-range %test:APPS test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Loadable Matchers
.sp
New in version 2019.2.0.

.sp
Internally targeting is implemented with chunks of code called Matchers.  As of
the 2019.2.0 release, matchers can be loaded dynamically.  Currently new matchers
cannot be created, but existing matchers can have their functionality altered or
extended.  For more information on Matchers see
.SS Matchers
.sp
New in version 3000.

.sp
Matchers are modules that provide Salt\(aqs targeting abilities.  As of the
3000 release, matchers can be dynamically loaded.  Currently new matchers
cannot be created because the required plumbing for the CLI does not exist yet.
Existing matchers may have their functionality altered or extended.
.sp
For details of targeting methods, see the \fI\%Targeting\fP topic.
.sp
A matcher module must have a function called \fBmatch()\fP\&. This function ends up
becoming a method on the Matcher class.  All matcher functions require at least
two arguments, \fBself\fP (because the function will be turned into a method), and
\fBtgt\fP, which is the actual target string.  The grains and pillar matchers also
take a \fBdelimiter\fP argument and should default to \fBDEFAULT_TARGET_DELIM\fP\&.
.sp
Like other Salt loadable modules, modules that override built\-in functionality
can be placed in \fBfile_roots\fP in a special directory and then copied to the
minion through the normal sync process.  \fI\%saltutil.sync_all\fP
will transfer all loadable modules, and the 3000 release introduces
\fI\%saltutil.sync_matchers\fP\&.  For matchers, the directory is
\fB/srv/salt/_matchers\fP (assuming your \fBfile_roots\fP is set to the default
\fB/srv/salt\fP).
.sp
As an example, let\(aqs modify the \fBlist\fP matcher to have the separator be a
\(aq\fB/\fP\(aq instead of the default \(aq\fB,\fP\(aq.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from __future__ import absolute_import, print_function, unicode_literals
from salt.ext import six  # pylint: disable=3rd\-party\-module\-not\-gated


def match(self, tgt):
    \(dq\(dq\(dq
    Determines if this host is on the list
    \(dq\(dq\(dq
    if isinstance(tgt, six.string_types):
        # The stock matcher splits on \(ga,\(ga.  Change to \(ga/\(ga below.
        tgt = tgt.split(\(dq/\(dq)
    return bool(self.opts[\(dqid\(dq] in tgt)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Place this code in a file called \fBlist_match.py\fP in a \fB_matchers\fP directory in your
\fBfile_roots\fP\&. Sync this down to your minions with
\fI\%saltutil.sync_matchers\fP\&.
Then attempt to match with the following, replacing \fBminionX\fP with three of your minions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-L \(aqminion1/minion2/minion3\(aq test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Three of your minions should respond.
.sp
The current supported matchers and associated filenames are
.TS
center;
|l|l|l|.
_
T{
Salt CLI Switch
T}	T{
Match Type
T}	T{
Filename
T}
_
T{
<none>
T}	T{
Glob
T}	T{
glob_match.py
T}
_
T{
\-C
T}	T{
Compound
T}	T{
compound_match.py
T}
_
T{
\-E
T}	T{
Perl\-Compatible
Regular Expressions
T}	T{
pcre_match.py
T}
_
T{
\-L
T}	T{
List
T}	T{
list_match.py
T}
_
T{
\-G
T}	T{
Grain
T}	T{
grain_match.py
T}
_
T{
\-P
T}	T{
Grain Perl\-Compatible
Regular Expressions
T}	T{
grain_pcre_match.py
T}
_
T{
\-N
T}	T{
Nodegroup
T}	T{
nodegroup_match.py
T}
_
T{
\-R
T}	T{
Range
T}	T{
range_match.py
T}
_
T{
\-I
T}	T{
Pillar
T}	T{
pillar_match.py
T}
_
T{
\-J
T}	T{
Pillar Perl\-Compatible
Regular Expressions
T}	T{
pillar_pcre.py
T}
_
T{
\-S
T}	T{
IP\-Classless Internet
Domain Routing
T}	T{
ipcidr_match.py
T}
_
.TE
.SS The Salt Mine
.sp
The Salt Mine is used to collect arbitrary data from Minions and store it on
the Master. This data is then made available to all Minions via the
\fI\%salt.modules.mine\fP module.
.sp
Mine data is gathered on the Minion and sent back to the Master where only the
most recent data is maintained (if long term data is required use returners or
the external job cache).
.SS Mine vs Grains
.sp
Mine data is designed to be much more up\-to\-date than grain data. Grains are
refreshed on a very limited basis and are largely static data. Mines are
designed to replace slow peer publishing calls when Minions need data from
other Minions. Rather than having a Minion reach out to all the other Minions
for a piece of data, the Salt Mine, running on the Master, can collect it from
all the Minions every \fI\%Mine Interval\fP, resulting in
almost fresh data at any given time, with much less overhead.
.SS Mine Functions
.sp
To enable the Salt Mine the \fBmine_functions\fP option needs to be applied to a
Minion. This option can be applied via the Minion\(aqs configuration file, or the
Minion\(aqs Pillar. The \fBmine_functions\fP option dictates what functions are
being executed and allows for arguments to be passed in.  The list of
functions are available in the \fBsalt.module\fP\&.  If no arguments
are passed, an empty list must be added like in the \fBtest.ping\fP function in
the example below:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_functions:
  test.ping: []
  network.ip_addrs:
    interface: eth0
    cidr: 10.0.0.0/8
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the example above \fI\%salt.modules.network.ip_addrs\fP has additional
filters to help narrow down the results.  In the above example IP addresses
are only returned if they are on a eth0 interface and in the 10.0.0.0/8 IP
range.
.sp
Changed in version 3000.

.sp
The format to define mine_functions has been changed to allow the same format
as used for module.run. The old format (above) will still be supported.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_functions:
  test.ping: []
  network.ip_addrs:
    \- interface: eth0
    \- cidr: 10.0.0.0/8
  test.arg:
    \- isn\(aqt
    \- this
    \- fun
    \- this: that
    \- salt: stack
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Minion\-side Access Control
.sp
New in version 3000.

.sp
Mine functions can be targeted to only be available to specific minions. This
uses the same targeting parameters as \fI\%Targeting Minions\fP but with keywords \fBallow_tgt\fP
and \fBallow_tgt_type\fP\&. When a minion requests a function from the salt mine that
is not allowed to be requested by that minion (i.e. when looking up the combination
of \fBallow_tgt\fP and \fBallow_tgt_type\fP and the requesting minion is not in the list)
it will get no data, just as if the requested function is not present in the salt mine.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_functions:
  network.ip_addrs:
    \- interface: eth0
    \- cidr: 10.0.0.0/8
    \- allow_tgt: \(aqG@role:master\(aq
    \- allow_tgt_type: \(aqcompound\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Mine Functions Aliases
.sp
Function aliases can be used to provide friendly names, usage intentions or to
allow multiple calls of the same function with different arguments. There is a
different syntax for passing positional and key\-value arguments. Mixing
positional and key\-value arguments is not supported.
.sp
New in version 2014.7.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_functions:
  network.ip_addrs: [eth0]
  networkplus.internal_ip_addrs: []
  internal_ip_addrs:
    mine_function: network.ip_addrs
    cidr: 192.168.0.0/16
  ip_list:
    \- mine_function: grains.get
    \- ip_interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3000.

.sp
With the addition of the module.run\-like format for defining mine_functions, the
method of adding aliases remains similar. Just add a \fBmine_function\fP kwarg with
the name of the real function to call, making the key below \fBmine_functions\fP
the alias:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_functions:
  alias_name:
    \- mine_function: network.ip_addrs
    \- eth0
  internal_ip_addrs:
    \- mine_function: network.ip_addrs
    \- cidr: 192.168.0.0/16
  ip_list:
    \- mine_function: grains.get
    \- ip_interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Mine Interval
.sp
The Salt Mine functions are executed when the Minion starts and at a given
interval by the scheduler. The default interval is every 60 minutes and can
be adjusted for the Minion via the \fBmine_interval\fP option in the minion
config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_interval: 60
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Mine in Salt\-SSH
.sp
As of the 2015.5.0 release of salt, salt\-ssh supports \fBmine.get\fP\&.
.sp
Because the Minions cannot provide their own \fBmine_functions\fP configuration,
we retrieve the args for specified mine functions in one of three places,
searched in the following order:
.INDENT 0.0
.IP 1. 3
Roster data
.IP 2. 3
Pillar
.IP 3. 3
Master config
.UNINDENT
.sp
The \fBmine_functions\fP are formatted exactly the same as in normal salt, just
stored in a different location. Here is an example of a flat roster containing
\fBmine_functions\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
test:
  host: 104.237.131.248
  user: root
  mine_functions:
    cmd.run: [\(aqecho \(dqhello!\(dq\(aq]
    network.ip_addrs:
      interface: eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Because of the differences in the architecture of salt\-ssh, \fBmine.get\fP
calls are somewhat inefficient. Salt must make a new salt\-ssh call to each
of the Minions in question to retrieve the requested data, much like a
publish call. However, unlike publish, it must run the requested function
as a wrapper function, so we can retrieve the function args from the pillar
of the Minion in question. This results in a non\-trivial delay in
retrieving the requested data.
.UNINDENT
.UNINDENT
.SS Minions Targeting with Mine
.sp
The \fBmine.get\fP function supports various methods of \fI\%Minions targeting\fP to fetch Mine data from particular hosts, such as glob or regular
expression matching on Minion id (name), grains, pillars and \fI\%compound
matches\fP\&. See the \fI\%salt.modules.mine\fP module
documentation for the reference.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Pillar data needs to be cached on Master for pillar targeting to work with
Mine. Read the note in \fI\%relevant section\fP\&.
.UNINDENT
.UNINDENT
.SS Example
.sp
One way to use data from Salt Mine is in a State. The values can be retrieved
via Jinja and used in the SLS file. The following example is a partial HAProxy
configuration file and pulls IP addresses from all Minions with the \(dqweb\(dq grain
to add them to the pool of load balanced servers.
.sp
\fB/srv/pillar/top.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqG@roles:web\(aq:
    \- web
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/pillar/web.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_functions:
  network.ip_addrs: [eth0]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then trigger the minions to refresh their pillar data by running:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.refresh_pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Verify that the results are showing up in the pillar on the minions by
executing the following and checking for \fBnetwork.ip_addrs\fP in the output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.items
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Which should show that the function is present on the minion, but not include
the output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minion1.example.com:
    \-\-\-\-\-\-\-\-\-\-
    mine_functions:
        \-\-\-\-\-\-\-\-\-\-
        network.ip_addrs:
            \- eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Mine data is typically only updated on the master every 60 minutes, this can
be modified by setting:
.sp
\fB/etc/salt/minion.d/mine.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_interval: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To force the mine data to update immediately run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mine.update
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Setup the \fI\%salt.states.file.managed\fP state in
\fB/srv/salt/haproxy.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
haproxy_config:
  file.managed:
    \- name: /etc/haproxy/config
    \- source: salt://haproxy_config
    \- template: jinja
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Create the Jinja template in \fB/srv/salt/haproxy_config\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<...file contents snipped...>

{% for server, addrs in salt[\(aqmine.get\(aq](\(aqroles:web\(aq, \(aqnetwork.ip_addrs\(aq, tgt_type=\(aqgrain\(aq) | dictsort() %}
server {{ server }} {{ addrs[0] }}:80 check
{% endfor %}

<...file contents snipped...>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above example, \fBserver\fP will be expanded to the \fBminion_id\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The expr_form argument will be renamed to \fBtgt_type\fP in the 2017.7.0
release of Salt.
.UNINDENT
.UNINDENT
.SS Runners
.sp
Salt runners are convenience applications executed with the salt\-run command.
.sp
Salt runners work similarly to Salt execution modules however they execute on the
Salt master itself instead of remote Salt minions.
.sp
A Salt runner can be a simple client call or a complex application.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%The full list of runners\fP
.UNINDENT
.UNINDENT
.SS Writing Salt Runners
.sp
A Salt runner is written in a similar manner to a Salt execution module.
Both are Python modules which contain functions and each public function
is a runner which may be executed via the \fIsalt\-run\fP command.
.sp
For example, if a Python module named \fBtest.py\fP is created in the runners
directory and contains a function called \fBfoo\fP, the \fBtest\fP runner could be
invoked with the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-run test.foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Runners have several options for controlling output.
.sp
Any \fBprint\fP statement in a runner is automatically also
fired onto the master event bus where. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def a_runner(outputter=None, display_progress=False):
    print(\(dqHello world\(dq)
    ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above would result in an event fired as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Event fired at Tue Jan 13 15:26:45 2015
*************************
Tag: salt/run/20150113152644070246/print
Data:
{\(aq_stamp\(aq: \(aq2015\-01\-13T15:26:45.078707\(aq,
 \(aqdata\(aq: \(aqhello\(aq,
  \(aqoutputter\(aq: \(aqpprint\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A runner may also send a progress event, which is displayed to the user during
runner execution and is also passed across the event bus if the \fBdisplay_progress\fP
argument to a runner is set to True.
.sp
A custom runner may send its own progress event by using the
\fB__jid_event_.fire_event()\fP method as shown here:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
if display_progress:
    __jid_event__.fire_event({\(dqmessage\(dq: \(dqA progress message\(dq}, \(dqprogress\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above would produce output on the console reading: \fBA progress message\fP
as well as an event on the event similar to:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Event fired at Tue Jan 13 15:21:20 2015
*************************
Tag: salt/run/20150113152118341421/progress
Data:
{\(aq_stamp\(aq: \(aq2015\-01\-13T15:21:20.390053\(aq,
 \(aqmessage\(aq: \(dqA progress message\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A runner could use the same approach to send an event with a customized tag
onto the event bus by replacing the second argument (\fBprogress\fP) with
whatever tag is desired. However, this will not be shown on the command\-line
and will only be fired onto the event bus.
.SS Synchronous vs. Asynchronous
.sp
A runner may be fired asynchronously which will immediately return control. In
this case, no output will be display to the user if \fBsalt\-run\fP is being used
from the command\-line. If used programmatically, no results will be returned.
If results are desired, they must be gathered either by firing events on the
bus from the runner and then watching for them or by some other means.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When running a runner in asynchronous mode, the \fB\-\-progress\fP flag will
not deliver output to the salt\-run CLI. However, progress events will
still be fired on the bus.
.UNINDENT
.UNINDENT
.sp
In synchronous mode, which is the default, control will not be returned until
the runner has finished executing.
.sp
To add custom runners, put them in a directory and add it to
\fI\%runner_dirs\fP in the master configuration file.
.SS Examples
.sp
Examples of runners can be found in the Salt distribution:
.sp
\fI\%salt/runners\fP
.sp
A simple runner that returns a well\-formatted list of the minions that are
responding to Salt calls could look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Import salt modules
import salt.client


def up():
    \(dq\(dq\(dq
    Print a list of all of the minions that are up
    \(dq\(dq\(dq
    client = salt.client.LocalClient(__opts__[\(dqconf_file\(dq])
    minions = client.cmd(\(dq*\(dq, \(dqtest.version\(dq, timeout=1)
    for minion in sorted(minions):
        print(minion)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Salt Engines
.sp
New in version 2015.8.0.

.sp
Salt Engines are long\-running, external system processes that leverage Salt.
.INDENT 0.0
.IP \(bu 2
Engines have access to Salt configuration, execution modules, and runners (\fB__opts__\fP, \fB__salt__\fP, and \fB__runners__\fP).
.IP \(bu 2
Engines are executed in a separate process that is monitored by Salt. If a Salt engine stops, it is restarted automatically.
.IP \(bu 2
Engines can run on the Salt master and on Salt minions.
.UNINDENT
.sp
Salt engines enhance and replace the \fI\%external processes\fP functionality.
.SS Configuration
.sp
Salt engines are configured under an \fBengines\fP top\-level section in your Salt master or Salt minion configuration. Provide a list of engines and parameters under this section.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- logstash:
      host: log.my_network.com
      port: 5959
      proto: tcp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.sp
Multiple copies of a particular Salt engine can be configured by including the \fBengine_module\fP parameter in the engine configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- production_logstash:
      host: production_log.my_network.com
      port: 5959
      proto: tcp
      engine_module: logstash
  \- develop_logstash:
      host: develop_log.my_network.com
      port: 5959
      proto: tcp
      engine_module: logstash
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt engines must be in the Salt path, or you can add the \fBengines_dirs\fP option in your Salt master configuration with a list of directories under which Salt attempts to find Salt engines. This option should be formatted as a list of directories to search, such as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines_dirs:
  \- /home/bob/engines
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Writing an Engine
.sp
An example Salt engine, \fI\%salt/engines/test.py\fP, is available in the Salt source. To develop an engine, the only requirement is that your module implement the \fBstart()\fP function.
.SS What is YAML and How To Use It
.sp
The default renderer for SLS files is the YAML renderer.
.SS What is YAML
.sp
What does YAML stand for? It\(aqs an acronym for \fIYAML Ain\(aqt Markup Language\fP\&.
.sp
\fI\%The Official YAML Website\fP defines YAML as:
.INDENT 0.0
.INDENT 3.5
\fI\&...a human friendly data serialization\fP
\fIstandard for all programming languages.\fP
.UNINDENT
.UNINDENT
.sp
However, Salt uses a small subset of YAML that maps over very commonly used data
structures, like lists and dictionaries. It is the job of the YAML renderer to
take the YAML data structure and compile it into a Python data structure for use
by Salt.
.SS Defining YAML
.sp
Though YAML syntax may seem daunting and terse at first, there are only
three very simple rules to remember when writing YAML for SLS files.
.SS Rule One: Indentation
.sp
YAML uses a fixed indentation scheme to represent relationships between
data layers. Salt requires that the indentation for each level consists
of exactly two spaces. Do not use tabs.
.SS Rule Two: Colons
.sp
Python dictionaries are, of course, simply key\-value pairs. Users from other
languages may recognize this data type as hashes or associative arrays.
.sp
Dictionary keys are represented in YAML as strings terminated by a trailing
colon. Values are represented by either a string following the colon,
separated by a space:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_key: my_value
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In Python, the above maps to:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqmy_key\(dq: \(dqmy_value\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternatively, a value can be associated with a key through indentation.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_key:
  my_value
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The above syntax is valid YAML but is uncommon in SLS files because most often,
the value for a key is not singular but instead is a \fIlist\fP of values.
.UNINDENT
.UNINDENT
.sp
In Python, the above maps to:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqmy_key\(dq: \(dqmy_value\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Dictionaries can be nested:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
first_level_dict_key:
  second_level_dict_key: value_in_second_level_dict
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And in Python:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqfirst_level_dict_key\(dq: {\(dqsecond_level_dict_key\(dq: \(dqvalue_in_second_level_dict\(dq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Rule Three: Dashes
.sp
To represent lists of items, a single dash followed by a space is used. Multiple
items are a part of the same list as a function of their having the same level of indentation.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- list_value_one
\- list_value_two
\- list_value_three
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Lists can be the value of a key\-value pair. This is quite common in Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_dictionary:
  \- list_value_one
  \- list_value_two
  \- list_value_three
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In Python, the above maps to:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqmy_dictionary\(dq: [\(dqlist_value_one\(dq, \(dqlist_value_two\(dq, \(dqlist_value_three\(dq]}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Learning more about YAML
.sp
One easy way to learn more about how YAML gets rendered into Python data structures is
to use an online YAML parser to see the Python output.
.sp
Here are some excellent links for experimenting with and referencing YAML:
.INDENT 0.0
.IP \(bu 2
\fI\%Online YAML Parser\fP: Convert YAML
to JSON or Python data structures.
.IP \(bu 2
\fI\%The Official YAML Specification\fP
.IP \(bu 2
\fI\%The Wikipedia page for YAML\fP
.UNINDENT
.SS Templating
.sp
Jinja statements and expressions are allowed by default in SLS files. See
\fI\%Understanding Jinja\fP\&.
.SS Understanding Jinja
.sp
\fI\%Jinja\fP is the default templating language in SLS files.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Jinja\fP supports a \fI\%secure, sandboxed template execution environment\fP that Salt
takes advantage of. Other text \fI\%Renderers\fP do not support this
functionality, so Salt highly recommends usage of \fBjinja\fP / \fBjinja|yaml\fP\&.
.UNINDENT
.UNINDENT
.SS Jinja in States
.sp
Jinja is evaluated before YAML, which means it is evaluated before the States
are run.
.sp
The most basic usage of Jinja in state files is using control structures to
wrap conditional or redundant state elements:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% if grains[\(aqos\(aq] != \(aqFreeBSD\(aq %}
tcsh:
    pkg:
        \- installed
{% endif %}

motd:
  file.managed:
    {% if grains[\(aqos\(aq] == \(aqFreeBSD\(aq %}
    \- name: /etc/motd
    {% elif grains[\(aqos\(aq] == \(aqDebian\(aq %}
    \- name: /etc/motd.tail
    {% endif %}
    \- source: salt://motd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example, the first \fBif\fP block will only be evaluated on minions that
aren\(aqt running FreeBSD, and the second block changes the file name based on the
\fIos\fP grain.
.sp
Writing \fBif\-else\fP blocks can lead to very redundant state files however. In
this case, using \fI\%pillars\fP, or using a previously
defined variable might be easier:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set motd = [\(aq/etc/motd\(aq] %}
{% if grains[\(aqos\(aq] == \(aqDebian\(aq %}
  {% set motd = [\(aq/etc/motd.tail\(aq, \(aq/var/run/motd\(aq] %}
{% endif %}

{% for motdfile in motd %}
{{ motdfile }}:
  file.managed:
    \- source: salt://motd
{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using a variable set by the template, the \fI\%for loop\fP will iterate over the
list of MOTD files to update, adding a state block for each file.
.sp
The filter_by function can also be used to set variables based on grains:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set auditd = salt[\(aqgrains.filter_by\(aq]({
\(aqRedHat\(aq: { \(aqpackage\(aq: \(aqaudit\(aq },
\(aqDebian\(aq: { \(aqpackage\(aq: \(aqauditd\(aq },
}) %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Include and Import
.sp
Includes and \fI\%imports\fP can be used to share common, reusable state configuration
between state files and between files.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% from \(aqlib.sls\(aq import test %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This would import the \fBtest\fP template variable or macro, not the \fBtest\fP
state element, from the file \fBlib.sls\fP\&. In the case that the included file
performs checks against grains, or something else that requires context, passing
the context into the included file is required:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% from \(aqlib.sls\(aq import test with context %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Includes must use full paths, like so:
.sp
spam/eggs.jinja
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
 {% include \(aqspam/foobar.jinja\(aq %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Including Context During Include/Import
.sp
By adding \fBwith context\fP to the include/import directive, the
current context can be passed to an included/imported template.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% import \(aqopenssl/vars.sls\(aq as ssl with context %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Macros
.sp
\fI\%Macros\fP are helpful for eliminating redundant code. Macros are most useful as
mini\-templates to repeat blocks of strings with a few parameterized variables.
Be aware that stripping whitespace from the template block, as well as
contained blocks, may be necessary to emulate a variable return from the macro.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# init.sls
{% from \(aqlib.sls\(aq import pythonpkg with context %}

python\-virtualenv:
  pkg.installed:
    \- name: {{ pythonpkg(\(aqvirtualenv\(aq) }}

python\-fabric:
  pkg.installed:
    \- name: {{ pythonpkg(\(aqfabric\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# lib.sls
{% macro pythonpkg(pkg) \-%}
  {%\- if grains[\(aqos\(aq] == \(aqFreeBSD\(aq \-%}
    py27\-{{ pkg }}
  {%\- elif grains[\(aqos\(aq] == \(aqDebian\(aq \-%}
    python\-{{ pkg }}
  {%\- endif \-%}
{%\- endmacro %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This would define a \fI\%macro\fP that would return a string of the full package name,
depending on the packaging system\(aqs naming convention. The whitespace of the
macro was eliminated, so that the macro would return a string without line
breaks, using \fI\%whitespace control\fP\&.
.SS Template Inheritance
.sp
\fI\%Template inheritance\fP works fine from state files and files. The search path
starts at the root of the state tree or pillar.
.SS Errors
.sp
Saltstack allows raising custom errors using the \fBraise\fP jinja function.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ raise(\(aqCustom Error\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When rendering the template containing the above statement, a \fBTemplateError\fP
exception is raised, causing the rendering to fail with the following message:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
TemplateError: Custom Error
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Filters
.sp
Saltstack extends \fI\%builtin filters\fP with these custom filters:
.SS \fBstrftime\fP
.sp
Converts any time related object into a time based string. It requires valid
strftime directives. An exhaustive list can be found \fI\%here\fP in the Python documentation.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set curtime = None | strftime() %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Fuzzy dates require the \fI\%timelib\fP Python module is installed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(dq2002/12/25\(dq|strftime(\(dq%y\(dq) }}
{{ \(dq1040814000\(dq|strftime(\(dq%Y\-%m\-%d\(dq) }}
{{ datetime|strftime(\(dq%u\(dq) }}
{{ \(dqtomorrow\(dq|strftime }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsequence\fP
.sp
Ensure that parsed data is a sequence.
.SS \fByaml_encode\fP
.sp
Serializes a single object into a YAML scalar with any necessary
handling for escaping special characters.  This will work for any
scalar YAML data type: ints, floats, timestamps, booleans, strings,
unicode.  It will \fInot\fP work for multi\-objects such as sequences or
maps.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set bar = 7 %}
{%\- set baz = none %}
{%\- set zip = true %}
{%\- set zap = \(aqThe word of the day is \(dqsalty\(dq\(aq %}

{%\- load_yaml as foo %}
bar: {{ bar|yaml_encode }}
baz: {{ baz|yaml_encode }}
zip: {{ zip|yaml_encode }}
zap: {{ zap|yaml_encode }}
{%\- endload %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above case \fB{{ bar }}\fP and \fB{{ foo.bar }}\fP should be
identical and \fB{{ baz }}\fP and \fB{{ foo.baz }}\fP should be
identical.
.SS \fByaml_dquote\fP
.sp
Serializes a string into a properly\-escaped YAML double\-quoted
string.  This is useful when the contents of a string are unknown
and may contain quotes or unicode that needs to be preserved.  The
resulting string will be emitted with opening and closing double
quotes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set bar = \(aq\(dqThe quick brown fox . . .\(dq\(aq %}
{%\- set baz = \(aqThe word of the day is \(dqsalty\(dq.\(aq %}

{%\- load_yaml as foo %}
bar: {{ bar|yaml_dquote }}
baz: {{ baz|yaml_dquote }}
{%\- endload %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above case \fB{{ bar }}\fP and \fB{{ foo.bar }}\fP should be
identical and \fB{{ baz }}\fP and \fB{{ foo.baz }}\fP should be
identical.  If variable contents are not guaranteed to be a string
then it is better to use \fByaml_encode\fP which handles all YAML
scalar types.
.SS \fByaml_squote\fP
.sp
Similar to the \fByaml_dquote\fP filter but with single quotes.  Note
that YAML only allows special escapes inside double quotes so
\fByaml_squote\fP is not nearly as useful (viz. you likely want to
use \fByaml_encode\fP or \fByaml_dquote\fP).
.SS \fBdict_to_sls_yaml_params\fP
.sp
New in version 3005.

.sp
Renders a formatted multi\-line YAML string from a Python dictionary. Each
key/value pair in the dictionary will be added as a single\-key dictionary
to a list that will then be sent to the YAML formatter.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set thing_params = {
    \(dqname\(dq: \(dqthing\(dq,
    \(dqchanges\(dq: True,
    \(dqwarnings\(dq: \(dqOMG! Stuff is happening!\(dq
   }
%}

thing:
  test.configurable_test_state:
    {{ thing_params | dict_to_sls_yaml_params | indent }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
thing:
  test.configurable_test_state:
    \- name: thing
    \- changes: true
    \- warnings: OMG! Stuff is happening!
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBto_bool\fP
.sp
New in version 2017.7.0.

.sp
Returns the logical value of an element.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqyes\(aq | to_bool }}
{{ \(aqtrue\(aq | to_bool }}
{{ 1 | to_bool }}
{{ \(aqno\(aq | to_bool }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Will be rendered as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
True
True
True
False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBexactly_n_true\fP
.sp
New in version 2017.7.0.

.sp
Tests that exactly N items in an iterable are \(dqtruthy\(dq (neither None, False, nor 0).
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [\(aqyes\(aq, 0, False, \(aqTrue\(aq] | exactly_n_true(2) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBexactly_one_true\fP
.sp
New in version 2017.7.0.

.sp
Tests that exactly one item in an iterable is \(dqtruthy\(dq (neither None, False, nor 0).
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [\(aqyes\(aq, False, 0, None] | exactly_one_true }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBquote\fP
.sp
New in version 2017.7.0.

.sp
This text will be wrapped in quotes.
.SS \fBregex_search\fP
.sp
New in version 2017.7.0.

.sp
Scan through string looking for a location where this regular expression
produces a match. Returns \fBNone\fP in case there were no matches found
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqabcdefabcdef\(aq | regex_search(\(aqBC(.*)\(aq, ignorecase=True) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(\(dqdefabcdef\(dq,)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBregex_match\fP
.sp
New in version 2017.7.0.

.sp
If zero or more characters at the beginning of string match this regular
expression, otherwise returns \fBNone\fP\&.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqabcdefabcdef\(aq | regex_match(\(aqBC(.*)\(aq, ignorecase=True) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
None
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBregex_replace\fP
.sp
New in version 2017.7.0.

.sp
Searches for a pattern and replaces with a sequence of characters.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set my_text = \(aqyes, this is a TEST\(aq %}
{{ my_text | regex_replace(\(aq ([a\-z])\(aq, \(aq__\e\e1\(aq, ignorecase=True) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
yes,__this__is__a__TEST
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBuuid\fP
.sp
New in version 2017.7.0.

.sp
Return a UUID.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqrandom\(aq | uuid }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
3652b285\-26ad\-588e\-a5dc\-c2ee65edc804
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBis_list\fP
.sp
New in version 2017.7.0.

.sp
Return if an object is list.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [1, 2, 3] | is_list }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBis_iter\fP
.sp
New in version 2017.7.0.

.sp
Return if an object is iterable.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [1, 2, 3] | is_iter }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmin\fP
.sp
New in version 2017.7.0.

.sp
Return the minimum value from a list.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [1, 2, 3] | min }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmax\fP
.sp
New in version 2017.7.0.

.sp
Returns the maximum value from a list.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [1, 2, 3] | max }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
3
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBavg\fP
.sp
New in version 2017.7.0.

.sp
Returns the average value of the elements of a list
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [1, 2, 3] | avg }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
2
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBunion\fP
.sp
New in version 2017.7.0.

.sp
Return the union of two lists.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [1, 2, 3] | union([2, 3, 4]) | join(\(aq, \(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
1, 2, 3, 4
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBintersect\fP
.sp
New in version 2017.7.0.

.sp
Return the intersection of two lists.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [1, 2, 3] | intersect([2, 3, 4]) | join(\(aq, \(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
2, 3
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBdifference\fP
.sp
New in version 2017.7.0.

.sp
Return the difference of two lists.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [1, 2, 3] | difference([2, 3, 4]) | join(\(aq, \(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsymmetric_difference\fP
.sp
New in version 2017.7.0.

.sp
Return the symmetric difference of two lists.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [1, 2, 3] | symmetric_difference([2, 3, 4]) | join(\(aq, \(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
1, 4
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBflatten\fP
.sp
New in version 3005.

.sp
Flatten a list.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [3, [4, 2] ] | flatten }}
# => [3, 4, 2]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Flatten only the first level of a list:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [3, [4, [2]] ] | flatten(levels=1) }}
# => [3, 4, [2]]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Preserve nulls in a list, by default \fBflatten\fP removes them.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [3, None, [4, [2]] ] | flatten(levels=1, preserve_nulls=True) }}
# => [3, None, 4, [2]]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcombinations\fP
.sp
New in version 3005.

.sp
Invokes the \fBcombinations\fP function from the \fBitertools\fP library.
.sp
See the \fI\%itertools documentation\fP for more information.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% for one, two in \(dqABCD\(dq | combinations(2) %}{{ one~two }} {% endfor %}
# => AB AC AD BC BD CD
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcombinations_with_replacement\fP
.sp
New in version 3005.

.sp
Invokes the \fBcombinations_with_replacement\fP function from the \fBitertools\fP library.
.sp
See the \fI\%itertools documentation\fP for more information.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% for one, two in \(dqABC\(dq | combinations_with_replacement(2) %}{{ one~two }} {% endfor %}
# => AA AB AC BB BC CC
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcompress\fP
.sp
New in version 3005.

.sp
Invokes the \fBcompress\fP function from the \fBitertools\fP library.
.sp
See the \fI\%itertools documentation\fP for more information.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% for val in \(dqABCDEF\(dq | compress([1,0,1,0,1,1]) %}{{ val }} {% endfor %}
# => A C E F
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpermutations\fP
.sp
New in version 3005.

.sp
Invokes the \fBpermutations\fP function from the \fBitertools\fP library.
.sp
See the \fI\%itertools documentation\fP for more information.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% for one, two in \(dqABCD\(dq | permutations(2) %}{{ one~two }} {% endfor %}
# => AB AC AD BA BC BD CA CB CD DA DB DC
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBproduct\fP
.sp
New in version 3005.

.sp
Invokes the \fBproduct\fP function from the \fBitertools\fP library.
.sp
See the \fI\%itertools documentation\fP for more information.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% for one, two in \(dqABCD\(dq | product(\(dqxy\(dq) %}{{ one~two }} {% endfor %}
# => Ax Ay Bx By Cx Cy Dx Dy
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBzip\fP
.sp
New in version 3005.

.sp
Invokes the native Python \fBzip\fP function.
.sp
The \fBzip\fP function returns a zip object, which is an iterator of tuples where
the first item in each passed iterator is paired together, and then the second
item in each passed iterator are paired together etc.
.sp
If the passed iterators have different lengths, the iterator with the least
items decides the length of the new iterator.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% for one, two in \(dqABCD\(dq | zip(\(dqxy\(dq) %}{{ one~two }} {% endfor %}
# => Ax By
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBzip_longest\fP
.sp
New in version 3005.

.sp
Invokes the \fBzip_longest\fP function from the \fBitertools\fP library.
.sp
See the \fI\%itertools documentation\fP for more information.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% for one, two in \(dqABCD\(dq | zip_longest(\(dqxy\(dq, fillvalue=\(dq\-\(dq) %}{{ one~two }} {% endfor %}
# => Ax By C\- D\-
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmethod_call\fP
.sp
New in version 3001.

.sp
Returns a result of object\(aqs method call.
.sp
Example #1:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [1, 2, 1, 3, 4] | method_call(\(aqindex\(aq, 1, 1, 3) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This filter can be used with the \fI\%map filter\fP to apply object methods without
using loop constructs or temporary variables.
.sp
Example #2:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set host_list = [\(aqweb01.example.com\(aq, \(aqdb01.example.com\(aq] %}
{% set host_list_split = [] %}
{% for item in host_list %}
  {% do host_list_split.append(item.split(\(aq.\(aq, 1)) %}
{% endfor %}
{{ host_list_split }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example #3:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ host_list|map(\(aqmethod_call\(aq, \(aqsplit\(aq, \(aq.\(aq, 1)|list }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Return of examples #2 and #3:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[[web01, example.com], [db01, example.com]]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBis_sorted\fP
.sp
New in version 2017.7.0.

.sp
Return \fBTrue\fP if an iterable object is already sorted.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [1, 2, 3] | is_sorted }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcompare_lists\fP
.sp
New in version 2017.7.0.

.sp
Compare two lists and return a dictionary with the changes.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [1, 2, 3] | compare_lists([1, 2, 4]) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqnew\(dq: [4], \(dqold\(dq: [3]}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcompare_dicts\fP
.sp
New in version 2017.7.0.

.sp
Compare two dictionaries and return a dictionary with the changes.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ {\(aqa\(aq: \(aqb\(aq} | compare_dicts({\(aqa\(aq: \(aqc\(aq}) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqa\(dq: {\(dqnew\(dq: \(dqc\(dq, \(dqold\(dq: \(dqb\(dq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBis_hex\fP
.sp
New in version 2017.7.0.

.sp
Return \fBTrue\fP if the value is hexadecimal.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq0xabcd\(aq | is_hex }}
{{ \(aqxyzt\(aq | is_hex }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
True
False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcontains_whitespace\fP
.sp
New in version 2017.7.0.

.sp
Return \fBTrue\fP if a text contains whitespaces.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqabcd\(aq | contains_whitespace }}
{{ \(aqab cd\(aq | contains_whitespace }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
False
True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsubstring_in_list\fP
.sp
New in version 2017.7.0.

.sp
Return \fBTrue\fP if a substring is found in a list of string values.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqabcd\(aq | substring_in_list([\(aqthis\(aq, \(aqis\(aq, \(aqan abcd example\(aq]) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBcheck_whitelist_blacklist\fP
.sp
New in version 2017.7.0.

.sp
Check a whitelist and/or blacklist to see if the value matches it.
.sp
This filter can be used with either a whitelist or a blacklist individually,
or a whitelist and a blacklist can be passed simultaneously.
.sp
If whitelist is used alone, value membership is checked against the
whitelist only. If the value is found, the function returns \fBTrue\fP\&.
Otherwise, it returns \fBFalse\fP\&.
.sp
If blacklist is used alone, value membership is checked against the
blacklist only. If the value is found, the function returns \fBFalse\fP\&.
Otherwise, it returns \fBTrue\fP\&.
.sp
If both a whitelist and a blacklist are provided, value membership in the
blacklist will be examined first. If the value is not found in the blacklist,
then the whitelist is checked. If the value isn\(aqt found in the whitelist,
the function returns \fBFalse\fP\&.
.sp
Whitelist Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ 5 | check_whitelist_blacklist(whitelist=[5, 6, 7]) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Blacklist Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ 5 | check_whitelist_blacklist(blacklist=[5, 6, 7]) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBdate_format\fP
.sp
New in version 2017.7.0.

.sp
Converts unix timestamp into human\-readable string.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ 1457456400 | date_format }}
{{ 1457456400 | date_format(\(aq%d.%m.%Y %H:%M\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
2017\-03\-08
08.03.2017 17:00
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBto_num\fP
.sp
New in version 2017.7.0.

.sp
New in version 2018.3.0: Renamed from \fBstr_to_num\fP to \fBto_num\fP\&.

.sp
Converts a string to its numerical value.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq5\(aq | to_num }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
5
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBto_bytes\fP
.sp
New in version 2017.7.0.

.sp
Converts string\-type object to bytes.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqwall of text\(aq | to_bytes }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This option may have adverse effects when using the default renderer,
\fBjinja|yaml\fP\&. This is due to the fact that YAML requires proper handling
in regard to special characters. Please see the section on \fI\%YAML ASCII
support\fP in the \fI\%YAML Idiosyncrasies\fP documentation for more information.
.UNINDENT
.UNINDENT
.SS \fBjson_encode_list\fP
.sp
New in version 2017.7.0.

.sp
New in version 2018.3.0: Renamed from \fBjson_decode_list\fP to \fBjson_encode_list\fP\&. When you encode
something you get bytes, and when you decode, you get your locale\(aqs
encoding (usually a \fBunicode\fP type). This filter was incorrectly\-named
when it was added. \fBjson_decode_list\fP will be supported until the 3003
release.

.sp
Deprecated since version 2018.3.3,2019.2.0: The \fI\%tojson\fP filter accomplishes what this filter was designed
to do, making this filter redundant.

.sp
Recursively encodes all string elements of the list to bytes.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [1, 2, 3] | json_encode_list }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[1, 2, 3]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBjson_encode_dict\fP
.sp
New in version 2017.7.0.

.sp
New in version 2018.3.0: Renamed from \fBjson_decode_dict\fP to \fBjson_encode_dict\fP\&. When you encode
something you get bytes, and when you decode, you get your locale\(aqs
encoding (usually a \fBunicode\fP type). This filter was incorrectly\-named
when it was added. \fBjson_decode_dict\fP will be supported until the 3003
release.

.sp
Deprecated since version 2018.3.3,2019.2.0: The \fI\%tojson\fP filter accomplishes what this filter was designed
to do, making this filter redundant.

.sp
Recursively encodes all string items in the dictionary to bytes.
.sp
Example:
.sp
Assuming that \fBpillar[\(aqfoo\(aq]\fP contains \fB{u\(aqa\(aq: u\(aq\eu0414\(aq}\fP, and your locale
is \fBen_US.UTF\-8\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ pillar[\(aqfoo\(aq] | json_encode_dict }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqa\(dq: \(dq\exd0\ex94\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtojson\fP
.sp
New in version 2018.3.3,2019.2.0.

.sp
Dumps a data structure to JSON.
.sp
This filter was added to provide this functionality to hosts which have a
Jinja release older than version 2.9 installed. If Jinja 2.9 or newer is
installed, then the upstream version of the filter will be used. See the
\fI\%upstream docs\fP for more information.
.SS \fBrandom_hash\fP
.sp
New in version 2017.7.0.

.sp
New in version 2018.3.0: Renamed from \fBrand_str\fP to \fBrandom_hash\fP to more accurately describe
what the filter does. \fBrand_str\fP will be supported to ensure backwards
compatibility but please use the preferred \fBrandom_hash\fP\&.

.sp
Generates a random number between 1 and the number passed to the filter, and
then hashes it. The default hash type is the one specified by the minion\(aqs
\fI\%hash_type\fP config option, but an alternate hash type can be
passed to the filter as an argument.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set num_range = 99999999 %}
{{ num_range | random_hash }}
{{ num_range | random_hash(\(aqsha512\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
43ec517d68b6edd3015b3edc9a11367b
d94a45acd81f8e3107d237dbc0d5d195f6a52a0d188bc0284c0763ece1eac9f9496fb6a531a296074c87b3540398dace1222b42e150e67c9301383fde3d66ae5
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrandom_sample\fP
.sp
New in version 3005.

.sp
Returns a given sample size from a list. The \fBseed\fP parameter can be used to
return a predictable outcome.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set my_list = [\(dqone\(dq, \(dqtwo\(dq, \(dqthree\(dq, \(dqfour\(dq] %}
{{ my_list | random_sample(2) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[\(dqfour\(dq, \(dqone\(dq]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBrandom_shuffle\fP
.sp
New in version 3005.

.sp
Returns a shuffled copy of an input list. The \fBseed\fP parameter can be used to
return a predictable outcome.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set my_list = [\(dqone\(dq, \(dqtwo\(dq, \(dqthree\(dq, \(dqfour\(dq] %}
{{ my_list | random_shuffle }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[\(dqfour\(dq, \(dqthree\(dq, \(dqone\(dq, \(dqtwo\(dq]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBset_dict_key_value\fP
.sp
New in version 3000.

.sp
Allows you to set a value in a nested dictionary without having to worry if all the nested keys actually exist.
Missing keys will be automatically created if they do not exist.
The default delimiter for the keys is \(aq:\(aq, however, with the \fIdelimiter\fP\-parameter, a different delimiter can be specified.
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B Example 1:
{%\- set foo = {} %}
{{ foo | set_dict_key_value(\(aqbar:baz\(aq, 42) }}
.TP
.B Example 2:
{{ {} | set_dict_key_value(\(aqbar.baz.qux\(aq, 42, delimiter=\(aq.\(aq) }}
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B Example 1:
{\(aqbar\(aq: {\(aqbaz\(aq: 42}}
.TP
.B Example 2:
{\(aqbar\(aq: {\(aqbaz\(aq: {\(aqqux\(aq: 42}}}
.UNINDENT
.SS \fBappend_dict_key_value\fP
.sp
New in version 3000.

.sp
Allows you to append to a list nested (deep) in a dictionary without having to worry if all the nested keys (or the list itself) actually exist.
Missing keys will automatically be created if they do not exist.
The default delimiter for the keys is \(aq:\(aq, however, with the \fIdelimiter\fP\-parameter, a different delimiter can be specified.
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B Example 1:
{%\- set foo = {\(aqbar\(aq: {\(aqbaz\(aq: [1, 2]}} %}
{{ foo | append_dict_key_value(\(aqbar:baz\(aq, 42) }}
.TP
.B Example 2:
{%\- set foo = {} %}
{{ foo | append_dict_key_value(\(aqbar:baz:qux\(aq, 42) }}
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B Example 1:
{\(aqbar\(aq: {\(aqbaz\(aq: [1, 2, 42]}}
.TP
.B Example 2:
{\(aqbar\(aq: {\(aqbaz\(aq: {\(aqqux\(aq: [42]}}}
.UNINDENT
.SS \fBextend_dict_key_value\fP
.sp
New in version 3000.

.sp
Allows you to extend a list nested (deep) in a dictionary without having to worry if all the nested keys (or the list itself) actually exist.
Missing keys will automatically be created if they do not exist.
The default delimiter for the keys is \(aq:\(aq, however, with the \fIdelimiter\fP\-parameter, a different delimiter can be specified.
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B Example 1:
{%\- set foo = {\(aqbar\(aq: {\(aqbaz\(aq: [1, 2]}} %}
{{ foo | extend_dict_key_value(\(aqbar:baz\(aq, [42, 42]) }}
.TP
.B Example 2:
{{ {} | extend_dict_key_value(\(aqbar:baz:qux\(aq, [42]) }}
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B Example 1:
{\(aqbar\(aq: {\(aqbaz\(aq: [1, 2, 42, 42]}}
.TP
.B Example 2:
{\(aqbar\(aq: {\(aqbaz\(aq: {\(aqqux\(aq: [42]}}}
.UNINDENT
.SS \fBupdate_dict_key_value\fP
.sp
New in version 3000.

.sp
Allows you to update a dictionary nested (deep) in another dictionary without having to worry if all the nested keys actually exist.
Missing keys will automatically be created if they do not exist.
The default delimiter for the keys is \(aq:\(aq, however, with the \fIdelimiter\fP\-parameter, a different delimiter can be specified.
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B Example 1:
{%\- set foo = {\(aqbar\(aq: {\(aqbaz\(aq: {\(aqqux\(aq: 1}}} %}
{{ foo | update_dict_key_value(\(aqbar:baz\(aq, {\(aqquux\(aq: 3}) }}
.TP
.B Example 2:
{{ {} | update_dict_key_value(\(aqbar:baz:qux\(aq, {\(aqquux\(aq: 3}) }}
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B Example 1:
{\(aqbar\(aq: {\(aqbaz\(aq: {\(aqqux\(aq: 1, \(aqquux\(aq: 3}}}
.TP
.B Example 2:
{\(aqbar\(aq: {\(aqbaz\(aq: {\(aqqux\(aq: {\(aqquux\(aq: 3}}}}
.UNINDENT
.SS \fBmd5\fP
.sp
New in version 2017.7.0.

.sp
Return the md5 digest of a string.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqrandom\(aq | md5 }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
7ddf32e17a6ac5ce04a8ecbf782ca509
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsha256\fP
.sp
New in version 2017.7.0.

.sp
Return the sha256 digest of a string.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqrandom\(aq | sha256 }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
a441b15fe9a3cf56661190a0b93b9dec7d04127288cc87250967cf3b52894d11
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBsha512\fP
.sp
New in version 2017.7.0.

.sp
Return the sha512 digest of a string.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqrandom\(aq | sha512 }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
811a90e1c8e86c7b4c0eef5b2c0bf0ec1b19c4b1b5a242e6455be93787cb473cb7bc9b0fdeb960d00d5c6881c2094dd63c5c900ce9057255e2a4e271fc25fef1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBbase64_encode\fP
.sp
New in version 2017.7.0.

.sp
Encode a string as base64.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqrandom\(aq | base64_encode }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cmFuZG9t
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBbase64_decode\fP
.sp
New in version 2017.7.0.

.sp
Decode a base64\-encoded string.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqZ2V0IHNhbHRlZA==\(aq | base64_decode }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
get salted
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBhmac\fP
.sp
New in version 2017.7.0.

.sp
Verify a challenging hmac signature against a string / shared\-secret. Returns
a boolean value.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqget salted\(aq | hmac(\(aqshared secret\(aq, \(aqeBWf9bstXg+NiP5AOwppB5HMvZiYMPzEM9W5YMm/AmQ=\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBhttp_query\fP
.sp
New in version 2017.7.0.

.sp
Return the HTTP reply object from a URL.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqhttp://jsonplaceholder.typicode.com/posts/1\(aq | http_query }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
  \(aqbody\(aq: \(aq{
    \(dquserId\(dq: 1,
    \(dqid\(dq: 1,
    \(dqtitle\(dq: \(dqsunt aut facere repellat provident occaecati excepturi option reprehenderit\(dq,
    \(dqbody\(dq: \(dqquia et suscipit\e\ensuscipit recusandae consequuntur expedita et cum\e\enreprehenderit molestiae ut ut quas totam\e\ennostrum rerum est autem sunt rem eveniet architecto\(dq
  }\(aq
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBtraverse\fP
.sp
New in version 2018.3.3.

.sp
Traverse a dict or list using a colon\-delimited target string.
The target \(aqfoo:bar:0\(aq will return data[\(aqfoo\(aq][\(aqbar\(aq][0] if this value exists,
and will otherwise return the provided default value.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ {\(aqa1\(aq: {\(aqb1\(aq: {\(aqc1\(aq: \(aqfoo\(aq}}, \(aqa2\(aq: \(aqbar\(aq} | traverse(\(aqa1:b1\(aq, \(aqdefault\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqc1\(dq: \(dqfoo\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ {\(aqa1\(aq: {\(aqb1\(aq: {\(aqc1\(aq: \(aqfoo\(aq}}, \(aqa2\(aq: \(aqbar\(aq} | traverse(\(aqa2:b2\(aq, \(aqdefault\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(dqdefault\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBjson_query\fP
.sp
New in version 3000.

.sp
A port of Ansible \fBjson_query\fP Jinja filter to make queries against JSON data using \fI\%JMESPath language\fP\&.
Could be used to filter \fBpillar\fP data, \fByaml\fP maps, and together with \fI\%http_query\fP\&.
Depends on the \fI\%jmespath\fP Python module.
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Example 1: {{ [1, 2, 3, 4, [5, 6]] | json_query(\(aq[]\(aq) }}

Example 2: {{
{\(dqmachines\(dq: [
  {\(dqname\(dq: \(dqa\(dq, \(dqstate\(dq: \(dqrunning\(dq},
  {\(dqname\(dq: \(dqb\(dq, \(dqstate\(dq: \(dqstopped\(dq},
  {\(dqname\(dq: \(dqc\(dq, \(dqstate\(dq: \(dqrunning\(dq}
]} | json_query(\(dqmachines[?state==\(aqrunning\(aq].name\(dq) }}

Example 3: {{
{\(dqservices\(dq: [
  {\(dqname\(dq: \(dqhttp\(dq, \(dqhost\(dq: \(dq1.2.3.4\(dq, \(dqport\(dq: 80},
  {\(dqname\(dq: \(dqsmtp\(dq, \(dqhost\(dq: \(dq1.2.3.5\(dq, \(dqport\(dq: 25},
  {\(dqname\(dq: \(dqssh\(dq,  \(dqhost\(dq: \(dq1.2.3.6\(dq, \(dqport\(dq: 22},
]} | json_query(\(dqservices[].port\(dq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Example 1: [1, 2, 3, 4, 5, 6]

Example 2: [\(aqa\(aq, \(aqc\(aq]

Example 3: [80, 25, 22]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBto_entries\fP
.sp
New in version 3007.0.

.sp
A port of the \fBto_entries\fP function from \fBjq\fP\&. This function converts between an object and an array of key\-value
pairs. If \fBto_entries\fP is passed an object, then for each \fBk: v\fP entry in the input, the output array includes
\fB{\(dqkey\(dq: k, \(dqvalue\(dq: v}\fP\&. The \fBfrom_entries\fP function performs the opposite conversion. \fBfrom_entries\fP accepts
\(dqkey\(dq, \(dqKey\(dq, \(dqname\(dq, \(dqName\(dq, \(dqvalue\(dq, and \(dqValue\(dq as keys.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ {\(dqa\(dq: 1, \(dqb\(dq: 2} | to_entries }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[{\(dqkey\(dq:\(dqa\(dq, \(dqvalue\(dq:1}, {\(dqkey\(dq:\(dqb\(dq, \(dqvalue\(dq:2}]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfrom_entries\fP
.sp
New in version 3007.0.

.sp
A port of the \fBfrom_entries\fP function from \fBjq\fP\&. This function converts between an array of key\-value pairs and an
object. If \fBfrom_entries\fP is passed an object, then the input is expected to be an array of dictionaries in the format
of \fB{\(dqkey\(dq: k, \(dqvalue\(dq: v}\fP\&. The output will be be key\-value pairs \fBk: v\fP\&. \fBfrom_entries\fP accepts \(dqkey\(dq, \(dqKey\(dq,
\(dqname\(dq, \(dqName\(dq, \(dqvalue\(dq, and \(dqValue\(dq as keys.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [{\(dqkey\(dq:\(dqa\(dq, \(dqvalue\(dq:1}, {\(dqkey\(dq:\(dqb\(dq, \(dqvalue\(dq:2}] | from_entries }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqa\(dq: 1, \(dqb\(dq: 2}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBto_snake_case\fP
.sp
New in version 3000.

.sp
Converts a string from camelCase (or CamelCase) to snake_case.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Example: {{ camelsWillLoveThis | to_snake_case }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Example: camels_will_love_this
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBto_camelcase\fP
.sp
New in version 3000.

.sp
Converts a string from snake_case to camelCase (or UpperCamelCase if so indicated).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Example 1: {{ snake_case_for_the_win | to_camelcase }}

Example 2: {{ snake_case_for_the_win | to_camelcase(uppercamel=True) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Example 1: snakeCaseForTheWin
Example 2: SnakeCaseForTheWin
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBhuman_to_bytes\fP
.sp
New in version 3005.

.sp
Given a human\-readable byte string (e.g. 2G, 30MB, 64KiB), return the number of bytes.
Will return 0 if the argument has unexpected form.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Example 1: {{ \(dq32GB\(dq | human_to_bytes }}

Example 2: {{ \(dq32GB\(dq | human_to_bytes(handle_metric=True) }}

Example 3: {{ \(dq32\(dq | human_to_bytes(default_unit=\(dqGiB\(dq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Example 1: 34359738368
Example 2: 32000000000
Example 3: 34359738368
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Networking Filters
.sp
The following networking\-related filters are supported:
.SS \fBis_ip\fP
.sp
New in version 2017.7.0.

.sp
Return if a string is a valid IP Address.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq192.168.0.1\(aq | is_ip }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Additionally accepts the following options:
.INDENT 0.0
.IP \(bu 2
global
.IP \(bu 2
link\-local
.IP \(bu 2
loopback
.IP \(bu 2
multicast
.IP \(bu 2
private
.IP \(bu 2
public
.IP \(bu 2
reserved
.IP \(bu 2
site\-local
.IP \(bu 2
unspecified
.UNINDENT
.sp
Example \- test if a string is a valid loopback IP address.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq192.168.0.1\(aq | is_ip(options=\(aqloopback\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBis_ipv4\fP
.sp
New in version 2017.7.0.

.sp
Returns if a string is a valid IPv4 address. Supports the same options
as \fBis_ip\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq192.168.0.1\(aq | is_ipv4 }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBis_ipv6\fP
.sp
New in version 2017.7.0.

.sp
Returns if a string is a valid IPv6 address. Supports the same options
as \fBis_ip\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqfe80::\(aq | is_ipv6 }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBipaddr\fP
.sp
New in version 2017.7.0.

.sp
From a list, returns only valid IP entries. Supports the same options
as \fBis_ip\fP\&. The list can contains also IP interfaces/networks.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [\(aq192.168.0.1\(aq, \(aqfoo\(aq, \(aqbar\(aq, \(aqfe80::\(aq] | ipaddr }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[\(dq192.168.0.1\(dq, \(dqfe80::\(dq]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBipv4\fP
.sp
New in version 2017.7.0.

.sp
From a list, returns only valid IPv4 entries. Supports the same options
as \fBis_ip\fP\&. The list can contains also IP interfaces/networks.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [\(aq192.168.0.1\(aq, \(aqfoo\(aq, \(aqbar\(aq, \(aqfe80::\(aq] | ipv4 }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[\(dq192.168.0.1\(dq]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBipv6\fP
.sp
New in version 2017.7.0.

.sp
From a list, returns only valid IPv6 entries. Supports the same options
as \fBis_ip\fP\&. The list can contains also IP interfaces/networks.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [\(aq192.168.0.1\(aq, \(aqfoo\(aq, \(aqbar\(aq, \(aqfe80::\(aq] | ipv6 }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[\(dqfe80::\(dq]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBipwrap\fP
.sp
New in version 3006.0.

.sp
From a string, list, or tuple, returns any IPv6 addresses wrapped in square brackets([])
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [\(aq192.0.2.1\(aq, \(aqfoo\(aq, \(aqbar\(aq, \(aqfe80::\(aq, \(aq2001:db8::1/64\(aq] | ipwrap }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[\(dq192.0.2.1\(dq, \(dqfoo\(dq, \(dqbar\(dq, \(dq[fe80::]\(dq, \(dq[2001:db8::1]/64\(dq]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBnetwork_hosts\fP
.sp
New in version 2017.7.0.

.sp
Return the list of hosts within a networks. This utility works for both IPv4 and IPv6.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When running this command with a large IPv6 network, the command will
take a long time to gather all of the hosts.
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq192.168.0.1/30\(aq | network_hosts }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[\(dq192.168.0.1\(dq, \(dq192.168.0.2\(dq]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBnetwork_size\fP
.sp
New in version 2017.7.0.

.sp
Return the size of the network. This utility works for both IPv4 and IPv6.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq192.168.0.1/8\(aq | network_size }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
16777216
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBgen_mac\fP
.sp
New in version 2017.7.0.

.sp
Generates a MAC address with the defined OUI prefix.
.sp
Common prefixes:
.INDENT 0.0
.IP \(bu 2
\fB00:16:3E\fP \-\- Xen
.IP \(bu 2
\fB00:18:51\fP \-\- OpenVZ
.IP \(bu 2
\fB00:50:56\fP \-\- VMware (manually generated)
.IP \(bu 2
\fB52:54:00\fP \-\- QEMU/KVM
.IP \(bu 2
\fBAC:DE:48\fP \-\- PRIVATE
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq00:50\(aq | gen_mac }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
00:50:71:52:1C
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmac_str_to_bytes\fP
.sp
New in version 2017.7.0.

.sp
Converts a string representing a valid MAC address to bytes.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq00:11:22:33:44:55\(aq | mac_str_to_bytes }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This option may have adverse effects when using the default renderer,
\fBjinja|yaml\fP\&. This is due to the fact that YAML requires proper handling
in regard to special characters. Please see the section on \fI\%YAML ASCII
support\fP in the \fI\%YAML Idiosyncrasies\fP documentation for more information.
.UNINDENT
.UNINDENT
.SS \fBdns_check\fP
.sp
New in version 2017.7.0.

.sp
Return the ip resolved by dns, but do not exit on failure, only raise an
exception. Obeys system preference for IPv4/6 address resolution.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqwww.google.com\(aq | dns_check(port=443) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(aq172.217.3.196\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS File filters
.SS \fBis_text_file\fP
.sp
New in version 2017.7.0.

.sp
Return if a file is text.
.sp
Uses heuristics to guess whether the given file is text or binary,
by reading a single block of bytes from the file.
If more than 30% of the chars in the block are non\-text, or there
are NUL (\(aqx00\(aq) bytes in the block, assume this is a binary file.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq/etc/salt/master\(aq | is_text_file }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBis_binary_file\fP
.sp
New in version 2017.7.0.

.sp
Return if a file is binary.
.sp
Detects if the file is a binary, returns bool. Returns True if the file is
a bin, False if the file is not and None if the file is not available.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq/etc/salt/master\(aq | is_binary_file }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBis_empty_file\fP
.sp
New in version 2017.7.0.

.sp
Return if a file is empty.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq/etc/salt/master\(aq | is_empty_file }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBfile_hashsum\fP
.sp
New in version 2017.7.0.

.sp
Return the hashsum of a file.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq/etc/salt/master\(aq | file_hashsum }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
02d4ef135514934759634f10079653252c7ad594ea97bd385480c532bca0fdda
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlist_files\fP
.sp
New in version 2017.7.0.

.sp
Return a recursive list of files under a specific path.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq/etc/salt/\(aq | list_files | join(\(aq\en\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/salt/master
/etc/salt/proxy
/etc/salt/minion
/etc/salt/pillar/top.sls
/etc/salt/pillar/device1.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBpath_join\fP
.sp
New in version 2017.7.0.

.sp
Joins absolute paths.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq/etc/salt/\(aq | path_join(\(aqpillar\(aq, \(aqdevice1.sls\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/salt/pillar/device1.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBwhich\fP
.sp
New in version 2017.7.0.

.sp
Python clone of /usr/bin/which.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqsalt\-master\(aq | which }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/usr/local/salt/virtualenv/bin/salt\-master
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Tests
.sp
Saltstack extends \fI\%builtin tests\fP with these custom tests:
.SS \fBequalto\fP
.sp
Tests the equality between two values.
.sp
Can be used in an \fBif\fP statement directly:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% if 1 is equalto(1) %}
    < statements >
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If clause evaluates to \fBTrue\fP
.sp
or with the \fBselectattr\fP filter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [{\(aqvalue\(aq: 1}, {\(aqvalue\(aq: 2} , {\(aqvalue\(aq: 3}] | selectattr(\(aqvalue\(aq, \(aqequalto\(aq, 3) | list }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[{\(dqvalue\(dq: 3}]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBmatch\fP
.sp
Tests that a string matches the regex passed as an argument.
.sp
Can be used in a \fBif\fP statement directly:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% if \(aqa\(aq is match(\(aq[a\-b]\(aq) %}
    < statements >
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If clause evaluates to \fBTrue\fP
.sp
or with the \fBselectattr\fP filter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ [{\(aqvalue\(aq: \(aqa\(aq}, {\(aqvalue\(aq: \(aqb\(aq}, {\(aqvalue\(aq: \(aqc\(aq}] | selectattr(\(aqvalue\(aq, \(aqmatch\(aq, \(aq[b\-e]\(aq) | list }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[{\(dqvalue\(dq: \(dqb\(dq}, {\(dqvalue\(dq: \(dqc\(dq}]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Test supports additional optional arguments: \fBignorecase\fP, \fBmultiline\fP
.SS Escape filters
.SS \fBregex_escape\fP
.sp
New in version 2017.7.0.

.sp
Allows escaping of strings so they can be interpreted literally by another function.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
regex_escape = {{ \(aqhttps://example.com?foo=bar%20baz\(aq | regex_escape }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will be rendered as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
regex_escape = https\e:\e/\e/example\e.com\e?foo\e=bar\e%20baz
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Set Theory Filters
.SS \fBunique\fP
.sp
New in version 2017.7.0.

.sp
Performs set math using Jinja filters.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
unique = {{ [\(aqfoo\(aq, \(aqfoo\(aq, \(aqbar\(aq] | unique }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will be rendered as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
unique = [\(aqfoo\(aq, \(aqbar\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Global Functions
.sp
Salt Project extends \fI\%builtin global functions\fP with these custom global functions:
.SS \fBifelse\fP
.sp
Evaluate each pair of arguments up to the last one as a (matcher, value)
tuple, returning \fBvalue\fP if matched.  If none match, returns the last
argument.
.sp
The \fBifelse\fP function is like a multi\-level if\-else statement. It was
inspired by CFEngine\(aqs \fBifelse\fP function which in turn was inspired by
Oracle\(aqs \fBDECODE\fP function. It must have an odd number of arguments (from
1 to N). The last argument is the default value, like the \fBelse\fP clause in
standard programming languages. Every pair of arguments before the last one
are evaluated as a pair. If the first one evaluates true then the second one
is returned, as if you had used the first one in a compound match
expression. Boolean values can also be used as the first item in a pair, as it
will be translated to a match that will always match (\(dq*\(dq) or never match
(\(dqSALT_IFELSE_MATCH_NOTHING\(dq) a target system.
.sp
This is essentially another way to express the \fBmatch.filter_by\fP functionality
in way that\(aqs familiar to CFEngine or Oracle users. Consider using
\fBmatch.filter_by\fP unless this function fits your workflow.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ ifelse(\(aqfoo*\(aq, \(aqfooval\(aq, \(aqbar*\(aq, \(aqbarval\(aq, \(aqdefaultval\(aq, minion_id=\(aqbar03\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Jinja in Files
.sp
\fI\%Jinja\fP can be used in the same way in managed files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# redis.sls
/etc/redis/redis.conf:
    file.managed:
        \- source: salt://redis.conf
        \- template: jinja
        \- context:
            bind: 127.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# lib.sls
{% set port = 6379 %}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# redis.conf
{% from \(aqlib.sls\(aq import port with context %}
port {{ port }}
bind {{ bind }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As an example, configuration was pulled from the file context and from an
external template file.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Macros and variables can be shared across templates. They should not start
with one or more underscores, and should be managed by one of the
following tags: \fImacro\fP, \fIset\fP, \fIload_yaml\fP, \fIload_json\fP, \fIimport_yaml\fP and
\fIimport_json\fP\&.
.UNINDENT
.UNINDENT
.SS Escaping Jinja
.sp
Occasionally, it may be necessary to escape Jinja syntax. There are two ways
to do this in Jinja. One is escaping individual variables or strings and the
other is to escape entire blocks.
.sp
To escape a string commonly used in Jinja syntax such as \fB{{\fP, you can use the
following syntax:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aq{{\(aq }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For larger blocks that contain Jinja syntax that needs to be escaped, you can use
raw blocks:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% raw %}
    some text that contains jinja characters that need to be escaped
{% endraw %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See the \fI\%Escaping\fP section of Jinja\(aqs documentation to learn more.
.sp
A real\-word example of needing to use raw tags to escape a larger block of code
is when using \fBfile.managed\fP with the \fBcontents_pillar\fP option to manage
files that contain something like consul\-template, which shares a syntax subset
with Jinja. Raw blocks are necessary here because the Jinja in the pillar would
be rendered before the file.managed is ever called, so the Jinja syntax must be
escaped:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% raw %}
\- contents_pillar: |
    job \(dqexample\-job\(dq {
      <snipped>
      task \(dqexample\(dq {
          driver = \(dqdocker\(dq

          config {
              image = \(dqdocker\-registry.service.consul:5000/example\-job:{{key \(dqnomad/jobs/example\-job/version\(dq}}\(dq
      <snipped>
{% endraw %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Calling Salt Functions
.sp
The Jinja renderer provides a shorthand lookup syntax for the \fBsalt\fP
dictionary of \fI\%execution function\fP\&.
.sp
New in version 2014.7.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# The following two function calls are equivalent.
{{ salt[\(aqcmd.run\(aq](\(aqwhoami\(aq) }}
{{ salt.cmd.run(\(aqwhoami\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Debugging
.sp
The \fBshow_full_context\fP function can be used to output all variables present
in the current Jinja context.
.sp
New in version 2014.7.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Context is: {{ show_full_context()|yaml(False) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Logs
.sp
New in version 2017.7.0.

.sp
Yes, in Salt, one is able to debug a complex Jinja template using the logs.
For example, making the call:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- do salt.log.error(\(aqtesting jinja logging\(aq) \-%}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Will insert the following message in the minion logs:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
2017\-02\-01 01:24:40,728 [salt.module.logmod][ERROR   ][3779] testing jinja logging
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Profiling
.sp
New in version 3002.

.sp
When working with a very large codebase, it becomes increasingly imperative to
trace inefficiencies with state and pillar render times.  The \fIprofile\fP jinja
block enables the user to get finely detailed information on the most expensive
areas in the codebase.
.SS Profiling blocks
.sp
Any block of jinja code can be wrapped in a \fBprofile\fP block.  The syntax for
a profile block is \fB{% profile as \(aq<name>\(aq %}<jinja code>{% endprofile %}\fP,
where \fB<name>\fP can be any string.  The \fB<name>\fP token will appear in the
log at the \fBprofile\fP level along with the render time of the block.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/salt/example.sls
{%\- profile as \(aqlocal data\(aq %}
  {%\- set local_data = {\(aqcounter\(aq: 0} %}
  {%\- for i in range(313377) %}
    {%\- do local_data.update({\(aqcounter\(aq: i}) %}
  {%\- endfor %}
{%\- endprofile %}

test:
  cmd.run:
    \- name: |\-
        printf \(aqdata: %s\(aq \(aq{{ local_data[\(aqcounter\(aq] }}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBprofile\fP block in the \fBexample.sls\fP state will emit the following log
statement:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call \-\-local \-l profile state.apply example
[...]
[PROFILE ] Time (in seconds) to render profile block \(aqlocal data\(aq: 0.9385035037994385
[...]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Profiling imports
.sp
Using the same logic as the \fBprofile\fP block, the \fBimport_yaml\fP,
\fBimport_json\fP, and \fBimport_text\fP blocks will emit similar statements at the
\fBprofile\fP log level.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/salt/data.sls
{%\- set values = {\(aqcounter\(aq: 0} %}
{%\- for i in range(524288) %}
  {%\- do values.update({\(aqcounter\(aq: i}) %}
{%\- endfor %}

data: {{ values[\(aqcounter\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/salt/example.sls
{%\- import_yaml \(aqdata.sls\(aq as imported %}

test:
  cmd.run:
    \- name: |\-
        printf \(aqdata: %s\(aq \(aq{{ imported[\(aqdata\(aq] }}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For \fBimport_*\fP blocks, the \fBprofile\fP log statement has the following form:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call \-\-local \-l profile state.apply example
[...]
[PROFILE ] Time (in seconds) to render import_yaml \(aqdata.sls\(aq: 1.5500736236572266
[...]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Python Methods
.sp
A powerful feature of jinja that is only hinted at in the official jinja
documentation is that you can use the native python methods of the
variable type. Here is the python documentation for \fI\%string methods\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set hostname,domain = grains.id.partition(\(aq.\(aq)[::2] %}{{ hostname }}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set strings = grains.id.split(\(aq\-\(aq) %}{{ strings[0] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Custom Execution Modules
.sp
Custom execution modules can be used to supplement or replace complex Jinja. Many
tasks that require complex looping and logic are trivial when using Python
in a Salt execution module. Salt execution modules are easy to write and
distribute to Salt minions.
.sp
Functions in custom execution modules are available in the Salt execution
module dictionary just like the built\-in execution modules:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt[\(aqmy_custom_module.my_custom_function\(aq]() }}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
\fI\%How to Convert Jinja Logic to an Execution Module\fP
.IP \(bu 2
\fI\%Writing Execution Modules\fP
.UNINDENT
.SS Custom Jinja filters
.sp
Given that all execution modules are available in the Jinja template,
one can easily define a custom module as in the previous paragraph
and use it as a Jinja filter.
However, please note that it will not be accessible through the pipe.
.sp
For example, instead of:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ my_variable | my_jinja_filter }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The user will need to define \fBmy_jinja_filter\fP function under an extension
module, say \fBmy_filters\fP and use as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt.my_filters.my_jinja_filter(my_variable) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The greatest benefit is that you are able to access thousands of existing functions, e.g.:
.INDENT 0.0
.IP \(bu 2
get the DNS AAAA records for a specific address using the \fI\%dnsutil\fP:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt.dnsutil.AAAA(\(aqwww.google.com\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
retrieve a specific field value from a \fBRedis\fP hash:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt.redis.hget(\(aqfoo_hash\(aq, \(aqbar_field\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
get the routes to \fB0.0.0.0/0\fP using the \fI\%NAPALM route\fP:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt.route.show(\(aq0.0.0.0/0\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Tutorials Index
.SS Autoaccept minions from Grains
.sp
New in version 2018.3.0.

.sp
To automatically accept minions based on certain characteristics, e.g. the \fBuuid\fP
you can specify certain grain values on the salt master. Minions with matching grains
will have their keys automatically accepted.
.INDENT 0.0
.IP 1. 3
Configure the autosign_grains_dir in the master config file:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
autosign_grains_dir: /etc/salt/autosign_grains
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 2. 3
Configure the grain values to be accepted
.UNINDENT
.sp
Place a file named like the grain in the autosign_grains_dir and write the values that
should be accepted automatically inside that file. For example to automatically
accept minions based on their \fBuuid\fP create a file named \fB/etc/salt/autosign_grains/uuid\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
8f7d68e2\-30c5\-40c6\-b84a\-df7e978a03ee
1d3c5473\-1fbc\-479e\-b0c7\-877705a0730f
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If already running, the master must be restarted for these config changes to take effect.
.sp
The master is now setup to accept minions with either of the two specified uuids.
Multiple values must always be written into separate lines.
Lines starting with a \fB#\fP are ignored.
.INDENT 0.0
.IP 3. 3
Configure the minion to send the specific grains to the master in the minion config file:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
autosign_grains:
  \- uuid
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now you should be able to start salt\-minion and run \fBsalt\-call
state.apply\fP or any other salt commands that require master authentication.
.SS Salt as a Cloud Controller
.sp
In Salt 0.14.0, an advanced cloud control system was introduced, allowing
private cloud VMs to be managed directly with Salt. This system is generally
referred to as \fBSalt Virt\fP\&.
.sp
The Salt Virt system already exists and is installed within Salt itself. This
means that besides setting up Salt, no additional salt code needs to be
deployed.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBlibvirt\fP python module and the \fBcerttool\fP binary are required.
.UNINDENT
.UNINDENT
.sp
The main goal of Salt Virt is to facilitate a very fast and simple cloud that
can scale and is fully featured. Salt Virt comes with the ability to set up and
manage complex virtual machine networking, powerful image and disk management,
and virtual machine migration with and without shared storage.
.sp
This means that Salt Virt can be used to create a cloud from a blade center
and a SAN, but can also create a cloud out of a swarm of Linux Desktops
without a single shared storage system. Salt Virt can make clouds from
truly commodity hardware, but can also stand up the power of specialized
hardware as well.
.SS Setting up Hypervisors
.sp
The first step to set up the hypervisors involves getting the correct software
installed and setting up the hypervisor network interfaces.
.SS Installing Hypervisor Software
.sp
Salt Virt is made to be hypervisor agnostic but currently, the only fully
implemented hypervisor is KVM via libvirt.
.sp
The required software for a hypervisor is libvirt and kvm. For advanced
features, install libguestfs or qemu\-nbd.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Libguestfs and qemu\-nbd allow for virtual machine images to be mounted
before startup and get pre\-seeded with configurations and a salt minion.
.UNINDENT
.UNINDENT
.sp
This sls will set up the needed software for a hypervisor, and run the routines
to set up the libvirt pki keys.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Package names and setup used is Red Hat specific. Different package names
will be required for different platforms.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
libvirt:
  pkg.installed: []
  file.managed:
    \- name: /etc/sysconfig/libvirtd
    \- contents: \(aqLIBVIRTD_ARGS=\(dq\-\-listen\(dq\(aq
    \- require:
      \- pkg: libvirt
  virt.keys:
    \- require:
      \- pkg: libvirt
  service.running:
    \- name: libvirtd
    \- require:
      \- pkg: libvirt
      \- network: br0
      \- libvirt: libvirt
    \- watch:
      \- file: libvirt

libvirt\-python:
  pkg.installed: []

libguestfs:
  pkg.installed:
    \- pkgs:
      \- libguestfs
      \- libguestfs\-tools
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Hypervisor Network Setup
.sp
The hypervisors will need to be running a network bridge to serve up network
devices for virtual machines. This formula will set up a standard bridge on
a hypervisor connecting the bridge to eth0:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
eth0:
  network.managed:
    \- enabled: True
    \- type: eth
    \- bridge: br0

br0:
  network.managed:
    \- enabled: True
    \- type: bridge
    \- proto: dhcp
    \- require:
      \- network: eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Virtual Machine Network Setup
.sp
Salt Virt comes with a system to model the network interfaces used by the
deployed virtual machines. By default, a single interface is created for the
deployed virtual machine and is bridged to \fBbr0\fP\&. To get going with the
default networking setup, ensure that the bridge interface named \fBbr0\fP exists
on the hypervisor and is bridged to an active network device.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To use more advanced networking in Salt Virt, read the \fISalt Virt
Networking\fP document:
.sp
\fI\%Salt Virt Networking\fP
.UNINDENT
.UNINDENT
.SS Libvirt State
.sp
One of the challenges of deploying a libvirt based cloud is the distribution
of libvirt certificates. These certificates allow for virtual machine
migration. Salt comes with a system used to auto deploy these certificates.
Salt manages the signing authority key and generates keys for libvirt clients
on the master, signs them with the certificate authority, and uses pillar to
distribute them. This is managed via the \fBlibvirt\fP state. Simply execute this
formula on the minion to ensure that the certificate is in place and up to
date:
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The above formula includes the calls needed to set up libvirt keys.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
libvirt_keys:
  virt.keys
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Getting Virtual Machine Images Ready
.sp
Salt Virt requires that virtual machine images be provided as these are not
generated on the fly. Generating these virtual machine images differs greatly
based on the underlying platform.
.sp
Virtual machine images can be manually created using KVM and running through
the installer, but this process is not recommended since it is very manual and
prone to errors.
.sp
Virtual Machine generation applications are available for many platforms:
.INDENT 0.0
.TP
.B kiwi: (openSUSE, SLES, RHEL, CentOS)
\fI\%https://opensuse.github.io/kiwi/\fP
.TP
.B vm\-builder:
\fI\%https://wiki.debian.org/VMBuilder\fP
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
\fI\%url vmbuilder\-formula\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Once virtual machine images are available, the easiest way to make them
available to Salt Virt is to place them in the Salt file server. Just copy an
image into \fB/srv/salt\fP and it can now be used by Salt Virt.
.sp
For purposes of this demo, the file name \fBcentos.img\fP will be used.
.SS Existing Virtual Machine Images
.sp
Many existing Linux distributions distribute virtual machine images which
can be used with Salt Virt. Please be advised that NONE OF THESE IMAGES ARE
SUPPORTED BY SALTSTACK.
.SS CentOS
.sp
These images have been prepared for OpenNebula but should work without issue with
Salt Virt, only the raw qcow image file is needed:
\fI\%https://wiki.centos.org/Cloud/OpenNebula\fP
.SS Fedora Linux
.sp
Images for Fedora Linux can be found here:
\fI\%https://alt.fedoraproject.org/cloud\fP
.SS openSUSE
.sp
\fI\%https://download.opensuse.org/distribution/leap/15.1/jeos/openSUSE\-Leap\-15.1\-JeOS.x86_64\-15.1.0\-kvm\-and\-xen\-Current.qcow2.meta4\fP
.SS SUSE
.sp
\fI\%https://www.suse.com/products/server/jeos\fP
.SS Ubuntu Linux
.sp
Images for Ubuntu Linux can be found here:
\fI\%http://cloud\-images.ubuntu.com/\fP
.SS Using Salt Virt
.sp
With hypervisors set up and virtual machine images ready, Salt can start
issuing cloud commands using the \fIvirt runner\fP\&.
.sp
Start by running a Salt Virt hypervisor info command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run virt.host_info
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will query the running hypervisor(s) for stats and display useful
information such as the number of CPUs and amount of memory.
.sp
You can also list all VMs and their current states on all hypervisor nodes:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run virt.list
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now that hypervisors are available a virtual machine can be provisioned, the
\fBvirt.init\fP routine will create a new virtual machine:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run virt.init centos1 2 512 salt://centos.img
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The Salt Virt runner will now automatically select a hypervisor to deploy
the new virtual machine on. Using \fBsalt://\fP assumes that the CentOS virtual
machine image is located in the root of the \fI\%Salt File Server\fP on the master.
When images are cloned (i.e. copied locally after retrieval from the file
server), the destination directory on the hypervisor minion is determined by the
\fBvirt:images\fP config option; by default this is \fB/srv/salt\-images/\fP\&.
.sp
When a VM is initialized using \fBvirt.init\fP, the image is copied to the
hypervisor using \fBcp.cache_file\fP and will be mounted and seeded with a minion.
Seeding includes setting pre\-authenticated keys on the new machine. A minion
will only be installed if one can not be found on the image using the default
arguments to \fBseed.apply\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The biggest bottleneck in starting VMs is when the Salt Minion needs to be
installed. Making sure that the source VM images already have Salt
installed will GREATLY speed up virtual machine deployment.
.UNINDENT
.UNINDENT
.sp
You can also deploy an image on a particular minion by directly calling the
\fBvirt\fP execution module with an absolute image path. This can be quite handy for
testing:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqhypervisor*\(aq virt.init centos1 2 512 image=/var/lib/libvirt/images/centos.img
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now that the new VM has been prepared, it can be seen via the \fBvirt.query\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run virt.query
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This command will return data about all of the hypervisors and respective
virtual machines.
.sp
Now that the new VM is booted, it should have contacted the Salt Master. A
\fBtest.ping\fP will reveal if the new VM is running.
.SS QEMU Copy on Write Support
.sp
For fast image cloning, you can use the \fI\%qcow\fP disk image format.
Pass the \fBenable_qcow\fP flag and a \fI\&.qcow2\fP image path to \fIvirt.init\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqhypervisor*\(aq virt.init centos1 2 512 image=/var/lib/libvirt/images/centos.qcow2 enable_qcow=True start=False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Beware that attempting to boot a qcow image too quickly after cloning
can result in a race condition where libvirt may try to boot the machine
before image seeding has completed. For that reason, it is recommended to
also pass \fBstart=False\fP to \fBvirt.init\fP\&.
.sp
Also know that you \fBmust not\fP modify the original base image without
first making a copy and then \fIrebasing\fP all overlay images onto it.
See the \fBqemu\-img rebase\fP \fI\%usage docs\fP\&.
.UNINDENT
.UNINDENT
.SS Migrating Virtual Machines
.sp
Salt Virt comes with full support for virtual machine migration. Using
the libvirt state in the above formula makes migration possible.
.sp
A few things need to be available to support migration. Many operating systems
turn on firewalls when originally set up; the firewall needs to be opened up
to allow for libvirt and kvm to cross communicate and execution migration
routines. On Red Hat based hypervisors in particular, port 16514 needs to be
opened on hypervisors:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
iptables \-A INPUT \-m state \-\-state NEW \-m tcp \-p tcp \-\-dport 16514 \-j ACCEPT
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
More in\-depth information regarding distribution specific firewall settings can be found in:
.sp
\fI\%Opening the Firewall up for Salt\fP
.UNINDENT
.UNINDENT
.sp
Salt also needs the \fBvirt:tunnel\fP option to be turned on. This flag tells Salt
to run migrations securely via the libvirt TLS tunnel and to use port 16514.
Without \fBvirt:tunnel\fP, libvirt tries to bind to random ports when running
migrations.
.sp
To turn on \fBvirt:tunnel\fP, simply apply it to the master config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
virt:
    tunnel: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once the master config has been updated, restart the master and send out a call
to the minions to refresh the pillar to pick up on the change:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \e* saltutil.refresh_modules
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now, migration routines can be run! To migrate a VM, simply run the Salt Virt
migrate routine:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run virt.migrate centos <new hypervisor>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS VNC Consoles
.sp
Although not enabled by default, Salt Virt can also set up VNC consoles allowing
for remote visual consoles to be opened up. When creating a new VM using
\fBvirt.init\fP, pass the \fBenable_vnc=True\fP parameter to have a console
configured for the new VM.
.sp
The information from a \fBvirt.query\fP routine will display the VNC console port
for the specific VMs:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
centos
  CPU: 2
  Memory: 524288
  State: running
  Graphics: vnc \- hyper6:5900
  Disk \- vda:
    Size: 2.0G
    File: /srv/salt\-images/ubuntu2/system.qcow2
    File Format: qcow2
  Nic \- ac:de:48:98:08:77:
    Source: br0
    Type: bridge
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The line \fIGraphics: vnc \- hyper6:5900\fP holds the key. First the port named,
in this case 5900, will need to be available in the hypervisor\(aqs firewall.
Once the port is open, then the console can be easily opened via vncviewer:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vncviewer hyper6:5900
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default there is no VNC security set up on these ports, which suggests that
keeping them firewalled and mandating that SSH tunnels be used to access these
VNC interfaces. Keep in mind that activity on a VNC interface that is accessed
can be viewed by any other user that accesses that same VNC interface, and any
other user logging in can also operate with the logged in user on the virtual
machine.
.SS Conclusion
.sp
Now with Salt Virt running, new hypervisors can be seamlessly added just by
running the above states on new bare metal machines, and these machines will be
instantly available to Salt Virt.
.SS Running Salt States and Commands in Docker Containers
.sp
The 2016.11.0 release of Salt introduces the ability to execute Salt States
and Salt remote execution commands directly inside of Docker containers.
.sp
This addition makes it possible to not only deploy fresh containers using
Salt States. This also allows for running containers to be audited and
modified using Salt, but without running a Salt Minion inside the container.
Some of the applications include security audits of running containers as
well as gathering operating data from containers.
.sp
This new feature is simple and straightforward, and can be used via a running
Salt Minion, the Salt Call command, or via Salt SSH. For this tutorial we will
use the \fIsalt\-call\fP command, but like all salt commands these calls are
directly translatable to \fIsalt\fP and \fIsalt\-ssh\fP\&.
.SS Step 1 \- Install Docker
.sp
Since setting up Docker is well covered in the Docker documentation we will
make no such effort to describe it here. Please see the Docker Installation
Documentation for installing and setting up Docker:
\fI\%https://docs.docker.com/engine/installation/\fP
.sp
The Docker integration also requires that the \fIdocker\-py\fP library is installed.
This can easily be done using pip or via your system package manager:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install docker\-py
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Step 2 \- Install Salt
.sp
For this tutorial we will be using Salt Call, which is available in the
\fIsalt\-minion\fP package, please follow the
\fI\%Salt install guide\fP\&.
.SS Step 3 \- Create With Salt States
.sp
Next some Salt States are needed, for this example a very basic state which
installs \fIvim\fP is used, but anything Salt States can do can be done here,
please see the Salt States Introduction Tutorial to learn more about Salt
States:
\fI\%https://docs.saltproject.io/en/stage/getstarted/config/\fP
.sp
For this tutorial, simply create a small state file in \fI/srv/salt/vim.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The base image you choose will need to have python 2.6 or 2.7 installed.
We are hoping to resolve this constraint in a future release.
.sp
If \fIbase\fP is omitted the default image used is a minimal openSUSE
image with Python support, maintained by SUSE
.UNINDENT
.UNINDENT
.sp
Next run the \fIdocker.sls_build\fP command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local dockerng.sls_build test base=my_base_image mods=vim
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now we have a fresh image called \fItest\fP to work with and vim has been
installed.
.SS Step 4 \- Running Commands Inside the Container
.sp
Salt can now run remote execution functions inside the container with another
simple \fIsalt\-call\fP command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local dockerng.call test test.version
salt\-call \-\-local dockerng.call test network.interfaces
salt\-call \-\-local dockerng.call test disk.usage
salt\-call \-\-local dockerng.call test pkg.list_pkgs
salt\-call \-\-local dockerng.call test service.running httpd
salt\-call \-\-local dockerng.call test cmd.run \(aqls \-l /etc\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Automatic Updates / Frozen Deployments
.sp
New in version 0.10.3.d.

.sp
Salt has support for the
\fI\%Esky\fP application freezing and update
tool. This tool allows one to build a complete zipfile out of the salt scripts
and all their dependencies \- including shared objects / DLLs.
.SS Getting Started
.sp
To build frozen applications, suitable build environment will be needed for
each platform. You should probably set up a virtualenv in order to limit the
scope of Q/A.
.sp
This process does work on Windows. Directions are available at
\fI\%https://github.com/saltstack/salt\-windows\-install\fP for details on
installing Salt in Windows. Only the 32\-bit Python and dependencies have been
tested, but they have been tested on 64\-bit Windows.
.sp
Install \fBbbfreeze\fP, and then \fBesky\fP from PyPI in order to enable the
\fBbdist_esky\fP command in \fBsetup.py\fP\&. Salt itself must also be installed, in
addition to its dependencies.
.SS Building and Freezing
.sp
Once you have your tools installed and the environment configured, use
\fBsetup.py\fP to prepare the distribution files.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python setup.py sdist
python setup.py bdist
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once the distribution files are in place, Esky can be used traverse the module
tree and pack all the scripts up into a redistributable.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python setup.py bdist_esky
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There will be an appropriately versioned \fBsalt\-VERSION.zip\fP in \fBdist/\fP if
everything went smoothly.
.SS Windows
.sp
\fBC:\ePython27\elib\esite\-packages\ezmq\fP will need to be added to the PATH
variable. This helps bbfreeze find the zmq DLL so it can pack it up.
.SS Using the Frozen Build
.sp
Unpack the zip file in the desired install location. Scripts like
\fBsalt\-minion\fP and \fBsalt\-call\fP will be in the root of the zip file. The
associated libraries and bootstrapping will be in the directories at the same
level. (Check the \fI\%Esky\fP documentation
for more information)
.sp
To support updating your minions in the wild, put the builds on a web server
that the minions can reach. \fI\%salt.modules.saltutil.update()\fP will
trigger an update and (optionally) a restart of the minion service under the
new version.
.SS Troubleshooting
.SS A Windows minion isn\(aqt responding
.sp
The process dispatch on Windows is slower than it is on *nix. It may be
necessary to add \(aq\-t 15\(aq to salt commands to give minions plenty of time to
return.
.SS Windows and the Visual Studio Redist
.sp
The Visual C++ 2008 32\-bit redistributable will need to be installed on all
Windows minions. Esky has an option to pack the library into the zipfile,
but OpenSSL does not seem to acknowledge the new location. If a
\fBno OPENSSL_Applink\fP error appears on the console when trying to start a
frozen minion, the redistributable is not installed.
.SS Mixed Linux environments and Yum
.sp
The Yum Python module doesn\(aqt appear to be available on any of the standard
Python package mirrors. If RHEL/CentOS systems need to be supported, the frozen
build should created on that platform to support all the Linux nodes. Remember
to build the virtualenv with \fB\-\-system\-site\-packages\fP so that the \fByum\fP
module is included.
.SS Automatic (Python) module discovery
.sp
Automatic (Python) module discovery does not work with the late\-loaded scheme
that Salt uses for (Salt) modules. Any misbehaving modules will need to be
explicitly added to the \fBfreezer_includes\fP in Salt\(aqs \fBsetup.py\fP\&.  Always
check the zipped application to make sure that the necessary modules were
included.
.SS ESXi Proxy Minion
.sp
New in version 2015.8.4.

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This tutorial assumes basic knowledge of Salt. To get up to speed, check
out the \fI\%Salt Walkthrough\fP\&.
.sp
This tutorial also assumes a basic understanding of Salt Proxy Minions. If
you\(aqre unfamiliar with Salt\(aqs Proxy Minion system, please read the
\fI\%Salt Proxy Minion\fP documentation and the
\fI\%Salt Proxy Minion End\-to\-End Example\fP
tutorial.
.sp
The third assumption that this tutorial makes is that you also have a
basic understanding of ESXi hosts. You can learn more about ESXi hosts on
\fI\%VMware\(aqs various resources\fP\&.
.UNINDENT
.UNINDENT
.sp
Salt\(aqs ESXi Proxy Minion allows a VMware ESXi host to be treated as an individual
Salt Minion, without installing a Salt Minion on the ESXi host.
.sp
Since an ESXi host may not necessarily run on an OS capable of hosting a Python
stack, the ESXi host can\(aqt run a regular Salt Minion directly. Therefore, Salt\(aqs
Proxy Minion functionality enables you to designate another machine to host a
proxy process that \(dqproxies\(dq communication from the Salt Master to the ESXi host.
The master does not know or care that the ESXi target is not a \(dqreal\(dq Salt Minion.
.sp
More in\-depth conceptual reading on Proxy Minions can be found in the
\fI\%Proxy Minion\fP section of Salt\(aqs documentation.
.sp
Salt\(aqs ESXi Proxy Minion was added in the 2015.8.4 release of Salt.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Be aware that some functionality for the ESXi Proxy Minion may depend on the
type of license attached the ESXi host(s).
.sp
For example, certain services are only available to manipulate service state
or policies with a VMware vSphere Enterprise or Enterprise Plus license, while
others are available with a Standard license. The \fBntpd\fP service is restricted
to an Enterprise Plus license, while \fBssh\fP is available via the Standard
license.
.sp
Please see the \fI\%vSphere Comparison\fP page for more information.
.UNINDENT
.UNINDENT
.SS Dependencies
.sp
Manipulation of the ESXi host via a Proxy Minion requires the machine running
the Proxy Minion process to have the ESXCLI package (and all of its dependencies)
and the pyVmomi Python Library to be installed.
.SS ESXi Password
.sp
The ESXi Proxy Minion uses VMware\(aqs API to perform tasks on the host as if it was
a regular Salt Minion. In order to access the API that is already running on the
ESXi host, the ESXi host must have a username and password that is used to log
into the host. The username is usually \fBroot\fP\&. Before Salt can access the ESXi
host via VMware\(aqs API, a default password \fImust\fP be set on the host.
.SS pyVmomi
.sp
The pyVmomi Python library must be installed on the machine that is running the
proxy process. pyVmomi can be installed via pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Version 6.0 of pyVmomi has some problems with SSL error handling on certain
versions of Python. If using version 6.0 of pyVmomi, the machine that you
are running the proxy minion process from must have either Python 2.6,
Python 2.7.9, or newer. This is due to an upstream dependency in pyVmomi 6.0
that is not supported in Python version 2.7 to 2.7.8. If the
version of Python running the proxy process is not in the supported range, you
will need to install an earlier version of pyVmomi. See \fI\%Issue #29537\fP for
more information.
.UNINDENT
.UNINDENT
.sp
Based on the note above, to install an earlier version of pyVmomi than the
version currently listed in PyPi, run the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi==5.5.0.2014.1.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The 5.5.0.2014.1.1 is a known stable version that the original ESXi Proxy Minion
was developed against.
.SS ESXCLI
.sp
Currently, about a third of the functions used for the ESXi Proxy Minion require
the ESXCLI package be installed on the machine running the Proxy Minion process.
.sp
The ESXCLI package is also referred to as the VMware vSphere CLI, or vCLI. VMware
provides vCLI package installation instructions for \fI\%vSphere 5.5\fP and
\fI\%vSphere 6.0\fP\&.
.sp
Once all of the required dependencies are in place and the vCLI package is
installed, you can check to see if you can connect to your ESXi host by running
the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
esxcli \-s <host\-location> \-u <username> \-p <password> system syslog config get
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the connection was successful, ESXCLI was successfully installed on your system.
You should see output related to the ESXi host\(aqs syslog configuration.
.SS Configuration
.sp
There are several places where various configuration values need to be set in
order for the ESXi Proxy Minion to run and connect properly.
.SS Proxy Config File
.sp
On the machine that will be running the Proxy Minion process(es), a proxy config
file must be in place. This file should be located in the \fB/etc/salt/\fP directory
and should be named \fBproxy\fP\&. If the file is not there by default, create it.
.sp
This file should contain the location of your Salt Master that the Salt Proxy
will connect to.
.sp
Example Proxy Config File:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/proxy

master: <salt\-master\-location>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Pillar Profiles
.sp
Proxy minions get their configuration from Salt\(aqs Pillar. Every proxy must
have a stanza in Pillar and a reference in the Pillar top\-file that matches
the Proxy ID. At a minimum for communication with the ESXi host, the pillar
should look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: esxi
  host: <ip or dns name of esxi host>
  username: <ESXi username>
  passwords:
    \- first_password
    \- second_password
    \- third_password
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Some other optional settings are \fBprotocol\fP and \fBport\fP\&. These can be added
to the pillar configuration.
.SS proxytype
.sp
The \fBproxytype\fP key and value pair is critical, as it tells Salt which
interface to load from the \fBproxy\fP directory in Salt\(aqs install hierarchy,
or from \fB/srv/salt/_proxy\fP on the Salt Master (if you have created your
own proxy module, for example). To use this ESXi Proxy Module, set this to
\fBesxi\fP\&.
.SS host
.sp
The location, or ip/dns, of the ESXi host. Required.
.SS username
.sp
The username used to login to the ESXi host, such as \fBroot\fP\&. Required.
.SS passwords
.sp
A list of passwords to be used to try and login to the ESXi host. At least
one password in this list is required.
.sp
The proxy integration will try the passwords listed in order. It is
configured this way so you can have a regular password and the password you
may be updating for an ESXi host either via the
\fI\%vsphere.update_host_password\fP
execution module function or via the
\fI\%esxi.password_present\fP state
function. This way, after the password is changed, you should not need to
restart the proxy minion\-\-it should just pick up the new password
provided in the list. You can then change pillar at will to move that
password to the front and retire the unused ones.
.sp
Use\-case/reasoning for using a list of passwords: You are setting up an
ESXi host for the first time, and the host comes with a default password.
You know that you\(aqll be changing this password during your initial setup
from the default to a new password. If you only have one password option,
and if you have a state changing the password, any remote execution commands
or states that run after the password change will not be able to run on the
host until the password is updated in Pillar and the Proxy Minion process is
restarted.
.sp
This allows you to use any number of potential fallback passwords.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When a password is changed on the host to one in the list of possible
passwords, the further down on the list the password is, the longer
individual commands will take to return. This is due to the nature of
pyVmomi\(aqs login system. We have to wait for the first attempt to fail
before trying the next password on the list.
.sp
This scenario is especially true, and even slower, when the proxy
minion first starts. If the correct password is not the first password
on the list, it may take up to a minute for \fBtest.version\fP to respond
with salt\(aqs version installed (Example: \fB2018.3.4\fP\&. Once the initial
authorization is complete, the responses for commands will be a little
faster.
.sp
To avoid these longer waiting periods, SaltStack recommends moving the
correct password to the top of the list and restarting the proxy minion
at your earliest convenience.
.UNINDENT
.UNINDENT
.SS protocol
.sp
If the ESXi host is not using the default protocol, set this value to an
alternate protocol. Default is \fBhttps\fP\&. For example:
.SS port
.sp
If the ESXi host is not using the default port, set this value to an
alternate port. Default is \fB443\fP\&.
.SS Example Configuration Files
.sp
An example of all of the basic configurations that need to be in place before
starting the Proxy Minion processes includes the Proxy Config File, Pillar
Top File, and any individual Proxy Minion Pillar files.
.sp
In this example, we\(aqll assuming there are two ESXi hosts to connect to. Therefore,
we\(aqll be creating two Proxy Minion config files, one config for each ESXi host.
.sp
Proxy Config File:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/proxy

master: <salt\-master\-location>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pillar Top File:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/pillar/top.sls

base:
  \(aqesxi\-1\(aq:
    \- esxi\-1
  \(aqesxi\-2\(aq:
    \- esxi\-2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pillar Config File for the first ESXi host, esxi\-1:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/pillar/esxi\-1.sls

proxy:
  proxytype: esxi
  host: esxi\-1.example.com
  username: \(aqroot\(aq
  passwords:
    \- bad\-password\-1
    \- backup\-bad\-password\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pillar Config File for the second ESXi host, esxi\-2:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/pillar/esxi\-2.sls

proxy:
  proxytype: esxi
  host: esxi\-2.example.com
  username: \(aqroot\(aq
  passwords:
    \- bad\-password\-2
    \- backup\-bad\-password\-2
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Starting the Proxy Minion
.sp
Once all of the correct configuration files are in place, it is time to start the
proxy processes!
.INDENT 0.0
.IP 1. 3
First, make sure your Salt Master is running.
.IP 2. 3
Start the first Salt Proxy, in debug mode, by giving the Proxy Minion process
and ID that matches the config file name created in the \fI\%Configuration\fP section.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid=\(aqesxi\-1\(aq \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 1. 3
Accept the \fBesxi\-1\fP Proxy Minion\(aqs key on the Salt Master:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-key \-L
Accepted Keys:
Denied Keys:
Unaccepted Keys:
esxi\-1
Rejected Keys:
#
# salt\-key \-a esxi\-1
The following keys are going to be accepted:
Unaccepted Keys:
esxi\-1
Proceed? [n/Y] y
Key for minion esxi\-1 accepted.
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 1. 3
Repeat for the second Salt Proxy, this time we\(aqll run the proxy process as a
daemon, as an example.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid=\(aqesxi\-2\(aq \-d
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 1. 3
Accept the \fBesxi\-2\fP Proxy Minion\(aqs key on the Salt Master:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-key \-L
Accepted Keys:
esxi\-1
Denied Keys:
Unaccepted Keys:
esxi\-2
Rejected Keys:
#
# salt\-key \-a esxi\-1
The following keys are going to be accepted:
Unaccepted Keys:
esxi\-2
Proceed? [n/Y] y
Key for minion esxi\-1 accepted.
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 1. 3
Check and see if your Proxy Minions are responding:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt \(aqesxi\-*\(aq test.version
esxi\-1:
    True
esxi\-3:
    True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Executing Commands
.sp
Now that you\(aqve configured your Proxy Minions and have them responding successfully
to a \fBtest.version\fP, we can start executing commands against the ESXi hosts via Salt.
.sp
It\(aqs important to understand how this particular proxy works, and there are a couple
of important pieces to be aware of in order to start running remote execution and
state commands against the ESXi host via a Proxy Minion: the
\fI\%vSphere Execution Module\fP, the \fI\%ESXi Execution Module\fP, and the \fI\%ESXi State Module\fP\&.
.SS vSphere Execution Module
.sp
The \fI\%Salt.modules.vsphere\fP is a
standard Salt execution module that does the bulk of the work for the ESXi Proxy
Minion. If you pull up the docs for it you\(aqll see that almost every function in
the module takes credentials (\fBusername\fP and \fBpassword\fP) and a target \fBhost\fP
argument. When credentials and a host aren\(aqt passed, Salt runs commands
through \fBpyVmomi\fP or \fBESXCLI\fP against the local machine. If you wanted,
you could run functions from this module on any machine where an appropriate
version of \fBpyVmomi\fP and \fBESXCLI\fP are installed, and that machine would reach
out over the network and communicate with the ESXi host.
.sp
You\(aqll notice that most of the functions in the vSphere module require a \fBhost\fP,
\fBusername\fP, and \fBpassword\fP\&. These parameters are contained in the Pillar files and
passed through to the function via the proxy process that is already running. You don\(aqt
need to provide these parameters when you execute the commands. See the
\fI\%Running Remote Execution Commands\fP section below for an example.
.SS ESXi Execution Module
.sp
In order for the Pillar information set up in the \fI\%Configuration\fP section above to
be passed to the function call in the vSphere Execution Module, the
\fI\%salt.modules.esxi\fP execution module acts
as a \(dqshim\(dq between the vSphere execution module functions and the proxy process.
.sp
The \(dqshim\(dq takes the authentication credentials specified in the Pillar files and
passes them through to the \fBhost\fP, \fBusername\fP, \fBpassword\fP, and optional
\fBprotocol\fP and \fBport\fP options required by the vSphere Execution Module functions.
.sp
If the function takes more positional, or keyword, arguments you can append them
to the call. It\(aqs this shim that speaks to the ESXi host through the proxy, arranging
for the credentials and hostname to be pulled from the Pillar section for the ESXi
Proxy Minion.
.sp
Because of the presence of the shim, to lookup documentation for what
functions you can use to interface with the ESXi host, you\(aqll want to
look in \fI\%salt.modules.vsphere\fP
instead of \fI\%salt.modules.esxi\fP\&.
.SS Running Remote Execution Commands
.sp
To run commands from the Salt Master to execute, via the ESXi Proxy Minion, against
the ESXi host, you use the \fBesxi.cmd <vsphere\-function\-name>\fP syntax to call
functions located in the vSphere Execution Module. Both args and kwargs needed
for various vsphere execution module functions must be passed through in a kwarg\-
type manor. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqesxi\-*\(aq esxi.cmd system_info
salt \(aqexsi\-*\(aq esxi.cmd get_service_running service_name=\(aqssh\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS ESXi State Module
.sp
The ESXi State Module functions similarly to other state modules. The \(dqshim\(dq provided
by the \fI\%ESXi Execution Module\fP passes the necessary \fBhost\fP, \fBusername\fP, and
\fBpassword\fP credentials through, so those options don\(aqt need to be provided in the
state. Other than that, state files are written and executed just like any other
Salt state. See the \fI\%salt.modules.esxi\fP state
for ESXi state functions.
.sp
The follow state file is an example of how to configure various pieces of an ESXi host
including enabling SSH, uploading and SSH key, configuring a coredump network config,
syslog, ntp, enabling VMotion, resetting a host password, and more.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/salt/configure\-esxi.sls

configure\-host\-ssh:
  esxi.ssh_configured:
    \- service_running: True
    \- ssh_key_file: /etc/salt/ssh_keys/my_key.pub
    \- service_policy: \(aqautomatic\(aq
    \- service_restart: True
    \- certificate_verify: True

configure\-host\-coredump:
  esxi.coredump_configured:
    \- enabled: True
    \- dump_ip: \(aqmy\-coredump\-ip.example.com\(aq

configure\-host\-syslog:
  esxi.syslog_configured:
    \- syslog_configs:
        loghost: ssl://localhost:5432,tcp://10.1.0.1:1514
        default\-timeout: 120
    \- firewall: True
    \- reset_service: True
    \- reset_syslog_config: True
    \- reset_configs: loghost,default\-timeout

configure\-host\-ntp:
  esxi.ntp_configured:
    \- service_running: True
    \- ntp_servers:
      \- 192.174.1.100
      \- 192.174.1.200
    \- service_policy: \(aqautomatic\(aq
    \- service_restart: True

configure\-vmotion:
  esxi.vmotion_configured:
    \- enabled: True

configure\-host\-vsan:
  esxi.vsan_configured:
    \- enabled: True
    \- add_disks_to_vsan: True

configure\-host\-password:
  esxi.password_present:
    \- password: \(aqnew\-bad\-password\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
States are called via the ESXi Proxy Minion just as they would on a regular minion.
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqesxi\-*\(aq state.sls configure\-esxi test=true
salt \(aqesxi\-*\(aq state.sls configure\-esxi
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Relevant Salt Files and Resources
.INDENT 0.0
.IP \(bu 2
\fI\%ESXi Proxy Minion\fP
.IP \(bu 2
\fI\%ESXi Execution Module\fP
.IP \(bu 2
\fI\%ESXi State Module\fP
.IP \(bu 2
\fI\%Salt Proxy Minion Docs\fP
.IP \(bu 2
\fI\%Salt Proxy Minion End\-to\-End Example\fP
.IP \(bu 2
\fI\%vSphere Execution Module\fP
.UNINDENT
.SS Opening the Firewall up for Salt
.sp
The Salt master communicates with the minions using an AES\-encrypted ZeroMQ
connection. These communications are done over TCP ports \fB4505\fP and \fB4506\fP,
which need to be accessible on the master only. This document outlines suggested
firewall rules for allowing these incoming connections to the master.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
No firewall configuration needs to be done on Salt minions. These changes
refer to the master only.
.UNINDENT
.UNINDENT
.SS Fedora 18 and beyond / RHEL 7 / CentOS 7
.sp
Starting with Fedora 18 \fI\%FirewallD\fP is the tool that is used to dynamically
manage the firewall rules on a host. It has support for IPv4/6 settings and
the separation of runtime and permanent configurations. To interact with
FirewallD use the command line client \fBfirewall\-cmd\fP\&.
.sp
\fBfirewall\-cmd example\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
firewall\-cmd \-\-permanent \-\-zone=<zone> \-\-add\-port=4505\-4506/tcp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A network zone defines the security level of trust for the network.
The user should choose an appropriate zone value for their setup.
Possible values include: drop, block, public, external, dmz, work, home, internal, trusted.
.sp
Don\(aqt forget to reload after you made your changes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
firewall\-cmd \-\-reload
.ft P
.fi
.UNINDENT
.UNINDENT
.SS RHEL 6 / CentOS 6
.sp
The \fBlokkit\fP command packaged with some Linux distributions makes opening
iptables firewall ports very simple via the command line. Just be careful
to not lock out access to the server by neglecting to open the ssh port.
.sp
\fBlokkit example\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lokkit \-p 22:tcp \-p 4505:tcp \-p 4506:tcp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBsystem\-config\-firewall\-tui\fP command provides a text\-based interface to
modifying the firewall.
.sp
\fBsystem\-config\-firewall\-tui\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
system\-config\-firewall\-tui
.ft P
.fi
.UNINDENT
.UNINDENT
.SS openSUSE
.sp
Salt installs firewall rules in \fI\%/etc/sysconfig/SuSEfirewall2.d/services/salt\fP\&.
Enable with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
SuSEfirewall2 open
SuSEfirewall2 start
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you have an older package of Salt where the above configuration file is
not included, the \fBSuSEfirewall2\fP command makes opening iptables firewall
ports very simple via the command line.
.sp
\fBSuSEfirewall example\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
SuSEfirewall2 open EXT TCP 4505
SuSEfirewall2 open EXT TCP 4506
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The firewall module in YaST2 provides a text\-based interface to modifying the
firewall.
.sp
\fBYaST2\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
yast2 firewall
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Windows
.sp
Windows Firewall is the default component of Microsoft Windows that provides
firewalling and packet filtering. There are many 3rd party firewalls available
for Windows, some of which use rules from the Windows Firewall. If you are
experiencing problems see the vendor\(aqs specific documentation for opening the
required ports.
.sp
The Windows Firewall can be configured using the Windows Interface or from the
command line.
.sp
\fBWindows Firewall (interface)\fP:
.INDENT 0.0
.IP 1. 3
Open the Windows Firewall Interface by typing \fBwf.msc\fP at the command
prompt or in a run dialog (\fIWindows Key + R\fP)
.IP 2. 3
Navigate to \fBInbound Rules\fP in the console tree
.IP 3. 3
Add a new rule by clicking \fBNew Rule...\fP in the Actions area
.IP 4. 3
Change the Rule Type to \fBPort\fP\&. Click \fBNext\fP
.IP 5. 3
Set the Protocol to \fBTCP\fP and specify local ports \fB4505\-4506\fP\&. Click
\fBNext\fP
.IP 6. 3
Set the Action to \fBAllow the connection\fP\&. Click \fBNext\fP
.IP 7. 3
Apply the rule to \fBDomain\fP, \fBPrivate\fP, and \fBPublic\fP\&. Click \fBNext\fP
.IP 8. 3
Give the new rule a Name, ie: \fBSalt\fP\&. You may also add a description. Click
\fBFinish\fP
.UNINDENT
.sp
\fBWindows Firewall (command line)\fP:
.sp
The Windows Firewall rule can be created by issuing a single command. Run the
following command from the command line or a run prompt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
netsh advfirewall firewall add rule name=\(dqSalt\(dq dir=in action=allow protocol=TCP localport=4505\-4506
.ft P
.fi
.UNINDENT
.UNINDENT
.SS iptables
.sp
Different Linux distributions store their \fIiptables\fP (also known as
\fI\%netfilter\fP) rules in different places, which makes it difficult to
standardize firewall documentation. Included are some of the more
common locations, but your mileage may vary.
.sp
\fBFedora / RHEL / CentOS\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/sysconfig/iptables
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBArch Linux\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/iptables/iptables.rules
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBDebian\fP
.sp
Follow these instructions: \fI\%https://wiki.debian.org/iptables\fP
.sp
Once you\(aqve found your firewall rules, you\(aqll need to add the below line
to allow traffic on \fBtcp/4505\fP and \fBtcp/4506\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\-A INPUT \-m state \-\-state new \-m tcp \-p tcp \-\-dport 4505:4506 \-j ACCEPT
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBUbuntu\fP
.sp
Salt installs firewall rules in \fI\%/etc/ufw/applications.d/salt.ufw\fP\&. Enable with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ufw allow salt
.ft P
.fi
.UNINDENT
.UNINDENT
.SS pf.conf
.sp
The BSD\-family of operating systems uses \fI\%packet filter (pf)\fP\&. The following
example describes the addition to \fBpf.conf\fP needed to access the Salt
master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pass in on $int_if proto tcp from any to $int_if port 4505:4506
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once this addition has been made to the \fBpf.conf\fP the rules will need to
be reloaded. This can be done using the \fBpfctl\fP command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pfctl \-vf /etc/pf.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Whitelist communication to Master
.sp
There are situations where you want to selectively allow Minion traffic
from specific hosts or networks into your Salt Master. The first
scenario which comes to mind is to prevent unwanted traffic to your
Master out of security concerns, but another scenario is to handle
Minion upgrades when there are backwards incompatible changes between
the installed Salt versions in your environment.
.sp
Here is an example \fI\%Linux iptables\fP ruleset to
be set on the Master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Allow Minions from these networks
\-I INPUT \-s 10.1.2.0/24 \-p tcp \-\-dports 4505:4506 \-j ACCEPT
\-I INPUT \-s 10.1.3.0/24 \-p tcp \-\-dports 4505:4506 \-j ACCEPT
# Allow Salt to communicate with Master on the loopback interface
\-A INPUT \-i lo \-p tcp \-\-dports 4505:4506 \-j ACCEPT
# Reject everything else
\-A INPUT \-p tcp \-\-dports 4505:4506 \-j REJECT
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The important thing to note here is that the \fBsalt\fP command
needs to communicate with the listening network socket of
\fBsalt\-master\fP on the \fIloopback\fP interface. Without this you will
see no outgoing Salt traffic from the master, even for a simple
\fBsalt \(aq*\(aq test.version\fP, because the \fBsalt\fP client never reached
the \fBsalt\-master\fP to tell it to carry out the execution.
.UNINDENT
.UNINDENT
.SS HTTP Modules
.sp
This tutorial demonstrates using the various HTTP modules available in Salt.
These modules wrap the Python \fBtornado\fP, \fBurllib2\fP, and \fBrequests\fP
libraries, extending them in a manner that is more consistent with Salt
workflows.
.SS The \fBsalt.utils.http\fP Library
.sp
This library forms the core of the HTTP modules. Since it is designed to be used
from the minion as an execution module, in addition to the master as a runner,
it was abstracted into this multi\-use library. This library can also be imported
by 3rd\-party programs wishing to take advantage of its extended functionality.
.sp
Core functionality of the execution, state, and runner modules is derived from
this library, so common usages between them are described here. Documentation
specific to each module is described below.
.sp
This library can be imported with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.utils.http
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configuring Libraries
.sp
This library can make use of either \fBtornado\fP, which is required by Salt,
\fBurllib2\fP, which ships with Python, or \fBrequests\fP, which can be installed
separately. By default, \fBtornado\fP will be used. In order to switch to
\fBurllib2\fP, set the following variable:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
backend: urllib2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In order to switch to \fBrequests\fP, set the following variable:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
backend: requests
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This can be set in the master or minion configuration file, or passed as an
option directly to any \fBhttp.query()\fP functions.
.SS \fBsalt.utils.http.query()\fP
.sp
This function forms a basic query, but with some add\-ons not present in the
\fBtornado\fP, \fBurllib2\fP, and \fBrequests\fP libraries. Not all functionality
currently available in these libraries has been added, but can be in future
iterations.
.SS HTTPS Request Methods
.sp
A basic query can be performed by calling this function with no more than a
single URL:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(\(dqhttp://example.com\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default the query will be performed with a \fBGET\fP method. The method can
be overridden with the \fBmethod\fP argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(\(dqhttp://example.com/delete/url\(dq, \(dqDELETE\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When using the \fBPOST\fP method (and others, such as \fBPUT\fP), extra data is usually
sent as well. This data can be sent directly (would be URL encoded when necessary),
or in whatever format is required by the remote server (XML, JSON, plain text, etc).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(
    \(dqhttp://example.com/post/url\(dq, method=\(dqPOST\(dq, data=json.dumps(mydict)
)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Data Formatting and Templating
.sp
Bear in mind that the data must be sent pre\-formatted; this function will not
format it for you. However, a templated file stored on the local system may be
passed through, along with variables to populate it with. To pass through only
the file (untemplated):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(
    \(dqhttp://example.com/post/url\(dq, method=\(dqPOST\(dq, data_file=\(dq/srv/salt/somefile.xml\(dq
)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To pass through a file that contains jinja + yaml templating (the default):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(
    \(dqhttp://example.com/post/url\(dq,
    method=\(dqPOST\(dq,
    data_file=\(dq/srv/salt/somefile.jinja\(dq,
    data_render=True,
    template_dict={\(dqkey1\(dq: \(dqvalue1\(dq, \(dqkey2\(dq: \(dqvalue2\(dq},
)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To pass through a file that contains mako templating:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(
    \(dqhttp://example.com/post/url\(dq,
    method=\(dqPOST\(dq,
    data_file=\(dq/srv/salt/somefile.mako\(dq,
    data_render=True,
    data_renderer=\(dqmako\(dq,
    template_dict={\(dqkey1\(dq: \(dqvalue1\(dq, \(dqkey2\(dq: \(dqvalue2\(dq},
)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Because this function uses Salt\(aqs own rendering system, any Salt renderer can
be used. Because Salt\(aqs renderer requires \fB__opts__\fP to be set, an \fBopts\fP
dictionary should be passed in. If it is not, then the default \fB__opts__\fP
values for the node type (master or minion) will be used. Because this library
is intended primarily for use by minions, the default node type is \fBminion\fP\&.
However, this can be changed to \fBmaster\fP if necessary.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(
    \(dqhttp://example.com/post/url\(dq,
    method=\(dqPOST\(dq,
    data_file=\(dq/srv/salt/somefile.jinja\(dq,
    data_render=True,
    template_dict={\(dqkey1\(dq: \(dqvalue1\(dq, \(dqkey2\(dq: \(dqvalue2\(dq},
    opts=__opts__,
)

salt.utils.http.query(
    \(dqhttp://example.com/post/url\(dq,
    method=\(dqPOST\(dq,
    data_file=\(dq/srv/salt/somefile.jinja\(dq,
    data_render=True,
    template_dict={\(dqkey1\(dq: \(dqvalue1\(dq, \(dqkey2\(dq: \(dqvalue2\(dq},
    node=\(dqmaster\(dq,
)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Headers
.sp
Headers may also be passed through, either as a \fBheader_list\fP, a
\fBheader_dict\fP, or as a \fBheader_file\fP\&. As with the \fBdata_file\fP, the
\fBheader_file\fP may also be templated. Take note that because HTTP headers are
normally syntactically\-correct YAML, they will automatically be imported as an
a Python dict.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(
    \(dqhttp://example.com/delete/url\(dq,
    method=\(dqPOST\(dq,
    header_file=\(dq/srv/salt/headers.jinja\(dq,
    header_render=True,
    header_renderer=\(dqjinja\(dq,
    template_dict={\(dqkey1\(dq: \(dqvalue1\(dq, \(dqkey2\(dq: \(dqvalue2\(dq},
)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Because much of the data that would be templated between headers and data may be
the same, the \fBtemplate_dict\fP is the same for both. Correcting possible
variable name collisions is up to the user.
.SS Authentication
.sp
The \fBquery()\fP function supports basic HTTP authentication. A username and
password may be passed in as \fBusername\fP and \fBpassword\fP, respectively.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(\(dqhttp://example.com\(dq, username=\(dqlarry\(dq, password=\(dq5700g3543v4r\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Cookies and Sessions
.sp
Cookies are also supported, using Python\(aqs built\-in \fBcookielib\fP\&. However, they
are turned off by default. To turn cookies on, set \fBcookies\fP to True.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(\(dqhttp://example.com\(dq, cookies=True)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default cookies are stored in Salt\(aqs cache directory, normally
\fB/var/cache/salt\fP, as a file called \fBcookies.txt\fP\&. However, this location
may be changed with the \fBcookie_jar\fP argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(
    \(dqhttp://example.com\(dq, cookies=True, cookie_jar=\(dq/path/to/cookie_jar.txt\(dq
)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default, the format of the cookie jar is LWP (aka, lib\-www\-perl). This
default was chosen because it is a human\-readable text file. If desired, the
format of the cookie jar can be set to Mozilla:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(
    \(dqhttp://example.com\(dq,
    cookies=True,
    cookie_jar=\(dq/path/to/cookie_jar.txt\(dq,
    cookie_format=\(dqmozilla\(dq,
)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Because Salt commands are normally one\-off commands that are piped together,
this library cannot normally behave as a normal browser, with session cookies
that persist across multiple HTTP requests. However, the session can be
persisted in a separate cookie jar. The default filename for this file, inside
Salt\(aqs cache directory, is \fBcookies.session.p\fP\&. This can also be changed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(
    \(dqhttp://example.com\(dq, persist_session=True, session_cookie_jar=\(dq/path/to/jar.p\(dq
)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The format of this file is msgpack, which is consistent with much of the rest
of Salt\(aqs internal structure. Historically, the extension for this file is
\fB\&.p\fP\&. There are no current plans to make this configurable.
.SS Proxy
.sp
If the \fBtornado\fP backend is used (\fBtornado\fP is the default), proxy
information configured in \fBproxy_host\fP, \fBproxy_port\fP, \fBproxy_username\fP,
\fBproxy_password\fP and \fBno_proxy\fP from the \fB__opts__\fP dictionary will be used.  Normally
these are set in the minion configuration file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy_host: proxy.my\-domain
proxy_port: 31337
proxy_username: charon
proxy_password: obolus
no_proxy: [\(aq127.0.0.1\(aq, \(aqlocalhost\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(\(dqhttp://example.com\(dq, opts=__opts__, backend=\(dqtornado\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Return Data
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Return data encoding
.sp
If \fBdecode\fP is set to \fBTrue\fP, \fBquery()\fP will attempt to decode the
return data. \fBdecode_type\fP defaults to \fBauto\fP\&.  Set it to a specific
encoding, \fBxml\fP, for example, to override autodetection.
.UNINDENT
.UNINDENT
.sp
Because Salt\(aqs http library was designed to be used with REST interfaces,
\fBquery()\fP will attempt to decode the data received from the remote server
when \fBdecode\fP is set to \fBTrue\fP\&.  First it will check the \fBContent\-type\fP
header to try and find references to XML. If it does not find any, it will look
for references to JSON. If it does not find any, it will fall back to plain
text, which will not be decoded.
.sp
JSON data is translated into a dict using Python\(aqs built\-in \fBjson\fP library.
XML is translated using \fBsalt.utils.xml_util\fP, which will use Python\(aqs
built\-in XML libraries to attempt to convert the XML into a dict. In order to
force either JSON or XML decoding, the \fBdecode_type\fP may be set:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(\(dqhttp://example.com\(dq, decode_type=\(dqxml\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once translated, the return dict from \fBquery()\fP will include a dict called
\fBdict\fP\&.
.sp
If the data is not to be translated using one of these methods, decoding may be
turned off.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(\(dqhttp://example.com\(dq, decode=False)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If decoding is turned on, and references to JSON or XML cannot be found, then
this module will default to plain text, and return the undecoded data as
\fBtext\fP (even if text is set to \fBFalse\fP; see below).
.sp
The \fBquery()\fP function can return the HTTP status code, headers, and/or text
as required. However, each must individually be turned on.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(\(dqhttp://example.com\(dq, status=True, headers=True, text=True)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The return from these will be found in the return dict as \fBstatus\fP,
\fBheaders\fP and \fBtext\fP, respectively.
.SS Writing Return Data to Files
.sp
It is possible to write either the return data or headers to files, as soon as
the response is received from the server, but specifying file locations via the
\fBtext_out\fP or \fBheaders_out\fP arguments. \fBtext\fP and \fBheaders\fP do not need
to be returned to the user in order to do this.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(
    \(dqhttp://example.com\(dq,
    text=False,
    headers=False,
    text_out=\(dq/path/to/url_download.txt\(dq,
    headers_out=\(dq/path/to/headers_download.txt\(dq,
)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS SSL Verification
.sp
By default, this function will verify SSL certificates. However, for testing or
debugging purposes, SSL verification can be turned off.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(\(dqhttps://example.com\(dq, verify_ssl=False)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS CA Bundles
.sp
The \fBrequests\fP library has its own method of detecting which CA (certificate
authority) bundle file to use. Usually this is implemented by the packager for
the specific operating system distribution that you are using. However,
\fBurllib2\fP requires a little more work under the hood. By default, Salt will
try to auto\-detect the location of this file. However, if it is not in an
expected location, or a different path needs to be specified, it may be done so
using the \fBca_bundle\fP variable.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.query(\(dqhttps://example.com\(dq, ca_bundle=\(dq/path/to/ca_bundle.pem\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Updating CA Bundles
.sp
The \fBupdate_ca_bundle()\fP function can be used to update the bundle file at a
specified location. If the target location is not specified, then it will
attempt to auto\-detect the location of the bundle file. If the URL to download
the bundle from does not exist, a bundle will be downloaded from the cURL
website.
.sp
CAUTION: The \fBtarget\fP and the \fBsource\fP should always be specified! Failure
to specify the \fBtarget\fP may result in the file being written to the wrong
location on the local system. Failure to specify the \fBsource\fP may cause the
upstream URL to receive excess unnecessary traffic, and may cause a file to be
download which is hazardous or does not meet the needs of the user.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.update_ca_bundle(
    target=\(dq/path/to/ca\-bundle.crt\(dq,
    source=\(dqhttps://example.com/path/to/ca\-bundle.crt\(dq,
    opts=__opts__,
)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBopts\fP parameter should also always be specified. If it is, then the
\fBtarget\fP and the \fBsource\fP may be specified in the relevant configuration
file (master or minion) as \fBca_bundle\fP and \fBca_bundle_url\fP, respectively.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ca_bundle: /path/to/ca\-bundle.crt
ca_bundle_url: https://example.com/path/to/ca\-bundle.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If Salt is unable to auto\-detect the location of the CA bundle, it will raise
an error.
.sp
The \fBupdate_ca_bundle()\fP function can also be passed a string or a list of
strings which represent files on the local system, which should be appended (in
the specified order) to the end of the CA bundle file. This is useful in
environments where private certs need to be made available, and are not
otherwise reasonable to add to the bundle file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt.utils.http.update_ca_bundle(
    opts=__opts__,
    merge_files=[
        \(dq/etc/ssl/private_cert_1.pem\(dq,
        \(dq/etc/ssl/private_cert_2.pem\(dq,
        \(dq/etc/ssl/private_cert_3.pem\(dq,
    ],
)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Test Mode
.sp
This function may be run in test mode. This mode will perform all work up until
the actual HTTP request. By default, instead of performing the request, an empty
dict will be returned. Using this function with \fBTRACE\fP logging turned on will
reveal the contents of the headers and POST data to be sent.
.sp
Rather than returning an empty dict, an alternate \fBtest_url\fP may be passed in.
If this is detected, then test mode will replace the \fBurl\fP with the
\fBtest_url\fP, set \fBtest\fP to \fBTrue\fP in the return data, and perform the rest
of the requested operations as usual. This allows a custom, non\-destructive URL
to be used for testing when necessary.
.SS Execution Module
.sp
The \fBhttp\fP execution module is a very thin wrapper around the
\fBsalt.utils.http\fP library. The \fBopts\fP can be passed through as well, but if
they are not specified, the minion defaults will be used as necessary.
.sp
Because passing complete data structures from the command line can be tricky at
best and dangerous (in terms of execution injection attacks) at worse, the
\fBdata_file\fP, and \fBheader_file\fP are likely to see more use here.
.sp
All methods for the library are available in the execution module, as kwargs.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion http.query http://example.com/restapi method=POST \e
    username=\(aqlarry\(aq password=\(aq5700g3543v4r\(aq headers=True text=True \e
    status=True decode_type=xml data_render=True \e
    header_file=/tmp/headers.txt data_file=/tmp/data.txt \e
    header_render=True cookies=True persist_session=True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Runner Module
.sp
Like the execution module, the \fBhttp\fP runner module is a very thin wrapper
around the \fBsalt.utils.http\fP library. The only significant difference is that
because runners execute on the master instead of a minion, a target is not
required, and default opts will be derived from the master config, rather than
the minion config.
.sp
All methods for the library are available in the runner module, as kwargs.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run http.query http://example.com/restapi method=POST \e
    username=\(aqlarry\(aq password=\(aq5700g3543v4r\(aq headers=True text=True \e
    status=True decode_type=xml data_render=True \e
    header_file=/tmp/headers.txt data_file=/tmp/data.txt \e
    header_render=True cookies=True persist_session=True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS State Module
.sp
The state module is a wrapper around the runner module, which applies stateful
logic to a query. All kwargs as listed above are specified as usual in state
files, but two more kwargs are available to apply stateful logic. A required
parameter is \fBmatch\fP, which specifies a pattern to look for in the return
text. By default, this will perform a string comparison of looking for the
value of match in the return text. In Python terms this looks like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def myfunc():
    if match in html_text:
        return True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If more complex pattern matching is required, a regular expression can be used
by specifying a \fBmatch_type\fP\&. By default this is set to \fBstring\fP, but it
can be manually set to \fBpcre\fP instead. Please note that despite the name, this
will use Python\(aqs \fBre.search()\fP rather than \fBre.match()\fP\&.
.sp
Therefore, the following states are valid:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
http://example.com/restapi:
  http.query:
    \- match: \(aqSUCCESS\(aq
    \- username: \(aqlarry\(aq
    \- password: \(aq5700g3543v4r\(aq
    \- data_render: True
    \- header_file: /tmp/headers.txt
    \- data_file: /tmp/data.txt
    \- header_render: True
    \- cookies: True
    \- persist_session: True

http://example.com/restapi:
  http.query:
    \- match_type: pcre
    \- match: \(aq(?i)succe[ss|ed]\(aq
    \- username: \(aqlarry\(aq
    \- password: \(aq5700g3543v4r\(aq
    \- data_render: True
    \- header_file: /tmp/headers.txt
    \- data_file: /tmp/data.txt
    \- header_render: True
    \- cookies: True
    \- persist_session: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In addition to, or instead of a match pattern, the status code for a URL can be
checked. This is done using the \fBstatus\fP argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
http://example.com/:
  http.query:
    \- status: 200
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If both are specified, both will be checked, but if only one is \fBTrue\fP and the
other is \fBFalse\fP, then \fBFalse\fP will be returned. In this case, the comments
in the return data will contain information for troubleshooting.
.sp
Because this is a monitoring state, it will return extra data to code that
expects it. This data will always include \fBtext\fP and \fBstatus\fP\&. Optionally,
\fBheaders\fP and \fBdict\fP may also be requested by setting the \fBheaders\fP and
\fBdecode\fP arguments to True, respectively.
.SS Using Salt at scale
.sp
The focus of this tutorial will be building a Salt infrastructure for handling
large numbers of minions. This will include tuning, topology, and best practices.
.sp
For how to install the Salt Master, see the
\fI\%Salt install guide\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This tutorial is intended for large installations, although these same settings
won\(aqt hurt, it may not be worth the complexity to smaller installations.
.sp
When used with minions, the term \(aqmany\(aq refers to at least a thousand
and \(aqa few\(aq always means 500.
.sp
For simplicity reasons, this tutorial will default to the standard ports
used by Salt.
.UNINDENT
.UNINDENT
.SS The Master
.sp
The most common problems on the Salt Master are:
.INDENT 0.0
.IP 1. 3
too many minions authing at once
.IP 2. 3
too many minions re\-authing at once
.IP 3. 3
too many minions re\-connecting at once
.IP 4. 3
too many minions returning at once
.IP 5. 3
too few resources (CPU/HDD)
.UNINDENT
.sp
The first three are all \(dqthundering herd\(dq problems. To mitigate these issues
we must configure the minions to back\-off appropriately when the Master is
under heavy load.
.sp
The fourth is caused by masters with little hardware resources in combination
with a possible bug in ZeroMQ. At least that\(aqs what it looks like till today
(\fI\%Issue 118651\fP,
\fI\%Issue 5948\fP,
\fI\%Mail thread\fP)
.sp
To fully understand each problem, it is important to understand, how Salt works.
.sp
Very briefly, the Salt Master offers two services to the minions.
.INDENT 0.0
.IP \(bu 2
a job publisher on port 4505
.IP \(bu 2
an open port 4506 to receive the minions returns
.UNINDENT
.sp
All minions are always connected to the publisher on port 4505 and only connect
to the open return port 4506 if necessary. On an idle Master, there will only
be connections on port 4505.
.SS Too many minions authing
.sp
When the Minion service is first started up, it will connect to its Master\(aqs publisher
on port 4505. If too many minions are started at once, this can cause a \(dqthundering herd\(dq.
This can be avoided by not starting too many minions at once.
.sp
The connection itself usually isn\(aqt the culprit, the more likely cause of master\-side
issues is the authentication that the Minion must do with the Master. If the Master
is too heavily loaded to handle the auth request it will time it out. The Minion
will then wait \fIacceptance_wait_time\fP to retry. If \fIacceptance_wait_time_max\fP is
set then the Minion will increase its wait time by the \fIacceptance_wait_time\fP each
subsequent retry until reaching \fIacceptance_wait_time_max\fP\&.
.SS Too many minions re\-authing
.sp
This is most likely to happen in the testing phase of a Salt deployment, when
all Minion keys have already been accepted, but the framework is being tested
and parameters are frequently changed in the Salt Master\(aqs configuration
file(s).
.sp
The Salt Master generates a new AES key to encrypt its publications at certain
events such as a Master restart or the removal of a Minion key.  If you are
encountering this problem of too many minions re\-authing against the Master,
you will need to recalibrate your setup to reduce the rate of events like a
Master restart or Minion key removal (\fBsalt\-key \-d\fP).
.sp
When the Master generates a new AES key, the minions aren\(aqt notified of this
but will discover it on the next pub job they receive. When the Minion
receives such a job it will then re\-auth with the Master. Since Salt does
minion\-side filtering this means that all the minions will re\-auth on the next
command published on the master\-\- causing another \(dqthundering herd\(dq. This can
be avoided by setting the
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
random_reauth_delay: 60
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
in the minions configuration file to a higher value and stagger the amount
of re\-auth attempts. Increasing this value will of course increase the time
it takes until all minions are reachable via Salt commands.
.SS Too many minions re\-connecting
.sp
By default the zmq socket will re\-connect every 100ms which for some larger
installations may be too quick. This will control how quickly the TCP session is
re\-established, but has no bearing on the auth load.
.sp
To tune the minions sockets reconnect attempts, there are a few values in
the sample configuration file (default values)
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
recon_default: 1000
recon_max: 5000
recon_randomize: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
recon_default: the default value the socket should use, i.e. 1000. This value is in
milliseconds. (1000ms = 1 second)
.IP \(bu 2
recon_max: the max value that the socket should use as a delay before trying to reconnect
This value is in milliseconds. (5000ms = 5 seconds)
.IP \(bu 2
recon_randomize: enables randomization between recon_default and recon_max
.UNINDENT
.sp
To tune this values to an existing environment, a few decision have to be made.
.INDENT 0.0
.IP 1. 3
How long can one wait, before the minions should be online and reachable via Salt?
.IP 2. 3
How many reconnects can the Master handle without a syn flood?
.UNINDENT
.sp
These questions can not be answered generally. Their answers depend on the
hardware and the administrators requirements.
.sp
Here is an example scenario with the goal, to have all minions reconnect
within a 60 second time\-frame on a Salt Master service restart.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
recon_default: 1000
recon_max: 59000
recon_randomize: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Each Minion will have a randomized reconnect value between \(aqrecon_default\(aq
and \(aqrecon_default + recon_max\(aq, which in this example means between 1000ms
and 60000ms (or between 1 and 60 seconds). The generated random\-value will
be doubled after each attempt to reconnect (ZeroMQ default behavior).
.sp
Lets say the generated random value is 11 seconds (or 11000ms).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reconnect 1: wait 11 seconds
reconnect 2: wait 22 seconds
reconnect 3: wait 33 seconds
reconnect 4: wait 44 seconds
reconnect 5: wait 55 seconds
reconnect 6: wait time is bigger than 60 seconds (recon_default + recon_max)
reconnect 7: wait 11 seconds
reconnect 8: wait 22 seconds
reconnect 9: wait 33 seconds
reconnect x: etc.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With a thousand minions this will mean
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
1000/60 = ~16
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
round about 16 connection attempts a second. These values should be altered to
values that match your environment. Keep in mind though, that it may grow over
time and that more minions might raise the problem again.
.SS Too many minions returning at once
.sp
This can also happen during the testing phase, if all minions are addressed at
once with
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt * disk.usage
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
it may cause thousands of minions trying to return their data to the Salt Master
open port 4506. Also causing a flood of syn\-flood if the Master can\(aqt handle that many
returns at once.
.sp
This can be easily avoided with Salt\(aqs batch mode:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt * disk.usage \-b 50
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will only address 50 minions at once while looping through all addressed
minions.
.SS Too few resources
.sp
The masters resources always have to match the environment. There is no way
to give good advise without knowing the environment the Master is supposed to
run in.  But here are some general tuning tips for different situations:
.SS The Master is CPU bound
.sp
In installations with large or with complex pillar files, it is possible
for the master to exhibit poor performance as a result of having to render
many pillar files at once. This exhibit itself in a number of ways, both
as high load on the master and on minions which block on waiting for their
pillar to be delivered to them.
.sp
To reduce pillar rendering times, it is possible to cache pillars on the
master. To do this, see the set of master configuration options which
are prefixed with \fIpillar_cache\fP\&.
.sp
If many pillars are encrypted using \fI\%gpg\fP renderer, it
is possible to cache GPG data. To do this, see the set of master configuration
options which are prefixed with \fIgpg_cache\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Caching pillars or GPG data on the master may introduce security
considerations. Be certain to read caveats outlined in the master
configuration file to understand how pillar caching may affect a master\(aqs
ability to protect sensitive data!
.UNINDENT
.UNINDENT
.SS The Master is disk IO bound
.sp
By default, the Master saves every Minion\(aqs return for every job in its
job\-cache. The cache can then be used later, to lookup results for previous
jobs. The default directory for this is:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cachedir: /var/cache/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
and then in the \fB/proc\fP directory.
.sp
Each job return for every Minion is saved in a single file. Over time this
directory can grow quite large, depending on the number of published jobs. The
amount of files and directories will scale with the number of jobs published and
the retention time defined by
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
keep_jobs_seconds: 86400
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
250 jobs/day * 2000 minions returns = 500,000 files a day
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Use and External Job Cache
.sp
An external job cache allows for job storage to be placed on an external
system, such as a database.
.INDENT 0.0
.IP \(bu 2
ext_job_cache: this will have the minions store their return data directly
into a returner (not sent through the Master)
.IP \(bu 2
master_job_cache (New in \fI2014.7.0\fP): this will make the Master store the job
data using a returner (instead of the local job cache on disk).
.UNINDENT
.sp
If a master has many accepted keys, it may take a long time to publish a job
because the master must first determine the matching minions and deliver
that information back to the waiting client before the job can be published.
.sp
To mitigate this, a key cache may be enabled. This will reduce the load
on the master to a single file open instead of thousands or tens of thousands.
.sp
This cache is updated by the maintenance process, however, which means that
minions with keys that are accepted may not be targeted by the master
for up to sixty seconds by default.
.sp
To enable the master key cache, set \fIkey_cache: \(aqsched\(aq\fP in the master
configuration file.
.SS Disable The Job Cache
.sp
The job cache is a central component of the Salt Master and many aspects of
the Salt Master will not function correctly without a running job cache.
.sp
Disabling the job cache is \fBSTRONGLY DISCOURAGED\fP and should not be done
unless the master is being used to execute routines that require no history
or reliable feedback!
.sp
The job cache can be disabled:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job_cache: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS How to Convert Jinja Logic to an Execution Module
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This tutorial assumes a basic knowledge of Salt states and specifically
experience using the \fImaps.jinja\fP idiom.
.sp
This tutorial was written by a salt user who was told \(dqif your maps.jinja
is too complicated, write an execution module!\(dq. If you are experiencing
over\-complicated jinja, read on.
.UNINDENT
.UNINDENT
.SS The Problem: Jinja Gone Wild
.sp
It is often said in the Salt community that \(dqJinja is not a Programming Language\(dq.
There\(aqs an even older saying known as Maslow\(aqs hammer.
It goes something like
\(dqif all you have is a hammer, everything looks like a nail\(dq.
Jinja is a reliable hammer, and so is the \fImaps.jinja\fP idiom.
Unfortunately, it can lead to code that looks like the following.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# storage/maps.yaml

{% import_yaml \(aqstorage/defaults.yaml\(aq as default_settings %}
{% set storage = default_settings.storage %}
{% do storage.update(salt[\(aqgrains.filter_by\(aq]({
    \(aqDebian\(aq: {
    },
    \(aqRedHat\(aq: {
    }
}, merge=salt[\(aqpillar.get\(aq](\(aqstorage:lookup\(aq))) %}

{% if \(aqVirtualBox\(aq == grains.get(\(aqvirtual\(aq, None) or \(aqoracle\(aq == grains.get(\(aqvirtual\(aq, None) %}
{%   do storage.update({\(aqdepot_ip\(aq: \(aq192.168.33.81\(aq, \(aqserver_ip\(aq:  \(aq192.168.33.51\(aq}) %}
{% else %}
{%   set colo = pillar.get(\(aqinventory\(aq, {}).get(\(aqcolo\(aq, \(aqUnknown\(aq) %}
{%   set servers_list = pillar.get(\(aqstorage_servers\(aq, {}).get(colo, [storage.depot_ip, ]) %}
{%   if opts.id.startswith(\(aqfoo\(aq) %}
{%     set modulus = servers_list | count %}
{%     set integer_id = opts.id | replace(\(aqfoo\(aq, \(aq\(aq) | int %}
{%     set server_index = integer_id % modulus %}
{%   else %}
{%     set server_index = 0 %}
{%   endif %}
{%   do storage.update({\(aqserver_ip\(aq: servers_list[server_index]}) %}
{% endif %}

{% for network, _ in salt.pillar.get(\(aqinventory:networks\(aq, {}) | dictsort %}
{%   do storage.ipsets.hash_net.foo_networks.append(network) %}
{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is an example from the author\(aqs salt formulae demonstrating misuse of jinja.
Aside from being difficult to read and maintain,
accessing the logic it contains from a non\-jinja renderer
while probably possible is a significant barrier!
.SS Refactor
.sp
The first step is to reduce the maps.jinja file to something reasonable.
This gives us an idea of what the module we are writing needs to do.
There is a lot of logic around selecting a storage server ip.
Let\(aqs move that to an execution module.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# storage/maps.yaml

{% import_yaml \(aqstorage/defaults.yaml\(aq as default_settings %}
{% set storage = default_settings.storage %}
{% do storage.update(salt[\(aqgrains.filter_by\(aq]({
    \(aqDebian\(aq: {
    },
    \(aqRedHat\(aq: {
    }
}, merge=salt[\(aqpillar.get\(aq](\(aqstorage:lookup\(aq))) %}

{% if \(aqVirtualBox\(aq == grains.get(\(aqvirtual\(aq, None) or \(aqoracle\(aq == grains.get(\(aqvirtual\(aq, None) %}
{%   do storage.update({\(aqdepot_ip\(aq: \(aq192.168.33.81\(aq}) %}
{% endif %}

{% do storage.update({\(aqserver_ip\(aq: salt[\(aqstorage.ip\(aq]()}) %}

{% for network, _ in salt.pillar.get(\(aqinventory:networks\(aq, {}) | dictsort %}
{%   do storage.ipsets.hash_net.af_networks.append(network) %}
{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And then, write the module.
Note how the module encapsulates all of the logic around finding the storage server IP.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# _modules/storage.py
#!python

\(dq\(dq\(dq
Functions related to storage servers.
\(dq\(dq\(dq

import re


def ips():
    \(dq\(dq\(dq
    Provide a list of all local storage server IPs.

    CLI Example::

        salt \e* storage.ips
    \(dq\(dq\(dq

    if __grains__.get(\(dqvirtual\(dq, None) in [\(dqVirtualBox\(dq, \(dqoracle\(dq]:
        return [
            \(dq192.168.33.51\(dq,
        ]

    colo = __pillar__.get(\(dqinventory\(dq, {}).get(\(dqcolo\(dq, \(dqUnknown\(dq)
    return __pillar__.get(\(dqstorage_servers\(dq, {}).get(colo, [\(dqunknown\(dq])


def ip():
    \(dq\(dq\(dq
    Select and return a local storage server IP.

    This loadbalances across storage servers by using the modulus of the client\(aqs id number.

    :maintainer:    Andrew Hammond <ahammond@anchorfree.com>
    :maturity:      new
    :depends:       None
    :platform:      all

    CLI Example::

        salt \e* storage.ip

    \(dq\(dq\(dq

    numerical_suffix = re.compile(r\(dq^.*(\ed+)$\(dq)
    servers_list = ips()

    m = numerical_suffix.match(__grains__[\(dqid\(dq])
    if m:
        modulus = len(servers_list)
        server_number = int(m.group(1))
        server_index = server_number % modulus
    else:
        server_index = 0

    return servers_list[server_index]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Conclusion
.sp
That was... surprisingly straight\-forward.
Now the logic is available in every renderer, instead of just Jinja.
Best of all, it can be maintained in Python,
which is a whole lot easier than Jinja.
.SS Using Apache Libcloud for declarative and procedural multi\-cloud orchestration
.sp
New in version 2018.3.0.

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This walkthrough assumes basic knowledge of Salt and Salt States. To get up to speed, check out the
\fI\%Salt Walkthrough\fP\&.
.UNINDENT
.UNINDENT
.sp
Apache Libcloud is a Python library which hides differences between different cloud provider APIs and allows
you to manage different cloud resources through a unified and easy to use API. Apache Libcloud supports over
60 cloud platforms, including Amazon, Microsoft Azure, DigitalOcean, Google Cloud Platform and OpenStack.
.INDENT 0.0
.TP
.B Execution and state modules are available for Compute, DNS, Storage and Load Balancer drivers from Apache Libcloud in
SaltStack.
.UNINDENT
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fI\%libcloud_compute\fP \- Compute \-
services such as OpenStack Nova, Amazon EC2, Microsoft Azure VMs
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fI\%libcloud_dns\fP \- DNS as a Service \-
services such as Amazon Route 53 and Zerigo
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fI\%libcloud_loadbalancer\fP \- Load Balancers as a Service \-
services such as Amazon Elastic Load Balancer and GoGrid LoadBalancers
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fI\%libcloud_storage\fP \- Cloud Object Storage and CDN \-
services such as Amazon S3 and Rackspace CloudFiles, OpenStack Swift
.UNINDENT
.UNINDENT
.sp
These modules are designed as a way of having a multi\-cloud deployment and abstracting simple differences
between platform to design a high\-availability architecture.
.sp
The Apache Libcloud functionality is available through both execution modules and Salt states.
.SS Configuring Drivers
.sp
Drivers can be configured in the Salt Configuration/Minion settings. All libcloud modules expect a list of \(dqprofiles\(dq to
be configured with authentication details for each driver.
.sp
Each driver will have a string identifier, these can be found in the libcloud.<api>.types.Provider class
for each API, \fI\%https://libcloud.readthedocs.io/en/latest/supported_providers.html\fP
.sp
Some drivers require additional parameters, which are documented in the Apache Libcloud documentation. For example,
GoDaddy DNS expects \(dq\fIshopper_id\fP\(dq, which is the customer ID. These additional parameters can be added to the profile settings
and will be passed directly to the driver instantiation method.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
libcloud_dns:
    godaddy:
        driver: godaddy
        shopper_id: 90425123
        key: AFDDJFGIjDFVNSDIFNASMC
        secret: FG(#f8vdfgjlkm)

libcloud_storage:
    google:
        driver: google_storage
        key: GOOG4ASDIDFNVIdfnIVW
        secret: R+qYE9hkfdhv89h4invhdfvird4Pq3an8rnK
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can have multiple profiles for a single driver, for example if you wanted 2 DNS profiles for Amazon Route53,
naming them \(dqroute53_prod\(dq and \(dqroute54_test\(dq would help your
administrators distinguish their purpose.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
libcloud_dns:
    route53_prod:
        driver: route53
        key: AFDDJFGIjDFVNSDIFNASMC
        secret: FG(#f8vdfgjlkm)
    route53_test:
        driver: route53
        key: AFDDJFGIjdfgdfgdf
        secret: FG(#f8vdfgjlkm)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Using the execution modules
.sp
Amongst over 60 clouds that Apache Libcloud supports, you can add profiles to your Salt configuration to access and control these clouds.
Each of the libcloud execution modules exposes the common API methods for controlling Compute, DNS, Load Balancers and Object Storage.
To see which functions are supported across specific clouds, see the Libcloud \fI\%supported methods\fP documentation.
.sp
The module documentation explains each of the API methods and how to leverage them.
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fI\%libcloud_compute\fP \- Compute \-
services such as OpenStack Nova, Amazon EC2, Microsoft Azure VMs
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fI\%libcloud_dns\fP \- DNS as a Service \-
services such as Amazon Route 53 and Zerigo
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fI\%libcloud_loadbalancer\fP \- Load Balancers as a Service \-
services such as Amazon Elastic Load Balancer and GoGrid LoadBalancers
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fI\%libcloud_storage\fP \- Cloud Object Storage and CDN \-
services such as Amazon S3 and Rackspace CloudFiles, OpenStack Swift
.UNINDENT
.UNINDENT
.sp
For example, listing buckets in the Google Storage platform:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-call libcloud_storage.list_containers google

    local:
        |_
        \-\-\-\-\-\-\-\-\-\-
        extra:
            \-\-\-\-\-\-\-\-\-\-
            creation_date:
                2017\-01\-05T05:44:56.324Z
        name:
            anthonypjshaw
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The Apache Libcloud storage module can be used to synchronize files between multiple storage clouds,
such as Google Storage, S3 and OpenStack Swift
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq libcloud_storage.download_object DeploymentTools test.sh /tmp/test.sh google_storage
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Using the state modules
.sp
For each configured profile, the assets available in the API (e.g. storage objects, containers,
DNS records and load balancers) can be deployed via Salt\(aqs state system.
.sp
The state module documentation explains the specific states that each module supports
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fI\%libcloud_storage\fP \- Cloud Object Storage and CDN
.INDENT 7.0
.IP \(bu 2
services such as Amazon S3 and Rackspace CloudFiles, OpenStack Swift
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fI\%libcloud_loadbalancer\fP \- Load Balancers as a Service
.INDENT 7.0
.IP \(bu 2
services such as Amazon Elastic Load Balancer and GoGrid LoadBalancers
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fI\%libcloud_dns\fP \- DNS as a Service
.INDENT 7.0
.IP \(bu 2
services such as Amazon Route 53 and Zerigo
.UNINDENT
.UNINDENT
.UNINDENT
.sp
For DNS, the state modules can be used to provide DNS resilience for multiple nameservers, for example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
libcloud_dns:
    godaddy:
        driver: godaddy
        shopper_id: 12345
        key: 2orgk34kgk34g
        secret: fjgoidhjgoim
    amazon:
        driver: route53
        key: blah
        secret: blah
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And then in a state file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
webserver:
  libcloud_dns.zone_present:
    name: mywebsite.com
    profile: godaddy
  libcloud_dns.record_present:
    name: www
    zone: mywebsite.com
    type: A
    data: 12.34.32.3
    profile: godaddy
  libcloud_dns.zone_present:
    name: mywebsite.com
    profile: amazon
  libcloud_dns.record_present:
    name: www
    zone: mywebsite.com
    type: A
    data: 12.34.32.3
    profile: amazon
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This could be combined with a multi\-cloud load balancer deployment,
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
webserver:
  libcloud_dns.zone_present:
    \- name: mywebsite.com
    \- profile: godaddy
    ...
  libcloud_loadbalancer.balancer_present:
    \- name: web_main
    \- port: 80
    \- protocol: http
    \- members:
        \- ip: 1.2.4.5
          port: 80
        \- ip: 2.4.5.6
          port: 80
    \- profile: google_gce
  libcloud_loadbalancer.balancer_present:
    \- name: web_main
    \- port: 80
    \- protocol: http
    \- members:
        \- ip: 1.2.4.5
          port: 80
        \- ip: 2.4.5.6
          port: 80
    \- profile: amazon_elb
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Extended parameters can be passed to the specific cloud, for example you can specify the region with the Google Cloud API, because
\fIcreate_balancer\fP can accept a \fIex_region\fP argument. Adding this argument to the state will pass the additional command to the driver.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lb_test:
    libcloud_loadbalancer.balancer_absent:
        \- name: example
        \- port: 80
        \- protocol: http
        \- profile: google
        \- ex_region: us\-east1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Accessing custom arguments in execution modules
.sp
Some cloud providers have additional functionality that can be accessed on top of the base API, for example
the Google Cloud Engine load balancer service offers the ability to provision load balancers into a specific region.
.sp
Looking at the \fI\%API documentation\fP,
we can see that it expects an \fIex_region\fP in the \fIcreate_balancer\fP method, so when we execute the salt command, we can add this additional parameter like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt myminion libcloud_storage.create_balancer my_balancer 80 http profile1 ex_region=us\-east1
$ salt myminion libcloud_storage.list_container_objects my_bucket profile1 ex_prefix=me
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Accessing custom methods in Libcloud drivers
.sp
Some cloud APIs have additional methods that are prefixed with \fIex_\fP in Apache Libcloud, these methods
are part of the non\-standard API but can still
be accessed from the Salt modules for \fIlibcloud_storage\fP, \fIlibcloud_loadbalancer\fP and \fIlibcloud_dns\fP\&.
The extra methods are available via the \fIextra\fP command, which expects the name of the method as the
first argument, the profile as the second and then
accepts a list of keyword arguments to pass onto the driver method, for example, accessing permissions in Google Storage objects:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt myminion libcloud_storage.extra ex_get_permissions google container_name=my_container object_name=me.jpg \-\-out=yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Example profiles
.SS Google Cloud
.sp
Using Service Accounts with GCE, you can provide a path to the JSON file and the project name in the parameters.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
google:
    driver: gce
    user_id: 234234\-compute@developer.gserviceaccount.com
    key: /path/to/service_account_download.json
    auth_type: SA
    project: project\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.SS LXC Management with Salt
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This walkthrough assumes basic knowledge of Salt. To get up to speed, check
out the \fI\%Salt Walkthrough\fP\&.
.UNINDENT
.UNINDENT
.SS Dependencies
.sp
Manipulation of LXC containers in Salt requires the minion to have an LXC
version of at least 1.0 (an alpha or beta release of LXC 1.0 is acceptable).
The following distributions are known to have new enough versions of LXC
packaged:
.INDENT 0.0
.IP \(bu 2
RHEL/CentOS 6 and later (via \fI\%EPEL\fP)
.IP \(bu 2
Fedora (All non\-EOL releases)
.IP \(bu 2
Debian 8.0 (Jessie)
.IP \(bu 2
Ubuntu 14.04 LTS and later (LXC templates are packaged separately as
\fBlxc\-templates\fP, it is recommended to also install this package)
.IP \(bu 2
openSUSE 13.2 and later
.UNINDENT
.SS Profiles
.sp
Profiles allow for a sort of shorthand for commonly\-used
configurations to be defined in the minion config file, \fI\%grains\fP, \fI\%pillar\fP, or the master config file. The
profile is retrieved by Salt using the \fI\%config.get\fP function, which looks in those locations, in that
order. This allows for profiles to be defined centrally in the master config
file, with several options for overriding them (if necessary) on groups of
minions or individual minions.
.sp
There are two types of profiles:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
One for defining the parameters used in container creation/clone.
.IP \(bu 2
One for defining the container\(aqs network interface(s) settings.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Container Profiles
.sp
LXC container profiles are defined underneath the
\fBlxc.container_profile\fP config option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lxc.container_profile:
  centos:
    template: centos
    backing: lvm
    vgname: vg1
    lvname: lxclv
    size: 10G
  centos_big:
    template: centos
    backing: lvm
    vgname: vg1
    lvname: lxclv
    size: 20G
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Profiles are retrieved using the \fI\%config.get\fP
function, with the \fBrecurse\fP merge strategy. This means that a profile can be
defined at a lower level (for example, the master config file) and then parts
of it can be overridden at a higher level (for example, in pillar data).
Consider the following container profile data:
.sp
\fBIn the Master config file:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lxc.container_profile:
  centos:
    template: centos
    backing: lvm
    vgname: vg1
    lvname: lxclv
    size: 10G
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBIn the Pillar data\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lxc.container_profile:
  centos:
    size: 20G
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Any minion with the above Pillar data would have the \fBsize\fP parameter in the
\fBcentos\fP profile overridden to 20G, while those minions without the above
Pillar data would have the 10G \fBsize\fP value. This is another way of achieving
the same result as the \fBcentos_big\fP profile above, without having to define
another whole profile that differs in just one value.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In the 2014.7.x release cycle and earlier, container profiles are defined
under \fBlxc.profile\fP\&. This parameter will still work in version 2015.5.0,
but is deprecated and will be removed in a future release. Please note
however that the profile merging feature described above will only work
with profiles defined under \fBlxc.container_profile\fP, and only in versions
2015.5.0 and later.
.UNINDENT
.UNINDENT
.sp
Additionally, in version 2015.5.0 container profiles have been expanded to
support passing template\-specific CLI options to \fI\%lxc.create\fP\&. Below is a table describing the parameters which
can be configured in container profiles:
.TS
center;
|l|l|l|.
_
T{
Parameter
T}	T{
2015.5.0 and Newer
T}	T{
2014.7.x and Earlier
T}
_
T{
\fItemplate\fP\s-2\u1\d\s0
T}	T{
Yes
T}	T{
Yes
T}
_
T{
\fIoptions\fP\s-2\u1\d\s0
T}	T{
Yes
T}	T{
No
T}
_
T{
\fIimage\fP\s-2\u1\d\s0
T}	T{
Yes
T}	T{
Yes
T}
_
T{
\fIbacking\fP
T}	T{
Yes
T}	T{
Yes
T}
_
T{
\fIsnapshot\fP\s-2\u2\d\s0
T}	T{
Yes
T}	T{
Yes
T}
_
T{
\fIlvname\fP\s-2\u1\d\s0
T}	T{
Yes
T}	T{
Yes
T}
_
T{
\fIfstype\fP\s-2\u1\d\s0
T}	T{
Yes
T}	T{
Yes
T}
_
T{
\fIsize\fP
T}	T{
Yes
T}	T{
Yes
T}
_
.TE
.INDENT 0.0
.IP 1. 3
Parameter is only supported for container creation, and will be ignored if
the profile is used when cloning a container.
.IP 2. 3
Parameter is only supported for container cloning, and will be ignored if
the profile is used when not cloning a container.
.UNINDENT
.SS Network Profiles
.sp
LXC network profiles are defined defined underneath the \fBlxc.network_profile\fP
config option.
By default, the module uses a DHCP based configuration and try to guess a bridge to
get connectivity.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
on pre \fB2015.5.2\fP, you need to specify explicitly the network bridge
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lxc.network_profile:
  centos:
    eth0:
      link: br0
      type: veth
      flags: up
  ubuntu:
    eth0:
      link: lxcbr0
      type: veth
      flags: up
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As with container profiles, network profiles are retrieved using the
\fI\%config.get\fP function, with the \fBrecurse\fP
merge strategy. Consider the following network profile data:
.sp
\fBIn the Master config file:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lxc.network_profile:
  centos:
    eth0:
      link: br0
      type: veth
      flags: up
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBIn the Pillar data\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lxc.network_profile:
  centos:
    eth0:
      link: lxcbr0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Any minion with the above Pillar data would use the \fBlxcbr0\fP interface as the
bridge interface for any container configured using the \fBcentos\fP network
profile, while those minions without the above Pillar data would use the
\fBbr0\fP interface for the same.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In the 2014.7.x release cycle and earlier, network profiles are defined
under \fBlxc.nic\fP\&. This parameter will still work in version 2015.5.0, but
is deprecated and will be removed in a future release. Please note however
that the profile merging feature described above will only work with
profiles defined under \fBlxc.network_profile\fP, and only in versions
2015.5.0 and later.
.UNINDENT
.UNINDENT
.sp
The following are parameters which can be configured in network profiles. These
will directly correspond to a parameter in an LXC configuration file (see \fBman
5 lxc.container.conf\fP).
.INDENT 0.0
.IP \(bu 2
\fBtype\fP \- Corresponds to \fBlxc.network.type\fP
.IP \(bu 2
\fBlink\fP \- Corresponds to \fBlxc.network.link\fP
.IP \(bu 2
\fBflags\fP \- Corresponds to \fBlxc.network.flags\fP
.UNINDENT
.sp
Interface\-specific options (MAC address, IPv4/IPv6, etc.) must be passed on a
container\-by\-container basis, for instance using the \fBnic_opts\fP argument to
\fI\%lxc.create\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.create container1 profile=centos network_profile=centos nic_opts=\(aq{eth0: {ipv4: 10.0.0.20/24, gateway: 10.0.0.1}}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
The \fBipv4\fP, \fBipv6\fP, \fBgateway\fP, and \fBlink\fP (bridge) settings in
network profiles / nic_opts will only work if the container doesn\(aqt redefine
the network configuration (for example in
\fB/etc/sysconfig/network\-scripts/ifcfg\-<interface_name>\fP on RHEL/CentOS,
or \fB/etc/network/interfaces\fP on Debian/Ubuntu/etc.). Use these with
caution. The container images installed using the \fBdownload\fP template,
for instance, typically are configured for eth0 to use DHCP, which will
conflict with static IP addresses set at the container level.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For LXC < 1.0.7 and DHCP support, set \fBipv4.gateway: \(aqauto\(aq\fP is your
network profile, ie.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lxc.network_profile.nic:
  debian:
    eth0:
      link: lxcbr0
      ipv4.gateway: \(aqauto\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Old lxc support (<1.0.7)
.sp
With saltstack \fB2015.5.2\fP and above, normally the setting is autoselected, but
before, you\(aqll need to teach your network profile to set
\fBlxc.network.ipv4.gateway\fP to \fBauto\fP when using a classic ipv4 configuration.
.sp
Thus you\(aqll need
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lxc.network_profile.foo:
  etho:
    link: lxcbr0
    ipv4.gateway: auto
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Tricky network setups Examples
.sp
This example covers how to make a container with both an internal ip and a
public routable ip, wired on two veth pairs.
.sp
The another interface which receives directly a public routable ip can\(aqt be on
the first interface that we reserve for private inter LXC networking.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lxc.network_profile.foo:
  eth0: {gateway: null, bridge: lxcbr0}
  eth1:
    # replace that by your main interface
    \(aqlink\(aq: \(aqbr0\(aq
    \(aqmac\(aq: \(aq00:16:5b:01:24:e1\(aq
    \(aqgateway\(aq: \(aq2.20.9.14\(aq
    \(aqipv4\(aq: \(aq2.20.9.1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Creating a Container on the CLI
.SS From a Template
.sp
LXC is commonly distributed with several template scripts in
/usr/share/lxc/templates. Some distros may package these separately in an
\fBlxc\-templates\fP package, so make sure to check if this is the case.
.sp
There are LXC template scripts for several different operating systems, but
some of them are designed to use tools specific to a given distribution. For
instance, the \fBubuntu\fP template uses deb_bootstrap, the \fBcentos\fP template
uses yum, etc., making these templates impractical when a container from a
different OS is desired.
.sp
The \fI\%lxc.create\fP function is used to create
containers using a template script. To create a CentOS container named
\fBcontainer1\fP on a CentOS minion named \fBmycentosminion\fP, using the
\fBcentos\fP LXC template, one can simply run the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt mycentosminion lxc.create container1 template=centos
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For these instances, there is a \fBdownload\fP template which retrieves minimal
container images for several different operating systems. To use this template,
it is necessary to provide an \fBoptions\fP parameter when creating the
container, with three values:
.INDENT 0.0
.IP 1. 3
\fBdist\fP \- the Linux distribution (i.e. \fBubuntu\fP or \fBcentos\fP)
.IP 2. 3
\fBrelease\fP \- the release name/version (i.e. \fBtrusty\fP or \fB6\fP)
.IP 3. 3
\fBarch\fP \- CPU architecture (i.e. \fBamd64\fP or \fBi386\fP)
.UNINDENT
.sp
The \fI\%lxc.images\fP function (new in version
2015.5.0) can be used to list the available images. Alternatively, the releases
can be viewed on \fI\%http://images.linuxcontainers.org/images/\fP\&. The images are
organized in such a way that the \fBdist\fP, \fBrelease\fP, and \fBarch\fP can be
determined using the following URL format:
\fBhttp://images.linuxcontainers.org/images/dist/release/arch\fP\&. For example,
\fBhttp://images.linuxcontainers.org/images/centos/6/amd64\fP would correspond to
a \fBdist\fP of \fBcentos\fP, a \fBrelease\fP of \fB6\fP, and an \fBarch\fP of \fBamd64\fP\&.
.sp
Therefore, to use the \fBdownload\fP template to create a new 64\-bit CentOS 6
container, the following command can be used:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.create container1 template=download options=\(aq{dist: centos, release: 6, arch: amd64}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
These command\-line options can be placed into a \fI\%container profile\fP, like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lxc.container_profile.cent6:
  template: download
  options:
    dist: centos
    release: 6
    arch: amd64
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBoptions\fP parameter is not supported in profiles for the 2014.7.x
release cycle and earlier, so it would still need to be provided on the
command\-line.
.UNINDENT
.UNINDENT
.SS Cloning an Existing Container
.sp
To clone a container, use the \fI\%lxc.clone\fP
function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.clone container2 orig=container1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Using a Container Image
.sp
While cloning is a good way to create new containers from a common base
container, the source container that is being cloned needs to already exist on
the minion. This makes deploying a common container across minions difficult.
For this reason, Salt\(aqs \fI\%lxc.create\fP is capable
of installing a container from a tar archive of another container\(aqs rootfs. To
create an image of a container named \fBcent6\fP, run the following command as
root:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tar czf cent6.tar.gz \-C /var/lib/lxc/cent6 rootfs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Before doing this, it is recommended that the container is stopped.
.UNINDENT
.UNINDENT
.sp
The resulting tarball can then be placed alongside the files in the salt
fileserver and referenced using a \fBsalt://\fP URL. To create a container using
an image, use the \fBimage\fP parameter with \fI\%lxc.create\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.create new\-cent6 image=salt://path/to/cent6.tar.gz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Making images of containers with LVM backing
.sp
For containers with LVM backing, the rootfs is not mounted, so it is
necessary to mount it first before creating the tar archive. When a
container is created using LVM backing, an empty \fBrootfs\fP dir is handily
created within \fB/var/lib/lxc/container_name\fP, so this can be used as the
mountpoint. The location of the logical volume for the container will be
\fB/dev/vgname/lvname\fP, where \fBvgname\fP is the name of the volume group,
and \fBlvname\fP is the name of the logical volume. Therefore, assuming a
volume group of \fBvg1\fP, a logical volume of \fBlxc\-cent6\fP, and a container
name of \fBcent6\fP, the following commands can be used to create a tar
archive of the rootfs:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mount /dev/vg1/lxc\-cent6 /var/lib/lxc/cent6/rootfs
tar czf cent6.tar.gz \-C /var/lib/lxc/cent6 rootfs
umount /var/lib/lxc/cent6/rootfs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
One caveat of using this method of container creation is that
\fB/etc/hosts\fP is left unmodified.  This could cause confusion for some
distros if salt\-minion is later installed on the container, as the
functions that determine the hostname take \fB/etc/hosts\fP into account.
.sp
Additionally, when creating an rootfs image, be sure to remove
\fB/etc/salt/minion_id\fP and make sure that \fBid\fP is not defined in
\fB/etc/salt/minion\fP, as this will cause similar issues.
.UNINDENT
.UNINDENT
.SS Initializing a New Container as a Salt Minion
.sp
The above examples illustrate a few ways to create containers on the CLI, but
often it is desirable to also have the new container run as a Minion. To do
this, the \fI\%lxc.init\fP function can be used. This
function will do the following:
.INDENT 0.0
.IP 1. 3
Create a new container
.IP 2. 3
Optionally set password and/or DNS
.IP 3. 3
Bootstrap the minion (using either \fI\%salt\-bootstrap\fP or a custom command)
.UNINDENT
.sp
By default, the new container will be pointed at the same Salt Master as the
host machine on which the container was created. It will then request to
authenticate with the Master like any other bootstrapped Minion, at which point
it can be accepted.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.init test1 profile=centos
salt\-key \-a test1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For even greater convenience, the \fI\%LXC runner\fP contains
a runner function of the same name (\fI\%lxc.init\fP),
which creates a keypair, seeds the new minion with it, and pre\-accepts the key,
allowing for the new Minion to be created and authorized in a single step:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run lxc.init test1 host=myminion profile=centos
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Running Commands Within a Container
.sp
For containers which are not running their own Minion, commands can be run
within the container in a manner similar to using (\fBcmd.run
<salt.modules.cmdmod.run\fP). The means of doing this have been changed
significantly in version 2015.5.0 (though the deprecated behavior will still be
supported for a few releases). Both the old and new usage are documented
below.
.SS 2015.5.0 and Newer
.sp
New functions have been added to mimic the behavior of the functions in the
\fI\%cmd\fP module. Below is a table with the \fI\%cmd\fP functions and their \fI\%lxc\fP module
equivalents:
.TS
center;
|l|l|l|.
_
T{
Description
T}	T{
\fI\%cmd\fP module
T}	T{
\fI\%lxc\fP module
T}
_
T{
Run a command and get all output
T}	T{
\fI\%cmd.run\fP
T}	T{
\fI\%lxc.run\fP
T}
_
T{
Run a command and get just stdout
T}	T{
\fI\%cmd.run_stdout\fP
T}	T{
\fI\%lxc.run_stdout\fP
T}
_
T{
Run a command and get just stderr
T}	T{
\fI\%cmd.run_stderr\fP
T}	T{
\fI\%lxc.run_stderr\fP
T}
_
T{
Run a command and get just the retcode
T}	T{
\fI\%cmd.retcode\fP
T}	T{
\fI\%lxc.retcode\fP
T}
_
T{
Run a command and get all information
T}	T{
\fI\%cmd.run_all\fP
T}	T{
\fI\%lxc.run_all\fP
T}
_
.TE
.SS 2014.7.x and Earlier
.sp
Earlier Salt releases use a single function (\fBlxc.run_cmd\fP) to run commands within containers. Whether stdout,
stderr, etc. are returned depends on how the function is invoked.
.sp
To run a command and return the stdout:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.run_cmd web1 \(aqtail /var/log/messages\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To run a command and return the stderr:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.run_cmd web1 \(aqtail /var/log/messages\(aq stdout=False stderr=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To run a command and return the retcode:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.run_cmd web1 \(aqtail /var/log/messages\(aq stdout=False stderr=False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To run a command and return all information:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.run_cmd web1 \(aqtail /var/log/messages\(aq stdout=True stderr=True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Container Management Using salt\-cloud
.sp
Salt cloud uses under the hood the salt runner and module to manage containers,
Please look at \fI\%this chapter\fP
.SS Container Management Using States
.sp
Several states are being renamed or otherwise modified in version 2015.5.0. The
information in this tutorial refers to the new states. For
2014.7.x and earlier, please refer to the \fI\%documentation for the LXC
states\fP\&.
.SS Ensuring a Container Is Present
.sp
To ensure the existence of a named container, use the \fI\%lxc.present\fP state. Here are some examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Using a template
web1:
  lxc.present:
    \- template: download
    \- options:
        dist: centos
        release: 6
        arch: amd64

# Cloning
web2:
  lxc.present:
    \- clone_from: web\-base

# Using a rootfs image
web3:
  lxc.present:
    \- image: salt://path/to/cent6.tar.gz

# Using profiles
web4:
  lxc.present:
    \- profile: centos_web
    \- network_profile: centos
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
The \fI\%lxc.present\fP state will not modify an
existing container (in other words, it will not re\-create the container).
If an \fI\%lxc.present\fP state is run on an
existing container, there will be no change and the state will return a
\fBTrue\fP result.
.UNINDENT
.UNINDENT
.sp
The \fI\%lxc.present\fP state also includes an
optional \fBrunning\fP parameter which can be used to ensure that a container is
running/stopped. Note that there are standalone \fI\%lxc.running\fP and \fI\%lxc.stopped\fP
states which can be used for this purpose.
.SS Ensuring a Container Does Not Exist
.sp
To ensure that a named container is not present, use the \fI\%lxc.absent\fP state. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
web1:
  lxc.absent
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Ensuring a Container is Running/Stopped/Frozen
.sp
Containers can be in one of three states:
.INDENT 0.0
.IP \(bu 2
\fBrunning\fP \- Container is running and active
.IP \(bu 2
\fBfrozen\fP \- Container is running, but all process are blocked and the
container is essentially non\-active until the container is \(dqunfrozen\(dq
.IP \(bu 2
\fBstopped\fP \- Container is not running
.UNINDENT
.sp
Salt has three states (\fI\%lxc.running\fP,
\fI\%lxc.frozen\fP, and \fI\%lxc.stopped\fP) which can be used to ensure a container is in one
of these states:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
web1:
  lxc.running

# Restart the container if it was already running
web2:
  lxc.running:
    \- restart: True

web3:
  lxc.stopped

# Explicitly kill all tasks in container instead of gracefully stopping
web4:
  lxc.stopped:
    \- kill: True

web5:
  lxc.frozen

# If container is stopped, do not start it (in which case the state will fail)
web6:
  lxc.frozen:
    \- start: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Master Cluster
.sp
A clustered Salt Master has several advantages over Salt\(aqs traditional High
Availability options. First, a master cluster is meant to be served behind a
load balancer. Minions only need to know about the load balancer\(aqs IP address.
Therefore, masters can be added and removed from a cluster without the need to
re\-configure minions. Another major benefit of master clusters over Salt\(aqs
older HA implimentations is that Masters in a cluster share the load of all
jobs. This allows Salt administrators to more easily scale their environments
to handle larger numbers of minions and larger jobs.
.SS Minimum Requirements
.sp
Running a cluster master requires all nodes in the cluster to have a shared
filesystem. The \fIcluster_pki_dir\fP, \fIcache_dir\fP, \fIfile_roots\fP and \fIpillar_roots\fP
must all be on a shared filesystem. Most implementations will also serve the
masters publish and request server ports via a tcp load balancer. All of the
masters in a cluster are assumed to be running on a reliable local area
network.
.sp
Each master in a cluster maintains its own public and private key, and an in
memory aes key. Each cluster peer also has access to the \fIcluster_pki_dir\fP
where a cluster wide public and private key are stored. In addition, the cluster
wide aes key is generated and stored in the \fIcluster_pki_dir\fP\&. Further,
when operating as a cluster, minion keys are stored in the \fIcluster_pki_dir\fP
instead of the master\(aqs \fIpki_dir\fP\&.
.SS Reference Implimentation
.sp
Gluster: \fI\%https://docs.gluster.org/en/main/Quick\-Start\-Guide/Quickstart/\fP
.sp
HAProxy:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
frontend salt\-master\-pub
    mode tcp
    bind 10.27.5.116:4505
    option tcplog
    timeout client  1m
    default_backend salt\-master\-pub\-backend

backend salt\-master\-pub\-backend
    mode tcp
    option tcplog
    #option log\-health\-checks
    log global
    #balance source
    balance roundrobin
    timeout connect 10s
    timeout server 1m
    server rserve1 10.27.12.13:4505 check
    server rserve2 10.27.7.126:4505 check
    server rserve3 10.27.3.73:4505 check

frontend salt\-master\-req
    mode tcp
    bind 10.27.5.116:4506
    option tcplog
    timeout client  1m
    default_backend salt\-master\-req\-backend

backend salt\-master\-req\-backend
    mode tcp
    option tcplog
    #option log\-health\-checks
    log global
    balance roundrobin
    #balance source
    timeout connect 10s
    timeout server 1m
    server rserve1 10.27.12.13:4506 check
    server rserve2 10.27.7.126:4506 check
    server rserve3 10.27.3.73:4506 check
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Master Config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
id: 10.27.12.13
cluster_id: master_cluster
cluster_peers:
  \- 10.27.7.126
  \- 10.27.3.73
cluster_pki_dir: /my/gluster/share/pki
cachedir: /my/gluster/share/cache
file_roots:
    \- /my/gluster/share/srv/salt
pillar_roots:
    \- /my/gluster/share/srv/pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Remote execution tutorial
.sp
\fBBefore continuing\fP make sure you have a working Salt installation by
following the instructions in the
\fI\%Salt install guide\fP\&.
.INDENT 0.0
.INDENT 3.5
.IP "Stuck?"
.sp
The Salt Project community can help offer advice and help troubleshoot
technical issues as you\(aqre learning about Salt. One of the best places to
talk to the community is on the
\fI\%Salt Project Slack workspace\fP\&.
.UNINDENT
.UNINDENT
.SS Order your minions around
.sp
Now that you have a \fI\%master\fP and at least one \fI\%minion\fP
communicating with each other you can perform commands on the minion via the
\fBsalt\fP command. Salt calls are comprised of three main components:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq<target>\(aq <function> [arguments]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%salt manpage\fP
.UNINDENT
.UNINDENT
.SS target
.sp
The target component allows you to filter which minions should run the
following function. The default filter is a glob on the minion id. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.version
salt \(aq*.example.org\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Targets can be based on minion system information using the Grains system:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos:Ubuntu\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Grains system\fP
.UNINDENT
.UNINDENT
.sp
Targets can be filtered by regular expression:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-E \(aqvirtmach[0\-9]\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Targets can be explicitly specified in a list:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-L \(aqfoo,bar,baz,quo\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or Multiple target types can be combined in one command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-C \(aqG@os:Ubuntu and webser* or E@database.*\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.SS function
.sp
A function is some functionality provided by a module. Salt ships with a large
collection of available functions. List all available functions on your
minions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.doc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here are some examples:
.sp
Show all currently available minions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Run an arbitrary shell command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run \(aquname \-a\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%the full list of modules\fP
.UNINDENT
.UNINDENT
.SS arguments
.sp
Space\-delimited arguments to the function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.exec_code python \(aqimport sys; print sys.version\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Optional, keyword arguments are also supported:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.install salt timeout=5 upgrade=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
They are always in the form of \fBkwarg=argument\fP\&.
.SS Multi Master Tutorial
.sp
As of Salt 0.16.0, the ability to connect minions to multiple masters has been
made available. The multi\-master system allows for redundancy of Salt
masters and facilitates multiple points of communication out to minions. When
using a multi\-master setup, all masters are running hot, and any active master
can be used to send commands out to the minions.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you need failover capabilities with multiple masters, there is also a
MultiMaster\-PKI setup available, that uses a different topology
\fI\%MultiMaster\-PKI with Failover Tutorial\fP
.UNINDENT
.UNINDENT
.sp
In 0.16.0, the masters do not share any information, keys need to be accepted
on both masters, and shared files need to be shared manually or use tools like
the git fileserver backend to ensure that the \fI\%file_roots\fP are
kept consistent.
.sp
Beginning with Salt 2016.11.0, the \fI\%Pluggable Minion Data Cache\fP
was introduced. The minion data cache contains the Salt Mine data, minion grains, and minion
pillar information cached on the Salt Master. By default, Salt uses the \fBlocalfs\fP cache
module, but other external data stores can be used instead.
.sp
Using a pluggable minion cache modules allows for the data stored on a Salt Master about
Salt Minions to be replicated on other Salt Masters the Minion is connected to. Please see
the \fI\%Minion Data Cache\fP documentation for more information and configuration
examples.
.SS Summary of Steps
.INDENT 0.0
.IP 1. 3
Create a redundant master server
.IP 2. 3
Copy primary master key to redundant master
.IP 3. 3
Start redundant master
.IP 4. 3
Configure minions to connect to redundant master
.IP 5. 3
Restart minions
.IP 6. 3
Accept keys on redundant master
.UNINDENT
.SS Prepping a Redundant Master
.sp
The first task is to prepare the redundant master. If the redundant master is
already running, stop it. There is only one requirement when preparing a
redundant master, which is that masters share the same private key. When the
first master was created, the master\(aqs identifying key pair was generated and
placed in the master\(aqs \fBpki_dir\fP\&. The default location of the master\(aqs key
pair is \fB/etc/salt/pki/master/\fP\&. Take the private key, \fBmaster.pem\fP, and
copy it to the same location on the redundant master. Do the same for the
master\(aqs public key, \fBmaster.pub\fP\&. Assuming that no minions have yet been
connected to the new redundant master, it is safe to delete any existing key
in this location and replace it.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
There is no logical limit to the number of redundant masters that can be
used.
.UNINDENT
.UNINDENT
.sp
Once the new key is in place, the redundant master can be safely started.
.SS Configure Minions
.sp
Since minions need to be master\-aware, the new master needs to be added to the
minion configurations. Simply update the minion configurations to list all
connected masters:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master:
  \- saltmaster1.example.com
  \- saltmaster2.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now the minion can be safely restarted.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If the ipc_mode for the minion is set to TCP (default in Windows), then
each minion in the multi\-minion setup (one per master) needs its own
tcp_pub_port and tcp_pull_port.
.sp
If these settings are left as the default 4510/4511, each minion object
will receive a port 2 higher than the previous. Thus the first minion will
get 4510/4511, the second will get 4512/4513, and so on. If these port
decisions are unacceptable, you must configure tcp_pub_port and
tcp_pull_port with lists of ports for each master. The length of these
lists should match the number of masters, and there should not be overlap
in the lists.
.UNINDENT
.UNINDENT
.sp
Now the minions will check into the original master and also check into the new
redundant master. Both masters are first\-class and have rights to the minions.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Minions can automatically detect failed masters and attempt to reconnect
to them quickly. To enable this functionality, set
\fImaster_alive_interval\fP in the minion config and specify a number of
seconds to poll the masters for connection status.
.sp
If this option is not set, minions will still reconnect to failed masters
but the first command sent after a master comes back up may be lost while
the minion authenticates.
.UNINDENT
.UNINDENT
.SS Sharing Files Between Masters
.sp
Salt does not automatically share files between multiple masters. A number of
files should be shared or sharing of these files should be strongly considered.
.SS Minion Keys
.sp
Minion keys can be accepted the normal way using \fBsalt\-key\fP on both
masters.  Keys accepted, deleted, or rejected on one master will NOT be
automatically managed on redundant masters; this needs to be taken care of by
running salt\-key on both masters or sharing the
\fB/etc/salt/pki/master/{minions,minions_pre,minions_rejected}\fP directories
between masters.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
While sharing the \fB/etc/salt/pki/master\fP directory will work, it is
strongly discouraged, since allowing access to the \fBmaster.pem\fP key
outside of Salt creates a \fISERIOUS\fP security risk.
.UNINDENT
.UNINDENT
.SS File_Roots
.sp
The \fI\%file_roots\fP contents should be kept consistent between
masters. Otherwise state runs will not always be consistent on minions since
instructions managed by one master will not agree with other masters.
.sp
The recommended way to sync these is to use a fileserver backend like gitfs or
to keep these files on shared storage.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If using gitfs/git_pillar with the cachedir shared between masters using
\fI\%GlusterFS\fP, nfs, or another network filesystem, and the masters are
running Salt 2015.5.9 or later, it is strongly recommended not to turn off
\fI\%gitfs_global_lock\fP/\fI\%git_pillar_global_lock\fP as
doing so will cause lock files to be removed if they were created by a
different master.
.UNINDENT
.UNINDENT
.SS Pillar_Roots
.sp
Pillar roots should be given the same considerations as
\fI\%file_roots\fP\&.
.SS Master Configurations
.sp
While reasons may exist to maintain separate master configurations, it is wise
to remember that each master maintains independent control over minions.
Therefore, access controls should be in sync between masters unless a valid
reason otherwise exists to keep them inconsistent.
.sp
These access control options include but are not limited to:
.INDENT 0.0
.IP \(bu 2
external_auth
.IP \(bu 2
publisher_acl
.IP \(bu 2
peer
.IP \(bu 2
peer_run
.UNINDENT
.SS Multi\-Master\-PKI Tutorial With Failover
.sp
This tutorial will explain, how to run a salt\-environment where a single
minion can have multiple masters and fail\-over between them if its current
master fails.
.sp
The individual steps are
.INDENT 0.0
.IP \(bu 2
setup the master(s) to sign its auth\-replies
.IP \(bu 2
setup minion(s) to verify master\-public\-keys
.IP \(bu 2
enable multiple masters on minion(s)
.IP \(bu 2
enable master\-check on  minion(s)
.INDENT 2.0
.INDENT 3.5
Please note, that it is advised to have good knowledge of the salt\-
authentication and communication\-process to understand this tutorial.
All of the settings described here, go on top of the default
authentication/communication process.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Motivation
.sp
The default behaviour of a salt\-minion is to connect to a master and accept
the masters public key. With each publication, the master sends his public\-key
for the minion to check and if this public\-key ever changes, the minion
complains and exits. Practically this means, that there can only be a single
master at any given time.
.sp
Would it not be much nicer, if the minion could have any number of masters
(1:n) and jump to the next master if its current master died because of a
network or hardware failure?
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
There is also a MultiMaster\-Tutorial with a different approach and topology
than this one, that might also suite your needs or might even be better suited
\fI\%Multi\-Master Tutorial\fP
.UNINDENT
.UNINDENT
.sp
It is also desirable, to add some sort of authenticity\-check to the very first
public key a minion receives from a master. Currently a minions takes the
first masters public key for granted.
.SS The Goal
.sp
Setup the master to sign the public key it sends to the minions and enable the
minions to verify this signature for authenticity.
.SS Prepping the master to sign its public key
.sp
For signing to work, both master and minion must have the signing and/or
verification settings enabled. If the master signs the public key but the
minion does not verify it, the minion will complain and exit. The same
happens, when the master does not sign but the minion tries to verify.
.sp
The easiest way to have the master sign its public key is to set
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_sign_pubkey: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
After restarting the salt\-master service, the master will automatically
generate a new key\-pair
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_sign.pem
master_sign.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A custom name can be set for the signing key\-pair by setting
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_sign_key_name: <name_without_suffix>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The master will then generate that key\-pair upon restart and use it for
creating the public keys signature attached to the auth\-reply.
.sp
The computation is done for every auth\-request of a minion. If many minions
auth very often, it is advised to use conf_master:\fImaster_pubkey_signature\fP
and conf_master:\fImaster_use_pubkey_signature\fP settings described below.
.sp
If multiple masters are in use and should sign their auth\-replies, the signing
key\-pair master_sign.* has to be copied to each master. Otherwise a minion
will fail to verify the masters public when connecting to a different master
than it did initially. That is because the public keys signature was created
with a different signing key\-pair.
.SS Prepping the minion to verify received public keys
.sp
The minion must have the public key (and only that one!) available to be
able to verify a signature it receives. That public key (defaults to
master_sign.pub) must be copied from the master to the minions pki\-directory.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/salt/pki/minion/master_sign.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
DO NOT COPY THE master_sign.pem FILE. IT MUST STAY ON THE MASTER AND
ONLY THERE!
.UNINDENT
.UNINDENT
.sp
When that is done, enable the signature checking in the minions configuration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
verify_master_pubkey_sign: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
and restart the minion. For the first try, the minion should be run in manual
debug mode.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-minion \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Upon connecting to the master, the following lines should appear on the output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[DEBUG   ] Attempting to authenticate with the Salt Master at 172.16.0.10
[DEBUG   ] Loaded minion key: /etc/salt/pki/minion/minion.pem
[DEBUG   ] salt.crypt.verify_signature: Loading public key
[DEBUG   ] salt.crypt.verify_signature: Verifying signature
[DEBUG   ] Successfully verified signature of master public key with verification public key master_sign.pub
[INFO    ] Received signed and verified master pubkey from master 172.16.0.10
[DEBUG   ] Decrypting the current master AES key
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the signature verification fails, something went wrong and it will look
like this
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[DEBUG   ] Attempting to authenticate with the Salt Master at 172.16.0.10
[DEBUG   ] Loaded minion key: /etc/salt/pki/minion/minion.pem
[DEBUG   ] salt.crypt.verify_signature: Loading public key
[DEBUG   ] salt.crypt.verify_signature: Verifying signature
[DEBUG   ] Failed to verify signature of public key
[CRITICAL] The Salt Master server\(aqs public key did not authenticate!
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In a case like this, it should be checked, that the verification pubkey
(master_sign.pub) on the minion is the same as the one on the master.
.sp
Once the verification is successful, the minion can be started in daemon mode
again.
.sp
For the paranoid among us, its also possible to verify the publication whenever
it is received from the master. That is, for every single auth\-attempt which
can be quite frequent. For example just the start of the minion will force the
signature to be checked 6 times for various things like auth, mine,
\fI\%highstate\fP, etc.
.sp
If that is desired, enable the setting
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
always_verify_signature: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Multiple Masters For A Minion
.sp
Configuring multiple masters on a minion is done by specifying two settings:
.INDENT 0.0
.IP \(bu 2
a list of masters addresses
.IP \(bu 2
what type of master is defined
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master:
    \- 172.16.0.10
    \- 172.16.0.11
    \- 172.16.0.12
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_type: failover
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This tells the minion that all the master above are available for it to
connect to. When started with this configuration, it will try the master
in the order they are defined. To randomize that order, set
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
random_master: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The master\-list will then be shuffled before the first connection attempt.
.sp
The first master that accepts the minion, is used by the minion. If the
master does not yet know the minion, that counts as accepted and the minion
stays on that master.
.sp
For the minion to be able to detect if its still connected to its current
master enable the check for it
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_alive_interval: <seconds>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the loss of the connection is detected, the minion will temporarily
remove the failed master from the list and try one of the other masters
defined (again shuffled if that is enabled).
.SS Testing the setup
.sp
At least two running masters are needed to test the failover setup.
.sp
Both masters should be running and the minion should be running on the command
line in debug mode
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-minion \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The minion will connect to the first master from its master list
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[DEBUG   ] Attempting to authenticate with the Salt Master at 172.16.0.10
[DEBUG   ] Loaded minion key: /etc/salt/pki/minion/minion.pem
[DEBUG   ] salt.crypt.verify_signature: Loading public key
[DEBUG   ] salt.crypt.verify_signature: Verifying signature
[DEBUG   ] Successfully verified signature of master public key with verification public key master_sign.pub
[INFO    ] Received signed and verified master pubkey from master 172.16.0.10
[DEBUG   ] Decrypting the current master AES key
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A test.version on the master the minion is currently connected to should be run to
test connectivity.
.sp
If successful, that master should be turned off. A firewall\-rule denying the
minions packets will also do the trick.
.sp
Depending on the configured conf_minion:\fImaster_alive_interval\fP, the minion
will notice the loss of the connection and log it to its logfile.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[INFO    ] Connection to master 172.16.0.10 lost
[INFO    ] Trying to tune in to next master from master\-list
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The minion will then remove the current master from the list and try connecting
to the next master
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[INFO    ] Removing possibly failed master 172.16.0.10 from list of masters
[WARNING ] Master ip address changed from 172.16.0.10 to 172.16.0.11
[DEBUG   ] Attempting to authenticate with the Salt Master at 172.16.0.11
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If everything is configured correctly, the new masters public key will be
verified successfully
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[DEBUG   ] Loaded minion key: /etc/salt/pki/minion/minion.pem
[DEBUG   ] salt.crypt.verify_signature: Loading public key
[DEBUG   ] salt.crypt.verify_signature: Verifying signature
[DEBUG   ] Successfully verified signature of master public key with verification public key master_sign.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
the authentication with the new master is successful
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[INFO    ] Received signed and verified master pubkey from master 172.16.0.11
[DEBUG   ] Decrypting the current master AES key
[DEBUG   ] Loaded minion key: /etc/salt/pki/minion/minion.pem
[INFO    ] Authentication with master successful!
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
and the minion can be pinged again from its new master.
.SS Performance Tuning
.sp
With the setup described above, the master computes a signature for every
auth\-request of a minion. With many minions and many auth\-requests, that
can chew up quite a bit of CPU\-Power.
.sp
To avoid that, the master can use a pre\-created signature of its public\-key.
The signature is saved as a base64 encoded string which the master reads
once when starting and attaches only that string to auth\-replies.
.sp
Enabling this also gives paranoid users the possibility, to have the signing
key\-pair on a different system than the actual salt\-master and create the public
keys signature there. Probably on a system with more restrictive firewall rules,
without internet access, less users, etc.
.sp
That signature can be created with
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-\-gen\-signature
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will create a default signature file in the master pki\-directory
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/salt/pki/master/master_pubkey_signature
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is a simple text\-file with the binary\-signature converted to base64.
.sp
If no signing\-pair is present yet, this will auto\-create the signing pair and
the signature file in one call
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-\-gen\-signature \-\-auto\-create
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Telling the master to use the pre\-created signature is done with
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_use_pubkey_signature: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
That requires the file \(aqmaster_pubkey_signature\(aq to be present in the masters
pki\-directory with the correct signature.
.sp
If the signature file is named differently, its name can be set with
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_pubkey_signature: <filename>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With many masters and many public\-keys (default and signing), it is advised to
use the salt\-masters hostname for the signature\-files name. Signatures can be
easily confused because they do not provide any information about the key the
signature was created from.
.sp
Verifying that everything works is done the same way as above.
.SS How the signing and verification works
.sp
The default key\-pair of the salt\-master is
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/salt/pki/master/master.pem
/etc/salt/pki/master/master.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To be able to create a signature of a message (in this case a public\-key),
another key\-pair has to be added to the setup. Its default name is:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_sign.pem
master_sign.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The combination of the master.* and master_sign.* key\-pairs give the
possibility of generating signatures. The signature of a given message
is unique and can be verified, if the public\-key of the signing\-key\-pair
is available to the recipient (the minion).
.sp
The signature of the masters public\-key in master.pub is computed with
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_sign.pem
master.pub
M2Crypto.EVP.sign_update()
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This results in a binary signature which is converted to base64 and attached
to the auth\-reply send to the minion.
.sp
With the signing\-pairs public\-key available to the minion, the attached
signature can be verified with
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_sign.pub
master.pub
M2Cryptos EVP.verify_update().
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When running multiple masters, either the signing key\-pair has to be present
on all of them, or the master_pubkey_signature has to be pre\-computed for
each master individually (because they all have different public\-keys).
.INDENT 0.0
.INDENT 3.5
DO NOT PUT THE SAME master.pub ON ALL MASTERS FOR EASE OF USE.
.UNINDENT
.UNINDENT
.SS Packaging External Modules for Salt
.SS External Modules Setuptools Entry\-Points Support
.sp
The salt loader was enhanced to look for external modules by looking at the
\fIsalt.loader\fP entry\-point:
.INDENT 0.0
.INDENT 3.5
\fI\%https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry\-points\fP
.UNINDENT
.UNINDENT
.sp
\fIpkg_resources\fP should be installed, which is normally included in setuptools.
.INDENT 0.0
.INDENT 3.5
\fI\%https://setuptools.readthedocs.io/en/latest/pkg_resources.html\fP
.UNINDENT
.UNINDENT
.sp
The package which has custom engines, minion modules, outputters, etc, should
require setuptools and should define the following entry points in its setup
function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from setuptools import setup, find_packages

setup(
    name=THE_NAME,
    version=THE_VERSION,
    description=THE_DESCRIPTION,
    author=THE_AUTHOR_NAME,
    author_email=THE_AUTHOR_EMAIL,
    url=\(dq ... \(dq,
    packages=find_packages(),
    entry_points=\(dq\(dq\(dq
    [salt.loader]
    engines_dirs = <package>.<loader\-module>:engines_dirs
    fileserver_dirs = <package>.<loader\-module>:fileserver_dirs
    pillar_dirs = <package>.<loader\-module>:pillar_dirs
    returner_dirs = <package>.<loader\-module>:returner_dirs
    roster_dirs = <package>.<loader\-module>:roster_dirs
    \(dq\(dq\(dq,
)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above setup script example mentions a loader module. here\(aqs an example of
how \fI<package>/<loader\-module>.py\fP it should look:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# \-*\- coding: utf\-8 \-*\-

# Import python libs
import os

PKG_DIR = os.path.abspath(os.path.dirname(__file__))


def engines_dirs():
    \(dq\(dq\(dq
    yield one path per parent directory of where engines can be found
    \(dq\(dq\(dq
    yield os.path.join(PKG_DIR, \(dqengines_1\(dq)
    yield os.path.join(PKG_DIR, \(dqengines_2\(dq)


def fileserver_dirs():
    \(dq\(dq\(dq
    yield one path per parent directory of where fileserver modules can be found
    \(dq\(dq\(dq
    yield os.path.join(PKG_DIR, \(dqfileserver\(dq)


def pillar_dirs():
    \(dq\(dq\(dq
    yield one path per parent directory of where external pillar modules can be found
    \(dq\(dq\(dq
    yield os.path.join(PKG_DIR, \(dqpillar\(dq)


def returner_dirs():
    \(dq\(dq\(dq
    yield one path per parent directory of where returner modules can be found
    \(dq\(dq\(dq
    yield os.path.join(PKG_DIR, \(dqreturners\(dq)


def roster_dirs():
    \(dq\(dq\(dq
    yield one path per parent directory of where roster modules can be found
    \(dq\(dq\(dq
    yield os.path.join(PKG_DIR, \(dqroster\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Preseed Minion with Accepted Key
.sp
In some situations, it is not convenient to wait for a minion to start before
accepting its key on the master. For instance, you may want the minion to
bootstrap itself as soon as it comes online. You may also want to let your
developers provision new development machines on the fly.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
Many ways to preseed minion keys
.sp
Salt has other ways to generate and pre\-accept minion keys in addition to
the manual steps outlined below.
.sp
salt\-cloud performs these same steps automatically when new cloud VMs are
created (unless instructed not to).
.sp
salt\-api exposes an HTTP call to Salt\(aqs REST API to \fI\%generate and
download the new minion keys as a tarball\fP\&.
.UNINDENT
.UNINDENT
.sp
There is a general four step process to do this:
.INDENT 0.0
.IP 1. 3
Generate the keys on the master:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
root@saltmaster# salt\-key \-\-gen\-keys=[key_name]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pick a name for the key, such as the minion\(aqs id.
.INDENT 0.0
.IP 2. 3
Add the public key to the accepted minion folder:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
root@saltmaster# cp key_name.pub /etc/salt/pki/master/minions/[minion_id]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is necessary that the public key file has the same name as your minion id.
This is how Salt matches minions with their keys. Also note that the pki folder
could be in a different location, depending on your OS or if specified in the
master config file.
.INDENT 0.0
.IP 3. 3
Distribute the minion keys.
.UNINDENT
.sp
There is no single method to get the keypair to your minion.  The difficulty is
finding a distribution method which is secure. For Amazon EC2 only, an AWS best
practice is to use IAM Roles to pass credentials. (See blog post,
\fI\%https://aws.amazon.com/blogs/security/using\-iam\-roles\-to\-distribute\-non\-aws\-credentials\-to\-your\-ec2\-instances/\fP )
.INDENT 0.0
.INDENT 3.5
.IP "Security Warning"
.sp
Since the minion key is already accepted on the master, distributing
the private key poses a potential security risk. A malicious party
will have access to your entire state tree and other sensitive data if they
gain access to a preseeded minion key.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 4. 3
Preseed the Minion with the keys
.UNINDENT
.sp
You will want to place the minion keys before starting the salt\-minion daemon:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/salt/pki/minion/minion.pem
/etc/salt/pki/minion/minion.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once in place, you should be able to start salt\-minion and run \fBsalt\-call
state.apply\fP or any other salt commands that require master authentication.
.SS Salt Masterless Quickstart
.sp
Running a masterless salt\-minion lets you use Salt\(aqs configuration management
for a single machine without calling out to a Salt master on another machine.
.sp
Since the Salt minion contains such extensive functionality it can be useful
to run it standalone. A standalone minion can be used to do a number of
things:
.INDENT 0.0
.IP \(bu 2
Stand up a master server via States (Salting a Salt Master)
.IP \(bu 2
Use salt\-call commands on a system without connectivity to a master
.IP \(bu 2
Masterless States, run states entirely from files local to the minion
.UNINDENT
.sp
It is also useful for testing out state trees before deploying to a production setup.
.SS Bootstrap Salt Minion
.sp
The \fI\%salt\-bootstrap\fP script makes bootstrapping a server with Salt simple
for any OS with a Bourne shell:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-L https://bootstrap.saltstack.com \-o bootstrap_salt.sh
sudo sh bootstrap_salt.sh
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Before run the script, it is a good practice to verify the checksum of the downloaded
file. You can verify the checksum with SHA256 by running this command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
test $(sha256sum bootstrap_salt.sh | awk \(aq{print $1}\(aq) \e
   = $(curl \-sL https://bootstrap.saltproject.io/sha256 | cat \-) \e
   && echo \(dqOK\(dq \e
   || echo \(dqFile does not match checksum\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The previous example is the preferred method because by downloading the script
you can investigate the contents of the bootstrap script or using it again later.
Alternatively, if you want to download the bash script and run it immediately,
use:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-L https://bootstrap.saltproject.io | sudo sh \-s \-\-
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
See the \fI\%salt\-bootstrap\fP documentation for other one liners. When using \fI\%Vagrant\fP
to test out salt, the \fI\%Vagrant salt provisioner\fP will provision the VM for you.
.SS Telling Salt to Run Masterless
.sp
To instruct the minion to not look for a master, the \fI\%file_client\fP
configuration option needs to be set in the minion configuration file.
By default the \fI\%file_client\fP is set to \fBremote\fP so that the
minion gathers file server and pillar data from the salt master.
When setting the \fI\%file_client\fP option to \fBlocal\fP the
minion is configured to not gather this data from the master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_client: local
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now the salt minion will not look for a master and will assume that the local
system has all of the file and pillar resources.
.sp
Configuration which resided in the
\fI\%master configuration\fP (e.g. \fB/etc/salt/master\fP)
should be moved to the \fI\%minion configuration\fP
since the minion does not read the master configuration.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When running Salt in masterless mode, do not run the salt\-minion daemon.
Otherwise, it will attempt to connect to a master and fail. The salt\-call
command stands on its own and does not need the salt\-minion daemon.
.UNINDENT
.UNINDENT
.SS Create State Tree
.sp
Following the successful installation of a salt\-minion, the next step is to create
a state tree, which is where the SLS files that comprise the possible states of the
minion are stored.
.sp
The following example walks through the steps necessary to create a state tree that
ensures that the server has the Apache webserver installed.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For a complete explanation on Salt States, see the \fI\%tutorial\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 1. 3
Create the \fBtop.sls\fP file:
.UNINDENT
.sp
\fB/srv/salt/top.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 2. 3
Create the webserver state tree:
.UNINDENT
.sp
\fB/srv/salt/webserver.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:               # ID declaration
  pkg:                # state declaration
    \- installed       # function declaration
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The apache package has different names on different platforms, for
instance on Debian/Ubuntu it is apache2, on Fedora/RHEL it is httpd
and on Arch it is apache
.UNINDENT
.UNINDENT
.sp
The only thing left is to provision our minion using \fBsalt\-call\fP\&.
.SS Salt\-call
.sp
The salt\-call command is used to run remote execution functions locally on a
minion instead of executing them from the master. Normally the salt\-call
command checks into the master to retrieve file server and pillar data, but
when running standalone salt\-call needs to be instructed to not check the
master for this data:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local state.apply
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fB\-\-local\fP flag tells the salt\-minion to look for the state tree in the
local file system and not to contact a Salt Master for instructions.
.sp
To provide verbose output, use \fB\-l debug\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local state.apply \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The minion first examines the \fBtop.sls\fP file and determines that it is a part
of the group matched by \fB*\fP glob and that the \fBwebserver\fP SLS should be applied.
.sp
It then examines the \fBwebserver.sls\fP file and finds the \fBapache\fP state, which
installs the Apache package.
.sp
The minion should now have Apache installed, and the next step is to begin
learning how to write \fI\%more complex states\fP\&.
.SS running salt as normal user tutorial
.sp
\fBBefore continuing\fP make sure you have a working Salt installation by
following the instructions in the
\fI\%Salt install guide\fP\&.
.INDENT 0.0
.INDENT 3.5
.IP "Stuck?"
.sp
The Salt Project community can help offer advice and help troubleshoot
technical issues as you\(aqre learning about Salt. One of the best places to
talk to the community is on the
\fI\%Salt Project Slack workspace\fP\&.
.UNINDENT
.UNINDENT
.SS Running Salt functions as non root user
.sp
If you don\(aqt want to run salt cloud as root or even install it you can
configure it to have a virtual root in your working directory.
.sp
The salt system uses the \fBsalt.syspath\fP module to find the variables
.sp
If you run the salt\-build, it will generated in:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\&./build/lib.linux\-x86_64\-2.7/salt/_syspaths.py
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To generate it, run the command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python setup.py build
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Copy the generated module into your salt directory
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cp ./build/lib.linux\-x86_64\-2.7/salt/_syspaths.py salt/_syspaths.py
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Edit it to include needed variables and your new paths
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# you need to edit this
_your_current_dir_ = ...
ROOT_DIR = _your_current_dir_ + \(dq/salt/root\(dq

# you need to edit this
_location_of_source_code_ = ...
INSTALL_DIR = _location_of_source_code_

CONFIG_DIR = ROOT_DIR + \(dq/etc/salt\(dq
CACHE_DIR = ROOT_DIR + \(dq/var/cache/salt\(dq
SOCK_DIR = ROOT_DIR + \(dq/var/run/salt\(dq
SRV_ROOT_DIR = ROOT_DIR + \(dq/srv\(dq
BASE_FILE_ROOTS_DIR = ROOT_DIR + \(dq/srv/salt\(dq
BASE_PILLAR_ROOTS_DIR = ROOT_DIR + \(dq/srv/pillar\(dq
BASE_MASTER_ROOTS_DIR = ROOT_DIR + \(dq/srv/salt\-master\(dq
LOGS_DIR = ROOT_DIR + \(dq/var/log/salt\(dq
PIDFILE_DIR = ROOT_DIR + \(dq/var/run\(dq
CLOUD_DIR = INSTALL_DIR + \(dq/cloud\(dq
BOOTSTRAP = CLOUD_DIR + \(dq/deploy/bootstrap\-salt.sh\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Create the directory structure
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mkdir \-p root/etc/salt root/var/cache/run root/run/salt root/srv
root/srv/salt root/srv/pillar root/srv/salt\-master root/var/log/salt root/var/run
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Populate the configuration files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cp \-r conf/* root/etc/salt/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Edit your \fBroot/etc/salt/master\fP configuration that is used by salt\-cloud:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
user: *your user name*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Run like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
PYTHONPATH=\(gapwd\(ga scripts/salt\-cloud
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Salt Bootstrap
.sp
The Salt Bootstrap Script allows a user to install the Salt Minion or Master
on a variety of system distributions and versions.
.sp
The Salt Bootstrap Script is a shell script is known as \fBbootstrap\-salt.sh\fP\&.
It runs through a series of checks to determine the operating system type and
version. It then installs the Salt binaries using the appropriate methods.
.sp
The Salt Bootstrap Script installs the minimum number of packages required to
run Salt. This means that in the event you run the bootstrap to install via
package, Git will not be installed. Installing the minimum number of packages
helps ensure the script stays as lightweight as possible, assuming the user
will install any other required packages after the Salt binaries are present
on the system.
.sp
The Salt Bootstrap Script is maintained in a separate repo from Salt, complete
with its own issues, pull requests, contributing guidelines, release protocol,
etc.
.sp
To learn more, please see the Salt Bootstrap repo links:
.INDENT 0.0
.IP \(bu 2
\fI\%Salt Bootstrap repo\fP
.IP \(bu 2
\fI\%README\fP: includes supported operating systems, example usage, and more.
.IP \(bu 2
\fI\%Contributing Guidelines\fP
.IP \(bu 2
\fI\%Release Process\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The Salt Bootstrap script can be found in the Salt repo under the
\fBsalt/cloud/deploy/bootstrap\-salt.sh\fP path. Any changes to this file
will be overwritten! Bug fixes and feature additions must be submitted
via the \fI\%Salt Bootstrap repo\fP\&. Please see the Salt Bootstrap Script\(aqs
\fI\%Release Process\fP for more information.
.UNINDENT
.UNINDENT
.SS Standalone Minion
.sp
Since the Salt minion contains such extensive functionality it can be useful
to run it standalone. A standalone minion can be used to do a number of
things:
.INDENT 0.0
.IP \(bu 2
Use salt\-call commands on a system without connectivity to a master
.IP \(bu 2
Masterless States, run states entirely from files local to the minion
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When running Salt in masterless mode, it is not required to run the
salt\-minion daemon. By default the salt\-minion daemon will attempt to
connect to a master and fail. The salt\-call command stands on its own
and does not need the salt\-minion daemon.
.sp
As of version 2016.11.0 you can have a running minion (with engines and
beacons) without a master connection. If you wish to run the salt\-minion
daemon you will need to set the \fI\%master_type\fP configuration
setting to be set to \(aqdisable\(aq.
.UNINDENT
.UNINDENT
.SS Minion Configuration
.sp
Throughout this document there are several references to setting different
options to configure a masterless Minion. Salt Minions are easy to configure
via a configuration file that is located, by default, in \fB/etc/salt/minion\fP\&.
Note, however, that on FreeBSD systems, the minion configuration file is located
in \fB/usr/local/etc/salt/minion\fP\&.
.sp
You can learn more about minion configuration options in the
\fI\%Configuring the Salt Minion\fP docs.
.SS Telling Salt Call to Run Masterless
.sp
The salt\-call command is used to run module functions locally on a minion
instead of executing them from the master. Normally the salt\-call command
checks into the master to retrieve file server and pillar data, but when
running standalone salt\-call needs to be instructed to not check the master for
this data. To instruct the minion to not look for a master when running
salt\-call the \fI\%file_client\fP configuration option needs to be set.
By default the \fI\%file_client\fP is set to \fBremote\fP so that the
minion knows that file server and pillar data are to be gathered from the
master. When setting the \fI\%file_client\fP option to \fBlocal\fP the
minion is configured to not gather this data from the master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_client: local
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now the salt\-call command will not look for a master and will assume that the
local system has all of the file and pillar resources.
.SS Running States Masterless
.sp
The state system can be easily run without a Salt master, with all needed files
local to the minion. To do this the minion configuration file needs to be set
up to know how to return file_roots information like the master. The file_roots
setting defaults to /srv/salt for the base environment just like on the master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now set up the Salt State Tree, top file, and SLS modules in the same way that
they would be set up on a master. Now, with the \fI\%file_client\fP
option set to \fBlocal\fP and an available state tree then calls to functions in
the state module will use the information in the file_roots on the minion
instead of checking in with the master.
.sp
Remember that when creating a state tree on a minion there are no syntax or
path changes needed, SLS modules written to be used from a master do not need
to be modified in any way to work with a minion.
.sp
This makes it easy to \(dqscript\(dq deployments with Salt states without having to
set up a master, and allows for these SLS modules to be easily moved into a
Salt master as the deployment grows.
.sp
The declared state can now be executed with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call state.apply
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or the salt\-call command can be executed with the \fB\-\-local\fP flag, this makes
it unnecessary to change the configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call state.apply \-\-local
.ft P
.fi
.UNINDENT
.UNINDENT
.SS External Pillars
.sp
\fI\%External pillars\fP are supported when running in masterless mode.
.SS How Do I Use Salt States?
.sp
Simplicity, Simplicity, Simplicity
.sp
Many of the most powerful and useful engineering solutions are founded on
simple principles. Salt States strive to do just that: K.I.S.S. (Keep It
Stupidly Simple)
.sp
The core of the Salt State system is the SLS, or \fBS\fPtructured \fBL\fPayered \fBS\fPtate.
The SLS is a representation of the state in which
a system should be in, and is set up to contain this data in a simple format.
This is often called configuration management.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is just the beginning of using states, make sure to read up on pillar
\fI\%Pillar\fP next.
.UNINDENT
.UNINDENT
.SS It is All Just Data
.sp
Before delving into the particulars, it will help to understand that the SLS
file is just a data structure under the hood. While understanding that the SLS
is just a data structure isn\(aqt critical for understanding and making use of
Salt States, it should help bolster knowledge of where the real power is.
.sp
SLS files are therefore, in reality, just dictionaries, lists, strings, and
numbers.  By using this approach Salt can be much more flexible. As one writes
more state files, it becomes clearer exactly what is being written. The result
is a system that is easy to understand, yet grows with the needs of the admin
or developer.
.SS The Top File
.sp
The example SLS files in the below sections can be assigned to hosts using a
file called \fBtop.sls\fP\&. This file is described in\-depth \fI\%here\fP\&.
.SS Default Data \- YAML
.sp
By default Salt represents the SLS data in what is one of the simplest
serialization formats available \- \fI\%YAML\fP\&.
.sp
A typical SLS file will often look like this in YAML:
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
These demos use some generic service and package names, different
distributions often use different names for packages and services. For
instance \fIapache\fP should be replaced with \fIhttpd\fP on a Red Hat system.
Salt uses the name of the init script, systemd name, upstart name etc.
based on what the underlying service management for the platform. To
get a list of the available service names on a platform execute the
service.get_all salt function.
.sp
Information on how to make states work with multiple distributions
is later in the tutorial.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  pkg.installed: []
  service.running:
    \- require:
      \- pkg: apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This SLS data will ensure that the package named apache is installed, and
that the apache service is running. The components can be explained in a
simple way.
.sp
The first line is the ID for a set of data, and it is called the ID
Declaration. This ID sets the name of the thing that needs to be manipulated.
.sp
The second and third lines contain the state module function to be run, in the
format \fB<state_module>.<function>\fP\&. The \fBpkg.installed\fP state module
function ensures that a software package is installed via the system\(aqs native
package manager. The \fBservice.running\fP state module function ensures that a
given system daemon is running.
.sp
Finally, on line four, is the word \fBrequire\fP\&. This is called a Requisite
Statement, and it makes sure that the Apache service is only started after
a successful installation of the apache package.
.SS Adding Configs and Users
.sp
When setting up a service like an Apache web server, many more components may
need to be added. The Apache configuration file will most likely be managed,
and a user and group may need to be set up.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  pkg.installed: []
  service.running:
    \- watch:
      \- pkg: apache
      \- file: /etc/httpd/conf/httpd.conf
      \- user: apache
  user.present:
    \- uid: 87
    \- gid: 87
    \- home: /var/www/html
    \- shell: /bin/nologin
    \- require:
      \- group: apache
  group.present:
    \- gid: 87
    \- require:
      \- pkg: apache

/etc/httpd/conf/httpd.conf:
  file.managed:
    \- source: salt://apache/httpd.conf
    \- user: root
    \- group: root
    \- mode: 644
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This SLS data greatly extends the first example, and includes a config file,
a user, a group and new requisite statement: \fBwatch\fP\&.
.sp
Adding more states is easy, since the new user and group states are under
the Apache ID, the user and group will be the Apache user and group. The
\fBrequire\fP statements will make sure that the user will only be made after
the group, and that the group will be made only after the Apache package is
installed.
.sp
Next, the \fBrequire\fP statement under service was changed to watch, and is
now watching 3 states instead of just one. The watch statement does the same
thing as require, making sure that the other states run before running the
state with a watch, but it adds an extra component. The \fBwatch\fP statement
will run the state\(aqs watcher function for any changes to the watched states.
So if the package was updated, the config file changed, or the user
uid modified, then the service state\(aqs watcher will be run. The service
state\(aqs watcher just restarts the service, so in this case, a change in the
config file will also trigger a restart of the respective service.
.SS Moving Beyond a Single SLS
.sp
When setting up Salt States in a scalable manner, more than one SLS will need
to be used. The above examples were in a single SLS file, but two or more
SLS files can be combined to build out a State Tree. The above example also
references a file with a strange source \- \fBsalt://apache/httpd.conf\fP\&. That
file will need to be available as well.
.sp
The SLS files are laid out in a directory structure on the Salt master; an
SLS is just a file and files to download are just files.
.sp
The Apache example would be laid out in the root of the Salt file server like
this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache/init.sls
apache/httpd.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
So the httpd.conf is just a file in the apache directory, and is referenced
directly.
.INDENT 0.0
.INDENT 3.5
.IP "Do not use dots in SLS file names or their directories"
.sp
The initial implementation of \fI\%top.sls\fP and
\fI\%Include declaration\fP followed the python import model where a slash
is represented as a period.  This means that a SLS file with a period in
the name ( besides the suffix period) can not be referenced.  For example,
webserver_1.0.sls is not referenceable because webserver_1.0 would refer
to the directory/file webserver_1/0.sls
.sp
The same applies for any subdirectories, this is especially \(aqtricky\(aq when
git repos are created.  Another command that typically can\(aqt render its
output is \fB\(gastate.show_sls\(ga\fP of a file in a path that contains a dot.
.UNINDENT
.UNINDENT
.sp
But when using more than one single SLS file, more components can be added to
the toolkit. Consider this SSH example:
.sp
\fBssh/init.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
openssh\-client:
  pkg.installed

/etc/ssh/ssh_config:
  file.managed:
    \- user: root
    \- group: root
    \- mode: 644
    \- source: salt://ssh/ssh_config
    \- require:
      \- pkg: openssh\-client
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBssh/server.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- ssh

openssh\-server:
  pkg.installed

sshd:
  service.running:
    \- require:
      \- pkg: openssh\-client
      \- pkg: openssh\-server
      \- file: /etc/ssh/banner
      \- file: /etc/ssh/sshd_config

/etc/ssh/sshd_config:
  file.managed:
    \- user: root
    \- group: root
    \- mode: 644
    \- source: salt://ssh/sshd_config
    \- require:
      \- pkg: openssh\-server

/etc/ssh/banner:
  file:
    \- managed
    \- user: root
    \- group: root
    \- mode: 644
    \- source: salt://ssh/banner
    \- require:
      \- pkg: openssh\-server
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Notice that we use two similar ways of denoting that a file
is managed by Salt. In the \fI/etc/ssh/sshd_config\fP state section above,
we use the \fIfile.managed\fP state declaration whereas with the
\fI/etc/ssh/banner\fP state section, we use the \fIfile\fP state declaration
and add a \fImanaged\fP attribute to that state declaration. Both ways
produce an identical result; the first way \-\- using \fIfile.managed\fP \-\-
is merely a shortcut.
.UNINDENT
.UNINDENT
.sp
Now our State Tree looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache/init.sls
apache/httpd.conf
ssh/init.sls
ssh/server.sls
ssh/banner
ssh/ssh_config
ssh/sshd_config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example now introduces the \fBinclude\fP statement. The include statement
includes another SLS file so that components found in it can be required,
watched or as will soon be demonstrated \- extended.
.sp
The include statement allows for states to be cross linked. When an SLS
has an include statement it is literally extended to include the contents of
the included SLS files.
.sp
Note that some of the SLS files are called init.sls, while others are not. More
info on what this means can be found in the \fI\%States Tutorial\fP\&.
.SS Extending Included SLS Data
.sp
Sometimes SLS data needs to be extended. Perhaps the apache service needs to
watch additional resources, or under certain circumstances a different file
needs to be placed.
.sp
In these examples, the first will add a custom banner to ssh and the second will
add more watchers to apache to include mod_python.
.sp
\fBssh/custom\-server.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- ssh.server

extend:
  /etc/ssh/banner:
    file:
      \- source: salt://ssh/custom\-banner
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBpython/mod_python.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- apache

extend:
  apache:
    service:
      \- watch:
        \- pkg: mod_python

mod_python:
  pkg.installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBcustom\-server.sls\fP file uses the extend statement to overwrite where the
banner is being downloaded from, and therefore changing what file is being used
to configure the banner.
.sp
In the new mod_python SLS the mod_python package is added, but more importantly
the apache service was extended to also watch the mod_python package.
.INDENT 0.0
.INDENT 3.5
.IP "Using extend with require or watch"
.sp
The \fBextend\fP statement works differently for \fBrequire\fP or \fBwatch\fP\&.
It appends to, rather than replacing the requisite component.
.UNINDENT
.UNINDENT
.SS Understanding the Render System
.sp
Since SLS data is simply that (data), it does not need to be represented
with YAML. Salt defaults to YAML because it is very straightforward and easy
to learn and use. But the SLS files can be rendered from almost any imaginable
medium, so long as a renderer module is provided.
.sp
The default rendering system is the \fBjinja|yaml\fP renderer. The
\fBjinja|yaml\fP renderer will first pass the template through the \fI\%Jinja2\fP
templating system, and then through the YAML parser. The benefit here is that
full programming constructs are available when creating SLS files.
.sp
Other renderers available are \fByaml_mako\fP and \fByaml_wempy\fP which each use
the \fI\%Mako\fP or \fI\%Wempy\fP templating system respectively rather than the jinja
templating system, and more notably, the pure Python or \fBpy\fP, \fBpydsl\fP &
\fBpyobjects\fP renderers.
The \fBpy\fP renderer allows for SLS files to be written in pure Python,
allowing for the utmost level of flexibility and power when preparing SLS
data; while the \fI\%pydsl\fP renderer
provides a flexible, domain\-specific language for authoring SLS data in Python;
and the \fI\%pyobjects\fP renderer
gives you a \fI\%\(dqPythonic\(dq\fP interface to building state data.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The templating engines described above aren\(aqt just available in SLS files.
They can also be used in \fI\%file.managed\fP
states, making file management much more dynamic and flexible. Some
examples for using templates in managed files can be found in the
documentation for the \fI\%file state\fP, as well as the
\fI\%MooseFS example\fP below.
.UNINDENT
.UNINDENT
.SS Getting to Know the Default \- jinja|yaml
.sp
The default renderer \- \fBjinja|yaml\fP, allows for use of the jinja
templating system. A guide to the Jinja templating system can be found here:
\fI\%https://jinja.palletsprojects.com/en/2.11.x/\fP
.sp
When working with renderers a few very useful bits of data are passed in. In
the case of templating engine based renderers, three critical components are
available, \fBsalt\fP, \fBgrains\fP, and \fBpillar\fP\&. The \fBsalt\fP object allows for
any Salt function to be called from within the template, and \fBgrains\fP allows
for the Grains to be accessed from within the template. A few examples:
.sp
\fBapache/init.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  pkg.installed:
    {% if grains[\(aqos\(aq] == \(aqRedHat\(aq%}
    \- name: httpd
    {% endif %}
  service.running:
    {% if grains[\(aqos\(aq] == \(aqRedHat\(aq%}
    \- name: httpd
    {% endif %}
    \- watch:
      \- pkg: apache
      \- file: /etc/httpd/conf/httpd.conf
      \- user: apache
  user.present:
    \- uid: 87
    \- gid: 87
    \- home: /var/www/html
    \- shell: /bin/nologin
    \- require:
      \- group: apache
  group.present:
    \- gid: 87
    \- require:
      \- pkg: apache

/etc/httpd/conf/httpd.conf:
  file.managed:
    \- source: salt://apache/httpd.conf
    \- user: root
    \- group: root
    \- mode: 644
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example is simple. If the \fBos\fP grain states that the operating system is
Red Hat, then the name of the Apache package and service needs to be httpd.
.sp
A more aggressive way to use Jinja can be found here, in a module to set up
a MooseFS distributed filesystem chunkserver:
.sp
\fBmoosefs/chunk.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- moosefs

{% for mnt in salt[\(aqcmd.run\(aq](\(aqls /dev/data/moose*\(aq).split() %}
/mnt/moose{{ mnt[\-1] }}:
  mount.mounted:
    \- device: {{ mnt }}
    \- fstype: xfs
    \- mkmnt: True
  file.directory:
    \- user: mfs
    \- group: mfs
    \- require:
      \- user: mfs
      \- group: mfs
{% endfor %}

/etc/mfshdd.cfg:
  file.managed:
    \- source: salt://moosefs/mfshdd.cfg
    \- user: root
    \- group: root
    \- mode: 644
    \- template: jinja
    \- require:
      \- pkg: mfs\-chunkserver

/etc/mfschunkserver.cfg:
  file.managed:
    \- source: salt://moosefs/mfschunkserver.cfg
    \- user: root
    \- group: root
    \- mode: 644
    \- template: jinja
    \- require:
      \- pkg: mfs\-chunkserver

mfs\-chunkserver:
  pkg.installed: []
mfschunkserver:
  service.running:
    \- require:
{% for mnt in salt[\(aqcmd.run\(aq](\(aqls /dev/data/moose*\(aq) %}
      \- mount: /mnt/moose{{ mnt[\-1] }}
      \- file: /mnt/moose{{ mnt[\-1] }}
{% endfor %}
      \- file: /etc/mfschunkserver.cfg
      \- file: /etc/mfshdd.cfg
      \- file: /var/lib/mfs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example shows much more of the available power of Jinja.
Multiple for loops are used to dynamically detect available hard drives
and set them up to be mounted, and the \fBsalt\fP object is used multiple
times to call shell commands to gather data.
.SS Introducing the Python, PyDSL, and the Pyobjects Renderers
.sp
Sometimes the chosen default renderer might not have enough logical power to
accomplish the needed task. When this happens, the Python renderer can be
used. Normally a YAML renderer should be used for the majority of SLS files,
but an SLS file set to use another renderer can be easily added to the tree.
.sp
This example shows a very basic Python SLS file:
.sp
\fBpython/django.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!py


def run():
    \(dq\(dq\(dq
    Install the django package
    \(dq\(dq\(dq
    return {\(dqinclude\(dq: [\(dqpython\(dq], \(dqdjango\(dq: {\(dqpkg\(dq: [\(dqinstalled\(dq]}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is a very simple example; the first line has an SLS shebang that
tells Salt to not use the default renderer, but to use the \fBpy\fP renderer.
Then the run function is defined, the return value from the run function
must be a Salt friendly data structure, or better known as a Salt
\fI\%HighState data structure\fP\&.
.sp
Alternatively, using the \fI\%pydsl\fP
renderer, the above example can be written more succinctly as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!pydsl

include(\(dqpython\(dq, delayed=True)
state(\(dqdjango\(dq).pkg.installed()
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fI\%pyobjects\fP renderer
provides an \fI\%\(dqPythonic\(dq\fP object based approach for building the state data.
The above example could be written as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!pyobjects

include(\(dqpython\(dq)
Pkg.installed(\(dqdjango\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
These Python examples would look like this if they were written in YAML:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- python

django:
  pkg.installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example clearly illustrates that; one, using the YAML renderer by default
is a wise decision and two, unbridled power can be obtained where needed by
using a pure Python SLS.
.SS Running and Debugging Salt States
.sp
Once the rules in an SLS are ready, they should be tested to ensure they
work properly. To invoke these rules, simply execute
\fBsalt \(aq*\(aq state.apply\fP on the command line. If you get back only
hostnames with a \fB:\fP after, but no return, chances are there is a problem with
one or more of the sls files. On the minion, use the \fBsalt\-call\fP command to
examine the output for errors:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call state.apply \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This should help troubleshoot the issue. The minion can also be started in the
foreground in debug mode by running \fBsalt\-minion \-l debug\fP\&.
.SS Next Reading
.sp
With an understanding of states, the next recommendation is to become familiar
with Salt\(aqs pillar interface:
.INDENT 0.0
.INDENT 3.5
\fI\%Pillar Walkthrough\fP
.UNINDENT
.UNINDENT
.SS States tutorial, part 1 \- Basic Usage
.sp
The purpose of this tutorial is to demonstrate how quickly you can configure a
system to be managed by Salt States. For detailed information about the state
system please refer to the full \fI\%states reference\fP\&.
.sp
This tutorial will walk you through using Salt to configure a minion to run the
Apache HTTP server and to ensure the server is running.
.sp
\fBBefore continuing\fP make sure you have a working Salt installation by
following the instructions in the
\fI\%Salt install guide\fP\&.
.INDENT 0.0
.INDENT 3.5
.IP "Stuck?"
.sp
The Salt Project community can help offer advice and help troubleshoot
technical issues as you\(aqre learning about Salt. One of the best places to
talk to the community is on the
\fI\%Salt Project Slack workspace\fP\&.
.UNINDENT
.UNINDENT
.SS Setting up the Salt State Tree
.sp
States are stored in text files on the master and transferred to the minions on
demand via the master\(aqs File Server. The collection of state files make up the
\fBState Tree\fP\&.
.sp
To start using a central state system in Salt, the Salt File Server must first
be set up. Edit the master config file (\fI\%file_roots\fP) and
uncomment the following lines:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you are deploying on FreeBSD via ports, the \fBfile_roots\fP path defaults
to \fB/usr/local/etc/salt/states\fP\&.
.UNINDENT
.UNINDENT
.sp
Restart the Salt master in order to pick up this change:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pkill salt\-master
salt\-master \-d
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Preparing the Top File
.sp
On the master, in the directory uncommented in the previous step,
(\fB/srv/salt\fP by default), create a new file called
\fI\%top.sls\fP and add the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fI\%top file\fP is separated into environments (discussed
later). The default environment is \fBbase\fP\&. Under the \fBbase\fP environment a
collection of minion matches is defined; for now simply specify all hosts
(\fB*\fP).
.INDENT 0.0
.INDENT 3.5
.IP "Targeting minions"
.sp
The expressions can use any of the targeting mechanisms used by Salt —
minions can be matched by glob, PCRE regular expression, or by \fI\%grains\fP\&. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqos:Fedora\(aq:
    \- match: grain
    \- webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Create an \fBsls\fP file
.sp
In the same directory as the \fI\%top file\fP, create a file
named \fBwebserver.sls\fP, containing the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:                 # ID declaration
  pkg:                  # state declaration
    \- installed         # function declaration
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The first line, called the \fI\%ID declaration\fP, is an arbitrary identifier.
In this case it defines the name of the package to be installed.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The package name for the Apache httpd web server may differ depending on
OS or distro — for example, on Fedora it is \fBhttpd\fP but on
Debian/Ubuntu it is \fBapache2\fP\&.
.UNINDENT
.UNINDENT
.sp
The second line, called the \fI\%State declaration\fP, defines which of the Salt
States we are using. In this example, we are using the \fI\%pkg state\fP to ensure that a given package is installed.
.sp
The third line, called the \fI\%Function declaration\fP, defines which function
in the \fI\%pkg state\fP module to call.
.INDENT 0.0
.INDENT 3.5
.IP "Renderers"
.sp
States \fBsls\fP files can be written in many formats. Salt requires only
a simple data structure and is not concerned with how that data structure
is built. Templating languages and \fI\%DSLs\fP are a dime\-a\-dozen and everyone
has a favorite.
.sp
Building the expected data structure is the job of Salt \fI\%Renderers\fP
and they are dead\-simple to write.
.sp
In this tutorial we will be using YAML in Jinja2 templates, which is the
default format. The default can be changed by editing
\fI\%renderer\fP in the master configuration file.
.UNINDENT
.UNINDENT
.SS Install the package
.sp
Next, let\(aqs run the state we created. Open a terminal on the master and run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Our master is instructing all targeted minions to run \fBstate.apply\fP\&. When this function is executed without any SLS
targets, a minion will download the \fI\%top file\fP and attempt to
match the expressions within it. When the minion does match an expression the
modules listed for it will be downloaded, compiled, and executed.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This action is referred to as a \(dqhighstate\(dq, and can be run using the
\fI\%state.highstate\fP function.
However, to make the usage easier to understand (\(dqhighstate\(dq is not
necessarily an intuitive name), a \fI\%state.apply\fP function was added in version 2015.5.0, which
when invoked without any SLS names will trigger a highstate.
\fI\%state.highstate\fP still exists and
can be used, but the documentation (as can be seen above) has been updated
to reference \fI\%state.apply\fP, so keep
the following in mind as you read the documentation:
.INDENT 0.0
.IP \(bu 2
\fI\%state.apply\fP invoked without any
SLS names will run \fI\%state.highstate\fP
.IP \(bu 2
\fI\%state.apply\fP invoked with SLS names
will run \fI\%state.sls\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Once completed, the minion will report back with a summary of all actions taken
and all changes made.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
If you have created \fI\%custom grain modules\fP, they will
not be available in the top file until after the first \fI\%highstate\fP\&. To make custom grains available on a minion\(aqs first
\fI\%highstate\fP, it is recommended to use \fI\%this
example\fP to ensure that the custom grains are synced
when the minion starts.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.IP "SLS File Namespace"
.sp
Note that in the \fI\%example\fP above, the SLS file
\fBwebserver.sls\fP was referred to simply as \fBwebserver\fP\&. The namespace
for SLS files when referenced in \fI\%top.sls\fP or an \fI\%Include declaration\fP
follows a few simple rules:
.INDENT 0.0
.IP 1. 3
The \fB\&.sls\fP is discarded (i.e. \fBwebserver.sls\fP becomes
\fBwebserver\fP).
.IP 2. 3
.INDENT 3.0
.TP
.B Subdirectories can be used for better organization.
.INDENT 7.0
.IP a. 3
Each subdirectory under the configured file_roots (default:
\fB/srv/salt/\fP) is represented with a dot (following the Python
import model) in Salt states and on the command line.
\fBwebserver/dev.sls\fP on the filesystem is referred to as
\fBwebserver.dev\fP in Salt
.IP b. 3
Because slashes are represented as dots, SLS files can not contain
dots in the name (other than the dot for the SLS suffix).  The SLS
file \fBwebserver_1.0.sls\fP can not be matched, and \fBwebserver_1.0\fP
would match the directory/file \fBwebserver_1/0.sls\fP
.UNINDENT
.UNINDENT
.IP 3. 3
A file called \fBinit.sls\fP in a subdirectory is referred to by the path
of the directory. So, \fBwebserver/init.sls\fP is referred to as
\fBwebserver\fP\&.
.IP 4. 3
If both \fBwebserver.sls\fP and \fBwebserver/init.sls\fP happen to exist,
\fBwebserver/init.sls\fP will be ignored and \fBwebserver.sls\fP will be the
file referred to as \fBwebserver\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.IP "Troubleshooting Salt"
.sp
If the expected output isn\(aqt seen, the following tips can help to
narrow down the problem.
.INDENT 0.0
.TP
.B Turn up logging
Salt can be quite chatty when you change the logging setting to
\fBdebug\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-minion \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B Run the minion in the foreground
By not starting the minion in daemon mode (\fI\%\-d\fP)
one can view any output from the minion as it works:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-minion
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Increase the default timeout value when running \fBsalt\fP\&. For
example, to change the default timeout to 60 seconds:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-t 60
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For best results, combine all three:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-minion \-l debug        # On the minion
salt \(aq*\(aq state.apply \-t 60  # On the master
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Next steps
.sp
This tutorial focused on getting a simple Salt States configuration working.
\fI\%Part 2\fP will build on this example to cover more advanced
\fBsls\fP syntax and will explore more of the states that ship with Salt.
.SS States tutorial, part 2 \- More Complex States, Requisites
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This tutorial builds on topics covered in \fI\%part 1\fP\&. It is
recommended that you begin there.
.UNINDENT
.UNINDENT
.sp
In the \fI\%last part\fP of the Salt States tutorial we covered the
basics of installing a package. We will now modify our \fBwebserver.sls\fP file
to have requirements, and use even more Salt States.
.SS Call multiple States
.sp
You can specify multiple \fI\%State declaration\fP under an
\fI\%ID declaration\fP\&. For example, a quick modification to our
\fBwebserver.sls\fP to also start Apache if it is not running:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  pkg.installed: []
  service.running:
    \- require:
      \- pkg: apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Try stopping Apache before running \fI\%state.apply\fP once again and observe the output.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For those running RedhatOS derivatives (Centos, AWS), you will want to specify the
service name to be httpd. More on state service here, \fI\%service state\fP\&.  With the example above, just add \(dq\- name: httpd\(dq
above the require line and with the same spacing.
.UNINDENT
.UNINDENT
.SS Require other states
.sp
We now have a working installation of Apache so let\(aqs add an HTML file to
customize our website. It isn\(aqt exactly useful to have a website without a
webserver so we don\(aqt want Salt to install our HTML file until Apache is
installed and running. Include the following at the bottom of your
\fBwebserver/init.sls\fP file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  pkg.installed: []
  service.running:
    \- require:
      \- pkg: apache

/var/www/index.html:                        # ID declaration
  file:                                     # state declaration
    \- managed                               # function
    \- source: salt://webserver/index.html   # function arg
    \- require:                              # requisite declaration
      \- pkg: apache                         # requisite reference
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBline 7\fP is the \fI\%ID declaration\fP\&. In this example it is the location we
want to install our custom HTML file. (\fBNote:\fP the default location that
Apache serves may differ from the above on your OS or distro. \fB/srv/www\fP
could also be a likely place to look.)
.sp
\fBLine 8\fP the \fI\%State declaration\fP\&. This example uses the Salt \fI\%file
state\fP\&.
.sp
\fBLine 9\fP is the \fI\%Function declaration\fP\&. The \fI\%managed function\fP will download a file from the master and install it
in the location specified.
.sp
\fBLine 10\fP is a \fI\%Function arg declaration\fP which, in this example, passes
the \fBsource\fP argument to the \fI\%managed function\fP\&.
.sp
\fBLine 11\fP is a \fI\%Requisite declaration\fP\&.
.sp
\fBLine 12\fP is a \fI\%Requisite reference\fP which refers to a state and an ID.
In this example, it is referring to the \fBID declaration\fP from our example in
\fI\%part 1\fP\&. This declaration tells Salt not to install the HTML
file until Apache is installed.
.sp
Next, create the \fBindex.html\fP file and save it in the \fBwebserver\fP
directory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<!DOCTYPE html>
<html>
    <head><title>Salt rocks</title></head>
    <body>
        <h1>This file brought to you by Salt</h1>
    </body>
</html>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Last, call \fI\%state.apply\fP again and the minion
will fetch and execute the \fI\%highstate\fP as well as our
HTML file from the master using Salt\(aqs File Server:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Verify that Apache is now serving your custom HTML.
.INDENT 0.0
.INDENT 3.5
.IP "\fBrequire\fP vs. \fBwatch\fP"
.sp
There are two \fI\%Requisite declaration\fP, “require”, and “watch”. Not
every state supports “watch”. The \fI\%service state\fP does support “watch” and will restart a service
based on the watch condition.
.sp
For example, if you use Salt to install an Apache virtual host
configuration file and want to restart Apache whenever that file is changed
you could modify our Apache example from earlier as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/httpd/extra/httpd\-vhosts.conf:
  file.managed:
    \- source: salt://webserver/httpd\-vhosts.conf

apache:
  pkg.installed: []
  service.running:
    \- watch:
      \- file: /etc/httpd/extra/httpd\-vhosts.conf
    \- require:
      \- pkg: apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the pkg and service names differ on your OS or distro of choice you can
specify each one separately using a \fI\%Name declaration\fP which explained
in \fI\%Part 3\fP\&.
.UNINDENT
.UNINDENT
.SS Next steps
.sp
In \fI\%part 3\fP we will discuss how to use includes, extends, and
templating to make a more complete State Tree configuration.
.SS States tutorial, part 3 \- Templating, Includes, Extends
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This tutorial builds on topics covered in \fI\%part 1\fP and
\fI\%part 2\fP\&. It is recommended that you begin there.
.UNINDENT
.UNINDENT
.sp
This part of the tutorial will cover more advanced templating and
configuration techniques for \fBsls\fP files.
.SS Templating SLS modules
.sp
SLS modules may require programming logic or inline execution. This is
accomplished with module templating. The default module templating system used
is \fI\%Jinja2\fP  and may be configured by changing the \fI\%renderer\fP
value in the master config.
.sp
All states are passed through a templating system when they are initially read.
To make use of the templating system, simply add some templating markup.
An example of an sls module with templating markup may look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% for usr in [\(aqmoe\(aq,\(aqlarry\(aq,\(aqcurly\(aq] %}
{{ usr }}:
  user.present
{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This templated sls file once generated will look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
moe:
  user.present
larry:
  user.present
curly:
  user.present
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here\(aqs a more complex example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Comments in yaml start with a hash symbol.
# Since jinja rendering occurs before yaml parsing, if you want to include jinja
# in the comments you may need to escape them using \(aqjinja\(aq comments to prevent
# jinja from trying to render something which is not well\-defined jinja.
# e.g.
# {# iterate over the Three Stooges using a {% for %}..{% endfor %} loop
# with the iterator variable {{ usr }} becoming the state ID. #}
{% for usr in \(aqmoe\(aq,\(aqlarry\(aq,\(aqcurly\(aq %}
{{ usr }}:
  group:
    \- present
  user:
    \- present
    \- gid_from_name: True
    \- require:
      \- group: {{ usr }}
{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Using Grains in SLS modules
.sp
Often times a state will need to behave differently on different systems.
\fI\%Salt grains\fP objects are made available in the template
context. The \fIgrains\fP can be used from within sls modules:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  pkg.installed:
    {% if grains[\(aqos\(aq] == \(aqRedHat\(aq %}
    \- name: httpd
    {% elif grains[\(aqos\(aq] == \(aqUbuntu\(aq %}
    \- name: apache2
    {% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Using Environment Variables in SLS modules
.sp
You can use \fBsalt[\(aqenviron.get\(aq](\(aqVARNAME\(aq)\fP to use an environment
variable in a Salt state.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
MYENVVAR=\(dqworld\(dq salt\-call state.template test.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Create a file with contents from an environment variable:
  file.managed:
    \- name: /tmp/hello
    \- contents: {{ salt[\(aqenviron.get\(aq](\(aqMYENVVAR\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Error checking:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set myenvvar = salt[\(aqenviron.get\(aq](\(aqMYENVVAR\(aq) %}
{% if myenvvar %}

Create a file with contents from an environment variable:
  file.managed:
    \- name: /tmp/hello
    \- contents: {{ salt[\(aqenviron.get\(aq](\(aqMYENVVAR\(aq) }}

{% else %}

Fail \- no environment passed in:
  test.fail_without_changes

{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Calling Salt modules from templates
.sp
All of the Salt modules loaded by the minion are available within the
templating system. This allows data to be gathered in real time on the target
system. It also allows for shell commands to be run easily from within the sls
modules.
.sp
The Salt module functions are also made available in the template context as
\fBsalt:\fP
.sp
The following example illustrates calling the \fBgroup_to_gid\fP function in the
\fBfile\fP execution module with a single positional argument called
\fBsome_group_that_exists\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
moe:
  user.present:
    \- gid: {{ salt[\(aqfile.group_to_gid\(aq](\(aqsome_group_that_exists\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
One way to think about this might be that the \fBgid\fP key is being assigned
a value equivalent to the following python pseudo\-code:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.modules.file

file.group_to_gid(\(dqsome_group_that_exists\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that for the above example to work, \fBsome_group_that_exists\fP must exist
before the state file is processed by the templating engine.
.sp
Below is an example that uses the \fBnetwork.hw_addr\fP function to retrieve the
MAC address for eth0:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt[\(dqnetwork.hw_addr\(dq](\(dqeth0\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To examine the possible arguments to each execution module function,
one can examine the \fI\%module reference documentation\fP:
.SS Advanced SLS module syntax
.sp
Lastly, we will cover some incredibly useful techniques for more complex State
trees.
.SS Include declaration
.sp
A previous example showed how to spread a Salt tree across several files.
Similarly, \fI\%Requisites and Other Global State Arguments\fP span multiple files by
using an \fI\%Include declaration\fP\&. For example:
.sp
\fBpython/python\-libs.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python\-dateutil:
  pkg.installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBpython/django.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- python.python\-libs

django:
  pkg.installed:
    \- require:
      \- pkg: python\-dateutil
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Extend declaration
.sp
You can modify previous declarations by using an \fI\%Extend declaration\fP\&. For
example the following modifies the Apache tree to also restart Apache when the
vhosts file is changed:
.sp
\fBapache/apache.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  pkg.installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBapache/mywebsite.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- apache.apache

extend:
  apache:
    service:
      \- running
      \- watch:
        \- file: /etc/httpd/extra/httpd\-vhosts.conf

/etc/httpd/extra/httpd\-vhosts.conf:
  file.managed:
    \- source: salt://apache/httpd\-vhosts.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.IP "Using extend with require or watch"
.sp
The \fBextend\fP statement works differently for \fBrequire\fP or \fBwatch\fP\&.
It appends to, rather than replacing the requisite component.
.UNINDENT
.UNINDENT
.SS Name declaration
.sp
You can override the \fI\%ID declaration\fP by using a \fI\%Name declaration\fP\&.
For example, the previous example is a bit more maintainable if rewritten as
follows:
.sp
\fBapache/mywebsite.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- apache.apache

extend:
  apache:
    service:
      \- running
      \- watch:
        \- file: mywebsite

mywebsite:
  file.managed:
    \- name: /etc/httpd/extra/httpd\-vhosts.conf
    \- source: salt://apache/httpd\-vhosts.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Names declaration
.sp
Even more powerful is using a \fI\%Names declaration\fP to override the
\fI\%ID declaration\fP for multiple states at once. This often can remove the
need for looping in a template. For example, the first example in this tutorial
can be rewritten without the loop:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
stooges:
  user.present:
    \- names:
      \- moe
      \- larry
      \- curly
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Next steps
.sp
In \fI\%part 4\fP we will discuss how to use salt\(aqs
\fI\%file_roots\fP to set up a workflow in which states can be
\(dqpromoted\(dq from dev, to QA, to production.
.SS States tutorial, part 4
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This tutorial builds on topics covered in \fI\%part 1\fP,
\fI\%part 2\fP, and \fI\%part 3\fP\&.
It is recommended that you begin there.
.UNINDENT
.UNINDENT
.sp
This part of the tutorial will show how to use salt\(aqs \fI\%file_roots\fP
to set up a workflow in which states can be \(dqpromoted\(dq from dev, to QA, to
production.
.SS Salt fileserver path inheritance
.sp
Salt\(aqs fileserver allows for more than one root directory per environment, like
in the below example, which uses both a local directory and a secondary
location shared to the salt master via NFS:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# In the master config file (/etc/salt/master)
file_roots:
  base:
    \- /srv/salt
    \- /mnt/salt\-nfs/base
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt\(aqs fileserver collapses the list of root directories into a single virtual
environment containing all files from each root. If the same file exists at the
same relative path in more than one root, then the top\-most match \(dqwins\(dq. For
example, if \fB/srv/salt/foo.txt\fP and \fB/mnt/salt\-nfs/base/foo.txt\fP both
exist, then \fBsalt://foo.txt\fP will point to \fB/srv/salt/foo.txt\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When using multiple fileserver backends, the order in which they are listed
in the \fI\%fileserver_backend\fP parameter also matters. If both
\fBroots\fP and \fBgit\fP backends contain a file with the same relative path,
and \fBroots\fP appears before \fBgit\fP in the
\fI\%fileserver_backend\fP list, then the file in \fBroots\fP will
\(dqwin\(dq, and the file in gitfs will be ignored.
.sp
A more thorough explanation of how Salt\(aqs modular fileserver works can be
found \fI\%here\fP\&. We recommend reading this.
.UNINDENT
.UNINDENT
.SS Environment configuration
.sp
Configure a multiple\-environment setup like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt/prod
  qa:
    \- /srv/salt/qa
    \- /srv/salt/prod
  dev:
    \- /srv/salt/dev
    \- /srv/salt/qa
    \- /srv/salt/prod
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Given the path inheritance described above, files within \fB/srv/salt/prod\fP
would be available in all environments. Files within \fB/srv/salt/qa\fP would be
available in both \fBqa\fP, and \fBdev\fP\&. Finally, the files within
\fB/srv/salt/dev\fP would only be available within the \fBdev\fP environment.
.sp
Based on the order in which the roots are defined, new files/states can be
placed within \fB/srv/salt/dev\fP, and pushed out to the dev hosts for testing.
.sp
Those files/states can then be moved to the same relative path within
\fB/srv/salt/qa\fP, and they are now available only in the \fBdev\fP and \fBqa\fP
environments, allowing them to be pushed to QA hosts and tested.
.sp
Finally, if moved to the same relative path within \fB/srv/salt/prod\fP, the
files are now available in all three environments.
.SS Requesting files from specific fileserver environments
.sp
See \fI\%here\fP for documentation on how to request
files from specific environments.
.SS Practical Example
.sp
As an example, consider a simple website, installed to \fB/var/www/foobarcom\fP\&.
Below is a top.sls that can be used to deploy the website:
.sp
\fB/srv/salt/prod/top.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqweb*prod*\(aq:
    \- webserver.foobarcom
qa:
  \(aqweb*qa*\(aq:
    \- webserver.foobarcom
dev:
  \(aqweb*dev*\(aq:
    \- webserver.foobarcom
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using pillar, roles can be assigned to the hosts:
.sp
\fB/srv/pillar/top.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqweb*prod*\(aq:
    \- webserver.prod
  \(aqweb*qa*\(aq:
    \- webserver.qa
  \(aqweb*dev*\(aq:
    \- webserver.dev
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/pillar/webserver/prod.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
webserver_role: prod
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/pillar/webserver/qa.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
webserver_role: qa
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/pillar/webserver/dev.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
webserver_role: dev
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And finally, the SLS to deploy the website:
.sp
\fB/srv/salt/prod/webserver/foobarcom.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% if pillar.get(\(aqwebserver_role\(aq, \(aq\(aq) %}
/var/www/foobarcom:
  file.recurse:
    \- source: salt://webserver/src/foobarcom
    \- env: {{ pillar[\(aqwebserver_role\(aq] }}
    \- user: www
    \- group: www
    \- dir_mode: 755
    \- file_mode: 644
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Given the above SLS, the source for the website should initially be placed in
\fB/srv/salt/dev/webserver/src/foobarcom\fP\&.
.sp
First, let\(aqs deploy to dev. Given the configuration in the top file, this can
be done using \fI\%state.apply\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-\-pillar \(aqwebserver_role:dev\(aq state.apply
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, in the event that it is not desirable to apply all states configured
in the top file (which could be likely in more complex setups), it is possible
to apply just the states for the \fBfoobarcom\fP website, by invoking
\fI\%state.apply\fP with the desired SLS target
as an argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-\-pillar \(aqwebserver_role:dev\(aq state.apply webserver.foobarcom
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once the site has been tested in dev, then the files can be moved from
\fB/srv/salt/dev/webserver/src/foobarcom\fP to
\fB/srv/salt/qa/webserver/src/foobarcom\fP, and deployed using the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-\-pillar \(aqwebserver_role:qa\(aq state.apply webserver.foobarcom
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Finally, once the site has been tested in qa, then the files can be moved from
\fB/srv/salt/qa/webserver/src/foobarcom\fP to
\fB/srv/salt/prod/webserver/src/foobarcom\fP, and deployed using the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-\-pillar \(aqwebserver_role:prod\(aq state.apply webserver.foobarcom
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Thanks to Salt\(aqs fileserver inheritance, even though the files have been moved
to within \fB/srv/salt/prod\fP, they are still available from the same
\fBsalt://\fP URI in both the qa and dev environments.
.SS Continue Learning
.sp
The best way to continue learning about Salt States is to read through the
\fI\%reference documentation\fP and to look through examples
of existing state trees. Many pre\-configured state trees
can be found on GitHub in the \fI\%saltstack\-formulas\fP collection of repositories.
.sp
If you have any questions, suggestions, or just want to chat with other people
who are using Salt, we have a very active community and we\(aqd love to hear from
you. One of the best places to talk to the community is on the
\fI\%Salt Project Slack workspace\fP\&.
.sp
In addition, by continuing to the \fI\%Orchestrate Runner\fP docs,
you can learn about the powerful orchestration of which Salt is capable.
.SS States Tutorial, Part 5 \- Orchestration with Salt
.sp
This was moved to \fI\%Orchestrate Runner\fP\&.
.SS Syslog\-ng usage
.SS Overview
.sp
Syslog_ng state module is for generating syslog\-ng
configurations. You can do the following things:
.INDENT 0.0
.IP \(bu 2
generate syslog\-ng configuration from YAML,
.IP \(bu 2
use non\-YAML configuration,
.IP \(bu 2
start, stop or reload syslog\-ng.
.UNINDENT
.sp
There is also an execution module, which can check the syntax of the
configuration, get the version and other information about syslog\-ng.
.SS Configuration
.sp
Users can create syslog\-ng configuration statements with the
\fI\%syslog_ng.config\fP function. It requires
a \fIname\fP and a \fIconfig\fP parameter. The \fIname\fP parameter determines the name of
the generated statement and the \fIconfig\fP parameter holds a parsed YAML structure.
.sp
A statement can be declared in the following forms (both are equivalent):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
source.s_localhost:
  syslog_ng.config:
    \- config:
        \- tcp:
          \- ip: \(dq127.0.0.1\(dq
          \- port: 1233
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
s_localhost:
  syslog_ng.config:
    \- config:
        source:
          \- tcp:
            \- ip: \(dq127.0.0.1\(dq
            \- port: 1233
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The first one is called short form, because it needs less typing. Users can use lists
and dictionaries to specify their configuration. The format is quite self describing and
there are more examples [at the end](#examples) of this document.
.SS Quotation
.INDENT 0.0
.TP
.B The quotation can be tricky sometimes but here are some rules to follow:
.INDENT 7.0
.IP \(bu 2
when a string meant to be \fB\(dqstring\(dq\fP in the generated configuration, it should be like \fB\(aq\(dqstring\(dq\(aq\fP in the YAML document
.IP \(bu 2
similarly, users should write \fB\(dq\(aqstring\(aq\(dq\fP to get \fB\(aqstring\(aq\fP in the generated configuration
.UNINDENT
.UNINDENT
.SS Full example
.sp
The following configuration is an example, how a complete syslog\-ng configuration looks like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Set the location of the configuration file
set_location:
  module.run:
    \- name: syslog_ng.set_config_file
    \- m_name: \(dq/home/tibi/install/syslog\-ng/etc/syslog\-ng.conf\(dq

# The syslog\-ng and syslog\-ng\-ctl binaries are here. You needn\(aqt use
# this method if these binaries can be found in a directory in your PATH.
set_bin_path:
  module.run:
    \- name: syslog_ng.set_binary_path
    \- m_name: \(dq/home/tibi/install/syslog\-ng/sbin\(dq

# Writes the first lines into the config file, also erases its previous
# content
write_version:
  module.run:
    \- name: syslog_ng.write_version
    \- m_name: \(dq3.6\(dq

# There is a shorter form to set the above variables
set_variables:
  module.run:
    \- name: syslog_ng.set_parameters
    \- version: \(dq3.6\(dq
    \- binary_path: \(dq/home/tibi/install/syslog\-ng/sbin\(dq
    \- config_file: \(dq/home/tibi/install/syslog\-ng/etc/syslog\-ng.conf\(dq


# Some global options
options.global_options:
  syslog_ng.config:
    \- config:
        \- time_reap: 30
        \- mark_freq: 10
        \- keep_hostname: \(dqyes\(dq

source.s_localhost:
  syslog_ng.config:
    \- config:
        \- tcp:
          \- ip: \(dq127.0.0.1\(dq
          \- port: 1233

destination.d_log_server:
  syslog_ng.config:
    \- config:
        \- tcp:
          \- \(dq127.0.0.1\(dq
          \- port: 1234

log.l_log_to_central_server:
  syslog_ng.config:
    \- config:
        \- source: s_localhost
        \- destination: d_log_server

some_comment:
  module.run:
    \- name: syslog_ng.write_config
    \- config: |
        # Multi line
        # comment

# Another mode to use comments or existing configuration snippets
config.other_comment_form:
  syslog_ng.config:
    \- config: |
        # Multi line
        # comment
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fI\%syslog_ng.reloaded\fP function can generate syslog\-ng configuration from YAML. If the statement (source, destination, parser,
etc.) has a name, this function uses the id as the name, otherwise (log
statement) its purpose is like a mandatory comment.
.sp
After execution this example the syslog_ng state will generate this
file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#Generated by Salt on 2014\-08\-18 00:11:11
@version: 3.6

options {
    time_reap(
        30
    );
    mark_freq(
        10
    );
    keep_hostname(
        yes
    );
};


source s_localhost {
    tcp(
        ip(
            127.0.0.1
        ),
        port(
            1233
        )
    );
};


destination d_log_server {
    tcp(
        127.0.0.1,
        port(
            1234
        )
    );
};


log {
    source(
        s_localhost
    );
    destination(
        d_log_server
    );
};


# Multi line
# comment


# Multi line
# comment
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Users can include arbitrary texts in the generated configuration with
using the \fBconfig\fP statement (see the example above).
.SS Syslog_ng module functions
.sp
You can use \fI\%syslog_ng.set_binary_path\fP
to set the directory which contains the
syslog\-ng and syslog\-ng\-ctl binaries. If this directory is in your PATH,
you don\(aqt need to use this function. There is also a  \fI\%syslog_ng.set_config_file\fP
function to set the location of the configuration file.
.SS Examples
.SS Simple source
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
source s_tail {
 file(
   \(dq/var/log/apache/access.log\(dq,
   follow_freq(1),
   flags(no\-parse, validate\-utf8)
 );
};
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
s_tail:
  # Salt will call the source function of syslog_ng module
  syslog_ng.config:
    \- config:
        source:
          \- file:
            \- file: \(aq\(aq\(dq/var/log/apache/access.log\(dq\(aq\(aq
            \- follow_freq : 1
            \- flags:
              \- no\-parse
              \- validate\-utf8
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
OR
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
s_tail:
  syslog_ng.config:
    \- config:
        source:
            \- file:
              \- \(aq\(aq\(dq/var/log/apache/access.log\(dq\(aq\(aq
              \- follow_freq : 1
              \- flags:
                \- no\-parse
                \- validate\-utf8
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
OR
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
source.s_tail:
  syslog_ng.config:
    \- config:
        \- file:
          \- \(aq\(aq\(dq/var/log/apache/access.log\(dq\(aq\(aq
          \- follow_freq : 1
          \- flags:
            \- no\-parse
            \- validate\-utf8
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Complex source
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
source s_gsoc2014 {
 tcp(
   ip(\(dq0.0.0.0\(dq),
   port(1234),
   flags(no\-parse)
 );
};
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
s_gsoc2014:
  syslog_ng.config:
    \- config:
        source:
          \- tcp:
            \- ip: 0.0.0.0
            \- port: 1234
            \- flags: no\-parse
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Filter
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
filter f_json {
 match(
   \(dq@json:\(dq
 );
};
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
f_json:
  syslog_ng.config:
    \- config:
        filter:
          \- match:
            \- \(aq\(aq\(dq@json:\(dq\(aq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Template
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
template t_demo_filetemplate {
 template(
   \(dq$ISODATE $HOST $MSG \(dq
 );
 template_escape(
   no
 );
};
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
t_demo_filetemplate:
  syslog_ng.config:
    \-config:
        template:
          \- template:
            \- \(aq\(dq$ISODATE $HOST $MSG\en\(dq\(aq
          \- template_escape:
            \- \(dqno\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Rewrite
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rewrite r_set_message_to_MESSAGE {
 set(
   \(dq${.json.message}\(dq,
   value(\(dq$MESSAGE\(dq)
 );
};
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
r_set_message_to_MESSAGE:
  syslog_ng.config:
    \- config:
        rewrite:
          \- set:
            \- \(aq\(dq${.json.message}\(dq\(aq
            \- value : \(aq\(dq$MESSAGE\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Global options
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
options {
   time_reap(30);
   mark_freq(10);
   keep_hostname(yes);
};
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
global_options:
  syslog_ng.config:
    \- config:
        options:
          \- time_reap: 30
          \- mark_freq: 10
          \- keep_hostname: \(dqyes\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Log
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log {
 source(s_gsoc2014);
 junction {
  channel {
   filter(f_json);
   parser(p_json);
   rewrite(r_set_json_tag);
   rewrite(r_set_message_to_MESSAGE);
   destination {
    file(
      \(dq/tmp/json\-input.log\(dq,
      template(t_gsoc2014)
    );
   };
   flags(final);
  };
  channel {
   filter(f_not_json);
   parser {
    syslog\-parser(

    );
   };
   rewrite(r_set_syslog_tag);
   flags(final);
  };
 };
 destination {
  file(
    \(dq/tmp/all.log\(dq,
    template(t_gsoc2014)
  );
 };
};
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
l_gsoc2014:
  syslog_ng.config:
    \- config:
        log:
          \- source: s_gsoc2014
          \- junction:
            \- channel:
              \- filter: f_json
              \- parser: p_json
              \- rewrite: r_set_json_tag
              \- rewrite: r_set_message_to_MESSAGE
              \- destination:
                \- file:
                  \- \(aq\(dq/tmp/json\-input.log\(dq\(aq
                  \- template: t_gsoc2014
              \- flags: final
            \- channel:
              \- filter: f_not_json
              \- parser:
                \- syslog\-parser: []
              \- rewrite: r_set_syslog_tag
              \- flags: final
          \- destination:
            \- file:
              \- \(dq/tmp/all.log\(dq
              \- template: t_gsoc2014
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Salt in 10 Minutes
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Welcome to Salt Project! I am excited that you are interested in Salt and
starting down the path to better infrastructure management. I developed
(and am continuing to develop) Salt with the goal of making the best
software available to manage computers of almost any kind. I hope you enjoy
working with Salt and that the software can solve your real world needs!
.INDENT 0.0
.IP \(bu 2
Thomas S Hatch
.IP \(bu 2
Salt Project creator and Chief Developer of Salt Project
.UNINDENT
.UNINDENT
.UNINDENT
.SS Getting Started
.SS What is Salt?
.sp
Salt is a different approach to infrastructure management, founded on
the idea that high\-speed communication with large numbers of systems can open
up new capabilities. This approach makes Salt a powerful multitasking system
that can solve many specific problems in an infrastructure.
.sp
The backbone of Salt is the remote execution engine, which creates a high\-speed,
secure and bi\-directional communication net for groups of systems. On top of this
communication system, Salt provides an extremely fast, flexible, and easy\-to\-use
configuration management system called \fBSalt States\fP\&.
.SS Installing Salt
.sp
SaltStack has been made to be very easy to install and get started. The
\fI\%Salt install guide\fP
provides instructions for all supported platforms.
.SS Starting Salt
.sp
Salt functions on a master/minion topology. A master server acts as a
central control bus for the clients, which are called \fBminions\fP\&. The minions
connect back to the master.
.SS Setting Up the Salt Master
.sp
Turning on the Salt Master is easy \-\- just turn it on! The default configuration
is suitable for the vast majority of installations. The Salt Master can be
controlled by the local Linux/Unix service manager:
.sp
On Systemd based platforms (newer Debian, openSUSE, Fedora):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
systemctl start salt\-master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
On Upstart based systems (Ubuntu, older Fedora/RHEL):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
service salt\-master start
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
On SysV Init systems (Gentoo, older Debian etc.):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/init.d/salt\-master start
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternatively, the Master can be started directly on the command\-line:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-master \-d
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The Salt Master can also be started in the foreground in debug mode, thus
greatly increasing the command output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-master \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The Salt Master needs to bind to two TCP network ports on the system. These ports
are \fB4505\fP and \fB4506\fP\&. For more in depth information on firewalling these ports,
the firewall tutorial is available \fI\%here\fP\&.
.SS Finding the Salt Master
.sp
When a minion starts, by default it searches for a system that resolves to the \fBsalt\fP hostname on the network.
If found, the minion initiates the handshake and key authentication process with the Salt master.
This means that the easiest configuration approach is to set internal DNS to resolve the name \fBsalt\fP back to the Salt Master IP.
.sp
Otherwise, the minion configuration file will need to be edited so that the
configuration option \fBmaster\fP points to the DNS name or the IP of the Salt Master:
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The default location of the configuration files is \fB/etc/salt\fP\&. Most
platforms adhere to this convention, but platforms such as FreeBSD and
Microsoft Windows place this file in different locations.
.UNINDENT
.UNINDENT
.sp
\fB/etc/salt/minion:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: saltmaster.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Setting up a Salt Minion
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The Salt Minion can operate with or without a Salt Master. This walk\-through
assumes that the minion will be connected to the master, for information on
how to run a master\-less minion please see the master\-less quick\-start guide:
.sp
\fI\%Masterless Minion Quickstart\fP
.UNINDENT
.UNINDENT
.sp
Now that the master can be found, start the minion in the same way as the
master; with the platform init system or via the command line directly:
.sp
As a daemon:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-minion \-d
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the foreground in debug mode:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-minion \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When the minion is started, it will generate an \fBid\fP value, unless it has
been generated on a previous run and cached (in \fB/etc/salt/minion_id\fP by
default). This is the name by which the minion will attempt
to authenticate to the master. The following steps are attempted, in order to
try to find a value that is not \fBlocalhost\fP:
.INDENT 0.0
.IP 1. 3
The Python function \fBsocket.getfqdn()\fP is run
.IP 2. 3
\fB/etc/hostname\fP is checked (non\-Windows only)
.IP 3. 3
\fB/etc/hosts\fP (\fB%WINDIR%\esystem32\edrivers\eetc\ehosts\fP on Windows hosts) is
checked for hostnames that map to anything within \fB127.0.0.0/8\fP\&.
.UNINDENT
.sp
If none of the above are able to produce an id which is not \fBlocalhost\fP, then
a sorted list of IP addresses on the minion (excluding any within
\fB127.0.0.0/8\fP) is inspected. The first publicly\-routable IP address is
used, if there is one. Otherwise, the first privately\-routable IP address is
used.
.sp
If all else fails, then \fBlocalhost\fP is used as a fallback.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Overriding the \fBid\fP
.sp
The minion id can be manually specified using the \fI\%id\fP
parameter in the minion config file.  If this configuration value is
specified, it will override all other sources for the \fBid\fP\&.
.UNINDENT
.UNINDENT
.sp
Now that the minion is started, it will generate cryptographic keys and attempt
to connect to the master. The next step is to venture back to the master server
and accept the new minion\(aqs public key.
.SS Using salt\-key
.sp
Salt authenticates minions using public\-key encryption and authentication. For
a minion to start accepting commands from the master, the minion keys need to be
accepted by the master.
.sp
The \fBsalt\-key\fP command is used to manage all of the keys on the
master. To list the keys that are on the master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-L
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The keys that have been rejected, accepted, and pending acceptance are listed.
The easiest way to accept the minion key is to accept all pending keys:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-A
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Keys should be verified! Print the master key fingerprint by running \fBsalt\-key \-F master\fP
on the Salt master. Copy the \fBmaster.pub\fP fingerprint from the Local Keys section,
and then set this value as the \fI\%master_finger\fP in the minion configuration
file. Restart the Salt minion.
.sp
On the master, run \fBsalt\-key \-f minion\-id\fP to print the fingerprint of the
minion\(aqs public key that was received by the master. On the minion, run
\fBsalt\-call key.finger \-\-local\fP to print the fingerprint of the minion key.
.sp
On the master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-key \-f foo.domain.com
Unaccepted Keys:
foo.domain.com:  39:f9:e4:8a:aa:74:8d:52:1a:ec:92:03:82:09:c8:f9
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
On the minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call key.finger \-\-local
local:
    39:f9:e4:8a:aa:74:8d:52:1a:ec:92:03:82:09:c8:f9
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If they match, approve the key with \fBsalt\-key \-a foo.domain.com\fP\&.
.UNINDENT
.UNINDENT
.SS Sending the First Commands
.sp
Now that the minion is connected to the master and authenticated, the master
can start to command the minion.
.sp
Salt commands allow for a vast set of functions to be executed and for
specific minions and groups of minions to be targeted for execution.
.sp
The \fBsalt\fP command is comprised of command options, target specification,
the function to execute, and arguments to the function.
.sp
A simple command to
start with looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fB*\fP is the target, which specifies all minions.
.sp
\fBtest.version\fP tells the minion to run the \fI\%test.version\fP function.
.sp
In the case of \fBtest.version\fP, \fBtest\fP refers to a \fI\%execution module\fP\&.  \fBversion\fP refers to the \fI\%version\fP function contained in the aforementioned \fBtest\fP
module.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Execution modules are the workhorses of Salt. They do the work on the
system to perform various tasks, such as manipulating files and restarting
services.
.UNINDENT
.UNINDENT
.sp
The result of running this command will be the master instructing all of the
minions to execute \fI\%test.version\fP in parallel
and return the result. Using \fI\%test.version\fP
is a good way of confirming that a minion is connected, and reaffirm to the user
the salt version(s) they have installed on the minions.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Each minion registers itself with a unique minion ID. This ID defaults to
the minion\(aqs hostname, but can be explicitly defined in the minion config as
well by using the \fI\%id\fP parameter.
.UNINDENT
.UNINDENT
.sp
Of course, there are hundreds of other modules that can be called just as
\fBtest.version\fP can.  For example, the following would return disk usage on all
targeted minions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.usage
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Getting to Know the Functions
.sp
Salt comes with a vast library of functions available for execution, and Salt
functions are self\-documenting. To see what functions are available on the
minions execute the \fBsys.doc\fP function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.doc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will display a very large list of available functions and documentation on
them.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Module documentation is also available \fI\%on the web\fP\&.
.UNINDENT
.UNINDENT
.sp
These functions cover everything from shelling out to package management to
manipulating database servers. They comprise a powerful system management API
which is the backbone to Salt configuration management and many other aspects
of Salt.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Salt comes with many plugin systems. The functions that are available via
the \fBsalt\fP command are called \fI\%Execution Modules\fP\&.
.UNINDENT
.UNINDENT
.SS Helpful Functions to Know
.sp
The \fI\%cmd\fP module contains
functions to shell out on minions, such as \fI\%cmd.run\fP and \fI\%cmd.run_all\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run \(aqls \-l /etc\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBpkg\fP functions automatically map local system package managers to the
same salt functions. This means that \fBpkg.install\fP will install packages via
\fByum\fP on Red Hat based systems, \fBapt\fP on Debian systems, etc.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install vim
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Some custom Linux spins and derivatives of other distributions are not properly
detected by Salt. If the above command returns an error message saying that
\fBpkg.install\fP is not available, then you may need to override the pkg
provider. This process is explained \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
The \fI\%network.interfaces\fP function will
list all interfaces on a minion, along with their IP addresses, netmasks, MAC
addresses, etc:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Changing the Output Format
.sp
The default output format used for most Salt commands is called the \fBnested\fP
outputter, but there are several other outputters that can be used to change
the way the output is displayed. For instance, the \fBpprint\fP outputter can be
used to display the return data using Python\(aqs \fBpprint\fP module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
root@saltmaster:~# salt myminion grains.item pythonpath \-\-out=pprint
{\(aqmyminion\(aq: {\(aqpythonpath\(aq: [\(aq/usr/lib64/python2.7\(aq,
                             \(aq/usr/lib/python2.7/plat\-linux2\(aq,
                             \(aq/usr/lib64/python2.7/lib\-tk\(aq,
                             \(aq/usr/lib/python2.7/lib\-tk\(aq,
                             \(aq/usr/lib/python2.7/site\-packages\(aq,
                             \(aq/usr/lib/python2.7/site\-packages/gst\-0.10\(aq,
                             \(aq/usr/lib/python2.7/site\-packages/gtk\-2.0\(aq]}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The full list of Salt outputters, as well as example output, can be found
\fI\%here\fP\&.
.SS \fBsalt\-call\fP
.sp
The examples so far have described running commands from the Master using the
\fBsalt\fP command, but when troubleshooting it can be more beneficial to login
to the minion directly and use \fBsalt\-call\fP\&.
.sp
Doing so allows you to see the minion log messages specific to the command you
are running (which are \fInot\fP part of the return data you see when running the
command from the Master using \fBsalt\fP), making it unnecessary to tail the
minion log. More information on \fBsalt\-call\fP and how to use it can be found
\fI\%here\fP\&.
.SS Grains
.sp
Salt uses a system called \fI\%Grains\fP to build up
static data about minions. This data includes information about the operating
system that is running, CPU architecture and much more. The grains system is
used throughout Salt to deliver platform data to many components and to users.
.sp
Grains can also be statically set, this makes it easy to assign values to
minions for grouping and managing.
.sp
A common practice is to assign grains to minions to specify what the role or
roles a minion might be. These static grains can be set in the minion
configuration file or via the \fI\%grains.setval\fP
function.
.SS Targeting
.sp
Salt allows for minions to be targeted based on a wide range of criteria.  The
default targeting system uses globular expressions to match minions, hence if
there are minions named \fBlarry1\fP, \fBlarry2\fP, \fBcurly1\fP, and \fBcurly2\fP, a
glob of \fBlarry*\fP will match \fBlarry1\fP and \fBlarry2\fP, and a glob of \fB*1\fP
will match \fBlarry1\fP and \fBcurly1\fP\&.
.sp
Many other targeting systems can be used other than globs, these systems
include:
.INDENT 0.0
.TP
.B Regular Expressions
Target using PCRE\-compliant regular expressions
.TP
.B Grains
Target based on grains data:
\fI\%Targeting with Grains\fP
.TP
.B Pillar
Target based on pillar data:
\fI\%Targeting with Pillar\fP
.TP
.B IP
Target based on IP address/subnet/range
.TP
.B Compound
Create logic to target based on multiple targets:
\fI\%Targeting with Compound\fP
.TP
.B Nodegroup
Target with nodegroups:
\fI\%Targeting with Nodegroup\fP
.UNINDENT
.sp
The concepts of targets are used on the command line with Salt, but also
function in many other areas as well, including the state system and the
systems used for ACLs and user permissions.
.SS Passing in Arguments
.sp
Many of the functions available accept arguments which can be passed in on
the command line:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install vim
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example passes the argument \fBvim\fP to the pkg.install function. Since
many functions can accept more complex input than just a string, the arguments
are parsed through YAML, allowing for more complex data to be sent on the
command line:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.echo \(aqfoo: bar\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this case Salt translates the string \(aqfoo: bar\(aq into the dictionary
\(dq{\(aqfoo\(aq: \(aqbar\(aq}\(dq
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Any line that contains a newline will not be parsed by YAML.
.UNINDENT
.UNINDENT
.SS Salt States
.sp
Now that the basics are covered the time has come to evaluate \fBStates\fP\&.  Salt
\fBStates\fP, or the \fBState System\fP is the component of Salt made for
configuration management.
.sp
The state system is already available with a basic Salt setup, no additional
configuration is required. States can be set up immediately.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Before diving into the state system, a brief overview of how states are
constructed will make many of the concepts clearer. Salt states are based
on data modeling and build on a low level data structure that is used to
execute each state function. Then more logical layers are built on top of
each other.
.sp
The high layers of the state system which this tutorial will
cover consists of everything that needs to be known to use states, the two
high layers covered here are the \fIsls\fP layer and the highest layer
\fIhighstate\fP\&.
.sp
Understanding the layers of data management in the State System will help with
understanding states, but they never need to be used. Just as understanding
how a compiler functions assists when learning a programming language,
understanding what is going on under the hood of a configuration management
system will also prove to be a valuable asset.
.UNINDENT
.UNINDENT
.SS The First SLS Formula
.sp
The state system is built on SLS (SaLt State) formulas. These formulas are built out in
files on Salt\(aqs file server. To make a very basic SLS formula open up a file
under /srv/salt named vim.sls. The following state ensures that vim is installed
on a system to which that state has been applied.
.sp
\fB/srv/salt/vim.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now install vim on the minions by calling the SLS directly:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply vim
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This command will invoke the state system and run the \fBvim\fP SLS.
.sp
Now, to beef up the vim SLS formula, a \fBvimrc\fP can be added:
.sp
\fB/srv/salt/vim.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed: []

/etc/vimrc:
  file.managed:
    \- source: salt://vimrc
    \- mode: 644
    \- user: root
    \- group: root
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now the desired \fBvimrc\fP needs to be copied into the Salt file server to
\fB/srv/salt/vimrc\fP\&. In Salt, everything is a file, so no path redirection needs
to be accounted for. The \fBvimrc\fP file is placed right next to the \fBvim.sls\fP file.
The same command as above can be executed to all the vim SLS formulas and now
include managing the file.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Salt does not need to be restarted/reloaded or have the master manipulated
in any way when changing SLS formulas. They are instantly available.
.UNINDENT
.UNINDENT
.SS Adding Some Depth
.sp
Obviously maintaining SLS formulas right in a single directory at the root of
the file server will not scale out to reasonably sized deployments. This is
why more depth is required. Start by making an nginx formula a better way,
make an nginx subdirectory and add an init.sls file:
.sp
\fB/srv/salt/nginx/init.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nginx:
  pkg.installed: []
  service.running:
    \- require:
      \- pkg: nginx
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A few concepts are introduced in this SLS formula.
.sp
First is the service statement which ensures that the \fBnginx\fP service is running.
.sp
Of course, the nginx service can\(aqt be started unless the package is installed \-\-
hence the \fBrequire\fP statement which sets up a dependency between the two.
.sp
The \fBrequire\fP statement makes sure that the required component is executed before
and that it results in success.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fIrequire\fP option belongs to a family of options called \fIrequisites\fP\&.
Requisites are a powerful component of Salt States, for more information
on how requisites work and what is available see:
\fI\%Requisites\fP
.sp
Also evaluation ordering is available in Salt as well:
\fI\%Ordering States\fP
.UNINDENT
.UNINDENT
.sp
This new sls formula has a special name \-\-  \fBinit.sls\fP\&. When an SLS formula is
named \fBinit.sls\fP it inherits the name of the directory path that contains it.
This formula can be referenced via the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply nginx
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%state.apply\fP is just another remote
execution function, just like \fI\%test.version\fP
or \fI\%disk.usage\fP\&. It simply takes the
name of an SLS file as an argument.
.UNINDENT
.UNINDENT
.sp
Now that subdirectories can be used, the \fBvim.sls\fP formula can be cleaned up.
To make things more flexible, move the \fBvim.sls\fP and vimrc into a new subdirectory
called \fBedit\fP and change the \fBvim.sls\fP file to reflect the change:
.sp
\fB/srv/salt/edit/vim.sls:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed

/etc/vimrc:
  file.managed:
    \- source: salt://edit/vimrc
    \- mode: 644
    \- user: root
    \- group: root
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Only the source path to the vimrc file has changed. Now the formula is
referenced as \fBedit.vim\fP because it resides in the edit subdirectory.
Now the edit subdirectory can contain formulas for emacs, nano, joe or any other
editor that may need to be deployed.
.SS Next Reading
.sp
Two walk\-throughs are specifically recommended at this point. First, a deeper
run through States, followed by an explanation of Pillar.
.INDENT 0.0
.IP 1. 3
\fI\%Starting States\fP
.IP 2. 3
\fI\%Pillar Walkthrough\fP
.UNINDENT
.sp
An understanding of Pillar is extremely helpful in using States.
.SS Getting Deeper Into States
.sp
Two more in\-depth States tutorials exist, which delve much more deeply into States
functionality.
.INDENT 0.0
.IP 1. 3
\fI\%How Do I Use Salt States?\fP, covers much
more to get off the ground with States.
.IP 2. 3
The \fI\%States Tutorial\fP also provides a
fantastic introduction.
.UNINDENT
.sp
These tutorials include much more in\-depth information including templating
SLS formulas etc.
.SS So Much More!
.sp
This concludes the initial Salt walk\-through, but there are many more things still
to learn! These documents will cover important core aspects of Salt:
.INDENT 0.0
.IP \(bu 2
\fI\%Pillar\fP
.IP \(bu 2
\fI\%Job Management\fP
.UNINDENT
.sp
A few more tutorials are also available:
.INDENT 0.0
.IP \(bu 2
\fI\%Remote Execution Tutorial\fP
.IP \(bu 2
\fI\%Standalone Minion\fP
.UNINDENT
.sp
This still is only scratching the surface, many components such as the reactor
and event systems, extending Salt, modular components and more are not covered
here. For an overview of all Salt features and documentation, look at the
\fI\%Table of Contents\fP\&.
.SS The macOS (Maverick) Developer Step By Step Guide To Salt Installation
.sp
This document provides a step\-by\-step guide to installing a Salt cluster
consisting of  one master, and one minion running on a local VM hosted on macOS.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This guide is aimed at developers who wish to run Salt in a virtual machine.
The official (Linux) walkthrough can be found
\fI\%here\fP\&.
.UNINDENT
.UNINDENT
.SS The 5 Cent Salt Intro
.sp
Since you\(aqre here you\(aqve probably already heard about Salt, so you already
know Salt lets you configure and run commands on hordes of servers easily.
Here\(aqs a brief overview of a Salt cluster:
.INDENT 0.0
.IP \(bu 2
Salt works by having a \(dqmaster\(dq server sending commands to one or multiple
\(dqminion\(dq servers. The master server is the \(dqcommand center\(dq. It is
going to be the place where you store your configuration files, aka: \(dqwhich
server is the db, which is the web server, and what libraries and software
they should have installed\(dq. The minions receive orders from the master.
Minions are the servers actually performing work for your business.
.IP \(bu 2
Salt has two types of configuration files:
.sp
1. the \(dqsalt communication channels\(dq or \(dqmeta\(dq  or \(dqconfig\(dq configuration
files (not official names): one for the master (usually is /etc/salt/master
, \fBon the master server\fP), and one for minions (default is
/etc/salt/minion or /etc/salt/minion.conf, \fBon the minion servers\fP). Those
files are used to determine things like the Salt Master IP, port, Salt
folder locations, etc.. If these are configured incorrectly, your minions
will probably be unable to receive orders from the master, or the master
will not know which software a given minion should install.
.sp
2. the \(dqbusiness\(dq or \(dqservice\(dq configuration files (once again, not an
official name): these are configuration files, ending with \(dq.sls\(dq extension,
that describe which software should run on which server, along with
particular configuration properties for the software that is being
installed. These files should be created in the /srv/salt folder by default,
but their location can be changed using ... /etc/salt/master configuration file!
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This tutorial contains a third important configuration file, not to
be confused with the previous two: the virtual machine provisioning
configuration file. This in itself is not specifically tied to Salt, but
it also contains some Salt configuration. More on that in step 3. Also
note that all configuration files are YAML files. So indentation matters.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Salt also works with \(dqmasterless\(dq configuration where a minion is
autonomous (in which case salt can be seen as a local configuration tool),
or in \(dqmultiple master\(dq configuration. See the documentation for more on
that.
.UNINDENT
.UNINDENT
.SS Before Digging In, The Architecture Of The Salt Cluster
.SS Salt Master
.sp
The \(dqSalt master\(dq server is going to be the Mac OS machine, directly. Commands
will be run from a terminal app, so Salt will need to be installed on the Mac.
This is going to be more convenient for toying around with configuration files.
.SS Salt Minion
.sp
We\(aqll only have one \(dqSalt minion\(dq server. It is going to be running on a
Virtual Machine running on the Mac, using VirtualBox. It will run an Ubuntu
distribution.
.SS Step 1 \- Configuring The Salt Master On Your Mac
.sp
See the \fI\%Salt install guide\fP
for macOS installation instructions.
.sp
Because Salt has a lot of dependencies that are not built in macOS, we will use
Homebrew to install Salt. Homebrew is a package manager for Mac, it\(aqs great, use
it (for this tutorial at least!). Some people spend a lot of time installing
libs by hand to better understand dependencies, and then realize how useful a
package manager is once they\(aqre configuring a brand new machine and have to do
it all over again. It also lets you \fIuninstall\fP things easily.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Brew is a Ruby program (Ruby is installed by default with your Mac). Brew
downloads, compiles, and links software. The linking phase is when compiled
software is deployed on your machine. It may conflict with manually
installed software, especially in the /usr/local directory. It\(aqs ok,
remove the manually installed version then refresh the link by typing
\fBbrew link \(aqpackageName\(aq\fP\&. Brew has a \fBbrew doctor\fP command that can
help you troubleshoot. It\(aqs a great command, use it often. Brew requires
xcode command line tools. When you run brew the first time it asks you to
install them if they\(aqre not already on your system. Brew installs
software in /usr/local/bin (system bins are in /usr/bin). In order to use
those bins you need your $PATH to search there first. Brew tells you if
your $PATH needs to be fixed.
.UNINDENT
.UNINDENT
.sp
\fBTIP:\fP
.INDENT 0.0
.INDENT 3.5
Use the keyboard shortcut \fBcmd + shift + period\fP in the \(dqopen\(dq macOS
dialog box to display hidden files and folders, such as .profile.
.UNINDENT
.UNINDENT
.SS Install Homebrew
.sp
Install Homebrew here \fI\%https://brew.sh/\fP
.sp
Or just type
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ruby \-e \(dq$(curl \-fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now type the following commands in your terminal (you may want to type \fBbrew
doctor\fP after each to make sure everything\(aqs fine):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
brew install python
brew install swig
brew install zmq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
zmq is ZeroMQ. It\(aqs a fantastic library used for server to server network
communication and is at the core of Salt efficiency.
.UNINDENT
.UNINDENT
.SS Install Salt
.sp
You should now have everything ready to launch this command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
There should be no need for \fBsudo pip install salt\fP\&. Brew installed
Python for your user, so you should have all the access. In case you
would like to check, type \fBwhich python\fP to ensure that it\(aqs
/usr/local/bin/python, and \fBwhich pip\fP which should be
/usr/local/bin/pip.
.UNINDENT
.UNINDENT
.sp
Now type \fBpython\fP in a terminal then, \fBimport salt\fP\&. There should be no
errors. Now exit the Python terminal using \fBexit()\fP\&.
.SS Create The Master Configuration
.sp
If the default /etc/salt/master configuration file was not created,
copy\-paste it from here:
\fI\%https://docs.saltproject.io/en/latest/ref/configuration/examples.html#configuration\-examples\-master\fP
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fB/etc/salt/master\fP is a file, not a folder.
.UNINDENT
.UNINDENT
.sp
Salt Master configuration changes. The Salt master needs a few customization
to be able to run on macOS:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo launchctl limit maxfiles 4096 8192
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the /etc/salt/master file, change max_open_files to 8192 (or just add the
line: \fBmax_open_files: 8192\fP (no quote) if it doesn\(aqt already exists).
.sp
You should now be able to launch the Salt master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo salt\-master \-\-log\-level=all
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There should be no errors when running the above command.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This command is supposed to be a daemon, but for toying around, we\(aqll keep
it running on a terminal to monitor the activity.
.UNINDENT
.UNINDENT
.sp
Now that the master is set, let\(aqs configure a minion on a VM.
.SS Step 2 \- Configuring The Minion VM
.sp
The Salt minion is going to run on a Virtual Machine. There are a lot of
software options that let you run virtual machines on a mac, But for this
tutorial we\(aqre going to use VirtualBox. In addition to virtualBox, we will use
Vagrant, which allows you to create the base VM configuration.
.sp
Vagrant lets you build ready to use VM images, starting from an OS image and
customizing it using \(dqprovisioners\(dq. In our case, we\(aqll use it to:
.INDENT 0.0
.IP \(bu 2
Download the base Ubuntu image
.IP \(bu 2
Install salt on that Ubuntu image (Salt is going to be the \(dqprovisioner\(dq
for the VM).
.IP \(bu 2
Launch the VM
.IP \(bu 2
SSH into the VM to debug
.IP \(bu 2
Stop the VM once you\(aqre done.
.UNINDENT
.SS Install VirtualBox
.sp
Go get it here: \fI\%https://www.virtualbox.org/wiki/Downloads\fP (click on VirtualBox
for macOS hosts => x86/amd64)
.SS Install Vagrant
.sp
Go get it here: \fI\%https://www.vagrantup.com/downloads.html\fP and choose the latest version
(1.3.5 at time of writing), then the .dmg file. Double\-click to install it.
Make sure the \fBvagrant\fP command is found when run in the terminal. Type
\fBvagrant\fP\&. It should display a list of commands.
.SS Create The Minion VM Folder
.sp
Create a folder in which you will store your minion\(aqs VM. In this tutorial,
it\(aqs going to be a minion folder in the $home directory.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cd $home
mkdir minion
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Initialize Vagrant
.sp
From the minion folder, type
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vagrant init ubuntu/focal64
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This command creates a default Vagrantfile configuration file and import focal64 virtualbox image file to configuration, so it could be used. This
configuration file will be used to pass configuration parameters to the Salt
provisioner in Step 3.
.SS Modify the Vagrantfile
.sp
Modify Vagrantfile to use th private_ip in local network.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
config.vm.network :private_network, ip: \(dq192.168.33.10\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
At this point you should have a VM that can run, although there won\(aqt be much
in it. Let\(aqs check that.
.SS Checking The VM
.sp
From the $home/minion folder type:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vagrant up
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A log showing the VM booting should be present. Once it\(aqs done you\(aqll be back
to the terminal:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ping 192.168.33.10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The VM should respond to your ping request.
.sp
Now log into the VM in ssh using Vagrant again:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vagrant ssh
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You should see the shell prompt change to something similar to
\fBvagrant@focal64:~$\fP meaning you\(aqre inside the VM. From there, enter the
following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ping 10.0.2.2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
That ip is the ip of your VM host (the macOS host). The number is a
VirtualBox default and is displayed in the log after the Vagrant ssh
command. We\(aqll use that IP to tell the minion where the Salt master is.
Once you\(aqre done, end the ssh session by typing \fBexit\fP\&.
.UNINDENT
.UNINDENT
.sp
It\(aqs now time to connect the VM to the salt master
.SS Step 3 \- Connecting Master and Minion
.SS Creating The Minion Configuration File
.sp
Create the \fB/etc/salt/minion\fP file. In that file, put the
following lines, giving the ID for this minion, and the IP of the master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: 10.0.2.2
id: \(aqminion1\(aq
file_client: remote
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minions authenticate with the master using keys. Keys are generated
automatically if you don\(aqt provide one and can accept them later on. However,
this requires accepting the minion key every time the minion is destroyed or
created (which could be quite often). A better way is to create those keys in
advance, feed them to the minion, and authorize them once.
.SS Preseed minion keys
.sp
From the minion folder on your Mac run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo salt\-key \-\-gen\-keys=minion1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This should create two files: minion1.pem, and minion1.pub.
Since those files have been created using sudo, but will be used by vagrant,
you need to change ownership:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo chown youruser:yourgroup minion1.pem
sudo chown youruser:yourgroup minion1.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then copy the .pub file into the list of accepted minions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo cp minion1.pub /etc/salt/pki/master/minions/minion1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Modify Vagrantfile to Use Salt Provisioner
.sp
Let\(aqs now modify the Vagrantfile used to provision the Salt VM. Add the
following section in the Vagrantfile (note: it should be at the same
indentation level as the other properties):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-vagrant config
config.vm.provision :salt do |salt|
    salt.run_highstate = true
    salt.minion_config = \(dq/etc/salt/minion\(dq
    salt.minion_key = \(dq./minion1.pem\(dq
    salt.minion_pub = \(dq./minion1.pub\(dq
end
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now destroy the vm and recreate it from the /minion folder:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vagrant destroy
vagrant up
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If everything is fine you should see the following message:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(dqBootstrapping Salt... (this may take a while)
Salt successfully configured and installed!\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Checking Master\-Minion Communication
.sp
To make sure the master and minion are talking to each other, enter the
following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo salt \(aq*\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You should see your minion answering with its salt version. It\(aqs now time to do some
configuration.
.SS Step 4 \- Configure Services to Install On the Minion
.sp
In this step we\(aqll use the Salt master to instruct our minion to install
Nginx.
.SS Checking the system\(aqs original state
.sp
First, make sure that an HTTP server is not installed on our minion.
When opening a browser directed at \fBhttp://192.168.33.10/\fP You should get an
error saying the site cannot be reached.
.SS Initialize the top.sls file
.sp
System configuration is done in \fB/srv/salt/top.sls\fP (and subfiles/folders),
and then applied by running the \fI\%state.apply\fP function to have the Salt master order its minions
to update their instructions and run the associated commands.
.sp
First Create an empty file on your Salt master (macOS machine):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
touch /srv/salt/top.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When the file is empty, or if no configuration is found for our minion
an error is reported:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo salt \(aqminion1\(aq state.apply
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This should return an error stating: \fBNo Top file or external nodes data
matches found\fP\&.
.SS Create The Nginx Configuration
.sp
Now is finally the time to enter the real meat of our server\(aqs configuration.
For this tutorial our minion will be treated as a web server that needs to
have Nginx installed.
.sp
Insert the following lines into \fB/srv/salt/top.sls\fP (which should current be
empty).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqminion1\(aq:
    \- bin.nginx
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now create \fB/srv/salt/bin/nginx.sls\fP containing the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nginx:
  pkg.installed:
    \- name: nginx
  service.running:
    \- enable: True
    \- reload: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Check Minion State
.sp
Finally, run the \fI\%state.apply\fP function
again:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo salt \(aqminion1\(aq state.apply
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You should see a log showing that the Nginx package has been installed
and the service configured. To prove it, open your browser and navigate to
\fI\%http://192.168.33.10/\fP, you should see the standard Nginx welcome page.
.sp
Congratulations!
.SS Where To Go From Here
.sp
A full description of configuration management within Salt (sls files among
other things) is available here:
\fI\%https://docs.saltproject.io/en/latest/index.html#configuration\-management\fP
.SS Salt\(aqs Test Suite: An Introduction
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This tutorial makes a couple of assumptions. The first assumption is that
you have a basic knowledge of Salt. To get up to speed, check out the
\fI\%Salt Walkthrough\fP\&.
.sp
The second assumption is that your Salt development environment is already
configured and that you have a basic understanding of contributing to the
Salt codebase. If you\(aqre unfamiliar with either of these topics, please refer
to the \fI\%Installing Salt for Development\fP
and the \fI\%Contributing\fP pages, respectively.
.UNINDENT
.UNINDENT
.sp
Salt comes with a powerful integration and unit test suite. The test suite
allows for the fully automated run of integration and/or unit tests from a
single interface.
.sp
Salt\(aqs test suite is located under the \fBtests\fP directory in the root of Salt\(aqs
code base and is divided into two main types of tests:
\fI\%unit tests and integration tests\fP\&. The \fBunit\fP and
\fBintegration\fP sub\-test\-suites are located in the \fBtests\fP directory, which is
where the majority of Salt\(aqs test cases are housed.
.SS Getting Set Up For Tests
.sp
First of all you will need to ensure you install \fBnox\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install nox
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Test Directory Structure
.sp
As noted in the introduction to this tutorial, Salt\(aqs test suite is located in the
\fBtests\fP directory in the root of Salt\(aqs code base. From there, the tests are divided
into two groups \fBintegration\fP and \fBunit\fP\&. Within each of these directories, the
directory structure roughly mirrors the directory structure of Salt\(aqs own codebase.
For example, the files inside \fBtests/integration/modules\fP contains tests for the
files located within \fBsalt/modules\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBtests/integration\fP and \fBtests/unit\fP are the only directories discussed in
this tutorial. With the exception of the \fBtests/runtests.py\fP file, which is
used below in the \fI\%Running the Test Suite\fP section, the other directories and
files located in \fBtests\fP are outside the scope of this tutorial.
.UNINDENT
.UNINDENT
.SS Integration vs. Unit
.sp
Given that Salt\(aqs test suite contains two powerful, though very different, testing
approaches, when should you write integration tests and when should you write unit
tests?
.sp
Integration tests use Salt masters, minions, and a syndic to test salt functionality
directly and focus on testing the interaction of these components. Salt\(aqs integration
test runner includes functionality to run Salt execution modules, runners, states,
shell commands, salt\-ssh commands, salt\-api commands, and more. This provides a
tremendous ability to use Salt to test itself and makes writing such tests a breeze.
Integration tests are the preferred method of testing Salt functionality when
possible.
.sp
Unit tests do not spin up any Salt daemons, but instead find their value in testing
singular implementations of individual functions. Instead of testing against specific
interactions, unit tests should be used to test a function\(aqs logic. Unit tests should
be used to test a function\(aqs exit point(s) such as any \fBreturn\fP or \fBraises\fP
statements.
.sp
Unit tests are also useful in cases where writing an integration test might not be
possible. While the integration test suite is extremely powerful, unfortunately at
this time, it does not cover all functional areas of Salt\(aqs ecosystem. For example,
at the time of this writing, there is not a way to write integration tests for Proxy
Minions. Since the test runner will need to be adjusted to account for Proxy Minion
processes, unit tests can still provide some testing support in the interim by
testing the logic contained inside Proxy Minion functions.
.SS Running the Test Suite
.sp
Once all of the \fI\%requirements\fP are installed, the
\fBnox\fP command is used to instantiate Salt\(aqs test suite:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-3(coverage=False)\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The command above, if executed without any options, will run the entire suite of
integration and unit tests. Some tests require certain flags to run, such as
destructive tests. If these flags are not included, then the test suite will only
perform the tests that don\(aqt require special attention.
.sp
At the end of the test run, you will see a summary output of the tests that passed,
failed, or were skipped.
.sp
You can pass any pytest options after the nox command like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-3(coverage=False)\(aq \-\- tests/unit/modules/test_ps.py
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above command will run the \fBtest_ps.py\fP test with the zeromq transport, python3,
and pytest. Pass any pytest options after \fI\-\-\fP
.SS Running Integration Tests
.sp
Salt\(aqs set of integration tests use Salt to test itself. The integration portion
of the test suite includes some built\-in Salt daemons that will spin up in preparation
of the test run. This list of Salt daemon processes includes:
.INDENT 0.0
.IP \(bu 2
2 Salt Masters
.IP \(bu 2
2 Salt Minions
.IP \(bu 2
1 Salt Syndic
.UNINDENT
.sp
These various daemons are used to execute Salt commands and functionality within
the test suite, allowing you to write tests to assert against expected or
unexpected behaviors.
.sp
A simple example of a test utilizing a typical master/minion execution module command
is the test for the \fBtest_ping\fP function in the
\fBtests/integration/modules/test_test.py\fP
file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def test_ping(self):
    \(dq\(dq\(dq
    test.ping
    \(dq\(dq\(dq
    self.assertTrue(self.run_function(\(dqtest.ping\(dq))
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The test above is a very simple example where the \fBtest.ping\fP function is
executed by Salt\(aqs test suite runner and is asserting that the minion returned
with a \fBTrue\fP response.
.SS Test Selection Options
.sp
If you want to run only a subset of tests, this is easily done with pytest. You only
need to point the test runner to the directory. For example if you want to run all
integration module tests:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-3(coverage=False)\(aq \-\- tests/integration/modules/
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Running Unit Tests
.sp
If you want to run only the unit tests, you can just pass the unit test directory
as an option to the test runner.
.sp
The unit tests do not spin up any Salt testing daemons as the integration tests
do and execute very quickly compared to the integration tests.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-3(coverage=False)\(aq \-\- tests/unit/
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Running Specific Tests
.sp
There are times when a specific test file, test class, or even a single,
individual test need to be executed, such as when writing new tests. In these
situations, you should use the \fI\%pytest syntax\fP to select the specific tests.
.sp
For running a single test file, such as the pillar module test file in the
integration test directory, you must provide the file path.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-3(coverage=False)\(aq \-\- tests/pytests/integration/modules/test_pillar.py
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Some test files contain only one test class while other test files contain multiple
test classes. To run a specific test class within the file, append the name of
the test class to the end of the file path:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-3(coverage=False)\(aq \-\- tests/pytests/integration/modules/test_pillar.py::PillarModuleTest
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To run a single test within a file, append both the name of the test class the
individual test belongs to, as well as the name of the test itself:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-3(coverage=False)\(aq \-\- tests/pytests/integration/modules/test_pillar.py::PillarModuleTest::test_data
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following command is an example of how to execute a single test found in
the \fBtests/unit/modules/test_cp.py\fP file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-3(coverage=False)\(aq \-\- tests/pytests/unit/modules/test_cp.py::CpTestCase::test_get_file_not_found
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Writing Tests for Salt
.sp
Once you\(aqre comfortable running tests, you can now start writing them! Be sure
to review the \fI\%Integration vs. Unit\fP section of this tutorial to determine what
type of test makes the most sense for the code you\(aqre testing.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
There are many decorators, naming conventions, and code specifications
required for Salt test files. We will not be covering all of the these specifics
in this tutorial. Please refer to the testing documentation links listed below
in the \fI\%Additional Testing Documentation\fP section to learn more about these
requirements.
.sp
In the following sections, the test examples assume the \(dqnew\(dq test is added to
a test file that is already present and regularly running in the test suite and
is written with the correct requirements.
.UNINDENT
.UNINDENT
.SS Writing Integration Tests
.sp
Since integration tests validate against a running environment, as explained in the
\fI\%Running Integration Tests\fP section of this tutorial, integration tests are very
easy to write and are generally the preferred method of writing Salt tests.
.sp
The following integration test is an example taken from the \fBtest.py\fP file in the
\fBtests/integration/modules\fP directory. This test uses the \fBrun_function\fP method
to test the functionality of a traditional execution module command.
.sp
The \fBrun_function\fP method uses the integration test daemons to execute a
\fBmodule.function\fP command as you would with Salt. The minion runs the function and
returns. The test also uses \fI\%Python\(aqs Assert Functions\fP to test that the
minion\(aqs return is expected.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def test_ping(self):
    \(dq\(dq\(dq
    test.ping
    \(dq\(dq\(dq
    self.assertTrue(self.run_function(\(dqtest.ping\(dq))
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Args can be passed in to the \fBrun_function\fP method as well:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def test_echo(self):
    \(dq\(dq\(dq
    test.echo
    \(dq\(dq\(dq
    self.assertEqual(self.run_function(\(dqtest.echo\(dq, [\(dqtext\(dq]), \(dqtext\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The next example is taken from the
\fBtests/integration/modules/test_aliases.py\fP file and
demonstrates how to pass kwargs to the \fBrun_function\fP call. Also note that this
test uses another salt function to ensure the correct data is present (via the
\fBaliases.set_target\fP call) before attempting to assert what the \fBaliases.get_target\fP
call should return.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def test_set_target(self):
    \(dq\(dq\(dq
    aliases.set_target and aliases.get_target
    \(dq\(dq\(dq
    set_ret = self.run_function(\(dqaliases.set_target\(dq, alias=\(dqfred\(dq, target=\(dqbob\(dq)
    self.assertTrue(set_ret)
    tgt_ret = self.run_function(\(dqaliases.get_target\(dq, alias=\(dqfred\(dq)
    self.assertEqual(tgt_ret, \(dqbob\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using multiple Salt commands in this manner provides two useful benefits. The first is
that it provides some additional coverage for the \fBaliases.set_target\fP function.
The second benefit is the call to \fBaliases.get_target\fP is not dependent on the
presence of any aliases set outside of this test. Tests should not be dependent on
the previous execution, success, or failure of other tests. They should be isolated
from other tests as much as possible.
.sp
While it might be tempting to build out a test file where tests depend on one another
before running, this should be avoided. SaltStack recommends that each test should
test a single functionality and not rely on other tests. Therefore, when possible,
individual tests should also be broken up into singular pieces. These are not
hard\-and\-fast rules, but serve more as recommendations to keep the test suite simple.
This helps with debugging code and related tests when failures occur and problems
are exposed. There may be instances where large tests use many asserts to set up a
use case that protects against potential regressions.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The examples above all use the \fBrun_function\fP option to test execution module
functions in a traditional master/minion environment. To see examples of how to
test other common Salt components such as runners, salt\-api, and more, please
refer to the \fI\%Integration Test Class Examples\fP
documentation.
.UNINDENT
.UNINDENT
.SS Destructive vs Non\-destructive Tests
.sp
Since Salt is used to change the settings and behavior of systems, often, the
best approach to run tests is to make actual changes to an underlying system.
This is where the concept of destructive integration tests comes into play.
Tests can be written to alter the system they are running on. This capability
is what fills in the gap needed to properly test aspects of system management
like package installation.
.sp
To write a destructive test, decorate the test function with the
\fBdestructive_test\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
@pytest.mark.destructive_test
def test_pkg_install(salt_cli):
    ret = salt_cli.run(\(dqpkg.install\(dq, \(dqfinch\(dq)
    assert ret
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Writing Unit Tests
.sp
As explained in the \fI\%Integration vs. Unit\fP section above, unit tests should be
written to test the \fIlogic\fP of a function. This includes focusing on testing
\fBreturn\fP and \fBraises\fP statements. Substantial effort should be made to mock
external resources that are used in the code being tested.
.sp
External resources that should be mocked include, but are not limited to, APIs,
function calls, external data either globally available or passed in through
function arguments, file data, etc. This practice helps to isolate unit tests to
test Salt logic. One handy way to think about writing unit tests is to \(dqblock
all of the exits\(dq. More information about how to properly mock external resources
can be found in Salt\(aqs \fI\%Unit Test\fP documentation.
.sp
Salt\(aqs unit tests utilize Python\(aqs mock class as well as \fI\%MagicMock\fP\&. The
\fB@patch\fP decorator is also heavily used when \(dqblocking all the exits\(dq.
.sp
A simple example of a unit test currently in use in Salt is the
\fBtest_get_file_not_found\fP test in the \fBtests/pytests/unit/modules/test_cp.py\fP file.
This test uses the \fB@patch\fP decorator and \fBMagicMock\fP to mock the return
of the call to Salt\(aqs \fBcp.hash_file\fP execution module function. This ensures
that we\(aqre testing the \fBcp.get_file\fP function directly, instead of inadvertently
testing the call to \fBcp.hash_file\fP, which is used in \fBcp.get_file\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def test_get_file_not_found(self):
    \(dq\(dq\(dq
    Test if get_file can\(aqt find the file.
    \(dq\(dq\(dq
    with patch(\(dqsalt.modules.cp.hash_file\(dq, MagicMock(return_value=False)):
        path = \(dqsalt://saltines\(dq
        dest = \(dq/srv/salt/cheese\(dq
        ret = \(dq\(dq
        assert cp.get_file(path, dest) == ret
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that Salt\(aqs \fBcp\fP module is imported at the top of the file, along with all
of the other necessary testing imports. The \fBget_file\fP function is then called
directed in the testing function, instead of using the \fBrun_function\fP method as
the integration test examples do above.
.sp
The call to \fBcp.get_file\fP returns an empty string when a \fBhash_file\fP isn\(aqt found.
Therefore, the example above is a good illustration of a unit test \(dqblocking
the exits\(dq via the \fB@patch\fP decorator, as well as testing logic via asserting
against the \fBreturn\fP statement in the \fBif\fP clause. In this example we used the
python \fBassert\fP to verify the return from \fBcp.get_file\fP\&. Pytest allows you to use
these \fI\%asserts\fP when writing your tests and, in fact, plain \fI\%asserts\fP is the preferred
way to assert anything in your tests. As Salt dives deeper into Pytest, the use of
\fIunittest.TestClass\fP will be replaced by plain test functions, or test functions grouped
in a class, which \fBdoes not\fP subclass \fIunittest.TestClass\fP, which, of course, doesn\(aqt
work with unittest assert functions.
.sp
There are more examples of writing unit tests of varying complexities available
in the following docs:
.INDENT 0.0
.IP \(bu 2
\fI\%Simple Unit Test Example\fP
.IP \(bu 2
\fI\%Complete Unit Test Example\fP
.IP \(bu 2
\fI\%Complex Unit Test Example\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Considerable care should be made to ensure that you\(aqre testing something
useful in your test functions. It is very easy to fall into a situation
where you have mocked so much of the original function that the test
results in only asserting against the data you have provided. This results
in a poor and fragile unit test.
.UNINDENT
.UNINDENT
.SS Add a python module dependency to the test run
.sp
The test dependencies for python modules are managed under the \fBrequirements/static/ci\fP
directory. You will need to add your module to the appropriate file under \fBrequirements/static/ci\fP\&.
When \fBpre\-commit\fP is run it will create all of the needed requirement files
under \fBrequirements/static/ci/py3{6,7,8,9}\fP\&. Nox will then use these files to install
the requirements for the tests.
.SS Add a system dependency to the test run
.sp
If you need to add a system dependency for the test run, this will need to be added in
the \fI\%salt\-ci\-images\fP repo. This repo uses salt states to install system dependencies.
You need to update the \fBstate\-tree/golden\-images\-provision.sls\fP file with
your dependency to ensure it is installed. Once your PR is merged the core team
will need to promote the new images with your new dependency installed.
.SS Checking for Log Messages
.sp
To test to see if a given log message has been emitted, the following pattern
can be used
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def test_issue_58763_a(tmp_path, modules, state_tree, caplog):

    venv_dir = tmp_path / \(dqissue\-2028\-pip\-installed\(dq

    sls_contents = \(dq\(dq\(dq
    test.random_hash:
      module.run:
        \- size: 10
        \- hash_type: md5
    \(dq\(dq\(dq
    with pytest.helpers.temp_file(\(dqissue\-58763.sls\(dq, sls_contents, state_tree):
        with caplog.at_level(logging.DEBUG):
            ret = modules.state.sls(
                mods=\(dqissue\-58763\(dq,
            )
            assert len(ret.raw) == 1
            for k in ret.raw:
                assert ret.raw[k][\(dqresult\(dq] is True
            assert (
                \(dqDetected legacy module.run syntax: test.random_hash\(dq in caplog.messages
            )
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Test Groups
.sp
Salt has four groups
.INDENT 0.0
.IP \(bu 2
fast \- Tests that are ~10s or faster. Fast tests make up ~75% of tests and can run in 10 to 20 minutes.
.IP \(bu 2
slow \- Tests that are ~10s or slower.
.IP \(bu 2
core \- Tests of any speed that test the root parts of salt.
.IP \(bu 2
flaky\-jail \- Test that need to be temporarily skipped.
.UNINDENT
.sp
Pytest Decorators
.INDENT 0.0
.IP \(bu 2
@pytest.mark.slow_test
.IP \(bu 2
@pytest.mark.core_test
.IP \(bu 2
@pytest.mark.flaky_jail
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
@pytest.mark.core_test
def test_ping(self):
    \(dq\(dq\(dq
    test.ping
    \(dq\(dq\(dq
    self.assertTrue(self.run_function(\(dqtest.ping\(dq))
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also mark all the tests in file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pytestmark = [
    pytest.mark.core_test,
]


def test_ping(self):
    \(dq\(dq\(dq
    test.ping
    \(dq\(dq\(dq
    self.assertTrue(self.run_function(\(dqtest.ping\(dq))


def test_ping2(self):
    \(dq\(dq\(dq
    test.ping
    \(dq\(dq\(dq
    for _ in range(10):
        self.assertTrue(self.run_function(\(dqtest.ping\(dq))
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can enable or disable test groups locally by passing there respected flag:
.INDENT 0.0
.IP \(bu 2
\-\-no\-fast\-tests
.IP \(bu 2
\-\-slow\-tests
.IP \(bu 2
\-\-core\-tests
.IP \(bu 2
\-\-flaky\-jail
.UNINDENT
.sp
In your PR you can enable or disable test groups by setting a label.
All thought the fast, slow and core tests specified in the change file will always run.
.INDENT 0.0
.IP \(bu 2
test:no\-fast
.IP \(bu 2
test:slow
.IP \(bu 2
test:core
.IP \(bu 2
test:flaky\-jail
.UNINDENT
.SS Additional Testing Documentation
.sp
In addition to this tutorial, there are some other helpful resources and documentation
that go into more depth on Salt\(aqs test runner, writing tests for Salt code, and general
Python testing documentation. Please see the follow references for more information:
.INDENT 0.0
.IP \(bu 2
\fI\%Salt\(aqs Test Suite Documentation\fP
.IP \(bu 2
\fI\%Integration Tests\fP
.IP \(bu 2
\fI\%Unit Tests\fP
.IP \(bu 2
\fI\%MagicMock\fP
.IP \(bu 2
\fI\%Python Unittest\fP
.IP \(bu 2
\fI\%Python\(aqs Assert Functions\fP
.UNINDENT
.SS Troubleshooting
.sp
The intent of the troubleshooting section is to introduce solutions to a
number of common issues encountered by users and the tools that are available
to aid in developing States and Salt code.
.SS Troubleshooting the Salt Master
.sp
If your Salt master is having issues such as minions not returning data, slow
execution times, or a variety of other issues, the following links contain
details on troubleshooting the most common issues encountered:
.SS Troubleshooting the Salt Master
.SS Running in the Foreground
.sp
A great deal of information is available via the debug logging system, if you
are having issues with minions connecting or not starting run the master in
the foreground:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-master \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Anyone wanting to run Salt daemons via a process supervisor such as \fI\%monit\fP,
\fI\%runit\fP, or \fI\%supervisord\fP, should omit the \fB\-d\fP argument to the daemons and
run them in the foreground.
.SS What Ports does the Master Need Open?
.sp
For the master, TCP ports 4505 and 4506 need to be open. If you\(aqve put both
your Salt master and minion in debug mode and don\(aqt see an acknowledgment
that your minion has connected, it could very well be a firewall interfering
with the connection. See our \fI\%firewall configuration\fP page for help opening the firewall on various
platforms.
.sp
If you\(aqve opened the correct TCP ports and still aren\(aqt seeing connections,
check that no additional access control system such as \fI\%SELinux\fP or
\fI\%AppArmor\fP is blocking Salt.
.SS Too many open files
.sp
The salt\-master needs at least 2 sockets per host that connects to it, one for
the Publisher and one for response port. Thus, large installations may, upon
scaling up the number of minions accessing a given master, encounter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
12:45:29,289 [salt.master    ][INFO    ] Starting Salt worker process 38
Too many open files
sock != \-1 (tcp_listener.cpp:335)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The solution to this would be to check the number of files allowed to be
opened by the user running salt\-master (root by default):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[root@salt\-master ~]# ulimit \-n
1024
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If this value is not equal to at least twice the number of minions, then it
will need to be raised. For example, in an environment with 1800 minions, the
\fBnofile\fP limit should be set to no less than 3600. This can be done by
creating the file \fB/etc/security/limits.d/99\-salt.conf\fP, with the following
contents:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
root        hard    nofile        4096
root        soft    nofile        4096
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Replace \fBroot\fP with the user under which the master runs, if different.
.sp
If your master does not have an \fB/etc/security/limits.d\fP directory, the lines
can simply be appended to \fB/etc/security/limits.conf\fP\&.
.sp
As with any change to resource limits, it is best to stay logged into your
current shell and open another shell to run \fBulimit \-n\fP again and verify that
the changes were applied correctly. Additionally, if your master is running
upstart, it may be necessary to specify the \fBnofile\fP limit in
\fB/etc/default/salt\-master\fP if upstart isn\(aqt respecting your resource limits:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
limit nofile 4096 4096
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The above is simply an example of how to set these values, and you may
wish to increase them even further if your Salt master is doing more than
just running Salt.
.UNINDENT
.UNINDENT
.SS Salt Master Stops Responding
.sp
There are known bugs with ZeroMQ versions less than 2.1.11 which can cause the
Salt master to not respond properly. If you\(aqre running a ZeroMQ version greater
than or equal to 2.1.9, you can work around the bug by setting the sysctls
\fBnet.core.rmem_max\fP and \fBnet.core.wmem_max\fP to 16777216. Next, set the third
field in \fBnet.ipv4.tcp_rmem\fP and \fBnet.ipv4.tcp_wmem\fP to at least 16777216.
.sp
You can do it manually with something like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# echo 16777216 > /proc/sys/net/core/rmem_max
# echo 16777216 > /proc/sys/net/core/wmem_max
# echo \(dq4096 87380 16777216\(dq > /proc/sys/net/ipv4/tcp_rmem
# echo \(dq4096 87380 16777216\(dq > /proc/sys/net/ipv4/tcp_wmem
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or with the following Salt state:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
net.core.rmem_max:
  sysctl:
    \- present
    \- value: 16777216

net.core.wmem_max:
  sysctl:
    \- present
    \- value: 16777216

net.ipv4.tcp_rmem:
  sysctl:
    \- present
    \- value: 4096 87380 16777216

net.ipv4.tcp_wmem:
  sysctl:
    \- present
    \- value: 4096 87380 16777216
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Live Python Debug Output
.sp
If the master seems to be unresponsive, a SIGUSR1 can be passed to the
salt\-master threads to display what piece of code is executing. This debug
information can be invaluable in tracking down bugs.
.sp
To pass a SIGUSR1 to the master, first make sure the master is running in the
foreground. Stop the service if it is running as a daemon, and start it in the
foreground like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-master \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then pass the signal to the master when it seems to be unresponsive:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# killall \-SIGUSR1 salt\-master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When filing an issue or sending questions to the mailing list for a problem
with an unresponsive daemon, be sure to include this information if possible.
.SS Live Salt\-Master Profiling
.sp
When faced with performance problems one can turn on master process profiling by
sending it SIGUSR2.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# killall \-SIGUSR2 salt\-master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will activate \fByappi\fP profiler inside salt\-master code, then after some
time one must send SIGUSR2 again to stop profiling and save results to file. If
run in foreground salt\-master will report filename for the results, which are
usually located under \fB/tmp\fP on Unix\-based OSes and \fBc:\etemp\fP on windows.
.sp
Make sure you have yappi installed.
.sp
Results can then be analyzed with \fI\%kcachegrind\fP or similar tool.
.sp
Make sure you have yappi installed.
.sp
On Windows, in the absence of kcachegrind, a simple file\-based workflow to create
profiling graphs could use \fI\%gprof2dot\fP, \fI\%graphviz\fP and this batch file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
::
:: Converts callgrind* profiler output to *.pdf, via *.dot
::
@echo off
del *.dot.pdf
for /r %%f in (callgrind*) do (
echo \(dq%%f\(dq
    gprof2dot.exe \-f callgrind \-\-show\-samples  \(dq%%f\(dq \-o \(dq%%f.dot\(dq
    dot.exe \(dq%%f.dot\(dq \-Tpdf \-O
    del \(dq%%f.dot\(dq
)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Commands Time Out or Do Not Return Output
.sp
Depending on your OS (this is most common on Ubuntu due to apt\-get) you may
sometimes encounter times where a \fI\%state.apply\fP, or other long running commands do not return
output.
.sp
By default the timeout is set to 5 seconds. The timeout value can easily be
increased by modifying the \fBtimeout\fP line within your \fB/etc/salt/master\fP
configuration file.
.sp
Having keys accepted for Salt minions that no longer exist or are not reachable
also increases the possibility of timeouts, since the Salt master waits for
those systems to return command results.
.SS Passing the \-c Option to Salt Returns a Permissions Error
.sp
Using the \fB\-c\fP option with the Salt command modifies the configuration
directory. When the configuration file is read it will still base data off of
the \fBroot_dir\fP setting. This can result in unintended behavior if you are
expecting files such as \fB/etc/salt/pki\fP to be pulled from the location
specified with \fB\-c\fP\&. Modify the \fBroot_dir\fP setting to address this
behavior.
.SS Salt Master Doesn\(aqt Return Anything While Running jobs
.sp
When a command being run via Salt takes a very long time to return
(package installations, certain scripts, etc.) the master may drop you back
to the shell. In most situations the job is still running but Salt has
exceeded the set timeout before returning. Querying the job queue will
provide the data of the job but is inconvenient. This can be resolved by
either manually using the \fB\-t\fP option to set a longer timeout when running
commands (by default it is 5 seconds) or by modifying the master
configuration file: \fB/etc/salt/master\fP and setting the \fBtimeout\fP value to
change the default timeout for all commands, and then restarting the
salt\-master service.
.sp
If a \fBstate.apply\fP run takes too long, you can find a bottleneck by adding the
\fI\%\-\-out=profile\fP option.
.SS Salt Master Auth Flooding
.sp
In large installations, care must be taken not to overwhealm the master with
authentication requests. Several options can be set on the master which
mitigate the chances of an authentication flood from causing an interruption in
service.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
recon_default:
.sp
The average number of seconds to wait between reconnection attempts.
.INDENT 0.0
.TP
.B recon_max:
The maximum number of seconds to wait between reconnection attempts.
.TP
.B recon_randomize:
A flag to indicate whether the recon_default value should be randomized.
.TP
.B acceptance_wait_time:
The number of seconds to wait for a reply to each authentication request.
.TP
.B random_reauth_delay:
The range of seconds across which the minions should attempt to randomize
authentication attempts.
.TP
.B auth_timeout:
The total time to wait for the authentication process to complete, regardless
of the number of attempts.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Running states locally
.sp
To debug the states, you can use call locally.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-l trace \-\-local state.highstate
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The top.sls file is used to map what SLS modules get loaded onto what minions via the state system.
.sp
It is located in the file defined in the \fBfile_roots\fP variable of the salt master
configuration file which is defined by found in \fBCONFIG_DIR/master\fP, normally \fB/etc/salt/master\fP
.sp
The default configuration for the \fBfile_roots\fP is:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
So the top file is defaulted to the location \fB/srv/salt/top.sls\fP
.SS Salt Master Umask
.sp
The salt master uses a cache to track jobs as they are published and returns come back.
The recommended umask for a salt\-master is \fI022\fP, which is the default for most users
on a system. Incorrect umasks can result in permission\-denied errors when the master
tries to access files in its cache.
.SS Troubleshooting the Salt Minion
.sp
In the event that your Salt minion is having issues, a variety of solutions
and suggestions are available. Please refer to the following links for more information:
.SS Troubleshooting the Salt Minion
.SS Running in the Foreground
.sp
A great deal of information is available via the debug logging system, if you
are having issues with minions connecting or not starting run the minion in
the foreground:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-minion \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Anyone wanting to run Salt daemons via a process supervisor such as \fI\%monit\fP,
\fI\%runit\fP, or \fI\%supervisord\fP, should omit the \fB\-d\fP argument to the daemons and
run them in the foreground.
.SS What Ports does the Minion Need Open?
.sp
No ports need to be opened on the minion, as it makes outbound connections to
the master. If you\(aqve put both your Salt master and minion in debug mode and
don\(aqt see an acknowledgment that your minion has connected, it could very well
be a firewall interfering with the connection. See our \fI\%firewall
configuration\fP page for help opening the firewall
on various platforms.
.sp
If you have netcat installed, you can check port connectivity from the minion
with the \fBnc\fP command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ nc \-v \-z salt.master.ip.addr 4505
Connection to salt.master.ip.addr 4505 port [tcp/unknown] succeeded!
$ nc \-v \-z salt.master.ip.addr 4506
Connection to salt.master.ip.addr 4506 port [tcp/unknown] succeeded!
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fI\%Nmap\fP utility can also be used to check if these ports are open:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# nmap \-sS \-q \-p 4505\-4506 salt.master.ip.addr

Starting Nmap 6.40 ( http://nmap.org ) at 2013\-12\-29 19:44 CST
Nmap scan report for salt.master.ip.addr (10.0.0.10)
Host is up (0.0026s latency).
PORT     STATE  SERVICE
4505/tcp open   unknown
4506/tcp open   unknown
MAC Address: 00:11:22:AA:BB:CC (Intel)

Nmap done: 1 IP address (1 host up) scanned in 1.64 seconds
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you\(aqve opened the correct TCP ports and still aren\(aqt seeing connections,
check that no additional access control system such as \fI\%SELinux\fP or
\fI\%AppArmor\fP is blocking Salt. Tools like \fI\%tcptraceroute\fP can also be used
to determine if an intermediate device or firewall is blocking the needed
TCP ports.
.SS Using salt\-call
.sp
The \fBsalt\-call\fP command was originally developed for aiding in the
development of new Salt modules. Since then, many applications have been
developed for running any Salt module locally on a minion. These range from the
original intent of salt\-call (development assistance), to gathering more
verbose output from calls like \fI\%state.apply\fP\&.
.sp
When initially creating your state tree, it is generally recommended to invoke
highstates by running \fI\%state.apply\fP directly
from the minion with \fBsalt\-call\fP, rather than remotely from the master. This
displays far more information about the execution than calling it remotely. For
even more verbosity, increase the loglevel using the \fB\-l\fP argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call \-l debug state.apply
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The main difference between using \fBsalt\fP and using \fBsalt\-call\fP is that
\fBsalt\-call\fP is run from the minion, and it only runs the selected function on
that minion. By contrast, \fBsalt\fP is run from the master, and requires you to
specify the minions on which to run the command using salt\(aqs \fI\%targeting
system\fP\&.
.SS Live Python Debug Output
.sp
If the minion seems to be unresponsive, a SIGUSR1 can be passed to the process
to display what piece of code is executing. This debug information can be
invaluable in tracking down bugs.
.sp
To pass a SIGUSR1 to the minion, first make sure the minion is running in the
foreground. Stop the service if it is running as a daemon, and start it in the
foreground like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-minion \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then pass the signal to the minion when it seems to be unresponsive:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# killall \-SIGUSR1 salt\-minion
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When filing an issue or sending questions to the mailing list for a problem
with an unresponsive daemon, be sure to include this information if possible.
.SS Multiprocessing in Execution Modules
.sp
As is outlined in github issue #6300, Salt cannot use python\(aqs multiprocessing
pipes and queues from execution modules. Multiprocessing from the execution
modules is perfectly viable, it is just necessary to use Salt\(aqs event system
to communicate back with the process.
.sp
The reason for this difficulty is that python attempts to pickle all objects in
memory when communicating, and it cannot pickle function objects. Since the
Salt loader system creates and manages function objects this causes the pickle
operation to fail.
.SS Salt Minion Doesn\(aqt Return Anything While Running Jobs Locally
.sp
When a command being run via Salt takes a very long time to return
(package installations, certain scripts, etc.) the minion may drop you back
to the shell. In most situations the job is still running but Salt has
exceeded the set timeout before returning. Querying the job queue will
provide the data of the job but is inconvenient. This can be resolved by
either manually using the \fB\-t\fP option to set a longer timeout when running
commands (by default it is 5 seconds) or by modifying the minion
configuration file: \fB/etc/salt/minion\fP and setting the \fBtimeout\fP value to
change the default timeout for all commands, and then restarting the
salt\-minion service.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Modifying the minion timeout value is not required when running commands
from a Salt Master. It is only required when running commands locally on
the minion.
.UNINDENT
.UNINDENT
.sp
If a \fBstate.apply\fP run takes too long, you can find a bottleneck by adding the
\fI\%\-\-out=profile\fP option.
.SS Running in the Foreground
.sp
A great deal of information is available via the debug logging system, if you
are having issues with minions connecting or not starting run the minion and/or
master in the foreground:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-master \-l debug
salt\-minion \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Anyone wanting to run Salt daemons via a process supervisor such as \fI\%monit\fP,
\fI\%runit\fP, or \fI\%supervisord\fP, should omit the \fB\-d\fP argument to the daemons and
run them in the foreground.
.SS What Ports do the Master and Minion Need Open?
.sp
No ports need to be opened up on each minion. For the master, TCP ports 4505
and 4506 need to be open. If you\(aqve put both your Salt master and minion in
debug mode and don\(aqt see an acknowledgment that your minion has connected,
it could very well be a firewall.
.sp
You can check port connectivity from the minion with the nc command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nc \-v \-z salt.master.ip 4505
nc \-v \-z salt.master.ip 4506
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There is also a \fI\%firewall configuration\fP
document that might help as well.
.sp
If you\(aqve enabled the right TCP ports on your operating system or Linux
distribution\(aqs firewall and still aren\(aqt seeing connections, check that no
additional access control system such as \fI\%SELinux\fP or \fI\%AppArmor\fP is blocking
Salt.
.SS Using salt\-call
.sp
The \fBsalt\-call\fP command was originally developed for aiding in the development
of new Salt modules. Since then, many applications have been developed for
running any Salt module locally on a minion. These range from the original
intent of salt\-call, development assistance, to gathering more verbose output
from calls like \fI\%state.apply\fP\&.
.sp
When initially creating your state tree, it is generally recommended to invoke
\fI\%state.apply\fP directly from the minion with
\fBsalt\-call\fP, rather than remotely from the master. This displays far more
information about the execution than calling it remotely. For even more
verbosity, increase the loglevel using the \fB\-l\fP argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-l debug state.apply
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The main difference between using \fBsalt\fP and using \fBsalt\-call\fP is that
\fBsalt\-call\fP is run from the minion, and it only runs the selected function on
that minion. By contrast, \fBsalt\fP is run from the master, and requires you to
specify the minions on which to run the command using salt\(aqs \fI\%targeting
system\fP\&.
.SS Too many open files
.sp
The salt\-master needs at least 2 sockets per host that connects to it, one for
the Publisher and one for response port. Thus, large installations may, upon
scaling up the number of minions accessing a given master, encounter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
12:45:29,289 [salt.master    ][INFO    ] Starting Salt worker process 38
Too many open files
sock != \-1 (tcp_listener.cpp:335)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The solution to this would be to check the number of files allowed to be
opened by the user running salt\-master (root by default):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[root@salt\-master ~]# ulimit \-n
1024
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And modify that value to be at least equal to the number of minions x 2.
This setting can be changed in limits.conf as the nofile value(s),
and activated upon new a login of the specified user.
.sp
So, an environment with 1800 minions, would need 1800 x 2 = 3600 as a minimum.
.SS Salt Master Stops Responding
.sp
There are known bugs with ZeroMQ versions less than 2.1.11 which can cause the
Salt master to not respond properly. If you\(aqre running a ZeroMQ version greater
than or equal to 2.1.9, you can work around the bug by setting the sysctls
\fBnet.core.rmem_max\fP and \fBnet.core.wmem_max\fP to 16777216. Next, set the third
field in \fBnet.ipv4.tcp_rmem\fP and \fBnet.ipv4.tcp_wmem\fP to at least 16777216.
.sp
You can do it manually with something like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# echo 16777216 > /proc/sys/net/core/rmem_max
# echo 16777216 > /proc/sys/net/core/wmem_max
# echo \(dq4096 87380 16777216\(dq > /proc/sys/net/ipv4/tcp_rmem
# echo \(dq4096 87380 16777216\(dq > /proc/sys/net/ipv4/tcp_wmem
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or with the following Salt state:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
net.core.rmem_max:
  sysctl:
    \- present
    \- value: 16777216

net.core.wmem_max:
  sysctl:
    \- present
    \- value: 16777216

net.ipv4.tcp_rmem:
  sysctl:
    \- present
    \- value: 4096 87380 16777216

net.ipv4.tcp_wmem:
  sysctl:
    \- present
    \- value: 4096 87380 16777216
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Salt and SELinux
.sp
Currently there are no SELinux policies for Salt. For the most part Salt runs
without issue when SELinux is running in Enforcing mode. This is because when
the minion executes as a daemon the type context is changed to \fBinitrc_t\fP\&.
The problem with SELinux arises when using salt\-call or running the minion in
the foreground, since the type context stays \fBunconfined_t\fP\&.
.sp
This problem is generally manifest in the rpm install scripts when using the
pkg module. Until a full SELinux Policy is available for Salt the solution
to this issue is to set the execution context of \fBsalt\-call\fP and
\fBsalt\-minion\fP to rpm_exec_t:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# CentOS 5 and RHEL 5:
chcon \-t system_u:system_r:rpm_exec_t:s0 /usr/bin/salt\-minion
chcon \-t system_u:system_r:rpm_exec_t:s0 /usr/bin/salt\-call

# CentOS 6 and RHEL 6:
chcon system_u:object_r:rpm_exec_t:s0 /usr/bin/salt\-minion
chcon system_u:object_r:rpm_exec_t:s0 /usr/bin/salt\-call
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This works well, because the \fBrpm_exec_t\fP context has very broad control over
other types.
.SS Red Hat Enterprise Linux 5
.sp
Salt requires Python 2.6 or 2.7. Red Hat Enterprise Linux 5 and its variants
come with Python 2.4 installed by default. When installing on RHEL 5 from the
\fI\%EPEL repository\fP this is handled for you. But, if you run Salt from git, be
advised that its dependencies need to be installed from EPEL and that Salt
needs to be run with the \fBpython26\fP executable.
.SS Common YAML Gotchas
.sp
An extensive list of YAML idiosyncrasies has been compiled:
.SS YAML Idiosyncrasies
.sp
One of Salt\(aqs strengths, the use of existing serialization systems for
representing SLS data, can also backfire. \fI\%YAML\fP is a general purpose system
and there are a number of things that would seem to make sense in an sls
file that cause YAML issues. It is wise to be aware of these issues. While
reports or running into them are generally rare they can still crop up at
unexpected times.
.SS Spaces vs Tabs
.sp
\fI\%YAML uses spaces\fP, period. Do not use tabs in your SLS files! If strange
errors are coming up in rendering SLS files, make sure to check that
no tabs have crept in! In Vim, after enabling search highlighting
with: \fB:set hlsearch\fP,  you can check with the following key sequence in
normal mode(you can hit \fIESC\fP twice to be sure): \fB/\fP, \fICtrl\-v\fP, \fITab\fP, then
hit \fIEnter\fP\&. Also, you can convert tabs to 2 spaces by these commands in Vim:
\fB:set tabstop=2 expandtab\fP and then \fB:retab\fP\&.
.SS Indentation
.sp
The suggested syntax for YAML files is to use 2 spaces for indentation,
but YAML will follow whatever indentation system that the individual file
uses. Indentation of two spaces works very well for SLS files given the
fact that the data is uniform and not deeply nested.
.SS Nested Dictionaries
.sp
When dictionaries are nested within other data structures (particularly lists),
the indentation logic sometimes changes.  Examples of where this might happen
include \fBcontext\fP and \fBdefault\fP options from the \fI\%file.managed\fP state:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/http/conf/http.conf:
  file:
    \- managed
    \- source: salt://apache/http.conf
    \- user: root
    \- group: root
    \- mode: 644
    \- template: jinja
    \- context:
        custom_var: \(dqoverride\(dq
    \- defaults:
        custom_var: \(dqdefault value\(dq
        other_var: 123
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Notice that while the indentation is two spaces per level, for the values under
the \fBcontext\fP and \fBdefaults\fP options there is a four\-space indent. If only
two spaces are used to indent, then those keys will be considered part of the
same dictionary that contains the \fBcontext\fP key, and so the data will not be
loaded correctly. If using a double indent is not desirable, then a
deeply\-nested dict can be declared with curly braces:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/http/conf/http.conf:
  file:
    \- managed
    \- source: salt://apache/http.conf
    \- user: root
    \- group: root
    \- mode: 644
    \- template: jinja
    \- context: {
      custom_var: \(dqoverride\(dq }
    \- defaults: {
      custom_var: \(dqdefault value\(dq,
      other_var: 123 }
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here is a more concrete example of how YAML actually handles these
indentations, using the Python interpreter on the command line:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
>>> import yaml
>>> yaml.safe_load(
\&...     \(dq\(dq\(dqmystate:
\&...   file.managed:
\&...     \- context:
\&...         some: var\(dq\(dq\(dq
\&... )
{\(aqmystate\(aq: {\(aqfile.managed\(aq: [{\(aqcontext\(aq: {\(aqsome\(aq: \(aqvar\(aq}}]}}
>>> yaml.safe_load(
\&...     \(dq\(dq\(dqmystate:
\&...   file.managed:
\&...     \- context:
\&...       some: var\(dq\(dq\(dq
\&... )
{\(aqmystate\(aq: {\(aqfile.managed\(aq: [{\(aqsome\(aq: \(aqvar\(aq, \(aqcontext\(aq: None}]}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that in the second example, \fBsome\fP is added as another key in the same
dictionary, whereas in the first example, it\(aqs the start of a new dictionary.
That\(aqs the distinction. \fBcontext\fP is a common example because it is a keyword
arg for many functions, and should contain a dictionary.
.SS Multi\-line Strings
.sp
Similarly, when a multi\-line string is nested within a list item (such as when
using the \fBcontents\fP argument for a \fI\%file.managed\fP state), the indentation must be doubled. Take for
example the following state:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/tmp/foo.txt:
  file.managed:
    \- contents: |
      foo
      bar
      baz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is invalid YAML, and will result in a rather cryptic error when you try to
run the state:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myminion:
    Data failed to compile:
\-\-\-\-\-\-\-\-\-\-
    Rendering SLS \(aqbase:test\(aq failed: could not find expected \(aq:\(aq; line 5

\-\-\-
/tmp/foo.txt:
  file.managed:
    \- contents: |
      foo
      bar    <======================
      baz

\-\-\-
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The correct indentation would be as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/tmp/foo.txt:
  file.managed:
    \- contents: |
        foo
        bar
        baz
.ft P
.fi
.UNINDENT
.UNINDENT
.SS True/False, Yes/No, On/Off
.sp
PyYAML will load these values as boolean \fBTrue\fP or \fBFalse\fP\&. Un\-capitalized
versions will also be loaded as booleans (\fBtrue\fP, \fBfalse\fP, \fByes\fP, \fBno\fP,
\fBon\fP, and \fBoff\fP). This can be especially problematic when constructing
Pillar data. Make sure that your Pillars which need to use the string versions
of these values are enclosed in quotes. Pillars will be parsed twice by salt,
so you\(aqll need to wrap your values in multiple quotes, including double quotation
marks (\fB\(dq \(dq\fP) and single quotation marks (\fB\(aq \(aq\fP). Note that spaces are included
in the quotation type examples for clarity.
.sp
Multiple quoting examples looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- \(aq\(dqfalse\(dq\(aq
\- \(dq\(aqTrue\(aq\(dq
\- \(dq\(aqYES\(aq\(dq
\- \(aq\(dqNo\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When using multiple quotes in this manner, they must be different. Using \fB\(dq\(dq \(dq\(dq\fP
or \fB\(aq\(aq \(aq\(aq\fP won\(aqt work in this case (spaces are included in examples for clarity).
.UNINDENT
.UNINDENT
.SS The \(aq%\(aq Sign
.sp
The \fI%\fP symbol has a special meaning in YAML, it needs to be passed as a
string literal:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cheese:
  ssh_auth.present:
    \- user: tbortels
    \- source: salt://ssh_keys/chease.pub
    \- config: \(aq%h/.ssh/authorized_keys\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Time Expressions
.sp
PyYAML will load a time expression as the integer value of that, assuming
\fBHH:MM\fP\&. So for example, \fB12:00\fP is loaded by PyYAML as \fB720\fP\&. An
excellent explanation for why can be found \fI\%here\fP\&.
.sp
To keep time expressions like this from being loaded as integers, always quote
them.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When using a jinja \fBload_yaml\fP map, items must be quoted twice. For
example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% load_yaml as wsus_schedule %}

FRI_10:
  time: \(aq\(dq23:00\(dq\(aq
  day: 6 \- Every Friday
SAT_10:
  time: \(aq\(dq06:00\(dq\(aq
  day: 7 \- Every Saturday
SAT_20:
  time: \(aq\(dq14:00\(dq\(aq
  day: 7 \- Every Saturday
SAT_30:
  time: \(aq\(dq22:00\(dq\(aq
  day: 7 \- Every Saturday
SUN_10:
  time: \(aq\(dq06:00\(dq\(aq
  day: 1 \- Every Sunday
{% endload %}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS YAML does not like \(dqDouble Short Decs\(dq
.sp
If I can find a way to make YAML accept \(dqDouble Short Decs\(dq then I will, since
I think that double short decs would be awesome. So what is a \(dqDouble Short
Dec\(dq? It is when you declare a multiple short decs in one ID. Here is a
standard short dec, it works great:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The short dec means that there are no arguments to pass, so it is not required
to add any arguments, and it can save space.
.sp
YAML though, gets upset when declaring multiple short decs, for the record...
.sp
THIS DOES NOT WORK:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed
  user.present
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Similarly declaring a short dec in the same ID dec as a standard dec does not
work either...
.sp
ALSO DOES NOT WORK:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fred:
  user.present
  ssh_auth.present:
    \- name: AAAAB3NzaC...
    \- user: fred
    \- enc: ssh\-dss
    \- require:
      \- user: fred
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The correct way is to define them like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed: []
  user.present: []

fred:
  user.present: []
  ssh_auth.present:
    \- name: AAAAB3NzaC...
    \- user: fred
    \- enc: ssh\-dss
    \- require:
      \- user: fred
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternatively,  they can be defined the \(dqold way\(dq,  or with multiple
\(dqfull decs\(dq:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg:
    \- installed
  user:
    \- present

fred:
  user:
    \- present
  ssh_auth:
    \- present
    \- name: AAAAB3NzaC...
    \- user: fred
    \- enc: ssh\-dss
    \- require:
      \- user: fred
.ft P
.fi
.UNINDENT
.UNINDENT
.SS YAML supports only plain ASCII
.sp
According to YAML specification, only ASCII characters can be used.
.sp
Within double\-quotes, special characters may be represented with C\-style
escape sequences starting with a backslash ( \e ).
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- micro: \(dq\eu00b5\(dq
\- copyright: \(dq\eu00A9\(dq
\- A: \(dq\ex41\(dq
\- alpha: \(dq\eu0251\(dq
\- Alef: \(dq\eu05d0\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
List of usable \fI\%Unicode characters\fP  will help you to identify correct numbers.
.sp
Python can also be used to discover the Unicode number for a character:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
repr(\(dqText with wrong characters i need to figure out\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This shell command can find wrong characters in your SLS files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
find . \-name \(aq*.sls\(aq  \-exec  grep \-\-color=\(aqauto\(aq \-P \-n \(aq[^\ex00\-\ex7F]\(aq \e{} \e;
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternatively you can toggle the \fIyaml_utf8\fP setting in your master configuration
file. This is still an experimental setting but it should manage the right
encoding conversion in salt after yaml states compilations.
.SS Underscores stripped in Integer Definitions
.sp
If a definition only includes numbers and underscores, it is parsed by YAML as
an integer and all underscores are stripped.  To ensure the object becomes a
string, it should be surrounded by quotes.  \fI\%More information here\fP\&.
.sp
Here\(aqs an example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
>>> import yaml
>>> yaml.safe_load(\(dq2013_05_10\(dq)
20130510
>>> yaml.safe_load(\(aq\(dq2013_05_10\(dq\(aq)
\(aq2013_05_10\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Automatic \fBdatetime\fP conversion
.sp
If there is a value in a YAML file formatted \fB2014\-01\-20 14:23:23\fP or
similar, YAML will automatically convert this to a Python \fBdatetime\fP object.
These objects are not msgpack serializable, and so may break core salt
functionality.  If values such as these are needed in a salt YAML file
(specifically a configuration file), they should be formatted with surrounding
strings to force YAML to serialize them as strings:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
>>> import yaml
>>> yaml.safe_load(\(dq2014\-01\-20 14:23:23\(dq)
datetime.datetime(2014, 1, 20, 14, 23, 23)
>>> yaml.safe_load(\(aq\(dq2014\-01\-20 14:23:23\(dq\(aq)
\(aq2014\-01\-20 14:23:23\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Additionally, numbers formatted like \fBXXXX\-XX\-XX\fP will also be converted (or
YAML will attempt to convert them, and error out if it doesn\(aqt think the date
is a real one).  Thus, for example, if a minion were to have an ID of
\fB4017\-16\-20\fP the minion would not start because YAML would complain that the
date was out of range.  The workaround is the same, surround the offending
string with quotes:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
>>> import yaml
>>> yaml.safe_load(\(dq4017\-16\-20\(dq)
Traceback (most recent call last):
  File \(dq<stdin>\(dq, line 1, in <module>
  File \(dq/usr/local/lib/python2.7/site\-packages/yaml/__init__.py\(dq, line 93, in safe_load
    return load(stream, SafeLoader)
  File \(dq/usr/local/lib/python2.7/site\-packages/yaml/__init__.py\(dq, line 71, in load
    return loader.get_single_data()
  File \(dq/usr/local/lib/python2.7/site\-packages/yaml/constructor.py\(dq, line 39, in get_single_data
    return self.construct_document(node)
  File \(dq/usr/local/lib/python2.7/site\-packages/yaml/constructor.py\(dq, line 43, in construct_document
    data = self.construct_object(node)
  File \(dq/usr/local/lib/python2.7/site\-packages/yaml/constructor.py\(dq, line 88, in construct_object
    data = constructor(self, node)
  File \(dq/usr/local/lib/python2.7/site\-packages/yaml/constructor.py\(dq, line 312, in construct_yaml_timestamp
    return datetime.date(year, month, day)
ValueError: month must be in 1..12
>>> yaml.safe_load(\(aq\(dq4017\-16\-20\(dq\(aq)
\(aq4017\-16\-20\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Keys Limited to 1024 Characters
.sp
Simple keys are limited by the \fI\%YAML Spec\fP to a single line, and cannot be
longer that 1024 characters. PyYAML enforces these limitations (see \fI\%here\fP),
and therefore anything parsed as YAML in Salt is subject to them.
.SS Live Python Debug Output
.sp
If the minion or master seems to be unresponsive, a SIGUSR1 can be passed to
the processes to display where in the code they are running. If encountering a
situation like this, this debug information can be invaluable. First make
sure the master of minion are running in the foreground:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-master \-l debug
salt\-minion \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then pass the signal to the master or minion when it seems to be unresponsive:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
killall \-SIGUSR1 salt\-master
killall \-SIGUSR1 salt\-minion
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Also under BSD and macOS in addition to SIGUSR1 signal, debug subroutine set
up for SIGINFO which has an advantage of being sent by Ctrl+T shortcut.
.sp
When filing an issue or sending questions to the mailing list for a problem
with an unresponsive daemon this information can be invaluable.
.SS Salt 0.16.x minions cannot communicate with a 0.17.x master
.sp
As of release 0.17.1 you can no longer run different versions of Salt on your
Master and Minion servers. This is due to a protocol change for security
purposes. The Salt team will continue to attempt to ensure versions are as
backwards compatible as possible.
.SS Debugging the Master and Minion
.sp
A list of common \fI\%master\fP and
\fI\%minion\fP troubleshooting steps provide a
starting point for resolving issues you may encounter.
.SS Frequently Asked Questions
.SS FAQ
.INDENT 0.0
.IP \(bu 2
\fI\%Frequently Asked Questions\fP
.INDENT 2.0
.IP \(bu 2
\fI\%Is Salt open\-core?\fP
.IP \(bu 2
\fI\%I think I found a bug! What should I do?\fP
.IP \(bu 2
\fI\%What ports should I open on my firewall?\fP
.IP \(bu 2
\fI\%I\(aqm seeing weird behavior (including but not limited to packages not installing their users properly)\fP
.IP \(bu 2
\fI\%My script runs every time I run a state.apply. Why?\fP
.IP \(bu 2
\fI\%When I run test.ping, why don\(aqt the Minions that aren\(aqt responding return anything? Returning False would be helpful.\fP
.IP \(bu 2
\fI\%How does Salt determine the Minion\(aqs id?\fP
.IP \(bu 2
\fI\%I\(aqm trying to manage packages/services but I get an error saying that the state is not available. Why?\fP
.IP \(bu 2
\fI\%Why aren\(aqt my custom modules/states/etc. available on my Minions?\fP
.IP \(bu 2
\fI\%Module X isn\(aqt available, even though the shell command it uses is installed. Why?\fP
.IP \(bu 2
\fI\%Can I run different versions of Salt on my Master and Minion?\fP
.IP \(bu 2
\fI\%Does Salt support backing up managed files?\fP
.IP \(bu 2
\fI\%Is it possible to deploy a file to a specific minion, without other minions having access to it?\fP
.IP \(bu 2
\fI\%What is the best way to restart a Salt Minion daemon using Salt after upgrade?\fP
.INDENT 2.0
.IP \(bu 2
\fI\%Upgrade without automatic restart\fP
.IP \(bu 2
\fI\%Restart using states\fP
.IP \(bu 2
\fI\%Restart using remote executions\fP
.IP \(bu 2
\fI\%Waiting for minions to come back online\fP
.UNINDENT
.IP \(bu 2
\fI\%Salting the Salt Master\fP
.IP \(bu 2
\fI\%Is Targeting using Grain Data Secure?\fP
.IP \(bu 2
\fI\%Why Did the Value for a Grain Change on Its Own?\fP
.UNINDENT
.UNINDENT
.SS Is Salt open\-core?
.sp
No. Salt is 100% committed to being open\-source, including all of our APIs. It
is developed under the \fI\%Apache 2.0 license\fP, allowing it to be used in both
open and proprietary projects.
.sp
To expand on this a little:
.sp
There is much argument over the actual definition of \(dqopen core\(dq.  From our standpoint, Salt is open source because
.INDENT 0.0
.IP 1. 3
It is a standalone product that anyone is free to use.
.IP 2. 3
It is developed in the open with contributions accepted from the community for the good of the project.
.IP 3. 3
There are no features of Salt itself that are restricted to separate proprietary products distributed by VMware, Inc.
.IP 4. 3
Because of our Apache 2.0 license, Salt can be used as the foundation for a project or even a proprietary tool.
.IP 5. 3
Our APIs are open and documented (any lack of documentation is an oversight as opposed to an intentional decision by SaltStack the company) and available for use by anyone.
.UNINDENT
.sp
SaltStack the company does make proprietary products which use Salt and its libraries, like company is free to do, but we do so via the APIs, NOT by forking Salt and creating a different, closed\-source version of it for paying customers.
.SS I think I found a bug! What should I do?
.sp
The salt\-users mailing list as well as the salt IRC channel can both be helpful
resources to confirm if others are seeing the issue and to assist with
immediate debugging.
.sp
To report a bug to the Salt project, please follow the instructions in
\fI\%reporting a bug\fP\&.
.SS What ports should I open on my firewall?
.sp
Minions need to be able to connect to the Master on TCP ports 4505 and 4506.
Minions do not need any inbound ports open. More detailed information on
firewall settings can be found \fI\%here\fP\&.
.SS I\(aqm seeing weird behavior (including but not limited to packages not installing their users properly)
.sp
This is often caused by SELinux.  Try disabling SELinux or putting it in
permissive mode and see if the weird behavior goes away.
.SS My script runs every time I run a \fIstate.apply\fP\&. Why?
.sp
You are probably using \fI\%cmd.run\fP rather than
\fI\%cmd.wait\fP\&. A \fI\%cmd.wait\fP state will only run when there has been a change in a
state that it is watching.
.sp
A \fI\%cmd.run\fP state will run the corresponding command
\fIevery time\fP (unless it is prevented from running by the \fBunless\fP or \fBonlyif\fP
arguments).
.sp
More details can be found in the documentation for the \fI\%cmd\fP states.
.SS When I run \fItest.ping\fP, why don\(aqt the Minions that aren\(aqt responding return anything? Returning \fBFalse\fP would be helpful.
.sp
When you run \fItest.ping\fP the Master tells Minions to run commands/functions,
and listens for the return data, printing it to the screen when it is received.
If it doesn\(aqt receive anything back, it doesn\(aqt have anything to display for
that Minion.
.sp
There are a couple options for getting information on Minions that are not
responding. One is to use the verbose (\fB\-v\fP) option when you run salt
commands, as it will display \(dqMinion did not return\(dq for any Minions which time
out.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-v \(aq*\(aq pkg.install zsh
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Another option is to use the \fI\%manage.down\fP
runner:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.down
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Also, if the Master is under heavy load, it is possible that the CLI will exit
without displaying return data for all targeted Minions. However, this doesn\(aqt
mean that the Minions did not return; this only means that the Salt CLI timed
out waiting for a response. Minions will still send their return data back to
the Master once the job completes. If any expected Minions are missing from the
CLI output, the \fI\%jobs.list_jobs\fP runner can
be used to show the job IDs of the jobs that have been run, and the
\fI\%jobs.lookup_jid\fP runner can be used to get
the return data for that job.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run jobs.list_jobs
salt\-run jobs.lookup_jid 20130916125524463507
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you find that you are often missing Minion return data on the CLI, only to
find it with the jobs runners, then this may be a sign that the
\fI\%worker_threads\fP value may need to be increased in the master
config file. Additionally, running your Salt CLI commands with the \fB\-t\fP
option will make Salt wait longer for the return data before the CLI command
exits. For instance, the below command will wait up to 60 seconds for the
Minions to return:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-t 60 \(aq*\(aq test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.SS How does Salt determine the Minion\(aqs id?
.sp
If the Minion id is not configured explicitly (using the \fI\%id\fP
parameter), Salt will determine the id based on the hostname. Exactly how this
is determined varies a little between operating systems and is described in
detail \fI\%here\fP\&.
.SS I\(aqm trying to manage packages/services but I get an error saying that the state is not available. Why?
.sp
Salt detects the Minion\(aqs operating system and assigns the correct package or
service management module based on what is detected. However, for certain custom
spins and OS derivatives this detection fails. In cases like this, an issue
should be opened on our \fI\%tracker\fP, with the following information:
.INDENT 0.0
.IP 1. 3
The output of the following command:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
salt <minion_id> grains.items | grep os
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
The contents of \fB/etc/lsb\-release\fP, if present on the Minion.
.UNINDENT
.SS Why aren\(aqt my custom modules/states/etc. available on my Minions?
.sp
Custom modules are synced to Minions when
\fI\%saltutil.sync_modules\fP,
or \fI\%saltutil.sync_all\fP is run.
.sp
Similarly, custom states are synced to Minions when \fI\%saltutil.sync_states\fP, or \fI\%saltutil.sync_all\fP is run.
.sp
They are both also synced when a \fI\%highstate\fP is
triggered.
.sp
As of the 2019.2.0 release, as well as 2017.7.7 and 2018.3.2 in their
respective release cycles, the \fBsync\fP argument to \fI\%state.apply\fP/\fI\%state.sls\fP can
be used to sync custom types when running individual SLS files.
.sp
Other custom types (renderers, outputters, etc.) have similar behavior, see the
documentation for the \fI\%saltutil\fP module for more
information.
.sp
\fI\%This reactor example\fP can be used to automatically
sync custom types when the minion connects to the master, to help with this
chicken\-and\-egg issue.
.SS Module \fBX\fP isn\(aqt available, even though the shell command it uses is installed. Why?
.sp
This is most likely a PATH issue. Did you custom\-compile the software which the
module requires? RHEL/CentOS/etc. in particular override the root user\(aqs path
in \fB/etc/init.d/functions\fP, setting it to \fB/sbin:/usr/sbin:/bin:/usr/bin\fP,
making software installed into \fB/usr/local/bin\fP unavailable to Salt when the
Minion is started using the initscript. In version 2014.1.0, Salt will have a
better solution for these sort of PATH\-related issues, but recompiling the
software to install it into a location within the PATH should resolve the
issue in the meantime. Alternatively, you can create a symbolic link within the
PATH using a \fI\%file.symlink\fP state.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/usr/bin/foo:
  file.symlink:
    \- target: /usr/local/bin/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Can I run different versions of Salt on my Master and Minion?
.sp
This depends on the versions.  In general, it is recommended that Master and
Minion versions match.
.sp
When upgrading Salt, the master(s) should always be upgraded first.  Backwards
compatibility for minions running newer versions of salt than their masters is
not guaranteed.
.sp
Whenever possible, backwards compatibility between new masters
and old minions will be preserved.  Generally, the only exception to this
policy is in case of a security vulnerability.
.sp
Recent examples of backwards compatibility breakage include the 0.17.1 release
(where all backwards compatibility was broken due to a security fix), and the
2014.1.0 release (which retained compatibility between 2014.1.0 masters and
0.17 minions, but broke compatibility for 2014.1.0 minions and older masters).
.SS Does Salt support backing up managed files?
.sp
Yes. Salt provides an easy to use addition to your file.managed states that
allow you to back up files via \fI\%backup_mode\fP,
backup_mode can be configured on a per state basis, or in the minion config
(note that if set in the minion config this would simply be the default
method to use, you still need to specify that the file should be backed up!).
.SS Is it possible to deploy a file to a specific minion, without other minions having access to it?
.sp
The Salt fileserver does not yet support access control, but it is still
possible to do this. As of Salt 2015.5.0, the
\fI\%file_tree\fP external pillar is available, and
allows the contents of a file to be loaded as Pillar data. This external pillar
is capable of assigning Pillar values both to individual minions, and to
\fI\%nodegroups\fP\&. See the \fI\%documentation\fP for details on how to set this up.
.sp
Once the external pillar has been set up, the data can be pushed to a minion
via a \fI\%file.managed\fP state, using the
\fBcontents_pillar\fP argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/my_super_secret_file:
  file.managed:
    \- user: secret
    \- group: secret
    \- mode: 600
    \- contents_pillar: secret_files:my_super_secret_file
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example, the source file would be located in a directory called
\fBsecret_files\fP underneath the file_tree path for the minion. The syntax for
specifying the pillar variable is the same one used for \fI\%pillar.get\fP, with a colon representing a nested dictionary.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Deploying binary contents using the \fI\%file.managed\fP state is only supported in Salt 2015.8.4 and
newer.
.UNINDENT
.UNINDENT
.SS What is the best way to restart a Salt Minion daemon using Salt after upgrade?
.sp
Updating the \fBsalt\-minion\fP package requires a restart of the \fBsalt\-minion\fP
service. But restarting the service while in the middle of a state run
interrupts the process of the Minion running states and sending results back to
the Master. A common way to workaround that is to schedule restarting the
Minion service in the background by issuing a \fBsalt\-call\fP command calling
\fBservice.restart\fP function. This prevents the Minion being disconnected from
the Master immediately. Otherwise you would get
\fBMinion did not return. [Not connected]\fP message as the result of a state run.
.SS Upgrade without automatic restart
.sp
Doing the Minion upgrade seems to be a simplest state in your SLS file at
first. But the operating systems such as Debian GNU/Linux, Ubuntu and their
derivatives start the service after the package installation by default.
To prevent this, we need to create policy layer which will prevent the Minion
service to restart right after the upgrade:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- if grains[\(aqos_family\(aq] == \(aqDebian\(aq %}

Disable starting services:
  file.managed:
    \- name: /usr/sbin/policy\-rc.d
    \- user: root
    \- group: root
    \- mode: 0755
    \- contents:
      \- \(aq#!/bin/sh\(aq
      \- exit 101
    # do not touch if already exists
    \- replace: False
    \- prereq:
      \- pkg: Upgrade Salt Minion

{%\- endif %}

Upgrade Salt Minion:
  pkg.installed:
    \- name: salt\-minion
    \- version: 2016.11.3{% if grains[\(aqos_family\(aq] == \(aqDebian\(aq %}+ds\-1{% endif %}
    \- order: last

Enable Salt Minion:
  service.enabled:
    \- name: salt\-minion
    \- require:
      \- pkg: Upgrade Salt Minion

{%\- if grains[\(aqos_family\(aq] == \(aqDebian\(aq %}

Enable starting services:
  file.absent:
    \- name: /usr/sbin/policy\-rc.d
    \- onchanges:
      \- pkg: Upgrade Salt Minion

{%\- endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Restart using states
.sp
Now we can apply the workaround to restart the Minion in reliable way.
The following example works on UNIX\-like operating systems:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- if grains[\(aqos\(aq] != \(aqWindows\(aq %}
Restart Salt Minion:
  cmd.run:
    \- name: \(aqsalt\-call service.restart salt\-minion\(aq
    \- bg: True
    \- onchanges:
      \- pkg: Upgrade Salt Minion
{%\- endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that restarting the \fBsalt\-minion\fP service on Windows operating systems is
not always necessary when performing an upgrade. The installer stops the
\fBsalt\-minion\fP service, removes it, deletes the contents of the \fB\esalt\ebin\fP
directory, installs the new code, re\-creates the \fBsalt\-minion\fP service, and
starts it (by default). The restart step \fBwould\fP be necessary during the
upgrade process, however, if the minion config was edited after the upgrade or
installation. If a minion restart is necessary, the state above can be edited
as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Restart Salt Minion:
  cmd.run:
{%\- if grains[\(aqkernel\(aq] == \(aqWindows\(aq %}
    \- name: \(aqC:\esalt\esalt\-call.bat service.restart salt\-minion\(aq
{%\- else %}
    \- name: \(aqsalt\-call service.restart salt\-minion\(aq
{%\- endif %}
    \- bg: True
    \- onchanges:
      \- pkg: Upgrade Salt Minion
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, it requires more advanced tricks to upgrade from legacy version of
Salt (before \fB2016.3.0\fP) on UNIX\-like operating systems, where executing
commands in the background is not supported. You also may need to schedule
restarting the Minion service using \fI\%masterless mode\fP after all other states have been applied for Salt
versions earlier than \fB2016.11.0\fP\&. This allows the Minion to keep the
connection to the Master alive for being able to report the final results back
to the Master, while the service is restarting in the background. This state
should run last or watch for the \fBpkg\fP state changes:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Restart Salt Minion:
  cmd.run:
{%\- if grains[\(aqkernel\(aq] == \(aqWindows\(aq %}
    \- name: \(aqstart powershell \(dqRestart\-Service \-Name salt\-minion\(dq\(aq
{%\- else %}
    # fork and disown the process
    \- name: |\-
        exec 0>&\- # close stdin
        exec 1>&\- # close stdout
        exec 2>&\- # close stderr
        nohup salt\-call \-\-local service.restart salt\-minion &
{%\- endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Restart using remote executions
.sp
Restart the Minion from the command line:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G kernel:Windows cmd.run_bg \(aqC:\esalt\esalt\-call.bat service.restart salt\-minion\(aq
salt \-C \(aqnot G@kernel:Windows\(aq cmd.run_bg \(aqsalt\-call service.restart salt\-minion\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Waiting for minions to come back online
.sp
A common issue in performing automated restarts of a salt minion, for example during
an orchestration run, is that it will break the orchestration since the next statement
is likely to be attempted before the minion is back online. This can be remedied
by inserting a blocking waiting state that only returns when the selected minions
are back up (note: this will only work in orchestration states since \fImanage.up\fP
needs to run on the master):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Wait for salt minion:
  loop.until_no_eval:
    \- name: saltutil.runner
    \- expected:
        \- my_minion
    \- args:
        \- manage.up
    \- kwargs:
        tgt: my_minion
    \- period: 3
    \- init_wait: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will, after an initial delay of 3 seconds, execute the \fImanage.up\fP\-runner
targeted specifically for \fImy_minion\fP\&. It will do this every \fIperiod\fP seconds
until the \fIexpected\fP data is returned. The default timeout is 60s but can be configured
as well.
.SS Salting the Salt Master
.sp
In order to configure a master server via states, the Salt master can also be
\(dqsalted\(dq in order to enforce state on the Salt master as well as the Salt
minions. Salting the Salt master requires a Salt minion to be installed on
the same machine as the Salt master. Once the Salt minion is installed, the
minion configuration file must be pointed to the local Salt master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: 127.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once the Salt master has been \(dqsalted\(dq with a Salt minion, it can be targeted
just like any other minion. If the minion on the salted master is running, the
minion can be targeted via any usual \fBsalt\fP command. Additionally, the
\fBsalt\-call\fP command can execute operations to enforce state on the salted
master without requiring the minion to be running.
.sp
More information about salting the Salt master can be found in the salt\-formula
for salt itself:
.sp
\fI\%https://github.com/saltstack\-formulas/salt\-formula\fP
.sp
Restarting the \fBsalt\-master\fP service using execution module or application of
state could be done the same way as for the Salt minion described \fI\%above\fP\&.
.SS Is Targeting using Grain Data Secure?
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Grains can be set by users that have access to the minion configuration files on
the local system, making them less secure than other identifiers in Salt. Avoid
storing sensitive data, such as passwords or keys, on minions. Instead, make
use of \fI\%Storing Static Data in the Pillar\fP and/or \fI\%Storing Data in Other Databases\fP\&.
.UNINDENT
.UNINDENT
.sp
Because grains can be set by users that have access to the minion configuration
files on the local system, grains are considered less secure than other
identifiers in Salt. Use caution when targeting sensitive operations or setting
pillar values based on grain data.
.sp
The only grain which can be safely used is \fBgrains[\(aqid\(aq]\fP which contains the Minion ID.
.sp
When possible, you should target sensitive operations and data using the Minion
ID. If the Minion ID of a system changes, the Salt Minion\(aqs public key must be
re\-accepted by an administrator on the Salt Master, making it less vulnerable
to impersonation attacks.
.SS Why Did the Value for a Grain Change on Its Own?
.sp
This is usually the result of an upstream change in an OS distribution that
replaces or removes something that Salt was using to detect the grain.
Fortunately, when this occurs, you can use Salt to fix it with a command
similar to the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqgrain:ChangedValue\(aq grains.setvals \(dq{\(aqgrain\(aq: \(aqOldValue\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
(Replacing \fIgrain\fP, \fIChangedValue\fP, and \fIOldValue\fP with
the grain and values that you want to change / set.)
.sp
You should also \fI\%file an issue\fP
describing the change so it can be fixed in Salt.
.SS Salt Best Practices
.sp
Salt\(aqs extreme flexibility leads to many questions concerning the structure of
configuration files.
.sp
This document exists to clarify these points through examples and code.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
The guidance here should be taken in combination with \fI\%Hardening Salt\fP\&.
.UNINDENT
.UNINDENT
.SS General rules
.INDENT 0.0
.IP 1. 3
Modularity and clarity should be emphasized whenever possible.
.IP 2. 3
Create clear relations between pillars and states.
.IP 3. 3
Use variables when it makes sense but don\(aqt overuse them.
.IP 4. 3
Store sensitive data in pillar.
.IP 5. 3
Don\(aqt use grains for matching in your pillar top file for any sensitive
pillars.
.sp
\fBWARNING:\fP
.INDENT 3.0
.INDENT 3.5
Grains can be set by users that have access to the minion configuration files on
the local system, making them less secure than other identifiers in Salt. Avoid
storing sensitive data, such as passwords or keys, on minions. Instead, make
use of \fI\%Storing Static Data in the Pillar\fP and/or \fI\%Storing Data in Other Databases\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Structuring States and Formulas
.sp
When structuring Salt States and Formulas it is important to begin with the
directory structure. A proper directory structure clearly defines the
functionality of each state to the user via visual inspection of the state\(aqs
name.
.sp
Reviewing the \fI\%MySQL Salt Formula\fP
it is clear to see the benefits to the end\-user when reviewing a sample of the
available states:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/srv/salt/mysql/files/
/srv/salt/mysql/client.sls
/srv/salt/mysql/map.jinja
/srv/salt/mysql/python.sls
/srv/salt/mysql/server.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This directory structure would lead to these states being referenced in a top
file in the following way:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqweb*\(aq:
    \- mysql.client
    \- mysql.python
  \(aqdb*\(aq:
    \- mysql.server
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This clear definition ensures that the user is properly informed of what each
state will do.
.sp
Another example comes from the \fI\%url vim\-formula\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/srv/salt/vim/files/
/srv/salt/vim/absent.sls
/srv/salt/vim/init.sls
/srv/salt/vim/map.jinja
/srv/salt/vim/nerdtree.sls
/srv/salt/vim/pyflakes.sls
/srv/salt/vim/salt.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once again viewing how this would look in a top file:
.sp
/srv/salt/top.sls:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqweb*\(aq:
    \- vim
    \- vim.nerdtree
    \- vim.pyflakes
    \- vim.salt
  \(aqdb*\(aq:
    \- vim.absent
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The usage of a clear top\-level directory as well as properly named states
reduces the overall complexity and leads a user to both understand what will
be included at a glance and where it is located.
.sp
In addition \fI\%Formulas\fP should
be used as often as possible.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Formulas repositories on the saltstack\-formulas GitHub organization should
not be pointed to directly from systems that automatically fetch new
updates such as GitFS or similar tooling. Instead formulas repositories
should be forked on GitHub or cloned locally, where unintended, automatic
changes will not take place.
.UNINDENT
.UNINDENT
.SS Structuring Pillar Files
.sp
\fI\%Pillars\fP are used to store
secure and insecure data pertaining to minions. When designing the structure
of the \fB/srv/pillar\fP directory, the pillars contained within
should once again be focused on clear and concise data which users can easily
review, modify, and understand.
.sp
The \fB/srv/pillar/\fP directory is primarily controlled by \fBtop.sls\fP\&. It
should be noted that the pillar \fBtop.sls\fP is not used as a location to
declare variables and their values. The \fBtop.sls\fP is used as a way to
include other pillar files and organize the way they are matched based on
environments or grains.
.sp
An example \fBtop.sls\fP may be as simple as the following:
.sp
/srv/pillar/top.sls:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- packages
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Any number of matchers can be added to the base environment. For example, here
is an expanded version of the Pillar top file stated above:
.sp
/srv/pillar/top.sls:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- packages
  \(aqweb*\(aq:
    \- apache
    \- vim
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or an even more complicated example, using a variety of matchers in numerous
environments:
.sp
/srv/pillar/top.sls:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- apache
dev:
  \(aqos:Debian\(aq:
    \- match: grain
    \- vim
test:
  \(aq* and not G@os: Debian\(aq:
    \- match: compound
    \- emacs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is clear to see through these examples how the top file provides users with
power but when used incorrectly it can lead to confusing configurations. This
is why it is important to understand that the top file for pillar is not used
for variable definitions.
.sp
Each SLS file within the \fB/srv/pillar/\fP directory should correspond to the
states which it matches.
.sp
This would mean that the \fBapache\fP pillar file should contain data relevant to
Apache. Structuring files in this way once again ensures modularity, and
creates a consistent understanding throughout our Salt environment. Users can
expect that pillar variables found in an Apache state will live inside of an
Apache pillar:
.sp
\fB/srv/pillar/apache.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  lookup:
    name: httpd
    config:
      tmpl: /etc/httpd/httpd.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
While this pillar file is simple, it shows how a pillar file explicitly
relates to the state it is associated with.
.SS Variable Flexibility
.sp
Salt allows users to define variables in SLS files. When creating a state
variables should provide users with as much flexibility as possible. This
means that variables should be clearly defined and easy to manipulate, and
that sane defaults should exist in the event a variable is not properly
defined. Looking at several examples shows how these different items can
lead to extensive flexibility.
.sp
Although it is possible to set variables locally, this is generally not
preferred:
.sp
\fB/srv/salt/apache/conf.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set name = \(aqhttpd\(aq %}
{% set tmpl = \(aqsalt://apache/files/httpd.conf\(aq %}

include:
  \- apache

apache_conf:
  file.managed:
    \- name: {{ name }}
    \- source: {{ tmpl }}
    \- template: jinja
    \- user: root
    \- watch_in:
      \- service: apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When generating this information it can be easily transitioned to the pillar
where data can be overwritten, modified, and applied to multiple states, or
locations within a single state:
.sp
\fB/srv/pillar/apache.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  lookup:
    name: httpd
    config:
      tmpl: salt://apache/files/httpd.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/salt/apache/conf.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% from \(dqapache/map.jinja\(dq import apache with context %}

include:
  \- apache

apache_conf:
  file.managed:
    \- name: {{ salt[\(aqpillar.get\(aq](\(aqapache:lookup:name\(aq) }}
    \- source: {{ salt[\(aqpillar.get\(aq](\(aqapache:lookup:config:tmpl\(aq) }}
    \- template: jinja
    \- user: root
    \- watch_in:
      \- service: apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This flexibility provides users with a centralized location to modify
variables, which is extremely important as an environment grows.
.SS Modularity Within States
.sp
Ensuring that states are modular is one of the key concepts to understand
within Salt. When creating a state a user must consider how many times the
state could be re\-used, and what it relies on to operate. Below are several
examples which will iteratively explain how a user can go from a state which
is not very modular to one that is:
.sp
\fB/srv/salt/apache/init.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg:
    \- installed
  service.running:
    \- enable: True

/etc/httpd/httpd.conf:
  file.managed:
    \- source: salt://apache/files/httpd.conf
    \- template: jinja
    \- watch_in:
      \- service: httpd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The example above is probably the worst\-case scenario when writing a state.
There is a clear lack of focus by naming both the pkg/service, and managed
file directly as the state ID. This would lead to changing multiple requires
within this state, as well as others that may depend upon the state.
.sp
Imagine if a require was used for the \fBhttpd\fP package in another state, and
then suddenly it\(aqs a custom package. Now changes need to be made in multiple
locations which increases the complexity and leads to a more error prone
configuration.
.sp
There is also the issue of having the configuration file located in the init,
as a user would be unable to simply install the service and use the default
conf file.
.sp
Our second revision begins to address the referencing by using \fB\- name\fP, as
opposed to direct ID references:
.sp
\fB/srv/salt/apache/init.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  pkg.installed:
    \- name: httpd
  service.running:
    \- name: httpd
    \- enable: True

apache_conf:
  file.managed:
    \- name: /etc/httpd/httpd.conf
    \- source: salt://apache/files/httpd.conf
    \- template: jinja
    \- watch_in:
      \- service: apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above init file is better than our original, yet it has several issues
which lead to a lack of modularity. The first of these problems is the usage
of static values for items such as the name of the service, the name of the
managed file, and the source of the managed file. When these items are hard
coded they become difficult to modify and the opportunity to make mistakes
arises. It also leads to multiple edits that need to occur when changing
these items (imagine if there were dozens of these occurrences throughout the
state!). There is also still the concern of the configuration file data living
in the same state as the service and package.
.sp
In the next example steps will be taken to begin addressing these issues.
Starting with the addition of a map.jinja file (as noted in the
\fI\%Formula documentation\fP), and
modification of static values:
.sp
\fB/srv/salt/apache/map.jinja\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set apache = salt[\(aqgrains.filter_by\(aq]({
    \(aqDebian\(aq: {
        \(aqserver\(aq: \(aqapache2\(aq,
        \(aqservice\(aq: \(aqapache2\(aq,
        \(aqconf\(aq: \(aq/etc/apache2/apache.conf\(aq,
    },
    \(aqRedHat\(aq: {
        \(aqserver\(aq: \(aqhttpd\(aq,
        \(aqservice\(aq: \(aqhttpd\(aq,
        \(aqconf\(aq: \(aq/etc/httpd/httpd.conf\(aq,
    },
}, merge=salt[\(aqpillar.get\(aq](\(aqapache:lookup\(aq)) %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
/srv/pillar/apache.sls:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  lookup:
    config:
      tmpl: salt://apache/files/httpd.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/salt/apache/init.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% from \(dqapache/map.jinja\(dq import apache with context %}

apache:
  pkg.installed:
    \- name: {{ apache.server }}
  service.running:
    \- name: {{ apache.service }}
    \- enable: True

apache_conf:
  file.managed:
    \- name: {{ apache.conf }}
    \- source: {{ salt[\(aqpillar.get\(aq](\(aqapache:lookup:config:tmpl\(aq) }}
    \- template: jinja
    \- user: root
    \- watch_in:
      \- service: apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The changes to this state now allow us to easily identify the location of the
variables, as well as ensuring they are flexible and easy to modify.
While this takes another step in the right direction, it is not yet complete.
Suppose the user did not want to use the provided conf file, or even their own
configuration file, but the default apache conf. With the current state setup
this is not possible. To attain this level of modularity this state will need
to be broken into two states.
.sp
\fB/srv/salt/apache/map.jinja\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set apache = salt[\(aqgrains.filter_by\(aq]({
    \(aqDebian\(aq: {
        \(aqserver\(aq: \(aqapache2\(aq,
        \(aqservice\(aq: \(aqapache2\(aq,
        \(aqconf\(aq: \(aq/etc/apache2/apache.conf\(aq,
    },
    \(aqRedHat\(aq: {
        \(aqserver\(aq: \(aqhttpd\(aq,
        \(aqservice\(aq: \(aqhttpd\(aq,
        \(aqconf\(aq: \(aq/etc/httpd/httpd.conf\(aq,
    },
}, merge=salt[\(aqpillar.get\(aq](\(aqapache:lookup\(aq)) %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/pillar/apache.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  lookup:
    config:
      tmpl: salt://apache/files/httpd.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/salt/apache/init.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% from \(dqapache/map.jinja\(dq import apache with context %}

apache:
  pkg.installed:
    \- name: {{ apache.server }}
  service.running:
    \- name: {{ apache.service }}
    \- enable: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/salt/apache/conf.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% from \(dqapache/map.jinja\(dq import apache with context %}

include:
  \- apache

apache_conf:
  file.managed:
    \- name: {{ apache.conf }}
    \- source: {{ salt[\(aqpillar.get\(aq](\(aqapache:lookup:config:tmpl\(aq) }}
    \- template: jinja
    \- user: root
    \- watch_in:
      \- service: apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This new structure now allows users to choose whether they only wish to
install the default Apache, or if they wish, overwrite the default package,
service, configuration file location, or the configuration file itself. In
addition to this the data has been broken between multiple files allowing for
users to identify where they need to change the associated data.
.SS Storing Secure Data
.sp
Secure data refers to any information that you would not wish to share with
anyone accessing a server. This could include data such as passwords,
keys, or other information.
.sp
As all data within a state is accessible by EVERY server that is connected
it is important to store secure data within pillar. This will ensure that only
those servers which require this secure data have access to it. In this
example a use can go from an insecure configuration to one which is only
accessible by the appropriate hosts:
.sp
\fB/srv/salt/mysql/testerdb.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
testdb:
  mysql_database.present:
    \- name: testerdb
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/salt/mysql/user.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- mysql.testerdb

testdb_user:
  mysql_user.present:
    \- name: frank
    \- password: \(dqtest3rdb\(dq
    \- host: localhost
    \- require:
      \- sls: mysql.testerdb
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Many users would review this state and see that the password is there in plain
text, which is quite problematic. It results in several issues which may not
be immediately visible.
.sp
The first of these issues is clear to most users \-\- the password being visible
in this state. This  means that any minion will have a copy of this, and
therefore the password which is a major security concern as minions may not
be locked down as tightly as the master server.
.sp
The other issue that can be encountered is access by users on the master. If
everyone has access to the states (or their repository), then they are able to
review this password. Keeping your password data accessible by only a few
users is critical for both security and peace of mind.
.sp
There is also the issue of portability. When a state is configured this way
it results in multiple changes needing to be made. This was discussed in the
sections above but it is a critical idea to drive home. If states are not
portable it may result in more work later!
.sp
Fixing this issue is relatively simple, the content just needs to be moved to
the associated pillar:
.sp
\fB/srv/pillar/mysql.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql:
  lookup:
    name: testerdb
    password: test3rdb
    user: frank
    host: localhost
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/salt/mysql/testerdb.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
testdb:
  mysql_database.present:
    \- name: {{ salt[\(aqpillar.get\(aq](\(aqmysql:lookup:name\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/salt/mysql/user.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- mysql.testerdb

testdb_user:
  mysql_user.present:
    \- name: {{ salt[\(aqpillar.get\(aq](\(aqmysql:lookup:user\(aq) }}
    \- password: {{ salt[\(aqpillar.get\(aq](\(aqmysql:lookup:password\(aq) }}
    \- host: {{ salt[\(aqpillar.get\(aq](\(aqmysql:lookup:host\(aq) }}
    \- require:
      \- sls: mysql.testerdb
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now that the database details have been moved to the associated pillar file,
only machines which are targeted via pillar will have access to these details.
Access to users who should not be able to review these details can also be
prevented while ensuring that they are still able to write states which take
advantage of this information.
.SH REMOTE EXECUTION
.sp
Running pre\-defined or arbitrary commands on remote hosts, also known as
remote execution, is the core function of Salt. The following links explore
modules and returners, which are two key elements of remote execution.
.sp
\fBSalt Execution Modules\fP
.sp
Salt execution modules are called by the remote execution system to perform
a wide variety of tasks. These modules provide functionality such as installing
packages, restarting a service, running a remote command, transferring files,
and so on.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \fI\%Full list of execution modules\fP
Contains: a list of core modules that ship with Salt.
.TP
.B \fI\%Writing execution modules\fP
Contains: a guide on how to write Salt modules.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Running Commands on Salt Minions
.sp
Salt can be controlled by a command line client by the root user on the Salt
master. The Salt command line client uses the Salt client API to communicate
with the Salt master server. The Salt client is straightforward and simple
to use.
.sp
Using the Salt client commands can be easily sent to the minions.
.sp
Each of these commands accepts an explicit \fI\-\-config\fP option to point to either
the master or minion configuration file.  If this option is not provided and
the default configuration file does not exist then Salt falls back to use the
environment variables \fBSALT_MASTER_CONFIG\fP and \fBSALT_MINION_CONFIG\fP\&.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Configuration\fP
.UNINDENT
.UNINDENT
.SS Using the Salt Command
.sp
The Salt command needs a few components to send information to the Salt
minions. The target minions need to be defined, the function to call and any
arguments the function requires.
.SS Defining the Target Minions
.sp
The first argument passed to salt, defines the target minions, the target
minions are accessed via their hostname. The default target type is a bash
glob:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*foo.com\(aq sys.doc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt can also define the target minions with regular expressions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-E \(aq.*\(aq cmd.run \(aqls \-l | grep foo\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or to explicitly list hosts, salt can take a list:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-L foo.bar.baz,quo.qux cmd.run \(aqps aux | grep foo\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS More Powerful Targets
.sp
See \fI\%Targeting\fP\&.
.SS Calling the Function
.sp
The function to call on the specified target is placed after the target
specification.
.sp
New in version 0.9.8.

.sp
Functions may also accept arguments, space\-delimited:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.exec_code python \(aqimport sys; print sys.version\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Optional, keyword arguments are also supported:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.install salt timeout=5 upgrade=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
They are always in the form of \fBkwarg=argument\fP\&.
.sp
Arguments are formatted as YAML:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run \(aqecho \(dqHello: $FIRST_NAME\(dq\(aq env=\(aq{FIRST_NAME: \(dqJoe\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note: dictionaries must have curly braces around them (like the \fBenv\fP
keyword argument above).  This was changed in 0.15.1: in the above example,
the first argument used to be parsed as the dictionary
\fB{\(aqecho \(dqHello\(aq: \(aq$FIRST_NAME\(dq\(aq}\fP\&. This was generally not the expected
behavior.
.sp
If you want to test what parameters are actually passed to a module, use the
\fBtest.arg_repr\fP command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.arg_repr \(aqecho \(dqHello: $FIRST_NAME\(dq\(aq env=\(aq{FIRST_NAME: \(dqJoe\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Finding available minion functions
.sp
The Salt functions are self documenting, all of the function documentation can
be retried from the minions via the \fBsys.doc()\fP function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.doc
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Compound Command Execution
.sp
If a series of commands needs to be sent to a single target specification then
the commands can be sent in a single publish. This can make gathering
groups of information faster, and lowers the stress on the network for repeated
commands.
.sp
Compound command execution works by sending a list of functions and arguments
instead of sending a single function and argument. The functions are executed
on the minion in the order they are defined on the command line, and then the
data from all of the commands are returned in a dictionary. This means that
the set of commands are called in a predictable way, and the returned data can
be easily interpreted.
.sp
Executing compound commands if done by passing a comma delimited list of
functions, followed by a comma delimited list of arguments:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run,test.ping,test.echo \(aqcat /proc/cpuinfo\(aq,,foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The trick to look out for here, is that if a function is being passed no
arguments, then there needs to be a placeholder for the absent arguments. This
is why in the above example, there are two commas right next to each other.
\fBtest.ping\fP takes no arguments, so we need to add another comma, otherwise
Salt would attempt to pass \(dqfoo\(dq to \fBtest.ping\fP\&.
.sp
If you need to pass arguments that include commas, then make sure you add
spaces around the commas that separate arguments. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run,test.ping,test.echo \(aqecho \(dq1,2,3\(dq\(aq , , foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You may change the arguments separator using the \fB\-\-args\-separator\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-\-args\-separator=:: \(aq*\(aq some.fun,test.echo params with , comma :: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.SS CLI Completion
.sp
Shell completion scripts for the Salt CLI are available in the \fBpkg\fP Salt
\fI\%source directory\fP\&.
.SS Writing Execution Modules
.sp
Salt execution modules are the functions called by the \fBsalt\fP command.
.SS Modules Are Easy to Write!
.sp
Writing Salt execution modules is straightforward.
.sp
A Salt execution module is a Python or \fI\%Cython\fP module placed in a directory
called \fB_modules/\fP at the root of the Salt fileserver. When using the default
fileserver backend (i.e. \fI\%roots\fP), unless
environments are otherwise defined in the \fI\%file_roots\fP config
option, the \fB_modules/\fP directory would be located in \fB/srv/salt/_modules\fP
on most systems.
.sp
Modules placed in \fB_modules/\fP will be synced to the minions when any of the
following Salt functions are called:
.INDENT 0.0
.IP \(bu 2
\fI\%state.highstate\fP (or \fI\%state.apply\fP with no state argument)
.IP \(bu 2
\fI\%saltutil.sync_modules\fP
.IP \(bu 2
\fI\%saltutil.sync_all\fP
.UNINDENT
.sp
Modules placed in \fB_modules/\fP will be synced to masters when any of the
following Salt runners are called:
.INDENT 0.0
.IP \(bu 2
\fI\%saltutil.sync_modules\fP
.IP \(bu 2
\fI\%saltutil.sync_all\fP
.UNINDENT
.sp
Note that a module\(aqs default name is its filename
(i.e. \fBfoo.py\fP becomes module \fBfoo\fP), but that its name can be overridden
by using a \fI\%__virtual__ function\fP\&.
.sp
If a Salt module has errors and cannot be imported, the Salt minion will continue
to load without issue and the module with errors will simply be omitted.
.sp
If adding a Cython module the file must be named \fB<modulename>.pyx\fP so that
the loader knows that the module needs to be imported as a Cython module. The
compilation of the Cython module is automatic and happens when the minion
starts, so only the \fB*.pyx\fP file is required.
.SS Zip Archives as Modules
.sp
Python 2.3 and higher allows developers to directly import zip archives
containing Python code. By setting \fI\%enable_zip_modules\fP to
\fBTrue\fP in the minion config, the Salt loader will be able to import \fB\&.zip\fP
files in this fashion. This allows Salt module developers to package
dependencies with their modules for ease of deployment, isolation, etc.
.sp
For a user, Zip Archive modules behave just like other modules.  When executing
a function from a module provided as the file \fBmy_module.zip\fP, a user would
call a function within that module as \fBmy_module.<function>\fP\&.
.SS Creating a Zip Archive Module
.sp
A Zip Archive module is structured similarly to a simple \fI\%Python package\fP\&.
The \fB\&.zip\fP file contains a single directory with the same name as the module.
The module code traditionally in \fB<module_name>.py\fP goes in
\fB<module_name>/__init__.py\fP\&.  The dependency packages are subdirectories of
\fB<module_name>/\fP\&.
.sp
Here is an example directory structure for the \fBlumberjack\fP module, which has
two library dependencies (\fBsleep\fP and \fBwork\fP) to be included.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
modules $ ls \-R lumberjack
__init__.py     sleep           work

lumberjack/sleep:
__init__.py

lumberjack/work:
__init__.py
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The contents of \fBlumberjack/__init__.py\fP show how to import and use these
included libraries.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Libraries included in lumberjack.zip
from lumberjack import sleep, work


def is_ok(person):
    \(dq\(dq\(dqChecks whether a person is really a lumberjack\(dq\(dq\(dq
    return sleep.all_night(person) and work.all_day(person)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then, create the zip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
modules $ zip \-r lumberjack lumberjack
  adding: lumberjack/ (stored 0%)
  adding: lumberjack/__init__.py (deflated 39%)
  adding: lumberjack/sleep/ (stored 0%)
  adding: lumberjack/sleep/__init__.py (deflated 7%)
  adding: lumberjack/work/ (stored 0%)
  adding: lumberjack/work/__init__.py (deflated 7%)
modules $ unzip \-l lumberjack.zip
Archive:  lumberjack.zip
  Length     Date   Time    Name
 \-\-\-\-\-\-\-\-    \-\-\-\-   \-\-\-\-    \-\-\-\-
        0  08\-21\-15 20:08   lumberjack/
      348  08\-21\-15 20:08   lumberjack/__init__.py
        0  08\-21\-15 19:53   lumberjack/sleep/
       83  08\-21\-15 19:53   lumberjack/sleep/__init__.py
        0  08\-21\-15 19:53   lumberjack/work/
       81  08\-21\-15 19:21   lumberjack/work/__init__.py
 \-\-\-\-\-\-\-\-                   \-\-\-\-\-\-\-
      512                   6 files
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once placed in \fI\%file_roots\fP, Salt users can distribute and use
\fBlumberjack.zip\fP like any other module.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt minion1 saltutil.sync_modules
minion1:
  \- modules.lumberjack
$ sudo salt minion1 lumberjack.is_ok \(aqMichael Palin\(aq
minion1:
  True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Cross Calling Execution Modules
.sp
All of the Salt execution modules are available to each other and modules can
call functions available in other execution modules.
.sp
The variable \fB__salt__\fP is packed into the modules after they are loaded into
the Salt minion.
.sp
The \fB__salt__\fP variable is a \fI\%Python dictionary\fP
containing all of the Salt functions. Dictionary keys are strings representing
the names of the modules and the values are the functions themselves.
.sp
Salt modules can be cross\-called by accessing the value in the \fB__salt__\fP
dict:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def foo(bar):
    return __salt__[\(dqcmd.run\(dq](bar)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This code will call the \fIrun\fP function in the \fI\%cmd\fP
module and pass the argument \fBbar\fP to it.
.SS Calling Execution Modules on the Salt Master
.sp
New in version 2016.11.0.

.sp
Execution modules can now also be called via the \fBsalt\-run\fP command
using the \fI\%salt runner\fP\&.
.SS Preloaded Execution Module Data
.sp
When interacting with execution modules often it is nice to be able to read
information dynamically about the minion or to load in configuration parameters
for a module.
.sp
Salt allows for different types of data to be loaded into the modules by the
minion.
.SS Grains Data
.sp
The values detected by the Salt Grains on the minion are available in a
\fI\%Python dictionary\fP named \fB__grains__\fP and can be
accessed from within callable objects in the Python modules.
.sp
To see the contents of the grains dictionary for a given system in your
deployment run the \fBgrains.items()\fP function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqhostname\(aq grains.items \-\-output=pprint
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Any value in a grains dictionary can be accessed as any other Python
dictionary. For example, the grain representing the minion ID is stored in the
\fBid\fP key and from an execution module, the value would be stored in
\fB__grains__[\(aqid\(aq]\fP\&.
.SS Module Configuration
.sp
Since parameters for configuring a module may be desired, Salt allows for
configuration information from the  minion configuration file to be passed to
execution modules.
.sp
Since the minion configuration file is a YAML document, arbitrary configuration
data can be passed in the minion config that is read by the modules. It is
therefore \fBstrongly\fP recommended that the values passed in the configuration
file match the module name. A value intended for the \fBtest\fP execution module
should be named \fBtest.<value>\fP\&.
.sp
The test execution module contains usage of the module configuration and the
default configuration file for the minion contains the information and format
used to pass data to the modules. \fI\%salt.modules.test\fP,
\fBconf/minion\fP\&.
.SS \fB__init__\fP Function
.sp
If you want your module to have different execution modes based on minion
configuration, you can use the \fB__init__(opts)\fP function to perform initial
module setup. The parameter \fBopts\fP is the complete minion configuration,
as also available in the \fB__opts__\fP dict.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(dq\(dq\(dq
Cheese module initialization example
\(dq\(dq\(dq


def __init__(opts):
    \(dq\(dq\(dq
    Allow foreign imports if configured to do so
    \(dq\(dq\(dq
    if opts.get(\(dqcheese.allow_foreign\(dq, False):
        _enable_foreign_products()
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Strings and Unicode
.sp
An execution  module author should always assume that strings fed to the module
have already decoded from strings into Unicode. In Python 2, these will
be of type \(aqUnicode\(aq and in Python 3 they will be of type \fBstr\fP\&. Calling
from a state to other Salt sub\-systems, should pass Unicode (or bytes if passing binary data). In the
rare event that a state needs to write directly to disk, Unicode should be
encoded to a string immediately before writing to disk. An author may use
\fB__salt_system_encoding__\fP to learn what the encoding type of the system is.
For example, \fI\(aqmy_string\(aq.encode(__salt_system_encoding__\(aq)\fP\&.
.SS Outputter Configuration
.sp
Since execution module functions can return different data, and the way the
data is printed can greatly change the presentation, Salt allows for a specific
outputter to be set on a function\-by\-function basis.
.sp
This is done be declaring an \fB__outputter__\fP dictionary in the global scope
of the module.  The \fB__outputter__\fP dictionary contains a mapping of function
names to Salt \fI\%outputters\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__outputter__ = {\(dqrun\(dq: \(dqtxt\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will ensure that the \fBtxt\fP outputter is used to display output from the
\fBrun\fP function.
.SS Virtual Modules
.sp
Virtual modules let you override the name of a module in order to use the same
name to refer to one of several similar modules. The specific module that is
loaded for a virtual name is selected based on the current platform or
environment.
.sp
For example, packages are managed across platforms using the \fBpkg\fP module.
\fBpkg\fP is a virtual module name that is an alias for the specific package
manager module that is loaded on a specific system (for example, \fI\%yumpkg\fP on RHEL/CentOS systems , and \fI\%aptpkg\fP on Ubuntu).
.sp
Virtual module names are set using the \fB__virtual__\fP function and the
\fI\%virtual name\fP\&.
.SS \fB__virtual__\fP Function
.sp
The \fB__virtual__\fP function returns either a \fI\%string\fP,
\fI\%True\fP, \fI\%False\fP, or \fI\%False\fP with an \fI\%error
string\fP\&. If a string is returned then the module is loaded
using the name of the string as the virtual name. If \fBTrue\fP is returned the
module is loaded using the current module name. If \fBFalse\fP is returned the
module is not loaded. \fBFalse\fP lets the module perform system checks and
prevent loading if dependencies are not met.
.sp
Since \fB__virtual__\fP is called before the module is loaded, \fB__salt__\fP will
be unreliable as not all modules will be available at this point in time. The
\fB__pillar__\fP and \fB__grains__\fP \fI\%\(dqdunder\(dq dictionaries\fP
are available however.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Modules which return a string from \fB__virtual__\fP that is already used by
a module that ships with Salt will _override_ the stock module.
.UNINDENT
.UNINDENT
.SS Returning Error Information from \fB__virtual__\fP
.sp
Optionally, Salt plugin modules, such as execution, state, returner, beacon,
etc. modules may additionally return a string containing the reason that a
module could not be loaded.  For example, an execution module called \fBcheese\fP
and a corresponding state module also called \fBcheese\fP, both depending on a
utility called \fBenzymes\fP should have \fB__virtual__\fP functions that handle
the case when the dependency is unavailable.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(dq\(dq\(dq
Cheese execution (or returner/beacon/etc.) module
\(dq\(dq\(dq

try:
    import enzymes

    HAS_ENZYMES = True
except ImportError:
    HAS_ENZYMES = False


def __virtual__():
    \(dq\(dq\(dq
    only load cheese if enzymes are available
    \(dq\(dq\(dq
    if HAS_ENZYMES:
        return \(dqcheese\(dq
    else:
        return (
            False,
            \(dqThe cheese execution module cannot be loaded: enzymes unavailable.\(dq,
        )


def slice():
    pass
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(dq\(dq\(dq
Cheese state module. Note that this works in state modules because it is
guaranteed that execution modules are loaded first
\(dq\(dq\(dq


def __virtual__():
    \(dq\(dq\(dq
    only load cheese if enzymes are available
    \(dq\(dq\(dq
    # predicate loading of the cheese state on the corresponding execution module
    if \(dqcheese.slice\(dq in __salt__:
        return \(dqcheese\(dq
    else:
        return False, \(dqThe cheese state module cannot be loaded: enzymes unavailable.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Examples
.sp
The package manager modules are among the best examples of using the
\fB__virtual__\fP function. A table of all the virtual \fBpkg\fP modules can be
found \fI\%here\fP\&.
.SS Overriding Virtual Module Providers
.sp
Salt often uses OS grains (\fBos\fP, \fBosrelease\fP, \fBos_family\fP, etc.) to
determine which module should be loaded as the virtual module for \fBpkg\fP,
\fBservice\fP, etc. Sometimes this OS detection is incomplete, with new distros
popping up, existing distros changing init systems, etc. The virtual modules
likely to be affected by this are in the list below (click each item for more
information):
.INDENT 0.0
.IP \(bu 2
\fI\%pkg\fP
.IP \(bu 2
\fI\%service\fP
.IP \(bu 2
\fI\%user\fP
.IP \(bu 2
\fI\%shadow\fP
.IP \(bu 2
\fI\%group\fP
.UNINDENT
.sp
If Salt is using the wrong module for one of these, first of all, please
\fI\%report it on the issue tracker\fP, so that this issue can be resolved for a
future release. To make it easier to troubleshoot, please also provide the
\fI\%grains.items\fP output, taking care to
redact any sensitive information.
.sp
Then, while waiting for the SaltStack development team to fix the issue, Salt
can be made to use the correct module using the \fI\%providers\fP option
in the minion config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
providers:
  service: systemd
  pkg: aptpkg
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above example will force the minion to use the \fBsystemd\fP module to provide service management, and the
\fI\%aptpkg\fP module to provide package management.
.sp
For per\-state provider overrides, see documentation on \fI\%state providers\fP\&.
.SS Logging Restrictions
.sp
As a rule, logging should not be done anywhere in a Salt module before it is
loaded. This rule apples to all code that would run before the \fB__virtual__()\fP
function, as well as the code within the \fB__virtual__()\fP function itself.
.sp
If logging statements are made before the virtual function determines if
the module should be loaded, then those logging statements will be called
repeatedly. This clutters up log files unnecessarily.
.sp
Exceptions may be considered for logging statements made at the \fBtrace\fP level.
However, it is better to provide the necessary information by another means.
One method is to \fI\%return error information\fP in the
\fB__virtual__()\fP function.
.SS \fB__virtualname__\fP
.sp
\fB__virtualname__\fP is a variable that is used by the documentation build
system to know the virtual name of a module without calling the \fB__virtual__\fP
function. Modules that return a string from the \fB__virtual__\fP function
must also set the \fB__virtualname__\fP variable.
.sp
To avoid setting the virtual name string twice, you can implement
\fB__virtual__\fP to return the value set for \fB__virtualname__\fP using a pattern
similar to the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Define the module\(aqs virtual name
__virtualname__ = \(dqpkg\(dq


def __virtual__():
    \(dq\(dq\(dq
    Confine this module to Mac OS with Homebrew.
    \(dq\(dq\(dq

    if salt.utils.path.which(\(dqbrew\(dq) and __grains__[\(dqos\(dq] == \(dqMacOS\(dq:
        return __virtualname__
    return False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fB__virtual__()\fP function can return a \fBTrue\fP or \fBFalse\fP boolean, a tuple,
or a string. If it returns a \fBTrue\fP value, this \fB__virtualname__\fP module\-level
attribute can be set as seen in the above example. This is the string that the module
should be referred to as.
.sp
When \fB__virtual__()\fP returns a tuple, the first item should be a boolean and the
second should be a string. This is typically done when the module should not load. The
first value of the tuple is \fBFalse\fP and the second is the error message to display
for why the module did not load.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def __virtual__():
    \(dq\(dq\(dq
    Only load if git exists on the system
    \(dq\(dq\(dq
    if salt.utils.path.which(\(dqgit\(dq) is None:
        return (False, \(dqThe git execution module cannot be loaded: git unavailable.\(dq)
    else:
        return True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Documentation
.sp
Salt execution modules are documented. The \fBsys.doc()\fP function will return
the documentation for all available modules:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.doc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBsys.doc\fP function simply prints out the docstrings found in the modules;
when writing Salt execution modules, please follow the formatting conventions
for docstrings as they appear in the other modules.
.SS Adding Documentation to Salt Modules
.sp
It is strongly suggested that all Salt modules have documentation added.
.sp
To add documentation add a \fI\%Python docstring\fP to the function.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def spam(eggs):
    \(dq\(dq\(dq
    A function to make some spam with eggs!

    CLI Example::

        salt \(aq*\(aq test.spam eggs
    \(dq\(dq\(dq
    return eggs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now when the sys.doc call is executed the docstring will be cleanly returned
to the calling terminal.
.sp
Documentation added to execution modules in docstrings will automatically be
added to the online web\-based documentation.
.SS Add Execution Module Metadata
.sp
When writing a Python docstring for an execution module, add information about
the module using the following field lists:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
:maintainer:    Thomas Hatch <thatch@saltstack.com, Seth House <shouse@saltstack.com>
:maturity:      new
:depends:       python\-mysqldb
:platform:      all
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The maintainer field is a comma\-delimited list of developers who help maintain
this module.
.sp
The maturity field indicates the level of quality and testing for this module.
Standard labels will be determined.
.sp
The depends field is a comma\-delimited list of modules that this module depends
on.
.sp
The platform field is a comma\-delimited list of platforms that this module is
known to run on.
.SS Log Output
.sp
You can call the logger from custom modules to write messages to the minion
logs. The following code snippet demonstrates writing log messages:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import logging

log = logging.getLogger(__name__)

log.info(\(dqHere is Some Information\(dq)
log.warning(\(dqYou Should Not Do That\(dq)
log.error(\(dqIt Is Busted\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Aliasing Functions
.sp
Sometimes one wishes to use a function name that would shadow a python built\-in.
A common example would be \fBset()\fP\&. To support this, append an underscore to
the function definition, \fBdef set_():\fP, and use the \fB__func_alias__\fP feature
to provide an alias to the function.
.sp
\fB__func_alias__\fP is a dictionary where each key is the name of a function in
the module, and each value is a string representing the alias for that function.
When calling an aliased function from a different execution module, state
module, or from the cli, the alias name should be used.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__func_alias__ = {
    \(dqset_\(dq: \(dqset\(dq,
    \(dqlist_\(dq: \(dqlist\(dq,
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Private Functions
.sp
In Salt, Python callable objects contained within an execution module are made
available to the Salt minion for use. The only exception to this rule is a
callable object with a name starting with an underscore \fB_\fP\&.
.SS Objects Loaded Into the Salt Minion
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def foo(bar):
    return bar
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Objects NOT Loaded into the Salt Minion
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def _foobar(baz):  # Preceded with an _
    return baz


cheese = {}  # Not a callable Python object
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Useful Decorators for Modules
.SS Depends Decorator
.sp
When writing execution modules there are many times where some of the module
will work on all hosts but some functions have an external dependency, such as
a service that needs to be installed or a binary that needs to be present on
the system.
.sp
Instead of trying to wrap much of the code in large try/except blocks, a
decorator can be used.
.sp
If the dependencies passed to the decorator don\(aqt exist, then the salt minion
will remove those functions from the module on that host.
.sp
If a \fBfallback_function\fP is defined, it will replace the function instead of
removing it
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import logging

from salt.utils.decorators import depends

log = logging.getLogger(__name__)

try:
    import dependency_that_sometimes_exists
except ImportError as e:
    log.trace(\(dqFailed to import dependency_that_sometimes_exists: {0}\(dq.format(e))


@depends(\(dqdependency_that_sometimes_exists\(dq)
def foo():
    \(dq\(dq\(dq
    Function with a dependency on the \(dqdependency_that_sometimes_exists\(dq module,
    if the \(dqdependency_that_sometimes_exists\(dq is missing this function will not exist
    \(dq\(dq\(dq
    return True


def _fallback():
    \(dq\(dq\(dq
    Fallback function for the depends decorator to replace a function with
    \(dq\(dq\(dq
    return \(aq\(dqdependency_that_sometimes_exists\(dq needs to be installed for this function to exist\(aq


@depends(\(dqdependency_that_sometimes_exists\(dq, fallback_function=_fallback)
def foo():
    \(dq\(dq\(dq
    Function with a dependency on the \(dqdependency_that_sometimes_exists\(dq module.
    If the \(dqdependency_that_sometimes_exists\(dq is missing this function will be
    replaced with \(dq_fallback\(dq
    \(dq\(dq\(dq
    return True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In addition to global dependencies the depends decorator also supports raw
booleans.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from salt.utils.decorators import depends

HAS_DEP = False
try:
    import dependency_that_sometimes_exists

    HAS_DEP = True
except ImportError:
    pass


@depends(HAS_DEP)
def foo():
    return True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Returners
.sp
By default the return values of the commands sent to the Salt minions are
returned to the Salt master, however anything at all can be done with the results
data.
.sp
By using a Salt returner, results data can be redirected to external data\-stores
for analysis and archival.
.sp
Returners pull their configuration values from the Salt minions. Returners are only
configured once, which is generally at load time.
.sp
The returner interface allows the return data to be sent to any system that
can receive data. This means that return data can be sent to a Redis server,
a MongoDB server, a MySQL server, or any system.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Full list of builtin returners\fP
.UNINDENT
.UNINDENT
.SS Using Returners
.sp
All Salt commands will return the command data back to the master. Specifying
returners will ensure that the data is _also_ sent to the specified returner
interfaces.
.sp
Specifying what returners to use is done when the command is invoked:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.version \-\-return redis_return
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This command will ensure that the redis_return returner is used.
.sp
It is also possible to specify multiple returners:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.version \-\-return mongo_return,redis_return,cassandra_return
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this scenario all three returners will be called and the data from the
test.version command will be sent out to the three named returners.
.SS Writing a Returner
.sp
Returners are Salt modules that allow the redirection of results data to targets other than the Salt Master.
.SS Returners Are Easy To Write!
.sp
Writing a Salt returner is straightforward.
.sp
A returner is a Python module containing at minimum a \fBreturner\fP function.
Other optional functions can be included to add support for
\fI\%master_job_cache\fP, \fI\%Storing Job Results in an External System\fP, and \fI\%Event Returners\fP\&.
.INDENT 0.0
.TP
.B \fBreturner\fP
The \fBreturner\fP function must accept a single argument. The argument
contains return data from the called minion function. If the minion
function \fBtest.version\fP is called, the value of the argument will be a
dictionary. Run the following command from a Salt master to get a sample
of the dictionary:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local \-\-metadata test.version \-\-out=pprint
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import redis
import salt.utils.json


def returner(ret):
    \(dq\(dq\(dq
    Return information to a redis server
    \(dq\(dq\(dq
    # Get a redis connection
    serv = redis.Redis(host=\(dqredis\-serv.example.com\(dq, port=6379, db=\(dq0\(dq)
    serv.sadd(\(dq%(id)s:jobs\(dq % ret, ret[\(dqjid\(dq])
    serv.set(\(dq%(jid)s:%(id)s\(dq % ret, salt.utils.json.dumps(ret[\(dqreturn\(dq]))
    serv.sadd(\(dqjobs\(dq, ret[\(dqjid\(dq])
    serv.sadd(ret[\(dqjid\(dq], ret[\(dqid\(dq])
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above example of a returner set to send the data to a Redis server
serializes the data as JSON and sets it in redis.
.SS Using Custom Returner Modules
.sp
Place custom returners in a \fB_returners/\fP directory within the
\fI\%file_roots\fP specified by the master config file.
.sp
Like all custom modules, these must be synced to the relevant master or minion
before they can be used. See \fI\%Modular Systems\fP for details.
.sp
Any custom returners which have been synced to a minion that are named the
same as one of Salt\(aqs default set of returners will take the place of the
default returner with the same name.
.SS Naming the Returner
.sp
Note that a returner\(aqs default name is its filename (i.e. \fBfoo.py\fP becomes
returner \fBfoo\fP), but that its name can be overridden by using a
\fI\%__virtual__ function\fP\&. A good example of this can be
found in the \fI\%redis\fP returner, which is named \fBredis_return.py\fP but is
loaded as simply \fBredis\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
try:
    import redis

    HAS_REDIS = True
except ImportError:
    HAS_REDIS = False

__virtualname__ = \(dqredis\(dq


def __virtual__():
    if not HAS_REDIS:
        return False
    return __virtualname__
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Master Job Cache Support
.sp
\fI\%master_job_cache\fP, \fI\%Storing Job Results in an External System\fP, and \fI\%Event Returners\fP\&.
Salt\(aqs \fI\%master_job_cache\fP allows returners to be used as a pluggable
replacement for the \fI\%Default Job Cache\fP\&. In order to do so, a returner
must implement the following functions:
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The code samples contained in this section were taken from the cassandra_cql
returner.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \fBprep_jid\fP
Ensures that job ids (jid) don\(aqt collide, unless passed_jid is provided.
.sp
\fBnocache\fP is an optional boolean that indicates if return data
should be cached. \fBpassed_jid\fP is a caller provided jid which should be
returned unconditionally.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def prep_jid(nocache, passed_jid=None):  # pylint: disable=unused\-argument
    \(dq\(dq\(dq
    Do any work necessary to prepare a JID, including sending a custom id
    \(dq\(dq\(dq
    return passed_jid if passed_jid is not None else salt.utils.jid.gen_jid()
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \fBsave_load\fP
Save job information.  The \fBjid\fP is generated by \fBprep_jid\fP and should
be considered a unique identifier for the job. The jid, for example, could
be used as the primary/unique key in a database. The \fBload\fP is what is
returned to a Salt master by a minion. \fBminions\fP is a list of minions
that the job was run against. The following code example stores the load as
a JSON string in the salt.jids table.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.utils.json


def save_load(jid, load, minions=None):
    \(dq\(dq\(dq
    Save the load to the specified jid id
    \(dq\(dq\(dq
    query = \(dq\(dq\(dqINSERT INTO salt.jids (
                 jid, load
               ) VALUES (
                 \(aq{0}\(aq, \(aq{1}\(aq
               );\(dq\(dq\(dq.format(
        jid, salt.utils.json.dumps(load)
    )

    # cassandra_cql.cql_query may raise a CommandExecutionError
    try:
        __salt__[\(dqcassandra_cql.cql_query\(dq](query)
    except CommandExecutionError:
        log.critical(\(dqCould not save load in jids table.\(dq)
        raise
    except Exception as e:
        log.critical(\(dqUnexpected error while inserting into jids: {0}\(dq.format(e))
        raise
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \fBget_load\fP
must accept a job id (jid) and return the job load stored by \fBsave_load\fP,
or an empty dictionary when not found.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def get_load(jid):
    \(dq\(dq\(dq
    Return the load data that marks a specified jid
    \(dq\(dq\(dq
    query = \(dq\(dq\(dqSELECT load FROM salt.jids WHERE jid = \(aq{0}\(aq;\(dq\(dq\(dq.format(jid)

    ret = {}

    # cassandra_cql.cql_query may raise a CommandExecutionError
    try:
        data = __salt__[\(dqcassandra_cql.cql_query\(dq](query)
        if data:
            load = data[0].get(\(dqload\(dq)
            if load:
                ret = json.loads(load)
    except CommandExecutionError:
        log.critical(\(dqCould not get load from jids table.\(dq)
        raise
    except Exception as e:
        log.critical(
            \(dq\(dq\(dqUnexpected error while getting load from
         jids: {0}\(dq\(dq\(dq.format(
                str(e)
            )
        )
        raise

    return ret
.ft P
.fi
.UNINDENT
.UNINDENT
.SS External Job Cache Support
.sp
Salt\(aqs \fI\%Storing Job Results in an External System\fP extends the \fI\%master_job_cache\fP\&. External
Job Cache support requires the following functions in addition to what is
required for Master Job Cache support:
.INDENT 0.0
.TP
.B \fBget_jid\fP
Return a dictionary containing the information (load) returned by each
minion when the specified job id was executed.
.UNINDENT
.sp
Sample:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqlocal\(dq: {
        \(dqmaster_minion\(dq: {
            \(dqfun_args\(dq: [],
            \(dqjid\(dq: \(dq20150330121011408195\(dq,
            \(dqreturn\(dq: \(dq2018.3.4\(dq,
            \(dqretcode\(dq: 0,
            \(dqsuccess\(dq: true,
            \(dqcmd\(dq: \(dq_return\(dq,
            \(dq_stamp\(dq: \(dq2015\-03\-30T12:10:12.708663\(dq,
            \(dqfun\(dq: \(dqtest.version\(dq,
            \(dqid\(dq: \(dqmaster_minion\(dq
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \fBget_fun\fP
Return a dictionary of minions that called a given Salt function as their
last function call.
.UNINDENT
.sp
Sample:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqlocal\(dq: {
        \(dqminion1\(dq: \(dqtest.version\(dq,
        \(dqminion3\(dq: \(dqtest.version\(dq,
        \(dqminion2\(dq: \(dqtest.version\(dq
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \fBget_jids\fP
Return a list of all job ids.
.UNINDENT
.sp
Sample:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqlocal\(dq: [
        \(dq20150330121011408195\(dq,
        \(dq20150330195922139916\(dq
    ]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \fBget_minions\fP
Returns a list of minions
.UNINDENT
.sp
Sample:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
     \(dqlocal\(dq: [
         \(dqminion3\(dq,
         \(dqminion2\(dq,
         \(dqminion1\(dq,
         \(dqmaster_minion\(dq
     ]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Please refer to one or more of the existing returners (i.e. mysql,
cassandra_cql) if you need further clarification.
.SS Event Support
.sp
An \fBevent_return\fP function must be added to the returner module to allow
events to be logged from a master via the returner. A list of events are passed
to the function by the master.
.sp
The following example was taken from the MySQL returner. In this example, each
event is inserted into the salt_events table keyed on the event tag. The tag
contains the jid and therefore is guaranteed to be unique.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.utils.json


def event_return(events):
    \(dq\(dq\(dq
    Return event to mysql server

    Requires that configuration be enabled via \(aqevent_return\(aq
    option in master config.
    \(dq\(dq\(dq
    with _get_serv(events, commit=True) as cur:
        for event in events:
            tag = event.get(\(dqtag\(dq, \(dq\(dq)
            data = event.get(\(dqdata\(dq, \(dq\(dq)
            sql = \(dq\(dq\(dqINSERT INTO \(gasalt_events\(ga (\(gatag\(ga, \(gadata\(ga, \(gamaster_id\(ga )
                  VALUES (%s, %s, %s)\(dq\(dq\(dq
            cur.execute(sql, (tag, salt.utils.json.dumps(data), __opts__[\(dqid\(dq]))
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Testing the Returner
.sp
The \fBreturner\fP, \fBprep_jid\fP, \fBsave_load\fP, \fBget_load\fP, and
\fBevent_return\fP functions can be tested by configuring the
\fI\%master_job_cache\fP and \fI\%Event Returners\fP in the master config
file and submitting a job to \fBtest.version\fP each minion from the master.
.sp
Once you have successfully exercised the Master Job Cache functions, test the
External Job Cache functions using the \fBret\fP execution module.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ret.get_jids cassandra_cql \-\-output=json
salt\-call ret.get_fun cassandra_cql test.version \-\-output=json
salt\-call ret.get_minions cassandra_cql \-\-output=json
salt\-call ret.get_jid cassandra_cql 20150330121011408195 \-\-output=json
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Event Returners
.sp
For maximum visibility into the history of events across a Salt
infrastructure, all events seen by a salt master may be logged to one or
more returners.
.sp
To enable event logging, set the \fBevent_return\fP configuration option in the
master config to the returner(s) which should be designated as the handler
for event returns.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Not all returners support event returns. Verify a returner has an
\fBevent_return()\fP function before using.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
On larger installations, many hundreds of events may be generated on a
busy master every second. Be certain to closely monitor the storage of
a given returner as Salt can easily overwhelm an underpowered server
with thousands of returns.
.UNINDENT
.UNINDENT
.SS Full List of Returners
.SS returner modules
.TS
center;
|l|l|.
_
T{
\fI\%appoptics_return\fP
T}	T{
Salt returner to return highstate stats to AppOptics Metrics
T}
_
T{
\fI\%carbon_return\fP
T}	T{
Take data from salt and \(dqreturn\(dq it into a carbon receiver
T}
_
T{
\fI\%cassandra_cql_return\fP
T}	T{
Return data to a cassandra server
T}
_
T{
\fI\%couchbase_return\fP
T}	T{
Simple returner for Couchbase.
T}
_
T{
\fI\%couchdb_return\fP
T}	T{
Simple returner for CouchDB.
T}
_
T{
\fI\%elasticsearch_return\fP
T}	T{
Return data to an elasticsearch server for indexing.
T}
_
T{
\fI\%etcd_return\fP
T}	T{
Return data to an etcd server or cluster
T}
_
T{
\fI\%highstate_return\fP
T}	T{
Return the results of a highstate (or any other state function that returns data in a compatible format) via an HTML email or HTML file.
T}
_
T{
\fI\%influxdb_return\fP
T}	T{
Return data to an influxdb server.
T}
_
T{
\fI\%kafka_return\fP
T}	T{
Return data to a Kafka topic
T}
_
T{
\fI\%librato_return\fP
T}	T{
Salt returner to return highstate stats to Librato
T}
_
T{
\fI\%local\fP
T}	T{
The local returner is used to test the returner interface, it just prints the return data to the console to verify that it is being passed properly
T}
_
T{
\fI\%local_cache\fP
T}	T{
Return data to local job cache
T}
_
T{
\fI\%mattermost_returner\fP
T}	T{
Return salt data via mattermost
T}
_
T{
\fI\%memcache_return\fP
T}	T{
Return data to a memcache server
T}
_
T{
\fI\%mongo_future_return\fP
T}	T{
Return data to a mongodb server
T}
_
T{
\fI\%mongo_return\fP
T}	T{
Return data to a mongodb server
T}
_
T{
\fI\%multi_returner\fP
T}	T{
Read/Write multiple returners
T}
_
T{
\fI\%mysql\fP
T}	T{
Return data to a mysql server
T}
_
T{
\fI\%nagios_nrdp_return\fP
T}	T{
Return salt data to Nagios
T}
_
T{
\fI\%odbc\fP
T}	T{
Return data to an ODBC compliant server.
T}
_
T{
\fI\%pgjsonb\fP
T}	T{
Return data to a PostgreSQL server with json data stored in Pg\(aqs jsonb data type
T}
_
T{
\fI\%postgres\fP
T}	T{
Return data to a postgresql server
T}
_
T{
\fI\%postgres_local_cache\fP
T}	T{
Use a postgresql server for the master job cache.
T}
_
T{
\fI\%pushover_returner\fP
T}	T{
T}
_
T{
\fI\%rawfile_json\fP
T}	T{
Take data from salt and \(dqreturn\(dq it into a raw file containing the json, with one line per event.
T}
_
T{
\fI\%redis_return\fP
T}	T{
Return data to a redis server
T}
_
T{
\fI\%sentry_return\fP
T}	T{
Salt returner that reports execution results back to sentry.
T}
_
T{
\fI\%slack_returner\fP
T}	T{
Return salt data via slack
T}
_
T{
\fI\%slack_webhook_return\fP
T}	T{
Return salt data via Slack using Incoming Webhooks
T}
_
T{
\fI\%sms_return\fP
T}	T{
Return data by SMS.
T}
_
T{
\fI\%smtp_return\fP
T}	T{
Return salt data via email
T}
_
T{
\fI\%splunk\fP
T}	T{
Send json response data to Splunk via the HTTP Event Collector Requires the following config values to be specified in config or pillar:
T}
_
T{
\fI\%sqlite3_return\fP
T}	T{
Insert minion return data into a sqlite3 database
T}
_
T{
\fI\%syslog_return\fP
T}	T{
Return data to the host operating system\(aqs syslog facility
T}
_
T{
\fI\%telegram_return\fP
T}	T{
Return salt data via Telegram.
T}
_
T{
\fI\%xmpp_return\fP
T}	T{
Return salt data via xmpp
T}
_
T{
\fI\%zabbix_return\fP
T}	T{
T}
_
.TE
.SS salt.returners.appoptics_return
.sp
Salt returner to return highstate stats to AppOptics Metrics
.sp
To enable this returner the minion will need the AppOptics Metrics
client importable on the Python path and the following
values configured in the minion or master config.
.sp
The AppOptics python client can be found at:
.sp
\fI\%https://github.com/appoptics/python\-appoptics\-metrics\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
appoptics.api_token: abc12345def
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
An example configuration that returns the total number of successes
and failures for your salt highstate runs (the default) would look
like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
return: appoptics
appoptics.api_token: <token string here>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The returner publishes the following metrics to AppOptics:
.INDENT 0.0
.IP \(bu 2
saltstack.failed
.IP \(bu 2
saltstack.passed
.IP \(bu 2
saltstack.retcode
.IP \(bu 2
saltstack.runtime
.IP \(bu 2
saltstack.total
.UNINDENT
.sp
You can add a tags section to specify which tags should be attached to
all metrics created by the returner.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
appoptics.tags:
  host_hostname_alias: <the minion ID \- matches @host>
  tier: <the tier/etc. of this node>
  cluster: <the cluster name, etc.>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If no tags are explicitly configured, then the tag key \fBhost_hostname_alias\fP
will be set, with the minion\(aqs \fBid\fP grain being the value.
.sp
In addition to the requested tags, for a highstate run each of these
will be tagged with the \fBkey:value\fP of \fBstate_type: highstate\fP\&.
.sp
In order to return metrics for \fBstate.sls\fP runs (distinct from highstates), you can
specify a list of state names to the key \fBappoptics.sls_states\fP like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
appoptics.sls_states:
  \- role_salt_master.netapi
  \- role_redis.config
  \- role_smarty.dummy
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will report success and failure counts on runs of the
\fBrole_salt_master.netapi\fP, \fBrole_redis.config\fP, and
\fBrole_smarty.dummy\fP states in addition to highstates.
.sp
This will report the same metrics as above, but for these runs the
metrics will be tagged with \fBstate_type: sls\fP and \fBstate_name\fP set to
the name of the state that was invoked, e.g. \fBrole_salt_master.netapi\fP\&.
.INDENT 0.0
.TP
.B salt.returners.appoptics_return.returner(ret)
Parse the return data and return metrics to AppOptics.
.sp
For each state that\(aqs provided in the configuration, return tagged metrics for
the result of that state if it\(aqs present.
.UNINDENT
.SS salt.returners.carbon_return
.sp
Take data from salt and \(dqreturn\(dq it into a carbon receiver
.sp
Add the following configuration to the minion configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
carbon.host: <server ip address>
carbon.port: 2003
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Errors when trying to convert data to numbers may be ignored by setting
\fBcarbon.skip_on_error\fP to \fITrue\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
carbon.skip_on_error: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default, data will be sent to carbon using the plaintext protocol. To use
the pickle protocol, set \fBcarbon.mode\fP to \fBpickle\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
carbon.mode: pickle
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B You can also specify the pattern used for the metric base path (except for virt modules metrics):
carbon.metric_base_pattern: carbon.[minion_id].[module].[function]
.TP
.B These tokens can used :
[module]: salt module
[function]: salt function
[minion_id]: minion id
.TP
.B Default is :
carbon.metric_base_pattern: [module].[function].[minion_id]
.UNINDENT
.sp
Carbon settings may also be configured as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
carbon:
  host: <server IP or hostname>
  port: <carbon port>
  skip_on_error: True
  mode: (pickle|text)
  metric_base_pattern: <pattern> | [module].[function].[minion_id]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.carbon:
  host: <server IP or hostname>
  port: <carbon port>
  skip_on_error: True
  mode: (pickle|text)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the carbon returner, append \(aq\-\-return carbon\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return carbon
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return carbon \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return carbon \-\-return_kwargs \(aq{\(dqskip_on_error\(dq: False}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.carbon_return.event_return(events)
Return event data to remote carbon server
.sp
Provide a list of events to be stored in carbon
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.carbon_return.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.carbon_return.returner(ret)
Return data to a remote carbon server using the text metric protocol
.sp
Each metric will look like:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[module].[function].[minion_id].[metric path [...]].[metric name]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.returners.cassandra_cql_return
.sp
Return data to a cassandra server
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B maintainer
Corin Kochenower<\fI\%ckochenower@saltstack.com\fP>
.TP
.B maturity
new as of 2015.2
.TP
.B depends
salt.modules.cassandra_cql
.TP
.B depends
DataStax Python Driver for Apache Cassandra
\fI\%https://github.com/datastax/python\-driver\fP
pip install cassandra\-driver
.TP
.B platform
all
.TP
.B configuration
To enable this returner, the minion will need the DataStax Python Driver
for Apache Cassandra ( \fI\%https://github.com/datastax/python\-driver\fP )
installed and the following values configured in the minion or master
config. The list of cluster IPs must include at least one cassandra node
IP address. No assumption or default will be used for the cluster IPs.
The cluster IPs will be tried in the order listed. The port, username,
and password values shown below will be the assumed defaults if you do
not provide values.:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cassandra:
  cluster:
    \- 192.168.50.11
    \- 192.168.50.12
    \- 192.168.50.13
  port: 9042
  username: salt
  password: salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Use the following cassandra database schema:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
CREATE KEYSPACE IF NOT EXISTS salt
    WITH replication = {\(aqclass\(aq: \(aqSimpleStrategy\(aq, \(aqreplication_factor\(aq : 1};

CREATE USER IF NOT EXISTS salt WITH PASSWORD \(aqsalt\(aq NOSUPERUSER;

GRANT ALL ON KEYSPACE salt TO salt;

USE salt;

CREATE TABLE IF NOT EXISTS salt.salt_returns (
    jid text,
    minion_id text,
    fun text,
    alter_time timestamp,
    full_ret text,
    return text,
    success boolean,
    PRIMARY KEY (jid, minion_id, fun)
) WITH CLUSTERING ORDER BY (minion_id ASC, fun ASC);
CREATE INDEX IF NOT EXISTS salt_returns_minion_id ON salt.salt_returns (minion_id);
CREATE INDEX IF NOT EXISTS salt_returns_fun ON salt.salt_returns (fun);

CREATE TABLE IF NOT EXISTS salt.jids (
    jid text PRIMARY KEY,
    load text
);

CREATE TABLE IF NOT EXISTS salt.minions (
    minion_id text PRIMARY KEY,
    last_fun text
);
CREATE INDEX IF NOT EXISTS minions_last_fun ON salt.minions (last_fun);

CREATE TABLE IF NOT EXISTS salt.salt_events (
    id timeuuid,
    tag text,
    alter_time timestamp,
    data text,
    master_id text,
    PRIMARY KEY (id, tag)
) WITH CLUSTERING ORDER BY (tag ASC);
CREATE INDEX tag ON salt.salt_events (tag);
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Required python modules: cassandra\-driver
.sp
To use the cassandra returner, append \(aq\-\-return cassandra_cql\(aq to the salt command. ex:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return_cql cassandra
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note: if your Cassandra instance has not been tuned much you may benefit from
altering some timeouts in \fIcassandra.yaml\fP like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# How long the coordinator should wait for read operations to complete
read_request_timeout_in_ms: 5000
# How long the coordinator should wait for seq or index scans to complete
range_request_timeout_in_ms: 20000
# How long the coordinator should wait for writes to complete
write_request_timeout_in_ms: 20000
# How long the coordinator should wait for counter writes to complete
counter_write_request_timeout_in_ms: 10000
# How long a coordinator should continue to retry a CAS operation
# that contends with other proposals for the same row
cas_contention_timeout_in_ms: 5000
# How long the coordinator should wait for truncates to complete
# (This can be much longer, because unless auto_snapshot is disabled
# we need to flush first so we can snapshot before removing the data.)
truncate_request_timeout_in_ms: 60000
# The default timeout for other, miscellaneous operations
request_timeout_in_ms: 20000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As always, your mileage may vary and your Cassandra cluster may have different
needs.  SaltStack has seen situations where these timeouts can resolve
some stacktraces that appear to come from the Datastax Python driver.
.INDENT 0.0
.TP
.B salt.returners.cassandra_cql_return.event_return(events)
Return event to one of potentially many clustered cassandra nodes
.sp
Requires that configuration be enabled via \(aqevent_return\(aq
option in master config.
.sp
Cassandra does not support an auto\-increment feature due to the
highly inefficient nature of creating a monotonically increasing
number across all nodes in a distributed database. Each event
will be assigned a uuid by the connecting client.
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.cassandra_cql_return.get_fun(fun)
Return a dict of the last function called for all minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.cassandra_cql_return.get_jid(jid)
Return the information returned when the specified job id was executed
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.cassandra_cql_return.get_jids()
Return a list of all job ids
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.cassandra_cql_return.get_load(jid)
Return the load data that marks a specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.cassandra_cql_return.get_minions()
Return a list of minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.cassandra_cql_return.prep_jid(nocache, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.cassandra_cql_return.returner(ret)
Return data to one of potentially many clustered cassandra nodes
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.cassandra_cql_return.save_load(jid, load, minions=None)
Save the load to the specified jid id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.cassandra_cql_return.save_minions(jid, minions, syndic_id=None)
Included for API consistency
.UNINDENT
.SS salt.returners.couchbase_return
.sp
Simple returner for Couchbase. Optional configuration
settings are listed below, along with sane defaults.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
couchbase.host:   \(aqsalt\(aq
couchbase.port:   8091
couchbase.bucket: \(aqsalt\(aq
couchbase.ttl: 86400
couchbase.password: \(aqpassword\(aq
couchbase.skip_verify_views: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the couchbase returner, append \(aq\-\-return couchbase\(aq to the salt command. ex:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return couchbase
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return couchbase \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return couchbase \-\-return_kwargs \(aq{\(dqbucket\(dq: \(dqanother\-salt\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
All of the return data will be stored in documents as follows:
.SS JID
.sp
load: load obj
tgt_minions: list of minions targeted
nocache: should we not cache the return data
.SS JID/MINION_ID
.sp
return: return_data
full_ret: full load of job return
.INDENT 0.0
.TP
.B salt.returners.couchbase_return.get_jid(jid)
Return the information returned when the specified job id was executed
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchbase_return.get_jids()
Return a list of all job ids
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchbase_return.get_load(jid)
Return the load data that marks a specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchbase_return.prep_jid(nocache=False, passed_jid=None)
Return a job id and prepare the job id directory
This is the function responsible for making sure jids don\(aqt collide (unless
its passed a jid)
So do what you have to do to make sure that stays the case
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchbase_return.returner(load)
Return data to couchbase bucket
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchbase_return.save_load(jid, clear_load, minion=None)
Save the load to the specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchbase_return.save_minions(jid, minions, syndic_id=None)
Save/update the minion list for a given jid. The syndic_id argument is
included for API compatibility only.
.UNINDENT
.SS salt.returners.couchdb_return
.sp
Simple returner for CouchDB. Optional configuration
settings are listed below, along with sane defaults:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
couchdb.db: \(aqsalt\(aq
couchdb.url: \(aqhttp://salt:5984/\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.couchdb.db: \(aqsalt\(aq
alternative.couchdb.url: \(aqhttp://salt:5984/\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the couchdb returner, append \fB\-\-return couchdb\fP to the salt command. Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return couchdb
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \fB\-\-return_config alternative\fP to the salt command.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return couchdb \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return couchdb \-\-return_kwargs \(aq{\(dqdb\(dq: \(dqanother\-salt\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS On concurrent database access
.sp
As this returner creates a couchdb document with the salt job id as document id
and as only one document with a given id can exist in a given couchdb database,
it is advised for most setups that every minion be configured to write to it own
database (the value of \fBcouchdb.db\fP may be suffixed with the minion id),
otherwise multi\-minion targeting can lead to losing output:
.INDENT 0.0
.IP \(bu 2
the first returning minion is able to create a document in the database
.IP \(bu 2
other minions fail with \fB{\(aqerror\(aq: \(aqHTTP Error 409: Conflict\(aq}\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchdb_return.ensure_views()
This function makes sure that all the views that should
exist in the design document do exist.
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchdb_return.get_fun(fun)
Return a dict with key being minion and value
being the job details of the last run of function \(aqfun\(aq.
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchdb_return.get_jid(jid)
Get the document with a given JID.
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchdb_return.get_jids()
List all the jobs that we have..
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchdb_return.get_minions()
Return a list of minion identifiers from a request of the view.
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchdb_return.get_valid_salt_views()
Returns a dict object of views that should be
part of the salt design document.
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchdb_return.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchdb_return.returner(ret)
Take in the return and shove it into the couchdb database.
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchdb_return.save_minions(jid, minions, syndic_id=None)
Included for API consistency
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.couchdb_return.set_salt_view()
Helper function that sets the salt design
document. Uses get_valid_salt_views and some hardcoded values.
.UNINDENT
.SS salt.returners.elasticsearch_return
.sp
Return data to an elasticsearch server for indexing.
.INDENT 0.0
.TP
.B maintainer
Jurnell Cockhren <\fI\%jurnell.cockhren@sophicware.com\fP>, Arnold Bechtoldt <\fI\%mail@arnoldbechtoldt.com\fP>
.TP
.B maturity
New
.TP
.B depends
\fI\%elasticsearch\-py\fP
.TP
.B platform
all
.UNINDENT
.sp
To enable this returner the elasticsearch python client must be installed
on the desired minions (all or some subset).
.sp
Please see documentation of \fI\%elasticsearch execution module\fP
for a valid connection configuration.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
The index that you wish to store documents will be created by Elasticsearch automatically if
doesn\(aqt exist yet. It is highly recommended to create predefined index templates with appropriate mapping(s)
that will be used by Elasticsearch upon index creation. Otherwise you will have problems as described in #20826.
.UNINDENT
.UNINDENT
.sp
To use the returner per salt call:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return elasticsearch
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In order to have the returner apply to all minions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_job_cache: elasticsearch
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B Minion configuration:
.INDENT 7.0
.TP
.B debug_returner_payload\(aq: False
Output the payload being posted to the log file in debug mode
.TP
.B doc_type: \(aqdefault\(aq
Document type to use for normal return messages
.TP
.B functions_blacklist
Optional list of functions that should not be returned to elasticsearch
.TP
.B index_date: False
Use a dated index (e.g. <index>\-2016.11.29)
.TP
.B master_event_index: \(aqsalt\-master\-event\-cache\(aq
Index to use when returning master events
.TP
.B master_event_doc_type: \(aqefault\(aq
Document type to use got master events
.TP
.B master_job_cache_index: \(aqsalt\-master\-job\-cache\(aq
Index to use for master job cache
.TP
.B master_job_cache_doc_type: \(aqdefault\(aq
Document type to use for master job cache
.TP
.B number_of_shards: 1
Number of shards to use for the indexes
.TP
.B number_of_replicas: 0
Number of replicas to use for the indexes
.UNINDENT
.sp
NOTE: The following options are valid for \(aqstate.apply\(aq, \(aqstate.sls\(aq and \(aqstate.highstate\(aq functions only.
.INDENT 7.0
.TP
.B states_count: False
Count the number of states which succeeded or failed and return it in top\-level item called \(aqcounts\(aq.
States reporting None (i.e. changes would be made but it ran in test mode) are counted as successes.
.TP
.B states_order_output: False
Prefix the state UID (e.g. file_|\-yum_configured_|\-/etc/yum.conf_|\-managed) with a zero\-padded version
of the \(aq__run_num__\(aq value to allow for easier sorting. Also store the state function (i.e. file.managed)
into a new key \(aq_func\(aq. Change the index to be \(aq<index>\-ordered\(aq (e.g. salt\-state_apply\-ordered).
.TP
.B states_single_index: False
Store results for state.apply, state.sls and state.highstate in the salt\-state_apply index
(or \-ordered/\-<date>) indexes if enabled
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
elasticsearch:
    hosts:
      \- \(dq10.10.10.10:9200\(dq
      \- \(dq10.10.10.11:9200\(dq
      \- \(dq10.10.10.12:9200\(dq
    index_date: True
    number_of_shards: 5
    number_of_replicas: 1
    debug_returner_payload: True
    states_count: True
    states_order_output: True
    states_single_index: True
    functions_blacklist:
      \- test.ping
      \- saltutil.find_job
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.elasticsearch_return.event_return(events)
Return events to Elasticsearch
.sp
Requires that the \fIevent_return\fP configuration be set in master config.
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.elasticsearch_return.get_load(jid)
Return the load data that marks a specified jid
.sp
New in version 2015.8.1.

.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.elasticsearch_return.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.elasticsearch_return.returner(ret)
Process the return from Salt
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.elasticsearch_return.save_load(jid, load, minions=None)
Save the load to the specified jid id
.sp
New in version 2015.8.1.

.UNINDENT
.SS salt.returners.etcd_return
.sp
Return data to an etcd server or cluster
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
python\-etcd or etcd3\-py
.UNINDENT
.UNINDENT
.sp
In order to return to an etcd server, a profile should be created in the master
configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_etcd_config:
  etcd.host: 127.0.0.1
  etcd.port: 2379
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is technically possible to configure etcd without using a profile, but this
is not considered to be a best practice, especially when multiple etcd servers
or clusters are available.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.host: 127.0.0.1
etcd.port: 2379
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In order to choose whether to use etcd API v2 or v3, you can put the following
configuration option in the same place as your etcd configuration.  This option
defaults to true, meaning you will use v2 unless you specify otherwise.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.require_v2: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When using API v3, there are some specific options available to be configured
within your etcd profile.  They are defaulted to the following...
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.encode_keys: False
etcd.encode_values: True
etcd.raw_keys: False
etcd.raw_values: False
etcd.unicode_errors: \(dqsurrogateescape\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBetcd.encode_keys\fP indicates whether you want to pre\-encode keys using msgpack before
adding them to etcd.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you set \fBetcd.encode_keys\fP to \fBTrue\fP, all recursive functionality will no longer work.
This includes \fBtree\fP and \fBls\fP and all other methods if you set \fBrecurse\fP/\fBrecursive\fP to \fBTrue\fP\&.
This is due to the fact that when encoding with msgpack, keys like \fB/salt\fP and \fB/salt/stack\fP will have
differing byte prefixes, and etcd v3 searches recursively using prefixes.
.UNINDENT
.UNINDENT
.sp
\fBetcd.encode_values\fP indicates whether you want to pre\-encode values using msgpack before
adding them to etcd.  This defaults to \fBTrue\fP to avoid data loss on non\-string values wherever possible.
.sp
\fBetcd.raw_keys\fP determines whether you want the raw key or a string returned.
.sp
\fBetcd.raw_values\fP determines whether you want the raw value or a string returned.
.sp
\fBetcd.unicode_errors\fP determines what you policy to follow when there are encoding/decoding errors.
.sp
Additionally, two more options must be specified in the top\-level configuration
in order to use the etcd returner:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.returner: my_etcd_config
etcd.returner_root: /salt/return
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBetcd.returner\fP option specifies which configuration profile to use. The
\fBetcd.returner_root\fP option specifies the path inside etcd to use as the root
of the returner system.
.sp
Once the etcd options are configured, the returner may be used:
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
salt \(aq*\(aq test.ping \-\-return etcd
.UNINDENT
.UNINDENT
.sp
A username and password can be set:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.username: larry  # Optional; requires etcd.password to be set
etcd.password: 123pass  # Optional; requires etcd.username to be set
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also set a TTL (time to live) value for the returner:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.ttl: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Authentication with username and password, and ttl, currently requires the
\fBmaster\fP branch of \fBpython\-etcd\fP\&.
.sp
You may also specify different roles for read and write operations. First,
create the profiles as specified above. Then add:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.returner_read_profile: my_etcd_read
etcd.returner_write_profile: my_etcd_write
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.etcd_return.clean_old_jobs()
Included for API consistency
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.etcd_return.get_fun(fun)
Return a dict of the last function called for all minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.etcd_return.get_jid(jid)
Return the information returned when the specified job id was executed
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.etcd_return.get_jids()
Return a list of all job ids
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.etcd_return.get_load(jid)
Return the load data that marks a specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.etcd_return.get_minions()
Return a list of minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.etcd_return.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.etcd_return.returner(ret)
Return data to an etcd server or cluster
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.etcd_return.save_load(jid, load, minions=None)
Save the load to the specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.etcd_return.save_minions(jid, minions, syndic_id=None)
Included for API consistency
.UNINDENT
.SS salt.returners.highstate_return
.sp
Return the results of a highstate (or any other state function that returns
data in a compatible format) via an HTML email or HTML file.
.sp
New in version 2017.7.0.

.sp
Similar results can be achieved by using the smtp returner with a custom template,
except an attempt at writing such a template for the complex data structure
returned by highstate function had proven to be a challenge, not to mention
that the smtp module doesn\(aqt support sending HTML mail at the moment.
.sp
The main goal of this returner was to produce an easy to read email similar
to the output of highstate outputter used by the CLI.
.sp
This returner could be very useful during scheduled executions,
but could also be useful for communicating the results of a manual execution.
.sp
Returner configuration is controlled in a standard fashion either via
highstate group or an alternatively named group.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.highstate \-\-return highstate
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \(aq\-\-return_config config\-name\(aq
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.highstate \-\-return highstate \-\-return_config simple
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here is an example of what the configuration might look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
simple.highstate:
  report_failures: True
  report_changes: True
  report_everything: False
  failure_function: pillar.items
  success_function: pillar.items
  report_format: html
  report_delivery: smtp
  smtp_success_subject: \(aqsuccess minion {id} on host {host}\(aq
  smtp_failure_subject: \(aqfailure minion {id} on host {host}\(aq
  smtp_server: smtp.example.com
  smtp_recipients: saltusers@example.com, devops@example.com
  smtp_sender: salt@example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fIreport_failures\fP, \fIreport_changes\fP, and \fIreport_everything\fP flags provide
filtering of the results. If you want an email to be sent every time, then
\fIreport_everything\fP is your choice. If you want to be notified only when
changes were successfully made use \fIreport_changes\fP\&. And \fIreport_failures\fP will
generate an email if there were failures.
.sp
The configuration allows you to run a salt module function in case of
success (\fIsuccess_function\fP) or failure (\fIfailure_function\fP).
.sp
Any salt function, including ones defined in the _module folder of your salt
repo, could be used here and its output will be displayed under the \(aqextra\(aq
heading of the email.
.sp
Supported values for \fIreport_format\fP are html, json, and yaml. The latter two
are typically used for debugging purposes, but could be used for applying
a template at some later stage.
.sp
The values for \fIreport_delivery\fP are smtp or file. In case of file delivery
the only other applicable option is \fIfile_output\fP\&.
.sp
In case of smtp delivery, smtp_* options demonstrated by the example above
could be used to customize the email.
.sp
As you might have noticed, the success and failure subjects contain {id} and {host}
values. Any other grain name could be used. As opposed to using
{{grains[\(aqid\(aq]}}, which will be rendered by the master and contain master\(aqs
values at the time of pillar generation, these will contain minion values at
the time of execution.
.INDENT 0.0
.TP
.B salt.returners.highstate_return.returner(ret)
Check highstate return information and possibly fire off an email
or save a file.
.UNINDENT
.SS salt.returners.influxdb_return
.sp
Return data to an influxdb server.
.sp
New in version 2015.8.0.

.sp
To enable this returner the minion will need the python client for influxdb
installed and the following values configured in the minion or master
config, these are the defaults:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
influxdb.db: \(aqsalt\(aq
influxdb.user: \(aqsalt\(aq
influxdb.password: \(aqsalt\(aq
influxdb.host: \(aqlocalhost\(aq
influxdb.port: 8086
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.influxdb.db: \(aqsalt\(aq
alternative.influxdb.user: \(aqsalt\(aq
alternative.influxdb.password: \(aqsalt\(aq
alternative.influxdb.host: \(aqlocalhost\(aq
alternative.influxdb.port: 6379
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the influxdb returner, append \(aq\-\-return influxdb\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return influxdb
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return influxdb \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return influxdb \-\-return_kwargs \(aq{\(dqdb\(dq: \(dqanother\-salt\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.influxdb_return.get_fun(fun)
Return a dict of the last function called for all minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.influxdb_return.get_jid(jid)
Return the information returned when the specified job id was executed
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.influxdb_return.get_jids()
Return a list of all job ids
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.influxdb_return.get_load(jid)
Return the load data that marks a specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.influxdb_return.get_minions()
Return a list of minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.influxdb_return.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.influxdb_return.returner(ret)
Return data to a influxdb data store
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.influxdb_return.save_load(jid, load, minions=None)
Save the load to the specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.influxdb_return.save_minions(jid, minions, syndic_id=None)
Included for API consistency
.UNINDENT
.SS salt.returners.kafka_return
.sp
Return data to a Kafka topic
.INDENT 0.0
.TP
.B maintainer
Justin Desilets (\fI\%justin.desilets@gmail.com\fP)
.TP
.B maturity
20181119
.TP
.B depends
confluent\-kafka
.TP
.B platform
all
.UNINDENT
.sp
To enable this returner install confluent\-kafka and enable the following
settings in the minion config:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B returner.kafka.bootstrap:
.INDENT 7.0
.IP \(bu 2
\(dqserver1:9092\(dq
.IP \(bu 2
\(dqserver2:9092\(dq
.IP \(bu 2
\(dqserver3:9092\(dq
.UNINDENT
.UNINDENT
.sp
returner.kafka.topic: \(aqtopic\(aq
.UNINDENT
.UNINDENT
.sp
To use the kafka returner, append \fI\-\-return kafka\fP to the Salt command, eg;
.INDENT 0.0
.INDENT 3.5
salt \(aq*\(aq test.ping \-\-return kafka
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.kafka_return.returner(ret)
Return information to a Kafka server
.UNINDENT
.SS salt.returners.librato_return
.sp
Salt returner to return highstate stats to Librato
.sp
To enable this returner the minion will need the Librato
client importable on the Python path and the following
values configured in the minion or master config.
.sp
The Librato python client can be found at:
\fI\%https://github.com/librato/python\-librato\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
librato.email: example@librato.com
librato.api_token: abc12345def
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This return supports multi\-dimension metrics for Librato. To enable
support for more metrics, the tags JSON object can be modified to include
other tags.
.sp
Adding EC2 Tags example:
If ec2_tags:region were desired within the tags for multi\-dimension. The tags
could be modified to include the ec2 tags. Multiple dimensions are added simply
by adding more tags to the submission.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillar_data = __salt__[\(aqpillar.raw\(aq]()
q.add(metric.name, value, tags={\(aqName\(aq: ret[\(aqid\(aq],\(aqRegion\(aq: pillar_data[\(aqec2_tags\(aq][\(aqName\(aq]})
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.librato_return.returner(ret)
Parse the return data and return metrics to Librato.
.UNINDENT
.SS salt.returners.local
.sp
The local returner is used to test the returner interface, it just prints the
return data to the console to verify that it is being passed properly
.sp
To use the local returner, append \(aq\-\-return local\(aq to the salt command. ex:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return local
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.local.event_return(event)
Print event return data to the terminal to verify functionality
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.local.returner(ret)
Print the return data to the terminal to verify functionality
.UNINDENT
.SS salt.returners.local_cache
.sp
Return data to local job cache
.INDENT 0.0
.TP
.B salt.returners.local_cache.clean_old_jobs()
Clean out the old jobs from the job cache
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.local_cache.get_endtime(jid)
Retrieve the stored endtime for a given job
.sp
Returns False if no endtime is present
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.local_cache.get_jid(jid)
Return the information returned when the specified job id was executed
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.local_cache.get_jids()
Return a dict mapping all job ids to job information
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.local_cache.get_jids_filter(count, filter_find_job=True)
Return a list of all jobs information filtered by the given criteria.
:param int count: show not more than the count of most recent jobs
:param bool filter_find_jobs: filter out \(aqsaltutil.find_job\(aq jobs
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.local_cache.get_load(jid)
Return the load data that marks a specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.local_cache.load_reg()
Load the register from msgpack files
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.local_cache.prep_jid(nocache=False, passed_jid=None, recurse_count=0)
Return a job id and prepare the job id directory.
.sp
This is the function responsible for making sure jids don\(aqt collide (unless
it is passed a jid).
So do what you have to do to make sure that stays the case
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.local_cache.returner(load)
Return data to the local job cache
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.local_cache.save_load(jid, clear_load, minions=None, recurse_count=0)
Save the load to the specified jid
.sp
minions argument is to provide a pre\-computed list of matched minions for
the job, for cases when this function can\(aqt compute that list itself (such
as for salt\-ssh)
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.local_cache.save_minions(jid, minions, syndic_id=None)
Save/update the serialized list of minions for a given job
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.local_cache.save_reg(data)
Save the register to msgpack files
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.local_cache.update_endtime(jid, time)
Update (or store) the end time for a given job
.sp
Endtime is stored as a plain text string
.UNINDENT
.SS salt.returners.mattermost_returner
.sp
Return salt data via mattermost
.sp
New in version 2017.7.0.

.sp
The following fields can be set in the minion conf file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mattermost.hook (required)
mattermost.username (optional)
mattermost.channel (optional)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mattermost.channel
mattermost.hook
mattermost.username
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
mattermost settings may also be configured as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mattermost:
  channel: RoomName
  hook: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  username: user
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the mattermost returner, append \(aq\-\-return mattermost\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return mattermost
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(aqkey:\(aq: \(aqvalue\(aq}\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return mattermost \-\-return_kwargs \(aq{\(aqchannel\(aq: \(aq#random\(aq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mattermost_returner.event_return(events)
Send the events to a mattermost room.
.INDENT 7.0
.TP
.B Parameters
\fBevents\fP \-\- List of events
.TP
.B Returns
Boolean if messages were sent successfully.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mattermost_returner.post_message(channel, message, username, api_url, hook)
Send a message to a mattermost room.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBchannel\fP \-\- The room name.
.IP \(bu 2
\fBmessage\fP \-\- The message to send to the mattermost room.
.IP \(bu 2
\fBusername\fP \-\- Specify who the message is from.
.IP \(bu 2
\fBhook\fP \-\- The mattermost hook, if not specified in the configuration.
.UNINDENT
.TP
.B Returns
Boolean if message was sent successfully.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mattermost_returner.returner(ret)
Send an mattermost message with the data
.UNINDENT
.SS salt.returners.memcache_return
.sp
Return data to a memcache server
.sp
To enable this returner the minion will need the python client for memcache
installed and the following values configured in the minion or master
config, these are the defaults.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
memcache.host: \(aqlocalhost\(aq
memcache.port: \(aq11211\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.memcache.host: \(aqlocalhost\(aq
alternative.memcache.port: \(aq11211\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
python2\-memcache uses \(aqlocalhost\(aq and \(aq11211\(aq as syntax on connection.
.sp
To use the memcache returner, append \(aq\-\-return memcache\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return memcache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return memcache \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return memcache \-\-return_kwargs \(aq{\(dqhost\(dq: \(dqhostname.domain.com\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.memcache_return.get_fun(fun)
Return a dict of the last function called for all minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.memcache_return.get_jid(jid)
Return the information returned when the specified job id was executed
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.memcache_return.get_jids()
Return a list of all job ids
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.memcache_return.get_load(jid)
Return the load data that marks a specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.memcache_return.get_minions()
Return a list of minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.memcache_return.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.memcache_return.returner(ret)
Return data to a memcache data store
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.memcache_return.save_load(jid, load, minions=None)
Save the load to the specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.memcache_return.save_minions(jid, minions, syndic_id=None)
Included for API consistency
.UNINDENT
.SS salt.returners.mongo_future_return
.sp
Return data to a mongodb server
.sp
Required python modules: pymongo
.sp
This returner will send data from the minions to a MongoDB server. MongoDB
server can be configured by using host, port, db, user and password settings
or by connection string URI (for pymongo > 2.3). To configure the settings
for your MongoDB server, add the following lines to the minion config files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mongo.db: <database name>
mongo.host: <server ip address>
mongo.user: <MongoDB username>
mongo.password: <MongoDB user password>
mongo.port: 27017
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or single URI:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mongo.uri: URI
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
where uri is in the format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mongodb://db1.example.net:27017/mydatabase
mongodb://db1.example.net:27017,db2.example.net:2500/?replicaSet=test
mongodb://db1.example.net:27017,db2.example.net:2500/?replicaSet=test&connectTimeoutMS=300000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
More information on URI format can be found in
\fI\%https://docs.mongodb.com/manual/reference/connection\-string/\fP
.sp
You can also ask for indexes creation on the most common used fields, which
should greatly improve performance. Indexes are not created by default.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mongo.indexes: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.mongo.db: <database name>
alternative.mongo.host: <server ip address>
alternative.mongo.user: <MongoDB username>
alternative.mongo.password: <MongoDB user password>
alternative.mongo.port: 27017
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or single URI:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.mongo.uri: URI
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This mongo returner is being developed to replace the default mongodb returner
in the future and should not be considered API stable yet.
.sp
To use the mongo returner, append \(aq\-\-return mongo\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return mongo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return mongo \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return mongo \-\-return_kwargs \(aq{\(dqdb\(dq: \(dqanother\-salt\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mongo_future_return.event_return(events)
Return events to Mongodb server
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mongo_future_return.get_fun(fun)
Return the most recent jobs that have executed the named function
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mongo_future_return.get_jid(jid)
Return the return information associated with a jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mongo_future_return.get_jids()
Return a list of job ids
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mongo_future_return.get_load(jid)
Return the load associated with a given job id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mongo_future_return.get_minions()
Return a list of minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mongo_future_return.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mongo_future_return.returner(ret)
Return data to a mongodb server
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mongo_future_return.save_load(jid, load, minions=None)
Save the load for a given job id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mongo_future_return.save_minions(jid, minions, syndic_id=None)
Included for API consistency
.UNINDENT
.SS salt.returners.mongo_return
.sp
Return data to a mongodb server
.sp
Required python modules: pymongo
.sp
This returner will send data from the minions to a MongoDB server. To
configure the settings for your MongoDB server, add the following lines
to the minion config files.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mongo.db: <database name>
mongo.host: <server ip address>
mongo.user: <MongoDB username>
mongo.password: <MongoDB user password>
mongo.port: 27017
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.mongo.db: <database name>
alternative.mongo.host: <server ip address>
alternative.mongo.user: <MongoDB username>
alternative.mongo.password: <MongoDB user password>
alternative.mongo.port: 27017
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the mongo returner, append \(aq\-\-return mongo\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return mongo_return
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return mongo_return \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return mongo \-\-return_kwargs \(aq{\(dqdb\(dq: \(dqanother\-salt\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return mongo \-\-return_kwargs \(aq{\(dqdb\(dq: \(dqanother\-salt\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mongo_return.get_fun(fun)
Return the most recent jobs that have executed the named function
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mongo_return.get_jid(jid)
Return the return information associated with a jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mongo_return.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mongo_return.returner(ret)
Return data to a mongodb server
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mongo_return.save_minions(jid, minions, syndic_id=None)
Included for API consistency
.UNINDENT
.SS salt.returners.multi_returner
.sp
Read/Write multiple returners
.INDENT 0.0
.TP
.B salt.returners.multi_returner.clean_old_jobs()
Clean out the old jobs from all returners (if you have it)
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.multi_returner.get_jid(jid)
Merge the return data from all returners
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.multi_returner.get_jids()
Return all job data from all returners
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.multi_returner.get_load(jid)
Merge the load data from all returners
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.multi_returner.prep_jid(nocache=False, passed_jid=None)
Call both with prep_jid on all returners in multi_returner
.sp
TODO: finish this, what do do when you get different jids from 2 returners...
since our jids are time based, this make this problem hard, because they
aren\(aqt unique, meaning that we have to make sure that no one else got the jid
and if they did we spin to get a new one, which means \(dqlocking\(dq the jid in 2
returners is non\-trivial
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.multi_returner.returner(load)
Write return to all returners in multi_returner
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.multi_returner.save_load(jid, clear_load, minions=None)
Write load to all returners in multi_returner
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.multi_returner.save_minions(jid, minions, syndic_id=None)
Included for API consistency
.UNINDENT
.SS salt.returners.mysql
.sp
Return data to a mysql server
.INDENT 0.0
.TP
.B maintainer
Dave Boucha <\fI\%dave@saltstack.com\fP>, Seth House <\fI\%shouse@saltstack.com\fP>
.TP
.B maturity
mature
.TP
.B depends
python\-mysqldb
.TP
.B platform
all
.UNINDENT
.sp
To enable this returner, the minion will need the python client for mysql
installed and the following values configured in the minion or master
config. These are the defaults:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql.host: \(aqsalt\(aq
mysql.user: \(aqsalt\(aq
mysql.pass: \(aqsalt\(aq
mysql.db: \(aqsalt\(aq
mysql.port: 3306
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
SSL is optional. The defaults are set to None. If you do not want to use SSL,
either exclude these options or set them to None.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql.ssl_ca: None
mysql.ssl_cert: None
mysql.ssl_key: None
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration
with \fIalternative.\fP\&. Any values not found in the alternative configuration will
be pulled from the default location. As stated above, SSL configuration is
optional. The following ssl options are simply for illustration purposes:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.mysql.host: \(aqsalt\(aq
alternative.mysql.user: \(aqsalt\(aq
alternative.mysql.pass: \(aqsalt\(aq
alternative.mysql.db: \(aqsalt\(aq
alternative.mysql.port: 3306
alternative.mysql.ssl_ca: \(aq/etc/pki/mysql/certs/localhost.pem\(aq
alternative.mysql.ssl_cert: \(aq/etc/pki/mysql/certs/localhost.crt\(aq
alternative.mysql.ssl_key: \(aq/etc/pki/mysql/certs/localhost.key\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Should you wish the returner data to be cleaned out every so often, set
\fIkeep_jobs_seconds\fP to the number of hours for the jobs to live in the
tables.  Setting it to \fI0\fP will cause the data to stay in the tables. The
default setting for \fIkeep_jobs_seconds\fP is set to \fI86400\fP\&.
.sp
Should you wish to archive jobs in a different table for later processing,
set \fIarchive_jobs\fP to True.  Salt will create 3 archive tables
.INDENT 0.0
.IP \(bu 2
\fIjids_archive\fP
.IP \(bu 2
\fIsalt_returns_archive\fP
.IP \(bu 2
\fIsalt_events_archive\fP
.UNINDENT
.sp
and move the contents of \fIjids\fP, \fIsalt_returns\fP, and \fIsalt_events\fP that are
more than \fIkeep_jobs_seconds\fP seconds old to these tables.
.sp
Use the following mysql database schema:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
CREATE DATABASE  \(gasalt\(ga
  DEFAULT CHARACTER SET utf8
  DEFAULT COLLATE utf8_general_ci;

USE \(gasalt\(ga;

\-\-
\-\- Table structure for table \(gajids\(ga
\-\-

DROP TABLE IF EXISTS \(gajids\(ga;
CREATE TABLE \(gajids\(ga (
  \(gajid\(ga varchar(255) NOT NULL,
  \(gaload\(ga mediumtext NOT NULL,
  UNIQUE KEY \(gajid\(ga (\(gajid\(ga)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

\-\-
\-\- Table structure for table \(gasalt_returns\(ga
\-\-

DROP TABLE IF EXISTS \(gasalt_returns\(ga;
CREATE TABLE \(gasalt_returns\(ga (
  \(gafun\(ga varchar(50) NOT NULL,
  \(gajid\(ga varchar(255) NOT NULL,
  \(gareturn\(ga mediumtext NOT NULL,
  \(gaid\(ga varchar(255) NOT NULL,
  \(gasuccess\(ga varchar(10) NOT NULL,
  \(gafull_ret\(ga mediumtext NOT NULL,
  \(gaalter_time\(ga TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
  KEY \(gaid\(ga (\(gaid\(ga),
  KEY \(gajid\(ga (\(gajid\(ga),
  KEY \(gafun\(ga (\(gafun\(ga)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

\-\-
\-\- Table structure for table \(gasalt_events\(ga
\-\-

DROP TABLE IF EXISTS \(gasalt_events\(ga;
CREATE TABLE \(gasalt_events\(ga (
\(gaid\(ga BIGINT NOT NULL AUTO_INCREMENT,
\(gatag\(ga varchar(255) NOT NULL,
\(gadata\(ga mediumtext NOT NULL,
\(gaalter_time\(ga TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
\(gamaster_id\(ga varchar(255) NOT NULL,
PRIMARY KEY (\(gaid\(ga),
KEY \(gatag\(ga (\(gatag\(ga)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required python modules: MySQLdb
.sp
To use the mysql returner, append \(aq\-\-return mysql\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return mysql
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return mysql \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return mysql \-\-return_kwargs \(aq{\(dqdb\(dq: \(dqanother\-salt\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mysql.clean_old_jobs()
Called in the master\(aqs event loop every loop_interval.  Archives and/or
deletes the events and job details from the database.
:return:
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mysql.event_return(events)
Return event to mysql server
.sp
Requires that configuration be enabled via \(aqevent_return\(aq
option in master config.
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mysql.get_fun(fun)
Return a dict of the last function called for all minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mysql.get_jid(jid)
Return the information returned when the specified job id was executed
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mysql.get_jids()
Return a list of all job ids
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mysql.get_jids_filter(count, filter_find_job=True)
Return a list of all job ids
:param int count: show not more than the count of most recent jobs
:param bool filter_find_jobs: filter out \(aqsaltutil.find_job\(aq jobs
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mysql.get_load(jid)
Return the load data that marks a specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mysql.get_minions()
Return a list of minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mysql.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mysql.returner(ret)
Return data to a mysql server
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mysql.save_load(jid, load, minions=None)
Save the load to the specified jid id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.mysql.save_minions(jid, minions, syndic_id=None)
Included for API consistency
.UNINDENT
.SS salt.returners.nagios_nrdp_return
.sp
Return salt data to Nagios
.sp
The following fields can be set in the minion conf file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nagios.url (required)
nagios.token (required)
nagios.service (optional)
nagios.check_type (optional)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nagios.url
nagios.token
nagios.service
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Nagios settings may also be configured as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
  nagios:
      url: http://localhost/nrdp
      token: r4nd0mt0k3n
      service: service\-check

  alternative.nagios:
      url: http://localhost/nrdp
      token: r4nd0mt0k3n
      service: another\-service\-check

To use the Nagios returner, append \(aq\-\-return nagios\(aq to the salt command. ex:

\&.. code\-block:: bash

  salt \(aq*\(aq test.ping \-\-return nagios

To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command. ex:

  salt \(aq*\(aq test.ping \-\-return nagios \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return nagios \-\-return_kwargs \(aq{\(dqservice\(dq: \(dqservice\-name\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.nagios_nrdp_return.returner(ret)
Send a message to Nagios with the data
.UNINDENT
.SS salt.returners.odbc
.sp
Return data to an ODBC compliant server.  This driver was
developed with Microsoft SQL Server in mind, but theoretically
could be used to return data to any compliant ODBC database
as long as there is a working ODBC driver for it on your
minion platform.
.INDENT 0.0
.TP
.B maintainer
.INDENT 7.0
.IP C. 3
.INDENT 3.0
.IP R. 3
Oldham (\fI\%cr@saltstack.com\fP)
.UNINDENT
.UNINDENT
.TP
.B maturity
New
.TP
.B depends
unixodbc, pyodbc, freetds (for SQL Server)
.TP
.B platform
all
.UNINDENT
.sp
To enable this returner the minion will need
.sp
On Linux:
.INDENT 0.0
.INDENT 3.5
unixodbc (\fI\%http://www.unixodbc.org\fP)
pyodbc (\fIpip install pyodbc\fP)
The FreeTDS ODBC driver for SQL Server (\fI\%http://www.freetds.org\fP)
or another compatible ODBC driver
.UNINDENT
.UNINDENT
.sp
On Windows:
.INDENT 0.0
.INDENT 3.5
TBD
.UNINDENT
.UNINDENT
.sp
unixODBC and FreeTDS need to be configured via /etc/odbcinst.ini and
/etc/odbc.ini.
.sp
/etc/odbcinst.ini:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[TDS]
Description=TDS
Driver=/usr/lib/x86_64\-linux\-gnu/odbc/libtdsodbc.so
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
(Note the above Driver line needs to point to the location of the FreeTDS
shared library.  This example is for Ubuntu 14.04.)
.sp
/etc/odbc.ini:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[TS]
Description = \(dqSalt Returner\(dq
Driver=TDS
Server = <your server ip or fqdn>
Port = 1433
Database = salt
Trace = No
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Also you need the following values configured in the minion or master config.
Configure as you see fit:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
returner.odbc.dsn: \(aqTS\(aq
returner.odbc.user: \(aqsalt\(aq
returner.odbc.passwd: \(aqsalt\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.returner.odbc.dsn: \(aqTS\(aq
alternative.returner.odbc.user: \(aqsalt\(aq
alternative.returner.odbc.passwd: \(aqsalt\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Running the following commands against Microsoft SQL Server in the desired
database as the appropriate user should create the database tables
correctly.  Replace with equivalent SQL for other ODBC\-compliant servers
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
  \-\-
  \-\- Table structure for table \(aqjids\(aq
  \-\-

  if OBJECT_ID(\(aqdbo.jids\(aq, \(aqU\(aq) is not null
      DROP TABLE dbo.jids

  CREATE TABLE dbo.jids (
     jid   varchar(255) PRIMARY KEY,
     load  varchar(MAX) NOT NULL
   );

  \-\-
  \-\- Table structure for table \(aqsalt_returns\(aq
  \-\-
  IF OBJECT_ID(\(aqdbo.salt_returns\(aq, \(aqU\(aq) IS NOT NULL
      DROP TABLE dbo.salt_returns;

  CREATE TABLE dbo.salt_returns (
     added     datetime not null default (getdate()),
     fun       varchar(100) NOT NULL,
     jid       varchar(255) NOT NULL,
     retval    varchar(MAX) NOT NULL,
     id        varchar(255) NOT NULL,
     success   bit default(0) NOT NULL,
     full_ret  varchar(MAX)
   );

  CREATE INDEX salt_returns_added on dbo.salt_returns(added);
  CREATE INDEX salt_returns_id on dbo.salt_returns(id);
  CREATE INDEX salt_returns_jid on dbo.salt_returns(jid);
  CREATE INDEX salt_returns_fun on dbo.salt_returns(fun);

To use this returner, append \(aq\-\-return odbc\(aq to the salt command.

\&.. code\-block:: bash

  salt \(aq*\(aq status.diskusage \-\-return odbc

To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command.

\&.. versionadded:: 2015.5.0

\&.. code\-block:: bash

  salt \(aq*\(aq test.ping \-\-return odbc \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return odbc \-\-return_kwargs \(aq{\(dqdsn\(dq: \(dqdsn\-name\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.odbc.get_fun(fun)
Return a dict of the last function called for all minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.odbc.get_jid(jid)
Return the information returned when the specified job id was executed
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.odbc.get_jids()
Return a list of all job ids
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.odbc.get_load(jid)
Return the load data that marks a specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.odbc.get_minions()
Return a list of minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.odbc.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.odbc.returner(ret)
Return data to an odbc server
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.odbc.save_load(jid, load, minions=None)
Save the load to the specified jid id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.odbc.save_minions(jid, minions, syndic_id=None)
Included for API consistency
.UNINDENT
.SS salt.returners.pgjsonb
.sp
Return data to a PostgreSQL server with json data stored in Pg\(aqs jsonb data type
.INDENT 0.0
.TP
.B maintainer
Dave Boucha <\fI\%dave@saltstack.com\fP>, Seth House <\fI\%shouse@saltstack.com\fP>, C. R. Oldham <\fI\%cr@saltstack.com\fP>
.TP
.B maturity
Stable
.TP
.B depends
python\-psycopg2
.TP
.B platform
all
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
There are three PostgreSQL returners.  Any can function as an external
\fI\%master job cache\fP\&. but each has different
features.  SaltStack recommends
\fI\%returners.pgjsonb\fP if you are working with
a version of PostgreSQL that has the appropriate native binary JSON types.
Otherwise, review
\fI\%returners.postgres\fP and
\fI\%returners.postgres_local_cache\fP
to see which module best suits your particular needs.
.UNINDENT
.UNINDENT
.sp
To enable this returner, the minion will need the python client for PostgreSQL
installed and the following values configured in the minion or master
config. These are the defaults:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
returner.pgjsonb.host: \(aqsalt\(aq
returner.pgjsonb.user: \(aqsalt\(aq
returner.pgjsonb.pass: \(aqsalt\(aq
returner.pgjsonb.db: \(aqsalt\(aq
returner.pgjsonb.port: 5432
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
SSL is optional. The defaults are set to None. If you do not want to use SSL,
either exclude these options or set them to None.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
returner.pgjsonb.sslmode: None
returner.pgjsonb.sslcert: None
returner.pgjsonb.sslkey: None
returner.pgjsonb.sslrootcert: None
returner.pgjsonb.sslcrl: None
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.5.0.

.sp
Alternative configuration values can be used by prefacing the configuration
with \fIalternative.\fP\&. Any values not found in the alternative configuration will
be pulled from the default location. As stated above, SSL configuration is
optional. The following ssl options are simply for illustration purposes:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.pgjsonb.host: \(aqsalt\(aq
alternative.pgjsonb.user: \(aqsalt\(aq
alternative.pgjsonb.pass: \(aqsalt\(aq
alternative.pgjsonb.db: \(aqsalt\(aq
alternative.pgjsonb.port: 5432
alternative.pgjsonb.ssl_ca: \(aq/etc/pki/mysql/certs/localhost.pem\(aq
alternative.pgjsonb.ssl_cert: \(aq/etc/pki/mysql/certs/localhost.crt\(aq
alternative.pgjsonb.ssl_key: \(aq/etc/pki/mysql/certs/localhost.key\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Should you wish the returner data to be cleaned out every so often, set
\fBkeep_jobs_seconds\fP to the number of seconds for the jobs to live in the tables.
Setting it to \fB0\fP or leaving it unset will cause the data to stay in the tables.
.sp
Should you wish to archive jobs in a different table for later processing,
set \fBarchive_jobs\fP to True.  Salt will create 3 archive tables;
.INDENT 0.0
.IP \(bu 2
\fBjids_archive\fP
.IP \(bu 2
\fBsalt_returns_archive\fP
.IP \(bu 2
\fBsalt_events_archive\fP
.UNINDENT
.sp
and move the contents of \fBjids\fP, \fBsalt_returns\fP, and \fBsalt_events\fP that are
more than \fBkeep_jobs_seconds\fP seconds old to these tables.
.sp
New in version 2019.2.0.

.sp
Use the following Pg database schema:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
CREATE DATABASE  salt
  WITH ENCODING \(aqutf\-8\(aq;

\-\-
\-\- Table structure for table \(gajids\(ga
\-\-
DROP TABLE IF EXISTS jids;
CREATE TABLE jids (
   jid varchar(255) NOT NULL primary key,
   load jsonb NOT NULL
);
CREATE INDEX idx_jids_jsonb on jids
       USING gin (load)
       WITH (fastupdate=on);

\-\-
\-\- Table structure for table \(gasalt_returns\(ga
\-\-

DROP TABLE IF EXISTS salt_returns;
CREATE TABLE salt_returns (
  fun varchar(50) NOT NULL,
  jid varchar(255) NOT NULL,
  return jsonb NOT NULL,
  id varchar(255) NOT NULL,
  success varchar(10) NOT NULL,
  full_ret jsonb NOT NULL,
  alter_time TIMESTAMP WITH TIME ZONE DEFAULT NOW());

CREATE INDEX idx_salt_returns_id ON salt_returns (id);
CREATE INDEX idx_salt_returns_jid ON salt_returns (jid);
CREATE INDEX idx_salt_returns_fun ON salt_returns (fun);
CREATE INDEX idx_salt_returns_return ON salt_returns
    USING gin (return) with (fastupdate=on);
CREATE INDEX idx_salt_returns_full_ret ON salt_returns
    USING gin (full_ret) with (fastupdate=on);

\-\-
\-\- Table structure for table \(gasalt_events\(ga
\-\-

DROP TABLE IF EXISTS salt_events;
DROP SEQUENCE IF EXISTS seq_salt_events_id;
CREATE SEQUENCE seq_salt_events_id;
CREATE TABLE salt_events (
    id BIGINT NOT NULL UNIQUE DEFAULT nextval(\(aqseq_salt_events_id\(aq),
    tag varchar(255) NOT NULL,
    data jsonb NOT NULL,
    alter_time TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
    master_id varchar(255) NOT NULL);

CREATE INDEX idx_salt_events_tag on
    salt_events (tag);
CREATE INDEX idx_salt_events_data ON salt_events
    USING gin (data) with (fastupdate=on);
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required python modules: Psycopg2
.sp
To use this returner, append \(aq\-\-return pgjsonb\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return pgjsonb
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return pgjsonb \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return pgjsonb \-\-return_kwargs \(aq{\(dqdb\(dq: \(dqanother\-salt\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.pgjsonb.clean_old_jobs()
Called in the master\(aqs event loop every loop_interval.  Archives and/or
deletes the events and job details from the database.
:return:
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.pgjsonb.event_return(events)
Return event to Pg server
.sp
Requires that configuration be enabled via \(aqevent_return\(aq
option in master config.
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.pgjsonb.get_fun(fun)
Return a dict of the last function called for all minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.pgjsonb.get_jid(jid)
Return the information returned when the specified job id was executed
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.pgjsonb.get_jids()
Return a list of all job ids
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.pgjsonb.get_load(jid)
Return the load data that marks a specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.pgjsonb.get_minions()
Return a list of minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.pgjsonb.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.pgjsonb.returner(ret)
Return data to a Pg server
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.pgjsonb.save_load(jid, load, minions=None)
Save the load to the specified jid id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.pgjsonb.save_minions(jid, minions, syndic_id=None)
Included for API consistency
.UNINDENT
.SS salt.returners.postgres
.sp
Return data to a postgresql server
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
There are three PostgreSQL returners.  Any can function as an external
\fI\%master job cache\fP\&. but each has different
features.  SaltStack recommends
\fI\%returners.pgjsonb\fP if you are working with
a version of PostgreSQL that has the appropriate native binary JSON types.
Otherwise, review
\fI\%returners.postgres\fP and
\fI\%returners.postgres_local_cache\fP
to see which module best suits your particular needs.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B maintainer
None
.TP
.B maturity
New
.TP
.B depends
psycopg2
.TP
.B platform
all
.UNINDENT
.sp
To enable this returner the minion will need the psycopg2 installed and
the following values configured in the minion or master config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
returner.postgres.host: \(aqsalt\(aq
returner.postgres.user: \(aqsalt\(aq
returner.postgres.passwd: \(aqsalt\(aq
returner.postgres.db: \(aqsalt\(aq
returner.postgres.port: 5432
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.returner.postgres.host: \(aqsalt\(aq
alternative.returner.postgres.user: \(aqsalt\(aq
alternative.returner.postgres.passwd: \(aqsalt\(aq
alternative.returner.postgres.db: \(aqsalt\(aq
alternative.returner.postgres.port: 5432
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Running the following commands as the postgres user should create the database
correctly:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
psql << EOF
CREATE ROLE salt WITH PASSWORD \(aqsalt\(aq;
CREATE DATABASE salt WITH OWNER salt;
EOF

psql \-h localhost \-U salt << EOF
\-\-
\-\- Table structure for table \(aqjids\(aq
\-\-

DROP TABLE IF EXISTS jids;
CREATE TABLE jids (
  jid   varchar(20) PRIMARY KEY,
  load  text NOT NULL
);

\-\-
\-\- Table structure for table \(aqsalt_returns\(aq
\-\-

DROP TABLE IF EXISTS salt_returns;
CREATE TABLE salt_returns (
  fun       varchar(50) NOT NULL,
  jid       varchar(255) NOT NULL,
  return    text NOT NULL,
  full_ret  text,
  id        varchar(255) NOT NULL,
  success   varchar(10) NOT NULL,
  alter_time   TIMESTAMP WITH TIME ZONE DEFAULT now()
);

CREATE INDEX idx_salt_returns_id ON salt_returns (id);
CREATE INDEX idx_salt_returns_jid ON salt_returns (jid);
CREATE INDEX idx_salt_returns_fun ON salt_returns (fun);
CREATE INDEX idx_salt_returns_updated ON salt_returns (alter_time);

\-\-
\-\- Table structure for table \(gasalt_events\(ga
\-\-

DROP TABLE IF EXISTS salt_events;
DROP SEQUENCE IF EXISTS seq_salt_events_id;
CREATE SEQUENCE seq_salt_events_id;
CREATE TABLE salt_events (
    id BIGINT NOT NULL UNIQUE DEFAULT nextval(\(aqseq_salt_events_id\(aq),
    tag varchar(255) NOT NULL,
    data text NOT NULL,
    alter_time TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
    master_id varchar(255) NOT NULL
);

CREATE INDEX idx_salt_events_tag on salt_events (tag);

EOF
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required python modules: psycopg2
.sp
To use the postgres returner, append \(aq\-\-return postgres\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return postgres
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return postgres \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return postgres \-\-return_kwargs \(aq{\(dqdb\(dq: \(dqanother\-salt\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres.event_return(events)
Return event to Pg server
.sp
Requires that configuration be enabled via \(aqevent_return\(aq
option in master config.
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres.get_fun(fun)
Return a dict of the last function called for all minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres.get_jid(jid)
Return the information returned when the specified job id was executed
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres.get_jids()
Return a list of all job ids
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres.get_load(jid)
Return the load data that marks a specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres.get_minions()
Return a list of minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres.returner(ret)
Return data to a postgres server
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres.save_load(jid, load, minions=None)
Save the load to the specified jid id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres.save_minions(jid, minions, syndic_id=None)
Included for API consistency
.UNINDENT
.SS salt.returners.postgres_local_cache
.sp
Use a postgresql server for the master job cache. This helps the job cache to
cope with scale.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
There are three PostgreSQL returners.  Any can function as an external
\fI\%master job cache\fP\&. but each has different
features.  SaltStack recommends
\fI\%returners.pgjsonb\fP if you are working with
a version of PostgreSQL that has the appropriate native binary JSON types.
Otherwise, review
\fI\%returners.postgres\fP and
\fI\%returners.postgres_local_cache\fP
to see which module best suits your particular needs.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B maintainer
\fI\%gjredelinghuys@gmail.com\fP
.TP
.B maturity
Stable
.TP
.B depends
psycopg2
.TP
.B platform
all
.UNINDENT
.sp
To enable this returner the minion will need the psycopg2 installed and
the following values configured in the master config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_job_cache: postgres_local_cache
master_job_cache.postgres.host: \(aqsalt\(aq
master_job_cache.postgres.user: \(aqsalt\(aq
master_job_cache.postgres.passwd: \(aqsalt\(aq
master_job_cache.postgres.db: \(aqsalt\(aq
master_job_cache.postgres.port: 5432
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Running the following command as the postgres user should create the database
correctly:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
psql << EOF
CREATE ROLE salt WITH PASSWORD \(aqsalt\(aq;
CREATE DATABASE salt WITH OWNER salt;
EOF
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In case the postgres database is a remote host, you\(aqll need this command also:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ALTER ROLE salt WITH LOGIN;
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
and then:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
psql \-h localhost \-U salt << EOF
\-\-
\-\- Table structure for table \(aqjids\(aq
\-\-

DROP TABLE IF EXISTS jids;
CREATE TABLE jids (
  jid   varchar(20) PRIMARY KEY,
  started TIMESTAMP WITH TIME ZONE DEFAULT now(),
  tgt_type text NOT NULL,
  cmd text NOT NULL,
  tgt text NOT NULL,
  kwargs text NOT NULL,
  ret text NOT NULL,
  username text NOT NULL,
  arg text NOT NULL,
  fun text NOT NULL
);

\-\-
\-\- Table structure for table \(aqsalt_returns\(aq
\-\-
\-\- note that \(aqsuccess\(aq must not have NOT NULL constraint, since
\-\- some functions don\(aqt provide it.

DROP TABLE IF EXISTS salt_returns;
CREATE TABLE salt_returns (
  added     TIMESTAMP WITH TIME ZONE DEFAULT now(),
  fun       text NOT NULL,
  jid       varchar(20) NOT NULL,
  return    text NOT NULL,
  id        text NOT NULL,
  success   boolean
);
CREATE INDEX ON salt_returns (added);
CREATE INDEX ON salt_returns (id);
CREATE INDEX ON salt_returns (jid);
CREATE INDEX ON salt_returns (fun);

DROP TABLE IF EXISTS salt_events;
CREATE TABLE salt_events (
  id SERIAL,
  tag text NOT NULL,
  data text NOT NULL,
  alter_time TIMESTAMP WITH TIME ZONE DEFAULT now(),
  master_id text NOT NULL
);
CREATE INDEX ON salt_events (tag);
CREATE INDEX ON salt_events (data);
CREATE INDEX ON salt_events (id);
CREATE INDEX ON salt_events (master_id);
EOF
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required python modules: psycopg2
.INDENT 0.0
.TP
.B salt.returners.postgres_local_cache.clean_old_jobs()
Clean out the old jobs from the job cache
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres_local_cache.event_return(events)
Return event to a postgres server
.sp
Require that configuration be enabled via \(aqevent_return\(aq
option in master config.
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres_local_cache.get_jid(jid)
Return the information returned when the specified job id was executed
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres_local_cache.get_jids()
Return a list of all job ids
For master job cache this also formats the output and returns a string
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres_local_cache.get_load(jid)
Return the load data that marks a specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres_local_cache.prep_jid(nocache=False, passed_jid=None)
Return a job id and prepare the job id directory
This is the function responsible for making sure jids don\(aqt collide
(unless its passed a jid). So do what you have to do to make sure that
stays the case
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres_local_cache.returner(load)
Return data to a postgres server
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres_local_cache.save_load(jid, clear_load, minions=None)
Save the load to the specified jid id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.postgres_local_cache.save_minions(jid, minions, syndic_id=None)
Included for API consistency
.UNINDENT
.SS salt.returners.pushover_returner
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%pushover Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Return salt data via pushover (\fI\%http://www.pushover.net\fP)
.sp
New in version 2016.3.0.

.sp
The following fields can be set in the minion conf file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pushover.user (required)
pushover.token (required)
pushover.title (optional)
pushover.device (optional)
pushover.priority (optional)
pushover.expire (optional)
pushover.retry (optional)
pushover.profile (optional)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBuser\fP here is your \fBuser key\fP, \fInot\fP the email address you use to
login to pushover.net.
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.pushover.user
alternative.pushover.token
alternative.pushover.title
alternative.pushover.device
alternative.pushover.priority
alternative.pushover.expire
alternative.pushover.retry
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
PushOver settings may also be configured as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
  pushover:
      user: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
      token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
      title: Salt Returner
      device: phone
      priority: \-1
      expire: 3600
      retry: 5

  alternative.pushover:
      user: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
      token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
      title: Salt Returner
      device: phone
      priority: 1
      expire: 4800
      retry: 2

  pushover_profile:
      pushover.token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

  pushover:
      user: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
      profile: pushover_profile

  alternative.pushover:
      user: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
      profile: pushover_profile

To use the PushOver returner, append \(aq\-\-return pushover\(aq to the salt command. ex:

\&.. code\-block:: bash

  salt \(aq*\(aq test.ping \-\-return pushover

To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command. ex:

  salt \(aq*\(aq test.ping \-\-return pushover \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return pushover \-\-return_kwargs \(aq{\(dqtitle\(dq: \(dqSalt is awesome!\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.pushover_returner.returner(ret)
Send an PushOver message with the data
.UNINDENT
.SS salt.returners.rawfile_json
.sp
Take data from salt and \(dqreturn\(dq it into a raw file containing the json, with
one line per event.
.sp
Add the following to the minion or master configuration file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rawfile_json.filename: <path_to_output_file>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Default is \fB/var/log/salt/events\fP\&.
.sp
Common use is to log all events on the master. This can generate a lot of
noise, so you may wish to configure batch processing and/or configure the
\fI\%event_return_whitelist\fP or \fI\%event_return_blacklist\fP
to restrict the events that are written.
.INDENT 0.0
.TP
.B salt.returners.rawfile_json.event_return(events)
Write event data (return data and non\-return data) to file on the master.
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.rawfile_json.returner(ret)
Write the return data to a file on the minion.
.UNINDENT
.SS salt.returners.redis_return
.sp
Return data to a redis server
.sp
To enable this returner the minion will need the python client for redis
installed and the following values configured in the minion or master
config, these are the defaults:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
redis.db: \(aq0\(aq
redis.host: \(aqsalt\(aq
redis.port: 6379
redis.password: \(aq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1: Alternatively a UNIX socket can be specified by \fIunix_socket_path\fP:

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
redis.db: \(aq0\(aq
redis.unix_socket_path: /var/run/redis/redis.sock
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Cluster Mode Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
redis.db: \(aq0\(aq
redis.cluster_mode: true
redis.cluster.skip_full_coverage_check: true
redis.cluster.startup_nodes:
  \- host: redis\-member\-1
    port: 6379
  \- host: redis\-member\-2
    port: 6379
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.redis.db: \(aq0\(aq
alternative.redis.host: \(aqsalt\(aq
alternative.redis.port: 6379
alternative.redis.password: \(aq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the redis returner, append \(aq\-\-return redis\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return redis
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return redis \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return redis \-\-return_kwargs \(aq{\(dqdb\(dq: \(dqanother\-salt\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Redis Cluster Mode Options:
.INDENT 0.0
.TP
.B cluster_mode: \fBFalse\fP
Whether cluster_mode is enabled or not
.TP
.B cluster.startup_nodes:
A list of host, port dictionaries pointing to cluster members. At least one is required
but multiple nodes are better
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
redis.cluster.startup_nodes
  \- host: redis\-member\-1
    port: 6379
  \- host: redis\-member\-2
    port: 6379
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B cluster.skip_full_coverage_check: \fBFalse\fP
Some cluster providers restrict certain redis commands such as CONFIG for enhanced security.
Set this option to true to skip checks that required advanced privileges.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Most cloud hosted redis clusters will require this to be set to \fBTrue\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.redis_return.clean_old_jobs()
Clean out minions\(aqs return data for old jobs.
.sp
Normally, hset \(aqret:<jid>\(aq are saved with a TTL, and will eventually
get cleaned by redis.But for jobs with some very late minion return, the
corresponding hset\(aqs TTL will be refreshed to a too late timestamp, we\(aqll
do manually cleaning here.
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.redis_return.get_fun(fun)
Return a dict of the last function called for all minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.redis_return.get_jid(jid)
Return the information returned when the specified job id was executed
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.redis_return.get_jids()
Return a dict mapping all job ids to job information
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.redis_return.get_load(jid)
Return the load data that marks a specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.redis_return.get_minions()
Return a list of minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.redis_return.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.redis_return.returner(ret)
Return data to a redis data store
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.redis_return.save_load(jid, load, minions=None)
Save the load to the specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.redis_return.save_minions(jid, minions, syndic_id=None)
Included for API consistency
.UNINDENT
.SS salt.returners.sentry_return
.sp
Salt returner that reports execution results back to sentry. The returner will
inspect the payload to identify errors and flag them as such.
.sp
Pillar needs something like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
raven:
  servers:
    \- http://192.168.1.1
    \- https://sentry.example.com
  public_key: deadbeefdeadbeefdeadbeefdeadbeef
  secret_key: beefdeadbeefdeadbeefdeadbeefdead
  project: 1
  tags:
    \- os
    \- master
    \- saltversion
    \- cpuarch
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or using a dsn:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
raven:
  dsn: https://aaaa:bbbb@app.getsentry.com/12345
  tags:
    \- os
    \- master
    \- saltversion
    \- cpuarch
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fI\%https://pypi.python.org/pypi/raven\fP must be installed.
.sp
The pillar can be hidden on sentry return by setting hide_pillar: true.
.sp
The tags list (optional) specifies grains items that will be used as sentry
tags, allowing tagging of events in the sentry ui.
.sp
To report only errors to sentry, set report_errors_only: true.
.INDENT 0.0
.TP
.B salt.returners.sentry_return.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.sentry_return.returner(ret)
Log outcome to sentry. The returner tries to identify errors and report
them as such. All other messages will be reported at info level.
Failed states will be appended as separate list for convenience.
.UNINDENT
.SS salt.returners.slack_returner
.sp
Return salt data via slack
.sp
New in version 2015.5.0.

.sp
The following fields can be set in the minion conf file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
slack.channel (required)
slack.api_key (required)
slack.username (required)
slack.as_user (required to see the profile picture of your bot)
slack.profile (optional)
slack.changes(optional, only show changes and failed states)
slack.only_show_failed(optional, only show failed states)
slack.yaml_format(optional, format the json in yaml format)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
slack.channel
slack.api_key
slack.username
slack.as_user
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Slack settings may also be configured as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
slack:
    channel: RoomName
    api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    username: user
    as_user: true

alternative.slack:
    room_id: RoomName
    api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    from_name: user@email.com

slack_profile:
    slack.api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    slack.from_name: user@email.com

slack:
    profile: slack_profile
    channel: RoomName

alternative.slack:
    profile: slack_profile
    channel: RoomName
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the Slack returner, append \(aq\-\-return slack\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return slack
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return slack \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return slack \-\-return_kwargs \(aq{\(dqchannel\(dq: \(dq#random\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.slack_returner.returner(ret)
Send an slack message with the data
.UNINDENT
.SS salt.returners.slack_webhook_return
.sp
Return salt data via Slack using Incoming Webhooks
.INDENT 0.0
.TP
.B codeauthor
\fICarlos D. Álvaro <github@cdalvaro.io>\fP
.UNINDENT
.sp
The following fields can be set in the minion conf file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
slack_webhook.webhook (required, the webhook id. Just the part after: \(aqhttps://hooks.slack.com/services/\(aq)
slack_webhook.success_title (optional, short title for succeeded states. By default: \(aq{id} | Succeeded\(aq)
slack_webhook.failure_title (optional, short title for failed states. By default: \(aq{id} | Failed\(aq)
slack_webhook.author_icon (optional, a URL that with a small 16x16px image. Must be of type: GIF, JPEG, PNG, and BMP)
slack_webhook.show_tasks (optional, show identifiers for changed and failed tasks. By default: False)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
slack_webhook.webhook
slack_webhook.success_title
slack_webhook.failure_title
slack_webhook.author_icon
slack_webhook.show_tasks
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Slack settings may also be configured as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
slack_webhook:
  webhook: T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
  success_title: \(aq[{id}] | Success\(aq
  failure_title: \(aq[{id}] | Failure\(aq
  author_icon: https://platform.slack\-edge.com/img/default_application_icon.png
  show_tasks: true

alternative.slack_webhook:
  webhook: T00000000/C00000000/YYYYYYYYYYYYYYYYYYYYYYYY
  show_tasks: false
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the Slack returner,
append \(aq\-\-return slack_webhook\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return slack_webhook
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration,
append \(aq\-\-return_config alternative\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return slack_webhook \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.slack_webhook_return.event_return(events)
Send event data to returner function
:param events: The Salt event return
:return: The result of the post
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.slack_webhook_return.returner(ret, **kwargs)
Send a slack message with the data through a webhook
:param ret: The Salt return
:return: The result of the post
.UNINDENT
.SS salt.returners.sms_return
.sp
Return data by SMS.
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B maintainer
Damian Myerscough
.TP
.B maturity
new
.TP
.B depends
twilio
.TP
.B platform
all
.UNINDENT
.sp
To enable this returner the minion will need the python twilio library
installed and the following values configured in the minion or master
config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
twilio.sid: \(aqXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\(aq
twilio.token: \(aqXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\(aq
twilio.to: \(aq+1415XXXXXXX\(aq
twilio.from: \(aq+1650XXXXXXX\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the sms returner, append \(aq\-\-return sms\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return sms
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.sms_return.returner(ret)
Return a response in an SMS message
.UNINDENT
.SS salt.returners.smtp_return
.sp
Return salt data via email
.sp
The following fields can be set in the minion conf file. Fields are optional
unless noted otherwise.
.INDENT 0.0
.IP \(bu 2
\fBfrom\fP (required) The name/address of the email sender.
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBto\fP (required) The names/addresses of the email recipients;
comma\-delimited. For example: \fByou@example.com,someoneelse@example.com\fP\&.
.UNINDENT
.IP \(bu 2
\fBhost\fP (required) The SMTP server hostname or address.
.IP \(bu 2
\fBport\fP The SMTP server port; defaults to \fB25\fP\&.
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBusername\fP The username used to authenticate to the server. If specified a
password is also required. It is recommended but not required to also use
TLS with this option.
.UNINDENT
.IP \(bu 2
\fBpassword\fP The password used to authenticate to the server.
.IP \(bu 2
\fBtls\fP Whether to secure the connection using TLS; defaults to \fBFalse\fP
.IP \(bu 2
\fBsubject\fP The email subject line.
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBfields\fP Which fields from the returned data to include in the subject line
of the email; comma\-delimited. For example: \fBid,fun\fP\&. Please note, \fIthe
subject line is not encrypted\fP\&.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBgpgowner\fP A user\(aqs \fB~/.gpg\fP directory. This must contain a gpg
public key matching the address the mail is sent to. If left unset, no
encryption will be used. Requires \fBpython\-gnupg\fP to be installed.
.UNINDENT
.IP \(bu 2
\fBtemplate\fP The path to a file to be used as a template for the email body.
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBrenderer\fP A Salt renderer, or render\-pipe, to use to render the email
template. Default \fBjinja\fP\&.
.UNINDENT
.UNINDENT
.sp
Below is an example of the above settings in a Salt Minion configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
smtp.from: me@example.net
smtp.to: you@example.com
smtp.host: localhost
smtp.port: 1025
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.smtp.username: saltdev
alternative.smtp.password: saltdev
alternative.smtp.tls: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the SMTP returner, append \(aq\-\-return smtp\(aq to the \fBsalt\fP command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return smtp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the \fBsalt\fP command.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return smtp \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the
\fBsalt\fP command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return smtp \-\-return_kwargs \(aq{\(dqto\(dq: \(dquser@domain.com\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
An easy way to test the SMTP returner is to use the development SMTP server
built into Python. The command below will start a single\-threaded SMTP server
that prints any email it receives to the console.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m smtpd \-n \-c DebuggingServer localhost:1025
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.sp
It is possible to send emails with selected Salt events by configuring \fBevent_return\fP option
for Salt Master. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
event_return: smtp

event_return_whitelist:
  \- salt/key

smtp.from: me@example.net
smtp.to: you@example.com
smtp.host: localhost
smtp.subject: \(aqSalt Master {{act}}ed key from Minion ID: {{id}}\(aq
smtp.template: /srv/salt/templates/email.j2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Also you need to create additional file \fB/srv/salt/templates/email.j2\fP with email body template:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
act: {{act}}
id: {{id}}
result: {{result}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This configuration enables Salt Master to send an email when accepting or rejecting minions keys.
.INDENT 0.0
.TP
.B salt.returners.smtp_return.event_return(events)
Return event data via SMTP
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.smtp_return.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.smtp_return.returner(ret)
Send an email with the data
.UNINDENT
.SS salt.returners.splunk
.sp
Send json response data to Splunk via the HTTP Event Collector
Requires the following config values to be specified in config or pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
splunk_http_forwarder:
  token: <splunk_http_forwarder_token>
  indexer: <hostname/IP of Splunk indexer>
  sourcetype: <Destination sourcetype for data>
  index: <Destination index for data>
  verify_ssl: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Run a test by using \fBsalt\-call test.ping \-\-return splunk\fP
.sp
Written by Scott Pack (github.com/scottjpack)
.INDENT 0.0
.TP
.B salt.returners.splunk.event_return(events)
Return events to Splunk via the HTTP Event Collector.
Requires the Splunk HTTP Event Collector running on port 8088.
This is available on Splunk Enterprise version 6.3 or higher.
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.returners.splunk.http_event_collector(token, http_event_server, host=\(aq\(aq, http_event_port=\(aq8088\(aq, http_event_server_ssl=True, max_bytes=100000, verify_ssl=True)
.INDENT 7.0
.TP
.B sendEvent(payload, eventtime=\(aq\(aq)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.splunk.returner(ret)
Send a message to Splunk via the HTTP Event Collector.
Requires the Splunk HTTP Event Collector running on port 8088.
This is available on Splunk Enterprise version 6.3 or higher.
.UNINDENT
.SS salt.returners.sqlite3
.sp
Insert minion return data into a sqlite3 database
.INDENT 0.0
.TP
.B maintainer
Mickey Malone <\fI\%mickey.malone@gmail.com\fP>
.TP
.B maturity
New
.TP
.B depends
None
.TP
.B platform
All
.UNINDENT
.sp
Sqlite3 is a serverless database that lives in a single file.
In order to use this returner the database file must exist,
have the appropriate schema defined, and be accessible to the
user whom the minion process is running as. This returner
requires the following values configured in the master or
minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sqlite3.database: /usr/lib/salt/salt.db
sqlite3.timeout: 5.0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.sqlite3.database: /usr/lib/salt/salt.db
alternative.sqlite3.timeout: 5.0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Use the commands to create the sqlite3 database and tables:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sqlite3 /usr/lib/salt/salt.db << EOF
\-\-
\-\- Table structure for table \(aqjids\(aq
\-\-

CREATE TABLE jids (
  jid TEXT PRIMARY KEY,
  load TEXT NOT NULL
  );

\-\-
\-\- Table structure for table \(aqsalt_returns\(aq
\-\-

CREATE TABLE salt_returns (
  fun TEXT KEY,
  jid TEXT KEY,
  id TEXT KEY,
  fun_args TEXT,
  date TEXT NOT NULL,
  full_ret TEXT NOT NULL,
  success TEXT NOT NULL
  );
EOF
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the sqlite returner, append \(aq\-\-return sqlite3\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return sqlite3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return sqlite3 \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return sqlite3 \-\-return_kwargs \(aq{\(dqdb\(dq: \(dq/var/lib/salt/another\-salt.db\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.sqlite3_return.get_fun(fun)
Return a dict of the last function called for all minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.sqlite3_return.get_jid(jid)
Return the information returned from a specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.sqlite3_return.get_jids()
Return a list of all job ids
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.sqlite3_return.get_load(jid)
Return the load from a specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.sqlite3_return.get_minions()
Return a list of minions
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.sqlite3_return.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.sqlite3_return.returner(ret)
Insert minion return data into the sqlite3 database
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.sqlite3_return.save_load(jid, load, minions=None)
Save the load to the specified jid
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.sqlite3_return.save_minions(jid, minions, syndic_id=None)
Included for API consistency
.UNINDENT
.SS salt.returners.syslog_return
.sp
Return data to the host operating system\(aqs syslog facility
.sp
To use the syslog returner, append \(aq\-\-return syslog\(aq to the
salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return syslog
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following fields can be set in the minion conf file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
syslog.level (optional, Default: LOG_INFO)
syslog.facility (optional, Default: LOG_USER)
syslog.tag (optional, Default: salt\-minion)
syslog.options (list, optional, Default: [])
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Available levels, facilities, and options can be found in the
\fBsyslog\fP docs for your python version.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The default tag comes from \fBsys.argv[0]\fP which is
usually \(dqsalt\-minion\(dq but could be different based on
the specific environment.
.UNINDENT
.UNINDENT
.sp
Configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
syslog.level: \(aqLOG_ERR\(aq
syslog.facility: \(aqLOG_DAEMON\(aq
syslog.tag: \(aqmysalt\(aq
syslog.options:
  \- LOG_PID
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Of course you can also nest the options:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
syslog:
  level: \(aqLOG_ERR\(aq
  facility: \(aqLOG_DAEMON\(aq
  tag: \(aqmysalt\(aq
  options:
    \- LOG_PID
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by
prefacing the configuration. Any values not found
in the alternative configuration will be pulled from
the default location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alternative.syslog.level: \(aqLOG_WARN\(aq
alternative.syslog.facility: \(aqLOG_NEWS\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append
\fB\-\-return_config alternative\fP to the salt command.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return syslog \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append
\-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return syslog \-\-return_kwargs \(aq{\(dqlevel\(dq: \(dqLOG_DEBUG\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Syslog server implementations may have limits on the maximum
record size received by the client. This may lead to job
return data being truncated in the syslog server\(aqs logs. For
example, for rsyslog on RHEL\-based systems, the default
maximum record size is approximately 2KB (which return data
can easily exceed). This is configurable in rsyslog.conf via
the $MaxMessageSize config parameter. Please consult your syslog
implmentation\(aqs documentation to determine how to adjust this limit.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.syslog_return.prep_jid(nocache=False, passed_jid=None)
Do any work necessary to prepare a JID, including sending a custom id
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.syslog_return.returner(ret)
Return data to the local syslog
.UNINDENT
.SS salt.returners.telegram_return
.sp
Return salt data via Telegram.
.sp
The following fields can be set in the minion conf file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
telegram.chat_id (required)
telegram.token (required)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Telegram settings may also be configured as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
telegram:
  chat_id: 000000000
  token: 000000000:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the Telegram return, append \(aq\-\-return telegram\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return telegram
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.telegram_return.returner(ret)
Send a Telegram message with the data.
.INDENT 7.0
.TP
.B Parameters
\fBret\fP \-\- The data to be sent.
.TP
.B Returns
Boolean if message was sent successfully.
.UNINDENT
.UNINDENT
.SS salt.returners.xmpp_return
.sp
Return salt data via xmpp
.INDENT 0.0
.TP
.B depends
sleekxmpp >= 1.3.1
.UNINDENT
.sp
The following fields can be set in the minion conf file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
xmpp.jid (required)
xmpp.password (required)
xmpp.recipient (required)
xmpp.profile (optional)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
xmpp.jid
xmpp.password
xmpp.recipient
xmpp.profile
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
XMPP settings may also be configured as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
xmpp:
    jid: user@xmpp.domain.com/resource
    password: password
    recipient: user@xmpp.example.com

alternative.xmpp:
    jid: user@xmpp.domain.com/resource
    password: password
    recipient: someone@xmpp.example.com

xmpp_profile:
    xmpp.jid: user@xmpp.domain.com/resource
    xmpp.password: password

xmpp:
    profile: xmpp_profile
    recipient: user@xmpp.example.com

alternative.xmpp:
    profile: xmpp_profile
    recipient: someone\-else@xmpp.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the XMPP returner, append \(aq\-\-return xmpp\(aq to the salt command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return xmpp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the alternative configuration, append \(aq\-\-return_config alternative\(aq to the salt command.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return xmpp \-\-return_config alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To override individual configuration items, append \-\-return_kwargs \(aq{\(dqkey:\(dq: \(dqvalue\(dq}\(aq to the salt command.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return xmpp \-\-return_kwargs \(aq{\(dqrecipient\(dq: \(dqsomeone\-else@xmpp.example.com\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.returners.xmpp_return.SendMsgBot(jid, password, recipient, msg)
.INDENT 7.0
.TP
.B start(event)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.xmpp_return.returner(ret)
Send an xmpp message with the data
.UNINDENT
.SS salt.returners.zabbix_return
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%zabbix Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Return salt data to Zabbix
.sp
The following Type: \(dqZabbix trapper\(dq with \(dqType of information\(dq Text items are required:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Key: salt.trap.info
Key: salt.trap.warning
Key: salt.trap.high
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use the Zabbix returner, append \(aq\-\-return zabbix\(aq to the salt command. ex:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping \-\-return zabbix
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.zabbix_return.returner(ret)
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.zabbix_return.save_load(jid, load, minions=None)
Included for API consistency
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.zabbix_return.zabbix_send(key, output)
.UNINDENT
.INDENT 0.0
.TP
.B salt.returners.zabbix_return.zbx()
.UNINDENT
.SS Executors
.sp
Executors are used by minion to execute module functions. Executors can be used
to modify the functions behavior, do any pre\-execution steps or execute in a
specific way like sudo executor.
.sp
Executors could be passed as a list and they will be used one\-by\-one in the
order. If an executor returns \fBNone\fP the next one will be called. If an
executor returns non\-\fBNone\fP the execution sequence is terminated and the
returned value is used as a result. It\(aqs a way executor could control modules
execution working as a filter. Note that executor could actually not execute
the function but just do something else and return \fBNone\fP like \fBsplay\fP
executor does. In this case some other executor have to be used as a final
executor that will actually execute the function. See examples below.
.sp
Executors list could be passed by minion config file in the following way:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
module_executors:
  \- splay
  \- direct_call
splaytime: 30
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The same could be done by command line:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-t 40 \-\-module\-executors=\(aq[splay, direct_call]\(aq \-\-executor\-opts=\(aq{splaytime: 30}\(aq \(aq*\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And the same command called via netapi will look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sSk https://localhost:8000 \e
    \-H \(aqAccept: application/x\-yaml\(aq \e
    \-H \(aqX\-Auth\-Token: 697adbdc8fe971d09ae4c2a3add7248859c87079\(aq \e
    \-H \(aqContent\-type: application/json\(aq \e
    \-d \(aq[{
        \(dqclient\(dq: \(dqlocal\(dq,
        \(dqtgt\(dq: \(dq*\(dq,
        \(dqfun\(dq: \(dqtest.version\(dq,
        \(dqmodule_executors\(dq: [\(dqsplay\(dq, \(dqdirect_call\(dq],
        \(dqexecutor_opts\(dq: {\(dqsplaytime\(dq: 10}
        }]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%The full list of executors\fP
.UNINDENT
.UNINDENT
.SS Writing Salt Executors
.sp
A Salt executor is written in a similar manner to a Salt execution module.
Executor is a python module placed into the \fBexecutors\fP folder and containing
the \fBexecute\fP function with the following signature:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def execute(opts, data, func, args, kwargs): ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Where the args are:
.INDENT 0.0
.TP
.B \fBopts\fP:
Dictionary containing the minion configuration options
.TP
.B \fBdata\fP:
Dictionary containing the load data including \fBexecutor_opts\fP passed via
cmdline/API.
.TP
.B \fBfunc\fP, \fBargs\fP, \fBkwargs\fP:
Execution module function to be executed and its arguments. For instance the
simplest \fBdirect_call\fP executor just runs it as \fBfunc(*args, **kwargs)\fP\&.
.TP
.B \fBReturns\fP:
\fBNone\fP if the execution sequence must be continued with the next executor.
Error string or execution result if the job is done and execution must be
stopped.
.UNINDENT
.sp
Specific options could be passed to the executor via minion config or via
\fBexecutor_opts\fP argument. For instance to access \fBsplaytime\fP option set by
minion config executor should access \fBopts.get(\(aqsplaytime\(aq)\fP\&. To access the
option set by commandline or API \fBdata.get(\(aqexecutor_opts\(aq,
{}).get(\(aqsplaytime\(aq)\fP should be used. So if an option is safe and must be
accessible by user executor should check it in both places, but if an option is
unsafe it should be read from the only config ignoring the passed request data.
.sp
There is also a function named \fBall_missing_func\fP which the name of the
\fBfunc\fP is passed, which can be used to verify if the command should still be
run, even if it is not loaded in minion_mods.
.SH CONFIGURATION MANAGEMENT
.sp
Salt contains a robust and flexible configuration management framework, which
is built on the remote execution core. This framework executes on the minions,
allowing effortless, simultaneous configuration of tens of thousands of hosts,
by rendering language specific state files. The following links provide
resources to learn more about state and renderers.
.INDENT 0.0
.TP
\fBStates\fP
Express the state of a host using small, easy to read, easy to
understand configuration files. \fINo programming required\fP\&.
.INDENT 7.0
.TP
.B \fI\%Full list of states\fP
Contains: list of install packages, create users, transfer files, start
services, and so on.
.TP
.B \fI\%Pillar System\fP
Contains: description of Salt\(aqs Pillar system.
.TP
.B \fI\%Highstate data structure\fP
Contains: a dry vocabulary and technical representation of the
configuration format that states represent.
.TP
.B \fI\%Writing states\fP
Contains: a guide on how to write Salt state modules, easily extending
Salt to directly manage more software.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Salt execution modules are different from state modules and cannot be
called as a state in an SLS file. In other words, this will not work:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
moe:
  user.rename:
    \- new_name: larry
    \- onlyif: id moe
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You must use the \fI\%module\fP states to call
execution modules directly. Here\(aqs an example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rename_moe:
  module.run:
    \- name: user.rename
    \- m_name: moe
    \- new_name: larry
    \- onlyif: id moe
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
\fBRenderers\fP
Renderers use state configuration files written in a variety of languages,
templating engines, or files. Salt\(aqs configuration management system is,
under the hood, language agnostic.
.INDENT 7.0
.TP
.B \fI\%Full list of renderers\fP
Contains: a list of renderers.
YAML is one choice, but many systems are available, from
alternative templating engines to the PyDSL language for rendering
sls formulas.
.TP
.B \fI\%Renderers\fP
Contains: more information about renderers. Salt states are only
concerned with the ultimate highstate data structure, not how the
data structure was created.
.UNINDENT
.UNINDENT
.SS State System Reference
.sp
Salt offers an interface to manage the configuration or \(dqstate\(dq of the
Salt minions. This interface is a fully capable mechanism used to enforce the
state of systems from a central manager.
.SS Mod Aggregate State Runtime Modifications
.sp
New in version 2014.7.0.

.sp
The mod_aggregate system was added in the 2014.7.0 release of Salt and allows for
runtime modification of the executing state data. Simply put, it allows for the
data used by Salt\(aqs state system to be changed on the fly at runtime, kind of
like a configuration management JIT compiler or a runtime import system. All in
all, it makes Salt much more dynamic.
.SS How it Works
.sp
The best example is the \fBpkg\fP state. One of the major requests in Salt has long
been adding the ability to install all packages defined at the same time. The
mod_aggregate system makes this a reality. While executing Salt\(aqs state system,
when a \fBpkg\fP state is reached the \fBmod_aggregate\fP function in the state module
is called. For \fBpkg\fP this function scans all of the other states that are slated
to run, and picks up the references to \fBname\fP and \fBpkgs\fP, then adds them to
\fBpkgs\fP in the first state. The result is a single call to yum, apt\-get,
pacman, etc as part of the first package install.
.SS How to Use it
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Since this option changes the basic behavior of the state runtime, after
it is enabled states should be executed using \fItest=True\fP to ensure that
the desired behavior is preserved.
.UNINDENT
.UNINDENT
.SS In config files
.sp
The first way to enable aggregation is with a configuration option in either
the master or minion configuration files. Salt will invoke \fBmod_aggregate\fP
the first time it encounters a state module that has aggregate support.
.sp
If this option is set in the master config it will apply to all state runs on
all minions, if set in the minion config it will only apply to said minion.
.sp
Enable for all states:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_aggregate: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Enable for only specific state modules:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_aggregate:
  \- pkg
.ft P
.fi
.UNINDENT
.UNINDENT
.SS In states
.sp
The second way to enable aggregation is with the state\-level \fBaggregate\fP
keyword. In this configuration, Salt will invoke the \fBmod_aggregate\fP function
the first time it encounters this keyword. Any additional occurrences of the
keyword will be ignored as the aggregation has already taken place.
.sp
The following example will trigger \fBmod_aggregate\fP when the \fBlamp_stack\fP
state is processed resulting in a single call to the underlying package
manager.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lamp_stack:
  pkg.installed:
    \- pkgs:
      \- php
      \- mysql\-client
    \- aggregate: True

memcached:
  pkg.installed:
    \- name: memcached
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Adding mod_aggregate to a State Module
.sp
Adding a mod_aggregate routine to an existing state module only requires adding
an additional function to the state module called mod_aggregate.
.sp
The mod_aggregate function just needs to accept three parameters and return the
low data to use. Since mod_aggregate is working on the state runtime level it
does need to manipulate \fIlow data\fP\&.
.sp
The three parameters are \fIlow\fP, \fIchunks\fP, and \fIrunning\fP\&. The \fIlow\fP option is the
low data for the state execution which is about to be called. The \fIchunks\fP is
the list of all of the low data dictionaries which are being executed by the
runtime and the \fIrunning\fP dictionary is the return data from all of the state
executions which have already be executed.
.sp
This example, simplified from the pkg state, shows how to create mod_aggregate functions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def mod_aggregate(low, chunks, running):
    \(dq\(dq\(dq
    The mod_aggregate function which looks up all packages in the available
    low chunks and merges them into a single pkgs ref in the present low data
    \(dq\(dq\(dq
    pkgs = []
    # What functions should we aggregate?
    agg_enabled = [
        \(dqinstalled\(dq,
        \(dqlatest\(dq,
        \(dqremoved\(dq,
        \(dqpurged\(dq,
    ]
    # The \(galow\(ga data is just a dict with the state, function (fun) and
    # arguments passed in from the sls
    if low.get(\(dqfun\(dq) not in agg_enabled:
        return low
    # Now look into what other things are set to execute
    for chunk in chunks:
        # The state runtime uses \(dqtags\(dq to track completed jobs, it may
        # look familiar with the _|\-
        tag = __utils__[\(dqstate.gen_tag\(dq](chunk)
        if tag in running:
            # Already ran the pkg state, skip aggregation
            continue
        if chunk.get(\(dqstate\(dq) == \(dqpkg\(dq:
            if \(dq__agg__\(dq in chunk:
                continue
            # Check for the same function
            if chunk.get(\(dqfun\(dq) != low.get(\(dqfun\(dq):
                continue
            # Pull out the pkg names!
            if \(dqpkgs\(dq in chunk:
                pkgs.extend(chunk[\(dqpkgs\(dq])
                chunk[\(dq__agg__\(dq] = True
            elif \(dqname\(dq in chunk:
                pkgs.append(chunk[\(dqname\(dq])
                chunk[\(dq__agg__\(dq] = True
    if pkgs:
        if \(dqpkgs\(dq in low:
            low[\(dqpkgs\(dq].extend(pkgs)
        else:
            low[\(dqpkgs\(dq] = pkgs
    # The low has been modified and needs to be returned to the state
    # runtime for execution
    return low
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Altering States
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This documentation has been moved \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.SS File State Backups
.sp
In 0.10.2 a new feature was added for backing up files that are replaced by
the file.managed and file.recurse states. The new feature is called the backup
mode. Setting the backup mode is easy, but it can be set in a number of
places.
.sp
The backup_mode can be set in the minion config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
backup_mode: minion
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or it can be set for each file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/ssh/sshd_config:
  file.managed:
    \- source: salt://ssh/sshd_config
    \- backup: minion
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The backup_mode can be set to any of the following options:
.INDENT 0.0
.IP \(bu 2
\fBminion\fP: backup to the minion.
.IP \(bu 2
\fBmaster\fP: backup to the master, a planned mode that has not yet been implemented, so does nothing.
.IP \(bu 2
\fBboth\fP: backup to both. a combination of both master and minion.
.UNINDENT
.SS Backed\-up Files
.sp
The files will be saved in the minion cachedir under the directory named
\fBfile_backup\fP\&. The files will be in the location relative to where they
were under the root filesystem and be appended with a timestamp. This should
make them easy to browse.
.SS Interacting with Backups
.sp
Starting with version 0.17.0, it will be possible to list, restore, and delete
previously\-created backups.
.SS Listing
.sp
The backups for a given file can be listed using \fI\%file.list_backups\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt foo.bar.com file.list_backups /tmp/foo.txt
foo.bar.com:
    \-\-\-\-\-\-\-\-\-\-
    0:
        \-\-\-\-\-\-\-\-\-\-
        Backup Time:
            Sat Jul 27 2013 17:48:41.738027
        Location:
            /var/cache/salt/minion/file_backup/tmp/foo.txt_Sat_Jul_27_17:48:41_738027_2013
        Size:
            13
    1:
        \-\-\-\-\-\-\-\-\-\-
        Backup Time:
            Sat Jul 27 2013 17:48:28.369804
        Location:
            /var/cache/salt/minion/file_backup/tmp/foo.txt_Sat_Jul_27_17:48:28_369804_2013
        Size:
            35
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Restoring
.sp
Restoring is easy using \fI\%file.restore_backup\fP, just pass the path and the numeric id
found with \fI\%file.list_backups\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt foo.bar.com file.restore_backup /tmp/foo.txt 1
foo.bar.com:
    \-\-\-\-\-\-\-\-\-\-
    comment:
        Successfully restored /var/cache/salt/minion/file_backup/tmp/foo.txt_Sat_Jul_27_17:48:28_369804_2013 to /tmp/foo.txt
    result:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The existing file will be backed up, just in case, as can be seen if
\fI\%file.list_backups\fP is run again:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt foo.bar.com file.list_backups /tmp/foo.txt
foo.bar.com:
    \-\-\-\-\-\-\-\-\-\-
    0:
        \-\-\-\-\-\-\-\-\-\-
        Backup Time:
            Sat Jul 27 2013 18:00:19.822550
        Location:
            /var/cache/salt/minion/file_backup/tmp/foo.txt_Sat_Jul_27_18:00:19_822550_2013
        Size:
            53
    1:
        \-\-\-\-\-\-\-\-\-\-
        Backup Time:
            Sat Jul 27 2013 17:48:41.738027
        Location:
            /var/cache/salt/minion/file_backup/tmp/foo.txt_Sat_Jul_27_17:48:41_738027_2013
        Size:
            13
    2:
        \-\-\-\-\-\-\-\-\-\-
        Backup Time:
            Sat Jul 27 2013 17:48:28.369804
        Location:
            /var/cache/salt/minion/file_backup/tmp/foo.txt_Sat_Jul_27_17:48:28_369804_2013
        Size:
            35
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Since no state is being run, restoring a file will not trigger any watches
for the file. So, if you are restoring a config file for a service, it will
likely still be necessary to run a \fBservice.restart\fP\&.
.UNINDENT
.UNINDENT
.SS Deleting
.sp
Deleting backups can be done using \fI\%file.delete_backup\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt foo.bar.com file.delete_backup /tmp/foo.txt 0
foo.bar.com:
    \-\-\-\-\-\-\-\-\-\-
    comment:
        Successfully removed /var/cache/salt/minion/file_backup/tmp/foo.txt_Sat_Jul_27_18:00:19_822550_2013
    result:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Understanding State Compiler Ordering
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This tutorial is an intermediate level tutorial. Some basic understanding
of the state system and writing Salt Formulas is assumed.
.UNINDENT
.UNINDENT
.sp
Salt\(aqs state system is built to deliver all of the power of configuration
management systems without sacrificing simplicity. This tutorial is made to
help users understand in detail just how the order is defined for state
executions in Salt.
.sp
This tutorial is written to represent the behavior of Salt as of version
0.17.0.
.SS Compiler Basics
.sp
To understand ordering in depth some very basic knowledge about the state
compiler is very helpful. No need to worry though, this is very high level!
.SS High Data and Low Data
.sp
When defining Salt Formulas in YAML the data that is being represented is
referred to by the compiler as High Data. When the data is initially
loaded into the compiler it is a single large python dictionary, this
dictionary can be viewed raw by running:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.show_highstate
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This \(dqHigh Data\(dq structure is then compiled down to \(dqLow Data\(dq. The Low
Data is what is matched up to create individual executions in Salt\(aqs
configuration management system. The
low data is an ordered list of single state calls to execute. Once the
low data is compiled the evaluation order can be seen.
.sp
The low data can be viewed by running:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.show_lowstate
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The state execution module contains MANY functions for evaluating the
state system and is well worth a read! These routines can be very useful
when debugging states or to help deepen one\(aqs understanding of Salt\(aqs
state system.
.UNINDENT
.UNINDENT
.sp
As an example, a state written thusly:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  pkg.installed:
    \- name: httpd
  service.running:
    \- name: httpd
    \- watch:
      \- file: apache_conf
      \- pkg: apache

apache_conf:
  file.managed:
    \- name: /etc/httpd/conf.d/httpd.conf
    \- source: salt://apache/httpd.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Will have High Data which looks like this represented in json:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqapache\(dq: {
        \(dqpkg\(dq: [
            {
                \(dqname\(dq: \(dqhttpd\(dq
            },
            \(dqinstalled\(dq,
            {
                \(dqorder\(dq: 10000
            }
        ],
        \(dqservice\(dq: [
            {
                \(dqname\(dq: \(dqhttpd\(dq
            },
            {
                \(dqwatch\(dq: [
                    {
                        \(dqfile\(dq: \(dqapache_conf\(dq
                    },
                    {
                        \(dqpkg\(dq: \(dqapache\(dq
                    }
                ]
            },
            \(dqrunning\(dq,
            {
                \(dqorder\(dq: 10001
            }
        ],
        \(dq__sls__\(dq: \(dqblah\(dq,
        \(dq__env__\(dq: \(dqbase\(dq
    },
    \(dqapache_conf\(dq: {
        \(dqfile\(dq: [
            {
                \(dqname\(dq: \(dq/etc/httpd/conf.d/httpd.conf\(dq
            },
            {
                \(dqsource\(dq: \(dqsalt://apache/httpd.conf\(dq
            },
            \(dqmanaged\(dq,
            {
                \(dqorder\(dq: 10002
            }
        ],
        \(dq__sls__\(dq: \(dqblah\(dq,
        \(dq__env__\(dq: \(dqbase\(dq
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The subsequent Low Data will look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[
    {
        \(dqname\(dq: \(dqhttpd\(dq,
        \(dqstate\(dq: \(dqpkg\(dq,
        \(dq__id__\(dq: \(dqapache\(dq,
        \(dqfun\(dq: \(dqinstalled\(dq,
        \(dq__env__\(dq: \(dqbase\(dq,
        \(dq__sls__\(dq: \(dqblah\(dq,
        \(dqorder\(dq: 10000
    },
    {
        \(dqname\(dq: \(dqhttpd\(dq,
        \(dqwatch\(dq: [
            {
                \(dqfile\(dq: \(dqapache_conf\(dq
            },
            {
                \(dqpkg\(dq: \(dqapache\(dq
            }
        ],
        \(dqstate\(dq: \(dqservice\(dq,
        \(dq__id__\(dq: \(dqapache\(dq,
        \(dqfun\(dq: \(dqrunning\(dq,
        \(dq__env__\(dq: \(dqbase\(dq,
        \(dq__sls__\(dq: \(dqblah\(dq,
        \(dqorder\(dq: 10001
    },
    {
        \(dqname\(dq: \(dq/etc/httpd/conf.d/httpd.conf\(dq,
        \(dqsource\(dq: \(dqsalt://apache/httpd.conf\(dq,
        \(dqstate\(dq: \(dqfile\(dq,
        \(dq__id__\(dq: \(dqapache_conf\(dq,
        \(dqfun\(dq: \(dqmanaged\(dq,
        \(dq__env__\(dq: \(dqbase\(dq,
        \(dq__sls__\(dq: \(dqblah\(dq,
        \(dqorder\(dq: 10002
    }
]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This tutorial discusses the Low Data evaluation and the state runtime.
.SS Ordering Layers
.sp
Salt defines 2 order interfaces which are evaluated in the state runtime and
defines these orders in a number of passes.
.SS Definition Order
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The Definition Order system can be disabled by turning the option
\fBstate_auto_order\fP to \fBFalse\fP in the master configuration file.
.UNINDENT
.UNINDENT
.sp
The top level of ordering is the \fIDefinition Order\fP\&. The \fIDefinition Order\fP
is the order in which states are defined in salt formulas. This is very
straightforward on basic states which do not contain \fBinclude\fP statements
or a \fBtop\fP file, as the states are just ordered from the top of the file,
but the include system starts to bring in some simple rules for how the
\fIDefinition Order\fP is defined.
.sp
Looking back at the \(dqLow Data\(dq and \(dqHigh Data\(dq shown above, the order key has
been transparently added to the data to enable the \fIDefinition Order\fP\&.
.SS The Include Statement
.sp
Basically, if there is an include statement in a formula, then the formulas
which are included will be run BEFORE the contents of the formula which
is including them. Also, the include statement is a list, so they will be
loaded in the order in which they are included.
.sp
In the following case:
.sp
\fBfoo.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- bar
  \- baz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBbar.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- quo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBbaz.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- qux
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above case if \fBstate.apply foo\fP were called then the formulas will be
loaded in the following order:
.INDENT 0.0
.IP 1. 3
quo
.IP 2. 3
bar
.IP 3. 3
qux
.IP 4. 3
baz
.IP 5. 3
foo
.UNINDENT
.SS The \fIorder\fP Flag
.sp
The \fIDefinition Order\fP happens transparently in the background, but the
ordering can be explicitly overridden using the \fBorder\fP flag in states:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  pkg.installed:
    \- name: httpd
    \- order: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This order flag will over ride the definition order, this makes it very
simple to create states that are always executed first, last or in specific
stages, a great example is defining a number of package repositories that
need to be set up before anything else, or final checks that need to be
run at the end of a state run by using \fBorder: last\fP or \fBorder: \-1\fP\&.
.sp
When the order flag is explicitly set the \fIDefinition Order\fP system will omit
setting an order for that state and directly use the order flag defined.
.SS Lexicographical Fall\-back
.sp
Salt states were written to ALWAYS execute in the same order. Before the
introduction of \fIDefinition Order\fP in version 0.17.0 everything was ordered
lexicographically according to the name of the state, then function then id.
.sp
This is the way Salt has always ensured that states always run in the same
order regardless of where they are deployed, the addition of the
\fIDefinition Order\fP method mealy makes this finite ordering easier to follow.
.sp
The lexicographical ordering is still applied but it only has any effect when
two order statements collide. This means that if multiple states are assigned
the same order number that they will fall back to lexicographical ordering
to ensure that every execution still happens in a finite order.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If running with \fBstate_auto_order: False\fP the \fBorder\fP key is not
set automatically, since the Lexicographical order can be derived
from other keys.
.UNINDENT
.UNINDENT
.SS Requisite Ordering
.sp
Salt states are fully declarative, in that they are written to declare the
state in which a system should be. This means that components can require that
other components have been set up successfully. Unlike the other ordering
systems, the \fIRequisite\fP system in Salt is evaluated at runtime.
.sp
The requisite system is also built to ensure that the ordering of execution
never changes, but is always the same for a given set of states. This is
accomplished by using a runtime that processes states in a completely
predictable order instead of using an event loop based system like other
declarative configuration management systems.
.SS Runtime Requisite Evaluation
.sp
The requisite system is evaluated as the components are found, and the
requisites are always evaluated in the same order. This explanation will
be followed by an example, as the raw explanation may be a little dizzying
at first as it creates a linear dependency evaluation sequence.
.sp
The \(dqLow Data\(dq is an ordered list or dictionaries, the state runtime evaluates
each dictionary in the order in which they are arranged in the list. When
evaluating a single dictionary it is checked for requisites, requisites are
evaluated in order, \fBrequire\fP then \fBwatch\fP then \fBprereq\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If using requisite in statements like require_in and watch_in these will
be compiled down to require and watch statements before runtime evaluation.
.UNINDENT
.UNINDENT
.sp
Each requisite contains an ordered list of requisites, these requisites are
looked up in the list of dictionaries and then executed. Once all requisites
have been evaluated and executed then the requiring state can safely be run
(or not run if requisites have not been met).
.sp
This means that the requisites are always evaluated in the same order, again
ensuring one of the core design principals of Salt\(aqs State system to ensure
that execution is always finite is intact.
.SS Simple Runtime Evaluation Example
.sp
Given the above \(dqLow Data\(dq the states will be evaluated in the following order:
.INDENT 0.0
.IP 1. 3
The pkg.installed is executed ensuring that the apache package is
installed, it contains no requisites and is therefore the first defined
state to execute.
.IP 2. 3
The service.running state is evaluated but NOT executed, a watch requisite
is found, therefore they are read in order, the runtime first checks for
the file, sees that it has not been executed and calls for the file state
to be evaluated.
.IP 3. 3
The file state is evaluated AND executed, since it, like the pkg state does
not contain any requisites.
.IP 4. 3
The evaluation of the service state continues, it next checks the pkg
requisite and sees that it is met, with all requisites met the service
state is now executed.
.UNINDENT
.SS Best Practice
.sp
The best practice in Salt is to choose a method and stick with it, official
states are written using requisites for all associations since requisites
create clean, traceable dependency trails and make for the most portable
formulas. To accomplish something similar to how classical imperative
systems function all requisites can be omitted and the \fBfailhard\fP option
then set to \fBTrue\fP in the master configuration, this will stop all state runs at
the first instance of a failure.
.sp
In the end, using requisites creates very tight and fine grained states,
not using requisites makes full sequence runs and while slightly easier
to write, and gives much less control over the executions.
.SS Extending External SLS Data
.sp
Sometimes a state defined in one SLS file will need to be modified from a
separate SLS file. A good example of this is when an argument needs to be
overwritten or when a service needs to watch an additional state.
.SS The Extend Declaration
.sp
The standard way to extend is via the extend declaration. The extend
declaration is a top level declaration like \fBinclude\fP and encapsulates ID
declaration data included from other SLS files. A standard extend looks like
this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- http
  \- ssh

extend:
  apache:
    file:
      \- name: /etc/httpd/conf/httpd.conf
      \- source: salt://http/httpd2.conf
  ssh\-server:
    service:
      \- watch:
        \- file: /etc/ssh/banner

/etc/ssh/banner:
  file.managed:
    \- source: salt://ssh/banner
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A few critical things happened here, first off the SLS files that are going to
be extended are included, then the extend dec is defined. Under the extend dec
2 IDs are extended, the apache ID\(aqs file state is overwritten with a new name
and source. Then the ssh server is extended to watch the banner file in
addition to anything it is already watching.
.SS Extend is a Top Level Declaration
.sp
This means that \fBextend\fP can only be called once in an sls, if it is used
twice then only one of the extend blocks will be read. So this is WRONG:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- http
  \- ssh

extend:
  apache:
    file:
      \- name: /etc/httpd/conf/httpd.conf
      \- source: salt://http/httpd2.conf
# Second extend will overwrite the first!! Only make one
extend:
  ssh\-server:
    service:
      \- watch:
        \- file: /etc/ssh/banner
.ft P
.fi
.UNINDENT
.UNINDENT
.SS The Requisite \(dqin\(dq Statement
.sp
Since one of the most common things to do when extending another SLS is to add
states for a service to watch, or anything for a watcher to watch, the
requisite in statement was added to 0.9.8 to make extending the watch and
require lists easier. The ssh\-server extend statement above could be more
cleanly defined like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- ssh

/etc/ssh/banner:
  file.managed:
    \- source: salt://ssh/banner
    \- watch_in:
      \- service: ssh\-server
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Rules to Extend By
.sp
There are a few rules to remember when extending states:
.INDENT 0.0
.IP 1. 3
Always include the SLS being extended with an include declaration
.IP 2. 3
Requisites (watch and require) are appended to, everything else is
overwritten
.IP 3. 3
extend is a top level declaration, like an ID declaration, cannot be
declared twice in a single SLS
.IP 4. 3
Many IDs can be extended under the extend declaration
.UNINDENT
.SS Failhard Global Option
.sp
Normally, when a state fails Salt continues to execute the remainder of the
defined states and will only refuse to execute states that require the failed
state.
.sp
But the situation may exist, where you would want all state execution to stop
if a single state execution fails. The capability to do this is called
\fBfailing hard\fP\&.
.SS State Level Failhard
.sp
A single state can have a failhard set, this means that if this individual
state fails that all state execution will immediately stop. This is a great
thing to do if there is a state that sets up a critical config file and
setting a require for each state that reads the config would be cumbersome.
A good example of this would be setting up a package manager early on:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/yum.repos.d/company.repo:
  file.managed:
    \- source: salt://company/yumrepo.conf
    \- user: root
    \- group: root
    \- mode: 644
    \- order: 1
    \- failhard: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this situation, the yum repo is going to be configured before other states,
and if it fails to lay down the config file, than no other states will be
executed.
It is possible to override a Global Failhard (see below) by explicitly setting
it to \fBFalse\fP in the state.
.SS Global Failhard
.sp
It may be desired to have failhard be applied to every state that is executed,
if this is the case, then failhard can be set in the master configuration
file. Setting failhard in the master configuration file will result in failing
hard when any minion gathering states from the master have a state fail.
.sp
This is NOT the default behavior, normally Salt will only fail states that
require a failed state.
.sp
Using the global failhard is generally not recommended, since it can result
in states not being executed or even checked. It can also be confusing to
see states failhard if an admin is not actively aware that the failhard has
been set.
.sp
To use the global failhard set \fI\%failhard\fP to \fBTrue\fP in the
master configuration file.
.SS Global State Arguments
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This documentation has been moved \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.SS Highstate data structure definitions
.SS The Salt State Tree
.sp
A state tree is a collection of \fBSLS\fP files and directories that live under the directory
specified in \fI\%file_roots\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Directory names or filenames in the state tree cannot contain a period, with the
exception of the period in the .sls file suffix.
.UNINDENT
.UNINDENT
.SS Top file
.sp
The main state file that instructs minions what environment and modules to use
during state execution.
.sp
Configurable via \fI\%state_top\fP\&.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%A detailed description of the top file\fP
.UNINDENT
.UNINDENT
.SS Include declaration
.sp
Defines a list of \fI\%Module reference\fP strings to include in this \fBSLS\fP\&.
.sp
Occurs only in the top level of the SLS data structure.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- edit.vim
  \- http.server
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Module reference
.sp
The name of a SLS module defined by a separate SLS file and residing on
the Salt Master. A module named \fBedit.vim\fP is a reference to the SLS
file \fBsalt://edit/vim.sls\fP\&.
.SS ID declaration
.sp
Defines an individual \fI\%highstate\fP component. Always
references a value of a dictionary containing keys referencing
\fI\%State declaration\fP and \fI\%Requisite declaration\fP\&. Can be overridden by
a \fI\%Name declaration\fP or a \fI\%Names declaration\fP\&.
.sp
Occurs on the top level or under the \fI\%Extend declaration\fP\&.
.sp
Must be unique across entire state tree. If the same ID declaration is
used twice, only the first one matched will be used. All subsequent
ID declarations with the same name will be ignored.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Naming gotchas
.sp
In Salt versions earlier than 0.9.7, ID declarations containing dots would
result in unpredictable output.
.UNINDENT
.UNINDENT
.SS Extend declaration
.sp
Extends a \fI\%Name declaration\fP from an included \fBSLS module\fP\&. The
keys of the extend declaration always refer to an existing
\fI\%ID declaration\fP which have been defined in included \fBSLS modules\fP\&.
.sp
Occurs only in the top level and defines a dictionary.
.sp
States cannot be extended more than once in a single state run.
.sp
Extend declarations are useful for adding\-to or overriding parts of a
\fI\%State declaration\fP that is defined in another \fBSLS\fP file. In the
following contrived example, the shown \fBmywebsite.sls\fP file is \fBinclude\fP
\-ing and \fBextend\fP \-ing the \fBapache.sls\fP module in order to add a \fBwatch\fP
declaration that will restart Apache whenever the Apache configuration file,
\fBmywebsite\fP changes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- apache

extend:
  apache:
    service:
      \- watch:
        \- file: mywebsite

mywebsite:
  file.managed:
    \- name: /var/www/mysite
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
watch_in and require_in
.sp
Sometimes it is more convenient to use the \fI\%watch_in\fP or \fI\%require_in\fP syntax
instead of extending another \fBSLS\fP file.
.sp
\fI\%State Requisites\fP
.UNINDENT
.UNINDENT
.SS State declaration
.sp
A list which contains one string defining the \fI\%Function declaration\fP and
any number of \fI\%Function arg declaration\fP dictionaries.
.sp
Can, optionally, contain a number of additional components like the
name override components — \fI\%name\fP and
\fI\%names\fP\&. Can also contain \fI\%requisite
declarations\fP\&.
.sp
Occurs under an \fI\%ID declaration\fP\&.
.SS Requisite declaration
.sp
A list containing \fI\%requisite references\fP\&.
.sp
Used to build the action dependency tree. While Salt states are made to
execute in a deterministic order, this order is managed by requiring
and watching other Salt states.
.sp
Occurs as a list component under a \fI\%State declaration\fP or as a
key under an \fI\%ID declaration\fP\&.
.SS Requisite reference
.sp
A single key dictionary. The key is the name of the referenced
\fI\%State declaration\fP and the value is the ID of the referenced
\fI\%ID declaration\fP\&.
.sp
Occurs as a single index in a \fI\%Requisite declaration\fP list.
.SS Function declaration
.sp
The name of the function to call within the state. A state declaration
can contain only a single function declaration.
.sp
For example, the following state declaration calls the \fI\%installed\fP function in the \fBpkg\fP state module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg.installed: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The function can be declared inline with the state as a shortcut.
The actual data structure is compiled to this form:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg:
    \- installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Where the function is a string in the body of the state declaration.
Technically when the function is declared in dot notation the compiler
converts it to be a string in the state declaration list. Note that the
use of the first example more than once in an ID declaration is invalid
yaml.
.sp
INVALID:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg.installed
  service.running
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When passing a function without arguments and another state declaration
within a single ID declaration, then the long or \(dqstandard\(dq format
needs to be used since otherwise it does not represent a valid data
structure.
.sp
VALID:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg.installed: []
  service.running: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Occurs as the only index in the \fI\%State declaration\fP list.
.SS Function arg declaration
.sp
A single key dictionary referencing a Python type which is to be passed
to the named \fI\%Function declaration\fP as a parameter. The type must
be the data type expected by the function.
.sp
Occurs under a \fI\%Function declaration\fP\&.
.sp
For example in the following state declaration \fBuser\fP, \fBgroup\fP, and
\fBmode\fP are passed as arguments to the \fI\%managed\fP function in the \fBfile\fP state module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/http/conf/http.conf:
  file.managed:
    \- user: root
    \- group: root
    \- mode: 644
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Name declaration
.sp
Overrides the \fBname\fP argument of a \fI\%State declaration\fP\&. If
\fBname\fP is not specified the \fI\%ID declaration\fP satisfies the
\fBname\fP argument.
.sp
The name is always a single key dictionary referencing a string.
.sp
Overriding \fBname\fP is useful for a variety of scenarios.
.sp
For example, avoiding clashing ID declarations. The following two state
declarations cannot both have \fB/etc/motd\fP as the ID declaration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
motd_perms:
  file.managed:
    \- name: /etc/motd
    \- mode: 644

motd_quote:
  file.append:
    \- name: /etc/motd
    \- text: \(dqOf all smells, bread; of all tastes, salt.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Another common reason to override \fBname\fP is if the ID declaration is long and
needs to be referenced in multiple places. In the example below it is much
easier to specify \fBmywebsite\fP than to specify
\fB/etc/apache2/sites\-available/mywebsite.com\fP multiple times:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mywebsite:
  file.managed:
    \- name: /etc/apache2/sites\-available/mywebsite.com
    \- source: salt://mywebsite.com

a2ensite mywebsite.com:
  cmd.wait:
    \- unless: test \-L /etc/apache2/sites\-enabled/mywebsite.com
    \- watch:
      \- file: mywebsite

apache2:
  service.running:
    \- watch:
      \- file: mywebsite
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Names declaration
.sp
Expands the contents of the containing \fI\%State declaration\fP into
multiple state declarations, each with its own name.
.sp
For example, given the following state declaration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python\-pkgs:
  pkg.installed:
    \- names:
      \- python\-django
      \- python\-crypto
      \- python\-yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once converted into the lowstate data structure the above state
declaration will be expanded into the following three state declarations:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python\-django:
  pkg.installed

python\-crypto:
  pkg.installed

python\-yaml:
  pkg.installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Other values can be overridden during the expansion by providing an additional
dictionary level.
.sp
New in version 2014.7.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ius:
  pkgrepo.managed:
    \- humanname: IUS Community Packages for Enterprise Linux 6 \- $basearch
    \- gpgcheck: 1
    \- baseurl: http://mirror.rackspace.com/ius/stable/CentOS/6/$basearch
    \- gpgkey: http://dl.iuscommunity.org/pub/ius/IUS\-COMMUNITY\-GPG\-KEY
    \- names:
        \- ius
        \- ius\-devel:
            \- baseurl: http://mirror.rackspace.com/ius/development/CentOS/6/$basearch
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Large example
.sp
Here is the layout in yaml using the names of the highdata structure
components.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<Include Declaration>:
  \- <Module Reference>
  \- <Module Reference>

<Extend Declaration>:
  <ID Declaration>:
    [<overrides>]


# standard declaration

<ID Declaration>:
  <State Module>:
    \- <Function>
    \- <Function Arg>
    \- <Function Arg>
    \- <Function Arg>
    \- <Name>: <name>
    \- <Requisite Declaration>:
      \- <Requisite Reference>
      \- <Requisite Reference>


# inline function and names

<ID Declaration>:
  <State Module>.<Function>:
    \- <Function Arg>
    \- <Function Arg>
    \- <Function Arg>
    \- <Names>:
      \- <name>
      \- <name>
      \- <name>
    \- <Requisite Declaration>:
      \- <Requisite Reference>
      \- <Requisite Reference>


# multiple states for single id

<ID Declaration>:
  <State Module>:
    \- <Function>
    \- <Function Arg>
    \- <Name>: <name>
    \- <Requisite Declaration>:
      \- <Requisite Reference>
  <State Module>:
    \- <Function>
    \- <Function Arg>
    \- <Names>:
      \- <name>
      \- <name>
    \- <Requisite Declaration>:
      \- <Requisite Reference>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Include and Exclude
.sp
Salt SLS files can include other SLS files and exclude SLS files that have been
otherwise included. This allows for an SLS file to easily extend or manipulate
other SLS files.
.SS Include
.sp
When other SLS files are included, everything defined in the included SLS file
will be added to the state run. When including define a list of SLS formulas
to include:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- http
  \- libvirt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The include statement will include SLS formulas from the same environment
that the including SLS formula is in. But the environment can be explicitly
defined in the configuration to override the running environment, therefore
if an SLS formula needs to be included from an external environment named \(dqdev\(dq
the following syntax is used:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- dev: http
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE\fP: \fBinclude\fP does not simply inject the states where you place it
in the SLS file. If you need to guarantee order of execution, consider using
requisites.
.INDENT 0.0
.INDENT 3.5
.IP "Do not use dots in SLS file names or their directories"
.sp
The initial implementation of \fI\%top.sls\fP and
\fI\%Include declaration\fP followed the python import model where a slash
is represented as a period.  This means that a SLS file with a period in
the name ( besides the suffix period) can not be referenced.  For example,
webserver_1.0.sls is not referenceable because webserver_1.0 would refer
to the directory/file webserver_1/0.sls
.sp
The same applies for any subdirectories, this is especially \(aqtricky\(aq when
git repos are created.  Another command that typically can\(aqt render its
output is \fB\(gastate.show_sls\(ga\fP of a file in a path that contains a dot.
.UNINDENT
.UNINDENT
.SS Relative Include
.sp
In Salt 0.16.0, the capability to include SLS formulas which are relative to
the running SLS formula was added.  Simply precede the formula name with a
\fB\&.\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- .virt
  \- .virt.hyper
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In Salt 2015.8, the ability to include SLS formulas which are relative to the
parents of the running SLS formula was added.  In order to achieve this,
precede the formula name with more than one \fB\&.\fP (dot). Much like Python\(aqs
relative import abilities, two or more leading dots represent a relative
include of the parent or parents of the current package, with each \fB\&.\fP
representing one level after the first.
.sp
The following SLS configuration, if placed within \fBexample.dev.virtual\fP,
would result in \fBexample.http\fP and \fBbase\fP being included respectively:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- ..http
  \- ...base
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Exclude
.sp
The exclude statement, added in Salt 0.10.3, allows an SLS to hard exclude
another SLS file or a specific id. The component is excluded after the
high data has been compiled, so nothing should be able to override an
exclude.
.sp
Since the exclude can remove an id or an sls the type of component to exclude
needs to be defined. An exclude statement that verifies that the running
\fI\%highstate\fP does not contain the \fBhttp\fP sls and the
\fB/etc/vimrc\fP id would look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
exclude:
  \- sls: http
  \- id: /etc/vimrc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The current state processing flow checks for duplicate IDs before
processing excludes. An error occurs if duplicate IDs are present even if
one of the IDs is targeted by an \fBexclude\fP\&.
.UNINDENT
.UNINDENT
.SS State System Layers
.sp
The Salt state system is comprised of multiple layers. While using Salt does
not require an understanding of the state layers, a deeper understanding of
how Salt compiles and manages states can be very beneficial.
.SS Function Call
.sp
The lowest layer of functionality in the state system is the direct state
function call. State executions are executions of single state functions at
the core. These individual functions are defined in state modules and can
be called directly via the \fBstate.single\fP command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.single pkg.installed name=\(aqvim\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Low Chunk
.sp
The low chunk is the bottom of the Salt state compiler. This is a data
representation of a single function call. The low chunk is sent to the state
caller and used to execute a single state function.
.sp
A single low chunk can be executed manually via the \fBstate.low\fP command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.low \(aq{name: vim, state: pkg, fun: installed}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The passed data reflects what the state execution system gets after compiling
the data down from sls formulas.
.SS Low State
.sp
The \fILow State\fP layer is the list of low chunks \(dqevaluated\(dq in order. To see
what the low state looks like for a \fI\%highstate\fP, run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.show_lowstate
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will display the raw lowstate in the order which each low chunk will be
evaluated. The order of evaluation is not necessarily the order of execution,
since requisites are evaluated at runtime. Requisite execution and evaluation
is finite; this means that the order of execution can be ascertained with 100%
certainty based on the order of the low state.
.SS High Data
.sp
High data is the data structure represented in YAML via SLS files. The High
data structure is created by merging the data components rendered inside sls
files (or other render systems). The High data can be easily viewed by
executing the \fBstate.show_highstate\fP or \fBstate.show_sls\fP functions. Since
this data is a somewhat complex data structure, it may be easier to read using
the json, yaml, or pprint outputters:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.show_highstate \-\-out yaml
salt \(aq*\(aq state.show_sls edit.vim \-\-out pprint
.ft P
.fi
.UNINDENT
.UNINDENT
.SS SLS
.sp
Above \(dqHigh Data\(dq, the logical layers are no longer technically required to be
executed, or to be executed in a hierarchy. This means that how the High data
is generated is optional and very flexible. The SLS layer allows for many
mechanisms to be used to render sls data from files or to use the fileserver
backend to generate sls and file data from external systems.
.sp
The SLS layer can be called directly to execute individual sls formulas.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
SLS Formulas have historically been called \(dqSLS files\(dq. This is because a
single SLS was only constituted in a single file. Now the term
\(dqSLS Formula\(dq better expresses how a compartmentalized SLS can be expressed
in a much more dynamic way by combining pillar and other sources, and the
SLS can be dynamically generated.
.UNINDENT
.UNINDENT
.sp
To call a single SLS formula named \fBedit.vim\fP, execute \fI\%state.apply\fP and pass \fBedit.vim\fP as an argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply edit.vim
.ft P
.fi
.UNINDENT
.UNINDENT
.SS HighState
.sp
Calling SLS directly logically assigns what states should be executed from the
context of the calling minion. The Highstate layer is used to allow for full
contextual assignment of what is executed where to be tied to groups of, or
individual, minions entirely from the master. This means that the environment of
a minion, and all associated execution data pertinent to said minion, can be
assigned from the master without needing to execute or configure anything on
the target minion. This also means that the minion can independently retrieve
information about its complete configuration from the master.
.sp
To execute the \fI\%highstate\fP use \fI\%state.apply\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Orchestrate
.sp
The orchestrate layer expresses the highest functional layer of Salt\(aqs automated
logic systems. The Overstate allows for stateful and functional orchestration
of routines from the master. The orchestrate defines in data execution stages
which minions should execute states, or functions, and in what order using
requisite logic.
.SS The Orchestrate Runner
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This documentation has been moved \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.SS Ordering States
.sp
The way in which configuration management systems are executed is a hotly
debated topic in the configuration management world. Two major philosophies
exist on the subject, to either execute in an imperative fashion where things
are executed in the order in which they are defined, or in a declarative
fashion where dependencies need to be mapped between objects.
.sp
Imperative ordering is deterministic and generally considered easier to write, but
declarative ordering is much more powerful and flexible but generally considered
more difficult to create.
.sp
Salt has been created to get the best of both worlds. States are evaluated in
a deterministic order, which guarantees that states are always executed in the same
order, and the states runtime is declarative, making Salt fully aware of
dependencies via the \fIrequisite\fP system.
.SS State Auto Ordering
.sp
Salt always executes states in a deterministic manner, meaning that they will always
execute in the same order regardless of the system that is executing them. This
evaluation order makes it easy to know what order the states will be executed in,
but it is important to note that the requisite system will override the ordering
defined in the files, and the \fBorder\fP option, described below, will also
override the order in which states are executed.
.sp
This ordering system can be disabled in preference of lexicographic (classic)
ordering by setting the \fBstate_auto_order\fP option to \fBFalse\fP in the master
configuration file. Otherwise, \fBstate_auto_order\fP defaults to \fBTrue\fP\&.
.sp
How compiler ordering is managed is described further in \fI\%Understanding State Compiler Ordering\fP\&.
.SS Requisite Statements
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The behavior of requisites changed in version 0.9.7 of Salt.  This
documentation applies to requisites in version 0.9.7 and later.
.UNINDENT
.UNINDENT
.sp
Often when setting up states any single action will require or depend on
another action. Salt allows for the building of relationships between states
with requisite statements. A requisite statement ensures that the named state
is evaluated before the state requiring it. There are three types of requisite
statements in Salt, \fBrequire\fP, \fBwatch\fP, and \fBprereq\fP\&.
.sp
These requisite statements are applied to a specific state declaration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg.installed: []
  file.managed:
    \- name: /etc/httpd/conf/httpd.conf
    \- source: salt://httpd/httpd.conf
    \- require:
      \- pkg: httpd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example, the \fBrequire\fP requisite is used to declare that the file
/etc/httpd/conf/httpd.conf should only be set up if the pkg state executes
successfully.
.sp
The requisite system works by finding the states that are required and
executing them before the state that requires them. Then the required states
can be evaluated to see if they have executed correctly.
.sp
Require statements can refer to any state defined in Salt. The basic examples
are \fIpkg\fP, \fIservice\fP, and \fIfile\fP, but any used state can be referenced.
.sp
In addition to state declarations such as pkg, file, etc., \fBsls\fP type requisites
are also recognized, and essentially allow \(aqchaining\(aq of states. This provides a
mechanism to ensure the proper sequence for complex state formulas, especially when
the discrete states are split or groups into separate sls files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- network

httpd:
  pkg.installed: []
  service.running:
    \- require:
      \- pkg: httpd
      \- sls: network
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example, the httpd service running state will not be applied
(i.e., the httpd service will not be started) unless both the httpd package is
installed AND the network state is satisfied.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Requisite matching
.sp
Requisites match on both the ID Declaration and the \fBname\fP parameter.
Therefore, if using the \fBpkgs\fP or \fBsources\fP argument to install
a list of packages in a pkg state, it\(aqs important to note that it is
impossible to match an individual package in the list, since all packages
are installed as a single state.
.UNINDENT
.UNINDENT
.SS Multiple Requisites
.sp
The requisite statement is passed as a list, allowing for the easy addition of
more requisites. Both requisite types can also be separately declared:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg.installed: []
  service.running:
    \- enable: True
    \- watch:
      \- file: /etc/httpd/conf/httpd.conf
    \- require:
      \- pkg: httpd
      \- user: httpd
      \- group: httpd
  file.managed:
    \- name: /etc/httpd/conf/httpd.conf
    \- source: salt://httpd/httpd.conf
    \- require:
      \- pkg: httpd
  user.present: []
  group.present: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example, the httpd service is only going to be started if the package,
user, group, and file are executed successfully.
.SS Requisite Documentation
.sp
For detailed information on each of the individual requisites, \fI\%please
look here.\fP
.SS The Order Option
.sp
Before using the \fIorder\fP option, remember that the majority of state ordering
should be done with a \fI\%Requisite declaration\fP, and that a requisite
declaration will override an \fIorder\fP option, so a state with order option
should not require or required by other states.
.sp
The order option is used by adding an order number to a state declaration
with the option \fIorder\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed:
    \- order: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By adding the order option to \fI1\fP this ensures that the vim package will be
installed in tandem with any other state declaration set to the order \fI1\fP\&.
.sp
Any state declared without an order option will be executed after all states
with order options are executed.
.sp
But this construct can only handle ordering states from the beginning.
Certain circumstances will present a situation where it is desirable to send
a state to the end of the line. To do this, set the order to \fBlast\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed:
    \- order: last
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Running States in Parallel
.sp
Introduced in Salt version \fB2017.7.0\fP it is now possible to run select states
in parallel. This is accomplished very easily by adding the \fBparallel: True\fP
option to your state declaration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nginx:
  service.running:
    \- parallel: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now \fBnginx\fP will be started in a separate process from the normal state run
and will therefore not block additional states.
.SS Parallel States and Requisites
.sp
Parallel States still honor requisites. If a given state requires another state
that has been run in parallel then the state runtime will wait for the required
state to finish.
.sp
Given this example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sleep 10:
  cmd.run:
    \- parallel: True

nginx:
  service.running:
    \- parallel: True
    \- require:
      \- cmd: sleep 10

sleep 5:
  cmd.run:
    \- parallel: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBsleep 10\fP will be started first, then the state system will block on
starting nginx until the \fBsleep 10\fP completes. Once nginx has been ensured to
be running then the \fBsleep 5\fP will start.
.sp
This means that the order of evaluation of Salt States and requisites are
still honored, and given that in the above case, \fBparallel: True\fP does not
actually speed things up.
.sp
To run the above state much faster make sure that the \fBsleep 5\fP is evaluated
before the \fBnginx\fP state
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sleep 10:
  cmd.run:
    \- parallel: True

sleep 5:
  cmd.run:
    \- parallel: True

nginx:
  service.running:
    \- parallel: True
    \- require:
      \- cmd: sleep 10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now both of the sleep calls will be started in parallel and \fBnginx\fP will still
wait for the state it requires, but while it waits the \fBsleep 5\fP state will
also complete.
.SS Things to be Careful of
.sp
Parallel States do not prevent you from creating parallel conflicts on your
system. This means that if you start multiple package installs using Salt then
the package manager will block or fail. If you attempt to manage the same file
with multiple states in parallel then the result can produce an unexpected
file.
.sp
Make sure that the states you choose to run in parallel do not conflict, or
else, like in any parallel programming environment, the outcome may not be
what you expect. Doing things like just making all states run in parallel
will almost certainly result in unexpected behavior.
.sp
With that said, running states in parallel should be safe the vast majority
of the time and the most likely culprit for unexpected behavior is running
multiple package installs in parallel.
.SS State Providers
.sp
New in version 0.9.8.

.sp
Salt predetermines what modules should be mapped to what uses based on the
properties of a system. These determinations are generally made for modules
that provide things like package and service management.
.sp
Sometimes in states, it may be necessary to use an alternative module to
provide the needed functionality. For instance, an very old Arch Linux system
may not be running systemd, so instead of using the systemd service module, you
can revert to the default service module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  service.running:
    \- enable: True
    \- provider: service
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this instance, the basic \fI\%service\fP module (which
manages \fBsysvinit\fP\-based services) will replace the
\fBsystemd\fP module which is used by default on Arch Linux.
.sp
This change only affects this one state though. If it is necessary to make this
override for most or every service, it is better to just override the provider
in the minion config file, as described \fI\%here\fP\&.
.sp
Also, keep in mind that this only works for states with an identically\-named
virtual module (\fI\%pkg\fP, \fI\%service\fP,
etc.).
.SS Arbitrary Module Redirects
.sp
The provider statement can also be used for more powerful means, instead of
overwriting or extending the module used for the named service an arbitrary
module can be used to provide certain functionality.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
emacs:
  pkg.installed:
    \- provider:
      \- cmd: customcmd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example, the state is being instructed to use a custom module to invoke
commands.
.sp
Arbitrary module redirects can be used to dramatically change the behavior of a
given state.
.SS Requisites and Other Global State Arguments
.SS Requisites
.sp
The Salt requisite system is used to create relationships between states. This
provides a method to easily define inter\-dependencies between states. These
dependencies are expressed by declaring the relationships using state names
and IDs or names. The generalized form of a requisite target is \fB<state name>:
<ID or name>\fP\&. The specific form is defined as a \fI\%Requisite Reference\fP\&.
.sp
A common use\-case for requisites is ensuring a package has been installed before
trying to ensure the service is running. In the following example, Salt will
ensure nginx has been installed before trying to manage the service. If the
package could not be installed, Salt will not try to manage the service.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nginx:
  pkg.installed:
    \- name: nginx\-light
  service.running:
    \- enable: True
    \- require:
      \- pkg: nginx
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Without the requisite defined, salt would attempt to install the package and
then attempt to manage the service even if the installation failed.
.sp
These requisites always form dependencies in a predictable single direction.
Each requisite has an alternate \fI\%<requisite>_in\fP form that
can be used to establish a \(dqreverse\(dq dependency\-\-useful in for loops.
.sp
In the end, a single dependency map is created and everything is executed in a
finite and predictable order.
.SS Requisite matching
.sp
Requisites typically need two pieces of information for matching:
.INDENT 0.0
.IP \(bu 2
The state module name (e.g. \fBpkg\fP or \fBservice\fP)
.IP \(bu 2
The state identifier (e.g. \fBnginx\fP or \fB/etc/nginx/nginx.conf\fP)
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nginx:
  pkg.installed: []
  file.managed:
    \- name: /etc/nginx/nginx.conf
  service.running:
    \- require:
      \- pkg: nginx
      \- file: /etc/nginx/nginx.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Identifier matching
.sp
Requisites match on both the ID Declaration and the \fBname\fP parameter.
This means that, in the \(dqDeploy server package\(dq example above, a \fBrequire\fP
requisite would match with \fBDeploy server package\fP \fIor\fP \fB/usr/local/share/myapp.tar.xz\fP,
so either of the following versions for \(dqExtract server package\(dq is correct:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# (Archive arguments omitted for simplicity)

# Match by ID declaration
Extract server package:
  archive.extracted:
    \- onchanges:
      \- file: Deploy server package

# Match by name parameter
Extract server package:
  archive.extracted:
    \- onchanges:
      \- file: /usr/local/share/myapp.tar.xz
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Wildcard matching in requisites
.sp
New in version 0.9.8.

.sp
Wildcard matching is supported for state identifiers.
.INDENT 0.0
.IP \(bu 2
\fB*\fP matches zero or more characters
.IP \(bu 2
\fB?\fP matches a single character
.IP \(bu 2
\fB[]\fP matches a single character from the enclosed set
.UNINDENT
.sp
Note that this does not follow glob rules \- dots and slashes are not special,
and it is matching against state identifiers, not file paths.
.sp
In the example below, a change in any state managing an apache config file
will reload/restart the service:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apache2:
  service.running:
    \- watch:
      \- file: /etc/apache2/*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A leading or bare \fB*\fP must be quoted to avoid confusion with YAML references:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/letsencrypt/renewal\-hooks/deploy/install.sh:
  cmd.run:
    \- onchanges:
      \- acme: \(aq*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Omitting state module
.sp
New in version 2016.3.0.

.sp
In version 2016.3.0, the state module name was made optional. If the state module
is omitted, all states matching the identifier will be required, regardless of which
module they are using.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- require:
  \- vim
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Requisites Types
.sp
All requisite types have a corresponding \fI\%_in\fP form:
.INDENT 0.0
.IP \(bu 2
\fI\%require\fP: Requires that a list of target states succeed before execution
.IP \(bu 2
\fI\%onchanges\fP: Execute if any target states succeed with changes
.IP \(bu 2
\fI\%watch\fP: Similar to \fBonchanges\fP; modifies state behavior using \fBmod_watch\fP
.IP \(bu 2
\fI\%listen\fP: Similar to \fBonchanges\fP; delays execution to end of state run using \fBmod_watch\fP
.IP \(bu 2
\fI\%prereq\fP: Execute prior to target state if target state expects to produce changes
.IP \(bu 2
\fI\%onfail\fP: Execute only if a target state fails
.IP \(bu 2
\fI\%use\fP: Copy arguments from another state
.UNINDENT
.sp
Several requisite types have a corresponding \fI\%requisite_any\fP form:
.INDENT 0.0
.IP \(bu 2
\fBrequire_any\fP
.IP \(bu 2
\fBwatch_any\fP
.IP \(bu 2
\fBonchanges_any\fP
.IP \(bu 2
\fBonfail_any\fP
.UNINDENT
.sp
There is no combined form of \fI\%_any\fP and \fI\%_in\fP requisites, such as \fBrequire_any_in\fP!
.sp
Lastly, onfail has one special \fBonfail_all\fP form to account for when \fBAND\fP
logic is desired instead of the default \fBOR\fP logic of onfail/onfail_any (which
are equivalent).
.sp
All requisites define specific relationships and always work with the dependency
logic defined \fI\%above\fP\&.
.SS require
.sp
The use of \fBrequire\fP builds a dependency that prevents a state from executing
until all required states execute successfully. If any required state fails,
then the state will fail due to requisites.
.sp
In the following example, the \fBservice\fP state will not be checked unless both
\fBfile\fP states execute without failure.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nginx:
  service.running:
    \- require:
      \- file: /etc/nginx/nginx.conf
      \- file: /etc/nginx/conf.d/ssl.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Require SLS File
.sp
As of Salt 0.16.0, it is possible to require an entire sls file. Do this by first
including the sls file and then setting a state to \fBrequire\fP the included sls
file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- foo

bar:
  pkg.installed:
    \- require:
      \- sls: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will add a \fBrequire\fP to all of the state declarations found in the given
sls file. This means that \fBbar\fP will \fBrequire\fP every state within \fBfoo\fP\&.
This makes it very easy to batch large groups of states easily in any requisite
statement.
.SS onchanges
.sp
New in version 2014.7.0.

.sp
The \fBonchanges\fP requisite makes a state only apply if the required states
generate changes, and if the watched state\(aqs \(dqresult\(dq is \fBTrue\fP (does not fail).
This can be a useful way to execute a post hook after changing aspects of a system.
.sp
If a state has multiple \fBonchanges\fP requisites then the state will trigger
if any of the watched states changes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myservice:
  file.managed:
    \- name: /etc/myservice/myservice.conf
    \- source: salt://myservice/files/myservice.conf
  cmd.run:
    \- name: /usr/local/sbin/run\-build
    \- onchanges:
      \- file: /etc/myservice/myservice.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the example above, \fBcmd.run\fP will run only if there are changes in the
\fBfile.managed\fP state.
.sp
An easy mistake to make is using \fBonchanges_in\fP when \fBonchanges\fP is the
correct choice, as seen in this next example.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myservice:
  file.managed:
    \- name: /etc/myservice/myservice.conf
    \- source: salt://myservice/files/myservice.conf
  cmd.run:
    \- name: /usr/local/sbin/run\-build
    \- onchanges_in:  # <\-\- broken logic
      \- file: /etc/myservice/myservice.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will set up a requisite relationship in which the \fBcmd.run\fP state
always executes, and the \fBfile.managed\fP state only executes if the
\fBcmd.run\fP state has changes (which it always will, since the \fBcmd.run\fP
state includes the command results as changes).
.sp
It may semantically seem like the \fBcmd.run\fP state should only run
when there are changes in the file state, but remember that requisite
relationships involve one state watching another state, and a
\fI\%requisite_in\fP does the opposite: it forces
the specified state to watch the state with the \fBrequisite_in\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
An \fBonchanges\fP requisite has no effect on SLS requisites (monitoring for
changes in an included SLS). Only the individual state IDs from an included
SLS can be monitored.
.UNINDENT
.UNINDENT
.SS watch
.sp
A \fBwatch\fP requisite is used to add additional behavior when there are changes
in other states. This is done using the \fBmod_watch\fP function available from
the execution module and will execute any time a watched state changes.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If a state should only execute when another state has changes, and
otherwise do nothing, the \fBonchanges\fP requisite should be used instead
of \fBwatch\fP\&. \fBwatch\fP is designed to add \fIadditional\fP behavior when
there are changes, but otherwise the state executes normally.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
A \fBwatch\fP requisite has no effect on SLS requisites (watching for changes
in an included SLS). Only the individual state IDs from an included SLS can
be watched.
.UNINDENT
.UNINDENT
.sp
A good example of using \fBwatch\fP is with a \fI\%service.running\fP state. When a service watches a state, then
the service is reloaded/restarted when the watched state changes, in addition
to Salt ensuring that the service is running.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ntpd:
  service.running:
    \- watch:
      \- file: /etc/ntp.conf
  file.managed:
    \- name: /etc/ntp.conf
    \- source: salt://ntp/files/ntp.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Another useful example of \fBwatch\fP is using salt to ensure a configuration file
is present and in a correct state, ensure the service is running, and trigger
\fBservice nginx reload\fP instead of \fBservice nginx restart\fP in order to avoid
dropping any connections.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nginx:
  service.running:
    \- reload: True
    \- watch:
      \- file: nginx
  file.managed:
    \- name: /etc/nginx/conf.d/tls\-settings.conf
    \- source: salt://nginx/files/tls\-settings.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Not all state modules contain \fBmod_watch\fP\&. If \fBmod_watch\fP is absent
from the watching state module, the \fBwatch\fP requisite behaves exactly
like a \fBrequire\fP requisite.
.UNINDENT
.UNINDENT
.sp
The state containing the \fBwatch\fP requisite is defined as the watching
state. The state specified in the \fBwatch\fP statement is defined as the watched
state. When the watched state executes, it will return a dictionary containing
a key named \(dqchanges\(dq. Here are two examples of state return dictionaries,
shown in json for clarity:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqlocal\(dq: {
        \(dqfile_|\-/tmp/foo_|\-/tmp/foo_|\-directory\(dq: {
            \(dqcomment\(dq: \(dqDirectory /tmp/foo updated\(dq,
            \(dq__run_num__\(dq: 0,
            \(dqchanges\(dq: {
                \(dquser\(dq: \(dqbar\(dq
            },
            \(dqname\(dq: \(dq/tmp/foo\(dq,
            \(dqresult\(dq: true
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqlocal\(dq: {
        \(dqpkgrepo_|\-salt\-minion_|\-salt\-minion_|\-managed\(dq: {
            \(dqcomment\(dq: \(dqPackage repo \(aqsalt\-minion\(aq already configured\(dq,
            \(dq__run_num__\(dq: 0,
            \(dqchanges\(dq: {},
            \(dqname\(dq: \(dqsalt\-minion\(dq,
            \(dqresult\(dq: true
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the \(dqresult\(dq of the watched state is \fBTrue\fP, the watching state \fIwill
execute normally\fP, and if it is \fBFalse\fP, the watching state will never run.
This part of \fBwatch\fP mirrors the functionality of the \fBrequire\fP requisite.
.sp
If the \(dqresult\(dq of the watched state is \fBTrue\fP \fIand\fP the \(dqchanges\(dq
key contains a populated dictionary (changes occurred in the watched state),
then the \fBwatch\fP requisite can add additional behavior. This additional
behavior is defined by the \fBmod_watch\fP function within the watching state
module. If the \fBmod_watch\fP function exists in the watching state module, it
will be called \fIin addition to\fP the normal watching state. The return data
from the \fBmod_watch\fP function is what will be returned to the master in this
case; the return data from the main watching function is discarded.
.sp
If the \(dqchanges\(dq key contains an empty dictionary, the \fBwatch\fP requisite acts
exactly like the \fBrequire\fP requisite (the watching state will execute if
\(dqresult\(dq is \fBTrue\fP, and fail if \(dqresult\(dq is \fBFalse\fP in the watched state).
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If the watching state \fBchanges\fP key contains values, then \fBmod_watch\fP
will not be called. If you\(aqre using \fBwatch\fP or \fBwatch_in\fP then it\(aqs a
good idea to have a state that only enforces one attribute \- such as
splitting out \fBservice.running\fP into its own state and have
\fBservice.enabled\fP in another.
.UNINDENT
.UNINDENT
.sp
One common source of confusion is expecting \fBmod_watch\fP to be called for
every necessary change. You might be tempted to write something like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  service.running:
    \- enable: True
    \- watch:
      \- file: httpd\-config

httpd\-config:
  file.managed:
    \- name: /etc/httpd/conf/httpd.conf
    \- source: salt://httpd/files/apache.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If your service is already running but not enabled, you might expect that Salt
will be able to tell that since the config file changed your service needs to
be restarted. This is not the case. Because the service needs to be enabled,
that change will be made and \fBmod_watch\fP will never be triggered. In this
case, changes to your \fBapache.conf\fP will fail to be loaded. If you want to
ensure that your service always reloads the correct way to handle this is
either ensure that your service is not running before applying your state, or
simply make sure that \fBservice.running\fP is in a state on its own:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
enable\-httpd:
  service.enabled:
    \- name: httpd

start\-httpd:
  service.running:
    \- name: httpd
    \- watch:
      \- file: httpd\-config

httpd\-config:
  file.managed:
    \- name: /etc/httpd/conf/httpd.conf
    \- source: salt://httpd/files/apache.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now that \fBservice.running\fP is its own state, changes to \fBservice.enabled\fP
will no longer prevent \fBmod_watch\fP from getting triggered, so your \fBhttpd\fP
service will get restarted like you want.
.SS listen
.sp
New in version 2014.7.0.

.sp
A \fBlisten\fP requisite is used to trigger the \fBmod_watch\fP function of a
state module. Rather than modifying execution order, the \fBmod_watch\fP state
created by \fBlisten\fP will execute at the end of the state run.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
restart\-apache2:
  service.running:
    \- name: apache2
    \- listen:
      \- file: /etc/apache2/apache2.conf

configure\-apache2:
  file.managed:
    \- name: /etc/apache2/apache2.conf
    \- source: salt://apache2/apache2.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example will cause apache2 to restart when the apache2.conf file is
changed, but the apache2 restart will happen at the end of the state run.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
restart\-apache2:
  service.running:
    \- name: apache2

configure\-apache2:
  file.managed:
    \- name: /etc/apache2/apache2.conf
    \- source: salt://apache2/apache2.conf
    \- listen_in:
      \- service: apache2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example does the same as the above example, but puts the state argument
on the file resource, rather than the service resource.
.SS prereq
.sp
New in version 0.16.0.

.sp
The \fBprereq\fP requisite works similar to \fBonchanges\fP except that it uses the
result from \fBtest=True\fP on the observed state to determine if it should run
prior to the observed state being run.
.sp
The best way to define how \fBprereq\fP operates is displayed in the following
practical example: When a service should be shut down because underlying code
is going to change, the service should be off\-line while the update occurs. In
this example, \fBgraceful\-down\fP is the pre\-requiring state and \fBsite\-code\fP
is the pre\-required state.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
graceful\-down:
  cmd.run:
    \- name: service apache graceful
    \- prereq:
      \- file: site\-code

site\-code:
  file.recurse:
    \- name: /opt/site_code
    \- source: salt://site/code
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this case, the apache server will only be shut down if the site\-code state
expects to deploy fresh code via the file.recurse call. The site\-code deployment
will only be executed if the graceful\-down run completes successfully.
.sp
When a \fBprereq\fP requisite is evaluated, the pre\-required state reports if it
expects to have any changes. It does this by running the pre\-required single
state as a test\-run by enabling \fBtest=True\fP\&. This test\-run will return a
dictionary containing a key named \(dqchanges\(dq. (See the \fBwatch\fP section above
for examples of \(dqchanges\(dq dictionaries.)
.sp
If the \(dqchanges\(dq key contains a populated dictionary, it means that the
pre\-required state expects changes to occur when the state is actually
executed, as opposed to the test\-run. The pre\-requiring state will now
run. If the pre\-requiring state executes successfully, the pre\-required
state will then execute. If the pre\-requiring state fails, the pre\-required
state will not execute.
.sp
If the \(dqchanges\(dq key contains an empty dictionary, this means that changes are
not expected by the pre\-required state. Neither the pre\-required state nor the
pre\-requiring state will run.
.SS onfail
.sp
New in version 2014.7.0.

.sp
The \fBonfail\fP requisite allows for reactions to happen strictly as a response
to the failure of another state. This can be used in a number of ways, such as
sending a notification or attempting an alternate task or thread of tasks when
an important state fails.
.sp
The \fBonfail\fP requisite is applied in the same way as \fBrequire\fP and \fBwatch\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
primary_mount:
  mount.mounted:
    \- name: /mnt/share
    \- device: 10.0.0.45:/share
    \- fstype: nfs

backup_mount:
  mount.mounted:
    \- name: /mnt/share
    \- device: 192.168.40.34:/share
    \- fstype: nfs
    \- onfail:
      \- mount: primary_mount
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
build_site:
  cmd.run:
    \- name: /srv/web/app/build_site

notify\-build_failure:
  hipchat.send_message:
    \- room_id: 123456
    \- message: \(dqBuilding website fail on {{ salt.grains.get(\(aqid\(aq) }}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The default behavior of the \fBonfail\fP when multiple requisites are listed is
the opposite of other requisites in the salt state engine, it acts by default
like \fBany()\fP instead of \fBall()\fP\&. This means that when you list multiple
onfail requisites on a state, if \fIany\fP fail the requisite will be satisfied.
If you instead need \fIall\fP logic to be applied, you can use \fBonfail_all\fP
form:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
test_site_a:
  cmd.run:
    \- name: ping \-c1 10.0.0.1

test_site_b:
  cmd.run:
    \- name: ping \-c1 10.0.0.2

notify_site_down:
  hipchat.send_message:
    \- room_id: 123456
    \- message: \(dqBoth primary and backup sites are down!\(dq
  \- onfail_all:
    \- cmd: test_site_a
    \- cmd: test_site_b
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this contrived example \fInotify_site_down\fP will run when both 10.0.0.1 and
10.0.0.2 fail to respond to ping.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Setting failhard (\fI\%globally\fP or in
\fI\%the failing state\fP) to \fBTrue\fP will cause
\fBonfail\fP, \fBonfail_in\fP and \fBonfail_any\fP requisites to be ignored.
If you want to combine a global failhard set to True with \fBonfail\fP,
\fBonfail_in\fP or \fBonfail_any\fP, you will have to explicitly set failhard
to \fBFalse\fP (overriding the global setting) in the state that could fail.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Beginning in the \fB2016.11.0\fP release of Salt, \fBonfail\fP uses OR logic for
multiple listed \fBonfail\fP requisites. Prior to the \fB2016.11.0\fP release,
\fBonfail\fP used AND logic. See \fI\%Issue #22370\fP for more information.
Beginning in the \fBNeon\fP release of Salt, a new \fBonfail_all\fP requisite
form is available if AND logic is desired.
.UNINDENT
.UNINDENT
.SS use
.sp
The \fBuse\fP requisite is used to inherit the arguments passed in another
id declaration. This is useful when many files need to have the same defaults.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.managed:
    \- source: salt://foo.conf
    \- template: jinja
    \- mkdirs: True
    \- user: apache
    \- group: apache
    \- mode: 755

/etc/bar.conf:
  file.managed:
    \- source: salt://bar.conf
    \- use:
      \- file: /etc/foo.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBuse\fP statement was developed primarily for the networking states but
can be used on any states in Salt. This makes sense for the networking state
because it can define a long list of options that need to be applied to
multiple network interfaces.
.sp
The \fBuse\fP statement does not inherit the requisites arguments of the
targeted state. This means also a chain of \fBuse\fP requisites would not
inherit inherited options.
.SS The _in version of requisites
.sp
Direct requisites form a dependency in a single direction. This makes it possible
for Salt to detect cyclical dependencies and helps prevent faulty logic. In some
cases, often in loops, it is desirable to establish a dependency in the opposite
direction.
.sp
All direct requisites have an \fB_in\fP counterpart that behaves the same but forms
the dependency in the opposite direction. The following sls examples will produce
the exact same dependency mapping.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg.installed: []
  service.running:
    \- require:
      \- pkg: httpd
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg.installed:
    \- require_in:
      \- service: httpd
  service.running: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the following example, Salt will not try to manage the nginx service or any
configuration files unless the nginx package is installed because of the \fBpkg:
nginx\fP requisite.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nginx:
  pkg.installed: []
  service.running:
    \- enable: True
    \- reload: True
    \- require:
      \- pkg: nginx
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
php.sls
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- http

php:
  pkg.installed:
    \- require_in:
      \- service: httpd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
mod_python.sls
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- http

mod_python:
  pkg.installed:
    \- require_in:
      \- service: httpd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now the httpd server will only start if both php and mod_python are first verified to
be installed. Thus allowing for a requisite to be defined \(dqafter the fact\(dq.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% for cfile in salt.pillar.get(\(aqnginx:config_files\(aq) %}
/etc/nginx/conf.d/{{ cfile }}:
  file.managed:
    \- source: salt://nginx/configs/{{ cfile }}
    \- require:
      \- pkg: nginx
    \- listen_in:
      \- service: nginx
{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this scenario, \fBlisten_in\fP is a better choice than \fBrequire_in\fP because the
\fBlisten\fP requisite will trigger \fBmod_watch\fP behavior which will wait until the
end of state execution and then reload the service.
.SS The _any version of requisites
.sp
New in version 2018.3.0.

.sp
Some requisites have an \fB_any\fP counterpart that changes the requisite behavior
from \fBall()\fP to \fBany()\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
A:
  cmd.run:
    \- name: echo A
    \- require_any:
      \- cmd: B
      \- cmd: C

B:
  cmd.run:
    \- name: echo B

C:
  cmd.run:
    \- name: /bin/false
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example \fBA\fP will run because at least one of the requirements specified,
\fBB\fP or \fBC\fP, will succeed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myservice:
  pkg.installed

/etc/myservice/myservice.conf:
  file.managed:
    \- source: salt://myservice/files/myservice.conf

/etc/yourservice/yourservice.conf:
  file.managed:
    \- source: salt://yourservice/files/yourservice.conf

/usr/local/sbin/myservice/post\-changes\-hook.sh
  cmd.run:
    \- onchanges_any:
      \- file: /etc/myservice/myservice.conf
      \- file: /etc/your_service/yourservice.conf
    \- require:
      \- pkg: myservice
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example, \fIcmd.run\fP would be run only if either of the \fIfile.managed\fP
states generated changes and at least one of the watched state\(aqs \(dqresult\(dq is
\fBTrue\fP\&.
.SS Altering States
.sp
The state altering system is used to make sure that states are evaluated exactly
as the user expects. It can be used to double check that a state preformed
exactly how it was expected to, or to make 100% sure that a state only runs
under certain conditions. The use of unless or onlyif options help make states
even more stateful. The \fBcheck_cmd\fP option helps ensure that the result of a
state is evaluated correctly.
.SS reload
.sp
\fBreload_modules\fP is a boolean option that forces salt to reload its modules
after a state finishes. \fBreload_pillar\fP and \fBreload_grains\fP can also be set.
See \fI\%Reloading Modules\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grains_refresh:
  module.run:
   \- name: saltutil.refresh_grains
   \- reload_grains: true

grains_read:
  module.run:
   \- name: grains.items
.ft P
.fi
.UNINDENT
.UNINDENT
.SS unless
.sp
New in version 2014.7.0.

.sp
The \fBunless\fP requisite specifies that a state should only run when any of
the specified commands return \fBFalse\fP\&. The \fBunless\fP requisite operates
as NAND and is useful in giving more granular control over when a state should
execute.
.sp
\fBNOTE\fP: Under the hood \fBunless\fP calls \fBcmd.retcode\fP with
\fBpython_shell=True\fP\&. This means the commands referenced by \fBunless\fP will be
parsed by a shell, so beware of side\-effects as this shell will be run with the
same privileges as the salt\-minion. Also be aware that the boolean value is
determined by the shell\(aqs concept of \fBTrue\fP and \fBFalse\fP, rather than Python\(aqs
concept of \fBTrue\fP and \fBFalse\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed:
    \- unless:
      \- rpm \-q vim\-enhanced
      \- ls /usr/bin/vim
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the example above, the state will only run if either the vim\-enhanced
package is not installed (returns \fBFalse\fP) or if /usr/bin/vim does not
exist (returns \fBFalse\fP). The state will run if both commands return
\fBFalse\fP\&.
.sp
However, the state will not run if both commands return \fBTrue\fP\&.
.sp
Unless checks are resolved for each name to which they are associated.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
deploy_app:
  cmd.run:
    \- names:
      \- first_deploy_cmd
      \- second_deploy_cmd
    \- unless: some_check
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above case, \fBsome_check\fP will be run prior to _each_ name \-\- once for
\fBfirst_deploy_cmd\fP and a second time for \fBsecond_deploy_cmd\fP\&.
.sp
Changed in version 3000: The \fBunless\fP requisite can take a module as a dictionary field in unless.
The dictionary must contain an argument \fBfun\fP which is the module that is
being run, and everything else must be passed in under the args key or will
be passed as individual kwargs to the module function.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
install apache on debian based distros:
  cmd.run:
    \- name: make install
    \- cwd: /path/to/dir/whatever\-2.1.5/
    \- unless:
      \- fun: file.file_exists
        path: /usr/local/bin/whatever
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set mysql root password:
  debconf.set:
    \- name: mysql\-server\-5.7
    \- data:
        \(aqmysql\-server/root_password\(aq: {\(aqtype\(aq: \(aqpassword\(aq, \(aqvalue\(aq: {{pillar[\(aqmysql.pass\(aq]}} }
    \- unless:
      \- fun: pkg.version
        args:
          \- mysql\-server\-5.7
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version sodium: For modules which return a deeper data structure, the \fBget_return\fP key can
be used to access results.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
test:
  test.nop:
    \- name: foo
    \- unless:
      \- fun: consul.get
        consul_url: http://127.0.0.1:8500
        key:  not\-existing
        get_return: res
.ft P
.fi
.UNINDENT
.UNINDENT

.sp
Changed in version 3006.0: Since the \fBunless\fP requisite utilizes \fBcmd.retcode\fP, certain parameters
included in the state are passed along to \fBcmd.retcode\fP\&.  On occasion this
can cause issues, particularly if the \fBshell\fP option in a \fBuser.present\fP
is set to /sbin/nologin and this shell is passed along to \fBcmd.retcode\fP\&.
This would cause \fBcmd.retcode\fP to run the command using that shell which
would fail regardless of the result of the command.
.sp
By including \fBshell\fP in \fBcmd_opts_exclude\fP, that parameter would not be
passed along to the call to \fBcmd.retcode\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jim_nologin:
  user.present:
    \- name: jim
    \- shell: /sbin/nologin
    \- unless:
      \- echo hello world
    \- cmd_opts_exclude:
      \- shell
.ft P
.fi
.UNINDENT
.UNINDENT

.SS onlyif
.sp
New in version 2014.7.0.

.sp
The \fBonlyif\fP requisite specifies that if each command listed in \fBonlyif\fP
returns \fBTrue\fP, then the state is run. If any of the specified commands
return \fBFalse\fP, the state will not run.
.sp
\fBNOTE\fP: Under the hood \fBonlyif\fP calls \fBcmd.retcode\fP with
\fBpython_shell=True\fP\&. This means the commands referenced by \fBonlyif\fP will be
parsed by a shell, so beware of side\-effects as this shell will be run with the
same privileges as the salt\-minion. Also be aware that the boolean value is
determined by the shell\(aqs concept of \fBTrue\fP and \fBFalse\fP, rather than Python\(aqs
concept of \fBTrue\fP and \fBFalse\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
stop\-volume:
  module.run:
    \- name: glusterfs.stop_volume
    \- m_name: work
    \- onlyif:
      \- gluster volume status work
    \- order: 1

remove\-volume:
  module.run:
    \- name: glusterfs.delete
    \- m_name: work
    \- onlyif:
      \- gluster volume info work
    \- watch:
      \- cmd: stop\-volume
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above example ensures that the stop_volume and delete modules only run
if the gluster commands return a 0 ret value.
.sp
Changed in version 3000: The \fBonlyif\fP requisite can take a module as a dictionary field in onlyif.
The dictionary must contain an argument \fBfun\fP which is the module that is
being run, and everything else must be passed in under the args key or will
be passed as individual kwargs to the module function.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
install apache on redhat based distros:
  pkg.latest:
    \- name: httpd
    \- onlyif:
      \- fun: match.grain
        tgt: \(aqos_family:RedHat\(aq

install apache on debian based distros:
  pkg.latest:
    \- name: apache2
    \- onlyif:
      \- fun: match.grain
        tgt: \(aqos_family:Debian\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
arbitrary file example:
  file.touch:
    \- name: /path/to/file
    \- onlyif:
      \- fun: file.search
        args:
          \- /etc/crontab
          \- \(aqentry1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT

.sp
Changed in version sodium: For modules which return a deeper data structure, the \fBget_return\fP key can
be used to access results.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
test:
  test.nop:
    \- name: foo
    \- onlyif:
      \- fun: consul.get
        consul_url: http://127.0.0.1:8500
        key:  does\-exist
        get_return: res
.ft P
.fi
.UNINDENT
.UNINDENT

.sp
Changed in version 3006.0: Since the \fBonlyif\fP requisite utilizes \fBcmd.retcode\fP, certain parameters
included in the state are passed along to \fBcmd.retcode\fP\&.  On occasion this
can cause issues, particularly if the \fBshell\fP option in a \fBuser.present\fP
is set to /sbin/nologin and this shell is passed along to \fBcmd.retcode\fP\&.
This would cause \fBcmd.retcode\fP to run the command using that shell which
would fail regardless of the result of the command.
.sp
By including \fBshell\fP in \fBcmd_opts_exclude\fP, that parameter would not be
passed along to the call to \fBcmd.retcode\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jim_nologin:
  user.present:
    \- name: jim
    \- shell: /sbin/nologin
    \- onlyif:
      \- echo hello world
    \- cmd_opts_exclude:
      \- shell
.ft P
.fi
.UNINDENT
.UNINDENT

.SS creates
.sp
New in version 3001.

.sp
The \fBcreates\fP requisite specifies that a state should only run when any of
the specified files do not already exist. Like \fBunless\fP, \fBcreates\fP requisite
operates as NAND and is useful in giving more granular control over when a state
should execute. This was previously used by the \fI\%cmd\fP and
\fI\%docker_container\fP states.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
contrived creates example:
  file.touch:
    \- name: /path/to/file
    \- creates: /path/to/file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBcreates\fP also accepts a list of files, in which case this state will
run if \fBany\fP of the files do not exist:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
creates list:
  file.cmd:
    \- name: /path/to/command
    \- creates:
        \- /path/file
        \- /path/file2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS runas
.sp
New in version 2017.7.0.

.sp
The \fBrunas\fP global option is used to set the user which will be used to run
the command in the \fBcmd.run\fP module.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
django:
  pip.installed:
    \- name: django >= 1.6, <= 1.7
    \- runas: daniel
    \- require:
      \- pkg: python\-pip
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above state, the pip command run by \fBcmd.run\fP will be run by the daniel user.
.SS runas_password
.sp
New in version 2017.7.2.

.sp
The \fBrunas_password\fP global option is used to set the password used by the
runas global option. This is required by \fBcmd.run\fP on Windows when \fBrunas\fP
is specified. It will be set when \fBrunas_password\fP is defined in the state.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
run_script:
  cmd.run:
    \- name: Powershell \-NonInteractive \-ExecutionPolicy Bypass \-File C:\e\eTemp\e\escript.ps1
    \- runas: frank
    \- runas_password: supersecret
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above state, the Powershell script run by \fBcmd.run\fP will be run by the
frank user with the password \fBsupersecret\fP\&.
.SS check_cmd
.sp
New in version 2014.7.0.

.sp
Check Command is used for determining that a state did or did not run as
expected.
.sp
\fBNOTE\fP: Under the hood \fBcheck_cmd\fP calls \fBcmd.retcode\fP with
\fBpython_shell=True\fP\&. This means the command will be parsed by a shell, so
beware of side\-effects as this shell will be run with the same privileges as
the salt\-minion.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
comment\-repo:
  file.replace:
    \- name: /etc/yum.repos.d/fedora.repo
    \- pattern: \(aq^enabled=0\(aq
    \- repl: enabled=1
    \- check_cmd:
      \- \(dq! grep \(aqenabled=0\(aq /etc/yum.repos.d/fedora.repo\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will attempt to do a replace on all \fBenabled=0\fP in the .repo file, and
replace them with \fBenabled=1\fP\&. The \fBcheck_cmd\fP is just a bash command. It
will do a grep for \fBenabled=0\fP in the file, and if it finds any, it will
return a 0, which will be inverted by the leading \fB!\fP, causing \fBcheck_cmd\fP
to set the state as failed. If it returns a 1, meaning it didn\(aqt find any
\fBenabled=0\fP, it will be inverted by the leading \fB!\fP, returning a 0, and
declaring the function succeeded.
.sp
\fBNOTE\fP: This requisite \fBcheck_cmd\fP functions differently than the \fBcheck_cmd\fP
of the \fBfile.managed\fP state.
.SS Overriding Checks
.sp
There are two commands used for the above checks.
.sp
\fBmod_run_check\fP is used to check for \fBonlyif\fP and \fBunless\fP\&. If the goal is to
override the global check for these to variables, include a \fBmod_run_check\fP in the
salt/states/ file.
.sp
\fBmod_run_check_cmd\fP is used to check for the check_cmd options. To override
this one, include a \fBmod_run_check_cmd\fP in the states file for the state.
.SS Fire Event Notifications
.sp
New in version 2015.8.0.

.sp
The \fIfire_event\fP option in a state will cause the minion to send an event to
the Salt Master upon completion of that individual state.
.sp
The following example will cause the minion to send an event to the Salt Master
with a tag of \fIsalt/state_result/20150505121517276431/dasalt/nano\fP and the
result of the state will be the data field of the event. Notice that the \fIname\fP
of the state gets added to the tag.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nano_stuff:
  pkg.installed:
    \- name: nano
    \- fire_event: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the following example instead of setting \fIfire_event\fP to \fITrue\fP,
\fIfire_event\fP is set to an arbitrary string, which will cause the event to be
sent with this tag:
\fIsalt/state_result/20150505121725642845/dasalt/custom/tag/nano/finished\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nano_stuff:
  pkg.installed:
    \- name: nano
    \- fire_event: custom/tag/nano/finished
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Retrying States
.sp
New in version 2017.7.0.

.sp
The retry option in a state allows it to be executed multiple times until a desired
result is obtained or the maximum number of attempts have been made.
.sp
The retry option can be configured by the \fBattempts\fP, \fBuntil\fP, \fBinterval\fP, and
\fBsplay\fP parameters.
.sp
The \fBattempts\fP parameter controls the maximum number of times the state will be
run.  If not specified or if an invalid value is specified, \fBattempts\fP will default
to \fB2\fP\&.
.sp
The \fBuntil\fP parameter defines the result that is required to stop retrying the state.
If not specified or if an invalid value is specified, \fBuntil\fP will default to \fBTrue\fP
.sp
The \fBinterval\fP parameter defines the amount of time, in seconds, that the system
will wait between attempts.  If not specified or if an invalid value is specified,
\fBinterval\fP will default to \fB30\fP\&.
.sp
The \fBsplay\fP parameter allows the \fBinterval\fP to be additionally spread out.  If not
specified or if an invalid value is specified, \fBsplay\fP defaults to \fB0\fP (i.e. no
splaying will occur).
.sp
The following example will run the pkg.installed state until it returns \fBTrue\fP or it has
been run \fB5\fP times.  Each attempt will be \fB60\fP seconds apart and the interval will be splayed
up to an additional \fB10\fP seconds:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_retried_state:
  pkg.installed:
    \- name: nano
    \- retry:
        attempts: 5
        until: True
        interval: 60
        splay: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following example will run the pkg.installed state with all the defaults for \fBretry\fP\&.
The state will run up to \fB2\fP times, each attempt being \fB30\fP seconds apart, or until it
returns \fBTrue\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
install_nano:
  pkg.installed:
    \- name: nano
    \- retry: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following example will run the file.exists state every \fB30\fP seconds up to \fB15\fP times
or until the file exists (i.e. the state returns \fBTrue\fP).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
wait_for_file:
  file.exists:
    \- name: /path/to/file
    \- retry:
        attempts: 15
        interval: 30
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Return data from a retried state
.sp
When a state is retried, the returned output is as follows:
.sp
The \fBresult\fP return value is the \fBresult\fP from the final run.  For example, imagine a state set
to \fBretry\fP up to three times or \fBuntil\fP \fBTrue\fP\&.  If the state returns \fBFalse\fP on the first run
and then \fBTrue\fP on the second, the \fBresult\fP of the state will be \fBTrue\fP\&.
.sp
The \fBstarted\fP return value is the \fBstarted\fP from the first run.
.sp
The \fBduration\fP return value is the total duration of all attempts plus the retry intervals.
.sp
The \fBcomment\fP return value will include the result and comment from all previous attempts.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
wait_for_file:
  file.exists:
    \- name: /path/to/file
    \- retry:
        attempts: 10
        interval: 2
        splay: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Would return similar to the following.  The state result in this case is \fBFalse\fP (file.exist was run 10
times with a 2 second interval, but the file specified did not exist on any run).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
      ID: wait_for_file
Function: file.exists
  Result: False
 Comment: Attempt 1: Returned a result of \(dqFalse\(dq, with the following comment: \(dqSpecified path /path/to/file does not exist\(dq
          Attempt 2: Returned a result of \(dqFalse\(dq, with the following comment: \(dqSpecified path /path/to/file does not exist\(dq
          Attempt 3: Returned a result of \(dqFalse\(dq, with the following comment: \(dqSpecified path /path/to/file does not exist\(dq
          Attempt 4: Returned a result of \(dqFalse\(dq, with the following comment: \(dqSpecified path /path/to/file does not exist\(dq
          Attempt 5: Returned a result of \(dqFalse\(dq, with the following comment: \(dqSpecified path /path/to/file does not exist\(dq
          Attempt 6: Returned a result of \(dqFalse\(dq, with the following comment: \(dqSpecified path /path/to/file does not exist\(dq
          Attempt 7: Returned a result of \(dqFalse\(dq, with the following comment: \(dqSpecified path /path/to/file does not exist\(dq
          Attempt 8: Returned a result of \(dqFalse\(dq, with the following comment: \(dqSpecified path /path/to/file does not exist\(dq
          Attempt 9: Returned a result of \(dqFalse\(dq, with the following comment: \(dqSpecified path /path/to/file does not exist\(dq
          Specified path /path/to/file does not exist
 Started: 09:08:12.903000
Duration: 47000.0 ms
 Changes:
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Run State With a Different Umask
.sp
New in version 3002: NOTE: not available on Windows

.sp
The \fBumask\fP state argument can be used to run a state with a different umask.
Prior to version 3002 this was available to \fI\%cmd\fP
states, but it is now a global state argument that can be applied to any state.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cleanup_script:
  cmd.script:
    \- name: salt://myapp/files/my_script.sh
    \- umask: \(dq077\(dq
    \- onchanges:
      \- file: /some/file
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Startup States
.sp
Sometimes it may be desired that the salt minion execute a state run when it is
started. This alleviates the need for the master to initiate a state run on a
new minion and can make provisioning much easier.
.sp
As of Salt 0.10.3 the minion config reads options that allow for states to be
executed at startup. The options are \fIstartup_states\fP, \fIsls_list\fP, and
\fItop_file\fP\&.
.sp
The \fIstartup_states\fP option can be passed one of a number of arguments to
define how to execute states. The available options are:
.INDENT 0.0
.TP
.B \fI\%highstate\fP
Execute \fI\%state.apply\fP
.TP
.B sls
Read in the \fBsls_list\fP option and execute the named sls files
.TP
.B top
Read in the \fBtop_file\fP option and execute states based on that top file
on the Salt Master
.UNINDENT
.SS Examples:
.sp
Execute \fI\%state.apply\fP to run the
\fI\%highstate\fP when starting the minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
startup_states: highstate
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Execute the sls files \fIedit.vim\fP and \fIhyper\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
startup_states: sls

sls_list:
  \- edit.vim
  \- hyper
.ft P
.fi
.UNINDENT
.UNINDENT
.SS State Testing
.sp
Executing a Salt state run can potentially change many aspects of a system and
it may be desirable to first see what a state run is going to change before
applying the run.
.sp
Salt has a test interface to report on exactly what will be changed, this
interface can be invoked on any of the major state run functions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply test=True
salt \(aq*\(aq state.apply mysls test=True
salt \(aq*\(aq state.single test=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The test run is mandated by adding the \fBtest=True\fP option to the states. The
return information will show states that will be applied in yellow and the
result is reported as \fBNone\fP\&.
.SS Default Test
.sp
If the value \fBtest\fP is set to \fBTrue\fP in the minion configuration file then
states will default to being executed in test mode. If this value is set then
states can still be run by calling test=False:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply test=False
salt \(aq*\(aq state.apply mysls test=False
salt \(aq*\(aq state.single test=False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS The Top File
.SS Introduction
.sp
Most infrastructures are made up of groups of machines, each machine in the
group performing a role similar to others. Those groups of machines work
in concert with each other to create an application stack.
.sp
To effectively manage those groups of machines, an administrator needs to
be able to create roles for those groups. For example, a group of machines
that serve front\-end web traffic might have roles which indicate that
those machines should all have the Apache webserver package installed and
that the Apache service should always be running.
.sp
In Salt, the file which contains a mapping between groups of machines on a
network and the configuration roles that should be applied to them is
called a \fBtop file\fP\&.
.sp
Top files are named \fBtop.sls\fP by default and they are so\-named because they
always exist in the \(dqtop\(dq of a directory hierarchy that contains state files.
That directory hierarchy is called a \fBstate tree\fP\&.
.SS A Basic Example
.sp
Top files have three components:
.INDENT 0.0
.IP \(bu 2
\fBEnvironment:\fP A state tree directory containing a set of state files to
configure systems.
.IP \(bu 2
\fBTarget:\fP A grouping of machines which will have a set of states applied to
them.
.IP \(bu 2
\fBState files:\fP A list of state files to apply to a target. Each state file
describes one or more states to be configured and enforced on the targeted
machines.
.UNINDENT
.sp
The relationship between these three components is nested as follows:
.INDENT 0.0
.IP \(bu 2
Environments contain targets
.IP \(bu 2
Targets contain states
.UNINDENT
.sp
Putting these concepts together, we can describe a scenario in which all
minions with an ID that begins with \fBweb\fP have an \fBapache\fP state applied
to them:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:          # Apply SLS files from the directory root for the \(aqbase\(aq environment
  \(aqweb*\(aq:      # All minions with a minion_id that begins with \(aqweb\(aq
    \- apache   # Apply the state file named \(aqapache.sls\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Environments
.sp
Environments are directory hierarchies which contain a top file and a set
of state files.
.sp
Environments can be used in many ways, however there is no requirement that
they be used at all. In fact, the most common way to deploy Salt is with
a single environment, called \fBbase\fP\&. It is recommended that users only
create multiple environments if they have a use case which specifically
calls for multiple versions of state trees.
.SS Getting Started with Top Files
.sp
Each environment is defined inside a salt master configuration variable
called, \fI\%file_roots\fP .
.sp
In the most common single\-environment setup, only the \fBbase\fP environment is
defined in \fI\%file_roots\fP along with only one directory path for
the state tree.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above example, the top file will only have a single environment to pull
from.
.sp
Next is a simple single\-environment top file placed in \fB/srv/salt/top.sls\fP,
illustrating that for the environment called \fBbase\fP, all minions will have the
state files named \fBcore.sls\fP and \fBedit.sls\fP applied to them.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- core
    \- edit
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Assuming the \fBfile_roots\fP configuration from above, Salt will look in the
\fB/srv/salt\fP directory for \fBcore.sls\fP and \fBedit.sls\fP\&.
.SS Multiple Environments
.sp
In some cases, teams may wish to create versioned state trees which can be
used to test Salt configurations in isolated sets of systems such as a staging
environment before deploying states into production.
.sp
For this case, multiple environments can be used to accomplish this task.
.sp
To create multiple environments, the \fI\%file_roots\fP option can be
expanded:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  dev:
    \- /srv/salt/dev
  qa:
    \- /srv/salt/qa
  prod:
    \- /srv/salt/prod
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above, we declare three environments: \fBdev\fP, \fBqa\fP and \fBprod\fP\&.
Each environment has a single directory assigned to it.
.sp
Our top file references the environments:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
dev:
  \(aqwebserver*\(aq:
    \- webserver
  \(aqdb*\(aq:
    \- db
qa:
  \(aqwebserver*\(aq:
    \- webserver
  \(aqdb*\(aq:
    \- db
prod:
  \(aqwebserver*\(aq:
    \- webserver
  \(aqdb*\(aq:
    \- db
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As seen above, the top file now declares the three environments and for each,
target expressions are defined to map minions to state files. For example, all
minions which have an ID beginning with the string \fBwebserver\fP will have the
webserver state from the requested environment assigned to it.
.sp
In this manner, a proposed change to a state could first be made in a state
file in \fB/srv/salt/dev\fP and then be applied to development webservers before
moving the state into QA by copying the state file into \fB/srv/salt/qa\fP\&.
.SS Choosing an Environment to Target
.sp
The top file is used to assign a minion to an environment unless overridden
using the methods described below. The environment in the top file must match
valid fileserver environment (a.k.a. \fBsaltenv\fP) in order for any states to be
applied to that minion. When using the default fileserver backend, environments
are defined in \fI\%file_roots\fP\&.
.sp
The states that will be applied to a minion in a given environment can be
viewed using the \fI\%state.show_top\fP
function.
.sp
Minions may be pinned to a particular environment by setting the
\fI\%environment\fP value in the minion configuration file. In doing so,
a minion will only request files from the environment to which it is assigned.
.sp
The environment may also be dynamically selected at runtime by passing it to
the \fBsalt\fP, \fBsalt\-call\fP or \fBsalt\-ssh\fP command. This is most commonly done
with functions in the \fBstate\fP module by using the \fBsaltenv\fP argument. For
example, to run a \fBhighstate\fP on all minions, using only the top file and SLS
files in the \fBprod\fP environment, run: \fBsalt \(aq*\(aq state.highstate
saltenv=prod\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Not all functions accept \fBsaltenv\fP as an argument, see the documentation
for an individual function documentation to verify.
.UNINDENT
.UNINDENT
.SS Shorthand
.sp
If you assign only one SLS to a system, as in this example, a shorthand is
also available:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq: global
dev:
  \(aqwebserver*\(aq: webserver
  \(aqdb*\(aq:        db
qa:
  \(aqwebserver*\(aq: webserver
  \(aqdb*\(aq:        db
prod:
  \(aqwebserver*\(aq: webserver
  \(aqdb*\(aq:        db
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Advanced Minion Targeting
.sp
In the examples above, notice that all of the target expressions are globs. The
default match type in top files (since version 2014.7.0) is actually the
\fI\%compound matcher\fP, not the glob matcher as in the
CLI.
.sp
A single glob, when passed through the compound matcher, acts the same way as
matching by glob, so in most cases the two are indistinguishable. However,
there is an edge case in which a minion ID contains whitespace. While it is not
recommended to include spaces in a minion ID, Salt will not stop you from doing
so. However, since compound expressions are parsed word\-by\-word, if a minion ID
contains spaces it will fail to match. In this edge case, it will be necessary
to explicitly use the \fBglob\fP matcher:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqminion 1\(aq:
    \- match: glob
    \- foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The available match types which can be set for a target expression in the top
file are:
.TS
center;
|l|l|.
_
T{
Match Type
T}	T{
Description
T}
_
T{
glob
T}	T{
Full minion ID or glob expression to match multiple minions (e.g. \fBminion123\fP or \fBminion*\fP)
T}
_
T{
pcre
T}	T{
Perl\-compatible regular expression (PCRE) matching a minion ID (e.g.  \fBweb[0\-3].domain.com\fP)
T}
_
T{
grain
T}	T{
Match a \fI\%grain\fP, optionally using globbing (e.g. \fBkernel:Linux\fP or \fBkernel:*BSD\fP)
T}
_
T{
grain_pcre
T}	T{
Match a \fI\%grain\fP using PCRE (e.g. \fBkernel:(Free|Open)BSD\fP)
T}
_
T{
list
T}	T{
Comma\-separated list of minions (e.g. \fBminion1,minion2,minion3\fP)
T}
_
T{
pillar
T}	T{
\fI\%Pillar\fP match, optionally using globbing (e.g. \fBrole:webserver\fP or \fBrole:web*\fP)
T}
_
T{
pillar_pcre
T}	T{
\fI\%Pillar\fP match using PCRE (e.g. \fBrole:web(server|proxy)\fP
T}
_
T{
pillar_exact
T}	T{
\fI\%Pillar\fP match with no globbing or PCRE (e.g. \fBrole:webserver\fP)
T}
_
T{
ipcidr
T}	T{
Subnet or IP address (e.g. \fB172.17.0.0/16\fP or \fB10.2.9.80\fP)
T}
_
T{
data
T}	T{
Match values kept in the minion\(aqs datastore (created using the \fI\%data\fP execution module)
T}
_
T{
range
T}	T{
\fI\%Range\fP cluster
T}
_
T{
compound
T}	T{
Complex expression combining multiple match types (see \fI\%here\fP)
T}
_
T{
nodegroup
T}	T{
Pre\-defined compound expressions in the master config file (see \fI\%here\fP)
T}
_
.TE
.sp
Below is a slightly more complex top file example, showing some of the above
match types:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# All files will be taken from the file path specified in the base
# environment in the \(ga\(gafile_roots\(ga\(ga configuration value.

base:
    # All minions which begin with the strings \(aqnag1\(aq or any minion with
    # a grain set called \(aqrole\(aq with the value of \(aqmonitoring\(aq will have
    # the \(aqserver.sls\(aq state file applied from the \(aqnagios/\(aq directory.

    \(aqnag1* or G@role:monitoring\(aq:
        \- nagios.server

    # All minions get the following three state files applied

    \(aq*\(aq:
        \- ldap\-client
        \- networking
        \- salt.minion

    # All minions which have an ID that begins with the phrase
    # \(aqsalt\-master\(aq will have an SLS file applied that is named
    # \(aqmaster.sls\(aq and is in the \(aqsalt\(aq directory, underneath
    # the root specified in the \(ga\(gabase\(ga\(ga environment in the
    # configuration value for \(ga\(gafile_roots\(ga\(ga.

    \(aqsalt\-master*\(aq:
        \- salt.master

    # Minions that have an ID matching the following regular
    # expression will have the state file called \(aqweb.sls\(aq in the
    # nagios/mon directory applied. Additionally, minions matching
    # the regular expression will also have the \(aqserver.sls\(aq file
    # in the apache/ directory applied.

    # NOTE!
    #
    # Take note of the \(aqmatch\(aq directive here, which tells Salt
    # to treat the target string as a regex to be matched!

    \(aq^(memcache|web).(qa|prod).loc$\(aq:
        \- match: pcre
        \- nagios.mon.web
        \- apache.server

    # Minions that have a grain set indicating that they are running
    # the Ubuntu operating system will have the state file called
    # \(aqubuntu.sls\(aq in the \(aqrepos\(aq directory applied.
    #
    # Again take note of the \(aqmatch\(aq directive here which tells
    # Salt to match against a grain instead of a minion ID.

    \(aqos:Ubuntu\(aq:
        \- match: grain
        \- repos.ubuntu

    # Minions that are either RedHat or CentOS should have the \(aqepel.sls\(aq
    # state applied, from the \(aqrepos/\(aq directory.

    \(aqos:(RedHat|CentOS)\(aq:
        \- match: grain_pcre
        \- repos.epel

    # The three minions with the IDs of \(aqfoo\(aq, \(aqbar\(aq and \(aqbaz\(aq should
    # have \(aqdatabase.sls\(aq applied.

    \(aqfoo,bar,baz\(aq:
        \- match: list
        \- database

    # Any minion for which the pillar key \(aqsomekey\(aq is set and has a value
    # of that key matching \(aqabc\(aq will have the \(aqxyz.sls\(aq state applied.

    \(aqsomekey:abc\(aq:
        \- match: pillar
        \- xyz
.ft P
.fi
.UNINDENT
.UNINDENT
.SS How Top Files Are Compiled
.sp
When a \fI\%highstate\fP is executed and an environment is
specified (either using the \fI\%environment\fP config option or by
passing the saltenv when executing the \fI\%highstate\fP),
then that environment\(aqs top file is the only top file used to assign states to
minions, and only states from the specified environment will be run.
.sp
The remainder of this section applies to cases in which a \fI\%highstate\fP is executed without an environment specified.
.sp
With no environment specified, the minion will look for a top file in each
environment, and each top file will be processed to determine the SLS files to
run on the minions. By default, the top files from each environment will be
merged together. In configurations with many environments, such as with
\fI\%GitFS\fP where each branch and tag is treated as a
distinct environment, this may cause unexpected results as SLS files from older
tags cause defunct SLS files to be included in the highstate. In cases like
this, it can be helpful to set \fI\%top_file_merging_strategy\fP to
\fBsame\fP to force each environment to use its own top file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
top_file_merging_strategy: same
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Another option would be to set \fI\%state_top_saltenv\fP to a specific
environment, to ensure that any top files in other environments are
disregarded:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_top_saltenv: base
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With \fI\%GitFS\fP, it can also be helpful to simply manage
each environment\(aqs top file separately, and/or manually specify the environment
when executing the highstate to avoid any complicated merging scenarios.
\fI\%gitfs_saltenv_whitelist\fP and \fI\%gitfs_saltenv_blacklist\fP can
also be used to hide unneeded branches and tags from GitFS to reduce the number
of top files in play.
.sp
When using multiple environments, it is not necessary to create a top file for
each environment. The easiest\-to\-maintain approach is to use a single top file
placed in the \fBbase\fP environment. This is often infeasible with \fI\%GitFS\fP though, since branching/tagging can easily result in extra
top files. However, when only the default (\fBroots\fP) fileserver backend is
used, a single top file in the \fBbase\fP environment is the most common way of
configuring a \fI\%highstate\fP\&.
.sp
The following minion configuration options affect how top files are compiled
when no environment is specified, it is recommended to follow the below four
links to learn more about how these options work:
.INDENT 0.0
.IP \(bu 2
\fI\%state_top_saltenv\fP
.IP \(bu 2
\fI\%top_file_merging_strategy\fP
.IP \(bu 2
\fI\%env_order\fP
.IP \(bu 2
\fI\%default_top\fP
.UNINDENT
.SS Top File Compilation Examples
.sp
For the scenarios below, assume the following configuration:
.sp
\fB/etc/salt/master\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt/base
  dev:
    \- /srv/salt/dev
  qa:
    \- /srv/salt/qa
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/salt/base/top.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- base1
dev:
  \(aq*\(aq:
    \- dev1
qa:
  \(aq*\(aq:
    \- qa1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/salt/dev/top.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqminion1\(aq:
    \- base2
dev:
  \(aqminion2\(aq:
    \- dev2
qa:
  \(aq*\(aq:
    \- qa1
    \- qa2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For the purposes of these examples, there is no top file in the \fBqa\fP
environment.
.UNINDENT
.UNINDENT
.SS Scenario 1 \- \fBdev\fP Environment Specified
.sp
In this scenario, the \fI\%highstate\fP was either invoked
with \fBsaltenv=dev\fP or the minion has \fBenvironment: dev\fP set in the minion
config file. The result will be that only the \fBdev2\fP SLS from the dev
environment will be part of the \fI\%highstate\fP, and it
will be applied to minion2, while minion1 will have no states applied to it.
.sp
If the \fBbase\fP environment were specified, the result would be that only the
\fBbase1\fP SLS from the \fBbase\fP environment would be part of the
\fI\%highstate\fP, and it would be applied to all minions.
.sp
If the \fBqa\fP environment were specified, the \fI\%highstate\fP would exit with an error.
.SS Scenario 2 \- No Environment Specified, \fI\%top_file_merging_strategy\fP is \(dqmerge\(dq
.sp
In this scenario, assuming that the \fBbase\fP environment\(aqs top file was
evaluated first, the \fBbase1\fP, \fBdev1\fP, and \fBqa1\fP states would be applied
to all minions. If, for instance, the \fBqa\fP environment is not defined in
\fB/srv/salt/base/top.sls\fP, then because there is no top file for the \fBqa\fP
environment, no states from the \fBqa\fP environment would be applied.
.SS Scenario 3 \- No Environment Specified, \fI\%top_file_merging_strategy\fP is \(dqsame\(dq
.sp
Changed in version 2016.11.0: In prior versions, \(dqsame\(dq did not quite work as described below (see
\fI\%here\fP). This has now been corrected. It was decided that changing
something like top file handling in a point release had the potential to
unexpectedly impact users\(aq top files too much, and it would be better to
make this correction in a feature release.

.sp
In this scenario, \fBbase1\fP from the \fBbase\fP environment is applied to all
minions. Additionally, \fBdev2\fP from the \fBdev\fP environment is applied to
minion2.
.sp
If \fI\%default_top\fP is unset (or set to \fBbase\fP, which happens to be
the default), then \fBqa1\fP from the \fBqa\fP environment will be applied to all
minions. If \fI\%default_top\fP were set to \fBdev\fP, then both \fBqa1\fP
and \fBqa2\fP from the \fBqa\fP environment would be applied to all minions.
.SS Scenario 4 \- No Environment Specified, \fI\%top_file_merging_strategy\fP is \(dqmerge_all\(dq
.sp
New in version 2016.11.0.

.sp
In this scenario, all configured states in all top files are applied. From the
\fBbase\fP environment, \fBbase1\fP would be applied to all minions, with \fBbase2\fP
being applied only to \fBminion1\fP\&. From the \fBdev\fP environment, \fBdev1\fP would
be applied to all minions, with \fBdev2\fP being applied only to \fBminion2\fP\&.
Finally, from the \fBqa\fP environment, both the \fBqa1\fP and \fBqa2\fP states will
be applied to all minions. Note that the \fBqa1\fP states would not be applied
twice, even though \fBqa1\fP appears twice.
.SS SLS Template Variable Reference
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
In the 3005 release \fBsls_path\fP, \fBtplfile\fP, and \fBtpldir\fP have had some significant
improvements which have the potential to break states that rely on old and
broken functionality.
.UNINDENT
.UNINDENT
.sp
The template engines available to sls files and file templates come loaded
with a number of context variables. These variables contain information and
functions to assist in the generation of templates.  See each variable below
for its availability \-\- not all variables are available in all templating
contexts.
.SS Salt
.sp
The \fIsalt\fP variable is available to abstract the salt library functions. This
variable is a python dictionary containing all of the functions available to
the running salt minion.  It is available in all salt templates.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% for file in salt[\(aqcmd.run\(aq](\(aqls \-1 /opt/to_remove\(aq).splitlines() %}
/opt/to_remove/{{ file }}:
  file.absent
{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Opts
.sp
The \fIopts\fP variable abstracts the contents of the minion\(aqs configuration file
directly to the template. The \fIopts\fP variable is a dictionary.  It is available
in all templates.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ opts[\(aqcachedir\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBconfig.get\fP function also searches for values in the \fIopts\fP dictionary.
.SS Pillar
.sp
The \fIpillar\fP dictionary can be referenced directly, and is available in all
templates:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ pillar[\(aqkey\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using the \fBpillar.get\fP function via the \fIsalt\fP variable is generally
recommended since a default can be safely set in the event that the value
is not available in pillar and dictionaries can be traversed directly:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt[\(aqpillar.get\(aq](\(aqkey\(aq, \(aqfailover_value\(aq) }}
{{ salt[\(aqpillar.get\(aq](\(aqstuff:more:deeper\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Grains
.sp
The \fIgrains\fP dictionary makes the minion\(aqs grains directly available, and is
available in all templates:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ grains[\(aqos\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBgrains.get\fP function can be used to traverse deeper grains and set
defaults:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt[\(aqgrains.get\(aq](\(aqos\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS saltenv
.sp
The \fIsaltenv\fP variable is available in only in sls files when gathering the sls
from an environment.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ saltenv }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS SLS Only Variables
.sp
The following are only available when processing sls files. If you need these
in other templates, you can usually pass them in as template context.
.SS sls
.sp
The \fIsls\fP variable contains the sls reference value, and is only available in
the actual SLS file (not in any files referenced in that SLS). The sls
reference value is the value used to include the sls in top files or via the
include option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ sls }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS slspath
.sp
The \fIslspath\fP variable contains the path to the directory of the current sls
file. The value of \fIslspath\fP in files referenced in the current sls depends on
the reference method. For jinja includes \fIslspath\fP is the path to the current
directory of the file. For salt includes \fIslspath\fP is the path to the directory
of the included file. If current sls file is in root of the file roots, this
will return \(dq\(dq
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ slspath }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS sls_path
.sp
A version of \fIslspath\fP with underscores as path separators instead of slashes.
So, if \fIslspath\fP is \fIpath/to/state\fP then \fIsls_path\fP is \fIpath_to_state\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ sls_path }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS slsdotpath
.sp
A version of \fIslspath\fP with dots as path separators instead of slashes. So, if
\fIslspath\fP is \fIpath/to/state\fP then \fIslsdotpath\fP is \fIpath.to.state\fP\&. This is same
as \fIsls\fP if \fIsls\fP points to a directory instead if a file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ slsdotpath }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS slscolonpath
.sp
A version of \fIslspath\fP with colons (\fI:\fP) as path separators instead of slashes.
So, if \fIslspath\fP is \fIpath/to/state\fP then \fIslscolonpath\fP is \fIpath:to:state\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ slscolonpath }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS tplpath
.sp
Full path to sls template file being process on local disk. This is usually
pointing to a copy of the sls file in a cache directory. This will be in OS
specific format (Windows vs POSIX). (It is probably best not to use this.)
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ tplpath }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS tplfile
.sp
Relative path to exact sls template file being processed relative to file
roots.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ tplfile }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS tpldir
.sp
Directory, relative to file roots, of the current sls file. If current sls file
is in root of the file roots, this will return \(dq.\(dq. This is usually identical
to \fIslspath\fP except in case of root\-level sls, where this will return a \(dq\fI\&.\fP\(dq.
.sp
A Common use case for this variable is to generate relative salt urls like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-file:
  file.managed:
    source: salt://{{ tpldir }}/files/my\-template
.ft P
.fi
.UNINDENT
.UNINDENT
.SS tpldot
.sp
A version of \fItpldir\fP with dots as path separators instead of slashes. So, if
\fItpldir\fP is \fIpath/to/state\fP then \fItpldot\fP is \fIpath.to.state\fP\&. NOTE: if \fItpldir\fP
is \fI\&.\fP, this will be set to \(dq\(dq
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ tpldot }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS State Modules
.sp
State Modules are the components that map to actual enforcement and management
of Salt states.
.SS States are Easy to Write!
.sp
State Modules should be easy to write and straightforward. The information
passed to the SLS data structures will map directly to the states modules.
.sp
Mapping the information from the SLS data is simple, this example should
illustrate:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/salt/master: # maps to \(dqname\(dq, unless a \(dqname\(dq argument is specified below
  file.managed: # maps to <filename>.<function> \- e.g. \(dqmanaged\(dq in https://github.com/saltstack/salt/tree/master/salt/states/file.py
    \- user: root # one of many options passed to the manage function
    \- group: root
    \- mode: 644
    \- source: salt://salt/master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Therefore this SLS data can be directly linked to a module, function, and
arguments passed to that function.
.sp
This does issue the burden, that function names, state names and function
arguments should be very human readable inside state modules, since they
directly define the user interface.
.INDENT 0.0
.INDENT 3.5
.IP "Keyword Arguments"
.sp
Salt passes a number of keyword arguments to states when rendering them,
including the environment, a unique identifier for the state, and more.
Additionally, keep in mind that the requisites for a state are part of the
keyword arguments. Therefore, if you need to iterate through the keyword
arguments in a state, these must be considered and handled appropriately.
One such example is in the \fI\%pkgrepo.managed\fP state, which needs to be able to handle
arbitrary keyword arguments and pass them to module execution functions.
An example of how these keyword arguments can be handled can be found
\fI\%here\fP\&.
.UNINDENT
.UNINDENT
.SS Best Practices
.sp
A well\-written state function will follow these steps:
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is an extremely simplified example. Feel free to browse the \fI\%source
code\fP for Salt\(aqs state modules to see other examples.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 1. 3
Set up the return dictionary and perform any necessary input validation
(type checking, looking for use of mutually\-exclusive arguments, etc.).
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
def myfunc():
    ret = {\(dqname\(dq: name, \(dqresult\(dq: False, \(dqchanges\(dq: {}, \(dqcomment\(dq: \(dq\(dq}

    if foo and bar:
        ret[\(dqcomment\(dq] = \(dqOnly one of foo and bar is permitted\(dq
        return ret
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
Check if changes need to be made. This is best done with an
information\-gathering function in an accompanying \fI\%execution module\fP\&. The state should be able to use the return
from this function to tell whether or not the minion is already in the
desired state.
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
result = __salt__[\(dqmodname.check\(dq](name)
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
If step 2 found that the minion is already in the desired state, then exit
immediately with a \fBTrue\fP result and without making any changes.
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
def myfunc():
    if result:
        ret[\(dqresult\(dq] = True
        ret[\(dqcomment\(dq] = \(dq{0} is already installed\(dq.format(name)
        return ret
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 4. 3
If step 2 found that changes \fIdo\fP need to be made, then check to see if the
state was being run in test mode (i.e. with \fBtest=True\fP). If so, then exit
with a \fBNone\fP result, a relevant comment, and (if possible) a \fBchanges\fP
entry describing what changes would be made.
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
def myfunc():
    if __opts__[\(dqtest\(dq]:
        ret[\(dqresult\(dq] = None
        ret[\(dqcomment\(dq] = \(dq{0} would be installed\(dq.format(name)
        ret[\(dqchanges\(dq] = result
        return ret
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 5. 3
Make the desired changes. This should again be done using a function from an
accompanying execution module. If the result of that function is enough to
tell you whether or not an error occurred, then you can exit with a
\fBFalse\fP result and a relevant comment to explain what happened.
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
result = __salt__[\(dqmodname.install\(dq](name)
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 6. 3
Perform the same check from step 2 again to confirm whether or not the
minion is in the desired state. Just as in step 2, this function should be
able to tell you by its return data whether or not changes need to be made.
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
ret[\(dqchanges\(dq] = __salt__[\(dqmodname.check\(dq](name)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As you can see here, we are setting the \fBchanges\fP key in the return
dictionary to the result of the \fBmodname.check\fP function (just as we did
in step 4). The assumption here is that the information\-gathering function
will return a dictionary explaining what changes need to be made. This may
or may not fit your use case.
.IP 7. 3
Set the return data and return!
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
def myfunc():
    if ret[\(dqchanges\(dq]:
        ret[\(dqcomment\(dq] = \(dq{0} failed to install\(dq.format(name)
    else:
        ret[\(dqresult\(dq] = True
        ret[\(dqcomment\(dq] = \(dq{0} was installed\(dq.format(name)

    return ret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Using Custom State Modules
.sp
Before the state module can be used, it must be distributed to minions. This
can be done by placing them into \fBsalt://_states/\fP\&. They can then be
distributed manually to minions by running \fI\%saltutil.sync_states\fP or \fI\%saltutil.sync_all\fP\&. Alternatively, when running a
\fI\%highstate\fP custom types will automatically be synced.
.sp
NOTE: Writing state modules with hyphens in the filename will cause issues
with !pyobjects routines.  Best practice to stick to underscores.
.sp
Any custom states which have been synced to a minion, that are named the same
as one of Salt\(aqs default set of states, will take the place of the default
state with the same name. Note that a state module\(aqs name defaults to one based
on its filename (i.e. \fBfoo.py\fP becomes state module \fBfoo\fP), but that its
name can be overridden by using a \fI\%__virtual__ function\fP\&.
.SS Cross Calling Execution Modules from States
.sp
As with Execution Modules, State Modules can also make use of the \fB__salt__\fP
and \fB__grains__\fP data. See \fI\%cross calling execution modules\fP\&.
.sp
It is important to note that the real work of state management should not be
done in the state module unless it is needed. A good example is the pkg state
module. This module does not do any package management work, it just calls the
pkg execution module. This makes the pkg state module completely generic, which
is why there is only one pkg state module and many backend pkg execution
modules.
.sp
On the other hand some modules will require that the logic be placed in the
state module, a good example of this is the file module. But in the vast
majority of cases this is not the best approach, and writing specific
execution modules to do the backend work will be the optimal solution.
.SS Cross Calling State Modules
.sp
All of the Salt state modules are available to each other and state modules can call
functions available in other state modules.
.sp
The variable \fB__states__\fP is packed into the modules after they are loaded into
the Salt minion.
.sp
The \fB__states__\fP variable is a \fI\%Python dictionary\fP
containing all of the state modules. Dictionary keys are strings representing
the names of the modules and the values are the functions themselves.
.sp
Salt state modules can be cross\-called by accessing the value in the
\fB__states__\fP dict:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ret = __states__[\(dqfile.managed\(dq](name=\(dq/tmp/myfile\(dq, source=\(dqsalt://myfile\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This code will call the \fImanaged\fP function in the \fI\%file\fP state module and pass the arguments \fBname\fP and \fBsource\fP
to it.
.SS Return Data
.sp
A State Module must return a dict containing the following keys/values:
.INDENT 0.0
.IP \(bu 2
\fBname:\fP The same value passed to the state as \(dqname\(dq.
.IP \(bu 2
\fBchanges:\fP A dict describing the changes made. Each thing changed should
be a key, with its value being another dict with keys called \(dqold\(dq and \(dqnew\(dq
containing the old/new values. For example, the pkg state\(aqs \fBchanges\fP dict
has one key for each package changed, with the \(dqold\(dq and \(dqnew\(dq keys in its
sub\-dict containing the old and new versions of the package. For example,
the final changes dictionary for this scenario would look something like this:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
ret[\(dqchanges\(dq].update({\(dqmy_pkg_name\(dq: {\(dqold\(dq: \(dq\(dq, \(dqnew\(dq: \(dqmy_pkg_name\-1.0\(dq}})
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBresult:\fP A tristate value.  \fBTrue\fP if the action was successful,
\fBFalse\fP if it was not, or \fBNone\fP if the state was run in test mode,
\fBtest=True\fP, and changes would have been made if the state was not run in
test mode.
.TS
center;
|l|l|l|.
_
T{
T}	T{
live mode
T}	T{
test mode
T}
_
T{
no changes
T}	T{
\fBTrue\fP
T}	T{
\fBTrue\fP
T}
_
T{
successful changes
T}	T{
\fBTrue\fP
T}	T{
\fBNone\fP
T}
_
T{
failed changes
T}	T{
\fBFalse\fP
T}	T{
\fBFalse\fP or \fBNone\fP
T}
_
.TE
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
Test mode does not predict if the changes will be successful or not,
and hence the result for pending changes is usually \fBNone\fP\&.
.sp
However, if a state is going to fail and this can be determined
in test mode without applying the change, \fBFalse\fP can be returned.
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBcomment:\fP A list of strings or a single string summarizing the result.
Note that support for lists of strings is available as of Salt 2018.3.0.
Lists of strings will be joined with newlines to form the final comment;
this is useful to allow multiple comments from subparts of a state.
Prefer to keep line lengths short (use multiple lines as needed),
and end with punctuation (e.g. a period) to delimit multiple comments.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
States should not return data which cannot be serialized such as frozensets.
.UNINDENT
.UNINDENT
.SS Sub State Runs
.sp
Some states can return multiple state runs from an external engine.
State modules that extend tools like Puppet, Chef, Ansible, and idem can run multiple external
states and then return their results individually in the \(dqsub_state_run\(dq portion of their return
as long as their individual state runs are formatted like salt states with low and high data.
.sp
For example, the idem state module can execute multiple idem states
via it\(aqs runtime and report the status of all those runs by attaching them to \(dqsub_state_run\(dq in it\(aqs state return.
These sub_state_runs will be formatted and printed alongside other salt states.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_return = {
    \(dqname\(dq: None,  # The parent state name
    \(dqresult\(dq: None,  # The overall status of the external state engine run
    \(dqcomment\(dq: None,  # Comments on the overall external state engine run
    \(dqchanges\(dq: {},  # An empty dictionary, each sub state run has it\(aqs own changes to report
    \(dqsub_state_run\(dq: [
        {
            \(dqchanges\(dq: {},  # A dictionary describing the changes made in the external state run
            \(dqresult\(dq: None,  # The external state run name
            \(dqcomment\(dq: None,  # Comment on the external state run
            \(dqduration\(dq: None,  # Optional, the duration in seconds of the external state run
            \(dqstart_time\(dq: None,  # Optional, the timestamp of the external state run\(aqs start time
            \(dqlow\(dq: {
                \(dqname\(dq: None,  # The name of the state from the external state run
                \(dqstate\(dq: None,  # Name of the external state run
                \(dq__id__\(dq: None,  # ID of the external state run
                \(dqfun\(dq: None,  # The Function name from the external state run
            },
        }
    ],
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Test State
.sp
All states should check for and support \fBtest\fP being passed in the options.
This will return data about what changes would occur if the state were actually
run. An example of such a check could look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def myfunc():
    # Return comment of changes if test.
    if __opts__[\(dqtest\(dq]:
        ret[\(dqresult\(dq] = None
        ret[\(dqcomment\(dq] = \(dqState Foo will execute with param {0}\(dq.format(bar)
        return ret
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Make sure to test and return before performing any real actions on the minion.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Be sure to refer to the \fBresult\fP table listed above and displaying any
possible changes when writing support for \fBtest\fP\&. Looking for changes in
a state is essential to \fBtest=true\fP functionality. If a state is predicted
to have no changes when \fBtest=true\fP (or \fBtest: true\fP in a config file)
is used, then the result of the final state \fBshould not\fP be \fBNone\fP\&.
.UNINDENT
.UNINDENT
.SS Watcher Function
.sp
If the state being written should support the watch requisite then a watcher
function needs to be declared. The watcher function is called whenever the
watch requisite is invoked and should be generic to the behavior of the state
itself.
.sp
The watcher function should accept all of the options that the normal state
functions accept (as they will be passed into the watcher function).
.sp
A watcher function typically is used to execute state specific reactive
behavior, for instance, the watcher for the service module restarts the
named service and makes it useful for the watcher to make the service
react to changes in the environment.
.sp
The watcher function also needs to return the same data that a normal state
function returns.
.SS Mod_init Interface
.sp
Some states need to execute something only once to ensure that an environment
has been set up, or certain conditions global to the state behavior can be
predefined. This is the realm of the mod_init interface.
.sp
A state module can have a function called \fBmod_init\fP which executes when the
first state of this type is called. This interface was created primarily to
improve the pkg state. When packages are installed the package metadata needs
to be refreshed, but refreshing the package metadata every time a package is
installed is wasteful. The mod_init function for the pkg state sets a flag down
so that the first, and only the first, package installation attempt will refresh
the package database (the package database can of course be manually called to
refresh via the \fBrefresh\fP option in the pkg state).
.sp
The mod_init function must accept the \fBLow State Data\fP for the given
executing state as an argument. The low state data is a dict and can be seen by
executing the state.show_lowstate function. Then the mod_init function must
return a bool. If the return value is True, then the mod_init function will not
be executed again, meaning that the needed behavior has been set up. Otherwise,
if the mod_init function returns False, then the function will be called the
next time.
.sp
A good example of the mod_init function is found in the pkg state module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def mod_init(low):
    \(dq\(dq\(dq
    Refresh the package database here so that it only needs to happen once
    \(dq\(dq\(dq
    if low[\(dqfun\(dq] == \(dqinstalled\(dq or low[\(dqfun\(dq] == \(dqlatest\(dq:
        rtag = __gen_rtag()
        if not os.path.exists(rtag):
            open(rtag, \(dqw+\(dq).write(\(dq\(dq)
        return True
    else:
        return False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The mod_init function in the pkg state accepts the low state data as \fBlow\fP
and then checks to see if the function being called is going to install
packages, if the function is not going to install packages then there is no
need to refresh the package database. Therefore if the package database is
prepared to refresh, then return True and the mod_init will not be called
the next time a pkg state is evaluated, otherwise return False and the mod_init
will be called next time a pkg state is evaluated.
.SS Log Output
.sp
You can call the logger from custom modules to write messages to the minion
logs. The following code snippet demonstrates writing log messages:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import logging

log = logging.getLogger(__name__)

log.info(\(dqHere is Some Information\(dq)
log.warning(\(dqYou Should Not Do That\(dq)
log.error(\(dqIt Is Busted\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Strings and Unicode
.sp
A state module author should always assume that strings fed to the module
have already decoded from strings into Unicode. In Python 2, these will
be of type \(aqUnicode\(aq and in Python 3 they will be of type \fBstr\fP\&. Calling
from a state to other Salt sub\-systems, such as execution modules should
pass Unicode (or bytes if passing binary data). In the rare event that a state needs to write directly
to disk, Unicode should be encoded to a string immediately before writing
to disk. An author may use \fB__salt_system_encoding__\fP to learn what the
encoding type of the system is. For example,
\fI\(aqmy_string\(aq.encode(__salt_system_encoding__\(aq)\fP\&.
.SS Full State Module Example
.sp
The following is a simplistic example of a full state module and function.
Remember to call out to execution modules to perform all the real work. The
state module should only perform \(dqbefore\(dq and \(dqafter\(dq checks.
.INDENT 0.0
.IP 1. 3
Make a custom state module by putting the code into a file at the following
path: \fB/srv/salt/_states/my_custom_state.py\fP\&.
.IP 2. 3
Distribute the custom state module to the minions:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_states
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
Write a new state to use the custom state by making a new state file, for
instance \fB/srv/salt/my_custom_state.sls\fP\&.
.IP 4. 3
Add the following SLS configuration to the file created in Step 3:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
human_friendly_state_id:        # An arbitrary state ID declaration.
  my_custom_state:              # The custom state module name.
    \- enforce_custom_thing      # The function in the custom state module.
    \- name: a_value             # Maps to the \(ga\(ganame\(ga\(ga parameter in the custom function.
    \- foo: Foo                  # Specify the required \(ga\(gafoo\(ga\(ga parameter.
    \- bar: False                # Override the default value for the \(ga\(gabar\(ga\(ga parameter.
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Example state module
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.exceptions


def enforce_custom_thing(name, foo, bar=True):
    \(dq\(dq\(dq
    Enforce the state of a custom thing

    This state module does a custom thing. It calls out to the execution module
    \(ga\(gamy_custom_module\(ga\(ga in order to check the current system and perform any
    needed changes.

    name
        The thing to do something to
    foo
        A required argument
    bar : True
        An argument with a default value
    \(dq\(dq\(dq
    ret = {
        \(dqname\(dq: name,
        \(dqchanges\(dq: {},
        \(dqresult\(dq: False,
        \(dqcomment\(dq: \(dq\(dq,
    }

    # Start with basic error\-checking. Do all the passed parameters make sense
    # and agree with each\-other?
    if bar == True and foo.startswith(\(dqFoo\(dq):
        raise salt.exceptions.SaltInvocationError(
            \(aqArgument \(dqfoo\(dq cannot start with \(dqFoo\(dq if argument \(dqbar\(dq is True.\(aq
        )

    # Check the current state of the system. Does anything need to change?
    current_state = __salt__[\(dqmy_custom_module.current_state\(dq](name)

    if current_state == foo:
        ret[\(dqresult\(dq] = True
        ret[\(dqcomment\(dq] = \(dqSystem already in the correct state\(dq
        return ret

    # The state of the system does need to be changed. Check if we\(aqre running
    # in \(ga\(gatest=true\(ga\(ga mode.
    if __opts__[\(dqtest\(dq] == True:
        ret[\(dqcomment\(dq] = \(aqThe state of \(dq{0}\(dq will be changed.\(aq.format(name)
        ret[\(dqchanges\(dq] = {
            \(dqold\(dq: current_state,
            \(dqnew\(dq: \(dqDescription, diff, whatever of the new state\(dq,
        }

        # Return \(ga\(gaNone\(ga\(ga when running with \(ga\(gatest=true\(ga\(ga.
        ret[\(dqresult\(dq] = None

        return ret

    # Finally, make the actual change and return the result.
    new_state = __salt__[\(dqmy_custom_module.change_state\(dq](name, foo)

    ret[\(dqcomment\(dq] = \(aqThe state of \(dq{0}\(dq was changed!\(aq.format(name)

    ret[\(dqchanges\(dq] = {
        \(dqold\(dq: current_state,
        \(dqnew\(dq: new_state,
    }

    ret[\(dqresult\(dq] = True

    return ret
.ft P
.fi
.UNINDENT
.UNINDENT
.SS State Management
.sp
State management, also frequently called Software Configuration Management
(SCM), is a program that puts and keeps a system into a predetermined state. It
installs software packages, starts or restarts services or puts configuration
files in place and watches them for changes.
.sp
Having a state management system in place allows one to easily and reliably
configure and manage a few servers or a few thousand servers. It allows
configurations to be kept under version control.
.sp
Salt States is an extension of the Salt Modules that we discussed in the
previous \fI\%remote execution\fP tutorial. Instead
of calling one\-off executions the state of a system can be easily defined and
then enforced.
.SS Understanding the Salt State System Components
.sp
The Salt state system is comprised of a number of components. As a user, an
understanding of the SLS and renderer systems are needed. But as a developer,
an understanding of Salt states and how to write the states is needed as well.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
States are compiled and executed only on minions that have been targeted.
To execute functions directly on masters, see \fI\%runners\fP\&.
.UNINDENT
.UNINDENT
.SS Salt SLS System
.sp
The primary system used by the Salt state system is the SLS system. SLS stands
for \fBS\fPa\fBL\fPt \fBS\fPtate.
.sp
The Salt States are files which contain the information about how to configure
Salt minions. The states are laid out in a directory tree and can be written in
many different formats.
.sp
The contents of the files and the way they are laid out is intended to be as
simple as possible while allowing for maximum flexibility. The files are laid
out in states and contains information about how the minion needs to be
configured.
.SS SLS File Layout
.sp
SLS files are laid out in the Salt file server.
.sp
A simple layout can look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
top.sls
ssh.sls
sshd_config
users/init.sls
users/admin.sls
salt/master.sls
web/init.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBtop.sls\fP file is a key component. The \fBtop.sls\fP files
is used to determine which SLS files should be applied to which minions.
.sp
The rest of the files with the \fB\&.sls\fP extension in the above example are
state files.
.sp
Files without a \fB\&.sls\fP extensions are seen by the Salt master as
files that can be downloaded to a Salt minion.
.sp
States are translated into dot notation. For example, the \fBssh.sls\fP file is
seen as the ssh state and the \fBusers/admin.sls\fP file is seen as the
users.admin state.
.sp
Files named \fBinit.sls\fP are translated to be the state name of the parent
directory, so the \fBweb/init.sls\fP file translates to the \fBweb\fP state.
.sp
In Salt, everything is a file; there is no \(dqmagic translation\(dq of files and file
types. This means that a state file can be distributed to minions just like a
plain text or binary file.
.SS SLS Files
.sp
The Salt state files are simple sets of data. Since SLS files are just data
they can be represented in a number of different ways.
.sp
The default format is YAML generated from a Jinja template. This allows for the
states files to have all the language constructs of Python and the simplicity of YAML.
.sp
State files can then be complicated Jinja templates that translate down to YAML, or just
plain and simple YAML files.
.sp
The State files are simply common data structures such as dictionaries and lists, constructed
using a templating language such as YAML.
.sp
Here is an example of a Salt State:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed: []

salt:
  pkg.latest:
    \- name: salt
  service.running:
    \- names:
      \- salt\-master
      \- salt\-minion
    \- require:
      \- pkg: salt
    \- watch:
      \- file: /etc/salt/minion

/etc/salt/minion:
  file.managed:
    \- source: salt://salt/minion
    \- user: root
    \- group: root
    \- mode: 644
    \- require:
      \- pkg: salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This short stanza will ensure that vim is installed, Salt is installed and up
to date, the salt\-master and salt\-minion daemons are running and the Salt
minion configuration file is in place. It will also ensure everything is
deployed in the right order and that the Salt services are restarted when the
watched file updated.
.SS The Top File
.sp
The top file controls the mapping between minions and the states which should
be applied to them.
.sp
The top file specifies which minions should have which SLS files applied and
which environments they should draw those SLS files from.
.sp
The top file works by specifying environments on the top\-level.
.sp
Each environment contains \fI\%target expressions\fP to match
minions. Finally, each target expression contains a list of Salt states to
apply to matching minions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- salt
    \- users
    \- users.admin
  \(aqsaltmaster.*\(aq:
    \- match: pcre
    \- salt.master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This above example uses the base environment which is built into the default
Salt setup.
.sp
The base environment has target expressions. The first one matches all minions,
and the SLS files below it apply to all minions.
.sp
The second expression is a regular expression that will match all minions
with an ID matching \fBsaltmaster.*\fP and specifies that for those minions, the
salt.master state should be applied.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
Since version 2014.7.0, the default matcher (when one is not explicitly
defined as in the second expression in the above example) is the
\fI\%compound\fP matcher. Since this matcher parses
individual words in the expression, minion IDs containing spaces will not
match properly using this matcher. Therefore, if your target expression is
designed to match a minion ID containing spaces, it will be necessary to
specify a different match type (such as \fBglob\fP). For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqtest minion\(aq:
    \- match: glob
    \- foo
    \- bar
    \- baz
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
A full table of match types available in the top file can be found \fI\%here\fP\&.
.SS Reloading Modules
.sp
Some Salt states require that specific packages be installed in order for the
module to load. As an example the \fI\%pip\fP state
module requires the \fI\%pip\fP package for proper name and version parsing.
.sp
In most of the common cases, Salt is clever enough to transparently reload the
modules. For example, if you install a package, Salt reloads modules because
some other module or state might require just that package which was installed.
.sp
On some edge\-cases salt might need to be told to reload the modules. Consider
the following state file which we\(aqll call \fBpep8.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python\-pip:
  cmd.run:
    \- name: |
        easy_install \-\-script\-dir=/usr/bin \-U pip
    \- cwd: /

pep8:
  pip.installed:
    \- require:
      \- cmd: python\-pip
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above example installs \fI\%pip\fP using \fBeasy_install\fP from \fI\%setuptools\fP and
installs \fI\%pep8\fP using \fI\%pip\fP, which, as told
earlier, requires \fI\%pip\fP to be installed system\-wide. Let\(aqs execute this state:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call state.apply pep8
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The execution output would be something like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-\-\-\-\-\-\-\-\-
    State: \- pip
    Name:      pep8
    Function:  installed
        Result:    False
        Comment:   State pip.installed found in sls pep8 is unavailable

        Changes:

Summary
\-\-\-\-\-\-\-\-\-\-\-\-
Succeeded: 1
Failed:    1
\-\-\-\-\-\-\-\-\-\-\-\-
Total:     2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If we executed the state again the output would be:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-\-\-\-\-\-\-\-\-
    State: \- pip
    Name:      pep8
    Function:  installed
        Result:    True
        Comment:   Package was successfully installed
        Changes:   pep8==1.4.6: Installed

Summary
\-\-\-\-\-\-\-\-\-\-\-\-
Succeeded: 2
Failed:    0
\-\-\-\-\-\-\-\-\-\-\-\-
Total:     2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Since we installed \fI\%pip\fP using \fI\%cmd\fP, Salt has no way
to know that a system\-wide package was installed.
.sp
On the second execution, since the required \fI\%pip\fP package was installed, the
state executed correctly.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Salt does not reload modules on every state run because doing so would greatly
slow down state execution.
.UNINDENT
.UNINDENT
.sp
So how do we solve this \fIedge\-case\fP? \fBreload_modules\fP!
.sp
\fBreload_modules\fP is a boolean option recognized by salt on \fBall\fP available
states which forces salt to reload its modules once a given state finishes.
.sp
The modified state file would now be:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python\-pip:
  cmd.run:
    \- name: |
        easy_install \-\-script\-dir=/usr/bin \-U pip
    \- cwd: /
    \- reload_modules: true

pep8:
  pip.installed:
    \- require:
      \- cmd: python\-pip
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Let\(aqs run it, once:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call state.apply pep8
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The output is:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-\-\-\-\-\-\-\-\-
    State: \- pip
    Name:      pep8
    Function:  installed
        Result:    True
        Comment:   Package was successfully installed
        Changes:   pep8==1.4.6: Installed

Summary
\-\-\-\-\-\-\-\-\-\-\-\-
Succeeded: 2
Failed:    0
\-\-\-\-\-\-\-\-\-\-\-\-
Total:     2
.ft P
.fi
.UNINDENT
.UNINDENT
.SH RETURN CODES
.sp
When the \fBsalt\fP or \fBsalt\-call\fP CLI commands result in an error, the command
will exit with a return code of \fB1\fP\&. Error cases consist of the following:
.INDENT 0.0
.IP 1. 3
Errors are encountered while running \fI\%States\fP, or any state returns a \fBFalse\fP result
.IP 2. 3
Any exception is raised
.IP 3. 3
In the case of remote\-execution functions, when the return data is a
\fI\%Python dictionary\fP with a key named either \fBresult\fP
or \fBsuccess\fP, which has a value of \fBFalse\fP
.UNINDENT
.SS Retcode Passthrough
.sp
In addition to the cases listed above, if a state or remote\-execution function
sets a nonzero value in the \fBretcode\fP key of the \fI\%__context__\fP dictionary, the command will exit with a return code of
\fB1\fP\&. For those developing custom states and execution modules, using
\fB__context__[\(aqretcode\(aq]\fP can be a useful way of signaling that an error has
occurred:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
if something_went_wrong:
    __context__[\(dqretcode\(dq] = 42
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is actually how states signal that they have failed. Different cases
result in different codes being set in the \fI\%__context__\fP
dictionary:
.INDENT 0.0
.IP \(bu 2
\fB1\fP is set when any error is encountered in the state compiler (missing SLS
file, etc.)
.IP \(bu 2
\fB2\fP is set when any state returns a \fBFalse\fP result
.IP \(bu 2
\fB5\fP is set when Pillar data fails to be compiled before running the
state(s)
.UNINDENT
.sp
When the \fB\-\-retcode\-passthrough\fP flag is used with \fBsalt\-call\fP, then
\fBsalt\-call\fP will exit with whichever retcode was set in the \fI\%__context__\fP dictionary, rather than the default behavior which simply
exits with \fB1\fP for any error condition.
.SH UTILITY MODULES - CODE REUSE IN CUSTOM MODULES
.sp
New in version 2015.5.0.

.sp
Changed in version 2016.11.0: These can now be synced to the Master for use in custom Runners, and in
custom execution modules called within Pillar SLS files.

.sp
When extending Salt by writing custom (\fI\%state modules\fP), \fI\%execution modules\fP, etc., sometimes there is a need for a function to
be available to more than just one kind of custom module. For these cases, Salt
supports what are called \(dqutility modules\(dq. These modules are like normal
execution modules, but instead of being invoked in Salt code using
\fB__salt__\fP, the \fB__utils__\fP prefix is used instead.
.sp
For example, assuming the following simple utility module, saved to
\fBsalt://_utils/foo.py\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# \-*\- coding: utf\-8 \-*\-
\(dq\(dq\(dq
My utils module
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-

This module contains common functions for use in my other custom types.
\(dq\(dq\(dq


def bar():
    return \(dqbaz\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once synced to a minion, this function would be available to other custom Salt
types like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# \-*\- coding: utf\-8 \-*\-
\(dq\(dq\(dq
My awesome execution module
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\(dq\(dq\(dq


def observe_the_awesomeness():
    \(dq\(dq\(dq
    Prints information from my utility module

    CLI Example:

    .. code\-block:: bash

        salt \(aq*\(aq mymodule.observe_the_awesomeness
    \(dq\(dq\(dq
    return __utils__[\(dqfoo.bar\(dq]()
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Utility modules, like any other kind of Salt extension, support using a
\fI\%__virtual__ function\fP to conditionally load them,
or load them under a different namespace. For instance, if the utility module
above were named \fBsalt://_utils/mymodule.py\fP it could be made to be loaded as
the \fBfoo\fP utility module with a \fB__virtual__\fP function.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# \-*\- coding: utf\-8 \-*\-
\(dq\(dq\(dq
My utils module
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-

This module contains common functions for use in my other custom types.
\(dq\(dq\(dq


def __virtual__():
    \(dq\(dq\(dq
    Load as a different name
    \(dq\(dq\(dq
    return \(dqfoo\(dq


def bar():
    return \(dqbaz\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0: Instantiating objects from classes declared in util modules works with
Master side modules, such as Runners, Outputters, etc.

.sp
Also you could even write your utility modules in object oriented fashion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# \-*\- coding: utf\-8 \-*\-
\(dq\(dq\(dq
My OOP\-style utils module
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-

This module contains common functions for use in my other custom types.
\(dq\(dq\(dq


class Foo(object):
    def __init__(self):
        pass

    def bar(self):
        return \(dqbaz\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And import them into other custom modules:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# \-*\- coding: utf\-8 \-*\-
\(dq\(dq\(dq
My awesome execution module
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\(dq\(dq\(dq

import mymodule


def observe_the_awesomeness():
    \(dq\(dq\(dq
    Prints information from my utility module

    CLI Example:

    .. code\-block:: bash

        salt \(aq*\(aq mymodule.observe_the_awesomeness
    \(dq\(dq\(dq
    foo = mymodule.Foo()
    return foo.bar()
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
These are, of course, contrived examples, but they should serve to show some of
the possibilities opened up by writing utility modules. Keep in mind though
that states still have access to all of the execution modules, so it is not
necessary to write a utility module to make a function available to both a
state and an execution module. One good use case for utility modules is one
where it is necessary to invoke the same function from a custom \fI\%outputter\fP/returner, as well as an execution module.
.sp
Utility modules placed in \fBsalt://_utils/\fP will be synced to the minions when
a \fI\%highstate\fP is run, as well as when any of the
following Salt functions are called:
.INDENT 0.0
.IP \(bu 2
\fI\%saltutil.sync_utils\fP
.IP \(bu 2
\fI\%saltutil.sync_all\fP
.UNINDENT
.sp
As of the 2019.2.0 release, as well as 2017.7.7 and 2018.3.2 in their
respective release cycles, the \fBsync\fP argument to \fI\%state.apply\fP/\fI\%state.sls\fP can
be used to sync custom types when running individual SLS files.
.sp
To sync to the Master, use either of the following:
.INDENT 0.0
.IP \(bu 2
\fI\%saltutil.sync_utils\fP
.IP \(bu 2
\fI\%saltutil.sync_all\fP
.UNINDENT
.SH EVENTS & REACTOR
.SS Event System
.sp
The Salt Event System is used to fire off events enabling third party
applications or external processes to react to behavior within Salt.
The event system uses a publish\-subscribe pattern, otherwise know as pub/sub.
.SS Event Bus
.sp
The event system is comprised of a two primary components, which make up the
concept of an Event Bus:
.INDENT 0.0
.IP \(bu 2
The event sockets, which publish events
.IP \(bu 2
The event library, which can listen to events and send events into the salt system
.UNINDENT
.sp
Events are published onto the event bus and event bus subscribers listen for the
published events.
.sp
The event bus is used for both inter\-process communication as well as network transport
in Salt. Inter\-process communication is provided through UNIX domain sockets (UDX).
.sp
The Salt Master and each Salt Minion has their own event bus.
.SS Event types
.SS Salt Master Events
.sp
These events are fired on the Salt Master event bus. This list is \fBnot\fP
comprehensive.
.SS Authentication events
.INDENT 0.0
.TP
.B salt/auth
Fired when a minion performs an authentication check with the master.
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBid\fP \-\- The minion ID.
.IP \(bu 2
\fBact\fP \-\- The current status of the minion key: \fBaccept\fP, \fBpend\fP,
\fBreject\fP\&.
.IP \(bu 2
\fBpub\fP \-\- The minion public key.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Minions fire auth events on fairly regular basis for a number
of reasons.  Writing reactors to respond to events through
the auth cycle can lead to infinite reactor event loops
(minion tries to auth, reactor responds by doing something
that generates another auth event, minion sends auth event,
etc.).  Consider reacting to \fBsalt/key\fP or \fBsalt/minion/<MID>/start\fP
or firing a custom event tag instead.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Start events
.INDENT 0.0
.TP
.B salt/minion/<MID>/start
Fired every time a minion connects to the Salt master.
.INDENT 7.0
.TP
.B Variables
\fBid\fP \-\- The minion ID.
.UNINDENT
.UNINDENT
.SS Key events
.INDENT 0.0
.TP
.B salt/key
Fired when accepting and rejecting minions keys on the Salt master.
These happen as a result of actions undertaken by the \fIsalt\-key\fP command.
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBid\fP \-\- The minion ID.
.IP \(bu 2
\fBact\fP \-\- The new status of the minion key: \fBaccept\fP, \fBdelete\fP,
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
If a master is in \fBauto_accept mode\fP, \fBsalt/key\fP events
will not be fired when the keys are accepted.  In addition, pre\-seeding
keys (like happens through \fI\%Salt\-Cloud\fP) will not cause
firing of these events.
.UNINDENT
.UNINDENT
.SS Job events
.INDENT 0.0
.TP
.B salt/job/<JID>/new
Fired as a new job is sent out to minions.
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBjid\fP \-\- The job ID.
.IP \(bu 2
\fBtgt\fP \-\- The target of the job: \fB*\fP, a minion ID,
\fBG@os_family:RedHat\fP, etc.
.IP \(bu 2
\fBtgt_type\fP \-\- The type of targeting used: \fBglob\fP, \fBgrain\fP,
\fBcompound\fP, etc.
.IP \(bu 2
\fBfun\fP \-\- The function to run on minions: \fBtest.version\fP,
\fBnetwork.interfaces\fP, etc.
.IP \(bu 2
\fBarg\fP \-\- A list of arguments to pass to the function that will be
called.
.IP \(bu 2
\fBminions\fP \-\- A list of minion IDs that Salt expects will return data for
this job.
.IP \(bu 2
\fBuser\fP \-\- The name of the user that ran the command as defined in Salt\(aqs
Publisher ACL or external auth.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt/job/<JID>/ret/<MID>
Fired each time a minion returns data for a job.
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBid\fP \-\- The minion ID.
.IP \(bu 2
\fBjid\fP \-\- The job ID.
.IP \(bu 2
\fBretcode\fP \-\- The return code for the job.
.IP \(bu 2
\fBfun\fP \-\- The function the minion ran. E.g., \fBtest.version\fP\&.
.IP \(bu 2
\fBreturn\fP \-\- The data returned from the execution module.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt/job/<JID>/prog/<MID>/<RUN NUM>
Fired each time a each function in a state run completes execution. Can
also be fired on individual state if the \fI\%fire_event\fP
option is set on that state.
.sp
Can be enabled for all state runs in the Salt master config with the
\fI\%state_events\fP option. To enable for an individual state
run, pass \fBstate_events=True\fP to the \fI\%state\fP
function being used.
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBdata\fP \-\- The data returned from the state module function.
.IP \(bu 2
\fBid\fP \-\- The minion ID.
.IP \(bu 2
\fBjid\fP \-\- The job ID.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Runner Events
.INDENT 0.0
.TP
.B salt/run/<JID>/new
Fired as a runner begins execution
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBjid\fP \-\- The job ID.
.IP \(bu 2
\fBfun\fP \-\- The name of the runner function, with \fBrunner.\fP prepended to it
(e.g. \fBrunner.jobs.lookup_jid\fP)
.IP \(bu 2
\fBfun_args\fP \-\- The arguments passed to the runner function (e.g.
\fB[\(aq20160829225914848058\(aq]\fP)
.IP \(bu 2
\fBuser\fP \-\- The user who executed the runner (e.g. \fBroot\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt/run/<JID>/ret
Fired when a runner function returns
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBjid\fP \-\- The job ID.
.IP \(bu 2
\fBfun\fP \-\- The name of the runner function, with \fBrunner.\fP prepended to it
(e.g. \fBrunner.jobs.lookup_jid\fP)
.IP \(bu 2
\fBfun_args\fP \-\- The arguments passed to the runner function (e.g.
\fB[\(aq20160829225914848058\(aq]\fP)
.IP \(bu 2
\fBreturn\fP \-\- The data returned by the runner function
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt/run/<JID>/args
New in version 2016.11.0.

.sp
Fired by the \fI\%state.orchestrate\fP
runner
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The ID declaration for the orchestration job (i.e. the line
above \fBsalt.state\fP, \fBsalt.function\fP, \fBsalt.runner\fP, etc.)
.IP \(bu 2
\fBtype\fP \-\- The type of orchestration job being run (e.g. \fBstate\fP)
.IP \(bu 2
\fBtgt\fP \-\- The target expression (e.g. \fB*\fP). Included for \fBstate\fP and
\fBfunction\fP types only.
.IP \(bu 2
\fBargs\fP \-\- The args passed to the orchestration job. \fBNote:\fP for
\fBstate\fP and \fBfunction\fP types, also includes a \fBtgt_type\fP value
which shows what kind of match (\fBglob\fP, \fBpcre\fP, etc.) was used.
This value was named \fBexpr_form\fP in the 2016.11 release cycle but has
been renamed to \fBtgt_type\fP in 2017.7.0 for consistency with other
events.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Presence Events
.INDENT 0.0
.TP
.B salt/presence/present
Events fired on a regular interval about currently connected, newly
connected, or recently disconnected minions. Requires the
\fI\%presence_events\fP setting to be enabled.
.INDENT 7.0
.TP
.B Variables
\fBpresent\fP \-\- A list of minions that are currently connected to the Salt
master.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt/presence/change
Fired when the Presence system detects new minions connect or disconnect.
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBnew\fP \-\- A list of minions that have connected since the last presence
event.
.IP \(bu 2
\fBlost\fP \-\- A list of minions that have disconnected since the last
presence event.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Cloud Events
.sp
Unlike other Master events, \fBsalt\-cloud\fP events are not fired on behalf of a
Salt Minion. Instead, \fBsalt\-cloud\fP events are fired on behalf of a VM. This
is because the minion\-to\-be may not yet exist to fire events to or also may have
been destroyed.
.sp
This behavior is reflected by the \fBname\fP variable in the event data for
\fBsalt\-cloud\fP events as compared to the \fBid\fP variable for Salt
Minion\-triggered events.
.INDENT 0.0
.TP
.B salt/cloud/<VM NAME>/creating
Fired when salt\-cloud starts the VM creation process.
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- the name of the VM being created.
.IP \(bu 2
\fBevent\fP \-\- description of the event.
.IP \(bu 2
\fBprovider\fP \-\- the cloud provider of the VM being created.
.IP \(bu 2
\fBprofile\fP \-\- the cloud profile for the VM being created.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt/cloud/<VM NAME>/deploying
Fired when the VM is available and salt\-cloud begins deploying Salt to the
new VM.
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- the name of the VM being created.
.IP \(bu 2
\fBevent\fP \-\- description of the event.
.IP \(bu 2
\fBkwargs\fP \-\- options available as the deploy script is invoked:
\fBconf_file\fP, \fBdeploy_command\fP, \fBdisplay_ssh_output\fP, \fBhost\fP,
\fBkeep_tmp\fP, \fBkey_filename\fP, \fBmake_minion\fP, \fBminion_conf\fP,
\fBname\fP, \fBparallel\fP, \fBpreseed_minion_keys\fP, \fBscript\fP,
\fBscript_args\fP, \fBscript_env\fP, \fBsock_dir\fP, \fBstart_action\fP,
\fBsudo\fP, \fBtmp_dir\fP, \fBtty\fP, \fBusername\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt/cloud/<VM NAME>/requesting
Fired when salt\-cloud sends the request to create a new VM.
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBevent\fP \-\- description of the event.
.IP \(bu 2
\fBlocation\fP \-\- the location of the VM being requested.
.IP \(bu 2
\fBkwargs\fP \-\- options available as the VM is being requested:
\fBAction\fP, \fBImageId\fP, \fBInstanceType\fP, \fBKeyName\fP, \fBMaxCount\fP,
\fBMinCount\fP, \fBSecurityGroup.1\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt/cloud/<VM NAME>/querying
Fired when salt\-cloud queries data for a new instance.
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBevent\fP \-\- description of the event.
.IP \(bu 2
\fBinstance_id\fP \-\- the ID of the new VM.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt/cloud/<VM NAME>/tagging
Fired when salt\-cloud tags a new instance.
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBevent\fP \-\- description of the event.
.IP \(bu 2
\fBtags\fP \-\- tags being set on the new instance.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt/cloud/<VM NAME>/waiting_for_ssh
Fired while the salt\-cloud deploy process is waiting for ssh to become
available on the new instance.
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBevent\fP \-\- description of the event.
.IP \(bu 2
\fBip_address\fP \-\- IP address of the new instance.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt/cloud/<VM NAME>/deploy_script
Fired once the deploy script is finished.
.INDENT 7.0
.TP
.B Variables
\fBevent\fP \-\- description of the event.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt/cloud/<VM NAME>/created
Fired once the new instance has been fully created.
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- the name of the VM being created.
.IP \(bu 2
\fBevent\fP \-\- description of the event.
.IP \(bu 2
\fBinstance_id\fP \-\- the ID of the new instance.
.IP \(bu 2
\fBprovider\fP \-\- the cloud provider of the VM being created.
.IP \(bu 2
\fBprofile\fP \-\- the cloud profile for the VM being created.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt/cloud/<VM NAME>/destroying
Fired when salt\-cloud requests the destruction of an instance.
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- the name of the VM being created.
.IP \(bu 2
\fBevent\fP \-\- description of the event.
.IP \(bu 2
\fBinstance_id\fP \-\- the ID of the new instance.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt/cloud/<VM NAME>/destroyed
Fired when an instance has been destroyed.
.INDENT 7.0
.TP
.B Variables
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- the name of the VM being created.
.IP \(bu 2
\fBevent\fP \-\- description of the event.
.IP \(bu 2
\fBinstance_id\fP \-\- the ID of the new instance.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Listening for Events
.sp
Salt\(aqs event system is used heavily within Salt and it is also written to
integrate heavily with existing tooling and scripts. There is a variety of
ways to consume it.
.SS From the CLI
.sp
The quickest way to watch the event bus is by calling the \fI\%state.event
runner\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.event pretty=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
That runner is designed to interact with the event bus from external tools and
shell scripts. See the documentation for more examples.
.SS Remotely via the REST API
.sp
Salt\(aqs event bus can be consumed
\fI\%salt.netapi.rest_cherrypy.app.Events\fP as an HTTP stream from
external tools or services.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-SsNk https://salt\-api.example.com:8000/events?token=05A3
.ft P
.fi
.UNINDENT
.UNINDENT
.SS From Python
.sp
Python scripts can access the event bus only as the same system user that Salt
is running as.
.sp
The event system is accessed via the event library and can only be accessed
by the same system user that Salt is running as. To listen to events a
SaltEvent object needs to be created and then the get_event function needs to
be run. The SaltEvent object needs to know the location that the Salt Unix
sockets are kept. In the configuration this is the \fBsock_dir\fP option. The
\fBsock_dir\fP option defaults to \(dq/var/run/salt/master\(dq on most systems.
.sp
The following code will check for a single event:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.config
import salt.utils.event

opts = salt.config.client_config(\(dq/etc/salt/master\(dq)

event = salt.utils.event.get_event(\(dqmaster\(dq, sock_dir=opts[\(dqsock_dir\(dq], opts=opts)

data = event.get_event()
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Events will also use a \(dqtag\(dq. Tags allow for events to be filtered by prefix.
By default all events will be returned. If only authentication events are
desired, then pass the tag \(dqsalt/auth\(dq.
.sp
The \fBget_event\fP method has a default poll time assigned of 5 seconds. To
change this time set the \(dqwait\(dq option.
.sp
The following example will only listen for auth events and will wait for 10 seconds
instead of the default 5.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
data = event.get_event(wait=10, tag=\(dqsalt/auth\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To retrieve the tag as well as the event data, pass \fBfull=True\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
evdata = event.get_event(wait=10, tag=\(dqsalt/job\(dq, full=True)

tag, data = evdata[\(dqtag\(dq], evdata[\(dqdata\(dq]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Instead of looking for a single event, the \fBiter_events\fP method can be used to
make a generator which will continually yield salt events.
.sp
The iter_events method also accepts a tag but not a wait time:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
for data in event.iter_events(tag=\(dqsalt/auth\(dq):
    print(data)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And finally event tags can be globbed, such as they can be in the Reactor,
using the fnmatch library.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import fnmatch

import salt.config
import salt.utils.event

opts = salt.config.client_config(\(dq/etc/salt/master\(dq)

sevent = salt.utils.event.get_event(\(dqmaster\(dq, sock_dir=opts[\(dqsock_dir\(dq], opts=opts)

while True:
    ret = sevent.get_event(full=True)
    if ret is None:
        continue

    if fnmatch.fnmatch(ret[\(dqtag\(dq], \(dqsalt/job/*/ret/*\(dq):
        do_something_with_job_return(ret[\(dqdata\(dq])
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Firing Events
.sp
It is possible to fire events on either the minion\(aqs local bus or to fire
events intended for the master.
.sp
To fire a local event from the minion on the command line call the
\fI\%event.fire\fP execution function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call event.fire \(aq{\(dqdata\(dq: \(dqmessage to be sent in the event\(dq}\(aq \(aqtag\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To fire an event to be sent up to the master from the minion call the
\fI\%event.send\fP execution function. Remember
YAML can be used at the CLI in function arguments:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call event.send \(aqmyco/mytag/success\(aq \(aq{success: True, message: \(dqIt works!\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a process is listening on the minion, it may be useful for a user on the
master to fire an event to it. An example of listening local events on
a minion on a non\-Windows system:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Job on minion
import salt.utils.event

opts = salt.config.minion_config(\(dq/etc/salt/minion\(dq)
event = salt.utils.event.MinionEvent(opts)

for evdata in event.iter_events(match_type=\(dqregex\(dq, tag=\(dqcustom/.*\(dq):
    # do your processing here...
    ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And an example of listening local events on a Windows system:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Job on minion
import salt.utils.event

opts = salt.config.minion_config(salt.minion.DEFAULT_MINION_OPTS)
event = salt.utils.event.MinionEvent(opts)

for evdata in event.iter_events(match_type=\(dqregex\(dq, tag=\(dqcustom/.*\(dq):
    # do your processing here...
    ...
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname event.fire \(aq{\(dqdata\(dq: \(dqmessage for the minion\(dq}\(aq \(aqcustomtag/african/unladen\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Firing Events from Python
.SS From Salt execution modules
.sp
Events can be very useful when writing execution modules, in order to inform
various processes on the master when a certain task has taken place. This is
easily done using the normal cross\-calling syntax:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/salt/_modules/my_custom_module.py


def do_something():
    \(dq\(dq\(dq
    Do something and fire an event to the master when finished

    CLI Example::

        salt \(aq*\(aq my_custom_module:do_something
    \(dq\(dq\(dq
    # do something!
    __salt__[\(dqevent.send\(dq](
        \(dqmyco/my_custom_module/finished\(dq,
        {\(dqfinished\(dq: True, \(dqmessage\(dq: \(dqThe something is finished!\(dq},
    )
.ft P
.fi
.UNINDENT
.UNINDENT
.SS From Custom Python Scripts
.sp
Firing events from custom Python code is quite simple and mirrors how it is
done at the CLI:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.client

caller = salt.client.Caller()

ret = caller.cmd(
    \(dqevent.send\(dq, \(dqmyco/event/success\(dq, {\(dqsuccess\(dq: True, \(dqmessage\(dq: \(dqIt works!\(dq}
)

if not ret:
    # the event could not be sent, process the error here
    ...
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Beacons
.sp
Beacons let you use the Salt event system to monitor non\-Salt processes. The
beacon system allows the minion to hook into a variety of system processes and
continually monitor these processes. When monitored activity occurs in a system
process, an event is sent on the Salt event bus that can be used to trigger a
\fI\%reactor\fP\&.
.sp
Salt beacons can currently monitor and send Salt events for many system
activities, including:
.INDENT 0.0
.IP \(bu 2
file system changes
.IP \(bu 2
system load
.IP \(bu 2
service status
.IP \(bu 2
shell activity, such as user login
.IP \(bu 2
network and disk usage
.UNINDENT
.sp
See \fI\%beacon modules\fP for a current list.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Salt beacons are an event generation mechanism. Beacons leverage the Salt
\fI\%reactor\fP system to make changes when beacon events occur.
.UNINDENT
.UNINDENT
.SS Configuring Beacons
.sp
Salt beacons do not require any changes to the system components that are being
monitored, everything is configured using Salt.
.sp
Beacons are typically enabled by placing a \fBbeacons:\fP top level block in
\fB/etc/salt/minion\fP or any file in \fB/etc/salt/minion.d/\fP such as
\fB/etc/salt/minion.d/beacons.conf\fP or add it to pillars for that minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  inotify:
    \- files:
        /etc/important_file:
          mask:
            \- modify
        /opt:
          mask:
            \- modify
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The beacon system, like many others in Salt, can also be configured via the
minion pillar, grains, or local config file.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fIinotify\fP beacon only works on OSes that have \fIinotify\fP kernel support.
Currently this excludes FreeBSD, macOS, and Windows.
.UNINDENT
.UNINDENT
.sp
All beacon configuration is done using list based configuration.
.sp
New in version Neon.

.sp
Multiple copies of a particular Salt beacon can be configured by including the \fBbeacon_module\fP parameter in the beacon configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  watch_important_file:
    \- files:
        /etc/important_file:
          mask:
            \- modify
    \- beacon_module: inotify
  watch_another_file:
    \- files:
        /etc/another_file:
          mask:
            \- modify
    \- beacon_module: inotify
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Beacon Monitoring Interval
.sp
Beacons monitor on a 1\-second interval by default. To set a different interval,
provide an \fBinterval\fP argument to a beacon. The following beacons run on 5\-
and 10\-second intervals:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  inotify:
    \- files:
        /etc/important_file:
          mask:
            \- modify
        /opt:
          mask:
            \- modify
    \- interval: 5
    \- disable_during_state_run: True
  load:
    \- averages:
        1m:
          \- 0.0
          \- 2.0
        5m:
          \- 0.0
          \- 1.5
        15m:
          \- 0.1
          \- 1.0
    \- interval: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Avoiding Event Loops
.sp
It is important to carefully consider the possibility of creating a loop
between a reactor and a beacon. For example, one might set up a beacon which
monitors whether a file is read which in turn fires a reactor to run a state
which in turn reads the file and re\-fires the beacon.
.sp
To avoid these types of scenarios, the \fBdisable_during_state_run\fP argument
may be set. If a state run is in progress, the beacon will not be run on its
regular interval until the minion detects that the state run has completed, at
which point the normal beacon interval will resume.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  inotify:
    \- files:
        /etc/important_file: {}
          mask:
            \- modify
    \- disable_during_state_run: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For beacon writers:  If you need extra stuff to happen, like closing file
handles for the \fBdisable_during_state_run\fP to actually work, you can add
a \fIclose()\fP function to the beacon to run those extra things. See the
\fIinotify\fP beacon.
.UNINDENT
.UNINDENT
.SS Beacon Example
.sp
This example demonstrates configuring the \fI\%inotify\fP
beacon to monitor a file for changes, and then restores the file to its
original contents if a change was made.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The inotify beacon requires Pyinotify on the minion, install it using
\fBsalt myminion pkg.install python\-inotify\fP\&.
.UNINDENT
.UNINDENT
.SS Create Watched File
.sp
Create the file named \fB/etc/important_file\fP and add some simple content:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
important_config: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Add Beacon Configs to Minion
.sp
On the Salt minion, add the following configuration to
\fB/etc/salt/minion.d/beacons.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  inotify:
    \- files:
        /etc/important_file:
          mask:
            \- modify
    \- disable_during_state_run: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Save the configuration file and restart the minion service. The beacon is now
set up to notify salt upon modifications made to the file.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBdisable_during_state_run: True\fP parameter \fI\%prevents\fP the inotify beacon from generating reactor
events due to salt itself modifying the file.
.UNINDENT
.UNINDENT
.SS View Events on the Master
.sp
On your Salt master, start the event runner using the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.event pretty=true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This runner displays events as they are received by the master on the Salt
event bus. To test the beacon you set up in the previous section, make and save
a modification to \fB/etc/important_file\fP\&. You\(aqll see an event similar to the
following on the event bus:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
 \(dq_stamp\(dq: \(dq2015\-09\-09T15:59:37.972753\(dq,
 \(dqdata\(dq: {
     \(dqchange\(dq: \(dqIN_IGNORED\(dq,
     \(dqid\(dq: \(dqlarry\(dq,
     \(dqpath\(dq: \(dq/etc/important_file\(dq
 },
 \(dqtag\(dq: \(dqsalt/beacon/larry/inotify//etc/important_file\(dq
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This indicates that the event is being captured and sent correctly. Now you can
create a reactor to take action when this event occurs.
.SS Create a Reactor
.sp
This reactor reverts the file named \fB/etc/important_file\fP to the contents
provided by salt each time it is modified.
.SS Reactor SLS
.sp
On your Salt master, create a file named \fB/srv/reactor/revert.sls\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If the \fB/srv/reactor\fP directory doesn\(aqt exist, create it.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mkdir \-p /srv/reactor
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Add the following to \fB/srv/reactor/revert.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
revert\-file:
  local.state.apply:
    \- tgt: {{ data[\(aqid\(aq] }}
    \- arg:
      \- maintain_important_file
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In addition to \fI\%setting\fP
\fBdisable_during_state_run: True\fP for an inotify beacon whose reaction is
to modify the watched file, it is important to ensure the state applied is
also \fI\%idempotent\fP\&.
.UNINDENT
.UNINDENT
.SS State SLS
.sp
Create the state sls file referenced by the reactor sls file.  This state file
will be located at \fB/srv/salt/maintain_important_file.sls\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
important_file:
  file.managed:
    \- name: /etc/important_file
    \- contents: |
        important_config: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Master Config
.sp
Configure the master to map the inotify beacon event to the \fBrevert\fP reaction
in \fB/etc/salt/master.d/reactor.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor:
  \- salt/beacon/*/inotify//etc/important_file:
    \- /srv/reactor/revert.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
You can have only one top level \fBreactor\fP section, so if one already
exists, add this code to the existing section. See \fI\%here\fP to learn more about reactor SLS syntax.
.UNINDENT
.UNINDENT
.SS Start the Salt Master in Debug Mode
.sp
To help with troubleshooting, start the Salt master in debug mode:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
service salt\-master stop
salt\-master \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When debug logging is enabled, event and reactor data are displayed so you can
discover syntax and other issues.
.SS Trigger the Reactor
.sp
On your minion, make and save another change to \fB/etc/important_file\fP\&. On the
Salt master, you\(aqll see debug messages that indicate the event was received and
the \fBstate.apply\fP job was sent. When you inspect the file on the minion,
you\(aqll see that the file contents have been restored to \fBimportant_config:
True\fP\&.
.sp
All beacons are configured using a similar process of enabling the beacon,
writing a reactor SLS (and state SLS if needed), and mapping a beacon event to
the reactor SLS.
.SS Writing Beacon Plugins
.sp
Beacon plugins use the standard Salt loader system, meaning that many of the
constructs from other plugin systems holds true, such as the \fB__virtual__\fP
function.
.sp
The important function in the Beacon Plugin is the \fBbeacon\fP function. When
the beacon is configured to run, this function will be executed repeatedly by
the minion. The \fBbeacon\fP function therefore cannot block and should be as
lightweight as possible. The \fBbeacon\fP also must return a list of dicts, each
dict in the list will be translated into an event on the master.
.sp
Beacons may also choose to implement a \fBvalidate\fP function which
takes the beacon configuration as an argument and ensures that it
is valid prior to continuing. This function is called automatically
by the Salt loader when a beacon is loaded.
.sp
Please see the \fI\%inotify\fP beacon as an example.
.SS The \fIbeacon\fP Function
.sp
The beacons system will look for a function named \fIbeacon\fP in the module. If
this function is not present then the beacon will not be fired. This function
is called on a regular basis and defaults to being called on every iteration of
the minion, which can be tens to hundreds of times a second. This means that
the \fIbeacon\fP function cannot block and should not be CPU or IO intensive.
.sp
The beacon function will be passed in the configuration for the executed
beacon. This makes it easy to establish a flexible configuration for each
called beacon. This is also the preferred way to ingest the beacon\(aqs
configuration as it allows for the configuration to be dynamically updated
while the minion is running by configuring the beacon in the minion\(aqs pillar.
.SS The Beacon Return
.sp
The information returned from the beacon is expected to follow a predefined
structure. The returned value needs to be a list of dictionaries (standard
python dictionaries are preferred, no ordered dicts are needed).
.sp
The dictionaries represent individual events to be fired on the minion and
master event buses. Each dict is a single event. The dict can contain any
arbitrary keys but the \(aqtag\(aq key will be extracted and added to the tag of the
fired event.
.sp
The return data structure would look something like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[{\(dqchanges\(dq: [\(dq/foo/bar\(dq], \(dqtag\(dq: \(dqfoo\(dq}, {\(dqchanges\(dq: [\(dq/foo/baz\(dq], \(dqtag\(dq: \(dqbar\(dq}]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Calling Execution Modules
.sp
Execution modules are still the preferred location for all work and system
interaction to happen in Salt. For this reason the \fI__salt__\fP variable is
available inside the beacon.
.sp
Please be careful when calling functions in \fI__salt__\fP, while this is the
preferred means of executing complicated routines in Salt not all of the
execution modules have been written with beacons in mind. Watch out for
execution modules that may be CPU intense or IO bound. Please feel free to add
new execution modules and functions to back specific beacons.
.SS Distributing Custom Beacons
.sp
Custom beacons can be distributed to minions via the standard methods, see
\fI\%Modular Systems\fP\&.
.SS Reactor System
.sp
Salt\(aqs Reactor system gives Salt the ability to trigger actions in response to
an event. It is a simple interface to watching Salt\(aqs event bus for event tags
that match a given pattern and then running one or more commands in response.
.sp
This system binds sls files to event tags on the master. These sls files then
define reactions. This means that the reactor system has two parts. First, the
reactor option needs to be set in the master configuration file.  The reactor
option allows for event tags to be associated with sls reaction files. Second,
these reaction files use highdata (like the state system) to define reactions
to be executed.
.SS Event System
.sp
A basic understanding of the event system is required to understand reactors.
The event system is a local ZeroMQ PUB interface which fires salt events. This
event bus is an open system used for sending information notifying Salt and
other systems about operations.
.sp
The event system fires events with a very specific criteria. Every event has a
\fBtag\fP\&. Event tags allow for fast top\-level filtering of events. In addition
to the tag, each event has a data structure. This data structure is a
dictionary, which contains information about the event.
.SS Mapping Events to Reactor SLS Files
.sp
Reactor SLS files and event tags are associated in the master config file.
By default this is /etc/salt/master, or /etc/salt/master.d/reactor.conf.
.sp
New in version 2014.7.0: Added Reactor support for \fBsalt://\fP file paths.

.sp
In the master config section \(aqreactor:\(aq is a list of event tags to be matched
and each event tag has a list of reactor SLS files to be run.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor:                            # Master config section \(dqreactor\(dq

  \- \(aqsalt/minion/*/start\(aq:          # Match tag \(dqsalt/minion/*/start\(dq
    \- /srv/reactor/start.sls        # Things to do when a minion starts
    \- /srv/reactor/monitor.sls      # Other things to do

  \- \(aqsalt/cloud/*/destroyed\(aq:       # Globs can be used to match tags
    \- /srv/reactor/destroy/*.sls    # Globs can be used to match file names

  \- \(aqmyco/custom/event/tag\(aq:        # React to custom event tags
    \- salt://reactor/mycustom.sls   # Reactor files can come from the salt fileserver
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In the above example, \fBsalt://reactor/mycustom.sls\fP refers to the
\fBbase\fP environment. To pull this file from a different environment, use
the \fI\%querystring syntax\fP (e.g.
\fBsalt://reactor/mycustom.sls?saltenv=reactor\fP).
.UNINDENT
.UNINDENT
.sp
Reactor SLS files are similar to State and Pillar SLS files. They are by
default YAML + Jinja templates and are passed familiar context variables.
Click \fI\%here\fP for more detailed information on the
variables available in Jinja templating.
.sp
Here is the SLS for a simple reaction:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% if data[\(aqid\(aq] == \(aqmysql1\(aq %}
highstate_run:
  local.state.apply:
    \- tgt: mysql1
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This simple reactor file uses Jinja to further refine the reaction to be made.
If the \fBid\fP in the event data is \fBmysql1\fP (in other words, if the name of
the minion is \fBmysql1\fP) then the following reaction is defined.  The same
data structure and compiler used for the state system is used for the reactor
system. The only difference is that the data is matched up to the salt command
API and the runner system.  In this example, a command is published to the
\fBmysql1\fP minion with a function of \fI\%state.apply\fP, which performs a \fI\%highstate\fP\&. Similarly, a runner can be called:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% if data[\(aqdata\(aq][\(aqcustom_var\(aq] == \(aqrunit\(aq %}
call_runit_orch:
  runner.state.orchestrate:
    \- args:
      \- mods: orchestrate.runit
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example will execute the state.orchestrate runner and initiate an execution
of the \fBrunit\fP orchestrator located at \fB/srv/salt/orchestrate/runit.sls\fP\&.
.SS Types of Reactions
.TS
center;
|l|l|.
_
T{
Name
T}	T{
Description
T}
_
T{
\fI\%local\fP
T}	T{
Runs a \fI\%remote\-execution function\fP on targeted minions
T}
_
T{
\fI\%runner\fP
T}	T{
Executes a \fI\%runner function\fP
T}
_
T{
\fI\%wheel\fP
T}	T{
Executes a \fI\%wheel function\fP on the master
T}
_
T{
\fI\%caller\fP
T}	T{
Runs a \fI\%remote\-execution function\fP on a masterless minion
T}
_
.TE
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBlocal\fP and \fBcaller\fP reaction types will likely be renamed in a
future release. These reaction types were named after Salt\(aqs internal
client interfaces, and are not intuitively named. Both \fBlocal\fP and
\fBcaller\fP will continue to work in Reactor SLS files, however.
.UNINDENT
.UNINDENT
.SS Where to Put Reactor SLS Files
.sp
Reactor SLS files can come both from files local to the master, and from any of
backends enabled via the \fI\%fileserver_backend\fP config option. Files
placed in the Salt fileserver can be referenced using a \fBsalt://\fP URL, just
like they can in State SLS files.
.sp
It is recommended to place reactor and orchestrator SLS files in their own
uniquely\-named subdirectories such as \fBorch/\fP, \fBorchestrate/\fP, \fBreact/\fP,
\fBreactor/\fP, etc., to keep them organized.
.SS Writing Reactor SLS
.sp
The different reaction types were developed separately and have historically
had different methods for passing arguments. For the 2017.7.2 release a new,
unified configuration schema has been introduced, which applies to all reaction
types.
.sp
The old config schema will continue to be supported, and there is no plan to
deprecate it at this time.
.SS Local Reactions
.sp
A \fBlocal\fP reaction runs a \fI\%remote\-execution function\fP
on the targeted minions.
.sp
The old config schema required the positional and keyword arguments to be
manually separated by the user under \fBarg\fP and \fBkwarg\fP parameters. However,
this is not very user\-friendly, as it forces the user to distinguish which type
of argument is which, and make sure that positional arguments are ordered
properly. Therefore, the new config schema is recommended if the master is
running a supported release.
.sp
The below two examples are equivalent:
.TS
center;
|l|l|.
_
T{
Supported in 2017.7.2 and later
T}	T{
Supported in all releases
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
install_zsh:
  local.state.single:
    \- tgt: \(aqkernel:Linux\(aq
    \- tgt_type: grain
    \- args:
      \- fun: pkg.installed
      \- name: zsh
      \- fromrepo: updates
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
install_zsh:
  local.state.single:
    \- tgt: \(aqkernel:Linux\(aq
    \- tgt_type: grain
    \- arg:
      \- pkg.installed
      \- zsh
    \- kwarg:
        fromrepo: updates
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
.TE
.sp
This reaction would be equivalent to running the following Salt command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqkernel:Linux\(aq state.single pkg.installed name=zsh fromrepo=updates
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Any other parameters in the \fI\%LocalClient().cmd_async()\fP method can be passed at the same
indentation level as \fBtgt\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBtgt_type\fP is only required when the target expression defined in \fBtgt\fP
uses a \fI\%target type\fP other than a minion ID glob.
.sp
The \fBtgt_type\fP argument was named \fBexpr_form\fP in releases prior to
2017.7.0.
.UNINDENT
.UNINDENT
.SS Runner Reactions
.sp
Runner reactions execute \fI\%runner functions\fP locally on
the master.
.sp
The old config schema called for passing arguments to the reaction directly
under the name of the runner function. However, this can cause unpredictable
interactions with the Reactor system\(aqs internal arguments. It is also possible
to pass positional and keyword arguments under \fBarg\fP and \fBkwarg\fP like above
in \fI\%local reactions\fP, but as noted above this is not very
user\-friendly. Therefore, the new config schema is recommended if the master
is running a supported release.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
State ids of reactors for runners and wheels should all be unique. They can
overwrite each other when added to the async queue causing lost reactions.
.UNINDENT
.UNINDENT
.sp
The below two examples are equivalent:
.TS
center;
|l|l|.
_
T{
Supported in 2017.7.2 and later
T}	T{
Supported in all releases
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
deploy_app:
  runner.state.orchestrate:
    \- args:
      \- mods: orchestrate.deploy_app
      \- pillar:
          event_tag: {{ tag }}
          event_data: {{ data[\(aqdata\(aq]|json }}
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
deploy_app:
  runner.state.orchestrate:
    \- mods: orchestrate.deploy_app
    \- kwarg:
        pillar:
          event_tag: {{ tag }}
          event_data: {{ data[\(aqdata\(aq]|json }}
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
.TE
.sp
Assuming that the event tag is \fBfoo\fP, and the data passed to the event is
\fB{\(aqbar\(aq: \(aqbaz\(aq}\fP, then this reaction is equivalent to running the following
Salt command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate mods=orchestrate.deploy_app pillar=\(aq{\(dqevent_tag\(dq: \(dqfoo\(dq, \(dqevent_data\(dq: {\(dqbar\(dq: \(dqbaz\(dq}}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Wheel Reactions
.sp
Wheel reactions run \fI\%wheel functions\fP locally on the
master.
.sp
Like \fI\%runner reactions\fP, the old config schema called for
wheel reactions to have arguments passed directly under the name of the
\fI\%wheel function\fP (or in \fBarg\fP or \fBkwarg\fP parameters).
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
State ids of reactors for runners and wheels should all be unique. They can
overwrite each other when added to the async queue causing lost reactions.
.UNINDENT
.UNINDENT
.sp
The below two examples are equivalent:
.TS
center;
|l|l|.
_
T{
Supported in 2017.7.2 and later
T}	T{
Supported in all releases
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
remove_key:
  wheel.key.delete:
    \- args:
      \- match: {{ data[\(aqid\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
remove_key:
  wheel.key.delete:
    \- match: {{ data[\(aqid\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
.TE
.SS Caller Reactions
.sp
Caller reactions run \fI\%remote\-execution functions\fP on a
minion daemon\(aqs Reactor system. To run a Reactor on the minion, it is necessary
to configure the \fI\%Reactor Engine\fP in the minion
config file, and then setup your watched events in a \fBreactor\fP section in the
minion config file as well.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Masterless Minions use this Reactor
.sp
This is the only way to run the Reactor if you use masterless minions.
.UNINDENT
.UNINDENT
.sp
Both the old and new config schemas involve passing arguments under an \fBargs\fP
parameter. However, the old config schema only supports positional arguments.
Therefore, the new config schema is recommended if the masterless minion is
running a supported release.
.sp
The below two examples are equivalent:
.TS
center;
|l|l|.
_
T{
Supported in 2017.7.2 and later
T}	T{
Supported in all releases
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
touch_file:
  caller.file.touch:
    \- args:
      \- name: /tmp/foo
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
touch_file:
  caller.file.touch:
    \- args:
      \- /tmp/foo
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
.TE
.sp
This reaction is equivalent to running the following Salt command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call file.touch name=/tmp/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Best Practices for Writing Reactor SLS Files
.sp
The Reactor works as follows:
.INDENT 0.0
.IP 1. 3
The Salt Reactor watches Salt\(aqs event bus for new events.
.IP 2. 3
Each event\(aqs tag is matched against the list of event tags configured under
the \fI\%reactor\fP section in the Salt Master config.
.IP 3. 3
The SLS files for any matches are rendered into a data structure that
represents one or more function calls.
.IP 4. 3
That data structure is given to a pool of worker threads for execution.
.UNINDENT
.sp
Matching and rendering Reactor SLS files is done sequentially in a single
process. For that reason, reactor SLS files should contain few individual
reactions (one, if at all possible). Also, keep in mind that reactions are
fired asynchronously (with the exception of \fI\%caller\fP) and
do \fInot\fP support \fI\%requisites\fP\&.
.sp
Complex Jinja templating that calls out to slow \fI\%remote\-execution\fP or \fI\%runner\fP functions slows down
the rendering and causes other reactions to pile up behind the current one. The
worker pool is designed to handle complex and long\-running processes like
\fI\%orchestration\fP jobs.
.sp
Therefore, when complex tasks are in order, \fI\%orchestration\fP is a natural fit. Orchestration SLS files can be more
complex, and use requisites. Performing a complex task using orchestration lets
the Reactor system fire off the orchestration job and proceed with processing
other reactions.
.SS Jinja Context
.sp
Reactor SLS files only have access to a minimal Jinja context. \fBgrains\fP and
\fBpillar\fP are \fInot\fP available. The \fBsalt\fP object is available for calling
\fI\%remote\-execution\fP or \fI\%runner\fP
functions, but it should be used sparingly and only for quick tasks for the
reasons mentioned above.
.sp
In addition to the \fBsalt\fP object, the following variables are available in
the Jinja context:
.INDENT 0.0
.IP \(bu 2
\fBtag\fP \- the tag from the event that triggered execution of the Reactor SLS
file
.IP \(bu 2
\fBdata\fP \- the event\(aqs data dictionary
.UNINDENT
.sp
The \fBdata\fP dict will contain an \fBid\fP key containing the minion ID, if the
event was fired from a minion, and a \fBdata\fP key containing the data passed to
the event.
.SS Advanced State System Capabilities
.sp
Reactor SLS files, by design, do not support \fI\%requisites\fP,
ordering, \fBonlyif\fP/\fBunless\fP conditionals and most other powerful constructs
from Salt\(aqs State system.
.sp
Complex Master\-side operations are best performed by Salt\(aqs Orchestrate system
so using the Reactor to kick off an Orchestrate run is a very common pairing.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/master.d/reactor.conf
# A custom event containing: {\(dqfoo\(dq: \(dqFoo!\(dq, \(dqbar: \(dqbar*\(dq, \(dqbaz\(dq: \(dqBaz!\(dq}
reactor:
  \- my/custom/event:
    \- /srv/reactor/some_event.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/reactor/some_event.sls
invoke_orchestrate_file:
  runner.state.orchestrate:
    \- args:
        \- mods: orchestrate.do_complex_thing
        \- pillar:
            event_tag: {{ tag }}
            event_data: {{ data|json }}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/salt/orchestrate/do_complex_thing.sls
{% set tag = salt.pillar.get(\(aqevent_tag\(aq) %}
{% set data = salt.pillar.get(\(aqevent_data\(aq) %}

# Pass data from the event to a custom runner function.
# The function expects a \(aqfoo\(aq argument.
do_first_thing:
  salt.runner:
    \- name: custom_runner.custom_function
    \- foo: {{ data.foo }}

# Wait for the runner to finish then send an execution to minions.
# Forward some data from the event down to the minion\(aqs state run.
do_second_thing:
  salt.state:
    \- tgt: {{ data.bar }}
    \- sls:
      \- do_thing_on_minion
    \- kwarg:
        pillar:
          baz: {{ data.baz }}
    \- require:
      \- salt: do_first_thing
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Beacons and Reactors
.sp
An event initiated by a beacon, when it arrives at the master will be wrapped
inside a second event, such that the data object containing the beacon
information will be \fBdata[\(aqdata\(aq]\fP, rather than \fBdata\fP\&.
.sp
For example, to access the \fBid\fP field of the beacon event in a reactor file,
you will need to reference \fB{{ data[\(aqdata\(aq][\(aqid\(aq] }}\fP rather than \fB{{
data[\(aqid\(aq] }}\fP as for events initiated directly on the event bus.
.sp
Similarly, the data dictionary attached to the event would be located in
\fB{{ data[\(aqdata\(aq][\(aqdata\(aq] }}\fP instead of \fB{{ data[\(aqdata\(aq] }}\fP\&.
.sp
See the \fI\%beacon documentation\fP for examples.
.SS Manually Firing an Event
.SS From the Master
.sp
Use the \fI\%event.send\fP runner:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run event.send foo \(aq{orchestrate: refresh}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS From the Minion
.sp
To fire an event to the master from a minion, call \fI\%event.send\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call event.send foo \(aq{orchestrate: refresh}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To fire an event to the minion\(aqs local event bus, call \fI\%event.fire\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call event.fire \(aq{orchestrate: refresh}\(aq foo
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Referencing Data Passed in Events
.sp
Assuming any of the above examples, any reactor SLS files triggered by watching
the event tag \fBfoo\fP will execute with \fB{{ data[\(aqdata\(aq][\(aqorchestrate\(aq] }}\fP
equal to \fB\(aqrefresh\(aq\fP\&.
.SS Getting Information About Events
.sp
The best way to see exactly what events have been fired and what data is
available in each event is to use the \fI\%state.event runner\fP\&.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Common Salt Events\fP
.UNINDENT
.UNINDENT
.sp
Example usage:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.event pretty=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt/job/20150213001905721678/new       {
    \(dq_stamp\(dq: \(dq2015\-02\-13T00:19:05.724583\(dq,
    \(dqarg\(dq: [],
    \(dqfun\(dq: \(dqtest.ping\(dq,
    \(dqjid\(dq: \(dq20150213001905721678\(dq,
    \(dqminions\(dq: [
        \(dqjerry\(dq
    ],
    \(dqtgt\(dq: \(dq*\(dq,
    \(dqtgt_type\(dq: \(dqglob\(dq,
    \(dquser\(dq: \(dqroot\(dq
}
salt/job/20150213001910749506/ret/jerry {
    \(dq_stamp\(dq: \(dq2015\-02\-13T00:19:11.136730\(dq,
    \(dqcmd\(dq: \(dq_return\(dq,
    \(dqfun\(dq: \(dqsaltutil.find_job\(dq,
    \(dqfun_args\(dq: [
        \(dq20150213001905721678\(dq
    ],
    \(dqid\(dq: \(dqjerry\(dq,
    \(dqjid\(dq: \(dq20150213001910749506\(dq,
    \(dqretcode\(dq: 0,
    \(dqreturn\(dq: {},
    \(dqsuccess\(dq: true
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Debugging the Reactor
.sp
The best window into the Reactor is to run the master in the foreground with
debug logging enabled. The output will include when the master sees the event,
what the master does in response to that event, and it will also include the
rendered SLS file (or any errors generated while rendering the SLS file).
.INDENT 0.0
.IP 1. 3
Stop the master.
.IP 2. 3
Start the master manually:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-master \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
Look for log entries in the form:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
[DEBUG   ] Gathering reactors for tag foo/bar
[DEBUG   ] Compiling reactions for tag foo/bar
[DEBUG   ] Rendered data from file: /path/to/the/reactor_file.sls:
<... Rendered output appears here. ...>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The rendered output is the result of the Jinja parsing and is a good way to
view the result of referencing Jinja variables. If the result is empty then
Jinja produced an empty result and the Reactor will ignore it.
.UNINDENT
.SS Passing Event Data to Minions or Orchestration as Pillar
.sp
An interesting trick to pass data from the Reactor SLS file to
\fI\%state.apply\fP is to pass it as inline
Pillar data since both functions take a keyword argument named \fBpillar\fP\&.
.sp
The following example uses Salt\(aqs Reactor to listen for the event that is fired
when the key for a new minion is accepted on the master using \fBsalt\-key\fP\&.
.sp
\fB/etc/salt/master.d/reactor.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor:
  \- \(aqsalt/key\(aq:
    \- /srv/salt/haproxy/react_new_minion.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The Reactor then fires a :\fI\%state.apply\fP
command targeted to the HAProxy servers and passes the ID of the new minion
from the event to the state file via inline Pillar.
.sp
\fB/srv/salt/haproxy/react_new_minion.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% if data[\(aqact\(aq] == \(aqaccept\(aq and data[\(aqid\(aq].startswith(\(aqweb\(aq) %}
add_new_minion_to_pool:
  local.state.apply:
    \- tgt: \(aqhaproxy*\(aq
    \- args:
      \- mods: haproxy.refresh_pool
      \- pillar:
          new_minion: {{ data[\(aqid\(aq] }}
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above command is equivalent to the following command at the CLI:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqhaproxy*\(aq state.apply haproxy.refresh_pool pillar=\(aq{new_minion: minionid}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This works with Orchestrate files as well:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
call_some_orchestrate_file:
  runner.state.orchestrate:
    \- args:
      \- mods: orchestrate.some_orchestrate_file
      \- pillar:
          stuff: things
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Which is equivalent to the following command at the CLI:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate orchestrate.some_orchestrate_file pillar=\(aq{stuff: things}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Finally, that data is available in the state file using the normal Pillar
lookup syntax. The following example is grabbing web server names and IP
addresses from \fI\%Salt Mine\fP\&. If this state is invoked from the
Reactor then the custom Pillar value from above will be available and the new
minion will be added to the pool but with the \fBdisabled\fP flag so that HAProxy
won\(aqt yet direct traffic to it.
.sp
\fB/srv/salt/haproxy/refresh_pool.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set new_minion = salt[\(aqpillar.get\(aq](\(aqnew_minion\(aq) %}

listen web *:80
    balance source
    {% for server,ip in salt[\(aqmine.get\(aq](\(aqweb*\(aq, \(aqnetwork.interfaces\(aq, [\(aqeth0\(aq]).items() %}
    {% if server == new_minion %}
    server {{ server }} {{ ip }}:80 disabled
    {% else %}
    server {{ server }} {{ ip }}:80 check
    {% endif %}
    {% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS A Complete Example
.sp
In this example, we\(aqre going to assume that we have a group of servers that
will come online at random and need to have keys automatically accepted. We\(aqll
also add that we don\(aqt want all servers being automatically accepted. For this
example, we\(aqll assume that all hosts that have an id that starts with \(aqink\(aq
will be automatically accepted and have \fI\%state.apply\fP executed. On top of this, we\(aqre going to add that
a host coming up that was replaced (meaning a new key) will also be accepted.
.sp
Our master configuration will be rather simple. All minions that attempt to
authenticate will match the \fBtag\fP of \fBsalt/auth\fP\&. When it comes
to the minion key being accepted, we get a more refined \fBtag\fP that
includes the minion id, which we can use for matching.
.sp
\fB/etc/salt/master.d/reactor.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor:
  \- \(aqsalt/auth\(aq:
    \- /srv/reactor/auth\-pending.sls
  \- \(aqsalt/minion/ink*/start\(aq:
    \- /srv/reactor/auth\-complete.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this SLS file, we say that if the key was rejected we will delete the key on
the master and then also tell the master to ssh in to the minion and tell it to
restart the minion, since a minion process will die if the key is rejected.
.sp
We also say that if the key is pending and the id starts with ink we will
accept the key. A minion that is waiting on a pending key will retry
authentication every ten seconds by default.
.sp
\fB/srv/reactor/auth\-pending.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{# Ink server failed to authenticate \-\- remove accepted key #}
{% if not data[\(aqresult\(aq] and data[\(aqid\(aq].startswith(\(aqink\(aq) %}
minion_remove:
  wheel.key.delete:
    \- args:
      \- match: {{ data[\(aqid\(aq] }}
minion_rejoin:
  local.cmd.run:
    \- tgt: salt\-master.domain.tld
    \- args:
      \- cmd: ssh \-o UserKnownHostsFile=/dev/null \-o StrictHostKeyChecking=no \(dq{{ data[\(aqid\(aq] }}\(dq \(aqsleep 10 && /etc/init.d/salt\-minion restart\(aq
{% endif %}

{# Ink server is sending new key \-\- accept this key #}
{% if \(aqact\(aq in data and data[\(aqact\(aq] == \(aqpend\(aq and data[\(aqid\(aq].startswith(\(aqink\(aq) %}
minion_add:
  wheel.key.accept:
    \- args:
      \- match: {{ data[\(aqid\(aq] }}
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
No if statements are needed here because we already limited this action to just
Ink servers in the master configuration.
.sp
\fB/srv/reactor/auth\-complete.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{# When an Ink server connects, run state.apply. #}
highstate_run:
  local.state.apply:
    \- tgt: {{ data[\(aqid\(aq] }}
    \- ret: smtp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above will also return the \fI\%highstate\fP result data
using the \fIsmtp_return\fP returner (use virtualname like when using from the
command line with \fI\-\-return\fP).  The returner needs to be configured on the
minion for this to work.  See \fI\%salt.returners.smtp_return\fP documentation for that.
.SS Syncing Custom Types on Minion Start
.sp
Salt will sync all custom types (by running a \fI\%saltutil.sync_all\fP) on every \fI\%highstate\fP\&. However, there is a chicken\-and\-egg issue where, on the
initial \fI\%highstate\fP, a minion will not yet have these
custom types synced when the top file is first compiled. This can be worked
around with a simple reactor which watches for \fBsalt/minion/*/start\fP events,
which each minion fires when it first starts up and connects to the master.
.sp
On the master, create \fB/srv/reactor/sync_grains.sls\fP with the following
contents:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sync_grains:
  local.saltutil.sync_grains:
    \- tgt: {{ data[\(aqid\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And in the master config file, add the following reactor configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor:
  \- \(aqsalt/minion/*/start\(aq:
    \- /srv/reactor/sync_grains.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will cause the master to instruct each minion to sync its custom grains
when it starts, making these grains available when the initial \fI\%highstate\fP is executed.
.sp
Other types can be synced by replacing \fBlocal.saltutil.sync_grains\fP with
\fBlocal.saltutil.sync_modules\fP, \fBlocal.saltutil.sync_all\fP, or whatever else
suits the intended use case.
.sp
Also, if it is not desirable that \fIevery\fP minion syncs on startup, the \fB*\fP
can be replaced with a different glob to narrow down the set of minions which
will match that reactor (e.g. \fBsalt/minion/appsrv*/start\fP, which would only
match minion IDs beginning with \fBappsrv\fP).
.SS Reactor Tuning for Large\-Scale Installations
.sp
The reactor uses a thread pool implementation that\(aqs contained inside
\fBsalt.utils.process.ThreadPool\fP\&. It uses Python\(aqs stdlib Queue to enqueue
jobs which are picked up by standard Python threads. If the queue is full,
\fBFalse\fP is simply returned by the firing method on the thread pool.
.sp
As such, there are a few things to say about the selection of proper values
for the reactor.
.sp
For situations where it is expected that many long\-running jobs might be
executed by the reactor, \fBreactor_worker_hwm\fP should be increased or even
set to \fB0\fP to bound it only by available memory. If set to zero, a close eye
should be kept on memory consumption.
.sp
If many long\-running jobs are expected and execution concurrency and
performance are a concern, you may also increase the value for
\fBreactor_worker_threads\fP\&. This will control the number of concurrent threads
which are pulling jobs from the queue and executing them. Obviously, this
bears a relationship to the speed at which the queue itself will fill up.
The price to pay for this value is that each thread will contain a copy of
Salt code needed to perform the requested action.
.SH ORCHESTRATION
.SS Orchestrate Runner
.sp
Executing states or highstate on a minion is perfect when you want to ensure that
minion configured and running the way you want. Sometimes however you want to
configure a set of minions all at once.
.sp
For example, if you want to set up a load balancer in front of a cluster of web
servers you can ensure the load balancer is set up first, and then the same
matching configuration is applied consistently across the whole cluster.
.sp
Orchestration is the way to do this.
.SS The Orchestrate Runner
.sp
New in version 0.17.0.

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Orchestrate Deprecates OverState
.sp
The Orchestrate Runner (originally called the state.sls runner) offers all
the functionality of the OverState, but with some advantages:
.INDENT 0.0
.IP \(bu 2
All \fI\%Requisites and Other Global State Arguments\fP available in states can be
used.
.IP \(bu 2
The states/functions will also work on salt\-ssh minions.
.UNINDENT
.sp
The Orchestrate Runner replaced the OverState system in Salt 2015.8.0.
.UNINDENT
.UNINDENT
.sp
The orchestrate runner generalizes the Salt state system to a Salt master
context.  Whereas the \fBstate.sls\fP, \fBstate.highstate\fP, et al. functions are
concurrently and independently executed on each Salt minion, the
\fBstate.orchestrate\fP runner is executed on the master, giving it a
master\-level view and control over requisites, such as state ordering and
conditionals.  This allows for inter minion requisites, like ordering the
application of states on different minions that must not happen simultaneously,
or for halting the state run on all minions if a minion fails one of its
states.
.sp
The \fBstate.sls\fP, \fBstate.highstate\fP, et al. functions allow you to statefully
manage each minion and the \fBstate.orchestrate\fP runner allows you to
statefully manage your entire infrastructure.
.SS Writing SLS Files
.sp
Orchestrate SLS files are stored in the same location as State SLS files. This
means that both \fBfile_roots\fP and \fBgitfs_remotes\fP impact what SLS files are
available to the reactor and orchestrator.
.sp
It is recommended to keep reactor and orchestrator SLS files in their own
uniquely named subdirectories such as \fB_orch/\fP, \fBorch/\fP, \fB_orchestrate/\fP,
\fBreact/\fP, \fB_reactor/\fP, etc. This will avoid duplicate naming and will help
prevent confusion.
.SS Executing the Orchestrate Runner
.sp
The Orchestrate Runner command format is the same as for the \fBstate.sls\fP
function, except that since it is a runner, it is executed with \fBsalt\-run\fP
rather than \fBsalt\fP\&.  Assuming you have a state.sls file called
\fB/srv/salt/orch/webserver.sls\fP the following command, run on the master,
will apply the states defined in that file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate orch.webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBstate.orch\fP is a synonym for \fBstate.orchestrate\fP
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.1.1: The runner function was renamed to \fBstate.orchestrate\fP to avoid confusion
with the \fI\%state.sls\fP execution function. In
versions 0.17.0 through 2014.1.0, \fBstate.sls\fP must be used.

.SS Masterless Orchestration
.sp
New in version 2016.11.0.

.sp
To support salt orchestration on masterless minions, the Orchestrate Runner is
available as an execution module. The syntax for masterless orchestration is
exactly the same, but it uses the \fBsalt\-call\fP command and the minion
configuration must contain the \fBfile_mode: local\fP option. Alternatively,
use \fBsalt\-call \-\-local\fP on the command line.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local state.orchestrate orch.webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Masterless orchestration supports only the \fBsalt.state\fP command in an
sls file; it does not (currently) support the \fBsalt.function\fP command.
.UNINDENT
.UNINDENT
.SS Examples
.SS Function
.sp
To execute a function, use \fI\%salt.function\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/salt/orch/cleanfoo.sls
cmd.run:
  salt.function:
    \- tgt: \(aq*\(aq
    \- arg:
      \- rm \-rf /tmp/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate orch.cleanfoo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you omit the \(dqname\(dq argument, the ID of the state will be the default name,
or in the case of \fBsalt.function\fP, the execution module function to run. You
can specify the \(dqname\(dq argument to avoid conflicting IDs:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
copy_some_file:
  salt.function:
    \- name: file.copy
    \- tgt: \(aq*\(aq
    \- arg:
      \- /path/to/file
      \- /tmp/copy_of_file
    \- kwarg:
        remove_existing: true
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Fail Functions
.sp
When running a remote execution function in orchestration, certain return
values for those functions may indicate failure, while the function itself
doesn\(aqt set a return code. For those circumstances, using a \(dqfail function\(dq
allows for a more flexible means of assessing success or failure.
.sp
A fail function can be written as part of a \fI\%custom execution module\fP\&. The function should accept one argument, and
return a boolean result. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def check_func_result(retval):
    if some_condition:
        return True
    else:
        return False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The function can then be referenced in orchestration SLS like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
do_stuff:
  salt.function:
    \- name: modname.funcname
    \- tgt: \(aq*\(aq
    \- fail_function: mymod.check_func_result
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
Fail functions run \fIon the master\fP, so they must be synced using \fBsalt\-run
saltutil.sync_modules\fP\&.
.UNINDENT
.UNINDENT
.SS State
.sp
To execute a state, use \fI\%salt.state\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/salt/orch/webserver.sls
install_nginx:
  salt.state:
    \- tgt: \(aqweb*\(aq
    \- sls:
      \- nginx
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate orch.webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Highstate
.sp
To run a highstate, set \fBhighstate: True\fP in your state config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/salt/orch/web_setup.sls
webserver_setup:
  salt.state:
    \- tgt: \(aqweb*\(aq
    \- highstate: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate orch.web_setup
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Runner
.sp
To execute another runner, use \fI\%salt.runner\fP\&.
For example to use the \fBcloud.profile\fP runner in your orchestration state
additional options to replace values in the configured profile, use this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/salt/orch/deploy.sls
create_instance:
  salt.runner:
    \- name: cloud.profile
    \- prof: cloud\-centos
    \- provider: cloud
    \- instances:
      \- server1
    \- opts:
        minion:
          master: master1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To get a more dynamic state, use jinja variables together with
\fBinline pillar data\fP\&.
Using the same example but passing on pillar data, the state would be like
this.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/salt/orch/deploy.sls
{% set servers = salt[\(aqpillar.get\(aq](\(aqservers\(aq, \(aqtest\(aq) %}
{% set master = salt[\(aqpillar.get\(aq](\(aqmaster\(aq, \(aqsalt\(aq) %}
create_instance:
  salt.runner:
    \- name: cloud.profile
    \- prof: cloud\-centos
    \- provider: cloud
    \- instances:
      \- {{ servers }}
    \- opts:
        minion:
          master: {{ master }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To execute with pillar data.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orch orch.deploy pillar=\(aq{\(dqservers\(dq: \(dqnewsystem1\(dq,
\(dqmaster\(dq: \(dqmymaster\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Return Codes in Runner/Wheel Jobs
.sp
New in version 2018.3.0.

.sp
State (\fBsalt.state\fP) jobs are able to report failure via the \fI\%state
return dictionary\fP\&. Remote execution (\fBsalt.function\fP)
jobs are able to report failure by setting a \fBretcode\fP key in the
\fB__context__\fP dictionary. However, runner (\fBsalt.runner\fP) and wheel
(\fBsalt.wheel\fP) jobs would only report a \fBFalse\fP result when the
runner/wheel function raised an exception. As of the 2018.3.0 release, it is
now possible to set a retcode in runner and wheel functions just as you can do
in remote execution functions. Here is some example pseudocode:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def myrunner():
    ...
    # do stuff
    ...
    if some_error_condition:
        __context__[\(dqretcode\(dq] = 1
    return result
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This allows a custom runner/wheel function to report its failure so that
requisites can accurately tell that a job has failed.
.SS More Complex Orchestration
.sp
Many states/functions can be configured in a single file, which when combined
with the full suite of \fI\%Requisites and Other Global State Arguments\fP, can be used
to easily configure complex orchestration tasks. Additionally, the
states/functions will be executed in the order in which they are defined,
unless prevented from doing so by any \fI\%Requisites and Other Global State Arguments\fP, as is the default in
SLS files since 0.17.0.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
bootstrap_servers:
  salt.function:
    \- name: cmd.run
    \- tgt: 10.0.0.0/24
    \- tgt_type: ipcidr
    \- arg:
      \- bootstrap

storage_setup:
  salt.state:
    \- tgt: \(aqrole:storage\(aq
    \- tgt_type: grain
    \- sls: ceph
    \- require:
      \- salt: webserver_setup

webserver_setup:
  salt.state:
    \- tgt: \(aqweb*\(aq
    \- highstate: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Given the above setup, the orchestration will be carried out as follows:
.INDENT 0.0
.IP 1. 3
The shell command \fBbootstrap\fP will be executed on all minions in the
10.0.0.0/24 subnet.
.IP 2. 3
A Highstate will be run on all minions whose ID starts with \(dqweb\(dq, since
the \fBstorage_setup\fP state requires it.
.IP 3. 3
Finally, the \fBceph\fP SLS target will be executed on all minions which have
a grain called \fBrole\fP with a value of \fBstorage\fP\&.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Remember, salt\-run is \fIalways\fP executed on the master.
.UNINDENT
.UNINDENT
.SS Parsing Results Programmatically
.sp
Orchestration jobs return output in a specific data structure. That data
structure is represented differently depending on the outputter used. With the
default outputter for orchestration, you get a nice human\-readable output.
Assume the following orchestration SLS:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
good_state:
  salt.state:
    \- tgt: myminion
    \- sls:
    \- succeed_with_changes

bad_state:
  salt.state:
    \- tgt: myminion
    \- sls:
    \- fail_with_changes

mymod.myfunc:
  salt.function:
    \- tgt: myminion

mymod.myfunc_false_result:
  salt.function:
    \- tgt: myminion
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Running this using the default outputter would produce output which looks like
this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fa5944a73aa8_master:
\-\-\-\-\-\-\-\-\-\-
          ID: good_state
    Function: salt.state
      Result: True
     Comment: States ran successfully. Updating myminion.
     Started: 21:08:02.681604
    Duration: 265.565 ms
     Changes:
              myminion:
              \-\-\-\-\-\-\-\-\-\-
                        ID: test succeed with changes
                  Function: test.succeed_with_changes
                    Result: True
                   Comment: Success!
                   Started: 21:08:02.835893
                  Duration: 0.375 ms
                   Changes:
                            \-\-\-\-\-\-\-\-\-\-
                            testing:
                                \-\-\-\-\-\-\-\-\-\-
                                new:
                                    Something pretended to change
                                old:
                                    Unchanged

              Summary for myminion
              \-\-\-\-\-\-\-\-\-\-\-\-
              Succeeded: 1 (changed=1)
              Failed:    0
              \-\-\-\-\-\-\-\-\-\-\-\-
              Total states run:     1
              Total run time:   0.375 ms
\-\-\-\-\-\-\-\-\-\-
          ID: bad_state
    Function: salt.state
      Result: False
     Comment: Run failed on minions: myminion
     Started: 21:08:02.947702
    Duration: 177.01 ms
     Changes:
              myminion:
              \-\-\-\-\-\-\-\-\-\-
                        ID: test fail with changes
                  Function: test.fail_with_changes
                    Result: False
                   Comment: Failure!
                   Started: 21:08:03.116634
                  Duration: 0.502 ms
                   Changes:
                            \-\-\-\-\-\-\-\-\-\-
                            testing:
                                \-\-\-\-\-\-\-\-\-\-
                                new:
                                    Something pretended to change
                                old:
                                    Unchanged

              Summary for myminion
              \-\-\-\-\-\-\-\-\-\-\-\-
              Succeeded: 0 (changed=1)
              Failed:    1
              \-\-\-\-\-\-\-\-\-\-\-\-
              Total states run:     1
              Total run time:   0.502 ms
\-\-\-\-\-\-\-\-\-\-
          ID: mymod.myfunc
    Function: salt.function
      Result: True
     Comment: Function ran successfully. Function mymod.myfunc ran on myminion.
     Started: 21:08:03.125011
    Duration: 159.488 ms
     Changes:
              myminion:
                  True
\-\-\-\-\-\-\-\-\-\-
          ID: mymod.myfunc_false_result
    Function: salt.function
      Result: False
     Comment: Running function mymod.myfunc_false_result failed on minions: myminion. Function mymod.myfunc_false_result ran on myminion.
     Started: 21:08:03.285148
    Duration: 176.787 ms
     Changes:
              myminion:
                  False

Summary for fa5944a73aa8_master
\-\-\-\-\-\-\-\-\-\-\-\-
Succeeded: 2 (changed=4)
Failed:    2
\-\-\-\-\-\-\-\-\-\-\-\-
Total states run:     4
Total run time: 778.850 ms
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, using the \fBjson\fP outputter, you can get the output in an easily
loadable and parsable format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate test \-\-out=json
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqoutputter\(dq: \(dqhighstate\(dq,
    \(dqdata\(dq: {
        \(dqfa5944a73aa8_master\(dq: {
            \(dqsalt_|\-good_state_|\-good_state_|\-state\(dq: {
                \(dqcomment\(dq: \(dqStates ran successfully. Updating myminion.\(dq,
                \(dqname\(dq: \(dqgood_state\(dq,
                \(dqstart_time\(dq: \(dq21:35:16.868345\(dq,
                \(dqresult\(dq: true,
                \(dqduration\(dq: 267.299,
                \(dq__run_num__\(dq: 0,
                \(dq__jid__\(dq: \(dq20171130213516897392\(dq,
                \(dq__sls__\(dq: \(dqtest\(dq,
                \(dqchanges\(dq: {
                    \(dqret\(dq: {
                        \(dqmyminion\(dq: {
                            \(dqtest_|\-test succeed with changes_|\-test succeed with changes_|\-succeed_with_changes\(dq: {
                                \(dqcomment\(dq: \(dqSuccess!\(dq,
                                \(dqname\(dq: \(dqtest succeed with changes\(dq,
                                \(dqstart_time\(dq: \(dq21:35:17.022592\(dq,
                                \(dqresult\(dq: true,
                                \(dqduration\(dq: 0.362,
                                \(dq__run_num__\(dq: 0,
                                \(dq__sls__\(dq: \(dqsucceed_with_changes\(dq,
                                \(dqchanges\(dq: {
                                    \(dqtesting\(dq: {
                                        \(dqnew\(dq: \(dqSomething pretended to change\(dq,
                                        \(dqold\(dq: \(dqUnchanged\(dq
                                    }
                                },
                                \(dq__id__\(dq: \(dqtest succeed with changes\(dq
                            }
                        }
                    },
                    \(dqout\(dq: \(dqhighstate\(dq
                },
                \(dq__id__\(dq: \(dqgood_state\(dq
            },
            \(dqsalt_|\-bad_state_|\-bad_state_|\-state\(dq: {
                \(dqcomment\(dq: \(dqRun failed on minions: test\(dq,
                \(dqname\(dq: \(dqbad_state\(dq,
                \(dqstart_time\(dq: \(dq21:35:17.136511\(dq,
                \(dqresult\(dq: false,
                \(dqduration\(dq: 197.635,
                \(dq__run_num__\(dq: 1,
                \(dq__jid__\(dq: \(dq20171130213517202203\(dq,
                \(dq__sls__\(dq: \(dqtest\(dq,
                \(dqchanges\(dq: {
                    \(dqret\(dq: {
                        \(dqmyminion\(dq: {
                            \(dqtest_|\-test fail with changes_|\-test fail with changes_|\-fail_with_changes\(dq: {
                                \(dqcomment\(dq: \(dqFailure!\(dq,
                                \(dqname\(dq: \(dqtest fail with changes\(dq,
                                \(dqstart_time\(dq: \(dq21:35:17.326268\(dq,
                                \(dqresult\(dq: false,
                                \(dqduration\(dq: 0.509,
                                \(dq__run_num__\(dq: 0,
                                \(dq__sls__\(dq: \(dqfail_with_changes\(dq,
                                \(dqchanges\(dq: {
                                    \(dqtesting\(dq: {
                                        \(dqnew\(dq: \(dqSomething pretended to change\(dq,
                                        \(dqold\(dq: \(dqUnchanged\(dq
                                    }
                                },
                                \(dq__id__\(dq: \(dqtest fail with changes\(dq
                            }
                        }
                    },
                    \(dqout\(dq: \(dqhighstate\(dq
                },
                \(dq__id__\(dq: \(dqbad_state\(dq
            },
            \(dqsalt_|\-mymod.myfunc_|\-mymod.myfunc_|\-function\(dq: {
                \(dqcomment\(dq: \(dqFunction ran successfully. Function mymod.myfunc ran on myminion.\(dq,
                \(dqname\(dq: \(dqmymod.myfunc\(dq,
                \(dqstart_time\(dq: \(dq21:35:17.334373\(dq,
                \(dqresult\(dq: true,
                \(dqduration\(dq: 151.716,
                \(dq__run_num__\(dq: 2,
                \(dq__jid__\(dq: \(dq20171130213517361706\(dq,
                \(dq__sls__\(dq: \(dqtest\(dq,
                \(dqchanges\(dq: {
                    \(dqret\(dq: {
                        \(dqmyminion\(dq: true
                    },
                    \(dqout\(dq: \(dqhighstate\(dq
                },
                \(dq__id__\(dq: \(dqmymod.myfunc\(dq
            },
            \(dqsalt_|\-mymod.myfunc_false_result\-mymod.myfunc_false_result\-function\(dq: {
                \(dqcomment\(dq: \(dqRunning function mymod.myfunc_false_result failed on minions: myminion. Function mymod.myfunc_false_result ran on myminion.\(dq,
                \(dqname\(dq: \(dqmymod.myfunc_false_result\(dq,
                \(dqstart_time\(dq: \(dq21:35:17.486625\(dq,
                \(dqresult\(dq: false,
                \(dqduration\(dq: 174.241,
                \(dq__run_num__\(dq: 3,
                \(dq__jid__\(dq: \(dq20171130213517536270\(dq,
                \(dq__sls__\(dq: \(dqtest\(dq,
                \(dqchanges\(dq: {
                    \(dqret\(dq: {
                        \(dqmyminion\(dq: false
                    },
                    \(dqout\(dq: \(dqhighstate\(dq
                },
                \(dq__id__\(dq: \(dqmymod.myfunc_false_result\(dq
            }
        }
    },
    \(dqretcode\(dq: 1
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The 2018.3.0 release includes a couple fixes to make parsing this data easier and
more accurate. The first is the ability to set a \fI\%return code\fP in a custom runner or wheel
function, as noted above. The second is a change to how failures are included
in the return data. Prior to the 2018.3.0 release, minions that failed a
\fBsalt.state\fP orchestration job would show up in the \fBcomment\fP field of the
return data, in a human\-readable string that was not easily parsed. They are
now included in the \fBchanges\fP dictionary alongside the minions that
succeeded. In addition, \fBsalt.function\fP jobs which failed because the
\fI\%fail function\fP returned \fBFalse\fP
used to handle their failures in the same way \fBsalt.state\fP jobs did, and this
has likewise been corrected.
.SS Running States on the Master without a Minion
.sp
The orchestrate runner can be used to execute states on the master without
using a minion. For example, assume that \fBsalt://foo.sls\fP contains the
following SLS:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.managed:
    \- source: salt://files/foo.conf
    \- mode: 0600
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this case, running \fBsalt\-run state.orchestrate foo\fP would be the
equivalent of running a \fBstate.sls foo\fP, but it would execute on the master
only, and would not require a minion daemon to be running on the master.
.sp
This is not technically orchestration, but it can be useful in certain use
cases.
.SS Limitations
.sp
Only one SLS target can be run at a time using this method, while using
\fI\%state.sls\fP allows for multiple SLS files to
be passed in a comma\-separated list.
.SH SOLARIS
.sp
This section contains details on Solaris specific quirks and workarounds.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Solaris refers to both Solaris 10 compatible platforms like Solaris 10, illumos, SmartOS, OmniOS, OpenIndiana,... and Oracle Solaris 11 platforms.
.UNINDENT
.UNINDENT
.SS Solaris\-specific Behaviour
.sp
Salt is capable of managing Solaris systems, however due to various differences
between the operating systems, there are some things you need to keep in mind.
.sp
This document will contain any quirks that apply across Salt or limitations in
some modules.
.SS FQDN/UQDN
.sp
On Solaris platforms the FQDN will not always be properly detected.
If an IPv6 address is configured pythons \fB\(gasocket.getfqdn()\(ga\fP fails to return
a FQDN and returns the nodename instead. For a full breakdown see the following
issue on github: #37027
.SS Grains
.sp
Not all grains are available or some have empty or 0 as value. Mostly grains
that are dependent on hardware discovery like:
\- num_gpus
\- gpus
.sp
Also some resolver related grains like:
\- domain
\- \fI\%dns:options\fP
\- \fI\%dns:sortlist\fP
.SH SALT SSH
.SS Getting Started
.sp
Salt SSH is very easy to use, simply set up a basic \fI\%roster\fP file of the
systems to connect to and run \fBsalt\-ssh\fP commands in a similar way as
standard \fBsalt\fP commands.
.INDENT 0.0
.IP \(bu 2
Salt ssh is considered production ready in version 2014.7.0
.IP \(bu 2
Python is required on the remote system (unless using the \fB\-r\fP option to
send raw ssh commands).  The python version requirement is the same as that
for a standard Salt installation.
.IP \(bu 2
On many systems, the \fBsalt\-ssh\fP executable will be in its own package, usually named
\fBsalt\-ssh\fP
.IP \(bu 2
The Salt SSH system does not supersede the standard Salt communication
systems, it simply offers an SSH\-based alternative that does not require
ZeroMQ and a remote agent. Be aware that since all communication with Salt SSH is
executed via SSH it is substantially slower than standard Salt with ZeroMQ.
.IP \(bu 2
At the moment fileserver operations must be wrapped to ensure that the
relevant files are delivered with the \fBsalt\-ssh\fP commands.
The state module is an exception, which compiles the state run on the
master, and in the process finds all the references to \fBsalt://\fP paths and
copies those files down in the same tarball as the state run.
However, needed fileserver wrappers are still under development.
.UNINDENT
.SS Salt SSH Roster
.sp
The roster system in Salt allows for remote minions to be easily defined.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
See the \fI\%SSH roster docs\fP for more details.
.UNINDENT
.UNINDENT
.sp
Simply create the roster file, the default location is \fI/etc/salt/roster\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
web1: 192.168.42.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is a very basic roster file where a Salt ID is being assigned to an IP
address. A more elaborate roster can be created:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
web1:
  host: 192.168.42.1 # The IP addr or DNS hostname
  user: fred         # Remote executions will be executed as user fred
  passwd: foobarbaz  # The password to use for login, if omitted, keys are used
  sudo: True         # Whether to sudo to root, not enabled by default
web2:
  host: 192.168.42.2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
sudo works only if NOPASSWD is set for user in /etc/sudoers:
\fBfred ALL=(ALL) NOPASSWD: ALL\fP
.UNINDENT
.UNINDENT
.SS Deploy ssh key for salt\-ssh
.sp
By default, salt\-ssh will generate key pairs for ssh, the default path will be
\fB/etc/salt/pki/master/ssh/salt\-ssh.rsa\fP\&. The key generation happens when you run
\fBsalt\-ssh\fP for the first time.
.sp
You can use ssh\-copy\-id, (the OpenSSH key deployment tool) to deploy keys to your servers.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh\-copy\-id \-i /etc/salt/pki/master/ssh/salt\-ssh.rsa.pub user@server.demo.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
One could also create a simple shell script, named salt\-ssh\-copy\-id.sh as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!/bin/bash
if [ \-z $1 ]; then
   echo $0 user@host.com
   exit 0
fi
ssh\-copy\-id \-i /etc/salt/pki/master/ssh/salt\-ssh.rsa.pub $1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Be certain to chmod +x salt\-ssh\-copy\-id.sh.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\&./salt\-ssh\-copy\-id.sh user@server1.host.com
\&./salt\-ssh\-copy\-id.sh user@server2.host.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once keys are successfully deployed, salt\-ssh can be used to control them.
.sp
Alternatively ssh agent forwarding can be used by setting the priv to agent\-forwarding.
.SS Calling Salt SSH
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBsalt\-ssh\fP on target hosts without Python 3
.sp
The \fBsalt\-ssh\fP command requires at least python 3, which is not
installed by default on some target hosts.  An easy workaround in this
situation is to use the \fB\-r\fP option to run a raw shell command that
installs python26:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-ssh centos\-5\-minion \-r \(aqyum \-y install epel\-release ; yum \-y install python26\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBsalt\-ssh\fP on systems with Python 3.x
.sp
Salt, before the 2017.7.0 release, does not support Python 3.x which is the
default on for example the popular 16.04 LTS release of Ubuntu. An easy
workaround for this scenario is to use the \fB\-r\fP option similar to the
example above:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-ssh ubuntu\-1604\-minion \-r \(aqapt update ; apt install \-y python\-minimal\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The \fBsalt\-ssh\fP command can be easily executed in the same way as a salt
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-ssh \(aq*\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Commands with \fBsalt\-ssh\fP follow the same syntax as the \fBsalt\fP command.
.sp
The standard salt functions are available! The output is the same as \fBsalt\fP
and many of the same flags are available. Please see
\fI\%Salt SSH reference\fP for all of the available options.
.SS Raw Shell Calls
.sp
By default \fBsalt\-ssh\fP runs Salt execution modules on the remote system,
but \fBsalt\-ssh\fP can also execute raw shell commands:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-ssh \(aq*\(aq \-r \(aqifconfig\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS States Via Salt SSH
.sp
The Salt State system can also be used with \fBsalt\-ssh\fP\&. The state system
abstracts the same interface to the user in \fBsalt\-ssh\fP as it does when using
standard \fBsalt\fP\&. The intent is that Salt Formulas defined for standard
\fBsalt\fP will work seamlessly with \fBsalt\-ssh\fP and vice\-versa.
.sp
The standard Salt States walkthroughs function by simply replacing \fBsalt\fP
commands with \fBsalt\-ssh\fP\&.
.SS Targeting with Salt SSH
.sp
Due to the fact that the targeting approach differs in salt\-ssh, only glob
and regex targets are supported as of this writing, the remaining target
systems still need to be implemented.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
By default, Grains are settable through \fBsalt\-ssh\fP\&. By
default, these grains will \fInot\fP be persisted across reboots.
.sp
See the \(dqthin_dir\(dq setting in \fI\%Roster documentation\fP
for more details.
.UNINDENT
.UNINDENT
.SS Configuring Salt SSH
.sp
Salt SSH takes its configuration from a master configuration file. Normally, this
file is in \fB/etc/salt/master\fP\&. If one wishes to use a customized configuration file,
the \fB\-c\fP option to Salt SSH facilitates passing in a directory to look inside for a
configuration file named \fBmaster\fP\&.
.SS Minion Config
.sp
New in version 2015.5.1.

.sp
Minion config options can be defined globally using the master configuration
option \fBssh_minion_opts\fP\&. It can also be defined on a per\-minion basis with
the \fBminion_opts\fP entry in the roster.
.SS Running Salt SSH as non\-root user
.sp
By default, Salt read all the configuration from /etc/salt/. If you are running
Salt SSH with a regular user you have to modify some paths or you will get
\(dqPermission denied\(dq messages. You have to modify two parameters: \fBpki_dir\fP
and \fBcachedir\fP\&. Those should point to a full path writable for the user.
.sp
It\(aqs recommended not to modify /etc/salt for this purpose. Create a private copy
of /etc/salt for the user and run the command with \fB\-c /new/config/path\fP\&.
.SS Define CLI Options with Saltfile
.sp
If you are commonly passing in CLI options to \fBsalt\-ssh\fP, you can create
a \fBSaltfile\fP to automatically use these options. This is common if you\(aqre
managing several different salt projects on the same server.
.sp
So you can \fBcd\fP into a directory that has a \fBSaltfile\fP with the following
YAML contents:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-ssh:
  config_dir: path/to/config/dir
  ssh_log_file: salt\-ssh.log
  ssh_max_procs: 30
  ssh_wipe: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Instead of having to call
\fBsalt\-ssh \-\-config\-dir=path/to/config/dir \-\-max\-procs=30 \-\-wipe \e* test.version\fP you
can call \fBsalt\-ssh \e* test.version\fP\&.
.sp
Boolean\-style options should be specified in their YAML representation.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The option keys specified must match the destination attributes for the
options specified in the parser
\fBsalt.utils.parsers.SaltSSHOptionParser\fP\&.  For example, in the
case of the \fB\-\-wipe\fP command line option, its \fBdest\fP is configured to
be \fBssh_wipe\fP and thus this is what should be configured in the
\fBSaltfile\fP\&.  Using the names of flags for this option, being \fBwipe:
True\fP or \fBw: True\fP, will not work.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For the \fISaltfile\fP to be automatically detected it needs to be named
\fISaltfile\fP with a capital \fIS\fP and be readable by the user running
salt\-ssh.
.UNINDENT
.UNINDENT
.sp
At last you can create \fB~/.salt/Saltfile\fP and \fBsalt\-ssh\fP
will automatically load it by default.
.SS Advanced options with salt\-ssh
.sp
Salt\(aqs ability to allow users to have custom grains and custom modules
is also applicable to using salt\-ssh. This is done through first packing
the custom grains into the thin tarball before it is deployed on the system.
.sp
For this to happen, the \fBconfig\fP file must be explicit enough to indicate
where the custom grains are located on the machine like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_client: local
file_roots:
  base:
    \- /home/user/.salt
    \- /home/user/.salt/_states
    \- /home/user/.salt/_grains
module_dirs:
  \- /home/user/.salt
pillar_roots:
  base:
    \- /home/user/.salt/_pillar
root_dir: /tmp/.salt\-root
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs better to be explicit rather than implicit in this situation. This will
allow urls all under \fIsalt://\fP to be resolved such as \fIsalt://_grains/custom_grain.py\fP\&.
.sp
One can confirm this action by executing a properly setup salt\-ssh minion with
\fIsalt\-ssh minion grains.items\fP\&. During this process, a \fIsaltutil.sync_all\fP is
ran to discover the thin tarball and then consumed. Output similar to this
indicates a successful sync with custom grains.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
local:
    \-\-\-\-\-\-\-\-\-\-
    ...
    executors:
    grains:
        \- grains.custom_grain
    log_handlers:
    ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is especially important when using a custom \fIfile_roots\fP that differ from
\fI/etc/salt/\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Please see \fI\%https://docs.saltproject.io/en/latest/topics/grains/\fP for more
information on grains and custom grains.
.UNINDENT
.UNINDENT
.SS Debugging salt\-ssh
.sp
One common approach for debugging \fBsalt\-ssh\fP is to simply use the tarball that salt
ships to the remote machine and call \fBsalt\-call\fP directly.
.sp
To determine the location of \fBsalt\-call\fP, simply run \fBsalt\-ssh\fP with the \fB\-ltrace\fP
flag and look for a line containing the string, \fBSALT_ARGV\fP\&. This contains the \fBsalt\-call\fP
command that \fBsalt\-ssh\fP attempted to execute.
.sp
It is recommended that one modify this command a bit by removing the \fB\-l quiet\fP,
\fB\-\-metadata\fP and \fB\-\-output json\fP to get a better idea of what\(aqs going on the target system.
.SS Salt Rosters
.sp
Salt rosters are pluggable systems added in Salt 0.17.0 to facilitate the
\fBsalt\-ssh\fP system.
The roster system was created because \fBsalt\-ssh\fP needs a means to
identify which systems need to be targeted for execution.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%roster modules\fP
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The Roster System is not needed or used in standard Salt because the
master does not need to be initially aware of target systems, since the
Salt Minion checks itself into the master.
.UNINDENT
.UNINDENT
.sp
Since the roster system is pluggable, it can be easily augmented to attach to
any existing systems to gather information about what servers are presently
available and should be attached to by \fBsalt\-ssh\fP\&. By default the roster
file is located at /etc/salt/roster.
.SS How Rosters Work
.sp
The roster system compiles a data structure internally referred to as
\fBtargets\fP\&. The \fBtargets\fP is a list of target systems and attributes about how
to connect to said systems. The only requirement for a roster module in Salt
is to return the \fBtargets\fP data structure.
.SS Targets Data
.sp
The information which can be stored in a roster \fBtarget\fP is the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<Salt ID>:       # The id to reference the target system with
    host:        # The IP address or DNS name of the remote host
    user:        # The user to log in as
    passwd:      # The password to log in with

    # Optional parameters
    port:        # The target system\(aqs ssh port number
    sudo:        # Boolean to run command via sudo
    sudo_user:   # Str: Set this to execute Salt as a sudo user other than root.
                 # This user must be in the same system group as the remote user
                 # that is used to login and is specified above. Alternatively,
                 # the user must be a super\-user.
    tty:         # Boolean: Set this option to True if sudo is also set to
                 # True and requiretty is also set on the target system
    priv:        # File path to ssh private key, defaults to salt\-ssh.rsa
                 # The priv can also be set to agent\-forwarding to not specify
                 # a key, but use ssh agent forwarding
    priv_passwd: # Passphrase for ssh private key
    timeout:     # Number of seconds to wait for response when establishing
                 # an SSH connection
    minion_opts: # Dictionary of minion opts
    thin_dir:    # The target system\(aqs storage directory for Salt
                 # components. Defaults to /tmp/salt\-<hash>.
    cmd_umask:   # umask to enforce for the salt\-call command. Should be in
                 # octal (so for 0o077 in YAML you would do 0077, or 63)
    ssh_pre_flight: # Path to a script that will run before all other salt\-ssh
                    # commands. Will only run the first time when the thin dir
                    # does not exist, unless \-\-pre\-flight is passed to salt\-ssh
                    # command or ssh_run_pre_flight is set to true in the config
                    # Added in 3001 Release.
    ssh_pre_flight_args: # The list of arguments to pass to the script
                         # running on the minion with ssh_pre_flight.
                         # Can be specified as single string.
    set_path:    # Set the path environment variable, to ensure the expected python
                 # binary is in the salt\-ssh path, when running the command.
                 # Example: \(aq$PATH:/usr/local/bin/\(aq. Added in 3001 Release.
    ssh_options: # List of options (as \(aqoption=argument\(aq) to pass to ssh.
.ft P
.fi
.UNINDENT
.UNINDENT
.SS ssh_pre_flight
.sp
A Salt\-SSH roster option \fIssh_pre_flight\fP was added in the 3001 release. This enables
you to run a script before Salt\-SSH tries to run any commands. You can set this option
in the roster for a specific minion or use the \fIroster_defaults\fP to set it for all minions.
This script will only run if the thin dir is not currently on the minion. This means it will
only run on the first run of salt\-ssh or if you have recently wiped out your thin dir. If
you want to intentionally run the script again you have a couple of options:
.INDENT 0.0
.IP \(bu 2
Wipe out your thin dir by using the \-w salt\-ssh arg.
.IP \(bu 2
Set ssh_run_pre_flight to True in the config
.IP \(bu 2
Run salt\-ssh with the \-\-pre\-flight arg.
.UNINDENT
.SS ssh_pre_flight_args
.sp
Additional arguments to the script running on the minion with \fIssh_pre_flight\fP can be passed
with specifying a list of arguments or a single string. In case of using single string
distinct arguments will be passed to the script by splitting this string with the spaces.
.SS Target Defaults
.sp
The \fIroster_defaults\fP dictionary in the master config is used to set the
default login variables for minions in the roster so that the same arguments do
not need to be passed with commandline arguments.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
roster_defaults:
  user: daniel
  sudo: True
  priv: /root/.ssh/id_rsa
  tty: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS thin_dir
.sp
Salt needs to upload a standalone environment to the target system, and this
defaults to /tmp/salt\-<hash>. This directory will be cleaned up per normal
systems operation.
.sp
If you need a persistent Salt environment, for instance to set persistent grains,
this value will need to be changed.
.SS SSH Ext Alternatives
.sp
In the 2019.2.0 release the \fBssh_ext_alternatives\fP feature was added.
This allows salt\-ssh to work across different supported python versions. You will
need to ensure you have the following:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Salt is installed, with all required dependencies for the Python version.
.IP \(bu 2
Everything needs to be importable from the respective Python environment.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
To enable using this feature you will need to edit the master configuration similar
to below:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_ext_alternatives:
    2019.2:                     # Namespace, can be anything.
        py\-version: [2, 7]      # Constraint to specific interpreter version
        path: /opt/2019.2/salt  # Main Salt installation directory.
        dependencies:           # List of dependencies and their installation paths
          jinja2: /opt/jinja2
          yaml: /opt/yaml
          tornado: /opt/tornado
          msgpack: /opt/msgpack
          certifi: /opt/certifi
          singledispatch: /opt/singledispatch.py
          singledispatch_helpers: /opt/singledispatch_helpers.py
          markupsafe: /opt/markupsafe
          backports_abc: /opt/backports_abc.py
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
When using Salt versions >= 3001 and Python 2 is your \fBpy\-version\fP
you need to use an older version of Salt that supports Python 2.
For example, if using Salt\-SSH version 3001 and you do not want
to install Python 3 on your target host you can use \fBssh_ext_alternatives\fP\(aqs
\fBpath\fP option. This option needs to point to a 2019.2.3 Salt installation directory
on your Salt\-SSH host, which still supports Python 2.
.UNINDENT
.UNINDENT
.SS auto_detect
.sp
In the 3001 release the \fBauto_detect\fP feature was added for \fBssh_ext_alternatives\fP\&.
This allows salt\-ssh to automatically detect the path to all of your dependencies and
does not require you to define them under \fBdependencies\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_ext_alternatives:
    2019.2:                     # Namespace, can be anything.
        py\-version: [2, 7]      # Constraint to specific interpreter version
        path: /opt/2019.2/salt  # Main Salt installation directory.
        auto_detect: True       # Auto detect dependencies
        py_bin: /usr/bin/python2.7 # Python binary path used to auto detect dependencies
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If \fBpy_bin\fP is not set alongside \fBauto_detect\fP, it will attempt to auto detect
the dependencies using the major version set in \fBpy\-version\fP\&. For example if you
have \fB[2, 7]\fP set as your \fBpy\-version\fP, it will attempt to use the binary \fBpython2\fP\&.
.sp
You can also use \fBauto_detect\fP and \fBdependencies\fP together.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_ext_alternatives:
    2019.2:                     # Namespace, can be anything.
        py\-version: [2, 7]      # Constraint to specific interpreter version
        path: /opt/2019.2/salt  # Main Salt installation directory.
        auto_detect: True       # Auto detect dependencies
        py_bin: /usr/bin/python2.7 # Python binary path to auto detect dependencies
        dependencies:           # List of dependencies and their installation paths
          jinja2: /opt/jinja2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a dependency is defined in the \fBdependencies\fP list \fBssh_ext_alternatives\fP will use
this dependency, instead of the path that \fBauto_detect\fP finds. For example, if you define
\fB/opt/jinja2\fP under your \fBdependencies\fP for jinja2, it will not try to autodetect the
file path to the jinja2 module, and will favor \fB/opt/jinja2\fP\&.
.SS Different Python Versions
.sp
The 3001 release removed python 2 support in Salt. Even though this python 2 support
is being dropped we have provided multiple ways to work around this with Salt\-SSH. You
can use the following options:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fI\%ssh_pre_flight\fP
.IP \(bu 2
Using the Salt\-SSH raw shell calls to install Python3.
.IP \(bu 2
Use an older version of Salt on the target host that still supports Python 2 using the feature \fI\%SSH ext alternatives\fP
.UNINDENT
.UNINDENT
.UNINDENT
.SH THORIUM COMPLEX REACTOR
.sp
The original Salt Reactor is based on the idea of listening for a specific
event and then reacting to it. This model comes with many logical limitations,
for instance it is very difficult (and hacky) to fire a reaction based on
aggregate data or based on multiple events.
.sp
The Thorium reactor is intended to alleviate this problem in a very elegant way.
Instead of using extensive jinja routines or complex python sls files the
aggregation of data and the determination of what should run becomes isolated
to the sls data logic, makes the definitions much cleaner.
.SS Starting the Thorium Engine
.sp
To enable the thorium engine add the following configuration to the engines
section of your Salt Master or Minion configuration file and restart the daemon:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- thorium: {}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Thorium Modules
.sp
Because of its specialized nature, Thorium uses its own set of modules. However,
many of these modules are designed to wrap the more commonly\-used Salt
subsystems. These modules are:
.INDENT 0.0
.IP \(bu 2
local: Execution modules
.IP \(bu 2
runner: Runner modules
.IP \(bu 2
wheel: Wheel modules
.UNINDENT
.sp
There are other modules that ship with Thorium as well. Some of these will be
highlighted later in this document.
.SS Writing Thorium Formulas
.sp
Like some other Salt subsystems, Thorium uses its own directory structure. The
default location for this structure is \fB/srv/thorium/\fP, but it can be changed
using the \fBthorium_roots\fP setting in the \fBmaster\fP configuration file.
.sp
This would explicitly set the roots to the default:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
thorium_roots:
  base:
    \- /srv/thorium
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example \fBthorium_roots\fP configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
thorium_roots:
  base:
    \- /etc/salt/thorium
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is also possible to use gitfs with Thorium,
using the \fBthoriumenv\fP or \fBthorium_top\fP settings.
.sp
Example using \fBthorium_top\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
thorium_top: salt://thorium/top.sls
gitfs_provider: pygit2

gitfs_remotes:
  \- git@github.com:user/repo.git:
    \- name: salt\-backend
    \- root: salt
    \- base: master
  \- git@github.com:user/repo.git:
    \- name: thorium\-backend
    \- root: thorium
    \- base: master
    \- mountpoint: salt://thorium
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When using this method don\(aqt forget to prepend the mountpoint to files served by this repo,
for example \fBtop.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- thorium.key_clean
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Example using \fBthoriumenv\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
thoriumenv: thorium
gitfs_provider: pygit2

gitfs_remotes:
  \- git@github.com:user/repo.git:
    \- name: salt\-backend
    \- root: salt
    \- base: master
  \- git@github.com:user/repo.git:
    \- name: thorium\-backend
    \- root: thorium
    \- saltenv:
      \- thorium:
        \- ref: master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When using this method all state will run under the defined environment,
for example \fBtop.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
thorium:
  \(aq*\(aq:
    \- key_clean
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS The Thorium top.sls File
.sp
Thorium uses its own \fBtop.sls\fP file, which follows the same convention as is
found in \fB/srv/salt/\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<srv>:
  <target>:
    \- <formula 1>
    \- <formula 2>
    \- <etc...>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For instance, a \fBtop.sls\fP using a standard \fBbase\fP environment and a single
Thorium formula called \fBkey_clean\fP, would look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- key_clean
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Take note that the target in a Thorium \fBtop.sls\fP is not used; it only exists
to follow the same convention as other \fBtop.sls\fP files. Leave this set to
\fB\(aq*\(aq\fP in your own Thorium \fBtop.sls\fP\&.
.SS Thorium Formula Files
.sp
Thorium SLS files are processed by the same state compiler that processes Salt
state files. This means that features like requisites, templates, and so on are
available.
.sp
Let\(aqs take a look at an example, and then discuss each component of it. This
formula uses Thorium to detect when a minion has disappeared and then deletes
the key from the master when the minion has been gone for 60 seconds:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
statreg:
  status.reg

keydel:
  key.timeout:
    \- delete: 60
    \- require:
      \- status: statreg
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There are two stanzas in this formula, whose IDs are \fBstatreg\fP and
\fBkeydel\fP\&. The first stanza, \fBstatreg\fP, tells Thorium to keep track of
minion status beacons in its \fIregister\fP\&. We\(aqll talk more about the register in
a moment.
.sp
The second stanza, \fBkeydel\fP, is the one that does the real work. It uses the
\fBkey\fP module to apply an expiration (using the \fBtimeout\fP function) to a
minion. Because \fBdelete\fP is set to \fB60\fP, this is a 60 second expiration. If
a minion does not check in at least once every 60 seconds, its key will be
deleted from the master. This particular function also allows you to use
\fBreject\fP instead of \fBdelete\fP, allowing for a minion to be rejected instead
of deleted if it does not check in within the specified time period.
.sp
There is also a \fBrequire\fP requisite in this stanza. It states that the
\fBkey.timeout\fP function will not be called unless the \fBstatus.reg\fP function
in the \fBstatreg\fP codeblock has been successfully called first.
.SS Thorium Links to Beacons
.sp
The above example was added in the 2016.11.0 release of Salt and makes use of the
\fBstatus\fP beacon also added in the 2016.11.0 release. For the above Thorium state
to function properly you will also need to enable the \fBstatus\fP beacon in the
\fBminion\fP configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  status:
    \- interval: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will cause the minion to use the status beacon to check in with the master
every 10 seconds.
.SS The Thorium Register
.sp
In order to keep track of information, Thorium uses an in\-memory register (or
rather, collection of registers) on the master. These registers are only
populated when told to by a formula, and they normally will be erased when the
master is restarted. It is possible to persist the registers to disk, but we\(aqll
get to that in a moment.
.sp
The example above uses \fBstatus.reg\fP to populate a register for you, which is
automatically used by the \fBkey.timeout\fP function. However, you can set your
own register values as well, using the \fBreg\fP module.
.sp
Because Thorium watches the event bus, the \fBreg\fP module is designed to look
for user\-specified tags, and then extract data from the payload of events that
match those tags. For instance, the following stanza will look for an event
with a tag of \fBmy/custom/event\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  reg.list:
    \- add: bar
    \- match: my/custom/event
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When such an event is found, the data found in the payload dictionary key of
\fBbar\fP will be stored in a register called \fBfoo\fP\&. This register will store
that data in a \fBlist\fP\&. You may also use \fBreg.set\fP to add data to a \fBset()\fP
instead.
.sp
If you would like to see a copy of the register as it is stored in memory, you
can use the \fBfile.save\fP function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myreg:
  file.save
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this case, each time the register is updated, a copy will be saved in JSON
format at \fB/var/cache/salt/master/thorium/saves/myreg\fP\&. If you would like to
see when particular events are added to a list\-type register, you may add a
\fBstamp\fP option to \fBreg.list\fP (but not \fBreg.set\fP). With the above two
stanzas put together, this would look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  reg.list:
    \- add: bar
    \- match: my/custom/event
    \- stamp: True

myreg:
  file.save
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you would like to only keep a certain number of the most recent register
entries, you may also add a \fBprune\fP option to \fBreg.list\fP (but not
\fBreg.set\fP):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  reg.list:
    \- add: bar
    \- match: my/custom/event
    \- stamp: True
    \- prune: 50
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example will only keep the 50 most recent entries in the \fBfoo\fP register.
.SS Using Register Data
.sp
Putting data in a register is useless if you don\(aqt do anything with it. The
\fBcheck\fP module is designed to examine register data and determine whether it
matches the given parameters. For instance, the \fBcheck.contains\fP function
will return \fBTrue\fP if the given \fBvalue\fP is contained in the specified
register:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  reg.list:
    \- add: bar
    \- match: my/custom/event
    \- stamp: True
    \- prune: 50
  check.contains:
    \- value: somedata
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Used with a \fBrequire\fP requisite, we can call one of the wrapper modules and
perform an operation. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
shell_test:
  local.cmd:
    \- tgt: dufresne
    \- func: cmd.run
    \- arg:
      \- echo \(aqthorium success\(aq > /tmp/thorium.txt
    \- require:
      \- check: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This stanza will only run if the \fBcheck.contains\fP function under the \fBfoo\fP
ID returns true (meaning the match was found).
.sp
There are a number of other functions in the \fBcheck\fP module which use
different means of comparing values:
.INDENT 0.0
.IP \(bu 2
\fBgt\fP: Check whether the register entry is greater than the given value
.IP \(bu 2
\fBgte\fP: Check whether the register entry is greater than or equal to the given value
.IP \(bu 2
\fBlt\fP: Check whether the register entry is less than the given value
.IP \(bu 2
\fBlte\fP: Check whether the register entry is less than or equal to the given value
.IP \(bu 2
\fBeq\fP: Check whether the register entry is equal to the given value
.IP \(bu 2
\fBne\fP: Check whether the register entry is not equal to the given value
.UNINDENT
.sp
There is also a function called \fBcheck.event\fP which does not examine the
register. Instead, it looks directly at an event as it is coming in on the
event bus, and returns \fBTrue\fP if that event\(aqs tag matches. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt/foo/*/bar:
  check.event

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.version
    \- require:
      \- check: salt/foo/*/bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This formula will look for an event whose tag is \fBsalt/foo/<anything>/bar\fP and
if it comes in, issue a \fBtest.version\fP to all minions.
.SS Register Persistence
.sp
It is possible to persist the register data to disk when a master is stopped
gracefully, and reload it from disk when the master starts up again. This
functionality is provided by the returner subsystem, and is enabled whenever
any returner containing a \fBload_reg\fP and a \fBsave_reg\fP function is used.
.SH SALT CLOUD
.SS Configuration
.sp
Salt Cloud provides a powerful interface to interact with cloud hosts. This
interface is tightly integrated with Salt, and new virtual machines
are automatically connected to your Salt master after creation.
.sp
Since Salt Cloud is designed to be an automated system, most configuration
is done using the following YAML configuration files:
.INDENT 0.0
.IP \(bu 2
\fB/etc/salt/cloud\fP: The main configuration file, contains global settings
that apply to all cloud hosts. See \fI\%Salt Cloud Configuration\fP\&.
.IP \(bu 2
\fB/etc/salt/cloud.providers.d/*.conf\fP: Contains settings that configure
a specific cloud host, such as credentials, region settings, and so on. Since
configuration varies significantly between each cloud host, a separate file
should be created for each cloud host. In Salt Cloud, a provider is
synonymous with a cloud host (Amazon EC2, Google Compute Engine, Rackspace,
and so on).  See \fI\%Provider Specifics\fP\&.
.IP \(bu 2
\fB/etc/salt/cloud.profiles.d/*.conf\fP: Contains settings that define
a specific VM type. A profile defines the systems specs and image, and any
other settings that are specific to this VM type. Each specific VM type is
called a profile, and multiple profiles can be defined in a profile file.
Each profile references a parent provider that defines the cloud host in
which the VM is created (the provider settings are in the provider
configuration explained above).  Based on your needs, you might define
different profiles for web servers, database servers, and so on. See \fI\%VM
Profiles\fP\&.
.UNINDENT
.SS Configuration Inheritance
.sp
Configuration settings are inherited in order from the cloud config =>
providers => profile.
[image]
.sp
For example, if you wanted to use the same image for
all virtual machines for a specific provider, the image name could be placed in
the provider file. This value is inherited by all profiles that use that
provider, but is overridden if a image name is defined in the profile.
.sp
Most configuration settings can be defined in any file, the main difference
being how that setting is inherited.
.SS QuickStart
.sp
The \fI\%Salt Cloud Quickstart\fP walks you through defining
a provider, a VM profile, and shows you how to create virtual machines using Salt Cloud.
.sp
Note that if you installed Salt via \fI\%Salt Bootstrap\fP, it may not have
automatically installed salt\-cloud for you. Use your distribution\(aqs package
manager to install the \fBsalt\-cloud\fP package from the same repo that you
used to install Salt.  These repos will automatically be setup by Salt Bootstrap.
.sp
Alternatively, the \fB\-L\fP option can be passed to the \fI\%Salt Bootstrap\fP script when
installing Salt. The \fB\-L\fP option will install \fBsalt\-cloud\fP and the required
\fBlibcloud\fP package.
.SS Using Salt Cloud
.SS \fBsalt\-cloud\fP
.sp
Provision virtual machines in the cloud with Salt
.SS Synopsis
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-m /etc/salt/cloud.map

salt\-cloud \-m /etc/salt/cloud.map NAME

salt\-cloud \-m /etc/salt/cloud.map NAME1 NAME2

salt\-cloud \-p PROFILE NAME

salt\-cloud \-p PROFILE NAME1 NAME2 NAME3 NAME4 NAME5 NAME6
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Description
.sp
Salt Cloud is the system used to provision virtual machines on various public
clouds via a cleanly controlled profile and mapping system.
.SS Options
.INDENT 0.0
.TP
.B \-\-version
Print the version of Salt that is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies and version number, and then exit
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
Show the help message and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory. This directory contains
the configuration files for Salt master and minions. The default location
on most systems is \fB/etc/salt\fP\&.
.UNINDENT
.SS Execution Options
.INDENT 0.0
.TP
.B \-L LOCATION, \-\-location=LOCATION
Specify which region to connect to.
.UNINDENT
.INDENT 0.0
.TP
.B \-a ACTION, \-\-action=ACTION
Perform an action that may be specific to this cloud provider. This
argument requires one or more instance names to be specified.
.UNINDENT
.INDENT 0.0
.TP
.B \-f <FUNC\-NAME> <PROVIDER>, \-\-function=<FUNC\-NAME> <PROVIDER>
Perform an function that may be specific to this cloud provider, that does
not apply to an instance. This argument requires a provider to be specified
(i.e.: nova).
.UNINDENT
.INDENT 0.0
.TP
.B \-p PROFILE, \-\-profile=PROFILE
Select a single profile to build the named cloud VMs from. The profile must
be defined in the specified profiles file.
.UNINDENT
.INDENT 0.0
.TP
.B \-m MAP, \-\-map=MAP
Specify a map file to use. If used without any other options, this option
will ensure that all of the mapped VMs are created. If the named VM already
exists then it will be skipped.
.UNINDENT
.INDENT 0.0
.TP
.B \-H, \-\-hard
When specifying a map file, the default behavior is to ensure that all of
the VMs specified in the map file are created. If the \-\-hard option is
set, then any VMs that exist on configured cloud providers that are
not specified in the map file will be destroyed. Be advised that this can
be a destructive operation and should be used with care.
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-destroy
Pass in the name(s) of VMs to destroy, salt\-cloud will search the
configured cloud providers for the specified names and destroy the
VMs. Be advised that this is a destructive operation and should be used
with care. Can be used in conjunction with the \-m option to specify a map
of VMs to be deleted.
.UNINDENT
.INDENT 0.0
.TP
.B \-P, \-\-parallel
Normally when building many cloud VMs they are executed serially. The \-P
option will run each cloud vm build in a separate process allowing for
large groups of VMs to be build at once.
.sp
Be advised that some cloud provider\(aqs systems don\(aqt seem to be well suited
for this influx of vm creation. When creating large groups of VMs watch the
cloud provider carefully.
.UNINDENT
.INDENT 0.0
.TP
.B \-u, \-\-update\-bootstrap
Update salt\-bootstrap to the latest stable bootstrap release.
.UNINDENT
.INDENT 0.0
.TP
.B \-y, \-\-assume\-yes
Default yes in answer to all confirmation questions.
.UNINDENT
.INDENT 0.0
.TP
.B \-k, \-\-keep\-tmp
Do not remove files from /tmp/ after deploy.sh finishes.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-show\-deploy\-args
Include the options used to deploy the minion in the data returned.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-script\-args=SCRIPT_ARGS
Script arguments to be fed to the bootstrap script when deploying the VM.
.UNINDENT
.SS Query Options
.INDENT 0.0
.TP
.B \-Q, \-\-query
Execute a query and return some information about the nodes running on
configured cloud providers
.UNINDENT
.INDENT 0.0
.TP
.B \-F, \-\-full\-query
Execute a query and print out all available information about all cloud VMs.
Can be used in conjunction with \-m to display only information about the
specified map.
.UNINDENT
.INDENT 0.0
.TP
.B \-S, \-\-select\-query
Execute a query and print out selected information about all cloud VMs.
Can be used in conjunction with \-m to display only information about the
specified map.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-list\-providers
Display a list of configured providers.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-list\-profiles
New in version 2014.7.0.

.sp
Display a list of configured profiles. Pass in a cloud provider to view
the provider\(aqs associated profiles, such as \fBdigitalocean\fP, or pass in
\fBall\fP to list all the configured profiles.
.UNINDENT
.SS Cloud Providers Listings
.INDENT 0.0
.TP
.B \-\-list\-locations=LIST_LOCATIONS
Display a list of locations available in configured cloud providers. Pass
the cloud provider that available locations are desired on, such as \(dqlinode\(dq,
or pass \(dqall\(dq to list locations for all configured cloud providers
.UNINDENT
.INDENT 0.0
.TP
.B \-\-list\-images=LIST_IMAGES
Display a list of images available in configured cloud providers. Pass the
cloud provider that available images are desired on, such as \(dqlinode\(dq, or pass
\(dqall\(dq to list images for all configured cloud providers
.UNINDENT
.INDENT 0.0
.TP
.B \-\-list\-sizes=LIST_SIZES
Display a list of sizes available in configured cloud providers. Pass the
cloud provider that available sizes are desired on, such as \(dqAWS\(dq, or pass
\(dqall\(dq to list sizes for all configured cloud providers
.UNINDENT
.SS Cloud Credentials
.INDENT 0.0
.TP
.B \-\-set\-password=<USERNAME> <PROVIDER>
Configure password for a cloud provider and save it to the keyring.
PROVIDER can be specified with or without a driver, for example:
\(dq\-\-set\-password bob rackspace\(dq or more specific \(dq\-\-set\-password bob
rackspace:openstack\(dq DEPRECATED!
.UNINDENT
.SS Output Options
.INDENT 0.0
.TP
.B \-\-out
Pass in an alternative outputter to display the return of data. This
outputter can be any of the available outputters:
.INDENT 7.0
.INDENT 3.5
\fBhighstate\fP, \fBjson\fP, \fBkey\fP, \fBoverstatestage\fP, \fBpprint\fP, \fBraw\fP, \fBtxt\fP, \fByaml\fP, and \fI\%many others\fP\&.
.UNINDENT
.UNINDENT
.sp
Some outputters are formatted only for data returned from specific functions.
If an outputter is used that does not support the data passed into it, then
Salt will fall back on the \fBpprint\fP outputter and display the return data
using the Python \fBpprint\fP standard library module.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-indent OUTPUT_INDENT, \-\-output\-indent OUTPUT_INDENT
Print the output indented by the provided value in spaces. Negative values
disable indentation. Only applicable in outputters that support
indentation.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-file=OUTPUT_FILE, \-\-output\-file=OUTPUT_FILE
Write the output to the specified file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-file\-append, \-\-output\-file\-append
Append the output to the specified file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-color
Disable all colored output
.UNINDENT
.INDENT 0.0
.TP
.B \-\-force\-color
Force colored output
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using colored output the color codes are as follows:
.sp
\fBgreen\fP denotes success, \fBred\fP denotes failure, \fBblue\fP denotes
changes and success and \fByellow\fP denotes a expected future change in configuration.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-state\-output=STATE_OUTPUT, \-\-state_output=STATE_OUTPUT
Override the configured state_output value for minion
output. One of \(aqfull\(aq, \(aqterse\(aq, \(aqmixed\(aq, \(aqchanges\(aq or
\(aqfilter\(aq. Default: \(aqnone\(aq.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-state\-verbose=STATE_VERBOSE, \-\-state_verbose=STATE_VERBOSE
Override the configured state_verbose value for minion
output. Set to True or False. Default: none.
.UNINDENT
.SS Examples
.sp
To create 4 VMs named web1, web2, db1, and db2 from specified profiles:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p fedora_rackspace web1 web2 db1 db2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To read in a map file and create all VMs specified therein:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-m /path/to/cloud.map
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To read in a map file and create all VMs specified therein in parallel:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-m /path/to/cloud.map \-P
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To delete any VMs specified in the map file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-m /path/to/cloud.map \-d
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To delete any VMs NOT specified in the map file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-m /path/to/cloud.map \-H
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To display the status of all VMs specified in the map file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-m /path/to/cloud.map \-Q
.ft P
.fi
.UNINDENT
.UNINDENT
.SS See also
.sp
\fBsalt\-cloud(7)\fP
\fBsalt(7)\fP
\fBsalt\-master(1)\fP
\fBsalt\-minion(1)\fP
.SS Salt Cloud basic usage
.sp
Salt Cloud needs, at least, one configured
\fI\%Provider\fP
and \fI\%Profile\fP to be functional.
.SS Creating a VM
.sp
To create a VM with salt cloud, use command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p <profile> name_of_vm
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Assuming there is a profile configured as following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fedora_rackspace:
    provider: my\-rackspace\-config
    image: Fedora 17
    size: 256 server
    script: bootstrap\-salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then, the command to create new VM named \fBfedora_http_01\fP is:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p fedora_rackspace fedora_http_01
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Destroying a VM
.sp
To destroy a created\-by\-salt\-cloud VM, use command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-d name_of_vm
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For example, to delete the VM created on above example, use:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-d fedora_http_01
.ft P
.fi
.UNINDENT
.UNINDENT
.SS VM Profiles
.sp
Salt cloud designates virtual machines inside the profile configuration file.
The profile configuration file defaults to \fB/etc/salt/cloud.profiles\fP and is
a yaml configuration. The syntax for declaring profiles is simple:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fedora_rackspace:
    provider: my\-rackspace\-config
    image: Fedora 17
    size: 256 server
    script: bootstrap\-salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It should be noted that the \fBscript\fP option defaults to \fBbootstrap\-salt\fP,
and does not normally need to be specified. Further examples in this document
will not show the \fBscript\fP option.
.sp
A few key pieces of information need to be declared and can change based on the
cloud provider. A number of additional parameters can also be inserted:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
centos_rackspace:
  provider: my\-rackspace\-config
  image: CentOS 6.2
  size: 1024 server
  minion:
    master: salt.example.com
    append_domain: webs.example.com
    grains:
      role: webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The image must be selected from available images. Similarly, sizes must be
selected from the list of sizes. To get a list of available images and sizes
use the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images openstack
salt\-cloud \-\-list\-sizes openstack
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Some parameters can be specified in the main Salt cloud configuration file and
then are applied to all cloud profiles. For instance if only a single cloud
provider is being used then the provider option can be declared in the Salt
cloud configuration file.
.SS Multiple Configuration Files
.sp
In addition to \fB/etc/salt/cloud.profiles\fP, profiles can also be specified in
any file matching \fBcloud.profiles.d/*conf\fP which is a sub\-directory relative
to the profiles configuration file(with the above configuration file as an
example, \fB/etc/salt/cloud.profiles.d/*.conf\fP).  This allows for more
extensible configuration, and plays nicely with various configuration
management tools as well as version control systems.
.SS Larger Example
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rhel_ec2:
  provider: my\-ec2\-config
  image: ami\-e565ba8c
  size: t1.micro
  minion:
    cheese: edam

ubuntu_ec2:
  provider: my\-ec2\-config
  image: ami\-7e2da54e
  size: t1.micro
  minion:
    cheese: edam

ubuntu_rackspace:
  provider: my\-rackspace\-config
  image: Ubuntu 12.04 LTS
  size: 256 server
  minion:
    cheese: edam

fedora_rackspace:
  provider: my\-rackspace\-config
  image: Fedora 17
  size: 256 server
  minion:
    cheese: edam

cent_linode:
  provider: my\-linode\-config
  image: CentOS 6.2 64bit
  size: Linode 512

cent_gogrid:
  provider: my\-gogrid\-config
  image: 12834
  size: 512MB

cent_joyent:
  provider: my\-joyent\-config
  image: centos\-7
  size: g4\-highram\-16G
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Cloud Map File
.sp
A number of options exist when creating virtual machines. They can be managed
directly from profiles and the command line execution, or a more complex map
file can be created. The map file allows for a number of virtual machines to
be created and associated with specific profiles. The map file is designed to
be run once to create these more complex scenarios using salt\-cloud.
.sp
Map files have a simple format, specify a profile and then a list of virtual
machines to make from said profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fedora_small:
  \- web1
  \- web2
  \- web3
fedora_high:
  \- redis1
  \- redis2
  \- redis3
cent_high:
  \- riak1
  \- riak2
  \- riak3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This map file can then be called to roll out all of these virtual machines. Map
files are called from the salt\-cloud command with the \-m option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-m /path/to/mapfile
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Remember, that as with direct profile provisioning the \-P option can be passed
to create the virtual machines in parallel:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-m /path/to/mapfile \-P
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Due to limitations in the GoGrid API, instances cannot be provisioned in parallel
with the GoGrid driver. Map files will work with GoGrid, but the \fB\-P\fP
argument should not be used on maps referencing GoGrid instances.
.UNINDENT
.UNINDENT
.sp
A map file can also be enforced to represent the total state of a cloud
deployment by using the \fB\-\-hard\fP option. When using the hard option any vms
that exist but are not specified in the map file will be destroyed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-m /path/to/mapfile \-P \-H
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Be careful with this argument, it is very dangerous! In fact, it is so
dangerous that in order to use it, you must explicitly enable it in the main
configuration file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
enable_hard_maps: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A map file can include grains and minion configuration options:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fedora_small:
  \- web1:
      minion:
        log_level: debug
      grains:
        cheese: tasty
        omelet: du fromage
  \- web2:
      minion:
        log_level: warn
      grains:
        cheese: more tasty
        omelet: with peppers
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Any top level data element from your profile may be overridden in the map file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fedora_small:
  \- web1:
      size: t2.micro
  \- web2:
      size: t2.nano
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As of Salt 2017.7.0, nested elements are merged, and can can be specified
individually without having to repeat the complete definition for each top
level data element. In this example a separate MAC is assigned to each VMware
instance while inheriting device parameters for for disk and network
configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nyc\-vm:
  \- db1:
      devices:
        network:
          Network Adapter 1:
            mac: \(aq44:44:44:44:44:41\(aq
  \- db2:
      devices:
        network:
          Network Adapter 1:
            mac: \(aq44:44:44:44:44:42\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A map file may also be used with the various query options:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-m /path/to/mapfile \-Q
{\(aqec2\(aq: {\(aqweb1\(aq: {\(aqid\(aq: \(aqi\-e6aqfegb\(aq,
                     \(aqimage\(aq: None,
                     \(aqprivate_ips\(aq: [],
                     \(aqpublic_ips\(aq: [],
                     \(aqsize\(aq: None,
                     \(aqstate\(aq: 0}},
         \(aqweb2\(aq: {\(aqAbsent\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\&...or with the delete option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-m /path/to/mapfile \-d
The following virtual machines are set to be destroyed:
  web1
  web2

Proceed? [N/y]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Specifying Nodes with Maps on the Command Line
Specifying the name of a node or nodes with the maps options on the command
line is \fInot\fP supported. This is especially important to remember when
using \fB\-\-destroy\fP with maps; \fBsalt\-cloud\fP will ignore any arguments
passed in which are not directly relevant to the map file. \fIWhen using
\(ga\(ga\-\-destroy\(ga\(ga with a map, every node in the map file will be deleted!\fP
Maps don\(aqt provide any useful information for destroying individual nodes,
and should not be used to destroy a subset of a map.
.UNINDENT
.UNINDENT
.SS Requiring Other Instances
.sp
The \fBrequires\fP directive can be used in map files to ensure that one instance
is created and available before another is created.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fedora_high:
  \- db1:
      size: m5.xlarge
  \- web1:
      size: m5.large
      requires:
        \- db1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This requisite is passed to the instance definition dicitonary in a map file
and accepts a list of instance names as defined in the map.
.SS Setting up New Salt Masters
.sp
Bootstrapping a new master in the map is as simple as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fedora_small:
  \- web1:
      make_master: True
  \- web2
  \- web3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Notice that \fBALL\fP bootstrapped minions from the map will answer to the newly
created salt\-master.
.sp
To make any of the bootstrapped minions answer to the bootstrapping salt\-master
as opposed to the newly created salt\-master, as an example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fedora_small:
  \- web1:
      make_master: True
      minion:
        master: <the local master ip address>
        local_master: True
  \- web2
  \- web3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above says the minion running on the newly created salt\-master responds to
the local master, ie, the master used to bootstrap these VMs.
.sp
Another example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fedora_small:
  \- web1:
      make_master: True
  \- web2
  \- web3:
      minion:
        master: <the local master ip address>
        local_master: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above example makes the \fBweb3\fP minion answer to the local master, not the
newly created master.
.SS Using Direct Map Data
.sp
When using modules that access the \fBCloudClient\fP directly (notably, the
\fBcloud\fP execution and runner modules), it is possible to pass in the contents
of a map file, rather than a path to the location of the map file.
.sp
Normally when using these modules, the path to the map file is passed in using:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cloud.map_run /path/to/cloud.map
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To pass in the actual map data, use the \fBmap_data\fP argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cloud.map_run map_data=\(aq{\(dqcentos7\(dq: [{\(dqsaltmaster\(dq: {\(dqminion\(dq: \e
    {\(dqtransport\(dq: \(dqtcp\(dq}, \(dqmake_master\(dq: true, \(dqmaster\(dq: {\(dqtransport\(dq: \e
    \(dqtcp\(dq}}}, {\(dqminion001\(dq: {\(dqminion\(dq: {\(dqtransport\(dq: \(dqtcp\(dq}}}]}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Cloud Actions
.sp
Once a VM has been created, there are a number of actions that can be performed
on it. The \(dqreboot\(dq action can be used across all providers, but all other
actions are specific to the cloud provider. In order to perform an action, you
may specify it from the command line, including the name(s) of the VM to
perform the action on:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-a reboot vm_name
$ salt\-cloud \-a reboot vm1 vm2 vm2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or you may specify a map which includes all VMs to perform the action on:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-a reboot \-m /path/to/mapfile
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following is an example list of actions currently supported by \fBsalt\-cloud\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
all providers:
    \- reboot
ec2:
    \- start
    \- stop
joyent:
    \- stop
linode:
    \- start
    \- stop
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Another useful reference for viewing more \fBsalt\-cloud\fP actions is the
\fI\%Salt Cloud Feature Matrix\fP\&.
.SS Cloud Functions
.sp
Cloud functions work much the same way as cloud actions, except that they don\(aqt
perform an operation on a specific instance, and so do not need a machine name
to be specified. However, since they perform an operation on a specific cloud
provider, that provider must be specified.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-f show_image ec2 image=ami\-fd20ad94
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There are three universal salt\-cloud functions that are extremely useful for
gathering information about instances on a provider basis:
.INDENT 0.0
.IP \(bu 2
\fBlist_nodes\fP: Returns some general information about the instances for the given provider.
.IP \(bu 2
\fBlist_nodes_full\fP: Returns all information about the instances for the given provider.
.IP \(bu 2
\fBlist_nodes_select\fP: Returns select information about the instances for the given provider.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-f list_nodes linode
$ salt\-cloud \-f list_nodes_full linode
$ salt\-cloud \-f list_nodes_select linode
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Another useful reference for viewing \fBsalt\-cloud\fP functions is the
\fI\%Salt Cloud Feature Matrix\fP\&.
.SS Core Configuration
.SS Install Salt Cloud
.sp
Salt Cloud is now part of Salt proper.  It was merged in as of
\fI\%Salt version 2014.1.0\fP\&.
.sp
On Ubuntu, install Salt Cloud by using following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo add\-apt\-repository ppa:saltstack/salt
sudo apt\-get update
sudo apt\-get install salt\-cloud
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If using Salt Cloud on macOS, \fBcurl\-ca\-bundle\fP must be installed. Presently,
this package is not available via \fBbrew\fP, but it is available using MacPorts:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo port install curl\-ca\-bundle
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt Cloud depends on \fBapache\-libcloud\fP\&.  Libcloud can be installed via pip
with \fBpip install apache\-libcloud\fP\&.
.SS Installing Salt Cloud for development
.sp
Installing Salt for development enables Salt Cloud development as well, just
make sure \fBapache\-libcloud\fP is installed as per above paragraph.
.sp
See these instructions: \fI\%Installing Salt for development\fP\&.
.SS Core Configuration
.sp
A number of core configuration options and some options that are global to the
VM profiles can be set in the cloud configuration file. By default this file is
located at \fB/etc/salt/cloud\fP\&.
.SS Thread Pool Size
.sp
When salt cloud is operating in parallel mode via the \fB\-P\fP argument, you can
control the thread pool size by specifying the \fBpool_size\fP parameter with
a positive integer value.
.sp
By default, the thread pool size will be set to the number of VMs that salt
cloud is operating on.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pool_size: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Minion Configuration
.sp
The default minion configuration is set up in this file. Minions created by
salt\-cloud derive their configuration from this file. Almost all parameters
found in \fI\%Configuring the Salt Minion\fP can be
used here.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minion:
  master: saltmaster.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In particular, this is the location to specify the location of the salt master
and its listening port, if the port is not set to the default.
.sp
Similar to most other settings, Minion configuration settings are inherited
across configuration files. For example, the master setting might be contained
in the main \fBcloud\fP configuration file as demonstrated above, but additional
settings can be placed in the provider, profile or map configuration files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ec2\-web:
  size: t1.micro
  minion:
    environment: test
    startup_states: sls
    sls_list:
      \- web
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When salt cloud creates a new minion, it can automatically add grain information
to the minion configuration file identifying the sources originally used
to define it.
.sp
The generated grain information will appear similar to:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grains:
  salt\-cloud:
    driver: ec2
    provider: my_ec2:ec2
    profile: ec2\-web
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The generation of the salt\-cloud grain can be suppressed by the
option \fBenable_cloud_grains: \(aqFalse\(aq\fP in the cloud configuration file.
.SS Cloud Configuration Syntax
.sp
The data specific to interacting with public clouds is set up \fI\%here\fP\&.
.sp
Cloud provider configuration settings can live in several places. The first is in
\fB/etc/salt/cloud\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/cloud
providers:
  my\-aws\-migrated\-config:
    id: HJGRYCILJLKJYG
    key: \(aqkdjgfsgm;woormgl/aserigjksjdhasdfgn\(aq
    keyname: test
    securitygroup: quick\-start
    private_key: /root/test.pem
    driver: ec2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Cloud provider configuration data can also be housed in \fB/etc/salt/cloud.providers\fP
or any file matching \fB/etc/salt/cloud.providers.d/*.conf\fP\&. All files in any of these
locations will be parsed for cloud provider data.
.sp
Using the example configuration above:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/cloud.providers
# or could be /etc/salt/cloud.providers.d/*.conf
my\-aws\-config:
  id: HJGRYCILJLKJYG
  key: \(aqkdjgfsgm;woormgl/aserigjksjdhasdfgn\(aq
  keyname: test
  securitygroup: quick\-start
  private_key: /root/test.pem
  driver: ec2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Salt Cloud provider configurations within \fB/etc/cloud.provider.d/\fP should not
specify the \fBproviders\fP starting key.
.UNINDENT
.UNINDENT
.sp
It is also possible to have multiple cloud configuration blocks within the same alias block.
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
production\-config:
  \- id: HJGRYCILJLKJYG
    key: \(aqkdjgfsgm;woormgl/aserigjksjdhasdfgn\(aq
    keyname: test
    securitygroup: quick\-start
    private_key: /root/test.pem
    driver: ec2

  \- user: example_user
    apikey: 123984bjjas87034
    driver: rackspace
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, using this configuration method requires a change with profile configuration blocks.
The provider alias needs to have the provider key value appended as in the following example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rhel_aws_dev:
  provider: production\-config:ec2
  image: ami\-e565ba8c
  size: t1.micro

rhel_aws_prod:
  provider: production\-config:ec2
  image: ami\-e565ba8c
  size: High\-CPU Extra Large Instance

database_prod:
  provider: production\-config:rackspace
  image: Ubuntu 12.04 LTS
  size: 256 server
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Notice that because of the multiple entries, one has to be explicit about the provider alias and
name, from the above example, \fBproduction\-config: ec2\fP\&.
.sp
This data interactions with the \fBsalt\-cloud\fP binary regarding its \fB\-\-list\-location\fP,
\fB\-\-list\-images\fP, and \fB\-\-list\-sizes\fP which needs a cloud provider as an argument. The argument
used should be the configured cloud provider alias. If the provider alias has multiple entries,
\fB<provider\-alias>: <provider\-name>\fP should be used.
.sp
To allow for a more extensible configuration, \fB\-\-providers\-config\fP, which defaults to
\fB/etc/salt/cloud.providers\fP, was added to the cli parser.  It allows for the providers\(aq
configuration to be added on a per\-file basis.
.SS Pillar Configuration
.sp
It is possible to configure cloud providers using pillars. This is only used when inside the cloud
module. You can setup a variable called \fBcloud\fP that contains your profile, provider, and map to
pass that information to the cloud servers instead of having to copy the full configuration to every
minion. In your pillar file, you would use something like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cloud:
  ssh_key_name: saltstack
  ssh_key_file: /root/.ssh/id_rsa
  update_cachedir: True
  diff_cache_events: True

  providers:
    my\-openstack:
      driver: openstack
      region_name: ORD
      cloud: mycloud

  profiles:
    ubuntu\-openstack:
      provider: my\-openstack
      size: ds512M
      image: CentOS 7
      script_args: git develop

  maps:
    my\-dev\-map:
      ubuntu\-openstack:
        \- dev\-test01
        \- dev\-test02
        \- dev\-test03
        \- dev\-test04
    my\-prd\-map:
      ubuntu\-openstack:
        \- prd\-web01
        \- prd\-web02
            minion:
              id: custom\-minion\-id\-app1\-stack1\-frontend
            grains:
              roles:
                \- webserver
              deployment: datacenter4\-openstack
        \- prod\-db01
        \- prod\-db02
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Cloud Configurations
.SS Scaleway
.sp
To use Salt Cloud with Scaleway, you need to get an \fBaccess key\fP and an \fBAPI token\fP\&. \fBAPI tokens\fP are unique identifiers associated with your Scaleway account.
To retrieve your \fBaccess key\fP and \fBAPI token\fP, log\-in to the Scaleway control panel, open the pull\-down menu on your account name and click on \(dqMy Credentials\(dq link.
.sp
If you do not have \fBAPI token\fP you can create one by clicking the \(dqCreate New Token\(dq button on the right corner.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-scaleway\-config:
  access_key: 15cf404d\-4560\-41b1\-9a0c\-21c3d5c4ff1f
  token: a7347ec8\-5de1\-4024\-a5e3\-24b77d1ba91d
  driver: scaleway
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In the cloud profile that uses this provider configuration, the syntax for the
\fBprovider\fP required field would be \fBprovider: my\-scaleway\-config\fP\&.
.UNINDENT
.UNINDENT
.SS Rackspace
.sp
Rackspace cloud requires two configuration options; a \fBuser\fP and an \fBapikey\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-rackspace\-config:
  user: example_user
  apikey: 123984bjjas87034
  driver: rackspace
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In the cloud profile that uses this provider configuration, the syntax for the
\fBprovider\fP required field would be \fBprovider: my\-rackspace\-config\fP\&.
.UNINDENT
.UNINDENT
.SS Amazon AWS
.sp
A number of configuration options are required for Amazon AWS including \fBid\fP,
\fBkey\fP, \fBkeyname\fP, \fBsecuritygroup\fP, and \fBprivate_key\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-aws\-quick\-start:
  id: HJGRYCILJLKJYG
  key: \(aqkdjgfsgm;woormgl/aserigjksjdhasdfgn\(aq
  keyname: test
  securitygroup: quick\-start
  private_key: /root/test.pem
  driver: ec2

my\-aws\-default:
  id: HJGRYCILJLKJYG
  key: \(aqkdjgfsgm;woormgl/aserigjksjdhasdfgn\(aq
  keyname: test
  securitygroup: default
  private_key: /root/test.pem
  driver: ec2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In the cloud profile that uses this provider configuration, the syntax for the
\fBprovider\fP required field would be either \fBprovider: my\-aws\-quick\-start\fP
or \fBprovider: my\-aws\-default\fP\&.
.UNINDENT
.UNINDENT
.SS Linode
.sp
Linode requires a single API key, but the default root password also needs to
be set:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-linode\-config:
  apikey: asldkgfaklsdfjsjaslfjaklsdjf;askldjfaaklsjdfhasldsadfghdkf
  password: F00barbazlonglongp@ssword
  ssh_pubkey: ssh\-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKHEOLLbeXgaqRQT9NBAopVz366SdYc0KKX33vAnq+2R user@host
  ssh_key_file: ~/.ssh/id_ed25519
  driver: linode
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The password needs to be 8 characters and contain lowercase, uppercase, and
numbers.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In the cloud profile that uses this provider configuration, the syntax for the
\fBprovider\fP required field would be \fBprovider: my\-linode\-config\fP
.UNINDENT
.UNINDENT
.SS Joyent Cloud
.sp
The Joyent cloud requires three configuration parameters: The username and
password that are used to log into the Joyent system, as well as the location
of the private SSH key associated with the Joyent account. The SSH key is needed
to send the provisioning commands up to the freshly created virtual machine.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-joyent\-config:
  user: fred
  password: saltybacon
  private_key: /root/joyent.pem
  driver: joyent
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In the cloud profile that uses this provider configuration, the syntax for the
\fBprovider\fP required field would be \fBprovider: my\-joyent\-config\fP
.UNINDENT
.UNINDENT
.SS GoGrid
.sp
To use Salt Cloud with GoGrid, log into the GoGrid web interface and create an
API key. Do this by clicking on \(dqMy Account\(dq and then going to the API Keys
tab.
.sp
The \fBapikey\fP and the \fBsharedsecret\fP configuration parameters need to
be set in the configuration file to enable interfacing with GoGrid:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-gogrid\-config:
  apikey: asdff7896asdh789
  sharedsecret: saltybacon
  driver: gogrid
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In the cloud profile that uses this provider configuration, the syntax for the
\fBprovider\fP required field would be \fBprovider: my\-gogrid\-config\fP\&.
.UNINDENT
.UNINDENT
.SS OpenStack
.sp
Using Salt for OpenStack uses the \fIshade <https://docs.openstack.org/shade/latest/>\fP driver managed by the
openstack\-infra team.
.sp
This driver can be configured using the \fB/etc/openstack/clouds.yml\fP file with
\fIos\-client\-config <https://docs.openstack.org/os\-client\-config/latest/>\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myopenstack:
  driver: openstack
  region_name: RegionOne
  cloud: mycloud
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or by just configuring the same auth block directly in the cloud provider config.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myopenstack:
  driver: openstack
  region_name: RegionOne
  auth:
    username: \(aqdemo\(aq
    password: secret
    project_name: \(aqdemo\(aq
    auth_url: \(aqhttp://openstack/identity\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Both of these methods support using the
\fIvendor <https://docs.openstack.org/os\-client\-config/latest/user/vendor\-support.html>\fP
options.
.sp
For more information, look at \fI\%Openstack Cloud Driver Docs\fP
.SS DigitalOcean
.sp
Using Salt for DigitalOcean requires a \fBclient_key\fP and an \fBapi_key\fP\&. These
can be found in the DigitalOcean web interface, in the \(dqMy Settings\(dq section,
under the API Access tab.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-digitalocean\-config:
  driver: digitalocean
  personal_access_token: xxx
  location: New York 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In the cloud profile that uses this provider configuration, the syntax for the
\fBprovider\fP required field would be \fBprovider: my\-digital\-ocean\-config\fP\&.
.UNINDENT
.UNINDENT
.SS Parallels
.sp
Using Salt with Parallels requires a \fBuser\fP, \fBpassword\fP and \fBURL\fP\&. These
can be obtained from your cloud provider.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-parallels\-config:
  user: myuser
  password: xyzzy
  url: https://api.cloud.xmission.com:4465/paci/v1.0/
  driver: parallels
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In the cloud profile that uses this provider configuration, the syntax for the
\fBprovider\fP required field would be \fBprovider: my\-parallels\-config\fP\&.
.UNINDENT
.UNINDENT
.SS Proxmox
.sp
Using Salt with Proxmox requires a \fBuser\fP, \fBpassword\fP, and \fBURL\fP\&. These can be
obtained from your cloud host. Both PAM and PVE users can be used.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-proxmox\-config:
  driver: proxmox
  user: saltcloud@pve
  password: xyzzy
  url: your.proxmox.host
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In the cloud profile that uses this provider configuration, the syntax for the
\fBprovider\fP required field would be \fBprovider: my\-proxmox\-config\fP\&.
.UNINDENT
.UNINDENT
.SS LXC
.sp
The lxc driver uses saltify to install salt and attach the lxc container as a new lxc
minion. As soon as we can, we manage baremetal operation over SSH. You can also destroy
those containers via this driver.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
devhost10\-lxc:
  target: devhost10
  driver: lxc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And in the map file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
devhost10\-lxc:
  provider: devhost10\-lxc
  from_container: ubuntu
  backing: lvm
  sudo: True
  size: 3g
  ip: 10.0.3.9
  minion:
    master: 10.5.0.1
    master_port: 4506
  lxc_conf:
    \- lxc.utsname: superlxc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In the cloud profile that uses this provider configuration, the syntax for the
\fBprovider\fP required field would be \fBprovider: devhost10\-lxc\fP\&.
.UNINDENT
.UNINDENT
.SS Saltify
.sp
The Saltify driver is a new, experimental driver designed to install Salt on a remote
machine, virtual or bare metal, using SSH. This driver is useful for provisioning
machines which are already installed, but not Salted. For more information about using
this driver and for configuration examples, please see the
\fI\%Getting Started with Saltify\fP documentation.
.SS Vagrant
.sp
The Vagrant driver is a new, experimental driver for controlling a VagrantBox
virtual machine, and installing Salt on it. The target host machine must be a
working salt minion, which is controlled via the salt master using salt\-api.
For more information, see
\fI\%Getting Started With Vagrant\fP\&.
.SS Extending Profiles and Cloud Providers Configuration
.sp
As of 0.8.7, the option to extend both the profiles and cloud providers
configuration and avoid duplication was added. The extends feature works on the
current profiles configuration, but, regarding the cloud providers
configuration, \fBonly\fP works in the new syntax and respective configuration
files, i.e. \fB/etc/salt/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/*.conf\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Extending cloud profiles and providers is not recursive. For example, a
profile that is extended by a second profile is possible, but the second
profile cannot be extended by a third profile.
.sp
Also, if a profile (or provider) is extending another profile and each
contains a list of values, the lists from the extending profile will
override the list from the original profile. The lists are not merged
together.
.UNINDENT
.UNINDENT
.SS Extending Profiles
.sp
Some example usage on how to use \fBextends\fP with profiles. Consider
\fB/etc/salt/salt/cloud.profiles\fP containing:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
development\-instances:
  provider: my\-ec2\-config
  size: t1.micro
  ssh_username: ec2_user
  securitygroup:
    \- default
  deploy: False

Amazon\-Linux\-AMI\-2012.09\-64bit:
  image: ami\-54cf5c3d
  extends: development\-instances

Fedora\-17:
  image: ami\-08d97e61
  extends: development\-instances

CentOS\-5:
  provider: my\-aws\-config
  image: ami\-09b61d60
  extends: development\-instances
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above configuration, once parsed would generate the following profiles
data:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[
    {
        \(dqdeploy\(dq: False,
        \(dqimage\(dq: \(dqami\-08d97e61\(dq,
        \(dqprofile\(dq: \(dqFedora\-17\(dq,
        \(dqprovider\(dq: \(dqmy\-ec2\-config\(dq,
        \(dqsecuritygroup\(dq: [\(dqdefault\(dq],
        \(dqsize\(dq: \(dqt1.micro\(dq,
        \(dqssh_username\(dq: \(dqec2_user\(dq,
    },
    {
        \(dqdeploy\(dq: False,
        \(dqimage\(dq: \(dqami\-09b61d60\(dq,
        \(dqprofile\(dq: \(dqCentOS\-5\(dq,
        \(dqprovider\(dq: \(dqmy\-aws\-config\(dq,
        \(dqsecuritygroup\(dq: [\(dqdefault\(dq],
        \(dqsize\(dq: \(dqt1.micro\(dq,
        \(dqssh_username\(dq: \(dqec2_user\(dq,
    },
    {
        \(dqdeploy\(dq: False,
        \(dqimage\(dq: \(dqami\-54cf5c3d\(dq,
        \(dqprofile\(dq: \(dqAmazon\-Linux\-AMI\-2012.09\-64bit\(dq,
        \(dqprovider\(dq: \(dqmy\-ec2\-config\(dq,
        \(dqsecuritygroup\(dq: [\(dqdefault\(dq],
        \(dqsize\(dq: \(dqt1.micro\(dq,
        \(dqssh_username\(dq: \(dqec2_user\(dq,
    },
    {
        \(dqdeploy\(dq: False,
        \(dqprofile\(dq: \(dqdevelopment\-instances\(dq,
        \(dqprovider\(dq: \(dqmy\-ec2\-config\(dq,
        \(dqsecuritygroup\(dq: [\(dqdefault\(dq],
        \(dqsize\(dq: \(dqt1.micro\(dq,
        \(dqssh_username\(dq: \(dqec2_user\(dq,
    },
]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pretty cool right?
.SS Extending Providers
.sp
Some example usage on how to use \fBextends\fP within the cloud providers
configuration.  Consider \fB/etc/salt/salt/cloud.providers\fP containing:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-develop\-envs:
  \- id: HJGRYCILJLKJYG
    key: \(aqkdjgfsgm;woormgl/aserigjksjdhasdfgn\(aq
    keyname: test
    securitygroup: quick\-start
    private_key: /root/test.pem
    location: ap\-southeast\-1
    availability_zone: ap\-southeast\-1b
    driver: ec2

  \- user: myuser@mycorp.com
    password: mypass
    ssh_key_name: mykey
    ssh_key_file: \(aq/etc/salt/ibm/mykey.pem\(aq
    location: Raleigh
    driver: ibmsce


my\-productions\-envs:
  \- extends: my\-develop\-envs:ibmsce
    user: my\-production\-user@mycorp.com
    location: us\-east\-1
    availability_zone: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above configuration, once parsed would generate the following providers
data:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqproviders\(dq: {
        \(dqmy\-develop\-envs\(dq: [
            {
                \(dqavailability_zone\(dq: \(dqap\-southeast\-1b\(dq,
                \(dqid\(dq: \(dqHJGRYCILJLKJYG\(dq,
                \(dqkey\(dq: \(dqkdjgfsgm;woormgl/aserigjksjdhasdfgn\(dq,
                \(dqkeyname\(dq: \(dqtest\(dq,
                \(dqlocation\(dq: \(dqap\-southeast\-1\(dq,
                \(dqprivate_key\(dq: \(dq/root/test.pem\(dq,
                \(dqdriver\(dq: \(dqaws\(dq,
                \(dqsecuritygroup\(dq: \(dqquick\-start\(dq,
            },
            {
                \(dqlocation\(dq: \(dqRaleigh\(dq,
                \(dqpassword\(dq: \(dqmypass\(dq,
                \(dqdriver\(dq: \(dqibmsce\(dq,
                \(dqssh_key_file\(dq: \(dq/etc/salt/ibm/mykey.pem\(dq,
                \(dqssh_key_name\(dq: \(dqmykey\(dq,
                \(dquser\(dq: \(dqmyuser@mycorp.com\(dq,
            },
        ],
        \(dqmy\-productions\-envs\(dq: [
            {
                \(dqavailability_zone\(dq: \(dqus\-east\-1\(dq,
                \(dqlocation\(dq: \(dqus\-east\-1\(dq,
                \(dqpassword\(dq: \(dqmypass\(dq,
                \(dqdriver\(dq: \(dqibmsce\(dq,
                \(dqssh_key_file\(dq: \(dq/etc/salt/ibm/mykey.pem\(dq,
                \(dqssh_key_name\(dq: \(dqmykey\(dq,
                \(dquser\(dq: \(dqmy\-production\-user@mycorp.com\(dq,
            }
        ],
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Windows Configuration
.SS Spinning up Windows Minions
.sp
It is possible to use Salt Cloud to spin up Windows instances, and then install
Salt on them. This functionality is available on all cloud providers that are
supported by Salt Cloud. However, it may not necessarily be available on all
Windows images.
.SS Dependencies
.sp
Salt Cloud needs the following packages:
.INDENT 0.0
.IP \(bu 2
\fI\%pypsexec\fP\&.
.IP \(bu 2
\fI\%smbprotocol\fP\&.
.UNINDENT
.sp
For versions of Salt prior to 3006, Salt Cloud has a dependency on the
\fBimpacket\fP library to set up the Windows Salt Minion installer:
.INDENT 0.0
.IP \(bu 2
\fI\%impacket\fP\&.
.UNINDENT
.SS Requirements
.sp
A copy of the Salt Minion Windows installer must be present on the system on
which Salt Cloud is running. See
\fI\%Windows \- Salt install guide\fP for information about downloading
and using the Salt Minion Windows installer.
.SS Self Signed Certificates with WinRM
.sp
Salt\-Cloud can use versions of \fBpywinrm<=0.1.1\fP or \fBpywinrm>=0.2.1\fP\&.
.sp
For versions greater than \fI0.2.1\fP, \fBwinrm_verify_ssl\fP needs to be set to
\fIFalse\fP if the certificate is self signed and not verifiable.
.SS Firewall Settings
.sp
Because Salt Cloud makes use of \fIsmbclient\fP and \fIwinexe\fP, port 445 must be open
on the target image. This port is not generally open by default on a standard
Windows distribution, and care must be taken to use an image in which this port
is open, or the Windows firewall is disabled.
.sp
If supported by the cloud provider, a PowerShell script may be used to open up
this port automatically, using the cloud provider\(aqs \fIuserdata\fP\&. The following
script would open up port 445, and apply the changes:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<powershell>
New\-NetFirewallRule \-Name \(dqSMB445\(dq \-DisplayName \(dqSMB445\(dq \-Protocol TCP \-LocalPort 445
Set\-Item (dir wsman:\elocalhost\eListener\e*\ePort \-Recurse).pspath 445 \-Force
Restart\-Service winrm
</powershell>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For EC2, this script may be saved as a file, and specified in the provider or
profile configuration as \fIuserdata_file\fP\&. For instance:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  # Pass userdata to the instance to be created
  userdata_file: /etc/salt/windows\-firewall.ps1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
From versions 2016.11.0 and 2016.11.3, this file was passed through the
master\(aqs \fI\%renderer\fP to template it. However, this caused
issues with non\-YAML data, so templating is no longer performed by default.
To template the userdata_file, add a \fBuserdata_template\fP option to the
cloud profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  # Pass userdata to the instance to be created
  userdata_file: /etc/salt/windows\-firewall.ps1
  userdata_template: jinja
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If no \fBuserdata_template\fP is set in the cloud profile, then the master
configuration will be checked for a \fI\%userdata_template\fP value.
If this is not set, then no templating will be performed on the
userdata_file.
.sp
To disable templating in a cloud profile when a
\fI\%userdata_template\fP has been set in the master configuration
file, simply set \fBuserdata_template\fP to \fBFalse\fP in the cloud profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  # Pass userdata to the instance to be created
  userdata_file: /etc/salt/windows\-firewall.ps1
  userdata_template: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
If you are using WinRM on EC2 the HTTPS port for the WinRM service must also be
enabled in your userdata. By default EC2 Windows images only have insecure HTTP
enabled. To enable HTTPS and basic authentication required by pywinrm consider
the following userdata example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<powershell>
New\-NetFirewallRule \-Name \(dqSMB445\(dq \-DisplayName \(dqSMB445\(dq \-Protocol TCP \-LocalPort 445
New\-NetFirewallRule \-Name \(dqWINRM5986\(dq \-DisplayName \(dqWINRM5986\(dq \-Protocol TCP \-LocalPort 5986

winrm quickconfig \-q
winrm set winrm/config/winrs \(aq@{MaxMemoryPerShellMB=\(dq300\(dq}\(aq
winrm set winrm/config \(aq@{MaxTimeoutms=\(dq1800000\(dq}\(aq
winrm set winrm/config/service/auth \(aq@{Basic=\(dqtrue\(dq}\(aq

$SourceStoreScope = \(aqLocalMachine\(aq
$SourceStorename = \(aqRemote Desktop\(aq

$SourceStore = New\-Object \-TypeName System.Security.Cryptography.X509Certificates.X509Store \-ArgumentList $SourceStorename, $SourceStoreScope
$SourceStore.Open([System.Security.Cryptography.X509Certificates.OpenFlags]::ReadOnly)

$cert = $SourceStore.Certificates | Where\-Object \-FilterScript {
    $_.subject \-like \(aq*\(aq
}

$DestStoreScope = \(aqLocalMachine\(aq
$DestStoreName = \(aqMy\(aq

$DestStore = New\-Object \-TypeName System.Security.Cryptography.X509Certificates.X509Store \-ArgumentList $DestStoreName, $DestStoreScope
$DestStore.Open([System.Security.Cryptography.X509Certificates.OpenFlags]::ReadWrite)
$DestStore.Add($cert)

$SourceStore.Close()
$DestStore.Close()

winrm create winrm/config/listener?Address=*+Transport=HTTPS \(ga@\(ga{CertificateThumbprint=\(ga\(dq($cert.Thumbprint)\(ga\(dq\(ga}

Restart\-Service winrm
</powershell>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
No certificate store is available by default on EC2 images and creating
one does not seem possible without an MMC (cannot be automated). To use the
default EC2 Windows images the above copies the RDP store.
.SS Configuration
.sp
Configuration is set as usual, with some extra configuration settings. The
location of the Windows installer on the machine that Salt Cloud is running on
must be specified. This may be done in any of the regular configuration files
(main, providers, profiles, maps). For example:
.sp
Setting the installer in \fB/etc/salt/cloud.providers\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-softlayer:
  driver: softlayer
  user: MYUSER1138
  apikey: \(aqe3b68aa711e6deadc62d5b76355674beef7cc3116062ddbacafe5f7e465bfdc9\(aq
  minion:
    master: saltmaster.example.com
  win_installer: /root/Salt\-Minion\-2014.7.0\-AMD64\-Setup.exe
  win_username: Administrator
  win_password: letmein
  smb_port: 445
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The default Windows user is \fIAdministrator\fP, and the default Windows password
is blank.
.sp
If WinRM is to be used \fBuse_winrm\fP needs to be set to \fITrue\fP\&. \fBwinrm_port\fP
can be used to specify a custom port (must be HTTPS listener).  And
\fBwinrm_verify_ssl\fP can be set to \fIFalse\fP to use a self signed certificate.
.SS Auto\-Generated Passwords on EC2
.sp
On EC2, when the \fIwin_password\fP is set to \fIauto\fP, Salt Cloud will query EC2 for
an auto\-generated password. This password is expected to take at least 4 minutes
to generate, adding additional time to the deploy process.
.sp
When the EC2 API is queried for the auto\-generated password, it will be returned
in a message encrypted with the specified \fIkeyname\fP\&. This requires that the
appropriate \fIprivate_key\fP file is also specified. Such a profile configuration
might look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
windows\-server\-2012:
  provider: my\-ec2\-config
  image: ami\-c49c0dac
  size: m1.small
  securitygroup: windows
  keyname: mykey
  private_key: /root/mykey.pem
  userdata_file: /etc/salt/windows\-firewall.ps1
  win_installer: /root/Salt\-Minion\-2014.7.0\-AMD64\-Setup.exe
  win_username: Administrator
  win_password: auto
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Cloud Provider Specifics
.SS Getting Started With Aliyun ECS
.sp
The Aliyun ECS (Elastic Computer Service) is one of the most popular public
cloud hosts in China. This cloud host can be used to manage aliyun
instance using salt\-cloud.
.sp
\fI\%http://www.aliyun.com/\fP
.SS Dependencies
.sp
This driver requires the Python \fBrequests\fP library to be installed.
.SS Configuration
.sp
Using Salt for Aliyun ECS requires aliyun access key id and key secret.
These can be found in the aliyun web interface, in the \(dqUser Center\(dq section,
under \(dqMy Service\(dq tab.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example is for /etc/salt/cloud.providers or any file in the
# /etc/salt/cloud.providers.d/ directory.

my\-aliyun\-config:
  # aliyun Access Key ID
  id: wDGEwGregedg3435gDgxd
  # aliyun Access Key Secret
  key: GDd45t43RDBTrkkkg43934t34qT43t4dgegerGEgg
  location: cn\-qingdao
  driver: aliyun
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Profiles
.SS Cloud Profiles
.sp
Set up an initial profile at \fB/etc/salt/cloud.profiles\fP or in the
\fB/etc/salt/cloud.profiles.d/\fP directory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
aliyun_centos:
    provider: my\-aliyun\-config
    size: ecs.t1.small
    location: cn\-qingdao
    securitygroup: G1989096784427999
    image: centos6u3_64_20G_aliaegis_20130816.vhd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Sizes can be obtained using the \fB\-\-list\-sizes\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-sizes my\-aliyun\-config
my\-aliyun\-config:
    \-\-\-\-\-\-\-\-\-\-
    aliyun:
        \-\-\-\-\-\-\-\-\-\-
        ecs.c1.large:
            \-\-\-\-\-\-\-\-\-\-
            CpuCoreCount:
                8
            InstanceTypeId:
                ecs.c1.large
            MemorySize:
                16.0

\&...SNIP...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Images can be obtained using the \fB\-\-list\-images\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-images my\-aliyun\-config
my\-aliyun\-config:
    \-\-\-\-\-\-\-\-\-\-
    aliyun:
        \-\-\-\-\-\-\-\-\-\-
        centos5u8_64_20G_aliaegis_20131231.vhd:
            \-\-\-\-\-\-\-\-\-\-
            Architecture:
                x86_64
            Description:

            ImageId:
                centos5u8_64_20G_aliaegis_20131231.vhd
            ImageName:
                CentOS 5.8 64位
            ImageOwnerAlias:
                system
            ImageVersion:
                1.0
            OSName:
                CentOS  5.8 64位
            Platform:
                CENTOS5
            Size:
                20
            Visibility:
                public
\&...SNIP...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Locations can be obtained using the \fB\-\-list\-locations\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-aliyun\-config:
    \-\-\-\-\-\-\-\-\-\-
    aliyun:
        \-\-\-\-\-\-\-\-\-\-
        cn\-beijing:
            \-\-\-\-\-\-\-\-\-\-
            LocalName:
                北京
            RegionId:
                cn\-beijing
        cn\-hangzhou:
            \-\-\-\-\-\-\-\-\-\-
            LocalName:
                杭州
            RegionId:
                cn\-hangzhou
        cn\-hongkong:
            \-\-\-\-\-\-\-\-\-\-
            LocalName:
                香港
            RegionId:
                cn\-hongkong
        cn\-qingdao:
            \-\-\-\-\-\-\-\-\-\-
            LocalName:
                青岛
            RegionId:
                cn\-qingdao
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Security Group can be obtained using the \fB\-f list_securitygroup\fP option
for the \fBsalt\-cloud\fP command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-location=cn\-qingdao \-f list_securitygroup my\-aliyun\-config
my\-aliyun\-config:
    \-\-\-\-\-\-\-\-\-\-
    aliyun:
        \-\-\-\-\-\-\-\-\-\-
        G1989096784427999:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                G1989096784427999
            SecurityGroupId:
                G1989096784427999
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Aliyun ECS REST API documentation is available from \fI\%Aliyun ECS API\fP\&.
.UNINDENT
.UNINDENT
.SS Getting Started with CloudStack
.sp
CloudStack is one the most popular cloud projects. It\(aqs an open source project
to build public and/or private clouds. You can use Salt Cloud to launch
CloudStack instances.
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
Libcloud >= 0.13.2
.UNINDENT
.SS Configuration
.sp
Using Salt for CloudStack, requires an \fBAPI key\fP and a \fBsecret key\fP along with the API address endpoint information.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example is for /etc/salt/cloud.providers or any file in the
# /etc/salt/cloud.providers.d/ directory.

exoscale:
  driver: cloudstack
  host: api.exoscale.com
  path: /compute
  apikey: EXOAPIKEY
  secretkey: EXOSECRETKEYINYOURACCOUNT
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Profiles
.SS Cloud Profiles
.sp
Set up an initial profile at \fB/etc/salt/cloud.profiles\fP or in the
\fB/etc/salt/cloud.profiles.d/\fP directory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
exoscale\-ubuntu:
  provider: exoscale\-config
  image: Linux Ubuntu 18.04
  size: Small
  location: ch\-gva\-2
  ssh_username: ubuntu
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Locations can be obtained using the \fB\-\-list\-locations\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-locations exoscale\-config
exoscale:
    \-\-\-\-\-\-\-\-\-\-
    cloudstack:
        \-\-\-\-\-\-\-\-\-\-
        ch\-dk\-2:
            \-\-\-\-\-\-\-\-\-\-
            country:
                Unknown
            driver:
            id:
                91e5e9e4\-c9ed\-4b76\-bee4\-427004b3baf9
            name:
                ch\-dk\-2
        ch\-gva\-2:
            \-\-\-\-\-\-\-\-\-\-
            country:
                Unknown
            driver:
            id:
                1128bd56\-b4d9\-4ac6\-a7b9\-c715b187ce11
            name:
                ch\-gva\-2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Sizes can be obtained using the \fB\-\-list\-sizes\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-sizes exoscale
exoscale:
    \-\-\-\-\-\-\-\-\-\-
    cloudstack:
        \-\-\-\-\-\-\-\-\-\-
        Extra\-large:
            \-\-\-\-\-\-\-\-\-\-
            bandwidth:
                0
            disk:
                0
            driver:
            extra:
                \-\-\-\-\-\-\-\-\-\-
                cpu:
                    4
            get_uuid:
            id:
                350dc5ea\-fe6d\-42ba\-b6c0\-efb8b75617ad
            name:
                Extra\-large
            price:
                0
            ram:
                16384
            uuid:
                edb4cd4ae14bbf152d451b30c4b417ab095a5bfe
\&...SNIP...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Images can be obtained using the \fB\-\-list\-images\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-images exoscale
exoscale:
    \-\-\-\-\-\-\-\-\-\-
    cloudstack:
        \-\-\-\-\-\-\-\-\-\-
        Linux CentOS 6.6 64\-bit:
            \-\-\-\-\-\-\-\-\-\-
            driver:
            extra:
                \-\-\-\-\-\-\-\-\-\-
                displaytext:
                    Linux CentOS 6.6 64\-bit 10G Disk (2014\-12\-01\-bac8e0)
                format:
                    QCOW2
                hypervisor:
                    KVM
                os:
                    Other PV (64\-bit)
                size:
                    10737418240
            get_uuid:
            id:
                aa69ae64\-1ea9\-40af\-8824\-c2c3344e8d7c
            name:
                Linux CentOS 6.6 64\-bit
            uuid:
                f26b4f54ec8591abdb6b5feb3b58f720aa438fee
\&...SNIP...
.ft P
.fi
.UNINDENT
.UNINDENT
.SS CloudStack specific settings
.SS securitygroup
.sp
New in version 2017.7.0.

.sp
You can specify a list of security groups (by name or id) that should be
assigned to the VM:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
exoscale:
  provider: cloudstack
  securitygroup:
    \- default
    \- salt\-master
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Getting Started With DigitalOcean
.sp
DigitalOcean is a public cloud host that specializes in Linux instances.
.SS Configuration
.sp
Using Salt for DigitalOcean requires a \fBpersonal_access_token\fP, an \fBssh_key_file\fP,
and at least one SSH key name in \fBssh_key_names\fP\&. More \fBssh_key_names\fP can be added
by separating each key with a comma. The \fBpersonal_access_token\fP can be found in the
DigitalOcean web interface in the \(dqApps & API\(dq section. The SSH key name can be found
under the \(dqSSH Keys\(dq section.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example is for /etc/salt/cloud.providers or any file in the
# /etc/salt/cloud.providers.d/ directory.

my\-digitalocean\-config:
  driver: digitalocean
  personal_access_token: xxx
  ssh_key_file: /path/to/ssh/key/file
  ssh_key_names: my\-key\-name,my\-key\-name\-2
  location: New York 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Profiles
.SS Cloud Profiles
.sp
Set up an initial profile at \fB/etc/salt/cloud.profiles\fP or in the
\fB/etc/salt/cloud.profiles.d/\fP directory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
digitalocean\-ubuntu:
  provider: my\-digitalocean\-config
  image: 14.04 x64
  size: 512MB
  location: New York 1
  vpc_name: Optional
  backups_enabled: True
  ipv6: True
  create_dns_record: True
  userdata_file: /etc/salt/cloud.userdata.d/setup
  tags:
    \- tag1
    \- tag2
    \- tag3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Locations can be obtained using the \fB\-\-list\-locations\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-locations my\-digitalocean\-config
my\-digitalocean\-config:
    \-\-\-\-\-\-\-\-\-\-
    digitalocean:
        \-\-\-\-\-\-\-\-\-\-
        Amsterdam 1:
            \-\-\-\-\-\-\-\-\-\-
            available:
                False
            features:
                [u\(aqbackups\(aq]
            name:
                Amsterdam 1
            sizes:
                []
            slug:
                ams1
\&...SNIP...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Sizes can be obtained using the \fB\-\-list\-sizes\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-sizes my\-digitalocean\-config
my\-digitalocean\-config:
    \-\-\-\-\-\-\-\-\-\-
    digitalocean:
        \-\-\-\-\-\-\-\-\-\-
        512MB:
            \-\-\-\-\-\-\-\-\-\-
            cost_per_hour:
                0.00744
            cost_per_month:
                5.0
            cpu:
                1
            disk:
                20
            id:
                66
            memory:
                512
            name:
                512MB
            slug:
                None
\&...SNIP...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Images can be obtained using the \fB\-\-list\-images\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-images my\-digitalocean\-config
my\-digitalocean\-config:
    \-\-\-\-\-\-\-\-\-\-
    digitalocean:
        \-\-\-\-\-\-\-\-\-\-
        10.1:
            \-\-\-\-\-\-\-\-\-\-
            created_at:
                2015\-01\-20T20:04:34Z
            distribution:
                FreeBSD
            id:
                10144573
            min_disk_size:
                20
            name:
                10.1
            public:
                True
\&...SNIP...
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Profile Specifics:
.SS ssh_username
.sp
If using a FreeBSD image from DigitalOcean, you\(aqll need to set the \fBssh_username\fP
setting to \fBfreebsd\fP in your profile configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
digitalocean\-freebsd:
  provider: my\-digitalocean\-config
  image: 10.2
  size: 512MB
  ssh_username: freebsd
.ft P
.fi
.UNINDENT
.UNINDENT
.SS userdata_file
.sp
New in version 2016.11.6.

.sp
Use \fIuserdata_file\fP to specify the userdata file to upload for use with
cloud\-init if available.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-openstack\-config:
  # Pass userdata to the instance to be created
  userdata_file: /etc/salt/cloud\-init/packages.yml
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-do\-config:
  # Pass userdata to the instance to be created
  userdata_file: /etc/salt/cloud\-init/packages.yml
  userdata_template: jinja
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If no \fBuserdata_template\fP is set in the cloud profile, then the master
configuration will be checked for a \fI\%userdata_template\fP value.
If this is not set, then no templating will be performed on the
userdata_file.
.sp
To disable templating in a cloud profile when a
\fI\%userdata_template\fP has been set in the master configuration
file, simply set \fBuserdata_template\fP to \fBFalse\fP in the cloud profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-do\-config:
  # Pass userdata to the instance to be created
  userdata_file: /etc/salt/cloud\-init/packages.yml
  userdata_template: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Miscellaneous Information
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
DigitalOcean\(aqs concept of \fBApplications\fP is nothing more than a
pre\-configured instance (same as a normal Droplet). You will find examples
such \fBDocker 0.7 Ubuntu 13.04 x64\fP and \fBWordpress on Ubuntu 12.10\fP
when using the \fB\-\-list\-images\fP option. These names can be used just like
the rest of the standard instances when specifying an image in the cloud
profile configuration.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If your domain\(aqs DNS is managed with DigitalOcean, and your minion name
matches your DigitalOcean managed DNS domain, you can automatically create
A and AAA records for newly created droplets. Use \fBcreate_dns_record: True\fP
in your config to enable this. Adding \fBdelete_dns_record: True\fP to also
delete records when a droplet is destroyed is optional. Due to limitations
in salt\-cloud design, the destroy code does not have access to the VM config
data. WHETHER YOU ADD \fBcreate_dns_record: True\fP OR NOT, salt\-cloud WILL
attempt to delete your DNS records if the minion name matches. This will
prevent advertising any recycled IP addresses for destroyed minions.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you need to perform the bootstrap using the local interface for droplets,
this can be done by setting \fBssh_interface: private\fP in your config. By
default the salt\-cloud script would run on the public interface however if firewall
is preventing the connection to the Droplet over the public interface you might need
to set this option to connect via private interface. Also, to use this feature
\fBprivate_networking: True\fP must be set in the config.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Additional documentation is available from \fI\%DigitalOcean\fP\&.
.UNINDENT
.UNINDENT
.SS Getting Started With Dimension Data Cloud
.sp
Dimension Data are a global IT Services company and form part of the NTT Group.
Dimension Data provide IT\-as\-a\-Service to customers around the globe on their
cloud platform (Compute as a Service). The CaaS service is available either on
one of the public cloud instances or as a private instance on premises.
.sp
\fI\%http://cloud.dimensiondata.com/\fP
.sp
CaaS has its own non\-standard API , SaltStack provides a wrapper on top of this
API with common methods with other IaaS solutions and Public cloud providers.
Therefore, you can use the Dimension Data module to communicate with both the
public and private clouds.
.SS Dependencies
.sp
This driver requires the Python \fBapache\-libcloud\fP and \fBnetaddr\fP library to be installed.
.SS Configuration
.sp
When you instantiate a driver you need to pass the following arguments to the
driver constructor:
.INDENT 0.0
.IP \(bu 2
\fBuser_id\fP \- Your Dimension Data Cloud username
.IP \(bu 2
\fBkey\fP \- Your Dimension Data Cloud password
.IP \(bu 2
\fBregion\fP \- The region key, one of the possible region keys
.UNINDENT
.sp
Possible regions:
.INDENT 0.0
.IP \(bu 2
\fBdd\-na\fP : Dimension Data North America (USA)
.IP \(bu 2
\fBdd\-eu\fP : Dimension Data Europe
.IP \(bu 2
\fBdd\-af\fP : Dimension Data Africa
.IP \(bu 2
\fBdd\-au\fP : Dimension Data Australia
.IP \(bu 2
\fBdd\-latam\fP : Dimension Data Latin America
.IP \(bu 2
\fBdd\-ap\fP : Dimension Data Asia Pacific
.IP \(bu 2
\fBdd\-canada\fP : Dimension Data Canada region
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example is for /etc/salt/cloud.providers or any file in the
# /etc/salt/cloud.providers.d/ directory.

my\-dimensiondata\-config:
  user_id: my_username
  key: myPassword!
  region: dd\-na
  driver: dimensiondata
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In version 2015.8.0, the \fBprovider\fP parameter in cloud provider
definitions was renamed to \fBdriver\fP\&. This change was made to avoid
confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the
Salt cloud module that provides the underlying functionality to connect to
a cloud host, while cloud profiles continue to use \fBprovider\fP to refer to
provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Profiles
.SS Cloud Profiles
.sp
Dimension Data images have an inbuilt size configuration, there is no list of sizes (although, if the
command \-\-list\-sizes is run a default will be returned).
.sp
Images can be obtained using the \fB\-\-list\-images\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-images my\-dimensiondata\-config
my\-dimensiondata\-config:
\-\-\-\-\-\-\-\-\-\-
dimensiondata:
    \-\-\-\-\-\-\-\-\-\-
    CSfM SharePoint 2013 Trial:
        \-\-\-\-\-\-\-\-\-\-
        driver:
        extra:
            \-\-\-\-\-\-\-\-\-\-
            OS_displayName:
                WIN2012R2S/64
            OS_type:
                None
            cpu:
            created:
                2015\-03\-19T18:36:06.000Z
            description:
                Windows 2012 R2 Standard 64\-bit installed with SharePoint 2013 and Visual Studio 2013 Pro (Trial Version)
            location:
            memoryGb:
                12
            osImageKey:
                T\-WIN\-2012R2\-STD\-SP2013\-VS2013\-64\-4\-12\-100
        get_uuid:
        id:
            0df4677e\-d380\-4e9b\-9469\-b529ee0214c5
        name:
            CSfM SharePoint 2013 Trial
        uuid:
            28c077f1be970ee904541407b377e3ff87a9ac69
    CentOS 5 32\-bit 2 CPU:
        \-\-\-\-\-\-\-\-\-\-
        driver:
        extra:
            \-\-\-\-\-\-\-\-\-\-
            OS_displayName:
                CENTOS5/32
            OS_type:
                None
            cpu:
            created:
                2015\-10\-21T14:52:29.000Z
            description:
                CentOS Release 5.11 32\-bit
            location:
            memoryGb:
                4
            osImageKey:
                T\-CENT\-5\-32\-2\-4\-10
        get_uuid:
        id:
            a8046bd1\-04ea\-4668\-bf32\-bf8d5540faed
        name:
            CentOS 5 32\-bit 2 CPU
        uuid:
            4d7dd59929fed6f4228db861b609da64997773a7

\&...SNIP...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Locations can be obtained using the \fB\-\-list\-locations\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-dimensiondata\-config:
    \-\-\-\-\-\-\-\-\-\-
    dimensiondata:
        \-\-\-\-\-\-\-\-\-\-
        Australia \- Melbourne:
            \-\-\-\-\-\-\-\-\-\-
            country:
                Australia
            driver:
            id:
                AU2
            name:
                Australia \- Melbourne
        Australia \- Melbourne MCP2:
            \-\-\-\-\-\-\-\-\-\-
            country:
                Australia
            driver:
            id:
                AU10
            name:
                Australia \- Melbourne MCP2
        Australia \- Sydney:
            \-\-\-\-\-\-\-\-\-\-
            country:
                Australia
            driver:
            id:
                AU1
            name:
                Australia \- Sydney
        Australia \- Sydney MCP2:
            \-\-\-\-\-\-\-\-\-\-
            country:
                Australia
            driver:
            id:
                AU9
            name:
                Australia \- Sydney MCP2
        New Zealand:
            \-\-\-\-\-\-\-\-\-\-
            country:
                New Zealand
            driver:
            id:
                AU8
            name:
                New Zealand
        New_Zealand:
            \-\-\-\-\-\-\-\-\-\-
            country:
                New Zealand
            driver:
            id:
                AU11
            name:
                New_Zealand
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Dimension Data Cloud REST API documentation is available from \fI\%Dimension Data MCP 2\fP\&.
.UNINDENT
.UNINDENT
.SS Getting Started With AWS EC2
.sp
Amazon EC2 is a very widely used public cloud platform and one of the core
platforms Salt Cloud has been built to support.
.sp
Previously, the suggested driver for AWS EC2 was the \fBaws\fP driver. This
has been deprecated in favor of the \fBec2\fP driver. Configuration using the
old \fBaws\fP driver will still function, but that driver is no longer in
active development.
.SS Dependencies
.sp
This driver requires the Python \fBrequests\fP library to be installed.
.SS Configuration
.sp
The following example illustrates some of the options that can be set. These
parameters are discussed in more detail below.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example is for /etc/salt/cloud.providers or any file in the
# /etc/salt/cloud.providers.d/ directory.

my\-ec2\-southeast\-public\-ips:
  # Set up the location of the salt master
  #
  minion:
    master: saltmaster.example.com

  # Set up grains information, which will be common for all nodes
  # using this provider
  grains:
    node_type: broker
    release: 1.0.1

  # Specify whether to use public or private IP for deploy script.
  #
  # Valid options are:
  #     private_ips \- The salt\-cloud command is run inside the EC2
  #     public_ips \- The salt\-cloud command is run outside of EC2
  #
  ssh_interface: public_ips

  # Optionally configure the Windows credential validation number of
  # retries and delay between retries.  This defaults to 10 retries
  # with a one second delay betwee retries
  win_deploy_auth_retries: 10
  win_deploy_auth_retry_delay: 1

  # Set the EC2 access credentials (see below)
  #
  id: \(aquse\-instance\-role\-credentials\(aq
  key: \(aquse\-instance\-role\-credentials\(aq

  # If \(aqrole_arn\(aq is specified the above credentials are used to
  # to assume to the role. By default, role_arn is set to None.
  role_arn: arn:aws:iam::012345678910:role/SomeRoleName

  # Make sure this key is owned by corresponding user (default \(aqsalt\(aq) with permissions 0400.
  #
  private_key: /etc/salt/my_test_key.pem
  keyname: my_test_key
  securitygroup: default

  # Optionally configure default region
  # Use salt\-cloud \-\-list\-locations <provider> to obtain valid regions
  #
  location: ap\-southeast\-1
  availability_zone: ap\-southeast\-1b

  # Configure which user to use to run the deploy script. This setting is
  # dependent upon the AMI that is used to deploy. It is usually safer to
  # configure this individually in a profile, than globally. Typical users
  # are:
  #
  # Amazon Linux \-> ec2\-user
  # RHEL         \-> ec2\-user
  # CentOS       \-> ec2\-user
  # Ubuntu       \-> ubuntu
  # Debian       \-> admin
  #
  ssh_username: ec2\-user

  # Optionally add an IAM profile
  iam_profile: \(aqarn:aws:iam::123456789012:instance\-profile/ExampleInstanceProfile\(aq

  driver: ec2


my\-ec2\-southeast\-private\-ips:
  # Set up the location of the salt master
  #
  minion:
    master: saltmaster.example.com

  # Specify whether to use public or private IP for deploy script.
  #
  # Valid options are:
  #     private_ips \- The salt\-master is also hosted with EC2
  #     public_ips \- The salt\-master is hosted outside of EC2
  #
  ssh_interface: private_ips

  # Optionally configure the Windows credential validation number of
  # retries and delay between retries.  This defaults to 10 retries
  # with a one second delay betwee retries
  win_deploy_auth_retries: 10
  win_deploy_auth_retry_delay: 1

  # Set the EC2 access credentials (see below)
  #
  id: \(aquse\-instance\-role\-credentials\(aq
  key: \(aquse\-instance\-role\-credentials\(aq

  # Make sure this key is owned by root with permissions 0400.
  #
  private_key: /etc/salt/my_test_key.pem
  keyname: my_test_key

  # This one should NOT be specified if VPC was not configured in AWS to be
  # the default. It might cause an error message which says that network
  # interfaces and an instance\-level security groups may not be specified
  # on the same request.
  #
  securitygroup: default

  # Optionally configure default region
  #
  location: ap\-southeast\-1
  availability_zone: ap\-southeast\-1b

  # Configure which user to use to run the deploy script. This setting is
  # dependent upon the AMI that is used to deploy. It is usually safer to
  # configure this individually in a profile, than globally. Typical users
  # are:
  #
  # Amazon Linux \-> ec2\-user
  # RHEL         \-> ec2\-user
  # CentOS       \-> ec2\-user
  # Ubuntu       \-> ubuntu
  #
  ssh_username: ec2\-user

  # Optionally add an IAM profile
  iam_profile: \(aqmy other profile name\(aq

  driver: ec2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Access Credentials
.sp
The \fBid\fP and \fBkey\fP settings may be found in the Security Credentials area
of the AWS Account page:
.sp
\fI\%https://portal.aws.amazon.com/gp/aws/securityCredentials\fP
.sp
Both are located in the Access Credentials area of the page, under the Access
Keys tab. The \fBid\fP setting is labeled Access Key ID, and the \fBkey\fP setting
is labeled Secret Access Key.
.sp
Note: if either \fBid\fP or \fBkey\fP is set to \(aquse\-instance\-role\-credentials\(aq it is
assumed that Salt is running on an AWS instance, and the instance role
credentials will be retrieved and used.  Since both the \fBid\fP and \fBkey\fP are
required parameters for the AWS ec2 provider, it is recommended to set both
to \(aquse\-instance\-role\-credentials\(aq for this functionality.
.sp
A \(dqstatic\(dq and \(dqpermanent\(dq Access Key ID and Secret Key can be specified,
but this is not recommended.  Instance role keys are rotated on a regular
basis, and are the recommended method of specifying AWS credentials.
.SS Windows Deploy Timeouts
.sp
For Windows instances, it may take longer than normal for the instance to be
ready.  In these circumstances, the provider configuration can be configured
with a \fBwin_deploy_auth_retries\fP and/or a \fBwin_deploy_auth_retry_delay\fP
setting, which default to 10 retries and a one second delay between retries.
These retries and timeouts relate to validating the Administrator password
once AWS provides the credentials via the AWS API.
.SS Key Pairs
.sp
In order to create an instance with Salt installed and configured, a key pair
will need to be created. This can be done in the EC2 Management Console, in the
Key Pairs area. These key pairs are unique to a specific region. Keys in the
us\-east\-1 region can be configured at:
.sp
\fI\%https://console.aws.amazon.com/ec2/home?region=us\-east\-1#s=KeyPairs\fP
.sp
Keys in the us\-west\-1 region can be configured at
.sp
\fI\%https://console.aws.amazon.com/ec2/home?region=us\-west\-1#s=KeyPairs\fP
.sp
\&...and so on. When creating a key pair, the browser will prompt to download a
pem file. This file must be placed in a directory accessible by Salt Cloud,
with permissions set to either 0400 or 0600.
.SS Security Groups
.sp
An instance on EC2 needs to belong to a security group. Like key pairs, these
are unique to a specific region. These are also configured in the EC2
Management Console. Security groups for the us\-east\-1 region can be configured
at:
.sp
\fI\%https://console.aws.amazon.com/ec2/home?region=us\-east\-1#s=SecurityGroups\fP
.sp
\&...and so on.
.sp
A security group defines firewall rules which an instance will adhere to. If
the salt\-master is configured outside of EC2, the security group must open the
SSH port (usually port 22) in order for Salt Cloud to install Salt.
.SS IAM Profile
.sp
Amazon EC2 instances support the concept of an \fI\%instance profile\fP, which
is a logical container for the IAM role. At the time that you launch an EC2
instance, you can associate the instance with an instance profile, which in
turn corresponds to the IAM role. Any software that runs on the EC2 instance
is able to access AWS using the permissions associated with the IAM role.
.sp
Scaffolding the profile is a 2\-step configuration process:
.INDENT 0.0
.IP 1. 3
Configure an IAM Role from the \fI\%IAM Management Console\fP\&.
.IP 2. 3
Attach this role to a new profile. It can be done with the \fI\%AWS CLI\fP:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
> aws iam create\-instance\-profile \-\-instance\-profile\-name PROFILE_NAME
> aws iam add\-role\-to\-instance\-profile \-\-instance\-profile\-name PROFILE_NAME \-\-role\-name ROLE_NAME
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Once the profile is created, you can use the \fBPROFILE_NAME\fP to configure
your cloud profiles.
.SS Cloud Profiles
.sp
Set up an initial profile at \fB/etc/salt/cloud.profiles\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base_ec2_private:
  provider: my\-ec2\-southeast\-private\-ips
  image: ami\-e565ba8c
  size: t2.micro
  ssh_username: ec2\-user

base_ec2_public:
  provider: my\-ec2\-southeast\-public\-ips
  image: ami\-e565ba8c
  size: t2.micro
  ssh_username: ec2\-user

base_ec2_db:
  provider: my\-ec2\-southeast\-public\-ips
  image: ami\-e565ba8c
  size: m1.xlarge
  ssh_username: ec2\-user
  volumes:
    \- { size: 10, device: /dev/sdf }
    \- { size: 10, device: /dev/sdg, type: io1, iops: 1000 }
    \- { size: 10, device: /dev/sdh, type: io1, iops: 1000 }
    \- { size: 10, device: /dev/sdi, tags: {\(dqEnvironment\(dq: \(dqproduction\(dq} }
  # optionally add tags to profile:
  tag: {\(aqEnvironment\(aq: \(aqproduction\(aq, \(aqRole\(aq: \(aqdatabase\(aq}
  # force grains to sync after install
  sync_after_install: grains

base_ec2_vpc:
  provider: my\-ec2\-southeast\-public\-ips
  image: ami\-a73264ce
  size: m1.xlarge
  ssh_username: ec2\-user
  script:  /etc/salt/cloud.deploy.d/my_bootstrap.sh
  network_interfaces:
    \- DeviceIndex: 0
      PrivateIpAddresses:
        \- Primary: True
      #auto assign public ip (not EIP)
      AssociatePublicIpAddress: True
      SubnetId: subnet\-813d4bbf
      SecurityGroupId:
        \- sg\-750af413
  del_root_vol_on_destroy: True
  del_all_vols_on_destroy: True
  volumes:
    \- { size: 10, device: /dev/sdf }
    \- { size: 10, device: /dev/sdg, type: io1, iops: 1000 }
    \- { size: 10, device: /dev/sdh, type: io1, iops: 1000 }
  tag: {\(aqEnvironment\(aq: \(aqproduction\(aq, \(aqRole\(aq: \(aqdatabase\(aq}
  sync_after_install: grains
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The profile can now be realized with a salt command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-p base_ec2 ami.example.com
# salt\-cloud \-p base_ec2_public ami.example.com
# salt\-cloud \-p base_ec2_private ami.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will create an instance named \fBami.example.com\fP in EC2. The minion that
is installed on this instance will have an \fBid\fP of \fBami.example.com\fP\&. If
the command was executed on the salt\-master, its Salt key will automatically be
signed on the master.
.sp
Once the instance has been created with salt\-minion installed, connectivity to
it can be verified with Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt \(aqami.example.com\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Required Settings
.sp
The following settings are always required for EC2:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Set the EC2 login data
my\-ec2\-config:
  id: HJGRYCILJLKJYG
  key: \(aqkdjgfsgm;woormgl/aserigjksjdhasdfgn\(aq
  keyname: test
  securitygroup: quick\-start
  private_key: /root/test.pem
  driver: ec2
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Optional Settings
.sp
EC2 allows a userdata file to be passed to the instance to be created. This
functionality was added to Salt in the 2015.5.0 release.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  # Pass userdata to the instance to be created
  userdata_file: /etc/salt/my\-userdata\-file
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
From versions 2016.11.0 and 2016.11.3, this file was passed through the
master\(aqs \fI\%renderer\fP to template it. However, this caused
issues with non\-YAML data, so templating is no longer performed by default.
To template the userdata_file, add a \fBuserdata_template\fP option to the
cloud profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  # Pass userdata to the instance to be created
  userdata_file: /etc/salt/my\-userdata\-file
  userdata_template: jinja
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If no \fBuserdata_template\fP is set in the cloud profile, then the master
configuration will be checked for a \fI\%userdata_template\fP value.
If this is not set, then no templating will be performed on the
userdata_file.
.sp
To disable templating in a cloud profile when a
\fI\%userdata_template\fP has been set in the master configuration
file, simply set \fBuserdata_template\fP to \fBFalse\fP in the cloud profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  # Pass userdata to the instance to be created
  userdata_file: /etc/salt/my\-userdata\-file
  userdata_template: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
EC2 allows a location to be set for servers to be deployed in. Availability
zones exist inside regions, and may be added to increase specificity.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  # Optionally configure default region
  location: ap\-southeast\-1
  availability_zone: ap\-southeast\-1b
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
EC2 instances can have a public or private IP, or both. When an instance is
deployed, Salt Cloud needs to log into it via SSH to run the deploy script.
By default, the public IP will be used for this. If the salt\-cloud command is
run from another EC2 instance, the private IP should be used.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  # Specify whether to use public or private IP for deploy script
  # private_ips or public_ips
  ssh_interface: public_ips
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Many EC2 instances do not allow remote access to the root user by default.
Instead, another user must be used to run the deploy script using sudo. Some
common usernames include ec2\-user (for Amazon Linux), ubuntu (for Ubuntu
instances), admin (official Debian) and bitnami (for images provided by
Bitnami).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  # Configure which user to use to run the deploy script
  ssh_username: ec2\-user
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple usernames can be provided, in which case Salt Cloud will attempt to
guess the correct username. This is mostly useful in the main configuration
file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  ssh_username:
    \- ec2\-user
    \- ubuntu
    \- admin
    \- bitnami
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple security groups can also be specified in the same fashion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  securitygroup:
    \- default
    \- extra
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
EC2 instances can be added to an \fI\%AWS Placement Group\fP by specifying the
\fBplacementgroup\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  placementgroup: my\-aws\-placement\-group
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Your instances may optionally make use of EC2 Spot Instances. The
following example will request that spot instances be used and your
maximum bid will be $0.10. Keep in mind that different spot prices
may be needed based on the current value of the various EC2 instance
sizes. You can check current and past spot instance pricing via the
EC2 API or AWS Console.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  spot_config:
    spot_price: 0.10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can optionally specify tags to apply to the EC2 spot instance request.
A spot instance request itself is an object in AWS. The following example
will set two tags on the spot instance request.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  spot_config:
    spot_price: 0.10
    tag:
      tag0: value
      tag1: value
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default, the spot instance type is set to \(aqone\-time\(aq, meaning it will
be launched and, if it\(aqs ever terminated for whatever reason, it will not
be recreated. If you would like your spot instances to be relaunched after
a termination (by you or AWS), set the \fBtype\fP to \(aqpersistent\(aq.
.sp
NOTE: Spot instances are a great way to save a bit of money, but you do
run the risk of losing your spot instances if the current price for the
instance size goes above your maximum bid.
.sp
The following parameters may be set in the cloud configuration file to
control various aspects of the spot instance launching:
.INDENT 0.0
.IP \(bu 2
\fBwait_for_spot_timeout\fP: seconds to wait before giving up on spot instance
launch (default=600)
.IP \(bu 2
\fBwait_for_spot_interval\fP: seconds to wait in between polling requests to
determine if a spot instance is available (default=30)
.IP \(bu 2
\fBwait_for_spot_interval_multiplier\fP: a multiplier to add to the interval in
between requests, which is useful if AWS is throttling your requests
(default=1)
.IP \(bu 2
\fBwait_for_spot_max_failures\fP: maximum number of failures before giving up
on launching your spot instance (default=10)
.UNINDENT
.sp
If you find that you\(aqre being throttled by AWS while polling for spot
instances, you can set the following in your core cloud configuration
file that will double the polling interval after each request to AWS.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
wait_for_spot_interval: 1
wait_for_spot_interval_multiplier: 2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See the \fI\%AWS Spot Instances\fP documentation for more information.
.sp
Block device mappings enable you to specify additional EBS volumes or instance
store volumes when the instance is launched. This setting is also available on
each cloud profile. Note that the number of instance stores varies by instance
type.  If more mappings are provided than are supported by the instance type,
mappings will be created in the order provided and additional mappings will be
ignored. Consult the \fI\%AWS documentation\fP for a listing of the available
instance stores, and device names.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  block_device_mappings:
    \- DeviceName: /dev/sdb
      VirtualName: ephemeral0
    \- DeviceName: /dev/sdc
      VirtualName: ephemeral1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also use block device mappings to change the size of the root device at the
provisioning time. For example, assuming the root device is \(aq/dev/sda\(aq, you can set
its size to 100G by using the following configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  block_device_mappings:
    \- DeviceName: /dev/sda
      Ebs.VolumeSize: 100
      Ebs.VolumeType: gp2
      Ebs.SnapshotId: dummy0
    \- DeviceName: /dev/sdb
      # required for devices > 2TB
      Ebs.VolumeType: gp2
      Ebs.VolumeSize: 3001
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Tagging of block devices can be set on a per device basis. For example, you may
have multiple devices defined in your block_device_mappings structure. You have the
option to set tags on any of one device or all of them as shown in the following
configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  block_device_mappings:
    \- DeviceName: /dev/sda
      Ebs.VolumeSize: 100
      Ebs.VolumeType: gp2
      tag:
        tag0: myserver
        tag1: value
    \- DeviceName: /dev/sdb
      Ebs.VolumeType: gp2
      Ebs.VolumeSize: 3001
      tag:
        tagX: value
        tagY: value
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can configure any AWS valid tag name as shown in the above example, including
\(aqName\(aq. If you do not configure the tag \(aqName\(aq, it will be automatically created
with a value set to the virtual machine name. If you configure the tag \(aqName\(aq, the
value you configure will be used rather than defaulting to the virtual machine
name as shown in the following configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  block_device_mappings:
    \- DeviceName: /dev/sda
      Ebs.VolumeSize: 100
      Ebs.VolumeType: gp2
      tag:
        Name: myserver
        tag0: value
        tag1: value
    \- DeviceName: /dev/sdb
      Ebs.VolumeType: gp2
      Ebs.VolumeSize: 3001
      tag:
        Name: customvalue
        tagX: value
        tagY: value
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Existing EBS volumes may also be attached (not created) to your instances or
you can create new EBS volumes based on EBS snapshots. To simply attach an
existing volume use the \fBvolume_id\fP parameter.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
device: /dev/xvdj
volume_id: vol\-12345abcd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or, to create a volume from an EBS snapshot, use the \fBsnapshot\fP parameter.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
device: /dev/xvdj
snapshot: snap\-abcd12345
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that \fBvolume_id\fP will take precedence over the \fBsnapshot\fP parameter.
.sp
Tags can be set once an instance has been launched.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
    tag:
        tag0: value
        tag1: value
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Setting up a Master inside EC2
.sp
Salt Cloud can configure Salt Masters as well as Minions. Use the \fBmake_master\fP setting to use
this functionality.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  # Optionally install a Salt Master in addition to the Salt Minion
  make_master: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When creating a Salt Master inside EC2 with \fBmake_master: True\fP, or when the Salt Master is already
located and configured inside EC2, by default, minions connect to the master\(aqs public IP address during
Salt Cloud\(aqs provisioning process. Depending on how your security groups are defined, the minions
may or may not be able to communicate with the master. In order to use the master\(aqs private IP in EC2
instead of the public IP, set the \fBsalt_interface\fP to \fBprivate_ips\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  # Optionally set the IP configuration to private_ips
  salt_interface: private_ips
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Modify EC2 Tags
.sp
One of the features of EC2 is the ability to tag resources. In fact, under the
hood, the names given to EC2 instances by salt\-cloud are actually just stored
as a tag called Name. Salt Cloud has the ability to manage these tags:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a get_tags mymachine
salt\-cloud \-a set_tags mymachine tag1=somestuff tag2=\(aqOther stuff\(aq
salt\-cloud \-a del_tags mymachine tag1,tag2,tag3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is possible to manage tags on any resource in EC2 with a Resource ID, not
just instances:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_tags my_ec2 resource_id=af5467ba
salt\-cloud \-f set_tags my_ec2 resource_id=af5467ba tag1=somestuff
salt\-cloud \-f del_tags my_ec2 resource_id=af5467ba tags=tag1,tag2,tag3
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Rename EC2 Instances
.sp
As mentioned above, EC2 instances are named via a tag. However, renaming an
instance by renaming its tag will cause the salt keys to mismatch. A rename
function exists which renames both the instance, and the salt keys.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a rename mymachine newname=yourmachine
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Rename on Destroy
.sp
When instances on EC2 are destroyed, there will be a lag between the time that
the action is sent, and the time that Amazon cleans up the instance. During
this time, the instance still retains a Name tag, which will cause a collision
if the creation of an instance with the same name is attempted before the
cleanup occurs. In order to avoid such collisions, Salt Cloud can be configured
to rename instances when they are destroyed. The new name will look something
like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myinstance\-DEL20f5b8ad4eb64ed88f2c428df80a1a0c
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In order to enable this, add rename_on_destroy line to the main
configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  rename_on_destroy: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Listing Images
.sp
Normally, images can be queried on a cloud provider by passing the
\fB\-\-list\-images\fP argument to Salt Cloud. This still holds true for EC2:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images my\-ec2\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, the full list of images on EC2 is extremely large, and querying all of
the available images may cause Salt Cloud to behave as if frozen. Therefore,
the default behavior of this option may be modified, by adding an \fBowner\fP
argument to the provider configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
owner: aws\-marketplace
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The possible values for this setting are \fBamazon\fP, \fBaws\-marketplace\fP,
\fBself\fP, \fB<AWS account ID>\fP or \fBall\fP\&. The default setting is \fBamazon\fP\&.
Take note that \fBall\fP and \fBaws\-marketplace\fP may cause Salt Cloud to appear
as if it is freezing, as it tries to handle the large amount of data.
.sp
It is also possible to perform this query using different settings without
modifying the configuration files. To do this, call the \fBavail_images\fP
function directly:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f avail_images my\-ec2\-config owner=aws\-marketplace
.ft P
.fi
.UNINDENT
.UNINDENT
.SS EC2 Images
.sp
The following are lists of available AMI images, generally sorted by OS. These
lists are on 3rd\-party websites, are not managed by Salt Stack in any way. They
are provided here as a reference for those who are interested, and contain no
warranty (express or implied) from anyone affiliated with Salt Stack. Most of
them have never been used, much less tested, by the Salt Stack team.
.INDENT 0.0
.IP \(bu 2
\fI\%Arch Linux\fP
.UNINDENT
.INDENT 0.0
.IP \(bu 2
\fI\%FreeBSD\fP
.UNINDENT
.INDENT 0.0
.IP \(bu 2
\fI\%Fedora\fP
.UNINDENT
.INDENT 0.0
.IP \(bu 2
\fI\%CentOS\fP
.UNINDENT
.INDENT 0.0
.IP \(bu 2
\fI\%Ubuntu\fP
.UNINDENT
.INDENT 0.0
.IP \(bu 2
\fI\%Debian\fP
.UNINDENT
.INDENT 0.0
.IP \(bu 2
\fI\%OmniOS\fP
.UNINDENT
.INDENT 0.0
.IP \(bu 2
\fI\%All Images on Amazon\fP
.UNINDENT
.sp
NOTE: If \fBimage\fP of a profile does not start with \fBami\-\fP, latest
image with that name will be used. For example, to create a CentOS 7
profile, instead of using the AMI like \fBimage: ami\-1caef165\fP, we
can use its name like \fBimage: \(aqCentOS Linux 7 x86_64 HVM EBS ENA 1803_01\(aq\fP\&.
We can also use a pattern like below to get the latest CentOS 7:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
profile\-id:
  provider: provider\-name
  subnetid: subnet\-XXXXXXXX
  image: \(aqCentOS Linux 7 x86_64 HVM EBS *\(aq
  size: m1.medium
  ssh_username: centos
  securitygroupid:
    \- sg\-XXXXXXXX
  securitygroupname:
    \- AnotherSecurityGroup
    \- AndThirdSecurityGroup
.ft P
.fi
.UNINDENT
.UNINDENT
.SS show_image
.sp
This is a function that describes an AMI on EC2. This will give insight as to
the defaults that will be applied to an instance using a particular AMI.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-f show_image ec2 image=ami\-fd20ad94
.ft P
.fi
.UNINDENT
.UNINDENT
.SS show_instance
.sp
This action is a thin wrapper around \fB\-\-full\-query\fP, which displays details on a
single instance only. In an environment with several machines, this will save a
user from having to sort through all instance data, just to examine a single
instance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-a show_instance myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.SS ebs_optimized
.sp
This argument enables switching of the EbsOptimized setting which default
to \(aqfalse\(aq. Indicates whether the instance is optimized for EBS I/O. This
optimization provides dedicated throughput to Amazon EBS and an optimized
configuration stack to provide optimal Amazon EBS I/O performance. This
optimization isn\(aqt available with all instance types. Additional usage
charges apply when using an EBS\-optimized instance.
.sp
This setting can be added to the profile or map file for an instance.
.sp
If set to True, this setting will enable an instance to be EbsOptimized
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ebs_optimized: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This can also be set as a cloud provider setting in the EC2 cloud
configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  ebs_optimized: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS del_root_vol_on_destroy
.sp
This argument overrides the default DeleteOnTermination setting in the AMI for
the EBS root volumes for an instance. Many AMIs contain \(aqfalse\(aq as a default,
resulting in orphaned volumes in the EC2 account, which may unknowingly be
charged to the account. This setting can be added to the profile or map file
for an instance.
.sp
If set, this setting will apply to the root EBS volume
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
del_root_vol_on_destroy: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This can also be set as a cloud provider setting in the EC2 cloud
configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  del_root_vol_on_destroy: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS del_all_vols_on_destroy
.sp
This argument overrides the default DeleteOnTermination setting in the AMI for
the not\-root EBS volumes for an instance. Many AMIs contain \(aqfalse\(aq as a
default, resulting in orphaned volumes in the EC2 account, which may
unknowingly be charged to the account. This setting can be added to the profile
or map file for an instance.
.sp
If set, this setting will apply to any (non\-root) volumes that were created
by salt\-cloud using the \(aqvolumes\(aq setting.
.sp
The volumes will not be deleted under the following conditions
* If a volume is detached before terminating the instance
* If a volume is created without this setting and attached to the instance
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
del_all_vols_on_destroy: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This can also be set as a cloud provider setting in the EC2 cloud
configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  del_all_vols_on_destroy: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The setting for this may be changed on all volumes of an existing instance
using one of the following commands:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a delvol_on_destroy myinstance
salt\-cloud \-a keepvol_on_destroy myinstance
salt\-cloud \-a show_delvol_on_destroy myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The setting for this may be changed on a volume on an existing instance
using one of the following commands:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a delvol_on_destroy myinstance device=/dev/sda1
salt\-cloud \-a delvol_on_destroy myinstance volume_id=vol\-1a2b3c4d
salt\-cloud \-a keepvol_on_destroy myinstance device=/dev/sda1
salt\-cloud \-a keepvol_on_destroy myinstance volume_id=vol\-1a2b3c4d
salt\-cloud \-a show_delvol_on_destroy myinstance device=/dev/sda1
salt\-cloud \-a show_delvol_on_destroy myinstance volume_id=vol\-1a2b3c4d
.ft P
.fi
.UNINDENT
.UNINDENT
.SS EC2 Termination Protection
.sp
EC2 allows the user to enable and disable termination protection on a specific
instance. An instance with this protection enabled cannot be destroyed. The EC2
driver adds a show_term_protect action to the regular EC2 functionality.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_term_protect mymachine
salt\-cloud \-a enable_term_protect mymachine
salt\-cloud \-a disable_term_protect mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Alternate Endpoint
.sp
Normally, EC2 endpoints are build using the region and the service_url. The
resulting endpoint would follow this pattern:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ec2.<region>.<service_url>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This results in an endpoint that looks like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ec2.us\-east\-1.amazonaws.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There are other projects that support an EC2 compatibility layer, which this
scheme does not account for. This can be overridden by specifying the endpoint
directly in the main cloud configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  endpoint: myendpoint.example.com:1138/services/Cloud
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Volume Management
.sp
The EC2 driver has several functions and actions for management of EBS volumes.
.SS Creating Volumes
.sp
A volume may be created, independent of an instance. A zone must be specified.
A size or a snapshot may be specified (in GiB). If neither is given, a default
size of 10 GiB will be used. If a snapshot is given, the size of the snapshot
will be used.
.sp
The following parameters may also be set (when providing a snapshot OR size):
.INDENT 0.0
.IP \(bu 2
\fBtype\fP: choose between standard (magnetic disk), gp2 (SSD), or io1 (provisioned IOPS).
(default=standard)
.IP \(bu 2
\fBiops\fP: the number of IOPS (only applicable to io1 volumes) (default varies on volume size)
.IP \(bu 2
\fBencrypted\fP: enable encryption on the volume (default=false)
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_volume ec2 zone=us\-east\-1b
salt\-cloud \-f create_volume ec2 zone=us\-east\-1b size=10
salt\-cloud \-f create_volume ec2 zone=us\-east\-1b snapshot=snap12345678
salt\-cloud \-f create_volume ec2 size=10 type=standard
salt\-cloud \-f create_volume ec2 size=10 type=gp2
salt\-cloud \-f create_volume ec2 size=10 type=io1 iops=1000
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Attaching Volumes
.sp
Unattached volumes may be attached to an instance. The following values are
required; name or instance_id, volume_id, and device.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a attach_volume myinstance volume_id=vol\-12345 device=/dev/sdb1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Show a Volume
.sp
The details about an existing volume may be retrieved.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_volume myinstance volume_id=vol\-12345
salt\-cloud \-f show_volume ec2 volume_id=vol\-12345
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Detaching Volumes
.sp
An existing volume may be detached from an instance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a detach_volume myinstance volume_id=vol\-12345
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Deleting Volumes
.sp
A volume that is not attached to an instance may be deleted.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_volume ec2 volume_id=vol\-12345
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Managing Key Pairs
.sp
The EC2 driver has the ability to manage key pairs.
.SS Creating a Key Pair
.sp
A key pair is required in order to create an instance. When creating a key pair
with this function, the return data will contain a copy of the private key.
This private key is not stored by Amazon, will not be obtainable past this
point, and should be stored immediately.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_keypair ec2 keyname=mykeypair
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Importing a Key Pair
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f import_keypair ec2 keyname=mykeypair file=/path/to/id_rsa.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Show a Key Pair
.sp
This function will show the details related to a key pair, not including the
private key itself (which is not stored by Amazon).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_keypair ec2 keyname=mykeypair
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Delete a Key Pair
.sp
This function removes the key pair from Amazon.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_keypair ec2 keyname=mykeypair
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Launching instances into a VPC
.SS Simple launching into a VPC
.sp
In the amazon web interface, identify the id or the name of the subnet into
which your image should be created. Then, edit your cloud.profiles file like
so:\-
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
profile\-id:
  provider: provider\-name
  subnetid: subnet\-XXXXXXXX
  image: ami\-XXXXXXXX
  size: m1.medium
  ssh_username: ubuntu
  securitygroupid:
    \- sg\-XXXXXXXX
  securitygroupname:
    \- AnotherSecurityGroup
    \- AndThirdSecurityGroup
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that \(aqsubnetid\(aq takes precedence over \(aqsubnetname\(aq, but \(aqsecuritygroupid\(aq
and \(aqsecuritygroupname\(aq are merged together to generate a single list for
SecurityGroups of instances.
.SS Specifying interface properties
.sp
New in version 2014.7.0.

.sp
Launching into a VPC allows you to specify more complex configurations for
the network interfaces of your virtual machines, for example:\-
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
profile\-id:
  provider: provider\-name
  image: ami\-XXXXXXXX
  size: m1.medium
  ssh_username: ubuntu

  # Do not include either \(aqsubnetid\(aq, \(aqsubnetname\(aq, \(aqsecuritygroupid\(aq or
  # \(aqsecuritygroupname\(aq here if you are going to manually specify
  # interface configuration
  #
  network_interfaces:
    \- DeviceIndex: 0
      SubnetId: subnet\-XXXXXXXX
      SecurityGroupId:
        \- sg\-XXXXXXXX

      # Uncomment this line if you would like to set an explicit private
      # IP address for the ec2 instance
      #
      # PrivateIpAddress: 192.168.1.66

      # Uncomment this to associate an existing Elastic IP Address with
      # this network interface:
      #
      # associate_eip: eipalloc\-XXXXXXXX

      # You can allocate more than one IP address to an interface. Use the
      # \(aqip addr list\(aq command to see them.
      #
      # SecondaryPrivateIpAddressCount: 2

      # Uncomment this to allocate a new Elastic IP Address to this
      # interface (will be associated with the primary private ip address
      # of the interface
      #
      # allocate_new_eip: True

      # Uncomment this instead to allocate a new Elastic IP Address to
      # both the primary private ip address and each of the secondary ones
      #
      allocate_new_eips: True

      # Uncomment this if you\(aqre creating NAT instances. Allows an instance
      # to accept IP packets with destinations other than itself.
      # SourceDestCheck: False

    \- DeviceIndex: 1
      subnetname: XXXXXXXX\-Subnet
      securitygroupname:
        \- XXXXXXXX\-SecurityGroup
        \- YYYYYYYY\-SecurityGroup
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that it is an error to assign a \(aqsubnetid\(aq, \(aqsubnetname\(aq, \(aqsecuritygroupid\(aq
or \(aqsecuritygroupname\(aq to a profile where the interfaces are manually configured
like this. These are both really properties of each network interface, not of
the machine itself.
.SS Getting Started With GoGrid
.sp
GoGrid is a public cloud host that supports Linux and Windows.
.SS Configuration
.sp
To use Salt Cloud with GoGrid log into the GoGrid web interface and create an
API key. Do this by clicking on \(dqMy Account\(dq and then going to the API Keys
tab.
.sp
The \fBapikey\fP and the \fBsharedsecret\fP configuration parameters need to be set
in the configuration file to enable interfacing with GoGrid:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example is for /etc/salt/cloud.providers or any file in the
# /etc/salt/cloud.providers.d/ directory.

my\-gogrid\-config:
  driver: gogrid
  apikey: asdff7896asdh789
  sharedsecret: saltybacon
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
A Note about using Map files with GoGrid:
.sp
Due to limitations in the GoGrid API, instances cannot be provisioned in parallel
with the GoGrid driver. Map files will work with GoGrid, but the \fB\-P\fP
argument should not be used on maps referencing GoGrid instances.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Profiles
.SS Cloud Profiles
.sp
Set up an initial profile at \fB/etc/salt/cloud.profiles\fP or in the
\fB/etc/salt/cloud.profiles.d/\fP directory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gogrid_512:
  provider: my\-gogrid\-config
  size: 512MB
  image: CentOS 6.2 (64\-bit) w/ None
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Sizes can be obtained using the \fB\-\-list\-sizes\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-sizes my\-gogrid\-config
my\-gogrid\-config:
    \-\-\-\-\-\-\-\-\-\-
    gogrid:
        \-\-\-\-\-\-\-\-\-\-
        512MB:
            \-\-\-\-\-\-\-\-\-\-
            bandwidth:
                None
            disk:
                30
            driver:
            get_uuid:
            id:
                512MB
            name:
                512MB
            price:
                0.095
            ram:
                512
            uuid:
                bde1e4d7c3a643536e42a35142c7caac34b060e9
\&...SNIP...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Images can be obtained using the \fB\-\-list\-images\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-images my\-gogrid\-config
my\-gogrid\-config:
    \-\-\-\-\-\-\-\-\-\-
    gogrid:
        \-\-\-\-\-\-\-\-\-\-
        CentOS 6.4 (64\-bit) w/ None:
            \-\-\-\-\-\-\-\-\-\-
            driver:
            extra:
                \-\-\-\-\-\-\-\-\-\-
            get_uuid:
            id:
                18094
            name:
                CentOS 6.4 (64\-bit) w/ None
            uuid:
                bfd4055389919e01aa6261828a96cf54c8dcc2c4
\&...SNIP...
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Assigning IPs
.sp
New in version 2015.8.0.

.sp
The GoGrid API allows IP addresses to be manually assigned. Salt Cloud supports
this functionality by allowing an IP address to be specified using the
\fBassign_public_ip\fP argument. This likely makes the most sense inside a map
file, but it may also be used inside a profile.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gogrid_512:
  provider: my\-gogrid\-config
  size: 512MB
  image: CentOS 6.2 (64\-bit) w/ None
  assign_public_ip: 11.38.257.42
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Getting Started With Google Compute Engine
.sp
Google Compute Engine (GCE) is Google\-infrastructure as a service that lets you
run your large\-scale computing workloads on virtual machines.  This document
covers how to use Salt Cloud to provision and manage your virtual machines
hosted within Google\(aqs infrastructure.
.sp
You can find out more about GCE and other Google Cloud Platform services
at \fI\%https://cloud.google.com\fP\&.
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
LibCloud >= 1.0.0
.UNINDENT
.sp
Changed in version 2017.7.0.

.INDENT 0.0
.IP \(bu 2
A Google Cloud Platform account with Compute Engine enabled
.IP \(bu 2
A registered Service Account for authorization
.IP \(bu 2
Oh, and obviously you\(aqll need \fI\%salt\fP
.UNINDENT
.SS Google Compute Engine Setup
.INDENT 0.0
.IP 1. 3
Sign up for Google Cloud Platform
.sp
Go to \fI\%https://cloud.google.com\fP and use your Google account to sign up for
Google Cloud Platform and complete the guided instructions.
.IP 2. 3
Create a Project
.sp
Next, go to the console at \fI\%https://cloud.google.com/console\fP and create a
new Project.  Make sure to select your new Project if you are not
automatically directed to the Project.
.sp
Projects are a way of grouping together related users, services, and
billing.  You may opt to create multiple Projects and the remaining
instructions will need to be completed for each Project if you wish to
use GCE and Salt Cloud to manage your virtual machines.
.IP 3. 3
Enable the Google Compute Engine service
.sp
In your Project, either just click \fICompute Engine\fP to the left, or go to
the \fIAPIs & auth\fP section and \fIAPIs\fP link and enable the Google Compute
Engine service.
.IP 4. 3
Create a Service Account
.sp
To set up authorization, navigate to \fIAPIs & auth\fP section and then the
\fICredentials\fP link and click the \fICREATE NEW CLIENT ID\fP button. Select
\fIService Account\fP and click the \fICreate Client ID\fP button. This will
automatically download a \fB\&.json\fP file, which may or may not be used
in later steps, depending on your version of \fBlibcloud\fP\&.
.sp
Look for a new \fIService Account\fP section in the page and record the generated
email address for the matching key/fingerprint. The email address will be used
in the \fBservice_account_email_address\fP of the \fB/etc/salt/cloud.providers\fP
or the \fB/etc/salt/cloud.providers.d/*.conf\fP file.
.IP 5. 3
Key Format
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
If you are using \fBlibcloud >= 0.17.0\fP it is recommended that you use the \fBJSON
format\fP file you downloaded above and skip to the \fI\%Provider Configuration\fP section
below, using the JSON file \fBin place of \(aqNEW.pem\(aq\fP in the documentation.
.sp
If you are using an older version of libcloud or are unsure of the version you
have, please follow the instructions below to generate and format a new P12 key.
.UNINDENT
.UNINDENT
.sp
In the new \fIService Account\fP section, click \fIGenerate new P12 key\fP, which
will automatically download a \fB\&.p12\fP private key file. The \fB\&.p12\fP
private key needs to be converted to a format compatible with libcloud.
This new Google\-generated private key was encrypted using \fInotasecret\fP as
a passphrase. Use the following command and record the location of the
converted private key and record the location for use in the
\fBservice_account_private_key\fP of the \fB/etc/salt/cloud\fP file:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
openssl pkcs12 \-in ORIG.p12 \-passin pass:notasecret \e
\-nodes \-nocerts | openssl rsa \-out NEW.pem
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Provider Configuration
.sp
Set up the provider cloud config at \fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/*.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gce\-config:
  # Set up the Project name and Service Account authorization
  project: \(dqyour\-project\-id\(dq
  service_account_email_address: \(dq123\-a5gt@developer.gserviceaccount.com\(dq
  service_account_private_key: \(dq/path/to/your/NEW.pem\(dq

  # Set up the location of the salt master
  minion:
    master: saltmaster.example.com

  # Set up grains information, which will be common for all nodes
  # using this provider
  grains:
    node_type: broker
    release: 1.0.1

  driver: gce
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Empty strings as values for \fBservice_account_private_key\fP and \fBservice_account_email_address\fP
can be used on GCE instances. This will result in the service account assigned to the GCE instance
being used.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The value provided for \fBproject\fP must not contain underscores or spaces and
is labeled as \(dqProject ID\(dq on the Google Developers Console.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Profile Configuration
.sp
Set up an initial profile at \fB/etc/salt/cloud.profiles\fP or
\fB/etc/salt/cloud.profiles.d/*.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-gce\-profile:
  image: centos\-6
  size: n1\-standard\-1
  location: europe\-west1\-b
  network: default
  subnetwork: default
  labels: \(aq{\(dqname\(dq: \(dqmyinstance\(dq}\(aq
  tags: \(aq[\(dqone\(dq, \(dqtwo\(dq, \(dqthree\(dq]\(aq
  metadata: \(aq{\(dqone\(dq: \(dq1\(dq, \(dq2\(dq: \(dqtwo\(dq}\(aq
  use_persistent_disk: True
  delete_boot_pd: False
  deploy: True
  make_master: False
  provider: gce\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The profile can be realized now with a salt command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p my\-gce\-profile gce\-instance
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will create an salt minion instance named \fBgce\-instance\fP in GCE.  If
the command was executed on the salt\-master, its Salt key will automatically
be signed on the master.
.sp
Once the instance has been created with a salt\-minion installed, connectivity to
it can be verified with Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt gce\-instance test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.SS GCE Specific Settings
.sp
Consult the sample profile below for more information about GCE specific
settings. Some of them are mandatory and are properly labeled below but
typically also include a hard\-coded default.
.SS Initial Profile
.sp
Set up an initial profile at \fB/etc/salt/cloud.profiles\fP or
\fB/etc/salt/cloud.profiles.d/gce.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-gce\-profile:
  image: centos\-6
  size: n1\-standard\-1
  location: europe\-west1\-b
  network: default
  subnetwork: default
  labels: \(aq{\(dqname\(dq: \(dqmyinstance\(dq}\(aq
  tags: \(aq[\(dqone\(dq, \(dqtwo\(dq, \(dqthree\(dq]\(aq
  metadata: \(aq{\(dqone\(dq: \(dq1\(dq, \(dq2\(dq: \(dqtwo\(dq}\(aq
  use_persistent_disk: True
  delete_boot_pd: False
  ssh_interface: public_ips
  external_ip: \(dqephemeral\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS image
.sp
Image is used to define what Operating System image should be used
to for the instance. Examples are Debian 7 (wheezy) and CentOS 6. Required.
.SS size
.sp
A \(aqsize\(aq, in GCE terms, refers to the instance\(aqs \(aqmachine type\(aq. See
the on\-line documentation for a complete list of GCE machine types. Required.
.SS location
.sp
A \(aqlocation\(aq, in GCE terms, refers to the instance\(aqs \(aqzone\(aq. GCE
has the notion of both Regions (e.g. us\-central1, europe\-west1, etc)
and Zones (e.g. us\-central1\-a, us\-central1\-b, etc). Required.
.SS network
.sp
Use this setting to define the network resource for the instance.
All GCE projects contain a network named \(aqdefault\(aq but it\(aqs possible
to use this setting to create instances belonging to a different
network resource.
.SS subnetwork
.sp
Use this setting to define the subnetwork an instance will be created in.
This requires that the network your instance is created under has a mode of \(aqcustom\(aq or \(aqauto\(aq.
Additionally, the subnetwork your instance is created under is associated with the location you provide.
.sp
New in version 2017.7.0.

.SS labels
.sp
This setting allows you to set labels on your GCE instances. It
should be a dictionary and must be parse\-able by the python
ast.literal_eval() function to convert it to a python dictionary.
.sp
New in version 3006.

.SS tags
.sp
GCE supports instance/network tags and this setting allows you to
set custom tags. It should be a list of strings and must be
parse\-able by the python ast.literal_eval() function to convert it
to a python list.
.SS metadata
.sp
GCE supports instance metadata and this setting allows you to
set custom metadata. It should be a hash of key/value strings and
parse\-able by the python ast.literal_eval() function to convert it
to a python dictionary.
.SS use_persistent_disk
.sp
Use this setting to ensure that when new instances are created,
they will use a persistent disk to preserve data between instance
terminations and re\-creations.
.SS delete_boot_pd
.sp
In the event that you wish the boot persistent disk to be permanently
deleted when you destroy an instance, set delete_boot_pd to True.
.SS ssh_interface
.sp
New in version 2015.5.0.

.sp
Specify whether to use public or private IP for deploy script.
.sp
Valid options are:
.INDENT 0.0
.IP \(bu 2
private_ips: The salt\-master is also hosted with GCE
.IP \(bu 2
public_ips: The salt\-master is hosted outside of GCE
.UNINDENT
.SS external_ip
.sp
Per instance setting: Used a named fixed IP address to this host.
.sp
Valid options are:
.INDENT 0.0
.IP \(bu 2
ephemeral: The host will use a GCE ephemeral IP
.IP \(bu 2
None: No external IP will be configured on this host.
.UNINDENT
.sp
Optionally, pass the name of a GCE address to use a fixed IP address.
If the address does not already exist, it will be created.
.SS ex_disk_type
.sp
GCE supports two different disk types, \fBpd\-standard\fP and \fBpd\-ssd\fP\&.
The default disk type setting is \fBpd\-standard\fP\&. To specify using an SSD
disk, set \fBpd\-ssd\fP as the value.
.sp
New in version 2014.7.0.

.SS ip_forwarding
.sp
GCE instances can be enabled to use IP Forwarding. When set to \fBTrue\fP,
this options allows the instance to send/receive non\-matching src/dst
packets. Default is \fBFalse\fP\&.
.sp
New in version 2015.8.1.

.SS Profile with scopes
.sp
Scopes can be specified by setting the optional \fBex_service_accounts\fP
key in your cloud profile. The following example enables the bigquery scope.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-gce\-profile:
 image: centos\-6
  ssh_username: salt
  size: f1\-micro
  location: us\-central1\-a
  network: default
  subnetwork: default
  labels: \(aq{\(dqname\(dq: \(dqmyinstance\(dq}\(aq
  tags: \(aq[\(dqone\(dq, \(dqtwo\(dq, \(dqthree\(dq]\(aq
  metadata: \(aq{\(dqone\(dq: \(dq1\(dq, \(dq2\(dq: \(dqtwo\(dq,
              \(dqsshKeys\(dq: \(dq\(dq}\(aq
  use_persistent_disk: True
  delete_boot_pd: False
  deploy: False
  make_master: False
  provider: gce\-config
  ex_service_accounts:
    \- scopes:
      \- bigquery
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Email can also be specified as an (optional) parameter.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-gce\-profile:
\&...snip
  ex_service_accounts:
    \- scopes:
      \- bigquery
      email: default
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There can be multiple entries for scopes since \fBex\-service_accounts\fP accepts
a list of dictionaries. For more information refer to the libcloud documentation
on \fI\%specifying service account scopes\fP\&.
.SS SSH Remote Access
.sp
GCE instances do not allow remote access to the root user by default.
Instead, another user must be used to run the deploy script using sudo.
Append something like this to \fB/etc/salt/cloud.profiles\fP or
\fB/etc/salt/cloud.profiles.d/*.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-gce\-profile:
    ...

    # SSH to GCE instances as gceuser
    ssh_username: gceuser

    # Use the local private SSH key file located here
    ssh_keyfile: /etc/cloud/google_compute_engine
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you have not already used this SSH key to login to instances in this
GCE project you will also need to add the public key to your projects
metadata at \fI\%https://cloud.google.com/console\fP\&. You could also add it via
the metadata setting too:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-gce\-profile:
    ...

    metadata: \(aq{\(dqone\(dq: \(dq1\(dq, \(dq2\(dq: \(dqtwo\(dq,
                \(dqsshKeys\(dq: \(dqgceuser:ssh\-rsa <Your SSH Public Key> gceuser@host\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Single instance details
.sp
This action is a thin wrapper around \fB\-\-full\-query\fP, which displays details on a
single instance only. In an environment with several machines, this will save a
user from having to sort through all instance data, just to examine a single
instance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_instance myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Destroy, persistent disks, and metadata
.sp
As noted in the provider configuration, it\(aqs possible to force the boot
persistent disk to be deleted when you destroy the instance.  The way that
this has been implemented is to use the instance metadata to record the
cloud profile used when creating the instance.  When \fBdestroy\fP is called,
if the instance contains a \fBsalt\-cloud\-profile\fP key, it\(aqs value is used
to reference the matching profile to determine if \fBdelete_boot_pd\fP is
set to \fBTrue\fP\&.
.sp
Be aware that any GCE instances created with salt cloud will contain this
custom \fBsalt\-cloud\-profile\fP metadata entry.
.SS List various resources
.sp
It\(aqs also possible to list several GCE resources similar to what can be done
with other providers.  The following commands can be used to list GCE zones
(locations), machine types (sizes), and images.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations gce
salt\-cloud \-\-list\-sizes gce
salt\-cloud \-\-list\-images gce
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Persistent Disk
.sp
The Compute Engine provider provides functions via salt\-cloud to manage your
Persistent Disks. You can create and destroy disks as well as attach and
detach them from running instances.
.SS Create
.sp
When creating a disk, you can create an empty disk and specify its size (in
GB), or specify either an \(aqimage\(aq or \(aqsnapshot\(aq.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_disk gce disk_name=pd location=us\-central1\-b size=200
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Delete
.sp
Deleting a disk only requires the name of the disk to delete
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_disk gce disk_name=old\-backup
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Attach
.sp
Attaching a disk to an existing instance is really an \(aqaction\(aq and requires
both an instance name and disk name. It\(aqs possible to use this ation to
create bootable persistent disks if necessary. Compute Engine also supports
attaching a persistent disk in READ_ONLY mode to multiple instances at the
same time (but then cannot be attached in READ_WRITE to any instance).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a attach_disk myinstance disk_name=pd mode=READ_WRITE boot=yes
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Detach
.sp
Detaching a disk is also an action against an instance and only requires
the name of the disk. Note that this does \fInot\fP safely sync and umount the
disk from the instance. To ensure no data loss, you must first make sure the
disk is unmounted from the instance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a detach_disk myinstance disk_name=pd
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Show disk
.sp
It\(aqs also possible to look up the details for an existing disk with either
a function or an action.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_disk myinstance disk_name=pd
salt\-cloud \-f show_disk gce disk_name=pd
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Create snapshot
.sp
You can take a snapshot of an existing disk\(aqs content. The snapshot can then
in turn be used to create other persistent disks. Note that to prevent data
corruption, it is strongly suggested that you unmount the disk prior to
taking a snapshot. You must name the snapshot and provide the name of the
disk.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_snapshot gce name=backup\-20140226 disk_name=pd
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Delete snapshot
.sp
You can delete a snapshot when it\(aqs no longer needed by specifying the name
of the snapshot.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_snapshot gce name=backup\-20140226
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Show snapshot
.sp
Use this function to look up information about the snapshot.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_snapshot gce name=backup\-20140226
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Networking
.sp
Compute Engine supports multiple private networks per project. Instances
within a private network can easily communicate with each other by an
internal DNS service that resolves instance names. Instances within a private
network can also communicate with either directly without needing special
routing or firewall rules even if they span different regions/zones.
.sp
Networks also support custom firewall rules. By default, traffic between
instances on the same private network is open to all ports and protocols.
Inbound SSH traffic (port 22) is also allowed but all other inbound traffic
is blocked.
.SS Create network
.sp
New networks require a name and CIDR range if they don\(aqt have a \(aqmode\(aq.
Optionally, \(aqmode\(aq can be provided. Supported modes are \(aqauto\(aq, \(aqcustom\(aq, \(aqlegacy\(aq.
Optionally, \(aqdescription\(aq can be provided to add an extra note to your network.
New instances can be created and added to this network by setting the network name during create. It is
not possible to add/remove existing instances to a network.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_network gce name=mynet cidr=10.10.10.0/24
salt\-cloud \-f create_network gce name=mynet mode=auto description=some optional info.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2017.7.0.

.SS Destroy network
.sp
Destroy a network by specifying the name. If a resource is currently using
the target network an exception will be raised.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_network gce name=mynet
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Show network
.sp
Specify the network name to view information about the network.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_network gce name=mynet
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Create subnetwork
.sp
New subnetworks require a name, region, and CIDR range.
Optionally, \(aqdescription\(aq can be provided to add an extra note to your subnetwork.
New instances can be created and added to this subnetwork by setting the subnetwork name during create. It is
not possible to add/remove existing instances to a subnetwork.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_subnetwork gce name=mynet network=mynet region=us\-central1 cidr=10.0.10.0/24
salt\-cloud \-f create_subnetwork gce name=mynet network=mynet region=us\-central1 cidr=10.10.10.0/24 description=some info about my subnet.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.SS Destroy subnetwork
.sp
Destroy a subnetwork by specifying the name and region. If a resource is currently using
the target subnetwork an exception will be raised.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_subnetwork gce name=mynet region=us\-central1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.SS Show subnetwork
.sp
Specify the subnetwork name to view information about the subnetwork.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_subnetwork gce name=mynet
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.SS Create address
.sp
Create a new named static IP address in a region.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_address gce name=my\-fixed\-ip region=us\-central1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Delete address
.sp
Delete an existing named fixed IP address.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_address gce name=my\-fixed\-ip region=us\-central1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Show address
.sp
View details on a named address.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_address gce name=my\-fixed\-ip region=us\-central1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Create firewall
.sp
You\(aqll need to create custom firewall rules if you want to allow other traffic
than what is described above. For instance, if you run a web service on
your instances, you\(aqll need to explicitly allow HTTP and/or SSL traffic.
The firewall rule must have a name and it will use the \(aqdefault\(aq network
unless otherwise specified with a \(aqnetwork\(aq attribute. Firewalls also support
instance tags for source/destination
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_fwrule gce name=web allow=tcp:80,tcp:443,icmp
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Delete firewall
.sp
Deleting a firewall rule will prevent any previously allowed traffic for the
named firewall rule.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_fwrule gce name=web
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Show firewall
.sp
Use this function to review an existing firewall rule\(aqs information.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_fwrule gce name=web
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Load Balancer
.sp
Compute Engine possess a load\-balancer feature for splitting traffic across
multiple instances. Please reference the
\fI\%documentation\fP
for a more complete description.
.sp
The load\-balancer functionality is slightly different than that described
in Google\(aqs documentation.  The concept of \fITargetPool\fP and \fIForwardingRule\fP
are consolidated in salt\-cloud/libcloud.  HTTP Health Checks are optional.
.SS HTTP Health Check
.sp
HTTP Health Checks can be used as a means to toggle load\-balancing across
instance members, or to detect if an HTTP site is functioning.  A common
use\-case is to set up a health check URL and if you want to toggle traffic
on/off to an instance, you can temporarily have it return a non\-200 response.
A non\-200 response to the load\-balancer\(aqs health check will keep the LB from
sending any new traffic to the \(dqdown\(dq instance.  Once the instance\(aqs
health check URL beings returning 200\-responses, the LB will again start to
send traffic to it. Review Compute Engine\(aqs documentation for allowable
parameters.  You can use the following salt\-cloud functions to manage your
HTTP health checks.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_hc gce name=myhc path=/ port=80
salt\-cloud \-f delete_hc gce name=myhc
salt\-cloud \-f show_hc gce name=myhc
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Load\-balancer
.sp
When creating a new load\-balancer, it requires a name, region, port range,
and list of members. There are other optional parameters for protocol,
and list of health checks. Deleting or showing details about the LB only
requires the name.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_lb gce name=lb region=... ports=80 members=w1,w2,w3
salt\-cloud \-f delete_lb gce name=lb
salt\-cloud \-f show_lb gce name=lb
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also create a load balancer using a named fixed IP addressby specifying the name of the address.
If the address does not exist yet it will be created.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_lb gce name=my\-lb region=us\-central1 ports=234 members=s1,s2,s3 address=my\-lb\-ip
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Attach and Detach LB
.sp
It is possible to attach or detach an instance from an existing load\-balancer.
Both the instance and load\-balancer must exist before using these functions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f attach_lb gce name=lb member=w4
salt\-cloud \-f detach_lb gce name=lb member=oops
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Getting Started With HP Cloud
.sp
HP Cloud is a major public cloud platform and uses the libcloud
\fIopenstack\fP driver. The current version of OpenStack that HP Cloud
uses is Havana. When an instance is booted, it must have a
floating IP added to it in order to connect to it and further below
you will see an example that adds context to this statement.
.SS Set up a cloud provider configuration file
.sp
To use the \fIopenstack\fP driver for HP Cloud, set up the cloud
provider configuration file as in the example shown below:
.sp
\fB/etc/salt/cloud.providers.d/hpcloud.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hpcloud\-config:
  # Set the location of the salt\-master
  #
  minion:
    master: saltmaster.example.com

  # Configure HP Cloud using the OpenStack plugin
  #
  identity_url: https://region\-b.geo\-1.identity.hpcloudsvc.com:35357/v2.0/tokens
  compute_name: Compute
  protocol: ipv4

  # Set the compute region:
  #
  compute_region: region\-b.geo\-1

  # Configure HP Cloud authentication credentials
  #
  user: myname
  tenant: myname\-project1
  password: xxxxxxxxx

  # keys to allow connection to the instance launched
  #
  ssh_key_name: yourkey
  ssh_key_file: /path/to/key/yourkey.priv

  driver: openstack
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The subsequent example that follows is using the openstack driver.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Compute Region
.sp
Originally, HP Cloud, in its OpenStack Essex version (1.0), had 3
availability zones in one region, US West (region\-a.geo\-1), which
each behaved each as a region.
.sp
This has since changed, and the current OpenStack Havana version of
HP Cloud (1.1) now has simplified this and now has two regions to choose from:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
region\-a.geo\-1 \-> US West
region\-b.geo\-1 \-> US East
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Authentication
.sp
The \fBuser\fP is the same user as is used to log into the HP Cloud management
UI. The \fBtenant\fP can be found in the upper left under \(dqProject/Region/Scope\(dq.
It is often named the same as \fBuser\fP albeit with a \fB\-project1\fP appended.
The \fBpassword\fP is of course what you created your account with. The management
UI also has other information such as being able to select US East or US West.
.SS Set up a cloud profile config file
.sp
The profile shown below is a know working profile for an Ubuntu instance. The
profile configuration file is stored in the following location:
.sp
\fB/etc/salt/cloud.profiles.d/hp_ae1_ubuntu.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hp_ae1_ubuntu:
    provider: hp_ae1
    image: 9302692b\-b787\-4b52\-a3a6\-daebb79cb498
    ignore_cidr: 10.0.0.1/24
    networks:
      \- floating: Ext\-Net
    size: standard.small
    ssh_key_file: /root/keys/test.key
    ssh_key_name: test
    ssh_username: ubuntu
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Some important things about the example above:
.INDENT 0.0
.IP \(bu 2
The \fBimage\fP parameter can use either the image name or image ID which you can obtain by running in the example below (this case US East):
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-images hp_ae1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
The parameter \fBignore_cidr\fP specifies a range of addresses to ignore when trying to connect to the instance. In this case, it\(aqs the range of IP addresses used for an private IP of the instance.
.IP \(bu 2
The parameter \fBnetworks\fP is very important to include. In previous versions of Salt Cloud, this is what made it possible for salt\-cloud to be able to attach a floating IP to the instance in order to connect to the instance and set up the minion. The current version of salt\-cloud doesn\(aqt require it, though having it is of no harm either. Newer versions of salt\-cloud will use this, and without it, will attempt to find a list of floating IP addresses to use regardless.
.IP \(bu 2
The \fBssh_key_file\fP and \fBssh_key_name\fP are the keys that will make it possible to connect to the instance to set up the minion
.IP \(bu 2
The \fBssh_username\fP parameter, in this case, being that the image used will be ubuntu, will make it possible to not only log in but install the minion
.UNINDENT
.SS Launch an instance
.sp
To instantiate a machine based on this profile (example):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-p hp_ae1_ubuntu ubuntu_instance_1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
After several minutes, this will create an instance named ubuntu_instance_1
running in HP Cloud in the US East region and will set up the minion and then
return information about the instance once completed.
.SS Manage the instance
.sp
Once the instance has been created with salt\-minion installed, connectivity to
it can be verified with Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt ubuntu_instance_1 ping
.ft P
.fi
.UNINDENT
.UNINDENT
.SS SSH to the instance
.sp
Additionally, the instance can be accessed via SSH using the floating IP assigned to it
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# ssh ubuntu@<floating ip>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Using a private IP
.sp
Alternatively, in the cloud profile, using the private IP to log into the instance to set up the minion is another option, particularly if salt\-cloud is running within the cloud on an instance that is on the same network with all the other instances (minions)
.sp
The example below is a modified version of the previous example. Note the use of \fBssh_interface\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hp_ae1_ubuntu:
    provider: hp_ae1
    image: 9302692b\-b787\-4b52\-a3a6\-daebb79cb498
    size: standard.small
    ssh_key_file: /root/keys/test.key
    ssh_key_name: test
    ssh_username: ubuntu
    ssh_interface: private_ips
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With this setup, salt\-cloud will use the private IP address to ssh into the instance and set up the salt\-minion
.SS Getting Started With Joyent
.sp
Joyent is a public cloud host that supports SmartOS, Linux, FreeBSD, and
Windows.
.SS Dependencies
.sp
This driver requires the Python \fBrequests\fP library to be installed.
.SS Configuration
.sp
The Joyent cloud requires three configuration parameters. The user name and
password that are used to log into the Joyent system, and the location of the
private ssh key associated with the Joyent account. The ssh key is needed to
send the provisioning commands up to the freshly created virtual machine.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example is for /etc/salt/cloud.providers or any file in the
# /etc/salt/cloud.providers.d/ directory.

my\-joyent\-config:
  driver: joyent
  user: fred
  password: saltybacon
  private_key: /root/mykey.pem
  keyname: mykey
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Profiles
.SS Cloud Profiles
.sp
Set up an initial profile at \fB/etc/salt/cloud.profiles\fP or in the
\fB/etc/salt/cloud.profiles.d/\fP directory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
joyent_512:
  provider: my\-joyent\-config
  size: g4\-highcpu\-512M
  image: ubuntu\-16.04
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Sizes can be obtained using the \fB\-\-list\-sizes\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-sizes my\-joyent\-config
my\-joyent\-config:
    \-\-\-\-\-\-\-\-\-\-
    joyent:
        \-\-\-\-\-\-\-\-\-\-
        g4\-highcpu\-512M:
            \-\-\-\-\-\-\-\-\-\-
            default:
                False
            description:
                Compute Optimized 512M RAM \- 1 vCPU \- 10 GB Disk
            disk:
                10240
            group:
                Compute Optimized
            id:
                14aea8fc\-d0f8\-11e5\-bfe4\-a7458dbc6c99
            lwps:
                4000
            memory:
                512
            name:
                g4\-highcpu\-512M
            swap:
                2048
            vcpus:
                0
            version:
                1.0.3
\&...SNIP...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Images can be obtained using the \fB\-\-list\-images\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-images my\-joyent\-config
my\-joyent\-config:
    \-\-\-\-\-\-\-\-\-\-
    joyent:
        \-\-\-\-\-\-\-\-\-\-
        base:
            \-\-\-\-\-\-\-\-\-\-
            description:
                A 32\-bit SmartOS image with just essential packages
                installed. Ideal for users who are comfortabl e with
                setting up their own environment and tools.
            files:
                |_
                  \-\-\-\-\-\-\-\-\-\-
                  compression:
                      gzip
                  sha1:
                      b00a77408ddd9aeac85085b68b1cd22a07353956
                  size:
                      106918297
            homepage:
                http://wiki.joyent.com/jpc2/Base+Instance
            id:
                00aec452\-6e81\-11e4\-8474\-ebfec9a1a911
            name:
                base
            os:
                smartos
            owner:
                9dce1460\-0c4c\-4417\-ab8b\-25ca478c5a78
            public:
                True
            published_at:
                2014\-11\-17T17:41:46Z
            requirements:
                \-\-\-\-\-\-\-\-\-\-
            state:
                active
            type:
                smartmachine
            version:
                14.3.0

\&...SNIP...
.ft P
.fi
.UNINDENT
.UNINDENT
.SS SmartDataCenter
.sp
This driver can also be used with the Joyent SmartDataCenter project. More
details can be found at:
.sp
Using SDC requires that an api_host_suffix is set. The default value for this is
\fI\&.api.joyentcloud.com\fP\&. All characters, including the leading \fI\&.\fP, should be
included:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
api_host_suffix: .api.myhostname.com
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Miscellaneous Configuration
.sp
The following configuration items can be set in either \fBprovider\fP or
\fBprofile\fP configuration files.
.SS use_ssl
.sp
When set to \fBTrue\fP (the default), attach \fBhttps://\fP to any URL that does not
already have \fBhttp://\fP or \fBhttps://\fP included at the beginning. The best
practice is to leave the protocol out of the URL, and use this setting to manage
it.
.SS verify_ssl
.sp
When set to \fBTrue\fP (the default), the underlying web library will verify the
SSL certificate. This should only be set to \fBFalse\fP for debugging.\(ga
.SS Getting Started With Libvirt
.sp
Libvirt is a toolkit to interact with the virtualization capabilities of recent versions
of Linux (and other OSes). This driver Salt cloud provider is currently geared towards
libvirt with qemu\-kvm.
.sp
\fI\%https://libvirt.org/\fP
.SS Host Dependencies
.INDENT 0.0
.IP \(bu 2
libvirt >= 1.2.18 (older might work)
.UNINDENT
.SS Salt\-Cloud Dependencies
.INDENT 0.0
.IP \(bu 2
libvirt\-python
.UNINDENT
.SS Provider Configuration
.sp
For every KVM host a provider needs to be set up. The provider currently maps to one libvirt daemon (e.g. one KVM host).
.sp
Set up the provider cloud configuration file at \fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/*.conf\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Set up a provider with qemu+ssh protocol
kvm\-via\-ssh:
  driver: libvirt
  url: qemu+ssh://user@kvm.company.com/system?socket=/var/run/libvirt/libvirt\-sock

# Or connect to a local libvirt instance
local\-kvm:
  driver: libvirt
  url: qemu:///system
  # work around flag for XML validation errors while cloning
  validate_xml: no
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Cloud Profiles
.sp
Virtual machines get cloned from so called Cloud Profiles. Profiles can be set up at \fB/etc/salt/cloud.profiles\fP or
\fB/etc/salt/cloud.profiles.d/*.conf\fP:
.INDENT 0.0
.IP \(bu 2
Configure a profile to be used:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
centos7:
  # points back at provider configuration
  provider: local\-kvm
  base_domain: base\-centos7\-64
  ip_source: ip\-learning
  ssh_username: root
  password: my\-very\-secret\-password
  # /tmp is mounted noexec.. do workaround
  deploy_command: sh /tmp/.saltcloud/deploy.sh
  script_args: \-F
  # grains to add to the minion
  grains:
    clones\-are\-awesome: true
  # override minion settings
  minion:
    master: 192.168.16.1
    master_port: 5506
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The profile can be realized now with a salt command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p centos7 my\-centos7\-clone
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will create an instance named \fBmy\-centos7\-clone\fP on the cloud host. Also
the minion id will be set to \fBmy\-centos7\-clone\fP\&.
.sp
If the command was executed on the salt\-master, its Salt key will automatically
be accepted on the master.
.sp
Once the instance has been created with salt\-minion installed, connectivity to
it can be verified with Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt my\-centos7\-clone test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Required Settings
.sp
The following settings are always required for libvirt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
centos7:
  provider: local\-kvm
  # the domain to clone
  base_domain: base\-centos7\-64
.ft P
.fi
.UNINDENT
.UNINDENT
.SS SSH Key Authentication
.sp
Instead of specifying a password, an authorized key can be used for the minion setup. Ensure that
the ssh user of your base image has the public key you want to use in ~/.ssh/authorized_keys.  If
you want to use a non\-root user you will likely want to configure salt\-cloud to use sudo.
.sp
An example using root:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
centos7:
  provider: local\-kvm
  # the domain to clone
  base_domain: base\-centos7\-64
  ssh_username: root
  private_key: /path/to/private/key
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
An example using a non\-root user:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
centos7:
  provider: local\-kvm
  # the domain to clone
  base_domain: base\-centos7\-64
  ssh_username: centos
  private_key: /path/to/private/key
  sudo: True
  sudo_password: \(dq\-\-redacted\-\-\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Optional Settings
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
centos7:
  # ssh settings
  # use forwarded agent instead of a local key
  ssh_agent: True
  ssh_port: 4910

  # credentials
  ssh_username: root
  # password will be used for sudo if defined, use sudo_password if using ssh keys
  password: my\-secret\-password
  private_key: /path/to/private/key
  sudo: True
  sudo_password: \(dq\-\-redacted\-\-\(dq

  # bootstrap options
  deploy_command: sh /tmp/.saltcloud/deploy.sh
  script_args: \-F

  # minion config
  grains:
    sushi: more tasty
  # point at the another master at another port
  minion:
    master: 192.168.16.1
    master_port: 5506

  # libvirt settings
  # clone_strategy: [ quick | full ] # default is full
  clone_strategy: quick
  # ip_source: [ ip\-learning | qemu\-agent ] # default is ip\-learning
  ip_source: qemu\-agent
  # validate_xml: [ false | true ] # default is true
  validate_xml: false
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBclone_strategy\fP controls how the clone is done. In case of \fBfull\fP the disks
are copied creating a standalone clone. If \fBquick\fP is used the disks of the base domain
are used as backing disks for the clone. This results in nearly instantaneous clones at
the expense of slower write performance. The quick strategy has a number of requirements:
.INDENT 0.0
.IP \(bu 2
The disks must be of type qcow2
.IP \(bu 2
The base domain must be turned off
.IP \(bu 2
The base domain must not change after creating the clone
.UNINDENT
.sp
The \fBip_source\fP setting controls how the IP address of the cloned instance is determined.
When using \fBip\-learning\fP the IP is requested from libvirt. This needs a recent libvirt
version and may only work for NAT/routed networks where libvirt runs the dhcp server.
Another option is to use \fBqemu\-agent\fP this requires that the qemu\-agent is installed and
configured to run at startup in the base domain.
.sp
The \fBvalidate_xml\fP setting is available to disable xml validation by libvirt when cloning.
.sp
See also \fI\%salt.cloud.clouds.libvirt\fP
.SS Getting Started With Linode
.sp
Linode is a public cloud host with a focus on Linux instances.
.SS Dependencies
.sp
This driver requires the Python \fBrequests\fP library to be installed.
.SS Provider Configuration
.SS Configuration Options
.INDENT 0.0
.TP
.B \fBapikey\fP
\fB(Required)\fP The key to use to authenticate with the Linode API.
.TP
.B \fBpassword\fP
\fB(Required)\fP The default password to set on new VMs. Must be 8 characters with at least one lowercase, uppercase, and numeric.
.TP
.B \fBpoll_interval\fP
The rate of time in milliseconds to poll the Linode API for changes. Defaults to \fB500\fP\&.
.TP
.B \fBratelimit_sleep\fP
The time in seconds to wait before retrying after a ratelimit has been enforced. Defaults to \fB0\fP\&.
.UNINDENT
.SS Example Configuration
.sp
Set up the provider cloud configuration file at \fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/*.conf\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-linode\-provider:
    driver: linode
    apikey: f4ZsmwtB1c7f85Jdu43RgXVDFlNjuJaeIYV8QMftTqKScEB2vSosFSr...
    password: F00barbazverylongp@ssword
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Profile Configuration
.SS Configuration Options
.INDENT 0.0
.TP
.B \fBimage\fP
\fB(Required)\fP The image to deploy the boot disk from. This should be an image ID
(e.g. \fBlinode/ubuntu22.04\fP); official images start with \fBlinode/\fP\&.
.TP
.B \fBlocation\fP
\fB(Required)\fP The location of the VM. This should be a Linode region
(e.g. \fBus\-east\fP). See \fI\%the list of locations\fP and
\fI\%the guide to choose a location\fP
for more options.
.TP
.B \fBsize\fP
\fB(Required)\fP The size of the VM. This should be a Linode instance type ID
(e.g. \fBg6\-standard\-2\fP). See \fI\%the list of sizes\fP and
\fI\%the guide to choose a size\fP
for more options.
.TP
.B \fBpassword\fP (overrides provider)
\fB(*Required)\fP The default password for the VM. Must be provided at the profile
or provider level.
.TP
.B \fBassign_private_ip\fP
New in version 2016.3.0.

.sp
\fB(optional)\fP Whether or not to assign a private IP to the VM. Defaults to \fBFalse\fP\&.
.TP
.B \fBbackups_enabled\fP
\fB(optional)\fP Whether or not to enable the backup for this VM. Backup can be
configured in your Linode account Defaults to \fBFalse\fP\&.
.TP
.B \fBcloneform\fP
\fB(optional)\fP The name of the Linode to clone from.
.TP
.B \fBssh_interface\fP
New in version 2016.3.0.

.sp
\fB(optional)\fP The interface with which to connect over SSH. Valid options are \fBprivate_ips\fP or
\fBpublic_ips\fP\&. Defaults to \fBpublic_ips\fP\&.
.sp
If specifying \fBprivate_ips\fP, the Linodes must be hosted within the same data center
and have the Network Helper enabled on your entire account. The instance that is
running the Salt\-Cloud provisioning command must also have a private IP assigned to it.
.sp
Newer accounts created on Linode have the Network Helper setting enabled by default,
account\-wide. Legacy accounts do not have this setting enabled by default. To enable
the Network Helper on your Linode account, please see \fI\%Linode\(aqs Network Helper\fP
documentation.
.TP
.B \fBssh_pubkey\fP
\fB(optional)\fP The public key to authorize for SSH with the VM.
.TP
.B \fBswap\fP
\fB(optional)\fP The amount of disk space to allocate for the swap partition. Defaults to \fB256\fP\&.
.UNINDENT
.SS Example Configuration
.sp
Set up a profile configuration at \fB/etc/salt/cloud.profiles\fP or \fB/etc/salt/cloud.profiles.d/*.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-linode\-profile:
    provider: my\-linode\-provider
    size: g6\-standard\-1
    image: linode/ubuntu22.04
    location: us\-east
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBmy\-linode\-profile\fP can be realized now with a salt command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p my\-linode\-profile my\-linode\-instance
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will create a salt minion instance named \fBmy\-linode\-instance\fP in Linode. If the command was
executed on the salt\-master, its Salt key will automatically be signed on the master.
.sp
Once the instance has been created with a salt\-minion installed, connectivity to
it can be verified with Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt my\-linode\-instance test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A more advanced configuration utlizing all of the configuration options might look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-linode\-profile\-advanced:
    provider: my\-linode\-provider
    size: g6\-standard\-1
    image: linode/ubuntu22.04
    location: us\-central
    password: iamaverylongp@ssword
    assign_private_ip: true
    ssh_interface: private_ips
    ssh_pubkey: ssh\-rsa AAAAB3NzaC1yc2EAAAADAQAB...
    swap_size: 512
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Migrating to APIv4
.sp
Linode APIv3 has been removed, and APIv4 is the only available version.
.sp
When switching to APIv4, you will also need to generate a new token. See
\fI\%here\fP
for more information.
.SS Notable Changes
.sp
\fBMove from label references to ID references.\fP The profile configuration parameters \fBlocation\fP,
\fBsize\fP, and \fBimage\fP have moved from accepting label based references to IDs. See the
\fI\%profile configuration\fP section for more details.
.sp
\fBThe \(ga\(gadisk_size\(ga\(ga profile configuration parameter has been removed.\fP The parameter will not be taken into
account when creating new VMs while targeting APIv4. See the \fBdisk_size\fP description under the
\fI\%profile configuration\fP section for more details.
.sp
\fBThe \(ga\(gaboot\(ga\(ga function no longer requires a \(ga\(gaconfig_id\(ga\(ga.\fP A config can be inferred by the API instead when booting.
.sp
\fBThe \(ga\(gaclone\(ga\(ga function has renamed parameters to match convention.\fP The old version of these parameters are no longer
supported.
* \fBdatacenter_id\fP has been removed and replaced by \fBlocation\fP\&.
* \fBplan_id\fP has been removed and replaced by \fBsize\fP\&.
.sp
\fBThe \(ga\(gaget_plan_id\(ga\(ga function has been removed and is not supported by APIv4.\fP IDs are now the only way
of referring to a \(dqplan\(dq (or type/size).
.SS Query Utilities
.SS Listing Sizes
.sp
Available sizes can be obtained by running one of:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-sizes my\-linode\-provider

salt\-cloud \-f avail_sizes my\-linode\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will list all Linode sizes/types which can be referenced in VM profiles.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-linode\-config:
    g6\-standard\-1:
        \-\-\-\-\-\-\-\-\-\-
        class:
            standard
        disk:
            51200
        gpus:
            0
        id:
            g6\-standard\-1
        label:
            Linode 2GB
        memory:
            2048
        network_out:
            2000
        price:
            \-\-\-\-\-\-\-\-\-\-
            hourly:
                0.015
            monthly:
                10.0
        successor:
            None
        transfer:
            2000
        vcpus:
            1
        addons:
            \-\-\-\-\-\-\-\-\-\-
            backups:
                \-\-\-\-\-\-\-\-\-\-
                price:
                    \-\-\-\-\-\-\-\-\-\-
                    hourly:
                        0.004
                    monthly:
                        2.5
\&...SNIP...
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Listing Images
.sp
Available images can be obtained by running one of:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images my\-linode\-provider

salt\-cloud \-f avail_images my\-linode\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will list all Linode images which can be referenced in VM profiles.
Official images are available under the \fBlinode\fP namespace.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-linode\-config:
    \-\-\-\-\-\-\-\-\-\-
    linode:
        \-\-\-\-\-\-\-\-\-\-
        linode/ubuntu22.04:
            \-\-\-\-\-\-\-\-\-\-
            created:
                2019\-06\-20T17:17:11
            created_by:
                linode
            deprecated:
                False
            description:
                None
            eol:
                2021\-05\-01T04:00:00
            expiry:
                None
            id:
                linode/ubuntu22.04
            is_public:
                True
            label:
                Alpine 3.10
            size:
                300
            type:
                manual
            vendor:
                Alpine
\&...SNIP...
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Listing Locations
.sp
Available locations can be obtained by running one of:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations my\-linode\-provider

salt\-cloud \-f avail_locations my\-linode\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will list all Linode regions which can be referenced in VM profiles.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-linode\-config:
    \-\-\-\-\-\-\-\-\-\-
    linode:
        \-\-\-\-\-\-\-\-\-\-
        us\-east:
            \-\-\-\-\-\-\-\-\-\-
            capabilities:
                \- Linodes
                \- NodeBalancers
                \- Block Storage
                \- Object Storage
                \- GPU Linodes
                \- Kubernetes
            country:
                us
            id:
                us\-east
            status:
                ok
\&...SNIP...
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Cloning
.sp
To clone a Linode, add a profile with a \fBclonefrom\fP key, and a \fBscript_args: \-C\fP\&.
\fBclonefrom\fP should be the name of the Linode that is the source for the clone.
\fBscript_args: \-C\fP passes a \-C to the salt\-bootstrap script, which only configures
the minion and doesn\(aqt try to install a new copy of salt\-minion. This way the minion
gets new keys and the keys get pre\-seeded on the master, and the \fB/etc/salt/minion\fP
file has the right minion \(aqid:\(aq declaration.
.sp
Cloning requires a post 2015\-02\-01 salt\-bootstrap.
.sp
It is safest to clone a stopped machine. To stop a machine run
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop machine_to_clone
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To create a new machine based on another machine, add an entry to your linode
cloud profile that looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
li\-clone:
  provider: my\-linode\-config
  clonefrom: machine_to_clone
  script_args: \-C \-F
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then run salt\-cloud as normal, specifying \fB\-p li\-clone\fP\&. The profile name can
be anything; It doesn\(aqt have to be \fBli\-clone\fP\&.
.sp
\fBclonefrom:\fP is the name of an existing machine in Linode from which to clone.
\fBScript_args: \-C \-F\fP is necessary to avoid re\-deploying Salt via salt\-bootstrap.
\fB\-C\fP will just re\-deploy keys so the new minion will not have a duplicate key
or minion_id on the Master, and \fB\-F\fP will force a rewrite of the Minion config
file on the new Minion. If \fB\-F\fP isn\(aqt provided, the new Minion will have the
\fBmachine_to_clone\fP\(aqs Minion ID, instead of its own Minion ID, which can cause
problems.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Pull Request #733\fP to the salt\-bootstrap repo makes the \fB\-F\fP argument
non\-necessary. Once that change is released into a stable version of the
Bootstrap Script, the \fB\-C\fP argument will be sufficient for the \fBscript_args\fP
setting.
.UNINDENT
.UNINDENT
.sp
If the \fBmachine_to_clone\fP does not have Salt installed on it, refrain from using
the \fBscript_args: \-C \-F\fP altogether, because the new machine will need to have
Salt installed.
.SS Getting Started With LXC
.sp
The LXC module is designed to install Salt in an LXC container on a controlled
and possibly remote minion.
.sp
In other words, Salt will connect to a minion, then from that minion:
.INDENT 0.0
.IP \(bu 2
Provision and configure a container for networking access
.IP \(bu 2
Use those modules to deploy salt and re\-attach to master.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fI\%lxc runner\fP
.IP \(bu 2
\fI\%lxc module\fP
.IP \(bu 2
\fI\%seed\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Limitations
.INDENT 0.0
.IP \(bu 2
You can only act on one minion and one provider at a time.
.IP \(bu 2
Listing images must be targeted to a particular LXC provider (nothing will be
outputted with \fBall\fP)
.UNINDENT
.SS Operation
.sp
Salt\(aqs LXC support does use \fI\%lxc.init\fP
via the \fI\%lxc.cloud_init_interface\fP
and seeds the minion via \fI\%seed.mkconfig\fP\&.
.sp
You can provide to those lxc VMs a profile and a network profile like if
you were directly using the minion module.
.sp
Order of operation:
.INDENT 0.0
.IP \(bu 2
Create the LXC container on the desired minion (clone or template)
.IP \(bu 2
Change LXC config options (if any need to be changed)
.IP \(bu 2
Start container
.IP \(bu 2
Change base passwords if any
.IP \(bu 2
Change base DNS configuration if necessary
.IP \(bu 2
Wait for LXC container to be up and ready for ssh
.IP \(bu 2
Test SSH connection and bailout in error
.IP \(bu 2
Upload deploy script and seeds, then re\-attach the minion.
.UNINDENT
.SS Provider configuration
.sp
Here is a simple provider configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example goes in /etc/salt/cloud.providers or any file in the
# /etc/salt/cloud.providers.d/ directory.
devhost10\-lxc:
  target: devhost10
  driver: lxc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Profile configuration
.sp
Please read \fI\%LXC Management with Salt\fP before anything else.
And specially \fI\%Profiles\fP\&.
.sp
Here are the options to configure your containers:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B target
Host minion id to install the lxc Container into
.TP
.B lxc_profile
Name of the profile or inline options for the LXC vm creation/cloning,
please see \fI\%Container Profiles\fP\&.
.TP
.B network_profile
Name of the profile or inline options for the LXC vm network settings,
please see \fI\%Network Profiles\fP\&.
.TP
.B nic_opts
Totally optional.
Per interface new\-style configuration options mappings which will
override any profile default option:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
eth0: {\(aqmac\(aq: \(aq00:16:3e:01:29:40\(aq,
              \(aqgateway\(aq: None, (default)
              \(aqlink\(aq: \(aqbr0\(aq, (default)
              \(aqgateway\(aq: None, (default)
              \(aqnetmask\(aq: \(aq\(aq, (default)
              \(aqip\(aq: \(aq22.1.4.25\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B password
password for root and sysadmin users
.TP
.B dnsservers
List of DNS servers to use. This is optional.
.TP
.B minion
minion configuration (see \fI\%Minion Configuration in Salt Cloud\fP)
.TP
.B bootstrap_delay
specify the time to wait (in seconds) between container creation
and salt bootstrap execution. It is useful to ensure that all essential services
have started before the bootstrap script is executed. By default there\(aqs no
wait time between container creation and bootstrap unless you are on systemd
where we wait that the system is no more in starting state.
.TP
.B bootstrap_shell
shell for bootstraping script (default: /bin/sh)
.TP
.B script
defaults to salt\-boostrap
.TP
.B script_args
arguments which are given to the bootstrap script.
the {0} placeholder will be replaced by the path which contains the
minion config and key files, eg:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
script_args=\(dq\-c {0}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Using profiles:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example would go in /etc/salt/cloud.profiles or any file in the
# /etc/salt/cloud.profiles.d/ directory.
devhost10\-lxc:
  provider: devhost10\-lxc
  lxc_profile: foo
  network_profile: bar
  minion:
    master: 10.5.0.1
    master_port: 4506
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using inline profiles (eg to override the network bridge):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
devhost11\-lxc:
  provider: devhost10\-lxc
  lxc_profile:
    clone_from: foo
  network_profile:
    etho:
      link: lxcbr0
  minion:
    master: 10.5.0.1
    master_port: 4506
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using a lxc template instead of a clone:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
devhost11\-lxc:
  provider: devhost10\-lxc
  lxc_profile:
    template: ubuntu
    # options:
    #   release: trusty
  network_profile:
    etho:
      link: lxcbr0
  minion:
    master: 10.5.0.1
    master_port: 4506
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Static ip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example would go in /etc/salt/cloud.profiles or any file in the
# /etc/salt/cloud.profiles.d/ directory.
devhost10\-lxc:
  provider: devhost10\-lxc
  nic_opts:
    eth0:
      ipv4: 10.0.3.9
  minion:
    master: 10.5.0.1
    master_port: 4506
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
DHCP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example would go in /etc/salt/cloud.profiles or any file in the
# /etc/salt/cloud.profiles.d/ directory.
devhost10\-lxc:
  provider: devhost10\-lxc
  minion:
    master: 10.5.0.1
    master_port: 4506
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Driver Support
.INDENT 0.0
.IP \(bu 2
Container creation
.IP \(bu 2
Image listing (LXC templates)
.IP \(bu 2
Running container information (IP addresses, etc.)
.UNINDENT
.SS Getting Started With 1and1
.sp
1&1 is one of the world’s leading Web hosting providers. 1&1 currently offers
a wide range of Web hosting products, including email solutions and high\-end
servers in 10 different countries including Germany, Spain, Great Britain
and the United States.  From domains to 1&1 MyWebsite to eBusiness solutions
like Cloud Hosting and Web servers for complex tasks, 1&1 is well placed to deliver
a high quality service to its customers. All 1&1 products are hosted in
1&1‘s high\-performance, green data centers in the USA and Europe.
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
1and1 >= 1.2.0
.UNINDENT
.SS Configuration
.INDENT 0.0
.IP \(bu 2
Using the new format, set up the cloud configuration at
\fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/oneandone.conf\fP:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-oneandone\-config:
  driver: oneandone

  # Set the location of the salt\-master
  #
  minion:
    master: saltmaster.example.com

  # Configure oneandone authentication credentials
  #
  api_token: <api_token>
  ssh_private_key: /path/to/id_rsa
  ssh_public_key: /path/to/id_rsa.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Authentication
.sp
The \fBapi_key\fP is used for API authorization. This token can be obtained
from the CloudPanel in the Management section below Users.
.SS Profiles
.sp
Here is an example of a profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
oneandone_fixed_size:
  provider: my\-oneandone\-config
  description: Small instance size server
  fixed_instance_size: S
  appliance_id: 8E3BAA98E3DFD37857810E0288DD8FBA

oneandone_custom_size:
  provider: my\-oneandone\-config
  description: Custom size server
  vcore: 2
  cores_per_processor: 2
  ram: 8
  appliance_id: 8E3BAA98E3DFD37857810E0288DD8FBA
  hdds:
  \-
    is_main: true
    size: 20
  \-
    is_main: false
    size: 20
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following list explains some of the important properties.
.INDENT 0.0
.TP
.B fixed_instance_size_id
When creating a server, either \fBfixed_instance_size_id\fP or custom hardware params
containing \fBvcore\fP, \fBcores_per_processor\fP, \fBram\fP, and \fBhdds\fP must be provided.
Can be one of the IDs listed among the output of the following command:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-sizes oneandone
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B vcore
Total amount of processors.
.TP
.B cores_per_processor
Number of cores per processor.
.TP
.B ram
RAM memory size in GB.
.TP
.B hdds
Hard disks.
.TP
.B appliance_id
ID of the image that will be installed on server.
Can be one of the IDs listed in the output of the following command:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images oneandone
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B datacenter_id
ID of the datacenter where the server will be created.
Can be one of the IDs listed in the output of the following command:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations oneandone
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B description
Description of the server.
.TP
.B password
Password of the server. Password must contain more than 8 characters
using uppercase letters, numbers and other special symbols.
.TP
.B power_on
Power on server after creation. Default is set to true.
.TP
.B firewall_policy_id
Firewall policy ID. If it is not provided, the server will assign
the best firewall policy, creating a new one if necessary. If the parameter
is sent with a 0 value, the server will be created with all ports blocked.
.TP
.B ip_id
IP address ID.
.TP
.B load_balancer_id
Load balancer ID.
.TP
.B monitoring_policy_id
Monitoring policy ID.
.TP
.B deploy
Set to False if Salt should not be installed on the node.
.TP
.B wait_for_timeout
The timeout to wait in seconds for provisioning resources such as servers.
The default wait_for_timeout is 15 minutes.
.TP
.B public_key_ids
List of public key IDs (ssh key).
.UNINDENT
.SS Functions
.INDENT 0.0
.IP \(bu 2
Create an SSH key
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo salt\-cloud \-f create_ssh_key my\-oneandone\-config name=\(aqSaltTest\(aq description=\(aqSaltTestDescription\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
Create a block storage
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo salt\-cloud \-f create_block_storage my\-oneandone\-config name=\(aqSaltTest2\(aq description=\(aqSaltTestDescription\(aq size=50 datacenter_id=\(aq5091F6D8CBFEF9C26ACE957C652D5D49\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For more information concerning cloud profiles, see \fI\%here\fP\&.
.SS Getting Started with OpenNebula
.sp
OpenNebula is an open\-source solution for the comprehensive management of virtualized data centers to enable the mixed
use of private, public, and hybrid IaaS clouds.
.SS Dependencies
.sp
The driver requires Python\(aqs \fBlxml\fP library to be installed. It also requires an OpenNebula installation running
version \fB4.12\fP or greater.
.SS Configuration
.sp
The following example illustrates some of the options that can be set. These parameters are discussed in more detail
below.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example is for /etc/salt/cloud.providers or any file in the
# /etc/salt/cloud.providers.d/ directory.

my\-opennebula\-provider:
  # Set up the location of the salt master
  #
  minion:
    master: saltmaster.example.com

  # Define xml_rpc setting which Salt\-Cloud uses to connect to the OpenNebula API. Required.
  #
  xml_rpc: http://localhost:2633/RPC2

  # Define the OpenNebula access credentials. This can be the main \(dqoneadmin\(dq user that OpenNebula uses as the
  # OpenNebula main admin, or it can be a user defined in the OpenNebula instance. Required.
  #
  user: oneadmin
  password: JHGhgsayu32jsa

  # Define the private key location that is used by OpenNebula to access new VMs. This setting is required if
  # provisioning new VMs or accessing VMs previously created with the associated public key.
  #
  private_key: /path/to/private/key

  driver: opennebula
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Access Credentials
.sp
The Salt Cloud driver for OpenNebula was written using OpenNebula\(aqs native XML RPC API. Every interaction with
OpenNebula\(aqs API requires a \fBusername\fP and \fBpassword\fP to make the connection from the machine running Salt Cloud
to API running on the OpenNebula instance. Based on the access credentials passed in, OpenNebula filters the commands
that the user can perform or the information for which the user can query. For example, the images that a user can
view with a \fB\-\-list\-images\fP command are the images that the connected user and the connected user\(aqs groups can access.
.SS Key Pairs
.sp
Salt Cloud needs to be able to access a virtual machine in order to install the Salt Minion by using a public/private
key pair. The virtual machine will need to be seeded with the public key, which is laid down by the OpenNebula
template. Salt Cloud then uses the corresponding private key, provided by the \fBprivate_key\fP setting in the cloud
provider file, to SSH into the new virtual machine.
.sp
To seed the virtual machine with the public key, the public key must be added to the OpenNebula template. If using the
OpenNebula web interface, navigate to the template, then click \fBUpdate\fP\&. Click the \fBContext\fP tab. Under the
\fBNetwork & SSH\fP section, click \fBAdd SSH Contextualization\fP and paste the public key in the \fBPublic Key\fP box.
Don\(aqt forget to save your changes by clicking the green \fBUpdate\fP button.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The key pair must not have a pass\-phrase.
.UNINDENT
.UNINDENT
.SS Cloud Profiles
.sp
Set up an initial profile at either \fB/etc/salt/cloud.profiles\fP or the \fB/etc/salt/cloud.profiles.d/\fP directory.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-opennebula\-profile:
  provider: my\-opennebula\-provider
  image: Ubuntu\-14.04
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The profile can now be realized with a salt command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p my\-opennebula\-profile my\-new\-vm
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will create a new instance named \fBmy\-new\-vm\fP in OpenNebula. The minion that is installed on this instance will
have a minion id of \fBmy\-new\-vm\fP\&. If the command was executed on the salt\-master, its Salt key will automatically be
signed on the master.
.sp
Once the instance has been created with salt\-minion installed, connectivity to it can be verified with Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt my\-new\-vm test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
OpenNebula uses an image \-\-> template \-\-> virtual machine paradigm where the template draws on the image, or disk,
and virtual machines are created from templates. Because of this, there is no need to define a \fBsize\fP in the cloud
profile. The size of the virtual machine is defined in the template.
.SS Change Disk Size
.sp
You can now change the size of a VM on creation by cloning an image and expanding the size. You can accomplish this by
the following cloud profile settings below.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-opennebula\-profile:
  provider: my\-opennebula\-provider
  image: Ubuntu\-14.04
  disk:
    disk0:
      disk_type: clone
      size: 8096
      image: centos7\-base\-image\-v2
    disk1:
      disk_type: volatile
      type: swap
      size: 4096
    disk2:
      disk_type: volatile
      size: 4096
      type: fs
      format: ext3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There are currently two different disk_types a user can use: volatile and clone. Clone which is required when specifying devices
will clone an image in open nebula and will expand it to the size specified in the profile settings. By default this will clone
the image attached to the template specified in the profile but a user can add the \fIimage\fP argument under the disk definition.
.sp
For example the profile below will not use Ubuntu\-14.04 for the cloned disk image. It will use the centos7\-base\-image image:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-opennebula\-profile:
  provider: my\-opennebula\-provider
  image: Ubuntu\-14.04
  disk:
    disk0:
      disk_type: clone
      size: 8096
      image: centos7\-base\-image
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you want to use the image attached to the template set in the profile you can simply remove the image argument as show below.
The profile below will clone the image Ubuntu\-14.04 and expand the disk to 8GB.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-opennebula\-profile:
  provider: my\-opennebula\-provider
  image: Ubuntu\-14.04
  disk:
    disk0:
      disk_type: clone
      size: 8096
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A user can also currently specify swap or fs disks. Below is an example of this profile setting:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-opennebula\-profile:
  provider: my\-opennebula\-provider
  image: Ubuntu\-14.04
  disk:
    disk0:
      disk_type: clone
      size: 8096
    disk1:
      disk_type: volatile
      type: swap
      size: 4096
    disk2:
      disk_type: volatile
      size: 4096
      type: fs
      format: ext3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The example above will attach both a swap disk and a ext3 filesystem with a size of 4GB. To note if you define other disks you have
to define the image disk to clone because the template will write over the entire \(aqDISK=[]\(aq template definition on creation.
.SS Required Settings
.sp
The following settings are always required for OpenNebula:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-opennebula\-config:
  xml_rpc: http://localhost:26633/RPC2
  user: oneadmin
  password: JHGhgsayu32jsa
  driver: opennebula
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Required Settings for VM Deployment
.sp
The settings defined in the \fI\%Required Settings\fP section are required for all interactions with
OpenNebula. However, when deploying a virtual machine via Salt Cloud, an additional setting, \fBprivate_key\fP, is also
required:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-opennebula\-config:
  private_key: /path/to/private/key
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Listing Images
.sp
Images can be queried on OpenNebula by passing the \fB\-\-list\-images\fP argument to Salt Cloud:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images opennebula
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Listing Locations
.sp
In OpenNebula, locations are defined as \fBhosts\fP\&. Locations, or \(dqhosts\(dq, can be querried on OpenNebula by passing the
\fB\-\-list\-locations\fP argument to Salt Cloud:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations opennebula
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Listing Sizes
.sp
Sizes are defined by templates in OpenNebula. As such, the \fB\-\-list\-sizes\fP call returns an empty dictionary since
there are no sizes to return.
.SS Additional OpenNebula API Functionality
.sp
The Salt Cloud driver for OpenNebula was written using OpenNebula\(aqs native XML RPC API. As such, many \fB\-\-function\fP
and \fB\-\-action\fP calls were added to the OpenNebula driver to enhance support for an OpenNebula infrastructure with
additional control from Salt Cloud. See the \fI\%OpenNebula function definitions\fP
for more information.
.SS Access via DNS entry instead of IP
.sp
Some OpenNebula installations do not assign IP addresses to new VMs, instead they establish the new VM\(aqs hostname based
on OpenNebula\(aqs name of the VM, and then allocate an IP out of DHCP with dynamic DNS attaching the hostname.  This driver
supports this behavior by adding the entry \fIfqdn_base\fP to the driver configuration or the OpenNebula profile with a value
matching the base fully\-qualified domain.  For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example is for /etc/salt/cloud.providers or any file in the
# /etc/salt/cloud.providers.d/ directory.

my\-opennebula\-provider:
  [...]
  fqdn_base: corp.example.com
  [...]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Getting Started with Openstack
.sp
See \fI\%salt.cloud.clouds.openstack\fP
.SS Getting Started With Parallels
.sp
Parallels Cloud Server is a product by Parallels that delivers a cloud hosting
solution. The PARALLELS module for Salt Cloud enables you to manage instances
hosted using PCS. Further information can be found at:
.sp
\fI\%http://www.parallels.com/products/pcs/\fP
.INDENT 0.0
.IP \(bu 2
Using the old format, set up the cloud configuration at \fB/etc/salt/cloud\fP:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Set up the location of the salt master
#
minion:
    master: saltmaster.example.com

# Set the PARALLELS access credentials (see below)
#
PARALLELS.user: myuser
PARALLELS.password: badpass

# Set the access URL for your PARALLELS host
#
PARALLELS.url: https://api.cloud.xmission.com:4465/paci/v1.0/
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
Using the new format, set up the cloud configuration at
\fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/parallels.conf\fP:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-parallels\-config:
  # Set up the location of the salt master
  #
  minion:
    master: saltmaster.example.com

  # Set the PARALLELS access credentials (see below)
  #
  user: myuser
  password: badpass

  # Set the access URL for your PARALLELS provider
  #
  url: https://api.cloud.xmission.com:4465/paci/v1.0/
  driver: parallels
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Access Credentials
.sp
The \fBuser\fP, \fBpassword\fP, and \fBurl\fP will be provided to you by your cloud
host. These are all required in order for the PARALLELS driver to work.
.SS Cloud Profiles
.sp
Set up an initial profile at \fB/etc/salt/cloud.profiles\fP or
\fB/etc/salt/cloud.profiles.d/parallels.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
parallels\-ubuntu:
    provider: my\-parallels\-config
    image: ubuntu\-12.04\-x86_64
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The profile can be realized now with a salt command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-p parallels\-ubuntu myubuntu
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will create an instance named \fBmyubuntu\fP on the cloud host. The
minion that is installed on this instance will have an \fBid\fP of \fBmyubuntu\fP\&.
If the command was executed on the salt\-master, its Salt key will automatically
be signed on the master.
.sp
Once the instance has been created with salt\-minion installed, connectivity to
it can be verified with Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt myubuntu test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Required Settings
.sp
The following settings are always required for PARALLELS:
.INDENT 0.0
.IP \(bu 2
Using the old cloud configuration format:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
PARALLELS.user: myuser
PARALLELS.password: badpass
PARALLELS.url: https://api.cloud.xmission.com:4465/paci/v1.0/
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
Using the new cloud configuration format:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-parallels\-config:
  user: myuser
  password: badpass
  url: https://api.cloud.xmission.com:4465/paci/v1.0/
  driver: parallels
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Optional Settings
.sp
Unlike other cloud providers in Salt Cloud, Parallels does not utilize a
\fBsize\fP setting. This is because Parallels allows the end\-user to specify a
more detailed configuration for their instances than is allowed by many other
cloud hosts. The following options are available to be used in a profile,
with their default settings listed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Description of the instance. Defaults to the instance name.
desc: <instance_name>

# How many CPU cores, and how fast they are (in MHz)
cpu_number: 1
cpu_power: 1000

# How many megabytes of RAM
ram: 256

# Bandwidth available, in kbps
bandwidth: 100

# How many public IPs will be assigned to this instance
ip_num: 1

# Size of the instance disk (in GiB)
disk_size: 10

# Username and password
ssh_username: root
password: <value from PARALLELS.password>

# The name of the image, from \(ga\(gasalt\-cloud \-\-list\-images parallels\(ga\(ga
image: ubuntu\-12.04\-x86_64
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Getting Started With ProfitBricks
.sp
ProfitBricks provides an enterprise\-grade Infrastructure as a Service (IaaS)
solution that can be managed through a browser\-based \(dqData Center Designer\(dq
(DCD) tool or via an easy to use API. A unique feature of the ProfitBricks
platform is that it allows you to define your own settings for cores, memory,
and disk size without being tied to a particular server size.
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
profitbricks >= 4.1.1
.UNINDENT
.SS Configuration
.INDENT 0.0
.IP \(bu 2
Using the new format, set up the cloud configuration at
\fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/profitbricks.conf\fP:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-profitbricks\-config:
  driver: profitbricks

  # Set the location of the salt\-master
  #
  minion:
    master: saltmaster.example.com

  # Configure ProfitBricks authentication credentials
  #
  username: user@domain.com
  password: 123456
  # datacenter is the UUID of a pre\-existing virtual data center.
  datacenter: 9e6709a0\-6bf9\-4bd6\-8692\-60349c70ce0e
  # delete_volumes is forcing a deletion of all volumes attached to a server on a deletion of a server
  delete_volumes: true
  # Connect to public LAN ID 1.
  public_lan: 1
  ssh_public_key: /path/to/id_rsa.pub
  ssh_private_key: /path/to/id_rsa
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Virtual Data Center
.sp
ProfitBricks uses the concept of Virtual Data Centers. These are logically
separated from one another and allow you to have a self\-contained environment
for all servers, volumes, networking, snapshots, and so forth.
.sp
A list of existing virtual data centers can be retrieved with the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_datacenters my\-profitbricks\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A new data center can be created with the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_datacenter my\-profitbricks\-config name=example location=us/las description=\(dqmy description\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Authentication
.sp
The \fBusername\fP and \fBpassword\fP are the same as those used to log into the
ProfitBricks \(dqData Center Designer\(dq.
.SS Profiles
.sp
Here is an example of a profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
profitbricks_staging
  provider: my\-profitbricks\-config
  size: Micro Instance
  image_alias: \(aqubuntu:latest\(aq
  # image or image_alias must be provided
  # image: 2f98b678\-6e7e\-11e5\-b680\-52540066fee9
  cores: 2
  ram: 4096
  public_lan: 1
  private_lan: 2
  ssh_public_key: /path/to/id_rsa.pub
  ssh_private_key: /path/to/id_rsa
  ssh_interface: private_lan

profitbricks_production:
  provider: my\-profitbricks\-config
  image: Ubuntu\-15.10\-server\-2016\-05\-01
  image_password: MyPassword1
  disk_type: SSD
  disk_size: 40
  cores: 8
  cpu_family: INTEL_XEON
  ram: 32768
  public_lan: 1
  public_ips:
    \- 172.217.18.174
  private_lan: 2
  private_ips:
    \- 192.168.100.10
  public_firewall_rules:
    Allow SSH:
      protocol: TCP
      source_ip: 1.2.3.4
      port_range_start: 22
      port_range_end: 22
    Allow Ping:
      protocol: ICMP
      icmp_type: 8
  ssh_public_key: /path/to/id_rsa.pub
  ssh_private_key: /path/to/id_rsa
  ssh_interface: private_lan
  volumes:
    db_data:
      disk_size: 500
    db_log:
      disk_size: 50
      disk_type: SSD
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Locations can be obtained using the \fB\-\-list\-locations\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-locations my\-profitbricks\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Images can be obtained using the \fB\-\-list\-sizes\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-images my\-profitbricks\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Sizes can be obtained using the \fB\-\-list\-sizes\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-sizes my\-profitbricks\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2019.2.0: One or more public IP address can be reserved with the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-f reserve_ipblock  my\-profitbricks\-config location=\(aqus/ewr\(aq size=1
.ft P
.fi
.UNINDENT
.UNINDENT

.SS Profile Specifics:
.sp
The following list explains some of the important properties.
.INDENT 0.0
.IP \(bu 2
\fBsize\fP \- Can be one of the options listed in the output of the following
command:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-sizes my\-profitbricks\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBimage\fP \- Can be one of the options listed in the output of the following
command:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images my\-profitbricks\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBimage_alias\fP \- Can be one of the options listed in the output of the
following command:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_images my\-profitbricks\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBdisk_size\fP \- This option allows you to override the size of the disk as
defined by the size. The disk size is set in gigabytes (GB).
.IP \(bu 2
\fBdisk_type\fP \- This option allow the disk type to be set to HDD or SSD. The
default is HDD.
.sp
New in version 2019.2.0.

.IP \(bu 2
\fBimage_password\fP \- A password is set on the image for the \(dqroot\(dq or
\(dqAdministrator\(dq account.  This field may only be set during volume creation.
Only valid with ProfitBricks supplied HDD (not ISO) images. The password must
contain at least 8 and no more than 50 characters. Only these characters are
allowed: [a\-z][A\-Z][0\-9]
.IP \(bu 2
\fBcores\fP \- This option allows you to override the number of CPU cores as
defined by the size.
.IP \(bu 2
\fBram\fP \- This option allows you to override the amount of RAM defined by the
size. The value must be a multiple of 256, e.g. 256, 512, 768, 1024, and so
forth.
.IP \(bu 2
\fBpublic_lan\fP \- This option will connect the server to the specified public
LAN. If no LAN exists, then a new public LAN will be created. The value
accepts a LAN ID (integer).
.sp
New in version 2019.2.0.

.IP \(bu 2
\fBpublic_ips\fP \- Public IPs assigned to the NIC in the public LAN.
.IP \(bu 2
\fBpublic_firewall_rules\fP \- This option allows for a list of firewall rules
assigned to the public network interface.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
Firewall Rule Name:
  protocol: <protocol> (TCP, UDP, ICMP)
  source_mac: <source\-mac>
  source_ip: <source\-ip>
  target_ip: <target\-ip>
  port_range_start: <port\-range\-start>
  port_range_end: <port\-range\-end>
  icmp_type: <icmp\-type>
  icmp_code: <icmp\-code>
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBprivate_lan\fP \- This option will connect the server to the specified
private LAN. If no LAN exists, then a new private LAN will be created. The
value accepts a LAN ID (integer).
.sp
New in version 2019.2.0.

.IP \(bu 2
\fBprivate_ips\fP \- Private IPs assigned in the private LAN. NAT setting is
ignored when this setting is active.
.IP \(bu 2
\fBprivate_firewall_rules\fP \- This option allows for a list of firewall rules
assigned to the private network interface.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
Firewall Rule Name:
  protocol: <protocol> (TCP, UDP, ICMP)
  source_mac: <source\-mac>
  source_ip: <source\-ip>
  target_ip: <target\-ip>
  port_range_start: <port\-range\-start>
  port_range_end: <port\-range\-end>
  icmp_type: <icmp\-type>
  icmp_code: <icmp\-code>
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBssh_private_key\fP \- Full path to the SSH private key file
.IP \(bu 2
\fBssh_public_key\fP \- Full path to the SSH public key file
.IP \(bu 2
\fBssh_interface\fP \- This option will use the private LAN IP for node
connections (such as as bootstrapping the node) instead of the public LAN IP.
The value accepts \(aqprivate_lan\(aq.
.IP \(bu 2
\fBcpu_family\fP \- This option allow the CPU family to be set to AMD_OPTERON or
INTEL_XEON.  The default is AMD_OPTERON.
.IP \(bu 2
\fBvolumes\fP \- This option allows a list of additional volumes by name that
will be created and attached to the server. Each volume requires \(aqdisk_size\(aq
and, optionally, \(aqdisk_type\(aq. The default is HDD.
.IP \(bu 2
\fBdeploy\fP \- Set to \fBFalse\fP if Salt should not be installed on the node.
.IP \(bu 2
\fBwait_for_timeout\fP \- The timeout to wait in seconds for provisioning
resources such as servers.  The default wait_for_timeout is 15 minutes.
.UNINDENT
.sp
For more information concerning cloud profiles, see \fI\%here\fP\&.
.SS Getting Started With Proxmox
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This cloud provider will be removed from Salt in version 3009.0 in favor of
the \fI\%saltext.proxmox Salt Extension\fP
.UNINDENT
.UNINDENT
.sp
Proxmox Virtual Environment is a complete server virtualization management solution,
based on OpenVZ(in Proxmox up to 3.4)/LXC(from Proxmox 4.0 and up) and full virtualization with KVM.
Further information can be found at:
.sp
\fI\%https://www.proxmox.com\fP
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
IPy >= 0.81
.IP \(bu 2
requests >= 2.2.1
.UNINDENT
.sp
Please note:
This module allows you to create OpenVZ/LXC containers and KVM VMs, but installing Salt on it will only be
done on containers rather than a KVM virtual machine.
.INDENT 0.0
.IP \(bu 2
Set up the cloud configuration at
\fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/proxmox.conf\fP:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-proxmox\-config:
  # Set up the location of the salt master
  #
  minion:
    master: saltmaster.example.com

  # Set the PROXMOX access credentials (see below)
  #
  user: myuser@pve
  password: badpass

  # Set the access URL for your PROXMOX host
  #
  url: your.proxmox.host
  driver: proxmox
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Access Credentials
.sp
The \fBuser\fP, \fBpassword\fP, and \fBurl\fP will be provided to you by your cloud
host. These are all required in order for the PROXMOX driver to work.
.SS Cloud Profiles
.sp
Set up an initial profile at \fB/etc/salt/cloud.profiles\fP or
\fB/etc/salt/cloud.profiles.d/proxmox.conf\fP:
.INDENT 0.0
.IP \(bu 2
Configure a profile to be used:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxmox\-ubuntu:
    provider: my\-proxmox\-config
    image: local:vztmpl/ubuntu\-12.04\-standard_12.04\-1_amd64.tar.gz
    technology: lxc

    # host needs to be set to the configured name of the proxmox host
    # and not the ip address or FQDN of the server
    host: myvmhost
    ip_address: 192.168.100.155
    password: topsecret
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The profile can be realized now with a salt command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-p proxmox\-ubuntu myubuntu
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will create an instance named \fBmyubuntu\fP on the cloud host. The
minion that is installed on this instance will have a \fBhostname\fP of \fBmyubuntu\fP\&.
If the command was executed on the salt\-master, its Salt key will automatically
be signed on the master.
.sp
Once the instance has been created with salt\-minion installed, connectivity to
it can be verified with Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt myubuntu test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Required Settings
.sp
The following settings are always required for PROXMOX:
.INDENT 0.0
.IP \(bu 2
Using the new cloud configuration format:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-proxmox\-config:
  driver: proxmox
  user: saltcloud@pve
  password: xyzzy
  url: your.proxmox.host
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Optional Settings
.sp
Unlike other cloud providers in Salt Cloud, Proxmox does not utilize a
\fBsize\fP setting. This is because Proxmox allows the end\-user to specify a
more detailed configuration for their instances, than is allowed by many other
cloud providers. The following options are available to be used in a profile,
with their default settings listed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Description of the instance.
desc: <instance_name>

# How many CPU cores, and how fast they are (in MHz)
cpus: 1
cpuunits: 1000

# How many megabytes of RAM
memory: 256

# How much swap space in MB
swap: 256

# Whether to auto boot the vm after the host reboots
onboot: 1

# Size of the instance disk (in GiB)
disk: 10

# Host to create this vm on
host: myvmhost

# Nameservers. Defaults to host
nameserver: 8.8.8.8 8.8.4.4

# Username and password
ssh_username: root
password: <value from PROXMOX.password>

# The name of the image, from \(ga\(gasalt\-cloud \-\-list\-images proxmox\(ga\(ga
image: local:vztmpl/ubuntu\-12.04\-standard_12.04\-1_amd64.tar.gz

# Whether or not to verify the SSL cert on the Proxmox host
verify_ssl: False

# Network interfaces, netX
net0: name=eth0,bridge=vmbr0,ip=dhcp

# Public key to add to /root/.ssh/authorized_keys.
pubkey: \(aqssh\-rsa AAAAB3NzaC1yc2EAAAADAQABA...\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS QEMU
.sp
Some functionnalities works differently if you use \(aqqemu\(aq as technology. In order to create a new VM with qemu, you need to specificy some more information.
You can also clone a qemu template which already is on your Proxmox server.
.sp
QEMU profile file (for a new VM):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxmox\-win7:
  # Image of the new VM
  image: image.iso # You can get all your available images using \(aqsalt\-cloud \-\-list\-images provider_name\(aq (Ex: \(aqsalt\-cloud \-\-list\-images my\-proxmox\-config\(aq)

  # Technology used to create the VM (\(aqqemu\(aq, \(aqopenvz\(aq(on Proxmox <4.x) or \(aqlxc\(aq(on Proxmox 4.x+))
  technology: qemu

  # Proxmox node name
  host: node_name

  # Proxmox password
  password: your_password

  # Workaround https://github.com/saltstack/salt/issues/27821
  size: \(aq\(aq

  # RAM size (MB)
  memory: 2048

  # OS Type enum (other / wxp / w2k / w2k3 / w2k8 / wvista / win7 / win8 / l24 / l26 / solaris)
  ostype: win7

  # Hard disk location
  sata0: <location>:<size>, format=<qcow2/vmdk/raw>, size=<size>GB #Example: local:120,format=qcow2,size=120GB

  #CD/DVD Drive
  ide2: <content_location>,media=cdrom #Example: local:iso/name.iso,media=cdrom

  # Network Device
  net0:<model>,bridge=<bridge> #Example: e1000,bridge=vmbr0

  # Enable QEMU Guest Agent (0 / 1)
  agent: 1

  # VM name
  name: Test
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
More information about these parameters can be found on Proxmox API (\fI\%http://pve.proxmox.com/pve2\-api\-doc/\fP) under the \(aqPOST\(aq method of nodes/{node}/qemu
.sp
QEMU profile file (for a clone):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxmox\-win7:
  # Enable Clone
  clone: True

  # New VM description
  clone_description: \(aqdescription\(aq

  # New VM name
  clone_name: \(aqname\(aq

  # New VM format (qcow2 / raw / vmdk)
  clone_format: qcow2

  # Full clone (1) or Link clone (0)
  clone_full: 0

  # VMID of Template to clone
  clone_from: ID

  # Technology used to create the VM (\(aqqemu\(aq or \(aqlxc\(aq)
  technology: qemu

  # Proxmox node name
  host: node_name

  # Proxmox password
  password: your_password

  # Workaround https://github.com/saltstack/salt/issues/27821
  size: \(aq\(aq

  # Enable the use of a Qemu agent on VM to retrieve the IP\-address from.
  agent_get_ip: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
More information can be found on Proxmox API under the \(aqPOST\(aq method of /nodes/{node}/qemu/{vmid}/clone
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The Proxmox API offers a lot more options and parameters, which are not yet
supported by this salt\-cloud \(aqoverlay\(aq. Feel free to add your contribution
by forking the github repository and modifying  the following file:
\fBsalt/cloud/clouds/proxmox.py\fP
.sp
An easy way to support more parameters for VM creation would be to add the
names of the optional parameters in the \(aqcreate_nodes(vm_)\(aq function, under
the \(aqqemu\(aq technology. But it requires you to dig into the code ...
.UNINDENT
.UNINDENT
.SS Getting Started With Scaleway
.sp
Scaleway is the first IaaS host worldwide to offer an ARM based cloud. It’s the ideal platform for horizontal scaling with BareMetal SSD servers. The solution provides on demand resources: it comes with on\-demand SSD storage, movable IPs , images, security group and an Object Storage solution. \fI\%https://scaleway.com\fP
.SS Configuration
.sp
Using Salt for Scaleway, requires an \fBaccess key\fP and an \fBAPI token\fP\&. \fBAPI tokens\fP are unique identifiers associated with your Scaleway account.
To retrieve your \fBaccess key\fP and \fBAPI token\fP, log\-in to the Scaleway control panel, open the pull\-down menu on your account name and click on \(dqMy Credentials\(dq link.
.sp
If you do not have API token you can create one by clicking the \(dqCreate New Token\(dq button on the right corner.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example is for /etc/salt/cloud.providers or any file in the
# /etc/salt/cloud.providers.d/ directory.

my\-scaleway\-config:
  access_key: 15cf404d\-4560\-41b1\-9a0c\-21c3d5c4ff1f
  token: a7347ec8\-5de1\-4024\-a5e3\-24b77d1ba91d
  driver: scaleway
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Profiles
.SS Cloud Profiles
.sp
Set up an initial profile at /etc/salt/cloud.profiles or in the /etc/salt/cloud.profiles.d/ directory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
scaleway\-ubuntu:
  provider: my\-scaleway\-config
  image: Ubuntu Trusty (14.04 LTS)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Images can be obtained using the \fB\-\-list\-images\fP option for the \fBsalt\-cloud\fP command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#salt\-cloud \-\-list\-images my\-scaleway\-config
my\-scaleway\-config:
  \-\-\-\-\-\-\-\-\-\-
  scaleway:
      \-\-\-\-\-\-\-\-\-\-
      069fd876\-eb04\-44ab\-a9cd\-47e2fa3e5309:
          \-\-\-\-\-\-\-\-\-\-
          arch:
              arm
          creation_date:
              2015\-03\-12T09:35:45.764477+00:00
          default_bootscript:
              {u\(aqkernel\(aq: {u\(aqdtb\(aq: u\(aq\(aq, u\(aqtitle\(aq: u\(aqPimouss 3.2.34\-30\-std\(aq, u\(aqid\(aq: u\(aqcfda4308\-cd6f\-4e51\-9744\-905fc0da370f\(aq, u\(aqpath\(aq: u\(aqkernel/pimouss\-uImage\-3.2.34\-30\-std\(aq}, u\(aqtitle\(aq: u\(aq3.2.34\-std #30 (stable)\(aq, u\(aqid\(aq: u\(aqc5af0215\-2516\-4316\-befc\-5da1cfad609c\(aq, u\(aqinitrd\(aq: {u\(aqpath\(aq: u\(aqinitrd/c1\-uInitrd\(aq, u\(aqid\(aq: u\(aq1be14b1b\-e24c\-48e5\-b0b6\-7ba452e42b92\(aq, u\(aqtitle\(aq: u\(aqC1 initrd\(aq}, u\(aqbootcmdargs\(aq: {u\(aqid\(aq: u\(aqd22c4dde\-e5a4\-47ad\-abb9\-d23b54d542ff\(aq, u\(aqvalue\(aq: u\(aqip=dhcp boot=local root=/dev/nbd0 USE_XNBD=1 nbd.max_parts=8\(aq}, u\(aqorganization\(aq: u\(aq11111111\-1111\-4111\-8111\-111111111111\(aq, u\(aqpublic\(aq: True}
          extra_volumes:
              []
          id:
              069fd876\-eb04\-44ab\-a9cd\-47e2fa3e5309
          modification_date:
              2015\-04\-24T12:02:16.820256+00:00
          name:
              Ubuntu Vivid (15.04)
          organization:
              a283af0b\-d13e\-42e1\-a43f\-855ffbf281ab
          public:
              True
          root_volume:
              {u\(aqname\(aq: u\(aqdistrib\-ubuntu\-vivid\-2015\-03\-12_10:32\-snapshot\(aq, u\(aqid\(aq: u\(aqa6d02e63\-8dee\-4bce\-b627\-b21730f35a05\(aq, u\(aqvolume_type\(aq: u\(aql_ssd\(aq, u\(aqsize\(aq: 50000000000L}
\&...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Execute a query and return all information about the nodes running on configured cloud providers using the \fB\-Q\fP option for the \fBsalt\-cloud\fP command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-F
[INFO    ] salt\-cloud starting
[INFO    ] Starting new HTTPS connection (1): api.scaleway.com
my\-scaleway\-config:
  \-\-\-\-\-\-\-\-\-\-
  scaleway:
      \-\-\-\-\-\-\-\-\-\-
      salt\-manager:
          \-\-\-\-\-\-\-\-\-\-
          creation_date:
              2015\-06\-03T08:17:38.818068+00:00
          hostname:
              salt\-manager
\&...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Additional documentation about Scaleway can be found at \fI\%https://www.scaleway.com/docs\fP\&.
.UNINDENT
.UNINDENT
.SS Getting Started With Saltify
.sp
The Saltify driver is a driver for installing Salt on existing
machines (virtual or bare metal).
.SS Dependencies
.sp
The Saltify driver has no external dependencies.
.SS Configuration
.sp
Because the Saltify driver does not use an actual cloud provider host, it can have a
simple provider configuration. The only thing that is required to be set is the
driver name, and any other potentially useful information, like the location of
the salt\-master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example is for /etc/salt/cloud.providers file or any file in
# the /etc/salt/cloud.providers.d/ directory.

my\-saltify\-config:
  minion:
    master: 111.222.333.444
  driver: saltify
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, if you wish to use the more advanced capabilities of salt\-cloud, such as
rebooting, listing, and disconnecting machines, then the salt master must fill
the role usually performed by a vendor\(aqs cloud management system. The salt master
must be running on the salt\-cloud machine, and created nodes must be connected to the
master.
.sp
Additional information about which configuration options apply to which actions
can be studied in the
\fI\%Saltify Module documentation\fP
and the
\fI\%Miscellaneous Salt Cloud Options\fP
document.
.SS Profiles
.sp
Saltify requires a separate profile to be configured for each machine that
needs Salt installed [1]\&. The initial profile can be set up at
\fB/etc/salt/cloud.profiles\fP
or in the \fB/etc/salt/cloud.profiles.d/\fP directory. Each profile requires
both an \fBssh_host\fP and an \fBssh_username\fP key parameter as well as either
an \fBkey_filename\fP or a \fBpassword\fP\&.
.IP [1] 5
Unless you are using a map file to provide the unique parameters.
.sp
Profile configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/cloud.profiles.d/saltify.conf

salt\-this\-machine:
  ssh_host: 12.34.56.78
  ssh_username: root
  key_filename: \(aq/etc/salt/mysshkey.pem\(aq
  provider: my\-saltify\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The machine can now be \(dqSalted\(dq with the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p salt\-this\-machine my\-machine
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will install salt on the machine specified by the cloud profile,
\fBsalt\-this\-machine\fP, and will give the machine the minion id of
\fBmy\-machine\fP\&. If the command was executed on the salt\-master, its Salt
key will automatically be accepted by the master.
.sp
Once a salt\-minion has been successfully installed on the instance, connectivity
to it can be verified with Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt my\-machine test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Destroy Options
.sp
New in version 2018.3.0.

.sp
For obvious reasons, the \fBdestroy\fP action does not actually vaporize hardware.
If the salt  master is connected, it can tear down parts of the client machines.
It will remove the client\(aqs key from the salt master,
and can execute the following options:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- remove_config_on_destroy: true
  # default: true
  # Deactivate salt\-minion on reboot and
  # delete the minion config and key files from its \(dq/etc/salt\(dq directory,
  #   NOTE: If deactivation was unsuccessful (older Ubuntu machines) then when
  #   salt\-minion restarts it will automatically create a new, unwanted, set
  #   of key files. Use the \(dqforce_minion_config\(dq option to replace them.

\- shutdown_on_destroy: false
  # default: false
  # last of all, send a \(dqshutdown\(dq command to the client.
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Wake On LAN
.sp
New in version 2018.3.0.

.sp
In addition to connecting a hardware machine to a Salt master,
you have the option of sending a wake\-on\-LAN
\fI\%magic packet\fP
to start that machine running.
.sp
The \(dqmagic packet\(dq must be sent by an existing salt minion which is on
the same network segment as the target machine. (Or your router
must be set up especially to route WoL packets.) Your target machine
must be set up to listen for WoL and to respond appropriately.
.sp
You must provide the Salt node id of the machine which will send
the WoL packet (parameter \fBwol_sender_node\fP), and
the hardware MAC address of the machine you intend to wake,
(parameter \fBwake_on_lan_mac\fP). If both parameters are defined,
the WoL will be sent. The cloud master will then sleep a while
(parameter \fBwol_boot_wait\fP) to give the target machine time to
boot up before we start probing its SSH port to begin deploying
Salt to it. The default sleep time is 30 seconds.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/cloud.profiles.d/saltify.conf

salt\-this\-machine:
  ssh_host: 12.34.56.78
  ssh_username: root
  key_filename: \(aq/etc/salt/mysshkey.pem\(aq
  provider: my\-saltify\-config
  wake_on_lan_mac: \(aq00:e0:4c:70:2a:b2\(aq  # found with ifconfig
  wol_sender_node: bevymaster  # its on this network segment
  wol_boot_wait: 45  # seconds to sleep
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Using Map Files
.sp
The settings explained in the section above may also be set in a map file. An
example of how to use the Saltify driver with a map file follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/saltify\-map

make_salty:
  \- my\-instance\-0:
      ssh_host: 12.34.56.78
      ssh_username: root
      password: very\-bad\-password
  \- my\-instance\-1:
      ssh_host: 44.33.22.11
      ssh_username: root
      password: another\-bad\-pass
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example, the names \fBmy\-instance\-0\fP and \fBmy\-instance\-1\fP will be the
identifiers of the deployed minions.
.sp
Note: The \fBssh_host\fP directive is also used for Windows hosts, even though they do
not typically run the SSH service. It indicates IP address or host name for the target
system.
.sp
Note: When using a cloud map with the Saltify driver, the name of the profile
to use, in this case \fBmake_salty\fP, must be defined in a profile config. For
example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/cloud.profiles.d/saltify.conf

make_salty:
  provider: my\-saltify\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The machines listed in the map file can now be \(dqSalted\(dq by applying the
following salt map command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-m /etc/salt/saltify\-map
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This command will install salt on the machines specified in the map and will
give each machine their minion id of \fBmy\-instance\-0\fP and \fBmy\-instance\-1\fP,
respectively. If the command was executed on the salt\-master, its Salt key will
automatically be signed on the master.
.sp
Connectivity to the new \(dqSalted\(dq instances can now be verified with Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-instance\-*\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Bulk Deployments
.sp
When deploying large numbers of Salt Minions using Saltify, it may be
preferable to organize the configuration in a way that duplicates data
as little as possible. For example, if a group of target systems have
the same credentials, they can be specified in the profile, rather than
in a map file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/cloud.profiles.d/saltify.conf

make_salty:
  provider: my\-saltify\-config
  ssh_username: root
  password: very\-bad\-password
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/saltify\-map

make_salty:
  \- my\-instance\-0:
      ssh_host: 12.34.56.78
  \- my\-instance\-1:
      ssh_host: 44.33.22.11
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If \fBssh_host\fP is not provided, its default value will be the Minion identifier
(\fBmy\-instance\-0\fP and \fBmy\-instance\-1\fP, in the example above). For deployments with
working DNS resolution, this can save a lot of redundant data in the map. Here is an
example map file using DNS names instead of IP addresses:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/saltify\-map

make_salty:
  \- my\-instance\-0
  \- my\-instance\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Credential Verification
.sp
Because the Saltify driver does not actually create VM\(aqs, unlike other
salt\-cloud drivers, it has special behaviour when the \fBdeploy\fP option is set
to \fBFalse\fP\&. When the cloud configuration specifies \fBdeploy: False\fP, the
Saltify driver will attempt to authenticate to the target node(s) and return
\fBTrue\fP for each one that succeeds. This can be useful to verify ports,
protocols, services and credentials are correctly configured before a live
deployment.
.INDENT 0.0
.TP
.B Return values:
.INDENT 7.0
.IP \(bu 2
\fBTrue\fP: Credential verification succeeded
.IP \(bu 2
\fBFalse\fP: Credential verification succeeded
.IP \(bu 2
\fBNone\fP: Credential verification was not attempted.
.UNINDENT
.UNINDENT
.SS Getting Started With SoftLayer
.sp
SoftLayer is a public cloud host, and baremetal hardware hosting service.
.SS Dependencies
.sp
The SoftLayer driver for Salt Cloud requires the softlayer package, which is
available at PyPI:
.sp
\fI\%https://pypi.org/project/SoftLayer/\fP
.sp
This package can be installed using \fBpip\fP or \fBeasy_install\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# pip install softlayer
# easy_install softlayer
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configuration
.sp
Set up the cloud config at \fB/etc/salt/cloud.providers\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: These examples are for /etc/salt/cloud.providers

  my\-softlayer:
    # Set up the location of the salt master
    minion:
      master: saltmaster.example.com

    # Set the SoftLayer access credentials (see below)
    user: MYUSER1138
    apikey: \(aqe3b68aa711e6deadc62d5b76355674beef7cc3116062ddbacafe5f7e465bfdc9\(aq

    driver: softlayer


  my\-softlayer\-hw:
    # Set up the location of the salt master
    minion:
      master: saltmaster.example.com

    # Set the SoftLayer access credentials (see below)
    user: MYUSER1138
    apikey: \(aqe3b68aa711e6deadc62d5b76355674beef7cc3116062ddbacafe5f7e465bfdc9\(aq

    driver: softlayer_hw
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Access Credentials
.sp
The \fBuser\fP setting is the same user as is used to log into the SoftLayer
Administration area. The \fBapikey\fP setting is found inside the Admin area after
logging in:
.INDENT 0.0
.IP \(bu 2
Hover over the \fBAccount\fP menu item.
.IP \(bu 2
Click the \fBUsers\fP link.
.IP \(bu 2
Find the \fBAPI Key\fP column and click \fBView\fP\&.
.UNINDENT
.SS Profiles
.SS Cloud Profiles
.sp
Set up an initial profile at \fB/etc/salt/cloud.profiles\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base_softlayer_ubuntu:
  provider: my\-softlayer
  image: UBUNTU_LATEST
  cpu_number: 1
  ram: 1024
  disk_size: 100
  local_disk: True
  hourly_billing: True
  domain: example.com
  location: sjc01
  # Optional
  max_net_speed: 1000
  private_vlan: 396
  private_network: True
  private_ssh: True
  # Use a dedicated host instead of cloud
  dedicated_host_id: 1234
  # May be used _instead_of_ image
  global_identifier: 320d8be5\-46c0\-dead\-cafe\-13e3c51
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Most of the above items are required; optional items are specified below.
.SS image
.sp
Images to build an instance can be found using the \fB\-\-list\-images\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-images my\-softlayer
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The setting used will be labeled as \fBtemplate\fP\&.
.SS cpu_number
.sp
This is the number of CPU cores that will be used for this instance. This
number may be dependent upon the image that is used. For instance:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Red Hat Enterprise Linux 6 \- Minimal Install (64 bit) (1 \- 4 Core):
    \-\-\-\-\-\-\-\-\-\-
    name:
        Red Hat Enterprise Linux 6 \- Minimal Install (64 bit) (1 \- 4 Core)
    template:
        REDHAT_6_64
Red Hat Enterprise Linux 6 \- Minimal Install (64 bit) (5 \- 100 Core):
    \-\-\-\-\-\-\-\-\-\-
    name:
        Red Hat Enterprise Linux 6 \- Minimal Install (64 bit) (5 \- 100 Core)
    template:
        REDHAT_6_64
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that the template (meaning, the \fIimage\fP option) for both of these is the
same, but the names suggests how many CPU cores are supported.
.SS ram
.sp
This is the amount of memory, in megabytes, that will be allocated to this
instance.
.SS disk_size
.sp
The amount of disk space that will be allocated to this image, in gigabytes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base_softlayer_ubuntu:
  disk_size: 100
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Using Multiple Disks
.sp
New in version 2015.8.1.

.sp
SoftLayer allows up to 5 disks to be specified for a virtual machine upon
creation. Multiple disks can be specified either as a list or a comma\-delimited
string. The first \fBdisk_size\fP specified in the string or list will be the first
disk size assigned to the VM.
.sp
List Example:
\&.. code\-block:: yaml
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B base_softlayer_ubuntu:
disk_size: [\(aq100\(aq, \(aq20\(aq, \(aq20\(aq]
.UNINDENT
.UNINDENT
.UNINDENT
.sp
String Example:
\&.. code\-block:: yaml
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B base_softlayer_ubuntu:
disk_size: \(aq100, 20, 20\(aq
.UNINDENT
.UNINDENT
.UNINDENT
.SS local_disk
.sp
When true the disks for the computing instance will be provisioned on the host
which it runs, otherwise SAN disks will be provisioned.
.SS hourly_billing
.sp
When true the computing instance will be billed on hourly usage, otherwise it
will be billed on a monthly basis.
.SS domain
.sp
The domain name that will be used in the FQDN (Fully Qualified Domain Name) for
this instance. The \fIdomain\fP setting will be used in conjunction with the
instance name to form the FQDN.
.SS use_fqdn
.sp
If set to True, the Minion will be identified by the FQDN (Fully Qualified Domain
Name) which is a result of combining the \fBdomain\fP configuration value and the
Minion name specified either via the CLI or a map file rather than only using the
short host name, or Minion ID. Default is False.
.sp
New in version 2016.3.0.

.sp
For example, if the value of \fBdomain\fP is \fBexample.com\fP and a new VM was created
via the CLI with \fBsalt\-cloud \-p base_softlayer_ubuntu my\-vm\fP, the resulting
Minion ID would be \fBmy\-vm.example.com\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When enabling the \fBuse_fqdn\fP setting, the Minion ID will be the FQDN and will
interact with salt commands with the FQDN instead of the short hostname. However,
due to the way the SoftLayer API is constructed, some Salt Cloud functions such
as listing nodes or destroying VMs will only list the short hostname of the VM
instead of the FQDN.
.UNINDENT
.UNINDENT
.sp
Example output displaying the SoftLayer hostname quirk mentioned in the note above
(note the Minion ID is \fBmy\-vm.example.com\fP, but the VM to be destroyed is listed
with its short hostname, \fBmy\-vm\fP):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-key \-L
Accepted Keys:
my\-vm.example.com
Denied Keys:
Unaccepted Keys:
Rejected Keys:
#
#
# salt my\-vm.example.com test.version
my\-vm.example.com:
    2018.3.4
#
#
# salt\-cloud \-d my\-vm.example.com
[INFO    ] salt\-cloud starting
[INFO    ] POST https://api.softlayer.com/xmlrpc/v3.1/SoftLayer_Account
The following virtual machines are set to be destroyed:
  softlayer\-config:
    softlayer:
      my\-vm

Proceed? [N/y] y
\&... proceeding
[INFO    ] Destroying in non\-parallel mode.
[INFO    ] POST https://api.softlayer.com/xmlrpc/v3.1/SoftLayer_Account
[INFO    ] POST https://api.softlayer.com/xmlrpc/v3.1/SoftLayer_Virtual_Guest
softlayer\-config:
    \-\-\-\-\-\-\-\-\-\-
    softlayer:
        \-\-\-\-\-\-\-\-\-\-
        my\-vm:
            True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS location
.sp
Images to build an instance can be found using the \fI\-\-list\-locations\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-location my\-softlayer
.ft P
.fi
.UNINDENT
.UNINDENT
.SS max_net_speed
.sp
Specifies the connection speed for the instance\(aqs network components. This
setting is optional. By default, this is set to 10.
.SS post_uri
.sp
Specifies the uri location of the script to be downloaded and run after the instance
is provisioned.
.sp
New in version 2015.8.1.

.sp
Example:
\&.. code\-block:: yaml
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B base_softlayer_ubuntu:
post_uri: \(aq\fI\%https://SOMESERVERIP:8000/myscript.sh\fP\(aq
.UNINDENT
.UNINDENT
.UNINDENT
.SS public_vlan
.sp
If it is necessary for an instance to be created within a specific frontend
VLAN, the ID for that VLAN can be specified in either the provider or profile
configuration.
.sp
This ID can be queried using the \fIlist_vlans\fP function, as described below. This
setting is optional.
.sp
If this setting is set to \fINone\fP, salt\-cloud will connect to the private ip of
the server.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If this setting is not provided and the server is not built with a public
vlan, \fIprivate_ssh\fP or \fIprivate_wds\fP will need to be set to make sure that
salt\-cloud attempts to connect to the private ip.
.UNINDENT
.UNINDENT
.SS private_vlan
.sp
If it is necessary for an instance to be created within a specific backend VLAN,
the ID for that VLAN can be specified in either the provider or profile
configuration.
.sp
This ID can be queried using the \fIlist_vlans\fP function, as described below. This
setting is optional.
.SS private_network
.sp
If a server is to only be used internally, meaning it does not have a public
VLAN associated with it, this value would be set to True. This setting is
optional. The default is False.
.SS private_ssh or private_wds
.sp
Whether to run the deploy script on the server using the public IP address
or the private IP address. If set to True, Salt Cloud will attempt to SSH or
WinRM into the new server using the private IP address. The default is False.
This settiong is optional.
.SS global_identifier
.sp
When creating an instance using a custom template, this option is set to the
corresponding value obtained using the \fIlist_custom_images\fP function. This
option will not be used if an \fIimage\fP is set, and if an \fIimage\fP is not set, it
is required.
.sp
The profile can be realized now with a salt command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-p base_softlayer_ubuntu myserver
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using the above configuration, this will create \fImyserver.example.com\fP\&.
.sp
Once the instance has been created with salt\-minion installed, connectivity to
it can be verified with Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt \(aqmyserver.example.com\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Dedicated Host
.sp
Soflayer allows the creation of new VMs in a dedicated host. This means that
you can order and pay a fixed amount for a bare metal dedicated host and use
it to provision as many VMs as you can fit in there. If you want your VMs to
be launched in a dedicated host, instead of Sofltayer\(aqs cloud, set the
\fBdedicated_host_id\fP parameter in your profile.
.SS dedicated_host_id
.sp
The id of the dedicated host where the VMs should be created. If not set, VMs
will be created in Softlayer\(aqs cloud instead.
.SS Bare metal Profiles
.sp
Set up an initial profile at \fB/etc/salt/cloud.profiles\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base_softlayer_hw_centos:
  provider: my\-softlayer\-hw
  # CentOS 6.0 \- Minimal Install (64 bit)
  image: 13963
  # 2 x 2.0 GHz Core Bare Metal Instance \- 2 GB Ram
  size: 1921
  # 500GB SATA II
  hdd: 1267
  # San Jose 01
  location: 168642
  domain: example.com
  # Optional
  vlan: 396
  port_speed: 273
  banwidth: 248
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Most of the above items are required; optional items are specified below.
.SS image
.sp
Images to build an instance can be found using the \fI\-\-list\-images\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-images my\-softlayer\-hw
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A list of \fIid\(gas and names will be provided. The \(ganame\fP will describe the
operating system and architecture. The \fIid\fP will be the setting to be used in
the profile.
.SS size
.sp
Sizes to build an instance can be found using the \fI\-\-list\-sizes\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-sizes my\-softlayer\-hw
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A list of \fIid\(gas and names will be provided. The \(ganame\fP will describe the speed
and quantity of CPU cores, and the amount of memory that the hardware will
contain. The \fIid\fP will be the setting to be used in the profile.
.SS hdd
.sp
There is currently only one size of hard disk drive (HDD) that is available for
hardware instances on SoftLayer:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
1267: 500GB SATA II
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fIhdd\fP setting in the profile should be 1267. Other sizes may be
added in the future.
.SS location
.sp
Locations to build an instance can be found using the \fI\-\-list\-images\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-locations my\-softlayer\-hw
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A list of IDs and names will be provided. The \fIlocation\fP will describe the
location in human terms. The \fIid\fP will be the setting to be used in the profile.
.SS domain
.sp
The domain name that will be used in the FQDN (Fully Qualified Domain Name) for
this instance. The \fIdomain\fP setting will be used in conjunction with the
instance name to form the FQDN.
.SS vlan
.sp
If it is necessary for an instance to be created within a specific VLAN, the ID
for that VLAN can be specified in either the provider or profile configuration.
.sp
This ID can be queried using the \fIlist_vlans\fP function, as described below.
.SS port_speed
.sp
Specifies the speed for the instance\(aqs network port. This setting refers to an
ID within the SoftLayer API, which sets the port speed. This setting is
optional. The default is 273, or, 100 Mbps Public & Private Networks. The
following settings are available:
.INDENT 0.0
.IP \(bu 2
273: 100 Mbps Public & Private Networks
.IP \(bu 2
274: 1 Gbps Public & Private Networks
.IP \(bu 2
21509: 10 Mbps Dual Public & Private Networks (up to 20 Mbps)
.IP \(bu 2
21513: 100 Mbps Dual Public & Private Networks (up to 200 Mbps)
.IP \(bu 2
2314: 1 Gbps Dual Public & Private Networks (up to 2 Gbps)
.IP \(bu 2
272: 10 Mbps Public & Private Networks
.UNINDENT
.SS bandwidth
.sp
Specifies the network bandwidth available for the instance. This setting refers
to an ID within the SoftLayer API, which sets the bandwidth. This setting is
optional. The default is 248, or, 5000 GB Bandwidth. The following settings are
available:
.INDENT 0.0
.IP \(bu 2
248: 5000 GB Bandwidth
.IP \(bu 2
129: 6000 GB Bandwidth
.IP \(bu 2
130: 8000 GB Bandwidth
.IP \(bu 2
131: 10000 GB Bandwidth
.IP \(bu 2
36: Unlimited Bandwidth (10 Mbps Uplink)
.IP \(bu 2
125: Unlimited Bandwidth (100 Mbps Uplink)
.UNINDENT
.SS Actions
.sp
The following actions are currently supported by the SoftLayer Salt Cloud
driver.
.SS show_instance
.sp
This action is a thin wrapper around \fI\-\-full\-query\fP, which displays details on a
single instance only. In an environment with several machines, this will save a
user from having to sort through all instance data, just to examine a single
instance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-a show_instance myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Functions
.sp
The following functions are currently supported by the SoftLayer Salt Cloud
driver.
.SS list_vlans
.sp
This function lists all VLANs associated with the account, and all known data
from the SoftLayer API concerning those VLANs.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-f list_vlans my\-softlayer
$ salt\-cloud \-f list_vlans my\-softlayer\-hw
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fIid\fP returned in this list is necessary for the \fIvlan\fP option when creating
an instance.
.SS list_custom_images
.sp
This function lists any custom templates associated with the account, that can
be used to create a new instance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-f list_custom_images my\-softlayer
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fIglobalIdentifier\fP returned in this list is necessary for the
\fIglobal_identifier\fP option when creating an image using a custom template.
.SS Optional Products for SoftLayer HW
.sp
The softlayer_hw driver supports the ability to add optional products, which
are supported by SoftLayer\(aqs API. These products each have an ID associated with
them, that can be passed into Salt Cloud with the \fIoptional_products\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
softlayer_hw_test:
  provider: my\-softlayer\-hw
  # CentOS 6.0 \- Minimal Install (64 bit)
  image: 13963
  # 2 x 2.0 GHz Core Bare Metal Instance \- 2 GB Ram
  size: 1921
  # 500GB SATA II
  hdd: 1267
  # San Jose 01
  location: 168642
  domain: example.com
  optional_products:
    # MySQL for Linux
    \- id: 28
    # Business Continuance Insurance
    \- id: 104
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
These values can be manually obtained by looking at the source of an order page
on the SoftLayer web interface. For convenience, many of these values are listed
here:
.SS Public Secondary IP Addresses
.INDENT 0.0
.IP \(bu 2
22: 4 Public IP Addresses
.IP \(bu 2
23: 8 Public IP Addresses
.UNINDENT
.SS Primary IPv6 Addresses
.INDENT 0.0
.IP \(bu 2
17129: 1 IPv6 Address
.UNINDENT
.SS Public Static IPv6 Addresses
.INDENT 0.0
.IP \(bu 2
1481: /64 Block Static Public IPv6 Addresses
.UNINDENT
.SS OS\-Specific Addon
.INDENT 0.0
.IP \(bu 2
17139: XenServer Advanced for XenServer 6.x
.IP \(bu 2
17141: XenServer Enterprise for XenServer 6.x
.IP \(bu 2
2334: XenServer Advanced for XenServer 5.6
.IP \(bu 2
2335: XenServer Enterprise for XenServer 5.6
.IP \(bu 2
13915: Microsoft WebMatrix
.IP \(bu 2
21276: VMware vCenter 5.1 Standard
.UNINDENT
.SS Control Panel Software
.INDENT 0.0
.IP \(bu 2
121: cPanel/WHM with Fantastico and RVskin
.IP \(bu 2
20778: Parallels Plesk Panel 11 (Linux) 100 Domain w/ Power Pack
.IP \(bu 2
20786: Parallels Plesk Panel 11 (Windows) 100 Domain w/ Power Pack
.IP \(bu 2
20787: Parallels Plesk Panel 11 (Linux) Unlimited Domain w/ Power Pack
.IP \(bu 2
20792: Parallels Plesk Panel 11 (Windows) Unlimited Domain w/ Power Pack
.IP \(bu 2
2340: Parallels Plesk Panel 10 (Linux) 100 Domain w/ Power Pack
.IP \(bu 2
2339: Parallels Plesk Panel 10 (Linux) Unlimited Domain w/ Power Pack
.IP \(bu 2
13704: Parallels Plesk Panel 10 (Windows) Unlimited Domain w/ Power Pack
.UNINDENT
.SS Database Software
.INDENT 0.0
.IP \(bu 2
29: MySQL 5.0 for Windows
.IP \(bu 2
28: MySQL for Linux
.IP \(bu 2
21501: Riak 1.x
.IP \(bu 2
20893: MongoDB
.IP \(bu 2
30: Microsoft SQL Server 2005 Express
.IP \(bu 2
92: Microsoft SQL Server 2005 Workgroup
.IP \(bu 2
90: Microsoft SQL Server 2005 Standard
.IP \(bu 2
94: Microsoft SQL Server 2005 Enterprise
.IP \(bu 2
1330: Microsoft SQL Server 2008 Express
.IP \(bu 2
1340: Microsoft SQL Server 2008 Web
.IP \(bu 2
1337: Microsoft SQL Server 2008 Workgroup
.IP \(bu 2
1334: Microsoft SQL Server 2008 Standard
.IP \(bu 2
1331: Microsoft SQL Server 2008 Enterprise
.IP \(bu 2
2179: Microsoft SQL Server 2008 Express R2
.IP \(bu 2
2173: Microsoft SQL Server 2008 Web R2
.IP \(bu 2
2183: Microsoft SQL Server 2008 Workgroup R2
.IP \(bu 2
2180: Microsoft SQL Server 2008 Standard R2
.IP \(bu 2
2176: Microsoft SQL Server 2008 Enterprise R2
.UNINDENT
.SS Anti\-Virus & Spyware Protection
.INDENT 0.0
.IP \(bu 2
594: McAfee VirusScan Anti\-Virus \- Windows
.IP \(bu 2
414: McAfee Total Protection \- Windows
.UNINDENT
.SS Insurance
.INDENT 0.0
.IP \(bu 2
104: Business Continuance Insurance
.UNINDENT
.SS Monitoring
.INDENT 0.0
.IP \(bu 2
55: Host Ping
.IP \(bu 2
56: Host Ping and TCP Service Monitoring
.UNINDENT
.SS Notification
.INDENT 0.0
.IP \(bu 2
57: Email and Ticket
.UNINDENT
.SS Advanced Monitoring
.INDENT 0.0
.IP \(bu 2
2302: Monitoring Package \- Basic
.IP \(bu 2
2303: Monitoring Package \- Advanced
.IP \(bu 2
2304: Monitoring Package \- Premium Application
.UNINDENT
.SS Response
.INDENT 0.0
.IP \(bu 2
58: Automated Notification
.IP \(bu 2
59: Automated Reboot from Monitoring
.IP \(bu 2
60: 24x7x365 NOC Monitoring, Notification, and Response
.UNINDENT
.SS Intrusion Detection & Protection
.INDENT 0.0
.IP \(bu 2
413: McAfee Host Intrusion Protection w/Reporting
.UNINDENT
.SS Hardware & Software Firewalls
.INDENT 0.0
.IP \(bu 2
411: APF Software Firewall for Linux
.IP \(bu 2
894: Microsoft Windows Firewall
.IP \(bu 2
410: 10Mbps Hardware Firewall
.IP \(bu 2
409: 100Mbps Hardware Firewall
.IP \(bu 2
408: 1000Mbps Hardware Firewall
.UNINDENT
.SS Getting Started With Tencent Cloud
.sp
Tencent Cloud is a secure, reliable and high\-performance cloud compute service
provided by Tencent. It is the 2nd largest Cloud Provider in China.
.SS Dependencies
.sp
The Tencent Cloud driver for Salt Cloud requires the \fBtencentcloud\-sdk\-python\fP package,
which is available at PyPI:
.sp
\fI\%https://pypi.org/project/tencentcloud\-sdk\-python/\fP
.sp
This package can be installed using \fBpip\fP or \fBeasy_install\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# pip install tencentcloud\-sdk\-python
# easy_install tencentcloud\-sdk\-python
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Provider Configuration
.INDENT 0.0
.TP
.B To use this module, set up the cloud configuration at
\fB/etc/salt/cloud.providers\fP or \fB/etc/salt/cloud.providers.d/*.conf\fP:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-tencentcloud\-config:
  driver: tencentcloud
  # Tencent Cloud Secret Id
  id: AKIDA64pOio9BMemkApzevX0HS169S4b750A
  # Tencent Cloud Secret Key
  key: 8r2xmPn0C5FDvRAlmcJimiTZKVRsk260
  # Tencent Cloud Region
  location: ap\-guangzhou
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configuration Parameters
.SS driver
.sp
\fBRequired\fP\&. \fBtencentcloud\fP to use this module.
.SS id
.sp
\fBRequired\fP\&. Your Tencent Cloud secret id.
.SS key
.sp
\fBRequired\fP\&. Your Tencent Cloud secret key.
.SS location
.sp
\fBOptional\fP\&. If this value is not specified, the default is \fBap\-guangzhou\fP\&.
Available locations can be found using the \fB\-\-list\-locations\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-location my\-tencentcloud\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Profile Configuration
.sp
Tencent Cloud profiles require a \fBprovider\fP, \fBavailability_zone\fP, \fBimage\fP and \fBsize\fP\&.
Set up an initial profile at \fB/etc/salt/cloud.profiles\fP or \fB/etc/salt/cloud.profiles.d/*.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tencentcloud\-guangzhou\-s1sm1:
    provider: my\-tencentcloud\-config
    availability_zone: ap\-guangzhou\-3
    image: img\-31tjrtph
    size: S1.SMALL1
    allocate_public_ip: True
    internet_max_bandwidth_out: 1
    password: \(aq153e41ec96140152\(aq
    securitygroups:
        \- sg\-5e90804b
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configuration Parameters
.SS provider
.sp
\fBRequired\fP\&. Name of entry in \fBsalt/cloud.providers.d/???\fP file.
.SS availability_zone
.sp
\fBRequired\fP\&. The availability zone that the instance is located in.
Available zones can be found using the \fBlist_availability_zones\fP function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-f list_availability_zones my\-tencentcloud\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.SS image
.sp
\fBRequired\fP\&. The image id to use for the instance.
Available images can be found using the \fB\-\-list\-images\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-images my\-tencentcloud\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.SS size
.sp
\fBRequired\fP\&. Instance type for instance can be found using the \fB\-\-list\-sizes\fP option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-sizes my\-tencentcloud\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.SS securitygroups
.sp
\fBOptional\fP\&. A list of security group ids to associate with.
Available security group ids can be found using the \fBlist_securitygroups\fP function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-f list_securitygroups my\-tencentcloud\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple security groups are supported:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tencentcloud\-guangzhou\-s1sm1:
    securitygroups:
        \- sg\-5e90804b
        \- sg\-8kpynf2t
.ft P
.fi
.UNINDENT
.UNINDENT
.SS hostname
.sp
\fBOptional\fP\&. The hostname of the instance.
.SS instance_charge_type
.sp
\fBOptional\fP\&. The charge type of the instance. Valid values are \fBPREPAID\fP,
\fBPOSTPAID_BY_HOUR\fP and \fBSPOTPAID\fP\&. The default is \fBPOSTPAID_BY_HOUR\fP\&.
.SS instance_charge_type_prepaid_renew_flag
.sp
\fBOptional\fP\&. When enabled, the instance will be renew automatically
when it reaches the end of the prepaid tenancy.
Valid values are \fBNOTIFY_AND_AUTO_RENEW\fP, \fBNOTIFY_AND_MANUAL_RENEW\fP and \fBDISABLE_NOTIFY_AND_MANUAL_RENEW\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This value is only used when \fBinstance_charge_type\fP is set to \fBPREPAID\fP\&.
.UNINDENT
.UNINDENT
.SS instance_charge_type_prepaid_period
.sp
\fBOptional\fP\&. The tenancy time in months of the prepaid instance,
Valid values are \fB1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This value is only used when \fBinstance_charge_type\fP is set to \fBPREPAID\fP\&.
.UNINDENT
.UNINDENT
.SS allocate_public_ip
.sp
\fBOptional\fP\&. Associate a public ip address with an instance
in a VPC or Classic. Boolean value, default is \fBfalse\fP\&.
.SS internet_max_bandwidth_out
.sp
\fBOptional\fP\&. Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bits per second).
Value range: \fB[0, 100]\fP\&. If this value is not specified, the default is \fB0\fP Mbps.
.SS internet_charge_type
.sp
\fBOptional\fP\&. Internet charge type of the instance. Valid values are \fBBANDWIDTH_PREPAID\fP,
\fBTRAFFIC_POSTPAID_BY_HOUR\fP, \fBBANDWIDTH_POSTPAID_BY_HOUR\fP and \fBBANDWIDTH_PACKAGE\fP\&.
The default is \fBTRAFFIC_POSTPAID_BY_HOUR\fP\&.
.SS key_name
.sp
\fBOptional\fP\&. The key pair to use for the instance, for example \fBskey\-16jig7tx\fP\&.
.SS password
.sp
\fBOptional\fP\&. Login password for the instance.
.SS private_ip
.sp
\fBOptional\fP\&. The private ip to be assigned to this instance,
must be in the provided subnet and available.
.SS project_id
.sp
\fBOptional\fP\&. The project this instance belongs to, defaults to \fB0\fP\&.
.SS vpc_id
.sp
\fBOptional\fP\&. The id of a VPC network.
If you want to create instances in a VPC network, this parameter must be set.
.SS subnet_id
.sp
\fBOptional\fP\&. The id of a VPC subnet.
If you want to create instances in VPC network, this parameter must be set.
.SS system_disk_size
.sp
\fBOptional\fP\&. Size of the system disk.
Value range: \fB[50, 1000]\fP, and unit is \fBGB\fP\&. Default is \fB50\fP GB.
.SS system_disk_type
.sp
\fBOptional\fP\&. Type of the system disk.
Valid values are \fBCLOUD_BASIC\fP, \fBCLOUD_SSD\fP and \fBCLOUD_PREMIUM\fP, default value is \fBCLOUD_BASIC\fP\&.
.SS Actions
.sp
The following actions are supported by the Tencent Cloud Salt Cloud driver.
.SS show_instance
.sp
This action is a thin wrapper around \fB\-\-full\-query\fP, which displays details on a
single instance only. In an environment with several machines, this will save a
user from having to sort through all instance data, just to examine a single
instance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-a show_instance myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.SS show_disk
.sp
Return disk details about a specific instance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-a show_disk myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.SS destroy
.sp
Destroy a Tencent Cloud instance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-a destroy myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.SS start
.sp
Start a Tencent Cloud instance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-a start myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.SS stop
.sp
Stop a Tencent Cloud instance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-a stop myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.SS reboot
.sp
Reboot a Tencent Cloud instance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-a reboot myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Functions
.sp
The following functions are currently supported by the Tencent Cloud Salt Cloud driver.
.SS list_securitygroups
.sp
Lists all Tencent Cloud security groups in current region.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-f list_securitygroups my\-tencentcloud\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.SS list_availability_zones
.sp
Lists all Tencent Cloud availability zones in current region.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-f list_availability_zones my\-tencentcloud\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.SS list_custom_images
.sp
Lists any custom images associated with the account. These images can
be used to create a new instance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-f list_custom_images my\-tencentcloud\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.SS show_image
.sp
Return details about a specific image. This image can be used
to create a new instance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-f show_image tencentcloud image=img\-31tjrtph
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Getting Started With Vagrant
.sp
The Vagrant driver is a new, experimental driver for spinning up a VagrantBox
virtual machine, and installing Salt on it.
.SS Dependencies
.sp
The Vagrant driver itself has no external dependencies.
.sp
The machine which will host the VagrantBox must be an already existing minion
of the cloud server\(aqs Salt master.
It must have \fI\%Vagrant\fP installed, and a Vagrant\-compatible virtual machine engine,
such as \fI\%VirtualBox\fP\&.
(Note: The Vagrant driver does not depend on the salt\-cloud VirtualBox driver in any way.)
.sp
[Caution: The version of Vagrant packaged for \fBapt install\fP in Ubuntu 16.04 will not connect a bridged
network adapter correctly. Use a version downloaded directly from the web site.]
.sp
Include the Vagrant guest editions plugin:
\fBvagrant plugin install vagrant\-vbguest\fP\&.
.SS Configuration
.sp
Configuration of the client virtual machine (using VirtualBox, VMware, etc)
will be done by Vagrant as specified in the Vagrantfile on the host machine.
.sp
Salt\-cloud will push the commands to install and provision a salt minion on
the virtual machine, so you need not (perhaps \fBshould\fP not) provision salt
in your Vagrantfile, in most cases.
.sp
If, however, your cloud master cannot open an SSH connection to the child VM,
you may \fBneed\fP to let Vagrant provision the VM with Salt, and use some other
method (such as passing a pillar dictionary to the VM) to pass the master\(aqs
IP address to the VM. The VM can then attempt to reach the salt master in the
usual way for non\-cloud minions. Specify the profile configuration argument
as \fBdeploy: False\fP to prevent the cloud master from trying.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example is for /etc/salt/cloud.providers file or any file in
# the /etc/salt/cloud.providers.d/ directory.

my\-vagrant\-config:
  minion:
    master: 111.222.333.444
  provider: vagrant
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Because the Vagrant driver needs a place to store the mapping between the
node name you use for Salt commands and the Vagrantfile which controls the VM,
you must configure your salt minion as a Salt smb server.
(See \fI\%host provisioning example\fP below.)
.SS Profiles
.sp
Vagrant requires a profile to be configured for each machine that needs Salt
installed. The initial profile can be set up at \fB/etc/salt/cloud.profiles\fP
or in the \fB/etc/salt/cloud.profiles.d/\fP directory.
.sp
Each profile requires a \fBvagrantfile\fP parameter. If the Vagrantfile has
definitions for \fI\%multiple machines\fP then you need a \fBmachine\fP parameter,
.sp
Salt\-cloud uses SSH to provision the minion. There must be a routable path
from the cloud master to the VM. Usually, you will want to use
a bridged network adapter for SSH. The address may not be known until
DHCP assigns it. If \fBssh_host\fP is not defined, and \fBtarget_network\fP
is defined, the driver will attempt to read the address from the output
of an \fBifconfig\fP command. Lacking either setting,
the driver will try to use the value Vagrant returns as its \fBssh_host\fP,
which will work only if the cloud master is running somewhere on the same host.
.sp
The \fBtarget_network\fP setting should be used
to identify the IP network your bridged adapter is expected to appear on.
Use CIDR notation, like \fBtarget_network: \(aq2001:DB8::/32\(aq\fP
or \fBtarget_network: \(aq192.0.2.0/24\(aq\fP\&.
.sp
Profile configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/cloud.profiles.d/vagrant.conf

vagrant\-machine:
  host: my\-vhost  # the Salt id of the virtual machine\(aqs host computer.
  provider: my\-vagrant\-config
  cwd: /srv/machines  # the path to your Vagrantfile.
  vagrant_runas: my\-username  # the username who defined the Vagrantbox on the host
  # vagrant_up_timeout: 300 # (seconds) timeout for cmd.run of the \(dqvagrant up\(dq command
  # vagrant_provider: \(aq\(aq # option for \(dqvagrant up\(dq like: \(dq\-\-provider vmware_fusion\(dq
  # ssh_host: None  # \(dqNone\(dq means try to find the routable IP address from \(dqifconfig\(dq
  # ssh_username: \(aq\(aq # also required when ssh_host is used.
  # target_network: None  # Expected CIDR address range of your bridged network
  # force_minion_config: false  # Set \(dqtrue\(dq to re\-purpose an existing VM
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The machine can now be created and configured with the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p vagrant\-machine my\-id
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will create the machine specified by the cloud profile
\fBvagrant\-machine\fP, and will give the machine the minion id of
\fBmy\-id\fP\&. If the cloud master is also the salt\-master, its Salt
key will automatically be accepted on the master.
.sp
Once a salt\-minion has been successfully installed on the instance, connectivity
to it can be verified with Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt my\-id test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Provisioning a Vagrant cloud host (example)
.sp
In order to query or control minions it created, each host
minion needs to track the Salt node names associated with
any guest virtual machines on it.
It does that using a Salt sdb database.
.sp
The Salt sdb is not configured by default. The following example shows a
simple installation.
.sp
This example assumes:
.INDENT 0.0
.IP \(bu 2
you are on a large network using the 10.x.x.x IP address space
.IP \(bu 2
your Salt master\(aqs Salt id is \(dqbevymaster\(dq
.IP \(bu 2
it will also be your salt\-cloud controller
.IP \(bu 2
it is at hardware address 10.124.30.7
.IP \(bu 2
it is running a recent Debian family Linux (raspbian)
.IP \(bu 2
your workstation is a Salt minion of bevymaster
.IP \(bu 2
your workstation\(aqs minion id is \(dqmy_laptop\(dq
.IP \(bu 2
VirtualBox has been installed on \(dqmy_laptop\(dq (apt install is okay)
.IP \(bu 2
Vagrant was installed from vagrantup.com. (not the 16.04 Ubuntu apt)
.IP \(bu 2
\(dqmy_laptop\(dq has done \(dqvagrant plugin install vagrant\-vbguest\(dq
.IP \(bu 2
the VM you want to start is on \(dqmy_laptop\(dq at \(dq/home/my_username/Vagrantfile\(dq
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# file /etc/salt/minion.d/vagrant_sdb.conf on host computer \(dqmy_laptop\(dq
#  \-\- this sdb database is required by the Vagrant module \-\-
vagrant_sdb_data:  # The sdb database must have this name.
  driver: sqlite3  # Let\(aqs use SQLite to store the data ...
  database: /var/cache/salt/vagrant.sqlite  # ... in this file ...
  table: sdb  # ... using this table name.
  create_table: True  # if not present
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Remember to re\-start your minion after changing its configuration files...
.INDENT 0.0
.INDENT 3.5
\fBsudo systemctl restart salt\-minion\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# \-*\- mode: ruby \-*\-
# file /home/my_username/Vagrantfile on host computer \(dqmy_laptop\(dq
BEVY = \(dqbevy1\(dq
DOMAIN = BEVY + \(dq.test\(dq  # .test is an ICANN reserved non\-public TLD

# must supply a list of names to avoid Vagrant asking for interactive input
def get_good_ifc()   # try to find a working Ubuntu network adapter name
  addr_infos = Socket.getifaddrs
  addr_infos.each do |info|
    a = info.addr
    if a and a.ip? and not a.ip_address.start_with?(\(dq127.\(dq)
     return info.name
     end
  end
  return \(dqeth0\(dq  # fall back to an old reliable name
end

Vagrant.configure(2) do |config|
  config.ssh.forward_agent = true  # so you can use git ssh://...

  # add a bridged network interface. (try to detect name, then guess MacOS names, too)
  interface_guesses = [get_good_ifc(), \(aqen0: Ethernet\(aq, \(aqen1: Wi\-Fi (AirPort)\(aq]
  config.vm.network \(dqpublic_network\(dq, bridge: interface_guesses
  if ARGV[0] == \(dqup\(dq
    puts \(dqTrying bridge network using interfaces: #{interface_guesses}\(dq
  end
  config.vm.provision \(dqshell\(dq, inline: \(dqip address\(dq, run: \(dqalways\(dq  # make user feel good

  # . . . . . . . . . . . . Define machine QUAIL1 . . . . . . . . . . . . . .
  config.vm.define \(dqquail1\(dq, primary: true do |quail_config|
    quail_config.vm.box = \(dqboxesio/xenial64\-standard\(dq  # a public VMware & Virtualbox box
    quail_config.vm.hostname = \(dqquail1.\(dq + DOMAIN  # supply a name in our bevy
    quail_config.vm.provider \(dqvirtualbox\(dq do |v|
        v.memory = 1024       # limit memory for the virtual box
        v.cpus = 1
        v.linked_clone = true # make a soft copy of the base Vagrant box
        v.customize [\(dqmodifyvm\(dq, :id, \(dq\-\-natnet1\(dq, \(dq192.168.128.0/24\(dq]  # do not use 10.x network for NAT
    end
  end
end
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# file /etc/salt/cloud.profiles.d/my_vagrant_profiles.conf on bevymaster
q1:
  host: my_laptop  # the Salt id of your virtual machine host
  machine: quail1   # a machine name in the Vagrantfile (if not primary)
  vagrant_runas: my_username  # owner of Vagrant box files on \(dqmy_laptop\(dq
  cwd: \(aq/home/my_username\(aq # the path (on \(dqmy_laptop\(dq) of the Vagrantfile
  provider: my_vagrant_provider  # name of entry in provider.conf file
  target_network: \(aq10.0.0.0/8\(aq  # VM external address will be somewhere here
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# file /etc/salt/cloud.providers.d/vagrant_provider.conf on bevymaster
my_vagrant_provider:
  driver: vagrant
  minion:
    master: 10.124.30.7  # the hard address of the master
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Create and use your new Salt minion
.INDENT 0.0
.IP \(bu 2
Typing on the Salt master computer \fBbevymaster\fP, tell it to create a new minion named \fBv1\fP using profile \fBq1\fP\&...
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo salt\-cloud \-p q1 v1
sudo salt v1 network.ip_addrs
  [ you get a list of IP addresses, including the bridged one ]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
logged in to your laptop (or some other computer known to GitHub)...
.INDENT 2.0
.INDENT 3.5
[NOTE:] if you are using MacOS, you need to type \fBssh\-add \-K\fP after each boot,
unless you use one of the methods in \fI\%this gist\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh \-A vagrant@< the bridged network address >
  # [ or, if you are at /home/my_username/ on my_laptop ]
vagrant ssh quail1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
then typing on your new node \(dqv1\(dq (a.k.a. quail1.bevy1.test)...
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
password: vagrant
  # [ stuff types out ... ]

ls \-al /vagrant
  # [ should be shared /home/my_username from my_laptop ]

# you can access other network facilities using the ssh authorization
# as recorded in your ~.ssh/ directory on my_laptop ...

sudo apt update
sudo apt install git
git clone ssh://git@github.com/yourID/your_project
# etc...
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Getting Started with VEXXHOST
.sp
\fI\%VEXXHOST\fP is a cloud computing host which provides
\fI\%Canadian cloud computing\fP services
which are based in Monteral and use the libcloud OpenStack driver.  VEXXHOST
currently runs the Havana release of OpenStack.  When provisioning new
instances, they automatically get a public IP and private IP address.
Therefore, you do not need to assign a floating IP to access your instance
after it\(aqs booted.
.SS Cloud Provider Configuration
.sp
To use the \fIopenstack\fP driver for the VEXXHOST public cloud, you will need to
set up the cloud provider configuration file as in the example below:
.sp
\fB/etc/salt/cloud.providers.d/vexxhost.conf\fP:
In order to use the VEXXHOST public cloud, you will need to setup a cloud
provider configuration file as in the example below which uses the OpenStack
driver.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-vexxhost\-config:
  # Set the location of the salt\-master
  #
  minion:
    master: saltmaster.example.com

  # Configure VEXXHOST using the OpenStack plugin
  #
  identity_url: http://auth.api.thenebulacloud.com:5000/v2.0/tokens
  compute_name: nova

  # Set the compute region:
  #
  compute_region: na\-yul\-nhs1

  # Configure VEXXHOST authentication credentials
  #
  user: your\-tenant\-id
  password: your\-api\-key
  tenant: your\-tenant\-name

  # keys to allow connection to the instance launched
  #
  ssh_key_name: yourkey
  ssh_key_file: /path/to/key/yourkey.priv

  driver: openstack
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Authentication
.sp
All of the authentication fields that you need can be found by logging into
your VEXXHOST customer center.  Once you\(aqve logged in, you will need to click
on \(dqCloudConsole\(dq and then click on \(dqAPI Credentials\(dq.
.SS Cloud Profile Configuration
.sp
In order to get the correct image UUID and the instance type to use in the
cloud profile, you can run the following command respectively:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-images=vexxhost\-config
# salt\-cloud \-\-list\-sizes=vexxhost\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once you have that, you can go ahead and create a new cloud profile.  This
profile will build an Ubuntu 12.04 LTS \fInb.2G\fP instance.
.sp
\fB/etc/salt/cloud.profiles.d/vh_ubuntu1204_2G.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vh_ubuntu1204_2G:
  provider: my\-vexxhost\-config
  image: 4051139f\-750d\-4d72\-8ef0\-074f2ccc7e5a
  size: nb.2G
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Provision an instance
.sp
To create an instance based on the sample profile that we created above, you
can run the following \fIsalt\-cloud\fP command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-p vh_ubuntu1204_2G vh_instance1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Typically, instances are provisioned in under 30 seconds on the VEXXHOST public
cloud.  After the instance provisions, it will be set up a minion and then
return all the instance information once it\(aqs complete.
.sp
Once the instance has been setup, you can test connectivity to it by running
the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt vh_instance1 test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can now continue to provision new instances and they will all automatically
be set up as minions of the master you\(aqve defined in the configuration file.
.SS Getting Started With Virtualbox
.sp
The Virtualbox cloud module allows you to manage a \fBlocal\fP Virtualbox hypervisor. Remote hypervisors may come later on.
.SS Dependencies
.sp
The virtualbox module for Salt Cloud requires the \fI\%Virtualbox SDK\fP
which is contained in a virtualbox installation from
.sp
\fI\%https://www.virtualbox.org/wiki/Downloads\fP
.SS Configuration
.sp
The Virtualbox cloud module just needs to use the virtualbox driver for now. Virtualbox will be run as the running user.
.sp
\fB/etc/salt/cloud.providers\fP or \fB/etc/salt/cloud.providers.d/virtualbox.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
virtualbox\-config:
   driver: virtualbox
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Profiles
.sp
Set up an initial profile at \fB/etc/salt/cloud.profiles\fP or
\fB/etc/salt/cloud.profiles.d/virtualbox.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
virtualbox\-test:
    provider: virtualbox\-config
    clonefrom: VM_to_clone_from
    # Optional
    power_on: True
    deploy: True
    ssh_username: a_username
    password: a_password
    sudo: a_username
    sudo_password: a_password
    # Example minion config
    minion:
        master: localhost
    make_master: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
\fBclonefrom\fP \fBMandatory\fP
Enter the name of the VM/template to clone from.
.UNINDENT
.sp
So far only machines can only be cloned and automatically provisioned by Salt Cloud.
.SS Provisioning
.sp
In order to provision when creating a new machine \fBpower_on\fP and \fBdeploy\fP have to be \fBTrue\fP\&.
.sp
Furthermore to connect to the VM \fBssh_username\fP and \fBpassword\fP will have to be set.
.sp
\fBsudo\fP and \fBsudo_password\fP are the credentials for getting root access in order to deploy salt
.SS Actions
.INDENT 0.0
.TP
.B \fBstart\fP
Attempt to boot a VM by name. VMs should have unique names in order to boot the correct one.
.TP
.B \fBstop\fP
Attempt to stop a VM. This is akin to a force shutdown or 5 second press.
.UNINDENT
.SS Functions
.INDENT 0.0
.TP
.B \fBshow_image\fP
Show all available information about a VM given by the \fIimage\fP parameter
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-cloud \-f show_image virtualbox image=my_vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Getting Started With VMware
.sp
New in version 2015.5.4.

.sp
\fBAuthor\fP: Nitin Madhok <\fI\%nmadhok@g.clemson.edu\fP>
.sp
The VMware cloud module allows you to manage VMware ESX, ESXi, and vCenter.
.SS Dependencies
.sp
The vmware module for Salt Cloud requires the \fBpyVmomi\fP package, which is
available at PyPI:
.sp
\fI\%https://pypi.org/project/pyvmomi/\fP
.sp
This package can be installed using \fIpip\fP or \fIeasy_install\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyvmomi
easy_install pyvmomi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Version 6.0 of pyVmomi has some problems with SSL error handling on certain
versions of Python. If using version 6.0 of pyVmomi, the machine that you
are running the proxy minion process from must have either Python 2.7.9 or
newer This is due to an upstream dependency in pyVmomi 6.0 that is not supported
in Python version 2.6 to 2.7.8. If the version of Python running the salt\-cloud
command is not in the supported range, you will need to install an earlier version
of pyVmomi. See \fI\%Issue #29537\fP for more information.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
pyVmomi doesn\(aqt expose the ability to specify the locale when connecting to
VMware. This causes parsing issues when connecting to an instance of VMware
running under a non\-English locale. Until this feature is added upstream
\fI\%Issue #38402\fP contains a workaround.
.UNINDENT
.UNINDENT
.SS Configuration
.sp
The VMware cloud module needs the vCenter or ESX/ESXi URL, username and password to be
set up in the cloud configuration at
\fB/etc/salt/cloud.providers\fP or \fB/etc/salt/cloud.providers.d/vmware.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-vmware\-config:
  driver: vmware
  user: \(aqDOMAIN\euser\(aq
  password: \(aqverybadpass\(aq
  url: \(aq10.20.30.40\(aq

vcenter01:
  driver: vmware
  user: \(aqDOMAIN\euser\(aq
  password: \(aqverybadpass\(aq
  url: \(aqvcenter01.domain.com\(aq
  protocol: \(aqhttps\(aq
  port: 443

vcenter02:
  driver: vmware
  user: \(aqDOMAIN\euser\(aq
  password: \(aqverybadpass\(aq
  url: \(aqvcenter02.domain.com\(aq
  protocol: \(aqhttp\(aq
  port: 80

vcenter03\-do\-not\-verify:
  driver: vmware
  user: \(aqDOMAIN\euser\(aq
  password: \(aqverybadpass\(aq
  url: \(aqvcenter01.domain.com\(aq
  protocol: \(aqhttps\(aq
  port: 443
  verify_ssl: False

esx01:
  driver: vmware
  user: \(aqadmin\(aq
  password: \(aqverybadpass\(aq
  url: \(aqesx01.domain.com\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Optionally, \fBprotocol\fP and \fBport\fP can be specified if the vCenter
server is not using the defaults. Default is \fBprotocol: https\fP and
\fBport: 443\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider configuration was renamed to \fBdriver\fP\&.
This change was made to avoid confusion with the \fBprovider\fP parameter that is
used in cloud profile configuration. Cloud provider configuration now uses \fBdriver\fP
to refer to the salt\-cloud driver that provides the underlying functionality to
connect to a cloud provider, while cloud profile configuration continues to use
\fBprovider\fP to refer to the cloud provider configuration that you define.
.UNINDENT
.UNINDENT
.SS Profiles
.sp
Set up an initial profile at \fB/etc/salt/cloud.profiles\fP or
\fB/etc/salt/cloud.profiles.d/vmware.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vmware\-centos6.5:
  provider: vcenter01
  clonefrom: test\-vm

  ## Optional arguments
  num_cpus: 4
  memory: 8GB
  devices:
    cd:
      CD/DVD drive 1:
        device_type: datastore_iso_file
        iso_path: \(dq[nap004\-1] vmimages/tools\-isoimages/linux.iso\(dq
      CD/DVD drive 2:
        device_type: client_device
        mode: atapi
        controller: IDE 2
      CD/DVD drive 3:
        device_type: client_device
        mode: passthrough
        controller: IDE 3
    disk:
      Hard disk 1:
        size: 30
      Hard disk 2:
        size: 20
        controller: SCSI controller 2
      Hard disk 3:
        size: 5
        controller: SCSI controller 3
        datastore: smalldiskdatastore
    network:
      Network adapter 1:
        name: 10.20.30\-400\-Test
        switch_type: standard
        ip: 10.20.30.123
        gateway: [10.20.30.110]
        subnet_mask: 255.255.255.128
        domain: example.com
      Network adapter 2:
        name: 10.30.40\-500\-Dev\-DHCP
        adapter_type: e1000
        switch_type: distributed
        mac: \(aq00:16:3e:e8:19:0f\(aq
      Network adapter 3:
        name: 10.40.50\-600\-Prod
        adapter_type: vmxnet3
        switch_type: distributed
        ip: 10.40.50.123
        gateway: [10.40.50.110]
        subnet_mask: 255.255.255.128
        domain: example.com
    scsi:
      SCSI controller 1:
        type: lsilogic
      SCSI controller 2:
        type: lsilogic_sas
        bus_sharing: virtual
      SCSI controller 3:
        type: paravirtual
        bus_sharing: physical
    ide:
      IDE 2: {}
      IDE 3: {}

  domain: example.com
  dns_servers:
    \- 123.127.255.240
    \- 123.127.255.241
    \- 123.127.255.242

  resourcepool: Resources
  cluster: Prod

  datastore: HUGE\-DATASTORE\-Cluster
  folder: Development
  datacenter: DC1
  host: c4212n\-002.domain.com
  template: False
  power_on: True
  extra_config:
    mem.hotadd: \(aqyes\(aq
    guestinfo.foo: bar
    guestinfo.domain: foobar.com
    guestinfo.customVariable: customValue
  annotation: Created by Salt\-Cloud

  deploy: True
  customization: True
  private_key: /root/.ssh/mykey.pem
  ssh_username: cloud\-user
  password: veryVeryBadPassword
  minion:
    master: 123.127.193.105

  file_map:
    /path/to/local/custom/script: /path/to/remote/script
    /path/to/local/file: /path/to/remote/file
    /srv/salt/yum/epel.repo: /etc/yum.repos.d/epel.repo

  hardware_version: 10
  image: centos64Guest

  #For Windows VM
  win_username: Administrator
  win_password: administrator
  win_organization_name: ABC\-Corp
  plain_text: True
  win_installer: /root/Salt\-Minion\-2015.8.4\-AMD64\-Setup.exe
  win_user_fullname: Windows User
  verify_ssl: False
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \fBprovider\fP
Enter the name that was specified when the cloud provider config was created.
.TP
.B \fBclonefrom\fP
Enter the name of the VM/template to clone from. If not specified, the VM will be created
without cloning.
.TP
.B \fBnum_cpus\fP
Enter the number of vCPUS that you want the VM/template to have. If not specified,
the current VM/template\(aqs vCPU count is used.
.TP
.B \fBcores_per_socket\fP
Enter the number of cores per vCPU that you want the VM/template to have. If not specified,
this will default to 1.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Cores per socket should be less than or equal to the total number of
vCPUs assigned to the VM/template.
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.TP
.B \fBmemory\fP
Enter the memory size (in MB or GB) that you want the VM/template to have. If
not specified, the current VM/template\(aqs memory size is used. Example
\fBmemory: 8GB\fP or \fBmemory: 8192MB\fP\&.
.TP
.B \fBdevices\fP
Enter the device specifications here. Currently, the following devices can be
created or reconfigured:
.INDENT 7.0
.TP
.B cd
Enter the CD/DVD drive specification here. If the CD/DVD drive doesn\(aqt exist,
it will be created with the specified configuration. If the CD/DVD drive
already exists, it will be reconfigured with the specifications. The following
options can be specified per CD/DVD drive:
.INDENT 7.0
.TP
.B device_type
Specify how the CD/DVD drive should be used. Currently supported types are
\fBclient_device\fP and \fBdatastore_iso_file\fP\&. Default is
\fBdevice_type: client_device\fP
.TP
.B iso_path
Enter the path to the iso file present on the datastore only if
\fBdevice_type: datastore_iso_file\fP\&. The syntax to specify this is
\fBiso_path: \(dq[datastoreName] vmimages/tools\-isoimages/linux.iso\(dq\fP\&. This
field is ignored if \fBdevice_type: client_device\fP
.TP
.B mode
Enter the mode of connection only if \fBdevice_type: client_device\fP\&. Currently
supported modes are \fBpassthrough\fP and \fBatapi\fP\&. This field is ignored if
\fBdevice_type: datastore_iso_file\fP\&. Default is \fBmode: passthrough\fP
.TP
.B controller
Specify the IDE controller label to which this drive should be attached.
This should be specified only when creating both the specified IDE
controller as well as the CD/DVD drive at the same time.
.UNINDENT
.TP
.B disk
Enter the disk specification here. If the hard disk doesn\(aqt exist, it will
be created with the provided size. If the hard disk already exists, it will
be expanded if the provided size is greater than the current size of the disk.
.INDENT 7.0
.TP
.B size
Enter the size of disk in GB
.TP
.B thin_provision
Specifies whether the disk should be thin provisioned or not. Default is \fBthin_provision: False\fP\&.
\&.. versionadded:: 2016.3.0
.TP
.B eagerly_scrub
Specifies whether the disk should be rewrite with zeros during thick provisioning or not.
Default is \fBeagerly_scrub: False\fP\&.
\&.. versionadded:: 2018.3.0
.TP
.B controller
Specify the SCSI controller label to which this disk should be attached.
This should be specified only when creating both the specified SCSI
controller as well as the hard disk at the same time.
.TP
.B datastore
The name of a valid datastore should you wish the new disk to be in
a datastore other than the default for the VM.
.UNINDENT
.TP
.B network
Enter the network adapter specification here. If the network adapter doesn\(aqt
exist, a new network adapter will be created with the specified network name,
type and other configuration. If the network adapter already exists, it will
be reconfigured with the specifications. The following additional options can
be specified per network adapter (See example above):
.INDENT 7.0
.TP
.B name
Enter the network name you want the network adapter to be mapped to.
.TP
.B adapter_type
Enter the network adapter type you want to create. Currently supported
types are \fBvmxnet\fP, \fBvmxnet2\fP, \fBvmxnet3\fP, \fBe1000\fP and \fBe1000e\fP\&.
If no type is specified, by default \fBvmxnet3\fP will be used.
.TP
.B switch_type
Enter the type of switch to use. This decides whether to use a standard
switch network or a distributed virtual portgroup. Currently supported
types are \fBstandard\fP for standard portgroups and \fBdistributed\fP for
distributed virtual portgroups.
.TP
.B ip
Enter the static IP you want the network adapter to be mapped to. If the
network specified is DHCP enabled, you do not have to specify this.
.TP
.B gateway
Enter the gateway for the network as a list. If the network specified
is DHCP enabled, you do not have to specify this.
.TP
.B subnet_mask
Enter the subnet mask for the network. If the network specified is DHCP
enabled, you do not have to specify this.
.TP
.B domain
Enter the domain to be used with the network adapter. If the network
specified is DHCP enabled, you do not have to specify this.
.TP
.B mac
Enter the MAC for this network adapter. If not specified an address
will be selected automatically.
.UNINDENT
.TP
.B scsi
Enter the SCSI controller specification here. If the SCSI controller doesn\(aqt exist,
a new SCSI controller will be created of the specified type. If the SCSI controller
already exists, it will be reconfigured with the specifications. The following
additional options can be specified per SCSI controller:
.INDENT 7.0
.TP
.B type
Enter the SCSI controller type you want to create. Currently supported
types are \fBlsilogic\fP, \fBlsilogic_sas\fP and \fBparavirtual\fP\&. Type must
be specified when creating a new SCSI controller.
.TP
.B bus_sharing
Specify this if sharing of virtual disks between virtual machines is desired.
The following can be specified:
.INDENT 7.0
.TP
.B virtual
Virtual disks can be shared between virtual machines on the same server.
.TP
.B physical
Virtual disks can be shared between virtual machines on any server.
.TP
.B no
Virtual disks cannot be shared between virtual machines.
.UNINDENT
.UNINDENT
.TP
.B ide
Enter the IDE controller specification here. If the IDE controller doesn\(aqt exist,
a new IDE controller is created. If the IDE controller already exists,
no further changes to it are made. The IDE controller specification is
a dictionary.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ide:
  IDE 2: {}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBdomain\fP
Enter the global domain name to be used for DNS. If not specified and if the VM name
is a FQDN, \fBdomain\fP is set to the domain from the VM name. Default is \fBlocal\fP\&.
.TP
.B \fBdns_servers\fP
Enter the list of DNS servers to use in order of priority.
.TP
.B \fBresourcepool\fP
Enter the name of the resourcepool to which the new virtual machine should be
attached. This determines what compute resources will be available to the clone.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
For a clone operation from a virtual machine, it will use the same
resourcepool as the original virtual machine unless specified.
.IP \(bu 2
For a clone operation from a template to a virtual machine, specifying
either this or cluster is required. If both are specified, the resourcepool
value will be used.
.IP \(bu 2
For a clone operation to a template, this argument is ignored.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBcluster\fP
Enter the name of the cluster whose resource pool the new virtual machine should
be attached to.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
For a clone operation from a virtual machine, it will use the same cluster\(aqs
resourcepool as the original virtual machine unless specified.
.IP \(bu 2
For a clone operation from a template to a virtual machine, specifying either
this or resourcepool is required. If both are specified, the resourcepool
value will be used.
.IP \(bu 2
For a clone operation to a template, this argument is ignored.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBdatastore\fP
Enter the name of the datastore or the datastore cluster where the virtual machine
should be located on physical storage. If not specified, the current datastore is
used.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
If you specify a datastore cluster name, DRS Storage recommendation is
automatically applied.
.IP \(bu 2
If you specify a datastore name, DRS Storage recommendation is disabled.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBfolder\fP
Enter the name of the folder that will contain the new virtual machine.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
For a clone operation from a VM/template, the new VM/template will be added
to the same folder that the original VM/template belongs to unless specified.
.IP \(bu 2
If both folder and datacenter are specified, the folder value will be used.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBdatacenter\fP
Enter the name of the datacenter that will contain the new virtual machine.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
For a clone operation from a VM/template, the new VM/template will be added
to the same folder that the original VM/template belongs to unless specified.
.IP \(bu 2
If both folder and datacenter are specified, the folder value will be used.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBhost\fP
Enter the name of the target host where the virtual machine should be registered.
.sp
If not specified:
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
If resource pool is not specified, current host is used.
.IP \(bu 2
If resource pool is specified, and the target pool represents a stand\-alone
host, the host is used.
.IP \(bu 2
If resource pool is specified, and the target pool represents a DRS\-enabled
cluster, a host selected by DRS is used.
.IP \(bu 2
If resource pool is specified and the target pool represents a cluster without
DRS enabled, an InvalidArgument exception be thrown.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBtemplate\fP
Specifies whether the new virtual machine should be marked as a template or not.
Default is \fBtemplate: False\fP\&.
.TP
.B \fBpower_on\fP
Specifies whether the new virtual machine should be powered on or not. If
\fBtemplate: True\fP is set, this field is ignored. Default is \fBpower_on: True\fP\&.
.TP
.B \fBcpu_hot_add\fP
Boolean value that enables hot\-add support for adding CPU resources while
the guest is powered on.
.TP
.B \fBcpu_hot_remove\fP
Boolean value that enables hot\-remove support for removing CPU resources while
the guest is powered on.
.TP
.B \fBmem_hot_add\fP
Boolean value that enables hot\-add support for adding memory resources while
the guest is powered on.
.TP
.B \fBnested_hv\fP
Boolean value that enables support for nested hardware\-assisted virtualization.
.TP
.B \fBvpmc\fP
Boolean value that enables virtual CPU performance counters.
.TP
.B \fBextra_config\fP
Specifies the additional configuration information for the virtual machine. This
describes a set of modifications to the additional options. If the key is already
present, it will be reset with the new value provided. Otherwise, a new option is
added. Keys with empty values will be removed.
.TP
.B \fBannotation\fP
User\-provided description of the virtual machine. This will store a message in the
vSphere interface, under the annotations section in the Summary view of the virtual
machine.
.TP
.B \fBdeploy\fP
Specifies if salt should be installed on the newly created VM. Default is \fBTrue\fP
so salt will be installed using the bootstrap script. If \fBtemplate: True\fP or
\fBpower_on: False\fP is set, this field is ignored and salt will not be installed.
.TP
.B \fBwait_for_ip_timeout\fP
When \fBdeploy: True\fP, this timeout determines the maximum time to wait for
VMware tools to be installed on the virtual machine. If this timeout is
reached, an attempt to determine the client\(aqs IP will be made by resolving
the VM\(aqs name.  By lowering this value a salt bootstrap can be fully
automated for systems that are not built with VMware tools.  Default is
\fBwait_for_ip_timeout: 1200\fP\&.
.TP
.B \fBcustomization\fP
Specify whether the new virtual machine should be customized or not. If
\fBcustomization: False\fP is set, the new virtual machine will not be customized.
Default is \fBcustomization: True\fP\&.
.TP
.B \fBprivate_key\fP
Specify the path to the private key to use to be able to ssh to the VM.
.TP
.B \fBssh_username\fP
Specify the username to use in order to ssh to the VM. Default is \fBroot\fP
.TP
.B \fBpassword\fP
Specify a password to use in order to ssh to the VM. If \fBprivate_key\fP is
specified, you do not need to specify this.
.TP
.B \fBminion\fP
Specify custom minion configuration you want the salt minion to have. A good example
would be to specify the \fBmaster\fP as the IP/DNS name of the master.
.TP
.B \fBfile_map\fP
Specify file/files you want to copy to the VM before the bootstrap script is run
and salt is installed. A good example of using this would be if you need to put
custom repo files on the server in case your server will be in a private network
and cannot reach external networks.
.TP
.B \fBhardware_version\fP
Specify the virtual hardware version for the vm/template that is supported by the
host.
.TP
.B \fBimage\fP
Specify the guest id of the VM. For a full list of supported values see the
VMware vSphere documentation:
.sp
\fI\%https://code.vmware.com/apis?pid=com.vmware.wssdk.apiref.doc&release=vsphere\-60&topic=vim.vm.GuestOsDescriptor.GuestOsIdentifier.html\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For a clone operation, this argument is ignored.
.UNINDENT
.UNINDENT
.TP
.B \fBwin_username\fP
Specify windows vm administrator account.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Windows template should have \(dqadministrator\(dq account.
.UNINDENT
.UNINDENT
.TP
.B \fBwin_password\fP
Specify windows vm administrator account password.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
During network configuration (if network specified), it is used to specify new administrator password for the machine.
.UNINDENT
.UNINDENT
.TP
.B \fBwin_organization_name\fP
.INDENT 7.0
.TP
.B Specify windows vm user\(aqs organization. Default organization name is Organization
VMware vSphere documentation:
.UNINDENT
.sp
\fI\%https://www.vmware.com/support/developer/vc\-sdk/visdk25pubs/ReferenceGuide/vim.vm.customization.UserData.html\fP
.TP
.B \fBwin_user_fullname\fP
.INDENT 7.0
.TP
.B Specify windows vm user\(aqs fullname. Default fullname is \(dqWindows User\(dq
VMware vSphere documentation:
.UNINDENT
.sp
\fI\%https://www.vmware.com/support/developer/vc\-sdk/visdk25pubs/ReferenceGuide/vim.vm.customization.UserData.html\fP
.TP
.B \fBplain_text\fP
Flag to specify whether or not the password is in plain text, rather than encrypted.
VMware vSphere documentation:
.sp
\fI\%https://www.vmware.com/support/developer/vc\-sdk/visdk25pubs/ReferenceGuide/vim.vm.customization.Password.html\fP
.TP
.B \fBwin_installer\fP
Specify windows minion client installer path
.TP
.B \fBwin_run_once\fP
Specify a list of commands to run on first login to a windows minion
.sp
\fI\%https://www.vmware.com/support/developer/vc\-sdk/visdk25pubs/ReferenceGuide/vim.vm.customization.GuiRunOnce.html\fP
.TP
.B \fBverify_ssl\fP
Verify the vmware ssl certificate. The default is True.
.UNINDENT
.SS Cloning a VM
.sp
Cloning VMs/templates is the easiest and the preferred way to work with VMs using the VMware driver.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Cloning operations are unsupported on standalone ESXi hosts, a vCenter server will be required.
.UNINDENT
.UNINDENT
.sp
Example of a minimal profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-minimal\-clone:
  provider: vcenter01
  clonefrom: \(aqtest\-vm\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When cloning a VM, all the profile configuration parameters are optional and the configuration gets inherited from the clone.
.sp
Example to add/resize a disk:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-disk\-example:
  provider: vcenter01
  clonefrom: \(aqtest\-vm\(aq

  devices:
    disk:
      Hard disk 1:
        size: 30
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Depending on the configuration of the VM that is getting cloned, the disk in the resulting clone will differ.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
If the VM has no disk named \(aqHard disk 1\(aq an empty disk with the specified size will be added to the clone.
.IP \(bu 2
If the VM has a disk named \(aqHard disk 1\(aq and the size specified is larger than the original disk, an empty disk with the specified size will be added to the clone.
.IP \(bu 2
If the VM has a disk named \(aqHard disk 1\(aq and the size specified is smaller than the original disk, an empty disk with the original size will be added to the clone.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Example to reconfigure the memory and number of vCPUs:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-disk\-example:
  provider: vcenter01
  clonefrom: \(aqtest\-vm\(aq

  memory: 16GB
  num_cpus: 8
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Instant Cloning a VM
.sp
Instant Cloning a powered\-ON VM is the easiest and the preferred way to work with VMs from controlled point in time using the VMware driver.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Instant Cloning operations are unsupported on standalone ESXi hosts, a vCenter server will be required.
.UNINDENT
.UNINDENT
.sp
Example of a minimal profile when skipping optional parameters:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-minimal\-clone:
  provider: vcenter01
  clonefrom: \(aqtest\-vm\(aq
  instant_clone: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When Instant cloning a VM, all the profile configuration parameters are optional and the configuration gets inherited from the clone.
.sp
Example to specify optional parameters :
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-minimal\-clone:
  provider: vcenter01
  clonefrom: \(aqtest\-vm\(aq
  instant_clone: true
  datastore: \(aqlocal\-0 (1)\(aq
  datacenter: \(aqvAPISdkDatacenter\(aq
  resourcepool: \(aqRP1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Cloning a Template
.sp
Cloning a template works similar to cloning a VM except for the fact that a resource
pool or cluster must be specified additionally in the profile.
.sp
Example of a minimal profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-template\-clone:
 provider: vcenter01
 clonefrom: \(aqtest\-template\(aq
 cluster: \(aqProd\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Cloning from a Snapshot
.sp
New in version 2016.3.5.

.sp
Cloning from a snapshot requires that one of the
supported options be set in the cloud profile.
.sp
Supported options are \fBcreateNewChildDiskBacking\fP,
\fBmoveChildMostDiskBacking\fP, \fBmoveAllDiskBackingsAndAllowSharing\fP
and \fBmoveAllDiskBackingsAndDisallowSharing\fP\&.
.sp
Example of a minimal profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-template\-clone:
  provider: vcenter01
  clonefrom: \(aqsalt_vm\(aq
  snapshot:
    disk_move_type: createNewChildDiskBacking
    # these types are also supported
    # disk_move_type: moveChildMostDiskBacking
    # disk_move_type: moveAllDiskBackingsAndAllowSharing
    # disk_move_type: moveAllDiskBackingsAndDisallowSharing
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Creating a VM
.sp
New in version 2016.3.0.

.sp
Creating a VM from scratch means that more configuration has to be specified in the
profile because there is no place to inherit configuration from.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Unlike most cloud drivers that use prepared images, creating VMs using VMware
cloud driver needs an installation method that requires no human interaction.
For Example: preseeded ISO, kickstart URL or network PXE boot.
.UNINDENT
.UNINDENT
.sp
Example of a minimal profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-minimal\-profile:
  provider: esx01
  datastore: esx01\-datastore
  resourcepool: Resources
  folder: vm
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The example above contains the minimum required configuration needed to create
a VM from scratch. The resulting VM will only have 1 VCPU, 32MB of RAM and will
not have any storage or networking.
.UNINDENT
.UNINDENT
.sp
Example of a complete profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-complete\-example:
  provider: esx01
  datastore: esx01\-datastore
  resourcepool: Resources
  folder: vm

  num_cpus: 2
  memory: 8GB

  image: debian7_64Guest

  devices:
    scsi:
      SCSI controller 0:
        type: lsilogic_sas
    ide:
      IDE 0: {}
      IDE 1: {}
    disk:
      Hard disk 0:
        controller: \(aqSCSI controller 0\(aq
        size: 20
        mode: \(aqindependent_nonpersistent\(aq
    cd:
      CD/DVD drive 0:
        controller: \(aqIDE 0\(aq
        device_type: datastore_iso_file
        iso_path: \(aq[esx01\-datastore] debian\-8\-with\-preseed.iso\(aq
    network:
      Network adapter 0:
        name: \(aqVM Network\(aq
        swith_type: standard
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Depending on VMware ESX/ESXi version, an exact match for \fBimage\fP might not
be available. In such cases, the closest match to another \fBimage\fP should
be used. In the example above, a Debian 8 VM is created using the image
\fBdebian7_64Guest\fP which is for a Debian 7 guest.
.UNINDENT
.UNINDENT
.SS Specifying disk backing mode
.sp
New in version 2016.3.5.

.sp
Disk backing mode can now be specified when cloning a VM. This option
can be set in the cloud profile as shown in example below:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-vm:
  provider: esx01
  datastore: esx01\-datastore
  resourcepool: Resources
  folder: vm


  devices:
    disk:
      Hard disk 1:
        mode: \(aqindependent_nonpersistent\(aq
        size: 42
      Hard disk 2:
        mode: \(aqindependent_nonpersistent\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Getting Started With Xen
.sp
The Xen cloud driver works with Citrix XenServer.
.sp
It can be used with a single XenServer or a XenServer resource pool.
.SS Setup Dependencies
.sp
This driver requires a copy of the freely available \fBXenAPI.py\fP Python module.
.sp
Information about the Xen API Python module in the XenServer SDK
can be found at \fI\%https://pypi.org/project/XenAPI/\fP
.sp
Place a copy of this module on your system. For example, it can
be placed in the \fIsite packages\fP location on your system.
.sp
The location of \fIsite packages\fP can be determined by running:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m site \-\-user\-site
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Provider Configuration
.sp
Xen requires login credentials to a XenServer.
.sp
Set up the provider cloud configuration file at \fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/*.conf\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/cloud.providers.d/myxen.conf
myxen:
  driver: xen
  url: https://10.0.0.120
  user: root
  password: p@ssw0rd
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B url:
The \fBurl\fP option supports both \fBhttp\fP and \fBhttps\fP uri prefixes.
.TP
.B user:
A valid user id to login to the XenServer host.
.TP
.B password:
The associated password for the user.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider definitions was renamed to \fBdriver\fP\&. This
change was made to avoid confusion with the \fBprovider\fP parameter that is used in cloud profile
definitions. Cloud provider definitions now use \fBdriver\fP to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use \fBprovider\fP to refer to provider configurations that you define.
.UNINDENT
.UNINDENT
.SS Profile Configuration
.sp
Xen profiles require a \fBprovider\fP and  \fBimage\fP\&.
.INDENT 0.0
.TP
.B provider:
This will be the name of your defined provider.
.TP
.B image:
The name of the VM template used to clone or copy.
.TP
.B clone:
The default behavior is to clone a template or VM. This is very fast,
but requires the source template or VM to be in the same storage
repository of the new target system. If the source and target are in
different storage repositories then you must copy the source and not
clone it by setting \fBclone: False\fP\&.
.TP
.B deploy:
The provisioning process will attempt to install the Salt minion
service on the new target system by default. This will require login
credentials for Salt cloud to login via ssh to it.  The \fBuser\fP and
\fBpassword\fP options are required.  If \fBdeploy\fP is set to \fBFalse\fP
then these options are not needed.
.TP
.B resource_pool:
The name of the resource pool used for this profile.
.TP
.B storage_repo:
The name of the storage repository for the target system.
.TP
.B ipv4_cidr:
If template is Windows, and running guest tools then a static
ip address can be set.
.TP
.B ipv4_gw:
If template is Windows, and running guest tools then a gateway
can be set.
.UNINDENT
.sp
Set up an initial profile
at \fB/etc/salt/cloud.profiles\fP or in the \fB/etc/salt/cloud.profiles.d/\fP directory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# file: /etc/salt/cloud.profiles.d/xenprofiles.conf
sles:
  provider: myxen
  deploy: False
  image: sles12sp2\-template

suse:
  user: root
  password: p@ssw0rd
  provider: myxen
  image: opensuseleap42_2\-template
  storage_repo: \(aqLocal storage\(aq
  clone: False
  minion:
    master: 10.0.0.20

w2k12:
  provider: myxen
  image: w2k12svr\-template
  clone: True
  userdata_file: /srv/salt/win/files/windows\-firewall.ps1
  win_installer: /srv/salt/win/files/Salt\-Minion\-2016.11.3\-AMD64\-Setup.exe
  win_username: Administrator
  win_password: p@ssw0rd
  use_winrm: False
  ipv4_cidr: 10.0.0.215/24
  ipv4_gw: 10.0.0.1
  minion:
    master: 10.0.0.21
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The first example will create a clone of the sles12sp2\-template in the
same storage repository without deploying the Salt minion.
.sp
The second example will make a copy of the image and deploy a new
suse VM with the Salt minion installed.
.sp
The third example will create a clone of the Windows 2012 template
and deploy the Salt minion.
.sp
The profile can be used with a salt command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p suse  xenvm02
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will create an salt minion instance named \fBxenvm02\fP in Xen. If the command was
executed on the salt\-master, its Salt key will automatically be signed on the master.
.sp
Once the instance has been created with a salt\-minion installed, connectivity to
it can be verified with Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt xenvm02 test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Listing Sizes
.sp
Sizes can be obtained using the \fB\-\-list\-sizes\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-sizes myxen
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Since size information is build in a template this command
is not implemented.
.UNINDENT
.UNINDENT
.SS Listing Images
.sp
Images can be obtained using the \fB\-\-list\-images\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-images myxen
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This command will return a list of templates with details.
.SS Listing Locations
.sp
Locations can be obtained using the \fB\-\-list\-locations\fP option for the \fBsalt\-cloud\fP
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-\-list\-locations myxen
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns a list of resource pools.
.SS Miscellaneous Options
.SS Miscellaneous Salt Cloud Options
.sp
This page describes various miscellaneous options available in Salt Cloud
.SS Deploy Script Arguments
.sp
Custom deploy scripts are unlikely to need custom arguments to be passed to
them, but salt\-bootstrap has been extended quite a bit, and this may be
necessary. script_args can be specified in either the profile or the map file,
to pass arguments to the deploy script:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ec2\-amazon:
  provider: my\-ec2\-config
  image: ami\-1624987f
  size: t1.micro
  ssh_username: ec2\-user
  script: bootstrap\-salt
  script_args: \-c /tmp/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This has also been tested to work with pipes, if needed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
script_args: \(aq| head\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Selecting the File Transport
.sp
By default, Salt Cloud uses SFTP to transfer files to Linux hosts. However, if
SFTP is not available, or specific SCP functionality is needed, Salt Cloud can
be configured to use SCP instead.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_transport: sftp
file_transport: scp
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Sync After Install
.sp
Salt allows users to create custom plugins such as execution, grains, and state
modules which can be synchronised to minions to extend Salt with further
functionality.
.sp
This option will inform Salt Cloud to synchronise your custom modules to the
minion just after it has been created. For this to happen, the following line
needs to be added to the main cloud configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sync_after_install: all
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The available options for this setting are:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
all
beacons
clouds
engines
executors
grains
log
matchers
modules
output
pillar
proxymodules
renderers
returners
sdb
serializers
states
thorium
utils
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A present and non\-falsy value that doesn\(aqt match one of these list items will
assume \fIall\fP, so \fIsync_after_install: True\fP and \fIsync_after_install: all\fP are
equivalent (though the former will produce a warning).
.SS Setting Up New Salt Masters
.sp
It has become increasingly common for users to set up multi\-hierarchal
infrastructures using Salt Cloud. This sometimes involves setting up an
instance to be a master in addition to a minion. With that in mind, you can
now lay down master configuration on a machine by specifying master options
in the profile or map file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
make_master: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will cause Salt Cloud to generate master keys for the instance, and tell
salt\-bootstrap to install the salt\-master package, in addition to the
salt\-minion package.
.sp
The default master configuration is usually appropriate for most users, and
will not be changed unless specific master configuration has been added to the
profile or map:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master:
  user: root
  interface: 0.0.0.0
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Setting Up a Salt Syndic with Salt Cloud
.sp
In addition to \fI\%setting up new Salt Masters\fP, \fI\%syndics\fP can also be
provisioned using Salt Cloud. In order to set up a Salt Syndic via Salt Cloud,
a Salt Master needs to be installed on the new machine and a master configuration
file needs to be set up using the \fBmake_master\fP setting. This setting can be
defined either in a profile config file or in a map file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
make_master: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To install the Salt Syndic, the only other specification that needs to be
configured is the \fBsyndic_master\fP key to specify the location of the master
that the syndic will be reporting to. This modification needs to be placed
in the \fBmaster\fP setting, which can be configured either in the profile,
provider, or \fB/etc/salt/cloud\fP config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master:
  syndic_master: 123.456.789  # may be either an IP address or a hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Many other Salt Syndic configuration settings and specifications can be passed
through to the new syndic machine via the \fBmaster\fP configuration setting.
See the \fI\%Salt Syndic\fP documentation for more information.
.SS SSH Port
.sp
By default ssh port is set to port 22. If you want to use a custom port in
provider, profile, or map blocks use ssh_port option.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_port: 2222
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Delete SSH Keys
.sp
When Salt Cloud deploys an instance, the SSH pub key for the instance is added
to the known_hosts file for the user that ran the salt\-cloud command. When an
instance is deployed, a cloud host generally recycles the IP address for
the instance.  When Salt Cloud attempts to deploy an instance using a recycled
IP address that has previously been accessed from the same machine, the old key
in the known_hosts file will cause a conflict.
.sp
In order to mitigate this issue, Salt Cloud can be configured to remove old
keys from the known_hosts file when destroying the node. In order to do this,
the following line needs to be added to the main cloud configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
delete_sshkeys: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Keeping /tmp/ Files
.sp
When Salt Cloud deploys an instance, it uploads temporary files to /tmp/ for
salt\-bootstrap to put in place. After the script has run, they are deleted. To
keep these files around (mostly for debugging purposes), the \-\-keep\-tmp option
can be added:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p myprofile mymachine \-\-keep\-tmp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For those wondering why /tmp/ was used instead of /root/, this had to be done
for images which require the use of sudo, and therefore do not allow remote
root logins, even for file transfers (which makes /root/ unavailable).
.SS Hide Output From Minion Install
.sp
By default Salt Cloud will stream the output from the minion deploy script
directly to STDOUT. Although this can been very useful, in certain cases you
may wish to switch this off. The following config option is there to enable or
disable this output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
display_ssh_output: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Connection Timeout
.sp
There are several stages when deploying Salt where Salt Cloud needs to wait for
something to happen. The VM getting its IP address, the VM\(aqs SSH port is
available, etc.
.sp
If you find that the Salt Cloud defaults are not enough and your deployment
fails because Salt Cloud did not wait log enough, there are some settings you
can tweak.
.INDENT 0.0
.INDENT 3.5
.IP "Note"
.sp
All settings should be provided in lowercase
All values should be provided in seconds
.UNINDENT
.UNINDENT
.sp
You can tweak these settings globally, per cloud provider, or event per profile
definition.
.SS wait_for_ip_timeout
.sp
The amount of time Salt Cloud should wait for a VM to start and get an IP back
from the cloud host.
Default: varies by cloud provider ( between 5 and 25 minutes)
.SS wait_for_ip_interval
.sp
The amount of time Salt Cloud should sleep while querying for the VM\(aqs IP.
Default: varies by cloud provider ( between .5 and 10 seconds)
.SS ssh_connect_timeout
.sp
The amount of time Salt Cloud should wait for a successful SSH connection to
the VM.
Default: varies by cloud provider  (between 5 and 15 minutes)
.SS wait_for_passwd_timeout
.sp
The amount of time until an ssh connection can be established via password or
ssh key.
Default: varies by cloud provider (mostly 15 seconds)
.SS wait_for_passwd_maxtries
.sp
The number of attempts to connect to the VM until we abandon.
Default: 15 attempts
.SS wait_for_fun_timeout
.sp
Some cloud drivers check for an available IP or a successful SSH connection
using a function, namely, SoftLayer, and SoftLayer\-HW. So, the amount of time
Salt Cloud should retry such functions before failing.
Default: 15 minutes.
.SS wait_for_spot_timeout
.sp
The amount of time Salt Cloud should wait before an EC2 Spot instance is
available. This setting is only available for the EC2 cloud driver.
Default: 10  minutes
.SS Salt Cloud Cache
.sp
Salt Cloud can maintain a cache of node data, for supported providers. The
following options manage this functionality.
.SS update_cachedir
.sp
On supported cloud providers, whether or not to maintain a cache of nodes
returned from a \-\-full\-query. The data will be stored in \fBmsgpack\fP format
under \fB<SALT_CACHEDIR>/cloud/active/<DRIVER>/<PROVIDER>/<NODE_NAME>.p\fP\&. This
setting can be True or False.
.SS diff_cache_events
.sp
When the cloud cachedir is being managed, if differences are encountered
between the data that is returned live from the cloud host and the data in
the cache, fire events which describe the changes. This setting can be True or
False.
.sp
Some of these events will contain data which describe a node. Because some of
the fields returned may contain sensitive data, the \fBcache_event_strip_fields\fP
configuration option exists to strip those fields from the event return.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cache_event_strip_fields:
  \- password
  \- priv_key
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following are events that can be fired based on this data.
.SS salt/cloud/minionid/cache_node_new
.sp
A new node was found on the cloud host which was not listed in the cloud
cachedir. A dict describing the new node will be contained in the event.
.SS salt/cloud/minionid/cache_node_missing
.sp
A node that was previously listed in the cloud cachedir is no longer available
on the cloud host.
.SS salt/cloud/minionid/cache_node_diff
.sp
One or more pieces of data in the cloud cachedir has changed on the cloud
host. A dict containing both the old and the new data will be contained in
the event.
.SS SSH Known Hosts
.sp
Normally when bootstrapping a VM, salt\-cloud will ignore the SSH host key. This
is because it does not know what the host key is before starting (because it
doesn\(aqt exist yet). If strict host key checking is turned on without the key
in the \fBknown_hosts\fP file, then the host will never be available, and cannot
be bootstrapped.
.sp
If a provider is able to determine the host key before trying to bootstrap it,
that provider\(aqs driver can add it to the \fBknown_hosts\fP file, and then turn on
strict host key checking. This can be set up in the main cloud configuration
file (normally \fB/etc/salt/cloud\fP) or in the provider\-specific configuration
file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
known_hosts_file: /path/to/.ssh/known_hosts
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If this is not set, it will default to \fB/dev/null\fP, and strict host key
checking will be turned off.
.sp
It is highly recommended that this option is \fInot\fP set, unless the user has
verified that the provider supports this functionality, and that the image
being used is capable of providing the necessary information. At this time,
only the EC2 driver supports this functionality.
.SS SSH Agent
.sp
New in version 2015.5.0.

.sp
If the ssh key is not stored on the server salt\-cloud is being run on, set
ssh_agent, and salt\-cloud will use the forwarded ssh\-agent to authenticate.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_agent: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS File Map Upload
.sp
New in version 2014.7.0.

.sp
The \fBfile_map\fP option allows an arbitrary group of files to be uploaded to the
target system before running the deploy script. This functionality requires a
provider uses salt.utils.cloud.bootstrap(), which is currently limited to the ec2,
gce, openstack and nova drivers.
.sp
The \fBfile_map\fP can be configured globally in \fB/etc/salt/cloud\fP, or in any cloud
provider or profile file. For example, to upload an extra package or a custom deploy
script, a cloud profile using \fBfile_map\fP might look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ubuntu14:
  provider: ec2\-config
  image: ami\-98aa1cf0
  size: t1.micro
  ssh_username: root
  securitygroup: default
  file_map:
    /local/path/to/custom/script: /remote/path/to/use/custom/script
    /local/path/to/package: /remote/path/to/store/package
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Running Pre\-Flight Commands
.sp
New in version 2018.3.0.

.sp
To execute specified preflight shell commands on a VM before the deploy script is
run, use the \fBpreflight_cmds\fP option. These must be defined as a list in a cloud
configuration file. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-cloud\-profile:
  provider: linode\-config
  image: Ubuntu 16.04 LTS
  size: Linode 2048
  preflight_cmds:
    \- whoami
    \- echo \(aqhello world!\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
These commands will run in sequence \fBbefore\fP the bootstrap script is executed.
.SS Force Minion Config
.sp
New in version 2018.3.0.

.sp
The \fBforce_minion_config\fP option requests the bootstrap process to overwrite
an existing minion configuration file and public/private key files.
Default: False
.sp
This might be important for drivers (such as \fBsaltify\fP) which are expected to
take over a connection from a former salt master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_saltify_provider:
  driver: saltify
  force_minion_config: true
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Troubleshooting Steps
.SS Troubleshooting Salt Cloud
.sp
This page describes various steps for troubleshooting problems that may arise
while using Salt Cloud.
.SS Virtual Machines Are Created, But Do Not Respond
.sp
Are TCP ports 4505 and 4506 open on the master? This is easy to overlook on new
masters. Information on how to open firewall ports on various platforms can be
found \fI\%here\fP\&.
.SS Generic Troubleshooting Steps
.sp
This section describes a set of instructions that are useful to a large number
of situations, and are likely to solve most issues that arise.
.SS Debug Mode
.sp
Frequently, running Salt Cloud in debug mode will reveal information about a
deployment which would otherwise not be obvious:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p myprofile myinstance \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Keep in mind that a number of messages will appear that look at first like
errors, but are in fact intended to give developers factual information to
assist in debugging. A number of messages that appear will be for cloud
providers that you do not have configured; in these cases, the message usually
is intended to confirm that they are not configured.
.SS Salt Bootstrap
.sp
By default, Salt Cloud uses the Salt Bootstrap script to provision instances:
.sp
This script is packaged with Salt Cloud, but may be updated without updating
the Salt package:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-u
.ft P
.fi
.UNINDENT
.UNINDENT
.SS The Bootstrap Log
.sp
If the default deploy script was used, there should be a file in the \fB/tmp/\fP
directory called \fBbootstrap\-salt.log\fP\&. This file contains the full output from
the deployment, including any errors that may have occurred.
.SS Keeping Temp Files
.sp
Salt Cloud uploads minion\-specific files to instances once they are available
via SSH, and then executes a deploy script to put them into the correct place
and install Salt. The \fB\-\-keep\-tmp\fP option will instruct Salt Cloud not to
remove those files when finished with them, so that the user may inspect them
for problems:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p myprofile myinstance \-\-keep\-tmp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default, Salt Cloud will create a directory on the target instance called
\fB/tmp/.saltcloud/\fP\&. This directory should be owned by the user that is to
execute the deploy script, and should have permissions of \fB0700\fP\&.
.sp
Most cloud hosts are configured to use \fBroot\fP as the default initial user
for deployment, and as such, this directory and all files in it should be owned
by the \fBroot\fP user.
.sp
The \fB/tmp/.saltcloud/\fP directory should the following files:
.INDENT 0.0
.IP \(bu 2
A \fBdeploy.sh\fP script. This script should have permissions of \fB0755\fP\&.
.IP \(bu 2
A \fB\&.pem\fP and \fB\&.pub\fP key named after the minion. The \fB\&.pem\fP file should
have permissions of \fB0600\fP\&. Ensure that the \fB\&.pem\fP and \fB\&.pub\fP files have
been properly copied to the \fB/etc/salt/pki/minion/\fP directory.
.IP \(bu 2
A file called \fBminion\fP\&. This file should have been copied to the
\fB/etc/salt/\fP directory.
.IP \(bu 2
Optionally, a file called \fBgrains\fP\&. This file, if present, should have been
copied to the \fB/etc/salt/\fP directory.
.UNINDENT
.SS Unprivileged Primary Users
.sp
Some cloud hosts, most notably EC2, are configured with a different primary user.
Some common examples are \fBec2\-user\fP, \fBubuntu\fP, \fBfedora\fP, and \fBbitnami\fP\&.
In these cases, the \fB/tmp/.saltcloud/\fP directory and all files in it should
be owned by this user.
.sp
Some cloud hosts, such as EC2, are configured to not require these users to
provide a password when using the \fBsudo\fP command. Because it is more secure
to require \fBsudo\fP users to provide a password, other hosts are configured
that way.
.sp
If this instance is required to provide a password, it needs to be configured
in Salt Cloud. A password for sudo to use may be added to either the provider
configuration or the profile configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo_password: mypassword
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fB/tmp/\fP is Mounted as \fBnoexec\fP
.sp
It is more secure to mount the \fB/tmp/\fP directory with a \fBnoexec\fP option.
This is uncommon on most cloud hosts, but very common in private
environments. To see if the \fB/tmp/\fP directory is mounted this way, run the
following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mount | grep tmp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The if the output of this command includes a line that looks like this, then
the \fB/tmp/\fP directory is mounted as \fBnoexec\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tmpfs on /tmp type tmpfs (rw,noexec)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If this is the case, then the \fBdeploy_command\fP will need to be changed
in order to run the deploy script through the \fBsh\fP command, rather than trying
to execute it directly. This may be specified in either the provider or the
profile config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
deploy_command: sh /tmp/.saltcloud/deploy.sh
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Please note that by default, Salt Cloud will place its files in a directory
called \fB/tmp/.saltcloud/\fP\&. This may be also be changed in the provider or
profile configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tmp_dir: /tmp/.saltcloud/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If this directory is changed, then the \fBdeploy_command\fP need to be changed
in order to reflect the \fBtmp_dir\fP configuration.
.SS Executing the Deploy Script Manually
.sp
If all of the files needed for deployment were successfully uploaded to the
correct locations, and contain the correct permissions and ownerships, the
deploy script may be executed manually in order to check for other issues:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cd /tmp/.saltcloud/
\&./deploy.sh
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Extending Salt Cloud
.SS Writing Cloud Driver Modules
.sp
Salt Cloud runs on a module system similar to the main Salt project. The
modules inside saltcloud exist in the \fBsalt/cloud/clouds\fP directory of the
salt source.
.sp
There are two basic types of cloud modules. If a cloud host is supported by
libcloud, then using it is the fastest route to getting a module written. The
Apache Libcloud project is located at:
.sp
\fI\%http://libcloud.apache.org/\fP
.sp
Not every cloud host is supported by libcloud. Additionally, not every
feature in a supported cloud host is necessarily supported by libcloud. In
either of these cases, a module can be created which does not rely on libcloud.
.SS All Driver Modules
.sp
The following functions are required by all driver modules, whether or not they are
based on libcloud.
.SS The __virtual__() Function
.sp
This function determines whether or not to make this cloud module available
upon execution. Most often, it uses \fBget_configured_provider()\fP to determine
if the necessary configuration has been set up. It may also check for necessary
imports, to decide whether to load the module. In most cases, it will return a
\fBTrue\fP or \fBFalse\fP value. If the name of the driver used does not match the
filename, then that name should be returned instead of \fBTrue\fP\&.
.SS The get_configured_provider() Function
.sp
This function uses \fBconfig.is_provider_configured()\fP to determine whether
all required information for this driver has been configured. The last value
in the list of required settings should be followed by a comma.
.SS Libcloud Based Modules
.sp
Writing a cloud module based on libcloud has two major advantages. First of all,
much of the work has already been done by the libcloud project. Second, most of
the functions necessary to Salt have already been added to the Salt Cloud
project.
.SS The create() Function
.sp
The most important function that does need to be manually written is the
\fBcreate()\fP function. This is what is used to request a virtual machine to be
created by the cloud host, wait for it to become available, and then
(optionally) log in and install Salt on it.
.sp
A good example to follow for writing a cloud driver module based on libcloud
is the module provided for Linode:
.sp
\fI\%https://github.com/saltstack/salt/tree/master/salt/cloud/clouds/linode.py\fP
.sp
The basic flow of a \fBcreate()\fP function is as follows:
.INDENT 0.0
.IP \(bu 2
Send a request to the cloud host to create a virtual machine.
.IP \(bu 2
Wait for the virtual machine to become available.
.IP \(bu 2
Generate kwargs to be used to deploy Salt.
.IP \(bu 2
Log into the virtual machine and deploy Salt.
.IP \(bu 2
Return a data structure that describes the newly\-created virtual machine.
.UNINDENT
.sp
At various points throughout this function, events may be fired on the Salt
event bus. Four of these events, which are described below, are required. Other
events may be added by the user, where appropriate.
.sp
When the \fBcreate()\fP function is called, it is passed a data structure called
\fBvm_\fP\&. This dict contains a composite of information describing the virtual
machine to be created. A dict called \fB__opts__\fP is also provided by Salt,
which contains the options used to run Salt Cloud, as well as a set of
configuration and environment variables.
.sp
The first thing the \fBcreate()\fP function must do is fire an event stating that
it has started the create process. This event is tagged
\fBsalt/cloud/<vm name>/creating\fP\&. The payload contains the names of the VM,
profile, and provider.
.sp
A set of kwargs is then usually created, to describe the parameters required
by the cloud host to request the virtual machine.
.sp
An event is then fired to state that a virtual machine is about to be requested.
It is tagged as \fBsalt/cloud/<vm name>/requesting\fP\&. The payload contains most
or all of the parameters that will be sent to the cloud host. Any private
information (such as passwords) should not be sent in the event.
.sp
After a request is made, a set of deploy kwargs will be generated. These will
be used to install Salt on the target machine. Windows options are supported
at this point, and should be generated, even if the cloud host does not
currently support Windows. This will save time in the future if the host
does eventually decide to support Windows.
.sp
An event is then fired to state that the deploy process is about to begin. This
event is tagged \fBsalt/cloud/<vm name>/deploying\fP\&. The payload for the event
will contain a set of deploy kwargs, useful for debugging purposed. Any private
data, including passwords and keys (including public keys) should be stripped
from the deploy kwargs before the event is fired.
.sp
If any Windows options have been passed in, the
\fBsalt.utils.cloud.deploy_windows()\fP function will be called. Otherwise, it
will be assumed that the target is a Linux or Unix machine, and the
\fBsalt.utils.cloud.deploy_script()\fP will be called.
.sp
Both of these functions will wait for the target machine to become available,
then the necessary port to log in, then a successful login that can be used to
install Salt. Minion configuration and keys will then be uploaded to a temporary
directory on the target by the appropriate function. On a Windows target, the
Windows Minion Installer will be run in silent mode. On a Linux/Unix target, a
deploy script (\fBbootstrap\-salt.sh\fP, by default) will be run, which will
auto\-detect the operating system, and install Salt using its native package
manager. These do not need to be handled by the developer in the cloud module.
.sp
The \fBsalt.utils.cloud.validate_windows_cred()\fP function has been extended to
take the number of retries and retry_delay parameters in case a specific cloud
host has a delay between providing the Windows credentials and the
credentials being available for use.  In their \fBcreate()\fP function, or as
a sub\-function called during the creation process, developers should use the
\fBwin_deploy_auth_retries\fP and \fBwin_deploy_auth_retry_delay\fP parameters from
the provider configuration to allow the end\-user the ability to customize the
number of tries and delay between tries for their particular host.
.sp
After the appropriate deploy function completes, a final event is fired
which describes the virtual machine that has just been created. This event is
tagged \fBsalt/cloud/<vm name>/created\fP\&. The payload contains the names of the
VM, profile, and provider.
.sp
Finally, a dict (queried from the provider) which describes the new virtual
machine is returned to the user. Because this data is not fired on the event
bus it can, and should, return any passwords that were returned by the cloud
host. In some cases (for example, Rackspace), this is the only time that
the password can be queried by the user; post\-creation queries may not contain
password information (depending upon the host).
.SS The libcloudfuncs Functions
.sp
A number of other functions are required for all cloud hosts. However, with
libcloud\-based modules, these are all provided for free by the libcloudfuncs
library. The following two lines set up the imports:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from salt.cloud.libcloudfuncs import *  # pylint: disable=W0614,W0401
import salt.utils.functools
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And then a series of declarations will make the necessary functions available
within the cloud module.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
get_size = salt.utils.functools.namespaced_function(get_size, globals())
get_image = salt.utils.functools.namespaced_function(get_image, globals())
avail_locations = salt.utils.functools.namespaced_function(avail_locations, globals())
avail_images = salt.utils.functools.namespaced_function(avail_images, globals())
avail_sizes = salt.utils.functools.namespaced_function(avail_sizes, globals())
script = salt.utils.functools.namespaced_function(script, globals())
destroy = salt.utils.functools.namespaced_function(destroy, globals())
list_nodes = salt.utils.functools.namespaced_function(list_nodes, globals())
list_nodes_full = salt.utils.functools.namespaced_function(list_nodes_full, globals())
list_nodes_select = salt.utils.functools.namespaced_function(
    list_nodes_select, globals()
)
show_instance = salt.utils.functools.namespaced_function(show_instance, globals())
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If necessary, these functions may be replaced by removing the appropriate
declaration line, and then adding the function as normal.
.sp
These functions are required for all cloud modules, and are described in detail
in the next section.
.SS Non\-Libcloud Based Modules
.sp
In some cases, using libcloud is not an option. This may be because libcloud has
not yet included the necessary driver itself, or it may be that the driver that
is included with libcloud does not contain all of the necessary features
required by the developer. When this is the case, some or all of the functions
in \fBlibcloudfuncs\fP may be replaced. If they are all replaced, the libcloud
imports should be absent from the Salt Cloud module.
.sp
A good example of a non\-libcloud driver is the DigitalOcean driver:
.sp
\fI\%https://github.com/saltstack/salt/tree/master/salt/cloud/clouds/digitalocean.py\fP
.SS The \fBcreate()\fP Function
.sp
The \fBcreate()\fP function must be created as described in the libcloud\-based
module documentation.
.SS The get_size() Function
.sp
This function is only necessary for libcloud\-based modules, and does not need
to exist otherwise.
.SS The get_image() Function
.sp
This function is only necessary for libcloud\-based modules, and does not need
to exist otherwise.
.SS The avail_locations() Function
.sp
This function returns a list of locations available, if the cloud host uses
multiple data centers. It is not necessary if the cloud host uses only one
data center. It is normally called using the \fB\-\-list\-locations\fP option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations my\-cloud\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.SS The avail_images() Function
.sp
This function returns a list of images available for this cloud provider. There
are not currently any known cloud providers that do not provide this
functionality, though they may refer to images by a different name (for example,
\(dqtemplates\(dq). It is normally called using the \fB\-\-list\-images\fP option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images my\-cloud\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.SS The avail_sizes() Function
.sp
This function returns a list of sizes available for this cloud provider.
Generally, this refers to a combination of RAM, CPU, and/or disk space. This
functionality may not be present on some cloud providers. For example, the
Parallels module breaks down RAM, CPU, and disk space into separate options,
whereas in other providers, these options are baked into the image. It is
normally called using the \fB\-\-list\-sizes\fP option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-sizes my\-cloud\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.SS The script() Function
.sp
This function builds the deploy script to be used on the remote machine.  It is
likely to be moved into the \fBsalt.utils.cloud\fP library in the near future, as
it is very generic and can usually be copied wholesale from another module.
.SS The destroy() Function
.sp
This function irreversibly destroys a virtual machine on the cloud provider.
Before doing so, it should fire an event on the Salt event bus. The tag for this
event is \fBsalt/cloud/<vm name>/destroying\fP\&. Once the virtual machine has been
destroyed, another event is fired. The tag for that event is
\fBsalt/cloud/<vm name>/destroyed\fP\&.
.sp
This function is normally called with the \fB\-d\fP options:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-d myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.SS The list_nodes() Function
.sp
This function returns a list of nodes available on this cloud provider, using
the following fields:
.INDENT 0.0
.IP \(bu 2
id (str)
.IP \(bu 2
image (str)
.IP \(bu 2
size (str)
.IP \(bu 2
state (str)
.IP \(bu 2
private_ips (list)
.IP \(bu 2
public_ips (list)
.UNINDENT
.sp
No other fields should be returned in this function, and all of these fields
should be returned, even if empty. The private_ips and public_ips fields should
always be of a list type, even if empty, and the other fields should always be
of a str type. This function is normally called with the \fB\-Q\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-Q
.ft P
.fi
.UNINDENT
.UNINDENT
.SS The list_nodes_full() Function
.sp
All information available about all nodes should be returned in this function.
The fields in the list_nodes() function should also be returned, even if they
would not normally be provided by the cloud provider. This is because some
functions both within Salt and 3rd party will break if an expected field is not
present. This function is normally called with the \fB\-F\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-F
.ft P
.fi
.UNINDENT
.UNINDENT
.SS The list_nodes_select() Function
.sp
This function returns only the fields specified in the \fBquery.selection\fP
option in \fB/etc/salt/cloud\fP\&. Because this function is so generic, all of the
heavy lifting has been moved into the \fBsalt.utils.cloud\fP library.
.sp
A function to call \fBlist_nodes_select()\fP still needs to be present. In
general, the following code can be used as\-is:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def list_nodes_select(call=None):
    \(dq\(dq\(dq
    Return a list of the VMs that are on the provider, with select fields
    \(dq\(dq\(dq
    return salt.utils.cloud.list_nodes_select(
        list_nodes_full(\(dqfunction\(dq), __opts__[\(dqquery.selection\(dq], call
    )
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, depending on the cloud provider, additional variables may be required.
For instance, some modules use a \fBconn\fP object, or may need to pass other
options into \fBlist_nodes_full()\fP\&. In this case, be sure to update the function
appropriately:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def list_nodes_select(conn=None, call=None):
    \(dq\(dq\(dq
    Return a list of the VMs that are on the provider, with select fields
    \(dq\(dq\(dq
    if not conn:
        conn = get_conn()  # pylint: disable=E0602

    return salt.utils.cloud.list_nodes_select(
        list_nodes_full(conn, \(dqfunction\(dq), __opts__[\(dqquery.selection\(dq], call
    )
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This function is normally called with the \fB\-S\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-S
.ft P
.fi
.UNINDENT
.UNINDENT
.SS The show_instance() Function
.sp
This function is used to display all of the information about a single node
that is available from the cloud provider. The simplest way to provide this is
usually to call \fBlist_nodes_full()\fP, and return just the data for the
requested node. It is normally called as an action:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_instance myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Actions and Functions
.sp
Extra functionality may be added to a cloud provider in the form of an
\fB\-\-action\fP or a \fB\-\-function\fP\&. Actions are performed against a cloud
instance/virtual machine, and functions are performed against a cloud provider.
.SS Actions
.sp
Actions are calls that are performed against a specific instance or virtual
machine. The \fBshow_instance\fP action should be available in all cloud modules.
Actions are normally called with the \fB\-a\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_instance myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Actions must accept a \fBname\fP as a first argument, may optionally support any
number of kwargs as appropriate, and must accept an argument of \fBcall\fP, with
a default of \fBNone\fP\&.
.sp
Before performing any other work, an action should normally verify that it has
been called correctly. It may then perform the desired feature, and return
useful information to the user. A basic action looks like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def show_instance(name, call=None):
    \(dq\(dq\(dq
    Show the details from EC2 concerning an AMI
    \(dq\(dq\(dq
    if call != \(dqaction\(dq:
        raise SaltCloudSystemExit(
            \(dqThe show_instance action must be called with \-a or \-\-action.\(dq
        )

    return _get_node(name)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Please note that generic kwargs, if used, are passed through to actions as
\fBkwargs\fP and not \fB**kwargs\fP\&. An example of this is seen in the Functions
section.
.SS Functions
.sp
Functions are called that are performed against a specific cloud provider. An
optional function that is often useful is \fBshow_image\fP, which describes an
image in detail. Functions are normally called with the \fB\-f\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_image my\-cloud\-provider image=\(aqUbuntu 13.10 64\-bit\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A function may accept any number of kwargs as appropriate, and must accept an
argument of \fBcall\fP with a default of \fBNone\fP\&.
.sp
Before performing any other work, a function should normally verify that it has
been called correctly. It may then perform the desired feature, and return
useful information to the user. A basic function looks like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def show_image(kwargs, call=None):
    \(dq\(dq\(dq
    Show the details from EC2 concerning an AMI
    \(dq\(dq\(dq
    if call != \(dqfunction\(dq:
        raise SaltCloudSystemExit(
            \(dqThe show_image action must be called with \-f or \-\-function.\(dq
        )

    params = {\(dqImageId.1\(dq: kwargs[\(dqimage\(dq], \(dqAction\(dq: \(dqDescribeImages\(dq}
    result = query(params)
    log.info(result)

    return result
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Take note that generic kwargs are passed through to functions as \fBkwargs\fP and
not \fB**kwargs\fP\&.
.SS Cloud deployment scripts
.sp
Salt Cloud works primarily by executing a script on the virtual machines as
soon as they become available. The script that is executed is referenced in the
cloud profile as the \fBscript\fP\&. In older versions, this was the \fBos\fP
argument. This was changed in 0.8.2.
.sp
A number of legacy scripts exist in the deploy directory in the saltcloud
source tree. The preferred method is currently to use the salt\-bootstrap
script. A stable version is included with each release tarball starting with
0.8.4. The most updated version can be found at:
.sp
\fI\%https://github.com/saltstack/salt\-bootstrap\fP
.sp
Note that, somewhat counter\-intuitively, this script is referenced as
\fBbootstrap\-salt\fP in the configuration.
.sp
You can specify a deploy script in the cloud configuration file
(\fB/etc/salt/cloud\fP by default):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
script: bootstrap\-salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or in a provider:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-provider:
  # snip...
  script: bootstrap\-salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or in a profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-profile:
  provider: my\-provider
  # snip...
  script: bootstrap\-salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you do not specify a script argument in your cloud configuration file,
provider configuration or profile configuration, the \(dqbootstrap\-salt\(dq script
will be used by default.
.SS Other Generic Deploy Scripts
.sp
If you want to be assured of always using the latest Salt Bootstrap script,
there are a few generic templates available in the deploy directory of your
saltcloud source tree:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
curl\-bootstrap
curl\-bootstrap\-git
python\-bootstrap
wget\-bootstrap
wget\-bootstrap\-git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
These are example scripts which were designed to be customized, adapted, and
refit to meet your needs. One important use of them is to pass options to
the salt\-bootstrap script, such as updating to specific git tags.
.SS Custom Deploy Scripts
.sp
If the Salt Bootstrap script does not meet your needs, you may write your own.
The script should be written in shell and is a Jinja template. Deploy scripts
need to execute a number of functions to do a complete salt setup. These
functions include:
.INDENT 0.0
.IP 1. 3
Install the salt minion. If this can be done via system packages this method
is HIGHLY preferred.
.IP 2. 3
Add the salt minion keys before the minion is started for the first time.
The minion keys are available as strings that can be copied into place in
the Jinja template under the dict named \(dqvm\(dq.
.IP 3. 3
Start the salt\-minion daemon and enable it at startup time.
.IP 4. 3
Set up the minion configuration file from the \(dqminion\(dq data available in
the Jinja template.
.UNINDENT
.sp
A good, well commented example of this process is the Fedora deployment
script:
.sp
\fI\%https://github.com/saltstack/salt/blob/master/salt/cloud/deploy/Fedora.sh\fP
.sp
A number of legacy deploy scripts are included with the release tarball. None
of them are as functional or complete as Salt Bootstrap, and are still included
for academic purposes.
.sp
Custom deploy scripts are picked up from \fB/etc/salt/cloud.deploy.d\fP by
default, but you can change the location of deploy scripts with the cloud
configuration \fBdeploy_scripts_search_path\fP\&. Additionally, if your deploy
script has the extension \fB\&.sh\fP, you can leave out the extension in your
configuration.
.sp
For example, if your custom deploy script is located in
\fB/etc/salt/cloud.deploy.d/my_deploy.sh\fP, you could specify it in a cloud
profile like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-profile:
  provider: my\-provider
  # snip...
  script: my_deploy
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You\(aqre also free to use the full path to the script if you like. Using full
paths, your script doesn\(aqt have to live inside \fB/etc/salt/cloud.deploy.d\fP or
whatever you\(aqve configured with \fBdeploy_scripts_search_path\fP\&.
.SS Post\-Deploy Commands
.sp
Once a minion has been deployed, it has the option to run a salt command.
Normally, this would be the \fI\%state.apply\fP,
which would finish provisioning the VM. Another common option (for testing) is
to use \fI\%test.version\fP\&. This is configured in the
main cloud config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
start_action: state.apply
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is currently considered to be experimental functionality, and may not work
well with all cloud hosts. If you experience problems with Salt Cloud hanging
after Salt is deployed, consider using \fI\%Startup States\fP instead.
.SS Skipping the Deploy Script
.sp
For whatever reason, you may want to skip the deploy script altogether. This
results in a VM being spun up much faster, with absolutely no configuration.
This can be set from the command line:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-no\-deploy \-p micro_aws my_instance
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or it can be set from the main cloud config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
deploy: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or it can be set from the provider\(aqs configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
RACKSPACE.user: example_user
RACKSPACE.apikey: 123984bjjas87034
RACKSPACE.deploy: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or even on the VM\(aqs profile settings:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ubuntu_aws:
  provider: my\-ec2\-config
  image: ami\-7e2da54e
  size: t1.micro
  deploy: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The default for deploy is True.
.sp
In the profile, you may also set the script option to \fBNone\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
script: None
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is the slowest option, since it still uploads the None deploy script and
executes it.
.SS Updating Salt Bootstrap
.sp
Salt Bootstrap can be updated automatically with \fBsalt\-cloud\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-u
salt\-cloud \-\-update\-bootstrap
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Bear in mind that this updates to the latest \fBstable\fP version from:
.sp
\fI\%https://bootstrap.saltproject.io/stable/bootstrap\-salt.sh\fP
.sp
To update Salt Bootstrap script to the \fBdevelop\fP version, run the following
command on the Salt minion host with \fBsalt\-cloud\fP installed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call config.gather_bootstrap_script \(aqhttps://bootstrap.saltproject.io/develop/bootstrap\-salt.sh\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or just download the file manually:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-L \(aqhttps://bootstrap.saltproject.io/develop\(aq > /etc/salt/cloud.deploy.d/bootstrap\-salt.sh
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Keeping /tmp/ Files
.sp
When Salt Cloud deploys an instance, it uploads temporary files to /tmp/ for
salt\-bootstrap to put in place. After the script has run, they are deleted. To
keep these files around (mostly for debugging purposes), the \-\-keep\-tmp option
can be added:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p myprofile mymachine \-\-keep\-tmp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For those wondering why /tmp/ was used instead of /root/, this had to be done
for images which require the use of sudo, and therefore do not allow remote
root logins, even for file transfers (which makes /root/ unavailable).
.SS Deploy Script Arguments
.sp
Custom deploy scripts are unlikely to need custom arguments to be passed to
them, but salt\-bootstrap has been extended quite a bit, and this may be
necessary. script_args can be specified in either the profile or the map file,
to pass arguments to the deploy script:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
aws\-amazon:
  provider: my\-ec2\-config
  image: ami\-1624987f
  size: t1.micro
  ssh_username: ec2\-user
  script: bootstrap\-salt
  script_args: \-c /tmp/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This has also been tested to work with pipes, if needed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
script_args: \(aq| head\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Using Salt Cloud from Salt
.SS Using the Salt Modules for Cloud
.sp
In addition to the \fBsalt\-cloud\fP command, Salt Cloud can be called from Salt,
in a variety of different ways. Most users will be interested in either the
execution module or the state module, but it is also possible to call Salt Cloud
as a runner.
.sp
Because the actual work will be performed on a remote minion, the normal Salt
Cloud configuration must exist on any target minion that needs to execute a Salt
Cloud command.  Because Salt Cloud now supports breaking out configuration into
individual files, the configuration is easily managed using Salt\(aqs own
\fBfile.managed\fP state function. For example, the following directories allow
this configuration to be managed easily:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/salt/cloud.providers.d/
/etc/salt/cloud.profiles.d/
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Minion Keys
.sp
Keep in mind that when creating minions, Salt Cloud will create public and
private minion keys, upload them to the minion, and place the public key on the
machine that created the minion. It will \fInot\fP attempt to place any public
minion keys on the master, unless the minion which was used to create the
instance is also the Salt Master. This is because granting arbitrary minions
access to modify keys on the master is a serious security risk, and must be
avoided.
.SS Execution Module
.sp
The \fBcloud\fP module is available to use from the command line. At the moment,
almost every standard Salt Cloud feature is available to use. The following
commands are available:
.SS list_images
.sp
This command is designed to show images that are available to be used to create
an instance using Salt Cloud. In general they are used in the creation of
profiles, but may also be used to create an instance directly (see below).
Listing images requires a provider to be configured, and specified:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cloud.list_images my\-cloud\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.SS list_sizes
.sp
This command is designed to show sizes that are available to be used to create
an instance using Salt Cloud. In general they are used in the creation of
profiles, but may also be used to create an instance directly (see below). This
command is not available for all cloud providers; see the provider\-specific
documentation for details. Listing sizes requires a provider to be configured,
and specified:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cloud.list_sizes my\-cloud\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.SS list_locations
.sp
This command is designed to show locations that are available to be used to
create an instance using Salt Cloud. In general they are used in the creation of
profiles, but may also be used to create an instance directly (see below). This
command is not available for all cloud providers; see the provider\-specific
documentation for details. Listing locations requires a provider to be
configured, and specified:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cloud.list_locations my\-cloud\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.SS query
.sp
This command is used to query all configured cloud providers, and display all
instances associated with those accounts. By default, it will run a standard
query, returning the following fields:
.INDENT 0.0
.TP
.B \fBid\fP
The name or ID of the instance, as used by the cloud provider.
.TP
.B \fBimage\fP
The disk image that was used to create this instance.
.TP
.B \fBprivate_ips\fP
Any public IP addresses currently assigned to this instance.
.TP
.B \fBpublic_ips\fP
Any private IP addresses currently assigned to this instance.
.TP
.B \fBsize\fP
The size of the instance; can refer to RAM, CPU(s), disk space, etc.,
depending on the cloud provider.
.TP
.B \fBstate\fP
The running state of the instance; for example, \fBrunning\fP, \fBstopped\fP,
\fBpending\fP, etc. This state is dependent upon the provider.
.UNINDENT
.sp
This command may also be used to perform a full query or a select query, as
described below. The following usages are available:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cloud.query
salt myminion cloud.query list_nodes
salt myminion cloud.query list_nodes_full
.ft P
.fi
.UNINDENT
.UNINDENT
.SS full_query
.sp
This command behaves like the \fBquery\fP command, but lists all information
concerning each instance as provided by the cloud provider, in addition to the
fields returned by the \fBquery\fP command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cloud.full_query
.ft P
.fi
.UNINDENT
.UNINDENT
.SS select_query
.sp
This command behaves like the \fBquery\fP command, but only returned select
fields as defined in the \fB/etc/salt/cloud\fP configuration file. A sample
configuration for this section of the file might look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
query.selection:
  \- id
  \- key_name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This configuration would only return the \fBid\fP and \fBkey_name\fP fields, for
those cloud providers that support those two fields. This would be called using
the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cloud.select_query
.ft P
.fi
.UNINDENT
.UNINDENT
.SS profile
.sp
This command is used to create an instance using a profile that is configured
on the target minion. Please note that the profile must be configured before
this command can be used with it.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cloud.profile ec2\-centos64\-x64 my\-new\-instance
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Please note that the execution module does \fInot\fP run in parallel mode. Using
multiple minions to create instances can effectively perform parallel instance
creation.
.SS create
.sp
This command is similar to the \fBprofile\fP command, in that it is used to create
a new instance. However, it does not require a profile to be pre\-configured.
Instead, all of the options that are normally configured in a profile are passed
directly to Salt Cloud to create the instance:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cloud.create my\-ec2\-config my\-new\-instance \e
    image=ami\-1624987f size=\(aqt1.micro\(aq ssh_username=ec2\-user \e
    securitygroup=default delvol_on_destroy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Please note that the execution module does \fInot\fP run in parallel mode. Using
multiple minions to create instances can effectively perform parallel instance
creation.
.SS destroy
.sp
This command is used to destroy an instance or instances. This command will
search all configured providers and remove any instance(s) which matches the
name(s) passed in here. The results of this command are \fInon\-reversable\fP and
should be used with caution.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cloud.destroy myinstance
salt myminion cloud.destroy myinstance1,myinstance2
.ft P
.fi
.UNINDENT
.UNINDENT
.SS action
.sp
This command implements both the \fBaction\fP and the \fBfunction\fP commands
used in the standard \fBsalt\-cloud\fP command. If one of the standard \fBaction\fP
commands is used, an instance name must be provided. If one of the standard
\fBfunction\fP commands is used, a provider configuration must be named.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cloud.action start instance=myinstance
salt myminion cloud.action show_image provider=my\-ec2\-config \e
    image=ami\-1624987f
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The actions available are largely dependent upon the module for the specific
cloud provider. The following actions are available for all cloud providers:
.INDENT 0.0
.TP
.B \fBlist_nodes\fP
This is a direct call to the \fBquery\fP function as described above, but is
only performed against a single cloud provider. A provider configuration
must be included.
.TP
.B \fBlist_nodes_select\fP
This is a direct call to the \fBfull_query\fP function as described above, but
is only performed against a single cloud provider. A provider configuration
must be included.
.TP
.B \fBlist_nodes_select\fP
This is a direct call to the \fBselect_query\fP function as described above,
but is only performed against a single cloud provider.  A provider
configuration must be included.
.TP
.B \fBshow_instance\fP
This is a thin wrapper around \fBlist_nodes\fP, which returns the full
information about a single instance. An instance name must be provided.
.UNINDENT
.SS State Module
.sp
A subset of the execution module is available through the \fBcloud\fP state
module. Not all functions are currently included, because there is currently
insufficient code for them to perform statefully. For example, a command to
create an instance may be issued with a series of options, but those options
cannot currently be statefully managed. Additional states to manage these
options will be released at a later time.
.SS cloud.present
.sp
This state will ensure that an instance is present inside a particular cloud
provider. Any option that is normally specified in the \fBcloud.create\fP
execution module and function may be declared here, but only the actual
presence of the instance will be managed statefully.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-instance\-name:
  cloud.present:
    \- cloud_provider: my\-ec2\-config
    \- image: ami\-1624987f
    \- size: \(aqt1.micro\(aq
    \- ssh_username: ec2\-user
    \- securitygroup: default
    \- delvol_on_destroy: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS cloud.profile
.sp
This state will ensure that an instance is present inside a particular cloud
provider. This function calls the \fBcloud.profile\fP execution module and
function, but as with \fBcloud.present\fP, only the actual presence of the
instance will be managed statefully.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-instance\-name:
  cloud.profile:
    \- profile: ec2\-centos64\-x64
.ft P
.fi
.UNINDENT
.UNINDENT
.SS cloud.absent
.sp
This state will ensure that an instance (identified by name) does not exist in
any of the cloud providers configured on the target minion. Please note that
this state is \fInon\-reversable\fP and may be considered especially destructive when
issued as a cloud state.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-instance\-name:
  cloud.absent
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Runner Module
.sp
The \fBcloud\fP runner module is executed on the master, and performs actions
using the configuration and Salt modules on the master itself. This means that
any public minion keys will also be properly accepted by the master.
.sp
Using the functions in the runner module is no different than using those in
the execution module, outside of the behavior described in the above paragraph.
The following functions are available inside the runner:
.INDENT 0.0
.IP \(bu 2
list_images
.IP \(bu 2
list_sizes
.IP \(bu 2
list_locations
.IP \(bu 2
query
.IP \(bu 2
full_query
.IP \(bu 2
select_query
.IP \(bu 2
profile
.IP \(bu 2
destroy
.IP \(bu 2
action
.UNINDENT
.sp
Outside of the standard usage of \fBsalt\-run\fP itself, commands are executed as
usual:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cloud.profile ec2\-centos64\-x86_64 my\-instance\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.SS CloudClient
.sp
The execution, state, and runner modules ultimately all use the CloudClient
library that ships with Salt. To use the CloudClient library locally (either on
the master or a minion), create a client object and issue a command against it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.cloud
import pprint

client = salt.cloud.CloudClient(\(dq/etc/salt/cloud\(dq)
nodes = client.query()
pprint.pprint(nodes)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Reactor
.sp
Examples of using the reactor with Salt Cloud are available in the
\fI\%ec2\-autoscale\-reactor\fP and
\fI\%salt\-cloud\-reactor\fP formulas.
.SS Feature Comparison
.SS Feature Matrix
.sp
A number of features are available in most cloud hosts, but not all are
available everywhere. This may be because the feature isn\(aqt supported by the
cloud host itself, or it may only be that the feature has not yet been
added to Salt Cloud. In a handful of cases, it is because the feature does not
make sense for a particular cloud provider (Saltify, for instance).
.sp
This matrix shows which features are available in which cloud hosts, as far
as Salt Cloud is concerned. This is not a comprehensive list of all features
available in all cloud hosts, and should not be used to make business
decisions concerning choosing a cloud host. In most cases, adding support
for a feature to Salt Cloud requires only a little effort.
.SS Legacy Drivers
.sp
Both AWS and Rackspace are listed as \(dqLegacy\(dq. This is because those drivers
have been replaced by other drivers, which are generally the preferred method
for working with those hosts.
.sp
The EC2 driver should be used instead of the AWS driver, when possible. The
OpenStack driver should be used instead of the Rackspace driver, unless the user
is dealing with instances in \(dqthe old cloud\(dq in Rackspace.
.SS Note for Developers
.sp
When adding new features to a particular cloud host, please make sure to
add the feature to this table. Additionally, if you notice a feature that is not
properly listed here, pull requests to fix them is appreciated.
.SS Standard Features
.sp
These are features that are available for almost every cloud host.
.TS
center;
|l|l|l|l|l|l|l|l|l|l|l|l|l|l|l|l|l|.
_
T{
T}	T{
AWS
(Legacy)
T}	T{
CloudStack
T}	T{
Digital
Ocean
T}	T{
EC2
T}	T{
GoGrid
T}	T{
JoyEnt
T}	T{
Linode
T}	T{
OpenStack
T}	T{
Parallels
T}	T{
Rackspace
(Legacy)
T}	T{
Saltify
T}	T{
Vagrant
T}	T{
Softlayer
T}	T{
Softlayer
Hardware
T}	T{
Aliyun
T}	T{
Tencent
Cloud
T}
_
T{
Query
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
[1]
T}	T{
[1]
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}
_
T{
Full Query
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
[1]
T}	T{
[1]
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}
_
T{
Selective Query
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
[1]
T}	T{
[1]
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}
_
T{
List Sizes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
[2]
T}	T{
[2]
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}
_
T{
List Images
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}
_
T{
List Locations
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
[2]
T}	T{
[2]
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}
_
T{
create
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
[1]
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}
_
T{
destroy
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
[1]
T}	T{
[1]
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}
_
.TE
.sp
[1] Yes, if salt\-api is enabled.
.sp
[2] Always returns \fI{}\fP\&.
.SS Actions
.sp
These are features that are performed on a specific instance, and require an
instance name to be passed in. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-a attach_volume ami.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.TS
center;
|l|l|l|l|l|l|l|l|l|l|l|l|l|l|l|l|.
_
T{
Actions
T}	T{
AWS
(Legacy)
T}	T{
CloudStack
T}	T{
Digital
Ocean
T}	T{
EC2
T}	T{
GoGrid
T}	T{
JoyEnt
T}	T{
Linode
T}	T{
OpenStack
T}	T{
Parallels
T}	T{
Rackspace
(Legacy)
T}	T{
.INDENT 0.0
.TP
.B Saltify&
Vagrant
.UNINDENT
T}	T{
Softlayer
T}	T{
Softlayer
Hardware
T}	T{
Aliyun
T}	T{
Tencent
Cloud
T}
_
T{
attach_volume
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
create_attach_volumes
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
del_tags
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
delvol_on_destroy
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
detach_volume
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
disable_term_protect
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
enable_term_protect
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
get_tags
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
keepvol_on_destroy
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
list_keypairs
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
rename
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
set_tags
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
show_delvol_on_destroy
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
show_instance
T}	T{
T}	T{
T}	T{
Yes
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}
_
T{
show_term_protect
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
start
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
Yes
T}	T{
Yes
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
Yes
T}
_
T{
stop
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
Yes
T}	T{
Yes
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
Yes
T}
_
T{
take_action
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
.TE
.SS Functions
.sp
These are features that are performed against a specific cloud provider, and
require the name of the provider to be passed in. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-cloud \-f list_images my_digitalocean
.ft P
.fi
.UNINDENT
.UNINDENT
.TS
center;
|l|l|l|l|l|l|l|l|l|l|l|l|l|l|l|l|.
_
T{
Functions
T}	T{
AWS
(Legacy)
T}	T{
CloudStack
T}	T{
Digital
Ocean
T}	T{
EC2
T}	T{
GoGrid
T}	T{
JoyEnt
T}	T{
Linode
T}	T{
OpenStack
T}	T{
Parallels
T}	T{
Rackspace
(Legacy)
T}	T{
.INDENT 0.0
.TP
.B Saltify&
Vagrant
.UNINDENT
T}	T{
Softlayer
T}	T{
Softlayer
Hardware
T}	T{
Aliyun
T}	T{
Tencent
Cloud
T}
_
T{
block_device_mappings
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
create_keypair
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
create_volume
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
delete_key
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
delete_keypair
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
delete_volume
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
get_image
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}
_
T{
get_ip
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
get_key
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
get_keyid
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
get_keypair
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
get_networkid
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
get_node
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
get_password
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
get_size
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}
_
T{
get_spot_config
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
get_subnetid
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
iam_profile
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}
_
T{
import_key
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
key_list
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
keyname
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
list_availability_zones
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
Yes
T}
_
T{
list_custom_images
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}
_
T{
list_keys
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
list_nodes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}
_
T{
list_nodes_full
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}
_
T{
list_nodes_select
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}	T{
Yes
T}
_
T{
list_vlans
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
Yes
T}	T{
T}	T{
T}
_
T{
rackconnect
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
reboot
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
[1]
T}	T{
T}	T{
T}	T{
Yes
T}	T{
Yes
T}
_
T{
reformat_node
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
securitygroup
T}	T{
Yes
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
securitygroupid
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}
_
T{
show_image
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
Yes
T}
_
T{
show_key
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
show_keypair
T}	T{
T}	T{
T}	T{
Yes
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
T{
show_volume
T}	T{
T}	T{
T}	T{
T}	T{
Yes
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}	T{
T}
_
.TE
.sp
[1] Yes, if salt\-api is enabled.
.SS Tutorials
.SS Salt Cloud Quickstart
.sp
Salt Cloud is built\-in to Salt, and the easiest way to run Salt Cloud is
directly from your Salt Master.
.sp
Note that if you installed Salt via \fI\%Salt Bootstrap\fP, it may not have
automatically installed salt\-cloud for you. Use your distribution\(aqs package
manager to install the \fBsalt\-cloud\fP package from the same repo that you
used to install Salt.  These repos will automatically be setup by Salt Bootstrap.
.sp
Alternatively, the \fB\-L\fP option can be passed to the \fI\%Salt Bootstrap\fP script when
installing Salt. The \fB\-L\fP option will install \fBsalt\-cloud\fP and the required
\fBlibcloud\fP package.
.sp
This quickstart walks you through the basic steps of setting up a cloud host
and defining some virtual machines to create.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Salt Cloud has its own process and does not rely on the Salt Master,
so it can be installed on a standalone minion instead of your Salt Master.
.UNINDENT
.UNINDENT
.SS Define a Provider
.sp
The first step is to add the credentials for your cloud host. Credentials and
other settings provided by the cloud host are stored in provider configuration
files. Provider configurations contain the details needed to connect to a cloud
host such as EC2, GCE, Rackspace, etc., and any global options that you want
set on your cloud minions (such as the location of your Salt Master).
.sp
On your Salt Master, browse to \fB/etc/salt/cloud.providers.d/\fP and create
a file called \fB<provider>.conf\fP, replacing \fB<provider>\fP with
\fBec2\fP, \fBsoftlayer\fP, and so on. The name helps you identify the contents,
and is not important as long as the file ends in \fB\&.conf\fP\&.
.sp
Next, browse to the \fI\%Provider specifics\fP and
add any required settings for your cloud host to this file. Here is an example
for Amazon EC2:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2:
  driver: ec2
  # Set the EC2 access credentials (see below)
  #
  id: \(aqHJGRYCILJLKJYG\(aq
  key: \(aqkdjgfsgm;woormgl/aserigjksjdhasdfgn\(aq
  # Make sure this key is owned by root with permissions 0400.
  #
  private_key: /etc/salt/my_test_key.pem
  keyname: my_test_key
  securitygroup: default
  # Optional: Set up the location of the Salt Master
  #
  minion:
    master: saltmaster.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The required configuration varies between cloud hosts so make sure you read the
provider specifics.
.SS List Cloud Provider Options
.sp
You can now query the cloud provider you configured for available locations,
images, and sizes. This information is used when you set up VM profiles.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations <provider_name>  # my\-ec2 in the previous example
salt\-cloud \-\-list\-images <provider_name>
salt\-cloud \-\-list\-sizes <provider_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Replace \fB<provider_name>\fP with the name of the provider configuration you defined.
.SS Create VM Profiles
.sp
On your Salt Master, browse to \fB/etc/salt/cloud.profiles.d/\fP and create
a file called \fB<profile>.conf\fP, replacing \fB<profile>\fP with
\fBec2\fP, \fBsoftlayer\fP, and so on. The file must end in \fB\&.conf\fP\&.
.sp
You can now add any custom profiles you\(aqd like to define to this file. Here are
a few examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
micro_ec2:
  provider: my\-ec2
  image: ami\-d514f291
  size: t1.micro

medium_ec2:
  provider: my\-ec2
  image: ami\-d514f291
  size: m3.medium

large_ec2:
  provider: my\-ec2
  image: ami\-d514f291
  size: m3.large
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Notice that the \fBprovider\fP in our profile matches the provider name that we
defined? That is how Salt Cloud knows how to connect to a cloud host to
create a VM with these attributes.
.SS Create VMs
.sp
VMs are created by calling \fBsalt\-cloud\fP with the following options:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p <profile> <name1> <name2> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p micro_ec2 minion1 minion2
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Destroy VMs
.sp
Add a \fB\-d\fP and the minion name you provided to destroy:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-d minion1 minion2
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Query VMs
.sp
You can view details about the VMs you\(aqve created using \fB\-\-query\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-query
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Cloud Map
.sp
Now that you know how to create and destoy individual VMs, next you should
learn how to use a cloud map to create a number of VMs at once.
.sp
Cloud maps let you define a map of your infrastructure and quickly provision
any number of VMs. On subsequent runs, any VMs that do not exist are created,
and VMs that are already configured are left unmodified.
.sp
See \fI\%Cloud Map File\fP\&.
.SS Using Salt Cloud with the Event Reactor
.sp
One of the most powerful features of the Salt framework is the Event Reactor.
As the Reactor was in development, Salt Cloud was regularly updated to take
advantage of the Reactor upon completion. As such, various aspects of both the
creation and destruction of instances with Salt Cloud fire events to the Salt
Master, which can be used by the Event Reactor.
.SS Event Structure
.sp
As of this writing, all events in Salt Cloud have a tag, which includes the ID
of the instance being managed, and a payload which describes the task that is
currently being handled. A Salt Cloud tag looks like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt/cloud/<minion_id>/<task>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For instance, the first event fired when creating an instance named \fBweb1\fP
would look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt/cloud/web1/creating
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Assuming this instance is using the \fBec2\-centos\fP profile, which is in turn
using the \fBec2\-config\fP provider, the payload for this tag would look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqname\(dq: \(dqweb1\(dq, \(dqprofile\(dq: \(dqec2\-centos\(dq, \(dqprovider\(dq: \(dqec2\-config:ec2\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Available Events
.sp
When an instance is created in Salt Cloud, whether by map, profile, or directly
through an API, a minimum of five events are normally fired. More may be
available, depending upon the cloud provider being used. Some of the common
events are described below.
.SS salt/cloud/<minion_id>/creating
.sp
This event states simply that the process to create an instance has begun. At
this point in time, no actual work has begun. The payload for this event
includes:
.sp
name
profile
provider
.SS salt/cloud/<minion_id>/requesting
.sp
Salt Cloud is about to make a request to the cloud provider to create an
instance. At this point, all of the variables required to make the request have
been gathered, and the payload of the event will reflect those variables which
do not normally pose a security risk. What is returned here is dependent upon
the cloud provider. Some common variables are:
.sp
name
image
size
location
.SS salt/cloud/<minion_id>/querying
.sp
The instance has been successfully requested, but the necessary information to
log into the instance (such as IP address) is not yet available. This event
marks the beginning of the process to wait for this information.
.sp
The payload for this event normally only includes the \fBinstance_id\fP\&.
.SS salt/cloud/<minion_id>/waiting_for_ssh
.sp
The information required to log into the instance has been retrieved, but the
instance is not necessarily ready to be accessed. Following this event, Salt
Cloud will wait for the IP address to respond to a ping, then wait for the
specified port (usually 22) to respond to a connection, and on Linux systems,
for SSH to become available. Salt Cloud will attempt to issue the \fBdate\fP
command on the remote system, as a means to check for availability. If no
\fBssh_username\fP has been specified, a list of usernames (starting with
\fBroot\fP) will be attempted. If one or more usernames was configured for
\fBssh_username\fP, they will be added to the beginning of the list, in order.
.sp
The payload for this event normally only includes the \fBip_address\fP\&.
.SS salt/cloud/<minion_id>/deploying
.sp
The necessary port has been detected as available, and now Salt Cloud can log
into the instance, upload any files used for deployment, and run the deploy
script. Once the script has completed, Salt Cloud will log back into the
instance and remove any remaining files.
.sp
A number of variables are used to deploy instances, and the majority of these
will be available in the payload. Any keys, passwords or other sensitive data
will be scraped from the payload. Most of the variables returned will be
related to the profile or provider config, and any default values that could
have been changed in the profile or provider, but weren\(aqt.
.SS salt/cloud/<minion_id>/created
.sp
The deploy sequence has completed, and the instance is now available, Salted,
and ready for use. This event is the final task for Salt Cloud, before returning
instance information to the user and exiting.
.sp
The payload for this event contains little more than the initial \fBcreating\fP
event. This event is required in all cloud providers.
.SS Filtering Events
.sp
When creating a VM, it is possible with certain tags to filter how much
information is sent to the event bus. The tags that can be filtered on any
provider are:
.INDENT 0.0
.IP \(bu 2
\fBsalt/cloud/<minion_id>/creating\fP
.IP \(bu 2
\fBsalt/cloud/<minion_id>/requesting\fP
.IP \(bu 2
\fBsalt/cloud/<minion_id>/created\fP
.UNINDENT
.sp
Other providers may allow other tags to be filtered; when that is the case,
the documentation for that provider will contain more details.
.sp
To filter information, create a section in your \fB/etc/salt/cloud\fP file called
\fBfilter_events\fP\&. Create a section for each tag that you want to filter, using
the last segment of the tag. For instance, use \fBcreating\fP to represent
\fBsalt/cloud/<minion_id>/creating\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
filter_events:
  creating:
    keys:
      \- name
      \- profile
      \- provider
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Any keys listed here will be added to the default keys that are already set to
be displayed for that provider. If you wish to start with a clean slate and
only show the keys specified, add another option called \fBuse_defaults\fP and
set it to \fBFalse\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
filter_events:
  creating:
    keys:
      \- name
      \- profile
      \- provider
    use_defaults: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configuring the Event Reactor
.sp
The Event Reactor is built into the Salt Master process, and as such is
configured via the master configuration file. Normally this will be a YAML
file located at \fB/etc/salt/master\fP\&. Additionally, master configuration items
can be stored, in YAML format, inside the \fB/etc/salt/master.d/\fP directory.
.sp
These configuration items may be stored in either location; however, they may
only be stored in one location. For organizational and security purposes, it
may be best to create a single configuration file, which contains only Event
Reactor configuration, at \fB/etc/salt/master.d/reactor\fP\&.
.sp
The Event Reactor uses a top\-level configuration item called \fBreactor\fP\&. This
block contains a list of tags to be watched for, each of which also includes a
list of \fBsls\fP files. For instance:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor:
  \- \(aqsalt/minion/*/start\(aq:
    \- \(aq/srv/reactor/custom\-reactor.sls\(aq
  \- \(aqsalt/cloud/*/created\(aq:
    \- \(aq/srv/reactor/cloud\-alert.sls\(aq
  \- \(aqsalt/cloud/*/destroyed\(aq:
    \- \(aq/srv/reactor/cloud\-destroy\-alert.sls\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above configuration configures reactors for three different tags: one which
is fired when a minion process has started and is available to receive commands,
one which is fired when a cloud instance has been created, and one which is
fired when a cloud instance is destroyed.
.sp
Note that each tag contains a wildcard (\fB*\fP) in it. For each of these tags,
this will normally refer to a \fBminion_id\fP\&. This is not required of event tags,
but is very common.
.SS Reactor SLS Files
.sp
Reactor \fBsls\fP files should be placed in the \fB/srv/reactor/\fP directory for
consistency between environments, but this is not currently enforced by Salt.
.sp
Reactor \fBsls\fP files follow a similar format to other \fBsls\fP files in
Salt. By default they are written in YAML and can be templated using Jinja, but
since they are processed through Salt\(aqs rendering system, any available
renderer (JSON, Mako, Cheetah, etc.) can be used.
.sp
As with other \fBsls\fP files, each stanza will start with a declaration ID,
followed by the function to run, and then any arguments for that function. For
example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/reactor/cloud\-alert.sls
new_instance_alert:
  cmd.pagerduty.create_event:
    \- tgt: alertserver
    \- kwarg:
        description: \(dqNew instance: {{ data[\(aqname\(aq] }}\(dq
        details: \(dqNew cloud instance created on {{ data[\(aqprovider\(aq] }}\(dq
        service_key: 1626dead5ecafe46231e968eb1be29c4
        profile: my\-pagerduty\-account
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When the Event Reactor receives an event notifying it that a new instance has
been created, this \fBsls\fP will create a new incident in PagerDuty, using the
configured PagerDuty account.
.sp
The declaration ID in this example is \fBnew_instance_alert\fP\&. The function
called is \fBcmd.pagerduty.create_event\fP\&. The \fBcmd\fP portion of this function
specifies that an execution module and function will be called, in this case,
the \fBpagerduty.create_event\fP function.
.sp
Because an execution module is specified, a target (\fBtgt\fP) must be specified
on which to call the function. In this case, a minion called \fBalertserver\fP
has been used. Any arguments passed through to the function are declared in the
\fBkwarg\fP block.
.SS Example: Reactor\-Based Highstate
.sp
When Salt Cloud creates an instance, by default it will install the Salt Minion
onto the instance, along with any specified minion configuration, and
automatically accept that minion\(aqs keys on the master. One of the configuration
options that can be specified is \fBstartup_states\fP, which is commonly set to
\fBhighstate\fP\&. This will tell the minion to immediately apply a \fI\%highstate\fP, as soon as it is able to do so.
.sp
This can present a problem with some system images on some cloud hosts. For
instance, Salt Cloud can be configured to log in as either the \fBroot\fP user, or
a user with \fBsudo\fP access. While some hosts commonly use images that
lock out remote \fBroot\fP access and require a user with \fBsudo\fP privileges to
log in (notably EC2, with their \fBec2\-user\fP login), most cloud hosts fall
back to \fBroot\fP as the default login on all images, including for operating
systems (such as Ubuntu) which normally disallow remote \fBroot\fP login.
.sp
For users of these operating systems, it is understandable that a
\fI\%highstate\fP would include configuration to block
remote \fBroot\fP logins again. However, Salt Cloud may not have finished
cleaning up its deployment files by the time the minion process has started,
and kicked off a \fI\%highstate\fP run. Users have reported
errors from Salt Cloud getting locked out while trying to clean up after
itself.
.sp
The goal of a startup state may be achieved using the Event Reactor. Because a
minion fires an event when it is able to receive commands, this event can
effectively be used inside the reactor system instead. The following will point
the reactor system to the right \fBsls\fP file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor:
  \- \(aqsalt/cloud/*/created\(aq:
    \- \(aq/srv/reactor/startup_highstate.sls\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And the following \fBsls\fP file will start a \fI\%highstate\fP run on the target minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/reactor/startup_highstate.sls
reactor_highstate:
  cmd.state.apply:
    \- tgt: {{ data[\(aqname\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Because this event will not be fired until Salt Cloud has cleaned up after
itself, the \fI\%highstate\fP run will not step on
salt\-cloud\(aqs toes. And because every file on the minion is configurable,
including \fB/etc/salt/minion\fP, the \fBstartup_states\fP can still be configured
for future minion restarts, if desired.
.SH SALT PROXY MINION
.sp
Proxy minions are a developing Salt feature that enables controlling devices
that, for whatever reason, cannot run a standard salt\-minion.  Examples include
network gear that has an API but runs a proprietary OS, devices with limited
CPU or memory, or devices that could run a minion, but for security reasons,
will not.
.sp
There are some \fI\%proxy modules\fP available, but if your device
interface is not currently supported you will most likely have to write the interface
yourself, because there are an infinite number of controllable devices. Fortunately, this
is only as difficult as the actual interface to the proxied device. Devices that have an
existing Python module (PyUSB for example) would be relatively simple to interface.
Code to control a device that has an HTML REST\-based interface should be easy.  Code to
control your typical housecat would be excellent source material for a PhD thesis.
.sp
Salt proxy\-minions provide the \(aqplumbing\(aq that allows device enumeration
and discovery, control, status, remote execution, and state management.
.sp
See the \fI\%Proxy Minion Walkthrough\fP for an end\-to\-end
demonstration of a working REST\-based proxy minion.
.sp
See the \fI\%Proxy Minion SSH Walkthrough\fP for an end\-to\-end
demonstration of a working SSH proxy minion.
.sp
See \fI\%Proxyminion States\fP to configure and
run \fBsalt\-proxy\fP on a remote minion. Specify all your master side
proxy (pillar) configuration and use this state to remotely configure proxies on one
or more minions.
.sp
See \fI\%Proxyminion Beacon\fP to help
with easy configuration and management of \fBsalt\-proxy\fP processes.
.SS New in 2017.7.0
.sp
The \fI\%proxy_merge_grains_in_module\fP configuration variable
introduced in 2016.3, has been changed, defaulting to \fBTrue\fP\&.
.sp
The connection with the remote device is kept alive by default, when the
module implements the \fBalive\fP function and \fI\%proxy_keep_alive\fP
is set to \fBTrue\fP\&. The polling interval is set using the
\fI\%proxy_keep_alive_interval\fP option which defaults to 1 minute.
.sp
The developers are also able to use the \fI\%proxy_always_alive\fP,
when designing a proxy module flexible enough to open the
connection with the remote device only when required.
.SS New in 2016.11.0
.sp
Proxy minions now support configuration files with names ending in \(aq*.conf\(aq
and placed in /etc/salt/proxy.d.
.sp
Proxy minions can now be configured in /etc/salt/proxy or /etc/salt/proxy.d
instead of just pillar.  Configuration format is the same as it would be in pillar.
.SS New in 2016.3
.sp
The deprecated config option \fBenumerate_proxy_minions\fP has been removed.
.sp
As mentioned in earlier documentation, the \fBadd_proxymodule_to_opts\fP
configuration variable defaults to \fBFalse\fP in this release.  This means if you
have proxymodules or other code looking in \fB__opts__[\(aqproxymodule\(aq]\fP you
will need to set this variable in your \fB/etc/salt/proxy\fP file, or
modify your code to use the \fI__proxy__\fP injected variable.
.sp
The \fB__proxyenabled__\fP directive now only applies to grains and proxy modules
themselves.  Standard execution modules and state modules are not prevented
from loading for proxy minions.
.sp
Enhancements in grains processing have made the \fB__proxyenabled__\fP directive
somewhat redundant in dynamic grains code.  It is still required, but best
practices for the \fB__virtual__\fP function in grains files have changed.  It
is now recommended that the \fB__virtual__\fP functions check to make sure
they are being loaded for the correct proxytype, example below:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def __virtual__():
    \(dq\(dq\(dq
    Only work on proxy
    \(dq\(dq\(dq
    try:
        if (
            salt.utils.platform.is_proxy()
            and __opts__[\(dqproxy\(dq][\(dqproxytype\(dq] == \(dqssh_sample\(dq
        ):
            return __virtualname__
    except KeyError:
        pass

    return False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The try/except block above exists because grains are processed very early
in the proxy minion startup process, sometimes earlier than the proxy
key in the \fB__opts__\fP dictionary is populated.
.sp
Grains are loaded so early in startup that no dunder dictionaries are
present, so \fB__proxy__\fP, \fB__salt__\fP, etc. are not available.  Custom
grains located in \fB/srv/salt/_grains\fP and in the salt install grains
directory can now take a single argument, \fBproxy\fP, that is identical
to \fB__proxy__\fP\&.  This enables patterns like
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def get_ip(proxy):
    \(dq\(dq\(dq
    Ask the remote device what IP it has
    \(dq\(dq\(dq
    return {\(dqip\(dq: proxy[\(dqproxymodulename.get_ip\(dq]()}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then the grain \fBip\fP will contain the result of calling the \fBget_ip()\fP function
in the proxymodule called \fBproxymodulename\fP\&.
.sp
Proxy modules now benefit from including a function called \fBinitialized()\fP\&.  This
function should return \fBTrue\fP if the proxy\(aqs \fBinit()\fP function has been successfully
called.  This is needed to make grains processing easier.
.sp
Finally, if there is a function called \fBgrains\fP in the proxymodule, it
will be executed on proxy\-minion startup and its contents will be merged with
the rest of the proxy\(aqs grains.  Since older proxy\-minions might have used other
methods to call such a function and add its results to grains, this is config\-gated
by a new proxy configuration option called \fBproxy_merge_grains_in_module\fP\&.  This
defaults to \fBTrue\fP in the \fB2017.7.0\fP release.
.SS New in 2015.8.2
.sp
\fIBREAKING CHANGE\fP: Adding the \fIproxymodule\fP variable  to __opts__ is deprecated.
The \fIproxymodule\fP variable has been moved a new globally\-injected variable
called \fI__proxy__\fP\&.  A related configuration option called
\fIadd_proxymodule_to_opts\fP has been added and defaults to \fITrue\fP\&.  In the next
major release, 2016.3.0, this variable will default to False.
.sp
In the meantime, proxies that functioned under 2015.8.0 and .1 should continue
to work under 2015.8.2.  You should rework your proxy code to use \fI__proxy__\fP as
soon as possible.
.sp
The \fIrest_sample\fP example proxy minion has been updated to use \fI__proxy__\fP\&.
.sp
This change was made because proxymodules are a LazyLoader object, but
LazyLoaders cannot be serialized.  \fI__opts__\fP gets serialized, and so things
like \fIsaltutil.sync_all\fP and \fIstate.highstate\fP would throw exceptions.
.sp
Support has been added to Salt\(aqs loader allowing custom proxymodules
to be placed in \fBsalt://_proxy\fP\&.  Proxy minions that need these modules
will need to be restarted to pick up any changes.  A corresponding utility function,
\fBsaltutil.sync_proxymodules\fP, has been added to sync these modules to minions.
.sp
In addition, a salt.utils helper function called \fIis_proxy()\fP was added to make
it easier to tell when the running minion is a proxy minion. \fBNOTE: This
function was renamed to salt.utils.platform.is_proxy() for the 2018.3.0
release\fP
.SS New in 2015.8
.sp
Starting with the 2015.8 release of Salt, proxy processes are no longer forked
off from a controlling minion.  Instead, they have their own script
\fBsalt\-proxy\fP which takes mostly the same arguments that the standard Salt
minion does with the addition of \fB\-\-proxyid\fP\&.  This is the id that the
salt\-proxy will use to identify itself to the master.  Proxy configurations are
still best kept in Pillar and their format has not changed.
.sp
This change allows for better process control and logging.  Proxy processes can
now be listed with standard process management utilities (\fBps\fP from the
command line).  Also, a full Salt minion is no longer required (though it is
still strongly recommended) on machines hosting proxies.
.SS Getting Started
.sp
The following diagram may be helpful in understanding the structure of a Salt
installation that includes proxy\-minions:
[image]
.sp
The key thing to remember is the left\-most section of the diagram.  Salt\(aqs
nature is to have a minion connect to a master, then the master may control
the minion.  However, for proxy minions, the target device cannot run a minion.
.sp
After the proxy minion is started and initiates its connection to the
device, it connects back to the salt\-master and for all intents and purposes
looks like just another minion to the Salt master.
.sp
To create support for a proxied device one needs to create four things:
.INDENT 0.0
.IP 1. 3
The \fI\%proxy_connection_module\fP (located in salt/proxy).
.IP 2. 3
The \fI\%grains support code\fP (located in salt/grains).
.IP 3. 3
\fI\%Salt modules\fP specific to the controlled
device.
.IP 4. 3
\fI\%Salt states\fP specific to the controlled device.
.UNINDENT
.SS Configuration parameters
.sp
Proxy minions require no configuration parameters in /etc/salt/master.
.sp
Salt\(aqs Pillar system is ideally suited for configuring proxy\-minions
(though they can be configured in /etc/salt/proxy as well).  Proxies
can either be designated via a pillar file in pillar_roots, or through an
external pillar.  External pillars afford the opportunity for interfacing with
a configuration management system, database, or other knowledgeable system that
that may already contain all the details of proxy targets.  To use static files
in pillar_roots, pattern your files after the following examples, which are
based on the diagram above:
.sp
\fB/srv/pillar/top.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  net\-device1:
    \- net\-device1
  net\-device2:
    \- net\-device2
  net\-device3:
    \- net\-device3
  i2c\-device4:
    \- i2c\-device4
  i2c\-device5:
    \- i2c\-device5
  433wireless\-device6:
    \- 433wireless\-device6
  smsgate\-device7:
    \- device7
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/pillar/net\-device1.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: networkswitch
  host: 172.23.23.5
  username: root
  passwd: letmein
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/pillar/net\-device2.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: networkswitch
  host: 172.23.23.6
  username: root
  passwd: letmein
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/pillar/net\-device3.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: networkswitch
  host: 172.23.23.7
  username: root
  passwd: letmein
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/pillar/i2c\-device4.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: i2c_lightshow
  i2c_address: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/pillar/i2c\-device5.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: i2c_lightshow
  i2c_address: 2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/pillar/433wireless\-device6.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: 433mhz_wireless
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/pillar/smsgate\-device7.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: sms_serial
  deventry: /dev/tty04
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note the contents of each minioncontroller key may differ widely based on
the type of device that the proxy\-minion is managing.
.sp
In the above example
.INDENT 0.0
.IP \(bu 2
net\-devices 1, 2, and 3 are network switches that have a management
interface available at a particular IP address.
.IP \(bu 2
i2c\-devices 4 and 5 are very low\-level devices controlled over an i2c bus.
In this case the devices are physically connected to machine
\(aqminioncontroller2\(aq, and are addressable on the i2c bus at their respective
i2c addresses.
.IP \(bu 2
433wireless\-device6 is a 433 MHz wireless transmitter, also physically connected to
minioncontroller2
.IP \(bu 2
smsgate\-device7 is an SMS gateway connected to machine minioncontroller3 via a
serial port.
.UNINDENT
.sp
Because of the way pillar works, each of the salt\-proxy processes that fork off the
proxy minions will only see the keys specific to the proxies it will be
handling.
.sp
Proxies can be configured in /etc/salt/proxy or with files in /etc/salt/proxy.d as of
Salt\(aqs 2016.11.0 release.
.sp
Also, in general, proxy\-minions are lightweight, so the machines that run them
could conceivably control a large number of devices.  To run more than one proxy from
a single machine, simply start an additional proxy process with \fB\-\-proxyid\fP
set to the id to which you want the proxy to bind.
It is possible for the proxy services to be spread across
many machines if necessary, or intentionally run on machines that need to
control devices because of some physical interface (e.g. i2c and serial above).
Another reason to divide proxy services might be security.  In more secure
environments only certain machines may have a network path to certain devices.
.SS Proxymodules
.sp
A proxy module encapsulates all the code necessary to interface with a device.
Proxymodules are located inside the salt.proxy module, or can be placed in
the \fB_proxy\fP directory in your file_roots (default is \fB/srv/salt/_proxy\fP\&.
At a minimum a proxymodule object must implement the following functions:
.sp
\fB__virtual__()\fP: This function performs the same duty that it does for other
types of Salt modules.  Logic goes here to determine if the module can be
loaded, checking for the presence of Python modules on which the proxy depends.
Returning \fBFalse\fP will prevent the module from loading.
.sp
\fBinit(opts)\fP: Perform any initialization that the device needs.  This is
a good place to bring up a persistent connection to a device, or authenticate
to create a persistent authorization token.
.sp
\fBinitialized()\fP: Returns True if \fBinit()\fP was successfully called.
.sp
\fBshutdown()\fP: Code to cleanly shut down or close a connection to
a controlled device goes here.  This function must exist, but can contain only
the keyword \fBpass\fP if there is no shutdown logic required.
.sp
\fBping()\fP: While not required, it is highly recommended that this function also
be defined in the proxymodule. The code for \fBping\fP should contact the
controlled device and make sure it is really available.
.sp
\fBalive(opts)\fP: Another optional function, it is used together with the
\fBproxy_keep_alive\fP option (default: \fBTrue\fP). This function should
return a boolean value corresponding to the state of the connection.
If the connection is down, will try to restart (\fBshutdown\fP
followed by \fBinit\fP). The polling frequency is controlled using
the \fBproxy_keep_alive_interval\fP option, in minutes.
.sp
\fBgrains()\fP: Rather than including grains in /srv/salt/_grains or in
the standard install directories for grains, grains can be computed and
returned by this function.  This function will be called automatically
if \fBproxy_merge_grains_in_module\fP is set to \fBTrue\fP in /etc/salt/proxy.
This variable defaults to \fBTrue\fP in the release code\-named \fI2017.7.0\fP\&.
.sp
Pre 2015.8 the proxymodule also must have an \fBid()\fP function.  2015.8 and following don\(aqt use
this function because the proxy\(aqs id is required on the command line.
.sp
Here is an example proxymodule used to interface to a \fIvery\fP simple REST
server. Code for the server is in the \fI\%salt\-contrib GitHub repository\fP\&.
.sp
This proxymodule enables \(dqservice\(dq enumeration, starting, stopping, restarting,
and status; \(dqpackage\(dq installation, and a ping.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# \-*\- coding: utf\-8 \-*\-
\(dq\(dq\(dq
This is a simple proxy\-minion designed to connect to and communicate with
the bottle\-based web service contained in https://github.com/saltstack/salt\-contrib/tree/master/proxyminion_rest_example
\(dq\(dq\(dq
from __future__ import absolute_import

# Import python libs
import logging
import salt.utils.http

HAS_REST_EXAMPLE = True

# This must be present or the Salt loader won\(aqt load this module
__proxyenabled__ = [\(dqrest_sample\(dq]


# Variables are scoped to this module so we can have persistent data
# across calls to fns in here.
GRAINS_CACHE = {}
DETAILS = {}

# Want logging!
log = logging.getLogger(__file__)


# This does nothing, it\(aqs here just as an example and to provide a log
# entry when the module is loaded.
def __virtual__():
    \(dq\(dq\(dq
    Only return if all the modules are available
    \(dq\(dq\(dq
    log.debug(\(dqrest_sample proxy __virtual__() called...\(dq)
    return True


def _complicated_function_that_determines_if_alive():
    return True


# Every proxy module needs an \(aqinit\(aq, though you can
# just put DETAILS[\(aqinitialized\(aq] = True here if nothing
# else needs to be done.


def init(opts):
    log.debug(\(dqrest_sample proxy init() called...\(dq)
    DETAILS[\(dqinitialized\(dq] = True

    # Save the REST URL
    DETAILS[\(dqurl\(dq] = opts[\(dqproxy\(dq][\(dqurl\(dq]

    # Make sure the REST URL ends with a \(aq/\(aq
    if not DETAILS[\(dqurl\(dq].endswith(\(dq/\(dq):
        DETAILS[\(dqurl\(dq] += \(dq/\(dq


def alive(opts):
    \(dq\(dq\(dq
    This function returns a flag with the connection state.
    It is very useful when the proxy minion establishes the communication
    via a channel that requires a more elaborated keep\-alive mechanism, e.g.
    NETCONF over SSH.
    \(dq\(dq\(dq
    log.debug(\(dqrest_sample proxy alive() called...\(dq)
    return _complicated_function_that_determines_if_alive()


def initialized():
    \(dq\(dq\(dq
    Since grains are loaded in many different places and some of those
    places occur before the proxy can be initialized, return whether
    our init() function has been called
    \(dq\(dq\(dq
    return DETAILS.get(\(dqinitialized\(dq, False)


def grains():
    \(dq\(dq\(dq
    Get the grains from the proxied device
    \(dq\(dq\(dq
    if not DETAILS.get(\(dqgrains_cache\(dq, {}):
        r = salt.utils.http.query(
            DETAILS[\(dqurl\(dq] + \(dqinfo\(dq, decode_type=\(dqjson\(dq, decode=True
        )
        DETAILS[\(dqgrains_cache\(dq] = r[\(dqdict\(dq]
    return DETAILS[\(dqgrains_cache\(dq]


def grains_refresh():
    \(dq\(dq\(dq
    Refresh the grains from the proxied device
    \(dq\(dq\(dq
    DETAILS[\(dqgrains_cache\(dq] = None
    return grains()


def fns():
    return {
        \(dqdetails\(dq: \(dqThis key is here because a function in \(dq
        \(dqgrains/rest_sample.py called fns() here in the proxymodule.\(dq
    }


def service_start(name):
    \(dq\(dq\(dq
    Start a \(dqservice\(dq on the REST server
    \(dq\(dq\(dq
    r = salt.utils.http.query(
        DETAILS[\(dqurl\(dq] + \(dqservice/start/\(dq + name, decode_type=\(dqjson\(dq, decode=True
    )
    return r[\(dqdict\(dq]


def service_stop(name):
    \(dq\(dq\(dq
    Stop a \(dqservice\(dq on the REST server
    \(dq\(dq\(dq
    r = salt.utils.http.query(
        DETAILS[\(dqurl\(dq] + \(dqservice/stop/\(dq + name, decode_type=\(dqjson\(dq, decode=True
    )
    return r[\(dqdict\(dq]


def service_restart(name):
    \(dq\(dq\(dq
    Restart a \(dqservice\(dq on the REST server
    \(dq\(dq\(dq
    r = salt.utils.http.query(
        DETAILS[\(dqurl\(dq] + \(dqservice/restart/\(dq + name, decode_type=\(dqjson\(dq, decode=True
    )
    return r[\(dqdict\(dq]


def service_list():
    \(dq\(dq\(dq
    List \(dqservices\(dq on the REST server
    \(dq\(dq\(dq
    r = salt.utils.http.query(
        DETAILS[\(dqurl\(dq] + \(dqservice/list\(dq, decode_type=\(dqjson\(dq, decode=True
    )
    return r[\(dqdict\(dq]


def service_status(name):
    \(dq\(dq\(dq
    Check if a service is running on the REST server
    \(dq\(dq\(dq
    r = salt.utils.http.query(
        DETAILS[\(dqurl\(dq] + \(dqservice/status/\(dq + name, decode_type=\(dqjson\(dq, decode=True
    )
    return r[\(dqdict\(dq]


def package_list():
    \(dq\(dq\(dq
    List \(dqpackages\(dq installed on the REST server
    \(dq\(dq\(dq
    r = salt.utils.http.query(
        DETAILS[\(dqurl\(dq] + \(dqpackage/list\(dq, decode_type=\(dqjson\(dq, decode=True
    )
    return r[\(dqdict\(dq]


def package_install(name, **kwargs):
    \(dq\(dq\(dq
    Install a \(dqpackage\(dq on the REST server
    \(dq\(dq\(dq
    cmd = DETAILS[\(dqurl\(dq] + \(dqpackage/install/\(dq + name
    if kwargs.get(\(dqversion\(dq, False):
        cmd += \(dq/\(dq + kwargs[\(dqversion\(dq]
    else:
        cmd += \(dq/1.0\(dq
    r = salt.utils.http.query(cmd, decode_type=\(dqjson\(dq, decode=True)
    return r[\(dqdict\(dq]


def fix_outage():
    r = salt.utils.http.query(DETAILS[\(dqurl\(dq] + \(dqfix_outage\(dq)
    return r


def uptodate(name):
    \(dq\(dq\(dq
    Call the REST endpoint to see if the packages on the \(dqserver\(dq are up to date.
    \(dq\(dq\(dq
    r = salt.utils.http.query(
        DETAILS[\(dqurl\(dq] + \(dqpackage/remove/\(dq + name, decode_type=\(dqjson\(dq, decode=True
    )
    return r[\(dqdict\(dq]


def package_remove(name):
    \(dq\(dq\(dq
    Remove a \(dqpackage\(dq on the REST server
    \(dq\(dq\(dq
    r = salt.utils.http.query(
        DETAILS[\(dqurl\(dq] + \(dqpackage/remove/\(dq + name, decode_type=\(dqjson\(dq, decode=True
    )
    return r[\(dqdict\(dq]


def package_status(name):
    \(dq\(dq\(dq
    Check the installation status of a package on the REST server
    \(dq\(dq\(dq
    r = salt.utils.http.query(
        DETAILS[\(dqurl\(dq] + \(dqpackage/status/\(dq + name, decode_type=\(dqjson\(dq, decode=True
    )
    return r[\(dqdict\(dq]


def ping():
    \(dq\(dq\(dq
    Is the REST server up?
    \(dq\(dq\(dq
    r = salt.utils.http.query(DETAILS[\(dqurl\(dq] + \(dqping\(dq, decode_type=\(dqjson\(dq, decode=True)
    try:
        return r[\(dqdict\(dq].get(\(dqret\(dq, False)
    except Exception:
        return False


def shutdown(opts):
    \(dq\(dq\(dq
    For this proxy shutdown is a no\-op
    \(dq\(dq\(dq
    log.debug(\(dqrest_sample proxy shutdown() called...\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Grains are data about minions.  Most proxied devices will have a paltry amount
of data as compared to a typical Linux server.  By default, a proxy minion will
have several grains taken from the host.  Salt core code requires values for \fBkernel\fP,
\fBos\fP, and \fBos_family\fP\-\-all of these are forced to be \fBproxy\fP for proxy\-minions.
.sp
To add others to your proxy minion for
a particular device, create a file in salt/grains named [proxytype].py and place
inside it the different functions that need to be run to collect the data you
are interested in.  Here\(aqs an example.  Note the function below called \fBproxy_functions\fP\&.
It demonstrates how a grains function can take a single argument, which will be
set to the value of \fB__proxy__\fP\&.  Dunder variables are not yet injected into Salt processes
at the time grains are loaded, so this enables us to get a handle to the proxymodule so we
can cross\-call the functions therein used to communicate with the controlled device.
.sp
Note that as of 2016.3, grains values can also be calculated in a function called \fBgrains()\fP
in the proxymodule itself.  This might be useful if a proxymodule author wants to keep
all the code for the proxy interface in the same place instead of splitting it between
the proxy and grains directories.
.sp
This function will only be called automatically if the configuration variable
\fBproxy_merge_grains_in_module\fP is set to True in the proxy configuration file
(default \fB/etc/salt/proxy\fP).  This variable defaults to \fBTrue\fP in the
release code\-named \fI2017.7.0\fP\&.
.SS The __proxyenabled__ directive
.sp
In previous versions of Salt the \fB__proxyenabled__\fP directive controlled
loading of all Salt modules for proxies (e.g. grains, execution modules, state
modules).  From 2016.3 on, the only modules that respect \fB__proxyenabled__\fP
are grains and proxy modules.  These modules need to be told which proxy they
work with.
.sp
\fB__proxyenabled__\fP is a list, and can contain a single \(aq*\(aq to indicate
a grains module works with all proxies.
.sp
Example from \fBsalt/grains/rest_sample.py\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# \-*\- coding: utf\-8 \-*\-
\(dq\(dq\(dq
Generate baseline proxy minion grains
\(dq\(dq\(dq
from __future__ import absolute_import
import salt.utils.platform

__proxyenabled__ = [\(dqrest_sample\(dq]

__virtualname__ = \(dqrest_sample\(dq


def __virtual__():
    try:
        if (
            salt.utils.platform.is_proxy()
            and __opts__[\(dqproxy\(dq][\(dqproxytype\(dq] == \(dqrest_sample\(dq
        ):
            return __virtualname__
    except KeyError:
        pass

    return False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Salt Proxy Minion End\-to\-End Example
.sp
The following is walkthrough that documents how to run a sample REST service
and configure one or more proxy minions to talk to and control it.
.INDENT 0.0
.IP 1. 3
Ideally, create a Python virtualenv in which to run the REST service.  This
is not strictly required, but without a virtualenv you will need to install
\fBbottle\fP via pip globally on your system
.IP 2. 3
Clone \fI\%https://github.com/saltstack/salt\-contrib\fP
and copy the contents of the directory \fBproxyminion_rest_example\fP
somewhere on a machine that is reachable from the machine on which you want to
run the salt\-proxy.  This machine needs Python 2.7 or later.
.IP 3. 3
Install bottle version 0.12.8 via pip or easy_install
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install bottle==0.12.8
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 4. 3
Run \fBpython rest.py \-\-help\fP for usage
.IP 5. 3
Start the REST API on an appropriate port and IP.
.IP 6. 3
Load the REST service\(aqs status page in your browser by going to the IP/port
combination (e.g. \fI\%http://127.0.0.1:8000\fP)
.IP 7. 3
You should see a page entitled \(dqSalt Proxy Minion\(dq with two sections,
one for \(dqservices\(dq and one for \(dqpackages\(dq and you should see a log entry in
the terminal where you started the REST process indicating that the index
page was retrieved.
.UNINDENT
[image]
.sp
Now, configure your salt\-proxy.
.INDENT 0.0
.IP 1. 3
Edit \fB/etc/salt/proxy\fP and add an entry for your master\(aqs location
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: localhost
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 2. 3
On your salt\-master, ensure that pillar is configured properly.  Select an ID
for your proxy (in this example we will name the proxy with the letter \(aqp\(aq
followed by the port the proxy is answering on).  In your pillar topfile,
place an entry for your proxy:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqp8000\(aq:
    \- p8000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This says that Salt\(aqs pillar should load some values for the proxy \fBp8000\fP
from the file \fB/srv/pillar/p8000.sls\fP (if you have not changed your default pillar_roots)
.INDENT 0.0
.IP 3. 3
In the pillar root for your base environment, create the \fBp8000.sls\fP file with the
following contents:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: rest_sample
  url: http://<IP your REST listens on>:port
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In other words, if your REST service is listening on port 8000 on 127.0.0.1
the \(aqurl\(aq key above should say \fBurl: http://127.0.0.1:8000\fP
.INDENT 0.0
.IP 4. 3
Make sure your salt\-master is running.
.IP 5. 3
Start the salt\-proxy in debug mode
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid=p8000 \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 6. 3
Accept your proxy\(aqs key on your salt\-master
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-y \-a p8000
The following keys are going to be accepted:
Unaccepted Keys:
p8000
Key for minion p8000 accepted.
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 7. 3
Now you should be able to ping your proxy.  When you ping, you should see
a log entry in the terminal where the REST service is running.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt p8000 test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 8. 3
The REST service implements a degenerately simple pkg and service provider as
well as a small set of grains.  To \(dqinstall\(dq a package, use a standard
\fBpkg.install\fP\&.  If you pass \(aq==\(aq and a version number after the package
name then the service will parse that and accept that as the package\(aqs
version.
.IP 9. 3
Try running \fBsalt p8000 grains.items\fP to see what grains are available.  You
can target proxies via grains if you like.
.IP 10. 3
You can also start and stop the available services (apache, redbull, and
postgresql with \fBservice.start\fP, etc.
.IP 11. 3
States can be written to target the proxy.  Feel free to experiment with
them.
.UNINDENT
.SS SSH Proxymodules
.sp
See above for a general introduction to writing proxy modules.
All of the guidelines that apply to REST are the same for SSH.
This sections specifically talks about the SSH proxy module and
explains the working of the example proxy module \fBssh_sample\fP\&.
.sp
Here is a simple example proxymodule used to interface to a device over SSH.
Code for the SSH shell is in the \fI\%salt\-contrib GitHub repository\fP\&.
.sp
This proxymodule enables \(dqpackage\(dq installation.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# \-*\- coding: utf\-8 \-*\-
\(dq\(dq\(dq
This is a simple proxy\-minion designed to connect to and communicate with
a server that exposes functionality via SSH.
This can be used as an option when the device does not provide
an api over HTTP and doesn\(aqt have the python stack to run a minion.
\(dq\(dq\(dq
from __future__ import absolute_import

# Import python libs
import salt.utils.json
import logging

# Import Salt\(aqs libs
from salt.utils.vt_helper import SSHConnection
from salt.utils.vt import TerminalException

# This must be present or the Salt loader won\(aqt load this module
__proxyenabled__ = [\(dqssh_sample\(dq]

DETAILS = {}

# Want logging!
log = logging.getLogger(__file__)


# This does nothing, it\(aqs here just as an example and to provide a log
# entry when the module is loaded.
def __virtual__():
    \(dq\(dq\(dq
    Only return if all the modules are available
    \(dq\(dq\(dq
    log.info(\(dqssh_sample proxy __virtual__() called...\(dq)

    return True


def init(opts):
    \(dq\(dq\(dq
    Required.
    Can be used to initialize the server connection.
    \(dq\(dq\(dq
    try:
        DETAILS[\(dqserver\(dq] = SSHConnection(
            host=__opts__[\(dqproxy\(dq][\(dqhost\(dq],
            username=__opts__[\(dqproxy\(dq][\(dqusername\(dq],
            password=__opts__[\(dqproxy\(dq][\(dqpassword\(dq],
        )
        # connected to the SSH server
        out, err = DETAILS[\(dqserver\(dq].sendline(\(dqhelp\(dq)

    except TerminalException as e:
        log.error(e)
        return False


def shutdown(opts):
    \(dq\(dq\(dq
    Disconnect
    \(dq\(dq\(dq
    DETAILS[\(dqserver\(dq].close_connection()


def parse(out):
    \(dq\(dq\(dq
    Extract json from out.

    Parameter
        out: Type string. The data returned by the
        ssh command.
    \(dq\(dq\(dq
    jsonret = []
    in_json = False
    for ln_ in out.split(\(dq\en\(dq):
        if \(dq{\(dq in ln_:
            in_json = True
        if in_json:
            jsonret.append(ln_)
        if \(dq}\(dq in ln_:
            in_json = False
    return salt.utils.json.loads(\(dq\en\(dq.join(jsonret))


def package_list():
    \(dq\(dq\(dq
    List \(dqpackages\(dq by executing a command via ssh
    This function is called in response to the salt command

    .. code\-block:: bash

        salt target_minion pkg.list_pkgs

    \(dq\(dq\(dq
    # Send the command to execute
    out, err = DETAILS[\(dqserver\(dq].sendline(\(dqpkg_list\(dq)

    # \(dqscrape\(dq the output and return the right fields as a dict
    return parse(out)


def package_install(name, **kwargs):
    \(dq\(dq\(dq
    Install a \(dqpackage\(dq on the REST server
    \(dq\(dq\(dq
    cmd = \(dqpkg_install \(dq + name
    if \(dqversion\(dq in kwargs:
        cmd += \(dq/\(dq + kwargs[\(dqversion\(dq]
    else:
        cmd += \(dq/1.0\(dq

    # Send the command to execute
    out, err = DETAILS[\(dqserver\(dq].sendline(cmd)

    # \(dqscrape\(dq the output and return the right fields as a dict
    return parse(out)


def package_remove(name):
    \(dq\(dq\(dq
    Remove a \(dqpackage\(dq on the REST server
    \(dq\(dq\(dq
    cmd = \(dqpkg_remove \(dq + name

    # Send the command to execute
    out, err = DETAILS[\(dqserver\(dq].sendline(cmd)

    # \(dqscrape\(dq the output and return the right fields as a dict
    return parse(out)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Connection Setup
.sp
The \fBinit()\fP method is responsible for connection setup. It uses the \fBhost\fP, \fBusername\fP and \fBpassword\fP config variables defined in the pillar data. The \fBprompt\fP kwarg can be passed to \fBSSHConnection\fP if your SSH server\(aqs prompt differs from the example\(aqs prompt \fB(Cmd)\fP\&. Instantiating the \fBSSHConnection\fP class establishes an SSH connection to the ssh server (using Salt VT).
.SS Command execution
.sp
The \fBpackage_*\fP methods use the SSH connection (established in \fBinit()\fP) to send commands out to the SSH server. The \fBsendline()\fP method of \fBSSHConnection\fP class can be used to send commands out to the server. In the above example we send commands like \fBpkg_list\fP or \fBpkg_install\fP\&. You can send any SSH command via this utility.
.SS Output parsing
.sp
Output returned by \fBsendline()\fP is a tuple of strings representing the stdout and the stderr respectively. In the toy example shown we simply scrape the output and convert it to a python dictionary, as shown in the \fBparse\fP method. You can tailor this method to match your parsing logic.
.SS Connection teardown
.sp
The \fBshutdown\fP method is responsible for calling the \fBclose_connection()\fP method of \fBSSHConnection\fP class. This ends the SSH connection to the server.
.sp
For more information please refer to class \fI\%SSHConnection\fP\&.
.SS Salt Proxy Minion SSH End\-to\-End Example
.sp
The following is walkthrough that documents how to run a sample SSH service
and configure one or more proxy minions to talk to and control it.
.INDENT 0.0
.IP 1. 3
This walkthrough uses a custom SSH shell to provide an end to end example.
Any other shells can be used too.
.IP 2. 3
Setup the proxy command shell as shown \fI\%https://github.com/saltstack/salt\-contrib/tree/master/proxyminion_ssh_example\fP
.UNINDENT
.sp
Now, configure your salt\-proxy.
.INDENT 0.0
.IP 1. 3
Edit \fB/etc/salt/proxy\fP and add an entry for your master\(aqs location
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: localhost
multiprocessing: False
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 2. 3
On your salt\-master, ensure that pillar is configured properly.  Select an ID
for your proxy (in this example we will name the proxy with the letter \(aqp\(aq
followed by the port the proxy is answering on).  In your pillar topfile,
place an entry for your proxy:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqp8000\(aq:
    \- p8000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This says that Salt\(aqs pillar should load some values for the proxy \fBp8000\fP
from the file \fB/srv/pillar/p8000.sls\fP (if you have not changed your default pillar_roots)
.INDENT 0.0
.IP 3. 3
In the pillar root for your base environment, create the \fBp8000.sls\fP file with the
following contents:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: ssh_sample
  host: saltyVM
  username: salt
  password: badpass
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 4. 3
Make sure your salt\-master is running.
.IP 5. 3
Start the salt\-proxy in debug mode
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid=p8000 \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 6. 3
Accept your proxy\(aqs key on your salt\-master
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-y \-a p8000
The following keys are going to be accepted:
Unaccepted Keys:
p8000
Key for minion p8000 accepted.
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 7. 3
Now you should be able to run commands on your proxy.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt p8000 pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 8. 3
The SSH shell implements a degenerately simple pkg.
To \(dqinstall\(dq a package, use a standard
\fBpkg.install\fP\&.  If you pass \(aq==\(aq and a version number after the package
name then the service will parse that and accept that as the package\(aqs
version.
.UNINDENT
New in version 2015.8.3.

.SS Proxy Minion Beacon
.sp
The salt proxy beacon is meant to facilitate configuring
multiple proxies on one or many minions. This should simplify
configuring and managing multiple \fBsalt\-proxy\fP processes.
.INDENT 0.0
.IP 1. 3
On your salt\-master, ensure that pillar is configured properly.  Select an ID
for your proxy (in this example we will name the proxy \(aqp8000\(aq).
In your pillar topfile, place an entry for your proxy:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqp8000\(aq:
    \- p8000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This says that Salt\(aqs pillar should load some values for the proxy \fBp8000\fP
from the file \fB/srv/pillar/p8000.sls\fP (if you have not changed your default pillar_roots)
.INDENT 0.0
.IP 2. 3
In the pillar root for your base environment, create the \fBp8000.sls\fP file with the
following contents:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  # set proxytype for your proxymodule
  proxytype: ssh_sample
  host: saltyVM
  username: salt
  password: badpass
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This should complete the proxy setup for \fBp8000\fP
.INDENT 0.0
.IP 3. 3
\fI\%Configure\fP the \fBsalt_proxy\fP beacon
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  salt_proxy:
    \- proxies:
        p8000: {}
        p8001: {}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once this beacon is configured it will automatically start the \fBsalt\-proxy\fP
process. If the \fBsalt\-proxy\fP process is terminated the beacon will
re\-start it.
.INDENT 0.0
.IP 4. 3
Accept your proxy\(aqs key on your salt\-master
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-y \-a p8000
The following keys are going to be accepted:
Unaccepted Keys:
p8000
Key for minion p8000 accepted.
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 5. 3
Now you should be able to run commands on your proxy.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt p8000 pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
New in version 2015.8.2.

.SS Proxy Minion States
.sp
Salt proxy state can be used to deploy, configure and run
a \fBsalt\-proxy\fP instance on your minion. Configure proxy settings
on the master side and the state configures and runs \fBsalt\-proxy\fP
on the remote end.
.INDENT 0.0
.IP 1. 3
On your salt\-master, ensure that pillar is configured properly.  Select an ID
for your proxy (in this example we will name the proxy \(aqp8000\(aq).
In your pillar topfile, place an entry for your proxy:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqp8000\(aq:
    \- p8000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This says that Salt\(aqs pillar should load some values for the proxy \fBp8000\fP
from the file \fB/srv/pillar/p8000.sls\fP (if you have not changed your default pillar_roots)
.INDENT 0.0
.IP 2. 3
In the pillar root for your base environment, create the \fBp8000.sls\fP file with the
following contents:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  # set proxytype for your proxymodule
  proxytype: ssh_sample
  host: saltyVM
  username: salt
  password: badpass
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 3. 3
Create the following state in your state tree
(let\(aqs name it salt_proxy.sls)
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy\-configure:
  salt_proxy.configure_proxy:
    \- proxyname: p8000
    \- start: True # start the process if it isn\(aqt running
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 4. 3
Make sure your salt\-master and salt\-minion are running.
.IP 5. 3
Run the state salt_proxy on the minion where you want to run \fBsalt\-proxy\fP
.UNINDENT
.sp
Example using \fBstate.sls\fP to configure and run \fBsalt\-proxy\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt device_minion state.sls salt_proxy
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This starts salt\-proxy on \fBdevice_minion\fP
.INDENT 0.0
.IP 6. 3
Accept your proxy\(aqs key on your salt\-master
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-y \-a p8000
The following keys are going to be accepted:
Unaccepted Keys:
p8000
Key for minion p8000 accepted.
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 7. 3
Now you should be able to run commands on your proxy.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt p8000 pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.SH NETWORK AUTOMATION
.sp
Network automation is a continuous process of automating the configuration,
management and operations of a computer network. Although the abstraction
could be compared with the operations on the server side, there are many particular
challenges, the most important being that a network device is traditionally
closed hardware able to run proprietary software only. In other words,
the user is not able to install the salt\-minion package directly on a
traditional network device. For these reasons, most network devices can be
controlled only remotely via \fI\%proxy minions\fP or
using the \fI\%Salt SSH\fP\&. However, there are also vendors producing
whitebox equipment (e.g. Arista, Cumulus) or others that have moved the
operating system in the container (e.g. Cisco NX\-OS, Cisco IOS\-XR),
allowing the salt\-minion to be installed directly on the platform.
.SS New in Carbon (2016.11)
.sp
The methodologies for network automation have been introduced in
\fI\%2016.11.0\fP\&. Network
automation support is based on proxy minions.
.INDENT 0.0
.IP \(bu 2
\fI\%NAPALM proxy\fP
.IP \(bu 2
\fI\%Junos proxy\fP
.IP \(bu 2
\fI\%Cisco NXOS\fP
.IP \(bu 2
\fI\%Cisco NSO\fP
.UNINDENT
.SS NAPALM
.sp
NAPALM (Network Automation and Programmability Abstraction Layer with
Multivendor support) is an opensourced Python library that implements a set of
functions to interact with different router vendor devices using a unified API.
Being vendor\-agnostic simplifies operations, as the configuration and
interaction with the network device does not rely on a particular vendor.
[image]
.sp
Beginning with 2017.7.0, the NAPALM modules have been transformed so they can
run in both proxy and regular minions. That means, if the operating system
allows, the salt\-minion package can be installed directly on the network gear.
The interface between the network operating system and Salt in that case would
be the corresponding NAPALM sub\-package.
.sp
For example, if the user installs the
salt\-minion on a Arista switch, the only requirement is
\fI\%napalm\-eos\fP\&.
.sp
The following modules are available in 2017.7.0:
.INDENT 0.0
.IP \(bu 2
\fI\%NAPALM grains\fP
.IP \(bu 2
\fI\%NET execution module\fP \- Networking basic
features
.IP \(bu 2
\fI\%NTP execution module\fP
.IP \(bu 2
\fI\%BGP execution module\fP
.IP \(bu 2
\fI\%Routes execution module\fP
.IP \(bu 2
\fI\%SNMP execution module\fP
.IP \(bu 2
\fI\%Users execution module\fP
.IP \(bu 2
\fI\%Probes execution module\fP
.IP \(bu 2
\fI\%NTP peers management state\fP
.IP \(bu 2
\fI\%SNMP configuration management state\fP
.IP \(bu 2
\fI\%Users management state\fP
.IP \(bu 2
\fI\%Netconfig state module\fP \- Manage the configuration
of network devices using arbitrary templates and the Salt\-specific
advanced templating methodologies.
.IP \(bu 2
\fBNetwork ACL execution module\fP \- Generate and
load ACL (firewall) configuration on network devices.
.IP \(bu 2
\fI\%Network ACL state\fP \- Manage the firewall
configuration. It only requires writing the pillar structure correctly!
.IP \(bu 2
\fI\%NAPALM YANG execution module\fP \- Parse,
generate and load native device configuration in a standard way,
using the OpenConfig/IETF models. This module contains also helpers for
the states.
.IP \(bu 2
\fBNAPALM YANG state module\fP \- Manage the
network device configuration according to the YANG models (OpenConfig or IETF).
.IP \(bu 2
\fI\%NET finder\fP \- Runner to find details easily and
fast. It\(aqs smart enough to know what you are looking for. It will search
in the details of the network interfaces, IP addresses, MAC address tables,
ARP tables and LLDP neighbors.
.IP \(bu 2
\fI\%BGP finder\fP \- Runner to search BGP neighbors details.
.IP \(bu 2
\fI\%NAPALM syslog\fP \- Engine to import events
from the napalm\-logs library into the Salt event bus. The events are based
on the syslog messages from the network devices and structured following
the OpenConfig/IETF YANG models.
.IP \(bu 2
\fBNAPALM Helpers\fP \- Generic helpers for
NAPALM\-related operations. For example, the
\fBCompliance report\fP function
can be used inside the state modules to compare the expected and the
existing configuration.
.UNINDENT
.SS Getting started
.sp
Install NAPALM \- follow the \fI\%notes\fP and check the platform\-specific \fI\%dependencies\fP\&.
.sp
Salt\(aqs Pillar system is ideally suited for configuring proxy\-minions
(though they can be configured in /etc/salt/proxy as well).  Proxies
can either be designated via a pillar file in \fI\%pillar_roots\fP,
or through an external pillar.
External pillars afford the opportunity for interfacing with
a configuration management system, database, or other knowledgeable system
that may already contain all the details of proxy targets. To use static files
in \fI\%pillar_roots\fP, pattern your files after the following examples:
.sp
\fB/etc/salt/pillar/top.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  router1:
    \- router1
  router2:
    \- router2
  switch1:
    \- switch1
  switch2:
    \- switch2
  cpe1:
    \- cpe1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/etc/salt/pillar/router1.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: napalm
  driver: junos
  host: r1.bbone.as1234.net
  username: my_username
  password: my_password
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/etc/salt/pillar/router2.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: napalm
  driver: iosxr
  host: r2.bbone.as1234.net
  username: my_username
  password: my_password
  optional_args:
    port: 22022
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/etc/salt/pillar/switch1.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: napalm
  driver: eos
  host: sw1.bbone.as1234.net
  username: my_username
  password: my_password
  optional_args:
    enable_password: my_secret
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/etc/salt/pillar/switch2.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: napalm
  driver: nxos
  host: sw2.bbone.as1234.net
  username: my_username
  password: my_password
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/etc/salt/pillar/cpe1.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: napalm
  driver: ios
  host: cpe1.edge.as1234.net
  username: \(aq\(aq
  password: \(aq\(aq
  optional_args:
    use_keys: True
    auto_rollback_on_error: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS CLI examples
.sp
Display the complete running configuration on \fBrouter1\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \(aqrouter1\(aq net.config source=\(aqrunning\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Retrieve the NTP servers configured on all devices:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \(aq*\(aq ntp.servers
router1:
  \-\-\-\-\-\-\-\-\-\-
  comment:
  out:
      \- 1.2.3.4
  result:
      True
cpe1:
  \-\-\-\-\-\-\-\-\-\-
  comment:
  out:
      \- 1.2.3.4
  result:
      True
switch2:
  \-\-\-\-\-\-\-\-\-\-
  comment:
  out:
      \- 1.2.3.4
  result:
      True
router2:
  \-\-\-\-\-\-\-\-\-\-
  comment:
  out:
      \- 1.2.3.4
  result:
      True
switch1:
  \-\-\-\-\-\-\-\-\-\-
  comment:
  out:
      \- 1.2.3.4
  result:
      True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Display the ARP tables on all Cisco devices running IOS\-XR 5.3.3:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \-G \(aqos:iosxr and version:5.3.3\(aq net.arp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Return operational details for interfaces from Arista switches:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \-C \(aqsw* and os:eos\(aq net.interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Execute traceroute from the edge of the network:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \(aqrouter*\(aq net.traceroute 8.8.8.8 vrf=\(aqCUSTOMER1\-VRF\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Verbatim display from the CLI of Juniper routers:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \-C \(aqrouter* and G@os:junos\(aq net.cli \(aqshow version and haiku\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Retrieve the results of the RPM probes configured on Juniper MX960 routers:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \-C \(aqrouter* and G@os:junos and G@model:MX960\(aq probes.results
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Return the list of configured users on the CPEs:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \(aqcpe*\(aq users.config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using the \fI\%BGP finder\fP, return the list of BGP neighbors
that are down:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt\-run bgp.neighbors up=False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using the \fI\%NET finder\fP, determine the devices containing
the pattern \(dqPX\-1234\-LHR\(dq in their interface description:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt\-run net.find PX\-1234\-LHR
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Cross\-platform configuration management example: NTP
.sp
Assuming that the user adds the following two lines under
\fI\%file_roots\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /etc/salt/pillar/
    \- /etc/salt/templates/
    \- /etc/salt/states/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Define the list of NTP peers and servers wanted:
.sp
\fB/etc/salt/pillar/ntp.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ntp.servers:
  \- 1.2.3.4
  \- 5.6.7.8
ntp.peers:
   \- 10.11.12.13
   \- 14.15.16.17
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Include the new file: for example, if we want to have the same NTP servers on all
network devices, we can add the following line inside the \fBtop.sls\fP file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(aq*\(aq:
  \- ntp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/etc/salt/pillar/top.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- ntp
  router1:
    \- router1
  router2:
    \- router2
  switch1:
    \- switch1
  switch2:
    \- switch2
  cpe1:
    \- cpe1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or include only where needed:
.sp
\fB/etc/salt/pillar/top.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  router1:
    \- router1
    \- ntp
  router2:
    \- router2
    \- ntp
  switch1:
    \- switch1
  switch2:
    \- switch2
  cpe1:
    \- cpe1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Define the cross\-vendor template:
.sp
\fB/etc/salt/templates/ntp.jinja\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- if grains.vendor|lower == \(aqcisco\(aq %}
  no ntp
  {%\- for server in servers %}
  ntp server {{ server }}
  {%\- endfor %}
  {%\- for peer in peers %}
  ntp peer {{ peer }}
  {%\- endfor %}
{%\- elif grains.os|lower == \(aqjunos\(aq %}
  system {
    replace:
    ntp {
      {%\- for server in servers %}
      server {{ server }};
      {%\- endfor %}
      {%\- for peer in peers %}
      peer {{ peer }};
      {%\- endfor %}
    }
  }
{%\- endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Define the SLS state file, making use of the
\fI\%Netconfig state module\fP:
.sp
\fB/etc/salt/states/router/ntp.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ntp_config_example:
  netconfig.managed:
    \- template_name: salt://ntp.jinja
    \- peers: {{ pillar.get(\(aqntp.peers\(aq, []) | json }}
    \- servers: {{ pillar.get(\(aqntp.servers\(aq, []) | json }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Run the state and assure NTP configuration consistency across your
multi\-vendor network:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \(aqrouter*\(aq state.sls router.ntp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Besides CLI, the state can be scheduled or executed when triggered by a certain
event.
.SS JUNOS
.sp
Juniper has developed a Junos specific proxy infrastructure which allows
remote execution and configuration management of Junos devices without
having to install SaltStack on the device. The infrastructure includes:
.INDENT 0.0
.IP \(bu 2
\fI\%Junos proxy\fP
.IP \(bu 2
\fI\%Junos execution module\fP
.IP \(bu 2
\fI\%Junos state module\fP
.IP \(bu 2
\fI\%Junos syslog engine\fP
.UNINDENT
.sp
The execution and state modules are implemented using junos\-eznc (PyEZ).
Junos PyEZ is a microframework for Python that enables you to remotely manage
and automate devices running the Junos operating system.
.SS Getting started
.sp
Install PyEZ on the system which will run the Junos proxy minion.
It is required to run Junos specific modules.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install junos\-eznc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Next, set the master of the proxy minions.
.sp
\fB/etc/salt/proxy\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: <master_ip>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Add the details of the Junos device. Device details are usually stored in
salt pillars. If the you do not wish to store credentials in the pillar,
one can setup passwordless ssh.
.sp
\fB/srv/pillar/vmx_details.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: junos
  host: <hostip>
  username: user
  passwd: secret123
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Map the pillar file to the proxy minion. This is done in the top file.
.sp
\fB/srv/pillar/top.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  vmx:
    \- vmx_details
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Before starting the Junos proxy make sure that netconf is enabled on the
Junos device. This can be done by adding the following configuration on
the Junos device.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set system services netconf ssh
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Start the salt master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-master \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then start the salt proxy.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid=vmx \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once the master and junos proxy minion have started, we can run execution
and state modules on the proxy minion. Below are few examples.
.SS CLI examples
.sp
For detailed documentation of all the junos execution modules refer:
\fI\%Junos execution module\fP
.sp
Display device facts.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \(aqvmx\(aq junos.facts
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Refresh the Junos facts. This function will also refresh the facts which are
stored in salt grains. (Junos proxy stores Junos facts in the salt grains)
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \(aqvmx\(aq junos.facts_refresh
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Call an RPC.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \(aqvmx\(aq junos.rpc \(aqget\-interface\-information\(aq \(aq/var/log/interface\-info.txt\(aq terse=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Install config on the device.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \(aqvmx\(aq junos.install_config \(aqsalt://my_config.set\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Shutdown the junos device.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \(aqvmx\(aq junos.shutdown shutdown=True in_min=10
.ft P
.fi
.UNINDENT
.UNINDENT
.SS State file examples
.sp
For detailed documentation of all the junos state modules refer:
\fI\%Junos state module\fP
.sp
Executing an RPC on Junos device and storing the output in a file.
.sp
\fB/srv/salt/rpc.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
get\-interface\-information:
    junos:
      \- rpc
      \- dest: /home/user/rpc.log
      \- interface_name: lo0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Lock the junos device, load the configuration, commit it and unlock
the device.
.sp
\fB/srv/salt/load.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lock the config:
  junos.lock

salt://configs/my_config.set:
  junos:
    \- install_config
    \- timeout: 100
    \- diffs_file: \(aqvar/log/diff\(aq

commit the changes:
  junos:
    \- commit

unlock the config:
  junos.unlock
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
According to the device personality install appropriate image on the device.
.sp
\fB/srv/salt/image_install.sls\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% if grains[\(aqjunos_facts\(aq][\(aqpersonality\(aq] == MX %}
salt://images/mx_junos_image.tgz:
  junos:
    \- install_os
    \- timeout: 100
    \- reboot: True
{% elif grains[\(aqjunos_facts\(aq][\(aqpersonality\(aq] == EX %}
salt://images/ex_junos_image.tgz:
  junos:
    \- install_os
    \- timeout: 150
{% elif grains[\(aqjunos_facts\(aq][\(aqpersonality\(aq] == SRX %}
salt://images/srx_junos_image.tgz:
  junos:
    \- install_os
    \- timeout: 150
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Junos Syslog Engine
.sp
\fI\%Junos Syslog Engine\fP is a Salt engine
which receives data from various Junos devices, extracts event information and
forwards it on the master/minion event bus. To start the engine on the salt
master, add the following configuration in the master config file.
The engine can also run on the salt minion.
.sp
\fB/etc/salt/master\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- junos_syslog:
      port: xxx
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For junos_syslog engine to receive events, syslog must be set on the Junos device.
This can be done via following configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set system syslog host <ip\-of\-the\-salt\-device> port xxx any any
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SALT VIRT
.sp
The Salt Virt cloud controller capability was initially added to Salt in
version 0.14.0 as an alpha technology.
.sp
The initial Salt Virt system supports core cloud operations:
.INDENT 0.0
.IP \(bu 2
Virtual machine deployment
.IP \(bu 2
Inspection of deployed VMs
.IP \(bu 2
Virtual machine migration
.IP \(bu 2
Network profiling
.IP \(bu 2
Automatic VM integration with all aspects of Salt
.IP \(bu 2
Image Pre\-seeding
.UNINDENT
.sp
Many features are currently under development to enhance the capabilities of
the Salt Virt systems.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
It is noteworthy that Salt was originally developed with the intent of
using the Salt communication system as the backbone to a cloud controller.
This means that the Salt Virt system is not an afterthought, simply a
system that took the back seat to other development. The original attempt
to develop the cloud control aspects of Salt was a project called butter.
This project never took off, but was functional and proves the early
viability of Salt to be a cloud controller.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Salt Virt does not work with KVM that is running in a VM. KVM must be running
on the base hardware.
.UNINDENT
.UNINDENT
.SS Salt Virt Tutorial
.sp
A tutorial about how to get Salt Virt up and running has been added to the
tutorial section:
.sp
\fI\%Cloud Controller Tutorial\fP
.SS The Salt Virt Runner
.sp
The point of interaction with the cloud controller is the \fBvirt\fP
runner. The \fBvirt\fP runner comes with routines to execute specific
virtual machine routines.
.sp
Reference documentation for the virt runner is available with the runner
module documentation:
.sp
\fI\%Virt Runner Reference\fP
.SS Based on Live State Data
.sp
The Salt Virt system is based on using Salt to query live data about
hypervisors and then using the data gathered to make decisions about cloud
operations. This means that no external resources are required to run Salt
Virt, and that the information gathered about the cloud is live and accurate.
.SS Deploy from Network or Disk
.SS Virtual Machine Disk Profiles
.sp
Salt Virt allows for the disks created for deployed virtual machines
to be finely configured. The configuration is a simple data structure which is
read from the \fBconfig.option\fP function, meaning that the configuration can be
stored in the minion config file, the master config file, or the minion\(aqs
pillar.
.sp
This configuration option is called \fBvirt.disk\fP\&. The default \fBvirt.disk\fP
data structure looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
virt.disk:
  default:
    \- system:
      size: 8192
      format: qcow2
      model: virtio
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The format and model does not need to be defined, Salt will
default to the optimal format used by the underlying hypervisor,
in the case of kvm this it is \fBqcow2\fP and
\fBvirtio\fP\&.
.UNINDENT
.UNINDENT
.sp
This configuration sets up a disk profile called default. The default
profile creates a single system disk on the virtual machine.
.SS Define More Profiles
.sp
Many environments will require more complex disk profiles and may require
more than one profile, this can be easily accomplished:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
virt.disk:
  default:
    \- system:
        size: 8192
  database:
    \- system:
        size: 8192
    \- data:
        size: 30720
  web:
    \- system:
        size: 1024
    \- logs:
        size: 5120
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This configuration allows for one of three profiles to be selected,
allowing virtual machines to be created with different storage needs
of the deployed vm.
.SS Virtual Machine Network Profiles
.sp
Salt Virt allows for the network devices created for deployed virtual machines
to be finely configured. The configuration is a simple data structure which is
read from the \fBconfig.option\fP function, meaning that the configuration can be
stored in the minion config file, the master config file, or the minion\(aqs
pillar.
.sp
This configuration option is called \fBvirt:nic\fP\&. By default the \fBvirt:nic\fP
option is empty but defaults to a data structure which looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
virt:
  nic:
    default:
      eth0:
        bridge: br0
        model: virtio
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The model does not need to be defined, Salt will default to the optimal
model used by the underlying hypervisor, in the case of kvm this model
is \fBvirtio\fP
.UNINDENT
.UNINDENT
.sp
This configuration sets up a network profile called default. The default
profile creates a single Ethernet device on the virtual machine that is bridged
to the hypervisor\(aqs \fBbr0\fP interface. This default setup does not
require setting up the \fBvirt:nic\fP configuration, and is the reason why a
default install only requires setting up the \fBbr0\fP bridge device on the
hypervisor.
.SS Define More Profiles
.sp
Many environments will require more complex network profiles and may require
more than one profile, this can be easily accomplished:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
virt:
  nic:
    dual:
      eth0:
        bridge: service_br
      eth1:
        bridge: storage_br
    single:
      eth0:
        bridge: service_br
    triple:
      eth0:
        bridge: service_br
      eth1:
        bridge: storage_br
      eth2:
        bridge: dmz_br
    all:
      eth0:
        bridge: service_br
      eth1:
        bridge: storage_br
      eth2:
        bridge: dmz_br
      eth3:
        bridge: database_br
    dmz:
      eth0:
        bridge: service_br
      eth1:
        bridge: dmz_br
    database:
      eth0:
        bridge: service_br
      eth1:
        bridge: database_br
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This configuration allows for one of six profiles to be selected, allowing
virtual machines to be created which attach to different network depending
on the needs of the deployed vm.
.SH ONEDIR PACKAGING
.SS Relenv onedir packaging
.sp
Starting in 3006, only onedir packaging will be available. The 3006 onedir packages
are built with the \fI\%relenv\fP tool.
.SS Docker Containers
.sp
The Salt Project uses docker containers to build our deb and rpm packages. If you are building your own packages you can use
the same containers we build with in the Github piplines. These containers are documented \fI\%here\fP\&.
.SS Package Grain
.sp
In the 3007.0 release a new package grain was added. This detects how Salt was installed using the \fI_pkg.txt\fP
in the root of the Salt repo. By default this is set to \fBpip\fP, but it is set to \fBonedir\fP when \fBtools pkg build salt\-onedir\fP
is run in our pipelines when building our onedir packages. If you are building your own custom packages, please ensure you set
\fB_pkg.txt\fP contents to be the type of package you are creating. The options are \fBpip\fP, \fBonedir\fP or \fBsystem\fP\&.
.SS How to build onedir only
.INDENT 0.0
.IP 1. 3
Install relenv:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install relenv
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 2. 3
Fetch toolchain (Only required for linux OSs)
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
relenv toolchain fetch
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 3. 3
Fetch Native Python Build:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
relenv fetch \-\-python=<python\-version>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 4. 3
Create relenv environment:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
relenv create \-\-python=<python\-version> <relenv\-package\-path>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 5. 3
Add Salt into onedir.
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<relenv\-package\-path>/bin/pip install /path/to/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS How to build rpm packages
.INDENT 0.0
.IP 1. 3
Ensure you are in the current Salt cloned git repo:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cd <path\-to\-salt\-repo>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 2. 3
Install the dependencies:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
yum \-y install python3 python3\-pip openssl git rpmdevtools rpmlint systemd\-units libxcrypt\-compat git gnupg2 jq createrepo rpm\-sign rustc cargo epel\-release
yum \-y install patchelf
pip install awscli
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install \-r requirements/static/ci/py{python_version}/tools.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 3. 3
(Optional) To build a specific Salt version, you will need to install tools and changelog dependencies:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install \-r requirements/static/ci/py{python_version}/changelog.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 4. 3
(Optional) To build a specific Salt version, run tools and set Salt version:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tools changelog update\-rpm <salt\-version>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 5. 3
Build the RPM:
.INDENT 3.0
.INDENT 3.5
Only the arch argument is required, the rest are optional.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tools pkg build rpm \-\-relenv\-version <relenv\-version> \-\-python\-version <python\-version> \-\-arch <arch>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS How to build deb packages
.INDENT 0.0
.IP 1. 3
Ensure you are in the current Salt cloned git repo.:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cd <path\-to\-salt\-repo>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 2. 3
Install the dependencies:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apt install \-y apt\-utils gnupg jq awscli python3 python3\-venv python3\-pip build\-essential devscripts debhelper bash\-completion git patchelf rustc
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install \-r requirements/static/ci/py{python_version}/tools.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 3. 3
(Optional) To build a specific Salt version, you will need to install changelog dependencies:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install \-r requirements/static/ci/py{python_version}/changelog.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 4. 3
(Optional) To build a specific Salt version, run tools and set Salt version:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tools changelog update\-deb <salt\-version>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 5. 3
Build the deb package:
.INDENT 3.0
.INDENT 3.5
Only the arch argument is required, the rest are optional.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tools pkg build deb \-\-relenv\-version <relenv\-version> \-\-python\-version <python\-version> \-\-arch <arch>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS How to build MacOS packages
.INDENT 0.0
.IP 1. 3
Ensure you are in the current Salt cloned git repo.:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cd <path\-to\-salt\-repo>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 2. 3
Install the dependencies:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install \-r requirements/static/ci/py{python_version}/tools.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 3. 3
Build the MacOS package:
.INDENT 3.0
.INDENT 3.5
Only the salt\-version argument is required, the rest are optional.
Do note that you will not be able to sign the packages when building them.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tools pkg build macos \-\-salt\-version <salt\-version>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS How to build Windows packages
.INDENT 0.0
.IP 1. 3
Ensure you are in the current Salt cloned git repo.:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cd <path\-to\-salt\-repo>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 2. 3
Install the dependencies:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install \-r requirements/static/ci/py{python_version}/tools.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 3. 3
Build the MacOS package:
.INDENT 3.0
.INDENT 3.5
Only the arch and salt\-version arguments are required, the rest are optional.
Do note that you will not be able to sign the packages when building them.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tools pkg build windows \-\-salt\-version <salt\-version> \-\-arch <arch>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS How to access python binary
.sp
The python library is available in the install directory of the onedir package. For example
on linux the default location would be \fB/opt/saltstack/salt/bin/python3\fP\&.
.SS Testing the packages
.sp
If you want to test your built packages, or any other collection of salt packages post 3006.0, follow \fI\%this guide\fP
.SS Testing packages
.SS The package test suite
.sp
The salt repo provides a test suite for testing basic functionality of our
packages at \fB<repo\-root>/pkg/tests/\fP\&. You can run the install, upgrade, and
downgrade tests. These tests run automatically on most PRs that are submitted
against Salt.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
These tests make destructive changes to your system because they install the
built packages onto the system. They may also install older versions in the
case of upgrades or downgrades. To prevent destructive changes, run the
tests in an isolated system, preferably a virtual machine.
.UNINDENT
.UNINDENT
.SS Setup
.sp
In order to run the package tests, the \fI\%relenv\fP onedir and
built packages need to be placed in the correct locations.
.INDENT 0.0
.IP \(bu 2
Place all salt packages for the applicable testing version in
\fB<repo\-root>/artifacts/pkg/\fP\&.
.IP \(bu 2
The onedir must be located under \fB<repo\-root>/artifacts/\fP\&.
.IP \(bu 2
Additionally, to ensure complete parity with Salt\(aqs CI/CD suite, place the
\fBnox\fP virtual environment in \fB<repo\-root>/.nox/test\-pkgs\-onedir\fP\&.
.UNINDENT
.sp
The following are a few ways this can be accomplished easily.
.sp
You can ensure parity by installing the package test suite through a few
possible methods:
.INDENT 0.0
.IP \(bu 2
Using \fBtools\fP
.IP \(bu 2
Downloading individually
.UNINDENT
.SS Using \fBtools\fP
.sp
Salt has preliminary support for setting up the package test suite in the
\fBtools\fP command suite that is located under \fB<repo\-root>/tools/testsuite/\fP\&.
This method requires the Github CLI tool \fBgh\fP (\fI\%https://cli.github.com/\fP) to be properly configured for
interaction with the salt repo.
.INDENT 0.0
.IP 1. 3
Install the dependencies using this command:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install \-r requirements/static/ci/py{python_version}/tools.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 2. 3
Download and extract the artifacts with this \fBtools\fP command:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tools ts setup \-\-platform {linux|darwin|windows} \-\-slug
<operating\-system\-slug> \-\-pr <pr\-number> \-\-pkg
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The most common use case is to test the packages built on a CI/CD run for a
given PR. To see the possible options for each argument, and other ways to
utilize this command, use the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tools ts setup \-h
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
You can only download artifacts from finished workflow runs. This is something
imposed by the GitHub API.
To download artifacts from a running workflow run, you either have to wait for
the finish or cancel it.
.UNINDENT
.UNINDENT
.SS Downloading individually
.sp
If the \fBtools ts setup\fP command doesn\(aqt work, you can download, unzip, and
place the artifacts in the correct locations manually. Typically, you want to
test packages built on a CI/CD run for a given PR. This guide explains how to
set up for running the package tests using those artifacts. An analogous process
can be performed for artifacts from nightly builds.
.INDENT 0.0
.IP 1. 3
Find and download the artifacts:
.INDENT 3.0
.INDENT 3.5
Under the summary page for the most recent actions run for that PR, there is
a list of available artifacts from that run that can be downloaded. Download
the package artifacts by finding
\fBsalt\-<major>.<minor>+<number>.<sha>\-<arch>\-<pkg\-type>\fP\&.  For example, the
amd64 deb packages might look like:
\fBsalt\-3006.2+123.01234567890\-x86_64\-deb\fP\&.
.sp
The onedir artifact will look like
\fBsalt\-<major>.<minor>+<number>.<sha>\-onedir\-<platform>\-<arch>.tar.xz\fP\&. For
instance, the macos x86_64 onedir may have the name
\fBsalt\-3006.2+123.01234567890\-onedir\-darwin\-x86_64.tar.xz\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Windows onedir artifacts have \fB\&.zip\fP extensions instead of \fBtar.xz\fP
.UNINDENT
.UNINDENT
.sp
While it is optional, it is recommended to download the \fBnox\fP session
artifact as well.  This will have the form of
\fBnox\-<os\-name>\-test\-pkgs\-onedir\-<arch>\fP\&. The amd64 Ubuntu 20.04 nox
artifact may look like \fBnox\-ubuntu\-20.04\-test\-pkgs\-onedir\-x86_64\fP\&.
.UNINDENT
.UNINDENT
.IP 2. 3
Place the artifacts in the correct location:
.INDENT 3.0
.INDENT 3.5
Unzip the packages and place them in \fB<repo\-root>/artifacts/pkg/\fP\&.
.sp
You must unzip and untar the onedir packages and place them in
\fB<repo\-root>/artifacts/\fP\&. Windows onedir requires an additional unzip
action. If you set it up correctly, the \fB<repo\-root>/artifacts/salt\fP
directory then contains the uncompressed onedir files.
.sp
Additionally, decompress the \fBnox\fP artifact and place it under
\fB<repo\-root>/.nox/\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Running the tests
.sp
You can run the test suite run if all the artifacts are in the correct location.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
You need root access to run the test artifacts. Run all nox commands at the
root of the salt repo and as the root user.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 1. 3
Install \fBnox\fP:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install nox
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 2. 3
Run the install tests:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e test\-pkgs\-onedir \-\- install
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP 3. 3
Run the upgrade or downgrade tests:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e test\-pkgs\-onedir \-\- upgrade \-\-prev\-version <previous\-version>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can run the downgrade tests in the same way, replacing \fBupgrade\fP with
\fBdowngrade\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you are testing upgrades or downgrades and classic packages are
available for your system, replace \fBupgrade\fP or
\fBdowngrade\fP with \fBupgrade\-classic\fP or \fBdowngrade\-classic\fP
respectively to test against those versions.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SH COMMAND LINE REFERENCE
.SS salt\-api
.SS \fBsalt\-api\fP
.sp
Start interfaces used to remotely connect to the salt master
.SS Synopsis
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-api
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Description
.sp
The Salt API system manages network api connectors for the Salt Master
.SS Options
.INDENT 0.0
.TP
.B \-\-version
Print the version of Salt that is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies and version number, and then exit
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
Show the help message and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory. This directory contains
the configuration files for Salt master and minions. The default location
on most systems is \fB/etc/salt\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-daemon
Run the salt\-api as a daemon
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pid\-file=PIDFILE
Specify the location of the pidfile. Default: /var/run/salt\-api.pid
.UNINDENT
.SS Logging Options
.sp
Logging options which override any settings defined on the configuration files.
.INDENT 0.0
.TP
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
Console logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file=LOG_FILE
Log file path. Default: /var/log/salt/api\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.SS See also
.sp
\fBsalt\-api(7)\fP
\fBsalt(7)\fP
\fBsalt\-master(1)\fP
.SS salt\-call
.SS \fBsalt\-call\fP
.SS Synopsis
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call [options]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Description
.sp
The salt\-call command is used to run module functions locally on a minion
instead of executing them from the master. Salt\-call is used to run a
\fI\%Standalone Minion\fP, and was originally
created for \fI\%troubleshooting\fP\&.
.sp
The Salt Master is contacted to retrieve state files and other resources
during execution unless the \fB\-\-local\fP option is specified.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBsalt\-call\fP commands execute from the current user\(aqs shell
context, while \fBsalt\fP commands execute from the system\(aqs default context.
.UNINDENT
.UNINDENT
.SS Options
.INDENT 0.0
.TP
.B \-\-version
Print the version of Salt that is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies and version number, and then exit
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
Show the help message and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory. This directory contains
the configuration files for Salt master and minions. The default location
on most systems is \fB/etc/salt\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hard\-crash
Raise any original exception rather than exiting gracefully Default: False
.UNINDENT
.INDENT 0.0
.TP
.B \-g, \-\-grains
Return the information generated by the Salt grains
.UNINDENT
.INDENT 0.0
.TP
.B \-m MODULE_DIRS, \-\-module\-dirs=MODULE_DIRS
Specify an additional directory to pull modules from.  Multiple directories
can be provided by passing \-m /\-\-module\-dirs multiple times.
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-doc, \-\-documentation
Return the documentation for the specified module or for all modules if
none are specified
.UNINDENT
.INDENT 0.0
.TP
.B \-\-master=MASTER
Specify the master to use. The minion must be authenticated with the
master. If this option is omitted, the master options from the minion
config will be used. If multi masters are set up the first listed master
that responds will be used.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-return RETURNER
Set salt\-call to pass the return data to one or many returner interfaces.
To use many returner interfaces specify a comma delimited list of
returners.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-local
Run salt\-call locally, as if there was no master running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-file\-root=FILE_ROOT
Set this directory as the base file root.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pillar\-root=PILLAR_ROOT
Set this directory as the base pillar root.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-retcode\-passthrough
Exit with the salt call retcode and not the salt binary retcode
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-return\-event
Do not send the return event back to master.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-metadata
Print out the execution metadata as well as the return. This will print out
the outputter data, the return code, etc.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-id=ID
Specify the minion id to use. If this option is omitted, the id option from
the minion config will be used.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-skip\-grains
Do not load grains.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-refresh\-grains\-cache
Force a refresh of the grains cache
.UNINDENT
.SS Logging Options
.sp
Logging options which override any settings defined on the configuration files.
.INDENT 0.0
.TP
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
Console logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file=LOG_FILE
Log file path. Default: /var/log/salt/minion\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.SS Output Options
.INDENT 0.0
.TP
.B \-\-out
Pass in an alternative outputter to display the return of data. This
outputter can be any of the available outputters:
.INDENT 7.0
.INDENT 3.5
\fBhighstate\fP, \fBjson\fP, \fBkey\fP, \fBoverstatestage\fP, \fBpprint\fP, \fBraw\fP, \fBtxt\fP, \fByaml\fP, and \fI\%many others\fP\&.
.UNINDENT
.UNINDENT
.sp
Some outputters are formatted only for data returned from specific functions.
If an outputter is used that does not support the data passed into it, then
Salt will fall back on the \fBpprint\fP outputter and display the return data
using the Python \fBpprint\fP standard library module.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-indent OUTPUT_INDENT, \-\-output\-indent OUTPUT_INDENT
Print the output indented by the provided value in spaces. Negative values
disable indentation. Only applicable in outputters that support
indentation.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-file=OUTPUT_FILE, \-\-output\-file=OUTPUT_FILE
Write the output to the specified file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-file\-append, \-\-output\-file\-append
Append the output to the specified file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-color
Disable all colored output
.UNINDENT
.INDENT 0.0
.TP
.B \-\-force\-color
Force colored output
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using colored output the color codes are as follows:
.sp
\fBgreen\fP denotes success, \fBred\fP denotes failure, \fBblue\fP denotes
changes and success and \fByellow\fP denotes a expected future change in configuration.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-state\-output=STATE_OUTPUT, \-\-state_output=STATE_OUTPUT
Override the configured state_output value for minion
output. One of \(aqfull\(aq, \(aqterse\(aq, \(aqmixed\(aq, \(aqchanges\(aq or
\(aqfilter\(aq. Default: \(aqnone\(aq.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-state\-verbose=STATE_VERBOSE, \-\-state_verbose=STATE_VERBOSE
Override the configured state_verbose value for minion
output. Set to True or False. Default: none.
.UNINDENT
.SS See also
.sp
\fBsalt(1)\fP
\fBsalt\-master(1)\fP
\fBsalt\-minion(1)\fP
.SS salt
.SS \fBsalt\fP
.SS Synopsis
.INDENT 0.0
.INDENT 3.5
salt \(aq*\(aq [ options ] sys.doc
.sp
salt \-E \(aq.*\(aq [ options ] sys.doc cmd
.sp
salt \-G \(aqos:Arch.*\(aq [ options ] test.version
.sp
salt \-C \fI\%\(aqG@os\fP:Arch.* and webserv* or \fI\%G@kernel\fP:FreeBSD\(aq [ options ] test.version
.UNINDENT
.UNINDENT
.SS Description
.sp
Salt allows for commands to be executed across a swath of remote systems in
parallel. This means that remote systems can be both controlled and queried
with ease.
.SS Options
.INDENT 0.0
.TP
.B \-\-version
Print the version of Salt that is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies and version number, and then exit
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
Show the help message and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory. This directory contains
the configuration files for Salt master and minions. The default location
on most systems is \fB/etc/salt\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-t TIMEOUT, \-\-timeout=TIMEOUT
The timeout in seconds to wait for replies from the Salt minions. The
timeout number specifies how long the command line client will wait to
query the minions and check on running jobs. Default: 5
.UNINDENT
.INDENT 0.0
.TP
.B \-s, \-\-static
By default as of version 0.9.8 the salt command returns data to the
console as it is received from minions, but previous releases would return
data only after all data was received. Use the static option to only return
the data with a hard timeout and after all minions have returned.
Without the static option, you will get a separate JSON string per minion
which makes JSON output invalid as a whole.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-async
Instead of waiting for the job to run on minions only print the job id of
the started execution and complete.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-subset=SUBSET
Execute the routine on a random subset of the targeted minions.  The
minions will be verified that they have the named function before
executing. The SUBSET argument is the count of the minions to target.
.UNINDENT
.INDENT 0.0
.TP
.B \-v VERBOSE, \-\-verbose
Turn on verbosity for the salt call, this will cause the salt command to
print out extra data like the job id.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hide\-timeout
Instead of showing the return data for all minions. This option
prints only the online minions which could be reached.
.UNINDENT
.INDENT 0.0
.TP
.B \-b BATCH, \-\-batch\-size=BATCH
Instead of executing on all targeted minions at once, execute on a
progressive set of minions. This option takes an argument in the form of
an explicit number of minions to execute at once, or a percentage of
minions to execute on.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-batch\-wait=BATCH_WAIT
Wait the specified time in seconds after each job is done before
freeing the slot in the batch of the next one.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-batch\-safe\-limit=BATCH_SAFE_LIMIT
Execute the salt job in batch mode if the job would have executed
on at least this many minions.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-batch\-safe\-size=BATCH_SAFE_SIZE
Batch size to use for batch jobs created by \-\-batch\-safe\-limit.
.UNINDENT
.INDENT 0.0
.TP
.B \-a EAUTH, \-\-auth=EAUTH
Pass in an external authentication medium to validate against. The
credentials will be prompted for. The options are \fIauto\fP,
\fIkeystone\fP, \fIldap\fP, and \fIpam\fP\&. Can be used with the \-T
option.
.UNINDENT
.INDENT 0.0
.TP
.B \-T, \-\-make\-token
Used in conjunction with the \-a option. This creates a token that allows
for the authenticated user to send commands without needing to
re\-authenticate.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-return=RETURNER
Choose an alternative returner to call on the minion, if an
alternative returner is used then the return will not come back to
the command line but will be sent to the specified return system.
The options are \fIcarbon\fP, \fIcassandra\fP, \fIcouchbase\fP, \fIcouchdb\fP,
\fIelasticsearch\fP, \fIetcd\fP, \fIhipchat\fP, \fIlocal\fP, \fIlocal_cache\fP,
\fImemcache\fP, \fImongo\fP, \fImysql\fP, \fIodbc\fP, \fIpostgres\fP, \fIredis\fP,
\fIsentry\fP, \fIslack\fP, \fIsms\fP, \fIsmtp\fP, \fIsqlite3\fP, \fIsyslog\fP, and \fIxmpp\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-doc, \-\-documentation
Return the documentation for the module functions available on the minions
.UNINDENT
.INDENT 0.0
.TP
.B \-\-args\-separator=ARGS_SEPARATOR
Set the special argument used as a delimiter between command arguments of
compound commands. This is useful when one wants to pass commas as
arguments to some of the commands in a compound command.
.UNINDENT
.SS Logging Options
.sp
Logging options which override any settings defined on the configuration files.
.INDENT 0.0
.TP
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
Console logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file=LOG_FILE
Log file path. Default: /var/log/salt/master\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.SS Target Selection
.sp
The default matching that Salt utilizes is shell\-style globbing around the
minion id. See \fI\%https://docs.python.org/3/library/fnmatch.html#module\-fnmatch\fP\&.
.INDENT 0.0
.TP
.B \-E, \-\-pcre
The target expression will be interpreted as a PCRE regular expression
rather than a shell glob.
.UNINDENT
.INDENT 0.0
.TP
.B \-L, \-\-list
The target expression will be interpreted as a comma\-delimited list;
example: server1.foo.bar,server2.foo.bar,example7.quo.qux
.UNINDENT
.INDENT 0.0
.TP
.B \-G, \-\-grain
The target expression matches values returned by the Salt grains system on
the minions. The target expression is in the format of \(aq<grain value>:<glob
expression>\(aq; example: \(aqos:Arch*\(aq
.sp
This was changed in version 0.9.8 to accept glob expressions instead of
regular expression. To use regular expression matching with grains, use
the \-\-grain\-pcre option.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-grain\-pcre
The target expression matches values returned by the Salt grains system on
the minions. The target expression is in the format of \(aq<grain value>:<
regular expression>\(aq; example: \(aqos:Arch.*\(aq
.UNINDENT
.INDENT 0.0
.TP
.B \-N, \-\-nodegroup
Use a predefined compound target defined in the Salt master configuration
file.
.UNINDENT
.INDENT 0.0
.TP
.B \-R, \-\-range
Instead of using shell globs to evaluate the target, use a range expression
to identify targets. Range expressions look like %cluster.
.sp
Using the Range option requires that a range server is set up and the
location of the range server is referenced in the master configuration
file.
.UNINDENT
.INDENT 0.0
.TP
.B \-C, \-\-compound
Utilize many target definitions to make the call very granular. This option
takes a group of targets separated by \fBand\fP or \fBor\fP\&. The default matcher is a
glob as usual. If something other than a glob is used, preface it with the
letter denoting the type; example: \(aqwebserv* and \fI\%G@os\fP:Debian or \fI\%E@db*\fP\(aq
Make sure that the compound target is encapsulated in quotes.
.UNINDENT
.INDENT 0.0
.TP
.B \-I, \-\-pillar
Instead of using shell globs to evaluate the target, use a pillar value to
identify targets. The syntax for the target is the pillar key followed by
a glob expression: \(dqrole:production*\(dq
.UNINDENT
.INDENT 0.0
.TP
.B \-S, \-\-ipcidr
Match based on Subnet (CIDR notation) or IPv4 address.
.UNINDENT
.SS Output Options
.INDENT 0.0
.TP
.B \-\-out
Pass in an alternative outputter to display the return of data. This
outputter can be any of the available outputters:
.INDENT 7.0
.INDENT 3.5
\fBhighstate\fP, \fBjson\fP, \fBkey\fP, \fBoverstatestage\fP, \fBpprint\fP, \fBraw\fP, \fBtxt\fP, \fByaml\fP, and \fI\%many others\fP\&.
.UNINDENT
.UNINDENT
.sp
Some outputters are formatted only for data returned from specific functions.
If an outputter is used that does not support the data passed into it, then
Salt will fall back on the \fBpprint\fP outputter and display the return data
using the Python \fBpprint\fP standard library module.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-indent OUTPUT_INDENT, \-\-output\-indent OUTPUT_INDENT
Print the output indented by the provided value in spaces. Negative values
disable indentation. Only applicable in outputters that support
indentation.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-file=OUTPUT_FILE, \-\-output\-file=OUTPUT_FILE
Write the output to the specified file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-file\-append, \-\-output\-file\-append
Append the output to the specified file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-color
Disable all colored output
.UNINDENT
.INDENT 0.0
.TP
.B \-\-force\-color
Force colored output
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using colored output the color codes are as follows:
.sp
\fBgreen\fP denotes success, \fBred\fP denotes failure, \fBblue\fP denotes
changes and success and \fByellow\fP denotes a expected future change in configuration.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-state\-output=STATE_OUTPUT, \-\-state_output=STATE_OUTPUT
Override the configured state_output value for minion
output. One of \(aqfull\(aq, \(aqterse\(aq, \(aqmixed\(aq, \(aqchanges\(aq or
\(aqfilter\(aq. Default: \(aqnone\(aq.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-state\-verbose=STATE_VERBOSE, \-\-state_verbose=STATE_VERBOSE
Override the configured state_verbose value for minion
output. Set to True or False. Default: none.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If using \fB\-\-out=json\fP, you will probably want \fB\-\-static\fP as well.
Without the static option, you will get a separate JSON string per minion
which makes JSON output invalid as a whole.
This is due to using an iterative outputter. So if you want to feed it
to a JSON parser, use \fB\-\-static\fP as well.
.UNINDENT
.UNINDENT
.SS See also
.sp
\fBsalt(7)\fP
\fBsalt\-master(1)\fP
\fBsalt\-minion(1)\fP
.SS salt\-cloud
.SS salt\-cp
.SS \fBsalt\-cp\fP
.sp
Copy a file or files to one or more minions
.SS Synopsis
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cp \(aq*\(aq [ options ] SOURCE [SOURCE2 SOURCE3 ...] DEST

salt\-cp \-E \(aq.*\(aq [ options ] SOURCE [SOURCE2 SOURCE3 ...] DEST

salt\-cp \-G \(aqos:Arch.*\(aq [ options ] SOURCE [SOURCE2 SOURCE3 ...] DEST
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Description
.sp
salt\-cp copies files from the master to all of the Salt minions matched by the
specified target expression.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
salt\-cp uses Salt\(aqs publishing mechanism. This means the privacy of the
contents of the file on the wire is completely dependent upon the transport
in use. In addition, if the master or minion is running with debug logging,
the contents of the file will be logged to disk.
.sp
In addition, this tool is less efficient than the Salt fileserver when
copying larger files. It is recommended to instead use
\fI\%cp.get_file\fP to copy larger files to
minions. However, this requires the file to be located within one of the
fileserver directories.
.UNINDENT
.UNINDENT
.sp
Changed in version 2016.3.7,2016.11.6,2017.7.0: Compression support added, disable with \fB\-n\fP\&. Also, if the destination
path ends in a path separator (i.e. \fB/\fP,  or \fB\e\fP on Windows, the
desitination will be assumed to be a directory. Finally, recursion is now
supported, allowing for entire directories to be copied.

.sp
Changed in version 2016.11.7,2017.7.2: Reverted back to the old copy mode to preserve backward compatibility. The
new functionality added in 2016.6.6 and 2017.7.0 is now available using the
\fB\-C\fP or \fB\-\-chunked\fP CLI arguments. Note that compression, recursive
copying, and support for copying large files is only available in chunked
mode.

.SS Options
.INDENT 0.0
.TP
.B \-\-version
Print the version of Salt that is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies and version number, and then exit
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
Show the help message and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory. This directory contains
the configuration files for Salt master and minions. The default location
on most systems is \fB/etc/salt\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-t TIMEOUT, \-\-timeout=TIMEOUT
The timeout in seconds to wait for replies from the Salt minions. The
timeout number specifies how long the command line client will wait to
query the minions and check on running jobs. Default: 5
.UNINDENT
.SS Logging Options
.sp
Logging options which override any settings defined on the configuration files.
.INDENT 0.0
.TP
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
Console logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file=LOG_FILE
Log file path. Default: /var/log/salt/master\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.SS Target Selection
.sp
The default matching that Salt utilizes is shell\-style globbing around the
minion id. See \fI\%https://docs.python.org/3/library/fnmatch.html#module\-fnmatch\fP\&.
.INDENT 0.0
.TP
.B \-E, \-\-pcre
The target expression will be interpreted as a PCRE regular expression
rather than a shell glob.
.UNINDENT
.INDENT 0.0
.TP
.B \-L, \-\-list
The target expression will be interpreted as a comma\-delimited list;
example: server1.foo.bar,server2.foo.bar,example7.quo.qux
.UNINDENT
.INDENT 0.0
.TP
.B \-G, \-\-grain
The target expression matches values returned by the Salt grains system on
the minions. The target expression is in the format of \(aq<grain value>:<glob
expression>\(aq; example: \(aqos:Arch*\(aq
.sp
This was changed in version 0.9.8 to accept glob expressions instead of
regular expression. To use regular expression matching with grains, use
the \-\-grain\-pcre option.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-grain\-pcre
The target expression matches values returned by the Salt grains system on
the minions. The target expression is in the format of \(aq<grain value>:<
regular expression>\(aq; example: \(aqos:Arch.*\(aq
.UNINDENT
.INDENT 0.0
.TP
.B \-N, \-\-nodegroup
Use a predefined compound target defined in the Salt master configuration
file.
.UNINDENT
.INDENT 0.0
.TP
.B \-R, \-\-range
Instead of using shell globs to evaluate the target, use a range expression
to identify targets. Range expressions look like %cluster.
.sp
Using the Range option requires that a range server is set up and the
location of the range server is referenced in the master configuration
file.
.UNINDENT
.INDENT 0.0
.TP
.B \-C, \-\-chunked
Use new chunked mode to copy files. This mode supports large files, recursive
directories copying and compression.
.sp
New in version 2016.11.7,2017.7.2.

.UNINDENT
.INDENT 0.0
.TP
.B \-n, \-\-no\-compression
Disable gzip compression in chunked mode.
.sp
New in version 2016.3.7,2016.11.6,2017.7.0.

.UNINDENT
.SS See also
.sp
\fBsalt(1)\fP
\fBsalt\-master(1)\fP
\fBsalt\-minion(1)\fP
.SS salt\-extend
.SS \fBsalt\-extend\fP
.sp
A utilty to generate extensions to the Salt source\-code. This is used for :
.INDENT 0.0
.IP \(bu 2
Adding new execution modules, state modules
.IP \(bu 2
Adding unit tests to existing modules
.IP \(bu 2
Adding integration tests to existing modules
.UNINDENT
.SS Synopsis
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-extend \-\-help
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Description
.sp
\fBsalt\-extend\fP is a templating tool for extending SaltStack. If you\(aqre looking to add a module to
SaltStack, then the \fBsalt\-extend\fP utility can guide you through the process.
.sp
You can use Salt Extend to quickly create templated modules for adding new behaviours to some of the module subsystems within Salt.
.sp
Salt Extend takes a template directory and merges it into a SaltStack source code directory.
.sp
\fISee also\fP: \fI\%Salt Extend\fP\&.
.SS Options
.INDENT 0.0
.TP
.B \-\-extension, \-e
The extension type you want to develop, e.g. module, module_unit, state
.UNINDENT
.INDENT 0.0
.TP
.B \-\-salt\-directory, \-o
The path to the salt installation, defaults to .
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name, \-n
The module name for the new module
.UNINDENT
.INDENT 0.0
.TP
.B \-\-description, \-d
A description of the new extension
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-merge
Don\(aqt merge the new module into the Salt source directory specified by \fI\-\-salt\-directory\fP, save
to a temporary directory and print the directory path
.UNINDENT
.INDENT 0.0
.TP
.B \-\-debug
Print debug messages to stdout
.UNINDENT
.SS See also
.sp
\fBsalt\-api(1)\fP
\fBsalt\-call(1)\fP
\fBsalt\-cloud(1)\fP
\fBsalt\-cp(1)\fP
\fBsalt\-key(1)\fP
\fBsalt\-main(1)\fP
\fBsalt\-master(1)\fP
\fBsalt\-minion(1)\fP
\fBsalt\-run(1)\fP
\fBsalt\-ssh(1)\fP
\fBsalt\-syndic(1)\fP
.SS salt\-key
.SS \fBsalt\-key\fP
.SS Synopsis
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key [ options ]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Description
.sp
Salt\-key executes simple management of Salt server public keys used for
authentication.
.sp
On initial connection, a Salt minion sends its public key to the Salt
master. This key must be accepted using the \fBsalt\-key\fP command on the
Salt master.
.sp
Salt minion keys can be in one of the following states:
.INDENT 0.0
.IP \(bu 2
\fBunaccepted\fP: key is waiting to be accepted.
.IP \(bu 2
\fBaccepted\fP: key was accepted and the minion can communicate with the Salt
master.
.IP \(bu 2
\fBrejected\fP: key was rejected using the \fBsalt\-key\fP command. In
this state the minion does not receive any communication from the Salt
master.
.IP \(bu 2
\fBdenied\fP: key was rejected automatically by the Salt master.
This occurs when a minion has a duplicate ID, or when a minion was rebuilt or
had new keys generated and the previous key was not deleted from the Salt
master. In this state the minion does not receive any communication from the
Salt master.
.UNINDENT
.sp
To change the state of a minion key, use \fB\-d\fP to delete the key and then
accept or reject the key.
.SS Options
.INDENT 0.0
.TP
.B \-\-version
Print the version of Salt that is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies and version number, and then exit
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
Show the help message and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory. This directory contains
the configuration files for Salt master and minions. The default location
on most systems is \fB/etc/salt\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-u USER, \-\-user=USER
Specify user to run salt\-key
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hard\-crash
Raise any original exception rather than exiting gracefully. Default is
False.
.UNINDENT
.INDENT 0.0
.TP
.B \-q, \-\-quiet
Suppress output
.UNINDENT
.INDENT 0.0
.TP
.B \-y, \-\-yes
Answer \(aqYes\(aq to all questions presented, defaults to False
.UNINDENT
.INDENT 0.0
.TP
.B \-\-rotate\-aes\-key=ROTATE_AES_KEY
Setting this to False prevents the master from refreshing the key session
when keys are deleted or rejected, this lowers the security of the key
deletion/rejection operation. Default is True.
.UNINDENT
.SS Logging Options
.sp
Logging options which override any settings defined on the configuration files.
.INDENT 0.0
.TP
.B \-\-log\-file=LOG_FILE
Log file path. Default: /var/log/salt/minion\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.SS Output Options
.INDENT 0.0
.TP
.B \-\-out
Pass in an alternative outputter to display the return of data. This
outputter can be any of the available outputters:
.INDENT 7.0
.INDENT 3.5
\fBhighstate\fP, \fBjson\fP, \fBkey\fP, \fBoverstatestage\fP, \fBpprint\fP, \fBraw\fP, \fBtxt\fP, \fByaml\fP, and \fI\%many others\fP\&.
.UNINDENT
.UNINDENT
.sp
Some outputters are formatted only for data returned from specific functions.
If an outputter is used that does not support the data passed into it, then
Salt will fall back on the \fBpprint\fP outputter and display the return data
using the Python \fBpprint\fP standard library module.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-indent OUTPUT_INDENT, \-\-output\-indent OUTPUT_INDENT
Print the output indented by the provided value in spaces. Negative values
disable indentation. Only applicable in outputters that support
indentation.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-file=OUTPUT_FILE, \-\-output\-file=OUTPUT_FILE
Write the output to the specified file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-file\-append, \-\-output\-file\-append
Append the output to the specified file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-color
Disable all colored output
.UNINDENT
.INDENT 0.0
.TP
.B \-\-force\-color
Force colored output
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using colored output the color codes are as follows:
.sp
\fBgreen\fP denotes success, \fBred\fP denotes failure, \fBblue\fP denotes
changes and success and \fByellow\fP denotes a expected future change in configuration.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-state\-output=STATE_OUTPUT, \-\-state_output=STATE_OUTPUT
Override the configured state_output value for minion
output. One of \(aqfull\(aq, \(aqterse\(aq, \(aqmixed\(aq, \(aqchanges\(aq or
\(aqfilter\(aq. Default: \(aqnone\(aq.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-state\-verbose=STATE_VERBOSE, \-\-state_verbose=STATE_VERBOSE
Override the configured state_verbose value for minion
output. Set to True or False. Default: none.
.UNINDENT
.SS Actions
.INDENT 0.0
.TP
.B \-l ARG, \-\-list=ARG
List the public keys. The args \fBpre\fP, \fBun\fP, and \fBunaccepted\fP will
list unaccepted/unsigned keys. \fBacc\fP or \fBaccepted\fP will list
accepted/signed keys. \fBrej\fP or \fBrejected\fP will list rejected keys.
Finally, \fBall\fP will list all keys.
.UNINDENT
.INDENT 0.0
.TP
.B \-L, \-\-list\-all
List all public keys. (Deprecated: use \fB\-\-list all\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-a ACCEPT, \-\-accept=ACCEPT
Accept the specified public key (use \-\-include\-all to match rejected keys
in addition to pending keys). Globs are supported.
.UNINDENT
.INDENT 0.0
.TP
.B \-A, \-\-accept\-all
Accepts all pending keys.
.UNINDENT
.INDENT 0.0
.TP
.B \-r REJECT, \-\-reject=REJECT
Reject the specified public key (use \-\-include\-all to match accepted keys
in addition to pending keys). Globs are supported.
.UNINDENT
.INDENT 0.0
.TP
.B \-R, \-\-reject\-all
Rejects all pending keys.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-include\-all
Include non\-pending keys when accepting/rejecting.
.UNINDENT
.INDENT 0.0
.TP
.B \-p PRINT, \-\-print=PRINT
Print the specified public key.
.UNINDENT
.INDENT 0.0
.TP
.B \-P, \-\-print\-all
Print all public keys
.UNINDENT
.INDENT 0.0
.TP
.B \-d DELETE, \-\-delete=DELETE
Delete the specified key. Globs are supported.
.UNINDENT
.INDENT 0.0
.TP
.B \-D, \-\-delete\-all
Delete all keys.
.UNINDENT
.INDENT 0.0
.TP
.B \-f FINGER, \-\-finger=FINGER
Print the specified key\(aqs fingerprint.
.UNINDENT
.INDENT 0.0
.TP
.B \-F, \-\-finger\-all
Print all keys\(aq fingerprints.
.UNINDENT
.SS Key Generation Options
.INDENT 0.0
.TP
.B \-\-gen\-keys=GEN_KEYS
Set a name to generate a keypair for use with salt
.UNINDENT
.INDENT 0.0
.TP
.B \-\-gen\-keys\-dir=GEN_KEYS_DIR
Set the directory to save the generated keypair.  Only works
with \(aqgen_keys_dir\(aq option; default is the current directory.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-keysize=KEYSIZE
Set the keysize for the generated key, only works with
the \(aq\-\-gen\-keys\(aq option, the key size must be 2048 or
higher, otherwise it will be rounded up to 2048. The
default is 2048.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-gen\-signature
Create a signature file of the master\(aqs public\-key named
master_pubkey_signature. The signature can be sent to a minion in the
master\(aqs auth\-reply and enables the minion to verify the master\(aqs public\-key
cryptographically. This requires a new signing\-key\-pair which can be
auto\-created with the \-\-auto\-create parameter.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-priv=PRIV
The private\-key file to create a signature with
.UNINDENT
.INDENT 0.0
.TP
.B \-\-signature\-path=SIGNATURE_PATH
The path where the signature file should be written
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pub=PUB
The public\-key file to create a signature for
.UNINDENT
.INDENT 0.0
.TP
.B \-\-auto\-create
Auto\-create a signing key\-pair if it does not yet exist
.UNINDENT
.SS See also
.sp
\fBsalt(7)\fP
\fBsalt\-master(1)\fP
\fBsalt\-minion(1)\fP
.SS salt\-master
.SS \fBsalt\-master\fP
.sp
The Salt master daemon, used to control the Salt minions
.SS Synopsis
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-master [ options ]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Description
.sp
The master daemon controls the Salt minions
.SS Options
.INDENT 0.0
.TP
.B \-\-version
Print the version of Salt that is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies and version number, and then exit
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
Show the help message and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory. This directory contains
the configuration files for Salt master and minions. The default location
on most systems is \fB/etc/salt\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-u USER, \-\-user=USER
Specify user to run salt\-master
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-daemon
Run salt\-master as a daemon
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pid\-file PIDFILE
Specify the location of the pidfile. Default: /var/run/salt\-master\&.pid
.UNINDENT
.SS Logging Options
.sp
Logging options which override any settings defined on the configuration files.
.INDENT 0.0
.TP
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
Console logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file=LOG_FILE
Log file path. Default: /var/log/salt/master\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.SS See also
.sp
\fBsalt(1)\fP
\fBsalt(7)\fP
\fBsalt\-minion(1)\fP
.SS salt\-minion
.SS \fBsalt\-minion\fP
.sp
The Salt minion daemon, receives commands from a remote Salt master.
.SS Synopsis
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-minion [ options ]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Description
.sp
The Salt minion receives commands from the central Salt master and replies with
the results of said commands.
.SS Options
.INDENT 0.0
.TP
.B \-\-version
Print the version of Salt that is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies and version number, and then exit
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
Show the help message and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory. This directory contains
the configuration files for Salt master and minions. The default location
on most systems is \fB/etc/salt\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-u USER, \-\-user=USER
Specify user to run salt\-minion
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-daemon
Run salt\-minion as a daemon
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pid\-file PIDFILE
Specify the location of the pidfile. Default: /var/run/salt\-minion\&.pid
.UNINDENT
.SS Logging Options
.sp
Logging options which override any settings defined on the configuration files.
.INDENT 0.0
.TP
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
Console logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file=LOG_FILE
Log file path. Default: /var/log/salt/minion\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.SS See also
.sp
\fBsalt(1)\fP
\fBsalt(7)\fP
\fBsalt\-master(1)\fP
.SS salt\-proxy
.SS \fBsalt\-proxy\fP
.sp
Receives commands from a Salt master and proxies these commands to
devices that are unable to run a full minion.
.SS Synopsis
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy [ options ]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Description
.sp
The Salt proxy minion receives commands from a Salt master, transmits
appropriate commands to devices that are unable to run a minion, and replies
with the results of said commands.
.SS Options
.INDENT 0.0
.TP
.B \-\-proxyid
The minion id that this proxy will assume.  This is required.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-version
Print the version of Salt that is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies and version number, and then exit
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
Show the help message and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory. This directory
contains  the  configuration  files for Salt master and minions.
The default location on most systems is \fB/etc/salt\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-u USER, \-\-user=USER
Specify user to run salt\-proxy
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-daemon
Run salt\-proxy as a daemon
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pid\-file PIDFILE
Specify the location of the pidfile. Default: \fB/var/run/salt\-proxy\-<id>.pid\fP
.UNINDENT
.SS Logging Options
.sp
Logging options which override any settings defined on the configuration files.
.INDENT 0.0
.TP
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
Console logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file=LOG_FILE
Log file path. Default: /var/log/salt/minion\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.SS See also
.sp
\fBsalt(1)\fP
\fBsalt(7)\fP
\fBsalt\-master(1)\fP
\fBsalt\-minion(1)\fP
.SS salt\-run
.SS \fBsalt\-run\fP
.sp
Execute a Salt runner
.SS Synopsis
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run RUNNER
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Description
.sp
salt\-run is the frontend command for executing \fBSalt Runners\fP\&.
Salt runners are simple modules used to execute convenience functions on the
master
.SS Options
.INDENT 0.0
.TP
.B \-\-version
Print the version of Salt that is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies and version number, and then exit
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
Show the help message and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory. This directory contains
the configuration files for Salt master and minions. The default location
on most systems is \fB/etc/salt\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-t TIMEOUT, \-\-timeout=TIMEOUT
The timeout in seconds to wait for replies from the Salt minions. The
timeout number specifies how long the command line client will wait to
query the minions and check on running jobs. Default: 1
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hard\-crash
Raise any original exception rather than exiting gracefully. Default is
False.
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-doc, \-\-documentation
Display documentation for runners, pass a module or a runner to see
documentation on only that module/runner.
.UNINDENT
.SS Logging Options
.sp
Logging options which override any settings defined on the configuration files.
.INDENT 0.0
.TP
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
Console logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file=LOG_FILE
Log file path. Default: /var/log/salt/master\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.SS See also
.sp
\fBsalt(1)\fP
\fBsalt\-master(1)\fP
\fBsalt\-minion(1)\fP
.SS salt\-ssh
.SS \fBsalt\-ssh\fP
.SS Synopsis
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-ssh \(aq*\(aq [ options ] sys.doc

salt\-ssh \-E \(aq.*\(aq [ options ] sys.doc cmd
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Description
.sp
Salt SSH allows for salt routines to be executed using only SSH for transport
.SS Options
.INDENT 0.0
.TP
.B \-\-version
Print the version of Salt that is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies and version number, and then exit
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
Show the help message and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory. This directory contains
the configuration files for Salt master and minions. The default location
on most systems is \fB/etc/salt\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hard\-crash
Raise any original exception rather than exiting gracefully. Default: False.
.UNINDENT
.INDENT 0.0
.TP
.B \-r, \-\-raw, \-\-raw\-shell
Execute a raw shell command.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-roster
Define which roster system to use, this defines if a database backend,
scanner, or custom roster system is used. Default is the flat file roster.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-roster\-file
Define an alternative location for the default roster file location. The
default roster file is called \fBroster\fP and is found in the same directory
as the master config file.
.sp
New in version 2014.1.0.

.UNINDENT
.INDENT 0.0
.TP
.B \-\-refresh, \-\-refresh\-cache
Force a refresh of the master side data cache of the target\(aqs data. This
is needed if a target\(aqs grains have been changed and the auto refresh
timeframe has not been reached.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max\-procs
Set the number of concurrent minions to communicate with. This value
defines how many processes are opened up at a time to manage connections,
the more running process the faster communication should be, default
is 25.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-extra\-filerefs=EXTRA_FILEREFS
Pass in extra files to include in the state tarball.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-min\-extra\-modules=MIN_EXTRA_MODS
One or comma\-separated list of extra Python modulesto be included
into Minimal Salt.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-thin\-extra\-modules=THIN_EXTRA_MODS
One or comma\-separated list of extra Python modulesto  be included
into Thin Salt.
.UNINDENT
.INDENT 0.0
.TP
.B \-v, \-\-verbose
Turn on command verbosity, display jid.
.UNINDENT
.INDENT 0.0
.TP
.B \-s, \-\-static
Return the data from minions as a group after they all return.
.UNINDENT
.INDENT 0.0
.TP
.B \-w, \-\-wipe
Remove the deployment of the salt files when done executing.
.UNINDENT
.INDENT 0.0
.TP
.B \-W, \-\-rand\-thin\-dir
Select a random temp dir to deploy on the remote system. The dir
will be cleaned after the execution.
.UNINDENT
.INDENT 0.0
.TP
.B \-t, \-\-regen\-thin, \-\-thin
Trigger a thin tarball regeneration. This is needed if  custom
grains/modules/states have been added or updated.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-python2\-bin=PYTHON2_BIN
Path to a python2 binary which has salt installed.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-python3\-bin=PYTHON3_BIN
Path to a python3 binary which has salt installed.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-jid=JID
Pass a JID to be used instead of generating one.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pre\-flight
Run the ssh_pre_flight script defined in the roster.
By default this script will only run if the thin dir
does not exist on the target minion. This option will
force the script to run regardless of the thin dir
existing or not.
.UNINDENT
.SS Authentication Options
.INDENT 0.0
.TP
.B \-\-priv=SSH_PRIV
Specify the SSH private key file to be used for authentication.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-priv\-passwd=SSH_PRIV_PASSWD
Specify the SSH private key file\(aqs passphrase if need be.
.UNINDENT
.INDENT 0.0
.TP
.B \-i, \-\-ignore\-host\-keys
By default ssh host keys are honored and connections  will ask for
approval. Use this option to disable StrictHostKeyChecking.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-host\-keys
Fully ignores ssh host keys which by default are honored and connections
would ask for approval. Useful if the host key of a remote server has
changed and would still error with \-\-ignore\-host\-keys.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-user=SSH_USER
Set the default user to attempt to use when authenticating.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-passwd
Set the default password to attempt to use when authenticating.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-askpass
Interactively ask for the SSH password with no echo \- avoids password
in process args and stored in history.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-key\-deploy
Set this flag to attempt to deploy the authorized ssh key with all
minions. This combined with \-\-passwd can make initial deployment of keys
very fast and easy.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-identities\-only
Use the only authentication identity files configured in the ssh_config
files. See IdentitiesOnly flag in man ssh_config.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-sudo
Run command via sudo.
.UNINDENT
.SS Scan Roster Options
.INDENT 0.0
.TP
.B \-\-scan\-ports=SSH_SCAN_PORTS
Comma\-separated list of ports to scan in the scan roster.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-scan\-timeout=SSH_SCAN_TIMEOUT
Scanning socket timeout for the scan roster.
.UNINDENT
.SS Logging Options
.sp
Logging options which override any settings defined on the configuration files.
.INDENT 0.0
.TP
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
Console logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file=LOG_FILE
Log file path. Default: /var/log/salt/ssh\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.SS Target Selection
.sp
The default matching that Salt utilizes is shell\-style globbing around the
minion id. See \fI\%https://docs.python.org/3/library/fnmatch.html#module\-fnmatch\fP\&.
.INDENT 0.0
.TP
.B \-E, \-\-pcre
The target expression will be interpreted as a PCRE regular expression
rather than a shell glob.
.UNINDENT
.SS Output Options
.INDENT 0.0
.TP
.B \-\-out
Pass in an alternative outputter to display the return of data. This
outputter can be any of the available outputters:
.INDENT 7.0
.INDENT 3.5
\fBhighstate\fP, \fBjson\fP, \fBkey\fP, \fBoverstatestage\fP, \fBpprint\fP, \fBraw\fP, \fBtxt\fP, \fByaml\fP, and \fI\%many others\fP\&.
.UNINDENT
.UNINDENT
.sp
Some outputters are formatted only for data returned from specific functions.
If an outputter is used that does not support the data passed into it, then
Salt will fall back on the \fBpprint\fP outputter and display the return data
using the Python \fBpprint\fP standard library module.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-indent OUTPUT_INDENT, \-\-output\-indent OUTPUT_INDENT
Print the output indented by the provided value in spaces. Negative values
disable indentation. Only applicable in outputters that support
indentation.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-file=OUTPUT_FILE, \-\-output\-file=OUTPUT_FILE
Write the output to the specified file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-file\-append, \-\-output\-file\-append
Append the output to the specified file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-color
Disable all colored output
.UNINDENT
.INDENT 0.0
.TP
.B \-\-force\-color
Force colored output
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using colored output the color codes are as follows:
.sp
\fBgreen\fP denotes success, \fBred\fP denotes failure, \fBblue\fP denotes
changes and success and \fByellow\fP denotes a expected future change in configuration.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-state\-output=STATE_OUTPUT, \-\-state_output=STATE_OUTPUT
Override the configured state_output value for minion
output. One of \(aqfull\(aq, \(aqterse\(aq, \(aqmixed\(aq, \(aqchanges\(aq or
\(aqfilter\(aq. Default: \(aqnone\(aq.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-state\-verbose=STATE_VERBOSE, \-\-state_verbose=STATE_VERBOSE
Override the configured state_verbose value for minion
output. Set to True or False. Default: none.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If using \fB\-\-out=json\fP, you will probably want \fB\-\-static\fP as well.
Without the static option, you will get a separate JSON string per minion
which makes JSON output invalid as a whole.
This is due to using an iterative outputter. So if you want to feed it
to a JSON parser, use \fB\-\-static\fP as well.
.UNINDENT
.UNINDENT
.SS See also
.sp
\fBsalt(7)\fP
\fBsalt\-master(1)\fP
\fBsalt\-minion(1)\fP
.SS salt\-syndic
.SS \fBsalt\-syndic\fP
.sp
The Salt syndic daemon, a special minion that passes through commands from a
higher master
.SS Synopsis
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-syndic [ options ]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Description
.sp
The Salt syndic daemon, a special minion that passes through commands from a
higher master.
.SS Options
.INDENT 0.0
.TP
.B \-\-version
Print the version of Salt that is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies and version number, and then exit
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
Show the help message and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory. This directory contains
the configuration files for Salt master and minions. The default location
on most systems is \fB/etc/salt\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-u USER, \-\-user=USER
Specify user to run salt\-syndic
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-daemon
Run salt\-syndic as a daemon
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pid\-file PIDFILE
Specify the location of the pidfile. Default: /var/run/salt\-syndic\&.pid
.UNINDENT
.SS Logging Options
.sp
Logging options which override any settings defined on the configuration files.
.INDENT 0.0
.TP
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
Console logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file=LOG_FILE
Log file path. Default: /var/log/salt/master\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.SS See also
.sp
\fBsalt(1)\fP
\fBsalt\-master(1)\fP
\fBsalt\-minion(1)\fP
.SS spm
.SS \fBspm\fP
.sp
\fI\%Salt Package Manager\fP
.SS Synopsis
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
spm <command> [<argument>]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Description
.sp
spm is the frontend command for managing Salt packages. Packages normally only
include formulas, meaning a group of SLS files that install into the
\fBfile_roots\fP on the Salt Master, but Salt modules can also be installed.
.SS Options
.INDENT 0.0
.TP
.B \-y, \-\-assume\-yes
Assume \fByes\fP instead of prompting the other whether or not to proceed
with a particular command. Default is False.
.UNINDENT
.INDENT 0.0
.TP
.B \-f, \-\-force
When presented with a course of action that spm would normally refuse to
perform, that action will be performed anyway. This is often destructive,
and should be used with caution.
.UNINDENT
.SS Logging Options
.sp
Logging options which override any settings defined on the configuration files.
.INDENT 0.0
.TP
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
Console logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file=LOG_FILE
Log file path. Default: /var/log/salt/spm\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
\fBwarning\fP\&.
.UNINDENT
.SS Commands
.INDENT 0.0
.TP
.B update_repo
Connect to remote repositories locally configured on the system and download
their metadata.
.UNINDENT
.INDENT 0.0
.TP
.B install
Install a package from a configured SPM repository. Requires a package name.
.UNINDENT
.INDENT 0.0
.TP
.B remove
Remove an installed package from the system. Requires a package name.
.UNINDENT
.INDENT 0.0
.TP
.B info
List information about an installed package. Requires a package name.
.UNINDENT
.INDENT 0.0
.TP
.B files
List files belonging to an installed package. Requires a package name.
.UNINDENT
.INDENT 0.0
.TP
.B local
Perform one of the above options (except for remove) on a package file,
instead of on a package in a repository, or an installed package. Requires
a valid path to a local file on the system.
.UNINDENT
.INDENT 0.0
.TP
.B build
Build a package from a directory containing a FORMULA file. Requires a valid
path to a local directory on the system.
.UNINDENT
.INDENT 0.0
.TP
.B create_repo
Scan a directory for valid SPM package files and build an SPM\-METADATA file
in that directory which describes them.
.UNINDENT
.SS See also
.sp
\fBsalt(1)\fP
\fBsalt\-master(1)\fP
\fBsalt\-minion(1)\fP
.SH PILLARS
.sp
Salt includes a number of built\-in external pillars, listed at
\fI\%pillar modules\fP\&.
.sp
The below links contain documentation for the configuration options
.INDENT 0.0
.IP \(bu 2
\fI\%master\-side configuration\fP
.IP \(bu 2
\fI\%minion\-side configuration\fP
.UNINDENT
.sp
Note that some of same the configuration options from the master are present in
the minion configuration file, these are used in \fI\%masterless\fP mode.
.sp
The source for the built\-in Salt pillars can be found here:
\fI\%salt/pillar\fP
.SH MASTER TOPS
.sp
Salt includes a number of built\-in subsystems to generate top file data, they
are listed at
\fI\%master tops modules\fP\&.
.sp
The source for the built\-in Salt master tops can be found here:
\fI\%salt/tops\fP
.SH SALT MODULE REFERENCE
.sp
This section contains a list of the Python modules that are used to extend the various subsystems within Salt.
.SS auth modules
.TS
center;
|l|l|.
_
T{
\fI\%auto\fP
T}	T{
An \(dqAlways Approved\(dq eauth interface to test against, not intended for production use
T}
_
T{
\fI\%django\fP
T}	T{
Provide authentication using Django Web Framework
T}
_
T{
\fI\%file\fP
T}	T{
Provide authentication using local files
T}
_
T{
\fI\%keystone\fP
T}	T{
Provide authentication using OpenStack Keystone
T}
_
T{
\fI\%ldap\fP
T}	T{
Provide authentication using simple LDAP binds
T}
_
T{
\fI\%mysql\fP
T}	T{
Provide authentication using MySQL.
T}
_
T{
\fI\%pam\fP
T}	T{
Authenticate against PAM
T}
_
T{
\fI\%pki\fP
T}	T{
Authenticate via a PKI certificate.
T}
_
T{
\fI\%rest\fP
T}	T{
Provide authentication using a REST call
T}
_
T{
\fI\%sharedsecret\fP
T}	T{
Provide authentication using configured shared secret
T}
_
T{
\fI\%yubico\fP
T}	T{
Provide authentication using YubiKey.
T}
_
.TE
.SS salt.auth.auto
.sp
An \(dqAlways Approved\(dq eauth interface to test against, not intended for
production use
.INDENT 0.0
.TP
.B salt.auth.auto.auth(username, password)
Authenticate!
.UNINDENT
.SS salt.auth.django
.sp
Provide authentication using Django Web Framework
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
Django Web Framework
.UNINDENT
.UNINDENT
.sp
Django authentication depends on the presence of the django framework in the
\fBPYTHONPATH\fP, the Django project\(aqs \fBsettings.py\fP file being in the
\fBPYTHONPATH\fP and accessible via the \fBDJANGO_SETTINGS_MODULE\fP environment
variable.
.sp
Django auth can be defined like any other eauth module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  django:
    fred:
      \- .*
      \- \(aq@runner\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will authenticate Fred via Django and allow him to run any execution
module and all runners.
.sp
The authorization details can optionally be located inside the Django database.
The relevant entry in the \fBmodels.py\fP file would look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
class SaltExternalAuthModel(models.Model):
    user_fk = models.ForeignKey(User, on_delete=models.CASCADE)
    minion_or_fn_matcher = models.CharField(max_length=255)
    minion_fn = models.CharField(max_length=255)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fI\%external_auth\fP clause in the master config would then look
like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  django:
    ^model: <fully\-qualified reference to model class>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When a user attempts to authenticate via Django, Salt will import the package
indicated via the keyword \fB^model\fP\&.  That model must have the fields
indicated above, though the model DOES NOT have to be named
\(aqSaltExternalAuthModel\(aq.
.INDENT 0.0
.TP
.B salt.auth.django.acl(username)
.INDENT 7.0
.TP
.B Parameters
\fBusername\fP \-\- Username to filter for
.TP
.B Returns
Dictionary that can be slotted into the \fB__opts__\fP structure for
eauth that designates the user associated ACL
.UNINDENT
.sp
Database records such as:
.TS
center;
|l|l|l|.
_
T{
username
T}	T{
minion_or_fn_matcher
T}	T{
minion_fn
T}
_
T{
fred
T}	T{
T}	T{
test.ping
T}
_
T{
fred
T}	T{
server1
T}	T{
network.interfaces
T}
_
T{
fred
T}	T{
server1
T}	T{
raid.list
T}
_
T{
fred
T}	T{
server2
T}	T{
\&.*
T}
_
T{
guru
T}	T{
\&.*
T}	T{
T}
_
T{
smartadmin
T}	T{
server1
T}	T{
\&.*
T}
_
.TE
.sp
Should result in an eauth config such as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
fred:
  \- test.ping
  \- server1:
      \- network.interfaces
      \- raid.list
  \- server2:
      \- .*
guru:
  \- .*
smartadmin:
  \- server1:
    \- .*
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.django.auth(username, password)
Simple Django auth
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.django.is_connection_usable()
.UNINDENT
.SS salt.auth.file
.sp
Provide authentication using local files
.sp
New in version 2018.3.0.

.sp
The \fIfile\fP auth module allows simple authentication via local files. Different
filetypes are supported, including:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP 1. 3
Text files, with passwords in plaintext or hashed
.IP 2. 3
Apache\-style htpasswd files
.IP 3. 3
Apache\-style htdigest files
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBpython\-passlib\fP library is required when using a \fB^filetype\fP of
\fBhtpasswd\fP or \fBhtdigest\fP\&.
.UNINDENT
.UNINDENT
.sp
The simplest example is a plaintext file with usernames and passwords:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  file:
    ^filename: /etc/insecure\-user\-list.txt
    gene:
      \- .*
    dean:
      \- test.*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example the \fB/etc/insecure\-user\-list.txt\fP file would be formatted
as so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
dean:goneFishing
gene:OceanMan
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB^filename\fP is the only required parameter. Any parameter that begins with
a \fB^\fP is passed directly to the underlying file authentication function
via \fBkwargs\fP, with the leading \fB^\fP being stripped.
.sp
The text file option is configurable to work with legacy formats:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  file:
    ^filename: /etc/legacy_users.txt
    ^filetype: text
    ^hashtype: md5
    ^username_field: 2
    ^password_field: 3
    ^field_separator: \(aq|\(aq
    trey:
      \- .*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This would authenticate users against a file of the following format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
46|trey|16a0034f90b06bf3c5982ed8ac41aab4
555|mike|b6e02a4d2cb2a6ef0669e79be6fd02e4
2001|page|14fce21db306a43d3b680da1a527847a
8888|jon|c4e94ba906578ccf494d71f45795c6cb
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fI\%hashutil.digest\fP execution
function is used for comparing hashed passwords, so any algorithm
supported by that function will work.
.UNINDENT
.UNINDENT
.sp
There is also support for Apache\-style \fBhtpasswd\fP and \fBhtdigest\fP files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  file:
    ^filename: /var/www/html/.htusers
    ^filetype: htpasswd
    cory:
      \- .*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When using \fBhtdigest\fP the \fB^realm\fP must be set:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  file:
    ^filename: /var/www/html/.htdigest
    ^filetype: htdigest
    ^realm: MySecureRealm
    cory:
      \- .*
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.file.auth(username, password)
File based authentication
.INDENT 7.0
.TP
.B ^filename
The path to the file to use for authentication.
.TP
.B ^filetype
The type of file: \fBtext\fP, \fBhtpasswd\fP, \fBhtdigest\fP\&.
.sp
Default: \fBtext\fP
.TP
.B ^realm
The realm required by htdigest authentication.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The following parameters are only used with the \fBtext\fP filetype.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B ^hashtype
The digest format of the password. Can be \fBplaintext\fP or any digest
available via \fI\%hashutil.digest\fP\&.
.sp
Default: \fBplaintext\fP
.TP
.B ^field_separator
The character to use as a delimiter between fields in a text file.
.sp
Default: \fB:\fP
.TP
.B ^username_field
The numbered field in the text file that contains the username, with
numbering beginning at 1 (one).
.sp
Default: \fB1\fP
.TP
.B ^password_field
The numbered field in the text file that contains the password, with
numbering beginning at 1 (one).
.sp
Default: \fB2\fP
.UNINDENT
.UNINDENT
.SS salt.auth.keystone
.sp
Provide authentication using OpenStack Keystone
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
keystoneclient Python module
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.keystone.auth(username, password)
Try and authenticate
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.keystone.get_auth_url()
Try and get the URL from the config, else return localhost
.UNINDENT
.SS salt.auth.ldap
.sp
Provide authentication using simple LDAP binds
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
ldap Python module
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.ldap.auth(username, password)
Simple LDAP auth
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.ldap.groups(username, **kwargs)
Authenticate against an LDAP group
.sp
Behavior is highly dependent on if Active Directory is in use.
.sp
AD handles group membership very differently than OpenLDAP.
See the \fI\%External Authentication\fP documentation for a thorough
discussion of available parameters for customizing the search.
.sp
OpenLDAP allows you to search for all groups in the directory
and returns members of those groups.  Then we check against
the username entered.
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.ldap.process_acl(auth_list, opts=None)
Query LDAP, retrieve list of minion_ids from an OU or other search.
For each minion_id returned from the LDAP search, copy the perms
matchers into the auth dictionary
:param auth_list:
:param opts: __opts__ for when __opts__ is not injected
:return: Modified auth list.
.UNINDENT
.SS salt.auth.mysql
.sp
Provide authentication using MySQL.
.sp
When using MySQL as an authentication backend, you will need to create or
use an existing table that has a username and a password column.
.sp
To get started, create a simple table that holds just a username and
a password. The password field will hold a SHA256 checksum.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
CREATE TABLE \(gausers\(ga (
  \(gaid\(ga int(11) NOT NULL AUTO_INCREMENT,
  \(gausername\(ga varchar(25) DEFAULT NULL,
  \(gapassword\(ga varchar(70) DEFAULT NULL,
  PRIMARY KEY (\(gaid\(ga)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=latin1;
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To create a user within MySQL, execute the following statement.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
INSERT INTO users VALUES (NULL, \(aqdiana\(aq, SHA2(\(aqsecret\(aq, 256))
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql_auth:
  hostname: localhost
  database: SaltStack
  username: root
  password: letmein
  auth_sql: \(aqSELECT username FROM users WHERE username = \(dq{0}\(dq AND password = SHA2(\(dq{1}\(dq, 256)\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fIauth_sql\fP contains the SQL that will validate a user to ensure they are
correctly authenticated. This is where you can specify other SQL queries to
authenticate users.
.sp
Enable MySQL authentication.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  mysql:
    damian:
      \- test.*
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
MySQL\-python Python module
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.mysql.auth(username, password)
Authenticate using a MySQL user table
.UNINDENT
.SS salt.auth.pam
.sp
Authenticate against PAM
.sp
Provides an authenticate function that will allow the caller to authenticate
a user against the Pluggable Authentication Modules (PAM) on the system.
.sp
Implemented using ctypes, so no compilation is necessary.
.sp
There is one extra configuration option for pam.  The \fIpam_service\fP that is
authenticated against.  This defaults to \fIlogin\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
auth.pam.service: login
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Solaris\-like (SmartOS, OmniOS, ...) systems may need \fBauth.pam.service\fP set to \fBother\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
PAM authentication will not work for the \fBroot\fP user.
.sp
The Python interface to PAM does not support authenticating as \fBroot\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This module executes itself in a subprocess in order to user the system python
and pam libraries. We do this to avoid openssl version conflicts when
running under a salt onedir build.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.auth.pam.PamConv
Wrapper class for pam_conv structure
.INDENT 7.0
.TP
.B appdata_ptr
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B conv
Structure/Union member
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.auth.pam.PamHandle
Wrapper class for pam_handle_t
.INDENT 7.0
.TP
.B handle
Structure/Union member
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.auth.pam.PamMessage
Wrapper class for pam_message structure
.INDENT 7.0
.TP
.B msg
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B msg_style
Structure/Union member
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.auth.pam.PamResponse
Wrapper class for pam_response structure
.INDENT 7.0
.TP
.B resp
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B resp_retcode
Structure/Union member
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.pam.auth(username, password, **kwargs)
Authenticate via pam
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.pam.authenticate(username, password)
Returns True if the given username and password authenticate for the
given service.  Returns False otherwise
.sp
\fBusername\fP: the username to authenticate
.sp
\fBpassword\fP: the password in plain text
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.pam.groups(username, *args, **kwargs)
Retrieve groups for a given user for this auth provider
.sp
Uses system groups
.UNINDENT
.SS salt.auth.pki
.sp
Authenticate via a PKI certificate.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This module is Experimental and should be used with caution
.UNINDENT
.UNINDENT
.sp
Provides an authenticate function that will allow the caller to authenticate
a user via their public cert against a pre\-defined Certificate Authority.
.sp
TODO: Add a \(aqca_dir\(aq option to configure a directory of CA files, a la Apache.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
pyOpenSSL module
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.pki.auth(username, password, **kwargs)
Returns True if the given user cert (password is the cert contents)
was issued by the CA and if cert\(aqs Common Name is equal to username.
.sp
Returns False otherwise.
.INDENT 7.0
.TP
.B \fBusername\fP: we need it to run the auth function from CLI/API;
it should be in master config auth/acl
.TP
.B \fBpassword\fP: contents of user certificate (pem\-encoded user public key);
why \(dqpassword\(dq? For CLI, it\(aqs the only available name
.UNINDENT
.sp
Configure the CA cert in the master config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  pki:
    ca_file: /etc/pki/tls/ca_certs/trusted\-ca.crt
    your_user:
      \- .*
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.auth.rest
.sp
Provide authentication using a REST call
.sp
REST auth can be defined like any other eauth module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  rest:
    ^url: https://url/for/rest/call
    fred:
      \- .*
      \- \(aq@runner\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If there are entries underneath the ^url entry then they are merged with any responses
from the REST call.  In the above example, assuming the REST call does not return
any additional ACLs, this will authenticate Fred via a REST call and allow him to
run any execution module and all runners.
.sp
The REST call should return a JSON array that maps to a regular eauth YAML
structure of a user as above.
.INDENT 0.0
.TP
.B salt.auth.rest.acl(username, **kwargs)
REST authorization
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.rest.auth(username, password)
REST authentication
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.rest.fetch(username, password)
Call the rest authentication endpoint
.UNINDENT
.SS salt.auth.sharedsecret
.sp
Provide authentication using configured shared secret
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  sharedsecret:
    fred:
      \- .*
      \- \(aq@jobs\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The shared secret should be added to the master configuration, for
example in /etc/salt/master.d/sharedsecret.conf (make sure that file
is only readable by the user running the master):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sharedsecret: OIUHF_CHANGE_THIS_12h88
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This auth module should be used with caution. It was initially
designed to work with a frontal that takes care of authentication (for
example kerberos) and places the shared secret in the HTTP headers to
the salt\-api call. This salt\-api call should really be done on
localhost to avoid someone eavesdropping on the shared secret.
.sp
See the documentation for cherrypy to setup the headers in your
frontal.
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B salt.auth.sharedsecret.auth(username, password)
Shared secret authentication
.UNINDENT
.SS salt.auth.yubico
.sp
Provide authentication using YubiKey.
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B depends
yubico\-client Python module
.UNINDENT
.sp
To get your YubiKey API key you will need to visit the website below.
.sp
\fI\%https://upgrade.yubico.com/getapikey/\fP
.sp
The resulting page will show the generated Client ID (aka AuthID or API ID)
and the generated API key (Secret Key). Make a note of both and use these
two values in your /etc/salt/master configuration.
.INDENT 0.0
.INDENT 3.5
/etc/salt/master
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
yubico_users:
  damian:
    id: 12345
    key: ABCDEFGHIJKLMNOPQRSTUVWXYZ
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  yubico:
    damian:
      \- test.*
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Please wait five to ten minutes after generating the key before testing so that
the API key will be updated on all the YubiCloud servers.
.INDENT 0.0
.TP
.B salt.auth.yubico.auth(username, password)
Authenticate against yubico server
.UNINDENT
.INDENT 0.0
.TP
.B salt.auth.yubico.groups(username, *args, **kwargs)
.UNINDENT
.SS beacon modules
.TS
center;
|l|l|.
_
T{
\fI\%adb\fP
T}	T{
Beacon to emit adb device state changes for Android devices
T}
_
T{
\fI\%aix_account\fP
T}	T{
Beacon to fire event when we notice a AIX user is locked due to many failed login attempts.
T}
_
T{
\fI\%avahi_announce\fP
T}	T{
Beacon to announce via avahi (zeroconf)
T}
_
T{
\fI\%bonjour_announce\fP
T}	T{
Beacon to announce via Bonjour (zeroconf)
T}
_
T{
\fI\%btmp\fP
T}	T{
Beacon to fire events at failed login of users
T}
_
T{
\fI\%cert_info\fP
T}	T{
Beacon to monitor certificate expiration dates from files on the filesystem.
T}
_
T{
\fI\%diskusage\fP
T}	T{
Beacon to monitor disk usage.
T}
_
T{
\fI\%glxinfo\fP
T}	T{
Beacon to emit when a display is available to a linux machine
T}
_
T{
\fI\%haproxy\fP
T}	T{
Watch current connections of haproxy server backends.
T}
_
T{
\fI\%inotify\fP
T}	T{
Watch files and translate the changes into salt events
T}
_
T{
\fI\%journald\fP
T}	T{
A simple beacon to watch journald for specific entries
T}
_
T{
\fI\%junos_rre_keys\fP
T}	T{
Junos redundant routing engine beacon.
T}
_
T{
\fI\%load\fP
T}	T{
Beacon to emit system load averages
T}
_
T{
\fI\%log_beacon\fP
T}	T{
Beacon to fire events at specific log messages.
T}
_
T{
\fI\%memusage\fP
T}	T{
Beacon to monitor memory usage.
T}
_
T{
\fI\%napalm_beacon\fP
T}	T{
Watch NAPALM functions and fire events on specific triggers
T}
_
T{
\fI\%network_info\fP
T}	T{
Beacon to monitor statistics from ethernet adapters
T}
_
T{
\fI\%network_settings\fP
T}	T{
Beacon to monitor network adapter setting changes on Linux
T}
_
T{
\fI\%pkg\fP
T}	T{
Watch for pkgs that have upgrades, then fire an event.
T}
_
T{
\fI\%proxy_example\fP
T}	T{
Example beacon to use with salt\-proxy
T}
_
T{
\fI\%ps\fP
T}	T{
Send events covering process status
T}
_
T{
\fI\%salt_monitor\fP
T}	T{
A beacon to execute salt execution module functions.
T}
_
T{
\fI\%salt_proxy\fP
T}	T{
Beacon to manage and report the status of one or more salt proxy processes
T}
_
T{
\fI\%sensehat\fP
T}	T{
Monitor temperature, humidity and pressure using the SenseHat of a Raspberry Pi
T}
_
T{
\fI\%service\fP
T}	T{
Send events covering service status
T}
_
T{
\fI\%sh\fP
T}	T{
Watch the shell commands being executed actively.
T}
_
T{
\fI\%smartos_imgadm\fP
T}	T{
Beacon that fires events on image import/delete.
T}
_
T{
\fI\%smartos_vmadm\fP
T}	T{
Beacon that fires events on vm state changes
T}
_
T{
\fI\%status\fP
T}	T{
The status beacon is intended to send a basic health check event up to the master, this allows for event driven routines based on presence to be set up.
T}
_
T{
\fI\%swapusage\fP
T}	T{
Beacon to monitor swap usage.
T}
_
T{
\fI\%telegram_bot_msg\fP
T}	T{
Beacon to emit Telegram messages
T}
_
T{
\fI\%twilio_txt_msg\fP
T}	T{
Beacon to emit Twilio text messages
T}
_
T{
\fI\%watchdog\fP
T}	T{
Watch files and translate the changes into salt events.
T}
_
T{
\fI\%wtmp\fP
T}	T{
Beacon to fire events at login of users as registered in the wtmp file
T}
_
.TE
.SS salt.beacons.adb
.sp
Beacon to emit adb device state changes for Android devices
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.beacons.adb.beacon(config)
Emit the status of all devices returned by adb
.sp
Specify the device states that should emit an event,
there will be an event for each device with the
event type and device specified.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  adb:
    \- states:
        \- offline
        \- unauthorized
        \- missing
    \- no_devices_event: True
    \- battery_low: 25
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.adb.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.aix_account
.sp
Beacon to fire event when we notice a AIX user is locked due to many failed login attempts.
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
none
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.aix_account.beacon(config)
Checks for locked accounts due to too many invalid login attempts, 3 or higher.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  aix_account:
    user: ALL
    interval: 120
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.aix_account.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.avahi_announce
.sp
Beacon to announce via avahi (zeroconf)
.sp
New in version 2016.11.0.

.SS Dependencies
.INDENT 0.0
.IP \(bu 2
python\-avahi
.IP \(bu 2
dbus\-python
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.avahi_announce.beacon(config)
Broadcast values via zeroconf
.sp
If the announced values are static, it is advised to set run_once: True
(do not poll) on the beacon configuration.
.sp
The following are required configuration settings:
.INDENT 7.0
.IP \(bu 2
\fBservicetype\fP \- The service type to announce
.IP \(bu 2
\fBport\fP \- The port of the service to announce
.IP \(bu 2
\fBtxt\fP \- The TXT record of the service being announced as a dict. Grains
can be used to define TXT values using one of following two formats:
.INDENT 2.0
.IP \(bu 2
\fBgrains.<grain_name>\fP
.IP \(bu 2
\fBgrains.<grain_name>[i]\fP where i is an integer representing the
index of the grain to use. If the grain is not a list, the index is
ignored.
.UNINDENT
.UNINDENT
.sp
The following are optional configuration settings:
.INDENT 7.0
.IP \(bu 2
\fBservicename\fP \- Set the name of the service. Will use the hostname from
the minion\(aqs \fBhost\fP grain if this value is not set.
.IP \(bu 2
\fBreset_on_change\fP \- If \fBTrue\fP and there is a change in TXT records
detected, it will stop announcing the service and then restart announcing
the service. This interruption in service announcement may be desirable
if the client relies on changes in the browse records to update its cache
of TXT records. Defaults to \fBFalse\fP\&.
.IP \(bu 2
\fBreset_wait\fP \- The number of seconds to wait after announcement stops
announcing and before it restarts announcing in the case where there is a
change in TXT records detected and \fBreset_on_change\fP is \fBTrue\fP\&.
Defaults to \fB0\fP\&.
.IP \(bu 2
\fBcopy_grains\fP \- If \fBTrue\fP, Salt will copy the grains passed into the
beacon when it backs them up to check for changes on the next iteration.
Normally, instead of copy, it would use straight value assignment. This
will allow detection of changes to grains where the grains are modified
in\-place instead of completely replaced.  In\-place grains changes are not
currently done in the main Salt code but may be done due to a custom
plug\-in. Defaults to \fBFalse\fP\&.
.UNINDENT
.sp
Example Config
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  avahi_announce:
    \- run_once: True
    \- servicetype: _demo._tcp
    \- port: 1234
    \- txt:
        ProdName: grains.productname
        SerialNo: grains.serialnumber
        Comments: \(aqthis is a test\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.avahi_announce.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.bonjour_announce
.sp
Beacon to announce via Bonjour (zeroconf)
.INDENT 0.0
.TP
.B salt.beacons.bonjour_announce.beacon(config)
Broadcast values via zeroconf
.sp
If the announced values are static, it is advised to set run_once: True
(do not poll) on the beacon configuration.
.sp
The following are required configuration settings:
.INDENT 7.0
.IP \(bu 2
\fBservicetype\fP \- The service type to announce
.IP \(bu 2
\fBport\fP \- The port of the service to announce
.IP \(bu 2
\fBtxt\fP \- The TXT record of the service being announced as a dict. Grains
can be used to define TXT values using one of following two formats:
.INDENT 2.0
.IP \(bu 2
\fBgrains.<grain_name>\fP
.IP \(bu 2
\fBgrains.<grain_name>[i]\fP where i is an integer representing the
index of the grain to use. If the grain is not a list, the index is
ignored.
.UNINDENT
.UNINDENT
.sp
The following are optional configuration settings:
.INDENT 7.0
.IP \(bu 2
\fBservicename\fP \- Set the name of the service. Will use the hostname from
the minion\(aqs \fBhost\fP grain if this value is not set.
.IP \(bu 2
\fBreset_on_change\fP \- If \fBTrue\fP and there is a change in TXT records
detected, it will stop announcing the service and then restart announcing
the service. This interruption in service announcement may be desirable
if the client relies on changes in the browse records to update its cache
of TXT records. Defaults to \fBFalse\fP\&.
.IP \(bu 2
\fBreset_wait\fP \- The number of seconds to wait after announcement stops
announcing and before it restarts announcing in the case where there is a
change in TXT records detected and \fBreset_on_change\fP is \fBTrue\fP\&.
Defaults to \fB0\fP\&.
.IP \(bu 2
\fBcopy_grains\fP \- If \fBTrue\fP, Salt will copy the grains passed into the
beacon when it backs them up to check for changes on the next iteration.
Normally, instead of copy, it would use straight value assignment. This
will allow detection of changes to grains where the grains are modified
in\-place instead of completely replaced.  In\-place grains changes are not
currently done in the main Salt code but may be done due to a custom
plug\-in. Defaults to \fBFalse\fP\&.
.UNINDENT
.sp
Example Config
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  bonjour_announce:
    \- run_once: True
    \- servicetype: _demo._tcp
    \- port: 1234
    \- txt:
        ProdName: grains.productname
        SerialNo: grains.serialnumber
        Comments: \(aqthis is a test\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.bonjour_announce.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.btmp
.sp
Beacon to fire events at failed login of users
.sp
New in version 2015.5.0.

.SS Example Configuration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Fire events on all failed logins
beacons:
  btmp: []

# Matching on user name, using a default time range
beacons:
  btmp:
    \- users:
        gareth:
    \- defaults:
        time_range:
            start: \(aq8am\(aq
            end: \(aq4pm\(aq

# Matching on user name, overriding the default time range
beacons:
  btmp:
    \- users:
        gareth:
            time_range:
                start: \(aq8am\(aq
                end: \(aq4pm\(aq
    \- defaults:
        time_range:
            start: \(aq8am\(aq
            end: \(aq4pm\(aq

# Matching on group name, overriding the default time range
beacons:
  btmp:
    \- groups:
        users:
            time_range:
                start: \(aq8am\(aq
                end: \(aq4pm\(aq
    \- defaults:
        time_range:
            start: \(aq8am\(aq
            end: \(aq4pm\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Use Case: Posting Failed Login Events to Slack
.sp
This can be done using the following reactor SLS:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
report\-wtmp:
  runner.salt.cmd:
    \- args:
      \- fun: slack.post_message
      \- channel: mychannel      # Slack channel
      \- from_name: someuser     # Slack user
      \- message: \(dqFailed login from \(ga{{ data.get(\(aquser\(aq, \(aq\(aq) or \(aqunknown user\(aq }}\(ga on \(ga{{ data[\(aqid\(aq] }}\(ga\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Match the event like so in the master config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor:

  \- \(aqsalt/beacon/*/btmp/\(aq:
    \- salt://reactor/btmp.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This approach uses the \fI\%slack execution module\fP directly on the master, and therefore requires
that the master has a slack API key in its configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
slack:
  api_key: xoxb\-XXXXXXXXXXXX\-XXXXXXXXXXXX\-XXXXXXXXXXXXXXXXXXXXXXXX
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See the \fI\%slack execution module\fP
documentation for more information. While you can use an individual user\(aqs
API key to post to Slack, a bot user is likely better suited for this. The
\fI\%slack engine\fP documentation has information
on how to set up a bot user.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.btmp.beacon(config)
Read the last btmp file and return information on the failed logins
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.btmp.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.cert_info
.sp
Beacon to monitor certificate expiration dates from files on the filesystem.
.sp
New in version 3000.

.INDENT 0.0
.TP
.B maintainer
<\fI\%devops@eitr.tech\fP>
.TP
.B maturity
new
.TP
.B depends
OpenSSL
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.cert_info.beacon(config)
Monitor the certificate files on the minion.
.sp
Specify a notification threshold in days and only emit a beacon if any certificates are
expiring within that timeframe or if \fInotify_days\fP equals \fI\-1\fP (always report information).
The default notification threshold is 45 days and can be overridden at the beacon level and
at an individual certificate level.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  cert_info:
    \- files:
        \- /etc/pki/tls/certs/mycert.pem
        \- /etc/pki/tls/certs/yourcert.pem:
            notify_days: 15
        \- /etc/pki/tls/certs/ourcert.pem
    \- notify_days: 45
    \- interval: 86400
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.cert_info.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.diskusage
.sp
Beacon to monitor disk usage.
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B depends
python\-psutil
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.diskusage.beacon(config)
Monitor the disk usage of the minion
.sp
Specify thresholds for each disk and only emit a beacon if any of them are
exceeded.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  diskusage:
    \- /: 63%
    \- /mnt/nfs: 50%
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Windows drives must be quoted to avoid yaml syntax errors
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  diskusage:
    \-  interval: 120
    \- \(aqc:\e\e\(aq: 90%
    \- \(aqd:\e\e\(aq: 50%
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Regular expressions can be used as mount points.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  diskusage:
    \- \(aq^\e/(?!home).*$\(aq: 90%
    \- \(aq^[a\-zA\-Z]:\e\e$\(aq: 50%
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The first one will match all mounted disks beginning with \(dq/\(dq, except /home
The second one will match disks from A:to Z:on a Windows system
.sp
Note that if a regular expression are evaluated after static mount points,
which means that if a regular expression matches another defined mount point,
it will override the previously defined threshold.
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.diskusage.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.glxinfo
.sp
Beacon to emit when a display is available to a linux machine
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.beacons.glxinfo.beacon(config)
Emit the status of a connected display to the minion
.sp
Mainly this is used to detect when the display fails to connect
for whatever reason.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  glxinfo:
    \- user: frank
    \- screen_event: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.glxinfo.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.haproxy
.sp
Watch current connections of haproxy server backends.
Fire an event when over a specified threshold.
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.beacons.haproxy.beacon(config)
Check if current number of sessions of a server for a specific haproxy backend
is over a defined threshold.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  haproxy:
    \- backends:
        www\-backend:
            threshold: 45
            servers:
              \- web1
              \- web2
    \- interval: 120
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.haproxy.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.inotify
.sp
Watch files and translate the changes into salt events
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
pyinotify Python module >= 0.9.5
.UNINDENT
.TP
.B Caution
Using generic mask options like open, access, ignored, and
closed_nowrite with reactors can easily cause the reactor
to loop on itself. To mitigate this behavior, consider
setting the \fIdisable_during_state_run\fP flag to \fITrue\fP in
the beacon configuration.
.TP
.B note
The \fIinotify\fP beacon only works on OSes that have \fIinotify\fP
kernel support.
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.inotify.beacon(config)
Watch the configured files
.sp
Example Config
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  inotify:
    \- files:
        /path/to/file/or/dir:
          mask:
            \- open
            \- create
            \- close_write
          recurse: True
          auto_add: True
          exclude:
            \- /path/to/file/or/dir/exclude1
            \- /path/to/file/or/dir/exclude2
            \- /path/to/file/or/dir/regex[a\-m]*$:
                regex: True
    \- coalesce: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The mask list can contain the following events (the default mask is create,
delete, and modify):
.INDENT 7.0
.IP \(bu 2
access            \- File accessed
.IP \(bu 2
attrib            \- File metadata changed
.IP \(bu 2
close_nowrite     \- Unwritable file closed
.IP \(bu 2
close_write       \- Writable file closed
.IP \(bu 2
create            \- File created in watched directory
.IP \(bu 2
delete            \- File deleted from watched directory
.IP \(bu 2
delete_self       \- Watched file or directory deleted
.IP \(bu 2
modify            \- File modified
.IP \(bu 2
moved_from        \- File moved out of watched directory
.IP \(bu 2
moved_to          \- File moved into watched directory
.IP \(bu 2
move_self         \- Watched file moved
.IP \(bu 2
open              \- File opened
.UNINDENT
.sp
The mask can also contain the following options:
.INDENT 7.0
.IP \(bu 2
dont_follow       \- Don\(aqt dereference symbolic links
.IP \(bu 2
excl_unlink       \- Omit events for children after they have been unlinked
.IP \(bu 2
oneshot           \- Remove watch after one event
.IP \(bu 2
onlydir           \- Operate only if name is directory
.UNINDENT
.INDENT 7.0
.TP
.B recurse:
Recursively watch files in the directory
.TP
.B auto_add:
Automatically start watching files that are created in the watched directory
.TP
.B exclude:
Exclude directories or files from triggering events in the watched directory.
Can use regex if regex is set to True
.TP
.B coalesce:
If this coalescing option is enabled, events are filtered based on
their unicity, only unique events are enqueued, doublons are discarded.
An event is unique when the combination of its fields (wd, mask,
cookie, name) is unique among events of a same batch. After a batch of
events is processed any events are accepted again.
This option is top\-level (at the same level as the path) and therefore
affects all paths that are being watched. This is due to this option
being at the Notifier level in pyinotify.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.inotify.close(config)
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.inotify.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.journald
.sp
A simple beacon to watch journald for specific entries
.INDENT 0.0
.TP
.B salt.beacons.journald.beacon(config)
The journald beacon allows for the systemd journal to be parsed and linked
objects to be turned into events.
.sp
This beacons config will return all sshd jornal entries
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  journald:
    \- services:
        sshd:
          SYSLOG_IDENTIFIER: sshd
          PRIORITY: 6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.journald.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.junos_rre_keys
.sp
Junos redundant routing engine beacon.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This beacon only works on the Juniper native minion.
.UNINDENT
.UNINDENT
.sp
Copies salt\-minion keys to the backup RE when present
.sp
Configure with
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacon:
  beacons:
    junos_rre_keys:
      \- interval: 43200
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fIinterval\fP above is in seconds, 43200 is recommended (every 12 hours)
.INDENT 0.0
.TP
.B salt.beacons.junos_rre_keys.beacon(config)
.UNINDENT
.SS salt.beacons.load
.sp
Beacon to emit system load averages
.INDENT 0.0
.TP
.B salt.beacons.load.beacon(config)
Emit the load averages of this host.
.sp
Specify thresholds for each load average
and only emit a beacon if any of them are
exceeded.
.sp
\fIonchangeonly\fP: when \fIonchangeonly\fP is True the beacon will fire
events only when the load average pass one threshold.  Otherwise, it will fire an
event at each beacon interval.  The default is False.
.INDENT 7.0
.TP
.B \fIemitatstartup\fP: when \fIemitatstartup\fP is False the beacon will not fire
event when the minion is reload. Applicable only when \fIonchangeonly\fP is True.
The default is True.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  load:
    \- averages:
        1m:
          \- 0.0
          \- 2.0
        5m:
          \- 0.0
          \- 1.5
        15m:
          \- 0.1
          \- 1.0
    \- emitatstartup: True
    \- onchangeonly: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.load.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.log_beacon
.sp
Beacon to fire events at specific log messages.
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.beacons.log_beacon.beacon(config)
Read the log file and return match whole string
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  log:
    \- file: <path>
    \- tags:
        <tag>:
          regex: <pattern>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
regex matching is based on the \fI\%re\fP module
.UNINDENT
.UNINDENT
.sp
The defined tag is added to the beacon event tag.
This is not the tag in the log.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  log:
    \- file: /var/log/messages #path to log.
    \- tags:
        goodbye/world: # tag added to beacon event tag.
          regex: .*good\-bye.* # match good\-bye string anywhere in the log entry.
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.log_beacon.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.memusage
.sp
Beacon to monitor memory usage.
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B depends
python\-psutil
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.memusage.beacon(config)
Monitor the memory usage of the minion
.sp
Specify thresholds for percent used and only emit a beacon
if it is exceeded.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  memusage:
    \- percent: 63%
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.memusage.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.napalm_beacon
.SS Watch NAPALM functions and fire events on specific triggers
.sp
New in version 2018.3.0.

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBNAPALM\fP beacon only works only when running under
a regular Minion or a Proxy Minion, managed via \fI\%NAPALM\fP\&.
Check the documentation for the
\fI\%NAPALM proxy module\fP\&.
.UNINDENT
.UNINDENT
.sp
The configuration accepts a list of Salt functions to be
invoked, and the corresponding output hierarchy that should
be matched against. To invoke a function with certain
arguments, they can be specified using the \fB_args\fP key, or
\fB_kwargs\fP for more specific key\-value arguments.
.sp
The match structure follows the output hierarchy of the NAPALM
functions, under the \fBout\fP key.
.sp
For example, the following is normal structure returned by the
\fI\%ntp.stats\fP execution function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqcomment\(dq: \(dq\(dq,
    \(dqresult\(dq: true,
    \(dqout\(dq: [
        {
            \(dqreferenceid\(dq: \(dq.GPSs.\(dq,
            \(dqremote\(dq: \(dq172.17.17.1\(dq,
            \(dqsynchronized\(dq: true,
            \(dqreachability\(dq: 377,
            \(dqoffset\(dq: 0.461,
            \(dqwhen\(dq: \(dq860\(dq,
            \(dqdelay\(dq: 143.606,
            \(dqhostpoll\(dq: 1024,
            \(dqstratum\(dq: 1,
            \(dqjitter\(dq: 0.027,
            \(dqtype\(dq: \(dq\-\(dq
        },
        {
            \(dqreferenceid\(dq: \(dq.INIT.\(dq,
            \(dqremote\(dq: \(dq172.17.17.2\(dq,
            \(dqsynchronized\(dq: false,
            \(dqreachability\(dq: 0,
            \(dqoffset\(dq: 0.0,
            \(dqwhen\(dq: \(dq\-\(dq,
            \(dqdelay\(dq: 0.0,
            \(dqhostpoll\(dq: 1024,
            \(dqstratum\(dq: 16,
            \(dqjitter\(dq: 4000.0,
            \(dqtype\(dq: \(dq\-\(dq
        }
    ]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In order to fire events when the synchronization is lost with
one of the NTP peers, e.g., \fB172.17.17.2\fP, we can match it explicitly as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ntp.stats:
  remote: 172.17.17.2
  synchronized: false
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There is one single nesting level, as the output of \fBntp.stats\fP is
just a list of dictionaries, and this beacon will compare each dictionary
from the list with the structure examplified above.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When we want to match on any element at a certain level, we can
configure \fB*\fP to match anything.
.UNINDENT
.UNINDENT
.sp
Considering a more complex structure consisting on multiple nested levels,
e.g., the output of the \fI\%bgp.neighbors\fP
execution function, to check when any neighbor from the \fBglobal\fP
routing table is down, the match structure would have the format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
bgp.neighbors:
  global:
    \(aq*\(aq:
      up: false
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The match structure above will match any BGP neighbor, with
any network (\fB*\fP matches any AS number), under the \fBglobal\fP VRF.
In other words, this beacon will push an event on the Salt bus
when there\(aqs a BGP neighbor down.
.sp
The right operand can also accept mathematical operations
(i.e., \fB<\fP, \fB<=\fP, \fB!=\fP, \fB>\fP, \fB>=\fP etc.) when comparing
numerical values.
.sp
Configuration Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  napalm:
    \- net.interfaces:
        # fire events when any interfaces is down
        \(aq*\(aq:
          is_up: false
    \- net.interfaces:
        # fire events only when the xe\-0/0/0 interface is down
        \(aqxe\-0/0/0\(aq:
          is_up: false
    \- ntp.stats:
        # fire when there\(aqs any NTP peer unsynchornized
        synchronized: false
    \- ntp.stats:
        # fire only when the synchronization
        # with with the 172.17.17.2 NTP server is lost
        _args:
          \- 172.17.17.2
        synchronized: false
    \- ntp.stats:
        # fire only when there\(aqs a NTP peer with
        # synchronization stratum > 5
        stratum: \(aq> 5\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Event structure example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dq_stamp\(dq: \(dq2017\-09\-05T09:51:09.377202\(dq,
    \(dqargs\(dq: [],
    \(dqdata\(dq: {
        \(dqcomment\(dq: \(dq\(dq,
        \(dqout\(dq: [
            {
                \(dqdelay\(dq: 0.0,
                \(dqhostpoll\(dq: 1024,
                \(dqjitter\(dq: 4000.0,
                \(dqoffset\(dq: 0.0,
                \(dqreachability\(dq: 0,
                \(dqreferenceid\(dq: \(dq.INIT.\(dq,
                \(dqremote\(dq: \(dq172.17.17.1\(dq,
                \(dqstratum\(dq: 16,
                \(dqsynchronized\(dq: false,
                \(dqtype\(dq: \(dq\-\(dq,
                \(dqwhen\(dq: \(dq\-\(dq
            }
        ],
        \(dqresult\(dq: true
    },
    \(dqfun\(dq: \(dqntp.stats\(dq,
    \(dqid\(dq: \(dqedge01.bjm01\(dq,
    \(dqkwargs\(dq: {},
    \(dqmatch\(dq: {
        \(dqstratum\(dq: \(dq> 5\(dq
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The event examplified above has been fired when the device
identified by the Minion id \fBedge01.bjm01\fP has been synchronized
with a NTP server at a stratum level greater than 5.
.INDENT 0.0
.TP
.B salt.beacons.napalm_beacon.beacon(config)
Watch napalm function and fire events.
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.napalm_beacon.validate(config)
Validate the beacon configuration.
.UNINDENT
.SS salt.beacons.network_info
.sp
Beacon to monitor statistics from ethernet adapters
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B salt.beacons.network_info.beacon(config)
Emit the network statistics of this host.
.sp
Specify thresholds for each network stat
and only emit a beacon if any of them are
exceeded.
.sp
Emit beacon when any values are equal to
configured values.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  network_info:
    \- interfaces:
        eth0:
          type: equal
          bytes_sent: 100000
          bytes_recv: 100000
          packets_sent: 100000
          packets_recv: 100000
          errin: 100
          errout: 100
          dropin: 100
          dropout: 100
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Emit beacon when any values are greater
than configured values.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  network_info:
    \- interfaces:
        eth0:
          type: greater
          bytes_sent: 100000
          bytes_recv: 100000
          packets_sent: 100000
          packets_recv: 100000
          errin: 100
          errout: 100
          dropin: 100
          dropout: 100
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.network_info.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.network_settings
.sp
Beacon to monitor network adapter setting changes on Linux
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B class  salt.beacons.network_settings.Hashabledict
Helper class that implements a hash function for a dictionary
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.network_settings.beacon(config)
Watch for changes on network settings
.sp
By default, the beacon will emit when there is a value change on one of the
settings on watch. The config also support the onvalue parameter for each
setting, which instruct the beacon to only emit if the setting changed to
the value defined.
.sp
Example Config
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  network_settings:
    \- interfaces:
        eth0:
          ipaddr:
          promiscuity:
            onvalue: 1
        eth1:
          linkmode:
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The config above will check for value changes on eth0 ipaddr and eth1 linkmode. It will also
emit if the promiscuity value changes to 1.
.sp
Beacon items can use the * wildcard to make a definition apply to several interfaces. For
example an eth* would apply to all ethernet interfaces.
.sp
Setting the argument coalesce = True will combine all the beacon results on a single event.
The example below shows how to trigger coalesced results:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  network_settings:
    \- coalesce: True
    \- interfaces:
        eth0:
          ipaddr:
          promiscuity:
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.network_settings.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.pkg
.sp
Watch for pkgs that have upgrades, then fire an event.
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.beacons.pkg.beacon(config)
Check if installed packages are the latest versions
and fire an event for those that have upgrades.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  pkg:
    \- pkgs:
        \- zsh
        \- apache2
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.pkg.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.proxy_example
.sp
Example beacon to use with salt\-proxy
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  proxy_example:
    endpoint: beacon
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.proxy_example.beacon(config)
Called several times each second
\fI\%https://docs.saltproject.io/en/latest/topics/beacons/#the\-beacon\-function\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  proxy_example:
    \- endpoint: beacon
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.proxy_example.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.ps
.sp
Send events covering process status
.INDENT 0.0
.TP
.B salt.beacons.ps.beacon(config)
Scan for processes and fire events
.sp
Example Config
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  ps:
    \- processes:
        salt\-master: running
        mysql: stopped
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The config above sets up beacons to check that
processes are running or stopped.
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.ps.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.salt_monitor
.sp
A beacon to execute salt execution module functions. This beacon will fire only if the return data is \(dqtruthy\(dq.
The function return, function name and args and/or kwargs, will be passed as data in the event.
.sp
The configuration can accept a list of salt functions to execute every interval.
Make sure to allot enough time via \(aqinterval\(aq key to allow all salt functions to execute.
The salt functions will be executed sequentially.
.sp
The elements in list of functions can be either a simple string (with no arguments) or a dictionary with a single
key being the salt execution module and sub keys indicating args and / or kwargs.
.sp
See example config below.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  salt_monitor:
    \- salt_fun:
    \- slsutil.renderer:
        args:
          \- salt://states/apache.sls
        kwargs:
          \- default_renderer: jinja
    \- test.ping
    \- interval: 3600 # seconds
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.salt_monitor.beacon(config)
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.salt_monitor.validate(config)
.UNINDENT
.SS salt.beacons.salt_proxy
.sp
Beacon to manage and report the status of
one or more salt proxy processes
.sp
New in version 2015.8.3.

.INDENT 0.0
.TP
.B salt.beacons.salt_proxy.beacon(config)
Handle configured proxies
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  salt_proxy:
    \- proxies:
        p8000: {}
        p8001: {}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.salt_proxy.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.sensehat module
.SS Monitor temperature, humidity and pressure using the SenseHat of a Raspberry Pi
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B maintainer
Benedikt Werner <\fI\%1benediktwerner@gmail.com\fP>
.TP
.B maturity
new
.TP
.B depends
sense_hat Python module
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.sensehat.beacon(config)
Monitor the temperature, humidity and pressure using the SenseHat sensors.
.sp
You can either specify a threshold for each value and only emit a beacon
if it is exceeded or define a range and emit a beacon when the value is
out of range.
.sp
Units:
* humidity:                     percent
* temperature:                  degrees Celsius
* temperature_from_pressure:    degrees Celsius
* pressure:                     Millibars
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  sensehat:
    \- sensors:
        humidity: 70%
        temperature: [20, 40]
        temperature_from_pressure: 40
        pressure: 1500
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.sensehat.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.service
.sp
Send events covering service status
.INDENT 0.0
.TP
.B salt.beacons.service.beacon(config)
Scan for the configured services and fire events
.sp
Example Config
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  service:
    \- services:
        salt\-master: {}
        mysql: {}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The config above sets up beacons to check for
the salt\-master and mysql services.
.sp
The config also supports two other parameters for each service:
.sp
\fIonchangeonly\fP: when \fIonchangeonly\fP is True the beacon will fire
events only when the service status changes.  Otherwise, it will fire an
event at each beacon interval.  The default is False.
.sp
\fIdelay\fP: when \fIdelay\fP is greater than 0 the beacon will fire events only
after the service status changes, and the delay (in seconds) has passed.
Applicable only when \fIonchangeonly\fP is True.  The default is 0.
.sp
\fIemitatstartup\fP: when \fIemitatstartup\fP is False the beacon will not fire
event when the minion is reload. Applicable only when \fIonchangeonly\fP is True.
The default is True.
.sp
\fIuncleanshutdown\fP: If \fIuncleanshutdown\fP is present it should point to the
location of a pid file for the service.  Most services will not clean up
this pid file if they are shutdown uncleanly (e.g. via \fIkill \-9\fP) or if they
are terminated through a crash such as a segmentation fault.  If the file is
present, then the beacon will add \fIuncleanshutdown: True\fP to the event.  If
not present, the field will be False.  The field is only added when the
service is NOT running. Omitting the configuration variable altogether will
turn this feature off.
.sp
Please note that some init systems can remove the pid file if the service
registers as crashed. One such example is nginx on CentOS 7, where the
service unit removes the pid file when the service shuts down (IE: the pid
file is observed as removed when kill \-9 is sent to the nginx master
process). The \(aquncleanshutdown\(aq option might not be of much use there,
unless the unit file is modified.
.sp
Here is an example that will fire an event 30 seconds after the state of nginx
changes and report an uncleanshutdown.  This example is for Arch, which
places nginx\(aqs pid file in \fI/run\fP\&.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  service:
    \- services:
        nginx:
          onchangeonly: True
          delay: 30
          uncleanshutdown: /run/nginx.pid
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.service.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.sh
.sp
Watch the shell commands being executed actively. This beacon requires strace.
.INDENT 0.0
.TP
.B salt.beacons.sh.beacon(config)
Scan the shell execve routines. This beacon will convert all login shells
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  sh: []
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.sh.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.smartos_imgadm
.sp
Beacon that fires events on image import/delete.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
## minimal
# \- check for new images every 1 second (salt default)
# \- does not send events at startup
beacons:
  imgadm: []

## standard
# \- check for new images every 60 seconds
# \- send import events at startup for all images
beacons:
  imgadm:
    \- interval: 60
    \- startup_import_event: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.smartos_imgadm.beacon(config)
Poll imgadm and compare available images
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.smartos_imgadm.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.smartos_vmadm
.sp
Beacon that fires events on vm state changes
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
## minimal
# \- check for vm changes every 1 second (salt default)
# \- does not send events at startup
beacons:
  vmadm: []

## standard
# \- check for vm changes every 60 seconds
# \- send create event at startup for all vms
beacons:
  vmadm:
    \- interval: 60
    \- startup_create_event: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.smartos_vmadm.beacon(config)
Poll vmadm for changes
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.smartos_vmadm.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.status
.sp
The status beacon is intended to send a basic health check event up to the
master, this allows for event driven routines based on presence to be set up.
.sp
The intention of this beacon is to add the config options to add monitoring
stats to the health beacon making it a one stop shop for gathering systems
health and status data
.sp
New in version 2016.11.0.

.sp
To configure this beacon to use the defaults, set up an empty dict for it in
the minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  status: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default, all of the information from the following execution module
functions will be returned:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
loadavg
.IP \(bu 2
cpustats
.IP \(bu 2
meminfo
.IP \(bu 2
vmstats
.IP \(bu 2
time
.UNINDENT
.UNINDENT
.UNINDENT
.sp
You can also configure your own set of functions to be returned:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  status:
    \- time:
      \- all
    \- loadavg:
      \- all
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You may also configure only certain fields from each function to be returned.
For instance, the \fBloadavg\fP function returns the following fields:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
1\-min
.IP \(bu 2
5\-min
.IP \(bu 2
15\-min
.UNINDENT
.UNINDENT
.UNINDENT
.sp
If you wanted to return only the \fB1\-min\fP and \fB5\-min\fP fields for \fBloadavg\fP
then you would configure:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  status:
    \- loadavg:
      \- 1\-min
      \- 5\-min
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Other functions only return a single value instead of a dictionary. With these,
you may specify \fBall\fP or \fB0\fP\&. The following are both valid:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  status:
    \- time:
      \- all

beacons:
  status:
    \- time:
      \- 0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a \fBstatus\fP function returns a list, you may return the index marker or
markers for specific list items:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  status:
    \- w:
      \- 0
      \- 1
      \- 2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Not all status functions are supported for every operating system. Be certain
to check the minion log for errors after configuring this beacon.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.status.beacon(config)
Return status for requested information
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.status.validate(config)
Validate the config is a dict
.UNINDENT
.SS salt.beacons.swapusage
.sp
Beacon to monitor swap usage.
.sp
New in version 3003.

.INDENT 0.0
.TP
.B depends
python\-psutil
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.swapusage.beacon(config)
Monitor the swap usage of the minion
.sp
Specify thresholds for percent used and only emit a beacon
if it is exceeded.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  swapusage:
    \- percent: 13%
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.swapusage.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.telegram_bot_msg
.sp
Beacon to emit Telegram messages
.sp
Requires the python\-telegram\-bot library
.INDENT 0.0
.TP
.B salt.beacons.telegram_bot_msg.beacon(config)
Emit a dict with a key \(dqmsgs\(dq whose value is a list of messages
sent to the configured bot by one of the allowed usernames.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  telegram_bot_msg:
    \- token: \(dq<bot access token>\(dq
    \- accept_from:
      \- \(dq<valid username>\(dq
    \- interval: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.telegram_bot_msg.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.twilio_txt_msg
.sp
Beacon to emit Twilio text messages
.INDENT 0.0
.TP
.B salt.beacons.twilio_txt_msg.beacon(config)
Emit a dict name \(dqtexts\(dq whose value is a list
of texts.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  twilio_txt_msg:
    \- account_sid: \(dq<account sid>\(dq
    \- auth_token: \(dq<auth token>\(dq
    \- twilio_number: \(dq+15555555555\(dq
    \- interval: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.twilio_txt_msg.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.watchdog
.sp
Watch files and translate the changes into salt events.
.sp
New in version 2019.2.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
watchdog Python module >= 0.8.3
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.beacons.watchdog.FileSystemEventHandler
A dummy class to make the import work
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.beacons.watchdog.Handler(queue, masks=None)
.INDENT 7.0
.TP
.B on_created(event)
.UNINDENT
.INDENT 7.0
.TP
.B on_deleted(event)
.UNINDENT
.INDENT 7.0
.TP
.B on_modified(event)
.UNINDENT
.INDENT 7.0
.TP
.B on_moved(event)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.beacons.watchdog.ValidationError
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.watchdog.beacon(config)
Watch the configured directories
.sp
Example Config
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  watchdog:
    \- directories:
        /path/to/dir:
          mask:
            \- create
            \- modify
            \- delete
            \- move
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The mask list can contain the following events (the default mask is create,
modify delete, and move):
.INDENT 7.0
.IP \(bu 2
create  \- File or directory is created in watched directory
.IP \(bu 2
modify  \- The watched directory is modified
.IP \(bu 2
delete  \- File or directory is deleted from watched directory
.IP \(bu 2
move    \- File or directory is moved or renamed in the watched directory
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.watchdog.close(config)
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.watchdog.to_salt_event(event)
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.watchdog.validate(config)
Validate the beacon configuration
.UNINDENT
.SS salt.beacons.wtmp
.sp
Beacon to fire events at login of users as registered in the wtmp file
.sp
New in version 2015.5.0.

.SS Example Configuration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Fire events on all logins
beacons:
  wtmp: []

# Matching on user name, using a default time range
beacons:
  wtmp:
    \- users:
        gareth:
    \- defaults:
        time_range:
            start: \(aq8am\(aq
            end: \(aq4pm\(aq

# Matching on user name, overriding the default time range
beacons:
  wtmp:
    \- users:
        gareth:
            time_range:
                start: \(aq7am\(aq
                end: \(aq3pm\(aq
    \- defaults:
        time_range:
            start: \(aq8am\(aq
            end: \(aq4pm\(aq

# Matching on group name, overriding the default time range
beacons:
  wtmp:
    \- groups:
        users:
            time_range:
                start: \(aq7am\(aq
                end: \(aq3pm\(aq
    \- defaults:
        time_range:
            start: \(aq8am\(aq
            end: \(aq4pm\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS How to Tell What An Event Means
.sp
In the events that this beacon fires, a type of \fB7\fP denotes a login, while a
type of \fB8\fP denotes a logout. These values correspond to the \fBut_type\fP
value from a wtmp/utmp event (see the \fBwtmp\fP manpage for more information).
In the extremely unlikely case that your platform uses different values, they
can be overridden using a \fBut_type\fP key in the beacon configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  wtmp:
    \- ut_type:
        login: 9
        logout: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This beacon\(aqs events include an \fBaction\fP key which will be either \fBlogin\fP
or \fBlogout\fP depending on the event type.
.sp
Changed in version 2019.2.0: \fBaction\fP key added to beacon event, and \fBut_type\fP config parameter
added.

.SS Use Case: Posting Login/Logout Events to Slack
.sp
This can be done using the following reactor SLS:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
report\-wtmp:
  runner.salt.cmd:
    \- args:
      \- fun: slack.post_message
      \- channel: mychannel      # Slack channel
      \- from_name: someuser     # Slack user
      \- message: \(dq{{ data.get(\(aqaction\(aq, \(aqUnknown event\(aq) | capitalize }} from \(ga{{ data.get(\(aquser\(aq, \(aq\(aq) or \(aqunknown user\(aq }}\(ga on \(ga{{ data[\(aqid\(aq] }}\(ga\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Match the event like so in the master config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor:

  \- \(aqsalt/beacon/*/wtmp/\(aq:
    \- salt://reactor/wtmp.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This approach uses the \fI\%slack execution module\fP directly on the master, and therefore requires
that the master has a slack API key in its configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
slack:
  api_key: xoxb\-XXXXXXXXXXXX\-XXXXXXXXXXXX\-XXXXXXXXXXXXXXXXXXXXXXXX
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See the \fI\%slack execution module\fP
documentation for more information. While you can use an individual user\(aqs
API key to post to Slack, a bot user is likely better suited for this. The
\fI\%slack engine\fP documentation has information
on how to set up a bot user.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.wtmp.beacon(config)
Read the last wtmp file and return information on the logins
.UNINDENT
.INDENT 0.0
.TP
.B salt.beacons.wtmp.validate(config)
Validate the beacon configuration
.UNINDENT
.SS cache modules
.sp
For understanding and usage of the cache modules see the \fI\%Minion Data Cache\fP topic.
.TS
center;
|l|l|.
_
T{
\fI\%consul\fP
T}	T{
Minion data cache plugin for Consul key/value data store.
T}
_
T{
\fI\%etcd_cache\fP
T}	T{
Minion data cache plugin for Etcd key/value data store.
T}
_
T{
\fI\%localfs\fP
T}	T{
Cache data in filesystem.
T}
_
T{
\fI\%mysql_cache\fP
T}	T{
Minion data cache plugin for MySQL database.
T}
_
T{
\fI\%redis_cache\fP
T}	T{
Redis
T}
_
.TE
.SS salt.cache.consul
.sp
Minion data cache plugin for Consul key/value data store.
.sp
New in version 2016.11.2.

.sp
Changed in version 3005: Timestamp/cache updated support added.

.INDENT 0.0
.TP
.B depends
python\-consul >= 0.2.0
.UNINDENT
.sp
It is up to the system administrator to set up and configure the Consul
infrastructure. All is needed for this plugin is a working Consul agent
with a read\-write access to the key\-value store.
.sp
The related documentation can be found in the \fI\%Consul documentation\fP\&.
.sp
To enable this cache plugin, the master will need the python client for
Consul installed. This can be easily installed with pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install python\-consul
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Optionally, depending on the Consul agent configuration, the following values
could be set in the master config. These are the defaults:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
consul.host: 127.0.0.1
consul.port: 8500
consul.token: None
consul.scheme: http
consul.consistency: default
consul.dc: dc1
consul.verify: True
consul.timestamp_suffix: .tstamp  # Added in 3005.0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In order to bring the cache APIs into conformity, in 3005.0 timestamp
information gets stored as a separate \fB{key}.tstamp\fP key/value. If your
existing functionality depends on being able to store normal keys with the
\fB\&.tstamp\fP suffix, override the \fBconsul.timestamp_suffix\fP default config.
.sp
Related docs could be found in the \fI\%python\-consul documentation\fP\&.
.sp
To use the consul as a minion data cache backend, set the master \fBcache\fP config
value to \fBconsul\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cache: consul
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.consul.contains(bank, key)
Checks if the specified bank contains the specified key.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.consul.fetch(bank, key)
Fetch a key value.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.consul.flush(bank, key=None)
Remove the key from the cache bank with all the key content.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.consul.list_(bank)
Return an iterable object containing all entries stored in the specified bank.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.consul.store(bank, key, data)
Store a key value.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.consul.updated(bank, key)
Return the Unix Epoch timestamp of when the key was last updated. Return
None if key is not found.
.UNINDENT
.SS salt.cache.etcd_cache
.sp
Minion data cache plugin for Etcd key/value data store.
.sp
New in version 2018.3.0.

.sp
Changed in version 3005.

.sp
It is up to the system administrator to set up and configure the Etcd
infrastructure. All is needed for this plugin is a working Etcd agent
with a read\-write access to the key\-value store.
.sp
The related documentation can be found in the \fI\%Etcd documentation\fP\&.
.sp
To enable this cache plugin, the master will need the python client for
Etcd installed. This can be easily installed with pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install python\-etcd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
While etcd API v3 has been implemented in other places within salt,
etcd_cache does not support it at this time due to fundamental differences in
how the versions are designed and v3 not being compatible with the cache API.
.UNINDENT
.UNINDENT
.sp
Optionally, depending on the Etcd agent configuration, the following values
could be set in the master config. These are the defaults:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.host: 127.0.0.1
etcd.port: 2379
etcd.protocol: http
etcd.allow_reconnect: True
etcd.allow_redirect: False
etcd.srv_domain: None
etcd.read_timeout: 60
etcd.username: None
etcd.password: None
etcd.cert: None
etcd.ca_cert: None
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Related docs could be found in the \fI\%python\-etcd documentation\fP\&.
.sp
To use the etcd as a minion data cache backend, set the master \fBcache\fP config
value to \fBetcd\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cache: etcd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In Phosphorus, ls/list was changed to always return the final name in the path.
This should only make a difference if you were directly using \fBls\fP on paths
that were more or less nested than, for example: \fB1/2/3/4\fP\&.
.INDENT 0.0
.TP
.B salt.cache.etcd_cache.contains(bank, key)
Checks if the specified bank contains the specified key.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.etcd_cache.fetch(bank, key)
Fetch a key value.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.etcd_cache.flush(bank, key=None)
Remove the key from the cache bank with all the key content.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.etcd_cache.ls(bank)
Return an iterable object containing all entries stored in the specified
bank.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.etcd_cache.store(bank, key, data)
Store a key value.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.etcd_cache.updated(bank, key)
Return Unix Epoch based timestamp of when the bank/key was updated.
.UNINDENT
.SS salt.cache.localfs
.sp
Cache data in filesystem.
.sp
New in version 2016.11.0.

.sp
The \fBlocalfs\fP Minion cache module is the default cache module and does not
require any configuration.
.sp
Expiration values can be set in the relevant config file (\fB/etc/salt/master\fP for
the master, \fB/etc/salt/cloud\fP for Salt Cloud, etc).
.INDENT 0.0
.TP
.B salt.cache.localfs.contains(bank, key, cachedir)
Checks if the specified bank contains the specified key.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.localfs.fetch(bank, key, cachedir)
Fetch information from a file.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.localfs.flush(bank, key=None, cachedir=None)
Remove the key from the cache bank with all the key content.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.localfs.get_storage_id(kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.localfs.init_kwargs(kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.localfs.list_(bank, cachedir)
Return an iterable object containing all entries stored in the specified bank.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.localfs.store(bank, key, data, cachedir)
Store information in a file.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.localfs.updated(bank, key, cachedir)
Return the epoch of the mtime for this cache file
.UNINDENT
.SS salt.cache.mysql_cache
.sp
Minion data cache plugin for MySQL database.
.sp
New in version 2018.3.0.

.sp
It is up to the system administrator to set up and configure the MySQL
infrastructure. All is needed for this plugin is a working MySQL server.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
The mysql.database and mysql.table_name will be directly added into certain
queries. Salt treats these as trusted input.
.UNINDENT
.UNINDENT
.sp
The module requires the database (default \fBsalt_cache\fP) to exist but creates
its own table if needed. The keys are indexed using the \fBbank\fP and
\fBetcd_key\fP columns.
.sp
To enable this cache plugin, the master will need the python client for
MySQL installed. This can be easily installed with pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pymysql
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Optionally, depending on the MySQL agent configuration, the following values
could be set in the master config. These are the defaults:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql.host: 127.0.0.1
mysql.port: 2379
mysql.user: None
mysql.password: None
mysql.database: salt_cache
mysql.table_name: cache
# This may be enabled to create a fresh connection on every call
mysql.fresh_connection: false
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Related docs can be found in the \fI\%python\-mysql documentation\fP\&.
.sp
To use the mysql as a minion data cache backend, set the master \fBcache\fP config
value to \fBmysql\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cache: mysql
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.mysql_cache.contains(bank, key)
Checks if the specified bank contains the specified key.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.mysql_cache.fetch(bank, key)
Fetch a key value.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.mysql_cache.flush(bank, key=None)
Remove the key from the cache bank with all the key content.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.mysql_cache.force_reconnect()
Force a reconnection to the MySQL database, by removing the client from
Salt\(aqs __context__.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.mysql_cache.ls(bank)
Return an iterable object containing all entries stored in the specified
bank.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.mysql_cache.run_query(conn, query, args=None, retries=3)
Get a cursor and run a query. Reconnect up to \fBretries\fP times if
needed.
Returns: cursor, affected rows counter
Raises: SaltCacheError, AttributeError, OperationalError, InterfaceError
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.mysql_cache.store(bank, key, data)
Store a key value.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.mysql_cache.updated(bank, key)
Return the integer Unix epoch update timestamp of the specified bank and
key.
.UNINDENT
.SS salt.cache.redis_cache
.SS Redis
.sp
Redis plugin for the Salt caching subsystem.
.sp
New in version 2017.7.0.

.sp
Changed in version 3005.

.sp
To enable this cache plugin, the master will need the python client for redis installed.
This can be easily installed with pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \e* pip.install redis
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As Redis provides a simple mechanism for very fast key\-value store, in order to
provide the necessary features for the Salt caching subsystem, the following
conventions are used:
.INDENT 0.0
.IP \(bu 2
A Redis key consists of the bank name and the cache key separated by \fB/\fP, e.g.:
\fB$KEY_minions/alpha/stuff\fP where \fBminions/alpha\fP is the bank name
and \fBstuff\fP is the key name.
.IP \(bu 2
As the caching subsystem is organised as a tree, we need to store the caching
path and identify the bank and its offspring.  At the same time, Redis is
linear and we need to avoid doing \fBkeys <pattern>\fP which is very
inefficient as it goes through all the keys on the remote Redis server.
Instead, each bank hierarchy has a Redis SET associated which stores the list
of sub\-banks. By default, these keys begin with \fB$BANK_\fP\&.
.IP \(bu 2
In addition, each key name is stored in a separate SET of all the keys within
a bank. By default, these SETs begin with \fB$BANKEYS_\fP\&.
.UNINDENT
.sp
For example, to store the key \fBmy\-key\fP under the bank \fBroot\-bank/sub\-bank/leaf\-bank\fP,
the following hierarchy will be built:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
127.0.0.1:6379> SMEMBERS $BANK_root\-bank
1) \(dqsub\-bank\(dq
127.0.0.1:6379> SMEMBERS $BANK_root\-bank/sub\-bank
1) \(dqleaf\-bank\(dq
127.0.0.1:6379> SMEMBERS $BANKEYS_root\-bank/sub\-bank/leaf\-bank
1) \(dqmy\-key\(dq
127.0.0.1:6379> GET $KEY_root\-bank/sub\-bank/leaf\-bank/my\-key
\(dqmy\-value\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There are four types of keys stored:
.INDENT 0.0
.IP \(bu 2
\fB$BANK_*\fP is a Redis SET containing the list of banks under the current bank.
.IP \(bu 2
\fB$BANKEYS_*\fP is a Redis SET containing the list of keys under the current bank.
.IP \(bu 2
\fB$KEY_*\fP keeps the value of the key.
.IP \(bu 2
\fB$TSTAMP_*\fP stores the last updated timestamp of the key.
.UNINDENT
.sp
These prefixes and the separator can be adjusted using the configuration options:
.INDENT 0.0
.TP
.B bank_prefix: \fB$BANK\fP
The prefix used for the name of the Redis key storing the list of sub\-banks.
.TP
.B bank_keys_prefix: \fB$BANKEYS\fP
The prefix used for the name of the Redis key storing the list of keys under a certain bank.
.TP
.B key_prefix: \fB$KEY\fP
The prefix of the Redis keys having the value of the keys to be cached under
a certain bank.
.TP
.B timestamp_prefix: \fB$TSTAMP\fP
The prefix for the last modified timestamp for keys.
.sp
New in version 3005.

.TP
.B separator: \fB_\fP
The separator between the prefix and the key body.
.UNINDENT
.sp
The connection details can be specified using:
.INDENT 0.0
.TP
.B host: \fBlocalhost\fP
The hostname of the Redis server.
.TP
.B port: \fB6379\fP
The Redis server port.
.TP
.B cluster_mode: \fBFalse\fP
Whether cluster_mode is enabled or not
.TP
.B cluster.startup_nodes:
A list of host, port dictionaries pointing to cluster members. At least one is required
but multiple nodes are better
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cache.redis.cluster.startup_nodes
  \- host: redis\-member\-1
    port: 6379
  \- host: redis\-member\-2
    port: 6379
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B cluster.skip_full_coverage_check: \fBFalse\fP
Some cluster providers restrict certain redis commands such as CONFIG for enhanced security.
Set this option to true to skip checks that required advanced privileges.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Most cloud hosted redis clusters will require this to be set to \fBTrue\fP
.UNINDENT
.UNINDENT
.TP
.B db: \fB\(aq0\(aq\fP
The database index.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The database index must be specified as string not as integer value!
.UNINDENT
.UNINDENT
.TP
.B password:
Redis connection password.
.UNINDENT
.sp
unix_socket_path:
.INDENT 0.0
.INDENT 3.5
New in version 2018.3.1.

.sp
Path to a UNIX socket for access. Overrides \fIhost\fP / \fIport\fP\&.
.UNINDENT
.UNINDENT
.sp
Configuration Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cache.redis.host: localhost
cache.redis.port: 6379
cache.redis.db: \(aq0\(aq
cache.redis.password: my pass
cache.redis.bank_prefix: #BANK
cache.redis.bank_keys_prefix: #BANKEYS
cache.redis.key_prefix: #KEY
cache.redis.timestamp_prefix: #TICKS
cache.redis.separator: \(aq@\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Cluster Configuration Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cache.redis.cluster_mode: true
cache.redis.cluster.skip_full_coverage_check: true
cache.redis.cluster.startup_nodes:
  \- host: redis\-member\-1
    port: 6379
  \- host: redis\-member\-2
    port: 6379
cache.redis.db: \(aq0\(aq
cache.redis.password: my pass
cache.redis.bank_prefix: #BANK
cache.redis.bank_keys_prefix: #BANKEYS
cache.redis.key_prefix: #KEY
cache.redis.separator: \(aq@\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.redis_cache.contains(bank, key)
Checks if the specified bank contains the specified key.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.redis_cache.fetch(bank, key)
Fetch data from the Redis cache.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.redis_cache.flush(bank, key=None)
Remove the key from the cache bank with all the key content. If no key is specified, remove
the entire bank with all keys and sub\-banks inside.
This function is using the Redis pipelining for best performance.
However, when removing a whole bank,
in order to re\-create the tree, there are a couple of requests made. In total:
.INDENT 7.0
.IP \(bu 2
one for node in the hierarchy sub\-tree, starting from the bank node
.IP \(bu 2
one pipelined request to get the keys under all banks in the sub\-tree
.IP \(bu 2
one pipeline request to remove the corresponding keys
.UNINDENT
.sp
This is not quite optimal, as if we need to flush a bank having
a very long list of sub\-banks, the number of requests to build the sub\-tree may grow quite big.
.sp
An improvement for this would be loading a custom Lua script in the Redis instance of the user
(using the \fBregister_script\fP feature) and call it whenever we flush.
This script would only need to build this sub\-tree causing problems. It can be added later and the behaviour
should not change as the user needs to explicitly allow Salt inject scripts in their Redis instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.redis_cache.init_kwargs(kwargs)
Effectively a noop. Return an empty dictionary.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.redis_cache.list_(bank)
Lists entries stored in the specified bank.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.redis_cache.store(bank, key, data)
Store the data in a Redis key.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cache.redis_cache.updated(bank, key)
Return the Unix Epoch timestamp of when the key was last updated. Return
None if key is not found.
.UNINDENT
.SS cloud modules
.TS
center;
|l|l|.
_
T{
\fI\%aliyun\fP
T}	T{
AliYun ECS Cloud Module
T}
_
T{
\fI\%clc\fP
T}	T{
CenturyLink Cloud Module
T}
_
T{
\fI\%cloudstack\fP
T}	T{
CloudStack Cloud Module
T}
_
T{
\fI\%digitalocean\fP
T}	T{
DigitalOcean Cloud Module
T}
_
T{
\fI\%dimensiondata\fP
T}	T{
Dimension Data Cloud Module
T}
_
T{
\fI\%ec2\fP
T}	T{
The EC2 Cloud Module
T}
_
T{
\fI\%gce\fP
T}	T{
Copyright 2013 Google Inc.
T}
_
T{
\fI\%gogrid\fP
T}	T{
GoGrid Cloud Module
T}
_
T{
\fI\%hetzner\fP
T}	T{
Hetzner Cloud Module
T}
_
T{
\fI\%joyent\fP
T}	T{
Joyent Cloud Module
T}
_
T{
\fI\%libvirt\fP
T}	T{
Libvirt Cloud Module
T}
_
T{
\fI\%linode\fP
T}	T{
The Linode Cloud Module
T}
_
T{
\fI\%lxc\fP
T}	T{
Install Salt on an LXC Container
T}
_
T{
\fI\%oneandone\fP
T}	T{
1&1 Cloud Server Module
T}
_
T{
\fI\%opennebula\fP
T}	T{
OpenNebula Cloud Module
T}
_
T{
\fI\%openstack\fP
T}	T{
Openstack Cloud Driver
T}
_
T{
\fI\%packet\fP
T}	T{
Packet Cloud Module Using Packet\(aqs Python API Client
T}
_
T{
\fI\%parallels\fP
T}	T{
Parallels Cloud Module
T}
_
T{
\fI\%profitbricks\fP
T}	T{
ProfitBricks Cloud Module
T}
_
T{
\fI\%proxmox\fP
T}	T{
T}
_
T{
\fI\%pyrax\fP
T}	T{
Pyrax Cloud Module
T}
_
T{
\fI\%qingcloud\fP
T}	T{
QingCloud Cloud Module
T}
_
T{
\fI\%saltify\fP
T}	T{
T}
_
T{
\fI\%scaleway\fP
T}	T{
Scaleway Cloud Module
T}
_
T{
\fI\%softlayer\fP
T}	T{
SoftLayer Cloud Module
T}
_
T{
\fI\%softlayer_hw\fP
T}	T{
SoftLayer HW Cloud Module
T}
_
T{
\fI\%tencentcloud\fP
T}	T{
Tencent Cloud Cloud Module
T}
_
T{
\fI\%vagrant\fP
T}	T{
Vagrant Cloud Driver
T}
_
T{
\fI\%virtualbox\fP
T}	T{
A salt cloud provider that lets you use virtualbox on your machine and act as a cloud.
T}
_
T{
\fI\%vmware\fP
T}	T{
VMware Cloud Module
T}
_
T{
\fI\%vultrpy\fP
T}	T{
Vultr Cloud Module using python\-vultr bindings
T}
_
T{
\fI\%xen\fP
T}	T{
XenServer Cloud Driver
T}
_
.TE
.SS salt.cloud.clouds.aliyun
.SS AliYun ECS Cloud Module
.sp
New in version 2014.7.0.

.sp
The Aliyun cloud module is used to control access to the aliyun ECS.
\fI\%http://www.aliyun.com/\fP
.sp
Use of this module requires the \fBid\fP and \fBkey\fP parameter to be set.
Set up the cloud configuration at \fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/aliyun.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-aliyun\-config:
  # aliyun Access Key ID
  id: wFGEwgregeqw3435gDger
  # aliyun Access Key Secret
  key: GDE43t43REGTrkilg43934t34qT43t4dgegerGEgg
  location: cn\-qingdao
  driver: aliyun
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
requests
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.avail_images(kwargs=None, call=None)
Return a list of the images that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.avail_locations(call=None)
Return a dict of all available VM locations on the cloud provider with
relevant data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.avail_sizes(call=None)
Return a list of the image sizes that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.create(vm_)
Create a single VM from a data dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.create_node(kwargs)
Convenience function to make the rest api call for node creation.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.destroy(name, call=None)
Destroy a node.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a destroy myinstance
salt\-cloud \-d myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.get_image(vm_)
Return the image object to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.get_location(vm_=None)
.INDENT 7.0
.TP
.B Return the aliyun region to use, in this order:
.INDENT 7.0
.IP \(bu 2
CLI parameter
.IP \(bu 2
VM parameter
.IP \(bu 2
Cloud profile setting
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.get_securitygroup(vm_)
Return the security group
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.get_size(vm_)
Return the VM\(aqs size. Used by create_node().
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.list_availability_zones(call=None)
List all availability zones in the current region
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.list_monitor_data(kwargs=None, call=None)
Get monitor data of the instance. If instance name is
missing, will show all the instance monitor data on the region.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_monitor_data aliyun
salt\-cloud \-f list_monitor_data aliyun name=AY14051311071990225bd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.list_nodes(call=None)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.list_nodes_full(call=None)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.list_nodes_min(call=None)
Return a list of the VMs that are on the provider. Only a list of VM names,
and their state, is returned. This is the minimum amount of information
needed to check for existing VMs.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.list_nodes_select(call=None)
Return a list of the VMs that are on the provider, with select fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.list_securitygroup(call=None)
Return a list of security group
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.query(params=None)
Make a web call to aliyun ECS REST API
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.reboot(name, call=None)
Reboot a node
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.script(vm_)
Return the script deployment object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.show_disk(name, call=None)
Show the disk details of the instance
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_disk aliyun myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.show_image(kwargs, call=None)
Show the details from aliyun image
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.show_instance(name, call=None)
Show the details from aliyun instance
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.start(name, call=None)
Start a node
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a start myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.aliyun.stop(name, force=False, call=None)
Stop a node
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop myinstance
salt\-cloud \-a stop myinstance force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.cloud.clouds.clc
.SS CenturyLink Cloud Module
.sp
New in version 2018.3.0.

.sp
The CLC cloud module allows you to manage CLC Via the CLC SDK.
.INDENT 0.0
.TP
.B codeauthor
Stephan Looney <\fI\%slooney@stephanlooney.com\fP>
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
clc\-sdk Python Module
.IP \(bu 2
flask
.UNINDENT
.SS CLC SDK
.sp
clc\-sdk can be installed via pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install clc\-sdk
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For sdk reference see: \fI\%https://github.com/CenturyLinkCloud/clc\-python\-sdk\fP
.UNINDENT
.UNINDENT
.SS Flask
.sp
flask can be installed via pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install flask
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configuration
.sp
To use this module: set up the clc\-sdk, user, password, key in the
cloud configuration at
\fB/etc/salt/cloud.providers\fP or \fB/etc/salt/cloud.providers.d/clc.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-clc\-config:
  driver: clc
  user: \(aqweb\-user\(aq
  password: \(aqverybadpass\(aq
  token: \(aq\(aq
  token_pass:\(aq\(aq
  accountalias: \(aqACT\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBprovider\fP parameter in cloud provider configuration was renamed to \fBdriver\fP\&.
This change was made to avoid confusion with the \fBprovider\fP parameter that is
used in cloud profile configuration. Cloud provider configuration now uses \fBdriver\fP
to refer to the salt\-cloud driver that provides the underlying functionality to
connect to a cloud provider, while cloud profile configuration continues to use
\fBprovider\fP to refer to the cloud provider configuration that you define.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.clc.avail_images(call=None)
returns a list of images available to you
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.clc.avail_locations(call=None)
returns a list of locations available to you
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.clc.avail_sizes(call=None)
use templates for this
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.clc.create(vm_)
get the system build going
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.clc.destroy(name, call=None)
destroy the vm
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.clc.get_build_status(req_id, nodename)
get the build status from CLC to make sure we don\(aqt return to early
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.clc.get_configured_provider()
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.clc.get_creds()
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.clc.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.clc.get_group_estimate(call=None, for_output=True, **kwargs)
Return a list of the VMs that are on the provider
usage: \(dqsalt\-cloud \-f get_group_estimate clc group=Dev location=VA1\(dq
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.clc.get_month_to_date(call=None, for_output=True)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.clc.get_monthly_estimate(call=None, for_output=True)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.clc.get_queue_data(call=None, for_output=True)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.clc.get_server_alerts(call=None, for_output=True, **kwargs)
Return a list of alerts from CLC as reported by their infra
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.clc.list_nodes_full(call=None, for_output=True)
Return a list of the VMs that are on the provider
.UNINDENT
.SS salt.cloud.clouds.cloudstack
.SS CloudStack Cloud Module
.sp
The CloudStack cloud module is used to control access to a CloudStack based
Public Cloud.
.INDENT 0.0
.TP
.B depends
libcloud >= 0.15
.UNINDENT
.sp
Use of this module requires the \fBapikey\fP, \fBsecretkey\fP, \fBhost\fP and
\fBpath\fP parameters.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-cloudstack\-cloud\-config:
  apikey: <your api key >
  secretkey: <your secret key >
  host: localhost
  path: /client/api
  driver: cloudstack
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.avail_images(conn=None, call=None)
Return a dict of all available VM images on the cloud provider with
relevant data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.avail_locations(conn=None, call=None)
Return a dict of all available VM locations on the cloud provider with
relevant data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.avail_sizes(conn=None, call=None)
Return a dict of all available VM images on the cloud provider with
relevant data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.block_device_mappings(vm_)
Return the block device mapping:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[{\(aqDeviceName\(aq: \(aq/dev/sdb\(aq, \(aqVirtualName\(aq: \(aqephemeral0\(aq},
  {\(aqDeviceName\(aq: \(aq/dev/sdc\(aq, \(aqVirtualName\(aq: \(aqephemeral1\(aq}]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.cloudstack_displayname(vm_)
Return display name of VM:
.INDENT 7.0
.TP
.B ::
\(dqminion1\(dq
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.create(vm_)
Create a single VM from a data dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.destroy(name, conn=None, call=None)
Delete a single VM, and all of its volumes
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.get_conn()
Return a conn object for the passed VM data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.get_image(conn, vm_)
Return the image object to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.get_ip(data)
Return the IP address of the VM
If the VM has  public IP as defined by libcloud module then use it
Otherwise try to extract the private IP and use that one.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.get_key()
Returns the ssh private key for VM access
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.get_keypair(vm_)
Return the keypair to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.get_location(conn, vm_)
Return the node location to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.get_networkid(vm_)
Return the networkid to use, only valid for Advanced Zone
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.get_node(conn, name)
Return a libcloud node for the named VM
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.get_password(vm_)
Return the password to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.get_project(conn, vm_)
Return the project to use.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.get_security_groups(conn, vm_)
Return a list of security groups to use, defaulting to [\(aqdefault\(aq]
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.get_size(conn, vm_)
Return the VM\(aqs size object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.list_nodes(conn=None, call=None)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.list_nodes_full(conn=None, call=None)
Return a list of the VMs that are on the provider, with all fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.list_nodes_select(conn=None, call=None)
Return a list of the VMs that are on the provider, with select fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.script(vm_)
Return the script deployment object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.show_instance(name, call=None)
Show the details from the provider concerning an instance
.UNINDENT
.SS salt.cloud.clouds.digitalocean
.SS DigitalOcean Cloud Module
.sp
The DigitalOcean cloud module is used to control access to the DigitalOcean VPS system.
.sp
Use of this module requires a requires a \fBpersonal_access_token\fP, an \fBssh_key_file\fP,
and at least one SSH key name in \fBssh_key_names\fP\&. More \fBssh_key_names\fP can be added
by separating each key with a comma. The \fBpersonal_access_token\fP can be found in the
DigitalOcean web interface in the \(dqApps & API\(dq section. The SSH key name can be found
under the \(dqSSH Keys\(dq section.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example is for /etc/salt/cloud.providers or any file in the
# /etc/salt/cloud.providers.d/ directory.

my\-digital\-ocean\-config:
  personal_access_token: xxx
  ssh_key_file: /path/to/ssh/key/file
  ssh_key_names: my\-key\-name,my\-key\-name\-2
  driver: digitalocean
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
requests
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.assign_floating_ip(kwargs=None, call=None)
Assign a floating IP
.sp
New in version 2016.3.0.

.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f assign_floating_ip my\-digitalocean\-config droplet_id=1234567 floating_ip=\(aq45.55.96.47\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.avail_images(call=None)
Return a list of the images that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.avail_locations(call=None)
Return a dict of all available VM locations on the cloud provider with
relevant data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.avail_sizes(call=None)
Return a list of the image sizes that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.create(vm_)
Create a single VM from a data dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.create_floating_ip(kwargs=None, call=None)
Create a new floating IP
.sp
New in version 2016.3.0.

.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_floating_ip my\-digitalocean\-config region=\(aqNYC2\(aq

salt\-cloud \-f create_floating_ip my\-digitalocean\-config droplet_id=\(aq1234567\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.create_key(kwargs=None, call=None)
Upload a public key
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.create_node(args)
Create a node
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.delete_floating_ip(kwargs=None, call=None)
Delete a floating IP
.sp
New in version 2016.3.0.

.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_floating_ip my\-digitalocean\-config floating_ip=\(aq45.55.96.47\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.destroy(name, call=None)
Destroy a node. Will check termination protection and warn if enabled.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-destroy mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.destroy_dns_records(fqdn)
Deletes DNS records for the given hostname if the domain is managed with DO.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.get_image(vm_)
Return the image object to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.get_keyid(keyname)
Return the ID of the keyname
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.get_location(vm_)
Return the VM\(aqs location
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.get_size(vm_)
Return the VM\(aqs size. Used by create_node().
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.import_keypair(kwargs=None, call=None)
Upload public key to cloud provider.
Similar to EC2 import_keypair.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B kwargs
file(mandatory): public key file\-name
keyname(mandatory): public key name in the provider
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.list_floating_ips(call=None)
Return a list of the floating ips that are on the provider
.sp
New in version 2016.3.0.

.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_floating_ips my\-digitalocean\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.list_keypairs(call=None)
Return a dict of all available VM locations on the cloud provider with
relevant data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.list_nodes(call=None)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.list_nodes_full(call=None, for_output=True)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.list_nodes_select(call=None)
Return a list of the VMs that are on the provider, with select fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.post_dns_record(**kwargs)
Creates a DNS record for the given name if the domain is managed with DO.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.query(method=\(aqdroplets\(aq, droplet_id=None, command=None, args=None, http_method=\(aqget\(aq)
Make a web call to DigitalOcean
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.reboot(name, call=None)
Reboot a droplet in DigitalOcean.
.sp
New in version 2015.8.8.

.INDENT 7.0
.TP
.B name
The name of the droplet to restart.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot droplet_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.remove_key(kwargs=None, call=None)
Delete public key
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.script(vm_)
Return the script deployment object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.show_floating_ip(kwargs=None, call=None)
Show the details of a floating IP
.sp
New in version 2016.3.0.

.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_floating_ip my\-digitalocean\-config floating_ip=\(aq45.55.96.47\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.show_instance(name, call=None)
Show the details from DigitalOcean concerning a droplet
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.show_keypair(kwargs=None, call=None)
Show the details of an SSH keypair
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.show_pricing(kwargs=None, call=None)
Show pricing for a particular profile. This is only an estimate, based on
unofficial pricing sources.
.sp
New in version 2015.8.0.

.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_pricing my\-digitalocean\-config profile=my\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.start(name, call=None)
Start a droplet in DigitalOcean.
.sp
New in version 2015.8.8.

.INDENT 7.0
.TP
.B name
The name of the droplet to start.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a start droplet_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.stop(name, call=None)
Stop a droplet in DigitalOcean.
.sp
New in version 2015.8.8.

.INDENT 7.0
.TP
.B name
The name of the droplet to stop.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop droplet_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.digitalocean.unassign_floating_ip(kwargs=None, call=None)
Unassign a floating IP
.sp
New in version 2016.3.0.

.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f unassign_floating_ip my\-digitalocean\-config floating_ip=\(aq45.55.96.47\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.cloud.clouds.dimensiondata
.SS Dimension Data Cloud Module
.sp
This is a cloud module for the Dimension Data Cloud,
using the existing Libcloud driver for Dimension Data.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note: This example is for /etc/salt/cloud.providers
# or any file in the
# /etc/salt/cloud.providers.d/ directory.

my\-dimensiondata\-config:
  user_id: my_username
  key: myPassword!
  region: dd\-na
  driver: dimensiondata
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B maintainer
Anthony Shaw <\fI\%anthonyshaw@apache.org\fP>
.TP
.B depends
libcloud >= 1.2.1
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.avail_images(conn=None, call=None)
Return a dict of all available VM images on the cloud provider with
relevant data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.avail_locations(conn=None, call=None)
Return a dict of all available VM locations on the cloud provider with
relevant data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.avail_sizes(conn=None, call=None)
Return a dict of all available VM images on the cloud provider with
relevant data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.create(vm_)
Create a single VM from a data dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.create_lb(kwargs=None, call=None)
Create a load\-balancer configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_lb dimensiondata \e
    name=dev\-lb port=80 protocol=http \e
    members=w1,w2,w3 algorithm=ROUND_ROBIN
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.destroy(name, conn=None, call=None)
Delete a single VM
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.get_conn()
Return a conn object for the passed VM data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.get_image(conn, vm_)
Return the image object to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.get_lb_conn(dd_driver=None)
Return a load\-balancer conn object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.get_node(conn, name)
Return a libcloud node for the named VM
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.get_size(conn, vm_)
Return the VM\(aqs size object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.list_nodes(conn=None, call=None)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.list_nodes_full(conn=None, call=None)
Return a list of the VMs that are on the provider, with all fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.list_nodes_select(conn=None, call=None)
Return a list of the VMs that are on the provider, with select fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.preferred_ip(vm_, ips)
Return the preferred Internet protocol. Either \(aqipv4\(aq (default) or \(aqipv6\(aq.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.reboot(name, conn=None)
Reboot a single VM
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.script(vm_)
Return the script deployment object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.show_instance(name, call=None)
Show the details from the provider concerning an instance
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.ssh_interface(vm_)
Return the ssh_interface type to connect to. Either \(aqpublic_ips\(aq (default)
or \(aqprivate_ips\(aq.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.start(name, call=None)
Stop a VM in DimensionData.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the VM to stop.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.dimensiondata.stop(name, call=None)
Stop a VM in DimensionData.
.INDENT 7.0
.TP
.B name:
The name of the VM to stop.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.cloud.clouds.ec2
.SS The EC2 Cloud Module
.sp
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
.INDENT 0.0
.TP
.B To use the EC2 cloud module, set up the cloud configuration at
\fB/etc/salt/cloud.providers\fP or \fB/etc/salt/cloud.providers.d/ec2.conf\fP:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  # EC2 API credentials: Access Key ID and Secret Access Key.
  # Alternatively, to use IAM Instance Role credentials available via
  # EC2 metadata set both id and key to \(aquse\-instance\-role\-credentials\(aq
  id: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

  # If \(aqrole_arn\(aq is specified the above credentials are used to
  # to assume to the role. By default, role_arn is set to None.
  role_arn: arn:aws:iam::012345678910:role/SomeRoleName

  # The ssh keyname to use
  keyname: default
  # The amazon security group
  securitygroup: ssh_open
  # The location of the private key which corresponds to the keyname
  private_key: /root/default.pem

  # Be default, service_url is set to amazonaws.com. If you are using this
  # driver for something other than Amazon EC2, change it here:
  service_url: amazonaws.com

  # The endpoint that is ultimately used is usually formed using the region
  # and the service_url. If you would like to override that entirely, you
  # can explicitly define the endpoint:
  endpoint: myendpoint.example.com:1138/services/Cloud

  # SSH Gateways can be used with this provider. Gateways can be used
  # when a salt\-master is not on the same private network as the instance
  # that is being deployed.

  # Defaults to None
  # Required
  ssh_gateway: gateway.example.com

  # Defaults to port 22
  # Optional
  ssh_gateway_port: 22

  # Defaults to root
  # Optional
  ssh_gateway_username: root

  # Default to nc \-q0 %h %p
  # Optional
  ssh_gateway_command: \(dq\-W %h:%p\(dq

  # One authentication method is required. If both
  # are specified, Private key wins.

  # Private key defaults to None
  ssh_gateway_private_key: /path/to/key.pem

  # Password defaults to None
  ssh_gateway_password: ExamplePasswordHere

  driver: ec2

  # Pass userdata to the instance to be created
  userdata_file: /etc/salt/my\-userdata\-file

  # Instance termination protection setting
  # Default is disabled
  termination_protection: False
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
requests
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.attach_volume(name=None, kwargs=None, instance_id=None, call=None)
Attach a volume to an instance
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.avail_images(kwargs=None, call=None)
Return a dict of all available VM images on the cloud provider.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.avail_locations(call=None)
List all available locations
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.avail_sizes(call=None)
Return a dict of all available VM sizes on the cloud provider with
relevant data. Latest version can be found at:
.sp
\fI\%http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance\-types.html\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.block_device_mappings(vm_)
Return the block device mapping:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[{\(aqDeviceName\(aq: \(aq/dev/sdb\(aq, \(aqVirtualName\(aq: \(aqephemeral0\(aq},
  {\(aqDeviceName\(aq: \(aq/dev/sdc\(aq, \(aqVirtualName\(aq: \(aqephemeral1\(aq}]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.copy_snapshot(kwargs=None, call=None)
Copy a snapshot
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.create(vm_=None, call=None)
Create a single VM from a data dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.create_attach_volumes(name, kwargs, call=None, wait_to_finish=True)
Create and attach volumes to created node
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.create_keypair(kwargs=None, call=None)
Create an SSH keypair
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.create_snapshot(kwargs=None, call=None, wait_to_finish=False)
Create a snapshot.
.INDENT 7.0
.TP
.B volume_id
The ID of the Volume from which to create a snapshot.
.TP
.B description
The optional description of the snapshot.
.UNINDENT
.sp
CLI Exampe:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_snapshot my\-ec2\-config volume_id=vol\-351d8826
salt\-cloud \-f create_snapshot my\-ec2\-config volume_id=vol\-351d8826 \e
    description=\(dqMy Snapshot Description\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.create_volume(kwargs=None, call=None, wait_to_finish=False)
Create a volume.
.INDENT 7.0
.TP
.B zone
The availability zone used to create the volume. Required. String.
.TP
.B size
The size of the volume, in GiBs. Defaults to \fB10\fP\&. Integer.
.TP
.B snapshot
The snapshot\-id from which to create the volume. Integer.
.TP
.B type
The volume type. This can be \fBgp2\fP for General Purpose SSD, \fBio1\fP or
\fBio2\fP for Provisioned IOPS SSD, \fBst1\fP for Throughput Optimized HDD,
\fBsc1\fP for Cold HDD, or \fBstandard\fP for Magnetic volumes. String.
.TP
.B iops
The number of I/O operations per second (IOPS) to provision for the volume,
with a maximum ratio of 50 IOPS/GiB. Only valid for Provisioned IOPS SSD
volumes. Integer.
.sp
This option will only be set if \fBtype\fP is also specified as \fBio1\fP or
\fBio2\fP
.TP
.B encrypted
Specifies whether the volume will be encrypted. Boolean.
.sp
If \fBsnapshot\fP is also given in the list of kwargs, then this value is ignored
since volumes that are created from encrypted snapshots are also automatically
encrypted.
.TP
.B tags
The tags to apply to the volume during creation. Dictionary.
.TP
.B call
The \fBcreate_volume\fP function must be called with \fB\-f\fP or \fB\-\-function\fP\&.
String.
.TP
.B wait_to_finish
Whether or not to wait for the volume to be available. Boolean. Defaults to
\fBFalse\fP\&.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_volume my\-ec2\-config zone=us\-east\-1b
salt\-cloud \-f create_volume my\-ec2\-config zone=us\-east\-1b tags=\(aq{\(dqtag1\(dq: \(dqval1\(dq, \(dqtag2\(dq, \(dqval2\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.del_tags(name=None, kwargs=None, call=None, instance_id=None, resource_id=None)
Delete tags for a resource. Normally a VM name or instance_id is passed in,
but a resource_id may be passed instead. If both are passed in, the
instance_id will be used.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a del_tags mymachine tags=mytag,
salt\-cloud \-a del_tags mymachine tags=tag1,tag2,tag3
salt\-cloud \-a del_tags resource_id=vol\-3267ab32 tags=tag1,tag2,tag3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.delete_keypair(kwargs=None, call=None)
Delete an SSH keypair
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.delete_snapshot(kwargs=None, call=None)
Delete a snapshot
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.delete_volume(name=None, kwargs=None, instance_id=None, call=None)
Delete a volume
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.delvol_on_destroy(name, kwargs=None, call=None)
Delete all/specified EBS volumes upon instance termination
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a delvol_on_destroy mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.describe_snapshots(kwargs=None, call=None)
Describe a snapshot (or snapshots)
.INDENT 7.0
.TP
.B snapshot_id
One or more snapshot IDs. Multiple IDs must be separated by \(dq,\(dq.
.TP
.B owner
Return the snapshots owned by the specified owner. Valid values
include: self, amazon, <AWS Account ID>. Multiple values must be
separated by \(dq,\(dq.
.TP
.B restorable_by
One or more AWS accounts IDs that can create volumes from the snapshot.
Multiple aws account IDs must be separated by \(dq,\(dq.
.UNINDENT
.sp
TODO: Add all of the filters.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.describe_volumes(kwargs=None, call=None)
Describe a volume (or volumes)
.INDENT 7.0
.TP
.B volume_id
One or more volume IDs. Multiple IDs must be separated by \(dq,\(dq.
.UNINDENT
.sp
TODO: Add all of the filters.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.destroy(name, call=None)
Destroy a node. Will check termination protection and warn if enabled.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-destroy mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.detach_volume(name=None, kwargs=None, instance_id=None, call=None)
Detach a volume from an instance
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.disable_detailed_monitoring(name, call=None)
Enable/disable detailed monitoring on a node
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.disable_term_protect(name, call=None)
Disable termination protection on a node
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a disable_term_protect mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.enable_detailed_monitoring(name, call=None)
Enable/disable detailed monitoring on a node
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.enable_term_protect(name, call=None)
Enable termination protection on a node
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a enable_term_protect mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.get_availability_zone(vm_)
Return the availability zone to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.get_console_output(name=None, location=None, instance_id=None, call=None, kwargs=None)
Show the console output from the instance.
.sp
By default, returns decoded data, not the Base64\-encoded data that is
actually returned from the EC2 API.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.get_imageid(vm_)
Returns the ImageId to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.get_location(vm_=None)
.INDENT 7.0
.TP
.B Return the EC2 region to use, in this order:
.INDENT 7.0
.IP \(bu 2
CLI parameter
.IP \(bu 2
VM parameter
.IP \(bu 2
Cloud profile setting
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.get_password_data(name=None, kwargs=None, instance_id=None, call=None)
Return password data for a Windows instance.
.sp
By default only the encrypted password data will be returned. However, if a
key_file is passed in, then a decrypted password will also be returned.
.sp
Note that the key_file references the private key that was used to generate
the keypair associated with this instance. This private key will _not_ be
transmitted to Amazon; it is only used internally inside of Salt Cloud to
decrypt data _after_ it has been received from Amazon.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a get_password_data mymachine
salt\-cloud \-a get_password_data mymachine key_file=/root/ec2key.pem
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note: PKCS1_v1_5 was added in PyCrypto 2.5
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.get_placementgroup(vm_)
Returns the PlacementGroup to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.get_provider(vm_=None)
Extract the provider name from vm
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.get_spot_config(vm_)
Returns the spot instance configuration for the provided vm
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.get_ssh_gateway_config(vm_)
Return the ssh_gateway configuration.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.get_subnetid(vm_)
Returns the SubnetId to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.get_tags(name=None, instance_id=None, call=None, location=None, kwargs=None, resource_id=None)
Retrieve tags for a resource. Normally a VM name or instance_id is passed
in, but a resource_id may be passed instead. If both are passed in, the
instance_id will be used.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a get_tags mymachine
salt\-cloud \-a get_tags resource_id=vol\-3267ab32
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.get_tenancy(vm_)
Returns the Tenancy to use.
.sp
Can be \(dqdedicated\(dq or \(dqdefault\(dq. Cannot be present for spot instances.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.iam_profile(vm_)
Return the IAM profile.
.sp
The IAM instance profile to associate with the instances.
This is either the Amazon Resource Name (ARN) of the instance profile
or the name of the role.
.sp
Type: String
.sp
Default: None
.sp
Required: No
.sp
Example: arn:aws:iam::111111111111:instance\-profile/s3access
.sp
Example: s3access
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.import_keypair(kwargs=None, call=None)
Import an SSH public key.
.sp
New in version 2015.8.3.

.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.keepvol_on_destroy(name, kwargs=None, call=None)
Do not delete all/specified EBS volumes upon instance termination
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a keepvol_on_destroy mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.keyname(vm_)
Return the keyname
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.list_availability_zones(vm_=None)
List all availability zones in the current region
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.list_nodes(call=None)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.list_nodes_full(location=None, call=None)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.list_nodes_min(location=None, call=None)
Return a list of the VMs that are on the provider. Only a list of VM names,
and their state, is returned. This is the minimum amount of information
needed to check for existing VMs.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.list_nodes_select(call=None)
Return a list of the VMs that are on the provider, with select fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.optimize_providers(providers)
Return an optimized list of providers.
.sp
We want to reduce the duplication of querying
the same region.
.sp
If a provider is using the same credentials for the same region
the same data will be returned for each provider, thus causing
un\-wanted duplicate data and API calls to EC2.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.query(params=None, setname=None, requesturl=None, location=None, return_url=False, return_root=False)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.query_instance(vm_=None, call=None)
Query an instance upon creation from the EC2 API
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.queue_instances(instances)
Queue a set of instances to be provisioned later. Expects a list.
.sp
Currently this only queries node data, and then places it in the cloud
cache (if configured). If the salt\-cloud\-reactor is being used, these
instances will be automatically provisioned using that.
.sp
For more information about the salt\-cloud\-reactor, see:
.sp
\fI\%https://github.com/saltstack\-formulas/salt\-cloud\-reactor\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.reboot(name, call=None)
Reboot a node.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.register_image(kwargs=None, call=None)
Create an ami from a snapshot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f register_image my\-ec2\-config ami_name=my_ami description=\(dqmy description\(dq
        root_device_name=/dev/xvda snapshot_id=snap\-xxxxxxxx
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.rename(name, kwargs, call=None)
Properly rename a node. Pass in the new name as \(dqnew name\(dq.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a rename mymachine newname=yourmachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.request_instance(vm_=None, call=None)
Put together all of the information necessary to request an instance on EC2,
and then fire off the request the instance.
.sp
Returns data about the instance
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.script(vm_)
Return the script deployment object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.securitygroup(vm_)
Return the security group
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.securitygroupid(vm_)
Returns the SecurityGroupId
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.set_tags(name=None, tags=None, call=None, location=None, instance_id=None, resource_id=None, kwargs=None)
Set tags for a resource. Normally a VM name or instance_id is passed in,
but a resource_id may be passed instead. If both are passed in, the
instance_id will be used.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a set_tags mymachine tag1=somestuff tag2=\(aqOther stuff\(aq
salt\-cloud \-a set_tags resource_id=vol\-3267ab32 tag=somestuff
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.show_delvol_on_destroy(name, kwargs=None, call=None)
Do not delete all/specified EBS volumes upon instance termination
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_delvol_on_destroy mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.show_detailed_monitoring(name=None, instance_id=None, call=None, quiet=False)
Show the details from EC2 regarding cloudwatch detailed monitoring.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.show_image(kwargs, call=None)
Show the details from EC2 concerning an AMI
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.show_instance(name=None, instance_id=None, call=None, kwargs=None)
Show the details from EC2 concerning an AMI.
.sp
Can be called as an action (which requires a name):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_instance myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\&...or as a function (which requires either a name or instance_id):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_instance my\-ec2 name=myinstance
salt\-cloud \-f show_instance my\-ec2 instance_id=i\-d34db33f
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.show_keypair(kwargs=None, call=None)
Show the details of an SSH keypair
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.show_pricing(kwargs=None, call=None)
Show pricing for a particular profile. This is only an estimate, based on
unofficial pricing sources.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_pricing my\-ec2\-config profile=my\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If pricing sources have not been cached, they will be downloaded. Once they
have been cached, they will not be updated automatically. To manually update
all prices, use the following command:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f update_pricing <provider>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.show_term_protect(name=None, instance_id=None, call=None, quiet=False)
Show the details from EC2 concerning an instance\(aqs termination protection state
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.show_volume(kwargs=None, call=None)
Wrapper around describe_volumes.
Here just to keep functionality.
Might be depreciated later.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.sign(key, msg)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.ssh_interface(vm_)
Return the ssh_interface type to connect to. Either \(aqpublic_ips\(aq (default)
or \(aqprivate_ips\(aq.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.ssm_create_association(name=None, kwargs=None, instance_id=None, call=None)
Associates the specified SSM document with the specified instance
.sp
\fI\%http://docs.aws.amazon.com/ssm/latest/APIReference/API_CreateAssociation.html\fP
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a ssm_create_association ec2\-instance\-name ssm_document=ssm\-document\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.ssm_describe_association(name=None, kwargs=None, instance_id=None, call=None)
Describes the associations for the specified SSM document or instance.
.sp
\fI\%http://docs.aws.amazon.com/ssm/latest/APIReference/API_DescribeAssociation.html\fP
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a ssm_describe_association ec2\-instance\-name ssm_document=ssm\-document\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.start(name, call=None)
Start a node
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.stop(name, call=None)
Stop a node
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.update_pricing(kwargs=None, call=None)
Download most recent pricing information from AWS and convert to a local
JSON file.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f update_pricing my\-ec2\-config
salt\-cloud \-f update_pricing my\-ec2\-config type=linux
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.volume_create(**kwargs)
Wrapper around create_volume.
Here just to ensure the compatibility with the cloud module.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.volume_list(**kwargs)
Wrapper around describe_volumes.
Here just to ensure the compatibility with the cloud module.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.ec2.wait_for_instance(vm_=None, data=None, ip_address=None, display_ssh_output=True, call=None)
Wait for an instance upon creation from the EC2 API, to become available
.UNINDENT
.SS salt.cloud.clouds.gce
.sp
Copyright 2013 Google Inc. All Rights Reserved.
.sp
Licensed under the Apache License, Version 2.0 (the \(dqLicense\(dq);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
.INDENT 0.0
.INDENT 3.5
\fI\%http://www.apache.org/licenses/LICENSE\-2.0\fP
.UNINDENT
.UNINDENT
.sp
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an \(dqAS IS\(dq BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
.SS Google Compute Engine Module
.sp
The Google Compute Engine module. This module interfaces with Google Compute
Engine (GCE). To authenticate to GCE, you will need to create a Service Account.
To set up Service Account Authentication, follow the \fI\%Google Compute Engine Setup\fP instructions.
.SS Example Provider Configuration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-gce\-config:
  # The Google Cloud Platform Project ID
  project: \(dqmy\-project\-id\(dq
  # The Service Account client ID
  service_account_email_address: 1234567890@developer.gserviceaccount.com
  # The location of the private key (PEM format)
  service_account_private_key: /home/erjohnso/PRIVKEY.pem
  driver: gce
  # Specify whether to use public or private IP for deploy script.
  # Valid options are:
  #     private_ips \- The salt\-master is also hosted with GCE
  #     public_ips \- The salt\-master is hosted outside of GCE
  ssh_interface: public_ips
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B maintainer
Eric Johnson <\fI\%erjohnso@google.com\fP>
.TP
.B maintainer
Russell Tolle <\fI\%russ.tolle@gmail.com\fP>
.TP
.B depends
libcloud >= 1.0.0
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.attach_disk(name=None, kwargs=None, call=None)
Attach an existing disk to an existing instance.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a attach_disk myinstance disk_name=mydisk mode=READ_WRITE
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.attach_lb(kwargs=None, call=None)
Add an existing node/member to an existing load\-balancer configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f attach_lb gce name=lb member=myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.avail_images(conn=None)
Return a dict of all available VM images on the cloud provider with
relevant data.
.sp
Note that for GCE, there are custom images within the project, but the
generic images are in other projects.  This returns a dict of images in
the project plus images in well\-known public projects that provide supported
images, as listed on this page:
\fI\%https://cloud.google.com/compute/docs/operating\-systems/\fP
.sp
If image names overlap, the image in the current project is used.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.avail_locations(conn=None, call=None)
Return a dict of all available VM locations on the cloud provider with
relevant data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.avail_sizes(conn=None)
Return a dict of available instances sizes (a.k.a machine types) and
convert them to something more serializable.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.create(vm_=None, call=None)
Create a single GCE instance from a data dict.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.create_address(kwargs=None, call=None)
Create a static address in a region.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_address gce name=my\-ip region=us\-central1 address=IP
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.create_attach_volumes(name, kwargs, call=None)
New in version 2017.7.0.

.sp
Create and attach multiple volumes to a node. The \(aqvolumes\(aq and \(aqnode\(aq
arguments are required, where \(aqnode\(aq is a libcloud node, and \(aqvolumes\(aq
is a list of maps, where each map contains:
.INDENT 7.0
.TP
.B size
The size of the new disk in GB. Required.
.TP
.B type
The disk type, either pd\-standard or pd\-ssd. Optional, defaults to pd\-standard.
.TP
.B image
An image to use for this new disk. Optional.
.TP
.B snapshot
A snapshot to use for this new disk. Optional.
.TP
.B auto_delete
An option(bool) to keep or remove the disk upon instance deletion.
Optional, defaults to False.
.UNINDENT
.sp
Volumes are attached in the order in which they are given, thus on a new
node the first volume will be /dev/sdb, the second /dev/sdc, and so on.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.create_disk(kwargs=None, call=None)
Create a new persistent disk. Must specify \fIdisk_name\fP and \fIlocation\fP,
and optionally can specify \(aqdisk_type\(aq as pd\-standard or pd\-ssd, which
defaults to pd\-standard. Can also specify an \fIimage\fP or \fIsnapshot\fP but
if neither of those are specified, a \fIsize\fP (in GB) is required.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_disk gce disk_name=pd size=300 location=us\-central1\-b
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.create_fwrule(kwargs=None, call=None)
Create a GCE firewall rule. The \(aqdefault\(aq network is used if not specified.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_fwrule gce name=allow\-http allow=tcp:80
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.create_hc(kwargs=None, call=None)
Create an HTTP health check configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_hc gce name=hc path=/healthy port=80
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.create_lb(kwargs=None, call=None)
Create a load\-balancer configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_lb gce name=lb region=us\-central1 ports=80
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.create_network(kwargs=None, call=None)
Changed in version 2017.7.0.

.sp
Create a GCE network. Must specify name and cidr.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_network gce name=mynet cidr=10.10.10.0/24 mode=legacy description=optional
salt\-cloud \-f create_network gce name=mynet description=optional
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.create_snapshot(kwargs=None, call=None)
Create a new disk snapshot. Must specify \fIname\fP and  \fIdisk_name\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_snapshot gce name=snap1 disk_name=pd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.create_subnetwork(kwargs=None, call=None)
New in version 2017.7.0.

.sp
Create a GCE Subnetwork. Must specify name, cidr, network, and region.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_subnetwork gce name=mysubnet network=mynet1 region=us\-west1 cidr=10.0.0.0/24 description=optional
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.delete_address(kwargs=None, call=None)
Permanently delete a static address.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_address gce name=my\-ip
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.delete_disk(kwargs=None, call=None)
Permanently delete a persistent disk.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_disk gce disk_name=pd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.delete_fwrule(kwargs=None, call=None)
Permanently delete a firewall rule.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_fwrule gce name=allow\-http
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.delete_hc(kwargs=None, call=None)
Permanently delete a health check.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_hc gce name=hc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.delete_lb(kwargs=None, call=None)
Permanently delete a load\-balancer.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_lb gce name=lb
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.delete_network(kwargs=None, call=None)
Permanently delete a network.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_network gce name=mynet
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.delete_snapshot(kwargs=None, call=None)
Permanently delete a disk snapshot.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_snapshot gce name=disk\-snap\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.delete_subnetwork(kwargs=None, call=None)
New in version 2017.7.0.

.sp
Delete a GCE Subnetwork. Must specify name and region.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_subnetwork gce name=mysubnet network=mynet1 region=us\-west1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.destroy(vm_name, call=None)
Call \(aqdestroy\(aq on the instance.  Can be called with \(dq\-a destroy\(dq or \-d
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a destroy myinstance1 myinstance2 ...
salt\-cloud \-d myinstance1 myinstance2 ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.detach_disk(name=None, kwargs=None, call=None)
Detach a disk from an instance.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a detach_disk myinstance disk_name=mydisk
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.detach_lb(kwargs=None, call=None)
Remove an existing node/member from an existing load\-balancer configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f detach_lb gce name=lb member=myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.get_conn()
Return a conn object for the passed VM data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.get_lb_conn(gce_driver=None)
Return a load\-balancer conn object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.list_nodes(conn=None, call=None)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.list_nodes_full(conn=None, call=None)
Return a list of the VMs that are on the provider, with all fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.list_nodes_select(conn=None, call=None)
Return a list of the VMs that are on the provider, with select fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.reboot(vm_name, call=None)
Call GCE \(aqreset\(aq on the instance.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.request_instance(vm_)
Request a single GCE instance from a data dict.
.sp
Changed in version 2017.7.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.script(vm_)
Return the script deployment object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.show_address(kwargs=None, call=None)
Show the details of an existing static address.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_address gce name=mysnapshot region=us\-central1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.show_disk(name=None, kwargs=None, call=None)
Show the details of an existing disk.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_disk myinstance disk_name=mydisk
salt\-cloud \-f show_disk gce disk_name=mydisk
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.show_fwrule(kwargs=None, call=None)
Show the details of an existing firewall rule.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_fwrule gce name=allow\-http
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.show_hc(kwargs=None, call=None)
Show the details of an existing health check.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_hc gce name=hc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.show_instance(vm_name, call=None)
Show the details of the existing instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.show_lb(kwargs=None, call=None)
Show the details of an existing load\-balancer.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_lb gce name=lb
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.show_network(kwargs=None, call=None)
Show the details of an existing network.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_network gce name=mynet
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.show_pricing(kwargs=None, call=None)
Show pricing for a particular profile. This is only an estimate, based on
unofficial pricing sources.
.sp
New in version 2015.8.0.

.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_pricing my\-gce\-config profile=my\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.show_snapshot(kwargs=None, call=None)
Show the details of an existing snapshot.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_snapshot gce name=mysnapshot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.show_subnetwork(kwargs=None, call=None)
New in version 2017.7.0.

.sp
Show details of an existing GCE Subnetwork. Must specify name and region.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_subnetwork gce name=mysubnet region=us\-west1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.start(vm_name, call=None)
Call GCE \(aqstart on the instance.
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a start myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.stop(vm_name, call=None)
Call GCE \(aqstop\(aq on the instance.
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gce.update_pricing(kwargs=None, call=None)
Download most recent pricing information from GCE and save locally
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f update_pricing my\-gce\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.SS salt.cloud.clouds.gogrid
.SS GoGrid Cloud Module
.sp
The GoGrid cloud module. This module interfaces with the gogrid public cloud
service. To use Salt Cloud with GoGrid log into the GoGrid web interface and
create an api key. Do this by clicking on \(dqMy Account\(dq and then going to the
API Keys tab.
.sp
Set up the cloud configuration at \fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/gogrid.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-gogrid\-config:
  # The generated api key to use
  apikey: asdff7896asdh789
  # The apikey\(aqs shared secret
  sharedsecret: saltybacon
  driver: gogrid
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
A Note about using Map files with GoGrid:
.sp
Due to limitations in the GoGrid API, instances cannot be provisioned in parallel
with the GoGrid driver. Map files will work with GoGrid, but the \fB\-P\fP
argument should not be used on maps referencing GoGrid instances.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
A Note about using Map files with GoGrid:
.sp
Due to limitations in the GoGrid API, instances cannot be provisioned in parallel
with the GoGrid driver. Map files will work with GoGrid, but the \fB\-P\fP
argument should not be used on maps referencing GoGrid instances.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.avail_images()
Available images
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.avail_locations()
Available locations
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.avail_sizes()
Available sizes
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.create(vm_)
Create a single VM from a data dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.destroy(name, call=None)
Destroy a machine by name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-d vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.list_common_lookups(kwargs=None, call=None)
List common lookups for a particular type of item
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.list_nodes(full=False, call=None)
List of nodes, keeping only a brief listing
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-Q
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.list_nodes_full(call=None)
List nodes, with all available information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-F
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.list_nodes_select(call=None)
Return a list of the VMs that are on the provider, with select fields
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-S
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.list_passwords(kwargs=None, call=None)
List all password on the account
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.list_public_ips(kwargs=None, call=None)
List all available public IPs.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_public_ips <provider>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To list unavailable (assigned) IPs, use:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_public_ips <provider> state=assigned
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.reboot(name, call=None)
Reboot a machine by name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.show_instance(name, call=None)
Start a machine by name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_instance vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.start(name, call=None)
Start a machine by name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a start vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.gogrid.stop(name, call=None)
Stop a machine by name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.SS salt.cloud.clouds.hetzner
.SS Hetzner Cloud Module
.sp
The Hetzner cloud module is used to control access to the hetzner cloud.
\fI\%https://docs.hetzner.cloud/\fP
.INDENT 0.0
.TP
.B depends
hcloud >= 1.10
.UNINDENT
.sp
Use of this module requires the \fBkey\fP parameter to be set.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-hetzner\-cloud\-config:
  key: <your api key>
  driver: hetzner
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.avail_images(call=None)
Return a dictionary of available images
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.avail_locations(call=None)
Return a dictionary of available locations
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.avail_sizes(call=None)
Return a dictionary of available VM sizes
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.create(vm_)
Create a single VM from a data dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.destroy(name, call=None)
Destroy a node.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-destroy mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.list_nodes(call=None)
Return a dictionary of existing VMs in the current project, containing basic details of each VM
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.list_nodes_full(call=None)
Return a dictionary of existing VMs in the current project, containing full details per VM
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.list_ssh_keys(call=None)
Return a dictionary of available SSH keys configured in the current project
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.reboot(name, call=None, wait=True)
Reboot a node.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.resize(name, kwargs, call=None)
Resize a node.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a resize mymachine size=...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.show_instance(name, call=None)
Return the details of a specific VM
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.start(name, call=None, wait=True)
Start a node.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a start mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.stop(name, call=None, wait=True)
Stop a node.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.hetzner.wait_until(name, state, timeout=300)
Wait until a specific state has been reached on  a node
.UNINDENT
.SS salt.cloud.clouds.joyent
.SS Joyent Cloud Module
.sp
The Joyent Cloud module is used to interact with the Joyent cloud system.
.sp
Set up the cloud configuration at \fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/joyent.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-joyent\-config:
  driver: joyent
  # The Joyent login user
  user: fred
  # The Joyent user\(aqs password
  password: saltybacon
  # The location of the ssh private key that can log into the new VM
  private_key: /root/mykey.pem
  # The name of the private key
  keyname: mykey
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When creating your profiles for the joyent cloud, add the location attribute to
the profile, this will automatically get picked up when performing tasks
associated with that vm. An example profile might look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
joyent_512:
  provider: my\-joyent\-config
  size: g4\-highcpu\-512M
  image: centos\-6
  location: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This driver can also be used with the Joyent SmartDataCenter project. More
details can be found at:
.sp
Using SDC requires that an api_host_suffix is set. The default value for this is
\fI\&.api.joyentcloud.com\fP\&. All characters, including the leading \fI\&.\fP, should be
included:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
api_host_suffix: .api.myhostname.com
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
PyCrypto
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.avail_images(call=None)
Get list of available images
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Can use a custom URL for images. Default is:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
image_url: images.joyent.com/images
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.avail_locations(call=None)
List all available locations
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.avail_sizes(call=None)
get list of available packages
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-sizes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.create(vm_)
Create a single VM from a data dict
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p profile_name vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.create_node(**kwargs)
convenience function to make the rest api call for node creation.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.delete_key(kwargs=None, call=None)
List the keys available
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f delete_key joyent keyname=mykey
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.destroy(name, call=None)
destroy a machine by name
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name given to the machine
.IP \(bu 2
\fBcall\fP \-\- call value in this case is \(aqaction\(aq
.UNINDENT
.TP
.B Returns
array of booleans , true if successfully stopped and true if
successfully removed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-d vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.get_image(vm_)
Return the image object to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.get_location(vm_=None)
.INDENT 7.0
.TP
.B Return the joyent data center to use, in this order:
.INDENT 7.0
.IP \(bu 2
CLI parameter
.IP \(bu 2
VM parameter
.IP \(bu 2
Cloud profile setting
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.get_location_path(location=\(aqus\-east\-1\(aq, api_host_suffix=\(aq.api.joyentcloud.com\(aq)
create url from location variable
:param location: joyent data center location
:return: url
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.get_node(name)
gets the node from the full node list by name
:param name: name of the vm
:return: node object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.get_size(vm_)
Return the VM\(aqs size object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.has_method(obj, method_name)
Find if the provided object has a specific method
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.import_key(kwargs=None, call=None)
List the keys available
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f import_key joyent keyname=mykey keyfile=/tmp/mykey.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.joyent_node_state(id_)
Convert joyent returned state to state common to other data center return
values for consistency
.INDENT 7.0
.TP
.B Parameters
\fBid\fP \-\- joyent state value
.TP
.B Returns
state value
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.key_list(items=None)
convert list to dictionary using the key as the identifier
:param items: array to iterate over
:return: dictionary
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.list_keys(kwargs=None, call=None)
List the keys available
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.list_nodes(full=False, call=None)
list of nodes, keeping only a brief listing
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-Q
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.list_nodes_full(call=None)
list of nodes, maintaining all content provided from joyent listings
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-F
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.list_nodes_select(call=None)
Return a list of the VMs that are on the provider, with select fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.query(action=None, command=None, args=None, method=\(aqGET\(aq, location=None, data=None)
Make a web call to Joyent
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.query_instance(vm_=None, call=None)
Query an instance upon creation from the Joyent API
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.reboot(name, call=None)
reboot a machine by name
:param name: name given to the machine
:param call: call value in this case is \(aqaction\(aq
:return: true if successful
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.reformat_node(item=None, full=False)
Reformat the returned data from joyent, determine public/private IPs and
strip out fields if necessary to provide either full or brief content.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBitem\fP \-\- node dictionary
.IP \(bu 2
\fBfull\fP \-\- full or brief output
.UNINDENT
.TP
.B Returns
dict
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.show_instance(name, call=None)
get details about a machine
:param name: name given to the machine
:param call: call value in this case is \(aqaction\(aq
:return: machine information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_instance vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.show_key(kwargs=None, call=None)
List the keys available
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.ssh_interface(vm_)
Return the ssh_interface type to connect to. Either \(aqpublic_ips\(aq (default)
or \(aqprivate_ips\(aq.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.start(name, call=None)
start a machine by name
:param name: name given to the machine
:param call: call value in this case is \(aqaction\(aq
:return: true if successful
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a start vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.stop(name, call=None)
stop a machine by name
:param name: name given to the machine
:param call: call value in this case is \(aqaction\(aq
:return: true if successful
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.take_action(name=None, call=None, command=None, data=None, method=\(aqGET\(aq, location=\(aqus\-east\-1\(aq)
take action call used by start,stop, reboot
:param name: name given to the machine
:param call: call value in this case is \(aqaction\(aq
:command: api path
:data: any data to be passed to the api, must be in json format
:method: GET,POST,or DELETE
:location: data center to execute the command on
:return: true if successful
.UNINDENT
.SS salt.cloud.clouds.libvirt
.SS Libvirt Cloud Module
.sp
Example provider:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# A provider maps to a libvirt instance
my\-libvirt\-config:
  driver: libvirt
  # url: \(dqqemu+ssh://user@remotekvm/system?socket=/var/run/libvirt/libvirt\-sock\(dq
  url: qemu:///system
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base\-itest:
  # points back at provider configuration e.g. the libvirt daemon to talk to
  provider: my\-libvirt\-config
  base_domain: base\-image
  # ip_source = [ ip\-learning | qemu\-agent ]
  ip_source: ip\-learning
  # clone_strategy = [ quick | full ]
  clone_strategy: quick
  ssh_username: vagrant
  # has_ssh_agent: True
  password: vagrant
  # if /tmp is mounted noexec do workaround
  deploy_command: sh /tmp/.saltcloud/deploy.sh
  # \-F makes the bootstrap script overwrite existing config
  # which make reprovisioning a box work
  script_args: \-F
  grains:
    sushi: more tasty
  # point at the another master at another port
  minion:
    master: 192.168.16.1
    master_port: 5506
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Tested on:
\- Fedora 26 (libvirt 3.2.1, qemu 2.9.1)
\- Fedora 25 (libvirt 1.3.3.2, qemu 2.6.1)
\- Fedora 23 (libvirt 1.2.18, qemu 2.4.1)
\- Centos 7 (libvirt 1.2.17, qemu 1.5.3)
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.create(vm_)
Provision a single machine
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.create_volume_with_backing_store_xml(volume)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.create_volume_xml(volume)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.destroy(name, call=None)
This function irreversibly destroys a virtual machine on the cloud provider.
Before doing so, it should fire an event on the Salt event bus.
.sp
The tag for this event is \fIsalt/cloud/<vm name>/destroying\fP\&.
Once the virtual machine has been destroyed, another event is fired.
The tag for that event is \fIsalt/cloud/<vm name>/destroyed\fP\&.
.INDENT 7.0
.TP
.B Dependencies:
list_nodes
.UNINDENT
.sp
@param name:
@type name: str
@param call:
@type call:
@return: True if all went well, otherwise an error message
@rtype: bool|str
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.destroy_domain(conn, domain)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.do_cleanup(cleanup)
Clean up clone domain leftovers as much as possible.
.sp
Extra robust clean up in order to deal with some small changes in libvirt
behavior over time. Passed in volumes and domains are deleted, any errors
are ignored. Used when cloning/provisioning a domain fails.
.INDENT 7.0
.TP
.B Parameters
\fBcleanup\fP \-\- list containing dictionaries with two keys: \(aqwhat\(aq and \(aqitem\(aq.
If \(aqwhat\(aq is domain the \(aqitem\(aq is a libvirt domain object.
If \(aqwhat\(aq is volume then the item is a libvirt volume object.
.TP
.B Returns
none
.UNINDENT
.sp
New in version 2017.7.3.

.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.find_pool_and_volume(conn, path)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.generate_new_name(orig_name)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.get_domain_ip(domain, idx, ip_source, skip_loopback=True)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.get_domain_ips(domain, ip_source)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.get_domain_volumes(conn, domain)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.libvirt_error_handler(ctx, error)
Redirect stderr prints from libvirt to salt logging.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.list_nodes(call=None)
Return a list of the VMs
.sp
id (str)
image (str)
size (str)
state (str)
private_ips (list)
public_ips (list)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.list_nodes_full(call=None)
Because this module is not specific to any cloud providers, there will be
no nodes to list.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.list_nodes_select(call=None)
Return a list of the VMs that are on the provider, with select fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.libvirt.to_ip_addr_type(addr_type)
.UNINDENT
.SS salt.cloud.clouds.linode
.SS The Linode Cloud Module
.sp
The Linode cloud module is used to interact with the Linode Cloud.
.SS Provider
.sp
The following provider parameters are supported:
.INDENT 0.0
.IP \(bu 2
\fBapikey\fP: (required) The key to use to authenticate with the Linode API.
.IP \(bu 2
\fBpassword\fP: (required) The default password to set on new VMs. Must be 8 characters with at least one lowercase, uppercase, and numeric.
.IP \(bu 2
\fBpoll_interval\fP: (optional) The rate of time in milliseconds to poll the Linode API for changes. Defaults to \fB500\fP\&.
.IP \(bu 2
\fBratelimit_sleep\fP: (optional) The time in seconds to wait before retrying after a ratelimit has been enforced. Defaults to \fB0\fP\&.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
APIv3 usage has been removed in favor of APIv4. To move to APIv4 now,
See the full migration guide
here \fI\%https://docs.saltproject.io/en/latest/topics/cloud/linode.html#migrating\-to\-apiv4\fP\&.
.UNINDENT
.UNINDENT
.sp
Set up the provider configuration at \fB/etc/salt/cloud.providers\fP or \fB/etc/salt/cloud.providers.d/linode.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-linode\-provider:
    driver: linode
    apikey: f4ZsmwtB1c7f85Jdu43RgXVDFlNjuJaeIYV8QMftTqKScEB2vSosFSr...
    password: F00barbazverylongp@ssword
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Profile
.sp
The following profile parameters are supported:
.INDENT 0.0
.IP \(bu 2
\fBsize\fP: (required) The size of the VM. This should be a Linode instance type ID (i.e. \fBg6\-standard\-2\fP). Run \fBsalt\-cloud \-f avail_sizes my\-linode\-provider\fP for options.
.IP \(bu 2
\fBlocation\fP: (required) The location of the VM. This should be a Linode region (e.g. \fBus\-east\fP). Run \fBsalt\-cloud \-f avail_locations my\-linode\-provider\fP for options.
.IP \(bu 2
\fBimage\fP: (required) The image to deploy the boot disk from. This should be an image ID (e.g. \fBlinode/ubuntu22.04\fP); official images start with \fBlinode/\fP\&. Run \fBsalt\-cloud \-f avail_images my\-linode\-provider\fP for more options.
.IP \(bu 2
\fBpassword\fP: (*required) The default password for the VM. Must be provided at the profile or provider level.
.IP \(bu 2
\fBassign_private_ip\fP: (optional) Whether or not to assign a private IP to the VM. Defaults to \fBFalse\fP\&.
.IP \(bu 2
\fBbackups_enabled\fP: (optional) Whether or not to enable the backup for this VM. Backup can be configured in your Linode account Defaults to \fBFalse\fP\&.
.IP \(bu 2
\fBssh_interface\fP: (optional) The interface with which to connect over SSH. Valid options are \fBprivate_ips\fP or \fBpublic_ips\fP\&. Defaults to \fBpublic_ips\fP\&.
.IP \(bu 2
\fBssh_pubkey\fP: (optional) The public key to authorize for SSH with the VM.
.IP \(bu 2
\fBswap\fP: (optional) The amount of disk space to allocate for the swap partition. Defaults to \fB256\fP\&.
.IP \(bu 2
\fBclonefrom\fP: (optional) The name of the Linode to clone from.
.UNINDENT
.sp
Set up a profile configuration in \fB/etc/salt/cloud.profiles.d/\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-linode\-profile:
    # a minimal configuration
    provider: my\-linode\-provider
    size: g6\-standard\-1
    image: linode/ubuntu22.04
    location: us\-east

my\-linode\-profile\-advanced:
    # an advanced configuration
    provider: my\-linode\-provider
    size: g6\-standard\-3
    image: linode/ubuntu22.04
    location: eu\-west
    password: bogus123X
    assign_private_ip: true
    ssh_interface: private_ips
    ssh_pubkey: ssh\-rsa AAAAB3NzaC1yc2EAAAADAQAB...
    swap_size: 512
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Migrating to APIv4
.sp
You will need to generate a new token for your account. See \fI\%https://www.linode.com/docs/products/tools/api/get\-started/#create\-an\-api\-token\fP
.sp
There are a few changes to note:
\- There has been a general move from label references to ID references. The profile configuration parameters \fBlocation\fP, \fBsize\fP, and \fBimage\fP have moved from being label based references to IDs. See the profile section for more information. In addition to these inputs being changed, \fBavail_sizes\fP, \fBavail_locations\fP, and \fBavail_images\fP now output options sorted by ID instead of label.
\- The \fBdisk_size\fP profile configuration parameter has been deprecated and will not be taken into account when creating new VMs while targeting APIv4.
.INDENT 0.0
.TP
.B maintainer
Linode Developer Tools and Experience Team <\fI\%dev\-dx@linode.com\fP>
.TP
.B depends
requests
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.cloud.clouds.linode.LinodeAPI
.INDENT 7.0
.TP
.B abstract  avail_images()
avail_images implementation
.UNINDENT
.INDENT 7.0
.TP
.B abstract  avail_locations()
avail_locations implementation
.UNINDENT
.INDENT 7.0
.TP
.B abstract  avail_sizes()
avail_sizes implementation
.UNINDENT
.INDENT 7.0
.TP
.B abstract  boot(name=None, kwargs=None)
boot implementation
.UNINDENT
.INDENT 7.0
.TP
.B abstract  clone(kwargs=None)
clone implementation
.UNINDENT
.INDENT 7.0
.TP
.B abstract  create(vm_)
create implementation
.UNINDENT
.INDENT 7.0
.TP
.B abstract  create_config(kwargs=None)
create_config implementation
.UNINDENT
.INDENT 7.0
.TP
.B abstract  destroy(name)
destroy implementation
.UNINDENT
.INDENT 7.0
.TP
.B abstract  get_config_id(kwargs=None)
get_config_id implementation
.UNINDENT
.INDENT 7.0
.TP
.B get_linode(kwargs=None)
.UNINDENT
.INDENT 7.0
.TP
.B abstract  list_nodes()
list_nodes implementation
.UNINDENT
.INDENT 7.0
.TP
.B abstract  list_nodes_full()
list_nodes_full implementation
.UNINDENT
.INDENT 7.0
.TP
.B abstract  list_nodes_min()
list_nodes_min implementation
.UNINDENT
.INDENT 7.0
.TP
.B list_nodes_select(call)
.UNINDENT
.INDENT 7.0
.TP
.B abstract  reboot(name)
reboot implementation
.UNINDENT
.INDENT 7.0
.TP
.B abstract  show_instance(name)
show_instance implementation
.UNINDENT
.INDENT 7.0
.TP
.B abstract  show_pricing(kwargs=None)
show_pricing implementation
.UNINDENT
.INDENT 7.0
.TP
.B abstract  start(name)
start implementation
.UNINDENT
.INDENT 7.0
.TP
.B abstract  stop(name)
stop implementation
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.cloud.clouds.linode.LinodeAPIv4
.INDENT 7.0
.TP
.B avail_images()
avail_images implementation
.UNINDENT
.INDENT 7.0
.TP
.B avail_locations()
avail_locations implementation
.UNINDENT
.INDENT 7.0
.TP
.B avail_sizes()
avail_sizes implementation
.UNINDENT
.INDENT 7.0
.TP
.B boot(name=None, kwargs=None)
boot implementation
.UNINDENT
.INDENT 7.0
.TP
.B clone(kwargs=None)
clone implementation
.UNINDENT
.INDENT 7.0
.TP
.B create(vm_)
create implementation
.UNINDENT
.INDENT 7.0
.TP
.B create_config(kwargs=None)
create_config implementation
.UNINDENT
.INDENT 7.0
.TP
.B destroy(name)
destroy implementation
.UNINDENT
.INDENT 7.0
.TP
.B classmethod  get_api_instance()
.UNINDENT
.INDENT 7.0
.TP
.B get_config_id(kwargs=None)
get_config_id implementation
.UNINDENT
.INDENT 7.0
.TP
.B list_nodes()
list_nodes implementation
.UNINDENT
.INDENT 7.0
.TP
.B list_nodes_full()
list_nodes_full implementation
.UNINDENT
.INDENT 7.0
.TP
.B list_nodes_min()
list_nodes_min implementation
.UNINDENT
.INDENT 7.0
.TP
.B reboot(name)
reboot implementation
.UNINDENT
.INDENT 7.0
.TP
.B set_backup_schedule(label, linode_id, day, window, auto_enable=False)
.UNINDENT
.INDENT 7.0
.TP
.B show_instance(name)
show_instance implementation
.UNINDENT
.INDENT 7.0
.TP
.B show_pricing(kwargs=None)
show_pricing implementation
.UNINDENT
.INDENT 7.0
.TP
.B start(name)
start implementation
.UNINDENT
.INDENT 7.0
.TP
.B stop(name)
stop implementation
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.avail_images(call=None)
Return available Linode images.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images my\-linode\-config
salt\-cloud \-f avail_images my\-linode\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.avail_locations(call=None)
Return available Linode datacenter locations.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations my\-linode\-config
salt\-cloud \-f avail_locations my\-linode\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.avail_sizes(call=None)
Return available Linode sizes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-sizes my\-linode\-config
salt\-cloud \-f avail_sizes my\-linode\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.boot(name=None, kwargs=None, call=None)
Boot a Linode.
.INDENT 7.0
.TP
.B name
The name of the Linode to boot. Can be used instead of \fBlinode_id\fP\&.
.TP
.B linode_id
The ID of the Linode to boot. If provided, will be used as an
alternative to \fBname\fP and reduces the number of API calls to
Linode by one. Will be preferred over \fBname\fP\&.
.TP
.B config_id
The ID of the Config to boot. Required.
.TP
.B check_running
Defaults to True. If set to False, overrides the call to check if
the VM is running before calling the linode.boot API call. Change
\fBcheck_running\fP to True is useful during the boot call in the
create function, since the new VM will not be running yet.
.UNINDENT
.sp
Can be called as an action (which requires a name):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a boot my\-instance config_id=10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\&...or as a function (which requires either a name or linode_id):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f boot my\-linode\-config name=my\-instance config_id=10
salt\-cloud \-f boot my\-linode\-config linode_id=1225876 config_id=10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.clone(kwargs=None, call=None)
Clone a Linode.
.INDENT 7.0
.TP
.B linode_id
The ID of the Linode to clone. Required.
.TP
.B location
The location of the new Linode. Required.
.TP
.B size
The size of the new Linode (must be greater than or equal to the clone source). Required.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f clone my\-linode\-config linode_id=1234567 location=us\-central size=g6\-standard\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.create(vm_)
Create a single Linode VM.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.create_config(kwargs=None, call=None)
Creates a Linode Configuration Profile.
.INDENT 7.0
.TP
.B name
The name of the VM to create the config for.
.TP
.B linode_id
The ID of the Linode to create the configuration for.
.TP
.B root_disk_id
The Root Disk ID to be used for this config.
.TP
.B swap_disk_id
The Swap Disk ID to be used for this config.
.TP
.B data_disk_id
The Data Disk ID to be used for this config.
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B kernel_id
The ID of the kernel to use for this configuration profile.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.destroy(name, call=None)
Destroys a Linode by name.
.INDENT 7.0
.TP
.B name
The name of VM to be be destroyed.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-d vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.get_config_id(kwargs=None, call=None)
Returns a config_id for a given linode.
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B name
The name of the Linode for which to get the config_id. Can be used instead
of \fBlinode_id\fP\&.
.TP
.B linode_id
The ID of the Linode for which to get the config_id. Can be used instead
of \fBname\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_config_id my\-linode\-config name=my\-linode
salt\-cloud \-f get_config_id my\-linode\-config linode_id=1234567
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.get_linode(kwargs=None, call=None)
Returns data for a single named Linode.
.INDENT 7.0
.TP
.B name
The name of the Linode for which to get data. Can be used instead
\fBlinode_id\fP\&. Note this will induce an additional API call
compared to using \fBlinode_id\fP\&.
.TP
.B linode_id
The ID of the Linode for which to get data. Can be used instead of
\fBname\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_linode my\-linode\-config name=my\-instance
salt\-cloud \-f get_linode my\-linode\-config linode_id=1234567
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.list_nodes(call=None)
Returns a list of linodes, keeping only a brief listing.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-Q
salt\-cloud \-\-query
salt\-cloud \-f list_nodes my\-linode\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fBimage\fP label only displays information about the VM\(aqs distribution vendor,
such as \(dqDebian\(dq or \(dqRHEL\(dq and does not display the actual image name. This is
due to a limitation of the Linode API.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.list_nodes_full(call=None)
List linodes, with all available information.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-F
salt\-cloud \-\-full\-query
salt\-cloud \-f list_nodes_full my\-linode\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fBimage\fP label only displays information about the VM\(aqs distribution vendor,
such as \(dqDebian\(dq or \(dqRHEL\(dq and does not display the actual image name. This is
due to a limitation of the Linode API.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.list_nodes_min(call=None)
Return a list of the VMs that are on the provider. Only a list of VM names and
their state is returned. This is the minimum amount of information needed to
check for existing VMs.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_nodes_min my\-linode\-config
salt\-cloud \-\-function list_nodes_min my\-linode\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.list_nodes_select(call=None)
Return a list of the VMs that are on the provider, with select fields.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.reboot(name, call=None)
Reboot a linode.
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B name
The name of the VM to reboot.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.set_backup_schedule(name=None, kwargs=None, call=None)
Set the backup schedule for a Linode.
.INDENT 7.0
.TP
.B name
The name (label) of the Linode. Can be used instead of
\fBlinode_id\fP\&.
.TP
.B linode_id
The ID of the Linode instance to set the backup schedule for.
If provided, will be used as an alternative to \fBname\fP and
reduces the number of API calls to Linode by one. Will be
preferred over \fBname\fP\&.
.TP
.B auto_enable
If \fBTrue\fP, automatically enable the backup feature for the Linode
if it wasn\(aqt already enabled. Optional parameter, default to \fBFalse\fP\&.
.TP
.B day
Possible values:
\fBSunday\fP, \fBMonday\fP, \fBTuesday\fP, \fBWednesday\fP,
\fBThursday\fP, \fBFriday\fP, \fBSaturday\fP
.sp
The day of the week that your Linode\(aqs weekly Backup is taken.
If not set manually, a day will be chosen for you. Backups are
taken every day, but backups taken on this day are preferred
when selecting backups to retain for a longer period.
.sp
If not set manually, then when backups are initially enabled,
this may come back as \fBScheduling\fP until the day is automatically
selected.
.TP
.B window
Possible values:
\fBW0\fP, \fBW2\fP, \fBW4\fP, \fBW6\fP, \fBW8\fP, \fBW10\fP,
\fBW12\fP, \fBW14\fP, \fBW16\fP, \fBW18\fP, \fBW20\fP, \fBW22\fP
.sp
The window in which your backups will be taken, in UTC. A backups
window is a two\-hour span of time in which the backup may occur.
.sp
For example, \fBW10\fP indicates that your backups should be taken
between 10:00 and 12:00. If you do not choose a backup window, one
will be selected for you automatically.
.sp
If not set manually, when backups are initially enabled this may come
back as \fBScheduling\fP until the window is automatically selected.
.UNINDENT
.sp
Can be called as an action (which requires a name):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a set_backup_schedule my\-linode\-instance day=Monday window=W20 auto_enable=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\&...or as a function (which requires either a name or linode_id):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f set_backup_schedule my\-linode\-provider name=my\-linode\-instance day=Monday window=W20 auto_enable=True
salt\-cloud \-f set_backup_schedule my\-linode\-provider linode_id=1225876 day=Monday window=W20 auto_enable=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.show_instance(name, call=None)
Displays details about a particular Linode VM. Either a name or a linode_id must
be provided.
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B name
The name of the VM for which to display details.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_instance vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fBimage\fP label only displays information about the VM\(aqs distribution vendor,
such as \(dqDebian\(dq or \(dqRHEL\(dq and does not display the actual image name. This is
due to a limitation of the Linode API.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.show_pricing(kwargs=None, call=None)
Show pricing for a particular profile. This is only an estimate, based on
unofficial pricing sources.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_pricing my\-linode\-config profile=my\-linode\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.start(name, call=None)
Start a VM in Linode.
.INDENT 7.0
.TP
.B name
The name of the VM to start.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.linode.stop(name, call=None)
Stop a VM in Linode.
.INDENT 7.0
.TP
.B name
The name of the VM to stop.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.cloud.clouds.lxc
.SS Install Salt on an LXC Container
.sp
New in version 2014.7.0.

.sp
Please read \fI\%core config documentation\fP\&.
.INDENT 0.0
.TP
.B salt.cloud.clouds.lxc.avail_images()
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.lxc.create(vm_, call=None)
Create an lxc Container.
This function is idempotent and will try to either provision
or finish the provision of an lxc container.
.sp
NOTE: Most of the initialization code has been moved and merged
with the lxc runner and lxc.init functions
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.lxc.destroy(vm_, call=None)
Destroy a lxc container
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.lxc.get_configured_provider(vm_=None)
Return the contextual provider of None if no configured
one can be found.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.lxc.get_provider(name)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.lxc.list_nodes(conn=None, call=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.lxc.list_nodes_full(conn=None, call=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.lxc.list_nodes_select(call=None)
Return a list of the VMs that are on the provider, with select fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.lxc.show_instance(name, call=None)
Show the details from the provider concerning an instance
.UNINDENT
.SS salt.cloud.clouds.oneandone
.SS 1&1 Cloud Server Module
.sp
The 1&1 SaltStack cloud module allows a 1&1 server to be automatically deployed
and bootstrapped with Salt. It also has functions to create block storages and
ssh keys.
.INDENT 0.0
.TP
.B depends
1and1 >= 1.2.0
.UNINDENT
.sp
The module requires the 1&1 api_token to be provided.  The server should also
be assigned a public LAN, a private LAN, or both along with SSH key pairs.
.sp
Set up the cloud configuration at \fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/oneandone.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-oneandone\-config:
  driver: oneandone
  # The 1&1 api token
  api_token: <your\-token>
  # SSH private key filename
  ssh_private_key: /path/to/private_key
  # SSH public key filename
  ssh_public_key: /path/to/public_key
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-oneandone\-profile:
  provider: my\-oneandone\-config
  # Either provide fixed_instance_size_id or vcore, cores_per_processor, ram, and hdds.
  # Size of the ID desired for the server
  fixed_instance_size: S
  # Total amount of processors
  vcore: 2
  # Number of cores per processor
  cores_per_processor: 2
  # RAM memory size in GB
  ram: 4
  # Hard disks
  hdds:
  \-
    is_main: true
    size: 20
  \-
    is_main: false
    size: 20
  # ID of the appliance image that will be installed on server
  appliance_id: <ID>
  # ID of the datacenter where the server will be created
  datacenter_id: <ID>
  # Description of the server
  description: My server description
  # Password of the server. Password must contain more than 8 characters
  # using uppercase letters, numbers and other special symbols.
  password: P4$$w0rD
  # Power on server after creation \- default True
  power_on: true
  # Firewall policy ID. If it is not provided, the server will assign
  # the best firewall policy, creating a new one if necessary.
  # If the parameter is sent with a 0 value, the server will be created with all ports blocked.
  firewall_policy_id: <ID>
  # IP address ID
  ip_id: <ID>
  # Load balancer ID
  load_balancer_id: <ID>
  # Monitoring policy ID
  monitoring_policy_id: <ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Set \fBdeploy\fP to False if Salt should not be installed on the node.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-oneandone\-profile:
  deploy: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Create an SSH key
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo salt\-cloud \-f create_ssh_key my\-oneandone\-config name=\(aqSaltTest\(aq description=\(aqSaltTestDescription\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Create a block storage
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo salt\-cloud \-f create_block_storage my\-oneandone\-config name=\(aqSaltTest2\(aq
description=\(aqSaltTestDescription\(aq size=50 datacenter_id=\(aq5091F6D8CBFEF9C26ACE957C652D5D49\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.avail_images(conn=None, call=None)
Return a list of the server appliances that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.avail_locations(conn=None, call=None)
List available locations/datacenters for 1&1
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.avail_sizes(call=None)
Return a dict of all available VM sizes on the cloud provider with
relevant data.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.create(vm_)
Create a single VM from a data dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.create_block_storage(kwargs=None, call=None)
Create a block storage
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.create_ssh_key(kwargs=None, call=None)
Create an ssh key
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.destroy(name, call=None)
destroy a server by name
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name given to the server
.IP \(bu 2
\fBcall\fP \-\- call value in this case is \(aqaction\(aq
.UNINDENT
.TP
.B Returns
array of booleans , true if successfully stopped and true if
successfully removed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-d vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.get_conn()
Return a conn object for the passed VM data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.get_dependencies()
Warn if dependencies are not met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.get_image(vm_)
Return the image object to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.get_key_filename(vm_)
Check SSH private key file and return absolute path if exists.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.get_node(conn, name)
Return a node for the named VM
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.get_size(vm_)
Return the VM\(aqs size object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.get_wait_timeout(vm_)
Return the wait_for_timeout for resource provisioning.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.list_nodes(conn=None, call=None)
Return a list of VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.list_nodes_full(conn=None, call=None)
Return a list of the VMs that are on the provider, with all fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.list_nodes_select(conn=None, call=None)
Return a list of the VMs that are on the provider, with select fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.load_public_key(vm_)
Load the public key file if exists.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.reboot(name, call=None)
reboot a server by name
:param name: name given to the machine
:param call: call value in this case is \(aqaction\(aq
:return: true if successful
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.script(vm_)
Return the script deployment object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.show_instance(name, call=None)
Show the details from the provider concerning an instance
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.start(name, call=None)
start a server by name
:param name: name given to the machine
:param call: call value in this case is \(aqaction\(aq
:return: true if successful
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a start vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.oneandone.stop(name, call=None)
stop a server by name
:param name: name given to the machine
:param call: call value in this case is \(aqaction\(aq
:return: true if successful
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.cloud.clouds.opennebula
.SS OpenNebula Cloud Module
.sp
The OpenNebula cloud module is used to control access to an OpenNebula cloud.
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B depends
lxml
.TP
.B depends
OpenNebula installation running version \fB4.14\fP or later.
.UNINDENT
.sp
Use of this module requires the \fBxml_rpc\fP, \fBuser\fP, and \fBpassword\fP
parameters to be set.
.sp
Set up the cloud configuration at \fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/opennebula.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-opennebula\-config:
  xml_rpc: http://localhost:2633/RPC2
  user: oneadmin
  password: JHGhgsayu32jsa
  driver: opennebula
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This driver supports accessing new VM instances via DNS entry instead
of IP address.  To enable this feature, in the provider or profile file
add \fIfqdn_base\fP with a value matching the base of your fully\-qualified
domain name.  Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-opennebula\-config:
  [...]
  fqdn_base: <my.basedomain.com>
  [...]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The driver will prepend the hostname to the fqdn_base and do a DNS lookup
to find the IP of the new VM.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f image_allocate opennebula datastore_name=default \e
    data=\(aqNAME=\(dqMy New Image\(dq DESCRIPTION=\(dqDescription of the image.\(dq \e
    PATH=/home/one_user/images/image_name.img\(aq
salt\-cloud \-f secgroup_allocate opennebula \e
    data=\(dqName = test RULE = [PROTOCOL = TCP, RULE_TYPE = inbound, \e
    RANGE = 1000:2000]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.avail_images(call=None)
Return available OpenNebula images.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images opennebula
salt\-cloud \-\-function avail_images opennebula
salt\-cloud \-f avail_images opennebula
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.avail_locations(call=None)
Return available OpenNebula locations.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations opennebula
salt\-cloud \-\-function avail_locations opennebula
salt\-cloud \-f avail_locations opennebula
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.avail_sizes(call=None)
Because sizes are built into templates with OpenNebula, there will be no sizes to
return here.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.create(vm_)
Create a single VM from a data dict.
.INDENT 7.0
.TP
.B vm_
The dictionary use to create a VM.
.UNINDENT
.sp
Optional vm_ dict options for overwriting template:
.INDENT 7.0
.TP
.B region_id
Optional \- OpenNebula Zone ID
.TP
.B memory
Optional \- In MB
.TP
.B cpu
Optional \- Percent of host CPU to allocate
.TP
.B vcpu
.INDENT 7.0
.INDENT 3.5
Optional \- Amount of vCPUs to allocate
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
 salt\-cloud \-p my\-opennebula\-profile vm_name

salt\-cloud \-p my\-opennebula\-profile vm_name memory=16384 cpu=2.5 vcpu=16
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.destroy(name, call=None)
Destroy a node. Will check termination protection and warn if enabled.
.INDENT 7.0
.TP
.B name
The name of the vm to be destroyed.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-destroy vm_name
salt\-cloud \-d vm_name
salt\-cloud \-\-action destroy vm_name
salt\-cloud \-a destroy vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.get_cluster_id(kwargs=None, call=None)
Returns a cluster\(aqs ID from the given cluster name.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_cluster_id opennebula name=my\-cluster\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.get_datastore_id(kwargs=None, call=None)
Returns a data store\(aqs ID from the given data store name.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_datastore_id opennebula name=my\-datastore\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.get_host_id(kwargs=None, call=None)
Returns a host\(aqs ID from the given host name.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_host_id opennebula name=my\-host\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.get_image(vm_)
Return the image object to use.
.INDENT 7.0
.TP
.B vm_
The VM dictionary for which to obtain an image.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.get_image_id(kwargs=None, call=None)
Returns an image\(aqs ID from the given image name.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_image_id opennebula name=my\-image\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.get_location(vm_)
Return the VM\(aqs location.
.INDENT 7.0
.TP
.B vm_
The VM dictionary for which to obtain a location.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.get_one_version(kwargs=None, call=None)
Returns the OpenNebula version.
.sp
New in version 2016.3.5.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_one_version one_provider_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.get_secgroup_id(kwargs=None, call=None)
Returns a security group\(aqs ID from the given security group name.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_secgroup_id opennebula name=my\-secgroup\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.get_template(vm_)
Return the template id for a VM.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B vm_
The VM dictionary for which to obtain a template.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.get_template_id(kwargs=None, call=None)
Returns a template\(aqs ID from the given template name.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_template_id opennebula name=my\-template\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.get_template_image(kwargs=None, call=None)
Returns a template\(aqs image from the given template name.
.sp
New in version 2018.3.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_template_image opennebula name=my\-template\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.get_vm_id(kwargs=None, call=None)
Returns a virtual machine\(aqs ID from the given virtual machine\(aqs name.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_vm_id opennebula name=my\-vm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.get_vn_id(kwargs=None, call=None)
Returns a virtual network\(aqs ID from the given virtual network\(aqs name.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_vn_id opennebula name=my\-vn\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.image_allocate(call=None, kwargs=None)
Allocates a new image in OpenNebula.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B path
The path to a file containing the template of the image to allocate.
Syntax within the file can be the usual attribute=value or XML. Can be
used instead of \fBdata\fP\&.
.TP
.B data
The data containing the template of the image to allocate. Syntax can be the
usual attribute=value or XML. Can be used instead of \fBpath\fP\&.
.TP
.B datastore_id
The ID of the data\-store to be used for the new image. Can be used instead
of \fBdatastore_name\fP\&.
.TP
.B datastore_name
The name of the data\-store to be used for the new image. Can be used instead of
\fBdatastore_id\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f image_allocate opennebula path=/path/to/image_file.txt datastore_id=1
salt\-cloud \-f image_allocate opennebula datastore_name=default \e
    data=\(aqNAME=\(dqUbuntu 14.04\(dq PATH=\(dq/home/one_user/images/ubuntu_desktop.img\(dq \e
    DESCRIPTION=\(dqUbuntu 14.04 for development.\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.image_clone(call=None, kwargs=None)
Clones an existing image.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the new image.
.TP
.B image_id
The ID of the image to be cloned. Can be used instead of \fBimage_name\fP\&.
.TP
.B image_name
The name of the image to be cloned. Can be used instead of \fBimage_id\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f image_clone opennebula name=my\-new\-image image_id=10
salt\-cloud \-f image_clone opennebula name=my\-new\-image image_name=my\-image\-to\-clone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.image_delete(call=None, kwargs=None)
Deletes the given image from OpenNebula. Either a name or an image_id must
be supplied.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the image to delete. Can be used instead of \fBimage_id\fP\&.
.TP
.B image_id
The ID of the image to delete. Can be used instead of \fBname\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f image_delete opennebula name=my\-image
salt\-cloud \-\-function image_delete opennebula image_id=100
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.image_info(call=None, kwargs=None)
Retrieves information for a given image. Either a name or an image_id must be
supplied.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the image for which to gather information. Can be used instead
of \fBimage_id\fP\&.
.TP
.B image_id
The ID of the image for which to gather information. Can be used instead of
\fBname\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f image_info opennebula name=my\-image
salt\-cloud \-\-function image_info opennebula image_id=5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.image_persistent(call=None, kwargs=None)
Sets the Image as persistent or not persistent.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the image to set. Can be used instead of \fBimage_id\fP\&.
.TP
.B image_id
The ID of the image to set. Can be used instead of \fBname\fP\&.
.TP
.B persist
A boolean value to set the image as persistent or not. Set to true
for persistent, false for non\-persistent.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f image_persistent opennebula name=my\-image persist=True
salt\-cloud \-\-function image_persistent opennebula image_id=5 persist=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.image_snapshot_delete(call=None, kwargs=None)
Deletes a snapshot from the image.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B image_id
The ID of the image from which to delete the snapshot. Can be used instead of
\fBimage_name\fP\&.
.TP
.B image_name
The name of the image from which to delete the snapshot. Can be used instead
of \fBimage_id\fP\&.
.TP
.B snapshot_id
The ID of the snapshot to delete.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f image_snapshot_delete vm_id=106 snapshot_id=45
salt\-cloud \-f image_snapshot_delete vm_name=my\-vm snapshot_id=111
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.image_snapshot_flatten(call=None, kwargs=None)
Flattens the snapshot of an image and discards others.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B image_id
The ID of the image. Can be used instead of \fBimage_name\fP\&.
.TP
.B image_name
The name of the image. Can be used instead of \fBimage_id\fP\&.
.TP
.B snapshot_id
The ID of the snapshot to flatten.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f image_snapshot_flatten vm_id=106 snapshot_id=45
salt\-cloud \-f image_snapshot_flatten vm_name=my\-vm snapshot_id=45
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.image_snapshot_revert(call=None, kwargs=None)
Reverts an image state to a previous snapshot.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B image_id
The ID of the image to revert. Can be used instead of \fBimage_name\fP\&.
.TP
.B image_name
The name of the image to revert. Can be used instead of \fBimage_id\fP\&.
.TP
.B snapshot_id
The ID of the snapshot to which the image will be reverted.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f image_snapshot_revert vm_id=106 snapshot_id=45
salt\-cloud \-f image_snapshot_revert vm_name=my\-vm snapshot_id=120
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.image_update(call=None, kwargs=None)
Replaces the image template contents.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B image_id
The ID of the image to update. Can be used instead of \fBimage_name\fP\&.
.TP
.B image_name
The name of the image to update. Can be used instead of \fBimage_id\fP\&.
.TP
.B path
The path to a file containing the template of the image. Syntax within the
file can be the usual attribute=value or XML. Can be used instead of \fBdata\fP\&.
.TP
.B data
Contains the template of the image. Syntax can be the usual attribute=value
or XML. Can be used instead of \fBpath\fP\&.
.TP
.B update_type
There are two ways to update an image: \fBreplace\fP the whole template
or \fBmerge\fP the new template with the existing one.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f image_update opennebula image_id=0 file=/path/to/image_update_file.txt update_type=replace
salt\-cloud \-f image_update opennebula image_name=\(dqUbuntu 14.04\(dq update_type=merge \e
    data=\(aqNAME=\(dqUbuntu Dev\(dq PATH=\(dq/home/one_user/images/ubuntu_desktop.img\(dq \e
    DESCRIPTION = \(dqUbuntu 14.04 for development.\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.list_clusters(call=None)
Returns a list of clusters in OpenNebula.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_clusters opennebula
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.list_datastores(call=None)
Returns a list of data stores on OpenNebula.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_datastores opennebula
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.list_hosts(call=None)
Returns a list of hosts on OpenNebula.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_hosts opennebula
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.list_nodes(call=None)
Return a list of VMs on OpenNebula.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-Q
salt\-cloud \-\-query
salt\-cloud \-\-function list_nodes opennebula
salt\-cloud \-f list_nodes opennebula
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.list_nodes_full(call=None)
Return a list of the VMs on OpenNebula.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-F
salt\-cloud \-\-full\-query
salt\-cloud \-\-function list_nodes_full opennebula
salt\-cloud \-f list_nodes_full opennebula
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.list_nodes_select(call=None)
Return a list of the VMs that are on the provider, with select fields.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.list_security_groups(call=None)
Lists all security groups available to the user and the user\(aqs groups.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_security_groups opennebula
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.list_templates(call=None)
Lists all templates available to the user and the user\(aqs groups.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_templates opennebula
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.list_vns(call=None)
Lists all virtual networks available to the user and the user\(aqs groups.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_vns opennebula
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.reboot(name, call=None)
Reboot a VM.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM to reboot.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot my\-vm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.secgroup_allocate(call=None, kwargs=None)
Allocates a new security group in OpenNebula.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B path
The path to a file containing the template of the security group. Syntax
within the file can be the usual attribute=value or XML. Can be used
instead of \fBdata\fP\&.
.TP
.B data
The template data of the security group. Syntax can be the usual
attribute=value or XML. Can be used instead of \fBpath\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f secgroup_allocate opennebula path=/path/to/secgroup_file.txt
salt\-cloud \-f secgroup_allocate opennebula \e
    data=\(dqNAME = test RULE = [PROTOCOL = TCP, RULE_TYPE = inbound, \e
    RANGE = 1000:2000]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.secgroup_clone(call=None, kwargs=None)
Clones an existing security group.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the new template.
.TP
.B secgroup_id
The ID of the security group to be cloned. Can be used instead of
\fBsecgroup_name\fP\&.
.TP
.B secgroup_name
The name of the security group to be cloned. Can be used instead of
\fBsecgroup_id\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f secgroup_clone opennebula name=my\-cloned\-secgroup secgroup_id=0
salt\-cloud \-f secgroup_clone opennebula name=my\-cloned\-secgroup secgroup_name=my\-secgroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.secgroup_delete(call=None, kwargs=None)
Deletes the given security group from OpenNebula. Either a name or a secgroup_id
must be supplied.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the security group to delete. Can be used instead of
\fBsecgroup_id\fP\&.
.TP
.B secgroup_id
The ID of the security group to delete. Can be used instead of \fBname\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f secgroup_delete opennebula name=my\-secgroup
salt\-cloud \-\-function secgroup_delete opennebula secgroup_id=100
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.secgroup_info(call=None, kwargs=None)
Retrieves information for the given security group. Either a name or a
secgroup_id must be supplied.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the security group for which to gather information. Can be
used instead of \fBsecgroup_id\fP\&.
.TP
.B secgroup_id
The ID of the security group for which to gather information. Can be
used instead of \fBname\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f secgroup_info opennebula name=my\-secgroup
salt\-cloud \-\-function secgroup_info opennebula secgroup_id=5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.secgroup_update(call=None, kwargs=None)
Replaces the security group template contents.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B secgroup_id
The ID of the security group to update. Can be used instead of
\fBsecgroup_name\fP\&.
.TP
.B secgroup_name
The name of the security group to update. Can be used instead of
\fBsecgroup_id\fP\&.
.TP
.B path
The path to a file containing the template of the security group. Syntax
within the file can be the usual attribute=value or XML. Can be used instead
of \fBdata\fP\&.
.TP
.B data
The template data of the security group. Syntax can be the usual attribute=value
or XML. Can be used instead of \fBpath\fP\&.
.TP
.B update_type
There are two ways to update a security group: \fBreplace\fP the whole template
or \fBmerge\fP the new template with the existing one.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-function secgroup_update opennebula secgroup_id=100 \e
    path=/path/to/secgroup_update_file.txt \e
    update_type=replace
salt\-cloud \-f secgroup_update opennebula secgroup_name=my\-secgroup update_type=merge \e
    data=\(dqName = test RULE = [PROTOCOL = TCP, RULE_TYPE = inbound, RANGE = 1000:2000]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.show_instance(name, call=None)
Show the details from OpenNebula concerning a named VM.
.INDENT 7.0
.TP
.B name
The name of the VM for which to display details.
.TP
.B call
Type of call to use with this function such as \fBfunction\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-action show_instance vm_name
salt\-cloud \-a show_instance vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.start(name, call=None)
Start a VM.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM to start.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a start my\-vm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.stop(name, call=None)
Stop a VM.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM to stop.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop my\-vm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.template_allocate(call=None, kwargs=None)
Allocates a new template in OpenNebula.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B path
The path to a file containing the elements of the template to be allocated.
Syntax within the file can be the usual attribute=value or XML. Can be used
instead of \fBdata\fP\&.
.TP
.B data
Contains the elements of the template to be allocated. Syntax can be the usual
attribute=value or XML. Can be used instead of \fBpath\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f template_allocate opennebula path=/path/to/template_file.txt
salt\-cloud \-f template_allocate opennebula \e
    data=\(aqCPU=\(dq1.0\(dq DISK=[IMAGE=\(dqUbuntu\-14.04\(dq] GRAPHICS=[LISTEN=\(dq0.0.0.0\(dq,TYPE=\(dqvnc\(dq] \e
    MEMORY=\(dq1024\(dq NETWORK=\(dqyes\(dq NIC=[NETWORK=\(dq192net\(dq,NETWORK_UNAME=\(dqoneadmin\(dq] \e
    OS=[ARCH=\(dqx86_64\(dq] SUNSTONE_CAPACITY_SELECT=\(dqYES\(dq SUNSTONE_NETWORK_SELECT=\(dqYES\(dq \e
    VCPU=\(dq1\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.template_clone(call=None, kwargs=None)
Clones an existing virtual machine template.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the new template.
.TP
.B template_id
The ID of the template to be cloned. Can be used instead of \fBtemplate_name\fP\&.
.TP
.B template_name
The name of the template to be cloned. Can be used instead of \fBtemplate_id\fP\&.
.TP
.B clone_images
Optional, defaults to False. Indicates if the images attached to the template should be cloned as well.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f template_clone opennebula name=my\-new\-template template_id=0
salt\-cloud \-f template_clone opennebula name=my\-new\-template template_name=my\-template
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.template_delete(call=None, kwargs=None)
Deletes the given template from OpenNebula. Either a name or a template_id must
be supplied.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the template to delete. Can be used instead of \fBtemplate_id\fP\&.
.TP
.B template_id
The ID of the template to delete. Can be used instead of \fBname\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f template_delete opennebula name=my\-template
salt\-cloud \-\-function template_delete opennebula template_id=5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.template_instantiate(call=None, kwargs=None)
Instantiates a new virtual machine from a template.
.sp
New in version 2016.3.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBtemplate_instantiate\fP creates a VM on OpenNebula from a template, but it
does not install Salt on the new VM. Use the \fBcreate\fP function for that
functionality: \fBsalt\-cloud \-p opennebula\-profile vm\-name\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B vm_name
Name for the new VM instance.
.TP
.B template_id
The ID of the template from which the VM will be created. Can be used instead
of \fBtemplate_name\fP\&.
.TP
.B template_name
The name of the template from which the VM will be created. Can be used instead
of \fBtemplate_id\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f template_instantiate opennebula vm_name=my\-new\-vm template_id=0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.template_update(call=None, kwargs=None)
Replaces the template contents.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B template_id
The ID of the template to update. Can be used instead of \fBtemplate_name\fP\&.
.TP
.B template_name
The name of the template to update. Can be used instead of \fBtemplate_id\fP\&.
.TP
.B path
The path to a file containing the elements of the template to be updated.
Syntax within the file can be the usual attribute=value or XML. Can be
used instead of \fBdata\fP\&.
.TP
.B data
Contains the elements of the template to be updated. Syntax can be the
usual attribute=value or XML. Can be used instead of \fBpath\fP\&.
.TP
.B update_type
There are two ways to update a template: \fBreplace\fP the whole template
or \fBmerge\fP the new template with the existing one.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-function template_update opennebula template_id=1 update_type=replace \e
    path=/path/to/template_update_file.txt
salt\-cloud \-f template_update opennebula template_name=my\-template update_type=merge \e
    data=\(aqCPU=\(dq1.0\(dq DISK=[IMAGE=\(dqUbuntu\-14.04\(dq] GRAPHICS=[LISTEN=\(dq0.0.0.0\(dq,TYPE=\(dqvnc\(dq] \e
    MEMORY=\(dq1024\(dq NETWORK=\(dqyes\(dq NIC=[NETWORK=\(dq192net\(dq,NETWORK_UNAME=\(dqoneadmin\(dq] \e
    OS=[ARCH=\(dqx86_64\(dq] SUNSTONE_CAPACITY_SELECT=\(dqYES\(dq SUNSTONE_NETWORK_SELECT=\(dqYES\(dq \e
    VCPU=\(dq1\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_action(name, kwargs=None, call=None)
Submits an action to be performed on a given virtual machine.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM to action.
.TP
.B action
.INDENT 7.0
.TP
.B The action to be performed on the VM. Available options include:
.INDENT 7.0
.IP \(bu 2
boot
.IP \(bu 2
delete
.IP \(bu 2
delete\-recreate
.IP \(bu 2
hold
.IP \(bu 2
poweroff
.IP \(bu 2
poweroff\-hard
.IP \(bu 2
reboot
.IP \(bu 2
reboot\-hard
.IP \(bu 2
release
.IP \(bu 2
resched
.IP \(bu 2
resume
.IP \(bu 2
shutdown
.IP \(bu 2
shutdown\-hard
.IP \(bu 2
stop
.IP \(bu 2
suspend
.IP \(bu 2
undeploy
.IP \(bu 2
undeploy\-hard
.IP \(bu 2
unresched
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_action my\-vm action=\(aqrelease\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_allocate(call=None, kwargs=None)
Allocates a new virtual machine in OpenNebula.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B path
The path to a file defining the template of the VM to allocate.
Syntax within the file can be the usual attribute=value or XML.
Can be used instead of \fBdata\fP\&.
.TP
.B data
Contains the template definitions of the VM to allocate. Syntax can
be the usual attribute=value or XML. Can be used instead of \fBpath\fP\&.
.TP
.B hold
If this parameter is set to \fBTrue\fP, the VM will be created in
the \fBHOLD\fP state. If not set, the VM is created in the \fBPENDING\fP
state. Default is \fBFalse\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f vm_allocate path=/path/to/vm_template.txt
salt\-cloud \-\-function vm_allocate path=/path/to/vm_template.txt hold=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_attach(name, kwargs=None, call=None)
Attaches a new disk to the given virtual machine.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM for which to attach the new disk.
.TP
.B path
The path to a file containing a single disk vector attribute.
Syntax within the file can be the usual attribute=value or XML.
Can be used instead of \fBdata\fP\&.
.TP
.B data
Contains the data needed to attach a single disk vector attribute.
Syntax can be the usual attribute=value or XML. Can be used instead
of \fBpath\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_attach my\-vm path=/path/to/disk_file.txt
salt\-cloud \-a vm_attach my\-vm data=\(dqDISK=[DISK_ID=1]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_attach_nic(name, kwargs=None, call=None)
Attaches a new network interface to the given virtual machine.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM for which to attach the new network interface.
.TP
.B path
The path to a file containing a single NIC vector attribute.
Syntax within the file can be the usual attribute=value or XML. Can
be used instead of \fBdata\fP\&.
.TP
.B data
Contains the single NIC vector attribute to attach to the VM.
Syntax can be the usual attribute=value or XML. Can be used instead
of \fBpath\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_attach_nic my\-vm path=/path/to/nic_file.txt
salt\-cloud \-a vm_attach_nic my\-vm data=\(dqNIC=[NETWORK_ID=1]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_deploy(name, kwargs=None, call=None)
Initiates the instance of the given VM on the target host.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM to deploy.
.TP
.B host_id
The ID of the target host where the VM will be deployed. Can be used instead
of \fBhost_name\fP\&.
.TP
.B host_name
The name of the target host where the VM will be deployed. Can be used instead
of \fBhost_id\fP\&.
.TP
.B capacity_maintained
True to enforce the Host capacity is not over\-committed. This parameter is only
acknowledged for users in the \fBoneadmin\fP group. Host capacity will be always
enforced for regular users.
.TP
.B datastore_id
The ID of the target system data\-store where the VM will be deployed. Optional
and can be used instead of \fBdatastore_name\fP\&. If neither \fBdatastore_id\fP nor
\fBdatastore_name\fP are set, OpenNebula will choose the data\-store.
.TP
.B datastore_name
The name of the target system data\-store where the VM will be deployed. Optional,
and can be used instead of \fBdatastore_id\fP\&. If neither \fBdatastore_id\fP nor
\fBdatastore_name\fP are set, OpenNebula will choose the data\-store.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_deploy my\-vm host_id=0
salt\-cloud \-a vm_deploy my\-vm host_id=1 capacity_maintained=False
salt\-cloud \-a vm_deploy my\-vm host_name=host01 datastore_id=1
salt\-cloud \-a vm_deploy my\-vm host_name=host01 datastore_name=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_detach(name, kwargs=None, call=None)
Detaches a disk from a virtual machine.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM from which to detach the disk.
.TP
.B disk_id
The ID of the disk to detach.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_detach my\-vm disk_id=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_detach_nic(name, kwargs=None, call=None)
Detaches a disk from a virtual machine.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM from which to detach the network interface.
.TP
.B nic_id
The ID of the nic to detach.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_detach_nic my\-vm nic_id=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_disk_save(name, kwargs=None, call=None)
Sets the disk to be saved in the given image.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM containing the disk to save.
.TP
.B disk_id
The ID of the disk to save.
.TP
.B image_name
The name of the new image where the disk will be saved.
.TP
.B image_type
The type for the new image. If not set, then the default \fBONED\fP Configuration
will be used. Other valid types include: OS, CDROM, DATABLOCK, KERNEL, RAMDISK,
and CONTEXT.
.TP
.B snapshot_id
The ID of the snapshot to export. If not set, the current image state will be
used.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_disk_save my\-vm disk_id=1 image_name=my\-new\-image
salt\-cloud \-a vm_disk_save my\-vm disk_id=1 image_name=my\-new\-image image_type=CONTEXT snapshot_id=10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_disk_snapshot_create(name, kwargs=None, call=None)
Takes a new snapshot of the disk image.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM of which to take the snapshot.
.TP
.B disk_id
The ID of the disk to save.
.TP
.B description
The description for the snapshot.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_disk_snapshot_create my\-vm disk_id=0 description=\(dqMy Snapshot Description\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_disk_snapshot_delete(name, kwargs=None, call=None)
Deletes a disk snapshot based on the given VM and the disk_id.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM containing the snapshot to delete.
.TP
.B disk_id
The ID of the disk to save.
.TP
.B snapshot_id
The ID of the snapshot to be deleted.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_disk_snapshot_delete my\-vm disk_id=0 snapshot_id=6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_disk_snapshot_revert(name, kwargs=None, call=None)
Reverts a disk state to a previously taken snapshot.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM containing the snapshot.
.TP
.B disk_id
The ID of the disk to revert its state.
.TP
.B snapshot_id
The ID of the snapshot to which the snapshot should be reverted.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_disk_snapshot_revert my\-vm disk_id=0 snapshot_id=6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_info(name, call=None)
Retrieves information for a given virtual machine. A VM name must be supplied.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM for which to gather information.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_info my\-vm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_migrate(name, kwargs=None, call=None)
Migrates the specified virtual machine to the specified target host.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM to migrate.
.TP
.B host_id
The ID of the host to which the VM will be migrated. Can be used instead
of \fBhost_name\fP\&.
.TP
.B host_name
The name of the host to which the VM will be migrated. Can be used instead
of \fBhost_id\fP\&.
.TP
.B live_migration
If set to \fBTrue\fP, a live\-migration will be performed. Default is \fBFalse\fP\&.
.TP
.B capacity_maintained
True to enforce the Host capacity is not over\-committed. This parameter is only
acknowledged for users in the \fBoneadmin\fP group. Host capacity will be always
enforced for regular users.
.TP
.B datastore_id
The target system data\-store ID where the VM will be migrated. Can be used
instead of \fBdatastore_name\fP\&.
.TP
.B datastore_name
The name of the data\-store target system where the VM will be migrated. Can be
used instead of \fBdatastore_id\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_migrate my\-vm host_id=0 datastore_id=1
salt\-cloud \-a vm_migrate my\-vm host_id=0 datastore_id=1 live_migration=True
salt\-cloud \-a vm_migrate my\-vm host_name=host01 datastore_name=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_monitoring(name, call=None)
Returns the monitoring records for a given virtual machine. A VM name must be
supplied.
.sp
The monitoring information returned is a list of VM elements. Each VM element
contains the complete dictionary of the VM with the updated information returned
by the poll action.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM for which to gather monitoring records.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_monitoring my\-vm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_resize(name, kwargs=None, call=None)
Changes the capacity of the virtual machine.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM to resize.
.TP
.B path
The path to a file containing new capacity elements CPU, VCPU, MEMORY. If one
of them is not present, or its value is 0, the VM will not be re\-sized. Syntax
within the file can be the usual attribute=value or XML. Can be used instead
of \fBdata\fP\&.
.TP
.B data
Contains the new capacity elements CPU, VCPU, and MEMORY. If one of them is not
present, or its value is 0, the VM will not be re\-sized. Can be used instead of
\fBpath\fP\&.
.TP
.B capacity_maintained
True to enforce the Host capacity is not over\-committed. This parameter is only
acknowledged for users in the \fBoneadmin\fP group. Host capacity will be always
enforced for regular users.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_resize my\-vm path=/path/to/capacity_template.txt
salt\-cloud \-a vm_resize my\-vm path=/path/to/capacity_template.txt capacity_maintained=False
salt\-cloud \-a vm_resize my\-vm data=\(dqCPU=1 VCPU=1 MEMORY=1024\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_snapshot_create(vm_name, kwargs=None, call=None)
Creates a new virtual machine snapshot from the provided VM.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B vm_name
The name of the VM from which to create the snapshot.
.TP
.B snapshot_name
The name of the snapshot to be created.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_snapshot_create my\-vm snapshot_name=my\-new\-snapshot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_snapshot_delete(vm_name, kwargs=None, call=None)
Deletes a virtual machine snapshot from the provided VM.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B vm_name
The name of the VM from which to delete the snapshot.
.TP
.B snapshot_id
The ID of the snapshot to be deleted.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_snapshot_delete my\-vm snapshot_id=8
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_snapshot_revert(vm_name, kwargs=None, call=None)
Reverts a virtual machine to a snapshot
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B vm_name
The name of the VM to revert.
.TP
.B snapshot_id
The snapshot ID.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_snapshot_revert my\-vm snapshot_id=42
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vm_update(name, kwargs=None, call=None)
Replaces the user template contents.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM to update.
.TP
.B path
The path to a file containing new user template contents. Syntax within the
file can be the usual attribute=value or XML. Can be used instead of \fBdata\fP\&.
.TP
.B data
Contains the new user template contents. Syntax can be the usual attribute=value
or XML. Can be used instead of \fBpath\fP\&.
.TP
.B update_type
There are two ways to update a VM: \fBreplace\fP the whole template
or \fBmerge\fP the new template with the existing one.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vm_update my\-vm path=/path/to/user_template_file.txt update_type=\(aqreplace\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vn_add_ar(call=None, kwargs=None)
Adds address ranges to a given virtual network.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B vn_id
The ID of the virtual network to add the address range. Can be used
instead of \fBvn_name\fP\&.
.TP
.B vn_name
The name of the virtual network to add the address range. Can be used
instead of \fBvn_id\fP\&.
.TP
.B path
The path to a file containing the template of the address range to add.
Syntax within the file can be the usual attribute=value or XML. Can be
used instead of \fBdata\fP\&.
.TP
.B data
Contains the template of the address range to add. Syntax can be the
usual attribute=value or XML. Can be used instead of \fBpath\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f vn_add_ar opennebula vn_id=3 path=/path/to/address_range.txt
salt\-cloud \-f vn_add_ar opennebula vn_name=my\-vn \e
    data=\(dqAR=[TYPE=IP4, IP=192.168.0.5, SIZE=10]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vn_allocate(call=None, kwargs=None)
Allocates a new virtual network in OpenNebula.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B path
The path to a file containing the template of the virtual network to allocate.
Syntax within the file can be the usual attribute=value or XML. Can be used
instead of \fBdata\fP\&.
.TP
.B data
Contains the template of the virtual network to allocate. Syntax can be the
usual attribute=value or XML. Can be used instead of \fBpath\fP\&.
.TP
.B cluster_id
The ID of the cluster for which to add the new virtual network. Can be used
instead of \fBcluster_name\fP\&. If neither \fBcluster_id\fP nor \fBcluster_name\fP
are provided, the virtual network won’t be added to any cluster.
.TP
.B cluster_name
The name of the cluster for which to add the new virtual network. Can be used
instead of \fBcluster_id\fP\&. If neither \fBcluster_name\fP nor \fBcluster_id\fP are
provided, the virtual network won\(aqt be added to any cluster.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f vn_allocate opennebula path=/path/to/vn_file.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vn_delete(call=None, kwargs=None)
Deletes the given virtual network from OpenNebula. Either a name or a vn_id must
be supplied.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the virtual network to delete. Can be used instead of \fBvn_id\fP\&.
.TP
.B vn_id
The ID of the virtual network to delete. Can be used instead of \fBname\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f vn_delete opennebula name=my\-virtual\-network
salt\-cloud \-\-function vn_delete opennebula vn_id=3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vn_free_ar(call=None, kwargs=None)
Frees a reserved address range from a virtual network.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B vn_id
The ID of the virtual network from which to free an address range.
Can be used instead of \fBvn_name\fP\&.
.TP
.B vn_name
The name of the virtual network from which to free an address range.
Can be used instead of \fBvn_id\fP\&.
.TP
.B ar_id
The ID of the address range to free.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f vn_free_ar opennebula vn_id=3 ar_id=1
salt\-cloud \-f vn_free_ar opennebula vn_name=my\-vn ar_id=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vn_hold(call=None, kwargs=None)
Holds a virtual network lease as used.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B vn_id
The ID of the virtual network from which to hold the lease. Can be used
instead of \fBvn_name\fP\&.
.TP
.B vn_name
The name of the virtual network from which to hold the lease. Can be used
instead of \fBvn_id\fP\&.
.TP
.B path
The path to a file defining the template of the lease to hold.
Syntax within the file can be the usual attribute=value or XML. Can be
used instead of \fBdata\fP\&.
.TP
.B data
Contains the template of the lease to hold. Syntax can be the usual
attribute=value or XML. Can be used instead of \fBpath\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f vn_hold opennebula vn_id=3 path=/path/to/vn_hold_file.txt
salt\-cloud \-f vn_hold opennebula vn_name=my\-vn data=\(dqLEASES=[IP=192.168.0.5]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vn_info(call=None, kwargs=None)
Retrieves information for the virtual network.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The name of the virtual network for which to gather information. Can be
used instead of \fBvn_id\fP\&.
.TP
.B vn_id
The ID of the virtual network for which to gather information. Can be
used instead of \fBname\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f vn_info opennebula vn_id=3
salt\-cloud \-\-function vn_info opennebula name=public
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vn_release(call=None, kwargs=None)
Releases a virtual network lease that was previously on hold.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B vn_id
The ID of the virtual network from which to release the lease. Can be
used instead of \fBvn_name\fP\&.
.TP
.B vn_name
The name of the virtual network from which to release the lease.
Can be used instead of \fBvn_id\fP\&.
.TP
.B path
The path to a file defining the template of the lease to release.
Syntax within the file can be the usual attribute=value or XML. Can be
used instead of \fBdata\fP\&.
.TP
.B data
Contains the template defining the lease to release. Syntax can be the
usual attribute=value or XML. Can be used instead of \fBpath\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f vn_release opennebula vn_id=3 path=/path/to/vn_release_file.txt
salt\-cloud =f vn_release opennebula vn_name=my\-vn data=\(dqLEASES=[IP=192.168.0.5]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.opennebula.vn_reserve(call=None, kwargs=None)
Reserve network addresses.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B vn_id
The ID of the virtual network from which to reserve addresses. Can be used
instead of vn_name.
.TP
.B vn_name
The name of the virtual network from which to reserve addresses. Can be
used instead of vn_id.
.TP
.B path
The path to a file defining the template of the address reservation.
Syntax within the file can be the usual attribute=value or XML. Can be used
instead of \fBdata\fP\&.
.TP
.B data
Contains the template defining the address reservation. Syntax can be the
usual attribute=value or XML. Data provided must be wrapped in double
quotes. Can be used instead of \fBpath\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f vn_reserve opennebula vn_id=3 path=/path/to/vn_reserve_file.txt
salt\-cloud \-f vn_reserve opennebula vn_name=my\-vn data=\(dqSIZE=10 AR_ID=8 NETWORK_ID=1\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.cloud.clouds.openstack
.SS Openstack Cloud Driver
.INDENT 0.0
.TP
.B depends
\fI\%shade>=1.19.0\fP
.UNINDENT
.sp
OpenStack is an open source project that is in use by a number a cloud
providers, each of which have their own ways of using it.
.sp
This OpenStack driver uses a the shade python module which is managed by the
OpenStack Infra team.  This module is written to handle all the different
versions of different OpenStack tools for salt, so most commands are just passed
over to the module to handle everything.
.SS Provider
.sp
There are two ways to configure providers for this driver.  The first one is to
just let shade handle everything, and configure using \fI\%os\-client\-config\fP and
setting up \fI/etc/openstack/clouds.yml\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
clouds:
  democloud:
    region_name: RegionOne
    auth:
      username: \(aqdemo\(aq
      password: secret
      project_name: \(aqdemo\(aq
      auth_url: \(aqhttp://openstack/identity\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And then this can be referenced in the salt provider based on the \fIdemocloud\fP
name.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myopenstack:
  driver: openstack
  cloud: democloud
  region_name: RegionOne
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This allows for just using one configuration for salt\-cloud and for any other
openstack tools which are all using \fI/etc/openstack/clouds.yml\fP
.sp
The other method allows for specifying everything in the provider config,
instead of using the extra configuration file.  This will allow for passing
salt\-cloud configs only through pillars for minions without having to write a
clouds.yml file on each minion.abs
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myopenstack:
  driver: openstack
  region_name: RegionOne
  auth:
    username: \(aqdemo\(aq
    password: secret
    project_name: \(aqdemo\(aq
    user_domain_name: default,
    project_domain_name: default,
    auth_url: \(aqhttp://openstack/identity\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or if you need to use a profile to setup some extra stuff, it can be passed as a
\fIprofile\fP to use any of the \fI\%vendor\fP config options.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myrackspace:
  driver: openstack
  profile: rackspace
  auth:
    username: rackusername
    api_key: myapikey
  region_name: ORD
  auth_type: rackspace_apikey
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And this will pull in the profile for rackspace and setup all the correct
options for the auth_url and different api versions for services.
.SS Profile
.sp
Most of the options for building servers are just passed on to the
\fI\%create_server\fP function from shade.
.sp
The salt specific ones are:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
ssh_key_file: The path to the ssh key that should be used to login to the machine to bootstrap it
.IP \(bu 2
ssh_key_file: The name of the keypair in openstack
.IP \(bu 2
userdata_template: The renderer to use if the userdata is a file that is templated. Default: False
.IP \(bu 2
ssh_interface: The interface to use to login for bootstrapping: public_ips, private_ips, floating_ips, fixed_ips
.IP \(bu 2
ignore_cidr: Specify a CIDR range of unreachable private addresses for salt to ignore when connecting
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
centos:
  provider: myopenstack
  image: CentOS 7
  size: ds1G
  ssh_key_name: mykey
  ssh_key_file: /root/.ssh/id_rsa
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is the minimum setup required.
.sp
If metadata is set to make sure that the host has finished setting up the
\fIwait_for_metadata\fP can be set.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
centos:
  provider: myopenstack
  image: CentOS 7
  size: ds1G
  ssh_key_name: mykey
  ssh_key_file: /root/.ssh/id_rsa
  meta:
    build_config: rack_user_only
  wait_for_metadata:
    rax_service_level_automation: Complete
    rackconnect_automation_status: DEPLOYED
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If your OpenStack instances only have private IP addresses and a CIDR range of
private addresses are not reachable from the salt\-master, you may set your
preference to have Salt ignore it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-openstack\-config:
  ignore_cidr: 192.168.0.0/16
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Anything else from the \fI\%create_server\fP docs can be passed through here.
.INDENT 0.0
.IP \(bu 2
\fBimage\fP: Image dict, name or ID to boot with. image is required
unless boot_volume is given.
.IP \(bu 2
\fBflavor\fP: Flavor dict, name or ID to boot onto.
.IP \(bu 2
\fBauto_ip\fP: Whether to take actions to find a routable IP for
the server. (defaults to True)
.IP \(bu 2
\fBips\fP: List of IPs to attach to the server (defaults to None)
.IP \(bu 2
\fBip_pool\fP: Name of the network or floating IP pool to get an
address from. (defaults to None)
.IP \(bu 2
\fBroot_volume\fP: Name or ID of a volume to boot from
(defaults to None \- deprecated, use boot_volume)
.IP \(bu 2
\fBboot_volume\fP: Name or ID of a volume to boot from
(defaults to None)
.IP \(bu 2
\fBterminate_volume\fP: If booting from a volume, whether it should
be deleted when the server is destroyed.
(defaults to False)
.IP \(bu 2
\fBvolumes\fP: (optional) A list of volumes to attach to the server
.IP \(bu 2
\fBmeta\fP: (optional) A dict of arbitrary key/value metadata to
store for this server. Both keys and values must be
<=255 characters.
.IP \(bu 2
\fBfiles\fP: (optional, deprecated) A dict of files to overwrite
on the server upon boot. Keys are file names (i.e.
\fB/etc/passwd\fP) and values
are the file contents (either as a string or as a
file\-like object). A maximum of five entries is allowed,
and each file must be 10k or less.
.IP \(bu 2
\fBreservation_id\fP: a UUID for the set of servers being requested.
.IP \(bu 2
\fBmin_count\fP: (optional extension) The minimum number of
servers to launch.
.IP \(bu 2
\fBmax_count\fP: (optional extension) The maximum number of
servers to launch.
.IP \(bu 2
\fBsecurity_groups\fP: A list of security group names
.IP \(bu 2
\fBuserdata\fP: user data to pass to be exposed by the metadata
server this can be a file type object as well or a
string.
.IP \(bu 2
\fBkey_name\fP: (optional extension) name of previously created
keypair to inject into the instance.
.IP \(bu 2
\fBavailability_zone\fP: Name of the availability zone for instance
placement.
.IP \(bu 2
\fBblock_device_mapping\fP: (optional) A list of dictionaries representing
legacy block device mappings for this server. See
\fI\%documentation\fP
for details.
.IP \(bu 2
\fBblock_device_mapping_v2\fP: (optional) A list of dictionaries representing
block device mappings for this server. See
\fI\%v2 documentation\fP
for details.
.IP \(bu 2
\fBnics\fP:  (optional extension) an ordered list of nics to be
added to this server, with information about
connected networks, fixed IPs, port etc.
.IP \(bu 2
\fBscheduler_hints\fP: (optional extension) arbitrary key\-value pairs
specified by the client to help boot an instance
.IP \(bu 2
\fBconfig_drive\fP: (optional extension) value for config drive
either boolean, or volume\-id
.IP \(bu 2
\fBdisk_config\fP: (optional extension) control how the disk is
partitioned when the server is created.  possible
values are \(aqAUTO\(aq or \(aqMANUAL\(aq.
.IP \(bu 2
\fBadmin_pass\fP: (optional extension) add a user supplied admin
password.
.IP \(bu 2
\fBtimeout\fP: (optional) Seconds to wait, defaults to 60.
See the \fBwait\fP parameter.
.IP \(bu 2
\fBreuse_ips\fP: (optional) Whether to attempt to reuse pre\-existing
floating ips should a floating IP be
needed (defaults to True)
.IP \(bu 2
\fBnetwork\fP: (optional) Network dict or name or ID to attach the
server to.  Mutually exclusive with the nics parameter.
Can also be be a list of network names or IDs or
network dicts.
.IP \(bu 2
\fBboot_from_volume\fP: Whether to boot from volume. \(aqboot_volume\(aq
implies True, but boot_from_volume=True with
no boot_volume is valid and will create a
volume from the image and use that.
.IP \(bu 2
\fBvolume_size\fP: When booting an image from volume, how big should
the created volume be? Defaults to 50.
.IP \(bu 2
\fBnat_destination\fP: Which network should a created floating IP
be attached to, if it\(aqs not possible to
infer from the cloud\(aqs configuration.
(Optional, defaults to None)
.IP \(bu 2
\fBgroup\fP: ServerGroup dict, name or id to boot the server in.
If a group is provided in both scheduler_hints and in
the group param, the group param will win.
(Optional, defaults to None)
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If there is anything added, that is not in this list, it can be added to an \fIextras\fP
dictionary for the profile, and that will be to the create_server function.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.avail_images(conn=None, call=None)
List available images for OpenStack
.sp
CLI Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f avail_images myopenstack
salt\-cloud \-\-list\-images myopenstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.avail_sizes(conn=None, call=None)
List available sizes for OpenStack
.sp
CLI Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f avail_sizes myopenstack
salt\-cloud \-\-list\-sizes myopenstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.call(conn=None, call=None, kwargs=None)
Call function from shade.
.sp
func
.INDENT 7.0
.INDENT 3.5
function to call from shade.openstackcloud library
.UNINDENT
.UNINDENT
.sp
CLI Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f call myopenstack func=list_images
t sujksalt\-cloud \-f call myopenstack func=create_network name=mysubnet
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.create(vm_)
Create a single VM from a data dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.destroy(name, conn=None, call=None)
Delete a single VM
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.get_conn()
Return a conn object for the passed VM data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.ignore_cidr(vm_, ip)
Return True if we are to ignore the specified IP.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.list_networks(conn=None, call=None)
List networks for OpenStack
.sp
CLI Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_networks myopenstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.list_nodes(conn=None, call=None)
Return a list of VMs
.sp
CLI Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_nodes myopenstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.list_nodes_full(conn=None, call=None)
Return a list of VMs with all the information about them
.sp
CLI Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_nodes_full myopenstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.list_nodes_min(conn=None, call=None)
Return a list of VMs with minimal information
.sp
CLI Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_nodes_min myopenstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.list_nodes_select(conn=None, call=None)
Return a list of VMs with the fields from \fIquery.selection\fP
.sp
CLI Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_nodes_full myopenstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.list_subnets(conn=None, call=None, kwargs=None)
List subnets in a virtual network
.INDENT 7.0
.TP
.B network
network to list subnets of
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_subnets myopenstack network=salt\-net
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.preferred_ip(vm_, ips)
Return either an \(aqipv4\(aq (default) or \(aqipv6\(aq address depending on \(aqprotocol\(aq option.
The list of \(aqipv4\(aq IPs is filtered by ignore_cidr() to remove any unreachable private addresses.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.request_instance(vm_, conn=None, call=None)
Request an instance to be built
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.show_instance(name, conn=None, call=None)
Get VM on this OpenStack account
.sp
name
.INDENT 7.0
.INDENT 3.5
name of the instance
.UNINDENT
.UNINDENT
.sp
CLI Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_instance myserver
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.openstack.ssh_interface(vm_)
Return the ssh_interface type to connect to. Either \(aqpublic_ips\(aq (default)
or \(aqprivate_ips\(aq.
.UNINDENT
.SS salt.cloud.clouds.packet
.SS Packet Cloud Module Using Packet\(aqs Python API Client
.sp
The Packet cloud module is used to control access to the Packet VPS system.
.sp
Use of this module only requires the \fBtoken\fP parameter.
.sp
Set up the cloud configuration at \fB/etc/salt/cloud.providers\fP or \fB/etc/salt/cloud.providers.d/packet.conf\fP:
.sp
The Packet profile requires \fBsize\fP, \fBimage\fP, \fBlocation\fP,  \fBproject_id\fP
.sp
Optional profile parameters:
.INDENT 0.0
.IP \(bu 2
\fBstorage_size\fP \-  min value is 10, defines Gigabytes of storage that will be attached to device.
.IP \(bu 2
\fBstorage_tier\fP \- storage_1 \- Standard Plan, storage_2 \- Performance Plan
.IP \(bu 2
\fBsnapshot_count\fP \- int
.IP \(bu 2
\fBsnapshot_frequency\fP \- string \- possible values:
.INDENT 2.0
.IP \(bu 2
1min
.IP \(bu 2
15min
.IP \(bu 2
1hour
.IP \(bu 2
1day
.IP \(bu 2
1week
.IP \(bu 2
1month
.IP \(bu 2
1year
.UNINDENT
.UNINDENT
.sp
This driver requires Packet\(aqs client library: \fI\%https://pypi.python.org/pypi/packet\-python\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
packet\-provider:
    minion:
        master: 192.168.50.10
    driver: packet
    token: ewr23rdf35wC8oNjJrhmHa87rjSXzJyi
    private_key: /root/.ssh/id_rsa

packet\-profile:
    provider: packet\-provider
    size: baremetal_0
    image: ubuntu_16_04_image
    location: ewr1
    project_id: a64d000b\-d47c\-4d26\-9870\-46aac43010a6
    storage_size: 10
    storage_tier: storage_1
    storage_snapshot_count: 1
    storage_snapshot_frequency: 15min
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.avail_images(call=None)
Return available Packet os images.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images packet\-provider
salt\-cloud \-f avail_images packet\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.avail_locations(call=None)
Return available Packet datacenter locations.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations packet\-provider
salt\-cloud \-f avail_locations packet\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.avail_projects(call=None)
Return available Packet projects.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f avail_projects packet\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.avail_sizes(call=None)
Return available Packet sizes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-sizes packet\-provider
salt\-cloud \-f avail_sizes packet\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.create(vm_)
Create a single Packet VM.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.destroy(name, call=None)
Destroys a Packet device by name.
.INDENT 7.0
.TP
.B name
The hostname of VM to be be destroyed.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-d name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.get_devices_by_token()
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.get_image(conn, vm_)
Return the image object to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.get_size(conn, vm_)
Return the VM\(aqs size object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.is_profile_configured(vm_)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.list_nodes(call=None)
Returns a list of devices, keeping only a brief listing.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-Q
salt\-cloud \-\-query
salt\-cloud \-f list_nodes packet\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.list_nodes_full(call=None)
List devices, with all available information.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-F
salt\-cloud \-\-full\-query
salt\-cloud \-f list_nodes_full packet\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.list_nodes_min(call=None)
Return a list of the VMs that are on the provider. Only a list of VM names and
their state is returned. This is the minimum amount of information needed to
check for existing VMs.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_nodes_min packet\-provider
salt\-cloud \-\-function list_nodes_min packet\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.list_nodes_select(call=None)
Return a list of the VMs that are on the provider, with select fields.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.script(vm_)
Return the script deployment object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.packet.show_instance(name, call=None)
Show the details from the provider concerning an instance
.UNINDENT
.SS salt.cloud.clouds.parallels
.SS Parallels Cloud Module
.sp
The Parallels cloud module is used to control access to cloud providers using
the Parallels VPS system.
.INDENT 0.0
.TP
.B Set up the cloud configuration at \fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/parallels.conf\fP:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-parallels\-config:
  # Parallels account information
  user: myuser
  password: mypassword
  url: https://api.cloud.xmission.com:4465/paci/v1.0/
  driver: parallels
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.avail_images(call=None)
Return a list of the images that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.create(vm_)
Create a single VM from a data dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.create_node(vm_)
Build and submit the XML to create a node
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.destroy(name, call=None)
Destroy a node.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-destroy mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.get_image(vm_)
Return the image object to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.list_nodes(call=None)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.list_nodes_full(call=None)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.list_nodes_select(call=None)
Return a list of the VMs that are on the provider, with select fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.query(action=None, command=None, args=None, method=\(aqGET\(aq, data=None)
Make a web call to a Parallels provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.script(vm_)
Return the script deployment object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.show_image(kwargs, call=None)
Show the details from Parallels concerning an image
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.show_instance(name, call=None)
Show the details from Parallels concerning an instance
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.start(name, call=None)
Start a node.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a start mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.stop(name, call=None)
Stop a node.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.parallels.wait_until(name, state, timeout=300)
Wait until a specific state has been reached on  a node
.UNINDENT
.SS salt.cloud.clouds.profitbricks
.SS ProfitBricks Cloud Module
.sp
The ProfitBricks SaltStack cloud module allows a ProfitBricks server to
be automatically deployed and bootstraped with Salt.
.INDENT 0.0
.TP
.B depends
profitbrick >= 3.1.0
.UNINDENT
.sp
The module requires ProfitBricks credentials to be supplied along with
an existing virtual datacenter UUID where the server resources will
reside. The server should also be assigned a public LAN, a private LAN,
or both along with SSH key pairs.
\&...
.sp
Set up the cloud configuration at \fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/profitbricks.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-profitbricks\-config:
  driver: profitbricks
  # The ProfitBricks login username
  username: user@example.com
  # The ProfitBricks login password
  password: secretpassword
  # The ProfitBricks virtual datacenter UUID
  datacenter_id: <UUID>
  # SSH private key filename
  ssh_private_key: /path/to/private.key
  # SSH public key filename
  ssh_public_key: /path/to/public.key
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-profitbricks\-profile:
  provider: my\-profitbricks\-config
  # Name of a predefined server size.
  size: Micro Instance
  # Assign CPU family to server.
  cpu_family: INTEL_XEON
  # Number of CPU cores to allocate to node (overrides server size).
  cores: 4
  # Amount of RAM in multiples of 256 MB (overrides server size).
  ram: 4096
  # The server availability zone.
  availability_zone: ZONE_1
  # Name or UUID of the HDD image to use.
  image: <UUID>
  # Image alias could be provided instead of image.
  # Example \(aqubuntu:latest\(aq
  #image_alias: <IMAGE_ALIAS>
  # Size of the node disk in GB (overrides server size).
  disk_size: 40
  # Type of disk (HDD or SSD).
  disk_type: SSD
  # Storage availability zone to use.
  disk_availability_zone: ZONE_2
  # Assign the server to the specified public LAN.
  public_lan: <ID>
  # Assign firewall rules to the network interface.
  public_firewall_rules:
    SSH:
      protocol: TCP
      port_range_start: 22
      port_range_end: 22
  # Assign the server to the specified private LAN.
  private_lan: <ID>
  # Enable NAT on the private NIC.
  nat: true
  # Assign additional volumes to the server.
  volumes:
    data\-volume:
      disk_size: 500
      disk_availability_zone: ZONE_3
    log\-volume:
      disk_size: 50
      disk_type: SSD
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use a private IP for connecting and bootstrapping node:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-profitbricks\-profile:
  ssh_interface: private_lan
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Set \fBdeploy\fP to False if Salt should not be installed on the node.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-profitbricks\-profile:
  deploy: False
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.avail_images(call=None)
Return a list of the images that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.avail_locations(call=None)
Return a dict of all available VM locations on the cloud provider with
relevant data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.avail_sizes(call=None)
Return a dict of all available VM sizes on the cloud provider with
relevant data. Latest version can be found at:
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.create(vm_)
Create a single VM from a data dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.create_datacenter(call=None, kwargs=None)
Creates a virtual datacenter based on supplied parameters.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_datacenter profitbricks name=mydatacenter
location=us/las description=\(dqmy description\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.create_loadbalancer(call=None, kwargs=None)
Creates a loadbalancer within the datacenter from the provider config.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_loadbalancer profitbricks name=mylb
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.destroy(name, call=None)
destroy a machine by name
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name given to the machine
.IP \(bu 2
\fBcall\fP \-\- call value in this case is \(aqaction\(aq
.UNINDENT
.TP
.B Returns
array of booleans , true if successfully stopped and true if
successfully removed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-d vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.get_conn()
Return a conn object for the passed VM data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.get_datacenter(conn)
Return the datacenter from the config provider datacenter ID
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.get_datacenter_id()
Return datacenter ID from provider configuration
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.get_dependencies()
Warn if dependencies are not met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.get_disk_type(vm_)
Return the type of disk to use. Either \(aqHDD\(aq (default) or \(aqSSD\(aq.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.get_image(vm_)
Return the image object to use
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.get_key_filename(vm_)
Check SSH private key file and return absolute path if exists.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.get_node(conn, name)
Return a node for the named VM
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.get_public_keys(vm_)
Retrieve list of SSH public keys.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.get_size(vm_)
Return the VM\(aqs size object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.get_wait_timeout(vm_)
Return the wait_for_timeout for resource provisioning.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.list_datacenters(conn=None, call=None)
List all the data centers
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_datacenters my\-profitbricks\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.list_images(call=None, kwargs=None)
List all the images with alias by location
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_images my\-profitbricks\-config location=us/las
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.list_loadbalancers(call=None)
Return a list of the loadbalancers that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.list_nodes(conn=None, call=None)
Return a list of VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.list_nodes_full(conn=None, call=None)
Return a list of the VMs that are on the provider, with all fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.reboot(name, call=None)
reboot a machine by name
:param name: name given to the machine
:param call: call value in this case is \(aqaction\(aq
:return: true if successful
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.reserve_ipblock(call=None, kwargs=None)
Reserve the IP Block
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.set_public_lan(lan_id)
Enables public Internet access for the specified public_lan. If no public
LAN is available, then a new public LAN is created.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.show_instance(name, call=None)
Show the details from the provider concerning an instance
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.signal_event(vm_, event, description)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.ssh_interface(vm_)
Return the ssh_interface type to connect to. Either \(aqpublic_ips\(aq (default)
or \(aqprivate_ips\(aq.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.start(name, call=None)
start a machine by name
:param name: name given to the machine
:param call: call value in this case is \(aqaction\(aq
:return: true if successful
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a start vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.stop(name, call=None)
stop a machine by name
:param name: name given to the machine
:param call: call value in this case is \(aqaction\(aq
:return: true if successful
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.profitbricks.version_compatible(version)
Checks profitbricks version
.UNINDENT
.SS salt.cloud.clouds.proxmox
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%proxmox Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.SS Proxmox Cloud Module
.sp
New in version 2014.7.0.

.sp
The Proxmox cloud module is used to control access to cloud providers using
the Proxmox system (KVM / OpenVZ / LXC).
.INDENT 0.0
.TP
.B Set up the cloud configuration at \fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/proxmox.conf\fP:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-proxmox\-config:
  # Proxmox account information
  user: myuser@pam or myuser@pve
  password: mypassword
  url: hypervisor.domain.tld
  port: 8006
  driver: proxmox
  verify_ssl: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This cloud provider will be removed from Salt in version 3009.0 in favor of
the \fI\%saltext.proxmox Salt Extension\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B maintainer
Frank Klaassen <\fI\%frank@cloudright.nl\fP>
.TP
.B depends
requests >= 2.2.1
.TP
.B depends
IPy >= 0.81
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.avail_images(call=None, location=\(aqlocal\(aq)
Return a list of the images that are on the provider
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images my\-proxmox\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.avail_locations(call=None)
Return a list of the hypervisors (nodes) which this Proxmox PVE machine manages
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations my\-proxmox\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.create(vm_)
Create a single VM from a data dict
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p proxmox\-ubuntu vmhostname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.create_node(vm_, newid)
Build and submit the requestdata to create a new node
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.destroy(name, call=None)
Destroy a node.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-destroy mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.get_resources_nodes(call=None, resFilter=None)
Retrieve all hypervisors (nodes) available on this environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_resources_nodes my\-proxmox\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.get_resources_vms(call=None, resFilter=None, includeConfig=True)
Retrieve all VMs available on this environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_resources_vms my\-proxmox\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.get_vm_status(vmid=None, name=None)
Get the status for a VM, either via the ID or the hostname
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.get_vmconfig(vmid, node=None, node_type=\(aqopenvz\(aq)
Get VM configuration
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.ignore_cidr(vm_, ip)
Return True if we are to ignore the specified IP.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.list_nodes(call=None)
Return a list of the VMs that are managed by the provider
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-Q my\-proxmox\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.list_nodes_full(call=None)
Return a list of the VMs that are on the provider
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-F my\-proxmox\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.list_nodes_select(call=None)
Return a list of the VMs that are on the provider, with select fields
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-S my\-proxmox\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.preferred_ip(vm_, ips)
Return either an \(aqipv4\(aq (default) or \(aqipv6\(aq address depending on \(aqprotocol\(aq option.
The list of \(aqipv4\(aq IPs is filtered by ignore_cidr() to remove any unreachable private addresses.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.query(conn_type, option, post_data=None)
Execute the HTTP request to the API
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.script(vm_)
Return the script deployment object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.set_vm_status(status, name=None, vmid=None)
Convenience function for setting VM status
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.show_instance(name, call=None)
Show the details from Proxmox concerning an instance
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.shutdown(name=None, vmid=None, call=None)
Shutdown a node via ACPI.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a shutdown mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.start(name, vmid=None, call=None)
Start a node.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a start mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.stop(name, vmid=None, call=None)
Stop a node (\(dqpulling the plug\(dq).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.wait_for_created(upid, timeout=300)
Wait until a the vm has been created successfully
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.proxmox.wait_for_state(vmid, state, timeout=300)
Wait until a specific state has been reached on a node
.UNINDENT
.SS salt.cloud.clouds.pyrax
.SS Pyrax Cloud Module
.sp
PLEASE NOTE: This module is currently in early development, and considered to
be experimental and unstable. It is not recommended for production use. Unless
you are actively developing code in this module, you should use the OpenStack
module instead.
.INDENT 0.0
.TP
.B salt.cloud.clouds.pyrax.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.pyrax.get_conn(conn_type)
Return a conn object for the passed VM data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.pyrax.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.pyrax.queues_create(call, kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.pyrax.queues_delete(call, kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.pyrax.queues_exists(call, kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.pyrax.queues_show(call, kwargs)
.UNINDENT
.SS salt.cloud.clouds.qingcloud
.SS QingCloud Cloud Module
.sp
New in version 2015.8.0.

.sp
The QingCloud cloud module is used to control access to the QingCloud.
\fI\%http://www.qingcloud.com/\fP
.sp
Use of this module requires the \fBaccess_key_id\fP, \fBsecret_access_key\fP,
\fBzone\fP and \fBkey_filename\fP parameter to be set.
.sp
Set up the cloud configuration at \fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/qingcloud.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-qingcloud:
  driver: qingcloud
  access_key_id: AKIDMRTGYONNLTFFRBQJ
  secret_access_key: clYwH21U5UOmcov4aNV2V2XocaHCG3JZGcxEczFu
  zone: pek2
  key_filename: /path/to/your.pem
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
requests
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.avail_images(kwargs=None, call=None)
Return a list of the images that are on the provider.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images my\-qingcloud
salt\-cloud \-f avail_images my\-qingcloud zone=gd1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.avail_locations(call=None)
Return a dict of all available locations on the provider with
relevant data.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations my\-qingcloud
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.avail_sizes(kwargs=None, call=None)
Return a list of the instance sizes that are on the provider.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-sizes my\-qingcloud
salt\-cloud \-f avail_sizes my\-qingcloud zone=pek2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.create(vm_)
Create a single instance from a data dict.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p qingcloud\-ubuntu\-c1m1 hostname1
salt\-cloud \-m /path/to/mymap.sls \-P
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.destroy(instance_id, call=None)
Destroy an instance.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a destroy i\-2f733r5n
salt\-cloud \-d i\-2f733r5n
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.list_nodes(call=None)
Return a list of the instances that are on the provider.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-Q my\-qingcloud
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.list_nodes_full(call=None)
Return a list of the instances that are on the provider.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-F my\-qingcloud
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.list_nodes_min(call=None)
Return a list of the instances that are on the provider. Only a list of
instances names, and their state, is returned.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_nodes_min my\-qingcloud
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.list_nodes_select(call=None)
Return a list of the instances that are on the provider, with selected
fields.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-S my\-qingcloud
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.query(params=None)
Make a web call to QingCloud IaaS API.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.reboot(instance_id, call=None)
Reboot an instance.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot i\-2f733r5n
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.script(vm_)
Return the script deployment object.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.show_image(kwargs, call=None)
Show the details from QingCloud concerning an image.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_image my\-qingcloud image=trustysrvx64c
salt\-cloud \-f show_image my\-qingcloud image=trustysrvx64c,coreos4
salt\-cloud \-f show_image my\-qingcloud image=trustysrvx64c zone=ap1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.show_instance(instance_id, call=None, kwargs=None)
Show the details from QingCloud concerning an instance.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_instance i\-2f733r5n
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.start(instance_id, call=None)
Start an instance.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a start i\-2f733r5n
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.qingcloud.stop(instance_id, force=False, call=None)
Stop an instance.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop i\-2f733r5n
salt\-cloud \-a stop i\-2f733r5n force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.cloud.clouds.saltify
.SS Saltify Module
.sp
The Saltify module is designed to install Salt on a remote machine, virtual or
bare metal, using SSH. This module is useful for provisioning machines which
are already installed, but not Salted.
.sp
Changed in version 2018.3.0: The wake_on_lan capability, and actions destroy, reboot, and query functions were added.

.sp
Use of this module requires some configuration in cloud profile and provider
files as described in the
\fI\%Getting Started with Saltify\fP documentation.
.INDENT 0.0
.TP
.B salt.cloud.clouds.saltify.avail_images(call=None)
This function returns a list of images available for this cloud provider.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images saltify
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
returns a list of available profiles.
.sp
New in version 2018.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.saltify.avail_locations(call=None)
This function returns a list of locations available.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations my\-cloud\-provider
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
[ saltify will always return an empty dictionary ]
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.saltify.avail_sizes(call=None)
This function returns a list of sizes available for this cloud provider.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-sizes saltify
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
[ saltify always returns an empty dictionary ]
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.saltify.create(vm_)
if configuration parameter \fBdeploy\fP is \fBTrue\fP,
.INDENT 7.0
.INDENT 3.5
Provision a single machine, adding its keys to the salt master
.UNINDENT
.UNINDENT
.sp
else,
.INDENT 7.0
.INDENT 3.5
Test ssh connections to the machine
.UNINDENT
.UNINDENT
.sp
Configuration parameters:
.INDENT 7.0
.IP \(bu 2
deploy:  (see above)
.IP \(bu 2
provider:  name of entry in \fBsalt/cloud.providers.d/???\fP file
.IP \(bu 2
ssh_host: IP address or DNS name of the new machine
.IP \(bu 2
ssh_username:  name used to log in to the new machine
.IP \(bu 2
ssh_password:  password to log in (unless key_filename is used)
.IP \(bu 2
key_filename:  (optional) SSH private key for passwordless login
.IP \(bu 2
ssh_port: (default=22) TCP port for SSH connection
.IP \(bu 2
wake_on_lan_mac:  (optional) hardware (MAC) address for wake on lan
.IP \(bu 2
wol_sender_node:  (optional) salt minion to send wake on lan command
.IP \(bu 2
wol_boot_wait:  (default=30) seconds to delay while client boots
.IP \(bu 2
force_minion_config: (optional) replace the minion configuration files on the new machine
.UNINDENT
.sp
See also
\fI\%Miscellaneous Salt Cloud Options\fP
and
\fI\%Getting Started with Saltify\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p mymachine my_new_id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.saltify.destroy(name, call=None)
Destroy a node.
.sp
New in version 2018.3.0.

.sp
Disconnect a minion from the master, and remove its keys.
.INDENT 7.0
.TP
.B Optionally, (if \fBremove_config_on_destroy\fP is \fBTrue\fP),
disables salt\-minion from running on the minion, and
erases the Salt configuration files from it.
.TP
.B Optionally, (if \fBshutdown_on_destroy\fP is \fBTrue\fP),
orders the minion to halt.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-destroy mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.saltify.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.saltify.list_nodes(call=None)
List the nodes which have salt\-cloud:driver:saltify grains.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-Q
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
returns a list of dictionaries of defined standard fields.
.sp
New in version 2018.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.saltify.list_nodes_full(call=None)
Lists complete information for all nodes.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-F
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
returns a list of dictionaries.
.sp
for \(aqsaltify\(aq minions, returns dict of grains (enhanced).
.sp
New in version 2018.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.saltify.list_nodes_select(call=None)
Return a list of the minions that have salt\-cloud grains, with
select fields.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.saltify.reboot(name, call=None)
Reboot a saltify minion.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
The name of the VM to reboot.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.saltify.show_instance(name, call=None)
List the a single node, return dict of grains.
.UNINDENT
.SS salt.cloud.clouds.scaleway
.SS Scaleway Cloud Module
.sp
New in version 2015.8.0.

.sp
The Scaleway cloud module is used to interact with your Scaleway BareMetal
Servers.
.sp
Use of this module only requires the \fBapi_key\fP parameter to be set. Set up
the cloud configuration at \fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/scaleway.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
scaleway\-config:
  # Scaleway organization and token
  access_key: 0e604a2c\-aea6\-4081\-acb2\-e1d1258ef95c
  token: be8fd96b\-04eb\-4d39\-b6ba\-a9edbcf17f12
  driver: scaleway
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.scaleway.avail_images(call=None)
Return a list of the images that are on the provider.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.scaleway.create(server_)
Create a single BareMetal server from a data dict.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.scaleway.create_node(args)
Create a node.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.scaleway.destroy(name, call=None)
Destroy a node. Will check termination protection and warn if enabled.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-destroy mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.scaleway.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.scaleway.get_image(server_)
Return the image object to use.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.scaleway.list_nodes(call=None)
Return a list of the BareMetal servers that are on the provider.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.scaleway.list_nodes_full(call=None)
Return a list of the BareMetal servers that are on the provider.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.scaleway.list_nodes_select(call=None)
Return a list of the BareMetal servers that are on the provider, with
select fields.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.scaleway.query(method=\(aqservers\(aq, server_id=None, command=None, args=None, http_method=\(aqGET\(aq, root=\(aqapi_root\(aq)
Make a call to the Scaleway API.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.scaleway.script(server_)
Return the script deployment object.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.scaleway.show_instance(name, call=None)
Show the details from a Scaleway BareMetal server.
.UNINDENT
.SS salt.cloud.clouds.softlayer
.SS SoftLayer Cloud Module
.sp
The SoftLayer cloud module is used to control access to the SoftLayer VPS
system.
.sp
Use of this module only requires the \fBapikey\fP parameter. Set up the cloud
configuration at:
.sp
\fB/etc/salt/cloud.providers\fP or \fB/etc/salt/cloud.providers.d/softlayer.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-softlayer\-config:
  # SoftLayer account api key
  user: MYLOGIN
  apikey: JVkbSJDGHSDKUKSDJfhsdklfjgsjdkflhjlsdfffhgdgjkenrtuinv
  driver: softlayer
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The SoftLayer Python Library needs to be installed in order to use the
SoftLayer salt.cloud modules. See: \fI\%https://pypi.python.org/pypi/SoftLayer\fP
.INDENT 0.0
.TP
.B depends
softlayer
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.avail_images(call=None)
Return a dict of all available VM images on the cloud provider.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.avail_locations(call=None)
List all available locations
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.avail_sizes(call=None)
Return a dict of all available VM sizes on the cloud provider with
relevant data. This data is provided in three dicts.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.create(vm_)
Create a single VM from a data dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.destroy(name, call=None)
Destroy a node.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-destroy mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.get_conn(service=\(aqSoftLayer_Virtual_Guest\(aq)
Return a conn object for the passed VM data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.get_location(vm_=None)
.INDENT 7.0
.TP
.B Return the location to use, in this order:
.INDENT 7.0
.IP \(bu 2
CLI parameter
.IP \(bu 2
VM parameter
.IP \(bu 2
Cloud profile setting
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.list_custom_images(call=None)
Return a dict of all custom VM images on the cloud provider.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.list_nodes(call=None)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.list_nodes_full(mask=\(aqmask[id]\(aq, call=None)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.list_nodes_select(call=None)
Return a list of the VMs that are on the provider, with select fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.list_vlans(call=None)
List all VLANs associated with the account
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.script(vm_)
Return the script deployment object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer.show_instance(name, call=None)
Show the details from SoftLayer concerning a guest
.UNINDENT
.SS salt.cloud.clouds.softlayer_hw
.SS SoftLayer HW Cloud Module
.sp
The SoftLayer HW cloud module is used to control access to the SoftLayer
hardware cloud system
.sp
Use of this module only requires the \fBapikey\fP parameter. Set up the cloud
configuration at:
.sp
\fB/etc/salt/cloud.providers\fP or \fB/etc/salt/cloud.providers.d/softlayer.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-softlayer\-config:
  # SoftLayer account api key
  user: MYLOGIN
  apikey: JVkbSJDGHSDKUKSDJfhsdklfjgsjdkflhjlsdfffhgdgjkenrtuinv
  driver: softlayer_hw
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The SoftLayer Python Library needs to be installed in order to use the
SoftLayer salt.cloud modules. See: \fI\%https://pypi.python.org/pypi/SoftLayer\fP
.INDENT 0.0
.TP
.B depends
softlayer
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.avail_images(call=None)
Return a dict of all available VM images on the cloud provider.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.avail_locations(call=None)
List all available locations
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.avail_sizes(call=None)
Return a dict of all available VM sizes on the cloud provider with
relevant data. This data is provided in three dicts.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.create(vm_)
Create a single VM from a data dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.destroy(name, call=None)
Destroy a node.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-destroy mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.get_conn(service=\(aqSoftLayer_Hardware\(aq)
Return a conn object for the passed VM data
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.get_location(vm_=None)
.INDENT 7.0
.TP
.B Return the location to use, in this order:
.INDENT 7.0
.IP \(bu 2
CLI parameter
.IP \(bu 2
VM parameter
.IP \(bu 2
Cloud profile setting
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.list_nodes(call=None)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.list_nodes_full(mask=\(aqmask[id, hostname, primaryIpAddress, primaryBackendIpAddress, processorPhysicalCoreAmount, memoryCount]\(aq, call=None)
Return a list of the VMs that are on the provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.list_nodes_select(call=None)
Return a list of the VMs that are on the provider, with select fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.list_vlans(call=None)
List all VLANs associated with the account
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.script(vm_)
Return the script deployment object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.show_all_categories(call=None)
Return a dict of all available categories on the cloud provider.
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.show_all_prices(call=None, kwargs=None)
Return a dict of all prices on the cloud provider.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.show_instance(name, call=None)
Show the details from SoftLayer concerning a guest
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.softlayer_hw.show_pricing(kwargs=None, call=None)
Show pricing for a particular profile. This is only an estimate, based on
unofficial pricing sources.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_pricing my\-softlayerhw\-config profile=my\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If pricing sources have not been cached, they will be downloaded. Once they
have been cached, they will not be updated automatically. To manually update
all prices, use the following command:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f update_pricing <provider>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.SS salt.cloud.clouds.tencentcloud
.SS Tencent Cloud Cloud Module
.sp
New in version 3000.

.sp
The Tencent Cloud Cloud Module is used to control access to the Tencent Cloud instance.
\fI\%https://intl.cloud.tencent.com/\fP
.INDENT 0.0
.TP
.B To use this module, set up the cloud configuration at
\fB/etc/salt/cloud.providers\fP or \fB/etc/salt/cloud.providers.d/*.conf\fP:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-tencentcloud\-config:
  driver: tencentcloud
  # Tencent Cloud Secret Id
  id: AKIDA64pOio9BMemkApzevX0HS169S4b750A
  # Tencent Cloud Secret Key
  key: 8r2xmPn0C5FDvRAlmcJimiTZKVRsk260
  # Tencent Cloud Region
  location: ap\-guangzhou
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
tencentcloud\-sdk\-python
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.avail_images(call=None)
Return Tencent Cloud available image
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images my\-tencentcloud\-config
salt\-cloud \-f avail_images my\-tencentcloud\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.avail_locations(call=None)
Return Tencent Cloud available region
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations my\-tencentcloud\-config
salt\-cloud \-f avail_locations my\-tencentcloud\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.avail_sizes(call=None)
Return Tencent Cloud available instance type
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-sizes my\-tencentcloud\-config
salt\-cloud \-f avail_sizes my\-tencentcloud\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.create(vm_)
Create a single Tencent Cloud instance from a data dict.
.sp
Tencent Cloud profiles require a \fBprovider\fP, \fBavailability_zone\fP, \fBimage\fP and \fBsize\fP\&.
Set up profile at \fB/etc/salt/cloud.profiles\fP or \fB/etc/salt/cloud.profiles.d/*.conf\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
tencentcloud\-guangzhou\-s1sm1:
    provider: my\-tencentcloud\-config
    availability_zone: ap\-guangzhou\-3
    image: img\-31tjrtph
    size: S1.SMALL1
    allocate_public_ip: True
    internet_max_bandwidth_out: 1
    password: \(aq153e41ec96140152\(aq
    securitygroups:
        \- sg\-5e90804b
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p tencentcloud\-guangzhou\-s1 myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.destroy(name, call=None)
Destroy a Tencent Cloud instance
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a destroy myinstance
salt\-cloud \-d myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.get_provider_client(name=None)
Return a new provider client
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.list_availability_zones(call=None)
Return all Tencent Cloud availability zones in current region
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_availability_zones my\-tencentcloud\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.list_custom_images(call=None)
Return all Tencent Cloud images in current region
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_custom_images my\-tencentcloud\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.list_nodes(call=None)
Return a list of instances that are on the provider
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-Q
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.list_nodes_full(call=None)
Return a list of instances that are on the provider, with full details
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-F
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.list_nodes_min(call=None)
Return a list of instances that are on the provider, Only names, and their state, is returned.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_nodes_min my\-tencentcloud\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.list_nodes_select(call=None)
Return a list of instances that are on the provider, with select fields
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-S
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.list_securitygroups(call=None)
Return all Tencent Cloud security groups in current region
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_securitygroups my\-tencentcloud\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.reboot(name, call=None)
Reboot a Tencent Cloud instance
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.script(vm_)
Return the script deployment object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.show_disk(name, call=None)
Show the disk details of Tencent Cloud instance
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_disk myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.show_image(kwargs, call=None)
Show the details of Tencent Cloud image
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f show_image tencentcloud image=img\-31tjrtph
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.show_instance(name, call=None)
Show the details of Tencent Cloud instance
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_instance myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.start(name, call=None)
Start a Tencent Cloud instance
Notice: the instance state must be stopped
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a start myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.tencentcloud.stop(name, force=False, call=None)
Stop a Tencent Cloud running instance
Note: use \fIforce=True\fP to make force stop
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop myinstance
salt\-cloud \-a stop myinstance force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.cloud.clouds.vagrant
.SS Vagrant Cloud Driver
.sp
The Vagrant cloud is designed to \(dqvagrant up\(dq a virtual machine as a
Salt minion.
.sp
Use of this module requires some configuration in cloud profile and provider
files as described in the
\fI\%Getting Started with Vagrant\fP documentation.
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B salt.cloud.clouds.vagrant.avail_images(call=None)
This function returns a list of images available for this cloud provider.
vagrant will return a list of profiles.
salt\-cloud \-\-list\-images my\-cloud\-provider
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vagrant.avail_locations(call=None)
This function returns a list of locations available.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations my\-cloud\-provider

# \e[ vagrant will always returns an empty dictionary \e]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vagrant.avail_sizes(call=None)
This function returns a list of sizes available for this cloud provider.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-sizes my\-cloud\-provider

# \e[ vagrant always returns an empty dictionary \e]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vagrant.create(vm_)
Provision a single machine
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p my_profile new_node_1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vagrant.destroy(name, call=None)
Destroy a node.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-destroy mymachine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vagrant.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vagrant.list_nodes(call=None)
List the nodes which have salt\-cloud:driver:vagrant grains.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-Q
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vagrant.list_nodes_full(call=None)
List the nodes, ask all \(aqvagrant\(aq minions, return dict of grains (enhanced).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-F
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vagrant.list_nodes_select(call=None)
Return a list of the minions that have salt\-cloud grains, with
select fields.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vagrant.reboot(name, call=None)
Reboot a vagrant minion.
.INDENT 7.0
.TP
.B name
The name of the VM to reboot.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot vm_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vagrant.show_instance(name, call=None)
List the a single node, return dict of grains.
.UNINDENT
.SS salt.cloud.clouds.virtualbox
.sp
A salt cloud provider that lets you use virtualbox on your machine
and act as a cloud.
.INDENT 0.0
.TP
.B depends
vboxapi
.UNINDENT
.sp
For now this will only clone existing VMs. It\(aqs best to create a template
from which we will clone.
.sp
Followed
\fI\%https://docs.saltproject.io/en/latest/topics/cloud/cloud.html#non\-libcloud\-based\-modules\fP
to create this.
.INDENT 0.0
.TP
.B Dicts provided by salt:
.INDENT 7.0
.TP
.B __opts__
contains the options used to run Salt Cloud,
as well as a set of configuration and environment variables
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.virtualbox.create(vm_info)
Creates a virtual machine from the given VM information
.sp
This is what is used to request a virtual machine to be created by the
cloud provider, wait for it to become available, and then (optionally) log
in and install Salt on it.
.sp
Events fired:
.sp
This function fires the event \fBsalt/cloud/vm_name/creating\fP, with the
payload containing the names of the VM, profile, and provider.
.sp
@param vm_info
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    name: <str>
    profile: <dict>
    driver: <provider>:<profile>
    clonefrom: <vm_name>
    clonemode: <mode> (default: state, choices: state, child, all)
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
@type vm_info dict
@return dict of resulting vm. !!!Passwords can and should be included!!!
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.virtualbox.destroy(name, call=None)
This function irreversibly destroys a virtual machine on the cloud provider.
Before doing so, it should fire an event on the Salt event bus.
.sp
The tag for this event is \fIsalt/cloud/<vm name>/destroying\fP\&.
Once the virtual machine has been destroyed, another event is fired.
The tag for that event is \fIsalt/cloud/<vm name>/destroyed\fP\&.
.INDENT 7.0
.TP
.B Dependencies:
list_nodes
.UNINDENT
.sp
@param name:
@type name: str
@param call:
@type call:
@return: True if all went well, otherwise an error message
@rtype: bool|str
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.virtualbox.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.virtualbox.list_nodes(kwargs=None, call=None)
This function returns a list of nodes available on this cloud provider, using the following fields:
.sp
id (str)
image (str)
size (str)
state (str)
private_ips (list)
public_ips (list)
.sp
No other fields should be returned in this function, and all of these fields should be returned, even if empty.
The private_ips and public_ips fields should always be of a list type, even if empty,
and the other fields should always be of a str type.
This function is normally called with the \-Q option:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-Q
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
@param kwargs:
@type kwargs:
@param call:
@type call:
@return:
@rtype:
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.virtualbox.list_nodes_full(kwargs=None, call=None)
All information available about all nodes should be returned in this function.
The fields in the list_nodes() function should also be returned,
even if they would not normally be provided by the cloud provider.
.sp
This is because some functions both within Salt and 3rd party will break if an expected field is not present.
This function is normally called with the \-F option:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-F
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
@param kwargs:
@type kwargs:
@param call:
@type call:
@return:
@rtype:
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.virtualbox.list_nodes_select(call=None)
Return a list of the VMs that are on the provider, with select fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.virtualbox.map_clonemode(vm_info)
Convert the virtualbox config file values for clone_mode into the integers the API requires
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.virtualbox.show_image(kwargs, call=None)
Show the details of an image
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.virtualbox.start(name, call=None)
Start a machine.
@param name: Machine to start
@type name: str
@param call: Must be \(dqaction\(dq
@type call: str
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.virtualbox.stop(name, call=None)
Stop a running machine.
@param name: Machine to stop
@type name: str
@param call: Must be \(dqaction\(dq
@type call: str
.UNINDENT
.SS salt.cloud.clouds.vmware
.SS VMware Cloud Module
.sp
New in version 2015.5.4.

.sp
The VMware cloud module allows you to manage VMware ESX, ESXi, and vCenter.
.sp
See \fI\%Getting started with VMware\fP to get started.
.INDENT 0.0
.TP
.B codeauthor
Nitin Madhok <\fI\%nmadhok@g.clemson.edu\fP>
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
pyVmomi Python Module
.UNINDENT
.SS pyVmomi
.sp
PyVmomi can be installed via pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Version 6.0 of pyVmomi has some problems with SSL error handling on certain
versions of Python. If using version 6.0 of pyVmomi, Python 2.6,
Python 2.7.9, or newer must be present. This is due to an upstream dependency
in pyVmomi 6.0 that is not supported in Python versions 2.7 to 2.7.8. If the
version of Python is not in the supported range, you will need to install an
earlier version of pyVmomi. See \fI\%Issue #29537\fP for more information.
.UNINDENT
.UNINDENT
.sp
Based on the note above, to install an earlier version of pyVmomi than the
version currently listed in PyPi, run the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi==5.5.0.2014.1.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The 5.5.0.2014.1.1 is a known stable version that this original VMware cloud
driver was developed against.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Ensure python pyVmomi module is installed by running following one\-liner
check. The output should be 0.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-c \(dqimport pyVmomi\(dq ; echo $?
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Configuration
.sp
To use this module, set up the vCenter or ESX/ESXi URL, username and password in the
cloud configuration at
\fB/etc/salt/cloud.providers\fP or \fB/etc/salt/cloud.providers.d/vmware.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-vmware\-config:
  driver: vmware
  user: \(aqDOMAIN\euser\(aq
  password: \(aqverybadpass\(aq
  url: \(aq10.20.30.40\(aq

vcenter01:
  driver: vmware
  user: \(aqDOMAIN\euser\(aq
  password: \(aqverybadpass\(aq
  url: \(aqvcenter01.domain.com\(aq
  protocol: \(aqhttps\(aq
  port: 443

vcenter02:
  driver: vmware
  user: \(aqDOMAIN\euser\(aq
  password: \(aqverybadpass\(aq
  url: \(aqvcenter02.domain.com\(aq
  protocol: \(aqhttp\(aq
  port: 80

esx01:
  driver: vmware
  user: \(aqadmin\(aq
  password: \(aqverybadpass\(aq
  url: \(aqesx01.domain.com\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Optionally, \fBprotocol\fP and \fBport\fP can be specified if the vCenter
server is not using the defaults. Default is \fBprotocol: https\fP and
\fBport: 443\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changed in version 2015.8.0.

.sp
The \fBprovider\fP parameter in cloud provider configuration was renamed to \fBdriver\fP\&.
This change was made to avoid confusion with the \fBprovider\fP parameter that is
used in cloud profile configuration. Cloud provider configuration now uses \fBdriver\fP
to refer to the salt\-cloud driver that provides the underlying functionality to
connect to a cloud provider, while cloud profile configuration continues to use
\fBprovider\fP to refer to the cloud provider configuration that you define.
.UNINDENT
.UNINDENT
.sp
To test the connection for \fBmy\-vmware\-config\fP specified in the cloud
configuration, run \fI\%test_vcenter_connection()\fP
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.add_host(kwargs=None, call=None)
Add a host system to the specified cluster or datacenter in this VMware environment
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To use this function, you need to specify \fBesxi_host_user\fP and
\fBesxi_host_password\fP under your provider configuration set up at
\fB/etc/salt/cloud.providers\fP or \fB/etc/salt/cloud.providers.d/vmware.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vcenter01:
  driver: vmware
  user: \(aqDOMAIN\euser\(aq
  password: \(aqverybadpass\(aq
  url: \(aqvcenter01.domain.com\(aq

  # Required when adding a host system
  esxi_host_user: \(aqroot\(aq
  esxi_host_password: \(aqmyhostpassword\(aq
  # Optional fields that can be specified when adding a host system
  esxi_host_ssl_thumbprint: \(aq12:A3:45:B6:CD:7E:F8:90:A1:BC:23:45:D6:78:9E:FA:01:2B:34:CD\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The SSL thumbprint of the host system can be optionally specified by setting
\fBesxi_host_ssl_thumbprint\fP under your provider configuration. To get the SSL
thumbprint of the host system, execute the following command from a remote
server:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
echo \-n | openssl s_client \-connect <YOUR\-HOSTSYSTEM\-DNS/IP>:443 2>/dev/null | openssl x509 \-noout \-fingerprint \-sha1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f add_host my\-vmware\-config host=\(dqmyHostSystemName\(dq cluster=\(dqmyClusterName\(dq
salt\-cloud \-f add_host my\-vmware\-config host=\(dqmyHostSystemName\(dq datacenter=\(dqmyDatacenterName\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.avail_images(call=None)
Return a list of all the templates present in this VMware environment with basic
details
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.avail_locations(call=None)
Return a list of all the available locations/datacenters in this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.avail_sizes(call=None)
Return a list of all the available sizes in this VMware environment.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-sizes my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Since sizes are built into templates, this function will return
an empty dictionary.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.build_clonespec(config_spec, object_ref, reloc_spec, template)
Returns the clone spec
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.connect_host(kwargs=None, call=None)
Connect the specified host system in this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f connect_host my\-vmware\-config host=\(dqmyHostSystemName\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.convert_to_template(name, kwargs=None, call=None)
Convert the specified virtual machine to template.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a convert_to_template vmname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.create(vm_)
To create a single VM in the VMware environment.
.sp
Sample profile and arguments that can be specified in it can be found
\fI\%here.\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p vmware\-centos6.5 vmname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.create_cluster(kwargs=None, call=None)
Create a new cluster under the specified datacenter in this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_cluster my\-vmware\-config name=\(dqmyNewCluster\(dq datacenter=\(dqdatacenterName\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.create_datacenter(kwargs=None, call=None)
Create a new data center in this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_datacenter my\-vmware\-config name=\(dqMyNewDatacenter\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.create_datastore_cluster(kwargs=None, call=None)
Create a new datastore cluster for the specified datacenter in this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_datastore_cluster my\-vmware\-config name=\(dqdatastoreClusterName\(dq datacenter=\(dqdatacenterName\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.create_folder(kwargs=None, call=None)
Create the specified folder path in this VMware environment
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To create a Host and Cluster Folder under a Datacenter, specify
\fBpath=\(dq/yourDatacenterName/host/yourFolderName\(dq\fP
.sp
To create a Network Folder under a Datacenter, specify
\fBpath=\(dq/yourDatacenterName/network/yourFolderName\(dq\fP
.sp
To create a Storage Folder under a Datacenter, specify
\fBpath=\(dq/yourDatacenterName/datastore/yourFolderName\(dq\fP
.sp
To create a VM and Template Folder under a Datacenter, specify
\fBpath=\(dq/yourDatacenterName/vm/yourFolderName\(dq\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f create_folder my\-vmware\-config path=\(dq/Local/a/b/c\(dq
salt\-cloud \-f create_folder my\-vmware\-config path=\(dq/MyDatacenter/vm/MyVMFolder\(dq
salt\-cloud \-f create_folder my\-vmware\-config path=\(dq/MyDatacenter/host/MyHostFolder\(dq
salt\-cloud \-f create_folder my\-vmware\-config path=\(dq/MyDatacenter/network/MyNetworkFolder\(dq
salt\-cloud \-f create_folder my\-vmware\-config path=\(dq/MyDatacenter/storage/MyStorageFolder\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.create_snapshot(name, kwargs=None, call=None)
Create a snapshot of the specified virtual machine in this VMware
environment
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the VM is powered on, the internal state of the VM (memory
dump) is included in the snapshot by default which will also set
the power state of the snapshot to \(dqpowered on\(dq. You can set
\fBmemdump=False\fP to override this. This field is ignored if
the virtual machine is powered off or if the VM does not support
snapshots with memory dumps. Default is \fBmemdump=True\fP
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the VM is powered on when the snapshot is taken, VMware Tools
can be used to quiesce the file system in the virtual machine by
setting \fBquiesce=True\fP\&. This field is ignored if the virtual
machine is powered off; if VMware Tools are not available or if
\fBmemdump=True\fP\&. Default is \fBquiesce=False\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a create_snapshot vmname snapshot_name=\(dqmySnapshot\(dq
salt\-cloud \-a create_snapshot vmname snapshot_name=\(dqmySnapshot\(dq [description=\(dqMy snapshot\(dq] [memdump=False] [quiesce=True]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.destroy(name, call=None)
To destroy a VM from the VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-d vmname
salt\-cloud \-\-destroy vmname
salt\-cloud \-a destroy vmname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.disconnect_host(kwargs=None, call=None)
Disconnect the specified host system in this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f disconnect_host my\-vmware\-config host=\(dqmyHostSystemName\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.enter_maintenance_mode(kwargs=None, call=None)
To put the specified host system in maintenance mode in this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f enter_maintenance_mode my\-vmware\-config host=\(dqmyHostSystemName\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.exit_maintenance_mode(kwargs=None, call=None)
To take the specified host system out of maintenance mode in this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f exit_maintenance_mode my\-vmware\-config host=\(dqmyHostSystemName\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.get_clonespec_for_valid_snapshot(config_spec, object_ref, reloc_spec, template, vm_)
return clonespec only if values are valid
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.get_dependencies()
Warn if dependencies aren\(aqt met.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.get_vcenter_version(kwargs=None, call=None)
Show the vCenter Server version with build number.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f get_vcenter_version my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.handle_snapshot(config_spec, object_ref, reloc_spec, template, vm_)
Returns a clone spec for cloning from shapshots
:rtype vim.vm.CloneSpec
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_clusters(kwargs=None, call=None)
List all the clusters for this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_clusters my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_clusters_by_datacenter(kwargs=None, call=None)
List clusters for each datacenter; or clusters for a specified datacenter in
this VMware environment
.sp
To list clusters for each datacenter:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_clusters_by_datacenter my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To list clusters for a specified datacenter:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_clusters_by_datacenter my\-vmware\-config datacenter=\(dqdatacenterName\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_datacenters(kwargs=None, call=None)
List all the data centers for this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_datacenters my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_datastore_clusters(kwargs=None, call=None)
List all the datastore clusters for this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_datastore_clusters my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_datastores(kwargs=None, call=None)
List all the datastores for this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_datastores my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_dvs(kwargs=None, call=None)
List all the distributed virtual switches for this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_dvs my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_folders(kwargs=None, call=None)
List all the folders for this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_folders my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_hbas(kwargs=None, call=None)
List all HBAs for each host system; or all HBAs for a specified host
system; or HBAs of specified type for each host system; or HBAs of
specified type for a specified host system in this VMware environment
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
You can specify type as either \fBparallel\fP, \fBiscsi\fP, \fBblock\fP
or \fBfibre\fP\&.
.UNINDENT
.UNINDENT
.sp
To list all HBAs for each host system:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_hbas my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To list all HBAs for a specified host system:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_hbas my\-vmware\-config host=\(dqhostSystemName\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To list HBAs of specified type for each host system:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_hbas my\-vmware\-config type=\(dqHBAType\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To list HBAs of specified type for a specified host system:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_hbas my\-vmware\-config host=\(dqhostSystemName\(dq type=\(dqHBAtype\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_hosts(kwargs=None, call=None)
List all the hosts for this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_hosts my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_hosts_by_cluster(kwargs=None, call=None)
List hosts for each cluster; or hosts for a specified cluster in
this VMware environment
.sp
To list hosts for each cluster:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_hosts_by_cluster my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To list hosts for a specified cluster:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_hosts_by_cluster my\-vmware\-config cluster=\(dqclusterName\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_hosts_by_datacenter(kwargs=None, call=None)
List hosts for each datacenter; or hosts for a specified datacenter in
this VMware environment
.sp
To list hosts for each datacenter:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_hosts_by_datacenter my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To list hosts for a specified datacenter:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_hosts_by_datacenter my\-vmware\-config datacenter=\(dqdatacenterName\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_networks(kwargs=None, call=None)
List all the standard networks for this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_networks my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_nodes(kwargs=None, call=None)
Return a list of all VMs and templates that are on the specified provider, with basic fields
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_nodes my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To return a list of all VMs and templates present on ALL configured providers, with basic
fields:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-Q
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_nodes_full(kwargs=None, call=None)
Return a list of all VMs and templates that are on the specified provider, with full details
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_nodes_full my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To return a list of all VMs and templates present on ALL configured providers, with full
details:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-F
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_nodes_min(kwargs=None, call=None)
Return a list of all VMs and templates that are on the specified provider, with no details
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_nodes_min my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_nodes_select(call=None)
Return a list of all VMs and templates that are on the specified provider, with fields
specified under \fBquery.selection\fP in \fB/etc/salt/cloud\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_nodes_select my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To return a list of all VMs and templates present on ALL configured providers, with
fields specified under \fBquery.selection\fP in \fB/etc/salt/cloud\fP:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-S
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_portgroups(kwargs=None, call=None)
List all the distributed virtual portgroups for this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_portgroups my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_resourcepools(kwargs=None, call=None)
List all the resource pools for this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_resourcepools my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_snapshots(kwargs=None, call=None)
List snapshots either for all VMs and templates or for a specific VM/template
in this VMware environment
.sp
To list snapshots for all VMs and templates:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_snapshots my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To list snapshots for a specific VM/template:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_snapshots my\-vmware\-config name=\(dqvmname\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_templates(kwargs=None, call=None)
List all the templates present in this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_templates my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.list_vapps(kwargs=None, call=None)
List all the vApps for this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_vapps my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.reboot_host(kwargs=None, call=None)
Reboot the specified host system in this VMware environment
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the host system is not in maintenance mode, it will not be rebooted. If you
want to reboot the host system regardless of whether it is in maintenance mode,
set \fBforce=True\fP\&. Default is \fBforce=False\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f reboot_host my\-vmware\-config host=\(dqmyHostSystemName\(dq [force=True]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.remove_all_snapshots(name, kwargs=None, call=None)
Remove all the snapshots present for the specified virtual machine.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
All the snapshots higher up in the hierarchy of the current snapshot tree
are consolidated and their virtual disks are merged. To override this
behavior and only remove all snapshots, set \fBmerge_snapshots=False\fP\&.
Default is \fBmerge_snapshots=True\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a remove_all_snapshots vmname [merge_snapshots=False]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.remove_host(kwargs=None, call=None)
Remove the specified host system from this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f remove_host my\-vmware\-config host=\(dqmyHostSystemName\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.remove_snapshot(name, kwargs=None, call=None)
Remove a snapshot of the specified virtual machine in this VMware environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a remove_snapshot vmname snapshot_name=\(dqmySnapshot\(dq
salt\-cloud \-a remove_snapshot vmname snapshot_name=\(dqmySnapshot\(dq [remove_children=\(dqTrue\(dq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.rescan_hba(kwargs=None, call=None)
To rescan a specified HBA or all the HBAs on the Host System
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f rescan_hba my\-vmware\-config host=\(dqhostSystemName\(dq
salt\-cloud \-f rescan_hba my\-vmware\-config hba=\(dqhbaDeviceName\(dq host=\(dqhostSystemName\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.reset(name, soft=False, call=None)
To reset a VM using its name
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If \fBsoft=True\fP then issues a command to the guest operating system
asking it to perform a reboot. Otherwise hypervisor will terminate VM and start it again.
Default is soft=False
.sp
For \fBsoft=True\fP vmtools should be installed on guest system.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reset vmname
salt\-cloud \-a reset vmname soft=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.revert_to_snapshot(name, kwargs=None, call=None)
Revert virtual machine to its current snapshot. If no snapshot
exists, the state of the virtual machine remains unchanged
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The virtual machine will be powered on if the power state of
the snapshot when it was created was set to \(dqPowered On\(dq. Set
\fBpower_off=True\fP so that the virtual machine stays powered
off regardless of the power state of the snapshot when it was
created. Default is \fBpower_off=False\fP\&.
.sp
If the power state of the snapshot when it was created was
\(dqPowered On\(dq and if \fBpower_off=True\fP, the VM will be put in
suspended state after it has been reverted to the snapshot.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a revert_to_snapshot vmame [power_off=True]
salt\-cloud \-a revert_to_snapshot vmame snapshot_name=\(dqselectedSnapshot\(dq [power_off=True]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.script(vm_)
Return the script deployment object
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.show_instance(name, call=None)
List all available details of the specified VM
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_instance vmname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.shutdown_host(kwargs=None, call=None)
Shut down the specified host system in this VMware environment
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the host system is not in maintenance mode, it will not be shut down. If you
want to shut down the host system regardless of whether it is in maintenance mode,
set \fBforce=True\fP\&. Default is \fBforce=False\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f shutdown_host my\-vmware\-config host=\(dqmyHostSystemName\(dq [force=True]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.start(name, call=None)
To start/power on a VM using its name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a start vmname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.stop(name, soft=False, call=None)
To stop/power off a VM using its name
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If \fBsoft=True\fP then issues a command to the guest operating system
asking it to perform a clean shutdown of all services.
Default is soft=False
.sp
For \fBsoft=True\fP vmtools should be installed on guest system.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop vmname
salt\-cloud \-a stop vmname soft=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.suspend(name, call=None)
To suspend a VM using its name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a suspend vmname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.terminate(name, call=None)
To do an immediate power off of a VM using its name. A \fBSIGKILL\fP
is issued to the vmx process of the VM
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a terminate vmname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.test_vcenter_connection(kwargs=None, call=None)
Test if the connection can be made to the vCenter server using
the specified credentials inside \fB/etc/salt/cloud.providers\fP
or \fB/etc/salt/cloud.providers.d/vmware.conf\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f test_vcenter_connection my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.upgrade_tools(name, reboot=False, call=None)
To upgrade VMware Tools on a specified virtual machine.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the virtual machine is running Windows OS, use \fBreboot=True\fP
to reboot the virtual machine after VMware tools upgrade. Default
is \fBreboot=False\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a upgrade_tools vmname
salt\-cloud \-a upgrade_tools vmname reboot=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vmware.upgrade_tools_all(call=None)
To upgrade VMware Tools on all virtual machines present in
the specified provider
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the virtual machine is running Windows OS, this function
will attempt to suppress the automatic reboot caused by a
VMware Tools upgrade.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f upgrade_tools_all my\-vmware\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.cloud.clouds.vultrpy
.SS Vultr Cloud Module using python\-vultr bindings
.sp
New in version 2016.3.0.

.sp
The Vultr cloud module is used to control access to the Vultr VPS system.
.sp
Use of this module only requires the \fBapi_key\fP parameter.
.sp
Set up the cloud configuration at \fB/etc/salt/cloud.providers\fP or
\fB/etc/salt/cloud.providers.d/vultr.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-vultr\-config:
  # Vultr account api key
  api_key: <supersecretapi_key>
  driver: vultr
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Set up the cloud profile at \fB/etc/salt/cloud.profiles\fP or
\fB/etc/salt/cloud.profiles.d/vultr.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nyc\-4gb\-4cpu\-ubuntu\-14\-04:
  location: 1
  provider: my\-vultr\-config
  image: 160
  size: 95
  enable_private_network: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This driver also supports Vultr\(aqs \fIstartup script\fP feature.  You can list startup
scripts in your account with
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_scripts <name of vultr provider>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
That list will include the IDs of the scripts in your account.  Thus, if you
have a script called \(aqsetup\-networking\(aq with an ID of 493234 you can specify
that startup script in a profile like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nyc\-2gb\-1cpu\-ubuntu\-17\-04:
  location: 1
  provider: my\-vultr\-config
  image: 223
  size: 13
  startup_script_id: 493234
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Similarly you can also specify a fiewall group ID using the option firewall_group_id. You can list
firewall groups with
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_firewall_groups <name of vultr provider>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To specify SSH keys to be preinstalled on the server, use the ssh_key_names setting
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nyc\-2gb\-1cpu\-ubuntu\-17\-04:
  location: 1
  provider: my\-vultr\-config
  image: 223
  size: 13
  ssh_key_names: dev1,dev2,salt\-master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can list SSH keys available on your account using
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f list_keypairs <name of vultr provider>
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.avail_firewall_groups(conn=None)
return available firewall groups
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.avail_images(conn=None)
Return available images
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.avail_keys(conn=None)
return available SSH keys
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.avail_locations(conn=None)
return available datacenter locations
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.avail_scripts(conn=None)
return available startup scripts
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.avail_sizes(conn=None)
Return available sizes (\(dqplans\(dq in VultrSpeak)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.create(vm_)
Create a single VM from a data dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.destroy(name)
Remove a node from Vultr
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.get_configured_provider()
Return the first configured instance
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.list_firewall_groups(conn=None, call=None)
return list of firewall groups
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.list_keypairs(conn=None, call=None)
return list of SSH keys
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.list_nodes(**kwargs)
Return basic data on nodes
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.list_nodes_full(**kwargs)
Return all data on nodes
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.list_nodes_select(conn=None, call=None)
Return a list of the VMs that are on the provider, with select fields
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.list_scripts(conn=None, call=None)
return list of Startup Scripts
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.show_instance(name, call=None)
Show the details from the provider concerning an instance
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.show_keypair(kwargs=None, call=None)
return list of SSH keys
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.start(*args, **kwargs)
Execute a \(dqstart\(dq action on a VM
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.vultrpy.stop(*args, **kwargs)
Execute a \(dqstop\(dq action on a VM
.UNINDENT
.SS salt.cloud.clouds.xen
.SS XenServer Cloud Driver
.sp
The XenServer driver is designed to work with a Citrix XenServer.
.sp
Requires XenServer SDK
(can be downloaded from \fI\%https://www.citrix.com/downloads/xenserver/product\-software/\fP )
.sp
Place a copy of the XenAPI.py in the Python site\-packages folder.
.INDENT 0.0
.TP
.B depends
XenAPI
.UNINDENT
.sp
Example provider configuration:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/cloud.providers.d/myxen.conf
myxen:
  driver: xen
  url: http://10.0.0.120
  user: root
  password: p@ssw0rd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Example profile configuration:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/cloud.profiles.d/myxen.conf
suse:
  provider: myxen
  user: root
  password: p@ssw0rd
  image: opensuseleap42_2\-template
  storage_repo: \(aqLocal storage\(aq
  resource_pool: default_pool
  clone: True
  minion:
    master: 10.0.0.18
sles:
  provider: myxen
  user: root
  clone: False
  image: sles12sp2\-template
  deploy: False
w2k12:
  provider: myxen
  image: w2k12svr\-template
  clone: True
  userdata_file: /srv/salt/win/files/windows\-firewall.ps1
  win_installer: /srv/salt/win/files/Salt\-Minion\-2016.11.3\-AMD64\-Setup.exe
  win_username: Administrator
  win_password: p@ssw0rd
  use_winrm: False
  ipv4_cidr: 10.0.0.215/24
  ipv4_gw: 10.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.avail_images(call=None)
Get a list of images from Xen
.sp
If called with the \fI\-\-list\-images\fP then it returns
images with all details.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-images myxen
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.avail_locations(session=None, call=None)
Return available Xen locations (not implemented)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-locations myxen
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.avail_sizes(session=None, call=None)
Return a list of Xen template definitions
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-\-list\-sizes myxen
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.create(vm_)
Create a VM in Xen
.sp
The configuration for this function is read from the profile settings.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-p some_profile xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.destroy(name=None, call=None)
Destroy Xen VM or template instance
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-d xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.destroy_template(name=None, call=None, kwargs=None)
Destroy Xen VM or template instance
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f destroy_template myxen name=testvm2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.destroy_vm_vdis(name=None, session=None, call=None)
Get virtual block devices on VM
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a destroy_vm_vdis  xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.get_configured_provider()
Return the first configured instance.
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.get_pv_args(name, session=None, call=None)
Get PV arguments for a VM
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a get_pv_args xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.get_vm_ip(name=None, session=None, call=None)
Get the IP address of the VM
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a get_vm_ip xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Requires xen guest tools to be installed in VM
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.host_list(call=None)
Get a list of Xen Servers
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f host_list myxen
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.list_nodes()
List virtual machines
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-Q
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.list_nodes_full(session=None)
List full virtual machines
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-F
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.list_nodes_select(call=None)
Perform a select query on Xen VM instances
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-S
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.pause(name, call=None, session=None)
Pause a vm
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a pause xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.pif_list(call=None)
Get a list of Resource Pools
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f pool_list myxen
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.pool_list(call=None)
Get a list of Resource Pools
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f pool_list myxen
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.reboot(name, call=None, session=None)
Reboot a vm
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a reboot xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.resume(name, call=None, session=None)
Resume a vm from disk
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a resume xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.set_pv_args(name, kwargs=None, session=None, call=None)
Set PV arguments for a VM
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a set_pv_args xenvm01 pv_args=\(dqutf\-8 graphical\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.set_vm_ip(name=None, ipv4_cidr=None, ipv4_gw=None, session=None, call=None)
Set the IP address on a virtual interface (vif)
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.show_instance(name, session=None, call=None)
Show information about a specific VM or template
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a show_instance xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
memory is memory_dynamic_max
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.shutdown(name, call=None, session=None)
Shutdown  a vm
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a shutdown xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.sr_list(call=None)
Geta list of storage repositories
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f sr_list myxen
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.start(name, call=None, session=None)
Start  a vm
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a start xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.stop(name, call=None, session=None)
Stop a vm
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a stop xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.suspend(name, call=None, session=None)
Suspend a vm to disk
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a suspend xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.template_list(call=None)
Return available Xen template information.
.sp
This returns the details of
each template to show number cores, memory sizes, etc..
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f template_list myxen
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.unpause(name, call=None, session=None)
UnPause a vm
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a unpause xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.vbd_list(name=None, call=None)
Get a list of VBDs on a VM
.sp
\fBrequires\fP: the name of the vm with the vbd definition
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vbd_list xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.vdi_list(call=None, kwargs=None)
Return available Xen VDI images
.sp
If this function is called with the \fB\-f\fP or \fB\-\-function\fP then
it can return a list with minimal deatil using the \fBterse=True\fP keyword
argument.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-f vdi_list myxen terse=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.cloud.clouds.xen.vif_list(name, call=None, kwargs=None)
Get a list of virtual network interfaces  on a VM
.sp
\fBrequires\fP: the name of the vm with the vbd definition
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cloud \-a vif_list xenvm01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS engine modules
.TS
center;
|l|l|.
_
T{
\fI\%docker_events\fP
T}	T{
T}
_
T{
\fI\%fluent\fP
T}	T{
An engine that reads messages from the salt event bus and pushes them onto a fluent endpoint.
T}
_
T{
\fI\%http_logstash\fP
T}	T{
HTTP Logstash engine
T}
_
T{
\fI\%ircbot\fP
T}	T{
IRC Bot engine
T}
_
T{
\fI\%junos_syslog\fP
T}	T{
Junos Syslog Engine
T}
_
T{
\fI\%libvirt_events\fP
T}	T{
An engine that listens for libvirt events and resends them to the salt event bus.
T}
_
T{
\fI\%logentries\fP
T}	T{
An engine that sends events to the Logentries logging service.
T}
_
T{
\fI\%logstash_engine\fP
T}	T{
An engine that reads messages from the salt event bus and pushes them onto a logstash endpoint.
T}
_
T{
\fI\%napalm_syslog\fP
T}	T{
NAPALM syslog engine
T}
_
T{
\fI\%reactor\fP
T}	T{
Setup Reactor
T}
_
T{
\fI\%redis_sentinel\fP
T}	T{
An engine that reads messages from the redis sentinel pubsub and sends reactor events based on the channels they are subscribed to.
T}
_
T{
\fI\%script\fP
T}	T{
Send events based on a script\(aqs stdout
T}
_
T{
\fI\%slack\fP
T}	T{
An engine that reads messages from Slack and can act on them
T}
_
T{
\fI\%slack_bolt_engine\fP
T}	T{
An engine that reads messages from Slack and can act on them
T}
_
T{
\fI\%sqs_events\fP
T}	T{
An engine that continuously reads messages from SQS and fires them as events.
T}
_
T{
\fI\%stalekey\fP
T}	T{
An engine that uses presence detection to keep track of which minions have been recently connected and remove their keys if they have not been connected for a certain period of time.
T}
_
T{
\fI\%test\fP
T}	T{
A simple test engine, not intended for real use but as an example
T}
_
T{
\fI\%thorium\fP
T}	T{
Manage the Thorium complex event reaction system
T}
_
T{
\fI\%webhook\fP
T}	T{
Send events from webhook api
T}
_
.TE
.SS salt.engines.docker_events
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%docker Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Send events from Docker events
:Depends:   Docker API >= 1.22
.INDENT 0.0
.TP
.B salt.engines.docker_events.start(docker_url=\(aqunix://var/run/docker.sock\(aq, timeout=60, tag=\(aqsalt/engines/docker_events\(aq, filters=None)
Scan for Docker events and fire events
.sp
Example Config
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- docker_events:
      docker_url: unix://var/run/docker.sock
      filters:
        event:
        \- start
        \- stop
        \- die
        \- oom
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The config above sets up engines to listen
for events from the Docker daemon and publish
them to the Salt event bus.
.sp
For filter reference, see \fI\%https://docs.docker.com/engine/reference/commandline/events/\fP
.UNINDENT
.SS salt.engines.fluent
.sp
An engine that reads messages from the salt event bus and pushes
them onto a fluent endpoint.
.sp
New in version 3000.

.INDENT 0.0
.TP
.B Configuration
.UNINDENT
.sp
All arguments are optional
.INDENT 0.0
.INDENT 3.5
Example configuration of default settings
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- fluent:
      host: localhost
      port: 24224
      app: engine
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example fluentd configuration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<source>
    @type forward
    port 24224
</source>

<match saltstack.**>
    @type file
    path /var/log/td\-agent/saltstack
</match>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
fluent\-logger
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.fluent.start(host=\(aqlocalhost\(aq, port=24224, app=\(aqengine\(aq)
Listen to salt events and forward them to fluent
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhost\fP (\fI\%str\fP) \-\- Host running fluentd agent. Default is localhost
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- Port of fluentd agent. Default is 24224
.IP \(bu 2
\fBapp\fP (\fI\%str\fP) \-\- Text sent as fluentd tag. Default is \(dqengine\(dq. This text is appended
to \(dqsaltstack.\(dq to form a fluentd tag, ex: \(dqsaltstack.engine\(dq
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.engines.http_logstash
.SS HTTP Logstash engine
.sp
An engine that reads messages from the salt event bus and pushes
them onto a logstash endpoint via HTTP requests.
.sp
Changed in version 2018.3.0.

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
By default, this engine take everything from the Salt bus and exports into
Logstash.
For a better selection of the events that you want to publish, you can use
the \fBtags\fP and \fBfuns\fP options.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B configuration
Example configuration
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- http_logstash:
      url: http://blabla.com/salt\-stuff
      tags:
          \- salt/job/*/new
          \- salt/job/*/ret/*
      funs:
          \- probes.results
          \- bgp.config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.http_logstash.start(url, funs=None, tags=None)
Listen to salt events and forward them to logstash.
.INDENT 7.0
.TP
.B url
The Logstash endpoint.
.TP
.B funs: \fBNone\fP
A list of functions to be compared against, looking into the \fBfun\fP
field from the event data. This option helps to select the events
generated by one or more functions.
If an event does not have the \fBfun\fP field in the data section, it
will be published. For a better selection, consider using the \fBtags\fP
option.
By default, this option accepts any event to be submitted to Logstash.
.TP
.B tags: \fBNone\fP
A list of pattern to compare the event tag against.
By default, this option accepts any event to be submitted to Logstash.
.UNINDENT
.UNINDENT
.SS salt.engines.ircbot
.sp
IRC Bot engine
.sp
New in version 2017.7.0.

.sp
Example Configuration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- ircbot:
      nick: <nick>
      username: <username>
      password: <password>
      host: irc.oftc.net
      port: 7000
      channels:
        \- salt\-test
        \- \(aq##something\(aq
      use_ssl: True
      use_sasl: True
      disable_query: True
      allow_hosts:
        \- salt/engineer/.*
      allow_nicks:
        \- gtmanfred
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Available commands on irc are:
.INDENT 0.0
.TP
.B ping
return pong
.TP
.B echo <stuff>
return <stuff> targeted at the user who sent the commands
.TP
.B event <tag> [<extra>, <data>]
fire event on the master or minion event stream with the tag \fIsalt/engines/ircbot/<tag>\fP and a data object with a
list of everything else sent in the message
.UNINDENT
.sp
Example of usage
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
08:33:57 @gtmanfred > !ping
08:33:57   gtmanbot > gtmanfred: pong
08:34:02 @gtmanfred > !echo ping
08:34:02   gtmanbot > ping
08:34:17 @gtmanfred > !event test/tag/ircbot irc is useful
08:34:17   gtmanbot > gtmanfred: TaDa!
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[DEBUG   ] Sending event: tag = salt/engines/ircbot/test/tag/ircbot; data = {\(aq_stamp\(aq: \(aq2016\-11\-28T14:34:16.633623\(aq, \(aqdata\(aq: [\(aqirc\(aq, \(aqis\(aq, \(aquseful\(aq]}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.engines.ircbot.Event(source, code, line)
.INDENT 7.0
.TP
.B code
Alias for field number 1
.UNINDENT
.INDENT 7.0
.TP
.B line
Alias for field number 2
.UNINDENT
.INDENT 7.0
.TP
.B source
Alias for field number 0
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.engines.ircbot.IRCClient(nick, host, port=6667, username=None, password=None, channels=None, use_ssl=False, use_sasl=False, char=\(aq!\(aq, allow_hosts=False, allow_nicks=False, disable_query=True)
.INDENT 7.0
.TP
.B join_channel(channel)
.UNINDENT
.INDENT 7.0
.TP
.B on_closed()
.UNINDENT
.INDENT 7.0
.TP
.B on_connect()
.UNINDENT
.INDENT 7.0
.TP
.B read_messages()
.UNINDENT
.INDENT 7.0
.TP
.B send_message(line)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.engines.ircbot.PrivEvent(source, nick, user, host, code, channel, command, line)
.INDENT 7.0
.TP
.B channel
Alias for field number 5
.UNINDENT
.INDENT 7.0
.TP
.B code
Alias for field number 4
.UNINDENT
.INDENT 7.0
.TP
.B command
Alias for field number 6
.UNINDENT
.INDENT 7.0
.TP
.B host
Alias for field number 3
.UNINDENT
.INDENT 7.0
.TP
.B line
Alias for field number 7
.UNINDENT
.INDENT 7.0
.TP
.B nick
Alias for field number 1
.UNINDENT
.INDENT 7.0
.TP
.B source
Alias for field number 0
.UNINDENT
.INDENT 7.0
.TP
.B user
Alias for field number 2
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.ircbot.start(nick, host, port=6667, username=None, password=None, channels=None, use_ssl=False, use_sasl=False, char=\(aq!\(aq, allow_hosts=False, allow_nicks=False, disable_query=True)
IRC Bot for interacting with salt.
.INDENT 7.0
.TP
.B nick
Nickname of the connected Bot.
.TP
.B host
irc server (example \- irc.oftc.net).
.TP
.B port
irc port.  Default: 6667
.TP
.B password
password for authenticating.  If not provided, user will not authenticate on the irc server.
.TP
.B channels
channels to join.
.TP
.B use_ssl
connect to server using ssl. Default: False
.TP
.B use_sasl
authenticate using sasl, instead of messaging NickServ. Default: False
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This will allow the bot user to be fully authenticated before joining any channels
.UNINDENT
.UNINDENT
.TP
.B char
command character to look for. Default: !
.TP
.B allow_hosts
hostmasks allowed to use commands on the bot.  Default: False
True to allow all
False to allow none
List of regexes to allow matching
.TP
.B allow_nicks
Nicks that are allowed to use commands on the bot.  Default: False
True to allow all
False to allow none
List of regexes to allow matching
.TP
.B disable_query
Disable commands from being sent through private queries.  Require they be sent to a channel, so that all
communication can be controlled by access to the channel. Default: True
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Unauthenticated Access to event stream
.sp
This engine sends events calls to the event stream without authenticating them in salt.  Authentication will
need to be configured and enforced on the irc server or enforced in the irc channel.  The engine only accepts
commands from channels, so non authenticated users could be banned or quieted in the channel.
.sp
/mode +q $~a  # quiet all users who are not authenticated
/mode +r      # do not allow unauthenticated users into the channel
.sp
It would also be possible to add a password to the irc channel, or only allow invited users to join.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.engines.junos_syslog
.SS Junos Syslog Engine
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B depends
pyparsing, twisted
.UNINDENT
.sp
An engine that listens to syslog message from Junos devices,
extract event information and generate message on SaltStack bus.
.sp
The event topic sent to salt is dynamically generated according to the topic title
specified by the user. The incoming event data (from the junos device) consists
of the following fields:
.INDENT 0.0
.IP 1. 4
hostname
.IP 2. 4
hostip
.IP 3. 4
daemon
.IP 4. 4
event
.IP 5. 4
severity
.IP 6. 4
priority
.IP 7. 4
timestamp
.IP 8. 4
message
.IP 9. 4
pid
.IP 10. 4
raw (the raw event data forwarded from the device)
.UNINDENT
.sp
The topic title can consist of any of the combination of above fields,
but the topic has to start with \(aqjnpr/syslog\(aq.
So, we can have different combinations:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
jnpr/syslog/hostip/daemon/event
.IP \(bu 2
jnpr/syslog/daemon/severity
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The corresponding dynamic topic sent on salt event bus would look something like:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
jnpr/syslog/1.1.1.1/mgd/UI_COMMIT_COMPLETED
.IP \(bu 2
jnpr/syslog/sshd/7
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The default topic title is \(aqjnpr/syslog/hostname/event\(aq.
.sp
The user can choose the type of data they wants of the event bus.
Like, if one wants only events pertaining to a particular daemon, they can
specify that in the configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
daemon: mgd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
One can even have a list of daemons like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
daemon:
  \- mgd
  \- sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example configuration (to be written in master config file)
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- junos_syslog:
      port: 9999
      topic: jnpr/syslog/hostip/daemon/event
      daemon:
        \- mgd
        \- sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For junos_syslog engine to receive events, syslog must be set on the junos device.
This can be done via following configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set system syslog host <ip\-of\-the\-salt\-device> port 516 any any
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Below is a sample syslog event which is received from the junos device:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(aq<30>May 29 05:18:12 bng\-ui\-vm\-9 mspd[1492]: No chassis configuration found\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The source for parsing the syslog messages is taken from:
\fI\%https://gist.github.com/leandrosilva/3651640#file\-xlog\-py\fP
.INDENT 0.0
.TP
.B class  salt.engines.junos_syslog.DatagramProtocol
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.junos_syslog.start(port=516, **kwargs)
.UNINDENT
.SS salt.engines.libvirt_events
.sp
An engine that listens for libvirt events and resends them to the salt event bus.
.sp
The minimal configuration is the following and will listen to all events on the
local hypervisor and send them with a tag starting with \fBsalt/engines/libvirt_events\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
    \- libvirt_events
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that the automatically\-picked libvirt connection will depend on the value
of \fBuri_default\fP in \fB/etc/libvirt/libvirt.conf\fP\&. To force using another
connection like the local LXC libvirt driver, set the \fBuri\fP property as in the
following example configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
    \- libvirt_events:
        uri: lxc:///
        tag_prefix: libvirt
        filters:
            \- domain/lifecycle
            \- domain/reboot
            \- pool
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Filters is a list of event types to relay to the event bus. Items in this list
can be either one of the main types (\fBdomain\fP, \fBnetwork\fP, \fBpool\fP,
\fBnodedev\fP, \fBsecret\fP), \fBall\fP or a more precise filter. These can be done
with values like <main_type>/<subtype>. The possible values are in the
CALLBACK_DEFS constant. If the filters list contains \fBall\fP, all
events will be relayed.
.sp
Be aware that the list of events increases with libvirt versions, for example
network events have been added in libvirt 1.2.1 and storage events in 2.0.0.
.SS Running the engine on non\-root
.sp
Running this engine as non\-root requires a special attention, which is surely
the case for the master running as user \fIsalt\fP\&. The engine is likely to fail
to connect to libvirt with an error like this one:
.INDENT 0.0
.INDENT 3.5
[ERROR   ] authentication unavailable: no polkit agent available to authenticate action \(aqorg.libvirt.unix.monitor\(aq
.UNINDENT
.UNINDENT
.sp
To fix this, the user running the engine, for example the salt\-master, needs
to have the rights to connect to libvirt in the machine polkit config.
A polkit rule like the following one will allow \fIsalt\fP user to connect to libvirt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
polkit.addRule(function(action, subject) {
    if (action.id.indexOf(\(dqorg.libvirt\(dq) == 0 &&
        subject.user == \(dqsalt\(dq) {
        return polkit.Result.YES;
    }
});
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
libvirt 1.0.0+ python binding
.UNINDENT
.sp
New in version 2019.2.0.

.INDENT 0.0
.TP
.B salt.engines.libvirt_events.start(uri=None, tag_prefix=\(aqsalt/engines/libvirt_events\(aq, filters=None)
Listen to libvirt events and forward them to salt.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuri\fP \-\- libvirt URI to listen on.
Defaults to None to pick the first available local hypervisor
.IP \(bu 2
\fBtag_prefix\fP \-\- the beginning of the salt event tag to use.
Defaults to \(aqsalt/engines/libvirt_events\(aq
.IP \(bu 2
\fBfilters\fP \-\- the list of event of listen on. Defaults to \(aqall\(aq
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.engines.logentries
.sp
An engine that sends events to the Logentries logging service.
.INDENT 0.0
.TP
.B maintainer
Jimmy Tang (\fI\%jimmy_tang@rapid7.com\fP)
.TP
.B maturity
New
.TP
.B depends
ssl, certifi
.TP
.B platform
all
.UNINDENT
.sp
New in version 2016.3.0.

.sp
To enable this engine the master and/or minion will need the following
python libraries
.INDENT 0.0
.INDENT 3.5
ssl
certifi
.UNINDENT
.UNINDENT
.sp
If you are running a new enough version of python then the ssl library
will be present already.
.sp
You will also need the following values configured in the minion or
master config.
.INDENT 0.0
.TP
.B configuration
Example configuration
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- logentries:
      endpoint: data.logentries.com
      port: 10000
      token: 057af3e2\-1c05\-47c5\-882a\-5cd644655dbf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The \(aqtoken\(aq can be obtained from the Logentries service.
.sp
To test this engine
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping cmd.run uptime
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.engines.logentries.PlainTextSocketAppender(verbose=True, LE_API=\(aqdata.logentries.com\(aq, LE_PORT=80, LE_TLS_PORT=443)
.INDENT 7.0
.TP
.B close_connection()
.UNINDENT
.INDENT 7.0
.TP
.B open_connection()
.UNINDENT
.INDENT 7.0
.TP
.B put(data)
.UNINDENT
.INDENT 7.0
.TP
.B reopen_connection()
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.logentries.SocketAppender
alias of \fI\%TLSSocketAppender\fP
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.engines.logentries.TLSSocketAppender(verbose=True, LE_API=\(aqdata.logentries.com\(aq, LE_PORT=80, LE_TLS_PORT=443)
.INDENT 7.0
.TP
.B open_connection()
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.logentries.event_bus_context(opts)
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.logentries.start(endpoint=\(aqdata.logentries.com\(aq, port=10000, token=None, tag=\(aqsalt/engines/logentries\(aq)
Listen to salt events and forward them to Logentries
.UNINDENT
.SS salt.engines.logstash_engine
.sp
An engine that reads messages from the salt event bus and pushes
them onto a logstash endpoint.
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B configuration
Example configuration
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- logstash:
      host: log.my_network.com
      port: 5959
      proto: tcp
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
logstash
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.logstash_engine.event_bus_context(opts)
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.logstash_engine.start(host, port=5959, tag=\(aqsalt/engine/logstash\(aq, proto=\(aqudp\(aq)
Listen to salt events and forward them to logstash
.UNINDENT
.SS salt.engines.napalm_syslog
.SS NAPALM syslog engine
.sp
New in version 2017.7.0.

.sp
An engine that takes syslog messages structured in
\fI\%OpenConfig\fP or IETF format
and fires Salt events.
.sp
As there can be many messages pushed into the event bus,
the user is able to filter based on the object structure.
.SS Requirements
.INDENT 0.0
.IP \(bu 2
\fI\%napalm\-logs\fP
.UNINDENT
.sp
This engine transfers objects from the napalm\-logs library
into the event bus. The top dictionary has the following keys:
.INDENT 0.0
.IP \(bu 2
\fBip\fP
.IP \(bu 2
\fBhost\fP
.IP \(bu 2
\fBtimestamp\fP
.IP \(bu 2
\fBos\fP: the network OS identified
.IP \(bu 2
\fBmodel_name\fP: the OpenConfig or IETF model name
.IP \(bu 2
\fBerror\fP: the error name (consult the documentation)
.IP \(bu 2
\fBmessage_details\fP: details extracted from the syslog message
.IP \(bu 2
\fBopen_config\fP: the OpenConfig model
.UNINDENT
.sp
The napalm\-logs transfers the messages via widely used transport
mechanisms such as: ZeroMQ (default), Kafka, etc.
.sp
The user can select the right transport using the \fBtransport\fP
option in the configuration.
.INDENT 0.0
.TP
.B configuration
Example configuration
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- napalm_syslog:
      transport: zmq
      address: 1.2.3.4
      port: 49018
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B configuration
Configuration example, excluding messages from IOS\-XR devices:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- napalm_syslog:
      transport: kafka
      address: 1.2.3.4
      port: 49018
      os_blacklist:
        \- iosxr
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Event example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dq_stamp\(dq: \(dq2017\-05\-26T10:03:18.653045\(dq,
    \(dqerror\(dq: \(dqBGP_PREFIX_THRESH_EXCEEDED\(dq,
    \(dqhost\(dq: \(dqvmx01\(dq,
    \(dqip\(dq: \(dq192.168.140.252\(dq,
    \(dqmessage_details\(dq: {
        \(dqdate\(dq: \(dqMay 25\(dq,
        \(dqhost\(dq: \(dqvmx01\(dq,
        \(dqmessage\(dq: \(dq192.168.140.254 (External AS 65001): Configured maximum prefix\-limit threshold(22) exceeded for inet\-unicast nlri: 28 (instance master)\(dq,
        \(dqpri\(dq: \(dq28\(dq,
        \(dqprocessId\(dq: \(dq2957\(dq,
        \(dqprocessName\(dq: \(dqrpd\(dq,
        \(dqtag\(dq: \(dqBGP_PREFIX_THRESH_EXCEEDED\(dq,
        \(dqtime\(dq: \(dq20:50:41\(dq
    },
    \(dqmodel_name\(dq: \(dqopenconfig_bgp\(dq,
    \(dqopen_config\(dq: {
        \(dqbgp\(dq: {
            \(dqneighbors\(dq: {
                \(dqneighbor\(dq: {
                    \(dq192.168.140.254\(dq: {
                        \(dqafi_safis\(dq: {
                            \(dqafi_safi\(dq: {
                                \(dqinet\(dq: {
                                    \(dqafi_safi_name\(dq: \(dqinet\(dq,
                                    \(dqipv4_unicast\(dq: {
                                        \(dqprefix_limit\(dq: {
                                            \(dqstate\(dq: {
                                                \(dqmax_prefixes\(dq: 22
                                            }
                                        }
                                    },
                                    \(dqstate\(dq: {
                                        \(dqprefixes\(dq: {
                                            \(dqreceived\(dq: 28
                                        }
                                    }
                                }
                            }
                        },
                        \(dqneighbor_address\(dq: \(dq192.168.140.254\(dq,
                        \(dqstate\(dq: {
                            \(dqpeer_as\(dq: 65001
                        }
                    }
                }
            }
        }
    },
    \(dqos\(dq: \(dqjunos\(dq,
    \(dqtimestamp\(dq: \(dq1495741841\(dq
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To consume the events and eventually react and deploy a configuration changes
on the device(s) firing the event, one is able to identify the minion ID, using
one of the following alternatives, but not limited to:
.INDENT 0.0
.IP \(bu 2
\fI\%Host grains\fP to match the event tag
.IP \(bu 2
\fI\%Host DNS grain\fP to match the IP address in the event data
.IP \(bu 2
\fI\%Hostname grains\fP to match the event tag
.IP \(bu 2
\fI\%Define static grains\fP
.IP \(bu 2
\fI\%Write a grains module\fP
.IP \(bu 2
\fI\%Targeting minions using pillar data\fP \- The user can
configure certain information in the Pillar data and then use it to identify
minions
.UNINDENT
.sp
Master configuration example, to match the event and react:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reactor:
  \- \(aqnapalm/syslog/*/BGP_PREFIX_THRESH_EXCEEDED/*\(aq:
    \- salt://increase_prefix_limit_on_thresh_exceeded.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Which matches the events having the error code \fBBGP_PREFIX_THRESH_EXCEEDED\fP
from any network operating system, from any host and reacts, executing the
\fBincrease_prefix_limit_on_thresh_exceeded.sls\fP reactor, found under
one of the \fI\%file_roots\fP paths.
.sp
Reactor example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
increase_prefix_limit_on_thresh_exceeded:
  local.net.load_template:
    \- tgt: \(dqhostname:{{ data[\(aqhost\(aq] }}\(dq
    \- tgt_type: grain
    \- kwarg:
        template_name: salt://increase_prefix_limit.jinja
        openconfig_structure: {{ data[\(aqopen_config\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The reactor in the example increases the BGP prefix limit
when triggered by an event as above. The minion is matched using the \fBhost\fP
field from the \fBdata\fP (which is the body of the event), compared to the
\fI\%hostname grain\fP field. When the event
occurs, the reactor will execute the
\fI\%net.load_template\fP function,
sending as arguments the template \fBsalt://increase_prefix_limit.jinja\fP defined
by the user in their environment and the complete OpenConfig object under
the variable name \fBopenconfig_structure\fP\&. Inside the Jinja template, the user
can process the object from \fBopenconfig_structure\fP and define the bussiness
logic as required.
.INDENT 0.0
.TP
.B salt.engines.napalm_syslog.start(transport=\(aqzmq\(aq, address=\(aq0.0.0.0\(aq, port=49017, auth_address=\(aq0.0.0.0\(aq, auth_port=49018, disable_security=False, certificate=None, os_whitelist=None, os_blacklist=None, error_whitelist=None, error_blacklist=None, host_whitelist=None, host_blacklist=None)
Listen to napalm\-logs and publish events into the Salt event bus.
.INDENT 7.0
.TP
.B transport: \fBzmq\fP
Choose the desired transport.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Currently \fBzmq\fP is the only valid option.
.UNINDENT
.UNINDENT
.TP
.B address: \fB0.0.0.0\fP
The address of the publisher, as configured on napalm\-logs.
.TP
.B port: \fB49017\fP
The port of the publisher, as configured on napalm\-logs.
.TP
.B auth_address: \fB0.0.0.0\fP
The address used for authentication
when security is not disabled.
.TP
.B auth_port: \fB49018\fP
Port used for authentication.
.TP
.B disable_security: \fBFalse\fP
Trust unencrypted messages.
Strongly discouraged in production.
.TP
.B certificate: \fBNone\fP
Absolute path to the SSL certificate.
.TP
.B os_whitelist: \fBNone\fP
List of operating systems allowed. By default everything is allowed.
.TP
.B os_blacklist: \fBNone\fP
List of operating system to be ignored. Nothing ignored by default.
.TP
.B error_whitelist: \fBNone\fP
List of errors allowed.
.TP
.B error_blacklist: \fBNone\fP
List of errors ignored.
.TP
.B host_whitelist: \fBNone\fP
List of hosts or IPs to be allowed.
.TP
.B host_blacklist: \fBNone\fP
List of hosts of IPs to be ignored.
.UNINDENT
.UNINDENT
.SS salt.engines.reactor
.sp
Setup Reactor
.sp
Example Config in Master or Minion config
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- reactor:
      refresh_interval: 60
      worker_threads: 10
      worker_hwm: 10000

reactor:
  \- \(aqsalt/cloud/*/destroyed\(aq:
    \- /srv/reactor/destroy/*.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.reactor.start(refresh_interval=None, worker_threads=None, worker_hwm=None)
.UNINDENT
.SS salt.engines.redis_sentinel
.sp
An engine that reads messages from the redis sentinel pubsub and sends reactor
events based on the channels they are subscribed to.
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B configuration
Example configuration
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- redis_sentinel:
      hosts:
        matching: \(aqboard*\(aq
        port: 26379
        interface: eth2
      channels:
        \- \(aq+switch\-master\(aq
        \- \(aq+odown\(aq
        \- \(aq\-odown\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
redis
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.engines.redis_sentinel.Listener(host=None, port=None, channels=None, tag=None)
.INDENT 7.0
.TP
.B run()
.UNINDENT
.INDENT 7.0
.TP
.B work(item)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.redis_sentinel.start(hosts, channels, tag=None)
.UNINDENT
.SS salt.engines.script
.sp
Send events based on a script\(aqs stdout
.sp
Example Config
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- script:
      cmd: /some/script.py \-a 1 \-b 2
      output: json
      interval: 5
      onchange: false
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Script engine configs:
.INDENT 0.0
.TP
.B cmd
Script or command to execute
.TP
.B output
Any available saltstack deserializer
.TP
.B interval
How often in seconds to execute the command
.TP
.B onchange
New in version 3006.0.

.sp
Only fire an event if the tag\-specific output changes. Defaults to False.
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.script.start(cmd, output=\(aqjson\(aq, interval=1, onchange=False)
Parse stdout of a command and generate an event
.sp
The script engine will scrap stdout of the
given script and generate an event based on the
presence of the \(aqtag\(aq key and its value.
.sp
If there is a data obj available, that will also
be fired along with the tag.
.sp
Example
.sp
Given the following json output from a script:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{ \(dqtag\(dq : \(dqlots/of/tacos\(dq,
\(dqdata\(dq : { \(dqtoppings\(dq : \(dqcilantro\(dq }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
This will fire the event \(aqlots/of/tacos\(aq
on the event bus with the data obj as is.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcmd\fP \-\- The command to execute
.IP \(bu 2
\fBoutput\fP \-\- How to deserialize stdout of the script
.IP \(bu 2
\fBinterval\fP \-\- How often to execute the script
.IP \(bu 2
\fBonchange\fP \-\- Only fire an event if the tag\-specific output changes
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.engines.slack
.sp
An engine that reads messages from Slack and can act on them
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B depends
\fI\%slackclient\fP Python module
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
This engine requires a bot user. To create a bot user, first go to the
\fBCustom Integrations\fP page in your Slack Workspace. Copy and paste the
following URL, and replace \fBmyworkspace\fP with the proper value for your
workspace:
.sp
\fBhttps://myworkspace.slack.com/apps/manage/custom\-integrations\fP
.sp
Next, click on the \fBBots\fP integration and request installation. Once
approved by an admin, you will be able to proceed with adding the bot user.
Once the bot user has been added, you can configure it by adding an avatar,
setting the display name, etc. You will also at this time have access to
your API token, which will be needed to configure this engine.
.sp
Finally, add this bot user to a channel by switching to the channel and
using \fB/invite @mybotuser\fP\&. Keep in mind that this engine will process
messages from each channel in which the bot is a member, so it is
recommended to narrowly define the commands which can be executed, and the
Slack users which are allowed to run commands.
.UNINDENT
.UNINDENT
.sp
This engine has two boolean configuration parameters that toggle specific
features (both default to \fBFalse\fP):
.INDENT 0.0
.IP 1. 3
\fBcontrol\fP \- If set to \fBTrue\fP, then any message which starts with the
trigger string (which defaults to \fB!\fP and can be overridden by setting the
\fBtrigger\fP option in the engine configuration) will be interpreted as a
Salt CLI command and the engine will attempt to run it. The permissions
defined in the various \fBgroups\fP will determine if the Slack user is
allowed to run the command. The \fBtargets\fP and \fBdefault_target\fP options
can be used to set targets for a given command, but the engine can also read
the following two keyword arguments:
.INDENT 3.0
.IP \(bu 2
\fBtarget\fP \- The target expression to use for the command
.IP \(bu 2
\fBtgt_type\fP \- The match type, can be one of \fBglob\fP, \fBlist\fP,
\fBpcre\fP, \fBgrain\fP, \fBgrain_pcre\fP, \fBpillar\fP, \fBnodegroup\fP, \fBrange\fP,
\fBipcidr\fP, or \fBcompound\fP\&. The default value is \fBglob\fP\&.
.UNINDENT
.sp
Here are a few examples:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
!test.ping target=*
!state.apply foo target=os:CentOS tgt_type=grain
!pkg.version mypkg target=role:database tgt_type=pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
\fBfire_all\fP \- If set to \fBTrue\fP, all messages which are not prefixed with
the trigger string will fired as events onto Salt\(aqs ref:\fIevent bus
<event\-system>\fP\&. The tag for these veents will be prefixed with the string
specified by the \fBtag\fP config option (default: \fBsalt/engines/slack\fP).
.UNINDENT
.sp
The \fBgroups_pillar_name\fP config option can be used to pull group
configuration from the specified pillar key.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In order to use \fBgroups_pillar_name\fP, the engine must be running as a
minion running on the master, so that the \fBCaller\fP client can be used to
retrieve that minions pillar data, because the master process does not have
pillar data.
.UNINDENT
.UNINDENT
.SS Configuration Examples
.sp
Changed in version 2017.7.0: Access control group support added

.sp
This example uses a single group called \fBdefault\fP\&. In addition, other groups
are being loaded from pillar data. The group names do not have any
significance, it is the users and commands defined within them that are used to
determine whether the Slack user has permission to run the desired command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- slack:
      token: \(aqxoxb\-xxxxxxxxxx\-xxxxxxxxxxxxxxxxxxxxxxxx\(aq
      control: True
      fire_all: False
      groups_pillar_name: \(aqslack_engine:groups_pillar\(aq
      groups:
        default:
          users:
            \- \(aq*\(aq
          commands:
            \- test.ping
            \- cmd.run
            \- list_jobs
            \- list_commands
          aliases:
            list_jobs:
              cmd: jobs.list_jobs
            list_commands:
              cmd: \(aqpillar.get salt:engines:slack:valid_commands target=saltmaster tgt_type=list\(aq
          default_target:
            target: saltmaster
            tgt_type: glob
          targets:
            test.ping:
              target: \(aq*\(aq
              tgt_type: glob
            cmd.run:
              target: saltmaster
              tgt_type: list
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example shows multiple groups applying to different users, with all users
having access to run test.ping. Keep in mind that when using \fB*\fP, the value
must be quoted, or else PyYAML will fail to load the configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- slack:
      groups_pillar: slack_engine_pillar
      token: \(aqxoxb\-xxxxxxxxxx\-xxxxxxxxxxxxxxxxxxxxxxxx\(aq
      control: True
      fire_all: True
      tag: salt/engines/slack
      groups_pillar_name: \(aqslack_engine:groups_pillar\(aq
      groups:
        default:
          users:
            \- \(aq*\(aq
          commands:
            \- test.ping
          aliases:
            list_jobs:
              cmd: jobs.list_jobs
            list_commands:
              cmd: \(aqpillar.get salt:engines:slack:valid_commands target=saltmaster tgt_type=list\(aq
        gods:
          users:
            \- garethgreenaway
          commands:
            \- \(aq*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.engines.slack.SlackClient(token)
.INDENT 7.0
.TP
.B can_user_run(user, command, groups)
Break out the permissions into the following:
.sp
Check whether a user is in any group, including whether a group has the \(aq*\(aq membership
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuser\fP (\fI\%str\fP) \-\- The username being checked against
.IP \(bu 2
\fBcommand\fP (\fI\%str\fP) \-\- The command that is being invoked (e.g. test.ping)
.IP \(bu 2
\fBgroups\fP (\fI\%dict\fP) \-\- the dictionary with groups permissions structure.
.UNINDENT
.TP
.B Return type
\fI\%tuple\fP
.TP
.B Returns
On a successful permitting match, returns 2\-element tuple that contains
the name of the group that successfully matched, and a dictionary containing
the configuration of the group so it can be referenced.
.sp
On failure it returns an empty tuple

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B commandline_to_list(cmdline_str, trigger_string)
cmdline_str is the string of the command line
trigger_string is the trigger string, to be removed
.UNINDENT
.INDENT 7.0
.TP
.B control_message_target(slack_user_name, text, loaded_groups, trigger_string)
Returns a tuple of (target, cmdline,) for the response
.sp
Raises IndexError if a user can\(aqt be looked up from all_slack_users
.sp
Returns (False, False) if the user doesn\(aqt have permission
.sp
These are returned together because the commandline and the targeting
interact with the group config (specifically aliases and targeting configuration)
so taking care of them together works out.
.sp
The cmdline that is returned is the actual list that should be
processed by salt, and not the alias.
.UNINDENT
.INDENT 7.0
.TP
.B fire(tag, msg)
This replaces a function in main called \(aqfire\(aq
.sp
It fires an event into the salt bus.
.UNINDENT
.INDENT 7.0
.TP
.B format_return_text(data, function, **kwargs)
Print out YAML using the block mode
.UNINDENT
.INDENT 7.0
.TP
.B generate_triggered_messages(token, trigger_string, groups, groups_pillar_name)
slack_token = string
trigger_string = string
input_valid_users = set
input_valid_commands = set
.sp
When the trigger_string prefixes the message text, yields a dictionary
of:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqmessage_data\(aq: m_data,
    \(aqcmdline\(aq: cmdline_list, # this is a list
    \(aqchannel\(aq: channel,
    \(aquser\(aq: m_data[\(aquser\(aq],
    \(aqslack_client\(aq: sc
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
else yields {\(aqmessage_data\(aq: m_data} and the caller can handle that
.sp
When encountering an error (e.g. invalid message), yields {}, the caller can proceed to the next message
.sp
When the websocket being read from has given up all its messages, yields {\(aqdone\(aq: True} to
indicate that the caller has read all of the relevant data for now, and should continue
its own processing and check back for more data later.
.sp
This relies on the caller sleeping between checks, otherwise this could flood
.UNINDENT
.INDENT 7.0
.TP
.B get_config_groups(groups_conf, groups_pillar_name)
get info from groups in config, and from the named pillar
.sp
todo: add specification for the minion to use to recover pillar
.UNINDENT
.INDENT 7.0
.TP
.B get_jobs_from_runner(outstanding_jids)
Given a list of job_ids, return a dictionary of those job_ids that have
completed and their results.
.sp
Query the salt event bus via the jobs runner. jobs.list_job will show
a job in progress, jobs.lookup_jid will return a job that has
completed.
.sp
returns a dictionary of job id: result
.UNINDENT
.INDENT 7.0
.TP
.B get_slack_channels(token)
Get all channel names from Slack
.UNINDENT
.INDENT 7.0
.TP
.B get_slack_users(token)
Get all users from Slack
.UNINDENT
.INDENT 7.0
.TP
.B get_target(permitted_group, cmdline, alias_cmdline)
When we are permitted to run a command on a target, look to see
what the default targeting is for that group, and for that specific
command (if provided).
.sp
It\(aqs possible for None or False to be the result of either, which means
that it\(aqs expected that the caller provide a specific target.
.sp
If no configured target is provided, the command line will be parsed
for target=foo and tgt_type=bar
.sp
Test for this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
h = {\(aqaliases\(aq: {}, \(aqcommands\(aq: {\(aqcmd.run\(aq, \(aqpillar.get\(aq},
    \(aqdefault_target\(aq: {\(aqtarget\(aq: \(aq*\(aq, \(aqtgt_type\(aq: \(aqglob\(aq},
    \(aqtargets\(aq: {\(aqpillar.get\(aq: {\(aqtarget\(aq: \(aqyou_momma\(aq, \(aqtgt_type\(aq: \(aqlist\(aq}},
    \(aqusers\(aq: {\(aqdmangot\(aq, \(aqjmickle\(aq, \(aqpcn\(aq}}
f = {\(aqaliases\(aq: {}, \(aqcommands\(aq: {\(aqcmd.run\(aq, \(aqpillar.get\(aq},
     \(aqdefault_target\(aq: {}, \(aqtargets\(aq: {},\(aqusers\(aq: {\(aqdmangot\(aq, \(aqjmickle\(aq, \(aqpcn\(aq}}

g = {\(aqaliases\(aq: {}, \(aqcommands\(aq: {\(aqcmd.run\(aq, \(aqpillar.get\(aq},
     \(aqdefault_target\(aq: {\(aqtarget\(aq: \(aq*\(aq, \(aqtgt_type\(aq: \(aqglob\(aq},
     \(aqtargets\(aq: {}, \(aqusers\(aq: {\(aqdmangot\(aq, \(aqjmickle\(aq, \(aqpcn\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Run each of them through \fBget_configured_target((\(aqfoo\(aq, f), \(aqpillar.get\(aq)\fP and confirm a valid target
.UNINDENT
.INDENT 7.0
.TP
.B message_text(m_data)
Raises ValueError if a value doesn\(aqt work out, and TypeError if
this isn\(aqt a message type
.UNINDENT
.INDENT 7.0
.TP
.B parse_args_and_kwargs(cmdline)
cmdline: list
.sp
returns tuple of: args (list), kwargs (dict)
.UNINDENT
.INDENT 7.0
.TP
.B run_command_async(msg)
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmessage_generator\fP (\fIgenerator\fP\fI of \fP\fI\%dict\fP) \-\- Generates messages from slack that should be run
.IP \(bu 2
\fBfire_all\fP (\fI\%bool\fP) \-\- Whether to also fire messages to the event bus
.IP \(bu 2
\fBtag\fP (\fI\%str\fP) \-\- The tag to send to use to send to the event bus
.IP \(bu 2
\fBinterval\fP (\fI\%int\fP) \-\- time to wait between ending a loop and beginning the next
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B run_commands_from_slack_async(message_generator, fire_all, tag, control, interval=1)
Pull any pending messages from the message_generator, sending each
one to either the event bus, the command_async or both, depending on
the values of fire_all and command
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.slack.start(token, control=False, trigger=\(aq!\(aq, groups=None, groups_pillar_name=None, fire_all=False, tag=\(aqsalt/engines/slack\(aq)
Listen to slack events and forward them to salt, new version
.UNINDENT
.SS salt.engines.slack_bolt_engine
.sp
An engine that reads messages from Slack and can act on them
.sp
New in version 3006.0.

.INDENT 0.0
.TP
.B depends
\fI\%slack_bolt\fP Python module
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
This engine requires a Slack app and a Slack Bot user. To create a
bot user, first go to the \fBCustom Integrations\fP page in your
Slack Workspace. Copy and paste the following URL, and log in with
account credentials with administrative privileges:
.sp
\fBhttps://api.slack.com/apps/new\fP
.sp
Next, click on the \fBFrom scratch\fP option from the \fBCreate an app\fP popup.
Give your new app a unique name, eg. \fBSaltSlackEngine\fP, select the workspace
where your app will be running, and click \fBCreate App\fP\&.
.sp
Next, click on \fBSocket Mode\fP and then click on the toggle button for
\fBEnable Socket Mode\fP\&. In the dialog give your Socket Mode Token a unique
name and then copy and save the app level token.  This will be used
as the \fBapp_token\fP parameter in the Slack engine configuration.
.sp
Next, click on \fBEvent Subscriptions\fP and ensure that \fBEnable Events\fP is in
the on position.  Then  add the following bot events, \fBmessage.channel\fP
and \fBmessage.im\fP to the \fBSubcribe to bot events\fP list.
.sp
Next, click on \fBOAuth & Permissions\fP and then under \fBBot Token Scope\fP, click
on \fBAdd an OAuth Scope\fP\&.  Ensure the following scopes are included:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBchannels:history\fP
.IP \(bu 2
\fBchannels:read\fP
.IP \(bu 2
\fBchat:write\fP
.IP \(bu 2
\fBcommands\fP
.IP \(bu 2
\fBfiles:read\fP
.IP \(bu 2
\fBfiles:write\fP
.IP \(bu 2
\fBim:history\fP
.IP \(bu 2
\fBmpim:history\fP
.IP \(bu 2
\fBusergroups:read\fP
.IP \(bu 2
\fBusers:read\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Once all the scopes have been added, click the \fBInstall to Workspace\fP button
under \fBOAuth Tokens for Your Workspace\fP, then click \fBAllow\fP\&.  Copy and save
the \fBBot User OAuth Token\fP, this will be used as the \fBbot_token\fP parameter
in the Slack engine configuration.
.sp
Finally, add this bot user to a channel by switching to the channel and
using \fB/invite @mybotuser\fP\&. Keep in mind that this engine will process
messages from each channel in which the bot is a member, so it is
recommended to narrowly define the commands which can be executed, and the
Slack users which are allowed to run commands.
.UNINDENT
.UNINDENT
.sp
This engine has two boolean configuration parameters that toggle specific
features (both default to \fBFalse\fP):
.INDENT 0.0
.IP 1. 3
\fBcontrol\fP \- If set to \fBTrue\fP, then any message which starts with the
trigger string (which defaults to \fB!\fP and can be overridden by setting the
\fBtrigger\fP option in the engine configuration) will be interpreted as a
Salt CLI command and the engine will attempt to run it. The permissions
defined in the various \fBgroups\fP will determine if the Slack user is
allowed to run the command. The \fBtargets\fP and \fBdefault_target\fP options
can be used to set targets for a given command, but the engine can also read
the following two keyword arguments:
.INDENT 3.0
.IP \(bu 2
\fBtarget\fP \- The target expression to use for the command
.IP \(bu 2
\fBtgt_type\fP \- The match type, can be one of \fBglob\fP, \fBlist\fP,
\fBpcre\fP, \fBgrain\fP, \fBgrain_pcre\fP, \fBpillar\fP, \fBnodegroup\fP, \fBrange\fP,
\fBipcidr\fP, or \fBcompound\fP\&. The default value is \fBglob\fP\&.
.UNINDENT
.sp
Here are a few examples:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
!test.ping target=*
!state.apply foo target=os:CentOS tgt_type=grain
!pkg.version mypkg target=role:database tgt_type=pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
\fBfire_all\fP \- If set to \fBTrue\fP, all messages which are not prefixed with
the trigger string will fired as events onto Salt\(aqs ref:\fIevent bus
<event\-system>\fP\&. The tag for these events will be prefixed with the string
specified by the \fBtag\fP config option (default: \fBsalt/engines/slack\fP).
.UNINDENT
.sp
The \fBgroups_pillar_name\fP config option can be used to pull group
configuration from the specified pillar key.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In order to use \fBgroups_pillar_name\fP, the engine must be running as a
minion running on the master, so that the \fBCaller\fP client can be used to
retrieve that minion\(aqs pillar data, because the master process does not have
pillar data.
.UNINDENT
.UNINDENT
.SS Configuration Examples
.sp
Changed in version 2017.7.0: Access control group support added

.sp
Changed in version 3006.0: Updated to use slack_bolt Python library.

.sp
This example uses a single group called \fBdefault\fP\&. In addition, other groups
are being loaded from pillar data. The users and commands defined within these
groups are used to determine whether the Slack user has permission to run
the desired command.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- slack_bolt:
      app_token: \(dqxapp\-x\-xxxxxxxxxxx\-xxxxxxxxxxxxx\-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\(dq
      bot_token: \(aqxoxb\-xxxxxxxxxx\-xxxxxxxxxxxxxxxxxxxxxxxx\(aq
      control: True
      fire_all: False
      groups_pillar_name: \(aqslack_engine:groups_pillar\(aq
      groups:
        default:
          users:
            \- \(aq*\(aq
          commands:
            \- test.ping
            \- cmd.run
            \- list_jobs
            \- list_commands
          aliases:
            list_jobs:
              cmd: jobs.list_jobs
            list_commands:
              cmd: \(aqpillar.get salt:engines:slack:valid_commands target=saltmaster tgt_type=list\(aq
          default_target:
            target: saltmaster
            tgt_type: glob
          targets:
            test.ping:
              target: \(aq*\(aq
              tgt_type: glob
            cmd.run:
              target: saltmaster
              tgt_type: list
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example shows multiple groups applying to different users, with all users
having access to run test.ping. Keep in mind that when using \fB*\fP, the value
must be quoted, or else PyYAML will fail to load the configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- slack_bolt:
      groups_pillar: slack_engine_pillar
      app_token: \(dqxapp\-x\-xxxxxxxxxxx\-xxxxxxxxxxxxx\-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\(dq
      bot_token: \(aqxoxb\-xxxxxxxxxx\-xxxxxxxxxxxxxxxxxxxxxxxx\(aq
      control: True
      fire_all: True
      tag: salt/engines/slack
      groups_pillar_name: \(aqslack_engine:groups_pillar\(aq
      groups:
        default:
          users:
            \- \(aq*\(aq
          commands:
            \- test.ping
          aliases:
            list_jobs:
              cmd: jobs.list_jobs
            list_commands:
              cmd: \(aqpillar.get salt:engines:slack:valid_commands target=saltmaster tgt_type=list\(aq
        gods:
          users:
            \- garethgreenaway
          commands:
            \- \(aq*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.engines.slack_bolt_engine.SlackClient(app_token, bot_token, trigger_string)
.INDENT 7.0
.TP
.B can_user_run(user, command, groups)
Check whether a user is in any group, including whether a group has the \(aq*\(aq membership
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuser\fP (\fI\%str\fP) \-\- The username being checked against
.IP \(bu 2
\fBcommand\fP (\fI\%str\fP) \-\- The command that is being invoked (e.g. test.ping)
.IP \(bu 2
\fBgroups\fP (\fI\%dict\fP) \-\- the dictionary with groups permissions structure.
.UNINDENT
.TP
.B Return type
\fI\%tuple\fP
.TP
.B Returns
On a successful permitting match, returns 2\-element tuple that contains
the name of the group that successfully matched, and a dictionary containing
the configuration of the group so it can be referenced.
.sp
On failure it returns an empty tuple

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B commandline_to_list(cmdline_str, trigger_string)
cmdline_str is the string of the command line
trigger_string is the trigger string, to be removed
.UNINDENT
.INDENT 7.0
.TP
.B control_message_target(slack_user_name, text, loaded_groups, trigger_string)
Returns a tuple of (target, cmdline,) for the response
.sp
Raises IndexError if a user can\(aqt be looked up from all_slack_users
.sp
Returns (False, False) if the user doesn\(aqt have permission
.sp
These are returned together because the commandline and the targeting
interact with the group config (specifically aliases and targeting configuration)
so taking care of them together works out.
.sp
The cmdline that is returned is the actual list that should be
processed by salt, and not the alias.
.UNINDENT
.INDENT 7.0
.TP
.B fire(tag, msg)
This replaces a function in main called \(aqfire\(aq
.sp
It fires an event into the salt bus.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtag\fP (\fI\%str\fP) \-\- The tag to use when sending events to the Salt event bus.
.IP \(bu 2
\fBmsg\fP (\fI\%dict\fP) \-\- The msg dictionary to send to the Salt event bus.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B format_return_text(data, function, **kwargs)
Print out YAML using the block mode
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtoken\fP \-\- The return data that needs to be formatted.
.IP \(bu 2
\fBtoken\fP \-\- The function that was used to generate the return data.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B generate_triggered_messages(token, trigger_string, groups, groups_pillar_name)
slack_token = string
trigger_string = string
input_valid_users = set
input_valid_commands = set
.sp
When the trigger_string prefixes the message text, yields a dictionary
of:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqmessage_data\(aq: m_data,
    \(aqcmdline\(aq: cmdline_list, # this is a list
    \(aqchannel\(aq: channel,
    \(aquser\(aq: m_data[\(aquser\(aq],
    \(aqslack_client\(aq: sc
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
else yields {\(aqmessage_data\(aq: m_data} and the caller can handle that
.sp
When encountering an error (e.g. invalid message), yields {}, the caller can proceed to the next message
.sp
When the websocket being read from has given up all its messages, yields {\(aqdone\(aq: True} to
indicate that the caller has read all of the relevant data for now, and should continue
its own processing and check back for more data later.
.sp
This relies on the caller sleeping between checks, otherwise this could flood
.UNINDENT
.INDENT 7.0
.TP
.B get_config_groups(groups_conf, groups_pillar_name)
get info from groups in config, and from the named pillar
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBgroup_conf\fP (\fI\%dict\fP) \-\- The dictionary containing the groups, group members,
and the commands those group members have access to.
.IP \(bu 2
\fBgroups_pillar_name\fP (\fI\%str\fP) \-\- can be used to pull group configuration from the specified pillar key.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B get_jobs_from_runner(outstanding_jids)
Given a list of job_ids, return a dictionary of those job_ids that have
completed and their results.
.sp
Query the salt event bus via the jobs runner. jobs.list_job will show
a job in progress, jobs.lookup_jid will return a job that has
completed.
.INDENT 7.0
.TP
.B Parameters
\fBoutstanding_jids\fP (\fI\%list\fP) \-\- The list of job ids to check for completion.
.UNINDENT
.sp
returns a dictionary of job id: result
.UNINDENT
.INDENT 7.0
.TP
.B get_slack_channels(token)
Get all channel names from Slack
.INDENT 7.0
.TP
.B Parameters
\fBtoken\fP (\fI\%str\fP) \-\- The Slack token being used to allow Salt to interact with Slack.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B get_slack_users(token)
Get all users from Slack
.INDENT 7.0
.TP
.B Parameters
\fBtoken\fP \-\- The Slack token being used to allow Salt to interact with Slack.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B get_target(permitted_group, cmdline, alias_cmdline)
When we are permitted to run a command on a target, look to see
what the default targeting is for that group, and for that specific
command (if provided).
.sp
It\(aqs possible for \fBNone\fP or \fBFalse\fP to be the result of either, which means
that it\(aqs expected that the caller provide a specific target.
.sp
If no configured target is provided, the command line will be parsed
for target=foo and tgt_type=bar
.sp
Test for this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
h = {\(aqaliases\(aq: {}, \(aqcommands\(aq: {\(aqcmd.run\(aq, \(aqpillar.get\(aq},
    \(aqdefault_target\(aq: {\(aqtarget\(aq: \(aq*\(aq, \(aqtgt_type\(aq: \(aqglob\(aq},
    \(aqtargets\(aq: {\(aqpillar.get\(aq: {\(aqtarget\(aq: \(aqyou_momma\(aq, \(aqtgt_type\(aq: \(aqlist\(aq}},
    \(aqusers\(aq: {\(aqdmangot\(aq, \(aqjmickle\(aq, \(aqpcn\(aq}}
f = {\(aqaliases\(aq: {}, \(aqcommands\(aq: {\(aqcmd.run\(aq, \(aqpillar.get\(aq},
     \(aqdefault_target\(aq: {}, \(aqtargets\(aq: {},\(aqusers\(aq: {\(aqdmangot\(aq, \(aqjmickle\(aq, \(aqpcn\(aq}}

g = {\(aqaliases\(aq: {}, \(aqcommands\(aq: {\(aqcmd.run\(aq, \(aqpillar.get\(aq},
     \(aqdefault_target\(aq: {\(aqtarget\(aq: \(aq*\(aq, \(aqtgt_type\(aq: \(aqglob\(aq},
     \(aqtargets\(aq: {}, \(aqusers\(aq: {\(aqdmangot\(aq, \(aqjmickle\(aq, \(aqpcn\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Run each of them through \fBget_configured_target((\(aqfoo\(aq, f), \(aqpillar.get\(aq)\fP and confirm a valid target
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpermitted_group\fP (\fI\%tuple\fP) \-\- A tuple containing the group name and group configuration to check for permission.
.IP \(bu 2
\fBcmdline\fP (\fI\%list\fP) \-\- The command sent from Slack formatted as a list.
.IP \(bu 2
\fBalias_cmdline\fP (\fI\%str\fP) \-\- An alias to a cmdline.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B message_text(m_data)
Raises ValueError if a value doesn\(aqt work out, and TypeError if
this isn\(aqt a message type
.INDENT 7.0
.TP
.B Parameters
\fBm_data\fP (\fI\%dict\fP) \-\- The message sent from Slack
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B message_trigger(message)
.UNINDENT
.INDENT 7.0
.TP
.B parse_args_and_kwargs(cmdline)
.INDENT 7.0
.TP
.B Parameters
\fBcmdline\fP (\fI\%list\fP) \-\- The command sent from Slack formatted as a list.
.UNINDENT
.sp
returns tuple of: args (list), kwargs (dict)
.UNINDENT
.INDENT 7.0
.TP
.B run_command_async(msg)
.INDENT 7.0
.TP
.B Parameters
\fBmsg\fP (\fI\%dict\fP) \-\- The message dictionary that contains the command and all information.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B run_commands_from_slack_async(message_generator, fire_all, tag, control, interval=1)
Pull any pending messages from the message_generator, sending each
one to either the event bus, the command_async or both, depending on
the values of fire_all and command
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmessage_generator\fP (\fIgenerator\fP\fI of \fP\fI\%dict\fP) \-\- Generates messages from slack that should be run
.IP \(bu 2
\fBfire_all\fP (\fI\%bool\fP) \-\- Whether to also fire messages to the event bus
.IP \(bu 2
\fBcontrol\fP (\fI\%bool\fP) \-\- If set to True, whether Slack is allowed to control Salt.
.IP \(bu 2
\fBtag\fP (\fI\%str\fP) \-\- The tag to send to use to send to the event bus
.IP \(bu 2
\fBinterval\fP (\fI\%int\fP) \-\- time to wait between ending a loop and beginning the next
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.slack_bolt_engine.start(app_token, bot_token, control=False, trigger=\(aq!\(aq, groups=None, groups_pillar_name=None, fire_all=False, tag=\(aqsalt/engines/slack\(aq)
Listen to slack events and forward them to salt, new version
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapp_token\fP (\fI\%str\fP) \-\- The Slack application token used by Salt to communicate with Slack.
.IP \(bu 2
\fBbot_token\fP (\fI\%str\fP) \-\- The Slack bot token used by Salt to communicate with Slack.
.IP \(bu 2
\fBcontrol\fP (\fI\%bool\fP) \-\- Determines whether or not commands sent from Slack with the trigger string will control Salt, defaults to False.
.IP \(bu 2
\fBtrigger\fP (\fI\%str\fP) \-\- The string that should preface all messages in Slack that should be treated as commands to send to Salt.
.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- The string that should preface all messages in Slack that should be treated as commands to send to Salt.
.IP \(bu 2
\fBgroup_pillars\fP \-\- A pillar key that can be used to pull group configuration.
.IP \(bu 2
\fBfire_all\fP (\fI\%bool\fP) \-\- If set to \fBTrue\fP, all messages which are not prefixed with
the trigger string will fired as events onto Salt\(aqs ref:\fIevent bus
<event\-system>\fP\&. The tag for these events will be prefixed with the string
specified by the \fBtag\fP config option (default: \fBsalt/engines/slack\fP).
.IP \(bu 2
\fBtag\fP (\fI\%str\fP) \-\- The tag to prefix all events sent to the Salt event bus.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.engines.sqs_events
.sp
An engine that continuously reads messages from SQS and fires them as events.
.sp
Note that long polling is utilized to avoid excessive CPU usage.
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B depends
boto
.UNINDENT
.SS Configuration
.sp
This engine can be run on the master or on a minion.
.sp
Example Config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sqs.keyid: GKTADJGHEIQSXMKKRBJ08H
sqs.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
sqs.message_format: json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Explicit sqs credentials are accepted but this engine can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not (or for \fBboto\fP version < 2.5.1) used you need to
specify them either in a pillar or in the config file of the master or
minion, as appropriate:
.sp
To deserialize the message from json:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sqs.message_format: json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify key, keyid and region via a profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sqs.keyid: GKTADJGHEIQSXMKKRBJ08H
sqs.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sqs.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
  region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Additionally you can define cross account sqs:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- sqs_events:
      queue: prod
      owner_acct_id: 111111111111
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.sqs_events.start(queue, profile=None, tag=\(aqsalt/engine/sqs\(aq, owner_acct_id=None)
Listen to sqs and fire message on event bus
.UNINDENT
.SS salt.engines.stalekey
.sp
An engine that uses presence detection to keep track of which minions
have been recently connected and remove their keys if they have not been
connected for a certain period of time.
.sp
Requires that the \fI\%minion_data_cache\fP option be enabled.
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B configuration
Example configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- stalekey:
      interval: 3600
      expire: 86400
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.stalekey.start(interval=3600, expire=604800)
Start the engine
.UNINDENT
.SS salt.engines.test
.sp
A simple test engine, not intended for real use but as an example
.INDENT 0.0
.TP
.B salt.engines.test.event_bus_context(opts)
.UNINDENT
.INDENT 0.0
.TP
.B salt.engines.test.start()
Listen to events and write them to a log file
.UNINDENT
.SS salt.engines.thorium
.sp
Manage the Thorium complex event reaction system
.INDENT 0.0
.TP
.B salt.engines.thorium.start(grains=False, grain_keys=None, pillar=False, pillar_keys=None)
Execute the Thorium runtime
.UNINDENT
.SS salt.engines.webhook
.sp
Send events from webhook api
.INDENT 0.0
.TP
.B salt.engines.webhook.start(address=None, port=5000, ssl_crt=None, ssl_key=None)
Api to listen for webhooks to send to the reactor.
.sp
Implement the webhook behavior in an engine.
\fI\%rest_cherrypy Webhook docs\fP
.sp
Unlike the rest_cherrypy Webhook, this is only an unauthenticated webhook
endpoint.  If an authenticated webhook endpoint is needed, use the salt\-api
webhook which runs on the master and authenticates through eauth.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Unauthenticated endpoint
.sp
This engine sends webhook calls to the event stream.  If the engine is
running on a minion with \fIfile_client: local\fP the event is sent to the
minion event stream.  Otherwise it is sent to the master event stream.
.UNINDENT
.UNINDENT
.sp
Example Config
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- webhook: {}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- webhook:
      port: 8000
      address: 10.128.1.145
      ssl_crt: /etc/pki/tls/certs/localhost.crt
      ssl_key: /etc/pki/tls/certs/localhost.key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS execution modules
.INDENT 0.0
.INDENT 3.5
.IP "Virtual modules"
.SS salt.modules.group
.sp
\fBgroup\fP is a virtual module that is fulfilled by one of the following
modules:
.TS
center;
|l|l|.
_
T{
Execution Module
T}	T{
Used for
T}
_
T{
\fI\%groupadd\fP
T}	T{
Linux, NetBSD, and OpenBSD systems using
\fBgroupadd(8)\fP, \fBgroupdel(8)\fP, and
\fBgroupmod(8)\fP
T}
_
T{
\fI\%pw_group\fP
T}	T{
FreeBSD\-based OSes using \fBpw(8)\fP
T}
_
T{
\fI\%solaris_group\fP
T}	T{
Solaris\-based OSes using
\fBgroupadd(1M)\fP, \fBgroupdel(1M)\fP, and
\fBgroupmod(1M)\fP
T}
_
T{
\fI\%win_groupadd\fP
T}	T{
Windows
T}
_
.TE
.SS salt.modules.kernelpkg
.sp
\fBkernelpkg\fP is a virtual module that is fulfilled by one of the following modules:
.TS
center;
|l|l|.
_
T{
Execution Module
T}	T{
Used for
T}
_
T{
\fI\%kernelpkg_linux_apt\fP
T}	T{
Debian/Ubuntu\-based distros which use
\fBapt\-get\fP for package management
T}
_
T{
\fI\%kernelpkg_linux_yum\fP
T}	T{
RedHat\-based distros and derivatives
using \fByum\fP or \fBdnf\fP
T}
_
.TE
.SS salt.modules.pkg
.sp
\fBpkg\fP is a virtual module that is fulfilled by one of the following modules:
.TS
center;
|l|l|.
_
T{
Execution Module
T}	T{
Used for
T}
_
T{
\fI\%aixpkg\fP
T}	T{
AIX OS using \fBinstallp\fP and \fBrpm\fP
T}
_
T{
\fI\%aptpkg\fP
T}	T{
Debian/Ubuntu\-based distros which use
\fBapt\-get(8)\fP for package management
T}
_
T{
\fI\%mac_brew_pkg\fP
T}	T{
Mac OS software management using
\fI\%Homebrew\fP
T}
_
T{
\fI\%ebuildpkg\fP
T}	T{
Gentoo\-based systems (utilizes the
\fBportage\fP python module as well as
\fBemerge(1)\fP)
T}
_
T{
\fI\%freebsdpkg\fP
T}	T{
FreeBSD\-based OSes using \fBpkg_add(1)\fP
T}
_
T{
\fI\%openbsdpkg\fP
T}	T{
OpenBSD\-based OSes using \fBpkg_add(1)\fP
T}
_
T{
\fI\%pacmanpkg\fP
T}	T{
Arch Linux\-based distros using
\fBpacman(8)\fP
T}
_
T{
\fI\%pkgin\fP
T}	T{
NetBSD\-based OSes using \fBpkgin(1)\fP
T}
_
T{
\fI\%pkgng\fP
T}	T{
FreeBSD\-based OSes using \fBpkg(8)\fP
T}
_
T{
\fI\%pkgutil\fP
T}	T{
Solaris\-based OSes using \fI\%OpenCSW\fP\(aqs
\fBpkgutil(1)\fP
T}
_
T{
\fI\%solarispkg\fP
T}	T{
Solaris\-based OSes using \fBpkgadd(1M)\fP
T}
_
T{
\fI\%solarisipspkg\fP
T}	T{
Solaris\-based OSes using IPS \fBpkg(1)\fP
T}
_
T{
\fI\%win_pkg\fP
T}	T{
Salt\(aqs \fI\%Windows Package Manager\fP
T}
_
T{
\fI\%yumpkg\fP
T}	T{
RedHat\-based distros and derivatives
using \fByum(8)\fP or \fBdnf(8)\fP
T}
_
T{
\fI\%zypperpkg\fP
T}	T{
SUSE\-based distros using \fBzypper(8)\fP
T}
_
.TE
.SS salt.modules.service
.sp
\fBservice\fP is a virtual module that is fulfilled by one of the following
modules:
.TS
center;
|l|l|.
_
T{
Execution Module
T}	T{
Used for
T}
_
T{
\fI\%debian_service\fP
T}	T{
Debian Wheezy and earlier
T}
_
T{
\fI\%freebsdservice\fP
T}	T{
FreeBSD\-based OSes using \fBservice(8)\fP
T}
_
T{
\fI\%gentoo_service\fP
T}	T{
Gentoo Linux using \fBsysvinit\fP and
\fBrc\-update(8)\fP
T}
_
T{
\fI\%mac_service\fP
T}	T{
Mac OS hosts using \fBlaunchctl(1)\fP
T}
_
T{
\fI\%netbsdservice\fP
T}	T{
NetBSD\-based OSes
T}
_
T{
\fI\%openbsdservice\fP
T}	T{
OpenBSD\-based OSes
T}
_
T{
\fI\%rh_service\fP
T}	T{
RedHat\-based distros and derivatives
using \fBservice(8)\fP and
\fBchkconfig(8)\fP\&. Supports both pure
sysvinit and mixed sysvinit/upstart
systems.
T}
_
T{
\fI\%service\fP
T}	T{
Fallback which simply wraps sysvinit
scripts
T}
_
T{
\fI\%smf_service\fP
T}	T{
Solaris\-based OSes which use SMF
T}
_
T{
\fI\%systemd_service\fP
T}	T{
Linux distros which use systemd
T}
_
T{
\fI\%upstart_service\fP
T}	T{
Ubuntu\-based distros using upstart
T}
_
T{
\fI\%win_service\fP
T}	T{
Windows
T}
_
.TE
.SS salt.modules.shadow
.sp
\fBshadow\fP is a virtual module that is fulfilled by one of the following
modules:
.TS
center;
|l|l|.
_
T{
Execution Module
T}	T{
Used for
T}
_
T{
\fI\%aix_shadow\fP
T}	T{
AIX
T}
_
T{
\fI\%linux_shadow\fP
T}	T{
Linux
T}
_
T{
\fI\%bsd_shadow\fP
T}	T{
FreeBSD, OpenBSD, NetBSD
T}
_
T{
\fI\%solaris_shadow\fP
T}	T{
Solaris\-based OSes
T}
_
T{
\fI\%win_shadow\fP
T}	T{
Windows
T}
_
.TE
.SS salt.modules.sysctl
.sp
\fBsysctl\fP is a virtual module that is fulfilled by one of the following modules:
.TS
center;
|l|l|.
_
T{
Execution Module
T}	T{
Used for
T}
_
T{
\fI\%freebsd_sysctl\fP
T}	T{
FreeBSD
T}
_
T{
\fI\%linux_sysctl\fP
T}	T{
Linux
T}
_
T{
\fI\%mac_sysctl\fP
T}	T{
macOS
T}
_
T{
\fI\%netbsd_sysctl\fP
T}	T{
NetBSD
T}
_
T{
\fI\%openbsd_sysctl\fP
T}	T{
OpenBSD
T}
_
.TE
.SS salt.modules.user
.sp
\fBuser\fP is a virtual module that is fulfilled by one of the following modules:
.TS
center;
|l|l|.
_
T{
Execution Module
T}	T{
Used for
T}
_
T{
\fI\%useradd\fP
T}	T{
Linux, NetBSD, and OpenBSD systems using
\fBuseradd(8)\fP, \fBuserdel(8)\fP, and
\fBusermod(8)\fP
T}
_
T{
\fI\%pw_user\fP
T}	T{
FreeBSD\-based OSes using \fBpw(8)\fP
T}
_
T{
\fI\%solaris_user\fP
T}	T{
Solaris\-based OSes using
\fBuseradd(1M)\fP, \fBuserdel(1M)\fP, and
\fBusermod(1M)\fP
T}
_
T{
\fI\%mac_user\fP
T}	T{
MacOS
T}
_
T{
\fI\%win_useradd\fP
T}	T{
Windows
T}
_
.TE
.UNINDENT
.UNINDENT
.TS
center;
|l|l|.
_
T{
\fI\%acme\fP
T}	T{
ACME / Let\(aqs Encrypt module
T}
_
T{
\fI\%aix_group\fP
T}	T{
Manage groups on Solaris
T}
_
T{
\fI\%aix_shadow\fP
T}	T{
Manage account locks on AIX systems
T}
_
T{
\fI\%aixpkg\fP
T}	T{
Package support for AIX
T}
_
T{
\fI\%aliases\fP
T}	T{
Manage the information in the aliases file
T}
_
T{
\fI\%alternatives\fP
T}	T{
Support for Alternatives system
T}
_
T{
\fI\%ansiblegate\fP
T}	T{
Ansible Support
T}
_
T{
\fI\%apache\fP
T}	T{
Support for Apache
T}
_
T{
\fI\%apcups\fP
T}	T{
Module for apcupsd
T}
_
T{
\fI\%apf\fP
T}	T{
Support for Advanced Policy Firewall (APF)

maintainer

Mostafa Hussein <\fI\%mostafa.hussein91@gmail.com\fP>

maturity

new

depends

python\-iptables

platform

Linux
T}
_
T{
\fI\%apkpkg\fP
T}	T{
Support for apk
T}
_
T{
\fI\%aptly\fP
T}	T{
Aptly Debian repository manager.
T}
_
T{
\fI\%aptpkg\fP
T}	T{
Support for APT (Advanced Packaging Tool)
T}
_
T{
\fI\%archive\fP
T}	T{
A module to wrap (non\-Windows) archive calls
T}
_
T{
\fI\%arista_pyeapi\fP
T}	T{
Arista pyeapi
T}
_
T{
\fI\%artifactory\fP
T}	T{
Module for fetching artifacts from Artifactory
T}
_
T{
\fI\%at\fP
T}	T{
Wrapper module for at(1)
T}
_
T{
\fI\%at_solaris\fP
T}	T{
Wrapper for at(1) on Solaris\-like systems
T}
_
T{
\fI\%augeas_cfg\fP
T}	T{
Manages configuration files via augeas
T}
_
T{
\fI\%aws_sqs\fP
T}	T{
Support for the Amazon Simple Queue Service.
T}
_
T{
\fI\%bamboohr\fP
T}	T{
Support for BambooHR
T}
_
T{
\fI\%baredoc\fP
T}	T{
Baredoc walks the installed module and state directories and generates dictionaries and lists of the function names and their arguments.
T}
_
T{
\fI\%bcache\fP
T}	T{
Module for managing BCache sets
T}
_
T{
\fI\%beacons\fP
T}	T{
Module for managing the Salt beacons on a minion
T}
_
T{
\fI\%bigip\fP
T}	T{
An execution module which can manipulate an f5 bigip via iControl REST
T}
_
T{
\fI\%bluez_bluetooth\fP
T}	T{
Support for Bluetooth (using BlueZ in Linux).
T}
_
T{
\fI\%boto3_elasticache\fP
T}	T{
Execution module for Amazon Elasticache using boto3
T}
_
T{
\fI\%boto3_elasticsearch\fP
T}	T{
Connection module for Amazon Elasticsearch Service
T}
_
T{
\fI\%boto3_route53\fP
T}	T{
Execution module for Amazon Route53 written against Boto 3
T}
_
T{
\fI\%boto3_sns\fP
T}	T{
Connection module for Amazon SNS
T}
_
T{
\fI\%boto_apigateway\fP
T}	T{
Connection module for Amazon APIGateway
T}
_
T{
\fI\%boto_asg\fP
T}	T{
Connection module for Amazon Autoscale Groups
T}
_
T{
\fI\%boto_cfn\fP
T}	T{
Connection module for Amazon Cloud Formation
T}
_
T{
\fI\%boto_cloudfront\fP
T}	T{
Connection module for Amazon CloudFront
T}
_
T{
\fI\%boto_cloudtrail\fP
T}	T{
Connection module for Amazon CloudTrail
T}
_
T{
\fI\%boto_cloudwatch\fP
T}	T{
Connection module for Amazon CloudWatch
T}
_
T{
\fI\%boto_cloudwatch_event\fP
T}	T{
Connection module for Amazon CloudWatch Events
T}
_
T{
\fI\%boto_cognitoidentity\fP
T}	T{
Connection module for Amazon CognitoIdentity
T}
_
T{
\fI\%boto_datapipeline\fP
T}	T{
Connection module for Amazon Data Pipeline
T}
_
T{
\fI\%boto_dynamodb\fP
T}	T{
Connection module for Amazon DynamoDB
T}
_
T{
\fI\%boto_ec2\fP
T}	T{
Connection module for Amazon EC2
T}
_
T{
\fI\%boto_efs\fP
T}	T{
Connection module for Amazon EFS
T}
_
T{
\fI\%boto_elasticache\fP
T}	T{
Connection module for Amazon Elasticache
T}
_
T{
\fI\%boto_elasticsearch_domain\fP
T}	T{
Connection module for Amazon Elasticsearch Service
T}
_
T{
\fI\%boto_elb\fP
T}	T{
Connection module for Amazon ELB
T}
_
T{
\fI\%boto_elbv2\fP
T}	T{
Connection module for Amazon ALB
T}
_
T{
\fI\%boto_iam\fP
T}	T{
Connection module for Amazon IAM
T}
_
T{
\fI\%boto_iot\fP
T}	T{
Connection module for Amazon IoT
T}
_
T{
\fI\%boto_kinesis\fP
T}	T{
Connection module for Amazon Kinesis
T}
_
T{
\fI\%boto_kms\fP
T}	T{
Connection module for Amazon KMS
T}
_
T{
\fI\%boto_lambda\fP
T}	T{
Connection module for Amazon Lambda
T}
_
T{
\fI\%boto_rds\fP
T}	T{
Connection module for Amazon RDS
T}
_
T{
\fI\%boto_route53\fP
T}	T{
Connection module for Amazon Route53
T}
_
T{
\fI\%boto_s3\fP
T}	T{
Connection module for Amazon S3 using boto3
T}
_
T{
\fI\%boto_s3_bucket\fP
T}	T{
Connection module for Amazon S3 Buckets
T}
_
T{
\fI\%boto_secgroup\fP
T}	T{
Connection module for Amazon Security Groups
T}
_
T{
\fI\%boto_sns\fP
T}	T{
Connection module for Amazon SNS
T}
_
T{
\fI\%boto_sqs\fP
T}	T{
Connection module for Amazon SQS
T}
_
T{
\fI\%boto_ssm\fP
T}	T{
Connection module for Amazon SSM
T}
_
T{
\fI\%boto_vpc\fP
T}	T{
Connection module for Amazon VPC
T}
_
T{
\fI\%bower\fP
T}	T{
Manage and query Bower packages
T}
_
T{
\fI\%bridge\fP
T}	T{
Module for gathering and managing bridging information
T}
_
T{
\fI\%bsd_shadow\fP
T}	T{
Manage the password database on BSD systems
T}
_
T{
\fI\%btrfs\fP
T}	T{
Module for managing BTRFS file systems.
T}
_
T{
\fI\%cabal\fP
T}	T{
Manage and query Cabal packages
T}
_
T{
\fI\%capirca_acl\fP
T}	T{
Capirca ACL
T}
_
T{
\fI\%cassandra_cql\fP
T}	T{
Cassandra Database Module
T}
_
T{
\fI\%celery\fP
T}	T{
Support for scheduling celery tasks.
T}
_
T{
\fI\%ceph\fP
T}	T{
Module to provide ceph control with salt.
T}
_
T{
\fI\%chassis\fP
T}	T{
Glue execution module to link to the \fI\%fx2 proxymodule\fP\&.
T}
_
T{
\fI\%chef\fP
T}	T{
Execute chef in server or solo mode
T}
_
T{
\fI\%chocolatey\fP
T}	T{
A module that wraps calls to the Chocolatey package manager (\fI\%http://chocolatey.org\fP)
T}
_
T{
\fI\%chronos\fP
T}	T{
Module providing a simple management interface to a chronos cluster.
T}
_
T{
\fI\%chroot\fP
T}	T{
Module for chroot :maintainer:    Alberto Planas <\fI\%aplanas@suse.com\fP> :maturity:      new :depends:       None :platform:      Linux
T}
_
T{
\fI\%cimc\fP
T}	T{
Module to provide Cisco UCS compatibility to Salt
T}
_
T{
\fI\%ciscoconfparse_mod\fP
T}	T{
Execution module for \fI\%ciscoconfparse\fP
T}
_
T{
\fI\%cisconso\fP
T}	T{
Execution module for Cisco Network Services Orchestrator Proxy minions
T}
_
T{
\fI\%cloud\fP
T}	T{
Salt\-specific interface for calling Salt Cloud directly
T}
_
T{
\fI\%cmdmod\fP
T}	T{
A module for shelling out.
T}
_
T{
\fI\%composer\fP
T}	T{
Use composer to install PHP dependencies for a directory
T}
_
T{
\fI\%config\fP
T}	T{
Return config information
T}
_
T{
\fI\%consul\fP
T}	T{
Interact with Consul
T}
_
T{
\fI\%container_resource\fP
T}	T{
Common resources for LXC and systemd\-nspawn containers
T}
_
T{
\fI\%cp\fP
T}	T{
Minion side functions for salt\-cp
T}
_
T{
\fI\%cpan\fP
T}	T{
Manage Perl modules using CPAN
T}
_
T{
\fI\%cron\fP
T}	T{
Work with cron
T}
_
T{
\fI\%cryptdev\fP
T}	T{
Salt module to manage Unix cryptsetup jobs and the crypttab file
T}
_
T{
\fI\%csf\fP
T}	T{
Support for Config Server Firewall (CSF)

maintainer

Mostafa Hussein <\fI\%mostafa.hussein91@gmail.com\fP>

maturity

new

platform

Linux
T}
_
T{
\fI\%cyg\fP
T}	T{
Manage cygwin packages.
T}
_
T{
\fI\%daemontools\fP
T}	T{
daemontools service module.
T}
_
T{
\fI\%data\fP
T}	T{
Manage a local persistent data structure that can hold any arbitrary data specific to the minion
T}
_
T{
\fI\%datadog_api\fP
T}	T{
An execution module that interacts with the Datadog API
T}
_
T{
\fI\%ddns\fP
T}	T{
Support for RFC 2136 dynamic DNS updates.
T}
_
T{
\fI\%deb_apache\fP
T}	T{
T}
_
T{
\fI\%deb_postgres\fP
T}	T{
Module to provide Postgres compatibility to salt for debian family specific tools.
T}
_
T{
\fI\%debconfmod\fP
T}	T{
Support for Debconf
T}
_
T{
\fI\%debian_ip\fP
T}	T{
The networking module for Debian\-based distros
T}
_
T{
\fI\%debian_service\fP
T}	T{
Service support for Debian systems (uses update\-rc.d and /sbin/service)
T}
_
T{
\fI\%debuild_pkgbuild\fP
T}	T{
Debian Package builder system
T}
_
T{
\fI\%defaults\fP
T}	T{
Module to work with salt formula defaults files
T}
_
T{
\fI\%devinfo\fP
T}	T{
Module for devinfo :maintainer:    Alberto Planas <\fI\%aplanas@suse.com\fP> :maturity:      new :depends:       None :platform:      Linux
T}
_
T{
\fI\%devmap\fP
T}	T{
Device\-Mapper module
T}
_
T{
\fI\%dig\fP
T}	T{
Compendium of generic DNS utilities.
T}
_
T{
\fI\%disk\fP
T}	T{
Module for managing disks and blockdevices
T}
_
T{
\fI\%djangomod\fP
T}	T{
Manage Django sites
T}
_
T{
\fI\%dnsmasq\fP
T}	T{
Module for managing dnsmasq
T}
_
T{
\fI\%dnsutil\fP
T}	T{
Compendium of generic DNS utilities.
T}
_
T{
\fI\%dockercompose\fP
T}	T{
T}
_
T{
\fI\%dockermod\fP
T}	T{
T}
_
T{
\fI\%dpkg_lowpkg\fP
T}	T{
Support for DEB packages
T}
_
T{
\fI\%drac\fP
T}	T{
Manage Dell DRAC
T}
_
T{
\fI\%dracr\fP
T}	T{
Manage Dell DRAC.
T}
_
T{
\fI\%drbd\fP
T}	T{
DRBD administration module
T}
_
T{
\fI\%dummyproxy_pkg\fP
T}	T{
Package support for the dummy proxy used by the test suite
T}
_
T{
\fI\%dummyproxy_service\fP
T}	T{
Provide the service module for the dummy proxy used in integration tests
T}
_
T{
\fI\%ebuildpkg\fP
T}	T{
Support for Portage
T}
_
T{
\fI\%eix\fP
T}	T{
Support for Eix
T}
_
T{
\fI\%elasticsearch\fP
T}	T{
Elasticsearch \- A distributed RESTful search and analytics server
T}
_
T{
\fI\%environ\fP
T}	T{
Support for getting and setting the environment variables of the current salt process.
T}
_
T{
\fI\%eselect\fP
T}	T{
Support for eselect, Gentoo\(aqs configuration and management tool.
T}
_
T{
\fI\%esxcluster\fP
T}	T{
Module used to access the esxcluster proxy connection methods
T}
_
T{
\fI\%esxdatacenter\fP
T}	T{
Module used to access the esxdatacenter proxy connection methods
T}
_
T{
\fI\%esxi\fP
T}	T{
Glues the VMware vSphere Execution Module to the VMware ESXi Proxy Minions to the \fI\%esxi proxymodule\fP\&.
T}
_
T{
\fI\%esxvm\fP
T}	T{
Module used to access the esx proxy connection methods
T}
_
T{
\fI\%etcd_mod\fP
T}	T{
Execution module to work with etcd
T}
_
T{
\fI\%ethtool\fP
T}	T{
Module for running ethtool command
T}
_
T{
\fI\%event\fP
T}	T{
Use the \fI\%Salt Event System\fP to fire events from the master to the minion and vice\-versa.
T}
_
T{
\fI\%extfs\fP
T}	T{
Module for managing ext2/3/4 file systems
T}
_
T{
\fI\%file\fP
T}	T{
Manage information about regular files, directories, and special files on the minion, set/read user, group, mode, and data
T}
_
T{
\fI\%firewalld\fP
T}	T{
Support for firewalld.
T}
_
T{
\fI\%freebsd_sysctl\fP
T}	T{
Module for viewing and modifying sysctl parameters
T}
_
T{
\fI\%freebsd_update\fP
T}	T{
Support for freebsd\-update utility on FreeBSD.
T}
_
T{
\fI\%freebsdjail\fP
T}	T{
The jail module for FreeBSD
T}
_
T{
\fI\%freebsdkmod\fP
T}	T{
Module to manage FreeBSD kernel modules
T}
_
T{
\fI\%freebsdpkg\fP
T}	T{
Remote package support using \fBpkg_add(1)\fP
T}
_
T{
\fI\%freebsdports\fP
T}	T{
Install software from the FreeBSD \fBports(7)\fP system
T}
_
T{
\fI\%freebsdservice\fP
T}	T{
The service module for FreeBSD
T}
_
T{
\fI\%freezer\fP
T}	T{
Module for freezer :maintainer:    Alberto Planas <\fI\%aplanas@suse.com\fP> :maturity:      new :depends:       None :platform:      Linux
T}
_
T{
\fI\%gcp_addon\fP
T}	T{
A route is a rule that specifies how certain packets should be handled by the virtual network.
T}
_
T{
\fI\%gem\fP
T}	T{
Manage ruby gems.
T}
_
T{
\fI\%genesis\fP
T}	T{
Module for managing container and VM images
T}
_
T{
\fI\%gentoo_service\fP
T}	T{
Top level package command wrapper, used to translate the os detected by grains to the correct service manager
T}
_
T{
\fI\%gentoolkitmod\fP
T}	T{
Support for Gentoolkit
T}
_
T{
\fI\%git\fP
T}	T{
Support for the Git SCM
T}
_
T{
\fI\%github\fP
T}	T{
Module for interacting with the GitHub v3 API.
T}
_
T{
\fI\%glanceng\fP
T}	T{
Glance module for interacting with OpenStack Glance
T}
_
T{
\fI\%glassfish\fP
T}	T{
Module for working with the Glassfish/Payara 4.x management API .
T}
_
T{
\fI\%glusterfs\fP
T}	T{
Manage a glusterfs pool
T}
_
T{
\fI\%gnomedesktop\fP
T}	T{
GNOME implementations
T}
_
T{
\fI\%google_chat\fP
T}	T{
Module for sending messages to google chat.
T}
_
T{
\fI\%gpg\fP
T}	T{
Manage GPG keychains, add keys, create keys, retrieve keys from keyservers.
T}
_
T{
\fI\%grafana4\fP
T}	T{
Module for working with the Grafana v4 API
T}
_
T{
\fI\%grains\fP
T}	T{
Return/control aspects of the grains data
T}
_
T{
\fI\%groupadd\fP
T}	T{
Manage groups on Linux, OpenBSD and NetBSD
T}
_
T{
\fI\%grub_legacy\fP
T}	T{
Support for GRUB Legacy
T}
_
T{
\fI\%guestfs\fP
T}	T{
Interact with virtual machine images via libguestfs
T}
_
T{
\fI\%hadoop\fP
T}	T{
Support for hadoop
T}
_
T{
\fI\%haproxyconn\fP
T}	T{
Support for haproxy
T}
_
T{
\fI\%hashutil\fP
T}	T{
A collection of hashing and encoding functions
T}
_
T{
\fI\%heat\fP
T}	T{
Module for handling OpenStack Heat calls
T}
_
T{
\fI\%helm\fP
T}	T{
Interface with Helm
T}
_
T{
\fI\%hg\fP
T}	T{
Support for the Mercurial SCM
T}
_
T{
\fI\%highstate_doc\fP
T}	T{
This module renders highstate configuration into a more human readable format.
T}
_
T{
\fI\%hosts\fP
T}	T{
Manage the information in the hosts file
T}
_
T{
\fI\%http\fP
T}	T{
Module for making various web calls.
T}
_
T{
\fI\%icinga2\fP
T}	T{
Module to provide icinga2 compatibility to salt.
T}
_
T{
\fI\%idem\fP
T}	T{
Idem Support
T}
_
T{
\fI\%ifttt\fP
T}	T{
Support for IFTTT
T}
_
T{
\fI\%ilo\fP
T}	T{
Manage HP ILO
T}
_
T{
\fI\%incron\fP
T}	T{
Work with incron
T}
_
T{
\fI\%influxdb08mod\fP
T}	T{
InfluxDB \- A distributed time series database
T}
_
T{
\fI\%influxdbmod\fP
T}	T{
InfluxDB \- A distributed time series database
T}
_
T{
\fI\%infoblox\fP
T}	T{
This module have been tested on infoblox API v1.2.1, other versions of the API are likly workable.
T}
_
T{
\fI\%ini_manage\fP
T}	T{
Edit ini files
T}
_
T{
\fI\%inspectlib\fP
T}	T{
T}
_
T{
\fI\%inspectlib.collector\fP
T}	T{
T}
_
T{
\fI\%inspectlib.dbhandle\fP
T}	T{
T}
_
T{
\fI\%inspectlib.entities\fP
T}	T{
T}
_
T{
\fI\%inspectlib.exceptions\fP
T}	T{
T}
_
T{
\fI\%inspectlib.fsdb\fP
T}	T{
.INDENT 0.0
.TP
.B codeauthor
Bo Maryniuk <\fI\%bo@suse.de\fP>
.UNINDENT
T}
_
T{
\fI\%inspectlib.kiwiproc\fP
T}	T{
T}
_
T{
\fI\%inspectlib.query\fP
T}	T{
T}
_
T{
\fI\%inspector\fP
T}	T{
Module for full system inspection.
T}
_
T{
\fI\%introspect\fP
T}	T{
Functions to perform introspection on a minion, and return data in a format usable by Salt States
T}
_
T{
\fI\%iosconfig\fP
T}	T{
Cisco IOS configuration manipulation helpers
T}
_
T{
\fI\%ipmi\fP
T}	T{
Support IPMI commands over LAN.
T}
_
T{
\fI\%ipset\fP
T}	T{
Support for ipset
T}
_
T{
\fI\%iptables\fP
T}	T{
Support for iptables
T}
_
T{
\fI\%iwtools\fP
T}	T{
Support for Wireless Tools for Linux
T}
_
T{
\fI\%jboss7\fP
T}	T{
Module for managing JBoss AS 7 through the CLI interface.
T}
_
T{
\fI\%jboss7_cli\fP
T}	T{
Module for low\-level interaction with JbossAS7 through CLI.
T}
_
T{
\fI\%jenkinsmod\fP
T}	T{
Module for controlling Jenkins
T}
_
T{
\fI\%jinja\fP
T}	T{
Module for checking jinja maps and verifying the result of loading JSON/YAML files
T}
_
T{
\fI\%jira_mod\fP
T}	T{
JIRA Execution module
T}
_
T{
\fI\%junos\fP
T}	T{
Module to interact with Junos devices.
T}
_
T{
\fI\%k8s\fP
T}	T{
T}
_
T{
\fI\%kapacitor\fP
T}	T{
Kapacitor execution module.
T}
_
T{
\fI\%kerberos\fP
T}	T{
Manage Kerberos KDC
T}
_
T{
\fI\%kernelpkg_linux_apt\fP
T}	T{
Manage Linux kernel packages on APT\-based systems
T}
_
T{
\fI\%kernelpkg_linux_yum\fP
T}	T{
Manage Linux kernel packages on YUM\-based systems
T}
_
T{
\fI\%key\fP
T}	T{
Functions to view the minion\(aqs public key information
T}
_
T{
\fI\%keyboard\fP
T}	T{
Module for managing keyboards on supported POSIX\-like systems using systemd, or such as Redhat, Debian and Gentoo.
T}
_
T{
\fI\%keystone\fP
T}	T{
Module for handling openstack keystone calls.
T}
_
T{
\fI\%keystoneng\fP
T}	T{
Keystone module for interacting with OpenStack Keystone
T}
_
T{
\fI\%keystore\fP
T}	T{
Module to interact with keystores
T}
_
T{
\fI\%kmod\fP
T}	T{
Module to manage Linux kernel modules
T}
_
T{
\fI\%kubeadm\fP
T}	T{
T}
_
T{
\fI\%kubernetesmod\fP
T}	T{
T}
_
T{
\fI\%launchctl_service\fP
T}	T{
Module for the management of MacOS systems that use launchd/launchctl
T}
_
T{
\fI\%layman\fP
T}	T{
Support for Layman
T}
_
T{
\fI\%ldap3\fP
T}	T{
Query and modify an LDAP database (alternative interface)
T}
_
T{
\fI\%ldapmod\fP
T}	T{
Salt interface to LDAP commands
T}
_
T{
\fI\%libcloud_compute\fP
T}	T{
Apache Libcloud Compute Management
T}
_
T{
\fI\%libcloud_dns\fP
T}	T{
Apache Libcloud DNS Management
T}
_
T{
\fI\%libcloud_loadbalancer\fP
T}	T{
Apache Libcloud Load Balancer Management
T}
_
T{
\fI\%libcloud_storage\fP
T}	T{
Apache Libcloud Storage Management
T}
_
T{
\fI\%linux_acl\fP
T}	T{
Support for Linux File Access Control Lists
T}
_
T{
\fI\%linux_ip\fP
T}	T{
The networking module for Non\-RH/Deb Linux distros
T}
_
T{
\fI\%linux_lvm\fP
T}	T{
Support for Linux LVM2
T}
_
T{
\fI\%linux_service\fP
T}	T{
If Salt\(aqs OS detection does not identify a different virtual service module, the minion will fall back to using this basic module, which simply wraps sysvinit scripts.
T}
_
T{
\fI\%linux_shadow\fP
T}	T{
Manage the shadow file on Linux systems
T}
_
T{
\fI\%linux_sysctl\fP
T}	T{
Module for viewing and modifying sysctl parameters
T}
_
T{
\fI\%localemod\fP
T}	T{
Module for managing locales on POSIX\-like systems.
T}
_
T{
\fI\%locate\fP
T}	T{
Module for using the locate utilities
T}
_
T{
\fI\%logadm\fP
T}	T{
Module for managing Solaris logadm based log rotations.
T}
_
T{
\fI\%logmod\fP
T}	T{
On\-demand logging
T}
_
T{
\fI\%logrotate\fP
T}	T{
Module for managing logrotate.
T}
_
T{
\fI\%lvs\fP
T}	T{
Support for LVS (Linux Virtual Server)
T}
_
T{
\fI\%lxc\fP
T}	T{
Control Linux Containers via Salt
T}
_
T{
\fI\%lxd\fP
T}	T{
Module for managing the LXD daemon and its containers.
T}
_
T{
\fI\%mac_assistive\fP
T}	T{
This module allows you to manage assistive access on macOS minions with 10.9+
T}
_
T{
\fI\%mac_brew_pkg\fP
T}	T{
Homebrew for macOS
T}
_
T{
\fI\%mac_desktop\fP
T}	T{
macOS implementations of various commands in the \(dqdesktop\(dq interface
T}
_
T{
\fI\%mac_group\fP
T}	T{
Manage groups on Mac OS 10.7+
T}
_
T{
\fI\%mac_keychain\fP
T}	T{
Install certificates into the keychain on Mac OS
T}
_
T{
\fI\%mac_pkgutil\fP
T}	T{
Installer support for macOS.
T}
_
T{
\fI\%mac_portspkg\fP
T}	T{
Support for MacPorts under macOS.
T}
_
T{
\fI\%mac_power\fP
T}	T{
Module for editing power settings on macOS
T}
_
T{
\fI\%mac_service\fP
T}	T{
The service module for macOS
T}
_
T{
\fI\%mac_shadow\fP
T}	T{
Manage macOS local directory passwords and policies
T}
_
T{
\fI\%mac_softwareupdate\fP
T}	T{
Support for the softwareupdate command on MacOS.
T}
_
T{
\fI\%mac_sysctl\fP
T}	T{
Module for viewing and modifying sysctl parameters
T}
_
T{
\fI\%mac_system\fP
T}	T{
System module for sleeping, restarting, and shutting down the system on Mac OS X
T}
_
T{
\fI\%mac_timezone\fP
T}	T{
Module for editing date/time settings on macOS
T}
_
T{
\fI\%mac_user\fP
T}	T{
Manage users on Mac OS 10.7+
T}
_
T{
\fI\%mac_xattr\fP
T}	T{
This module allows you to manage extended attributes on files or directories
T}
_
T{
\fI\%macdefaults\fP
T}	T{
Set defaults on Mac OS
T}
_
T{
\fI\%macpackage\fP
T}	T{
Install pkg, dmg and .app applications on macOS minions.
T}
_
T{
\fI\%makeconf\fP
T}	T{
Support for modifying make.conf under Gentoo
T}
_
T{
\fI\%mandrill\fP
T}	T{
Mandrill
T}
_
T{
\fI\%marathon\fP
T}	T{
Module providing a simple management interface to a marathon cluster.
T}
_
T{
\fI\%match\fP
T}	T{
The match module allows for match routines to be run and determine target specs
T}
_
T{
\fI\%mattermost\fP
T}	T{
Module for sending messages to Mattermost
T}
_
T{
\fI\%mdadm_raid\fP
T}	T{
Salt module to manage RAID arrays with mdadm
T}
_
T{
\fI\%mdata\fP
T}	T{
Module for managaging metadata in SmartOS Zones
T}
_
T{
\fI\%memcached\fP
T}	T{
Module for Management of Memcached Keys
T}
_
T{
\fI\%mine\fP
T}	T{
The function cache system allows for data to be stored on the master so it can be easily read by other minions
T}
_
T{
\fI\%minion\fP
T}	T{
Module to provide information about minions
T}
_
T{
\fI\%mod_random\fP
T}	T{
Provides access to randomness generators.
T}
_
T{
\fI\%modjk\fP
T}	T{
Control Modjk via the Apache Tomcat \(dqStatus\(dq worker (\fI\%http://tomcat.apache.org/connectors\-doc/reference/status.html\fP)
T}
_
T{
\fI\%mongodb\fP
T}	T{
Module to provide MongoDB functionality to Salt
T}
_
T{
\fI\%monit\fP
T}	T{
Monit service module.
T}
_
T{
\fI\%moosefs\fP
T}	T{
Module for gathering and managing information about MooseFS
T}
_
T{
\fI\%mount\fP
T}	T{
Salt module to manage Unix mounts and the fstab file
T}
_
T{
\fI\%mssql\fP
T}	T{
Module to provide MS SQL Server compatibility to salt.
T}
_
T{
\fI\%msteams\fP
T}	T{
Module for sending messages to MS Teams
T}
_
T{
\fI\%munin\fP
T}	T{
Run munin plugins/checks from salt and format the output as data.
T}
_
T{
\fI\%mysql\fP
T}	T{
Module to provide MySQL compatibility to salt.
T}
_
T{
\fI\%nacl\fP
T}	T{
This module helps include encrypted passwords in pillars, grains and salt state files.
T}
_
T{
\fI\%nagios\fP
T}	T{
Run nagios plugins/checks from salt and get the return as data.
T}
_
T{
\fI\%nagios_rpc\fP
T}	T{
Check Host & Service status from Nagios via JSON RPC.
T}
_
T{
\fI\%namecheap_domains\fP
T}	T{
Namecheap Domain Management
T}
_
T{
\fI\%namecheap_domains_dns\fP
T}	T{
Namecheap DNS Management
T}
_
T{
\fI\%namecheap_domains_ns\fP
T}	T{
Namecheap Nameserver Management
T}
_
T{
\fI\%namecheap_ssl\fP
T}	T{
Namecheap SSL Certificate Management
T}
_
T{
\fI\%namecheap_users\fP
T}	T{
Namecheap User Management
T}
_
T{
\fI\%napalm_bgp\fP
T}	T{
NAPALM BGP
T}
_
T{
\fI\%napalm_formula\fP
T}	T{
NAPALM Formula helpers
T}
_
T{
\fI\%napalm_mod\fP
T}	T{
NAPALM helpers
T}
_
T{
\fI\%napalm_netacl\fP
T}	T{
NAPALM ACL
T}
_
T{
\fI\%napalm_network\fP
T}	T{
NAPALM Network
T}
_
T{
\fI\%napalm_ntp\fP
T}	T{
NAPALM NTP
T}
_
T{
\fI\%napalm_probes\fP
T}	T{
NAPALM Probes
T}
_
T{
\fI\%napalm_route\fP
T}	T{
NAPALM Route
T}
_
T{
\fI\%napalm_snmp\fP
T}	T{
NAPALM SNMP
T}
_
T{
\fI\%napalm_users\fP
T}	T{
NAPALM Users
T}
_
T{
\fI\%napalm_yang_mod\fP
T}	T{
NAPALM YANG
T}
_
T{
\fI\%netaddress\fP
T}	T{
Module for getting information about network addresses.
T}
_
T{
\fI\%netbox\fP
T}	T{
NetBox
T}
_
T{
\fI\%netbsd_sysctl\fP
T}	T{
Module for viewing and modifying sysctl parameters
T}
_
T{
\fI\%netbsdservice\fP
T}	T{
The service module for NetBSD
T}
_
T{
\fI\%netmiko_mod\fP
T}	T{
Netmiko Execution Module
T}
_
T{
\fI\%netscaler\fP
T}	T{
Module to provide Citrix Netscaler compatibility to Salt (compatible with netscaler 9.2+)
T}
_
T{
\fI\%network\fP
T}	T{
Module for gathering and managing network information
T}
_
T{
\fI\%neutron\fP
T}	T{
Module for handling OpenStack Neutron calls
T}
_
T{
\fI\%neutronng\fP
T}	T{
Neutron module for interacting with OpenStack Neutron
T}
_
T{
\fI\%nexus\fP
T}	T{
Module for fetching artifacts from Nexus 3.x
T}
_
T{
\fI\%nfs3\fP
T}	T{
Module for managing NFS version 3.
T}
_
T{
\fI\%nftables\fP
T}	T{
Support for nftables
T}
_
T{
\fI\%nginx\fP
T}	T{
Support for nginx
T}
_
T{
\fI\%nilrt_ip\fP
T}	T{
The networking module for NI Linux Real\-Time distro
T}
_
T{
\fI\%nix\fP
T}	T{
Work with Nix packages
T}
_
T{
\fI\%nova\fP
T}	T{
Module for handling OpenStack Nova calls
T}
_
T{
\fI\%npm\fP
T}	T{
Manage and query NPM packages.
T}
_
T{
\fI\%nspawn\fP
T}	T{
Manage nspawn containers
T}
_
T{
\fI\%nxos\fP
T}	T{
Execution module for Cisco NX OS Switches.
T}
_
T{
\fI\%nxos_api\fP
T}	T{
Execution module to manage Cisco Nexus Switches (NX\-OS) over the NX\-API
T}
_
T{
\fI\%nxos_upgrade\fP
T}	T{
Execution module to upgrade Cisco NX\-OS Switches.
T}
_
T{
\fI\%omapi\fP
T}	T{
This module interacts with an ISC DHCP Server via OMAPI.
T}
_
T{
\fI\%openbsd_sysctl\fP
T}	T{
Module for viewing and modifying OpenBSD sysctl parameters
T}
_
T{
\fI\%openbsdpkg\fP
T}	T{
Package support for OpenBSD
T}
_
T{
\fI\%openbsdrcctl_service\fP
T}	T{
The rcctl service module for OpenBSD
T}
_
T{
\fI\%openbsdservice\fP
T}	T{
The service module for OpenBSD
T}
_
T{
\fI\%openscap\fP
T}	T{
Module for OpenSCAP Management
T}
_
T{
\fI\%openstack_config\fP
T}	T{
Modify, retrieve, or delete values from OpenStack configuration files.
T}
_
T{
\fI\%openstack_mng\fP
T}	T{
Module for OpenStack Management
T}
_
T{
\fI\%openvswitch\fP
T}	T{
Support for Open vSwitch \- module with basic Open vSwitch commands.
T}
_
T{
\fI\%opkg\fP
T}	T{
Support for Opkg
T}
_
T{
\fI\%opsgenie\fP
T}	T{
Module for sending data to OpsGenie
T}
_
T{
\fI\%oracle\fP
T}	T{
Oracle DataBase connection module
T}
_
T{
\fI\%osquery\fP
T}	T{
Support for OSQuery \- \fI\%https://osquery.io\fP\&.
T}
_
T{
\fI\%out\fP
T}	T{
Output Module
T}
_
T{
\fI\%pacmanpkg\fP
T}	T{
A module to wrap pacman calls, since Arch is the best (\fI\%https://wiki.archlinux.org/index.php/Arch_is_the_best\fP)
T}
_
T{
\fI\%pagerduty\fP
T}	T{
Module for Firing Events via PagerDuty
T}
_
T{
\fI\%pagerduty_util\fP
T}	T{
Module for manageing PagerDuty resource
T}
_
T{
\fI\%pam\fP
T}	T{
Support for pam
T}
_
T{
\fI\%panos\fP
T}	T{
Module to provide Palo Alto compatibility to Salt
T}
_
T{
\fI\%parallels\fP
T}	T{
Manage Parallels Desktop VMs with \fBprlctl\fP and \fBprlsrvctl\fP\&.
T}
_
T{
\fI\%parted_partition\fP
T}	T{
Module for managing partitions on POSIX\-like systems.
T}
_
T{
\fI\%pcs\fP
T}	T{
Configure a Pacemaker/Corosync cluster with PCS
T}
_
T{
\fI\%pdbedit\fP
T}	T{
Manage accounts in Samba\(aqs passdb using pdbedit
T}
_
T{
\fI\%pecl\fP
T}	T{
Manage PHP pecl extensions.
T}
_
T{
\fI\%peeringdb\fP
T}	T{
PeeringDB Module
T}
_
T{
\fI\%pf\fP
T}	T{
Control the OpenBSD packet filter (PF).
T}
_
T{
\fI\%philips_hue\fP
T}	T{
Philips HUE lamps module for proxy.
T}
_
T{
\fI\%pillar\fP
T}	T{
Extract the pillar data for this minion
T}
_
T{
\fI\%pip\fP
T}	T{
Install Python packages with pip to either the system or a virtualenv
T}
_
T{
\fI\%pkg_resource\fP
T}	T{
Resources needed by pkg providers
T}
_
T{
\fI\%pkgin\fP
T}	T{
Package support for pkgin based systems, inspired from freebsdpkg module
T}
_
T{
\fI\%pkgng\fP
T}	T{
Support for \fBpkgng\fP, the new package manager for FreeBSD
T}
_
T{
\fI\%pkgutil\fP
T}	T{
Pkgutil support for Solaris
T}
_
T{
\fI\%portage_config\fP
T}	T{
Configure \fBportage(5)\fP
T}
_
T{
\fI\%postfix\fP
T}	T{
Support for Postfix
T}
_
T{
\fI\%postgres\fP
T}	T{
Module to provide Postgres compatibility to salt.
T}
_
T{
\fI\%poudriere\fP
T}	T{
Support for poudriere
T}
_
T{
\fI\%powerpath\fP
T}	T{
powerpath support.
T}
_
T{
\fI\%proxy\fP
T}	T{
This module allows you to manage proxy settings
T}
_
T{
\fI\%ps\fP
T}	T{
A salt interface to psutil, a system and process library.
T}
_
T{
\fI\%publish\fP
T}	T{
Publish a command from a minion to a target
T}
_
T{
\fI\%puppet\fP
T}	T{
Execute puppet routines
T}
_
T{
\fI\%purefa\fP
T}	T{
Management of Pure Storage FlashArray
T}
_
T{
\fI\%purefb\fP
T}	T{
Management of Pure Storage FlashBlade
T}
_
T{
\fI\%pushbullet\fP
T}	T{
Module for sending messages to Pushbullet (\fI\%https://www.pushbullet.com\fP)
T}
_
T{
\fI\%pushover_notify\fP
T}	T{
T}
_
T{
\fI\%pw_group\fP
T}	T{
Manage groups on FreeBSD
T}
_
T{
\fI\%pw_user\fP
T}	T{
Manage users with the pw command
T}
_
T{
\fI\%pyenv\fP
T}	T{
Manage python installations with pyenv.
T}
_
T{
\fI\%qemu_img\fP
T}	T{
Qemu\-img Command Wrapper
T}
_
T{
\fI\%qemu_nbd\fP
T}	T{
Qemu Command Wrapper
T}
_
T{
\fI\%quota\fP
T}	T{
Module for managing quotas on POSIX\-like systems.
T}
_
T{
\fI\%rabbitmq\fP
T}	T{
Module to provide RabbitMQ compatibility to Salt.
T}
_
T{
\fI\%rallydev\fP
T}	T{
Support for RallyDev
T}
_
T{
\fI\%random_org\fP
T}	T{
Module for retrieving random information from Random.org
T}
_
T{
\fI\%rbac_solaris\fP
T}	T{
Module for Solaris\(aq Role\-Based Access Control
T}
_
T{
\fI\%rbenv\fP
T}	T{
Manage ruby installations with rbenv.
T}
_
T{
\fI\%rdp\fP
T}	T{
Manage RDP Service on Windows servers
T}
_
T{
\fI\%rebootmgr\fP
T}	T{
Module for rebootmgr :maintainer:    Alberto Planas <\fI\%aplanas@suse.com\fP> :maturity:      new :depends:       None :platform:      Linux
T}
_
T{
\fI\%redismod\fP
T}	T{
Module to provide redis functionality to Salt
T}
_
T{
\fI\%reg\fP
T}	T{
Manage the Windows registry
T}
_
T{
\fI\%rest_pkg\fP
T}	T{
Package support for the REST example
T}
_
T{
\fI\%rest_sample_utils\fP
T}	T{
Utility functions for the rest_sample
T}
_
T{
\fI\%rest_service\fP
T}	T{
Provide the service module for the proxy\-minion REST sample
T}
_
T{
\fI\%restartcheck\fP
T}	T{
checkrestart functionality for Debian and Red Hat Based systems
T}
_
T{
\fI\%restconf\fP
T}	T{
Execution module for RESTCONF Proxy minions
T}
_
T{
\fI\%ret\fP
T}	T{
Module to integrate with the returner system and retrieve data sent to a salt returner
T}
_
T{
\fI\%rh_ip\fP
T}	T{
The networking module for RHEL/Fedora based distros
T}
_
T{
\fI\%rh_service\fP
T}	T{
Service support for RHEL\-based systems, including support for both upstart and sysvinit
T}
_
T{
\fI\%riak\fP
T}	T{
Riak Salt Module
T}
_
T{
\fI\%rpm_lowpkg\fP
T}	T{
Support for rpm
T}
_
T{
\fI\%rpmbuild_pkgbuild\fP
T}	T{
RPM Package builder system
T}
_
T{
\fI\%rsync\fP
T}	T{
Wrapper for rsync
T}
_
T{
\fI\%runit\fP
T}	T{
runit service module (\fI\%http://smarden.org/runit\fP)
T}
_
T{
\fI\%rvm\fP
T}	T{
Manage ruby installations and gemsets with RVM, the Ruby Version Manager.
T}
_
T{
\fI\%s3\fP
T}	T{
Connection module for Amazon S3
T}
_
T{
\fI\%s6\fP
T}	T{
s6 service module
T}
_
T{
\fI\%salt_proxy\fP
T}	T{
Salt proxy module
T}
_
T{
\fI\%salt_version\fP
T}	T{
Access Salt\(aqs elemental release code\-names.
T}
_
T{
\fI\%saltcheck\fP
T}	T{
A module for testing the logic of states and highstates on salt minions
T}
_
T{
\fI\%saltcloudmod\fP
T}	T{
Control a salt cloud system
T}
_
T{
\fI\%saltutil\fP
T}	T{
The Saltutil module is used to manage the state of the salt minion itself.
T}
_
T{
\fI\%schedule\fP
T}	T{
Module for managing the Salt schedule on a minion
T}
_
T{
\fI\%scp_mod\fP
T}	T{
SCP Module
T}
_
T{
\fI\%scsi\fP
T}	T{
SCSI administration module
T}
_
T{
\fI\%sdb\fP
T}	T{
Module for Manipulating Data via the Salt DB API
T}
_
T{
\fI\%seed\fP
T}	T{
Virtual machine image management tools
T}
_
T{
\fI\%selinux\fP
T}	T{
Execute calls on selinux
T}
_
T{
\fI\%sensehat\fP
T}	T{
Module for controlling the LED matrix or reading environment data on the SenseHat of a Raspberry Pi.
T}
_
T{
\fI\%sensors\fP
T}	T{
Read lm\-sensors
T}
_
T{
\fI\%serverdensity_device\fP
T}	T{
Wrapper around Server Density API
T}
_
T{
\fI\%servicenow\fP
T}	T{
Module for execution of ServiceNow CI (configuration items)
T}
_
T{
\fI\%slack_notify\fP
T}	T{
Module for sending messages to Slack
T}
_
T{
\fI\%slackware_service\fP
T}	T{
The service module for Slackware
T}
_
T{
\fI\%slsutil\fP
T}	T{
Utility functions for use with or in SLS files
T}
_
T{
\fI\%smartos_imgadm\fP
T}	T{
Module for running imgadm command on SmartOS
T}
_
T{
\fI\%smartos_nictagadm\fP
T}	T{
Module for running nictagadm command on SmartOS :maintainer:    Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP> :maturity:      new :depends:       nictagadm binary, dladm binary :platform:      smartos
T}
_
T{
\fI\%smartos_virt\fP
T}	T{
virst compatibility module for managing VMs on SmartOS
T}
_
T{
\fI\%smartos_vmadm\fP
T}	T{
Module for running vmadm command on SmartOS
T}
_
T{
\fI\%smbios\fP
T}	T{
Interface to SMBIOS/DMI
T}
_
T{
\fI\%smf_service\fP
T}	T{
Service support for Solaris 10 and 11, should work with other systems that use SMF also.
T}
_
T{
\fI\%smtp\fP
T}	T{
Module for Sending Messages via SMTP
T}
_
T{
\fI\%snapper\fP
T}	T{
Module to manage filesystem snapshots with snapper
T}
_
T{
\fI\%solaris_fmadm\fP
T}	T{
Module for running fmadm and fmdump on Solaris
T}
_
T{
\fI\%solaris_group\fP
T}	T{
Manage groups on Solaris
T}
_
T{
\fI\%solaris_shadow\fP
T}	T{
Manage the password database on Solaris systems
T}
_
T{
\fI\%solaris_system\fP
T}	T{
Support for reboot, shutdown, etc
T}
_
T{
\fI\%solaris_user\fP
T}	T{
Manage users with the useradd command
T}
_
T{
\fI\%solarisipspkg\fP
T}	T{
IPS pkg support for Solaris
T}
_
T{
\fI\%solarispkg\fP
T}	T{
Package support for Solaris
T}
_
T{
\fI\%solr\fP
T}	T{
Apache Solr Salt Module
T}
_
T{
\fI\%solrcloud\fP
T}	T{
Module for solrcloud configuration
T}
_
T{
\fI\%splunk\fP
T}	T{
Module for interop with the Splunk API
T}
_
T{
\fI\%splunk_search\fP
T}	T{
Module for interop with the Splunk API
T}
_
T{
\fI\%sqlite3\fP
T}	T{
Support for SQLite3
T}
_
T{
\fI\%ssh\fP
T}	T{
Manage client ssh components
T}
_
T{
\fI\%ssh_pkg\fP
T}	T{
Service support for the REST example
T}
_
T{
\fI\%ssh_service\fP
T}	T{
Provide the service module for the proxy\-minion SSH sample .
T}
_
T{
\fI\%state\fP
T}	T{
Control the state system on the minion.
T}
_
T{
\fI\%status\fP
T}	T{
Module for returning various status data about a minion.
T}
_
T{
\fI\%statuspage\fP
T}	T{
StatusPage
T}
_
T{
\fI\%supervisord\fP
T}	T{
Provide the service module for system supervisord or supervisord in a virtualenv
T}
_
T{
\fI\%suse_apache\fP
T}	T{
T}
_
T{
\fI\%suse_ip\fP
T}	T{
The networking module for SUSE based distros
T}
_
T{
\fI\%svn\fP
T}	T{
Subversion SCM
T}
_
T{
\fI\%swarm\fP
T}	T{
Docker Swarm Module using Docker\(aqs Python SDK
T}
_
T{
\fI\%swift\fP
T}	T{
Module for handling OpenStack Swift calls Author: Anthony Stanton <\fI\%anthony.stanton@gmail.com\fP>
T}
_
T{
\fI\%sysbench\fP
T}	T{
The \(aqsysbench\(aq module is used to analyze the performance of the minions, right from the master! It measures various system parameters such as CPU, Memory, File I/O, Threads and Mutex.
T}
_
T{
\fI\%sysfs\fP
T}	T{
Module for interfacing with SysFS
T}
_
T{
\fI\%syslog_ng\fP
T}	T{
Module for getting information about syslog\-ng
T}
_
T{
\fI\%sysmod\fP
T}	T{
The sys module provides information about the available functions on the minion
T}
_
T{
\fI\%sysrc\fP
T}	T{
sysrc module for FreeBSD
T}
_
T{
\fI\%system\fP
T}	T{
Support for reboot, shutdown, etc on POSIX\-like systems.
T}
_
T{
\fI\%system_profiler\fP
T}	T{
System Profiler Module
T}
_
T{
\fI\%systemd_service\fP
T}	T{
Provides the service module for systemd
T}
_
T{
\fI\%telegram\fP
T}	T{
Module for sending messages via Telegram.
T}
_
T{
\fI\%telemetry\fP
T}	T{
Connection module for Telemetry
T}
_
T{
\fI\%temp\fP
T}	T{
Simple module for creating temporary directories and files
T}
_
T{
\fI\%test\fP
T}	T{
Module for running arbitrary tests
T}
_
T{
\fI\%test_virtual\fP
T}	T{
Module for testing that a __virtual__ function returning False will not be available via the Salt Loader.
T}
_
T{
\fI\%testinframod\fP
T}	T{
This module exposes the functionality of the TestInfra library for use with SaltStack in order to verify the state of your minions.
T}
_
T{
\fI\%textfsm_mod\fP
T}	T{
TextFSM
T}
_
T{
\fI\%timezone\fP
T}	T{
Module for managing timezone on POSIX\-like systems.
T}
_
T{
\fI\%tls\fP
T}	T{
A salt module for SSL/TLS.
T}
_
T{
\fI\%tomcat\fP
T}	T{
Support for Tomcat
T}
_
T{
\fI\%trafficserver\fP
T}	T{
Apache Traffic Server execution module.
T}
_
T{
\fI\%transactional_update\fP
T}	T{
Transactional update
T}
_
T{
\fI\%travisci\fP
T}	T{
Commands for working with travisci.
T}
_
T{
\fI\%tuned\fP
T}	T{
Interface to Red Hat tuned\-adm module
T}
_
T{
\fI\%twilio_notify\fP
T}	T{
Module for notifications via Twilio
T}
_
T{
\fI\%udev\fP
T}	T{
Manage and query udev info
T}
_
T{
\fI\%upstart_service\fP
T}	T{
Module for the management of upstart systems.
T}
_
T{
\fI\%uptime\fP
T}	T{
Wrapper around uptime API
T}
_
T{
\fI\%useradd\fP
T}	T{
Manage users with the useradd command
T}
_
T{
\fI\%uwsgi\fP
T}	T{
uWSGI stats server \fI\%https://uwsgi\-docs.readthedocs.io/en/latest/StatsServer.html\fP
T}
_
T{
\fI\%vagrant\fP
T}	T{
Work with virtual machines managed by Vagrant.
T}
_
T{
\fI\%varnish\fP
T}	T{
Support for Varnish
T}
_
T{
\fI\%vault\fP
T}	T{
T}
_
T{
\fI\%vbox_guest\fP
T}	T{
VirtualBox Guest Additions installer
T}
_
T{
\fI\%vboxmanage\fP
T}	T{
Support for VirtualBox using the VBoxManage command
T}
_
T{
\fI\%vcenter\fP
T}	T{
Module used to access the vcenter proxy connection methods
T}
_
T{
\fI\%victorops\fP
T}	T{
Support for VictorOps
T}
_
T{
\fI\%virt\fP
T}	T{
Work with virtual machines managed by libvirt
T}
_
T{
\fI\%virtualenv_mod\fP
T}	T{
Create virtualenv environments.
T}
_
T{
\fI\%vmctl\fP
T}	T{
Manage vms running on the OpenBSD VMM hypervisor using vmctl(8).
T}
_
T{
\fI\%vsphere\fP
T}	T{
Manage VMware vCenter servers and ESXi hosts.
T}
_
T{
\fI\%webutil\fP
T}	T{
Support for htpasswd command.
T}
_
T{
\fI\%win_appx\fP
T}	T{
Manage provisioned apps
T}
_
T{
\fI\%win_auditpol\fP
T}	T{
A salt module for modifying the audit policies on the machine
T}
_
T{
\fI\%win_autoruns\fP
T}	T{
Module for listing programs that automatically run on startup (very alpha...not tested on anything but my Win 7x64)
T}
_
T{
\fI\%win_certutil\fP
T}	T{
This module allows you to install certificates into the windows certificate manager.
T}
_
T{
\fI\%win_dacl\fP
T}	T{
Manage DACLs on Windows
T}
_
T{
\fI\%win_disk\fP
T}	T{
Module for gathering disk information on Windows
T}
_
T{
\fI\%win_dism\fP
T}	T{
Install features/packages for Windows using DISM, which is useful for minions not running server versions\ of Windows.
T}
_
T{
\fI\%win_dns_client\fP
T}	T{
Module for configuring DNS Client on Windows systems
T}
_
T{
\fI\%win_dsc\fP
T}	T{
Module for working with Windows PowerShell DSC (Desired State Configuration)
T}
_
T{
\fI\%win_event\fP
T}	T{
A module for working with the Windows Event log system.
T}
_
T{
\fI\%win_file\fP
T}	T{
Manage information about files on the minion, set/read user, group data, modify the ACL of files/directories
T}
_
T{
\fI\%win_firewall\fP
T}	T{
Module for configuring Windows Firewall using \fBnetsh\fP
T}
_
T{
\fI\%win_groupadd\fP
T}	T{
Manage groups on Windows
T}
_
T{
\fI\%win_iis\fP
T}	T{
Microsoft IIS site management via WebAdministration powershell module
T}
_
T{
\fI\%win_ip\fP
T}	T{
The networking module for Windows based systems
T}
_
T{
\fI\%win_lgpo\fP
T}	T{
Manage Local Policy on Windows
T}
_
T{
\fI\%win_lgpo_reg\fP
T}	T{
LGPO \- Registry.pol
T}
_
T{
\fI\%win_license\fP
T}	T{
This module allows you to manage windows licensing via slmgr.vbs
T}
_
T{
\fI\%win_network\fP
T}	T{
Module for gathering and managing network information
T}
_
T{
\fI\%win_ntp\fP
T}	T{
Management of NTP servers on Windows
T}
_
T{
\fI\%win_path\fP
T}	T{
Manage the Windows System PATH
T}
_
T{
\fI\%win_pkg\fP
T}	T{
A module to manage software on Windows
T}
_
T{
\fI\%win_pki\fP
T}	T{
Microsoft certificate management via the PKI Client PowerShell module.
T}
_
T{
\fI\%win_powercfg\fP
T}	T{
This module allows you to control the power settings of a windows minion via powercfg.
T}
_
T{
\fI\%win_psget\fP
T}	T{
Module for managing PowerShell through PowerShellGet (PSGet)
T}
_
T{
\fI\%win_servermanager\fP
T}	T{
Manage Windows features via the ServerManager powershell module.
T}
_
T{
\fI\%win_service\fP
T}	T{
Windows Service module.
T}
_
T{
\fI\%win_shadow\fP
T}	T{
Manage the shadow file
T}
_
T{
\fI\%win_shortcut\fP
T}	T{
Execution module for creating shortcuts on Windows.
T}
_
T{
\fI\%win_smtp_server\fP
T}	T{
Module for managing IIS SMTP server configuration on Windows servers.
T}
_
T{
\fI\%win_snmp\fP
T}	T{
Module for managing SNMP service settings on Windows servers.
T}
_
T{
\fI\%win_status\fP
T}	T{
Module for returning various status data about a minion.
T}
_
T{
\fI\%win_system\fP
T}	T{
Module for managing Windows systems and getting Windows system information.
T}
_
T{
\fI\%win_task\fP
T}	T{
Windows Task Scheduler Module .
T}
_
T{
\fI\%win_timezone\fP
T}	T{
Module for managing timezone on Windows systems.
T}
_
T{
\fI\%win_useradd\fP
T}	T{
Module for managing Windows Users.
T}
_
T{
\fI\%win_wua\fP
T}	T{
Module for managing Windows Updates using the Windows Update Agent.
T}
_
T{
\fI\%win_wusa\fP
T}	T{
Microsoft Update files management via wusa.exe
T}
_
T{
\fI\%winrepo\fP
T}	T{
Module to manage Windows software repo on a Standalone Minion
T}
_
T{
\fI\%wordpress\fP
T}	T{
This module is used to manage Wordpress installations
T}
_
T{
\fI\%x509\fP
T}	T{
Manage X509 certificates
T}
_
T{
\fI\%x509_v2\fP
T}	T{
Manage X.509 certificates
T}
_
T{
\fI\%xapi_virt\fP
T}	T{
This module (mostly) uses the XenAPI to manage Xen virtual machines.
T}
_
T{
\fI\%xbpspkg\fP
T}	T{
Package support for XBPS package manager (used by VoidLinux)
T}
_
T{
\fI\%xfs\fP
T}	T{
Module for managing XFS file systems.
T}
_
T{
\fI\%xml\fP
T}	T{
XML file manager
T}
_
T{
\fI\%xmpp\fP
T}	T{
Module for Sending Messages via XMPP (a.k.a.
T}
_
T{
\fI\%yaml\fP
T}	T{
Yaml helper module for troubleshooting yaml
T}
_
T{
\fI\%yumpkg\fP
T}	T{
Support for YUM/DNF
T}
_
T{
\fI\%zabbix\fP
T}	T{
T}
_
T{
\fI\%zcbuildout\fP
T}	T{
Management of zc.buildout
T}
_
T{
\fI\%zenoss\fP
T}	T{
Module for working with the Zenoss API
T}
_
T{
\fI\%zfs\fP
T}	T{
Module for running ZFS command
T}
_
T{
\fI\%zk_concurrency\fP
T}	T{
Concurrency controls in zookeeper
T}
_
T{
\fI\%znc\fP
T}	T{
znc \- An advanced IRC bouncer
T}
_
T{
\fI\%zoneadm\fP
T}	T{
Module for Solaris 10\(aqs zoneadm
T}
_
T{
\fI\%zonecfg\fP
T}	T{
Module for Solaris 10\(aqs zonecfg
T}
_
T{
\fI\%zookeeper\fP
T}	T{
Zookeeper Module

maintainer

SaltStack

maturity

new

platform

all

depends

kazoo
T}
_
T{
\fI\%zpool\fP
T}	T{
Module for running ZFS zpool command
T}
_
T{
\fI\%zypperpkg\fP
T}	T{
Package support for openSUSE via the zypper package manager
T}
_
.TE
.SS salt.modules.acme
.SS ACME / Let\(aqs Encrypt module
.sp
New in version 2016.3.0.

.sp
This module currently looks for certbot script in the $PATH as
\- certbot,
\- lestsencrypt,
\- certbot\-auto,
\- letsencrypt\-auto
eventually falls back to /opt/letsencrypt/letsencrypt\-auto
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Installation & configuration of the Let\(aqs Encrypt client can for example be done using
\fI\%https://github.com/saltstack\-formulas/letsencrypt\-formula\fP
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Be sure to set at least accept\-tos = True in cli.ini!
.UNINDENT
.UNINDENT
.sp
Most parameters will fall back to cli.ini defaults if None is given.
.SS DNS plugins
.sp
This module currently supports the CloudFlare certbot DNS plugin.  The DNS
plugin credentials file needs to be passed in using the
\fBdns_plugin_credentials\fP argument.
.sp
Make sure the appropriate certbot plugin for the wanted DNS provider is
installed before using this module.
.INDENT 0.0
.TP
.B salt.modules.acme.cert(name, aliases=None, email=None, webroot=None, test_cert=False, renew=None, keysize=None, server=None, owner=\(aqroot\(aq, group=\(aqroot\(aq, mode=\(aq0640\(aq, certname=None, preferred_challenges=None, tls_sni_01_port=None, tls_sni_01_address=None, http_01_port=None, http_01_address=None, dns_plugin=None, dns_plugin_credentials=None, manual_auth_hook=None, manual_cleanup_hook=None)
Obtain/renew a certificate from an ACME CA, probably Let\(aqs Encrypt.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Common Name of the certificate (DNS name of certificate)
.IP \(bu 2
\fBaliases\fP \-\- subjectAltNames (Additional DNS names on certificate)
.IP \(bu 2
\fBemail\fP \-\- e\-mail address for interaction with ACME provider
.IP \(bu 2
\fBwebroot\fP \-\- True or a full path to use to use webroot. Otherwise use standalone mode
.IP \(bu 2
\fBtest_cert\fP \-\- Request a certificate from the Happy Hacker Fake CA (mutually
exclusive with \(aqserver\(aq)
.IP \(bu 2
\fBrenew\fP \-\- True/\(aqforce\(aq to force a renewal, or a window of renewal before
expiry in days
.IP \(bu 2
\fBkeysize\fP \-\- RSA key bits
.IP \(bu 2
\fBserver\fP \-\- API endpoint to talk to
.IP \(bu 2
\fBowner\fP \-\- owner of the private key file
.IP \(bu 2
\fBgroup\fP \-\- group of the private key file
.IP \(bu 2
\fBmode\fP \-\- mode of the private key file
.IP \(bu 2
\fBcertname\fP \-\- Name of the certificate to save
.IP \(bu 2
\fBpreferred_challenges\fP \-\- A sorted, comma delimited list of the preferred
challenge to use during authorization with the most preferred challenge
listed first.
.IP \(bu 2
\fBtls_sni_01_port\fP \-\- Port used during tls\-sni\-01 challenge. This only affects
the port Certbot listens on. A conforming ACME server will still attempt
to connect on port 443.
.IP \(bu 2
\fBtls_sni_01_address\fP \-\- The address the server listens to during tls\-sni\-01
challenge.
.IP \(bu 2
\fBhttp_01_port\fP \-\- Port used in the http\-01 challenge. This only affects
the port Certbot listens on. A conforming ACME server will still attempt
to connect on port 80.
.IP \(bu 2
\fBhttps_01_address\fP \-\- The address the server listens to during http\-01 challenge.
.IP \(bu 2
\fBdns_plugin\fP \-\- Name of a DNS plugin to use (currently only \(aqcloudflare\(aq
or \(aqdigitalocean\(aq)
.IP \(bu 2
\fBdns_plugin_credentials\fP \-\- Path to the credentials file if required by
the specified DNS plugin
.IP \(bu 2
\fBdns_plugin_propagate_seconds\fP \-\- Number of seconds to wait for DNS propogations
before asking ACME servers to verify the DNS record. (default 10)
.IP \(bu 2
\fBmanual_auth_hook\fP \-\- Path to the manual authentication hook script.
.IP \(bu 2
\fBmanual_cleanup_hook\fP \-\- Path to the manual cleanup or post\-authentication hook script.
.UNINDENT
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with \(aqresult\(aq True/False/None, \(aqcomment\(aq and certificate\(aqs
expiry date (\(aqnot_after\(aq)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqgitlab.example.com\(aq acme.cert dev.example.com \(dq[gitlab.example.com]\(dq test_cert=True         renew=14 webroot=/opt/gitlab/embedded/service/gitlab\-rails/public
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.acme.certs()
Return a list of active certificates
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqvhost.example.com\(aq acme.certs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.acme.expires(name)
The expiry date of a certificate in ISO format
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- Name of certificate
.TP
.B Return type
\fI\%str\fP
.TP
.B Returns
Expiry date in ISO format.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqgitlab.example.com\(aq acme.expires dev.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.acme.has(name)
Test if a certificate is in the Let\(aqs Encrypt Live directory
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- Name of certificate
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
Code example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
if __salt__[\(aqacme.has\(aq](\(aqdev.example.com\(aq):
    log.info(\(aqThat is one nice certificate you have there!\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.acme.info(name)
Return information about a certificate
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- Name of certificate
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with information about the certificate.
If neither the \fBtls\fP nor the \fBx509\fP module can be used to determine
the certificate information, the information will be retrieved as one
big text block under the key \fBtext\fP using the openssl cli.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqgitlab.example.com\(aq acme.info dev.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.acme.needs_renewal(name, window=None)
Check if a certificate needs renewal
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name of certificate
.IP \(bu 2
\fBwindow\fP (\fIbool/str/int\fP) \-\- Window in days to renew earlier or True/force to just return True
.UNINDENT
.TP
.B Return type
\fI\%bool\fP
.TP
.B Returns
Whether or not the certificate needs to be renewed.
.UNINDENT
.sp
Code example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
if __salt__[\(aqacme.needs_renewal\(aq](\(aqdev.example.com\(aq):
    __salt__[\(aqacme.cert\(aq](\(aqdev.example.com\(aq, **kwargs)
else:
    log.info(\(aqYour certificate is still good\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.acme.renew_by(name, window=None)
Date in ISO format when a certificate should first be renewed
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name of certificate
.IP \(bu 2
\fBwindow\fP (\fI\%int\fP) \-\- number of days before expiry when renewal should take place
.UNINDENT
.TP
.B Return type
\fI\%str\fP
.TP
.B Returns
Date of certificate renewal in ISO format.
.UNINDENT
.UNINDENT
.SS salt.modules.aix_group
.sp
Manage groups on Solaris
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage groups on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqgroup.info\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aix_group.add(name, gid=None, system=False, root=None, **kwargs)
Add the specified group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.add foo 3456
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aix_group.adduser(name, username, root=None)
Add a user in the group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.adduser foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Verifies if a valid username \(aqbar\(aq as a member of an existing group \(aqfoo\(aq,
if not then adds it.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aix_group.chgid(name, gid)
Change the gid for a named group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.chgid foo 4376
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aix_group.delete(name)
Remove the named group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.delete foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aix_group.deluser(name, username, root=None)
Remove a user from the group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.deluser foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Removes a member user \(aqbar\(aq from a group \(aqfoo\(aq. If group is not present
then returns True.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aix_group.getent(refresh=False)
Return info on all groups
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.getent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aix_group.info(name)
Return information about a group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.info foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aix_group.members(name, members_list, root=None)
Replaces members of the group with a provided list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.members foo \(aquser1,user2,user3,...\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Replaces a membership list for a local group \(aqfoo\(aq.
foo:x:1234:user1,user2,user3,...
.UNINDENT
.UNINDENT
.SS salt.modules.aix_shadow
.sp
Manage account locks on AIX systems
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
none
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aix_shadow.locked(user)
Query for all accounts which are flagged as locked.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <minion_id> shadow.locked ALL
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aix_shadow.login_failures(user)
Query for all accounts which have 3 or more login failures.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <minion_id> shadow.login_failures ALL
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aix_shadow.unlock(user)
Unlock user for locked account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <minion_id> shadow.unlock user
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.aixpkg
.sp
Package support for AIX
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage filesets or
rpm packages on a minion, and it is using a different module (or gives an
error similar to \fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aixpkg.available_version(*names, **kwargs)
This function is an alias of \fBlatest_version\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the latest available version of the named fileset/rpm package available for
upgrade or installation. If more than one fileset/rpm package name is
specified, a dict of name/version pairs is returned.
.sp
If the latest version of a given fileset/rpm package is already installed,
an empty string will be returned for that package.
.sp
Changed in version 3005.

.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B Note: currently only functional for rpm packages due to filesets do not have a specific location to check
Requires yum of dnf available in order to query a repository
.UNINDENT
.sp
This function will always return an empty string for unfound fileset/rpm package.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aixpkg.install(name=None, refresh=False, pkgs=None, version=None, test=False, **kwargs)
Install the named fileset(s)/rpm package(s).
.sp
Changed in version 3005:
.INDENT 7.0
.TP
.B preference to install rpm packages are to use in the following order:
/opt/freeware/bin/dnf
/opt/freeware/bin/yum
/usr/bin/yum
/usr/bin/rpm
.UNINDENT

.INDENT 7.0
.TP
.B name
The name of the fileset or rpm package to be installed.
.TP
.B refresh
Whether or not to update the yum database before executing.
.TP
.B pkgs
A list of filesets and/or rpm packages to install.
Must be passed as a python list. The \fBname\fP parameter will be
ignored if this option is passed.
.TP
.B version
Install a specific version of a fileset/rpm package.
(Unused at present).
.TP
.B test
Verify that command functions correctly.
.UNINDENT
.sp
Returns a dict containing the new fileset(s)/rpm package(s) names and versions:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B {\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
\(aqnew\(aq: \(aq<new\-version>\(aq}}
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install /stage/middleware/AIX/bash\-4.2\-3.aix6.1.ppc.rpm
salt \(aq*\(aq pkg.install /stage/middleware/AIX/bash\-4.2\-3.aix6.1.ppc.rpm refresh=True
salt \(aq*\(aq pkg.install /stage/middleware/AIX/VIOS2211_update/tpc_4.1.1.85.bff
salt \(aq*\(aq pkg.install /cecc/repos/aix72/TL3/BASE/installp/ppc/bos.rte.printers_7.2.2.0.bff
salt \(aq*\(aq pkg.install /stage/middleware/AIX/Xlc/usr/sys/inst.images/xlC.rte
salt \(aq*\(aq pkg.install /stage/middleware/AIX/Firefox/ppc\-AIX53/Firefox.base
salt \(aq*\(aq pkg.install /cecc/repos/aix72/TL3/BASE/installp/ppc/bos.net
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
salt \(aq*\(aq pkg.install libxml2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aixpkg.latest_version(*names, **kwargs)
Return the latest available version of the named fileset/rpm package available for
upgrade or installation. If more than one fileset/rpm package name is
specified, a dict of name/version pairs is returned.
.sp
If the latest version of a given fileset/rpm package is already installed,
an empty string will be returned for that package.
.sp
Changed in version 3005.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Note: currently only functional for rpm packages due to filesets do not have a specific location to check
Requires yum of dnf available in order to query a repository
.UNINDENT
.sp
This function will always return an empty string for unfound fileset/rpm package.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aixpkg.list_pkgs(versions_as_list=False, **kwargs)
List the filesets/rpm packages currently installed as a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aixpkg.remove(name=None, pkgs=None, **kwargs)
Remove specified fileset(s)/rpm package(s).
.INDENT 7.0
.TP
.B name
The name of the fileset or rpm package to be deleted.
.UNINDENT
.sp
Changed in version 3005:
.INDENT 7.0
.TP
.B preference to install rpm packages are to use in the following order:
/opt/freeware/bin/dnf
/opt/freeware/bin/yum
/usr/bin/yum
/usr/bin/rpm
.UNINDENT

.INDENT 7.0
.TP
.B pkgs
A list of filesets and/or rpm packages to delete.
Must be passed as a python list. The \fBname\fP parameter will be
ignored if this option is passed.
.UNINDENT
.sp
Returns a list containing the removed packages.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <fileset/rpm package name>
salt \(aq*\(aq pkg.remove tcsh
salt \(aq*\(aq pkg.remove xlC.rte
salt \(aq*\(aq pkg.remove Firefox.base.adt
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aixpkg.upgrade_available(name, **kwargs)
Check whether or not an upgrade is available for a given package
.sp
Changed in version 3005.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade_available <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Note: currently only functional for rpm packages due to filesets do not have a specific location to check
Requires yum of dnf available in order to query a repository
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aixpkg.version(*names, **kwargs)
Return the current installed version of the named fileset/rpm package
If more than one fileset/rpm package name is specified a dict of
name/version pairs is returned.
.sp
Changed in version 3005.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.aliases
.sp
Manage the information in the aliases file
.INDENT 0.0
.TP
.B salt.modules.aliases.get_target(alias)
Return the target associated with an alias
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aliases.get_target alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aliases.has_target(alias, target)
Return true if the alias/target is set
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aliases.has_target alias target
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aliases.list_aliases()
Return the aliases found in the aliases file in this format:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqalias\(aq: \(aqtarget\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aliases.list_aliases
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aliases.rm_alias(alias)
Remove an entry from the aliases file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aliases.rm_alias alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aliases.set_target(alias, target)
Set the entry in the aliases file for the given alias, this will overwrite
any previous entry for the given alias or create a new one if it does not
exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aliases.set_target alias target
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.alternatives
.sp
Support for Alternatives system
.INDENT 0.0
.TP
.B codeauthor
Radek Rada <\fI\%radek.rada@gmail.com\fP>
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.alternatives.auto(name)
Trigger alternatives to set the path for <name> as
specified by priority.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq alternatives.auto name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.alternatives.check_exists(name, path)
Check if the given path is an alternative for a name.
.sp
New in version 2015.8.4.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq alternatives.check_exists name path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.alternatives.check_installed(name, path)
Check if the current highest\-priority match for a given alternatives link
is set to the desired path
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq alternatives.check_installed name path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.alternatives.display(name)
Display alternatives settings for defined command name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq alternatives.display editor
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.alternatives.install(name, link, path, priority)
Install symbolic links determining default commands
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq alternatives.install editor /usr/bin/editor /usr/bin/emacs23 50
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.alternatives.remove(name, path)
Remove symbolic links determining the default commands.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq alternatives.remove name path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.alternatives.set_(name, path)
Manually set the alternative <path> for <name>.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq alternatives.set name path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.alternatives.show_current(name)
Display the current highest\-priority alternative for a given alternatives
link
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq alternatives.show_current editor
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.alternatives.show_link(name)
Display master link for the alternative
.sp
New in version 2015.8.13,2016.3.4,2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq alternatives.show_link editor
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.ansiblegate
.SS Ansible Support
.sp
This module can have an optional minion\-level
configuration in /etc/salt/minion.d/ as follows:
.INDENT 0.0
.INDENT 3.5
ansible_timeout: 1200
.UNINDENT
.UNINDENT
.sp
The timeout is how many seconds Salt should wait for
any Ansible module to respond.
.INDENT 0.0
.TP
.B salt.modules.ansiblegate.call(module, *args, **kwargs)
Call an Ansible module by invoking it.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmodule\fP \-\- the name of the module.
.IP \(bu 2
\fBargs\fP \-\- Arguments to pass to the module
.IP \(bu 2
\fBkwargs\fP \-\- keywords to pass to the module
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt * ansible.call ping data=foobar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ansiblegate.discover_playbooks(path=None, locations=None, playbook_extension=None, hosts_filename=None, syntax_check=False)
New in version 3005.

.sp
Discover Ansible playbooks stored under the given path or from multiple paths (locations)
.sp
This will search for files matching with the playbook file extension under the given
root path and will also look for files inside the first level of directories in this path.
.sp
The return of this function would be a dict like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dq/home/foobar/\(dq: {
        \(dqmy_ansible_playbook.yml\(dq: {
            \(dqfullpath\(dq: \(dq/home/foobar/playbooks/my_ansible_playbook.yml\(dq,
            \(dqcustom_inventory\(dq: \(dq/home/foobar/playbooks/hosts\(dq
        },
        \(dqanother_playbook.yml\(dq: {
            \(dqfullpath\(dq: \(dq/home/foobar/playbooks/another_playbook.yml\(dq,
            \(dqcustom_inventory\(dq: \(dq/home/foobar/playbooks/hosts\(dq
        },
        \(dqlamp_simple/site.yml\(dq: {
            \(dqfullpath\(dq: \(dq/home/foobar/playbooks/lamp_simple/site.yml\(dq,
            \(dqcustom_inventory\(dq: \(dq/home/foobar/playbooks/lamp_simple/hosts\(dq
        },
        \(dqlamp_proxy/site.yml\(dq: {
            \(dqfullpath\(dq: \(dq/home/foobar/playbooks/lamp_proxy/site.yml\(dq,
            \(dqcustom_inventory\(dq: \(dq/home/foobar/playbooks/lamp_proxy/hosts\(dq
        }
    },
    \(dq/srv/playbooks/\(dq: {
        \(dqexample_playbook/example.yml\(dq: {
            \(dqfullpath\(dq: \(dq/srv/playbooks/example_playbook/example.yml\(dq,
            \(dqcustom_inventory\(dq: \(dq/srv/playbooks/example_playbook/hosts\(dq
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP \-\- Path to discover playbooks from.
.IP \(bu 2
\fBlocations\fP \-\- List of paths to discover playbooks from.
.IP \(bu 2
\fBplaybook_extension\fP \-\- File extension of playbooks file to search for. Default: \(dqyml\(dq
.IP \(bu 2
\fBhosts_filename\fP \-\- Filename of custom playbook inventory to search for. Default: \(dqhosts\(dq
.IP \(bu 2
\fBsyntax_check\fP \-\- Skip playbooks that do not pass \(dqansible\-playbook \-\-syntax\-check\(dq validation. Default: False
.UNINDENT
.TP
.B Returns
The discovered playbooks under the given paths
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqansiblehost\(aq ansible.discover_playbooks path=/srv/playbooks/
salt \(aqansiblehost\(aq ansible.discover_playbooks locations=\(aq[\(dq/srv/playbooks/\(dq, \(dq/srv/foobar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ansiblegate.help(module=None, *args)
Display help on Ansible standard module.
.INDENT 7.0
.TP
.B Parameters
\fBmodule\fP \-\- The module to get the help
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt * ansible.help ping
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ansiblegate.list_(pattern=None)
Lists available modules.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt * ansible.list
salt * ansible.list \(aq*win*\(aq  # To get all modules matching \(aqwin\(aq on it\(aqs name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ansiblegate.playbooks(playbook, rundir=None, check=False, diff=False, extra_vars=None, flush_cache=False, forks=5, inventory=None, limit=None, list_hosts=False, list_tags=False, list_tasks=False, module_path=None, skip_tags=None, start_at_task=None, syntax_check=False, tags=None, playbook_kwargs=None)
Run Ansible Playbooks
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBplaybook\fP \-\- Which playbook to run.
.IP \(bu 2
\fBrundir\fP \-\- Directory to run \fIansible\-playbook\fP in. (Default: None)
.IP \(bu 2
\fBcheck\fP \-\- don\(aqt make any changes; instead, try to predict some
of the changes that may occur (Default: False)
.IP \(bu 2
\fBdiff\fP \-\- when changing (small) files and templates, show the
differences in those files; works great with \-\-check
(default: False)
.IP \(bu 2
\fBextra_vars\fP \-\- set additional variables as key=value or YAML/JSON, if
filename prepend with @, (default: None)
.IP \(bu 2
\fBflush_cache\fP \-\- clear the fact cache for every host in inventory
(default: False)
.IP \(bu 2
\fBforks\fP \-\- specify number of parallel processes to use
(Default: 5)
.IP \(bu 2
\fBinventory\fP \-\- specify inventory host path or comma separated host
list. (Default: None) (Ansible\(aqs default is /etc/ansible/hosts)
.IP \(bu 2
\fBlimit\fP \-\- further limit selected hosts to an additional pattern (Default: None)
.IP \(bu 2
\fBlist_hosts\fP \-\- outputs a list of matching hosts; does not execute anything else
(Default: False)
.IP \(bu 2
\fBlist_tags\fP \-\- list all available tags (Default: False)
.IP \(bu 2
\fBlist_tasks\fP \-\- list all tasks that would be executed (Default: False)
.IP \(bu 2
\fBmodule_path\fP \-\- prepend colon\-separated path(s) to module library. (Default: None)
.IP \(bu 2
\fBskip_tags\fP \-\- only run plays and tasks whose tags do not match these
values (Default: False)
.IP \(bu 2
\fBstart_at_task\fP \-\- start the playbook at the task matching this name (Default: None)
.IP \(bu 2
\fBtags\fP \-\- only run plays and tasks tagged with these values (Default: None)
.UNINDENT
.TP
.B Param
syntax_check: perform a syntax check on the playbook, but do not execute it
(Default: False)
.TP
.B Returns
Playbook return
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqansiblehost\(aq  ansible.playbooks playbook=/srv/playbooks/play.yml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ansiblegate.targets(inventory=\(aq/etc/ansible/hosts\(aq, yaml=False, export=False)
New in version 3005.

.sp
Return the inventory from an Ansible inventory_file
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinventory\fP \-\- The inventory file to read the inventory from. Default: \(dq/etc/ansible/hosts\(dq
.IP \(bu 2
\fByaml\fP \-\- Return the inventory as yaml output. Default: False
.IP \(bu 2
\fBexport\fP \-\- Return inventory as export format. Default: False
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqansiblehost\(aq ansible.targets
salt \(aqansiblehost\(aq ansible.targets inventory=my_custom_inventory
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.apache
.sp
Support for Apache
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The functions in here are generic functions designed to work with
all implementations of Apache. Debian\-specific functions have been moved into
deb_apache.py, but will still load under the \fBapache\fP namespace when a
Debian\-based system is detected.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apache.config(name, config, edit=True)
Create VirtualHost configuration files
.INDENT 7.0
.TP
.B name
File for the virtual host
.TP
.B config
VirtualHost configurations
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function is not meant to be used from the command line.
Config is meant to be an ordered dict of all of the apache configs.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.config /etc/httpd/conf.d/ports.conf config=\(dq[{\(aqListen\(aq: \(aq22\(aq}]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apache.directives()
Return list of directives together with expected arguments
and places where the directive is valid (\fBapachectl \-L\fP)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.directives
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apache.fullversion()
Return server version (\fBapachectl \-V\fP)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.fullversion
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apache.modules()
Return list of static and shared modules (\fBapachectl \-M\fP)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.modules
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apache.server_status(profile=\(aqdefault\(aq)
Get Information from the Apache server\-status handler
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The server\-status handler is disabled by default.
In order for this function to work it needs to be enabled.
See \fI\%http://httpd.apache.org/docs/2.2/mod/mod_status.html\fP
.UNINDENT
.UNINDENT
.sp
The following configuration needs to exists in pillar/grains.
Each entry nested in \fBapache.server\-status\fP is a profile of a vhost/server.
This would give support for multiple apache servers/vhosts.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
apache.server\-status:
  default:
    url: http://localhost/server\-status
    user: someuser
    pass: password
    realm: \(aqauthentication realm for digest passwords\(aq
    timeout: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.server_status
salt \(aq*\(aq apache.server_status other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apache.servermods()
Return list of modules compiled into the server (\fBapachectl \-l\fP)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.servermods
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apache.signal(signal=None)
Signals httpd to start, restart, or stop.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.signal restart
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apache.useradd(pwfile, user, password, opts=\(aq\(aq)
Add HTTP user using the \fBhtpasswd\fP command. If the \fBhtpasswd\fP file does not
exist, it will be created. Valid options that can be passed are:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
n  Don\(aqt update file; display results on stdout.
m  Force MD5 hashing of the password (default).
d  Force CRYPT(3) hashing of the password.
p  Do not hash the password (plaintext).
s  Force SHA1 hashing of the password.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.useradd /etc/httpd/htpasswd larry badpassword
salt \(aq*\(aq apache.useradd /etc/httpd/htpasswd larry badpass opts=ns
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apache.userdel(pwfile, user)
Delete HTTP user from the specified \fBhtpasswd\fP file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.userdel /etc/httpd/htpasswd larry
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apache.version()
Return server version (\fBapachectl \-v\fP)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apache.vhosts()
Show the settings as parsed from the config file (currently
only shows the virtualhost settings) (\fBapachectl \-S\fP).
Because each additional virtual host adds to the execution
time, this command may require a long timeout be specified
by using \fB\-t 10\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-t 10 \(aq*\(aq apache.vhosts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.apcups
.sp
Module for apcupsd
.INDENT 0.0
.TP
.B salt.modules.apcups.status()
Return apcaccess output
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apcups.status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apcups.status_battery()
Return true if running on battery power
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apcups.status_battery
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apcups.status_charge()
Return battery charge
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apcups.status_charge
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apcups.status_load()
Return load
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apcups.status_load
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.apf
.SS Support for Advanced Policy Firewall (APF)
.INDENT 0.0
.TP
.B maintainer
Mostafa Hussein <\fI\%mostafa.hussein91@gmail.com\fP>
.TP
.B maturity
new
.TP
.B depends
python\-iptables
.TP
.B platform
Linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apf.allow(ip, port=None)
Add host (IP/FQDN) to allow_hosts.rules and immediately load new rule into firewall
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apf.allow 127.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apf.deny(ip)
Add host (IP/FQDN) to deny_hosts.rules and immediately load new rule into firewall
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apf.deny 1.2.3.4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apf.disable()
Stop (flush) all firewall rules
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apf.disable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apf.enable()
Load all firewall rules
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apf.enable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apf.refresh()
Refresh & resolve dns names in trust rules
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apf.refresh
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apf.reload()
Stop (flush) & reload firewall rules
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apf.reload
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apf.remove(ip)
Remove host from [glob]*_hosts.rules and immediately remove rule from firewall
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apf.remove 1.2.3.4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apf.running()
Check apf status
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apf.running
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.apkpkg
.sp
Support for apk
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage packages on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.modules.apkpkg.file_dict(*packages, **kwargs)
List the files that belong to a package, grouped by package. Not
specifying any packages will return a list of _every_ file on the system\(aqs
package database (not generally recommended).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_list httpd
salt \(aq*\(aq pkg.file_list httpd postfix
salt \(aq*\(aq pkg.file_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apkpkg.file_list(*packages, **kwargs)
List the files that belong to a package. Not specifying any packages will
return a list of _every_ file on the system\(aqs package database (not
generally recommended).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_list httpd
salt \(aq*\(aq pkg.file_list httpd postfix
salt \(aq*\(aq pkg.file_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apkpkg.install(name=None, refresh=False, pkgs=None, sources=None, **kwargs)
Install the passed package, add refresh=True to update the apk database.
.INDENT 7.0
.TP
.B name
The name of the package to be installed. Note that this parameter is
ignored if either \(dqpkgs\(dq or \(dqsources\(dq is passed. Additionally, please
note that this option can only be used to install packages from a
software repository. To install a package file manually, use the
\(dqsources\(dq option.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B refresh
Whether or not to refresh the package database before installing.
.UNINDENT
.sp
Multiple Package Installation Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to install from a software repository. Must be
passed as a python list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B sources
A list of IPK packages to install. Must be passed as a list of dicts,
with the keys being package names, and the values being the source URI
or local path to the package.  Dependencies are automatically resolved
and marked as auto\-installed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install sources=\(aq[{\(dqfoo\(dq: \(dqsalt://foo.deb\(dq},{\(dqbar\(dq: \(dqsalt://bar.deb\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B install_recommends
Whether to install the packages marked as recommended. Default is True.
.UNINDENT
.sp
Returns a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apkpkg.latest_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apkpkg.list_pkgs(versions_as_list=False, **kwargs)
List the packages currently installed in a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
salt \(aq*\(aq pkg.list_pkgs versions_as_list=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apkpkg.list_upgrades(refresh=True, **kwargs)
List all available package upgrades.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apkpkg.owner(*paths, **kwargs)
Return the name of the package that owns the file. Multiple file paths can
be passed. Like \fBpkg.version <salt.modules.apk.version\fP, if a single
path is passed, a string will be returned, and if multiple paths are passed,
a dictionary of file/package name pairs will be returned.
.sp
If the file is not owned by a package, or is not present on the minion,
then an empty string will be returned for that path.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.owns /usr/bin/apachectl
salt \(aq*\(aq pkg.owns /usr/bin/apachectl /usr/bin/basename
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apkpkg.purge(name=None, pkgs=None, **kwargs)
Alias to remove
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apkpkg.refresh_db(**kwargs)
Updates the package list
.INDENT 7.0
.IP \(bu 2
\fBTrue\fP: Database updated successfully
.IP \(bu 2
\fBFalse\fP: Problem updating database
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apkpkg.remove(name=None, pkgs=None, purge=False, **kwargs)
Remove packages using \fBapk del\fP\&.
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apkpkg.upgrade(name=None, pkgs=None, refresh=True, **kwargs)
Upgrades all packages via \fBapk upgrade\fP or a specific package if name or
pkgs is specified. Name is ignored if pkgs is specified
.sp
Returns a dict containing the changes.
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B {\(aq<package>\(aq:  {\(aqold\(aq: \(aq<old\-version>\(aq,
\(aqnew\(aq: \(aq<new\-version>\(aq}}
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.apkpkg.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.aptly
.sp
Aptly Debian repository manager.
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B salt.modules.aptly.cleanup_db(config_path=\(aq/etc/aptly.conf\(aq, dry_run=False)
.INDENT 7.0
.TP
.B Remove data regarding unreferenced packages and delete files in the package pool that
are no longer being used by packages.
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBdry_run\fP (\fI\%bool\fP) \-\- Report potential changes without making any changes.
.TP
.B Returns
A dictionary of the package keys and files that were removed.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aptly.cleanup_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptly.delete_repo(name, config_path=\(aq/etc/aptly.conf\(aq, force=False)
Remove the repository.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the repository.
.IP \(bu 2
\fBconfig_path\fP (\fI\%str\fP) \-\- The path to the configuration file for the aptly instance.
.IP \(bu 2
\fBforce\fP (\fI\%bool\fP) \-\- Whether to remove the repository even if it is used as the source
of an existing snapshot.
.UNINDENT
.TP
.B Returns
A boolean representing whether all changes succeeded.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aptly.delete_repo name=\(dqtest\-repo\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptly.get_config(config_path=\(aq/etc/aptly.conf\(aq)
Get the configuration data.
.INDENT 7.0
.TP
.B Parameters
\fBconfig_path\fP (\fI\%str\fP) \-\- The path to the configuration file for the aptly instance.
.TP
.B Returns
A dictionary containing the configuration data.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aptly.get_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptly.get_repo(name, config_path=\(aq/etc/aptly.conf\(aq, with_packages=False)
Get the details of the repository.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the repository.
.IP \(bu 2
\fBconfig_path\fP (\fI\%str\fP) \-\- The path to the configuration file for the aptly instance.
.IP \(bu 2
\fBwith_packages\fP (\fI\%bool\fP) \-\- Return a list of packages in the repo.
.UNINDENT
.TP
.B Returns
A dictionary containing information about the repository.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aptly.get_repo name=\(dqtest\-repo\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptly.list_mirrors(config_path=\(aq/etc/aptly.conf\(aq)
Get a list of all the mirrors.
.INDENT 7.0
.TP
.B Parameters
\fBconfig_path\fP (\fI\%str\fP) \-\- The path to the configuration file for the aptly instance.
.TP
.B Returns
A list of the mirror names.
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aptly.list_mirrors
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptly.list_published(config_path=\(aq/etc/aptly.conf\(aq)
Get a list of all the published repositories.
.INDENT 7.0
.TP
.B Parameters
\fBconfig_path\fP (\fI\%str\fP) \-\- The path to the configuration file for the aptly instance.
.TP
.B Returns
A list of the published repository names.
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aptly.list_published
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptly.list_repos(config_path=\(aq/etc/aptly.conf\(aq, with_packages=False)
List all of the repos.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconfig_path\fP (\fI\%str\fP) \-\- The path to the configuration file for the aptly instance.
.IP \(bu 2
\fBwith_packages\fP (\fI\%bool\fP) \-\- Return a list of packages in the repo.
.UNINDENT
.TP
.B Returns
A dictionary of the repositories.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aptly.list_repos
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptly.list_snapshots(config_path=\(aq/etc/aptly.conf\(aq, sort_by_time=False)
Get a list of all the snapshots.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconfig_path\fP (\fI\%str\fP) \-\- The path to the configuration file for the aptly instance.
.IP \(bu 2
\fBsort_by_time\fP (\fI\%bool\fP) \-\- Whether to sort by creation time instead of by name.
.UNINDENT
.TP
.B Returns
A list of the snapshot names.
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aptly.list_snapshots
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptly.new_repo(name, config_path=\(aq/etc/aptly.conf\(aq, comment=None, component=None, distribution=None, uploaders_file=None, from_snapshot=None, saltenv=\(aqbase\(aq)
Create the new repository.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the repository.
.IP \(bu 2
\fBconfig_path\fP (\fI\%str\fP) \-\- The path to the configuration file for the aptly instance.
.IP \(bu 2
\fBcomment\fP (\fI\%str\fP) \-\- The description of the repository.
.IP \(bu 2
\fBcomponent\fP (\fI\%str\fP) \-\- The default component to use when publishing.
.IP \(bu 2
\fBdistribution\fP (\fI\%str\fP) \-\- The default distribution to use when publishing.
.IP \(bu 2
\fBuploaders_file\fP (\fI\%str\fP) \-\- The repository upload restrictions config.
.IP \(bu 2
\fBfrom_snapshot\fP (\fI\%str\fP) \-\- The snapshot to initialize the repository contents from.
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- The environment the file resides in.
.UNINDENT
.TP
.B Returns
A boolean representing whether all changes succeeded.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aptly.new_repo name=\(dqtest\-repo\(dq comment=\(dqTest main repo\(dq component=\(dqmain\(dq distribution=\(dqtrusty\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptly.set_repo(name, config_path=\(aq/etc/aptly.conf\(aq, comment=None, component=None, distribution=None, uploaders_file=None, saltenv=\(aqbase\(aq)
Configure the repository settings.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the repository.
.IP \(bu 2
\fBconfig_path\fP (\fI\%str\fP) \-\- The path to the configuration file for the aptly instance.
.IP \(bu 2
\fBcomment\fP (\fI\%str\fP) \-\- The description of the repository.
.IP \(bu 2
\fBcomponent\fP (\fI\%str\fP) \-\- The default component to use when publishing.
.IP \(bu 2
\fBdistribution\fP (\fI\%str\fP) \-\- The default distribution to use when publishing.
.IP \(bu 2
\fBuploaders_file\fP (\fI\%str\fP) \-\- The repository upload restrictions config.
.IP \(bu 2
\fBfrom_snapshot\fP (\fI\%str\fP) \-\- The snapshot to initialize the repository contents from.
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- The environment the file resides in.
.UNINDENT
.TP
.B Returns
A boolean representing whether all changes succeeded.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aptly.set_repo name=\(dqtest\-repo\(dq comment=\(dqTest universe repo\(dq component=\(dquniverse\(dq distribution=\(dqxenial\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.aptpkg
.sp
Support for APT (Advanced Packaging Tool)
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage packages on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.sp
For repository management, the \fBpython\-apt\fP package must be installed.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.aptpkg.SourceEntry(line, file=None)
.INDENT 7.0
.TP
.B repo_line()
Return the repo line for the sources file
.UNINDENT
.INDENT 7.0
.TP
.B str()
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.aptpkg.SourcesList
.INDENT 7.0
.TP
.B add(type, uri, dist, orig_comps, architectures, signedby)
.UNINDENT
.INDENT 7.0
.TP
.B add_file(file)
Add the lines of a file to self.list
.UNINDENT
.INDENT 7.0
.TP
.B remove(source)
remove a source from the list of sources
.UNINDENT
.INDENT 7.0
.TP
.B save()
write all of the sources from the list of sources
to the file.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.add_repo_key(path=None, text=None, keyserver=None, keyid=None, saltenv=\(aqbase\(aq, aptkey=True, keydir=None, keyfile=None)
New in version 2017.7.0.

.sp
Add a repo key using \fBapt\-key add\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path of the key file to import.
.IP \(bu 2
\fBtext\fP (\fI\%str\fP) \-\- The key data to import, in string form.
.IP \(bu 2
\fBkeyserver\fP (\fI\%str\fP) \-\- The server to download the repo key specified by the keyid.
.IP \(bu 2
\fBkeyid\fP (\fI\%str\fP) \-\- The key id of the repo key to add.
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- The environment the key file resides in.
.IP \(bu 2
\fBaptkey\fP (\fI\%bool\fP) \-\- Use the binary apt\-key.
.IP \(bu 2
\fBkeydir\fP (\fI\%str\fP) \-\- The directory path to save keys. The default directory
is /etc/apt/keyrings/ which is the recommended path
for adding third party keys. This argument is only used
when aptkey is False.
.IP \(bu 2
\fBkeyfile\fP (\fI\%str\fP) \-\- The name of the key to add. This is only required when
aptkey is False and you are using a keyserver. This
argument is only used when aptkey is False.
.UNINDENT
.TP
.B Returns
A boolean representing whether the repo key was added.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The apt\-key binary is deprecated and will last be available
in Debian 11 and Ubuntu 22.04. It is recommended to use aptkey=False
when using this module.
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.add_repo_key \(aqsalt://apt/sources/test.key\(aq

salt \(aq*\(aq pkg.add_repo_key text=\(dq\(aq$KEY1\(aq\(dq

salt \(aq*\(aq pkg.add_repo_key keyserver=\(aqkeyserver.example\(aq keyid=\(aq0000AAAA\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.autoremove(list_only=False, purge=False)
New in version 2015.5.0.

.sp
Remove packages not required by another package using \fBapt\-get
autoremove\fP\&.
.INDENT 7.0
.TP
.B list_only
False
Only retrieve the list of packages to be auto\-removed, do not actually
perform the auto\-removal.
.TP
.B purge
False
Also remove package config data when autoremoving packages.
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.autoremove
salt \(aq*\(aq pkg.autoremove list_only=True
salt \(aq*\(aq pkg.autoremove purge=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.available_version(*names, **kwargs)
This function is an alias of \fBlatest_version\fP\&.
.INDENT 7.0
.INDENT 3.5
Changed in version 3007.0.

.sp
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
A specific repo can be requested using the \fBfromrepo\fP keyword argument.
.sp
cache_valid_time
.INDENT 0.0
.INDENT 3.5
New in version 2016.11.0.

.sp
Skip refreshing the package database if refresh has already occurred within
<value> seconds
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package name> fromrepo=unstable
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.del_repo(repo, **kwargs)
Delete a repo from the sources.list / sources.list.d
.sp
If the .list file is in the sources.list.d directory
and the file that the repo exists in does not contain any other
repo configuration, the file itself will be deleted.
.sp
The repo passed in must be a fully formed repository definition
string.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.del_repo \(dqmyrepo definition\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.del_repo_key(name=None, aptkey=True, keydir=None, **kwargs)
New in version 2015.8.0.

.sp
Remove a repo key using \fBapt\-key del\fP
.INDENT 7.0
.TP
.B name
Repo from which to remove the key. Unnecessary if \fBkeyid\fP is passed.
.TP
.B keyid
The KeyID of the GPG key to remove
.TP
.B keyid_ppa
False
If set to \fBTrue\fP, the repo\(aqs GPG key ID will be looked up from
ppa.launchpad.net and removed.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Setting this option to \fBTrue\fP requires that the \fBname\fP param
also be passed.
.UNINDENT
.UNINDENT
.TP
.B aptkey
Use the binary apt\-key.
.TP
.B keydir
The directory path to save keys. The default directory
is /etc/apt/keyrings/ which is the recommended path
for adding third party keys.
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The apt\-key binary is deprecated and will last be available
in Debian 11 and Ubuntu 22.04. It is recommended to use aptkey=False
when using this module.
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.del_repo_key keyid=0123ABCD
salt \(aq*\(aq pkg.del_repo_key name=\(aqppa:foo/bar\(aq keyid_ppa=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.file_dict(*packages, **kwargs)
List the files that belong to a package, grouped by package. Not
specifying any packages will return a list of _every_ file on the system\(aqs
package database (not generally recommended).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_dict httpd
salt \(aq*\(aq pkg.file_dict httpd postfix
salt \(aq*\(aq pkg.file_dict
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.file_list(*packages, **kwargs)
List the files that belong to a package. Not specifying any packages will
return a list of _every_ file on the system\(aqs package database (not
generally recommended).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_list httpd
salt \(aq*\(aq pkg.file_list httpd postfix
salt \(aq*\(aq pkg.file_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.get_repo(repo, **kwargs)
Display a repo from the sources.list / sources.list.d
.sp
The repo passed in needs to be a complete repo entry.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.get_repo \(dqmyrepo definition\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.get_repo_keys(aptkey=True, keydir=None)
New in version 2017.7.0.

.sp
List known repo key details.
:param bool aptkey: Use the binary apt\-key.
:param str keydir: The directory path to save keys. The default directory
is /etc/apt/keyrings/ which is the recommended path
for adding third party keys. This argument is only used
when aptkey is False.
.INDENT 7.0
.TP
.B Returns
A dictionary containing the repo keys.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.get_repo_keys
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.get_selections(pattern=None, state=None)
View package state from the dpkg database.
.sp
Returns a dict of dicts containing the state, and package names:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<host>\(aq:
    {\(aq<state>\(aq: [\(aqpkg1\(aq,
                 ...
                ]
    },
    ...
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.get_selections
salt \(aq*\(aq pkg.get_selections \(aqpython\-*\(aq
salt \(aq*\(aq pkg.get_selections state=hold
salt \(aq*\(aq pkg.get_selections \(aqopenssh*\(aq state=hold
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.hold(name=None, pkgs=None, sources=None, **kwargs)
New in version 2014.7.0.

.sp
Set package in \(aqhold\(aq state, meaning it will not be upgraded.
.INDENT 7.0
.TP
.B name
The name of the package, e.g., \(aqtmux\(aq
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.hold <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B pkgs
A list of packages to hold. Must be passed as a python list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.hold pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.info_installed(*names, **kwargs)
Return the information of the named package(s) installed on the system.
.sp
New in version 2015.8.1.

.INDENT 7.0
.TP
.B names
The names of the packages for which to return information.
.TP
.B failhard
Whether to throw an exception if none of the packages are installed.
Defaults to True.
.sp
New in version 2016.11.3.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.info_installed <package1>
salt \(aq*\(aq pkg.info_installed <package1> <package2> <package3> ...
salt \(aq*\(aq pkg.info_installed <package1> failhard=false
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.install(name=None, refresh=False, fromrepo=None, skip_verify=False, debconf=None, pkgs=None, sources=None, reinstall=False, downloadonly=False, ignore_epoch=False, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any apt\-get/dpkg commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Install the passed package, add refresh=True to update the dpkg database.
.INDENT 7.0
.TP
.B name
The name of the package to be installed. Note that this parameter is
ignored if either \(dqpkgs\(dq or \(dqsources\(dq is passed. Additionally, please
note that this option can only be used to install packages from a
software repository. To install a package file manually, use the
\(dqsources\(dq option.
.sp
32\-bit packages can be installed on 64\-bit systems by appending the
architecture designation (\fB:i386\fP, etc.) to the end of the package
name.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B refresh
Whether or not to refresh the package database before installing.
.UNINDENT
.sp
cache_valid_time
.INDENT 7.0
.INDENT 3.5
New in version 2016.11.0.

.sp
Skip refreshing the package database if refresh has already occurred within
<value> seconds
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B fromrepo
Specify a package repository to install from
(e.g., \fBapt\-get \-t unstable install somepackage\fP)
.TP
.B skip_verify
Skip the GPG verification check (e.g., \fB\-\-allow\-unauthenticated\fP, or
\fB\-\-force\-bad\-verify\fP for install from package file).
.TP
.B debconf
Provide the path to a debconf answers file, processed before
installation.
.TP
.B version
Install a specific version of the package, e.g. 1.2.3~0ubuntu0. Ignored
if \(dqpkgs\(dq or \(dqsources\(dq is passed.
.sp
Changed in version 2018.3.0: version can now contain comparison operators (e.g. \fB>1.2.3\fP,
\fB<=2.0\fP, etc.)

.TP
.B reinstall
False
Specifying reinstall=True will use \fBapt\-get install \-\-reinstall\fP
rather than simply \fBapt\-get install\fP for requested packages that are
already installed.
.sp
If a version is specified with the requested package, then \fBapt\-get
install \-\-reinstall\fP will only be used if the installed version
matches the requested version.
.sp
New in version 2015.8.0.

.TP
.B ignore_epoch
False
Only used when the version of a package is specified using a comparison
operator (e.g. \fB>4.1\fP). If set to \fBTrue\fP, then the epoch will be
ignored when comparing the currently\-installed version to the desired
version.
.sp
New in version 2018.3.0.

.UNINDENT
.sp
Multiple Package Installation Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to install from a software repository. Must be
passed as a python list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, {\(dqbar\(dq: \(dq1.2.3\-0ubuntu0\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B sources
A list of DEB packages to install. Must be passed as a list of dicts,
with the keys being package names, and the values being the source URI
or local path to the package.  Dependencies are automatically resolved
and marked as auto\-installed.
.sp
32\-bit packages can be installed on 64\-bit systems by appending the
architecture designation (\fB:i386\fP, etc.) to the end of the package
name.
.sp
Changed in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install sources=\(aq[{\(dqfoo\(dq: \(dqsalt://foo.deb\(dq},{\(dqbar\(dq: \(dqsalt://bar.deb\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B force_yes
Passes \fB\-\-force\-yes\fP to the apt\-get command.  Don\(aqt use this unless
you know what you\(aqre doing.
.sp
New in version 0.17.4.

.TP
.B install_recommends
Whether to install the packages marked as recommended.  Default is True.
.sp
New in version 2015.5.0.

.TP
.B only_upgrade
Only upgrade the packages, if they are already installed. Default is False.
.sp
New in version 2015.5.0.

.TP
.B force_conf_new
Always install the new version of any configuration files.
.sp
New in version 2015.8.0.

.UNINDENT
.sp
Returns a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.latest_version(*names, **kwargs)
Changed in version 3007.0.

.sp
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
A specific repo can be requested using the \fBfromrepo\fP keyword argument.
.sp
cache_valid_time
.INDENT 7.0
.INDENT 3.5
New in version 2016.11.0.

.sp
Skip refreshing the package database if refresh has already occurred within
<value> seconds
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package name> fromrepo=unstable
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.list_downloaded(root=None, **kwargs)
New in version 3000.

.sp
List prefetched packages downloaded by apt in the local disk.
.INDENT 7.0
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_downloaded
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.list_pkgs(versions_as_list=False, removed=False, purge_desired=False, **kwargs)
List the packages currently installed in a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B removed
If \fBTrue\fP, then only packages which have been removed (but not
purged) will be returned.
.TP
.B purge_desired
If \fBTrue\fP, then only packages which have been marked to be purged,
but can\(aqt be purged due to their status as dependencies for other
installed packages, will be returned. Note that these packages will
appear in installed
.sp
Changed in version 2014.1.1: Packages in this state now correctly show up in the output of this
function.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
salt \(aq*\(aq pkg.list_pkgs versions_as_list=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.list_repo_pkgs(*args, **kwargs)
New in version 2017.7.0.

.sp
Returns all available packages. Optionally, package names (and name globs)
can be passed and the results will be filtered to packages matching those
names.
.sp
This function can be helpful in discovering the version or repo to specify
in a \fI\%pkg.installed\fP state.
.sp
The return data will be a dictionary mapping package names to a list of
version numbers, ordered from newest to oldest. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqbash\(aq: [\(aq4.3\-14ubuntu1.1\(aq,
             \(aq4.3\-14ubuntu1\(aq],
    \(aqnginx\(aq: [\(aq1.10.0\-0ubuntu0.16.04.4\(aq,
              \(aq1.9.15\-0ubuntu1\(aq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_repo_pkgs
salt \(aq*\(aq pkg.list_repo_pkgs foo bar baz
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.list_repos(**kwargs)
Lists all repos in the sources.list (and sources.lists.d) files
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_repos
salt \(aq*\(aq pkg.list_repos disabled=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.list_upgrades(refresh=True, dist_upgrade=True, **kwargs)
List all available package upgrades.
.INDENT 7.0
.TP
.B refresh
Whether to refresh the package database before listing upgrades.
Default: True.
.UNINDENT
.sp
cache_valid_time
.INDENT 7.0
.INDENT 3.5
New in version 2016.11.0.

.sp
Skip refreshing the package database if refresh has already occurred within
<value> seconds
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B dist_upgrade
Whether to list the upgrades using dist\-upgrade vs upgrade.  Default is
to use dist\-upgrade.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.mod_repo(repo, saltenv=\(aqbase\(aq, aptkey=True, **kwargs)
Modify one or more values for a repo.  If the repo does not exist, it will
be created, so long as the definition is well formed.  For Ubuntu the
\fBppa:<project>/repo\fP format is acceptable. \fBppa:\fP format can only be
used to create a new repository.
.sp
The following options are available to modify a repo definition:
.INDENT 7.0
.TP
.B architectures
A comma\-separated list of supported architectures, e.g. \fBamd64\fP If
this option is not set, all architectures (configured in the system)
will be used.
.TP
.B comps
A comma separated list of components for the repo, e.g. \fBmain\fP
.TP
.B file
A file name to be used
.TP
.B keyserver
Keyserver to get gpg key from
.TP
.B keyid
Key ID or a list of key IDs to load with the \fBkeyserver\fP argument
.TP
.B key_url
URL to a GPG key to add to the APT GPG keyring
.TP
.B key_text
GPG key in string form to add to the APT GPG keyring
.sp
New in version 2018.3.0.

.TP
.B consolidate
False
If \fBTrue\fP, will attempt to de\-duplicate and consolidate sources
.TP
.B comments
Sometimes you want to supply additional information, but not as
enabled configuration. All comments provided here will be joined
into a single string and appended to the repo configuration with a
comment marker (#) before it.
.sp
New in version 2015.8.9.

.TP
.B refresh
True
Enable or disable (True or False) refreshing of the apt package
database. The previous \fBrefresh_db\fP argument was deprecated in
favor of \fBrefresh\(ga\fP\&. The \fBrefresh_db\fP argument will still
continue to work to ensure backwards compatibility, but please
change to using the preferred \fBrefresh\fP\&.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Due to the way keys are stored for APT, there is a known issue where
the key won\(aqt be updated unless another change is made at the same
time. Keys should be properly added on initial configuration.
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.mod_repo \(aqmyrepo definition\(aq uri=http://new/uri
salt \(aq*\(aq pkg.mod_repo \(aqmyrepo definition\(aq comps=main,universe
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.normalize_name(name)
Strips the architecture from the specified package name, if necessary.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.normalize_name zsh:amd64
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.owner(*paths, **kwargs)
New in version 2014.7.0.

.sp
Return the name of the package that owns the file. Multiple file paths can
be passed. Like \fI\%pkg.version\fP, if a
single path is passed, a string will be returned, and if multiple paths are
passed, a dictionary of file/package name pairs will be returned.
.sp
If the file is not owned by a package, or is not present on the minion,
then an empty string will be returned for that path.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.owner /usr/bin/apachectl
salt \(aq*\(aq pkg.owner /usr/bin/apachectl /usr/bin/basename
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.parse_arch(name)
Parse name and architecture from the specified package name.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.parse_arch zsh:amd64
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.purge(name=None, pkgs=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any apt\-get/dpkg commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Remove packages via \fBapt\-get purge\fP along with all configuration files.
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.purge <package name>
salt \(aq*\(aq pkg.purge <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.purge pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.refresh_db(cache_valid_time=0, failhard=False, **kwargs)
Updates the APT database to latest packages based upon repositories
.sp
Returns a dict, with the keys being package databases and the values being
the result of the update attempt. Values can be one of the following:
.INDENT 7.0
.IP \(bu 2
\fBTrue\fP: Database updated successfully
.IP \(bu 2
\fBFalse\fP: Problem updating database
.IP \(bu 2
\fBNone\fP: Database already up\-to\-date
.UNINDENT
.sp
cache_valid_time
.INDENT 7.0
.INDENT 3.5
New in version 2016.11.0.

.sp
Skip refreshing the package database if refresh has already occurred within
<value> seconds
.UNINDENT
.UNINDENT
.sp
failhard
.INDENT 7.0
.INDENT 3.5
If False, return results of Err lines as \fBFalse\fP for the package database that
encountered the error.
If True, raise an error with a list of the package databases that encountered
errors.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.remove(name=None, pkgs=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any apt\-get/dpkg commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Remove packages using \fBapt\-get remove\fP\&.
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.services_need_restart(**kwargs)
New in version 3003.

.sp
List services that use files which have been changed by the
package manager. It might be needed to restart them.
.sp
Requires checkrestart from the debian\-goodies package.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.services_need_restart
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.set_selections(path=None, selection=None, clear=False, saltenv=\(aqbase\(aq)
Change package state in the dpkg database.
.sp
The state can be any one of, documented in \fBdpkg(1)\fP:
.INDENT 7.0
.IP \(bu 2
install
.IP \(bu 2
hold
.IP \(bu 2
deinstall
.IP \(bu 2
purge
.UNINDENT
.sp
This command is commonly used to mark specific packages to be held from
being upgraded, that is, to be kept at a certain version. When a state is
changed to anything but being held, then it is typically followed by
\fBapt\-get \-u dselect\-upgrade\fP\&.
.sp
Note: Be careful with the \fBclear\fP argument, since it will start
with setting all packages to deinstall state.
.sp
Returns a dict of dicts containing the package names, and the new and old
versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<host>\(aq:
    {\(aq<package>\(aq: {\(aqnew\(aq: \(aq<new\-state>\(aq,
                   \(aqold\(aq: \(aq<old\-state>\(aq}
    },
    ...
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.set_selections selection=\(aq{\(dqinstall\(dq: [\(dqnetcat\(dq]}\(aq
salt \(aq*\(aq pkg.set_selections selection=\(aq{\(dqhold\(dq: [\(dqopenssh\-server\(dq, \(dqopenssh\-client\(dq]}\(aq
salt \(aq*\(aq pkg.set_selections salt://path/to/file
salt \(aq*\(aq pkg.set_selections salt://path/to/file clear=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.show(*names, **kwargs)
New in version 2019.2.0.

.sp
Runs an \fBapt\-cache show\fP on the passed package names, and returns the
results in a nested dictionary. The top level of the return data will be
the package name, with each package name mapping to a dictionary of version
numbers to any additional information returned by \fBapt\-cache show\fP\&.
.INDENT 7.0
.TP
.B filter
An optional comma\-separated list (or quoted Python list) of
case\-insensitive keys on which to filter. This allows one to restrict
the information returned for each package to a smaller selection of
pertinent items.
.TP
.B refresh
False
If \fBTrue\fP, the apt cache will be refreshed first. By default, no
refresh is performed.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pkg.show gawk
salt myminion pkg.show \(aqnginx\-*\(aq
salt myminion pkg.show \(aqnginx\-*\(aq filter=description,provides
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.unhold(name=None, pkgs=None, sources=None, **kwargs)
New in version 2014.7.0.

.sp
Set package current in \(aqhold\(aq state to install state,
meaning it will be upgraded.
.INDENT 7.0
.TP
.B name
The name of the package, e.g., \(aqtmux\(aq
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.unhold <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B pkgs
A list of packages to unhold. Must be passed as a python list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.unhold pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.upgrade(refresh=True, dist_upgrade=False, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any apt\-get/dpkg commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Upgrades all packages via \fBapt\-get upgrade\fP or \fBapt\-get dist\-upgrade\fP
if  \fBdist_upgrade\fP is \fBTrue\fP\&.
.sp
Returns a dictionary containing the changes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq:  {\(aqold\(aq: \(aq<old\-version>\(aq,
                \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B dist_upgrade
Whether to perform the upgrade using dist\-upgrade vs upgrade.  Default
is to use upgrade.
.sp
New in version 2014.7.0.

.TP
.B refresh
True
If \fBTrue\fP, the apt cache will be refreshed first. By default,
this is \fBTrue\fP and a refresh is performed.
.UNINDENT
.sp
cache_valid_time
.INDENT 7.0
.INDENT 3.5
New in version 2016.11.0.

.sp
Skip refreshing the package database if refresh has already occurred within
<value> seconds
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B download_only (or downloadonly)
Only download the packages, don\(aqt unpack or install them. Use
downloadonly to be in line with yum and zypper module.
.sp
New in version 2018.3.0.

.TP
.B force_conf_new
Always install the new version of any configuration files.
.sp
New in version 2015.8.0.

.TP
.B allow_downgrades
Allow apt to downgrade packages without a prompt.
.sp
New in version 3005.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.upgrade_available(name, **kwargs)
Check whether or not an upgrade is available for a given package
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade_available <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aptpkg.version_cmp(pkg1, pkg2, ignore_epoch=False, **kwargs)
Do a cmp\-style comparison on two packages. Return \-1 if pkg1 < pkg2, 0 if
pkg1 == pkg2, and 1 if pkg1 > pkg2. Return None if there was a problem
making the comparison.
.INDENT 7.0
.TP
.B ignore_epoch
False
Set to \fBTrue\fP to ignore the epoch when comparing versions
.sp
New in version 2015.8.10,2016.3.2.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version_cmp \(aq0.2.4\-0ubuntu1\(aq \(aq0.2.4.1\-0ubuntu1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.archive
.sp
A module to wrap (non\-Windows) archive calls
.sp
New in version 2014.1.0.

.INDENT 0.0
.TP
.B salt.modules.archive.cmd_unzip(zip_file, dest, excludes=None, options=None, template=None, runas=None, trim_output=False, password=None)
New in version 2015.5.0: In versions 2014.7.x and earlier, this function was known as
\fBarchive.unzip\fP\&.

.sp
Uses the \fBunzip\fP command to unpack zip files. This command is part of the
\fI\%Info\-ZIP\fP suite of tools, and is typically packaged as simply \fBunzip\fP\&.
.INDENT 7.0
.TP
.B zip_file
Path of zip file to be unpacked
.TP
.B dest
The destination directory into which the file should be unpacked
.TP
.B excludes
None
Comma\-separated list of files not to unpack. Can also be passed in a
Python list.
.TP
.B template
None
Can be set to \(aqjinja\(aq or another supported template engine to render
the command arguments before execution:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.cmd_unzip template=jinja /tmp/zipfile.zip \(aq/tmp/{{grains.id}}\(aq excludes=file_1,file_2
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B options
Optional when using \fBzip\fP archives, ignored when usign other archives
files. This is mostly used to overwrite existing files with \fBo\fP\&.
This options are only used when \fBunzip\fP binary is used.
.sp
New in version 2016.3.1.

.TP
.B runas
None
Unpack the zip file as the specified user. Defaults to the user under
which the minion is running.
.sp
New in version 2015.5.0.

.TP
.B trim_output
False
The number of files we should output on success before the rest are trimmed, if this is
set to True then it will default to 100
.TP
.B password
Password to use with password protected zip files
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is not considered secure. It is recommended to instead use
\fI\%archive.unzip\fP for
password\-protected ZIP files. If a password is used here, then the
unzip command run to extract the ZIP file will not show up in the
minion log like most shell commands Salt runs do. However, the
password will still be present in the events logged to the minion
log at the \fBdebug\fP log level. If the minion is logging at
\fBdebug\fP (or more verbose), then be advised that the password will
appear in the log.
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.cmd_unzip /tmp/zipfile.zip /home/strongbad/ excludes=file_1,file_2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.archive.cmd_zip(zip_file, sources, template=None, cwd=None, runas=None)
New in version 2015.5.0: In versions 2014.7.x and earlier, this function was known as
\fBarchive.zip\fP\&.

.sp
Uses the \fBzip\fP command to create zip files. This command is part of the
\fI\%Info\-ZIP\fP suite of tools, and is typically packaged as simply \fBzip\fP\&.
.INDENT 7.0
.TP
.B zip_file
Path of zip file to be created
.TP
.B sources
Comma\-separated list of sources to include in the zip file. Sources can
also be passed in a Python list.
.sp
Changed in version 2017.7.0: Globbing is now supported for this argument

.TP
.B template
None
Can be set to \(aqjinja\(aq or another supported template engine to render
the command arguments before execution:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.cmd_zip template=jinja /tmp/zipfile.zip /tmp/sourcefile1,/tmp/{{grains.id}}.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B cwd
None
Use this argument along with relative paths in \fBsources\fP to create
zip files which do not contain the leading directories. If not
specified, the zip file will be created as if the cwd was \fB/\fP, and
creating a zip file of \fB/foo/bar/baz.txt\fP will contain the parent
directories \fBfoo\fP and \fBbar\fP\&. To create a zip file containing just
\fBbaz.txt\fP, the following command would be used:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.cmd_zip /tmp/baz.zip baz.txt cwd=/foo/bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2014.7.1.

.TP
.B runas
None
Create the zip file as the specified user. Defaults to the user under
which the minion is running.
.sp
New in version 2015.5.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.cmd_zip /tmp/zipfile.zip /tmp/sourcefile1,/tmp/sourcefile2
# Globbing for sources (2017.7.0 and later)
salt \(aq*\(aq archive.cmd_zip /tmp/zipfile.zip \(aq/tmp/sourcefile*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.archive.gunzip(gzipfile, template=None, runas=None, options=None)
Uses the gunzip command to unpack gzip files
.INDENT 7.0
.TP
.B template
None
Can be set to \(aqjinja\(aq or another supported template engine to render
the command arguments before execution:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.gunzip template=jinja /tmp/{{grains.id}}.txt.gz
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B runas
None
The user with which to run the gzip command line
.TP
.B options
None
Pass any additional arguments to gzip
.sp
New in version 2016.3.4.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Create /tmp/sourcefile.txt
salt \(aq*\(aq archive.gunzip /tmp/sourcefile.txt.gz
salt \(aq*\(aq archive.gunzip /tmp/sourcefile.txt options=\(aq\-\-verbose\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.archive.gzip(sourcefile, template=None, runas=None, options=None)
Uses the gzip command to create gzip files
.INDENT 7.0
.TP
.B template
None
Can be set to \(aqjinja\(aq or another supported template engine to render
the command arguments before execution:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.gzip template=jinja /tmp/{{grains.id}}.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B runas
None
The user with which to run the gzip command line
.TP
.B options
None
Pass any additional arguments to gzip
.sp
New in version 2016.3.4.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Create /tmp/sourcefile.txt.gz
salt \(aq*\(aq archive.gzip /tmp/sourcefile.txt
salt \(aq*\(aq archive.gzip /tmp/sourcefile.txt options=\(aq\-9 \-\-verbose\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.archive.is_encrypted(name, clean=False, saltenv=\(aqbase\(aq, source_hash=None, use_etag=False)
New in version 2016.11.0.

.sp
Changed in version 3005.

.sp
Returns \fBTrue\fP if the zip archive is password\-protected, \fBFalse\fP if
not. If the specified file is not a ZIP archive, an error will be raised.
.INDENT 7.0
.TP
.B name
The path / URL of the archive to check.
.TP
.B clean
False
Set this value to \fBTrue\fP to delete the path referred to by \fBname\fP
once the contents have been listed. This option should be used with
care.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If there is an error listing the archive\(aqs contents, the cached
file will not be removed, to allow for troubleshooting.
.UNINDENT
.UNINDENT
.TP
.B saltenv
base
Specifies the fileserver environment from which to retrieve
\fBarchive\fP\&. This is only applicable when \fBarchive\fP is a file from
the \fBsalt://\fP fileserver.
.TP
.B source_hash
If \fBname\fP is an http(s)/ftp URL and the file exists in the minion\(aqs
file cache, this option can be passed to keep the minion from
re\-downloading the archive if the cached copy matches the specified
hash.
.sp
New in version 2018.3.0.

.TP
.B use_etag
If \fBTrue\fP, remote http/https file sources will attempt to use the
ETag header to determine if the remote file needs to be downloaded.
This provides a lightweight mechanism for promptly refreshing files
changed on a web server without requiring a full hash comparison via
the \fBsource_hash\fP parameter.
.sp
New in version 3005.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.is_encrypted /path/to/myfile.zip
salt \(aq*\(aq archive.is_encrypted salt://foo.zip
salt \(aq*\(aq archive.is_encrypted salt://foo.zip saltenv=dev
salt \(aq*\(aq archive.is_encrypted https://domain.tld/myfile.zip clean=True
salt \(aq*\(aq archive.is_encrypted https://domain.tld/myfile.zip source_hash=f1d2d2f924e986ac86fdf7b36c94bcdf32beec15
salt \(aq*\(aq archive.is_encrypted ftp://10.1.2.3/foo.zip
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.archive.list_(name, archive_format=None, options=None, strip_components=None, clean=False, verbose=False, saltenv=\(aqbase\(aq, source_hash=None, use_etag=False)
New in version 2016.11.0.

.sp
Changed in version 2016.11.2,3005: The \fI\%rarfile\fP Python module is now supported for listing the contents of
rar archives. This is necessary on minions with older releases of the
\fBrar\fP CLI tool, which do not support listing the contents in a
parsable format.

.sp
List the files and directories in an tar, zip, or rar archive.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function will only provide results for XZ\-compressed archives if
the \fI\%xz\fP CLI command is available, as Python does not at this time
natively support XZ compression in its \fI\%tarfile\fP module. Keep in mind
however that most Linux distros ship with \fI\%xz\fP already installed.
.sp
To check if a given minion has \fI\%xz\fP, the following Salt command can be
run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion_id cmd.which xz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If \fBNone\fP is returned, then \fI\%xz\fP is not present and must be installed.
It is widely available and should be packaged as either \fBxz\fP or
\fBxz\-utils\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Path/URL of archive
.TP
.B archive_format
Specify the format of the archive (\fBtar\fP, \fBzip\fP, or \fBrar\fP). If
this argument is omitted, the archive format will be guessed based on
the value of the \fBname\fP parameter.
.TP
.B options
\fBFor tar archives only.\fP This function will, by default, try to use
the \fI\%tarfile\fP module from the Python standard library to get a list of
files/directories. If this method fails, then it will fall back to
using the shell to decompress the archive to stdout and pipe the
results to \fBtar \-tf \-\fP to produce a list of filenames. XZ\-compressed
archives are already supported automatically, but in the event that the
tar archive uses a different sort of compression not supported natively
by \fI\%tarfile\fP, this option can be used to specify a command that will
decompress the archive to stdout. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion_id archive.list /path/to/foo.tar.gz options=\(aqgzip \-\-decompress \-\-stdout\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
It is not necessary to manually specify options for gzip\(aqed
archives, as gzip compression is natively supported by \fI\%tarfile\fP\&.
.UNINDENT
.UNINDENT
.TP
.B strip_components
This argument specifies a number of top\-level directories to strip from
the results. This is similar to the paths that would be extracted if
\fB\-\-strip\-components\fP (or \fB\-\-strip\fP) were used when extracting tar
archives.
.sp
New in version 2016.11.2.

.TP
.B clean
False
Set this value to \fBTrue\fP to delete the path referred to by \fBname\fP
once the contents have been listed. This option should be used with
care.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If there is an error listing the archive\(aqs contents, the cached
file will not be removed, to allow for troubleshooting.
.UNINDENT
.UNINDENT
.TP
.B verbose
False
If \fBFalse\fP, this function will return a list of files/dirs in the
archive. If \fBTrue\fP, it will return a dictionary categorizing the
paths into separate keys containing the directory names, file names,
and also directories/files present in the top level of the archive.
.sp
Changed in version 2016.11.2: This option now includes symlinks in their own list. Before, they
were included with files.

.TP
.B saltenv
base
Specifies the fileserver environment from which to retrieve
\fBarchive\fP\&. This is only applicable when \fBarchive\fP is a file from
the \fBsalt://\fP fileserver.
.TP
.B source_hash
If \fBname\fP is an http(s)/ftp URL and the file exists in the minion\(aqs
file cache, this option can be passed to keep the minion from
re\-downloading the archive if the cached copy matches the specified
hash.
.sp
New in version 2018.3.0.

.TP
.B use_etag
If \fBTrue\fP, remote http/https file sources will attempt to use the
ETag header to determine if the remote file needs to be downloaded.
This provides a lightweight mechanism for promptly refreshing files
changed on a web server without requiring a full hash comparison via
the \fBsource_hash\fP parameter.
.sp
New in version 3005.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.list /path/to/myfile.tar.gz
salt \(aq*\(aq archive.list /path/to/myfile.tar.gz strip_components=1
salt \(aq*\(aq archive.list salt://foo.tar.gz
salt \(aq*\(aq archive.list https://domain.tld/myfile.zip
salt \(aq*\(aq archive.list https://domain.tld/myfile.zip source_hash=f1d2d2f924e986ac86fdf7b36c94bcdf32beec15
salt \(aq*\(aq archive.list ftp://10.1.2.3/foo.rar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.archive.rar(rarfile, sources, template=None, cwd=None, runas=None)
Uses \fI\%rar for Linux\fP to create rar files
.INDENT 7.0
.TP
.B rarfile
Path of rar file to be created
.TP
.B sources
Comma\-separated list of sources to include in the rar file. Sources can
also be passed in a Python list.
.sp
Changed in version 2017.7.0: Globbing is now supported for this argument

.TP
.B cwd
None
Run the rar command from the specified directory. Use this argument
along with relative file paths to create rar files which do not
contain the leading directories. If not specified, this will default
to the home directory of the user under which the salt minion process
is running.
.sp
New in version 2014.7.1.

.TP
.B template
None
Can be set to \(aqjinja\(aq or another supported template engine to render
the command arguments before execution:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.rar template=jinja /tmp/rarfile.rar \(aq/tmp/sourcefile1,/tmp/{{grains.id}}.txt\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.rar /tmp/rarfile.rar /tmp/sourcefile1,/tmp/sourcefile2
# Globbing for sources (2017.7.0 and later)
salt \(aq*\(aq archive.rar /tmp/rarfile.rar \(aq/tmp/sourcefile*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.archive.tar(options, tarfile, sources=None, dest=None, cwd=None, template=None, runas=None)
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function has changed for version 0.17.0. In prior versions, the
\fBcwd\fP and \fBtemplate\fP arguments must be specified, with the source
directories/files coming as a space\-separated list at the end of the
command. Beginning with 0.17.0, \fBsources\fP must be a comma\-separated
list, and the \fBcwd\fP and \fBtemplate\fP arguments are optional.
.UNINDENT
.UNINDENT
.sp
Uses the tar command to pack, unpack, etc. tar files
.INDENT 7.0
.TP
.B options
Options to pass to the tar command
.sp
Changed in version 2015.8.0: The mandatory \fI\-\fP prefixing has been removed.  An options string
beginning with a \fI\-\-long\-option\fP, would have uncharacteristically
needed its first \fI\-\fP removed under the former scheme.
.sp
Also, tar will parse its options differently if short options are
used with or without a preceding \fI\-\fP, so it is better to not
confuse the user into thinking they\(aqre using the non\-\fI\-\fP format,
when really they are using the with\-\fI\-\fP format.

.TP
.B tarfile
The filename of the tar archive to pack/unpack
.TP
.B sources
Comma delimited list of files to \fBpack\fP into the tarfile. Can also be
passed as a Python list.
.sp
Changed in version 2017.7.0: Globbing is now supported for this argument

.TP
.B dest
The destination directory into which to \fBunpack\fP the tarfile
.TP
.B cwd
None
The directory in which the tar command should be executed. If not
specified, will default to the home directory of the user under which
the salt minion process is running.
.TP
.B template
None
Can be set to \(aqjinja\(aq or another supported template engine to render
the command arguments before execution:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.tar cjvf /tmp/salt.tar.bz2 {{grains.saltpath}} template=jinja
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Create a tarfile
salt \(aq*\(aq archive.tar cjvf /tmp/tarfile.tar.bz2 /tmp/file_1,/tmp/file_2
# Create a tarfile using globbing (2017.7.0 and later)
salt \(aq*\(aq archive.tar cjvf /tmp/tarfile.tar.bz2 \(aq/tmp/file_*\(aq
# Unpack a tarfile
salt \(aq*\(aq archive.tar xf foo.tar dest=/target/directory
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.archive.unrar(rarfile, dest, excludes=None, template=None, runas=None, trim_output=False)
Uses \fI\%rar for Linux\fP to unpack rar files
.INDENT 7.0
.TP
.B rarfile
Name of rar file to be unpacked
.TP
.B dest
The destination directory into which to \fBunpack\fP the rar file
.TP
.B template
None
Can be set to \(aqjinja\(aq or another supported template engine to render
the command arguments before execution:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.unrar template=jinja /tmp/rarfile.rar /tmp/{{grains.id}}/ excludes=file_1,file_2
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B trim_output
False
The number of files we should output on success before the rest are trimmed, if this is
set to True then it will default to 100
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.unrar /tmp/rarfile.rar /home/strongbad/ excludes=file_1,file_2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.archive.unzip(zip_file, dest, excludes=None, options=None, template=None, runas=None, trim_output=False, password=None, extract_perms=True)
Uses the \fBzipfile\fP Python module to unpack zip files
.sp
Changed in version 2015.5.0: This function was rewritten to use Python\(aqs native zip file support.
The old functionality has been preserved in the new function
\fI\%archive.cmd_unzip\fP\&. For versions
2014.7.x and earlier, see the \fI\%archive.cmd_zip\fP documentation.

.INDENT 7.0
.TP
.B zip_file
Path of zip file to be unpacked
.TP
.B dest
The destination directory into which the file should be unpacked
.TP
.B excludes
None
Comma\-separated list of files not to unpack. Can also be passed in a
Python list.
.TP
.B options
This options are only used when \fBunzip\fP binary is used. In this
function is ignored.
.sp
New in version 2016.3.1.

.TP
.B template
None
Can be set to \(aqjinja\(aq or another supported template engine to render
the command arguments before execution:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.unzip template=jinja /tmp/zipfile.zip /tmp/{{grains.id}}/ excludes=file_1,file_2
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B runas
None
Unpack the zip file as the specified user. Defaults to the user under
which the minion is running.
.TP
.B trim_output
False
The number of files we should output on success before the rest are trimmed, if this is
set to True then it will default to 100
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.unzip /tmp/zipfile.zip /home/strongbad/ excludes=file_1,file_2
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B password
Password to use with password protected zip files
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The password will be present in the events logged to the minion log
file at the \fBdebug\fP log level. If the minion is logging at
\fBdebug\fP (or more verbose), then be advised that the password will
appear in the log.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.TP
.B extract_perms
True
The Python \fI\%zipfile\fP module does not extract file/directory attributes
by default. When this argument is set to \fBTrue\fP, Salt will attempt to
apply the file permission attributes to the extracted files/folders.
.sp
On Windows, only the read\-only flag will be extracted as set within the
zip file, other attributes (i.e. user/group permissions) are ignored.
.sp
Set this argument to \fBFalse\fP to disable this behavior.
.sp
New in version 2016.11.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.unzip /tmp/zipfile.zip /home/strongbad/ password=\(aqBadPassword\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.archive.zip_(zip_file, sources, template=None, cwd=None, runas=None, zip64=False)
Uses the \fBzipfile\fP Python module to create zip files
.sp
Changed in version 2015.5.0: This function was rewritten to use Python\(aqs native zip file support.
The old functionality has been preserved in the new function
\fI\%archive.cmd_zip\fP\&. For versions
2014.7.x and earlier, see the \fI\%archive.cmd_zip\fP documentation.

.INDENT 7.0
.TP
.B zip_file
Path of zip file to be created
.TP
.B sources
Comma\-separated list of sources to include in the zip file. Sources can
also be passed in a Python list.
.sp
Changed in version 2017.7.0: Globbing is now supported for this argument

.TP
.B template
None
Can be set to \(aqjinja\(aq or another supported template engine to render
the command arguments before execution:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.zip template=jinja /tmp/zipfile.zip /tmp/sourcefile1,/tmp/{{grains.id}}.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B cwd
None
Use this argument along with relative paths in \fBsources\fP to create
zip files which do not contain the leading directories. If not
specified, the zip file will be created as if the cwd was \fB/\fP, and
creating a zip file of \fB/foo/bar/baz.txt\fP will contain the parent
directories \fBfoo\fP and \fBbar\fP\&. To create a zip file containing just
\fBbaz.txt\fP, the following command would be used:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.zip /tmp/baz.zip baz.txt cwd=/foo/bar
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B runas
None
Create the zip file as the specified user. Defaults to the user under
which the minion is running.
.TP
.B zip64
False
Used to enable ZIP64 support, necessary to create archives larger than
4 GByte in size.
If true, will create ZIP file with the ZIPp64 extension when the zipfile
is larger than 2 GB.
ZIP64 extension is disabled by default in the Python native zip support
because the default zip and unzip commands on Unix (the InfoZIP utilities)
don\(aqt support these extensions.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq archive.zip /tmp/zipfile.zip /tmp/sourcefile1,/tmp/sourcefile2
# Globbing for sources (2017.7.0 and later)
salt \(aq*\(aq archive.zip /tmp/zipfile.zip \(aq/tmp/sourcefile*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.arista_pyeapi
.SS Arista pyeapi
.sp
New in version 2019.2.0.

.sp
Execution module to interface the connection with Arista switches, connecting to
the remote network device using the
\fI\%pyeapi\fP library. It is
flexible enough to execute the commands both when running under an Arista Proxy
Minion, as well as running under a Regular Minion by specifying the connection
arguments, i.e., \fBdevice_type\fP, \fBhost\fP, \fBusername\fP, \fBpassword\fP etc.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP>
.TP
.B maturity
new
.TP
.B depends
pyeapi
.TP
.B platform
unix
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To understand how to correctly enable the eAPI on your switch, please check
\fI\%https://eos.arista.com/arista\-eapi\-101/\fP\&.
.UNINDENT
.UNINDENT
.SS Dependencies
.sp
The \fBpyeapi\fP Execution module requires the Python Client for eAPI (pyeapi) to
be installed: \fBpip install pyeapi\fP\&.
.SS Usage
.sp
This module can equally be used via the \fI\%pyeapi\fP
Proxy module or directly from an arbitrary (Proxy) Minion that is running on a
machine having access to the network device API, and the \fBpyeapi\fP library is
installed.
.sp
When running outside of the \fI\%pyeapi Proxy\fP
(i.e., from another Proxy Minion type, or regular Minion), the pyeapi connection
arguments can be either specified from the CLI when executing the command, or
in a configuration block under the \fBpyeapi\fP key in the configuration opts
(i.e., (Proxy) Minion configuration file), or Pillar. The module supports these
simultaneously. These fields are the exact same supported by the \fBpyeapi\fP
Proxy Module:
.INDENT 0.0
.TP
.B transport: \fBhttps\fP
Specifies the type of connection transport to use. Valid values for the
connection are \fBsocket\fP, \fBhttp_local\fP, \fBhttp\fP, and  \fBhttps\fP\&.
.TP
.B host: \fBlocalhost\fP
The IP address or DNS host name of the connection device.
.TP
.B username: \fBadmin\fP
The username to pass to the device to authenticate the eAPI connection.
.TP
.B password
The password to pass to the device to authenticate the eAPI connection.
.TP
.B port
The TCP port of the endpoint for the eAPI connection. If this keyword is
not specified, the default value is automatically determined by the
transport type (\fB80\fP for \fBhttp\fP, or \fB443\fP for \fBhttps\fP).
.TP
.B enablepwd
The enable mode password if required by the destination node.
.UNINDENT
.sp
Example (when not running in a \fBpyeapi\fP Proxy Minion):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pyeapi:
  username: test
  password: test
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In case the \fBusername\fP and \fBpassword\fP are the same on any device you are
targeting, the block above (besides other parameters specific to your
environment you might need) should suffice to be able to execute commands from
outside a \fBpyeapi\fP Proxy, e.g.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyeapi.run_commands \(aqshow version\(aq \(aqshow interfaces\(aq
salt \(aq*\(aq pyeapi.config \(aqntp server 1.2.3.4\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Remember that the above applies only when not running in a \fBpyeapi\fP Proxy
Minion. If you want to use the \fI\%pyeapi Proxy\fP,
please follow the documentation notes for a proper setup.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.arista_pyeapi.call(method, *args, **kwargs)
Invoke an arbitrary pyeapi method.
.INDENT 7.0
.TP
.B method
The name of the pyeapi method to invoke.
.TP
.B args
A list of arguments to send to the method invoked.
.TP
.B kwargs
Key\-value dictionary to send to the method invoked.
.TP
.B transport: \fBhttps\fP
Specifies the type of connection transport to use. Valid values for the
connection are \fBsocket\fP, \fBhttp_local\fP, \fBhttp\fP, and  \fBhttps\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B host: \fBlocalhost\fP
The IP address or DNS host name of the connection device.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B username: \fBadmin\fP
The username to pass to the device to authenticate the eAPI connection.
.INDENT 7.0
.INDENT 3.5
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B password
The password to pass to the device to authenticate the eAPI connection.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B port
The TCP port of the endpoint for the eAPI connection. If this keyword is
not specified, the default value is automatically determined by the
transport type (\fB80\fP for \fBhttp\fP, or \fB443\fP for \fBhttps\fP).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B enablepwd
The enable mode password if required by the destination node.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyeapi.call run_commands \(dq[\(aqshow version\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.arista_pyeapi.config(commands=None, config_file=None, template_engine=\(aqjinja\(aq, context=None, defaults=None, saltenv=\(aqbase\(aq, **kwargs)
Configures the node with the specified commands.
.sp
This method is used to send configuration commands to the node.  It
will take either a string or a list and prepend the necessary commands
to put the session into config mode.
.sp
Returns the diff after the configuration commands are loaded.
.INDENT 7.0
.TP
.B config_file
The source file with the configuration commands to be sent to the
device.
.sp
The file can also be a template that can be rendered using the template
engine of choice.
.sp
This can be specified using the absolute path to the file, or using one
of the following URL schemes:
.INDENT 7.0
.IP \(bu 2
\fBsalt://\fP, to fetch the file from the Salt fileserver.
.IP \(bu 2
\fBhttp://\fP or \fBhttps://\fP
.IP \(bu 2
\fBftp://\fP
.IP \(bu 2
\fBs3://\fP
.IP \(bu 2
\fBswift://\fP
.UNINDENT
.TP
.B commands
The commands to send to the node in config mode.  If the commands
argument is a string it will be cast to a list.
The list of commands will also be prepended with the necessary commands
to put the session in config mode.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument is ignored when \fBconfig_file\fP is specified.
.UNINDENT
.UNINDENT
.TP
.B template_engine: \fBjinja\fP
The template engine to use when rendering the source file. Default:
\fBjinja\fP\&. To simply fetch the file without attempting to render, set
this argument to \fBNone\fP\&.
.TP
.B context
Variables to add to the template context.
.TP
.B defaults
Default values of the \fBcontext\fP dict.
.TP
.B transport: \fBhttps\fP
Specifies the type of connection transport to use. Valid values for the
connection are \fBsocket\fP, \fBhttp_local\fP, \fBhttp\fP, and  \fBhttps\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B host: \fBlocalhost\fP
The IP address or DNS host name of the connection device.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B username: \fBadmin\fP
The username to pass to the device to authenticate the eAPI connection.
.INDENT 7.0
.INDENT 3.5
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B password
The password to pass to the device to authenticate the eAPI connection.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B port
The TCP port of the endpoint for the eAPI connection. If this keyword is
not specified, the default value is automatically determined by the
transport type (\fB80\fP for \fBhttp\fP, or \fB443\fP for \fBhttps\fP).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B enablepwd
The enable mode password if required by the destination node.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyeapi.config commands=\(dq[\(aqntp server 1.2.3.4\(aq, \(aqntp server 5.6.7.8\(aq]\(dq
salt \(aq*\(aq pyeapi.config config_file=salt://config.txt
salt \(aq*\(aq pyeapi.config config_file=https://bit.ly/2LGLcDy context=\(dq{\(aqservers\(aq: [\(aq1.2.3.4\(aq]}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.arista_pyeapi.get_config(config=\(aqrunning\-config\(aq, params=None, as_string=False, **kwargs)
Retrieves the config from the device.
.sp
This method will retrieve the config from the node as either a string
or a list object.  The config to retrieve can be specified as either
the startup\-config or the running\-config.
.INDENT 7.0
.TP
.B config: \fBrunning\-config\fP
Specifies to return either the nodes \fBstartup\-config\fP
or \fBrunning\-config\fP\&.  The default value is the \fBrunning\-config\fP\&.
.TP
.B params
A string of keywords to append to the command for retrieving the config.
.TP
.B as_string: \fBFalse\fP
Flag that determines the response.  If \fBTrue\fP, then the configuration
is returned as a raw string.  If \fBFalse\fP, then the configuration is
returned as a list.  The default value is \fBFalse\fP\&.
.TP
.B transport: \fBhttps\fP
Specifies the type of connection transport to use. Valid values for the
connection are \fBsocket\fP, \fBhttp_local\fP, \fBhttp\fP, and  \fBhttps\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B host: \fBlocalhost\fP
The IP address or DNS host name of the connection device.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B username: \fBadmin\fP
The username to pass to the device to authenticate the eAPI connection.
.INDENT 7.0
.INDENT 3.5
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B password
The password to pass to the device to authenticate the eAPI connection.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B port
The TCP port of the endpoint for the eAPI connection. If this keyword is
not specified, the default value is automatically determined by the
transport type (\fB80\fP for \fBhttp\fP, or \fB443\fP for \fBhttps\fP).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B enablepwd
The enable mode password if required by the destination node.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyeapi.get_config
salt \(aq*\(aq pyeapi.get_config params=\(aqsection snmp\-server\(aq
salt \(aq*\(aq pyeapi.get_config config=\(aqstartup\-config\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.arista_pyeapi.get_connection(**kwargs)
Return the connection object to the pyeapi Node.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This function returns an unserializable object, hence it is not meant
to be used on the CLI. This should mainly be used when invoked from
other modules for the low level connection with the network device.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B kwargs
Key\-value dictionary with the authentication details.
.UNINDENT
.sp
USAGE Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
conn = __salt__[\(aqpyeapi.get_connection\(aq](host=\(aqrouter1.example.com\(aq,
                                         username=\(aqexample\(aq,
                                         password=\(aqexample\(aq)
show_ver = conn.run_commands([\(aqshow version\(aq, \(aqshow interfaces\(aq])
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.arista_pyeapi.run_commands(*commands, **kwargs)
Sends the commands over the transport to the device.
.sp
This function sends the commands to the device using the nodes
transport.  This is a lower layer function that shouldn\(aqt normally
need to be used, preferring instead to use \fBconfig()\fP or \fBenable()\fP\&.
.INDENT 7.0
.TP
.B transport: \fBhttps\fP
Specifies the type of connection transport to use. Valid values for the
connection are \fBsocket\fP, \fBhttp_local\fP, \fBhttp\fP, and  \fBhttps\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B host: \fBlocalhost\fP
The IP address or DNS host name of the connection device.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B username: \fBadmin\fP
The username to pass to the device to authenticate the eAPI connection.
.INDENT 7.0
.INDENT 3.5
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B password
The password to pass to the device to authenticate the eAPI connection.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B port
The TCP port of the endpoint for the eAPI connection. If this keyword is
not specified, the default value is automatically determined by the
transport type (\fB80\fP for \fBhttp\fP, or \fB443\fP for \fBhttps\fP).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B enablepwd
The enable mode password if required by the destination node.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyeapi.run_commands \(aqshow version\(aq
salt \(aq*\(aq pyeapi.run_commands \(aqshow version\(aq encoding=text
salt \(aq*\(aq pyeapi.run_commands \(aqshow version\(aq encoding=text host=cr1.thn.lon username=example password=weak
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
veos1:
    |_
      \-\-\-\-\-\-\-\-\-\-
      architecture:
          i386
      bootupTimestamp:
          1527541728.53
      hardwareRevision:
      internalBuildId:
          63d2e89a\-220d\-4b8a\-a9b3\-0524fa8f9c5f
      internalVersion:
          4.18.1F\-4591672.4181F
      isIntlVersion:
          False
      memFree:
          501468
      memTotal:
          1893316
      modelName:
          vEOS
      serialNumber:
      systemMacAddress:
          52:54:00:3f:e6:d0
      version:
          4.18.1F
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.arista_pyeapi.section(regex, config=\(aqrunning\-config\(aq, **kwargs)
Return a section of the config.
.INDENT 7.0
.TP
.B regex
A valid regular expression used to select sections of configuration to
return.
.TP
.B config: \fBrunning\-config\fP
The configuration to return. Valid values for config are
\fBrunning\-config\fP or \fBstartup\-config\fP\&. The default value is
\fBrunning\-config\fP\&.
.TP
.B transport: \fBhttps\fP
Specifies the type of connection transport to use. Valid values for the
connection are \fBsocket\fP, \fBhttp_local\fP, \fBhttp\fP, and  \fBhttps\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B host: \fBlocalhost\fP
The IP address or DNS host name of the connection device.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B username: \fBadmin\fP
The username to pass to the device to authenticate the eAPI connection.
.INDENT 7.0
.INDENT 3.5
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B password
The password to pass to the device to authenticate the eAPI connection.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B port
The TCP port of the endpoint for the eAPI connection. If this keyword is
not specified, the default value is automatically determined by the
transport type (\fB80\fP for \fBhttp\fP, or \fB443\fP for \fBhttps\fP).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.TP
.B enablepwd
The enable mode password if required by the destination node.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument does not need to be specified when running in a
\fI\%pyeapi\fP Proxy Minion.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.artifactory
.sp
Module for fetching artifacts from Artifactory
.INDENT 0.0
.TP
.B exception  salt.modules.artifactory.ArtifactoryError(value)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.artifactory.get_latest_release(artifactory_url, repository, group_id, artifact_id, packaging, target_dir=\(aq/tmp\(aq, target_file=None, classifier=None, username=None, password=None, use_literal_group_id=False)
Gets the latest release of the artifact
.INDENT 7.0
.TP
.B artifactory_url
URL of artifactory instance
.TP
.B repository
Release repository in artifactory to retrieve artifact from, for example: libs\-releases
.TP
.B group_id
Group Id of the artifact
.TP
.B artifact_id
Artifact Id of the artifact
.TP
.B packaging
Packaging type (jar,war,ear,etc)
.TP
.B target_dir
Target directory to download artifact to (default: /tmp)
.TP
.B target_file
Target file to download artifact to (by default it is target_dir/artifact_id\-version.packaging)
.TP
.B classifier
Artifact classifier name (ex: sources,javadoc,etc). Optional parameter.
.TP
.B username
Artifactory username. Optional parameter.
.TP
.B password
Artifactory password. Optional parameter.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.artifactory.get_latest_snapshot(artifactory_url, repository, group_id, artifact_id, packaging, target_dir=\(aq/tmp\(aq, target_file=None, classifier=None, username=None, password=None, use_literal_group_id=False)
Gets latest snapshot of the given artifact
.INDENT 7.0
.TP
.B artifactory_url
URL of artifactory instance
.TP
.B repository
Snapshot repository in artifactory to retrieve artifact from, for example: libs\-snapshots
.TP
.B group_id
Group Id of the artifact
.TP
.B artifact_id
Artifact Id of the artifact
.TP
.B packaging
Packaging type (jar,war,ear,etc)
.TP
.B target_dir
Target directory to download artifact to (default: /tmp)
.TP
.B target_file
Target file to download artifact to (by default it is target_dir/artifact_id\-snapshot_version.packaging)
.TP
.B classifier
Artifact classifier name (ex: sources,javadoc,etc). Optional parameter.
.TP
.B username
Artifactory username. Optional parameter.
.TP
.B password
Artifactory password. Optional parameter.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.artifactory.get_release(artifactory_url, repository, group_id, artifact_id, packaging, version, target_dir=\(aq/tmp\(aq, target_file=None, classifier=None, username=None, password=None, use_literal_group_id=False)
Gets the specified release of the artifact
.INDENT 7.0
.TP
.B artifactory_url
URL of artifactory instance
.TP
.B repository
Release repository in artifactory to retrieve artifact from, for example: libs\-releases
.TP
.B group_id
Group Id of the artifact
.TP
.B artifact_id
Artifact Id of the artifact
.TP
.B packaging
Packaging type (jar,war,ear,etc)
.TP
.B version
Version of the artifact
.TP
.B target_dir
Target directory to download artifact to (default: /tmp)
.TP
.B target_file
Target file to download artifact to (by default it is target_dir/artifact_id\-version.packaging)
.TP
.B classifier
Artifact classifier name (ex: sources,javadoc,etc). Optional parameter.
.TP
.B username
Artifactory username. Optional parameter.
.TP
.B password
Artifactory password. Optional parameter.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.artifactory.get_snapshot(artifactory_url, repository, group_id, artifact_id, packaging, version, snapshot_version=None, target_dir=\(aq/tmp\(aq, target_file=None, classifier=None, username=None, password=None, use_literal_group_id=False)
Gets snapshot of the desired version of the artifact
.INDENT 7.0
.TP
.B artifactory_url
URL of artifactory instance
.TP
.B repository
Snapshot repository in artifactory to retrieve artifact from, for example: libs\-snapshots
.TP
.B group_id
Group Id of the artifact
.TP
.B artifact_id
Artifact Id of the artifact
.TP
.B packaging
Packaging type (jar,war,ear,etc)
.TP
.B version
Version of the artifact
.TP
.B target_dir
Target directory to download artifact to (default: /tmp)
.TP
.B target_file
Target file to download artifact to (by default it is target_dir/artifact_id\-snapshot_version.packaging)
.TP
.B classifier
Artifact classifier name (ex: sources,javadoc,etc). Optional parameter.
.TP
.B username
Artifactory username. Optional parameter.
.TP
.B password
Artifactory password. Optional parameter.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.artifactory.set_basic_auth(url, username, password)
Sets the username and password for a specific url. Helper method.
.sp
CLI Example:
.UNINDENT
.SS salt.modules.at
.sp
Wrapper module for at(1)
.sp
Also, a \(aqtag\(aq feature has been added to more
easily tag jobs.
.INDENT 0.0
.TP
.B platform
linux,openbsd,freebsd
.UNINDENT
.sp
Changed in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.modules.at.at(*args, **kwargs)
Add a job to the queue.
.sp
The \(aqtimespec\(aq follows the format documented in the
at(1) manpage.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq at.at <timespec> <cmd> [tag=<tag>] [runas=<user>]
salt \(aq*\(aq at.at 12:05am \(aq/sbin/reboot\(aq tag=reboot
salt \(aq*\(aq at.at \(aq3:05am +3 days\(aq \(aqbin/myscript\(aq tag=nightly runas=jim
salt \(aq*\(aq at.at \(aq\(dq22:02\(dq\(aq \(aqbin/myscript\(aq tag=nightly runas=jim
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.at.atc(jobid)
Print the at(1) script that will run for the passed job
id. This is mostly for debugging so the output will
just be text.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq at.atc <jobid>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.at.atq(tag=None)
List all queued and running jobs or only those with
an optional \(aqtag\(aq.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq at.atq
salt \(aq*\(aq at.atq [tag]
salt \(aq*\(aq at.atq [job number]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.at.atrm(*args)
Remove jobs from the queue.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq at.atrm <jobid> <jobid> .. <jobid>
salt \(aq*\(aq at.atrm all
salt \(aq*\(aq at.atrm all [tag]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.at.jobcheck(**kwargs)
Check the job from queue.
The kwargs dict include \(aqhour minute day month year tag runas\(aq
Other parameters will be ignored.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq at.jobcheck runas=jam day=13
salt \(aq*\(aq at.jobcheck day=13 month=12 year=13 tag=rose
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.at_solaris
.sp
Wrapper for at(1) on Solaris\-like systems
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
we try to mirror the generic at module
where possible
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B maintainer
jorge schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B platform
solaris,illumos,smartso
.UNINDENT
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.modules.at_solaris.at(*args, **kwargs)
Add a job to the queue.
.sp
The \(aqtimespec\(aq follows the format documented in the
at(1) manpage.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq at.at <timespec> <cmd> [tag=<tag>] [runas=<user>]
salt \(aq*\(aq at.at 12:05am \(aq/sbin/reboot\(aq tag=reboot
salt \(aq*\(aq at.at \(aq3:05am +3 days\(aq \(aqbin/myscript\(aq tag=nightly runas=jim
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.at_solaris.atc(jobid)
Print the at(1) script that will run for the passed job
id. This is mostly for debugging so the output will
just be text.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq at.atc <jobid>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.at_solaris.atq(tag=None)
List all queued and running jobs or only those with
an optional \(aqtag\(aq.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq at.atq
salt \(aq*\(aq at.atq [tag]
salt \(aq*\(aq at.atq [job number]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.at_solaris.atrm(*args)
Remove jobs from the queue.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq at.atrm <jobid> <jobid> .. <jobid>
salt \(aq*\(aq at.atrm all
salt \(aq*\(aq at.atrm all [tag]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.at_solaris.jobcheck(**kwargs)
Check the job from queue.
The kwargs dict include \(aqhour minute day month year tag runas\(aq
Other parameters will be ignored.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq at.jobcheck runas=jam day=13
salt \(aq*\(aq at.jobcheck day=13 month=12 year=13 tag=rose
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.augeas_cfg
.sp
Manages configuration files via augeas
.sp
This module requires the \fBaugeas\fP Python module.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Minimal installations of Debian and Ubuntu have been seen to have packaging
bugs with python\-augeas, causing the augeas module to fail to import. If
the minion has the augeas module installed, but the functions in this
execution module fail to run due to being unavailable, first restart the
salt\-minion service. If the problem persists past that, the following
command can be run from the master to determine what is causing the import
to fail:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion\-id cmd.run \(aqpython \-c \(dqfrom augeas import Augeas\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For affected Debian/Ubuntu hosts, installing \fBlibpython2.7\fP has been
known to resolve the issue.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.augeas_cfg.execute(context=None, lens=None, commands=(), load_path=None)
Execute Augeas commands
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq augeas.execute /files/etc/redis/redis.conf \e
commands=\(aq[\(dqset bind 0.0.0.0\(dq, \(dqset maxmemory 1G\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B context
The Augeas context
.TP
.B lens
The Augeas lens to use
.TP
.B commands
The Augeas commands to execute
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B load_path
A colon\-spearated list of directories that modules should be searched
in. This is in addition to the standard load path and the directories
in AUGEAS_LENS_LIB.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.augeas_cfg.get(path, value=\(aq\(aq, load_path=None)
Get a value for a specific augeas path
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq augeas.get /files/etc/hosts/1/ ipaddr
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
The path to get the value of
.TP
.B value
The optional value to get
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B load_path
A colon\-spearated list of directories that modules should be searched
in. This is in addition to the standard load path and the directories
in AUGEAS_LENS_LIB.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.augeas_cfg.ls(path, load_path=None)
List the direct children of a node
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq augeas.ls /files/etc/passwd
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
The path to list
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B load_path
A colon\-spearated list of directories that modules should be searched
in. This is in addition to the standard load path and the directories
in AUGEAS_LENS_LIB.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.augeas_cfg.match(path, value=\(aq\(aq, load_path=None)
Get matches for path expression
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq augeas.match /files/etc/services/service\-name ssh
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
The path to match
.TP
.B value
The value to match on
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B load_path
A colon\-spearated list of directories that modules should be searched
in. This is in addition to the standard load path and the directories
in AUGEAS_LENS_LIB.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.augeas_cfg.remove(path, load_path=None)
Get matches for path expression
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq augeas.remove \e
/files/etc/sysctl.conf/net.ipv4.conf.all.log_martians
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
The path to remove
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B load_path
A colon\-spearated list of directories that modules should be searched
in. This is in addition to the standard load path and the directories
in AUGEAS_LENS_LIB.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.augeas_cfg.setvalue(*args)
Set a value for a specific augeas path
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq augeas.setvalue /files/etc/hosts/1/canonical localhost
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will set the first entry in /etc/hosts to localhost
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq augeas.setvalue /files/etc/hosts/01/ipaddr 192.168.1.1 \e
                         /files/etc/hosts/01/canonical test
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Adds a new host to /etc/hosts the ip address 192.168.1.1 and hostname test
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq augeas.setvalue prefix=/files/etc/sudoers/ \e
         \(dqspec[user = \(aq%wheel\(aq]/user\(dq \(dq%wheel\(dq \e
         \(dqspec[user = \(aq%wheel\(aq]/host_group/host\(dq \(aqALL\(aq \e
         \(dqspec[user = \(aq%wheel\(aq]/host_group/command[1]\(dq \(aqALL\(aq \e
         \(dqspec[user = \(aq%wheel\(aq]/host_group/command[1]/tag\(dq \(aqPASSWD\(aq \e
         \(dqspec[user = \(aq%wheel\(aq]/host_group/command[2]\(dq \(aq/usr/bin/apt\-get\(aq \e
         \(dqspec[user = \(aq%wheel\(aq]/host_group/command[2]/tag\(dq NOPASSWD
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Ensures that the following line is present in /etc/sudoers:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
%wheel ALL = PASSWD : ALL , NOPASSWD : /usr/bin/apt\-get , /usr/bin/aptitude
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.augeas_cfg.tree(path, load_path=None)
Returns recursively the complete tree of a node
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq augeas.tree /files/etc/
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
The base of the recursive listing
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B load_path
A colon\-spearated list of directories that modules should be searched
in. This is in addition to the standard load path and the directories
in AUGEAS_LENS_LIB.
.UNINDENT
.UNINDENT
.SS salt.modules.aws_sqs
.sp
Support for the Amazon Simple Queue Service.
.INDENT 0.0
.TP
.B salt.modules.aws_sqs.create_queue(name, region, opts=None, user=None)
Creates a queue with the correct name.
.INDENT 7.0
.TP
.B name
Name of the SQS queue to create
.TP
.B region
Region to create the SQS queue in
.TP
.B opts
None
Any additional options to add to the command line
.TP
.B user
None
Run hg as a user other than what the minion runs as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aws_sqs.create_queue <sqs queue> <region>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aws_sqs.delete_message(queue, region, receipthandle, opts=None, user=None)
Delete one or more messages from a queue in a region
.INDENT 7.0
.TP
.B queue
The name of the queue to delete messages from
.TP
.B region
Region where SQS queues exists
.TP
.B receipthandle
The ReceiptHandle of the message to delete. The ReceiptHandle
is obtained in the return from receive_message
.TP
.B opts
None
Any additional options to add to the command line
.TP
.B user
None
Run as a user other than what the minion runs as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aws_sqs.delete_message <sqs queue> <region> receipthandle=\(aq<sqs ReceiptHandle>\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2014.7.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aws_sqs.delete_queue(name, region, opts=None, user=None)
Deletes a queue in the region.
.INDENT 7.0
.TP
.B name
Name of the SQS queue to deletes
.TP
.B region
Name of the region to delete the queue from
.TP
.B opts
None
Any additional options to add to the command line
.TP
.B user
None
Run hg as a user other than what the minion runs as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aws_sqs.delete_queue <sqs queue> <region>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aws_sqs.list_queues(region, opts=None, user=None)
List the queues in the selected region.
.INDENT 7.0
.TP
.B region
Region to list SQS queues for
.TP
.B opts
None
Any additional options to add to the command line
.TP
.B user
None
Run hg as a user other than what the minion runs as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aws_sqs.list_queues <region>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aws_sqs.queue_exists(name, region, opts=None, user=None)
Returns True or False on whether the queue exists in the region
.INDENT 7.0
.TP
.B name
Name of the SQS queue to search for
.TP
.B region
Name of the region to search for the queue in
.TP
.B opts
None
Any additional options to add to the command line
.TP
.B user
None
Run hg as a user other than what the minion runs as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aws_sqs.queue_exists <sqs queue> <region>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.aws_sqs.receive_message(queue, region, num=1, opts=None, user=None)
Receive one or more messages from a queue in a region
.INDENT 7.0
.TP
.B queue
The name of the queue to receive messages from
.TP
.B region
Region where SQS queues exists
.TP
.B num
1
The max number of messages to receive
.TP
.B opts
None
Any additional options to add to the command line
.TP
.B user
None
Run as a user other than what the minion runs as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq aws_sqs.receive_message <sqs queue> <region>
salt \(aq*\(aq aws_sqs.receive_message <sqs queue> <region> num=10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2014.7.0.

.UNINDENT
.SS salt.modules.bamboohr
.sp
Support for BambooHR
.sp
New in version 2015.8.0.

.sp
Requires a \fBsubdomain\fP and an \fBapikey\fP in \fB/etc/salt/minion\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
bamboohr:
  apikey: 012345678901234567890
  subdomain: mycompany
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bamboohr.list_employees(order_by=\(aqid\(aq)
Show all employees for this company.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion bamboohr.list_employees
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default, the return data will be keyed by ID. However, it can be ordered
by any other field. Keep in mind that if the field that is chosen contains
duplicate values (i.e., location is used, for a company which only has one
location), then each duplicate value will be overwritten by the previous.
Therefore, it is advisable to only sort by fields that are guaranteed to be
unique.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion bamboohr.list_employees order_by=id
salt myminion bamboohr.list_employees order_by=displayName
salt myminion bamboohr.list_employees order_by=workEmail
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bamboohr.list_meta_fields()
Show all meta data fields for this company.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion bamboohr.list_meta_fields
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bamboohr.list_users(order_by=\(aqid\(aq)
Show all users for this company.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion bamboohr.list_users
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default, the return data will be keyed by ID. However, it can be ordered
by any other field. Keep in mind that if the field that is chosen contains
duplicate values (i.e., location is used, for a company which only has one
location), then each duplicate value will be overwritten by the previous.
Therefore, it is advisable to only sort by fields that are guaranteed to be
unique.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion bamboohr.list_users order_by=id
salt myminion bamboohr.list_users order_by=email
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bamboohr.show_employee(emp_id, fields=None)
Show all employees for this company.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion bamboohr.show_employee 1138
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default, the fields normally returned from bamboohr.list_employees are
returned. These fields are:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
canUploadPhoto
.IP \(bu 2
department
.IP \(bu 2
displayName
.IP \(bu 2
firstName
.IP \(bu 2
id
.IP \(bu 2
jobTitle
.IP \(bu 2
lastName
.IP \(bu 2
location
.IP \(bu 2
mobilePhone
.IP \(bu 2
nickname
.IP \(bu 2
photoUploaded
.IP \(bu 2
photoUrl
.IP \(bu 2
workEmail
.IP \(bu 2
workPhone
.IP \(bu 2
workPhoneExtension
.UNINDENT
.UNINDENT
.UNINDENT
.sp
If needed, a different set of fields may be specified, separated by commas:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion bamboohr.show_employee 1138 displayName,dateOfBirth
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A list of available fields can be found at
\fI\%http://www.bamboohr.com/api/documentation/employees.php\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bamboohr.update_employee(emp_id, key=None, value=None, items=None)
Update one or more items for this employee. Specifying an empty value will
clear it for that employee.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion bamboohr.update_employee 1138 nickname Curly
salt myminion bamboohr.update_employee 1138 nickname \(aq\(aq
salt myminion bamboohr.update_employee 1138 items=\(aq{\(dqnickname\(dq: \(dqCurly\(dq}
salt myminion bamboohr.update_employee 1138 items=\(aq{\(dqnickname\(dq: \(dq\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.baredoc
.sp
Baredoc walks the installed module and state directories and generates
dictionaries and lists of the function names and their arguments.
.sp
New in version 3001.

.INDENT 0.0
.TP
.B salt.modules.baredoc.list_modules(name=False, names_only=False)
Walk the Salt install tree for execution modules and return a
dictionary or a list of their functions as well as their arguments.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- specify a specific module to list. If not specified, all modules will be listed.
.IP \(bu 2
\fBnames_only\fP \-\- Return only a list of the callable functions instead of a dictionary with arguments
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion baredoc.list_modules

myminion:
    \-\-\-\-\-\-\-\-\-\-
[...]
  at:
\- atq:
    tag: null
\- atrm:
    args: args
\- at:
    args: args
    kwargs: kwargs
\- atc:
    jobid: null
\- jobcheck:
    kwargs: kwargs
[...]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.baredoc.list_states(name=False, names_only=False)
Walk the Salt install tree for state modules and return a
dictionary or a list of their functions as well as their arguments.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- specify a specific module to list. If not specified, all modules will be listed.
.IP \(bu 2
\fBnames_only\fP \-\- Return only a list of the callable functions instead of a dictionary with arguments
.UNINDENT
.UNINDENT
.sp
CLI Example:
.sp
(example truncated for brevity)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion baredoc.list_states

myminion:
    \-\-\-\-\-\-\-\-\-\-
[...]
  at:
  \- present:
      name: null
      timespec: null
      tag: null
      user: null
      job: null
      unique_tag: false
   \- absent:
      name: null
      jobid: null
      kwargs: kwargs
   \- watch:
      name: null
      timespec: null
      tag: null
      user: null
      job: null
      unique_tag: false
   \- mod_watch:
      name: null
      kwargs: kwargs
[...]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.baredoc.module_docs(*names)
Return the docstrings for all modules. Optionally, specify a module or a
function to narrow the selection.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- specify a specific module to list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion baredoc.module_docs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.baredoc.state_docs(*names)
Return the docstrings for all state modules. Optionally, specify a state module or a
function to narrow the selection.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- specify a specific module to list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion baredoc.state_docs at
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.bcache
.sp
Module for managing BCache sets
.sp
BCache is a block\-level caching mechanism similar to ZFS L2ARC/ZIL, dm\-cache and fscache.
It works by formatting one block device as a cache set, then adding backend devices
(which need to be formatted as such) to the set and activating them.
.sp
It\(aqs available in Linux mainline kernel since 3.10
.sp
\fI\%https://www.kernel.org/doc/Documentation/bcache.txt\fP
.sp
This module needs the bcache userspace tools to function.
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.modules.bcache.attach_(dev=None)
Attach a backing devices to a cache set
If no dev is given, all backing devices will be attached.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bcache.attach sdc
salt \(aq*\(aq bcache.attach /dev/bcache1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
bool or None if nuttin\(aq happened
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bcache.back_make(dev, cache_mode=\(aqwriteback\(aq, force=False, attach=True, bucket_size=None)
Create a backing device for attachment to a set.
Because the block size must be the same, a cache set already needs to exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bcache.back_make sdc cache_mode=writeback attach=True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcache_mode\fP \-\- writethrough, writeback, writearound or none.
.IP \(bu 2
\fBforce\fP \-\- Overwrite existing bcaches
.IP \(bu 2
\fBattach\fP \-\- Immediately attach the backing device to the set
.IP \(bu 2
\fBbucket_size\fP \-\- Size of a bucket (see kernel doc)
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bcache.cache_make(dev, reserved=None, force=False, block_size=None, bucket_size=None, attach=True)
Create BCache cache on a block device.
If blkdiscard is available the entire device will be properly cleared in advance.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bcache.cache_make sdb reserved=10% block_size=4096
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBreserved\fP \-\-
.sp
if dev is a full device, create a partition table with this size empty.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
this increases the amount of reserved space available to SSD garbage collectors,
potentially (vastly) increasing performance
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBblock_size\fP \-\- Block size of the cache; defaults to devices\(aq logical block size
.IP \(bu 2
\fBforce\fP \-\- Overwrite existing BCache sets
.IP \(bu 2
\fBattach\fP \-\- Attach all existing backend devices immediately
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bcache.config_(dev=None, **kwargs)
Show or update config of a bcache device.
.sp
If no device is given, operate on the cache set itself.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bcache.config
salt \(aq*\(aq bcache.config bcache1
salt \(aq*\(aq bcache.config errors=panic journal_delay_ms=150
salt \(aq*\(aq bcache.config bcache1 cache_mode=writeback writeback_percent=15
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
config or True/False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bcache.detach(dev=None)
Detach a backing device(s) from a cache set
If no dev is given, all backing devices will be attached.
.sp
Detaching a backing device will flush its write cache.
This should leave the underlying device in a consistent state, but might take a while.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bcache.detach sdc
salt \(aq*\(aq bcache.detach bcache1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bcache.device(dev, stats=False, config=False, internals=False, superblock=False)
Check the state of a single bcache device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bcache.device bcache0
salt \(aq*\(aq bcache.device /dev/sdc stats=True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstats\fP \-\- include statistics
.IP \(bu 2
\fBsettings\fP \-\- include all settings
.IP \(bu 2
\fBinternals\fP \-\- include all internals
.IP \(bu 2
\fBsuperblock\fP \-\- include superblock info
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bcache.start()
Trigger a start of the full bcache system through udev.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bcache.start
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bcache.status(stats=False, config=False, internals=False, superblock=False, alldevs=False)
Show the full status of the BCache system and optionally all its involved devices
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bcache.status
salt \(aq*\(aq bcache.status stats=True
salt \(aq*\(aq bcache.status internals=True alldevs=True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstats\fP \-\- include statistics
.IP \(bu 2
\fBconfig\fP \-\- include settings
.IP \(bu 2
\fBinternals\fP \-\- include internals
.IP \(bu 2
\fBsuperblock\fP \-\- include superblock
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bcache.stop(dev=None)
Stop a bcache device
If no device is given, all backing devices will be detached from the cache, which will subsequently be stopped.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
\(aqStop\(aq on an individual backing device means hard\-stop;
no attempt at flushing will be done and the bcache device will seemingly \(aqdisappear\(aq from the device lists
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bcache.stop
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bcache.super_(dev)
Read out BCache SuperBlock
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bcache.device bcache0
salt \(aq*\(aq bcache.device /dev/sdc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bcache.uuid(dev=None)
Return the bcache UUID of a block device.
If no device is given, the Cache UUID is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bcache.uuid
salt \(aq*\(aq bcache.uuid /dev/sda
salt \(aq*\(aq bcache.uuid bcache0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.beacons
.sp
Module for managing the Salt beacons on a minion
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B salt.modules.beacons.add(name, beacon_data, **kwargs)
Add a beacon on the minion
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Name of the beacon to configure
.IP \(bu 2
\fBbeacon_data\fP \-\- Dictionary or list containing configuration for beacon.
.UNINDENT
.TP
.B Returns
Boolean and status message on success or failure of add.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq beacons.add ps \(dq[{\(aqprocesses\(aq: {\(aqsalt\-master\(aq: \(aqstopped\(aq, \(aqapache2\(aq: \(aqstopped\(aq}}]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.beacons.delete(name, **kwargs)
Delete a beacon item
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- Name of the beacon to delete
.TP
.B Returns
Boolean and status message on success or failure of delete.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq beacons.delete ps

salt \(aq*\(aq beacons.delete load
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.beacons.disable(**kwargs)
Disable all beacons jobs on the minion
.INDENT 7.0
.TP
.B Returns
Boolean and status message on success or failure of disable.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq beacons.disable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.beacons.disable_beacon(name, **kwargs)
Disable a beacon on the minion
.INDENT 7.0
.TP
.B Name
Name of the beacon to disable.
.TP
.B Returns
Boolean and status message on success or failure of disable.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq beacons.disable_beacon ps
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.beacons.enable(**kwargs)
Enable all beacons on the minion
.INDENT 7.0
.TP
.B Returns
Boolean and status message on success or failure of enable.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq beacons.enable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.beacons.enable_beacon(name, **kwargs)
Enable beacon on the minion
.INDENT 7.0
.TP
.B Name
Name of the beacon to enable.
.TP
.B Returns
Boolean and status message on success or failure of enable.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq beacons.enable_beacon ps
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.beacons.list_(return_yaml=True, include_pillar=True, include_opts=True, **kwargs)
List the beacons currently configured on the minion
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBreturn_yaml\fP \-\- Whether to return YAML formatted output,
default \fBTrue\fP
.IP \(bu 2
\fBinclude_pillar\fP \-\- Whether to include beacons that are
configured in pillar, default is \fBTrue\fP\&.
.IP \(bu 2
\fBinclude_opts\fP \-\- Whether to include beacons that are
configured in opts, default is \fBTrue\fP\&.
.UNINDENT
.TP
.B Returns
List of currently configured Beacons.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq beacons.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.beacons.list_available(return_yaml=True, **kwargs)
List the beacons currently available on the minion
.INDENT 7.0
.TP
.B Parameters
\fBreturn_yaml\fP \-\- Whether to return YAML formatted output, default
\fBTrue\fP
.TP
.B Returns
List of currently configured Beacons.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq beacons.list_available
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.beacons.modify(name, beacon_data, **kwargs)
Modify an existing beacon
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Name of the beacon to configure
.IP \(bu 2
\fBbeacon_data\fP \-\- Dictionary or list containing updated configuration for beacon.
.UNINDENT
.TP
.B Returns
Boolean and status message on success or failure of modify.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq beacons.modify ps \(dq[{\(aqsalt\-master\(aq: \(aqstopped\(aq}, {\(aqapache2\(aq: \(aqstopped\(aq}]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.beacons.reset(**kwargs)
Reset beacon configuration on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq beacons.reset
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.beacons.save(**kwargs)
Save all configured beacons to the minion config
.INDENT 7.0
.TP
.B Returns
Boolean and status message on success or failure of save.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq beacons.save
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.bigip
.INDENT 0.0
.TP
.B An execution module which can manipulate an f5 bigip via iControl REST
.INDENT 7.0
.TP
.B maturity
develop
.TP
.B platform
f5_bigip_11.6
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.add_pool_member(hostname, username, password, name, member)
A function to connect to a bigip device and add a new member to an existing pool.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool to modify
.TP
.B member
The name of the member to add
i.e. 10.1.1.2:80
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.add_pool_members bigip admin admin my\-pool 10.2.2.1:80
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.commit_transaction(hostname, username, password, label)
A function to connect to a bigip device and commit an existing transaction.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B label
the label of this transaction stored within the grain:
\fBbigip_f5_trans:<label>\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.commit_transaction bigip admin admin my_transaction
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.create_monitor(hostname, username, password, monitor_type, name, **kwargs)
A function to connect to a bigip device and create a monitor.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B monitor_type
The type of monitor to create
.TP
.B name
The name of the monitor to create
.TP
.B kwargs
Consult F5 BIGIP user guide for specific options for each monitor type.
Typically, tmsh arg names are used.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.create_monitor bigip admin admin http my\-http\-monitor timeout=10 interval=5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.create_node(hostname, username, password, name, address, trans_label=None)
A function to connect to a bigip device and create a node.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the node
.TP
.B address
The address of the node
.TP
.B trans_label
The label of the transaction stored within the grain:
\fBbigip_f5_trans:<label>\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.create_node bigip admin admin 10.1.1.2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.create_pool(hostname, username, password, name, members=None, allow_nat=None, allow_snat=None, description=None, gateway_failsafe_device=None, ignore_persisted_weight=None, ip_tos_to_client=None, ip_tos_to_server=None, link_qos_to_client=None, link_qos_to_server=None, load_balancing_mode=None, min_active_members=None, min_up_members=None, min_up_members_action=None, min_up_members_checking=None, monitor=None, profiles=None, queue_depth_limit=None, queue_on_connection_limit=None, queue_time_limit=None, reselect_tries=None, service_down_action=None, slow_ramp_time=None)
A function to connect to a bigip device and create a pool.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool to create.
.TP
.B members
List of comma delimited pool members to add to the pool.
i.e. 10.1.1.1:80,10.1.1.2:80,10.1.1.3:80
.TP
.B allow_nat
[yes | no]
.TP
.B allow_snat
[yes | no]
.TP
.B description
[string]
.TP
.B gateway_failsafe_device
[string]
.TP
.B ignore_persisted_weight
[enabled | disabled]
.TP
.B ip_tos_to_client
[pass\-through | [integer]]
.TP
.B ip_tos_to_server
[pass\-through | [integer]]
.TP
.B link_qos_to_client
[pass\-through | [integer]]
.TP
.B link_qos_to_server
[pass\-through | [integer]]
.TP
.B load_balancing_mode
[dynamic\-ratio\-member | dynamic\-ratio\-node |
fastest\-app\-response | fastest\-node |
least\-connections\-members |
least\-connections\-node |
least\-sessions |
observed\-member | observed\-node |
predictive\-member | predictive\-node |
ratio\-least\-connections\-member |
ratio\-least\-connections\-node |
ratio\-member | ratio\-node | ratio\-session |
round\-robin | weighted\-least\-connections\-member |
weighted\-least\-connections\-node]
.TP
.B min_active_members
[integer]
.TP
.B min_up_members
[integer]
.TP
.B min_up_members_action
[failover | reboot | restart\-all]
.TP
.B min_up_members_checking
[enabled | disabled]
.TP
.B monitor
[name]
.TP
.B profiles
[none | profile_name]
.TP
.B queue_depth_limit
[integer]
.TP
.B queue_on_connection_limit
[enabled | disabled]
.TP
.B queue_time_limit
[integer]
.TP
.B reselect_tries
[integer]
.TP
.B service_down_action
[drop | none | reselect | reset]
.TP
.B slow_ramp_time
[integer]
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.create_pool bigip admin admin my\-pool 10.1.1.1:80,10.1.1.2:80,10.1.1.3:80 monitor=http
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.create_profile(hostname, username, password, profile_type, name, **kwargs)
A function to connect to a bigip device and create a profile.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B profile_type
The type of profile to create
.TP
.B name
The name of the profile to create
.TP
.B kwargs
\fB[ arg=val ] ... [arg=key1:val1,key2:val2] ...\fP
.sp
Consult F5 BIGIP user guide for specific options for each monitor type.
Typically, tmsh arg names are used.
.TP
.B Creating Complex Args
Profiles can get pretty complicated in terms of the amount of possible
config options. Use the following shorthand to create complex arguments such
as lists, dictionaries, and lists of dictionaries. An option is also
provided to pass raw json as well.
.INDENT 7.0
.TP
.B lists \fB[i,i,i]\fP:
\fBparam=\(aqitem1,item2,item3\(aq\fP
.TP
.B Dictionary \fB[k:v,k:v,k,v]\fP:
\fBparam=\(aqkey\-1:val\-1,key\-2:val2,key\-3:va\-3\(aq\fP
.TP
.B List of Dictionaries \fB[k:v,k:v|k:v,k:v|k:v,k:v]\fP:
\fBparam=\(aqkey\-1:val\-1,key\-2:val\-2|key\-1:val\-1,key\-2:val\-2|key\-1:val\-1,key\-2:val\-2\(aq\fP
.TP
.B JSON: \fB\(aqj{ ... }j\(aq\fP:
\fBcert\-key\-chain=\(aqj{ \(dqdefault\(dq: { \(dqcert\(dq: \(dqdefault.crt\(dq, \(dqchain\(dq: \(dqdefault.crt\(dq, \(dqkey\(dq: \(dqdefault.key\(dq } }j\(aq\fP
.TP
.B Escaping Delimiters:
Use \fB\e,\fP or \fB\e:\fP or \fB\e|\fP to escape characters which shouldn\(aqt
be treated as delimiters i.e. \fBciphers=\(aqDEFAULT\e:!SSLv3\(aq\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.create_profile bigip admin admin http my\-http\-profile defaultsFrom=\(aq/Common/http\(aq
salt \(aq*\(aq bigip.create_profile bigip admin admin http my\-http\-profile defaultsFrom=\(aq/Common/http\(aq \e
    enforcement=maxHeaderCount:3200,maxRequests:10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.create_virtual(hostname, username, password, name, destination, pool=None, address_status=None, auto_lasthop=None, bwc_policy=None, cmp_enabled=None, connection_limit=None, dhcp_relay=None, description=None, fallback_persistence=None, flow_eviction_policy=None, gtm_score=None, ip_forward=None, ip_protocol=None, internal=None, twelve_forward=None, last_hop_pool=None, mask=None, mirror=None, nat64=None, persist=None, profiles=None, policies=None, rate_class=None, rate_limit=None, rate_limit_mode=None, rate_limit_dst=None, rate_limit_src=None, rules=None, related_rules=None, reject=None, source=None, source_address_translation=None, source_port=None, state=None, traffic_classes=None, translate_address=None, translate_port=None, vlans=None)
A function to connect to a bigip device and create a virtual server.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the virtual to create
.TP
.B destination
[ [virtual_address_name:port] | [ipv4:port] | [ipv6.port] ]
.TP
.B pool
[ [pool_name] | none]
.TP
.B address_status
[yes | no]
.TP
.B auto_lasthop
[default | enabled | disabled ]
.TP
.B bwc_policy
[none] | string]
.TP
.B cmp_enabled
[yes | no]
.TP
.B dhcp_relay
[yes | no]
.TP
.B connection_limit
[integer]
.TP
.B description
[string]
.TP
.B state
[disabled | enabled]
.TP
.B fallback_persistence
[none | [profile name] ]
.TP
.B flow_eviction_policy
[none | [eviction policy name] ]
.TP
.B gtm_score
[integer]
.TP
.B ip_forward
[yes | no]
.TP
.B ip_protocol
[any | protocol]
.TP
.B internal
[yes | no]
.TP
.B twelve_forward
(12\-forward)
[yes | no]
.TP
.B last_hop\-pool
[ [pool_name] | none]
.TP
.B mask
{ [ipv4] | [ipv6] }
.TP
.B mirror
{ [disabled | enabled | none] }
.TP
.B nat64
[enabled | disabled]
.TP
.B persist
[none | profile1,profile2,profile3 ... ]
.TP
.B profiles
[none | default | profile1,profile2,profile3 ... ]
.TP
.B policies
[none | default | policy1,policy2,policy3 ... ]
.TP
.B rate_class
[name]
.TP
.B rate_limit
[integer]
.TP
.B rate_limit_mode
[destination | object | object\-destination |
object\-source | object\-source\-destination |
source | source\-destination]
.TP
.B rate_limit_dst
[integer]
.TP
.B rate_limitçsrc
[integer]
.TP
.B rules
[none | [rule_one,rule_two ...] ]
.TP
.B related_rules
[none | [rule_one,rule_two ...] ]
.TP
.B reject
[yes | no]
.TP
.B source
{ [ipv4[/prefixlen]] | [ipv6[/prefixlen]] }
.TP
.B source_address_translation
[none | snat:pool_name | lsn | automap ]
.TP
.B source_port
[change | preserve | preserve\-strict]
.TP
.B state
[enabled | disabled]
.TP
.B traffic_classes
[none | default | class_one,class_two ... ]
.TP
.B translate_address
[enabled | disabled]
.TP
.B translate_port
[enabled | disabled]
.TP
.B vlans
[none | default | [enabled|disabled]:vlan1,vlan2,vlan3 ... ]
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.create_virtual bigip admin admin my\-virtual\-3 26.2.2.5:80 \e
    pool=my\-http\-pool\-http profiles=http,tcp

salt \(aq*\(aq bigip.create_virtual bigip admin admin my\-virtual\-3 43.2.2.5:80 \e
    pool=test\-http\-pool\-http profiles=http,websecurity persist=cookie,hash \e
    policies=asm_auto_l7_policy__http\-virtual \e
    rules=_sys_APM_ExchangeSupport_helper,_sys_https_redirect \e
    related_rules=_sys_APM_activesync,_sys_APM_ExchangeSupport_helper \e
    source_address_translation=snat:my\-snat\-pool \e
    translate_address=enabled translate_port=enabled \e
    traffic_classes=my\-class,other\-class \e
    vlans=enabled:external,internal
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.delete_monitor(hostname, username, password, monitor_type, name)
A function to connect to a bigip device and delete an existing monitor.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B monitor_type
The type of monitor to delete
.TP
.B name
The name of the monitor to delete
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.delete_monitor bigip admin admin http my\-http\-monitor
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.delete_node(hostname, username, password, name, trans_label=None)
A function to connect to a bigip device and delete a specific node.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the node which will be deleted.
.TP
.B trans_label
The label of the transaction stored within the grain:
\fBbigip_f5_trans:<label>\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.delete_node bigip admin admin my\-node
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.delete_pool(hostname, username, password, name)
A function to connect to a bigip device and delete a specific pool.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool which will be deleted
.UNINDENT
.sp
CLI Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.delete_node bigip admin admin my\-pool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.delete_pool_member(hostname, username, password, name, member)
A function to connect to a bigip device and delete a specific pool.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool to modify
.TP
.B member
The name of the pool member to delete
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.delete_pool_member bigip admin admin my\-pool 10.2.2.2:80
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.delete_profile(hostname, username, password, profile_type, name)
A function to connect to a bigip device and delete an existing profile.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B profile_type
The type of profile to delete
.TP
.B name
The name of the profile to delete
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.delete_profile bigip admin admin http my\-http\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.delete_transaction(hostname, username, password, label)
A function to connect to a bigip device and delete an existing transaction.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B label
The label of this transaction stored within the grain:
\fBbigip_f5_trans:<label>\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.delete_transaction bigip admin admin my_transaction
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.delete_virtual(hostname, username, password, name)
A function to connect to a bigip device and delete a specific virtual.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the virtual to delete
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.delete_virtual bigip admin admin my\-virtual
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.list_monitor(hostname, username, password, monitor_type, name=None)
A function to connect to a bigip device and list an existing monitor.  If no name is provided than all
monitors of the specified type will be listed.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B monitor_type
The type of monitor(s) to list
.TP
.B name
The name of the monitor to list
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.list_monitor bigip admin admin http my\-http\-monitor
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.list_node(hostname, username, password, name=None, trans_label=None)
A function to connect to a bigip device and list all nodes or a specific node.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the node to list. If no name is specified than all nodes
will be listed.
.TP
.B trans_label
The label of the transaction stored within the grain:
\fBbigip_f5_trans:<label>\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.list_node bigip admin admin my\-node
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.list_pool(hostname, username, password, name=None)
A function to connect to a bigip device and list all pools or a specific pool.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool to list. If no name is specified then all pools
will be listed.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.list_pool bigip admin admin my\-pool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.list_profile(hostname, username, password, profile_type, name=None)
A function to connect to a bigip device and list an existing profile.  If no name is provided than all
profiles of the specified type will be listed.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B profile_type
The type of profile(s) to list
.TP
.B name
The name of the profile to list
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.list_profile bigip admin admin http my\-http\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.list_transaction(hostname, username, password, label)
A function to connect to a bigip device and list an existing transaction.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B label
the label of this transaction stored within the grain:
\fBbigip_f5_trans:<label>\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.list_transaction bigip admin admin my_transaction
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.list_virtual(hostname, username, password, name=None)
A function to connect to a bigip device and list all virtuals or a specific virtual.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the virtual to list. If no name is specified than all
virtuals will be listed.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.list_virtual bigip admin admin my\-virtual
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.modify_monitor(hostname, username, password, monitor_type, name, **kwargs)
A function to connect to a bigip device and modify an existing monitor.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B monitor_type
The type of monitor to modify
.TP
.B name
The name of the monitor to modify
.TP
.B kwargs
Consult F5 BIGIP user guide for specific options for each monitor type.
Typically, tmsh arg names are used.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.modify_monitor bigip admin admin http my\-http\-monitor  timout=16 interval=6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.modify_node(hostname, username, password, name, connection_limit=None, description=None, dynamic_ratio=None, logging=None, monitor=None, rate_limit=None, ratio=None, session=None, state=None, trans_label=None)
A function to connect to a bigip device and modify an existing node.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the node to modify
.TP
.B connection_limit
[integer]
.TP
.B description
[string]
.TP
.B dynamic_ratio
[integer]
.TP
.B logging
[enabled | disabled]
.TP
.B monitor
[[name] | none | default]
.TP
.B rate_limit
[integer]
.TP
.B ratio
[integer]
.TP
.B session
[user\-enabled | user\-disabled]
.TP
.B state
[user\-down | user\-up ]
.TP
.B trans_label
The label of the transaction stored within the grain:
\fBbigip_f5_trans:<label>\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.modify_node bigip admin admin 10.1.1.2 ratio=2 logging=enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.modify_pool(hostname, username, password, name, allow_nat=None, allow_snat=None, description=None, gateway_failsafe_device=None, ignore_persisted_weight=None, ip_tos_to_client=None, ip_tos_to_server=None, link_qos_to_client=None, link_qos_to_server=None, load_balancing_mode=None, min_active_members=None, min_up_members=None, min_up_members_action=None, min_up_members_checking=None, monitor=None, profiles=None, queue_depth_limit=None, queue_on_connection_limit=None, queue_time_limit=None, reselect_tries=None, service_down_action=None, slow_ramp_time=None)
A function to connect to a bigip device and modify an existing pool.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool to modify.
.TP
.B allow_nat
[yes | no]
.TP
.B allow_snat
[yes | no]
.TP
.B description
[string]
.TP
.B gateway_failsafe_device
[string]
.TP
.B ignore_persisted_weight
[yes | no]
.TP
.B ip_tos_to_client
[pass\-through | [integer]]
.TP
.B ip_tos_to_server
[pass\-through | [integer]]
.TP
.B link_qos_to_client
[pass\-through | [integer]]
.TP
.B link_qos_to_server
[pass\-through | [integer]]
.TP
.B load_balancing_mode
[dynamic\-ratio\-member | dynamic\-ratio\-node |
fastest\-app\-response | fastest\-node |
least\-connections\-members |
least\-connections\-node |
least\-sessions |
observed\-member | observed\-node |
predictive\-member | predictive\-node |
ratio\-least\-connections\-member |
ratio\-least\-connections\-node |
ratio\-member | ratio\-node | ratio\-session |
round\-robin | weighted\-least\-connections\-member |
weighted\-least\-connections\-node]
.TP
.B min_active_members
[integer]
.TP
.B min_up_members
[integer]
.TP
.B min_up_members_action
[failover | reboot | restart\-all]
.TP
.B min_up_members_checking
[enabled | disabled]
.TP
.B monitor
[name]
.TP
.B profiles
[none | profile_name]
.TP
.B queue_on_connection_limit
[enabled | disabled]
.TP
.B queue_depth_limit
[integer]
.TP
.B queue_time_limit
[integer]
.TP
.B reselect_tries
[integer]
.TP
.B service_down_action
[drop | none | reselect | reset]
.TP
.B slow_ramp_time
[integer]
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.modify_pool bigip admin admin my\-pool 10.1.1.1:80,10.1.1.2:80,10.1.1.3:80 min_active_members=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.modify_pool_member(hostname, username, password, name, member, connection_limit=None, description=None, dynamic_ratio=None, inherit_profile=None, logging=None, monitor=None, priority_group=None, profiles=None, rate_limit=None, ratio=None, session=None, state=None)
A function to connect to a bigip device and modify an existing member of a pool.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool to modify
.TP
.B member
The name of the member to modify i.e. 10.1.1.2:80
.TP
.B connection_limit
[integer]
.TP
.B description
[string]
.TP
.B dynamic_ratio
[integer]
.TP
.B inherit_profile
[enabled | disabled]
.TP
.B logging
[enabled | disabled]
.TP
.B monitor
[name]
.TP
.B priority_group
[integer]
.TP
.B profiles
[none | profile_name]
.TP
.B rate_limit
[integer]
.TP
.B ratio
[integer]
.TP
.B session
[user\-enabled | user\-disabled]
.TP
.B state
[ user\-up | user\-down ]
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.modify_pool_member bigip admin admin my\-pool 10.2.2.1:80 state=use\-down session=user\-disabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.modify_profile(hostname, username, password, profile_type, name, **kwargs)
A function to connect to a bigip device and create a profile.
.sp
A function to connect to a bigip device and create a profile.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B profile_type
The type of profile to create
.TP
.B name
The name of the profile to create
.TP
.B kwargs
\fB[ arg=val ] ... [arg=key1:val1,key2:val2] ...\fP
.sp
Consult F5 BIGIP user guide for specific options for each monitor type.
Typically, tmsh arg names are used.
.UNINDENT
.sp
Creating Complex Args
.INDENT 7.0
.INDENT 3.5
Profiles can get pretty complicated in terms of the amount of possible
config options. Use the following shorthand to create complex arguments such
as lists, dictionaries, and lists of dictionaries. An option is also
provided to pass raw json as well.
.INDENT 0.0
.TP
.B lists \fB[i,i,i]\fP:
\fBparam=\(aqitem1,item2,item3\(aq\fP
.TP
.B Dictionary \fB[k:v,k:v,k,v]\fP:
\fBparam=\(aqkey\-1:val\-1,key\-2:val2,key\-3:va\-3\(aq\fP
.TP
.B List of Dictionaries \fB[k:v,k:v|k:v,k:v|k:v,k:v]\fP:
\fBparam=\(aqkey\-1:val\-1,key\-2:val\-2|key\-1:val\-1,key\-2:val\-2|key\-1:val\-1,key\-2:val\-2\(aq\fP
.TP
.B JSON: \fB\(aqj{ ... }j\(aq\fP:
\fBcert\-key\-chain=\(aqj{ \(dqdefault\(dq: { \(dqcert\(dq: \(dqdefault.crt\(dq, \(dqchain\(dq: \(dqdefault.crt\(dq, \(dqkey\(dq: \(dqdefault.key\(dq } }j\(aq\fP
.TP
.B Escaping Delimiters:
Use \fB\e,\fP or \fB\e:\fP or \fB\e|\fP to escape characters which shouldn\(aqt
be treated as delimiters i.e. \fBciphers=\(aqDEFAULT\e:!SSLv3\(aq\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.modify_profile bigip admin admin http my\-http\-profile defaultsFrom=\(aq/Common/http\(aq

salt \(aq*\(aq bigip.modify_profile bigip admin admin http my\-http\-profile defaultsFrom=\(aq/Common/http\(aq \e
    enforcement=maxHeaderCount:3200,maxRequests:10

salt \(aq*\(aq bigip.modify_profile bigip admin admin client\-ssl my\-client\-ssl\-1 retainCertificate=false \e
    ciphers=\(aqDEFAULT\e:!SSLv3\(aq
    cert_key_chain=\(aqj{ \(dqdefault\(dq: { \(dqcert\(dq: \(dqdefault.crt\(dq, \(dqchain\(dq: \(dqdefault.crt\(dq, \(dqkey\(dq: \(dqdefault.key\(dq } }j\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.modify_virtual(hostname, username, password, name, destination=None, pool=None, address_status=None, auto_lasthop=None, bwc_policy=None, cmp_enabled=None, connection_limit=None, dhcp_relay=None, description=None, fallback_persistence=None, flow_eviction_policy=None, gtm_score=None, ip_forward=None, ip_protocol=None, internal=None, twelve_forward=None, last_hop_pool=None, mask=None, mirror=None, nat64=None, persist=None, profiles=None, policies=None, rate_class=None, rate_limit=None, rate_limit_mode=None, rate_limit_dst=None, rate_limit_src=None, rules=None, related_rules=None, reject=None, source=None, source_address_translation=None, source_port=None, state=None, traffic_classes=None, translate_address=None, translate_port=None, vlans=None)
A function to connect to a bigip device and modify an existing virtual server.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the virtual to modify
.TP
.B destination
[ [virtual_address_name:port] | [ipv4:port] | [ipv6.port] ]
.TP
.B pool
[ [pool_name] | none]
.TP
.B address_status
[yes | no]
.TP
.B auto_lasthop
[default | enabled | disabled ]
.TP
.B bwc_policy
[none] | string]
.TP
.B cmp_enabled
[yes | no]
.TP
.B dhcp_relay
[yes | no}
.TP
.B connection_limit
[integer]
.TP
.B description
[string]
.TP
.B state
[disabled | enabled]
.TP
.B fallback_persistence
[none | [profile name] ]
.TP
.B flow_eviction_policy
[none | [eviction policy name] ]
.TP
.B gtm_score
[integer]
.TP
.B ip_forward
[yes | no]
.TP
.B ip_protocol
[any | protocol]
.TP
.B internal
[yes | no]
.TP
.B twelve_forward
(12\-forward)
[yes | no]
.TP
.B last_hop\-pool
[ [pool_name] | none]
.TP
.B mask
{ [ipv4] | [ipv6] }
.TP
.B mirror
{ [disabled | enabled | none] }
.TP
.B nat64
[enabled | disabled]
.TP
.B persist
[none | profile1,profile2,profile3 ... ]
.TP
.B profiles
[none | default | profile1,profile2,profile3 ... ]
.TP
.B policies
[none | default | policy1,policy2,policy3 ... ]
.TP
.B rate_class
[name]
.TP
.B rate_limit
[integer]
.TP
.B rate_limitr_mode
[destination | object | object\-destination |
object\-source | object\-source\-destination |
source | source\-destination]
.TP
.B rate_limit_dst
[integer]
.TP
.B rate_limit_src
[integer]
.TP
.B rules
[none | [rule_one,rule_two ...] ]
.TP
.B related_rules
[none | [rule_one,rule_two ...] ]
.TP
.B reject
[yes | no]
.TP
.B source
{ [ipv4[/prefixlen]] | [ipv6[/prefixlen]] }
.TP
.B source_address_translation
[none | snat:pool_name | lsn | automap ]
.TP
.B source_port
[change | preserve | preserve\-strict]
.TP
.B state
[enabled | disable]
.TP
.B traffic_classes
[none | default | class_one,class_two ... ]
.TP
.B translate_address
[enabled | disabled]
.TP
.B translate_port
[enabled | disabled]
.TP
.B vlans
[none | default | [enabled|disabled]:vlan1,vlan2,vlan3 ... ]
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.modify_virtual bigip admin admin my\-virtual source_address_translation=none
salt \(aq*\(aq bigip.modify_virtual bigip admin admin my\-virtual rules=my\-rule,my\-other\-rule
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.replace_pool_members(hostname, username, password, name, members)
A function to connect to a bigip device and replace members of an existing pool with new members.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool to modify
.TP
.B members
List of comma delimited pool members to replace existing members with.
i.e. 10.1.1.1:80,10.1.1.2:80,10.1.1.3:80
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.replace_pool_members bigip admin admin my\-pool 10.2.2.1:80,10.2.2.2:80,10.2.2.3:80
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bigip.start_transaction(hostname, username, password, label)
A function to connect to a bigip device and start a new transaction.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B label
The name / alias for this transaction.  The actual transaction
id will be stored within a grain called \fBbigip_f5_trans:<label>\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bigip.start_transaction bigip admin admin my_transaction
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.bluez_bluetooth
.sp
Support for Bluetooth (using BlueZ in Linux).
.sp
The following packages are required packages for this module:
.INDENT 0.0
.INDENT 3.5
bluez >= 5.7
bluez\-libs >= 5.7
bluez\-utils >= 5.7
pybluez >= 0.18
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bluez_bluetooth.address_()
Get the many addresses of the Bluetooth adapter
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bluetooth.address
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bluez_bluetooth.block(bdaddr)
Block a specific bluetooth device by BD Address
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bluetooth.block DE:AD:BE:EF:CA:FE
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bluez_bluetooth.discoverable(dev)
Enable this bluetooth device to be discoverable.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bluetooth.discoverable hci0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bluez_bluetooth.noscan(dev)
Turn off scanning modes on this device.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bluetooth.noscan hci0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bluez_bluetooth.pair(address, key)
Pair the bluetooth adapter with a device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bluetooth.pair DE:AD:BE:EF:CA:FE 1234
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Where DE:AD:BE:EF:CA:FE is the address of the device to pair with, and 1234
is the passphrase.
.sp
TODO: This function is currently broken, as the bluez\-simple\-agent program
no longer ships with BlueZ >= 5.0. It needs to be refactored.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bluez_bluetooth.power(dev, mode)
Power a bluetooth device on or off
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bluetooth.power hci0 on
salt \(aq*\(aq bluetooth.power hci0 off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bluez_bluetooth.scan()
Scan for bluetooth devices in the area
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bluetooth.scan
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bluez_bluetooth.start()
Start the bluetooth service.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bluetooth.start
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bluez_bluetooth.stop()
Stop the bluetooth service.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bluetooth.stop
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bluez_bluetooth.unblock(bdaddr)
Unblock a specific bluetooth device by BD Address
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bluetooth.unblock DE:AD:BE:EF:CA:FE
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bluez_bluetooth.unpair(address)
Unpair the bluetooth adapter from a device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bluetooth.unpair DE:AD:BE:EF:CA:FE
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Where DE:AD:BE:EF:CA:FE is the address of the device to unpair.
.sp
TODO: This function is currently broken, as the bluez\-simple\-agent program
no longer ships with BlueZ >= 5.0. It needs to be refactored.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bluez_bluetooth.version()
Return Bluez version from bluetoothd \-v
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bluetoothd.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto3_elasticache
.SS Execution module for Amazon Elasticache using boto3
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit elasticache credentials but can
also utilize IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
elasticache.keyid: GKTADJGHEIQSXMKKRBJ08H
elasticache.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
elasticache.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.add_tags_to_resource(name, region=None, key=None, keyid=None, profile=None, **args)
Add tags to an Elasticache resource.
.sp
Note that this function is essentially useless as it requires a full AWS ARN for the
resource being operated on, but there is no provided API or programmatic way to find
the ARN for a given object from its name or ID alone.  It requires specific knowledge
about the account number, AWS partition, and other magic details to generate.
.sp
If you happen to have those at hand though, feel free to utilize this function...
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.add_tags_to_resource                 name\(aq=arn:aws:elasticache:us\-west\-2:0123456789:snapshot:mySnapshot\(aq                 Tags=\(dq[{\(aqKey\(aq: \(aqTeamOwner\(aq, \(aqValue\(aq: \(aqinfrastructure\(aq}]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.authorize_cache_security_group_ingress(name, region=None, key=None, keyid=None, profile=None, **args)
Authorize network ingress from an ec2 security group to a cache security group.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.authorize_cache_security_group_ingress                                         mycachesecgrp                                         EC2SecurityGroupName=someEC2sg                                         EC2SecurityGroupOwnerId=SOMEOWNERID
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.cache_cluster_exists(name, conn=None, region=None, key=None, keyid=None, profile=None)
Check to see if a cache cluster exists.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.cache_cluster_exists myelasticache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.cache_security_group_exists(name, region=None, key=None, keyid=None, profile=None)
Check to see if an ElastiCache security group exists.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.cache_security_group_exists mysecuritygroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.cache_subnet_group_exists(name, region=None, key=None, keyid=None, profile=None)
Check to see if an ElastiCache subnet group exists.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.cache_subnet_group_exists my\-subnet\-group
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.copy_snapshot(name, region=None, key=None, keyid=None, profile=None, **args)
Make a copy of an existing snapshot.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.copy_snapshot name=mySnapshot                                                       TargetSnapshotName=copyOfMySnapshot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.create_cache_cluster(name, wait=600, security_groups=None, region=None, key=None, keyid=None, profile=None, **args)
Create a cache cluster.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.create_cache_cluster name=myCacheCluster                                                              Engine=redis                                                              CacheNodeType=cache.t2.micro                                                              NumCacheNodes=1                                                              SecurityGroupIds=\(aq[sg\-11223344]\(aq                                                              CacheSubnetGroupName=myCacheSubnetGroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.create_cache_parameter_group(name, region=None, key=None, keyid=None, profile=None, **args)
Create a cache parameter group.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.create_cache_parameter_group                 name=myParamGroup                 CacheParameterGroupFamily=redis2.8                 Description=\(dqMy Parameter Group\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.create_cache_security_group(name, region=None, key=None, keyid=None, profile=None, **args)
Create a cache security group.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.create_cache_security_group mycachesecgrp Description=\(aqMy Cache Security Group\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.create_cache_subnet_group(name, subnets=None, region=None, key=None, keyid=None, profile=None, **args)
Create an ElastiCache subnet group
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.create_cache_subnet_group name=my\-subnet\-group                                               CacheSubnetGroupDescription=\(dqdescription\(dq                                               subnets=\(aq[myVPCSubnet1,myVPCSubnet2]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.create_replication_group(name, wait=600, security_groups=None, region=None, key=None, keyid=None, profile=None, **args)
Create a replication group.
Params are extensive and variable \- see
\fI\%http://boto3.readthedocs.io/en/latest/reference/services/elasticache.html\fP?#ElastiCache.Client.create_replication_group
for in\-depth usage documentation.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.create_replication_group                                                   name=myelasticache                                                   ReplicationGroupDescription=description
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.delete_cache_cluster(name, wait=600, region=None, key=None, keyid=None, profile=None, **args)
Delete a cache cluster.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.delete myelasticache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.delete_cache_parameter_group(name, region=None, key=None, keyid=None, profile=None, **args)
Delete a cache parameter group.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.delete_cache_parameter_group myParamGroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.delete_cache_security_group(name, region=None, key=None, keyid=None, profile=None, **args)
Delete a cache security group.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.delete_cache_security_group myelasticachesg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.delete_cache_subnet_group(name, region=None, key=None, keyid=None, profile=None, **args)
Delete an ElastiCache subnet group.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.delete_subnet_group my\-subnet\-group region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.delete_replication_group(name, wait=600, region=None, key=None, keyid=None, profile=None, **args)
Delete an ElastiCache replication group, optionally taking a snapshot first.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.delete_replication_group my\-replication\-group
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.describe_cache_clusters(name=None, conn=None, region=None, key=None, keyid=None, profile=None, **args)
Return details about all (or just one) Elasticache cache clusters.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.describe_cache_clusters
salt myminion boto3_elasticache.describe_cache_clusters myelasticache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.describe_cache_parameter_groups(name=None, conn=None, region=None, key=None, keyid=None, profile=None)
Return details about all (or just one) Elasticache cache clusters.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.describe_cache_parameter_groups
salt myminion boto3_elasticache.describe_cache_parameter_groups myParameterGroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.describe_cache_security_groups(name=None, conn=None, region=None, key=None, keyid=None, profile=None)
Return details about all (or just one) Elasticache cache clusters.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.describe_cache_security_groups
salt myminion boto3_elasticache.describe_cache_security_groups mycachesecgrp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.describe_cache_subnet_groups(name=None, conn=None, region=None, key=None, keyid=None, profile=None)
Return details about all (or just one) Elasticache replication groups.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.describe_cache_subnet_groups region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.describe_replication_groups(name=None, conn=None, region=None, key=None, keyid=None, profile=None)
Return details about all (or just one) Elasticache replication groups.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.describe_replication_groups
salt myminion boto3_elasticache.describe_replication_groups myelasticache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.list_cache_subnet_groups(region=None, key=None, keyid=None, profile=None)
Return a list of all cache subnet group names
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.list_cache_subnet_groups region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.list_tags_for_resource(name, region=None, key=None, keyid=None, profile=None, **args)
List tags on an Elasticache resource.
.sp
Note that this function is essentially useless as it requires a full AWS ARN for the
resource being operated on, but there is no provided API or programmatic way to find
the ARN for a given object from its name or ID alone.  It requires specific knowledge
about the account number, AWS partition, and other magic details to generate.
.sp
If you happen to have those handy, feel free to utilize this however...
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.list_tags_for_resource                 name\(aq=arn:aws:elasticache:us\-west\-2:0123456789:snapshot:mySnapshot\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.modify_cache_cluster(name, wait=600, security_groups=None, region=None, key=None, keyid=None, profile=None, **args)
Update a cache cluster in place.
.INDENT 7.0
.TP
.B Notes:  {ApplyImmediately: False} is pretty danged silly in the context of salt.
You can pass it, but for fairly obvious reasons the results over multiple
runs will be undefined and probably contrary to your desired state.
Reducing the number of nodes requires an EXPLICIT CacheNodeIdsToRemove be
passed, which until a reasonable heuristic for programmatically deciding
which nodes to remove has been established, MUST be decided and populated
intentionally before a state call, and removed again before the next.  In
practice this is not particularly useful and should probably be avoided.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.create_cache_cluster name=myCacheCluster                                                              NotificationTopicStatus=inactive
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.modify_cache_subnet_group(name, subnets=None, region=None, key=None, keyid=None, profile=None, **args)
Modify an ElastiCache subnet group
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.modify_cache_subnet_group                                               name=my\-subnet\-group                                               subnets=\(aq[myVPCSubnet3]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.modify_replication_group(name, wait=600, security_groups=None, region=None, key=None, keyid=None, profile=None, **args)
Modify a replication group.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.modify_replication_group                                                   name=myelasticache                                                   ReplicationGroupDescription=newDescription
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.remove_tags_from_resource(name, region=None, key=None, keyid=None, profile=None, **args)
Remove tags from an Elasticache resource.
.sp
Note that this function is essentially useless as it requires a full AWS ARN for the
resource being operated on, but there is no provided API or programmatic way to find
the ARN for a given object from its name or ID alone.  It requires specific knowledge
about the account number, AWS partition, and other magic details to generate.
.sp
If you happen to have those at hand though, feel free to utilize this function...
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.remove_tags_from_resource                 name\(aq=arn:aws:elasticache:us\-west\-2:0123456789:snapshot:mySnapshot\(aq                 TagKeys=\(dq[\(aqTeamOwner\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.replication_group_exists(name, region=None, key=None, keyid=None, profile=None)
Check to see if a replication group exists.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.replication_group_exists myelasticache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticache.revoke_cache_security_group_ingress(name, region=None, key=None, keyid=None, profile=None, **args)
Revoke network ingress from an ec2 security group to a cache security
group.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticache.revoke_cache_security_group_ingress                                         mycachesecgrp                                         EC2SecurityGroupName=someEC2sg                                         EC2SecurityGroupOwnerId=SOMEOWNERID
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto3_elasticsearch
.sp
Connection module for Amazon Elasticsearch Service
.sp
New in version 3001.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit IAM credentials but can also
utilize IAM roles assigned to the instance trough Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
es.keyid: GKTADJGHEIQSXMKKRBJ08H
es.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
es.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B All methods return a dict with:
\(aqresult\(aq key containing a boolean indicating success or failure,
\(aqerror\(aq key containing the errormessage returned by boto on error,
\(aqresponse\(aq key containing the data of the response returned by boto on success.
.UNINDENT
.TP
.B codeauthor
Herbert Buurman <\fI\%herbert.buurman@ogd.nl\fP>
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.add_tags(domain_name=None, arn=None, tags=None, region=None, key=None, keyid=None, profile=None)
Attaches tags to an existing Elasticsearch domain.
Tags are a set of case\-sensitive key value pairs.
An Elasticsearch domain may have up to 10 tags.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdomain_name\fP (\fI\%str\fP) \-\- The name of the Elasticsearch domain you want to add tags to.
.IP \(bu 2
\fBarn\fP (\fI\%str\fP) \-\- The ARN of the Elasticsearch domain you want to add tags to.
Specifying this overrides \fBdomain_name\fP\&.
.IP \(bu 2
\fBtags\fP (\fI\%dict\fP) \-\- The dict of tags to add to the Elasticsearch domain.
.UNINDENT
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticsearch.add_tags domain_name=mydomain tags=\(aq{\(dqfoo\(dq: \(dqbar\(dq, \(dqbaz\(dq: \(dqqux\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.cancel_elasticsearch_service_software_update(domain_name, region=None, keyid=None, key=None, profile=None)
Cancels a scheduled service software update for an Amazon ES domain. You can
only perform this operation before the AutomatedUpdateDate and when the UpdateStatus
is in the PENDING_UPDATE state.
.INDENT 7.0
.TP
.B Parameters
\fBdomain_name\fP (\fI\%str\fP) \-\- The name of the domain that you want to stop the latest
service software update on.
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with the current service software options.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.check_upgrade_eligibility(domain_name, elasticsearch_version, region=None, keyid=None, key=None, profile=None)
Helper function to determine in one call if an Elasticsearch domain can be
upgraded to the specified Elasticsearch version.
.sp
This assumes that the Elasticsearch domain is at rest at the moment this function
is called. I.e. The domain is not in the process of :
.INDENT 7.0
.IP \(bu 2
being created.
.IP \(bu 2
being updated.
.IP \(bu 2
another upgrade running, or a check thereof.
.IP \(bu 2
being deleted.
.UNINDENT
.sp
Behind the scenes, this does 3 things:
.INDENT 7.0
.IP \(bu 2
Check if \fBelasticsearch_version\fP is among the compatible elasticsearch versions.
.IP \(bu 2
Perform a check if the Elasticsearch domain is eligible for the upgrade.
.IP \(bu 2
Check the result of the check and return the result as a boolean.
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The Elasticsearch domain name to check.
.IP \(bu 2
\fBelasticsearch_version\fP (\fI\%str\fP) \-\- The Elasticsearch version to upgrade to.
.UNINDENT
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with boolean result of the check.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticsearch.check_upgrade_eligibility mydomain \(aq6.7\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.create_elasticsearch_domain(domain_name, elasticsearch_version=None, elasticsearch_cluster_config=None, ebs_options=None, access_policies=None, snapshot_options=None, vpc_options=None, cognito_options=None, encryption_at_rest_options=None, node_to_node_encryption_options=None, advanced_options=None, log_publishing_options=None, blocking=False, region=None, key=None, keyid=None, profile=None)
Given a valid config, create a domain.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdomain_name\fP (\fI\%str\fP) \-\- The name of the Elasticsearch domain that you are creating.
Domain names are unique across the domains owned by an account within an
AWS region. Domain names must start with a letter or number and can contain
the following characters: a\-z (lowercase), 0\-9, and \- (hyphen).
.IP \(bu 2
\fBelasticsearch_version\fP (\fI\%str\fP) \-\- String of format X.Y to specify version for
the Elasticsearch domain eg. \(dq1.5\(dq or \(dq2.3\(dq.
.IP \(bu 2
\fBelasticsearch_cluster_config\fP (\fI\%dict\fP) \-\-
.sp
Dictionary specifying the configuration
options for an Elasticsearch domain. Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
InstanceType (str): The instance type for an Elasticsearch cluster.
.IP \(bu 2
InstanceCount (int): The instance type for an Elasticsearch cluster.
.IP \(bu 2
DedicatedMasterEnabled (bool): Indicate whether a dedicated master
node is enabled.
.IP \(bu 2
ZoneAwarenessEnabled (bool): Indicate whether zone awareness is enabled.
If this is not enabled, the Elasticsearch domain will only be in one
availability zone.
.IP \(bu 2
ZoneAwarenessConfig (dict): Specifies the zone awareness configuration
for a domain when zone awareness is enabled.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
AvailabilityZoneCount (int): An integer value to indicate the
number of availability zones for a domain when zone awareness is
enabled. This should be equal to number of subnets if VPC endpoints
is enabled. Allowed values: 2, 3
.UNINDENT
.IP \(bu 2
DedicatedMasterType (str): The instance type for a dedicated master node.
.IP \(bu 2
DedicatedMasterCount (int): Total number of dedicated master nodes,
active and on standby, for the cluster.
.UNINDENT

.IP \(bu 2
\fBebs_options\fP (\fI\%dict\fP) \-\-
.sp
Dict specifying the options to enable or disable and
specifying the type and size of EBS storage volumes.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
EBSEnabled (bool): Specifies whether EBS\-based storage is enabled.
.IP \(bu 2
VolumeType (str): Specifies the volume type for EBS\-based storage.
.IP \(bu 2
VolumeSize (int): Integer to specify the size of an EBS volume.
.IP \(bu 2
Iops (int): Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
.UNINDENT

.IP \(bu 2
\fBaccess_policies\fP (\fI\%str\fP\fI or \fP\fI\%dict\fP) \-\- Dict or JSON string with the IAM access policy.
.IP \(bu 2
\fBsnapshot_options\fP (\fI\%dict\fP) \-\-
.sp
Dict specifying the snapshot options.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
AutomatedSnapshotStartHour (int): Specifies the time, in UTC format,
when the service takes a daily automated snapshot of the specified
Elasticsearch domain. Default value is 0 hours.
.UNINDENT

.IP \(bu 2
\fBvpc_options\fP (\fI\%dict\fP) \-\-
.sp
Dict with the options to specify the subnets and security
groups for the VPC endpoint.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
SubnetIds (list): The list of subnets for the VPC endpoint.
.IP \(bu 2
SecurityGroupIds (list): The list of security groups for the VPC endpoint.
.UNINDENT

.IP \(bu 2
\fBcognito_options\fP (\fI\%dict\fP) \-\-
.sp
Dict with options to specify the cognito user and
identity pools for Kibana authentication.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
Enabled (bool): Specifies the option to enable Cognito for Kibana authentication.
.IP \(bu 2
UserPoolId (str): Specifies the Cognito user pool ID for Kibana authentication.
.IP \(bu 2
IdentityPoolId (str): Specifies the Cognito identity pool ID for Kibana authentication.
.IP \(bu 2
RoleArn (str): Specifies the role ARN that provides Elasticsearch permissions
for accessing Cognito resources.
.UNINDENT

.IP \(bu 2
\fBencryption_at_rest_options\fP (\fI\%dict\fP) \-\-
.sp
Dict specifying the encryption at rest
options. Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
Enabled (bool): Specifies the option to enable Encryption At Rest.
.IP \(bu 2
KmsKeyId (str): Specifies the KMS Key ID for Encryption At Rest options.
.UNINDENT

.IP \(bu 2
\fBnode_to_node_encryption_options\fP (\fI\%dict\fP) \-\-
.sp
Dict specifying the node to node
encryption options. Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
Enabled (bool): Specify True to enable node\-to\-node encryption.
.UNINDENT

.IP \(bu 2
\fBadvanced_options\fP (\fI\%dict\fP) \-\- Dict with option to allow references to indices
in an HTTP request body. Must be False when configuring access to individual
sub\-resources. By default, the value is True.
See \fI\%http://docs.aws.amazon.com/elasticsearch\-service/latest/developerguide\fP        /es\-createupdatedomains.html#es\-createdomain\-configure\-advanced\-options
for more information.
.IP \(bu 2
\fBlog_publishing_options\fP (\fI\%dict\fP) \-\-
.sp
Dict with options for various type of logs.
The keys denote the type of log file and can be one of the following:
.INDENT 2.0
.IP \(bu 2
INDEX_SLOW_LOGS
.IP \(bu 2
SEARCH_SLOW_LOGS
.IP \(bu 2
ES_APPLICATION_LOGS
.UNINDENT
.sp
The value assigned to each key is a dict with the following case sensitive keys:
.INDENT 2.0
.IP \(bu 2
CloudWatchLogsLogGroupArn (str): The ARN of the Cloudwatch log
group to which the log needs to be published.
.IP \(bu 2
Enabled (bool): Specifies whether given log publishing option is enabled or not.
.UNINDENT

.IP \(bu 2
\fBblocking\fP (\fI\%bool\fP) \-\- Whether or not to wait (block) until the Elasticsearch
domain has been created.
.UNINDENT
.UNINDENT
.sp
Note: Not all instance types allow enabling encryption at rest. See \fI\%https://docs.aws.amazon.com\fP        /elasticsearch\-service/latest/developerguide/aes\-supported\-instance\-types.html
.INDENT 7.0
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with the domain status configuration.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticsearch.create_elasticsearch_domain mydomain \e
elasticsearch_cluster_config=\(aq{ \e
  \(dqInstanceType\(dq: \(dqt2.micro.elasticsearch\(dq, \e
  \(dqInstanceCount\(dq: 1, \e
  \(dqDedicatedMasterEnabled\(dq: False, \e
  \(dqZoneAwarenessEnabled\(dq: False}\(aq \e
ebs_options=\(aq{ \e
  \(dqEBSEnabled\(dq: True, \e
  \(dqVolumeType\(dq: \(dqgp2\(dq, \e
  \(dqVolumeSize\(dq: 10, \e
  \(dqIops\(dq: 0}\(aq \e
access_policies=\(aq{ \e
  \(dqVersion\(dq: \(dq2012\-10\-17\(dq, \e
  \(dqStatement\(dq: [ \e
    {\(dqEffect\(dq: \(dqAllow\(dq, \e
     \(dqPrincipal\(dq: {\(dqAWS\(dq: \(dq*\(dq}, \e
     \(dqAction\(dq: \(dqes:*\(dq, \e
     \(dqResource\(dq: \(dqarn:aws:es:us\-east\-1:111111111111:domain/mydomain/*\(dq, \e
     \(dqCondition\(dq: {\(dqIpAddress\(dq: {\(dqaws:SourceIp\(dq: [\(dq127.0.0.1\(dq]}}}]}\(aq \e
snapshot_options=\(aq{\(dqAutomatedSnapshotStartHour\(dq: 0}\(aq \e
advanced_options=\(aq{\(dqrest.action.multi.allow_explicit_index\(dq: \(dqtrue\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.delete_elasticsearch_domain(domain_name, blocking=False, region=None, key=None, keyid=None, profile=None)
Permanently deletes the specified Elasticsearch domain and all of its data.
Once a domain is deleted, it cannot be recovered.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdomain_name\fP (\fI\%str\fP) \-\- The name of the domain to delete.
.IP \(bu 2
\fBblocking\fP (\fI\%bool\fP) \-\- Whether or not to wait (block) until the Elasticsearch
domain has been deleted.
.UNINDENT
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.delete_elasticsearch_service_role(region=None, keyid=None, key=None, profile=None)
Deletes the service\-linked role that Elasticsearch Service uses to manage and
maintain VPC domains. Role deletion will fail if any existing VPC domains use
the role. You must delete any such Elasticsearch domains before deleting the role.
.INDENT 7.0
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.describe_elasticsearch_domain(domain_name, region=None, keyid=None, key=None, profile=None)
Given a domain name gets its status description.
.INDENT 7.0
.TP
.B Parameters
\fBdomain_name\fP (\fI\%str\fP) \-\- The name of the domain to get the status of.
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary ith key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with the domain status information.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.describe_elasticsearch_domain_config(domain_name, region=None, keyid=None, key=None, profile=None)
Provides cluster configuration information about the specified Elasticsearch domain,
such as the state, creation date, update version, and update date for cluster options.
.INDENT 7.0
.TP
.B Parameters
\fBdomain_name\fP (\fI\%str\fP) \-\- The name of the domain to describe.
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with the current configuration information.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.describe_elasticsearch_domains(domain_names, region=None, keyid=None, key=None, profile=None)
Returns domain configuration information about the specified Elasticsearch
domains, including the domain ID, domain endpoint, and domain ARN.
.INDENT 7.0
.TP
.B Parameters
\fBdomain_names\fP (\fI\%list\fP) \-\- List of domain names to get information for.
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with the list of domain status information.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticsearch.describe_elasticsearch_domains \(aq[\(dqdomain_a\(dq, \(dqdomain_b\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.describe_elasticsearch_instance_type_limits(instance_type, elasticsearch_version, domain_name=None, region=None, keyid=None, key=None, profile=None)
Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.
When modifying existing Domain, specify the \(ga\(ga DomainName \(ga\(ga to know what Limits
are supported for modifying.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinstance_type\fP (\fI\%str\fP) \-\- The instance type for an Elasticsearch cluster for
which Elasticsearch \fBLimits\fP are needed.
.IP \(bu 2
\fBelasticsearch_version\fP (\fI\%str\fP) \-\- Version of Elasticsearch for which \fBLimits\fP
are needed.
.IP \(bu 2
\fBdomain_name\fP (\fI\%str\fP) \-\- Represents the name of the Domain that we are trying
to modify. This should be present only if we are querying for Elasticsearch
\fBLimits\fP for existing domain.
.UNINDENT
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with the limits information.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticsearch.describe_elasticsearch_instance_type_limits \e
  instance_type=r3.8xlarge.elasticsearch \e
  elasticsearch_version=\(aq6.2\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.describe_reserved_elasticsearch_instance_offerings(reserved_elasticsearch_instance_offering_id=None, region=None, keyid=None, key=None, profile=None)
Lists available reserved Elasticsearch instance offerings.
.INDENT 7.0
.TP
.B Parameters
\fBreserved_elasticsearch_instance_offering_id\fP (\fI\%str\fP) \-\- The offering identifier
filter value. Use this parameter to show only the available offering that
matches the specified reservation identifier.
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with the list of offerings information.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.describe_reserved_elasticsearch_instances(reserved_elasticsearch_instance_id=None, region=None, keyid=None, key=None, profile=None)
Returns information about reserved Elasticsearch instances for this account.
.INDENT 7.0
.TP
.B Parameters
\fBreserved_elasticsearch_instance_id\fP (\fI\%str\fP) \-\- The reserved instance identifier
filter value. Use this parameter to show only the reservation that matches
the specified reserved Elasticsearch instance ID.
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with a list of information on
reserved instances.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.TP
.B Note
Version 1.9.174 of boto3 has a bug in that reserved_elasticsearch_instance_id
is considered a required argument, even though the documentation says otherwise.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.exists(domain_name, region=None, key=None, keyid=None, profile=None)
Given a domain name, check to see if the given domain exists.
.INDENT 7.0
.TP
.B Parameters
\fBdomain_name\fP (\fI\%str\fP) \-\- The name of the domain to check.
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.get_compatible_elasticsearch_versions(domain_name=None, region=None, keyid=None, key=None, profile=None)
Returns a list of upgrade compatible Elastisearch versions. You can optionally
pass a \fBdomain_name\fP to get all upgrade compatible Elasticsearch versions
for that specific domain.
.INDENT 7.0
.TP
.B Parameters
\fBdomain_name\fP (\fI\%str\fP) \-\- The name of an Elasticsearch domain.
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with a list of compatible versions.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.get_upgrade_history(domain_name, region=None, keyid=None, key=None, profile=None)
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
.INDENT 7.0
.TP
.B Parameters
\fBdomain_name\fP (\fI\%str\fP) \-\- The name of an Elasticsearch domain. Domain names are
unique across the domains owned by an account within an AWS region. Domain
names start with a letter or number and can contain the following characters:
a\-z (lowercase), 0\-9, and \- (hyphen).
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with a list of upgrade histories.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.get_upgrade_status(domain_name, region=None, keyid=None, key=None, profile=None)
Retrieves the latest status of the last upgrade or upgrade eligibility check
that was performed on the domain.
.INDENT 7.0
.TP
.B Parameters
\fBdomain_name\fP (\fI\%str\fP) \-\- The name of an Elasticsearch domain. Domain names are
unique across the domains owned by an account within an AWS region. Domain
names start with a letter or number and can contain the following characters:
a\-z (lowercase), 0\-9, and \- (hyphen).
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with upgrade status information.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.list_domain_names(region=None, keyid=None, key=None, profile=None)
Returns the name of all Elasticsearch domains owned by the current user\(aqs account.
.INDENT 7.0
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with a list of domain names.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.list_elasticsearch_instance_types(elasticsearch_version, domain_name=None, region=None, keyid=None, key=None, profile=None)
List all Elasticsearch instance types that are supported for given ElasticsearchVersion.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBelasticsearch_version\fP (\fI\%str\fP) \-\- Version of Elasticsearch for which list of
supported elasticsearch instance types are needed.
.IP \(bu 2
\fBdomain_name\fP (\fI\%str\fP) \-\- DomainName represents the name of the Domain that we
are trying to modify. This should be present only if we are querying for
list of available Elasticsearch instance types when modifying existing domain.
.UNINDENT
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with a list of Elasticsearch instance types.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.list_elasticsearch_versions(region=None, keyid=None, key=None, profile=None)
List all supported Elasticsearch versions.
.INDENT 7.0
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with a list of Elasticsearch versions.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.list_tags(domain_name=None, arn=None, region=None, key=None, keyid=None, profile=None)
Returns all tags for the given Elasticsearch domain.
.INDENT 7.0
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with a dict of tags.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.purchase_reserved_elasticsearch_instance_offering(reserved_elasticsearch_instance_offering_id, reservation_name, instance_count=None, region=None, keyid=None, key=None, profile=None)
Allows you to purchase reserved Elasticsearch instances.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBreserved_elasticsearch_instance_offering_id\fP (\fI\%str\fP) \-\- The ID of the reserved
Elasticsearch instance offering to purchase.
.IP \(bu 2
\fBreservation_name\fP (\fI\%str\fP) \-\- A customer\-specified identifier to track this reservation.
.IP \(bu 2
\fBinstance_count\fP (\fI\%int\fP) \-\- The number of Elasticsearch instances to reserve.
.UNINDENT
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with purchase information.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.remove_tags(tag_keys, domain_name=None, arn=None, region=None, key=None, keyid=None, profile=None)
Removes the specified set of tags from the specified Elasticsearch domain.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtag_keys\fP (\fI\%list\fP) \-\- List with tag keys you want to remove from the Elasticsearch domain.
.IP \(bu 2
\fBdomain_name\fP (\fI\%str\fP) \-\- The name of the Elasticsearch domain you want to remove tags from.
.IP \(bu 2
\fBarn\fP (\fI\%str\fP) \-\- The ARN of the Elasticsearch domain you want to remove tags from.
Specifying this overrides \fBdomain_name\fP\&.
.UNINDENT
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticsearch.remove_tags \(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq domain_name=my_domain
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.start_elasticsearch_service_software_update(domain_name, region=None, keyid=None, key=None, profile=None)
Schedules a service software update for an Amazon ES domain.
.INDENT 7.0
.TP
.B Parameters
\fBdomain_name\fP (\fI\%str\fP) \-\- The name of the domain that you want to update to the
latest service software.
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with service software information.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.update_elasticsearch_domain_config(domain_name, elasticsearch_cluster_config=None, ebs_options=None, vpc_options=None, access_policies=None, snapshot_options=None, cognito_options=None, advanced_options=None, log_publishing_options=None, blocking=False, region=None, key=None, keyid=None, profile=None)
Modifies the cluster configuration of the specified Elasticsearch domain,
for example setting the instance type and the number of instances.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdomain_name\fP (\fI\%str\fP) \-\- The name of the Elasticsearch domain that you are creating.
Domain names are unique across the domains owned by an account within an
AWS region. Domain names must start with a letter or number and can contain
the following characters: a\-z (lowercase), 0\-9, and \- (hyphen).
.IP \(bu 2
\fBelasticsearch_cluster_config\fP (\fI\%dict\fP) \-\-
.sp
Dictionary specifying the configuration
options for an Elasticsearch domain. Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
InstanceType (str): The instance type for an Elasticsearch cluster.
.IP \(bu 2
InstanceCount (int): The instance type for an Elasticsearch cluster.
.IP \(bu 2
DedicatedMasterEnabled (bool): Indicate whether a dedicated master
node is enabled.
.IP \(bu 2
ZoneAwarenessEnabled (bool): Indicate whether zone awareness is enabled.
.IP \(bu 2
ZoneAwarenessConfig (dict): Specifies the zone awareness configuration
for a domain when zone awareness is enabled.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
AvailabilityZoneCount (int): An integer value to indicate the
number of availability zones for a domain when zone awareness is
enabled. This should be equal to number of subnets if VPC endpoints
is enabled.
.UNINDENT
.IP \(bu 2
DedicatedMasterType (str): The instance type for a dedicated master node.
.IP \(bu 2
DedicatedMasterCount (int): Total number of dedicated master nodes,
active and on standby, for the cluster.
.UNINDENT

.IP \(bu 2
\fBebs_options\fP (\fI\%dict\fP) \-\-
.sp
Dict specifying the options to enable or disable and
specifying the type and size of EBS storage volumes.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
EBSEnabled (bool): Specifies whether EBS\-based storage is enabled.
.IP \(bu 2
VolumeType (str): Specifies the volume type for EBS\-based storage.
.IP \(bu 2
VolumeSize (int): Integer to specify the size of an EBS volume.
.IP \(bu 2
Iops (int): Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
.UNINDENT

.IP \(bu 2
\fBsnapshot_options\fP (\fI\%dict\fP) \-\-
.sp
Dict specifying the snapshot options.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
AutomatedSnapshotStartHour (int): Specifies the time, in UTC format,
when the service takes a daily automated snapshot of the specified
Elasticsearch domain. Default value is 0 hours.
.UNINDENT

.IP \(bu 2
\fBvpc_options\fP (\fI\%dict\fP) \-\-
.sp
Dict with the options to specify the subnets and security
groups for the VPC endpoint.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
SubnetIds (list): The list of subnets for the VPC endpoint.
.IP \(bu 2
SecurityGroupIds (list): The list of security groups for the VPC endpoint.
.UNINDENT

.IP \(bu 2
\fBcognito_options\fP (\fI\%dict\fP) \-\-
.sp
Dict with options to specify the cognito user and
identity pools for Kibana authentication.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
Enabled (bool): Specifies the option to enable Cognito for Kibana authentication.
.IP \(bu 2
UserPoolId (str): Specifies the Cognito user pool ID for Kibana authentication.
.IP \(bu 2
IdentityPoolId (str): Specifies the Cognito identity pool ID for Kibana authentication.
.IP \(bu 2
RoleArn (str): Specifies the role ARN that provides Elasticsearch permissions
for accessing Cognito resources.
.UNINDENT

.IP \(bu 2
\fBadvanced_options\fP (\fI\%dict\fP) \-\- Dict with option to allow references to indices
in an HTTP request body. Must be False when configuring access to individual
sub\-resources. By default, the value is True.
See \fI\%http://docs.aws.amazon.com/elasticsearch\-service/latest/developerguide\fP        /es\-createupdatedomains.html#es\-createdomain\-configure\-advanced\-options
for more information.
.IP \(bu 2
\fBaccess_policies\fP (\fIstr/dict\fP) \-\- Dict or JSON string with the IAM access policy.
.IP \(bu 2
\fBlog_publishing_options\fP (\fI\%dict\fP) \-\-
.sp
Dict with options for various type of logs.
The keys denote the type of log file and can be one of the following:
.INDENT 2.0
.INDENT 3.5
INDEX_SLOW_LOGS, SEARCH_SLOW_LOGS, ES_APPLICATION_LOGS.
.UNINDENT
.UNINDENT
.sp
The value assigned to each key is a dict with the following case sensitive keys:
.INDENT 2.0
.IP \(bu 2
CloudWatchLogsLogGroupArn (str): The ARN of the Cloudwatch log
group to which the log needs to be published.
.IP \(bu 2
Enabled (bool): Specifies whether given log publishing option
is enabled or not.
.UNINDENT

.IP \(bu 2
\fBblocking\fP (\fI\%bool\fP) \-\- Whether or not to wait (block) until the Elasticsearch
domain has been updated.
.UNINDENT
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with the domain configuration.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticsearch.update_elasticsearch_domain_config mydomain \e
  elasticsearch_cluster_config=\(aq{\e
    \(dqInstanceType\(dq: \(dqt2.micro.elasticsearch\(dq, \e
    \(dqInstanceCount\(dq: 1, \e
    \(dqDedicatedMasterEnabled\(dq: false,
    \(dqZoneAwarenessEnabled\(dq: false}\(aq \e
  ebs_options=\(aq{\e
    \(dqEBSEnabled\(dq: true, \e
    \(dqVolumeType\(dq: \(dqgp2\(dq, \e
    \(dqVolumeSize\(dq: 10, \e
    \(dqIops\(dq: 0}\(aq \e
  access_policies=\(aq{\(dqVersion\(dq: \(dq2012\-10\-17\(dq, \(dqStatement\(dq: [{\e
    \(dqEffect\(dq: \(dqAllow\(dq, \(dqPrincipal\(dq: {\(dqAWS\(dq: \(dq*\(dq}, \(dqAction\(dq: \(dqes:*\(dq, \e
    \(dqResource\(dq: \(dqarn:aws:es:us\-east\-1:111111111111:domain/mydomain/*\(dq, \e
    \(dqCondition\(dq: {\(dqIpAddress\(dq: {\(dqaws:SourceIp\(dq: [\(dq127.0.0.1\(dq]}}}]}\(aq \e
  snapshot_options=\(aq{\(dqAutomatedSnapshotStartHour\(dq: 0}\(aq \e
  advanced_options=\(aq{\(dqrest.action.multi.allow_explicit_index\(dq: \(dqtrue\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.upgrade_elasticsearch_domain(domain_name, target_version, perform_check_only=None, blocking=False, region=None, keyid=None, key=None, profile=None)
Allows you to either upgrade your domain or perform an Upgrade eligibility
check to a compatible Elasticsearch version.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdomain_name\fP (\fI\%str\fP) \-\- The name of an Elasticsearch domain. Domain names are
unique across the domains owned by an account within an AWS region. Domain
names start with a letter or number and can contain the following characters:
a\-z (lowercase), 0\-9, and \- (hyphen).
.IP \(bu 2
\fBtarget_version\fP (\fI\%str\fP) \-\- The version of Elasticsearch that you intend to
upgrade the domain to.
.IP \(bu 2
\fBperform_check_only\fP (\fI\%bool\fP) \-\- This flag, when set to True, indicates that
an Upgrade Eligibility Check needs to be performed. This will not actually
perform the Upgrade.
.IP \(bu 2
\fBblocking\fP (\fI\%bool\fP) \-\- Whether or not to wait (block) until the Elasticsearch
domain has been upgraded.
.UNINDENT
.TP
.B Return type
\fI\%dict\fP
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon success, also contains a key \(aqreponse\(aq with the domain configuration.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_elasticsearch.upgrade_elasticsearch_domain mydomain \e
target_version=\(aq6.7\(aq \e
perform_check_only=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_elasticsearch.wait_for_upgrade(domain_name, region=None, keyid=None, key=None, profile=None)
Block until an upgrade\-in\-progress for domain \fBname\fP is finished.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the domain to wait for.
.TP
.B Rtype dict
.TP
.B Returns
Dictionary with key \(aqresult\(aq and as value a boolean denoting success or failure.
Upon failure, also contains a key \(aqerror\(aq with the error message as value.
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.SS salt.modules.boto3_route53
.sp
Execution module for Amazon Route53 written against Boto 3
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit route53 credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
route53.keyid: GKTADJGHEIQSXMKKRBJ08H
route53.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
route53.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
  region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that Route53 essentially ignores all (valid) settings for \(aqregion\(aq,
since there is only one Endpoint (in us\-east\-1 if you care) and any (valid)
region setting will just send you there.  It is entirely safe to set it to
None as well.
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_route53.associate_vpc_with_hosted_zone(HostedZoneId=None, Name=None, VPCId=None, VPCName=None, VPCRegion=None, Comment=None, region=None, key=None, keyid=None, profile=None)
Associates an Amazon VPC with a private hosted zone.
.sp
To perform the association, the VPC and the private hosted zone must already exist. You can\(aqt
convert a public hosted zone into a private hosted zone.  If you want to associate a VPC from
one AWS account with a zone from a another, the AWS account owning the hosted zone must first
submit a CreateVPCAssociationAuthorization (using create_vpc_association_authorization() or by
other means, such as the AWS console).  With that done, the account owning the VPC can then call
associate_vpc_with_hosted_zone() to create the association.
.sp
Note that if both sides happen to be within the same account, associate_vpc_with_hosted_zone()
is enough on its own, and there is no need for the CreateVPCAssociationAuthorization step.
.sp
Also note that looking up hosted zones by name (e.g. using the Name parameter) only works
within a single account \- if you\(aqre associating a VPC to a zone in a different account, as
outlined above, you unfortunately MUST use the HostedZoneId parameter exclusively.
.INDENT 7.0
.TP
.B HostedZoneId
The unique Zone Identifier for the Hosted Zone.
.TP
.B Name
The domain name associated with the Hosted Zone(s).
.TP
.B VPCId
When working with a private hosted zone, either the VPC ID or VPC Name to associate with is
required.  Exclusive with VPCName.
.TP
.B VPCName
When working with a private hosted zone, either the VPC ID or VPC Name to associate with is
required.  Exclusive with VPCId.
.TP
.B VPCRegion
When working with a private hosted zone, the region of the associated VPC is required.  If
not provided, an effort will be made to determine it from VPCId or VPCName, if possible.  If
this fails, you\(aqll need to provide an explicit value for VPCRegion.
.TP
.B Comment
Any comments you want to include about the change being made.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_route53.associate_vpc_with_hosted_zone                     Name=example.org. VPCName=myVPC                     VPCRegion=us\-east\-1 Comment=\(dqWhoo\-hoo!  I added another VPC.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_route53.change_resource_record_sets(HostedZoneId=None, Name=None, PrivateZone=None, ChangeBatch=None, region=None, key=None, keyid=None, profile=None)
See the \fI\%AWS Route53 API docs\fP as well as the \fI\%Boto3 documentation\fP for all the details...
.sp
The syntax for a ChangeBatch parameter is as follows, but note that the permutations of allowed
parameters and combinations thereof are quite varied, so perusal of the above linked docs is
highly recommended for any non\-trival configurations.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqComment\(dq: \(dqstring\(dq,
    \(dqChanges\(dq: [
        {
            \(dqAction\(dq: \(dqCREATE\(dq|\(dqDELETE\(dq|\(dqUPSERT\(dq,
            \(dqResourceRecordSet\(dq: {
                \(dqName\(dq: \(dqstring\(dq,
                \(dqType\(dq: \(dqSOA\(dq|\(dqA\(dq|\(dqTXT\(dq|\(dqNS\(dq|\(dqCNAME\(dq|\(dqMX\(dq|\(dqNAPTR\(dq|\(dqPTR\(dq|\(dqSRV\(dq|\(dqSPF\(dq|\(dqAAAA\(dq,
                \(dqSetIdentifier\(dq: \(dqstring\(dq,
                \(dqWeight\(dq: 123,
                \(dqRegion\(dq: \(dqus\-east\-1\(dq|\(dqus\-east\-2\(dq|\(dqus\-west\-1\(dq|\(dqus\-west\-2\(dq|\(dqca\-central\-1\(dq|\(dqeu\-west\-1\(dq|\(dqeu\-west\-2\(dq|\(dqeu\-central\-1\(dq|\(dqap\-southeast\-1\(dq|\(dqap\-southeast\-2\(dq|\(dqap\-northeast\-1\(dq|\(dqap\-northeast\-2\(dq|\(dqsa\-east\-1\(dq|\(dqcn\-north\-1\(dq|\(dqap\-south\-1\(dq,
                \(dqGeoLocation\(dq: {
                    \(dqContinentCode\(dq: \(dqstring\(dq,
                    \(dqCountryCode\(dq: \(dqstring\(dq,
                    \(dqSubdivisionCode\(dq: \(dqstring\(dq
                },
                \(dqFailover\(dq: \(dqPRIMARY\(dq|\(dqSECONDARY\(dq,
                \(dqTTL\(dq: 123,
                \(dqResourceRecords\(dq: [
                    {
                        \(dqValue\(dq: \(dqstring\(dq
                    },
                ],
                \(dqAliasTarget\(dq: {
                    \(dqHostedZoneId\(dq: \(dqstring\(dq,
                    \(dqDNSName\(dq: \(dqstring\(dq,
                    \(dqEvaluateTargetHealth\(dq: True|False
                },
                \(dqHealthCheckId\(dq: \(dqstring\(dq,
                \(dqTrafficPolicyInstanceId\(dq: \(dqstring\(dq
            }
        },
    ]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo=\(aq{
       \(dqName\(dq: \(dqmy\-cname.example.org.\(dq,
       \(dqTTL\(dq: 600,
       \(dqType\(dq: \(dqCNAME\(dq,
       \(dqResourceRecords\(dq: [
         {
           \(dqValue\(dq: \(dqmy\-host.example.org\(dq
         }
       ]
     }\(aq
foo=\(gaecho $foo\(ga  # Remove newlines
salt myminion boto3_route53.change_resource_record_sets DomainName=example.org.                 keyid=A1234567890ABCDEF123 key=xblahblahblah                 ChangeBatch=\(dq{\(aqChanges\(aq: [{\(aqAction\(aq: \(aqUPSERT\(aq, \(aqResourceRecordSet\(aq: $foo}]}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_route53.create_hosted_zone(Name, VPCId=None, VPCName=None, VPCRegion=None, CallerReference=None, Comment=\(aq\(aq, PrivateZone=False, DelegationSetId=None, region=None, key=None, keyid=None, profile=None)
Create a new Route53 Hosted Zone. Returns a Python data structure with information about the
newly created Hosted Zone.
.INDENT 7.0
.TP
.B Name
The name of the domain. This should be a fully\-specified domain, and should terminate with
a period. This is the name you have registered with your DNS registrar. It is also the name
you will delegate from your registrar to the Amazon Route 53 delegation servers returned in
response to this request.
.TP
.B VPCId
When creating a private hosted zone, either the VPC ID or VPC Name to associate with is
required.  Exclusive with VPCName.  Ignored if passed for a non\-private zone.
.TP
.B VPCName
When creating a private hosted zone, either the VPC ID or VPC Name to associate with is
required.  Exclusive with VPCId.  Ignored if passed for a non\-private zone.
.TP
.B VPCRegion
When creating a private hosted zone, the region of the associated VPC is required.  If not
provided, an effort will be made to determine it from VPCId or VPCName, if possible.  If
this fails, you\(aqll need to provide an explicit value for this option.  Ignored if passed for
a non\-private zone.
.TP
.B CallerReference
A unique string that identifies the request and that allows create_hosted_zone() calls to be
retried without the risk of executing the operation twice.  This is a required parameter
when creating new Hosted Zones.  Maximum length of 128.
.TP
.B Comment
Any comments you want to include about the hosted zone.
.TP
.B PrivateZone
Boolean \- Set to True if creating a private hosted zone.
.TP
.B DelegationSetId
If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon
Route 53 assigned to the reusable delegation set when you created it.  Note that XXX TODO
create_delegation_set() is not yet implemented, so you\(aqd need to manually create any
delegation sets before utilizing this.
.TP
.B region
Region endpoint to connect to.
.TP
.B key
AWS key to bind with.
.TP
.B keyid
AWS keyid to bind with.
.TP
.B profile
Dict, or pillar key pointing to a dict, containing AWS region/key/keyid.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_route53.create_hosted_zone example.org.
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_route53.delete_hosted_zone(Id, region=None, key=None, keyid=None, profile=None)
Delete a Route53 hosted zone.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_route53.delete_hosted_zone Z1234567890
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_route53.delete_hosted_zone_by_domain(Name, PrivateZone=None, region=None, key=None, keyid=None, profile=None)
Delete a Route53 hosted zone by domain name, and PrivateZone status if provided.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_route53.delete_hosted_zone_by_domain example.org.
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_route53.disassociate_vpc_from_hosted_zone(HostedZoneId=None, Name=None, VPCId=None, VPCName=None, VPCRegion=None, Comment=None, region=None, key=None, keyid=None, profile=None)
Disassociates an Amazon VPC from a private hosted zone.
.sp
You can\(aqt disassociate the last VPC from a private hosted zone.  You also can\(aqt convert a
private hosted zone into a public hosted zone.
.sp
Note that looking up hosted zones by name (e.g. using the Name parameter) only works XXX FACTCHECK
within a single AWS account \- if you\(aqre disassociating a VPC in one account from a hosted zone
in a different account you unfortunately MUST use the HostedZoneId parameter exclusively. XXX FIXME DOCU
.INDENT 7.0
.TP
.B HostedZoneId
The unique Zone Identifier for the Hosted Zone.
.TP
.B Name
The domain name associated with the Hosted Zone(s).
.TP
.B VPCId
When working with a private hosted zone, either the VPC ID or VPC Name to associate with is
required.  Exclusive with VPCName.
.TP
.B VPCName
When working with a private hosted zone, either the VPC ID or VPC Name to associate with is
required.  Exclusive with VPCId.
.TP
.B VPCRegion
When working with a private hosted zone, the region of the associated VPC is required.  If
not provided, an effort will be made to determine it from VPCId or VPCName, if possible.  If
this fails, you\(aqll need to provide an explicit value for VPCRegion.
.TP
.B Comment
Any comments you want to include about the change being made.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_route53.disassociate_vpc_from_hosted_zone                     Name=example.org. VPCName=myVPC                     VPCRegion=us\-east\-1 Comment=\(dqWhoops!  Don\(aqt wanna talk to this\-here zone no more.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_route53.find_hosted_zone(Id=None, Name=None, PrivateZone=None, region=None, key=None, keyid=None, profile=None)
Find a hosted zone with the given characteristics.
.INDENT 7.0
.TP
.B Id
The unique Zone Identifier for the Hosted Zone.  Exclusive with Name.
.TP
.B Name
The domain name associated with the Hosted Zone.  Exclusive with Id.
Note this has the potential to match more then one hosted zone (e.g. a public and a private
if both exist) which will raise an error unless PrivateZone has also been passed in order
split the different.
.TP
.B PrivateZone
Boolean \- Set to True if searching for a private hosted zone.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
Dict, or pillar key pointing to a dict, containing AWS region/key/keyid.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_route53.find_hosted_zone Name=salt.org.                 profile=\(aq{\(dqregion\(dq: \(dqus\-east\-1\(dq, \(dqkeyid\(dq: \(dqA12345678AB\(dq, \(dqkey\(dq: \(dqxblahblahblah\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_route53.get_hosted_zone(Id, region=None, key=None, keyid=None, profile=None)
Return detailed info about the given zone.
.INDENT 7.0
.TP
.B Id
The unique Zone Identifier for the Hosted Zone.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
Dict, or pillar key pointing to a dict, containing AWS region/key/keyid.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_route53.get_hosted_zone Z1234567690                 profile=\(aq{\(dqregion\(dq: \(dqus\-east\-1\(dq, \(dqkeyid\(dq: \(dqA12345678AB\(dq, \(dqkey\(dq: \(dqxblahblahblah\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_route53.get_hosted_zones_by_domain(Name, region=None, key=None, keyid=None, profile=None)
Find any zones with the given domain name and return detailed info about them.
Note that this can return multiple Route53 zones, since a domain name can be used in
both public and private zones.
.INDENT 7.0
.TP
.B Name
The domain name associated with the Hosted Zone(s).
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
Dict, or pillar key pointing to a dict, containing AWS region/key/keyid.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_route53.get_hosted_zones_by_domain salt.org.                 profile=\(aq{\(dqregion\(dq: \(dqus\-east\-1\(dq, \(dqkeyid\(dq: \(dqA12345678AB\(dq, \(dqkey\(dq: \(dqxblahblahblah\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_route53.get_resource_records(HostedZoneId=None, Name=None, StartRecordName=None, StartRecordType=None, PrivateZone=None, region=None, key=None, keyid=None, profile=None)
Get all resource records from a given zone matching the provided StartRecordName (if given) or all
records in the zone (if not), optionally filtered by a specific StartRecordType.  This will return
any and all RRs matching, regardless of their special AWS flavors (weighted, geolocation, alias,
etc.) so your code should be prepared for potentially large numbers of records back from this
function \- for example, if you\(aqve created a complex geolocation mapping with lots of entries all
over the world providing the same server name to many different regional clients.
.sp
If you want EXACTLY ONE record to operate on, you\(aqll need to implement any logic required to
pick the specific RR you care about from those returned.
.sp
Note that if you pass in Name without providing a value for PrivateZone (either True or
False), CommandExecutionError can be raised in the case of both public and private zones
matching the domain. XXX FIXME DOCU
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_route53.get_records test.example.org example.org A
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_route53.list_hosted_zones(DelegationSetId=None, region=None, key=None, keyid=None, profile=None)
Return detailed info about all zones in the bound account.
.INDENT 7.0
.TP
.B DelegationSetId
If you\(aqre using reusable delegation sets and you want to list all of the hosted zones that
are associated with a reusable delegation set, specify the ID of that delegation set.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
Dict, or pillar key pointing to a dict, containing AWS region/key/keyid.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_route53.describe_hosted_zones                 profile=\(aq{\(dqregion\(dq: \(dqus\-east\-1\(dq, \(dqkeyid\(dq: \(dqA12345678AB\(dq, \(dqkey\(dq: \(dqxblahblahblah\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_route53.update_hosted_zone_comment(Id=None, Name=None, Comment=None, PrivateZone=None, region=None, key=None, keyid=None, profile=None)
Update the comment on an existing Route 53 hosted zone.
.INDENT 7.0
.TP
.B Id
The unique Zone Identifier for the Hosted Zone.
.TP
.B Name
The domain name associated with the Hosted Zone(s).
.TP
.B Comment
Any comments you want to include about the hosted zone.
.TP
.B PrivateZone
Boolean \- Set to True if changing a private hosted zone.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_route53.update_hosted_zone_comment Name=example.org.                 Comment=\(dqThis is an example comment for an example zone\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto3_sns
.sp
Connection module for Amazon SNS
.INDENT 0.0
.TP
.B configuration
This module accepts explicit sns credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sns.keyid: GKTADJGHEIQSXMKKRBJ08H
sns.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sns.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_sns.create_topic(Name, region=None, key=None, keyid=None, profile=None)
Create an SNS topic.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_sns.create_topic mytopic region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_sns.delete_topic(TopicArn, region=None, key=None, keyid=None, profile=None)
Delete an SNS topic.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_sns.delete_topic mytopic region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_sns.describe_topic(name, region=None, key=None, keyid=None, profile=None)
Returns details about a specific SNS topic, specified by name or ARN.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt my_favorite_client boto3_sns.describe_topic a_sns_topic_of_my_choice
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_sns.get_subscription_attributes(SubscriptionArn, region=None, key=None, keyid=None, profile=None)
Returns all of the properties of a subscription.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_sns.get_subscription_attributes somesubscription region=us\-west\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_sns.get_topic_attributes(TopicArn, region=None, key=None, keyid=None, profile=None)
Returns all of the properties of a topic.  Topic properties returned might differ based on the
authorization of the user.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_sns.get_topic_attributes someTopic region=us\-west\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_sns.list_subscriptions(region=None, key=None, keyid=None, profile=None)
Returns a list of the requester\(aqs topics
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_sns.list_subscriptions region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_sns.list_subscriptions_by_topic(TopicArn, region=None, key=None, keyid=None, profile=None)
Returns a list of the subscriptions to a specific topic
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_sns.list_subscriptions_by_topic mytopic region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_sns.list_topics(region=None, key=None, keyid=None, profile=None)
Returns a list of the requester\(aqs topics
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_sns.list_topics
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_sns.set_subscription_attributes(SubscriptionArn, AttributeName, AttributeValue, region=None, key=None, keyid=None, profile=None)
Set an attribute of a subscription to a new value.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_sns.set_subscription_attributes someSubscription RawMessageDelivery jsonStringValue
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_sns.set_topic_attributes(TopicArn, AttributeName, AttributeValue, region=None, key=None, keyid=None, profile=None)
Set an attribute of a topic to a new value.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_sns.set_topic_attributes someTopic DisplayName myDisplayNameValue
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_sns.subscribe(TopicArn, Protocol, Endpoint, region=None, key=None, keyid=None, profile=None)
Subscribe to a Topic.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_sns.subscribe mytopic https https://www.example.com/sns\-endpoint
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_sns.topic_exists(name, region=None, key=None, keyid=None, profile=None)
Check to see if an SNS topic exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_sns.topic_exists mytopic region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto3_sns.unsubscribe(SubscriptionArn, region=None, key=None, keyid=None, profile=None)
Unsubscribe a specific SubscriptionArn of a topic.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto3_sns.unsubscribe my_subscription_arn region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_apigateway
.sp
Connection module for Amazon APIGateway
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
boto >= 2.8.0
.IP \(bu 2
boto3 >= 1.2.1
.IP \(bu 2
botocore >= 1.4.49
.UNINDENT
.TP
.B configuration
This module accepts explicit Lambda credentials but can also
utilize IAM roles assigned to the instance trough Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
apigateway.keyid: GKTADJGHEIQSXMKKRBJ08H
apigateway.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
apigateway.region: us\-west\-2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-west\-2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.0: All methods now return a dictionary. Create and delete methods return:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
created: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
created: false
error:
  message: error message
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Request methods (e.g., \fBdescribe_apigateway\fP) return:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
apigateway:
  \- {...}
  \- {...}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
error:
  message: error message
.ft P
.fi
.UNINDENT
.UNINDENT

.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.activate_api_deployment(restApiId, stageName, deploymentId, region=None, key=None, keyid=None, profile=None)
Activates previously deployed deployment for a given stage
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.activate_api_deployent restApiId stagename deploymentId
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.api_exists(name, description=None, region=None, key=None, keyid=None, profile=None)
Check to see if the given Rest API Name and optionally description exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.exists myapi_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.api_model_exists(restApiId, modelName, region=None, key=None, keyid=None, profile=None)
Check to see if the given modelName exists in the given restApiId
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.api_model_exists restApiId modelName
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.associate_api_key_stagekeys(apiKey, stagekeyslist, region=None, key=None, keyid=None, profile=None)
associate the given stagekeyslist to the given apiKey.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.associate_stagekeys_api_key \e
        api_key \(aq[\(dqrestapi id/stage name\(dq, ...]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.attach_usage_plan_to_apis(plan_id, apis, region=None, key=None, keyid=None, profile=None)
Attaches given usage plan to each of the apis provided in a list of apiId and stage values
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B apis
a list of dictionaries, where each dictionary contains the following:
.INDENT 7.0
.TP
.B apiId
a string, which is the id of the created API in AWS ApiGateway
.TP
.B stage
a string, which is the stage that the created API is deployed to.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.attach_usage_plan_to_apis plan_id=\(aqusage plan id\(aq apis=\(aq[{\(dqapiId\(dq: \(dqsome id 1\(dq, \(dqstage\(dq: \(dqsome stage 1\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.create_api(name, description, cloneFrom=None, region=None, key=None, keyid=None, profile=None)
Create a new REST API Service with the given name
.sp
Returns {created: True} if the rest api was created and returns
{created: False} if the rest api was not created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.create_api myapi_name api_description
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.create_api_deployment(restApiId, stageName, stageDescription=\(aq\(aq, description=\(aq\(aq, cacheClusterEnabled=False, cacheClusterSize=\(aq0.5\(aq, variables=None, region=None, key=None, keyid=None, profile=None)
Creates a new API deployment.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.create_api_deployent restApiId stagename stageDescription=\(aq\(aq \e
description=\(aq\(aq cacheClusterEnabled=True|False cacheClusterSize=0.5 variables=\(aq{\(dqname\(dq: \(dqvalue\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.create_api_integration(restApiId, resourcePath, httpMethod, integrationType, integrationHttpMethod, uri, credentials, requestParameters=None, requestTemplates=None, region=None, key=None, keyid=None, profile=None)
Creates an integration for a given method in a given API.
If integrationType is MOCK, uri and credential parameters will be ignored.
.sp
uri is in the form of (substitute APIGATEWAY_REGION and LAMBDA_FUNC_ARN)
\(dqarn:aws:apigateway:APIGATEWAY_REGION:lambda:path/2015\-03\-31/functions/LAMBDA_FUNC_ARN/invocations\(dq
.sp
credentials is in the form of an iam role name or role arn.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.create_api_integration restApiId resourcePath httpMethod \e
                     integrationType integrationHttpMethod uri credentials [\(aq{}\(aq [\(aq{}\(aq]]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.create_api_integration_response(restApiId, resourcePath, httpMethod, statusCode, selectionPattern, responseParameters=None, responseTemplates=None, region=None, key=None, keyid=None, profile=None)
Creates an integration response for a given method in a given API
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.create_api_integration_response restApiId resourcePath httpMethod \e
                    statusCode selectionPattern [\(aq{}\(aq [\(aq{}\(aq]]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.create_api_key(name, description, enabled=True, stageKeys=None, region=None, key=None, keyid=None, profile=None)
Create an API key given name and description.
.sp
An optional enabled argument can be provided.  If provided, the
valid values are True|False.  This argument defaults to True.
.sp
An optional stageKeys argument can be provided in the form of
list of dictionary with \(aqrestApiId\(aq and \(aqstageName\(aq as keys.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.create_api_key name description

salt myminion boto_apigateway.create_api_key name description enabled=False

salt myminion boto_apigateway.create_api_key name description \e
     stageKeys=\(aq[{\(dqrestApiId\(dq: \(dqid\(dq, \(dqstageName\(dq: \(dqstagename\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.create_api_method(restApiId, resourcePath, httpMethod, authorizationType, apiKeyRequired=False, requestParameters=None, requestModels=None, region=None, key=None, keyid=None, profile=None)
Creates API method for a resource in the given API
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.create_api_method restApiId resourcePath, httpMethod, authorizationType, \e
    apiKeyRequired=False, requestParameters=\(aq{\(dqname\(dq, \(dqvalue\(dq}\(aq, requestModels=\(aq{\(dqcontent\-type\(dq, \(dqvalue\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.create_api_method_response(restApiId, resourcePath, httpMethod, statusCode, responseParameters=None, responseModels=None, region=None, key=None, keyid=None, profile=None)
Create API method response for a method on a given resource in the given API
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.create_api_method_response restApiId resourcePath httpMethod \e
       statusCode responseParameters=\(aq{\(dqname\(dq, \(dqTrue|False\(dq}\(aq responseModels=\(aq{\(dqcontent\-type\(dq, \(dqmodel\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.create_api_model(restApiId, modelName, modelDescription, schema, contentType=\(aqapplication/json\(aq, region=None, key=None, keyid=None, profile=None)
Create a new model in a given API with a given schema, currently only contentType supported is
\(aqapplication/json\(aq
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.create_api_model restApiId modelName modelDescription \(aq<schema>\(aq \(aqcontent\-type\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.create_api_resources(restApiId, path, region=None, key=None, keyid=None, profile=None)
Given rest api id, and an absolute resource path, create all the resources and
return all resources in the resourcepath, returns False on failure.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.create_api_resources myapi_id resource_path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.create_api_stage(restApiId, stageName, deploymentId, description=\(aq\(aq, cacheClusterEnabled=False, cacheClusterSize=\(aq0.5\(aq, variables=None, region=None, key=None, keyid=None, profile=None)
Creates a new API stage for a given restApiId and deploymentId.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.create_api_stage restApiId stagename deploymentId \e
    description=\(aq\(aq cacheClusterEnabled=True|False cacheClusterSize=\(aq0.5\(aq variables=\(aq{\(dqname\(dq: \(dqvalue\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.create_usage_plan(name, description=None, throttle=None, quota=None, region=None, key=None, keyid=None, profile=None)
Creates a new usage plan with throttling and quotas optionally applied
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B name
Name of the usage plan
.TP
.B throttle
A dictionary consisting of the following keys:
.INDENT 7.0
.TP
.B rateLimit
requests per second at steady rate, float
.TP
.B burstLimit
maximum number of requests per second, integer
.UNINDENT
.TP
.B quota
A dictionary consisting of the following keys:
.INDENT 7.0
.TP
.B limit
number of allowed requests per specified quota period [required if quota parameter is present]
.TP
.B offset
number of requests to be subtracted from limit at the beginning of the period [optional]
.TP
.B period
quota period, must be one of DAY, WEEK, or MONTH. [required if quota parameter is present
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.create_usage_plan name=\(aqusage plan name\(aq throttle=\(aq{\(dqrateLimit\(dq: 10.0, \(dqburstLimit\(dq: 10}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.delete_api(name, description=None, region=None, key=None, keyid=None, profile=None)
Delete all REST API Service with the given name and an optional API description
.sp
Returns {deleted: True, count: deleted_count} if apis were deleted, and
returns {deleted: False} if error or not found.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.delete_api myapi_name

salt myminion boto_apigateway.delete_api myapi_name description=\(aqapi description\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.delete_api_deployment(restApiId, deploymentId, region=None, key=None, keyid=None, profile=None)
Deletes API deployment for a given restApiId and deploymentID
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.delete_api_deployent restApiId deploymentId
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.delete_api_integration(restApiId, resourcePath, httpMethod, region=None, key=None, keyid=None, profile=None)
Deletes an integration for a given method in a given API
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.delete_api_integration restApiId resourcePath httpMethod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.delete_api_integration_response(restApiId, resourcePath, httpMethod, statusCode, region=None, key=None, keyid=None, profile=None)
Deletes an integration response for a given method in a given API
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.delete_api_integration_response restApiId resourcePath httpMethod statusCode
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.delete_api_key(apiKey, region=None, key=None, keyid=None, profile=None)
Deletes a given apiKey
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.delete_api_key apikeystring
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.delete_api_method(restApiId, resourcePath, httpMethod, region=None, key=None, keyid=None, profile=None)
Delete API method for a resource in the given API
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.delete_api_method restApiId resourcePath httpMethod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.delete_api_method_response(restApiId, resourcePath, httpMethod, statusCode, region=None, key=None, keyid=None, profile=None)
Delete API method response for a resource in the given API
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.delete_api_method_response restApiId resourcePath httpMethod statusCode
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.delete_api_model(restApiId, modelName, region=None, key=None, keyid=None, profile=None)
Delete a model identified by name in a given API
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.delete_api_model restApiId modelName
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.delete_api_resources(restApiId, path, region=None, key=None, keyid=None, profile=None)
Given restApiId and an absolute resource path, delete the resources starting
from the absolute resource path. If resourcepath is the root resource \(aq/\(aq,
the function will return False. Returns False on failure.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.delete_api_resources myapi_id, resource_path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.delete_api_stage(restApiId, stageName, region=None, key=None, keyid=None, profile=None)
Deletes stage identified by stageName from API identified by restApiId
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.delete_api_stage restApiId stageName
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.delete_usage_plan(plan_id, region=None, key=None, keyid=None, profile=None)
Deletes usage plan identified by plan_id
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.delete_usage_plan plan_id=\(aqusage plan id\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_api_deployment(restApiId, deploymentId, region=None, key=None, keyid=None, profile=None)
Get API deployment for a given restApiId and deploymentId.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_api_deployent restApiId deploymentId
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_api_deployments(restApiId, region=None, key=None, keyid=None, profile=None)
Gets information about the defined API Deployments.  Return list of api deployments.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_api_deployments restApiId
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_api_integration(restApiId, resourcePath, httpMethod, region=None, key=None, keyid=None, profile=None)
Get an integration for a given method in a given API
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_api_integration restApiId resourcePath httpMethod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_api_integration_response(restApiId, resourcePath, httpMethod, statusCode, region=None, key=None, keyid=None, profile=None)
Get an integration response for a given method in a given API
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_api_integration_response restApiId resourcePath httpMethod statusCode
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_api_key(apiKey, region=None, key=None, keyid=None, profile=None)
Gets info about the given api key
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_api_key apigw_api_key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_api_keys(region=None, key=None, keyid=None, profile=None)
Gets information about the defined API Keys.  Return list of apiKeys.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_api_keys
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_api_method(restApiId, resourcePath, httpMethod, region=None, key=None, keyid=None, profile=None)
Get API method for a resource in the given API
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_api_method restApiId resourcePath httpMethod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_api_method_response(restApiId, resourcePath, httpMethod, statusCode, region=None, key=None, keyid=None, profile=None)
Get API method response for a resource in the given API
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_api_method_response restApiId resourcePath httpMethod statusCode
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_api_model(restApiId, modelName, flatten=True, region=None, key=None, keyid=None, profile=None)
Get a model by name for a given API
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_api_model restApiId modelName [True]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_api_models(restApiId, region=None, key=None, keyid=None, profile=None)
Get all models for a given API
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_api_models restApiId
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_api_resource(restApiId, path, region=None, key=None, keyid=None, profile=None)
Given rest api id, and an absolute resource path, returns the resource id for
the given path.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_api_resource myapi_id resource_path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_api_resource_method(restApiId, resourcePath, httpMethod, region=None, key=None, keyid=None, profile=None)
Given rest api id, resource path, and http method (must be one of DELETE,
GET, HEAD, OPTIONS, PATCH, POST, PUT), return the method for the
api/resource path if defined.  Return False if method is not defined.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_api_resource_method myapi_id resource_path httpmethod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_api_resources(restApiId, region=None, key=None, keyid=None, profile=None)
Given rest api id, return all resources for this api.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_api_resources myapi_id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_api_stage(restApiId, stageName, region=None, key=None, keyid=None, profile=None)
Get API stage for a given apiID and stage name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_api_stage restApiId stageName
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_api_stages(restApiId, deploymentId, region=None, key=None, keyid=None, profile=None)
Get all API stages for a given apiID and deploymentID
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_api_stages restApiId deploymentId
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_apis(name=None, description=None, region=None, key=None, keyid=None, profile=None)
Returns all rest apis in the defined region.  If optional parameter name is included,
returns all rest apis matching the name in the defined region.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_apis

salt myminion boto_apigateway.describe_apis name=\(aqapi name\(aq

salt myminion boto_apigateway.describe_apis name=\(aqapi name\(aq description=\(aqdesc str\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.describe_usage_plans(name=None, plan_id=None, region=None, key=None, keyid=None, profile=None)
Returns a list of existing usage plans, optionally filtered to match a given plan name
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.describe_usage_plans
salt myminion boto_apigateway.describe_usage_plans name=\(aqusage plan name\(aq
salt myminion boto_apigateway.describe_usage_plans plan_id=\(aqusage plan id\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.detach_usage_plan_from_apis(plan_id, apis, region=None, key=None, keyid=None, profile=None)
Detaches given usage plan from each of the apis provided in a list of apiId and stage value
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B apis
a list of dictionaries, where each dictionary contains the following:
.INDENT 7.0
.TP
.B apiId
a string, which is the id of the created API in AWS ApiGateway
.TP
.B stage
a string, which is the stage that the created API is deployed to.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.detach_usage_plan_to_apis plan_id=\(aqusage plan id\(aq apis=\(aq[{\(dqapiId\(dq: \(dqsome id 1\(dq, \(dqstage\(dq: \(dqsome stage 1\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.disable_api_key(apiKey, region=None, key=None, keyid=None, profile=None)
disable the given apiKey.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.enable_api_key api_key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.disassociate_api_key_stagekeys(apiKey, stagekeyslist, region=None, key=None, keyid=None, profile=None)
disassociate the given stagekeyslist to the given apiKey.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.disassociate_stagekeys_api_key \e
        api_key \(aq[\(dqrestapi id/stage name\(dq, ...]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.enable_api_key(apiKey, region=None, key=None, keyid=None, profile=None)
enable the given apiKey.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.enable_api_key api_key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.flush_api_stage_cache(restApiId, stageName, region=None, key=None, keyid=None, profile=None)
Flushes cache for the stage identified by stageName from API identified by restApiId
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.flush_api_stage_cache restApiId stageName
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.overwrite_api_stage_variables(restApiId, stageName, variables, region=None, key=None, keyid=None, profile=None)
Overwrite the stage variables for the given restApiId and stage name with the given variables,
variables must be in the form of a dictionary.  Overwrite will always remove all the existing
stage variables associated with the given restApiId and stage name, follow by the adding of all the
variables specified in the variables dictionary
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.overwrite_api_stage_variables restApiId stageName variables=\(aq{\(dqname\(dq: \(dqvalue\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.update_api_key_description(apiKey, description, region=None, key=None, keyid=None, profile=None)
update the given apiKey with the given description.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.update_api_key_description api_key description
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.update_api_model_schema(restApiId, modelName, schema, region=None, key=None, keyid=None, profile=None)
update the schema (in python dictionary format) for the given model in the given restApiId
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.update_api_model_schema restApiId modelName schema
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_apigateway.update_usage_plan(plan_id, throttle=None, quota=None, region=None, key=None, keyid=None, profile=None)
Updates an existing usage plan with throttling and quotas
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B plan_id
Id of the created usage plan
.TP
.B throttle
A dictionary consisting of the following keys:
.INDENT 7.0
.TP
.B rateLimit
requests per second at steady rate, float
.TP
.B burstLimit
maximum number of requests per second, integer
.UNINDENT
.TP
.B quota
A dictionary consisting of the following keys:
.INDENT 7.0
.TP
.B limit
number of allowed requests per specified quota period [required if quota parameter is present]
.TP
.B offset
number of requests to be subtracted from limit at the beginning of the period [optional]
.TP
.B period
quota period, must be one of DAY, WEEK, or MONTH. [required if quota parameter is present
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_apigateway.update_usage_plan plan_id=\(aqusage plan id\(aq throttle=\(aq{\(dqrateLimit\(dq: 10.0, \(dqburstLimit\(dq: 10}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_asg
.sp
Connection module for Amazon Autoscale Groups
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit autoscale credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
asg.keyid: GKTADJGHEIQSXMKKRBJ08H
asg.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
asg.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.create(name, launch_config_name, availability_zones, min_size, max_size, desired_capacity=None, load_balancers=None, default_cooldown=None, health_check_type=None, health_check_period=None, placement_group=None, vpc_zone_identifier=None, tags=None, termination_policies=None, suspended_processes=None, scaling_policies=None, scheduled_actions=None, region=None, notification_arn=None, notification_types=None, key=None, keyid=None, profile=None)
Create an autoscale group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_asg.create myasg mylc \(aq[\(dqus\-east\-1a\(dq, \(dqus\-east\-1e\(dq]\(aq 1 10 load_balancers=\(aq[\(dqmyelb\(dq, \(dqmyelb2\(dq]\(aq tags=\(aq[{\(dqkey\(dq: \(dqName\(dq, value=\(dqmyasg\(dq, \(dqpropagate_at_launch\(dq: True}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.create_launch_configuration(name, image_id, key_name=None, vpc_id=None, vpc_name=None, security_groups=None, user_data=None, instance_type=\(aqm1.small\(aq, kernel_id=None, ramdisk_id=None, block_device_mappings=None, instance_monitoring=False, spot_price=None, instance_profile_name=None, ebs_optimized=False, associate_public_ip_address=None, volume_type=None, delete_on_termination=True, iops=None, use_block_device_types=False, region=None, key=None, keyid=None, profile=None)
Create a launch configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_asg.create_launch_configuration mylc image_id=ami\-0b9c9f62 key_name=\(aqmykey\(aq security_groups=\(aq[\(dqmygroup\(dq]\(aq instance_type=\(aqc3.2xlarge\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.delete(name, force=False, region=None, key=None, keyid=None, profile=None)
Delete an autoscale group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_asg.delete myasg region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.delete_launch_configuration(name, region=None, key=None, keyid=None, profile=None)
Delete a launch configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_asg.delete_launch_configuration mylc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.describe_launch_configuration(name, region=None, key=None, keyid=None, profile=None)
Dump details of a given launch configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_asg.describe_launch_configuration mylc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.enter_standby(name, instance_ids, should_decrement_desired_capacity=False, region=None, key=None, keyid=None, profile=None)
Switch desired instances to StandBy mode
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_asg.enter_standby my_autoscale_group_name \(aq[\(dqi\-xxxxxx\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.exists(name, region=None, key=None, keyid=None, profile=None)
Check to see if an autoscale group exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_asg.exists myasg region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.exit_standby(name, instance_ids, should_decrement_desired_capacity=False, region=None, key=None, keyid=None, profile=None)
Exit desired instances from StandBy mode
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_asg.exit_standby my_autoscale_group_name \(aq[\(dqi\-xxxxxx\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.get_all_groups(region=None, key=None, keyid=None, profile=None)
Return all AutoScale Groups visible in the account
(as a list of boto.ec2.autoscale.group.AutoScalingGroup).
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_asg.get_all_groups region=us\-east\-1 \-\-output yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.get_all_launch_configurations(region=None, key=None, keyid=None, profile=None)
Fetch and return all Launch Configuration with details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_asg.get_all_launch_configurations
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.get_cloud_init_mime(cloud_init)
Get a mime multipart encoded string from a cloud\-init dict. Currently
supports boothooks, scripts and cloud\-config.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto.get_cloud_init_mime <cloud init>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.get_config(name, region=None, key=None, keyid=None, profile=None)
Get the configuration for an autoscale group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_asg.get_config myasg region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.get_instances(name, lifecycle_state=\(aqInService\(aq, health_status=\(aqHealthy\(aq, attribute=\(aqprivate_ip_address\(aq, attributes=None, region=None, key=None, keyid=None, profile=None)
return attribute of all instances in the named autoscale group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_asg.get_instances my_autoscale_group_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.get_scaling_policy_arn(as_group, scaling_policy_name, region=None, key=None, keyid=None, profile=None)
Return the arn for a scaling policy in a specific autoscale group or None
if not found. Mainly used as a helper method for boto_cloudwatch_alarm, for
linking alarms to scaling policies.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq boto_asg.get_scaling_policy_arn mygroup mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.launch_configuration_exists(name, region=None, key=None, keyid=None, profile=None)
Check for a launch configuration\(aqs existence.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_asg.launch_configuration_exists mylc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.list_groups(region=None, key=None, keyid=None, profile=None)
Return all AutoScale Groups visible in the account
(as a list of names).
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_asg.list_groups region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.list_launch_configurations(region=None, key=None, keyid=None, profile=None)
List all Launch Configurations.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_asg.list_launch_configurations
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_asg.update(name, launch_config_name, availability_zones, min_size, max_size, desired_capacity=None, load_balancers=None, default_cooldown=None, health_check_type=None, health_check_period=None, placement_group=None, vpc_zone_identifier=None, tags=None, termination_policies=None, suspended_processes=None, scaling_policies=None, scheduled_actions=None, notification_arn=None, notification_types=None, region=None, key=None, keyid=None, profile=None)
Update an autoscale group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_asg.update myasg mylc \(aq[\(dqus\-east\-1a\(dq, \(dqus\-east\-1e\(dq]\(aq 1 10 load_balancers=\(aq[\(dqmyelb\(dq, \(dqmyelb2\(dq]\(aq tags=\(aq[{\(dqkey\(dq: \(dqName\(dq, value=\(dqmyasg\(dq, \(dqpropagate_at_launch\(dq: True}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_cfn
.sp
Connection module for Amazon Cloud Formation
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit AWS credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cfn.keyid: GKTADJGHEIQSXMKKRBJ08H
cfn.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cfn.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cfn.create(name, template_body=None, template_url=None, parameters=None, notification_arns=None, disable_rollback=None, timeout_in_minutes=None, capabilities=None, tags=None, on_failure=None, stack_policy_body=None, stack_policy_url=None, region=None, key=None, keyid=None, profile=None)
Create a CFN stack.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cfn.create mystack template_url=\(aqhttps://s3.amazonaws.com/bucket/template.cft\(aq         region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cfn.delete(name, region=None, key=None, keyid=None, profile=None)
Delete a CFN stack.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cfn.delete mystack region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cfn.describe(name, region=None, key=None, keyid=None, profile=None)
Describe a stack.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cfn.describe mystack region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cfn.exists(name, region=None, key=None, keyid=None, profile=None)
Check to see if a stack exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cfn.exists mystack region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cfn.get_template(name, region=None, key=None, keyid=None, profile=None)
Check to see if attributes are set on a CFN stack.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cfn.get_template mystack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cfn.update_stack(name, template_body=None, template_url=None, parameters=None, notification_arns=None, disable_rollback=False, timeout_in_minutes=None, capabilities=None, tags=None, use_previous_template=None, stack_policy_during_update_body=None, stack_policy_during_update_url=None, stack_policy_body=None, stack_policy_url=None, region=None, key=None, keyid=None, profile=None)
Update a CFN stack.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cfn.update_stack mystack template_url=\(aqhttps://s3.amazonaws.com/bucket/template.cft\(aq         region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cfn.validate_template(template_body=None, template_url=None, region=None, key=None, keyid=None, profile=None)
Validate cloudformation template
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cfn.validate_template mystack\-template
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_cloudfront
.sp
Connection module for Amazon CloudFront
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
boto3
.TP
.B configuration
This module accepts explicit AWS credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles or
it can read them from the ~/.aws/credentials file or from these
environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/
    iam\-roles\-for\-amazon\-ec2.html

http://boto3.readthedocs.io/en/latest/guide/
    configuration.html#guide\-configuration
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cloudfront.keyid: GKTADJGHEIQSXMKKRBJ08H
cloudfront.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cloudfront.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudfront.create_distribution(name, config, tags=None, region=None, key=None, keyid=None, profile=None)
Create a CloudFront distribution with the given name, config, and (optionally) tags.
.INDENT 7.0
.TP
.B name
Name for the CloudFront distribution
.TP
.B config
Configuration for the distribution
.TP
.B tags
Tags to associate with the distribution
.TP
.B region
Region to connect to
.TP
.B key
Secret key to use
.TP
.B keyid
Access key to use
.TP
.B profile
A dict with region, key, and keyid,
or a pillar key (string) that contains such a dict.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudfront.create_distribution name=mydistribution profile=awsprofile             config=\(aq{\(dqComment\(dq:\(dqpartial configuration\(dq,\(dqEnabled\(dq:true}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudfront.export_distributions(region=None, key=None, keyid=None, profile=None)
Get details of all CloudFront distributions.
Produces results that can be used to create an SLS file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_cloudfront.export_distributions \-\-out=txt |            sed \(dqs/local: //\(dq > cloudfront_distributions.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudfront.get_distribution(name, region=None, key=None, keyid=None, profile=None)
Get information about a CloudFront distribution (configuration, tags) with a given name.
.INDENT 7.0
.TP
.B name
Name of the CloudFront distribution
.TP
.B region
Region to connect to
.TP
.B key
Secret key to use
.TP
.B keyid
Access key to use
.TP
.B profile
A dict with region, key, and keyid,
or a pillar key (string) that contains such a dict.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudfront.get_distribution name=mydistribution profile=awsprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudfront.update_distribution(name, config, tags=None, region=None, key=None, keyid=None, profile=None)
Update the config (and optionally tags) for the CloudFront distribution with the given name.
.INDENT 7.0
.TP
.B name
Name of the CloudFront distribution
.TP
.B config
Configuration for the distribution
.TP
.B tags
Tags to associate with the distribution
.TP
.B region
Region to connect to
.TP
.B key
Secret key to use
.TP
.B keyid
Access key to use
.TP
.B profile
A dict with region, key, and keyid,
or a pillar key (string) that contains such a dict.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudfront.update_distribution name=mydistribution profile=awsprofile             config=\(aq{\(dqComment\(dq:\(dqpartial configuration\(dq,\(dqEnabled\(dq:true}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_cloudtrail
.sp
Connection module for Amazon CloudTrail
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
boto
.IP \(bu 2
boto3
.UNINDENT
.UNINDENT
.sp
The dependencies listed above can be installed via package or pip.
.INDENT 0.0
.TP
.B configuration
This module accepts explicit Lambda credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cloudtrail.keyid: GKTADJGHEIQSXMKKRBJ08H
cloudtrail.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cloudtrail.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudtrail.add_tags(Name, region=None, key=None, keyid=None, profile=None, **kwargs)
Add tags to a trail
.sp
Returns {tagged: true} if the trail was tagged and returns
{tagged: False} if the trail was not tagged.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudtrail.add_tags my_trail tag_a=tag_value tag_b=tag_value
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudtrail.create(Name, S3BucketName, S3KeyPrefix=None, SnsTopicName=None, IncludeGlobalServiceEvents=None, IsMultiRegionTrail=None, EnableLogFileValidation=None, CloudWatchLogsLogGroupArn=None, CloudWatchLogsRoleArn=None, KmsKeyId=None, region=None, key=None, keyid=None, profile=None)
Given a valid config, create a trail.
.sp
Returns {created: true} if the trail was created and returns
{created: False} if the trail was not created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudtrail.create my_trail my_bucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudtrail.delete(Name, region=None, key=None, keyid=None, profile=None)
Given a trail name, delete it.
.sp
Returns {deleted: true} if the trail was deleted and returns
{deleted: false} if the trail was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudtrail.delete mytrail
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudtrail.describe(Name, region=None, key=None, keyid=None, profile=None)
Given a trail name describe its properties.
.sp
Returns a dictionary of interesting properties.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudtrail.describe mytrail
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudtrail.exists(Name, region=None, key=None, keyid=None, profile=None)
Given a trail name, check to see if the given trail exists.
.sp
Returns True if the given trail exists and returns False if the given
trail does not exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudtrail.exists mytrail
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudtrail.list(region=None, key=None, keyid=None, profile=None)
List all trails
.sp
Returns list of trails
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
policies:
  \- {...}
  \- {...}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudtrail.list_tags(Name, region=None, key=None, keyid=None, profile=None)
List tags of a trail
.INDENT 7.0
.TP
.B Returns
.INDENT 7.0
.IP \(bu 2
{...}
.IP \(bu 2
{...}
.UNINDENT

.TP
.B Return type
tags
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudtrail.list_tags my_trail
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudtrail.remove_tags(Name, region=None, key=None, keyid=None, profile=None, **kwargs)
Remove tags from a trail
.sp
Returns {tagged: true} if the trail was tagged and returns
{tagged: False} if the trail was not tagged.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudtrail.remove_tags my_trail tag_a=tag_value tag_b=tag_value
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudtrail.start_logging(Name, region=None, key=None, keyid=None, profile=None)
Start logging for a trail
.sp
Returns {started: true} if the trail was started and returns
{started: False} if the trail was not started.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudtrail.start_logging my_trail
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudtrail.status(Name, region=None, key=None, keyid=None, profile=None)
Given a trail name describe its properties.
.sp
Returns a dictionary of interesting properties.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudtrail.describe mytrail
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudtrail.stop_logging(Name, region=None, key=None, keyid=None, profile=None)
Stop logging for a trail
.sp
Returns {stopped: true} if the trail was stopped and returns
{stopped: False} if the trail was not stopped.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudtrail.stop_logging my_trail
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudtrail.update(Name, S3BucketName, S3KeyPrefix=None, SnsTopicName=None, IncludeGlobalServiceEvents=None, IsMultiRegionTrail=None, EnableLogFileValidation=None, CloudWatchLogsLogGroupArn=None, CloudWatchLogsRoleArn=None, KmsKeyId=None, region=None, key=None, keyid=None, profile=None)
Given a valid config, update a trail.
.sp
Returns {created: true} if the trail was created and returns
{created: False} if the trail was not created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudtrail.update my_trail my_bucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_cloudwatch
.sp
Connection module for Amazon CloudWatch
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cloudwatch.keyid: GKTADJGHEIQSXMKKRBJ08H
cloudwatch.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cloudwatch.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudwatch.convert_to_arn(arns, region=None, key=None, keyid=None, profile=None)
Convert a list of strings into actual arns. Converts convenience names such
as \(aqscaling_policy:...\(aq
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq convert_to_arn \(aqscaling_policy:\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudwatch.create_or_update_alarm(connection=None, name=None, metric=None, namespace=None, statistic=None, comparison=None, threshold=None, period=None, evaluation_periods=None, unit=None, description=\(aq\(aq, dimensions=None, alarm_actions=None, insufficient_data_actions=None, ok_actions=None, region=None, key=None, keyid=None, profile=None)
Create or update a cloudwatch alarm.
.INDENT 7.0
.TP
.B Params are the same as:
\fI\%https://boto.readthedocs.io/en/latest/ref/cloudwatch.html#boto.ec2.cloudwatch.alarm.MetricAlarm\fP\&.
.UNINDENT
.sp
Dimensions must be a dict. If the value of Dimensions is a string, it will
be json decoded to produce a dict. alarm_actions, insufficient_data_actions,
and ok_actions must be lists of string.  If the passed\-in value is a string,
it will be split on \(dq,\(dq to produce a list. The strings themselves for
alarm_actions, insufficient_data_actions, and ok_actions must be Amazon
resource names (ARN\(aqs); however, this method also supports an arn lookup
notation, as follows:
.INDENT 7.0
.INDENT 3.5
arn:aws:....                                    ARN as per http://docs.aws.amazon.com/general/latest/gr/aws\-arns\-and\-namespaces.html
scaling_policy:<as_name>:<scaling_policy_name>  The named autoscale group scaling policy, for the named group (e.g.  scaling_policy:my\-asg:ScaleDown)
.UNINDENT
.UNINDENT
.sp
This is convenient for setting up autoscaling as follows.  First specify a
boto_asg.present state for an ASG with scaling_policies, and then set up
boto_cloudwatch_alarm.present states which have alarm_actions that
reference the scaling_policy.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudwatch.create_alarm name=myalarm ... region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudwatch.delete_alarm(name, region=None, key=None, keyid=None, profile=None)
Delete a cloudwatch alarm
.sp
CLI example to delete a queue:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudwatch.delete_alarm myalarm region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudwatch.get_alarm(name, region=None, key=None, keyid=None, profile=None)
Get alarm details. Also can be used to check to see if an alarm exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudwatch.get_alarm myalarm region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudwatch.get_all_alarms(region=None, prefix=None, key=None, keyid=None, profile=None)
Get all alarm details.  Produces results that can be used to create an sls
file.
.sp
If prefix parameter is given, alarm names in the output will be prepended
with the prefix; alarms that have the prefix will be skipped.  This can be
used to convert existing alarms to be managed by salt, as follows:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP 1. 3
.INDENT 3.0
.TP
.B Make a \(dqbackup\(dq of all existing alarms
$ salt\-call boto_cloudwatch.get_all_alarms \-\-out=txt | sed \(dqs/local: //\(dq > legacy_alarms.sls
.UNINDENT
.IP 2. 3
.INDENT 3.0
.TP
.B Get all alarms with new prefixed names
$ salt\-call boto_cloudwatch.get_all_alarms \(dqprefix=**MANAGED BY SALT** \(dq \-\-out=txt | sed \(dqs/local: //\(dq > managed_alarms.sls
.UNINDENT
.IP 3. 3
.INDENT 3.0
.TP
.B Insert the managed alarms into cloudwatch
$ salt\-call state.template managed_alarms.sls
.UNINDENT
.IP 4. 3
Manually verify that the new alarms look right
.IP 5. 3
Delete the original alarms
$ sed s/present/absent/ legacy_alarms.sls > remove_legacy_alarms.sls
$ salt\-call state.template remove_legacy_alarms.sls
.IP 6. 3
Get all alarms again, verify no changes
$ salt\-call boto_cloudwatch.get_all_alarms \-\-out=txt | sed \(dqs/local: //\(dq > final_alarms.sls
$ diff final_alarms.sls managed_alarms.sls
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudwatch.get_all_alarms region=us\-east\-1 \-\-out=txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_cloudwatch_event
.sp
Connection module for Amazon CloudWatch Events
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cloudwatch_event.keyid: GKTADJGHEIQSXMKKRBJ08H
cloudwatch_event.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cloudwatch_event.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudwatch_event.create_or_update(Name, ScheduleExpression=None, EventPattern=None, Description=None, RoleArn=None, State=None, region=None, key=None, keyid=None, profile=None)
Given a valid config, create an event rule.
.sp
Returns {created: true} if the rule was created and returns
{created: False} if the rule was not created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudwatch_event.create_or_update my_rule
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudwatch_event.delete(Name, region=None, key=None, keyid=None, profile=None)
Given a rule name, delete it.
.sp
Returns {deleted: true} if the rule was deleted and returns
{deleted: false} if the rule was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudwatch_event.delete myrule
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudwatch_event.describe(Name, region=None, key=None, keyid=None, profile=None)
Given a rule name describe its properties.
.sp
Returns a dictionary of interesting properties.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudwatch_event.describe myrule
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudwatch_event.exists(Name, region=None, key=None, keyid=None, profile=None)
Given a rule name, check to see if the given rule exists.
.sp
Returns True if the given rule exists and returns False if the given
rule does not exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudwatch_event.exists myevent region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudwatch_event.list_rules(region=None, key=None, keyid=None, profile=None)
List, with details, all Cloudwatch Event rules visible in the current scope.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudwatch_event.list_rules region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudwatch_event.list_targets(Rule, region=None, key=None, keyid=None, profile=None)
Given a rule name list the targets of that rule.
.sp
Returns a dictionary of interesting properties.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudwatch_event.list_targets myrule
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudwatch_event.put_targets(Rule, Targets, region=None, key=None, keyid=None, profile=None)
Add the given targets to the given rule
.sp
Returns a dictionary describing any failures.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudwatch_event.put_targets myrule [{\(aqId\(aq: \(aqtarget1\(aq, \(aqArn\(aq: \(aqarn:***\(aq}]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cloudwatch_event.remove_targets(Rule, Ids, region=None, key=None, keyid=None, profile=None)
Given a rule name remove the named targets from the target list
.sp
Returns a dictionary describing any failures.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudwatch_event.remove_targets myrule [\(aqTarget1\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_cognitoidentity
.sp
Connection module for Amazon CognitoIdentity
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit CognitoIdentity credentials but can also
utilize IAM roles assigned to the instance trough Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cognitoidentity.keyid: GKTADJGHEIQSXMKKRBJ08H
cognitoidentity.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cognitoidentity.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.0: All methods now return a dictionary. Create, delete, set, and
update methods return:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
created: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
created: false
error:
  message: error message
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Request methods (e.g., \fIdescribe_identity_pools\fP) return:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
identity_pools:
  \- {...}
  \- {...}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
error:
  message: error message
.ft P
.fi
.UNINDENT
.UNINDENT

.INDENT 0.0
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cognitoidentity.create_identity_pool(IdentityPoolName, AllowUnauthenticatedIdentities=False, SupportedLoginProviders=None, DeveloperProviderName=None, OpenIdConnectProviderARNs=None, region=None, key=None, keyid=None, profile=None)
Creates a new identity pool.  All parameters except for IdentityPoolName is optional.
SupportedLoginProviders should be a dictionary mapping provider names to provider app
IDs.  OpenIdConnectProviderARNs should be a list of OpenID Connect provider ARNs.
.sp
Returns the created identity pool if successful
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cognitoidentity.create_identity_pool my_id_pool_name                              DeveloperProviderName=custom_developer_provider
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cognitoidentity.delete_identity_pools(IdentityPoolName, IdentityPoolId=None, region=None, key=None, keyid=None, profile=None)
Given an identity pool name, (optionally if an identity pool id is given,
the given name will be ignored)
.sp
Deletes all identity pools matching the given name, or the specific identity pool with
the given identity pool id.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cognitoidentity.delete_identity_pools my_id_pool_name
salt myminion boto_cognitoidentity.delete_identity_pools \(aq\(aq IdentityPoolId=my_id_pool_id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cognitoidentity.describe_identity_pools(IdentityPoolName, IdentityPoolId=None, region=None, key=None, keyid=None, profile=None)
Given an identity pool name, (optionally if an identity pool id is given,
the given name will be ignored)
.sp
Returns a list of matched identity pool name\(aqs pool properties
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cognitoidentity.describe_identity_pools my_id_pool_name
salt myminion boto_cognitoidentity.describe_identity_pools \(aq\(aq IdentityPoolId=my_id_pool_id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cognitoidentity.get_identity_pool_roles(IdentityPoolName, IdentityPoolId=None, region=None, key=None, keyid=None, profile=None)
Given an identity pool name, (optionally if an identity pool id if given,
the given name will be ignored)
.sp
Returns a list of matched identity pool name\(aqs associated roles
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cognitoidentity.get_identity_pool_roles my_id_pool_name
salt myminion boto_cognitoidentity.get_identity_pool_roles \(aq\(aq IdentityPoolId=my_id_pool_id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cognitoidentity.set_identity_pool_roles(IdentityPoolId, AuthenticatedRole=None, UnauthenticatedRole=None, region=None, key=None, keyid=None, profile=None)
Given an identity pool id, set the given AuthenticatedRole and UnauthenticatedRole (the Role
can be an iam arn, or a role name)  If AuthenticatedRole or UnauthenticatedRole is not given,
the authenticated and/or the unauthenticated role associated previously with the pool will be
cleared.
.sp
Returns set True if successful, set False if unsuccessful with the associated errors.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cognitoidentity.set_identity_pool_roles my_id_pool_roles  # this clears the roles
salt myminion boto_cognitoidentity.set_identity_pool_roles my_id_pool_id             AuthenticatedRole=my_auth_role UnauthenticatedRole=my_unauth_role  # this set both roles
salt myminion boto_cognitoidentity.set_identity_pool_roles my_id_pool_id             AuthenticatedRole=my_auth_role  # this will set the auth role and clear the unauth role
salt myminion boto_cognitoidentity.set_identity_pool_roles my_id_pool_id             UnauthenticatedRole=my_unauth_role  # this will set the unauth role and clear the auth role
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_cognitoidentity.update_identity_pool(IdentityPoolId, IdentityPoolName=None, AllowUnauthenticatedIdentities=False, SupportedLoginProviders=None, DeveloperProviderName=None, OpenIdConnectProviderARNs=None, region=None, key=None, keyid=None, profile=None)
Updates the given IdentityPoolId\(aqs properties.  All parameters except for IdentityPoolId,
is optional.  SupportedLoginProviders should be a dictionary mapping provider names to
provider app IDs.  OpenIdConnectProviderARNs should be a list of OpenID Connect provider
ARNs.
.sp
To clear SupportedLoginProviders pass \(aq{}\(aq
.sp
To clear OpenIdConnectProviderARNs pass \(aq[]\(aq
.sp
boto3 api prevents DeveloperProviderName to be updated after it has been set for the first time.
.sp
Returns the updated identity pool if successful
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cognitoidentity.update_identity_pool my_id_pool_id my_id_pool_name                              DeveloperProviderName=custom_developer_provider
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_datapipeline
.sp
Connection module for Amazon Data Pipeline
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_datapipeline.activate_pipeline(pipeline_id, region=None, key=None, keyid=None, profile=None)
Start processing pipeline tasks. This function is idempotent.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_datapipeline.activate_pipeline my_pipeline_id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_datapipeline.create_pipeline(name, unique_id, description=\(aq\(aq, region=None, key=None, keyid=None, profile=None)
Create a new, empty pipeline. This function is idempotent.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_datapipeline.create_pipeline my_name my_unique_id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_datapipeline.delete_pipeline(pipeline_id, region=None, key=None, keyid=None, profile=None)
Delete a pipeline, its pipeline definition, and its run history. This function is idempotent.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_datapipeline.delete_pipeline my_pipeline_id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_datapipeline.describe_pipelines(pipeline_ids, region=None, key=None, keyid=None, profile=None)
Retrieve metadata about one or more pipelines.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_datapipeline.describe_pipelines [\(aqmy_pipeline_id\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_datapipeline.get_pipeline_definition(pipeline_id, version=\(aqlatest\(aq, region=None, key=None, keyid=None, profile=None)
Get the definition of the specified pipeline.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_datapipeline.get_pipeline_definition my_pipeline_id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_datapipeline.list_pipelines(region=None, key=None, keyid=None, profile=None)
Get a list of pipeline ids and names for all pipelines.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_datapipeline.list_pipelines profile=myprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_datapipeline.pipeline_id_from_name(name, region=None, key=None, keyid=None, profile=None)
Get the pipeline id, if it exists, for the given name.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_datapipeline.pipeline_id_from_name my_pipeline_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_datapipeline.put_pipeline_definition(pipeline_id, pipeline_objects, parameter_objects=None, parameter_values=None, region=None, key=None, keyid=None, profile=None)
Add tasks, schedules, and preconditions to the specified pipeline. This function is
idempotent and will replace an existing definition.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_datapipeline.put_pipeline_definition my_pipeline_id my_pipeline_objects
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_dynamodb
.sp
Connection module for Amazon DynamoDB
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit DynamoDB credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
keyid: GKTADJGHEIQSXMKKRBJ08H
key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_dynamodb.create_global_secondary_index(table_name, global_index, region=None, key=None, keyid=None, profile=None)
Creates a single global secondary index on a DynamoDB table.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_dynamodb.create_global_secondary_index table_name /
index_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_dynamodb.create_table(table_name, region=None, key=None, keyid=None, profile=None, read_capacity_units=None, write_capacity_units=None, hash_key=None, hash_key_data_type=None, range_key=None, range_key_data_type=None, local_indexes=None, global_indexes=None)
Creates a DynamoDB table.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_dynamodb.create_table table_name /
region=us\-east\-1 /
hash_key=id /
hash_key_data_type=N /
range_key=created_at /
range_key_data_type=N /
read_capacity_units=1 /
write_capacity_units=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_dynamodb.delete(table_name, region=None, key=None, keyid=None, profile=None)
Delete a DynamoDB table.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_dynamodb.delete table_name region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_dynamodb.describe(table_name, region=None, key=None, keyid=None, profile=None)
Describe a DynamoDB table.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_dynamodb.describe table_name region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_dynamodb.exists(table_name, region=None, key=None, keyid=None, profile=None)
Check to see if a table exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_dynamodb.exists table_name region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_dynamodb.extract_index(index_data, global_index=False)
Instantiates and returns an AllIndex object given a valid index
configuration
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_dynamodb.extract_index index
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_dynamodb.list_tags_of_resource(resource_arn, region=None, key=None, keyid=None, profile=None)
Returns a dictionary of all tags currently attached to a given resource.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_dynamodb.list_tags_of_resource               resource_arn=arn:aws:dynamodb:us\-east\-1:012345678901:table/my\-table
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3006.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_dynamodb.tag_resource(resource_arn, tags, region=None, key=None, keyid=None, profile=None)
Sets given tags (provided as list or dict) on the given resource.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_dynamodb.tag_resource               resource_arn=arn:aws:dynamodb:us\-east\-1:012345678901:table/my\-table               tags=\(aq{Name: my\-table, Owner: Ops}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3006.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_dynamodb.untag_resource(resource_arn, tag_keys, region=None, key=None, keyid=None, profile=None)
Removes given tags (provided as list) from the given resource.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_dynamodb.untag_resource               resource_arn=arn:aws:dynamodb:us\-east\-1:012345678901:table/my\-table               tag_keys=\(aq[Name, Owner]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3006.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_dynamodb.update(table_name, throughput=None, global_indexes=None, region=None, key=None, keyid=None, profile=None)
Update a DynamoDB table.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_dynamodb.update table_name region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_dynamodb.update_global_secondary_index(table_name, global_indexes, region=None, key=None, keyid=None, profile=None)
Updates the throughput of the given global secondary indexes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_dynamodb.update_global_secondary_index table_name /
indexes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_ec2
.sp
Connection module for Amazon EC2
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit EC2 credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available \fI\%here\fP\&.
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ec2.keyid: GKTADJGHEIQSXMKKRBJ08H
ec2.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ec2.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid, and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
  region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
boto
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.allocate_eip_address(domain=None, region=None, key=None, keyid=None, profile=None)
Allocate a new Elastic IP address and associate it with your account.
.INDENT 7.0
.TP
.B domain
(string) Optional param \- if set to exactly \(aqvpc\(aq, the address will be
allocated to the VPC.  The default simply maps the EIP to your
account container.
.TP
.B returns
(dict) dict of \(aqinteresting\(aq information about the newly allocated EIP,
with probably the most interesting keys being \(aqpublic_ip\(aq; and
\(aqallocation_id\(aq iff \(aqdomain=vpc\(aq was passed.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_ec2.allocate_eip_address domain=vpc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.assign_private_ip_addresses(network_interface_name=None, network_interface_id=None, private_ip_addresses=None, secondary_private_ip_address_count=None, allow_reassignment=False, region=None, key=None, keyid=None, profile=None)
Assigns one or more secondary private IP addresses to a network interface.
.INDENT 7.0
.TP
.B network_interface_id
(string) \- ID of the network interface to associate the IP with (exclusive with \(aqnetwork_interface_name\(aq)
.TP
.B network_interface_name
(string) \- Name of the network interface to associate the IP with (exclusive with \(aqnetwork_interface_id\(aq)
.TP
.B private_ip_addresses
(list) \- Assigns the specified IP addresses as secondary IP addresses to the network interface (exclusive with \(aqsecondary_private_ip_address_count\(aq)
.TP
.B secondary_private_ip_address_count
(int) \- The number of secondary IP addresses to assign to the network interface. (exclusive with \(aqprivate_ip_addresses\(aq)
.TP
.B allow_reassociation
(bool)   – Allow a currently associated EIP to be re\-associated with the new instance or interface.
.TP
.B returns
(bool)   \- True on success, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.assign_private_ip_addresses network_interface_name=my_eni private_ip_addresses=private_ip
salt myminion boto_ec2.assign_private_ip_addresses network_interface_name=my_eni secondary_private_ip_address_count=2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.associate_eip_address(instance_id=None, instance_name=None, public_ip=None, allocation_id=None, network_interface_id=None, network_interface_name=None, private_ip_address=None, allow_reassociation=False, region=None, key=None, keyid=None, profile=None)
Associate an Elastic IP address with a currently running instance or a network interface.
This requires exactly one of either \(aqpublic_ip\(aq or \(aqallocation_id\(aq, depending
on whether you’re associating a VPC address or a plain EC2 address.
.INDENT 7.0
.TP
.B instance_id
(string) – ID of the instance to associate with (exclusive with \(aqinstance_name\(aq)
.TP
.B instance_name
(string) – Name tag of the instance to associate with (exclusive with \(aqinstance_id\(aq)
.TP
.B public_ip
(string) – Public IP address, for standard EC2 based allocations.
.TP
.B allocation_id
(string) – Allocation ID for a VPC\-based EIP.
.TP
.B network_interface_id
(string) \- ID of the network interface to associate the EIP with
.TP
.B network_interface_name
(string) \- Name of the network interface to associate the EIP with
.TP
.B private_ip_address
(string) – The primary or secondary private IP address to associate with the Elastic IP address.
.TP
.B allow_reassociation
(bool)   – Allow a currently associated EIP to be re\-associated with the new instance or interface.
.TP
.B returns
(bool)   \- True on success, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.associate_eip_address instance_name=bubba.ho.tep allocation_id=eipalloc\-ef382c8a
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.attach_network_interface(device_index, name=None, network_interface_id=None, instance_name=None, instance_id=None, region=None, key=None, keyid=None, profile=None)
Attach an Elastic Network Interface.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.attach_network_interface my_eni instance_name=salt\-master device_index=0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.attach_volume(volume_id, instance_id, device, region=None, key=None, keyid=None, profile=None)
Attach an EBS volume to an EC2 instance.
\&..
.INDENT 7.0
.TP
.B volume_id
(string) – The ID of the EBS volume to be attached.
.TP
.B instance_id
(string) – The ID of the EC2 instance to attach the volume to.
.TP
.B device
(string) – The device on the instance through which the volume is exposed (e.g. /dev/sdh)
.TP
.B returns
(bool) \- True on success, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_ec2.attach_volume vol\-12345678 i\-87654321 /dev/sdh
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.create_image(ami_name, instance_id=None, instance_name=None, tags=None, region=None, key=None, keyid=None, profile=None, description=None, no_reboot=False, dry_run=False, filters=None)
Given instance properties that define exactly one instance, create AMI and return AMI\-id.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.create_image ami_name instance_name=myinstance
salt myminion boto_ec2.create_image another_ami_name tags=\(aq{\(dqmytag\(dq: \(dqvalue\(dq}\(aq description=\(aqthis is my ami\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.create_key(key_name, save_path, region=None, key=None, keyid=None, profile=None)
Creates a key and saves it to a given path.
Returns the private key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.create_key mykey /root/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.create_network_interface(name, subnet_id=None, subnet_name=None, private_ip_address=None, description=None, groups=None, region=None, key=None, keyid=None, profile=None)
Create an Elastic Network Interface.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.create_network_interface my_eni subnet\-12345 description=my_eni groups=[\(aqmy_group\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.create_tags(resource_ids, tags, region=None, key=None, keyid=None, profile=None)
Create new metadata tags for the specified resource ids.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B resource_ids
(string) or (list) – List of resource IDs.  A plain string will be converted to a list of one element.
.TP
.B tags
(dict) – Dictionary of name/value pairs. To create only a tag name, pass \(aq\(aq as the value.
.TP
.B returns
(bool) \- True on success, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_ec2.create_tags vol\-12345678 \(aq{\(dqName\(dq: \(dqmyVolume01\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.create_volume(zone_name, size=None, snapshot_id=None, volume_type=None, iops=None, encrypted=False, kms_key_id=None, wait_for_creation=False, region=None, key=None, keyid=None, profile=None)
Create an EBS volume to an availability zone.
.INDENT 7.0
.TP
.B zone_name
(string) – The Availability zone name of the EBS volume to be created.
.TP
.B size
.INDENT 7.0
.TP
.B (int) –  The size of the new volume, in GiB. If you\(aqre creating the
volume from a snapshot and don\(aqt specify a volume size, the
default is the snapshot size.
.UNINDENT
.TP
.B snapshot_id
(string) –  The snapshot ID from which the new volume will be created.
.TP
.B volume_type
.INDENT 7.0
.TP
.B (string) \-  The type of the volume. Valid volume types for AWS can be found here:
\fI\%http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html\fP
.UNINDENT
.TP
.B iops
(int) \- The provisioned IOPS you want to associate with this volume.
.TP
.B encrypted
(bool) \- Specifies whether the volume should be encrypted.
.TP
.B kms_key_id
.INDENT 7.0
.TP
.B (string) \- If encrypted is True, this KMS Key ID may be specified to
encrypt volume with this key
e.g.: arn:aws:kms:us\-east\-1:012345678910:key/abcd1234\-a123\-456a\-a12b\-a123b4cd56ef
.UNINDENT
.TP
.B wait_for_creation
(bool) \- Whether or not to wait for volume creation to complete.
.TP
.B returns
(string) \- created volume id on success, error message on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_ec2.create_volume us\-east\-1a size=10
salt\-call boto_ec2.create_volume us\-east\-1a snapshot_id=snap\-0123abcd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.delete_key(key_name, region=None, key=None, keyid=None, profile=None)
Deletes a key. Always returns True
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.delete_key mykey
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.delete_network_interface(name=None, network_interface_id=None, region=None, key=None, keyid=None, profile=None)
Create an Elastic Network Interface.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.create_network_interface my_eni subnet\-12345 description=my_eni groups=[\(aqmy_group\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.delete_tags(resource_ids, tags, region=None, key=None, keyid=None, profile=None)
Delete metadata tags for the specified resource ids.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B resource_ids
(string) or (list) – List of resource IDs.  A plain string will be converted to a list of one element.
.TP
.B tags
.INDENT 7.0
.TP
.B (dict) or (list) – Either a dictionary containing name/value pairs or a list containing just tag names.
If you pass in a dictionary, the values must match the actual tag values or the tag
will not be deleted. If you pass in a value of None for the tag value, all tags with
that name will be deleted.
.UNINDENT
.TP
.B returns
(bool) \- True on success, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_ec2.delete_tags vol\-12345678 \(aq{\(dqName\(dq: \(dqmyVolume01\(dq}\(aq
salt\-call boto_ec2.delete_tags vol\-12345678 \(aq[\(dqName\(dq,\(dqMountPoint\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.delete_volume(volume_id, instance_id=None, device=None, force=False, region=None, key=None, keyid=None, profile=None)
Detach an EBS volume from an EC2 instance.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B volume_id
(string) – The ID of the EBS volume to be deleted.
.TP
.B force
(bool) – Forces deletion even if the device has not yet been detached from its instance.
.TP
.B returns
(bool) \- True on success, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_ec2.delete_volume vol\-12345678
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.detach_network_interface(name=None, network_interface_id=None, attachment_id=None, force=False, region=None, key=None, keyid=None, profile=None)
Detach an Elastic Network Interface.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.detach_network_interface my_eni
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.detach_volume(volume_id, instance_id=None, device=None, force=False, wait_for_detachement=False, region=None, key=None, keyid=None, profile=None)
Detach an EBS volume from an EC2 instance.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B volume_id
(string) – The ID of the EBS volume to be detached.
.TP
.B instance_id
(string) – The ID of the EC2 instance from which it will be detached.
.TP
.B device
(string) – The device on the instance through which the volume is exposted (e.g. /dev/sdh)
.TP
.B force
.INDENT 7.0
.TP
.B (bool) – Forces detachment if the previous detachment attempt did not occur cleanly.
This option can lead to data loss or a corrupted file system. Use this option
only as a last resort to detach a volume from a failed instance. The instance
will not have an opportunity to flush file system caches nor file system meta data.
If you use this option, you must perform file system check and repair procedures.
.UNINDENT
.TP
.B wait_for_detachement
(bool) \- Whether or not to wait for volume detachement to complete.
.TP
.B returns
(bool) \- True on success, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_ec2.detach_volume vol\-12345678 i\-87654321
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.disassociate_eip_address(public_ip=None, association_id=None, region=None, key=None, keyid=None, profile=None)
Disassociate an Elastic IP address from a currently running instance. This
requires exactly one of either \(aqassociation_id\(aq or \(aqpublic_ip\(aq, depending
on whether you’re dealing with a VPC or EC2 Classic address.
.INDENT 7.0
.TP
.B public_ip
(string) – Public IP address, for EC2 Classic allocations.
.TP
.B association_id
(string) – Association ID for a VPC\-bound EIP.
.TP
.B returns
(bool)   \- True on success, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.disassociate_eip_address association_id=eipassoc\-e3ba2d16
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.exists(instance_id=None, name=None, tags=None, region=None, key=None, keyid=None, profile=None, in_states=None, filters=None)
Given an instance id, check to see if the given instance id exists.
.sp
Returns True if the given instance with the given id, name, or tags
exists; otherwise, False is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.exists myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.find_images(ami_name=None, executable_by=None, owners=None, image_ids=None, tags=None, region=None, key=None, keyid=None, profile=None, return_objs=False)
Given image properties, find and return matching AMI ids
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.find_images tags=\(aq{\(dqmytag\(dq: \(dqvalue\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.find_instances(instance_id=None, name=None, tags=None, region=None, key=None, keyid=None, profile=None, return_objs=False, in_states=None, filters=None)
Given instance properties, find and return matching instance ids
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.find_instances # Lists all instances
salt myminion boto_ec2.find_instances name=myinstance
salt myminion boto_ec2.find_instances tags=\(aq{\(dqmytag\(dq: \(dqvalue\(dq}\(aq
salt myminion boto_ec2.find_instances filters=\(aq{\(dqvpc\-id\(dq: \(dqvpc\-12345678\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.get_all_eip_addresses(addresses=None, allocation_ids=None, region=None, key=None, keyid=None, profile=None)
Get public addresses of some, or all EIPs associated with the current account.
.INDENT 7.0
.TP
.B addresses
(list) \- Optional list of addresses.  If provided, only the addresses
associated with those in the list will be returned.
.TP
.B allocation_ids
(list) \- Optional list of allocation IDs.  If provided, only the
addresses associated with the given allocation IDs will be returned.
.TP
.B returns
(list) \- A list of the requested EIP addresses
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_ec2.get_all_eip_addresses
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.get_all_tags(filters=None, region=None, key=None, keyid=None, profile=None)
Describe all tags matching the filter criteria, or all tags in the account otherwise.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B filters
(dict) \- Additional constraints on which volumes to return.  Note that valid filters vary
extensively depending on the resource type.  When in doubt, search first without a filter
and then use the returned data to help fine\-tune your search.  You can generally garner the
resource type from its ID (e.g. \fIvol\-XXXXX\fP is a volume, \fIi\-XXXXX\fP is an instance, etc.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_ec2.get_all_tags \(aq{\(dqtag:Name\(dq: myInstanceNameTag, resource\-type: instance}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.get_all_volumes(volume_ids=None, filters=None, return_objs=False, region=None, key=None, keyid=None, profile=None)
Get a list of all EBS volumes, optionally filtered by provided \(aqfilters\(aq param
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B volume_ids
(list) \- Optional list of volume_ids.  If provided, only the volumes
associated with those in the list will be returned.
.TP
.B filters
(dict) \- Additional constraints on which volumes to return.  Valid filters are:
.UNINDENT
.INDENT 7.0
.IP \(bu 2
attachment.attach\-time \- The time stamp when the attachment initiated.
.IP \(bu 2
attachment.delete\-on\-termination \- Whether the volume is deleted on instance termination.
.IP \(bu 2
attachment.device \- The device name that is exposed to the instance (for example, /dev/sda1).
.IP \(bu 2
attachment.instance\-id \- The ID of the instance the volume is attached to.
.IP \(bu 2
attachment.status \- The attachment state (attaching | attached | detaching | detached).
.IP \(bu 2
availability\-zone \- The Availability Zone in which the volume was created.
.IP \(bu 2
create\-time \- The time stamp when the volume was created.
.IP \(bu 2
encrypted \- The encryption status of the volume.
.IP \(bu 2
size \- The size of the volume, in GiB.
.IP \(bu 2
snapshot\-id \- The snapshot from which the volume was created.
.IP \(bu 2
status \- The status of the volume (creating | available | in\-use | deleting | deleted | error).
.IP \(bu 2
\fI\%tag:key=value\fP \- The key/value combination of a tag assigned to the resource.
.IP \(bu 2
volume\-id \- The volume ID.
.IP \(bu 2
volume\-type \- The Amazon EBS volume type. This can be \fBgp2\fP for General
Purpose SSD, \fBio1\fP for Provisioned IOPS SSD, \fBst1\fP for Throughput
Optimized HDD, \fBsc1\fP for Cold HDD, or \fBstandard\fP for Magnetic volumes.
.UNINDENT
.INDENT 7.0
.TP
.B return_objs
(bool) \- Changes the return type from list of volume IDs to list of
boto.ec2.volume.Volume objects
.TP
.B returns
(list) \- A list of the requested values: Either the volume IDs or, if
return_objs is \fBTrue\fP, boto.ec2.volume.Volume objects.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_ec2.get_all_volumes filters=\(aq{\(dqtag:Name\(dq: \(dqmyVolume01\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.get_attribute(attribute, instance_name=None, instance_id=None, region=None, key=None, keyid=None, profile=None, filters=None)
Get an EC2 instance attribute.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.get_attribute sourceDestCheck instance_name=my_instance
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Available attributes:
.INDENT 7.0
.IP \(bu 2
instanceType
.IP \(bu 2
kernel
.IP \(bu 2
ramdisk
.IP \(bu 2
userData
.IP \(bu 2
disableApiTermination
.IP \(bu 2
instanceInitiatedShutdownBehavior
.IP \(bu 2
rootDeviceName
.IP \(bu 2
blockDeviceMapping
.IP \(bu 2
productCodes
.IP \(bu 2
sourceDestCheck
.IP \(bu 2
groupSet
.IP \(bu 2
ebsOptimized
.IP \(bu 2
sriovNetSupport
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.get_eip_address_info(addresses=None, allocation_ids=None, region=None, key=None, keyid=None, profile=None)
Get \(aqinteresting\(aq info about some, or all EIPs associated with the current account.
.INDENT 7.0
.TP
.B addresses
(list) \- Optional list of addresses.  If provided, only the addresses
associated with those in the list will be returned.
.TP
.B allocation_ids
(list) \- Optional list of allocation IDs.  If provided, only the
addresses associated with the given allocation IDs will be returned.
.TP
.B returns
(list of dicts) \- A list of dicts, each containing the info for one of the requested EIPs.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_ec2.get_eip_address_info addresses=52.4.2.15
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.get_id(name=None, tags=None, region=None, key=None, keyid=None, profile=None, in_states=None, filters=None)
Given instance properties, return the instance id if it exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.get_id myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.get_key(key_name, region=None, key=None, keyid=None, profile=None)
Check to see if a key exists. Returns fingerprint and name if
it does and False if it doesn\(aqt
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.get_key mykey
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.get_keys(keynames=None, filters=None, region=None, key=None, keyid=None, profile=None)
Gets all keys or filters them by name and returns a list.
keynames (list):: A list of the names of keypairs to retrieve.
If not provided, all key pairs will be returned.
filters (dict) :: Optional filters that can be used to limit the
results returned. Filters are provided in the form of a dictionary
consisting of filter names as the key and filter values as the
value. The set of allowable filter names/values is dependent on
the request being performed. Check the EC2 API guide for details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.get_keys
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.get_network_interface(name=None, network_interface_id=None, region=None, key=None, keyid=None, profile=None)
Get an Elastic Network Interface.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.get_network_interface name=my_eni
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.get_network_interface_id(name, region=None, key=None, keyid=None, profile=None)
Get an Elastic Network Interface id from its name tag.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.get_network_interface_id name=my_eni
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.get_tags(instance_id=None, keyid=None, key=None, profile=None, region=None)
Given an instance_id, return a list of tags associated with that instance.
.INDENT 7.0
.TP
.B returns
(list) \- list of tags as key/value pairs
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.get_tags instance_id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.get_unassociated_eip_address(domain=\(aqstandard\(aq, region=None, key=None, keyid=None, profile=None)
Return the first unassociated EIP
.INDENT 7.0
.TP
.B domain
Indicates whether the address is an EC2 address or a VPC address
(standard|vpc).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_ec2.get_unassociated_eip_address
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.get_zones(region=None, key=None, keyid=None, profile=None)
Get a list of AZs for the configured region.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.get_zones
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.import_key(key_name, public_key_material, region=None, key=None, keyid=None, profile=None)
Imports the public key from an RSA key pair that you created with a third\-party tool.
Supported formats:
\- OpenSSH public key format (e.g., the format in ~/.ssh/authorized_keys)
\- Base64 encoded DER format
\- SSH public key file format as specified in RFC4716
\- DSA keys are not supported. Make sure your key generator is set up to create RSA keys.
Supported lengths: 1024, 2048, and 4096.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.import mykey publickey
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.modify_network_interface_attribute(name=None, network_interface_id=None, attr=None, value=None, region=None, key=None, keyid=None, profile=None)
Modify an attribute of an Elastic Network Interface.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.modify_network_interface_attribute my_eni attr=description value=\(aqexample description\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.release_eip_address(public_ip=None, allocation_id=None, region=None, key=None, keyid=None, profile=None)
Free an Elastic IP address.  Pass either a public IP address to release an
EC2 Classic EIP, or an AllocationId to release a VPC EIP.
.INDENT 7.0
.TP
.B public_ip
(string) \- The public IP address \- for EC2 elastic IPs.
.TP
.B allocation_id
(string) \- The Allocation ID \- for VPC elastic IPs.
.TP
.B returns
(bool) \- True on success, False on failure
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.release_eip_address allocation_id=eipalloc\-ef382c8a
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.run(image_id, name=None, tags=None, key_name=None, security_groups=None, user_data=None, instance_type=\(aqm1.small\(aq, placement=None, kernel_id=None, ramdisk_id=None, monitoring_enabled=None, vpc_id=None, vpc_name=None, subnet_id=None, subnet_name=None, private_ip_address=None, block_device_map=None, disable_api_termination=None, instance_initiated_shutdown_behavior=None, placement_group=None, client_token=None, security_group_ids=None, security_group_names=None, additional_info=None, tenancy=None, instance_profile_arn=None, instance_profile_name=None, ebs_optimized=None, network_interface_id=None, network_interface_name=None, region=None, key=None, keyid=None, profile=None, network_interfaces=None)
Create and start an EC2 instance.
.sp
Returns True if the instance was created; otherwise False.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.run ami\-b80c2b87 name=myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B image_id
(string) – The ID of the image to run.
.TP
.B name
(string) \- The name of the instance.
.TP
.B tags
(dict of key: value pairs) \- tags to apply to the instance.
.TP
.B key_name
(string) – The name of the key pair with which to launch instances.
.TP
.B security_groups
(list of strings) – The names of the EC2 classic security groups with
which to associate instances
.TP
.B user_data
(string) – The Base64\-encoded MIME user data to be made available to the
instance(s) in this reservation.
.TP
.B instance_type
(string) – The type of instance to run.  Note that some image types
(e.g. hvm) only run on some instance types.
.TP
.B placement
(string) – The Availability Zone to launch the instance into.
.TP
.B kernel_id
(string) – The ID of the kernel with which to launch the instances.
.TP
.B ramdisk_id
(string) – The ID of the RAM disk with which to launch the instances.
.TP
.B monitoring_enabled
(bool) – Enable detailed CloudWatch monitoring on the instance.
.TP
.B vpc_id
(string) \- ID of a VPC to bind the instance to.  Exclusive with vpc_name.
.TP
.B vpc_name
(string) \- Name of a VPC to bind the instance to.  Exclusive with vpc_id.
.TP
.B subnet_id
(string) – The subnet ID within which to launch the instances for VPC.
.TP
.B subnet_name
(string) – The name of a subnet within which to launch the instances for VPC.
.TP
.B private_ip_address
(string) – If you’re using VPC, you can optionally use this parameter to
assign the instance a specific available IP address from the subnet
(e.g. 10.0.0.25).
.TP
.B block_device_map
(boto.ec2.blockdevicemapping.BlockDeviceMapping) – A BlockDeviceMapping
data structure describing the EBS volumes associated with the Image.
(string) \- A string representation of a BlockDeviceMapping structure
(dict) \- A dict describing a BlockDeviceMapping structure
.sp
YAML example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
device\-maps:
    /dev/sdb:
        ephemeral_name: ephemeral0
    /dev/sdc:
        ephemeral_name: ephemeral1
    /dev/sdd:
        ephemeral_name: ephemeral2
    /dev/sde:
        ephemeral_name: ephemeral3
    /dev/sdf:
        size: 20
        volume_type: gp2
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B disable_api_termination
(bool) – If True, the instances will be locked and will not be able to
be terminated via the API.
.TP
.B instance_initiated_shutdown_behavior
(string) – Specifies whether the instance stops or terminates on
instance\-initiated shutdown. Valid values are: stop, terminate
.TP
.B placement_group
(string) – If specified, this is the name of the placement group in
which the instance(s) will be launched.
.TP
.B client_token
(string) – Unique, case\-sensitive identifier you provide to ensure
idempotency of the request. Maximum 64 ASCII characters.
.TP
.B security_group_ids
(list of strings) – The ID(s) of the VPC security groups with which to
associate instances.
.TP
.B security_group_names
(list of strings) – The name(s) of the VPC security groups with which to
associate instances.
.TP
.B additional_info
(string) – Specifies additional information to make available to the
instance(s).
.TP
.B tenancy
(string) – The tenancy of the instance you want to launch. An instance
with a tenancy of ‘dedicated’ runs on single\-tenant hardware and can
only be launched into a VPC. Valid values are:”default” or “dedicated”.
NOTE: To use dedicated tenancy you MUST specify a VPC subnet\-ID as well.
.TP
.B instance_profile_arn
(string) – The Amazon resource name (ARN) of the IAM Instance Profile
(IIP) to associate with the instances.
.TP
.B instance_profile_name
(string) – The name of the IAM Instance Profile (IIP) to associate with
the instances.
.TP
.B ebs_optimized
(bool) – Whether the instance is optimized for EBS I/O. This
optimization provides dedicated throughput to Amazon EBS and an
optimized configuration stack to provide optimal EBS I/O performance.
This optimization isn’t available with all instance types.
.TP
.B network_interfaces
(boto.ec2.networkinterface.NetworkInterfaceCollection) – A
NetworkInterfaceCollection data structure containing the ENI
specifications for the instance.
.TP
.B network_interface_id
(string) \- ID of the network interface to attach to the instance
.TP
.B network_interface_name
(string) \- Name of the network interface to attach to the instance
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.set_attribute(attribute, attribute_value, instance_name=None, instance_id=None, region=None, key=None, keyid=None, profile=None, filters=None)
Set an EC2 instance attribute.
Returns whether the operation succeeded or not.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.set_attribute sourceDestCheck False instance_name=my_instance
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Available attributes:
.INDENT 7.0
.IP \(bu 2
instanceType
.IP \(bu 2
kernel
.IP \(bu 2
ramdisk
.IP \(bu 2
userData
.IP \(bu 2
disableApiTermination
.IP \(bu 2
instanceInitiatedShutdownBehavior
.IP \(bu 2
rootDeviceName
.IP \(bu 2
blockDeviceMapping
.IP \(bu 2
productCodes
.IP \(bu 2
sourceDestCheck
.IP \(bu 2
groupSet
.IP \(bu 2
ebsOptimized
.IP \(bu 2
sriovNetSupport
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.set_volumes_tags(tag_maps, authoritative=False, dry_run=False, region=None, key=None, keyid=None, profile=None)
New in version 2016.11.0.

.INDENT 7.0
.TP
.B tag_maps (list)
List of dicts of filters and tags, where \(aqfilters\(aq is a dict suitable for passing to the
\(aqfilters\(aq argument of get_all_volumes() above, and \(aqtags\(aq is a dict of tags to be set on
volumes (via create_tags/delete_tags) as matched by the given filters.  The filter syntax
is extended to permit passing either a list of volume_ids or an instance_name (with
instance_name being the Name tag of the instance to which the desired volumes are mapped).
Each mapping in the list is applied separately, so multiple sets of volumes can be all
tagged differently with one call to this function.  If filtering by instance Name, You may
additionally limit the instances matched by passing in a list of desired instance states.
The default set of states is (\(aqpending\(aq, \(aqrebooting\(aq, \(aqrunning\(aq, \(aqstopping\(aq, \(aqstopped\(aq).
.UNINDENT
.sp
YAML example fragment:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- filters:
    attachment.instance_id: i\-abcdef12
  tags:
    Name: dev\-int\-abcdef12.aws\-foo.com
\- filters:
    attachment.device: /dev/sdf
  tags:
    ManagedSnapshots: true
    BillingGroup: bubba.hotep@aws\-foo.com
  in_states:
  \- stopped
  \- terminated
\- filters:
    instance_name: prd\-foo\-01.aws\-foo.com
  tags:
    Name: prd\-foo\-01.aws\-foo.com
    BillingGroup: infra\-team@aws\-foo.com
\- filters:
    volume_ids: [ vol\-12345689, vol\-abcdef12 ]
  tags:
    BillingGroup: infra\-team@aws\-foo.com
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B authoritative (bool)
If true, any existing tags on the matched volumes, and not explicitly requested here, will
be removed.
.TP
.B dry_run (bool)
If true, don\(aqt change anything, just return a dictionary describing any changes which
would have been applied.
.TP
.B returns (dict)
A dict describing status and any changes.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.terminate(instance_id=None, name=None, region=None, key=None, keyid=None, profile=None, filters=None)
Terminate the instance described by instance_id or name.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.terminate name=myinstance
salt myminion boto_ec2.terminate instance_id=i\-a46b9f
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ec2.unassign_private_ip_addresses(network_interface_name=None, network_interface_id=None, private_ip_addresses=None, region=None, key=None, keyid=None, profile=None)
Unassigns one or more secondary private IP addresses from a network interface
.INDENT 7.0
.TP
.B network_interface_id
(string) \- ID of the network interface to associate the IP with (exclusive with \(aqnetwork_interface_name\(aq)
.TP
.B network_interface_name
(string) \- Name of the network interface to associate the IP with (exclusive with \(aqnetwork_interface_id\(aq)
.TP
.B private_ip_addresses
(list) \- Assigns the specified IP addresses as secondary IP addresses to the network interface.
.TP
.B returns
(bool)   \- True on success, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_ec2.unassign_private_ip_addresses network_interface_name=my_eni private_ip_addresses=private_ip
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.UNINDENT
.SS salt.modules.boto_efs
.sp
Connection module for Amazon EFS
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit EFS credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles or
it can read them from the ~/.aws/credentials file or from these
environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary.  More information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/efs/latest/ug/
    access\-control\-managing\-permissions.html

http://boto3.readthedocs.io/en/latest/guide/
    configuration.html#guide\-configuration
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
efs.keyid: GKTADJGHEIQSXMKKRBJ08H
efs.key: askd+ghsdfjkghWupU/asdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
efs.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid, and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askd+ghsdfjkghWupU/asdflkdfklgjsdfjajkghs
  region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_efs.create_file_system(name, performance_mode=\(aqgeneralPurpose\(aq, keyid=None, key=None, profile=None, region=None, creation_token=None, **kwargs)
Creates a new, empty file system.
.INDENT 7.0
.TP
.B name
(string) \- The name for the new file system
.TP
.B performance_mode
(string) \- The PerformanceMode of the file system. Can be either
generalPurpose or maxIO
.TP
.B creation_token
(string) \- A unique name to be used as reference when creating an EFS.
This will ensure idempotency. Set to name if not specified otherwise
.TP
.B returns
(dict) \- A dict of the data for the elastic file system
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq boto_efs.create_file_system efs\-name generalPurpose
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_efs.create_mount_target(filesystemid, subnetid, ipaddress=None, securitygroups=None, keyid=None, key=None, profile=None, region=None, **kwargs)
Creates a mount target for a file system.
You can then mount the file system on EC2 instances via the mount target.
.sp
You can create one mount target in each Availability Zone in your VPC.
All EC2 instances in a VPC within a given Availability Zone share a
single mount target for a given file system.
.sp
If you have multiple subnets in an Availability Zone,
you create a mount target in one of the subnets.
EC2 instances do not need to be in the same subnet as the mount target
in order to access their file system.
.INDENT 7.0
.TP
.B filesystemid
(string) \- ID of the file system for which to create the mount target.
.TP
.B subnetid
(string) \- ID of the subnet to add the mount target in.
.TP
.B ipaddress
.INDENT 7.0
.TP
.B (string) \- Valid IPv4 address within the address range
of the specified subnet.
.UNINDENT
.TP
.B securitygroups
.INDENT 7.0
.TP
.B (list[string]) \- Up to five VPC security group IDs,
of the form sg\-xxxxxxxx.
These must be for the same VPC as subnet specified.
.UNINDENT
.TP
.B returns
(dict) \- A dict of the response data
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq boto_efs.create_mount_target filesystemid subnetid
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_efs.create_tags(filesystemid, tags, keyid=None, key=None, profile=None, region=None, **kwargs)
Creates or overwrites tags associated with a file system.
Each tag is a key\-value pair. If a tag key specified in the request
already exists on the file system, this operation overwrites
its value with the value provided in the request.
.INDENT 7.0
.TP
.B filesystemid
(string) \- ID of the file system for whose tags will be modified.
.TP
.B tags
(dict) \- The tags to add to the file system
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq boto_efs.create_tags
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_efs.delete_file_system(filesystemid, keyid=None, key=None, profile=None, region=None, **kwargs)
Deletes a file system, permanently severing access to its contents.
Upon return, the file system no longer exists and you can\(aqt access
any contents of the deleted file system. You can\(aqt delete a file system
that is in use. That is, if the file system has any mount targets,
you must first delete them.
.INDENT 7.0
.TP
.B filesystemid
(string) \- ID of the file system to delete.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq boto_efs.delete_file_system filesystemid
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_efs.delete_mount_target(mounttargetid, keyid=None, key=None, profile=None, region=None, **kwargs)
Deletes the specified mount target.
.sp
This operation forcibly breaks any mounts of the file system via the
mount target that is being deleted, which might disrupt instances or
applications using those mounts. To avoid applications getting cut off
abruptly, you might consider unmounting any mounts of the mount target,
if feasible. The operation also deletes the associated network interface.
Uncommitted writes may be lost, but breaking a mount target using this
operation does not corrupt the file system itself.
The file system you created remains.
You can mount an EC2 instance in your VPC via another mount target.
.INDENT 7.0
.TP
.B mounttargetid
(string) \- ID of the mount target to delete
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq boto_efs.delete_mount_target mounttargetid
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_efs.delete_tags(filesystemid, tags, keyid=None, key=None, profile=None, region=None, **kwargs)
Deletes the specified tags from a file system.
.INDENT 7.0
.TP
.B filesystemid
(string) \- ID of the file system for whose tags will be removed.
.TP
.B tags
(list[string]) \- The tag keys to delete to the file system
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq boto_efs.delete_tags
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_efs.get_file_systems(filesystemid=None, keyid=None, key=None, profile=None, region=None, creation_token=None, **kwargs)
Get all EFS properties or a specific instance property
if filesystemid is specified
.INDENT 7.0
.TP
.B filesystemid
(string) \- ID of the file system to retrieve properties
.TP
.B creation_token
(string) \- A unique token that identifies an EFS.
If fileysystem created via create_file_system this would
either be explictitly passed in or set to name.
You can limit your search with this.
.TP
.B returns
(list[dict]) \- list of all elastic file system properties
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq boto_efs.get_file_systems efs\-id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_efs.get_mount_targets(filesystemid=None, mounttargetid=None, keyid=None, key=None, profile=None, region=None, **kwargs)
Get all the EFS mount point properties for a specific filesystemid or
the properties for a specific mounttargetid. One or the other must be
specified
.INDENT 7.0
.TP
.B filesystemid
.INDENT 7.0
.TP
.B (string) \- ID of the file system whose mount targets to list
Must be specified if mounttargetid is not
.UNINDENT
.TP
.B mounttargetid
.INDENT 7.0
.TP
.B (string) \- ID of the mount target to have its properties returned
Must be specified if filesystemid is not
.UNINDENT
.TP
.B returns
(list[dict]) \- list of all mount point properties
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq boto_efs.get_mount_targets
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_efs.get_tags(filesystemid, keyid=None, key=None, profile=None, region=None, **kwargs)
Return the tags associated with an EFS instance.
.INDENT 7.0
.TP
.B filesystemid
(string) \- ID of the file system whose tags to list
.TP
.B returns
(list) \- list of tags as key/value pairs
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq boto_efs.get_tags efs\-id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_efs.set_security_groups(mounttargetid, securitygroup, keyid=None, key=None, profile=None, region=None, **kwargs)
Modifies the set of security groups in effect for a mount target
.INDENT 7.0
.TP
.B mounttargetid
(string) \- ID of the mount target whose security groups will be modified
.TP
.B securitygroups
(list[string]) \- list of no more than 5 VPC security group IDs.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq boto_efs.set_security_groups my\-mount\-target\-id my\-sec\-group
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_elasticache
.sp
Connection module for Amazon Elasticache
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit elasticache credentials but can
also utilize IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
elasticache.keyid: GKTADJGHEIQSXMKKRBJ08H
elasticache.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
elasticache.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.authorize_cache_security_group_ingress(name, ec2_security_group_name, ec2_security_group_owner_id, region=None, key=None, keyid=None, profile=None)
Authorize network ingress from an ec2 security group to a cache security
group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.authorize_cache_security_group_ingress myelasticachesg myec2sg 879879
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.create(name, num_cache_nodes=None, engine=None, cache_node_type=None, replication_group_id=None, engine_version=None, cache_parameter_group_name=None, cache_subnet_group_name=None, cache_security_group_names=None, security_group_ids=None, snapshot_arns=None, preferred_availability_zone=None, preferred_maintenance_window=None, port=None, notification_topic_arn=None, auto_minor_version_upgrade=None, wait=None, region=None, key=None, keyid=None, profile=None)
Create a cache cluster.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.create myelasticache 1 redis cache.t1.micro
cache_security_group_names=\(aq[\(dqmyelasticachesg\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.create_cache_security_group(name, description, region=None, key=None, keyid=None, profile=None)
Create a cache security group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.create_cache_security_group myelasticachesg \(aqMy Cache Security Group\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.create_replication_group(name, primary_cluster_id, replication_group_description, wait=None, region=None, key=None, keyid=None, profile=None)
Create replication group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.create_replication_group myelasticache myprimarycluster description
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.create_subnet_group(name, description, subnet_ids=None, subnet_names=None, tags=None, region=None, key=None, keyid=None, profile=None)
Create an ElastiCache subnet group
.sp
CLI example to create an ElastiCache subnet group:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.create_subnet_group my\-subnet\-group             \(dqgroup description\(dq subnet_ids=\(aq[subnet\-12345678, subnet\-87654321]\(aq             region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.delete(name, wait=False, region=None, key=None, keyid=None, profile=None)
Delete a cache cluster.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.delete myelasticache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.delete_cache_security_group(name, region=None, key=None, keyid=None, profile=None)
Delete a cache security group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.delete_cache_security_group myelasticachesg \(aqMy Cache Security Group\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.delete_replication_group(name, region=None, key=None, keyid=None, profile=None)
Delete an ElastiCache replication group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.delete_replication_group my\-replication\-group                 region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.delete_subnet_group(name, region=None, key=None, keyid=None, profile=None)
Delete an ElastiCache subnet group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.delete_subnet_group my\-subnet\-group                 region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.describe_replication_group(name, region=None, key=None, keyid=None, profile=None, parameter=None)
Get replication group information.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.describe_replication_group mygroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.exists(name, region=None, key=None, keyid=None, profile=None)
Check to see if a cache cluster exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.exists myelasticache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.get_all_cache_subnet_groups(name=None, region=None, key=None, keyid=None, profile=None)
Return a list of all cache subnet groups with details
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.get_all_subnet_groups region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.get_cache_subnet_group(name, region=None, key=None, keyid=None, profile=None)
Get information about a cache subnet group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.get_cache_subnet_group mycache_subnet_group
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.get_config(name, region=None, key=None, keyid=None, profile=None)
Get the configuration for a cache cluster.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.get_config myelasticache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.get_group_host(name, region=None, key=None, keyid=None, profile=None)
Get hostname from replication cache group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.get_group_host myelasticachegroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.get_node_host(name, region=None, key=None, keyid=None, profile=None)
Get hostname from cache node
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.get_node_host myelasticache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.group_exists(name, region=None, key=None, keyid=None, profile=None)
Check to see if a replication group exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.group_exists myelasticache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.list_cache_subnet_groups(name=None, region=None, key=None, keyid=None, profile=None)
Return a list of all cache subnet group names
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.list_subnet_groups region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.revoke_cache_security_group_ingress(name, ec2_security_group_name, ec2_security_group_owner_id, region=None, key=None, keyid=None, profile=None)
Revoke network ingress from an ec2 security group to a cache security
group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.revoke_cache_security_group_ingress myelasticachesg myec2sg 879879
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticache.subnet_group_exists(name, tags=None, region=None, key=None, keyid=None, profile=None)
Check to see if an ElastiCache subnet group exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticache.subnet_group_exists my\-param\-group                 region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_elasticsearch_domain
.sp
Connection module for Amazon Elasticsearch Service
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit AWS credentials but can also
utilize IAM roles assigned to the instance trough Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
lambda.keyid: GKTADJGHEIQSXMKKRBJ08H
lambda.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
lambda.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Create and delete methods return:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
created: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
created: false
error:
  message: error message
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Request methods (e.g., \fIdescribe_function\fP) return:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
domain:
  \- {...}
  \- {...}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
error:
  message: error message
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticsearch_domain.add_tags(DomainName=None, ARN=None, region=None, key=None, keyid=None, profile=None, **kwargs)
Add tags to a domain
.sp
Returns {tagged: true} if the domain was tagged and returns
{tagged: False} if the domain was not tagged.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticsearch_domain.add_tags mydomain tag_a=tag_value tag_b=tag_value
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticsearch_domain.create(DomainName, ElasticsearchClusterConfig=None, EBSOptions=None, AccessPolicies=None, SnapshotOptions=None, AdvancedOptions=None, region=None, key=None, keyid=None, profile=None, ElasticsearchVersion=None)
Given a valid config, create a domain.
.sp
Returns {created: true} if the domain was created and returns
{created: False} if the domain was not created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticsearch_domain.create mydomain \e
      {\(aqInstanceType\(aq: \(aqt2.micro.elasticsearch\(aq, \(aqInstanceCount\(aq: 1, \e
      \(aqDedicatedMasterEnabled\(aq: false, \(aqZoneAwarenessEnabled\(aq: false} \e
      {\(aqEBSEnabled\(aq: true, \(aqVolumeType\(aq: \(aqgp2\(aq, \(aqVolumeSize\(aq: 10, \e
      \(aqIops\(aq: 0} \e
      {\(dqVersion\(dq: \(dq2012\-10\-17\(dq, \(dqStatement\(dq: [{\(dqEffect\(dq: \(dqAllow\(dq, \(dqPrincipal\(dq: {\(dqAWS\(dq: \(dq*\(dq}, \(dqAction\(dq: \(dqes:*\(dq, \e
       \(dqResource\(dq: \(dqarn:aws:es:us\-east\-1:111111111111:domain/mydomain/*\(dq, \e
       \(dqCondition\(dq: {\(dqIpAddress\(dq: {\(dqaws:SourceIp\(dq: [\(dq127.0.0.1\(dq]}}}]} \e
      {\(dqAutomatedSnapshotStartHour\(dq: 0} \e
      {\(dqrest.action.multi.allow_explicit_index\(dq: \(dqtrue\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticsearch_domain.delete(DomainName, region=None, key=None, keyid=None, profile=None)
Given a domain name, delete it.
.sp
Returns {deleted: true} if the domain was deleted and returns
{deleted: false} if the domain was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticsearch_domain.delete mydomain
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticsearch_domain.describe(DomainName, region=None, key=None, keyid=None, profile=None)
Given a domain name describe its properties.
.sp
Returns a dictionary of interesting properties.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticsearch_domain.describe mydomain
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticsearch_domain.exists(DomainName, region=None, key=None, keyid=None, profile=None)
Given a domain name, check to see if the given domain exists.
.sp
Returns True if the given domain exists and returns False if the given
function does not exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticsearch_domain.exists mydomain
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticsearch_domain.list_tags(DomainName=None, ARN=None, region=None, key=None, keyid=None, profile=None)
List tags of a trail
.INDENT 7.0
.TP
.B Returns
.INDENT 7.0
.IP \(bu 2
{...}
.IP \(bu 2
{...}
.UNINDENT

.TP
.B Return type
tags
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudtrail.list_tags my_trail
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticsearch_domain.remove_tags(TagKeys, DomainName=None, ARN=None, region=None, key=None, keyid=None, profile=None)
Remove tags from a trail
.sp
Returns {tagged: true} if the trail was tagged and returns
{tagged: False} if the trail was not tagged.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_cloudtrail.remove_tags my_trail tag_a=tag_value tag_b=tag_value
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticsearch_domain.status(DomainName, region=None, key=None, keyid=None, profile=None)
Given a domain name describe its status.
.sp
Returns a dictionary of interesting properties.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticsearch_domain.status mydomain
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elasticsearch_domain.update(DomainName, ElasticsearchClusterConfig=None, EBSOptions=None, AccessPolicies=None, SnapshotOptions=None, AdvancedOptions=None, region=None, key=None, keyid=None, profile=None)
Update the named domain to the configuration.
.sp
Returns {updated: true} if the domain was updated and returns
{updated: False} if the domain was not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elasticsearch_domain.update mydomain \e
      {\(aqInstanceType\(aq: \(aqt2.micro.elasticsearch\(aq, \(aqInstanceCount\(aq: 1, \e
      \(aqDedicatedMasterEnabled\(aq: false, \(aqZoneAwarenessEnabled\(aq: false} \e
      {\(aqEBSEnabled\(aq: true, \(aqVolumeType\(aq: \(aqgp2\(aq, \(aqVolumeSize\(aq: 10, \e
      \(aqIops\(aq: 0} \e
      {\(dqVersion\(dq: \(dq2012\-10\-17\(dq, \(dqStatement\(dq: [{\(dqEffect\(dq: \(dqAllow\(dq, \(dqPrincipal\(dq: {\(dqAWS\(dq: \(dq*\(dq}, \(dqAction\(dq: \(dqes:*\(dq, \e
       \(dqResource\(dq: \(dqarn:aws:es:us\-east\-1:111111111111:domain/mydomain/*\(dq, \e
       \(dqCondition\(dq: {\(dqIpAddress\(dq: {\(dqaws:SourceIp\(dq: [\(dq127.0.0.1\(dq]}}}]} \e
      {\(dqAutomatedSnapshotStartHour\(dq: 0} \e
      {\(dqrest.action.multi.allow_explicit_index\(dq: \(dqtrue\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_elb
.sp
Connection module for Amazon ELB
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit elb credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
elb.keyid: GKTADJGHEIQSXMKKRBJ08H
elb.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
elb.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto >= 2.33.0
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.apply_security_groups(name, security_groups, region=None, key=None, keyid=None, profile=None)
Apply security groups to ELB.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.apply_security_groups myelb \(aq[\(dqmysecgroup1\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.attach_subnets(name, subnets, region=None, key=None, keyid=None, profile=None)
Attach ELB to subnets.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.attach_subnets myelb \(aq[\(dqmysubnet\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.create(name, availability_zones, listeners, subnets=None, security_groups=None, scheme=\(aqinternet\-facing\(aq, region=None, key=None, keyid=None, profile=None)
Create an ELB
.sp
CLI example to create an ELB:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.create myelb \(aq[\(dqus\-east\-1a\(dq, \(dqus\-east\-1e\(dq]\(aq \(aq{\(dqelb_port\(dq: 443, \(dqelb_protocol\(dq: \(dqHTTPS\(dq, ...}\(aq region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.create_listeners(name, listeners, region=None, key=None, keyid=None, profile=None)
Create listeners on an ELB.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.create_listeners myelb \(aq[[\(dqHTTPS\(dq, \(dqHTTP\(dq, 443, 80, \(dqarn:aws:iam::11  11111:server\-certificate/mycert\(dq]]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.create_policy(name, policy_name, policy_type, policy, region=None, key=None, keyid=None, profile=None)
Create an ELB policy.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.create_policy myelb mypolicy LBCookieStickinessPolicyType \(aq{\(dqCookieExpirationPeriod\(dq: 3600}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.delete(name, region=None, key=None, keyid=None, profile=None)
Delete an ELB.
.sp
CLI example to delete an ELB:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.delete myelb region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.delete_listeners(name, ports, region=None, key=None, keyid=None, profile=None)
Delete listeners on an ELB.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.delete_listeners myelb \(aq[80,443]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.delete_policy(name, policy_name, region=None, key=None, keyid=None, profile=None)
Delete an ELB policy.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.delete_policy myelb mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.delete_tags(name, tags, region=None, key=None, keyid=None, profile=None)
Add the tags on an ELB
.INDENT 7.0
.TP
.B name
name of the ELB
.TP
.B tags
list of tags to remove
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.delete_tags my\-elb\-name [\(aqTagToRemove1\(aq, \(aqTagToRemove2\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.deregister_instances(name, instances, region=None, key=None, keyid=None, profile=None)
Deregister instances with an ELB.  Instances is either a string
instance id or a list of string instance id\(aqs.
.sp
Returns:
.INDENT 7.0
.IP \(bu 2
\fBTrue\fP: instance(s) deregistered successfully
.IP \(bu 2
\fBFalse\fP: instance(s) failed to be deregistered
.IP \(bu 2
\fBNone\fP: instance(s) not valid or not registered, no action taken
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.deregister_instances myelb instance_id
salt myminion boto_elb.deregister_instances myelb \(dq[instance_id, instance_id]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.detach_subnets(name, subnets, region=None, key=None, keyid=None, profile=None)
Detach ELB from subnets.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.detach_subnets myelb \(aq[\(dqmysubnet\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.disable_availability_zones(name, availability_zones, region=None, key=None, keyid=None, profile=None)
Disable availability zones for ELB.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.disable_availability_zones myelb \(aq[\(dqus\-east\-1a\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.enable_availability_zones(name, availability_zones, region=None, key=None, keyid=None, profile=None)
Enable availability zones for ELB.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.enable_availability_zones myelb \(aq[\(dqus\-east\-1a\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.exists(name, region=None, key=None, keyid=None, profile=None)
Check to see if an ELB exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.exists myelb region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.get_all_elbs(region=None, key=None, keyid=None, profile=None)
Return all load balancers associated with an account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.get_all_elbs region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.get_attributes(name, region=None, key=None, keyid=None, profile=None)
Check to see if attributes are set on an ELB.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.get_attributes myelb
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.get_elb_config(name, region=None, key=None, keyid=None, profile=None)
Get an ELB configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.exists myelb region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.get_health_check(name, region=None, key=None, keyid=None, profile=None)
Get the health check configured for this ELB.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.get_health_check myelb
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.get_instance_health(name, region=None, key=None, keyid=None, profile=None, instances=None)
Get a list of instances and their health state
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.get_instance_health myelb
salt myminion boto_elb.get_instance_health myelb region=us\-east\-1 instances=\(dq[instance_id,instance_id]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.list_elbs(region=None, key=None, keyid=None, profile=None)
Return names of all load balancers associated with an account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.list_elbs region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.listener_dict_to_tuple(listener)
Convert an ELB listener dict into a listener tuple used by certain parts of
the AWS ELB API.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.listener_dict_to_tuple \(aq{\(dqelb_port\(dq:80,\(dqinstance_port\(dq:80,\(dqelb_protocol\(dq:\(dqHTTP\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.register_instances(name, instances, region=None, key=None, keyid=None, profile=None)
Register instances with an ELB.  Instances is either a string
instance id or a list of string instance id\(aqs.
.sp
Returns:
.INDENT 7.0
.IP \(bu 2
\fBTrue\fP: instance(s) registered successfully
.IP \(bu 2
\fBFalse\fP: instance(s) failed to be registered
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.register_instances myelb instance_id
salt myminion boto_elb.register_instances myelb \(dq[instance_id,instance_id]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.set_attributes(name, attributes, region=None, key=None, keyid=None, profile=None)
Set attributes on an ELB.
.INDENT 7.0
.TP
.B name (string)
Name of the ELB instance to set attributes for
.TP
.B attributes
A dict of attributes to set.
.sp
Valid attributes are:
.INDENT 7.0
.TP
.B access_log (dict)
.INDENT 7.0
.TP
.B enabled (bool)
Enable storage of access logs.
.TP
.B s3_bucket_name (string)
The name of the S3 bucket to place logs.
.TP
.B s3_bucket_prefix (string)
Prefix for the log file name.
.TP
.B emit_interval (int)
Interval for storing logs in S3 in minutes. Valid values are
5 and 60.
.UNINDENT
.TP
.B connection_draining (dict)
.INDENT 7.0
.TP
.B enabled (bool)
Enable connection draining.
.TP
.B timeout (int)
Maximum allowed time in seconds for sending existing
connections to an instance that is deregistering or unhealthy.
Default is 300.
.UNINDENT
.TP
.B cross_zone_load_balancing (dict)
.INDENT 7.0
.TP
.B enabled (bool)
Enable cross\-zone load balancing.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI example to set attributes on an ELB:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.set_attributes myelb \(aq{\(dqaccess_log\(dq: {\(dqenabled\(dq: \(dqtrue\(dq, \(dqs3_bucket_name\(dq: \(dqmybucket\(dq, \(dqs3_bucket_prefix\(dq: \(dqmylogs/\(dq, \(dqemit_interval\(dq: \(dq5\(dq}}\(aq region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.set_backend_policy(name, port, policies=None, region=None, key=None, keyid=None, profile=None)
Set the policies of an ELB backend server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.set_backend_policy myelb 443 \(dq[policy1,policy2]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.set_health_check(name, health_check, region=None, key=None, keyid=None, profile=None)
Set attributes on an ELB.
.sp
CLI example to set attributes on an ELB:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.set_health_check myelb \(aq{\(dqtarget\(dq: \(dqHTTP:80/\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.set_instances(name, instances, test=False, region=None, key=None, keyid=None, profile=None)
Set the instances assigned to an ELB to exactly the list given
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.set_instances myelb region=us\-east\-1 instances=\(dq[instance_id,instance_id]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.set_listener_policy(name, port, policies=None, region=None, key=None, keyid=None, profile=None)
Set the policies of an ELB listener.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.set_listener_policy myelb 443 \(dq[policy1,policy2]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elb.set_tags(name, tags, region=None, key=None, keyid=None, profile=None)
Add the tags on an ELB
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
name of the ELB
.TP
.B tags
dict of name/value pair tags
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elb.set_tags my\-elb\-name \(dq{\(aqTag1\(aq: \(aqValue\(aq, \(aqTag2\(aq: \(aqAnother Value\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_elbv2
.sp
Connection module for Amazon ALB
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit elb credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
elbv2.keyid: GKTADJGHEIQSXMKKRBJ08H
elbv2.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
elbv2.region: us\-west\-2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elbv2.create_target_group(name, protocol, port, vpc_id, region=None, key=None, keyid=None, profile=None, health_check_protocol=\(aqHTTP\(aq, health_check_port=\(aqtraffic\-port\(aq, health_check_path=\(aq/\(aq, health_check_interval_seconds=30, health_check_timeout_seconds=5, healthy_threshold_count=5, unhealthy_threshold_count=2)
Create target group if not present.
.INDENT 7.0
.TP
.B name
(string) \- The name of the target group.
.TP
.B protocol
(string) \- The protocol to use for routing traffic to the targets
.TP
.B port
(int) \- The port on which the targets receive traffic. This port is used unless
you specify a port override when registering the traffic.
.TP
.B vpc_id
(string) \- The identifier of the virtual private cloud (VPC).
.TP
.B health_check_protocol
(string) \- The protocol the load balancer uses when performing health check on
targets. The default is the HTTP protocol.
.TP
.B health_check_port
(string) \- The port the load balancer uses when performing health checks on
targets. The default is \(aqtraffic\-port\(aq, which indicates the port on which each
target receives traffic from the load balancer.
.TP
.B health_check_path
(string) \- The ping path that is the destination on the targets for health
checks. The default is /.
.TP
.B health_check_interval_seconds
(integer) \- The approximate amount of time, in seconds, between health checks
of an individual target. The default is 30 seconds.
.TP
.B health_check_timeout_seconds
(integer) \- The amount of time, in seconds, during which no response from a
target means a failed health check. The default is 5 seconds.
.TP
.B healthy_threshold_count
(integer) \- The number of consecutive health checks successes required before
considering an unhealthy target healthy. The default is 5.
.TP
.B unhealthy_threshold_count
(integer) \- The number of consecutive health check failures required before
considering a target unhealthy. The default is 2.
.TP
.B returns
(bool) \- True on success, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elbv2.create_target_group learn1give1 protocol=HTTP port=54006 vpc_id=vpc\-deadbeef
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elbv2.delete_target_group(name, region=None, key=None, keyid=None, profile=None)
Delete target group.
.INDENT 7.0
.TP
.B name
(string) \- Target Group Name or Amazon Resource Name (ARN).
.TP
.B returns
(bool) \- True on success, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elbv2.delete_target_group arn:aws:elasticloadbalancing:us\-west\-2:644138682826:targetgroup/learn1give1\-api/414788a16b5cf163
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elbv2.deregister_targets(name, targets, region=None, key=None, keyid=None, profile=None)
Deregister targets to a target froup of an ALB. \fBtargets\fP is either a
instance id string or a list of instance id\(aqs.
.sp
Returns:
.INDENT 7.0
.IP \(bu 2
\fBTrue\fP: instance(s) deregistered successfully
.IP \(bu 2
\fBFalse\fP: instance(s) failed to be deregistered
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elbv2.deregister_targets myelb instance_id
salt myminion boto_elbv2.deregister_targets myelb \(dq[instance_id,instance_id]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elbv2.describe_target_health(name, targets=None, region=None, key=None, keyid=None, profile=None)
Get the curret health check status for targets in a target group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elbv2.describe_target_health arn:aws:elasticloadbalancing:us\-west\-2:644138682826:targetgroup/learn1give1\-api/414788a16b5cf163 targets=[\(dqi\-isdf23ifjf\(dq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elbv2.register_targets(name, targets, region=None, key=None, keyid=None, profile=None)
Register targets to a target froup of an ALB. \fBtargets\fP is either a
instance id string or a list of instance id\(aqs.
.sp
Returns:
.INDENT 7.0
.IP \(bu 2
\fBTrue\fP: instance(s) registered successfully
.IP \(bu 2
\fBFalse\fP: instance(s) failed to be registered
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elbv2.register_targets myelb instance_id
salt myminion boto_elbv2.register_targets myelb \(dq[instance_id,instance_id]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_elbv2.target_group_exists(name, region=None, key=None, keyid=None, profile=None)
Check to see if an target group exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_elbv2.target_group_exists arn:aws:elasticloadbalancing:us\-west\-2:644138682826:targetgroup/learn1give1\-api/414788a16b5cf163
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_iam
.sp
Connection module for Amazon IAM
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit iam credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
iam.keyid: GKTADJGHEIQSXMKKRBJ08H
iam.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
iam.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.add_user_to_group(user_name, group_name, region=None, key=None, keyid=None, profile=None)
Add user to group.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.add_user_to_group myuser mygroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.associate_profile_to_role(profile_name, role_name, region=None, key=None, keyid=None, profile=None)
Associate an instance profile with an IAM role.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.associate_profile_to_role myirole myiprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.attach_group_policy(policy_name, group_name, region=None, key=None, keyid=None, profile=None)
Attach a managed policy to a group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.attach_group_policy mypolicy mygroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.attach_role_policy(policy_name, role_name, region=None, key=None, keyid=None, profile=None)
Attach a managed policy to a role.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.attach_role_policy mypolicy myrole
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.attach_user_policy(policy_name, user_name, region=None, key=None, keyid=None, profile=None)
Attach a managed policy to a user.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.attach_user_policy mypolicy myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.build_policy(region=None, key=None, keyid=None, profile=None)
Build a default assume role policy.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.build_policy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.create_access_key(user_name, region=None, key=None, keyid=None, profile=None)
Create access key id for a user.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.create_access_key myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.create_group(group_name, path=None, region=None, key=None, keyid=None, profile=None)
Create a group.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.create_group group
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.create_instance_profile(name, region=None, key=None, keyid=None, profile=None)
Create an instance profile.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.create_instance_profile myiprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.create_login_profile(user_name, password, region=None, key=None, keyid=None, profile=None)
Creates a login profile for the specified user, give the user the
ability to access AWS services and the AWS Management Console.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.create_login_profile user_name password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.create_policy(policy_name, policy_document, path=None, description=None, region=None, key=None, keyid=None, profile=None)
Create a policy.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminios boto_iam.create_policy mypolicy \(aq{\(dqVersion\(dq: \(dq2012\-10\-17\(dq, \(dqStatement\(dq: [{ \(dqEffect\(dq: \(dqAllow\(dq, \(dqAction\(dq: [\(dqs3:Get*\(dq, \(dqs3:List*\(dq], \(dqResource\(dq: [\(dqarn:aws:s3:::my\-bucket/shared/*\(dq]},]}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.create_policy_version(policy_name, policy_document, set_as_default=None, region=None, key=None, keyid=None, profile=None)
Create a policy version.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminios boto_iam.create_policy_version mypolicy \(aq{\(dqVersion\(dq: \(dq2012\-10\-17\(dq, \(dqStatement\(dq: [{ \(dqEffect\(dq: \(dqAllow\(dq, \(dqAction\(dq: [\(dqs3:Get*\(dq, \(dqs3:List*\(dq], \(dqResource\(dq: [\(dqarn:aws:s3:::my\-bucket/shared/*\(dq]},]}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.create_role(name, policy_document=None, path=None, region=None, key=None, keyid=None, profile=None)
Create an instance role.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.create_role myrole
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.create_role_policy(role_name, policy_name, policy, region=None, key=None, keyid=None, profile=None)
Create or modify a role policy.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.create_role_policy myirole mypolicy \(aq{\(dqMyPolicy\(dq: \(dqStatement\(dq: [{\(dqAction\(dq: [\(dqsqs:*\(dq], \(dqEffect\(dq: \(dqAllow\(dq, \(dqResource\(dq: [\(dqarn:aws:sqs:*:*:*\(dq], \(dqSid\(dq: \(dqMyPolicySqs1\(dq}]}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.create_saml_provider(name, saml_metadata_document, region=None, key=None, keyid=None, profile=None)
Create SAML provider
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.create_saml_provider my_saml_provider_name saml_metadata_document
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.create_user(user_name, path=None, region=None, key=None, keyid=None, profile=None)
Create a user.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.create_user myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.deactivate_mfa_device(user_name, serial, region=None, key=None, keyid=None, profile=None)
Deactivates the specified MFA device and removes it from association with
the user.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.deactivate_mfa_device user_name serial_num
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.delete_access_key(access_key_id, user_name=None, region=None, key=None, keyid=None, profile=None)
Delete access key id from a user.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.delete_access_key myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.delete_group(group_name, region=None, key=None, keyid=None, profile=None)
Delete a group policy.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.delete_group mygroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.delete_group_policy(group_name, policy_name, region=None, key=None, keyid=None, profile=None)
Delete a group policy.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.delete_group_policy mygroup mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.delete_instance_profile(name, region=None, key=None, keyid=None, profile=None)
Delete an instance profile.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.delete_instance_profile myiprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.delete_login_profile(user_name, region=None, key=None, keyid=None, profile=None)
Deletes a login profile for the specified user.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.delete_login_profile user_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.delete_policy(policy_name, region=None, key=None, keyid=None, profile=None)
Delete a policy.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.delete_policy mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.delete_policy_version(policy_name, version_id, region=None, key=None, keyid=None, profile=None)
Delete a policy version.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.delete_policy_version mypolicy v1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.delete_role(name, region=None, key=None, keyid=None, profile=None)
Delete an IAM role.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.delete_role myirole
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.delete_role_policy(role_name, policy_name, region=None, key=None, keyid=None, profile=None)
Delete a role policy.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.delete_role_policy myirole mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.delete_saml_provider(name, region=None, key=None, keyid=None, profile=None)
Delete SAML provider
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.delete_saml_provider my_saml_provider_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.delete_server_cert(cert_name, region=None, key=None, keyid=None, profile=None)
Deletes a certificate from Amazon.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.delete_server_cert mycert_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.delete_user(user_name, region=None, key=None, keyid=None, profile=None)
Delete a user.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.delete_user myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.delete_user_policy(user_name, policy_name, region=None, key=None, keyid=None, profile=None)
Delete a user policy.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.delete_user_policy myuser mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.delete_virtual_mfa_device(serial, region=None, key=None, keyid=None, profile=None)
Deletes the specified virtual MFA device.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.delete_virtual_mfa_device serial_num
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.describe_role(name, region=None, key=None, keyid=None, profile=None)
Get information for a role.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.describe_role myirole
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.detach_group_policy(policy_name, group_name, region=None, key=None, keyid=None, profile=None)
Detach a managed policy to a group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.detach_group_policy mypolicy mygroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.detach_role_policy(policy_name, role_name, region=None, key=None, keyid=None, profile=None)
Detach a managed policy to a role.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.detach_role_policy mypolicy myrole
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.detach_user_policy(policy_name, user_name, region=None, key=None, keyid=None, profile=None)
Detach a managed policy to a user.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.detach_user_policy mypolicy myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.disassociate_profile_from_role(profile_name, role_name, region=None, key=None, keyid=None, profile=None)
Disassociate an instance profile from an IAM role.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.disassociate_profile_from_role myirole myiprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.export_roles(path_prefix=\(aq/\(aq, region=None, key=None, keyid=None, profile=None)
Get all IAM role details. Produces results that can be used to create an
sls file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_iam.export_roles \-\-out=txt | sed \(dqs/local: //\(dq > iam_roles.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.export_users(path_prefix=\(aq/\(aq, region=None, key=None, keyid=None, profile=None)
Get all IAM user details. Produces results that can be used to create an
sls file.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_iam.export_users \-\-out=txt | sed \(dqs/local: //\(dq > iam_users.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_account_id(region=None, key=None, keyid=None, profile=None)
Get a the AWS account id associated with the used credentials.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.get_account_id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_account_policy(region=None, key=None, keyid=None, profile=None)
Get account policy for the AWS account.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.get_account_policy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_all_access_keys(user_name, marker=None, max_items=None, region=None, key=None, keyid=None, profile=None)
Get all access keys from a user.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.get_all_access_keys myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_all_group_policies(group_name, region=None, key=None, keyid=None, profile=None)
Get a list of policy names from a group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.get_all_group_policies mygroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_all_groups(path_prefix=\(aq/\(aq, region=None, key=None, keyid=None, profile=None)
Get and return all IAM group details, starting at the optional path.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_iam.get_all_groups
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_all_instance_profiles(path_prefix=\(aq/\(aq, region=None, key=None, keyid=None, profile=None)
Get and return all IAM instance profiles, starting at the optional path.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_iam.get_all_instance_profiles
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_all_mfa_devices(user_name, region=None, key=None, keyid=None, profile=None)
Get all MFA devices associated with an IAM user.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.get_all_mfa_devices user_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_all_roles(path_prefix=None, region=None, key=None, keyid=None, profile=None)
Get and return all IAM role details, starting at the optional path.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_iam.get_all_roles
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_all_user_policies(user_name, marker=None, max_items=None, region=None, key=None, keyid=None, profile=None)
Get all user policies.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.get_all_user_policies myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_all_users(path_prefix=\(aq/\(aq, region=None, key=None, keyid=None, profile=None)
Get and return all IAM user details, starting at the optional path.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_iam.get_all_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_group(group_name, region=None, key=None, keyid=None, profile=None)
Get group information.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.get_group mygroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_group_members(group_name, region=None, key=None, keyid=None, profile=None)
Get group information.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.get_group mygroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_group_policy(group_name, policy_name, region=None, key=None, keyid=None, profile=None)
Retrieves the specified policy document for the specified group.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.get_group_policy mygroup policyname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_policy(policy_name, region=None, key=None, keyid=None, profile=None)
Check to see if policy exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.instance_profile_exists myiprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_policy_version(policy_name, version_id, region=None, key=None, keyid=None, profile=None)
Check to see if policy exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.instance_profile_exists myiprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_role_policy(role_name, policy_name, region=None, key=None, keyid=None, profile=None)
Get a role policy.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.get_role_policy myirole mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_saml_provider(name, region=None, key=None, keyid=None, profile=None)
Get SAML provider document.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.get_saml_provider arn
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_saml_provider_arn(name, region=None, key=None, keyid=None, profile=None)
Get SAML provider
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.get_saml_provider_arn my_saml_provider_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_server_certificate(cert_name, region=None, key=None, keyid=None, profile=None)
Returns certificate information from Amazon
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.get_server_certificate mycert_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_user(user_name=None, region=None, key=None, keyid=None, profile=None)
Get user information.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.get_user myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.get_user_policy(user_name, policy_name, region=None, key=None, keyid=None, profile=None)
Retrieves the specified policy document for the specified user.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.get_user_policy myuser mypolicyname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.instance_profile_exists(name, region=None, key=None, keyid=None, profile=None)
Check to see if an instance profile exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.instance_profile_exists myiprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.list_attached_group_policies(group_name, path_prefix=None, entity_filter=None, region=None, key=None, keyid=None, profile=None)
List entities attached to the given group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.list_entities_for_policy mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.list_attached_role_policies(role_name, path_prefix=None, entity_filter=None, region=None, key=None, keyid=None, profile=None)
List entities attached to the given role.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.list_entities_for_policy mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.list_attached_user_policies(user_name, path_prefix=None, entity_filter=None, region=None, key=None, keyid=None, profile=None)
List entities attached to the given user.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.list_entities_for_policy mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.list_entities_for_policy(policy_name, path_prefix=None, entity_filter=None, region=None, key=None, keyid=None, profile=None)
List entities that a policy is attached to.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.list_entities_for_policy mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.list_instance_profiles(path_prefix=\(aq/\(aq, region=None, key=None, keyid=None, profile=None)
List all IAM instance profiles, starting at the optional path.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_iam.list_instance_profiles
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.list_policies(region=None, key=None, keyid=None, profile=None)
List policies.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.list_policies
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.list_policy_versions(policy_name, region=None, key=None, keyid=None, profile=None)
List versions of a policy.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.list_policy_versions mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.list_role_policies(role_name, region=None, key=None, keyid=None, profile=None)
Get a list of policy names from a role.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.list_role_policies myirole
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.list_saml_providers(region=None, key=None, keyid=None, profile=None)
List SAML providers.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.list_saml_providers
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.policy_exists(policy_name, region=None, key=None, keyid=None, profile=None)
Check to see if policy exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.instance_profile_exists myiprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.policy_version_exists(policy_name, version_id, region=None, key=None, keyid=None, profile=None)
Check to see if policy exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.instance_profile_exists myiprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.profile_associated(role_name, profile_name, region, key, keyid, profile)
Check to see if an instance profile is associated with an IAM role.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.profile_associated myirole myiprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.put_group_policy(group_name, policy_name, policy_json, region=None, key=None, keyid=None, profile=None)
Adds or updates the specified policy document for the specified group.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.put_group_policy mygroup policyname policyrules
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.put_user_policy(user_name, policy_name, policy_json, region=None, key=None, keyid=None, profile=None)
Adds or updates the specified policy document for the specified user.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.put_user_policy myuser policyname policyrules
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.remove_user_from_group(group_name, user_name, region=None, key=None, keyid=None, profile=None)
Remove user from group.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.remove_user_from_group mygroup myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.role_exists(name, region=None, key=None, keyid=None, profile=None)
Check to see if an IAM role exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.role_exists myirole
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.set_default_policy_version(policy_name, version_id, region=None, key=None, keyid=None, profile=None)
Set the default version of  a policy.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.set_default_policy_version mypolicy v1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.update_account_password_policy(allow_users_to_change_password=None, hard_expiry=None, max_password_age=None, minimum_password_length=None, password_reuse_prevention=None, require_lowercase_characters=None, require_numbers=None, require_symbols=None, require_uppercase_characters=None, region=None, key=None, keyid=None, profile=None)
Update the password policy for the AWS account.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.update_account_password_policy True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.update_assume_role_policy(role_name, policy_document, region=None, key=None, keyid=None, profile=None)
Update an assume role policy for a role.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.update_assume_role_policy myrole \(aq{\(dqStatement\(dq:\(dq...\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.update_saml_provider(name, saml_metadata_document, region=None, key=None, keyid=None, profile=None)
Update SAML provider.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.update_saml_provider my_saml_provider_name saml_metadata_document
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.upload_server_cert(cert_name, cert_body, private_key, cert_chain=None, path=None, region=None, key=None, keyid=None, profile=None)
Upload a certificate to Amazon.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.upload_server_cert mycert_name crt priv_key
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcert_name\fP \-\- The name for the server certificate. Do not include the path in this value.
.IP \(bu 2
\fBcert_body\fP \-\- The contents of the public key certificate in PEM\-encoded format.
.IP \(bu 2
\fBprivate_key\fP \-\- The contents of the private key in PEM\-encoded format.
.IP \(bu 2
\fBcert_chain\fP \-\- The contents of the certificate chain. This is typically a concatenation of the PEM\-encoded public key certificates of the chain.
.IP \(bu 2
\fBpath\fP \-\- The path for the server certificate.
.IP \(bu 2
\fBregion\fP \-\- The name of the region to connect to.
.IP \(bu 2
\fBkey\fP \-\- The key to be used in order to connect
.IP \(bu 2
\fBkeyid\fP \-\- The keyid to be used in order to connect
.IP \(bu 2
\fBprofile\fP \-\- The profile that contains a dict of region, key, keyid
.UNINDENT
.TP
.B Returns
True / False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iam.user_exists_in_group(user_name, group_name, region=None, key=None, keyid=None, profile=None)
Check if user exists in group.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iam.user_exists_in_group myuser mygroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_iot
.sp
Connection module for Amazon IoT
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
boto
.IP \(bu 2
boto3
.UNINDENT
.UNINDENT
.sp
The dependencies listed above can be installed via package or pip.
.INDENT 0.0
.TP
.B configuration
This module accepts explicit Lambda credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
iot.keyid: GKTADJGHEIQSXMKKRBJ08H
iot.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
iot.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
  region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.attach_principal_policy(policyName, principal, region=None, key=None, keyid=None, profile=None)
Attach the specified policy to the specified principal (certificate or other
credential.)
.sp
Returns {attached: true} if the policy was attached
{attached: False} if the policy was not attached.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.attach_principal_policy mypolicy mycognitoID
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.create_policy(policyName, policyDocument, region=None, key=None, keyid=None, profile=None)
Given a valid config, create a policy.
.sp
Returns {created: true} if the policy was created and returns
{created: False} if the policy was not created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.create_policy my_policy \e
      \(aq{\(dqVersion\(dq:\(dq2015\-12\-12\(dq,\e
      \(dqStatement\(dq:[{\(dqEffect\(dq:\(dqAllow\(dq,\e
                    \(dqAction\(dq:[\(dqiot:Publish\(dq],\e
                    \(dqResource\(dq:[\(dqarn:::::topic/foo/bar\(dq]}]}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.create_policy_version(policyName, policyDocument, setAsDefault=False, region=None, key=None, keyid=None, profile=None)
Given a valid config, create a new version of a policy.
.sp
Returns {created: true} if the policy version was created and returns
{created: False} if the policy version was not created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.create_policy_version my_policy \e
       \(aq{\(dqStatement\(dq:[{\(dqEffect\(dq:\(dqAllow\(dq,\(dqAction\(dq:[\(dqiot:Publish\(dq],\(dqResource\(dq:[\(dqarn:::::topic/foo/bar\(dq]}]}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.create_thing_type(thingTypeName, thingTypeDescription, searchableAttributesList, region=None, key=None, keyid=None, profile=None)
Given a valid config, create a thing type.
.sp
Returns {created: true} if the thing type was created and returns
{created: False} if the thing type was not created.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.create_thing_type mythingtype \e
      thingtype_description_string \(aq[\(dqsearchable_attr_1\(dq, \(dqsearchable_attr_2\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.create_topic_rule(ruleName, sql, actions, description, ruleDisabled=False, region=None, key=None, keyid=None, profile=None)
Given a valid config, create a topic rule.
.sp
Returns {created: true} if the rule was created and returns
{created: False} if the rule was not created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.create_topic_rule my_rule \(dqSELECT * FROM \(aqsome/thing\(aq\(dq \e
    \(aq[{\(dqlambda\(dq:{\(dqfunctionArn\(dq:\(dqarn:::::something\(dq}},{\(dqsns\(dq:{\e
    \(dqtargetArn\(dq:\(dqarn:::::something\(dq,\(dqroleArn\(dq:\(dqarn:::::something\(dq}}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.delete_policy(policyName, region=None, key=None, keyid=None, profile=None)
Given a policy name, delete it.
.sp
Returns {deleted: true} if the policy was deleted and returns
{deleted: false} if the policy was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.delete_policy mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.delete_policy_version(policyName, policyVersionId, region=None, key=None, keyid=None, profile=None)
Given a policy name and version, delete it.
.sp
Returns {deleted: true} if the policy version was deleted and returns
{deleted: false} if the policy version was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.delete_policy_version mypolicy version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.delete_thing_type(thingTypeName, region=None, key=None, keyid=None, profile=None)
Given a thing type name, delete it.
.sp
Returns {deleted: true} if the thing type was deleted and returns
{deleted: false} if the thing type was not deleted.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.delete_thing_type mythingtype
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.delete_topic_rule(ruleName, region=None, key=None, keyid=None, profile=None)
Given a rule name, delete it.
.sp
Returns {deleted: true} if the rule was deleted and returns
{deleted: false} if the rule was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.delete_rule myrule
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.deprecate_thing_type(thingTypeName, undoDeprecate=False, region=None, key=None, keyid=None, profile=None)
Given a thing type name, deprecate it when undoDeprecate is False
and undeprecate it when undoDeprecate is True.
.sp
Returns {deprecated: true} if the thing type was deprecated and returns
{deprecated: false} if the thing type was not deprecated.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.deprecate_thing_type mythingtype
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.describe_policy(policyName, region=None, key=None, keyid=None, profile=None)
Given a policy name describe its properties.
.sp
Returns a dictionary of interesting properties.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.describe_policy mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.describe_policy_version(policyName, policyVersionId, region=None, key=None, keyid=None, profile=None)
Given a policy name and version describe its properties.
.sp
Returns a dictionary of interesting properties.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.describe_policy_version mypolicy version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.describe_thing_type(thingTypeName, region=None, key=None, keyid=None, profile=None)
Given a thing type name describe its properties.
.sp
Returns a dictionary of interesting properties.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.describe_thing_type mythingtype
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.describe_topic_rule(ruleName, region=None, key=None, keyid=None, profile=None)
Given a topic rule name describe its properties.
.sp
Returns a dictionary of interesting properties.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.describe_topic_rule myrule
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.detach_principal_policy(policyName, principal, region=None, key=None, keyid=None, profile=None)
Detach the specified policy from the specified principal (certificate or other
credential.)
.sp
Returns {detached: true} if the policy was detached
{detached: False} if the policy was not detached.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.detach_principal_policy mypolicy mycognitoID
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.list_policies(region=None, key=None, keyid=None, profile=None)
List all policies
.sp
Returns list of policies
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.list_policies
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example Return:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
policies:
  \- {...}
  \- {...}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.list_policy_versions(policyName, region=None, key=None, keyid=None, profile=None)
List the versions available for the given policy.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.list_policy_versions mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example Return:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
policyVersions:
  \- {...}
  \- {...}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.list_principal_policies(principal, region=None, key=None, keyid=None, profile=None)
List the policies attached to the given principal.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.list_principal_policies myprincipal
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example Return:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
policies:
  \- {...}
  \- {...}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.list_topic_rules(topic=None, ruleDisabled=None, region=None, key=None, keyid=None, profile=None)
List all rules (for a given topic, if specified)
.sp
Returns list of rules
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.list_topic_rules
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example Return:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
rules:
  \- {...}
  \- {...}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.policy_exists(policyName, region=None, key=None, keyid=None, profile=None)
Given a policy name, check to see if the given policy exists.
.sp
Returns True if the given policy exists and returns False if the given
policy does not exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.policy_exists mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.policy_version_exists(policyName, policyVersionId, region=None, key=None, keyid=None, profile=None)
Given a policy name and version ID, check to see if the given policy version exists.
.sp
Returns True if the given policy version exists and returns False if the given
policy version does not exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.policy_version_exists mypolicy versionid
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.replace_topic_rule(ruleName, sql, actions, description, ruleDisabled=False, region=None, key=None, keyid=None, profile=None)
Given a valid config, replace a topic rule with the new values.
.sp
Returns {created: true} if the rule was created and returns
{created: False} if the rule was not created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.replace_topic_rule my_rule \(aqSELECT * FROM some.thing\(aq \e
    \(aq[{\(dqlambda\(dq:{\(dqfunctionArn\(dq:\(dqarn:::::something\(dq}},{\(dqsns\(dq:{\e
    \(dqtargetArn\(dq:\(dqarn:::::something\(dq,\(dqroleArn\(dq:\(dqarn:::::something\(dq}}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.set_default_policy_version(policyName, policyVersionId, region=None, key=None, keyid=None, profile=None)
Sets the specified version of the specified policy as the policy\(aqs default
(operative) version. This action affects all certificates that the policy is
attached to.
.sp
Returns {changed: true} if the policy version was set
{changed: False} if the policy version was not set.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.set_default_policy_version mypolicy versionid
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.thing_type_exists(thingTypeName, region=None, key=None, keyid=None, profile=None)
Given a thing type name, check to see if the given thing type exists
.sp
Returns True if the given thing type exists and returns False if the
given thing type does not exist.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.thing_type_exists mythingtype
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_iot.topic_rule_exists(ruleName, region=None, key=None, keyid=None, profile=None)
Given a rule name, check to see if the given rule exists.
.sp
Returns True if the given rule exists and returns False if the given
rule does not exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_iot.topic_rule_exists myrule
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_kinesis
.sp
Connection module for Amazon Kinesis
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit Kinesis credentials but can also
utilize IAM roles assigned to the instance trough Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
kinesis.keyid: GKTADJGHEIQSXMKKRBJ08H
kinesis.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
kinesis.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kinesis.create_stream(stream_name, num_shards, region=None, key=None, keyid=None, profile=None)
Create a stream with name stream_name and initial number of shards num_shards.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kinesis.create_stream my_stream N region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kinesis.decrease_stream_retention_period(stream_name, retention_hours, region=None, key=None, keyid=None, profile=None)
Decrease stream retention period to retention_hours
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kinesis.decrease_stream_retention_period my_stream N region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kinesis.delete_stream(stream_name, region=None, key=None, keyid=None, profile=None)
Delete the stream with name stream_name. This cannot be undone! All data will be lost!!
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kinesis.delete_stream my_stream region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kinesis.disable_enhanced_monitoring(stream_name, metrics, region=None, key=None, keyid=None, profile=None)
Disable enhanced monitoring for the specified shard\-level metrics on stream stream_name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kinesis.disable_enhanced_monitoring my_stream [\(dqmetrics\(dq, \(dqto\(dq, \(dqdisable\(dq] region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kinesis.enable_enhanced_monitoring(stream_name, metrics, region=None, key=None, keyid=None, profile=None)
Enable enhanced monitoring for the specified shard\-level metrics on stream stream_name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kinesis.enable_enhanced_monitoring my_stream [\(dqmetrics\(dq, \(dqto\(dq, \(dqenable\(dq] region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kinesis.exists(stream_name, region=None, key=None, keyid=None, profile=None)
Check if the stream exists. Returns False and the error if it does not.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kinesis.exists my_stream region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kinesis.get_info_for_reshard(stream_details)
Collect some data: number of open shards, key range, etc.
Modifies stream_details to add a sorted list of OpenShards.
Returns (min_hash_key, max_hash_key, stream_details)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kinesis.get_info_for_reshard existing_stream_details
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kinesis.get_stream_when_active(stream_name, region=None, key=None, keyid=None, profile=None)
Get complete stream info from AWS, returning only when the stream is in the ACTIVE state.
Continues to retry when stream is updating or creating.
If the stream is deleted during retries, the loop will catch the error and break.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kinesis.get_stream_when_active my_stream region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kinesis.increase_stream_retention_period(stream_name, retention_hours, region=None, key=None, keyid=None, profile=None)
Increase stream retention period to retention_hours
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kinesis.increase_stream_retention_period my_stream N region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kinesis.list_streams(region=None, key=None, keyid=None, profile=None)
Return a list of all streams visible to the current account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kinesis.list_streams
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kinesis.long_int(hash_key)
The hash key is a 128\-bit int, sent as a string.
It\(aqs necessary to convert to int/long for comparison operations.
This helper method handles python 2/3 incompatibility
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kinesis.long_int some_MD5_hash_as_string
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
long object if python 2.X, int object if python 3.X
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kinesis.reshard(stream_name, desired_size, force=False, region=None, key=None, keyid=None, profile=None)
Reshard a kinesis stream.  Each call to this function will wait until the stream is ACTIVE,
then make a single split or merge operation. This function decides where to split or merge
with the assumption that the ultimate goal is a balanced partition space.
.sp
For safety, user must past in force=True; otherwise, the function will dry run.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kinesis.reshard my_stream N True region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
True if a split or merge was found/performed, False if nothing is needed
.UNINDENT
.UNINDENT
.SS salt.modules.boto_kms
.sp
Connection module for Amazon KMS
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit kms credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
kms.keyid: GKTADJGHEIQSXMKKRBJ08H
kms.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
kms.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B myprofile:
keyid: GKTADJGHEIQSXMKKRBJ08H
key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
region: us\-east\-1
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B depends
boto
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.create_alias(alias_name, target_key_id, region=None, key=None, keyid=None, profile=None)
Create a display name for a key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.create_alias \(aqalias/mykey\(aq key_id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.create_grant(key_id, grantee_principal, retiring_principal=None, operations=None, constraints=None, grant_tokens=None, region=None, key=None, keyid=None, profile=None)
Adds a grant to a key to specify who can access the key and under what
conditions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.create_grant \(aqalias/mykey\(aq \(aqarn:aws:iam::1111111:/role/myrole\(aq operations=\(aq[\(dqEncrypt\(dq,\(dqDecrypt\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.create_key(policy=None, description=None, key_usage=None, region=None, key=None, keyid=None, profile=None)
Creates a master key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.create_key \(aq{\(dqStatement\(dq:...}\(aq \(dqMy master key\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.decrypt(ciphertext_blob, encryption_context=None, grant_tokens=None, region=None, key=None, keyid=None, profile=None)
Decrypt ciphertext.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.decrypt encrypted_ciphertext
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.describe_key(key_id, region=None, key=None, keyid=None, profile=None)
Get detailed information about a key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.describe_key \(aqalias/mykey\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.disable_key(key_id, region=None, key=None, keyid=None, profile=None)
Mark key as disabled.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.disable_key \(aqalias/mykey\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.disable_key_rotation(key_id, region=None, key=None, keyid=None, profile=None)
Disable key rotation for specified key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.disable_key_rotation \(aqalias/mykey\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.enable_key(key_id, region=None, key=None, keyid=None, profile=None)
Mark key as enabled.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.enable_key \(aqalias/mykey\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.enable_key_rotation(key_id, region=None, key=None, keyid=None, profile=None)
Disable key rotation for specified key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.enable_key_rotation \(aqalias/mykey\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.encrypt(key_id, plaintext, encryption_context=None, grant_tokens=None, region=None, key=None, keyid=None, profile=None)
Encrypt plaintext into cipher text using specified key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.encrypt \(aqalias/mykey\(aq \(aqmyplaindata\(aq \(aq{\(dqaws:username\(dq:\(dqmyuser\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.generate_data_key(key_id, encryption_context=None, number_of_bytes=None, key_spec=None, grant_tokens=None, region=None, key=None, keyid=None, profile=None)
Generate a secure data key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.generate_data_key \(aqalias/mykey\(aq number_of_bytes=1024 key_spec=AES_128
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.generate_data_key_without_plaintext(key_id, encryption_context=None, number_of_bytes=None, key_spec=None, grant_tokens=None, region=None, key=None, keyid=None, profile=None)
Generate a secure data key without a plaintext copy of the key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.generate_data_key_without_plaintext \(aqalias/mykey\(aq number_of_bytes=1024 key_spec=AES_128
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.generate_random(number_of_bytes=None, region=None, key=None, keyid=None, profile=None)
Generate a random string.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.generate_random number_of_bytes=1024
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.get_key_policy(key_id, policy_name, region=None, key=None, keyid=None, profile=None)
Get the policy for the specified key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.get_key_policy \(aqalias/mykey\(aq mypolicy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.get_key_rotation_status(key_id, region=None, key=None, keyid=None, profile=None)
Get status of whether or not key rotation is enabled for a key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.get_key_rotation_status \(aqalias/mykey\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.key_exists(key_id, region=None, key=None, keyid=None, profile=None)
Check for the existence of a key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.key_exists \(aqalias/mykey\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.list_grants(key_id, limit=None, marker=None, region=None, key=None, keyid=None, profile=None)
List grants for the specified key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.list_grants \(aqalias/mykey\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.list_key_policies(key_id, limit=None, marker=None, region=None, key=None, keyid=None, profile=None)
List key_policies for the specified key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.list_key_policies \(aqalias/mykey\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.put_key_policy(key_id, policy_name, policy, region=None, key=None, keyid=None, profile=None)
Attach a key policy to the specified key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.put_key_policy \(aqalias/mykey\(aq default \(aq{\(dqStatement\(dq:...}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.re_encrypt(ciphertext_blob, destination_key_id, source_encryption_context=None, destination_encryption_context=None, grant_tokens=None, region=None, key=None, keyid=None, profile=None)
Reencrypt encrypted data with a new master key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.re_encrypt \(aqencrypted_data\(aq \(aqalias/mynewkey\(aq default \(aq{\(dqStatement\(dq:...}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.revoke_grant(key_id, grant_id, region=None, key=None, keyid=None, profile=None)
Revoke a grant from a key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.revoke_grant \(aqalias/mykey\(aq 8u89hf\-j09j...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_kms.update_key_description(key_id, description, region=None, key=None, keyid=None, profile=None)
Update a key\(aqs description.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_kms.update_key_description \(aqalias/mykey\(aq \(aqMy key\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_lambda
.sp
Connection module for Amazon Lambda
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B depends
.UNINDENT
.INDENT 0.0
.IP \(bu 2
boto
.IP \(bu 2
boto3
.UNINDENT
.sp
The dependencies listed above can be installed via package or pip.
.INDENT 0.0
.TP
.B configuration
This module accepts explicit Lambda credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available \fI\%here\fP\&.
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lambda.keyid: GKTADJGHEIQSXMKKRBJ08H
lambda.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lambda.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.0: All methods now return a dictionary. Create and delete methods return:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
created: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
created: false
error:
  message: error message
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Request methods (e.g., \fIdescribe_function\fP) return:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
function:
  \- {...}
  \- {...}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
error:
  message: error message
.ft P
.fi
.UNINDENT
.UNINDENT

.INDENT 0.0
.TP
.B salt.modules.boto_lambda.add_permission(FunctionName, StatementId, Action, Principal, SourceArn=None, SourceAccount=None, Qualifier=None, region=None, key=None, keyid=None, profile=None)
Add a permission to a lambda function.
.sp
Returns {added: true} if the permission was added and returns
{added: False} if the permission was not added.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lamba.add_permission my_function my_id \(dqlambda:*\(dq \e
                   s3.amazonaws.com aws:arn::::bucket\-name \e
                   aws\-account\-id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.alias_exists(FunctionName, Name, region=None, key=None, keyid=None, profile=None)
Given a function name and alias name, check to see if the given alias exists.
.sp
Returns True if the given alias exists and returns False if the given
alias does not exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lambda.alias_exists myfunction myalias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.create_alias(FunctionName, Name, FunctionVersion, Description=\(aq\(aq, region=None, key=None, keyid=None, profile=None)
Given a valid config, create an alias to a function.
.sp
Returns {created: true} if the alias was created and returns
{created: False} if the alias was not created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lamba.create_alias my_function my_alias $LATEST \(dqAn alias\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.create_event_source_mapping(EventSourceArn, FunctionName, StartingPosition, Enabled=True, BatchSize=100, region=None, key=None, keyid=None, profile=None)
Identifies a stream as an event source for a Lambda function. It can be
either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda
invokes the specified function when records are posted to the stream.
.sp
Returns {created: true} if the event source mapping was created and returns
{created: False} if the event source mapping was not created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lamba.create_event_source_mapping arn::::eventsource myfunction LATEST
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.create_function(FunctionName, Runtime, Role, Handler, ZipFile=None, S3Bucket=None, S3Key=None, S3ObjectVersion=None, Description=\(aq\(aq, Timeout=3, MemorySize=128, Publish=False, WaitForRole=False, RoleRetries=5, region=None, key=None, keyid=None, profile=None, VpcConfig=None, Environment=None)
New in version 2017.7.0.

.sp
Given a valid config, create a function.
.INDENT 7.0
.TP
.B Environment
The parent object that contains your environment\(aqs configuration
settings. This is a dictionary of the form:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqVariables\(aq: {
        \(aqVariableName\(aq: \(aqVariableValue\(aq
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Returns \fB{\(aqcreated\(aq: True}\fP if the function was created and \fB{created:
False}\fP if the function was not created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lamba.create_function my_function python2.7 my_role my_file.my_function my_function.zip
salt myminion boto_lamba.create_function my_function python2.7 my_role my_file.my_function salt://files/my_function.zip
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.delete_alias(FunctionName, Name, region=None, key=None, keyid=None, profile=None)
Given a function name and alias name, delete the alias.
.sp
Returns {deleted: true} if the alias was deleted and returns
{deleted: false} if the alias was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lambda.delete_alias myfunction myalias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.delete_event_source_mapping(UUID=None, EventSourceArn=None, FunctionName=None, region=None, key=None, keyid=None, profile=None)
Given an event source mapping ID or an event source ARN and FunctionName,
delete the event source mapping
.sp
Returns {deleted: true} if the mapping was deleted and returns
{deleted: false} if the mapping was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lambda.delete_event_source_mapping 260c423d\-e8b5\-4443\-8d6a\-5e91b9ecd0fa
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.delete_function(FunctionName, Qualifier=None, region=None, key=None, keyid=None, profile=None)
Given a function name and optional version qualifier, delete it.
.sp
Returns {deleted: true} if the function was deleted and returns
{deleted: false} if the function was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lambda.delete_function myfunction
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.describe_alias(FunctionName, Name, region=None, key=None, keyid=None, profile=None)
Given a function name and alias name describe the properties of the alias.
.sp
Returns a dictionary of interesting properties.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lambda.describe_alias myalias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.describe_event_source_mapping(UUID=None, EventSourceArn=None, FunctionName=None, region=None, key=None, keyid=None, profile=None)
Given an event source mapping ID or an event source ARN and FunctionName,
obtain the current settings of that mapping.
.sp
Returns a dictionary of interesting properties.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lambda.describe_event_source_mapping uuid
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.describe_function(FunctionName, region=None, key=None, keyid=None, profile=None)
Given a function name describe its properties.
.sp
Returns a dictionary of interesting properties.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lambda.describe_function myfunction
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.event_source_mapping_exists(UUID=None, EventSourceArn=None, FunctionName=None, region=None, key=None, keyid=None, profile=None)
Given an event source mapping ID or an event source ARN and FunctionName,
check whether the mapping exists.
.sp
Returns True if the given alias exists and returns False if the given
alias does not exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lambda.alias_exists myfunction myalias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.function_exists(FunctionName, region=None, key=None, keyid=None, profile=None)
Given a function name, check to see if the given function name exists.
.sp
Returns True if the given function exists and returns False if the given
function does not exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lambda.function_exists myfunction
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.get_event_source_mapping_ids(EventSourceArn, FunctionName, region=None, key=None, keyid=None, profile=None)
Given an event source and function name, return a list of mapping IDs
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lambda.get_event_source_mapping_ids arn:::: myfunction
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.get_permissions(FunctionName, Qualifier=None, region=None, key=None, keyid=None, profile=None)
Get resource permissions for the given lambda function
.sp
Returns dictionary of permissions, by statement ID
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lamba.get_permissions my_function

permissions: {...}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.list_function_versions(FunctionName, region=None, key=None, keyid=None, profile=None)
List the versions available for the given function.
.sp
Returns list of function versions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
versions:
  \- {...}
  \- {...}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.list_functions(region=None, key=None, keyid=None, profile=None)
List all Lambda functions visible in the current scope.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lambda.list_functions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.remove_permission(FunctionName, StatementId, Qualifier=None, region=None, key=None, keyid=None, profile=None)
Remove a permission from a lambda function.
.sp
Returns {removed: true} if the permission was removed and returns
{removed: False} if the permission was not removed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lamba.remove_permission my_function my_id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.update_alias(FunctionName, Name, FunctionVersion=None, Description=None, region=None, key=None, keyid=None, profile=None)
Update the named alias to the configuration.
.sp
Returns {updated: true} if the alias was updated and returns
{updated: False} if the alias was not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lamba.update_alias my_lambda my_alias $LATEST
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.update_event_source_mapping(UUID, FunctionName=None, Enabled=None, BatchSize=None, region=None, key=None, keyid=None, profile=None)
Update the event source mapping identified by the UUID.
.sp
Returns {updated: true} if the alias was updated and returns
{updated: False} if the alias was not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lamba.update_event_source_mapping uuid FunctionName=new_function
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.update_function_code(FunctionName, ZipFile=None, S3Bucket=None, S3Key=None, S3ObjectVersion=None, Publish=False, region=None, key=None, keyid=None, profile=None)
Upload the given code to the named lambda function.
.sp
Returns {updated: true} if the function was updated and returns
{updated: False} if the function was not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lamba.update_function_code my_function ZipFile=function.zip
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_lambda.update_function_config(FunctionName, Role=None, Handler=None, Description=None, Timeout=None, MemorySize=None, region=None, key=None, keyid=None, profile=None, VpcConfig=None, WaitForRole=False, RoleRetries=5, Environment=None)
New in version 2017.7.0.

.sp
Update the named lambda function to the configuration.
.INDENT 7.0
.TP
.B Environment
The parent object that contains your environment\(aqs configuration
settings. This is a dictionary of the form:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqVariables\(aq: {
        \(aqVariableName\(aq: \(aqVariableValue\(aq
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Returns \fB{\(aqupdated\(aq: True}\fP if the function was updated, and
\fB{\(aqupdated\(aq: False}\fP if the function was not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_lamba.update_function_config my_function my_role my_file.my_function \(dqmy lambda function\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_rds
.sp
Connection module for Amazon RDS
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit rds credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
rds.keyid: GKTADJGHEIQSXMKKRBJ08H
rds.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
rds.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.create(name, allocated_storage, db_instance_class, engine, master_username, master_user_password, db_name=None, db_security_groups=None, vpc_security_group_ids=None, vpc_security_groups=None, availability_zone=None, db_subnet_group_name=None, preferred_maintenance_window=None, db_parameter_group_name=None, backup_retention_period=None, preferred_backup_window=None, port=None, multi_az=None, engine_version=None, auto_minor_version_upgrade=None, license_model=None, iops=None, option_group_name=None, character_set_name=None, publicly_accessible=None, wait_status=None, tags=None, db_cluster_identifier=None, storage_type=None, tde_credential_arn=None, tde_credential_password=None, storage_encrypted=None, kms_key_id=None, domain=None, copy_tags_to_snapshot=None, monitoring_interval=None, monitoring_role_arn=None, domain_iam_role_name=None, region=None, promotion_tier=None, key=None, keyid=None, profile=None)
Create an RDS Instance
.sp
CLI example to create an RDS Instance:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.create myrds 10 db.t2.micro MySQL sqlusr sqlpassw
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.create_option_group(name, engine_name, major_engine_version, option_group_description, tags=None, region=None, key=None, keyid=None, profile=None)
Create an RDS option group
.sp
CLI example to create an RDS option group:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.create_option_group my\-opt\-group mysql 5.6                 \(dqgroup description\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.create_parameter_group(name, db_parameter_group_family, description, tags=None, region=None, key=None, keyid=None, profile=None)
Create an RDS parameter group
.sp
CLI example to create an RDS parameter group:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.create_parameter_group my\-param\-group mysql5.6                 \(dqgroup description\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.create_read_replica(name, source_name, db_instance_class=None, availability_zone=None, port=None, auto_minor_version_upgrade=None, iops=None, option_group_name=None, publicly_accessible=None, tags=None, db_subnet_group_name=None, storage_type=None, copy_tags_to_snapshot=None, monitoring_interval=None, monitoring_role_arn=None, region=None, key=None, keyid=None, profile=None)
Create an RDS read replica
.sp
CLI example to create an RDS  read replica:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.create_read_replica replicaname source_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.create_subnet_group(name, description, subnet_ids, tags=None, region=None, key=None, keyid=None, profile=None)
Create an RDS subnet group
.sp
CLI example to create an RDS subnet group:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.create_subnet_group my\-subnet\-group             \(dqgroup description\(dq \(aq[subnet\-12345678, subnet\-87654321]\(aq             region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.delete(name, skip_final_snapshot=None, final_db_snapshot_identifier=None, region=None, key=None, keyid=None, profile=None, tags=None, wait_for_deletion=True, timeout=180)
Delete an RDS instance.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.delete myrds skip_final_snapshot=True                 region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.delete_option_group(name, region=None, key=None, keyid=None, profile=None)
Delete an RDS option group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.delete_option_group my\-opt\-group                 region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.delete_parameter_group(name, region=None, key=None, keyid=None, profile=None)
Delete an RDS parameter group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.delete_parameter_group my\-param\-group                 region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.delete_subnet_group(name, region=None, key=None, keyid=None, profile=None)
Delete an RDS subnet group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.delete_subnet_group my\-subnet\-group                 region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.describe(name, tags=None, region=None, key=None, keyid=None, profile=None)
Return RDS instance details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.describe myrds
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.describe_db_instances(name=None, filters=None, jmespath=\(aqDBInstances\(aq, region=None, key=None, keyid=None, profile=None)
Return a detailed listing of some, or all, DB Instances visible in the
current scope.  Arbitrary subelements or subsections of the returned dataset
can be selected by passing in a valid JMSEPath filter as well.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.describe_db_instances jmespath=\(aqDBInstances[*].DBInstanceIdentifier\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.describe_db_subnet_groups(name=None, filters=None, jmespath=\(aqDBSubnetGroups\(aq, region=None, key=None, keyid=None, profile=None)
Return a detailed listing of some, or all, DB Subnet Groups visible in the
current scope.  Arbitrary subelements or subsections of the returned dataset
can be selected by passing in a valid JMSEPath filter as well.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.describe_db_subnet_groups
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.describe_parameter_group(name, Filters=None, MaxRecords=None, Marker=None, region=None, key=None, keyid=None, profile=None)
Returns a list of \fIDBParameterGroup\fP descriptions.
CLI example to description of parameter group:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.describe_parameter_group parametergroupname            region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.describe_parameters(name, Source=None, MaxRecords=None, Marker=None, region=None, key=None, keyid=None, profile=None)
Returns a list of \fIDBParameterGroup\fP parameters.
CLI example to description of parameters
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.describe_parameters parametergroupname            region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.exists(name, tags=None, region=None, key=None, keyid=None, profile=None)
Check to see if an RDS exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.exists myrds region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.get_endpoint(name, tags=None, region=None, key=None, keyid=None, profile=None)
Return the endpoint of an RDS instance.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.get_endpoint myrds
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.modify_db_instance(name, allocated_storage=None, allow_major_version_upgrade=None, apply_immediately=None, auto_minor_version_upgrade=None, backup_retention_period=None, ca_certificate_identifier=None, character_set_name=None, copy_tags_to_snapshot=None, db_cluster_identifier=None, db_instance_class=None, db_name=None, db_parameter_group_name=None, db_port_number=None, db_security_groups=None, db_subnet_group_name=None, domain=None, domain_iam_role_name=None, engine_version=None, iops=None, kms_key_id=None, license_model=None, master_user_password=None, monitoring_interval=None, monitoring_role_arn=None, multi_az=None, new_db_instance_identifier=None, option_group_name=None, preferred_backup_window=None, preferred_maintenance_window=None, promotion_tier=None, publicly_accessible=None, storage_encrypted=None, storage_type=None, tde_credential_arn=None, tde_credential_password=None, vpc_security_group_ids=None, region=None, key=None, keyid=None, profile=None)
Modify settings for a DB instance.
CLI example to description of parameters
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.modify_db_instance db_instance_identifier region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.option_group_exists(name, tags=None, region=None, key=None, keyid=None, profile=None)
Check to see if an RDS option group exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.option_group_exists myoptiongr region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.parameter_group_exists(name, tags=None, region=None, key=None, keyid=None, profile=None)
Check to see if an RDS parameter group exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.parameter_group_exists myparametergroup                 region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.subnet_group_exists(name, tags=None, region=None, key=None, keyid=None, profile=None)
Check to see if an RDS subnet group exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.subnet_group_exists my\-param\-group                 region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_rds.update_parameter_group(name, parameters, apply_method=\(aqpending\-reboot\(aq, tags=None, region=None, key=None, keyid=None, profile=None)
Update an RDS parameter group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_rds.update_parameter_group my\-param\-group                 parameters=\(aq{\(dqback_log\(dq:1, \(dqbinlog_cache_size\(dq:4096}\(aq                 region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_route53
.sp
Connection module for Amazon Route53
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit route53 credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
route53.keyid: GKTADJGHEIQSXMKKRBJ08H
route53.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
route53.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is \(aquniversal\(aq, which is what the boto_route53
library expects, rather than None.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
  region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_route53.add_record(name, value, zone, record_type, identifier=None, ttl=None, region=None, key=None, keyid=None, profile=None, wait_for_sync=True, split_dns=False, private_zone=False, retry_on_rate_limit=None, rate_limit_retries=None, retry_on_errors=True, error_retries=5)
Add a record to a zone.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_route53.add_record test.example.org 1.1.1.1 example.org A
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B retry_on_errors
Continue to query if the zone exists after an error is
raised. The previously used argument \fIretry_on_rate_limit\fP
was deprecated for this argument. Users can still use
\fIretry_on_rate_limit\fP to ensure backwards compatibility,
but please migrate to using the favored \fIretry_on_errors\fP
argument instead.
.TP
.B error_retries
Number of times to attempt to query if the zone exists.
The previously used argument \fIrate_limit_retries\fP was
deprecated for this arguments. Users can still use
\fIrate_limit_retries\fP to ensure backwards compatibility,
but please migrate to using the favored \fIerror_retries\fP
argument instead.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_route53.create_healthcheck(ip_addr=None, fqdn=None, region=None, key=None, keyid=None, profile=None, port=53, hc_type=\(aqTCP\(aq, resource_path=\(aq\(aq, string_match=None, request_interval=30, failure_threshold=3, retry_on_errors=True, error_retries=5)
Create a Route53 healthcheck
.sp
New in version 2018.3.0.

.sp
ip_addr
.INDENT 7.0
.INDENT 3.5
IP address to check.  ip_addr or fqdn is required.
.UNINDENT
.UNINDENT
.sp
fqdn
.INDENT 7.0
.INDENT 3.5
Domain name of the endpoint to check.  ip_addr or fqdn is required
.UNINDENT
.UNINDENT
.sp
port
.INDENT 7.0
.INDENT 3.5
Port to check
.UNINDENT
.UNINDENT
.sp
hc_type
.INDENT 7.0
.INDENT 3.5
Healthcheck type.  HTTP | HTTPS | HTTP_STR_MATCH | HTTPS_STR_MATCH | TCP
.UNINDENT
.UNINDENT
.sp
resource_path
.INDENT 7.0
.INDENT 3.5
Path to check
.UNINDENT
.UNINDENT
.sp
string_match
.INDENT 7.0
.INDENT 3.5
If hc_type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string to search for in the
response body from the specified resource
.UNINDENT
.UNINDENT
.sp
request_interval
.INDENT 7.0
.INDENT 3.5
The number of seconds between the time that Amazon Route 53 gets a response from
your endpoint and the time that it sends the next health\-check request.
.UNINDENT
.UNINDENT
.sp
failure_threshold
.INDENT 7.0
.INDENT 3.5
The number of consecutive health checks that an endpoint must pass or fail for
Amazon Route 53 to change the current status of the endpoint from unhealthy to
healthy or vice versa.
.UNINDENT
.UNINDENT
.sp
region
.INDENT 7.0
.INDENT 3.5
Region endpoint to connect to
.UNINDENT
.UNINDENT
.sp
key
.INDENT 7.0
.INDENT 3.5
AWS key
.UNINDENT
.UNINDENT
.sp
keyid
.INDENT 7.0
.INDENT 3.5
AWS keyid
.UNINDENT
.UNINDENT
.sp
profile
.INDENT 7.0
.INDENT 3.5
AWS pillar profile
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_route53.create_healthcheck 192.168.0.1
salt myminion boto_route53.create_healthcheck 192.168.0.1 port=443 hc_type=HTTPS                                                       resource_path=/ fqdn=blog.saltstack.furniture
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_route53.create_hosted_zone(domain_name, caller_ref=None, comment=\(aq\(aq, private_zone=False, vpc_id=None, vpc_name=None, vpc_region=None, region=None, key=None, keyid=None, profile=None)
Create a new Route53 Hosted Zone. Returns a Python data structure with information about the
newly created Hosted Zone.
.INDENT 7.0
.TP
.B domain_name
The name of the domain. This must be fully\-qualified, terminating with a period.  This is
the name you have registered with your domain registrar.  It is also the name you will
delegate from your registrar to the Amazon Route 53 delegation servers returned in response
to this request.
.TP
.B caller_ref
A unique string that identifies the request and that allows create_hosted_zone() calls to
be retried without the risk of executing the operation twice.  It can take several minutes
for the change to replicate globally, and change from PENDING to INSYNC status. Thus it\(aqs
best to provide some value for this where possible, since duplicate calls while the first
is in PENDING status will be accepted and can lead to multiple copies of the zone being
created.  On the other hand, if a zone is created with a given caller_ref, then deleted,
a second attempt to create a zone with the same caller_ref will fail until that caller_ref
is flushed from the Route53 system, which can take upwards of 24 hours.
.TP
.B comment
Any comments you want to include about the hosted zone.
.TP
.B private_zone
Set True if creating a private hosted zone.
.TP
.B vpc_id
When creating a private hosted zone, either the VPC ID or VPC Name to associate with is
required.  Exclusive with vpe_name.  Ignored when creating a non\-private zone.
.TP
.B vpc_name
When creating a private hosted zone, either the VPC ID or VPC Name to associate with is
required.  Exclusive with vpe_id.  Ignored when creating a non\-private zone.
.TP
.B vpc_region
When creating a private hosted zone, the region of the associated VPC is required.  If not
provided, an effort will be made to determine it from vpc_id or vpc_name, where possible.
If this fails, you\(aqll need to provide an explicit value for this option.  Ignored when
creating a non\-private zone.
.TP
.B region
Region endpoint to connect to.
.TP
.B key
AWS key to bind with.
.TP
.B keyid
AWS keyid to bind with.
.TP
.B profile
Dict, or pillar key pointing to a dict, containing AWS region/key/keyid.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_route53.create_hosted_zone example.org
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_route53.create_zone(zone, private=False, vpc_id=None, vpc_region=None, region=None, key=None, keyid=None, profile=None)
Create a Route53 hosted zone.
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B zone
DNS zone to create
.TP
.B private
True/False if the zone will be a private zone
.TP
.B vpc_id
VPC ID to associate the zone to (required if private is True)
.TP
.B vpc_region
VPC Region (required if private is True)
.TP
.B region
region endpoint to connect to
.TP
.B key
AWS key
.TP
.B keyid
AWS keyid
.TP
.B profile
AWS pillar profile
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_route53.create_zone example.org
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_route53.delete_record(name, zone, record_type, identifier=None, all_records=False, region=None, key=None, keyid=None, profile=None, wait_for_sync=True, split_dns=False, private_zone=False, retry_on_rate_limit=None, rate_limit_retries=None, retry_on_errors=True, error_retries=5)
Modify a record in a zone.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_route53.delete_record test.example.org example.org A
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B retry_on_errors
Continue to query if the zone exists after an error is
raised. The previously used argument \fIretry_on_rate_limit\fP
was deprecated for this argument. Users can still use
\fIretry_on_rate_limit\fP to ensure backwards compatibility,
but please migrate to using the favored \fIretry_on_errors\fP
argument instead.
.TP
.B error_retries
Number of times to attempt to query if the zone exists.
The previously used argument \fIrate_limit_retries\fP was
deprecated for this arguments. Users can still use
\fIrate_limit_retries\fP to ensure backwards compatibility,
but please migrate to using the favored \fIerror_retries\fP
argument instead.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_route53.delete_zone(zone, region=None, key=None, keyid=None, profile=None)
Delete a Route53 hosted zone.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_route53.delete_zone example.org
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_route53.describe_hosted_zones(zone_id=None, domain_name=None, region=None, key=None, keyid=None, profile=None)
Return detailed info about one, or all, zones in the bound account.
If neither zone_id nor domain_name is provided, return all zones.
Note that the return format is slightly different between the \(aqall\(aq
and \(aqsingle\(aq description types.
.INDENT 7.0
.TP
.B zone_id
The unique identifier for the Hosted Zone
.TP
.B domain_name
The FQDN of the Hosted Zone (including final period)
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_route53.describe_hosted_zones domain_name=foo.bar.com.                 profile=\(aq{\(dqregion\(dq: \(dqus\-east\-1\(dq, \(dqkeyid\(dq: \(dqA12345678AB\(dq, \(dqkey\(dq: \(dqxblahblahblah\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_route53.get_record(name, zone, record_type, fetch_all=False, region=None, key=None, keyid=None, profile=None, split_dns=False, private_zone=False, identifier=None, retry_on_rate_limit=None, rate_limit_retries=None, retry_on_errors=True, error_retries=5)
Get a record from a zone.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_route53.get_record test.example.org example.org A
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B retry_on_errors
Continue to query if the zone exists after an error is
raised. The previously used argument \fIretry_on_rate_limit\fP
was deprecated for this argument. Users can still use
\fIretry_on_rate_limit\fP to ensure backwards compatibility,
but please migrate to using the favored \fIretry_on_errors\fP
argument instead.
.TP
.B error_retries
Number of times to attempt to query if the zone exists.
The previously used argument \fIrate_limit_retries\fP was
deprecated for this arguments. Users can still use
\fIrate_limit_retries\fP to ensure backwards compatibility,
but please migrate to using the favored \fIerror_retries\fP
argument instead.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_route53.list_all_zones_by_id(region=None, key=None, keyid=None, profile=None)
List, by their IDs, all hosted zones in the bound account.
.INDENT 7.0
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_route53.list_all_zones_by_id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_route53.list_all_zones_by_name(region=None, key=None, keyid=None, profile=None)
List, by their FQDNs, all hosted zones in the bound account.
.INDENT 7.0
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_route53.list_all_zones_by_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_route53.update_record(name, value, zone, record_type, identifier=None, ttl=None, region=None, key=None, keyid=None, profile=None, wait_for_sync=True, split_dns=False, private_zone=False, retry_on_rate_limit=None, rate_limit_retries=None, retry_on_errors=True, error_retries=5)
Modify a record in a zone.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_route53.modify_record test.example.org 1.1.1.1 example.org A
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B retry_on_errors
Continue to query if the zone exists after an error is
raised. The previously used argument \fIretry_on_rate_limit\fP
was deprecated for this argument. Users can still use
\fIretry_on_rate_limit\fP to ensure backwards compatibility,
but please migrate to using the favored \fIretry_on_errors\fP
argument instead.
.TP
.B error_retries
Number of times to attempt to query if the zone exists.
The previously used argument \fIrate_limit_retries\fP was
deprecated for this arguments. Users can still use
\fIrate_limit_retries\fP to ensure backwards compatibility,
but please migrate to using the favored \fIerror_retries\fP
argument instead.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_route53.zone_exists(zone, region=None, key=None, keyid=None, profile=None, retry_on_rate_limit=None, rate_limit_retries=None, retry_on_errors=True, error_retries=5)
Check for the existence of a Route53 hosted zone.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_route53.zone_exists example.org
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B retry_on_errors
Continue to query if the zone exists after an error is
raised. The previously used argument \fIretry_on_rate_limit\fP
was deprecated for this argument. Users can still use
\fIretry_on_rate_limit\fP to ensure backwards compatibility,
but please migrate to using the favored \fIretry_on_errors\fP
argument instead.
.TP
.B error_retries
Number of times to attempt to query if the zone exists.
The previously used argument \fIrate_limit_retries\fP was
deprecated for this arguments. Users can still use
\fIrate_limit_retries\fP to ensure backwards compatibility,
but please migrate to using the favored \fIerror_retries\fP
argument instead.
.UNINDENT
.UNINDENT
.SS salt.modules.boto_s3
.sp
Connection module for Amazon S3 using boto3
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit AWS credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles or
it can read them from the ~/.aws/credentials file or from these
environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/
    iam\-roles\-for\-amazon\-ec2.html

http://boto3.readthedocs.io/en/latest/guide/
    configuration.html#guide\-configuration
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
s3.keyid: GKTADJGHEIQSXMKKRBJ08H
s3.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
s3.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3.get_object_metadata(name, extra_args=None, region=None, key=None, keyid=None, profile=None)
Get metadata about an S3 object.
Returns None if the object does not exist.
.sp
You can pass AWS SSE\-C related args and/or RequestPayer in extra_args.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3.get_object_metadata \e
                 my_bucket/path/to/object \e
                 region=us\-east\-1 \e
                 key=key \e
                 keyid=keyid \e
                 profile=profile \e
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3.upload_file(source, name, extra_args=None, region=None, key=None, keyid=None, profile=None)
Upload a local file as an S3 object.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3.upload_file \e
                 /path/to/local/file \e
                 my_bucket/path/to/object \e
                 region=us\-east\-1 \e
                 key=key \e
                 keyid=keyid \e
                 profile=profile \e
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_s3_bucket
.sp
Connection module for Amazon S3 Buckets
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
boto
.IP \(bu 2
boto3
.UNINDENT
.UNINDENT
.sp
The dependencies listed above can be installed via package or pip.
.INDENT 0.0
.TP
.B configuration
This module accepts explicit Lambda credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
s3.keyid: GKTADJGHEIQSXMKKRBJ08H
s3.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
s3.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.create(Bucket, ACL=None, LocationConstraint=None, GrantFullControl=None, GrantRead=None, GrantReadACP=None, GrantWrite=None, GrantWriteACP=None, region=None, key=None, keyid=None, profile=None)
Given a valid config, create an S3 Bucket.
.sp
Returns {created: true} if the bucket was created and returns
{created: False} if the bucket was not created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.create my_bucket \e
                 GrantFullControl=\(aqemailaddress=example@example.com\(aq \e
                 GrantRead=\(aquri=\(dqhttp://acs.amazonaws.com/groups/global/AllUsers\(dq\(aq \e
                 GrantReadACP=\(aqemailaddress=\(dqexampl@example.com\(dq,id=\(dq2345678909876432\(dq\(aq \e
                 LocationConstraint=us\-west\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.delete(Bucket, MFA=None, RequestPayer=None, Force=False, region=None, key=None, keyid=None, profile=None)
Given a bucket name, delete it, optionally emptying it first.
.sp
Returns {deleted: true} if the bucket was deleted and returns
{deleted: false} if the bucket was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.delete mybucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.delete_cors(Bucket, region=None, key=None, keyid=None, profile=None)
Delete the CORS configuration for the given bucket
.sp
Returns {deleted: true} if CORS was deleted and returns
{deleted: False} if CORS was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.delete_cors my_bucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.delete_lifecycle_configuration(Bucket, region=None, key=None, keyid=None, profile=None)
Delete the lifecycle configuration for the given bucket
.sp
Returns {deleted: true} if Lifecycle was deleted and returns
{deleted: False} if Lifecycle was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.delete_lifecycle_configuration my_bucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.delete_objects(Bucket, Delete, MFA=None, RequestPayer=None, region=None, key=None, keyid=None, profile=None)
Delete objects in a given S3 bucket.
.sp
Returns {deleted: true} if all objects were deleted
and {deleted: false, failed: [key, ...]} otherwise
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.delete_objects mybucket \(aq{Objects: [Key: myobject]}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.delete_policy(Bucket, region=None, key=None, keyid=None, profile=None)
Delete the policy from the given bucket
.sp
Returns {deleted: true} if policy was deleted and returns
{deleted: False} if policy was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.delete_policy my_bucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.delete_replication(Bucket, region=None, key=None, keyid=None, profile=None)
Delete the replication config from the given bucket
.sp
Returns {deleted: true} if replication configuration was deleted and returns
{deleted: False} if replication configuration was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.delete_replication my_bucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.delete_tagging(Bucket, region=None, key=None, keyid=None, profile=None)
Delete the tags from the given bucket
.sp
Returns {deleted: true} if tags were deleted and returns
{deleted: False} if tags were not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.delete_tagging my_bucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.delete_website(Bucket, region=None, key=None, keyid=None, profile=None)
Remove the website configuration from the given bucket
.sp
Returns {deleted: true} if website configuration was deleted and returns
{deleted: False} if website configuration was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.delete_website my_bucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.describe(Bucket, region=None, key=None, keyid=None, profile=None)
Given a bucket name describe its properties.
.sp
Returns a dictionary of interesting properties.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.describe mybucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.empty(Bucket, MFA=None, RequestPayer=None, region=None, key=None, keyid=None, profile=None)
Delete all objects in a given S3 bucket.
.sp
Returns {deleted: true} if all objects were deleted
and {deleted: false, failed: [key, ...]} otherwise
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.empty mybucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.exists(Bucket, region=None, key=None, keyid=None, profile=None)
Given a bucket name, check to see if the given bucket exists.
.sp
Returns True if the given bucket exists and returns False if the given
bucket does not exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.exists mybucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.list(region=None, key=None, keyid=None, profile=None)
List all buckets owned by the authenticated sender of the request.
.sp
Returns list of buckets
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Owner: {...}
Buckets:
  \- {...}
  \- {...}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.list_object_versions(Bucket, Delimiter=None, EncodingType=None, Prefix=None, region=None, key=None, keyid=None, profile=None)
List objects in a given S3 bucket.
.sp
Returns a list of objects.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.list_object_versions mybucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.list_objects(Bucket, Delimiter=None, EncodingType=None, Prefix=None, FetchOwner=False, StartAfter=None, region=None, key=None, keyid=None, profile=None)
List objects in a given S3 bucket.
.sp
Returns a list of objects.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.list_objects mybucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.put_acl(Bucket, ACL=None, AccessControlPolicy=None, GrantFullControl=None, GrantRead=None, GrantReadACP=None, GrantWrite=None, GrantWriteACP=None, region=None, key=None, keyid=None, profile=None)
Given a valid config, update the ACL for a bucket.
.sp
Returns {updated: true} if the ACL was updated and returns
{updated: False} if the ACL was not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.put_acl my_bucket \(aqpublic\(aq \e
                 GrantFullControl=\(aqemailaddress=example@example.com\(aq \e
                 GrantRead=\(aquri=\(dqhttp://acs.amazonaws.com/groups/global/AllUsers\(dq\(aq \e
                 GrantReadACP=\(aqemailaddress=\(dqexampl@example.com\(dq,id=\(dq2345678909876432\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.put_cors(Bucket, CORSRules, region=None, key=None, keyid=None, profile=None)
Given a valid config, update the CORS rules for a bucket.
.sp
Returns {updated: true} if CORS was updated and returns
{updated: False} if CORS was not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.put_cors my_bucket \(aq[{\e
      \(dqAllowedHeaders\(dq:[],\e
      \(dqAllowedMethods\(dq:[\(dqGET\(dq],\e
      \(dqAllowedOrigins\(dq:[\(dq*\(dq],\e
      \(dqExposeHeaders\(dq:[],\e
      \(dqMaxAgeSeconds\(dq:123,\e
}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.put_lifecycle_configuration(Bucket, Rules, region=None, key=None, keyid=None, profile=None)
Given a valid config, update the Lifecycle rules for a bucket.
.sp
Returns {updated: true} if Lifecycle was updated and returns
{updated: False} if Lifecycle was not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.put_lifecycle_configuration my_bucket \(aq[{\e
      \(dqExpiration\(dq: {...},\e
      \(dqID\(dq: \(dqidstring\(dq,\e
      \(dqPrefix\(dq: \(dqprefixstring\(dq,\e
      \(dqStatus\(dq: \(dqenabled\(dq,\e
      \(dqTransitions\(dq: [{...},],\e
      \(dqNoncurrentVersionTransitions\(dq: [{...},],\e
      \(dqNoncurrentVersionExpiration\(dq: {...},\e
}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.put_logging(Bucket, TargetBucket=None, TargetPrefix=None, TargetGrants=None, region=None, key=None, keyid=None, profile=None)
Given a valid config, update the logging parameters for a bucket.
.sp
Returns {updated: true} if parameters were updated and returns
{updated: False} if parameters were not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.put_logging my_bucket log_bucket \(aq[{...}]\(aq prefix
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.put_notification_configuration(Bucket, TopicConfigurations=None, QueueConfigurations=None, LambdaFunctionConfigurations=None, region=None, key=None, keyid=None, profile=None)
Given a valid config, update the notification parameters for a bucket.
.sp
Returns {updated: true} if parameters were updated and returns
{updated: False} if parameters were not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.put_notification_configuration my_bucket
        [{...}] \e
        [{...}] \e
        [{...}]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.put_policy(Bucket, Policy, region=None, key=None, keyid=None, profile=None)
Given a valid config, update the policy for a bucket.
.sp
Returns {updated: true} if policy was updated and returns
{updated: False} if policy was not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.put_policy my_bucket {...}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.put_replication(Bucket, Role, Rules, region=None, key=None, keyid=None, profile=None)
Given a valid config, update the replication configuration for a bucket.
.sp
Returns {updated: true} if replication configuration was updated and returns
{updated: False} if replication configuration was not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.put_replication my_bucket my_role [...]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.put_request_payment(Bucket, Payer, region=None, key=None, keyid=None, profile=None)
Given a valid config, update the request payment configuration for a bucket.
.sp
Returns {updated: true} if request payment configuration was updated and returns
{updated: False} if request payment configuration was not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.put_request_payment my_bucket Requester
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.put_tagging(Bucket, region=None, key=None, keyid=None, profile=None, **kwargs)
Given a valid config, update the tags for a bucket.
.sp
Returns {updated: true} if tags were updated and returns
{updated: False} if tags were not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.put_tagging my_bucket my_role [...]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.put_versioning(Bucket, Status, MFADelete=None, MFA=None, region=None, key=None, keyid=None, profile=None)
Given a valid config, update the versioning configuration for a bucket.
.sp
Returns {updated: true} if versioning configuration was updated and returns
{updated: False} if versioning configuration was not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.put_versioning my_bucket Enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_s3_bucket.put_website(Bucket, ErrorDocument=None, IndexDocument=None, RedirectAllRequestsTo=None, RoutingRules=None, region=None, key=None, keyid=None, profile=None)
Given a valid config, update the website configuration for a bucket.
.sp
Returns {updated: true} if website configuration was updated and returns
{updated: False} if website configuration was not updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_s3_bucket.put_website my_bucket IndexDocument=\(aq{\(dqSuffix\(dq:\(dqindex.html\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_secgroup
.sp
Connection module for Amazon Security Groups
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit ec2 credentials but can
also utilize IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
secgroup.keyid: GKTADJGHEIQSXMKKRBJ08H
secgroup.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
secgroup.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_secgroup.authorize(name=None, source_group_name=None, source_group_owner_id=None, ip_protocol=None, from_port=None, to_port=None, cidr_ip=None, group_id=None, source_group_group_id=None, region=None, key=None, keyid=None, profile=None, vpc_id=None, vpc_name=None, egress=False)
Add a new rule to an existing security group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_secgroup.authorize mysecgroup ip_protocol=tcp from_port=80 to_port=80 cidr_ip=\(aq[\(aq10.0.0.0/8\(aq, \(aq192.168.0.0/24\(aq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_secgroup.convert_to_group_ids(groups, vpc_id=None, vpc_name=None, region=None, key=None, keyid=None, profile=None)
Given a list of security groups and a vpc_id, convert_to_group_ids will
convert all list items in the given list to security group ids.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_secgroup.convert_to_group_ids mysecgroup vpc\-89yhh7h
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_secgroup.create(name, description, vpc_id=None, vpc_name=None, region=None, key=None, keyid=None, profile=None)
Create a security group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_secgroup.create mysecgroup \(aqMy Security Group\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_secgroup.delete(name=None, group_id=None, region=None, key=None, keyid=None, profile=None, vpc_id=None, vpc_name=None)
Delete a security group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_secgroup.delete mysecgroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_secgroup.delete_tags(tags, name=None, group_id=None, vpc_name=None, vpc_id=None, region=None, key=None, keyid=None, profile=None)
Deletes tags from a security group.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B tags
a list of tags to remove
.TP
.B name
the name of the security group
.TP
.B group_id
the group id of the security group (in lie of a name/vpc combo)
.TP
.B vpc_name
the name of the vpc to search the named group for
.TP
.B vpc_id
the id of the vpc, in lieu of the vpc_name
.TP
.B region
the amazon region
.TP
.B key
amazon key
.TP
.B keyid
amazon keyid
.TP
.B profile
amazon profile
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_secgroup.delete_tags [\(aqTAG_TO_DELETE1\(aq,\(aqTAG_TO_DELETE2\(aq] security_group_name vpc_id=vpc\-13435 profile=my_aws_profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_secgroup.exists(name=None, region=None, key=None, keyid=None, profile=None, vpc_id=None, vpc_name=None, group_id=None)
Check to see if a security group exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_secgroup.exists mysecgroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_secgroup.get_all_security_groups(groupnames=None, group_ids=None, filters=None, region=None, key=None, keyid=None, profile=None)
Return a list of all Security Groups matching the given criteria and
filters.
.sp
Note that the \fBgroupnames\fP argument only functions correctly for EC2
Classic and default VPC Security Groups.  To find groups by name in other
VPCs you\(aqll want to use the \fBgroup\-name\fP filter instead.
.sp
The valid keys for the \fBfilters\fP argument can be found in \fI\%AWS\(aqs API
documentation\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_secgroup.get_all_security_groups filters=\(aq{group\-name: mygroup}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_secgroup.get_config(name=None, group_id=None, region=None, key=None, keyid=None, profile=None, vpc_id=None, vpc_name=None)
Get the configuration for a security group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_secgroup.get_config mysecgroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_secgroup.get_group_id(name, vpc_id=None, vpc_name=None, region=None, key=None, keyid=None, profile=None)
Get a Group ID given a Group Name or Group Name and VPC ID
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_secgroup.get_group_id mysecgroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_secgroup.revoke(name=None, source_group_name=None, source_group_owner_id=None, ip_protocol=None, from_port=None, to_port=None, cidr_ip=None, group_id=None, source_group_group_id=None, region=None, key=None, keyid=None, profile=None, vpc_id=None, vpc_name=None, egress=False)
Remove a rule from an existing security group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_secgroup.revoke mysecgroup ip_protocol=tcp from_port=80 to_port=80 cidr_ip=\(aq10.0.0.0/8\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_secgroup.set_tags(tags, name=None, group_id=None, vpc_name=None, vpc_id=None, region=None, key=None, keyid=None, profile=None)
Sets tags on a security group.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B tags
a dict of key:value pair of tags to set on the security group
.TP
.B name
the name of the security group
.TP
.B group_id
the group id of the security group (in lie of a name/vpc combo)
.TP
.B vpc_name
the name of the vpc to search the named group for
.TP
.B vpc_id
the id of the vpc, in lieu of the vpc_name
.TP
.B region
the amazon region
.TP
.B key
amazon key
.TP
.B keyid
amazon keyid
.TP
.B profile
amazon profile
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_secgroup.set_tags \(dq{\(aqTAG1\(aq: \(aqValue1\(aq, \(aqTAG2\(aq: \(aqValue2\(aq}\(dq security_group_name vpc_id=vpc\-13435 profile=my_aws_profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_sns
.sp
Connection module for Amazon SNS
.INDENT 0.0
.TP
.B configuration
This module accepts explicit sns credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sns.keyid: GKTADJGHEIQSXMKKRBJ08H
sns.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sns.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_sns.create(name, region=None, key=None, keyid=None, profile=None)
Create an SNS topic.
.sp
CLI example to create a topic:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_sns.create mytopic region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_sns.delete(name, region=None, key=None, keyid=None, profile=None)
Delete an SNS topic.
.sp
CLI example to delete a topic:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_sns.delete mytopic region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_sns.exists(name, region=None, key=None, keyid=None, profile=None)
Check to see if an SNS topic exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_sns.exists mytopic region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_sns.get_all_subscriptions_by_topic(name, region=None, key=None, keyid=None, profile=None)
Get list of all subscriptions to a specific topic.
.sp
CLI example to delete a topic:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_sns.get_all_subscriptions_by_topic mytopic region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_sns.get_all_topics(region=None, key=None, keyid=None, profile=None)
Returns a list of the all topics..
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_sns.get_all_topics
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_sns.get_arn(name, region=None, key=None, keyid=None, profile=None)
Returns the full ARN for a given topic name.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_sns.get_arn mytopic
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_sns.subscribe(topic, protocol, endpoint, region=None, key=None, keyid=None, profile=None)
Subscribe to a Topic.
.sp
CLI example to delete a topic:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_sns.subscribe mytopic https https://www.example.com/sns\-endpoint region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_sns.unsubscribe(topic, subscription_arn, region=None, key=None, keyid=None, profile=None)
Unsubscribe a specific SubscriptionArn of a topic.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_sns.unsubscribe my_topic my_subscription_arn region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.SS salt.modules.boto_sqs
.sp
Connection module for Amazon SQS
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit sqs credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sqs.keyid: GKTADJGHEIQSXMKKRBJ08H
sqs.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sqs.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_sqs.create(name, attributes=None, region=None, key=None, keyid=None, profile=None)
Create an SQS queue.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_sqs.create myqueue region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_sqs.delete(name, region=None, key=None, keyid=None, profile=None)
Delete an SQS queue.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_sqs.delete myqueue region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_sqs.exists(name, region=None, key=None, keyid=None, profile=None)
Check to see if a queue exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_sqs.exists myqueue region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_sqs.get_attributes(name, region=None, key=None, keyid=None, profile=None)
Return attributes currently set on an SQS queue.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_sqs.get_attributes myqueue
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_sqs.list_(prefix=\(aq\(aq, region=None, key=None, keyid=None, profile=None)
Return a list of the names of all visible queues.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_sqs.list region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_sqs.set_attributes(name, attributes, region=None, key=None, keyid=None, profile=None)
Set attributes on an SQS queue.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_sqs.set_attributes myqueue \(aq{ReceiveMessageWaitTimeSeconds: 20}\(aq region=us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_ssm
.sp
Connection module for Amazon SSM
.INDENT 0.0
.TP
.B configuration
This module uses IAM roles assigned to the instance through
Instance Profiles. Dynamic credentials are then automatically obtained
from AWS API and no further configuration is necessary. More Information
available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ssm.delete_parameter(Name, region=None, key=None, keyid=None, profile=None)
Removes a parameter from the SSM parameter store
.sp
New in version 3000.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_ssm.delete_parameter test\-param
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ssm.get_parameter(name, withdecryption=False, resp_json=False, region=None, key=None, keyid=None, profile=None)
Retrieves a parameter from SSM Parameter Store
.sp
New in version 3000.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_ssm.get_parameter test\-param withdescription=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_ssm.put_parameter(Name, Value, Description=None, Type=\(aqString\(aq, KeyId=None, Overwrite=False, AllowedPattern=None, region=None, key=None, keyid=None, profile=None)
Sets a parameter in the SSM parameter store
.sp
New in version 3000.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call boto_ssm.put_parameter test\-param test_value Type=SecureString KeyId=alias/aws/ssm Description=\(aqtest encrypted key\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.boto_vpc
.sp
Connection module for Amazon VPC
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B depends
.UNINDENT
.INDENT 0.0
.IP \(bu 2
boto >= 2.8.0
.IP \(bu 2
boto3 >= 1.2.6
.UNINDENT
.INDENT 0.0
.TP
.B configuration
This module accepts explicit VPC credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available \fI\%here\fP\&.
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vpc.keyid: GKTADJGHEIQSXMKKRBJ08H
vpc.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vpc.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.0: All methods now return a dictionary. Create and delete methods return:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
created: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
created: false
error:
  message: error message
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Request methods (e.g., \fIdescribe_vpc\fP) return:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vpcs:
  \- {...}
  \- {...}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
error:
  message: error message
.ft P
.fi
.UNINDENT
.UNINDENT

.sp
New in version 2016.11.0.

.sp
Functions to request, accept, delete and describe VPC peering connections.
Named VPC peering connections can be requested using these modules.
VPC owner accounts can accept VPC peering connections (named or otherwise).
.sp
Examples showing creation of VPC peering connection
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Create a named VPC peering connection
salt myminion boto_vpc.request_vpc_peering_connection vpc\-4a3e622e vpc\-be82e9da name=my_vpc_connection
# Without a name
salt myminion boto_vpc.request_vpc_peering_connection vpc\-4a3e622e vpc\-be82e9da
# Specify a region
salt myminion boto_vpc.request_vpc_peering_connection vpc\-4a3e622e vpc\-be82e9da region=us\-west\-2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Check to see if VPC peering connection is pending
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.is_peering_connection_pending name=salt\-vpc
# Specify a region
salt myminion boto_vpc.is_peering_connection_pending name=salt\-vpc region=us\-west\-2
# specify an id
salt myminion boto_vpc.is_peering_connection_pending conn_id=pcx\-8a8939e3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Accept VPC peering connection
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.accept_vpc_peering_connection name=salt\-vpc
# Specify a region
salt myminion boto_vpc.accept_vpc_peering_connection name=salt\-vpc region=us\-west\-2
# specify an id
salt myminion boto_vpc.accept_vpc_peering_connection conn_id=pcx\-8a8939e3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Deleting VPC peering connection via this module
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Delete a named VPC peering connection
salt myminion boto_vpc.delete_vpc_peering_connection name=salt\-vpc
# Specify a region
salt myminion boto_vpc.delete_vpc_peering_connection name=salt\-vpc region=us\-west\-2
# specify an id
salt myminion boto_vpc.delete_vpc_peering_connection conn_id=pcx\-8a8939e3
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.accept_vpc_peering_connection(conn_id=\(aq\(aq, name=\(aq\(aq, region=None, key=None, keyid=None, profile=None, dry_run=False)
Request a VPC peering connection between two VPCs.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconn_id\fP \-\- The ID to use. String type.
.IP \(bu 2
\fBname\fP \-\- The name of this VPC peering connection. String type.
.IP \(bu 2
\fBregion\fP \-\- The AWS region to use. Type string.
.IP \(bu 2
\fBkey\fP \-\- The key to use for this connection. Type string.
.IP \(bu 2
\fBkeyid\fP \-\- The key id to use.
.IP \(bu 2
\fBprofile\fP \-\- The profile to use.
.IP \(bu 2
\fBdry_run\fP \-\- The dry_run flag to set.
.UNINDENT
.TP
.B Returns
dict
.UNINDENT
.sp
Warning: Please specify either the \fBvpc_peering_connection_id\fP or
\fBname\fP but not both. Specifying both will result in an error!
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.accept_vpc_peering_connection name=salt\-vpc
# Specify a region
salt myminion boto_vpc.accept_vpc_peering_connection name=salt\-vpc region=us\-west\-2
# specify an id
salt myminion boto_vpc.accept_vpc_peering_connection conn_id=pcx\-8a8939e3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.associate_dhcp_options_to_vpc(dhcp_options_id, vpc_id=None, vpc_name=None, region=None, key=None, keyid=None, profile=None)
Given valid DHCP options id and a valid VPC id, associate the DHCP options record with the VPC.
.sp
Returns True if the DHCP options record were associated and returns False if the DHCP options record was not associated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.associate_dhcp_options_to_vpc \(aqdhcp\-a0bl34pp\(aq \(aqvpc\-6b1fe402\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.associate_network_acl_to_subnet(network_acl_id=None, subnet_id=None, network_acl_name=None, subnet_name=None, region=None, key=None, keyid=None, profile=None)
Given a network acl and subnet ids or names, associate a network acl to a subnet.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.associate_network_acl_to_subnet \e
        network_acl_id=\(aqacl\-5fb85d36\(aq subnet_id=\(aqsubnet\-6a1fe403\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.associate_network_acl_to_subnet \e
        network_acl_id=\(aqmyacl\(aq subnet_id=\(aqmysubnet\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.associate_route_table(route_table_id=None, subnet_id=None, route_table_name=None, subnet_name=None, region=None, key=None, keyid=None, profile=None)
Given a route table and subnet name or id, associates the route table with the subnet.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.associate_route_table \(aqrtb\-1f382e7d\(aq \(aqsubnet\-6a1fe403\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.associate_route_table route_table_name=\(aqmyrtb\(aq \e
        subnet_name=\(aqmysubnet\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.check_vpc(vpc_id=None, vpc_name=None, region=None, key=None, keyid=None, profile=None)
Check whether a VPC with the given name or id exists.
Returns the vpc_id or None. Raises SaltInvocationError if
both vpc_id and vpc_name are None. Optionally raise a
CommandExecutionError if the VPC does not exist.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.check_vpc vpc_name=myvpc profile=awsprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.create(cidr_block, instance_tenancy=None, vpc_name=None, enable_dns_support=None, enable_dns_hostnames=None, tags=None, region=None, key=None, keyid=None, profile=None)
Given a valid CIDR block, create a VPC.
.sp
An optional instance_tenancy argument can be provided. If provided, the
valid values are \(aqdefault\(aq or \(aqdedicated\(aq
.sp
An optional vpc_name argument can be provided.
.sp
Returns {created: true} if the VPC was created and returns
{created: False} if the VPC was not created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.create \(aq10.0.0.0/24\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.create_customer_gateway(vpn_connection_type, ip_address, bgp_asn, customer_gateway_name=None, tags=None, region=None, key=None, keyid=None, profile=None)
Given a valid VPN connection type, a static IP address and a customer
gateway’s Border Gateway Protocol (BGP) Autonomous System Number,
create a customer gateway.
.sp
Returns the customer gateway id if the customer gateway was created and
returns False if the customer gateway was not created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.create_customer_gateway \(aqipsec.1\(aq, \(aq12.1.2.3\(aq, 65534
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.create_dhcp_options(domain_name=None, domain_name_servers=None, ntp_servers=None, netbios_name_servers=None, netbios_node_type=None, dhcp_options_name=None, tags=None, vpc_id=None, vpc_name=None, region=None, key=None, keyid=None, profile=None)
Given valid DHCP options, create a DHCP options record, optionally associating it with
an existing VPC.
.sp
Returns True if the DHCP options record was created and returns False if the DHCP options record was not deleted.
.sp
Changed in version 2015.8.0: Added vpc_name and vpc_id arguments

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.create_dhcp_options domain_name=\(aqexample.com\(aq \e
        domain_name_servers=\(aq[1.2.3.4]\(aq ntp_servers=\(aq[5.6.7.8]\(aq \e
        netbios_name_servers=\(aq[10.0.0.1]\(aq netbios_node_type=1 \e
        vpc_name=\(aqmyvpc\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.create_internet_gateway(internet_gateway_name=None, vpc_id=None, vpc_name=None, tags=None, region=None, key=None, keyid=None, profile=None)
Create an Internet Gateway, optionally attaching it to an existing VPC.
.sp
Returns the internet gateway id if the internet gateway was created and
returns False if the internet gateways was not created.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.create_internet_gateway \e
        internet_gateway_name=myigw vpc_name=myvpc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.create_nat_gateway(subnet_id=None, subnet_name=None, allocation_id=None, region=None, key=None, keyid=None, profile=None)
Create a NAT Gateway within an existing subnet. If allocation_id is
specified, the elastic IP address it references is associated with the
gateway. Otherwise, a new allocation_id is created and used.
.sp
This function requires boto3 to be installed.
.sp
Returns the nat gateway id if the nat gateway was created and
returns False if the nat gateway was not created.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.create_nat_gateway subnet_name=mysubnet
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.create_network_acl(vpc_id=None, vpc_name=None, network_acl_name=None, subnet_id=None, subnet_name=None, tags=None, region=None, key=None, keyid=None, profile=None)
Given a vpc_id, creates a network acl.
.sp
Returns the network acl id if successful, otherwise returns False.
.sp
Changed in version 2015.8.0: Added vpc_name, subnet_id, and subnet_name arguments

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.create_network_acl \(aqvpc\-6b1fe402\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.create_network_acl_entry(network_acl_id=None, rule_number=None, protocol=None, rule_action=None, cidr_block=None, egress=None, network_acl_name=None, icmp_code=None, icmp_type=None, port_range_from=None, port_range_to=None, region=None, key=None, keyid=None, profile=None)
Creates a network acl entry.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.create_network_acl_entry \(aqacl\-5fb85d36\(aq \(aq32767\(aq \e
        \(aqall\(aq \(aqdeny\(aq \(aq0.0.0.0/0\(aq egress=true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.create_route(route_table_id=None, destination_cidr_block=None, route_table_name=None, gateway_id=None, internet_gateway_name=None, instance_id=None, interface_id=None, vpc_peering_connection_id=None, vpc_peering_connection_name=None, region=None, key=None, keyid=None, profile=None, nat_gateway_id=None, nat_gateway_subnet_name=None, nat_gateway_subnet_id=None)
Creates a route.
.sp
If a nat gateway is specified, boto3 must be installed
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.create_route \(aqrtb\-1f382e7d\(aq \(aq10.0.0.0/16\(aq gateway_id=\(aqvgw\-a1b2c3\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.create_route_table(vpc_id=None, vpc_name=None, route_table_name=None, tags=None, region=None, key=None, keyid=None, profile=None)
Creates a route table.
.sp
Changed in version 2015.8.0: Added vpc_name argument

.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.create_route_table vpc_id=\(aqvpc\-6b1fe402\(aq \e
        route_table_name=\(aqmyroutetable\(aq
salt myminion boto_vpc.create_route_table vpc_name=\(aqmyvpc\(aq \e
        route_table_name=\(aqmyroutetable\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.create_subnet(vpc_id=None, cidr_block=None, vpc_name=None, availability_zone=None, subnet_name=None, tags=None, region=None, key=None, keyid=None, profile=None, auto_assign_public_ipv4=False)
Given a valid VPC ID or Name and a CIDR block, create a subnet for the VPC.
.sp
An optional availability zone argument can be provided.
.sp
Returns True if the VPC subnet was created and returns False if the VPC subnet was not created.
.sp
Changed in version 2015.8.0: Added vpc_name argument

.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.create_subnet vpc_id=\(aqvpc\-6b1fe402\(aq \e
        subnet_name=\(aqmysubnet\(aq cidr_block=\(aq10.0.0.0/25\(aq
salt myminion boto_vpc.create_subnet vpc_name=\(aqmyvpc\(aq \e
        subnet_name=\(aqmysubnet\(aq, cidr_block=\(aq10.0.0.0/25\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.customer_gateway_exists(customer_gateway_id=None, customer_gateway_name=None, region=None, key=None, keyid=None, profile=None)
Given a customer gateway ID, check if the customer gateway ID exists.
.sp
Returns True if the customer gateway ID exists; Returns False otherwise.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.customer_gateway_exists cgw\-b6a247df
salt myminion boto_vpc.customer_gateway_exists customer_gatway_name=mycgw
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.delete(vpc_id=None, name=None, vpc_name=None, tags=None, region=None, key=None, keyid=None, profile=None)
Given a VPC ID or VPC name, delete the VPC.
.sp
Returns {deleted: true} if the VPC was deleted and returns
{deleted: false} if the VPC was not deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.delete vpc_id=\(aqvpc\-6b1fe402\(aq
salt myminion boto_vpc.delete name=\(aqmyvpc\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.delete_customer_gateway(customer_gateway_id=None, customer_gateway_name=None, region=None, key=None, keyid=None, profile=None)
Given a customer gateway ID or name, delete the customer gateway.
.sp
Returns True if the customer gateway was deleted and returns False if the customer gateway was not deleted.
.sp
Changed in version 2015.8.0: Added customer_gateway_name argument

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.delete_customer_gateway \(aqcgw\-b6a247df\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.delete_dhcp_options(dhcp_options_id=None, dhcp_options_name=None, region=None, key=None, keyid=None, profile=None)
Delete dhcp options by id or name.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.delete_dhcp_options \(aqdopt\-b6a247df\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.delete_internet_gateway(internet_gateway_id=None, internet_gateway_name=None, detach=False, region=None, key=None, keyid=None, profile=None)
Delete an internet gateway (by name or id).
.sp
Returns True if the internet gateway was deleted and otherwise False.
.sp
New in version 2015.8.0.

.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.delete_internet_gateway internet_gateway_id=igw\-1a2b3c
salt myminion boto_vpc.delete_internet_gateway internet_gateway_name=myigw
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.delete_nat_gateway(nat_gateway_id, release_eips=False, region=None, key=None, keyid=None, profile=None, wait_for_delete=False, wait_for_delete_retries=5)
Delete a nat gateway (by id).
.sp
Returns True if the internet gateway was deleted and otherwise False.
.sp
This function requires boto3 to be installed.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B nat_gateway_id
Id of the NAT Gateway
.TP
.B release_eips
whether to release the elastic IPs associated with the given NAT Gateway Id
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.TP
.B wait_for_delete
whether to wait for delete of the NAT gateway to be in failed or deleted
state after issuing the delete call.
.TP
.B wait_for_delete_retries
NAT gateway may take some time to be go into deleted or failed state.
During the deletion process, subsequent release of elastic IPs may fail;
this state will automatically retry this number of times to ensure
the NAT gateway is in deleted or failed state before proceeding.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.delete_nat_gateway nat_gateway_id=igw\-1a2b3c
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.delete_network_acl(network_acl_id=None, network_acl_name=None, disassociate=False, region=None, key=None, keyid=None, profile=None)
Delete a network acl based on the network_acl_id or network_acl_name provided.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.delete_network_acl network_acl_id=\(aqacl\-5fb85d36\(aq \e
        disassociate=false
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.delete_network_acl network_acl_name=\(aqmyacl\(aq \e
        disassociate=true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.delete_network_acl_entry(network_acl_id=None, rule_number=None, egress=None, network_acl_name=None, region=None, key=None, keyid=None, profile=None)
Deletes a network acl entry.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.delete_network_acl_entry \(aqacl\-5fb85d36\(aq \(aq32767\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.delete_route(route_table_id=None, destination_cidr_block=None, route_table_name=None, region=None, key=None, keyid=None, profile=None)
Deletes a route.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.delete_route \(aqrtb\-1f382e7d\(aq \(aq10.0.0.0/16\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.delete_route_table(route_table_id=None, route_table_name=None, region=None, key=None, keyid=None, profile=None)
Deletes a route table.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.delete_route_table route_table_id=\(aqrtb\-1f382e7d\(aq
salt myminion boto_vpc.delete_route_table route_table_name=\(aqmyroutetable\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.delete_subnet(subnet_id=None, subnet_name=None, region=None, key=None, keyid=None, profile=None)
Given a subnet ID or name, delete the subnet.
.sp
Returns True if the subnet was deleted and returns False if the subnet was not deleted.
.sp
Changed in version 2015.8.0: Added subnet_name argument

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.delete_subnet \(aqsubnet\-6a1fe403\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.delete_vpc_peering_connection(conn_id=None, conn_name=None, region=None, key=None, keyid=None, profile=None, dry_run=False)
Delete a VPC peering connection.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B conn_id
The connection ID to check.  Exclusive with conn_name.
.TP
.B conn_name
The connection name to check.  Exclusive with conn_id.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.TP
.B dry_run
If True, skip application and simply return projected status.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Create a named VPC peering connection
salt myminion boto_vpc.delete_vpc_peering_connection conn_name=salt\-vpc
# Specify a region
salt myminion boto_vpc.delete_vpc_peering_connection conn_name=salt\-vpc region=us\-west\-2
# specify an id
salt myminion boto_vpc.delete_vpc_peering_connection conn_id=pcx\-8a8939e3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.describe(vpc_id=None, vpc_name=None, region=None, key=None, keyid=None, profile=None)
Describe a VPC\(aqs properties. If no VPC ID/Name is spcified then describe the default VPC.
.sp
Returns a dictionary of interesting properties.
.sp
Changed in version 2015.8.0: Added vpc_name argument

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.describe vpc_id=vpc\-123456
salt myminion boto_vpc.describe vpc_name=myvpc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.describe_nat_gateways(nat_gateway_id=None, subnet_id=None, subnet_name=None, vpc_id=None, vpc_name=None, states=(\(aqpending\(aq, \(aqavailable\(aq), region=None, key=None, keyid=None, profile=None)
Return a description of nat gateways matching the selection criteria
.sp
This function requires boto3 to be installed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.describe_nat_gateways nat_gateway_id=\(aqnat\-03b02643b43216fe7\(aq
salt myminion boto_vpc.describe_nat_gateways subnet_id=\(aqsubnet\-5b05942d\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.describe_route_tables(route_table_id=None, route_table_name=None, vpc_id=None, tags=None, region=None, key=None, keyid=None, profile=None)
Given route table properties, return details of all matching route tables.
.sp
This function requires boto3 to be installed.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.describe_route_tables vpc_id=\(aqvpc\-a6a9efc3\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.describe_subnet(subnet_id=None, subnet_name=None, region=None, key=None, keyid=None, profile=None)
Given a subnet id or name, describe its properties.
.sp
Returns a dictionary of interesting properties.
.sp
New in version 2015.8.0.

.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.describe_subnet subnet_id=subnet\-123456
salt myminion boto_vpc.describe_subnet subnet_name=mysubnet
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.describe_subnets(subnet_ids=None, subnet_names=None, vpc_id=None, cidr=None, region=None, key=None, keyid=None, profile=None)
Given a VPC ID or subnet CIDR, returns a list of associated subnets and
their details. Return all subnets if VPC ID or CIDR are not provided.
If a subnet id or CIDR is provided, only its associated subnet details will be
returned.
.sp
New in version 2015.8.0.

.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.describe_subnets
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.describe_subnets subnet_ids=[\(aqsubnet\-ba1987ab\(aq, \(aqsubnet\-ba1987cd\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.describe_subnets vpc_id=vpc\-123456
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.describe_subnets cidr=10.0.0.0/21
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.describe_vpc_peering_connection(name, region=None, key=None, keyid=None, profile=None)
Returns any VPC peering connection id(s) for the given VPC
peering connection name.
.sp
VPC peering connection ids are only returned for connections that
are in the \fBactive\fP, \fBpending\-acceptance\fP or \fBprovisioning\fP
state.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The string name for this VPC peering connection
.IP \(bu 2
\fBregion\fP \-\- The aws region to use
.IP \(bu 2
\fBkey\fP \-\- Your aws key
.IP \(bu 2
\fBkeyid\fP \-\- The key id associated with this aws account
.IP \(bu 2
\fBprofile\fP \-\- The profile to use
.UNINDENT
.TP
.B Returns
dict
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.describe_vpc_peering_connection salt\-vpc
# Specify a region
salt myminion boto_vpc.describe_vpc_peering_connection salt\-vpc region=us\-west\-2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.describe_vpcs(vpc_id=None, name=None, cidr=None, tags=None, region=None, key=None, keyid=None, profile=None)
Describe all VPCs, matching the filter criteria if provided.
.sp
Returns a list of dictionaries with interesting properties.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.describe_vpcs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.dhcp_options_exists(dhcp_options_id=None, name=None, dhcp_options_name=None, tags=None, region=None, key=None, keyid=None, profile=None)
Check if a dhcp option exists.
.sp
Returns True if the dhcp option exists; Returns False otherwise.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.dhcp_options_exists dhcp_options_id=\(aqdhcp\-a0bl34pp\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.disassociate_network_acl(subnet_id=None, vpc_id=None, subnet_name=None, vpc_name=None, region=None, key=None, keyid=None, profile=None)
Given a subnet ID, disassociates a network acl.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.disassociate_network_acl \(aqsubnet\-6a1fe403\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.disassociate_route_table(association_id, region=None, key=None, keyid=None, profile=None)
Disassociates a route table.
.INDENT 7.0
.TP
.B association_id
The Route Table Association ID to disassociate
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.disassociate_route_table \(aqrtbassoc\-d8ccddba\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.exists(vpc_id=None, name=None, cidr=None, tags=None, region=None, key=None, keyid=None, profile=None)
Given a VPC ID, check to see if the given VPC ID exists.
.sp
Returns True if the given VPC ID exists and returns False if the given
VPC ID does not exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.exists myvpc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.get_dhcp_options(dhcp_options_name=None, dhcp_options_id=None, region=None, key=None, keyid=None, profile=None)
Return a dict with the current values of the requested DHCP options set
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.get_dhcp_options \(aqmyfunnydhcpoptionsname\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.get_id(name=None, cidr=None, tags=None, region=None, key=None, keyid=None, profile=None)
Given VPC properties, return the VPC id if a match is found.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.get_id myvpc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.get_resource_id(resource, name=None, resource_id=None, region=None, key=None, keyid=None, profile=None)
Get an AWS id for a VPC resource by type and name.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.get_resource_id internet_gateway myigw
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.get_subnet_association(subnets, region=None, key=None, keyid=None, profile=None)
Given a subnet (aka: a vpc zone identifier) or list of subnets, returns
vpc association.
.sp
Returns a VPC ID if the given subnets are associated with the same VPC ID.
Returns False on an error or if the given subnets are associated with
different VPC IDs.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.get_subnet_association subnet\-61b47516
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.get_subnet_association [\(aqsubnet\-61b47516\(aq,\(aqsubnet\-2cb9785b\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.is_peering_connection_pending(conn_id=None, conn_name=None, region=None, key=None, keyid=None, profile=None)
Check if a VPC peering connection is in the pending state.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B conn_id
The connection ID to check.  Exclusive with conn_name.
.TP
.B conn_name
The connection name to check.  Exclusive with conn_id.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.is_peering_connection_pending conn_name=salt\-vpc
# Specify a region
salt myminion boto_vpc.is_peering_connection_pending conn_name=salt\-vpc region=us\-west\-2
# specify an id
salt myminion boto_vpc.is_peering_connection_pending conn_id=pcx\-8a8939e3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.nat_gateway_exists(nat_gateway_id=None, subnet_id=None, subnet_name=None, vpc_id=None, vpc_name=None, states=(\(aqpending\(aq, \(aqavailable\(aq), region=None, key=None, keyid=None, profile=None)
Checks if a nat gateway exists.
.sp
This function requires boto3 to be installed.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.nat_gateway_exists nat_gateway_id=\(aqnat\-03b02643b43216fe7\(aq
salt myminion boto_vpc.nat_gateway_exists subnet_id=\(aqsubnet\-5b05942d\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.network_acl_exists(network_acl_id=None, name=None, network_acl_name=None, tags=None, region=None, key=None, keyid=None, profile=None)
Checks if a network acl exists.
.sp
Returns True if the network acl exists or returns False if it doesn\(aqt exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.network_acl_exists network_acl_id=\(aqacl\-5fb85d36\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.peering_connection_pending_from_vpc(conn_id=None, conn_name=None, vpc_id=None, vpc_name=None, region=None, key=None, keyid=None, profile=None)
Check if a VPC peering connection is in the pending state, and requested from the given VPC.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B conn_id
The connection ID to check.  Exclusive with conn_name.
.TP
.B conn_name
The connection name to check.  Exclusive with conn_id.
.TP
.B vpc_id
Is this the ID of the requesting VPC for this peering connection.  Exclusive with vpc_name.
.TP
.B vpc_name
Is this the Name of the requesting VPC for this peering connection.  Exclusive with vpc_id.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.is_peering_connection_pending name=salt\-vpc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.replace_network_acl_entry(network_acl_id=None, rule_number=None, protocol=None, rule_action=None, cidr_block=None, egress=None, network_acl_name=None, icmp_code=None, icmp_type=None, port_range_from=None, port_range_to=None, region=None, key=None, keyid=None, profile=None)
Replaces a network acl entry.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.replace_network_acl_entry \(aqacl\-5fb85d36\(aq \(aq32767\(aq \e
        \(aqall\(aq \(aqdeny\(aq \(aq0.0.0.0/0\(aq egress=true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.replace_route(route_table_id=None, destination_cidr_block=None, route_table_name=None, gateway_id=None, instance_id=None, interface_id=None, region=None, key=None, keyid=None, profile=None, vpc_peering_connection_id=None)
Replaces a route.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.replace_route \(aqrtb\-1f382e7d\(aq \(aq10.0.0.0/16\(aq gateway_id=\(aqvgw\-a1b2c3\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.replace_route_table_association(association_id, route_table_id, region=None, key=None, keyid=None, profile=None)
Replaces a route table association.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.replace_route_table_association \(aqrtbassoc\-d8ccddba\(aq \(aqrtb\-1f382e7d\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.request_vpc_peering_connection(requester_vpc_id=None, requester_vpc_name=None, peer_vpc_id=None, peer_vpc_name=None, name=None, peer_owner_id=None, peer_region=None, region=None, key=None, keyid=None, profile=None, dry_run=False)
Request a VPC peering connection between two VPCs.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B requester_vpc_id
ID of the requesting VPC. Exclusive with requester_vpc_name.
.TP
.B requester_vpc_name
Name tag of the requesting VPC.  Exclusive with requester_vpc_id.
.TP
.B peer_vpc_id
ID of the VPC to create VPC peering connection with. This can be a VPC in
another account. Exclusive with peer_vpc_name.
.TP
.B peer_vpc_name
Name tag of the VPC to create VPC peering connection with. This can only
be a VPC in the same account and same region, else resolving it into a
vpc ID will almost certainly fail. Exclusive with peer_vpc_id.
.TP
.B name
The name to use for this VPC peering connection.
.TP
.B peer_owner_id
ID of the owner of the peer VPC. Defaults to your account ID, so a value
is required if peering with a VPC in a different account.
.TP
.B peer_region
Region of peer VPC. For inter\-region vpc peering connections. Not required
for intra\-region peering connections.
.sp
New in version 3005.

.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.TP
.B dry_run
If True, skip application and return status.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Create a named VPC peering connection
salt myminion boto_vpc.request_vpc_peering_connection vpc\-4a3e622e vpc\-be82e9da name=my_vpc_connection
# Without a name
salt myminion boto_vpc.request_vpc_peering_connection vpc\-4a3e622e vpc\-be82e9da
# Specify a region
salt myminion boto_vpc.request_vpc_peering_connection vpc\-4a3e622e vpc\-be82e9da region=us\-west\-2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.resource_exists(resource, name=None, resource_id=None, tags=None, region=None, key=None, keyid=None, profile=None)
Given a resource type and name, return {exists: true} if it exists,
{exists: false} if it does not exist, or {error: {message: error text}
on error.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.resource_exists internet_gateway myigw
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.route_exists(destination_cidr_block, route_table_name=None, route_table_id=None, gateway_id=None, instance_id=None, interface_id=None, tags=None, region=None, key=None, keyid=None, profile=None, vpc_peering_connection_id=None)
Checks if a route exists.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.route_exists destination_cidr_block=\(aq10.0.0.0/20\(aq gateway_id=\(aqlocal\(aq route_table_name=\(aqtest\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.route_table_exists(route_table_id=None, name=None, route_table_name=None, tags=None, region=None, key=None, keyid=None, profile=None)
Checks if a route table exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.route_table_exists route_table_id=\(aqrtb\-1f382e7d\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.boto_vpc.subnet_exists(subnet_id=None, name=None, subnet_name=None, cidr=None, tags=None, zones=None, region=None, key=None, keyid=None, profile=None)
Check if a subnet exists.
.sp
Returns True if the subnet exists, otherwise returns False.
.sp
Changed in version 2015.8.0: Added subnet_name argument
Deprecated name argument

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion boto_vpc.subnet_exists subnet_id=\(aqsubnet\-6a1fe403\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.bower
.SS Manage and query Bower packages
.sp
This module manages the installed packages using Bower.
Note that npm, git and bower must be installed for this module to be
available.
.INDENT 0.0
.TP
.B salt.modules.bower.install(pkg, dir, pkgs=None, runas=None, env=None)
Install a Bower package.
.sp
If no package is specified, the dependencies (from bower.json) of the
package in the given directory will be installed.
.INDENT 7.0
.TP
.B pkg
A package name in any format accepted by Bower, including a version
identifier
.TP
.B dir
The target directory in which to install the package
.TP
.B pkgs
A list of package names in the same format as the \fBpkg\fP parameter
.TP
.B runas
The user to run Bower with
.TP
.B env
Environment variables to set when invoking Bower. Uses the same \fBenv\fP
format as the \fI\%cmd.run\fP execution
function.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bower.install underscore /path/to/project

salt \(aq*\(aq bower.install jquery#2.0 /path/to/project
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bower.list_(dir, runas=None, env=None)
List installed Bower packages.
.INDENT 7.0
.TP
.B dir
The directory whose packages will be listed
.TP
.B runas
The user to run Bower with
.TP
.B env
Environment variables to set when invoking Bower. Uses the same \fBenv\fP
format as the \fI\%cmd.run\fP execution
function.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bower.list /path/to/project
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bower.prune(dir, runas=None, env=None)
New in version 2017.7.0.

.sp
Remove extraneous local Bower packages, i.e. those not referenced in bower.json
.INDENT 7.0
.TP
.B dir
The directory whose packages will be pruned
.TP
.B runas
The user to run Bower with
.TP
.B env
Environment variables to set when invoking Bower. Uses the same \fBenv\fP
format as the \fI\%cmd.run\fP execution
function.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bower.prune /path/to/project
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bower.uninstall(pkg, dir, runas=None, env=None)
Uninstall a Bower package.
.INDENT 7.0
.TP
.B pkg
A package name in any format accepted by Bower
.TP
.B dir
The target directory from which to uninstall the package
.TP
.B runas
The user to run Bower with
.TP
.B env
Environment variables to set when invoking Bower. Uses the same \fBenv\fP
format as the \fI\%cmd.run\fP execution
function.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bower.uninstall underscore /path/to/project
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.bridge
.sp
Module for gathering and managing bridging information
.INDENT 0.0
.TP
.B salt.modules.bridge.add(br=None)
Creates a bridge
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bridge.add br0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bridge.addif(br=None, iface=None)
Adds an interface to a bridge
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bridge.addif br0 eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bridge.delete(br=None)
Deletes a bridge
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bridge.delete br0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bridge.delif(br=None, iface=None)
Removes an interface from a bridge
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bridge.delif br0 eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bridge.find_interfaces(*args)
Returns the bridge to which the interfaces are bond to
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bridge.find_interfaces eth0 [eth1...]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bridge.interfaces(br=None)
Returns interfaces attached to a bridge
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bridge.interfaces br0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bridge.list_()
Returns the machine\(aqs bridges list
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bridge.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bridge.show(br=None)
Returns bridges interfaces along with enslaved physical interfaces. If
no interface is given, all bridges are shown, else only the specified
bridge values are returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bridge.show
salt \(aq*\(aq bridge.show br0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bridge.stp(br=None, state=\(aqdisable\(aq, iface=None)
Sets Spanning Tree Protocol state for a bridge
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bridge.stp br0 enable
salt \(aq*\(aq bridge.stp br0 disable
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For BSD\-like operating systems, it is required to add the interface on
which to enable the STP.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bridge.stp bridge0 enable fxp0
salt \(aq*\(aq bridge.stp bridge0 disable fxp0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.bsd_shadow
.sp
Manage the password database on BSD systems
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage passwords on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqshadow.info\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bsd_shadow.default_hash()
Returns the default hash used for unset passwords
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.default_hash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bsd_shadow.del_password(name)
New in version 2015.8.2.

.sp
Delete the password from name user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.del_password username
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bsd_shadow.gen_password(password, crypt_salt=None, algorithm=\(aqsha512\(aq)
Generate hashed password
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When called this function is called directly via remote\-execution,
the password argument may be displayed in the system\(aqs process list.
This may be a security risk on certain systems.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B password
Plaintext password to be hashed.
.TP
.B crypt_salt
Crpytographic salt. If not given, a random 8\-character salt will be
generated.
.TP
.B algorithm
The following hash algorithms are supported:
.INDENT 7.0
.IP \(bu 2
md5
.IP \(bu 2
blowfish (not in mainline glibc, only available in distros that add it)
.IP \(bu 2
sha256
.IP \(bu 2
sha512 (default)
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.gen_password \(aqI_am_password\(aq
salt \(aq*\(aq shadow.gen_password \(aqI_am_password\(aq crypt_salt=\(aqI_am_salt\(aq algorithm=sha256
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bsd_shadow.info(name)
Return information for the specified user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.info someuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bsd_shadow.set_change(name, change)
Sets the time at which the password expires (in seconds since the UNIX
epoch). See \fBman 8 usermod\fP on NetBSD and OpenBSD or \fBman 8 pw\fP on
FreeBSD.
.sp
A value of \fB0\fP sets the password to never expire.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_change username 1419980400
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bsd_shadow.set_expire(name, expire)
Sets the time at which the account expires (in seconds since the UNIX
epoch). See \fBman 8 usermod\fP on NetBSD and OpenBSD or \fBman 8 pw\fP on
FreeBSD.
.sp
A value of \fB0\fP sets the account to never expire.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_expire username 1419980400
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.bsd_shadow.set_password(name, password)
Set the password for a named user. The password must be a properly defined
hash. A password hash can be generated with \fI\%gen_password()\fP\&.
.sp
It is important to make sure that a supported cipher is used.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_password someuser \(aq$1$UYCIxa628.9qXjpQCjM4a..\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.btrfs
.sp
Module for managing BTRFS file systems.
.INDENT 0.0
.TP
.B salt.modules.btrfs.add(mountpoint, *devices, **kwargs)
Add a devices to a BTRFS filesystem.
.sp
General options:
.INDENT 7.0
.IP \(bu 2
\fBnodiscard\fP: Do not perform whole device TRIM
.IP \(bu 2
\fBforce\fP: Force overwrite existing filesystem on the disk
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.add /mountpoint /dev/sda1 /dev/sda2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.convert(device, permanent=False, keeplf=False)
Convert ext2/3/4 to BTRFS. Device should be mounted.
.sp
Filesystem can be converted temporarily so the further processing and rollback is possible,
or permanently, where previous extended filesystem image gets deleted. Please note, permanent
conversion takes a while as BTRFS filesystem needs to be properly rebalanced afterwards.
.sp
General options:
.INDENT 7.0
.IP \(bu 2
\fBpermanent\fP: Specify if the migration should be permanent (false by default)
.IP \(bu 2
.INDENT 2.0
.TP
\fBkeeplf\fP: Keep \fBlost+found\fP of the partition (removed by default,
but still in the image, if not permanent migration)
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.convert /dev/sda1
salt \(aq*\(aq btrfs.convert /dev/sda1 permanent=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.defragment(path)
Defragment mounted BTRFS filesystem.
In order to defragment a filesystem, device should be properly mounted and writable.
.sp
If passed a device name, then defragmented whole filesystem, mounted on in.
If passed a moun tpoint of the filesystem, then only this mount point is defragmented.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.defragment /dev/sda1
salt \(aq*\(aq btrfs.defragment /path/on/filesystem
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.delete(mountpoint, *devices, **kwargs)
Remove devices from a BTRFS filesystem.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.delete /mountpoint /dev/sda1 /dev/sda2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.devices()
Get known BTRFS formatted devices on the system.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.devices
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.features()
List currently available BTRFS features.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.mkfs_features
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.info(device)
Get BTRFS filesystem information.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.info /dev/sda1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.mkfs(*devices, **kwargs)
Create a file system on the specified device. By default wipes out with force.
.sp
General options:
.INDENT 7.0
.IP \(bu 2
\fBallocsize\fP: Specify the BTRFS offset from the start of the device.
.IP \(bu 2
\fBbytecount\fP: Specify the size of the resultant filesystem.
.IP \(bu 2
\fBnodesize\fP: Node size.
.IP \(bu 2
\fBleafsize\fP: Specify the nodesize, the tree block size in which btrfs stores data.
.IP \(bu 2
\fBnoforce\fP: Prevent force overwrite when an existing filesystem is detected on the device.
.IP \(bu 2
\fBsectorsize\fP: Specify the sectorsize, the minimum data block allocation unit.
.IP \(bu 2
\fBnodiscard\fP: Do not perform whole device TRIM operation by default.
.IP \(bu 2
\fBuuid\fP: Pass UUID or pass True to generate one.
.UNINDENT
.sp
Options:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBdto\fP: (raid0|raid1|raid5|raid6|raid10|single|dup)
Specify how the data must be spanned across the devices specified.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBmto\fP: (raid0|raid1|raid5|raid6|raid10|single|dup)
Specify how metadata must be spanned across the devices specified.
.UNINDENT
.IP \(bu 2
\fBfts\fP: Features (call \fBsalt <host> btrfs.features\fP for full list of available features)
.UNINDENT
.sp
See the \fBmkfs.btrfs(8)\fP manpage for a more complete description of corresponding options description.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.mkfs /dev/sda1
salt \(aq*\(aq btrfs.mkfs /dev/sda1 noforce=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.properties(obj, type=None, set=None)
List properties for given btrfs object. The object can be path of BTRFS device,
mount point, or any directories/files inside the BTRFS filesystem.
.sp
General options:
.INDENT 7.0
.IP \(bu 2
\fBtype\fP: Possible types are s[ubvol], f[ilesystem], i[node] and d[evice].
.IP \(bu 2
\fBforce\fP: Force overwrite existing filesystem on the disk
.IP \(bu 2
\fBset\fP: <key=value,key1=value1...> Options for a filesystem properties.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.properties /mountpoint
salt \(aq*\(aq btrfs.properties /dev/sda1 type=subvol set=\(aqro=false,label=\(dqMy Storage\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.resize(mountpoint, size)
Resize filesystem.
.sp
General options:
.INDENT 7.0
.IP \(bu 2
\fBmountpoint\fP: Specify the BTRFS mountpoint to resize.
.IP \(bu 2
\fBsize\fP: ([+/\-]<newsize>[kKmMgGtTpPeE]|max) Specify the new size of the target.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.resize /mountpoint size=+1g
salt \(aq*\(aq btrfs.resize /dev/sda1 size=max
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.subvolume_create(name, dest=None, qgroupids=None)
Create subvolume \fIname\fP in \fIdest\fP\&.
.sp
Return True if the subvolume is created, False is the subvolume is
already there.
.INDENT 7.0
.TP
.B name
Name of the new subvolume
.TP
.B dest
If not given, the subvolume will be created in the current
directory, if given will be in /dest/name
.TP
.B qgroupids
Add the newly created subcolume to a qgroup. This parameter
is a list
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.subvolume_create var
salt \(aq*\(aq btrfs.subvolume_create var dest=/mnt
salt \(aq*\(aq btrfs.subvolume_create var qgroupids=\(aq[200]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.subvolume_delete(name=None, names=None, commit=None)
Delete the subvolume(s) from the filesystem
.sp
The user can remove one single subvolume (name) or multiple of
then at the same time (names). One of the two parameters needs to
specified.
.sp
Please, refer to the documentation to understand the implication
on the transactions, and when the subvolume is really deleted.
.sp
Return True if the subvolume is deleted, False is the subvolume
was already missing.
.INDENT 7.0
.TP
.B name
Name of the subvolume to remove
.TP
.B names
List of names of subvolumes to remove
.TP
.B commit
.INDENT 7.0
.IP \(bu 2
\(aqafter\(aq: Wait for transaction commit at the end
.IP \(bu 2
\(aqeach\(aq: Wait for transaction commit after each delete
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.subvolume_delete /var/volumes/tmp
salt \(aq*\(aq btrfs.subvolume_delete /var/volumes/tmp commit=after
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.subvolume_exists(path)
Check if a subvolume is present in the filesystem.
.INDENT 7.0
.TP
.B path
Mount point for the subvolume (full path)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.subvolume_exists /mnt/var
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.subvolume_find_new(name, last_gen)
List the recently modified files in a subvolume
.INDENT 7.0
.TP
.B name
Name of the subvolume
.TP
.B last_gen
Last transid marker from where to compare
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.subvolume_find_new /var/volumes/tmp 1024
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.subvolume_get_default(path)
Get the default subvolume of the filesystem path
.INDENT 7.0
.TP
.B path
Mount point for the subvolume
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.subvolume_get_default /var/volumes/tmp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.subvolume_list(path, parent_id=False, absolute=False, ogeneration=False, generation=False, subvolumes=False, uuid=False, parent_uuid=False, sent_subvolume_uuid=False, snapshots=False, readonly=False, deleted=False, generation_cmp=None, ogeneration_cmp=None, sort=None)
List the subvolumes present in the filesystem.
.INDENT 7.0
.TP
.B path
Mount point for the subvolume
.TP
.B parent_id
Print parent ID
.TP
.B absolute
Print all the subvolumes in the filesystem and distinguish
between absolute and relative path with respect to the given
<path>
.TP
.B ogeneration
Print the ogeneration of the subvolume
.TP
.B generation
Print the generation of the subvolume
.TP
.B subvolumes
Print only subvolumes below specified <path>
.TP
.B uuid
Print the UUID of the subvolume
.TP
.B parent_uuid
Print the parent uuid of subvolumes (and snapshots)
.TP
.B sent_subvolume_uuid
Print the UUID of the sent subvolume, where the subvolume is
the result of a receive operation
.TP
.B snapshots
Only snapshot subvolumes in the filesystem will be listed
.TP
.B readonly
Only readonly subvolumes in the filesystem will be listed
.TP
.B deleted
Only deleted subvolumens that are ye not cleaned
.TP
.B generation_cmp
List subvolumes in the filesystem that its generation is >=,
<= or = value. \(aq+\(aq means >= value, \(aq\-\(aq means <= value, If
there is neither \(aq+\(aq nor \(aq\-\(aq, it means = value
.TP
.B ogeneration_cmp
List subvolumes in the filesystem that its ogeneration is >=,
<= or = value
.TP
.B sort
List subvolumes in order by specified items. Possible values:
* rootid
* gen
* ogen
* path
You can add \(aq+\(aq or \(aq\-\(aq in front of each items, \(aq+\(aq means
ascending, \(aq\-\(aq means descending. The default is ascending. You
can combite it in a list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.subvolume_list /var/volumes/tmp
salt \(aq*\(aq btrfs.subvolume_list /var/volumes/tmp path=True
salt \(aq*\(aq btrfs.subvolume_list /var/volumes/tmp sort=\(aq[\-rootid]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.subvolume_set_default(subvolid, path)
Set the subvolume as default
.INDENT 7.0
.TP
.B subvolid
ID of the new default subvolume
.TP
.B path
Mount point for the filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.subvolume_set_default 257 /var/volumes/tmp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.subvolume_show(path)
Show information of a given subvolume
.INDENT 7.0
.TP
.B path
Mount point for the filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.subvolume_show /var/volumes/tmp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.subvolume_snapshot(source, dest=None, name=None, read_only=False)
Create a snapshot of a source subvolume
.INDENT 7.0
.TP
.B source
Source subvolume from where to create the snapshot
.TP
.B dest
If only dest is given, the subvolume will be named as the
basename of the source
.TP
.B name
Name of the snapshot
.TP
.B read_only
Create a read only snapshot
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.subvolume_snapshot /var/volumes/tmp dest=/.snapshots
salt \(aq*\(aq btrfs.subvolume_snapshot /var/volumes/tmp name=backup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.subvolume_sync(path, subvolids=None, sleep=None)
Wait until given subvolume are completely removed from the
filesystem after deletion.
.INDENT 7.0
.TP
.B path
Mount point for the filesystem
.TP
.B subvolids
List of IDs of subvolumes to wait for
.TP
.B sleep
Sleep N seconds betwenn checks (default: 1)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.subvolume_sync /var/volumes/tmp
salt \(aq*\(aq btrfs.subvolume_sync /var/volumes/tmp subvolids=\(aq[257]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.usage(path)
Show in which disk the chunks are allocated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.usage /your/mountpoint
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.btrfs.version()
Return BTRFS version.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq btrfs.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.cabal
.SS Manage and query Cabal packages
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B salt.modules.cabal.install(pkg=None, pkgs=None, user=None, install_global=False, env=None)
Install a cabal package.
.INDENT 7.0
.TP
.B pkg
A package name in format accepted by cabal\-install. See:
\fI\%https://wiki.haskell.org/Cabal\-Install\fP
.TP
.B pkgs
A list of packages names in same format as \fBpkg\fP
.TP
.B user
The user to run cabal install with
.TP
.B install_global
Install package globally instead of locally
.TP
.B env
Environment variables to set when invoking cabal. Uses the
same \fBenv\fP format as the \fI\%cmd.run\fP execution function
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cabal.install shellcheck
salt \(aq*\(aq cabal.install shellcheck\-0.3.5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cabal.list_(pkg=None, user=None, installed=False, env=None)
List packages matching a search string.
.INDENT 7.0
.TP
.B pkg
Search string for matching package names
.TP
.B user
The user to run cabal list with
.TP
.B installed
If True, only return installed packages.
.TP
.B env
Environment variables to set when invoking cabal. Uses the
same \fBenv\fP format as the \fI\%cmd.run\fP execution function
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cabal.list
salt \(aq*\(aq cabal.list ShellCheck
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cabal.uninstall(pkg, user=None, env=None)
Uninstall a cabal package.
.INDENT 7.0
.TP
.B pkg
The package to uninstall
.TP
.B user
The user to run ghc\-pkg unregister with
.TP
.B env
Environment variables to set when invoking cabal. Uses the
same \fBenv\fP format as the \fI\%cmd.run\fP execution function
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cabal.uninstall ShellCheck
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cabal.update(user=None, env=None)
Updates list of known packages.
.INDENT 7.0
.TP
.B user
The user to run cabal update with
.TP
.B env
Environment variables to set when invoking cabal. Uses the
same \fBenv\fP format as the \fI\%cmd.run\fP execution function.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cabal.update
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.capirca_acl
.SS Capirca ACL
.sp
Generate ACL (firewall) configuration for network devices.
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP> & Robert Ankeny <\fI\%robankeny@google.com\fP>
.TP
.B maturity
new
.TP
.B depends
capirca
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.sp
The firewall configuration is generated by \fI\%Capirca\fP\&.
.sp
To install Capirca, execute: \fBpip install capirca\fP\&.
.INDENT 0.0
.TP
.B salt.modules.capirca_acl.get_filter_config(platform, filter_name, filter_options=None, terms=None, prepend=True, pillar_key=\(aqacl\(aq, pillarenv=None, saltenv=None, merge_pillar=True, only_lower_merge=False, revision_id=None, revision_no=None, revision_date=True, revision_date_format=\(aq%Y/%m/%d\(aq)
Return the configuration of a policy filter.
.INDENT 7.0
.TP
.B platform
The name of the Capirca platform.
.TP
.B filter_name
The name of the policy filter.
.TP
.B filter_options
Additional filter options. These options are platform\-specific.
See the complete list of \fI\%options\fP\&.
.TP
.B terms
List of terms for this policy filter.
If not specified or empty, will try to load the configuration from the pillar,
unless \fBmerge_pillar\fP is set as \fBFalse\fP\&.
.TP
.B prepend: \fBTrue\fP
When \fBmerge_pillar\fP is set as \fBTrue\fP, the final list of terms generated by merging
the terms from \fBterms\fP with those defined in the pillar (if any): new terms are prepended
at the beginning, while existing ones will preserve the position. To add the new terms
at the end of the list, set this argument to \fBFalse\fP\&.
.TP
.B pillar_key: \fBacl\fP
The key in the pillar containing the default attributes values. Default: \fBacl\fP\&.
.TP
.B pillarenv
Query the master to generate fresh pillar data on the fly,
specifically from the requested pillar environment.
.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.TP
.B merge_pillar: \fBTrue\fP
Merge the CLI variables with the pillar. Default: \fBTrue\fP\&.
.TP
.B only_lower_merge: \fBFalse\fP
Specify if it should merge only the terms fields. Otherwise it will try
to merge also filters fields. Default: \fBFalse\fP\&.
.TP
.B revision_id
Add a comment in the filter config having the description for the changes applied.
.TP
.B revision_no
The revision count.
.TP
.B revision_date: \fBTrue\fP
Boolean flag: display the date when the filter configuration was generated. Default: \fBTrue\fP\&.
.TP
.B revision_date_format: \fB%Y/%m/%d\fP
The date format to be used when generating the perforce data. Default: \fB%Y/%m/%d\fP (<year>/<month>/<day>).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq capirca.get_filter_config ciscoxr my\-filter pillar_key=netacl
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
! $Id:$
! $Date:$
! $Revision:$
no ipv4 access\-list my\-filter
ipv4 access\-list my\-filter
 remark $Id:$
 remark my\-term
 deny ipv4 any eq 1234 any
 deny ipv4 any eq 1235 any
 remark my\-other\-term
 permit tcp any range 5678 5680 any
exit
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The filter configuration has been loaded from the pillar, having the following structure:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
netacl:
  \- my\-filter:
      terms:
        \- my\-term:
            source_port: [1234, 1235]
            action: reject
        \- my\-other\-term:
            source_port:
              \- [5678, 5680]
            protocol: tcp
            action: accept
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.capirca_acl.get_filter_pillar(filter_name, pillar_key=\(aqacl\(aq, pillarenv=None, saltenv=None)
Helper that can be used inside a state SLS,
in order to get the filter configuration given its name.
.INDENT 7.0
.TP
.B filter_name
The name of the filter.
.TP
.B pillar_key
The root key of the whole policy config.
.TP
.B pillarenv
Query the master to generate fresh pillar data on the fly,
specifically from the requested pillar environment.
.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.capirca_acl.get_policy_config(platform, filters=None, prepend=True, pillar_key=\(aqacl\(aq, pillarenv=None, saltenv=None, merge_pillar=True, only_lower_merge=False, revision_id=None, revision_no=None, revision_date=True, revision_date_format=\(aq%Y/%m/%d\(aq)
Return the configuration of the whole policy.
.INDENT 7.0
.TP
.B platform
The name of the Capirca platform.
.TP
.B filters
List of filters for this policy.
If not specified or empty, will try to load the configuration from the pillar,
unless \fBmerge_pillar\fP is set as \fBFalse\fP\&.
.TP
.B prepend: \fBTrue\fP
When \fBmerge_pillar\fP is set as \fBTrue\fP, the final list of filters generated by merging
the filters from \fBfilters\fP with those defined in the pillar (if any): new filters are prepended
at the beginning, while existing ones will preserve the position. To add the new filters
at the end of the list, set this argument to \fBFalse\fP\&.
.TP
.B pillar_key: \fBacl\fP
The key in the pillar containing the default attributes values. Default: \fBacl\fP\&.
.TP
.B pillarenv
Query the master to generate fresh pillar data on the fly,
specifically from the requested pillar environment.
.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.TP
.B merge_pillar: \fBTrue\fP
Merge the CLI variables with the pillar. Default: \fBTrue\fP\&.
.TP
.B only_lower_merge: \fBFalse\fP
Specify if it should merge only the filters and terms fields. Otherwise it will try
to merge everything at the policy level. Default: \fBFalse\fP\&.
.TP
.B revision_id
Add a comment in the policy config having the description for the changes applied.
.TP
.B revision_no
The revision count.
.TP
.B revision_date: \fBTrue\fP
Boolean flag: display the date when the policy configuration was generated. Default: \fBTrue\fP\&.
.TP
.B revision_date_format: \fB%Y/%m/%d\fP
The date format to be used when generating the perforce data. Default: \fB%Y/%m/%d\fP (<year>/<month>/<day>).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq capirca.get_policy_config juniper pillar_key=netacl
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
firewall {
    family inet {
        replace:
        /*
        ** $Id:$
        ** $Date:$
        ** $Revision:$
        **
        */
        filter my\-filter {
            term my\-term {
                from {
                    source\-port [ 1234 1235 ];
                }
                then {
                    reject;
                }
            }
            term my\-other\-term {
                from {
                    protocol tcp;
                    source\-port 5678\-5680;
                }
                then accept;
            }
        }
    }
}
firewall {
    family inet {
        replace:
        /*
        ** $Id:$
        ** $Date:$
        ** $Revision:$
        **
        */
        filter my\-other\-filter {
            interface\-specific;
            term dummy\-term {
                from {
                    protocol [ tcp udp ];
                }
                then {
                    reject;
                }
            }
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The policy configuration has been loaded from the pillar, having the following structure:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
netacl:
  \- my\-filter:
      options:
        \- not\-interface\-specific
      terms:
        \- my\-term:
            source_port: [1234, 1235]
            action: reject
        \- my\-other\-term:
            source_port:
              \- [5678, 5680]
            protocol: tcp
            action: accept
  \- my\-other\-filter:
      terms:
        \- dummy\-term:
            protocol:
              \- tcp
              \- udp
            action: reject
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.capirca_acl.get_term_config(platform, filter_name, term_name, filter_options=None, pillar_key=\(aqacl\(aq, pillarenv=None, saltenv=None, merge_pillar=True, revision_id=None, revision_no=None, revision_date=True, revision_date_format=\(aq%Y/%m/%d\(aq, source_service=None, destination_service=None, **term_fields)
Return the configuration of a single policy term.
.INDENT 7.0
.TP
.B platform
The name of the Capirca platform.
.TP
.B filter_name
The name of the policy filter.
.TP
.B term_name
The name of the term.
.TP
.B filter_options
Additional filter options. These options are platform\-specific.
E.g.: \fBinet6\fP, \fBbridge\fP, \fBobject\-group\fP,
See the complete list of \fI\%options\fP\&.
.TP
.B pillar_key: \fBacl\fP
The key in the pillar containing the default attributes values. Default: \fBacl\fP\&.
If the pillar contains the following structure:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
firewall:
  \- my\-filter:
      terms:
        \- my\-term:
            source_port: 1234
            source_address:
                \- 1.2.3.4/32
                \- 5.6.7.8/32
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBpillar_key\fP field would be specified as \fBfirewall\fP\&.
.TP
.B pillarenv
Query the master to generate fresh pillar data on the fly,
specifically from the requested pillar environment.
.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.TP
.B merge_pillar: \fBTrue\fP
Merge the CLI variables with the pillar. Default: \fBTrue\fP\&.
.TP
.B revision_id
Add a comment in the term config having the description for the changes applied.
.TP
.B revision_no
The revision count.
.TP
.B revision_date: \fBTrue\fP
Boolean flag: display the date when the term configuration was generated. Default: \fBTrue\fP\&.
.TP
.B revision_date_format: \fB%Y/%m/%d\fP
The date format to be used when generating the perforce data. Default: \fB%Y/%m/%d\fP (<year>/<month>/<day>).
.TP
.B source_service
A special service to choose from. This is a helper so the user is able to
select a source just using the name, instead of specifying a source_port and protocol.
.sp
As this module is available on Unix platforms only,
it reads the \fI\%IANA\fP port assignment from \fB/etc/services\fP\&.
.sp
If the user requires additional shortcuts to be referenced, they can add entries under \fB/etc/services\fP,
which can be managed using the \fI\%file state\fP\&.
.TP
.B destination_service
A special service to choose from. This is a helper so the user is able to
select a source just using the name, instead of specifying a destination_port and protocol.
Allows the same options as \fBsource_service\fP\&.
.TP
.B term_fields
Term attributes.
To see what fields are supported, please consult the list of supported \fI\%keywords\fP\&.
Some platforms have few other \fI\%optional\fP keywords.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The following fields are accepted:
.INDENT 0.0
.IP \(bu 2
action
.IP \(bu 2
address
.IP \(bu 2
address_exclude
.IP \(bu 2
comment
.IP \(bu 2
counter
.IP \(bu 2
expiration
.IP \(bu 2
destination_address
.IP \(bu 2
destination_address_exclude
.IP \(bu 2
destination_port
.IP \(bu 2
destination_prefix
.IP \(bu 2
forwarding_class
.IP \(bu 2
forwarding_class_except
.IP \(bu 2
logging
.IP \(bu 2
log_name
.IP \(bu 2
loss_priority
.IP \(bu 2
option
.IP \(bu 2
policer
.IP \(bu 2
port
.IP \(bu 2
precedence
.IP \(bu 2
principals
.IP \(bu 2
protocol
.IP \(bu 2
protocol_except
.IP \(bu 2
qos
.IP \(bu 2
pan_application
.IP \(bu 2
routing_instance
.IP \(bu 2
source_address
.IP \(bu 2
source_address_exclude
.IP \(bu 2
source_port
.IP \(bu 2
source_prefix
.IP \(bu 2
verbatim
.IP \(bu 2
packet_length
.IP \(bu 2
fragment_offset
.IP \(bu 2
hop_limit
.IP \(bu 2
icmp_type
.IP \(bu 2
ether_type
.IP \(bu 2
traffic_class_count
.IP \(bu 2
traffic_type
.IP \(bu 2
translated
.IP \(bu 2
dscp_set
.IP \(bu 2
dscp_match
.IP \(bu 2
dscp_except
.IP \(bu 2
next_ip
.IP \(bu 2
flexible_match_range
.IP \(bu 2
source_prefix_except
.IP \(bu 2
destination_prefix_except
.IP \(bu 2
vpn
.IP \(bu 2
source_tag
.IP \(bu 2
destination_tag
.IP \(bu 2
source_interface
.IP \(bu 2
destination_interface
.IP \(bu 2
flattened
.IP \(bu 2
flattened_addr
.IP \(bu 2
flattened_saddr
.IP \(bu 2
flattened_daddr
.IP \(bu 2
priority
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The following fields can be also a single value and a list of values:
.INDENT 0.0
.IP \(bu 2
action
.IP \(bu 2
address
.IP \(bu 2
address_exclude
.IP \(bu 2
comment
.IP \(bu 2
destination_address
.IP \(bu 2
destination_address_exclude
.IP \(bu 2
destination_port
.IP \(bu 2
destination_prefix
.IP \(bu 2
forwarding_class
.IP \(bu 2
forwarding_class_except
.IP \(bu 2
logging
.IP \(bu 2
option
.IP \(bu 2
port
.IP \(bu 2
precedence
.IP \(bu 2
principals
.IP \(bu 2
protocol
.IP \(bu 2
protocol_except
.IP \(bu 2
pan_application
.IP \(bu 2
source_address
.IP \(bu 2
source_address_exclude
.IP \(bu 2
source_port
.IP \(bu 2
source_prefix
.IP \(bu 2
verbatim
.IP \(bu 2
icmp_type
.IP \(bu 2
ether_type
.IP \(bu 2
traffic_type
.IP \(bu 2
dscp_match
.IP \(bu 2
dscp_except
.IP \(bu 2
flexible_match_range
.IP \(bu 2
source_prefix_except
.IP \(bu 2
destination_prefix_except
.IP \(bu 2
source_tag
.IP \(bu 2
destination_tag
.IP \(bu 2
source_service
.IP \(bu 2
destination_service
.UNINDENT
.sp
Example: \fBdestination_address\fP can be either defined as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
destination_address: 172.17.17.1/24
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or as a list of destination IP addresses:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
destination_address:
    \- 172.17.17.1/24
    \- 172.17.19.1/24
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or a list of services to be matched:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
source_service:
    \- ntp
    \- snmp
    \- ldap
    \- bgpd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The port fields \fBsource_port\fP and \fBdestination_port\fP can be used as above to select either
a single value, either a list of values, but also they can select port ranges. Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
source_port:
    \- [1000, 2000]
    \- [3000, 4000]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With the configuration above, the user is able to select the 1000\-2000 and 3000\-4000 source port ranges.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq capirca.get_term_config arista filter\-name term\-name source_address=1.2.3.4 destination_address=5.6.7.8 action=accept
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
! $Date: 2017/03/22 $
no ip access\-list filter\-name
ip access\-list filter\-name
 remark term\-name
 permit ip host 1.2.3.4 host 5.6.7.8
exit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.capirca_acl.get_term_pillar(filter_name, term_name, pillar_key=\(aqacl\(aq, pillarenv=None, saltenv=None)
Helper that can be used inside a state SLS,
in order to get the term configuration given its name,
under a certain filter uniquely identified by its name.
.INDENT 7.0
.TP
.B filter_name
The name of the filter.
.TP
.B term_name
The name of the term.
.TP
.B pillar_key: \fBacl\fP
The root key of the whole policy config. Default: \fBacl\fP\&.
.TP
.B pillarenv
Query the master to generate fresh pillar data on the fly,
specifically from the requested pillar environment.
.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.UNINDENT
.UNINDENT
.SS salt.modules.cassandra_cql
.sp
Cassandra Database Module
.sp
New in version 2015.5.0.

.sp
This module works with Cassandra v2 and v3 and hence generates
queries based on the internal schema of said version.
.INDENT 0.0
.TP
.B depends
DataStax Python Driver for Apache Cassandra
\fI\%https://github.com/datastax/python\-driver\fP
pip install cassandra\-driver
.TP
.B referenced by
Salt\(aqs cassandra_cql returner
.TP
.B configuration
The Cassandra cluster members and connection port can either be specified
in the master or minion config, the minion\(aqs pillar or be passed to the module.
.sp
Example configuration in the config for a single node:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cassandra:
  cluster: 192.168.50.10
  port: 9000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example configuration in the config for a cluster:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cassandra:
  cluster:
    \- 192.168.50.10
    \- 192.168.50.11
    \- 192.168.50.12
  port: 9000
  username: cas_admin
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2016.11.0.

.sp
Added support for \fBssl_options\fP and \fBprotocol_version\fP\&.
.sp
Example configuration with
\fI\%ssl options\fP:
.sp
If \fBssl_options\fP are present in cassandra config the cassandra_cql returner
will use SSL. SSL isn\(aqt used if \fBssl_options\fP isn\(aqt specified.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cassandra:
  cluster:
    \- 192.168.50.10
    \- 192.168.50.11
    \- 192.168.50.12
  port: 9000
  username: cas_admin

  ssl_options:
    ca_certs: /etc/ssl/certs/ca\-bundle.trust.crt

    # SSL version should be one from the ssl module
    # This is an optional parameter
    ssl_version: PROTOCOL_TLSv1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Additionally you can also specify the \fBprotocol_version\fP to
\fI\%use\fP\&.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cassandra:
  cluster:
    \- 192.168.50.10
    \- 192.168.50.11
    \- 192.168.50.12
  port: 9000
  username: cas_admin

  # defaults to 4, if not set
  protocol_version: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Also all configuration could be passed directly to module as arguments.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
salt minion1 cassandra_cql.info contact_points=delme\-nextgen\-01 port=9042 cql_user=cassandra cql_pass=cassandra protocol_version=4
.sp
salt minion1 cassandra_cql.info ssl_options=\(aq{\(dqca_certs\(dq: /path/to/\-ca.crt}\(aq
.sp
We can also provide the load balancing policy as arguments
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
salt minion1 cassandra_cql.cql_query \(dqalter user cassandra with password \(aqcassandra2\(aq ;\(dq contact_points=scylladb cql_user=user1 cql_pass=password port=9142 protocol_version=4 ssl_options=\(aq{\(dqca_certs\(dq: path\-to\-client\-ca.crt}\(aq load_balancing_policy=DCAwareRoundRobinPolicy load_balancing_policy_args=\(aq{\(dqlocal_dc\(dq: \(dqdatacenter1\(dq}\(aq
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cassandra_cql.cql_query(query, contact_points=None, port=None, cql_user=None, cql_pass=None, protocol_version=None, load_balancing_policy=None, load_balancing_policy_args=None, ssl_options=None)
Run a query on a Cassandra cluster and return a dictionary.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBquery\fP (\fI\%str\fP) \-\- The query to execute.
.IP \(bu 2
\fBcontact_points\fP (\fI\%str\fP\fI | \fP\fI\%list\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The Cassandra cluster addresses, can either be a string or a list of IPs.
.IP \(bu 2
\fBcql_user\fP (\fI\%str\fP) \-\- The Cassandra user if authentication is turned on.
.IP \(bu 2
\fBcql_pass\fP (\fI\%str\fP) \-\- The Cassandra user password if authentication is turned on.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The Cassandra cluster port, defaults to None.
.IP \(bu 2
\fBparams\fP (\fI\%str\fP) \-\- The parameters for the query, optional.
.IP \(bu 2
\fBprotocol_version\fP (\fI\%int\fP) \-\- Cassandra protocol version to use.
.IP \(bu 2
\fBload_balancing_policy\fP (\fI\%str\fP) \-\- cassandra.policy class name to use
.IP \(bu 2
\fBload_balancing_policy_args\fP (\fI\%dict\fP) \-\- cassandra.policy constructor args
.IP \(bu 2
\fBssl_options\fP (\fI\%dict\fP) \-\- Cassandra protocol version to use.
.UNINDENT
.TP
.B Returns
A dictionary from the return values of the query
.TP
.B Return type
\fI\%list\fP[\fI\%dict\fP]
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqcassandra\-server\(aq cassandra_cql.cql_query \(dqSELECT * FROM users_by_name WHERE first_name = \(aqjane\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cassandra_cql.cql_query_with_prepare(query, statement_name, statement_arguments, asynchronous=False, callback_errors=None, contact_points=None, port=None, cql_user=None, cql_pass=None, protocol_version=None, load_balancing_policy=None, load_balancing_policy_args=None, ssl_options=None, **kwargs)
Run a query on a Cassandra cluster and return a dictionary.
.sp
This function should not be used asynchronously for SELECTs \-\- it will not
return anything and we don\(aqt currently have a mechanism for handling a future
that will return results.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBquery\fP (\fI\%str\fP) \-\- The query to execute.
.IP \(bu 2
\fBstatement_name\fP (\fI\%str\fP) \-\- Name to assign the prepared statement in the __context__ dictionary
.IP \(bu 2
\fBstatement_arguments\fP (\fI\%list\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- Bind parameters for the SQL statement
.IP \(bu 2
\fBasynchronous\fP (\fI\%bool\fP) \-\- Run this query in asynchronous mode
.IP \(bu 2
\fBasync\fP (\fI\%bool\fP) \-\- Run this query in asynchronous mode (an alias to \(aqasynchronous\(aq)
NOTE: currently it overrides \(aqasynchronous\(aq and it will be dropped in version 3001!
.IP \(bu 2
\fBcallback_errors\fP (\fIFunction callable\fP) \-\- Function to call after query runs if there is an error
.IP \(bu 2
\fBcontact_points\fP (\fI\%str\fP\fI | \fP\fI\%list\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The Cassandra cluster addresses, can either be a string or a list of IPs.
.IP \(bu 2
\fBcql_user\fP (\fI\%str\fP) \-\- The Cassandra user if authentication is turned on.
.IP \(bu 2
\fBcql_pass\fP (\fI\%str\fP) \-\- The Cassandra user password if authentication is turned on.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The Cassandra cluster port, defaults to None.
.IP \(bu 2
\fBparams\fP (\fI\%str\fP) \-\- The parameters for the query, optional.
.IP \(bu 2
\fBprotocol_version\fP \-\- Cassandra protocol version to use.
.IP \(bu 2
\fBload_balancing_policy\fP (\fI\%str\fP) \-\- cassandra.policy class name to use
.IP \(bu 2
\fBload_balancing_policy_args\fP (\fI\%dict\fP) \-\- cassandra.policy constructor args
.IP \(bu 2
\fBssl_options\fP (\fI\%dict\fP) \-\- Cassandra protocol version to use.
.UNINDENT
.TP
.B Returns
A dictionary from the return values of the query
.TP
.B Return type
\fI\%list\fP[\fI\%dict\fP]
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Insert data asynchronously
salt this\-node cassandra_cql.cql_query_with_prepare \(dqname_insert\(dq \(dqINSERT INTO USERS (first_name, last_name) VALUES (?, ?)\(dq             statement_arguments=[\(aqJohn\(aq,\(aqDoe\(aq], asynchronous=True

# Select data, should not be asynchronous because there is not currently a facility to return data from a future
salt this\-node cassandra_cql.cql_query_with_prepare \(dqname_select\(dq \(dqSELECT * FROM USERS WHERE first_name=?\(dq             statement_arguments=[\(aqJohn\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cassandra_cql.create_keyspace(keyspace, replication_strategy=\(aqSimpleStrategy\(aq, replication_factor=1, replication_datacenters=None, contact_points=None, port=None, cql_user=None, cql_pass=None, protocol_version=None, load_balancing_policy=None, load_balancing_policy_args=None, ssl_options=None)
Create a new keyspace in Cassandra.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkeyspace\fP (\fI\%str\fP) \-\- The keyspace name
.IP \(bu 2
\fBreplication_strategy\fP (\fI\%str\fP) \-\- either \fISimpleStrategy\fP or \fINetworkTopologyStrategy\fP
.IP \(bu 2
\fBreplication_factor\fP (\fI\%int\fP) \-\- number of replicas of data on multiple nodes. not used if using NetworkTopologyStrategy
.IP \(bu 2
\fBreplication_datacenters\fP (\fI\%str\fP\fI | \fP\fI\%dict\fP\fI[\fP\fI\%str\fP\fI, \fP\fI\%int\fP\fI]\fP) \-\- string or dict of datacenter names to replication factors, required if using
NetworkTopologyStrategy (will be a dict if coming from state file).
.IP \(bu 2
\fBcontact_points\fP (\fI\%str\fP\fI | \fP\fI\%list\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The Cassandra cluster addresses, can either be a string or a list of IPs.
.IP \(bu 2
\fBcql_user\fP (\fI\%str\fP) \-\- The Cassandra user if authentication is turned on.
.IP \(bu 2
\fBcql_pass\fP (\fI\%str\fP) \-\- The Cassandra user password if authentication is turned on.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The Cassandra cluster port, defaults to None.
.IP \(bu 2
\fBprotocol_version\fP (\fI\%int\fP) \-\- Cassandra protocol version to use.
.IP \(bu 2
\fBload_balancing_policy\fP (\fI\%str\fP) \-\- cassandra.policy class name to use
.IP \(bu 2
\fBload_balancing_policy_args\fP (\fI\%dict\fP) \-\- cassandra.policy constructor args
.IP \(bu 2
\fBssl_options\fP (\fI\%dict\fP) \-\- Cassandra protocol version to use.
.UNINDENT
.TP
.B Returns
The info for the keyspace or False if it does not exist.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# CLI Example:
salt \(aqminion1\(aq cassandra_cql.create_keyspace keyspace=newkeyspace

salt \(aqminion1\(aq cassandra_cql.create_keyspace keyspace=newkeyspace replication_strategy=NetworkTopologyStrategy         replication_datacenters=\(aq{\(dqdatacenter_1\(dq: 3, \(dqdatacenter_2\(dq: 2}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cassandra_cql.create_user(username, password, superuser=False, contact_points=None, port=None, cql_user=None, cql_pass=None, protocol_version=None, load_balancing_policy=None, load_balancing_policy_args=None, ssl_options=None)
Create a new cassandra user with credentials and superuser status.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBusername\fP (\fI\%str\fP) \-\- The name of the new user.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- The password of the new user.
.IP \(bu 2
\fBsuperuser\fP (\fI\%bool\fP) \-\- Is the new user going to be a superuser? default: False
.IP \(bu 2
\fBcontact_points\fP (\fI\%str\fP\fI | \fP\fI\%list\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The Cassandra cluster addresses, can either be a string or a list of IPs.
.IP \(bu 2
\fBcql_user\fP (\fI\%str\fP) \-\- The Cassandra user if authentication is turned on.
.IP \(bu 2
\fBcql_pass\fP (\fI\%str\fP) \-\- The Cassandra user password if authentication is turned on.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The Cassandra cluster port, defaults to None.
.IP \(bu 2
\fBprotocol_version\fP (\fI\%int\fP) \-\- Cassandra protocol version to use.
.IP \(bu 2
\fBload_balancing_policy\fP (\fI\%str\fP) \-\- cassandra.policy class name to use
.IP \(bu 2
\fBload_balancing_policy_args\fP (\fI\%dict\fP) \-\- cassandra.policy constructor args
.IP \(bu 2
\fBssl_options\fP (\fI\%dict\fP) \-\- Cassandra protocol version to use.
.UNINDENT
.TP
.B Returns

.TP
.B Return type

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion1\(aq cassandra_cql.create_user username=joe password=secret

salt \(aqminion1\(aq cassandra_cql.create_user username=joe password=secret superuser=True

salt \(aqminion1\(aq cassandra_cql.create_user username=joe password=secret superuser=True contact_points=minion1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cassandra_cql.drop_keyspace(keyspace, contact_points=None, port=None, cql_user=None, cql_pass=None, protocol_version=None, load_balancing_policy=None, load_balancing_policy_args=None, ssl_options=None)
Drop a keyspace if it exists in a Cassandra cluster.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkeyspace\fP (\fI\%str\fP) \-\- The keyspace to drop.
.IP \(bu 2
\fBcontact_points\fP (\fI\%str\fP\fI | \fP\fI\%list\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The Cassandra cluster addresses, can either be a string or a list of IPs.
.IP \(bu 2
\fBcql_user\fP (\fI\%str\fP) \-\- The Cassandra user if authentication is turned on.
.IP \(bu 2
\fBcql_pass\fP (\fI\%str\fP) \-\- The Cassandra user password if authentication is turned on.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The Cassandra cluster port, defaults to None.
.IP \(bu 2
\fBprotocol_version\fP (\fI\%int\fP) \-\- Cassandra protocol version to use.
.IP \(bu 2
\fBload_balancing_policy\fP (\fI\%str\fP) \-\- cassandra.policy class name to use
.IP \(bu 2
\fBload_balancing_policy_args\fP (\fI\%dict\fP) \-\- cassandra.policy constructor args
.IP \(bu 2
\fBssl_options\fP (\fI\%dict\fP) \-\- Cassandra protocol version to use.
.UNINDENT
.TP
.B Returns
The info for the keyspace or False if it does not exist.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion1\(aq cassandra_cql.drop_keyspace keyspace=test

salt \(aqminion1\(aq cassandra_cql.drop_keyspace keyspace=test contact_points=minion1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cassandra_cql.grant_permission(username, resource=None, resource_type=\(aqkeyspace\(aq, permission=None, contact_points=None, port=None, cql_user=None, cql_pass=None, protocol_version=None, load_balancing_policy=None, load_balancing_policy_args=None, ssl_options=None)
Grant permissions to a user.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBusername\fP (\fI\%str\fP) \-\- The name of the user to grant permissions to.
.IP \(bu 2
\fBresource\fP (\fI\%str\fP) \-\- The resource (keyspace or table), if None, permissions for all resources are granted.
.IP \(bu 2
\fBresource_type\fP (\fI\%str\fP) \-\- The resource_type (keyspace or table), defaults to \(aqkeyspace\(aq.
.IP \(bu 2
\fBpermission\fP (\fI\%str\fP) \-\- A permission name (e.g. select), if None, all permissions are granted.
.IP \(bu 2
\fBcontact_points\fP (\fI\%str\fP\fI | \fP\fI\%list\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The Cassandra cluster addresses, can either be a string or a list of IPs.
.IP \(bu 2
\fBcql_user\fP (\fI\%str\fP) \-\- The Cassandra user if authentication is turned on.
.IP \(bu 2
\fBcql_pass\fP (\fI\%str\fP) \-\- The Cassandra user password if authentication is turned on.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The Cassandra cluster port, defaults to None.
.IP \(bu 2
\fBprotocol_version\fP (\fI\%int\fP) \-\- Cassandra protocol version to use.
.IP \(bu 2
\fBload_balancing_policy\fP (\fI\%str\fP) \-\- cassandra.policy class name to use
.IP \(bu 2
\fBload_balancing_policy_args\fP (\fI\%dict\fP) \-\- cassandra.policy constructor args
.IP \(bu 2
\fBssl_options\fP (\fI\%dict\fP) \-\- Cassandra protocol version to use.
.UNINDENT
.TP
.B Returns

.TP
.B Return type

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion1\(aq cassandra_cql.grant_permission

salt \(aqminion1\(aq cassandra_cql.grant_permission username=joe resource=test_keyspace permission=select

salt \(aqminion1\(aq cassandra_cql.grant_permission username=joe resource=test_table resource_type=table         permission=select contact_points=minion1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cassandra_cql.info(contact_points=None, port=None, cql_user=None, cql_pass=None, protocol_version=None, load_balancing_policy=None, load_balancing_policy_args=None, ssl_options=None)
Show the Cassandra information for this cluster.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontact_points\fP (\fI\%str\fP\fI | \fP\fI\%list\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The Cassandra cluster addresses, can either be a string or a list of IPs.
.IP \(bu 2
\fBcql_user\fP (\fI\%str\fP) \-\- The Cassandra user if authentication is turned on.
.IP \(bu 2
\fBcql_pass\fP (\fI\%str\fP) \-\- The Cassandra user password if authentication is turned on.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The Cassandra cluster port, defaults to None.
.IP \(bu 2
\fBprotocol_version\fP (\fI\%int\fP) \-\- Cassandra protocol version to use.
.IP \(bu 2
\fBload_balancing_policy\fP (\fI\%str\fP) \-\- cassandra.policy class name to use
.IP \(bu 2
\fBload_balancing_policy_args\fP (\fI\%dict\fP) \-\- cassandra.policy constructor args
.IP \(bu 2
\fBssl_options\fP (\fI\%dict\fP) \-\- Cassandra protocol version to use.
.UNINDENT
.TP
.B Returns
The information for this Cassandra cluster.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion1\(aq cassandra_cql.info

salt \(aqminion1\(aq cassandra_cql.info contact_points=minion1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cassandra_cql.keyspace_exists(keyspace, contact_points=None, port=None, cql_user=None, cql_pass=None, protocol_version=None, load_balancing_policy=None, load_balancing_policy_args=None, ssl_options=None)
Check if a keyspace exists in a Cassandra cluster.
.sp
:param keyspace        The keyspace name to check for.
:type  keyspace:       str
:param contact_points: The Cassandra cluster addresses, can either be a string or a list of IPs.
:type  contact_points: str | list[str]
:param cql_user:       The Cassandra user if authentication is turned on.
:type  cql_user:       str
:param cql_pass:       The Cassandra user password if authentication is turned on.
:type  cql_pass:       str
:param port:           The Cassandra cluster port, defaults to None.
:type  port:           int
:param protocol_version: Cassandra protocol version to use.
:type  protocol_version: int
:param load_balancing_policy: cassandra.policy class name to use
:type  load_balancing_policy: str
:param load_balancing_policy_args: cassandra.policy constructor args
:type  load_balancing_policy_args: dict
:param ssl_options:    Cassandra protocol version to use.
:type  ssl_options:    dict
:return:               The info for the keyspace or False if it does not exist.
:rtype:                dict
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion1\(aq cassandra_cql.keyspace_exists keyspace=system
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cassandra_cql.list_column_families(keyspace=None, contact_points=None, port=None, cql_user=None, cql_pass=None, protocol_version=None, load_balancing_policy=None, load_balancing_policy_args=None, ssl_options=None)
List column families in a Cassandra cluster for all keyspaces or just the provided one.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkeyspace\fP (\fI\%str\fP) \-\- The keyspace to provide the column families for, optional.
.IP \(bu 2
\fBcontact_points\fP (\fI\%str\fP\fI | \fP\fI\%list\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The Cassandra cluster addresses, can either be a string or a list of IPs.
.IP \(bu 2
\fBcql_user\fP (\fI\%str\fP) \-\- The Cassandra user if authentication is turned on.
.IP \(bu 2
\fBcql_pass\fP (\fI\%str\fP) \-\- The Cassandra user password if authentication is turned on.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The Cassandra cluster port, defaults to None.
.IP \(bu 2
\fBprotocol_version\fP (\fI\%int\fP) \-\- Cassandra protocol version to use.
.IP \(bu 2
\fBload_balancing_policy\fP (\fI\%str\fP) \-\- cassandra.policy class name to use
.IP \(bu 2
\fBload_balancing_policy_args\fP (\fI\%dict\fP) \-\- cassandra.policy constructor args
.IP \(bu 2
\fBssl_options\fP (\fI\%dict\fP) \-\- Cassandra protocol version to use.
.UNINDENT
.TP
.B Returns
The column families in this Cassandra cluster.
.TP
.B Return type
\fI\%list\fP[\fI\%dict\fP]
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion1\(aq cassandra_cql.list_column_families

salt \(aqminion1\(aq cassandra_cql.list_column_families contact_points=minion1

salt \(aqminion1\(aq cassandra_cql.list_column_families keyspace=system
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cassandra_cql.list_keyspaces(contact_points=None, port=None, cql_user=None, cql_pass=None, protocol_version=None, load_balancing_policy=None, load_balancing_policy_args=None, ssl_options=None)
List keyspaces in a Cassandra cluster.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontact_points\fP (\fI\%str\fP\fI | \fP\fI\%list\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The Cassandra cluster addresses, can either be a string or a list of IPs.
.IP \(bu 2
\fBcql_user\fP (\fI\%str\fP) \-\- The Cassandra user if authentication is turned on.
.IP \(bu 2
\fBcql_pass\fP (\fI\%str\fP) \-\- The Cassandra user password if authentication is turned on.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The Cassandra cluster port, defaults to None.
.IP \(bu 2
\fBprotocol_version\fP (\fI\%int\fP) \-\- Cassandra protocol version to use.
.IP \(bu 2
\fBload_balancing_policy\fP (\fI\%str\fP) \-\- cassandra.policy class name to use
.IP \(bu 2
\fBload_balancing_policy_args\fP (\fI\%dict\fP) \-\- cassandra.policy constructor args
.IP \(bu 2
\fBssl_options\fP (\fI\%dict\fP) \-\- Cassandra protocol version to use.
.UNINDENT
.TP
.B Returns
The keyspaces in this Cassandra cluster.
.TP
.B Return type
\fI\%list\fP[\fI\%dict\fP]
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion1\(aq cassandra_cql.list_keyspaces

salt \(aqminion1\(aq cassandra_cql.list_keyspaces contact_points=minion1 port=9000
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cassandra_cql.list_permissions(username=None, resource=None, resource_type=\(aqkeyspace\(aq, permission=None, contact_points=None, port=None, cql_user=None, cql_pass=None, protocol_version=None, load_balancing_policy=None, load_balancing_policy_args=None, ssl_options=None)
List permissions.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBusername\fP (\fI\%str\fP) \-\- The name of the user to list permissions for.
.IP \(bu 2
\fBresource\fP (\fI\%str\fP) \-\- The resource (keyspace or table), if None, permissions for all resources are listed.
.IP \(bu 2
\fBresource_type\fP (\fI\%str\fP) \-\- The resource_type (keyspace or table), defaults to \(aqkeyspace\(aq.
.IP \(bu 2
\fBpermission\fP (\fI\%str\fP) \-\- A permission name (e.g. select), if None, all permissions are listed.
.IP \(bu 2
\fBcontact_points\fP (\fI\%str\fP\fI | \fP\fI\%list\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The Cassandra cluster addresses, can either be a string or a list of IPs.
.IP \(bu 2
\fBcql_user\fP (\fI\%str\fP) \-\- The Cassandra user if authentication is turned on.
.IP \(bu 2
\fBcql_pass\fP (\fI\%str\fP) \-\- The Cassandra user password if authentication is turned on.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The Cassandra cluster port, defaults to None.
.IP \(bu 2
\fBprotocol_version\fP (\fI\%int\fP) \-\- Cassandra protocol version to use.
.IP \(bu 2
\fBload_balancing_policy\fP (\fI\%str\fP) \-\- cassandra.policy class name to use
.IP \(bu 2
\fBload_balancing_policy_args\fP (\fI\%dict\fP) \-\- cassandra.policy constructor args
.IP \(bu 2
\fBssl_options\fP (\fI\%dict\fP) \-\- Cassandra protocol version to use.
.UNINDENT
.TP
.B Returns
Dictionary of permissions.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion1\(aq cassandra_cql.list_permissions

salt \(aqminion1\(aq cassandra_cql.list_permissions username=joe resource=test_keyspace permission=select

salt \(aqminion1\(aq cassandra_cql.list_permissions username=joe resource=test_table resource_type=table           permission=select contact_points=minion1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cassandra_cql.list_users(contact_points=None, port=None, cql_user=None, cql_pass=None, protocol_version=None, load_balancing_policy=None, load_balancing_policy_args=None, ssl_options=None)
List existing users in this Cassandra cluster.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontact_points\fP (\fI\%str\fP\fI | \fP\fI\%list\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The Cassandra cluster addresses, can either be a string or a list of IPs.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The Cassandra cluster port, defaults to None.
.IP \(bu 2
\fBcql_user\fP (\fI\%str\fP) \-\- The Cassandra user if authentication is turned on.
.IP \(bu 2
\fBcql_pass\fP (\fI\%str\fP) \-\- The Cassandra user password if authentication is turned on.
.IP \(bu 2
\fBprotocol_version\fP (\fI\%int\fP) \-\- Cassandra protocol version to use.
.IP \(bu 2
\fBload_balancing_policy\fP (\fI\%str\fP) \-\- cassandra.policy class name to use
.IP \(bu 2
\fBload_balancing_policy_args\fP (\fI\%dict\fP) \-\- cassandra.policy constructor args
.IP \(bu 2
\fBssl_options\fP (\fI\%dict\fP) \-\- Cassandra protocol version to use.
.UNINDENT
.TP
.B Returns
The list of existing users.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion1\(aq cassandra_cql.list_users

salt \(aqminion1\(aq cassandra_cql.list_users contact_points=minion1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cassandra_cql.version(contact_points=None, port=None, cql_user=None, cql_pass=None, protocol_version=None, load_balancing_policy=None, load_balancing_policy_args=None, ssl_options=None)
Show the Cassandra version.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontact_points\fP (\fI\%str\fP\fI | \fP\fI\%list\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The Cassandra cluster addresses, can either be a string or a list of IPs.
.IP \(bu 2
\fBcql_user\fP (\fI\%str\fP) \-\- The Cassandra user if authentication is turned on.
.IP \(bu 2
\fBcql_pass\fP (\fI\%str\fP) \-\- The Cassandra user password if authentication is turned on.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The Cassandra cluster port, defaults to None.
.IP \(bu 2
\fBprotocol_version\fP (\fI\%int\fP) \-\- Cassandra protocol version to use.
.IP \(bu 2
\fBload_balancing_policy\fP (\fI\%str\fP) \-\- cassandra.policy class name to use
.IP \(bu 2
\fBload_balancing_policy_args\fP (\fI\%dict\fP) \-\- cassandra.policy constructor args
.IP \(bu 2
\fBssl_options\fP (\fI\%dict\fP) \-\- Cassandra protocol version to use.
.UNINDENT
.TP
.B Returns
The version for this Cassandra cluster.
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion1\(aq cassandra_cql.version

salt \(aqminion1\(aq cassandra_cql.version contact_points=minion1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.celery
.sp
Support for scheduling celery tasks. The worker is independent of salt and thus can run in a different
virtualenv or on a different python version, as long as broker, backend and serializer configurations match.
Also note that celery and packages required by the celery broker, e.g. redis must be installed to load
the salt celery execution module.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
A new app (and thus new connections) is created for each task execution
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.celery.run_task(task_name, args=None, kwargs=None, broker=None, backend=None, wait_for_result=False, timeout=None, propagate=True, interval=0.5, no_ack=True, raise_timeout=True, config=None)
Execute celery tasks. For celery specific parameters see celery documentation.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq celery.run_task tasks.sleep args=[4] broker=redis://localhost \e
backend=redis://localhost wait_for_result=true
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B task_name
The task name, e.g. tasks.sleep
.TP
.B args
Task arguments as a list
.TP
.B kwargs
Task keyword arguments
.TP
.B broker
Broker for celeryapp, see celery documentation
.TP
.B backend
Result backend for celeryapp, see celery documentation
.TP
.B wait_for_result
Wait until task result is read from result backend and return result, Default: False
.TP
.B timeout
Timeout waiting for result from celery, see celery AsyncResult.get documentation
.TP
.B propagate
Propagate exceptions from celery task, see celery AsyncResult.get documentation, Default: True
.TP
.B interval
Interval to check for task result, see celery AsyncResult.get documentation, Default: 0.5
.TP
.B no_ack
see celery AsyncResult.get documentation. Default: True
.TP
.B raise_timeout
Raise timeout exception if waiting for task result times out. Default: False
.TP
.B config
Config dict for celery app, See celery documentation
.UNINDENT
.UNINDENT
.SS salt.modules.ceph
.sp
Module to provide ceph control with salt.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
ceph_cfg Python module
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.modules.ceph.ceph_version()
Get the version of ceph installed
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.ceph_version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.cluster_quorum(**kwargs)
Get the cluster\(aqs quorum status
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.cluster_quorum \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.cluster_status(**kwargs)
Get the cluster status, including health if in quorum
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.cluster_status \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.keyring_auth_add(**kwargs)
Add keyring to authorized list
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.keyring_auth_add \e
        \(aqkeyring_type\(aq=\(aqadmin\(aq \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B keyring_type (required)
One of \fBadmin\fP, \fBmon\fP, \fBosd\fP, \fBrgw\fP, \fBmds\fP
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.keyring_auth_del(**kwargs)
Remove keyring from authorised list
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.keyring_osd_auth_del \e
        \(aqkeyring_type\(aq=\(aqadmin\(aq \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B keyring_type (required)
One of \fBadmin\fP, \fBmon\fP, \fBosd\fP, \fBrgw\fP, \fBmds\fP
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.keyring_auth_list(**kwargs)
List all cephx authorization keys
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.keyring_auth_list \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.keyring_create(**kwargs)
Create keyring for cluster
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.keyring_create \e
        \(aqkeyring_type\(aq=\(aqadmin\(aq \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B keyring_type (required)
One of \fBadmin\fP, \fBmon\fP, \fBosd\fP, \fBrgw\fP, \fBmds\fP
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.keyring_present(**kwargs)
Returns \fBTrue\fP if the keyring is present on disk, otherwise \fBFalse\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.keyring_present \e
        \(aqkeyring_type\(aq=\(aqadmin\(aq \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B keyring_type (required)
One of \fBadmin\fP, \fBmon\fP, \fBosd\fP, \fBrgw\fP, \fBmds\fP
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.keyring_purge(**kwargs)
Delete keyring for cluster
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.keyring_purge \e
        \(aqkeyring_type\(aq=\(aqadmin\(aq \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B keyring_type (required)
One of \fBadmin\fP, \fBmon\fP, \fBosd\fP, \fBrgw\fP, \fBmds\fP
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.sp
If no ceph config file is found, this command will fail.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.keyring_save(**kwargs)
Create save keyring locally
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.keyring_save \e
        \(aqkeyring_type\(aq=\(aqadmin\(aq \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B keyring_type (required)
One of \fBadmin\fP, \fBmon\fP, \fBosd\fP, \fBrgw\fP, \fBmds\fP
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.mds_create(**kwargs)
Create a mds
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.mds_create \e
        \(aqname\(aq = \(aqmds.name\(aq \e
        \(aqport\(aq = 1000, \e
        \(aqaddr\(aq = \(aqfqdn.example.org\(aq \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name (required)
The MDS name (must start with \fBmds.\fP)
.TP
.B port (required)
Port to which the MDS will listen
.TP
.B addr (required)
Address or IP address for the MDS to listen
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.mds_destroy(**kwargs)
Remove a mds
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.mds_destroy \e
        \(aqname\(aq = \(aqmds.name\(aq \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name (required)
The MDS name (must start with \fBmds.\fP)
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.mon_active(**kwargs)
Returns \fBTrue\fP if the mon daemon is running, otherwise \fBFalse\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.mon_active \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.mon_create(**kwargs)
Create a mon node
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.mon_create \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.mon_is(**kwargs)
Returns \fBTrue\fP if the target is a mon node, otherwise \fBFalse\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.mon_is \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.mon_quorum(**kwargs)
Returns \fBTrue\fP if the mon daemon is in the quorum, otherwise \fBFalse\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.mon_quorum \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.mon_status(**kwargs)
Get status from mon daemon
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.mon_status \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.osd_activate(**kwargs)
Activate an OSD
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.osd_activate \(aqosd_dev\(aq=\(aq/dev/vdc\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.osd_discover()
List all OSD by cluster
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.osd_discover
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.osd_prepare(**kwargs)
Prepare an OSD
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.osd_prepare \(aqosd_dev\(aq=\(aq/dev/vdc\(aq \e
        \(aqjournal_dev\(aq=\(aqdevice\(aq \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq \e
        \(aqosd_fs_type\(aq=\(aqxfs\(aq \e
        \(aqosd_uuid\(aq=\(aq2a143b73\-6d85\-4389\-a9e9\-b8a78d9e1e07\(aq \e
        \(aqjournal_uuid\(aq=\(aq4562a5db\-ff6f\-4268\-811d\-12fd4a09ae98\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cluster_uuid
The device to store the osd data on.
.TP
.B journal_dev
The journal device. defaults to osd_dev.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.TP
.B cluster_uuid
The cluster date will be added too. Defaults to the value found in local config.
.TP
.B osd_fs_type
set the file system to store OSD data with. Defaults to \(dqxfs\(dq.
.TP
.B osd_uuid
set the OSD data UUID. If set will return if OSD with data UUID already exists.
.TP
.B journal_uuid
set the OSD journal UUID. If set will return if OSD with journal UUID already exists.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.partition_is(dev)
Check whether a given device path is a partition or a full disk.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.partition_is /dev/sdc1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.partition_list()
List partitions by disk
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.partition_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.partition_list_journal()
List all OSD journal partitions by partition
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.partition_list_journal
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.partition_list_osd()
List all OSD data partitions by partition
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.partition_list_osd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.pool_add(pool_name, **kwargs)
Create a pool
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.pool_add pool_name \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B pg_num
Default to 8
.TP
.B pgp_num
Default to pg_num
.TP
.B pool_type
can take values \(dqreplicated\(dq or \(dqerasure\(dq
.TP
.B erasure_code_profile
The \(dqerasure_code_profile\(dq
.TP
.B crush_ruleset
The crush map rule set
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.pool_del(pool_name, **kwargs)
Delete a pool
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.pool_del pool_name \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.pool_list(**kwargs)
List all pools
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.pool_list \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.purge(**kwargs)
purge ceph configuration on the node
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.purge \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.rgw_create(**kwargs)
Create a rgw
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.rgw_create \e
        \(aqname\(aq = \(aqrgw.name\(aq \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name (required)
The RGW client name. Must start with \fBrgw.\fP
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.rgw_destroy(**kwargs)
Remove a rgw
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.rgw_destroy \e
        \(aqname\(aq = \(aqrgw.name\(aq \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name (required)
The RGW client name (must start with \fBrgw.\fP)
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.rgw_pools_create(**kwargs)
Create pools for rgw
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.rgw_pools_create
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.rgw_pools_missing(**kwargs)
Show pools missing for rgw
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.rgw_pools_missing
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ceph.zap(target=None, **kwargs)
Destroy the partition table and content of a given disk.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ceph.osd_prepare \(aqdev\(aq=\(aq/dev/vdc\(aq \e
        \(aqcluster_name\(aq=\(aqceph\(aq \e
        \(aqcluster_uuid\(aq=\(aqcluster_uuid\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B dev
The block device to format.
.TP
.B cluster_name
The cluster name. Defaults to \fBceph\fP\&.
.TP
.B cluster_uuid
The cluster UUID. Defaults to value found in ceph config file.
.UNINDENT
.UNINDENT
.SS salt.modules.chassis
.sp
Glue execution module to link to the \fI\%fx2 proxymodule\fP\&.
.sp
Depends: \fI\%iDRAC Remote execution module (salt.modules.dracr)\fP
.sp
For documentation on commands that you can direct to a Dell chassis via proxy,
look in the documentation for \fI\%salt.modules.dracr\fP\&.
.sp
This execution module calls through to a function in the fx2 proxy module
called \fBchconfig\fP\&.  That function looks up the function passed in the \fBcmd\fP
parameter in \fI\%salt.modules.dracr\fP and calls it.
.sp
New in version 2015.8.2.

.INDENT 0.0
.TP
.B salt.modules.chassis.chassis_credentials()
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chassis.cmd(cmd, *args, **kwargs)
.UNINDENT
.SS salt.modules.chef
.sp
Execute chef in server or solo mode
.INDENT 0.0
.TP
.B salt.modules.chef.client(whyrun=False, localmode=False, logfile=None, **kwargs)
Execute a chef client run and return a dict with the stderr, stdout,
return code, and pid.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chef.client server=https://localhost
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B server
The chef server URL
.TP
.B client_key
Set the client key file location
.TP
.B config
The configuration file to use
.TP
.B config\-file\-jail
Directory under which config files are allowed to be loaded
(no client.rb or knife.rb outside this path will be loaded).
.TP
.B environment
Set the Chef Environment on the node
.TP
.B group
Group to set privilege to
.TP
.B json\-attributes
Load attributes from a JSON file or URL
.TP
.B localmode
Point chef\-client at local repository if True
.TP
.B log_level
Set the log level (debug, info, warn, error, fatal)
.TP
.B logfile
Set the log file location
.TP
.B node\-name
The node name for this client
.TP
.B override\-runlist
Replace current run list with specified items for a single run
.TP
.B pid
Set the PID file location, defaults to /tmp/chef\-client.pid
.TP
.B run\-lock\-timeout
Set maximum duration to wait for another client run to finish,
default is indefinitely.
.TP
.B runlist
Permanently replace current run list with specified items
.TP
.B user
User to set privilege to
.TP
.B validation_key
Set the validation key file location, used for registering new clients
.TP
.B whyrun
Enable whyrun mode when set to True
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chef.solo(whyrun=False, logfile=None, **kwargs)
Execute a chef solo run and return a dict with the stderr, stdout,
return code, and pid.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chef.solo override\-runlist=test
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B config
The configuration file to use
.TP
.B environment
Set the Chef Environment on the node
.TP
.B group
Group to set privilege to
.TP
.B json\-attributes
Load attributes from a JSON file or URL
.TP
.B log_level
Set the log level (debug, info, warn, error, fatal)
.TP
.B logfile
Set the log file location
.TP
.B node\-name
The node name for this client
.TP
.B override\-runlist
Replace current run list with specified items for a single run
.TP
.B recipe\-url
Pull down a remote gzipped tarball of recipes and untar it to
the cookbook cache
.TP
.B run\-lock\-timeout
Set maximum duration to wait for another client run to finish,
default is indefinitely.
.TP
.B user
User to set privilege to
.TP
.B whyrun
Enable whyrun mode when set to True
.UNINDENT
.UNINDENT
.SS salt.modules.chocolatey
.sp
A module that wraps calls to the Chocolatey package manager
(\fI\%http://chocolatey.org\fP)
.sp
New in version 2014.1.0.

.INDENT 0.0
.TP
.B salt.modules.chocolatey.add_source(name, source_location, username=None, password=None, priority=None)
Instructs Chocolatey to add a source.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the source to be added as a chocolatey repository.
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- Location of the source you want to work with.
.IP \(bu 2
\fBusername\fP (\fI\%str\fP) \-\- Provide username for chocolatey sources that need authentication
credentials.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- Provide password for chocolatey sources that need authentication
credentials.
.IP \(bu 2
\fBpriority\fP (\fI\%int\fP) \-\- The priority order of this source as compared to other sources,
lower is better. Defaults to 0 (no priority). All priorities
above 0 will be evaluated first, then zero\-based values will be
evaluated in config file order.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.add_source <source name> <source_location>
salt \(aq*\(aq chocolatey.add_source <source name> <source_location> priority=100
salt \(aq*\(aq chocolatey.add_source <source name> <source_location> user=<user> password=<password>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.bootstrap(force=False, source=None, version=None)
Download and install the latest version of the Chocolatey package manager
via the official bootstrap.
.sp
Chocolatey requires Windows PowerShell and the .NET v4.0 runtime. Depending
on the host\(aqs version of Windows, chocolatey.bootstrap will attempt to
ensure these prerequisites are met by downloading and executing the
appropriate installers from Microsoft.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If PowerShell is installed, you may have to restart the host machine for
Chocolatey to work.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If you\(aqre installing offline using the source parameter, the PowerShell
and .NET requirements must already be met on the target. This shouldn\(aqt
be a problem on Windows versions 2012/8 and later
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If you\(aqre installing chocolatey version 2.0+ the system requires .NET
4.8. Installing this requires a reboot, therefore this module will not
automatically install .NET 4.8.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBforce\fP (\fI\%bool\fP) \-\- Run the bootstrap process even if Chocolatey is found in the path.
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\-
.sp
The location of the \fB\&.nupkg\fP file or \fB\&.ps1\fP file to run from an
alternate location. This can be one of the following types of URLs:
.INDENT 2.0
.IP \(bu 2
salt://
.IP \(bu 2
http(s)://
.IP \(bu 2
\fI\%ftp://\fP
.IP \(bu 2
\fI\%file://\fP \- A local file on the system
.UNINDENT
.sp
New in version 3001.


.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\-
.sp
The version of chocolatey to install. The latest version is
installed if this value is \fBNone\fP\&. Default is \fBNone\fP
.sp
New in version 3007.1.


.UNINDENT
.TP
.B Returns
The stdout of the Chocolatey installation script
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# To bootstrap Chocolatey
salt \(aq*\(aq chocolatey.bootstrap
salt \(aq*\(aq chocolatey.bootstrap force=True

# To bootstrap Chocolatey offline from a file on the salt master
salt \(aq*\(aq chocolatey.bootstrap source=salt://files/chocolatey.nupkg

# To bootstrap Chocolatey from a file on C:\eTemp
salt \(aq*\(aq chocolatey.bootstrap source=C:\eTemp\echocolatey.nupkg

# To bootstrap Chocolatey version 1.4.0
salt \(aq*\(aq chocolatey.bootstrap version=1.4.0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.chocolatey_version(refresh=False)
Returns the version of Chocolatey installed on the minion.
.INDENT 7.0
.TP
.B Parameters
\fBrefresh\fP (\fI\%bool\fP) \-\-
.sp
Refresh the cached version of chocolatey
.sp
New in version 3007.1.


.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.chocolatey_version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.disable_source(name)
Instructs Chocolatey to disable a source.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- Name of the source repository to disable.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.disable_source <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.enable_source(name)
Instructs Chocolatey to enable a source.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- Name of the source repository to enable.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.enable_source <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.install(name, version=None, source=None, force=False, pre_versions=False, install_args=None, override_args=False, force_x86=False, package_args=None, allow_multiple=False, execution_timeout=None)
Instructs Chocolatey to install a package.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to be installed. Only accepts a single
argument. Required.
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\- Install a specific version of the package. Defaults to latest
version. Default is \fBNone\fP\&.
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\-
.sp
Chocolatey repository (directory, share or remote URL feed) the
package comes from. Defaults to the official Chocolatey feed.
Default is \fBNone\fP\&.
.sp
Alternate Sources:
.INDENT 2.0
.IP \(bu 2
cygwin
.IP \(bu 2
python
.IP \(bu 2
ruby
.IP \(bu 2
webpi
.IP \(bu 2
windowsfeatures
.UNINDENT

.IP \(bu 2
\fBforce\fP (\fI\%bool\fP) \-\- Reinstall the current version of an existing package. Do not use
with \fBallow_multiple\fP\&. Default is \fBFalse\fP\&.
.IP \(bu 2
\fBpre_versions\fP (\fI\%bool\fP) \-\- Include pre\-release packages. Default is \fBFalse\fP\&.
.IP \(bu 2
\fBinstall_args\fP (\fI\%str\fP) \-\- A list of install arguments you want to pass to the installation
process, i.e. product key or feature list. Default is \fBNone\fP\&.
.IP \(bu 2
\fBoverride_args\fP (\fI\%bool\fP) \-\- Set to true if you want to override the original install arguments
(for the native installer) in the package and use your own. When
this is set to \fBFalse\fP install_args will be appended to the end of
the default arguments. Default is \fBNone\fP\&.
.IP \(bu 2
\fBforce_x86\fP (\fI\%bool\fP) \-\- Force x86 (32bit) installation on 64bit systems. Default is
\fBFalse\fP\&.
.IP \(bu 2
\fBpackage_args\fP (\fI\%str\fP) \-\- Arguments you want to pass to the package. Default is \fBNone\fP\&.
.IP \(bu 2
\fBallow_multiple\fP (\fI\%bool\fP) \-\-
.sp
Allow multiple versions of the package to be installed. Do not use
with \fBforce\fP\&. Does not work with all packages. Default is
\fBFalse\fP\&.
.sp
New in version 2017.7.0.


.IP \(bu 2
\fBexecution_timeout\fP (\fI\%str\fP) \-\-
.sp
Chocolatey execution timeout value you want to pass to the
installation process. Default is \fBNone\fP\&.
.sp
New in version 2018.3.0.


.UNINDENT
.TP
.B Returns
The output of the \fBchocolatey\fP command
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.install <package name>
salt \(aq*\(aq chocolatey.install <package name> version=<package version>
salt \(aq*\(aq chocolatey.install <package name> install_args=<args> override_args=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.install_cygwin(name, install_args=None, override_args=False)
Instructs Chocolatey to install a package via Cygwin.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to be installed. Only accepts a single
argument.
.IP \(bu 2
\fBinstall_args\fP (\fI\%str\fP) \-\- A list of install arguments you want to pass to the installation
process, i.e. product key or feature list
.IP \(bu 2
\fBoverride_args\fP (\fI\%bool\fP) \-\- Set to \fBTrue\fP if you want to override the original install
arguments (for the native installer) in the package and use your
own. When this is set to \fBFalse\fP install_args will be appended to
the end of the default arguments
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.install_cygwin <package name>
salt \(aq*\(aq chocolatey.install_cygwin <package name> install_args=<args> override_args=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.install_gem(name, version=None, install_args=None, override_args=False)
Instructs Chocolatey to install a package via Ruby\(aqs Gems.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to be installed. Only accepts a single
argument.
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\- Install a specific version of the package. Defaults to the latest
version available.
.IP \(bu 2
\fBinstall_args\fP (\fI\%str\fP) \-\- A list of install arguments you want to pass to the installation
process, i.e. product key or feature list
.IP \(bu 2
\fBoverride_args\fP (\fI\%bool\fP) \-\- Set to \fBTrue\fP if you want to override the original install
arguments (for the native installer) in the package and use your
own. When this is set to \fBFalse\fP install_args will be appended to
the end of the default arguments
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.install_gem <package name>
salt \(aq*\(aq chocolatey.install_gem <package name> version=<package version>
salt \(aq*\(aq chocolatey.install_gem <package name> install_args=<args> override_args=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.install_missing(name, version=None, source=None)
Instructs Chocolatey to install a package if it doesn\(aqt already exist.
.sp
Changed in version 2014.7.0: If the minion has Chocolatey >= 0.9.8.24 installed, this function calls
\fI\%chocolatey.install\fP instead, as
\fBinstallmissing\fP is deprecated as of that version and will be removed
in Chocolatey 1.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to be installed. Only accepts a single
argument.
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\- Install a specific version of the package. Defaults to the latest
version available.
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- Chocolatey repository (directory, share or remote URL feed) the
package comes from. Defaults to the official Chocolatey feed.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.install_missing <package name>
salt \(aq*\(aq chocolatey.install_missing <package name> version=<package version>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.install_python(name, version=None, install_args=None, override_args=False)
Instructs Chocolatey to install a package via Python\(aqs easy_install.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to be installed. Only accepts a single
argument.
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\- Install a specific version of the package. Defaults to the latest
version available.
.IP \(bu 2
\fBinstall_args\fP (\fI\%str\fP) \-\- A list of install arguments you want to pass to the installation
process, i.e. product key or feature list.
.IP \(bu 2
\fBoverride_args\fP (\fI\%bool\fP) \-\- Set to \fBTrue\fP if you want to override the original install
arguments (for the native installer) in the package and use your
own. When this is set to \fBFalse\fP install_args will be appended to
the end of the default arguments.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.install_python <package name>
salt \(aq*\(aq chocolatey.install_python <package name> version=<package version>
salt \(aq*\(aq chocolatey.install_python <package name> install_args=<args> override_args=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.install_webpi(name, install_args=None, override_args=False)
Instructs Chocolatey to install a package via the Microsoft Web PI service.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to be installed. Only accepts a single
argument.
.IP \(bu 2
\fBinstall_args\fP (\fI\%str\fP) \-\- A list of install arguments you want to pass to the installation
process, i.e. product key or feature list.
.IP \(bu 2
\fBoverride_args\fP (\fI\%bool\fP) \-\- Set to \fBTrue\fP if you want to override the original install
arguments (for the native installer) in the package and use your
own. When this is set to \fBFalse\fP install_args will be appended to
the end of the default arguments.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.install_webpi <package name>
salt \(aq*\(aq chocolatey.install_webpi <package name> install_args=<args> override_args=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.install_windowsfeatures(name)
Instructs Chocolatey to install a Windows Feature via the Deployment Image
Servicing and Management tool.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the feature to be installed. Only accepts a single
argument.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.install_windowsfeatures <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.list_(narrow=None, all_versions=False, pre_versions=False, source=None, local_only=False, exact=False)
Instructs Chocolatey to pull a vague package list from the repository.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnarrow\fP (\fI\%str\fP) \-\- Term used to narrow down results. Searches against
name/description/tag. Default is None.
.IP \(bu 2
\fBall_versions\fP (\fI\%bool\fP) \-\- Display all available package versions in results. Default is False.
.IP \(bu 2
\fBpre_versions\fP (\fI\%bool\fP) \-\- Display pre\-release packages in results. Default is False.
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- Chocolatey repository (directory, share or remote URL feed) the
package comes from. Defaults to the official Chocolatey feed if
None is passed. Default is None.
.IP \(bu 2
\fBlocal_only\fP (\fI\%bool\fP) \-\- Only display packages that are installed locally. Default is False.
.IP \(bu 2
\fBexact\fP (\fI\%bool\fP) \-\-
.sp
Only display packages that match \fBnarrow\fP exactly. Default is
False.
.sp
New in version 2017.7.0.


.UNINDENT
.TP
.B Returns
A dictionary of results.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.list <narrow>
salt \(aq*\(aq chocolatey.list <narrow> all_versions=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.list_sources()
Returns the list of installed sources.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.list_sources
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.list_webpi()
Instructs Chocolatey to pull a full package list from the Microsoft Web PI
repository.
.INDENT 7.0
.TP
.B Returns
List of webpi packages
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.list_webpi
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.list_windowsfeatures()
Instructs Chocolatey to pull a full package list from the Windows Features
list, via the Deployment Image Servicing and Management tool.
.INDENT 7.0
.TP
.B Returns
List of Windows Features
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.list_windowsfeatures
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.unbootstrap()
Uninstall chocolatey from the system by doing the following:
.INDENT 7.0
.IP \(bu 2
Delete the Chocolatey Directory
.IP \(bu 2
Remove Chocolatey from the path
.IP \(bu 2
Remove Chocolatey environment variables
.UNINDENT
.sp
New in version 3001.

.INDENT 7.0
.TP
.B Returns
A list of items that were removed, otherwise an empty list
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt * chocolatey.unbootstrap
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.uninstall(name, version=None, uninstall_args=None, override_args=False, force=False)
Instructs Chocolatey to uninstall a package.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to be uninstalled. Only accepts a single
argument.
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\- Uninstalls a specific version of the package. Defaults to the latest
version installed.
.IP \(bu 2
\fBuninstall_args\fP (\fI\%str\fP) \-\- A list of uninstall arguments you want to pass to the uninstallation
process, i.e. product key or feature list.
.IP \(bu 2
\fBoverride_args\fP \-\- Set to \fBTrue\fP if you want to override the original uninstall
arguments (for the native uninstaller) in the package and use your
own. When this is set to \fBFalse\fP uninstall_args will be appended
to the end of the default arguments.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chocolatey.uninstall <package name>
salt \(aq*\(aq chocolatey.uninstall <package name> version=<package version>
salt \(aq*\(aq chocolatey.uninstall <package name> version=<package version> uninstall_args=<args> override_args=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.update(name, source=None, pre_versions=False)
Instructs Chocolatey to update packages on the system.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to update, or \(dqall\(dq to update everything
installed on the system.
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- Chocolatey repository (directory, share or remote URL feed) the
package comes from. Defaults to the official Chocolatey feed.
.IP \(bu 2
\fBpre_versions\fP (\fI\%bool\fP) \-\- Include pre\-release packages in comparison. Defaults to \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq chocolatey.update all
salt \(dq*\(dq chocolatey.update <package name> pre_versions=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.upgrade(name, version=None, source=None, force=False, pre_versions=False, install_args=None, override_args=False, force_x86=False, package_args=None)
New in version 2016.3.4.

.sp
Instructs Chocolatey to upgrade packages on the system. (update is being
deprecated). This command will install the package if not installed.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to update, or \(dqall\(dq to update everything
installed on the system.
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\- Install a specific version of the package. Defaults to latest
version.
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- Chocolatey repository (directory, share or remote URL feed) the
package comes from. Defaults to the official Chocolatey feed.
.IP \(bu 2
\fBforce\fP (\fI\%bool\fP) \-\- Reinstall the \fBsame\fP version already installed.
.IP \(bu 2
\fBpre_versions\fP (\fI\%bool\fP) \-\- Include pre\-release packages in comparison. Defaults to \fBFalse\fP\&.
.IP \(bu 2
\fBinstall_args\fP (\fI\%str\fP) \-\- A list of install arguments you want to pass to the installation
process, i.e. product key or feature list.
.IP \(bu 2
\fBoverride_args\fP (\fI\%bool\fP) \-\- Set to \fBTrue\fP if you want to override the original install
arguments (for the native installer) in the package and use your
own. When this is set to \fBFalse\fP install_args will be appended to
the end of the default arguments.
.IP \(bu 2
\fBforce_x86\fP (\fI\%bool\fP) \-\- Force x86 (32bit) installation on 64bit systems. Defaults to
\fBFalse\fP\&.
.IP \(bu 2
\fBpackage_args\fP (\fI\%str\fP) \-\- A list of arguments you want to pass to the package.
.UNINDENT
.TP
.B Returns
Results of the \fBchocolatey\fP command
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq chocolatey.upgrade all
salt \(dq*\(dq chocolatey.upgrade <package name> pre_versions=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chocolatey.version(name, check_remote=False, source=None, pre_versions=False)
Instructs Chocolatey to check an installed package version, and optionally
compare it to one available from a remote feed.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to check. Required.
.IP \(bu 2
\fBcheck_remote\fP (\fI\%bool\fP) \-\- Get the version number of the latest package from the remote feed.
Default is \fBFalse\fP\&.
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- Chocolatey repository (directory, share or remote URL feed) the
package comes from. Defaults to the official Chocolatey feed.
Default is \fBNone\fP\&.
.IP \(bu 2
\fBpre_versions\fP (\fI\%bool\fP) \-\- Include pre\-release packages in comparison. Default is \fBFalse\fP\&.
.UNINDENT
.TP
.B Returns
A dictionary of currently installed software and versions
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq chocolatey.version <package name>
salt \(dq*\(dq chocolatey.version <package name> check_remote=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.chronos
.sp
Module providing a simple management interface to a chronos cluster.
.sp
Currently this only works when run through a proxy minion.
.sp
New in version 2015.8.2.

.INDENT 0.0
.TP
.B salt.modules.chronos.has_job(name)
Return whether the given job is currently configured.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt chronos\-minion\-id chronos.has_job my\-job
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chronos.job(name)
Return the current server configuration for the specified job.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt chronos\-minion\-id chronos.job my\-job
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chronos.jobs()
Return a list of the currently installed job names.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt chronos\-minion\-id chronos.jobs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chronos.rm_job(name)
Remove the specified job from the server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt chronos\-minion\-id chronos.rm_job my\-job
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chronos.update_job(name, config)
Update the specified job with the given configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt chronos\-minion\-id chronos.update_job my\-job \(aq<config yaml>\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.chroot
.sp
Module for chroot
:maintainer:    Alberto Planas <\fI\%aplanas@suse.com\fP>
:maturity:      new
:depends:       None
:platform:      Linux
.INDENT 0.0
.TP
.B salt.modules.chroot.apply_(root, mods=None, **kwargs)
Apply an state inside a chroot.
.sp
This function will call \fIchroot.highstate\fP or \fIchroot.sls\fP based
on the arguments passed to this function. It exists as a more
intuitive way of applying states.
.INDENT 7.0
.TP
.B root
Path to the chroot environment
.UNINDENT
.sp
For a formal description of the possible parameters accepted in
this function, check \fIstate.apply_\fP documentation.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion chroot.apply /chroot
salt myminion chroot.apply /chroot stuff
salt myminion chroot.apply /chroot stuff pillar=\(aq{\(dqfoo\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chroot.call(root, function, *args, **kwargs)
Executes a Salt function inside a chroot environment.
.sp
The chroot does not need to have Salt installed, but Python is
required.
.INDENT 7.0
.TP
.B root
Path to the chroot environment
.TP
.B function
Salt execution module function
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion chroot.call /chroot test.ping
salt myminion chroot.call /chroot ssh.set_auth_key user key=mykey
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chroot.create(root)
Create a basic chroot environment.
.sp
Note that this environment is not functional. The caller needs to
install the minimal required binaries, including Python if
chroot.call is called.
.INDENT 7.0
.TP
.B root
Path to the chroot environment
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion chroot.create /chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chroot.exist(root)
Return True if the chroot environment is present.
.INDENT 7.0
.TP
.B root
Path to the chroot environment
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion chroot.exist /chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chroot.highstate(root, **kwargs)
Retrieve the state data from the salt master for this minion and
execute it inside the chroot.
.INDENT 7.0
.TP
.B root
Path to the chroot environment
.UNINDENT
.sp
For a formal description of the possible parameters accepted in
this function, check \fIstate.highstate\fP documentation.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion chroot.highstate /chroot
salt myminion chroot.highstate /chroot pillar=\(aq{\(dqfoo\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chroot.in_chroot()
Return True if the process is inside a chroot jail
.sp
New in version 3004.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion chroot.in_chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.chroot.sls(root, mods, saltenv=\(aqbase\(aq, test=None, exclude=None, **kwargs)
Execute the states in one or more SLS files inside the chroot.
.INDENT 7.0
.TP
.B root
Path to the chroot environment
.TP
.B saltenv
Specify a salt fileserver environment to be used when applying
states
.TP
.B mods
List of states to execute
.TP
.B test
Run states in test\-only (dry\-run) mode
.TP
.B exclude
Exclude specific states from execution. Accepts a list of sls
names, a comma\-separated string of sls names, or a list of
dictionaries containing \fBsls\fP or \fBid\fP keys. Glob\-patterns
may be used to match multiple states.
.UNINDENT
.sp
For a formal description of the possible parameters accepted in
this function, check \fIstate.sls\fP documentation.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq chroot.sls /chroot stuff pillar=\(aq{\(dqfoo\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.cimc
.sp
Module to provide Cisco UCS compatibility to Salt
.INDENT 0.0
.TP
.B codeauthor
\fBSpencer Ervin <spencer_ervin@hotmail.com>\fP
.TP
.B maturity
new
.TP
.B depends
none
.TP
.B platform
unix
.UNINDENT
.SS Configuration
.sp
This module accepts connection configuration details either as
parameters, or as configuration settings in pillar as a Salt proxy.
Options passed into opts will be ignored if options are passed into pillar.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Cisco UCS Proxy Module\fP
.UNINDENT
.UNINDENT
.SS About
.sp
This execution module was designed to handle connections to a Cisco UCS server.
This module adds support to send connections directly to the device through the
rest API.
.INDENT 0.0
.TP
.B salt.modules.cimc.activate_backup_image(reset=False)
Activates the firmware backup image.
.sp
CLI Example:
.INDENT 7.0
.TP
.B Parameters
\fBreset\fP (\fI\%bool\fP) \-\- Reset the CIMC device on activate.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.activate_backup_image
salt \(aq*\(aq cimc.activate_backup_image reset=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.create_user(uid=None, username=None, password=None, priv=None)
Create a CIMC user with username and password.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuid\fP (\fI\%int\fP) \-\- The user ID slot to create the user account in.
.IP \(bu 2
\fBusername\fP (\fI\%str\fP) \-\- The name of the user.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- The clear text password of the user.
.IP \(bu 2
\fBpriv\fP (\fI\%str\fP) \-\- The privilege level of the user.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.create_user 11 username=admin password=foobar priv=admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_bios_defaults()
Get the default values of BIOS tokens.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_bios_defaults
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_bios_settings()
Get the C240 server BIOS token values.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_bios_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_boot_order()
Retrieves the configured boot order table.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_boot_order
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_cpu_details()
Get the CPU product ID details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_cpu_details
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_disks()
Get the HDD product ID details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_disks
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_ethernet_interfaces()
Get the adapter Ethernet interface details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_ethernet_interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_fibre_channel_interfaces()
Get the adapter fibre channel interface details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_fibre_channel_interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_firmware()
Retrieves the current running firmware versions of server components.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_firmware
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_hostname()
Retrieves the hostname from the device.
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_ldap()
Retrieves LDAP server details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_ldap
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_management_interface()
Retrieve the management interface details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_management_interface
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_memory_token()
Get the memory RAS BIOS token.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_memory_token
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_memory_unit()
Get the IMM/Memory unit product ID details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_memory_unit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_network_adapters()
Get the list of network adapters and configuration details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_network_adapters
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_ntp()
Retrieves the current running NTP configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_ntp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_pci_adapters()
Get the PCI adapter product ID details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_disks
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_power_configuration()
Get the configuration of the power settings from the device. This is only available
on some C\-Series servers.
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_power_configuration
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_power_supplies()
Retrieves the power supply unit details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_power_supplies
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_snmp_config()
Get the snmp configuration details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_snmp_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_syslog()
Get the Syslog client\-server details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_syslog
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_syslog_settings()
Get the Syslog configuration settings from the system.
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_syslog_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_system_info()
Get the system information.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_system_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_users()
Get the CIMC users.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_vic_adapters()
Get the VIC adapter general profile details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_vic_adapters
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.get_vic_uplinks()
Get the VIC adapter uplink port details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.get_vic_uplinks
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.mount_share(name=None, remote_share=None, remote_file=None, mount_type=\(aqnfs\(aq, username=None, password=None)
Mounts a remote file through a remote share. Currently, this feature is supported in version 1.5 or greater.
The remote share can be either NFS, CIFS, or WWW.
.INDENT 7.0
.TP
.B Some of the advantages of CIMC Mounted vMedia include:
Communication between mounted media and target stays local (inside datacenter)
Media mounts can be scripted/automated
No vKVM requirements for media connection
Multiple share types supported
Connections supported through all CIMC interfaces
.sp
Note: CIMC Mounted vMedia is enabled through BIOS configuration.
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the volume on the CIMC device.
.IP \(bu 2
\fBremote_share\fP (\fI\%str\fP) \-\- The file share link that will be used to mount the share. This can be NFS, CIFS, or WWW. This
.IP \(bu 2
\fBfile.\fP (\fImust be the directory path and not the full path to the remote\fP) \-\-
.IP \(bu 2
\fBremote_file\fP (\fI\%str\fP) \-\- The name of the remote file to mount. It must reside within remote_share.
.IP \(bu 2
\fBmount_type\fP (\fI\%str\fP) \-\- The type of share to mount. Valid options are nfs, cifs, and www.
.IP \(bu 2
\fBusername\fP (\fI\%str\fP) \-\- An optional requirement to pass credentials to the remote share. If not provided, an
.IP \(bu 2
\fBmade.\fP (\fIunauthenticated connection attempt will be\fP) \-\-
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- An optional requirement to pass a password to the remote share. If not provided, an
.IP \(bu 2
\fBmade.\fP \-\-
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.mount_share name=WIN7 remote_share=10.xxx.27.xxx:/nfs remote_file=sl1huu.iso

salt \(aq*\(aq cimc.mount_share name=WIN7 remote_share=10.xxx.27.xxx:/nfs remote_file=sl1huu.iso username=bob password=badpassword
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.reboot()
Power cycling the server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.reboot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.set_hostname(hostname=None)
Sets the hostname on the server.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B Parameters
\fBhostname\fP (\fI\%str\fP) \-\- The new hostname to set.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.set_hostname foobar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.set_logging_levels(remote=None, local=None)
Sets the logging levels of the CIMC devices. The logging levels must match
the following options: emergency, alert, critical, error, warning, notice,
informational, debug.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBremote\fP (\fI\%str\fP) \-\- The logging level for SYSLOG logs.
.IP \(bu 2
\fBlocal\fP (\fI\%str\fP) \-\- The logging level for the local device.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.set_logging_levels remote=error local=notice
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.set_ntp_server(server1=\(aq\(aq, server2=\(aq\(aq, server3=\(aq\(aq, server4=\(aq\(aq)
Sets the NTP servers configuration. This will also enable the client NTP service.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBserver1\fP (\fI\%str\fP) \-\- The first IP address or FQDN of the NTP servers.
.IP \(bu 2
\fBserver2\fP (\fI\%str\fP) \-\- The second IP address or FQDN of the NTP servers.
.IP \(bu 2
\fBserver3\fP (\fI\%str\fP) \-\- The third IP address or FQDN of the NTP servers.
.IP \(bu 2
\fBserver4\fP (\fI\%str\fP) \-\- The fourth IP address or FQDN of the NTP servers.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.set_ntp_server 10.10.10.1

salt \(aq*\(aq cimc.set_ntp_server 10.10.10.1 foo.bar.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.set_power_configuration(policy=None, delayType=None, delayValue=None)
Sets the power configuration on the device. This is only available for some
C\-Series servers.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpolicy\fP (\fI\%str\fP) \-\- The action to be taken when chassis power is restored after
.IP \(bu 2
\fBfollowing\fP (\fIdelayed with this option. This can be one\fP\fI of \fP\fIthe\fP) \-\-
.sp
reset: The server is allowed to boot up normally when power is
restored. The server can restart immediately or, optionally, after a
fixed or random delay.
.sp
stay\-off: The server remains off until it is manually restarted.
.sp
last\-state: The server restarts and the system attempts to restore
any processes that were running before power was lost.

.IP \(bu 2
\fBdelayType\fP (\fI\%str\fP) \-\- If the selected policy is reset, the restart can be
.IP \(bu 2
\fBfollowing\fP \-\-
.sp
fixed: The server restarts after a fixed delay.
.sp
random: The server restarts after a random delay.

.IP \(bu 2
\fBdelayValue\fP (\fI\%int\fP) \-\- If a fixed delay is selected, once chassis power is
.IP \(bu 2
\fBrebooting\fP (\fIrestored and the Cisco IMC has finished\fP) \-\-
.IP \(bu 2
\fBfor\fP (\fIthe system waits\fP) \-\-
.IP \(bu 2
\fBan\fP (\fIthe specified number\fP\fI of \fP\fIseconds before restarting the server. Enter\fP) \-\-
.IP \(bu 2
\fB240.\fP (\fIinteger between 0 and\fP) \-\-
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.set_power_configuration stay\-off

salt \(aq*\(aq cimc.set_power_configuration reset fixed 0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.set_syslog_server(server=None, type=\(aqprimary\(aq)
Set the SYSLOG server on the host.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBserver\fP (\fI\%str\fP) \-\- The hostname or IP address of the SYSLOG server.
.IP \(bu 2
\fBtype\fP (\fI\%str\fP) \-\- Specifies the type of SYSLOG server. This can either be primary (default) or secondary.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.set_syslog_server foo.bar.com

salt \(aq*\(aq cimc.set_syslog_server foo.bar.com primary

salt \(aq*\(aq cimc.set_syslog_server foo.bar.com secondary
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.set_user(uid=None, username=None, password=None, priv=None, status=None)
Sets a CIMC user with specified configurations.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuid\fP (\fI\%int\fP) \-\- The user ID slot to create the user account in.
.IP \(bu 2
\fBusername\fP (\fI\%str\fP) \-\- The name of the user.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- The clear text password of the user.
.IP \(bu 2
\fBpriv\fP (\fI\%str\fP) \-\- The privilege level of the user.
.IP \(bu 2
\fBstatus\fP (\fI\%str\fP) \-\- The account status of the user.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.set_user 11 username=admin password=foobar priv=admin active
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.tftp_update_bios(server=None, path=None)
Update the BIOS firmware through TFTP.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBserver\fP (\fI\%str\fP) \-\- The IP address or hostname of the TFTP server.
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The TFTP path and filename for the BIOS image.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.tftp_update_bios foo.bar.com HP\-SL2.cap
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cimc.tftp_update_cimc(server=None, path=None)
Update the CIMC firmware through TFTP.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBserver\fP (\fI\%str\fP) \-\- The IP address or hostname of the TFTP server.
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The TFTP path and filename for the CIMC image.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cimc.tftp_update_cimc foo.bar.com HP\-SL2.bin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.ciscoconfparse_mod
.sp
Execution module for \fI\%ciscoconfparse\fP
.sp
New in version 2019.2.0.

.sp
This module can be used for basic configuration parsing, audit or validation
for a variety of network platforms having Cisco IOS style configuration (one
space indentation), including: Cisco IOS, Cisco Nexus, Cisco IOS\-XR,
Cisco IOS\-XR, Cisco ASA, Arista EOS, Brocade, HP Switches, Dell PowerConnect
Switches, or Extreme Networks devices. In newer versions, \fBciscoconfparse\fP
provides support for brace\-delimited configuration style as well, for platforms
such as: Juniper Junos, Palo Alto, or F5 Networks.
.sp
See \fI\%http://www.pennington.net/py/ciscoconfparse/index.html\fP for further details.
.INDENT 0.0
.TP
.B depends
ciscoconfparse
.UNINDENT
.sp
This module depends on the Python library with the same name,
\fBciscoconfparse\fP \- to install execute: \fBpip install ciscoconfparse\fP\&.
.INDENT 0.0
.TP
.B salt.modules.ciscoconfparse_mod.filter_lines(config=None, config_path=None, parent_regex=None, child_regex=None, saltenv=\(aqbase\(aq)
Return a list of detailed matches, for the configuration blocks (parent\-child
relationship) whose parent respects the regular expressions configured via
the \fBparent_regex\fP argument, and the child matches the \fBchild_regex\fP
regular expression. The result is a list of dictionaries with the following
keys:
.INDENT 7.0
.IP \(bu 2
\fBmatch\fP: a boolean value that tells whether \fBchild_regex\fP matched any
children lines.
.IP \(bu 2
\fBparent\fP: the parent line (as text).
.IP \(bu 2
\fBchild\fP: the child line (as text). If no child line matched, this field
will be \fBNone\fP\&.
.UNINDENT
.sp
Note that the return list contains the elements that matched the parent
condition, the \fBparent_regex\fP regular expression. Therefore, the \fBparent\fP
field will always have a valid value, while \fBmatch\fP and \fBchild\fP may
default to \fBFalse\fP and \fBNone\fP respectively when there is not child match.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ciscoconfparse.filter_lines config_path=https://bit.ly/2mAdq7z parent_regex=\(aqGigabit\(aq child_regex=\(aqshutdown\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output (for the example above):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
    {
        \(aqparent\(aq: \(aqinterface GigabitEthernet1\(aq,
        \(aqmatch\(aq: False,
        \(aqchild\(aq: None
    },
    {
        \(aqparent\(aq: \(aqinterface GigabitEthernet2\(aq,
        \(aqmatch\(aq: True,
        \(aqchild\(aq: \(aq shutdown\(aq
    },
    {
        \(aqparent\(aq: \(aqinterface GigabitEthernet3\(aq,
        \(aqmatch\(aq: True,
        \(aqchild\(aq: \(aq shutdown\(aq
    }
]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ciscoconfparse_mod.find_lines(config=None, config_path=None, regex=None, saltenv=\(aqbase\(aq)
Return all the lines (as text) that match the expression in the \fBregex\fP
argument.
.INDENT 7.0
.TP
.B config
The configuration sent as text.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument is ignored when \fBconfig_path\fP is specified.
.UNINDENT
.UNINDENT
.TP
.B config_path
The absolute or remote path to the file with the configuration to be
parsed. This argument supports the usual Salt filesystem URIs, e.g.,
\fBsalt://\fP, \fBhttps://\fP, \fBftp://\fP, \fBs3://\fP, etc.
.TP
.B regex
The regular expression to match the lines against.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file. This
argument is ignored when \fBconfig_path\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ciscoconfparse.find_lines config_path=https://bit.ly/2mAdq7z regex=\(aqip address\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cisco\-ios\-router:
     \-  ip address dhcp
     \-  ip address 172.20.0.1 255.255.255.0
     \-  no ip address
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ciscoconfparse_mod.find_lines_w_child(config=None, config_path=None, parent_regex=None, child_regex=None, ignore_ws=False, saltenv=\(aqbase\(aq)
Return a list of parent lines (as text)  matching the regular expression
\fBparent_regex\fP that have children lines matching \fBchild_regex\fP\&.
.INDENT 7.0
.TP
.B config
The configuration sent as text.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument is ignored when \fBconfig_path\fP is specified.
.UNINDENT
.UNINDENT
.TP
.B config_path
The absolute or remote path to the file with the configuration to be
parsed. This argument supports the usual Salt filesystem URIs, e.g.,
\fBsalt://\fP, \fBhttps://\fP, \fBftp://\fP, \fBs3://\fP, etc.
.TP
.B parent_regex
The regular expression to match the parent lines against.
.TP
.B child_regex
The regular expression to match the child lines against.
.TP
.B ignore_ws: \fBFalse\fP
Whether to ignore the white spaces.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file. This
argument is ignored when \fBconfig_path\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ciscoconfparse.find_lines_w_child config_path=https://bit.ly/2mAdq7z parent_line=\(aqline con\(aq child_line=\(aqstopbits\(aq
salt \(aq*\(aq ciscoconfparse.find_lines_w_child config_path=https://bit.ly/2uIRxau parent_regex=\(aqge\-(.*)\(aq child_regex=\(aqunit \ed+\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ciscoconfparse_mod.find_lines_wo_child(config=None, config_path=None, parent_regex=None, child_regex=None, ignore_ws=False, saltenv=\(aqbase\(aq)
Return a list of parent \fBciscoconfparse.IOSCfgLine\fP lines as text, which
matched the \fBparent_regex\fP and whose children did \fInot\fP match \fBchild_regex\fP\&.
Only the parent \fBciscoconfparse.IOSCfgLine\fP text lines  will be returned.
For simplicity, this method only finds oldest ancestors without immediate
children that match.
.INDENT 7.0
.TP
.B config
The configuration sent as text.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument is ignored when \fBconfig_path\fP is specified.
.UNINDENT
.UNINDENT
.TP
.B config_path
The absolute or remote path to the file with the configuration to be
parsed. This argument supports the usual Salt filesystem URIs, e.g.,
\fBsalt://\fP, \fBhttps://\fP, \fBftp://\fP, \fBs3://\fP, etc.
.TP
.B parent_regex
The regular expression to match the parent lines against.
.TP
.B child_regex
The regular expression to match the child lines against.
.TP
.B ignore_ws: \fBFalse\fP
Whether to ignore the white spaces.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file. This
argument is ignored when \fBconfig_path\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ciscoconfparse.find_lines_wo_child config_path=https://bit.ly/2mAdq7z parent_line=\(aqline con\(aq child_line=\(aqstopbits\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ciscoconfparse_mod.find_objects(config=None, config_path=None, regex=None, saltenv=\(aqbase\(aq)
Return all the line objects that match the expression in the \fBregex\fP
argument.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This function is mostly valuable when invoked from other Salt
components (i.e., execution modules, states, templates etc.). For CLI
usage, please consider using
\fBciscoconfparse.find_lines\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B config
The configuration sent as text.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument is ignored when \fBconfig_path\fP is specified.
.UNINDENT
.UNINDENT
.TP
.B config_path
The absolute or remote path to the file with the configuration to be
parsed. This argument supports the usual Salt filesystem URIs, e.g.,
\fBsalt://\fP, \fBhttps://\fP, \fBftp://\fP, \fBs3://\fP, etc.
.TP
.B regex
The regular expression to match the lines against.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file. This
argument is ignored when \fBconfig_path\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
Usage example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
objects = __salt__[\(aqciscoconfparse.find_objects\(aq](config_path=\(aqsalt://path/to/config.txt\(aq,
                                                  regex=\(aqGigabit\(aq)
for obj in objects:
    print(obj.text)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ciscoconfparse_mod.find_objects_w_child(config=None, config_path=None, parent_regex=None, child_regex=None, ignore_ws=False, saltenv=\(aqbase\(aq)
Parse through the children of all parent lines matching \fBparent_regex\fP,
and return a list of child objects, which matched the \fBchild_regex\fP\&.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This function is mostly valuable when invoked from other Salt
components (i.e., execution modules, states, templates etc.). For CLI
usage, please consider using
\fBciscoconfparse.find_lines_w_child\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B config
The configuration sent as text.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument is ignored when \fBconfig_path\fP is specified.
.UNINDENT
.UNINDENT
.TP
.B config_path
The absolute or remote path to the file with the configuration to be
parsed. This argument supports the usual Salt filesystem URIs, e.g.,
\fBsalt://\fP, \fBhttps://\fP, \fBftp://\fP, \fBs3://\fP, etc.
.TP
.B parent_regex
The regular expression to match the parent lines against.
.TP
.B child_regex
The regular expression to match the child lines against.
.TP
.B ignore_ws: \fBFalse\fP
Whether to ignore the white spaces.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file. This
argument is ignored when \fBconfig_path\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
Usage example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
objects = __salt__[\(aqciscoconfparse.find_objects_w_child\(aq](config_path=\(aqhttps://bit.ly/2mAdq7z\(aq,
                                                          parent_regex=\(aqline con\(aq,
                                                          child_regex=\(aqstopbits\(aq)
for obj in objects:
    print(obj.text)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ciscoconfparse_mod.find_objects_wo_child(config=None, config_path=None, parent_regex=None, child_regex=None, ignore_ws=False, saltenv=\(aqbase\(aq)
Return a list of parent \fBciscoconfparse.IOSCfgLine\fP objects, which matched
the \fBparent_regex\fP and whose children did \fInot\fP match \fBchild_regex\fP\&.
Only the parent \fBciscoconfparse.IOSCfgLine\fP objects will be returned. For
simplicity, this method only finds oldest ancestors without immediate
children that match.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This function is mostly valuable when invoked from other Salt
components (i.e., execution modules, states, templates etc.). For CLI
usage, please consider using
\fBciscoconfparse.find_lines_wo_child\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B config
The configuration sent as text.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument is ignored when \fBconfig_path\fP is specified.
.UNINDENT
.UNINDENT
.TP
.B config_path
The absolute or remote path to the file with the configuration to be
parsed. This argument supports the usual Salt filesystem URIs, e.g.,
\fBsalt://\fP, \fBhttps://\fP, \fBftp://\fP, \fBs3://\fP, etc.
.TP
.B parent_regex
The regular expression to match the parent lines against.
.TP
.B child_regex
The regular expression to match the child lines against.
.TP
.B ignore_ws: \fBFalse\fP
Whether to ignore the white spaces.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file. This
argument is ignored when \fBconfig_path\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
Usage example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
objects = __salt__[\(aqciscoconfparse.find_objects_wo_child\(aq](config_path=\(aqhttps://bit.ly/2mAdq7z\(aq,
                                                           parent_regex=\(aqline con\(aq,
                                                           child_regex=\(aqstopbits\(aq)
for obj in objects:
    print(obj.text)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.cisconso
.sp
Execution module for Cisco Network Services Orchestrator Proxy minions
.sp
New in version 2016.11.0.

.sp
For documentation on setting up the cisconso proxy minion look in the documentation
for \fI\%salt.proxy.cisconso\fP\&.
.INDENT 0.0
.TP
.B salt.modules.cisconso.apply_rollback(datastore, name)
Apply a system rollback
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdatastore\fP (\fBDatastoreType\fP (\fBstr\fP enum).) \-\- The datastore, e.g. running, operational.
One of the NETCONF store IETF types
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- an ID of the rollback to restore
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt cisco\-nso cisconso.apply_rollback 52
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cisconso.get_data(datastore, path)
Get the configuration of the device tree at the given path
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdatastore\fP (\fBDatastoreType\fP (\fBstr\fP enum).) \-\- The datastore, e.g. running, operational.
One of the NETCONF store IETF types
.IP \(bu 2
\fBpath\fP (\fBlist\fP, \fBstr\fP OR \fBtuple\fP) \-\- The device path to set the value at,
a list of element names in order, / separated
.UNINDENT
.TP
.B Returns
The network configuration at that tree
.TP
.B Return type
\fBdict\fP
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt cisco\-nso cisconso.get_data running \(aqdevices/ex0\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cisconso.get_rollback(name)
Get the backup of stored a configuration rollback
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fBstr\fP) \-\- Typically an ID of the backup
.TP
.B Return type
\fBstr\fP
.TP
.B Returns
the contents of the rollback snapshot
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt cisco\-nso cisconso.get_rollback 52
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cisconso.get_rollbacks()
Get a list of stored configuration rollbacks
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt cisco\-nso cisconso.get_rollbacks
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cisconso.info()
Return system information for grains of the NSO proxy minion
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cisconso.info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cisconso.set_data_value(datastore, path, data)
Set a data entry in a datastore
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdatastore\fP (\fBDatastoreType\fP (\fBstr\fP enum).) \-\- The datastore, e.g. running, operational.
One of the NETCONF store IETF types
.IP \(bu 2
\fBpath\fP (\fBlist\fP, \fBstr\fP OR \fBtuple\fP) \-\- The device path to set the value at,
a list of element names in order, / separated
.IP \(bu 2
\fBdata\fP (\fBdict\fP) \-\- The new value at the given path
.UNINDENT
.TP
.B Return type
\fBbool\fP
.TP
.B Returns
\fBTrue\fP if successful, otherwise error.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt cisco\-nso cisconso.set_data_value running \(aqdevices/ex0/routes\(aq 10.0.0.20/24
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.cloud
.sp
Salt\-specific interface for calling Salt Cloud directly
.INDENT 0.0
.TP
.B salt.modules.cloud.action(fun=None, cloudmap=None, names=None, provider=None, instance=None, **kwargs)
Execute a single action on the given provider/instance
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.action start instance=myinstance
salt minionname cloud.action stop instance=myinstance
salt minionname cloud.action show_image provider=my\-ec2\-config image=ami\-1624987f
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.create(provider, names, opts=None, **kwargs)
Create an instance using Salt Cloud
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.create my\-ec2\-config myinstance image=ami\-1624987f size=\(aqt1.micro\(aq ssh_username=ec2\-user securitygroup=default delvol_on_destroy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.destroy(names)
Destroy the named VM(s)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.destroy myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.full_query(query_type=\(aqlist_nodes_full\(aq)
List all available cloud provider data
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.full_query
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.get_instance(name, provider=None)
Return details on an instance.
.sp
Similar to the cloud action show_instance
but returns only the instance details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.get_instance myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt[\(aqcloud.get_instance\(aq](\(aqmyinstance\(aq)[\(aqmac_address\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.has_instance(name, provider=None)
Return true if the instance is found on a provider
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.has_instance myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.list_images(provider=\(aqall\(aq)
List cloud provider images for the given providers
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.list_images my\-gce\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.list_locations(provider=\(aqall\(aq)
List cloud provider locations for the given providers
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.list_locations my\-gce\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.list_sizes(provider=\(aqall\(aq)
List cloud provider sizes for the given providers
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.list_sizes my\-gce\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.map_run(path=None, **kwargs)
Execute a salt cloud map file
.sp
Cloud Map data can be retrieved from several sources:
.INDENT 7.0
.IP \(bu 2
a local file (provide the path to the file to the \(aqpath\(aq argument)
.IP \(bu 2
a JSON\-formatted map directly (provide the appropriately formatted to using the \(aqmap_data\(aq argument)
.IP \(bu 2
the Salt Pillar (provide the map name of under \(aqpillar:cloud:maps\(aq to the \(aqmap_pillar\(aq argument)
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Only one of these sources can be read at a time. The options are listed
in their order of precedence.
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.map_run /path/to/cloud.map
salt minionname cloud.map_run path=/path/to/cloud.map
salt minionname cloud.map_run map_pillar=\(aq<map_pillar>\(aq
  .. versionchanged:: 2018.3.1
salt minionname cloud.map_run map_data=\(aq<actual map data>\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.network_create(provider, names, **kwargs)
Create private network
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.network_create my\-nova names=[\(aqsalt\(aq] cidr=\(aq192.168.100.0/24\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.network_list(provider)
List private networks
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.network_list my\-nova
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.profile_(profile, names, vm_overrides=None, opts=None, **kwargs)
Spin up an instance using Salt Cloud
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.profile my\-gce\-config myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.query(query_type=\(aqlist_nodes\(aq)
List cloud provider data for all providers
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.query
salt minionname cloud.query list_nodes_full
salt minionname cloud.query list_nodes_select
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.select_query(query_type=\(aqlist_nodes_select\(aq)
List selected nodes
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.select_query
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.virtual_interface_create(provider, names, **kwargs)
Attach private interfaces to a server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.virtual_interface_create my\-nova names=[\(aqsalt\-master\(aq] net_name=\(aqsalt\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.virtual_interface_list(provider, names, **kwargs)
List virtual interfaces on a server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.virtual_interface_list my\-nova names=[\(aqsalt\-master\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.volume_attach(provider, names, **kwargs)
Attach volume to a server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.volume_attach my\-nova myblock server_name=myserver device=\(aq/dev/xvdf\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.volume_create(provider, names, **kwargs)
Create volume
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.volume_create my\-nova myblock size=100 voltype=SSD
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.volume_delete(provider, names, **kwargs)
Delete volume
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.volume_delete my\-nova myblock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.volume_detach(provider, names, **kwargs)
Detach volume from a server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.volume_detach my\-nova myblock server_name=myserver
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cloud.volume_list(provider)
List block storage volumes
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minionname cloud.volume_list my\-nova
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.cmdmod
.sp
A module for shelling out.
.sp
Keep in mind that this module is insecure, in that it can give whomever has
access to the master root execution access to all salt minions.
.INDENT 0.0
.TP
.B salt.modules.cmdmod.exec_code(lang, code, cwd=None, args=None, **kwargs)
Pass in two strings, the first naming the executable language, aka \-
python2, python3, ruby, perl, lua, etc. the second string containing
the code you wish to execute. The stdout will be returned.
.sp
All parameters from \fI\%cmd.run_all\fP except python_shell can be used.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.exec_code ruby \(aqputs \(dqcheese\(dq\(aq
salt \(aq*\(aq cmd.exec_code ruby \(aqputs \(dqcheese\(dq\(aq args=\(aq[\(dqarg1\(dq, \(dqarg2\(dq]\(aq env=\(aq{\(dqFOO\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.exec_code_all(lang, code, cwd=None, args=None, **kwargs)
Pass in two strings, the first naming the executable language, aka \-
python2, python3, ruby, perl, lua, etc. the second string containing
the code you wish to execute. All cmd artifacts (stdout, stderr, retcode, pid)
will be returned.
.sp
All parameters from \fI\%cmd.run_all\fP except python_shell can be used.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.exec_code_all ruby \(aqputs \(dqcheese\(dq\(aq
salt \(aq*\(aq cmd.exec_code_all ruby \(aqputs \(dqcheese\(dq\(aq args=\(aq[\(dqarg1\(dq, \(dqarg2\(dq]\(aq env=\(aq{\(dqFOO\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.has_exec(cmd)
Returns true if the executable is available on the minion, false otherwise
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.has_exec cat
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.powershell(cmd, cwd=None, stdin=None, runas=None, shell=\(aqpowershell\(aq, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=None, use_vt=False, password=None, depth=None, encode_cmd=False, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
Execute the passed PowerShell command and return the output as a dictionary.
.sp
Other \fBcmd.*\fP functions (besides \fBcmd.powershell_all\fP)
return the raw text output of the command. This
function appends \fB| ConvertTo\-JSON\fP to the command and then parses the
JSON into a Python dictionary. If you want the raw textual result of your
PowerShell command you should use \fBcmd.run\fP with the \fBshell=powershell\fP
option.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run \(aq$PSVersionTable.CLRVersion\(aq shell=powershell
salt \(aq*\(aq cmd.run \(aqGet\-NetTCPConnection\(aq shell=powershell
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This passes the cmd argument directly to PowerShell
without any further processing! Be absolutely sure that you
have properly sanitized the command passed to this function
and do not use untrusted inputs.
.UNINDENT
.UNINDENT
.sp
In addition to the normal \fBcmd.run\fP parameters, this command offers the
\fBdepth\fP parameter to change the Windows default depth for the
\fBConvertTo\-JSON\fP powershell command. The Windows default is 2. If you need
more depth, set that here.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For some commands, setting the depth to a value greater than 4 greatly
increases the time it takes for the command to return and in many cases
returns useless data.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcmd\fP (\fI\%str\fP) \-\- The powershell command to run.
.IP \(bu 2
\fBcwd\fP (\fI\%str\fP) \-\- The directory from which to execute the command. Defaults
to the home directory of the user specified by \fBrunas\fP (or the user
under which Salt is running if \fBrunas\fP is not specified).
.IP \(bu 2
\fBstdin\fP (\fI\%str\fP) \-\- A string of standard input can be specified for the
command to be run using the \fBstdin\fP parameter. This can be useful in cases
where sensitive information must be read from standard input.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the \fBpassword\fP argument, and
the target user account must be in the Administrators group.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\-
.sp
Windows only. Required when specifying \fBrunas\fP\&. This
parameter will be ignored on non\-Windows platforms.
.sp
New in version 2016.3.0.


.IP \(bu 2
\fBshell\fP (\fI\%str\fP) \-\- Specify an alternate shell. Defaults to \(dqpowershell\(dq. Can
also use \(dqpwsh\(dq for powershell core if present on the system
.IP \(bu 2
\fBpython_shell\fP (\fI\%bool\fP) \-\- If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
.IP \(bu 2
\fBenv\fP (\fI\%dict\fP) \-\-
.sp
Environment variables to be set prior to execution.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cmd.powershell \(aqsome command\(aq env=\(aq{\(dqFOO\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When using environment variables on Window\(aqs, case\-sensitivity
matters, i.e. Window\(aqs uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBclean_env\fP (\fI\%bool\fP) \-\- Attempt to clean out all other shell environment
variables and set only those provided in the \(aqenv\(aq argument to this
function.
.IP \(bu 2
\fBtemplate\fP (\fI\%str\fP) \-\- If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
.IP \(bu 2
\fBrstrip\fP (\fI\%bool\fP) \-\- Strip all whitespace off the end of output before it is
returned.
.IP \(bu 2
\fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command.
.IP \(bu 2
\fBoutput_encoding\fP (\fI\%str\fP) \-\-
.sp
Control the encoding used to decode the
command\(aqs output.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF\-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF\-8.
.sp
To see the encoding Salt has detected from the system locale, check
the \fIlocale\fP line in the output of \fI\%test.versions_report\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBoutput_loglevel\fP (\fI\%str\fP) \-\-
.sp
Control the loglevel at which the output from
the command is logged to the minion log.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBignore_retcode\fP (\fI\%bool\fP) \-\- If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to
skip logging the output if the command has a nonzero exit code.
.IP \(bu 2
\fBhide_output\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP, suppress stdout and stderr in the
return data.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This is separate from \fBoutput_loglevel\fP, which only handles how
Salt logs to the minion log.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- A timeout in seconds for the executed process to return.
.IP \(bu 2
\fBuse_vt\fP (\fI\%bool\fP) \-\- Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
.IP \(bu 2
\fBreset_system_locale\fP (\fI\%bool\fP) \-\- Resets the system locale
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- The salt environment to use. Default is \(aqbase\(aq
.IP \(bu 2
\fBdepth\fP (\fI\%int\fP) \-\-
.sp
The number of levels of contained objects to be included.
Default is 2. Values greater than 4 seem to greatly increase the time
it takes for the command to complete for some commands. eg: \fBdir\fP
.sp
New in version 2016.3.4.


.IP \(bu 2
\fBencode_cmd\fP (\fI\%bool\fP) \-\- Encode the command before executing. Use in cases
where characters may be dropped or incorrectly converted when executed.
Default is False.
.IP \(bu 2
\fBsuccess_retcodes\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
non\-zero return codes that should be considered a success.  If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBsuccess_stdout\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBsuccess_stderr\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBstdin_raw_newlines\fP (\fI\%bool\fP) \-\- .INDENT 2.0
.TP
.B False
If \fBTrue\fP, Salt will not automatically convert the characters \fB\en\fP
present in the \fBstdin\fP value to newlines.
.UNINDENT
.sp
New in version 2019.2.0.


.UNINDENT
.TP
.B Returns
.INDENT 7.0
.TP
.B dict
A dictionary of data returned by the powershell command.
.UNINDENT

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.powershell \(dq$PSVersionTable.CLRVersion\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.powershell_all(cmd, cwd=None, stdin=None, runas=None, shell=\(aqpowershell\(aq, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, quiet=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=None, use_vt=False, password=None, depth=None, encode_cmd=False, force_list=False, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
Execute the passed PowerShell command and return a dictionary with a result
field representing the output of the command, as well as other fields
showing us what the PowerShell invocation wrote to \fBstderr\fP, the process
id, and the exit code of the invocation.
.sp
This function appends \fB| ConvertTo\-JSON\fP to the command before actually
invoking powershell.
.sp
An unquoted empty string is not valid JSON, but it\(aqs very normal for the
Powershell output to be exactly that. Therefore, we do not attempt to parse
empty Powershell output (which would result in an exception). Instead we
treat this as a special case and one of two things will happen:
.INDENT 7.0
.IP \(bu 2
If the value of the \fBforce_list\fP parameter is \fBTrue\fP, then the
\fBresult\fP field of the return dictionary will be an empty list.
.IP \(bu 2
If the value of the \fBforce_list\fP parameter is \fBFalse\fP, then the
return dictionary \fBwill not have a result key added to it\fP\&. We aren\(aqt
setting \fBresult\fP to \fBNone\fP in this case, because \fBNone\fP is the
Python representation of \(dqnull\(dq in JSON. (We likewise can\(aqt use \fBFalse\fP
for the equivalent reason.)
.UNINDENT
.sp
If Powershell\(aqs output is not an empty string and Python cannot parse its
content, then a \fBCommandExecutionError\fP exception will be raised.
.sp
If Powershell\(aqs output is not an empty string, Python is able to parse its
content, and the type of the resulting Python object is other than \fBlist\fP
then one of two things will happen:
.INDENT 7.0
.IP \(bu 2
If the value of the \fBforce_list\fP parameter is \fBTrue\fP, then the
\fBresult\fP field will be a singleton list with the Python object as its
sole member.
.IP \(bu 2
If the value of the \fBforce_list\fP parameter is \fBFalse\fP, then the value
of \fBresult\fP will be the unmodified Python object.
.UNINDENT
.sp
If Powershell\(aqs output is not an empty string, Python is able to parse its
content, and the type of the resulting Python object is \fBlist\fP, then the
value of \fBresult\fP will be the unmodified Python object. The
\fBforce_list\fP parameter has no effect in this case.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
An example of why the \fBforce_list\fP parameter is useful is as
follows: The Powershell command \fBdir x | Convert\-ToJson\fP results in
.INDENT 0.0
.IP \(bu 2
no output when x is an empty directory.
.IP \(bu 2
a dictionary object when x contains just one item.
.IP \(bu 2
a list of dictionary objects when x contains multiple items.
.UNINDENT
.sp
By setting \fBforce_list\fP to \fBTrue\fP we will always end up with a
list of dictionary items, representing files, no matter how many files
x contains.  Conversely, if \fBforce_list\fP is \fBFalse\fP, we will end
up with no \fBresult\fP key in our return dictionary when x is an empty
directory, and a dictionary object when x contains just one file.
.UNINDENT
.UNINDENT
.sp
If you want a similar function but with a raw textual result instead of a
Python dictionary, you should use \fBcmd.run_all\fP in combination with
\fBshell=powershell\fP\&.
.sp
The remaining fields in the return dictionary are described in more detail
in the \fBReturns\fP section.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run_all \(aq$PSVersionTable.CLRVersion\(aq shell=powershell
salt \(aq*\(aq cmd.run_all \(aqGet\-NetTCPConnection\(aq shell=powershell
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This passes the cmd argument directly to PowerShell without any further
processing! Be absolutely sure that you have properly sanitized the
command passed to this function and do not use untrusted inputs.
.UNINDENT
.UNINDENT
.sp
In addition to the normal \fBcmd.run\fP parameters, this command offers the
\fBdepth\fP parameter to change the Windows default depth for the
\fBConvertTo\-JSON\fP powershell command. The Windows default is 2. If you need
more depth, set that here.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For some commands, setting the depth to a value greater than 4 greatly
increases the time it takes for the command to return and in many cases
returns useless data.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcmd\fP (\fI\%str\fP) \-\- The powershell command to run.
.IP \(bu 2
\fBcwd\fP (\fI\%str\fP) \-\- The directory from which to execute the command. Defaults
to the home directory of the user specified by \fBrunas\fP (or the user
under which Salt is running if \fBrunas\fP is not specified).
.IP \(bu 2
\fBstdin\fP (\fI\%str\fP) \-\- A string of standard input can be specified for the
command to be run using the \fBstdin\fP parameter. This can be useful in
cases where sensitive information must be read from standard input.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the \fBpassword\fP argument, and
the target user account must be in the Administrators group.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- Windows only. Required when specifying \fBrunas\fP\&. This
parameter will be ignored on non\-Windows platforms.
.IP \(bu 2
\fBshell\fP (\fI\%str\fP) \-\- Specify an alternate shell. Defaults to \(dqpowershell\(dq. Can
also use \(dqpwsh\(dq for powershell core if present on the system
.IP \(bu 2
\fBpython_shell\fP (\fI\%bool\fP) \-\- If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
.IP \(bu 2
\fBenv\fP (\fI\%dict\fP) \-\-
.sp
Environment variables to be set prior to execution.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cmd.powershell_all \(aqsome command\(aq env=\(aq{\(dqFOO\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When using environment variables on Window\(aqs, case\-sensitivity
matters, i.e. Window\(aqs uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBclean_env\fP (\fI\%bool\fP) \-\- Attempt to clean out all other shell environment
variables and set only those provided in the \(aqenv\(aq argument to this
function.
.IP \(bu 2
\fBtemplate\fP (\fI\%str\fP) \-\- If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
.IP \(bu 2
\fBrstrip\fP (\fI\%bool\fP) \-\- Strip all whitespace off the end of output before it is
returned.
.IP \(bu 2
\fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command.
.IP \(bu 2
\fBoutput_encoding\fP (\fI\%str\fP) \-\-
.sp
Control the encoding used to decode the
command\(aqs output.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF\-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF\-8.
.sp
To see the encoding Salt has detected from the system locale, check
the \fIlocale\fP line in the output of \fI\%test.versions_report\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBoutput_loglevel\fP (\fI\%str\fP) \-\-
.sp
Control the loglevel at which the output from
the command is logged to the minion log.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBignore_retcode\fP (\fI\%bool\fP) \-\- If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to
skip logging the output if the command has a nonzero exit code.
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- A timeout in seconds for the executed process to
return.
.IP \(bu 2
\fBuse_vt\fP (\fI\%bool\fP) \-\- Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
.IP \(bu 2
\fBreset_system_locale\fP (\fI\%bool\fP) \-\- Resets the system locale
.IP \(bu 2
\fBignore_retcode\fP \-\- If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to
skip logging the output if the command has a nonzero exit code.
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- The salt environment to use. Default is \(aqbase\(aq
.IP \(bu 2
\fBdepth\fP (\fI\%int\fP) \-\- The number of levels of contained objects to be included.
Default is 2. Values greater than 4 seem to greatly increase the time
it takes for the command to complete for some commands. eg: \fBdir\fP
.IP \(bu 2
\fBencode_cmd\fP (\fI\%bool\fP) \-\- Encode the command before executing. Use in cases
where characters may be dropped or incorrectly converted when executed.
Default is False.
.IP \(bu 2
\fBforce_list\fP (\fI\%bool\fP) \-\- The purpose of this parameter is described in the
preamble of this function\(aqs documentation. Default value is False.
.IP \(bu 2
\fBsuccess_retcodes\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
non\-zero return codes that should be considered a success.  If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBsuccess_stdout\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBsuccess_stderr\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBstdin_raw_newlines\fP (\fI\%bool\fP) \-\- .INDENT 2.0
.TP
.B False
If \fBTrue\fP, Salt will not automatically convert the characters \fB\en\fP
present in the \fBstdin\fP value to newlines.
.UNINDENT
.sp
New in version 2019.2.0.


.UNINDENT
.TP
.B Returns
A dictionary with the following entries:
.INDENT 7.0
.TP
.B result
For a complete description of this field, please refer to this
function\(aqs preamble. \fBThis key will not be added to the dictionary
when force_list is False and Powershell\(aqs output is the empty
string.\fP
.TP
.B stderr
What the PowerShell invocation wrote to \fBstderr\fP\&.
.TP
.B pid
The process id of the PowerShell invocation
.TP
.B retcode
This is the exit code of the invocation of PowerShell.
If the final execution status (in PowerShell) of our command
(with \fB| ConvertTo\-JSON\fP appended) is \fBFalse\fP this should be non\-0.
Likewise if PowerShell exited with \fB$LASTEXITCODE\fP set to some
non\-0 value, then \fBretcode\fP will end up with this value.
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.powershell_all \(dq$PSVersionTable.CLRVersion\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.powershell_all \(dqdir mydirectory\(dq force_list=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.retcode(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, clean_env=False, template=None, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=None, use_vt=False, password=None, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
Execute a shell command and return the command\(aqs return code.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcmd\fP (\fI\%str\fP) \-\- The command to run. ex: \fBls \-lart /home\fP
.IP \(bu 2
\fBcwd\fP (\fI\%str\fP) \-\- The directory from which to execute the command. Defaults
to the home directory of the user specified by \fBrunas\fP (or the user
under which Salt is running if \fBrunas\fP is not specified).
.IP \(bu 2
\fBstdin\fP (\fI\%str\fP) \-\- A string of standard input can be specified for the
command to be run using the \fBstdin\fP parameter. This can be useful in
cases where sensitive information must be read from standard input.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\-
.sp
Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the \fBpassword\fP argument, and
the target user account must be in the Administrators group.
.sp
\fBWARNING:\fP
.INDENT 2.0
.INDENT 3.5
For versions 2018.3.3 and above on macosx while using runas,
to pass special characters to the command you need to escape
the characters on the shell.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cmd.retcode \(aqecho \(aq\e\(aq\(aqh=\e\(dqbaz\e\(dq\(aq\e\(aq\(aq\(aq runas=macuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\-
.sp
Windows only. Required when specifying \fBrunas\fP\&. This
parameter will be ignored on non\-Windows platforms.
.sp
New in version 2016.3.0.


.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- Group to run command as. Not currently supported
on Windows.
.IP \(bu 2
\fBshell\fP (\fI\%str\fP) \-\- Specify an alternate shell. Defaults to the system\(aqs
default shell.
.IP \(bu 2
\fBpython_shell\fP (\fI\%bool\fP) \-\- If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
.IP \(bu 2
\fBenv\fP (\fI\%dict\fP) \-\-
.sp
Environment variables to be set prior to execution.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cmd.retcode \(aqsome command\(aq env=\(aq{\(dqFOO\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When using environment variables on Window\(aqs, case\-sensitivity
matters, i.e. Window\(aqs uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBclean_env\fP (\fI\%bool\fP) \-\- Attempt to clean out all other shell environment
variables and set only those provided in the \(aqenv\(aq argument to this
function.
.IP \(bu 2
\fBtemplate\fP (\fI\%str\fP) \-\- If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
.IP \(bu 2
\fBrstrip\fP (\fI\%bool\fP) \-\- Strip all whitespace off the end of output before it is
returned.
.IP \(bu 2
\fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command.
.IP \(bu 2
\fBoutput_encoding\fP (\fI\%str\fP) \-\-
.sp
Control the encoding used to decode the
command\(aqs output.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF\-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF\-8.
.sp
To see the encoding Salt has detected from the system locale, check
the \fIlocale\fP line in the output of \fI\%test.versions_report\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBoutput_loglevel\fP (\fI\%str\fP) \-\-
.sp
Control the loglevel at which the output from
the command is logged to the minion log.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBignore_retcode\fP (\fI\%bool\fP) \-\- If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to
skip logging the output if the command has a nonzero exit code.
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- A timeout in seconds for the executed process to return.
.IP \(bu 2
\fBuse_vt\fP (\fI\%bool\fP) \-\- Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
.IP \(bu 2
\fBsuccess_retcodes\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
non\-zero return codes that should be considered a success.  If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBsuccess_stdout\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBsuccess_stderr\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBstdin_raw_newlines\fP (\fI\%bool\fP) \-\- .INDENT 2.0
.TP
.B False
If \fBTrue\fP, Salt will not automatically convert the characters \fB\en\fP
present in the \fBstdin\fP value to newlines.
.UNINDENT
.sp
New in version 2019.2.0.


.UNINDENT
.TP
.B Return type
\fI\%int\fP
.TP
.B Return type
None
.TP
.B Returns
Return Code as an int or None if there was an exception.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.retcode \(dqfile /bin/bash\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The template arg can be set to \(aqjinja\(aq or another supported template
engine to render the command arguments before execution.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.retcode template=jinja \(dqfile {{grains.pythonpath[0]}}/python\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A string of standard input can be specified for the command to be run using
the \fBstdin\fP parameter. This can be useful in cases where sensitive
information must be read from standard input.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.retcode \(dqgrep f\(dq stdin=\(aqone\entwo\enthree\enfour\enfive\en\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.run(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=None, use_vt=False, redirect_stderr=True, bg=False, password=None, encoded_cmd=False, raise_err=False, prepend_path=None, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
Execute the passed command and return the output as a string
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcmd\fP (\fI\%str\fP) \-\- The command to run. ex: \fBls \-lart /home\fP
.IP \(bu 2
\fBcwd\fP (\fI\%str\fP) \-\- The directory from which to execute the command. Defaults
to the home directory of the user specified by \fBrunas\fP (or the user
under which Salt is running if \fBrunas\fP is not specified).
.IP \(bu 2
\fBstdin\fP (\fI\%str\fP) \-\- A string of standard input can be specified for the
command to be run using the \fBstdin\fP parameter. This can be useful in
cases where sensitive information must be read from standard input.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\-
.sp
Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running.
.sp
\fBWARNING:\fP
.INDENT 2.0
.INDENT 3.5
For versions 2018.3.3 and above on macosx while using runas,
on linux while using run, to pass special characters to the
command you need to escape the characters on the shell.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cmd.run \(aqecho \(aq\e\(aq\(aqh=\e\(dqbaz\e\(dq\(aq\e\(aq\(aq\(aq runas=macuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- Group to run command as. Not currently supported
on Windows.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\-
.sp
Windows only. Required when specifying \fBrunas\fP\&. This
parameter will be ignored on non\-Windows platforms.
.sp
New in version 2016.3.0.


.IP \(bu 2
\fBshell\fP (\fI\%str\fP) \-\- Specify an alternate shell. Defaults to the system\(aqs
default shell.
.IP \(bu 2
\fBpython_shell\fP (\fI\%bool\fP) \-\- If \fBFalse\fP, let python handle the positional
arguments. Set to \fBTrue\fP to use shell features, such as pipes or
redirection.
.IP \(bu 2
\fBbg\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP, run command in background and do not await or
deliver its results
.sp
New in version 2016.3.0.


.IP \(bu 2
\fBenv\fP (\fI\%dict\fP) \-\-
.sp
Environment variables to be set prior to execution.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cmd.run \(aqsome command\(aq env=\(aq{\(dqFOO\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When using environment variables on Window\(aqs, case\-sensitivity
matters, i.e. Window\(aqs uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBclean_env\fP (\fI\%bool\fP) \-\- Attempt to clean out all other shell environment
variables and set only those provided in the \(aqenv\(aq argument to this
function.
.IP \(bu 2
\fBprepend_path\fP (\fI\%str\fP) \-\-
.sp
$PATH segment to prepend (trailing \(aq:\(aq not
necessary) to $PATH
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBtemplate\fP (\fI\%str\fP) \-\- If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
.IP \(bu 2
\fBrstrip\fP (\fI\%bool\fP) \-\- Strip all whitespace off the end of output before it is
returned.
.IP \(bu 2
\fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command.
.IP \(bu 2
\fBoutput_encoding\fP (\fI\%str\fP) \-\-
.sp
Control the encoding used to decode the
command\(aqs output.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF\-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF\-8.
.sp
To see the encoding Salt has detected from the system locale, check
the \fIlocale\fP line in the output of \fI\%test.versions_report\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBoutput_loglevel\fP (\fI\%str\fP) \-\-
.sp
Control the loglevel at which the output from
the command is logged to the minion log.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBignore_retcode\fP (\fI\%bool\fP) \-\- If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to
skip logging the output if the command has a nonzero exit code.
.IP \(bu 2
\fBhide_output\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP, suppress stdout and stderr in the
return data.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This is separate from \fBoutput_loglevel\fP, which only handles how
Salt logs to the minion log.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- A timeout in seconds for the executed process to return.
.IP \(bu 2
\fBuse_vt\fP (\fI\%bool\fP) \-\- Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
.IP \(bu 2
\fBredirect_stderr\fP (\fI\%bool\fP) \-\-
.sp
If set to \fBTrue\fP, then stderr will be
redirected to stdout. This is helpful for cases where obtaining both
the retcode and output is desired. Default is \fBTrue\fP
.sp
New in version 3006.9.


.IP \(bu 2
\fBencoded_cmd\fP (\fI\%bool\fP) \-\-
.sp
Specify if the supplied command is encoded.
Only applies to shell \(aqpowershell\(aq and \(aqpwsh\(aq.
.sp
New in version 2018.3.0.

.sp
Older versions of powershell seem to return raw xml data in the return.
To avoid raw xml data in the return, prepend your command with the
following before encoding:
.sp
\fI$ProgressPreference=\(aqSilentlyContinue\(aq; <your command>\fP
.sp
The following powershell code block will encode the \fIWrite\-Output\fP
command so that it will not have the raw xml data in the return:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
# target string
$Command = \(aq$ProgressPreference=\(dqSilentlyContinue\(dq; Write\-Output \(dqhello\(dq\(aq

# Convert to Base64 encoded string
$Encoded = [convert]::ToBase64String([System.Text.encoding]::Unicode.GetBytes($command))

Write\-Output $Encoded
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBraise_err\fP (\fI\%bool\fP) \-\- If \fBTrue\fP and the command has a nonzero exit code,
a CommandExecutionError exception will be raised.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This function does not process commands through a shell
unless the python_shell flag is set to True. This means that any
shell\-specific functionality such as \(aqecho\(aq or the use of pipes,
redirection or &&, should either be migrated to cmd.shell or
have the python_shell=True flag set here.
.sp
The use of python_shell=True means that the shell will accept _any_ input
including potentially malicious commands such as \(aqgood_command;rm \-rf /\(aq.
Be absolutely certain that you have sanitized your input prior to using
python_shell=True
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsuccess_retcodes\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
non\-zero return codes that should be considered a success.  If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBsuccess_stdout\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBsuccess_stderr\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBstdin_raw_newlines\fP (\fI\%bool\fP) \-\- .INDENT 2.0
.TP
.B False
If \fBTrue\fP, Salt will not automatically convert the characters \fB\e\en\fP
present in the \fBstdin\fP value to newlines.
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBwindows_codepage\fP (\fI\%int\fP) \-\- .INDENT 2.0
.TP
.B 65001
Only applies to Windows: the minion uses \fIC:WindowsSystem32chcp.com\fP to
verify or set the code page before the command \fIcmd\fP is executed.
Code page 65001 corresponds with UTF\-8 and allows international localization of Windows.
.UNINDENT
.sp
New in version 3002.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run \(dqls \-l | awk \(aq/foo/{print \e\e$2}\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The template arg can be set to \(aqjinja\(aq or another supported template
engine to render the command arguments before execution.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run template=jinja \(dqls \-l /tmp/{{grains.id}} | awk \(aq/foo/{print \e\e$2}\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Specify an alternate shell with the shell parameter:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run \(dqGet\-ChildItem C:\e\e \(dq shell=\(aqpowershell\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A string of standard input can be specified for the command to be run using
the \fBstdin\fP parameter. This can be useful in cases where sensitive
information must be read from standard input.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run \(dqgrep f\(dq stdin=\(aqone\e\entwo\e\enthree\e\enfour\e\enfive\e\en\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If an equal sign (\fB=\fP) appears in an argument to a Salt command it is
interpreted as a keyword argument in the format \fBkey=val\fP\&. That
processing can be bypassed in order to pass an equal sign through to the
remote shell command by manually specifying the kwarg:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run cmd=\(aqsed \-e s/=/:/g\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.run_all(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=None, use_vt=False, redirect_stderr=False, password=None, encoded_cmd=False, prepend_path=None, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
Execute the passed command and return a dict of return data
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcmd\fP (\fI\%str\fP) \-\- The command to run. ex: \fBls \-lart /home\fP
.IP \(bu 2
\fBcwd\fP (\fI\%str\fP) \-\- The directory from which to execute the command. Defaults
to the home directory of the user specified by \fBrunas\fP (or the user
under which Salt is running if \fBrunas\fP is not specified).
.IP \(bu 2
\fBstdin\fP (\fI\%str\fP) \-\- A string of standard input can be specified for the
command to be run using the \fBstdin\fP parameter. This can be useful in
cases where sensitive information must be read from standard input.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\-
.sp
Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the \fBpassword\fP argument, and
the target user account must be in the Administrators group.
.sp
\fBWARNING:\fP
.INDENT 2.0
.INDENT 3.5
For versions 2018.3.3 and above on macosx while using runas,
to pass special characters to the command you need to escape
the characters on the shell.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cmd.run_all \(aqecho \(aq\e\(aq\(aqh=\e\(dqbaz\e\(dq\(aq\e\(aq\(aq\(aq runas=macuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\-
.sp
Windows only. Required when specifying \fBrunas\fP\&. This
parameter will be ignored on non\-Windows platforms.
.sp
New in version 2016.3.0.


.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- Group to run command as. Not currently supported
on Windows.
.IP \(bu 2
\fBshell\fP (\fI\%str\fP) \-\- Specify an alternate shell. Defaults to the system\(aqs
default shell.
.IP \(bu 2
\fBpython_shell\fP (\fI\%bool\fP) \-\- If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
.IP \(bu 2
\fBenv\fP (\fI\%dict\fP) \-\-
.sp
Environment variables to be set prior to execution.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cmd.run_all \(aqsome command\(aq env=\(aq{\(dqFOO\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When using environment variables on Window\(aqs, case\-sensitivity
matters, i.e. Window\(aqs uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBclean_env\fP (\fI\%bool\fP) \-\- Attempt to clean out all other shell environment
variables and set only those provided in the \(aqenv\(aq argument to this
function.
.IP \(bu 2
\fBprepend_path\fP (\fI\%str\fP) \-\-
.sp
$PATH segment to prepend (trailing \(aq:\(aq not
necessary) to $PATH
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBtemplate\fP (\fI\%str\fP) \-\- If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
.IP \(bu 2
\fBrstrip\fP (\fI\%bool\fP) \-\- Strip all whitespace off the end of output before it is
returned.
.IP \(bu 2
\fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command.
.IP \(bu 2
\fBoutput_encoding\fP (\fI\%str\fP) \-\-
.sp
Control the encoding used to decode the
command\(aqs output.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF\-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF\-8.
.sp
To see the encoding Salt has detected from the system locale, check
the \fIlocale\fP line in the output of \fI\%test.versions_report\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBoutput_loglevel\fP (\fI\%str\fP) \-\-
.sp
Control the loglevel at which the output from
the command is logged to the minion log.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBignore_retcode\fP (\fI\%bool\fP) \-\- If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to
skip logging the output if the command has a nonzero exit code.
.IP \(bu 2
\fBhide_output\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP, suppress stdout and stderr in the
return data.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This is separate from \fBoutput_loglevel\fP, which only handles how
Salt logs to the minion log.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- A timeout in seconds for the executed process to
return.
.IP \(bu 2
\fBuse_vt\fP (\fI\%bool\fP) \-\- Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
.IP \(bu 2
\fBencoded_cmd\fP (\fI\%bool\fP) \-\-
.sp
Specify if the supplied command is encoded.
Only applies to shell \(aqpowershell\(aq and \(aqpwsh\(aq.
.sp
New in version 2018.3.0.

.sp
Older versions of powershell seem to return raw xml data in the return.
To avoid raw xml data in the return, prepend your command with the
following before encoding:
.sp
\fI$ProgressPreference=\(aqSilentlyContinue\(aq; <your command>\fP
.sp
The following powershell code block will encode the \fIWrite\-Output\fP
command so that it will not have the raw xml data in the return:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
# target string
$Command = \(aq$ProgressPreference=\(dqSilentlyContinue\(dq; Write\-Output \(dqhello\(dq\(aq

# Convert to Base64 encoded string
$Encoded = [convert]::ToBase64String([System.Text.encoding]::Unicode.GetBytes($command))

Write\-Output $Encoded
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBredirect_stderr\fP (\fI\%bool\fP) \-\-
.sp
If set to \fBTrue\fP, then stderr will be
redirected to stdout. This is helpful for cases where obtaining both
the retcode and output is desired, but it is not desired to have the
output separated into both stdout and stderr.
.sp
New in version 2015.8.2.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
Windows only. Required when specifying \fBrunas\fP\&. This
parameter will be ignored on non\-Windows platforms.
.INDENT 2.0
.INDENT 3.5
New in version 2016.3.0.

.UNINDENT
.UNINDENT

.IP \(bu 2
\fBbg\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP, run command in background and do not await or
deliver its results
.sp
New in version 2016.3.6.


.IP \(bu 2
\fBsuccess_retcodes\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
non\-zero return codes that should be considered a success.  If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBsuccess_stdout\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBsuccess_stderr\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBstdin_raw_newlines\fP (\fI\%bool\fP) \-\- .INDENT 2.0
.TP
.B False
If \fBTrue\fP, Salt will not automatically convert the characters \fB\en\fP
present in the \fBstdin\fP value to newlines.
.UNINDENT
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run_all \(dqls \-l | awk \(aq/foo/{print \e$2}\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The template arg can be set to \(aqjinja\(aq or another supported template
engine to render the command arguments before execution.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run_all template=jinja \(dqls \-l /tmp/{{grains.id}} | awk \(aq/foo/{print \e$2}\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A string of standard input can be specified for the command to be run using
the \fBstdin\fP parameter. This can be useful in cases where sensitive
information must be read from standard input.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run_all \(dqgrep f\(dq stdin=\(aqone\entwo\enthree\enfour\enfive\en\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.run_bg(cmd, cwd=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, clean_env=False, template=None, umask=None, timeout=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, reset_system_locale=True, ignore_retcode=False, saltenv=None, password=None, prepend_path=None, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
New in version 2016.3.0.

.sp
Execute the passed command in the background and return its PID
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the init system is systemd and the backgrounded task should run even
if the salt\-minion process is restarted, prepend \fBsystemd\-run
\-\-scope\fP to the command. This will reparent the process in its own
scope separate from salt\-minion, and will not be affected by restarting
the minion service.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcmd\fP (\fI\%str\fP) \-\- The command to run. ex: \fBls \-lart /home\fP
.IP \(bu 2
\fBcwd\fP (\fI\%str\fP) \-\- The directory from which to execute the command. Defaults
to the home directory of the user specified by \fBrunas\fP (or the user
under which Salt is running if \fBrunas\fP is not specified).
.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- Group to run command as. Not currently supported
on Windows.
.IP \(bu 2
\fBshell\fP (\fI\%str\fP) \-\- Shell to execute under. Defaults to the system default
shell.
.IP \(bu 2
\fBoutput_encoding\fP (\fI\%str\fP) \-\-
.sp
Control the encoding used to decode the
command\(aqs output.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF\-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF\-8.
.sp
To see the encoding Salt has detected from the system locale, check
the \fIlocale\fP line in the output of \fI\%test.versions_report\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBoutput_loglevel\fP (\fI\%str\fP) \-\-
.sp
Control the loglevel at which the output from
the command is logged to the minion log.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBignore_retcode\fP (\fI\%bool\fP) \-\- If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to
skip logging the output if the command has a nonzero exit code.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\-
.sp
Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the \fBpassword\fP argument, and
the target user account must be in the Administrators group.
.sp
\fBWARNING:\fP
.INDENT 2.0
.INDENT 3.5
For versions 2018.3.3 and above on macosx while using runas,
to pass special characters to the command you need to escape
the characters on the shell.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cmd.run_bg \(aqecho \(aq\e\(aq\(aqh=\e\(dqbaz\e\(dq\(aq\e\(aq\(aq\(aq runas=macuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\-
.sp
Windows only. Required when specifying \fBrunas\fP\&. This
parameter will be ignored on non\-Windows platforms.
.sp
New in version 2016.3.0.


.IP \(bu 2
\fBshell\fP \-\- Specify an alternate shell. Defaults to the system\(aqs
default shell.
.IP \(bu 2
\fBpython_shell\fP (\fI\%bool\fP) \-\- If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
.IP \(bu 2
\fBenv\fP (\fI\%dict\fP) \-\-
.sp
Environment variables to be set prior to execution.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cmd.run_bg \(aqsome command\(aq env=\(aq{\(dqFOO\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When using environment variables on Window\(aqs, case\-sensitivity
matters, i.e. Window\(aqs uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBclean_env\fP (\fI\%bool\fP) \-\- Attempt to clean out all other shell environment
variables and set only those provided in the \(aqenv\(aq argument to this
function.
.IP \(bu 2
\fBprepend_path\fP (\fI\%str\fP) \-\-
.sp
$PATH segment to prepend (trailing \(aq:\(aq not
necessary) to $PATH
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBtemplate\fP (\fI\%str\fP) \-\- If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
.IP \(bu 2
\fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command.
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- A timeout in seconds for the executed process to return.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This function does not process commands through a shell unless the
\fBpython_shell\fP argument is set to \fBTrue\fP\&. This means that any
shell\-specific functionality such as \(aqecho\(aq or the use of pipes,
redirection or &&, should either be migrated to cmd.shell or have the
python_shell=True flag set here.
.sp
The use of \fBpython_shell=True\fP means that the shell will accept _any_
input including potentially malicious commands such as \(aqgood_command;rm
\-rf /\(aq.  Be absolutely certain that you have sanitized your input prior
to using \fBpython_shell=True\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsuccess_retcodes\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
non\-zero return codes that should be considered a success.  If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBsuccess_stdout\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBsuccess_stderr\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBstdin_raw_newlines\fP (\fI\%bool\fP) \-\- .INDENT 2.0
.TP
.B False
If \fBTrue\fP, Salt will not automatically convert the characters \fB\e\en\fP
present in the \fBstdin\fP value to newlines.
.UNINDENT
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run_bg \(dqfstrim\-all\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The template arg can be set to \(aqjinja\(aq or another supported template
engine to render the command arguments before execution.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run_bg template=jinja \(dqls \-l /tmp/{{grains.id}} | awk \(aq/foo/{print \e\e$2}\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Specify an alternate shell with the shell parameter:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run_bg \(dqGet\-ChildItem C:\e\e \(dq shell=\(aqpowershell\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If an equal sign (\fB=\fP) appears in an argument to a Salt command it is
interpreted as a keyword argument in the format \fBkey=val\fP\&. That
processing can be bypassed in order to pass an equal sign through to the
remote shell command by manually specifying the kwarg:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run_bg cmd=\(aqls \-lR / | sed \-e s/=/:/g > /tmp/dontwait\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.run_chroot(root, cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=True, binds=None, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqquiet\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=None, use_vt=False, bg=False, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
New in version 2014.7.0.

.sp
This function runs \fI\%cmd.run_all\fP wrapped
within a chroot, with dev and proc mounted in the chroot
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBroot\fP (\fI\%str\fP) \-\- Path to the root of the jail to use.
.IP \(bu 2
\fBstdin\fP (\fI\%str\fP) \-\- A string of standard input can be specified for
the command to be run using the \fBstdin\fP parameter. This can
be useful in cases where sensitive information must be read
from standard input.:
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- User to run script as.
.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- Group to run script as.
.IP \(bu 2
\fBshell\fP (\fI\%str\fP) \-\- Shell to execute under. Defaults to the system
default shell.
.IP \(bu 2
\fBcmd\fP (\fI\%str\fP) \-\- The command to run. ex: \fBls \-lart /home\fP
.IP \(bu 2
\fBcwd\fP (\fI\%str\fP) \-\- The directory from which to execute the command. Defaults
to the home directory of the user specified by \fBrunas\fP (or the user
under which Salt is running if \fBrunas\fP is not specified).
.IP \(bu 2
\fBrunas\fP \-\- Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the \fBpassword\fP argument, and
the target user account must be in the Administrators group.
.IP \(bu 2
\fBshell\fP \-\- Specify an alternate shell. Defaults to the system\(aqs
default shell.
.IP \(bu 2
\fBpython_shell\fP (\fI\%bool\fP) \-\- If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
.IP \(bu 2
\fBbinds\fP (\fI\%list\fP) \-\-
.sp
List of directories that will be exported inside
the chroot with the bind option.
.sp
New in version 3000.


.IP \(bu 2
\fBenv\fP (\fI\%dict\fP) \-\-
.sp
Environment variables to be set prior to execution.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cmd.run_chroot \(aqsome command\(aq env=\(aq{\(dqFOO\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When using environment variables on Window\(aqs, case\-sensitivity
matters, i.e. Window\(aqs uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBclean_env\fP (\fI\%dict\fP) \-\- Attempt to clean out all other shell environment
variables and set only those provided in the \(aqenv\(aq argument to this
function.
.IP \(bu 2
\fBtemplate\fP (\fI\%str\fP) \-\- If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
.IP \(bu 2
\fBrstrip\fP (\fI\%bool\fP) \-\- Strip all whitespace off the end of output
before it is returned.
.IP \(bu 2
\fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the
command.
.IP \(bu 2
\fBoutput_encoding\fP (\fI\%str\fP) \-\-
.sp
Control the encoding used to decode the
command\(aqs output.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF\-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF\-8.
.sp
To see the encoding Salt has detected from the system locale, check
the \fIlocale\fP line in the output of \fI\%test.versions_report\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBoutput_loglevel\fP (\fI\%str\fP) \-\-
.sp
Control the loglevel at which the output from
the command is logged to the minion log.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBignore_retcode\fP (\fI\%bool\fP) \-\- If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to
skip logging the output if the command has a nonzero exit code.
.IP \(bu 2
\fBhide_output\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP, suppress stdout and stderr in the
return data.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This is separate from \fBoutput_loglevel\fP, which only handles how
Salt logs to the minion log.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- A timeout in seconds for the executed process to return.
.IP \(bu 2
\fBuse_vt\fP (\fI\%bool\fP) \-\- Use VT utils (saltstack) to stream the command output more
interactively to the console and the logs. This is experimental.
.IP \(bu 2
\fBsuccess_retcodes\fP \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
non\-zero return codes that should be considered a success.  If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBsuccess_stdout\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBsuccess_stderr\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.UNINDENT
.TP
.B Parar str stdin
A string of standard input can be specified for the
command to be run using the \fBstdin\fP parameter. This can be useful in
cases where sensitive information must be read from standard input.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run_chroot /var/lib/lxc/container_name/rootfs \(aqsh /tmp/bootstrap.sh\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.run_stderr(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=None, use_vt=False, password=None, prepend_path=None, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
Execute a command and only return the standard error
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcmd\fP (\fI\%str\fP) \-\- The command to run. ex: \fBls \-lart /home\fP
.IP \(bu 2
\fBcwd\fP (\fI\%str\fP) \-\- The directory from which to execute the command. Defaults
to the home directory of the user specified by \fBrunas\fP (or the user
under which Salt is running if \fBrunas\fP is not specified).
.IP \(bu 2
\fBstdin\fP (\fI\%str\fP) \-\- A string of standard input can be specified for the
command to be run using the \fBstdin\fP parameter. This can be useful in
cases where sensitive information must be read from standard input.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\-
.sp
Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the \fBpassword\fP argument, and
the target user account must be in the Administrators group.
.sp
\fBWARNING:\fP
.INDENT 2.0
.INDENT 3.5
For versions 2018.3.3 and above on macosx while using runas,
to pass special characters to the command you need to escape
the characters on the shell.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cmd.run_stderr \(aqecho \(aq\e\(aq\(aqh=\e\(dqbaz\e\(dq\(aq\e\(aq\(aq\(aq runas=macuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\-
.sp
Windows only. Required when specifying \fBrunas\fP\&. This
parameter will be ignored on non\-Windows platforms.
.sp
New in version 2016.3.0.


.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- Group to run command as. Not currently supported
on Windows.
.IP \(bu 2
\fBshell\fP (\fI\%str\fP) \-\- Specify an alternate shell. Defaults to the system\(aqs
default shell.
.IP \(bu 2
\fBpython_shell\fP (\fI\%bool\fP) \-\- If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
.IP \(bu 2
\fBenv\fP (\fI\%dict\fP) \-\-
.sp
Environment variables to be set prior to execution.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cmd.run_stderr \(aqsome command\(aq env=\(aq{\(dqFOO\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When using environment variables on Window\(aqs, case\-sensitivity
matters, i.e. Window\(aqs uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBclean_env\fP (\fI\%bool\fP) \-\- Attempt to clean out all other shell environment
variables and set only those provided in the \(aqenv\(aq argument to this
function.
.IP \(bu 2
\fBprepend_path\fP (\fI\%str\fP) \-\-
.sp
$PATH segment to prepend (trailing \(aq:\(aq not
necessary) to $PATH
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBtemplate\fP (\fI\%str\fP) \-\- If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
.IP \(bu 2
\fBrstrip\fP (\fI\%bool\fP) \-\- Strip all whitespace off the end of output before it is
returned.
.IP \(bu 2
\fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command.
.IP \(bu 2
\fBoutput_encoding\fP (\fI\%str\fP) \-\-
.sp
Control the encoding used to decode the
command\(aqs output.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF\-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF\-8.
.sp
To see the encoding Salt has detected from the system locale, check
the \fIlocale\fP line in the output of \fI\%test.versions_report\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBoutput_loglevel\fP (\fI\%str\fP) \-\-
.sp
Control the loglevel at which the output from
the command is logged to the minion log.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBignore_retcode\fP (\fI\%bool\fP) \-\- If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to
skip logging the output if the command has a nonzero exit code.
.IP \(bu 2
\fBhide_output\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP, suppress stdout and stderr in the
return data.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This is separate from \fBoutput_loglevel\fP, which only handles how
Salt logs to the minion log.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- A timeout in seconds for the executed process to
return.
.IP \(bu 2
\fBuse_vt\fP (\fI\%bool\fP) \-\- Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
.IP \(bu 2
\fBsuccess_retcodes\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
non\-zero return codes that should be considered a success.  If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBsuccess_stdout\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBsuccess_stderr\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBstdin_raw_newlines\fP (\fI\%bool\fP) \-\- .INDENT 2.0
.TP
.B False
If \fBTrue\fP, Salt will not automatically convert the characters \fB\en\fP
present in the \fBstdin\fP value to newlines.
.UNINDENT
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run_stderr \(dqls \-l | awk \(aq/foo/{print \e$2}\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The template arg can be set to \(aqjinja\(aq or another supported template
engine to render the command arguments before execution.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run_stderr template=jinja \(dqls \-l /tmp/{{grains.id}} | awk \(aq/foo/{print \e$2}\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A string of standard input can be specified for the command to be run using
the \fBstdin\fP parameter. This can be useful in cases where sensitive
information must be read from standard input.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run_stderr \(dqgrep f\(dq stdin=\(aqone\entwo\enthree\enfour\enfive\en\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.run_stdout(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=None, use_vt=False, password=None, prepend_path=None, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
Execute a command, and only return the standard out
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcmd\fP (\fI\%str\fP) \-\- The command to run. ex: \fBls \-lart /home\fP
.IP \(bu 2
\fBcwd\fP (\fI\%str\fP) \-\- The directory from which to execute the command. Defaults
to the home directory of the user specified by \fBrunas\fP (or the user
under which Salt is running if \fBrunas\fP is not specified).
.IP \(bu 2
\fBstdin\fP (\fI\%str\fP) \-\- A string of standard input can be specified for the
command to be run using the \fBstdin\fP parameter. This can be useful in
cases where sensitive information must be read from standard input.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\-
.sp
Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the \fBpassword\fP argument, and
the target user account must be in the Administrators group.
.sp
\fBWARNING:\fP
.INDENT 2.0
.INDENT 3.5
For versions 2018.3.3 and above on macosx while using runas,
to pass special characters to the command you need to escape
the characters on the shell.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cmd.run_stdout \(aqecho \(aq\e\(aq\(aqh=\e\(dqbaz\e\(dq\(aq\e\(aq\(aq\(aq runas=macuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\-
.sp
Windows only. Required when specifying \fBrunas\fP\&. This
parameter will be ignored on non\-Windows platforms.
.sp
New in version 2016.3.0.


.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- Group to run command as. Not currently supported
on Windows.
.IP \(bu 2
\fBshell\fP (\fI\%str\fP) \-\- Specify an alternate shell. Defaults to the system\(aqs
default shell.
.IP \(bu 2
\fBpython_shell\fP (\fI\%bool\fP) \-\- If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
.IP \(bu 2
\fBenv\fP (\fI\%dict\fP) \-\-
.sp
Environment variables to be set prior to execution.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cmd.run_stdout \(aqsome command\(aq env=\(aq{\(dqFOO\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When using environment variables on Window\(aqs, case\-sensitivity
matters, i.e. Window\(aqs uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBclean_env\fP (\fI\%bool\fP) \-\- Attempt to clean out all other shell environment
variables and set only those provided in the \(aqenv\(aq argument to this
function.
.IP \(bu 2
\fBprepend_path\fP (\fI\%str\fP) \-\-
.sp
$PATH segment to prepend (trailing \(aq:\(aq not necessary)
to $PATH
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBtemplate\fP (\fI\%str\fP) \-\- If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
.IP \(bu 2
\fBrstrip\fP (\fI\%bool\fP) \-\- Strip all whitespace off the end of output before it is
returned.
.IP \(bu 2
\fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command.
.IP \(bu 2
\fBoutput_encoding\fP (\fI\%str\fP) \-\-
.sp
Control the encoding used to decode the
command\(aqs output.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF\-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF\-8.
.sp
To see the encoding Salt has detected from the system locale, check
the \fIlocale\fP line in the output of \fI\%test.versions_report\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBoutput_loglevel\fP (\fI\%str\fP) \-\-
.sp
Control the loglevel at which the output from
the command is logged to the minion log.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBignore_retcode\fP (\fI\%bool\fP) \-\- If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to
skip logging the output if the command has a nonzero exit code.
.IP \(bu 2
\fBhide_output\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP, suppress stdout and stderr in the
return data.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This is separate from \fBoutput_loglevel\fP, which only handles how
Salt logs to the minion log.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- A timeout in seconds for the executed process to
return.
.IP \(bu 2
\fBuse_vt\fP (\fI\%bool\fP) \-\- Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
.IP \(bu 2
\fBsuccess_retcodes\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
non\-zero return codes that should be considered a success.  If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBsuccess_stdout\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBsuccess_stderr\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBstdin_raw_newlines\fP (\fI\%bool\fP) \-\- .INDENT 2.0
.TP
.B False
If \fBTrue\fP, Salt will not automatically convert the characters \fB\en\fP
present in the \fBstdin\fP value to newlines.
.UNINDENT
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run_stdout \(dqls \-l | awk \(aq/foo/{print \e$2}\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The template arg can be set to \(aqjinja\(aq or another supported template
engine to render the command arguments before execution.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run_stdout template=jinja \(dqls \-l /tmp/{{grains.id}} | awk \(aq/foo/{print \e$2}\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A string of standard input can be specified for the command to be run using
the \fBstdin\fP parameter. This can be useful in cases where sensitive
information must be read from standard input.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run_stdout \(dqgrep f\(dq stdin=\(aqone\entwo\enthree\enfour\enfive\en\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.script(source, args=None, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, template=None, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, saltenv=None, use_vt=False, bg=False, password=None, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
Download a script from a remote location and execute the script locally.
The script can be located on the salt master file server or on an HTTP/FTP
server.
.sp
The script will be executed directly, so it can be written in any available
programming language.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- The location of the script to download. If the file is
located on the master in the directory named spam, and is called eggs,
the source string is salt://spam/eggs
.IP \(bu 2
\fBargs\fP (\fI\%str\fP) \-\-
.sp
String of command line args to pass to the script. Only
used if no args are specified as part of the \fIname\fP argument. To pass a
string containing spaces in YAML, you will need to doubly\-quote it:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cmd.script salt://foo.sh \(dqarg1 \(aqarg two\(aq arg3\(dq
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBcwd\fP (\fI\%str\fP) \-\- The directory from which to execute the command. Defaults
to the directory returned from Python\(aqs tempfile.mkstemp.
.IP \(bu 2
\fBstdin\fP (\fI\%str\fP) \-\- A string of standard input can be specified for the
command to be run using the \fBstdin\fP parameter. This can be useful in
cases where sensitive information must be read from standard input.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\-
.sp
Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the \fBpassword\fP argument, and
the target user account must be in the Administrators group.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
For Window\(aqs users, specifically Server users, it may be necessary
to specify your runas user using the User Logon Name instead of the
legacy logon name. Traditionally, logons would be in the following
format.
.INDENT 0.0
.INDENT 3.5
\fBDomain/user\fP
.UNINDENT
.UNINDENT
.sp
In the event this causes issues when executing scripts, use the UPN
format which looks like the following.
.INDENT 0.0
.INDENT 3.5
\fBuser@domain.local\fP
.UNINDENT
.UNINDENT
.sp
More information <\fI\%https://github.com/saltstack/salt/issues/55080\fP>
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\-
.sp
Windows only. Required when specifying \fBrunas\fP\&. This
parameter will be ignored on non\-Windows platforms.
.sp
New in version 2016.3.0.


.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- Group to run script as. Not currently supported
on Windows.
.IP \(bu 2
\fBshell\fP (\fI\%str\fP) \-\- Specify an alternate shell. Defaults to the system\(aqs
default shell.
.IP \(bu 2
\fBpython_shell\fP (\fI\%bool\fP) \-\- If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
.IP \(bu 2
\fBbg\fP (\fI\%bool\fP) \-\- If True, run script in background and do not await or
deliver its results
.IP \(bu 2
\fBenv\fP (\fI\%dict\fP) \-\-
.sp
Environment variables to be set prior to execution.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cmd.script \(aqsome command\(aq env=\(aq{\(dqFOO\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When using environment variables on Window\(aqs, case\-sensitivity
matters, i.e. Window\(aqs uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBtemplate\fP (\fI\%str\fP) \-\- If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
.IP \(bu 2
\fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command.
.IP \(bu 2
\fBoutput_encoding\fP (\fI\%str\fP) \-\-
.sp
Control the encoding used to decode the
command\(aqs output.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF\-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF\-8.
.sp
To see the encoding Salt has detected from the system locale, check
the \fIlocale\fP line in the output of \fI\%test.versions_report\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBoutput_loglevel\fP (\fI\%str\fP) \-\-
.sp
Control the loglevel at which the output from
the command is logged to the minion log.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBignore_retcode\fP (\fI\%bool\fP) \-\- If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to
skip logging the output if the command has a nonzero exit code.
.IP \(bu 2
\fBhide_output\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP, suppress stdout and stderr in the
return data.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This is separate from \fBoutput_loglevel\fP, which only handles how
Salt logs to the minion log.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- If the command has not terminated after timeout
seconds, send the subprocess sigterm, and if sigterm is ignored, follow
up with sigkill
.IP \(bu 2
\fBuse_vt\fP (\fI\%bool\fP) \-\- Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
.IP \(bu 2
\fBsuccess_retcodes\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
non\-zero return codes that should be considered a success.  If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBsuccess_stdout\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBsuccess_stderr\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBstdin_raw_newlines\fP (\fI\%bool\fP) \-\- .INDENT 2.0
.TP
.B False
If \fBTrue\fP, Salt will not automatically convert the characters \fB\en\fP
present in the \fBstdin\fP value to newlines.
.UNINDENT
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.script salt://scripts/runme.sh
salt \(aq*\(aq cmd.script salt://scripts/runme.sh \(aqarg1 arg2 \(dqarg 3\(dq\(aq
salt \(aq*\(aq cmd.script salt://scripts/windows_task.ps1 args=\(aq \-Input c:\etmp\einfile.txt\(aq shell=\(aqpowershell\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.script salt://scripts/runme.sh stdin=\(aqone\entwo\enthree\enfour\enfive\en\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.script_retcode(source, args=None, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, template=\(aqjinja\(aq, umask=None, timeout=None, reset_system_locale=True, saltenv=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, use_vt=False, password=None, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
Download a script from a remote location and execute the script locally.
The script can be located on the salt master file server or on an HTTP/FTP
server.
.sp
The script will be executed directly, so it can be written in any available
programming language.
.sp
The script can also be formatted as a template, the default is jinja.
.sp
Only evaluate the script return code and do not block for terminal output
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- The location of the script to download. If the file is
located on the master in the directory named spam, and is called eggs,
the source string is salt://spam/eggs
.IP \(bu 2
\fBargs\fP (\fI\%str\fP) \-\- String of command line args to pass to the script. Only
used if no args are specified as part of the \fIname\fP argument. To pass a
string containing spaces in YAML, you will need to doubly\-quote it:
\(dqarg1 \(aqarg two\(aq arg3\(dq
.IP \(bu 2
\fBcwd\fP (\fI\%str\fP) \-\- The directory from which to execute the command. Defaults
to the home directory of the user specified by \fBrunas\fP (or the user
under which Salt is running if \fBrunas\fP is not specified).
.IP \(bu 2
\fBstdin\fP (\fI\%str\fP) \-\- A string of standard input can be specified for the
command to be run using the \fBstdin\fP parameter. This can be useful in
cases where sensitive information must be read from standard input.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the \fBpassword\fP argument, and
the target user account must be in the Administrators group.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\-
.sp
Windows only. Required when specifying \fBrunas\fP\&. This
parameter will be ignored on non\-Windows platforms.
.sp
New in version 2016.3.0.


.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- Group to run script as. Not currently supported
on Windows.
.IP \(bu 2
\fBshell\fP (\fI\%str\fP) \-\- Specify an alternate shell. Defaults to the system\(aqs
default shell.
.IP \(bu 2
\fBpython_shell\fP (\fI\%bool\fP) \-\- If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
.IP \(bu 2
\fBenv\fP (\fI\%dict\fP) \-\-
.sp
Environment variables to be set prior to execution.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cmd.script_retcode \(aqsome command\(aq env=\(aq{\(dqFOO\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When using environment variables on Window\(aqs, case\-sensitivity
matters, i.e. Window\(aqs uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBtemplate\fP (\fI\%str\fP) \-\- If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
.IP \(bu 2
\fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command.
.IP \(bu 2
\fBoutput_encoding\fP (\fI\%str\fP) \-\-
.sp
Control the encoding used to decode the
command\(aqs output.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF\-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF\-8.
.sp
To see the encoding Salt has detected from the system locale, check
the \fIlocale\fP line in the output of \fI\%test.versions_report\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBoutput_loglevel\fP (\fI\%str\fP) \-\-
.sp
Control the loglevel at which the output from
the command is logged to the minion log.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBignore_retcode\fP (\fI\%bool\fP) \-\- If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to
skip logging the output if the command has a nonzero exit code.
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- If the command has not terminated after timeout
seconds, send the subprocess sigterm, and if sigterm is ignored, follow
up with sigkill
.IP \(bu 2
\fBuse_vt\fP (\fI\%bool\fP) \-\- Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
.IP \(bu 2
\fBsuccess_retcodes\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
non\-zero return codes that should be considered a success.  If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBsuccess_stdout\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBsuccess_stderr\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBstdin_raw_newlines\fP (\fI\%bool\fP) \-\- .INDENT 2.0
.TP
.B False
If \fBTrue\fP, Salt will not automatically convert the characters \fB\en\fP
present in the \fBstdin\fP value to newlines.
.UNINDENT
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.script_retcode salt://scripts/runme.sh
salt \(aq*\(aq cmd.script_retcode salt://scripts/runme.sh \(aqarg1 arg2 \(dqarg 3\(dq\(aq
salt \(aq*\(aq cmd.script_retcode salt://scripts/windows_task.ps1 args=\(aq \-Input c:\etmp\einfile.txt\(aq shell=\(aqpowershell\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A string of standard input can be specified for the command to be run using
the \fBstdin\fP parameter. This can be useful in cases where sensitive
information must be read from standard input.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.script_retcode salt://scripts/runme.sh stdin=\(aqone\entwo\enthree\enfour\enfive\en\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.shell(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=None, use_vt=False, bg=False, password=None, prepend_path=None, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
Execute the passed command and return the output as a string.
.sp
New in version 2015.5.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcmd\fP (\fI\%str\fP) \-\- The command to run. ex: \fBls \-lart /home\fP
.IP \(bu 2
\fBcwd\fP (\fI\%str\fP) \-\- The directory from which to execute the command. Defaults
to the home directory of the user specified by \fBrunas\fP (or the user
under which Salt is running if \fBrunas\fP is not specified).
.IP \(bu 2
\fBstdin\fP (\fI\%str\fP) \-\- A string of standard input can be specified for the
command to be run using the \fBstdin\fP parameter. This can be useful in
cases where sensitive information must be read from standard input.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\-
.sp
Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the \fBpassword\fP argument, and
the target user account must be in the Administrators group.
.sp
\fBWARNING:\fP
.INDENT 2.0
.INDENT 3.5
For versions 2018.3.3 and above on macosx while using runas,
to pass special characters to the command you need to escape
the characters on the shell.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cmd.shell \(aqecho \(aq\e\(aq\(aqh=\e\(dqbaz\e\(dq\(aq\e\(aq\(aq\(aq runas=macuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- Group to run command as. Not currently supported
on Windows.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\-
.sp
Windows only. Required when specifying \fBrunas\fP\&. This
parameter will be ignored on non\-Windows platforms.
.sp
New in version 2016.3.0.


.IP \(bu 2
\fBshell\fP (\fI\%int\fP) \-\- Shell to execute under. Defaults to the system default
shell.
.IP \(bu 2
\fBbg\fP (\fI\%bool\fP) \-\- If True, run command in background and do not await or
deliver its results
.IP \(bu 2
\fBenv\fP (\fI\%dict\fP) \-\-
.sp
Environment variables to be set prior to execution.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion cmd.shell \(aqsome command\(aq env=\(aq{\(dqFOO\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
When using environment variables on Window\(aqs, case\-sensitivity
matters, i.e. Window\(aqs uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBclean_env\fP (\fI\%bool\fP) \-\- Attempt to clean out all other shell environment
variables and set only those provided in the \(aqenv\(aq argument to this
function.
.IP \(bu 2
\fBprepend_path\fP (\fI\%str\fP) \-\-
.sp
$PATH segment to prepend (trailing \(aq:\(aq not necessary)
to $PATH
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBtemplate\fP (\fI\%str\fP) \-\- If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
.IP \(bu 2
\fBrstrip\fP (\fI\%bool\fP) \-\- Strip all whitespace off the end of output before it is
returned.
.IP \(bu 2
\fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command.
.IP \(bu 2
\fBoutput_encoding\fP (\fI\%str\fP) \-\-
.sp
Control the encoding used to decode the
command\(aqs output.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF\-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF\-8.
.sp
To see the encoding Salt has detected from the system locale, check
the \fIlocale\fP line in the output of \fI\%test.versions_report\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBoutput_loglevel\fP (\fI\%str\fP) \-\-
.sp
Control the loglevel at which the output from
the command is logged to the minion log.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBignore_retcode\fP (\fI\%bool\fP) \-\- If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to
skip logging the output if the command has a nonzero exit code.
.IP \(bu 2
\fBhide_output\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP, suppress stdout and stderr in the
return data.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This is separate from \fBoutput_loglevel\fP, which only handles how
Salt logs to the minion log.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- A timeout in seconds for the executed process to
return.
.IP \(bu 2
\fBuse_vt\fP (\fI\%bool\fP) \-\- Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This passes the cmd argument directly to the shell without any further
processing! Be absolutely sure that you have properly sanitized the
command passed to this function and do not use untrusted inputs.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsuccess_retcodes\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
non\-zero return codes that should be considered a success.  If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBsuccess_stdout\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBsuccess_stderr\fP (\fI\%list\fP) \-\- .INDENT 2.0
.TP
.B This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.sp
New in version 3004.


.IP \(bu 2
\fBstdin_raw_newlines\fP (\fI\%bool\fP) \-\- .INDENT 2.0
.TP
.B False
If \fBTrue\fP, Salt will not automatically convert the characters \fB\en\fP
present in the \fBstdin\fP value to newlines.
.UNINDENT
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.shell \(dqls \-l | awk \(aq/foo/{print \e$2}\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The template arg can be set to \(aqjinja\(aq or another supported template
engine to render the command arguments before execution.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.shell template=jinja \(dqls \-l /tmp/{{grains.id}} | awk \(aq/foo/{print \e$2}\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Specify an alternate shell with the shell parameter:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.shell \(dqGet\-ChildItem C:\e \(dq shell=\(aqpowershell\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A string of standard input can be specified for the command to be run using
the \fBstdin\fP parameter. This can be useful in cases where sensitive
information must be read from standard input.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.shell \(dqgrep f\(dq stdin=\(aqone\entwo\enthree\enfour\enfive\en\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If an equal sign (\fB=\fP) appears in an argument to a Salt command it is
interpreted as a keyword argument in the format \fBkey=val\fP\&. That
processing can be bypassed in order to pass an equal sign through to the
remote shell command by manually specifying the kwarg:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.shell cmd=\(aqsed \-e s/=/:/g\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.shell_info(shell, list_modules=False)
New in version 2016.11.0.

.sp
Provides information about a shell or script languages which often use
\fB#!\fP\&. The values returned are dependent on the shell or scripting
languages all return the \fBinstalled\fP, \fBpath\fP, \fBversion\fP,
\fBversion_raw\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBshell\fP (\fI\%str\fP) \-\- Name of the shell. Support shells/script languages include
.IP \(bu 2
\fBbash\fP \-\-
.IP \(bu 2
\fBcmd\fP \-\-
.IP \(bu 2
\fBperl\fP \-\-
.IP \(bu 2
\fBphp\fP \-\-
.IP \(bu 2
\fBpowershell\fP \-\-
.IP \(bu 2
\fBpython\fP \-\-
.IP \(bu 2
\fBzsh\fP (\fIruby and\fP) \-\-
.IP \(bu 2
\fBlist_modules\fP (\fI\%bool\fP) \-\- True to list modules available to the shell.
.IP \(bu 2
\fBmodules.\fP (\fICurrently only lists powershell\fP) \-\-
.UNINDENT
.TP
.B Returns
A dictionary of information about the shell
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqversion\(aq: \(aq<2 or 3 numeric components dot\-separated>\(aq,
 \(aqversion_raw\(aq: \(aq<full version string>\(aq,
 \(aqpath\(aq: \(aq<full path to binary>\(aq,
 \(aqinstalled\(aq: <True, False or None>,
 \(aq<attribute>\(aq: \(aq<attribute value>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBinstalled\fP is always returned, if \fBNone\fP or \fBFalse\fP also
returns error and may also return \fBstdout\fP for diagnostics.
.IP \(bu 2
\fBversion\fP is for use in determine if a shell/script language has a
particular feature set, not for package management.
.IP \(bu 2
The shell must be within the executable search path.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.shell_info bash
salt \(aq*\(aq cmd.shell_info powershell
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Codeauthor
Damon Atkins <\fI\%https://github.com/damon\-atkins\fP>
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.shells()
Lists the valid shells on this system via the /etc/shells file
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.shells
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.tty(device, echo=\(aq\(aq)
Echo a string to a specific tty
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.tty tty0 \(aqThis is a test\(aq
salt \(aq*\(aq cmd.tty pts3 \(aqThis is a test\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.which(cmd)
Returns the path of an executable available on the minion, None otherwise
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.which cat
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cmdmod.which_bin(cmds)
Returns the first command found in a list of commands
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.which_bin \(aq[pip2, pip, pip\-python]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.composer
.sp
Use composer to install PHP dependencies for a directory
.INDENT 0.0
.TP
.B salt.modules.composer.did_composer_install(dir)
Test to see if the vendor directory exists in this directory
.INDENT 7.0
.TP
.B dir
Directory location of the composer.json file
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq composer.did_composer_install /var/www/application
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.composer.install(directory, composer=None, php=None, runas=None, prefer_source=None, prefer_dist=None, no_scripts=None, no_plugins=None, optimize=None, no_dev=None, quiet=False, composer_home=\(aq/root\(aq, env=None)
Install composer dependencies for a directory.
.sp
If composer has not been installed globally making it available in the
system PATH & making it executable, the \fBcomposer\fP and \fBphp\fP parameters
will need to be set to the location of the executables.
.INDENT 7.0
.TP
.B directory
Directory location of the composer.json file.
.TP
.B composer
Location of the composer.phar file. If not set composer will
just execute \(dqcomposer\(dq as if it is installed globally.
(i.e. /path/to/composer.phar)
.TP
.B php
Location of the php executable to use with composer.
(i.e. /usr/bin/php)
.TP
.B runas
Which system user to run composer as.
.TP
.B prefer_source
\-\-prefer\-source option of composer.
.TP
.B prefer_dist
\-\-prefer\-dist option of composer.
.TP
.B no_scripts
\-\-no\-scripts option of composer.
.TP
.B no_plugins
\-\-no\-plugins option of composer.
.TP
.B optimize
\-\-optimize\-autoloader option of composer. Recommended for production.
.TP
.B no_dev
\-\-no\-dev option for composer. Recommended for production.
.TP
.B quiet
\-\-quiet option for composer. Whether or not to return output from composer.
.TP
.B composer_home
$COMPOSER_HOME environment variable
.TP
.B env
A list of environment variables to be set prior to execution.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq composer.install /var/www/application

salt \(aq*\(aq composer.install /var/www/application             no_dev=True optimize=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.composer.selfupdate(composer=None, php=None, runas=None, quiet=False, composer_home=\(aq/root\(aq)
Update composer itself.
.sp
If composer has not been installed globally making it available in the
system PATH & making it executable, the \fBcomposer\fP and \fBphp\fP parameters
will need to be set to the location of the executables.
.INDENT 7.0
.TP
.B composer
Location of the composer.phar file. If not set composer will
just execute \(dqcomposer\(dq as if it is installed globally.
(i.e. /path/to/composer.phar)
.TP
.B php
Location of the php executable to use with composer.
(i.e. /usr/bin/php)
.TP
.B runas
Which system user to run composer as.
.TP
.B quiet
\-\-quiet option for composer. Whether or not to return output from composer.
.TP
.B composer_home
$COMPOSER_HOME environment variable
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq composer.selfupdate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.composer.update(directory, composer=None, php=None, runas=None, prefer_source=None, prefer_dist=None, no_scripts=None, no_plugins=None, optimize=None, no_dev=None, quiet=False, composer_home=\(aq/root\(aq, env=None)
Update composer dependencies for a directory.
.sp
If \fIcomposer install\fP has not yet been run, this runs \fIcomposer install\fP
instead.
.sp
If composer has not been installed globally making it available in the
system PATH & making it executable, the \fBcomposer\fP and \fBphp\fP parameters
will need to be set to the location of the executables.
.INDENT 7.0
.TP
.B directory
Directory location of the composer.json file.
.TP
.B composer
Location of the composer.phar file. If not set composer will
just execute \(dqcomposer\(dq as if it is installed globally.
(i.e. /path/to/composer.phar)
.TP
.B php
Location of the php executable to use with composer.
(i.e. /usr/bin/php)
.TP
.B runas
Which system user to run composer as.
.TP
.B prefer_source
\-\-prefer\-source option of composer.
.TP
.B prefer_dist
\-\-prefer\-dist option of composer.
.TP
.B no_scripts
\-\-no\-scripts option of composer.
.TP
.B no_plugins
\-\-no\-plugins option of composer.
.TP
.B optimize
\-\-optimize\-autoloader option of composer. Recommended for production.
.TP
.B no_dev
\-\-no\-dev option for composer. Recommended for production.
.TP
.B quiet
\-\-quiet option for composer. Whether or not to return output from composer.
.TP
.B composer_home
$COMPOSER_HOME environment variable
.TP
.B env
A list of environment variables to be set prior to execution.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq composer.update /var/www/application

salt \(aq*\(aq composer.update /var/www/application             no_dev=True optimize=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.config
.sp
Return config information
.INDENT 0.0
.TP
.B salt.modules.config.backup_mode(backup=\(aq\(aq)
Return the backup mode
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq config.backup_mode
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.config.dot_vals(value)
Pass in a configuration value that should be preceded by the module name
and a dot, this will return a list of all read key/value pairs
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq config.dot_vals host
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.config.gather_bootstrap_script(bootstrap=None)
Download the salt\-bootstrap script, and return its location
.INDENT 7.0
.TP
.B bootstrap
URL of alternate bootstrap script
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq config.gather_bootstrap_script
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.config.get(key, default=\(aq\(aq, delimiter=\(aq:\(aq, merge=None, omit_opts=False, omit_pillar=False, omit_master=False, omit_grains=False)
New in version 0.14.0.

.sp
Attempt to retrieve the named value from the minion config file, pillar,
grains or the master config. If the named value is not available, return
the value specified by the \fBdefault\fP argument. If this argument is not
specified, \fBdefault\fP falls back to an empty string.
.sp
Values can also be retrieved from nested dictionaries. Assume the below
data structure:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqpkg\(aq: {\(aqapache\(aq: \(aqhttpd\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To retrieve the value associated with the \fBapache\fP key, in the
sub\-dictionary corresponding to the \fBpkg\fP key, the following command can
be used:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion config.get pkg:apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fB:\fP (colon) is used to represent a nested dictionary level.
.sp
Changed in version 2015.5.0: The \fBdelimiter\fP argument was added, to allow delimiters other than
\fB:\fP to be used.

.sp
This function traverses these data stores in this order, returning the
first match found:
.INDENT 7.0
.IP \(bu 2
Minion configuration
.IP \(bu 2
Minion\(aqs grains
.IP \(bu 2
Minion\(aqs pillar data
.IP \(bu 2
Master configuration (requires \fBpillar_opts\fP to be set to
\fBTrue\fP in Minion config file in order to work)
.UNINDENT
.sp
This means that if there is a value that is going to be the same for the
majority of minions, it can be configured in the Master config file, and
then overridden using the grains, pillar, or Minion config file.
.sp
Adding config options to the Master or Minion configuration file is easy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my\-config\-option: value
cafe\-menu:
  \- egg and bacon
  \- egg sausage and bacon
  \- egg and spam
  \- egg bacon and spam
  \- egg bacon sausage and spam
  \- spam bacon sausage and spam
  \- spam egg spam spam bacon and spam
  \- spam sausage spam spam bacon spam tomato and spam
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Minion configuration options built into Salt (like those defined
\fI\%here\fP) will \fIalways\fP be defined in
the Minion configuration and thus \fIcannot be overridden by grains or
pillar data\fP\&. However, additional (user\-defined) configuration options
(as in the above example) will not be in the Minion configuration by
default and thus can be overridden using grains/pillar data by leaving
the option out of the minion config file.
.UNINDENT
.UNINDENT
.sp
\fBArguments\fP
.INDENT 7.0
.TP
.B delimiter
New in version 2015.5.0.

.sp
Override the delimiter used to separate nested levels of a data
structure.
.TP
.B merge
New in version 2015.5.0.

.sp
If passed, this parameter will change the behavior of the function so
that, instead of traversing each data store above in order and
returning the first match, the data stores are first merged together
and then searched. The pillar data is merged into the master config
data, then the grains are merged, followed by the Minion config data.
The resulting data structure is then searched for a match. This allows
for configurations to be more flexible.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The merging described above does not mean that grain data will end
up in the Minion\(aqs pillar data, or pillar data will end up in the
master config data, etc. The data is just combined for the purposes
of searching an amalgam of the different data stores.
.UNINDENT
.UNINDENT
.sp
The supported merge strategies are as follows:
.INDENT 7.0
.IP \(bu 2
\fBrecurse\fP \- If a key exists in both dictionaries, and the new value
is not a dictionary, it is replaced. Otherwise, the sub\-dictionaries
are merged together into a single dictionary, recursively on down,
following the same criteria. For example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
>>> dict1 = {\(aqfoo\(aq: {\(aqbar\(aq: 1, \(aqqux\(aq: True},
             \(aqhosts\(aq: [\(aqa\(aq, \(aqb\(aq, \(aqc\(aq],
             \(aqonly_x\(aq: None}
>>> dict2 = {\(aqfoo\(aq: {\(aqbaz\(aq: 2, \(aqqux\(aq: False},
             \(aqhosts\(aq: [\(aqd\(aq, \(aqe\(aq, \(aqf\(aq],
             \(aqonly_y\(aq: None}
>>> merged
{\(aqfoo\(aq: {\(aqbar\(aq: 1, \(aqbaz\(aq: 2, \(aqqux\(aq: False},
 \(aqhosts\(aq: [\(aqd\(aq, \(aqe\(aq, \(aqf\(aq],
 \(aqonly_dict1\(aq: None,
 \(aqonly_dict2\(aq: None}
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBoverwrite\fP \- If a key exists in the top level of both
dictionaries, the new value completely overwrites the old. For
example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
>>> dict1 = {\(aqfoo\(aq: {\(aqbar\(aq: 1, \(aqqux\(aq: True},
             \(aqhosts\(aq: [\(aqa\(aq, \(aqb\(aq, \(aqc\(aq],
             \(aqonly_x\(aq: None}
>>> dict2 = {\(aqfoo\(aq: {\(aqbaz\(aq: 2, \(aqqux\(aq: False},
             \(aqhosts\(aq: [\(aqd\(aq, \(aqe\(aq, \(aqf\(aq],
             \(aqonly_y\(aq: None}
>>> merged
{\(aqfoo\(aq: {\(aqbaz\(aq: 2, \(aqqux\(aq: False},
 \(aqhosts\(aq: [\(aqd\(aq, \(aqe\(aq, \(aqf\(aq],
 \(aqonly_dict1\(aq: None,
 \(aqonly_dict2\(aq: None}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq config.get pkg:apache
salt \(aq*\(aq config.get lxc.container_profile:centos merge=recurse
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.config.items()
Return the complete config from the currently running minion process.
This includes defaults for values not set in the config file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq config.items
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.config.manage_mode(mode)
Return a mode value, normalized to a string
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq config.manage_mode
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.config.merge(value, default=\(aq\(aq, omit_opts=False, omit_master=False, omit_pillar=False)
Retrieves an option based on key, merging all matches.
.sp
Same as \fBoption()\fP except that it merges all matches, rather than taking
the first match.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq config.merge schedule
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.config.option(value, default=None, omit_opts=False, omit_grains=False, omit_pillar=False, omit_master=False, omit_all=False, wildcard=False)
Returns the setting for the specified config value. The priority for
matches is the same as in \fI\%config.get\fP,
only this function does not recurse into nested data structures. Another
difference between this function and \fI\%config.get\fP is that it comes with a set of \(dqsane defaults\(dq.
To view these, you can run the following command:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq config.option \(aq*\(aq omit_all=True wildcard=True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B default
The default value if no match is found. If not specified, then the
fallback default will be an empty string, unless \fBwildcard=True\fP, in
which case the return will be an empty dictionary.
.TP
.B omit_opts
False
Pass as \fBTrue\fP to exclude matches from the minion configuration file
.TP
.B omit_grains
False
Pass as \fBTrue\fP to exclude matches from the grains
.TP
.B omit_pillar
False
Pass as \fBTrue\fP to exclude matches from the pillar data
.TP
.B omit_master
False
Pass as \fBTrue\fP to exclude matches from the master configuration file
.TP
.B omit_all
True
Shorthand to omit all of the above and return matches only from the
\(dqsane defaults\(dq.
.sp
New in version 3000.

.TP
.B wildcard
False
If used, this will perform pattern matching on keys. Note that this
will also significantly change the return data. Instead of only a value
being returned, a dictionary mapping the matched keys to their values
is returned. For example, using \fBwildcard=True\fP with a \fBkey\fP of
\fB\(aqfoo.ba*\fP could return a dictionary like so:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqfoo.bar\(aq: True, \(aqfoo.baz\(aq: False}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq config.option redis.host
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.config.valid_fileproto(uri)
Returns a boolean value based on whether or not the URI passed has a valid
remote file protocol designation
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq config.valid_fileproto salt://path/to/file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.consul
.sp
Interact with Consul
.sp
\fI\%https://www.consul.io\fP
.INDENT 0.0
.TP
.B salt.modules.consul.acl_clone(consul_url=None, token=None, **kwargs)
Information about an ACL token.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBid\fP \-\- Unique identifier for the ACL to update.
.UNINDENT
.TP
.B Returns
Boolean, message of success or
failure, and new ID of cloned ACL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.acl_info id=\(aqc1c4d223\-91cb\-3d1f\-1ee8\-f2af9e7b6716\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.acl_create(consul_url=None, token=None, **kwargs)
Create a new ACL token.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBname\fP \-\- Meaningful indicator of the ACL\(aqs purpose.
.IP \(bu 2
\fBtype\fP \-\- Type is either client or management. A management
token is comparable to a root user and has the
ability to perform any action including creating,
modifying, and deleting ACLs.
.IP \(bu 2
\fBrules\fP \-\- The Consul server URL.
.UNINDENT
.TP
.B Returns
Boolean & message of success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.acl_create
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.acl_delete(consul_url=None, token=None, **kwargs)
Delete an ACL token.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBid\fP \-\- Unique identifier for the ACL to update.
.UNINDENT
.TP
.B Returns
Boolean & message of success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.acl_delete id=\(aqc1c4d223\-91cb\-3d1f\-1ee8\-f2af9e7b6716\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.acl_info(consul_url=None, **kwargs)
Information about an ACL token.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBid\fP \-\- Unique identifier for the ACL to update.
.UNINDENT
.TP
.B Returns
Information about the ACL requested.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.acl_info id=\(aqc1c4d223\-91cb\-3d1f\-1ee8\-f2af9e7b6716\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.acl_list(consul_url=None, token=None, **kwargs)
List the ACL tokens.
.INDENT 7.0
.TP
.B Parameters
\fBconsul_url\fP \-\- The Consul server URL.
.TP
.B Returns
List of ACLs
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.acl_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.acl_update(consul_url=None, token=None, **kwargs)
Update an ACL token.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBname\fP \-\- Meaningful indicator of the ACL\(aqs purpose.
.IP \(bu 2
\fBid\fP \-\- Unique identifier for the ACL to update.
.IP \(bu 2
\fBtype\fP \-\- Type is either client or management. A management
token is comparable to a root user and has the
ability to perform any action including creating,
modifying, and deleting ACLs.
.IP \(bu 2
\fBrules\fP \-\- The Consul server URL.
.UNINDENT
.TP
.B Returns
Boolean & message of success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.acl_update
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.agent_check_deregister(consul_url=None, token=None, checkid=None)
The agent will take care of deregistering the check from the Catalog.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBcheckid\fP \-\- The ID of the check to deregister from Consul.
.UNINDENT
.TP
.B Returns
Boolean and message indicating success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.agent_check_deregister checkid=\(aqMemory Utilization\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.agent_check_fail(consul_url=None, token=None, checkid=None, **kwargs)
This endpoint is used with a check that is of the TTL type. When this
is called, the status of the check is set to critical and the
TTL clock is reset.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBcheckid\fP \-\- The ID of the check to deregister from Consul.
.IP \(bu 2
\fBnote\fP \-\- A human\-readable message with the status of the check.
.UNINDENT
.TP
.B Returns
Boolean and message indicating success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.agent_check_fail checkid=\(aqredis_check1\(aq note=\(aqForcing check into critical state.\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.agent_check_pass(consul_url=None, token=None, checkid=None, **kwargs)
This endpoint is used with a check that is of the TTL type. When this
is called, the status of the check is set to passing and the TTL
clock is reset.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBcheckid\fP \-\- The ID of the check to mark as passing.
.IP \(bu 2
\fBnote\fP \-\- A human\-readable message with the status of the check.
.UNINDENT
.TP
.B Returns
Boolean and message indicating success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.agent_check_pass checkid=\(aqredis_check1\(aq note=\(aqForcing check into passing state.\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.agent_check_register(consul_url=None, token=None, **kwargs)
The register endpoint is used to add a new check to the local agent.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBname\fP \-\- The description of what the check is for.
.IP \(bu 2
\fBid\fP \-\- The unique name to use for the check, if not
provided \(aqname\(aq is used.
.IP \(bu 2
\fBnotes\fP \-\- Human readable description of the check.
.IP \(bu 2
\fBscript\fP \-\- If script is provided, the check type is
a script, and Consul will evaluate that script
based on the interval parameter.
.IP \(bu 2
\fBhttp\fP \-\- Check will perform an HTTP GET request against
the value of HTTP (expected to be a URL) based
on the interval parameter.
.IP \(bu 2
\fBttl\fP \-\- If a TTL type is used, then the TTL update endpoint
must be used periodically to update the state of the check.
.IP \(bu 2
\fBinterval\fP \-\- Interval at which the check should run.
.UNINDENT
.TP
.B Returns
Boolean and message indicating success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.agent_check_register name=\(aqMemory Utilization\(aq script=\(aq/usr/local/bin/check_mem.py\(aq interval=\(aq15s\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.agent_check_warn(consul_url=None, token=None, checkid=None, **kwargs)
This endpoint is used with a check that is of the TTL type. When this
is called, the status of the check is set to warning and the TTL
clock is reset.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBcheckid\fP \-\- The ID of the check to deregister from Consul.
.IP \(bu 2
\fBnote\fP \-\- A human\-readable message with the status of the check.
.UNINDENT
.TP
.B Returns
Boolean and message indicating success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.agent_check_warn checkid=\(aqredis_check1\(aq note=\(aqForcing check into warning state.\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.agent_checks(consul_url=None, token=None)
Returns the checks the local agent is managing
.INDENT 7.0
.TP
.B Parameters
\fBconsul_url\fP \-\- The Consul server URL.
.TP
.B Returns
Returns the checks the local agent is managing
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.agent_checks
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.agent_join(consul_url=None, token=None, address=None, **kwargs)
Triggers the local agent to join a node
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBaddress\fP \-\- The address for the agent to connect to.
.IP \(bu 2
\fBwan\fP \-\- Causes the agent to attempt to join using the WAN pool.
.UNINDENT
.TP
.B Returns
Boolean and message indicating success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.agent_join address=\(aq192.168.1.1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.agent_leave(consul_url=None, token=None, node=None)
Used to instruct the agent to force a node into the left state.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBnode\fP \-\- The node the agent will force into left state
.UNINDENT
.TP
.B Returns
Boolean and message indicating success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.agent_leave node=\(aqweb1.example.com\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.agent_maintenance(consul_url=None, token=None, **kwargs)
Manages node maintenance mode
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBenable\fP \-\- The enable flag is required.
Acceptable values are either true
(to enter maintenance mode) or
false (to resume normal operation).
.IP \(bu 2
\fBreason\fP \-\- If provided, its value should be a
text string explaining the reason for
placing the node into maintenance mode.
.UNINDENT
.TP
.B Returns
Boolean and message indicating success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.agent_maintenance enable=\(aqFalse\(aq reason=\(aqUpgrade in progress\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.agent_members(consul_url=None, token=None, **kwargs)
Returns the members as seen by the local serf agent
.INDENT 7.0
.TP
.B Parameters
\fBconsul_url\fP \-\- The Consul server URL.
.TP
.B Returns
Returns the members as seen by the local serf agent
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.agent_members
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.agent_self(consul_url=None, token=None)
Returns the local node configuration
.INDENT 7.0
.TP
.B Parameters
\fBconsul_url\fP \-\- The Consul server URL.
.TP
.B Returns
Returns the local node configuration
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.agent_self
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.agent_service_deregister(consul_url=None, token=None, serviceid=None)
Used to remove a service.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBserviceid\fP \-\- A serviceid describing the service.
.UNINDENT
.TP
.B Returns
Boolean and message indicating success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.agent_service_deregister serviceid=\(aqredis\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.agent_service_maintenance(consul_url=None, token=None, serviceid=None, **kwargs)
Used to place a service into maintenance mode.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBserviceid\fP \-\- A name of the service.
.IP \(bu 2
\fBenable\fP \-\- Whether the service should be enabled or disabled.
.IP \(bu 2
\fBreason\fP \-\- A human readable message of why the service was
enabled or disabled.
.UNINDENT
.TP
.B Returns
Boolean and message indicating success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.agent_service_deregister serviceid=\(aqredis\(aq enable=\(aqTrue\(aq reason=\(aqDown for upgrade\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.agent_service_register(consul_url=None, token=None, **kwargs)
The used to add a new service, with an optional
health check, to the local agent.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBname\fP \-\- A name describing the service.
.IP \(bu 2
\fBaddress\fP \-\- The address used by the service, defaults
to the address of the agent.
.IP \(bu 2
\fBport\fP \-\- The port used by the service.
.IP \(bu 2
\fBid\fP \-\- Unique ID to identify the service, if not
provided the value of the name parameter is used.
.IP \(bu 2
\fBtags\fP \-\- Identifying tags for service, string or list.
.IP \(bu 2
\fBscript\fP \-\- If script is provided, the check type is
a script, and Consul will evaluate that script
based on the interval parameter.
.IP \(bu 2
\fBhttp\fP \-\- Check will perform an HTTP GET request against
the value of HTTP (expected to be a URL) based
on the interval parameter.
.IP \(bu 2
\fBcheck_ttl\fP \-\- If a TTL type is used, then the TTL update
endpoint must be used periodically to update
the state of the check.
.IP \(bu 2
\fBcheck_interval\fP \-\- Interval at which the check should run.
.UNINDENT
.TP
.B Returns
Boolean and message indicating success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.agent_service_register name=\(aqredis\(aq tags=\(aq[\(dqmaster\(dq, \(dqv1\(dq]\(aq address=\(dq127.0.0.1\(dq port=\(dq8080\(dq check_script=\(dq/usr/local/bin/check_redis.py\(dq interval=\(dq10s\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.agent_services(consul_url=None, token=None)
Returns the services the local agent is managing
.INDENT 7.0
.TP
.B Parameters
\fBconsul_url\fP \-\- The Consul server URL.
.TP
.B Returns
Returns the services the local agent is managing
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.agent_services
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.catalog_datacenters(consul_url=None, token=None)
Return list of available datacenters from catalog.
.INDENT 7.0
.TP
.B Parameters
\fBconsul_url\fP \-\- The Consul server URL.
.TP
.B Returns
The list of available datacenters.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.catalog_datacenters
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.catalog_deregister(consul_url=None, token=None, **kwargs)
Deregisters a node, service, or check
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBnode\fP \-\- The node to deregister.
.IP \(bu 2
\fBdatacenter\fP \-\- By default, the datacenter of the agent is queried;
however, the dc can be provided using the \(dqdc\(dq parameter.
.IP \(bu 2
\fBcheckid\fP \-\- The ID of the health check to deregister.
.IP \(bu 2
\fBserviceid\fP \-\- The ID of the service to deregister.
.UNINDENT
.TP
.B Returns
Boolean & message of success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.catalog_register node=\(aqnode1\(aq serviceid=\(aqredis_server1\(aq checkid=\(aqredis_check1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.catalog_node(consul_url=None, token=None, node=None, **kwargs)
Information about the registered node.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBnode\fP \-\- The node to request information about.
.IP \(bu 2
\fBdc\fP \-\- By default, the datacenter of the agent is queried;
however, the dc can be provided using the \(dqdc\(dq parameter.
.UNINDENT
.TP
.B Returns
Information about the requested node.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.catalog_service service=\(aqredis\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.catalog_nodes(consul_url=None, token=None, **kwargs)
Return list of available nodes from catalog.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBdc\fP \-\- By default, the datacenter of the agent is queried;
however, the dc can be provided using the \(dqdc\(dq parameter.
.UNINDENT
.TP
.B Returns
The list of available nodes.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.catalog_nodes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.catalog_register(consul_url=None, token=None, **kwargs)
Registers a new node, service, or check
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBdc\fP \-\- By default, the datacenter of the agent is queried;
however, the dc can be provided using the \(dqdc\(dq parameter.
.IP \(bu 2
\fBnode\fP \-\- The node to register.
.IP \(bu 2
\fBaddress\fP \-\- The address of the node.
.IP \(bu 2
\fBservice\fP \-\- The service that will be registered.
.IP \(bu 2
\fBservice_address\fP \-\- The address that the service listens on.
.IP \(bu 2
\fBservice_port\fP \-\- The port for the service.
.IP \(bu 2
\fBservice_id\fP \-\- A unique identifier for the service, if this is not
provided \(dqname\(dq will be used.
.IP \(bu 2
\fBservice_tags\fP \-\- Any tags associated with the service.
.IP \(bu 2
\fBcheck\fP \-\- The name of the health check to register
.IP \(bu 2
\fBcheck_status\fP \-\- The initial status of the check,
must be one of unknown, passing, warning, or critical.
.IP \(bu 2
\fBcheck_service\fP \-\- The service that the check is performed against.
.IP \(bu 2
\fBcheck_id\fP \-\- Unique identifier for the service.
.IP \(bu 2
\fBcheck_notes\fP \-\- An opaque field that is meant to hold human\-readable text.
.UNINDENT
.TP
.B Returns
Boolean & message of success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.catalog_register node=\(aqnode1\(aq address=\(aq192.168.1.1\(aq service=\(aqredis\(aq service_address=\(aq127.0.0.1\(aq service_port=\(aq8080\(aq service_id=\(aqredis_server1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.catalog_service(consul_url=None, token=None, service=None, **kwargs)
Information about the registered service.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBdc\fP \-\- By default, the datacenter of the agent is queried;
however, the dc can be provided using the \(dqdc\(dq parameter.
.IP \(bu 2
\fBtag\fP \-\- Filter returned services with tag parameter.
.UNINDENT
.TP
.B Returns
Information about the requested service.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.catalog_service service=\(aqredis\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.catalog_services(consul_url=None, token=None, **kwargs)
Return list of available services rom catalog.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBdc\fP \-\- By default, the datacenter of the agent is queried;
however, the dc can be provided using the \(dqdc\(dq parameter.
.UNINDENT
.TP
.B Returns
The list of available services.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.catalog_services
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.delete(consul_url=None, token=None, key=None, **kwargs)
Delete values from Consul
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBkey\fP \-\- The key to use as the starting point for the list.
.IP \(bu 2
\fBrecurse\fP \-\- Delete values recursively beginning at the value of key.
.IP \(bu 2
\fBcas\fP \-\- This flag is used to turn the DELETE into
a Check\-And\-Set operation.
.UNINDENT
.TP
.B Returns
Boolean & message of success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.delete key=\(aqweb\(aq
salt \(aq*\(aq consul.delete key=\(aqweb\(aq recurse=\(aqTrue\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.event_fire(consul_url=None, token=None, name=None, **kwargs)
List the ACL tokens.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBname\fP \-\- The name of the event to fire.
.IP \(bu 2
\fBdc\fP \-\- By default, the datacenter of the agent is queried;
however, the dc can be provided using the \(dqdc\(dq parameter.
.IP \(bu 2
\fBnode\fP \-\- Filter by node name.
.IP \(bu 2
\fBservice\fP \-\- Filter by service name.
.IP \(bu 2
\fBtag\fP \-\- Filter by tag name.
.UNINDENT
.TP
.B Returns
List of ACLs
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.event_fire name=\(aqdeploy\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.event_list(consul_url=None, token=None, **kwargs)
List the recent events.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBname\fP \-\- The name of the event to fire.
.UNINDENT
.TP
.B Returns
List of ACLs
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.event_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.get(consul_url=None, key=None, token=None, recurse=False, decode=False, raw=False)
Get key from Consul
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBkey\fP \-\- The key to use as the starting point for the list.
.IP \(bu 2
\fBrecurse\fP \-\- Return values recursively beginning at the value of key.
.IP \(bu 2
\fBdecode\fP \-\- By default values are stored as Base64 encoded values,
decode will return the whole key with the value decoded.
.IP \(bu 2
\fBraw\fP \-\- Simply return the decoded value of the key.
.UNINDENT
.TP
.B Returns
The keys in Consul.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.get key=\(aqweb/key1\(aq
salt \(aq*\(aq consul.get key=\(aqweb\(aq recurse=True
salt \(aq*\(aq consul.get key=\(aqweb\(aq recurse=True decode=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default values stored in Consul are base64 encoded, passing the
decode option will show them as the decoded values.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.get key=\(aqweb\(aq recurse=True decode=True raw=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default Consult will return other information about the key, the raw
option will return only the raw value.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.health_checks(consul_url=None, token=None, service=None, **kwargs)
Health information about the registered service.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBservice\fP \-\- The service to request health information about.
.IP \(bu 2
\fBdc\fP \-\- By default, the datacenter of the agent is queried;
however, the dc can be provided using the \(dqdc\(dq parameter.
.UNINDENT
.TP
.B Returns
Health information about the requested node.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.health_checks service=\(aqredis1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.health_node(consul_url=None, token=None, node=None, **kwargs)
Health information about the registered node.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBnode\fP \-\- The node to request health information about.
.IP \(bu 2
\fBdc\fP \-\- By default, the datacenter of the agent is queried;
however, the dc can be provided using the \(dqdc\(dq parameter.
.UNINDENT
.TP
.B Returns
Health information about the requested node.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.health_node node=\(aqnode1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.health_service(consul_url=None, token=None, service=None, **kwargs)
Health information about the registered service.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBservice\fP \-\- The service to request health information about.
.IP \(bu 2
\fBdc\fP \-\- By default, the datacenter of the agent is queried;
however, the dc can be provided using the \(dqdc\(dq parameter.
.IP \(bu 2
\fBtag\fP \-\- Filter returned services with tag parameter.
.IP \(bu 2
\fBpassing\fP \-\- Filter results to only nodes with all
checks in the passing state.
.UNINDENT
.TP
.B Returns
Health information about the requested node.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.health_service service=\(aqredis1\(aq

salt \(aq*\(aq consul.health_service service=\(aqredis1\(aq passing=\(aqTrue\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.health_state(consul_url=None, token=None, state=None, **kwargs)
Returns the checks in the state provided on the path.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBstate\fP \-\- The state to show checks for. The supported states
are any, unknown, passing, warning, or critical.
The any state is a wildcard that can be used to
return all checks.
.IP \(bu 2
\fBdc\fP \-\- By default, the datacenter of the agent is queried;
however, the dc can be provided using the \(dqdc\(dq parameter.
.UNINDENT
.TP
.B Returns
The checks in the provided state.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.health_state state=\(aqredis1\(aq

salt \(aq*\(aq consul.health_state service=\(aqredis1\(aq passing=\(aqTrue\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.list_(consul_url=None, token=None, key=None, **kwargs)
List keys in Consul
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBkey\fP \-\- The key to use as the starting point for the list.
.UNINDENT
.TP
.B Returns
The list of keys.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.list
salt \(aq*\(aq consul.list key=\(aqweb\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.put(consul_url=None, token=None, key=None, value=None, **kwargs)
Put values into Consul
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBkey\fP \-\- The key to use as the starting point for the list.
.IP \(bu 2
\fBvalue\fP \-\- The value to set the key to.
.IP \(bu 2
\fBflags\fP \-\- This can be used to specify an unsigned value
between 0 and 2^64\-1. Clients can choose to use
this however makes sense for their application.
.IP \(bu 2
\fBcas\fP \-\- This flag is used to turn the PUT into a
Check\-And\-Set operation.
.IP \(bu 2
\fBacquire\fP \-\- This flag is used to turn the PUT into a
lock acquisition operation.
.IP \(bu 2
\fBrelease\fP \-\- This flag is used to turn the PUT into a
lock release operation.
.UNINDENT
.TP
.B Returns
Boolean & message of success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.put key=\(aqweb/key1\(aq value=\(dqHello there\(dq

salt \(aq*\(aq consul.put key=\(aqweb/key1\(aq value=\(dqHello there\(dq acquire=\(aqd5d371f4\-c380\-5280\-12fd\-8810be175592\(aq

salt \(aq*\(aq consul.put key=\(aqweb/key1\(aq value=\(dqHello there\(dq release=\(aqd5d371f4\-c380\-5280\-12fd\-8810be175592\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.session_create(consul_url=None, token=None, **kwargs)
Used to create a session.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBlockdelay\fP \-\- Duration string using a \(dqs\(dq suffix for seconds.
The default is 15s.
.IP \(bu 2
\fBnode\fP \-\- Must refer to a node that is already registered,
if specified. By default, the agent\(aqs own node
name is used.
.IP \(bu 2
\fBname\fP \-\- A human\-readable name for the session
.IP \(bu 2
\fBchecks\fP \-\- A list of associated health checks. It is highly
recommended that, if you override this list, you
include the default \(dqserfHealth\(dq.
.IP \(bu 2
\fBbehavior\fP \-\- Can be set to either release or delete. This controls
the behavior when a session is invalidated. By default,
this is release, causing any locks that are held to be
released. Changing this to delete causes any locks that
are held to be deleted. delete is useful for creating
ephemeral key/value entries.
.IP \(bu 2
\fBttl\fP \-\- Session is invalidated if it is not renewed before
the TTL expires
.UNINDENT
.TP
.B Returns
Boolean and message indicating success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.session_create node=\(aqnode1\(aq name=\(aqmy\-session\(aq behavior=\(aqdelete\(aq ttl=\(aq3600s\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.session_destroy(consul_url=None, token=None, session=None, **kwargs)
Destroy session
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBsession\fP \-\- The ID of the session to destroy.
.IP \(bu 2
\fBdc\fP \-\- By default, the datacenter of the agent is queried;
however, the dc can be provided using the \(dqdc\(dq parameter.
.UNINDENT
.TP
.B Returns
Boolean & message of success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.session_destroy session=\(aqc1c4d223\-91cb\-3d1f\-1ee8\-f2af9e7b6716\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.session_info(consul_url=None, token=None, session=None, **kwargs)
Information about a session
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBsession\fP \-\- The ID of the session to return information about.
.IP \(bu 2
\fBdc\fP \-\- By default, the datacenter of the agent is queried;
however, the dc can be provided using the \(dqdc\(dq parameter.
.UNINDENT
.TP
.B Returns
Boolean & message of success or failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.session_info session=\(aqc1c4d223\-91cb\-3d1f\-1ee8\-f2af9e7b6716\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.session_list(consul_url=None, token=None, return_list=False, **kwargs)
Used to list sessions.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsul_url\fP \-\- The Consul server URL.
.IP \(bu 2
\fBdc\fP \-\- By default, the datacenter of the agent is queried;
however, the dc can be provided using the \(dqdc\(dq parameter.
.IP \(bu 2
\fBreturn_list\fP \-\- By default, all information about the sessions is
returned, using the return_list parameter will return
a list of session IDs.
.UNINDENT
.TP
.B Returns
A list of all available sessions.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.session_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.status_leader(consul_url=None, token=None)
Returns the current Raft leader
.INDENT 7.0
.TP
.B Parameters
\fBconsul_url\fP \-\- The Consul server URL.
.TP
.B Returns
The address of the Raft leader.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.status_leader
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.consul.status_peers(consul_url, token=None)
Returns the current Raft peer set
.INDENT 7.0
.TP
.B Parameters
\fBconsul_url\fP \-\- The Consul server URL.
.TP
.B Returns
Retrieves the Raft peers for the
datacenter in which the agent is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq consul.status_peers
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.container_resource
.sp
Common resources for LXC and systemd\-nspawn containers
.sp
New in version 2015.8.0.

.sp
These functions are not designed to be called directly, but instead from the
\fI\%lxc\fP, \fI\%nspawn\fP, and
\fBdocker\fP execution modules. They provide for
common logic to be re\-used for common actions.
.INDENT 0.0
.TP
.B salt.modules.container_resource.cache_file(source)
Wrapper for cp.cache_file which raises an error if the file was unable to
be cached.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion container_resource.cache_file salt://foo/bar/baz.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.container_resource.copy_to(name, source, dest, container_type=None, path=None, exec_driver=None, overwrite=False, makedirs=False)
Common logic for copying files to containers
.INDENT 7.0
.TP
.B path
path to the container parent (for LXC only)
default: /var/lib/lxc (system default)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion container_resource.copy_to mycontainer /local/file/path /container/file/path container_type=docker exec_driver=nsenter
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.container_resource.run(name, cmd, container_type=None, exec_driver=None, output=None, no_start=False, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, ignore_retcode=False, path=None, use_vt=False, keep_env=None)
Common logic for running shell commands in containers
.INDENT 7.0
.TP
.B path
path to the container parent (for LXC only)
default: /var/lib/lxc (system default)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion container_resource.run mycontainer \(aqps aux\(aq container_type=docker exec_driver=nsenter output=stdout
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.cp
.sp
Minion side functions for salt\-cp
.INDENT 0.0
.TP
.B salt.modules.cp.cache_dest(url, saltenv=None)
New in version 3000.

.sp
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
Returns the expected cache path for the file, if cached using
\fI\%cp.cache_file\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This only returns the _expected_ path, it does not tell you if the URL
is really cached. To check if the URL is cached, use
\fI\%cp.is_cached\fP instead.
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.cache_dest https://foo.com/bar.rpm
salt \(aq*\(aq cp.cache_dest salt://my/file
salt \(aq*\(aq cp.cache_dest salt://my/file saltenv=dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.cache_dir(path, saltenv=None, include_empty=False, include_pat=None, exclude_pat=None)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
Download and cache everything under a directory from the master
.INDENT 7.0
.TP
.B include_pat
None
Glob or regex to narrow down the files cached from the given path. If
matching with a regex, the regex must be prefixed with \fBE@\fP,
otherwise the expression will be interpreted as a glob.
.sp
New in version 2014.7.0.

.TP
.B exclude_pat
None
Glob or regex to exclude certain files from being cached from the given
path. If matching with a regex, the regex must be prefixed with \fBE@\fP,
otherwise the expression will be interpreted as a glob.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If used with \fBinclude_pat\fP, files matching this pattern will be
excluded from the subset of files defined by \fBinclude_pat\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2014.7.0.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.cache_dir salt://path/to/dir
salt \(aq*\(aq cp.cache_dir salt://path/to/dir include_pat=\(aqE@*.py$\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.cache_file(path, saltenv=None, source_hash=None, verify_ssl=True, use_etag=False)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
Used to cache a single file on the Minion
.sp
Returns the location of the new cached file on the Minion
.INDENT 7.0
.TP
.B source_hash
If \fBname\fP is an http(s) or ftp URL and the file exists in the
minion\(aqs file cache, this option can be passed to keep the minion from
re\-downloading the file if the cached copy matches the specified hash.
.sp
New in version 2018.3.0.

.TP
.B verify_ssl
If \fBFalse\fP, remote https file sources (\fBhttps://\fP) and source_hash
will not attempt to validate the servers certificate. Default is True.
.sp
New in version 3002.

.TP
.B use_etag
If \fBTrue\fP, remote http/https file sources will attempt to use the
ETag header to determine if the remote file needs to be downloaded.
This provides a lightweight mechanism for promptly refreshing files
changed on a web server without requiring a full hash comparison via
the \fBsource_hash\fP parameter.
.sp
New in version 3005.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.cache_file salt://path/to/file
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There are two ways of defining the fileserver environment (a.k.a.
\fBsaltenv\fP) from which to cache the file. One is to use the \fBsaltenv\fP
parameter, and the other is to use a querystring syntax in the \fBsalt://\fP
URL. The below two examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.cache_file salt://foo/bar.conf saltenv=config
salt \(aq*\(aq cp.cache_file salt://foo/bar.conf?saltenv=config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the path being cached is a \fBsalt://\fP URI, and the path does not exist,
then \fBFalse\fP will be returned.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
It may be necessary to quote the URL when using the querystring method,
depending on the shell being used to run the command.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.cache_file_ssh(path, saltenv=None, source_hash=None, verify_ssl=True, use_etag=False)
This function is an alias of \fBcache_file\fP\&.
.INDENT 7.0
.INDENT 3.5
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
Used to cache a single file on the Minion
.sp
Returns the location of the new cached file on the Minion
.INDENT 0.0
.TP
.B source_hash
If \fBname\fP is an http(s) or ftp URL and the file exists in the
minion\(aqs file cache, this option can be passed to keep the minion from
re\-downloading the file if the cached copy matches the specified hash.
.sp
New in version 2018.3.0.

.TP
.B verify_ssl
If \fBFalse\fP, remote https file sources (\fBhttps://\fP) and source_hash
will not attempt to validate the servers certificate. Default is True.
.sp
New in version 3002.

.TP
.B use_etag
If \fBTrue\fP, remote http/https file sources will attempt to use the
ETag header to determine if the remote file needs to be downloaded.
This provides a lightweight mechanism for promptly refreshing files
changed on a web server without requiring a full hash comparison via
the \fBsource_hash\fP parameter.
.sp
New in version 3005.

.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.cache_file salt://path/to/file
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There are two ways of defining the fileserver environment (a.k.a.
\fBsaltenv\fP) from which to cache the file. One is to use the \fBsaltenv\fP
parameter, and the other is to use a querystring syntax in the \fBsalt://\fP
URL. The below two examples are equivalent:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.cache_file salt://foo/bar.conf saltenv=config
salt \(aq*\(aq cp.cache_file salt://foo/bar.conf?saltenv=config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the path being cached is a \fBsalt://\fP URI, and the path does not exist,
then \fBFalse\fP will be returned.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
It may be necessary to quote the URL when using the querystring method,
depending on the shell being used to run the command.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.cache_files(paths, saltenv=None)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
Used to gather many files from the Master, the gathered files will be
saved in the minion cachedir reflective to the paths retrieved from the
Master
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.cache_files salt://pathto/file1,salt://pathto/file1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There are two ways of defining the fileserver environment (a.k.a.
\fBsaltenv\fP) from which to cache the files. One is to use the \fBsaltenv\fP
parameter, and the other is to use a querystring syntax in the \fBsalt://\fP
URL. The below two examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.cache_files salt://foo/bar.conf,salt://foo/baz.conf saltenv=config
salt \(aq*\(aq cp.cache_files salt://foo/bar.conf?saltenv=config,salt://foo/baz.conf?saltenv=config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The querystring method is less useful when all files are being cached from
the same environment, but is a good way of caching files from multiple
different environments in the same command. For example, the below command
will cache the first file from the \fBconfig1\fP environment, and the second
one from the \fBconfig2\fP environment.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.cache_files salt://foo/bar.conf?saltenv=config1,salt://foo/bar.conf?saltenv=config2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
It may be necessary to quote the URL when using the querystring method,
depending on the shell being used to run the command.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.cache_local_file(path)
Cache a local file on the minion in the localfiles cache
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.cache_local_file /etc/hosts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.cache_master(saltenv=None)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
Retrieve all of the files on the master and cache them locally
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.cache_master
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.envs()
List available environments for fileserver
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.envs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.get_dir(path, dest, saltenv=None, template=None, gzip=None, **kwargs)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
Used to recursively copy a directory from the salt master
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.get_dir salt://path/to/dir/ /minion/dest
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
get_dir supports the same template and gzip arguments as get_file.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.get_file(path, dest, saltenv=None, makedirs=False, template=None, gzip=None, **kwargs)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
Changed in version 2018.3.0: \fBdest\fP can now be a directory

.sp
Used to get a single file from the salt master
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.get_file salt://path/to/file /minion/dest
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Template rendering can be enabled on both the source and destination file
names like so:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.get_file \(dqsalt://{{grains.os}}/vimrc\(dq /etc/vimrc template=jinja
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example would instruct all Salt minions to download the vimrc from a
directory with the same name as their os grain and copy it to /etc/vimrc
.sp
For larger files, the cp.get_file module also supports gzip compression.
Because gzip is CPU\-intensive, this should only be used in scenarios where
the compression ratio is very high (e.g. pretty\-printed JSON or YAML
files).
.sp
Use the \fIgzip\fP named argument to enable it.  Valid values are 1..9, where 1
is the lightest compression and 9 the heaviest.  1 uses the least CPU on
the master (and minion), 9 uses the most.
.sp
There are two ways of defining the fileserver environment (a.k.a.
\fBsaltenv\fP) from which to retrieve the file. One is to use the \fBsaltenv\fP
parameter, and the other is to use a querystring syntax in the \fBsalt://\fP
URL. The below two examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.get_file salt://foo/bar.conf /etc/foo/bar.conf saltenv=config
salt \(aq*\(aq cp.get_file salt://foo/bar.conf?saltenv=config /etc/foo/bar.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
It may be necessary to quote the URL when using the querystring method,
depending on the shell being used to run the command.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.get_file_str(path, saltenv=None)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
Download a file from a URL to the Minion cache directory and return the
contents of that file
.sp
Returns \fBFalse\fP if Salt was unable to cache a file from a URL.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.get_file_str salt://my/file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.get_template(path, dest, template=\(aqjinja\(aq, saltenv=None, makedirs=False, **kwargs)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
Render a file as a template before setting it down.
Warning, order is not the same as in fileclient.cp for
non breaking old API.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.get_template salt://path/to/template /minion/dest
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.get_url(path, dest=\(aq\(aq, saltenv=None, makedirs=False, source_hash=None)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
Changed in version 2018.3.0: \fBdest\fP can now be a directory

.sp
Used to get a single file from a URL.
.INDENT 7.0
.TP
.B path
A URL to download a file from. Supported URL schemes are: \fBsalt://\fP,
\fBhttp://\fP, \fBhttps://\fP, \fBftp://\fP, \fBs3://\fP, \fBswift://\fP and
\fBfile://\fP (local filesystem). If no scheme was specified, this is
equivalent of using \fBfile://\fP\&.
If a \fBfile://\fP URL is given, the function just returns absolute path
to that file on a local filesystem.
The function returns \fBFalse\fP if Salt was unable to fetch a file from
a \fBsalt://\fP URL.
.TP
.B dest
The default behaviour is to write the fetched file to the given
destination path. If this parameter is omitted or set as empty string
(\fB\(aq\(aq\fP), the function places the remote file on the local filesystem
inside the Minion cache directory and returns the path to that file.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To simply return the file contents instead, set destination to
\fBNone\fP\&. This works with \fBsalt://\fP, \fBhttp://\fP, \fBhttps://\fP
and \fBfile://\fP URLs. The files fetched by \fBhttp://\fP and
\fBhttps://\fP will not be cached.
.UNINDENT
.UNINDENT
.TP
.B saltenv
Salt fileserver environment from which to retrieve the file. Ignored if
\fBpath\fP is not a \fBsalt://\fP URL.
.TP
.B source_hash
If \fBpath\fP is an http(s) or ftp URL and the file exists in the
minion\(aqs file cache, this option can be passed to keep the minion from
re\-downloading the file if the cached copy matches the specified hash.
.sp
New in version 2018.3.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.get_url salt://my/file /tmp/this_file_is_mine
salt \(aq*\(aq cp.get_url http://www.slashdot.org /tmp/index.html
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.hash_file(path, saltenv=None)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
Return the hash of a file, to get the hash of a file on the
salt master file server prepend the path with salt://<file on server>
otherwise, prepend the file with / for a local file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.hash_file salt://path/to/file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.hash_file_ssh(path, saltenv=None)
This function is an alias of \fBhash_file\fP\&.
.INDENT 7.0
.INDENT 3.5
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
Return the hash of a file, to get the hash of a file on the
salt master file server prepend the path with salt://<file on server>
otherwise, prepend the file with / for a local file.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.hash_file salt://path/to/file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.is_cached(path, saltenv=None)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
Returns the full path to a file if it is cached locally on the minion
otherwise returns a blank string
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.is_cached salt://path/to/file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.list_master(saltenv=None, prefix=\(aq\(aq)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
List all of the files stored on the master
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.list_master
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.list_master_dirs(saltenv=None, prefix=\(aq\(aq)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
List all of the directories stored on the master
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.list_master_dirs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.list_master_symlinks(saltenv=None, prefix=\(aq\(aq)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
List all of the symlinks stored on the master
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.list_master_symlinks
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.list_minion(saltenv=None)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
List all of the files cached on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.list_minion
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.list_states(saltenv=None)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
List all of the available state files in an environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.list_states
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.push(path, keep_symlinks=False, upload_path=None, remove_source=False)
WARNING Files pushed to the master will have global read permissions..
.sp
Push a file from the minion up to the master, the file will be saved to
the salt master in the master\(aqs minion files cachedir
(defaults to \fB/var/cache/salt/master/minions/minion\-id/files\fP)
.sp
Since this feature allows a minion to push a file up to the master server
it is disabled by default for security purposes. To enable, set
\fBfile_recv\fP to \fBTrue\fP in the master configuration file, and restart the
master.
.INDENT 7.0
.TP
.B keep_symlinks
Keep the path value without resolving its canonical form
.TP
.B upload_path
Provide a different path inside the master\(aqs minion files cachedir
.TP
.B remove_source
Remove the source file on the minion
.sp
New in version 2016.3.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.push /etc/fstab
salt \(aq*\(aq cp.push /etc/system\-release keep_symlinks=True
salt \(aq*\(aq cp.push /etc/fstab upload_path=\(aq/new/path/fstab\(aq
salt \(aq*\(aq cp.push /tmp/filename remove_source=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.push_dir(path, glob=None, upload_path=None)
Push a directory from the minion up to the master, the files will be saved
to the salt master in the master\(aqs minion files cachedir (defaults to
\fB/var/cache/salt/master/minions/minion\-id/files\fP).  It also has a glob
for matching specific files using globbing.
.sp
New in version 2014.7.0.

.sp
Since this feature allows a minion to push files up to the master server it
is disabled by default for security purposes. To enable, set \fBfile_recv\fP
to \fBTrue\fP in the master configuration file, and restart the master.
.INDENT 7.0
.TP
.B upload_path
Provide a different path and directory name inside the master\(aqs minion
files cachedir
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.push /usr/lib/mysql
salt \(aq*\(aq cp.push /usr/lib/mysql upload_path=\(aq/newmysql/path\(aq
salt \(aq*\(aq cp.push_dir /etc/modprobe.d/ glob=\(aq*.conf\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.recv(files, dest)
Used with salt\-cp, pass the files dict, and the destination.
.sp
This function receives small fast copy files from the master via salt\-cp.
It does not work via the CLI.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.recv
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.recv_chunked(dest, chunk, append=False, compressed=True, mode=None)
This function receives files copied to the minion using \fBsalt\-cp\fP and is
not intended to be used directly on the CLI.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.recv_chunked
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cp.stat_file(path, saltenv=None, octal=True)
Changed in version 3005: \fBsaltenv\fP will use value from config if not explicitly set

.sp
Return the permissions of a file, to get the permissions of a file on the
salt master file server prepend the path with salt://<file on server>
otherwise, prepend the file with / for a local file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.stat_file salt://path/to/file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.cpan
.sp
Manage Perl modules using CPAN
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B salt.modules.cpan.install(module)
Install a Perl module from CPAN
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cpan.install Template::Alloy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cpan.list_()
List installed Perl modules, and the version installed
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cpan.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cpan.remove(module, details=False)
Attempt to remove a Perl module that was installed from CPAN. Because the
\fBcpan\fP command doesn\(aqt actually support \(dquninstall\(dq\-like functionality,
this function will attempt to do what it can, with what it has from CPAN.
.sp
Until this function is declared stable, USE AT YOUR OWN RISK!
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cpan.remove Old::Package
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cpan.show(module)
Show information about a specific Perl module
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cpan.show Template::Alloy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cpan.show_config()
Return a dict of CPAN configuration values
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cpan.show_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.cron
.sp
Work with cron
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Salt does not escape cron metacharacters automatically. You should
backslash\-escape percent characters and any other metacharacters that might
be interpreted incorrectly by the shell.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cron.get_entry(user, identifier=None, cmd=None)
Return the specified entry from user\(aqs crontab.
identifier will be used if specified, otherwise will lookup cmd
Either identifier or cmd should be specified.
.INDENT 7.0
.TP
.B user:
User\(aqs crontab to query
.TP
.B identifier:
Search for line with identifier
.TP
.B cmd:
Search for cron line with cmd
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cron.get_entry root identifier=task1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cron.list_tab(user)
Return the contents of the specified user\(aqs crontab
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cron.list_tab root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cron.ls(user)
This function is an alias of \fBlist_tab\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the contents of the specified user\(aqs crontab
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cron.list_tab root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cron.raw_cron(user)
Return the contents of the user\(aqs crontab
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cron.raw_cron root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cron.rm(user, cmd, minute=None, hour=None, daymonth=None, month=None, dayweek=None, identifier=None)
This function is an alias of \fBrm_job\fP\&.
.INDENT 7.0
.INDENT 3.5
Remove a cron job for a specified user. If any of the day/time params are
specified, the job will only be removed if the specified params match.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cron.rm_job root /usr/local/weekly
salt \(aq*\(aq cron.rm_job root /usr/bin/foo dayweek=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cron.rm_env(user, name)
Remove cron environment variable for a specified user.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cron.rm_env root MAILTO
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cron.rm_job(user, cmd, minute=None, hour=None, daymonth=None, month=None, dayweek=None, identifier=None)
Remove a cron job for a specified user. If any of the day/time params are
specified, the job will only be removed if the specified params match.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cron.rm_job root /usr/local/weekly
salt \(aq*\(aq cron.rm_job root /usr/bin/foo dayweek=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cron.rm_special(user, cmd, special=None, identifier=None)
Remove a special cron job for a specified user.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cron.rm_special root /usr/bin/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cron.set_env(user, name, value=None)
Set up an environment variable in the crontab.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cron.set_env root MAILTO user@example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cron.set_job(user, minute, hour, daymonth, month, dayweek, cmd, commented=False, comment=None, identifier=None)
Sets a cron job up for a specified user.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cron.set_job root \(aq*\(aq \(aq*\(aq \(aq*\(aq \(aq*\(aq 1 /usr/local/weekly
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cron.set_special(user, special, cmd, commented=False, comment=None, identifier=None)
Set up a special command in the crontab.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cron.set_special root @hourly \(aqecho foobar\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cron.write_cron_file(user, path)
Writes the contents of a file to a user\(aqs crontab
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cron.write_cron_file root /tmp/new_cron
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.9.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Some OS\(aq do not support specifying user via the \fIcrontab\fP command i.e. (Solaris, AIX)
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cron.write_cron_file_verbose(user, path)
Writes the contents of a file to a user\(aqs crontab and return error message on error
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cron.write_cron_file_verbose root /tmp/new_cron
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.9.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Some OS\(aq do not support specifying user via the \fIcrontab\fP command i.e. (Solaris, AIX)
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.cryptdev
.sp
Salt module to manage Unix cryptsetup jobs and the crypttab file
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B salt.modules.cryptdev.active()
List existing device\-mapper device details.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cryptdev.close(name)
Close a crypt device using \fBcryptsetup\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cryptdev.close foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cryptdev.crypttab(config=\(aq/etc/crypttab\(aq)
List the contents of the crypttab
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cryptdev.crypttab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cryptdev.open(name, device, keyfile)
Open a crypt device using \fBcryptsetup\fP\&. The \fBkeyfile\fP must not be
\fBNone\fP or \fB\(aqnone\(aq\fP, because \fBcryptsetup\fP will otherwise ask for the
password interactively.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cryptdev.open foo /dev/sdz1 /path/to/keyfile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cryptdev.rm_crypttab(name, config=\(aq/etc/crypttab\(aq)
Remove the named mapping from the crypttab. If the described entry does not
exist, nothing is changed, but the command succeeds by returning
\fB\(aqabsent\(aq\fP\&. If a line is removed, it returns \fB\(aqchange\(aq\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cryptdev.rm_crypttab foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cryptdev.set_crypttab(name, device, password=\(aqnone\(aq, options=\(aq\(aq, config=\(aq/etc/crypttab\(aq, test=False, match_on=\(aqname\(aq)
Verify that this device is represented in the crypttab, change the device to
match the name passed, or add the name if it is not present.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cryptdev.set_crypttab foo /dev/sdz1 mypassword swap,size=256
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.csf
.SS Support for Config Server Firewall (CSF)
.INDENT 0.0
.TP
.B maintainer
Mostafa Hussein <\fI\%mostafa.hussein91@gmail.com\fP>
.TP
.B maturity
new
.TP
.B platform
Linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.allow(ip, port=None, proto=\(aqtcp\(aq, direction=\(aqin\(aq, port_origin=\(aqd\(aq, ip_origin=\(aqs\(aq, ttl=None, comment=\(aq\(aq)
Add an rule to csf allowed hosts
See \fB_access_rule()\fP\&.
1\- Add an IP:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq csf.allow 127.0.0.1
salt \(aq*\(aq csf.allow 127.0.0.1 comment=\(dqAllow localhost\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.allow_port(port, proto=\(aqtcp\(aq, direction=\(aqboth\(aq)
Like allow_ports, but it will append to the
existing entry instead of replacing it.
Takes a single port instead of a list of ports.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq csf.allow_port 22 proto=\(aqtcp\(aq direction=\(aqin\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.allow_ports(ports, proto=\(aqtcp\(aq, direction=\(aqin\(aq)
Fully replace the incoming or outgoing ports
line in the csf.conf file \- e.g. TCP_IN, TCP_OUT,
UDP_IN, UDP_OUT, etc.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq csf.allow_ports ports=\(dq[22,80,443,4505,4506]\(dq proto=\(aqtcp\(aq direction=\(aqin\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.build_directions(direction)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.deny(ip, port=None, proto=\(aqtcp\(aq, direction=\(aqin\(aq, port_origin=\(aqd\(aq, ip_origin=\(aqd\(aq, ttl=None, comment=\(aq\(aq)
Add an rule to csf denied hosts
See \fB_access_rule()\fP\&.
1\- Deny an IP:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq csf.deny 127.0.0.1
salt \(aq*\(aq csf.deny 127.0.0.1 comment=\(dqToo localhosty\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.disable()
Disable csf permanently
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq csf.disable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.disable_testing_mode()
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.enable()
Activate csf if not running
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq csf.enable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.enable_testing_mode()
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.exists(method, ip, port=None, proto=\(aqtcp\(aq, direction=\(aqin\(aq, port_origin=\(aqd\(aq, ip_origin=\(aqd\(aq, ttl=None, comment=\(aq\(aq)
Returns true a rule for the ip already exists
based on the method supplied. Returns false if
not found.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq csf.exists allow 1.2.3.4
salt \(aq*\(aq csf.exists tempdeny 1.2.3.4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.get_option(option)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.get_ports(proto=\(aqtcp\(aq, direction=\(aqin\(aq)
Lists ports from csf.conf based on direction and protocol.
e.g. \- TCP_IN, TCP_OUT, UDP_IN, UDP_OUT, etc..
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq csf.allow_port 22 proto=\(aqtcp\(aq direction=\(aqin\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.get_skipped_nics(ipv6=False)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.get_testing_status()
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.reload()
Restart csf
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq csf.reload
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.remove_rule(method, ip, port=None, proto=\(aqtcp\(aq, direction=\(aqin\(aq, port_origin=\(aqd\(aq, ip_origin=\(aqs\(aq, ttl=None, comment=\(aq\(aq)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.remove_temp_rule(ip)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.running()
Check csf status
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq csf.running
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.set_option(option, value)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.skip_nic(nic, ipv6=False)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.skip_nics(nics, ipv6=False)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.split_option(option)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.tempallow(ip=None, ttl=None, port=None, direction=None, comment=\(aq\(aq)
Add an rule to the temporary ip allow list.
See \fB_access_rule()\fP\&.
1\- Add an IP:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq csf.tempallow 127.0.0.1 3600 port=22 direction=\(aqin\(aq comment=\(aq# Temp dev ssh access\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.tempdeny(ip=None, ttl=None, port=None, direction=None, comment=\(aq\(aq)
Add a rule to the temporary ip deny list.
See \fB_access_rule()\fP\&.
1\- Add an IP:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq csf.tempdeny 127.0.0.1 300 port=22 direction=\(aqin\(aq comment=\(aq# Brute force attempt\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.unallow(ip)
Remove a rule from the csf denied hosts
See \fB_access_rule()\fP\&.
1\- Deny an IP:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq csf.unallow 127.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.csf.undeny(ip)
Remove a rule from the csf denied hosts
See \fB_access_rule()\fP\&.
1\- Deny an IP:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq csf.undeny 127.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.cyg
.sp
Manage cygwin packages.
.sp
Module file to accompany the cyg state.
.INDENT 0.0
.TP
.B salt.modules.cyg.check_valid_package(package, cyg_arch=\(aqx86_64\(aq, mirrors=None)
Check if the package is valid on the given mirrors.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpackage\fP \-\- The name of the package
.IP \(bu 2
\fBcyg_arch\fP \-\- The cygwin architecture
.IP \(bu 2
\fBmirrors\fP \-\- any mirrors to check
.UNINDENT
.UNINDENT
.sp
Returns (bool): True if Valid, otherwise False
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cyg.check_valid_package <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cyg.install(packages=None, cyg_arch=\(aqx86_64\(aq, mirrors=None)
Install one or several packages.
.INDENT 7.0
.TP
.B packages
None
The packages to install
.TP
.B cyg_arch
x86_64
Specify the architecture to install the package under
Current options are x86 and x86_64
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cyg.install dos2unix
salt \(aq*\(aq cyg.install dos2unix mirrors=\(dq[{\(aqhttp://mirror\(aq: \(aqhttp://url/to/public/key}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cyg.list_(package=\(aq\(aq, cyg_arch=\(aqx86_64\(aq)
List locally installed packages.
.INDENT 7.0
.TP
.B package
\(aq\(aq
package name to check. else all
.TP
.B cyg_arch :
Cygwin architecture to use
Options are x86 and x86_64
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cyg.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cyg.uninstall(packages, cyg_arch=\(aqx86_64\(aq, mirrors=None)
Uninstall one or several packages.
.INDENT 7.0
.TP
.B packages
The packages to uninstall.
.TP
.B cyg_arch
x86_64
Specify the architecture to remove the package from
Current options are x86 and x86_64
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cyg.uninstall dos2unix
salt \(aq*\(aq cyg.uninstall dos2unix mirrors=\(dq[{\(aqhttp://mirror\(aq: \(aqhttp://url/to/public/key}]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.cyg.update(cyg_arch=\(aqx86_64\(aq, mirrors=None)
Update all packages.
.INDENT 7.0
.TP
.B cyg_arch
x86_64
Specify the cygwin architecture update
Current options are x86 and x86_64
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cyg.update
salt \(aq*\(aq cyg.update dos2unix mirrors=\(dq[{\(aqhttp://mirror\(aq: \(aqhttp://url/to/public/key}]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.daemontools
.sp
daemontools service module. This module will create daemontools type
service watcher.
.sp
This module is compatible with the \fI\%service\fP states,
so it can be used to maintain services using the \fBprovider\fP argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myservice:
  service.running:
    \- provider: daemontools
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.daemontools.available(name)
Returns \fBTrue\fP if the specified service is available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq daemontools.available foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.daemontools.disabled(name)
Return True if the named service is enabled, false otherwise
.sp
New in version 2015.5.6.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq daemontools.disabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.daemontools.enabled(name, **kwargs)
Return True if the named service is enabled, false otherwise
A service is considered enabled if in your service directory:
\- an executable ./run file exist
\- a file named \(dqdown\(dq does not exist
.sp
New in version 2015.5.7.

.INDENT 7.0
.TP
.B name
Service name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq daemontools.enabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.daemontools.full_restart(name)
Calls daemontools.restart() function
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq daemontools.full_restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.daemontools.get_all()
Return a list of all available services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq daemontools.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.daemontools.missing(name)
The inverse of daemontools.available.
Returns \fBTrue\fP if the specified service is not available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq daemontools.missing foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.daemontools.reload_(name)
Wrapper for term()
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq daemontools.reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.daemontools.restart(name)
Restart service via daemontools. This will stop/start service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq daemontools.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.daemontools.start(name)
Starts service via daemontools
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq daemontools.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.daemontools.status(name, sig=None)
Return the status for a service via daemontools, return pid if running
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq daemontools.status <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.daemontools.stop(name)
Stops service via daemontools
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq daemontools.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.daemontools.term(name)
Send a TERM to service via daemontools
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq daemontools.term <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.data
.sp
Manage a local persistent data structure that can hold any arbitrary data
specific to the minion
.INDENT 0.0
.TP
.B salt.modules.data.cas(key, value, old_value)
Check and set a value in the minion datastore
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq data.cas <key> <value> <old_value>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.data.clear()
Clear out all of the data in the minion datastore, this function is
destructive!
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq data.clear
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.data.dump(new_data)
Replace the entire datastore with a passed data structure
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq data.dump \(aq{\(aqeggs\(aq: \(aqspam\(aq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.data.get(key, default=None)
Get a (list of) value(s) from the minion datastore
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq data.get key
salt \(aq*\(aq data.get \(aq[\(dqkey1\(dq, \(dqkey2\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.data.has_key(key)
Check if key is in the minion datastore
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq data.has_key <mykey>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.data.items()
Get items from the minion datastore
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq data.items
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.data.keys()
Get all keys from the minion datastore
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq data.keys
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.data.load()
Return all of the data in the minion datastore
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq data.load
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.data.pop(key, default=None)
Pop (return & delete) a value from the minion datastore
.sp
New in version 2015.5.2.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq data.pop <key> \(dqthere was no val\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.data.update(key, value)
Update a key with a value in the minion datastore
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq data.update <key> <value>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.data.values()
Get values from the minion datastore
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq data.values
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.datadog_api
.sp
An execution module that interacts with the Datadog API
.INDENT 0.0
.TP
.B depends
\fI\%datadog\fP Python module
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The following parameters are required for all functions:
.INDENT 0.0
.TP
.B api_key
The datadog API key
.TP
.B app_key
The datadog application key
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full argument reference is available on the Datadog API reference page
\fI\%https://docs.datadoghq.com/api/\fP
.INDENT 0.0
.TP
.B salt.modules.datadog_api.cancel_downtime(api_key=None, app_key=None, scope=None, id=None)
Cancel a downtime by id or by scope.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call datadog.cancel_downtime scope=\(aqhost:app01\(aq \e
                                  api_key=\(aq0123456789\(aq \e
                                  app_key=\(aq9876543210\(aq\(ga
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Arguments \- Either scope or id is required.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBid\fP \-\- The downtime ID
.IP \(bu 2
\fBscope\fP \-\- The downtime scope
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.datadog_api.post_event(api_key=None, app_key=None, title=None, text=None, date_happened=None, priority=None, host=None, tags=None, alert_type=None, aggregation_key=None, source_type_name=None)
Post an event to the Datadog stream.
.sp
CLI Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call datadog.post_event api_key=\(aq0123456789\(aq \e
                             app_key=\(aq9876543210\(aq \e
                             title=\(aqSalt Highstate\(aq \e
                             text=\(dqSalt highstate was run on $(salt\-call grains.get id)\(dq \e
                             tags=\(aq[\(dqservice:salt\(dq, \(dqevent:highstate\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required arguments
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtitle\fP \-\- The event title. Limited to 100 characters.
.IP \(bu 2
\fBtext\fP \-\- The body of the event. Limited to 4000 characters. The text
supports markdown.
.UNINDENT
.UNINDENT
.sp
Optional arguments
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdate_happened\fP \-\- POSIX timestamp of the event.
.IP \(bu 2
\fBpriority\fP \-\- The priority of the event (\(aqnormal\(aq or \(aqlow\(aq).
.IP \(bu 2
\fBhost\fP \-\- Host name to associate with the event.
.IP \(bu 2
\fBtags\fP \-\- A list of tags to apply to the event.
.IP \(bu 2
\fBalert_type\fP \-\- \(dqerror\(dq, \(dqwarning\(dq, \(dqinfo\(dq or \(dqsuccess\(dq.
.IP \(bu 2
\fBaggregation_key\fP \-\- An arbitrary string to use for aggregation,
max length of 100 characters.
.IP \(bu 2
\fBsource_type_name\fP \-\- The type of event being posted.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.datadog_api.schedule_downtime(scope, api_key=None, app_key=None, monitor_id=None, start=None, end=None, message=None, recurrence=None, timezone=None, test=False)
Schedule downtime for a scope of monitors.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call datadog.schedule_downtime \(aqhost:app2\(aq \e
                                    stop=$(date \-\-date=\(aq30 minutes\(aq +%s) \e
                                    app_key=\(aq0123456789\(aq \e
                                    api_key=\(aq9876543210\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Optional arguments
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmonitor_id\fP \-\- The ID of the monitor
.IP \(bu 2
\fBstart\fP \-\- Start time in seconds since the epoch
.IP \(bu 2
\fBend\fP \-\- End time in seconds since the epoch
.IP \(bu 2
\fBmessage\fP \-\- A message to send in a notification for this downtime
.IP \(bu 2
\fBrecurrence\fP \-\- Repeat this downtime periodically
.IP \(bu 2
\fBtimezone\fP \-\- Specify the timezone
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.ddns
.sp
Support for RFC 2136 dynamic DNS updates.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
dnspython Python module
.UNINDENT
.TP
.B configuration
If you want to use TSIG authentication for the server, there
are a couple of optional configuration parameters made available to
support this (the keyname is only needed if the keyring contains more
than one key):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
keyfile: keyring file (default=None)
keyname: key name in file (default=None)
keyalgorithm: algorithm used to create the key
              (default=\(aqHMAC\-MD5.SIG\-ALG.REG.INT\(aq).
    Other possible values: hmac\-sha1, hmac\-sha224, hmac\-sha256,
        hmac\-sha384, hmac\-sha512
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The keyring file needs to be in json format and the key name needs to end
with an extra period in the file, similar to this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqkeyname.\(dq: \(dqkeycontent\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ddns.add_host(zone, name, ttl, ip, nameserver=\(aq127.0.0.1\(aq, replace=True, timeout=5, port=53, **kwargs)
Add, replace, or update the A and PTR (reverse) records for a host.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 ddns.add_host example.com host1 60 10.1.1.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ddns.delete(zone, name, rdtype=None, data=None, nameserver=\(aq127.0.0.1\(aq, timeout=5, port=53, **kwargs)
Delete a DNS record.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 ddns.delete example.com host1 A
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ddns.delete_host(zone, name, nameserver=\(aq127.0.0.1\(aq, timeout=5, port=53, **kwargs)
Delete the forward and reverse records for a host.
.sp
Returns true if any records are deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 ddns.delete_host example.com host1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ddns.update(zone, name, ttl, rdtype, data, nameserver=\(aq127.0.0.1\(aq, timeout=5, replace=False, port=53, **kwargs)
Add, replace, or update a DNS record.
nameserver must be an IP address and the minion running this module
must have update privileges on that server.
If replace is true, first deletes all records for this name and type.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 ddns.update example.com host1 60 A 10.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.deb_apache
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%apache Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Support for Apache
.sp
Please note: The functions in here are Debian\-specific. Placing them in this
separate file will allow them to load only on Debian\-based systems, while still
loading under the \fBapache\fP namespace.
.INDENT 0.0
.TP
.B salt.modules.deb_apache.a2disconf(conf)
New in version 2016.3.0.

.sp
Runs a2disconf for the given conf.
.sp
This will only be functional on Debian\-based operating systems (Ubuntu,
Mint, etc).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.a2disconf security
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.deb_apache.a2dismod(mod)
Runs a2dismod for the given mod.
.sp
This will only be functional on Debian\-based operating systems (Ubuntu,
Mint, etc).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.a2dismod vhost_alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.deb_apache.a2dissite(site)
Runs a2dissite for the given site.
.sp
This will only be functional on Debian\-based operating systems (Ubuntu,
Mint, etc).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.a2dissite example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.deb_apache.a2enconf(conf)
New in version 2016.3.0.

.sp
Runs a2enconf for the given conf.
.sp
This will only be functional on Debian\-based operating systems (Ubuntu,
Mint, etc).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.a2enconf security
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.deb_apache.a2enmod(mod)
Runs a2enmod for the given mod.
.sp
This will only be functional on Debian\-based operating systems (Ubuntu,
Mint, etc).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.a2enmod vhost_alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.deb_apache.a2ensite(site)
Runs a2ensite for the given site.
.sp
This will only be functional on Debian\-based operating systems (Ubuntu,
Mint, etc).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.a2ensite example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.deb_apache.check_conf_enabled(conf)
New in version 2016.3.0.

.sp
Checks to see if the specific conf symlink is in /etc/apache2/conf\-enabled.
.sp
This will only be functional on Debian\-based operating systems (Ubuntu,
Mint, etc).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.check_conf_enabled security
salt \(aq*\(aq apache.check_conf_enabled security.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.deb_apache.check_mod_enabled(mod)
Checks to see if the specific mod symlink is in /etc/apache2/mods\-enabled.
.sp
This will only be functional on Debian\-based operating systems (Ubuntu,
Mint, etc).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.check_mod_enabled status
salt \(aq*\(aq apache.check_mod_enabled status.load
salt \(aq*\(aq apache.check_mod_enabled status.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.deb_apache.check_site_enabled(site)
Checks to see if the specific site symlink is in /etc/apache2/sites\-enabled.
.sp
This will only be functional on Debian\-based operating systems (Ubuntu,
Mint, etc).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.check_site_enabled example.com
salt \(aq*\(aq apache.check_site_enabled example.com.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.deb_postgres
.sp
Module to provide Postgres compatibility to salt for debian family specific tools.
.INDENT 0.0
.TP
.B salt.modules.deb_postgres.cluster_create(version, name=\(aqmain\(aq, port=None, locale=None, encoding=None, datadir=None, allow_group_access=None, data_checksums=None, wal_segsize=None)
Adds a cluster to the Postgres server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.cluster_create \(aq9.3\(aq

salt \(aq*\(aq postgres.cluster_create \(aq9.3\(aq \(aqmain\(aq

salt \(aq*\(aq postgres.cluster_create \(aq9.3\(aq locale=\(aqfr_FR\(aq

salt \(aq*\(aq postgres.cluster_create \(aq11\(aq data_checksums=True wal_segsize=\(aq32\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.deb_postgres.cluster_exists(version, name=\(aqmain\(aq)
Checks if a given version and name of a cluster exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.cluster_exists \(aq9.3\(aq

salt \(aq*\(aq postgres.cluster_exists \(aq9.3\(aq \(aqmain\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.deb_postgres.cluster_list(verbose=False)
Return a list of cluster of Postgres server (tuples of version and name).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.cluster_list

salt \(aq*\(aq postgres.cluster_list verbose=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.deb_postgres.cluster_remove(version, name=\(aqmain\(aq, stop=False)
Remove a cluster on a Postgres server. By default it doesn\(aqt try
to stop the cluster.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.cluster_remove \(aq9.3\(aq

salt \(aq*\(aq postgres.cluster_remove \(aq9.3\(aq \(aqmain\(aq

salt \(aq*\(aq postgres.cluster_remove \(aq9.3\(aq \(aqmain\(aq stop=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.debconfmod
.sp
Support for Debconf
.INDENT 0.0
.TP
.B salt.modules.debconfmod.get_selections(fetchempty=True)
Answers to debconf questions for all packages in the following format:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqpackage\(aq: [[\(aqquestion\(aq, \(aqtype\(aq, \(aqvalue\(aq], ...]}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq debconf.get_selections
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debconfmod.set_(package, question, type, value, *extra)
Set answers to debconf questions for a package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq debconf.set <package> <question> <type> <value> [<value> ...]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debconfmod.set_file(path, saltenv=\(aqbase\(aq, **kwargs)
Set answers to debconf questions from a file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq debconf.set_file salt://pathto/pkg.selections
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debconfmod.set_template(path, template, context, defaults, saltenv=\(aqbase\(aq, **kwargs)
Set answers to debconf questions from a template.
.INDENT 7.0
.TP
.B path
location of the file containing the package selections
.TP
.B template
template format
.TP
.B context
variables to add to the template environment
.TP
.B default
default values for the template environment
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq debconf.set_template salt://pathto/pkg.selections.jinja jinja None None
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debconfmod.show(name)
Answers to debconf questions for a package in the following format:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[[\(aqquestion\(aq, \(aqtype\(aq, \(aqvalue\(aq], ...]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If debconf doesn\(aqt know about a package, we return None.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq debconf.show <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.debian_ip
.sp
The networking module for Debian\-based distros
.sp
References:
.INDENT 0.0
.IP \(bu 2
\fI\%http://www.debian.org/doc/manuals/debian\-reference/ch05.en.html\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_ip.apply_network_settings(**settings)
Apply global network configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.apply_network_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_ip.build_bond(iface, **settings)
Create a bond script in /etc/modprobe.d with the passed settings
and load the bonding kernel module.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.build_bond bond0 mode=balance\-alb
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_ip.build_interface(iface, iface_type, enabled, **settings)
Build an interface script for a network interface.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.build_interface eth0 eth <settings>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_ip.build_network_settings(**settings)
Build the global network script.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.build_network_settings <settings>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_ip.build_routes(iface, **settings)
Add route scripts for a network interface using up commands.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.build_routes eth0 <settings>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_ip.down(iface, iface_type)
Shutdown a network interface
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.down eth0 eth
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_ip.get_bond(iface)
Return the content of a bond script
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.get_bond bond0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_ip.get_interface(iface)
Return the contents of an interface script
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.get_interface eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_ip.get_network_settings()
Return the contents of the global network script.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.get_network_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_ip.get_routes(iface)
Return the routes for the interface
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.get_routes eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_ip.up(iface, iface_type)
Start up a network interface
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.up eth0 eth
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.debian_service
.sp
Service support for Debian systems (uses update\-rc.d and /sbin/service)
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage services on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqservice.start\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_service.available(name)
Returns \fBTrue\fP if the specified service is available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.available sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_service.disable(name, **kwargs)
Disable the named service to start at boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_service.disabled(name)
Return True if the named service is disabled, false otherwise
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_service.enable(name, **kwargs)
Enable the named service to start at boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_service.enabled(name, **kwargs)
Return True if the named service is enabled, false otherwise
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_service.force_reload(name)
Force\-reload the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.force_reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_service.get_all()
Return all available boot services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_service.get_disabled()
Return a set of services that are installed but disabled
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_disabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_service.get_enabled()
Return a list of service that are enabled on boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_service.missing(name)
The inverse of service.available.
Returns \fBTrue\fP if the specified service is not available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.missing sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_service.reload_(name)
Reload the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_service.restart(name)
Restart the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_service.start(name)
Start the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_service.status(name, sig=None)
Return the status for a service.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.sp
Changed in version 2018.3.0: The service name can now be a glob (e.g. \fBsalt*\fP)

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.IP \(bu 2
\fBsig\fP (\fI\%str\fP) \-\- Signature to use to find the service via ps
.UNINDENT
.TP
.B Returns
True if running, False otherwise
dict: Maps service name to True if running, False otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name> [service signature]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debian_service.stop(name)
Stop the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.debuild_pkgbuild
.sp
Debian Package builder system
.sp
New in version 2015.8.0.

.sp
This system allows for all of the components to build debs safely in chrooted
environments. This also provides a function to generate debian repositories
.sp
This module implements the pkgbuild interface
.INDENT 0.0
.TP
.B salt.modules.debuild_pkgbuild.build(runas, tgt, dest_dir, spec, sources, deps, env, template, saltenv=\(aqbase\(aq, log_dir=\(aq/var/log/salt/pkgbuild\(aq)
Given the package destination directory, the tarball containing debian files (e.g. control)
and package sources, use pbuilder to safely build the platform package
.sp
CLI Example:
.sp
\fBDebian\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgbuild.make_src_pkg deb\-8\-x86_64 /var/www/html
        https://raw.githubusercontent.com/saltstack/libnacl/master/pkg/deb/python\-libnacl.control
        https://pypi.python.org/packages/source/l/libnacl/libnacl\-1.3.5.tar.gz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example command should build the libnacl package for Debian using pbuilder
and place it in /var/www/html/ on the minion
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debuild_pkgbuild.make_repo(repodir, keyid=None, env=None, use_passphrase=False, gnupghome=\(aq/etc/salt/gpgkeys\(aq, runas=\(aqroot\(aq, timeout=15.0)
Make a package repository and optionally sign it and packages present
.sp
Given the repodir (directory to create repository in), create a Debian
repository and optionally sign it and packages present. This state is
best used with onchanges linked to your package building states.
.INDENT 7.0
.TP
.B repodir
The directory to find packages that will be in the repository.
.TP
.B keyid
Changed in version 2016.3.0.

.sp
Optional Key ID to use in signing packages and repository.
This consists of the last 8 hex digits of the GPG key ID.
.sp
Utilizes Public and Private keys associated with keyid which have
been loaded into the minion\(aqs Pillar data. Leverages gpg\-agent and
gpg\-preset\-passphrase for caching keys, etc.
These pillar values are assumed to be filenames which are present
in \fBgnupghome\fP\&. The pillar keys shown below have to match exactly.
.sp
For example, contents from a Pillar data file with named Public
and Private keys as follows:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
gpg_pkg_priv_keyname: gpg_pkg_key.pem
gpg_pkg_pub_keyname: gpg_pkg_key.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B env
Changed in version 2016.3.0.

.sp
A dictionary of environment variables to be utilized in creating the
repository.
.TP
.B use_passphrase
False
New in version 2016.3.0.

.sp
Use a passphrase with the signing key presented in \fBkeyid\fP\&.
Passphrase is received from Pillar data which could be passed on the
command line with \fBpillar\fP parameter. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pillar=\(aq{ \(dqgpg_passphrase\(dq : \(dqmy_passphrase\(dq }\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B gnupghome
/etc/salt/gpgkeys
New in version 2016.3.0.

.sp
Location where GPG related files are stored, used with \fBkeyid\fP\&.
.TP
.B runas
root
New in version 2016.3.0.

.sp
User to create the repository as, and optionally sign packages.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Ensure the user has correct permissions to any files and
directories which are to be utilized.
.UNINDENT
.UNINDENT
.TP
.B timeout
15.0
New in version 2016.3.4.

.sp
Timeout in seconds to wait for the prompt for inputting the passphrase.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgbuild.make_repo /var/www/html
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.debuild_pkgbuild.make_src_pkg(dest_dir, spec, sources, env=None, saltenv=\(aqbase\(aq, runas=\(aqroot\(aq)
Create a platform specific source package from the given platform spec/control file and sources
.sp
CLI Example:
.sp
\fBDebian\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgbuild.make_src_pkg /var/www/html/
        https://raw.githubusercontent.com/saltstack/libnacl/master/pkg/deb/python\-libnacl.control.tar.xz
        https://pypi.python.org/packages/source/l/libnacl/libnacl\-1.3.5.tar.gz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example command should build the libnacl SOURCE package and place it in
/var/www/html/ on the minion
.INDENT 7.0
.TP
.B dest_dir
Absolute path for directory to write source package
.TP
.B spec
Absolute path to spec file or equivalent
.TP
.B sources
Absolute path to source files to build source package from
.TP
.B env
None
A list  or dictionary of environment variables to be set prior to execution.
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- env:
    \- DEB_BUILD_OPTIONS: \(aqnocheck\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The above illustrates a common PyYAML pitfall, that \fByes\fP,
\fBno\fP, \fBon\fP, \fBoff\fP, \fBtrue\fP, and \fBfalse\fP are all loaded as
boolean \fBTrue\fP and \fBFalse\fP values, and must be enclosed in
quotes to be used as strings. More info on this (and other) PyYAML
idiosyncrasies can be found \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
saltenv: base
.INDENT 7.0
.INDENT 3.5
Salt environment variables
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B runas
root
New in version 2019.2.1.

.sp
User to create the files and directories
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Ensure the user has correct permissions to any files and
directories which are to be utilized.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.defaults
.sp
Module to work with salt formula defaults files
.INDENT 0.0
.TP
.B salt.modules.defaults.deepcopy(source)
Allows deep copy of objects in formulas.
.INDENT 7.0
.INDENT 3.5
By default, Python does not copy objects,
it creates bindings between a target and an object.
.UNINDENT
.UNINDENT
.sp
It is more typical to use this in a templating language in formulas,
instead of directly on the command\-line.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.defaults.get(key, default=\(aq\(aq)
defaults.get is used much like pillar.get except that it will read
a default value for a pillar from defaults.json or defaults.yaml
files that are stored in the root of a salt formula.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq defaults.get core:users:root
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The defaults is computed from pillar key. The first entry is considered as
the formula namespace.
.sp
For example, querying \fBcore:users:root\fP will try to load
\fBsalt://core/defaults.yaml\fP and \fBsalt://core/defaults.json\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.defaults.merge(dest, src, merge_lists=False, in_place=True, convert_none=True)
Allows deep merging of dicts in formulas.
.INDENT 7.0
.TP
.B merge_lists
False
If True, it will also merge lists instead of replace their items.
.TP
.B in_place
True
If True, it will merge into dest dict,
if not it will make a new copy from that dict and return it.
.TP
.B convert_none
True
If True, it will convert src and dest to empty dicts if they are None.
If True and dest is None but in_place is True, raises TypeError.
If False it will make a new copy from that dict and return it.
.sp
New in version 3005.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq defaults.merge \(aq{a: b}\(aq \(aq{d: e}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is more typical to use this in a templating language in formulas,
instead of directly on the command\-line.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.defaults.update(dest, defaults, merge_lists=True, in_place=True, convert_none=True)
Allows setting defaults for group of data set e.g. group for nodes.
.INDENT 7.0
.INDENT 3.5
This function is a combination of defaults.merge
and defaults.deepcopy to avoid redundant in jinja.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
group01:
  defaults:
    enabled: True
    extra:
      \- test
      \- stage
  nodes:
    host01:
      index: foo
      upstream: bar
    host02:
      index: foo2
      upstream: bar2
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% do salt[\(aqdefaults.update\(aq](group01.nodes, group01.defaults) %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Each node will look like the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
host01:
  enabled: True
  index: foo
  upstream: bar
  extra:
    \- test
    \- stage
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B merge_lists
True
If True, it will also merge lists instead of replace their items.
.TP
.B in_place
True
If True, it will merge into dest dict.
if not it will make a new copy from that dict and return it.
.TP
.B convert_none
True
If True, it will convert src and dest to empty dicts if they are None.
If True and dest is None but in_place is True, raises TypeError.
If False it will make a new copy from that dict and return it.
.sp
New in version 3005.

.UNINDENT
.sp
It is more typical to use this in a templating language in formulas,
instead of directly on the command\-line.
.UNINDENT
.SS salt.modules.devinfo
.sp
Module for devinfo
:maintainer:    Alberto Planas <\fI\%aplanas@suse.com\fP>
:maturity:      new
:depends:       None
:platform:      Linux
.INDENT 0.0
.TP
.B salt.modules.devinfo.filter_(udev_in=None, udev_ex=None)
Returns a list of devices, filtered under udev keys.
.INDENT 7.0
.TP
.B udev_in
A dictionary of key:values that are expected in the device
udev information
.TP
.B udev_ex
A dictionary of key:values that are not expected in the device
udev information (excluded)
.UNINDENT
.sp
The key is a lower case string, joined by dots, that represent a
path in the udev information dictionary. For example, \(aqe.id_bus\(aq
will represent the udev entry \fIudev[\(aqE\(aq][\(aqID_BUS\(aq]\fP
.sp
If the udev entry is a list, the algorithm will check that at
least one item match one item of the value of the parameters.
.sp
Returns list of devices that match \fIudev_in\fP and do not match
\fIudev_ex\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq devinfo.filter udev_in=\(aq{\(dqe.id_bus\(dq: \(dqata\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.devinfo.hwinfo(items=None, short=True, listmd=False, devices=None)
Probe for hardware
.INDENT 7.0
.TP
.B items
List of hardware items to inspect. Default [\(aqbios\(aq, \(aqcpu\(aq, \(aqdisk\(aq,
\(aqmemory\(aq, \(aqnetwork\(aq, \(aqpartition\(aq]
.TP
.B short
Show only a summary. Default True.
.TP
.B listmd
Report RAID devices. Default False.
.TP
.B devices
List of devices to show information from. Default None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq devinfo.hwinfo
salt \(aq*\(aq devinfo.hwinfo items=\(aq[\(dqdisk\(dq]\(aq short=no
salt \(aq*\(aq devinfo.hwinfo items=\(aq[\(dqdisk\(dq]\(aq short=no devices=\(aq[\(dq/dev/sda\(dq]\(aq
salt \(aq*\(aq devinfo.hwinfo devices=/dev/sda
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.devmap
.sp
Device\-Mapper module
.INDENT 0.0
.TP
.B salt.modules.devmap.multipath_flush(device)
Device\-Mapper Multipath flush
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq devmap.multipath_flush mpath1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.devmap.multipath_list()
Device\-Mapper Multipath list
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq devmap.multipath_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.dig
.sp
Compendium of generic DNS utilities.
The \(aqdig\(aq command line tool must be installed in order to use this module.
.INDENT 0.0
.TP
.B salt.modules.dig.A(host, nameserver=None)
Return the A record for \fBhost\fP\&.
.sp
Always returns a list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.A www.google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dig.AAAA(host, nameserver=None)
Return the AAAA record for \fBhost\fP\&.
.sp
Always returns a list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.AAAA www.google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dig.CNAME(host, nameserver=None)
Return the CNAME record for \fBhost\fP\&.
.sp
New in version 3005.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.CNAME mail.google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dig.MX(domain, resolve=False, nameserver=None)
Return a list of lists for the MX of \fBdomain\fP\&.
.sp
If the \fBresolve\fP argument is True, resolve IPs for the servers.
.sp
It\(aqs limited to one IP, because although in practice it\(aqs very rarely a
round robin, it is an acceptable configuration and pulling just one IP lets
the data be similar to the non\-resolved version. If you think an MX has
multiple IPs, don\(aqt use the resolver here, resolve them in a separate step.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.MX google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dig.NS(domain, resolve=True, nameserver=None)
Return a list of IPs of the nameservers for \fBdomain\fP
.sp
If \fBresolve\fP is False, don\(aqt resolve names.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.NS google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dig.PTR(host, nameserver=None)
New in version 3006.0.

.sp
Return the PTR record for \fBhost\fP\&.
.sp
Always returns a list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.PTR 1.2.3.4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dig.SPF(domain, record=\(aqSPF\(aq, nameserver=None)
Return the allowed IPv4 ranges in the SPF record for \fBdomain\fP\&.
.sp
If record is \fBSPF\fP and the SPF record is empty, the TXT record will be
searched automatically. If you know the domain uses TXT and not SPF,
specifying that will save a lookup.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.SPF google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dig.TXT(host, nameserver=None)
Return the TXT record for \fBhost\fP\&.
.sp
Always returns a list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.TXT google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dig.a(host, nameserver=None)
Return the A record for \fBhost\fP\&.
.sp
Always returns a list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.A www.google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dig.aaaa(host, nameserver=None)
Return the AAAA record for \fBhost\fP\&.
.sp
Always returns a list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.AAAA www.google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dig.check_ip(addr)
Check if address is a valid IP. returns True if valid, otherwise False.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.check_ip 127.0.0.1
salt ns1 dig.check_ip 1111:2222:3333:4444:5555:6666:7777:8888
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dig.cname(host, nameserver=None)
Return the CNAME record for \fBhost\fP\&.
.sp
New in version 3005.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.CNAME mail.google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dig.mx(domain, resolve=False, nameserver=None)
Return a list of lists for the MX of \fBdomain\fP\&.
.sp
If the \fBresolve\fP argument is True, resolve IPs for the servers.
.sp
It\(aqs limited to one IP, because although in practice it\(aqs very rarely a
round robin, it is an acceptable configuration and pulling just one IP lets
the data be similar to the non\-resolved version. If you think an MX has
multiple IPs, don\(aqt use the resolver here, resolve them in a separate step.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.MX google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dig.ns(domain, resolve=True, nameserver=None)
Return a list of IPs of the nameservers for \fBdomain\fP
.sp
If \fBresolve\fP is False, don\(aqt resolve names.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.NS google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dig.ptr(host, nameserver=None)
New in version 3006.0.

.sp
Return the PTR record for \fBhost\fP\&.
.sp
Always returns a list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.PTR 1.2.3.4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dig.spf(domain, record=\(aqSPF\(aq, nameserver=None)
Return the allowed IPv4 ranges in the SPF record for \fBdomain\fP\&.
.sp
If record is \fBSPF\fP and the SPF record is empty, the TXT record will be
searched automatically. If you know the domain uses TXT and not SPF,
specifying that will save a lookup.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dig.SPF google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.disk
.sp
Module for managing disks and blockdevices
.INDENT 0.0
.TP
.B salt.modules.disk.blkid(device=None, token=None)
Return block device attributes: UUID, LABEL, etc. This function only works
on systems where blkid is available.
.INDENT 7.0
.TP
.B device
Device name from the system
.TP
.B token
Any valid token used for the search
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.blkid
salt \(aq*\(aq disk.blkid /dev/sda
salt \(aq*\(aq disk.blkid token=\(aqUUID=6a38ee5\-7235\-44e7\-8b22\-816a403bad5d\(aq
salt \(aq*\(aq disk.blkid token=\(aqTYPE=ext4\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.disk.dump(device, args=None)
Return all contents of dumpe2fs for a specified device
.INDENT 7.0
.TP
.B device
The device path to dump.
.TP
.B args
A list of attributes to return. Returns all by default.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.dump /dev/sda1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.disk.format_(device, fs_type=\(aqext4\(aq, inode_size=None, lazy_itable_init=None, fat=None, force=False)
Format a filesystem onto a device
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B device
The device in which to create the new filesystem
.TP
.B fs_type
The type of filesystem to create
.TP
.B inode_size
Size of the inodes
.sp
This option is only enabled for ext and xfs filesystems
.TP
.B lazy_itable_init
If enabled and the uninit_bg feature is enabled, the inode table will
not be fully initialized by mke2fs.  This speeds up filesystem
initialization noticeably, but it requires the kernel to finish
initializing the filesystem  in  the  background  when  the filesystem
is first mounted.  If the option value is omitted, it defaults to 1 to
enable lazy inode table zeroing.
.sp
This option is only enabled for ext filesystems
.TP
.B fat
FAT size option. Can be 12, 16 or 32, and can only be used on
fat or vfat filesystems.
.TP
.B force
Force mke2fs to create a filesystem, even if the specified device is
not a partition on a block special device. This option is only enabled
for ext and xfs filesystems
.sp
This option is dangerous, use it with caution.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.format /dev/sdX1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.disk.fstype(device)
Return the filesystem name of the specified device
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B device
The name of the device
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.fstype /dev/sdX1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.disk.get_fstype_from_path(path)
Return the filesystem type of the underlying device for a specified path.
.sp
New in version 3006.0.

.INDENT 7.0
.TP
.B path
The path for the function to evaluate.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.get_fstype_from_path /root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.disk.hdparms(disks, args=\(aqaAbBcCdgHiJkMmNnQrRuW\(aq)
Retrieve disk parameters.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B disks
Single disk or list of disks to query.
.TP
.B args
Sequence of \fBhdparm\fP flags to fetch.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.hdparms /dev/sda
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.disk.hpa(disks, size=None)
Get/set Host Protected Area settings
.sp
T13 INCITS 346\-2001 (1367D) defines the BEER (Boot Engineering Extension Record)
and PARTIES (Protected Area Run Time Interface Extension Services), allowing
for a Host Protected Area on a disk.
.sp
It\(aqs often used by OEMS to hide parts of a disk, and for overprovisioning SSD\(aqs
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Setting the HPA might clobber your data, be very careful with this on active disks!
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.hpa /dev/sda
salt \(aq*\(aq disk.hpa /dev/sda 5%
salt \(aq*\(aq disk.hpa /dev/sda 10543256
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.disk.inodeusage(args=None)
Return inode usage information for volumes mounted on this minion
.INDENT 7.0
.TP
.B args
Sequence of flags to pass to the \fBdf\fP command.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.inodeusage
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.disk.iostat(interval=1, count=5, disks=None)
Gather and return (averaged) IO stats.
.sp
New in version 2016.3.0.

.sp
Changed in version 2016.11.4: Added support for AIX

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.iostat 1 5 disks=sda
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.disk.percent(args=None)
Return partition information for volumes mounted on this minion
.INDENT 7.0
.TP
.B args
Specify a single partition for which to return data.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.percent /var
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.disk.resize2fs(device)
Resizes the filesystem.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.resize2fs /dev/sda1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.disk.smart_attributes(dev, attributes=None, values=None)
Fetch SMART attributes
Providing attributes will deliver only requested attributes
Providing values will deliver only requested values for attributes
.sp
Default is the Backblaze recommended
set (\fI\%https://www.backblaze.com/blog/hard\-drive\-smart\-stats/\fP):
(5,187,188,197,198)
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.smart_attributes /dev/sda
salt \(aq*\(aq disk.smart_attributes /dev/sda attributes=(5,187,188,197,198)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.disk.tune(device, **kwargs)
Set attributes for the specified device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.tune /dev/sda1 read\-ahead=1024 read\-write=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Valid options are: \fBread\-ahead\fP, \fBfilesystem\-read\-ahead\fP,
\fBread\-only\fP, \fBread\-write\fP\&.
.sp
See the \fBblockdev(8)\fP manpage for a more complete description of these
options.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.disk.usage(args=None)
Return usage information for volumes mounted on this minion
.INDENT 7.0
.TP
.B args
Sequence of flags to pass to the \fBdf\fP command.
.UNINDENT
.sp
Changed in version 2019.2.0: Default for SunOS changed to 1 kilobyte blocks

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.usage
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.disk.wipe(device)
Remove the filesystem information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.wipe /dev/sda1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.djangomod
.sp
Manage Django sites
.INDENT 0.0
.TP
.B salt.modules.djangomod.collectstatic(settings_module, bin_env=None, no_post_process=False, ignore=None, dry_run=False, clear=False, link=False, no_default_ignore=False, pythonpath=None, env=None, runas=None)
Collect static files from each of your applications into a single location
that can easily be served in production.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq django.collectstatic <settings_module>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.djangomod.command(settings_module, command, bin_env=None, pythonpath=None, env=None, runas=None, *args, **kwargs)
Run arbitrary django management command
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq django.command <settings_module> <command>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.djangomod.createsuperuser(settings_module, username, email, bin_env=None, database=None, pythonpath=None, env=None, runas=None)
Create a super user for the database.
This function defaults to use the \fB\-\-noinput\fP flag which prevents the
creation of a password for the superuser.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq django.createsuperuser <settings_module> user user@example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.djangomod.loaddata(settings_module, fixtures, bin_env=None, database=None, pythonpath=None, env=None)
Load fixture data
.INDENT 7.0
.TP
.B Fixtures:
comma separated list of fixtures to load
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq django.loaddata <settings_module> <comma delimited list of fixtures>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.djangomod.migrate(settings_module, app_label=None, migration_name=None, bin_env=None, database=None, pythonpath=None, env=None, noinput=True, runas=None)
Run migrate
.sp
Execute the Django\-Admin migrate command (requires Django 1.7 or higher).
.sp
New in version 3000.

.INDENT 7.0
.TP
.B settings_module
Specifies the settings module to use.
The settings module should be in Python package syntax, e.g. mysite.settings.
If this isn’t provided, django\-admin will use the DJANGO_SETTINGS_MODULE
environment variable.
.TP
.B app_label
Specific app to run migrations for, instead of all apps.
This may involve running other apps’ migrations too, due to dependencies.
.TP
.B migration_name
Named migration to be applied to a specific app.
Brings the database schema to a state where the named migration is applied,
but no later migrations in the same app are applied. This may involve
unapplying migrations if you have previously migrated past the named migration.
Use the name zero to unapply all migrations for an app.
.TP
.B bin_env
Path to pip (or to a virtualenv). This can be used to specify the path
to the pip to use when more than one Python release is installed (e.g.
\fB/usr/bin/pip\-2.7\fP or \fB/usr/bin/pip\-2.6\fP\&. If a directory path is
specified, it is assumed to be a virtualenv.
.TP
.B database
Database to migrate. Defaults to \(aqdefault\(aq.
.TP
.B pythonpath
Adds the given filesystem path to the Python import search path.
If this isn’t provided, django\-admin will use the PYTHONPATH environment variable.
.TP
.B env
A list of environment variables to be set prior to execution.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
module.run:
  \- name: django.migrate
  \- settings_module: my_django_app.settings
  \- env:
    \- DATABASE_USER: \(aqmydbuser\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B noinput
Suppresses all user prompts. Defaults to True.
.TP
.B runas
The user name to run the command as.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq django.migrate <settings_module>
salt \(aq*\(aq django.migrate <settings_module> <app_label>
salt \(aq*\(aq django.migrate <settings_module> <app_label> <migration_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.djangomod.syncdb(settings_module, bin_env=None, migrate=False, database=None, pythonpath=None, env=None, noinput=True, runas=None)
Run syncdb
.sp
Execute the Django\-Admin syncdb command, if South is available on the
minion the \fBmigrate\fP option can be passed as \fBTrue\fP calling the
migrations to run after the syncdb completes
.sp
NOTE: The syncdb command was deprecated in Django 1.7 and removed in Django 1.9.
For Django versions 1.9 or higher use the \fImigrate\fP command instead.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq django.syncdb <settings_module>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.dnsmasq
.sp
Module for managing dnsmasq
.INDENT 0.0
.TP
.B salt.modules.dnsmasq.fullversion()
Shows installed version of dnsmasq and compile options.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dnsmasq.fullversion
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dnsmasq.get_config(config_file=\(aq/etc/dnsmasq.conf\(aq)
Dumps all options from the config file.
.INDENT 7.0
.TP
.B config_file
The location of the config file from which to obtain contents.
Defaults to \fB/etc/dnsmasq.conf\fP\&.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dnsmasq.get_config
salt \(aq*\(aq dnsmasq.get_config config_file=/etc/dnsmasq.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dnsmasq.set_config(config_file=\(aq/etc/dnsmasq.conf\(aq, follow=True, **kwargs)
Sets a value or a set of values in the specified file. By default, if
conf\-dir is configured in this file, salt will attempt to set the option
in any file inside the conf\-dir where it has already been enabled. If it
does not find it inside any files, it will append it to the main config
file. Setting follow to False will turn off this behavior.
.sp
If a config option currently appears multiple times (such as dhcp\-host,
which is specified at least once per host), the new option will be added
to the end of the main config file (and not to any includes). If you need
an option added to a specific include file, specify it as the config_file.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconfig_file\fP (\fIstring\fP) \-\- config file where settings should be updated / added.
.IP \(bu 2
\fBfollow\fP (\fI\%bool\fP) \-\- attempt to set the config option inside any file within
the \fBconf\-dir\fP where it has already been enabled.
.IP \(bu 2
\fBkwargs\fP \-\- key value pairs that contain the configuration settings that you
want set.
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dnsmasq.set_config domain=mydomain.com
salt \(aq*\(aq dnsmasq.set_config follow=False domain=mydomain.com
salt \(aq*\(aq dnsmasq.set_config config_file=/etc/dnsmasq.conf domain=mydomain.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dnsmasq.version()
Shows installed version of dnsmasq.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dnsmasq.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.dnsutil
.sp
Compendium of generic DNS utilities.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Some functions in the \fBdnsutil\fP execution module depend on \fBdig\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dnsutil.A(host, nameserver=None)
Return the A record(s) for \fBhost\fP\&.
.sp
Always returns a list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dnsutil.A www.google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dnsutil.AAAA(host, nameserver=None)
Return the AAAA record(s) for \fBhost\fP\&.
.sp
Always returns a list.
.sp
New in version 2014.7.5.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dnsutil.AAAA www.google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dnsutil.MX(domain, resolve=False, nameserver=None)
Return a list of lists for the MX of \fBdomain\fP\&.
.sp
If the \(aqresolve\(aq argument is True, resolve IPs for the servers.
.sp
It\(aqs limited to one IP, because although in practice it\(aqs very rarely a
round robin, it is an acceptable configuration and pulling just one IP lets
the data be similar to the non\-resolved version. If you think an MX has
multiple IPs, don\(aqt use the resolver here, resolve them in a separate step.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dnsutil.MX google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dnsutil.NS(domain, resolve=True, nameserver=None)
Return a list of IPs of the nameservers for \fBdomain\fP
.sp
If \(aqresolve\(aq is False, don\(aqt resolve names.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dnsutil.NS google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dnsutil.SPF(domain, record=\(aqSPF\(aq, nameserver=None)
Return the allowed IPv4 ranges in the SPF record for \fBdomain\fP\&.
.sp
If record is \fBSPF\fP and the SPF record is empty, the TXT record will be
searched automatically. If you know the domain uses TXT and not SPF,
specifying that will save a lookup.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dnsutil.SPF google.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dnsutil.check_ip(ip_addr)
Check that string ip_addr is a valid IP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dnsutil.check_ip 127.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dnsutil.hosts_append(hostsfile=\(aq/etc/hosts\(aq, ip_addr=None, entries=None)
Append a single line to the /etc/hosts file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dnsutil.hosts_append /etc/hosts 127.0.0.1 ad1.yuk.co,ad2.yuk.co
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dnsutil.hosts_remove(hostsfile=\(aq/etc/hosts\(aq, entries=None)
Remove a host from the /etc/hosts file. If doing so will leave a line
containing only an IP address, then the line will be deleted. This function
will leave comments and blank lines intact.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dnsutil.hosts_remove /etc/hosts ad1.yuk.co
salt \(aq*\(aq dnsutil.hosts_remove /etc/hosts ad2.yuk.co,ad1.yuk.co
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dnsutil.parse_hosts(hostsfile=\(aq/etc/hosts\(aq, hosts=None)
Parse /etc/hosts file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dnsutil.parse_hosts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dnsutil.parse_zone(zonefile=None, zone=None)
Parses a zone file. Can be passed raw zone data on the API level.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dnsutil.parse_zone /var/lib/named/example.com.zone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dnsutil.serial(zone=\(aq\(aq, update=False)
Return, store and update a dns serial for your zone files.
.sp
zone: a keyword for a specific zone
.sp
update: store an updated version of the serial in a grain
.sp
If \fBupdate\fP is False, the function will retrieve an existing serial or
return the current date if no serial is stored. Nothing will be stored
.sp
If \fBupdate\fP is True, the function will set the serial to the current date
if none exist or if the existing serial is for a previous date. If a serial
for greater than the current date is already stored, the function will
increment it.
.sp
This module stores the serial in a grain, you can explicitly set the
stored value as a grain named \fBdnsserial_<zone_name>\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt ns1 dnsutil.serial example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.dockercompose
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%docker Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Module to import docker\-compose via saltstack
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B maintainer
Jean Praloran <\fI\%jeanpralo@gmail.com\fP>
.TP
.B maturity
new
.TP
.B depends
docker\-compose>=1.5
.TP
.B platform
all
.UNINDENT
.SS Introduction
.sp
This module allows one to deal with docker\-compose file in a directory.
.sp
This is  a first version only, the following commands are missing at the moment
but will be built later on if the community is interested in this module:
.INDENT 0.0
.IP \(bu 2
run
.IP \(bu 2
logs
.IP \(bu 2
port
.IP \(bu 2
scale
.UNINDENT
.SS Installation Prerequisites
.sp
This execution module requires at least version 1.4.0 of both \fI\%docker\-compose\fP and
\fI\%Docker\fP\&. docker\-compose can easily be installed using \fI\%pip.install\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pip.install docker\-compose>=1.5.0
.ft P
.fi
.UNINDENT
.UNINDENT
.SS How to use this module?
.sp
In order to use the module if you have no docker\-compose file on the server you
can issue the command create, it takes two arguments the path where the
docker\-compose.yml will be stored and the content of this latter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call \-l debug dockercompose.create /tmp/toto \(aq
database:
image: mongo:3.0
command: mongod \-\-smallfiles \-\-quiet \-\-logpath=/dev/null
\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then you can execute a list of method defined at the bottom with at least one
argument (the path where the docker\-compose.yml will be read) and an optional
python list which corresponds to the services names:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call \-l debug dockercompose.up /tmp/toto
# salt\-call \-l debug dockercompose.restart /tmp/toto \(aq[database]\(aq
# salt\-call \-l debug dockercompose.stop /tmp/toto
# salt\-call \-l debug dockercompose.rm /tmp/toto
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Docker\-compose method supported
.INDENT 0.0
.IP \(bu 2
up
.IP \(bu 2
restart
.IP \(bu 2
stop
.IP \(bu 2
start
.IP \(bu 2
pause
.IP \(bu 2
unpause
.IP \(bu 2
kill
.IP \(bu 2
rm
.IP \(bu 2
ps
.IP \(bu 2
pull
.IP \(bu 2
build
.UNINDENT
.SS Functions
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B docker\-compose.yml management
.INDENT 7.0
.IP \(bu 2
\fI\%dockercompose.create\fP
.IP \(bu 2
\fI\%dockercompose.get\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B Manage containers
.INDENT 7.0
.IP \(bu 2
\fI\%dockercompose.restart\fP
.IP \(bu 2
\fI\%dockercompose.stop\fP
.IP \(bu 2
\fI\%dockercompose.pause\fP
.IP \(bu 2
\fI\%dockercompose.unpause\fP
.IP \(bu 2
\fI\%dockercompose.start\fP
.IP \(bu 2
\fI\%dockercompose.kill\fP
.IP \(bu 2
\fI\%dockercompose.rm\fP
.IP \(bu 2
\fI\%dockercompose.up\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B Manage containers image:
.INDENT 7.0
.IP \(bu 2
\fI\%dockercompose.pull\fP
.IP \(bu 2
\fI\%dockercompose.build\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B Gather information about containers:
.INDENT 7.0
.IP \(bu 2
\fI\%dockercompose.ps\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B Manage service definitions:
.INDENT 7.0
.IP \(bu 2
\fI\%dockercompose.service_create\fP
.IP \(bu 2
\fI\%dockercompose.service_upsert\fP
.IP \(bu 2
\fI\%dockercompose.service_remove\fP
.IP \(bu 2
\fI\%dockercompose.service_set_tag\fP
.UNINDENT
.UNINDENT
.UNINDENT
.SS Detailed Function Documentation
.INDENT 0.0
.TP
.B salt.modules.dockercompose.build(path, service_names=None)
Build image for containers in the docker\-compose file, service_names is a
python list, if omitted build images for all containers. Please note
that at the moment the module does not allow you to upload your Dockerfile,
nor any other file you could need with your docker\-compose.yml, you will
have to make sure the files you need are actually in the directory specified
in the \fIbuild\fP keyword
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.TP
.B service_names
If specified will pull only the image for the specified services
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.build /path/where/docker\-compose/stored
salt myminion dockercompose.build /path/where/docker\-compose/stored \(aq[janus]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.create(path, docker_compose)
Create and validate a docker\-compose file into a directory
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file will be stored on the server
.TP
.B docker_compose
docker_compose file
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.create /path/where/docker\-compose/stored content
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.get(path)
Get the content of the docker\-compose file into a directory
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.get /path/where/docker\-compose/stored
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.kill(path, service_names=None)
Kill containers in the docker\-compose file, service_names is a python
list, if omitted kill all containers
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.TP
.B service_names
If specified will kill only the specified services
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.kill /path/where/docker\-compose/stored
salt myminion dockercompose.kill /path/where/docker\-compose/stored \(aq[janus]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.pause(path, service_names=None)
Pause running containers in the docker\-compose file, service_names is a python
list, if omitted pause all containers
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.TP
.B service_names
If specified will pause only the specified services
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.pause /path/where/docker\-compose/stored
salt myminion dockercompose.pause /path/where/docker\-compose/stored \(aq[janus]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.ps(path)
List all running containers and report some information about them
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.ps /path/where/docker\-compose/stored
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.pull(path, service_names=None)
Pull image for containers in the docker\-compose file, service_names is a
python list, if omitted pull all images
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.TP
.B service_names
If specified will pull only the image for the specified services
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.pull /path/where/docker\-compose/stored
salt myminion dockercompose.pull /path/where/docker\-compose/stored \(aq[janus]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.restart(path, service_names=None)
Restart container(s) in the docker\-compose file, service_names is a python
list, if omitted restart all containers
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.TP
.B service_names
If specified will restart only the specified services
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.restart /path/where/docker\-compose/stored
salt myminion dockercompose.restart /path/where/docker\-compose/stored \(aq[janus]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.rm(path, service_names=None)
Remove stopped containers in the docker\-compose file, service_names is a python
list, if omitted remove all stopped containers
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.TP
.B service_names
If specified will remove only the specified stopped services
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.rm /path/where/docker\-compose/stored
salt myminion dockercompose.rm /path/where/docker\-compose/stored \(aq[janus]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.service_create(path, service_name, definition)
Create the definition of a docker\-compose service
This fails when the service already exists
This does not pull or up the service
This wil re\-write your yaml file. Comments will be lost. Indentation is set to 2 spaces
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.TP
.B service_name
Name of the service to create
.TP
.B definition
Service definition as yaml or json string
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.service_create /path/where/docker\-compose/stored service_name definition
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.service_remove(path, service_name)
Remove the definition of a docker\-compose service
This does not rm the container
This wil re\-write your yaml file. Comments will be lost. Indentation is set to 2 spaces
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.TP
.B service_name
Name of the service to remove
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.service_remove /path/where/docker\-compose/stored service_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.service_set_tag(path, service_name, tag)
Change the tag of a docker\-compose service
This does not pull or up the service
This wil re\-write your yaml file. Comments will be lost. Indentation is set to 2 spaces
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.TP
.B service_name
Name of the service to remove
.TP
.B tag
Name of the tag (often used as version) that the service image should have
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.service_create /path/where/docker\-compose/stored service_name tag
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.service_upsert(path, service_name, definition)
Create or update the definition of a docker\-compose service
This does not pull or up the service
This wil re\-write your yaml file. Comments will be lost. Indentation is set to 2 spaces
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.TP
.B service_name
Name of the service to create
.TP
.B definition
Service definition as yaml or json string
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.service_upsert /path/where/docker\-compose/stored service_name definition
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.start(path, service_names=None)
Start containers in the docker\-compose file, service_names is a python
list, if omitted start all containers
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.TP
.B service_names
If specified will start only the specified services
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.start /path/where/docker\-compose/stored
salt myminion dockercompose.start /path/where/docker\-compose/stored \(aq[janus]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.stop(path, service_names=None)
Stop running containers in the docker\-compose file, service_names is a python
list, if omitted stop all containers
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.TP
.B service_names
If specified will stop only the specified services
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.stop /path/where/docker\-compose/stored
salt myminion dockercompose.stop  /path/where/docker\-compose/stored \(aq[janus]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.unpause(path, service_names=None)
Un\-Pause containers in the docker\-compose file, service_names is a python
list, if omitted unpause all containers
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.TP
.B service_names
If specified will un\-pause only the specified services
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.pause /path/where/docker\-compose/stored
salt myminion dockercompose.pause /path/where/docker\-compose/stored \(aq[janus]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockercompose.up(path, service_names=None)
Create and start containers defined in the docker\-compose.yml file
located in path, service_names is a python list, if omitted create and
start all containers
.INDENT 7.0
.TP
.B path
Path where the docker\-compose file is stored on the server
.TP
.B service_names
If specified will create and start only the specified services
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion dockercompose.up /path/where/docker\-compose/stored
salt myminion dockercompose.up /path/where/docker\-compose/stored \(aq[janus]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.dockermod
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%docker Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Management of Docker Containers
.sp
New in version 2015.8.0.

.sp
Changed in version 2017.7.0: This module has replaced the legacy docker execution module.

.INDENT 0.0
.TP
.B depends
\fI\%docker\fP Python module
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Older releases of the Python bindings for Docker were called \fI\%docker\-py\fP in
PyPI. All releases of \fI\%docker\fP, and releases of \fI\%docker\-py\fP >= 1.6.0 are
supported. These python bindings can easily be installed using
\fI\%pip.install\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pip.install docker
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To upgrade from \fI\%docker\-py\fP to \fI\%docker\fP, you must first uninstall \fI\%docker\-py\fP,
and then install \fI\%docker\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pip.uninstall docker\-py
salt myminion pip.install docker
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Authentication
.sp
If you have previously performed a \fBdocker login\fP from the minion, then the
credentials saved in \fB~/.docker/config.json\fP will be used for any actions
which require authentication. If not, then credentials can be configured in
any of the following locations:
.INDENT 0.0
.IP \(bu 2
Minion config file
.IP \(bu 2
Grains
.IP \(bu 2
Pillar data
.IP \(bu 2
Master config file (requires \fBpillar_opts\fP to be set to \fBTrue\fP
in Minion config file in order to work)
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
Versions prior to 3000 require that Docker credentials are configured in
Pillar data. Be advised that Pillar data is still recommended though,
because this keeps the configuration from being stored on the Minion.
.sp
Also, keep in mind that if one gets your \fB~/.docker/config.json\fP, the
password can be decoded from its contents.
.UNINDENT
.UNINDENT
.sp
The configuration schema is as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
docker\-registries:
  <registry_url>:
    username: <username>
    password: <password>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
docker\-registries:
  hub:
    username: foo
    password: s3cr3t
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
As of the 2016.3.7, 2016.11.4, and 2017.7.0 releases of Salt, credentials
for the Docker Hub can be configured simply by specifying \fBhub\fP in place
of the registry URL. In earlier releases, it is necessary to specify the
actual registry URL for the Docker Hub (i.e.
\fBhttps://index.docker.io/v1/\fP).
.UNINDENT
.UNINDENT
.sp
More than one registry can be configured. Salt will look for Docker credentials
in the \fBdocker\-registries\fP Pillar key, as well as any key ending in
\fB\-docker\-registries\fP\&. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
docker\-registries:
  \(aqhttps://mydomain.tld/registry:5000\(aq:
    username: foo
    password: s3cr3t

foo\-docker\-registries:
  https://index.foo.io/v1/:
    username: foo
    password: s3cr3t

bar\-docker\-registries:
  https://index.bar.io/v1/:
    username: foo
    password: s3cr3t
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To login to the configured registries, use the \fI\%docker.login\fP function. This only needs to be done once for a
given registry, and it will store/update the credentials in
\fB~/.docker/config.json\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For Salt releases before 2016.3.7 and 2016.11.4, \fI\%docker.login\fP is not available. Instead, Salt will try to
authenticate using each of your configured registries for each push/pull,
behavior which is not correct and has been resolved in newer releases.
.UNINDENT
.UNINDENT
.SS Configuration Options
.sp
The following configuration options can be set to fine\-tune how Salt uses
Docker:
.INDENT 0.0
.IP \(bu 2
\fBdocker.url\fP: URL to the docker service (default: local socket).
.IP \(bu 2
\fBdocker.version\fP: API version to use (should not need to be set manually in
the vast majority of cases)
.IP \(bu 2
\fBdocker.exec_driver\fP: Execution driver to use, one of \fBnsenter\fP,
\fBlxc\-attach\fP, or \fBdocker\-exec\fP\&. See the \fI\%Executing Commands Within a
Running Container\fP section for more details on how
this config parameter is used.
.UNINDENT
.sp
These configuration options are retrieved using \fI\%config.get\fP (click the link for further information).
.SS Executing Commands Within a Running Container
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
With the release of Docker 1.13.1, the Execution Driver has been removed.
Starting in versions 2016.3.6, 2016.11.4, and 2017.7.0, Salt defaults to
using \fBdocker exec\fP to run commands in containers, however for older Salt
releases it will be necessary to set the \fBdocker.exec_driver\fP config
option to either \fBdocker\-exec\fP or \fBnsenter\fP for Docker versions 1.13.1
and newer.
.UNINDENT
.UNINDENT
.sp
Multiple methods exist for executing commands within Docker containers:
.INDENT 0.0
.IP \(bu 2
\fI\%lxc\-attach\fP: Default for older versions of docker
.IP \(bu 2
\fI\%nsenter\fP: Enters container namespace to run command
.IP \(bu 2
\fI\%docker\-exec\fP: Native support for executing commands in Docker containers
(added in Docker 1.3)
.UNINDENT
.sp
Adding a configuration option (see \fI\%config.get\fP) called \fBdocker.exec_driver\fP will tell Salt which
execution driver to use:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
docker.exec_driver: docker\-exec
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If this configuration option is not found, Salt will use the appropriate
interface (either \fI\%nsenter\fP or \fI\%lxc\-attach\fP) based on the \fBExecution Driver\fP
value returned from \fBdocker info\fP\&. \fI\%docker\-exec\fP will not be used by default,
as it is presently (as of version 1.6.2) only able to execute commands as the
effective user of the container. Thus, if a \fBUSER\fP directive was used to run
as a non\-privileged user, \fI\%docker\-exec\fP would be unable to perform the action as
root. Salt can still use \fI\%docker\-exec\fP as an execution driver, but must be
explicitly configured (as in the example above) to do so at this time.
.sp
If possible, try to manually specify the execution driver, as it will save Salt
a little work.
.sp
This execution module provides functions that shadow those from the \fI\%cmd\fP module. They are as follows:
.INDENT 0.0
.IP \(bu 2
\fI\%docker.retcode\fP
.IP \(bu 2
\fI\%docker.run\fP
.IP \(bu 2
\fI\%docker.run_all\fP
.IP \(bu 2
\fI\%docker.run_stderr\fP
.IP \(bu 2
\fI\%docker.run_stdout\fP
.IP \(bu 2
\fI\%docker.script\fP
.IP \(bu 2
\fI\%docker.script_retcode\fP
.UNINDENT
.SS Detailed Function Documentation
.INDENT 0.0
.TP
.B class  salt.modules.dockermod.DockerJSONDecoder(*, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, strict=True, object_pairs_hook=None)
.INDENT 7.0
.TP
.B decode(s, _w=None)
Return the Python representation of \fBs\fP (a \fBstr\fP instance
containing a JSON document).
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.apply_(name, mods=None, **kwargs)
New in version 2019.2.0.

.sp
Apply states! This function will call highstate or state.sls based on the
arguments passed in, \fBapply\fP is intended to be the main gateway for
all state executions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdocker\(aq docker.apply web01
salt \(aqdocker\(aq docker.apply web01 test
salt \(aqdocker\(aq docker.apply web01 test,pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.build(path=None, repository=None, tag=None, cache=True, rm=True, api_response=False, fileobj=None, dockerfile=None, buildargs=None)
Changed in version 2018.3.0: If the built image should be tagged, then the repository and tag must
now be passed separately using the \fBrepository\fP and \fBtag\fP
arguments, rather than together in the (now deprecated) \fBimage\fP
argument.

.sp
Builds a docker image from a Dockerfile or a URL
.INDENT 7.0
.TP
.B path
Path to directory on the Minion containing a Dockerfile
.TP
.B repository
Optional repository name for the image being built
.sp
New in version 2018.3.0.

.TP
.B tag
latest
Tag name for the image (required if \fBrepository\fP is passed)
.sp
New in version 2018.3.0.

.TP
.B image
Deprecated since version 2018.3.0: Use both \fBrepository\fP and \fBtag\fP instead

.TP
.B cache
True
Set to \fBFalse\fP to force the build process not to use the Docker image
cache, and pull all required intermediate image layers
.TP
.B rm
True
Remove intermediate containers created during build
.TP
.B api_response
False
If \fBTrue\fP: an \fBAPI_Response\fP key will be present in the return
data, containing the raw output from the Docker API.
.TP
.B fileobj
Allows for a file\-like object containing the contents of the Dockerfile
to be passed in place of a file \fBpath\fP argument. This argument should
not be used from the CLI, only from other Salt code.
.TP
.B dockerfile
Allows for an alternative Dockerfile to be specified. Path to
alternative Dockefile is relative to the build path for the Docker
container.
.sp
New in version 2016.11.0.

.TP
.B buildargs
A dictionary of build arguments provided to the docker build process.
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary containing one or more of the following keys:
.INDENT 7.0
.IP \(bu 2
\fBId\fP \- ID of the newly\-built image
.IP \(bu 2
\fBTime_Elapsed\fP \- Time in seconds taken to perform the build
.IP \(bu 2
\fBIntermediate_Containers\fP \- IDs of containers created during the course
of the build process
.sp
\fI(Only present if rm=False)\fP
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBImages\fP \- A dictionary containing one or more of the following keys:
.INDENT 7.0
.IP \(bu 2
\fBAlready_Pulled\fP \- Layers that that were already present on the
Minion
.IP \(bu 2
\fBPulled\fP \- Layers that that were pulled
.UNINDENT
.UNINDENT
.sp
\fI(Only present if the image specified by the \(dqrepository\(dq and \(dqtag\(dq
arguments was not present on the Minion, or if cache=False)\fP
.IP \(bu 2
\fBStatus\fP \- A string containing a summary of the pull action (usually a
message saying that an image was downloaded, or that it was up to date).
.sp
\fI(Only present if the image specified by the \(dqrepository\(dq and \(dqtag\(dq
arguments was not present on the Minion, or if cache=False)\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.build /path/to/docker/build/dir
salt myminion docker.build https://github.com/myuser/myrepo.git repository=myimage tag=latest
salt myminion docker.build /path/to/docker/build/dir dockerfile=Dockefile.different repository=myimage tag=dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.call(name, function, *args, **kwargs)
Executes a Salt function inside a running container
.sp
New in version 2016.11.0.

.sp
The container does not need to have Salt installed, but Python is required.
.INDENT 7.0
.TP
.B name
Container name or ID
.TP
.B function
Salt execution module function
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.call test.ping
salt myminion test.arg arg1 arg2 key1=val1
salt myminion dockerng.call compassionate_mirzakhani test.arg arg1 arg2 key1=val1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.commit(name, repository, tag=\(aqlatest\(aq, message=None, author=None)
Changed in version 2018.3.0: The repository and tag must now be passed separately using the
\fBrepository\fP and \fBtag\fP arguments, rather than together in the (now
deprecated) \fBimage\fP argument.

.sp
Commits a container, thereby promoting it to an image. Equivalent to
running the \fBdocker commit\fP Docker CLI command.
.INDENT 7.0
.TP
.B name
Container name or ID to commit
.TP
.B repository
Repository name for the image being committed
.sp
New in version 2018.3.0.

.TP
.B tag
latest
Tag name for the image
.sp
New in version 2018.3.0.

.TP
.B image
Deprecated since version 2018.3.0: Use both \fBrepository\fP and \fBtag\fP instead

.TP
.B message
Commit message (Optional)
.TP
.B author
Author name (Optional)
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBId\fP \- ID of the newly\-created image
.IP \(bu 2
\fBImage\fP \- Name of the newly\-created image
.IP \(bu 2
\fBTime_Elapsed\fP \- Time in seconds taken to perform the commit
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.commit mycontainer myuser/myimage mytag
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.compare_container(first, second, ignore=None)
This function is an alias of \fBcompare_containers\fP\&.
.INDENT 7.0
.INDENT 3.5
New in version 2017.7.0.

.sp
Changed in version 2018.3.0: Renamed from \fBdocker.compare_container\fP to
\fBdocker.compare_containers\fP (old function name remains as an alias)

.sp
Compare two containers\(aq Config and and HostConfig and return any
differences between the two.
.INDENT 0.0
.TP
.B first
Name or ID of first container
.TP
.B second
Name or ID of second container
.TP
.B ignore
A comma\-separated list (or Python list) of keys to ignore when
comparing. This is useful when comparing two otherwise identical
containers which have different hostnames.
.UNINDENT
.sp
CLI Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.compare_containers foo bar
salt myminion docker.compare_containers foo bar ignore=Hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.compare_container_networks(first, second)
New in version 2018.3.0.

.sp
Returns the differences between two containers\(aq networks. When a network is
only present one of the two containers, that network\(aqs diff will simply be
represented with \fBTrue\fP for the side of the diff in which the network is
present) and \fBFalse\fP for the side of the diff in which the network is
absent.
.sp
This function works by comparing the contents of both containers\(aq
\fBNetworks\fP keys (under \fBNetworkSettings\fP) in the return data from
\fI\%docker.inspect_container\fP\&. Because each network contains
some items that either A) only set at runtime, B) naturally varying from
container to container, or both, by default the following keys in each
network are examined:
.INDENT 7.0
.IP \(bu 2
\fBAliases\fP
.IP \(bu 2
\fBLinks\fP
.IP \(bu 2
\fBIPAMConfig\fP
.UNINDENT
.sp
The exception to this is if \fBIPAMConfig\fP is unset (i.e. null) in one
container but not the other. This happens when no static IP configuration
is set, and automatic IP configuration is in effect. So, in order to report
on changes between automatic IP configuration in one container and static
IP configuration in another container (as we need to do for the
\fI\%docker_container.running\fP
state), automatic IP configuration will also be checked in these cases.
.sp
This function uses the \fI\%docker.compare_container_networks\fP
minion config option to determine which keys to examine. This provides
flexibility in the event that features added in a future Docker release
necessitate changes to how Salt compares networks. In these cases, rather
than waiting for a new Salt release one can just set
\fI\%docker.compare_container_networks\fP\&.
.sp
Changed in version 3000: This config option can now also be set in pillar data and grains.
Additionally, it can be set in the master config file, provided that
\fBpillar_opts\fP is enabled on the minion.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The checks for automatic IP configuration described above only apply if
\fBIPAMConfig\fP is among the keys set for static IP checks in
\fI\%docker.compare_container_networks\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B first
Name or ID of first container (old)
.TP
.B second
Name or ID of second container (new)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.compare_container_networks foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.compare_containers(first, second, ignore=None)
New in version 2017.7.0.

.sp
Changed in version 2018.3.0: Renamed from \fBdocker.compare_container\fP to
\fBdocker.compare_containers\fP (old function name remains as an alias)

.sp
Compare two containers\(aq Config and and HostConfig and return any
differences between the two.
.INDENT 7.0
.TP
.B first
Name or ID of first container
.TP
.B second
Name or ID of second container
.TP
.B ignore
A comma\-separated list (or Python list) of keys to ignore when
comparing. This is useful when comparing two otherwise identical
containers which have different hostnames.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.compare_containers foo bar
salt myminion docker.compare_containers foo bar ignore=Hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.compare_networks(first, second, ignore=\(aqName,Id,Created,Containers\(aq)
New in version 2018.3.0.

.sp
Compare two networks and return any differences between the two
.INDENT 7.0
.TP
.B first
Name or ID of first container
.TP
.B second
Name or ID of second container
.TP
.B ignore
Name,Id,Created,Containers
A comma\-separated list (or Python list) of keys to ignore when
comparing.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.compare_network foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.connect_container_to_network(container, net_id, **kwargs)
New in version 2015.8.3.

.sp
Changed in version 2017.7.0: Support for \fBipv4_address\fP argument added

.sp
Changed in version 2018.3.0: All arguments are now passed through to
\fI\%connect_container_to_network()\fP, allowing for any new arguments added
to this function to be supported automagically.

.sp
Connect container to network. See the \fI\%connect_container_to_network()\fP
docs for information on supported arguments.
.INDENT 7.0
.TP
.B container
Container name or ID
.TP
.B net_id
Network name or ID
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.connect_container_to_network web\-1 mynet
salt myminion docker.connect_container_to_network web\-1 mynet ipv4_address=10.20.0.10
salt myminion docker.connect_container_to_network web\-1 1f9d2454d0872b68dd9e8744c6e7a4c66b86f10abaccc21e14f7f014f729b2bc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.connected(name, verbose=False)
New in version 2018.3.0.

.sp
Return a list of running containers attached to the specified network
.INDENT 7.0
.TP
.B name
Network name
.TP
.B verbose
False
If \fBTrue\fP, return extended info about each container (IP
configuration, etc.)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.connected net_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.copy_from(name, source, dest, overwrite=False, makedirs=False)
Copy a file from inside a container to the Minion
.INDENT 7.0
.TP
.B name
Container name
.TP
.B source
Path of the file on the container\(aqs filesystem
.TP
.B dest
Destination on the Minion. Must be an absolute path. If the destination
is a directory, the file will be copied into that directory.
.TP
.B overwrite
False
Unless this option is set to \fBTrue\fP, then if a file exists at the
location specified by the \fBdest\fP argument, an error will be raised.
.TP
.B makedirs
False
Create the parent directory on the container if it does not already
exist.
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A boolean (\fBTrue\fP if successful, otherwise \fBFalse\fP)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.copy_from mycontainer /var/log/nginx/access.log /home/myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.copy_to(name, source, dest, exec_driver=None, overwrite=False, makedirs=False)
Copy a file from the host into a container
.INDENT 7.0
.TP
.B name
Container name
.TP
.B source
File to be copied to the container. Can be a local path on the Minion
or a remote file from the Salt fileserver.
.TP
.B dest
Destination on the container. Must be an absolute path. If the
destination is a directory, the file will be copied into that
directory.
.TP
.B exec_driver
None
If not passed, the execution driver will be detected as described
\fI\%above\fP\&.
.TP
.B overwrite
False
Unless this option is set to \fBTrue\fP, then if a file exists at the
location specified by the \fBdest\fP argument, an error will be raised.
.TP
.B makedirs
False
Create the parent directory on the container if it does not already
exist.
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A boolean (\fBTrue\fP if successful, otherwise \fBFalse\fP)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.copy_to mycontainer /tmp/foo /root/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.cp(name, source, dest, overwrite=False, makedirs=False)
This function is an alias of \fBcopy_from\fP\&.
.INDENT 7.0
.INDENT 3.5
Copy a file from inside a container to the Minion
.INDENT 0.0
.TP
.B name
Container name
.TP
.B source
Path of the file on the container\(aqs filesystem
.TP
.B dest
Destination on the Minion. Must be an absolute path. If the destination
is a directory, the file will be copied into that directory.
.TP
.B overwrite
False
Unless this option is set to \fBTrue\fP, then if a file exists at the
location specified by the \fBdest\fP argument, an error will be raised.
.TP
.B makedirs
False
Create the parent directory on the container if it does not already
exist.
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A boolean (\fBTrue\fP if successful, otherwise \fBFalse\fP)
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.copy_from mycontainer /var/log/nginx/access.log /home/myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.create(image, name=None, start=False, skip_translate=None, ignore_collisions=False, validate_ip_addrs=True, client_timeout=60, **kwargs)
Create a new container
.INDENT 7.0
.TP
.B image
Image from which to create the container
.TP
.B name
Name for the new container. If not provided, Docker will randomly
generate one for you (it will be included in the return data).
.TP
.B start
False
If \fBTrue\fP, start container after creating it
.sp
New in version 2018.3.0.

.TP
.B skip_translate
This function translates Salt CLI or SLS input into the format which
docker\-py expects. However, in the event that Salt\(aqs translation logic
fails (due to potential changes in the Docker Remote API, or to bugs in
the translation code), this argument can be used to exert granular
control over which arguments are translated and which are not.
.sp
Pass this argument as a comma\-separated list (or Python list) of
arguments, and translation for each passed argument name will be
skipped. Alternatively, pass \fBTrue\fP and \fIall\fP translation will be
skipped.
.sp
Skipping tranlsation allows for arguments to be formatted directly in
the format which docker\-py expects. This allows for API changes and
other issues to be more easily worked around. An example of using this
option to skip translation would be:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.create image=centos:7.3.1611 skip_translate=environment environment=\(dq{\(aqFOO\(aq: \(aqbar\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See the following links for more information:
.INDENT 7.0
.IP \(bu 2
\fI\%docker\-py Low\-level API\fP
.IP \(bu 2
\fI\%Docker Engine API\fP
.UNINDENT
.TP
.B ignore_collisions
False
Since many of docker\-py\(aqs arguments differ in name from their CLI
counterparts (with which most Docker users are more familiar), Salt
detects usage of these and aliases them to the docker\-py version of
that argument. However, if both the alias and the docker\-py version of
the same argument (e.g. \fBenv\fP and \fBenvironment\fP) are used, an error
will be raised. Set this argument to \fBTrue\fP to suppress these errors
and keep the docker\-py version of the argument.
.TP
.B validate_ip_addrs
True
For parameters which accept IP addresses as input, IP address
validation will be performed. To disable, set this to \fBFalse\fP
.TP
.B client_timeout
60
Timeout in seconds for the Docker client. This is not a timeout for
this function, but for receiving a response from the API.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only used if Salt needs to pull the requested image.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBCONTAINER CONFIGURATION ARGUMENTS\fP
.INDENT 7.0
.TP
.B auto_remove (or \fIrm\fP)
False
Enable auto\-removal of the container on daemon side when the
container’s process exits (analogous to running a docker container with
\fB\-\-rm\fP on the CLI).
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBauto_remove=True\fP
.IP \(bu 2
\fBrm=True\fP
.UNINDENT
.TP
.B binds
Files/directories to bind mount. Each bind mount should be passed in
one of the following formats:
.INDENT 7.0
.IP \(bu 2
\fB<host_path>:<container_path>\fP \- \fBhost_path\fP is mounted within
the container as \fBcontainer_path\fP with read\-write access.
.IP \(bu 2
\fB<host_path>:<container_path>:<selinux_context>\fP \- \fBhost_path\fP is
mounted within the container as \fBcontainer_path\fP with read\-write
access. Additionally, the specified selinux context will be set
within the container.
.IP \(bu 2
\fB<host_path>:<container_path>:<read_only>\fP \- \fBhost_path\fP is
mounted within the container as \fBcontainer_path\fP, with the
read\-only or read\-write setting explicitly defined.
.IP \(bu 2
\fB<host_path>:<container_path>:<read_only>,<selinux_context>\fP \-
\fBhost_path\fP is mounted within the container as \fBcontainer_path\fP,
with the read\-only or read\-write setting explicitly defined.
Additionally, the specified selinux context will be set within the
container.
.UNINDENT
.sp
\fB<read_only>\fP can be either \fBro\fP for read\-write access, or \fBro\fP
for read\-only access. When omitted, it is assumed to be read\-write.
.sp
\fB<selinux_context>\fP can be \fBz\fP if the volume is shared between
multiple containers, or \fBZ\fP if the volume should be private.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When both \fB<read_only>\fP and \fB<selinux_context>\fP are specified,
there must be a comma before \fB<selinux_context>\fP\&.
.UNINDENT
.UNINDENT
.sp
Binds can be expressed as a comma\-separated list or a Python list,
however in cases where both ro/rw and an selinux context are specified,
the binds \fImust\fP be specified as a Python list.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBbinds=/srv/www:/var/www:ro\fP
.IP \(bu 2
\fBbinds=/srv/www:/var/www:rw\fP
.IP \(bu 2
\fBbinds=/srv/www:/var/www\fP
.IP \(bu 2
\fBbinds=\(dq[\(aq/srv/www:/var/www:ro,Z\(aq]\(dq\fP
.IP \(bu 2
\fBbinds=\(dq[\(aq/srv/www:/var/www:rw,Z\(aq]\(dq\fP
.IP \(bu 2
\fBbinds=/srv/www:/var/www:Z\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The second and third examples above are equivalent to each other,
as are the last two examples.
.UNINDENT
.UNINDENT
.TP
.B blkio_weight
Block IO weight (relative weight), accepts a weight value between 10
and 1000.
.sp
Example: \fBblkio_weight=100\fP
.TP
.B blkio_weight_device
Block IO weight (relative device weight), specified as a list of
expressions in the format \fBPATH:WEIGHT\fP
.sp
Example: \fBblkio_weight_device=/dev/sda:100\fP
.TP
.B cap_add
List of capabilities to add within the container. Can be passed as a
comma\-separated list or a Python list. Requires Docker 1.2.0 or
newer.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBcap_add=SYS_ADMIN,MKNOD\fP
.IP \(bu 2
\fBcap_add=\(dq[SYS_ADMIN, MKNOD]\(dq\fP
.UNINDENT
.TP
.B cap_drop
List of capabilities to drop within the container. Can be passed as a
comma\-separated string or a Python list. Requires Docker 1.2.0 or
newer.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBcap_drop=SYS_ADMIN,MKNOD\fP,
.IP \(bu 2
\fBcap_drop=\(dq[SYS_ADMIN, MKNOD]\(dq\fP
.UNINDENT
.TP
.B command (or \fIcmd\fP)
Command to run in the container
.sp
Example: \fBcommand=bash\fP or \fBcmd=bash\fP
.sp
Changed in version 2015.8.1: \fBcmd\fP is now also accepted

.TP
.B cpuset_cpus (or \fIcpuset\fP)
CPUs on which which to allow execution, specified as a string
containing a range (e.g. \fB0\-3\fP) or a comma\-separated list of CPUs
(e.g. \fB0,1\fP).
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBcpuset_cpus=\(dq0\-3\(dq\fP
.IP \(bu 2
\fBcpuset=\(dq0,1\(dq\fP
.UNINDENT
.TP
.B cpuset_mems
Memory nodes on which which to allow execution, specified as a string
containing a range (e.g. \fB0\-3\fP) or a comma\-separated list of MEMs
(e.g. \fB0,1\fP). Only effective on NUMA systems.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBcpuset_mems=\(dq0\-3\(dq\fP
.IP \(bu 2
\fBcpuset_mems=\(dq0,1\(dq\fP
.UNINDENT
.TP
.B cpu_group
The length of a CPU period in microseconds
.sp
Example: \fBcpu_group=100000\fP
.TP
.B cpu_period
Microseconds of CPU time that the container can get in a CPU period
.sp
Example: \fBcpu_period=50000\fP
.TP
.B cpu_shares
CPU shares (relative weight), specified as an integer between 2 and 1024.
.sp
Example: \fBcpu_shares=512\fP
.TP
.B detach
False
If \fBTrue\fP, run the container\(aqs command in the background (daemon
mode)
.sp
Example: \fBdetach=True\fP
.TP
.B devices
List of host devices to expose within the container
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBdevices=\(dq/dev/net/tun,/dev/xvda1:/dev/xvda1,/dev/xvdb1:/dev/xvdb1:r\(dq\fP
.IP \(bu 2
\fBdevices=\(dq[\(aq/dev/net/tun\(aq, \(aq/dev/xvda1:/dev/xvda1\(aq, \(aq/dev/xvdb1:/dev/xvdb1:r\(aq]\(dq\fP
.UNINDENT
.TP
.B device_read_bps
Limit read rate (bytes per second) from a device, specified as a list
of expressions in the format \fBPATH:RATE\fP, where \fBRATE\fP is either an
integer number of bytes, or a string ending in \fBkb\fP, \fBmb\fP, or
\fBgb\fP\&.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBdevice_read_bps=\(dq/dev/sda:1mb,/dev/sdb:5mb\(dq\fP
.IP \(bu 2
\fBdevice_read_bps=\(dq[\(aq/dev/sda:100mb\(aq, \(aq/dev/sdb:5mb\(aq]\(dq\fP
.UNINDENT
.TP
.B device_read_iops
Limit read rate (I/O per second) from a device, specified as a list
of expressions in the format \fBPATH:RATE\fP, where \fBRATE\fP is a number
of I/O operations.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBdevice_read_iops=\(dq/dev/sda:1000,/dev/sdb:500\(dq\fP
.IP \(bu 2
\fBdevice_read_iops=\(dq[\(aq/dev/sda:1000\(aq, \(aq/dev/sdb:500\(aq]\(dq\fP
.UNINDENT
.TP
.B device_write_bps
Limit write rate (bytes per second) from a device, specified as a list
of expressions in the format \fBPATH:RATE\fP, where \fBRATE\fP is either an
integer number of bytes, or a string ending in \fBkb\fP, \fBmb\fP or
\fBgb\fP\&.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBdevice_write_bps=\(dq/dev/sda:100mb,/dev/sdb:50mb\(dq\fP
.IP \(bu 2
\fBdevice_write_bps=\(dq[\(aq/dev/sda:100mb\(aq, \(aq/dev/sdb:50mb\(aq]\(dq\fP
.UNINDENT
.TP
.B device_write_iops
Limit write rate (I/O per second) from a device, specified as a list
of expressions in the format \fBPATH:RATE\fP, where \fBRATE\fP is a number
of I/O operations.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBdevice_write_iops=\(dq/dev/sda:1000,/dev/sdb:500\(dq\fP
.IP \(bu 2
\fBdevice_write_iops=\(dq[\(aq/dev/sda:1000\(aq, \(aq/dev/sdb:500\(aq]\(dq\fP
.UNINDENT
.TP
.B dns
List of DNS nameservers. Can be passed as a comma\-separated list or a
Python list.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBdns=8.8.8.8,8.8.4.4\fP
.IP \(bu 2
\fBdns=\(dq[\(aq8.8.8.8\(aq, \(aq8.8.4.4\(aq]\(dq\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To skip IP address validation, use \fBvalidate_ip_addrs=False\fP
.UNINDENT
.UNINDENT
.TP
.B dns_opt
Additional options to be added to the container’s \fBresolv.conf\fP file
.sp
Example: \fBdns_opt=ndots:9\fP
.TP
.B dns_search
List of DNS search domains. Can be passed as a comma\-separated list
or a Python list.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBdns_search=foo1.domain.tld,foo2.domain.tld\fP
.IP \(bu 2
\fBdns_search=\(dq[foo1.domain.tld, foo2.domain.tld]\(dq\fP
.UNINDENT
.TP
.B domainname
The domain name to use for the container
.sp
Example: \fBdomainname=domain.tld\fP
.TP
.B entrypoint
Entrypoint for the container. Either a string (e.g. \fB\(dqmycmd \-\-arg1
\-\-arg2\(dq\fP) or a Python list (e.g.  \fB\(dq[\(aqmycmd\(aq, \(aq\-\-arg1\(aq, \(aq\-\-arg2\(aq]\(dq\fP)
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBentrypoint=\(dqcat access.log\(dq\fP
.IP \(bu 2
\fBentrypoint=\(dq[\(aqcat\(aq, \(aqaccess.log\(aq]\(dq\fP
.UNINDENT
.TP
.B environment (or \fIenv\fP)
Either a dictionary of environment variable names and their values, or
a Python list of strings in the format \fBVARNAME=value\fP\&.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBenvironment=\(aqVAR1=value,VAR2=value\(aq\fP
.IP \(bu 2
\fBenvironment=\(dq[\(aqVAR1=value\(aq, \(aqVAR2=value\(aq]\(dq\fP
.IP \(bu 2
\fBenvironment=\(dq{\(aqVAR1\(aq: \(aqvalue\(aq, \(aqVAR2\(aq: \(aqvalue\(aq}\(dq\fP
.UNINDENT
.TP
.B extra_hosts
Additional hosts to add to the container\(aqs /etc/hosts file. Can be
passed as a comma\-separated list or a Python list. Requires Docker
1.3.0 or newer.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBextra_hosts=web1:10.9.8.7,web2:10.9.8.8\fP
.IP \(bu 2
\fBextra_hosts=\(dq[\(aqweb1:10.9.8.7\(aq, \(aqweb2:10.9.8.8\(aq]\(dq\fP
.IP \(bu 2
\fBextra_hosts=\(dq{\(aqweb1\(aq: \(aq10.9.8.7\(aq, \(aqweb2\(aq: \(aq10.9.8.8\(aq}\(dq\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To skip IP address validation, use \fBvalidate_ip_addrs=False\fP
.UNINDENT
.UNINDENT
.TP
.B group_add
List of additional group names and/or IDs that the container process
will run as
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBgroup_add=web,network\fP
.IP \(bu 2
\fBgroup_add=\(dq[\(aqweb\(aq, \(aqnetwork\(aq]\(dq\fP
.UNINDENT
.TP
.B hostname
Hostname of the container. If not provided, and if a \fBname\fP has been
provided, the \fBhostname\fP will default to the \fBname\fP that was
passed.
.sp
Example: \fBhostname=web1\fP
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
If the container is started with \fBnetwork_mode=host\fP, the
hostname will be overridden by the hostname of the Minion.
.UNINDENT
.UNINDENT
.TP
.B interactive (or \fIstdin_open\fP): False
Leave stdin open, even if not attached
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBinteractive=True\fP
.IP \(bu 2
\fBstdin_open=True\fP
.UNINDENT
.TP
.B ipc_mode (or \fIipc\fP)
Set the IPC mode for the container. The default behavior is to create a
private IPC namespace for the container, but this option can be
used to change that behavior:
.INDENT 7.0
.IP \(bu 2
\fBcontainer:<container_name_or_id>\fP reuses another container shared
memory, semaphores and message queues
.IP \(bu 2
\fBhost\fP: use the host\(aqs shared memory, semaphores and message queues
.UNINDENT
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBipc_mode=container:foo\fP
.IP \(bu 2
\fBipc=host\fP
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Using \fBhost\fP gives the container full access to local shared
memory and is therefore considered insecure.
.UNINDENT
.UNINDENT
.TP
.B isolation
Specifies the type of isolation technology used by containers
.sp
Example: \fBisolation=hyperv\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The default value on Windows server is \fBprocess\fP, while the
default value on Windows client is \fBhyperv\fP\&. On Linux, only
\fBdefault\fP is supported.
.UNINDENT
.UNINDENT
.TP
.B labels (or \fIlabel\fP)
Add metadata to the container. Labels can be set both with and without
values:
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBlabels=foo,bar=baz\fP
.IP \(bu 2
\fBlabels=\(dq[\(aqfoo\(aq, \(aqbar=baz\(aq]\(dq\fP
.UNINDENT
.sp
Changed in version 2018.3.0: Labels both with and without values can now be mixed. Earlier
releases only permitted one method or the other.

.TP
.B links
Link this container to another. Links should be specified in the format
\fB<container_name_or_id>:<link_alias>\fP\&. Multiple links can be passed,
ether as a comma separated list or a Python list.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBlinks=web1:link1,web2:link2\fP,
.IP \(bu 2
\fBlinks=\(dq[\(aqweb1:link1\(aq, \(aqweb2:link2\(aq]\(dq\fP
.IP \(bu 2
\fBlinks=\(dq{\(aqweb1\(aq: \(aqlink1\(aq, \(aqweb2\(aq: \(aqlink2\(aq}\(dq\fP
.UNINDENT
.TP
.B log_driver
Set container\(aqs logging driver. Requires Docker 1.6 or newer.
.sp
Example:
.INDENT 7.0
.IP \(bu 2
\fBlog_driver=syslog\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The logging driver feature was improved in Docker 1.13 introducing
option name changes. Please see Docker\(aqs \fI\%Configure logging
drivers\fP documentation for more information.
.UNINDENT
.UNINDENT
.TP
.B log_opt
Config options for the \fBlog_driver\fP config option. Requires Docker
1.6 or newer.
.sp
Example:
.INDENT 7.0
.IP \(bu 2
\fBlog_opt=\(dqsyslog\-address=tcp://192.168.0.42,syslog\-facility=daemon\(dq\fP
.IP \(bu 2
\fBlog_opt=\(dq[\(aqsyslog\-address=tcp://192.168.0.42\(aq, \(aqsyslog\-facility=daemon\(aq]\(dq\fP
.IP \(bu 2
\fBlog_opt=\(dq{\(aqsyslog\-address\(aq: \(aqtcp://192.168.0.42\(aq, \(aqsyslog\-facility\(aq: \(aqdaemon\(aq}\(dq\fP
.UNINDENT
.TP
.B lxc_conf
Additional LXC configuration parameters to set before starting the
container.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBlxc_conf=\(dqlxc.utsname=docker,lxc.arch=x86_64\(dq\fP
.IP \(bu 2
\fBlxc_conf=\(dq[\(aqlxc.utsname=docker\(aq, \(aqlxc.arch=x86_64\(aq]\(dq\fP
.IP \(bu 2
\fBlxc_conf=\(dq{\(aqlxc.utsname\(aq: \(aqdocker\(aq, \(aqlxc.arch\(aq: \(aqx86_64\(aq}\(dq\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
These LXC configuration parameters will only have the desired
effect if the container is using the LXC execution driver, which
has been deprecated for some time.
.UNINDENT
.UNINDENT
.TP
.B mac_address
MAC address to use for the container. If not specified, a random MAC
address will be used.
.sp
Example: \fBmac_address=01:23:45:67:89:0a\fP
.TP
.B mem_limit (or \fImemory\fP)
0
Memory limit. Can be specified in bytes or using single\-letter units
(i.e. \fB512M\fP, \fB2G\fP, etc.). A value of \fB0\fP (the default) means no
memory limit.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBmem_limit=512M\fP
.IP \(bu 2
\fBmemory=1073741824\fP
.UNINDENT
.TP
.B mem_swappiness
Tune a container\(aqs memory swappiness behavior. Accepts an integer
between 0 and 100.
.sp
Example: \fBmem_swappiness=60\fP
.TP
.B memswap_limit (or \fImemory_swap\fP)
\-1
Total memory limit (memory plus swap). Set to \fB\-1\fP to disable swap. A
value of \fB0\fP means no swap limit.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBmemswap_limit=1G\fP
.IP \(bu 2
\fBmemory_swap=2147483648\fP
.UNINDENT
.TP
.B network_disabled
False
If \fBTrue\fP, networking will be disabled within the container
.sp
Example: \fBnetwork_disabled=True\fP
.TP
.B network_mode
bridge
One of the following:
.INDENT 7.0
.IP \(bu 2
\fBbridge\fP \- Creates a new network stack for the container on the
docker bridge
.IP \(bu 2
\fBnone\fP \- No networking (equivalent of the Docker CLI argument
\fB\-\-net=none\fP). Not to be confused with Python\(aqs \fBNone\fP\&.
.IP \(bu 2
\fBcontainer:<name_or_id>\fP \- Reuses another container\(aqs network stack
.IP \(bu 2
\fBhost\fP \- Use the host\(aqs network stack inside the container
.sp
\fBWARNING:\fP
.INDENT 2.0
.INDENT 3.5
Using \fBhost\fP mode gives the container full access to the hosts
system\(aqs services (such as D\-Bus), and is therefore considered
insecure.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBnetwork_mode=null\fP
.IP \(bu 2
\fBnetwork_mode=container:web1\fP
.UNINDENT
.TP
.B oom_kill_disable
Whether to disable OOM killer
.sp
Example: \fBoom_kill_disable=False\fP
.TP
.B oom_score_adj
An integer value containing the score given to the container in order
to tune OOM killer preferences
.sp
Example: \fBoom_score_adj=500\fP
.TP
.B pid_mode
Set to \fBhost\fP to use the host container\(aqs PID namespace within the
container. Requires Docker 1.5.0 or newer.
.sp
Example: \fBpid_mode=host\fP
.TP
.B pids_limit
Set the container\(aqs PID limit. Set to \fB\-1\fP for unlimited.
.sp
Example: \fBpids_limit=2000\fP
.TP
.B port_bindings (or \fIpublish\fP)
Bind exposed ports which were exposed using the \fBports\fP argument to
\fI\%docker.create\fP\&. These
should be passed in the same way as the \fB\-\-publish\fP argument to the
\fBdocker run\fP CLI command:
.INDENT 7.0
.IP \(bu 2
\fBip:hostPort:containerPort\fP \- Bind a specific IP and port on the
host to a specific port within the container.
.IP \(bu 2
\fBip::containerPort\fP \- Bind a specific IP and an ephemeral port to a
specific port within the container.
.IP \(bu 2
\fBhostPort:containerPort\fP \- Bind a specific port on all of the
host\(aqs interfaces to a specific port within the container.
.IP \(bu 2
\fBcontainerPort\fP \- Bind an ephemeral port on all of the host\(aqs
interfaces to a specific port within the container.
.UNINDENT
.sp
Multiple bindings can be separated by commas, or passed as a Python
list. The below two examples are equivalent:
.INDENT 7.0
.IP \(bu 2
\fBport_bindings=\(dq5000:5000,2123:2123/udp,8080\(dq\fP
.IP \(bu 2
\fBport_bindings=\(dq[\(aq5000:5000\(aq, \(aq2123:2123/udp\(aq, 8080]\(dq\fP
.UNINDENT
.sp
Port bindings can also include ranges:
.INDENT 7.0
.IP \(bu 2
\fBport_bindings=\(dq14505\-14506:4505\-4506\(dq\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When specifying a protocol, it must be passed in the
\fBcontainerPort\fP value, as seen in the examples above.
.UNINDENT
.UNINDENT
.TP
.B ports
A list of ports to expose on the container. Can be passed as
comma\-separated list or a Python list. If the protocol is omitted, the
port will be assumed to be a TCP port.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBports=1111,2222/udp\fP
.IP \(bu 2
\fBports=\(dq[1111, \(aq2222/udp\(aq]\(dq\fP
.UNINDENT
.TP
.B privileged
False
If \fBTrue\fP, runs the exec process with extended privileges
.sp
Example: \fBprivileged=True\fP
.TP
.B publish_all_ports (or \fIpublish_all\fP): False
Publish all ports to the host
.sp
Example: \fBpublish_all_ports=True\fP
.TP
.B read_only
False
If \fBTrue\fP, mount the container’s root filesystem as read only
.sp
Example: \fBread_only=True\fP
.TP
.B restart_policy (or \fIrestart\fP)
Set a restart policy for the container. Must be passed as a string in
the format \fBpolicy[:retry_count]\fP where \fBpolicy\fP is one of
\fBalways\fP, \fBunless\-stopped\fP, or \fBon\-failure\fP, and \fBretry_count\fP
is an optional limit to the number of retries. The retry count is ignored
when using the \fBalways\fP or \fBunless\-stopped\fP restart policy.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBrestart_policy=on\-failure:5\fP
.IP \(bu 2
\fBrestart_policy=always\fP
.UNINDENT
.TP
.B security_opt
Security configuration for MLS systems such as SELinux and AppArmor.
Can be passed as a comma\-separated list or a Python list.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBsecurity_opt=apparmor:unconfined,param2:value2\fP
.IP \(bu 2
\fBsecurity_opt=\(aq[\(dqapparmor:unconfined\(dq, \(dqparam2:value2\(dq]\(aq\fP
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
Some security options can contain commas. In these cases, this
argument \fImust\fP be passed as a Python list, as splitting by comma
will result in an invalid configuration.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
See the documentation for security_opt at
\fI\%https://docs.docker.com/engine/reference/run/#security\-configuration\fP
.UNINDENT
.UNINDENT
.TP
.B shm_size
Size of /dev/shm
.sp
Example: \fBshm_size=128M\fP
.TP
.B stop_signal
The signal used to stop the container. The default is \fBSIGTERM\fP\&.
.sp
Example: \fBstop_signal=SIGRTMIN+3\fP
.TP
.B stop_timeout
Timeout to stop the container, in seconds
.sp
Example: \fBstop_timeout=5\fP
.TP
.B storage_opt
Storage driver options for the container
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBstorage_opt=\(aqdm.basesize=40G\(aq\fP
.IP \(bu 2
\fBstorage_opt=\(dq[\(aqdm.basesize=40G\(aq]\(dq\fP
.IP \(bu 2
\fBstorage_opt=\(dq{\(aqdm.basesize\(aq: \(aq40G\(aq}\(dq\fP
.UNINDENT
.TP
.B sysctls (or \fIsysctl\fP)
Set sysctl options for the container
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBsysctl=\(aqfs.nr_open=1048576,kernel.pid_max=32768\(aq\fP
.IP \(bu 2
\fBsysctls=\(dq[\(aqfs.nr_open=1048576\(aq, \(aqkernel.pid_max=32768\(aq]\(dq\fP
.IP \(bu 2
\fBsysctls=\(dq{\(aqfs.nr_open\(aq: \(aq1048576\(aq, \(aqkernel.pid_max\(aq: \(aq32768\(aq}\(dq\fP
.UNINDENT
.TP
.B tmpfs
A map of container directories which should be replaced by tmpfs
mounts, and their corresponding mount options. Can be passed as Python
list of PATH:VALUE mappings, or a Python dictionary. However, since
commas usually appear in the values, this option \fIcannot\fP be passed as
a comma\-separated list.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBtmpfs=\(dq[\(aq/run:rw,noexec,nosuid,size=65536k\(aq, \(aq/var/lib/mysql:rw,noexec,nosuid,size=600m\(aq]\(dq\fP
.IP \(bu 2
\fBtmpfs=\(dq{\(aq/run\(aq: \(aqrw,noexec,nosuid,size=65536k\(aq, \(aq/var/lib/mysql\(aq: \(aqrw,noexec,nosuid,size=600m\(aq}\(dq\fP
.UNINDENT
.TP
.B tty
False
Attach TTYs
.sp
Example: \fBtty=True\fP
.TP
.B ulimits (or \fIulimit\fP)
List of ulimits. These limits should be passed in the format
\fB<ulimit_name>:<soft_limit>:<hard_limit>\fP, with the hard limit being
optional. Can be passed as a comma\-separated list or a Python list.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBulimits=\(dqnofile=1024:1024,nproc=60\(dq\fP
.IP \(bu 2
\fBulimits=\(dq[\(aqnofile=1024:1024\(aq, \(aqnproc=60\(aq]\(dq\fP
.UNINDENT
.TP
.B user
User under which to run exec process
.sp
Example: \fBuser=foo\fP
.TP
.B userns_mode (or \fIuser_ns_mode\fP)
Sets the user namsepace mode, when the user namespace remapping option
is enabled.
.sp
Example: \fBuserns_mode=host\fP
.TP
.B volumes (or \fIvolume\fP)
List of directories to expose as volumes. Can be passed as a
comma\-separated list or a Python list.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBvolumes=/mnt/vol1,/mnt/vol2\fP
.IP \(bu 2
\fBvolume=\(dq[\(aq/mnt/vol1\(aq, \(aq/mnt/vol2\(aq]\(dq\fP
.UNINDENT
.TP
.B volumes_from
Container names or IDs from which the container will get volumes. Can
be passed as a comma\-separated list or a Python list.
.sp
Example: \fBvolumes_from=foo\fP, \fBvolumes_from=foo,bar\fP,
\fBvolumes_from=\(dq[foo, bar]\(dq\fP
.TP
.B volume_driver
Sets the container\(aqs volume driver
.sp
Example: \fBvolume_driver=foobar\fP
.TP
.B working_dir (or \fIworkdir\fP)
Working directory inside the container
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBworking_dir=/var/log/nginx\fP
.IP \(bu 2
\fBworkdir=/var/www/myapp\fP
.UNINDENT
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBId\fP \- ID of the newly\-created container
.IP \(bu 2
\fBName\fP \- Name of the newly\-created container
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Create a data\-only container
salt myminion docker.create myuser/mycontainer volumes=\(dq/mnt/vol1,/mnt/vol2\(dq
# Create a CentOS 7 container that will stay running once started
salt myminion docker.create centos:7 name=mycent7 interactive=True tty=True command=bash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.create_network(name, skip_translate=None, ignore_collisions=False, validate_ip_addrs=True, client_timeout=60, **kwargs)
Changed in version 2018.3.0: Support added for network configuration options other than \fBdriver\fP
and \fBdriver_opts\fP, as well as IPAM configuration.

.sp
Create a new network
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function supports all arguments for network and IPAM pool
configuration which are available for the release of docker\-py
installed on the minion. For that reason, the arguments described below
in the \fI\%NETWORK CONFIGURATION ARGUMENTS\fP and \fI\%IP ADDRESS
MANAGEMENT (IPAM)\fP
sections may not accurately reflect what is available on the minion.
The \fI\%docker.get_client_args\fP function can be used to check
the available arguments for the installed version of docker\-py (they
are found in the \fBnetwork_config\fP and \fBipam_config\fP sections of the
return data), but Salt will not prevent a user from attempting to use
an argument which is unsupported in the release of Docker which is
installed. In those cases, network creation be attempted but will fail.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Network name
.TP
.B skip_translate
This function translates Salt CLI or SLS input into the format which
docker\-py expects. However, in the event that Salt\(aqs translation logic
fails (due to potential changes in the Docker Remote API, or to bugs in
the translation code), this argument can be used to exert granular
control over which arguments are translated and which are not.
.sp
Pass this argument as a comma\-separated list (or Python list) of
arguments, and translation for each passed argument name will be
skipped. Alternatively, pass \fBTrue\fP and \fIall\fP translation will be
skipped.
.sp
Skipping tranlsation allows for arguments to be formatted directly in
the format which docker\-py expects. This allows for API changes and
other issues to be more easily worked around. See the following links
for more information:
.INDENT 7.0
.IP \(bu 2
\fI\%docker\-py Low\-level API\fP
.IP \(bu 2
\fI\%Docker Engine API\fP
.UNINDENT
.sp
New in version 2018.3.0.

.TP
.B ignore_collisions
False
Since many of docker\-py\(aqs arguments differ in name from their CLI
counterparts (with which most Docker users are more familiar), Salt
detects usage of these and aliases them to the docker\-py version of
that argument. However, if both the alias and the docker\-py version of
the same argument (e.g. \fBoptions\fP and \fBdriver_opts\fP) are used, an error
will be raised. Set this argument to \fBTrue\fP to suppress these errors
and keep the docker\-py version of the argument.
.sp
New in version 2018.3.0.

.TP
.B validate_ip_addrs
True
For parameters which accept IP addresses as input, IP address
validation will be performed. To disable, set this to \fBFalse\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When validating subnets, whether or not the IP portion of the
subnet is a valid subnet boundary will not be checked. The IP will
portion will be validated, and the subnet size will be checked to
confirm it is a valid number (1\-32 for IPv4, 1\-128 for IPv6).
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.UNINDENT
.sp
\fBNETWORK CONFIGURATION ARGUMENTS\fP
.INDENT 7.0
.TP
.B driver
Network driver
.sp
Example: \fBdriver=macvlan\fP
.TP
.B driver_opts (or \fIdriver_opt\fP, or \fIoptions\fP)
Options for the network driver. Either a dictionary of option names and
values or a Python list of strings in the format \fBvarname=value\fP\&.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBdriver_opts=\(aqmacvlan_mode=bridge,parent=eth0\(aq\fP
.IP \(bu 2
\fBdriver_opts=\(dq[\(aqmacvlan_mode=bridge\(aq, \(aqparent=eth0\(aq]\(dq\fP
.IP \(bu 2
\fBdriver_opts=\(dq{\(aqmacvlan_mode\(aq: \(aqbridge\(aq, \(aqparent\(aq: \(aqeth0\(aq}\(dq\fP
.UNINDENT
.TP
.B check_duplicate
True
If \fBTrue\fP, checks for networks with duplicate names. Since networks
are primarily keyed based on a random ID and not on the name, and
network name is strictly a user\-friendly alias to the network which is
uniquely identified using ID, there is no guaranteed way to check for
duplicates. This option providess a best effort, checking for any
networks which have the same name, but it is not guaranteed to catch
all name collisions.
.sp
Example: \fBcheck_duplicate=False\fP
.TP
.B internal
False
If \fBTrue\fP, restricts external access to the network
.sp
Example: \fBinternal=True\fP
.TP
.B labels
Add metadata to the network. Labels can be set both with and without
values:
.sp
Examples (\fIwith\fP values):
.INDENT 7.0
.IP \(bu 2
\fBlabels=\(dqlabel1=value1,label2=value2\(dq\fP
.IP \(bu 2
\fBlabels=\(dq[\(aqlabel1=value1\(aq, \(aqlabel2=value2\(aq]\(dq\fP
.IP \(bu 2
\fBlabels=\(dq{\(aqlabel1\(aq: \(aqvalue1\(aq, \(aqlabel2\(aq: \(aqvalue2\(aq}\(dq\fP
.UNINDENT
.sp
Examples (\fIwithout\fP values):
.INDENT 7.0
.IP \(bu 2
\fBlabels=label1,label2\fP
.IP \(bu 2
\fBlabels=\(dq[\(aqlabel1\(aq, \(aqlabel2\(aq]\(dq\fP
.UNINDENT
.TP
.B enable_ipv6 (or \fIipv6\fP)
False
Enable IPv6 on the network
.sp
Example: \fBenable_ipv6=True\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
While it should go without saying, this argument must be set to
\fBTrue\fP to \fI\%configure an IPv6 subnet\fP\&. Also, if this option is
turned on without an IPv6 subnet explicitly configured, you will
get an error unless you have set up a fixed IPv6 subnet. Consult
the \fI\%Docker IPv6 docs\fP for information on how to do this.
.UNINDENT
.UNINDENT
.TP
.B attachable
False
If \fBTrue\fP, and the network is in the global scope, non\-service
containers on worker nodes will be able to connect to the network.
.sp
Example: \fBattachable=True\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
While support for this option was added in API version 1.24, its
value was not added to the inpsect results until API version 1.26.
The version of Docker which is available for CentOS 7 runs API
version 1.24, meaning that while Salt can pass this argument to the
API, it has no way of knowing the value of this config option in an
existing Docker network.
.UNINDENT
.UNINDENT
.TP
.B scope
Specify the network\(aqs scope (\fBlocal\fP, \fBglobal\fP or \fBswarm\fP)
.sp
Example: \fBscope=local\fP
.TP
.B ingress
False
If \fBTrue\fP, create an ingress network which provides the routing\-mesh in
swarm mode
.sp
Example: \fBingress=True\fP
.UNINDENT
.sp
\fBIP ADDRESS MANAGEMENT (IPAM)\fP
.sp
This function supports networks with either IPv4, or both IPv4 and IPv6. If
configuring IPv4, then you can pass the IPAM arguments as shown below, as
individual arguments on the Salt CLI. However, if configuring IPv4 and
IPv6, the arguments must be passed as a list of dictionaries, in the
\fBipam_pools\fP argument. See the \fBCLI Examples\fP below. \fI\%These docs\fP also
have more information on these arguments.
.sp
\fIIPAM ARGUMENTS\fP
.INDENT 7.0
.TP
.B ipam_driver
IPAM driver to use, if different from the default one
.sp
Example: \fBipam_driver=foo\fP
.TP
.B ipam_opts
Options for the IPAM driver. Either a dictionary of option names
and values or a Python list of strings in the format
\fBvarname=value\fP\&.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBipam_opts=\(aqfoo=bar,baz=qux\(aq\fP
.IP \(bu 2
\fBipam_opts=\(dq[\(aqfoo=bar\(aq, \(aqbaz=quz\(aq]\(dq\fP
.IP \(bu 2
\fBipam_opts=\(dq{\(aqfoo\(aq: \(aqbar\(aq, \(aqbaz\(aq: \(aqqux\(aq}\(dq\fP
.UNINDENT
.UNINDENT
.sp
\fIIPAM POOL ARGUMENTS\fP
.INDENT 7.0
.TP
.B subnet
Subnet in CIDR format that represents a network segment
.sp
Example: \fBsubnet=192.168.50.0/25\fP
.TP
.B iprange (or \fIip_range\fP)
Allocate container IP from a sub\-range within the subnet
.sp
Subnet in CIDR format that represents a network segment
.sp
Example: \fBiprange=192.168.50.64/26\fP
.TP
.B gateway
IPv4 gateway for the master subnet
.sp
Example: \fBgateway=192.168.50.1\fP
.TP
.B aux_addresses (or \fIaux_address\fP)
A dictionary of mapping container names to IP addresses which should be
allocated for them should they connect to the network. Either a
dictionary of option names and values or a Python list of strings in
the format \fBhost=ipaddr\fP\&.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBaux_addresses=\(aqfoo.bar.tld=192.168.50.10,hello.world.tld=192.168.50.11\(aq\fP
.IP \(bu 2
\fBaux_addresses=\(dq[\(aqfoo.bar.tld=192.168.50.10\(aq, \(aqhello.world.tld=192.168.50.11\(aq]\(dq\fP
.IP \(bu 2
\fBaux_addresses=\(dq{\(aqfoo.bar.tld\(aq: \(aq192.168.50.10\(aq, \(aqhello.world.tld\(aq: \(aq192.168.50.11\(aq}\(dq\fP
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.create_network web_network driver=bridge
# IPv4
salt myminion docker.create_network macvlan_network driver=macvlan driver_opts=\(dq{\(aqparent\(aq:\(aqeth0\(aq}\(dq gateway=172.20.0.1 subnet=172.20.0.0/24
# IPv4 and IPv6
salt myminion docker.create_network mynet ipam_pools=\(aq[{\(dqsubnet\(dq: \(dq10.0.0.0/24\(dq, \(dqgateway\(dq: \(dq10.0.0.1\(dq}, {\(dqsubnet\(dq: \(dqfe3f:2180:26:1::60/123\(dq, \(dqgateway\(dq: \(dqfe3f:2180:26:1::61\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.create_volume(name, driver=None, driver_opts=None)
Create a new volume
.sp
New in version 2015.8.4.

.INDENT 7.0
.TP
.B name
name of volume
.TP
.B driver
Driver of the volume
.TP
.B driver_opts
Options for the driver volume
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.create_volume my_volume driver=local
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.dangling(prune=False, force=False)
Return top\-level images (those on which no other images depend) which do
not have a tag assigned to them. These include:
.INDENT 7.0
.IP \(bu 2
Images which were once tagged but were later untagged, such as those
which were superseded by committing a new copy of an existing tagged
image.
.IP \(bu 2
Images which were loaded using \fI\%docker.load\fP (or the \fBdocker load\fP Docker CLI
command), but not tagged.
.UNINDENT
.INDENT 7.0
.TP
.B prune
False
Remove these images
.TP
.B force
False
If \fBTrue\fP, and if \fBprune=True\fP, then forcibly remove these images.
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
If \fBprune=False\fP, the return data will be a list of dangling image IDs.
.sp
If \fBprune=True\fP, the return data will be a dictionary with each key being
the ID of the dangling image, and the following information for each image:
.INDENT 7.0
.IP \(bu 2
\fBComment\fP \- Any error encountered when trying to prune a dangling image
.sp
\fI(Only present if prune failed)\fP
.IP \(bu 2
\fBRemoved\fP \- A boolean (\fBTrue\fP if prune was successful, \fBFalse\fP if
not)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.dangling
salt myminion docker.dangling prune=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.depends(name)
Returns the containers and images, if any, which depend on the given image
.INDENT 7.0
.TP
.B name
Name or ID of image
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBContainers\fP \- A list of containers which depend on the specified image
.IP \(bu 2
\fBImages\fP \- A list of IDs of images which depend on the specified image
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.depends myimage
salt myminion docker.depends 0123456789ab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.diff(name)
Get information on changes made to container\(aqs filesystem since it was
created. Equivalent to running the \fBdocker diff\fP Docker CLI command.
.INDENT 7.0
.TP
.B name
Container name or ID
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary containing any of the following keys:
.INDENT 7.0
.IP \(bu 2
\fBAdded\fP \- A list of paths that were added.
.IP \(bu 2
\fBChanged\fP \- A list of paths that were changed.
.IP \(bu 2
\fBDeleted\fP \- A list of paths that were deleted.
.UNINDENT
.sp
These keys will only be present if there were changes, so if the container
has no differences the return dict will be empty.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.diff mycontainer
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.disconnect_all_containers_from_network(network_id)
New in version 2018.3.0.

.sp
Runs \fI\%docker.disconnect_container_from_network\fP on all
containers connected to the specified network, and returns the names of all
containers that were disconnected.
.INDENT 7.0
.TP
.B network_id
Network name or ID
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.disconnect_all_containers_from_network mynet
salt myminion docker.disconnect_all_containers_from_network 1f9d2454d0872b68dd9e8744c6e7a4c66b86f10abaccc21e14f7f014f729b2bc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.disconnect_container_from_network(container, network_id)
New in version 2015.8.3.

.sp
Disconnect container from network
.INDENT 7.0
.TP
.B container
Container name or ID
.TP
.B network_id
Network name or ID
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.disconnect_container_from_network web\-1 mynet
salt myminion docker.disconnect_container_from_network web\-1 1f9d2454d0872b68dd9e8744c6e7a4c66b86f10abaccc21e14f7f014f729b2bc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.exists(name)
Check if a given container exists
.INDENT 7.0
.TP
.B name
Container name or ID
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A boolean (\fBTrue\fP if the container exists, otherwise \fBFalse\fP)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.exists mycontainer
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.export(name, path, overwrite=False, makedirs=False, compression=None, **kwargs)
Exports a container to a tar archive. It can also optionally compress that
tar archive, and push it up to the Master.
.INDENT 7.0
.TP
.B name
Container name or ID
.TP
.B path
Absolute path on the Minion where the container will be exported
.TP
.B overwrite
False
Unless this option is set to \fBTrue\fP, then if a file exists at the
location specified by the \fBpath\fP argument, an error will be raised.
.TP
.B makedirs
False
If \fBTrue\fP, then if the parent directory of the file specified by the
\fBpath\fP argument does not exist, Salt will attempt to create it.
.TP
.B compression
None
Can be set to any of the following:
.INDENT 7.0
.IP \(bu 2
\fBgzip\fP or \fBgz\fP for gzip compression
.IP \(bu 2
\fBbzip2\fP or \fBbz2\fP for bzip2 compression
.IP \(bu 2
\fBxz\fP or \fBlzma\fP for XZ compression (requires \fI\%xz\-utils\fP, as well
as the \fBlzma\fP module from Python 3.3, available in Python 2 and
Python 3.0\-3.2 as \fI\%backports.lzma\fP)
.UNINDENT
.sp
This parameter can be omitted and Salt will attempt to determine the
compression type by examining the filename passed in the \fBpath\fP
parameter.
.TP
.B push
False
If \fBTrue\fP, the container will be pushed to the master using
\fI\%cp.push\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This requires \fI\%file_recv\fP to be set to \fBTrue\fP on the
Master.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary will containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBPath\fP \- Path of the file that was exported
.IP \(bu 2
\fBPush\fP \- Reports whether or not the file was successfully pushed to the
Master
.sp
\fI(Only present if push=True)\fP
.IP \(bu 2
\fBSize\fP \- Size of the file, in bytes
.IP \(bu 2
\fBSize_Human\fP \- Size of the file, in human\-readable units
.IP \(bu 2
\fBTime_Elapsed\fP \- Time in seconds taken to perform the export
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.export mycontainer /tmp/mycontainer.tar
salt myminion docker.export mycontainer /tmp/mycontainer.tar.xz push=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.freeze(name)
This function is an alias of \fBpause\fP\&.
.INDENT 7.0
.INDENT 3.5
Pauses a container
.INDENT 0.0
.TP
.B name
Container name or ID
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary will be returned, containing the following keys:
.INDENT 0.0
.IP \(bu 2
\fBstatus\fP \- A dictionary showing the prior state of the container as
well as the new state
.IP \(bu 2
\fBresult\fP \- A boolean noting whether or not the action was successful
.IP \(bu 2
\fBcomment\fP \- Only present if the container cannot be paused
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.pause mycontainer
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.get_client_args(limit=None)
New in version 2016.3.6,2016.11.4,2017.7.0.

.sp
Changed in version 2017.7.0: Replaced the container config args with the ones from the API\(aqs
\fBcreate_container\fP function.

.sp
Changed in version 2018.3.0: Added ability to limit the input to specific client functions

.sp
Many functions in Salt have been written to support the full list of
arguments for a given function in the \fI\%docker\-py Low\-level API\fP\&. However,
depending on the version of docker\-py installed on the minion, the
available arguments may differ. This function will get the arguments for
various functions in the installed version of docker\-py, to be used as a
reference.
.INDENT 7.0
.TP
.B limit
An optional list of categories for which to limit the return. This is
useful if only a specific set of arguments is desired, and also keeps
other function\(aqs argspecs from needlessly being examined.
.UNINDENT
.sp
\fBAVAILABLE LIMITS\fP
.INDENT 7.0
.IP \(bu 2
\fBcreate_container\fP \- arguments accepted by \fI\%create_container()\fP (used
by \fI\%docker.create\fP)
.IP \(bu 2
\fBhost_config\fP \- arguments accepted by \fI\%create_host_config()\fP (used to
build the host config for \fI\%docker.create\fP)
.IP \(bu 2
\fBconnect_container_to_network\fP \- arguments used by
\fI\%connect_container_to_network()\fP to construct an endpoint config when
connecting to a network (used by
\fI\%docker.connect_container_to_network\fP)
.IP \(bu 2
\fBcreate_network\fP \- arguments accepted by \fI\%create_network()\fP (used by
\fI\%docker.create_network\fP)
.IP \(bu 2
\fBipam_config\fP \- arguments used to create an \fI\%IPAM pool\fP (used by
\fI\%docker.create_network\fP
in the process of constructing an IPAM config dictionary)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.get_client_args
salt myminion docker.get_client_args logs
salt myminion docker.get_client_args create_container,connect_container_to_network
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.highstate(name, saltenv=\(aqbase\(aq, **kwargs)
Apply a highstate to the running container
.sp
New in version 2019.2.0.

.sp
The container does not need to have Salt installed, but Python is required.
.INDENT 7.0
.TP
.B name
Container name or ID
.TP
.B saltenv
base
Specify the environment from which to retrieve the SLS indicated by the
\fImods\fP parameter.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.highstate compassionate_mirzakhani
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.history(name, quiet=False)
Return the history for an image. Equivalent to running the \fBdocker
history\fP Docker CLI command.
.INDENT 7.0
.TP
.B name
Container name or ID
.TP
.B quiet
False
If \fBTrue\fP, the return data will simply be a list of the commands run
to build the container.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt myminion docker.history nginx:latest quiet=True
myminion:
    \- FROM scratch
    \- ADD file:ef063ed0ae9579362871b9f23d2bc0781ef7cd4de6ac822052cf6c9c5a12b1e2 in /
    \- CMD [/bin/bash]
    \- MAINTAINER NGINX Docker Maintainers \(dqdocker\-maint@nginx.com\(dq
    \- apt\-key adv \-\-keyserver pgp.mit.edu \-\-recv\-keys 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62
    \- echo \(dqdeb http://nginx.org/packages/mainline/debian/ wheezy nginx\(dq >> /etc/apt/sources.list
    \- ENV NGINX_VERSION=1.7.10\-1~wheezy
    \- apt\-get update &&     apt\-get install \-y ca\-certificates nginx=${NGINX_VERSION} &&     rm \-rf /var/lib/apt/lists/*
    \- ln \-sf /dev/stdout /var/log/nginx/access.log
    \- ln \-sf /dev/stderr /var/log/nginx/error.log
    \- VOLUME [/var/cache/nginx]
    \- EXPOSE map[80/tcp:{} 443/tcp:{}]
    \- CMD [nginx \-g daemon off;]
            https://github.com/saltstack/salt/pull/22421
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
If \fBquiet=False\fP, the return value will be a list of dictionaries
containing information about each step taken to build the image. The keys
in each step include the following:
.INDENT 7.0
.IP \(bu 2
\fBCommand\fP \- The command executed in this build step
.IP \(bu 2
\fBId\fP \- Layer ID
.IP \(bu 2
\fBSize\fP \- Cumulative image size, in bytes
.IP \(bu 2
\fBSize_Human\fP \- Cumulative image size, in human\-readable units
.IP \(bu 2
\fBTags\fP \- Tag(s) assigned to this layer
.IP \(bu 2
\fBTime_Created_Epoch\fP \- Time this build step was completed (Epoch
time)
.IP \(bu 2
\fBTime_Created_Local\fP \- Time this build step was completed (Minion\(aqs
local timezone)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.exists mycontainer
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.images(verbose=False, **kwargs)
Returns information about the Docker images on the Minion. Equivalent to
running the \fBdocker images\fP Docker CLI command.
.INDENT 7.0
.TP
.B all
False
If \fBTrue\fP, untagged images will also be returned
.TP
.B verbose
False
If \fBTrue\fP, a \fBdocker inspect\fP will be run on each image returned.
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary with each key being an image ID, and each value some general
info about that image (time created, size, tags associated with the image,
etc.)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.images
salt myminion docker.images all=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.import_(source, repository, tag=\(aqlatest\(aq, api_response=False)
Changed in version 2018.3.0: The repository and tag must now be passed separately using the
\fBrepository\fP and \fBtag\fP arguments, rather than together in the (now
deprecated) \fBimage\fP argument.

.sp
Imports content from a local tarball or a URL as a new docker image
.INDENT 7.0
.TP
.B source
Content to import (URL or absolute path to a tarball).  URL can be a
file on the Salt fileserver (i.e.
\fBsalt://path/to/rootfs/tarball.tar.xz\fP\&. To import a file from a
saltenv other than \fBbase\fP (e.g. \fBdev\fP), pass it at the end of the
URL (ex. \fBsalt://path/to/rootfs/tarball.tar.xz?saltenv=dev\fP).
.TP
.B repository
Repository name for the image being imported
.sp
New in version 2018.3.0.

.TP
.B tag
latest
Tag name for the image
.sp
New in version 2018.3.0.

.TP
.B image
Deprecated since version 2018.3.0: Use both \fBrepository\fP and \fBtag\fP instead

.TP
.B api_response
False
If \fBTrue\fP an \fBapi_response\fP key will be present in the return data,
containing the raw output from the Docker API.
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBId\fP \- ID of the newly\-created image
.IP \(bu 2
\fBImage\fP \- Name of the newly\-created image
.IP \(bu 2
\fBTime_Elapsed\fP \- Time in seconds taken to perform the commit
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.import /tmp/cent7\-minimal.tar.xz myuser/centos
salt myminion docker.import /tmp/cent7\-minimal.tar.xz myuser/centos:7
salt myminion docker.import salt://dockerimages/cent7\-minimal.tar.xz myuser/centos:7
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.info()
Returns a dictionary of system\-wide information. Equivalent to running
the \fBdocker info\fP Docker CLI command.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.inspect(name)
Changed in version 2017.7.0: Volumes and networks are now checked, in addition to containers and
images.

.sp
This is a generic container/image/volume/network inspecton function. It
will run the following functions in order:
.INDENT 7.0
.IP \(bu 2
\fI\%docker.inspect_container\fP
.IP \(bu 2
\fI\%docker.inspect_image\fP
.IP \(bu 2
\fI\%docker.inspect_volume\fP
.IP \(bu 2
\fI\%docker.inspect_network\fP
.UNINDENT
.sp
The first of these to find a match will be returned.
.INDENT 7.0
.TP
.B name
Container/image/volume/network name or ID
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary of container/image/volume/network information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.inspect mycontainer
salt myminion docker.inspect busybox
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.inspect_container(name)
Retrieves container information. Equivalent to running the \fBdocker
inspect\fP Docker CLI command, but will only look for container information.
.INDENT 7.0
.TP
.B name
Container name or ID
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary of container information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.inspect_container mycontainer
salt myminion docker.inspect_container 0123456789ab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.inspect_image(name)
Retrieves image information. Equivalent to running the \fBdocker inspect\fP
Docker CLI command, but will only look for image information.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To inspect an image, it must have been pulled from a registry or built
locally. Images on a Docker registry which have not been pulled cannot
be inspected.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Image name or ID
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary of image information
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.inspect_image busybox
salt myminion docker.inspect_image centos:6
salt myminion docker.inspect_image 0123456789ab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.inspect_network(network_id)
Inspect Network
.INDENT 7.0
.TP
.B network_id
ID of network
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.inspect_network 1f9d2454d0872b68dd9e8744c6e7a4c66b86f10abaccc21e14f7f014f729b2bc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.inspect_volume(name)
Inspect Volume
.sp
New in version 2015.8.4.

.INDENT 7.0
.TP
.B name
Name of volume
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.inspect_volume my_volume
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.kill(name)
Kill all processes in a running container instead of performing a graceful
shutdown
.INDENT 7.0
.TP
.B name
Container name or ID
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary will be returned, containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBstatus\fP \- A dictionary showing the prior state of the container as
well as the new state
.IP \(bu 2
\fBresult\fP \- A boolean noting whether or not the action was successful
.IP \(bu 2
\fBcomment\fP \- Only present if the container cannot be killed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.kill mycontainer
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.layers(name)
Returns a list of the IDs of layers belonging to the specified image, with
the top\-most layer (the one correspnding to the passed name) appearing
last.
.INDENT 7.0
.TP
.B name
Image name or ID
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.layers centos:7
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.list_containers(**kwargs)
Returns a list of containers by name. This is different from
\fI\%docker.ps\fP in that
\fI\%docker.ps\fP returns its results
organized by container ID.
.INDENT 7.0
.TP
.B all
False
If \fBTrue\fP, stopped containers will be included in return data
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.list_containers
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.list_tags()
Returns a list of tagged images
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.list_tags
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.load(path, repository=None, tag=None)
Changed in version 2018.3.0: If the loaded image should be tagged, then the repository and tag must
now be passed separately using the \fBrepository\fP and \fBtag\fP
arguments, rather than together in the (now deprecated) \fBimage\fP
argument.

.sp
Load a tar archive that was created using \fI\%docker.save\fP (or via the Docker CLI using \fBdocker save\fP).
.INDENT 7.0
.TP
.B path
Path to docker tar archive. Path can be a file on the Minion, or the
URL of a file on the Salt fileserver (i.e.
\fBsalt://path/to/docker/saved/image.tar\fP). To load a file from a
saltenv other than \fBbase\fP (e.g. \fBdev\fP), pass it at the end of the
URL (ex. \fBsalt://path/to/rootfs/tarball.tar.xz?saltenv=dev\fP).
.TP
.B repository
If specified, the topmost layer of the newly\-loaded image will be
tagged with the specified repo using \fI\%docker.tag\fP\&. If a repository name is provided, then
the \fBtag\fP argument is also required.
.sp
New in version 2018.3.0.

.TP
.B tag
Tag name to go along with the repository name, if the loaded image is
to be tagged.
.sp
New in version 2018.3.0.

.TP
.B image
Deprecated since version 2018.3.0: Use both \fBrepository\fP and \fBtag\fP instead

.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary will be returned, containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBPath\fP \- Path of the file that was saved
.IP \(bu 2
\fBLayers\fP \- A list containing the IDs of the layers which were loaded.
Any layers in the file that was loaded, which were already present on the
Minion, will not be included.
.IP \(bu 2
\fBImage\fP \- Name of tag applied to topmost layer
.sp
\fI(Only present if tag was specified and tagging was successful)\fP
.IP \(bu 2
\fBTime_Elapsed\fP \- Time in seconds taken to load the file
.IP \(bu 2
\fBWarning\fP \- Message describing any problems encountered in attempt to
tag the topmost layer
.sp
\fI(Only present if tag was specified and tagging failed)\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.load /path/to/image.tar
salt myminion docker.load salt://path/to/docker/saved/image.tar repository=myuser/myimage tag=mytag
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.login(*registries)
New in version 2016.3.7,2016.11.4,2017.7.0.

.sp
Performs a \fBdocker login\fP to authenticate to one or more configured
repositories. See the documentation at the top of this page to configure
authentication credentials.
.sp
Multiple registry URLs (matching those configured in Pillar) can be passed,
and Salt will attempt to login to \fIjust\fP those registries. If no registry
URLs are provided, Salt will attempt to login to \fIall\fP configured
registries.
.sp
\fBRETURN DATA\fP
.sp
A dictionary containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBResults\fP \- A dictionary mapping registry URLs to the authentication
result. \fBTrue\fP means a successful login, \fBFalse\fP means a failed
login.
.IP \(bu 2
\fBErrors\fP \- A list of errors encountered during the course of this
function.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.login
salt myminion docker.login hub
salt myminion docker.login hub https://mydomain.tld/registry/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.logout(*registries)
New in version 3001.

.sp
Performs a \fBdocker logout\fP to remove the saved authentication details for
one or more configured repositories.
.sp
Multiple registry URLs (matching those configured in Pillar) can be passed,
and Salt will attempt to logout of \fIjust\fP those registries. If no registry
URLs are provided, Salt will attempt to logout of \fIall\fP configured
registries.
.sp
\fBRETURN DATA\fP
.sp
A dictionary containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBResults\fP \- A dictionary mapping registry URLs to the authentication
result. \fBTrue\fP means a successful logout, \fBFalse\fP means a failed
logout.
.IP \(bu 2
\fBErrors\fP \- A list of errors encountered during the course of this
function.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.logout
salt myminion docker.logout hub
salt myminion docker.logout hub https://mydomain.tld/registry/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.logs(name, **kwargs)
Changed in version 2018.3.0: Support for all of docker\-py\(aqs \fI\%logs()\fP function\(aqs arguments, with the
exception of \fBstream\fP\&.

.sp
Returns the logs for the container. An interface to docker\-py\(aqs \fI\%logs()\fP
function.
.INDENT 7.0
.TP
.B name
Container name or ID
.TP
.B stdout
True
Return stdout lines
.TP
.B stderr
True
Return stdout lines
.TP
.B timestamps
False
Show timestamps
.TP
.B tail
all
Output specified number of lines at the end of logs. Either an integer
number of lines or the string \fBall\fP\&.
.TP
.B since
Show logs since the specified time, passed as a UNIX epoch timestamp.
Optionally, if \fI\%timelib\fP is installed on the minion the timestamp can be
passed as a string which will be resolved to a date using
\fBtimelib.strtodatetime()\fP\&.
.TP
.B follow
False
If \fBTrue\fP, this function will block until the container exits and
return the logs when it does. The default behavior is to return what is
in the log at the time this function is executed.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# All logs
salt myminion docker.logs mycontainer
# Last 100 lines of log
salt myminion docker.logs mycontainer tail=100
# Just stderr
salt myminion docker.logs mycontainer stdout=False
# Logs since a specific UNIX timestamp
salt myminion docker.logs mycontainer since=1511688459
# Flexible format for \(dqsince\(dq argument (requires timelib)
salt myminion docker.logs mycontainer since=\(aq1 hour ago\(aq
salt myminion docker.logs mycontainer since=\(aq1 week ago\(aq
salt myminion docker.logs mycontainer since=\(aq1 fortnight ago\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.networks(names=None, ids=None)
Changed in version 2017.7.0: The \fBnames\fP and \fBids\fP can be passed as a comma\-separated list now,
as well as a Python list.

.sp
Changed in version 2018.3.0: The \fBContainers\fP key for each network is no longer always empty.

.sp
List existing networks
.INDENT 7.0
.TP
.B names
Filter by name
.TP
.B ids
Filter by id
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.networks names=network\-web
salt myminion docker.networks ids=1f9d2454d0872b68dd9e8744c6e7a4c66b86f10abaccc21e14f7f014f729b2bc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.pause(name)
Pauses a container
.INDENT 7.0
.TP
.B name
Container name or ID
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary will be returned, containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBstatus\fP \- A dictionary showing the prior state of the container as
well as the new state
.IP \(bu 2
\fBresult\fP \- A boolean noting whether or not the action was successful
.IP \(bu 2
\fBcomment\fP \- Only present if the container cannot be paused
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.pause mycontainer
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.pid(name)
Returns the PID of a container
.INDENT 7.0
.TP
.B name
Container name or ID
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.pid mycontainer
salt myminion docker.pid 0123456789ab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.port(name, private_port=None)
Returns port mapping information for a given container. Equivalent to
running the \fBdocker port\fP Docker CLI command.
.INDENT 7.0
.TP
.B name
Container name or ID
.sp
Changed in version 2019.2.0: This value can now be a pattern expression (using the
pattern\-matching characters defined in \fI\%fnmatch\fP). If a pattern
expression is used, this function will return a dictionary mapping
container names which match the pattern to the mappings for those
containers. When no pattern expression is used, a dictionary of the
mappings for the specified container name will be returned.

.TP
.B private_port
None
If specified, get information for that specific port. Can be specified
either as a port number (i.e. \fB5000\fP), or as a port number plus the
protocol (i.e. \fB5000/udp\fP).
.sp
If this argument is omitted, all port mappings will be returned.
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary of port mappings, with the keys being the port and the values
being the mapping(s) for that port.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.port mycontainer
salt myminion docker.port mycontainer 5000
salt myminion docker.port mycontainer 5000/udp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.prune(containers=False, networks=False, images=False, build=False, volumes=False, system=None, **filters)
New in version 2019.2.0.

.sp
Prune Docker\(aqs various subsystems
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This requires docker\-py version 2.1.0 or later.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B containers
False
If \fBTrue\fP, prunes stopped containers (\fI\%documentation\fP)
.TP
.B images
False
If \fBTrue\fP, prunes unused images (\fI\%documentation\fP)
.TP
.B networks
False
If \fBFalse\fP, prunes unreferenced networks (\fI\%documentation\fP)
.TP
.B build
False
If \fBTrue\fP, clears the builder cache
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Only supported in Docker 17.07.x and newer. Additionally, filters
do not apply to this argument.
.UNINDENT
.UNINDENT
.TP
.B volumes
False
If \fBTrue\fP, prunes unreferenced volumes (\fI\%documentation\fP)
.TP
.B system
If \fBTrue\fP, prunes containers, images, networks, and builder cache.
Assumed to be \fBTrue\fP if none of \fBcontainers\fP, \fBimages\fP,
\fBnetworks\fP, or \fBbuild\fP are set to \fBTrue\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBvolumes=True\fP must still be used to prune volumes
.UNINDENT
.UNINDENT
.TP
.B filters
.INDENT 7.0
.IP \(bu 2
\fBdangling=True\fP (images only) \- remove only dangling images
.IP \(bu 2
\fBuntil=<timestamp>\fP \- only remove objects created before given
timestamp. Not applicable to volumes. See the documentation links
above for examples of valid time expressions.
.IP \(bu 2
\fBlabel\fP \- only remove objects matching the label expression. Valid
expressions include \fBlabelname\fP or \fBlabelname=value\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.prune system=True
salt myminion docker.prune system=True until=12h
salt myminion docker.prune images=True dangling=True
salt myminion docker.prune images=True label=foo,bar=baz
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.ps_(filters=None, **kwargs)
Returns information about the Docker containers on the Minion. Equivalent
to running the \fBdocker ps\fP Docker CLI command.
.INDENT 7.0
.TP
.B all
False
If \fBTrue\fP, stopped containers will also be returned
.TP
.B host: False
If \fBTrue\fP, local host\(aqs network topology will be included
.TP
.B verbose
False
If \fBTrue\fP, a \fBdocker inspect\fP will be run on each container
returned.
.TP
.B filters: None
A dictionary of filters to be processed on the container list.
Available filters:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
exited (int): Only containers with specified exit code
.IP \(bu 2
status (str): One of restarting, running, paused, exited
.IP \(bu 2
label (str): format either \(dqkey\(dq or \(dqkey=value\(dq
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary with each key being an container ID, and each value some
general info about that container (time created, name, command, etc.)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.ps
salt myminion docker.ps all=True
salt myminion docker.ps filters=\(dq{\(aqlabel\(aq: \(aqrole=web\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.pull(image, insecure_registry=False, api_response=False, client_timeout=60)
Changed in version 2018.3.0: If no tag is specified in the \fBimage\fP argument, all tags for the
image will be pulled. For this reason is it recommended to pass
\fBimage\fP using the \fBrepo:tag\fP notation.

.sp
Pulls an image from a Docker registry
.INDENT 7.0
.TP
.B image
Image to be pulled
.TP
.B insecure_registry
False
If \fBTrue\fP, the Docker client will permit the use of insecure
(non\-HTTPS) registries.
.TP
.B api_response
False
If \fBTrue\fP, an \fBAPI_Response\fP key will be present in the return
data, containing the raw output from the Docker API.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This may result in a \fBlot\fP of additional return data, especially
for larger images.
.UNINDENT
.UNINDENT
.TP
.B client_timeout
Timeout in seconds for the Docker client. This is not a timeout for
this function, but for receiving a response from the API.
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary will be returned, containing the following keys:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBLayers\fP \- A dictionary containing one or more of the following keys:
.INDENT 7.0
.IP \(bu 2
\fBAlready_Pulled\fP \- Layers that that were already present on the
Minion
.IP \(bu 2
\fBPulled\fP \- Layers that that were pulled
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBStatus\fP \- A string containing a summary of the pull action (usually a
message saying that an image was downloaded, or that it was up to date).
.IP \(bu 2
\fBTime_Elapsed\fP \- Time in seconds taken to perform the pull
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.pull centos
salt myminion docker.pull centos:6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.push(image, insecure_registry=False, api_response=False, client_timeout=60)
Changed in version 2015.8.4: The \fBId\fP and \fBImage\fP keys are no longer present in the return data.
This is due to changes in the Docker Remote API.

.sp
Pushes an image to a Docker registry. See the documentation at top of this
page to configure authentication credentials.
.INDENT 7.0
.TP
.B image
Image to be pushed. If just the repository name is passed, then all
tagged images for the specified repo will be pushed. If the image name
is passed in \fBrepo:tag\fP notation, only the specified image will be
pushed.
.TP
.B insecure_registry
False
If \fBTrue\fP, the Docker client will permit the use of insecure
(non\-HTTPS) registries.
.TP
.B api_response
False
If \fBTrue\fP, an \fBAPI_Response\fP key will be present in the return
data, containing the raw output from the Docker API.
.TP
.B client_timeout
Timeout in seconds for the Docker client. This is not a timeout for
this function, but for receiving a response from the API.
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary will be returned, containing the following keys:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fBLayers\fP \- A dictionary containing one or more of the following keys:
.INDENT 7.0
.IP \(bu 2
\fBAlready_Pushed\fP \- Layers that that were already present on the
Minion
.IP \(bu 2
\fBPushed\fP \- Layers that that were pushed
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBTime_Elapsed\fP \- Time in seconds taken to perform the push
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.push myuser/mycontainer
salt myminion docker.push myuser/mycontainer:mytag
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.remove_network(network_id)
Remove a network
.INDENT 7.0
.TP
.B network_id
Network name or ID
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.remove_network mynet
salt myminion docker.remove_network 1f9d2454d0872b68dd9e8744c6e7a4c66b86f10abaccc21e14f7f014f729b2bc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.remove_volume(name)
Remove a volume
.sp
New in version 2015.8.4.

.INDENT 7.0
.TP
.B name
Name of volume
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.remove_volume my_volume
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.rename(name, new_name)
New in version 2017.7.0.

.sp
Renames a container. Returns \fBTrue\fP if successful, and raises an error if
the API returns one. If unsuccessful and the API returns no error (should
not happen), then \fBFalse\fP will be returned.
.INDENT 7.0
.TP
.B name
Name or ID of existing container
.TP
.B new_name
New name to assign to container
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.rename foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.resolve_image_id(name)
New in version 2018.3.0.

.sp
Given an image name (or partial image ID), return the full image ID. If no
match is found among the locally\-pulled images, then \fBFalse\fP will be
returned.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.resolve_image_id foo
salt myminion docker.resolve_image_id foo:bar
salt myminion docker.resolve_image_id 36540f359ca3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.resolve_tag(name, **kwargs)
New in version 2017.7.2.

.sp
Changed in version 2018.3.0: Instead of matching against pulled tags using
\fI\%docker.list_tags\fP, this
function now simply inspects the passed image name using
\fI\%docker.inspect_image\fP
and returns the first matching tag. If no matching tags are found, it
is assumed that the passed image is an untagged image ID, and the full
ID is returned.

.sp
Inspects the specified image name and returns the first matching tag in the
inspect results. If the specified image is not pulled locally, this
function will return \fBFalse\fP\&.
.INDENT 7.0
.TP
.B name
Image name to resolve. If the image is found but there are no tags,
this means that the image name passed was an untagged image. In this
case the image ID will be returned.
.TP
.B all
False
If \fBTrue\fP, a list of all matching tags will be returned. If the image
is found but there are no tags, then a list will still be returned, but
it will simply contain the image ID.
.sp
New in version 2018.3.0.

.TP
.B tags
Deprecated since version 2018.3.0.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.resolve_tag busybox
salt myminion docker.resolve_tag centos:7 all=True
salt myminion docker.resolve_tag c9f378ac27d9
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.restart(name, timeout=10)
Restarts a container
.INDENT 7.0
.TP
.B name
Container name or ID
.TP
.B timeout
10
Timeout in seconds after which the container will be killed (if it has
not yet gracefully shut down)
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary will be returned, containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBstatus\fP \- A dictionary showing the prior state of the container as
well as the new state
.IP \(bu 2
\fBresult\fP \- A boolean noting whether or not the action was successful
.IP \(bu 2
\fBrestarted\fP \- If restart was successful, this key will be present and
will be set to \fBTrue\fP\&.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.restart mycontainer
salt myminion docker.restart mycontainer timeout=20
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.retcode(name, cmd, exec_driver=None, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, ignore_retcode=False, keep_env=None)
Run \fI\%cmd.retcode\fP within a container
.INDENT 7.0
.TP
.B name
Container name or ID in which to run the command
.TP
.B cmd
Command to run
.TP
.B exec_driver
None
If not passed, the execution driver will be detected as described
\fI\%above\fP\&.
.TP
.B stdin
None
Standard input to be used for the command
.TP
.B output_loglevel
debug
Level at which to log the output from the command. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console.
.TP
.B keep_env
None
If not passed, only a sane default PATH environment variable will be
set. If \fBTrue\fP, all environment variables from the container\(aqs host
will be kept. Otherwise, a comma\-separated list (or Python list) of
environment variable names can be passed, and those environment
variables will be kept.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.retcode mycontainer \(aqls \-l /etc\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.rm_(name, force=False, volumes=False, **kwargs)
Removes a container
.INDENT 7.0
.TP
.B name
Container name or ID
.TP
.B force
False
If \fBTrue\fP, the container will be killed first before removal, as the
Docker API will not permit a running container to be removed. This
option is set to \fBFalse\fP by default to prevent accidental removal of
a running container.
.TP
.B stop
False
If \fBTrue\fP, the container will be stopped first before removal, as the
Docker API will not permit a running container to be removed. This
option is set to \fBFalse\fP by default to prevent accidental removal of
a running container.
.sp
New in version 2017.7.0.

.TP
.B timeout
Optional timeout to be passed to \fI\%docker.stop\fP if stopping the container.
.sp
New in version 2018.3.0.

.TP
.B volumes
False
Also remove volumes associated with container
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A list of the IDs of containers which were removed
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.rm mycontainer
salt myminion docker.rm mycontainer force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.rmi(*names, **kwargs)
Removes an image
.INDENT 7.0
.TP
.B name
Name (in \fBrepo:tag\fP notation) or ID of image.
.TP
.B force
False
If \fBTrue\fP, the image will be removed even if the Minion has
containers created from that image
.TP
.B prune
True
If \fBTrue\fP, untagged parent image layers will be removed as well, set
this to \fBFalse\fP to keep them.
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary will be returned, containing the following two keys:
.INDENT 7.0
.IP \(bu 2
\fBLayers\fP \- A list of the IDs of image layers that were removed
.IP \(bu 2
\fBTags\fP \- A list of the tags that were removed
.IP \(bu 2
\fBErrors\fP \- A list of any errors that were encountered
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.rmi busybox
salt myminion docker.rmi busybox force=True
salt myminion docker.rmi foo bar baz
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.run(name, cmd, exec_driver=None, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, ignore_retcode=False, keep_env=None)
Run \fI\%cmd.run\fP within a container
.INDENT 7.0
.TP
.B name
Container name or ID in which to run the command
.TP
.B cmd
Command to run
.TP
.B exec_driver
None
If not passed, the execution driver will be detected as described
\fI\%above\fP\&.
.TP
.B stdin
None
Standard input to be used for the command
.TP
.B output_loglevel
debug
Level at which to log the output from the command. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console.
.TP
.B keep_env
None
If not passed, only a sane default PATH environment variable will be
set. If \fBTrue\fP, all environment variables from the container\(aqs host
will be kept. Otherwise, a comma\-separated list (or Python list) of
environment variable names can be passed, and those environment
variables will be kept.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.run mycontainer \(aqls \-l /etc\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.run_all(name, cmd, exec_driver=None, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, ignore_retcode=False, keep_env=None)
Run \fI\%cmd.run_all\fP within a container
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
While the command is run within the container, it is initiated from the
host. Therefore, the PID in the return dict is from the host, not from
the container.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Container name or ID in which to run the command
.TP
.B cmd
Command to run
.TP
.B exec_driver
None
If not passed, the execution driver will be detected as described
\fI\%above\fP\&.
.TP
.B stdin
None
Standard input to be used for the command
.TP
.B output_loglevel
debug
Level at which to log the output from the command. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console.
.TP
.B keep_env
None
If not passed, only a sane default PATH environment variable will be
set. If \fBTrue\fP, all environment variables from the container\(aqs host
will be kept. Otherwise, a comma\-separated list (or Python list) of
environment variable names can be passed, and those environment
variables will be kept.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.run_all mycontainer \(aqls \-l /etc\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.run_container(image, name=None, skip_translate=None, ignore_collisions=False, validate_ip_addrs=True, client_timeout=60, bg=False, replace=False, force=False, networks=None, **kwargs)
New in version 2018.3.0.

.sp
Equivalent to \fBdocker run\fP on the Docker CLI. Runs the container, waits
for it to exit, and returns the container\(aqs logs when complete.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Not to be confused with \fI\%docker.run\fP, which provides a \fI\%cmd.run\fP\-like interface for executing commands in a
running container.
.UNINDENT
.UNINDENT
.sp
This function accepts the same arguments as \fI\%docker.create\fP, with the exception of \fBstart\fP\&. In
addition, it accepts the arguments from \fI\%docker.logs\fP, with the exception of \fBfollow\fP, to
control how logs are returned. Finally, the \fBbg\fP argument described below
can be used to optionally run the container in the background (the default
behavior is to block until the container exits).
.INDENT 7.0
.TP
.B bg
False
If \fBTrue\fP, this function will not wait for the container to exit and
will not return its logs. It will however return the container\(aqs name
and ID, allowing for \fI\%docker.logs\fP to be used to view the logs.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The logs will be inaccessible once the container exits if
\fBauto_remove\fP is set to \fBTrue\fP, so keep this in mind.
.UNINDENT
.UNINDENT
.TP
.B replace
False
If \fBTrue\fP, and if the named container already exists, this will
remove the existing container. The default behavior is to return a
\fBFalse\fP result when the container already exists.
.TP
.B force
False
If \fBTrue\fP, and the named container already exists, \fIand\fP \fBreplace\fP
is also set to \fBTrue\fP, then the container will be forcibly removed.
Otherwise, the state will not proceed and will return a \fBFalse\fP
result.
.TP
.B networks
Networks to which the container should be connected. If automatic IP
configuration is being used, the networks can be a simple list of
network names. If custom IP configuration is being used, then this
argument must be passed as a dictionary.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.run_container myuser/myimage command=/usr/local/bin/myscript.sh
# Run container in the background
salt myminion docker.run_container myuser/myimage command=/usr/local/bin/myscript.sh bg=True
# Connecting to two networks using automatic IP configuration
salt myminion docker.run_container myuser/myimage command=\(aqperl /scripts/sync.py\(aq networks=net1,net2
# net1 using automatic IP, net2 using static IPv4 address
salt myminion docker.run_container myuser/myimage command=\(aqperl /scripts/sync.py\(aq networks=\(aq{\(dqnet1\(dq: {}, \(dqnet2\(dq: {\(dqipv4_address\(dq: \(dq192.168.27.12\(dq}}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.run_stderr(name, cmd, exec_driver=None, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, ignore_retcode=False, keep_env=None)
Run \fI\%cmd.run_stderr\fP within a
container
.INDENT 7.0
.TP
.B name
Container name or ID in which to run the command
.TP
.B cmd
Command to run
.TP
.B exec_driver
None
If not passed, the execution driver will be detected as described
\fI\%above\fP\&.
.TP
.B stdin
None
Standard input to be used for the command
.TP
.B output_loglevel
debug
Level at which to log the output from the command. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console.
.TP
.B keep_env
None
If not passed, only a sane default PATH environment variable will be
set. If \fBTrue\fP, all environment variables from the container\(aqs host
will be kept. Otherwise, a comma\-separated list (or Python list) of
environment variable names can be passed, and those environment
variables will be kept.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.run_stderr mycontainer \(aqls \-l /etc\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.run_stdout(name, cmd, exec_driver=None, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, ignore_retcode=False, keep_env=None)
Run \fI\%cmd.run_stdout\fP within a
container
.INDENT 7.0
.TP
.B name
Container name or ID in which to run the command
.TP
.B cmd
Command to run
.TP
.B exec_driver
None
If not passed, the execution driver will be detected as described
\fI\%above\fP\&.
.TP
.B stdin
None
Standard input to be used for the command
.TP
.B output_loglevel
debug
Level at which to log the output from the command. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console.
.TP
.B keep_env
None
If not passed, only a sane default PATH environment variable will be
set. If \fBTrue\fP, all environment variables from the container\(aqs host
will be kept. Otherwise, a comma\-separated list (or Python list) of
environment variable names can be passed, and those environment
variables will be kept.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.run_stdout mycontainer \(aqls \-l /etc\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.save(name, path, overwrite=False, makedirs=False, compression=None, **kwargs)
Saves an image and to a file on the minion. Equivalent to running the
\fBdocker save\fP Docker CLI command, but unlike \fBdocker save\fP this will
also work on named images instead of just images IDs.
.INDENT 7.0
.TP
.B name
Name or ID of image. Specify a specific tag by using the \fBrepo:tag\fP
notation.
.TP
.B path
Absolute path on the Minion where the image will be exported
.TP
.B overwrite
False
Unless this option is set to \fBTrue\fP, then if the destination file
exists an error will be raised.
.TP
.B makedirs
False
If \fBTrue\fP, then if the parent directory of the file specified by the
\fBpath\fP argument does not exist, Salt will attempt to create it.
.TP
.B compression
None
Can be set to any of the following:
.INDENT 7.0
.IP \(bu 2
\fBgzip\fP or \fBgz\fP for gzip compression
.IP \(bu 2
\fBbzip2\fP or \fBbz2\fP for bzip2 compression
.IP \(bu 2
\fBxz\fP or \fBlzma\fP for XZ compression (requires \fI\%xz\-utils\fP, as well
as the \fBlzma\fP module from Python 3.3, available in Python 2 and
Python 3.0\-3.2 as \fI\%backports.lzma\fP)
.UNINDENT
.sp
This parameter can be omitted and Salt will attempt to determine the
compression type by examining the filename passed in the \fBpath\fP
parameter.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Since the Docker API does not support \fBdocker save\fP, compression
will be a bit slower with this function than with
\fI\%docker.export\fP since the
image(s) will first be saved and then the compression done
afterwards.
.UNINDENT
.UNINDENT
.TP
.B push
False
If \fBTrue\fP, the container will be pushed to the master using
\fI\%cp.push\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This requires \fI\%file_recv\fP to be set to \fBTrue\fP on the
Master.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary will be returned, containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBPath\fP \- Path of the file that was saved
.IP \(bu 2
\fBPush\fP \- Reports whether or not the file was successfully pushed to the
Master
.sp
\fI(Only present if push=True)\fP
.IP \(bu 2
\fBSize\fP \- Size of the file, in bytes
.IP \(bu 2
\fBSize_Human\fP \- Size of the file, in human\-readable units
.IP \(bu 2
\fBTime_Elapsed\fP \- Time in seconds taken to perform the save
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.save centos:7 /tmp/cent7.tar
salt myminion docker.save 0123456789ab cdef01234567 /tmp/saved.tar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.script(name, source, saltenv=\(aqbase\(aq, args=None, template=None, exec_driver=None, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, ignore_retcode=False, use_vt=False, keep_env=None)
Run \fI\%cmd.script\fP within a container
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
While the command is run within the container, it is initiated from the
host. Therefore, the PID in the return dict is from the host, not from
the container.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Container name or ID
.TP
.B source
Path to the script. Can be a local path on the Minion or a remote file
from the Salt fileserver.
.TP
.B args
A string containing additional command\-line options to pass to the
script.
.TP
.B template
None
Templating engine to use on the script before running.
.TP
.B exec_driver
None
If not passed, the execution driver will be detected as described
\fI\%above\fP\&.
.TP
.B stdin
None
Standard input to be used for the script
.TP
.B output_loglevel
debug
Level at which to log the output from the script. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console.
.TP
.B keep_env
None
If not passed, only a sane default PATH environment variable will be
set. If \fBTrue\fP, all environment variables from the container\(aqs host
will be kept. Otherwise, a comma\-separated list (or Python list) of
environment variable names can be passed, and those environment
variables will be kept.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.script mycontainer salt://docker_script.py
salt myminion docker.script mycontainer salt://scripts/runme.sh \(aqarg1 arg2 \(dqarg 3\(dq\(aq
salt myminion docker.script mycontainer salt://scripts/runme.sh stdin=\(aqone\entwo\enthree\enfour\enfive\en\(aq output_loglevel=quiet
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.script_retcode(name, source, saltenv=\(aqbase\(aq, args=None, template=None, exec_driver=None, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, ignore_retcode=False, use_vt=False, keep_env=None)
Run \fI\%cmd.script_retcode\fP
within a container
.INDENT 7.0
.TP
.B name
Container name or ID
.TP
.B source
Path to the script. Can be a local path on the Minion or a remote file
from the Salt fileserver.
.TP
.B args
A string containing additional command\-line options to pass to the
script.
.TP
.B template
None
Templating engine to use on the script before running.
.TP
.B exec_driver
None
If not passed, the execution driver will be detected as described
\fI\%above\fP\&.
.TP
.B stdin
None
Standard input to be used for the script
.TP
.B output_loglevel
debug
Level at which to log the output from the script. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console.
.TP
.B keep_env
None
If not passed, only a sane default PATH environment variable will be
set. If \fBTrue\fP, all environment variables from the container\(aqs host
will be kept. Otherwise, a comma\-separated list (or Python list) of
environment variable names can be passed, and those environment
variables will be kept.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.script_retcode mycontainer salt://docker_script.py
salt myminion docker.script_retcode mycontainer salt://scripts/runme.sh \(aqarg1 arg2 \(dqarg 3\(dq\(aq
salt myminion docker.script_retcode mycontainer salt://scripts/runme.sh stdin=\(aqone\entwo\enthree\enfour\enfive\en\(aq output_loglevel=quiet
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.search(name, official=False, trusted=False)
Searches the registry for an image
.INDENT 7.0
.TP
.B name
Search keyword
.TP
.B official
False
Limit results to official builds
.TP
.B trusted
False
Limit results to \fI\%trusted builds\fP
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary with each key being the name of an image, and the following
information for each image:
.INDENT 7.0
.IP \(bu 2
\fBDescription\fP \- Image description
.IP \(bu 2
\fBOfficial\fP \- A boolean (\fBTrue\fP if an official build, \fBFalse\fP if
not)
.IP \(bu 2
\fBStars\fP \- Number of stars the image has on the registry
.IP \(bu 2
\fBTrusted\fP \- A boolean (\fBTrue\fP if a trusted build, \fBFalse\fP if not)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.search centos
salt myminion docker.search centos official=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.signal_(name, signal)
Send a signal to a container. Signals can be either strings or numbers, and
are defined in the \fBStandard Signals\fP section of the \fBsignal(7)\fP
manpage. Run \fBman 7 signal\fP on a Linux host to browse this manpage.
.INDENT 7.0
.TP
.B name
Container name or ID
.TP
.B signal
Signal to send to container
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
If the signal was successfully sent, \fBTrue\fP will be returned. Otherwise,
an error will be raised.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.signal mycontainer SIGHUP
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.sls(name, mods=None, **kwargs)
Apply the states defined by the specified SLS modules to the running
container
.sp
New in version 2016.11.0.

.sp
The container does not need to have Salt installed, but Python is required.
.INDENT 7.0
.TP
.B name
Container name or ID
.TP
.B mods
None
A string containing comma\-separated list of SLS with defined states to
apply to the container.
.TP
.B saltenv
base
Specify the environment from which to retrieve the SLS indicated by the
\fImods\fP parameter.
.TP
.B pillarenv
Specify a Pillar environment to be used when applying states. This
can also be set in the minion config file using the
\fI\%pillarenv\fP option. When neither the
\fI\%pillarenv\fP minion config option nor this CLI argument is
used, all Pillar environments will be merged together.
.sp
New in version 2018.3.0.

.TP
.B pillar
Custom Pillar values, passed as a dictionary of key\-value pairs
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Values passed this way will override Pillar values set via
\fBpillar_roots\fP or an external Pillar source.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.sls compassionate_mirzakhani mods=rails,web
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.sls_build(repository, tag=\(aqlatest\(aq, base=\(aqopensuse/python\(aq, mods=None, dryrun=False, **kwargs)
Changed in version 2018.3.0: The repository and tag must now be passed separately using the
\fBrepository\fP and \fBtag\fP arguments, rather than together in the (now
deprecated) \fBimage\fP argument.

.sp
Build a Docker image using the specified SLS modules on top of base image
.sp
New in version 2016.11.0.

.sp
The base image does not need to have Salt installed, but Python is required.
.INDENT 7.0
.TP
.B repository
Repository name for the image to be built
.sp
New in version 2018.3.0.

.TP
.B tag
latest
Tag name for the image to be built
.sp
New in version 2018.3.0.

.TP
.B name
Deprecated since version 2018.3.0: Use both \fBrepository\fP and \fBtag\fP instead

.TP
.B base
opensuse/python
Name or ID of the base image
.TP
.B mods
A string containing comma\-separated list of SLS with defined states to
apply to the base image.
.TP
.B saltenv
base
Specify the environment from which to retrieve the SLS indicated by the
\fImods\fP parameter.
.TP
.B pillarenv
Specify a Pillar environment to be used when applying states. This
can also be set in the minion config file using the
\fI\%pillarenv\fP option. When neither the
\fI\%pillarenv\fP minion config option nor this CLI argument is
used, all Pillar environments will be merged together.
.sp
New in version 2018.3.0.

.TP
.B pillar
Custom Pillar values, passed as a dictionary of key\-value pairs
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Values passed this way will override Pillar values set via
\fBpillar_roots\fP or an external Pillar source.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.TP
.B dryrun: False
when set to True the container will not be committed at the end of
the build. The dryrun succeed also when the state contains errors.
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary with the ID of the new container. In case of a dryrun,
the state result is returned and the container gets removed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.sls_build imgname base=mybase mods=rails,web
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.start_(name)
Start a container
.INDENT 7.0
.TP
.B name
Container name or ID
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary will be returned, containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBstatus\fP \- A dictionary showing the prior state of the container as
well as the new state
.IP \(bu 2
\fBresult\fP \- A boolean noting whether or not the action was successful
.IP \(bu 2
\fBcomment\fP \- Only present if the container cannot be started
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.start mycontainer
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.state(name)
Returns the state of the container
.INDENT 7.0
.TP
.B name
Container name or ID
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A string representing the current state of the container (either
\fBrunning\fP, \fBpaused\fP, or \fBstopped\fP)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.state mycontainer
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.stop(name, timeout=None, **kwargs)
Stops a running container
.INDENT 7.0
.TP
.B name
Container name or ID
.TP
.B unpause
False
If \fBTrue\fP and the container is paused, it will be unpaused before
attempting to stop the container.
.TP
.B timeout
Timeout in seconds after which the container will be killed (if it has
not yet gracefully shut down)
.sp
Changed in version 2017.7.0: If this argument is not passed, then the container\(aqs configuration
will be checked. If the container was created using the
\fBstop_timeout\fP argument, then the configured timeout will be
used, otherwise the timeout will be 10 seconds.

.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary will be returned, containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBstatus\fP \- A dictionary showing the prior state of the container as
well as the new state
.IP \(bu 2
\fBresult\fP \- A boolean noting whether or not the action was successful
.IP \(bu 2
\fBcomment\fP \- Only present if the container can not be stopped
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.stop mycontainer
salt myminion docker.stop mycontainer unpause=True
salt myminion docker.stop mycontainer timeout=20
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.tag_(name, repository, tag=\(aqlatest\(aq, force=False)
Changed in version 2018.3.0: The repository and tag must now be passed separately using the
\fBrepository\fP and \fBtag\fP arguments, rather than together in the (now
deprecated) \fBimage\fP argument.

.sp
Tag an image into a repository and return \fBTrue\fP\&. If the tag was
unsuccessful, an error will be raised.
.INDENT 7.0
.TP
.B name
ID of image
.TP
.B repository
Repository name for the image to be built
.sp
New in version 2018.3.0.

.TP
.B tag
latest
Tag name for the image to be built
.sp
New in version 2018.3.0.

.TP
.B image
Deprecated since version 2018.3.0: Use both \fBrepository\fP and \fBtag\fP instead

.TP
.B force
False
Force apply tag
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.tag 0123456789ab myrepo/mycontainer mytag
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.top(name)
Runs the \fIdocker top\fP command on a specific container
.INDENT 7.0
.TP
.B name
Container name or ID
.UNINDENT
.sp
CLI Example:
.sp
\fBRETURN DATA\fP
.sp
A list of dictionaries containing information about each process
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.top mycontainer
salt myminion docker.top 0123456789ab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.unfreeze(name)
This function is an alias of \fBunpause\fP\&.
.INDENT 7.0
.INDENT 3.5
Unpauses a container
.INDENT 0.0
.TP
.B name
Container name or ID
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary will be returned, containing the following keys:
.INDENT 0.0
.IP \(bu 2
\fBstatus\fP \- A dictionary showing the prior state of the container as
well as the new state
.IP \(bu 2
\fBresult\fP \- A boolean noting whether or not the action was successful
.IP \(bu 2
\fBcomment\fP \- Only present if the container can not be unpaused
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.pause mycontainer
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.unpause(name)
Unpauses a container
.INDENT 7.0
.TP
.B name
Container name or ID
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary will be returned, containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBstatus\fP \- A dictionary showing the prior state of the container as
well as the new state
.IP \(bu 2
\fBresult\fP \- A boolean noting whether or not the action was successful
.IP \(bu 2
\fBcomment\fP \- Only present if the container can not be unpaused
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.pause mycontainer
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.version()
Returns a dictionary of Docker version information. Equivalent to running
the \fBdocker version\fP Docker CLI command.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.volumes(filters=None)
List existing volumes
.sp
New in version 2015.8.4.

.INDENT 7.0
.TP
.B filters
There is one available filter: dangling=true
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.volumes filters=\(dq{\(aqdangling\(aq: True}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dockermod.wait(name, ignore_already_stopped=False, fail_on_exit_status=False)
Wait for the container to exit gracefully, and return its exit code
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function will block until the container is stopped.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Container name or ID
.TP
.B ignore_already_stopped
Boolean flag that prevents execution to fail, if a container
is already stopped.
.TP
.B fail_on_exit_status
Boolean flag to report execution as failure if \fBexit_status\fP
is different than 0.
.UNINDENT
.sp
\fBRETURN DATA\fP
.sp
A dictionary will be returned, containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBstatus\fP \- A dictionary showing the prior state of the container as
well as the new state
.IP \(bu 2
\fBresult\fP \- A boolean noting whether or not the action was successful
.IP \(bu 2
\fBexit_status\fP \- Exit status for the container
.IP \(bu 2
\fBcomment\fP \- Only present if the container is already stopped
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.wait mycontainer
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.dpkg_lowpkg
.sp
Support for DEB packages
.INDENT 0.0
.TP
.B salt.modules.dpkg_lowpkg.bin_pkg_info(path, saltenv=\(aqbase\(aq)
New in version 2015.8.0.

.sp
Parses DEB metadata and returns a dictionary of information about the
package (name, version, etc.).
.INDENT 7.0
.TP
.B path
Path to the file. Can either be an absolute path to a file on the
minion, or a salt fileserver URL (e.g. \fBsalt://path/to/file.deb\fP).
If a salt fileserver URL is passed, the file will be cached to the
minion so that it can be examined.
.TP
.B saltenv
base
Salt fileserver environment from which to retrieve the package. Ignored
if \fBpath\fP is a local file path on the minion.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.bin_pkg_info /root/foo\-1.2.3\-1ubuntu1_all.deb
salt \(aq*\(aq lowpkg.bin_pkg_info salt://foo\-1.2.3\-1ubuntu1_all.deb
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dpkg_lowpkg.file_dict(*packages, **kwargs)
List the files that belong to a package, grouped by package. Not
specifying any packages will return a list of _every_ file on the system\(aqs
package database (not generally recommended).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.file_dict hostname
salt \(aq*\(aq lowpkg.file_dict hostname mount
salt \(aq*\(aq lowpkg.file_dict
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dpkg_lowpkg.file_list(*packages, **kwargs)
List the files that belong to a package. Not specifying any packages will
return a list of _every_ file on the system\(aqs package database (not
generally recommended).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.file_list hostname
salt \(aq*\(aq lowpkg.file_list hostname mount
salt \(aq*\(aq lowpkg.file_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dpkg_lowpkg.info(*packages, **kwargs)
Returns a detailed summary of package information for provided package names.
If no packages are specified, all packages will be returned.
.sp
New in version 2015.8.1.

.INDENT 7.0
.TP
.B packages
The names of the packages for which to return information.
.TP
.B failhard
Whether to throw an exception if none of the packages are installed.
Defaults to True.
.sp
New in version 2016.11.3.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.info
salt \(aq*\(aq lowpkg.info apache2 bash
salt \(aq*\(aq lowpkg.info \(aqphp5*\(aq failhard=false
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dpkg_lowpkg.list_pkgs(*packages, **kwargs)
List the packages currently installed in a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
External dependencies:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Virtual package resolution requires aptitude. Because this function
uses dpkg, virtual packages will be reported as not installed.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.list_pkgs
salt \(aq*\(aq lowpkg.list_pkgs hostname
salt \(aq*\(aq lowpkg.list_pkgs hostname mount
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dpkg_lowpkg.unpurge(*packages)
Change package selection for each package specified to \(aqinstall\(aq
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.unpurge curl
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.drac
.sp
Manage Dell DRAC
.INDENT 0.0
.TP
.B salt.modules.drac.change_password(username, password, uid=None)
Change users password
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.change_password [USERNAME] [PASSWORD] [UID \- optional]
salt dell drac.change_password diana secret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.create_user(username, password, permissions, users=None)
Create user accounts
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.create_user [USERNAME] [PASSWORD] [PRIVILEGES]
salt dell drac.create_user diana secret login,test_alerts,clear_logs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B DRAC Privileges
.INDENT 7.0
.IP \(bu 2
login                   : Login to iDRAC
.IP \(bu 2
drac                    : Configure iDRAC
.IP \(bu 2
user_management         : Configure Users
.IP \(bu 2
clear_logs              : Clear Logs
.IP \(bu 2
server_control_commands : Execute Server Control Commands
.IP \(bu 2
console_redirection     : Access Console Redirection
.IP \(bu 2
virtual_media           : Access Virtual Media
.IP \(bu 2
test_alerts             : Test Alerts
.IP \(bu 2
debug_commands          : Execute Debug Commands
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.delete_user(username, uid=None)
Delete a user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.delete_user [USERNAME] [UID \- optional]
salt dell drac.delete_user diana 4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.email_alerts(action)
Enable/Disable email alerts
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.email_alerts True
salt dell drac.email_alerts False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.list_users()
List all DRAC users
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.list_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.nameservers(*ns)
Configure the nameservers on the DRAC
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.nameservers [NAMESERVERS]
salt dell drac.nameservers ns1.example.com ns2.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.network_info()
Return Network Configuration
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.network_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.server_hardreset()
Performs a reset (reboot) operation on the managed server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.server_hardreset
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.server_poweroff()
Powers down the managed server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.server_poweroff
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.server_poweron()
Powers up the managed server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.server_poweron
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.server_pxe()
Configure server to PXE perform a one off PXE boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.server_pxe
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.server_reboot()
Issues a power\-cycle operation on the managed server. This action is
similar to pressing the power button on the system\(aqs front panel to
power down and then power up the system.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.server_reboot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.set_network(ip, netmask, gateway)
Configure Network
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.set_network [DRAC IP] [NETMASK] [GATEWAY]
salt dell drac.set_network 192.168.0.2 255.255.255.0 192.168.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.set_permissions(username, permissions, uid=None)
Configure users permissions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.set_permissions [USERNAME] [PRIVILEGES] [USER INDEX \- optional]
salt dell drac.set_permissions diana login,test_alerts,clear_logs 4
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B DRAC Privileges
.INDENT 7.0
.IP \(bu 2
login                   : Login to iDRAC
.IP \(bu 2
drac                    : Configure iDRAC
.IP \(bu 2
user_management         : Configure Users
.IP \(bu 2
clear_logs              : Clear Logs
.IP \(bu 2
server_control_commands : Execute Server Control Commands
.IP \(bu 2
console_redirection     : Access Console Redirection
.IP \(bu 2
virtual_media           : Access Virtual Media
.IP \(bu 2
test_alerts             : Test Alerts
.IP \(bu 2
debug_commands          : Execute Debug Commands
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.set_snmp(community)
Configure SNMP community string
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.set_snmp [COMMUNITY]
salt dell drac.set_snmp public
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.syslog(server, enable=True)
Configure syslog remote logging, by default syslog will automatically be
enabled if a server is specified. However, if you want to disable syslog
you will need to specify a server followed by False
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.syslog [SYSLOG IP] [ENABLE/DISABLE]
salt dell drac.syslog 0.0.0.0 False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drac.system_info()
Return System information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.system_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.dracr
.sp
Manage Dell DRAC.
.sp
New in version 2015.8.2.

.INDENT 0.0
.TP
.B salt.modules.dracr.bare_rac_cmd(cmd, host=None, admin_username=None, admin_password=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.change_password(username, password, uid=None, host=None, admin_username=None, admin_password=None, module=None)
Change user\(aqs password
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.change_password [USERNAME] [PASSWORD] uid=[OPTIONAL]
    host=<remote DRAC> admin_username=<DRAC user>
    admin_password=<DRAC PW>
salt dell dracr.change_password diana secret
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that if only a username is specified then this module will look up
details for all 16 possible DRAC users.  This is time consuming, but might
be necessary if one is not sure which user slot contains the one you want.
Many late\-model Dell chassis have \(aqroot\(aq as UID 1, so if you can depend
on that then setting the password is much quicker.
Raises an error if the supplied password is greater than 20 chars.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.create_user(username, password, permissions, users=None, host=None, admin_username=None, admin_password=None)
Create user accounts
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.create_user [USERNAME] [PASSWORD] [PRIVILEGES]
salt dell dracr.create_user diana secret login,test_alerts,clear_logs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B DRAC Privileges
.INDENT 7.0
.IP \(bu 2
login                   : Login to iDRAC
.IP \(bu 2
drac                    : Configure iDRAC
.IP \(bu 2
user_management         : Configure Users
.IP \(bu 2
clear_logs              : Clear Logs
.IP \(bu 2
server_control_commands : Execute Server Control Commands
.IP \(bu 2
console_redirection     : Access Console Redirection
.IP \(bu 2
virtual_media           : Access Virtual Media
.IP \(bu 2
test_alerts             : Test Alerts
.IP \(bu 2
debug_commands          : Execute Debug Commands
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.delete_user(username, uid=None, host=None, admin_username=None, admin_password=None)
Delete a user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.delete_user [USERNAME] [UID \- optional]
salt dell dracr.delete_user diana 4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.deploy_password(username, password, host=None, admin_username=None, admin_password=None, module=None)
Change the QuickDeploy password, used for switches as well
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.deploy_password [USERNAME] [PASSWORD]
    host=<remote DRAC> admin_username=<DRAC user>
    admin_password=<DRAC PW>
salt dell dracr.change_password diana secret
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that if only a username is specified then this module will look up
details for all 16 possible DRAC users.  This is time consuming, but might
be necessary if one is not sure which user slot contains the one you want.
Many late\-model Dell chassis have \(aqroot\(aq as UID 1, so if you can depend
on that then setting the password is much quicker.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.deploy_snmp(snmp, host=None, admin_username=None, admin_password=None, module=None)
Change the QuickDeploy SNMP community string, used for switches as well
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.deploy_snmp SNMP_STRING
    host=<remote DRAC or CMC> admin_username=<DRAC user>
    admin_password=<DRAC PW>
salt dell dracr.deploy_password diana secret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.email_alerts(action, host=None, admin_username=None, admin_password=None)
Enable/Disable email alerts
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.email_alerts True
salt dell dracr.email_alerts False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.get_chassis_datacenter(host=None, admin_username=None, admin_password=None)
Get the datacenter of the chassis.
.INDENT 7.0
.TP
.B host
The chassis host.
.TP
.B admin_username
The username used to access the chassis.
.TP
.B admin_password
The password used to access the chassis.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dracr.set_chassis_location host=111.222.333.444
   admin_username=root admin_password=secret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.get_chassis_location(host=None, admin_username=None, admin_password=None)
Get the location of the chassis.
.INDENT 7.0
.TP
.B host
The chassis host.
.TP
.B admin_username
The username used to access the chassis.
.TP
.B admin_password
The password used to access the chassis.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dracr.set_chassis_location host=111.222.333.444
   admin_username=root admin_password=secret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.get_chassis_name(host=None, admin_username=None, admin_password=None)
Get the name of a chassis.
.INDENT 7.0
.TP
.B host
The chassis host.
.TP
.B admin_username
The username used to access the chassis.
.TP
.B admin_password
The password used to access the chassis.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dracr.get_chassis_name host=111.222.333.444
    admin_username=root admin_password=secret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.get_dns_dracname(host=None, admin_username=None, admin_password=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.get_general(cfg_sec, cfg_var, host=None, admin_username=None, admin_password=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.get_slotname(slot, host=None, admin_username=None, admin_password=None)
Get the name of a slot number in the chassis.
.INDENT 7.0
.TP
.B slot
The number of the slot for which to obtain the name.
.TP
.B host
The chassis host.
.TP
.B admin_username
The username used to access the chassis.
.TP
.B admin_password
The password used to access the chassis.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local dracr.get_slotname 0 host=111.222.333.444
   admin_username=root admin_password=secret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.idrac_general(blade_name, command, idrac_password=None, host=None, admin_username=None, admin_password=None)
Run a generic racadm command against a particular
blade in a chassis.  Blades are usually named things like
\(aqserver\-1\(aq, \(aqserver\-2\(aq, etc.  If the iDRAC has a different
password than the CMC, then you can pass it with the
idrac_password kwarg.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBblade_name\fP \-\- Name of the blade to run the command on
.IP \(bu 2
\fBcommand\fP \-\- Command like to pass to racadm
.IP \(bu 2
\fBidrac_password\fP \-\- Password for the iDRAC if different from the CMC
.IP \(bu 2
\fBhost\fP \-\- Chassis hostname
.IP \(bu 2
\fBadmin_username\fP \-\- CMC username
.IP \(bu 2
\fBadmin_password\fP \-\- CMC password
.UNINDENT
.TP
.B Returns
stdout if the retcode is 0, otherwise a standard cmd.run_all dictionary
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt fx2 chassis.cmd idrac_general server\-1 \(aqget BIOS.SysProfileSettings\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.inventory(host=None, admin_username=None, admin_password=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.list_slotnames(host=None, admin_username=None, admin_password=None)
List the names of all slots in the chassis.
.INDENT 7.0
.TP
.B host
The chassis host.
.TP
.B admin_username
The username used to access the chassis.
.TP
.B admin_password
The password used to access the chassis.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local dracr.list_slotnames host=111.222.333.444
    admin_username=root admin_password=secret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.list_users(host=None, admin_username=None, admin_password=None, module=None)
List all DRAC users
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.list_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.nameservers(ns, host=None, admin_username=None, admin_password=None, module=None)
Configure the nameservers on the DRAC
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.nameservers [NAMESERVERS]
salt dell dracr.nameservers ns1.example.com ns2.example.com
    admin_username=root admin_password=calvin module=server\-1
    host=192.168.1.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.network_info(host=None, admin_username=None, admin_password=None, module=None)
Return Network Configuration
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.network_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.server_hardreset(host=None, admin_username=None, admin_password=None, module=None)
Performs a reset (reboot) operation on the managed server.
.INDENT 7.0
.TP
.B host
The chassis host.
.TP
.B admin_username
The username used to access the chassis.
.TP
.B admin_password
The password used to access the chassis.
.TP
.B module
The element to hard reset on the chassis such as a blade. If
not provided, the chassis will be reset.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.server_hardreset
salt dell dracr.server_hardreset module=server\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.server_power(status, host=None, admin_username=None, admin_password=None, module=None)
.INDENT 7.0
.TP
.B status
One of \(aqpowerup\(aq, \(aqpowerdown\(aq, \(aqpowercycle\(aq, \(aqhardreset\(aq,
\(aqgraceshutdown\(aq
.TP
.B host
The chassis host.
.TP
.B admin_username
The username used to access the chassis.
.TP
.B admin_password
The password used to access the chassis.
.TP
.B module
The element to reboot on the chassis such as a blade. If not provided,
the chassis will be rebooted.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.server_reboot
salt dell dracr.server_reboot module=server\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.server_poweroff(host=None, admin_username=None, admin_password=None, module=None)
Powers down the managed server.
.INDENT 7.0
.TP
.B host
The chassis host.
.TP
.B admin_username
The username used to access the chassis.
.TP
.B admin_password
The password used to access the chassis.
.TP
.B module
The element to power off on the chassis such as a blade.
If not provided, the chassis will be powered off.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.server_poweroff
salt dell dracr.server_poweroff module=server\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.server_poweron(host=None, admin_username=None, admin_password=None, module=None)
Powers up the managed server.
.INDENT 7.0
.TP
.B host
The chassis host.
.TP
.B admin_username
The username used to access the chassis.
.TP
.B admin_password
The password used to access the chassis.
.TP
.B module
The element to power on located on the chassis such as a blade. If
not provided, the chassis will be powered on.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.server_poweron
salt dell dracr.server_poweron module=server\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.server_powerstatus(host=None, admin_username=None, admin_password=None, module=None)
return the power status for the passed module
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell drac.server_powerstatus
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.server_pxe(host=None, admin_username=None, admin_password=None)
Configure server to PXE perform a one off PXE boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.server_pxe
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.server_reboot(host=None, admin_username=None, admin_password=None, module=None)
Issues a power\-cycle operation on the managed server. This action is
similar to pressing the power button on the system\(aqs front panel to
power down and then power up the system.
.INDENT 7.0
.TP
.B host
The chassis host.
.TP
.B admin_username
The username used to access the chassis.
.TP
.B admin_password
The password used to access the chassis.
.TP
.B module
The element to reboot on the chassis such as a blade. If not provided,
the chassis will be rebooted.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.server_reboot
salt dell dracr.server_reboot module=server\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.set_chassis_datacenter(location, host=None, admin_username=None, admin_password=None)
Set the location of the chassis.
.INDENT 7.0
.TP
.B location
The name of the datacenter to be set on the chassis.
.TP
.B host
The chassis host.
.TP
.B admin_username
The username used to access the chassis.
.TP
.B admin_password
The password used to access the chassis.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dracr.set_chassis_datacenter datacenter\-name host=111.222.333.444
    admin_username=root admin_password=secret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.set_chassis_location(location, host=None, admin_username=None, admin_password=None)
Set the location of the chassis.
.INDENT 7.0
.TP
.B location
The name of the location to be set on the chassis.
.TP
.B host
The chassis host.
.TP
.B admin_username
The username used to access the chassis.
.TP
.B admin_password
The password used to access the chassis.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dracr.set_chassis_location location\-name host=111.222.333.444
    admin_username=root admin_password=secret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.set_chassis_name(name, host=None, admin_username=None, admin_password=None)
Set the name of the chassis.
.INDENT 7.0
.TP
.B name
The name to be set on the chassis.
.TP
.B host
The chassis host.
.TP
.B admin_username
The username used to access the chassis.
.TP
.B admin_password
The password used to access the chassis.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dracr.set_chassis_name my\-chassis host=111.222.333.444
    admin_username=root admin_password=secret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.set_dns_dracname(name, host=None, admin_username=None, admin_password=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.set_general(cfg_sec, cfg_var, val, host=None, admin_username=None, admin_password=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.set_network(ip, netmask, gateway, host=None, admin_username=None, admin_password=None)
Configure Network on the CMC or individual iDRAC.
Use \fBset_niccfg\fP for blade and switch addresses.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.set_network [DRAC IP] [NETMASK] [GATEWAY]
salt dell dracr.set_network 192.168.0.2 255.255.255.0 192.168.0.1
    admin_username=root admin_password=calvin host=192.168.1.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.set_niccfg(ip=None, netmask=None, gateway=None, dhcp=False, host=None, admin_username=None, admin_password=None, module=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.set_nicvlan(vlan=None, host=None, admin_username=None, admin_password=None, module=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.set_permissions(username, permissions, uid=None, host=None, admin_username=None, admin_password=None)
Configure users permissions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.set_permissions [USERNAME] [PRIVILEGES]
     [USER INDEX \- optional]
salt dell dracr.set_permissions diana login,test_alerts,clear_logs 4
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B DRAC Privileges
.INDENT 7.0
.IP \(bu 2
login                   : Login to iDRAC
.IP \(bu 2
drac                    : Configure iDRAC
.IP \(bu 2
user_management         : Configure Users
.IP \(bu 2
clear_logs              : Clear Logs
.IP \(bu 2
server_control_commands : Execute Server Control Commands
.IP \(bu 2
console_redirection     : Access Console Redirection
.IP \(bu 2
virtual_media           : Access Virtual Media
.IP \(bu 2
test_alerts             : Test Alerts
.IP \(bu 2
debug_commands          : Execute Debug Commands
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.set_slotname(slot, name, host=None, admin_username=None, admin_password=None)
Set the name of a slot in a chassis.
.INDENT 7.0
.TP
.B slot
The slot number to change.
.TP
.B name
The name to set. Can only be 15 characters long.
.TP
.B host
The chassis host.
.TP
.B admin_username
The username used to access the chassis.
.TP
.B admin_password
The password used to access the chassis.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dracr.set_slotname 2 my\-slotname host=111.222.333.444
    admin_username=root admin_password=secret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.set_snmp(community, host=None, admin_username=None, admin_password=None)
Configure CMC or individual iDRAC SNMP community string.
Use \fBdeploy_snmp\fP for configuring chassis switch SNMP.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.set_snmp [COMMUNITY]
salt dell dracr.set_snmp public
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.syslog(server, enable=True, host=None, admin_username=None, admin_password=None, module=None)
Configure syslog remote logging, by default syslog will automatically be
enabled if a server is specified. However, if you want to disable syslog
you will need to specify a server followed by False
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.syslog [SYSLOG IP] [ENABLE/DISABLE]
salt dell dracr.syslog 0.0.0.0 False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.system_info(host=None, admin_username=None, admin_password=None, module=None)
Return System information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.system_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.update_firmware(filename, host=None, admin_username=None, admin_password=None)
Updates firmware using local firmware file
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.update_firmware firmware.exe
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This executes the following command on your FX2
(using username and password stored in the pillar data)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
racadm update –f firmware.exe \-u user –p pass
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dracr.update_firmware_nfs_or_cifs(filename, share, host=None, admin_username=None, admin_password=None)
Executes the following for CIFS
(using username and password stored in the pillar data)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
racadm update \-f <updatefile> \-u user –p pass \-l //IP\-Address/share
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or for NFS
(using username and password stored in the pillar data)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
racadm update \-f <updatefile> \-u user –p pass \-l IP\-address:/share
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt command for CIFS:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.update_firmware_nfs_or_cifs          firmware.exe //IP\-Address/share
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt command for NFS:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dell dracr.update_firmware_nfs_or_cifs          firmware.exe IP\-address:/share
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.drbd
.sp
DRBD administration module
.INDENT 0.0
.TP
.B salt.modules.drbd.overview()
Show status of the DRBD devices, support two nodes only.
drbd\-overview is removed since drbd\-utils\-9.6.0,
use status instead.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq drbd.overview
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.drbd.status(name=\(aqall\(aq)
Using drbdadm to show status of the DRBD devices,
available in the latest drbd9.
Support multiple nodes, multiple volumes.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- Resource name.
.TP
.B Returns
drbd status of resource.
.TP
.B Return type
\fI\%list\fP(\fI\%dict\fP(res))
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq drbd.status
salt \(aq*\(aq drbd.status name=<resource name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.dummyproxy_pkg
.sp
Package support for the dummy proxy used by the test suite
.INDENT 0.0
.TP
.B salt.modules.dummyproxy_pkg.install(name=None, refresh=False, fromrepo=None, pkgs=None, sources=None, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dummyproxy_pkg.installed(name, version=None, refresh=False, fromrepo=None, skip_verify=False, pkgs=None, sources=None, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dummyproxy_pkg.list_pkgs(versions_as_list=False, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dummyproxy_pkg.remove(name=None, pkgs=None, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dummyproxy_pkg.upgrade(name=None, pkgs=None, refresh=True, skip_verify=True, normalize=True, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dummyproxy_pkg.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.dummyproxy_service
.sp
Provide the service module for the dummy proxy used in integration tests
.INDENT 0.0
.TP
.B salt.modules.dummyproxy_service.enabled(name, sig=None)
Only the \(aqredbull\(aq service is \(aqenabled\(aq in the test
.sp
New in version 2016.11.3.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dummyproxy_service.get_all()
Return a list of all available services
.sp
New in version 2016.11.3.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dummyproxy_service.list_()
Return a list of all available services.
.sp
New in version 2016.11.3.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dummyproxy_service.restart(name, sig=None)
Restart the specified service with dummy.
.sp
New in version 2016.11.3.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dummyproxy_service.running(name, sig=None)
Return whether this service is running.
.sp
New in version 2016.11.3.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dummyproxy_service.start(name, sig=None)
Start the specified service on the dummy
.sp
New in version 2016.11.3.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dummyproxy_service.status(name, sig=None)
Return the status for a service via dummy, returns a bool
whether the service is running.
.sp
New in version 2016.11.3.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.dummyproxy_service.stop(name, sig=None)
Stop the specified service on the dummy
.sp
New in version 2016.11.3.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.ebuildpkg
.sp
Support for Portage
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage packages on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B optdepends
.INDENT 7.0
.IP \(bu 2
portage Python adapter
.UNINDENT
.UNINDENT
.sp
For now all package names \fIMUST\fP include the package category,
i.e. \fB\(aqvim\(aq\fP will not work, \fB\(aqapp\-editors/vim\(aq\fP will.
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.available_version(*names, **kwargs)
This function is an alias of \fBlatest_version\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.check_db(*names, **kwargs)
New in version 0.17.0.

.sp
Returns a dict containing the following information for each specified
package:
.INDENT 7.0
.IP 1. 3
A key \fBfound\fP, which will be a boolean value denoting if a match was
found in the package database.
.IP 2. 3
If \fBfound\fP is \fBFalse\fP, then a second key called \fBsuggestions\fP will
be present, which will contain a list of possible matches. This list
will be empty if the package name was specified in \fBcategory/pkgname\fP
format, since the suggestions are only intended to disambiguate
ambiguous package names (ones submitted without a category).
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.check_db <package1> <package2> <package3>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.check_extra_requirements(pkgname, pkgver)
Check if the installed package already has the given requirements.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.check_extra_requirements \(aqsys\-devel/gcc\(aq \(aq~>4.1.2:4.1::gentoo[nls,fortran]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.depclean(name=None, slot=None, fromrepo=None, pkgs=None)
Portage has a function to remove unused dependencies. If a package
is provided, it will only removed the package if no other package
depends on it.
.INDENT 7.0
.TP
.B name
The name of the package to be cleaned.
.TP
.B slot
Restrict the remove to a specific slot. Ignored if \fBname\fP is None.
.TP
.B fromrepo
Restrict the remove to a specific slot. Ignored if \fBname\fP is None.
.TP
.B pkgs
Clean multiple packages. \fBslot\fP and \fBfromrepo\fP arguments are
ignored if this argument is present. Must be passed as a python list.
.UNINDENT
.sp
Return a list containing the removed packages:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.depclean <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.ex_mod_init(low)
If the config option \fBebuild.enforce_nice_config\fP is set to True, this
module will enforce a nice tree structure for /etc/portage/package.*
configuration files.
.sp
New in version 0.17.0: Initial automatic enforcement added when pkg is used on a Gentoo system.

.sp
Changed in version 2014.7.0: Configure option added to make this behaviour optional, defaulting to
off.

.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
\fBebuild.ex_mod_init\fP is called automatically when a state invokes a
pkg state on a Gentoo system.
\fBsalt.states.pkg.mod_init()\fP
.sp
\fBebuild.ex_mod_init\fP uses \fBportage_config.enforce_nice_config\fP to do
the lifting.
\fI\%salt.modules.portage_config.enforce_nice_config()\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.ex_mod_init
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.install(name=None, refresh=False, pkgs=None, sources=None, slot=None, fromrepo=None, uses=None, binhost=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any emerge commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Install the passed package(s), add refresh=True to sync the portage tree
before package is installed.
.INDENT 7.0
.TP
.B name
The name of the package to be installed. Note that this parameter is
ignored if either \(dqpkgs\(dq or \(dqsources\(dq is passed. Additionally, please
note that this option can only be used to emerge a package from the
portage tree. To install a tbz2 package manually, use the \(dqsources\(dq
option described below.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B refresh
Whether or not to sync the portage tree before installing.
.TP
.B version
Install a specific version of the package, e.g. 1.0.9\-r1. Ignored
if \(dqpkgs\(dq or \(dqsources\(dq is passed.
.TP
.B slot
Similar to version, but specifies a valid slot to be installed. It
will install the latest available version in the specified slot.
Ignored if \(dqpkgs\(dq or \(dqsources\(dq or \(dqversion\(dq is passed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install sys\-devel/gcc slot=\(aq4.4\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B fromrepo
Similar to slot, but specifies the repository from the package will be
installed. It will install the latest available version in the
specified repository.
Ignored if \(dqpkgs\(dq or \(dqsources\(dq or \(dqversion\(dq is passed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install salt fromrepo=\(aqgentoo\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B uses
Similar to slot, but specifies a list of use flag.
Ignored if \(dqpkgs\(dq or \(dqsources\(dq or \(dqversion\(dq is passed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install sys\-devel/gcc uses=\(aq[\(dqnptl\(dq,\(dq\-nossp\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Multiple Package Installation Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to install from the portage tree. Must be passed as
a python list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq,\(dqbar\(dq,\(dq~category/package:slot::repository[use]\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B sources
A list of tbz2 packages to install. Must be passed as a list of dicts,
with the keys being package names, and the values being the source URI
or local path to the package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install sources=\(aq[{\(dqfoo\(dq: \(dqsalt://foo.tbz2\(dq},{\(dqbar\(dq: \(dqsalt://bar.tbz2\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B binhost
has two options try and force.
try \- tells emerge to try and install the package from a configured binhost.
force \- forces emerge to install the package from a binhost otherwise it fails out.
.UNINDENT
.sp
Returns a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.latest_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.list_pkgs(versions_as_list=False, **kwargs)
List the packages currently installed in a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.list_upgrades(refresh=True, backtrack=3, **kwargs)
List all available package upgrades.
.INDENT 7.0
.TP
.B refresh
Whether or not to sync the portage tree before checking for upgrades.
.TP
.B backtrack
Specifies an integer number of times to backtrack if dependency
calculation fails due to a conflict or an unsatisfied dependency
(default: \'3\').
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.porttree_matches(name)
Returns a list containing the matches for a given package name from the
portage tree. Note that the specific version of the package will not be
provided for packages that have several versions in the portage tree, but
rather the name of the package (i.e. \(dqdev\-python/paramiko\(dq).
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.purge(name=None, slot=None, fromrepo=None, pkgs=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any emerge commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Portage does not have a purge, this function calls remove followed
by depclean to emulate a purge process
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.TP
.B slot
Restrict the remove to a specific slot. Ignored if name is None.
.TP
.B fromrepo
Restrict the remove to a specific slot. Ignored if \fBname\fP is None.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
Uninstall multiple packages. \fBslot\fP and \fBfromrepo\fP arguments are
ignored if this argument is present. Must be passed as a python list.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.purge <package name>
salt \(aq*\(aq pkg.purge <package name> slot=4.4
salt \(aq*\(aq pkg.purge <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.purge pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.refresh_db(**kwargs)
Update the portage tree using the first available method from the following
list:
.INDENT 7.0
.IP \(bu 2
emaint sync
.IP \(bu 2
eix\-sync
.IP \(bu 2
emerge\-webrsync
.IP \(bu 2
emerge \-\-sync
.UNINDENT
.sp
To prevent the portage tree from being synced within one day of the
previous sync, add the following pillar data for this minion:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
portage:
  sync_wait_one_day: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.remove(name=None, slot=None, fromrepo=None, pkgs=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any emerge commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Remove packages via emerge \-\-unmerge.
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.TP
.B slot
Restrict the remove to a specific slot. Ignored if \fBname\fP is None.
.TP
.B fromrepo
Restrict the remove to a specific slot. Ignored if \fBname\fP is None.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
Uninstall multiple packages. \fBslot\fP and \fBfromrepo\fP arguments are
ignored if this argument is present. Must be passed as a python list.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package name> slot=4.4 fromrepo=gentoo
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.update(pkg, slot=None, fromrepo=None, refresh=False, binhost=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any emerge commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Updates the passed package (emerge \-\-update package)
.INDENT 7.0
.TP
.B slot
Restrict the update to a particular slot. It will update to the
latest version within the slot.
.TP
.B fromrepo
Restrict the update to a particular repository. It will update to the
latest version within the repository.
.TP
.B binhost
has two options try and force.
try \- tells emerge to try and install the package from a configured binhost.
force \- forces emerge to install the package from a binhost otherwise it fails out.
.UNINDENT
.sp
Return a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.update <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.upgrade(refresh=True, binhost=None, backtrack=3, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any emerge commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Run a full system upgrade (emerge \-uDN @world)
.INDENT 7.0
.TP
.B binhost
has two options try and force.
try \- tells emerge to try and install the package from a configured binhost.
force \- forces emerge to install the package from a binhost otherwise it fails out.
.TP
.B backtrack
Specifies an integer number of times to backtrack if dependency
calculation fails due to a conflict or an unsatisfied dependency
(default: \'3\').
.sp
New in version 2015.8.0.

.UNINDENT
.sp
Returns a dictionary containing the changes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq:  {\(aqold\(aq: \(aq<old\-version>\(aq,
                \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.upgrade_available(name, **kwargs)
Check whether or not an upgrade is available for a given package
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade_available <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.version_clean(version)
Clean the version string removing extra data.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version_clean <version_string>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ebuildpkg.version_cmp(pkg1, pkg2, **kwargs)
Do a cmp\-style comparison on two packages. Return \-1 if pkg1 < pkg2, 0 if
pkg1 == pkg2, and 1 if pkg1 > pkg2. Return None if there was a problem
making the comparison.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version_cmp \(aq0.2.4\-0\(aq \(aq0.2.4.1\-0\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.eix
.sp
Support for Eix
.INDENT 0.0
.TP
.B salt.modules.eix.sync()
Sync portage/overlay trees and update the eix database
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq eix.sync
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.eix.update()
Update the eix database
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq eix.update
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.elasticsearch
.sp
Elasticsearch \- A distributed RESTful search and analytics server
.sp
Module to provide Elasticsearch compatibility to Salt
(compatible with Elasticsearch version 1.5.2+)
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B depends
\fI\%elasticsearch\-py\fP
.TP
.B configuration
This module accepts connection configuration details either as
parameters or as configuration settings in /etc/salt/minion on the relevant
minions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
elasticsearch:
  host: \(aq10.10.10.100:9200\(aq

elasticsearch\-cluster:
  hosts:
    \- \(aq10.10.10.100:9200\(aq
    \- \(aq10.10.10.101:9200\(aq
    \- \(aq10.10.10.102:9200\(aq

elasticsearch\-extra:
  hosts:
    \- \(aq10.10.10.100:9200\(aq
  use_ssl: True
  verify_certs: True
  ca_certs: /path/to/custom_ca_bundle.pem
  number_of_shards: 1
  number_of_replicas: 0
  functions_blacklist:
    \- \(aqsaltutil.find_job\(aq
    \- \(aqpillar.items\(aq
    \- \(aqgrains.items\(aq
  proxies:
    \- http: http://proxy:3128
    \- https: http://proxy:1080
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When specifying proxies the requests backend will be used and the \(aqproxies\(aq
data structure is passed as\-is to that module.
.sp
This data can also be passed into pillar. Options passed into opts will
overwrite options passed into pillar.
.sp
Some functionality might be limited by elasticsearch\-py and Elasticsearch server versions.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.alias_create(indices, alias, hosts=None, body=None, profile=None, source=None)
Create an alias for a specific index/indices
.INDENT 7.0
.TP
.B indices
Single or multiple indices separated by comma, use _all to perform the operation on all indices.
.TP
.B alias
Alias name
.TP
.B body
Optional definition such as routing or filter as defined in \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/indices\-aliases.html\fP
.TP
.B source
URL of file specifying optional definition such as routing or filter. Cannot be used in combination with \fBbody\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.alias_create testindex_v1 testindex
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.alias_delete(indices, aliases, hosts=None, body=None, profile=None, source=None)
Delete an alias of an index
.INDENT 7.0
.TP
.B indices
Single or multiple indices separated by comma, use _all to perform the operation on all indices.
.TP
.B aliases
Alias names separated by comma
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.alias_delete testindex_v1 testindex
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.alias_exists(aliases, indices=None, hosts=None, profile=None)
Return a boolean indicating whether given alias exists
.INDENT 7.0
.TP
.B indices
Single or multiple indices separated by comma, use _all to perform the operation on all indices.
.TP
.B aliases
Alias names separated by comma
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.alias_exists None testindex
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.alias_get(indices=None, aliases=None, hosts=None, profile=None)
Check for the existence of an alias and if it exists, return it
.INDENT 7.0
.TP
.B indices
Single or multiple indices separated by comma, use _all to perform the operation on all indices.
.TP
.B aliases
Alias names separated by comma
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.alias_get testindex
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.cluster_get_settings(flat_settings=False, include_defaults=False, hosts=None, profile=None)
New in version 3000.

.sp
Return Elasticsearch cluster settings.
.INDENT 7.0
.TP
.B flat_settings
Return settings in flat format.
.TP
.B include_defaults
Whether to return all default clusters setting.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.cluster_get_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.cluster_health(index=None, level=\(aqcluster\(aq, local=False, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Return Elasticsearch cluster health.
.INDENT 7.0
.TP
.B index
Limit the information returned to a specific index
.TP
.B level
Specify the level of detail for returned information, default \(aqcluster\(aq, valid choices are: \(aqcluster\(aq, \(aqindices\(aq, \(aqshards\(aq
.TP
.B local
Return local information, do not retrieve the state from master node
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.cluster_health
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.cluster_put_settings(body=None, flat_settings=False, hosts=None, profile=None)
New in version 3000.

.sp
Set Elasticsearch cluster settings.
.INDENT 7.0
.TP
.B body
The settings to be updated. Can be either \(aqtransient\(aq or \(aqpersistent\(aq (survives cluster restart)
\fI\%http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster\-update\-settings.html\fP
.TP
.B flat_settings
Return settings in flat format.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.cluster_put_settings \(aq{\(dqpersistent\(dq: {\(dqindices.recovery.max_bytes_per_sec\(dq: \(dq50mb\(dq}}\(aq
salt myminion elasticsearch.cluster_put_settings \(aq{\(dqtransient\(dq: {\(dqindices.recovery.max_bytes_per_sec\(dq: \(dq50mb\(dq}}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.cluster_stats(nodes=None, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Return Elasticsearch cluster stats.
.INDENT 7.0
.TP
.B nodes
List of cluster nodes (id or name) to display stats for. Use _local for connected node, empty for all
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.cluster_stats
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.document_create(index, doc_type, body=None, id=None, hosts=None, profile=None, source=None)
Create a document in a specified index
.INDENT 7.0
.TP
.B index
Index name where the document should reside
.TP
.B doc_type
Type of the document
.TP
.B body
Document to store
.TP
.B source
URL of file specifying document to store. Cannot be used in combination with \fBbody\fP\&.
.TP
.B id
Optional unique document identifier for specified doc_type (empty for random)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.document_create testindex doctype1 \(aq{}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.document_delete(index, doc_type, id, hosts=None, profile=None)
Delete a document from an index
.INDENT 7.0
.TP
.B index
Index name where the document resides
.TP
.B doc_type
Type of the document
.TP
.B id
Document identifier
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.document_delete testindex doctype1 AUx\-384m0Bug_8U80wQZ
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.document_exists(index, id, doc_type=\(aq_all\(aq, hosts=None, profile=None)
Return a boolean indicating whether given document exists
.INDENT 7.0
.TP
.B index
Index name where the document resides
.TP
.B id
Document identifier
.TP
.B doc_type
Type of the document, use _all to fetch the first document matching the ID across all types
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.document_exists testindex AUx\-384m0Bug_8U80wQZ
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.document_get(index, id, doc_type=\(aq_all\(aq, hosts=None, profile=None)
Check for the existence of a document and if it exists, return it
.INDENT 7.0
.TP
.B index
Index name where the document resides
.TP
.B id
Document identifier
.TP
.B doc_type
Type of the document, use _all to fetch the first document matching the ID across all types
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.document_get testindex AUx\-384m0Bug_8U80wQZ
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.flush_synced(hosts=None, profile=None, **kwargs)
New in version 3000.

.sp
Perform a normal flush, then add a generated unique marker (sync_id) to all shards.
\fI\%http://www.elastic.co/guide/en/elasticsearch/reference/current/indices\-synced\-flush.html\fP
.INDENT 7.0
.TP
.B index
(Optional, string) A comma\-separated list of index names; use _all or empty string for all indices. Defaults to \(aq_all\(aq.
.TP
.B ignore_unavailable
(Optional, boolean) If true, missing or closed indices are not included in the response. Defaults to false.
.TP
.B allow_no_indices
(Optional, boolean) If true, the request does not return an error if a wildcard expression or _all value retrieves only missing or closed indices.
This parameter also applies to index aliases that point to a missing or closed index.
.TP
.B expand_wildcards
(Optional, string) Controls what kind of indices that wildcard expressions can expand to.
.sp
Valid values are:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
all \- Expand to open and closed indices.
open \- Expand only to open indices.
closed \- Expand only to closed indices.
none \- Wildcard expressions are not accepted.
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The defaults settings for the above parameters depend on the API being used.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.flush_synced index=\(aqindex1,index2\(aq ignore_unavailable=True allow_no_indices=True expand_wildcards=\(aqall\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.index_close(index, allow_no_indices=True, expand_wildcards=\(aqopen\(aq, ignore_unavailable=True, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Close specified index.
.INDENT 7.0
.TP
.B index
Index to be closed
.TP
.B allow_no_indices
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)
.TP
.B expand_wildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both., default ‘open’, valid choices are: ‘open’, ‘closed’, ‘none’, ‘all’
.TP
.B ignore_unavailable
Whether specified concrete indices should be ignored when unavailable (missing or closed)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.index_close testindex
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.index_create(index, body=None, hosts=None, profile=None, source=None)
Create an index
.INDENT 7.0
.TP
.B index
Index name
.TP
.B body
Index definition, such as settings and mappings as defined in \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/indices\-create\-index.html\fP
.TP
.B source
URL to file specifying index definition. Cannot be used in combination with \fBbody\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.index_create testindex
salt myminion elasticsearch.index_create testindex2 \(aq{\(dqsettings\(dq : {\(dqindex\(dq : {\(dqnumber_of_shards\(dq : 3, \(dqnumber_of_replicas\(dq : 2}}}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.index_delete(index, hosts=None, profile=None)
Delete an index
.INDENT 7.0
.TP
.B index
Index name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.index_delete testindex
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.index_exists(index, hosts=None, profile=None)
Return a boolean indicating whether given index exists
.INDENT 7.0
.TP
.B index
Index name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.index_exists testindex
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.index_get(index, hosts=None, profile=None)
Check for the existence of an index and if it exists, return it
.INDENT 7.0
.TP
.B index
Index name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.index_get testindex
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.index_get_settings(hosts=None, profile=None, **kwargs)
New in version 3000.

.sp
Check for the existence of an index and if it exists, return its settings
\fI\%http://www.elastic.co/guide/en/elasticsearch/reference/current/indices\-get\-settings.html\fP
.INDENT 7.0
.TP
.B index
(Optional, string) A comma\-separated list of index names; use _all or empty string for all indices. Defaults to \(aq_all\(aq.
.TP
.B name
(Optional, string) The name of the settings that should be included
.TP
.B allow_no_indices
(Optional, boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices.
(This includes _all string or when no indices have been specified)
.TP
.B expand_wildcards
(Optional, string) Whether to expand wildcard expression to concrete indices that are open, closed or both.
Valid choices are: ‘open’, ‘closed’, ‘none’, ‘all’
.TP
.B flat_settings
(Optional, boolean) Return settings in flat format
.TP
.B ignore_unavailable
(Optional, boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
.TP
.B include_defaults
(Optional, boolean) Whether to return all default setting for each of the indices.
.TP
.B local
(Optional, boolean) Return local information, do not retrieve the state from master node
.UNINDENT
.sp
The defaults settings for the above parameters depend on the API version being used.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.index_get_settings index=testindex
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.index_open(index, allow_no_indices=True, expand_wildcards=\(aqclosed\(aq, ignore_unavailable=True, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Open specified index.
.INDENT 7.0
.TP
.B index
Index to be opened
.TP
.B allow_no_indices
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)
.TP
.B expand_wildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both., default ‘closed’, valid choices are: ‘open’, ‘closed’, ‘none’, ‘all’
.TP
.B ignore_unavailable
Whether specified concrete indices should be ignored when unavailable (missing or closed)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.index_open testindex
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.index_put_settings(body=None, hosts=None, profile=None, source=None, **kwargs)
New in version 3000.

.sp
Update existing index settings
\fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/indices\-update\-settings.html\fP
.INDENT 7.0
.TP
.B body
The index settings to be updated.
.TP
.B source
URL to file specifying index definition. Cannot be used in combination with \fBbody\fP\&.
.TP
.B index
(Optional, string) A comma\-separated list of index names; use _all or empty string to perform the operation on all indices
.TP
.B allow_no_indices
(Optional, boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices.
(This includes _all string or when no indices have been specified)
.TP
.B expand_wildcards
(Optional, string) Whether to expand wildcard expression to concrete indices that are open, closed or both.
Valid choices are: ‘open’, ‘closed’, ‘none’, ‘all’
.TP
.B flat_settings
(Optional, boolean) Return settings in flat format (default: false)
.TP
.B ignore_unavailable
(Optional, boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
.TP
.B master_timeout
(Optional, time units) Explicit operation timeout for connection to master node
.TP
.B preserve_existing
(Optional, boolean) Whether to update existing settings. If set to true existing settings on an index remain unchanged, the default is false
.UNINDENT
.sp
The defaults settings for the above parameters depend on the API version being used.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Elasticsearch time units can be found here:
\fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/common\-options.html#time\-units\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.index_put_settings index=testindex body=\(aq{\(dqsettings\(dq : {\(dqindex\(dq : {\(dqnumber_of_replicas\(dq : 2}}}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.index_template_create(name, body=None, hosts=None, profile=None, source=None)
Create an index template
.INDENT 7.0
.TP
.B name
Index template name
.TP
.B body
Template definition as specified in \fI\%http://www.elastic.co/guide/en/elasticsearch/reference/current/indices\-templates.html\fP
.TP
.B source
URL to file specifying template definition. Cannot be used in combination with \fBbody\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.index_template_create testindex_templ \(aq{ \(dqtemplate\(dq: \(dqlogstash\-*\(dq, \(dqorder\(dq: 1, \(dqsettings\(dq: { \(dqnumber_of_shards\(dq: 1 } }\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.index_template_delete(name, hosts=None, profile=None)
Delete an index template (type) along with its data
.INDENT 7.0
.TP
.B name
Index template name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.index_template_delete testindex_templ user
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.index_template_exists(name, hosts=None, profile=None)
Return a boolean indicating whether given index template exists
.INDENT 7.0
.TP
.B name
Index template name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.index_template_exists testindex_templ
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.index_template_get(name, hosts=None, profile=None)
Retrieve template definition of index or index/type
.INDENT 7.0
.TP
.B name
Index template name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.index_template_get testindex_templ
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.info(hosts=None, profile=None)
New in version 2017.7.0.

.sp
Return Elasticsearch information.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.info
salt myminion elasticsearch.info profile=elasticsearch\-extra
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.mapping_create(index, doc_type, body=None, hosts=None, profile=None, source=None)
Create a mapping in a given index
.INDENT 7.0
.TP
.B index
Index for the mapping
.TP
.B doc_type
Name of the document type
.TP
.B body
Mapping definition as specified in \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/indices\-put\-mapping.html\fP
.TP
.B source
URL to file specifying mapping definition. Cannot be used in combination with \fBbody\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.mapping_create testindex user \(aq{ \(dquser\(dq : { \(dqproperties\(dq : { \(dqmessage\(dq : {\(dqtype\(dq : \(dqstring\(dq, \(dqstore\(dq : true } } } }\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.mapping_delete(index, doc_type, hosts=None, profile=None)
Delete a mapping (type) along with its data. As of Elasticsearch 5.0 this is no longer available.
.INDENT 7.0
.TP
.B index
Index for the mapping
.TP
.B doc_type
Name of the document type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.mapping_delete testindex user
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.mapping_get(index, doc_type, hosts=None, profile=None)
Retrieve mapping definition of index or index/type
.INDENT 7.0
.TP
.B index
Index for the mapping
.TP
.B doc_type
Name of the document type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.mapping_get testindex user
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.node_info(nodes=None, flat_settings=False, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Return Elasticsearch node information.
.INDENT 7.0
.TP
.B nodes
List of cluster nodes (id or name) to display stats for. Use _local for connected node, empty for all
.TP
.B flat_settings
Flatten settings keys
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.node_info flat_settings=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.ping(allow_failure=False, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Test connection to Elasticsearch instance. This method does not fail if not explicitly specified.
.INDENT 7.0
.TP
.B allow_failure
Throw exception if ping fails
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.ping allow_failure=True
salt myminion elasticsearch.ping profile=elasticsearch\-extra
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.pipeline_create(id, body, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Create Ingest pipeline by supplied definition. Available since Elasticsearch 5.0.
.INDENT 7.0
.TP
.B id
Pipeline id
.TP
.B body
Pipeline definition as specified in \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/master/pipeline.html\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.pipeline_create mypipeline \(aq{\(dqdescription\(dq: \(dqmy custom pipeline\(dq, \(dqprocessors\(dq: [{\(dqset\(dq : {\(dqfield\(dq: \(dqcollector_timestamp_millis\(dq, \(dqvalue\(dq: \(dq{{_ingest.timestamp}}\(dq}}]}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.pipeline_delete(id, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Delete Ingest pipeline. Available since Elasticsearch 5.0.
.INDENT 7.0
.TP
.B id
Pipeline id
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.pipeline_delete mypipeline
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.pipeline_get(id, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Retrieve Ingest pipeline definition. Available since Elasticsearch 5.0.
.INDENT 7.0
.TP
.B id
Pipeline id
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.pipeline_get mypipeline
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.pipeline_simulate(id, body, verbose=False, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Simulate existing Ingest pipeline on provided data. Available since Elasticsearch 5.0.
.INDENT 7.0
.TP
.B id
Pipeline id
.TP
.B body
Pipeline definition as specified in \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/master/pipeline.html\fP
.TP
.B verbose
Specify if the output should be more verbose
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.pipeline_simulate mypipeline \(aq{\(dqdocs\(dq:[{\(dq_index\(dq:\(dqindex\(dq,\(dq_type\(dq:\(dqtype\(dq,\(dq_id\(dq:\(dqid\(dq,\(dq_source\(dq:{\(dqfoo\(dq:\(dqbar\(dq}},{\(dq_index\(dq:\(dqindex\(dq,\(dq_type\(dq:\(dqtype\(dq,\(dq_id\(dq:\(dqid\(dq,\(dq_source\(dq:{\(dqfoo\(dq:\(dqrab\(dq}}]}\(aq verbose=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.repository_create(name, body, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Create repository for storing snapshots. Note that shared repository paths have to be specified in path.repo Elasticsearch configuration option.
.INDENT 7.0
.TP
.B name
Repository name
.TP
.B body
Repository definition as in \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/modules\-snapshots.html\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.repository_create testrepo \(aq{\(dqtype\(dq:\(dqfs\(dq,\(dqsettings\(dq:{\(dqlocation\(dq:\(dq/tmp/test\(dq,\(dqcompress\(dq:true}}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.repository_delete(name, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Delete existing repository.
.INDENT 7.0
.TP
.B name
Repository name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.repository_delete testrepo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.repository_get(name, local=False, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Get existing repository details.
.INDENT 7.0
.TP
.B name
Repository name
.TP
.B local
Retrieve only local information, default is false
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.repository_get testrepo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.repository_verify(name, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Obtain list of cluster nodes which successfully verified this repository.
.INDENT 7.0
.TP
.B name
Repository name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.repository_verify testrepo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.search_template_create(id, body, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Create search template by supplied definition
.INDENT 7.0
.TP
.B id
Template ID
.TP
.B body
Search template definition
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.search_template_create mytemplate \(aq{\(dqtemplate\(dq:{\(dqquery\(dq:{\(dqmatch\(dq:{\(dqtitle\(dq:\(dq{{query_string}}\(dq}}}}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.search_template_delete(id, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Delete existing search template definition.
.INDENT 7.0
.TP
.B id
Template ID
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.search_template_delete mytemplate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.search_template_get(id, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Obtain existing search template definition.
.INDENT 7.0
.TP
.B id
Template ID
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.search_template_get mytemplate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.snapshot_create(repository, snapshot, body=None, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Create snapshot in specified repository by supplied definition.
.INDENT 7.0
.TP
.B repository
Repository name
.TP
.B snapshot
Snapshot name
.TP
.B body
Snapshot definition as in \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/modules\-snapshots.html\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.snapshot_create testrepo testsnapshot \(aq{\(dqindices\(dq:\(dqindex_1,index_2\(dq,\(dqignore_unavailable\(dq:true,\(dqinclude_global_state\(dq:false}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.snapshot_delete(repository, snapshot, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Delete snapshot from specified repository.
.INDENT 7.0
.TP
.B repository
Repository name
.TP
.B snapshot
Snapshot name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.snapshot_delete testrepo testsnapshot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.snapshot_get(repository, snapshot, ignore_unavailable=False, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Obtain snapshot residing in specified repository.
.INDENT 7.0
.TP
.B repository
Repository name
.TP
.B snapshot
Snapshot name, use _all to obtain all snapshots in specified repository
.TP
.B ignore_unavailable
Ignore unavailable snapshots
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.snapshot_get testrepo testsnapshot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.snapshot_restore(repository, snapshot, body=None, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Restore existing snapshot in specified repository by supplied definition.
.INDENT 7.0
.TP
.B repository
Repository name
.TP
.B snapshot
Snapshot name
.TP
.B body
Restore definition as in \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/modules\-snapshots.html\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.snapshot_restore testrepo testsnapshot \(aq{\(dqindices\(dq:\(dqindex_1,index_2\(dq,\(dqignore_unavailable\(dq:true,\(dqinclude_global_state\(dq:true}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.elasticsearch.snapshot_status(repository=None, snapshot=None, ignore_unavailable=False, hosts=None, profile=None)
New in version 2017.7.0.

.sp
Obtain status of all currently running snapshots.
.INDENT 7.0
.TP
.B repository
Particular repository to look for snapshots
.TP
.B snapshot
Snapshot name
.TP
.B ignore_unavailable
Ignore unavailable snapshots
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion elasticsearch.snapshot_status ignore_unavailable=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.environ
.sp
Support for getting and setting the environment variables
of the current salt process.
.INDENT 0.0
.TP
.B salt.modules.environ.get(key, default=\(aq\(aq)
Get a single salt process environment variable.
.INDENT 7.0
.TP
.B key
String used as the key for environment lookup.
.TP
.B default
If the key is not found in the environment, return this value.
Default: \(aq\(aq
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq environ.get foo
salt \(aq*\(aq environ.get baz default=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.environ.has_value(key, value=None)
Determine whether the key exists in the current salt process
environment dictionary. Optionally compare the current value
of the environment against the supplied value string.
.INDENT 7.0
.TP
.B key
Must be a string. Used as key for environment lookup.
.TP
.B value:
Optional. If key exists in the environment, compare the
current value with this value. Return True if they are equal.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq environ.has_value foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.environ.item(keys, default=\(aq\(aq)
Get one or more salt process environment variables.
Returns a dict.
.INDENT 7.0
.TP
.B keys
Either a string or a list of strings that will be used as the
keys for environment lookup.
.TP
.B default
If the key is not found in the environment, return this value.
Default: \(aq\(aq
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq environ.item foo
salt \(aq*\(aq environ.item \(aq[foo, baz]\(aq default=None
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.environ.items()
Return a dict of the entire environment set for the salt process
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq environ.items
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.environ.setenv(environ, false_unsets=False, clear_all=False, update_minion=False, permanent=False)
Set multiple salt process environment variables from a dict.
Returns a dict.
.INDENT 7.0
.TP
.B environ
Must be a dict. The top\-level keys of the dict are the names
of the environment variables to set. Each key\(aqs value must be
a string or False. Refer to the \(aqfalse_unsets\(aq parameter for
behavior when a value set to False.
.TP
.B false_unsets
If a key\(aqs value is False and false_unsets is True, then the
key will be removed from the salt processes environment dict
entirely. If a key\(aqs value is False and false_unsets is not
True, then the key\(aqs value will be set to an empty string.
Default: False
.TP
.B clear_all
USE WITH CAUTION! This option can unset environment variables
needed for salt to function properly.
If clear_all is True, then any environment variables not
defined in the environ dict will be deleted.
Default: False
.TP
.B update_minion
If True, apply these environ changes to the main salt\-minion
process. If False, the environ changes will only affect the
current salt subprocess.
Default: False
.TP
.B permanent
On Windows minions this will set the environment variable in the
registry so that it is always added as an environment variable when
applications open. If you want to set the variable to HKLM instead of
HKCU just pass in \(dqHKLM\(dq for this parameter. On all other minion types
this will be ignored. Note: This will only take affect on applications
opened after this has been set.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq environ.setenv \(aq{\(dqfoo\(dq: \(dqbar\(dq, \(dqbaz\(dq: \(dqquux\(dq}\(aq
salt \(aq*\(aq environ.setenv \(aq{\(dqa\(dq: \(dqb\(dq, \(dqc\(dq: False}\(aq false_unsets=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.environ.setval(key, val, false_unsets=False, permanent=False)
Set a single salt process environment variable. Returns True
on success.
.INDENT 7.0
.TP
.B key
The environment key to set. Must be a string.
.TP
.B val
The value to set. Must be a string or False. Refer to the
\(aqfalse_unsets\(aq parameter for behavior when set to False.
.TP
.B false_unsets
If val is False and false_unsets is True, then the key will be
removed from the salt processes environment dict entirely.
If val is False and false_unsets is not True, then the key\(aqs
value will be set to an empty string.
Default: False.
.TP
.B permanent
On Windows minions this will set the environment variable in the
registry so that it is always added as an environment variable when
applications open. If you want to set the variable to HKLM instead of
HKCU just pass in \(dqHKLM\(dq for this parameter. On all other minion types
this will be ignored. Note: This will only take affect on applications
opened after this has been set.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq environ.setval foo bar
salt \(aq*\(aq environ.setval baz val=False false_unsets=True
salt \(aq*\(aq environ.setval baz bar permanent=True
salt \(aq*\(aq environ.setval baz bar permanent=HKLM
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.eselect
.sp
Support for eselect, Gentoo\(aqs configuration and management tool.
.INDENT 0.0
.TP
.B salt.modules.eselect.exec_action(module, action, module_parameter=None, action_parameter=None, state_only=False)
Execute an arbitrary action on a module.
.INDENT 7.0
.TP
.B module
name of the module to be executed
.TP
.B action
name of the module\(aqs action to be run
.TP
.B module_parameter
additional params passed to the defined module
.TP
.B action_parameter
additional params passed to the defined action
.TP
.B state_only
don\(aqt return any output but only the success/failure of the operation
.UNINDENT
.sp
CLI Example (updating the \fBphp\fP implementation used for \fBapache2\fP):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq eselect.exec_action php update action_parameter=\(aqapache2\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.eselect.get_current_target(module, module_parameter=None, action_parameter=None)
Get the currently selected target for the given module.
.INDENT 7.0
.TP
.B module
name of the module to be queried for its current target
.TP
.B module_parameter
additional params passed to the defined module
.TP
.B action_parameter
additional params passed to the \(aqshow\(aq action
.UNINDENT
.sp
CLI Example (current target of system\-wide \fBjava\-vm\fP):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq eselect.get_current_target java\-vm action_parameter=\(aqsystem\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example (current target of \fBkernel\fP symlink):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq eselect.get_current_target kernel
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.eselect.get_modules()
List available \fBeselect\fP modules.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq eselect.get_modules
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.eselect.get_target_list(module, action_parameter=None)
List available targets for the given module.
.INDENT 7.0
.TP
.B module
name of the module to be queried for its targets
.TP
.B action_parameter
additional params passed to the defined action
.sp
New in version 2016.11.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq eselect.get_target_list kernel
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.eselect.set_target(module, target, module_parameter=None, action_parameter=None)
Set the target for the given module.
Target can be specified by index or name.
.INDENT 7.0
.TP
.B module
name of the module for which a target should be set
.TP
.B target
name of the target to be set for this module
.TP
.B module_parameter
additional params passed to the defined module
.TP
.B action_parameter
additional params passed to the defined action
.UNINDENT
.sp
CLI Example (setting target of system\-wide \fBjava\-vm\fP):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq eselect.set_target java\-vm icedtea\-bin\-7 action_parameter=\(aqsystem\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example (setting target of \fBkernel\fP symlink):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq eselect.set_target kernel linux\-3.17.5\-gentoo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.esxcluster
.sp
Module used to access the esxcluster proxy connection methods
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be deprecated in a future release of Salt. VMware strongly
recommends using the
\fI\%VMware Salt extensions\fP
instead of the ESX cluster module. Because the Salt extensions are newer and
actively supported by VMware, they are more compatible with current versions
of ESXi and they work well with the latest features in the VMware product
line.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.esxcluster.get_details()
.UNINDENT
.SS salt.modules.esxdatacenter
.sp
Module used to access the esxdatacenter proxy connection methods
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be deprecated in a future release of Salt. VMware strongly
recommends using the
\fI\%VMware Salt extensions\fP
instead of the ESX data center module. Because the Salt extensions are newer
and actively supported by VMware, they are more compatible with current
versions of ESXi and they work well with the latest features in the VMware
product line.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.esxdatacenter.get_details()
.UNINDENT
.SS salt.modules.esxi
.sp
Glues the VMware vSphere Execution Module to the VMware ESXi Proxy Minions to the
\fI\%esxi proxymodule\fP\&.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be deprecated in a future release of Salt. VMware strongly
recommends using the
\fI\%VMware Salt extensions\fP
instead of the ESXi module. Because the Salt extensions are newer and
actively supported by VMware, they are more compatible with current versions
of ESXi and they work well with the latest features in the VMware product
line.
.UNINDENT
.UNINDENT
.sp
Depends: \fI\%vSphere Remote Execution Module (salt.modules.vsphere)\fP
.sp
For documentation on commands that you can direct to an ESXi host via proxy,
look in the documentation for \fI\%salt.modules.vsphere\fP\&.
.sp
This execution module calls through to a function in the ESXi proxy module
called \fBch_config\fP, which looks up the function passed in the \fBcommand\fP
parameter in \fI\%salt.modules.vsphere\fP and calls it.
.sp
To execute commands with an ESXi Proxy Minion using the vSphere Execution Module,
use the \fBesxi.cmd <vsphere\-function\-name>\fP syntax. Both args and kwargs needed
for various vsphere execution module functions must be passed through in a kwarg\-
type manor.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqesxi\-proxy\(aq esxi.cmd system_info
salt \(aqexsi\-proxy\(aq esxi.cmd get_service_policy service_name=\(aqssh\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.esxi.cmd(command, *args, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.esxi.get_details()
.UNINDENT
.SS salt.modules.esxvm
.sp
Module used to access the esx proxy connection methods
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be deprecated in a future release of Salt. VMware strongly
recommends using the
\fI\%VMware Salt extensions\fP
instead of the ESX VSM module. Because the Salt extensions are newer and
actively supported by VMware, they are more compatible with current versions
of ESXi and they work well with the latest features in the VMware product
line.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.esxvm.get_details()
.UNINDENT
.SS salt.modules.etcd_mod
.sp
Execution module to work with etcd
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
python\-etcd or etcd3\-py
.UNINDENT
.UNINDENT
.SS Configuration
.sp
To work with an etcd server you must configure an etcd profile. The etcd config
can be set in either the Salt Minion configuration file or in pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_etd_config:
  etcd.host: 127.0.0.1
  etcd.port: 4001
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is technically possible to configure etcd without using a profile, but this
is not considered to be a best practice, especially when multiple etcd servers
or clusters are available.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.host: 127.0.0.1
etcd.port: 4001
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In order to choose whether to use etcd API v2 or v3, you can put the following
configuration option in the same place as your etcd configuration.  This option
defaults to true, meaning you will use v2 unless you specify otherwise.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.require_v2: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When using API v3, there are some specific options available to be configured
within your etcd profile.  They are defaulted to the following...
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.encode_keys: False
etcd.encode_values: True
etcd.raw_keys: False
etcd.raw_values: False
etcd.unicode_errors: \(dqsurrogateescape\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBetcd.encode_keys\fP indicates whether you want to pre\-encode keys using msgpack before
adding them to etcd.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you set \fBetcd.encode_keys\fP to \fBTrue\fP, all recursive functionality will no longer work.
This includes \fBtree\fP and \fBls\fP and all other methods if you set \fBrecurse\fP/\fBrecursive\fP to \fBTrue\fP\&.
This is due to the fact that when encoding with msgpack, keys like \fB/salt\fP and \fB/salt/stack\fP will have
differing byte prefixes, and etcd v3 searches recursively using prefixes.
.UNINDENT
.UNINDENT
.sp
\fBetcd.encode_values\fP indicates whether you want to pre\-encode values using msgpack before
adding them to etcd.  This defaults to \fBTrue\fP to avoid data loss on non\-string values wherever possible.
.sp
\fBetcd.raw_keys\fP determines whether you want the raw key or a string returned.
.sp
\fBetcd.raw_values\fP determines whether you want the raw value or a string returned.
.sp
\fBetcd.unicode_errors\fP determines what you policy to follow when there are encoding/decoding errors.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The etcd configuration can also be set in the Salt Master config file,
but in order to use any etcd configurations defined in the Salt Master
config, the \fI\%pillar_opts\fP must be set to \fBTrue\fP\&.
.sp
Be aware that setting \fBpillar_opts\fP to \fBTrue\fP has security implications
as this makes all master configuration settings available in all minion\(aqs
pillars.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.etcd_mod.get_(key, recurse=False, profile=None, **kwargs)
New in version 2014.7.0.

.sp
Get a value from etcd, by direct path.  Returns None on failure.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion etcd.get /path/to/key
salt myminion etcd.get /path/to/key profile=my_etcd_config
salt myminion etcd.get /path/to/key recurse=True profile=my_etcd_config
salt myminion etcd.get /path/to/key host=127.0.0.1 port=2379
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.etcd_mod.ls_(path=\(aq/\(aq, profile=None, **kwargs)
New in version 2014.7.0.

.sp
Return all keys and dirs inside a specific path. Returns an empty dict on
failure.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion etcd.ls /path/to/dir/
salt myminion etcd.ls /path/to/dir/ profile=my_etcd_config
salt myminion etcd.ls /path/to/dir/ host=127.0.0.1 port=2379
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.etcd_mod.rm_(key, recurse=False, profile=None, **kwargs)
New in version 2014.7.0.

.sp
Delete a key from etcd.  Returns True if the key was deleted, False if it was
not and None if there was a failure.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion etcd.rm /path/to/key
salt myminion etcd.rm /path/to/key profile=my_etcd_config
salt myminion etcd.rm /path/to/key host=127.0.0.1 port=2379
salt myminion etcd.rm /path/to/dir recurse=True profile=my_etcd_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.etcd_mod.set_(key, value, profile=None, ttl=None, directory=False, **kwargs)
New in version 2014.7.0.

.sp
Set a key in etcd by direct path. Optionally, create a directory
or set a TTL on the key.  Returns None on failure.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion etcd.set /path/to/key value
salt myminion etcd.set /path/to/key value profile=my_etcd_config
salt myminion etcd.set /path/to/key value host=127.0.0.1 port=2379
salt myminion etcd.set /path/to/dir \(aq\(aq directory=True
salt myminion etcd.set /path/to/key value ttl=5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.etcd_mod.tree(path=\(aq/\(aq, profile=None, **kwargs)
New in version 2014.7.0.

.sp
Recurse through etcd and return all values.  Returns None on failure.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion etcd.tree
salt myminion etcd.tree profile=my_etcd_config
salt myminion etcd.tree host=127.0.0.1 port=2379
salt myminion etcd.tree /path/to/keys profile=my_etcd_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.etcd_mod.update(fields, path=\(aq\(aq, profile=None, **kwargs)
New in version 2016.3.0.

.sp
Sets a dictionary of values in one call.  Useful for large updates
in syndic environments.  The dictionary can contain a mix of formats
such as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
  \(aq/some/example/key\(aq: \(aqbar\(aq,
  \(aq/another/example/key\(aq: \(aqbaz\(aq
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or it may be a straight dictionary, which will be flattened to look
like the above format:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqsome\(aq: {
        \(aqexample\(aq: {
            \(aqkey\(aq: \(aqbar\(aq
        }
    },
    \(aqanother\(aq: {
        \(aqexample\(aq: {
            \(aqkey\(aq: \(aqbaz\(aq
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can even mix the two formats and it will be flattened to the first
format.  Leading and trailing \(aq/\(aq will be removed.
.sp
Empty directories can be created by setting the value of the key to an
empty dictionary.
.sp
The \(aqpath\(aq parameter will optionally set the root of the path to use.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion etcd.update \(dq{\(aq/path/to/key\(aq: \(aqbaz\(aq, \(aq/another/key\(aq: \(aqbar\(aq}\(dq
salt myminion etcd.update \(dq{\(aq/path/to/key\(aq: \(aqbaz\(aq, \(aq/another/key\(aq: \(aqbar\(aq}\(dq profile=my_etcd_config
salt myminion etcd.update \(dq{\(aq/path/to/key\(aq: \(aqbaz\(aq, \(aq/another/key\(aq: \(aqbar\(aq}\(dq host=127.0.0.1 port=2379
salt myminion etcd.update \(dq{\(aq/path/to/key\(aq: \(aqbaz\(aq, \(aq/another/key\(aq: \(aqbar\(aq}\(dq path=\(aq/some/root\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.etcd_mod.watch(key, recurse=False, profile=None, timeout=0, index=None, **kwargs)
New in version 2016.3.0.

.sp
Makes a best effort to watch for a key or tree change in etcd.
Returns a dict containing the new key value ( or None if the key was
deleted ), the modifiedIndex of the key, whether the key changed or
not, the path to the key that changed and whether it is a directory or not.
.sp
If something catastrophic happens, returns {}
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion etcd.watch /path/to/key
salt myminion etcd.watch /path/to/key timeout=10
salt myminion etcd.watch /patch/to/key profile=my_etcd_config index=10
salt myminion etcd.watch /patch/to/key host=127.0.0.1 port=2379
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.ethtool
.sp
Module for running ethtool command
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B codeauthor
Krzysztof Pawlowski <\fI\%msciciel@msciciel.eu\fP>
.TP
.B maturity
new
.TP
.B depends
python\-ethtool
.TP
.B platform
linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ethtool.set_coalesce(devname, **kwargs)
Changes the coalescing settings of the specified network device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ethtool.set_coalesce <devname> [adaptive_rx=on|off] [adaptive_tx=on|off] [rx_usecs=N] [rx_frames=N]
    [rx_usecs_irq=N] [rx_frames_irq=N] [tx_usecs=N] [tx_frames=N] [tx_usecs_irq=N] [tx_frames_irq=N]
    [stats_block_usecs=N] [pkt_rate_low=N] [rx_usecs_low=N] [rx_frames_low=N] [tx_usecs_low=N] [tx_frames_low=N]
    [pkt_rate_high=N] [rx_usecs_high=N] [rx_frames_high=N] [tx_usecs_high=N] [tx_frames_high=N]
    [sample_interval=N]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ethtool.set_feature(devname, **kwargs)
New in version 3006.0.

.sp
Changes the feature parameters of the specified network device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ethtool.set_feature <devname> sg=off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ethtool.set_offload(devname, **kwargs)
Changes the offload parameters and other features of the specified network device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ethtool.set_offload <devname> tcp_segmentation_offload=on
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ethtool.set_pause(devname, **kwargs)
New in version 3006.0.

.sp
Changes the pause parameters of the specified network device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ethtool.set_pause <devname> autoneg=off rx=off tx=off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ethtool.set_ring(devname, **kwargs)
Changes the rx/tx ring parameters of the specified network device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ethtool.set_ring <devname> [rx=N] [rx_mini=N] [rx_jumbo=N] [tx=N]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ethtool.show_coalesce(devname)
Queries the specified network device for coalescing information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ethtool.show_coalesce <devname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ethtool.show_driver(devname)
Queries the specified network device for associated driver information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ethtool.show_driver <devname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ethtool.show_features(devname)
New in version 3006.0.

.sp
Queries the specified network device for associated feature information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ethtool.show_features <devname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ethtool.show_offload(devname)
Queries the specified network device for the state of protocol offload and other features
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ethtool.show_offload <devname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ethtool.show_pause(devname)
New in version 3006.0.

.sp
Queries the specified network device for associated pause information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ethtool.show_pause <devname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ethtool.show_ring(devname)
Queries the specified network device for rx/tx ring parameter information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ethtool.show_ring <devname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.event
.sp
Use the \fI\%Salt Event System\fP to fire events from the
master to the minion and vice\-versa.
.INDENT 0.0
.TP
.B salt.modules.event.fire(data, tag)
Fire an event on the local minion event bus. Data must be formed as a dict.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq event.fire \(aq{\(dqdata\(dq:\(dqmy event data\(dq}\(aq \(aqtag\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.event.fire_master(data, tag, preload=None)
Fire an event off up to the master server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq event.fire_master \(aq{\(dqdata\(dq:\(dqmy event data\(dq}\(aq \(aqtag\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.event.send(tag, data=None, preload=None, with_env=False, with_grains=False, with_pillar=False, with_env_opts=False, **kwargs)
Send an event to the Salt Master
.sp
New in version 2014.7.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtag\fP \-\- A tag to give the event.
Use slashes to create a namespace for related events. E.g.,
\fBmyco/build/buildserver1/start\fP, \fBmyco/build/buildserver1/success\fP,
\fBmyco/build/buildserver1/failure\fP\&.
.IP \(bu 2
\fBdata\fP \-\- A dictionary of data to send in the event.
This is free\-form. Send any data points that are needed for whoever is
consuming the event. Arguments on the CLI are interpreted as YAML so
complex data structures are possible.
.IP \(bu 2
\fBwith_env\fP (Specify \fBTrue\fP to include all environment variables, or
specify a list of strings of variable names to include.) \-\- Include environment variables from the current shell
environment in the event data as \fBenviron\fP\&.. This is a short\-hand for
working with systems that seed the environment with relevant data such
as Jenkins.
.IP \(bu 2
\fBwith_grains\fP (Specify \fBTrue\fP to include all grains, or specify a
list of strings of grain names to include.) \-\- Include grains from the current minion in the event
data as \fBgrains\fP\&.
.IP \(bu 2
\fBwith_pillar\fP (Specify \fBTrue\fP to include all Pillar values, or
specify a list of strings of Pillar keys to include. It is a
best\-practice to only specify a relevant subset of Pillar data.) \-\- Include Pillar values from the current minion in the
event data as \fBpillar\fP\&. Remember Pillar data is often sensitive data
so be careful. This is useful for passing ephemeral Pillar values
through an event. Such as passing the \fBpillar={}\fP kwarg in
\fI\%state.sls\fP from the Master, through
an event on the Minion, then back to the Master.
.IP \(bu 2
\fBwith_env_opts\fP (Specify \fBTrue\fP to include \fBsaltenv\fP and
\fBpillarenv\fP values or \fBFalse\fP to omit them.) \-\- Include \fBsaltenv\fP and \fBpillarenv\fP set on minion
at the moment when event is send into event data.
.IP \(bu 2
\fBkwargs\fP \-\- Any additional keyword arguments passed to this function
will be interpreted as key\-value pairs and included in the event data.
This provides a convenient alternative to YAML for simple values.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call event.send myco/mytag foo=Foo bar=Bar
salt\-call event.send \(aqmyco/mytag\(aq \(aq{foo: Foo, bar: Bar}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.extfs
.sp
Module for managing ext2/3/4 file systems
.INDENT 0.0
.TP
.B salt.modules.extfs.attributes(device, args=None)
Return attributes from dumpe2fs for a specified device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq extfs.attributes /dev/sda1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.extfs.blocks(device, args=None)
Return block and inode info from dumpe2fs for a specified device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq extfs.blocks /dev/sda1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.extfs.dump(device, args=None)
Return all contents of dumpe2fs for a specified device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq extfs.dump /dev/sda1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.extfs.mkfs(device, fs_type, full_return=False, **kwargs)
Create a file system on the specified device
.INDENT 7.0
.TP
.B full_return
False
If \fBTrue\fP, the full \fBcmd.run_all\fP dictionary will be returned
instead of just stdout/stderr text. Useful for setting the result of
the \fBmodule.run\fP state.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq extfs.mkfs /dev/sda1 fs_type=ext4 opts=\(aqacl,noexec\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Valid options are:
.INDENT 7.0
.IP \(bu 2
\fBblock_size\fP: 1024, 2048 or 4096
.IP \(bu 2
\fBcheck\fP: check for bad blocks
.IP \(bu 2
\fBdirect\fP: use direct IO
.IP \(bu 2
\fBext_opts\fP: extended file system options (comma\-separated)
.IP \(bu 2
\fBfragment_size\fP: size of fragments
.IP \(bu 2
\fBforce\fP: setting force to True will cause mke2fs to specify the \-F
option twice (it is already set once); this is truly dangerous
.IP \(bu 2
\fBblocks_per_group\fP: number of blocks in a block group
.IP \(bu 2
\fBnumber_of_groups\fP: ext4 option for a virtual block group
.IP \(bu 2
\fBbytes_per_inode\fP: set the bytes/inode ratio
.IP \(bu 2
\fBinode_size\fP: size of the inode
.IP \(bu 2
\fBjournal\fP: set to True to create a journal (default on ext3/4)
.IP \(bu 2
\fBjournal_opts\fP: options for the fs journal (comma separated)
.IP \(bu 2
\fBblocks_file\fP: read bad blocks from file
.IP \(bu 2
\fBlabel\fP: label to apply to the file system
.IP \(bu 2
\fBreserved\fP: percentage of blocks reserved for super\-user
.IP \(bu 2
\fBlast_dir\fP: last mounted directory
.IP \(bu 2
\fBtest\fP: set to True to not actually create the file system (mke2fs \-n)
.IP \(bu 2
\fBnumber_of_inodes\fP: override default number of inodes
.IP \(bu 2
\fBcreator_os\fP: override \(dqcreator operating system\(dq field
.IP \(bu 2
\fBopts\fP: mount options (comma separated)
.IP \(bu 2
\fBrevision\fP: set the filesystem revision (default 1)
.IP \(bu 2
\fBsuper\fP: write superblock and group descriptors only
.IP \(bu 2
\fBfs_type\fP: set the filesystem type (REQUIRED)
.IP \(bu 2
\fBusage_type\fP: how the filesystem is going to be used
.IP \(bu 2
\fBuuid\fP: set the UUID for the file system
.IP \(bu 2
\fBcluster_size\fP: specify the size of cluster in bytes for file systems using the bigalloc feature
.IP \(bu 2
\fBroot_directory\fP: copy the contents of the given directory into the root directory of the file system
.IP \(bu 2
\fBerrors_behavior\fP: change the behavior of the kernel code when errors are detected
.UNINDENT
.sp
See the \fBmke2fs(8)\fP manpage for a more complete description of these
options.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.extfs.tune(device, full_return=False, **kwargs)
Set attributes for the specified device (using tune2fs)
.INDENT 7.0
.TP
.B full_return
False
If \fBTrue\fP, the full \fBcmd.run_all\fP dictionary will be returned
instead of just stdout/stderr text. Useful for setting the result of
the \fBmodule.run\fP state.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq extfs.tune /dev/sda1 force=True label=wildstallyns opts=\(aqacl,noexec\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Valid options are:
.INDENT 7.0
.IP \(bu 2
\fBmax\fP: max mount count
.IP \(bu 2
\fBcount\fP: mount count
.IP \(bu 2
\fBerror\fP: error behavior
.IP \(bu 2
\fBextended_opts\fP: extended options (comma separated)
.IP \(bu 2
\fBforce\fP: force, even if there are errors (set to True)
.IP \(bu 2
\fBgroup\fP: group name or gid that can use the reserved blocks
.IP \(bu 2
\fBinterval\fP: interval between checks
.IP \(bu 2
\fBjournal\fP: set to True to create a journal (default on ext3/4)
.IP \(bu 2
\fBjournal_opts\fP: options for the fs journal (comma separated)
.IP \(bu 2
\fBlabel\fP: label to apply to the file system
.IP \(bu 2
\fBreserved_percentage\fP: percentage of blocks reserved for super\-user
.IP \(bu 2
\fBlast_dir\fP: last mounted directory
.IP \(bu 2
\fBopts\fP: mount options (comma separated)
.IP \(bu 2
\fBfeature\fP: set or clear a feature (comma separated)
.IP \(bu 2
\fBmmp_check\fP: mmp check interval
.IP \(bu 2
\fBreserved\fP: reserved blocks count
.IP \(bu 2
\fBquota_opts\fP: quota options (comma separated)
.IP \(bu 2
\fBtime\fP: time last checked
.IP \(bu 2
\fBuser\fP: user or uid who can use the reserved blocks
.IP \(bu 2
\fBuuid\fP: set the UUID for the file system
.UNINDENT
.sp
See the \fBmke2fs(8)\fP manpage for a more complete description of these
options.
.UNINDENT
.SS salt.modules.file
.sp
Manage information about regular files, directories,
and special files on the minion, set/read user,
group, mode, and data
.INDENT 0.0
.TP
.B class  salt.modules.file.AttrChanges(added, removed)
.INDENT 7.0
.TP
.B added
Alias for field number 0
.UNINDENT
.INDENT 7.0
.TP
.B removed
Alias for field number 1
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.access(path, mode)
New in version 2014.1.0.

.sp
Test whether the Salt process has the specified access to the file. One of
the following modes must be specified:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
f: Test the existence of the path
r: Test the readability of the path
w: Test the writability of the path
x: Test whether the path can be executed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.access /path/to/file f
salt \(aq*\(aq file.access /path/to/file x
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.append(path, *args, **kwargs)
New in version 0.9.5.

.sp
Append text to the end of a file
.INDENT 7.0
.TP
.B path
path to file
.TP
.B \fI*args\fP
strings to append to file
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.append /etc/motd \e
        \(dqWith all thine offerings thou shalt offer salt.\(dq \e
        \(dqSalt is what makes things taste bad when it isn\(aqt in them.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Attention"
.sp
If you need to pass a string to append and that string contains
an equal sign, you \fBmust\fP include the argument name, args.
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.append /etc/motd args=\(aqcheese=spam\(aq

salt \(aq*\(aq file.append /etc/motd args=\(dq[\(aqcheese=spam\(aq,\(aqspam=cheese\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.apply_template_on_contents(contents, template, context, defaults, saltenv)
Return the contents after applying the templating engine
.INDENT 7.0
.TP
.B contents
template string
.TP
.B template
template format
.TP
.B context
Overrides default context variables passed to the template.
.TP
.B defaults
Default context passed to the template.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.apply_template_on_contents \e
    contents=\(aqThis is a {{ template }} string.\(aq \e
    template=jinja \e
    \(dqcontext={}\(dq \(dqdefaults={\(aqtemplate\(aq: \(aqcool\(aq}\(dq \e
    saltenv=base
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.basename(path)
Returns the final component of a pathname
.sp
New in version 2015.5.0.

.sp
This can be useful at the CLI but is frequently useful when scripting.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set filename = salt[\(aqfile.basename\(aq](source_file) %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.basename \(aqtest/test.config\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.blockreplace(path, marker_start=\(aq#\-\- start managed zone \-\-\(aq, marker_end=\(aq#\-\- end managed zone \-\-\(aq, content=\(aq\(aq, append_if_not_found=False, prepend_if_not_found=False, backup=\(aq.bak\(aq, dry_run=False, show_changes=True, append_newline=False, insert_before_match=None, insert_after_match=None)
New in version 2014.1.0.

.sp
Replace content of a text block in a file, delimited by line markers
.sp
A block of content delimited by comments can help you manage several lines
entries without worrying about old entries removal.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function will store two copies of the file in\-memory (the original
version and the edited version) in order to detect changes and only
edit the targeted file if necessary.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
Filesystem path to the file to be edited
.TP
.B marker_start
The line content identifying a line as the start of the content block.
Note that the whole line containing this marker will be considered, so
whitespace or extra content before or after the marker is included in
final output
.TP
.B marker_end
The line content identifying the end of the content block. As of
versions 2017.7.5 and 2018.3.1, everything up to the text matching the
marker will be replaced, so it\(aqs important to ensure that your marker
includes the beginning of the text you wish to replace.
.TP
.B content
The content to be used between the two lines identified by marker_start
and marker_stop.
.TP
.B append_if_not_found: False
If markers are not found and set to \fBTrue\fP then, the markers and
content will be appended to the file.
.TP
.B prepend_if_not_found: False
If markers are not found and set to \fBTrue\fP then, the markers and
content will be prepended to the file.
.TP
.B insert_before_match
If markers are not found, this parameter can be set to a regex which will
insert the block before the first found occurrence in the file.
.sp
New in version 3001.

.TP
.B insert_after_match
If markers are not found, this parameter can be set to a regex which will
insert the block after the first found occurrence in the file.
.sp
New in version 3001.

.TP
.B backup
The file extension to use for a backup of the file if any edit is made.
Set to \fBFalse\fP to skip making a backup.
.TP
.B dry_run: False
If \fBTrue\fP, do not make any edits to the file and simply return the
changes that \fIwould\fP be made.
.TP
.B show_changes: True
Controls how changes are presented. If \fBTrue\fP, this function will
return a unified diff of the changes made. If False, then it will
return a boolean (\fBTrue\fP if any changes were made, otherwise
\fBFalse\fP).
.TP
.B append_newline: False
Controls whether or not a newline is appended to the content block. If
the value of this argument is \fBTrue\fP then a newline will be added to
the content block. If it is \fBFalse\fP, then a newline will \fInot\fP be
added to the content block. If it is \fBNone\fP then a newline will only
be added to the content block if it does not already end in a newline.
.sp
New in version 2016.3.4.

.sp
Changed in version 2017.7.5,2018.3.1: New behavior added when value is \fBNone\fP\&.

.sp
Changed in version 2019.2.0: The default value of this argument will change to \fBNone\fP to match
the behavior of the \fI\%file.blockreplace state\fP

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.blockreplace /etc/hosts \(aq#\-\- start managed zone foobar : DO NOT EDIT \-\-\(aq \e
\(aq#\-\- end managed zone foobar \-\-\(aq $\(aq10.0.1.1 foo.foobar\en10.0.1.2 bar.foobar\(aq True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.chattr(*files, **kwargs)
New in version 2018.3.0.

.sp
Change the attributes of files. This function accepts one or more files and
the following options:
.INDENT 7.0
.TP
.B operator
Can be wither \fBadd\fP or \fBremove\fP\&. Determines whether attributes
should be added or removed from files
.TP
.B attributes
One or more of the following characters: \fBaAcCdDeijPsStTu\fP,
representing attributes to add to/remove from files
.TP
.B version
a version number to assign to the file(s)
.TP
.B flags
One or more of the following characters: \fBRVf\fP, representing
flags to assign to chattr (recurse, verbose, suppress most errors)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.chattr foo1.txt foo2.txt operator=add attributes=ai
salt \(aq*\(aq file.chattr foo3.txt operator=remove attributes=i version=2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.check_file_meta(name, sfn, source, source_sum, user, group, mode, attrs, saltenv, contents=None, seuser=None, serole=None, setype=None, serange=None, verify_ssl=True, follow_symlinks=False)
Check for the changes in the file metadata.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.check_file_meta /etc/httpd/conf.d/httpd.conf None salt://http/httpd.conf \(aq{hash_type: \(aqmd5\(aq, \(aqhsum\(aq: <md5sum>}\(aq root root \(aq755\(aq None base
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Supported hash types include sha512, sha384, sha256, sha224, sha1, and
md5.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Path to file destination
.TP
.B sfn
Template\-processed source file contents
.TP
.B source
URL to file source
.TP
.B source_sum
File checksum information as a dictionary
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{hash_type: md5, hsum: <md5sum>}
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B user
Destination file user owner
.TP
.B group
Destination file group owner
.TP
.B mode
Destination file permissions mode
.TP
.B attrs
Destination file attributes
.sp
New in version 2018.3.0.

.TP
.B saltenv
Salt environment used to resolve source files
.TP
.B contents
File contents
.TP
.B seuser
selinux user attribute
.sp
New in version 3001.

.TP
.B serole
selinux role attribute
.sp
New in version 3001.

.TP
.B setype
selinux type attribute
.sp
New in version 3001.

.TP
.B serange
selinux range attribute
.sp
New in version 3001.

.TP
.B verify_ssl
If \fBFalse\fP, remote https file sources (\fBhttps://\fP)
will not attempt to validate the servers certificate. Default is True.
.sp
New in version 3002.

.TP
.B follow_symlinks
If the desired path is a symlink, follow it and check the permissions
of the file to which the symlink points.
.sp
New in version 3005.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.check_hash(path, file_hash)
Check if a file matches the given hash string
.sp
Returns \fBTrue\fP if the hash matches, otherwise \fBFalse\fP\&.
.INDENT 7.0
.TP
.B path
Path to a file local to the minion.
.TP
.B hash
The hash to check against the file specified in the \fBpath\fP argument.
.sp
Changed in version 2016.11.4.

.sp
For this and newer versions the hash can be specified without an
accompanying hash type (e.g. \fBe138491e9d5b97023cea823fe17bac22\fP),
but for earlier releases it is necessary to also specify the hash type
in the format \fB<hash_type>=<hash_value>\fP (e.g.
\fBmd5=e138491e9d5b97023cea823fe17bac22\fP).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.check_hash /etc/fstab e138491e9d5b97023cea823fe17bac22
salt \(aq*\(aq file.check_hash /etc/fstab md5=e138491e9d5b97023cea823fe17bac22
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.check_managed(name, source, source_hash, source_hash_name, user, group, mode, attrs, template, context, defaults, saltenv, contents=None, skip_verify=False, seuser=None, serole=None, setype=None, serange=None, follow_symlinks=False, **kwargs)
Check to see what changes need to be made for a file
.INDENT 7.0
.TP
.B follow_symlinks
If the desired path is a symlink, follow it and check the permissions
of the file to which the symlink points.
.sp
New in version 3005.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.check_managed /etc/httpd/conf.d/httpd.conf salt://http/httpd.conf \(aq{hash_type: \(aqmd5\(aq, \(aqhsum\(aq: <md5sum>}\(aq root, root, \(aq755\(aq jinja True None None base
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.check_managed_changes(name, source, source_hash, source_hash_name, user, group, mode, attrs, template, context, defaults, saltenv, contents=None, skip_verify=False, keep_mode=False, seuser=None, serole=None, setype=None, serange=None, verify_ssl=True, follow_symlinks=False, **kwargs)
Return a dictionary of what changes need to be made for a file
.sp
Changed in version 3001: selinux attributes added

.INDENT 7.0
.TP
.B verify_ssl
If \fBFalse\fP, remote https file sources (\fBhttps://\fP) and source_hash
will not attempt to validate the servers certificate. Default is True.
.sp
New in version 3002.

.TP
.B follow_symlinks
If the desired path is a symlink, follow it and check the permissions
of the file to which the symlink points.
.sp
New in version 3005.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.check_managed_changes /etc/httpd/conf.d/httpd.conf salt://http/httpd.conf \(aq{hash_type: \(aqmd5\(aq, \(aqhsum\(aq: <md5sum>}\(aq root, root, \(aq755\(aq jinja True None None base
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.check_perms(name, ret, user, group, mode, attrs=None, follow_symlinks=False, seuser=None, serole=None, setype=None, serange=None)
Changed in version 3001: Added selinux options

.sp
Check the permissions on files, modify attributes and chown if needed. File
attributes are only verified if lsattr(1) is installed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.check_perms /etc/sudoers \(aq{}\(aq root root 400 ai
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.1.3: \fBfollow_symlinks\fP option added

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.chgrp(path, group)
Change the group of a file
.INDENT 7.0
.TP
.B path
path to the file or directory
.TP
.B group
group owner
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.chgrp /etc/passwd root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.chown(path, user, group)
Chown a file, pass the file the desired user and group
.INDENT 7.0
.TP
.B path
path to the file or directory
.TP
.B user
user owner
.TP
.B group
group owner
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.chown /etc/passwd root root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.comment(path, regex, char=\(aq#\(aq, backup=\(aq.bak\(aq)
Deprecated since version 0.17.0: Use \fI\%replace()\fP instead.

.sp
Comment out specified lines in a file
.INDENT 7.0
.TP
.B path
The full path to the file to be edited
.TP
.B regex
A regular expression used to find the lines that are to be commented;
this pattern will be wrapped in parenthesis and will move any
preceding/trailing \fB^\fP or \fB$\fP characters outside the parenthesis
(e.g., the pattern \fB^foo$\fP will be rewritten as \fB^(foo)$\fP)
.TP
.B char: \fB#\fP
The character to be inserted at the beginning of a line in order to
comment it out
.TP
.B backup: \fB\&.bak\fP
The file will be backed up before edit with this file extension
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This backup will be overwritten each time \fBsed\fP / \fBcomment\fP /
\fBuncomment\fP is called. Meaning the backup will only be useful
after the first invocation.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.comment /etc/modules pcspkr
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.comment_line(path, regex, char=\(aq#\(aq, cmnt=True, backup=\(aq.bak\(aq)
Comment or Uncomment a line in a text file.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP \-\- string
The full path to the text file.
.IP \(bu 2
\fBregex\fP \-\- string
A regex expression that begins with \fB^\fP that will find the line you wish
to comment. Can be as simple as \fB^color =\fP
.IP \(bu 2
\fBchar\fP \-\- string
The character used to comment a line in the type of file you\(aqre referencing.
Default is \fB#\fP
.IP \(bu 2
\fBcmnt\fP \-\- boolean
True to comment the line. False to uncomment the line. Default is True.
.IP \(bu 2
\fBbackup\fP \-\- string
The file extension to give the backup file. Default is \fB\&.bak\fP
Set to False/None to not keep a backup.
.UNINDENT
.TP
.B Returns
boolean
Returns True if successful, False if not
.UNINDENT
.sp
CLI Example:
.sp
The following example will comment out the \fBpcspkr\fP line in the
\fB/etc/modules\fP file using the default \fB#\fP character and create a backup
file named \fBmodules.bak\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.comment_line \(aq/etc/modules\(aq \(aq^pcspkr\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.sp
The following example will uncomment the \fBlog_level\fP setting in \fBminion\fP
config file if it is set to either \fBwarning\fP, \fBinfo\fP, or \fBdebug\fP using
the \fB#\fP character and create a backup file named \fBminion.bk\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.comment_line \(aqC:\esalt\econf\eminion\(aq \(aq^log_level: (warning|info|debug)\(aq \(aq#\(aq False \(aq.bk\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.contains(path, text)
Deprecated since version 0.17.0: Use \fI\%search()\fP instead.

.sp
Return \fBTrue\fP if the file at \fBpath\fP contains \fBtext\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.contains /etc/crontab \(aqmymaintenance.sh\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.contains_glob(path, glob_expr)
Deprecated since version 0.17.0: Use \fI\%search()\fP instead.

.sp
Return \fBTrue\fP if the given glob matches a string in the named file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.contains_glob /etc/foobar \(aq*cheese*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.contains_regex(path, regex, lchar=\(aq\(aq)
Deprecated since version 0.17.0: Use \fI\%search()\fP instead.

.sp
Return True if the given regular expression matches on any line in the text
of a given file.
.sp
If the lchar argument (leading char) is specified, it
will strip \fIlchar\fP from the left side of each line before trying to match
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.contains_regex /etc/crontab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.copy(src, dst, recurse=False, remove_existing=False)
Copy a file or directory from source to dst
.sp
In order to copy a directory, the recurse flag is required, and
will by default overwrite files in the destination with the same path,
and retain all other existing files. (similar to cp \-r on unix)
.sp
remove_existing will remove all files in the target directory,
and then copy files from the source.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The copy function accepts paths that are local to the Salt minion.
This function does not support salt://, http://, or the other
additional file paths that are supported by \fI\%states.file.managed\fP and \fI\%states.file.recurse\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.copy /path/to/src /path/to/dst
salt \(aq*\(aq file.copy /path/to/src_dir /path/to/dst_dir recurse=True
salt \(aq*\(aq file.copy /path/to/src_dir /path/to/dst_dir recurse=True remove_existing=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.delete_backup(path, backup_id)
New in version 0.17.0.

.sp
Delete a previous version of a file that was backed up using Salt\(aqs
\fI\%file state backup\fP system.
.INDENT 7.0
.TP
.B path
The path on the minion to check for backups
.TP
.B backup_id
The numeric id for the backup you wish to delete, as found using
\fI\%file.list_backups\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.delete_backup /var/cache/salt/minion/file_backup/home/foo/bar/baz.txt 0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.directory_exists(path)
Tests to see if path is a valid directory.  Returns True/False.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.directory_exists /etc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.dirname(path)
Returns the directory component of a pathname
.sp
New in version 2015.5.0.

.sp
This can be useful at the CLI but is frequently useful when scripting.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- from salt[\(aqfile.dirname\(aq](tpldir) + \(aq/vars.jinja\(aq import parent_vars %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.dirname \(aqtest/path/filename.config\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.diskusage(path)
Recursively calculate disk usage of path and return it
in bytes
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.diskusage /path/to/check
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.extract_hash(hash_fn, hash_type=\(aqsha256\(aq, file_name=\(aq\(aq, source=\(aq\(aq, source_hash_name=None)
Changed in version 2016.3.5: Prior to this version, only the \fBfile_name\fP argument was considered
for filename matches in the hash file. This would be problematic for
cases in which the user was relying on a remote checksum file that they
do not control, and they wished to use a different name for that file
on the minion from the filename on the remote server (and in the
checksum file). For example, managing \fB/tmp/myfile.tar.gz\fP when the
remote file was at \fBhttps://mydomain.tld/different_name.tar.gz\fP\&. The
\fI\%file.managed\fP state now also
passes this function the source URI as well as the \fBsource_hash_name\fP
(if specified). In cases where \fBsource_hash_name\fP is specified, it
takes precedence over both the \fBfile_name\fP and \fBsource\fP\&. When it is
not specified, \fBfile_name\fP takes precedence over \fBsource\fP\&. This
allows for better capability for matching hashes.

.sp
Changed in version 2016.11.0: File name and source URI matches are no longer disregarded when
\fBsource_hash_name\fP is specified. They will be used as fallback
matches if there is no match to the \fBsource_hash_name\fP value.

.sp
This routine is called from the \fI\%file.managed\fP state to pull a hash from a remote file.
Regular expressions are used line by line on the \fBsource_hash\fP file, to
find a potential candidate of the indicated hash type. This avoids many
problems of arbitrary file layout rules. It specifically permits pulling
hash codes from debian \fB*.dsc\fP files.
.sp
If no exact match of a hash and filename are found, then the first hash
found (if any) will be returned. If no hashes at all are found, then
\fBNone\fP will be returned.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
openerp_7.0\-latest\-1.tar.gz:
  file.managed:
    \- name: /tmp/openerp_7.0\-20121227\-075624\-1_all.deb
    \- source: http://nightly.openerp.com/7.0/nightly/deb/openerp_7.0\-20121227\-075624\-1.tar.gz
    \- source_hash: http://nightly.openerp.com/7.0/nightly/deb/openerp_7.0\-20121227\-075624\-1.dsc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.extract_hash /path/to/hash/file sha512 /etc/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.file_exists(path)
Tests to see if path is a valid file.  Returns True/False.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.file_exists /etc/passwd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.find(path, *args, **kwargs)
Approximate the Unix \fBfind(1)\fP command and return a list of paths that
meet the specified criteria.
.sp
The options include match criteria:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
name    = path\-glob                 # case sensitive
iname   = path\-glob                 # case insensitive
regex   = path\-regex                # case sensitive
iregex  = path\-regex                # case insensitive
type    = file\-types                # match any listed type
user    = users                     # match any listed user
group   = groups                    # match any listed group
size    = [+\-]number[size\-unit]     # default unit = byte
mtime   = interval                  # modified since date
grep    = regex                     # search file contents
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
and/or actions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
delete [= file\-types]               # default type = \(aqf\(aq
exec    = command [arg ...]         # where {} is replaced by pathname
print  [= print\-opts]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
and/or depth criteria:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
maxdepth = maximum depth to transverse in path
mindepth = minimum depth to transverse before checking files or directories
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The default action is \fBprint=path\fP
.sp
\fBpath\-glob\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
*                = match zero or more chars
?                = match any char
[abc]            = match a, b, or c
[!abc] or [^abc] = match anything except a, b, and c
[x\-y]            = match chars x through y
[!x\-y] or [^x\-y] = match anything except chars x through y
{a,b,c}          = match a or b or c
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBpath\-regex\fP: a Python Regex (regular expression) pattern to match pathnames
.sp
\fBfile\-types\fP: a string of one or more of the following:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
a: all file types
b: block device
c: character device
d: directory
p: FIFO (named pipe)
f: plain file
l: symlink
s: socket
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBusers\fP: a space and/or comma separated list of user names and/or uids
.sp
\fBgroups\fP: a space and/or comma separated list of group names and/or gids
.sp
\fBsize\-unit\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
b: bytes
k: kilobytes
m: megabytes
g: gigabytes
t: terabytes
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
interval:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[<num>w] [<num>d] [<num>h] [<num>m] [<num>s]

where:
    w: week
    d: day
    h: hour
    m: minute
    s: second
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
print\-opts: a comma and/or space separated list of one or more of the
following:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
group: group name
md5:   MD5 digest of file contents
mode:  file permissions (as integer)
mtime: last modification time (as time_t)
name:  file basename
path:  file absolute path
size:  file size in bytes
type:  file type
user:  user name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.find / type=f name=\e*.bak size=+10m
salt \(aq*\(aq file.find /var mtime=+30d size=+10m print=path,size,mtime
salt \(aq*\(aq file.find /var/log name=\e*.[0\-9] mtime=+30d size=+10m delete
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.get_devmm(name)
Get major/minor info from a device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_devmm /dev/chr
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.get_diff(file1, file2, saltenv=\(aqbase\(aq, show_filenames=True, show_changes=True, template=False, source_hash_file1=None, source_hash_file2=None)
Return unified diff of two files
.INDENT 7.0
.TP
.B file1
The first file to feed into the diff utility
.sp
Changed in version 2018.3.0: Can now be either a local or remote file. In earlier releases,
thuis had to be a file local to the minion.

.TP
.B file2
The second file to feed into the diff utility
.sp
Changed in version 2018.3.0: Can now be either a local or remote file. In earlier releases, this
had to be a file on the salt fileserver (i.e.
\fBsalt://somefile.txt\fP)

.TP
.B show_filenames: True
Set to \fBFalse\fP to hide the filenames in the top two lines of the
diff.
.TP
.B show_changes: True
If set to \fBFalse\fP, and there are differences, then instead of a diff
a simple message stating that show_changes is set to \fBFalse\fP will be
returned.
.TP
.B template: False
Set to \fBTrue\fP if two templates are being compared. This is not useful
except for within states, with the \fBobfuscate_templates\fP option set
to \fBTrue\fP\&.
.sp
New in version 2018.3.0.

.TP
.B source_hash_file1
If \fBfile1\fP is an http(s)/ftp URL and the file exists in the minion\(aqs
file cache, this option can be passed to keep the minion from
re\-downloading the archive if the cached copy matches the specified
hash.
.sp
New in version 2018.3.0.

.TP
.B source_hash_file2
If \fBfile2\fP is an http(s)/ftp URL and the file exists in the minion\(aqs
file cache, this option can be passed to keep the minion from
re\-downloading the archive if the cached copy matches the specified
hash.
.sp
New in version 2018.3.0.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_diff /home/fred/.vimrc salt://users/fred/.vimrc
salt \(aq*\(aq file.get_diff /tmp/foo.txt /tmp/bar.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.get_gid(path, follow_symlinks=True)
Return the id of the group that owns a given file
.INDENT 7.0
.TP
.B path
file or directory of which to get the gid
.TP
.B follow_symlinks
indicated if symlinks should be followed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_gid /etc/passwd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 0.16.4: \fBfollow_symlinks\fP option added

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.get_group(path, follow_symlinks=True)
Return the group that owns a given file
.INDENT 7.0
.TP
.B path
file or directory of which to get the group
.TP
.B follow_symlinks
indicated if symlinks should be followed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_group /etc/passwd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 0.16.4: \fBfollow_symlinks\fP option added

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.get_hash(path, form=\(aqsha256\(aq, chunk_size=65536)
Get the hash sum of a file
.INDENT 7.0
.TP
.B This is better than \fBget_sum\fP for the following reasons:
.INDENT 7.0
.IP \(bu 2
It does not read the entire file into memory.
.IP \(bu 2
.INDENT 2.0
.TP
.B It does not return a string on error. The returned value of
\fBget_sum\fP cannot really be trusted since it is vulnerable to
collisions: \fBget_sum(..., \(aqxyz\(aq) == \(aqHash xyz not supported\(aq\fP
.UNINDENT
.UNINDENT
.TP
.B path
path to the file or directory
.TP
.B form
desired sum format
.TP
.B chunk_size
amount to sum at once
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_hash /etc/shadow
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.get_managed(name, template, source, source_hash, source_hash_name, user, group, mode, attrs, saltenv, context, defaults, skip_verify=False, verify_ssl=True, use_etag=False, source_hash_sig=None, signed_by_any=None, signed_by_all=None, keyring=None, gnupghome=None, **kwargs)
Return the managed file data for file.managed
.INDENT 7.0
.TP
.B name
location where the file lives on the server
.TP
.B template
template format
.TP
.B source
managed source file
.TP
.B source_hash
hash of the source file
.TP
.B source_hash_name
When \fBsource_hash\fP refers to a remote file, this specifies the
filename to look for in that file.
.sp
New in version 2016.3.5.

.TP
.B user
Owner of file
.TP
.B group
Group owner of file
.TP
.B mode
Permissions of file
.TP
.B attrs
Attributes of file
.sp
New in version 2018.3.0.

.TP
.B context
Variables to add to the template context
.TP
.B defaults
Default values of for context_dict
.TP
.B skip_verify
If \fBTrue\fP, hash verification of remote file sources (\fBhttp://\fP,
\fBhttps://\fP, \fBftp://\fP) will be skipped, and the \fBsource_hash\fP
argument will be ignored.
.sp
New in version 2016.3.0.

.TP
.B verify_ssl
If \fBFalse\fP, remote https file sources (\fBhttps://\fP) and source_hash
will not attempt to validate the servers certificate. Default is True.
.sp
New in version 3002.

.TP
.B use_etag
If \fBTrue\fP, remote http/https file sources will attempt to use the
ETag header to determine if the remote file needs to be downloaded.
This provides a lightweight mechanism for promptly refreshing files
changed on a web server without requiring a full hash comparison via
the \fBsource_hash\fP parameter.
.sp
New in version 3005.

.TP
.B source_hash_sig
When \fBsource\fP is a remote file source, \fBsource_hash\fP is a file,
\fBskip_verify\fP is not true and \fBuse_etag\fP is not true, ensure a
valid GPG signature exists on the source hash file.
Set this to \fBtrue\fP for an inline (clearsigned) signature, or to a
file URI retrievable by \fI:py:func:\(gacp.cache_file <salt.modules.cp.cache_file>\fP
for a detached one.
.sp
New in version 3007.0.

.TP
.B signed_by_any
When verifying \fBsource_hash_sig\fP, require at least one valid signature
from one of a list of key fingerprints. This is passed to \fI\%gpg.verify\fP\&.
.sp
New in version 3007.0.

.TP
.B signed_by_all
When verifying \fBsource_hash_sig\fP, require a valid signature from each
of the key fingerprints in this list. This is passed to \fI\%gpg.verify\fP\&.
.sp
New in version 3007.0.

.TP
.B keyring
When verifying \fBsource_hash_sig\fP, use this keyring.
.sp
New in version 3007.0.

.TP
.B gnupghome
When verifying \fBsource_hash_sig\fP, use this GnuPG home.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_managed /etc/httpd/conf.d/httpd.conf jinja salt://http/httpd.conf \(aq{hash_type: \(aqmd5\(aq, \(aqhsum\(aq: <md5sum>}\(aq None root root \(aq755\(aq base None None
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.get_mode(path, follow_symlinks=True)
Return the mode of a file
.INDENT 7.0
.TP
.B path
file or directory of which to get the mode
.TP
.B follow_symlinks
indicated if symlinks should be followed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_mode /etc/passwd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.1.0: \fBfollow_symlinks\fP option added

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.get_selinux_context(path)
Get an SELinux context from a given path
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_selinux_context /etc/hosts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.get_source_sum(file_name=\(aq\(aq, source=\(aq\(aq, source_hash=None, source_hash_name=None, saltenv=\(aqbase\(aq, verify_ssl=True, source_hash_sig=None, signed_by_any=None, signed_by_all=None, keyring=None, gnupghome=None)
New in version 2016.11.0.

.sp
Used by \fI\%file.get_managed\fP to
obtain the hash and hash type from the parameters specified below.
.INDENT 7.0
.TP
.B file_name
Optional file name being managed, for matching with
\fI\%file.extract_hash\fP\&.
.TP
.B source
Source file, as used in \fI\%file\fP and other
states. If \fBsource_hash\fP refers to a file containing hashes, then
this filename will be used to match a filename in that file. If the
\fBsource_hash\fP is a hash expression, then this argument will be
ignored.
.TP
.B source_hash
Hash file/expression, as used in \fI\%file\fP and
other states. If this value refers to a remote URL or absolute path to
a local file, it will be cached and \fI\%file.extract_hash\fP will be used to obtain a hash from
it.
.TP
.B source_hash_name
Specific file name to look for when \fBsource_hash\fP refers to a remote
file, used to disambiguate ambiguous matches.
.TP
.B saltenv: base
Salt fileserver environment from which to retrieve the source_hash. This
value will only be used when \fBsource_hash\fP refers to a file on the
Salt fileserver (i.e. one beginning with \fBsalt://\fP).
.TP
.B verify_ssl
If \fBFalse\fP, remote https file sources (\fBhttps://\fP) and source_hash
will not attempt to validate the servers certificate. Default is True.
.sp
New in version 3002.

.TP
.B source_hash_sig
When \fBsource\fP is a remote file source and \fBsource_hash\fP is a file,
ensure a valid GPG signature exists on the source hash file.
Set this to \fBtrue\fP for an inline (clearsigned) signature, or to a
file URI retrievable by \fI:py:func:\(gacp.cache_file <salt.modules.cp.cache_file>\fP
for a detached one.
.sp
New in version 3007.0.

.TP
.B signed_by_any
When verifying \fBsource_hash_sig\fP, require at least one valid signature
from one of a list of key fingerprints. This is passed to \fI\%gpg.verify\fP\&.
.sp
New in version 3007.0.

.TP
.B signed_by_all
When verifying \fBsource_hash_sig\fP, require a valid signature from each
of the key fingerprints in this list. This is passed to \fI\%gpg.verify\fP\&.
.sp
New in version 3007.0.

.TP
.B keyring
When verifying \fBsource_hash_sig\fP, use this keyring.
.sp
New in version 3007.0.

.TP
.B gnupghome
When verifying \fBsource_hash_sig\fP, use this GnuPG home.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_source_sum /tmp/foo.tar.gz source=http://mydomain.tld/foo.tar.gz source_hash=499ae16dcae71eeb7c3a30c75ea7a1a6
salt \(aq*\(aq file.get_source_sum /tmp/foo.tar.gz source=http://mydomain.tld/foo.tar.gz source_hash=https://mydomain.tld/hashes.md5
salt \(aq*\(aq file.get_source_sum /tmp/foo.tar.gz source=http://mydomain.tld/foo.tar.gz source_hash=https://mydomain.tld/hashes.md5 source_hash_name=./dir2/foo.tar.gz
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.get_sum(path, form=\(aqsha256\(aq)
Return the checksum for the given file. The following checksum algorithms
are supported:
.INDENT 7.0
.IP \(bu 2
md5
.IP \(bu 2
sha1
.IP \(bu 2
sha224
.IP \(bu 2
sha256 \fB(default)\fP
.IP \(bu 2
sha384
.IP \(bu 2
sha512
.UNINDENT
.INDENT 7.0
.TP
.B path
path to the file or directory
.TP
.B form
desired sum format
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_sum /etc/passwd sha512
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.get_uid(path, follow_symlinks=True)
Return the id of the user that owns a given file
.INDENT 7.0
.TP
.B path
file or directory of which to get the uid
.TP
.B follow_symlinks
indicated if symlinks should be followed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_uid /etc/passwd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 0.16.4: \fBfollow_symlinks\fP option added

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.get_user(path, follow_symlinks=True)
Return the user that owns a given file
.INDENT 7.0
.TP
.B path
file or directory of which to get the user
.TP
.B follow_symlinks
indicated if symlinks should be followed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_user /etc/passwd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 0.16.4: \fBfollow_symlinks\fP option added

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.gid_to_group(gid)
Convert the group id to the group name on this system
.INDENT 7.0
.TP
.B gid
gid to convert to a group name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.gid_to_group 0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.grep(path, pattern, *opts)
Grep for a string in the specified file
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function\(aqs return value is slated for refinement in future
versions of Salt
.sp
Windows does not support the \fBgrep\fP functionality.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
Path to the file to be searched
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Globbing is supported (i.e. \fB/var/log/foo/*.log\fP, but if globbing
is being used then the path should be quoted to keep the shell from
attempting to expand the glob expression.
.UNINDENT
.UNINDENT
.TP
.B pattern
Pattern to match. For example: \fBtest\fP, or \fBa[0\-5]\fP
.TP
.B opts
Additional command\-line flags to pass to the grep command. For example:
\fB\-v\fP, or \fB\-i \-B2\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The options should come after a double\-dash (as shown in the
examples below) to keep Salt\(aqs own argument parser from
interpreting them.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.grep /etc/passwd nobody
salt \(aq*\(aq file.grep /etc/sysconfig/network\-scripts/ifcfg\-eth0 ipaddr \-\- \-i
salt \(aq*\(aq file.grep /etc/sysconfig/network\-scripts/ifcfg\-eth0 ipaddr \-\- \-i \-B2
salt \(aq*\(aq file.grep \(dq/etc/sysconfig/network\-scripts/*\(dq ipaddr \-\- \-i \-l
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.group_to_gid(group)
Convert the group to the gid on this system
.INDENT 7.0
.TP
.B group
group to convert to its gid
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.group_to_gid root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.is_blkdev(name)
Check if a file exists and is a block device.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.is_blkdev /dev/blk
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.is_chrdev(name)
Check if a file exists and is a character device.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.is_chrdev /dev/chr
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.is_fifo(name)
Check if a file exists and is a FIFO.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.is_fifo /dev/fifo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.is_hardlink(path)
Check if the path is a hard link by verifying that the number of links
is larger than 1
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.is_hardlink /path/to/link
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.is_link(path)
Check if the path is a symbolic link
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.is_link /path/to/link
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.join(*args)
Return a normalized file system path for the underlying OS
.sp
New in version 2014.7.0.

.sp
This can be useful at the CLI but is frequently useful when scripting
combining path variables:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set www_root = \(aq/var\(aq %}
{% set app_dir = \(aqmyapp\(aq %}

myapp_config:
  file:
    \- managed
    \- name: {{ salt[\(aqfile.join\(aq](www_root, app_dir, \(aqconfig.yaml\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.join \(aq/\(aq \(aqusr\(aq \(aqlocal\(aq \(aqbin\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.lchown(path, user, group)
Chown a file, pass the file the desired user and group without following
symlinks.
.INDENT 7.0
.TP
.B path
path to the file or directory
.TP
.B user
user owner
.TP
.B group
group owner
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.chown /etc/passwd root root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.line(path, content=None, match=None, mode=None, location=None, before=None, after=None, show_changes=True, backup=False, quiet=False, indent=True)
New in version 2015.8.0.

.sp
Line\-focused editing of a file.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBfile.line\fP exists for historic reasons, and is not
generally recommended. It has a lot of quirks.  You may find
\fBfile.replace\fP to be more suitable.
.UNINDENT
.UNINDENT
.sp
\fBfile.line\fP is most useful if you have single lines in a file
(potentially a config file) that you would like to manage. It can
remove, add, and replace a single line at a time.
.INDENT 7.0
.TP
.B path
Filesystem path to the file to be edited.
.TP
.B content
Content of the line. Allowed to be empty if \fBmode=\(aqdelete\(aq\fP\&.
.TP
.B match
Match the target line for an action by
a fragment of a string or regular expression.
.sp
If neither \fBbefore\fP nor \fBafter\fP are provided, and \fBmatch\fP
is also \fBNone\fP, match falls back to the \fBcontent\fP value.
.TP
.B mode
Defines how to edit a line. One of the following options is
required:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B ensure
If line does not exist, it will be added. If \fBbefore\fP
and \fBafter\fP are specified either zero lines, or lines
that contain the \fBcontent\fP line are allowed to be in between
\fBbefore\fP and \fBafter\fP\&. If there are lines, and none of
them match then it will produce an error.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B replace
If line already exists, the entire line will be replaced.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B delete
Delete the line, if found.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B insert
Nearly identical to \fBensure\fP\&. If a line does not exist,
it will be added.
.sp
The differences are that multiple (and non\-matching) lines are
alloweed between \fBbefore\fP and \fBafter\fP, if they are
specified. The line will always be inserted right before
\fBbefore\fP\&. \fBinsert\fP also allows the use of \fBlocation\fP to
specify that the line should be added at the beginning or end of
the file.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If \fBmode=\(aqinsert\(aq\fP is used, at least one of \fBlocation\fP,
\fBbefore\fP, or \fBafter\fP is required.  If \fBlocation\fP is used,
\fBbefore\fP and \fBafter\fP are ignored.
.UNINDENT
.UNINDENT
.TP
.B location
In \fBmode=\(aqinsert\(aq\fP only, whether to place the \fBcontent\fP at the
beginning or end of a the file. If \fBlocation\fP is provided,
\fBbefore\fP and \fBafter\fP are ignored. Valid locations:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B start
Place the content at the beginning of the file.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B end
Place the content at the end of the file.
.UNINDENT
.UNINDENT
.TP
.B before
Regular expression or an exact case\-sensitive fragment of the string.
Will be tried as \fBboth\fP a regex \fBand\fP a part of the line.  Must
match \fBexactly\fP one line in the file.  This value is only used in
\fBensure\fP and \fBinsert\fP modes. The \fBcontent\fP will be inserted just
before this line, with matching indentation unless \fBindent=False\fP\&.
.TP
.B after
Regular expression or an exact case\-sensitive fragment of the string.
Will be tried as \fBboth\fP a regex \fBand\fP a part of the line.  Must
match \fBexactly\fP one line in the file.  This value is only used in
\fBensure\fP and \fBinsert\fP modes. The \fBcontent\fP will be inserted
directly after this line, unless \fBbefore\fP is also provided. If
\fBbefore\fP is not provided, indentation will match this line, unless
\fBindent=False\fP\&.
.TP
.B show_changes
Output a unified diff of the old file and the new file.
If \fBFalse\fP return a boolean if any changes were made.
Default is \fBTrue\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Using this option will store two copies of the file in\-memory
(the original version and the edited version) in order to generate the diff.
.UNINDENT
.UNINDENT
.TP
.B backup
Create a backup of the original file with the extension:
\(dqYear\-Month\-Day\-Hour\-Minutes\-Seconds\(dq.
.TP
.B quiet
Do not raise any exceptions. E.g. ignore the fact that the file that is
tried to be edited does not exist and nothing really happened.
.TP
.B indent
Keep indentation with the previous line. This option is not considered when
the \fBdelete\fP mode is specified. Default is \fBTrue\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.line /etc/nsswitch.conf \(dqnetworks:        files dns\(dq after=\(dqhosts:.*?\(dq mode=\(aqensure\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If an equal sign (\fB=\fP) appears in an argument to a Salt command, it is
interpreted as a keyword argument in the format of \fBkey=val\fP\&. That
processing can be bypassed in order to pass an equal sign through to the
remote shell command by manually specifying the kwarg:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.line /path/to/file content=\(dqCREATEMAIL_SPOOL=no\(dq match=\(dqCREATE_MAIL_SPOOL=yes\(dq mode=\(dqreplace\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExamples:\fP
.sp
Here\(aqs a simple config file.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[some_config]
# Some config file
# this line will go away

here=False
away=True
goodybe=away
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \e* file.line /some/file.conf mode=delete match=away
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will produce:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[some_config]
# Some config file

here=False
away=True
goodbye=away
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If that command is executed 2 more times, this will be the result:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[some_config]
# Some config file

here=False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If we reset the file to its original state and run
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \e* file.line /some/file.conf mode=replace match=away content=here
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Three passes will this state will result in this file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[some_config]
# Some config file
here

here=False
here
here
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Each pass replacing the first line found.
.sp
Given this file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
insert after me
something
insert before me
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following command
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \e* file.line /some/file.txt mode=insert after=\(dqinsert after me\(dq before=\(dqinsert before me\(dq content=thrice
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If that command is executed 3 times, the result will be:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
insert after me
something
thrice
thrice
thrice
insert before me
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the mode is \fBensure\fP instead, it will fail each time. To succeed, we
need to remove the incorrect line between before and after:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
insert after me
insert before me
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With an ensure mode, this will insert \fBthrice\fP the first time and
make no changes for subsequent calls. For something simple this is
fine, but if you have instead blocks like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Begin SomeBlock
    foo = bar
End

Begin AnotherBlock
    another = value
End
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And you try to use ensure this way:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \e* file.line  /tmp/fun.txt mode=\(dqensure\(dq content=\(dqthis = should be my content\(dq after=\(dqBegin SomeBlock\(dq before=\(dqEnd\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will fail because there are multiple \fBEnd\fP lines. Without that
problem, it still would fail because there is a non\-matching line,
\fBfoo = bar\fP\&. Ensure \fBonly\fP allows either zero, or the matching
line present to be present in between \fBbefore\fP and \fBafter\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.link(src, path)
New in version 2014.1.0.

.sp
Create a hard link to a file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.link /path/to/file /path/to/link
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.list_backup(path, limit=None)
This function is an alias of \fBlist_backups\fP\&.
.INDENT 7.0
.INDENT 3.5
New in version 0.17.0.

.sp
Lists the previous versions of a file backed up using Salt\(aqs \fI\%file
state backup\fP system.
.INDENT 0.0
.TP
.B path
The path on the minion to check for backups
.TP
.B limit
Limit the number of results to the most recent N backups
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.list_backups /foo/bar/baz.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.list_backups(path, limit=None)
New in version 0.17.0.

.sp
Lists the previous versions of a file backed up using Salt\(aqs \fI\%file
state backup\fP system.
.INDENT 7.0
.TP
.B path
The path on the minion to check for backups
.TP
.B limit
Limit the number of results to the most recent N backups
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.list_backups /foo/bar/baz.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.list_backups_dir(path, limit=None)
Lists the previous versions of a directory backed up using Salt\(aqs \fI\%file
state backup\fP system.
.INDENT 7.0
.TP
.B path
The directory on the minion to check for backups
.TP
.B limit
Limit the number of results to the most recent N backups
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.list_backups_dir /foo/bar/baz/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.lsattr(path)
New in version 2018.3.0.

.sp
Changed in version 2018.3.1: If \fBlsattr\fP is not installed on the system, \fBNone\fP is returned.

.sp
Changed in version 2018.3.4: If on \fBAIX\fP, \fBNone\fP is returned even if in filesystem as lsattr on \fBAIX\fP
is not the same thing as the linux version.

.sp
Obtain the modifiable attributes of the given file. If path
is to a directory, an empty list is returned.
.INDENT 7.0
.TP
.B path
path to file to obtain attributes of. File/directory must exist.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.lsattr foo1.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.lstat(path)
New in version 2014.1.0.

.sp
Returns the lstat attributes for the given file or dir. Does not support
symbolic links.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.lstat /path/to/file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.makedirs_(path, user=None, group=None, mode=None)
Ensure that the directory containing this path is available.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The path must end with a trailing slash otherwise the directory/directories
will be created up to the parent directory. For example if path is
\fB/opt/code\fP, then it would be treated as \fB/opt/\fP but if the path
ends with a trailing slash like \fB/opt/code/\fP, then it would be
treated as \fB/opt/code/\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.makedirs /opt/code/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.makedirs_perms(name, user=None, group=None, mode=\(aq0755\(aq)
Taken and modified from os.makedirs to set user, group and mode for each
directory created.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.makedirs_perms /opt/code
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.manage_file(name, sfn, ret, source, source_sum, user, group, mode, attrs, saltenv, backup, makedirs=False, template=None, show_changes=True, contents=None, dir_mode=None, follow_symlinks=True, skip_verify=False, keep_mode=False, encoding=None, encoding_errors=\(aqstrict\(aq, seuser=None, serole=None, setype=None, serange=None, verify_ssl=True, use_etag=False, signature=None, source_hash_sig=None, signed_by_any=None, signed_by_all=None, keyring=None, gnupghome=None, **kwargs)
Checks the destination against what was retrieved with get_managed and
makes the appropriate modifications (if necessary).
.INDENT 7.0
.TP
.B name
location to place the file
.TP
.B sfn
location of cached file on the minion
.sp
This is the path to the file stored on the minion. This file is placed
on the minion using cp.cache_file.  If the hash sum of that file
matches the source_sum, we do not transfer the file to the minion
again.
.sp
This file is then grabbed and if it has template set, it renders the
file to be placed into the correct place on the system using
salt.files.utils.copyfile()
.TP
.B ret
The initial state return data structure. Pass in \fBNone\fP to use the
default structure.
.TP
.B source
file reference on the master
.TP
.B source_sum
sum hash for source
.TP
.B user
user owner
.TP
.B group
group owner
.TP
.B backup
backup_mode
.TP
.B attrs
attributes to be set on file: \(aq\(aq means remove all of them
.sp
New in version 2018.3.0.

.TP
.B makedirs
make directories if they do not exist
.TP
.B template
format of templating
.TP
.B show_changes
Include diff in state return
.TP
.B contents:
contents to be placed in the file
.TP
.B dir_mode
mode for directories created with makedirs
.TP
.B skip_verify: False
If \fBTrue\fP, hash verification of remote file sources (\fBhttp://\fP,
\fBhttps://\fP, \fBftp://\fP) will be skipped, and the \fBsource_hash\fP
argument will be ignored.
.sp
New in version 2016.3.0.

.TP
.B keep_mode: False
If \fBTrue\fP, and the \fBsource\fP is a file from the Salt fileserver (or
a local file on the minion), the mode of the destination file will be
set to the mode of the source file.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
keep_mode does not work with salt\-ssh.
.sp
As a consequence of how the files are transferred to the minion, and
the inability to connect back to the master with salt\-ssh, salt is
unable to stat the file as it exists on the fileserver and thus
cannot mirror the mode on the salt\-ssh minion
.UNINDENT
.UNINDENT
.TP
.B encoding
If specified, then the specified encoding will be used. Otherwise, the
file will be encoded using the system locale (usually UTF\-8). See
\fI\%https://docs.python.org/3/library/codecs.html#standard\-encodings\fP for
the list of available encodings.
.sp
New in version 2017.7.0.

.TP
.B encoding_errors: \(aqstrict\(aq
Default is \fB\(ga\(aqstrict\(aq\(ga\fP\&.
See \fI\%https://docs.python.org/2/library/codecs.html#codec\-base\-classes\fP
for the error handling schemes.
.sp
New in version 2017.7.0.

.TP
.B seuser
selinux user attribute
.sp
New in version 3001.

.TP
.B serange
selinux range attribute
.sp
New in version 3001.

.TP
.B setype
selinux type attribute
.sp
New in version 3001.

.TP
.B serange
selinux range attribute
.sp
New in version 3001.

.TP
.B verify_ssl
If \fBFalse\fP, remote https file sources (\fBhttps://\fP)
will not attempt to validate the servers certificate. Default is True.
.sp
New in version 3002.

.TP
.B use_etag
If \fBTrue\fP, remote http/https file sources will attempt to use the
ETag header to determine if the remote file needs to be downloaded.
This provides a lightweight mechanism for promptly refreshing files
changed on a web server without requiring a full hash comparison via
the \fBsource_hash\fP parameter.
.sp
New in version 3005.

.TP
.B signature
Ensure a valid GPG signature exists on the selected \fBsource\fP file.
Set this to true for inline signatures, or to a file URI retrievable
by \fI:py:func:\(gacp.cache_file <salt.modules.cp.cache_file>\fP
for a detached one.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A signature is only enforced directly after caching the file,
before it is moved to its final destination. Existing target files
(with the correct checksum) will neither be checked nor deleted.
.sp
It will be enforced regardless of source type and will be
required on the final output, therefore this does not lend itself
well when templates are rendered.
The file will not be modified, meaning inline signatures are not
removed.
.UNINDENT
.UNINDENT
.sp
New in version 3007.0.

.TP
.B source_hash_sig
When \fBsource\fP is a remote file source, \fBsource_hash\fP is a file,
\fBskip_verify\fP is not true and \fBuse_etag\fP is not true, ensure a
valid GPG signature exists on the source hash file.
Set this to \fBtrue\fP for an inline (clearsigned) signature, or to a
file URI retrievable by \fI:py:func:\(gacp.cache_file <salt.modules.cp.cache_file>\fP
for a detached one.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A signature on the \fBsource_hash\fP file is enforced regardless of
changes since its contents are used to check if an existing file
is in the correct state \- but only for remote sources!
As for \fBsignature\fP, existing target files will not be modified,
only the cached source_hash and source_hash_sig files will be removed.
.UNINDENT
.UNINDENT
.sp
New in version 3007.0.

.TP
.B signed_by_any
When verifying signatures either on the managed file or its source hash file,
require at least one valid signature from one of a list of key fingerprints.
This is passed to \fI\%gpg.verify\fP\&.
.sp
New in version 3007.0.

.TP
.B signed_by_all
When verifying signatures either on the managed file or its source hash file,
require a valid signature from each of the key fingerprints in this list.
This is passed to \fI\%gpg.verify\fP\&.
.sp
New in version 3007.0.

.TP
.B keyring
When verifying signatures, use this keyring.
.sp
New in version 3007.0.

.TP
.B gnupghome
When verifying signatures, use this GnuPG home.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.manage_file /etc/httpd/conf.d/httpd.conf \(aq\(aq \(aq{}\(aq salt://http/httpd.conf \(aq{hash_type: \(aqmd5\(aq, \(aqhsum\(aq: <md5sum>}\(aq root root \(aq755\(aq \(aq\(aq base \(aq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.7.0: \fBfollow_symlinks\fP option added

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.mkdir(dir_path, user=None, group=None, mode=None)
Ensure that a directory is available.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.mkdir /opt/jetty/context
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.mknod(name, ntype, major=0, minor=0, user=None, group=None, mode=\(aq0600\(aq)
New in version 0.17.0.

.sp
Create a block device, character device, or fifo pipe.
Identical to the gnu mknod.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.mknod /dev/chr c 180 31
salt \(aq*\(aq file.mknod /dev/blk b 8 999
salt \(aq*\(aq file.nknod /dev/fifo p
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.mknod_blkdev(name, major, minor, user=None, group=None, mode=\(aq0660\(aq)
New in version 0.17.0.

.sp
Create a block device.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.mknod_blkdev /dev/blk 8 999
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.mknod_chrdev(name, major, minor, user=None, group=None, mode=\(aq0660\(aq)
New in version 0.17.0.

.sp
Create a character device.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.mknod_chrdev /dev/chr 180 31
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.mknod_fifo(name, user=None, group=None, mode=\(aq0660\(aq)
New in version 0.17.0.

.sp
Create a FIFO pipe.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.mknod_fifo /dev/fifo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.move(src, dst, disallow_copy_and_unlink=False)
Move a file or directory
.INDENT 7.0
.TP
.B disallow_copy_and_unlink
If \fBTrue\fP, the operation is offloaded to the \fBfile.rename\fP execution
module function. This will use \fBos.rename\fP underneath, which will fail
in the event that \fBsrc\fP and \fBdst\fP are on different filesystems. If
\fBFalse\fP (the default), \fBshutil.move\fP will be used in order to fall
back on a \(dqcopy then unlink\(dq approach, which is required for moving
across filesystems.
.sp
New in version 3006.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.move /path/to/src /path/to/dst
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.normpath(path)
Returns Normalize path, eliminating double slashes, etc.
.sp
New in version 2015.5.0.

.sp
This can be useful at the CLI but is frequently useful when scripting.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- from salt[\(aqfile.normpath\(aq](tpldir + \(aq/../vars.jinja\(aq) import parent_vars %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.normpath \(aqa/b/c/..\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.open_files(by_pid=False)
Return a list of all physical open files on the system.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.open_files
salt \(aq*\(aq file.open_files by_pid=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.pardir()
Return the relative parent directory path symbol for underlying OS
.sp
New in version 2014.7.0.

.sp
This can be useful when constructing Salt Formulas.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set pardir = salt[\(aqfile.pardir\(aq]() %}
{% set final_path = salt[\(aqfile.join\(aq](\(aqsubdir\(aq, pardir, \(aqconfdir\(aq) %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.pardir
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.patch(originalfile, patchfile, options=\(aq\(aq, dry_run=False)
New in version 0.10.4.

.sp
Apply a patch to a file or directory.
.sp
Equivalent to:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
patch <options> \-i <patchfile> <originalfile>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or, when a directory is patched:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
patch <options> \-i <patchfile> \-d <originalfile> \-p0
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B originalfile
The full path to the file or directory to be patched
.TP
.B patchfile
A patch file to apply to \fBoriginalfile\fP
.TP
.B options
Options to pass to patch.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Windows now supports using patch as of 3004.
.sp
In order to use this function in Windows, please install the
patch binary through your own means and ensure it\(aqs found
in the system Path. If installing through git\-for\-windows,
please select the optional \(dqUse Git and optional Unix tools
from the Command Prompt\(dq option when installing Git.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.patch /opt/file.txt /tmp/file.txt.patch

salt \(aq*\(aq file.patch C:\efile1.txt C:\efile3.patch
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.path_exists_glob(path)
Tests to see if path after expansion is a valid path (file or directory).
Expansion allows usage of ? * and character ranges []. Tilde expansion
is not supported. Returns True/False.
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.path_exists_glob /etc/pam*/pass*
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.prepend(path, *args, **kwargs)
New in version 2014.7.0.

.sp
Prepend text to the beginning of a file
.INDENT 7.0
.TP
.B path
path to file
.TP
.B \fI*args\fP
strings to prepend to the file
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.prepend /etc/motd \e
        \(dqWith all thine offerings thou shalt offer salt.\(dq \e
        \(dqSalt is what makes things taste bad when it isn\(aqt in them.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Attention"
.sp
If you need to pass a string to append and that string contains
an equal sign, you \fBmust\fP include the argument name, args.
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.prepend /etc/motd args=\(aqcheese=spam\(aq

salt \(aq*\(aq file.prepend /etc/motd args=\(dq[\(aqcheese=spam\(aq,\(aqspam=cheese\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.psed(path, before, after, limit=\(aq\(aq, backup=\(aq.bak\(aq, flags=\(aqgMS\(aq, escape_all=False, multi=False)
Deprecated since version 0.17.0: Use \fI\%replace()\fP instead.

.sp
Make a simple edit to a file (pure Python version)
.sp
Equivalent to:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sed <backup> <options> \(dq/<limit>/ s/<before>/<after>/<flags> <file>\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
The full path to the file to be edited
.TP
.B before
A pattern to find in order to replace with \fBafter\fP
.TP
.B after
Text that will replace \fBbefore\fP
.TP
.B limit: \fB\(aq\(aq\fP
An initial pattern to search for before searching for \fBbefore\fP
.TP
.B backup: \fB\&.bak\fP
The file will be backed up before edit with this file extension;
\fBWARNING:\fP each time \fBsed\fP/\fBcomment\fP/\fBuncomment\fP is called will
overwrite this backup
.TP
.B flags: \fBgMS\fP
.INDENT 7.0
.TP
.B Flags to modify the search. Valid values are:
.INDENT 7.0
.IP \(bu 2
\fBg\fP: Replace all occurrences of the pattern, not just the first.
.IP \(bu 2
\fBI\fP: Ignore case.
.IP \(bu 2
\fBL\fP: Make \fB\ew\fP, \fB\eW\fP, \fB\eb\fP, \fB\eB\fP, \fB\es\fP and \fB\eS\fP
dependent on the locale.
.IP \(bu 2
\fBM\fP: Treat multiple lines as a single line.
.IP \(bu 2
\fBS\fP: Make \fI\&.\fP match all characters, including newlines.
.IP \(bu 2
\fBU\fP: Make \fB\ew\fP, \fB\eW\fP, \fB\eb\fP, \fB\eB\fP, \fB\ed\fP, \fB\eD\fP,
\fB\es\fP and \fB\eS\fP dependent on Unicode.
.IP \(bu 2
\fBX\fP: Verbose (whitespace is ignored).
.UNINDENT
.UNINDENT
.TP
.B multi: \fBFalse\fP
If True, treat the entire file as a single line
.UNINDENT
.sp
Forward slashes and single quotes will be escaped automatically in the
\fBbefore\fP and \fBafter\fP patterns.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.sed /etc/httpd/httpd.conf \(aqLogLevel warn\(aq \(aqLogLevel info\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.read(path, binary=False)
New in version 2017.7.0.

.sp
Return the content of the file.
.INDENT 7.0
.TP
.B Parameters
\fBbinary\fP (\fI\%bool\fP) \-\- Whether to read and return binary data
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.read /path/to/file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.readdir(path)
New in version 2014.1.0.

.sp
Return a list containing the contents of a directory
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.readdir /path/to/dir/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.readlink(path, canonicalize=False)
New in version 2014.1.0.

.sp
Return the path that a symlink points to
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path to the symlink
.IP \(bu 2
\fBcanonicalize\fP (\fI\%bool\fP) \-\- Get the canonical path eliminating any symbolic links encountered in
the path
.UNINDENT
.TP
.B Returns
The path that the symlink points to
.TP
.B Return type
\fI\%str\fP
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%SaltInvocationError\fP \-\- path is not absolute
.IP \(bu 2
\fI\%SaltInvocationError\fP \-\- path is not a link
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- error reading the symbolic link
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.readlink /path/to/link
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.remove(path, **kwargs)
Remove the named file. If a directory is supplied, it will be recursively
deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.remove /tmp/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3000: The method now works on all types of file system entries, not just
files, directories and symlinks.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.remove_backup(path, backup_id)
This function is an alias of \fBdelete_backup\fP\&.
.INDENT 7.0
.INDENT 3.5
New in version 0.17.0.

.sp
Delete a previous version of a file that was backed up using Salt\(aqs
\fI\%file state backup\fP system.
.INDENT 0.0
.TP
.B path
The path on the minion to check for backups
.TP
.B backup_id
The numeric id for the backup you wish to delete, as found using
\fI\%file.list_backups\fP
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.delete_backup /var/cache/salt/minion/file_backup/home/foo/bar/baz.txt 0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.rename(src, dst)
Rename a file or directory
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.rename /path/to/src /path/to/dst
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.replace(path, pattern, repl, count=0, flags=8, bufsize=1, append_if_not_found=False, prepend_if_not_found=False, not_found_content=None, backup=\(aq.bak\(aq, dry_run=False, search_only=False, show_changes=True, ignore_if_missing=False, preserve_inode=True, backslash_literal=False)
New in version 0.17.0.

.sp
Replace occurrences of a pattern in a file. If \fBshow_changes\fP is
\fBTrue\fP, then a diff of what changed will be returned, otherwise a
\fBTrue\fP will be returned when changes are made, and \fBFalse\fP when
no changes are made.
.sp
This is a pure Python implementation that wraps Python\(aqs \fI\%sub()\fP\&.
.INDENT 7.0
.TP
.B path
Filesystem path to the file to be edited. If a symlink is specified, it
will be resolved to its target.
.TP
.B pattern
A regular expression, to be matched using Python\(aqs
\fI\%search()\fP\&.
.TP
.B repl
The replacement text
.TP
.B count: 0
Maximum number of pattern occurrences to be replaced. If count is a
positive integer \fBn\fP, only \fBn\fP occurrences will be replaced,
otherwise all occurrences will be replaced.
.TP
.B flags (list or int)
A list of flags defined in the \fBre\fP module documentation from the
Python standard library. Each list item should be a string that will
correlate to the human\-friendly flag name. E.g., \fB[\(aqIGNORECASE\(aq,
\(aqMULTILINE\(aq]\fP\&. Optionally, \fBflags\fP may be an int, with a value
corresponding to the XOR (\fB|\fP) of all the desired flags. Defaults to
8 (which supports \(aqMULTILINE\(aq).
.TP
.B bufsize (int or str)
How much of the file to buffer into memory at once. The
default value \fB1\fP processes one line at a time. The special value
\fBfile\fP may be specified which will read the entire file into memory
before processing.
.TP
.B append_if_not_found: False
New in version 2014.7.0.

.sp
If set to \fBTrue\fP, and pattern is not found, then the content will be
appended to the file.
.TP
.B prepend_if_not_found: False
New in version 2014.7.0.

.sp
If set to \fBTrue\fP and pattern is not found, then the content will be
prepended to the file.
.TP
.B not_found_content
New in version 2014.7.0.

.sp
Content to use for append/prepend if not found. If None (default), uses
\fBrepl\fP\&. Useful when \fBrepl\fP uses references to group in pattern.
.TP
.B backup: .bak
The file extension to use for a backup of the file before editing. Set
to \fBFalse\fP to skip making a backup.
.TP
.B dry_run: False
If set to \fBTrue\fP, no changes will be made to the file, the function
will just return the changes that would have been made (or a
\fBTrue\fP/\fBFalse\fP value if \fBshow_changes\fP is set to \fBFalse\fP).
.TP
.B search_only: False
If set to true, this no changes will be performed on the file, and this
function will simply return \fBTrue\fP if the pattern was matched, and
\fBFalse\fP if not.
.TP
.B show_changes: True
If \fBTrue\fP, return a diff of changes made. Otherwise, return \fBTrue\fP
if changes were made, and \fBFalse\fP if not.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Using this option will store two copies of the file in memory (the
original version and the edited version) in order to generate the
diff. This may not normally be a concern, but could impact
performance if used with large files.
.UNINDENT
.UNINDENT
.TP
.B ignore_if_missing: False
New in version 2015.8.0.

.sp
If set to \fBTrue\fP, this function will simply return \fBFalse\fP
if the file doesn\(aqt exist. Otherwise, an error will be thrown.
.TP
.B preserve_inode: True
New in version 2015.8.0.

.sp
Preserve the inode of the file, so that any hard links continue to
share the inode with the original filename. This works by \fIcopying\fP the
file, reading from the copy, and writing to the file at the original
inode. If \fBFalse\fP, the file will be \fImoved\fP rather than copied, and a
new file will be written to a new inode, but using the original
filename. Hard links will then share an inode with the backup, instead
(if using \fBbackup\fP to create a backup copy).
.TP
.B backslash_literal: False
New in version 2016.11.7.

.sp
Interpret backslashes as literal backslashes for the repl and not
escape characters.  This will help when using append/prepend so that
the backslashes are not interpreted for the repl on the second run of
the state.
.UNINDENT
.sp
If an equal sign (\fB=\fP) appears in an argument to a Salt command it is
interpreted as a keyword argument in the format \fBkey=val\fP\&. That
processing can be bypassed in order to pass an equal sign through to the
remote shell command by manually specifying the kwarg:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.replace /path/to/file pattern=\(aq=\(aq repl=\(aq:\(aq
salt \(aq*\(aq file.replace /path/to/file pattern=\(dqbind\-address\es*=\(dq repl=\(aqbind\-address:\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.replace /etc/httpd/httpd.conf pattern=\(aqLogLevel warn\(aq repl=\(aqLogLevel info\(aq
salt \(aq*\(aq file.replace /some/file pattern=\(aqbefore\(aq repl=\(aqafter\(aq flags=\(aq[MULTILINE, IGNORECASE]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.restore_backup(path, backup_id)
New in version 0.17.0.

.sp
Restore a previous version of a file that was backed up using Salt\(aqs
\fI\%file state backup\fP system.
.INDENT 7.0
.TP
.B path
The path on the minion to check for backups
.TP
.B backup_id
The numeric id for the backup you wish to restore, as found using
\fI\%file.list_backups\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.restore_backup /foo/bar/baz.txt 0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.restorecon(path, recursive=False)
Reset the SELinux context on a given path
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.restorecon /home/user/.ssh/authorized_keys
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.rmdir(path, recurse=False, verbose=False, older_than=None)
New in version 2014.1.0.

.sp
Changed in version 3006.0: Changed return value for failure to a boolean.

.sp
Remove the specified directory. Fails if a directory is not empty.
.INDENT 7.0
.TP
.B recurse
When \fBrecurse\fP is set to \fBTrue\fP, all empty directories
within the path are pruned.
.sp
New in version 3006.0.

.TP
.B verbose
When \fBverbose\fP is set to \fBTrue\fP, a dictionary is returned
which contains more information about the removal process.
.sp
New in version 3006.0.

.TP
.B older_than
When \fBolder_than\fP is set to a number, it is used to determine the
\fBnumber of days\fP which must have passed since the last modification
timestamp before a directory will be allowed to be removed. Setting
the value to 0 is equivalent to leaving it at the default of \fBNone\fP\&.
.sp
New in version 3006.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.rmdir /tmp/foo/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.search(path, pattern, flags=8, bufsize=1, ignore_if_missing=False, multiline=False)
New in version 0.17.0.

.sp
Search for occurrences of a pattern in a file
.sp
Except for multiline, params are identical to
\fI\%replace()\fP\&.
.INDENT 7.0
.TP
.B multiline
If true, inserts \(aqMULTILINE\(aq into \fBflags\fP and sets \fBbufsize\fP to
\(aqfile\(aq.
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.search /etc/crontab \(aqmymaintenance.sh\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.sed(path, before, after, limit=\(aq\(aq, backup=\(aq.bak\(aq, options=\(aq\-r \-e\(aq, flags=\(aqg\(aq, escape_all=False, negate_match=False)
Deprecated since version 0.17.0: Use \fI\%replace()\fP instead.

.sp
Make a simple edit to a file
.sp
Equivalent to:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sed <backup> <options> \(dq/<limit>/ s/<before>/<after>/<flags> <file>\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
The full path to the file to be edited
.TP
.B before
A pattern to find in order to replace with \fBafter\fP
.TP
.B after
Text that will replace \fBbefore\fP
.TP
.B limit: \fB\(aq\(aq\fP
An initial pattern to search for before searching for \fBbefore\fP
.TP
.B backup: \fB\&.bak\fP
The file will be backed up before edit with this file extension;
\fBWARNING:\fP each time \fBsed\fP/\fBcomment\fP/\fBuncomment\fP is called will
overwrite this backup
.TP
.B options: \fB\-r \-e\fP
Options to pass to sed
.TP
.B flags: \fBg\fP
Flags to modify the sed search; e.g., \fBi\fP for case\-insensitive pattern
matching
.TP
.B negate_match: False
Negate the search command (\fB!\fP)
.sp
New in version 0.17.0.

.UNINDENT
.sp
Forward slashes and single quotes will be escaped automatically in the
\fBbefore\fP and \fBafter\fP patterns.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.sed /etc/httpd/httpd.conf \(aqLogLevel warn\(aq \(aqLogLevel info\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.sed_contains(path, text, limit=\(aq\(aq, flags=\(aqg\(aq)
Deprecated since version 0.17.0: Use \fI\%search()\fP instead.

.sp
Return True if the file at \fBpath\fP contains \fBtext\fP\&. Utilizes sed to
perform the search (line\-wise search).
.sp
Note: the \fBp\fP flag will be added to any flags you pass in.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.contains /etc/crontab \(aqmymaintenance.sh\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.seek_read(path, size, offset)
New in version 2014.1.0.

.sp
Seek to a position on a file and read it
.INDENT 7.0
.TP
.B path
path to file
.TP
.B seek
amount to read at once
.TP
.B offset
offset to start into the file
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.seek_read /path/to/file 4096 0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.seek_write(path, data, offset)
New in version 2014.1.0.

.sp
Seek to a position on a file and write to it
.INDENT 7.0
.TP
.B path
path to file
.TP
.B data
data to write to file
.TP
.B offset
position in file to start writing
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.seek_write /path/to/file \(aqsome data\(aq 4096
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.set_mode(path, mode)
Set the mode of a file
.INDENT 7.0
.TP
.B path
file or directory of which to set the mode
.TP
.B mode
mode to set the path to
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.set_mode /etc/passwd 0644
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.set_selinux_context(path, user=None, role=None, type=None, range=None, persist=False)
Changed in version 3001: Added persist option

.sp
Set a specific SELinux label on a given path
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.set_selinux_context path <user> <role> <type> <range>
salt \(aq*\(aq file.set_selinux_context /etc/yum.repos.d/epel.repo system_u object_r system_conf_t s0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.source_list(source, source_hash, saltenv)
Check the source list and return the source to use
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.source_list salt://http/httpd.conf \(aq{hash_type: \(aqmd5\(aq, \(aqhsum\(aq: <md5sum>}\(aq base
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.stats(path, hash_type=None, follow_symlinks=True)
Return a dict containing the stats for a given file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.stats /etc/passwd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.statvfs(path)
New in version 2014.1.0.

.sp
Perform a statvfs call against the filesystem that the file resides on
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.statvfs /path/to/file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.symlink(src, path, force=False, atomic=False, follow_symlinks=True)
Create a symbolic link (symlink, soft link) to a file
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsrc\fP (\fI\%str\fP) \-\- The path to a file or directory
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path to the link. Must be an absolute path
.IP \(bu 2
\fBforce\fP (\fI\%bool\fP) \-\- Overwrite an existing symlink with the same name
\&.. versionadded:: 3005
.IP \(bu 2
\fBatomic\fP (\fI\%bool\fP) \-\- Use atomic file operations to create the symlink
\&.. versionadded:: 3006.0
.IP \(bu 2
\fBfollow_symlinks\fP (\fI\%bool\fP) \-\- If set to \fBFalse\fP, use \fBos.path.lexists()\fP for existence checks
instead of \fBos.path.exists()\fP\&.
\&.. versionadded:: 3007.0
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise raises \fBCommandExecutionError\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.symlink /path/to/file /path/to/link
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.touch(name, atime=None, mtime=None)
New in version 0.9.5.

.sp
Just like the \fBtouch\fP command, create a file if it doesn\(aqt exist or
simply update the atime and mtime if it already does.
.INDENT 7.0
.TP
.B atime:
Access time in Unix epoch time. Set it to 0 to set atime of the
file with Unix date of birth. If this parameter isn\(aqt set, atime
will be set with current time.
.TP
.B mtime:
Last modification in Unix epoch time. Set it to 0 to set mtime of
the file with Unix date of birth. If this parameter isn\(aqt set,
mtime will be set with current time.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.touch /var/log/emptyfile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.truncate(path, length)
New in version 2014.1.0.

.sp
Seek to a position on a file and delete everything after that point
.INDENT 7.0
.TP
.B path
path to file
.TP
.B length
offset into file to truncate
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.truncate /path/to/file 512
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.uid_to_user(uid)
Convert a uid to a user name
.INDENT 7.0
.TP
.B uid
uid to convert to a username
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.uid_to_user 0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.uncomment(path, regex, char=\(aq#\(aq, backup=\(aq.bak\(aq)
Deprecated since version 0.17.0: Use \fI\%replace()\fP instead.

.sp
Uncomment specified commented lines in a file
.INDENT 7.0
.TP
.B path
The full path to the file to be edited
.TP
.B regex
A regular expression used to find the lines that are to be uncommented.
This regex should not include the comment character. A leading \fB^\fP
character will be stripped for convenience (for easily switching
between comment() and uncomment()).
.TP
.B char: \fB#\fP
The character to remove in order to uncomment a line
.TP
.B backup: \fB\&.bak\fP
The file will be backed up before edit with this file extension;
\fBWARNING:\fP each time \fBsed\fP/\fBcomment\fP/\fBuncomment\fP is called will
overwrite this backup
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.uncomment /etc/hosts.deny \(aqALL: PARANOID\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.user_to_uid(user)
Convert user name to a uid
.INDENT 7.0
.TP
.B user
user name to convert to its uid
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.user_to_uid root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.file.write(path, *args, **kwargs)
New in version 2014.7.0.

.sp
Write text to a file, overwriting any existing contents.
.INDENT 7.0
.TP
.B path
path to file
.TP
.B \fI*args\fP
strings to write to the file
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.write /etc/motd \e
        \(dqWith all thine offerings thou shalt offer salt.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Attention"
.sp
If you need to pass a string to append and that string contains
an equal sign, you \fBmust\fP include the argument name, args.
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.write /etc/motd args=\(aqcheese=spam\(aq

salt \(aq*\(aq file.write /etc/motd args=\(dq[\(aqcheese=spam\(aq,\(aqspam=cheese\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.firewalld
.sp
Support for firewalld.
.sp
New in version 2015.2.0.

.INDENT 0.0
.TP
.B salt.modules.firewalld.add_interface(zone, interface, permanent=True)
Bind an interface to a zone
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.add_interface zone eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.add_masquerade(zone=None, permanent=True)
Enable masquerade on a zone.
If zone is omitted, default zone will be used.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.add_masquerade
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To enable masquerade on a specific zone
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.add_masquerade dmz
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.add_port(zone, port, permanent=True, force_masquerade=False)
Allow specific ports in a zone.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.add_port internal 443/tcp
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B force_masquerade
when a zone is created ensure masquerade is also enabled
on that zone.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.add_port_fwd(zone, src, dest, proto=\(aqtcp\(aq, dstaddr=\(aq\(aq, permanent=True, force_masquerade=False)
Add port forwarding.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.add_port_fwd public 80 443 tcp
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B force_masquerade
when a zone is created ensure masquerade is also enabled
on that zone.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.add_rich_rule(zone, rule, permanent=True)
Add a rich rule to a zone
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.add_rich_rule zone \(aqrule\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.add_service(service, zone=None, permanent=True)
Add a service for zone. If zone is omitted, default zone will be used.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.add_service ssh
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To assign a service to a specific zone:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.add_service ssh my_zone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.add_service_port(service, port)
Add a new port to the specified service.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.add_service_port zone 80
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.add_service_protocol(service, protocol)
Add a new protocol to the specified service.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.add_service_protocol zone ssh
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.add_source(zone, source, permanent=True)
Bind a source to a zone
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.add_source zone 192.168.1.0/24
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.allow_icmp(zone, icmp, permanent=True)
Allow a specific ICMP type on a zone
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.allow_icmp zone echo\-reply
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.block_icmp(zone, icmp, permanent=True)
Block a specific ICMP type on a zone
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.block_icmp zone echo\-reply
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.default_zone()
Print default zone for connections and interfaces
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.default_zone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.delete_service(name, restart=True)
Delete an existing service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.delete_service my_service
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default firewalld will be reloaded. However, to avoid reloading
you need to specify the restart as False
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.delete_service my_service False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.delete_zone(zone, restart=True)
Delete an existing zone
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.delete_zone my_zone
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default firewalld will be reloaded. However, to avoid reloading
you need to specify the restart as False
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.delete_zone my_zone False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.get_icmp_types(permanent=True)
Print predefined icmptypes
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.get_icmp_types
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.get_interfaces(zone, permanent=True)
List interfaces bound to a zone
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.get_interfaces zone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.get_masquerade(zone=None, permanent=True)
Show if masquerading is enabled on a zone.
If zone is omitted, default zone will be used.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.get_masquerade zone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.get_rich_rules(zone, permanent=True)
List rich rules bound to a zone
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.get_rich_rules zone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.get_service_ports(service)
List ports of a service.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.get_service_ports zone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.get_service_protocols(service)
List protocols of a service.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.get_service_protocols zone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.get_services(permanent=True)
Print predefined services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.get_services
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.get_sources(zone, permanent=True)
List sources bound to a zone
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.get_sources zone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.get_zones(permanent=True)
Print predefined zones
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.get_zones
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.list_all(zone=None, permanent=True)
List everything added for or enabled in a zone
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.list_all
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
List a specific zone
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.list_all my_zone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.list_icmp_block(zone, permanent=True)
List ICMP blocks on a zone
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewlld.list_icmp_block zone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.list_port_fwd(zone, permanent=True)
List port forwarding
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.list_port_fwd public
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.list_ports(zone, permanent=True)
List all ports in a zone.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.list_ports
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.list_services(zone=None, permanent=True)
List services added for zone as a space separated list.
If zone is omitted, default zone will be used.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.list_services
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
List a specific zone
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.list_services my_zone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.list_zones(permanent=True)
List everything added for or enabled in all zones
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.list_zones
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.make_permanent()
Make current runtime configuration permanent.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.make_permanent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.new_service(name, restart=True)
Add a new service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.new_service my_service
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default firewalld will be reloaded. However, to avoid reloading
you need to specify the restart as False
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.new_service my_service False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.new_zone(zone, restart=True)
Add a new zone
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.new_zone my_zone
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default firewalld will be reloaded. However, to avoid reloading
you need to specify the restart as False
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.new_zone my_zone False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.reload_rules()
Reload the firewall rules, which makes the permanent configuration the new
runtime configuration without losing state information.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.reload_rules
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.remove_interface(zone, interface, permanent=True)
Remove an interface bound to a zone
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.remove_interface zone eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.remove_masquerade(zone=None, permanent=True)
Remove masquerade on a zone.
If zone is omitted, default zone will be used.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.remove_masquerade
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To remove masquerade on a specific zone
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.remove_masquerade dmz
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.remove_port(zone, port, permanent=True)
Remove a specific port from a zone.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.remove_port internal 443/tcp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.remove_port_fwd(zone, src, dest, proto=\(aqtcp\(aq, dstaddr=\(aq\(aq, permanent=True)
Remove Port Forwarding.
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.remove_port_fwd public 80 443 tcp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.remove_rich_rule(zone, rule, permanent=True)
Add a rich rule to a zone
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.remove_rich_rule zone \(aqrule\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.remove_service(service, zone=None, permanent=True)
Remove a service from zone. This option can be specified multiple times.
If zone is omitted, default zone will be used.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.remove_service ssh
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To remove a service from a specific zone
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.remove_service ssh dmz
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.remove_service_port(service, port)
Remove a port from the specified service.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.remove_service_port zone 80
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.remove_service_protocol(service, protocol)
Remove a protocol from the specified service.
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.remove_service_protocol zone ssh
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.remove_source(zone, source, permanent=True)
Remove a source bound to a zone
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.remove_source zone 192.168.1.0/24
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.set_default_zone(zone)
Set default zone
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.set_default_zone damian
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.firewalld.version()
Return version from firewall\-cmd
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewalld.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.freebsd_sysctl
.sp
Module for viewing and modifying sysctl parameters
.INDENT 0.0
.TP
.B salt.modules.freebsd_sysctl.assign(name, value)
Assign a single sysctl parameter for this minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.assign net.inet.icmp.icmplim 50
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsd_sysctl.get(name)
Return a single sysctl parameter for this minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.get hw.physmem
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsd_sysctl.persist(name, value, config=\(aq/etc/sysctl.conf\(aq)
Assign and persist a simple sysctl parameter for this minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.persist net.inet.icmp.icmplim 50
salt \(aq*\(aq sysctl.persist coretemp_load NO config=/boot/loader.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsd_sysctl.show(config_file=False)
Return a list of sysctl parameters for this minion
.INDENT 7.0
.TP
.B config: Pull the data from the system configuration file
instead of the live data.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.show
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.freebsd_update
.sp
Support for freebsd\-update utility on FreeBSD.
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B maintainer
George Mamalakis <\fI\%mamalos@gmail.com\fP>
.TP
.B maturity
new
.TP
.B platform
FreeBSD
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsd_update.fetch(**kwargs)
New in version 2016.3.4.

.sp
freebsd\-update fetch wrapper. Based on the currently installed world and the
configuration options set, fetch all available binary updates.
.INDENT 7.0
.TP
.B kwargs:
Parameters of freebsd\-update command.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsd_update.ids(**kwargs)
New in version 2016.3.4.

.sp
freebsd\-update IDS wrapper function. Compares the system against a \(dqknown
good\(dq index of the installed release.
.INDENT 7.0
.TP
.B kwargs:
Parameters of freebsd\-update command.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsd_update.install(**kwargs)
New in version 2016.3.4.

.sp
freebsd\-update install wrapper. Install the most recently fetched updates or
upgrade.
.INDENT 7.0
.TP
.B kwargs:
Parameters of freebsd\-update command.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsd_update.rollback(**kwargs)
New in version 2016.3.4.

.sp
freebsd\-update rollback wrapper. Uninstalls the most recently installed
updates.
.INDENT 7.0
.TP
.B kwargs:
Parameters of freebsd\-update command.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsd_update.update(**kwargs)
New in version 2016.3.4.

.sp
Command that simplifies freebsd\-update by running freebsd\-update fetch first
and then freebsd\-update install.
.INDENT 7.0
.TP
.B kwargs:
Parameters of freebsd\-update command.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsd_update.upgrade(**kwargs)
New in version 2016.3.4.

.sp
Dummy function used only to print a message that upgrade is not available.
The reason is that upgrade needs manual intervention and reboot, so even if
used with:
.INDENT 7.0
.INDENT 3.5
yes | freebsd\-upgrade \-r VERSION
.UNINDENT
.UNINDENT
.sp
the additional freebsd\-update install that needs to run after the reboot
cannot be implemented easily.
.INDENT 7.0
.TP
.B kwargs:
Parameters of freebsd\-update command.
.UNINDENT
.UNINDENT
.SS salt.modules.freebsdjail
.sp
The jail module for FreeBSD
.INDENT 0.0
.TP
.B salt.modules.freebsdjail.fstab(jail)
Display contents of a fstab(5) file defined in specified
jail\(aqs configuration. If no file is defined, return False.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jail.fstab <jail name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdjail.get_enabled()
Return which jails are set to be run
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jail.get_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdjail.is_enabled()
See if jail service is actually enabled on boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jail.is_enabled <jail name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdjail.restart(jail=\(aq\(aq)
Restart the specified jail or all, if none specified
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jail.restart [<jail name>]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdjail.show_config(jail)
Display specified jail\(aqs configuration
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jail.show_config <jail name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdjail.start(jail=\(aq\(aq)
Start the specified jail or all, if none specified
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jail.start [<jail name>]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdjail.status(jail)
See if specified jail is currently running
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jail.status <jail name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdjail.stop(jail=\(aq\(aq)
Stop the specified jail or all, if none specified
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jail.stop [<jail name>]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdjail.sysctl()
Dump all jail related kernel states (sysctl)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jail.sysctl
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.freebsdkmod
.sp
Module to manage FreeBSD kernel modules
.INDENT 0.0
.TP
.B salt.modules.freebsdkmod.available()
Return a list of all available kernel modules
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kmod.available
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdkmod.check_available(mod)
Check to see if the specified kernel module is available
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kmod.check_available vmm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdkmod.is_loaded(mod)
Check to see if the specified kernel module is loaded
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kmod.is_loaded vmm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdkmod.load(mod, persist=False)
Load the specified kernel module
.INDENT 7.0
.TP
.B mod
Name of the module to add
.TP
.B persist
Write the module to sysrc kld_modules to make it load on system reboot
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kmod.load bhyve
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdkmod.lsmod()
Return a dict containing information about currently loaded modules
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kmod.lsmod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdkmod.mod_list(only_persist=False)
Return a list of the loaded module names
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kmod.mod_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdkmod.remove(mod, persist=False, comment=True)
Remove the specified kernel module
.INDENT 7.0
.TP
.B mod
Name of module to remove
.TP
.B persist
Also remove module from /boot/loader.conf
.TP
.B comment
If persist is set don\(aqt remove line from /boot/loader.conf but only
comment it
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kmod.remove vmm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.freebsdpkg
.sp
Remote package support using \fBpkg_add(1)\fP
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage packages on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module has been completely rewritten. Up to and including version
0.17.0, it supported \fBpkg_add(1)\fP, but checked for the existence of a
pkgng local database and, if found,  would provide some of pkgng\(aqs
functionality. The rewrite of this module has removed all pkgng support,
and moved it to the \fI\%pkgng\fP execution module. For
versions <= 0.17.0, the documentation here should not be considered
accurate. If your Minion is running one of these versions, then the
documentation for this module can be viewed using the \fBsys.doc\fP function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt bsdminion sys.doc pkg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
This module acts as the default package provider for FreeBSD 9 and older. If
you need to use pkgng on a FreeBSD 9 system, you will need to override the
\fBpkg\fP provider by setting the \fI\%providers\fP parameter in your
Minion config file, in order to use pkgng.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
providers:
  pkg: pkgng
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
More information on pkgng support can be found in the documentation for the
\fI\%pkgng\fP module.
.sp
This module will respect the \fBPACKAGEROOT\fP and \fBPACKAGESITE\fP environment
variables, if set, but these values can also be overridden in several ways:
.INDENT 0.0
.IP 1. 3
\fBSalt configuration parameters.\fP The configuration parameters
\fBfreebsdpkg.PACKAGEROOT\fP and \fBfreebsdpkg.PACKAGESITE\fP are recognized.
These config parameters are looked up using \fI\%config.get\fP and can thus be specified in the Master config
file, Grains, Pillar, or in the Minion config file. Example:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
freebsdpkg.PACKAGEROOT: ftp://ftp.freebsd.org/
freebsdpkg.PACKAGESITE: ftp://ftp.freebsd.org/pub/FreeBSD/ports/ia64/packages\-9\-stable/Latest/
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
\fBCLI arguments.\fP Both the \fBpackageroot\fP (used interchangeably with
\fBfromrepo\fP for API compatibility) and \fBpackagesite\fP CLI arguments are
recognized, and override their config counterparts from section 1 above.
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
    salt \-G \(aqos:FreeBSD\(aq pkg.install zsh fromrepo=ftp://ftp2.freebsd.org/
    salt \-G \(aqos:FreeBSD\(aq pkg.install zsh packageroot=ftp://ftp2.freebsd.org/
    salt \-G \(aqos:FreeBSD\(aq pkg.install zsh packagesite=ftp://ftp2.freebsd.org/pub/FreeBSD/ports/ia64/packages\-9\-stable/Latest/

\&.. note::

    These arguments can also be passed through in states:

    .. code\-block:: yaml

        zsh:
          pkg.installed:
            \- fromrepo: ftp://ftp2.freebsd.org/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdpkg.available_version(*names, **kwargs)
This function is an alias of \fBlatest_version\fP\&.
.INDENT 7.0
.INDENT 3.5
\fBpkg_add(1)\fP is not capable of querying for remote packages, so this
function will always return results as if there is no package available for
install or upgrade.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdpkg.delete(name=None, pkgs=None, **kwargs)
This function is an alias of \fBremove\fP\&.
.INDENT 7.0
.INDENT 3.5
Remove packages using \fBpkg_delete(1)\fP
.INDENT 0.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 0.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdpkg.file_dict(*packages, **kwargs)
List the files that belong to a package, grouped by package. Not
specifying any packages will return a list of _every_ file on the
system\(aqs package database (not generally recommended).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_list httpd
salt \(aq*\(aq pkg.file_list httpd postfix
salt \(aq*\(aq pkg.file_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdpkg.file_list(*packages, **kwargs)
List the files that belong to a package. Not specifying any packages will
return a list of _every_ file on the system\(aqs package database (not
generally recommended).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_list httpd
salt \(aq*\(aq pkg.file_list httpd postfix
salt \(aq*\(aq pkg.file_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdpkg.install(name=None, refresh=False, fromrepo=None, pkgs=None, sources=None, **kwargs)
Install package(s) using \fBpkg_add(1)\fP
.INDENT 7.0
.TP
.B name
The name of the package to be installed.
.TP
.B refresh
Whether or not to refresh the package database before installing.
.TP
.B fromrepo or packageroot
Specify a package repository from which to install. Overrides the
system default, as well as the PACKAGEROOT environment variable.
.TP
.B packagesite
Specify the exact directory from which to install the remote package.
Overrides the PACKAGESITE environment variable, if present.
.UNINDENT
.sp
Multiple Package Installation Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to install from a software repository. Must be
passed as a python list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B sources
A list of packages to install. Must be passed as a list of dicts,
with the keys being package names, and the values being the source URI
or local path to the package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install sources=\(aq[{\(dqfoo\(dq: \(dqsalt://foo.deb\(dq}, {\(dqbar\(dq: \(dqsalt://bar.deb\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Return a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdpkg.latest_version(*names, **kwargs)
\fBpkg_add(1)\fP is not capable of querying for remote packages, so this
function will always return results as if there is no package available for
install or upgrade.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdpkg.list_pkgs(versions_as_list=False, with_origin=False, **kwargs)
List the packages currently installed as a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B with_origin
False
Return a nested dictionary containing both the origin name and version
for each installed package.
.sp
New in version 2014.1.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdpkg.purge(name=None, pkgs=None, **kwargs)
This function is an alias of \fBremove\fP\&.
.INDENT 7.0
.INDENT 3.5
Remove packages using \fBpkg_delete(1)\fP
.INDENT 0.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 0.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdpkg.refresh_db(**kwargs)
\fBpkg_add(1)\fP does not use a local database of available packages, so this
function simply returns \fBTrue\fP\&. it exists merely for API compatibility.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdpkg.remove(name=None, pkgs=None, **kwargs)
Remove packages using \fBpkg_delete(1)\fP
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdpkg.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.INDENT 7.0
.TP
.B with_origin
False
Return a nested dictionary containing both the origin name and version
for each specified package.
.sp
New in version 2014.1.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.freebsdports
.sp
Install software from the FreeBSD \fBports(7)\fP system
.sp
New in version 2014.1.0.

.sp
This module allows you to install ports using \fBBATCH=yes\fP to bypass
configuration prompts. It is recommended to use the \fBports state\fP to install ports, but it is also possible to use
this module exclusively from the command line.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion\-id ports.config security/nmap IPV6=off
salt minion\-id ports.install security/nmap
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdports.config(name, reset=False, **kwargs)
Modify configuration options for a given port. Multiple options can be
specified. To see the available options for a port, use
\fI\%ports.showconfig\fP\&.
.INDENT 7.0
.TP
.B name
The port name, in \fBcategory/name\fP format
.TP
.B reset
False
If \fBTrue\fP, runs a \fBmake rmconfig\fP for the port, clearing its
configuration before setting the desired options
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ports.config security/nmap IPV6=off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdports.deinstall(name)
De\-install a port.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ports.deinstall security/nmap
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdports.install(name, clean=True)
Install a port from the ports tree. Installs using \fBBATCH=yes\fP for
non\-interactive building. To set config options for a given port, use
\fI\%ports.config\fP\&.
.INDENT 7.0
.TP
.B clean
True
If \fBTrue\fP, cleans after installation. Equivalent to running \fBmake
install clean BATCH=yes\fP\&.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
It may be helpful to run this function using the \fB\-t\fP option to set a
higher timeout, since compiling a port may cause the Salt command to
exceed the default timeout.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-t 1200 \(aq*\(aq ports.install security/nmap
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdports.list_all()
Lists all ports available.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ports.list_all
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Takes a while to run, and returns a \fBLOT\fP of output
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdports.rmconfig(name)
Clear the cached options for the specified port; run a \fBmake rmconfig\fP
.INDENT 7.0
.TP
.B name
The name of the port to clear
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ports.rmconfig security/nmap
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdports.search(name)
Search for matches in the ports tree. Globs are supported, and the category
is optional
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ports.search \(aqsecurity/*\(aq
salt \(aq*\(aq ports.search \(aqsecurity/n*\(aq
salt \(aq*\(aq ports.search nmap
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Takes a while to run
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdports.showconfig(name, default=False, dict_return=False)
Show the configuration options for a given port.
.INDENT 7.0
.TP
.B default
False
Show the default options for a port (not necessarily the same as the
current configuration)
.TP
.B dict_return
False
Instead of returning the output of \fBmake showconfig\fP, return the data
in an dictionary
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ports.showconfig security/nmap
salt \(aq*\(aq ports.showconfig security/nmap default=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdports.update(extract=False)
Update the ports tree
.INDENT 7.0
.TP
.B extract
False
If \fBTrue\fP, runs a \fBportsnap extract\fP after fetching, should be used
for first\-time installation of the ports tree.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ports.update
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.freebsdservice
.sp
The service module for FreeBSD
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage services on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqservice.start\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdservice.available(name, jail=None)
Check that the given service is available.
.sp
Changed in version 2016.3.4.

.sp
jail: optional jid or jail name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.available sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdservice.disable(name, **kwargs)
Disable the named service to start at boot
.sp
Arguments the same as for enable()
.sp
Changed in version 2016.3.4.

.INDENT 7.0
.TP
.B jail (optional keyword argument)
the jail\(aqs id or name
.TP
.B chroot (optional keyword argument)
the jail\(aqs chroot, if the jail\(aqs /etc is not mounted read\-write
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdservice.disabled(name, **kwargs)
Return True if the named service is enabled, false otherwise
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdservice.enable(name, **kwargs)
Enable the named service to start at boot
.INDENT 7.0
.TP
.B name
service name
.TP
.B config
/etc/rc.conf
Config file for managing service. If config value is
empty string, then /etc/rc.conf.d/<service> used.
See man rc.conf(5) for details.
.sp
Also service.config variable can be used to change default.
.UNINDENT
.sp
Changed in version 2016.3.4.

.INDENT 7.0
.TP
.B jail (optional keyword argument)
the jail\(aqs id or name
.TP
.B chroot (optional keyword argument)
the jail\(aqs chroot, if the jail\(aqs /etc is not mounted read\-write
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdservice.enabled(name, **kwargs)
Return True if the named service is enabled, false otherwise
.INDENT 7.0
.TP
.B name
Service name
.UNINDENT
.sp
Changed in version 2016.3.4.

.sp
Support for jail (representing jid or jail name) keyword argument in kwargs
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdservice.get_all(jail=None)
Return a list of all available services
.sp
Changed in version 2016.3.4.

.sp
jail: optional jid or jail name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdservice.get_disabled(jail=None)
Return what services are available but not enabled to start at boot
.sp
Changed in version 2016.3.4.

.sp
Support for jail (representing jid or jail name) keyword argument in kwargs
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_disabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdservice.get_enabled(jail=None)
Return what services are set to run on boot
.sp
Changed in version 2016.3.4.

.sp
Support for jail (representing jid or jail name) keyword argument in kwargs
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdservice.missing(name, jail=None)
The inverse of service.available.
Returns \fBTrue\fP if the specified service is not available, otherwise returns
\fBFalse\fP\&.
.sp
Changed in version 2016.3.4.

.sp
jail: optional jid or jail name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.missing sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdservice.reload_(name, jail=None)
Restart the named service
.sp
Changed in version 2016.3.4.

.sp
jail: optional jid or jail name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdservice.restart(name, jail=None)
Restart the named service
.sp
Changed in version 2016.3.4.

.sp
jail: optional jid or jail name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdservice.start(name, jail=None)
Start the specified service
.sp
Changed in version 2016.3.4.

.sp
jail: optional jid or jail name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdservice.status(name, sig=None, jail=None)
Return the status for a service.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.sp
Changed in version 2016.3.4.

.sp
Changed in version 2018.3.0: The service name can now be a glob (e.g. \fBsalt*\fP)

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.IP \(bu 2
\fBsig\fP (\fI\%str\fP) \-\- Signature to use to find the service via ps
.UNINDENT
.TP
.B Returns
True if running, False otherwise
dict: Maps service name to True if running, False otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name> [service signature]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freebsdservice.stop(name, jail=None)
Stop the specified service
.sp
Changed in version 2016.3.4.

.sp
jail: optional jid or jail name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.freezer
.sp
Module for freezer
:maintainer:    Alberto Planas <\fI\%aplanas@suse.com\fP>
:maturity:      new
:depends:       None
:platform:      Linux
.INDENT 0.0
.TP
.B salt.modules.freezer.compare(old, new)
Display the difference between two frozen states. The results are shown as
as a dictionary with keys for packages and repositories. Each key may
contain a changes dictionary showing items that differ between the two
frozen states. Items shown in the \(dqold\(dq changes but not the \(dqnew\(dq were
removed. Items in \(dqnew\(dq but not \(dqold\(dq were added. Items shown in both
probably updated/changed versions between freezes.
.INDENT 7.0
.TP
.B old
Name of the \(dqold\(dq frozen state. Required.
.TP
.B new
Name of the \(dqnew\(dq frozen state. Required.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq freezer.freeze pre_install post_install
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freezer.freeze(name=None, force=False, **kwargs)
Save the list of package and repos in a freeze file.
.sp
As this module is build on top of the pkg module, the user can
send extra attributes to the underlying pkg module via kwargs.
This function will call \fBpkg.list_pkgs\fP and \fBpkg.list_repos\fP,
and any additional arguments will be passed through to those
functions.
.INDENT 7.0
.TP
.B name
Name of the frozen state. Optional.
.TP
.B force
If true, overwrite the state. Optional.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq freezer.freeze
salt \(aq*\(aq freezer.freeze pre_install
salt \(aq*\(aq freezer.freeze force=True root=/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freezer.list_()
Return the list of frozen states.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq freezer.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freezer.restore(name=None, clean=False, **kwargs)
Make sure that the system contains the packages and repos from a
frozen state.
.sp
Read the list of packages and repositories from the freeze file,
and compare it with the current list of packages and repos. If
there is any difference, all the missing packages are repos will
be installed, and all the extra packages and repos will be
removed.
.sp
As this module is build on top of the pkg module, the user can
send extra attributes to the underlying pkg module via kwargs.
This function will call \fBpkg.list_repos\fP, \fBpkg.mod_repo\fP,
\fBpkg.list_pkgs\fP, \fBpkg.install\fP, \fBpkg.remove\fP and
\fBpkg.del_repo\fP, and any additional arguments will be passed
through to those functions.
.INDENT 7.0
.TP
.B name
Name of the frozen state. Optional.
.TP
.B clean
If True remove the frozen information YAML from the cache
.sp
New in version 3000.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq freezer.restore
salt \(aq*\(aq freezer.restore root=/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.freezer.status(name=None)
Return True if there is already a frozen state.
.sp
A frozen state is merely a list of packages (including the
version) in a specific time. This information can be used to
compare with the current list of packages, and revert the
installation of some extra packages that are in the system.
.INDENT 7.0
.TP
.B name
Name of the frozen state. Optional.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq freezer.status
salt \(aq*\(aq freezer.status pre_install
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.gcp_addon
.sp
A route is a rule that specifies how certain packets should be handled by the
virtual network. Routes are associated with virtual machine instances by tag,
and the set of routes for a particular VM is called its routing table.
For each packet leaving a virtual machine, the system searches that machine\(aqs
routing table for a single best matching route.
.sp
New in version 2018.3.0.

.sp
This module will create a route to send traffic destined to the Internet
through your gateway instance.
.INDENT 0.0
.TP
.B codeauthor
\fIPratik Bandarkar <pratik.bandarkar@gmail.com>\fP
.TP
.B maturity
new
.TP
.B depends
google\-api\-python\-client
.TP
.B platform
Linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gcp_addon.route_create(credential_file=None, project_id=None, name=None, dest_range=None, next_hop_instance=None, instance_zone=None, tags=None, network=None, priority=None)
Create a route to send traffic destined to the Internet through your
gateway instance
.INDENT 7.0
.TP
.B credential_file
string
File location of application default credential. For more information,
refer: \fI\%https://developers.google.com/identity/protocols/application\-default\-credentials\fP
.TP
.B project_id
string
Project ID where instance and network resides.
.TP
.B name
string
name of the route to create
.TP
.B next_hop_instance
string
the name of an instance that should handle traffic matching this route.
.TP
.B instance_zone
string
zone where instance(\(dqnext_hop_instance\(dq) resides
.TP
.B network
string
Specifies the network to which the route will be applied.
.TP
.B dest_range
string
The destination range of outgoing packets that the route will apply to.
.TP
.B tags
list
(optional) Identifies the set of instances that this route will apply to.
.TP
.B priority
int
(optional) Specifies the priority of this route relative to other routes.
default=1000
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqsalt\-master.novalocal\(aq gcp.route_create
    credential_file=/root/secret_key.json
    project_id=cp100\-170315
    name=derby\-db\-route1
    next_hop_instance=instance\-1
    instance_zone=us\-central1\-a
    network=default
    dest_range=0.0.0.0/0
    tags=[\(aqno\-ip\(aq]
    priority=700
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In above example, the instances which are having tag \(dqno\-ip\(dq will route the
packet to instance \(dqinstance\-1\(dq(if packet is intended to other network)
.UNINDENT
.SS salt.modules.gem
.sp
Manage ruby gems.
.INDENT 0.0
.TP
.B salt.modules.gem.install(gems, ruby=None, gem_bin=None, runas=None, version=None, rdoc=False, ri=False, pre_releases=False, proxy=None, source=None)
Installs one or several gems.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBgems\fP \-\- string
The gems to install
.IP \(bu 2
\fBgem_bin\fP \-\- string : None
Full path to \fBgem\fP binary to use.
.IP \(bu 2
\fBruby\fP \-\- string : None
If RVM or rbenv are installed, the ruby version and gemset to use.
Ignored if \fBgem_bin\fP is specified.
.IP \(bu 2
\fBrunas\fP \-\- string : None
The user to run gem as.
.IP \(bu 2
\fBversion\fP \-\- string : None
Specify the version to install for the gem.
Doesn\(aqt play nice with multiple gems at once
.IP \(bu 2
\fBrdoc\fP \-\- boolean : False
Generate RDoc documentation for the gem(s).
For rubygems > 3 this is interpreted as the \-\-no\-document arg and the
ri option will then be ignored
.IP \(bu 2
\fBri\fP \-\- boolean : False
Generate RI documentation for the gem(s).
For rubygems > 3 this is interpreted as the \-\-no\-document arg and the
rdoc option will then be ignored
.IP \(bu 2
\fBpre_releases\fP \-\- boolean : False
Include pre\-releases in the available versions
.IP \(bu 2
\fBproxy\fP \-\- string : None
Use the specified HTTP proxy server for all outgoing traffic.
Format: \fI\%http://hostname[:port\fP]
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B source
None
Use the specified HTTP gem source server to download gem.
Format: \fI\%http://hostname[:port\fP]
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gem.install vagrant

salt \(aq*\(aq gem.install redphone gem_bin=/opt/sensu/embedded/bin/gem
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gem.list_(prefix=\(aq\(aq, ruby=None, runas=None, gem_bin=None)
List locally installed gems.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprefix\fP \-\- string :
Only list gems when the name matches this prefix.
.IP \(bu 2
\fBgem_bin\fP \-\- string : None
Full path to \fBgem\fP binary to use.
.IP \(bu 2
\fBruby\fP \-\- string : None
If RVM or rbenv are installed, the ruby version and gemset to use.
Ignored if \fBgem_bin\fP is specified.
.IP \(bu 2
\fBrunas\fP \-\- string : None
The user to run gem as.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gem.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gem.list_upgrades(ruby=None, runas=None, gem_bin=None)
New in version 2015.8.0.

.sp
Check if an upgrade is available for installed gems
.INDENT 7.0
.TP
.B gem_bin
None
Full path to \fBgem\fP binary to use.
.TP
.B ruby
None
If RVM or rbenv are installed, the ruby version and gemset to use.
Ignored if \fBgem_bin\fP is specified.
.TP
.B runas
None
The user to run gem as.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gem.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gem.sources_add(source_uri, ruby=None, runas=None, gem_bin=None)
Add a gem source.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsource_uri\fP \-\- string
The source URI to add.
.IP \(bu 2
\fBgem_bin\fP \-\- string : None
Full path to \fBgem\fP binary to use.
.IP \(bu 2
\fBruby\fP \-\- string : None
If RVM or rbenv are installed, the ruby version and gemset to use.
Ignored if \fBgem_bin\fP is specified.
.IP \(bu 2
\fBrunas\fP \-\- string : None
The user to run gem as.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gem.sources_add http://rubygems.org/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gem.sources_list(ruby=None, runas=None, gem_bin=None)
List the configured gem sources.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBgem_bin\fP \-\- string : None
Full path to \fBgem\fP binary to use.
.IP \(bu 2
\fBruby\fP \-\- string : None
If RVM or rbenv are installed, the ruby version and gemset to use.
Ignored if \fBgem_bin\fP is specified.
.IP \(bu 2
\fBrunas\fP \-\- string : None
The user to run gem as.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gem.sources_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gem.sources_remove(source_uri, ruby=None, runas=None, gem_bin=None)
Remove a gem source.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsource_uri\fP \-\- string
The source URI to remove.
.IP \(bu 2
\fBgem_bin\fP \-\- string : None
Full path to \fBgem\fP binary to use.
.IP \(bu 2
\fBruby\fP \-\- string : None
If RVM or rbenv are installed, the ruby version and gemset to use.
Ignored if \fBgem_bin\fP is specified.
.IP \(bu 2
\fBrunas\fP \-\- string : None
The user to run gem as.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gem.sources_remove http://rubygems.org/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gem.uninstall(gems, ruby=None, runas=None, gem_bin=None)
Uninstall one or several gems.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBgems\fP \-\- string
The gems to uninstall.
.IP \(bu 2
\fBgem_bin\fP \-\- string : None
Full path to \fBgem\fP binary to use.
.IP \(bu 2
\fBruby\fP \-\- string : None
If RVM or rbenv are installed, the ruby version and gemset to use.
Ignored if \fBgem_bin\fP is specified.
.IP \(bu 2
\fBrunas\fP \-\- string : None
The user to run gem as.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gem.uninstall vagrant
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gem.update(gems, ruby=None, runas=None, gem_bin=None)
Update one or several gems.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBgems\fP \-\- string
The gems to update.
.IP \(bu 2
\fBgem_bin\fP \-\- string : None
Full path to \fBgem\fP binary to use.
.IP \(bu 2
\fBruby\fP \-\- string : None
If RVM or rbenv are installed, the ruby version and gemset to use.
Ignored if \fBgem_bin\fP is specified.
.IP \(bu 2
\fBrunas\fP \-\- string : None
The user to run gem as.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gem.update vagrant
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gem.update_system(version=\(aq\(aq, ruby=None, runas=None, gem_bin=None)
Update rubygems.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBversion\fP \-\- string : (newest)
The version of rubygems to install.
.IP \(bu 2
\fBgem_bin\fP \-\- string : None
Full path to \fBgem\fP binary to use.
.IP \(bu 2
\fBruby\fP \-\- string : None
If RVM or rbenv are installed, the ruby version and gemset to use.
Ignored if \fBgem_bin\fP is specified.
.IP \(bu 2
\fBrunas\fP \-\- string : None
The user to run gem as.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gem.update_system
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gem.version(ruby=None, runas=None, gem_bin=None)
Print out the version of gem
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBgem_bin\fP \-\- string : None
Full path to \fBgem\fP binary to use.
.IP \(bu 2
\fBruby\fP \-\- string : None
If RVM or rbenv are installed, the ruby version and gemset to use.
Ignored if \fBgem_bin\fP is specified.
.IP \(bu 2
\fBrunas\fP \-\- string : None
The user to run gem as.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gem.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.genesis
.sp
Module for managing container and VM images
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B salt.modules.genesis.avail_platforms()
Return which platforms are available
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion genesis.avail_platforms
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.genesis.bootstrap(platform, root, img_format=\(aqdir\(aq, fs_format=\(aqext2\(aq, fs_opts=None, arch=None, flavor=None, repo_url=None, static_qemu=None, img_size=None, mount_dir=None, pkg_cache=None, pkgs=None, exclude_pkgs=None, epel_url=\(aqhttp://download.fedoraproject.org/pub/epel/6/i386/epel\-release\-6\-8.noarch.rpm\(aq)
Create an image for a specific platform.
.sp
Please note that this function \fIMUST\fP be run as root, as images that are
created make files belonging to root.
.INDENT 7.0
.TP
.B platform
Which platform to use to create the image. Currently supported platforms
are rpm, deb and pacman.
.TP
.B root
Local path to create the root of the image filesystem.
.TP
.B img_format
Which format to create the image in. By default, just copies files into
a directory on the local filesystem (\fBdir\fP). Future support will exist
for \fBsparse\fP\&.
.TP
.B fs_format
When using a non\-\fBdir\fP \fBimg_format\fP, which filesystem to format the
image to. By default, \fBext2\fP\&.
.TP
.B fs_opts
When using a non\-\fBdir\fP \fBimg_format\fP, a dict of opts may be
specified.
.TP
.B arch
Architecture to install packages for, if supported by the underlying
bootstrap tool. Currently only used for deb.
.TP
.B flavor
Which flavor of operating system to install. This correlates to a
specific directory on the distribution repositories. For instance,
\fBwheezy\fP on Debian.
.TP
.B repo_url
Mainly important for Debian\-based repos. Base URL for the mirror to
install from. (e.x.: \fI\%http://ftp.debian.org/debian/\fP)
.TP
.B static_qemu
Local path to the static qemu binary required for this arch.
(e.x.: /usr/bin/qemu\-amd64\-static)
.TP
.B pkg_confs
The location of the conf files to copy into the image, to point the
installer to the right repos and configuration.
.TP
.B img_size
If img_format is not \fBdir\fP, then the size of the image must be
specified.
.TP
.B mount_dir
If img_format is not \fBdir\fP, then the image must be mounted somewhere.
If the \fBmount_dir\fP is not specified, then it will be created at
\fB/opt/salt\-genesis.<random_uuid>\fP\&. This directory will be unmounted
and removed when the process is finished.
.TP
.B pkg_cache
This points to a directory containing a cache of package files to be
copied to the image. It does not need to be specified.
.TP
.B pkgs
A list of packages to be installed on this image. For RedHat, this
will include \fByum\fP, \fBcentos\-release\fP and \fBiputils\fP by default.
.TP
.B exclude_pkgs
A list of packages to be excluded. If you do not want to install the
defaults, you need to include them in this list.
.TP
.B epel_url
The URL to download the EPEL release package from.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion genesis.bootstrap pacman /root/arch
salt myminion genesis.bootstrap rpm /root/redhat
salt myminion genesis.bootstrap deb /root/wheezy arch=amd64             flavor=wheezy static_qemu=/usr/bin/qemu\-x86_64\-static
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.genesis.ldd_deps(filename, ret=None)
Recurse through a set of dependencies reported by \fBldd\fP, to find
associated dependencies.
.sp
Please note that this does not necessarily resolve all (non\-package)
dependencies for a file; but it does help.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion genesis.ldd_deps bash
salt myminion genesis.ldd_deps /bin/bash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.genesis.mksls(fmt, src, dst=None)
Convert an installation file/script to an SLS file. Currently supports
\fBkickstart\fP, \fBpreseed\fP, and \fBautoyast\fP\&.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <minion> genesis.mksls kickstart /path/to/kickstart.cfg
salt <minion> genesis.mksls kickstart /path/to/kickstart.cfg /path/to/dest.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.genesis.pack(name, root, path=None, pack_format=\(aqtar\(aq, compress=\(aqbzip2\(aq)
Pack up a directory structure, into a specific format
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion genesis.pack centos /root/centos
salt myminion genesis.pack centos /root/centos pack_format=\(aqtar\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.genesis.unpack(name, dest=None, path=None, pack_format=\(aqtar\(aq, compress=\(aqbz2\(aq)
Unpack an image into a directory structure
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion genesis.unpack centos /root/centos
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.gentoo_service
.sp
Top level package command wrapper, used to translate the os detected by grains
to the correct service manager
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage services on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqservice.start\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoo_service.available(name)
Returns \fBTrue\fP if the specified service is available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.available sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoo_service.disable(name, **kwargs)
Disable the named service to start at boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disable <service name> <runlevels=single\-runlevel>
salt \(aq*\(aq service.disable <service name> <runlevels=[runlevel1,runlevel2]>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoo_service.disabled(name)
Return True if the named service is enabled, false otherwise
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disabled <service name> <runlevels=[runlevel]>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoo_service.enable(name, **kwargs)
Enable the named service to start at boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enable <service name> <runlevels=single\-runlevel>
salt \(aq*\(aq service.enable <service name> <runlevels=[runlevel1,runlevel2]>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoo_service.enabled(name, **kwargs)
Return True if the named service is enabled, false otherwise
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enabled <service name> <runlevels=single\-runlevel>
salt \(aq*\(aq service.enabled <service name> <runlevels=[runlevel1,runlevel2]>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoo_service.get_all()
Return all available boot services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoo_service.get_disabled()
Return a set of services that are installed but disabled
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_disabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoo_service.get_enabled()
Return a list of service that are enabled on boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoo_service.missing(name)
The inverse of service.available.
Returns \fBTrue\fP if the specified service is not available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.missing sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoo_service.reload_(name)
Reload the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoo_service.restart(name)
Restart the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoo_service.start(name)
Start the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoo_service.status(name, sig=None)
Return the status for a service.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.sp
Changed in version 2018.3.0: The service name can now be a glob (e.g. \fBsalt*\fP)

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.IP \(bu 2
\fBsig\fP (\fI\%str\fP) \-\- Signature to use to find the service via ps
.UNINDENT
.TP
.B Returns
True if running, False otherwise
dict: Maps service name to True if running, False otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name> [service signature]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoo_service.stop(name)
Stop the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoo_service.zap(name)
Resets service state
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.zap <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.gentoolkitmod
.sp
Support for Gentoolkit
.INDENT 0.0
.TP
.B salt.modules.gentoolkitmod.eclean_dist(destructive=False, package_names=False, size_limit=0, time_limit=0, fetch_restricted=False, exclude_file=\(aq/etc/eclean/distfiles.exclude\(aq)
Clean obsolete portage sources
.INDENT 7.0
.TP
.B destructive
Only keep minimum for reinstallation
.TP
.B package_names
Protect all versions of installed packages. Only meaningful if used
with destructive=True
.TP
.B size_limit <size>
Don\(aqt delete distfiles bigger than <size>.
<size> is a size specification: \(dq10M\(dq is \(dqten megabytes\(dq,
\(dq200K\(dq is \(dqtwo hundreds kilobytes\(dq, etc. Units are: G, M, K and B.
.TP
.B time_limit <time>
Don\(aqt delete distfiles files modified since <time>
<time> is an amount of time: \(dq1y\(dq is \(dqone year\(dq, \(dq2w\(dq is
\(dqtwo weeks\(dq, etc. Units are: y (years), m (months), w (weeks),
d (days) and h (hours).
.TP
.B fetch_restricted
Protect fetch\-restricted files. Only meaningful if used with
destructive=True
.TP
.B exclude_file
Path to exclusion file. Default is /etc/eclean/distfiles.exclude
This is the same default eclean\-dist uses. Use None if this file
exists and you want to ignore.
.UNINDENT
.sp
Returns a dict containing the cleaned, saved, and deprecated dists:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqcleaned\(aq: {<dist file>: <size>},
 \(aqdeprecated\(aq: {<package>: <dist file>},
 \(aqsaved\(aq: {<package>: <dist file>},
 \(aqtotal_cleaned\(aq: <size>}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gentoolkit.eclean_dist destructive=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoolkitmod.eclean_pkg(destructive=False, package_names=False, time_limit=0, exclude_file=\(aq/etc/eclean/packages.exclude\(aq)
Clean obsolete binary packages
.INDENT 7.0
.TP
.B destructive
Only keep minimum for reinstallation
.TP
.B package_names
Protect all versions of installed packages. Only meaningful if used
with destructive=True
.TP
.B time_limit <time>
Don\(aqt delete distfiles files modified since <time>
<time> is an amount of time: \(dq1y\(dq is \(dqone year\(dq, \(dq2w\(dq is
\(dqtwo weeks\(dq, etc. Units are: y (years), m (months), w (weeks),
d (days) and h (hours).
.TP
.B exclude_file
Path to exclusion file. Default is /etc/eclean/packages.exclude
This is the same default eclean\-pkg uses. Use None if this file
exists and you want to ignore.
.UNINDENT
.sp
Returns a dict containing the cleaned binary packages:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqcleaned\(aq: {<dist file>: <size>},
 \(aqtotal_cleaned\(aq: <size>}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gentoolkit.eclean_pkg destructive=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoolkitmod.glsa_check_list(glsa_list)
List the status of Gentoo Linux Security Advisories
.INDENT 7.0
.TP
.B glsa_list
can contain an arbitrary number of GLSA ids, filenames
containing GLSAs or the special identifiers \(aqall\(aq and \(aqaffected\(aq
.UNINDENT
.sp
Returns a dict containing glsa ids with a description, status, and CVEs:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{<glsa_id>: {\(aqdescription\(aq: <glsa_description>,
 \(aqstatus\(aq: <glsa status>,
 \(aqCVEs\(aq: [<list of CVEs>]}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gentoolkit.glsa_check_list \(aqaffected\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gentoolkitmod.revdep_rebuild(lib=None)
Fix up broken reverse dependencies
.INDENT 7.0
.TP
.B lib
Search for reverse dependencies for a particular library rather
than every library on the system. It can be a full path to a
library or basic regular expression.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gentoolkit.revdep_rebuild
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.git
.sp
Support for the Git SCM
.INDENT 0.0
.TP
.B salt.modules.git.add(cwd, filename, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None)
Changed in version 2015.8.0: The \fB\-\-verbose\fP command line argument is now implied

.sp
Interface to \fI\%git\-add(1)\fP
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B filename
The location of the file/directory to add, relative to \fBcwd\fP
.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP (as in the CLI examples
below) to avoid causing errors with Salt\(aqs own argument parsing.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the \fBadd\fP
subcommand), in a single string. This is useful for passing \fB\-c\fP to
run git with temporary changes to the git configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.add /path/to/repo foo/bar.py
salt myminion git.add /path/to/repo foo/bar.py opts=\(aq\-\-dry\-run\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.archive(cwd, output, rev=\(aqHEAD\(aq, prefix=None, git_opts=\(aq\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None, **kwargs)
Changed in version 2015.8.0: Returns \fBTrue\fP if successful, raises an error if not.

.sp
Interface to \fI\%git\-archive(1)\fP, exports a tarball/zip file of the
repository
.INDENT 7.0
.TP
.B cwd
The path to be archived
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBgit archive\fP permits a partial archive to be created. Thus, this
path does not need to be the root of the git repository. Only the
files within the directory specified by \fBcwd\fP (and its
subdirectories) will be in the resulting archive. For example, if
there is a git checkout at \fB/tmp/foo\fP, then passing
\fB/tmp/foo/bar\fP as the \fBcwd\fP will result in just the files
underneath \fB/tmp/foo/bar\fP to be exported as an archive.
.UNINDENT
.UNINDENT
.TP
.B output
The path of the archive to be created
.TP
.B overwrite
False
Unless set to \fBTrue\fP, Salt will over overwrite an existing archive at
the path specified by the \fBoutput\fP argument.
.sp
New in version 2015.8.0.

.TP
.B rev
HEAD
The revision from which to create the archive
.TP
.B format
Manually specify the file format of the resulting archive. This
argument can be omitted, and \fBgit archive\fP will attempt to guess the
archive type (and compression) from the filename. \fBzip\fP, \fBtar\fP,
\fBtar.gz\fP, and \fBtgz\fP are extensions that are recognized
automatically, and git can be configured to support other archive types
with the addition of git configuration keys.
.sp
See the \fI\%git\-archive(1)\fP manpage explanation of the
\fB\-\-format\fP argument (as well as the \fBCONFIGURATION\fP section of the
manpage) for further information.
.sp
New in version 2015.8.0.

.TP
.B prefix
Prepend \fB<prefix>\fP to every filename in the archive. If unspecified,
the name of the directory at the top level of the repository will be
used as the prefix (e.g. if \fBcwd\fP is set to \fB/foo/bar/baz\fP, the
prefix will be \fBbaz\fP, and the resulting archive will contain a
top\-level directory by that name).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The default behavior if the \fB\-\-prefix\fP option for \fBgit archive\fP
is not specified is to not prepend a prefix, so Salt\(aqs behavior
differs slightly from \fBgit archive\fP in this respect. Use
\fBprefix=\(aq\(aq\fP to create an archive with no prefix.
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.0: The behavior of this argument has been changed slightly. As of
this version, it is necessary to include the trailing slash when
specifying a prefix, if the prefix is intended to create a
top\-level directory.

.TP
.B git_opts
Any additional options to add to git command itself (not the
\fBarchive\fP subcommand), in a single string. This is useful for passing
\fB\-c\fP to run git with temporary changes to the git configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.archive /path/to/repo /path/to/archive.tar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.branch(cwd, name=None, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None)
Interface to \fI\%git\-branch(1)\fP
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B name
Name of the branch on which to operate. If not specified, the current
branch will be assumed.
.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To create a branch based on something other than HEAD, pass the
name of the revision as \fBopts\fP\&. If the revision is in the format
\fBremotename/branch\fP, then this will also set the remote tracking
branch.
.sp
Additionally, on the Salt CLI, if the opts are preceded with a
dash, it is necessary to precede them with \fBopts=\fP (as in the CLI
examples below) to avoid causing errors with Salt\(aqs own argument
parsing.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the \fBbranch\fP
subcommand), in a single string. This is useful for passing \fB\-c\fP to
run git with temporary changes to the git configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Set remote tracking branch
salt myminion git.branch /path/to/repo mybranch opts=\(aq\-\-set\-upstream\-to origin/mybranch\(aq
# Create new branch
salt myminion git.branch /path/to/repo mybranch upstream/somebranch
# Delete branch
salt myminion git.branch /path/to/repo mybranch opts=\(aq\-d\(aq
# Rename branch (2015.8.0 and later)
salt myminion git.branch /path/to/repo newbranch opts=\(aq\-m oldbranch\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.checkout(cwd, rev=None, force=False, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None)
Interface to \fI\%git\-checkout(1)\fP
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP (as in the CLI examples
below) to avoid causing errors with Salt\(aqs own argument parsing.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the
\fBcheckout\fP subcommand), in a single string. This is useful for
passing \fB\-c\fP to run git with temporary changes to the git
configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B rev
The remote branch or revision to checkout.
.sp
Changed in version 2015.8.0: Optional when using \fB\-b\fP or \fB\-B\fP in \fBopts\fP\&.

.TP
.B force
False
Force a checkout even if there might be overwritten changes
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Checking out local local revisions
salt myminion git.checkout /path/to/repo somebranch user=jeff
salt myminion git.checkout /path/to/repo opts=\(aqtestbranch \-\- conf/file1 file2\(aq
salt myminion git.checkout /path/to/repo rev=origin/mybranch opts=\(aq\-\-track\(aq
# Checking out remote revision into new branch
salt myminion git.checkout /path/to/repo upstream/master opts=\(aq\-b newbranch\(aq
# Checking out current revision into new branch (2015.8.0 and later)
salt myminion git.checkout /path/to/repo opts=\(aq\-b newbranch\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.clone(cwd, url=None, name=None, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, identity=None, https_user=None, https_pass=None, ignore_retcode=False, saltenv=\(aqbase\(aq, output_encoding=None)
Interface to \fI\%git\-clone(1)\fP
.INDENT 7.0
.TP
.B cwd
Location of git clone
.sp
Changed in version 2015.8.0: If \fBname\fP is passed, then the clone will be made \fIwithin\fP this
directory.

.TP
.B url
The URL of the repository to be cloned
.sp
Changed in version 2015.8.0: Argument renamed from \fBrepository\fP to \fBurl\fP

.TP
.B name
Optional alternate name for the top\-level directory to be created by
the clone
.sp
New in version 2015.8.0.

.TP
.B opts
Any additional options to add to the command line, in a single string
.TP
.B git_opts
Any additional options to add to git command itself (not the \fBclone\fP
subcommand), in a single string. This is useful for passing \fB\-c\fP to
run git with temporary changes to the git configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B identity
Path to a private key to use for ssh URLs
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Unless Salt is invoked from the minion using \fBsalt\-call\fP, the
key(s) must be passphraseless. For greater security with
passphraseless private keys, see the \fI\%sshd(8)\fP manpage for
information on securing the keypair from the remote side in the
\fBauthorized_keys\fP file.
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.7: Salt will no longer attempt to use passphrase\-protected keys unless
invoked from the minion using \fBsalt\-call\fP, to prevent blocking
waiting for user input.

.sp
Key can also be specified as a SaltStack file server URL, eg. salt://location/identity_file
.sp
Changed in version 2016.3.0.

.TP
.B https_user
Set HTTP Basic Auth username. Only accepted for HTTPS URLs.
.sp
New in version 2015.5.0.

.TP
.B https_pass
Set HTTP Basic Auth password. Only accepted for HTTPS URLs.
.sp
New in version 2015.5.0.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B saltenv
The default salt environment to pull sls files from
.sp
New in version 2016.3.1.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.clone /path/to/repo_parent_dir git://github.com/saltstack/salt.git
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.commit(cwd, message, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, filename=None, ignore_retcode=False, output_encoding=None)
Interface to \fI\%git\-commit(1)\fP
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B message
Commit message
.TP
.B opts
Any additional options to add to the command line, in a single string.
These opts will be added to the end of the git command being run.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP (as in the CLI examples
below) to avoid causing errors with Salt\(aqs own argument parsing.
.sp
The \fB\-m\fP option should not be passed here, as the commit message
will be defined by the \fBmessage\fP argument.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the \fBcommit\fP
subcommand), in a single string. This is useful for passing \fB\-c\fP to
run git with temporary changes to the git configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B filename
The location of the file/directory to commit, relative to \fBcwd\fP\&.
This argument is optional, and can be used to commit a file without
first staging it.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument only works on files which are already tracked by the
git repository.
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.commit /path/to/repo \(aqThe commit message\(aq
salt myminion git.commit /path/to/repo \(aqThe commit message\(aq filename=foo/bar.py
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.config_get(key, cwd=None, user=None, password=None, ignore_retcode=False, output_encoding=None, **kwargs)
Get the value of a key in the git configuration file
.INDENT 7.0
.TP
.B key
The name of the configuration key to get
.sp
Changed in version 2015.8.0: Argument renamed from \fBsetting_name\fP to \fBkey\fP

.TP
.B cwd
The path to the git checkout
.sp
Changed in version 2015.8.0: Now optional if \fBglobal\fP is set to \fBTrue\fP

.TP
.B global
False
If \fBTrue\fP, query the global git configuration. Otherwise, only the
local git configuration will be queried.
.sp
New in version 2015.8.0.

.TP
.B all
False
If \fBTrue\fP, return a list of all values set for \fBkey\fP\&. If the key
does not exist, \fBNone\fP will be returned.
.sp
New in version 2015.8.0.

.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.config_get user.name cwd=/path/to/repo
salt myminion git.config_get user.email global=True
salt myminion git.config_get core.gitproxy cwd=/path/to/repo all=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.config_get_regex(key, value_regex=None, cwd=None, user=None, password=None, ignore_retcode=False, output_encoding=None, **kwargs)
This function is an alias of \fBconfig_get_regexp\fP\&.
.INDENT 7.0
.INDENT 3.5
New in version 2015.8.0.

.sp
Get the value of a key or keys in the git configuration file using regexes
for more flexible matching. The return data is a dictionary mapping keys to
lists of values matching the \fBvalue_regex\fP\&. If no values match, an empty
dictionary will be returned.
.INDENT 0.0
.TP
.B key
Regex on which key names will be matched
.TP
.B value_regex
If specified, return all values matching this regex. The return data
will be a dictionary mapping keys to lists of values matching the
regex.
.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
Only values matching the \fBvalue_regex\fP will be part of the return
data. So, if \fBkey\fP matches a multivar, then it is possible that
not all of the values will be returned. To get all values set for a
multivar, simply omit the \fBvalue_regex\fP argument.
.UNINDENT
.UNINDENT
.TP
.B cwd
The path to the git checkout
.TP
.B global
False
If \fBTrue\fP, query the global git configuration. Otherwise, only the
local git configuration will be queried.
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Matches any values for key \(aqfoo.bar\(aq
salt myminion git.config_get_regexp /path/to/repo foo.bar
# Matches any value starting with \(aqbaz\(aq set for key \(aqfoo.bar\(aq
salt myminion git.config_get_regexp /path/to/repo foo.bar \(aqbaz.*\(aq
# Matches any key starting with \(aquser.\(aq
salt myminion git.config_get_regexp \(aq^user\e.\(aq global=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.config_get_regexp(key, value_regex=None, cwd=None, user=None, password=None, ignore_retcode=False, output_encoding=None, **kwargs)
New in version 2015.8.0.

.sp
Get the value of a key or keys in the git configuration file using regexes
for more flexible matching. The return data is a dictionary mapping keys to
lists of values matching the \fBvalue_regex\fP\&. If no values match, an empty
dictionary will be returned.
.INDENT 7.0
.TP
.B key
Regex on which key names will be matched
.TP
.B value_regex
If specified, return all values matching this regex. The return data
will be a dictionary mapping keys to lists of values matching the
regex.
.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
Only values matching the \fBvalue_regex\fP will be part of the return
data. So, if \fBkey\fP matches a multivar, then it is possible that
not all of the values will be returned. To get all values set for a
multivar, simply omit the \fBvalue_regex\fP argument.
.UNINDENT
.UNINDENT
.TP
.B cwd
The path to the git checkout
.TP
.B global
False
If \fBTrue\fP, query the global git configuration. Otherwise, only the
local git configuration will be queried.
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Matches any values for key \(aqfoo.bar\(aq
salt myminion git.config_get_regexp /path/to/repo foo.bar
# Matches any value starting with \(aqbaz\(aq set for key \(aqfoo.bar\(aq
salt myminion git.config_get_regexp /path/to/repo foo.bar \(aqbaz.*\(aq
# Matches any key starting with \(aquser.\(aq
salt myminion git.config_get_regexp \(aq^user\e.\(aq global=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.config_set(key, value=None, multivar=None, cwd=None, user=None, password=None, ignore_retcode=False, output_encoding=None, **kwargs)
Changed in version 2015.8.0: Return the value(s) of the key being set

.sp
Set a key in the git configuration file
.INDENT 7.0
.TP
.B cwd
The path to the git checkout. Must be an absolute path, or the word
\fBglobal\fP to indicate that a global key should be set.
.sp
Changed in version 2014.7.0: Made \fBcwd\fP argument optional if \fBis_global=True\fP

.TP
.B key
The name of the configuration key to set
.sp
Changed in version 2015.8.0: Argument renamed from \fBsetting_name\fP to \fBkey\fP

.TP
.B value
The value to set for the specified key. Incompatible with the
\fBmultivar\fP argument.
.sp
Changed in version 2015.8.0: Argument renamed from \fBsetting_value\fP to \fBvalue\fP

.TP
.B add
False
Add a value to a key, creating/updating a multivar
.sp
New in version 2015.8.0.

.TP
.B multivar
Set a multivar all at once. Values can be comma\-separated or passed as
a Python list. Incompatible with the \fBvalue\fP argument.
.sp
New in version 2015.8.0.

.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B global
False
If \fBTrue\fP, set a global variable
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.config_set user.email me@example.com cwd=/path/to/repo
salt myminion git.config_set user.email foo@bar.com global=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.config_unset(key, value_regex=None, cwd=None, user=None, password=None, ignore_retcode=False, output_encoding=None, **kwargs)
New in version 2015.8.0.

.sp
Unset a key in the git configuration file
.INDENT 7.0
.TP
.B cwd
The path to the git checkout. Must be an absolute path, or the word
\fBglobal\fP to indicate that a global key should be unset.
.TP
.B key
The name of the configuration key to unset
.TP
.B value_regex
Regular expression that matches exactly one key, used to delete a
single value from a multivar. Ignored if \fBall\fP is set to \fBTrue\fP\&.
.TP
.B all
False
If \fBTrue\fP unset all values for a multivar. If \fBFalse\fP, and \fBkey\fP
is a multivar, an error will be raised.
.TP
.B global
False
If \fBTrue\fP, unset set a global variable. Otherwise, a local variable
will be unset.
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.config_unset /path/to/repo foo.bar
salt myminion git.config_unset /path/to/repo foo.bar all=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.current_branch(cwd, user=None, password=None, ignore_retcode=False, output_encoding=None)
Returns the current branch name of a local checkout. If HEAD is detached,
return the SHA1 of the revision which is currently checked out.
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.current_branch /path/to/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.describe(cwd, rev=\(aqHEAD\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None)
Returns the \fI\%git\-describe(1)\fP string (or the SHA1 hash if there are no
tags) for the given revision.
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B rev
HEAD
The revision to describe
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.describe /path/to/repo
salt myminion git.describe /path/to/repo develop
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.diff(cwd, item1=None, item2=None, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, no_index=False, cached=False, paths=None, output_encoding=None)
New in version 2015.8.12,2016.3.3,2016.11.0.

.sp
Interface to \fI\%git\-diff(1)\fP
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B item1 and item2
Revision(s) to pass to the \fBgit diff\fP command. One or both of these
arguments may be ignored if some of the options below are set to
\fBTrue\fP\&. When \fBcached\fP is \fBFalse\fP, and no revisions are passed
to this function, then the current working tree will be compared
against the index (i.e. unstaged changes). When two revisions are
passed, they will be compared to each other.
.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP (as in the CLI examples
below) to avoid causing errors with Salt\(aqs own argument parsing.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the \fBdiff\fP
subcommand), in a single string. This is useful for passing \fB\-c\fP to
run git with temporary changes to the git configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B no_index
False
When it is necessary to diff two files in the same repo against each
other, and not diff two different revisions, set this option to
\fBTrue\fP\&. If this is left \fBFalse\fP in these instances, then a normal
\fBgit diff\fP will be performed against the index (i.e. unstaged
changes), and files in the \fBpaths\fP option will be used to narrow down
the diff output.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Requires Git 1.5.1 or newer. Additionally, when set to \fBTrue\fP,
\fBitem1\fP and \fBitem2\fP will be ignored.
.UNINDENT
.UNINDENT
.TP
.B cached
False
If \fBTrue\fP, compare staged changes to \fBitem1\fP (if specified),
otherwise compare them to the most recent commit.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBitem2\fP is ignored if this option is is set to \fBTrue\fP\&.
.UNINDENT
.UNINDENT
.TP
.B paths
File paths to pass to the \fBgit diff\fP command. Can be passed as a
comma\-separated list or a Python list.
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Perform diff against the index (staging area for next commit)
salt myminion git.diff /path/to/repo
# Compare staged changes to the most recent commit
salt myminion git.diff /path/to/repo cached=True
# Compare staged changes to a specific revision
salt myminion git.diff /path/to/repo mybranch cached=True
# Perform diff against the most recent commit (includes staged changes)
salt myminion git.diff /path/to/repo HEAD
# Diff two commits
salt myminion git.diff /path/to/repo abcdef1 aabbccd
# Diff two commits, only showing differences in the specified paths
salt myminion git.diff /path/to/repo abcdef1 aabbccd paths=path/to/file1,path/to/file2
# Diff two files with one being outside the working tree
salt myminion git.diff /path/to/repo no_index=True paths=path/to/file1,/absolute/path/to/file2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.discard_local_changes(cwd, path=\(aq.\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None)
New in version 2019.2.0.

.sp
Runs a \fBgit checkout \-\- <path>\fP from the directory specified by \fBcwd\fP\&.
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B path
path relative to cwd (defaults to \fB\&.\fP)
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.discard_local_changes /path/to/repo
salt myminion git.discard_local_changes /path/to/repo path=foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.fetch(cwd, remote=None, force=False, refspecs=None, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, identity=None, ignore_retcode=False, saltenv=\(aqbase\(aq, output_encoding=None)
Changed in version 2015.8.2: Return data is now a dictionary containing information on branches and
tags that were added/updated

.sp
Interface to \fI\%git\-fetch(1)\fP
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B remote
Optional remote name to fetch. If not passed, then git will use its
default behavior (as detailed in \fI\%git\-fetch(1)\fP).
.sp
New in version 2015.8.0.

.TP
.B force
Force the fetch even when it is not a fast\-forward.
.sp
New in version 2015.8.0.

.TP
.B refspecs
Override the refspec(s) configured for the remote with this argument.
Multiple refspecs can be passed, comma\-separated.
.sp
New in version 2015.8.0.

.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP (as in the CLI examples
below) to avoid causing errors with Salt\(aqs own argument parsing.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the \fBfetch\fP
subcommand), in a single string. This is useful for passing \fB\-c\fP to
run git with temporary changes to the git configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B identity
Path to a private key to use for ssh URLs
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Unless Salt is invoked from the minion using \fBsalt\-call\fP, the
key(s) must be passphraseless. For greater security with
passphraseless private keys, see the \fI\%sshd(8)\fP manpage for
information on securing the keypair from the remote side in the
\fBauthorized_keys\fP file.
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.7: Salt will no longer attempt to use passphrase\-protected keys unless
invoked from the minion using \fBsalt\-call\fP, to prevent blocking
waiting for user input.

.sp
Key can also be specified as a SaltStack file server URL, eg. salt://location/identity_file
.sp
Changed in version 2016.3.0.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B saltenv
The default salt environment to pull sls files from
.sp
New in version 2016.3.1.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.fetch /path/to/repo upstream
salt myminion git.fetch /path/to/repo identity=/root/.ssh/id_rsa
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.init(cwd, bare=False, template=None, separate_git_dir=None, shared=None, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None)
Interface to \fI\%git\-init(1)\fP
.INDENT 7.0
.TP
.B cwd
The path to the directory to be initialized
.TP
.B bare
False
If \fBTrue\fP, init a bare repository
.sp
New in version 2015.8.0.

.TP
.B template
Set this argument to specify an alternate \fI\%template directory\fP
.sp
New in version 2015.8.0.

.TP
.B separate_git_dir
Set this argument to specify an alternate \fB$GIT_DIR\fP
.sp
New in version 2015.8.0.

.TP
.B shared
Set sharing permissions on git repo. See \fI\%git\-init(1)\fP for more
details.
.sp
New in version 2015.8.0.

.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP (as in the CLI examples
below) to avoid causing errors with Salt\(aqs own argument parsing.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the \fBinit\fP
subcommand), in a single string. This is useful for passing \fB\-c\fP to
run git with temporary changes to the git configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.init /path/to/repo
# Init a bare repo (before 2015.8.0)
salt myminion git.init /path/to/bare/repo.git opts=\(aq\-\-bare\(aq
# Init a bare repo (2015.8.0 and later)
salt myminion git.init /path/to/bare/repo.git bare=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.is_worktree(cwd, user=None, password=None, output_encoding=None)
New in version 2015.8.0.

.sp
This function will attempt to determine if \fBcwd\fP is part of a
worktree by checking its \fB\&.git\fP to see if it is a file containing a
reference to another gitdir.
.INDENT 7.0
.TP
.B cwd
path to the worktree to be removed
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.is_worktree /path/to/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.list_branches(cwd, remote=False, user=None, password=None, ignore_retcode=False, output_encoding=None)
New in version 2015.8.0.

.sp
Return a list of branches
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B remote
False
If \fBTrue\fP, list remote branches. Otherwise, local branches will be
listed.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This option will only return remote branches of which the local
checkout is aware, use \fI\%git.fetch\fP to update remotes.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.list_branches /path/to/repo
salt myminion git.list_branches /path/to/repo remote=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.list_tags(cwd, user=None, password=None, ignore_retcode=False, output_encoding=None)
New in version 2015.8.0.

.sp
Return a list of tags
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.list_tags /path/to/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.list_worktrees(cwd, stale=False, user=None, password=None, output_encoding=None, **kwargs)
New in version 2015.8.0.

.sp
Returns information on worktrees
.sp
Changed in version 2015.8.4: Version 2.7.0 added the \fBlist\fP subcommand to \fI\%git\-worktree(1)\fP which
provides a lot of additional information. The return data has been
changed to include this information, even for pre\-2.7.0 versions of
git. In addition, if a worktree has a detached head, then any tags
which point to the worktree\(aqs HEAD will be included in the return data.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
By default, only worktrees for which the worktree directory is still
present are returned, but this can be changed using the \fBall\fP and
\fBstale\fP arguments (described below).
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B all
False
If \fBTrue\fP, then return all worktrees tracked under
$GIT_DIR/worktrees, including ones for which the gitdir is no longer
present.
.TP
.B stale
False
If \fBTrue\fP, return \fIonly\fP worktrees whose gitdir is no longer present.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Only one of \fBall\fP and \fBstale\fP can be set to \fBTrue\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.list_worktrees /path/to/repo
salt myminion git.list_worktrees /path/to/repo all=True
salt myminion git.list_worktrees /path/to/repo stale=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.ls_remote(cwd=None, remote=\(aqorigin\(aq, ref=None, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, identity=None, https_user=None, https_pass=None, ignore_retcode=False, output_encoding=None, saltenv=\(aqbase\(aq)
Interface to \fI\%git\-ls\-remote(1)\fP\&. Returns the upstream hash for a remote
reference.
.INDENT 7.0
.TP
.B cwd
The path to the git checkout. Optional (and ignored if present) when
\fBremote\fP is set to a URL instead of a remote name.
.TP
.B remote
origin
The name of the remote to query. Can be the name of a git remote
(which exists in the git checkout defined by the \fBcwd\fP parameter),
or the URL of a remote repository.
.sp
Changed in version 2015.8.0: Argument renamed from \fBrepository\fP to \fBremote\fP

.TP
.B ref
The name of the ref to query. Optional, if not specified, all refs are
returned. Can be a branch or tag name, or the full name of the
reference (for example, to get the hash for a Github pull request number
1234, \fBref\fP can be set to \fBrefs/pull/1234/head\fP
.sp
Changed in version 2015.8.0: Argument renamed from \fBbranch\fP to \fBref\fP

.sp
Changed in version 2015.8.4: Defaults to returning all refs instead of master.

.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
New in version 2015.8.0.

.TP
.B git_opts
Any additional options to add to git command itself (not the
\fBls\-remote\fP subcommand), in a single string. This is useful for
passing \fB\-c\fP to run git with temporary changes to the git
configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B identity
Path to a private key to use for ssh URLs
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Unless Salt is invoked from the minion using \fBsalt\-call\fP, the
key(s) must be passphraseless. For greater security with
passphraseless private keys, see the \fI\%sshd(8)\fP manpage for
information on securing the keypair from the remote side in the
\fBauthorized_keys\fP file.
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.7: Salt will no longer attempt to use passphrase\-protected keys unless
invoked from the minion using \fBsalt\-call\fP, to prevent blocking
waiting for user input.

.sp
Key can also be specified as a SaltStack file server URL, eg. salt://location/identity_file
.sp
Changed in version 2016.3.0.

.TP
.B https_user
Set HTTP Basic Auth username. Only accepted for HTTPS URLs.
.sp
New in version 2015.5.0.

.TP
.B https_pass
Set HTTP Basic Auth password. Only accepted for HTTPS URLs.
.sp
New in version 2015.5.0.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B saltenv
The default salt environment to pull sls files from
.sp
New in version 2016.3.1.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.ls_remote /path/to/repo origin master
salt myminion git.ls_remote remote=https://mydomain.tld/repo.git ref=mytag opts=\(aq\-\-tags\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.merge(cwd, rev=None, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, identity=None, ignore_retcode=False, output_encoding=None, **kwargs)
Interface to \fI\%git\-merge(1)\fP
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B rev
Revision to merge into the current branch. If not specified, the remote
tracking branch will be merged.
.sp
New in version 2015.8.0.

.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP (as in the CLI examples
below) to avoid causing errors with Salt\(aqs own argument parsing.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the \fBmerge\fP
subcommand), in a single string. This is useful for passing \fB\-c\fP to
run git with temporary changes to the git configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B identity
Path to a private key to use for ssh URLs. Salt will not attempt to use
passphrase\-protected keys unless invoked from the minion using
\fBsalt\-call\fP, to prevent blocking waiting for user input. Key can also
be specified as a SaltStack file server URL, eg.
\fBsalt://location/identity_file\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For greater security with passphraseless private keys, see the
\fI\%sshd(8)\fP manpage for information on securing the keypair from the
remote side in the \fBauthorized_keys\fP file.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.5,2019.2.1,3000.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Fetch first...
salt myminion git.fetch /path/to/repo
# ... then merge the remote tracking branch
salt myminion git.merge /path/to/repo
# .. or merge another rev
salt myminion git.merge /path/to/repo rev=upstream/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.merge_base(cwd, refs=None, octopus=False, is_ancestor=False, independent=False, fork_point=None, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None, **kwargs)
New in version 2015.8.0.

.sp
Interface to \fI\%git\-merge\-base(1)\fP\&.
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B refs
Any refs/commits to check for a merge base. Can be passed as a
comma\-separated list or a Python list.
.TP
.B all
False
Return a list of all matching merge bases. Not compatible with any of
the below options except for \fBoctopus\fP\&.
.TP
.B octopus
False
If \fBTrue\fP, then this function will determine the best common
ancestors of all specified commits, in preparation for an n\-way merge.
See \fI\%here\fP for a description of how these bases are determined.
.sp
Set \fBall\fP to \fBTrue\fP with this option to return all computed merge
bases, otherwise only the \(dqbest\(dq will be returned.
.TP
.B is_ancestor
False
If \fBTrue\fP, then instead of returning the merge base, return a
boolean telling whether or not the first commit is an ancestor of the
second commit.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option requires two commits to be passed.
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.2: Works properly in git versions older than 1.8.0, where the
\fB\-\-is\-ancestor\fP CLI option is not present.

.TP
.B independent
False
If \fBTrue\fP, this function will return the IDs of the refs/commits
passed which cannot be reached by another commit.
.TP
.B fork_point
If passed, then this function will return the commit where the
commit diverged from the ref specified by \fBfork_point\fP\&. If no fork
point is found, \fBNone\fP is returned.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
At most one commit is permitted to be passed if a \fBfork_point\fP is
specified. If no commits are passed, then \fBHEAD\fP is assumed.
.UNINDENT
.UNINDENT
.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP (as in the CLI examples
below) to avoid causing errors with Salt\(aqs own argument parsing.
.sp
This option should not be necessary unless new CLI arguments are
added to \fI\%git\-merge\-base(1)\fP and are not yet supported in Salt.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the
\fBmerge\-base\fP subcommand), in a single string. This is useful for
passing \fB\-c\fP to run git with temporary changes to the git
configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
if \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.merge_base /path/to/repo HEAD upstream/mybranch
salt myminion git.merge_base /path/to/repo 8f2e542,4ad8cab,cdc9886 octopus=True
salt myminion git.merge_base /path/to/repo refs=8f2e542,4ad8cab,cdc9886 independent=True
salt myminion git.merge_base /path/to/repo refs=8f2e542,4ad8cab is_ancestor=True
salt myminion git.merge_base /path/to/repo fork_point=upstream/master
salt myminion git.merge_base /path/to/repo refs=mybranch fork_point=upstream/master
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.merge_tree(cwd, ref1, ref2, base=None, user=None, password=None, ignore_retcode=False, output_encoding=None)
New in version 2015.8.0.

.sp
Interface to \fI\%git\-merge\-tree(1)\fP, shows the merge results and conflicts
from a 3\-way merge without touching the index.
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B ref1
First ref/commit to compare
.TP
.B ref2
Second ref/commit to compare
.TP
.B base
The base tree to use for the 3\-way\-merge. If not provided, then
\fI\%git.merge_base\fP will be invoked
on \fBref1\fP and \fBref2\fP to determine the merge base to use.
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
if \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.merge_tree /path/to/repo HEAD upstream/dev
salt myminion git.merge_tree /path/to/repo HEAD upstream/dev base=aaf3c3d
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.pull(cwd, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, identity=None, ignore_retcode=False, saltenv=\(aqbase\(aq, output_encoding=None)
Interface to \fI\%git\-pull(1)\fP
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP (as in the CLI examples
below) to avoid causing errors with Salt\(aqs own argument parsing.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the \fBpull\fP
subcommand), in a single string. This is useful for passing \fB\-c\fP to
run git with temporary changes to the git configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B identity
Path to a private key to use for ssh URLs
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Unless Salt is invoked from the minion using \fBsalt\-call\fP, the
key(s) must be passphraseless. For greater security with
passphraseless private keys, see the \fI\%sshd(8)\fP manpage for
information on securing the keypair from the remote side in the
\fBauthorized_keys\fP file.
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.7: Salt will no longer attempt to use passphrase\-protected keys unless
invoked from the minion using \fBsalt\-call\fP, to prevent blocking
waiting for user input.

.sp
Key can also be specified as a SaltStack file server URL, eg. salt://location/identity_file
.sp
Changed in version 2016.3.0.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B saltenv
The default salt environment to pull sls files from
.sp
New in version 2016.3.1.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.pull /path/to/repo opts=\(aq\-\-rebase origin master\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.push(cwd, remote=None, ref=None, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, identity=None, ignore_retcode=False, saltenv=\(aqbase\(aq, output_encoding=None, **kwargs)
Interface to \fI\%git\-push(1)\fP
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B remote
Name of the remote to which the ref should being pushed
.sp
New in version 2015.8.0.

.TP
.B ref
master
Name of the ref to push
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Being a \fI\%refspec\fP, this argument can include a colon to define local
and remote ref names.
.UNINDENT
.UNINDENT
.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP (as in the CLI examples
below) to avoid causing errors with Salt\(aqs own argument parsing.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the \fBpush\fP
subcommand), in a single string. This is useful for passing \fB\-c\fP to
run git with temporary changes to the git configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B identity
Path to a private key to use for ssh URLs
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Unless Salt is invoked from the minion using \fBsalt\-call\fP, the
key(s) must be passphraseless. For greater security with
passphraseless private keys, see the \fI\%sshd(8)\fP manpage for
information on securing the keypair from the remote side in the
\fBauthorized_keys\fP file.
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.7: Salt will no longer attempt to use passphrase\-protected keys unless
invoked from the minion using \fBsalt\-call\fP, to prevent blocking
waiting for user input.

.sp
Key can also be specified as a SaltStack file server URL, eg. salt://location/identity_file
.sp
Changed in version 2016.3.0.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B saltenv
The default salt environment to pull sls files from
.sp
New in version 2016.3.1.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Push master as origin/master
salt myminion git.push /path/to/repo origin master
# Push issue21 as upstream/develop
salt myminion git.push /path/to/repo upstream issue21:develop
# Delete remote branch \(aqupstream/temp\(aq
salt myminion git.push /path/to/repo upstream :temp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.rebase(cwd, rev=\(aqmaster\(aq, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None)
Interface to \fI\%git\-rebase(1)\fP
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B rev
master
The revision to rebase onto the current branch
.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP (as in the CLI examples
below) to avoid causing errors with Salt\(aqs own argument parsing.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the \fBrebase\fP
subcommand), in a single string. This is useful for passing \fB\-c\fP to
run git with temporary changes to the git configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.rebase /path/to/repo master
salt myminion git.rebase /path/to/repo \(aqorigin master\(aq
salt myminion git.rebase /path/to/repo origin/master opts=\(aq\-\-onto newbranch\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.remote_get(cwd, remote=\(aqorigin\(aq, user=None, password=None, redact_auth=True, ignore_retcode=False, output_encoding=None)
Get the fetch and push URL for a specific remote
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B remote
origin
Name of the remote to query
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B redact_auth
True
Set to \fBFalse\fP to include the username/password if the remote uses
HTTPS Basic Auth. Otherwise, this information will be redacted.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Setting this to \fBFalse\fP will not only reveal any HTTPS Basic Auth
that is configured, but the return data will also be written to the
job cache. When possible, it is recommended to use SSH for
authentication.
.UNINDENT
.UNINDENT
.sp
New in version 2015.5.6.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.remote_get /path/to/repo
salt myminion git.remote_get /path/to/repo upstream
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.remote_refs(url, heads=False, tags=False, user=None, password=None, identity=None, https_user=None, https_pass=None, ignore_retcode=False, output_encoding=None, saltenv=\(aqbase\(aq, **kwargs)
New in version 2015.8.0.

.sp
Return the remote refs for the specified URL by running \fBgit ls\-remote\fP\&.
.INDENT 7.0
.TP
.B url
URL of the remote repository
.TP
.B filter
Optionally provide a ref name to \fBgit ls\-remote\fP\&. This can be useful
to make this function run faster on repositories with many
branches/tags.
.sp
New in version 2019.2.0.

.TP
.B heads
False
Restrict output to heads. Can be combined with \fBtags\fP\&.
.TP
.B tags
False
Restrict output to tags. Can be combined with \fBheads\fP\&.
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B identity
Path to a private key to use for ssh URLs
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Unless Salt is invoked from the minion using \fBsalt\-call\fP, the
key(s) must be passphraseless. For greater security with
passphraseless private keys, see the \fI\%sshd(8)\fP manpage for
information on securing the keypair from the remote side in the
\fBauthorized_keys\fP file.
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.7: Salt will no longer attempt to use passphrase\-protected keys unless
invoked from the minion using \fBsalt\-call\fP, to prevent blocking
waiting for user input.

.sp
Key can also be specified as a SaltStack file server URL, eg. salt://location/identity_file
.sp
Changed in version 2016.3.0.

.TP
.B https_user
Set HTTP Basic Auth username. Only accepted for HTTPS URLs.
.TP
.B https_pass
Set HTTP Basic Auth password. Only accepted for HTTPS URLs.
.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.TP
.B saltenv
The default salt environment to pull sls files from
.sp
New in version 2016.3.1.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.remote_refs https://github.com/saltstack/salt.git
salt myminion git.remote_refs https://github.com/saltstack/salt.git filter=develop
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.remote_set(cwd, url, remote=\(aqorigin\(aq, user=None, password=None, https_user=None, https_pass=None, push_url=None, push_https_user=None, push_https_pass=None, ignore_retcode=False, output_encoding=None)
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B url
Remote URL to set
.TP
.B remote
origin
Name of the remote to set
.TP
.B push_url
If unset, the push URL will be identical to the fetch URL.
.sp
New in version 2015.8.0.

.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B https_user
Set HTTP Basic Auth username. Only accepted for HTTPS URLs.
.sp
New in version 2015.5.0.

.TP
.B https_pass
Set HTTP Basic Auth password. Only accepted for HTTPS URLs.
.sp
New in version 2015.5.0.

.TP
.B push_https_user
Set HTTP Basic Auth user for \fBpush_url\fP\&. Ignored if \fBpush_url\fP is
unset. Only accepted for HTTPS URLs.
.sp
New in version 2015.8.0.

.TP
.B push_https_pass
Set HTTP Basic Auth password for \fBpush_url\fP\&. Ignored if \fBpush_url\fP
is unset. Only accepted for HTTPS URLs.
.sp
New in version 2015.8.0.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.remote_set /path/to/repo git@github.com:user/repo.git
salt myminion git.remote_set /path/to/repo git@github.com:user/repo.git remote=upstream
salt myminion git.remote_set /path/to/repo https://github.com/user/repo.git remote=upstream push_url=git@github.com:user/repo.git
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.remotes(cwd, user=None, password=None, redact_auth=True, ignore_retcode=False, output_encoding=None)
Get fetch and push URLs for each remote in a git checkout
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B redact_auth
True
Set to \fBFalse\fP to include the username/password for authenticated
remotes in the return data. Otherwise, this information will be
redacted.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Setting this to \fBFalse\fP will not only reveal any HTTPS Basic Auth
that is configured, but the return data will also be written to the
job cache. When possible, it is recommended to use SSH for
authentication.
.UNINDENT
.UNINDENT
.sp
New in version 2015.5.6.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.remotes /path/to/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.reset(cwd, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, identity=None, ignore_retcode=False, output_encoding=None)
Interface to \fI\%git\-reset(1)\fP, returns the stdout from the git command
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP (as in the CLI examples
below) to avoid causing errors with Salt\(aqs own argument parsing.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the \fBreset\fP
subcommand), in a single string. This is useful for passing \fB\-c\fP to
run git with temporary changes to the git configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B identity
Path to a private key to use for ssh URLs. Salt will not attempt to use
passphrase\-protected keys unless invoked from the minion using
\fBsalt\-call\fP, to prevent blocking waiting for user input. Key can also
be specified as a SaltStack file server URL, eg.
\fBsalt://location/identity_file\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For greater security with passphraseless private keys, see the
\fI\%sshd(8)\fP manpage for information on securing the keypair from the
remote side in the \fBauthorized_keys\fP file.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.5,2019.2.1,3000.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Soft reset to a specific commit ID
salt myminion git.reset /path/to/repo ac3ee5c
# Hard reset
salt myminion git.reset /path/to/repo opts=\(aq\-\-hard origin/master\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.rev_parse(cwd, rev=None, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None)
New in version 2015.8.0.

.sp
Interface to \fI\%git\-rev\-parse(1)\fP
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B rev
Revision to parse. See the \fI\%SPECIFYING REVISIONS\fP section of the
\fI\%git\-rev\-parse(1)\fP manpage for details on how to format this argument.
.sp
This argument is optional when using the options in the \fIOptions for
Files\fP section of the \fI\%git\-rev\-parse(1)\fP manpage.
.TP
.B opts
Any additional options to add to the command line, in a single string
.TP
.B git_opts
Any additional options to add to git command itself (not the
\fBrev\-parse\fP subcommand), in a single string. This is useful for
passing \fB\-c\fP to run git with temporary changes to the git
configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Get the full SHA1 for HEAD
salt myminion git.rev_parse /path/to/repo HEAD
# Get the short SHA1 for HEAD
salt myminion git.rev_parse /path/to/repo HEAD opts=\(aq\-\-short\(aq
# Get the develop branch\(aqs upstream tracking branch
salt myminion git.rev_parse /path/to/repo \(aqdevelop@{upstream}\(aq opts=\(aq\-\-abbrev\-ref\(aq
# Get the SHA1 for the commit corresponding to tag v1.2.3
salt myminion git.rev_parse /path/to/repo \(aqv1.2.3^{commit}\(aq
# Find out whether or not the repo at /path/to/repo is a bare repository
salt myminion git.rev_parse /path/to/repo opts=\(aq\-\-is\-bare\-repository\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.revision(cwd, rev=\(aqHEAD\(aq, short=False, user=None, password=None, ignore_retcode=False, output_encoding=None)
Returns the SHA1 hash of a given identifier (hash, branch, tag, HEAD, etc.)
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B rev
HEAD
The revision
.TP
.B short
False
If \fBTrue\fP, return an abbreviated SHA1 git hash
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.revision /path/to/repo mybranch
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.rm_(cwd, filename, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None)
Interface to \fI\%git\-rm(1)\fP
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B filename
The location of the file/directory to remove, relative to \fBcwd\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To remove a directory, \fB\-r\fP must be part of the \fBopts\fP
parameter.
.UNINDENT
.UNINDENT
.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP (as in the CLI examples
below) to avoid causing errors with Salt\(aqs own argument parsing.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the \fBrm\fP
subcommand), in a single string. This is useful for passing \fB\-c\fP to
run git with temporary changes to the git configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.rm /path/to/repo foo/bar.py
salt myminion git.rm /path/to/repo foo/bar.py opts=\(aq\-\-dry\-run\(aq
salt myminion git.rm /path/to/repo foo/baz opts=\(aq\-r\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.stash(cwd, action=\(aqsave\(aq, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None)
Interface to \fI\%git\-stash(1)\fP, returns the stdout from the git command
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B opts
Any additional options to add to the command line, in a single string.
Use this to complete the \fBgit stash\fP command by adding the remaining
arguments (i.e.  \fB\(aqsave <stash comment>\(aq\fP, \fB\(aqapply stash@{2}\(aq\fP,
\fB\(aqshow\(aq\fP, etc.).  Omitting this argument will simply run \fBgit
stash\fP\&.
.TP
.B git_opts
Any additional options to add to git command itself (not the \fBstash\fP
subcommand), in a single string. This is useful for passing \fB\-c\fP to
run git with temporary changes to the git configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.stash /path/to/repo save opts=\(aqwork in progress\(aq
salt myminion git.stash /path/to/repo apply opts=\(aqstash@{1}\(aq
salt myminion git.stash /path/to/repo drop opts=\(aqstash@{1}\(aq
salt myminion git.stash /path/to/repo list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.status(cwd, user=None, password=None, ignore_retcode=False, output_encoding=None)
Changed in version 2015.8.0: Return data has changed from a list of lists to a dictionary

.sp
Returns the changes to the repository
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.status /path/to/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.submodule(cwd, command, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, identity=None, ignore_retcode=False, saltenv=\(aqbase\(aq, output_encoding=None, **kwargs)
Changed in version 2015.8.0: Added the \fBcommand\fP argument to allow for operations other than
\fBupdate\fP to be run on submodules, and deprecated the \fBinit\fP
argument. To do a submodule update with \fBinit=True\fP moving forward,
use \fBcommand=update opts=\(aq\-\-init\(aq\fP

.sp
Interface to \fI\%git\-submodule(1)\fP
.INDENT 7.0
.TP
.B cwd
The path to the submodule
.TP
.B command
Submodule command to run, see \fIgit\-submodule(1) <git submodule>\fP for
more information. Any additional arguments after the command (such as
the URL when adding a submodule) must be passed in the \fBopts\fP
parameter.
.sp
New in version 2015.8.0.

.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP (as in the CLI examples
below) to avoid causing errors with Salt\(aqs own argument parsing.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the
\fBsubmodule\fP subcommand), in a single string. This is useful for
passing \fB\-c\fP to run git with temporary changes to the git
configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B init
False
If \fBTrue\fP, ensures that new submodules are initialized
.sp
Deprecated since version 2015.8.0: Pass \fBinit\fP as the \fBcommand\fP parameter, or include \fB\-\-init\fP
in the \fBopts\fP param with \fBcommand\fP set to update.

.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B identity
Path to a private key to use for ssh URLs
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Unless Salt is invoked from the minion using \fBsalt\-call\fP, the
key(s) must be passphraseless. For greater security with
passphraseless private keys, see the \fI\%sshd(8)\fP manpage for
information on securing the keypair from the remote side in the
\fBauthorized_keys\fP file.
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.7: Salt will no longer attempt to use passphrase\-protected keys unless
invoked from the minion using \fBsalt\-call\fP, to prevent blocking
waiting for user input.

.sp
Key can also be specified as a SaltStack file server URL, eg. salt://location/identity_file
.sp
Changed in version 2016.3.0.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B saltenv
The default salt environment to pull sls files from
.sp
New in version 2016.3.1.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Update submodule and ensure it is initialized (before 2015.8.0)
salt myminion git.submodule /path/to/repo/sub/repo init=True
# Update submodule and ensure it is initialized (2015.8.0 and later)
salt myminion git.submodule /path/to/repo/sub/repo update opts=\(aq\-\-init\(aq

# Rebase submodule (2015.8.0 and later)
salt myminion git.submodule /path/to/repo/sub/repo update opts=\(aq\-\-rebase\(aq

# Add submodule (2015.8.0 and later)
salt myminion git.submodule /path/to/repo/sub/repo add opts=\(aqhttps://mydomain.tld/repo.git\(aq

# Unregister submodule (2015.8.0 and later)
salt myminion git.submodule /path/to/repo/sub/repo deinit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.symbolic_ref(cwd, ref, value=None, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None)
New in version 2015.8.0.

.sp
Interface to \fI\%git\-symbolic\-ref(1)\fP
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B ref
Symbolic ref to read/modify
.TP
.B value
If passed, then the symbolic ref will be set to this value and an empty
string will be returned.
.sp
If not passed, then the ref to which \fBref\fP points will be returned,
unless \fB\-\-delete\fP is included in \fBopts\fP (in which case the symbolic
ref will be deleted).
.TP
.B opts
Any additional options to add to the command line, in a single string
.TP
.B git_opts
Any additional options to add to git command itself (not the
\fBsymbolic\-refs\fP subcommand), in a single string. This is useful for
passing \fB\-c\fP to run git with temporary changes to the git
configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Get ref to which HEAD is pointing
salt myminion git.symbolic_ref /path/to/repo HEAD
# Set/overwrite symbolic ref \(aqFOO\(aq to local branch \(aqfoo\(aq
salt myminion git.symbolic_ref /path/to/repo FOO refs/heads/foo
# Delete symbolic ref \(aqFOO\(aq
salt myminion git.symbolic_ref /path/to/repo FOO opts=\(aq\-\-delete\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.tag(cwd, name, ref=\(aqHEAD\(aq, message=None, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None)
New in version 2018.3.4.

.sp
Interface to \fI\%git\-tag(1)\fP, adds and removes tags.
.INDENT 7.0
.TP
.B cwd
The path to the main git checkout or a linked worktree
.TP
.B name
Name of the tag
.TP
.B ref
HEAD
Which ref to tag (defaults to local clone\(aqs HEAD)
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument is ignored when either \fB\-d\fP or \fB\-\-delete\fP is
present in the \fBopts\fP passed to this function.
.UNINDENT
.UNINDENT
.TP
.B message
Optional message to include with the tag. If provided, an annotated tag
will be created.
.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Additionally, on the Salt CLI, if the opts are preceded with a
dash, it is necessary to precede them with \fBopts=\fP (as in the CLI
examples below) to avoid causing errors with Salt\(aqs own argument
parsing.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the
\fBworktree\fP subcommand), in a single string. This is useful for
passing \fB\-c\fP to run git with temporary changes to the git
configuration.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Create an non\-annotated tag
salt myminion git.tag /path/to/repo v1.2
# Create an annotated tag
salt myminion git.tag /path/to/repo v1.2 message=\(aqVersion 1.2\(aq
# Delete the tag
salt myminion git.tag /path/to/repo v1.2 opts=\(aq\-d\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.version(versioninfo=False)
New in version 2015.8.0.

.sp
Returns the version of Git installed on the minion
.INDENT 7.0
.TP
.B versioninfo
False
If \fBTrue\fP, return the version in a versioninfo list (e.g. \fB[2, 5, 0]\fP)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.worktree_add(cwd, worktree_path, ref=None, reset_branch=None, force=None, detach=False, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None, **kwargs)
New in version 2015.8.0.

.sp
Interface to \fI\%git\-worktree(1)\fP, adds a worktree
.INDENT 7.0
.TP
.B cwd
The path to the git checkout
.TP
.B worktree_path
Path to the new worktree. Can be either absolute, or relative to
\fBcwd\fP\&.
.TP
.B branch
Name of new branch to create. If omitted, will be set to the basename
of the \fBworktree_path\fP\&. For example, if the \fBworktree_path\fP is
\fB/foo/bar/baz\fP, then \fBbranch\fP will be \fBbaz\fP\&.
.TP
.B ref
Name of the ref on which to base the new worktree. If omitted, then
\fBHEAD\fP is use, and a new branch will be created, named for the
basename of the \fBworktree_path\fP\&. For example, if the
\fBworktree_path\fP is \fB/foo/bar/baz\fP then a new branch \fBbaz\fP will be
created, and pointed at \fBHEAD\fP\&.
.TP
.B reset_branch
False
If \fBFalse\fP, then \fI\%git\-worktree(1)\fP will fail to create the worktree
if the targeted branch already exists. Set this argument to \fBTrue\fP to
reset the targeted branch to point at \fBref\fP, and checkout the
newly\-reset branch into the new worktree.
.TP
.B force
False
By default, \fI\%git\-worktree(1)\fP will not permit the same branch to be
checked out in more than one worktree. Set this argument to \fBTrue\fP to
override this.
.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP to avoid causing errors
with Salt\(aqs own argument parsing.
.sp
All CLI options for adding worktrees as of Git 2.5.0 are already
supported by this function as of Salt 2015.8.0, so using this
argument is unnecessary unless new CLI arguments are added to
\fI\%git\-worktree(1)\fP and are not yet supported in Salt.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the
\fBworktree\fP subcommand), in a single string. This is useful for
passing \fB\-c\fP to run git with temporary changes to the git
configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.worktree_add /path/to/repo/main ../hotfix ref=origin/master
salt myminion git.worktree_add /path/to/repo/main ../hotfix branch=hotfix21 ref=v2.1.9.3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.worktree_prune(cwd, dry_run=False, verbose=True, expire=None, opts=\(aq\(aq, git_opts=\(aq\(aq, user=None, password=None, ignore_retcode=False, output_encoding=None)
New in version 2015.8.0.

.sp
Interface to \fI\%git\-worktree(1)\fP, prunes stale worktree administrative data
from the gitdir
.INDENT 7.0
.TP
.B cwd
The path to the main git checkout or a linked worktree
.TP
.B dry_run
False
If \fBTrue\fP, then this function will report what would have been
pruned, but no changes will be made.
.TP
.B verbose
True
Report all changes made. Set to \fBFalse\fP to suppress this output.
.TP
.B expire
Only prune unused worktree data older than a specific period of time.
The date format for this parameter is described in the documentation
for the \fBgc.pruneWorktreesExpire\fP config param in the
\fI\%git\-config(1)\fP manpage.
.TP
.B opts
Any additional options to add to the command line, in a single string
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On the Salt CLI, if the opts are preceded with a dash, it is
necessary to precede them with \fBopts=\fP to avoid causing errors
with Salt\(aqs own argument parsing.
.sp
All CLI options for pruning worktrees as of Git 2.5.0 are already
supported by this function as of Salt 2015.8.0, so using this
argument is unnecessary unless new CLI arguments are added to
\fI\%git\-worktree(1)\fP and are not yet supported in Salt.
.UNINDENT
.UNINDENT
.TP
.B git_opts
Any additional options to add to git command itself (not the
\fBworktree\fP subcommand), in a single string. This is useful for
passing \fB\-c\fP to run git with temporary changes to the git
configuration.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only supported in git 1.7.2 and newer.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run the git command. By default, the command is run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B ignore_retcode
False
If \fBTrue\fP, do not log an error to the minion log if the git command
returns a nonzero exit status.
.sp
New in version 2015.8.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.worktree_prune /path/to/repo
salt myminion git.worktree_prune /path/to/repo dry_run=True
salt myminion git.worktree_prune /path/to/repo expire=1.day.ago
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.git.worktree_rm(cwd, user=None, output_encoding=None)
New in version 2015.8.0.

.sp
Recursively removes the worktree located at \fBcwd\fP, returning \fBTrue\fP if
successful. This function will attempt to determine if \fBcwd\fP is actually
a worktree by invoking \fI\%git.is_worktree\fP\&. If the path does not correspond to a
worktree, then an error will be raised and no action will be taken.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
There is no undoing this action. Be \fBVERY\fP careful before running
this function.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cwd
Path to the worktree to be removed
.TP
.B user
Used for path expansion when \fBcwd\fP is not an absolute path. By
default, when \fBcwd\fP is not absolute, the path will be assumed to be
relative to the home directory of the user under which the minion is
running. Setting this option will change the home directory from which
path expansion is performed.
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion git.worktree_rm /path/to/worktree
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.github
.sp
Module for interacting with the GitHub v3 API.
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B depends
PyGithub python module
.UNINDENT
.SS Configuration
.sp
Configure this module by specifying the name of a configuration
profile in the minion config, minion pillar, or master config. The module
will use the \(aqgithub\(aq key by default, if defined.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
github:
  token: abc1234
  org_name: my_organization

  # optional: some functions require a repo_name, which
  # can be set in the config file, or passed in at the CLI.
  repo_name: my_repo

  # optional: it can be dangerous to change the privacy of a repository
  # in an automated way. set this to True to allow privacy modifications
  allow_repo_privacy_changes: False
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.add_repo(name, description=None, homepage=None, private=None, has_issues=None, has_wiki=None, has_downloads=None, auto_init=None, gitignore_template=None, license_template=None, profile=\(aqgithub\(aq)
Create a new github repository.
.INDENT 7.0
.TP
.B name
The name of the team to be created.
.TP
.B description
The description of the repository.
.TP
.B homepage
The URL with more information about the repository.
.TP
.B private
The visiblity of the repository. Note that private repositories require
a paid GitHub account.
.TP
.B has_issues
Whether to enable issues for this repository.
.TP
.B has_wiki
Whether to enable the wiki for this repository.
.TP
.B has_downloads
Whether to enable downloads for this repository.
.TP
.B auto_init
Whether to create an initial commit with an empty README.
.TP
.B gitignore_template
The desired language or platform for a .gitignore, e.g \(dqHaskell\(dq.
.TP
.B license_template
The desired LICENSE template to apply, e.g \(dqmit\(dq or \(dqmozilla\(dq.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.add_repo \(aqrepo_name\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.add_team(name, description=None, repo_names=None, privacy=None, permission=None, profile=\(aqgithub\(aq)
Create a new Github team within an organization.
.INDENT 7.0
.TP
.B name
The name of the team to be created.
.TP
.B description
The description of the team.
.TP
.B repo_names
The names of repositories to add the team to.
.TP
.B privacy
The level of privacy for the team, can be \(aqsecret\(aq or \(aqclosed\(aq.
.TP
.B permission
The default permission for new repositories added to the team, can be
\(aqpull\(aq, \(aqpush\(aq or \(aqadmin\(aq.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.add_team \(aqteam_name\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.add_team_member(name, team_name, profile=\(aqgithub\(aq)
Adds a team member to a team with team_name.
.INDENT 7.0
.TP
.B name
The name of the team member to add.
.TP
.B team_name
The name of the team of which to add the user.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.add_team_member \(aquser_name\(aq \(aqteam_name\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.add_team_repo(repo_name, team_name, profile=\(aqgithub\(aq, permission=None)
Adds a repository to a team with team_name.
.INDENT 7.0
.TP
.B repo_name
The name of the repository to add.
.TP
.B team_name
The name of the team of which to add the repository.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.TP
.B permission
The permission for team members within the repository, can be \(aqpull\(aq,
\(aqpush\(aq or \(aqadmin\(aq. If not specified, the default permission specified on
the team will be used.
.sp
New in version 2017.7.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.add_team_repo \(aqmy_repo\(aq \(aqteam_name\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.add_user(name, profile=\(aqgithub\(aq)
Add a GitHub user.
.INDENT 7.0
.TP
.B name
The user for which to obtain information.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.add_user github\-handle
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.edit_repo(name, description=None, homepage=None, private=None, has_issues=None, has_wiki=None, has_downloads=None, profile=\(aqgithub\(aq)
Updates an existing Github repository.
.INDENT 7.0
.TP
.B name
The name of the team to be created.
.TP
.B description
The description of the repository.
.TP
.B homepage
The URL with more information about the repository.
.TP
.B private
The visiblity of the repository. Note that private repositories require
a paid GitHub account.
.TP
.B has_issues
Whether to enable issues for this repository.
.TP
.B has_wiki
Whether to enable the wiki for this repository.
.TP
.B has_downloads
Whether to enable downloads for this repository.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.add_repo \(aqrepo_name\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.edit_team(name, description=None, privacy=None, permission=None, profile=\(aqgithub\(aq)
Updates an existing Github team.
.INDENT 7.0
.TP
.B name
The name of the team to be edited.
.TP
.B description
The description of the team.
.TP
.B privacy
The level of privacy for the team, can be \(aqsecret\(aq or \(aqclosed\(aq.
.TP
.B permission
The default permission for new repositories added to the team, can be
\(aqpull\(aq, \(aqpush\(aq or \(aqadmin\(aq.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.edit_team \(aqteam_name\(aq description=\(aqTeam description\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.get_issue(issue_number, repo_name=None, profile=\(aqgithub\(aq, output=\(aqmin\(aq)
Return information about a single issue in a named repository.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B issue_number
The number of the issue to retrieve.
.TP
.B repo_name
The name of the repository from which to get the issue. This argument is
required, either passed via the CLI, or defined in the configured
profile. A \fBrepo_name\fP passed as a CLI argument will override the
repo_name defined in the configured profile, if provided.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.TP
.B output
The amount of data returned by each issue. Defaults to \fBmin\fP\&. Change
to \fBfull\fP to see all issue output.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.get_issue 514
salt myminion github.get_issue 514 repo_name=salt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.get_issue_comments(issue_number, repo_name=None, profile=\(aqgithub\(aq, since=None, output=\(aqmin\(aq)
Return information about the comments for a given issue in a named repository.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B issue_number
The number of the issue for which to retrieve comments.
.TP
.B repo_name
The name of the repository to which the issue belongs. This argument is
required, either passed via the CLI, or defined in the configured
profile. A \fBrepo_name\fP passed as a CLI argument will override the
repo_name defined in the configured profile, if provided.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.TP
.B since
Only comments updated at or after this time are returned. This is a
timestamp in ISO 8601 format: \fBYYYY\-MM\-DDTHH:MM:SSZ\fP\&.
.TP
.B output
The amount of data returned by each issue. Defaults to \fBmin\fP\&. Change
to \fBfull\fP to see all issue output.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.get_issue_comments 514
salt myminion github.get_issue 514 repo_name=salt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.get_issues(repo_name=None, profile=\(aqgithub\(aq, milestone=None, state=\(aqopen\(aq, assignee=None, creator=None, mentioned=None, labels=None, sort=\(aqcreated\(aq, direction=\(aqdesc\(aq, since=None, output=\(aqmin\(aq, per_page=None)
Returns information for all issues in a given repository, based on the search options.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B repo_name
The name of the repository for which to list issues. This argument is
required, either passed via the CLI, or defined in the configured
profile. A \fBrepo_name\fP passed as a CLI argument will override the
repo_name defined in the configured profile, if provided.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.TP
.B milestone
The number of a GitHub milestone, or a string of either \fB*\fP or
\fBnone\fP\&.
.sp
If a number is passed, it should refer to a milestone by its number
field. Use the \fBgithub.get_milestone\fP function to obtain a milestone\(aqs
number.
.sp
If the string \fB*\fP is passed, issues with any milestone are
accepted. If the string \fBnone\fP is passed, issues without milestones
are returned.
.TP
.B state
Indicates the state of the issues to return. Can be either \fBopen\fP,
\fBclosed\fP, or \fBall\fP\&. Default is \fBopen\fP\&.
.TP
.B assignee
Can be the name of a user. Pass in \fBnone\fP (as a string) for issues
with no assigned user or \fB*\fP for issues assigned to any user.
.TP
.B creator
The user that created the issue.
.TP
.B mentioned
A user that\(aqs mentioned in the issue.
.TP
.B labels
A string of comma separated label names. For example, \fBbug,ui,@high\fP\&.
.TP
.B sort
What to sort results by. Can be either \fBcreated\fP, \fBupdated\fP, or
\fBcomments\fP\&. Default is \fBcreated\fP\&.
.TP
.B direction
The direction of the sort. Can be either \fBasc\fP or \fBdesc\fP\&. Default
is \fBdesc\fP\&.
.TP
.B since
Only issues updated at or after this time are returned. This is a
timestamp in ISO 8601 format: \fBYYYY\-MM\-DDTHH:MM:SSZ\fP\&.
.TP
.B output
The amount of data returned by each issue. Defaults to \fBmin\fP\&. Change
to \fBfull\fP to see all issue output.
.TP
.B per_page
GitHub paginates data in their API calls. Use this value to increase or
decrease the number of issues gathered from GitHub, per page. If not set,
GitHub defaults are used. Maximum is 100.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.get_issues my\-github\-repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.get_milestone(number=None, name=None, repo_name=None, profile=\(aqgithub\(aq, output=\(aqmin\(aq)
Return information about a single milestone in a named repository.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B number
The number of the milestone to retrieve. If provided, this option
will be favored over \fBname\fP\&.
.TP
.B name
The name of the milestone to retrieve.
.TP
.B repo_name
The name of the repository for which to list issues. This argument is
required, either passed via the CLI, or defined in the configured
profile. A \fBrepo_name\fP passed as a CLI argument will override the
repo_name defined in the configured profile, if provided.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.TP
.B output
The amount of data returned by each issue. Defaults to \fBmin\fP\&. Change
to \fBfull\fP to see all issue output.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.get_milestone 72
salt myminion github.get_milestone name=my_milestone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.get_milestones(repo_name=None, profile=\(aqgithub\(aq, state=\(aqopen\(aq, sort=\(aqdue_on\(aq, direction=\(aqasc\(aq, output=\(aqmin\(aq, per_page=None)
Return information about milestones for a given repository.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B repo_name
The name of the repository for which to list issues. This argument is
required, either passed via the CLI, or defined in the configured
profile. A \fBrepo_name\fP passed as a CLI argument will override the
repo_name defined in the configured profile, if provided.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.TP
.B state
The state of the milestone. Either \fBopen\fP, \fBclosed\fP, or \fBall\fP\&.
Default is \fBopen\fP\&.
.TP
.B sort
What to sort results by. Either \fBdue_on\fP or \fBcompleteness\fP\&. Default
is \fBdue_on\fP\&.
.TP
.B direction
The direction of the sort. Either \fBasc\fP or \fBdesc\fP\&. Default is \fBasc\fP\&.
.TP
.B output
The amount of data returned by each issue. Defaults to \fBmin\fP\&. Change
to \fBfull\fP to see all issue output.
.TP
.B per_page
GitHub paginates data in their API calls. Use this value to increase or
decrease the number of issues gathered from GitHub, per page. If not set,
GitHub defaults are used.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.get_milestones
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.get_prs(repo_name=None, profile=\(aqgithub\(aq, state=\(aqopen\(aq, head=None, base=None, sort=\(aqcreated\(aq, direction=\(aqdesc\(aq, output=\(aqmin\(aq, per_page=None)
Returns information for all pull requests in a given repository, based on
the search options provided.
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B repo_name
The name of the repository for which to list pull requests. This
argument is required, either passed via the CLI, or defined in the
configured profile. A \fBrepo_name\fP passed as a CLI argument will
override the \fBrepo_name\fP defined in the configured profile, if
provided.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.TP
.B state
Indicates the state of the pull requests to return. Can be either
\fBopen\fP, \fBclosed\fP, or \fBall\fP\&. Default is \fBopen\fP\&.
.TP
.B head
Filter pull requests by head user and branch name in the format of
\fBuser:ref\-name\fP\&. Example: \fB\(aqgithub:new\-script\-format\(aq\fP\&. Default
is \fBNone\fP\&.
.TP
.B base
Filter pulls by base branch name. Example: \fBgh\-pages\fP\&. Default is
\fBNone\fP\&.
.TP
.B sort
What to sort results by. Can be either \fBcreated\fP, \fBupdated\fP,
\fBpopularity\fP (comment count), or \fBlong\-running\fP (age, filtering
by pull requests updated within the last month). Default is \fBcreated\fP\&.
.TP
.B direction
The direction of the sort. Can be either \fBasc\fP or \fBdesc\fP\&. Default
is \fBdesc\fP\&.
.TP
.B output
The amount of data returned by each pull request. Defaults to \fBmin\fP\&.
Change to \fBfull\fP to see all pull request output.
.TP
.B per_page
GitHub paginates data in their API calls. Use this value to increase or
decrease the number of pull requests gathered from GitHub, per page. If
not set, GitHub defaults are used. Maximum is 100.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.get_prs
salt myminion github.get_prs base=2016.11
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.get_repo_info(repo_name, profile=\(aqgithub\(aq, ignore_cache=False)
Return information for a given repo.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B repo_name
The name of the repository.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.get_repo_info salt
salt myminion github.get_repo_info salt profile=\(aqmy\-github\-profile\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.get_repo_teams(repo_name, profile=\(aqgithub\(aq)
Return teams belonging to a repository.
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B repo_name
The name of the repository from which to retrieve teams.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.get_repo_teams salt
salt myminion github.get_repo_teams salt profile=\(aqmy\-github\-profile\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.get_team(name, profile=\(aqgithub\(aq)
Returns the team details if a team with the given name exists, or None
otherwise.
.INDENT 7.0
.TP
.B name
The team name for which to obtain information.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.get_team \(aqteam_name\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.get_user(name, profile=\(aqgithub\(aq, user_details=False)
Get a GitHub user by name.
.INDENT 7.0
.TP
.B name
The user for which to obtain information.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.TP
.B user_details
Prints user information details. Defaults to \fBFalse\fP\&. If the user is
already in the organization and user_details is set to False, the
get_user function returns \fBTrue\fP\&. If the user is not already present
in the organization, user details will be printed by default.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.get_user github\-handle
salt myminion github.get_user github\-handle user_details=true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.is_team_member(name, team_name, profile=\(aqgithub\(aq)
Returns True if the github user is in the team with team_name, or False
otherwise.
.INDENT 7.0
.TP
.B name
The name of the user whose membership to check.
.TP
.B team_name
The name of the team to check membership in.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.is_team_member \(aquser_name\(aq \(aqteam_name\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.list_members_without_mfa(profile=\(aqgithub\(aq, ignore_cache=False)
List all members (in lower case) without MFA turned on.
.INDENT 7.0
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.TP
.B ignore_cache
Bypasses the use of cached team repos.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.list_members_without_mfa
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.list_private_repos(profile=\(aqgithub\(aq)
List private repositories within the organization. Dependent upon the access
rights of the profile token.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.list_private_repos
salt myminion github.list_private_repos profile=\(aqmy\-github\-profile\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.list_public_repos(profile=\(aqgithub\(aq)
List public repositories within the organization.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.list_public_repos
salt myminion github.list_public_repos profile=\(aqmy\-github\-profile\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.list_repos(profile=\(aqgithub\(aq)
List all repositories within the organization. Includes public and private
repositories within the organization Dependent upon the access rights of
the profile token.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.list_repos
salt myminion github.list_repos profile=\(aqmy\-github\-profile\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.list_team_members(team_name, profile=\(aqgithub\(aq, ignore_cache=False)
Gets the names of team members in lower case.
.INDENT 7.0
.TP
.B team_name
The name of the team from which to list members.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.TP
.B ignore_cache
Bypasses the use of cached team members.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.list_team_members \(aqteam_name\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.list_team_repos(team_name, profile=\(aqgithub\(aq, ignore_cache=False)
Gets the repo details for a given team as a dict from repo_name to repo details.
Note that repo names are always in lower case.
.INDENT 7.0
.TP
.B team_name
The name of the team from which to list repos.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.TP
.B ignore_cache
Bypasses the use of cached team repos.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.list_team_repos \(aqteam_name\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.list_teams(profile=\(aqgithub\(aq, ignore_cache=False)
Lists all teams with the organization.
.INDENT 7.0
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.TP
.B ignore_cache
Bypasses the use of cached teams.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.list_teams
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.list_users(profile=\(aqgithub\(aq, ignore_cache=False)
List all users within the organization.
.INDENT 7.0
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.TP
.B ignore_cache
Bypasses the use of cached users.
.sp
New in version 2016.11.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.list_users
salt myminion github.list_users profile=\(aqmy\-github\-profile\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.remove_repo(name, profile=\(aqgithub\(aq)
Remove a Github repository.
.INDENT 7.0
.TP
.B name
The name of the repository to be removed.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.remove_repo \(aqmy\-repo\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.remove_team(name, profile=\(aqgithub\(aq)
Remove a github team.
.INDENT 7.0
.TP
.B name
The name of the team to be removed.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.remove_team \(aqteam_name\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.remove_team_member(name, team_name, profile=\(aqgithub\(aq)
Removes a team member from a team with team_name.
.INDENT 7.0
.TP
.B name
The name of the team member to remove.
.TP
.B team_name
The name of the team from which to remove the user.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.remove_team_member \(aquser_name\(aq \(aqteam_name\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.remove_team_repo(repo_name, team_name, profile=\(aqgithub\(aq)
Removes a repository from a team with team_name.
.INDENT 7.0
.TP
.B repo_name
The name of the repository to remove.
.TP
.B team_name
The name of the team of which to remove the repository.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.remove_team_repo \(aqmy_repo\(aq \(aqteam_name\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.github.remove_user(name, profile=\(aqgithub\(aq)
Remove a Github user by name.
.INDENT 7.0
.TP
.B name
The user for which to obtain information.
.TP
.B profile
The name of the profile configuration to use. Defaults to \fBgithub\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion github.remove_user github\-handle
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.glanceng
.sp
Glance module for interacting with OpenStack Glance
.sp
New in version 2018.3.0.

.sp
:depends:shade
.sp
Example configuration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
glance:
  cloud: default
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
glance:
  auth:
    username: admin
    password: password123
    user_domain_name: mydomain
    project_name: myproject
    project_domain_name: myproject
    auth_url: https://example.org:5000/v3
  identity_api_version: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glanceng.compare_changes(obj, **kwargs)
Compare two dicts returning only keys that exist in the first dict and are
different in the second one
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glanceng.get_openstack_cloud(auth=None)
Return an openstack_cloud
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glanceng.get_operator_cloud(auth=None)
Return an operator_cloud
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glanceng.image_create(auth=None, **kwargs)
Create an image
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glanceng.image_create name=cirros file=cirros.raw disk_format=raw
salt \(aq*\(aq glanceng.image_create name=cirros file=cirros.raw disk_format=raw hw_scsi_model=virtio\-scsi hw_disk_bus=scsi
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glanceng.image_delete(auth=None, **kwargs)
Delete an image
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glanceng.image_delete name=image1
salt \(aq*\(aq glanceng.image_delete name=0e4febc2a5ab4f2c8f374b054162506d
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glanceng.image_get(auth=None, **kwargs)
Get a single image
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glanceng.image_get name=image1
salt \(aq*\(aq glanceng.image_get name=0e4febc2a5ab4f2c8f374b054162506d
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glanceng.image_list(auth=None, **kwargs)
List images
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glanceng.image_list
salt \(aq*\(aq glanceng.image_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glanceng.image_search(auth=None, **kwargs)
Search for images
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glanceng.image_search name=image1
salt \(aq*\(aq glanceng.image_search
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glanceng.setup_clouds(auth=None)
Call functions to create Shade cloud objects in __context__ to take
advantage of Shade\(aqs in\-memory caching across several states
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glanceng.update_image_properties(auth=None, **kwargs)
Update properties for an image
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glanceng.update_image_properties name=image1 hw_scsi_model=virtio\-scsi hw_disk_bus=scsi
salt \(aq*\(aq glanceng.update_image_properties name=0e4febc2a5ab4f2c8f374b054162506d min_ram=1024
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.glassfish
.sp
Module for working with the Glassfish/Payara 4.x management API
\&.. versionadded:: 2016.11.0
:depends: requests
.INDENT 0.0
.TP
.B salt.modules.glassfish.create_admin_object_resource(name, server=None, **kwargs)
Create a JMS destination
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.create_connector_c_pool(name, server=None, **kwargs)
Create a connection pool
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.create_connector_resource(name, server=None, **kwargs)
Create a connection resource
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.create_jdbc_connection_pool(name, server=None, **kwargs)
Create a connection resource
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.create_jdbc_resource(name, server=None, **kwargs)
Create a JDBC resource
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.delete_admin_object_resource(name, target=\(aqserver\(aq, server=None)
Delete a JMS destination
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.delete_connector_c_pool(name, target=\(aqserver\(aq, cascade=True, server=None)
Delete a connection pool
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.delete_connector_resource(name, target=\(aqserver\(aq, server=None)
Delete a connection resource
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.delete_jdbc_connection_pool(name, target=\(aqserver\(aq, cascade=False, server=None)
Delete a JDBC pool
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.delete_jdbc_resource(name, target=\(aqserver\(aq, server=None)
Delete a JDBC resource
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.delete_system_properties(name, server=None)
Delete a system property
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.enum_admin_object_resource(server=None)
Enum JMS destinations
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.enum_connector_c_pool(server=None)
Enum connection pools
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.enum_connector_resource(server=None)
Enum connection resources
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.enum_jdbc_connection_pool(server=None)
Enum JDBC pools
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.enum_jdbc_resource(server=None)
Enum JDBC resources
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.get_admin_object_resource(name, server=None)
Get a specific JMS destination
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.get_connector_c_pool(name, server=None)
Get a specific connection pool
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.get_connector_resource(name, server=None)
Get a specific connection resource
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.get_jdbc_connection_pool(name, server=None)
Get a specific JDBC pool
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.get_jdbc_resource(name, server=None)
Get a specific JDBC resource
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.get_system_properties(server=None)
Get system properties
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.update_admin_object_resource(name, server=None, **kwargs)
Update a JMS destination
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.update_connector_c_pool(name, server=None, **kwargs)
Update a connection pool
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.update_connector_resource(name, server=None, **kwargs)
Update a connection resource
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.update_jdbc_connection_pool(name, server=None, **kwargs)
Update a JDBC pool
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.update_jdbc_resource(name, server=None, **kwargs)
Update a JDBC resource
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glassfish.update_system_properties(data, server=None)
Update system properties
.UNINDENT
.SS salt.modules.glusterfs
.sp
Manage a glusterfs pool
.INDENT 0.0
.TP
.B salt.modules.glusterfs.add_volume_bricks(name, bricks)
Add brick(s) to an existing volume
.INDENT 7.0
.TP
.B name
Volume name
.TP
.B bricks
List of bricks to add to the volume
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.add_volume_bricks <volume> <bricks>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.create_volume(name, bricks, stripe=False, replica=False, device_vg=False, transport=\(aqtcp\(aq, start=False, force=False, arbiter=False)
Create a glusterfs volume
.INDENT 7.0
.TP
.B name
Name of the gluster volume
.TP
.B bricks
Bricks to create volume from, in <peer>:<brick path> format. For         multiple bricks use list format: \(aq[\(dq<peer1>:<brick1>\(dq,         \(dq<peer2>:<brick2>\(dq]\(aq
.TP
.B stripe
Stripe count, the number of bricks should be a multiple of the stripe         count for a distributed striped volume
.TP
.B replica
Replica count, the number of bricks should be a multiple of the         replica count for a distributed replicated volume
.TP
.B arbiter
If true, specifies volume should use arbiter brick(s).         Valid configuration limited to \(dqreplica 3 arbiter 1\(dq per         Gluster documentation. Every third brick in the brick list         is used as an arbiter brick.
.sp
New in version 2019.2.0.

.TP
.B device_vg
If true, specifies volume should use block backend instead of regular         posix backend. Block device backend volume does not support multiple         bricks
.TP
.B transport
Transport protocol to use, can be \(aqtcp\(aq, \(aqrdma\(aq or \(aqtcp,rdma\(aq
.TP
.B start
Start the volume after creation
.TP
.B force
Force volume creation, this works even if creating in root FS
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt host1 glusterfs.create newvolume host1:/brick

salt gluster1 glusterfs.create vol2 \(aq[\(dqgluster1:/export/vol2/brick\(dq,         \(dqgluster2:/export/vol2/brick\(dq]\(aq replica=2 start=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.delete_volume(target, stop=True)
Deletes a gluster volume
.INDENT 7.0
.TP
.B target
Volume to delete
.TP
.B stop
True
If \fBTrue\fP, stop volume before delete
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.delete_volume <volume>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.disable_quota_volume(name)
Disable quota on a glusterfs volume.
.INDENT 7.0
.TP
.B name
Name of the gluster volume
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.disable_quota_volume <volume>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.enable_quota_volume(name)
Enable quota on a glusterfs volume.
.INDENT 7.0
.TP
.B name
Name of the gluster volume
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.enable_quota_volume <volume>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.get_max_op_version()
New in version 2019.2.0.

.sp
Returns the glusterfs volume\(aqs max op\-version value
Requires Glusterfs version > 3.9
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.get_max_op_version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.get_op_version(name)
New in version 2019.2.0.

.sp
Returns the glusterfs volume op\-version
.INDENT 7.0
.TP
.B name
Name of the glusterfs volume
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.get_op_version <volume>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.get_version()
New in version 2019.2.0.

.sp
Returns the version of glusterfs.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.get_version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.info(name=None)
New in version 2015.8.4.

.sp
Return gluster volume info.
.INDENT 7.0
.TP
.B name
Optional name to retrieve only information of one volume
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.list_quota_volume(name)
List quotas of glusterfs volume
.INDENT 7.0
.TP
.B name
Name of the gluster volume
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.list_quota_volume <volume>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.list_volumes()
List configured volumes
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.list_volumes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.peer(name)
Add another node into the peer list.
.INDENT 7.0
.TP
.B name
The remote host to probe.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqone.gluster.*\(aq glusterfs.peer two
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
GLUSTER direct CLI example (to show what salt is sending to gluster):
.INDENT 7.0
.INDENT 3.5
$ gluster peer probe ftp2
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B GLUSTER CLI 3.4.4 return example (so we know what we are parsing):
#if the \(dqpeer\(dq is the local host:
peer probe: success: on localhost not needed
.sp
#if the peer was just added:
peer probe: success
.sp
#if the peer was already part of the cluster:
peer probe: success: host ftp2 port 24007 already in peer list
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.peer_status()
Return peer status information
.sp
The return value is a dictionary with peer UUIDs as keys and dicts of peer
information as values. Hostnames are listed in one list. GlusterFS separates
one of the hostnames but the only reason for this seems to be which hostname
happens to be used first in peering.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.peer_status
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
GLUSTER direct CLI example (to show what salt is sending to gluster):
.INDENT 7.0
.INDENT 3.5
$ gluster peer status
.UNINDENT
.UNINDENT
.sp
GLUSTER CLI 3.4.4 return example (so we know what we are parsing):
.INDENT 7.0
.INDENT 3.5
Number of Peers: 2
.sp
Hostname: ftp2
Port: 24007
Uuid: cbcb256b\-e66e\-4ec7\-a718\-21082d396c24
State: Peer in Cluster (Connected)
.sp
Hostname: ftp3
Uuid: 5ea10457\-6cb2\-427b\-a770\-7897509625e9
State: Peer in Cluster (Connected)
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.set_op_version(version)
New in version 2019.2.0.

.sp
Set the glusterfs volume op\-version
.INDENT 7.0
.TP
.B version
Version to set the glusterfs volume op\-version
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.set_op_version <volume>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.set_quota_volume(name, path, size, enable_quota=False)
Set quota to glusterfs volume.
.INDENT 7.0
.TP
.B name
Name of the gluster volume
.TP
.B path
Folder path for restriction in volume (\(dq/\(dq)
.TP
.B size
Hard\-limit size of the volume (MB/GB)
.TP
.B enable_quota
Enable quota before set up restriction
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.set_quota_volume <volume> <path> <size> enable_quota=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.start_volume(name, force=False)
Start a gluster volume
.INDENT 7.0
.TP
.B name
Volume name
.TP
.B force
Force the volume start even if the volume is started
\&.. versionadded:: 2015.8.4
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.start mycluster
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.status(name)
Check the status of a gluster volume.
.INDENT 7.0
.TP
.B name
Volume name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.status myvolume
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.stop_volume(name, force=False)
Stop a gluster volume
.INDENT 7.0
.TP
.B name
Volume name
.TP
.B force
Force stop the volume
.sp
New in version 2015.8.4.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.stop_volume mycluster
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.glusterfs.unset_quota_volume(name, path)
Unset quota on glusterfs volume
.INDENT 7.0
.TP
.B name
Name of the gluster volume
.TP
.B path
Folder path for restriction in volume
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq glusterfs.unset_quota_volume <volume> <path>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.gnomedesktop
.sp
GNOME implementations
.INDENT 0.0
.TP
.B salt.modules.gnomedesktop.get(schema=None, key=None, user=None, **kwargs)
Get key in a particular GNOME schema
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gnome.get user=<username> schema=org.gnome.desktop.screensaver key=idle\-activation\-enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gnomedesktop.getClockFormat(**kwargs)
Return the current clock format, either 12h or 24h format.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gnome.getClockFormat user=<username>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gnomedesktop.getClockShowDate(**kwargs)
Return the current setting, if the date is shown in the clock
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gnome.getClockShowDate user=<username>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gnomedesktop.getIdleActivation(**kwargs)
Get whether the idle activation is enabled
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gnome.getIdleActivation user=<username>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gnomedesktop.getIdleDelay(**kwargs)
Return the current idle delay setting in seconds
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gnome.getIdleDelay user=<username>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gnomedesktop.ping(**kwargs)
A test to ensure the GNOME module is loaded
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gnome.ping user=<username>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gnomedesktop.setClockFormat(clockFormat, **kwargs)
Set the clock format, either 12h or 24h format.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gnome.setClockFormat <12h|24h> user=<username>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gnomedesktop.setClockShowDate(kvalue, **kwargs)
Set whether the date is visible in the clock
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gnome.setClockShowDate <True|False> user=<username>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gnomedesktop.setIdleActivation(kvalue, **kwargs)
Set whether the idle activation is enabled
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gnome.setIdleActivation <True|False> user=<username>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gnomedesktop.setIdleDelay(delaySeconds, **kwargs)
Set the current idle delay setting in seconds
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gnome.setIdleDelay <seconds> user=<username>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gnomedesktop.set_(schema=None, key=None, user=None, value=None, **kwargs)
Set key in a particular GNOME schema
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gnome.set user=<username> schema=org.gnome.desktop.screensaver key=idle\-activation\-enabled value=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.google_chat
.sp
Module for sending messages to google chat.
.sp
New in version 2019.2.0.

.sp
To use this module you need to configure a webhook in the google chat room
where you would like the message to be sent, see:
.INDENT 0.0
.INDENT 3.5
\fI\%https://developers.google.com/hangouts/chat/how\-tos/webhooks\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.google_chat.send_message(url, message)
Send a message to the google chat room specified in the webhook url.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq google_chat.send_message \(dqhttps://chat.googleapis.com/v1/spaces/example_space/messages?key=example_key\(dq \(dqThis is a test message\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.gpg
.sp
Manage GPG keychains, add keys, create keys, retrieve keys from keyservers.
Sign, encrypt, sign plus encrypt and verify text and files.
.sp
New in version 2015.5.0.

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBpython\-gnupg\fP library and \fBgpg\fP binary are required to be
installed.
Be aware that the alternate \fBgnupg\fP and \fBpretty\-bad\-protocol\fP
libraries are not supported.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.gpg.FixedVerify(gpg)
This is a workaround for \fI\%https://github.com/vsajip/python\-gnupg/issues/214\fP\&.
It ensures invalid or otherwise unverified signatures are not
merged into sig_info in any way.
.sp
\fI\%https://github.com/vsajip/python\-gnupg/commit/ee94a7ecc1a86484c9f02337e2bbdd05fd32b383\fP
.INDENT 7.0
.TP
.B handle_status(key, value)
Handle status messages from the \fIgpg\fP child process. These are lines of the format
.INDENT 7.0
.INDENT 3.5
[GNUPG:] <key> <value>
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- Identifies what the status message is.
.IP \(bu 2
\fBvalue\fP (\fI\%str\fP) \-\- Identifies additional data, which differs depending on the key.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gpg.create_key(key_type=\(aqRSA\(aq, key_length=1024, name_real=\(aqAutogenerated Key\(aq, name_comment=\(aqGenerated by SaltStack\(aq, name_email=None, subkey_type=None, subkey_length=None, expire_date=None, use_passphrase=False, user=None, gnupghome=None, keyring=None)
Create a key in the GPG keychain
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
GPG key generation requires \fIa lot\fP of entropy and randomness.
Difficult to do over a remote connection, consider having
another process available which is generating randomness for
the machine. Also especially difficult on virtual machines,
consider the \fI\%rng\-tools\fP
package.
.sp
The create_key process takes awhile so increasing the timeout
may be necessary, e.g. \-t 15.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B key_type
The type of the primary key to generate. It must be capable of signing.
\(aqRSA\(aq or \(aqDSA\(aq.
.TP
.B key_length
The length of the primary key in bits.
.TP
.B name_real
The real name of the user identity which is represented by the key.
.TP
.B name_comment
A comment to attach to the user id.
.TP
.B name_email
An email address for the user.
.TP
.B subkey_type
The type of the secondary key to generate.
.TP
.B subkey_length
The length of the secondary key in bits.
.TP
.B expire_date
The expiration date for the primary and any secondary key.
You can specify an ISO date, A number of days/weeks/months/years,
an epoch value, or 0 for a non\-expiring key.
.TP
.B use_passphrase
Whether to use a passphrase with the signing key. The passphrase is
retrieved from the Pillar key \fBgpg_passphrase\fP\&.
.TP
.B user
Which user\(aqs keychain to access, defaults to user Salt is running as.
Passing the user as \fBsalt\fP will set the GnuPG home directory to
\fB/etc/salt/gpgkeys\fP\&.
.TP
.B gnupghome
Specify the location where the GPG keyring and related files are stored.
.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-t 15 \(aq*\(aq gpg.create_key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gpg.decrypt(user=None, text=None, filename=None, output=None, use_passphrase=False, gnupghome=None, bare=False, keyring=None)
Decrypt a message or a file
.INDENT 7.0
.TP
.B user
Which user\(aqs keychain to access, defaults to user Salt is running as.
Passing the user as \fBsalt\fP will set the GnuPG home directory to
\fB/etc/salt/gpgkeys\fP\&.
.TP
.B text
The encrypted text to decrypt.
.TP
.B filename
The path of the encrypted file to decrypt.
.TP
.B output
Instead of printing to standard out, write the output to this path.
.TP
.B use_passphrase
Whether to use a passphrase with the signing key. The passphrase is retrieved
from Pillar value \fBgpg_passphrase\fP\&.
.TP
.B gnupghome
Specify the location where the GPG keyring and related files are stored.
.TP
.B bare
If \fBTrue\fP, return the (armored) decrypted block as a string without the
standard comment/res dict.
.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gpg.decrypt filename=\(aq/path/to/important.file.gpg\(aq

salt \(aq*\(aq gpg.decrypt filename=\(aq/path/to/important.file.gpg\(aq use_passphrase=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gpg.delete_key(keyid=None, fingerprint=None, delete_secret=False, user=None, gnupghome=None, use_passphrase=True, keyring=None)
Delete a key from the GPG keychain.
.INDENT 7.0
.TP
.B keyid
The keyid of the key to be deleted.
.TP
.B fingerprint
The fingerprint of the key to be deleted.
.TP
.B delete_secret
Whether to delete a corresponding secret key prior to deleting the public key.
Secret keys must be deleted before deleting any corresponding public keys.
.TP
.B user
Which user\(aqs keychain to access, defaults to user Salt is running as.
Passing the user as \fBsalt\fP will set the GnuPG home directory to
\fB/etc/salt/gpgkeys\fP\&.
.TP
.B gnupghome
Specify the location where the GPG keyring and related files are stored.
.TP
.B use_passphrase
Whether to use a passphrase with the signing key. The passphrase is retrieved
from the Pillar key \fBgpg_passphrase\fP\&. Note that this defaults to True here,
contrary to the rest of the module functions that provide this parameter.
.sp
New in version 3003.

.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gpg.delete_key keyid=3FAD9F1E

salt \(aq*\(aq gpg.delete_key fingerprint=53C96788253E58416D20BCD352952C84C3252192

salt \(aq*\(aq gpg.delete_key keyid=3FAD9F1E user=username

salt \(aq*\(aq gpg.delete_key keyid=3FAD9F1E user=username delete_secret=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gpg.encrypt(user=None, recipients=None, text=None, filename=None, output=None, sign=None, use_passphrase=False, always_trust=False, gnupghome=None, bare=False, keyring=None)
Encrypt a message or a file
.INDENT 7.0
.TP
.B user
Which user\(aqs keychain to access, defaults to user Salt is running as.
Passing the user as \fBsalt\fP will set the GnuPG home directory to
\fB/etc/salt/gpgkeys\fP\&.
.TP
.B recipients
The key ID, fingerprint, user ID or email address associated with the recipients
key can be used.
.TP
.B text
The text to encrypt.
.TP
.B filename
The path of the file to encrypt.
.TP
.B output
Instead of printing to standard out, write the output to this path.
.TP
.B sign
Whether to sign, in addition to encrypt, the data. \fBTrue\fP to use
default key or fingerprint to specify a different key to sign with.
.TP
.B use_passphrase
Whether to use a passphrase with the signing key.
The passphrase is retrieved from the Pillar key \fBgpg_passphrase\fP\&.
.TP
.B always_trust
Skip key validation and assume that used keys are fully trusted.
.sp
New in version 3006.0.

.TP
.B gnupghome
Specify the location where the GPG keyring and related files are stored.
.TP
.B bare
If \fBTrue\fP, return the (armored) encrypted block as a string without
the standard comment/res dict.
.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gpg.encrypt text=\(aqHello there.  How are you?\(aq recipients=recipient@example.com

salt \(aq*\(aq gpg.encrypt filename=\(aq/path/to/important.file\(aq recipients=recipient@example.com

salt \(aq*\(aq gpg.encrypt filename=\(aq/path/to/important.file\(aq sign=True use_passphrase=True \e
                     recipients=recipient@example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gpg.export_key(keyids=None, secret=False, user=None, gnupghome=None, use_passphrase=False, output=None, bare=False, keyring=None)
Export a key from the GPG keychain
.INDENT 7.0
.TP
.B keyids
The key ID(s) of the key(s) to be exported. Can be specified as a comma
separated string or a list. Anything which GnuPG itself accepts to identify a key
for example, the key ID, fingerprint, user ID or email address could be used.
.TP
.B secret
Export the secret key identified by the \fBkeyids\fP information passed.
.TP
.B user
Which user\(aqs keychain to access, defaults to user Salt is running as.
Passing the user as \fBsalt\fP will set the GnuPG home directory to
\fB/etc/salt/gpgkeys\fP\&.
.TP
.B gnupghome
Specify the location where the GPG keyring and related files are stored.
.TP
.B use_passphrase
Whether to use a passphrase to export the secret key.
The passphrase is retrieved from the Pillar key \fBgpg_passphrase\fP\&.
.sp
New in version 3003.

.TP
.B output
Instead of printing to standard out, write the output to this path.
.sp
New in version 3006.0.

.TP
.B bare
If \fBTrue\fP, return the (armored) exported key block as a string without the
standard comment/res dict.
.sp
New in version 3006.0.

.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gpg.export_key keyids=3FAD9F1E

salt \(aq*\(aq gpg.export_key keyids=3FAD9F1E secret=True

salt \(aq*\(aq gpg.export_key keyids=\(dq[\(aq3FAD9F1E\(aq,\(aq3FBD8F1E\(aq]\(dq user=username
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gpg.get_key(keyid=None, fingerprint=None, user=None, gnupghome=None, keyring=None)
Get a key from the GPG keychain
.INDENT 7.0
.TP
.B keyid
The key ID (short or long) of the key to be retrieved.
.TP
.B fingerprint
The fingerprint of the key to be retrieved.
.TP
.B user
Which user\(aqs keychain to access, defaults to user Salt is running as.
Passing the user as \fBsalt\fP will set the GnuPG home directory to
\fB/etc/salt/gpgkeys\fP\&.
.TP
.B gnupghome
Specify the location where the GPG keyring and related files are stored.
.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gpg.get_key keyid=3FAD9F1E

salt \(aq*\(aq gpg.get_key fingerprint=53C96788253E58416D20BCD352952C84C3252192

salt \(aq*\(aq gpg.get_key keyid=3FAD9F1E user=username
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gpg.get_secret_key(keyid=None, fingerprint=None, user=None, gnupghome=None, keyring=None)
Get a secret key from the GPG keychain
.INDENT 7.0
.TP
.B keyid
The key ID (short or long) of the key to be retrieved.
.TP
.B fingerprint
The fingerprint of the key to be retrieved.
.TP
.B user
Which user\(aqs keychain to access, defaults to user Salt is running as.
Passing the user as \fBsalt\fP will set the GnuPG home directory to
\fB/etc/salt/gpgkeys\fP\&.
.TP
.B gnupghome
Specify the location where the GPG keyring and related files are stored.
.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gpg.get_secret_key keyid=3FAD9F1E

salt \(aq*\(aq gpg.get_secret_key fingerprint=53C96788253E58416D20BCD352952C84C3252192

salt \(aq*\(aq gpg.get_secret_key keyid=3FAD9F1E user=username
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gpg.import_key(text=None, filename=None, user=None, gnupghome=None, keyring=None)
Import a key from text or a file
.INDENT 7.0
.TP
.B text
The text containing the key to import.
.TP
.B filename
The path of the file containing the key to import.
.TP
.B user
Which user\(aqs keychain to access, defaults to user Salt is running as.
Passing the user as \fBsalt\fP will set the GnuPG home directory to
\fB/etc/salt/gpgkeys\fP\&.
.TP
.B gnupghome
Specify the location where the GPG keyring and related files are stored.
.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gpg.import_key text=\(aq\-\-\-\-\-BEGIN PGP PUBLIC KEY BLOCK\-\-\-\-\-\en ... \-\-\-\-\-END PGP PUBLIC KEY BLOCK\-\-\-\-\-\(aq
salt \(aq*\(aq gpg.import_key filename=\(aq/path/to/public\-key\-file\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gpg.list_keys(user=None, gnupghome=None, keyring=None)
List keys in GPG keychain
.INDENT 7.0
.TP
.B user
Which user\(aqs keychain to access, defaults to user Salt is running as.
Passing the user as \fBsalt\fP will set the GnuPG home directory to
\fB/etc/salt/gpgkeys\fP\&.
.TP
.B gnupghome
Specify the location where the GPG keyring and related files are stored.
.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gpg.list_keys
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gpg.list_secret_keys(user=None, gnupghome=None, keyring=None)
List secret keys in GPG keychain
.INDENT 7.0
.TP
.B user
Which user\(aqs keychain to access, defaults to user Salt is running as.
Passing the user as \fBsalt\fP will set the GnuPG home directory to
\fB/etc/salt/gpgkeys\fP\&.
.TP
.B gnupghome
Specify the location where the GPG keyring and related files are stored.
.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gpg.list_secret_keys
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gpg.receive_keys(keyserver=None, keys=None, user=None, gnupghome=None, keyring=None)
Receive key(s) from keyserver and add them to the keychain
.INDENT 7.0
.TP
.B keyserver
Keyserver to use for searching for GPG keys, defaults to keys.openpgp.org
.TP
.B keys
The keyID(s) to retrieve from the keyserver. Can be specified as a comma
separated string or a list.
.TP
.B user
Which user\(aqs keychain to access, defaults to user Salt is running as.
Passing the user as \fBsalt\fP will set the GnuPG home directory to
\fB/etc/salt/gpgkeys\fP\&.
.TP
.B gnupghome
Specify the location where the GPG keyring and related files are stored.
.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gpg.receive_keys keys=\(aq3FAD9F1E\(aq

salt \(aq*\(aq gpg.receive_keys keys=\(dq[\(aq3FAD9F1E\(aq,\(aq3FBD9F2E\(aq]\(dq

salt \(aq*\(aq gpg.receive_keys keys=3FAD9F1E user=username
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gpg.search_keys(text, keyserver=None, user=None, gnupghome=None)
Search for keys on a keyserver
.INDENT 7.0
.TP
.B text
Text to search the keyserver for, e.g. email address, keyID or fingerprint.
.TP
.B keyserver
Keyserver to use for searching for GPG keys, defaults to keys.openpgp.org.
.TP
.B user
Which user\(aqs keychain to access, defaults to user Salt is running as.
Passing the user as \fBsalt\fP will set the GnuPG home directory to
\fB/etc/salt/gpgkeys\fP\&.
.TP
.B gnupghome
Specify the location where the GPG keyring and related files are stored.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gpg.search_keys user@example.com

salt \(aq*\(aq gpg.search_keys user@example.com keyserver=keyserver.ubuntu.com

salt \(aq*\(aq gpg.search_keys user@example.com keyserver=keyserver.ubuntu.com user=username
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gpg.sign(user=None, keyid=None, text=None, filename=None, output=None, use_passphrase=False, gnupghome=None, keyring=None)
Sign a message or a file
.INDENT 7.0
.TP
.B user
Which user\(aqs keychain to access, defaults to user Salt is running as.
Passing the user as \fBsalt\fP will set the GnuPG home directory to
\fB/etc/salt/gpgkeys\fP\&.
.TP
.B keyid
The keyid of the key to use for signing, defaults to the
first key in the secret keyring.
.TP
.B text
The text to sign.
.TP
.B filename
The path of the file to sign.
.TP
.B output
Instead of printing to standard out, write the output to this path.
.TP
.B use_passphrase
Whether to use a passphrase with the signing key. The passphrase is
retrieved from the Pillar key \fBgpg_passphrase\fP\&.
.TP
.B gnupghome
Specify the location where the GPG keyring and related files are stored.
.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gpg.sign text=\(aqHello there.  How are you?\(aq

salt \(aq*\(aq gpg.sign filename=\(aq/path/to/important.file\(aq

salt \(aq*\(aq gpg.sign filename=\(aq/path/to/important.file\(aq use_passphrase=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gpg.trust_key(keyid=None, fingerprint=None, trust_level=None, user=None, gnupghome=None, keyring=None)
Set the trust level for a key in the GPG keychain
.INDENT 7.0
.TP
.B keyid
The keyid of the key to set the trust level for.
.TP
.B fingerprint
The fingerprint of the key to set the trust level for.
.TP
.B trust_level
The trust level to set for the specified key, must be one
of the following:
expired, unknown, not_trusted, marginally, fully, ultimately
.TP
.B user
Which user\(aqs keychain to access, defaults to user Salt is running as.
Passing the user as \fBsalt\fP will set the GnuPG home directory to
\fB/etc/salt/gpgkeys\fP\&.
.TP
.B gnupghome
Specify the location where the GPG keyring and related files are stored.
.sp
New in version 3007.0.

.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gpg.trust_key keyid=\(aq3FAD9F1E\(aq trust_level=\(aqmarginally\(aq
salt \(aq*\(aq gpg.trust_key fingerprint=\(aq53C96788253E58416D20BCD352952C84C3252192\(aq trust_level=\(aqnot_trusted\(aq
salt \(aq*\(aq gpg.trust_key keys=3FAD9F1E trust_level=\(aqultimately\(aq user=\(aqusername\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.gpg.verify(text=None, user=None, filename=None, gnupghome=None, signature=None, trustmodel=None, signed_by_any=None, signed_by_all=None, keyring=None)
Verify a message or a file
.INDENT 7.0
.TP
.B text
The text to verify.
.TP
.B filename
The path of the file to verify.
.TP
.B user
Which user\(aqs keychain to access, defaults to user Salt is running as.
Passing the user as \fBsalt\fP will set the GnuPG home directory to
\fB/etc/salt/gpgkeys\fP\&.
.TP
.B gnupghome
Specify the location where the GPG keyring and related files are stored.
.TP
.B signature
Specify the path of a detached signature.
.sp
New in version 2018.3.0.

.TP
.B trustmodel
.INDENT 7.0
.TP
.B Explicitly define the used trust model. One of:
.INDENT 7.0
.IP \(bu 2
pgp
.IP \(bu 2
classic
.IP \(bu 2
tofu
.IP \(bu 2
tofu+pgp
.IP \(bu 2
direct
.IP \(bu 2
always
.IP \(bu 2
auto
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B signed_by_any
A list of key fingerprints from which any valid signature
will mark verification as passed. If none of the provided
keys signed the data, verification will fail. Optional.
Note that this does not take into account trust.
.sp
New in version 3007.0.

.TP
.B signed_by_all
A list of key fingerprints whose signatures are required
for verification to pass. If a single provided key did
not sign the data, verification will fail. Optional.
Note that this does not take into account trust.
.sp
New in version 3007.0.

.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq gpg.verify text=\(aqHello there.  How are you?\(aq
salt \(aq*\(aq gpg.verify filename=\(aq/path/to/important.file\(aq
salt \(aq*\(aq gpg.verify filename=\(aq/path/to/important.file\(aq trustmodel=direct
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.grafana4
.sp
Module for working with the Grafana v4 API
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B depends
requests
.TP
.B configuration
This module requires a configuration profile to be configured
in the minion config, minion pillar, or master config.
The module will use the \(aqgrafana\(aq key by default, if defined.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
grafana:
    grafana_url: http://grafana.localhost
    grafana_user: admin
    grafana_password: admin
    grafana_timeout: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.create_datasource(orgname=None, profile=\(aqgrafana\(aq, **kwargs)
Create a new datasource in an organisation.
.INDENT 7.0
.TP
.B name
Name of the data source.
.TP
.B type
Type of the datasource (\(aqgraphite\(aq, \(aqinfluxdb\(aq etc.).
.TP
.B access
Use proxy or direct.
.TP
.B url
The URL to the data source API.
.TP
.B user
Optional \- user to authenticate with the data source.
.TP
.B password
Optional \- password to authenticate with the data source.
.TP
.B database
Optional \- database to use with the data source.
.TP
.B basicAuth
Optional \- set to True to use HTTP basic auth to authenticate with the
data source.
.TP
.B basicAuthUser
Optional \- HTTP basic auth username.
.TP
.B basicAuthPassword
Optional \- HTTP basic auth password.
.TP
.B jsonData
Optional \- additional json data to post (eg. \(dqtimeInterval\(dq).
.TP
.B isDefault
Optional \- set data source as default.
.TP
.B withCredentials
Optional \- Whether credentials such as cookies or auth headers should
be sent with cross\-site requests.
.TP
.B typeLogoUrl
Optional \- Logo to use for this datasource.
.TP
.B orgname
Name of the organization in which the data source should be created.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.create_datasource
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.create_org(profile=\(aqgrafana\(aq, **kwargs)
Create a new organization.
.INDENT 7.0
.TP
.B name
Name of the organization.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.create_org <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.create_org_user(orgname=None, profile=\(aqgrafana\(aq, **kwargs)
Add user to the organization.
.INDENT 7.0
.TP
.B loginOrEmail
Login or email of the user.
.TP
.B role
.INDENT 7.0
.TP
.B Role of the user for this organization. Should be one of:
.INDENT 7.0
.IP \(bu 2
Admin
.IP \(bu 2
Editor
.IP \(bu 2
Read Only Editor
.IP \(bu 2
Viewer
.UNINDENT
.UNINDENT
.TP
.B orgname
Name of the organization in which users are added.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.create_org_user <orgname> loginOrEmail=<loginOrEmail> role=<role>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.create_update_dashboard(orgname=None, profile=\(aqgrafana\(aq, **kwargs)
Create or update a dashboard.
.INDENT 7.0
.TP
.B dashboard
A dict that defines the dashboard to create/update.
.TP
.B overwrite
Whether the dashboard should be overwritten if already existing.
.TP
.B orgname
Name of the organization.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.create_update_dashboard dashboard=<dashboard> overwrite=True orgname=<orgname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.create_user(profile=\(aqgrafana\(aq, **kwargs)
Create a new user.
.INDENT 7.0
.TP
.B login
Login of the new user.
.TP
.B password
Password of the new user.
.TP
.B email
Email of the new user.
.TP
.B name
Optional \- Full name of the new user.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.create_user login=<login> password=<password> email=<email>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.delete_dashboard(slug, orgname=None, profile=\(aqgrafana\(aq)
Delete a dashboard.
.INDENT 7.0
.TP
.B slug
Slug (name) of the dashboard.
.TP
.B orgname
Name of the organization.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.delete_dashboard <slug>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.delete_datasource(datasourceid, orgname=None, profile=\(aqgrafana\(aq)
Delete a datasource.
.INDENT 7.0
.TP
.B datasourceid
Id of the datasource.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.delete_datasource <datasource_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.delete_org(orgid, profile=\(aqgrafana\(aq)
Delete an organization.
.INDENT 7.0
.TP
.B orgid
Id of the organization.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.delete_org <org_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.delete_org_user(userid, orgname=None, profile=\(aqgrafana\(aq)
Remove user from the organization.
.INDENT 7.0
.TP
.B userid
Id of the user.
.TP
.B orgname
Name of the organization in which users are updated.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.delete_org_user <user_id> <orgname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.delete_user(userid, profile=\(aqgrafana\(aq)
Delete a user.
.INDENT 7.0
.TP
.B userid
Id of the user.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.delete_user <user_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.delete_user_org(userid, orgid, profile=\(aqgrafana\(aq)
Remove a user from an organization.
.INDENT 7.0
.TP
.B userid
Id of the user.
.TP
.B orgid
Id of the organization.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.delete_user_org <user_id> <org_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.get_dashboard(slug, orgname=None, profile=\(aqgrafana\(aq)
Get a dashboard.
.INDENT 7.0
.TP
.B slug
Slug (name) of the dashboard.
.TP
.B orgname
Name of the organization.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.get_dashboard <slug>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.get_datasource(name, orgname=None, profile=\(aqgrafana\(aq)
Show a single datasource in an organisation.
.INDENT 7.0
.TP
.B name
Name of the datasource.
.TP
.B orgname
Name of the organization.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.get_datasource <name> <orgname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.get_datasources(orgname=None, profile=\(aqgrafana\(aq)
List all datasources in an organisation.
.INDENT 7.0
.TP
.B orgname
Name of the organization.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.get_datasources <orgname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.get_org(name, profile=\(aqgrafana\(aq)
Show a single organization.
.INDENT 7.0
.TP
.B name
Name of the organization.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.get_org <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.get_org_address(orgname=None, profile=\(aqgrafana\(aq)
Get the organization address.
.INDENT 7.0
.TP
.B orgname
Name of the organization in which users are updated.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.get_org_address <orgname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.get_org_prefs(orgname=None, profile=\(aqgrafana\(aq)
Get the organization preferences.
.INDENT 7.0
.TP
.B orgname
Name of the organization in which users are updated.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.get_org_prefs <orgname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.get_org_users(orgname=None, profile=\(aqgrafana\(aq)
Get the list of users that belong to the organization.
.INDENT 7.0
.TP
.B orgname
Name of the organization.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.get_org_users <orgname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.get_orgs(profile=\(aqgrafana\(aq)
List all organizations.
.INDENT 7.0
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.get_orgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.get_user(login, profile=\(aqgrafana\(aq)
Show a single user.
.INDENT 7.0
.TP
.B login
Login of the user.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.get_user <login>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.get_user_data(userid, profile=\(aqgrafana\(aq)
Get user data.
.INDENT 7.0
.TP
.B userid
Id of the user.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.get_user_data <user_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.get_user_orgs(userid, profile=\(aqgrafana\(aq)
Get the list of organisations a user belong to.
.INDENT 7.0
.TP
.B userid
Id of the user.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.get_user_orgs <user_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.get_users(profile=\(aqgrafana\(aq)
List all users.
.INDENT 7.0
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.get_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.switch_org(orgname, profile=\(aqgrafana\(aq)
Switch the current organization.
.INDENT 7.0
.TP
.B name
Name of the organization to switch to.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.switch_org <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.update_datasource(datasourceid, orgname=None, profile=\(aqgrafana\(aq, **kwargs)
Update a datasource.
.INDENT 7.0
.TP
.B datasourceid
Id of the datasource.
.TP
.B name
Name of the data source.
.TP
.B type
Type of the datasource (\(aqgraphite\(aq, \(aqinfluxdb\(aq etc.).
.TP
.B access
Use proxy or direct.
.TP
.B url
The URL to the data source API.
.TP
.B user
Optional \- user to authenticate with the data source.
.TP
.B password
Optional \- password to authenticate with the data source.
.TP
.B database
Optional \- database to use with the data source.
.TP
.B basicAuth
Optional \- set to True to use HTTP basic auth to authenticate with the
data source.
.TP
.B basicAuthUser
Optional \- HTTP basic auth username.
.TP
.B basicAuthPassword
Optional \- HTTP basic auth password.
.TP
.B jsonData
Optional \- additional json data to post (eg. \(dqtimeInterval\(dq).
.TP
.B isDefault
Optional \- set data source as default.
.TP
.B withCredentials
Optional \- Whether credentials such as cookies or auth headers should
be sent with cross\-site requests.
.TP
.B typeLogoUrl
Optional \- Logo to use for this datasource.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.update_datasource <datasourceid>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.update_org(orgid, profile=\(aqgrafana\(aq, **kwargs)
Update an existing organization.
.INDENT 7.0
.TP
.B orgid
Id of the organization.
.TP
.B name
New name of the organization.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.update_org <org_id> name=<name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.update_org_address(orgname=None, profile=\(aqgrafana\(aq, **kwargs)
Update the organization address.
.INDENT 7.0
.TP
.B orgname
Name of the organization in which users are updated.
.TP
.B address1
Optional \- address1 of the org.
.TP
.B address2
Optional \- address2 of the org.
.TP
.B city
Optional \- city of the org.
.TP
.B zip_code
Optional \- zip_code of the org.
.TP
.B state
Optional \- state of the org.
.TP
.B country
Optional \- country of the org.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.update_org_address <orgname> country=<country>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.update_org_prefs(orgname=None, profile=\(aqgrafana\(aq, **kwargs)
Update the organization preferences.
.INDENT 7.0
.TP
.B orgname
Name of the organization in which users are updated.
.TP
.B theme
Selected theme for the org.
.TP
.B homeDashboardId
Home dashboard for the org.
.TP
.B timezone
Timezone for the org (one of: \(dqbrowser\(dq, \(dqutc\(dq, or \(dq\(dq).
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.update_org_prefs <orgname> theme=<theme> timezone=<timezone>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.update_org_user(userid, orgname=None, profile=\(aqgrafana\(aq, **kwargs)
Update user role in the organization.
.INDENT 7.0
.TP
.B userid
Id of the user.
.TP
.B loginOrEmail
Login or email of the user.
.TP
.B role
.INDENT 7.0
.TP
.B Role of the user for this organization. Should be one of:
.INDENT 7.0
.IP \(bu 2
Admin
.IP \(bu 2
Editor
.IP \(bu 2
Read Only Editor
.IP \(bu 2
Viewer
.UNINDENT
.UNINDENT
.TP
.B orgname
Name of the organization in which users are updated.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.update_org_user <user_id> <orgname> loginOrEmail=<loginOrEmail> role=<role>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.update_user(userid, profile=\(aqgrafana\(aq, **kwargs)
Update an existing user.
.INDENT 7.0
.TP
.B userid
Id of the user.
.TP
.B login
Optional \- Login of the user.
.TP
.B email
Optional \- Email of the user.
.TP
.B name
Optional \- Full name of the user.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.update_user <user_id> login=<login> email=<email>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.update_user_password(userid, profile=\(aqgrafana\(aq, **kwargs)
Update a user password.
.INDENT 7.0
.TP
.B userid
Id of the user.
.TP
.B password
New password of the user.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.update_user_password <user_id> password=<password>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grafana4.update_user_permissions(userid, profile=\(aqgrafana\(aq, **kwargs)
Update a user password.
.INDENT 7.0
.TP
.B userid
Id of the user.
.TP
.B isGrafanaAdmin
Whether user is a Grafana admin.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grafana4.update_user_permissions <user_id> isGrafanaAdmin=<true|false>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.grains
.sp
Return/control aspects of the grains data
.sp
Grains set or altered with this module are stored in the \(aqgrains\(aq
file on the minions. By default, this file is located at: \fB/etc/salt/grains\fP
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This does \fBNOT\fP override any grains set in the minion config file.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grains.append(key, val, convert=False, delimiter=\(aq:\(aq)
New in version 0.17.0.

.sp
Append a value to a list in the grains config file. If the grain doesn\(aqt
exist, the grain key is added and the value is appended to the new grain
as a list item.
.INDENT 7.0
.TP
.B key
The grain key to be appended to
.TP
.B val
The value to append to the grain key
.TP
.B convert
If convert is True, convert non\-list contents into a list.
If convert is False and the grain contains non\-list contents, an error
is given. Defaults to False.
.TP
.B delimiter
The key can be a nested dict key. Use this parameter to
specify the delimiter you use, instead of the default \fB:\fP\&.
You can now append values to a list in nested dictionary grains. If the
list doesn\(aqt exist at this level, it will be created.
.sp
New in version 2014.7.6.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.append key val
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grains.delkey(key, force=False)
New in version 2017.7.0.

.sp
Remove a grain completely from the grain system, this will remove the
grain key and value
.INDENT 7.0
.TP
.B key
The grain key from which to delete the value.
.TP
.B force
Force remove the grain even when it is a mapped value.
Defaults to False
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.delkey key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grains.delval(key, destructive=False, force=False)
New in version 0.17.0.

.sp
Delete a grain value from the grains config file. This will just set the
grain value to \fBNone\fP\&. To completely remove the grain, run \fBgrains.delkey\fP
or pass \fBdestructive=True\fP to \fBgrains.delval\fP\&.
.INDENT 7.0
.TP
.B key
The grain key from which to delete the value.
.TP
.B destructive
Delete the key, too. Defaults to False.
.TP
.B force
Force remove the grain even when it is a mapped value.
Defaults to False
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.delval key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grains.equals(key, value)
Used to make sure the minion\(aqs grain key/value matches.
.sp
Returns \fBTrue\fP if matches otherwise \fBFalse\fP\&.
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.equals fqdn <expected_fqdn>
salt \(aq*\(aq grains.equals systemd:version 219
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grains.fetch(key, default=\(aq\(aq, delimiter=\(aq:\(aq, ordered=True)
Attempt to retrieve the named value from grains, if the named value is not
available return the passed default. The default return is an empty string.
.sp
The value can also represent a value in a nested dict using a \(dq:\(dq delimiter
for the dict. This means that if a dict in grains looks like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqpkg\(aq: {\(aqapache\(aq: \(aqhttpd\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To retrieve the value associated with the apache key in the pkg dict this
key can be passed:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pkg:apache
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdelimiter\fP \-\-
.sp
Specify an alternate delimiter to use when traversing a nested dict.
This is useful for when the desired key contains a colon. See CLI
example below for usage.
.sp
New in version 2014.7.0.


.IP \(bu 2
\fBordered\fP \-\-
.sp
Outputs an ordered dict if applicable (default: True)
.sp
New in version 2016.11.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.get pkg:apache
salt \(aq*\(aq grains.get abc::def|ghi delimiter=\(aq|\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grains.filter_by(lookup_dict, grain=\(aqos_family\(aq, merge=None, default=\(aqdefault\(aq, base=None)
New in version 0.17.0.

.sp
Look up the given grain in a given dictionary for the current OS and return
the result
.sp
Although this may occasionally be useful at the CLI, the primary intent of
this function is for use in Jinja to make short work of creating lookup
tables for OS\-specific data. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set apache = salt[\(aqgrains.filter_by\(aq]({
    \(aqDebian\(aq: {\(aqpkg\(aq: \(aqapache2\(aq, \(aqsrv\(aq: \(aqapache2\(aq},
    \(aqRedHat\(aq: {\(aqpkg\(aq: \(aqhttpd\(aq, \(aqsrv\(aq: \(aqhttpd\(aq},
}, default=\(aqDebian\(aq) %}

myapache:
  pkg.installed:
    \- name: {{ apache.pkg }}
  service.running:
    \- name: {{ apache.srv }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Values in the lookup table may be overridden by values in Pillar. An
example Pillar to override values in the example above could be as follows:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
apache:
  lookup:
    pkg: apache_13
    srv: apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The call to \fBfilter_by()\fP would be modified as follows to reference those
Pillar values:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set apache = salt[\(aqgrains.filter_by\(aq]({
    ...
}, merge=salt[\(aqpillar.get\(aq](\(aqapache:lookup\(aq)) %}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBlookup_dict\fP \-\-
.sp
A dictionary, keyed by a grain, containing a value or
values relevant to systems matching that grain. For example, a key
could be the grain for an OS and the value could the name of a package
on that particular OS.
.sp
Changed in version 2016.11.0: The dictionary key could be a globbing pattern. The function will
return the corresponding \fBlookup_dict\fP value where grain value
matches the pattern. For example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
# this will render \(aqgot some salt\(aq if Minion ID begins from \(aqsalt\(aq
salt \(aq*\(aq grains.filter_by \(aq{salt*: got some salt, default: salt is not here}\(aq id
.ft P
.fi
.UNINDENT
.UNINDENT


.IP \(bu 2
\fBgrain\fP \-\-
.sp
The name of a grain to match with the current system\(aqs
grains. For example, the value of the \(dqos_family\(dq grain for the current
system could be used to pull values from the \fBlookup_dict\fP
dictionary.
.sp
Changed in version 2016.11.0: The grain value could be a list. The function will return the
\fBlookup_dict\fP value for a first found item in the list matching
one of the \fBlookup_dict\fP keys.


.IP \(bu 2
\fBmerge\fP \-\- A dictionary to merge with the results of the grain selection
from \fBlookup_dict\fP\&. This allows Pillar to override the values in the
\fBlookup_dict\fP\&. This could be useful, for example, to override the
values for non\-standard package names such as when using a different
Python version from the default Python version provided by the OS
(e.g., \fBpython26\-mysql\fP instead of \fBpython\-mysql\fP).
.IP \(bu 2
\fBdefault\fP \-\-
.sp
default lookup_dict\(aqs key used if the grain does not exists
or if the grain value has no match on lookup_dict.  If unspecified
the value is \(dqdefault\(dq.
.sp
New in version 2014.1.0.


.IP \(bu 2
\fBbase\fP \-\-
.sp
A lookup_dict key to use for a base dictionary.  The
grain\-selected \fBlookup_dict\fP is merged over this and then finally
the \fBmerge\fP dictionary is merged.  This allows common values for
each case to be collected in the base and overridden by the grain
selection dictionary and the merge dictionary.  Default is unset.
.sp
New in version 2015.5.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.filter_by \(aq{Debian: Debheads rule, RedHat: I love my hat}\(aq
# this one will render {D: {E: I, G: H}, J: K}
salt \(aq*\(aq grains.filter_by \(aq{A: B, C: {D: {E: F, G: H}}}\(aq \(aqxxx\(aq \(aq{D: {E: I}, J: K}\(aq \(aqC\(aq
# next one renders {A: {B: G}, D: J}
salt \(aq*\(aq grains.filter_by \(aq{default: {A: {B: C}, D: E}, F: {A: {B: G}}, H: {D: I}}\(aq \(aqxxx\(aq \(aq{D: J}\(aq \(aqF\(aq \(aqdefault\(aq
# next same as above when default=\(aqH\(aq instead of \(aqF\(aq renders {A: {B: C}, D: J}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grains.get(key, default=\(aq\(aq, delimiter=\(aq:\(aq, ordered=True)
Attempt to retrieve the named value from grains, if the named value is not
available return the passed default. The default return is an empty string.
.sp
The value can also represent a value in a nested dict using a \(dq:\(dq delimiter
for the dict. This means that if a dict in grains looks like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqpkg\(aq: {\(aqapache\(aq: \(aqhttpd\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To retrieve the value associated with the apache key in the pkg dict this
key can be passed:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pkg:apache
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdelimiter\fP \-\-
.sp
Specify an alternate delimiter to use when traversing a nested dict.
This is useful for when the desired key contains a colon. See CLI
example below for usage.
.sp
New in version 2014.7.0.


.IP \(bu 2
\fBordered\fP \-\-
.sp
Outputs an ordered dict if applicable (default: True)
.sp
New in version 2016.11.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.get pkg:apache
salt \(aq*\(aq grains.get abc::def|ghi delimiter=\(aq|\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grains.has_value(key)
Determine whether a key exists in the grains dictionary.
.sp
Given a grains dictionary that contains the following structure:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqpkg\(aq: {\(aqapache\(aq: \(aqhttpd\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
One would determine if the apache key in the pkg dict exists by:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pkg:apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.has_value pkg:apache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grains.item(*args, **kwargs)
Return one or more grains
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.item os
salt \(aq*\(aq grains.item os osrelease oscodename
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Sanitized CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.item host sanitize=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grains.items(sanitize=False)
Return all of the minion\(aqs grains
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.items
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Sanitized CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.items sanitize=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grains.ls()
Return a list of all available grains
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.ls
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grains.remove(key, val, delimiter=\(aq:\(aq)
New in version 0.17.0.

.sp
Remove a value from a list in the grains config file
.INDENT 7.0
.TP
.B key
The grain key to remove.
.TP
.B val
The value to remove.
.TP
.B delimiter
The key can be a nested dict key. Use this parameter to
specify the delimiter you use, instead of the default \fB:\fP\&.
You can now append values to a list in nested dictionary grains. If the
list doesn\(aqt exist at this level, it will be created.
.sp
New in version 2015.8.2.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.remove key val
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grains.set(key, val=\(aq\(aq, force=False, destructive=False, delimiter=\(aq:\(aq)
Set a key to an arbitrary value. It is used like setval but works
with nested keys.
.sp
This function is conservative. It will only overwrite an entry if
its value and the given one are not a list or a dict. The \fBforce\fP
parameter is used to allow overwriting in all cases.
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBforce\fP \-\- Force writing over existing entry if given or existing
values are list or dict. Defaults to False.
.IP \(bu 2
\fBdestructive\fP \-\- If an operation results in a key being removed,
delete the key, too. Defaults to False.
.IP \(bu 2
\fBdelimiter\fP \-\- Specify an alternate delimiter to use when traversing a nested dict,
the default being \fB:\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.set \(aqapps:myApp:port\(aq 2209
salt \(aq*\(aq grains.set \(aqapps:myApp\(aq \(aq{port: 2209}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grains.setval(key, val, destructive=False, refresh_pillar=True)
Set a grains value in the grains config file
.INDENT 7.0
.TP
.B key
The grain key to be set.
.TP
.B val
The value to set the grain key to.
.TP
.B destructive
If an operation results in a key being removed, delete the key, too.
Defaults to False.
.TP
.B refresh_pillar
Whether pillar will be refreshed.
Defaults to True.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.setval key val
salt \(aq*\(aq grains.setval key \(dq{\(aqsub\-key\(aq: \(aqval\(aq, \(aqsub\-key2\(aq: \(aqval2\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grains.setvals(grains, destructive=False, refresh_pillar=True)
Set new grains values in the grains config file
.INDENT 7.0
.TP
.B destructive
If an operation results in a key being removed, delete the key, too.
Defaults to False.
.TP
.B refresh_pillar
Whether pillar will be refreshed.
Defaults to True.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.setvals \(dq{\(aqkey1\(aq: \(aqval1\(aq, \(aqkey2\(aq: \(aqval2\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.groupadd
.sp
Manage groups on Linux, OpenBSD and NetBSD
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage groups on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqgroup.info\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.groupadd.add(name, gid=None, system=False, root=None, non_unique=False, local=False)
Changed in version 3006.0.

.sp
Add the specified group
.INDENT 7.0
.TP
.B name
Name of the new group
.TP
.B gid
Use GID for the new group
.TP
.B system
Create a system account
.TP
.B root
Directory to chroot into
.TP
.B non_unique
Allow creating groups with duplicate (non\-unique) GIDs
.sp
New in version 3006.0.

.TP
.B local
Specifically add the group locally rather than through remote providers (e.g. LDAP)
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.add foo 3456
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.groupadd.adduser(name, username, root=None)
Add a user in the group.
.INDENT 7.0
.TP
.B name
Name of the group to modify
.TP
.B username
Username to add to the group
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.adduser foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Verifies if a valid username \(aqbar\(aq as a member of an existing group \(aqfoo\(aq,
if not then adds it.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.groupadd.chgid(name, gid, root=None, non_unique=False)
Changed in version 3006.0.

.sp
Change the gid for a named group
.INDENT 7.0
.TP
.B name
Name of the group to modify
.TP
.B gid
Change the group ID to GID
.TP
.B root
Directory to chroot into
.TP
.B non_unique
Allow modifying groups with duplicate (non\-unique) GIDs
.sp
New in version 3006.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.chgid foo 4376
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.groupadd.delete(name, root=None, local=False)
Remove the named group
.INDENT 7.0
.TP
.B name
Name group to delete
.TP
.B root
Directory to chroot into
.TP
.B local (Only on systems with lgroupdel available):
Ensure the group account is removed locally ignoring global
account management (default is False).
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.delete foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.groupadd.deluser(name, username, root=None)
Remove a user from the group.
.INDENT 7.0
.TP
.B name
Name of the group to modify
.TP
.B username
Username to delete from the group
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.deluser foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Removes a member user \(aqbar\(aq from a group \(aqfoo\(aq. If group is not present
then returns True.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.groupadd.getent(refresh=False, root=None)
Return info on all groups
.INDENT 7.0
.TP
.B refresh
Force a refresh of group information
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.getent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.groupadd.info(name, root=None)
Return information about a group
.INDENT 7.0
.TP
.B name
Name of the group
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.info foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.groupadd.members(name, members_list, root=None)
Replaces members of the group with a provided list.
.INDENT 7.0
.TP
.B name
Name of the group to modify
.TP
.B members_list
Username list to set into the group
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.members foo \(aquser1,user2,user3,...\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Replaces a membership list for a local group \(aqfoo\(aq.
foo:x:1234:user1,user2,user3,...
.UNINDENT
.UNINDENT
.SS salt.modules.grub_legacy
.sp
Support for GRUB Legacy
.INDENT 0.0
.TP
.B salt.modules.grub_legacy.conf()
Parse GRUB conf file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grub.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.grub_legacy.version()
Return server version from grub \-\-version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grub.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.guestfs
.sp
Interact with virtual machine images via libguestfs
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
libguestfs
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.guestfs.mount(location, access=\(aqrw\(aq, root=None)
Mount an image
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq guest.mount /srv/images/fedora.qcow
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.guestfs.umount(name, disk=None)
Unmount an image
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq guestfs.umount /mountpoint disk=/srv/images/fedora.qcow
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.hadoop
.sp
Support for hadoop
.INDENT 0.0
.TP
.B maintainer
Yann Jouanin <\fI\%yann.jouanin@intelunix.fr\fP>
.TP
.B maturity
new
.TP
.B depends
.TP
.B platform
linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hadoop.dfs(command=None, *args)
Execute a command on DFS
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hadoop.dfs ls /
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hadoop.dfs_absent(path)
Check if a file or directory is absent on the distributed FS.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hadoop.dfs_absent /some_random_file
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns True if the file is absent
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hadoop.dfs_present(path)
Check if a file or directory is present on the distributed FS.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hadoop.dfs_present /some_random_file
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns True if the file is present
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hadoop.dfsadmin_report(arg=None)
New in version 2019.2.0.

.sp
Reports basic filesystem information and statistics. Optional flags may be used to filter the list of displayed DataNodes.
.INDENT 7.0
.TP
.B arg
[live] [dead] [decommissioning]
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hadoop.dfsadmin \-report
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hadoop.namenode_format(force=None)
Format a name node
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hadoop.namenode_format force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hadoop.version()
Return version from hadoop version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hadoop.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.haproxyconn
.sp
Support for haproxy
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B salt.modules.haproxyconn.disable_server(name, backend, socket=\(aq/var/run/haproxy.sock\(aq)
Disable server in haproxy.
.INDENT 7.0
.TP
.B name
Server to disable
.TP
.B backend
haproxy backend, or all backends if \(dq*\(dq is supplied
.TP
.B socket
haproxy stats socket, default \fB/var/run/haproxy.sock\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq haproxy.disable_server db1.example.com mysql
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.haproxyconn.enable_server(name, backend, socket=\(aq/var/run/haproxy.sock\(aq)
Enable Server in haproxy
.INDENT 7.0
.TP
.B name
Server to enable
.TP
.B backend
haproxy backend, or all backends if \(dq*\(dq is supplied
.TP
.B socket
haproxy stats socket, default \fB/var/run/haproxy.sock\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq haproxy.enable_server web1.example.com www
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.haproxyconn.get_backend(backend, socket=\(aq/var/run/haproxy.sock\(aq)
Receive information about a specific backend.
.INDENT 7.0
.TP
.B backend
haproxy backend
.TP
.B socket
haproxy stats socket, default \fB/var/run/haproxy.sock\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq haproxy.get_backend mysql
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.haproxyconn.get_sessions(name, backend, socket=\(aq/var/run/haproxy.sock\(aq)
New in version 2016.11.0.

.sp
Get number of current sessions on server in backend (scur)
.INDENT 7.0
.TP
.B name
Server name
.TP
.B backend
haproxy backend
.TP
.B socket
haproxy stats socket, default \fB/var/run/haproxy.sock\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq haproxy.get_sessions web1.example.com www
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.haproxyconn.get_weight(name, backend, socket=\(aq/var/run/haproxy.sock\(aq)
Get server weight
.INDENT 7.0
.TP
.B name
Server name
.TP
.B backend
haproxy backend
.TP
.B socket
haproxy stats socket, default \fB/var/run/haproxy.sock\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq haproxy.get_weight web1.example.com www
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.haproxyconn.list_backends(servers=True, socket=\(aq/var/run/haproxy.sock\(aq)
List HaProxy Backends
.INDENT 7.0
.TP
.B socket
haproxy stats socket, default \fB/var/run/haproxy.sock\fP
.TP
.B servers
list backends with servers
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq haproxy.list_backends
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.haproxyconn.list_frontends(socket=\(aq/var/run/haproxy.sock\(aq)
List HaProxy frontends
.INDENT 7.0
.TP
.B socket
haproxy stats socket, default \fB/var/run/haproxy.sock\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq haproxy.list_frontends
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.haproxyconn.list_servers(backend, socket=\(aq/var/run/haproxy.sock\(aq, objectify=False)
List servers in haproxy backend.
.INDENT 7.0
.TP
.B backend
haproxy backend
.TP
.B socket
haproxy stats socket, default \fB/var/run/haproxy.sock\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq haproxy.list_servers mysql
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.haproxyconn.set_state(name, backend, state, socket=\(aq/var/run/haproxy.sock\(aq)
Force a server\(aqs administrative state to a new state. This can be useful to
disable load balancing and/or any traffic to a server. Setting the state to
\(dqready\(dq puts the server in normal mode, and the command is the equivalent of
the \(dqenable server\(dq command. Setting the state to \(dqmaint\(dq disables any traffic
to the server as well as any health checks. This is the equivalent of the
\(dqdisable server\(dq command. Setting the mode to \(dqdrain\(dq only removes the server
from load balancing but still allows it to be checked and to accept new
persistent connections. Changes are propagated to tracking servers if any.
.INDENT 7.0
.TP
.B name
Server name
.TP
.B backend
haproxy backend
.TP
.B state
A string of the state to set. Must be \(aqready\(aq, \(aqdrain\(aq, or \(aqmaint\(aq
.TP
.B socket
haproxy stats socket, default \fB/var/run/haproxy.sock\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq haproxy.set_state my_proxy_server my_backend ready
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.haproxyconn.set_weight(name, backend, weight=0, socket=\(aq/var/run/haproxy.sock\(aq)
Set server weight
.INDENT 7.0
.TP
.B name
Server name
.TP
.B backend
haproxy backend
.TP
.B weight
Server Weight
.TP
.B socket
haproxy stats socket, default \fB/var/run/haproxy.sock\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq haproxy.set_weight web1.example.com www 13
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.haproxyconn.show_backends(socket=\(aq/var/run/haproxy.sock\(aq)
Show HaProxy Backends
.INDENT 7.0
.TP
.B socket
haproxy stats socket, default \fB/var/run/haproxy.sock\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq haproxy.show_backends
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.haproxyconn.show_frontends(socket=\(aq/var/run/haproxy.sock\(aq)
Show HaProxy frontends
.INDENT 7.0
.TP
.B socket
haproxy stats socket, default \fB/var/run/haproxy.sock\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq haproxy.show_frontends
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.haproxyconn.wait_state(backend, server, value=\(aqup\(aq, timeout=300, socket=\(aq/var/run/haproxy.sock\(aq)
Wait for a specific server state
.INDENT 7.0
.TP
.B backend
haproxy backend
.TP
.B server
targeted server
.TP
.B value
state value
.TP
.B timeout
timeout before giving up state value, default 5 min
.TP
.B socket
haproxy stats socket, default \fB/var/run/haproxy.sock\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq haproxy.wait_state mysql server01 up 60
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.hashutil
.sp
A collection of hashing and encoding functions
.INDENT 0.0
.TP
.B salt.modules.hashutil.base64_b64decode(instr)
Decode a base64\-encoded string using the \(dqmodern\(dq Python interface
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hashutil.base64_b64decode \(aqZ2V0IHNhbHRlZA==\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hashutil.base64_b64encode(instr)
Encode a string as base64 using the \(dqmodern\(dq Python interface.
.sp
Among other possible differences, the \(dqmodern\(dq encoder does not include
newline (\(aqn\(aq) characters in the encoded output.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hashutil.base64_b64encode \(aqget salted\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hashutil.base64_decodefile(instr, outfile)
Decode a base64\-encoded string and write the result to a file
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hashutil.base64_decodefile instr=\(aqZ2V0IHNhbHRlZAo=\(aq outfile=\(aq/path/to/binary_file\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hashutil.base64_decodestring(instr)
Decode a base64\-encoded byte\-like object using the \(dqmodern\(dq Python interface
.sp
New in version 3000.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hashutil.base64_decodestring instr=\(aqZ2V0IHNhbHRlZAo=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hashutil.base64_encodefile(fname)
Read a file from the file system and return as a base64 encoded string
.sp
New in version 2016.3.0.

.sp
Pillar example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
path:
  to:
    data: |
      {{ salt.hashutil.base64_encodefile(\(aq/path/to/binary_file\(aq) | indent(6) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fI\%file.decode\fP state function can be
used to decode this data and write it to disk.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hashutil.base64_encodefile /path/to/binary_file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hashutil.base64_encodestring(instr)
Encode a byte\-like object as base64 using the \(dqmodern\(dq Python interface.
.sp
Among other possible differences, the \(dqmodern\(dq encoder includes
a newline (\(aqn\(aq) character after every 76 characters and always
at the end of the encoded byte\-like object.
.sp
New in version 3000.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hashutil.base64_encodestring \(aqget salted\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hashutil.digest(instr, checksum=\(aqmd5\(aq)
Return a checksum digest for a string
.INDENT 7.0
.TP
.B instr
A string
.TP
.B checksum
\fBmd5\fP
The hashing algorithm to use to generate checksums. Valid options: md5,
sha256, sha512.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hashutil.digest \(aqget salted\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hashutil.digest_file(infile, checksum=\(aqmd5\(aq)
Return a checksum digest for a file
.INDENT 7.0
.TP
.B infile
A file path
.TP
.B checksum
\fBmd5\fP
The hashing algorithm to use to generate checksums. Wraps the
\fI\%hashutil.digest\fP execution
function.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hashutil.digest_file /path/to/file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hashutil.github_signature(string, shared_secret, challenge_hmac)
Verify a challenging hmac signature against a string / shared\-secret for
github webhooks.
.sp
New in version 2017.7.0.

.sp
Returns a boolean if the verification succeeded or failed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hashutil.github_signature \(aq{\(dqref\(dq:....} \(aq \(aqshared secret\(aq \(aqsha1=bc6550fc290acf5b42283fa8deaf55cea0f8c206\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hashutil.hmac_compute(string, shared_secret)
New in version 3000.

.sp
Compute a HMAC SHA256 digest using a string and secret.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hashutil.hmac_compute \(aqget salted\(aq \(aqshared secret\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hashutil.hmac_signature(string, shared_secret, challenge_hmac)
Verify a challenging hmac signature against a string / shared\-secret
.sp
New in version 2014.7.0.

.sp
Returns a boolean if the verification succeeded or failed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hashutil.hmac_signature \(aqget salted\(aq \(aqshared secret\(aq \(aqeBWf9bstXg+NiP5AOwppB5HMvZiYMPzEM9W5YMm/AmQ=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hashutil.md5_digest(instr)
Generate an md5 hash of a given string
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hashutil.md5_digest \(aqget salted\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hashutil.sha256_digest(instr)
Generate an sha256 hash of a given string
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hashutil.sha256_digest \(aqget salted\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hashutil.sha512_digest(instr)
Generate an sha512 hash of a given string
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hashutil.sha512_digest \(aqget salted\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.heat
.sp
Module for handling OpenStack Heat calls
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
heatclient Python module
.UNINDENT
.TP
.B configuration
This module is not usable until the user, password, tenant, and
auth URL are specified either in a pillar or in the minion\(aqs config file.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
keystone.user: admin
keystone.password: verybadpass
keystone.tenant: admin
keystone.insecure: False   #(optional)
keystone.auth_url: \(aqhttp://127.0.0.1:5000/v2.0/\(aq
# Optional
keystone.region_name: \(aqRegionOne\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If configuration for multiple OpenStack accounts is required, they can be
set up as different configuration profiles:
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
openstack1:
  keystone.user: admin
  keystone.password: verybadpass
  keystone.tenant: admin
  keystone.auth_url: \(aqhttp://127.0.0.1:5000/v2.0/\(aq

openstack2:
  keystone.user: admin
  keystone.password: verybadpass
  keystone.tenant: admin
  keystone.auth_url: \(aqhttp://127.0.0.2:5000/v2.0/\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With this configuration in place, any of the heat functions can make use of
a configuration profile by declaring it explicitly.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq heat.flavor_list profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.heat.create_stack(name=None, template_file=None, environment=None, parameters=None, poll=0, rollback=False, timeout=60, profile=None)
Create a stack (heat stack\-create)
.INDENT 7.0
.TP
.B name
Name of the new stack
.TP
.B template_file
File of template
.TP
.B environment
File of environment
.TP
.B parameters
Parameter dict used to create the stack
.TP
.B poll
Poll and report events until stack complete
.TP
.B rollback
Enable rollback on create failure
.TP
.B timeout
Stack creation timeout in minutes
.TP
.B profile
Profile to build on
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq heat.create_stack name=mystack \e
         template_file=salt://template.yaml \e
         environment=salt://environment.yaml \e
         parameters=\(dq{\(dqimage\(dq: \(dqDebian 8\(dq, \(dqflavor\(dq: \(dqm1.small\(dq}\(dq \e
         poll=5 rollback=False timeout=60 profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.5,2018.3.1: The spelling mistake in parameter \fIenviroment\fP was corrected to \fIenvironment\fP\&.
The \fIenviroment\fP spelling mistake has been removed in Salt 3000.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.heat.delete_stack(name=None, poll=0, timeout=60, profile=None)
Delete a stack (heat stack\-delete)
.INDENT 7.0
.TP
.B name
Name of the stack
.TP
.B poll
Poll and report events until stack complete
.TP
.B timeout
Stack creation timeout in minute
.TP
.B profile
Profile to use
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq heat.delete_stack name=mystack poll=5 \e
         profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.heat.list_stack(profile=None)
Return a list of available stack (heat stack\-list)
.INDENT 7.0
.TP
.B profile
Profile to use
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq heat.list_stack profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.heat.show_stack(name=None, profile=None)
Return details about a specific stack (heat stack\-show)
.INDENT 7.0
.TP
.B name
Name of the stack
.TP
.B profile
Profile to use
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq heat.show_stack name=mystack profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.heat.template_stack(name=None, profile=None)
Return template a specific stack (heat stack\-template)
.INDENT 7.0
.TP
.B name
Name of the stack
.TP
.B profile
Profile to use
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq heat.template_stack name=mystack profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.heat.update_stack(name=None, template_file=None, environment=None, parameters=None, poll=0, rollback=False, timeout=60, profile=None)
Update a stack (heat stack\-template)
.INDENT 7.0
.TP
.B name
Name of the  stack
.TP
.B template_file
File of template
.TP
.B environment
File of environment
.TP
.B parameters
Parameter dict used to update the stack
.TP
.B poll
Poll and report events until stack complete
.TP
.B rollback
Enable rollback on update failure
.TP
.B timeout
Stack creation timeout in minutes
.TP
.B profile
Profile to build on
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq heat.update_stack name=mystack \e
         template_file=salt://template.yaml \e
         environment=salt://environment.yaml \e
         parameters=\(dq{\(dqimage\(dq: \(dqDebian 8\(dq, \(dqflavor\(dq: \(dqm1.small\(dq}\(dq \e
         poll=5 rollback=False timeout=60 profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.5,2018.3.1: The spelling mistake in parameter \fIenviroment\fP was corrected to \fIenvironment\fP\&.
The \fIenviroment\fP spelling mistake has been removed in Salt 3000.

.UNINDENT
.SS salt.modules.helm
.sp
Interface with Helm
.INDENT 0.0
.TP
.B depends
\fI\%pyhelm\fP Python package
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This module use the helm\-cli. The helm\-cli binary have to be present in your Salt\-Minion path.
.UNINDENT
.UNINDENT
.SS Helm\-CLI vs Salt\-Modules
.sp
This module is a wrapper of the helm binary.
All helm v3.0 command are implemented.
.sp
To install a chart with the helm\-cli:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
helm install grafana stable/grafana \-\-wait \-\-values /path/to/values.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To install a chart with the Salt\-Module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.install grafana stable/grafana values=\(aq/path/to/values.yaml\(aq flags=\(dq[\(aqwait\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Detailed Function Documentation
.INDENT 0.0
.TP
.B salt.modules.helm.completion(shell, flags=None, kvflags=None)
Generate auto\-completions script for Helm for the specified shell (bash or zsh).
Return the shell auto\-completion content.
.INDENT 7.0
.TP
.B shell
(string) One of [\(aqbash\(aq, \(aqzsh\(aq].
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.completion bash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.create(name, flags=None, kvflags=None)
Creates a chart directory along with the common files and directories used in a chart.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B name
(string) The chart name to create.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.create NAME
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.dependency_build(chart, flags=None, kvflags=None)
Build out the charts/ directory from the Chart.lock file.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B chart
(string) The chart name to build dependency.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.dependency_build CHART
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.dependency_list(chart, flags=None, kvflags=None)
List all of the dependencies declared in a chart.
Return chart dependencies if succeed, else the error message.
.INDENT 7.0
.TP
.B chart
(string) The chart name to list dependency.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.dependency_list CHART
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.dependency_update(chart, flags=None, kvflags=None)
Update the on\-disk dependencies to mirror Chart.yaml.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B chart
(string) The chart name to update dependency.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.dependency_update CHART
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.env(flags=None, kvflags=None)
Prints out all the environment information in use by Helm.
Return Helm environments variables if succeed, else the error message.
.INDENT 7.0
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.env
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.get_all(release, flags=None, kvflags=None)
Prints a human readable collection of information about the notes, hooks, supplied values, and generated manifest file of the given release.
Return release information if succeed, else the error message.
.INDENT 7.0
.TP
.B release
(string) Release name to get information from.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.get_all RELEASE
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.get_hooks(release, flags=None, kvflags=None)
Prints a human readable collection of information about the hooks of the given release.
Return release hooks information if succeed, else the error message.
.INDENT 7.0
.TP
.B release
(string) Release name to get hooks information from.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.get_hooks RELEASE
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.get_manifest(release, flags=None, kvflags=None)
Prints a human readable collection of information about the manifest of the given release.
Return release manifest information if succeed, else the error message.
.INDENT 7.0
.TP
.B release
(string) Release name to get manifest information from.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.get_manifest RELEASE
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.get_notes(release, flags=None, kvflags=None)
Prints a human readable collection of information about the notes of the given release.
Return release notes information if succeed, else the error message.
.INDENT 7.0
.TP
.B release
(string) Release name to get notes information from.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.get_notes RELEASE
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.get_values(release, flags=None, kvflags=None)
Prints a human readable collection of information about the values of the given release.
Return release values information if succeed, else the error message.
.INDENT 7.0
.TP
.B release
(string) Release name to get values information from.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.get_values RELEASE

# In YAML format
salt \(aq*\(aq helm.get_values RELEASE kvflags=\(dq{\(aqoutput\(aq: \(aqyaml\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.help_(command, flags=None, kvflags=None)
Provides help for any command in the application.
Return the full help if succeed, else the error message.
.INDENT 7.0
.TP
.B command
(string) Command to get help. ex: \(aqget\(aq
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.help COMMAND
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.history(release, flags=None, kvflags=None)
Prints historical revisions for a given release.
Return release historic if succeed, else the error message.
.INDENT 7.0
.TP
.B release
(string) Release name to get history from.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.history RELEASE

# In YAML format
salt \(aq*\(aq helm.history RELEASE kvflags=\(dq{\(aqoutput\(aq: \(aqyaml\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.install(release, chart, values=None, version=None, namespace=None, set=None, flags=None, kvflags=None)
Installs a chart archive.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B release
(string) Release name to get values information from.
.TP
.B chart
(string) Chart name to install.
.TP
.B values
(string) Absolute path to the values.yaml file.
.TP
.B version
(string) The exact chart version to install. If this is not specified, the latest version is installed.
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B set
(string or list) Set a values on the command line.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.install RELEASE CHART

# With values file.
salt \(aq*\(aq helm.install RELEASE CHART values=\(aq/path/to/values.yaml\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.lint(path, values=None, namespace=None, set=None, flags=None, kvflags=None)
Takes a path to a chart and runs a series of tests to verify that the chart is well\-formed.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B path
(string) The path to the chart to lint.
.TP
.B values
(string) Absolute path to the values.yaml file.
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B set
(string or list) Set a values on the command line.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.lint PATH
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.list_(namespace=None, flags=None, kvflags=None)
Lists all of the releases. By default, it lists only releases that are deployed or failed.
Return the list of release if succeed, else the error message.
.INDENT 7.0
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.list

# In YAML format
salt \(aq*\(aq helm.list kvflags=\(dq{\(aqoutput\(aq: \(aqyaml\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.package(chart, flags=None, kvflags=None)
Packages a chart into a versioned chart archive file. If a path is given, this will look at that path for a chart
(which must contain a Chart.yaml file) and then package that directory.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B chart
(string) Chart name to package. Can be an absolute path.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.package CHART

# With destination path.
salt \(aq*\(aq helm.package CHART kvflags=\(dq{\(aqdestination\(aq: \(aq/path/to/the/package\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.plugin_install(path, flags=None, kvflags=None)
Install a Helm plugin from a url to a VCS repo or a local path.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B path
(string) Path to the local plugin. Can be an url.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.plugin_install PATH
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.plugin_list(flags=None, kvflags=None)
List installed Helm plugins.
Return the plugin list if succeed, else the error message.
.INDENT 7.0
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.plugin_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.plugin_uninstall(plugin, flags=None, kvflags=None)
Uninstall a Helm plugin.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B plugin
(string) The plugin to uninstall.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.plugin_uninstall PLUGIN
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.plugin_update(plugin, flags=None, kvflags=None)
Update a Helm plugin.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B plugin
(string) The plugin to update.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.plugin_update PLUGIN
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.pull(pkg, flags=None, kvflags=None)
Retrieve a package from a package repository, and download it locally.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B pkg
(string) The package to pull. Can be url or repo/chartname.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.pull PKG

# With destination path to write the chart.
salt \(aq*\(aq helm.pull PKG kvflags=\(dq{\(aqdestination\(aq: \(aq/path/to/the/chart\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.repo_add(name, url, namespace=None, flags=None, kvflags=None)
Add a chart repository.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B name
(string) The local name of the repository to install. Have to be unique.
.TP
.B url
(string) The url to the repository.
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.repo_add NAME URL
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.repo_index(directory, namespace=None, flags=None, kvflags=None)
Read the current directory and generate an index file based on the charts found.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B directory
(string) The path to the index.
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.index DIRECTORY
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.repo_list(namespace=None, flags=None, kvflags=None)
List a chart repository.
Return the repository list if succeed, else the error message.
.INDENT 7.0
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.repo_list

# In YAML format
salt \(aq*\(aq helm.repo_list kvflags=\(dq{\(aqoutput\(aq: \(aqyaml\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.repo_manage(present=None, absent=None, prune=False, namespace=None, flags=None, kvflags=None)
Manage charts repository.
Return the summery of all actions.
.INDENT 7.0
.TP
.B present
(list) List of repository to be present. It\(aqs a list of dict: [{\(aqname\(aq: \(aqlocal_name\(aq, \(aqurl\(aq: \(aqrepository_url\(aq}]
.TP
.B absent
(list) List of local name repository to be absent.
.TP
.B prune
(boolean \- default: False) If True, all repository already present but not in the present list would be removed.
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.repo_manage present=\(dq[{\(aqname\(aq: \(aqLOCAL_NAME\(aq, \(aqurl\(aq: \(aqREPO_URL\(aq}]\(dq absent=\(dq[\(aqLOCAL_NAME\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.repo_remove(name, namespace=None, flags=None, kvflags=None)
Remove a chart repository.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B name
(string) The local name of the repository to remove.
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.repo_remove NAME
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.repo_update(namespace=None, flags=None, kvflags=None)
Update all charts repository.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.repo_update
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.rollback(release, revision, namespace=None, flags=None, kvflags=None)
Rolls back a release to a previous revision.
To see release revision number, execute the history module.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B release
(string) The name of the release to managed.
.TP
.B revision
(string) The revision number to roll back to.
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.rollback RELEASE REVISION

# In dry\-run mode.
salt \(aq*\(aq helm.rollback RELEASE REVISION flags=[\(aqdry\-run\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.search_hub(keyword, flags=None, kvflags=None)
Search the Helm Hub or an instance of Monocular for Helm charts.
Return the research result if succeed, else the error message.
.INDENT 7.0
.TP
.B keyword
(string) The keyword to search in the hub.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.search_hub KEYWORD

# In YAML format
salt \(aq*\(aq helm.search_hub KEYWORD kvflags=\(dq{\(aqoutput\(aq: \(aqyaml\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.search_repo(keyword, flags=None, kvflags=None)
Search reads through all of the repositories configured on the system, and looks for matches. Search of these
repositories uses the metadata stored on the system.
Return the research result if succeed, else the error message.
.INDENT 7.0
.TP
.B keyword
(string) The keyword to search in the repo.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.search_hub KEYWORD

# In YAML format
salt \(aq*\(aq helm.search_hub KEYWORD kvflags=\(dq{\(aqoutput\(aq: \(aqyaml\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.show_all(chart, flags=None, kvflags=None)
Inspects a chart (directory, file, or URL) and displays all its content (values.yaml, Charts.yaml, README).
Return chart information if succeed, else the error message.
.INDENT 7.0
.TP
.B chart
(string) The chart to inspect.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.show_all CHART
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.show_chart(chart, flags=None, kvflags=None)
Inspects a chart (directory, file, or URL) and displays the contents of the Charts.yaml file.
Return chart information if succeed, else the error message.
.INDENT 7.0
.TP
.B chart
(string) The chart to inspect.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.show_chart CHART
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.show_readme(chart, flags=None, kvflags=None)
Inspects a chart (directory, file, or URL) and displays the contents of the README file.
Return chart information if succeed, else the error message.
.INDENT 7.0
.TP
.B chart
(string) The chart to inspect.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.show_readme CHART
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.show_values(chart, flags=None, kvflags=None)
Inspects a chart (directory, file, or URL) and displays the contents of the values.yaml file.
Return chart information if succeed, else the error message.
.INDENT 7.0
.TP
.B chart
(string) The chart to inspect.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.show_values CHART
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.status(release, namespace=None, flags=None, kvflags=None)
Show the status of the release.
Return the release status if succeed, else the error message.
.INDENT 7.0
.TP
.B release
(string) The release to status.
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.status RELEASE

# In YAML format
salt \(aq*\(aq helm.status RELEASE kvflags=\(dq{\(aqoutput\(aq: \(aqyaml\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.template(name, chart, values=None, output_dir=None, set=None, flags=None, kvflags=None)
Render chart templates locally and display the output.
Return the chart renderer if succeed, else the error message.
.INDENT 7.0
.TP
.B name
(string) The template name.
.TP
.B chart
(string) The chart to template.
.TP
.B values
(string) Absolute path to the values.yaml file.
.TP
.B output_dir
(string) Absolute path to the output directory.
.TP
.B set
(string or list) Set a values on the command line.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.template NAME CHART

# With values file.
salt \(aq*\(aq helm.template NAME CHART values=\(aq/path/to/values.yaml\(aq output_dir=\(aqpath/to/output/dir\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.test(release, flags=None, kvflags=None)
Runs the tests for a release.
Return the test result if succeed, else the error message.
.INDENT 7.0
.TP
.B release
(string) The release name to test.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.test RELEASE
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.uninstall(release, namespace=None, flags=None, kvflags=None)
Uninstall the release name.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B release
(string) The name of the release to managed.
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.uninstall RELEASE

# In dry\-run mode.
salt \(aq*\(aq helm.uninstall RELEASE flags=[\(aqdry\-run\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.upgrade(release, chart, values=None, version=None, namespace=None, set=None, flags=None, kvflags=None)
Upgrades a release to a new version of a chart.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B release
(string) The name of the release to managed.
.TP
.B chart
(string) The chart to managed.
.TP
.B values
(string) Absolute path to the values.yaml file.
.TP
.B version
(string) The exact chart version to install. If this is not specified, the latest version is installed.
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B set
(string or list) Set a values on the command line.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.upgrade RELEASE CHART

# In dry\-run mode.
salt \(aq*\(aq helm.upgrade RELEASE CHART flags=[\(aqdry\-run\(aq]

# With values file.
salt \(aq*\(aq helm.upgrade RELEASE CHART values=\(aq/path/to/values.yaml\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.verify(path, flags=None, kvflags=None)
Verify that the given chart has a valid provenance file.
Return True if succeed, else the error message.
.INDENT 7.0
.TP
.B path
(string) The path to the chart file.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.verify PATH
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.helm.version(flags=None, kvflags=None)
Show the version for Helm.
Return version information if succeed, else the error message.
.INDENT 7.0
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq helm.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.hg
.sp
Support for the Mercurial SCM
.INDENT 0.0
.TP
.B salt.modules.hg.archive(cwd, output, rev=\(aqtip\(aq, fmt=None, prefix=None, user=None)
Export a tarball from the repository
.INDENT 7.0
.TP
.B cwd
The path to the Mercurial repository
.TP
.B output
The path to the archive tarball
.TP
.B rev: tip
The revision to create an archive from
.TP
.B fmt: None
Format of the resulting archive. Mercurial supports: tar,
tbz2, tgz, zip, uzip, and files formats.
.TP
.B prefix
None
Prepend <prefix>/ to every filename in the archive
.TP
.B user
None
Run hg as a user other than what the minion runs as
.UNINDENT
.sp
If \fBprefix\fP is not specified it defaults to the basename of the repo
directory.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hg.archive /path/to/repo output=/tmp/archive.tgz fmt=tgz
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hg.clone(cwd, repository, opts=None, user=None, identity=None)
Clone a new repository
.INDENT 7.0
.TP
.B cwd
The path to the Mercurial repository
.TP
.B repository
The hg URI of the repository
.TP
.B opts
None
Any additional options to add to the command line
.TP
.B user
None
Run hg as a user other than what the minion runs as
.TP
.B identity
None
Private SSH key on the minion server for authentication (\fI\%ssh://\fP)
.sp
New in version 2015.5.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hg.clone /path/to/repo https://bitbucket.org/birkenfeld/sphinx
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hg.describe(cwd, rev=\(aqtip\(aq, user=None)
Mimic git describe and return an identifier for the given revision
.INDENT 7.0
.TP
.B cwd
The path to the Mercurial repository
.TP
.B rev: tip
The path to the archive tarball
.TP
.B user
None
Run hg as a user other than what the minion runs as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hg.describe /path/to/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hg.pull(cwd, opts=None, user=None, identity=None, repository=None)
Perform a pull on the given repository
.INDENT 7.0
.TP
.B cwd
The path to the Mercurial repository
.TP
.B repository
None
Perform pull from the repository different from .hg/hgrc:[paths]:default
.TP
.B opts
None
Any additional options to add to the command line
.TP
.B user
None
Run hg as a user other than what the minion runs as
.TP
.B identity
None
Private SSH key on the minion server for authentication (\fI\%ssh://\fP)
.sp
New in version 2015.5.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hg.pull /path/to/repo opts=\-u
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hg.revision(cwd, rev=\(aqtip\(aq, short=False, user=None)
Returns the long hash of a given identifier (hash, branch, tag, HEAD, etc)
.INDENT 7.0
.TP
.B cwd
The path to the Mercurial repository
.TP
.B rev: tip
The revision
.TP
.B short: False
Return an abbreviated commit hash
.TP
.B user
None
Run hg as a user other than what the minion runs as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hg.revision /path/to/repo mybranch
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hg.status(cwd, opts=None, user=None)
Show changed files of the given repository
.INDENT 7.0
.TP
.B cwd
The path to the Mercurial repository
.TP
.B opts
None
Any additional options to add to the command line
.TP
.B user
None
Run hg as a user other than what the minion runs as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hg.status /path/to/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hg.update(cwd, rev, force=False, user=None)
Update to a given revision
.INDENT 7.0
.TP
.B cwd
The path to the Mercurial repository
.TP
.B rev
The revision to update to
.TP
.B force
False
Force an update
.TP
.B user
None
Run hg as a user other than what the minion runs as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt devserver1 hg.update /path/to/repo somebranch
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.highstate_doc
.sp
This module renders highstate configuration into a more human readable format.
.sp
How it works:
.sp
\fIhighstate or lowstate\fP data is parsed with a \fIprocessor\fP this defaults to \fIhighstate_doc.processor_markdown\fP\&.
The processed data is passed to a \fIjinja\fP template that builds up the document content.
.sp
configuration: Pillar
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# the following defaults can be overridden
highstate_doc.config:

    # list of regex of state names to ignore in \(gahighstate_doc.process_lowstates\(ga
    filter_id_regex:
        \- \(aq.*!doc_skip$\(aq

    # list of regex of state functions to ignore in \(gahighstate_doc.process_lowstates\(ga
    filter_state_function_regex:
        \- \(aqfile.accumulated\(aq

    # dict of regex to replace text after \(gahighstate_doc.render\(ga. (remove passwords)
    text_replace_regex:
        \(aqpassword:.*^\(aq: \(aq[PASSWORD]\(aq

    # limit size of files that can be included in doc (10000 bytes)
    max_render_file_size: 10000

    # advanced option to set a custom lowstate processor
    processor: highstate_doc.processor_markdown
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
State example
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{sls}} note:
    highstate_doc.note:
        \- name: example
        \- order: 0
        \- contents: |
            example \(gahighstate_doc.note\(ga
            \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
            This state does not do anything to the system! It is only used by a \(gaprocessor\(ga
            you can use \(garequisites\(ga and \(gaorder\(ga to move your docs around the rendered file.

{{sls}} a file we don\(aqt want in the doc !doc_skip:
    file.managed:
        \- name: /root/passwords
        \- contents: \(aqpassword: sadefgq34y45h56q\(aq
        # also could use \(gahighstate_doc.config: text_replace_regex\(ga to replace
        # password string. \(gapassword:.*^\(aq: \(aq[PASSWORD]\(ga
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To create the help document build a State that uses \fIhighstate_doc.render\fP\&.
For performance it\(aqs advised to not included this state in your \fItop.sls\fP file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# example \(gasalt://makereadme.sls\(ga
make helpfile:
    file.managed:
        \- name: /root/README.md
        \- contents: {{salt.highstate_doc.render()|json}}
        \- show_diff: {{opts[\(aqtest\(aq]}}
        \- mode: \(aq0640\(aq
        \- order: last
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Run our \fImakereadme.sls\fP state to create \fI/root/README.md\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# first ensure \(gahighstate\(ga return without errors or changes
salt\-call state.highstate
salt\-call state.apply makereadme
# or if you don\(aqt want the extra \(gamake helpfile\(ga state
salt\-call \-\-out=newline_values_only salt.highstate_doc.render > /root/README.md ; chmod 0600 /root/README.md
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Creating a document collection
.sp
From the master we can run the following script to
creates a collection of all your minion documents.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply makereadme
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!/bin/python
import os
import salt.client
s = salt.client.LocalClient()
# NOTE: because of issues with \(gacp.push\(ga use \(gahighstate_doc.read_file\(ga
o = s.cmd(\(aq*\(aq, \(aqhighstate_doc.read_file\(aq, [\(aq/root/README.md\(aq])
for m in o:
    d = o.get(m)
    if d and not d.endswith(\(aqis not available.\(aq):
        # mkdir m
        #directory = os.path.dirname(file_path)
        if not os.path.exists(m):
            os.makedirs(m)
        with open(m + \(aq/README.md\(aq,\(aqwb\(aq) as f:
            f.write(d)
        print(\(aqADDED: \(aq + m + \(aq/README.md\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once the master has a collection of all the README files.
You can use pandoc to create HTML versions of the markdown.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# process all the readme.md files to readme.html
if which pandoc; then echo \(dqFound pandoc\(dq; else echo \(dq** Missing pandoc\(dq; exit 1; fi
if which gs; then echo \(dqFound gs\(dq; else echo \(dq** Missing gs(ghostscript)\(dq; exit 1; fi
readme_files=$(find $dest \-type f \-path \(dq*/README.md\(dq \-print)
for f in $readme_files ; do
    ff=${f#$dest/}
    minion=${ff%%/*}
    echo \(dqprocess: $dest/${minion}/$(basename $f)\(dq
    cat $dest/${minion}/$(basename $f) |             pandoc \-\-standalone \-\-from markdown_github \-\-to html             \-\-include\-in\-header $dest/style.html             > $dest/${minion}/$(basename $f).html
done
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is also nice to put the help files in source control.
.INDENT 0.0
.INDENT 3.5
# git init
git add \-A
git commit \-am \(aqupdated docs\(aq
git push \-f
.UNINDENT
.UNINDENT
.SS Other hints
.sp
If you wish to customize the document format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# you could also create a new \(gaprocessor\(ga for perhaps reStructuredText
# highstate_doc.config:
#     processor: doc_custom.processor_rst

# example \(gasalt://makereadme.jinja\(ga
\(dq\(dq\(dq
{{opts[\(aqid\(aq]}}
==========================================

{# lowstates is set from highstate_doc.render() #}
{# if lowstates is missing use salt.highstate_doc.process_lowstates() #}
{% for s in lowstates %}
{{s.id}}
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
{{s.function}}

{{s.markdown.requisite}}
{{s.markdown.details}}

{%\- endfor %}
\(dq\(dq\(dq

# example \(gasalt://makereadme.sls\(ga
{% import_text \(dqmakereadme.jinja\(dq as makereadme %}
{{sls}} or:
    file.managed:
        \- name: /root/README_other.md
        \- contents: {{salt.highstate_doc.render(jinja_template_text=makereadme)|json}}
        \- mode: \(aq0640\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Some \fIreplace_text_regex\fP values that might be helpful:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
CERTS
\-\-\-\-\-

\(ga\(ga\(aq\-\-\-\-\-BEGIN RSA PRIVATE KEY\-\-\-\-\-[\er\en\et\ef\eS]{0,2200}\(aq: \(aqXXXXXXX\(aq\(ga\(ga
\(ga\(ga\(aq\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-[\er\en\et\ef\eS]{0,2200}\(aq: \(aqXXXXXXX\(aq\(ga\(ga
\(ga\(ga\(aq\-\-\-\-\-BEGIN DH PARAMETERS\-\-\-\-\-[\er\en\et\ef\eS]{0,2200}\(aq: \(aqXXXXXXX\(aq\(ga\(ga
\(ga\(ga\(aq\-\-\-\-\-BEGIN PRIVATE KEY\-\-\-\-\-[\er\en\et\ef\eS]{0,2200}\(aq: \(aqXXXXXXX\(aq\(ga\(ga
\(ga\(ga\(aq\-\-\-\-\-BEGIN OPENSSH PRIVATE KEY\-\-\-\-\-[\er\en\et\ef\eS]{0,2200}\(aq: \(aqXXXXXXX\(aq\(ga\(ga
\(ga\(ga\(aqssh\-rsa .* \(aq: \(aqssh\-rsa XXXXXXX \(aq\(ga\(ga
\(ga\(ga\(aqssh\-dss .* \(aq: \(aqssh\-dss XXXXXXX \(aq\(ga\(ga

DB
\-\-

\(ga\(ga\(aqDB_PASS.*\(aq: \(aqDB_PASS = XXXXXXX\(aq\(ga\(ga
\(ga\(ga\(aq5432:*:*:.*\(aq: \(aq5432:*:XXXXXXX\(aq\(ga\(ga
\(ga\(ga\(dq\(aqPASSWORD\(aq: .*\(dq: \(dq\(aqPASSWORD\(aq: \(aqXXXXXXX\(aq,\(dq\(ga\(ga
\(ga\(ga\(dq PASSWORD \(aq.*\(aq\(dq: \(dq PASSWORD \(aqXXXXXXX\(aq\(dq\(ga\(ga
\(ga\(ga\(aqPGPASSWORD=.* \(aq: \(aqPGPASSWORD=XXXXXXX\(aq\(ga\(ga
\(ga\(ga\(dq_replication password \(aq.*\(aq\(dq:  \(dq_replication password \(aqXXXXXXX\(aq\(dq\(ga\(ga

OTHER
\-\-\-\-\-

\(ga\(ga\(aqEMAIL_HOST_PASSWORD =.*\(aq: \(aqEMAIL_HOST_PASSWORD =XXXXXXX\(aq\(ga\(ga
\(ga\(ga\(dqnet ads join \-U \(aq.*@MFCFADS.MATH.EXAMPLE.CA.* \(dq: \(dqnet ads join \-U \(aq.*@MFCFADS.MATH.EXAMPLE.CA%XXXXXXX \(dq\(ga\(ga
\(ga\(ga\(dqnet ads join \-U \(aq.*@NEXUS.EXAMPLE.CA.* \(dq: \(dqnet ads join \-U \(aq.*@NEXUS.EXAMPLE.CA%XXXXXXX \(dq\(ga\(ga
\(ga\(ga\(aqinstall\-uptrack .* \-\-autoinstall\(aq: \(aqinstall\-uptrack XXXXXXX \-\-autoinstall\(aq\(ga\(ga
\(ga\(ga\(aqaccesskey = .*\(aq: \(aqaccesskey = XXXXXXX\(aq\(ga\(ga
\(ga\(ga\(aqauth_pass .*\(aq: \(aqauth_pass XXXXXXX\(aq\(ga\(ga
\(ga\(ga\(aqPSK \(dq0x.*\(aq: \(aqPSK \(dq0xXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\(aq\(ga\(ga
\(ga\(ga\(aqSECRET_KEY.*\(aq: \(aqSECRET_KEY = XXXXXXX\(aq\(ga\(ga
\(ga\(ga\(dqpassword=.*\(dq: \(dqpassword=XXXXXXX\(dq\(ga\(ga
\(ga\(ga\(aq<password>.*</password>\(aq: \(aq<password>XXXXXXX</password>\(aq\(ga\(ga
\(ga\(ga\(aq<salt>.*</salt>\(aq: \(aq<salt>XXXXXXX</salt>\(aq\(ga\(ga
\(ga\(ga\(aqapplication.secret = \(dq.*\(dq\(aq: \(aqapplication.secret = \(dqXXXXXXX\(dq\(aq\(ga\(ga
\(ga\(ga\(aqurl = \(dqpostgres://.*\(dq\(aq: \(aqurl = \(dqpostgres://XXXXXXX\(dq\(aq\(ga\(ga
\(ga\(ga\(aqPASS_.*_PASS\(aq: \(aqPASS_XXXXXXX_PASS\(aq\(ga\(ga

HTACCESS
\-\-\-\-\-\-\-\-

\(ga\(ga\(aq:{PLAIN}.*\(aq: \(aq:{PLAIN}XXXXXXX\(aq\(ga\(ga
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.highstate_doc.markdown_basic_jinja_template(**kwargs)
Return text for a simple markdown jinja template
.sp
This function can be used from the \fIhighstate_doc.render\fP modules \fIjinja_template_function\fP option.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.highstate_doc.markdown_default_jinja_template(**kwargs)
Return text for a markdown jinja template that included a header
.sp
This function can be used from the \fIhighstate_doc.render\fP modules \fIjinja_template_function\fP option.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.highstate_doc.markdown_full_jinja_template(**kwargs)
Return text for an advanced markdown jinja template
.sp
This function can be used from the \fIhighstate_doc.render\fP modules \fIjinja_template_function\fP option.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.highstate_doc.process_lowstates(**kwargs)
return processed lowstate data that was not blacklisted
.sp
render_module_function is used to provide your own.
defaults to from_lowstate
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.highstate_doc.processor_markdown(lowstate_item, config, **kwargs)
Takes low state data and returns a dict of processed data
that is by default used in a jinja template when rendering a markdown highstate_doc.
.sp
This \fIlowstate_item_markdown\fP given a lowstate item, returns a dict like:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
vars:       # the raw lowstate_item that was processed
id:         # the \(aqid\(aq of the state.
id_full:    # combo of the state type and id \(dqstate: id\(dq
state:      # name of the salt state module
function:   # name of the state function
name:       # value of \(aqname:\(aq passed to the salt state module
state_function:    # the state name and function name
markdown:          # text data to describe a state
    requisites:    # requisite like [watch_in, require_in]
    details:       # state name, parameters and other details like file contents
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.highstate_doc.read_file(name)
output the contents of a file:
.sp
this is a workaround if the cp.push module does not work.
\fI\%https://github.com/saltstack/salt/issues/37133\fP
.sp
help the master output the contents of a document
that might be saved on the minions filesystem.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
#!/bin/python
import os
import salt.client
s = salt.client.LocalClient()
o = s.cmd(\(aq*\(aq, \(aqhighstate_doc.read_file\(aq, [\(aq/root/README.md\(aq])
for m in o:
    d = o.get(m)
    if d and not d.endswith(\(aqis not available.\(aq):
        # mkdir m
        #directory = os.path.dirname(file_path)
        if not os.path.exists(m):
            os.makedirs(m)
        with open(m + \(aq/README.md\(aq,\(aqwb\(aq) as fin:
            fin.write(d)
        print(\(aqADDED: \(aq + m + \(aq/README.md\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.highstate_doc.render(jinja_template_text=None, jinja_template_function=\(aqhighstate_doc.markdown_default_jinja_template\(aq, **kwargs)
Render highstate to a text format (default Markdown)
.sp
if \fIjinja_template_text\fP is not set, \fIjinja_template_function\fP is used.
.sp
jinja_template_text: jinja text that the render uses to create the document.
jinja_template_function: a salt module call that returns template text.
.INDENT 7.0
.TP
.B Options
highstate_doc.markdown_basic_jinja_template
highstate_doc.markdown_default_jinja_template
highstate_doc.markdown_full_jinja_template
.UNINDENT
.UNINDENT
.SS salt.modules.hosts
.sp
Manage the information in the hosts file
.INDENT 0.0
.TP
.B salt.modules.hosts.add_host(ip, alias)
Add a host to an existing entry, if the entry is not in place then create
it with the given host
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hosts.add_host <ip> <alias>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hosts.get_alias(ip)
Return the list of aliases associated with an ip
.sp
Aliases (host names) are returned in the order in which they
appear in the hosts file.  If there are no aliases associated with
the IP, an empty list is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hosts.get_alias <ip addr>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hosts.get_ip(host)
Return the ip associated with the named host
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hosts.get_ip <hostname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hosts.has_pair(ip, alias)
Return true if the alias is set
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hosts.has_pair <ip> <alias>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hosts.list_hosts()
Return the hosts found in the hosts file in this format:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<ip addr>\(aq: [\(aqalias1\(aq, \(aqalias2\(aq, ...]}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hosts.list_hosts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hosts.rm_host(ip, alias)
Remove a host entry from the hosts file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hosts.rm_host <ip> <alias>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hosts.set_comment(ip, comment)
Set the comment for a host to an existing entry,
if the entry is not in place then return False
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hosts.set_comment <ip> <comment>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.hosts.set_host(ip, alias, comment=None)
Set the host entry in the hosts file for the given ip, this will overwrite
any previous entry for the given ip
.sp
Changed in version 2016.3.0: If \fBalias\fP does not include any host names (it is the empty
string or contains only whitespace), all entries for the given
IP address are removed.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hosts.set_host <ip> <alias>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.http
.sp
Module for making various web calls. Primarily designed for webhooks and the
like, but also useful for basic http testing.
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B salt.modules.http.query(url, **kwargs)
New in version 2015.5.0.

.sp
Query a resource, and decode the return data
.sp
Passes through all the parameters described in the
\fI\%utils.http.query function\fP:
.INDENT 7.0
.TP
.B salt.utils.http.query(url, method=\(aqGET\(aq, params=None, data=None, data_file=None, header_dict=None, header_list=None, header_file=None, username=None, password=None, auth=None, decode=False, decode_type=\(aqauto\(aq, status=False, headers=False, text=False, cookies=None, cookie_jar=None, cookie_format=\(aqlwp\(aq, persist_session=False, session_cookie_jar=None, data_render=False, data_renderer=None, header_render=False, header_renderer=None, template_dict=None, test=False, test_url=None, node=\(aqminion\(aq, port=80, opts=None, backend=None, ca_bundle=None, verify_ssl=None, cert=None, text_out=None, headers_out=None, decode_out=None, stream=False, streaming_callback=None, header_callback=None, handle=False, agent=\(aqSalt/3007.1\(aq, hide_fields=None, raise_error=True, formdata=False, formdata_fieldname=None, formdata_filename=None, decode_body=True, **kwargs)
Query a resource, and decode the return data
.UNINDENT
.INDENT 7.0
.TP
.B raise_error
True
If \fBFalse\fP, and if a connection cannot be made, the error will be
suppressed and the body of the return will simply be \fBNone\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq http.query http://somelink.com/
salt \(aq*\(aq http.query http://somelink.com/ method=POST             params=\(aq{\(dqkey1\(dq: \(dqval1\(dq, \(dqkey2\(dq: \(dqval2\(dq}\(aq
salt \(aq*\(aq http.query http://somelink.com/ method=POST             data=\(aq<xml>somecontent</xml>\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.http.update_ca_bundle(target=None, source=None, merge_files=None)
Update the local CA bundle file from a URL
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq http.update_ca_bundle
salt \(aq*\(aq http.update_ca_bundle target=/path/to/cacerts.pem
salt \(aq*\(aq http.update_ca_bundle source=https://example.com/cacerts.pem
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the \fBtarget\fP is not specified, it will be pulled from the \fBca_cert\fP
configuration variable available to the minion. If it cannot be found there,
it will be placed at \fB<<FILE_ROOTS>>/cacerts.pem\fP\&.
.sp
If the \fBsource\fP is not specified, it will be pulled from the
\fBca_cert_url\fP configuration variable available to the minion. If it cannot
be found, it will be downloaded from the cURL website, using an http (not
https) URL. USING THE DEFAULT URL SHOULD BE AVOIDED!
.sp
\fBmerge_files\fP may also be specified, which includes a string or list of
strings representing a file or files to be appended to the end of the CA
bundle, once it is downloaded.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq http.update_ca_bundle merge_files=/path/to/mycert.pem
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.http.wait_for_successful_query(url, wait_for=300, **kwargs)
Query a resource until a successful response, and decode the return data
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq http.wait_for_successful_query http://somelink.com/ wait_for=160 request_interval=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.icinga2
.sp
Module to provide icinga2 compatibility to salt.
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
icinga2 server
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.icinga2.generate_cert(domain)
Generate an icinga2 client certificate and key.
.INDENT 7.0
.TP
.B Returns::
icinga2 pki new\-cert \-\-cn domain.tld \-\-key /etc/icinga2/pki/domain.tld.key \-\-cert /etc/icinga2/pki/domain.tld.crt
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq icinga2.generate_cert domain.tld
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.icinga2.generate_ticket(domain)
Generate and save an icinga2 ticket.
.INDENT 7.0
.TP
.B Returns::
icinga2 pki ticket \-\-cn domain.tld
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq icinga2.generate_ticket domain.tld
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.icinga2.node_setup(domain, master, ticket)
Setup the icinga2 node.
.INDENT 7.0
.TP
.B Returns::
icinga2 node setup \-\-ticket TICKET_ID \-\-endpoint master.domain.tld \-\-zone domain.tld \-\-master_host master.domain.tld \-\-trustedcert                 /etc/icinga2/pki/trusted\-master.crt
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq icinga2.node_setup domain.tld master.domain.tld TICKET_ID
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.icinga2.request_cert(domain, master, ticket, port)
Request CA cert from master icinga2 node.
.INDENT 7.0
.TP
.B Returns::
icinga2 pki request \-\-host master.domain.tld \-\-port 5665 \-\-ticket TICKET_ID \-\-key /etc/icinga2/pki/domain.tld.key \-\-cert /etc/icinga2/pki/domain.tld.crt \-\-trustedcert                 /etc/icinga2/pki/trusted\-master.crt \-\-ca /etc/icinga2/pki/ca.crt
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq icinga2.request_cert domain.tld master.domain.tld TICKET_ID
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.icinga2.save_cert(domain, master)
Save the certificate for master icinga2 node.
.INDENT 7.0
.TP
.B Returns::
icinga2 pki save\-cert \-\-key /etc/icinga2/pki/domain.tld.key \-\-cert /etc/icinga2/pki/domain.tld.crt \-\-trustedcert /etc/icinga2/pki/trusted\-master.crt \-\-host master.domain.tld
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq icinga2.save_cert domain.tld master.domain.tld
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.idem
.SS Idem Support
.sp
This module provides access to idem execution modules
.sp
New in version 3002.

.INDENT 0.0
.TP
.B salt.modules.idem.exec_(path, acct_file=None, acct_key=None, acct_profile=None, *args, **kwargs)
Call an idem execution module
.INDENT 7.0
.TP
.B path
The idem path of the idem execution module to run
.TP
.B acct_file
Path to the acct file used in generating idem ctx parameters.
Defaults to the value in the ACCT_FILE environment variable.
.TP
.B acct_key
Key used to decrypt the acct file.
Defaults to the value in the ACCT_KEY environment variable.
.TP
.B acct_profile
Name of the profile to add to idem\(aqs ctx.acct parameter.
Defaults to the value in the ACCT_PROFILE environment variable.
.TP
.B args
Any positional arguments to pass to the idem exec function
.TP
.B kwargs
Any keyword arguments to pass to the idem exec function
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq idem.exec test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Maturity
new
.TP
.B Depends
acct, pop, pop\-config, idem
.TP
.B Platform
all
.UNINDENT
.UNINDENT
.SS salt.modules.ifttt
.sp
Support for IFTTT
.sp
New in version 2015.8.0.

.sp
Requires an \fBapi_key\fP in \fB/etc/salt/minion\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ifttt:
  secret_key: \(aq280d4699\-a817\-4719\-ba6f\-ca56e573e44f\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ifttt.trigger_event(event=None, **kwargs)
Trigger a configured event in IFTTT.
.INDENT 7.0
.TP
.B Parameters
\fBevent\fP \-\- The name of the event to trigger.
.TP
.B Returns
A dictionary with status, text, and error if result was failure.
.UNINDENT
.UNINDENT
.SS salt.modules.ilo
.sp
Manage HP ILO
.INDENT 0.0
.TP
.B depends
hponcfg (SmartStart Scripting Toolkit Linux Edition)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.change_password(username, password)
Reset a users password
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.change_password damianMyerscough
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.change_username(old_username, new_username)
Change a username
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.change_username damian diana
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.configure_network(ip, netmask, gateway)
Configure Network Interface
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.configure_network [IP ADDRESS] [NETMASK] [GATEWAY]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.configure_snmp(community, snmp_port=161, snmp_trapport=161)
Configure SNMP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.configure_snmp [COMMUNITY STRING] [SNMP PORT] [SNMP TRAP PORT]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.create_user(name, password, *privileges)
Create user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.create_user damian secretagent VIRTUAL_MEDIA_PRIV
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If no permissions are specify the user will only have a read\-only account.
.sp
Supported privelges:
.INDENT 7.0
.IP \(bu 2
ADMIN_PRIV
Enables the user to administer user accounts.
.IP \(bu 2
REMOTE_CONS_PRIV
Enables the user to access the Remote Console functionality.
.IP \(bu 2
RESET_SERVER_PRIV
Enables the user to remotely manipulate the server power setting.
.IP \(bu 2
VIRTUAL_MEDIA_PRIV
Enables the user permission to access the virtual media functionality.
.IP \(bu 2
CONFIG_ILO_PRIV
Enables the user to configure iLO settings.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.delete_ssh_key(username)
Delete a users SSH key from the ILO
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.delete_user_sshkey damian
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.delete_user(username)
Delete a user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.delete_user damian
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.disable_dhcp()
Disable DHCP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.disable_dhcp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.disable_ssh()
Disable the SSH daemon
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.disable_ssh
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.enable_dhcp()
Enable DHCP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.enable_dhcp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.enable_ssh()
Enable the SSH daemon
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.enable_ssh
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.get_user(username)
Returns local user information, excluding the password
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.get_user damian
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.global_settings()
Show global settings
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.global_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.list_users()
List all users
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.list_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.list_users_info()
List all users in detail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.list_users_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.network()
Grab the current network settings
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.network
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.set_http_port(port=80)
Configure the port HTTP should listen on
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.set_http_port 8080
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.set_https_port(port=443)
Configure the port HTTPS should listen on
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.set_https_port 4334
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.set_ssh_key(public_key)
Configure SSH public keys for specific users
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.set_ssh_key \(dqssh\-dss AAAAB3NzaC1kc3MAAACBA... damian\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The SSH public key needs to be DSA and the last argument in the key needs
to be the username (case\-senstive) of the ILO username.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ilo.set_ssh_port(port=22)
Enable SSH on a user defined port
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ilo.set_ssh_port 2222
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.incron
.sp
Work with incron
.INDENT 0.0
.TP
.B salt.modules.incron.list_tab(user)
Return the contents of the specified user\(aqs incrontab
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq incron.list_tab root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.incron.ls(user)
This function is an alias of \fBlist_tab\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the contents of the specified user\(aqs incrontab
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq incron.list_tab root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.incron.raw_incron(user)
Return the contents of the user\(aqs incrontab
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq incron.raw_incron root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.incron.raw_system_incron()
Return the contents of the system wide incrontab
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq incron.raw_system_incron
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.incron.rm(user, path, mask, cmd)
This function is an alias of \fBrm_job\fP\&.
.INDENT 7.0
.INDENT 3.5
Remove a incron job for a specified user. If any of the day/time params are
specified, the job will only be removed if the specified params match.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq incron.rm_job root /path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.incron.rm_job(user, path, mask, cmd)
Remove a incron job for a specified user. If any of the day/time params are
specified, the job will only be removed if the specified params match.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq incron.rm_job root /path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.incron.set_job(user, path, mask, cmd)
Sets an incron job up for a specified user.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq incron.set_job root \(aq/root\(aq \(aqIN_MODIFY\(aq \(aqecho \(dq$$ $@ $# $% $&\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.incron.write_incron_file(user, path)
Writes the contents of a file to a user\(aqs incrontab
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq incron.write_incron_file root /tmp/new_incron
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.incron.write_incron_file_verbose(user, path)
Writes the contents of a file to a user\(aqs incrontab and return error message on error
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq incron.write_incron_file_verbose root /tmp/new_incron
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.influxdb08mod
.sp
InfluxDB \- A distributed time series database
.sp
Module to provide InfluxDB compatibility to Salt (compatible with InfluxDB
version 0.5\-0.8)
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
influxdb Python module (>= 1.0.0)
.UNINDENT
.TP
.B configuration
This module accepts connection configuration details either as
parameters or as configuration settings in /etc/salt/minion on the relevant
minions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
influxdb08.host: \(aqlocalhost\(aq
influxdb08.port: 8086
influxdb08.user: \(aqroot\(aq
influxdb08.password: \(aqroot\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This data can also be passed into pillar. Options passed into opts will
overwrite options passed into pillar.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdb08mod.db_create(name, user=None, password=None, host=None, port=None)
Create a database
.INDENT 7.0
.TP
.B name
Database name to create
.TP
.B user
The user to connect as
.TP
.B password
The password of the user
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb08.db_create <name>
salt \(aq*\(aq influxdb08.db_create <name> <user> <password> <host> <port>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdb08mod.db_exists(name, user=None, password=None, host=None, port=None)
Checks if a database exists in Influxdb
.INDENT 7.0
.TP
.B name
Database name to create
.TP
.B user
The user to connect as
.TP
.B password
The password of the user
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb08.db_exists <name>
salt \(aq*\(aq influxdb08.db_exists <name> <user> <password> <host> <port>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdb08mod.db_list(user=None, password=None, host=None, port=None)
List all InfluxDB databases
.INDENT 7.0
.TP
.B user
The user to connect as
.TP
.B password
The password of the user
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb08.db_list
salt \(aq*\(aq influxdb08.db_list <user> <password> <host> <port>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdb08mod.db_remove(name, user=None, password=None, host=None, port=None)
Remove a database
.INDENT 7.0
.TP
.B name
Database name to remove
.TP
.B user
The user to connect as
.TP
.B password
The password of the user
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb08.db_remove <name>
salt \(aq*\(aq influxdb08.db_remove <name> <user> <password> <host> <port>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdb08mod.login_test(name, password, database=None, host=None, port=None)
Checks if a credential pair can log in at all.
.sp
If a database is specified: it will check for database user existence.
If a database is not specified: it will check for cluster admin existence.
.INDENT 7.0
.TP
.B name
The user to connect as
.TP
.B password
The password of the user
.TP
.B database
The database to try to log in to
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb08.login_test <name>
salt \(aq*\(aq influxdb08.login_test <name> <database>
salt \(aq*\(aq influxdb08.login_test <name> <database> <user> <password> <host> <port>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdb08mod.query(database, query, time_precision=\(aqs\(aq, chunked=False, user=None, password=None, host=None, port=None)
Querying data
.INDENT 7.0
.TP
.B database
The database to query
.TP
.B query
Query to be executed
.TP
.B time_precision
Time precision to use (\(aqs\(aq, \(aqm\(aq, or \(aqu\(aq)
.TP
.B chunked
Whether is chunked or not
.TP
.B user
The user to connect as
.TP
.B password
The password of the user
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb08.query <database> <query>
salt \(aq*\(aq influxdb08.query <database> <query> <time_precision> <chunked> <user> <password> <host> <port>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdb08mod.retention_policy_add(database, name, duration, replication, default=False, user=None, password=None, host=None, port=None)
Add a retention policy.
.INDENT 7.0
.TP
.B database
The database to operate on.
.TP
.B name
Name of the policy to modify.
.TP
.B duration
How long InfluxDB keeps the data.
.TP
.B replication
How many copies of the data are stored in the cluster.
.TP
.B default
Whether this policy should be the default or not. Default is False.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.retention_policy_add metrics default 1d 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdb08mod.retention_policy_alter(database, name, duration, replication, default=False, user=None, password=None, host=None, port=None)
Modify an existing retention policy.
.INDENT 7.0
.TP
.B database
The database to operate on.
.TP
.B name
Name of the policy to modify.
.TP
.B duration
How long InfluxDB keeps the data.
.TP
.B replication
How many copies of the data are stored in the cluster.
.TP
.B default
Whether this policy should be the default or not. Default is False.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb08.retention_policy_modify metrics default 1d 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdb08mod.retention_policy_exists(database, name, user=None, password=None, host=None, port=None)
Check if a retention policy exists.
.INDENT 7.0
.TP
.B database
The database to operate on.
.TP
.B name
Name of the policy to modify.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb08.retention_policy_exists metrics default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdb08mod.retention_policy_get(database, name, user=None, password=None, host=None, port=None)
Get an existing retention policy.
.INDENT 7.0
.TP
.B database
The database to operate on.
.TP
.B name
Name of the policy to modify.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb08.retention_policy_get metrics default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdb08mod.user_chpass(name, passwd, database=None, user=None, password=None, host=None, port=None)
Change password for a cluster admin or a database user.
.sp
If a database is specified: it will update database user password.
If a database is not specified: it will update cluster admin password.
.INDENT 7.0
.TP
.B name
User name for whom to change the password
.TP
.B passwd
New password
.TP
.B database
The database on which to operate
.TP
.B user
The user to connect as
.TP
.B password
The password of the user
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb08.user_chpass <name> <passwd>
salt \(aq*\(aq influxdb08.user_chpass <name> <passwd> <database>
salt \(aq*\(aq influxdb08.user_chpass <name> <passwd> <database> <user> <password> <host> <port>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdb08mod.user_create(name, passwd, database=None, user=None, password=None, host=None, port=None)
Create a cluster admin or a database user.
.sp
If a database is specified: it will create database user.
If a database is not specified: it will create a cluster admin.
.INDENT 7.0
.TP
.B name
User name for the new user to create
.TP
.B passwd
Password for the new user to create
.TP
.B database
The database to create the user in
.TP
.B user
The user to connect as
.TP
.B password
The password of the user
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb08.user_create <name> <passwd>
salt \(aq*\(aq influxdb08.user_create <name> <passwd> <database>
salt \(aq*\(aq influxdb08.user_create <name> <passwd> <database> <user> <password> <host> <port>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdb08mod.user_exists(name, database=None, user=None, password=None, host=None, port=None)
Checks if a cluster admin or database user exists.
.sp
If a database is specified: it will check for database user existence.
If a database is not specified: it will check for cluster admin existence.
.INDENT 7.0
.TP
.B name
User name
.TP
.B database
The database to check for the user to exist
.TP
.B user
The user to connect as
.TP
.B password
The password of the user
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb08.user_exists <name>
salt \(aq*\(aq influxdb08.user_exists <name> <database>
salt \(aq*\(aq influxdb08.user_exists <name> <database> <user> <password> <host> <port>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdb08mod.user_list(database=None, user=None, password=None, host=None, port=None)
List cluster admins or database users.
.sp
If a database is specified: it will return database users list.
If a database is not specified: it will return cluster admins list.
.INDENT 7.0
.TP
.B database
The database to list the users from
.TP
.B user
The user to connect as
.TP
.B password
The password of the user
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb08.user_list
salt \(aq*\(aq influxdb08.user_list <database>
salt \(aq*\(aq influxdb08.user_list <database> <user> <password> <host> <port>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdb08mod.user_remove(name, database=None, user=None, password=None, host=None, port=None)
Remove a cluster admin or a database user.
.sp
If a database is specified: it will remove the database user.
If a database is not specified: it will remove the cluster admin.
.INDENT 7.0
.TP
.B name
User name to remove
.TP
.B database
The database to remove the user from
.TP
.B user
User name for the new user to delete
.TP
.B user
The user to connect as
.TP
.B password
The password of the user
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb08.user_remove <name>
salt \(aq*\(aq influxdb08.user_remove <name> <database>
salt \(aq*\(aq influxdb08.user_remove <name> <database> <user> <password> <host> <port>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.influxdbmod
.sp
InfluxDB \- A distributed time series database
.sp
Module to provide InfluxDB compatibility to Salt (compatible with InfluxDB
version 0.9+)
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
influxdb Python module (>= 3.0.0)
.UNINDENT
.TP
.B configuration
This module accepts connection configuration details either as
parameters or as configuration settings in /etc/salt/minion on the relevant
minions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
influxdb.host: \(aqlocalhost\(aq
influxdb.port: 8086
influxdb.user: \(aqroot\(aq
influxdb.password: \(aqroot\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This data can also be passed into pillar. Options passed into opts will
overwrite options passed into pillar.
.sp
Most functions in this module allow you to override or provide some or all
of these settings via keyword arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.foo_function influxdb_user=\(aqinfluxadmin\(aq influxdb_password=\(aqs3cr1t\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
would override \fBuser\fP and \fBpassword\fP while still using the defaults for
\fBhost\fP and \fBport\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.alter_retention_policy(database, name, duration, replication, default=False, **client_args)
Modify an existing retention policy.
.INDENT 7.0
.TP
.B name
Name of the retention policy to modify.
.TP
.B database
Name of the database for which the retention policy was defined.
.TP
.B duration
New duration of given retention policy.
.sp
Durations such as 1h, 90m, 12h, 7d, and 4w, are all supported
and mean 1 hour, 90 minutes, 12 hours, 7 day, and 4 weeks,
respectively. For infinite retention – meaning the data will
never be deleted – use \(aqINF\(aq for duration.
The minimum retention period is 1 hour.
.TP
.B replication
New replication of given retention policy.
.sp
This determines how many independent copies of each data point are
stored in a cluster.
.TP
.B default
False
Whether or not to set the modified policy as default.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.alter_retention_policy metrics default 1d 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.continuous_query_exists(database, name, **client_args)
Check if continuous query with given name exists on the database.
.INDENT 7.0
.TP
.B database
Name of the database for which the continuous query was
defined.
.TP
.B name
Name of the continuous query to check.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.continuous_query_exists metrics default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.create_continuous_query(database, name, query, resample_time=None, coverage_period=None, **client_args)
Create a continuous query.
.INDENT 7.0
.TP
.B database
Name of the database for which the continuous query will be
created on.
.TP
.B name
Name of the continuous query to create.
.TP
.B query
The continuous query string.
.TP
.B resample_time
None
Duration between continuous query resampling.
.TP
.B coverage_period
None
Duration specifying time period per sample.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.create_continuous_query mydb cq_month \(aqSELECT mean(*) INTO mydb.a_month.:MEASUREMENT FROM mydb.a_week./.*/ GROUP BY time(5m), *\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.create_db(name, **client_args)
Create a database.
.INDENT 7.0
.TP
.B name
Name of the database to create.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.create_db <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.create_retention_policy(database, name, duration, replication, default=False, **client_args)
Create a retention policy.
.INDENT 7.0
.TP
.B database
Name of the database for which the retention policy will be created.
.TP
.B name
Name of the new retention policy.
.TP
.B duration
Duration of the new retention policy.
.sp
Durations such as 1h, 90m, 12h, 7d, and 4w, are all supported and mean
1 hour, 90 minutes, 12 hours, 7 day, and 4 weeks, respectively. For
infinite retention – meaning the data will never be deleted – use \(aqINF\(aq
for duration. The minimum retention period is 1 hour.
.TP
.B replication
Replication factor of the retention policy.
.sp
This determines how many independent copies of each data point are
stored in a cluster.
.TP
.B default
False
Whether or not the policy as default will be set as default.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.create_retention_policy metrics default 1d 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.create_user(name, passwd, admin=False, **client_args)
Create a user.
.INDENT 7.0
.TP
.B name
Name of the user to create.
.TP
.B passwd
Password of the new user.
.TP
.B admin
False
Whether the user should have cluster administration
privileges or not.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.create_user <name> <password>
salt \(aq*\(aq influxdb.create_user <name> <password> admin=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.db_exists(name, **client_args)
Checks if a database exists in InfluxDB.
.INDENT 7.0
.TP
.B name
Name of the database to check.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.db_exists <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.drop_continuous_query(database, name, **client_args)
Drop a continuous query.
.INDENT 7.0
.TP
.B database
Name of the database for which the continuous query will
be drop from.
.TP
.B name
Name of the continuous query to drop.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.drop_continuous_query mydb my_cq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.drop_db(name, **client_args)
Drop a database.
.INDENT 7.0
.TP
.B name
Name of the database to drop.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.drop_db <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.drop_retention_policy(database, name, **client_args)
Drop a retention policy.
.INDENT 7.0
.TP
.B database
Name of the database for which the retention policy will be dropped.
.TP
.B name
Name of the retention policy to drop.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.drop_retention_policy mydb mypr
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.get_continuous_query(database, name, **client_args)
Get an existing continuous query.
.INDENT 7.0
.TP
.B database
Name of the database for which the continuous query was
defined.
.TP
.B name
Name of the continuous query to get.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.get_continuous_query mydb cq_month
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.get_retention_policy(database, name, **client_args)
Get an existing retention policy.
.INDENT 7.0
.TP
.B database
Name of the database for which the retention policy was
defined.
.TP
.B name
Name of the retention policy.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.get_retention_policy metrics default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.grant_admin_privileges(name, **client_args)
Grant cluster administration privileges to a user.
.INDENT 7.0
.TP
.B name
Name of the user to whom admin privileges will be granted.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.grant_admin_privileges <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.grant_privilege(database, privilege, username, **client_args)
Grant a privilege on a database to a user.
.INDENT 7.0
.TP
.B database
Name of the database to grant the privilege on.
.TP
.B privilege
Privilege to grant. Can be one of \(aqread\(aq, \(aqwrite\(aq or \(aqall\(aq.
.TP
.B username
Name of the user to grant the privilege to.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.list_dbs(**client_args)
List all InfluxDB databases.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.list_dbs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.list_privileges(name, **client_args)
List privileges from a user.
.INDENT 7.0
.TP
.B name
Name of the user from whom privileges will be listed.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.list_privileges <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.list_users(**client_args)
List all users.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.list_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.query(database, query, **client_args)
Execute a query.
.INDENT 7.0
.TP
.B database
Name of the database to query on.
.TP
.B query
InfluxQL query string.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.remove_user(name, **client_args)
Remove a user.
.INDENT 7.0
.TP
.B name
Name of the user to remove
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.remove_user <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.retention_policy_exists(database, name, **client_args)
Check if retention policy with given name exists.
.INDENT 7.0
.TP
.B database
Name of the database for which the retention policy was
defined.
.TP
.B name
Name of the retention policy to check.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.retention_policy_exists metrics default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.revoke_admin_privileges(name, **client_args)
Revoke cluster administration privileges from a user.
.INDENT 7.0
.TP
.B name
Name of the user from whom admin privileges will be revoked.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.revoke_admin_privileges <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.revoke_privilege(database, privilege, username, **client_args)
Revoke a privilege on a database from a user.
.INDENT 7.0
.TP
.B database
Name of the database to grant the privilege on.
.TP
.B privilege
Privilege to grant. Can be one of \(aqread\(aq, \(aqwrite\(aq or \(aqall\(aq.
.TP
.B username
Name of the user to grant the privilege to.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.set_user_password(name, passwd, **client_args)
Change password of a user.
.INDENT 7.0
.TP
.B name
Name of the user for whom to set the password.
.TP
.B passwd
New password of the user.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.set_user_password <name> <password>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.user_exists(name, **client_args)
Check if a user exists.
.INDENT 7.0
.TP
.B name
Name of the user to check.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.user_exists <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.influxdbmod.user_info(name, **client_args)
Get information about given user.
.INDENT 7.0
.TP
.B name
Name of the user for which to get information.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq influxdb.user_info <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.infoblox
.sp
This module have been tested on infoblox API v1.2.1,
other versions of the API are likly workable.
.INDENT 0.0
.TP
.B depends
libinfoblox, \fI\%https://github.com/steverweber/libinfoblox\fP
.sp
libinfoblox can be installed using \fIpip install libinfoblox\fP
.UNINDENT
.sp
API documents can be found on your infoblox server at:
.INDENT 0.0
.INDENT 3.5
\fI\%https://INFOBLOX/wapidoc\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B configuration
The following configuration defaults can be
defined (pillar or config files \(aq/etc/salt/master.d/infoblox.conf\(aq):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
infoblox.config:
    api_sslverify: True
    api_url: \(aqhttps://INFOBLOX/wapi/v1.2.1\(aq
    api_user: \(aqusername\(aq
    api_key: \(aqpassword\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Many of the functions accept \fIapi_opts\fP to override the API config.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.get_host name=my.host.com             api_url: \(aqhttps://INFOBLOX/wapi/v1.2.1\(aq             api_user=admin             api_key=passs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.create_a(data, **api_opts)
Create A record.
.sp
This is a helper function to \fIcreate_object\fP\&.
See your infoblox API for full \fIdata\fP format.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.create_a                     data =
            name: \(aqfastlinux.math.example.ca\(aq
            ipv4addr: \(aq127.0.0.1\(aq
            view: External
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.create_cname(data, **api_opts)
Create a cname record.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.create_cname data={             \(dqcomment\(dq: \(dqcname to example server\(dq,             \(dqname\(dq: \(dqexample.example.com\(dq,             \(dqzone\(dq: \(dqexample.com\(dq,             \(dqview\(dq: \(dqInternal\(dq,             \(dqcanonical\(dq: \(dqexample\-ha\-0.example.com\(dq         }
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.create_host(data, **api_opts)
Add host record
.sp
Avoid race conditions, use func:nextavailableip for ipv[4,6]addrs:
.INDENT 7.0
.IP \(bu 2
func:nextavailableip:network/ZG54dfgsrDFEFfsfsLzA:10.0.0.0/8/default
.IP \(bu 2
func:nextavailableip:10.0.0.0/8
.IP \(bu 2
func:nextavailableip:10.0.0.0/8,external
.IP \(bu 2
func:nextavailableip:10.0.0.3\-10.0.0.10
.UNINDENT
.sp
See your infoblox API for full \fIdata\fP format.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.create_host             data =
        {\(aqname\(aq: \(aqhostname.example.ca\(aq,
        \(aqaliases\(aq: [\(aqhostname.math.example.ca\(aq],
    \(aqextattrs\(aq: [{\(aqBusiness Contact\(aq: {\(aqvalue\(aq: \(aqexample@example.ca\(aq}},
        {\(aqPol8 Classification\(aq: {\(aqvalue\(aq: \(aqRestricted\(aq}},
        {\(aqPrimary OU\(aq: {\(aqvalue\(aq: \(aqCS\(aq}},
        {\(aqTechnical Contact\(aq: {\(aqvalue\(aq: \(aqexample@example.ca\(aq}}],
    \(aqipv4addrs\(aq: [{\(aqconfigure_for_dhcp\(aq: True,
        \(aqipv4addr\(aq: \(aqfunc:nextavailableip:129.97.139.0/24\(aq,
        \(aqmac\(aq: \(aq00:50:56:84:6e:ae\(aq}],
    \(aqipv6addrs\(aq: [], }
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.create_ipv4_range(data, **api_opts)
Create a ipv4 range
.sp
This is a helper function to \fIcreate_object\fP
See your infoblox API for full \fIdata\fP format.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.create_ipv4_range data={
    start_addr: \(aq129.97.150.160\(aq,
    end_addr: \(aq129.97.150.170\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.create_object(object_type, data, **api_opts)
Create raw infoblox object. This is a low level api call.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.update_object object_type=record:host  data={}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.delete_a(name=None, ipv4addr=None, allow_array=False, **api_opts)
Delete A record
.sp
If the A record is used as a round robin you can set \fBallow_array=True\fP to
delete all records for the hostname.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.delete_a name=abc.example.com
salt\-call infoblox.delete_a ipv4addr=192.168.3.5
salt\-call infoblox.delete_a name=acname.example.com allow_array=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.delete_cname(name=None, canonical=None, **api_opts)
Delete CNAME. This is a helper call to delete_object.
.sp
If record is not found, return True
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.delete_cname name=example.example.com
salt\-call infoblox.delete_cname canonical=example\-ha\-0.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.delete_host(name=None, mac=None, ipv4addr=None, **api_opts)
Delete host
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.delete_host name=example.domain.com
salt\-call infoblox.delete_host ipv4addr=123.123.122.12
salt\-call infoblox.delete_host ipv4addr=123.123.122.12 mac=00:50:56:84:6e:ae
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.delete_ipv4_range(start_addr=None, end_addr=None, **api_opts)
Delete ip range.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.delete_ipv4_range start_addr=123.123.122.12
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.delete_object(objref, **api_opts)
Delete infoblox object. This is a low level api call.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.delete_object objref=[ref_of_object]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.diff_objects(obja, objb)
Diff two complex infoblox objects.
This is used from salt states to detect changes in objects.
.sp
Using \fBfunc:nextavailableip\fP will not cause a diff if the ipaddress is in
range
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.get_a(name=None, ipv4addr=None, allow_array=True, **api_opts)
Get A record
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.get_a name=abc.example.com
salt\-call infoblox.get_a ipv4addr=192.168.3.5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.get_cname(name=None, canonical=None, return_fields=None, **api_opts)
Get CNAME information.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.get_cname name=example.example.com
salt\-call infoblox.get_cname canonical=example\-ha\-0.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.get_host(name=None, ipv4addr=None, mac=None, return_fields=None, **api_opts)
Get host information
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.get_host hostname.domain.ca
salt\-call infoblox.get_host ipv4addr=123.123.122.12
salt\-call infoblox.get_host mac=00:50:56:84:6e:ae
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.get_host_advanced(name=None, ipv4addr=None, mac=None, **api_opts)
Get all host information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.get_host_advanced hostname.domain.ca
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.get_host_domainname(name, domains=None, **api_opts)
Get host domain name
.sp
If no domains are passed, the hostname is checked for a zone in infoblox,
if no zone split on first dot.
.sp
If domains are provided, the best match out of the list is returned.
.sp
If none are found the return is None
.sp
dots at end of names are ignored.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call uwl.get_host_domainname name=localhost.t.domain.com             domains=[\(aqdomain.com\(aq, \(aqt.domain.com.\(aq]

# returns: t.domain.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.get_host_hostname(name, domains=None, **api_opts)
Get hostname
.sp
If no domains are passed, the hostname is checked for a zone in infoblox,
if no zone split on first dot.
.sp
If domains are provided, the best match out of the list is truncated from
the fqdn leaving the hostname.
.sp
If no matching domains are found the fqdn is returned.
.sp
dots at end of names are ignored.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.get_host_hostname fqdn=localhost.xxx.t.domain.com             domains=\(dq[\(aqdomain.com\(aq, \(aqt.domain.com\(aq]\(dq
#returns: localhost.xxx

salt\-call infoblox.get_host_hostname fqdn=localhost.xxx.t.domain.com
#returns: localhost
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.get_host_ipv4(name=None, mac=None, allow_array=False, **api_opts)
Get ipv4 address from host record.
.sp
Use \fIallow_array\fP to return possible multiple values.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.get_host_ipv4 host=localhost.domain.com
salt\-call infoblox.get_host_ipv4 mac=00:50:56:84:6e:ae
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.get_host_ipv4addr_info(ipv4addr=None, mac=None, discovered_data=None, return_fields=None, **api_opts)
Get host ipv4addr information
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.get_ipv4addr ipv4addr=123.123.122.12
salt\-call infoblox.get_ipv4addr mac=00:50:56:84:6e:ae
salt\-call infoblox.get_ipv4addr mac=00:50:56:84:6e:ae return_fields=host return_fields=\(aqmac,host,configure_for_dhcp,ipv4addr\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.get_host_ipv6addr_info(ipv6addr=None, mac=None, discovered_data=None, return_fields=None, **api_opts)
Get host ipv6addr information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.get_host_ipv6addr_info ipv6addr=2001:db8:85a3:8d3:1349:8a2e:370:7348
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.get_host_mac(name=None, allow_array=False, **api_opts)
Get mac address from host record.
.sp
Use \fIallow_array\fP to return possible multiple values.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.get_host_mac host=localhost.domain.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.get_ipv4_range(start_addr=None, end_addr=None, return_fields=None, **api_opts)
Get ip range
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.get_ipv4_range start_addr=123.123.122.12
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.get_network(ipv4addr=None, network=None, return_fields=None, **api_opts)
Get list of all networks. This is helpful when looking up subnets to use
with func:nextavailableip
.sp
This call is offen slow and not cached!
.sp
some return_fields
comment,network,network_view,ddns_domainname,disable,enable_ddns
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.get_network
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.get_object(objref, data=None, return_fields=None, max_results=None, ensure_none_or_one_result=False, **api_opts)
Get raw infoblox object. This is a low level api call.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.get_object objref=[_ref of object]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.is_ipaddr_in_ipfunc_range(ipaddr, ipfunc)
Return true if the ipaddress is in the range of the nextavailableip function
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.is_ipaddr_in_ipfunc_range             ipaddr=\(dq10.0.2.2\(dq ipfunc=\(dqfunc:nextavailableip:10.0.0.0/8\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.update_cname(name, data, **api_opts)
Update CNAME. This is a helper call to update_object.
.sp
Find a CNAME \fB_ref\fP then call update_object with the record data.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.update_cname name=example.example.com data=\(dq{
        \(aqcanonical\(aq:\(aqexample\-ha\-0.example.com\(aq,
        \(aquse_ttl\(aq:true,
        \(aqttl\(aq:200,
        \(aqcomment\(aq:\(aqSalt managed CNAME\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.update_host(name, data, **api_opts)
Update host record. This is a helper call to update_object.
.sp
Find a hosts \fB_ref\fP then call update_object with the record data.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.update_host name=fqdn data={}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.infoblox.update_object(objref, data, **api_opts)
Update raw infoblox object. This is a low level api call.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call infoblox.update_object objref=[ref_of_object] data={}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.ini_manage
.sp
Edit ini files
.INDENT 0.0
.TP
.B maintainer
<\fI\%akilesh1597@gmail.com\fP>
.TP
.B maturity
new
.TP
.B depends
re
.TP
.B platform
all
.UNINDENT
.sp
(for example /etc/sysctl.conf)
.INDENT 0.0
.TP
.B salt.modules.ini_manage.get_ini(file_name, separator=\(aq=\(aq, encoding=None)
Retrieve the whole structure from an ini file and return it as a dictionary.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfile_name\fP (\fI\%str\fP) \-\- The full path to the ini file.
.IP \(bu 2
\fBseparator\fP (\fI\%str\fP) \-\-
.sp
The character used to separate keys and values. Standard ini files
use the \(dq=\(dq character. The default is \fB=\fP\&.
.sp
New in version 2016.11.0.


.IP \(bu 2
\fBencoding\fP (\fI\%str\fP) \-\-
.sp
A string value representing encoding of the target ini file. If
\fBNone\fP is passed, it uses the system default which is likely
\fButf\-8\fP\&. Default is \fBNone\fP
.sp
New in version 3006.6.


.UNINDENT
.TP
.B Returns
.INDENT 7.0
.TP
.B A dictionary containing the sections along with the values and
names contained in each section
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
API Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.client
with salt.client.get_local_client() as sc:
    sc.cmd(\(aqtarget\(aq, \(aqini.get_ini\(aq, [path_to_ini_file])
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ini.get_ini /path/to/ini
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ini_manage.get_option(file_name, section, option, separator=\(aq=\(aq, encoding=None)
Get value of a key from a section in an ini file. Returns \fBNone\fP if
no matching key was found.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfile_name\fP (\fI\%str\fP) \-\- The full path to the ini file.
.IP \(bu 2
\fBsection\fP (\fI\%str\fP) \-\- A string value representing the section of the ini that the option
is in. If the option is not in a section, leave this empty.
.IP \(bu 2
\fBoption\fP (\fI\%str\fP) \-\- A string value representing the option to search for.
.IP \(bu 2
\fBseparator\fP (\fI\%str\fP) \-\-
.sp
The character used to separate keys and values. Standard ini files
use the \(dq=\(dq character. The default is \fB=\fP\&.
.sp
New in version 2016.11.0.


.IP \(bu 2
\fBencoding\fP (\fI\%str\fP) \-\-
.sp
A string value representing encoding of the target ini file. If
\fBNone\fP is passed, it uses the system default which is likely
\fButf\-8\fP\&. Default is \fBNone\fP
.sp
New in version 3006.6.


.UNINDENT
.TP
.B Returns
.INDENT 7.0
.TP
.B The value as defined in the ini file, or \fBNone\fP if empty or not
found
.UNINDENT

.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
API Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.client
with salt.client.get_local_client() as sc:
    sc.cmd(\(aqtarget\(aq, \(aqini.get_option\(aq, [path_to_ini_file, section_name, option])
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ini.get_option /path/to/ini section_name option_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ini_manage.get_section(file_name, section, separator=\(aq=\(aq, encoding=None)
Retrieve a section from an ini file. Returns the section as a dictionary. If
the section is not found, an empty dictionary is returned.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfile_name\fP (\fI\%str\fP) \-\- The full path to the ini file.
.IP \(bu 2
\fBsection\fP (\fI\%str\fP) \-\- A string value representing name of the section to search for.
.IP \(bu 2
\fBseparator\fP (\fI\%str\fP) \-\-
.sp
The character used to separate keys and values. Standard ini files
use the \(dq=\(dq character. The default is \fB=\fP\&.
.sp
New in version 2016.11.0.


.IP \(bu 2
\fBencoding\fP (\fI\%str\fP) \-\-
.sp
A string value representing encoding of the target ini file. If
\fBNone\fP is passed, it uses the system default which is likely
\fButf\-8\fP\&. Default is \fBNone\fP
.sp
New in version 3006.6.


.UNINDENT
.TP
.B Returns
.INDENT 7.0
.TP
.B A dictionary containing the names and values of all items in the
section of the ini file. If the section is not found, an empty
dictionary is returned
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
API Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.client
with salt.client.get_local_client() as sc:
    sc.cmd(\(aqtarget\(aq, \(aqini.get_section\(aq, [path_to_ini_file, section_name])
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ini.get_section /path/to/ini section_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ini_manage.remove_option(file_name, section, option, separator=\(aq=\(aq, encoding=None)
Remove a key/value pair from a section in an ini file. Returns the value of
the removed key, or \fBNone\fP if nothing was removed.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfile_name\fP (\fI\%str\fP) \-\- The full path to the ini file.
.IP \(bu 2
\fBsection\fP (\fI\%str\fP) \-\- A string value representing the section of the ini that the option
is in. If the option is not in a section, leave this empty.
.IP \(bu 2
\fBoption\fP (\fI\%str\fP) \-\- A string value representing the option to search for.
.IP \(bu 2
\fBseparator\fP (\fI\%str\fP) \-\-
.sp
The character used to separate keys and values. Standard ini files
use the \(dq=\(dq character. The default is \fB=\fP\&.
.sp
New in version 2016.11.0.


.IP \(bu 2
\fBencoding\fP (\fI\%str\fP) \-\-
.sp
A string value representing encoding of the target ini file. If
\fBNone\fP is passed, it uses the system default which is likely
\fButf\-8\fP\&. Default is \fBNone\fP
.sp
New in version 3006.6.


.UNINDENT
.TP
.B Returns
.INDENT 7.0
.TP
.B A string value representing the option that was removed or \fBNone\fP
if nothing was removed
.UNINDENT

.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
API Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt
sc = salt.client.get_local_client()
sc.cmd(\(aqtarget\(aq, \(aqini.remove_option\(aq, [path_to_ini_file, section_name, option])
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ini.remove_option /path/to/ini section_name option_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ini_manage.remove_section(file_name, section, separator=\(aq=\(aq, encoding=None)
Remove a section in an ini file. Returns the removed section as a
dictionary, or \fBNone\fP if nothing is removed.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfile_name\fP (\fI\%str\fP) \-\- The full path to the ini file.
.IP \(bu 2
\fBsection\fP (\fI\%str\fP) \-\- A string value representing the name of the section search for.
.IP \(bu 2
\fBseparator\fP (\fI\%str\fP) \-\-
.sp
The character used to separate keys and values. Standard ini files
use the \(dq=\(dq character. The default is \fB=\fP\&.
.sp
New in version 2016.11.0.


.IP \(bu 2
\fBencoding\fP (\fI\%str\fP) \-\-
.sp
A string value representing encoding of the target ini file. If
\fBNone\fP is passed, it uses the system default which is likely
\fButf\-8\fP\&. Default is \fBNone\fP
.sp
New in version 3006.6.


.UNINDENT
.TP
.B Returns
.INDENT 7.0
.TP
.B A dictionary containing the names and values of all items in the
section that was removed or \fBNone\fP if nothing was removed
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
API Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.client
with  salt.client.get_local_client() as sc:
    sc.cmd(\(aqtarget\(aq, \(aqini.remove_section\(aq, [path_to_ini_file, section_name])
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ini.remove_section /path/to/ini section_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ini_manage.set_option(file_name, sections=None, separator=\(aq=\(aq, encoding=None)
Edit an ini file, replacing one or more sections. Returns a dictionary
containing the changes made.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfile_name\fP (\fI\%str\fP) \-\- The full path to the ini file.
.IP \(bu 2
\fBsections\fP (\fI\%dict\fP) \-\- A dictionary representing the sections to be edited in the ini file.
The keys are the section names and the values are a dictionary
containing the options. If the ini file does not contain sections
the keys and values represent the options. The default is \fBNone\fP\&.
.IP \(bu 2
\fBseparator\fP (\fI\%str\fP) \-\-
.sp
The character used to separate keys and values. Standard ini files
use the \(dq=\(dq character. The default is \fB=\fP\&.
.sp
New in version 2016.11.0.


.IP \(bu 2
\fBencoding\fP (\fI\%str\fP) \-\-
.sp
A string value representing encoding of the target ini file. If
\fBNone\fP is passed, it uses the system default which is likely
\fButf\-8\fP\&. Default is \fBNone\fP
.sp
New in version 3006.6.


.UNINDENT
.TP
.B Returns
A dictionary representing the changes made to the ini file
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
API Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.client
with salt.client.get_local_client() as sc:
    sc.cmd(
        \(aqtarget\(aq, \(aqini.set_option\(aq, [\(aqpath_to_ini_file\(aq, \(aq{\(dqsection_to_change\(dq: {\(dqkey\(dq: \(dqvalue\(dq}}\(aq]
    )
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ini.set_option /path/to/ini \(aq{section_foo: {key: value}}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.inspectlib package
.SS Submodules
.SS salt.modules.inspectlib.collector
.INDENT 0.0
.TP
.B class  salt.modules.inspectlib.collector.Inspector(cachedir=None, piddir=None, pidfilename=None)
.INDENT 7.0
.TP
.B DEFAULT_MINION_CONFIG_PATH  =  \(aq/etc/salt/minion\(aq
.UNINDENT
.INDENT 7.0
.TP
.B IGNORE_FS_TYPES  =  [\(aqautofs\(aq, \(aqcifs\(aq, \(aqnfs\(aq, \(aqnfs4\(aq]
.UNINDENT
.INDENT 7.0
.TP
.B IGNORE_MOUNTS  =  [\(aqproc\(aq, \(aqsysfs\(aq, \(aqdevtmpfs\(aq, \(aqtmpfs\(aq, \(aqfuse.gvfs\-fuse\-daemon\(aq]
.UNINDENT
.INDENT 7.0
.TP
.B IGNORE_PATHS  =  [\(aq/tmp\(aq, \(aq/var/tmp\(aq, \(aq/lost+found\(aq, \(aq/var/run\(aq, \(aq/var/lib/rpm\(aq, \(aq/.snapshots\(aq, \(aq/.zfs\(aq, \(aq/etc/ssh\(aq, \(aq/root\(aq, \(aq/home\(aq]
.UNINDENT
.INDENT 7.0
.TP
.B MODE  =  [\(aqconfiguration\(aq, \(aqpayload\(aq, \(aqall\(aq]
.UNINDENT
.INDENT 7.0
.TP
.B build(format=\(aqqcow2\(aq, path=\(aq/tmp\(aq)
Build an image using Kiwi.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBformat\fP \-\-
.IP \(bu 2
\fBpath\fP \-\-
.UNINDENT
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B create_snapshot()
Open new snapshot.
.INDENT 7.0
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B export(description, local=False, path=\(aq/tmp\(aq, format=\(aqqcow2\(aq)
Export description for Kiwi.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBlocal\fP \-\-
.IP \(bu 2
\fBpath\fP \-\-
.UNINDENT
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B request_snapshot(mode, priority=19, **kwargs)
Take a snapshot of the system.
.UNINDENT
.INDENT 7.0
.TP
.B reuse_snapshot()
Open an existing, latest snapshot.
.INDENT 7.0
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B snapshot(mode)
Take a snapshot of the system.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.inspectlib.collector.is_alive(pidfile)
Check if PID is still alive.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.inspectlib.collector.main(dbfile, pidfile, mode)
Main analyzer routine.
.UNINDENT
.SS salt.modules.inspectlib.dbhandle
.INDENT 0.0
.TP
.B class  salt.modules.inspectlib.dbhandle.DBHandle(*args, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.inspectlib.dbhandle.DBHandleBase(path)
Handle for the \fIvolatile\fP database, which serves the purpose of caching
the inspected data. This database can be destroyed or corrupted, so it should
be simply re\-created from scratch.
.INDENT 7.0
.TP
.B close()
Close the database connection.
.UNINDENT
.INDENT 7.0
.TP
.B flush(table)
Flush the table.
.UNINDENT
.INDENT 7.0
.TP
.B open(new=False)
Init the database, if required.
.UNINDENT
.INDENT 7.0
.TP
.B purge()
Purge whole database.
.UNINDENT
.UNINDENT
.SS salt.modules.inspectlib.exceptions
.INDENT 0.0
.TP
.B exception  salt.modules.inspectlib.exceptions.InspectorKiwiProcessorException
Kiwi builder/exporter exception.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.modules.inspectlib.exceptions.InspectorQueryException
Exception that is only for the inspector query.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.modules.inspectlib.exceptions.InspectorSnapshotException
Snapshot exception.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.modules.inspectlib.exceptions.SIException
System information exception.
.UNINDENT
.SS salt.modules.inspectlib.query
.INDENT 0.0
.TP
.B class  salt.modules.inspectlib.query.Query(scope, cachedir=None)
Query the system.
This class is actually puts all Salt features together,
so there would be no need to pick it from various places.
.INDENT 7.0
.TP
.B SCOPES  =  [\(aqchanges\(aq, \(aqconfiguration\(aq, \(aqidentity\(aq, \(aqsystem\(aq, \(aqsoftware\(aq, \(aqservices\(aq, \(aqpayload\(aq, \(aqall\(aq]
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.inspectlib.query.SysInfo(systype)
System information.
.UNINDENT
.SS Module contents
.INDENT 0.0
.TP
.B class  salt.modules.inspectlib.EnvLoader(cachedir=None, piddir=None, pidfilename=None)
Load environment.
.INDENT 7.0
.TP
.B DB_FILE  =  \(aq_minion_collector.db\(aq
.UNINDENT
.INDENT 7.0
.TP
.B DEFAULT_CACHE_PATH  =  \(aq/var/cache/salt\(aq
.UNINDENT
.INDENT 7.0
.TP
.B DEFAULT_PID_PATH  =  \(aq/var/run\(aq
.UNINDENT
.INDENT 7.0
.TP
.B PID_FILE  =  \(aq_minion_collector.pid\(aq
.UNINDENT
.UNINDENT
.SS salt.modules.inspectlib.entities
.INDENT 0.0
.TP
.B class  salt.modules.inspectlib.entities.AllowedDir
Allowed directories
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.inspectlib.entities.IgnoredDir
Ignored directories
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.inspectlib.entities.Package
Package.
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.inspectlib.entities.PackageCfgFile
Config file, belongs to the package
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.inspectlib.entities.PayloadFile
Payload file.
.UNINDENT
.SS salt.modules.inspectlib.fsdb
.INDENT 0.0
.TP
.B codeauthor
Bo Maryniuk <\fI\%bo@suse.de\fP>
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.inspectlib.fsdb.CsvDB(path)
File\-based CSV database.
This database is in\-memory operating relatively small plain text csv files.
.INDENT 7.0
.TP
.B close()
Close the database.
.INDENT 7.0
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B create_table_from_object(obj)
Create a table from the object.
NOTE: This method doesn\(aqt stores anything.
.INDENT 7.0
.TP
.B Parameters
\fBobj\fP \-\-
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B delete(obj, matches=None, mt=None, lt=None, eq=None)
Delete object from the database.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBobj\fP \-\-
.IP \(bu 2
\fBmatches\fP \-\-
.IP \(bu 2
\fBmt\fP \-\-
.IP \(bu 2
\fBlt\fP \-\-
.IP \(bu 2
\fBeq\fP \-\-
.UNINDENT
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B flush(table)
Flush table.
.INDENT 7.0
.TP
.B Parameters
\fBtable\fP \-\-
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B get(obj, matches=None, mt=None, lt=None, eq=None)
Get objects from the table.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtable_name\fP \-\-
.IP \(bu 2
\fBmatches\fP \-\- Regexp.
.IP \(bu 2
\fBmt\fP \-\- More than.
.IP \(bu 2
\fBlt\fP \-\- Less than.
.IP \(bu 2
\fBeq\fP \-\- Equals.
.UNINDENT
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B is_closed()
Return if the database is closed.
.INDENT 7.0
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B list()
List all the databases on the given path.
.INDENT 7.0
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B list_tables()
Load existing tables and their descriptions.
.INDENT 7.0
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B new()
Create a new database and opens it.
.INDENT 7.0
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B open(dbname=None)
Open database from the path with the name or latest.
If there are no yet databases, create a new implicitly.
.INDENT 7.0
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B purge(dbid)
Purge the database.
.INDENT 7.0
.TP
.B Parameters
\fBdbid\fP \-\-
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B store(obj, distinct=False)
Store an object in the table.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBobj\fP \-\- An object to store
.IP \(bu 2
\fBdistinct\fP \-\- Store object only if there is none identical of such.
If at least one field is different, store it.
.UNINDENT
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B update(obj, matches=None, mt=None, lt=None, eq=None)
Update object(s) in the database.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBobj\fP \-\-
.IP \(bu 2
\fBmatches\fP \-\-
.IP \(bu 2
\fBmt\fP \-\-
.IP \(bu 2
\fBlt\fP \-\-
.IP \(bu 2
\fBeq\fP \-\-
.UNINDENT
.TP
.B Returns

.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.inspectlib.fsdb.CsvDBEntity
Serializable object for the table.
.UNINDENT
.SS salt.modules.inspectlib.kiwiproc
.INDENT 0.0
.TP
.B class  salt.modules.inspectlib.kiwiproc.KiwiExporter(grains, format)
Exports system description as Kiwi configuration.
.INDENT 7.0
.TP
.B export(name)
Export to the Kiwi config.xml as text.
.INDENT 7.0
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B load(**descr)
Load data by keys.
.INDENT 7.0
.TP
.B Parameters
\fBdata\fP \-\-
.TP
.B Returns

.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.inspector
.sp
Module for full system inspection.
.INDENT 0.0
.TP
.B salt.modules.inspector.build(format=\(aqqcow2\(aq, path=\(aq/tmp/\(aq)
Build an image from a current system description.
The image is a system image can be output in bootable ISO or QCOW2 formats.
.sp
Node uses the image building library Kiwi to perform the actual build.
.sp
Parameters:
.INDENT 7.0
.IP \(bu 2
\fBformat\fP: Specifies output format: \(dqqcow2\(dq or \(dqiso. Default: \fIqcow2\fP\&.
.IP \(bu 2
\fBpath\fP: Specifies output path where to store built image. Default: \fI/tmp\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion inspector.build
salt myminion inspector.build format=iso path=/opt/builds/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.inspector.delete(all=False, *databases)
Remove description snapshots from the system.
.sp
::parameter: all. Default: False. Remove all snapshots, if set to True.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion inspector.delete <ID> <ID1> <ID2>..
salt myminion inspector.delete all=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.inspector.export(local=False, path=\(aq/tmp\(aq, format=\(aqqcow2\(aq)
Export an image description for Kiwi.
.sp
Parameters:
.INDENT 7.0
.IP \(bu 2
\fBlocal\fP: Specifies True or False if the export has to be in the local file. Default: False.
.IP \(bu 2
.INDENT 2.0
.TP
\fBpath\fP: If \fIlocal=True\fP, then specifies the path where file with the Kiwi description is written.
Default: \fI/tmp\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion inspector.export
salt myminion inspector.export format=iso path=/opt/builds/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.inspector.inspect(mode=\(aqall\(aq, priority=19, **kwargs)
Start node inspection and save the data to the database for further query.
.sp
Parameters:
.INDENT 7.0
.IP \(bu 2
\fBmode\fP: Clarify inspection mode: configuration, payload, all (default)
.INDENT 2.0
.TP
.B payload
.INDENT 7.0
.IP \(bu 2
\fBfilter\fP: Comma\-separated directories to track payload.
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBpriority\fP: (advanced) Set priority of the inspection. Default is low priority.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq inspector.inspect
salt \(aq*\(aq inspector.inspect configuration
salt \(aq*\(aq inspector.inspect payload filter=/opt,/ext/oracle
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.inspector.query(*args, **kwargs)
Query the node for specific information.
.sp
Parameters:
.INDENT 7.0
.IP \(bu 2
\fBscope\fP: Specify scope of the query.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBSystem\fP: Return system data.
.IP \(bu 2
\fBSoftware\fP: Return software information.
.IP \(bu 2
\fBServices\fP: Return known services.
.IP \(bu 2
.INDENT 2.0
.TP
\fBIdentity\fP: Return user accounts information for this system.
.INDENT 7.0
.TP
.B accounts
Can be either \(aqlocal\(aq, \(aqremote\(aq or \(aqall\(aq (equal to \(dqlocal,remote\(dq).
Remote accounts cannot be resolved on all systems, but only
those, which supports \(aqpasswd \-S \-a\(aq.
.TP
.B disabled
True (or False, default) to return only disabled accounts.
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBpayload\fP: Payload scope parameters:
.INDENT 7.0
.TP
.B filter
Include only results which path starts from the filter string.
.TP
.B time
Display time in Unix ticks or format according to the configured TZ (default)
Values: ticks, tz (default)
.TP
.B size
Format size. Values: B, KB, MB, GB
.TP
.B type
Include payload type.
Values (comma\-separated): directory (or dir), link, file (default)
Example (returns everything): type=directory,link,file
.TP
.B owners
Resolve UID/GID to an actual names or leave them numeric (default).
Values: name (default), id
.TP
.B brief
Return just a list of payload elements, if True. Default: False.
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBall\fP: Return all information (default).
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq inspector.query scope=system
salt \(aq*\(aq inspector.query scope=payload type=file,link filter=/etc size=Kb brief=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.inspector.snapshots()
List current description snapshots.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion inspector.snapshots
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.introspect
.sp
Functions to perform introspection on a minion, and return data in a format
usable by Salt States
.INDENT 0.0
.TP
.B salt.modules.introspect.enabled_service_owners()
Return which packages own each of the services that are currently enabled.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion introspect.enabled_service_owners
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.introspect.running_service_owners(exclude=(\(aq/dev\(aq, \(aq/home\(aq, \(aq/media\(aq, \(aq/proc\(aq, \(aq/run\(aq, \(aq/sys/\(aq, \(aq/tmp\(aq, \(aq/var\(aq))
Determine which packages own the currently running services. By default,
excludes files whose full path starts with \fB/dev\fP, \fB/home\fP, \fB/media\fP,
\fB/proc\fP, \fB/run\fP, \fB/sys\fP, \fB/tmp\fP and \fB/var\fP\&. This can be
overridden by passing in a new list to \fBexclude\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion introspect.running_service_owners
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.introspect.service_highstate(requires=True)
Return running and enabled services in a highstate structure. By default
also returns package dependencies for those services, which means that
package definitions must be created outside this function. To drop the
package dependencies, set \fBrequires\fP to False.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion introspect.service_highstate
salt myminion introspect.service_highstate requires=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.iosconfig
.sp
Cisco IOS configuration manipulation helpers
.sp
New in version 2019.2.0.

.sp
This module provides a collection of helper functions for Cisco IOS style
configuration manipulation. This module does not have external dependencies
and can be used from any Proxy or regular Minion.
.INDENT 0.0
.TP
.B salt.modules.iosconfig.clean(config=None, path=None, saltenv=\(aqbase\(aq)
Return a clean version of the config, without any special signs (such as
\fB!\fP as an individual line) or empty lines, but just lines with significant
value in the configuration of the network device.
.INDENT 7.0
.TP
.B config
The configuration sent as text. This argument is ignored when \fBpath\fP
is configured.
.TP
.B path
Absolute or remote path from where to load the configuration text. This
argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file.
Ignored if \fBpath\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iosconfig.clean path=salt://path/to/my/config.txt
salt \(aq*\(aq iosconfig.clean path=https://bit.ly/2mAdq7z
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iosconfig.diff_text(candidate_config=None, candidate_path=None, running_config=None, running_path=None, saltenv=\(aqbase\(aq)
Return the diff, as text, between the candidate and the running config.
.INDENT 7.0
.TP
.B candidate_config
The candidate configuration sent as text. This argument is ignored when
\fBcandidate_path\fP is set.
.TP
.B candidate_path
Absolute or remote path from where to load the candidate configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B running_config
The running configuration sent as text. This argument is ignored when
\fBrunning_path\fP is set.
.TP
.B running_path
Absolute or remote path from where to load the running configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file.
Ignored if \fBcandidate_path\fP or \fBrunning_path\fP is not a
\fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iosconfig.diff_text candidate_path=salt://path/to/candidate.cfg running_path=salt://path/to/running.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iosconfig.diff_tree(candidate_config=None, candidate_path=None, running_config=None, running_path=None, saltenv=\(aqbase\(aq)
Return the diff, as Python dictionary, between the candidate and the running
configuration.
.INDENT 7.0
.TP
.B candidate_config
The candidate configuration sent as text. This argument is ignored when
\fBcandidate_path\fP is set.
.TP
.B candidate_path
Absolute or remote path from where to load the candidate configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B running_config
The running configuration sent as text. This argument is ignored when
\fBrunning_path\fP is set.
.TP
.B running_path
Absolute or remote path from where to load the running configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file.
Ignored if \fBcandidate_path\fP or \fBrunning_path\fP is not a
\fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iosconfig.diff_tree candidate_path=salt://path/to/candidate.cfg running_path=salt://path/to/running.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iosconfig.merge_diff(initial_config=None, initial_path=None, merge_config=None, merge_path=None, saltenv=\(aqbase\(aq)
Return the merge diff, as text, after merging the merge config into the
initial config.
.INDENT 7.0
.TP
.B initial_config
The initial configuration sent as text. This argument is ignored when
\fBinitial_path\fP is set.
.TP
.B initial_path
Absolute or remote path from where to load the initial configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B merge_config
The config to be merged into the initial config, sent as text. This
argument is ignored when \fBmerge_path\fP is set.
.TP
.B merge_path
Absolute or remote path from where to load the merge configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file.
Ignored if \fBinitial_path\fP or \fBmerge_path\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iosconfig.merge_diff initial_path=salt://path/to/running.cfg merge_path=salt://path/to/merge.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iosconfig.merge_text(initial_config=None, initial_path=None, merge_config=None, merge_path=None, saltenv=\(aqbase\(aq)
Return the merge result of the \fBinitial_config\fP with the \fBmerge_config\fP,
as plain text.
.INDENT 7.0
.TP
.B initial_config
The initial configuration sent as text. This argument is ignored when
\fBinitial_path\fP is set.
.TP
.B initial_path
Absolute or remote path from where to load the initial configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B merge_config
The config to be merged into the initial config, sent as text. This
argument is ignored when \fBmerge_path\fP is set.
.TP
.B merge_path
Absolute or remote path from where to load the merge configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file.
Ignored if \fBinitial_path\fP or \fBmerge_path\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iosconfig.merge_text initial_path=salt://path/to/running.cfg merge_path=salt://path/to/merge.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iosconfig.merge_tree(initial_config=None, initial_path=None, merge_config=None, merge_path=None, saltenv=\(aqbase\(aq)
Return the merge tree of the \fBinitial_config\fP with the \fBmerge_config\fP,
as a Python dictionary.
.INDENT 7.0
.TP
.B initial_config
The initial configuration sent as text. This argument is ignored when
\fBinitial_path\fP is set.
.TP
.B initial_path
Absolute or remote path from where to load the initial configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B merge_config
The config to be merged into the initial config, sent as text. This
argument is ignored when \fBmerge_path\fP is set.
.TP
.B merge_path
Absolute or remote path from where to load the merge configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file.
Ignored if \fBinitial_path\fP or \fBmerge_path\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iosconfig.merge_tree initial_path=salt://path/to/running.cfg merge_path=salt://path/to/merge.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iosconfig.tree(config=None, path=None, with_tags=False, saltenv=\(aqbase\(aq)
Transform Cisco IOS style configuration to structured Python dictionary.
Depending on the value of the \fBwith_tags\fP argument, this function may
provide different views, valuable in different situations.
.INDENT 7.0
.TP
.B config
The configuration sent as text. This argument is ignored when \fBpath\fP
is configured.
.TP
.B path
Absolute or remote path from where to load the configuration text. This
argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B with_tags: \fBFalse\fP
Whether this function should return a detailed view, with tags.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file.
Ignored if \fBpath\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iosconfig.tree path=salt://path/to/my/config.txt
salt \(aq*\(aq iosconfig.tree path=https://bit.ly/2mAdq7z
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.ipmi
.sp
Support IPMI commands over LAN. This module does not talk to the local
systems hardware through IPMI drivers. It uses a python module \fIpyghmi\fP\&.
.INDENT 0.0
.TP
.B depends
Python module pyghmi.
You can install pyghmi using pip:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyghmi
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B configuration
The following configuration defaults can be
define (pillar or config files):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ipmi.config:
    api_host: 127.0.0.1
    api_user: admin
    api_pass: apassword
    api_port: 623
    api_kg: None
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Usage can override the config defaults:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.get_user api_host=myipmienabled.system
                        api_user=admin api_pass=pass
                        uid=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.create_user(uid, name, password, channel=14, callback=False, link_auth=True, ipmi_msg=True, privilege_level=\(aqadministrator\(aq, **kwargs)
create/ensure a user is created with provided settings.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprivilege_level\fP \-\- User Privilege Limit. (Determines the maximum privilege level that
the user is allowed to switch to on the specified channel.)
* callback
* user
* operator
* administrator
* proprietary
* no_access
.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.create_user uid=2 name=steverweber api_host=172.168.0.7 api_pass=nevertell
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.fast_connect_test(**kwargs)
Returns True if connection success.
This uses an aggressive timeout value!
.INDENT 7.0
.TP
.B Parameters
\fBkwargs\fP \-\- .INDENT 7.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.fast_connect_test api_host=172.168.0.9
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.get_bootdev(**kwargs)
Get current boot device override information.
.sp
Provides the current requested boot device.  Be aware that not all IPMI
devices support this.  Even in BMCs that claim to, occasionally the
BIOS or UEFI fail to honor it. This is usually only applicable to the
next reboot.
.INDENT 7.0
.TP
.B Parameters
\fBkwargs\fP \-\- .INDENT 7.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.get_bootdev api_host=127.0.0.1 api_user=admin api_pass=pass
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.get_channel_access(channel=14, read_mode=\(aqnon_volatile\(aq, **kwargs)
:param kwargs:api_host=\(aq127.0.0.1\(aq api_user=\(aqadmin\(aq api_pass=\(aqexample\(aq api_port=623
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBchannel\fP \-\- number [1:7]
.IP \(bu 2
\fBread_mode\fP \-\- .INDENT 2.0
.IP \(bu 2
non_volatile  = get non\-volatile Channel Access
.IP \(bu 2
volatile      = get present volatile (active) setting of Channel Access
.UNINDENT

.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Return Data
.INDENT 7.0
.INDENT 3.5
A Python dict with the following keys/values:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    alerting:
    per_msg_auth:
    user_level_auth:
    access_mode:{ (ONE OF)
        0: \(aqdisabled\(aq,
        1: \(aqpre_boot\(aq,
        2: \(aqalways\(aq,
        3: \(aqshared\(aq
    }
    privilege_level: { (ONE OF)
        1: \(aqcallback\(aq,
        2: \(aquser\(aq,
        3: \(aqoperator\(aq,
        4: \(aqadministrator\(aq,
        5: \(aqproprietary\(aq,
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.get_channel_access channel=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.get_channel_info(channel=14, **kwargs)
Get channel info
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBchannel\fP \-\- number [1:7]
.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Return Data
channel session supports
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- no_session: channel is session\-less
\- single: channel is single\-session
\- multi: channel is multi\-session
\- auto: channel is session\-based (channel could alternate between
    single\- and multi\-session operation, as can occur with a
    serial/modem channel that supports connection mode auto\-detect)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.get_channel_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.get_channel_max_user_count(channel=14, **kwargs)
Get max users in channel
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBchannel\fP \-\- number [1:7]
.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.TP
.B Returns
int \-\- often 16
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.get_channel_max_user_count
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.get_health(**kwargs)
Get Summarize health
.sp
This provides a summary of the health of the managed system.
It additionally provides an iterable list of reasons for
warning, critical, or failed assessments.
.sp
good health: {\(aqbadreadings\(aq: [], \(aqhealth\(aq: 0}
.INDENT 7.0
.TP
.B Parameters
\fBkwargs\fP \-\- .INDENT 7.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.get_health api_host=127.0.0.1 api_user=admin api_pass=pass
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.get_power(**kwargs)
Get current power state
.sp
The response, if successful, should contain \(aqpowerstate\(aq key and
either \(aqon\(aq or \(aqoff\(aq to indicate current state.
.INDENT 7.0
.TP
.B Parameters
\fBkwargs\fP \-\- .INDENT 7.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.get_power api_host=127.0.0.1 api_user=admin api_pass=pass
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.get_sensor_data(**kwargs)
Get sensor readings
.sp
Iterates sensor reading objects
.INDENT 7.0
.TP
.B Parameters
\fBkwargs\fP \-\- .INDENT 7.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.get_sensor_data api_host=127.0.0.1 api_user=admin api_pass=pass
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.get_user(uid, channel=14, **kwargs)
Get user from uid and access on channel
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuid\fP \-\- user number [1:16]
.IP \(bu 2
\fBchannel\fP \-\- number [1:7]
.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Return Data
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
name: (str)
uid: (int)
channel: (int)
access:
    \- callback (bool)
    \- link_auth (bool)
    \- ipmi_msg (bool)
    \- privilege_level: (str)[callback, user, operatorm administrator,
                            proprietary, no_access]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.get_user uid=2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.get_user_access(uid, channel=14, **kwargs)
Get user access
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuid\fP \-\- user number [1:16]
.IP \(bu 2
\fBchannel\fP \-\- number [1:7]
.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Return Data
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
channel_info:
    \- max_user_count = maximum number of user IDs on this channel
    \- enabled_users = count of User ID slots presently in use
    \- users_with_fixed_names = count of user IDs with fixed names
access:
    \- callback
    \- link_auth
    \- ipmi_msg
    \- privilege_level: [reserved, callback, user, operator
                       administrator, proprietary, no_access]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.get_user_access uid=2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.get_user_name(uid, return_none_on_error=True, **kwargs)
Get user name
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuid\fP \-\- user number [1:16]
.IP \(bu 2
\fBreturn_none_on_error\fP \-\- return None on error
.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.get_user_name uid=2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.get_users(channel=14, **kwargs)
get list of users and access information
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBchannel\fP \-\- number [1:7]
.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.TP
.B Returns
.INDENT 7.0
.IP \(bu 2
name: (str)
.IP \(bu 2
uid: (int)
.IP \(bu 2
channel: (int)
.IP \(bu 2
.INDENT 2.0
.TP
.B access:
.INDENT 7.0
.IP \(bu 2
callback (bool)
.IP \(bu 2
link_auth (bool)
.IP \(bu 2
ipmi_msg (bool)
.IP \(bu 2
privilege_level: (str)[callback, user, operatorm administrator,
proprietary, no_access]
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.get_users api_host=172.168.0.7
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.raw_command(netfn, command, bridge_request=None, data=(), retry=True, delay_xmit=None, **kwargs)
Send raw ipmi command
.sp
This allows arbitrary IPMI bytes to be issued.  This is commonly used
for certain vendor specific commands.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnetfn\fP \-\- Net function number
.IP \(bu 2
\fBcommand\fP \-\- Command value
.IP \(bu 2
\fBbridge_request\fP \-\- The target slave address and channel number for
the bridge request.
.IP \(bu 2
\fBdata\fP \-\- Command data as a tuple or list
.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.TP
.B Returns
dict \-\- The response from IPMI device
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.raw_command netfn=0x06 command=0x46 data=[0x02]
# this will return the name of the user with id 2 in bytes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.set_bootdev(bootdev=\(aqdefault\(aq, persist=False, uefiboot=False, **kwargs)
Set boot device to use on next reboot
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBbootdev\fP \-\- .INDENT 2.0
.IP \(bu 2
network: Request network boot
.IP \(bu 2
hd: Boot from hard drive
.IP \(bu 2
safe: Boot from hard drive, requesting \(aqsafe mode\(aq
.IP \(bu 2
optical: boot from CD/DVD/BD drive
.IP \(bu 2
setup: Boot into setup utility
.IP \(bu 2
default: remove any IPMI directed boot device
request
.UNINDENT

.IP \(bu 2
\fBpersist\fP \-\- If true, ask that system firmware use this device
beyond next boot.  Be aware many systems do not honor
this
.IP \(bu 2
\fBuefiboot\fP \-\- If true, request UEFI boot explicitly.  Strictly
speaking, the spec suggests that if not set, the system
should BIOS boot and offers no \(dqdon\(aqt care\(dq option.
In practice, this flag not being set does not preclude
UEFI boot on any system I\(aqve encountered.
.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.TP
.B Returns
dict or True \-\- If callback is not provided, the response
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.set_bootdev bootdev=network persist=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.set_channel_access(channel=14, access_update_mode=\(aqnon_volatile\(aq, alerting=False, per_msg_auth=False, user_level_auth=False, access_mode=\(aqalways\(aq, privilege_update_mode=\(aqnon_volatile\(aq, privilege_level=\(aqadministrator\(aq, **kwargs)
Set channel access
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBchannel\fP \-\- number [1:7]
.IP \(bu 2
\fBaccess_update_mode\fP \-\- .INDENT 2.0
.IP \(bu 2
\(aqdont_change\(aq  = don\(aqt set or change Channel Access
.IP \(bu 2
\(aqnon_volatile\(aq = set non\-volatile Channel Access
.IP \(bu 2
\(aqvolatile\(aq     = set volatile (active) setting of Channel Access
.UNINDENT

.IP \(bu 2
\fBalerting\fP \-\-
.sp
PEF Alerting Enable/Disable
.INDENT 2.0
.IP \(bu 2
True  = enable PEF Alerting
.IP \(bu 2
False = disable PEF Alerting on this channel
(Alert Immediate command can still be used to generate alerts)
.UNINDENT

.IP \(bu 2
\fBper_msg_auth\fP \-\-
.sp
Per\-message Authentication
.INDENT 2.0
.IP \(bu 2
True  = enable
.IP \(bu 2
False = disable Per\-message Authentication. [Authentication required to
activate any session on this channel, but authentication not
used on subsequent packets for the session.]
.UNINDENT

.IP \(bu 2
\fBuser_level_auth\fP \-\-
.sp
User Level Authentication Enable/Disable
.INDENT 2.0
.IP \(bu 2
True  = enable User Level Authentication. All User Level commands are
to be authenticated per the Authentication Type that was
negotiated when the session was activated.
.IP \(bu 2
False = disable User Level Authentication. Allow User Level commands to
be executed without being authenticated.
If the option to disable User Level Command authentication is
accepted, the BMC will accept packets with Authentication Type
set to None if they contain user level commands.
For outgoing packets, the BMC returns responses with the same
Authentication Type that was used for the request.
.UNINDENT

.IP \(bu 2
\fBaccess_mode\fP \-\-
.sp
Access Mode for IPMI messaging (PEF Alerting is enabled/disabled
separately from IPMI messaging)
.INDENT 2.0
.IP \(bu 2
disabled = disabled for IPMI messaging
.IP \(bu 2
pre_boot = pre\-boot only channel only available when system is
in a powered down state or in BIOS prior to start of boot.
.IP \(bu 2
always   = channel always available regardless of system mode.
BIOS typically dedicates the serial connection to the BMC.
.IP \(bu 2
shared   = same as always available, but BIOS typically leaves the
serial port available for software use.
.UNINDENT

.IP \(bu 2
\fBprivilege_update_mode\fP \-\-
.sp
Channel Privilege Level Limit. This value sets the maximum privilege
level that can be accepted on the specified channel.
.INDENT 2.0
.IP \(bu 2
dont_change  = don\(aqt set or change channel Privilege Level Limit
.IP \(bu 2
non_volatile = non\-volatile Privilege Level Limit according
.IP \(bu 2
volatile     = volatile setting of Privilege Level Limit
.UNINDENT

.IP \(bu 2
\fBprivilege_level\fP \-\-
.sp
Channel Privilege Level Limit
.INDENT 2.0
.IP \(bu 2
reserved      = unused
.IP \(bu 2
callback
.IP \(bu 2
user
.IP \(bu 2
operator
.IP \(bu 2
administrator
.IP \(bu 2
proprietary   = used by OEM
.UNINDENT

.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.set_channel_access privilege_level=\(aqadministrator\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.set_identify(on=True, duration=600, **kwargs)
Request identify light
.sp
Request the identify light to turn off, on for a duration,
or on indefinitely.  Other than error exceptions,
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBon\fP \-\- Set to True to force on or False to force off
.IP \(bu 2
\fBduration\fP \-\- Set if wanting to request turn on for a duration
in seconds, None = indefinitely.
.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.set_identify
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.set_power(state=\(aqpower_on\(aq, wait=True, **kwargs)
Request power state change
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- .INDENT 2.0
.IP \(bu 2
power_on \-\- system turn on
.IP \(bu 2
power_off \-\- system turn off (without waiting for OS)
.IP \(bu 2
shutdown \-\- request OS proper shutdown
.IP \(bu 2
reset \-\- reset (without waiting for OS)
.IP \(bu 2
boot \-\- If system is off, then \(aqon\(aq, else \(aqreset\(aq
.UNINDENT

.IP \(bu 2
\fBensure\fP \-\- If (bool True), do not return until system actually completes
requested state change for 300 seconds.
If a non\-zero (int), adjust the wait time to the
requested number of seconds
.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.TP
.B Returns
dict \-\- A dict describing the response retrieved
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.set_power state=shutdown wait=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.set_user_access(uid, channel=14, callback=True, link_auth=True, ipmi_msg=True, privilege_level=\(aqadministrator\(aq, **kwargs)
Set user access
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuid\fP \-\- user number [1:16]
.IP \(bu 2
\fBchannel\fP \-\- number [1:7]
.IP \(bu 2
\fBcallback\fP \-\-
.sp
User Restricted to Callback
.INDENT 2.0
.IP \(bu 2
False = User Privilege Limit is determined by the User Privilege Limit
parameter, below, for both callback and non\-callback connections.
.IP \(bu 2
True  = User Privilege Limit is determined by the User Privilege Limit
parameter for callback connections, but is restricted to Callback
level for non\-callback connections. Thus, a user can only initiate
a Callback when they \(aqcall in\(aq to the BMC, but once the callback
connection has been made, the user could potentially establish a
session as an Operator.
.UNINDENT

.IP \(bu 2
\fBlink_auth\fP \-\- User Link authentication enable/disable (used to enable
whether this user\(aqs name and password information will be used for link
authentication, e.g. PPP CHAP) for the given channel. Link
authentication itself is a global setting for the channel and is
enabled/disabled via the serial/modem configuration parameters.
.IP \(bu 2
\fBipmi_msg\fP \-\- User IPMI Messaging: (used to enable/disable whether
this user\(aqs name and password information will be used for IPMI
Messaging. In this case, \(aqIPMI Messaging\(aq refers to the ability to
execute generic IPMI commands that are not associated with a
particular payload type. For example, if IPMI Messaging is disabled for
a user, but that user is enabled for activating the SOL
payload type, then IPMI commands associated with SOL and session
management, such as Get SOL Configuration Parameters and Close Session
are available, but generic IPMI commands such as Get SEL Time are
unavailable.)
.IP \(bu 2
\fBprivilege_level\fP \-\-
.sp
User Privilege Limit. (Determines the maximum privilege level that the
user is allowed to switch to on the specified channel.)
.INDENT 2.0
.IP \(bu 2
callback
.IP \(bu 2
user
.IP \(bu 2
operator
.IP \(bu 2
administrator
.IP \(bu 2
proprietary
.IP \(bu 2
no_access
.UNINDENT

.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.set_user_access uid=2 privilege_level=\(aqoperator\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.set_user_name(uid, name, **kwargs)
Set user name
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuid\fP \-\- user number [1:16]
.IP \(bu 2
\fBname\fP \-\- username (limit of 16bytes)
.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.set_user_name uid=2 name=\(aqsteverweber\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.set_user_password(uid, mode=\(aqset_password\(aq, password=None, **kwargs)
Set user password and (modes)
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuid\fP \-\- id number of user.  see: get_names_uid()[\(aqname\(aq]
.IP \(bu 2
\fBmode\fP \-\- .INDENT 2.0
.IP \(bu 2
disable       = disable user connections
.IP \(bu 2
enable        = enable user connections
.IP \(bu 2
set_password  = set or ensure password
.IP \(bu 2
test_password = test password is correct
.UNINDENT

.IP \(bu 2
\fBpassword\fP \-\- max 16 char string
(optional when mode is [disable or enable])
.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.TP
.B Returns
True on success
when mode = test_password, return False on bad password
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.set_user_password api_host=127.0.0.1 api_user=admin api_pass=pass
                                 uid=1 password=newPass
salt\-call ipmi.set_user_password uid=1 mode=enable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipmi.user_delete(uid, channel=14, **kwargs)
Delete user (helper)
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuid\fP \-\- user number [1:16]
.IP \(bu 2
\fBchannel\fP \-\- number [1:7]
.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
api_host=127.0.0.1
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=example
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT

.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call ipmi.user_delete uid=2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.ipset
.sp
Support for ipset
.INDENT 0.0
.TP
.B salt.modules.ipset.add(name=None, entry=None, family=\(aqipv4\(aq, **kwargs)
Append an entry to the specified set.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ipset.add name 192.168.1.26

salt \(aq*\(aq ipset.add name 192.168.0.3,AA:BB:CC:DD:EE:FF
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipset.check(name=None, entry=None, family=\(aqipv4\(aq)
Check that an entry exists in the specified set.
.INDENT 7.0
.TP
.B name
The ipset name
.TP
.B entry
An entry in the ipset.  This parameter can be a single IP address, a
range of IP addresses, or a subnet block.  Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
192.168.0.1
192.168.0.2\-192.168.0.19
192.168.0.0/25
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B family
IP protocol version: ipv4 or ipv6
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ipset.check name \(aq192.168.0.1 comment \(dqHello\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipset.check_set(name=None, family=\(aqipv4\(aq)
Check that given ipset set exists.
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ipset.check_set name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipset.delete(name=None, entry=None, family=\(aqipv4\(aq, **kwargs)
Delete an entry from the specified set.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ipset.delete name 192.168.0.3,AA:BB:CC:DD:EE:FF
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipset.delete_set(name=None, family=\(aqipv4\(aq)
New in version 2014.7.0.

.sp
Delete ipset set.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ipset.delete_set custom_set

IPv6:
salt \(aq*\(aq ipset.delete_set custom_set family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipset.flush(name=None, family=\(aqipv4\(aq)
Flush entries in the specified set,
Flush all sets if set is not specified.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ipset.flush

salt \(aq*\(aq ipset.flush set

IPv6:
salt \(aq*\(aq ipset.flush

salt \(aq*\(aq ipset.flush set
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipset.list_sets(family=\(aqipv4\(aq)
New in version 2014.7.0.

.sp
List all ipset sets.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ipset.list_sets
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipset.new_set(name=None, set_type=None, family=\(aqipv4\(aq, comment=False, **kwargs)
New in version 2014.7.0.

.sp
Create new custom set
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ipset.new_set custom_set list:set

salt \(aq*\(aq ipset.new_set custom_set list:set comment=True

IPv6:
salt \(aq*\(aq ipset.new_set custom_set list:set family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipset.rename_set(name=None, new_set=None, family=\(aqipv4\(aq)
New in version 2014.7.0.

.sp
Delete ipset set.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ipset.rename_set custom_set new_set=new_set_name

IPv6:
salt \(aq*\(aq ipset.rename_set custom_set new_set=new_set_name family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipset.test(name=None, entry=None, family=\(aqipv4\(aq, **kwargs)
Test if an entry is in the specified set.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ipset.test name 192.168.0.2

IPv6:
salt \(aq*\(aq ipset.test name fd81:fc56:9ac7::/48
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ipset.version()
Return version from ipset \-\-version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ipset.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.iptables
.sp
Support for iptables
.SS Configuration Options
.sp
The following options can be set in the minion config, grains, pillar, or
master config. The configuration is read using \fI\%config.get\fP\&.
.INDENT 0.0
.IP \(bu 2
\fBiptables.save_filters\fP: List of REGEX strings to FILTER OUT matching lines
.sp
This is useful for filtering out chains, rules, etc that you do not wish to
persist, such as ephemeral Docker rules.
.sp
The default is to not filter out anything.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
iptables.save_filters:
  \- \(dq\-j CATTLE_PREROUTING\(dq
  \- \(dq\-j DOCKER\(dq
  \- \(dq\-A POSTROUTING\(dq
  \- \(dq\-A CATTLE_POSTROUTING\(dq
  \- \(dq\-A FORWARD\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.append(table=\(aqfilter\(aq, chain=None, rule=None, family=\(aqipv4\(aq)
Append a rule to the specified table/chain.
.INDENT 7.0
.TP
.B This function accepts a rule in a standard iptables command format,
starting with the chain. Trying to force users to adapt to a new
method of creating rules would be irritating at best, and we
already have a parser that can handle it.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.append filter INPUT \e
    rule=\(aq\-m state \-\-state RELATED,ESTABLISHED \-j ACCEPT\(aq

IPv6:
salt \(aq*\(aq iptables.append filter INPUT \e
    rule=\(aq\-m state \-\-state RELATED,ESTABLISHED \-j ACCEPT\(aq \e
    family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.build_rule(table=\(aqfilter\(aq, chain=None, command=None, position=\(aq\(aq, full=None, family=\(aqipv4\(aq, **kwargs)
Build a well\-formatted iptables rule based on kwargs. A \fItable\fP and \fIchain\fP
are not required, unless \fIfull\fP is True.
.sp
If \fIfull\fP is \fITrue\fP, then \fItable\fP, \fIchain\fP and \fIcommand\fP are required.
\fIcommand\fP may be specified as either a short option (\(aqI\(aq) or a long option
(\fI\-\-insert\fP). This will return the iptables command, exactly as it would
be used from the command line.
.sp
If a position is required (as with \fI\-I\fP or \fI\-D\fP), it may be specified as
\fIposition\fP\&. This will only be useful if \fIfull\fP is True.
.sp
If \fIstate\fP is passed, it will be ignored, use \fIconnstate\fP\&.
If \fIconnstate\fP is passed in, it will automatically be changed to \fIstate\fP\&.
.sp
To pass in jump options that doesn\(aqt take arguments, pass in an empty
string.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Whereas iptables will accept \fB\-p\fP, \fB\-\-proto[c[o[l]]]\fP as synonyms
of \fB\-\-protocol\fP, if \fB\-\-proto\fP appears in an iptables command after
the appearance of \fB\-m policy\fP, it is interpreted as the \fB\-\-proto\fP
option of the policy extension (see the iptables\-extensions(8) man
page).
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.build_rule match=state \e
    connstate=RELATED,ESTABLISHED jump=ACCEPT

salt \(aq*\(aq iptables.build_rule filter INPUT command=I position=3 \e
    full=True match=state connstate=RELATED,ESTABLISHED jump=ACCEPT

salt \(aq*\(aq iptables.build_rule filter INPUT command=A \e
    full=True match=state connstate=RELATED,ESTABLISHED \e
    source=\(aq127.0.0.1\(aq jump=ACCEPT

\&.. Invert Rules
salt \(aq*\(aq iptables.build_rule filter INPUT command=A \e
    full=True match=state connstate=RELATED,ESTABLISHED \e
    source=\(aq!127.0.0.1\(aq jump=ACCEPT

salt \(aq*\(aq iptables.build_rule filter INPUT command=A \e
    full=True match=state connstate=RELATED,ESTABLISHED \e
    destination=\(aqnot 127.0.0.1\(aq jump=ACCEPT

IPv6:
salt \(aq*\(aq iptables.build_rule match=state \e
    connstate=RELATED,ESTABLISHED jump=ACCEPT \e
    family=ipv6
salt \(aq*\(aq iptables.build_rule filter INPUT command=I position=3 \e
    full=True match=state connstate=RELATED,ESTABLISHED jump=ACCEPT \e
    family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.check(table=\(aqfilter\(aq, chain=None, rule=None, family=\(aqipv4\(aq)
Check for the existence of a rule in the table and chain
.INDENT 7.0
.TP
.B This function accepts a rule in a standard iptables command format,
starting with the chain. Trying to force users to adapt to a new
method of creating rules would be irritating at best, and we
already have a parser that can handle it.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.check filter INPUT \e
    rule=\(aq\-m state \-\-state RELATED,ESTABLISHED \-j ACCEPT\(aq

IPv6:
salt \(aq*\(aq iptables.check filter INPUT \e
    rule=\(aq\-m state \-\-state RELATED,ESTABLISHED \-j ACCEPT\(aq \e
    family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.check_chain(table=\(aqfilter\(aq, chain=None, family=\(aqipv4\(aq)
New in version 2014.1.0.

.sp
Check for the existence of a chain in the table
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.check_chain filter INPUT

IPv6:
salt \(aq*\(aq iptables.check_chain filter INPUT family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.delete(table, chain=None, position=None, rule=None, family=\(aqipv4\(aq)
.INDENT 7.0
.TP
.B Delete a rule from the specified table/chain, specifying either the rule
in its entirety, or the rule\(aqs position in the chain.
.TP
.B This function accepts a rule in a standard iptables command format,
starting with the chain. Trying to force users to adapt to a new
method of creating rules would be irritating at best, and we
already have a parser that can handle it.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.delete filter INPUT position=3
salt \(aq*\(aq iptables.delete filter INPUT \e
    rule=\(aq\-m state \-\-state RELATED,ESTABLISHED \-j ACCEPT\(aq

IPv6:
salt \(aq*\(aq iptables.delete filter INPUT position=3 family=ipv6
salt \(aq*\(aq iptables.delete filter INPUT \e
    rule=\(aq\-m state \-\-state RELATED,ESTABLISHED \-j ACCEPT\(aq \e
    family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.delete_chain(table=\(aqfilter\(aq, chain=None, family=\(aqipv4\(aq)
New in version 2014.1.0.

.sp
Delete custom chain to the specified table.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.delete_chain filter CUSTOM_CHAIN

IPv6:
salt \(aq*\(aq iptables.delete_chain filter CUSTOM_CHAIN family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.flush(table=\(aqfilter\(aq, chain=\(aq\(aq, family=\(aqipv4\(aq)
Flush the chain in the specified table, flush all chains in the specified
table if not specified chain.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.flush filter INPUT

IPv6:
salt \(aq*\(aq iptables.flush filter INPUT family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.get_policy(table=\(aqfilter\(aq, chain=None, family=\(aqipv4\(aq)
Return the current policy for the specified table/chain
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.get_policy filter INPUT

IPv6:
salt \(aq*\(aq iptables.get_policy filter INPUT family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.get_rules(family=\(aqipv4\(aq)
Return a data structure of the current, in\-memory rules
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.get_rules

IPv6:
salt \(aq*\(aq iptables.get_rules family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.get_saved_policy(table=\(aqfilter\(aq, chain=None, conf_file=None, family=\(aqipv4\(aq)
Return the current policy for the specified table/chain
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.get_saved_policy filter INPUT
salt \(aq*\(aq iptables.get_saved_policy filter INPUT \e
    conf_file=/etc/iptables.saved

IPv6:
salt \(aq*\(aq iptables.get_saved_policy filter INPUT family=ipv6
salt \(aq*\(aq iptables.get_saved_policy filter INPUT \e
    conf_file=/etc/iptables.saved family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.get_saved_rules(conf_file=None, family=\(aqipv4\(aq)
Return a data structure of the rules in the conf file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.get_saved_rules

IPv6:
salt \(aq*\(aq iptables.get_saved_rules family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.insert(table=\(aqfilter\(aq, chain=None, position=None, rule=None, family=\(aqipv4\(aq)
Insert a rule into the specified table/chain, at the specified position.
.INDENT 7.0
.TP
.B This function accepts a rule in a standard iptables command format,
starting with the chain. Trying to force users to adapt to a new
method of creating rules would be irritating at best, and we
already have a parser that can handle it.
.TP
.B If the position specified is a negative number, then the insert will be
performed counting from the end of the list. For instance, a position
of \-1 will insert the rule as the second to last rule. To insert a rule
in the last position, use the append function instead.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.insert filter INPUT position=3 \e
    rule=\(aq\-m state \-\-state RELATED,ESTABLISHED \-j ACCEPT\(aq

IPv6:
salt \(aq*\(aq iptables.insert filter INPUT position=3 \e
    rule=\(aq\-m state \-\-state RELATED,ESTABLISHED \-j ACCEPT\(aq \e
    family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.new_chain(table=\(aqfilter\(aq, chain=None, family=\(aqipv4\(aq)
New in version 2014.1.0.

.sp
Create new custom chain to the specified table.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.new_chain filter CUSTOM_CHAIN

IPv6:
salt \(aq*\(aq iptables.new_chain filter CUSTOM_CHAIN family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.save(filename=None, family=\(aqipv4\(aq)
Save the current in\-memory rules to disk
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.save /etc/sysconfig/iptables

IPv6:
salt \(aq*\(aq iptables.save /etc/sysconfig/iptables family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.set_policy(table=\(aqfilter\(aq, chain=None, policy=None, family=\(aqipv4\(aq)
Set the current policy for the specified table/chain
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.set_policy filter INPUT ACCEPT

IPv6:
salt \(aq*\(aq iptables.set_policy filter INPUT ACCEPT family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iptables.version(family=\(aqipv4\(aq)
Return version from iptables \-\-version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq iptables.version

IPv6:
salt \(aq*\(aq iptables.version family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.iwtools
.sp
Support for Wireless Tools for Linux
.INDENT 0.0
.TP
.B salt.modules.iwtools.list_interfaces(style=None)
List all of the wireless interfaces
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion iwtools.list_interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iwtools.scan(iface, style=None)
List networks on a wireless interface
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion iwtools.scan wlp3s0
salt minion iwtools.scan wlp3s0 list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.iwtools.set_mode(iface, mode)
List networks on a wireless interface
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion iwtools.set_mode wlp3s0 Managed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.jboss7
.sp
Module for managing JBoss AS 7 through the CLI interface.
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B In order to run each function, jboss_config dictionary with the following properties must be passed:
.INDENT 7.0
.IP \(bu 2
cli_path: the path to jboss\-cli script, for example: \(aq/opt/jboss/jboss\-7.0/bin/jboss\-cli.sh\(aq
.IP \(bu 2
controller: the IP address and port of controller, for example: 10.11.12.13:9999
.IP \(bu 2
cli_user: username to connect to jboss administration console if necessary
.IP \(bu 2
cli_password: password to connect to jboss administration console if necessary
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jboss_config:
   cli_path: \(aq/opt/jboss/jboss\-7.0/bin/jboss\-cli.sh\(aq
   controller: 10.11.12.13:9999
   cli_user: \(aqjbossadm\(aq
   cli_password: \(aqjbossadm\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jboss7.create_datasource(jboss_config, name, datasource_properties, profile=None)
Create datasource in running jboss instance
.INDENT 7.0
.TP
.B jboss_config
Configuration dictionary with properties specified above.
.TP
.B name
Datasource name
.TP
.B datasource_properties
.INDENT 7.0
.TP
.B A dictionary of datasource properties to be created:
.INDENT 7.0
.IP \(bu 2
driver\-name: mysql
.IP \(bu 2
connection\-url: \(aq\fI\%jdbc:mysql://localhost:3306/sampleDatabase\fP\(aq
.IP \(bu 2
jndi\-name: \(aqjava:jboss/datasources/sampleDS\(aq
.IP \(bu 2
user\-name: sampleuser
.IP \(bu 2
password: secret
.IP \(bu 2
min\-pool\-size: 3
.IP \(bu 2
use\-java\-context: True
.UNINDENT
.UNINDENT
.TP
.B profile
The profile name (JBoss domain mode only)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jboss7.create_datasource \(aq{\(dqcli_path\(dq: \(dqintegration.modules.sysmod.SysModuleTest.test_valid_docs\(dq, \(dqcontroller\(dq: \(dq10.11.12.13:9999\(dq, \(dqcli_user\(dq: \(dqjbossadm\(dq, \(dqcli_password\(dq: \(dqjbossadm\(dq}\(aq \(aqmy_datasource\(aq \(aq{\(dqdriver\-name\(dq: \(dqmysql\(dq, \(dqconnection\-url\(dq: \(dqjdbc:mysql://localhost:3306/sampleDatabase\(dq, \(dqjndi\-name\(dq: \(dqjava:jboss/datasources/sampleDS\(dq, \(dquser\-name\(dq: \(dqsampleuser\(dq, \(dqpassword\(dq: \(dqsecret\(dq, \(dqmin\-pool\-size\(dq: 3, \(dquse\-java\-context\(dq: True}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jboss7.create_simple_binding(jboss_config, binding_name, value, profile=None)
Create a simple jndi binding in the running jboss instance
.INDENT 7.0
.TP
.B jboss_config
Configuration dictionary with properties specified above.
.TP
.B binding_name
Binding name to be created
.TP
.B value
Binding value
.TP
.B profile
The profile name (JBoss domain mode only)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jboss7.create_simple_binding \e
        \(aq{\(dqcli_path\(dq: \(dqintegration.modules.sysmod.SysModuleTest.test_valid_docs\(dq, \e
        \(dqcontroller\(dq: \(dq10.11.12.13:9999\(dq, \(dqcli_user\(dq: \(dqjbossadm\(dq, \(dqcli_password\(dq: \(dqjbossadm\(dq}\(aq \e
        my_binding_name my_binding_value
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jboss7.deploy(jboss_config, source_file)
Deploy the application on the jboss instance from the local file system where minion is running.
.INDENT 7.0
.TP
.B jboss_config
Configuration dictionary with properties specified above.
.TP
.B source_file
Source file to deploy from
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jboss7.deploy \(aq{\(dqcli_path\(dq: \(dqintegration.modules.sysmod.SysModuleTest.test_valid_docs\(dq, \(dqcontroller\(dq: \(dq10.11.12.13:9999\(dq, \(dqcli_user\(dq: \(dqjbossadm\(dq, \(dqcli_password\(dq: \(dqjbossadm\(dq}\(aq /opt/deploy_files/my_deploy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jboss7.list_deployments(jboss_config)
List all deployments on the jboss instance
.INDENT 7.0
.TP
.B jboss_config
.INDENT 7.0
.INDENT 3.5
Configuration dictionary with properties specified above.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jboss7.list_deployments \(aq{\(dqcli_path\(dq: \(dqintegration.modules.sysmod.SysModuleTest.test_valid_docs\(dq, \(dqcontroller\(dq: \(dq10.11.12.13:9999\(dq, \(dqcli_user\(dq: \(dqjbossadm\(dq, \(dqcli_password\(dq: \(dqjbossadm\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jboss7.read_datasource(jboss_config, name, profile=None)
Read datasource properties in the running jboss instance.
.INDENT 7.0
.TP
.B jboss_config
Configuration dictionary with properties specified above.
.TP
.B name
Datasource name
.TP
.B profile
Profile name (JBoss domain mode only)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jboss7.read_datasource \(aq{\(dqcli_path\(dq: \(dqintegration.modules.sysmod.SysModuleTest.test_valid_docs\(dq, \(dqcontroller\(dq: \(dq10.11.12.13:9999\(dq, \(dqcli_user\(dq: \(dqjbossadm\(dq, \(dqcli_password\(dq: \(dqjbossadm\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jboss7.read_simple_binding(jboss_config, binding_name, profile=None)
Read jndi binding in the running jboss instance
.INDENT 7.0
.TP
.B jboss_config
Configuration dictionary with properties specified above.
.TP
.B binding_name
Binding name to be created
.TP
.B profile
The profile name (JBoss domain mode only)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
salt \(aq*\(aq jboss7.read_simple_binding \(aq{\(dqcli_path\(dq: \(dqintegration.modules.sysmod.SysModuleTest.test_valid_docs\(dq, \(dqcontroller\(dq: \(dq10.11.12.13:9999\(dq, \(dqcli_user\(dq: \(dqjbossadm\(dq, \(dqcli_password\(dq: \(dqjbossadm\(dq}\(aq my_binding_name
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jboss7.reload_(jboss_config, host=None)
Reload running jboss instance
.INDENT 7.0
.TP
.B jboss_config
Configuration dictionary with properties specified above.
.TP
.B host
The name of the host. JBoss domain mode only \- and required if running in domain mode.
The host name is the \(dqname\(dq attribute of the \(dqhost\(dq element in host.xml
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jboss7.reload \(aq{\(dqcli_path\(dq: \(dqintegration.modules.sysmod.SysModuleTest.test_valid_docs\(dq, \(dqcontroller\(dq: \(dq10.11.12.13:9999\(dq, \(dqcli_user\(dq: \(dqjbossadm\(dq, \(dqcli_password\(dq: \(dqjbossadm\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jboss7.remove_datasource(jboss_config, name, profile=None)
Remove an existing datasource from the running jboss instance.
.INDENT 7.0
.TP
.B jboss_config
Configuration dictionary with properties specified above.
.TP
.B name
Datasource name
.TP
.B profile
The profile (JBoss domain mode only)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jboss7.remove_datasource \(aq{\(dqcli_path\(dq: \(dqintegration.modules.sysmod.SysModuleTest.test_valid_docs\(dq, \(dqcontroller\(dq: \(dq10.11.12.13:9999\(dq, \(dqcli_user\(dq: \(dqjbossadm\(dq, \(dqcli_password\(dq: \(dqjbossadm\(dq}\(aq my_datasource_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jboss7.status(jboss_config, host=None, server_config=None)
Get status of running jboss instance.
.INDENT 7.0
.TP
.B jboss_config
Configuration dictionary with properties specified above.
.TP
.B host
The name of the host. JBoss domain mode only \- and required if running in domain mode.
The host name is the \(dqname\(dq attribute of the \(dqhost\(dq element in host.xml
.TP
.B server_config
The name of the Server Configuration. JBoss Domain mode only \- and required
if running in domain mode.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jboss7.status \(aq{\(dqcli_path\(dq: \(dqintegration.modules.sysmod.SysModuleTest.test_valid_docs\(dq, \(dqcontroller\(dq: \(dq10.11.12.13:9999\(dq, \(dqcli_user\(dq: \(dqjbossadm\(dq, \(dqcli_password\(dq: \(dqjbossadm\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jboss7.stop_server(jboss_config, host=None)
Stop running jboss instance
.INDENT 7.0
.TP
.B jboss_config
Configuration dictionary with properties specified above.
.TP
.B host
The name of the host. JBoss domain mode only \- and required if running in domain mode.
The host name is the \(dqname\(dq attribute of the \(dqhost\(dq element in host.xml
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jboss7.stop_server \(aq{\(dqcli_path\(dq: \(dqintegration.modules.sysmod.SysModuleTest.test_valid_docs\(dq, \(dqcontroller\(dq: \(dq10.11.12.13:9999\(dq, \(dqcli_user\(dq: \(dqjbossadm\(dq, \(dqcli_password\(dq: \(dqjbossadm\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jboss7.undeploy(jboss_config, deployment)
Undeploy the application from jboss instance
.INDENT 7.0
.TP
.B jboss_config
Configuration dictionary with properties specified above.
.TP
.B deployment
Deployment name to undeploy
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jboss7.undeploy \(aq{\(dqcli_path\(dq: \(dqintegration.modules.sysmod.SysModuleTest.test_valid_docs\(dq, \(dqcontroller\(dq: \(dq10.11.12.13:9999\(dq, \(dqcli_user\(dq: \(dqjbossadm\(dq, \(dqcli_password\(dq: \(dqjbossadm\(dq}\(aq my_deployment
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jboss7.update_datasource(jboss_config, name, new_properties, profile=None)
Update an existing datasource in running jboss instance.
If the property doesn\(aqt exist if will be created, if it does, it will be updated with the new value
.INDENT 7.0
.TP
.B jboss_config
Configuration dictionary with properties specified above.
.TP
.B name
Datasource name
.TP
.B new_properties
.INDENT 7.0
.TP
.B A dictionary of datasource properties to be updated. For example:
.INDENT 7.0
.IP \(bu 2
driver\-name: mysql
.IP \(bu 2
connection\-url: \(aq\fI\%jdbc:mysql://localhost:3306/sampleDatabase\fP\(aq
.IP \(bu 2
jndi\-name: \(aqjava:jboss/datasources/sampleDS\(aq
.IP \(bu 2
user\-name: sampleuser
.IP \(bu 2
password: secret
.IP \(bu 2
min\-pool\-size: 3
.IP \(bu 2
use\-java\-context: True
.UNINDENT
.UNINDENT
.TP
.B profile
The profile name (JBoss domain mode only)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jboss7.update_datasource \(aq{\(dqcli_path\(dq: \(dqintegration.modules.sysmod.SysModuleTest.test_valid_docs\(dq, \(dqcontroller\(dq: \(dq10.11.12.13:9999\(dq, \(dqcli_user\(dq: \(dqjbossadm\(dq, \(dqcli_password\(dq: \(dqjbossadm\(dq}\(aq \(aqmy_datasource\(aq \(aq{\(dqdriver\-name\(dq: \(dqmysql\(dq, \(dqconnection\-url\(dq: \(dqjdbc:mysql://localhost:3306/sampleDatabase\(dq, \(dqjndi\-name\(dq: \(dqjava:jboss/datasources/sampleDS\(dq, \(dquser\-name\(dq: \(dqsampleuser\(dq, \(dqpassword\(dq: \(dqsecret\(dq, \(dqmin\-pool\-size\(dq: 3, \(dquse\-java\-context\(dq: True}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jboss7.update_simple_binding(jboss_config, binding_name, value, profile=None)
Update the simple jndi binding in the running jboss instance
.INDENT 7.0
.TP
.B jboss_config
Configuration dictionary with properties specified above.
.TP
.B binding_name
Binding name to be updated
.TP
.B value
New binding value
.TP
.B profile
The profile name (JBoss domain mode only)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jboss7.update_simple_binding \(aq{\(dqcli_path\(dq: \(dqintegration.modules.sysmod.SysModuleTest.test_valid_docs\(dq, \(dqcontroller\(dq: \(dq10.11.12.13:9999\(dq, \(dqcli_user\(dq: \(dqjbossadm\(dq, \(dqcli_password\(dq: \(dqjbossadm\(dq}\(aq my_binding_name my_binding_value
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.jboss7_cli
.sp
Module for low\-level interaction with JbossAS7 through CLI.
.sp
This module exposes two ways of interaction with the CLI, either through commands or operations.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Following JBoss documentation (\fI\%https://developer.jboss.org/wiki/CommandLineInterface\fP):
\(dqOperations are considered a low level but comprehensive way to manage the AS controller, i.e. if it can\(aqt be done with operations it can\(aqt be done in any other way.
Commands, on the other hand, are more user\-friendly in syntax,
although most of them still translate into operation requests and some of them even into a few
composite operation requests, i.e. commands also simplify some management operations from the user\(aqs point of view.\(dq
.UNINDENT
.UNINDENT
.sp
The difference between calling a command or operation is in handling the result.
Commands return a zero return code if operation is successful or return non\-zero return code and
print an error to standard output in plain text, in case of an error.
.sp
Operations return a json\-like structure, that contain more information about the result.
In case of a failure, they also return a specific return code. This module parses the output from the operations and
returns it as a dictionary so that an execution of an operation can then be verified against specific errors.
.INDENT 0.0
.TP
.B In order to run each function, jboss_config dictionary with the following properties must be passed:
.INDENT 7.0
.IP \(bu 2
cli_path: the path to jboss\-cli script, for example: \(aq/opt/jboss/jboss\-7.0/bin/jboss\-cli.sh\(aq
.IP \(bu 2
controller: the IP address and port of controller, for example: 10.11.12.13:9999
.IP \(bu 2
cli_user: username to connect to jboss administration console if necessary
.IP \(bu 2
cli_password: password to connect to jboss administration console if necessary
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jboss_config:
   cli_path: \(aq/opt/jboss/jboss\-7.0/bin/jboss\-cli.sh\(aq
   controller: 10.11.12.13:9999
   cli_user: \(aqjbossadm\(aq
   cli_password: \(aqjbossadm\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jboss7_cli.run_command(jboss_config, command, fail_on_error=True)
Execute a command against jboss instance through the CLI interface.
.INDENT 7.0
.TP
.B jboss_config
Configuration dictionary with properties specified above.
.TP
.B command
Command to execute against jboss instance
.TP
.B fail_on_error (default=True)
Is true, raise CommandExecutionError exception if execution fails.
If false, \(aqsuccess\(aq property of the returned dictionary is set to False
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jboss7_cli.run_command \(aq{\(dqcli_path\(dq: \(dqintegration.modules.sysmod.SysModuleTest.test_valid_docs\(dq, \(dqcontroller\(dq: \(dq10.11.12.13:9999\(dq, \(dqcli_user\(dq: \(dqjbossadm\(dq, \(dqcli_password\(dq: \(dqjbossadm\(dq}\(aq my_command
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jboss7_cli.run_operation(jboss_config, operation, fail_on_error=True, retries=1)
Execute an operation against jboss instance through the CLI interface.
.INDENT 7.0
.TP
.B jboss_config
Configuration dictionary with properties specified above.
.TP
.B operation
An operation to execute against jboss instance
.TP
.B fail_on_error (default=True)
Is true, raise CommandExecutionError exception if execution fails.
If false, \(aqsuccess\(aq property of the returned dictionary is set to False
.TP
.B retries:
Number of retries in case of \(dqJBAS012144: Could not connect to remote\(dq error.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jboss7_cli.run_operation \(aq{\(dqcli_path\(dq: \(dqintegration.modules.sysmod.SysModuleTest.test_valid_docs\(dq, \(dqcontroller\(dq: \(dq10.11.12.13:9999\(dq, \(dqcli_user\(dq: \(dqjbossadm\(dq, \(dqcli_password\(dq: \(dqjbossadm\(dq}\(aq my_operation
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.jenkinsmod
.sp
Module for controlling Jenkins
.INDENT 0.0
.TP
.B depends
python\-jenkins
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B depends
\fI\%python\-jenkins\fP Python module (not to be confused with \fI\%jenkins\fP)
.UNINDENT
.INDENT 0.0
.TP
.B configuration
This module can be used by either passing an api key and version
directly or by specifying both in a configuration profile in the salt
master/minion config.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins:
  api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jenkinsmod.build_job(name=None, parameters=None)
Initiate a build for the provided job.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The name of the job is check if it exists.
.IP \(bu 2
\fBparameters\fP \-\- Parameters to send to the job.
.UNINDENT
.TP
.B Returns
True is successful, otherwise raise an exception.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jenkins.build_job jobname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jenkinsmod.create_job(name=None, config_xml=None, saltenv=\(aqbase\(aq)
Return the configuration file.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The name of the job is check if it exists.
.IP \(bu 2
\fBconfig_xml\fP \-\- The configuration file to use to create the job.
.IP \(bu 2
\fBsaltenv\fP \-\- The environment to look for the file in.
.UNINDENT
.TP
.B Returns
The configuration file used for the job.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jenkins.create_job jobname

salt \(aq*\(aq jenkins.create_job jobname config_xml=\(aqsalt://jenkins/config.xml\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jenkinsmod.delete_job(name=None)
Return true is job is deleted successfully.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- The name of the job to delete.
.TP
.B Returns
Return true if job is deleted successfully.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jenkins.delete_job jobname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jenkinsmod.disable_job(name=None)
Return true is job is disabled successfully.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- The name of the job to disable.
.TP
.B Returns
Return true if job is disabled successfully.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jenkins.disable_job jobname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jenkinsmod.enable_job(name=None)
Return true is job is enabled successfully.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- The name of the job to enable.
.TP
.B Returns
Return true if job is enabled successfully.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jenkins.enable_job jobname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jenkinsmod.get_job_config(name=None)
Return the current job configuration for the provided job.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- The name of the job to return the configuration for.
.TP
.B Returns
The configuration for the job specified.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jenkins.get_job_config jobname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jenkinsmod.get_job_info(name=None)
Return information about the Jenkins job.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- The name of the job is check if it exists.
.TP
.B Returns
Information about the Jenkins job.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jenkins.get_job_info jobname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jenkinsmod.get_jobs()
Return the currently configured jobs.
.INDENT 7.0
.TP
.B Returns
The currently configured jobs.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jenkins.get_jobs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jenkinsmod.get_version()
Return version of Jenkins
.INDENT 7.0
.TP
.B Returns
The version of Jenkins
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jenkins.get_version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jenkinsmod.job_exists(name=None)
Check whether the job exists in configured Jenkins jobs.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- The name of the job is check if it exists.
.TP
.B Returns
True if job exists, False if job does not exist.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jenkins.job_exists jobname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jenkinsmod.job_status(name=None)
Return the current status, enabled or disabled, of the job.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- The name of the job to return status for
.TP
.B Returns
Return true if enabled or false if disabled.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jenkins.job_status jobname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jenkinsmod.plugin_installed(name)
New in version 2016.11.0.

.sp
Return if the plugin is installed for the provided plugin name.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- The name of the parameter to confirm installation.
.TP
.B Returns
True if plugin exists, False if plugin does not exist.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jenkins.plugin_installed pluginName
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jenkinsmod.run(script)
New in version 2017.7.0.

.sp
Execute a script on the jenkins master
.INDENT 7.0
.TP
.B Parameters
\fBscript\fP \-\- The script
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jenkins.run \(aqJenkins.instance.doSafeRestart()\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jenkinsmod.update_job(name=None, config_xml=None, saltenv=\(aqbase\(aq)
Return the updated configuration file.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The name of the job is check if it exists.
.IP \(bu 2
\fBconfig_xml\fP \-\- The configuration file to use to create the job.
.IP \(bu 2
\fBsaltenv\fP \-\- The environment to look for the file in.
.UNINDENT
.TP
.B Returns
The configuration file used for the job.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jenkins.update_job jobname

salt \(aq*\(aq jenkins.update_job jobname config_xml=\(aqsalt://jenkins/config.xml\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.jinja
.sp
Module for checking jinja maps and verifying the result of loading JSON/YAML
files
.sp
New in version 3000.

.INDENT 0.0
.TP
.B salt.modules.jinja.import_json(path)
Loads JSON data from the specified path
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion jinja.import_JSON myformula/foo.json
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jinja.import_yaml(path)
Loads YAML data from the specified path
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion jinja.import_yaml myformula/foo.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jinja.load_map(path, value)
Loads the map at the specified path, and returns the specified value from
that map.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Assuming the map is loaded in your formula SLS as follows:
#
# {% from \(dqmyformula/map.jinja\(dq import myformula with context %}
#
# the following syntax can be used to load the map and check the
# results:
salt myminion jinja.load_map myformula/map.jinja myformula
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.jira_mod
.SS JIRA Execution module
.sp
New in version 2019.2.0.

.sp
Execution module to manipulate JIRA tickets via Salt.
.sp
This module requires the \fBjira\fP Python library to be installed.
.sp
Configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jira:
  server: https://jira.atlassian.org
  username: salt
  password: pass
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jira_mod.add_comment(issue_key, comment, visibility=None, is_internal=False, server=None, username=None, password=None)
Add a comment to an existing ticket. Return \fBTrue\fP when it successfully
added the comment.
.INDENT 7.0
.TP
.B issue_key
The issue ID to add the comment to.
.TP
.B comment
The body of the comment to be added.
.TP
.B visibility: \fBNone\fP
A dictionary having two keys:
.INDENT 7.0
.IP \(bu 2
\fBtype\fP: is \fBrole\fP (or \fBgroup\fP if the JIRA server has configured
comment visibility for groups).
.IP \(bu 2
\fBvalue\fP: the name of the role (or group) to which viewing of this
comment will be restricted.
.UNINDENT
.TP
.B is_internal: \fBFalse\fP
Whether a comment has to be marked as \fBInternal\fP in Jira Service Desk.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jira.add_comment NE\-123 \(aqThis is a comment\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jira_mod.assign_issue(issue_key, assignee, server=None, username=None, password=None)
Assign the issue to an existing user. Return \fBTrue\fP when the issue has
been properly assigned.
.INDENT 7.0
.TP
.B issue_key
The JIRA ID of the ticket to manipulate.
.TP
.B assignee
The name of the user to assign the ticket to.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jira.assign_issue NET\-123 example_user
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jira_mod.create_issue(project, summary, description, template_engine=\(aqjinja\(aq, context=None, defaults=None, saltenv=\(aqbase\(aq, issuetype=\(aqBug\(aq, priority=\(aqNormal\(aq, labels=None, assignee=None, server=None, username=None, password=None, **kwargs)
Create a JIRA issue using the named settings. Return the JIRA ticket ID.
.INDENT 7.0
.TP
.B project
The name of the project to attach the JIRA ticket to.
.TP
.B summary
The summary (title) of the JIRA ticket. When the \fBtemplate_engine\fP
argument is set to a proper value of an existing Salt template engine
(e.g., \fBjinja\fP, \fBmako\fP, etc.) it will render the \fBsummary\fP before
creating the ticket.
.TP
.B description
The full body description of the JIRA ticket. When the \fBtemplate_engine\fP
argument is set to a proper value of an existing Salt template engine
(e.g., \fBjinja\fP, \fBmako\fP, etc.) it will render the \fBdescription\fP before
creating the ticket.
.TP
.B template_engine: \fBjinja\fP
The name of the template engine to be used to render the values of the
\fBsummary\fP and \fBdescription\fP arguments. Default: \fBjinja\fP\&.
.TP
.B context: \fBNone\fP
The context to pass when rendering the \fBsummary\fP and \fBdescription\fP\&.
This argument is ignored when \fBtemplate_engine\fP is set as \fBNone\fP
.TP
.B defaults: \fBNone\fP
Default values to pass to the Salt rendering pipeline for the
\fBsummary\fP and \fBdescription\fP arguments.
This argument is ignored when \fBtemplate_engine\fP is set as \fBNone\fP\&.
.TP
.B saltenv: \fBbase\fP
The Salt environment name (for the rendering system).
.TP
.B issuetype: \fBBug\fP
The type of the JIRA ticket. Default: \fBBug\fP\&.
.TP
.B priority: \fBNormal\fP
The priority of the JIRA ticket. Default: \fBNormal\fP\&.
.TP
.B labels: \fBNone\fP
A list of labels to add to the ticket.
.TP
.B assignee: \fBNone\fP
The name of the person to assign the ticket to.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jira.create_issue NET \(aqTicket title\(aq \(aqTicket description\(aq
salt \(aq*\(aq jira.create_issue NET \(aqIssue on {{ opts.id }}\(aq \(aqError detected on {{ opts.id }}\(aq template_engine=jinja
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.jira_mod.issue_closed(issue_key, server=None, username=None, password=None)
Check if the issue is closed.
.INDENT 7.0
.TP
.B issue_key
The JIRA iD of the ticket to close.
.UNINDENT
.sp
Returns:
.INDENT 7.0
.IP \(bu 2
\fBTrue\fP: the ticket exists and it is closed.
.IP \(bu 2
\fBFalse\fP: the ticket exists and it has not been closed.
.IP \(bu 2
\fBNone\fP: the ticket does not exist.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq jira.issue_closed NE\-123
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.junos
.sp
Module to interact with Junos devices.
.INDENT 0.0
.TP
.B maturity
new
.TP
.B dependencies
junos\-eznc, jxmlease
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Those who wish to use junos\-eznc (PyEZ) version >= 2.1.0, must
use the latest salt code from github until the next release.
.UNINDENT
.UNINDENT
.sp
Refer to \fI\%junos\fP for information on connecting to junos proxy.
.INDENT 0.0
.TP
.B class  salt.modules.junos.HandleFileCopy(path, **kwargs)
To figure out proper path either from proxy local file system
or proxy cache or on master. If required, then only copy from
master to proxy
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.cli(command=None, **kwargs)
Executes the CLI commands and returns the output in specified format.     (default is text) The output can also be stored in a file.
.INDENT 7.0
.TP
.B command (required)
The command to execute on the Junos CLI
.TP
.B format
text
Format in which to get the CLI output (either \fBtext\fP or \fBxml\fP)
.TP
.B dev_timeout
30
The NETCONF RPC timeout (in seconds)
.TP
.B dest
Destination file where the RPC output is stored. Note that the file
will be stored on the proxy minion. To push the files to the master use
\fI\%cp.push\fP\&.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.cli \(aqshow system commit\(aq
salt \(aqdevice_name\(aq junos.cli \(aqshow system alarms\(aq format=xml dest=/home/user/cli_output.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.commit(**kwargs)
To commit the changes loaded in the candidate configuration.
.INDENT 7.0
.TP
.B dev_timeout
30
The NETCONF RPC timeout (in seconds)
.TP
.B comment
Provide a comment for the commit
.TP
.B confirm
Provide time in minutes for commit confirmation. If this option is
specified, the commit will be rolled back in the specified amount of time
unless the commit is confirmed.
.TP
.B sync
False
When \fBTrue\fP, on dual control plane systems, requests that the candidate
configuration on one control plane be copied to the other control plane,
checked for correct syntax, and committed on both Routing Engines.
.TP
.B force_sync
False
When \fBTrue\fP, on dual control plane systems, force the candidate
configuration on one control plane to be copied to the other control
plane.
.TP
.B full
When \fBTrue\fP, requires all the daemons to check and evaluate the new
configuration.
.TP
.B detail
When \fBTrue\fP, return commit detail
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.commit comment=\(aqCommiting via saltstack\(aq detail=True
salt \(aqdevice_name\(aq junos.commit dev_timeout=60 confirm=10
salt \(aqdevice_name\(aq junos.commit sync=True dev_timeout=90
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.commit_check()
Perform a commit check on the configuration
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.commit_check
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.diff(**kwargs)
Returns the difference between the candidate and the current configuration
.INDENT 7.0
.TP
.B id
0
The rollback ID value (0\-49)
.TP
.B d_id
0
The rollback ID value (0\-49)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.diff d_id=3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
NOTE: Because of historical reasons and the internals of the Salt state
compiler, there are three possible sources of the rollback ID\-\-the
positional argument, and the \fIid\fP and \fId_id\fP kwargs.  The precedence of
the arguments are \fIid\fP (positional), \fIid\fP (kwarg), \fId_id\fP (kwarg).  In
other words, if all three are passed, only the positional argument
will be used.  A warning is logged if more than one is passed.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.dir_copy(source, dest, force=False, **kwargs)
Copy a directory and recursively its contents from source to dest.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function only works on the Juniper native minion
.UNINDENT
.UNINDENT
.sp
Parameters:
.sp
source : Directory to use as the source
.sp
dest : Directory in which to place the source and its contents.
.sp
force : This function will not copy identical files unless \fIforce\fP is \fITrue\fP
.sp
New in version 3003.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.dir_copy /etc/salt/pki re1:/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will take the \fIpki\fP directory, its absolute path and copy it and its
contents to routing engine 1 root directory. The result will be
\fIre1:/etc/salt/pki/<files and dirs in /etc/salt/pki\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.facts()
Displays the facts gathered during the connection.
These facts are also stored in Salt grains.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.facts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.facts_refresh()
Reload the facts dictionary from the device. Usually only needed if,
the device configuration is changed by some other actor.
This function will also refresh the facts stored in the salt grains.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.facts_refresh
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.file_compare(file1, file2, **kwargs)
Compare two files and return a dictionary indicating if they
are different.
.sp
Dictionary includes \fIsuccess\fP key.  If False, one or more files do not
exist or some other error occurred.
.sp
Under the hood, this uses the junos CLI command \fIfile compare files ...\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function only works on Juniper native minions
.UNINDENT
.UNINDENT
.sp
New in version 3003.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt junos\-router junos.file_compare /var/tmp/backup1/cmt.script /var/tmp/backup2/cmt.script

junos\-router:
    identical:
        False
    success:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.file_copy(src, dest)
Copies the file from the local device to the junos device
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function does not work on Juniper native minions
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B src
The source path where the file is kept.
.TP
.B dest
The destination path on the where the file will be copied
.UNINDENT
.sp
New in version 3001.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.file_copy /home/m2/info.txt info_copy.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.fsentry_exists(dir, **kwargs)
Returns a dictionary indicating if \fIdir\fP refers to a file
or a non\-file (generally a directory) in the file system,
or if there is no file by that name.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function only works on Juniper native minions
.UNINDENT
.UNINDENT
.sp
New in version 3003.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt junos\-router junos.fsentry_exists /var/log

junos\-router:
    is_dir:
        True
    exists:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.get_table(table, table_file, path=None, target=None, key=None, key_items=None, filters=None, table_args=None)
New in version 3001.

.sp
Retrieve data from a Junos device using Tables/Views
.INDENT 7.0
.TP
.B table (required)
Name of PyEZ Table
.TP
.B table_file (required)
YAML file that has the table specified in table parameter
.TP
.B path:
Path of location of the YAML file.
defaults to op directory in jnpr.junos.op
.TP
.B target:
if command need to run on FPC, can specify fpc target
.TP
.B key:
To overwrite key provided in YAML
.TP
.B key_items:
To select only given key items
.TP
.B filters:
To select only filter for the dictionary from columns
.TP
.B table_args:
key/value pair which should render Jinja template command
or are passed as args to rpc call in op table
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.get_table RouteTable routes.yml
salt \(aqdevice_name\(aq junos.get_table EthPortTable ethport.yml table_args=\(aq{\(dqinterface_name\(dq: \(dqge\-3/2/2\(dq}\(aq
salt \(aqdevice_name\(aq junos.get_table EthPortTable ethport.yml salt://tables
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.install_config(path=None, **kwargs)
Installs the given configuration file into the candidate configuration.
Commits the changes if the commit checks or throws an error.
.INDENT 7.0
.TP
.B path (required)
Path where the configuration/template file is present. If the file has
a \fB\&.conf\fP extension, the content is treated as text format. If the
file has a \fB\&.xml\fP extension, the content is treated as XML format. If
the file has a \fB\&.set\fP extension, the content is treated as Junos OS
\fBset\fP commands.
.TP
.B mode
exclusive
The mode in which the configuration is locked. Can be one of
\fBprivate\fP, \fBdynamic\fP, \fBbatch\fP, \fBexclusive\fP, \fBephemeral\fP
.TP
.B dev_timeout
30
Set NETCONF RPC timeout. Can be used for commands which take a while to
execute.
.TP
.B overwrite
False
Set to \fBTrue\fP if you want this file is to completely replace the
configuration file. Sets action to override
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option cannot be used if \fBformat\fP is \(dqset\(dq.
.UNINDENT
.UNINDENT
.TP
.B replace
False
Specify whether the configuration file uses \fBreplace:\fP statements. If
\fBTrue\fP, only those statements under the \fBreplace\fP tag will be
changed.
.TP
.B merge
False
If set to \fBTrue\fP will set the load\-config action to merge.
the default load\-config action is \(aqreplace\(aq for xml/json/text config
.TP
.B format
Determines the format of the contents
.TP
.B update
False
Compare a complete loaded configuration against the candidate
configuration. For each hierarchy level or configuration object that is
different in the two configurations, the version in the loaded
configuration replaces the version in the candidate configuration. When
the configuration is later committed, only system processes that are
affected by the changed configuration elements parse the new
configuration. This action is supported from PyEZ 2.1.
.TP
.B comment
Provide a comment for the commit
.TP
.B confirm
Provide time in minutes for commit confirmation. If this option is
specified, the commit will be rolled back in the specified amount of time
unless the commit is confirmed.
.TP
.B diffs_file
Path to the file where the diff (difference in old configuration and the
committed configuration) will be stored. Note that the file will be
stored on the proxy minion. To push the files to the master use:
.INDENT 7.0
.INDENT 3.5
py:func:\fIcp.push <salt.modules.cp.push>\fP\&.
.UNINDENT
.UNINDENT
.TP
.B template_vars
Variables to be passed into the template processing engine in addition to
those present in pillar, the minion configuration, grains, etc.  You may
reference these variables in your template like so:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{{ template_vars[\(dqvar_name\(dq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.install_config \(aqsalt://production/network/routers/config.set\(aq
salt \(aqdevice_name\(aq junos.install_config \(aqsalt://templates/replace_config.conf\(aq replace=True comment=\(aqCommitted via SaltStack\(aq
salt \(aqdevice_name\(aq junos.install_config \(aqsalt://my_new_configuration.conf\(aq dev_timeout=300 diffs_file=\(aq/salt/confs/old_config.conf\(aq overwrite=True
salt \(aqdevice_name\(aq junos.install_config \(aqsalt://syslog_template.conf\(aq template_vars=\(aq{\(dqsyslog_host\(dq: \(dq10.180.222.7\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.install_os(path=None, **kwargs)
Installs the given image on the device. After the installation is complete
the device is rebooted, if reboot=True is given as a keyworded argument.
.INDENT 7.0
.TP
.B path (required)
Path where the image file is present on the proxy minion
.TP
.B remote_path
/var/tmp
If the value of path  is a file path on the local
(Salt host\(aqs) filesystem, then the image is copied from the local
filesystem to the :remote_path: directory on the target Junos
device. The default is \fB/var/tmp\fP\&. If the value of :path: or
is a URL, then the value of :remote_path: is unused.
.TP
.B dev_timeout
1800
The NETCONF RPC timeout (in seconds). This argument was added since most of
the time the \(dqpackage add\(dq RPC takes a significant amount of time.
So this :timeout: value will be used in the context of the SW installation
process.  Defaults to 30 minutes (30*60=1800 seconds)
.TP
.B timeout
1800
Alias to dev_timeout for backward compatibility
.TP
.B reboot
False
Whether to reboot after installation
.TP
.B no_copy
False
If \fBTrue\fP the software package will not be SCP’d to the device
.TP
.B bool validate:
When \fBTrue\fP this method will perform a config validation against
the new image
.TP
.B bool issu: False
When \fBTrue\fP allows unified in\-service software upgrade
(ISSU) feature enables you to upgrade between two different Junos OS
releases with no disruption on the control plane and with minimal
disruption of traffic.
.TP
.B bool nssu: False
When \fBTrue\fP allows nonstop software upgrade (NSSU)
enables you to upgrade the software running on a Juniper Networks
EX Series Virtual Chassis or a Juniper Networks EX Series Ethernet
Switch with redundant Routing Engines with a single command and
minimal disruption to network traffic.
.TP
.B bool all_re: True
When True (default), executes the software install on all Routing Engines of the Junos
device. When False, execute the software install only on the current Routing Engine.
.sp
New in version 3001.

.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Any additional keyword arguments specified are passed down to PyEZ sw.install() as is.
Please refer to below URl for PyEZ sw.install() documentation:
\fI\%https://pyez.readthedocs.io/en/latest/jnpr.junos.utils.html#jnpr.junos.utils.sw.SW.install\fP
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.install_os \(aqsalt://images/junos_image.tgz\(aq reboot=True
salt \(aqdevice_name\(aq junos.install_os \(aqsalt://junos_16_1.tgz\(aq dev_timeout=300
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.load(path=None, **kwargs)
Loads the configuration from the file provided onto the device.
.INDENT 7.0
.TP
.B path (required)
Path where the configuration/template file is present. If the file has
a \fB\&.conf\fP extension, the content is treated as text format. If the
file has a \fB\&.xml\fP extension, the content is treated as XML format. If
the file has a \fB\&.set\fP extension, the content is treated as Junos OS
\fBset\fP commands.
.TP
.B overwrite
False
Set to \fBTrue\fP if you want this file is to completely replace the
configuration file. Sets action to override
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option cannot be used if \fBformat\fP is \(dqset\(dq.
.UNINDENT
.UNINDENT
.TP
.B replace
False
Specify whether the configuration file uses \fBreplace:\fP statements. If
\fBTrue\fP, only those statements under the \fBreplace\fP tag will be
changed.
.TP
.B merge
False
If set to \fBTrue\fP will set the load\-config action to merge.
the default load\-config action is \(aqreplace\(aq for xml/json/text config
.TP
.B update
False
Compare a complete loaded configuration against the candidate
configuration. For each hierarchy level or configuration object that is
different in the two configurations, the version in the loaded
configuration replaces the version in the candidate configuration. When
the configuration is later committed, only system processes that are
affected by the changed configuration elements parse the new
configuration. This action is supported from PyEZ 2.1.
.TP
.B format
Determines the format of the contents
.TP
.B template_vars
Variables to be passed into the template processing engine in addition to
those present in pillar, the minion configuration, grains, etc.  You may
reference these variables in your template like so:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{{ template_vars[\(dqvar_name\(dq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.load \(aqsalt://production/network/routers/config.set\(aq

salt \(aqdevice_name\(aq junos.load \(aqsalt://templates/replace_config.conf\(aq replace=True

salt \(aqdevice_name\(aq junos.load \(aqsalt://my_new_configuration.conf\(aq overwrite=True

salt \(aqdevice_name\(aq junos.load \(aqsalt://syslog_template.conf\(aq template_vars=\(aq{\(dqsyslog_host\(dq: \(dq10.180.222.7\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.lock()
Attempts an exclusive lock on the candidate configuration. This
is a non\-blocking call.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When locking, it is important to remember to call
\fI\%junos.unlock\fP once finished. If
locking during orchestration, remember to include a step in the
orchestration job to unlock.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.lock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.ping(dest_ip=None, **kwargs)
Send a ping RPC to a device
.INDENT 7.0
.TP
.B dest_ip
The IP of the device to ping
.TP
.B dev_timeout
30
The NETCONF RPC timeout (in seconds)
.TP
.B rapid
False
When \fBTrue\fP, executes ping at 100pps instead of 1pps
.TP
.B ttl
Maximum number of IP routers (IP hops) allowed between source and
destination
.TP
.B routing_instance
Name of the routing instance to use to send the ping
.TP
.B interface
Interface used to send traffic
.TP
.B count
5
Number of packets to send
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.ping \(aq8.8.8.8\(aq count=5
salt \(aqdevice_name\(aq junos.ping \(aq8.8.8.8\(aq ttl=1 rapid=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.rollback(**kwargs)
Roll back the last committed configuration changes and commit
.INDENT 7.0
.TP
.B id
0
The rollback ID value (0\-49)
.TP
.B d_id
0
The rollback ID value (0\-49)
.TP
.B dev_timeout
30
The NETCONF RPC timeout (in seconds)
.TP
.B comment
Provide a comment for the commit
.TP
.B confirm
Provide time in minutes for commit confirmation. If this option is
specified, the commit will be rolled back in the specified amount of time
unless the commit is confirmed.
.TP
.B diffs_file
Path to the file where the diff (difference in old configuration and the
committed configuration) will be stored. Note that the file will be
stored on the proxy minion. To push the files to the master use
\fI\%cp.push\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.rollback 10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
NOTE: Because of historical reasons and the internals of the Salt state
compiler, there are three possible sources of the rollback ID\-\-the
positional argument, and the \fIid\fP and \fId_id\fP kwargs.  The precedence of
the arguments are \fIid\fP (positional), \fIid\fP (kwarg), \fId_id\fP (kwarg).  In
other words, if all three are passed, only the positional argument
will be used.  A warning is logged if more than one is passed.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.routing_engine(**kwargs)
Returns a dictionary containing the routing engines on the device and
their status (Master, Disabled, Backup).
.sp
Under the hood parses the result of \fIshow chassis routing\-engine\fP
.sp
New in version 3003.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt junos\-router junos.routing_engine

junos\-router:
    backup:
      \- re1:
    master:
      re0:
    success:
      True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns \fIsuccess: False\fP if the device does not appear to have multiple routing engines.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.rpc(cmd=None, dest=None, **kwargs)
This function executes the RPC provided as arguments on the junos device.
The returned data can be stored in a file.
.INDENT 7.0
.TP
.B cmd
The RPC to be executed
.TP
.B dest
Destination file where the RPC output is stored. Note that the file
will be stored on the proxy minion. To push the files to the master use
\fI\%cp.push\fP\&.
.TP
.B format
xml
The format in which the RPC reply is received from the device
.TP
.B dev_timeout
30
The NETCONF RPC timeout (in seconds)
.TP
.B filter
Used with the \fBget\-config\fP RPC to get specific configuration
.TP
.B terse
False
Amount of information you want
.TP
.B interface_name
Name of the interface to query
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice\(aq junos.rpc get_config dest=/var/log/config.txt format=text filter=\(aq<configuration><system/></configuration>\(aq
salt \(aqdevice\(aq junos.rpc get\-interface\-information dest=/home/user/interface.xml interface_name=\(aqlo0\(aq terse=True
salt \(aqdevice\(aq junos.rpc get\-chassis\-inventory
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.rpc_file_list(path, **kwargs)
Use the Junos RPC interface to get a list of files and return
them as a structure dictionary.
.sp
New in version 3003.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt junos\-router junos.rpc_file_list /var/local/salt/etc

junos\-router:
    files:
        directory:
            directory\-name:
                /var/local/salt/etc
            file\-information:
                |_
                  file\-directory:
                      file\-name:
                          pki
                |_
                  file\-name:
                      proxy
                |_
                  file\-directory:
                      file\-name:
                          proxy.d
        total\-file\-blocks:
            10
        total\-files:
            1
success:
    True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.set_hostname(hostname=None, **kwargs)
Set the device\(aqs hostname
.INDENT 7.0
.TP
.B hostname
The name to be set
.TP
.B comment
Provide a comment to the commit
.TP
.B dev_timeout
30
The NETCONF RPC timeout (in seconds)
.TP
.B confirm
Provide time in minutes for commit confirmation. If this option is
specified, the commit will be rolled back in the specified amount of time
unless the commit is confirmed.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.set_hostname salt\-device
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.shutdown(**kwargs)
Shut down (power off) or reboot a device running Junos OS. This includes
all Routing Engines in a Virtual Chassis or a dual Routing Engine system.
.INDENT 7.0
.INDENT 3.5
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
One of \fBshutdown\fP or \fBreboot\fP must be set to \fBTrue\fP or no
action will be taken.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B shutdown
False
Set this to \fBTrue\fP if you want to shutdown the machine. This is a
safety mechanism so that the user does not accidentally shutdown the
junos device.
.TP
.B reboot
False
If \fBTrue\fP, reboot instead of shutting down
.TP
.B at
Used when rebooting, to specify the date and time the reboot should take
place. The value of this option must match the JunOS CLI reboot syntax.
.TP
.B in_min
Used when shutting down. Specify the delay (in minutes) before the
device will be shut down.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.shutdown reboot=True
salt \(aqdevice_name\(aq junos.shutdown shutdown=True in_min=10
salt \(aqdevice_name\(aq junos.shutdown shutdown=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.unlock()
Unlocks the candidate configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.unlock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.junos.zeroize()
Resets the device to default factory settings
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
In case of non\-root user, proxy_reconnect will not be able
to re\-connect to the device as zeroize will delete the local
user\(aqs configuration.
For more details on zeroize functionality, please refer
\fI\%https://www.juniper.net/documentation/en_US/junos/topics/reference/command\-summary/request\-system\-zeroize.html\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice_name\(aq junos.zeroize
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.k8s
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%kubernetes Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Salt module to manage Kubernetes cluster
.sp
New in version 2016.3.0.

.sp
Roadmap:
.INDENT 0.0
.IP \(bu 2
Add creation of K8S objects (pod, rc, service, ...)
.IP \(bu 2
Add replace of K8S objects (pod, rc, service, ...)
.IP \(bu 2
Add deletion of K8S objects (pod, rc, service, ...)
.IP \(bu 2
Add rolling update
.IP \(bu 2
Add (auto)scalling
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.k8s.create_namespace(name, apiserver_url=None)
New in version 2016.3.0.

.sp
Create kubernetes namespace from the name, similar to the functionality added to kubectl since v.1.2.0:
\&.. code\-block:: bash
.INDENT 7.0
.INDENT 3.5
kubectl create namespaces namespace\-name
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq k8s.create_namespace namespace_name

salt \(aq*\(aq k8s.create_namespace namespace_name http://kube\-master.cluster.local
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.k8s.create_secret(namespace, name, sources, apiserver_url=None, force=False, update=False, saltenv=\(aqbase\(aq)
New in version 2016.3.0.

.sp
Create k8s secrets in the defined namespace from the list of files
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq k8s.create_secret namespace_name secret_name sources

salt \(aq*\(aq k8s.create_secret namespace_name secret_name sources
http://kube\-master.cluster.local
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
sources are either dictionary of {name: path, name1: path} pairs or array of strings defining paths.
.sp
Example of paths array:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
[\(aq/full/path/filename\(aq, \(dq\fI\%file:///full/path/filename\fP\(dq, \(dqsalt://secret/storage/file.txt\(dq, \(dqhttp://user:password@securesite.com/secret\-file.json\(dq]
.sp
Example of dictionaries:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
{\(dqnameit\(dq: \(aq/full/path/fiename\(aq, name2: \(dqsalt://secret/storage/file.txt\(dq}
.sp
optional parameters accepted:
.sp
update=[false] default value is false
if set to false, and secret is already present on the cluster \- warning will be returned and no changes to the secret will be done.
In case it is set to \(dqtrue\(dq and secret is present but data is differ \- secret will be updated.
.sp
force=[true] default value is true
if the to False, secret will not be created in case one of the files is not
valid kubernetes secret. e.g. capital letters in secret name or _
in case force is set to True, wrong files will be skipped but secret will be created any way.
.sp
saltenv=[\(aqbase\(aq] default value is base
in case \(aqsalt://\(aq path is used, this parameter can change the visibility of files
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.k8s.delete_secret(namespace, name, apiserver_url=None, force=True)
New in version 2016.3.0.

.sp
Delete kubernetes secret in the defined namespace. Namespace is the mandatory parameter as well as name.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq k8s.delete_secret namespace_name secret_name

salt \(aq*\(aq k8s.delete_secret namespace_name secret_name http://kube\-master.cluster.local
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.k8s.get_labels(node=None, apiserver_url=None)
New in version 2016.3.0.

.sp
Get labels from the current node
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq k8s.get_labels
salt \(aq*\(aq k8s.get_labels kube\-node.cluster.local http://kube\-master.cluster.local
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.k8s.get_namespaces(namespace=\(aq\(aq, apiserver_url=None)
New in version 2016.3.0.

.sp
Get one or all kubernetes namespaces.
.sp
If namespace parameter is omitted, all namespaces will be returned back to user, similar to following kubectl example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
kubectl get namespaces \-o json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In case namespace is set by user, the output will be similar to the one from kubectl:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
kubectl get namespaces namespace_name \-o json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq k8s.get_namespaces
salt \(aq*\(aq k8s.get_namespaces namespace_name http://kube\-master.cluster.local
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.k8s.get_secrets(namespace, name=\(aq\(aq, apiserver_url=None, decode=False, brief=False)
Get k8s namespaces
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq k8s.get_secrets namespace_name
salt \(aq*\(aq k8s.get_secrets namespace_name secret_name http://kube\-master.cluster.local
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.k8s.label_absent(name, node=None, apiserver_url=None)
New in version 2016.3.0.

.sp
Delete label to the current node
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq k8s.label_absent hw/disktype
salt \(aq*\(aq k8s.label_absent hw/disktype kube\-node.cluster.local http://kube\-master.cluster.local
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.k8s.label_folder_absent(name, node=None, apiserver_url=None)
New in version 2016.3.0.

.sp
Delete label folder to the current node
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq k8s.label_folder_absent hw
salt \(aq*\(aq k8s.label_folder_absent hw/ kube\-node.cluster.local http://kube\-master.cluster.local
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.k8s.label_present(name, value, node=None, apiserver_url=None)
New in version 2016.3.0.

.sp
Set label to the current node
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq k8s.label_present hw/disktype ssd

salt \(aq*\(aq k8s.label_present hw/disktype ssd kube\-node.cluster.local http://kube\-master.cluster.local
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.k8s.update_secret(namespace, name, sources, apiserver_url=None, force=True, saltenv=\(aqbase\(aq)
New in version 2016.3.0.

.sp
alias to k8s.create_secret with update=true
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq k8s.update_secret namespace_name secret_name sources [apiserver_url] [force=true] [update=false] [saltenv=\(aqbase\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
sources are either dictionary of {name: path, name1: path} pairs or array of strings defining paths.
.sp
Example of paths array:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
[\(aq/full/path/filename\(aq, \(dq\fI\%file:///full/path/filename\fP\(dq, \(dqsalt://secret/storage/file.txt\(dq, \(dqhttp://user:password@securesite.com/secret\-file.json\(dq]
.sp
Example of dictionaries:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
{\(dqnameit\(dq: \(aq/full/path/fiename\(aq, name2: \(dqsalt://secret/storage/file.txt\(dq}
.sp
optional parameters accepted:
.sp
force=[true] default value is true
if the to False, secret will not be created in case one of the files is not
valid kubernetes secret. e.g. capital letters in secret name or _
in case force is set to True, wrong files will be skipped but secret will be created any way.
.sp
saltenv=[\(aqbase\(aq] default value is base
in case \(aqsalt://\(aq path is used, this parameter can change the visibility of files
.UNINDENT
.SS salt.modules.kapacitor
.sp
Kapacitor execution module.
.INDENT 0.0
.TP
.B configuration
This module accepts connection configuration details either as
parameters or as configuration settings in /etc/salt/minion on the relevant
minions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
kapacitor.host: \(aqlocalhost\(aq
kapacitor.port: 9092
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.sp
Also protocol and SSL settings could be configured:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
kapacitor.unsafe_ssl: \(aqfalse\(aq
kapacitor.protocol: \(aqhttp\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
This data can also be passed into pillar. Options passed into opts will
overwrite options passed into pillar.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kapacitor.define_task(name, tick_script, task_type=\(aqstream\(aq, database=None, retention_policy=\(aqdefault\(aq, dbrps=None)
Define a task. Serves as both create/update.
.INDENT 7.0
.TP
.B name
Name of the task.
.TP
.B tick_script
Path to the TICK script for the task. Can be a salt:// source.
.TP
.B task_type
Task type. Defaults to \(aqstream\(aq
.TP
.B dbrps
A list of databases and retention policies in \(dqdbname\(dq.\(dqrpname\(dq format
to fetch data from. For backward compatibility, the value of
\(aqdatabase\(aq and \(aqretention_policy\(aq will be merged as part of dbrps.
.sp
New in version 2019.2.0.

.TP
.B database
Which database to fetch data from.
.TP
.B retention_policy
Which retention policy to fetch data from. Defaults to \(aqdefault\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kapacitor.define_task cpu salt://kapacitor/cpu.tick database=telegraf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kapacitor.delete_task(name)
Delete a kapacitor task.
.INDENT 7.0
.TP
.B name
Name of the task to delete.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kapacitor.delete_task cpu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kapacitor.disable_task(name)
Disable a kapacitor task.
.INDENT 7.0
.TP
.B name
Name of the task to disable.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kapacitor.disable_task cpu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kapacitor.enable_task(name)
Enable a kapacitor task.
.INDENT 7.0
.TP
.B name
Name of the task to enable.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kapacitor.enable_task cpu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kapacitor.get_task(name)
Get a dict of data on a task.
.INDENT 7.0
.TP
.B name
Name of the task to get information about.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kapacitor.get_task cpu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kapacitor.version()
Get the kapacitor version.
.UNINDENT
.SS salt.modules.kerberos
.sp
Manage Kerberos KDC
.INDENT 0.0
.TP
.B configuration
In order to manage your KDC you will need to generate a keytab
that can authenticate without requiring a password.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# ktadd \-k /root/secure.keytab kadmin/admin kadmin/changepw
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
On the KDC minion you will need to add the following to the minion
configuration file so Salt knows what keytab to use and what principal to
authenticate as.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
auth_keytab: /root/auth.keytab
auth_principal: kadmin/admin
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kerberos.create_keytab(name, keytab, enctypes=None)
Create keytab
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqkdc.example.com\(aq kerberos.create_keytab host/host1.example.com host1.example.com.keytab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kerberos.create_principal(name, enctypes=None)
Create Principal
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqkdc.example.com\(aq kerberos.create_principal host/example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kerberos.delete_principal(name)
Delete Principal
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqkdc.example.com\(aq kerberos.delete_principal host/example.com@EXAMPLE.COM
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kerberos.get_policy(name)
Get policy details
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqkdc.example.com\(aq kerberos.get_policy my_policy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kerberos.get_principal(name)
Get princial details
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqkdc.example.com\(aq kerberos.get_principal root/admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kerberos.get_privs()
Current privileges
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqkdc.example.com\(aq kerberos.get_privs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kerberos.list_policies()
List policies
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqkdc.example.com\(aq kerberos.list_policies
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kerberos.list_principals()
Get all principals
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqkde.example.com\(aq kerberos.list_principals
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.kernelpkg_linux_apt
.sp
Manage Linux kernel packages on APT\-based systems
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_apt.active()
Return the version of the running kernel.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.active
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_apt.cleanup(keep_latest=True)
Remove all unused kernel packages from the system.
.INDENT 7.0
.TP
.B keep_latest
True
In the event that the active kernel is not the latest one installed, setting this to True
will retain the latest kernel package, in addition to the active one. If False, all kernel
packages other than the active one will be removed.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.cleanup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_apt.latest_available()
Return the version of the latest kernel from the package repositories.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.latest_available
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_apt.latest_installed()
Return the version of the latest installed kernel.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.latest_installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function may not return the same value as
\fI\%active()\fP if a new kernel
has been installed and the system has not yet been rebooted.
The \fI\%needs_reboot()\fP function
exists to detect this condition.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_apt.list_installed()
Return a list of all installed kernels.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.list_installed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_apt.needs_reboot()
Detect if a new kernel version has been installed but is not running.
Returns True if a new kernel is installed, False otherwise.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.needs_reboot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_apt.remove(release)
Remove a specific version of the kernel.
.INDENT 7.0
.TP
.B release
The release number of an installed kernel. This must be the entire release
number as returned by \fI\%list_installed()\fP,
not the package name.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.remove 4.4.0\-70\-generic
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_apt.upgrade(reboot=False, at_time=None)
Upgrade the kernel and optionally reboot the system.
.INDENT 7.0
.TP
.B reboot
False
Request a reboot if a new kernel is available.
.TP
.B at_time
immediate
Schedule the reboot at some point in the future. This argument
is ignored if \fBreboot=False\fP\&. See
\fI\%reboot()\fP for more details
on this argument.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.upgrade
salt \(aq*\(aq kernelpkg.upgrade reboot=True at_time=1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
An immediate reboot often shuts down the system before the minion has a
chance to return, resulting in errors. A minimal delay (1 minute) is
useful to ensure the result is delivered to the master.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_apt.upgrade_available()
Detect if a new kernel version is available in the repositories.
Returns True if a new kernel is available, False otherwise.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.upgrade_available
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.kernelpkg_linux_yum
.sp
Manage Linux kernel packages on YUM\-based systems
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_yum.active()
Return the version of the running kernel.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.active
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_yum.cleanup(keep_latest=True)
Remove all unused kernel packages from the system.
.INDENT 7.0
.TP
.B keep_latest
True
In the event that the active kernel is not the latest one installed, setting this to True
will retain the latest kernel package, in addition to the active one. If False, all kernel
packages other than the active one will be removed.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.cleanup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_yum.latest_available()
Return the version of the latest kernel from the package repositories.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.latest_available
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_yum.latest_installed()
Return the version of the latest installed kernel.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.latest_installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function may not return the same value as
\fI\%active()\fP if a new kernel
has been installed and the system has not yet been rebooted.
The \fI\%needs_reboot()\fP function
exists to detect this condition.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_yum.list_installed()
Return a list of all installed kernels.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.list_installed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_yum.needs_reboot()
Detect if a new kernel version has been installed but is not running.
Returns True if a new kernel is installed, False otherwise.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.needs_reboot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_yum.remove(release)
Remove a specific version of the kernel.
.INDENT 7.0
.TP
.B release
The release number of an installed kernel. This must be the entire release
number as returned by \fI\%list_installed()\fP,
not the package name.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.remove 3.10.0\-327.el7
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_yum.upgrade(reboot=False, at_time=None)
Upgrade the kernel and optionally reboot the system.
.INDENT 7.0
.TP
.B reboot
False
Request a reboot if a new kernel is available.
.TP
.B at_time
immediate
Schedule the reboot at some point in the future. This argument
is ignored if \fBreboot=False\fP\&. See
\fI\%reboot()\fP for more details
on this argument.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.upgrade
salt \(aq*\(aq kernelpkg.upgrade reboot=True at_time=1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
An immediate reboot often shuts down the system before the minion has a
chance to return, resulting in errors. A minimal delay (1 minute) is
useful to ensure the result is delivered to the master.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kernelpkg_linux_yum.upgrade_available()
Detect if a new kernel version is available in the repositories.
Returns True if a new kernel is available, False otherwise.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kernelpkg.upgrade_available
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.key
.sp
Functions to view the minion\(aqs public key information
.INDENT 0.0
.TP
.B salt.modules.key.finger(hash_type=None)
Return the minion\(aqs public key fingerprint
.INDENT 7.0
.TP
.B hash_type
The hash algorithm used to calculate the fingerprint
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq key.finger
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.key.finger_master(hash_type=None)
Return the fingerprint of the master\(aqs public key on the minion.
.INDENT 7.0
.TP
.B hash_type
The hash algorithm used to calculate the fingerprint
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq key.finger_master
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.keyboard
.sp
Module for managing keyboards on supported POSIX\-like systems using
systemd, or such as Redhat, Debian and Gentoo.
.INDENT 0.0
.TP
.B salt.modules.keyboard.get_sys()
Get current system keyboard setting
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keyboard.get_sys
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keyboard.get_x()
Get current X keyboard setting
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keyboard.get_x
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keyboard.set_sys(layout)
Set current system keyboard setting
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keyboard.set_sys dvorak
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keyboard.set_x(layout)
Set current X keyboard setting
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keyboard.set_x dvorak
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.keystone
.sp
Module for handling openstack keystone calls.
.INDENT 0.0
.TP
.B optdepends
.INDENT 7.0
.IP \(bu 2
keystoneclient Python adapter
.UNINDENT
.TP
.B configuration
This module is not usable until the following are specified
either in a pillar or in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
keystone.user: admin
keystone.password: verybadpass
keystone.tenant: admin
keystone.tenant_id: f80919baedab48ec8931f200c65a50df
keystone.auth_url: \(aqhttp://127.0.0.1:5000/v2.0/\(aq
keystone.verify_ssl: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
OR (for token based authentication)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
keystone.token: \(aqADMIN\(aq
keystone.endpoint: \(aqhttp://127.0.0.1:35357/v2.0\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If configuration for multiple openstack accounts is required, they can be
set up as different configuration profiles. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
openstack1:
  keystone.user: admin
  keystone.password: verybadpass
  keystone.tenant: admin
  keystone.tenant_id: f80919baedab48ec8931f200c65a50df
  keystone.auth_url: \(aqhttp://127.0.0.1:5000/v2.0/\(aq
  keystone.verify_ssl: True

openstack2:
  keystone.user: admin
  keystone.password: verybadpass
  keystone.tenant: admin
  keystone.tenant_id: f80919baedab48ec8931f200c65a50df
  keystone.auth_url: \(aqhttp://127.0.0.2:5000/v2.0/\(aq
  keystone.verify_ssl: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With this configuration in place, any of the keystone functions can make use
of a configuration profile by declaring it explicitly.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.tenant_list profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.api_version(profile=None, **connection_args)
Returns the API version derived from endpoint\(aqs response.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.api_version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.auth(profile=None, **connection_args)
Set up keystone credentials. Only intended to be used within Keystone\-enabled modules.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.auth
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.ec2_credentials_create(user_id=None, name=None, tenant_id=None, tenant=None, profile=None, **connection_args)
Create EC2\-compatible credentials for user per tenant
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.ec2_credentials_create name=admin tenant=admin

salt \(aq*\(aq keystone.ec2_credentials_create         user_id=c965f79c4f864eaaa9c3b41904e67082         tenant_id=722787eb540849158668370dc627ec5f
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.ec2_credentials_delete(user_id=None, name=None, access_key=None, profile=None, **connection_args)
Delete EC2\-compatible credentials
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.ec2_credentials_delete         860f8c2c38ca4fab989f9bc56a061a64 access_key=5f66d2f24f604b8bb9cd28886106f442

salt \(aq*\(aq keystone.ec2_credentials_delete name=admin         access_key=5f66d2f24f604b8bb9cd28886106f442
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.ec2_credentials_get(user_id=None, name=None, access=None, profile=None, **connection_args)
Return ec2_credentials for a user (keystone ec2\-credentials\-get)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.ec2_credentials_get c965f79c4f864eaaa9c3b41904e67082 access=722787eb540849158668370
salt \(aq*\(aq keystone.ec2_credentials_get user_id=c965f79c4f864eaaa9c3b41904e67082 access=722787eb540849158668370
salt \(aq*\(aq keystone.ec2_credentials_get name=nova access=722787eb540849158668370dc627ec5f
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.ec2_credentials_list(user_id=None, name=None, profile=None, **connection_args)
Return a list of ec2_credentials for a specific user (keystone ec2\-credentials\-list)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.ec2_credentials_list 298ce377245c4ec9b70e1c639c89e654
salt \(aq*\(aq keystone.ec2_credentials_list user_id=298ce377245c4ec9b70e1c639c89e654
salt \(aq*\(aq keystone.ec2_credentials_list name=jack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.endpoint_create(service, publicurl=None, internalurl=None, adminurl=None, region=None, profile=None, url=None, interface=None, **connection_args)
Create an endpoint for an Openstack service
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqv2\(aq keystone.endpoint_create nova \(aqhttp://public/url\(aq \(aqhttp://internal/url\(aq \(aqhttp://adminurl/url\(aq region

salt \(aqv3\(aq keystone.endpoint_create nova url=\(aqhttp://public/url\(aq interface=\(aqpublic\(aq region=\(aqRegionOne\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.endpoint_delete(service, region=None, profile=None, interface=None, **connection_args)
Delete endpoints of an Openstack service
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqv2\(aq keystone.endpoint_delete nova [region=RegionOne]

salt \(aqv3\(aq keystone.endpoint_delete nova interface=admin [region=RegionOne]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.endpoint_get(service, region=None, profile=None, interface=None, **connection_args)
Return a specific endpoint (keystone endpoint\-get)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqv2\(aq keystone.endpoint_get nova [region=RegionOne]

salt \(aqv3\(aq keystone.endpoint_get nova interface=admin [region=RegionOne]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.endpoint_list(profile=None, **connection_args)
Return a list of available endpoints (keystone endpoints\-list)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.endpoint_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.project_create(name, domain, description=None, enabled=True, profile=None, **connection_args)
Create a keystone project.
Overrides keystone tenant_create form api V2. For keystone api V3.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B name
The project name, which must be unique within the owning domain.
.TP
.B domain
The domain name.
.TP
.B description
The project description.
.TP
.B enabled
Enables or disables the project.
.TP
.B profile
Configuration profile \- if configuration for multiple openstack accounts required.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.project_create nova default description=\(aqNova Compute Project\(aq
salt \(aq*\(aq keystone.project_create test default enabled=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.project_delete(project_id=None, name=None, profile=None, **connection_args)
Delete a project (keystone project\-delete).
Overrides keystone tenant\-delete form api V2. For keystone api V3 only.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B project_id
The project id.
.TP
.B name
The project name.
.TP
.B profile
Configuration profile \- if configuration for multiple openstack accounts required.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.project_delete c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.project_delete project_id=c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.project_delete name=demo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.project_get(project_id=None, name=None, profile=None, **connection_args)
Return a specific projects (keystone project\-get)
Overrides keystone tenant\-get form api V2.
For keystone api V3 only.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B project_id
The project id.
.TP
.B name
The project name.
.TP
.B profile
Configuration profile \- if configuration for multiple openstack accounts required.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.project_get c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.project_get project_id=c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.project_get name=nova
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.project_list(profile=None, **connection_args)
Return a list of available projects (keystone projects\-list).
Overrides keystone tenants\-list form api V2.
For keystone api V3 only.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B profile
Configuration profile \- if configuration for multiple openstack accounts required.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.project_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.project_update(project_id=None, name=None, description=None, enabled=None, profile=None, **connection_args)
Update a tenant\(aqs information (keystone project\-update)
The following fields may be updated: name, description, enabled.
Can only update name if targeting by ID
.sp
Overrides keystone tenant_update form api V2.
For keystone api V3 only.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B project_id
The project id.
.TP
.B name
The project name, which must be unique within the owning domain.
.TP
.B description
The project description.
.TP
.B enabled
Enables or disables the project.
.TP
.B profile
Configuration profile \- if configuration for multiple openstack accounts required.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.project_update name=admin enabled=True
salt \(aq*\(aq keystone.project_update c965f79c4f864eaaa9c3b41904e67082 name=admin email=admin@domain.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.role_create(name, profile=None, **connection_args)
Create a named role.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.role_create admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.role_delete(role_id=None, name=None, profile=None, **connection_args)
Delete a role (keystone role\-delete)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.role_delete c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.role_delete role_id=c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.role_delete name=admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.role_get(role_id=None, name=None, profile=None, **connection_args)
Return a specific roles (keystone role\-get)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.role_get c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.role_get role_id=c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.role_get name=nova
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.role_list(profile=None, **connection_args)
Return a list of available roles (keystone role\-list)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.role_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.service_create(name, service_type, description=None, profile=None, **connection_args)
Add service to Keystone service catalog
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.service_create nova compute \(aqOpenStack Compute Service\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.service_delete(service_id=None, name=None, profile=None, **connection_args)
Delete a service from Keystone service catalog
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.service_delete c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.service_delete name=nova
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.service_get(service_id=None, name=None, profile=None, **connection_args)
Return a specific services (keystone service\-get)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.service_get c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.service_get service_id=c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.service_get name=nova
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.service_list(profile=None, **connection_args)
Return a list of available services (keystone services\-list)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.service_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.tenant_create(name, description=None, enabled=True, profile=None, **connection_args)
Create a keystone tenant
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.tenant_create nova description=\(aqnova tenant\(aq
salt \(aq*\(aq keystone.tenant_create test enabled=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.tenant_delete(tenant_id=None, name=None, profile=None, **connection_args)
Delete a tenant (keystone tenant\-delete)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.tenant_delete c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.tenant_delete tenant_id=c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.tenant_delete name=demo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.tenant_get(tenant_id=None, name=None, profile=None, **connection_args)
Return a specific tenants (keystone tenant\-get)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.tenant_get c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.tenant_get tenant_id=c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.tenant_get name=nova
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.tenant_list(profile=None, **connection_args)
Return a list of available tenants (keystone tenants\-list)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.tenant_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.tenant_update(tenant_id=None, name=None, description=None, enabled=None, profile=None, **connection_args)
Update a tenant\(aqs information (keystone tenant\-update)
The following fields may be updated: name, description, enabled.
Can only update name if targeting by ID
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.tenant_update name=admin enabled=True
salt \(aq*\(aq keystone.tenant_update c965f79c4f864eaaa9c3b41904e67082 name=admin email=admin@domain.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.token_get(profile=None, **connection_args)
Return the configured tokens (keystone token\-get)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.token_get c965f79c4f864eaaa9c3b41904e67082
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.user_create(name, password, email, tenant_id=None, enabled=True, profile=None, project_id=None, description=None, **connection_args)
Create a user (keystone user\-create)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.user_create name=jack password=zero email=jack@halloweentown.org         tenant_id=a28a7b5a999a455f84b1f5210264375e enabled=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.user_delete(user_id=None, name=None, profile=None, **connection_args)
Delete a user (keystone user\-delete)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.user_delete c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.user_delete user_id=c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.user_delete name=nova
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.user_get(user_id=None, name=None, profile=None, **connection_args)
Return a specific users (keystone user\-get)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.user_get c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.user_get user_id=c965f79c4f864eaaa9c3b41904e67082
salt \(aq*\(aq keystone.user_get name=nova
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.user_list(profile=None, **connection_args)
Return a list of available users (keystone user\-list)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.user_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.user_password_update(user_id=None, name=None, password=None, profile=None, **connection_args)
Update a user\(aqs password (keystone user\-password\-update)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.user_password_update c965f79c4f864eaaa9c3b41904e67082 password=12345
salt \(aq*\(aq keystone.user_password_update user_id=c965f79c4f864eaaa9c3b41904e67082 password=12345
salt \(aq*\(aq keystone.user_password_update name=nova password=12345
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.user_role_add(user_id=None, user=None, tenant_id=None, tenant=None, role_id=None, role=None, profile=None, project_id=None, project_name=None, **connection_args)
Add role for user in tenant (keystone user\-role\-add)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.user_role_add user_id=298ce377245c4ec9b70e1c639c89e654 tenant_id=7167a092ece84bae8cead4bf9d15bb3b role_id=ce377245c4ec9b70e1c639c89e8cead4
salt \(aq*\(aq keystone.user_role_add user=admin tenant=admin role=admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.user_role_list(user_id=None, tenant_id=None, user_name=None, tenant_name=None, profile=None, project_id=None, project_name=None, **connection_args)
Return a list of available user_roles (keystone user\-roles\-list)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.user_role_list user_id=298ce377245c4ec9b70e1c639c89e654 tenant_id=7167a092ece84bae8cead4bf9d15bb3b
salt \(aq*\(aq keystone.user_role_list user_name=admin tenant_name=admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.user_role_remove(user_id=None, user=None, tenant_id=None, tenant=None, role_id=None, role=None, profile=None, project_id=None, project_name=None, **connection_args)
Remove role for user in tenant (keystone user\-role\-remove)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.user_role_remove user_id=298ce377245c4ec9b70e1c639c89e654 tenant_id=7167a092ece84bae8cead4bf9d15bb3b role_id=ce377245c4ec9b70e1c639c89e8cead4
salt \(aq*\(aq keystone.user_role_remove user=admin tenant=admin role=admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.user_update(user_id=None, name=None, email=None, enabled=None, tenant=None, profile=None, project=None, description=None, **connection_args)
Update a user\(aqs information (keystone user\-update)
The following fields may be updated: name, email, enabled, tenant.
Because the name is one of the fields, a valid user id is required.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.user_update user_id=c965f79c4f864eaaa9c3b41904e67082 name=newname
salt \(aq*\(aq keystone.user_update c965f79c4f864eaaa9c3b41904e67082 name=newname email=newemail@domain.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystone.user_verify_password(user_id=None, name=None, password=None, profile=None, **connection_args)
Verify a user\(aqs password
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystone.user_verify_password name=test password=foobar
salt \(aq*\(aq keystone.user_verify_password user_id=c965f79c4f864eaaa9c3b41904e67082 password=foobar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.keystoneng
.sp
Keystone module for interacting with OpenStack Keystone
.sp
New in version 2018.3.0.

.sp
:depends:shade
.sp
Example configuration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
keystone:
  cloud: default
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
keystone:
  auth:
    username: admin
    password: password123
    user_domain_name: mydomain
    project_name: myproject
    project_domain_name: myproject
    auth_url: https://example.org:5000/v3
  identity_api_version: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.compare_changes(obj, **kwargs)
Compare two dicts returning only keys that exist in the first dict and are
different in the second one
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.domain_create(auth=None, **kwargs)
Create a domain
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.domain_create name=domain1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.domain_delete(auth=None, **kwargs)
Delete a domain
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.domain_delete name=domain1
salt \(aq*\(aq keystoneng.domain_delete name=b62e76fbeeff4e8fb77073f591cf211e
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.domain_get(auth=None, **kwargs)
Get a single domain
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.domain_get name=domain1
salt \(aq*\(aq keystoneng.domain_get name=b62e76fbeeff4e8fb77073f591cf211e
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.domain_list(auth=None, **kwargs)
List domains
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.domain_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.domain_search(auth=None, **kwargs)
Search domains
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.domain_search
salt \(aq*\(aq keystoneng.domain_search name=domain1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.domain_update(auth=None, **kwargs)
Update a domain
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.domain_update name=domain1 new_name=newdomain
salt \(aq*\(aq keystoneng.domain_update name=domain1 enabled=True description=\(aqnew description\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.endpoint_create(auth=None, **kwargs)
Create an endpoint
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.endpoint_create interface=admin service=glance url=https://example.org:9292
salt \(aq*\(aq keystoneng.endpoint_create interface=public service=glance region=RegionOne url=https://example.org:9292
salt \(aq*\(aq keystoneng.endpoint_create interface=admin service=glance url=https://example.org:9292 enabled=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.endpoint_delete(auth=None, **kwargs)
Delete an endpoint
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.endpoint_delete id=3bee4bd8c2b040ee966adfda1f0bfca9
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.endpoint_get(auth=None, **kwargs)
Get a single endpoint
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.endpoint_get id=02cffaa173b2460f98e40eda3748dae5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.endpoint_list(auth=None, **kwargs)
List endpoints
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.endpoint_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.endpoint_search(auth=None, **kwargs)
Search endpoints
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.endpoint_search
salt \(aq*\(aq keystoneng.endpoint_search id=02cffaa173b2460f98e40eda3748dae5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.endpoint_update(auth=None, **kwargs)
Update an endpoint
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.endpoint_update endpoint_id=4f961ad09d2d48948896bbe7c6a79717 interface=public enabled=False
salt \(aq*\(aq keystoneng.endpoint_update endpoint_id=4f961ad09d2d48948896bbe7c6a79717 region=newregion
salt \(aq*\(aq keystoneng.endpoint_update endpoint_id=4f961ad09d2d48948896bbe7c6a79717 service_name_or_id=glance url=https://example.org:9292
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.get_entity(ent_type, **kwargs)
Attempt to query Keystone for more information about an entity
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.get_openstack_cloud(auth=None)
Return an openstack_cloud
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.get_operator_cloud(auth=None)
Return an operator_cloud
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.group_create(auth=None, **kwargs)
Create a group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.group_create name=group1
salt \(aq*\(aq keystoneng.group_create name=group2 domain=domain1 description=\(aqmy group2\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.group_delete(auth=None, **kwargs)
Delete a group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.group_delete name=group1
salt \(aq*\(aq keystoneng.group_delete name=group2 domain_id=b62e76fbeeff4e8fb77073f591cf211e
salt \(aq*\(aq keystoneng.group_delete name=0e4febc2a5ab4f2c8f374b054162506d
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.group_get(auth=None, **kwargs)
Get a single group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.group_get name=group1
salt \(aq*\(aq keystoneng.group_get name=group2 domain_id=b62e76fbeeff4e8fb77073f591cf211e
salt \(aq*\(aq keystoneng.group_get name=0e4febc2a5ab4f2c8f374b054162506d
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.group_list(auth=None, **kwargs)
List groups
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.group_list
salt \(aq*\(aq keystoneng.group_list domain_id=b62e76fbeeff4e8fb77073f591cf211e
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.group_search(auth=None, **kwargs)
Search for groups
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.group_search name=group1
salt \(aq*\(aq keystoneng.group_search domain_id=b62e76fbeeff4e8fb77073f591cf211e
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.group_update(auth=None, **kwargs)
Update a group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.group_update name=group1 description=\(aqnew description\(aq
salt \(aq*\(aq keystoneng.group_create name=group2 domain_id=b62e76fbeeff4e8fb77073f591cf211e new_name=newgroupname
salt \(aq*\(aq keystoneng.group_create name=0e4febc2a5ab4f2c8f374b054162506d new_name=newgroupname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.project_create(auth=None, **kwargs)
Create a project
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.project_create name=project1
salt \(aq*\(aq keystoneng.project_create name=project2 domain_id=b62e76fbeeff4e8fb77073f591cf211e
salt \(aq*\(aq keystoneng.project_create name=project3 enabled=False description=\(aqmy project3\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.project_delete(auth=None, **kwargs)
Delete a project
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.project_delete name=project1
salt \(aq*\(aq keystoneng.project_delete name=project2 domain_id=b62e76fbeeff4e8fb77073f591cf211e
salt \(aq*\(aq keystoneng.project_delete name=f315afcf12f24ad88c92b936c38f2d5a
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.project_get(auth=None, **kwargs)
Get a single project
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.project_get name=project1
salt \(aq*\(aq keystoneng.project_get name=project2 domain_id=b62e76fbeeff4e8fb77073f591cf211e
salt \(aq*\(aq keystoneng.project_get name=f315afcf12f24ad88c92b936c38f2d5a
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.project_list(auth=None, **kwargs)
List projects
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.project_list
salt \(aq*\(aq keystoneng.project_list domain_id=b62e76fbeeff4e8fb77073f591cf211e
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.project_search(auth=None, **kwargs)
Search projects
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.project_search
salt \(aq*\(aq keystoneng.project_search name=project1
salt \(aq*\(aq keystoneng.project_search domain_id=b62e76fbeeff4e8fb77073f591cf211e
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.project_update(auth=None, **kwargs)
Update a project
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.project_update name=project1 new_name=newproject
salt \(aq*\(aq keystoneng.project_update name=project2 enabled=False description=\(aqnew description\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.role_assignment_list(auth=None, **kwargs)
List role assignments
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.role_assignment_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.role_create(auth=None, **kwargs)
Create a role
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.role_create name=role1
salt \(aq*\(aq keystoneng.role_create name=role1 domain_id=b62e76fbeeff4e8fb77073f591cf211e
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.role_delete(auth=None, **kwargs)
Delete a role
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.role_delete name=role1 domain_id=b62e76fbeeff4e8fb77073f591cf211e
salt \(aq*\(aq keystoneng.role_delete name=1eb6edd5525e4ac39af571adee673559
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.role_get(auth=None, **kwargs)
Get a single role
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.role_get name=role1
salt \(aq*\(aq keystoneng.role_get name=role1 domain_id=b62e76fbeeff4e8fb77073f591cf211e
salt \(aq*\(aq keystoneng.role_get name=1eb6edd5525e4ac39af571adee673559
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.role_grant(auth=None, **kwargs)
Grant a role in a project/domain to a user/group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.role_grant name=role1 user=user1 project=project1
salt \(aq*\(aq keystoneng.role_grant name=ddbe3e0ed74e4c7f8027bad4af03339d group=user1 project=project1 domain=domain1
salt \(aq*\(aq keystoneng.role_grant name=ddbe3e0ed74e4c7f8027bad4af03339d group=19573afd5e4241d8b65c42215bae9704 project=1dcac318a83b4610b7a7f7ba01465548
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.role_list(auth=None, **kwargs)
List roles
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.role_list
salt \(aq*\(aq keystoneng.role_list domain_id=b62e76fbeeff4e8fb77073f591cf211e
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.role_revoke(auth=None, **kwargs)
Grant a role in a project/domain to a user/group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.role_revoke name=role1 user=user1 project=project1
salt \(aq*\(aq keystoneng.role_revoke name=ddbe3e0ed74e4c7f8027bad4af03339d group=user1 project=project1 domain=domain1
salt \(aq*\(aq keystoneng.role_revoke name=ddbe3e0ed74e4c7f8027bad4af03339d group=19573afd5e4241d8b65c42215bae9704 project=1dcac318a83b4610b7a7f7ba01465548
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.role_search(auth=None, **kwargs)
Search roles
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.role_search
salt \(aq*\(aq keystoneng.role_search name=role1
salt \(aq*\(aq keystoneng.role_search domain_id=b62e76fbeeff4e8fb77073f591cf211e
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.role_update(auth=None, **kwargs)
Update a role
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.role_update name=role1 new_name=newrole
salt \(aq*\(aq keystoneng.role_update name=1eb6edd5525e4ac39af571adee673559 new_name=newrole
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.service_create(auth=None, **kwargs)
Create a service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.service_create name=glance type=image
salt \(aq*\(aq keystoneng.service_create name=glance type=image description=\(dqImage\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.service_delete(auth=None, **kwargs)
Delete a service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.service_delete name=glance
salt \(aq*\(aq keystoneng.service_delete name=39cc1327cdf744ab815331554430e8ec
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.service_get(auth=None, **kwargs)
Get a single service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.service_get name=glance
salt \(aq*\(aq keystoneng.service_get name=75a5804638944b3ab54f7fbfcec2305a
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.service_list(auth=None, **kwargs)
List services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.service_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.service_search(auth=None, **kwargs)
Search services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.service_search
salt \(aq*\(aq keystoneng.service_search name=glance
salt \(aq*\(aq keystoneng.service_search name=135f0403f8e544dc9008c6739ecda860
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.service_update(auth=None, **kwargs)
Update a service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.service_update name=cinder type=volumev2
salt \(aq*\(aq keystoneng.service_update name=cinder description=\(aqnew description\(aq
salt \(aq*\(aq keystoneng.service_update name=ab4d35e269f147b3ae2d849f77f5c88f enabled=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.setup_clouds(auth=None)
Call functions to create Shade cloud objects in __context__ to take
advantage of Shade\(aqs in\-memory caching across several states
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.user_create(auth=None, **kwargs)
Create a user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.user_create name=user1
salt \(aq*\(aq keystoneng.user_create name=user2 password=1234 enabled=False
salt \(aq*\(aq keystoneng.user_create name=user3 domain_id=b62e76fbeeff4e8fb77073f591cf211e
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.user_delete(auth=None, **kwargs)
Delete a user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.user_delete name=user1
salt \(aq*\(aq keystoneng.user_delete name=user2 domain_id=b62e76fbeeff4e8fb77073f591cf211e
salt \(aq*\(aq keystoneng.user_delete name=a42cbbfa1e894e839fd0f584d22e321f
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.user_get(auth=None, **kwargs)
Get a single user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.user_get name=user1
salt \(aq*\(aq keystoneng.user_get name=user1 domain_id=b62e76fbeeff4e8fb77073f591cf211e
salt \(aq*\(aq keystoneng.user_get name=02cffaa173b2460f98e40eda3748dae5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.user_list(auth=None, **kwargs)
List users
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.user_list
salt \(aq*\(aq keystoneng.user_list domain_id=b62e76fbeeff4e8fb77073f591cf211e
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.user_search(auth=None, **kwargs)
List users
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.user_list
salt \(aq*\(aq keystoneng.user_list domain_id=b62e76fbeeff4e8fb77073f591cf211e
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystoneng.user_update(auth=None, **kwargs)
Update a user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystoneng.user_update name=user1 enabled=False description=\(aqnew description\(aq
salt \(aq*\(aq keystoneng.user_update name=user1 new_name=newuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.keystore
.sp
Module to interact with keystores
.INDENT 0.0
.TP
.B salt.modules.keystore.add(name, keystore, passphrase, certificate, private_key=None)
Adds certificates to an existing keystore or creates a new one if necesssary.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- alias for the certificate
.IP \(bu 2
\fBkeystore\fP \-\- The path to the keystore file to query
.IP \(bu 2
\fBpassphrase\fP \-\- The passphrase to use to decode the keystore
.IP \(bu 2
\fBcertificate\fP \-\- The PEM public certificate to add to keystore. Can be a string for file.
.IP \(bu 2
\fBprivate_key\fP \-\- (Optional for TrustedCert) The PEM private key to add to the keystore
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystore.add aliasname /tmp/test.store changeit /tmp/testcert.crt
salt \(aq*\(aq keystore.add aliasname /tmp/test.store changeit certificate=\(dq\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-SIb...BM=\-\-\-\-\-END CERTIFICATE\-\-\-\-\-\(dq
salt \(aq*\(aq keystore.add keyname /tmp/test.store changeit /tmp/512.cert private_key=/tmp/512.key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystore.get_sha1(certificate)
Returns the SHA1 sum of a ASN1/PEM certificate
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- ASN1/PEM certificate
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystore.get_sha1 \(dq(certificate_content_string)\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystore.list(keystore, passphrase, alias=None, return_cert=False)
Lists certificates in a keytool managed keystore.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkeystore\fP \-\- The path to the keystore file to query
.IP \(bu 2
\fBpassphrase\fP \-\- The passphrase to use to decode the keystore
.IP \(bu 2
\fBalias\fP \-\- (Optional) If found, displays details on only this key
.IP \(bu 2
\fBreturn_certs\fP \-\- (Optional) Also return certificate PEM.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
There are security implications for using return_cert to return decrypted certificates.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystore.list /usr/lib/jvm/java\-8/jre/lib/security/cacerts changeit
salt \(aq*\(aq keystore.list /usr/lib/jvm/java\-8/jre/lib/security/cacerts changeit debian:verisign_\-_g5.pem
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.keystore.remove(name, keystore, passphrase)
Removes a certificate from an existing keystore.
Returns True if remove was successful, otherwise False
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- alias for the certificate
.IP \(bu 2
\fBkeystore\fP \-\- The path to the keystore file to query
.IP \(bu 2
\fBpassphrase\fP \-\- The passphrase to use to decode the keystore
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keystore.remove aliasname /tmp/test.store changeit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.kmod
.sp
Module to manage Linux kernel modules
.INDENT 0.0
.TP
.B salt.modules.kmod.available()
Return a list of all available kernel modules
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kmod.available
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kmod.check_available(mod)
Check to see if the specified kernel module is available
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kmod.check_available kvm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kmod.is_loaded(mod)
Check to see if the specified kernel module is loaded
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kmod.is_loaded kvm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kmod.load(mod, persist=False)
Load the specified kernel module
.INDENT 7.0
.TP
.B mod
Name of module to add
.TP
.B persist
Write module to /etc/modules to make it load on system reboot
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kmod.load kvm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kmod.lsmod()
Return a dict containing information about currently loaded modules
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kmod.lsmod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kmod.mod_list(only_persist=False)
Return a list of the loaded module names
.INDENT 7.0
.TP
.B only_persist
Only return the list of loaded persistent modules
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kmod.mod_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kmod.remove(mod, persist=False, comment=True)
Remove the specified kernel module
.INDENT 7.0
.TP
.B mod
Name of module to remove
.TP
.B persist
Also remove module from /etc/modules
.TP
.B comment
If persist is set don\(aqt remove line from /etc/modules but only
comment it
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kmod.remove kvm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.kubeadm
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%kubernetes Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Module for kubeadm
:maintainer:    Alberto Planas <\fI\%aplanas@suse.com\fP>
:maturity:      new
:depends:       None
:platform:      Linux
.INDENT 0.0
.TP
.B salt.modules.kubeadm.alpha_certs_renew(rootfs=None)
New in version 3001.

.sp
Renews certificates for a Kubernetes cluster
.INDENT 7.0
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.alpha_certs_renew
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.alpha_kubeconfig_user(client_name, apiserver_advertise_address=None, apiserver_bind_port=None, cert_dir=None, org=None, token=None, rootfs=None)
New in version 3001.

.sp
Outputs a kubeconfig file for an additional user
.INDENT 7.0
.TP
.B client_name
The name of the user. It will be used as the CN if client
certificates are created
.TP
.B apiserver_advertise_address
The IP address the API server is accessible on
.TP
.B apiserver_bind_port
The port the API server is accessible on (default 6443)
.TP
.B cert_dir
The path where certificates are stored (default
\(dq/etc/kubernetes/pki\(dq)
.TP
.B org
The organization of the client certificate
.TP
.B token
The token that show be used as the authentication mechanism for
this kubeconfig, instead of client certificates
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.alpha_kubeconfig_user client_name=user
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.alpha_kubelet_config_download(kubeconfig=None, kubelet_version=None, rootfs=None)
New in version 3001.

.sp
Downloads the kubelet configuration from the cluster ConfigMap
kubelet\-config\-1.X
.INDENT 7.0
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B kubelet_version
The desired version for the kubelet
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.alpha_kubelet_config_download
salt \(aq*\(aq kubeadm.alpha_kubelet_config_download kubelet_version=\(aq1.14.0\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.alpha_kubelet_config_enable_dynamic(node_name, kubeconfig=None, kubelet_version=None, rootfs=None)
New in version 3001.

.sp
Enables or updates dynamic kubelet configuration for a node
.INDENT 7.0
.TP
.B node_name
Name of the node that should enable the dynamic kubelet
configuration
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B kubelet_version
The desired version for the kubelet
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.alpha_kubelet_config_enable_dynamic node\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.alpha_selfhosting_pivot(cert_dir=None, config=None, kubeconfig=None, store_certs_in_secrets=False, rootfs=None)
New in version 3001.

.sp
Converts a static Pod\-hosted control plane into a selt\-hosted one
.INDENT 7.0
.TP
.B cert_dir
The path where certificates are stored (default
\(dq/etc/kubernetes/pki\(dq)
.TP
.B config
Path to kubeadm configuration file
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B store_certs_in_secrets
Enable storing certs in secrets
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.alpha_selfhost_pivot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.config_images_list(config=None, feature_gates=None, kubernetes_version=None, kubeconfig=None, rootfs=None)
New in version 3001.

.sp
Print a list of images kubeadm will use
.INDENT 7.0
.TP
.B config
Path to kubeadm configuration file
.TP
.B feature_gates
A set of key=value pairs that describe feature gates for
various features
.TP
.B kubernetes_version
Choose a specifig Kubernetes version for the control plane
(default \(dqstable\-1\(dq)
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.config_images_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.config_images_pull(config=None, cri_socket=None, feature_gates=None, kubernetes_version=None, kubeconfig=None, rootfs=None)
New in version 3001.

.sp
Pull images used by kubeadm
.INDENT 7.0
.TP
.B config
Path to kubeadm configuration file
.TP
.B cri_socket
Path to the CRI socket to connect
.TP
.B feature_gates
A set of key=value pairs that describe feature gates for
various features
.TP
.B kubernetes_version
Choose a specifig Kubernetes version for the control plane
(default \(dqstable\-1\(dq)
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.config_images_pull
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.config_migrate(old_config, new_config=None, kubeconfig=None, rootfs=None)
New in version 3001.

.sp
Read an older version of the kubeadm configuration API types from
a file, and output the similar config object for the newer version
.INDENT 7.0
.TP
.B old_config
Path to the kubeadm config file that is usin the old API
version and should be converted
.TP
.B new_config
Path to the resulting equivalent kubeadm config file using the
new API version. If not specified the output will be returned
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.config_migrate /oldconfig.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.config_print_init_defaults(component_configs=None, kubeconfig=None, rootfs=None)
New in version 3001.

.sp
Return default init configuration, that can be used for \(aqkubeadm
init\(aq
.INDENT 7.0
.TP
.B component_config
A comma\-separated list for component config API object to print
the default values for (valid values: KubeProxyConfiguration,
KubeletConfiguration)
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.config_print_init_defaults
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.config_print_join_defaults(component_configs=None, kubeconfig=None, rootfs=None)
New in version 3001.

.sp
Return default join configuration, that can be used for \(aqkubeadm
join\(aq
.INDENT 7.0
.TP
.B component_config
A comma\-separated list for component config API object to print
the default values for (valid values: KubeProxyConfiguration,
KubeletConfiguration)
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.config_print_join_defaults
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.config_upload_from_file(config, kubeconfig=None, rootfs=None)
New in version 3001.

.sp
Upload a configuration file to the in\-cluster ConfigMap for
kubeadm configuration
.INDENT 7.0
.TP
.B config
Path to a kubeadm configuration file
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.config_upload_from_file /config.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.config_upload_from_flags(apiserver_advertise_address=None, apiserver_bind_port=None, apiserver_cert_extra_sans=None, cert_dir=None, cri_socket=None, feature_gates=None, kubernetes_version=None, node_name=None, pod_network_cidr=None, service_cidr=None, service_dns_domain=None, kubeconfig=None, rootfs=None)
New in version 3001.

.sp
Create the in\-cluster configuration file for the first time using
flags
.INDENT 7.0
.TP
.B apiserver_advertise_address
The IP address the API server will advertise it\(aqs listening on
.TP
.B apiserver_bind_port
The port the API server is accessible on (default 6443)
.TP
.B apiserver_cert_extra_sans
Optional extra Subject Alternative Names (SANs) to use for the
API Server serving certificate
.TP
.B cert_dir
The path where to save and store the certificates (default
\(dq/etc/kubernetes/pki\(dq)
.TP
.B cri_socket
Path to the CRI socket to connect
.TP
.B feature_gates
A set of key=value pairs that describe feature gates for
various features
.TP
.B kubernetes_version
Choose a specifig Kubernetes version for the control plane
(default \(dqstable\-1\(dq)
.TP
.B node_name
Specify the node name
.TP
.B pod_network_cidr
Specify range of IP addresses for the pod network
.TP
.B service_cidr
Use alternative range of IP address for service VIPs (default
\(dq10.96.0.0/12\(dq)
.TP
.B service_dns_domain
Use alternative domain for services (default \(dqcluster.local\(dq)
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.config_upload_from_flags
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.config_view(kubeconfig=None, rootfs=None)
New in version 3001.

.sp
View the kubeadm configuration stored inside the cluster
.INDENT 7.0
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.config_view
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.init(apiserver_advertise_address=None, apiserver_bind_port=None, apiserver_cert_extra_sans=None, cert_dir=None, certificate_key=None, control_plane_endpoint=None, config=None, cri_socket=None, experimental_upload_certs=False, upload_certs=False, feature_gates=None, ignore_preflight_errors=None, image_repository=None, kubernetes_version=None, node_name=None, pod_network_cidr=None, service_cidr=None, service_dns_domain=None, skip_certificate_key_print=False, skip_phases=None, skip_token_print=False, token=None, token_ttl=None, rootfs=None)
New in version 3001.

.sp
Command to set up the Kubernetes control plane
.INDENT 7.0
.TP
.B apiserver_advertise_address
The IP address the API server will advertise it\(aqs listening on
.TP
.B apiserver_bind_port
The port the API server is accessible on (default 6443)
.TP
.B apiserver_cert_extra_sans
Optional extra Subject Alternative Names (SANs) to use for the
API Server serving certificate
.TP
.B cert_dir
The path where to save and store the certificates (default
\(dq/etc/kubernetes/pki\(dq)
.TP
.B certificate_key
Key used to encrypt the control\-plane certificates in the
kubeadm\-certs Secret
.TP
.B config
Path to a kubeadm configuration file
.TP
.B control_plane_endpoint
Specify a stable IP address or DNS name for the control plane
.TP
.B cri_socket
Path to the CRI socket to connect
.TP
.B experimental_upload_certs
Upload control\-plane certificate to the kubeadm\-certs Secret. ( kubeadm version =< 1.16 )
.TP
.B upload_certs
Upload control\-plane certificate to the kubeadm\-certs Secret. ( kubeadm version > 1.16 )
.TP
.B feature_gates
A set of key=value pairs that describe feature gates for
various features
.TP
.B ignore_preflight_errors
A list of checks whose errors will be shown as warnings
.TP
.B image_repository
Choose a container registry to pull control plane images from
.TP
.B kubernetes_version
Choose a specifig Kubernetes version for the control plane
(default \(dqstable\-1\(dq)
.TP
.B node_name
Specify the node name
.TP
.B pod_network_cidr
Specify range of IP addresses for the pod network
.TP
.B service_cidr
Use alternative range of IP address for service VIPs (default
\(dq10.96.0.0/12\(dq)
.TP
.B service_dns_domain
Use alternative domain for services (default \(dqcluster.local\(dq)
.TP
.B skip_certificate_key_print
Don\(aqt print the key used to encrypt the control\-plane
certificates
.TP
.B skip_phases
List of phases to be skipped
.TP
.B skip_token_print
Skip printing of the default bootstrap token generated by
\(aqkubeadm init\(aq
.TP
.B token
The token to use for establishing bidirectional trust between
nodes and control\-plane nodes. The token must match a regular
expression, that by default is [a\-z0\-9]{6}.[a\-z0\-9]{16}
.TP
.B token_ttl
The duration defore the token is automatically deleted (1s, 2m,
3h). If set to \(aq0\(aq the token will never expire. Default value
is 24h0m0s
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.init pod_network_cidr=\(aq10.244.0.0/16\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.join(api_server_endpoint=None, apiserver_advertise_address=None, apiserver_bind_port=None, certificate_key=None, config=None, cri_socket=None, discovery_file=None, discovery_token=None, discovery_token_ca_cert_hash=None, discovery_token_unsafe_skip_ca_verification=False, experimental_control_plane=False, control_plane=False, ignore_preflight_errors=None, node_name=None, skip_phases=None, tls_bootstrap_token=None, token=None, rootfs=None)
New in version 3001.

.sp
Command to join to an existing cluster
.INDENT 7.0
.TP
.B api_server_endpoint
IP address or domain name and port of the API Server
.TP
.B apiserver_advertise_address
If the node should host a new control plane instance, the IP
address the API Server will advertise it\(aqs listening on
.TP
.B apiserver_bind_port
If the node should host a new control plane instance, the port
the API Server to bind to (default 6443)
.TP
.B certificate_key
Use this key to decrypt the certificate secrets uploaded by
init
.TP
.B config
Path to a kubeadm configuration file
.TP
.B cri_socket
Path to the CRI socket to connect
.TP
.B discovery_file
For file\-based discovery, a file or URL from which to load
cluster information
.TP
.B discovery_token
For token\-based discovery, the token used to validate cluster
information fetched from the API Server
.TP
.B discovery_token_ca_cert_hash
For token\-based discovery, validate that the root CA public key
matches this hash (format: \(dq<type>:<value>\(dq)
.TP
.B discovery_token_unsafe_skip_ca_verification
For token\-based discovery, allow joining without
\(aqdiscovery\-token\-ca\-cert\-hash\(aq pinning
.TP
.B experimental_control_plane
Create a new control plane instance on this node (kubeadm version =< 1.16)
.TP
.B control_plane
Create a new control plane instance on this node (kubeadm version > 1.16)
.TP
.B ignore_preflight_errors
A list of checks whose errors will be shown as warnings
.TP
.B node_name
Specify the node name
.TP
.B skip_phases
List of phases to be skipped
.TP
.B tls_bootstrap_token
Specify the token used to temporarily authenticate with the
Kubernetes Control Plane while joining the node
.TP
.B token
Use this token for both discovery\-token and tls\-bootstrap\-token
when those values are not provided
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.join 10.160.65.165:6443 token=\(aqtoken\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.join_params(create_if_needed=False)
New in version 3001.

.sp
Return the parameters required for joining into the cluster
.INDENT 7.0
.TP
.B create_if_needed
If the token bucket is empty and this parameter is True, a new
token will be created.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.join_params
salt \(aq*\(aq kubeadm.join_params create_if_needed=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.reset(cert_dir=None, cri_socket=None, ignore_preflight_errors=None, kubeconfig=None, rootfs=None)
New in version 3001.

.sp
Revert any changes made to this host by \(aqkubeadm init\(aq or \(aqkubeadm
join\(aq
.INDENT 7.0
.TP
.B cert_dir
The path to the directory where the certificates are stored
(default \(dq/etc/kubernetes/pki\(dq)
.TP
.B cri_socket
Path to the CRI socket to connect
.TP
.B ignore_preflight_errors
A list of checks whose errors will be shown as warnings
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.join 10.160.65.165:6443 token=\(aqtoken\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.token_create(token=None, config=None, description=None, groups=None, ttl=None, usages=None, kubeconfig=None, rootfs=None)
New in version 3001.

.sp
Create bootstrap tokens on the server
.INDENT 7.0
.TP
.B token
Token to write, if None one will be generated. The token must
match a regular expression, that by default is
[a\-z0\-9]{6}.[a\-z0\-9]{16}
.TP
.B config
Path to kubeadm configuration file
.TP
.B description
A human friendly description of how this token is used
.TP
.B groups
List of extra groups that this token will authenticate, default
to [\(aqsystem:bootstrappers:kubeadm:default\-node\-token\(aq]
.TP
.B ttl
The duration defore the token is automatically deleted (1s, 2m,
3h). If set to \(aq0\(aq the token will never expire. Default value
is 24h0m0s
.TP
.B usages
Describes the ways in which this token can be used. The default
value is [\(aqsigning\(aq, \(aqauthentication\(aq]
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.token_create
salt \(aq*\(aq kubeadm.token_create a1b2c.0123456789abcdef
salt \(aq*\(aq kubeadm.token_create ttl=\(aq6h\(aq
salt \(aq*\(aq kubeadm.token_create usages=\(dq[\(aqsigning\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.token_delete(token, kubeconfig=None, rootfs=None)
New in version 3001.

.sp
Delete bootstrap tokens on the server
.INDENT 7.0
.TP
.B token
Token to write, if None one will be generated. The token must
match a regular expression, that by default is
[a\-z0\-9]{6}.[a\-z0\-9]{16}
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.token_delete a1b2c
salt \(aq*\(aq kubeadm.token_create a1b2c.0123456789abcdef
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.token_generate(kubeconfig=None, rootfs=None)
New in version 3001.

.sp
Generate and return a bootstrap token, but do not create it on the
server
.INDENT 7.0
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.token_generate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.token_list(kubeconfig=None, rootfs=None)
New in version 3001.

.sp
List bootstrap tokens on the server
.INDENT 7.0
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.token_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubeadm.version(kubeconfig=None, rootfs=None)
New in version 3001.

.sp
Return the version of kubeadm
.INDENT 7.0
.TP
.B kubeconfig
The kubeconfig file to use when talking to the cluster. The
default values in /etc/kubernetes/admin.conf
.TP
.B rootfs
The path to the real host root filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubeadm.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.kubernetesmod
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%kubernetes Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Module for handling kubernetes calls.
.INDENT 0.0
.TP
.B optdepends
.INDENT 7.0
.IP \(bu 2
kubernetes Python client < 4.0
.IP \(bu 2
PyYAML < 6.0
.UNINDENT
.TP
.B configuration
The k8s API settings are provided either in a pillar, in
the minion\(aqs config file, or in master\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
kubernetes.kubeconfig: \(aq/path/to/kubeconfig\(aq
kubernetes.kubeconfig\-data: \(aq<base64 encoded kubeconfig content\(aq
kubernetes.context: \(aqcontext\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
These settings can be overridden by adding \fIcontext and \(gakubeconfig\fP or
\fIkubeconfig_data\fP parameters when calling a function.
.sp
The data format for \fIkubernetes.kubeconfig\-data\fP value is the content of
\fIkubeconfig\fP base64 encoded in one line.
.sp
Only \fIkubeconfig\fP or \fIkubeconfig\-data\fP should be provided. In case both are
provided \fIkubeconfig\fP entry is preferred.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.nodes kubeconfig=/etc/salt/k8s/kubeconfig context=minikube
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.sp
Changed in version 2019.2.0.

.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Configuration options changed in 2019.2.0. The following configuration options have been removed:
.INDENT 0.0
.IP \(bu 2
kubernetes.user
.IP \(bu 2
kubernetes.password
.IP \(bu 2
kubernetes.api_url
.IP \(bu 2
kubernetes.certificate\-authority\-data/file
.IP \(bu 2
kubernetes.client\-certificate\-data/file
.IP \(bu 2
kubernetes.client\-key\-data/file
.UNINDENT
.sp
Please use now:
.INDENT 0.0
.IP \(bu 2
kubernetes.kubeconfig or kubernetes.kubeconfig\-data
.IP \(bu 2
kubernetes.context
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.configmaps(namespace=\(aqdefault\(aq, **kwargs)
Return a list of kubernetes configmaps defined in the namespace
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.configmaps
salt \(aq*\(aq kubernetes.configmaps namespace=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.create_configmap(name, namespace, data, source=None, template=None, saltenv=\(aqbase\(aq, **kwargs)
Creates the kubernetes configmap as defined by the user.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion1\(aq kubernetes.create_configmap             settings default \(aq{\(dqexample.conf\(dq: \(dq# example file\(dq}\(aq

salt \(aqminion2\(aq kubernetes.create_configmap             name=settings namespace=default data=\(aq{\(dqexample.conf\(dq: \(dq# example file\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.create_deployment(name, namespace, metadata, spec, source, template, saltenv, **kwargs)
Creates the kubernetes deployment as defined by the user.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.create_namespace(name, **kwargs)
Creates a namespace with the specified name.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.create_namespace salt
salt \(aq*\(aq kubernetes.create_namespace name=salt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.create_pod(name, namespace, metadata, spec, source, template, saltenv, **kwargs)
Creates the kubernetes deployment as defined by the user.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.create_secret(name, namespace=\(aqdefault\(aq, data=None, source=None, template=None, saltenv=\(aqbase\(aq, **kwargs)
Creates the kubernetes secret as defined by the user.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion1\(aq kubernetes.create_secret             passwords default \(aq{\(dqdb\(dq: \(dqletmein\(dq}\(aq

salt \(aqminion2\(aq kubernetes.create_secret             name=passwords namespace=default data=\(aq{\(dqdb\(dq: \(dqletmein\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.create_service(name, namespace, metadata, spec, source, template, saltenv, **kwargs)
Creates the kubernetes service as defined by the user.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.delete_configmap(name, namespace=\(aqdefault\(aq, **kwargs)
Deletes the kubernetes configmap defined by name and namespace
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.delete_configmap settings default
salt \(aq*\(aq kubernetes.delete_configmap name=settings namespace=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.delete_deployment(name, namespace=\(aqdefault\(aq, **kwargs)
Deletes the kubernetes deployment defined by name and namespace
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.delete_deployment my\-nginx
salt \(aq*\(aq kubernetes.delete_deployment name=my\-nginx namespace=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.delete_namespace(name, **kwargs)
Deletes the kubernetes namespace defined by name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.delete_namespace salt
salt \(aq*\(aq kubernetes.delete_namespace name=salt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.delete_pod(name, namespace=\(aqdefault\(aq, **kwargs)
Deletes the kubernetes pod defined by name and namespace
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.delete_pod guestbook\-708336848\-5nl8c default
salt \(aq*\(aq kubernetes.delete_pod name=guestbook\-708336848\-5nl8c namespace=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.delete_secret(name, namespace=\(aqdefault\(aq, **kwargs)
Deletes the kubernetes secret defined by name and namespace
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.delete_secret confidential default
salt \(aq*\(aq kubernetes.delete_secret name=confidential namespace=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.delete_service(name, namespace=\(aqdefault\(aq, **kwargs)
Deletes the kubernetes service defined by name and namespace
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.delete_service my\-nginx default
salt \(aq*\(aq kubernetes.delete_service name=my\-nginx namespace=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.deployments(namespace=\(aqdefault\(aq, **kwargs)
Return a list of kubernetes deployments defined in the namespace
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.deployments
salt \(aq*\(aq kubernetes.deployments namespace=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.namespaces(**kwargs)
Return the names of the available namespaces
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.namespaces
salt \(aq*\(aq kubernetes.namespaces kubeconfig=/etc/salt/k8s/kubeconfig context=minikube
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.node(name, **kwargs)
Return the details of the node identified by the specified name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.node name=\(aqminikube\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.node_add_label(node_name, label_name, label_value, **kwargs)
Set the value of the label identified by \fIlabel_name\fP to \fIlabel_value\fP on
the node identified by the name \fInode_name\fP\&.
Creates the label if not present.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.node_add_label node_name=\(dqminikube\(dq             label_name=\(dqfoo\(dq label_value=\(dqbar\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.node_labels(name, **kwargs)
Return the labels of the node identified by the specified name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.node_labels name=\(dqminikube\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.node_remove_label(node_name, label_name, **kwargs)
Removes the label identified by \fIlabel_name\fP from
the node identified by the name \fInode_name\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.node_remove_label node_name=\(dqminikube\(dq             label_name=\(dqfoo\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.nodes(**kwargs)
Return the names of the nodes composing the kubernetes cluster
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.nodes
salt \(aq*\(aq kubernetes.nodes kubeconfig=/etc/salt/k8s/kubeconfig context=minikube
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.ping(**kwargs)
Checks connections with the kubernetes API server.
Returns True if the connection can be established, False otherwise.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.pods(namespace=\(aqdefault\(aq, **kwargs)
Return a list of kubernetes pods defined in the namespace
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.pods
salt \(aq*\(aq kubernetes.pods namespace=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.replace_configmap(name, data, source=None, template=None, saltenv=\(aqbase\(aq, namespace=\(aqdefault\(aq, **kwargs)
Replaces an existing configmap with a new one defined by name and
namespace with the specified data.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion1\(aq kubernetes.replace_configmap             settings default \(aq{\(dqexample.conf\(dq: \(dq# example file\(dq}\(aq

salt \(aqminion2\(aq kubernetes.replace_configmap             name=settings namespace=default data=\(aq{\(dqexample.conf\(dq: \(dq# example file\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.replace_deployment(name, metadata, spec, source, template, saltenv, namespace=\(aqdefault\(aq, **kwargs)
Replaces an existing deployment with a new one defined by name and
namespace, having the specificed metadata and spec.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.replace_secret(name, data, source=None, template=None, saltenv=\(aqbase\(aq, namespace=\(aqdefault\(aq, **kwargs)
Replaces an existing secret with a new one defined by name and namespace,
having the specificed data.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion1\(aq kubernetes.replace_secret             name=passwords data=\(aq{\(dqdb\(dq: \(dqletmein\(dq}\(aq

salt \(aqminion2\(aq kubernetes.replace_secret             name=passwords namespace=saltstack data=\(aq{\(dqdb\(dq: \(dqpassw0rd\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.replace_service(name, metadata, spec, source, template, old_service, saltenv, namespace=\(aqdefault\(aq, **kwargs)
Replaces an existing service with a new one defined by name and namespace,
having the specificed metadata and spec.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.secrets(namespace=\(aqdefault\(aq, **kwargs)
Return a list of kubernetes secrets defined in the namespace
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.secrets
salt \(aq*\(aq kubernetes.secrets namespace=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.services(namespace=\(aqdefault\(aq, **kwargs)
Return a list of kubernetes services defined in the namespace
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.services
salt \(aq*\(aq kubernetes.services namespace=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.show_configmap(name, namespace=\(aqdefault\(aq, **kwargs)
Return the kubernetes configmap defined by name and namespace.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.show_configmap game\-config default
salt \(aq*\(aq kubernetes.show_configmap name=game\-config namespace=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.show_deployment(name, namespace=\(aqdefault\(aq, **kwargs)
Return the kubernetes deployment defined by name and namespace
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.show_deployment my\-nginx default
salt \(aq*\(aq kubernetes.show_deployment name=my\-nginx namespace=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.show_namespace(name, **kwargs)
Return information for a given namespace defined by the specified name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.show_namespace kube\-system
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.show_pod(name, namespace=\(aqdefault\(aq, **kwargs)
Return POD information for a given pod name defined in the namespace
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.show_pod guestbook\-708336848\-fqr2x
salt \(aq*\(aq kubernetes.show_pod guestbook\-708336848\-fqr2x namespace=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.show_secret(name, namespace=\(aqdefault\(aq, decode=False, **kwargs)
Return the kubernetes secret defined by name and namespace.
The secrets can be decoded if specified by the user. Warning: this has
security implications.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.show_secret confidential default
salt \(aq*\(aq kubernetes.show_secret name=confidential namespace=default
salt \(aq*\(aq kubernetes.show_secret name=confidential decode=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.kubernetesmod.show_service(name, namespace=\(aqdefault\(aq, **kwargs)
Return the kubernetes service defined by name and namespace
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq kubernetes.show_service my\-nginx default
salt \(aq*\(aq kubernetes.show_service name=my\-nginx namespace=default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.launchctl_service
.sp
Module for the management of MacOS systems that use launchd/launchctl
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage services on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqservice.start\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
plistlib Python module
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.launchctl_service.available(job_label)
Check that the given service is available.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.available com.openssh.sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.launchctl_service.disabled(job_label, runas=None)
Return True if the named service is disabled, false otherwise
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disabled <service label>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.launchctl_service.enabled(job_label, runas=None)
Return True if the named service is enabled, false otherwise
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enabled <service label>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.launchctl_service.get_all()
Return all installed services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.launchctl_service.missing(job_label)
The inverse of service.available
Check that the given service is not available.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.missing com.openssh.sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.launchctl_service.restart(job_label, runas=None)
Restart the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service label>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.launchctl_service.start(job_label, runas=None)
Start the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service label>
salt \(aq*\(aq service.start org.ntp.ntpd
salt \(aq*\(aq service.start /System/Library/LaunchDaemons/org.ntp.ntpd.plist
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.launchctl_service.status(name, runas=None)
Return the status for a service via systemd.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.sp
Changed in version 2018.3.0: The service name can now be a glob (e.g. \fBsalt*\fP)

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- User to run launchctl commands
.UNINDENT
.TP
.B Returns
True if running, False otherwise
dict: Maps service name to True if running, False otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.launchctl_service.stop(job_label, runas=None)
Stop the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service label>
salt \(aq*\(aq service.stop org.ntp.ntpd
salt \(aq*\(aq service.stop /System/Library/LaunchDaemons/org.ntp.ntpd.plist
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.layman
.sp
Support for Layman
.INDENT 0.0
.TP
.B salt.modules.layman.add(overlay)
Add the given overlay from the cached remote list to your locally
installed overlays. Specify \(aqALL\(aq to add all overlays from the
remote list.
.sp
Return a list of the new overlay(s) added:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq layman.add <overlay name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.layman.delete(overlay)
Remove the given overlay from the your locally installed overlays.
Specify \(aqALL\(aq to remove all overlays.
.sp
Return a list of the overlays(s) that were removed:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq layman.delete <overlay name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.layman.list_all()
List all overlays, including remote ones.
.sp
Return a list of available overlays:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq layman.list_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.layman.list_local()
List the locally installed overlays.
.sp
Return a list of installed overlays:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq layman.list_local
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.layman.sync(overlay=\(aqALL\(aq)
Update the specified overlay. Use \(aqALL\(aq to synchronize all overlays.
This is the default if no overlay is specified.
.INDENT 7.0
.TP
.B overlay
Name of the overlay to sync. (Defaults to \(aqALL\(aq)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq layman.sync
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.ldap3
.SS Query and modify an LDAP database (alternative interface)
.sp
New in version 2016.3.0.

.sp
This is an alternative to the \fBldap\fP interface provided by the
\fI\%ldapmod\fP execution module.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
\fBldap\fP Python module
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.modules.ldap3.LDAPError(message, cause=None)
Base class of all LDAP exceptions raised by backends.
.sp
This is only used for errors encountered while interacting with
the LDAP server; usage errors (e.g., invalid backend name) will
have a different type.
.INDENT 7.0
.TP
.B Variables
\fBcause\fP \-\- backend exception object, if applicable
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ldap3.add(connect_spec, dn, attributes)
Add an entry to an LDAP database.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnect_spec\fP \-\- See the documentation for the \fBconnect_spec\fP parameter for
\fI\%connect()\fP\&.
.IP \(bu 2
\fBdn\fP \-\- Distinguished name of the entry.
.IP \(bu 2
\fBattributes\fP \-\- Non\-empty dict mapping each of the new entry\(aqs attributes to a
non\-empty iterable of values.
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, raises an exception otherwise.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ldap3.add \(dq{
    \(aqurl\(aq: \(aqldaps://ldap.example.com/\(aq,
    \(aqbind\(aq: {
        \(aqmethod\(aq: \(aqsimple\(aq,
        \(aqpassword\(aq: \(aqsecret\(aq,
    },
}\(dq \(dqdn=\(aqdc=example,dc=com\(aq\(dq \(dqattributes={\(aqexample\(aq: \(aqvalues\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ldap3.change(connect_spec, dn, before, after)
Modify an entry in an LDAP database.
.sp
This does the same thing as \fI\%modify()\fP, but with a simpler
interface.  Instead of taking a list of directives, it takes a
before and after view of an entry, determines the differences
between the two, computes the directives, and executes them.
.sp
Any attribute value present in \fBbefore\fP but missing in \fBafter\fP
is deleted.  Any attribute value present in \fBafter\fP but missing
in \fBbefore\fP is added.  Any attribute value in the database that
is not mentioned in either \fBbefore\fP or \fBafter\fP is not altered.
Any attribute value that is present in both \fBbefore\fP and
\fBafter\fP is ignored, regardless of whether that attribute value
exists in the database.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnect_spec\fP \-\- See the documentation for the \fBconnect_spec\fP parameter for
\fI\%connect()\fP\&.
.IP \(bu 2
\fBdn\fP \-\- Distinguished name of the entry.
.IP \(bu 2
\fBbefore\fP \-\- The expected state of the entry before modification.  This is
a dict mapping each attribute name to an iterable of values.
.IP \(bu 2
\fBafter\fP \-\- The desired state of the entry after modification.  This is a
dict mapping each attribute name to an iterable of values.
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, raises an exception otherwise.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ldap3.change \(dq{
    \(aqurl\(aq: \(aqldaps://ldap.example.com/\(aq,
    \(aqbind\(aq: {
        \(aqmethod\(aq: \(aqsimple\(aq,
        \(aqpassword\(aq: \(aqsecret\(aq}
}\(dq dn=\(aqcn=admin,dc=example,dc=com\(aq
before=\(dq{\(aqexample_value\(aq: \(aqbefore_val\(aq}\(dq
after=\(dq{\(aqexample_value\(aq: \(aqafter_val\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ldap3.connect(connect_spec=None)
Connect and optionally bind to an LDAP server.
.INDENT 7.0
.TP
.B Parameters
\fBconnect_spec\fP \-\-
.sp
This can be an LDAP connection object returned by a previous
call to \fI\%connect()\fP (in which case the argument is
simply returned), \fBNone\fP (in which case an empty dict is
used), or a dict with the following keys:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqbackend\(aq\fP
Optional; default depends on which Python LDAP modules are
installed.  Name of the Python LDAP module to use.  Only
\fB\(aqldap\(aq\fP is supported at the moment.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqurl\(aq\fP
Optional; defaults to \fB\(aqldapi:///\(aq\fP\&.  URL to the LDAP
server.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqbind\(aq\fP
Optional; defaults to \fBNone\fP\&.  Describes how to bind an
identity to the LDAP connection.  If \fBNone\fP, an
anonymous connection is made.  Valid keys:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqmethod\(aq\fP
Optional; defaults to \fBNone\fP\&.  The authentication
method to use.  Valid values include but are not
necessarily limited to \fB\(aqsimple\(aq\fP, \fB\(aqsasl\(aq\fP, and
\fBNone\fP\&.  If \fBNone\fP, an anonymous connection is
made.  Available methods depend on the chosen backend.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqmechanism\(aq\fP
Optional; defaults to \fB\(aqEXTERNAL\(aq\fP\&.  The SASL
mechanism to use.  Ignored unless the method is
\fB\(aqsasl\(aq\fP\&.  Available methods depend on the chosen
backend and the server\(aqs capabilities.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqcredentials\(aq\fP
Optional; defaults to \fBNone\fP\&.  An object specific to
the chosen SASL mechanism and backend that represents
the authentication credentials.  Ignored unless the
method is \fB\(aqsasl\(aq\fP\&.
.sp
For the \fB\(aqldap\(aq\fP backend, this is a dictionary.  If
\fBNone\fP, an empty dict is used.  Keys:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqargs\(aq\fP
Optional; defaults to an empty list.  A list of
arguments to pass to the SASL mechanism
constructor.  See the SASL mechanism constructor
documentation in the \fBldap.sasl\fP Python module.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqkwargs\(aq\fP
Optional; defaults to an empty dict.  A dict of
keyword arguments to pass to the SASL mechanism
constructor.  See the SASL mechanism constructor
documentation in the \fBldap.sasl\fP Python module.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqdn\(aq\fP
Optional; defaults to an empty string.  The
distinguished name to bind.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqpassword\(aq\fP
Optional; defaults to an empty string.  Password for
binding.  Ignored if the method is \fB\(aqsasl\(aq\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqtls\(aq\fP
Optional; defaults to \fBNone\fP\&.  A backend\-specific object
containing settings to override default TLS behavior.
.sp
For the \fB\(aqldap\(aq\fP backend, this is a dictionary.  Not all
settings in this dictionary are supported by all versions
of \fBpython\-ldap\fP or the underlying TLS library.  If
\fBNone\fP, an empty dict is used.  Possible keys:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqstarttls\(aq\fP
If present, initiate a TLS connection using StartTLS.
(The value associated with this key is ignored.)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqcacertdir\(aq\fP
Set the path of the directory containing CA
certificates.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqcacertfile\(aq\fP
Set the pathname of the CA certificate file.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqcertfile\(aq\fP
Set the pathname of the certificate file.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqcipher_suite\(aq\fP
Set the allowed cipher suite.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqcrlcheck\(aq\fP
Set the CRL evaluation strategy.  Valid values are
\fB\(aqnone\(aq\fP, \fB\(aqpeer\(aq\fP, and \fB\(aqall\(aq\fP\&.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqcrlfile\(aq\fP
Set the pathname of the CRL file.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqdhfile\(aq\fP
Set the pathname of the file containing the parameters
for Diffie\-Hellman ephemeral key exchange.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqkeyfile\(aq\fP
Set the pathname of the certificate key file.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqnewctx\(aq\fP
If present, instruct the underlying TLS library to
create a new TLS context.  (The value associated with
this key is ignored.)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqprotocol_min\(aq\fP
Set the minimum protocol version.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqrandom_file\(aq\fP
Set the pathname of the random file when
\fB/dev/random\fP and \fB/dev/urandom\fP are not
available.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqrequire_cert\(aq\fP
Set the certificate validation policy.  Valid values
are \fB\(aqnever\(aq\fP, \fB\(aqhard\(aq\fP, \fB\(aqdemand\(aq\fP,
\fB\(aqallow\(aq\fP, and \fB\(aqtry\(aq\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqopts\(aq\fP
Optional; defaults to \fBNone\fP\&.  A backend\-specific object
containing options for the backend.
.sp
For the \fB\(aqldap\(aq\fP backend, this is a dictionary of
OpenLDAP options to set.  If \fBNone\fP, an empty dict is
used.  Each key is a the name of an OpenLDAP option
constant without the \fB\(aqLDAP_OPT_\(aq\fP prefix, then
converted to lower case.
.UNINDENT
.UNINDENT

.TP
.B Returns
an object representing an LDAP connection that can be used as
the \fBconnect_spec\fP argument to any of the functions in this
module (to avoid the overhead of making and terminating
multiple connections).
.sp
This object should be used as a context manager.  It is safe
to nest \fBwith\fP statements.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ldap3.connect \(dq{
    \(aqurl\(aq: \(aqldaps://ldap.example.com/\(aq,
    \(aqbind\(aq: {
        \(aqmethod\(aq: \(aqsimple\(aq,
        \(aqdn\(aq: \(aqcn=admin,dc=example,dc=com\(aq,
        \(aqpassword\(aq: \(aqsecret\(aq}
}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ldap3.delete(connect_spec, dn)
Delete an entry from an LDAP database.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnect_spec\fP \-\- See the documentation for the \fBconnect_spec\fP parameter for
\fI\%connect()\fP\&.
.IP \(bu 2
\fBdn\fP \-\- Distinguished name of the entry.
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, raises an exception otherwise.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ldap3.delete \(dq{
    \(aqurl\(aq: \(aqldaps://ldap.example.com/\(aq,
    \(aqbind\(aq: {
        \(aqmethod\(aq: \(aqsimple\(aq,
        \(aqpassword\(aq: \(aqsecret\(aq}
}\(dq dn=\(aqcn=admin,dc=example,dc=com\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ldap3.modify(connect_spec, dn, directives)
Modify an entry in an LDAP database.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnect_spec\fP \-\- See the documentation for the \fBconnect_spec\fP parameter for
\fI\%connect()\fP\&.
.IP \(bu 2
\fBdn\fP \-\- Distinguished name of the entry.
.IP \(bu 2
\fBdirectives\fP \-\-
.sp
Iterable of directives that indicate how to modify the entry.
Each directive is a tuple of the form \fB(op, attr, vals)\fP,
where:
.INDENT 2.0
.IP \(bu 2
\fBop\fP identifies the modification operation to perform.
One of:
.INDENT 2.0
.IP \(bu 2
\fB\(aqadd\(aq\fP to add one or more values to the attribute
.IP \(bu 2
\fB\(aqdelete\(aq\fP to delete some or all of the values from the
attribute.  If no values are specified with this
operation, all of the attribute\(aqs values are deleted.
Otherwise, only the named values are deleted.
.IP \(bu 2
\fB\(aqreplace\(aq\fP to replace all of the attribute\(aqs values
with zero or more new values
.UNINDENT
.IP \(bu 2
\fBattr\fP names the attribute to modify
.IP \(bu 2
\fBvals\fP is an iterable of values to add or delete
.UNINDENT

.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, raises an exception otherwise.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ldap3.modify \(dq{
    \(aqurl\(aq: \(aqldaps://ldap.example.com/\(aq,
    \(aqbind\(aq: {
        \(aqmethod\(aq: \(aqsimple\(aq,
        \(aqpassword\(aq: \(aqsecret\(aq}
}\(dq dn=\(aqcn=admin,dc=example,dc=com\(aq
directives=\(dq(\(aqadd\(aq, \(aqexample\(aq, [\(aqexample_val\(aq])\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ldap3.search(connect_spec, base, scope=\(aqsubtree\(aq, filterstr=\(aq(objectClass=*)\(aq, attrlist=None, attrsonly=0)
Search an LDAP database.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnect_spec\fP \-\- See the documentation for the \fBconnect_spec\fP parameter for
\fI\%connect()\fP\&.
.IP \(bu 2
\fBbase\fP \-\- Distinguished name of the entry at which to start the search.
.IP \(bu 2
\fBscope\fP \-\-
.sp
One of the following:
.INDENT 2.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqsubtree\(aq\fP
Search the base and all of its descendants.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqbase\(aq\fP
Search only the base itself.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqonelevel\(aq\fP
Search only the base\(aqs immediate children.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBfilterstr\fP \-\- String representation of the filter to apply in the search.
.IP \(bu 2
\fBattrlist\fP \-\- Limit the returned attributes to those in the specified list.
If \fBNone\fP, all attributes of each entry are returned.
.IP \(bu 2
\fBattrsonly\fP \-\- If non\-zero, don\(aqt return any attribute values.
.UNINDENT
.TP
.B Returns
a dict of results.  The dict is empty if there are no results.
The dict maps each returned entry\(aqs distinguished name to a
dict that maps each of the matching attribute names to a list
of its values.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ldap3.search \(dq{
    \(aqurl\(aq: \(aqldaps://ldap.example.com/\(aq,
    \(aqbind\(aq: {
        \(aqmethod\(aq: \(aqsimple\(aq,
        \(aqdn\(aq: \(aqcn=admin,dc=example,dc=com\(aq,
        \(aqpassword\(aq: \(aqsecret\(aq,
    },
}\(dq \(dqbase=\(aqdc=example,dc=com\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.ldapmod
.sp
Salt interface to LDAP commands
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
ldap Python module
.UNINDENT
.TP
.B configuration
In order to connect to LDAP, certain configuration is required
in the minion config on the LDAP server. The minimum configuration items
that must be set are:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ldap.basedn: dc=acme,dc=com (example values, adjust to suit)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If your LDAP server requires authentication then you must also set:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ldap.anonymous: False
ldap.binddn: admin
ldap.bindpw: password
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In addition, the following optional values may be set:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ldap.server: localhost (default=localhost, see warning below)
ldap.port: 389 (default=389, standard port)
ldap.tls: False (default=False, no TLS)
ldap.no_verify: False (default=False, verify TLS)
ldap.anonymous: True (default=True, bind anonymous)
ldap.scope: 2 (default=2, ldap.SCOPE_SUBTREE)
ldap.attrs: [saltAttr] (default=None, return all attributes)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
At the moment this module only recommends connection to LDAP services
listening on \fBlocalhost\fP\&. This is deliberate to avoid the potentially
dangerous situation of multiple minions sending identical update commands
to the same LDAP server. It\(aqs easy enough to override this behavior, but
badness may ensue \- you have been warned.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ldapmod.search(filter, dn=None, scope=None, attrs=None, **kwargs)
Run an arbitrary LDAP query and return the results.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqldaphost\(aq ldap.search \(dqfilter=cn=myhost\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Return data:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqmyhost\(aq: {\(aqcount\(aq: 1,
            \(aqresults\(aq: [[\(aqcn=myhost,ou=hosts,o=acme,c=gb\(aq,
                         {\(aqsaltKeyValue\(aq: [\(aqntpserver=ntp.acme.local\(aq,
                                           \(aqfoo=myfoo\(aq],
                          \(aqsaltState\(aq: [\(aqfoo\(aq, \(aqbar\(aq]}]],
            \(aqtime\(aq: {\(aqhuman\(aq: \(aq1.2ms\(aq, \(aqraw\(aq: \(aq0.00123\(aq}}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Search and connection options can be overridden by specifying the relevant
option as key=value pairs, for example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqldaphost\(aq ldap.search filter=cn=myhost dn=ou=hosts,o=acme,c=gb
scope=1 attrs=\(aq\(aq server=\(aqlocalhost\(aq port=\(aq7393\(aq tls=True bindpw=\(aqssh\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.libcloud_compute
.SS Apache Libcloud Compute Management
.sp
Connection module for Apache Libcloud Compute management for a full list
of supported clouds, see \fI\%http://libcloud.readthedocs.io/en/latest/compute/supported_providers.html\fP
.sp
Clouds include Amazon EC2, Azure, Google GCE, VMware, OpenStack Nova
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B configuration
This module uses a configuration profile for one or multiple cloud providers
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
libcloud_compute:
    profile_test1:
      driver: google
      key: service\-account@googlecloud.net
      secret: /path/to.key.json
    profile_test2:
      driver: arm
      key: 12345
      secret: mysecret
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
apache\-libcloud
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.attach_volume(node_id, volume_id, profile, device=None, **libcloud_kwargs)
Attaches volume to node.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnode_id\fP (\fBstr\fP) \-\- Node ID to target
.IP \(bu 2
\fBvolume_id\fP (\fBstr\fP) \-\- Volume ID from which to attach
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBdevice\fP (\fBstr\fP) \-\- Where the device is exposed, e.g. \(aq/dev/sdb\(aq
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs attach_volume method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.detach_volume vol1 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.copy_image(source_region, image_id, name, profile, description=None, **libcloud_kwargs)
Copies an image from a source region to the current region.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsource_region\fP (\fBstr\fP) \-\- Region to copy the node from.
.IP \(bu 2
\fBimage_id\fP (\fBstr\fP) \-\- Image to copy.
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- name for new image.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBdescription\fP \-\- description for new image.
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs copy_image method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.copy_image us\-east1 image1 \(aqnew image\(aq profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.create_image(node_id, name, profile, description=None, **libcloud_kwargs)
Create an image from a node
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnode_id\fP (\fBstr\fP) \-\- Node to run the task on.
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- name for new image.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBdescription\fP (\fBdescription\fP) \-\- description for new image.
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs create_image method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.create_image server1 my_image profile1
salt myminion libcloud_compute.create_image server1 my_image profile1 description=\(aqtest image\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.create_key_pair(name, profile, **libcloud_kwargs)
Create a single key pair by name
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Name of the key pair to create.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs create_key_pair method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.create_key_pair pair1 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.create_volume(size, name, profile, location_id=None, **libcloud_kwargs)
Create a storage volume
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsize\fP (\fBint\fP) \-\- Size of volume in gigabytes (required)
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Name of the volume to be created
.IP \(bu 2
\fBlocation_id\fP (\fBstr\fP) \-\- Which data center to create a volume in. If
empty, undefined behavior will be selected.
(optional)
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs list_volumes method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.create_volume 1000 vol1 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.create_volume_snapshot(volume_id, profile, name=None, **libcloud_kwargs)
Create a storage volume snapshot
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvolume_id\fP (\fBstr\fP) \-\- Volume ID from which to create the new
snapshot.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Name of the snapshot to be created (optional)
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs create_volume_snapshot method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.create_volume_snapshot vol1 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.delete_image(image_id, profile, **libcloud_kwargs)
Delete an image of a node
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBimage_id\fP (\fBstr\fP) \-\- Image to delete
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs delete_image method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.delete_image image1 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.delete_key_pair(name, profile, **libcloud_kwargs)
Delete a key pair
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Key pair name.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs import_key_pair_from_xxx method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.delete_key_pair pair1 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.destroy_node(node_id, profile, **libcloud_kwargs)
Destroy a node in the cloud
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnode_id\fP (\fBstr\fP) \-\- Unique ID of the node to destroy
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs destroy_node method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.destry_node as\-2346 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.destroy_volume(volume_id, profile, **libcloud_kwargs)
Destroy a volume.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvolume_id\fP (\fBstr\fP) \-\- Volume ID from which to destroy
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs destroy_volume method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.destroy_volume vol1 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.destroy_volume_snapshot(volume_id, snapshot_id, profile, **libcloud_kwargs)
Destroy a volume snapshot.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvolume_id\fP (\fBstr\fP) \-\- Volume ID from which the snapshot belongs
.IP \(bu 2
\fBsnapshot_id\fP (\fBstr\fP) \-\- Volume Snapshot ID from which to destroy
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs destroy_volume_snapshot method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.destroy_volume_snapshot snap1 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.detach_volume(volume_id, profile, **libcloud_kwargs)
Detaches a volume from a node.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvolume_id\fP (\fBstr\fP) \-\- Volume ID from which to detach
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs detach_volume method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.detach_volume vol1 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.extra(method, profile, **libcloud_kwargs)
Call an extended method on the driver
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmethod\fP (\fBstr\fP) \-\- Driver\(aqs method name
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.extra ex_get_permissions google container_name=my_container object_name=me.jpg \-\-out=yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.get_image(image_id, profile, **libcloud_kwargs)
Get an image of a node
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBimage_id\fP (\fBstr\fP) \-\- Image to fetch
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs delete_image method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.get_image image1 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.get_key_pair(name, profile, **libcloud_kwargs)
Get a single key pair by name
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Name of the key pair to retrieve.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs get_key_pair method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.get_key_pair pair1 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.import_key_pair(name, key, profile, key_type=None, **libcloud_kwargs)
Import a new public key from string or a file path
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Key pair name.
.IP \(bu 2
\fBkey\fP (\fBstr\fP or path \fBstr\fP) \-\- Public key material, the string or a path to a file
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBkey_type\fP (\fBstr\fP) \-\- The key pair type, either \fIFILE\fP or \fISTRING\fP\&. Will detect if not provided
and assume that if the string is a path to an existing path it is a FILE, else STRING.
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs import_key_pair_from_xxx method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.import_key_pair pair1 key_value_data123 profile1
salt myminion libcloud_compute.import_key_pair pair1 /path/to/key profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.list_images(profile, location_id=None, **libcloud_kwargs)
Return a list of images for this cloud
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlocation_id\fP (\fBstr\fP) \-\- The location key, from list_locations
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs list_images method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.list_images profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.list_key_pairs(profile, **libcloud_kwargs)
List all the available key pair objects.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs list_key_pairs method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.list_key_pairs profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.list_locations(profile, **libcloud_kwargs)
Return a list of locations for this cloud
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs list_locations method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.list_locations profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.list_nodes(profile, **libcloud_kwargs)
Return a list of nodes
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs list_nodes method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.list_nodes profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.list_sizes(profile, location_id=None, **libcloud_kwargs)
Return a list of node sizes
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlocation_id\fP (\fBstr\fP) \-\- The location key, from list_locations
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs list_sizes method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.list_sizes profile1
salt myminion libcloud_compute.list_sizes profile1 us\-east1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.list_volume_snapshots(volume_id, profile, **libcloud_kwargs)
Return a list of storage volumes snapshots for this cloud
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvolume_id\fP (\fBstr\fP) \-\- The volume identifier
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs list_volume_snapshots method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.list_volume_snapshots vol1 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.list_volumes(profile, **libcloud_kwargs)
Return a list of storage volumes for this cloud
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs list_volumes method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.list_volumes profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_compute.reboot_node(node_id, profile, **libcloud_kwargs)
Reboot a node in the cloud
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnode_id\fP (\fBstr\fP) \-\- Unique ID of the node to reboot
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs reboot_node method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_compute.reboot_node as\-2346 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.libcloud_dns
.SS Apache Libcloud DNS Management
.sp
Connection module for Apache Libcloud DNS management
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B configuration
This module uses a configuration profile for one or multiple DNS providers
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
libcloud_dns:
    profile_test1:
      driver: cloudflare
      key: 12345
      secret: mysecret
    profile_test2:
      driver: godaddy
      key: 12345
      secret: mysecret
      shopper_id: 12345
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
apache\-libcloud
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_dns.create_record(name, zone_id, type, data, profile)
Create a new record.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Record name without the domain name (e.g. www).
Note: If you want to create a record for a base domain
name, you should specify empty string (\(aq\(aq) for this
argument.
.IP \(bu 2
\fBzone_id\fP (\fBstr\fP) \-\- Zone where the requested record is created.
.IP \(bu 2
\fBtype\fP (\fBstr\fP) \-\- DNS record type (A, AAAA, ...).
.IP \(bu 2
\fBdata\fP (\fBstr\fP) \-\- Data for the record (depends on the record type).
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_dns.create_record www google.com A 12.32.12.2 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_dns.create_zone(domain, profile, type=\(aqmaster\(aq, ttl=None)
Create a new zone.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdomain\fP (\fBstr\fP) \-\- Zone domain name (e.g. example.com)
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBtype\fP (\fBstr\fP) \-\- Zone type (master / slave).
.IP \(bu 2
\fBttl\fP (\fBint\fP) \-\- TTL for new records. (optional)
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_dns.create_zone google.com profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_dns.delete_record(zone_id, record_id, profile)
Delete a record.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBzone_id\fP (\fBstr\fP) \-\- Zone to delete.
.IP \(bu 2
\fBrecord_id\fP (\fBstr\fP) \-\- Record to delete.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.TP
.B Return type
\fBbool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_dns.delete_record google.com www profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_dns.delete_zone(zone_id, profile)
Delete a zone.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBzone_id\fP (\fBstr\fP) \-\- Zone to delete.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.TP
.B Return type
\fBbool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_dns.delete_zone google.com profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_dns.extra(method, profile, **libcloud_kwargs)
Call an extended method on the driver
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmethod\fP (\fBstr\fP) \-\- Driver\(aqs method name
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs delete_container method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_dns.extra ex_get_permissions google container_name=my_container object_name=me.jpg \-\-out=yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_dns.get_bind_data(zone_id, profile)
Export Zone to the BIND compatible format.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBzone_id\fP (\fBstr\fP) \-\- Zone to export.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.TP
.B Returns
Zone data in BIND compatible format.
.TP
.B Return type
\fBstr\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_dns.get_bind_data google.com profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_dns.get_record(zone_id, record_id, profile)
Get record information for the given zone_id on the given profile
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBzone_id\fP (\fBstr\fP) \-\- Zone to export.
.IP \(bu 2
\fBrecord_id\fP (\fBstr\fP) \-\- Record to delete.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_dns.get_record google.com www profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_dns.get_zone(zone_id, profile)
Get zone information for the given zone_id on the given profile
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBzone_id\fP (\fBstr\fP) \-\- Zone to export.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_dns.get_zone google.com profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_dns.list_record_types(profile)
List available record types for the given profile, e.g. A, AAAA
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_dns.list_record_types profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_dns.list_records(zone_id, profile, type=None)
List records for the given zone_id on the given profile
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBzone_id\fP (\fBstr\fP) \-\- Zone to export.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBtype\fP (\fBstr\fP) \-\- The record type, e.g. A, NS
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_dns.list_records google.com profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_dns.list_zones(profile)
List zones for the given profile
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_dns.list_zones profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_dns.update_zone(zone_id, domain, profile, type=\(aqmaster\(aq, ttl=None)
Update an existing zone.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBzone_id\fP (\fBstr\fP) \-\- Zone ID to update.
.IP \(bu 2
\fBdomain\fP (\fBstr\fP) \-\- Zone domain name (e.g. example.com)
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBtype\fP (\fBstr\fP) \-\- Zone type (master / slave).
.IP \(bu 2
\fBttl\fP (\fBint\fP) \-\- TTL for new records. (optional)
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_dns.update_zone google.com google.com profile1 type=slave
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.libcloud_loadbalancer
.SS Apache Libcloud Load Balancer Management
.sp
Connection module for Apache Libcloud Storage load balancer management for a full list
of supported clouds, see \fI\%http://libcloud.readthedocs.io/en/latest/loadbalancer/supported_providers.html\fP
.sp
Clouds include Amazon ELB, ALB, Google, Aliyun, CloudStack, Softlayer
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B configuration
This module uses a configuration profile for one or multiple Storage providers
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
libcloud_loadbalancer:
    profile_test1:
      driver: gce
      key: GOOG0123456789ABCXYZ
      secret: mysecret
    profile_test2:
      driver: alb
      key: 12345
      secret: mysecret
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
apache\-libcloud
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_loadbalancer.balancer_attach_member(balancer_id, ip, port, profile, extra=None, **libcloud_kwargs)
Add a new member to the load balancer
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBbalancer_id\fP (\fBstr\fP) \-\- id of a load balancer you want to fetch
.IP \(bu 2
\fBip\fP (\fBstr\fP) \-\- IP address for the new member
.IP \(bu 2
\fBport\fP (\fBint\fP) \-\- Port for the new member
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs balancer_attach_member method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.balancer_attach_member balancer123 1.2.3.4 80 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_loadbalancer.balancer_detach_member(balancer_id, member_id, profile, **libcloud_kwargs)
Add a new member to the load balancer
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBbalancer_id\fP (\fBstr\fP) \-\- id of a load balancer you want to fetch
.IP \(bu 2
\fBip\fP (\fBstr\fP) \-\- IP address for the new member
.IP \(bu 2
\fBport\fP (\fBint\fP) \-\- Port for the new member
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs balancer_detach_member method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.balancer_detach_member balancer123 member123 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_loadbalancer.create_balancer(name, port, protocol, profile, algorithm=None, members=None, **libcloud_kwargs)
Create a new load balancer instance
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Name of the new load balancer (required)
.IP \(bu 2
\fBport\fP (\fBstr\fP) \-\- Port the load balancer should listen on, defaults to 80
.IP \(bu 2
\fBprotocol\fP (\fBstr\fP) \-\- Loadbalancer protocol, defaults to http.
.IP \(bu 2
\fBalgorithm\fP (\fBstr\fP) \-\- Load balancing algorithm, defaults to ROUND_ROBIN. See Algorithm type
in Libcloud documentation for a full listing.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs create_balancer method
.UNINDENT
.TP
.B Returns
The details of the new balancer
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.create_balancer my_balancer 80 http profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_loadbalancer.destroy_balancer(balancer_id, profile, **libcloud_kwargs)
Destroy a load balancer
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBbalancer_id\fP (\fBstr\fP) \-\- LoadBalancer ID which should be used
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs destroy_balancer method
.UNINDENT
.TP
.B Returns
\fBTrue\fP if the destroy was successful, otherwise \fBFalse\fP\&.
.TP
.B Return type
\fBbool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.destroy_balancer balancer_1 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_loadbalancer.extra(method, profile, **libcloud_kwargs)
Call an extended method on the driver
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmethod\fP (\fBstr\fP) \-\- Driver\(aqs method name
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_loadbalancer.extra ex_get_permissions google container_name=my_container object_name=me.jpg \-\-out=yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_loadbalancer.get_balancer(balancer_id, profile, **libcloud_kwargs)
Get the details for a load balancer by ID
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBbalancer_id\fP (\fBstr\fP) \-\- id of a load balancer you want to fetch
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs get_balancer method
.UNINDENT
.TP
.B Returns
the load balancer details
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.get_balancer balancer123 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_loadbalancer.get_balancer_by_name(name, profile, **libcloud_kwargs)
Get the details for a load balancer by name
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Name of a load balancer you want to fetch
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs list_balancers method
.UNINDENT
.TP
.B Returns
the load balancer details
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.get_balancer_by_name my_balancer profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_loadbalancer.list_balancer_members(balancer_id, profile, **libcloud_kwargs)
List the members of a load balancer
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBbalancer_id\fP (\fBstr\fP) \-\- id of a load balancer you want to fetch
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs list_balancer_members method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.list_balancer_members balancer123 profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_loadbalancer.list_balancers(profile, **libcloud_kwargs)
Return a list of load balancers.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs list_balancers method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.list_balancers profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_loadbalancer.list_protocols(profile, **libcloud_kwargs)
Return a list of supported protocols.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs list_protocols method
.UNINDENT
.TP
.B Returns
a list of supported protocols
.TP
.B Return type
\fBlist\fP of \fBstr\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.list_protocols profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_loadbalancer.list_supported_algorithms(profile, **libcloud_kwargs)
Get the supported algorithms for a profile
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs list_supported_algorithms method
.UNINDENT
.TP
.B Returns
The supported algorithms
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.list_supported_algorithms profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.libcloud_storage
.SS Apache Libcloud Storage Management
.sp
Connection module for Apache Libcloud Storage (object/blob) management for a full list
of supported clouds, see \fI\%http://libcloud.readthedocs.io/en/latest/storage/supported_providers.html\fP
.sp
Clouds include Amazon S3, Google Storage, Aliyun, Azure Blobs, Ceph, OpenStack swift
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B configuration
This module uses a configuration profile for one or multiple Storage providers
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
libcloud_storage:
    profile_test1:
      driver: google_storage
      key: GOOG0123456789ABCXYZ
      secret: mysecret
    profile_test2:
      driver: s3
      key: 12345
      secret: mysecret
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
apache\-libcloud
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_storage.create_container(container_name, profile, **libcloud_kwargs)
Create a container in the cloud
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontainer_name\fP (\fBstr\fP) \-\- Container name
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs create_container method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.create_container MyFolder profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_storage.delete_container(container_name, profile, **libcloud_kwargs)
Delete an object container in the cloud
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontainer_name\fP (\fBstr\fP) \-\- Container name
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs delete_container method
.UNINDENT
.TP
.B Returns
True if an object container has been successfully deleted, False
otherwise.
.TP
.B Return type
\fBbool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.delete_container MyFolder profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_storage.delete_object(container_name, object_name, profile, **libcloud_kwargs)
Delete an object in the cloud
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontainer_name\fP (\fBstr\fP) \-\- Container name
.IP \(bu 2
\fBobject_name\fP (\fBstr\fP) \-\- Object name
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs delete_object method
.UNINDENT
.TP
.B Returns
True if an object has been successfully deleted, False
otherwise.
.TP
.B Return type
\fBbool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.delete_object MyFolder me.jpg profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_storage.download_object(container_name, object_name, destination_path, profile, overwrite_existing=False, delete_on_failure=True, **libcloud_kwargs)
Download an object to the specified destination path.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontainer_name\fP (\fBstr\fP) \-\- Container name
.IP \(bu 2
\fBobject_name\fP (\fBstr\fP) \-\- Object name
.IP \(bu 2
\fBdestination_path\fP (\fBstr\fP) \-\- Full path to a file or a directory where the
incoming file will be saved.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBoverwrite_existing\fP (\fBbool\fP) \-\- True to overwrite an existing file,
defaults to False.
.IP \(bu 2
\fBdelete_on_failure\fP (\fBbool\fP) \-\- True to delete a partially downloaded file if
the download was not successful (hash
mismatch / file size).
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs download_object method
.UNINDENT
.TP
.B Returns
True if an object has been successfully downloaded, False
otherwise.
.TP
.B Return type
\fBbool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.download_object MyFolder me.jpg /tmp/me.jpg profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_storage.extra(method, profile, **libcloud_kwargs)
Call an extended method on the driver
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmethod\fP (\fBstr\fP) \-\- Driver\(aqs method name
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs delete_container method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.extra ex_get_permissions google container_name=my_container object_name=me.jpg \-\-out=yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_storage.get_container(container_name, profile, **libcloud_kwargs)
List container details for the given container_name on the given profile
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontainer_name\fP (\fBstr\fP) \-\- Container name
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs get_container method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.get_container MyFolder profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_storage.get_container_object(container_name, object_name, profile, **libcloud_kwargs)
Get the details for a container object (file or object in the cloud)
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontainer_name\fP (\fBstr\fP) \-\- Container name
.IP \(bu 2
\fBobject_name\fP (\fBstr\fP) \-\- Object name
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs get_container_object method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.get_container_object MyFolder MyFile.xyz profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_storage.list_container_objects(container_name, profile, **libcloud_kwargs)
List container objects (e.g. files) for the given container_id on the given profile
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontainer_name\fP (\fBstr\fP) \-\- Container name
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs list_container_objects method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.list_container_objects MyFolder profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_storage.list_containers(profile, **libcloud_kwargs)
Return a list of containers.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs list_containers method
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.list_containers profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.libcloud_storage.upload_object(file_path, container_name, object_name, profile, extra=None, verify_hash=True, headers=None, **libcloud_kwargs)
Upload an object currently located on a disk.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfile_path\fP (\fBstr\fP) \-\- Path to the object on disk.
.IP \(bu 2
\fBcontainer_name\fP (\fBstr\fP) \-\- Destination container.
.IP \(bu 2
\fBobject_name\fP (\fBstr\fP) \-\- Object name.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBverify_hash\fP (\fBbool\fP) \-\- Verify hash
.IP \(bu 2
\fBextra\fP (\fBdict\fP) \-\- Extra attributes (driver specific). (optional)
.IP \(bu 2
\fBheaders\fP (\fBdict\fP) \-\- (optional) Additional request headers,
such as CORS headers. For example:
headers = {\(aqAccess\-Control\-Allow\-Origin\(aq: \(aq\fI\%http://mozilla.com\fP\(aq}
.IP \(bu 2
\fBlibcloud_kwargs\fP (\fBdict\fP) \-\- Extra arguments for the driver\(aqs upload_object method
.UNINDENT
.TP
.B Returns
The object name in the cloud
.TP
.B Return type
\fBstr\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion libcloud_storage.upload_object /file/to/me.jpg MyFolder me.jpg profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.linux_acl
.sp
Support for Linux File Access Control Lists
.sp
The Linux ACL module requires the \fIgetfacl\fP and \fIsetfacl\fP binaries.
.INDENT 0.0
.TP
.B salt.modules.linux_acl.delfacl(acl_type, acl_name=\(aq\(aq, *args, **kwargs)
Remove specific FACL from the specified file(s)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq acl.delfacl user myuser /tmp/house/kitchen
salt \(aq*\(aq acl.delfacl default:group mygroup /tmp/house/kitchen
salt \(aq*\(aq acl.delfacl d:u myuser /tmp/house/kitchen
salt \(aq*\(aq acl.delfacl g myuser /tmp/house/kitchen /tmp/house/livingroom
salt \(aq*\(aq acl.delfacl user myuser /tmp/house/kitchen recursive=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_acl.getfacl(*args, **kwargs)
Return (extremely verbose) map of FACLs on specified file(s)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq acl.getfacl /tmp/house/kitchen
salt \(aq*\(aq acl.getfacl /tmp/house/kitchen /tmp/house/livingroom
salt \(aq*\(aq acl.getfacl /tmp/house/kitchen /tmp/house/livingroom recursive=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_acl.modfacl(acl_type, acl_name=\(aq\(aq, perms=\(aq\(aq, *args, **kwargs)
Add or modify a FACL for the specified file(s)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq acl.modfacl user myuser rwx /tmp/house/kitchen
salt \(aq*\(aq acl.modfacl default:group mygroup rx /tmp/house/kitchen
salt \(aq*\(aq acl.modfacl d:u myuser 7 /tmp/house/kitchen
salt \(aq*\(aq acl.modfacl g mygroup 0 /tmp/house/kitchen /tmp/house/livingroom
salt \(aq*\(aq acl.modfacl user myuser rwx /tmp/house/kitchen recursive=True
salt \(aq*\(aq acl.modfacl user myuser rwx /tmp/house/kitchen raise_err=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_acl.version()
Return facl version from getfacl \-\-version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq acl.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_acl.wipefacls(*args, **kwargs)
Remove all FACLs from the specified file(s)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq acl.wipefacls /tmp/house/kitchen
salt \(aq*\(aq acl.wipefacls /tmp/house/kitchen /tmp/house/livingroom
salt \(aq*\(aq acl.wipefacls /tmp/house/kitchen /tmp/house/livingroom recursive=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.linux_ip
.sp
The networking module for Non\-RH/Deb Linux distros
.INDENT 0.0
.TP
.B salt.modules.linux_ip.down(iface, iface_type=None)
Shutdown a network interface
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.down eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_ip.get_interface(iface)
Return the contents of an interface script
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.get_interface eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_ip.get_routes(iface=None)
Return the current routing table
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.get_routes
salt \(aq*\(aq ip.get_routes eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_ip.up(iface, iface_type=None)
Start up a network interface
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.up eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.linux_lvm
.sp
Support for Linux LVM2
.INDENT 0.0
.TP
.B salt.modules.linux_lvm.fullversion()
Return all version info from lvm version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvm.fullversion
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_lvm.lvcreate(lvname, vgname, size=None, extents=None, snapshot=None, pv=None, thinvolume=False, thinpool=False, force=False, **kwargs)
Create a new logical volume, with option for which physical volume to be used
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvm.lvcreate new_volume_name     vg_name size=10G
salt \(aq*\(aq lvm.lvcreate new_volume_name     vg_name extents=100 pv=/dev/sdb
salt \(aq*\(aq lvm.lvcreate new_snapshot        vg_name snapshot=volume_name size=3G
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 0.12.0.

.sp
Support for thin pools and thin volumes
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvm.lvcreate new_thinpool_name   vg_name               size=20G thinpool=True
salt \(aq*\(aq lvm.lvcreate new_thinvolume_name vg_name/thinpool_name size=10G thinvolume=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_lvm.lvdisplay(lvname=\(aq\(aq, quiet=False)
Return information about the logical volume(s)
.INDENT 7.0
.TP
.B lvname
logical device name
.TP
.B quiet
if the logical volume is not present, do not show any error
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvm.lvdisplay
salt \(aq*\(aq lvm.lvdisplay /dev/vg_myserver/root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_lvm.lvextend(size=None, lvpath=None, extents=None, force=False, resizefs=False)
Increase a logical volume to specific size.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvm.lvextend +12M /dev/mapper/vg1\-test
salt \(aq*\(aq lvm.lvextend lvpath=/dev/mapper/vg1\-test extents=+100%FREE
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_lvm.lvremove(lvname, vgname, force=True)
Remove a given existing logical volume from a named existing volume group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvm.lvremove lvname vgname force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_lvm.lvresize(size=None, lvpath=None, extents=None, force=False, resizefs=False)
Resize a logical volume to specific size.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvm.lvresize +12M /dev/mapper/vg1\-test
salt \(aq*\(aq lvm.lvresize lvpath=/dev/mapper/vg1\-test extents=+100%FREE
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_lvm.pvcreate(devices, override=True, force=True, **kwargs)
Set a physical device to be used as an LVM physical volume
.INDENT 7.0
.TP
.B override
Skip devices, if they are already LVM physical volumes
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt mymachine lvm.pvcreate /dev/sdb1,/dev/sdb2
salt mymachine lvm.pvcreate /dev/sdb1 dataalignmentoffset=7s
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_lvm.pvdisplay(pvname=\(aq\(aq, real=False, quiet=False)
Return information about the physical volume(s)
.INDENT 7.0
.TP
.B pvname
physical device name
.TP
.B real
dereference any symlinks and report the real device
.sp
New in version 2015.8.7.

.TP
.B quiet
if the physical volume is not present, do not show any error
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvm.pvdisplay
salt \(aq*\(aq lvm.pvdisplay /dev/md0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_lvm.pvremove(devices, override=True, force=True)
Remove a physical device being used as an LVM physical volume
.INDENT 7.0
.TP
.B override
Skip devices, if they are already not used as LVM physical volumes
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt mymachine lvm.pvremove /dev/sdb1,/dev/sdb2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_lvm.pvresize(devices, override=True, force=True)
Resize a LVM physical volume to the physical device size
.INDENT 7.0
.TP
.B override
Skip devices, if they are already not used as LVM physical volumes
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt mymachine lvm.pvresize /dev/sdb1,/dev/sdb2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_lvm.version()
Return LVM version from lvm version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvm.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_lvm.vgcreate(vgname, devices, force=False, **kwargs)
Create an LVM volume group
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt mymachine lvm.vgcreate my_vg /dev/sdb1,/dev/sdb2
salt mymachine lvm.vgcreate my_vg /dev/sdb1 clustered=y
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_lvm.vgdisplay(vgname=\(aq\(aq, quiet=False)
Return information about the volume group(s)
.INDENT 7.0
.TP
.B vgname
volume group name
.TP
.B quiet
if the volume group is not present, do not show any error
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvm.vgdisplay
salt \(aq*\(aq lvm.vgdisplay nova\-volumes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_lvm.vgextend(vgname, devices, force=False)
Add physical volumes to an LVM volume group
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt mymachine lvm.vgextend my_vg /dev/sdb1,/dev/sdb2
salt mymachine lvm.vgextend my_vg /dev/sdb1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_lvm.vgremove(vgname, force=True)
Remove an LVM volume group
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt mymachine lvm.vgremove vgname
salt mymachine lvm.vgremove vgname force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.linux_service
.sp
If Salt\(aqs OS detection does not identify a different virtual service module, the minion will fall back to using this basic module, which simply wraps sysvinit scripts.
.INDENT 0.0
.TP
.B salt.modules.linux_service.available(name)
Returns \fBTrue\fP if the specified service is available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.available sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_service.get_all()
Return a list of all available services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_service.missing(name)
The inverse of service.available.
Returns \fBTrue\fP if the specified service is not available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.missing sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_service.reload_(name)
Refreshes config files by calling service reload. Does not perform a full
restart.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_service.restart(name)
Restart the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_service.run(name, action)
Run the specified service with an action.
.sp
New in version 2015.8.1.

.INDENT 7.0
.TP
.B name
Service name.
.TP
.B action
Action name (like start,  stop,  reload,  restart).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.run apache2 reload
salt \(aq*\(aq service.run postgresql initdb
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_service.start(name)
Start the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_service.status(name, sig=None)
Return the status for a service.
If the name contains globbing, a dict mapping service name to PID or empty
string is returned.
.sp
Changed in version 2018.3.0: The service name can now be a glob (e.g. \fBsalt*\fP)

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.IP \(bu 2
\fBsig\fP (\fI\%str\fP) \-\- Signature to use to find the service via ps
.UNINDENT
.TP
.B Returns
PID if running, empty otherwise
dict: Maps service name to PID if running, empty string otherwise
.TP
.B Return type
string
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name> [service signature]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_service.stop(name)
Stop the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.linux_shadow
.sp
Manage the shadow file on Linux systems
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage passwords on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqshadow.info\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_shadow.default_hash()
Returns the default hash used for unset passwords
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.default_hash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_shadow.del_password(name, root=None)
New in version 2014.7.0.

.sp
Delete the password from name user
.INDENT 7.0
.TP
.B name
User to delete
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.del_password username
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_shadow.gen_password(password, crypt_salt=None, algorithm=\(aqsha512\(aq)
New in version 2014.7.0.

.sp
Generate hashed password
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When called this function is called directly via remote\-execution,
the password argument may be displayed in the system\(aqs process list.
This may be a security risk on certain systems.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B password
Plaintext password to be hashed.
.TP
.B crypt_salt
Crpytographic salt. If not given, a random 8\-character salt will be
generated.
.TP
.B algorithm
The following hash algorithms are supported:
.INDENT 7.0
.IP \(bu 2
md5
.IP \(bu 2
blowfish (not in mainline glibc, only available in distros that add it)
.IP \(bu 2
sha256
.IP \(bu 2
sha512 (default)
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.gen_password \(aqI_am_password\(aq
salt \(aq*\(aq shadow.gen_password \(aqI_am_password\(aq crypt_salt=\(aqI_am_salt\(aq algorithm=sha256
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_shadow.info(name, root=None)
Return information for the specified user
.INDENT 7.0
.TP
.B name
User to get the information for
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.info root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_shadow.list_users(root=None)
New in version 2018.3.0.

.sp
Return a list of all shadow users
.INDENT 7.0
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.list_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_shadow.lock_password(name, root=None)
New in version 2016.11.0.

.sp
Lock the password from specified user
.INDENT 7.0
.TP
.B name
User to lock
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.lock_password username
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_shadow.set_date(name, date, root=None)
Sets the value for the date the password was last changed to days since the
epoch (January 1, 1970). See man chage.
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B date
Date the password was last changed
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_date username 0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_shadow.set_expire(name, expire, root=None)
Changed in version 2014.7.0.

.sp
Sets the value for the date the account expires as days since the epoch
(January 1, 1970). Using a value of \-1 will clear expiration. See man
chage.
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B date
Date the account expires
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_expire username \-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_shadow.set_inactdays(name, inactdays, root=None)
Set the number of days of inactivity after a password has expired before
the account is locked. See man chage.
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B inactdays
Set password inactive after this number of days
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_inactdays username 7
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_shadow.set_maxdays(name, maxdays, root=None)
Set the maximum number of days during which a password is valid.
See man chage.
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B maxdays
Maximum number of days during which a password is valid
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_maxdays username 90
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_shadow.set_mindays(name, mindays, root=None)
Set the minimum number of days between password changes. See man chage.
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B mindays
Minimum number of days between password changes
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_mindays username 7
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_shadow.set_password(name, password, use_usermod=False, root=None)
Set the password for a named user. The password must be a properly defined
hash. A password hash can be generated with \fI\%gen_password()\fP\&.
.INDENT 7.0
.TP
.B name
User to set the password
.TP
.B password
Password already hashed
.TP
.B use_usermod
Use usermod command to better compatibility
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_password root \(aq$1$UYCIxa628.9qXjpQCjM4a..\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_shadow.set_warndays(name, warndays, root=None)
Set the number of days of warning before a password change is required.
See man chage.
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B warndays
Number of days of warning before a password change is required
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_warndays username 7
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_shadow.unlock_password(name, root=None)
New in version 2016.11.0.

.sp
Unlock the password from name user
.INDENT 7.0
.TP
.B name
User to unlock
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.unlock_password username
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.linux_sysctl
.sp
Module for viewing and modifying sysctl parameters
.INDENT 0.0
.TP
.B salt.modules.linux_sysctl.assign(name, value)
Assign a single sysctl parameter for this minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.assign net.ipv4.ip_forward 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_sysctl.default_config()
Linux hosts using systemd 207 or later ignore \fB/etc/sysctl.conf\fP and only
load from \fB/etc/sysctl.d/*.conf\fP\&. This function will do the proper checks
and return a default config file which will be valid for the Minion. Hosts
running systemd >= 207 will use \fB/etc/sysctl.d/99\-salt.conf\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqkernel:Linux\(aq sysctl.default_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_sysctl.get(name)
Return a single sysctl parameter for this minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.get net.ipv4.ip_forward
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_sysctl.persist(name, value, config=None)
Assign and persist a simple sysctl parameter for this minion. If \fBconfig\fP
is not specified, a sensible default will be chosen using
\fI\%sysctl.default_config\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.persist net.ipv4.ip_forward 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.linux_sysctl.show(config_file=False)
Return a list of sysctl parameters for this minion
.INDENT 7.0
.TP
.B config: Pull the data from the system configuration file
instead of the live data.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.show
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.localemod
.sp
Module for managing locales on POSIX\-like systems.
.INDENT 0.0
.TP
.B salt.modules.localemod.avail(locale)
Check if a locale is available.
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq locale.avail \(aqen_US.UTF\-8\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.localemod.gen_locale(locale, **kwargs)
Generate a locale. Options:
.sp
New in version 2014.7.0.

.INDENT 7.0
.TP
.B Parameters
\fBlocale\fP \-\- Any locale listed in /usr/share/i18n/locales or
/usr/share/i18n/SUPPORTED for Debian and Gentoo based distributions,
which require the charmap to be specified as part of the locale
when generating it.
.UNINDENT
.INDENT 7.0
.TP
.B verbose
Show extra warnings about errors that are normally ignored.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq locale.gen_locale en_US.UTF\-8
salt \(aq*\(aq locale.gen_locale \(aqen_IE.UTF\-8 UTF\-8\(aq    # Debian/Gentoo only
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.localemod.get_locale()
Get the current system locale
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq locale.get_locale
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.localemod.list_avail()
Lists available (compiled) locales
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq locale.list_avail
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.localemod.set_locale(locale)
Sets the current system locale
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq locale.set_locale \(aqen_US.UTF\-8\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.locate
.sp
Module for using the locate utilities
.INDENT 0.0
.TP
.B salt.modules.locate.locate(pattern, database=\(aq\(aq, limit=0, **kwargs)
Performs a file lookup. Valid options (and their defaults) are:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
basename=False
count=False
existing=False
follow=True
ignore=False
nofollow=False
wholename=True
regex=False
database=<locate\(aqs default database>
limit=<integer, not set by default>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See the manpage for \fBlocate(1)\fP for further explanation of these options.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq locate.locate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.locate.stats()
Returns statistics about the locate database
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq locate.stats
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.locate.updatedb()
Updates the locate database
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq locate.updatedb
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.locate.version()
Returns the version of locate
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq locate.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.logadm
.sp
Module for managing Solaris logadm based log rotations.
.INDENT 0.0
.TP
.B salt.modules.logadm.list_conf(conf_file=\(aq/etc/logadm.conf\(aq, log_file=None, include_unset=False)
Show parsed configuration
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B conf_file
string
path to logadm.conf, defaults to /etc/logadm.conf
.TP
.B log_file
string
optional show only one log file
.TP
.B include_unset
boolean
include unset flags in output
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq logadm.list_conf
salt \(aq*\(aq logadm.list_conf log=/var/log/syslog
salt \(aq*\(aq logadm.list_conf include_unset=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.logadm.remove(name, conf_file=\(aq/etc/logadm.conf\(aq)
Remove log pattern from logadm
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq logadm.remove myapplog
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.logadm.rotate(name, pattern=None, conf_file=\(aq/etc/logadm.conf\(aq, **kwargs)
Set up pattern for logging.
.INDENT 7.0
.TP
.B name
string
alias for entryname
.TP
.B pattern
string
alias for log_file
.TP
.B conf_file
string
optional path to alternative configuration file
.TP
.B kwargs
boolean|string|int
optional additional flags and parameters
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBname\fP and \fBpattern\fP were kept for backwards compatibility reasons.
.sp
\fBname\fP is an alias for the \fBentryname\fP argument, \fBpattern\fP is an alias
for \fBlog_file\fP\&. These aliases will only be used if the \fBentryname\fP and
\fBlog_file\fP arguments are not passed.
.sp
For a full list of arguments see \fB\(galogadm.show_args\(ga\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq logadm.rotate myapplog pattern=\(aq/var/log/myapp/*.log\(aq count=7
salt \(aq*\(aq logadm.rotate myapplog log_file=\(aq/var/log/myapp/*.log\(aq count=4 owner=myappd mode=\(aq0700\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.logadm.show_args()
Show which arguments map to which flags and options.
.sp
New in version 2018.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq logadm.show_args
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.logadm.show_conf(conf_file=\(aq/etc/logadm.conf\(aq, name=None)
Show configuration
.INDENT 7.0
.TP
.B conf_file
string
path to logadm.conf, defaults to /etc/logadm.conf
.TP
.B name
string
optional show only a single entry
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq logadm.show_conf
salt \(aq*\(aq logadm.show_conf name=/var/log/syslog
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.logmod
.SS On\-demand logging
.sp
New in version 2017.7.0.

.sp
The sole purpose of this module is logging messages in the (proxy) minion.
It comes very handy when debugging complex Jinja templates, for example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- for var in range(10) %}
  {%\- do salt[\(dqlog.info\(dq](var) \-%}
{%\- endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq log.error \(dqPlease don\(aqt do that, this module is not for CLI use!\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.logmod.critical(message)
Log message at level CRITICAL.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.logmod.debug(message)
Log message at level DEBUG.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.logmod.error(message)
Log message at level ERROR.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.logmod.exception(message)
Log message at level EXCEPTION.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.logmod.info(message)
Log message at level INFO.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.logmod.warning(message)
Log message at level WARNING.
.UNINDENT
.SS salt.modules.logrotate
.sp
Module for managing logrotate.
.INDENT 0.0
.TP
.B salt.modules.logrotate.get(key, value=None, conf_file=\(aq/etc/logrotate.conf\(aq)
Get the value for a specific configuration line.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The command or stanza block to configure.
.IP \(bu 2
\fBvalue\fP (\fI\%str\fP) \-\- The command value or command of the block specified by the key parameter.
.IP \(bu 2
\fBconf_file\fP (\fI\%str\fP) \-\- The logrotate configuration file.
.UNINDENT
.TP
.B Returns
The value for a specific configuration line.
.TP
.B Return type
\fI\%bool\fP|\fI\%int\fP|\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq logrotate.get rotate

salt \(aq*\(aq logrotate.get /var/log/wtmp rotate /etc/logrotate.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.logrotate.set_(key, value, setting=None, conf_file=\(aq/etc/logrotate.conf\(aq)
Set a new value for a specific configuration line.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The command or block to configure.
.IP \(bu 2
\fBvalue\fP (\fI\%str\fP) \-\- The command value or command of the block specified by the key parameter.
.IP \(bu 2
\fBsetting\fP (\fI\%str\fP) \-\- The command value for the command specified by the value parameter.
.IP \(bu 2
\fBconf_file\fP (\fI\%str\fP) \-\- The logrotate configuration file.
.UNINDENT
.TP
.B Returns
A boolean representing whether all changes succeeded.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq logrotate.set rotate 2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Can also be used to set a single value inside a multiline configuration
block. For instance, to change rotate in the following block:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/var/log/wtmp {
    monthly
    create 0664 root root
    rotate 1
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Use the following command:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq logrotate.set /var/log/wtmp rotate 2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This module also has the ability to scan files inside an include directory,
and make changes in the appropriate file.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.logrotate.show_conf(conf_file=\(aq/etc/logrotate.conf\(aq)
Show parsed configuration
.INDENT 7.0
.TP
.B Parameters
\fBconf_file\fP (\fI\%str\fP) \-\- The logrotate configuration file.
.TP
.B Returns
The parsed configuration.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq logrotate.show_conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.lvs
.sp
Support for LVS (Linux Virtual Server)
.INDENT 0.0
.TP
.B salt.modules.lvs.add_server(protocol=None, service_address=None, server_address=None, packet_forward_method=\(aqdr\(aq, weight=1, **kwargs)
Add a real server to a virtual service.
.INDENT 7.0
.TP
.B protocol
The service protocol(only support \fBtcp\fP, \fBudp\fP and \fBfwmark\fP service).
.TP
.B service_address
The LVS service address.
.TP
.B server_address
The real server address.
.TP
.B packet_forward_method
The LVS packet forwarding method(\fBdr\fP for direct routing, \fBtunnel\fP for tunneling, \fBnat\fP for network access translation).
.TP
.B weight
The capacity  of a server relative to the others in the pool.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvs.add_server tcp 1.1.1.1:80 192.168.0.11:8080 nat 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lvs.add_service(protocol=None, service_address=None, scheduler=\(aqwlc\(aq)
Add a virtual service.
.INDENT 7.0
.TP
.B protocol
The service protocol(only support tcp, udp and fwmark service).
.TP
.B service_address
The LVS service address.
.TP
.B scheduler
Algorithm for allocating TCP connections and UDP datagrams to real servers.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvs.add_service tcp 1.1.1.1:80 rr
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lvs.check_server(protocol=None, service_address=None, server_address=None, **kwargs)
Check the real server exists in the specified service.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvs.check_server tcp 1.1.1.1:80 192.168.0.11:8080
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lvs.check_service(protocol=None, service_address=None, **kwargs)
Check the virtual service exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvs.check_service tcp 1.1.1.1:80
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lvs.clear()
Clear the virtual server table
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvs.clear
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lvs.delete_server(protocol=None, service_address=None, server_address=None)
Delete the realserver from the virtual service.
.INDENT 7.0
.TP
.B protocol
The service protocol(only support \fBtcp\fP, \fBudp\fP and \fBfwmark\fP service).
.TP
.B service_address
The LVS service address.
.TP
.B server_address
The real server address.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvs.delete_server tcp 1.1.1.1:80 192.168.0.11:8080
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lvs.delete_service(protocol=None, service_address=None)
Delete the virtual service.
.INDENT 7.0
.TP
.B protocol
The service protocol(only support tcp, udp and fwmark service).
.TP
.B service_address
The LVS service address.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvs.delete_service tcp 1.1.1.1:80
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lvs.edit_server(protocol=None, service_address=None, server_address=None, packet_forward_method=None, weight=None, **kwargs)
Edit a real server to a virtual service.
.INDENT 7.0
.TP
.B protocol
The service protocol(only support \fBtcp\fP, \fBudp\fP and \fBfwmark\fP service).
.TP
.B service_address
The LVS service address.
.TP
.B server_address
The real server address.
.TP
.B packet_forward_method
The LVS packet forwarding method(\fBdr\fP for direct routing, \fBtunnel\fP for tunneling, \fBnat\fP for network access translation).
.TP
.B weight
The capacity  of a server relative to the others in the pool.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvs.edit_server tcp 1.1.1.1:80 192.168.0.11:8080 nat 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lvs.edit_service(protocol=None, service_address=None, scheduler=None)
Edit the virtual service.
.INDENT 7.0
.TP
.B protocol
The service protocol(only support tcp, udp and fwmark service).
.TP
.B service_address
The LVS service address.
.TP
.B scheduler
Algorithm for allocating TCP connections and UDP datagrams to real servers.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvs.edit_service tcp 1.1.1.1:80 rr
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lvs.get_rules()
Get the virtual server rules
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvs.get_rules
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lvs.list_(protocol=None, service_address=None)
List the virtual server table if service_address is not specified. If a service_address is selected, list this service only.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvs.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lvs.zero(protocol=None, service_address=None)
Zero the packet, byte and rate counters in a service or all services.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lvs.zero
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.lxc
.sp
Control Linux Containers via Salt
.INDENT 0.0
.TP
.B depends
lxc package for distribution
.UNINDENT
.sp
lxc >= 1.0 (even beta alpha) is required
.INDENT 0.0
.TP
.B salt.modules.lxc.add_veth(name, interface_name, bridge=None, path=None)
Add a veth to a container.
Note : this function doesn\(aqt update the container config, just add the interface at runtime
.INDENT 7.0
.TP
.B name
Name of the container
.TP
.B interface_name
Name of the interface in the container
.TP
.B bridge
Name of the bridge to attach the interface to (facultative)
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.add_veth container_name eth1 br1
salt \(aq*\(aq lxc.add_veth container_name eth1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.apply_network_profile(name, network_profile, nic_opts=None, path=None)
New in version 2015.5.0.

.sp
Apply a network profile to a container
.INDENT 7.0
.TP
.B network_profile
profile name or default values (dict)
.TP
.B nic_opts
values to override in defaults (dict)
indexed by nic card names
.TP
.B path
path to the container parent
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq lxc.apply_network_profile web1 centos
salt \(aqminion\(aq lxc.apply_network_profile web1 centos \e
        nic_opts=\(dq{\(aqeth0\(aq: {\(aqmac\(aq: \(aqxx:xx:xx:xx:xx:xx\(aq}}\(dq
salt \(aqminion\(aq lxc.apply_network_profile web1 \e
        \(dq{\(aqeth0\(aq: {\(aqmac\(aq: \(aqxx:xx:xx:xx:xx:yy\(aq}}\(dq
        nic_opts=\(dq{\(aqeth0\(aq: {\(aqmac\(aq: \(aqxx:xx:xx:xx:xx:xx\(aq}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The special case to disable use of ethernet nics:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq lxc.apply_network_profile web1 centos \e
        \(dq{eth0: {disable: true}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.attachable(name, path=None)
Return True if the named container can be attached to via the lxc\-attach
command
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq lxc.attachable ubuntu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.bootstrap(name, config=None, approve_key=True, install=True, pub_key=None, priv_key=None, bootstrap_url=None, force_install=False, unconditional_install=False, path=None, bootstrap_delay=None, bootstrap_args=None, bootstrap_shell=None)
Install and configure salt in a container.
.INDENT 7.0
.TP
.B config
Minion configuration options. By default, the \fBmaster\fP option is set
to the target host\(aqs master.
.TP
.B approve_key
Request a pre\-approval of the generated minion key. Requires
that the salt\-master be configured to either auto\-accept all keys or
expect a signing request from the target host. Default: \fBTrue\fP
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.TP
.B pub_key
Explicit public key to pressed the minion with (optional).
This can be either a filepath or a string representing the key
.TP
.B priv_key
Explicit private key to pressed the minion with (optional).
This can be either a filepath or a string representing the key
.TP
.B bootstrap_delay
Delay in seconds between end of container creation and bootstrapping.
Useful when waiting for container to obtain a DHCP lease.
.sp
New in version 2015.5.0.

.TP
.B bootstrap_url
url, content or filepath to the salt bootstrap script
.TP
.B bootstrap_args
salt bootstrap script arguments
.TP
.B bootstrap_shell
shell to execute the script into
.TP
.B install
Whether to attempt a full installation of salt\-minion if needed.
.TP
.B force_install
Force installation even if salt\-minion is detected,
this is the way to run vendor bootstrap scripts even
if a salt minion is already present in the container
.TP
.B unconditional_install
Run the script even if the container seems seeded
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq lxc.bootstrap container_name [config=config_data] \e
        [approve_key=(True|False)] [install=(True|False)]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.clone(name, orig, profile=None, network_profile=None, nic_opts=None, **kwargs)
Create a new container as a clone of another container
.INDENT 7.0
.TP
.B name
Name of the container
.TP
.B orig
Name of the original container to be cloned
.TP
.B profile
Profile to use in container cloning (see
\fI\%lxc.get_container_profile\fP). Values in a profile will be
overridden by the \fBContainer Cloning Arguments\fP listed below.
.TP
.B path
path to the container parent directory
default: /var/lib/lxc (system)
.sp
New in version 2015.8.0.

.UNINDENT
.sp
\fBContainer Cloning Arguments\fP
.INDENT 7.0
.TP
.B snapshot
Use Copy On Write snapshots (LVM)
.TP
.B size
1G
Size of the volume to create. Only applicable if \fBbacking=lvm\fP\&.
.TP
.B backing
The type of storage to use. Set to \fBlvm\fP to use an LVM group.
Defaults to filesystem within /var/lib/lxc.
.TP
.B network_profile
Network profile to use for container
.sp
New in version 2015.8.0.

.TP
.B nic_opts
give extra opts overriding network profile values
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.clone myclone orig=orig_container
salt \(aq*\(aq lxc.clone myclone orig=orig_container snapshot=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.cloud_init(name, vm_=None, **kwargs)
Thin wrapper to lxc.init to be used from the saltcloud lxc driver
.INDENT 7.0
.TP
.B name
Name of the container
may be None and then guessed from saltcloud mapping
.TP
.B \fIvm_\fP
saltcloud mapping defaults for the vm
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.cloud_init foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.cloud_init_interface(name, vm_=None, **kwargs)
Interface between salt.cloud.lxc driver and lxc.init
\fBvm_\fP is a mapping of vm opts in the salt.cloud format
as documented for the lxc driver.
.sp
This can be used either:
.INDENT 7.0
.IP \(bu 2
from the salt cloud driver
.IP \(bu 2
because you find the argument to give easier here
than using directly lxc.init
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
BE REALLY CAREFUL CHANGING DEFAULTS !!!
IT\(aqS A RETRO COMPATIBLE INTERFACE WITH
THE SALT CLOUD DRIVER (ask kiorky).
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
name of the lxc container to create
.TP
.B pub_key
public key to preseed the minion with.
Can be the keycontent or a filepath
.TP
.B priv_key
private key to preseed the minion with.
Can be the keycontent or a filepath
.TP
.B path
path to the container parent directory (default: /var/lib/lxc)
.sp
New in version 2015.8.0.

.TP
.B profile
\fI\%profile\fP selection
.TP
.B network_profile
\fI\%network profile\fP selection
.TP
.B nic_opts
per interface settings compatibles with
network profile (ipv4/ipv6/link/gateway/mac/netmask)
.sp
eg:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- {\(aqeth0\(aq: {\(aqmac\(aq: \(aq00:16:3e:01:29:40\(aq,
            \(aqgateway\(aq: None, (default)
            \(aqlink\(aq: \(aqbr0\(aq, (default)
            \(aqgateway\(aq: None, (default)
            \(aqnetmask\(aq: \(aq\(aq, (default)
            \(aqip\(aq: \(aq22.1.4.25\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B unconditional_install
given to lxc.bootstrap (see relative doc)
.TP
.B force_install
given to lxc.bootstrap (see relative doc)
.TP
.B config
any extra argument for the salt minion config
.TP
.B dnsservers
list of DNS servers to set inside the container
.TP
.B dns_via_dhcp
do not set the dns servers, let them be set by the dhcp.
.TP
.B autostart
autostart the container at boot time
.TP
.B password
administrative password for the container
.TP
.B bootstrap_delay
delay before launching bootstrap script at Container init
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Legacy but still supported options:
.INDENT 0.0
.TP
.B from_container
which container we use as a template
when running lxc.clone
.TP
.B image
which template do we use when we
are using lxc.create. This is the default
mode unless you specify something in from_container
.TP
.B backing
which backing store to use.
Values can be: overlayfs, dir(default), lvm, zfs, brtfs
.TP
.B fstype
When using a blockdevice level backing store,
which filesystem to use on
.TP
.B size
When using a blockdevice level backing store,
which size for the filesystem to use on
.TP
.B snapshot
Use snapshot when cloning the container source
.TP
.B vgname
if using LVM: vgname
.TP
.B lvname
if using LVM: lvname
.TP
.B thinpool:
if using LVM: thinpool
.TP
.B ip
ip for the primary nic
.TP
.B mac
mac address for the primary nic
.TP
.B netmask
netmask for the primary nic (24)
= \fBvm_.get(\(aqnetmask\(aq, \(aq24\(aq)\fP
.TP
.B bridge
bridge for the primary nic (lxcbr0)
.TP
.B gateway
network gateway for the container
.TP
.B additional_ips
additional ips which will be wired on the main bridge (br0)
which is connected to internet.
Be aware that you may use manual virtual mac addresses
providen by you provider (online, ovh, etc).
This is a list of mappings {ip: \(aq\(aq, mac: \(aq\(aq, netmask:\(aq\(aq}
Set gateway to None and an interface with a gateway
to escape from another interface that eth0.
eg:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- {\(aqmac\(aq: \(aq00:16:3e:01:29:40\(aq,
   \(aqgateway\(aq: None, (default)
   \(aqlink\(aq: \(aqbr0\(aq, (default)
   \(aqnetmask\(aq: \(aq\(aq, (default)
   \(aqip\(aq: \(aq22.1.4.25\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B users
administrative users for the container
default: [root] and [root, ubuntu] on ubuntu
.TP
.B default_nic
name of the first interface, you should
really not override this
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.cloud_init_interface foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.copy_to(name, source, dest, overwrite=False, makedirs=False, path=None)
Changed in version 2015.8.0: Function renamed from \fBlxc.cp\fP to \fBlxc.copy_to\fP for consistency
with other container types. \fBlxc.cp\fP will continue to work, however.
For versions 2015.2.x and earlier, use \fBlxc.cp\fP\&.

.sp
Copy a file or directory from the host into a container
.INDENT 7.0
.TP
.B name
Container name
.TP
.B source
File to be copied to the container
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.TP
.B dest
Destination on the container. Must be an absolute path.
.sp
Changed in version 2015.5.0: If the destination is a directory, the file will be copied into
that directory.

.TP
.B overwrite
False
Unless this option is set to \fBTrue\fP, then if a file exists at the
location specified by the \fBdest\fP argument, an error will be raised.
.sp
New in version 2015.8.0.

.UNINDENT
.sp
makedirs : False
.INDENT 7.0
.INDENT 3.5
Create the parent directory on the container if it does not already
exist.
.sp
New in version 2015.5.0.

.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq lxc.copy_to /tmp/foo /root/foo
salt \(aqminion\(aq lxc.cp /tmp/foo /root/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.cp(name, source, dest, overwrite=False, makedirs=False, path=None)
This function is an alias of \fBcopy_to\fP\&.
.INDENT 7.0
.INDENT 3.5
Changed in version 2015.8.0: Function renamed from \fBlxc.cp\fP to \fBlxc.copy_to\fP for consistency
with other container types. \fBlxc.cp\fP will continue to work, however.
For versions 2015.2.x and earlier, use \fBlxc.cp\fP\&.

.sp
Copy a file or directory from the host into a container
.INDENT 0.0
.TP
.B name
Container name
.TP
.B source
File to be copied to the container
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.TP
.B dest
Destination on the container. Must be an absolute path.
.sp
Changed in version 2015.5.0: If the destination is a directory, the file will be copied into
that directory.

.TP
.B overwrite
False
Unless this option is set to \fBTrue\fP, then if a file exists at the
location specified by the \fBdest\fP argument, an error will be raised.
.sp
New in version 2015.8.0.

.UNINDENT
.sp
makedirs : False
.INDENT 0.0
.INDENT 3.5
Create the parent directory on the container if it does not already
exist.
.sp
New in version 2015.5.0.

.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq lxc.copy_to /tmp/foo /root/foo
salt \(aqminion\(aq lxc.cp /tmp/foo /root/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.create(name, config=None, profile=None, network_profile=None, nic_opts=None, **kwargs)
Create a new container.
.INDENT 7.0
.TP
.B name
Name of the container
.TP
.B config
The config file to use for the container. Defaults to system\-wide
config (usually in /etc/lxc/lxc.conf).
.TP
.B profile
Profile to use in container creation (see
\fI\%lxc.get_container_profile\fP). Values in a profile will be
overridden by the \fBContainer Creation Arguments\fP listed below.
.TP
.B network_profile
Network profile to use for container
.sp
New in version 2015.5.0.

.UNINDENT
.sp
\fBContainer Creation Arguments\fP
.INDENT 7.0
.TP
.B template
The template to use. For example, \fBubuntu\fP or \fBfedora\fP\&.
For a full list of available templates, check out
the \fI\%lxc.templates\fP function.
.sp
Conflicts with the \fBimage\fP argument.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fBdownload\fP template requires the following three parameters
to be defined in \fBoptions\fP:
.INDENT 0.0
.IP \(bu 2
\fBdist\fP \- The name of the distribution
.IP \(bu 2
\fBrelease\fP \- Release name/version
.IP \(bu 2
\fBarch\fP \- Architecture of the container
.UNINDENT
.sp
The available images can be listed using the \fI\%lxc.images\fP function.
.UNINDENT
.UNINDENT
.TP
.B options
Template\-specific options to pass to the lxc\-create command. These
correspond to the long options (ones beginning with two dashes) that
the template script accepts. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
options=\(aq{\(dqdist\(dq: \(dqcentos\(dq, \(dqrelease\(dq: \(dq6\(dq, \(dqarch\(dq: \(dqamd64\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For available template options, refer to the lxc template scripts
which are usually located under \fB/usr/share/lxc/templates\fP,
or run \fBlxc\-create \-t <template> \-h\fP\&.
.TP
.B image
A tar archive to use as the rootfs for the container. Conflicts with
the \fBtemplate\fP argument.
.TP
.B backing
The type of storage to use. Set to \fBlvm\fP to use an LVM group.
Defaults to filesystem within /var/lib/lxc.
.TP
.B fstype
Filesystem type to use on LVM logical volume
.TP
.B size
1G
Size of the volume to create. Only applicable if \fBbacking=lvm\fP\&.
.TP
.B vgname
lxc
Name of the LVM volume group in which to create the volume for this
container. Only applicable if \fBbacking=lvm\fP\&.
.TP
.B lvname
Name of the LVM logical volume in which to create the volume for this
container. Only applicable if \fBbacking=lvm\fP\&.
.TP
.B thinpool
Name of a pool volume that will be used for thin\-provisioning this
container. Only applicable if \fBbacking=lvm\fP\&.
.TP
.B nic_opts
give extra opts overriding network profile values
.TP
.B path
parent path for the container creation (default: /var/lib/lxc)
.TP
.B zfsroot
Name of the ZFS root in which to create the volume for this container.
Only applicable if \fBbacking=zfs\fP\&. (default: tank/lxc)
.sp
New in version 2015.8.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.destroy(name, stop=False, path=None)
Destroy the named container.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Destroys all data associated with the container.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
path to the container parent directory (default: /var/lib/lxc)
.sp
New in version 2015.8.0.

.TP
.B stop
False
If \fBTrue\fP, the container will be destroyed even if it is
running/frozen.
.sp
Changed in version 2015.5.0: Default value changed to \fBFalse\fP\&. This more closely matches the
behavior of \fBlxc\-destroy(1)\fP, and also makes it less likely that
an accidental command will destroy a running container that was
being used for important things.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.destroy foo
salt \(aq*\(aq lxc.destroy foo stop=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.edit_conf(conf_file, out_format=\(aqsimple\(aq, read_only=False, lxc_config=None, **kwargs)
Edit an LXC configuration file. If a setting is already present inside the
file, its value will be replaced. If it does not exist, it will be appended
to the end of the file. Comments and blank lines will be kept in\-tact if
they already exist in the file.
.INDENT 7.0
.TP
.B out_format:
Set to simple if you need backward compatibility (multiple items for a
simple key is not supported)
.TP
.B read_only:
return only the edited configuration without applying it
to the underlying lxc configuration file
.TP
.B lxc_config:
List of dict containning lxc configuration items
For network configuration, you also need to add the device it belongs
to, otherwise it will default to eth0.
Also, any change to a network parameter will result in the whole
network reconfiguration to avoid mismatchs, be aware of that !
.UNINDENT
.sp
After the file is edited, its contents will be returned. By default, it
will be returned in \fBsimple\fP format, meaning an unordered dict (which
may not represent the actual file order). Passing in an \fBout_format\fP of
\fBcommented\fP will return a data structure which accurately represents the
order and content of the file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq lxc.edit_conf /etc/lxc/mycontainer.conf \e
    out_format=commented lxc.network.type=veth
salt \(aqminion\(aq lxc.edit_conf /etc/lxc/mycontainer.conf \e
    out_format=commented \e
    lxc_config=\(dq[{\(aqlxc.network.name\(aq: \(aqeth0\(aq, \e
                  \(aqlxc.network.ipv4\(aq: \(aq1.2.3.4\(aq},
                 {\(aqlxc.network.name\(aq: \(aqeth2\(aq, \e
                  \(aqlxc.network.ipv4\(aq: \(aq1.2.3.5\(aq,\e
                  \(aqlxc.network.gateway\(aq: \(aq1.2.3.1\(aq}]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.exists(name, path=None)
Returns whether the named container exists.
.INDENT 7.0
.TP
.B path
path to the container parent directory (default: /var/lib/lxc)
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.exists name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.freeze(name, **kwargs)
Freeze the named container
.INDENT 7.0
.TP
.B path
path to the container parent directory
default: /var/lib/lxc (system)
.sp
New in version 2015.8.0.

.TP
.B start
False
If \fBTrue\fP and the container is stopped, the container will be started
before attempting to freeze.
.sp
New in version 2015.5.0.

.TP
.B use_vt
run the command through VT
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.freeze name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.get_container_profile(name=None, **kwargs)
New in version 2015.5.0.

.sp
Gather a pre\-configured set of container configuration parameters. If no
arguments are passed, an empty profile is returned.
.sp
Profiles can be defined in the minion or master config files, or in pillar
or grains, and are loaded using \fI\%config.get\fP\&. The key under which LXC profiles must be
configured is \fBlxc.container_profile.profile_name\fP\&. An example container
profile would be as follows:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
lxc.container_profile:
  ubuntu:
    template: ubuntu
    backing: lvm
    vgname: lxc
    size: 1G
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Parameters set in a profile can be overridden by passing additional
container creation arguments (such as the ones passed to \fI\%lxc.create\fP) to this function.
.sp
A profile can be defined either as the name of the profile, or a dictionary
of variable names and values. See the \fI\%LXC Tutorial\fP for more information on how to use LXC profiles.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call lxc.get_container_profile centos
salt\-call lxc.get_container_profile ubuntu template=ubuntu backing=overlayfs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.get_network_profile(name=None, **kwargs)
New in version 2015.5.0.

.sp
Gather a pre\-configured set of network configuration parameters. If no
arguments are passed, the following default profile is returned:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqeth0\(aq: {\(aqlink\(aq: \(aqbr0\(aq, \(aqtype\(aq: \(aqveth\(aq, \(aqflags\(aq: \(aqup\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Profiles can be defined in the minion or master config files, or in pillar
or grains, and are loaded using \fI\%config.get\fP\&. The key under which LXC profiles must be
configured is \fBlxc.network_profile\fP\&. An example network profile would be
as follows:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
lxc.network_profile.centos:
  eth0:
    link: br0
    type: veth
    flags: up
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To disable networking entirely:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
lxc.network_profile.centos:
  eth0:
    disable: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Parameters set in a profile can be overridden by passing additional
arguments to this function.
.sp
A profile can be passed either as the name of the profile, or a
dictionary of variable names and values. See the \fI\%LXC Tutorial\fP for more information on how to use network
profiles.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The \fBipv4\fP, \fBipv6\fP, \fBgateway\fP, and \fBlink\fP (bridge) settings in
network profiles will only work if the container doesn\(aqt redefine the
network configuration (for example in
\fB/etc/sysconfig/network\-scripts/ifcfg\-<interface_name>\fP on
RHEL/CentOS, or \fB/etc/network/interfaces\fP on Debian/Ubuntu/etc.)
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call lxc.get_network_profile default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.get_parameter(name, parameter, path=None)
Returns the value of a cgroup parameter for a container
.INDENT 7.0
.TP
.B path
path to the container parent directory
default: /var/lib/lxc (system)
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.get_parameter container_name memory.limit_in_bytes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.get_pid(name, path=None)
Returns a container pid.
Throw an exception if the container isn\(aqt running.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.get_pid name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.get_root_path(path)
Get the configured lxc root for containers
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.get_root_path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.images(dist=None)
New in version 2015.5.0.

.sp
List the available images for LXC\(aqs \fBdownload\fP template.
.INDENT 7.0
.TP
.B dist
None
Filter results to a single Linux distribution
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.images
salt myminion lxc.images dist=centos
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.info(name, path=None)
Returns information about a container
.INDENT 7.0
.TP
.B path
path to the container parent directory
default: /var/lib/lxc (system)
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.info name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.init(name, config=None, cpuset=None, cpushare=None, memory=None, profile=None, network_profile=None, nic_opts=None, cpu=None, autostart=True, password=None, password_encrypted=None, users=None, dnsservers=None, searchdomains=None, bridge=None, gateway=None, pub_key=None, priv_key=None, force_install=False, unconditional_install=False, bootstrap_delay=None, bootstrap_args=None, bootstrap_shell=None, bootstrap_url=None, **kwargs)
Initialize a new container.
.sp
This is a partial idempotent function as if it is already provisioned, we
will reset a bit the lxc configuration file but much of the hard work will
be escaped as markers will prevent re\-execution of harmful tasks.
.INDENT 7.0
.TP
.B name
Name of the container
.TP
.B image
A tar archive to use as the rootfs for the container. Conflicts with
the \fBtemplate\fP argument.
.TP
.B cpus
Select a random number of cpu cores and assign it to the cpuset, if the
cpuset option is set then this option will be ignored
.TP
.B cpuset
Explicitly define the cpus this container will be bound to
.TP
.B cpushare
cgroups cpu shares
.TP
.B autostart
autostart container on reboot
.TP
.B memory
cgroups memory limit, in MB
.sp
Changed in version 2015.5.0: If no value is passed, no limit is set. In earlier Salt versions,
not passing this value causes a 1024MB memory limit to be set, and
it was necessary to pass \fBmemory=0\fP to set no limit.

.TP
.B gateway
the ipv4 gateway to use
the default does nothing more than lxcutils does
.TP
.B bridge
the bridge to use
the default does nothing more than lxcutils does
.TP
.B network_profile
Network profile to use for the container
.sp
New in version 2015.5.0.

.TP
.B nic_opts
Extra options for network interfaces, will override
.sp
\fB{\(dqeth0\(dq: {\(dqhwaddr\(dq: \(dqaa:bb:cc:dd:ee:ff\(dq, \(dqipv4\(dq: \(dq10.1.1.1\(dq, \(dqipv6\(dq: \(dq2001:db8::ff00:42:8329\(dq}}\fP
.sp
or
.sp
\fB{\(dqeth0\(dq: {\(dqhwaddr\(dq: \(dqaa:bb:cc:dd:ee:ff\(dq, \(dqipv4\(dq: \(dq10.1.1.1/24\(dq, \(dqipv6\(dq: \(dq2001:db8::ff00:42:8329\(dq}}\fP
.TP
.B users
Users for which the password defined in the \fBpassword\fP param should
be set. Can be passed as a comma separated list or a python list.
Defaults to just the \fBroot\fP user.
.TP
.B password
Set the initial password for the users defined in the \fBusers\fP
parameter
.TP
.B password_encrypted
False
Set to \fBTrue\fP to denote a password hash instead of a plaintext
password
.sp
New in version 2015.5.0.

.TP
.B profile
A LXC profile (defined in config or pillar).
This can be either a real profile mapping or a string
to retrieve it in configuration
.TP
.B start
Start the newly\-created container
.TP
.B dnsservers
list of dns servers to set in the container, default [] (no setting)
.TP
.B seed
Seed the container with the minion config. Default: \fBTrue\fP
.TP
.B install
If salt\-minion is not already installed, install it. Default: \fBTrue\fP
.TP
.B config
Optional config parameters. By default, the id is set to
the name of the container.
.TP
.B master
salt master (default to minion\(aqs master)
.TP
.B master_port
salt master port (default to minion\(aqs master port)
.TP
.B pub_key
Explicit public key to preseed the minion with (optional).
This can be either a filepath or a string representing the key
.TP
.B priv_key
Explicit private key to preseed the minion with (optional).
This can be either a filepath or a string representing the key
.TP
.B approve_key
If explicit preseeding is not used;
Attempt to request key approval from the master. Default: \fBTrue\fP
.TP
.B path
path to the container parent directory
default: /var/lib/lxc (system)
.sp
New in version 2015.8.0.

.TP
.B clone_from
Original from which to use a clone operation to create the container.
Default: \fBNone\fP
.TP
.B bootstrap_delay
Delay in seconds between end of container creation and bootstrapping.
Useful when waiting for container to obtain a DHCP lease.
.sp
New in version 2015.5.0.

.TP
.B bootstrap_url
See lxc.bootstrap
.TP
.B bootstrap_shell
See lxc.bootstrap
.TP
.B bootstrap_args
See lxc.bootstrap
.TP
.B force_install
Force installation even if salt\-minion is detected,
this is the way to run vendor bootstrap scripts even
if a salt minion is already present in the container
.TP
.B unconditional_install
Run the script even if the container seems seeded
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq lxc.init name [cpuset=cgroups_cpuset] \e
        [cpushare=cgroups_cpushare] [memory=cgroups_memory] \e
        [nic=nic_profile] [profile=lxc_profile] \e
        [nic_opts=nic_opts] [start=(True|False)] \e
        [seed=(True|False)] [install=(True|False)] \e
        [config=minion_config] [approve_key=(True|False) \e
        [clone_from=original] [autostart=True] \e
        [priv_key=/path_or_content] [pub_key=/path_or_content] \e
        [bridge=lxcbr0] [gateway=10.0.3.1] \e
        [dnsservers[dns1,dns2]] \e
        [users=[foo]] [password=\(aqsecret\(aq] \e
        [password_encrypted=(True|False)]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.list_(extra=False, limit=None, path=None)
List containers classified by state
.INDENT 7.0
.TP
.B extra
Also get per\-container specific info. This will change the return data.
Instead of returning a list of containers, a dictionary of containers
and each container\(aqs output from \fI\%lxc.info\fP\&.
.TP
.B path
path to the container parent directory
default: /var/lib/lxc (system)
.sp
New in version 2015.8.0.

.TP
.B limit
Return output matching a specific state (\fBfrozen\fP, \fBrunning\fP, or
\fBstopped\fP).
.sp
New in version 2015.5.0.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.list
salt \(aq*\(aq lxc.list extra=True
salt \(aq*\(aq lxc.list limit=running
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.ls_(active=None, cache=True, path=None)
Return a list of the containers available on the minion
.INDENT 7.0
.TP
.B path
path to the container parent directory
default: /var/lib/lxc (system)
.sp
New in version 2015.8.0.

.TP
.B active
If \fBTrue\fP, return only active (i.e. running) containers
.sp
New in version 2015.5.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.ls
salt \(aq*\(aq lxc.ls active=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.read_conf(conf_file, out_format=\(aqsimple\(aq)
Read in an LXC configuration file. By default returns a simple, unsorted
dict, but can also return a more detailed structure including blank lines
and comments.
.INDENT 7.0
.TP
.B out_format:
set to \(aqsimple\(aq if you need the old and unsupported behavior.
This won\(aqt support the multiple lxc values (eg: multiple network nics)
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq lxc.read_conf /etc/lxc/mycontainer.conf
salt \(aqminion\(aq lxc.read_conf /etc/lxc/mycontainer.conf out_format=commented
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.reboot(name, path=None)
Reboot a container.
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq lxc.reboot myvm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.reconfigure(name, cpu=None, cpuset=None, cpushare=None, memory=None, profile=None, network_profile=None, nic_opts=None, bridge=None, gateway=None, autostart=None, utsname=None, rootfs=None, path=None, **kwargs)
Reconfigure a container.
.sp
This only applies to a few property
.INDENT 7.0
.TP
.B name
Name of the container.
.TP
.B utsname
utsname of the container.
.sp
New in version 2016.3.0.

.TP
.B rootfs
rootfs of the container.
.sp
New in version 2016.3.0.

.TP
.B cpu
Select a random number of cpu cores and assign it to the cpuset, if the
cpuset option is set then this option will be ignored
.TP
.B cpuset
Explicitly define the cpus this container will be bound to
.TP
.B cpushare
cgroups cpu shares.
.TP
.B autostart
autostart container on reboot
.TP
.B memory
cgroups memory limit, in MB.
(0 for nolimit, None for old default 1024MB)
.TP
.B gateway
the ipv4 gateway to use
the default does nothing more than lxcutils does
.TP
.B bridge
the bridge to use
the default does nothing more than lxcutils does
.TP
.B nic
Network interfaces profile (defined in config or pillar).
.TP
.B nic_opts
Extra options for network interfaces, will override
.sp
\fB{\(dqeth0\(dq: {\(dqmac\(dq: \(dqaa:bb:cc:dd:ee:ff\(dq, \(dqipv4\(dq: \(dq10.1.1.1\(dq, \(dqipv6\(dq: \(dq2001:db8::ff00:42:8329\(dq}}\fP
.sp
or
.sp
\fB{\(dqeth0\(dq: {\(dqmac\(dq: \(dqaa:bb:cc:dd:ee:ff\(dq, \(dqipv4\(dq: \(dq10.1.1.1/24\(dq, \(dqipv6\(dq: \(dq2001:db8::ff00:42:8329\(dq}}\fP
.TP
.B path
path to the container parent
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-lall mc_lxc_fork.reconfigure foobar nic_opts=\(dq{\(aqeth1\(aq: {\(aqmac\(aq: \(aq00:16:3e:dd:ee:44\(aq}}\(dq memory=4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.remove(name, stop=False, path=None)
This function is an alias of \fBdestroy\fP\&.
.INDENT 7.0
.INDENT 3.5
Destroy the named container.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Destroys all data associated with the container.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B path
path to the container parent directory (default: /var/lib/lxc)
.sp
New in version 2015.8.0.

.TP
.B stop
False
If \fBTrue\fP, the container will be destroyed even if it is
running/frozen.
.sp
Changed in version 2015.5.0: Default value changed to \fBFalse\fP\&. This more closely matches the
behavior of \fBlxc\-destroy(1)\fP, and also makes it less likely that
an accidental command will destroy a running container that was
being used for important things.

.UNINDENT
.sp
CLI Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.destroy foo
salt \(aq*\(aq lxc.destroy foo stop=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.restart(name, path=None, lxc_config=None, force=False)
New in version 2015.5.0.

.sp
Restart the named container. If the container was not running, the
container will merely be started.
.INDENT 7.0
.TP
.B name
The name of the container
.TP
.B path
path to the container parent directory
default: /var/lib/lxc (system)
.sp
New in version 2015.8.0.

.TP
.B lxc_config
path to a lxc config file
config file will be guessed from container name otherwise
.sp
New in version 2015.8.0.

.TP
.B force
False
If \fBTrue\fP, the container will be force\-stopped instead of gracefully
shut down
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.restart name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.retcode(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, path=None, ignore_retcode=False, chroot_fallback=False, keep_env=\(aqhttp_proxy,https_proxy,no_proxy\(aq)
New in version 2015.5.0.

.sp
Run \fI\%cmd.retcode\fP within a container
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Many shell builtins do not work, failing with stderr similar to the
following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lxc_container: No such file or directory \- failed to exec \(aqcommand\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The same error will be displayed in stderr if the command being run
does not exist. If the retcode is nonzero and not what was expected,
try using \fI\%lxc.run_stderr\fP
or \fI\%lxc.run_all\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Name of the container in which to run the command
.TP
.B cmd
Command to run
.TP
.B no_start
False
If the container is not running, don\(aqt start it
.TP
.B preserve_state
True
After running the command, return the container to its previous state
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.TP
.B stdin
None
Standard input to be used for the command
.TP
.B output_loglevel
debug
Level at which to log the output from the command. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console
\fBoutput=all\fP\&.
.TP
.B keep_env
http_proxy,https_proxy,no_proxy
A list of env vars to preserve. May be passed as commma\-delimited list.
.TP
.B chroot_fallback
if the container is not running, try to run the command using chroot
default: false
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.retcode mycontainer \(aqip addr show\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.run(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, path=None, ignore_retcode=False, chroot_fallback=False, keep_env=\(aqhttp_proxy,https_proxy,no_proxy\(aq)
New in version 2015.8.0.

.sp
Run \fI\%cmd.run\fP within a container
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Many shell builtins do not work, failing with stderr similar to the
following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lxc_container: No such file or directory \- failed to exec \(aqcommand\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The same error will be displayed in stderr if the command being run
does not exist. If no output is returned using this function, try using
\fI\%lxc.run_stderr\fP or
\fI\%lxc.run_all\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Name of the container in which to run the command
.TP
.B cmd
Command to run
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.TP
.B no_start
False
If the container is not running, don\(aqt start it
.TP
.B preserve_state
True
After running the command, return the container to its previous state
.TP
.B stdin
None
Standard input to be used for the command
.TP
.B output_loglevel
debug
Level at which to log the output from the command. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console. Assumes
\fBoutput=all\fP\&.
.TP
.B chroot_fallback
if the container is not running, try to run the command using chroot
default: false
.TP
.B keep_env
http_proxy,https_proxy,no_proxy
A list of env vars to preserve. May be passed as commma\-delimited list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.run mycontainer \(aqip addr show\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.run_all(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, path=None, ignore_retcode=False, chroot_fallback=False, keep_env=\(aqhttp_proxy,https_proxy,no_proxy\(aq)
New in version 2015.5.0.

.sp
Run \fI\%cmd.run_all\fP within a container
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
While the command is run within the container, it is initiated from the
host. Therefore, the PID in the return dict is from the host, not from
the container.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Many shell builtins do not work, failing with stderr similar to the
following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lxc_container: No such file or directory \- failed to exec \(aqcommand\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The same error will be displayed in stderr if the command being run
does not exist.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Name of the container in which to run the command
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.TP
.B cmd
Command to run
.TP
.B no_start
False
If the container is not running, don\(aqt start it
.TP
.B preserve_state
True
After running the command, return the container to its previous state
.TP
.B stdin
None
Standard input to be used for the command
.TP
.B output_loglevel
debug
Level at which to log the output from the command. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console
\fBoutput=all\fP\&.
.TP
.B keep_env
http_proxy,https_proxy,no_proxy
A list of env vars to preserve. May be passed as commma\-delimited list.
.TP
.B chroot_fallback
if the container is not running, try to run the command using chroot
default: false
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.run_all mycontainer \(aqip addr show\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.run_stderr(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, path=None, ignore_retcode=False, chroot_fallback=False, keep_env=\(aqhttp_proxy,https_proxy,no_proxy\(aq)
New in version 2015.5.0.

.sp
Run \fI\%cmd.run_stderr\fP within a container
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Many shell builtins do not work, failing with stderr similar to the
following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lxc_container: No such file or directory \- failed to exec \(aqcommand\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The same error will be displayed if the command being run does not
exist.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Name of the container in which to run the command
.TP
.B cmd
Command to run
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.TP
.B no_start
False
If the container is not running, don\(aqt start it
.TP
.B preserve_state
True
After running the command, return the container to its previous state
.TP
.B stdin
None
Standard input to be used for the command
.TP
.B output_loglevel
debug
Level at which to log the output from the command. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console
\fBoutput=all\fP\&.
.TP
.B keep_env
http_proxy,https_proxy,no_proxy
A list of env vars to preserve. May be passed as commma\-delimited list.
.TP
.B chroot_fallback
if the container is not running, try to run the command using chroot
default: false
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.run_stderr mycontainer \(aqip addr show\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.run_stdout(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, path=None, ignore_retcode=False, chroot_fallback=False, keep_env=\(aqhttp_proxy,https_proxy,no_proxy\(aq)
New in version 2015.5.0.

.sp
Run \fI\%cmd.run_stdout\fP within a container
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Many shell builtins do not work, failing with stderr similar to the
following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lxc_container: No such file or directory \- failed to exec \(aqcommand\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The same error will be displayed in stderr if the command being run
does not exist. If no output is returned using this function, try using
\fI\%lxc.run_stderr\fP or
\fI\%lxc.run_all\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Name of the container in which to run the command
.TP
.B cmd
Command to run
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.TP
.B no_start
False
If the container is not running, don\(aqt start it
.TP
.B preserve_state
True
After running the command, return the container to its previous state
.TP
.B stdin
None
Standard input to be used for the command
.TP
.B output_loglevel
debug
Level at which to log the output from the command. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console
\fBoutput=all\fP\&.
.TP
.B keep_env
http_proxy,https_proxy,no_proxy
A list of env vars to preserve. May be passed as commma\-delimited list.
.TP
.B chroot_fallback
if the container is not running, try to run the command using chroot
default: false
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.run_stdout mycontainer \(aqip addr show\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.running_systemd(name, cache=True, path=None)
Determine if systemD is running
.INDENT 7.0
.TP
.B path
path to the container parent
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.running_systemd ubuntu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.search_lxc_bridge()
Search the first bridge which is potentially available as LXC bridge
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.search_lxc_bridge
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.search_lxc_bridges()
Search which bridges are potentially available as LXC bridges
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.search_lxc_bridges
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.set_dns(name, dnsservers=None, searchdomains=None, path=None)
Changed in version 2015.5.0: The \fBdnsservers\fP and \fBsearchdomains\fP parameters can now be passed
as a comma\-separated list.

.sp
Update /etc/resolv.confo
.sp
path
.INDENT 7.0
.INDENT 3.5
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.set_dns ubuntu \(dq[\(aq8.8.8.8\(aq, \(aq4.4.4.4\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.set_parameter(name, parameter, value, path=None)
Set the value of a cgroup parameter for a container.
.INDENT 7.0
.TP
.B path
path to the container parent directory
default: /var/lib/lxc (system)
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.set_parameter name parameter value
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.set_pass(name, users, password, encrypted=True, path=None)
This function is an alias of \fBset_password\fP\&.
.INDENT 7.0
.INDENT 3.5
Changed in version 2015.5.0: Function renamed from \fBset_pass\fP to \fBset_password\fP\&. Additionally,
this function now supports (and defaults to using) a password hash
instead of a plaintext password.

.sp
Set the password of one or more system users inside containers
.INDENT 0.0
.TP
.B users
Comma\-separated list (or python list) of users to change password
.TP
.B password
Password to set for the specified user(s)
.TP
.B encrypted
True
If true, \fBpassword\fP must be a password hash. Set to \fBFalse\fP to set
a plaintext password (not recommended).
.sp
New in version 2015.5.0.

.TP
.B path
path to the container parent directory
default: /var/lib/lxc (system)
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.set_pass container\-name root \(aq$6$uJ2uAyLU$KoI67t8As/0fXtJOPcHKGXmUpcoYUcVR2K6x93walnShTCQvjRwq25yIkiCBOqgbfdKQSFnAo28/ek6716vEV1\(aq
salt \(aq*\(aq lxc.set_pass container\-name root foo encrypted=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.set_password(name, users, password, encrypted=True, path=None)
Changed in version 2015.5.0: Function renamed from \fBset_pass\fP to \fBset_password\fP\&. Additionally,
this function now supports (and defaults to using) a password hash
instead of a plaintext password.

.sp
Set the password of one or more system users inside containers
.INDENT 7.0
.TP
.B users
Comma\-separated list (or python list) of users to change password
.TP
.B password
Password to set for the specified user(s)
.TP
.B encrypted
True
If true, \fBpassword\fP must be a password hash. Set to \fBFalse\fP to set
a plaintext password (not recommended).
.sp
New in version 2015.5.0.

.TP
.B path
path to the container parent directory
default: /var/lib/lxc (system)
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.set_pass container\-name root \(aq$6$uJ2uAyLU$KoI67t8As/0fXtJOPcHKGXmUpcoYUcVR2K6x93walnShTCQvjRwq25yIkiCBOqgbfdKQSFnAo28/ek6716vEV1\(aq
salt \(aq*\(aq lxc.set_pass container\-name root foo encrypted=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.start(name, **kwargs)
Start the named container
.INDENT 7.0
.TP
.B path
path to the container parent directory
default: /var/lib/lxc (system)
.sp
New in version 2015.8.0.

.TP
.B lxc_config
path to a lxc config file
config file will be guessed from container name otherwise
.sp
New in version 2015.8.0.

.TP
.B use_vt
run the command through VT
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.start name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.state(name, path=None)
Returns the state of a container.
.INDENT 7.0
.TP
.B path
path to the container parent directory (default: /var/lib/lxc)
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.state name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.stop(name, kill=False, path=None, use_vt=None)
Stop the named container
.INDENT 7.0
.TP
.B path
path to the container parent directory
default: /var/lib/lxc (system)
.sp
New in version 2015.8.0.

.TP
.B kill: False
Do not wait for the container to stop, kill all tasks in the container.
Older LXC versions will stop containers like this irrespective of this
argument.
.sp
Changed in version 2015.5.0: Default value changed to \fBFalse\fP

.TP
.B use_vt
run the command through VT
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.stop name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.systemd_running_state(name, path=None)
Get the operational state of a systemd based container
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.systemd_running_state ubuntu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.templates()
New in version 2015.5.0.

.sp
List the available LXC template scripts installed on the minion
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.templates
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.test_bare_started_state(name, path=None)
Test if a non systemd container is fully started
For now, it consists only to test if the container is attachable
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.test_bare_started_state ubuntu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.test_sd_started_state(name, path=None)
Test if a systemd container is fully started
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.test_sd_started_state ubuntu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.unfreeze(name, path=None, use_vt=None)
Unfreeze the named container.
.INDENT 7.0
.TP
.B path
path to the container parent directory
default: /var/lib/lxc (system)
.sp
New in version 2015.8.0.

.TP
.B use_vt
run the command through VT
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.unfreeze name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.update_lxc_conf(name, lxc_conf, lxc_conf_unset, path=None)
Edit LXC configuration options
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.update_lxc_conf ubuntu \e
        lxc_conf=\(dq[{\(aqnetwork.ipv4.ip\(aq:\(aq10.0.3.5\(aq}]\(dq \e
        lxc_conf_unset=\(dq[\(aqlxc.utsname\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.version()
Return the actual lxc client version
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxc.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.wait_started(name, path=None, timeout=300)
Check that the system has fully inited
.sp
This is actually very important for systemD based containers
.sp
see \fI\%https://github.com/saltstack/salt/issues/23847\fP
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion lxc.wait_started ubuntu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxc.write_conf(conf_file, conf)
Write out an LXC configuration file
.sp
This is normally only used internally. The format of the data structure
must match that which is returned from \fBlxc.read_conf()\fP, with
\fBout_format\fP set to \fBcommented\fP\&.
.sp
An example might look like:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
    {\(aqlxc.utsname\(aq: \(aq$CONTAINER_NAME\(aq},
    \(aq# This is a commented line\en\(aq,
    \(aq\en\(aq,
    {\(aqlxc.mount\(aq: \(aq$CONTAINER_FSTAB\(aq},
    {\(aqlxc.rootfs\(aq: {\(aqcomment\(aq: \(aqThis is another test\(aq,
                    \(aqvalue\(aq: \(aqThis is another test\(aq}},
    \(aq\en\(aq,
    {\(aqlxc.network.type\(aq: \(aqveth\(aq},
    {\(aqlxc.network.flags\(aq: \(aqup\(aq},
    {\(aqlxc.network.link\(aq: \(aqbr0\(aq},
    {\(aqlxc.network.mac\(aq: \(aq$CONTAINER_MACADDR\(aq},
    {\(aqlxc.network.ipv4\(aq: \(aq$CONTAINER_IPADDR\(aq},
    {\(aqlxc.network.name\(aq: \(aq$CONTAINER_DEVICENAME\(aq},
]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq lxc.write_conf /etc/lxc/mycontainer.conf \e
    out_format=commented
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.lxd
.sp
Module for managing the LXD daemon and its containers.
.sp
New in version 2019.2.0.

.sp
\fI\%LXD(1)\fP is a container \(dqhypervisor\(dq. This execution module provides
several functions to help manage it and its containers.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fI\%pylxd(2)\fP version >=2.2.5 is required to let this work,
currently only available via pip.
.INDENT 2.0
.INDENT 3.5
To install on Ubuntu:
.sp
$ apt\-get install libssl\-dev python\-pip
$ pip install \-U pylxd
.UNINDENT
.UNINDENT
.IP \(bu 2
you need lxd installed on the minion
for the init() and version() methods.
.IP \(bu 2
for the config_get() and config_get() methods
you need to have lxd\-client installed.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B maintainer
René Jochum <\fI\%rene@jochums.at\fP>
.TP
.B maturity
new
.TP
.B depends
python\-pylxd
.TP
.B platform
Linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.authenticate(remote_addr, password, cert, key, verify_cert=True)
Authenticate with a remote LXDaemon.
.INDENT 7.0
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if you
provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
.UNINDENT
.TP
.B password :
The password of the remote.
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.authenticate https://srv01:8443 <yourpass> ~/.config/lxc/client.crt ~/.config/lxc/client.key false
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See the \fI\%requests\-docs\fP for the SSL stuff.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.config_get(key)
Get an LXD daemon config option
.INDENT 7.0
.TP
.B key :
The key of the config value to retrieve
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.config_get core.https_address
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.config_set(key, value)
Set an LXD daemon config option
.sp
CLI Examples:
.sp
To listen on IPv4 and IPv6 port 8443,
you can omit the :8443 its the default:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.config_set core.https_address [::]:8443
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To set the server trust password:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.config_set core.trust_password blah
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_config_delete(name, config_key, remote_addr=None, cert=None, key=None, verify_cert=True)
Delete a container config value
.INDENT 7.0
.TP
.B name :
Name of the container
.TP
.B config_key :
The config key to delete
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_config_get(name, config_key, remote_addr=None, cert=None, key=None, verify_cert=True)
Get a container config value
.INDENT 7.0
.TP
.B name :
Name of the container
.TP
.B config_key :
The config key to retrieve
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_config_set(name, config_key, config_value, remote_addr=None, cert=None, key=None, verify_cert=True)
Set a container config value
.INDENT 7.0
.TP
.B name :
Name of the container
.TP
.B config_key :
The config key to set
.TP
.B config_value :
The config value to set
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_create(name, source, profiles=None, config=None, devices=None, architecture=\(aqx86_64\(aq, ephemeral=False, wait=True, remote_addr=None, cert=None, key=None, verify_cert=True, _raw=False)
Create a container
.INDENT 7.0
.TP
.B name :
The name of the container
.TP
.B source :
.INDENT 7.0
.TP
.B Can be either a string containing an image alias:
\(dqxenial/amd64\(dq
.TP
.B or an dict with type \(dqimage\(dq with alias:
.INDENT 7.0
.TP
.B {\(dqtype\(dq: \(dqimage\(dq,
\(dqalias\(dq: \(dqxenial/amd64\(dq}
.UNINDENT
.TP
.B or image with \(dqfingerprint\(dq:
.INDENT 7.0
.TP
.B {\(dqtype\(dq: \(dqimage\(dq,
\(dqfingerprint\(dq: \(dqSHA\-256\(dq}
.UNINDENT
.TP
.B or image with \(dqproperties\(dq:
.INDENT 7.0
.TP
.B {\(dqtype\(dq: \(dqimage\(dq,
.INDENT 7.0
.TP
.B \(dqproperties\(dq: {
\(dqos\(dq: \(dqubuntu\(dq,
\(dqrelease\(dq: \(dq14.04\(dq,
\(dqarchitecture\(dq: \(dqx86_64\(dq}}
.UNINDENT
.UNINDENT
.TP
.B or none:
{\(dqtype\(dq: \(dqnone\(dq}
.TP
.B or copy:
.INDENT 7.0
.TP
.B {\(dqtype\(dq: \(dqcopy\(dq,
\(dqsource\(dq: \(dqmy\-old\-container\(dq}
.UNINDENT
.UNINDENT
.TP
.B profiles
[\(aqdefault\(aq]
List of profiles to apply on this container
.TP
.B config :
A config dict or None (None = unset).
.INDENT 7.0
.TP
.B Can also be a list:
.INDENT 7.0
.TP
.B [{\(aqkey\(aq: \(aqboot.autostart\(aq, \(aqvalue\(aq: 1},
{\(aqkey\(aq: \(aqsecurity.privileged\(aq, \(aqvalue\(aq: \(aq1\(aq}]
.UNINDENT
.UNINDENT
.TP
.B devices :
A device dict or None (None = unset).
.TP
.B architecture
\(aqx86_64\(aq.INDENT 7.0
.TP
.B Can be one of the following:
.INDENT 7.0
.IP \(bu 2
unknown
.IP \(bu 2
i686
.IP \(bu 2
x86_64
.IP \(bu 2
armv7l
.IP \(bu 2
aarch64
.IP \(bu 2
ppc
.IP \(bu 2
ppc64
.IP \(bu 2
ppc64le
.IP \(bu 2
s390x
.UNINDENT
.UNINDENT
.TP
.B ephemeral
False
Destroy this container after stop?
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.TP
.B _raw
False
Return the raw pyxld object or a dict?
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.container_create test xenial/amd64
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See also the \fI\%rest\-api\-docs\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_delete(name, remote_addr=None, cert=None, key=None, verify_cert=True)
Delete a container
.INDENT 7.0
.TP
.B name :
Name of the container to delete
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_device_add(name, device_name, device_type=\(aqdisk\(aq, remote_addr=None, cert=None, key=None, verify_cert=True, **kwargs)
Add a container device
.INDENT 7.0
.TP
.B name :
Name of the container
.TP
.B device_name :
The device name to add
.TP
.B device_type :
Type of the device
.TP
.B ** kwargs :
Additional device args
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_device_delete(name, device_name, remote_addr=None, cert=None, key=None, verify_cert=True)
Delete a container device
.INDENT 7.0
.TP
.B name :
Name of the container
.TP
.B device_name :
The device name to delete
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_device_get(name, device_name, remote_addr=None, cert=None, key=None, verify_cert=True)
Get a container device
.INDENT 7.0
.TP
.B name :
Name of the container
.TP
.B device_name :
The device name to retrieve
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_execute(name, cmd, remote_addr=None, cert=None, key=None, verify_cert=True)
Execute a command list on a container.
.INDENT 7.0
.TP
.B name :
Name of the container
.TP
.B cmd :
Command to be executed (as a list)
.INDENT 7.0
.TP
.B Example :
\(aq[\(dqls\(dq, \(dq\-l\(dq]\(aq
.UNINDENT
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.container_execute <container name> \(aq[\(dqls\(dq, \(dq\-l\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_file_get(name, src, dst, overwrite=False, mode=None, uid=None, gid=None, remote_addr=None, cert=None, key=None, verify_cert=True)
Get a file from a container
.INDENT 7.0
.TP
.B name :
Name of the container
.TP
.B src :
The source file or directory
.TP
.B dst :
The destination file or directory
.TP
.B mode :
Set file mode to octal number
.TP
.B uid :
Set file uid (owner)
.TP
.B gid :
Set file gid (group)
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_file_put(name, src, dst, recursive=False, overwrite=False, mode=None, uid=None, gid=None, saltenv=\(aqbase\(aq, remote_addr=None, cert=None, key=None, verify_cert=True)
Put a file into a container
.INDENT 7.0
.TP
.B name :
Name of the container
.TP
.B src :
The source file or directory
.TP
.B dst :
The destination file or directory
.TP
.B recursive :
Decent into src directory
.TP
.B overwrite :
Replace destination if it exists
.TP
.B mode :
Set file mode to octal number
.TP
.B uid :
Set file uid (owner)
.TP
.B gid :
Set file gid (group)
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.container_file_put <container name> /var/tmp/foo /var/tmp/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_freeze(name, remote_addr=None, cert=None, key=None, verify_cert=True)
Freeze a container
.INDENT 7.0
.TP
.B name :
Name of the container to freeze
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_get(name=None, remote_addr=None, cert=None, key=None, verify_cert=True, _raw=False)
Gets a container from the LXD
.INDENT 7.0
.TP
.B name :
The name of the container to get.
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.TP
.B _raw :
Return the pylxd object, this is internal and by states in use.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_list(list_names=False, remote_addr=None, cert=None, key=None, verify_cert=True)
Lists containers
.INDENT 7.0
.TP
.B list_names
False
Only return a list of names when True
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Examples:
.sp
Full dict with all available information:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.container_list
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For a list of names:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.container_list true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See also \fI\%container\-attributes\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_migrate(name, stop_and_start=False, remote_addr=None, cert=None, key=None, verify_cert=True, src_remote_addr=None, src_cert=None, src_key=None, src_verify_cert=None)
Migrate a container.
.sp
If the container is running, it either must be shut down
first (use stop_and_start=True) or criu must be installed
on the source and destination machines.
.sp
For this operation both certs need to be authenticated,
use \fBlxd.authenticate <salt.modules.lxd.authenticate\fP
to authenticate your cert(s).
.INDENT 7.0
.TP
.B name :
Name of the container to migrate
.TP
.B stop_and_start :
Stop the container on the source and start it on dest
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Authorize
salt \(aq*\(aq lxd.authenticate https://srv01:8443 <yourpass> ~/.config/lxc/client.crt ~/.config/lxc/client.key false
salt \(aq*\(aq lxd.authenticate https://srv02:8443 <yourpass> ~/.config/lxc/client.crt ~/.config/lxc/client.key false

# Migrate phpmyadmin from srv01 to srv02
salt \(aq*\(aq lxd.container_migrate phpmyadmin stop_and_start=true remote_addr=https://srv02:8443 cert=~/.config/lxc/client.crt key=~/.config/lxc/client.key verify_cert=False src_remote_addr=https://srv01:8443
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_rename(name, newname, remote_addr=None, cert=None, key=None, verify_cert=True)
Rename a container
.INDENT 7.0
.TP
.B name :
Name of the container to Rename
.TP
.B newname :
The new name of the container
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_restart(name, remote_addr=None, cert=None, key=None, verify_cert=True)
Restart a container
.INDENT 7.0
.TP
.B name :
Name of the container to restart
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_start(name, remote_addr=None, cert=None, key=None, verify_cert=True)
Start a container
.INDENT 7.0
.TP
.B name :
Name of the container to start
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_state(name=None, remote_addr=None, cert=None, key=None, verify_cert=True)
Get container state
.INDENT 7.0
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_stop(name, timeout=30, force=True, remote_addr=None, cert=None, key=None, verify_cert=True)
Stop a container
.INDENT 7.0
.TP
.B name :
Name of the container to stop
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.container_unfreeze(name, remote_addr=None, cert=None, key=None, verify_cert=True)
Unfreeze a container
.INDENT 7.0
.TP
.B name :
Name of the container to unfreeze
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.image_alias_add(image, alias, description=\(aq\(aq, remote_addr=None, cert=None, key=None, verify_cert=True)
Create an alias on the given image
.INDENT 7.0
.TP
.B image :
An image alias, a fingerprint or a image object
.TP
.B alias :
The alias to add
.TP
.B description :
Description of the alias
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.image_alias_add xenial/amd64 x \(dqShort version of xenial/amd64\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.image_alias_delete(image, alias, remote_addr=None, cert=None, key=None, verify_cert=True)
Delete an alias (this is currently not restricted to the image)
.INDENT 7.0
.TP
.B image :
An image alias, a fingerprint or a image object
.TP
.B alias :
The alias to delete
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.image_alias_add xenial/amd64 x \(dqShort version of xenial/amd64\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.image_copy_lxd(source, src_remote_addr, src_cert, src_key, src_verify_cert, remote_addr, cert, key, verify_cert=True, aliases=None, public=None, auto_update=None, _raw=False)
Copy an image from another LXD instance
.INDENT 7.0
.TP
.B source :
An alias or a fingerprint of the source.
.TP
.B src_remote_addr :
An URL to the source remote daemon
.INDENT 7.0
.TP
.B Examples:
\fI\%https://mysourceserver.lan:8443\fP
.UNINDENT
.TP
.B src_cert :
PEM Formatted SSL Certificate for the source
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B src_key :
PEM Formatted SSL Key for the source
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B src_verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.TP
.B remote_addr :
Address of the destination daemon
.INDENT 7.0
.TP
.B Examples:
\fI\%https://mydestserver.lan:8443\fP
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate for the destination
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key for the destination
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.TP
.B aliases
[]
List of aliases to append to the copied image
.TP
.B public
None
Make this image public available, None = copy source
.TP
.B auto_update
None
Wherever to auto\-update from the original source, None = copy source
.TP
.B _raw
False
Return the raw pylxd object or a dict of the destination image?
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.image_copy_lxd xenial/amd64 https://srv01:8443 ~/.config/lxc/client.crt ~/.config/lxc/client.key false https://srv02:8443 ~/.config/lxc/client.crt ~/.config/lxc/client.key false aliases=\(dq[\(aqxenial/amd64\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.image_delete(image, remote_addr=None, cert=None, key=None, verify_cert=True)
Delete an image by an alias or fingerprint
.INDENT 7.0
.TP
.B name :
The alias or fingerprint of the image to delete,
can be a obj for the states.
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.image_delete xenial/amd64
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.image_from_file(filename, remote_addr=None, cert=None, key=None, verify_cert=True, aliases=None, public=False, saltenv=\(aqbase\(aq, _raw=False)
Create an image from a file
.INDENT 7.0
.TP
.B filename :
The filename of the rootfs
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.TP
.B aliases
[]
List of aliases to append to the copied image
.TP
.B public
False
Make this image public available
.TP
.B saltenv
base
The saltenv to use for salt:// copies
.TP
.B _raw
False
Return the raw pylxd object or a dict of the image?
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.image_from_file salt://lxd/files/busybox.tar.xz aliases=[\(dqbusybox\-amd64\(dq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.image_from_simplestreams(server, alias, remote_addr=None, cert=None, key=None, verify_cert=True, aliases=None, public=False, auto_update=False, _raw=False)
Create an image from simplestreams
.INDENT 7.0
.TP
.B server :
Simplestreams server URI
.TP
.B alias :
The alias of the image to retrieve
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.TP
.B aliases
[]
List of aliases to append to the copied image
.TP
.B public
False
Make this image public available
.TP
.B auto_update
False
Should LXD auto update that image?
.TP
.B _raw
False
Return the raw pylxd object or a dict of the image?
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.image_from_simplestreams \(dqhttps://cloud\-images.ubuntu.com/releases\(dq \(dqtrusty/amd64\(dq aliases=\(aq[\(dqt\(dq, \(dqtrusty/amd64\(dq]\(aq auto_update=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.image_from_url(url, remote_addr=None, cert=None, key=None, verify_cert=True, aliases=None, public=False, auto_update=False, _raw=False)
Create an image from an url
.INDENT 7.0
.TP
.B url :
The URL from where to download the image
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.TP
.B aliases
[]
List of aliases to append to the copied image
.TP
.B public
False
Make this image public available
.TP
.B auto_update
False
Should LXD auto update that image?
.TP
.B _raw
False
Return the raw pylxd object or a dict of the image?
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.image_from_url https://dl.stgraber.org/lxd aliases=\(aq[\(dqbusybox\-amd64\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.image_get(fingerprint, remote_addr=None, cert=None, key=None, verify_cert=True, _raw=False)
Get an image by its fingerprint
.INDENT 7.0
.TP
.B fingerprint :
The fingerprint of the image to retrieve
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.TP
.B _raw
False
Return the raw pylxd object or a dict of it?
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.image_get <fingerprint>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.image_get_by_alias(alias, remote_addr=None, cert=None, key=None, verify_cert=True, _raw=False)
Get an image by an alias
.INDENT 7.0
.TP
.B alias :
The alias of the image to retrieve
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.TP
.B _raw
False
Return the raw pylxd object or a dict of it?
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.image_get_by_alias xenial/amd64
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.image_list(list_aliases=False, remote_addr=None, cert=None, key=None, verify_cert=True)
Lists all images from the LXD.
.sp
list_aliases :
.INDENT 7.0
.INDENT 3.5
Return a dict with the fingerprint as key and
a list of aliases as value instead.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.image_list true \-\-out=json
salt \(aq*\(aq lxd.image_list \-\-out=json
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.init(storage_backend=\(aqdir\(aq, trust_password=None, network_address=None, network_port=None, storage_create_device=None, storage_create_loop=None, storage_pool=None)
Calls lxd init \-\-auto \-\- opts
.INDENT 7.0
.TP
.B storage_backend :
Storage backend to use (zfs or dir, default: dir)
.TP
.B trust_password :
Password required to add new clients
.TP
.B network_address
None
Address to bind LXD to (default: none)
.TP
.B network_port
None
Port to bind LXD to (Default: 8443)
.TP
.B storage_create_device
None
Setup device based storage using this DEVICE
.TP
.B storage_create_loop
None
Setup loop based storage with this SIZE in GB
.TP
.B storage_pool
None
Storage pool to use or create
.UNINDENT
.sp
CLI Examples:
.sp
To listen on all IPv4/IPv6 Addresses:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.init dir PaSsW0rD [::]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To not listen on Network:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.init
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.normalize_input_values(config, devices)
normalize config input so returns can be put into mongodb, which doesn\(aqt like \fI\&.\fP
.sp
This is not meant to be used on the commandline.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.normalize_input_values config={} devices={}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.profile_config_delete(name, config_key, remote_addr=None, cert=None, key=None, verify_cert=True)
Delete a profile config item.
.INDENT 7.0
.TP
.B name :
The name of the profile to delete the config item.
.TP
.B config_key :
The config key for the value to retrieve.
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.profile_config_delete autostart boot.autostart.delay
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.profile_config_get(name, config_key, remote_addr=None, cert=None, key=None, verify_cert=True)
Get a profile config item.
.INDENT 7.0
.TP
.B name :
The name of the profile to get the config item from.
.TP
.B config_key :
The key for the item to retrieve.
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.profile_config_get autostart boot.autostart
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.profile_config_set(name, config_key, config_value, remote_addr=None, cert=None, key=None, verify_cert=True)
Set a profile config item.
.INDENT 7.0
.TP
.B name :
The name of the profile to set the config item to.
.TP
.B config_key :
The items key.
.TP
.B config_value :
Its items value.
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.profile_config_set autostart boot.autostart 0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.profile_create(name, config=None, devices=None, description=None, remote_addr=None, cert=None, key=None, verify_cert=True)
Creates a profile.
.INDENT 7.0
.TP
.B name :
The name of the profile to get.
.TP
.B config :
A config dict or None (None = unset).
.INDENT 7.0
.TP
.B Can also be a list:
.INDENT 7.0
.TP
.B [{\(aqkey\(aq: \(aqboot.autostart\(aq, \(aqvalue\(aq: 1},
{\(aqkey\(aq: \(aqsecurity.privileged\(aq, \(aqvalue\(aq: \(aq1\(aq}]
.UNINDENT
.UNINDENT
.TP
.B devices :
A device dict or None (None = unset).
.TP
.B description :
A description string or None (None = unset).
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.profile_create autostart config=\(dq{boot.autostart: 1, boot.autostart.delay: 2, boot.autostart.priority: 1}\(dq
salt \(aq*\(aq lxd.profile_create shared_mounts devices=\(dq{shared_mount: {type: \(aqdisk\(aq, source: \(aq/home/shared\(aq, path: \(aq/home/shared\(aq}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See the \fI\%lxd\-docs\fP for the details about the config and devices dicts.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.profile_delete(name, remote_addr=None, cert=None, key=None, verify_cert=True)
Deletes a profile.
.INDENT 7.0
.TP
.B name :
The name of the profile to delete.
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.profile_delete shared_mounts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.profile_device_delete(name, device_name, remote_addr=None, cert=None, key=None, verify_cert=True)
Delete a profile device.
.INDENT 7.0
.TP
.B name :
The name of the profile to delete the device.
.TP
.B device_name :
The name of the device to delete.
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.profile_device_delete autostart eth1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.profile_device_get(name, device_name, remote_addr=None, cert=None, key=None, verify_cert=True)
Get a profile device.
.INDENT 7.0
.TP
.B name :
The name of the profile to get the device from.
.TP
.B device_name :
The name of the device to retrieve.
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.profile_device_get default eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.profile_device_set(name, device_name, device_type=\(aqdisk\(aq, remote_addr=None, cert=None, key=None, verify_cert=True, **kwargs)
Set a profile device.
.INDENT 7.0
.TP
.B name :
The name of the profile to set the device to.
.TP
.B device_name :
The name of the device to set.
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.profile_device_set autostart eth1 nic nictype=bridged parent=lxdbr0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.profile_get(name, remote_addr=None, cert=None, key=None, verify_cert=True, _raw=False)
Gets a profile from the LXD
.INDENT 7.0
.TP
.B name :
The name of the profile to get.
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.TP
.B _raw :
Return the pylxd object, this is internal and by states in use.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.profile_get autostart
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.profile_list(list_names=False, remote_addr=None, cert=None, key=None, verify_cert=True)
Lists all profiles from the LXD.
.sp
list_names :
.INDENT 7.0
.INDENT 3.5
Return a list of names instead of full blown dicts.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if
you provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.profile_list true \-\-out=json
salt \(aq*\(aq lxd.profile_list \-\-out=json
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.pylxd_client_get(remote_addr=None, cert=None, key=None, verify_cert=True)
Get an pyxld client, this is not meant to be run over the CLI.
.INDENT 7.0
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if you
provide remote_addr and its a TCP Address!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
See the \fI\%requests\-docs\fP for the SSL stuff.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.pylxd_save_object(obj)
.INDENT 7.0
.TP
.B Saves an object (profile/image/container) and
translate its execpetion on failure
.TP
.B obj :
The object to save
.UNINDENT
.sp
This is an internal method, no CLI Example.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.pylxd_version()
Returns the actual pylxd version.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.pylxd_version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.snapshots_all(container, remote_addr=None, cert=None, key=None, verify_cert=True)
Get all snapshots for a container
.INDENT 7.0
.TP
.B container :
The name of the container to get.
.TP
.B remote_addr :
An URL to a remote server. The \(aqcert\(aq and \(aqkey\(aq fields must also be
provided if \(aqremote_addr\(aq is defined.
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Verify the ssl certificate.  Default: True
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.snapshots_all test\-container
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.snapshots_create(container, name=None, remote_addr=None, cert=None, key=None, verify_cert=True)
Create a snapshot for a container
.INDENT 7.0
.TP
.B container :
The name of the container to get.
.TP
.B name :
The name of the snapshot.
.TP
.B remote_addr :
An URL to a remote server. The \(aqcert\(aq and \(aqkey\(aq fields must also be
provided if \(aqremote_addr\(aq is defined.
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Verify the ssl certificate.  Default: True
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.snapshots_create test\-container test\-snapshot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.snapshots_delete(container, name, remote_addr=None, cert=None, key=None, verify_cert=True)
Delete a snapshot for a container
.INDENT 7.0
.TP
.B container :
The name of the container to get.
.TP
.B name :
The name of the snapshot.
.TP
.B remote_addr :
An URL to a remote server. The \(aqcert\(aq and \(aqkey\(aq fields must also be
provided if \(aqremote_addr\(aq is defined.
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Verify the ssl certificate.  Default: True
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.snapshots_delete test\-container test\-snapshot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.snapshots_get(container, name, remote_addr=None, cert=None, key=None, verify_cert=True)
Get information about snapshot for a container
.INDENT 7.0
.TP
.B container :
The name of the container to get.
.TP
.B name :
The name of the snapshot.
.TP
.B remote_addr :
An URL to a remote server. The \(aqcert\(aq and \(aqkey\(aq fields must also be
provided if \(aqremote_addr\(aq is defined.
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Certificate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Verify the ssl certificate.  Default: True
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.snapshots_get test\-container test\-snapshot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.sync_config_devices(obj, newconfig, newdevices, test=False)
Syncs the given config and devices with the object
(a profile or a container)
returns a changes dict with all changes made.
.INDENT 7.0
.TP
.B obj :
The object to sync with / or just test with.
.TP
.B newconfig:
The new config to check with the obj.
.TP
.B newdevices:
The new devices to check with the obj.
.TP
.B test:
Wherever to not change anything and give \(dqWould change\(dq message.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.lxd.version()
Returns the actual lxd version.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lxd.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mac_assistive
.sp
This module allows you to manage assistive access on macOS minions with 10.9+
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq assistive.install /usr/bin/osascript
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.mac_assistive.TccDB(path=None)
.INDENT 7.0
.TP
.B disable(app_id)
.UNINDENT
.INDENT 7.0
.TP
.B enable(app_id)
.UNINDENT
.INDENT 7.0
.TP
.B enabled(app_id)
.UNINDENT
.INDENT 7.0
.TP
.B install(app_id, enable=True)
.UNINDENT
.INDENT 7.0
.TP
.B installed(app_id)
.UNINDENT
.INDENT 7.0
.TP
.B remove(app_id)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_assistive.enable_(app_id, enabled=True)
Enable or disable an existing assistive access application.
.INDENT 7.0
.TP
.B app_id
The bundle ID or command to set assistive access status.
.TP
.B enabled
Sets enabled or disabled status. Default is \fBTrue\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq assistive.enable /usr/bin/osascript
salt \(aq*\(aq assistive.enable com.smileonmymac.textexpander enabled=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_assistive.enabled(app_id)
Check if a bundle ID or command is listed in assistive access and
enabled.
.INDENT 7.0
.TP
.B app_id
The bundle ID or command to retrieve assistive access status.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq assistive.enabled /usr/bin/osascript
salt \(aq*\(aq assistive.enabled com.smileonmymac.textexpander
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_assistive.install(app_id, enable=True, tries=3, wait=10)
Install a bundle ID or command as being allowed to use
assistive access.
.INDENT 7.0
.TP
.B app_id
The bundle ID or command to install for assistive access.
.TP
.B enabled
Sets enabled or disabled status. Default is \fBTrue\fP\&.
.TP
.B tries
How many times to try and write to a read\-only tcc. Default is \fBTrue\fP\&.
.TP
.B wait
Number of seconds to wait between tries. Default is \fB10\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq assistive.install /usr/bin/osascript
salt \(aq*\(aq assistive.install com.smileonmymac.textexpander
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_assistive.installed(app_id)
Check if a bundle ID or command is listed in assistive access.
This will not check to see if it\(aqs enabled.
.INDENT 7.0
.TP
.B app_id
The bundle ID or command to check installed status.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq assistive.installed /usr/bin/osascript
salt \(aq*\(aq assistive.installed com.smileonmymac.textexpander
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_assistive.remove(app_id)
Remove a bundle ID or command as being allowed to use assistive access.
.INDENT 7.0
.TP
.B app_id
The bundle ID or command to remove from assistive access list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq assistive.remove /usr/bin/osascript
salt \(aq*\(aq assistive.remove com.smileonmymac.textexpander
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mac_brew_pkg
.sp
Homebrew for macOS
.sp
It is recommended for the \fBsalt\-minion\fP to have the \fBHOMEBREW_PREFIX\fP
environment variable set.
.sp
This will ensure that Salt uses the correct path for the \fBbrew\fP binary.
.sp
Typically, this is set to \fB/usr/local\fP for Intel Macs and \fB/opt/homebrew\fP
for Apple Silicon Macs.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage packages on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.available_version(*names, **kwargs)
This function is an alias of \fBlatest_version\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the latest version of the named package available for upgrade or
installation
.sp
Currently chooses stable versions, falling back to devel if that does not
exist.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.hold(name=None, pkgs=None, sources=None, **kwargs)
Set package in \(aqhold\(aq state, meaning it will not be upgraded.
.sp
New in version 3001.

.INDENT 7.0
.TP
.B name
The name of the package, e.g., \(aqtmux\(aq
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.hold <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B pkgs
A list of packages to hold. Must be passed as a python list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.hold pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.homebrew_prefix()
Returns the full path to the homebrew prefix.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.homebrew_prefix
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.info_installed(*names, **kwargs)
Return the information of the named package(s) installed on the system.
.sp
New in version 2016.3.1.

.INDENT 7.0
.TP
.B names
The names of the packages for which to return information.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.info_installed <package1>
salt \(aq*\(aq pkg.info_installed <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.install(name=None, pkgs=None, taps=None, options=None, **kwargs)
Install the passed package(s) with \fBbrew install\fP
.INDENT 7.0
.TP
.B name
The name of the formula to be installed. Note that this parameter is
ignored if \(dqpkgs\(dq is passed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B taps
Unofficial GitHub repos to use when updating and installing formulas.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name> tap=\(aq<tap>\(aq
salt \(aq*\(aq pkg.install zlib taps=\(aqhomebrew/dupes\(aq
salt \(aq*\(aq pkg.install php54 taps=\(aq[\(dqjosegonzalez/php\(dq, \(dqhomebrew/dupes\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B options
Options to pass to brew. Only applies to initial install. Due to how brew
works, modifying chosen options requires a full uninstall followed by a
fresh install. Note that if \(dqpkgs\(dq is used, all options will be passed
to all packages. Unrecognized options for a package will be silently
ignored by brew.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name> tap=\(aq<tap>\(aq
salt \(aq*\(aq pkg.install php54 taps=\(aq[\(dqjosegonzalez/php\(dq, \(dqhomebrew/dupes\(dq]\(aq options=\(aq[\(dq\-\-with\-fpm\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Multiple Package Installation Options:
.INDENT 7.0
.TP
.B pkgs
A list of formulas to install. Must be passed as a python list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq,\(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Returns a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install \(aqpackage package package\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.latest_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation
.sp
Currently chooses stable versions, falling back to devel if that does not
exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.list_pkgs(versions_as_list=False, **kwargs)
List the packages currently installed in a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.list_upgrades(refresh=True, include_casks=False, **kwargs)
Check whether or not an upgrade is available for all packages
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.pin(name=None, pkgs=None, sources=None, **kwargs)
Set package in \(aqhold\(aq state, meaning it will not be upgraded.
.sp
New in version 3001.

.INDENT 7.0
.TP
.B name
The name of the package, e.g., \(aqtmux\(aq
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.hold <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B pkgs
A list of packages to hold. Must be passed as a python list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.hold pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.refresh_db(**kwargs)
Update the homebrew package repository.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.remove(name=None, pkgs=None, **kwargs)
Removes packages with \fBbrew uninstall\fP\&.
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.unhold(name=None, pkgs=None, sources=None, **kwargs)
Set package current in \(aqhold\(aq state to install state,
meaning it will be upgraded.
.sp
New in version 3001.

.INDENT 7.0
.TP
.B name
.INDENT 7.0
.INDENT 3.5
The name of the package, e.g., \(aqtmux\(aq
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.unhold <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B pkgs
A list of packages to unhold. Must be passed as a python list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.unhold pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.unpin(name=None, pkgs=None, sources=None, **kwargs)
Set package current in \(aqhold\(aq state to install state,
meaning it will be upgraded.
.sp
New in version 3001.

.INDENT 7.0
.TP
.B name
.INDENT 7.0
.INDENT 3.5
The name of the package, e.g., \(aqtmux\(aq
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.unhold <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B pkgs
A list of packages to unhold. Must be passed as a python list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.unhold pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.upgrade(refresh=True, **kwargs)
Upgrade outdated, unpinned brews.
.INDENT 7.0
.TP
.B refresh
Fetch the newest version of Homebrew and all formulae from GitHub before installing.
.UNINDENT
.sp
Returns a dictionary containing the changes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq:  {\(aqold\(aq: \(aq<old\-version>\(aq,
                \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.upgrade_available(pkg, **kwargs)
Check whether or not an upgrade is available for a given package
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade_available <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_brew_pkg.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mac_desktop
.sp
macOS implementations of various commands in the \(dqdesktop\(dq interface
.INDENT 0.0
.TP
.B salt.modules.mac_desktop.get_output_volume()
Get the output volume (range 0 to 100)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq desktop.get_output_volume
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_desktop.lock()
Lock the desktop session
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq desktop.lock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_desktop.say(*words)
Say some words.
.INDENT 7.0
.TP
.B words
The words to execute the say command with.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq desktop.say <word0> <word1> ... <wordN>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_desktop.screensaver()
Launch the screensaver.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq desktop.screensaver
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_desktop.set_output_volume(volume)
Set the volume of sound.
.INDENT 7.0
.TP
.B volume
The level of volume. Can range from 0 to 100.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq desktop.set_output_volume <volume>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mac_group
.sp
Manage groups on Mac OS 10.7+
.INDENT 0.0
.TP
.B salt.modules.mac_group.add(name, gid=None, **kwargs)
Changed in version 3006.0.

.sp
Add the specified group
.INDENT 7.0
.TP
.B name
Name of the new group
.TP
.B gid
Use GID for the new group
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.add foo 3456
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_group.adduser(group, name)
Add a user in the group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.adduser foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Verifies if a valid username \(aqbar\(aq as a member of an existing group \(aqfoo\(aq,
if not then adds it.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_group.chgid(name, gid)
Change the gid for a named group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.chgid foo 4376
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_group.delete(name)
Remove the named group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.delete foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_group.deluser(group, name)
Remove a user from the group
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.deluser foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Removes a member user \(aqbar\(aq from a group \(aqfoo\(aq. If group is not present
then returns True.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_group.getent(refresh=False)
Return info on all groups
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.getent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_group.info(name)
Return information about a group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.info foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_group.members(name, members_list)
Replaces members of the group with a provided list.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.members foo \(aquser1,user2,user3,...\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Replaces a membership list for a local group \(aqfoo\(aq.
.UNINDENT
.SS salt.modules.mac_keychain
.sp
Install certificates into the keychain on Mac OS
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.modules.mac_keychain.get_default_keychain(user=None, domain=\(aquser\(aq)
Get the default keychain
.INDENT 7.0
.TP
.B user
The user to check the default keychain of
.TP
.B domain
The domain to use valid values are user|system|common|dynamic, the default is user
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keychain.get_default_keychain
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_keychain.get_friendly_name(cert, password, legacy=False)
Get the friendly name of the given certificate
.INDENT 7.0
.TP
.B cert
The certificate to install
.TP
.B password
The password for the certificate being installed formatted in the way
described for openssl command in the PASS PHRASE ARGUMENTS section
.sp
Note: The password given here will show up as plaintext in the returned job
info.
.TP
.B legacy
Assume legacy format for certificate.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keychain.get_friendly_name /tmp/test.p12 test123

salt \(aq*\(aq keychain.get_friendly_name /tmp/test.p12 test123 legacy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_keychain.get_hash(name, password=None)
Returns the hash of a certificate in the keychain.
.INDENT 7.0
.TP
.B name
The name of the certificate (which you can get from keychain.get_friendly_name) or the
location of a p12 file.
.TP
.B password
The password that is used in the certificate. Only required if your passing a p12 file.
Note: This will be outputted to logs
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keychain.get_hash /tmp/test.p12 test123
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_keychain.install(cert, password, keychain=\(aq/Library/Keychains/System.keychain\(aq, allow_any=False, keychain_password=None)
Install a certificate
.INDENT 7.0
.TP
.B cert
The certificate to install
.TP
.B password
The password for the certificate being installed formatted in the way
described for openssl command in the PASS PHRASE ARGUMENTS section.
.sp
Note: The password given here will show up as plaintext in the job returned
info.
.TP
.B keychain
The keychain to install the certificate to, this defaults to
/Library/Keychains/System.keychain
.TP
.B allow_any
Allow any application to access the imported certificate without warning
.TP
.B keychain_password
If your keychain is likely to be locked pass the password and it will be unlocked
before running the import
.sp
Note: The password given here will show up as plaintext in the returned job
info.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keychain.install test.p12 test123
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_keychain.list_certs(keychain=\(aq/Library/Keychains/System.keychain\(aq)
List all of the installed certificates
.INDENT 7.0
.TP
.B keychain
The keychain to install the certificate to, this defaults to
/Library/Keychains/System.keychain
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keychain.list_certs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_keychain.set_default_keychain(keychain, domain=\(aquser\(aq, user=None)
Set the default keychain
.INDENT 7.0
.TP
.B keychain
The location of the keychain to set as default
.TP
.B domain
The domain to use valid values are user|system|common|dynamic, the default is user
.TP
.B user
The user to set the default keychain as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keychain.set_keychain /Users/fred/Library/Keychains/login.keychain
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_keychain.uninstall(cert_name, keychain=\(aq/Library/Keychains/System.keychain\(aq, keychain_password=None)
Uninstall a certificate from a keychain
.INDENT 7.0
.TP
.B cert_name
The name of the certificate to remove
.TP
.B keychain
The keychain to install the certificate to, this defaults to
/Library/Keychains/System.keychain
.TP
.B keychain_password
If your keychain is likely to be locked pass the password and it will be unlocked
before running the import
.sp
Note: The password given here will show up as plaintext in the returned job
info.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keychain.install test.p12 test123
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_keychain.unlock_keychain(keychain, password)
Unlock the given keychain with the password
.INDENT 7.0
.TP
.B keychain
The keychain to unlock
.TP
.B password
The password to use to unlock the keychain.
.sp
Note: The password given here will show up as plaintext in the returned job
info.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq keychain.unlock_keychain /tmp/test.p12 test123
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mac_pkgutil
.sp
Installer support for macOS.
.sp
Installer is the native .pkg/.mpkg package manager for macOS.
.INDENT 0.0
.TP
.B salt.modules.mac_pkgutil.forget(package_id)
New in version 2016.3.0.

.sp
Remove the receipt data about the specified package. Does not remove files.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
DO NOT use this command to fix broken package design
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBpackage_id\fP (\fI\%str\fP) \-\- The name of the package to forget
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgutil.forget com.apple.pkg.gcc4.2Leo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_pkgutil.install(source, package_id)
Install a .pkg from an URI or an absolute path.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- The path to a package.
.IP \(bu 2
\fBpackage_id\fP (\fI\%str\fP) \-\- The package ID
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgutil.install source=/vagrant/build_essentials.pkg package_id=com.apple.pkg.gcc4.2Leo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_pkgutil.is_installed(package_id)
Returns whether a given package id is installed.
.INDENT 7.0
.TP
.B Returns
True if installed, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgutil.is_installed com.apple.pkg.gcc4.2Leo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_pkgutil.list_()
List the installed packages.
.INDENT 7.0
.TP
.B Returns
A list of installed packages
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgutil.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mac_portspkg
.sp
Support for MacPorts under macOS.
.sp
This module has some caveats.
.sp
1. Updating the database of available ports is quite resource\-intensive.
However, \fIrefresh=True\fP is the default for all operations that need an
up\-to\-date copy of available ports.  Consider \fIrefresh=False\fP when you are
sure no db update is needed.
.sp
2. In some cases MacPorts doesn\(aqt always realize when another copy of itself
is running and will gleefully tromp all over the available ports database.
This makes MacPorts behave in undefined ways until a fresh complete
copy is retrieved.
.sp
Because of 1 and 2 it is possible to get the salt\-minion into a state where
\fIsalt mac\-machine pkg./something/\fP won\(aqt want to return.  Use
.sp
\fIsalt\-run jobs.active\fP
.sp
on the master to check for potentially long\-running calls to \fIport\fP\&.
.sp
Finally, ports database updates are always handled with \fIport selfupdate\fP
as opposed to \fIport sync\fP\&.  This makes sense in the MacPorts user community
but may confuse experienced Linux admins as Linux package managers
don\(aqt upgrade the packaging software when doing a package database update.
In other words \fIsalt mac\-machine pkg.refresh_db\fP is more like
\fIapt\-get update; apt\-get upgrade dpkg apt\-get\fP than simply \fIapt\-get update\fP\&.
.INDENT 0.0
.TP
.B salt.modules.mac_portspkg.available_version(*names, **kwargs)
This function is an alias of \fBlatest_version\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the latest version of the named package available for upgrade or
installation
.sp
Options:
.INDENT 0.0
.TP
.B refresh
Update ports with \fBport selfupdate\fP
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_portspkg.install(name=None, refresh=False, pkgs=None, **kwargs)
Install the passed package(s) with \fBport install\fP
.INDENT 7.0
.TP
.B name
The name of the formula to be installed. Note that this parameter is
ignored if \(dqpkgs\(dq is passed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B version
Specify a version to pkg to install. Ignored if pkgs is specified.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
salt \(aq*\(aq pkg.install git\-core version=\(aq1.8.5.5\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B variant
Specify a variant to pkg to install. Ignored if pkgs is specified.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
salt \(aq*\(aq pkg.install git\-core version=\(aq1.8.5.5\(aq variant=\(aq+credential_osxkeychain+doc+pcre\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Multiple Package Installation Options:
.INDENT 7.0
.TP
.B pkgs
A list of formulas to install. Must be passed as a python list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq,\(dqbar\(dq]\(aq
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo@1.2\(dq,\(dqbar\(dq]\(aq
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo@1.2+ssl\(dq,\(dqbar@2.3\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Returns a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install \(aqpackage package package\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_portspkg.latest_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation
.sp
Options:
.INDENT 7.0
.TP
.B refresh
Update ports with \fBport selfupdate\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_portspkg.list_pkgs(versions_as_list=False, **kwargs)
List the packages currently installed in a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_portspkg.list_upgrades(refresh=True, **kwargs)
Check whether or not an upgrade is available for all packages
.sp
Options:
.INDENT 7.0
.TP
.B refresh
Update ports with \fBport selfupdate\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_portspkg.refresh_db(**kwargs)
Update ports with \fBport selfupdate\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt mac pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_portspkg.remove(name=None, pkgs=None, **kwargs)
Removes packages with \fBport uninstall\fP\&.
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_portspkg.upgrade(refresh=True, **kwargs)
Run a full upgrade using MacPorts \(aqport upgrade outdated\(aq
.sp
Options:
.INDENT 7.0
.TP
.B refresh
Update ports with \fBport selfupdate\fP
.UNINDENT
.sp
Returns a dictionary containing the changes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq:  {\(aqold\(aq: \(aq<old\-version>\(aq,
                \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_portspkg.upgrade_available(pkg, refresh=True, **kwargs)
Check whether or not an upgrade is available for a given package
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade_available <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_portspkg.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mac_power
.sp
Module for editing power settings on macOS
.INDENT 0.0
.INDENT 3.5
New in version 2016.3.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.get_computer_sleep()
Display the amount of idle time until the computer sleeps.
.INDENT 7.0
.TP
.B Returns
A string representing the sleep settings for the computer
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.get_computer_sleep
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.get_display_sleep()
Display the amount of idle time until the display sleeps.
.INDENT 7.0
.TP
.B Returns
A string representing the sleep settings for the displey
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.get_display_sleep
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.get_harddisk_sleep()
Display the amount of idle time until the hard disk sleeps.
.INDENT 7.0
.TP
.B Returns
A string representing the sleep settings for the hard disk
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.get_harddisk_sleep
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.get_restart_freeze()
Displays whether \(aqrestart on freeze\(aq is on or off if supported
.INDENT 7.0
.TP
.B Returns
A string value representing the \(dqrestart on freeze\(dq settings
.TP
.B Return type
string
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.get_restart_freeze
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.get_restart_power_failure()
Displays whether \(aqrestart on power failure\(aq is on or off if supported
.INDENT 7.0
.TP
.B Returns
A string value representing the \(dqrestart on power failure\(dq settings
.TP
.B Return type
string
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.get_restart_power_failure
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.get_sleep()
Displays the amount of idle time until the machine sleeps. Settings for
Computer, Display, and Hard Disk are displayed.
.INDENT 7.0
.TP
.B Returns
A dictionary containing the sleep status for Computer, Display, and
Hard Disk
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.get_sleep
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.get_sleep_on_power_button()
Displays whether \(aqallow power button to sleep computer\(aq is on or off if
supported
.INDENT 7.0
.TP
.B Returns
A string value representing the \(dqallow power button to sleep
computer\(dq settings
.TP
.B Return type
string
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.get_sleep_on_power_button
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.get_wake_on_modem()
Displays whether \(aqwake on modem\(aq is on or off if supported
.INDENT 7.0
.TP
.B Returns
A string value representing the \(dqwake on modem\(dq settings
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.get_wake_on_modem
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.get_wake_on_network()
Displays whether \(aqwake on network\(aq is on or off if supported
.INDENT 7.0
.TP
.B Returns
A string value representing the \(dqwake on network\(dq settings
.TP
.B Return type
string
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.get_wake_on_network
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.set_computer_sleep(minutes)
Set the amount of idle time until the computer sleeps. Pass \(dqNever\(dq of \(dqOff\(dq
to never sleep.
.INDENT 7.0
.TP
.B Parameters
\fBminutes\fP \-\- Can be an integer between 1 and 180 or \(dqNever\(dq or \(dqOff\(dq
.TP
.B Ptype
int, str
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.set_computer_sleep 120
salt \(aq*\(aq power.set_computer_sleep off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.set_display_sleep(minutes)
Set the amount of idle time until the display sleeps. Pass \(dqNever\(dq of \(dqOff\(dq
to never sleep.
.INDENT 7.0
.TP
.B Parameters
\fBminutes\fP \-\- Can be an integer between 1 and 180 or \(dqNever\(dq or \(dqOff\(dq
.TP
.B Ptype
int, str
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.set_display_sleep 120
salt \(aq*\(aq power.set_display_sleep off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.set_harddisk_sleep(minutes)
Set the amount of idle time until the harddisk sleeps. Pass \(dqNever\(dq of \(dqOff\(dq
to never sleep.
.INDENT 7.0
.TP
.B Parameters
\fBminutes\fP \-\- Can be an integer between 1 and 180 or \(dqNever\(dq or \(dqOff\(dq
.TP
.B Ptype
int, str
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.set_harddisk_sleep 120
salt \(aq*\(aq power.set_harddisk_sleep off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.set_restart_freeze(enabled)
Specifies whether the server restarts automatically after a system freeze.
This setting doesn\(aqt seem to be editable. The command completes successfully
but the setting isn\(aqt actually updated. This is probably a macOS. The
functions remains in case they ever fix the bug.
.INDENT 7.0
.TP
.B Parameters
\fBenabled\fP (\fI\%bool\fP) \-\- True to enable, False to disable. \(dqOn\(dq and \(dqOff\(dq are
also acceptable values. Additionally you can pass 1 and 0 to represent
True and False respectively
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.set_restart_freeze True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.set_restart_power_failure(enabled)
Set whether or not the computer will automatically restart after a power
failure.
.INDENT 7.0
.TP
.B Parameters
\fBenabled\fP (\fI\%bool\fP) \-\- True to enable, False to disable. \(dqOn\(dq and \(dqOff\(dq are
also acceptable values. Additionally you can pass 1 and 0 to represent
True and False respectively
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.set_restart_power_failure True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.set_sleep(minutes)
Sets the amount of idle time until the machine sleeps. Sets the same value
for Computer, Display, and Hard Disk. Pass \(dqNever\(dq or \(dqOff\(dq for computers
that should never sleep.
.INDENT 7.0
.TP
.B Parameters
\fBminutes\fP \-\- Can be an integer between 1 and 180 or \(dqNever\(dq or \(dqOff\(dq
.TP
.B Ptype
int, str
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.set_sleep 120
salt \(aq*\(aq power.set_sleep never
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.set_sleep_on_power_button(enabled)
Set whether or not the power button can sleep the computer.
.INDENT 7.0
.TP
.B Parameters
\fBenabled\fP (\fI\%bool\fP) \-\- True to enable, False to disable. \(dqOn\(dq and \(dqOff\(dq are
also acceptable values. Additionally you can pass 1 and 0 to represent
True and False respectively
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.set_sleep_on_power_button True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.set_wake_on_modem(enabled)
Set whether or not the computer will wake from sleep when modem activity is
detected.
.INDENT 7.0
.TP
.B Parameters
\fBenabled\fP (\fI\%bool\fP) \-\- True to enable, False to disable. \(dqOn\(dq and \(dqOff\(dq are
also acceptable values. Additionally you can pass 1 and 0 to represent
True and False respectively
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.set_wake_on_modem True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_power.set_wake_on_network(enabled)
Set whether or not the computer will wake from sleep when network activity
is detected.
.INDENT 7.0
.TP
.B Parameters
\fBenabled\fP (\fI\%bool\fP) \-\- True to enable, False to disable. \(dqOn\(dq and \(dqOff\(dq are
also acceptable values. Additionally you can pass 1 and 0 to represent
True and False respectively
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq power.set_wake_on_network True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mac_service
.sp
The service module for macOS
.sp
New in version 2016.3.0.

.sp
This module has support for services in the following locations.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/System/Library/LaunchDaemons/
/System/Library/LaunchAgents/
/Library/LaunchDaemons/
/Library/LaunchAgents/

# As of version \(dq2019.2.0\(dq support for user\-specific services were added.
/Users/foo/Library/LaunchAgents/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
As of the 2019.2.0 release, if a service is located in a \fBLaunchAgent\fP
path and a \fBrunas\fP user is NOT specified, the current console user will
be used to properly interact with the service.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
As of the 3002 release, if a service name of \fBsalt\-minion\fP is passed this
module will convert it over to it\(aqs macOS equivalent name, in this case
to \fBcom.saltstack.salt.minion\fP\&. This is true for \fBsalt\-master\fP
\fBsalt\-api\fP, and \fBsalt\-syndic\fP as well.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.available(name)
Check that the given service is available.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the service
.TP
.B Returns
True if the service is available, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.available com.openssh.sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.disable(name, runas=None)
Disable a launchd service. Raises an error if the service fails to be
disabled
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Service label, file name, or full path
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- User to run launchctl commands
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful or if the service is already disabled
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disable org.cups.cupsd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.disabled(name, runas=None, domain=\(aqsystem\(aq)
Check if the specified service is not enabled. This is the opposite of
\fBservice.enabled\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name to look up
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- User to run launchctl commands
.IP \(bu 2
\fBdomain\fP (\fI\%str\fP) \-\- domain to check for disabled services. Default is system.
.UNINDENT
.TP
.B Returns
True if the specified service is NOT enabled, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disabled org.cups.cupsd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.enable(name, runas=None)
Enable a launchd service. Raises an error if the service fails to be enabled
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Service label, file name, or full path
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- User to run launchctl commands
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful or if the service is already enabled
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enable org.cups.cupsd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.enabled(name, runas=None)
Check if the specified service is enabled (not disabled, capable of being
loaded/bootstrapped).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Previously this function would see if the service is loaded via
\fBlaunchctl list\fP to determine if the service is enabled. This was not
an accurate way to do so. The new behavior checks to make sure its not
disabled to determine the status. Please use \fBservice.loaded\fP for the
previous behavior.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to look up.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- User to run launchctl commands.
.UNINDENT
.TP
.B Returns
True if the specified service enabled, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enabled org.cups.cupsd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.get_all(runas=None)
Return a list of services that are enabled or available. Can be used to
find the name of a service.
.INDENT 7.0
.TP
.B Parameters
\fBrunas\fP (\fI\%str\fP) \-\- User to run launchctl commands
.TP
.B Returns
A list of all the services available or enabled
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.get_enabled(runas=None)
Return a list of all services that are enabled. Can be used to find the
name of a service.
.INDENT 7.0
.TP
.B Parameters
\fBrunas\fP (\fI\%str\fP) \-\- User to run launchctl commands
.TP
.B Returns
A list of all the services enabled on the system
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.launchctl(sub_cmd, *args, **kwargs)
Run a launchctl command and raise an error if it fails
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsub_cmd\fP (\fI\%str\fP) \-\- Sub command supplied to launchctl
.IP \(bu 2
\fBargs\fP (\fI\%tuple\fP) \-\- Tuple containing additional arguments to pass to
launchctl
.IP \(bu 2
\fBkwargs\fP (\fI\%dict\fP) \-\- Dictionary containing arguments to pass to
\fBcmd.run_all\fP
.IP \(bu 2
\fBreturn_stdout\fP (\fI\%bool\fP) \-\- A keyword argument.  If true return the stdout
of the launchctl command
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, raise \fBCommandExecutionError\fP if not, or
the stdout of the launchctl command if requested
.TP
.B Return type
\fI\%bool\fP, \fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.launchctl debug org.cups.cupsd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.list_(name=None, runas=None)
Run launchctl list and return the output
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to list
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- User to run launchctl commands
.UNINDENT
.TP
.B Returns
If a name is passed returns information about the named service,
otherwise returns a list of all services and pids
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.list
salt \(aq*\(aq service.list org.cups.cupsd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.loaded(name, runas=None)
Check if the specified service is loaded.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to look up
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- User to run launchctl commands
.UNINDENT
.TP
.B Returns
\fBTrue\fP if the specified service is loaded, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.loaded org.cups.cupsd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.missing(name)
The inverse of service.available
Check that the given service is not available.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the service
.TP
.B Returns
True if the service is not available, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.missing com.openssh.sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.restart(name, runas=None)
Unloads and reloads a launchd service.  Raises an error if the service
fails to reload
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Service label, file name, or full path
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- User to run launchctl commands
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart org.cups.cupsd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.show(name)
Show properties of a launchctl service
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- Service label, file name, or full path
.TP
.B Returns
The service information if the service is found
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.show org.cups.cupsd  # service label
salt \(aq*\(aq service.show org.cups.cupsd.plist  # file name
salt \(aq*\(aq service.show /System/Library/LaunchDaemons/org.cups.cupsd.plist  # full path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.start(name, runas=None)
Start a launchd service.  Raises an error if the service fails to start
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To start a service in macOS the service must be enabled first. Use
\fBservice.enable\fP to enable the service.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Service label, file name, or full path
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- User to run launchctl commands
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful or if the service is already running
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start org.cups.cupsd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.status(name, sig=None, runas=None)
Return the status for a service.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Previously this function would return a PID for a running service with
a PID or \(aqloaded\(aq for a loaded service without a PID. This was changed
to have better parity with other service modules that return True/False.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Used to find the service from launchctl.  Can be the
service Label, file name, or path to the service file. (normally a plist)
.IP \(bu 2
\fBsig\fP (\fI\%str\fP) \-\- Find the service with status.pid instead.  Note that
\fBname\fP must still be provided.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- User to run launchctl commands.
.UNINDENT
.TP
.B Returns
True if running, otherwise False.
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status cups
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_service.stop(name, runas=None)
Stop a launchd service.  Raises an error if the service fails to stop
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Though \fBservice.stop\fP will unload a service in macOS, the service
will start on next boot unless it is disabled. Use \fBservice.disable\fP
to disable the service
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Service label, file name, or full path
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- User to run launchctl commands
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful or if the service is already stopped
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop org.cups.cupsd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mac_shadow
.sp
Manage macOS local directory passwords and policies
.sp
New in version 2016.3.0.

.sp
Note that it is usually better to apply password policies through the creation
of a configuration profile.
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.del_password(name)
Deletes the account password
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The user name of the account
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
CommandExecutionError on user not found or any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.del_password username
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.get_account_created(name)
Get the date/time the account was created
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The username of the account
.TP
.B Returns
The date/time the account was created (yyyy\-mm\-dd hh:mm:ss) or 0 if
the value is not defined
.TP
.B Return type
\fI\%str\fP
.TP
.B Raises
CommandExecutionError on user not found or any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.get_account_created admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.get_change(name)
Gets the date on which the password expires
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the user account
.TP
.B Returns
The date the password will expire
.TP
.B Return type
\fI\%str\fP
.TP
.B Raises
CommandExecutionError on user not found or any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.get_change username
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.get_expire(name)
Gets the date on which the account expires
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the user account
.TP
.B Returns
The date the account expires
.TP
.B Return type
\fI\%str\fP
.TP
.B Raises
CommandExecutionError on user not found or any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.get_expire username
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.get_last_change(name)
Get the date/time the account was changed
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The username of the account
.TP
.B Returns
The date/time the account was modified (yyyy\-mm\-dd hh:mm:ss) or 0
if the value is not defined
.TP
.B Return type
\fI\%str\fP
.TP
.B Raises
CommandExecutionError on user not found or any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.get_last_change admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.get_login_failed_count(name)
Get the number of failed login attempts
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The username of the account
.TP
.B Returns
The number of failed login attempts. 0 may mean there are no failed
login attempts or the value is not defined
.TP
.B Return type
\fI\%str\fP
.TP
.B Raises
CommandExecutionError on user not found or any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.get_login_failed_count admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.get_login_failed_last(name)
Get the date/time of the last failed login attempt
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The username of the account
.TP
.B Returns
The date/time of the last failed login attempt on this account
(yyyy\-mm\-dd hh:mm:ss) or 0 if the value is not defined
.TP
.B Return type
\fI\%str\fP
.TP
.B Raises
CommandExecutionError on user not found or any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.get_login_failed_last admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.get_maxdays(name)
Get the maximum age of the password
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The username of the account
.TP
.B Returns
The maximum age of the password in days
.TP
.B Return type
\fI\%int\fP
.TP
.B Raises
CommandExecutionError on user not found or any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.get_maxdays admin 90
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.info(name)
Return information for the specified user
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The username
.TP
.B Returns
A dictionary containing the user\(aqs shadow information
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.info admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.set_change(name, date)
Sets the date on which the password expires. The user will be required to
change their password. Format is mm/dd/yyyy
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the user account
.IP \(bu 2
\fBdate\fP (\fIdate\fP) \-\- The date the password will expire. Must be in mm/dd/yyyy
format.
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
CommandExecutionError on user not found or any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_change username 09/21/2016
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.set_expire(name, date)
Sets the date on which the account expires. The user will not be able to
login after this date. Date format is mm/dd/yyyy
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the user account
.IP \(bu 2
\fBdate\fP (\fIdatetime\fP) \-\- The date the account will expire. Format must be
mm/dd/yyyy.
.UNINDENT
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
CommandExecutionError on user not found or any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_expire username 07/23/2015
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.set_inactdays(name, days)
Set the number if inactive days before the account is locked. Not available
in macOS
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The user name
.IP \(bu 2
\fBdays\fP (\fI\%int\fP) \-\- The number of days
.UNINDENT
.TP
.B Returns
Will always return False until macOS supports this feature.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_inactdays admin 90
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.set_maxdays(name, days)
Set the maximum age of the password in days
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The username of the account
.IP \(bu 2
\fBdays\fP (\fI\%int\fP) \-\- The maximum age of the account in days
.UNINDENT
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
CommandExecutionError on user not found or any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_maxdays admin 90
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.set_mindays(name, days)
Set the minimum password age in days. Not available in macOS.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The user name
.IP \(bu 2
\fBdays\fP (\fI\%int\fP) \-\- The number of days
.UNINDENT
.TP
.B Returns
Will always return False until macOS supports this feature.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_mindays admin 90
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.set_password(name, password)
Set the password for a named user (insecure, the password will be in the
process list while the command is running)
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the local user, which is assumed to be in the
local directory service
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- The plaintext password to set
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
CommandExecutionError on user not found or any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mac_shadow.set_password macuser macpassword
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_shadow.set_warndays(name, days)
Set the number of days before the password expires that the user will start
to see a warning. Not available in macOS
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The user name
.IP \(bu 2
\fBdays\fP (\fI\%int\fP) \-\- The number of days
.UNINDENT
.TP
.B Returns
Will always return False until macOS supports this feature.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_warndays admin 90
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mac_softwareupdate
.sp
Support for the softwareupdate command on MacOS.
.INDENT 0.0
.TP
.B salt.modules.mac_softwareupdate.download(name)
Download a named update so that it can be installed later with the
\fBupdate\fP or \fBupdate_all\fP functions
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The update to download.
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq softwareupdate.download <update name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_softwareupdate.download_all(recommended=False, restart=True)
Download all available updates so that they can be installed later with the
\fBupdate\fP or \fBupdate_all\fP functions. It returns a list of updates that
are now downloaded.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrecommended\fP (\fI\%bool\fP) \-\- If set to True, only install the recommended
updates. If set to False (default) all updates are installed.
.IP \(bu 2
\fBrestart\fP (\fI\%bool\fP) \-\- Set this to False if you do not want to install updates
that require a restart. Default is True
.UNINDENT
.TP
.B Returns
A list containing all downloaded updates on the system.
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq softwareupdate.download_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_softwareupdate.get_catalog()
New in version 2016.3.0.

.sp
Get the current catalog being used for update lookups. Will return a url if
a custom catalog has been specified. Otherwise the word \(aqDefault\(aq will be
returned
.INDENT 7.0
.TP
.B Returns
The catalog being used for update lookups
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq softwareupdates.get_catalog
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_softwareupdate.ignore(name)
Ignore a specific program update. When an update is ignored the \(aq\-\(aq and
version number at the end will be omitted, so \(dqSecUpd2014\-001\-1.0\(dq becomes
\(dqSecUpd2014\-001\(dq. It will be removed automatically if present. An update
is successfully ignored when it no longer shows up after list_updates.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- The name of the update to add to the ignore list.
.TP
.B Ptype
str
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq softwareupdate.ignore <update\-name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_softwareupdate.list_available(recommended=False, restart=False, shut_down=False)
List all available updates.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrecommended\fP (\fI\%bool\fP) \-\- Show only recommended updates.
.IP \(bu 2
\fBrestart\fP (\fI\%bool\fP) \-\- Show only updates that require a restart.
.UNINDENT
.TP
.B Returns
Returns a dictionary containing the updates
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq softwareupdate.list_available
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_softwareupdate.list_downloads()
Return a list of all updates that have been downloaded locally.
.INDENT 7.0
.TP
.B Returns
A list of updates that have been downloaded
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq softwareupdate.list_downloads
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_softwareupdate.list_ignored()
List all updates that have been ignored. Ignored updates are shown
without the \(aq\-\(aq and version number at the end, this is how the
softwareupdate command works.
.INDENT 7.0
.TP
.B Returns
The list of ignored updates
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq softwareupdate.list_ignored
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_softwareupdate.reset_catalog()
New in version 2016.3.0.

.sp
Reset the Software Update Catalog to the default.
.INDENT 7.0
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq softwareupdates.reset_catalog
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_softwareupdate.reset_ignored()
Make sure the ignored updates are not ignored anymore,
returns a list of the updates that are no longer ignored.
.INDENT 7.0
.TP
.B Returns
True if the list was reset, Otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq softwareupdate.reset_ignored
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_softwareupdate.schedule_enable(enable)
Enable/disable automatic update scheduling.
.INDENT 7.0
.TP
.B Parameters
\fBenable\fP \-\- True/On/Yes/1 to turn on automatic updates. False/No/Off/0
to turn off automatic updates. If this value is empty, the current
status will be returned.
.TP
.B Type
bool str
.TP
.B Returns
True if scheduling is enabled, False if disabled
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq softwareupdate.schedule_enable on|off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_softwareupdate.schedule_enabled()
Check the status of automatic update scheduling.
.INDENT 7.0
.TP
.B Returns
True if scheduling is enabled, False if disabled
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq softwareupdate.schedule_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_softwareupdate.set_catalog(url)
New in version 2016.3.0.

.sp
Set the Software Update Catalog to the URL specified
.INDENT 7.0
.TP
.B Parameters
\fBurl\fP (\fI\%str\fP) \-\- The url to the update catalog
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq softwareupdates.set_catalog http://swupd.local:8888/index.sucatalog
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_softwareupdate.update(name)
Install a named update.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the of the update to install.
.TP
.B Returns
True if successfully updated, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq softwareupdate.update <update\-name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_softwareupdate.update_all(recommended=False, restart=True)
Install all available updates. Returns a dictionary containing the name
of the update and the status of its installation.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrecommended\fP (\fI\%bool\fP) \-\- If set to True, only install the recommended
updates. If set to False (default) all updates are installed.
.IP \(bu 2
\fBrestart\fP (\fI\%bool\fP) \-\- Set this to False if you do not want to install updates
that require a restart. Default is True
.UNINDENT
.TP
.B Returns
A dictionary containing the updates that were installed and the
status of its installation. If no updates were installed an empty
dictionary is returned.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq softwareupdate.update_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_softwareupdate.update_available(name)
Check whether or not an update is available with a given name.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the update to look for
.TP
.B Returns
True if available, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq softwareupdate.update_available <update\-name>
salt \(aq*\(aq softwareupdate.update_available \(dq<update with whitespace>\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mac_sysctl
.sp
Module for viewing and modifying sysctl parameters
.INDENT 0.0
.TP
.B salt.modules.mac_sysctl.assign(name, value)
Assign a single sysctl parameter for this minion
.INDENT 7.0
.TP
.B name
The name of the sysctl value to edit.
.TP
.B value
The sysctl value to apply.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.assign net.inet.icmp.icmplim 50
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_sysctl.get(name)
Return a single sysctl parameter for this minion
.INDENT 7.0
.TP
.B name
The name of the sysctl value to display.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.get hw.physmem
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_sysctl.persist(name, value, config=\(aq/etc/sysctl.conf\(aq, apply_change=False)
Assign and persist a simple sysctl parameter for this minion
.INDENT 7.0
.TP
.B name
The name of the sysctl value to edit.
.TP
.B value
The sysctl value to apply.
.TP
.B config
The location of the sysctl configuration file.
.TP
.B apply_change
Default is False; Default behavior only creates or edits
the sysctl.conf file. If apply is set to True, the changes are
applied to the system.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.persist net.inet.icmp.icmplim 50
salt \(aq*\(aq sysctl.persist coretemp_load NO config=/etc/sysctl.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_sysctl.show(config_file=False)
Return a list of sysctl parameters for this minion
.INDENT 7.0
.TP
.B config: Pull the data from the system configuration file
instead of the live data.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.show
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mac_system
.sp
System module for sleeping, restarting, and shutting down the system on Mac OS X
.sp
New in version 2016.3.0.

.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Using this module will enable \fBatrun\fP on the system if it is disabled.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.get_boot_arch()
Get the kernel architecture setting from \fBcom.apple.Boot.plist\fP
.INDENT 7.0
.TP
.B Returns
A string value representing the boot architecture setting
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_boot_arch
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.get_computer_name()
Gets the computer name
.INDENT 7.0
.TP
.B Returns
The computer name
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_computer_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.get_disable_keyboard_on_lock()
Get whether or not the keyboard should be disabled when the X Serve enclosure
lock is engaged.
.INDENT 7.0
.TP
.B Returns
True if disable keyboard on lock is on, False if off
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_disable_keyboard_on_lock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.get_remote_events()
Displays whether remote apple events are on or off.
.INDENT 7.0
.TP
.B Returns
True if remote apple events are on, False if off
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_remote_events
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.get_remote_login()
Displays whether remote login (SSH) is on or off.
.INDENT 7.0
.TP
.B Returns
True if remote login is on, False if off
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_remote_login
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.get_restart_delay()
Get the number of seconds after which the computer will start up after a
power failure.
.INDENT 7.0
.TP
.B Returns
A string value representing the number of seconds the system will
delay restart after power loss
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_restart_delay
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.get_startup_disk()
Displays the current startup disk
.INDENT 7.0
.TP
.B Returns
The current startup disk
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_startup_disk
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.get_subnet_name()
Gets the local subnet name
.INDENT 7.0
.TP
.B Returns
The local subnet name
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_subnet_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.halt(at_time=None)
Halt a running system
.INDENT 7.0
.TP
.B Parameters
\fBat_time\fP (\fI\%str\fP) \-\-
.sp
Any valid \fIat\fP expression. For example, some valid at
expressions could be:
.INDENT 7.0
.IP \(bu 2
noon
.IP \(bu 2
midnight
.IP \(bu 2
fri
.IP \(bu 2
9:00 AM
.IP \(bu 2
2:30 PM tomorrow
.IP \(bu 2
now + 10 minutes
.UNINDENT

.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If you pass a time only, with no \(aqAM/PM\(aq designation, you have to
double quote the parameter on the command line. For example: \(aq\(dq14:00\(dq\(aq
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.halt
salt \(aq*\(aq system.halt \(aqnow + 10 minutes\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.list_startup_disks()
List all valid startup disks on the system.
.INDENT 7.0
.TP
.B Returns
A list of valid startup disks
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.list_startup_disks
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.restart(at_time=None)
Restart the system
.INDENT 7.0
.TP
.B Parameters
\fBat_time\fP (\fI\%str\fP) \-\-
.sp
Any valid \fIat\fP expression. For example, some valid at
expressions could be:
.INDENT 7.0
.IP \(bu 2
noon
.IP \(bu 2
midnight
.IP \(bu 2
fri
.IP \(bu 2
9:00 AM
.IP \(bu 2
2:30 PM tomorrow
.IP \(bu 2
now + 10 minutes
.UNINDENT

.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If you pass a time only, with no \(aqAM/PM\(aq designation, you have to
double quote the parameter on the command line. For example: \(aq\(dq14:00\(dq\(aq
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.restart
salt \(aq*\(aq system.restart \(aq12:00 PM fri\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.set_boot_arch(arch=\(aqdefault\(aq)
Set the kernel to boot in 32 or 64 bit mode on next boot.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When this function fails with the error \fBchanges to kernel
architecture failed to save!\fP, then the boot arch is not updated.
This is either an Apple bug, not available on the test system, or a
result of system files being locked down in macOS (SIP Protection).
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBarch\fP (\fI\%str\fP) \-\-
.sp
A string representing the desired architecture. If no
value is passed, default is assumed. Valid values include:
.INDENT 7.0
.IP \(bu 2
i386
.IP \(bu 2
x86_64
.IP \(bu 2
default
.UNINDENT

.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_boot_arch i386
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.set_computer_name(name)
Set the computer name
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The new computer name
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_computer_name \(dqMike\(aqs Mac\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.set_disable_keyboard_on_lock(enable)
Get whether or not the keyboard should be disabled when the X Serve
enclosure lock is engaged.
.INDENT 7.0
.TP
.B Parameters
\fBenable\fP (\fI\%bool\fP) \-\- True to enable, False to disable. \(dqOn\(dq and \(dqOff\(dq are
also acceptable values. Additionally you can pass 1 and 0 to represent
True and False respectively
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_disable_keyboard_on_lock False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.set_remote_events(enable)
Set whether the server responds to events sent by other computers (such as
AppleScripts)
.INDENT 7.0
.TP
.B Parameters
\fBenable\fP (\fI\%bool\fP) \-\- True to enable, False to disable. \(dqOn\(dq and \(dqOff\(dq are
also acceptable values. Additionally you can pass 1 and 0 to represent
True and False respectively
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_remote_events On
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.set_remote_login(enable)
Set the remote login (SSH) to either on or off.
.INDENT 7.0
.TP
.B Parameters
\fBenable\fP (\fI\%bool\fP) \-\- True to enable, False to disable. \(dqOn\(dq and \(dqOff\(dq are
also acceptable values. Additionally you can pass 1 and 0 to represent
True and False respectively
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_remote_login True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.set_restart_delay(seconds)
Set the number of seconds after which the computer will start up after a
power failure.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This command fails with the following error:
.sp
\fBError, IOServiceOpen returned 0x10000003\fP
.sp
The setting is not updated. This is an apple bug. It seems like it may
only work on certain versions of Mac Server X. This article explains the
issue in more detail, though it is quite old.
.sp
\fI\%http://lists.apple.com/archives/macos\-x\-server/2006/Jul/msg00967.html\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBseconds\fP (\fI\%int\fP) \-\- The number of seconds. Must be a multiple of 30
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_restart_delay 180
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.set_startup_disk(path)
Set the current startup disk to the indicated path. Use
\fBsystem.list_startup_disks\fP to find valid startup disks on the system.
.INDENT 7.0
.TP
.B Parameters
\fBpath\fP (\fI\%str\fP) \-\- The valid startup disk path
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_startup_disk /System/Library/CoreServices
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.set_subnet_name(name)
Set the local subnet name
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The new local subnet name
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Spaces are changed to dashes. Other special characters are removed.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
The following will be set as \(aqMikes\-Mac\(aq
salt \(aq*\(aq system.set_subnet_name \(dqMike\(aqs Mac\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.shutdown(at_time=None)
Shutdown the system
.INDENT 7.0
.TP
.B Parameters
\fBat_time\fP (\fI\%str\fP) \-\-
.sp
Any valid \fIat\fP expression. For example, some valid at
expressions could be:
.INDENT 7.0
.IP \(bu 2
noon
.IP \(bu 2
midnight
.IP \(bu 2
fri
.IP \(bu 2
9:00 AM
.IP \(bu 2
2:30 PM tomorrow
.IP \(bu 2
now + 10 minutes
.UNINDENT

.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If you pass a time only, with no \(aqAM/PM\(aq designation, you have to
double quote the parameter on the command line. For example: \(aq\(dq14:00\(dq\(aq
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.shutdown
salt \(aq*\(aq system.shutdown \(aqnow + 1 hour\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_system.sleep(at_time=None)
Sleep the system. If a user is active on the system it will likely fail to
sleep.
.INDENT 7.0
.TP
.B Parameters
\fBat_time\fP (\fI\%str\fP) \-\-
.sp
Any valid \fIat\fP expression. For example, some valid at
expressions could be:
.INDENT 7.0
.IP \(bu 2
noon
.IP \(bu 2
midnight
.IP \(bu 2
fri
.IP \(bu 2
9:00 AM
.IP \(bu 2
2:30 PM tomorrow
.IP \(bu 2
now + 10 minutes
.UNINDENT

.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If you pass a time only, with no \(aqAM/PM\(aq designation, you have to
double quote the parameter on the command line. For example: \(aq\(dq14:00\(dq\(aq
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.sleep
salt \(aq*\(aq system.sleep \(aq10:00 PM\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mac_timezone
.sp
Module for editing date/time settings on macOS
.INDENT 0.0
.INDENT 3.5
New in version 2016.3.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.get_date()
Displays the current date
.INDENT 7.0
.TP
.B Returns
the system date
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_date
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.get_hwclock()
Get current hardware clock setting (UTC or localtime)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_hwclock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.get_offset()
Displays the current time zone offset
.INDENT 7.0
.TP
.B Returns
The current time zone offset
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_offset
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.get_time()
Get the current system time.
.INDENT 7.0
.TP
.B Returns
The current time in 24 hour format
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_time
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.get_time_server()
Display the currently set network time server.
.INDENT 7.0
.TP
.B Returns
the network time server
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_time_server
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.get_using_network_time()
Display whether network time is on or off
.INDENT 7.0
.TP
.B Returns
True if network time is on, False if off
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_using_network_time
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.get_zone()
Displays the current time zone
.INDENT 7.0
.TP
.B Returns
The current time zone
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_zone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.get_zonecode()
Displays the current time zone abbreviated code
.INDENT 7.0
.TP
.B Returns
The current time zone code
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_zonecode
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.list_zones()
Displays a list of available time zones. Use this list when setting a
time zone using \fBtimezone.set_zone\fP
.INDENT 7.0
.TP
.B Returns
a list of time zones
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.list_zones
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.set_date(date)
Set the current month, day, and year
.INDENT 7.0
.TP
.B Parameters
\fBdate\fP (\fI\%str\fP) \-\-
.sp
The date to set. Valid date formats are:
.INDENT 7.0
.IP \(bu 2
%m:%d:%y
.IP \(bu 2
%m:%d:%Y
.IP \(bu 2
%m/%d/%y
.IP \(bu 2
%m/%d/%Y
.UNINDENT

.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
SaltInvocationError on Invalid Date format
.TP
.B Raises
CommandExecutionError on failure
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.set_date 1/13/2016
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.set_hwclock(clock)
Sets the hardware clock to be either UTC or localtime
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.set_hwclock UTC
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.set_time(time)
Sets the current time. Must be in 24 hour format.
.INDENT 7.0
.TP
.B Parameters
\fBtime\fP (\fI\%str\fP) \-\- The time to set in 24 hour format.  The value must be
double quoted. ie: \(aq\(dq17:46\(dq\(aq
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
SaltInvocationError on Invalid Time format
.TP
.B Raises
CommandExecutionError on failure
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.set_time \(aq\(dq17:34\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.set_time_server(time_server=\(aqtime.apple.com\(aq)
Designates a network time server. Enter the IP address or DNS name for the
network time server.
.INDENT 7.0
.TP
.B Parameters
\fBtime_server\fP \-\- IP or DNS name of the network time server. If nothing
is passed the time server will be set to the macOS default of
\(aqtime.apple.com\(aq
.TP
.B Type
\fI\%str\fP
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
CommandExecutionError on failure
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.set_time_server time.acme.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.set_using_network_time(enable)
Set whether network time is on or off.
.INDENT 7.0
.TP
.B Parameters
\fBenable\fP \-\- True to enable, False to disable. Can also use \(aqon\(aq or \(aqoff\(aq
.TP
.B Type
str bool
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
CommandExecutionError on failure
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.set_using_network_time True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.set_zone(time_zone)
Set the local time zone. Use \fBtimezone.list_zones\fP to list valid time_zone
arguments
.INDENT 7.0
.TP
.B Parameters
\fBtime_zone\fP (\fI\%str\fP) \-\- The time zone to apply
.TP
.B Returns
True if successful, False if not
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
SaltInvocationError on Invalid Timezone
.TP
.B Raises
CommandExecutionError on failure
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.set_zone America/Denver
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_timezone.zone_compare(time_zone)
Compares the given timezone name with the system timezone name.
.INDENT 7.0
.TP
.B Returns
True if they are the same, False if not
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.zone_compare America/Boise
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mac_user
.sp
Manage users on Mac OS 10.7+
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage users on a
minion, and it is using a different module (or gives an error similar to
\fI\(aquser.info\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.add(name, uid=None, gid=None, groups=None, home=None, shell=None, fullname=None, createhome=True, **kwargs)
Add a user to the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.add name <uid> <gid> <groups> <home> <shell>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.chfullname(name, fullname)
Change the user\(aqs Full Name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chfullname foo \(aqFoo Bar\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.chgid(name, gid)
Change the default group of the user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chgid foo 4376
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.chgroups(name, groups, append=False)
Change the groups to which the user belongs. Note that the user\(aqs primary
group does not have to be one of the groups passed, membership in the
user\(aqs primary group is automatically assumed.
.INDENT 7.0
.TP
.B groups
Groups to which the user should belong, can be passed either as a
python list or a comma\-separated string
.TP
.B append
Instead of removing user from groups not included in the \fBgroups\fP
parameter, just add user to any groups for which they are not members
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chgroups foo wheel,root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.chhome(name, home, **kwargs)
Change the home directory of the user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chhome foo /Users/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.chshell(name, shell)
Change the default shell of the user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chshell foo /bin/zsh
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.chuid(name, uid)
Change the uid for a named user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chuid foo 4376
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.delete(name, remove=False, force=False)
Remove a user from the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.delete name remove=True force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.disable_auto_login()
New in version 2016.3.0.

.sp
Disables auto login on the machine
.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.disable_auto_login
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.enable_auto_login(name, password)
New in version 2016.3.0.

.sp
Configures the machine to auto login with the specified user
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The user account use for auto login
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\-
.sp
The password to user for auto login
.sp
New in version 2017.7.3.


.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.enable_auto_login stevej
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.get_auto_login()
New in version 2016.3.0.

.sp
Gets the current setting for Auto Login
.INDENT 7.0
.TP
.B Returns
If enabled, returns the user name, otherwise returns False
.TP
.B Return type
\fI\%str\fP, \fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.get_auto_login
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.getent(refresh=False)
Return the list of all info for all users
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.getent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.info(name)
Return user information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.info root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.list_groups(name)
Return a list of groups the named user belongs to.
.sp
name
.INDENT 7.0
.INDENT 3.5
The name of the user for which to list groups. Starting in Salt 2016.11.0,
all groups for the user, including groups beginning with an underscore
will be listed.
.sp
Changed in version 2016.11.0.

.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.list_groups foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.list_users()
Return a list of all users
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.list_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.primary_group(name)
Return the primary group of the named user
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.primary_group saltadmin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_user.rename(name, new_name)
Change the username for a named user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.rename name new_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mac_xattr
.sp
This module allows you to manage extended attributes on files or directories
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xattr.list /path/to/file
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_xattr.clear(path)
Causes the all attributes on the file/directory to be removed
.INDENT 7.0
.TP
.B Parameters
\fBpath\fP (\fI\%str\fP) \-\- The file(s) to get attributes from
.TP
.B Returns
True if successful, otherwise False
.TP
.B Raises
CommandExecutionError on file not found or any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xattr.delete /path/to/file \(dqcom.test.attr\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_xattr.delete(path, attribute)
Removes the given attribute from the file
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The file(s) to get attributes from
.IP \(bu 2
\fBattribute\fP (\fI\%str\fP) \-\- The attribute name to be deleted from the
file/directory
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
CommandExecutionError on file not found, attribute not found, and
any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xattr.delete /path/to/file \(dqcom.test.attr\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_xattr.list_(path, **kwargs)
List all of the extended attributes on the given file/directory
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The file(s) to get attributes from
.IP \(bu 2
\fBhex\fP (\fI\%bool\fP) \-\- Return the values with forced hexadecimal values
.UNINDENT
.TP
.B Returns
A dictionary containing extended attributes and values for the
given file
.TP
.B Return type
\fI\%dict\fP
.TP
.B Raises
CommandExecutionError on file not found or any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xattr.list /path/to/file
salt \(aq*\(aq xattr.list /path/to/file hex=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_xattr.read(path, attribute, **kwargs)
Read the given attributes on the given file/directory
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The file to get attributes from
.IP \(bu 2
\fBattribute\fP (\fI\%str\fP) \-\- The attribute to read
.IP \(bu 2
\fBhex\fP (\fI\%bool\fP) \-\- Return the values with forced hexadecimal values
.UNINDENT
.TP
.B Returns
A string containing the value of the named attribute
.TP
.B Return type
\fI\%str\fP
.TP
.B Raises
CommandExecutionError on file not found, attribute not found, and
any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xattr.read /path/to/file com.test.attr
salt \(aq*\(aq xattr.read /path/to/file com.test.attr hex=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mac_xattr.write(path, attribute, value, **kwargs)
Causes the given attribute name to be assigned the given value
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The file(s) to get attributes from
.IP \(bu 2
\fBattribute\fP (\fI\%str\fP) \-\- The attribute name to be written to the file/directory
.IP \(bu 2
\fBvalue\fP (\fI\%str\fP) \-\- The value to assign to the given attribute
.IP \(bu 2
\fBhex\fP (\fI\%bool\fP) \-\- Set the values with forced hexadecimal values
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
CommandExecutionError on file not found or any other unknown error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xattr.write /path/to/file \(dqcom.test.attr\(dq \(dqvalue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.macdefaults
.sp
Set defaults on Mac OS
.INDENT 0.0
.TP
.B salt.modules.macdefaults.delete(domain, key, user=None)
Delete a default from the system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq macdefaults.delete com.apple.CrashReporter DialogType

salt \(aq*\(aq macdefaults.delete NSGlobalDomain ApplePersistence
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B domain
The name of the domain to delete from
.TP
.B key
The key of the given domain to delete
.TP
.B user
The user to delete the defaults with
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.macdefaults.read(domain, key, user=None)
Read a default from the system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq macdefaults.read com.apple.CrashReporter DialogType

salt \(aq*\(aq macdefaults.read NSGlobalDomain ApplePersistence
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B domain
The name of the domain to read from
.TP
.B key
The key of the given domain to read from
.TP
.B user
The user to read the defaults as
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.macdefaults.write(domain, key, value, type=\(aqstring\(aq, user=None)
Write a default to the system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq macdefaults.write com.apple.CrashReporter DialogType Server

salt \(aq*\(aq macdefaults.write NSGlobalDomain ApplePersistence True type=bool
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B domain
The name of the domain to write to
.TP
.B key
The key of the given domain to write to
.TP
.B value
The value to write to the given key
.TP
.B type
The type of value to be written, valid types are string, data, int[eger],
float, bool[ean], date, array, array\-add, dict, dict\-add
.TP
.B user
The user to write the defaults to
.UNINDENT
.UNINDENT
.SS salt.modules.macpackage
.sp
Install pkg, dmg and .app applications on macOS minions.
.INDENT 0.0
.TP
.B salt.modules.macpackage.get_mpkg_ids(mpkg)
Attempt to get the package IDs from a mounted .mpkg file
.INDENT 7.0
.TP
.B Parameters
\fBmpkg\fP (\fI\%str\fP) \-\- The location of the mounted mpkg file
.TP
.B Returns
List of package IDs
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq macpackage.get_mpkg_ids /dev/disk2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.macpackage.get_pkg_id(pkg)
Attempt to get the package ID from a .pkg file
.INDENT 7.0
.TP
.B Parameters
\fBpkg\fP (\fI\%str\fP) \-\- The location of the pkg file
.TP
.B Returns
List of all of the package IDs
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq macpackage.get_pkg_id /tmp/test.pkg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.macpackage.install(pkg, target=\(aqLocalSystem\(aq, store=False, allow_untrusted=False)
Install a pkg file
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpkg\fP (\fI\%str\fP) \-\- The package to install
.IP \(bu 2
\fBtarget\fP (\fI\%str\fP) \-\- The target in which to install the package to
.IP \(bu 2
\fBstore\fP (\fI\%bool\fP) \-\- Should the package be installed as if it was from the
store?
.IP \(bu 2
\fBallow_untrusted\fP (\fI\%bool\fP) \-\- Allow the installation of untrusted packages?
.UNINDENT
.TP
.B Returns
A dictionary containing the results of the installation
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq macpackage.install test.pkg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.macpackage.install_app(app, target=\(aq/Applications/\(aq)
Install an app file by moving it into the specified Applications directory
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapp\fP (\fI\%str\fP) \-\- The location of the .app file
.IP \(bu 2
\fBtarget\fP (\fI\%str\fP) \-\- The target in which to install the package to
Default is \(aq\(aq/Applications/\(aq\(aq
.UNINDENT
.TP
.B Returns
The results of the rsync command
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq macpackage.install_app /tmp/tmp.app /Applications/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.macpackage.installed_pkgs()
Return the list of installed packages on the machine
.INDENT 7.0
.TP
.B Returns
List of installed packages
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq macpackage.installed_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.macpackage.mount(dmg)
Attempt to mount a dmg file to a temporary location and return the
location of the pkg file inside
.INDENT 7.0
.TP
.B Parameters
\fBdmg\fP (\fI\%str\fP) \-\- The location of the dmg file to mount
.TP
.B Returns
.INDENT 7.0
.TP
.B Tuple containing the results of the command along with the mount
point
.UNINDENT

.TP
.B Return type
\fI\%tuple\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq macpackage.mount /tmp/software.dmg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.macpackage.uninstall_app(app)
Uninstall an app file by removing it from the Applications directory
.INDENT 7.0
.TP
.B Parameters
\fBapp\fP (\fI\%str\fP) \-\- The location of the .app file
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq macpackage.uninstall_app /Applications/app.app
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.macpackage.unmount(mountpoint)
Attempt to unmount a dmg file from a temporary location
.INDENT 7.0
.TP
.B Parameters
\fBmountpoint\fP (\fI\%str\fP) \-\- The location of the mount point
.TP
.B Returns
The results of the hdutil detach command
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq macpackage.unmount /dev/disk2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.makeconf
.sp
Support for modifying make.conf under Gentoo
.INDENT 0.0
.TP
.B salt.modules.makeconf.append_cflags(value)
Add to or create a new CFLAGS in the make.conf
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.append_cflags \(aq\-pipe\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.append_cxxflags(value)
Add to or create a new CXXFLAGS in the make.conf
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.append_cxxflags \(aq\-pipe\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.append_emerge_default_opts(value)
Add to or create a new EMERGE_DEFAULT_OPTS in the make.conf
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.append_emerge_default_opts \(aq\-\-jobs\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.append_features(value)
Add to or create a new FEATURES in the make.conf
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.append_features \(aqwebrsync\-gpg\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.append_gentoo_mirrors(value)
Add to or create a new GENTOO_MIRRORS in the make.conf
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.append_gentoo_mirrors \(aqhttp://distfiles.gentoo.org\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.append_makeopts(value)
Add to or create a new MAKEOPTS in the make.conf
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.append_makeopts \(aq\-j3\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.append_var(var, value)
Add to or create a new variable in the make.conf
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.append_var \(aqLINGUAS\(aq \(aqen\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.cflags_contains(value)
Verify if CFLAGS variable contains a value in make.conf
.sp
Return True if value is set for var
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.cflags_contains \(aq\-pipe\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.chost_contains(value)
Verify if CHOST variable contains a value in make.conf
.sp
Return True if value is set for var
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.chost_contains \(aqx86_64\-pc\-linux\-gnu\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.cxxflags_contains(value)
Verify if CXXFLAGS variable contains a value in make.conf
.sp
Return True if value is set for var
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.cxxflags_contains \(aq\-pipe\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.emerge_default_opts_contains(value)
Verify if EMERGE_DEFAULT_OPTS variable contains a value in make.conf
.sp
Return True if value is set for var
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.emerge_default_opts_contains \(aq\-\-jobs\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.features_contains(value)
Verify if FEATURES variable contains a value in make.conf
.sp
Return True if value is set for var
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.features_contains \(aqwebrsync\-gpg\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.gentoo_mirrors_contains(value)
Verify if GENTOO_MIRRORS variable contains a value in make.conf
.sp
Return True if value is set for var
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.gentoo_mirrors_contains \(aqhttp://distfiles.gentoo.org\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.get_cflags()
Get the value of CFLAGS variable in the make.conf
.sp
Return the value of the variable or None if the variable is
not in the make.conf
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.get_cflags
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.get_chost()
Get the value of CHOST variable in the make.conf
.sp
Return the value of the variable or None if the variable is
not in the make.conf
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.get_chost
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.get_cxxflags()
Get the value of CXXFLAGS variable in the make.conf
.sp
Return the value of the variable or None if the variable is
not in the make.conf
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.get_cxxflags
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.get_emerge_default_opts()
Get the value of EMERGE_DEFAULT_OPTS variable in the make.conf
.sp
Return the value of the variable or None if the variable is
not in the make.conf
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.get_emerge_default_opts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.get_features()
Get the value of FEATURES variable in the make.conf
.sp
Return the value of the variable or None if the variable is
not in the make.conf
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.get_features
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.get_gentoo_mirrors()
Get the value of GENTOO_MIRRORS variable in the make.conf
.sp
Return the value of the variable or None if the variable is
not in the make.conf
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.get_gentoo_mirrors
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.get_makeopts()
Get the value of MAKEOPTS variable in the make.conf
.sp
Return the value of the variable or None if the variable is
not in the make.conf
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.get_makeopts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.get_sync()
Get the value of SYNC variable in the make.conf
.sp
Return the value of the variable or None if the variable is
not in the make.conf
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.get_sync
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.get_var(var)
Get the value of a variable in make.conf
.sp
Return the value of the variable or None if the variable is not in
make.conf
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.get_var \(aqLINGUAS\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.makeopts_contains(value)
Verify if MAKEOPTS variable contains a value in make.conf
.sp
Return True if value is set for var
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.makeopts_contains \(aq\-j3\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.remove_var(var)
Remove a variable from the make.conf
.sp
Return a dict containing the new value for the variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.remove_var \(aqLINGUAS\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.set_cflags(value)
Set the CFLAGS variable
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.set_cflags \(aq\-march=native \-O2 \-pipe\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.set_chost(value)
Set the CHOST variable
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.set_chost \(aqx86_64\-pc\-linux\-gnu\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.set_cxxflags(value)
Set the CXXFLAGS variable
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.set_cxxflags \(aq\-march=native \-O2 \-pipe\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.set_emerge_default_opts(value)
Set the EMERGE_DEFAULT_OPTS variable
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.set_emerge_default_opts \(aq\-\-jobs\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.set_gentoo_mirrors(value)
Set the GENTOO_MIRRORS variable
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.set_gentoo_mirrors \(aqhttp://distfiles.gentoo.org\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.set_makeopts(value)
Set the MAKEOPTS variable
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.set_makeopts \(aq\-j3\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.set_sync(value)
Set the SYNC variable
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.set_sync \(aqrsync://rsync.namerica.gentoo.org/gentoo\-portage\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.set_var(var, value)
Set a variable in the make.conf
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.set_var \(aqLINGUAS\(aq \(aqen\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.sync_contains(value)
Verify if SYNC variable contains a value in make.conf
.sp
Return True if value is set for var
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.sync_contains \(aqrsync://rsync.namerica.gentoo.org/gentoo\-portage\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.trim_cflags(value)
Remove a value from CFLAGS variable in the make.conf
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.trim_cflags \(aq\-pipe\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.trim_cxxflags(value)
Remove a value from CXXFLAGS variable in the make.conf
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.trim_cxxflags \(aq\-pipe\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.trim_emerge_default_opts(value)
Remove a value from EMERGE_DEFAULT_OPTS variable in the make.conf
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.trim_emerge_default_opts \(aq\-\-jobs\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.trim_features(value)
Remove a value from FEATURES variable in the make.conf
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.trim_features \(aqwebrsync\-gpg\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.trim_gentoo_mirrors(value)
Remove a value from GENTOO_MIRRORS variable in the make.conf
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.trim_gentoo_mirrors \(aqhttp://distfiles.gentoo.org\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.trim_makeopts(value)
Remove a value from MAKEOPTS variable in the make.conf
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.trim_makeopts \(aq\-j3\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.trim_var(var, value)
Remove a value from a variable in the make.conf
.sp
Return a dict containing the new value for variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<variable>\(aq: {\(aqold\(aq: \(aq<old\-value>\(aq,
                \(aqnew\(aq: \(aq<new\-value>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.trim_var \(aqLINGUAS\(aq \(aqen\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.makeconf.var_contains(var, value)
Verify if variable contains a value in make.conf
.sp
Return True if value is set for var
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq makeconf.var_contains \(aqLINGUAS\(aq \(aqen\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mandrill
.SS Mandrill
.sp
Send out emails using the \fI\%Mandrill\fP \fI\%API\fP\&.
.sp
In the minion configuration file, the following block is required:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mandrill:
  key: <API_KEY>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B salt.modules.mandrill.send(message, asynchronous=False, ip_pool=None, send_at=None, api_url=None, api_version=None, api_key=None)
Send out the email using the details from the \fBmessage\fP argument.
.INDENT 7.0
.TP
.B message
The information on the message to send. This argument must be
sent as dictionary with at fields as specified in the Mandrill API
documentation.
.TP
.B asynchronous: \fBFalse\fP
Enable a background sending mode that is optimized for bulk sending.
In asynchronous mode, messages/send will immediately return a status of
\(dqqueued\(dq for every recipient. To handle rejections when sending in asynchronous
mode, set up a webhook for the \(aqreject\(aq event. Defaults to false for
messages with no more than 10 recipients; messages with more than 10
recipients are always sent asynchronously, regardless of the value of
asynchronous.
.TP
.B ip_pool
The name of the dedicated ip pool that should be used to send the
message. If you do not have any dedicated IPs, this parameter has no
effect. If you specify a pool that does not exist, your default pool
will be used instead.
.TP
.B send_at
When this message should be sent as a UTC timestamp in
\fBYYYY\-MM\-DD HH:MM:SS\fP format. If you specify a time in the past,
the message will be sent immediately. An additional fee applies for
scheduled email, and this feature is only available to accounts with a
positive balance.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Fur further details please consult the \fI\%API documentation\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mandrill.send message=\(dq{\(aqsubject\(aq: \(aqHi\(aq, \(aqfrom_email\(aq: \(aqtest@example.com\(aq, \(aqto\(aq: [{\(aqemail\(aq: \(aqrecv@example.com\(aq, \(aqtype\(aq: \(aqto\(aq}]}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBmessage\fP structure example (as YAML for readability):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
message:
    text: |
        This is the body of the email.
        This is the second line.
    subject: Email subject
    from_name: Test At Example Dot Com
    from_email: test@example.com
    to:
      \- email: recv@example.com
        type: to
        name: Recv At Example Dot Com
      \- email: cc@example.com
        type: cc
        name: CC At Example Dot Com
    important: true
    track_clicks: true
    track_opens: true
    attachments:
      \- type: text/x\-yaml
        name: yaml_file.yml
        content: aV9hbV9zdXBlcl9jdXJpb3VzOiB0cnVl
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
minion:
    \-\-\-\-\-\-\-\-\-\-
    comment:
    out:
        |_
          \-\-\-\-\-\-\-\-\-\-
          _id:
              c4353540a3c123eca112bbdd704ab6
          email:
              recv@example.com
          reject_reason:
              None
          status:
              sent
    result:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.marathon
.sp
Module providing a simple management interface to a marathon cluster.
.sp
Currently this only works when run through a proxy minion.
.sp
New in version 2015.8.2.

.INDENT 0.0
.TP
.B salt.modules.marathon.app(id)
Return the current server configuration for the specified app.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt marathon\-minion\-id marathon.app my\-app
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.marathon.apps()
Return a list of the currently installed app ids.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt marathon\-minion\-id marathon.apps
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.marathon.has_app(id)
Return whether the given app id is currently configured.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt marathon\-minion\-id marathon.has_app my\-app
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.marathon.info()
Return configuration and status information about the marathon instance.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt marathon\-minion\-id marathon.info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.marathon.restart_app(id, restart=False, force=True)
Restart the current server configuration for the specified app.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrestart\fP \-\- Restart the app
.IP \(bu 2
\fBforce\fP \-\- Override the current deployment
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt marathon\-minion\-id marathon.restart_app my\-app
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default, this will only check if the app exists in marathon. It does
not check if there are any tasks associated with it or if the app is suspended.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt marathon\-minion\-id marathon.restart_app my\-app true true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The restart option needs to be set to True to actually issue a rolling
restart to marathon.
.sp
The force option tells marathon to ignore the current app deployment if
there is one.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.marathon.rm_app(id)
Remove the specified app from the server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt marathon\-minion\-id marathon.rm_app my\-app
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.marathon.update_app(id, config)
Update the specified app with the given configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt marathon\-minion\-id marathon.update_app my\-app \(aq<config yaml>\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.match
.sp
The match module allows for match routines to be run and determine target specs
.INDENT 0.0
.TP
.B salt.modules.match.compound(tgt, minion_id=None)
Return True if the minion ID matches the given compound target
.INDENT 7.0
.TP
.B minion_id
Specify the minion ID to match against the target expression
.sp
New in version 2014.7.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq match.compound \(aqL@cheese,foo and *\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.match.data(tgt)
Return True if the minion matches the given data target
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq match.data \(aqspam:eggs\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.match.filter_by(lookup, tgt_type=\(aqcompound\(aq, minion_id=None, merge=None, merge_lists=False, default=\(aqdefault\(aq)
Return the first match in a dictionary of target patterns
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq match.filter_by \(aq{foo*: Foo!, bar*: Bar!}\(aq minion_id=bar03
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pillar Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Filter the data for the current minion into a variable:
{% set roles = salt[\(aqmatch.filter_by\(aq]({
    \(aqweb*\(aq: [\(aqapp\(aq, \(aqcaching\(aq],
    \(aqdb*\(aq: [\(aqdb\(aq],
}, minion_id=grains[\(aqid\(aq], default=\(aqweb*\(aq) %}

# Make the filtered data available to Pillar:
roles: {{ roles | yaml() }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.match.glob(tgt, minion_id=None)
Return True if the minion ID matches the given glob target
.INDENT 7.0
.TP
.B minion_id
Specify the minion ID to match against the target expression
.sp
New in version 2014.7.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq match.glob \(aq*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.match.grain(tgt, delimiter=\(aq:\(aq)
Return True if the minion matches the given grain target. The \fBdelimiter\fP
argument can be used to specify a different delimiter.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq match.grain \(aqos:Ubuntu\(aq
salt \(aq*\(aq match.grain \(aqipv6|2001:db8::ff00:42:8329\(aq delimiter=\(aq|\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B delimiter
Specify an alternate delimiter to use when traversing a nested dict
.sp
New in version 2014.7.0.

.TP
.B delim
Specify an alternate delimiter to use when traversing a nested dict
.sp
New in version 0.16.4.

.sp
Deprecated since version 2015.8.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.match.grain_pcre(tgt, delimiter=\(aq:\(aq)
Return True if the minion matches the given grain_pcre target. The
\fBdelimiter\fP argument can be used to specify a different delimiter.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq match.grain_pcre \(aqos:Fedo.*\(aq
salt \(aq*\(aq match.grain_pcre \(aqipv6|2001:.*\(aq delimiter=\(aq|\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B delimiter
Specify an alternate delimiter to use when traversing a nested dict
.sp
New in version 2014.7.0.

.TP
.B delim
Specify an alternate delimiter to use when traversing a nested dict
.sp
New in version 0.16.4.

.sp
Deprecated since version 2015.8.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.match.ifelse(*args, tgt_type=\(aqcompound\(aq, minion_id=None, merge=None, merge_lists=False)
New in version 3006.0.

.sp
Evaluate each pair of arguments up to the last one as a (matcher, value)
tuple, returning \fBvalue\fP if matched.  If none match, returns the last
argument.
.sp
The \fBifelse\fP function is like a multi\-level if\-else statement. It was
inspired by CFEngine\(aqs \fBifelse\fP function which in turn was inspired by
Oracle\(aqs \fBDECODE\fP function. It must have an odd number of arguments (from
1 to N). The last argument is the default value, like the \fBelse\fP clause in
standard programming languages. Every pair of arguments before the last one
are evaluated as a pair. If the first one evaluates true then the second one
is returned, as if you had used the first one in a compound match
expression. Boolean values can also be used as the first item in a pair,
as it will be translated to a match that will always match (\(dq*\(dq) or never
match (\(dqSALT_IFELSE_MATCH_NOTHING\(dq) a target system.
.sp
This is essentially another way to express the \fBfilter_by\fP functionality
in way that\(aqs familiar to CFEngine or Oracle users. Consider using
\fBfilter_by\fP unless this function fits your workflow.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq match.ifelse \(aqfoo*\(aq \(aqFoo!\(aq \(aqbar*\(aq \(aqBar!\(aq minion_id=bar03
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.match.ipcidr(tgt)
Return True if the minion matches the given ipcidr target
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq match.ipcidr \(aq192.168.44.0/24\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
delimiter
Pillar Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\(aq172.16.0.0/12\(aq:
  \- match: ipcidr
  \- nodeclass: internal
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.match.list_(tgt, minion_id=None)
Return True if the minion ID matches the given list target
.INDENT 7.0
.TP
.B minion_id
Specify the minion ID to match against the target expression
.sp
New in version 2014.7.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq match.list \(aqserver1,server2\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.match.pcre(tgt, minion_id=None)
Return True if the minion ID matches the given pcre target
.INDENT 7.0
.TP
.B minion_id
Specify the minion ID to match against the target expression
.sp
New in version 2014.7.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq match.pcre \(aq.*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.match.pillar(tgt, delimiter=\(aq:\(aq)
Return True if the minion matches the given pillar target. The
\fBdelimiter\fP argument can be used to specify a different delimiter.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq match.pillar \(aqcheese:foo\(aq
salt \(aq*\(aq match.pillar \(aqclone_url|https://github.com/saltstack/salt.git\(aq delimiter=\(aq|\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B delimiter
Specify an alternate delimiter to use when traversing a nested dict
.sp
New in version 2014.7.0.

.TP
.B delim
Specify an alternate delimiter to use when traversing a nested dict
.sp
New in version 0.16.4.

.sp
Deprecated since version 2015.8.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.match.pillar_pcre(tgt, delimiter=\(aq:\(aq)
Return True if the minion matches the given pillar_pcre target. The
\fBdelimiter\fP argument can be used to specify a different delimiter.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq match.pillar_pcre \(aqcheese:(swiss|american)\(aq
salt \(aq*\(aq match.pillar_pcre \(aqclone_url|https://github\e.com/.*\e.git\(aq delimiter=\(aq|\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B delimiter
Specify an alternate delimiter to use when traversing a nested dict
.sp
New in version 2014.7.0.

.TP
.B delim
Specify an alternate delimiter to use when traversing a nested dict
.sp
New in version 0.16.4.

.sp
Deprecated since version 2015.8.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.match.search_by(lookup, tgt_type=\(aqcompound\(aq, minion_id=None)
Search a dictionary of target strings for matching targets
.sp
This is the inverse of \fI\%match.filter_by\fP and allows matching values instead of
matching keys. A minion can be matched by multiple entries.
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq match.search_by \(aq{web: [node1, node2], db: [node2, node]}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pillar Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set roles = salt.match.search_by({
    \(aqweb\(aq: [\(aqG@os_family:Debian not nodeX\(aq],
    \(aqdb\(aq: [\(aqL@node2,node3 and G@datacenter:west\(aq],
    \(aqcaching\(aq: [\(aqnode3\(aq, \(aqnode4\(aq],
}) %}

# Make the filtered data available to Pillar:
roles: {{ roles | yaml() }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mattermost
.sp
Module for sending messages to Mattermost
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B configuration
This module can be used by either passing an api_url and hook
directly or by specifying both in a configuration profile in the salt
master/minion config. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mattermost:
  hook: peWcBiMOS9HrZG15peWcBiMOS9HrZG15
  api_url: https://example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mattermost.post_message(message, channel=None, username=None, api_url=None, hook=None)
Send a message to a Mattermost channel.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBchannel\fP \-\- The channel name, either will work.
.IP \(bu 2
\fBusername\fP \-\- The username of the poster.
.IP \(bu 2
\fBmessage\fP \-\- The message to send to the Mattermost channel.
.IP \(bu 2
\fBapi_url\fP \-\- The Mattermost api url, if not specified in the configuration.
.IP \(bu 2
\fBhook\fP \-\- The Mattermost hook, if not specified in the configuration.
.UNINDENT
.TP
.B Returns
Boolean if message was sent successfully.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mattermost.post_message message=\(aqBuild is done\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mdadm_raid
.sp
Salt module to manage RAID arrays with mdadm
.INDENT 0.0
.TP
.B salt.modules.mdadm_raid.add(name, device)
Add new device to RAID array.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq raid.add /dev/md0 /dev/sda1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mdadm_raid.assemble(name, devices, test_mode=False, **kwargs)
Assemble a RAID device.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq raid.assemble /dev/md0 [\(aq/dev/xvdd\(aq, \(aq/dev/xvde\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Adding \fBtest_mode=True\fP as an argument will print out the mdadm
command that would have been run.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the array to assemble.
.TP
.B devices
The list of devices comprising the array to assemble.
.TP
.B kwargs
Optional arguments to be passed to mdadm.
.TP
.B returns
.INDENT 7.0
.TP
.B test_mode=True:
Prints out the full command.
.TP
.B test_mode=False (Default):
Executes command on the host(s) and prints out the mdadm output.
.UNINDENT
.UNINDENT
.sp
For more info, read the \fBmdadm\fP manpage.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mdadm_raid.create(name, level, devices, metadata=\(aqdefault\(aq, test_mode=False, **kwargs)
Create a RAID device.
.sp
Changed in version 2014.7.0.

.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Use with CAUTION, as this function can be very destructive if not used
properly!
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq raid.create /dev/md0 level=1 chunk=256 devices=\(dq[\(aq/dev/xvdd\(aq, \(aq/dev/xvde\(aq]\(dq test_mode=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Adding \fBtest_mode=True\fP as an argument will print out the mdadm
command that would have been run.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the array to create.
.TP
.B level
The RAID level to use when creating the raid.
.TP
.B devices
A list of devices used to build the array.
.TP
.B metadata
Version of metadata to use when creating the array.
.TP
.B kwargs
Optional arguments to be passed to mdadm.
.TP
.B returns
.INDENT 7.0
.TP
.B test_mode=True:
Prints out the full command.
.TP
.B test_mode=False (Default):
Executes command on remote the host(s) and
Prints out the mdadm output.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
It takes time to create a RAID array. You can check the progress in
\(dqresync_status:\(dq field of the results from the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq raid.detail /dev/md0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
For more info, read the \fBmdadm(8)\fP manpage
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mdadm_raid.destroy(device)
Destroy a RAID device.
.sp
WARNING This will zero the superblock of all members of the RAID array..
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq raid.destroy /dev/md0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mdadm_raid.detail(device=\(aq/dev/md0\(aq)
Show detail for a specified RAID device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq raid.detail \(aq/dev/md0\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mdadm_raid.examine(device, quiet=False)
Show detail for a specified RAID component device
.INDENT 7.0
.TP
.B device
Device to examine, that is part of the RAID
.TP
.B quiet
If the device is not part of the RAID, do not show any error
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq raid.examine \(aq/dev/sda1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mdadm_raid.list_()
List the RAID devices.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq raid.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mdadm_raid.save_config()
Save RAID configuration to config file.
.sp
Same as:
mdadm \-\-detail \-\-scan >> /etc/mdadm/mdadm.conf
.sp
Fixes this issue with Ubuntu
REF: \fI\%http://askubuntu.com/questions/209702/why\-is\-my\-raid\-dev\-md1\-showing\-up\-as\-dev\-md126\-is\-mdadm\-conf\-being\-ignored\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq raid.save_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mdadm_raid.stop()
Shut down all arrays that can be shut down (i.e. are not currently in use).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq raid.stop
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mdata
.sp
Module for managaging metadata in SmartOS Zones
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B platform
smartos
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mdata.delete_(*keyname)
Delete metadata
.INDENT 7.0
.TP
.B prop
string
name of property
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mdata.get salt:role
salt \(aq*\(aq mdata.get user\-script salt:role
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mdata.get_(*keyname)
Get metadata
.INDENT 7.0
.TP
.B keyname
string
name of key
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If no keynames are specified, we get all (public) properties
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mdata.get salt:role
salt \(aq*\(aq mdata.get user\-script salt:role
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mdata.list_()
List available metadata
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mdata.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mdata.put_(keyname, val)
Put metadata
.INDENT 7.0
.TP
.B prop
string
name of property
.TP
.B val
string
value to set
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mdata.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.memcached
.sp
Module for Management of Memcached Keys
.sp
New in version 2014.1.0.

.INDENT 0.0
.TP
.B salt.modules.memcached.add(key, value, host=\(aq127.0.0.1\(aq, port=11211, time=0, min_compress_len=0)
Add a key to the memcached server, but only if it does not exist. Returns
False if the key already exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq memcached.add <key> <value>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.memcached.decr(key, delta=1, host=\(aq127.0.0.1\(aq, port=11211)
This function is an alias of \fBdecrement\fP\&.
.INDENT 7.0
.INDENT 3.5
Decrement the value of a key
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq memcached.decrement <key>
salt \(aq*\(aq memcached.decrement <key> 2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.memcached.decrement(key, delta=1, host=\(aq127.0.0.1\(aq, port=11211)
Decrement the value of a key
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq memcached.decrement <key>
salt \(aq*\(aq memcached.decrement <key> 2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.memcached.delete(key, host=\(aq127.0.0.1\(aq, port=11211, time=0)
Delete a key from memcache server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq memcached.delete <key>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.memcached.get(key, host=\(aq127.0.0.1\(aq, port=11211)
Retrieve value for a key
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq memcached.get <key>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.memcached.incr(key, delta=1, host=\(aq127.0.0.1\(aq, port=11211)
This function is an alias of \fBincrement\fP\&.
.INDENT 7.0
.INDENT 3.5
Increment the value of a key
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq memcached.increment <key>
salt \(aq*\(aq memcached.increment <key> 2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.memcached.increment(key, delta=1, host=\(aq127.0.0.1\(aq, port=11211)
Increment the value of a key
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq memcached.increment <key>
salt \(aq*\(aq memcached.increment <key> 2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.memcached.replace(key, value, host=\(aq127.0.0.1\(aq, port=11211, time=0, min_compress_len=0)
Replace a key on the memcached server. This only succeeds if the key
already exists. This is the opposite of \fI\%memcached.add\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq memcached.replace <key> <value>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.memcached.set_(key, value, host=\(aq127.0.0.1\(aq, port=11211, time=0, min_compress_len=0)
Set a key on the memcached server, overwriting the value if it exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq memcached.set <key> <value>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.memcached.status(host=\(aq127.0.0.1\(aq, port=11211)
Get memcached status
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq memcached.status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mine
.sp
The function cache system allows for data to be stored on the master so it can be easily read by other minions
.INDENT 0.0
.TP
.B salt.modules.mine.delete(fun)
Remove specific function contents of minion.
.INDENT 7.0
.TP
.B Parameters
\fBfun\fP (\fI\%str\fP) \-\- The name of the function.
.TP
.B Return type
\fI\%bool\fP
.TP
.B Returns
True on success.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mine.delete \(aqnetwork.interfaces\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mine.flush()
Remove all mine contents of minion.
.INDENT 7.0
.TP
.B Return type
\fI\%bool\fP
.TP
.B Returns
True on success
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mine.flush
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mine.get(tgt, fun, tgt_type=\(aqglob\(aq, exclude_minion=False)
Get data from the mine.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtgt\fP (\fI\%str\fP) \-\- Target whose mine data to get.
.IP \(bu 2
\fBfun\fP (\fI\%str\fP\fI or \fP\fI\%list\fP) \-\- Function to get the mine data of. You can specify multiple functions
to retrieve using either a list or a comma\-separated string of functions.
.IP \(bu 2
\fBtgt_type\fP (\fI\%str\fP) \-\- Default \fBglob\fP\&. Target type to use with \fBtgt\fP\&.
See \fI\%Targeting Minions\fP for more information.
Note that all pillar matches, whether using the compound matching system or
the pillar matching system, will be exact matches, with globbing disabled.
.IP \(bu 2
\fBexclude_minion\fP (\fI\%bool\fP) \-\- Excludes the current minion from the result set.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mine.get \(aq*\(aq network.interfaces
salt \(aq*\(aq mine.get \(aqos:Fedora\(aq network.interfaces grain
salt \(aq*\(aq mine.get \(aqG@os:Fedora and S@192.168.5.0/24\(aq network.ipaddrs compound
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
Retrieving Mine data from Pillar and Orchestrate
.sp
This execution module is intended to be executed on minions.
Master\-side operations such as Pillar or Orchestrate that require Mine
data should use the \fI\%Mine Runner module\fP
instead; it can be invoked from a Pillar SLS file using the
\fI\%saltutil.runner\fP module. For
example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set minion_ips = salt.saltutil.runner(\(aqmine.get\(aq,
    tgt=\(aq*\(aq,
    fun=\(aqnetwork.ip_addrs\(aq,
    tgt_type=\(aqglob\(aq) %}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mine.get_docker(interfaces=None, cidrs=None, with_container_id=False)
Changed in version 2017.7.8,2018.3.3: When \fI\%docker.update_mine\fP is set to \fBFalse\fP for a given
minion, no mine data will be populated for that minion, and thus none
will be returned for it.

.sp
Changed in version 2019.2.0: \fI\%docker.update_mine\fP now defaults to \fBFalse\fP

.sp
Get all mine data for \fI\%docker.ps\fP and
run an aggregation routine. The \fBinterfaces\fP parameter allows for
specifying the network interfaces from which to select IP addresses. The
\fBcidrs\fP parameter allows for specifying a list of subnets which the IP
address must match.
.INDENT 7.0
.TP
.B with_container_id
Boolean, to expose container_id in the list of results
.sp
New in version 2015.8.2.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mine.get_docker
salt \(aq*\(aq mine.get_docker interfaces=\(aqeth0\(aq
salt \(aq*\(aq mine.get_docker interfaces=\(aq[\(dqeth0\(dq, \(dqeth1\(dq]\(aq
salt \(aq*\(aq mine.get_docker cidrs=\(aq107.170.147.0/24\(aq
salt \(aq*\(aq mine.get_docker cidrs=\(aq[\(dq107.170.147.0/24\(dq, \(dq172.17.42.0/24\(dq]\(aq
salt \(aq*\(aq mine.get_docker interfaces=\(aq[\(dqeth0\(dq, \(dqeth1\(dq]\(aq cidrs=\(aq[\(dq107.170.147.0/24\(dq, \(dq172.17.42.0/24\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mine.send(name, *args, **kwargs)
Send a specific function and its result to the salt mine.
This gets stored in either the local cache, or the salt master\(aqs cache.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- Name of the function to add to the mine.
.UNINDENT
.sp
The following pameters are extracted from kwargs if present:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmine_function\fP (\fI\%str\fP) \-\- The name of the execution_module.function to run
and whose value will be stored in the salt mine. Defaults to \fBname\fP\&.
.IP \(bu 2
\fBallow_tgt\fP (\fI\%str\fP) \-\- Targeting specification for ACL. Specifies which minions
are allowed to access this function. Please note both your master and
minion need to be on, at least, version 3000 for this to work properly.
.IP \(bu 2
\fBallow_tgt_type\fP (\fI\%str\fP) \-\- Type of the targeting specification. This value will
be ignored if \fBallow_tgt\fP is not specified. Please note both your
master and minion need to be on, at least, version 3000 for this to work
properly.
.UNINDENT
.UNINDENT
.sp
Remaining args and kwargs will be passed on to the function to run.
.INDENT 7.0
.TP
.B Return type
\fI\%bool\fP
.TP
.B Returns
Whether executing the function and storing the information was successful.
.UNINDENT
.sp
Changed in version 3000: Added \fBallow_tgt\fP\- and \fBallow_tgt_type\fP\-parameters to specify which
minions are allowed to access this function.
See \fI\%Targeting Minions\fP for more information about targeting.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mine.send network.ip_addrs interface=eth0
salt \(aq*\(aq mine.send eth0_ip_addrs mine_function=network.ip_addrs interface=eth0
salt \(aq*\(aq mine.send eth0_ip_addrs mine_function=network.ip_addrs interface=eth0 allow_tgt=\(aqG@grain:value\(aq allow_tgt_type=compound
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mine.update(clear=False, mine_functions=None)
Call the configured functions and send the data back up to the master.
The functions to be called are merged from the master config, pillar and
minion config under the option \fImine_functions\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mine_functions:
  network.ip_addrs:
    \- eth0
  disk.usage: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This function accepts the following arguments:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBclear\fP (\fI\%bool\fP) \-\- Default: \fBFalse\fP
Specifies whether updating will clear the existing values (\fBTrue\fP), or
whether it will update them (\fBFalse\fP).
.IP \(bu 2
\fBmine_functions\fP (\fI\%dict\fP) \-\-
.sp
Update (or clear, see \fBclear\fP) the mine data on these functions only.
This will need to have the structure as defined on
\fI\%https://docs.saltproject.io/en/latest/topics/mine/index.html#mine\-functions\fP
.sp
This feature can be used when updating the mine for functions
that require a refresh at different intervals than the rest of
the functions specified under \fImine_functions\fP in the
minion/master config or pillar.
A potential use would be together with the \fIscheduler\fP, for example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  lldp_mine_update:
    function: mine.update
    kwargs:
        mine_functions:
          net.lldp: []
    hours: 12
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the example above, the mine for \fInet.lldp\fP would be refreshed
every 12 hours, while  \fInetwork.ip_addrs\fP would continue to be updated
as specified in \fImine_interval\fP\&.

.UNINDENT
.UNINDENT
.sp
The function cache will be populated with information from executing these
functions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mine.update
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mine.valid()
List valid entries in mine configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mine.valid
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.minion
.sp
Module to provide information about minions
.INDENT 0.0
.TP
.B salt.modules.minion.kill(timeout=15)
Kill the salt minion.
.INDENT 7.0
.TP
.B timeout
int seconds to wait for the minion to die.
.UNINDENT
.sp
If you have a monitor that restarts \fBsalt\-minion\fP when it dies then this is
a great way to restart after a minion upgrade.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion[12] minion.kill

minion1:
    \-\-\-\-\-\-\-\-\-\-
    killed:
        7874
    retcode:
        0
minion2:
    \-\-\-\-\-\-\-\-\-\-
    killed:
        29071
    retcode:
        0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The result of the salt command shows the process ID of the minions and the
results of a kill signal to the minion in as the \fBretcode\fP value: \fB0\fP
is success, anything else is a failure.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.minion.list_()
Return a list of accepted, denied, unaccepted and rejected keys.
This is the same output as \fIsalt\-key \-L\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmaster\(aq minion.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.minion.restart()
Kill and restart the salt minion.
.sp
The configuration key \fBminion_restart_command\fP is an argv list for the
command to restart the minion.  If \fBminion_restart_command\fP is not
specified or empty then the \fBargv\fP of the current process will be used.
.sp
if the configuration value \fBminion_restart_command\fP is not set and the
\fB\-d\fP (daemonize) argument is missing from \fBargv\fP then the minion
\fIwill\fP be killed but will \fInot\fP be restarted and will require the parent
process to perform the restart.  This behavior is intended for managed
salt minion processes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion[12] minion.restart

minion1:
    \-\-\-\-\-\-\-\-\-\-
    comment:
        \- Restart using process argv:
        \-     /home/omniture/install/bin/salt\-minion
        \-     \-d
        \-     \-c
        \-     /home/omniture/install/etc/salt
    killed:
        10070
    restart:
        \-\-\-\-\-\-\-\-\-\-
        stderr:
        stdout:
    retcode:
        0
minion2:
    \-\-\-\-\-\-\-\-\-\-
    comment:
        \- Using configuration minion_restart_command:
        \-     /home/omniture/install/bin/salt\-minion
        \-     \-\-not\-an\-option
        \-     \-d
        \-     \-c
        \-     /home/omniture/install/etc/salt
        \- Restart failed
    killed:
        10896
    restart:
        \-\-\-\-\-\-\-\-\-\-
        stderr:
            Usage: salt\-minion

            salt\-minion: error: no such option: \-\-not\-an\-option
        stdout:
    retcode:
        64
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The result of the command shows the process ID of \fBminion1\fP that is
shutdown (killed) and the results of the restart.  If there is a failure
in the restart it will be reflected in a non\-zero \fBretcode\fP and possibly
output in the \fBstderr\fP and/or \fBstdout\fP values along with addition
information in the \fBcomment\fP field as is demonstrated with \fBminion2\fP\&.
.UNINDENT
.SS salt.modules.mod_random
.SS Provides access to randomness generators.
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B salt.modules.mod_random.get_str(length=20, chars=None, lowercase=True, uppercase=True, digits=True, punctuation=True, whitespace=False, printable=False)
New in version 2014.7.0.

.sp
Changed in version 3004: Changed the default character set used to include symbols and implemented arguments to control the used character set.

.sp
Returns a random string of the specified length.
.INDENT 7.0
.TP
.B length
20
Any valid number of bytes.
.TP
.B chars
None
New in version 3004.

.sp
String with any character that should be used to generate random string.
.sp
This argument supersedes all other character controlling arguments.
.TP
.B lowercase
True
New in version 3004.

.sp
Use lowercase letters in generated random string.
(see \fI\%string.ascii_lowercase\fP)
.sp
This argument is superseded by chars.
.TP
.B uppercase
True
New in version 3004.

.sp
Use uppercase letters in generated random string.
(see \fI\%string.ascii_uppercase\fP)
.sp
This argument is superseded by chars.
.TP
.B digits
True
New in version 3004.

.sp
Use digits in generated random string.
(see \fI\%string.digits\fP)
.sp
This argument is superseded by chars.
.TP
.B printable
False
New in version 3004.

.sp
Use printable characters in generated random string and includes lowercase, uppercase,
digits, punctuation and whitespace.
(see \fI\%string.printable\fP)
.sp
It is disabled by default as includes whitespace characters which some systems do not
handle well in passwords.
This argument also supersedes all other classes because it includes them.
.sp
This argument is superseded by chars.
.TP
.B punctuation
True
New in version 3004.

.sp
Use punctuation characters in generated random string.
(see \fI\%string.punctuation\fP)
.sp
This argument is superseded by chars.
.TP
.B whitespace
False
New in version 3004.

.sp
Use whitespace characters in generated random string.
(see \fI\%string.whitespace\fP)
.sp
It is disabled by default as some systems do not handle whitespace characters in passwords
well.
.sp
This argument is superseded by chars.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq random.get_str 128
salt \(aq*\(aq random.get_str 128 chars=\(aqabc123.!()\(aq
salt \(aq*\(aq random.get_str 128 lowercase=False whitespace=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mod_random.hash(value, algorithm=\(aqsha512\(aq)
New in version 2014.7.0.

.sp
Encodes a value with the specified encoder.
.INDENT 7.0
.TP
.B value
The value to be hashed.
.TP
.B algorithm
sha512
The algorithm to use. May be any valid algorithm supported by
hashlib.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq random.hash \(aqI am a string\(aq md5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mod_random.rand_int(start=1, end=10, seed=None)
Returns a random integer number between the start and end number.
.sp
New in version 2015.5.3.

.INDENT 7.0
.TP
.B start
1
Any valid integer number
.TP
.B end
10
Any valid integer number
.TP
.B seed :
Optional hashable object
.UNINDENT
.sp
Changed in version 2019.2.0: Added seed argument. Will return the same result when run with the same seed.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq random.rand_int 1 10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mod_random.sample(value, size, seed=None)
Return a given sample size from a list. By default, the random number
generator uses the current system time unless given a seed value.
.sp
New in version 3005.

.INDENT 7.0
.TP
.B value
A list to e used as input.
.TP
.B size
The sample size to return.
.TP
.B seed
Any value which will be hashed as a seed for random.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq random.sample \(aq[\(dqone\(dq, \(dqtwo\(dq]\(aq 1 seed=\(dqsomething\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mod_random.seed(range=10, hash=None)
Returns a random number within a range. Optional hash argument can
be any hashable object. If hash is omitted or None, the id of the minion is used.
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B hash: None
Any hashable object.
.TP
.B range: 10
Any valid integer number
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq random.seed 10 hash=None
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mod_random.shadow_hash(crypt_salt=None, password=None, algorithm=\(aqsha512\(aq)
Generates a salted hash suitable for /etc/shadow.
.INDENT 7.0
.TP
.B crypt_salt
None
Salt to be used in the generation of the hash. If one is not
provided, a random salt will be generated.
.TP
.B password
None
Value to be salted and hashed. If one is not provided, a random
password will be generated.
.TP
.B algorithm
sha512
Hash algorithm to use.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq random.shadow_hash \(aqMy5alT\(aq \(aqMyP@asswd\(aq md5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mod_random.shuffle(value, seed=None)
Return a shuffled copy of an input list. By default, the random number
generator uses the current system time unless given a seed value.
.sp
New in version 3005.

.INDENT 7.0
.TP
.B value
A list to be used as input.
.TP
.B seed
Any value which will be hashed as a seed for random.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq random.shuffle \(aq[\(dqone\(dq, \(dqtwo\(dq]\(aq seed=\(dqsomething\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mod_random.str_encode(value, encoder=\(aqbase64\(aq)
New in version 2014.7.0.

.INDENT 7.0
.TP
.B value
The value to be encoded.
.TP
.B encoder
base64
The encoder to use on the subsequent string.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq random.str_encode \(aqI am a new string\(aq base64
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.modjk
.sp
Control Modjk via the Apache Tomcat \(dqStatus\(dq worker
(\fI\%http://tomcat.apache.org/connectors\-doc/reference/status.html\fP)
.sp
Below is an example of the configuration needed for this module. This
configuration data can be placed either in \fI\%grains\fP or \fI\%pillar\fP\&.
.sp
If using grains, this can be accomplished \fI\%statically\fP or via a \fI\%grain module\fP\&.
.sp
If using pillar, the yaml configuration can be placed directly into a pillar
SLS file, making this both the easier and more dynamic method of configuring
this module.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
modjk:
  default:
    url: http://localhost/jkstatus
    user: modjk
    pass: secret
    realm: authentication realm for digest passwords
    timeout: 5
  otherVhost:
    url: http://otherVhost/jkstatus
    user: modjk
    pass: secret2
    realm: authentication realm2 for digest passwords
    timeout: 600
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.bulk_activate(workers, lbn, profile=\(aqdefault\(aq)
Activate all the given workers in the specific load balancer
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.bulk_activate node1,node2,node3 loadbalancer1
salt \(aq*\(aq modjk.bulk_activate node1,node2,node3 loadbalancer1 other\-profile

salt \(aq*\(aq modjk.bulk_activate [\(dqnode1\(dq,\(dqnode2\(dq,\(dqnode3\(dq] loadbalancer1
salt \(aq*\(aq modjk.bulk_activate [\(dqnode1\(dq,\(dqnode2\(dq,\(dqnode3\(dq] loadbalancer1 other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.bulk_disable(workers, lbn, profile=\(aqdefault\(aq)
Disable all the given workers in the specific load balancer
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.bulk_disable node1,node2,node3 loadbalancer1
salt \(aq*\(aq modjk.bulk_disable node1,node2,node3 loadbalancer1 other\-profile

salt \(aq*\(aq modjk.bulk_disable [\(dqnode1\(dq,\(dqnode2\(dq,\(dqnode3\(dq] loadbalancer1
salt \(aq*\(aq modjk.bulk_disable [\(dqnode1\(dq,\(dqnode2\(dq,\(dqnode3\(dq] loadbalancer1 other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.bulk_recover(workers, lbn, profile=\(aqdefault\(aq)
Recover all the given workers in the specific load balancer
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.bulk_recover node1,node2,node3 loadbalancer1
salt \(aq*\(aq modjk.bulk_recover node1,node2,node3 loadbalancer1 other\-profile

salt \(aq*\(aq modjk.bulk_recover [\(dqnode1\(dq,\(dqnode2\(dq,\(dqnode3\(dq] loadbalancer1
salt \(aq*\(aq modjk.bulk_recover [\(dqnode1\(dq,\(dqnode2\(dq,\(dqnode3\(dq] loadbalancer1 other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.bulk_stop(workers, lbn, profile=\(aqdefault\(aq)
Stop all the given workers in the specific load balancer
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.bulk_stop node1,node2,node3 loadbalancer1
salt \(aq*\(aq modjk.bulk_stop node1,node2,node3 loadbalancer1 other\-profile

salt \(aq*\(aq modjk.bulk_stop [\(dqnode1\(dq,\(dqnode2\(dq,\(dqnode3\(dq] loadbalancer1
salt \(aq*\(aq modjk.bulk_stop [\(dqnode1\(dq,\(dqnode2\(dq,\(dqnode3\(dq] loadbalancer1 other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.dump_config(profile=\(aqdefault\(aq)
Dump the original configuration that was loaded from disk
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.dump_config
salt \(aq*\(aq modjk.dump_config other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.get_running(profile=\(aqdefault\(aq)
Get the current running config (not from disk)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.get_running
salt \(aq*\(aq modjk.get_running other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.lb_edit(lbn, settings, profile=\(aqdefault\(aq)
Edit the loadbalancer settings
.sp
Note: \fI\%http://tomcat.apache.org/connectors\-doc/reference/status.html\fP
Data Parameters for the standard Update Action
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.lb_edit loadbalancer1 \(dq{\(aqvlr\(aq: 1, \(aqvlt\(aq: 60}\(dq
salt \(aq*\(aq modjk.lb_edit loadbalancer1 \(dq{\(aqvlr\(aq: 1, \(aqvlt\(aq: 60}\(dq other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.list_configured_members(lbn, profile=\(aqdefault\(aq)
Return a list of member workers from the configuration files
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.list_configured_members loadbalancer1
salt \(aq*\(aq modjk.list_configured_members loadbalancer1 other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.recover_all(lbn, profile=\(aqdefault\(aq)
Set the all the workers in lbn to recover and activate them if they are not
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.recover_all loadbalancer1
salt \(aq*\(aq modjk.recover_all loadbalancer1 other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.reset_stats(lbn, profile=\(aqdefault\(aq)
Reset all runtime statistics for the load balancer
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.reset_stats loadbalancer1
salt \(aq*\(aq modjk.reset_stats loadbalancer1 other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.version(profile=\(aqdefault\(aq)
Return the modjk version
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.version
salt \(aq*\(aq modjk.version other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.worker_activate(worker, lbn, profile=\(aqdefault\(aq)
Set the worker to activate state in the lbn load balancer
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.worker_activate node1 loadbalancer1
salt \(aq*\(aq modjk.worker_activate node1 loadbalancer1 other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.worker_disable(worker, lbn, profile=\(aqdefault\(aq)
Set the worker to disable state in the lbn load balancer
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.worker_disable node1 loadbalancer1
salt \(aq*\(aq modjk.worker_disable node1 loadbalancer1 other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.worker_edit(worker, lbn, settings, profile=\(aqdefault\(aq)
Edit the worker settings
.sp
Note: \fI\%http://tomcat.apache.org/connectors\-doc/reference/status.html\fP
Data Parameters for the standard Update Action
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.worker_edit node1 loadbalancer1 \(dq{\(aqvwf\(aq: 500, \(aqvwd\(aq: 60}\(dq
salt \(aq*\(aq modjk.worker_edit node1 loadbalancer1 \(dq{\(aqvwf\(aq: 500, \(aqvwd\(aq: 60}\(dq other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.worker_recover(worker, lbn, profile=\(aqdefault\(aq)
Set the worker to recover
this module will fail if it is in OK state
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.worker_recover node1 loadbalancer1
salt \(aq*\(aq modjk.worker_recover node1 loadbalancer1 other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.worker_status(worker, profile=\(aqdefault\(aq)
Return the state of the worker
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.worker_status node1
salt \(aq*\(aq modjk.worker_status node1 other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.worker_stop(worker, lbn, profile=\(aqdefault\(aq)
Set the worker to stopped state in the lbn load balancer
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.worker_activate node1 loadbalancer1
salt \(aq*\(aq modjk.worker_activate node1 loadbalancer1 other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.modjk.workers(profile=\(aqdefault\(aq)
Return a list of member workers and their status
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq modjk.workers
salt \(aq*\(aq modjk.workers other\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mongodb
.sp
Module to provide MongoDB functionality to Salt
.INDENT 0.0
.TP
.B configuration
This module uses PyMongo, and accepts configuration details as
parameters as well as configuration settings:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mongodb.host: \(aqlocalhost\(aq
mongodb.port: 27017
mongodb.user: \(aq\(aq
mongodb.password: \(aq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This data can also be passed into pillar. Options passed into opts will
overwrite options passed into pillar.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.collection_create(collection, user=None, password=None, host=None, port=None, database=\(aqadmin\(aq, authdb=None)
New in version 3006.0.

.sp
Create a collection in the specified database.
.INDENT 7.0
.TP
.B collection
The name of the collection to create.
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.collection_create mycollection <user> <password> <host> <port> <database>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.collection_drop(collection, user=None, password=None, host=None, port=None, database=\(aqadmin\(aq, authdb=None)
New in version 3006.0.

.sp
Drop a collection in the specified database.
.INDENT 7.0
.TP
.B collection
The name of the collection to drop.
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.collection_drop mycollection <user> <password> <host> <port> <database>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.collections_list(user=None, password=None, host=None, port=None, database=\(aqadmin\(aq, authdb=None)
New in version 3006.0.

.sp
List the collections available in the specified database.
.INDENT 7.0
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.collections_list mycollection <user> <password> <host> <port> <database>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.db_exists(name, user=None, password=None, host=None, port=None, authdb=None)
Checks if a database exists in MongoDB
.INDENT 7.0
.TP
.B name
The name of the database to check for.
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.db_exists <name> <user> <password> <host> <port>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.db_list(user=None, password=None, host=None, port=None, authdb=None)
List all MongoDB databases
.INDENT 7.0
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.db_list <user> <password> <host> <port>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.db_remove(name, user=None, password=None, host=None, port=None, authdb=None)
Remove a MongoDB database
.INDENT 7.0
.TP
.B name
The name of the database to remove.
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.db_remove <name> <user> <password> <host> <port>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.find(collection, query=None, user=None, password=None, host=None, port=None, database=\(aqadmin\(aq, authdb=None)
Find an object or list of objects in a collection
.INDENT 7.0
.TP
.B collection
The collection to find the objects in.
.TP
.B query
The query to use when locating objects in the collection.
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.find mycollection \(aq[{\(dqfoo\(dq: \(dqFOO\(dq, \(dqbar\(dq: \(dqBAR\(dq}]\(aq <user> <password> <host> <port> <database>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.insert(objects, collection, user=None, password=None, host=None, port=None, database=\(aqadmin\(aq, authdb=None)
Insert an object or list of objects into a collection
.INDENT 7.0
.TP
.B objects
The objects to insert into the collection, should be provided as a list.
.TP
.B collection
The collection to insert the objects into.
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.insert \(aq[{\(dqfoo\(dq: \(dqFOO\(dq, \(dqbar\(dq: \(dqBAR\(dq}, {\(dqfoo\(dq: \(dqBAZ\(dq, \(dqbar\(dq: \(dqBAM\(dq}]\(aq mycollection <user> <password> <host> <port> <database>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.remove(collection, query=None, user=None, password=None, host=None, port=None, database=\(aqadmin\(aq, w=1, authdb=None)
Remove an object or list of objects from a collection
.INDENT 7.0
.TP
.B collection
The collection to remove objects from based on the query.
.TP
.B query
Query to determine which objects to remove.
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B database
The database where the collection is.
.TP
.B w
The number of matches to remove from the collection.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.remove mycollection \(aq[{\(dqfoo\(dq: \(dqFOO\(dq, \(dqbar\(dq: \(dqBAR\(dq}, {\(dqfoo\(dq: \(dqBAZ\(dq, \(dqbar\(dq: \(dqBAM\(dq}]\(aq <user> <password> <host> <port> <database>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.update_one(objects, collection, user=None, password=None, host=None, port=None, database=\(aqadmin\(aq, authdb=None)
Update an object into a collection
\fI\%http://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.update_one\fP
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B objects
The objects to update in the collection, should be provided as a list.
.TP
.B collection
The collection to insert the objects into.
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.update_one \(aq{\(dq_id\(dq: \(dqmy_minion\(dq} {\(dqbar\(dq: \(dqBAR\(dq}\(aq mycollection <user> <password> <host> <port> <database>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.user_create(name, passwd, user=None, password=None, host=None, port=None, database=\(aqadmin\(aq, authdb=None, roles=None)
Create a MongoDB user
.INDENT 7.0
.TP
.B name
The name of the user to create.
.TP
.B passwd
The password for the user that is being created.
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B database
The MongoDB database to use when checking if the user exists. Default is \fBadmin\fP\&.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.TP
.B roles
The roles that should be associated with the user. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.user_create <user_name> <user_password> <roles> <user> <password> <host> <port> <database>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.user_exists(name, user=None, password=None, host=None, port=None, database=\(aqadmin\(aq, authdb=None)
Checks if a user exists in MongoDB
.INDENT 7.0
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B database
The MongoDB database to use when checking if the user exists. Default is \fBadmin\fP\&.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.user_exists <name> <user> <password> <host> <port> <database>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.user_find(name, user=None, password=None, host=None, port=None, database=\(aqadmin\(aq, authdb=None)
Get single user from MongoDB
.INDENT 7.0
.TP
.B name
The name of the user to find.
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B database
The MongoDB database to use when looking for the user. Default is \fBadmin\fP\&.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.user_find <name> <user> <password> <host> <port> <database> <authdb>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.user_grant_roles(name, roles, database, user=None, password=None, host=None, port=None, authdb=None)
Grant one or many roles to a MongoDB user
.INDENT 7.0
.TP
.B name
The user to grant the specified roles to.
.TP
.B roles
The roles to grant to the specified user.
.TP
.B database
The database to great the roles against for the specified user.
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.user_grant_roles johndoe \(aq[\(dqreadWrite\(dq]\(aq dbname admin adminpwd localhost 27017
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.user_grant_roles janedoe \(aq[{\(dqrole\(dq: \(dqreadWrite\(dq, \(dqdb\(dq: \(dqdbname\(dq }, {\(dqrole\(dq: \(dqread\(dq, \(dqdb\(dq: \(dqotherdb\(dq}]\(aq dbname admin adminpwd localhost 27017
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.user_list(user=None, password=None, host=None, port=None, database=\(aqadmin\(aq, authdb=None)
List users of a MongoDB database
.INDENT 7.0
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B database
The MongoDB database to use when listing users. Default is \fBadmin\fP\&.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.user_list <user> <password> <host> <port> <database>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.user_remove(name, user=None, password=None, host=None, port=None, database=\(aqadmin\(aq, authdb=None)
Remove a MongoDB user
.INDENT 7.0
.TP
.B name
The name of the user that should be removed.
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.user_remove <name> <user> <password> <host> <port> <database>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.user_revoke_roles(name, roles, database, user=None, password=None, host=None, port=None, authdb=None)
Revoke one or many roles to a MongoDB user
.INDENT 7.0
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B roles
The roles to revoke from the specified user.
.TP
.B database
The database to revoke the roles from for the specified user.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.user_revoke_roles johndoe \(aq[\(dqreadWrite\(dq]\(aq dbname admin adminpwd localhost 27017
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.user_revoke_roles janedoe \(aq[{\(dqrole\(dq: \(dqreadWrite\(dq, \(dqdb\(dq: \(dqdbname\(dq }, {\(dqrole\(dq: \(dqread\(dq, \(dqdb\(dq: \(dqotherdb\(dq}]\(aq dbname admin adminpwd localhost 27017
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.user_roles_exists(name, roles, database, user=None, password=None, host=None, port=None, authdb=None)
Checks if a user of a MongoDB database has specified roles
.INDENT 7.0
.TP
.B name
The name of the user to check for the specified roles.
.TP
.B roles
The roles to check are associated with the specified user.
.TP
.B database
The database to check has the specified roles for the specified user.
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.user_roles_exists johndoe \(aq[\(dqreadWrite\(dq]\(aq dbname admin adminpwd localhost 27017
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.user_roles_exists johndoe \(aq[{\(dqrole\(dq: \(dqreadWrite\(dq, \(dqdb\(dq: \(dqdbname\(dq }, {\(dqrole\(dq: \(dqread\(dq, \(dqdb\(dq: \(dqotherdb\(dq}]\(aq dbname admin adminpwd localhost 27017
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mongodb.version(user=None, password=None, host=None, port=None, database=\(aqadmin\(aq, authdb=None)
Get MongoDB instance version
.INDENT 7.0
.TP
.B user
The user to connect to MongoDB as. Default is None.
.TP
.B password
The password to use to connect to MongoDB as.  Default is None.
.TP
.B host
The host where MongoDB is running. Default is None.
.TP
.B port
The host where MongoDB is running. Default is None.
.TP
.B authdb
The MongoDB database to use for authentication. Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mongodb.version <user> <password> <host> <port> <database>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.monit
.sp
Monit service module. This module will create a monit type
service watcher.
.INDENT 0.0
.TP
.B salt.modules.monit.configtest()
New in version 2016.3.0.

.sp
Test monit configuration syntax
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq monit.configtest
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.monit.id_(reset=False)
New in version 2016.3.0.

.sp
Return monit unique id.
.INDENT 7.0
.TP
.B reset
False
Reset current id and generate a new id when it\(aqs True.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq monit.id [reset=True]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.monit.monitor(name)
monitor service via monit
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq monit.monitor <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.monit.reload_()
New in version 2016.3.0.

.sp
Reload monit configuration
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq monit.reload
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.monit.restart(name)
Restart service via monit
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq monit.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.monit.start(name)
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq monit.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.monit.status(svc_name=\(aq\(aq)
Display a process status from monit
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq monit.status
salt \(aq*\(aq monit.status <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.monit.stop(name)
Stops service via monit
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq monit.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.monit.summary(svc_name=\(aq\(aq)
Display a summary from monit
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq monit.summary
salt \(aq*\(aq monit.summary <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.monit.unmonitor(name)
Unmonitor service via monit
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq monit.unmonitor <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.monit.validate()
New in version 2016.3.0.

.sp
Check all services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq monit.validate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.monit.version()
New in version 2016.3.0.

.sp
Return version from monit \-V
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq monit.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.moosefs
.sp
Module for gathering and managing information about MooseFS
.INDENT 0.0
.TP
.B salt.modules.moosefs.dirinfo(path, opts=None)
Return information on a directory located on the Moose
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq moosefs.dirinfo /path/to/dir/ [\-[n][h|H]]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.moosefs.fileinfo(path)
Return information on a file located on the Moose
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq moosefs.fileinfo /path/to/dir/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.moosefs.getgoal(path, opts=None)
Return goal(s) for a file or directory
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq moosefs.getgoal /path/to/file [\-[n][h|H]]
salt \(aq*\(aq moosefs.getgoal /path/to/dir/ [\-[n][h|H][r]]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.moosefs.mounts()
Return a list of current MooseFS mounts
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq moosefs.mounts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mount
.sp
Salt module to manage Unix mounts and the fstab file
.INDENT 0.0
.TP
.B salt.modules.mount.active(extended=False)
List the active mounts.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.active
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.automaster(config=\(aq/etc/auto_salt\(aq)
List the contents of the auto master
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.automaster
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.delete_mount_cache(real_name)
New in version 2018.3.0.

.sp
Provide information if the path is mounted
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.delete_mount_cache /mnt/share
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.filesystems(config=\(aq/etc/filesystems\(aq)
New in version 2018.3.3.

.sp
List the contents of the filesystems
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.filesystems
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.fstab(config=\(aq/etc/fstab\(aq)
Changed in version 2016.3.2.

.sp
List the contents of the fstab
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.fstab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.get_device_from_path(path)
Return the underlying device for a specified path.
.sp
New in version 3006.0.

.INDENT 7.0
.TP
.B path
The path for the function to evaluate.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.get_device_from_path /
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.get_mount_from_path(path)
Return the mount providing a specified path.
.sp
New in version 3006.0.

.INDENT 7.0
.TP
.B path
The path for the function to evaluate.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.get_mount_from_path /opt/some/nested/path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.is_fuse_exec(cmd)
Returns true if the command passed is a fuse mountable application.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.is_fuse_exec sshfs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.is_mounted(name)
New in version 2014.7.0.

.sp
Provide information if the path is mounted
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.is_mounted /mnt/share
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.mount(name, device=False, mkmnt=False, fstype=\(aq\(aq, opts=\(aqdefaults\(aq, user=None, util=\(aqmount\(aq)
Mount a device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.mount /mnt/foo /dev/sdz1 True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.read_mount_cache(name)
New in version 2018.3.0.

.sp
Provide information if the path is mounted
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.read_mount_cache /mnt/share
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.remount(name, device, mkmnt=False, fstype=\(aq\(aq, opts=\(aqdefaults\(aq, user=None)
Attempt to remount a device, if the device is not already mounted, mount
is called
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.remount /mnt/foo /dev/sdz1 True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.rm_automaster(name, device, config=\(aq/etc/auto_salt\(aq)
Remove the mount point from the auto_master
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.rm_automaster /mnt/foo /dev/sdg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.rm_filesystems(name, device, config=\(aq/etc/filesystems\(aq)
New in version 2018.3.3.

.sp
Remove the mount point from the filesystems
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.rm_filesystems /mnt/foo /dev/sdg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.rm_fstab(name, device, config=\(aq/etc/fstab\(aq)
Changed in version 2016.3.2.

.sp
Remove the mount point from the fstab
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.rm_fstab /mnt/foo /dev/sdg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.rm_vfstab(name, device, config=\(aq/etc/vfstab\(aq)
New in version 2016.3.2.

.sp
Remove the mount point from the vfstab
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.rm_vfstab /mnt/foo /device/c0t0d0p0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.set_automaster(name, device, fstype, opts=\(aq\(aq, config=\(aq/etc/auto_salt\(aq, test=False, not_change=False, **kwargs)
Verify that this mount is represented in the auto_salt, change the mount
to match the data passed, or add the mount if it is not present.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.set_automaster /mnt/foo /dev/sdz1 ext4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.set_filesystems(name, device, vfstype, opts=\(aq\-\(aq, mount=\(aqtrue\(aq, config=\(aq/etc/filesystems\(aq, test=False, match_on=\(aqauto\(aq, not_change=False, **kwargs)
New in version 2018.3.3.

.sp
Verify that this mount is represented in the filesystems, change the mount
to match the data passed, or add the mount if it is not present on AIX
.sp
If the entry is found via \fImatch_on\fP and \fInot_change\fP is True, the
current line will be preserved.
.INDENT 7.0
.INDENT 3.5
Provide information if the path is mounted
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The name of the mount point where the device is mounted.
.IP \(bu 2
\fBdevice\fP \-\- The device that is being mounted.
.IP \(bu 2
\fBvfstype\fP \-\- The file system that is used (AIX has two fstypes, fstype and vfstype \- similar to Linux fstype)
.IP \(bu 2
\fBopts\fP \-\- Additional options used when mounting the device.
.IP \(bu 2
\fBmount\fP \-\- Mount if not mounted, default True.
.IP \(bu 2
\fBconfig\fP \-\- Configuration file, default /etc/filesystems.
.IP \(bu 2
\fBmatch\fP \-\- File systems type to match on, default auto
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.set_filesystems /mnt/foo /dev/sdz1 jfs2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.set_fstab(name, device, fstype, opts=\(aqdefaults\(aq, dump=0, pass_num=0, config=\(aq/etc/fstab\(aq, test=False, match_on=\(aqauto\(aq, not_change=False, **kwargs)
Verify that this mount is represented in the fstab, change the mount
to match the data passed, or add the mount if it is not present.
.sp
If the entry is found via \fImatch_on\fP and \fInot_change\fP is True, the
current line will be preserved.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.set_fstab /mnt/foo /dev/sdz1 ext4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.set_vfstab(name, device, fstype, opts=\(aq\-\(aq, device_fsck=\(aq\-\(aq, pass_fsck=\(aq\-\(aq, mount_at_boot=\(aqyes\(aq, config=\(aq/etc/vfstab\(aq, test=False, match_on=\(aqauto\(aq, not_change=False, **kwargs)
New in version 2016.3.2.

.sp
Verify that this mount is represented in the fstab, change the mount
to match the data passed, or add the mount if it is not present.
.sp
If the entry is found via \fImatch_on\fP and \fInot_change\fP is True, the
current line will be preserved.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.set_vfstab /mnt/foo /device/c0t0d0p0 ufs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.swapoff(name)
Deactivate a named swap mount
.sp
Changed in version 2016.3.2.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.swapoff /root/swapfile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.swapon(name, priority=None)
Activate a swap disk
.sp
Changed in version 2016.3.2.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.swapon /root/swapfile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.swaps()
Return a dict containing information on active swap
.sp
Changed in version 2016.3.2.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.swaps
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.umount(name, device=None, user=None, util=\(aqmount\(aq, lazy=False)
Attempt to unmount a device by specifying the directory it is mounted on
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.umount /mnt/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.5.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.umount /mnt/foo /dev/xvdc1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.vfstab(config=\(aq/etc/vfstab\(aq)
New in version 2016.3.2.

.sp
List the contents of the vfstab
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.vfstab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mount.write_mount_cache(real_name, device, mkmnt, fstype, mount_opts)
New in version 2018.3.0.

.sp
Provide information if the path is mounted
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBreal_name\fP \-\- The real name of the mount point where the device is mounted.
.IP \(bu 2
\fBdevice\fP \-\- The device that is being mounted.
.IP \(bu 2
\fBmkmnt\fP \-\- Whether or not the mount point should be created.
.IP \(bu 2
\fBfstype\fP \-\- The file system that is used.
.IP \(bu 2
\fBmount_opts\fP \-\- Additional options used when mounting the device.
.UNINDENT
.TP
.B Returns
Boolean if message was sent successfully.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mount.write_mount_cache /mnt/share /dev/sda1 False ext4 defaults,nosuid
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mssql
.sp
Module to provide MS SQL Server compatibility to salt.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
FreeTDS
.IP \(bu 2
pymssql Python module
.UNINDENT
.TP
.B configuration
In order to connect to MS SQL Server, certain configuration is
required in minion configs/pillars on the relevant minions. Some sample
pillars might look like:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mssql.server: \(aqlocalhost\(aq
mssql.port:   1433
mssql.user:   \(aqsysdba\(aq
mssql.password:   \(aqSome preferable complex password\(aq
mssql.database: \(aq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The default for the port is \(aq1433\(aq and for the database is \(aq\(aq (empty string);
in most cases they can be left at the default setting.
Options that are directly passed into functions will overwrite options from
configs or pillars.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.db_create(database, containment=\(aqNONE\(aq, new_database_options=None, **kwargs)
Creates a new database.
Does not update options of existing databases.
new_database_options can only be a list of strings
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.db_create DB_NAME
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.db_exists(database_name, **kwargs)
Find if a specific database exists on the MS SQL server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.db_exists database_name=\(aqDBNAME\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.db_list(**kwargs)
Return the database list created on a MS SQL server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.db_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.db_remove(database_name, **kwargs)
Drops a specific database from the MS SQL server.
It will not drop any of \(aqmaster\(aq, \(aqmodel\(aq, \(aqmsdb\(aq or \(aqtempdb\(aq.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.db_remove database_name=\(aqDBNAME\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.login_create(login, new_login_password=None, new_login_domain=\(aq\(aq, new_login_roles=None, new_login_options=None, **kwargs)
Creates a new login.  Does not update password of existing logins.  For
Windows authentication, provide \fBnew_login_domain\fP\&.  For SQL Server
authentication, prvide \fBnew_login_password\fP\&.  Since hashed passwords are
\fIvarbinary\fP values, if the \fBnew_login_password\fP is \(aqint / long\(aq, it will
be considered to be HASHED.
.INDENT 7.0
.TP
.B new_login_roles
a list of SERVER roles
.TP
.B new_login_options
a list of strings
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.login_create LOGIN_NAME database=DBNAME [new_login_password=PASSWORD]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.login_exists(login, domain=\(aq\(aq, **kwargs)
Find if a login exists in the MS SQL server.
domain, if provided, will be prepended to login
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.login_exists \(aqLOGIN\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.login_remove(login, **kwargs)
Removes an login.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.login_remove LOGINNAME
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.role_create(role, owner=None, grants=None, **kwargs)
Creates a new database role.
If no owner is specified, the role will be owned by the user that
executes CREATE ROLE, which is the user argument or mssql.user option.
grants is list of strings.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.role_create role=product01 owner=sysdba grants=\(aq[\(dqSELECT\(dq, \(dqINSERT\(dq, \(dqUPDATE\(dq, \(dqDELETE\(dq, \(dqEXECUTE\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.role_exists(role, **kwargs)
Checks if a role exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.role_exists db_owner
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.role_list(**kwargs)
Lists database roles.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.role_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.role_remove(role, **kwargs)
Remove a database role.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.role_create role=test_role01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.tsql_query(query, **kwargs)
Run a SQL query and return query result as list of tuples, or a list of dictionaries if as_dict was passed, or an empty list if no data is available.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.tsql_query \(aqSELECT @@version as version\(aq as_dict=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.user_create(username, login=None, domain=\(aq\(aq, database=None, roles=None, options=None, **kwargs)
Creates a new user.  If login is not specified, the user will be created
without a login.  domain, if provided, will be prepended to username.
options can only be a list of strings
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.user_create USERNAME database=DBNAME
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.user_exists(username, domain=\(aq\(aq, database=None, **kwargs)
Find if an user exists in a specific database on the MS SQL server.
domain, if provided, will be prepended to username
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.user_exists \(aqUSERNAME\(aq [database=\(aqDBNAME\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.user_list(**kwargs)
Get the user list for a specific database on the MS SQL server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.user_list [database=\(aqDBNAME\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.user_remove(username, **kwargs)
Removes an user.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.user_remove USERNAME database=DBNAME
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mssql.version(**kwargs)
Return the version of a MS SQL server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion mssql.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.msteams
.sp
Module for sending messages to MS Teams
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B configuration
This module can be used by either passing a hook_url
directly or by specifying it in a configuration profile in the salt
master/minion config. For example:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
msteams:
  hook_url: https://outlook.office.com/webhook/837
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.msteams.post_card(message, hook_url=None, title=None, theme_color=None)
Send a message to an MS Teams channel.
:param message:     The message to send to the MS Teams channel.
:param hook_url:    The Teams webhook URL, if not specified in the configuration.
:param title:       Optional title for the posted card
:param theme_color:  Optional hex color highlight for the posted card
:return:            Boolean if message was sent successfully.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq msteams.post_card message=\(dqBuild is done\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.munin
.sp
Run munin plugins/checks from salt and format the output as data.
.INDENT 0.0
.TP
.B salt.modules.munin.list_plugins()
List all the munin plugins
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq munin.list_plugins
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.munin.run(plugins)
Run one or more named munin plugins
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq munin.run uptime
salt \(aq*\(aq munin.run uptime,cpu,load,memory
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.munin.run_all()
Run all the munin plugins
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq munin.run_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.mysql
.sp
Module to provide MySQL compatibility to salt.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
Python module: MySQLdb, mysqlclient, or PyMYSQL
.UNINDENT
.TP
.B configuration
In order to connect to MySQL, certain configuration is required
in either the relevant minion config (/etc/salt/minion), or pillar.
.sp
Some sample configs might look like:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mysql.host: \(aqlocalhost\(aq
mysql.port: 3306
mysql.user: \(aqroot\(aq
mysql.pass: \(aq\(aq
mysql.db: \(aqmysql\(aq
mysql.unix_socket: \(aq/tmp/mysql.sock\(aq
mysql.charset: \(aqutf8\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also use a defaults file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mysql.default_file: \(aq/etc/mysql/debian.cnf\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.1.0: \(aqcharset\(aq connection argument added. This is a MySQL charset, not a python one.

.sp
Changed in version 0.16.2: Connection arguments from the minion config file can be overridden on the
CLI by using the arguments defined \fI\%here\fP\&.
Additionally, it is now possible to setup a user with no password.

.INDENT 0.0
.TP
.B salt.modules.mysql.alter_db(name, character_set=None, collate=None, **connection_args)
Modify database using \fBALTER DATABASE %(dbname)s CHARACTER SET %(charset)s
COLLATE %(collation)s;\fP query.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.alter_db testdb charset=\(aqlatin1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.db_check(name, table=None, **connection_args)
Repairs the full database or just a given table
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.db_check dbname
salt \(aq*\(aq mysql.db_check dbname dbtable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.db_create(name, character_set=None, collate=None, **connection_args)
Adds a databases to the MySQL server.
.INDENT 7.0
.TP
.B name
The name of the database to manage
.TP
.B character_set
The character set, if left empty the MySQL default will be used
.TP
.B collate
The collation, if left empty the MySQL default will be used
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.db_create \(aqdbname\(aq
salt \(aq*\(aq mysql.db_create \(aqdbname\(aq \(aqutf8\(aq \(aqutf8_general_ci\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.db_exists(name, **connection_args)
Checks if a database exists on the MySQL server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.db_exists \(aqdbname\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.db_get(name, **connection_args)
Return a list of databases of a MySQL server using the output
from the \fBSELECT DEFAULT_CHARACTER_SET_NAME, DEFAULT_COLLATION_NAME FROM
INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME=\(aqdbname\(aq;\fP query.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.db_get test
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.db_list(**connection_args)
Return a list of databases of a MySQL server using the output
from the \fBSHOW DATABASES\fP query.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.db_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.db_optimize(name, table=None, **connection_args)
Optimizes the full database or just a given table
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.db_optimize dbname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.db_remove(name, **connection_args)
Removes a databases from the MySQL server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.db_remove \(aqdbname\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.db_repair(name, table=None, **connection_args)
Repairs the full database or just a given table
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.db_repair dbname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.db_tables(name, **connection_args)
Shows the tables in the given MySQL database (if exists)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.db_tables \(aqdatabase\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.file_query(database, file_name, **connection_args)
Run an arbitrary SQL query from the specified file and return the
the number of affected rows.
.sp
New in version 2017.7.0.

.sp
database
.INDENT 7.0
.INDENT 3.5
database to run script inside
.UNINDENT
.UNINDENT
.sp
file_name
.INDENT 7.0
.INDENT 3.5
File name of the script.  This can be on the minion, or a file that is reachable by the fileserver
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.file_query mydb file_name=/tmp/sqlfile.sql
salt \(aq*\(aq mysql.file_query mydb file_name=salt://sqlfile.sql
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Return data:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqquery time\(aq: {\(aqhuman\(aq: \(aq39.0ms\(aq, \(aqraw\(aq: \(aq0.03899\(aq}, \(aqrows affected\(aq: 1L}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.free_slave(**connection_args)
Frees a slave from its master.  This is a WIP, do not use.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.free_slave
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.get_master_status(**connection_args)
Retrieves the master status from the minion.
.sp
Returns:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqhost.domain.com\(aq: {\(aqBinlog_Do_DB\(aq: \(aq\(aq,
                 \(aqBinlog_Ignore_DB\(aq: \(aq\(aq,
                 \(aqFile\(aq: \(aqmysql\-bin.000021\(aq,
                 \(aqPosition\(aq: 107}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.get_master_status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.get_slave_status(**connection_args)
Retrieves the slave status from the minion.
.sp
Returns:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqhost.domain.com\(aq: {\(aqConnect_Retry\(aq: 60,
               \(aqExec_Master_Log_Pos\(aq: 107,
               \(aqLast_Errno\(aq: 0,
               \(aqLast_Error\(aq: \(aq\(aq,
               \(aqLast_IO_Errno\(aq: 0,
               \(aqLast_IO_Error\(aq: \(aq\(aq,
               \(aqLast_SQL_Errno\(aq: 0,
               \(aqLast_SQL_Error\(aq: \(aq\(aq,
               \(aqMaster_Host\(aq: \(aqcomet.scion\-eng.com\(aq,
               \(aqMaster_Log_File\(aq: \(aqmysql\-bin.000021\(aq,
               \(aqMaster_Port\(aq: 3306,
               \(aqMaster_SSL_Allowed\(aq: \(aqNo\(aq,
               \(aqMaster_SSL_CA_File\(aq: \(aq\(aq,
               \(aqMaster_SSL_CA_Path\(aq: \(aq\(aq,
               \(aqMaster_SSL_Cert\(aq: \(aq\(aq,
               \(aqMaster_SSL_Cipher\(aq: \(aq\(aq,
               \(aqMaster_SSL_Key\(aq: \(aq\(aq,
               \(aqMaster_SSL_Verify_Server_Cert\(aq: \(aqNo\(aq,
               \(aqMaster_Server_Id\(aq: 1,
               \(aqMaster_User\(aq: \(aqreplu\(aq,
               \(aqRead_Master_Log_Pos\(aq: 107,
               \(aqRelay_Log_File\(aq: \(aqklo\-relay\-bin.000071\(aq,
               \(aqRelay_Log_Pos\(aq: 253,
               \(aqRelay_Log_Space\(aq: 553,
               \(aqRelay_Master_Log_File\(aq: \(aqmysql\-bin.000021\(aq,
               \(aqReplicate_Do_DB\(aq: \(aq\(aq,
               \(aqReplicate_Do_Table\(aq: \(aq\(aq,
               \(aqReplicate_Ignore_DB\(aq: \(aq\(aq,
               \(aqReplicate_Ignore_Server_Ids\(aq: \(aq\(aq,
               \(aqReplicate_Ignore_Table\(aq: \(aq\(aq,
               \(aqReplicate_Wild_Do_Table\(aq: \(aq\(aq,
               \(aqReplicate_Wild_Ignore_Table\(aq: \(aq\(aq,
               \(aqSeconds_Behind_Master\(aq: 0,
               \(aqSkip_Counter\(aq: 0,
               \(aqSlave_IO_Running\(aq: \(aqYes\(aq,
               \(aqSlave_IO_State\(aq: \(aqWaiting for master to send event\(aq,
               \(aqSlave_SQL_Running\(aq: \(aqYes\(aq,
               \(aqUntil_Condition\(aq: \(aqNone\(aq,
               \(aqUntil_Log_File\(aq: \(aq\(aq,
               \(aqUntil_Log_Pos\(aq: 0}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.get_slave_status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.grant_add(grant, database, user, host=\(aqlocalhost\(aq, grant_option=False, escape=True, ssl_option=False, **connection_args)
Adds a grant to the MySQL server.
.sp
For database, make sure you specify database.table or database.*
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.grant_add             \(aqSELECT,INSERT,UPDATE,...\(aq \(aqdatabase.*\(aq \(aqfrank\(aq \(aqlocalhost\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.grant_exists(grant, database, user, host=\(aqlocalhost\(aq, grant_option=False, escape=True, **connection_args)
Checks to see if a grant exists in the database
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.grant_exists              \(aqSELECT,INSERT,UPDATE,...\(aq \(aqdatabase.*\(aq \(aqfrank\(aq \(aqlocalhost\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.grant_revoke(grant, database, user, host=\(aqlocalhost\(aq, grant_option=False, escape=True, **connection_args)
Removes a grant from the MySQL server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.grant_revoke             \(aqSELECT,INSERT,UPDATE\(aq \(aqdatabase.*\(aq \(aqfrank\(aq \(aqlocalhost\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.plugin_add(name, soname=None, **connection_args)
Add a plugina.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.plugin_add auth_socket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.plugin_remove(name, **connection_args)
Remove a plugin.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.plugin_remove auth_socket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.plugin_status(name, **connection_args)
Return the status of a plugin.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.plugin_status auth_socket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.plugins_list(**connection_args)
Return a list of plugins and their status
from the \fBSHOW PLUGINS\fP query.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.plugins_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.processlist(**connection_args)
Retrieves the processlist from the MySQL server via
\(dqSHOW FULL PROCESSLIST\(dq.
.sp
Returns: a list of dicts, with each dict representing a process:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqCommand\(aq: \(aqQuery\(aq,
\(aqHost\(aq: \(aqlocalhost\(aq,
\(aqId\(aq: 39,
\(aqInfo\(aq: \(aqSHOW FULL PROCESSLIST\(aq,
\(aqRows_examined\(aq: 0,
\(aqRows_read\(aq: 1,
\(aqRows_sent\(aq: 0,
\(aqState\(aq: None,
\(aqTime\(aq: 0,
\(aqUser\(aq: \(aqroot\(aq,
\(aqdb\(aq: \(aqmysql\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.processlist
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.query(database, query, **connection_args)
Run an arbitrary SQL query and return the results or
the number of affected rows.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.query mydb \(dqUPDATE mytable set myfield=1 limit 1\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Return data:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqquery time\(aq: {\(aqhuman\(aq: \(aq39.0ms\(aq, \(aqraw\(aq: \(aq0.03899\(aq}, \(aqrows affected\(aq: 1L}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.query mydb \(dqSELECT id,name,cash from users limit 3\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Return data:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqcolumns\(aq: (\(aqid\(aq, \(aqname\(aq, \(aqcash\(aq),
    \(aqquery time\(aq: {\(aqhuman\(aq: \(aq1.0ms\(aq, \(aqraw\(aq: \(aq0.001\(aq},
    \(aqresults\(aq: ((1L, \(aqUser 1\(aq, Decimal(\(aq110.000000\(aq)),
                (2L, \(aqUser 2\(aq, Decimal(\(aq215.636756\(aq)),
                (3L, \(aqUser 3\(aq, Decimal(\(aq0.040000\(aq))),
    \(aqrows returned\(aq: 3L}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.query mydb \(aqINSERT into users values (null,\(dquser 4\(dq, 5)\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Return data:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqquery time\(aq: {\(aqhuman\(aq: \(aq25.6ms\(aq, \(aqraw\(aq: \(aq0.02563\(aq}, \(aqrows affected\(aq: 1L}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.query mydb \(aqDELETE from users where id = 4 limit 1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Return data:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqquery time\(aq: {\(aqhuman\(aq: \(aq39.0ms\(aq, \(aqraw\(aq: \(aq0.03899\(aq}, \(aqrows affected\(aq: 1L}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Jinja Example: Run a query on \fBmydb\fP and use row 0, column 0\(aqs data.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt[\(aqmysql.query\(aq](\(aqmydb\(aq, \(aqSELECT info from mytable limit 1\(aq)[\(aqresults\(aq][0][0] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.quote_identifier(identifier, for_grants=False)
Return an identifier name (column, table, database, etc) escaped for MySQL
.sp
This means surrounded by \(dq\(ga\(dq character and escaping this character inside.
It also means doubling the \(aq%\(aq character for MySQLdb internal usage.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBidentifier\fP \-\- the table, column or database identifier
.IP \(bu 2
\fBfor_grants\fP \-\- is False by default, when using database names on grant
queries you should set it to True to also escape \(dq_\(dq and \(dq%\(dq characters as
requested by MySQL. Note that theses characters should only be escaped when
requesting grants on the database level (\fImy_%db\fP\&.*) but not for table
level grants (\fImy_%db\fP\&.\(gafoo\(ga)
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.quote_identifier \(aqfoo\(gabar\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.showglobal(**connection_args)
Retrieves the show global variables from the minion.
.INDENT 7.0
.TP
.B Returns::
show global variables full dict
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.showglobal
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.showvariables(**connection_args)
Retrieves the show variables from the minion.
.INDENT 7.0
.TP
.B Returns::
show variables full dict
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.showvariables
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.slave_lag(**connection_args)
Return the number of seconds that a slave SQL server is lagging behind the
master, if the host is not a slave it will return \-1.  If the server is
configured to be a slave for replication but slave IO is not running then
\-2 will be returned. If there was an error connecting to the database or
checking the slave status, \-3 will be returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.slave_lag
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.status(**connection_args)
Return the status of a MySQL server using the output from the \fBSHOW
STATUS\fP query.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.tokenize_grant(grant)
External wrapper function
:param grant:
:return: dict
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.tokenize_grant             \(dqGRANT SELECT, INSERT ON testdb.* TO \(aqtestuser\(aq@\(aqlocalhost\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.user_chpass(user, host=\(aqlocalhost\(aq, password=None, password_hash=None, allow_passwordless=False, unix_socket=None, password_column=None, **connection_args)
Change password for a MySQL user
.INDENT 7.0
.TP
.B host
Host for which this user/password combo applies
.TP
.B password
The password to set for the new user. Will take precedence over the
\fBpassword_hash\fP option if both are specified.
.TP
.B password_hash
The password in hashed form. Be sure to quote the password because YAML
doesn\(aqt like the \fB*\fP\&. A password hash can be obtained from the mysql
command\-line client like so:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mysql> SELECT PASSWORD(\(aqmypass\(aq);
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
| PASSWORD(\(aqmypass\(aq)                        |
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
| *6C8989366EAF75BB670AD8EA7A7FC1176A95CEF4 |
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
1 row in set (0.00 sec)
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B allow_passwordless
If \fBTrue\fP, then \fBpassword\fP and \fBpassword_hash\fP can be omitted (or
set to \fBNone\fP) to permit a passwordless login.
.UNINDENT
.sp
New in version 0.16.2: The \fBallow_passwordless\fP option was added.

.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.user_chpass frank localhost newpassword
salt \(aq*\(aq mysql.user_chpass frank localhost password_hash=\(aqhash\(aq
salt \(aq*\(aq mysql.user_chpass frank localhost allow_passwordless=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.user_create(user, host=\(aqlocalhost\(aq, password=None, password_hash=None, allow_passwordless=False, unix_socket=False, password_column=None, auth_plugin=\(aqmysql_native_password\(aq, **connection_args)
Creates a MySQL user
.INDENT 7.0
.TP
.B host
Host for which this user/password combo applies
.TP
.B password
The password to use for the new user. Will take precedence over the
\fBpassword_hash\fP option if both are specified.
.TP
.B password_hash
The password in hashed form. Be sure to quote the password because YAML
doesn\(aqt like the \fB*\fP\&. A password hash can be obtained from the mysql
command\-line client like so:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mysql> SELECT PASSWORD(\(aqmypass\(aq);
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
| PASSWORD(\(aqmypass\(aq)                        |
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
| *6C8989366EAF75BB670AD8EA7A7FC1176A95CEF4 |
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
1 row in set (0.00 sec)
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B allow_passwordless
If \fBTrue\fP, then \fBpassword\fP and \fBpassword_hash\fP can be omitted (or
set to \fBNone\fP) to permit a passwordless login.
.TP
.B unix_socket
If \fBTrue\fP and allow_passwordless is \fBTrue\fP then will be used unix_socket auth plugin.
.TP
.B password_column
The password column to use in the user table.
.TP
.B auth_plugin
The authentication plugin to use, default is to use the mysql_native_password plugin.
.UNINDENT
.sp
New in version 0.16.2: The \fBallow_passwordless\fP option was added.

.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.user_create \(aqusername\(aq \(aqhostname\(aq \(aqpassword\(aq
salt \(aq*\(aq mysql.user_create \(aqusername\(aq \(aqhostname\(aq password_hash=\(aqhash\(aq
salt \(aq*\(aq mysql.user_create \(aqusername\(aq \(aqhostname\(aq allow_passwordless=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.user_exists(user, host=\(aqlocalhost\(aq, password=None, password_hash=None, passwordless=False, unix_socket=False, password_column=None, **connection_args)
Checks if a user exists on the MySQL server. A login can be checked to see
if passwordless login is permitted by omitting \fBpassword\fP and
\fBpassword_hash\fP, and using \fBpasswordless=True\fP\&.
.sp
New in version 0.16.2: The \fBpasswordless\fP option was added.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.user_exists \(aqusername\(aq \(aqhostname\(aq \(aqpassword\(aq
salt \(aq*\(aq mysql.user_exists \(aqusername\(aq \(aqhostname\(aq password_hash=\(aqhash\(aq
salt \(aq*\(aq mysql.user_exists \(aqusername\(aq passwordless=True
salt \(aq*\(aq mysql.user_exists \(aqusername\(aq password_column=\(aqauthentication_string\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.user_grants(user, host=\(aqlocalhost\(aq, **connection_args)
Shows the grants for the given MySQL user (if it exists)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.user_grants \(aqfrank\(aq \(aqlocalhost\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.user_info(user, host=\(aqlocalhost\(aq, **connection_args)
Get full info on a MySQL user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.user_info root localhost
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.user_list(**connection_args)
Return a list of users on a MySQL server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.user_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.user_remove(user, host=\(aqlocalhost\(aq, **connection_args)
Delete MySQL user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.user_remove frank localhost
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.verify_login(user, password=None, **connection_args)
Attempt to login using the provided credentials.
If successful, return true.  Otherwise, return False.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.verify_login root password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.mysql.version(**connection_args)
Return the version of a MySQL server using the output from the \fBSELECT
VERSION()\fP query.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq mysql.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.nacl
.sp
This module helps include encrypted passwords in pillars, grains and salt state files.
.INDENT 0.0
.TP
.B depends
PyNaCl, \fI\%https://github.com/pyca/pynacl\fP
.UNINDENT
.sp
This is often useful if you wish to store your pillars in source control or
share your pillar data with others that you trust. I don\(aqt advise making your pillars public
regardless if they are encrypted or not.
.sp
When generating keys and encrypting passwords use \-\-local when using salt\-call for extra
security. Also consider using just the salt runner nacl when encrypting pillar passwords.
.INDENT 0.0
.TP
.B configuration
The following configuration defaults can be
define (pillar or config files) Avoid storing private keys in pillars! Ensure master does not have \fIpillar_opts=True\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# cat /etc/salt/master.d/nacl.conf
nacl.config:
    # NOTE: \(gakey\(ga and \(gakey_file\(ga have been renamed to \(gask\(ga, \(gask_file\(ga
    # also \(gabox_type\(ga default changed from secretbox to sealedbox.
    box_type: sealedbox                     (default)
    sk_file: /etc/salt/pki/master/nacl      (default)
    pk_file: /etc/salt/pki/master/nacl.pub  (default)
    sk: None
    pk: None
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Usage can override the config defaults:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call nacl.enc sk_file=/etc/salt/pki/master/nacl pk_file=/etc/salt/pki/master/nacl.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The nacl lib uses 32byte keys, these keys are base64 encoded to make your life more simple.
To generate your \fIsk_file\fP and \fIpk_file\fP use:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local nacl.keygen sk_file=/etc/salt/pki/master/nacl
# or if you want to work without files.
salt\-call \-\-local nacl.keygen
local:
    \-\-\-\-\-\-\-\-\-\-
    pk:
        /kfGX7PbWeu099702PBbKWLpG/9p06IQRswkdWHCDk0=
    sk:
        SVWut5SqNpuPeNzb1b9y6b2eXg2PLIog43GBzp48Sow=
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now with your keypair, you can encrypt data:
.sp
You have two option, \fIsealedbox\fP or \fIsecretbox\fP\&.
.sp
SecretBox is data encrypted using private key \fIpk\fP\&. Sealedbox is encrypted using public key \fIpk\fP\&.
.sp
Recommend using Sealedbox because the one way encryption permits developers to encrypt data for source control but not decrypt.
Sealedbox only has one key that is for both encryption and decryption.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local nacl.enc asecretpass pk=/kfGX7PbWeu099702PBbKWLpG/9p06IQRswkdWHCDk0=
tqXzeIJnTAM9Xf0mdLcpEdklMbfBGPj2oTKmlgrm3S1DTVVHNnh9h8mU1GKllGq/+cYsk6m5WhGdk58=
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To decrypt the data:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local nacl.dec data=\(aqtqXzeIJnTAM9Xf0mdLcpEdklMbfBGPj2oTKmlgrm3S1DTVVHNnh9h8mU1GKllGq/+cYsk6m5WhGdk58=\(aq         sk=\(aqSVWut5SqNpuPeNzb1b9y6b2eXg2PLIog43GBzp48Sow=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When the keys are defined in the master config you can use them from the nacl runner
without extra parameters:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# cat /etc/salt/master.d/nacl.conf
nacl.config:
    sk_file: /etc/salt/pki/master/nacl
    pk: \(aqcTIqXwnUiD1ulg4kXsbeCE7/NoeKEzd4nLeYcCFpd9k=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.enc \(aqasecretpass\(aq
salt\-run nacl.dec data=\(aqtqXzeIJnTAM9Xf0mdLcpEdklMbfBGPj2oTKmlgrm3S1DTVVHNnh9h8mU1GKllGq/+cYsk6m5WhGdk58=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# a salt developers minion could have pillar data that includes a nacl public key
nacl.config:
    pk: \(aq/kfGX7PbWeu099702PBbKWLpG/9p06IQRswkdWHCDk0=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The developer can then use a less\-secure system to encrypt data.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local nacl.enc apassword
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pillar files can include protected data that the salt master decrypts:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillarexample:
    user: root
    password1: {{salt.nacl.dec(\(aqDRB7Q6/X5gGSRCTpZyxS6hlbWj0llUA+uaVyvou3vJ4=\(aq)|json}}
    cert_key: {{salt.nacl.dec_file(\(aq/srv/salt/certs/example.com/key.nacl\(aq)|json}}
    cert_key2: {{salt.nacl.dec_file(\(aqsalt:///certs/example.com/key.nacl\(aq)|json}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Larger files like certificates can be encrypted with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call nacl.enc_file /tmp/cert.crt out=/tmp/cert.nacl
# or more advanced
cert=$(cat /tmp/cert.crt)
salt\-call \-\-out=newline_values_only nacl.enc_pub data=\(dq$cert\(dq > /tmp/cert.nacl
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In pillars rended with jinja be sure to include \fI|json\fP so line breaks are encoded:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cert: \(dq{{salt.nacl.dec(\(aqS2uogToXkgENz9...085KYt\(aq)|json}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In states rendered with jinja it is also good pratice to include \fI|json\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{sls}} private key:
    file.managed:
        \- name: /etc/ssl/private/cert.key
        \- mode: 700
        \- contents: \(dq{{pillar[\(aqpillarexample\(aq][\(aqcert_key\(aq]|json}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Optional small program to encrypt data without needing salt modules.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!/bin/python3
import sys, base64, nacl.public
pk = base64.b64decode(\(aqYOURPUBKEY\(aq)
b = nacl.public.SealedBox(pk)
data = sys.stdin.buffer.read()
print(base64.b64encode(b.encrypt(data)).decode())
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
echo \(aqapassword\(aq | nacl_enc.py
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nacl.dec(data, **kwargs)
Alias to \fI{box_type}_decrypt\fP
.sp
box_type: secretbox, sealedbox(default)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nacl.dec_file(name, out=None, **kwargs)
This is a helper function to decrypt a file and return its contents.
.sp
You can provide an optional output file using \fIout\fP
.sp
\fIname\fP can be a local file or when not using \fIsalt\-run\fP can be a url like \fIsalt://\fP, \fIhttps://\fP etc.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.dec_file name=/tmp/id_rsa.nacl
salt\-call nacl.dec_file name=salt://crt/mycert.nacl out=/tmp/id_rsa
salt\-run nacl.dec_file name=/tmp/id_rsa.nacl box_type=secretbox             sk_file=/etc/salt/pki/master/nacl.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nacl.enc(data, **kwargs)
Alias to \fI{box_type}_encrypt\fP
.sp
box_type: secretbox, sealedbox(default)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nacl.enc_file(name, out=None, **kwargs)
This is a helper function to encrypt a file and return its contents.
.sp
You can provide an optional output file using \fIout\fP
.sp
\fIname\fP can be a local file or when not using \fIsalt\-run\fP can be a url like \fIsalt://\fP, \fIhttps://\fP etc.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.enc_file name=/tmp/id_rsa
salt\-call nacl.enc_file name=salt://crt/mycert out=/tmp/cert
salt\-run nacl.enc_file name=/tmp/id_rsa box_type=secretbox             sk_file=/etc/salt/pki/master/nacl.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nacl.keygen(sk_file=None, pk_file=None, **kwargs)
Use PyNaCl to generate a keypair.
.sp
If no \fIsk_file\fP is defined return a keypair.
.sp
If only the \fIsk_file\fP is defined \fIpk_file\fP will use the same name with a postfix \fI\&.pub\fP\&.
.sp
When the \fIsk_file\fP is already existing, but \fIpk_file\fP is not. The \fIpk_file\fP will be generated
using the \fIsk_file\fP\&.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call nacl.keygen
salt\-call nacl.keygen sk_file=/etc/salt/pki/master/nacl
salt\-call nacl.keygen sk_file=/etc/salt/pki/master/nacl pk_file=/etc/salt/pki/master/nacl.pub
salt\-call \-\-local nacl.keygen
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nacl.sealedbox_decrypt(data, **kwargs)
Decrypt data using a secret key that was encrypted using a public key with \fInacl.sealedbox_encrypt\fP\&.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call nacl.sealedbox_decrypt pEXHQM6cuaF7A=
salt\-call \-\-local nacl.sealedbox_decrypt data=\(aqpEXHQM6cuaF7A=\(aq sk_file=/etc/salt/pki/master/nacl
salt\-call \-\-local nacl.sealedbox_decrypt data=\(aqpEXHQM6cuaF7A=\(aq sk=\(aqYmFkcGFzcwo=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nacl.sealedbox_encrypt(data, **kwargs)
Encrypt data using a public key generated from \fInacl.keygen\fP\&.
The encryptd data can be decrypted using \fInacl.sealedbox_decrypt\fP only with the secret key.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.sealedbox_encrypt datatoenc
salt\-call \-\-local nacl.sealedbox_encrypt datatoenc pk_file=/etc/salt/pki/master/nacl.pub
salt\-call \-\-local nacl.sealedbox_encrypt datatoenc pk=\(aqvrwQF7cNiNAVQVAiS3bvcbJUnF0cN6fU9YTZD9mBfzQ=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nacl.secretbox_decrypt(data, **kwargs)
Decrypt data that was encrypted using \fInacl.secretbox_encrypt\fP using the secret key
that was generated from \fInacl.keygen\fP\&.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call nacl.secretbox_decrypt pEXHQM6cuaF7A=
salt\-call \-\-local nacl.secretbox_decrypt data=\(aqpEXHQM6cuaF7A=\(aq sk_file=/etc/salt/pki/master/nacl
salt\-call \-\-local nacl.secretbox_decrypt data=\(aqpEXHQM6cuaF7A=\(aq sk=\(aqYmFkcGFzcwo=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nacl.secretbox_encrypt(data, **kwargs)
Encrypt data using a secret key generated from \fInacl.keygen\fP\&.
The same secret key can be used to decrypt the data using \fInacl.secretbox_decrypt\fP\&.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.secretbox_encrypt datatoenc
salt\-call \-\-local nacl.secretbox_encrypt datatoenc sk_file=/etc/salt/pki/master/nacl
salt\-call \-\-local nacl.secretbox_encrypt datatoenc sk=\(aqYmFkcGFzcwo=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.nagios
.sp
Run nagios plugins/checks from salt and get the return as data.
.INDENT 0.0
.TP
.B salt.modules.nagios.list_plugins()
List all the nagios plugins
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nagios.list_plugins
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nagios.retcode(plugin, args=\(aq\(aq, key_name=None)
Run one nagios plugin and return retcode of the execution
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nagios.retcode_pillar(pillar_name)
Run one or more nagios plugins from pillar data and get the result of cmd.retcode
The pillar have to be in this format:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-\-\-\-\-
webserver:
    Ping_google:
        \- check_icmp: 8.8.8.8
        \- check_icmp: google.com
    Load:
        \- check_load: \-w 0.8 \-c 1
    APT:
        \- check_apt
\-\-\-\-\-\-\-
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
webserver is the role to check, the next keys are the group and the items
the check with the arguments if needed
.sp
You must to group different checks(one o more) and always it will return
the highest value of all the checks
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nagios.retcode webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nagios.run(plugin, args=\(aq\(aq)
Run nagios plugin and return all the data execution with cmd.run
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nagios.run check_apt
salt \(aq*\(aq nagios.run check_icmp \(aq8.8.8.8\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nagios.run_all(plugin, args=\(aq\(aq)
Run nagios plugin and return all the data execution with cmd.run_all
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nagios.run_all_pillar(pillar_name)
Run one or more nagios plugins from pillar data and get the result of cmd.run_all
The pillar have to be in this format:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-\-\-\-\-
webserver:
    Ping_google:
        \- check_icmp: 8.8.8.8
        \- check_icmp: google.com
    Load:
        \- check_load: \-w 0.8 \-c 1
    APT:
        \- check_apt
\-\-\-\-\-\-\-
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
webserver is the role to check, the next keys are the group and the items
the check with the arguments if needed
.sp
You have to group different checks in a group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nagios.run webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nagios.run_pillar(pillar_name)
Run one or more nagios plugins from pillar data and get the result of cmd.run
The pillar have to be in this format:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-\-\-\-\-
webserver:
    Ping_google:
        \- check_icmp: 8.8.8.8
        \- check_icmp: google.com
    Load:
        \- check_load: \-w 0.8 \-c 1
    APT:
        \- check_apt
\-\-\-\-\-\-\-
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
webserver is the role to check, the next keys are the group and the items
the check with the arguments if needed
.sp
You have to group different checks in a group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nagios.run webserver
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.nagios_rpc
.sp
Check Host & Service status from Nagios via JSON RPC.
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B salt.modules.nagios_rpc.host_status(hostname=None, **kwargs)
Check status of a particular host By default
statuses are returned in a numeric format.
.sp
Parameters:
.INDENT 7.0
.TP
.B hostname
The hostname to check the status of the service in Nagios.
.TP
.B numeric
Turn to false in order to return status in text format
(\(aqOK\(aq instead of 0, \(aqWarning\(aq instead of 1 etc)
.UNINDENT
.INDENT 7.0
.TP
.B Returns
status:     \(aqOK\(aq, \(aqWarning\(aq, \(aqCritical\(aq or \(aqUnknown\(aq
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nagios_rpc.host_status hostname=webserver.domain.com
salt \(aq*\(aq nagios_rpc.host_status hostname=webserver.domain.com numeric=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nagios_rpc.service_status(hostname=None, service=None, **kwargs)
Check status of a particular service on a host on it in Nagios.
By default statuses are returned in a numeric format.
.sp
Parameters:
.INDENT 7.0
.TP
.B hostname
The hostname to check the status of the service in Nagios.
.TP
.B service
The service to check the status of in Nagios.
.TP
.B numeric
Turn to false in order to return status in text format
(\(aqOK\(aq instead of 0, \(aqWarning\(aq instead of 1 etc)
.UNINDENT
.INDENT 7.0
.TP
.B Returns
status:     \(aqOK\(aq, \(aqWarning\(aq, \(aqCritical\(aq or \(aqUnknown\(aq
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nagios_rpc.service_status hostname=webserver.domain.com service=\(aqHTTP\(aq
salt \(aq*\(aq nagios_rpc.service_status hostname=webserver.domain.com service=\(aqHTTP\(aq numeric=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.namecheap_domains
.sp
Namecheap Domain Management
.sp
New in version 2017.7.0.

.SS Prerequisites
.sp
This module uses the \fBrequests\fP Python module to communicate to the namecheap
API.
.SS Configuration
.sp
The Namecheap username, API key and URL should be set in the minion configuration
file, or in the Pillar data.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
namecheap.name: companyname
namecheap.key: a1b2c3d4e5f67a8b9c0d1e2f3
namecheap.client_ip: 162.155.30.172
#Real url
namecheap.url: https://api.namecheap.com/xml.response
#Sandbox url
#namecheap.url: https://api.sandbox.namecheap.xml.response
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains.check(*domains_to_check)
Checks the availability of domains
.INDENT 7.0
.TP
.B domains_to_check
array of strings  List of domains to check
.UNINDENT
.sp
Returns a dictionary mapping the each domain name to a boolean denoting
whether or not it is available.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_domains.check domain\-to\-check
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains.create(domain_name, years, **kwargs)
Try to register the specified domain name
.INDENT 7.0
.TP
.B domain_name
The domain name to be registered
.TP
.B years
Number of years to register
.UNINDENT
.sp
Returns the following information:
.INDENT 7.0
.IP \(bu 2
Whether or not the domain was renewed successfully
.IP \(bu 2
Whether or not WhoisGuard is enabled
.IP \(bu 2
Whether or not registration is instant
.IP \(bu 2
The amount charged for registration
.IP \(bu 2
The domain ID
.IP \(bu 2
The order ID
.IP \(bu 2
The transaction ID
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_domains.create my\-domain\-name 2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains.get_info(domain_name)
Returns information about the requested domain
.sp
returns a dictionary of information about the domain_name
.INDENT 7.0
.TP
.B domain_name
string  Domain name to get information about
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_domains.get_info my\-domain\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains.get_list(list_type=None, search_term=None, page=None, page_size=None, sort_by=None)
Returns a list of domains for the particular user as a list of objects
offset by \fBpage\fP length of \fBpage_size\fP
.INDENT 7.0
.TP
.B list_type
ALL
One of \fBALL\fP, \fBEXPIRING\fP, \fBEXPIRED\fP
.TP
.B search_term
Keyword to look for on the domain list
.TP
.B page
1
Number of result page to return
.TP
.B page_size
20
Number of domains to be listed per page (minimum: \fB10\fP, maximum:
\fB100\fP)
.TP
.B sort_by
One of \fBNAME\fP, \fBNAME_DESC\fP, \fBEXPIREDATE\fP, \fBEXPIREDATE_DESC\fP,
\fBCREATEDATE\fP, or \fBCREATEDATE_DESC\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_domains.get_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains.get_tld_list()
Returns a list of TLDs as objects
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_domains.get_tld_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains.reactivate(domain_name)
Try to reactivate the expired domain name
.sp
Returns the following information:
.INDENT 7.0
.IP \(bu 2
Whether or not the domain was reactivated successfully
.IP \(bu 2
The amount charged for reactivation
.IP \(bu 2
The order ID
.IP \(bu 2
The transaction ID
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_domains.reactivate my\-domain\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains.renew(domain_name, years, promotion_code=None)
Try to renew the specified expiring domain name for a specified number of years
.INDENT 7.0
.TP
.B domain_name
The domain name to be renewed
.TP
.B years
Number of years to renew
.UNINDENT
.sp
Returns the following information:
.INDENT 7.0
.IP \(bu 2
Whether or not the domain was renewed successfully
.IP \(bu 2
The domain ID
.IP \(bu 2
The order ID
.IP \(bu 2
The transaction ID
.IP \(bu 2
The amount charged for renewal
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_domains.renew my\-domain\-name 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.namecheap_domains_dns
.sp
Namecheap DNS Management
.sp
New in version 2017.7.0.

.SS Prerequisites
.sp
This module uses the \fBrequests\fP Python module to communicate to the namecheap
API.
.SS Configuration
.sp
The Namecheap username, API key and URL should be set in the minion configuration
file, or in the Pillar data.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
namecheap.name: companyname
namecheap.key: a1b2c3d4e5f67a8b9c0d1e2f3
namecheap.client_ip: 162.155.30.172
#Real url
namecheap.url: https://api.namecheap.com/xml.response
#Sandbox url
#namecheap.url: https://api.sandbox.namecheap.xml.response
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains_dns.get_hosts(sld, tld)
Retrieves DNS host record settings for the requested domain.
.sp
returns a dictionary of information about the requested domain
.INDENT 7.0
.TP
.B sld
SLD of the domain name
.TP
.B tld
TLD of the domain name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_domains_dns.get_hosts sld tld
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains_dns.get_list(sld, tld)
Gets a list of DNS servers associated with the requested domain.
.sp
returns a dictionary of information about requested domain
.INDENT 7.0
.TP
.B sld
SLD of the domain name
.TP
.B tld
TLD of the domain name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_domains_dns.get_list sld tld
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains_dns.set_custom(sld, tld, nameservers)
Sets domain to use custom DNS servers.
.sp
returns True if the custom nameservers were set successfully
.INDENT 7.0
.TP
.B sld
SLD of the domain name
.TP
.B tld
TLD of the domain name
.TP
.B nameservers
array of strings  List of nameservers to be associated with this domain
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_domains_dns.set_custom sld tld nameserver
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains_dns.set_default(sld, tld)
Sets domain to use namecheap default DNS servers. Required for free
services like Host record management, URL forwarding, email forwarding,
dynamic DNS and other value added services.
.INDENT 7.0
.TP
.B sld
SLD of the domain name
.TP
.B tld
TLD of the domain name
.UNINDENT
.sp
Returns \fBTrue\fP if the domain was successfully pointed at the default DNS
servers.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_domains_dns.set_default sld tld
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains_dns.set_hosts(sld, tld, hosts)
Sets DNS host records settings for the requested domain.
.sp
returns True if the host records were set successfully
.INDENT 7.0
.TP
.B sld
SLD of the domain name
.TP
.B tld
TLD of the domain name
.TP
.B hosts
Must be passed as a list of Python dictionaries, with each dictionary
containing the following keys:
.INDENT 7.0
.IP \(bu 2
\fBhostname\fP
.IP \(bu 2
\fBrecordtype\fP \- One of \fBA\fP, \fBAAAA\fP, \fBCNAME\fP, \fBMX\fP, \fBMXE\fP,
\fBTXT\fP, \fBURL\fP, \fBURL301\fP, or \fBFRAME\fP
.IP \(bu 2
\fBaddress\fP \- URL or IP address
.IP \(bu 2
\fBttl\fP \- An integer between 60 and 60000 (default: \fB1800\fP)
.UNINDENT
.sp
Additionally, the \fBmxpref\fP key can be present, but must be accompanied
by an \fBemailtype\fP key.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_domains_dns.set_hosts sld tld hosts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.namecheap_domains_ns
.sp
Namecheap Nameserver Management
.sp
New in version 2017.7.0.

.SS Prerequisites
.sp
This module uses the \fBrequests\fP Python module to communicate to the namecheap
API.
.SS Configuration
.sp
The Namecheap username, API key and URL should be set in the minion configuration
file, or in the Pillar data.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
namecheap.name: companyname
namecheap.key: a1b2c3d4e5f67a8b9c0d1e2f3
namecheap.client_ip: 162.155.30.172
#Real url
namecheap.url: https://api.namecheap.com/xml.response
#Sandbox url
#namecheap.url: https://api.sandbox.namecheap.xml.response
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains_ns.create(sld, tld, nameserver, ip)
Creates a new nameserver. Returns \fBTrue\fP if the nameserver was created
successfully.
.INDENT 7.0
.TP
.B sld
SLD of the domain name
.TP
.B tld
TLD of the domain name
.TP
.B nameserver
Nameserver to create
.TP
.B ip
Nameserver IP address
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq namecheap_domains_ns.create sld tld nameserver ip
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains_ns.delete(sld, tld, nameserver)
Deletes a nameserver. Returns \fBTrue\fP if the nameserver was deleted
successfully
.INDENT 7.0
.TP
.B sld
SLD of the domain name
.TP
.B tld
TLD of the domain name
.TP
.B nameserver
Nameserver to delete
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq namecheap_domains_ns.delete sld tld nameserver
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains_ns.get_info(sld, tld, nameserver)
Retrieves information about a registered nameserver. Returns the following
information:
.INDENT 7.0
.IP \(bu 2
IP Address set for the nameserver
.IP \(bu 2
Domain name which was queried
.IP \(bu 2
A list of nameservers and their statuses
.UNINDENT
.INDENT 7.0
.TP
.B sld
SLD of the domain name
.TP
.B tld
TLD of the domain name
.TP
.B nameserver
Nameserver to retrieve
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq namecheap_domains_ns.get_info sld tld nameserver
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_domains_ns.update(sld, tld, nameserver, old_ip, new_ip)
Deletes a nameserver. Returns \fBTrue\fP if the nameserver was updated
successfully.
.INDENT 7.0
.TP
.B sld
SLD of the domain name
.TP
.B tld
TLD of the domain name
.TP
.B nameserver
Nameserver to create
.TP
.B old_ip
Current ip address
.TP
.B new_ip
New ip address
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq namecheap_domains_ns.update sld tld nameserver old_ip new_ip
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.namecheap_ssl
.sp
Namecheap SSL Certificate Management
.sp
New in version 2017.7.0.

.SS Prerequisites
.sp
This module uses the \fBrequests\fP Python module to communicate to the namecheap
API.
.SS Configuration
.sp
The Namecheap username, API key and URL should be set in the minion configuration
file, or in the Pillar data.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
namecheap.name: companyname
namecheap.key: a1b2c3d4e5f67a8b9c0d1e2f3
namecheap.client_ip: 162.155.30.172
#Real url
namecheap.url: https://api.namecheap.com/xml.response
#Sandbox url
#namecheap.url: https://api.sandbox.namecheap.xml.response
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_ssl.activate(csr_file, certificate_id, web_server_type, approver_email=None, http_dc_validation=False, **kwargs)
Activates a newly\-purchased SSL certificate. Returns a dictionary of result
values.
.INDENT 7.0
.TP
.B csr_file
Path to Certificate Signing Request file
.TP
.B certificate_id
Unique ID of the SSL certificate you wish to activate
.TP
.B web_server_type
The type of certificate format to return. Possible values include:
.INDENT 7.0
.IP \(bu 2
apache2
.IP \(bu 2
apacheapachessl
.IP \(bu 2
apacheopenssl
.IP \(bu 2
apacheraven
.IP \(bu 2
apachessl
.IP \(bu 2
apachessleay
.IP \(bu 2
c2net
.IP \(bu 2
cobaltseries
.IP \(bu 2
cpanel
.IP \(bu 2
domino
.IP \(bu 2
dominogo4625
.IP \(bu 2
dominogo4626
.IP \(bu 2
ensim
.IP \(bu 2
hsphere
.IP \(bu 2
ibmhttp
.IP \(bu 2
iis
.IP \(bu 2
iis4
.IP \(bu 2
iis5
.IP \(bu 2
iplanet
.IP \(bu 2
ipswitch
.IP \(bu 2
netscape
.IP \(bu 2
other
.IP \(bu 2
plesk
.IP \(bu 2
tomcat
.IP \(bu 2
weblogic
.IP \(bu 2
website
.IP \(bu 2
webstar
.IP \(bu 2
zeusv3
.UNINDENT
.TP
.B approver_email
The email ID which is on the approver email list.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBhttp_dc_validation\fP must be set to \fBFalse\fP if this option is
used.
.UNINDENT
.UNINDENT
.TP
.B http_dc_validation
False
Whether or not to activate using HTTP\-based validation.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For other parameters which may be required, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_ssl.activate my\-csr\-file my\-cert\-id apachessl
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_ssl.create(years, certificate_type, promotion_code=None, sans_to_add=None)
Creates a new SSL certificate. Returns the following information:
.INDENT 7.0
.IP \(bu 2
Whether or not the SSL order was successful
.IP \(bu 2
The certificate ID
.IP \(bu 2
The order ID
.IP \(bu 2
The transaction ID
.IP \(bu 2
The amount charged for the order
.IP \(bu 2
The date on which the certificate was created
.IP \(bu 2
The date on which the certificate will expire
.IP \(bu 2
The type of SSL certificate
.IP \(bu 2
The number of years for which the certificate was purchased
.IP \(bu 2
The current status of the SSL certificate
.UNINDENT
.INDENT 7.0
.TP
.B years
1
Number of years to register
.TP
.B certificate_type
Type of SSL Certificate. Possible values include:
.INDENT 7.0
.IP \(bu 2
EV Multi Domain SSL
.IP \(bu 2
EV SSL
.IP \(bu 2
EV SSL SGC
.IP \(bu 2
EssentialSSL
.IP \(bu 2
EssentialSSL Wildcard
.IP \(bu 2
InstantSSL
.IP \(bu 2
InstantSSL Pro
.IP \(bu 2
Multi Domain SSL
.IP \(bu 2
PositiveSSL
.IP \(bu 2
PositiveSSL Multi Domain
.IP \(bu 2
PositiveSSL Wildcard
.IP \(bu 2
PremiumSSL
.IP \(bu 2
PremiumSSL Wildcard
.IP \(bu 2
QuickSSL Premium
.IP \(bu 2
RapidSSL
.IP \(bu 2
RapidSSL Wildcard
.IP \(bu 2
SGC Supercert
.IP \(bu 2
SSL Web Server
.IP \(bu 2
SSL Webserver EV
.IP \(bu 2
SSL123
.IP \(bu 2
Secure Site
.IP \(bu 2
Secure Site Pro
.IP \(bu 2
Secure Site Pro with EV
.IP \(bu 2
Secure Site with EV
.IP \(bu 2
True BusinessID
.IP \(bu 2
True BusinessID Multi Domain
.IP \(bu 2
True BusinessID Wildcard
.IP \(bu 2
True BusinessID with EV
.IP \(bu 2
True BusinessID with EV Multi Domain
.IP \(bu 2
Unified Communications
.UNINDENT
.TP
.B promotional_code
An optional promo code to use when creating the certificate
.TP
.B sans_to_add
0
This parameter defines the number of add\-on domains to be purchased in
addition to the default number of domains included with a multi\-domain
certificate. Each certificate that supports SANs has the default number
of domains included. You may check the default number of domains
included and the maximum number of domains that can be added to it in
the table below.
.UNINDENT
.TS
center;
|l|l|l|l|l|.
_
T{
Provider
T}	T{
Product name
T}	T{
Default number of
domains (domain from
CSR is counted here)
T}	T{
Maximum number of
total domains
T}	T{
Maximum number
of domains
that can be
passed in
sans_to_add
parameter
T}
_
T{
Comodo
T}	T{
PositiveSSL
Multi\-Domain
T}	T{
3
T}	T{
100
T}	T{
97
T}
_
T{
Comodo
T}	T{
Multi\-Domain
SSL
T}	T{
3
T}	T{
100
T}	T{
97
T}
_
T{
Comodo
T}	T{
EV Multi\-
Domain SSL
T}	T{
3
T}	T{
100
T}	T{
97
T}
_
T{
Comodo
T}	T{
Unified
Communications
T}	T{
3
T}	T{
100
T}	T{
97
T}
_
T{
GeoTrust
T}	T{
QuickSSL
Premium
T}	T{
1
T}	T{
1 domain +
4 subdomains
T}	T{
The only
supported
value is 4
T}
_
T{
GeoTrust
T}	T{
True
BusinessID
with EV
Multi\-Domain
T}	T{
5
T}	T{
25
T}	T{
20
T}
_
T{
GeoTrust
T}	T{
True Business
ID Multi\-
Domain
T}	T{
5
T}	T{
25
T}	T{
20
T}
_
T{
Thawte
T}	T{
SSL Web
Server
T}	T{
1
T}	T{
25
T}	T{
24
T}
_
T{
Thawte
T}	T{
SSL Web
Server with
EV
T}	T{
1
T}	T{
25
T}	T{
24
T}
_
T{
Thawte
T}	T{
SGC Supercerts
T}	T{
1
T}	T{
25
T}	T{
24
T}
_
T{
Symantec
T}	T{
Secure Site
Pro with EV
T}	T{
1
T}	T{
25
T}	T{
24
T}
_
T{
Symantec
T}	T{
Secure Site
with EV
T}	T{
1
T}	T{
25
T}	T{
24
T}
_
T{
Symantec
T}	T{
Secure Site
T}	T{
1
T}	T{
25
T}	T{
24
T}
_
T{
Symantec
T}	T{
Secure Site
Pro
T}	T{
1
T}	T{
25
T}	T{
24
T}
_
.TE
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_ssl.create 2 RapidSSL
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_ssl.get_info(certificate_id, returncertificate=False, returntype=None)
Retrieves information about the requested SSL certificate. Returns a
dictionary of information about the SSL certificate with two keys:
.INDENT 7.0
.IP \(bu 2
\fBssl\fP \- Contains the metadata information
.IP \(bu 2
\fBcertificate\fP \- Contains the details for the certificate such as the
CSR, Approver, and certificate data
.UNINDENT
.INDENT 7.0
.TP
.B certificate_id
Unique ID of the SSL certificate
.TP
.B returncertificate
False
Set to \fBTrue\fP to ask for the certificate in response
.TP
.B returntype
Optional type for the returned certificate. Can be either \(dqIndividual\(dq
(for X.509 format) or \(dqPKCS7\(dq
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Required if \fBreturncertificate\fP is \fBTrue\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_ssl.get_info my\-cert\-id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_ssl.get_list(**kwargs)
Returns a list of SSL certificates for a particular user
.INDENT 7.0
.TP
.B ListType
All
Possible values:
.INDENT 7.0
.IP \(bu 2
All
.IP \(bu 2
Processing
.IP \(bu 2
EmailSent
.IP \(bu 2
TechnicalProblem
.IP \(bu 2
InProgress
.IP \(bu 2
Completed
.IP \(bu 2
Deactivated
.IP \(bu 2
Active
.IP \(bu 2
Cancelled
.IP \(bu 2
NewPurchase
.IP \(bu 2
NewRenewal
.UNINDENT
.INDENT 7.0
.TP
.B SearchTerm
Keyword to look for on the SSL list
.TP
.B Page
1
Page number to return
.TP
.B PageSize
20
Total number of SSL certificates to display per page (minimum:
\fB10\fP, maximum: \fB100\fP)
.TP
.B SoryBy
One of \fBPURCHASEDATE\fP, \fBPURCHASEDATE_DESC\fP, \fBSSLTYPE\fP,
\fBSSLTYPE_DESC\fP, \fBEXPIREDATETIME\fP, \fBEXPIREDATETIME_DESC\fP,
\fBHost_Name\fP, or \fBHost_Name_DESC\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_ssl.get_list Processing
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_ssl.parse_csr(csr_file, certificate_type, http_dc_validation=False)
Parses the CSR. Returns a dictionary of result values.
.INDENT 7.0
.TP
.B csr_file
Path to Certificate Signing Request file
.TP
.B certificate_type
Type of SSL Certificate. Possible values include:
.INDENT 7.0
.IP \(bu 2
EV Multi Domain SSL
.IP \(bu 2
EV SSL
.IP \(bu 2
EV SSL SGC
.IP \(bu 2
EssentialSSL
.IP \(bu 2
EssentialSSL Wildcard
.IP \(bu 2
InstantSSL
.IP \(bu 2
InstantSSL Pro
.IP \(bu 2
Multi Domain SSL
.IP \(bu 2
PositiveSSL
.IP \(bu 2
PositiveSSL Multi Domain
.IP \(bu 2
PositiveSSL Wildcard
.IP \(bu 2
PremiumSSL
.IP \(bu 2
PremiumSSL Wildcard
.IP \(bu 2
QuickSSL Premium
.IP \(bu 2
RapidSSL
.IP \(bu 2
RapidSSL Wildcard
.IP \(bu 2
SGC Supercert
.IP \(bu 2
SSL Web Server
.IP \(bu 2
SSL Webserver EV
.IP \(bu 2
SSL123
.IP \(bu 2
Secure Site
.IP \(bu 2
Secure Site Pro
.IP \(bu 2
Secure Site Pro with EV
.IP \(bu 2
Secure Site with EV
.IP \(bu 2
True BusinessID
.IP \(bu 2
True BusinessID Multi Domain
.IP \(bu 2
True BusinessID Wildcard
.IP \(bu 2
True BusinessID with EV
.IP \(bu 2
True BusinessID with EV Multi Domain
.IP \(bu 2
Unified Communications
.UNINDENT
.TP
.B http_dc_validation
False
Set to \fBTrue\fP if a Comodo certificate and validation should be
done with files instead of emails and to return the info to do so
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_ssl.parse_csr my\-csr\-file PremiumSSL
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_ssl.reissue(csr_file, certificate_id, web_server_type, approver_email=None, http_dc_validation=False, **kwargs)
Reissues a purchased SSL certificate. Returns a dictionary of result
values.
.INDENT 7.0
.TP
.B csr_file
Path to Certificate Signing Request file
.TP
.B certificate_id
Unique ID of the SSL certificate you wish to activate
.TP
.B web_server_type
The type of certificate format to return. Possible values include:
.INDENT 7.0
.IP \(bu 2
apache2
.IP \(bu 2
apacheapachessl
.IP \(bu 2
apacheopenssl
.IP \(bu 2
apacheraven
.IP \(bu 2
apachessl
.IP \(bu 2
apachessleay
.IP \(bu 2
c2net
.IP \(bu 2
cobaltseries
.IP \(bu 2
cpanel
.IP \(bu 2
domino
.IP \(bu 2
dominogo4625
.IP \(bu 2
dominogo4626
.IP \(bu 2
ensim
.IP \(bu 2
hsphere
.IP \(bu 2
ibmhttp
.IP \(bu 2
iis
.IP \(bu 2
iis4
.IP \(bu 2
iis5
.IP \(bu 2
iplanet
.IP \(bu 2
ipswitch
.IP \(bu 2
netscape
.IP \(bu 2
other
.IP \(bu 2
plesk
.IP \(bu 2
tomcat
.IP \(bu 2
weblogic
.IP \(bu 2
website
.IP \(bu 2
webstar
.IP \(bu 2
zeusv3
.UNINDENT
.TP
.B approver_email
The email ID which is on the approver email list.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBhttp_dc_validation\fP must be set to \fBFalse\fP if this option is
used.
.UNINDENT
.UNINDENT
.TP
.B http_dc_validation
False
Whether or not to activate using HTTP\-based validation.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For other parameters which may be required, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_ssl.reissue my\-csr\-file my\-cert\-id apachessl
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_ssl.renew(years, certificate_id, certificate_type, promotion_code=None)
Renews an SSL certificate if it is ACTIVE and Expires <= 30 days. Returns
the following information:
.INDENT 7.0
.IP \(bu 2
The certificate ID
.IP \(bu 2
The order ID
.IP \(bu 2
The transaction ID
.IP \(bu 2
The amount charged for the order
.UNINDENT
.INDENT 7.0
.TP
.B years
1
Number of years to register
.TP
.B certificate_id
Unique ID of the SSL certificate you wish to renew
.TP
.B certificate_type
Type of SSL Certificate. Possible values include:
.INDENT 7.0
.IP \(bu 2
EV Multi Domain SSL
.IP \(bu 2
EV SSL
.IP \(bu 2
EV SSL SGC
.IP \(bu 2
EssentialSSL
.IP \(bu 2
EssentialSSL Wildcard
.IP \(bu 2
InstantSSL
.IP \(bu 2
InstantSSL Pro
.IP \(bu 2
Multi Domain SSL
.IP \(bu 2
PositiveSSL
.IP \(bu 2
PositiveSSL Multi Domain
.IP \(bu 2
PositiveSSL Wildcard
.IP \(bu 2
PremiumSSL
.IP \(bu 2
PremiumSSL Wildcard
.IP \(bu 2
QuickSSL Premium
.IP \(bu 2
RapidSSL
.IP \(bu 2
RapidSSL Wildcard
.IP \(bu 2
SGC Supercert
.IP \(bu 2
SSL Web Server
.IP \(bu 2
SSL Webserver EV
.IP \(bu 2
SSL123
.IP \(bu 2
Secure Site
.IP \(bu 2
Secure Site Pro
.IP \(bu 2
Secure Site Pro with EV
.IP \(bu 2
Secure Site with EV
.IP \(bu 2
True BusinessID
.IP \(bu 2
True BusinessID Multi Domain
.IP \(bu 2
True BusinessID Wildcard
.IP \(bu 2
True BusinessID with EV
.IP \(bu 2
True BusinessID with EV Multi Domain
.IP \(bu 2
Unified Communications
.UNINDENT
.TP
.B promotional_code
An optional promo code to use when renewing the certificate
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_ssl.renew 1 my\-cert\-id RapidSSL
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.namecheap_users
.sp
Namecheap User Management
.sp
New in version 2017.7.0.

.SS Prerequisites
.sp
This module uses the \fBrequests\fP Python module to communicate to the namecheap
API.
.SS Configuration
.sp
The Namecheap username, API key and URL should be set in the minion configuration
file, or in the Pillar data.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
namecheap.name: companyname
namecheap.key: a1b2c3d4e5f67a8b9c0d1e2f3
namecheap.client_ip: 162.155.30.172
#Real url
namecheap.url: https://api.namecheap.com/xml.response
#Sandbox url
#namecheap.url: https://api.sandbox.namecheap.xml.response
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_users.check_balances(minimum=100)
Checks if the provided minimum value is present in the user\(aqs account.
.sp
Returns a boolean. Returns \fBFalse\fP if the user\(aqs account balance is less
than the provided minimum or \fBTrue\fP if greater than the minimum.
.INDENT 7.0
.TP
.B minimum
100
The value to check
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_users.check_balances
salt \(aqmy\-minion\(aq namecheap_users.check_balances minimum=150
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.namecheap_users.get_balances()
Gets information about fund in the user\(aqs account. This method returns the
following information: Available Balance, Account Balance, Earned Amount,
Withdrawable Amount and Funds Required for AutoRenew.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If a domain setup with automatic renewal is expiring within the next 90
days, the FundsRequiredForAutoRenew attribute shows the amount needed
in your Namecheap account to complete auto renewal.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy\-minion\(aq namecheap_users.get_balances
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.napalm_bgp
.SS NAPALM BGP
.sp
Manages BGP configuration on network devices and provides statistics.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP> & Jerome Fleury <\fI\%jf@cloudflare.com\fP>
.TP
.B maturity
new
.TP
.B depends
napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
\fI\%napalm proxy minion\fP
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.modules.napalm_bgp.config(group=None, neighbor=None, **kwargs)
Provides the BGP configuration on the device.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBgroup\fP \-\- Name of the group selected to display the configuration.
.IP \(bu 2
\fBneighbor\fP \-\- IP Address of the neighbor to display the configuration.
If the group parameter is not specified, the neighbor setting will be
ignored.
.UNINDENT
.TP
.B Returns
A dictionary containing the BGP configuration from the network
device. The keys of the main dictionary are the group names.
.UNINDENT
.sp
Each group has the following properties:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
type (string)
.IP \(bu 2
description (string)
.IP \(bu 2
apply_groups (string list)
.IP \(bu 2
multihop_ttl (int)
.IP \(bu 2
multipath (True/False)
.IP \(bu 2
local_address (string)
.IP \(bu 2
local_as (int)
.IP \(bu 2
remote_as (int)
.IP \(bu 2
import_policy (string)
.IP \(bu 2
export_policy (string)
.IP \(bu 2
remove_private_as (True/False)
.IP \(bu 2
prefix_limit (dictionary)
.IP \(bu 2
neighbors (dictionary)
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Each neighbor in the dictionary of neighbors provides:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
description (string)
.IP \(bu 2
import_policy (string)
.IP \(bu 2
export_policy (string)
.IP \(bu 2
local_address (string)
.IP \(bu 2
local_as (int)
.IP \(bu 2
remote_as (int)
.IP \(bu 2
authentication_key (string)
.IP \(bu 2
prefix_limit (dictionary)
.IP \(bu 2
route_reflector_client (True/False)
.IP \(bu 2
nhs (True/False)
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bgp.config # entire BGP config
salt \(aq*\(aq bgp.config PEERS\-GROUP\-NAME # provides detail only about BGP group PEERS\-GROUP\-NAME
salt \(aq*\(aq bgp.config PEERS\-GROUP\-NAME 172.17.17.1 # provides details only about BGP neighbor 172.17.17.1,
# configured in the group PEERS\-GROUP\-NAME
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqPEERS\-GROUP\-NAME\(aq:{
        \(aqtype\(aq          : \(aqexternal\(aq,
        \(aqdescription\(aq   : \(aqHere we should have a nice description\(aq,
        \(aqapply_groups\(aq  : [\(aqBGP\-PREFIX\-LIMIT\(aq],
        \(aqimport_policy\(aq : \(aqPUBLIC\-PEER\-IN\(aq,
        \(aqexport_policy\(aq : \(aqPUBLIC\-PEER\-OUT\(aq,
        \(aqremove_private\(aq: True,
        \(aqmultipath\(aq     : True,
        \(aqmultihop_ttl\(aq  : 30,
        \(aqneighbors\(aq     : {
            \(aq192.168.0.1\(aq: {
                \(aqdescription\(aq   : \(aqFacebook [CDN]\(aq,
                \(aqprefix_limit\(aq  : {
                    \(aqinet\(aq: {
                        \(aqunicast\(aq: {
                            \(aqlimit\(aq: 100,
                            \(aqteardown\(aq: {
                                \(aqthreshold\(aq : 95,
                                \(aqtimeout\(aq   : 5
                            }
                        }
                    }
                }
                \(aqpeer\-as\(aq        : 32934,
                \(aqroute_reflector\(aq: False,
                \(aqnhs\(aq            : True
            },
            \(aq172.17.17.1\(aq: {
                \(aqdescription\(aq   : \(aqTwitter [CDN]\(aq,
                \(aqprefix_limit\(aq  : {
                    \(aqinet\(aq: {
                        \(aqunicast\(aq: {
                            \(aqlimit\(aq: 500,
                            \(aqno\-validate\(aq: \(aqIMPORT\-FLOW\-ROUTES\(aq
                        }
                    }
                }
                \(aqpeer_as\(aq        : 13414
                \(aqroute_reflector\(aq: False,
                \(aqnhs\(aq            : False
            }
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_bgp.neighbors(neighbor=None, **kwargs)
Provides details regarding the BGP sessions configured on the network device.
.INDENT 7.0
.TP
.B Parameters
\fBneighbor\fP \-\- IP Address of a specific neighbor.
.TP
.B Returns
A dictionary with the statistics of the all/selected BGP
neighbors. Outer dictionary keys represent the VRF name.  Keys of inner
dictionary represent the AS numbers, while the values are lists of
dictionaries, having the following keys:
.INDENT 7.0
.IP \(bu 2
up (True/False)
.IP \(bu 2
local_as (int)
.IP \(bu 2
remote_as (int)
.IP \(bu 2
local_address (string)
.IP \(bu 2
routing_table (string)
.IP \(bu 2
local_address_configured (True/False)
.IP \(bu 2
local_port (int)
.IP \(bu 2
remote_address (string)
.IP \(bu 2
remote_port (int)
.IP \(bu 2
multihop (True/False)
.IP \(bu 2
multipath (True/False)
.IP \(bu 2
remove_private_as (True/False)
.IP \(bu 2
import_policy (string)
.IP \(bu 2
export_policy (string)
.IP \(bu 2
input_messages (int)
.IP \(bu 2
output_messages (int)
.IP \(bu 2
input_updates (int)
.IP \(bu 2
output_updates (int)
.IP \(bu 2
messages_queued_out (int)
.IP \(bu 2
connection_state (string)
.IP \(bu 2
previous_connection_state (string)
.IP \(bu 2
last_event (string)
.IP \(bu 2
suppress_4byte_as (True/False)
.IP \(bu 2
local_as_prepend (True/False)
.IP \(bu 2
holdtime (int)
.IP \(bu 2
configured_holdtime (int)
.IP \(bu 2
keepalive (int)
.IP \(bu 2
configured_keepalive (int)
.IP \(bu 2
active_prefix_count (int)
.IP \(bu 2
received_prefix_count (int)
.IP \(bu 2
accepted_prefix_count (int)
.IP \(bu 2
suppressed_prefix_count (int)
.IP \(bu 2
advertised_prefix_count (int)
.IP \(bu 2
flap_count (int)
.UNINDENT

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq bgp.neighbors  # all neighbors
salt \(aq*\(aq bgp.neighbors 172.17.17.1  # only session with BGP neighbor(s) 172.17.17.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqdefault\(aq: {
        8121: [
            {
                \(aqup\(aq                        : True,
                \(aqlocal_as\(aq                  : 13335,
                \(aqremote_as\(aq                 : 8121,
                \(aqlocal_address\(aq             : \(aq172.101.76.1\(aq,
                \(aqlocal_address_configured\(aq  : True,
                \(aqlocal_port\(aq                : 179,
                \(aqremote_address\(aq            : \(aq192.247.78.0\(aq,
                \(aqrouter_id\(aq                 : \(aq192.168.0.1\(aq,
                \(aqremote_port\(aq               : 58380,
                \(aqmultihop\(aq                  : False,
                \(aqimport_policy\(aq             : \(aq4\-NTT\-TRANSIT\-IN\(aq,
                \(aqexport_policy\(aq             : \(aq4\-NTT\-TRANSIT\-OUT\(aq,
                \(aqinput_messages\(aq            : 123,
                \(aqoutput_messages\(aq           : 13,
                \(aqinput_updates\(aq             : 123,
                \(aqoutput_updates\(aq            : 5,
                \(aqmessages_queued_out\(aq       : 23,
                \(aqconnection_state\(aq          : \(aqEstablished\(aq,
                \(aqprevious_connection_state\(aq : \(aqEstabSync\(aq,
                \(aqlast_event\(aq                : \(aqRecvKeepAlive\(aq,
                \(aqsuppress_4byte_as\(aq         : False,
                \(aqlocal_as_prepend\(aq          : False,
                \(aqholdtime\(aq                  : 90,
                \(aqconfigured_holdtime\(aq       : 90,
                \(aqkeepalive\(aq                 : 30,
                \(aqconfigured_keepalive\(aq      : 30,
                \(aqactive_prefix_count\(aq       : 132808,
                \(aqreceived_prefix_count\(aq     : 566739,
                \(aqaccepted_prefix_count\(aq     : 566479,
                \(aqsuppressed_prefix_count\(aq   : 0,
                \(aqadvertise_prefix_count\(aq    : 0,
                \(aqflap_count\(aq                : 27
            }
        ]
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.napalm_formula
.SS NAPALM Formula helpers
.sp
New in version 2019.2.0.

.sp
This is an Execution Module providing helpers for various NAPALM formulas,
e.g., napalm\-interfaces\-formula, napalm\-bgp\-formula, napalm\-ntp\-formula etc.,
meant to provide various helper functions to make the templates more readable.
.INDENT 0.0
.TP
.B salt.modules.napalm_formula.container_path(model, key=None, container=None, delim=\(aq:\(aq)
Return the list of all the possible paths in a container, down to the
\fBconfig\fP container.
This function can be used to verify that the \fBmodel\fP is a Python object
correctly structured and respecting the OpenConfig hierarchy.
.INDENT 7.0
.TP
.B model
The OpenConfig\-structured object to inspect.
.TP
.B delim: \fB:\fP
The key delimiter. In particular cases, it is indicated to use \fB//\fP
as \fB:\fP might be already used in various cases, e.g., IPv6 addresses,
interface name (e.g., Juniper QFX series), etc.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm_formula.container_path \(dq{\(aqinterfaces\(aq: {\(aqinterface\(aq: {\(aqEthernet1\(aq: {\(aqconfig\(aq: {\(aqname\(aq: \(aqEthernet1\(aq}}}}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The example above would return a list with the following element:
\fBinterfaces:interface:Ethernet1:config\fP which is the only possible path
in that hierarchy.
.sp
Other output examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- interfaces:interface:Ethernet1:config
\- interfaces:interface:Ethernet1:subinterfaces:subinterface:0:config
\- interfaces:interface:Ethernet2:config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_formula.defaults(model, defaults_, delim=\(aq//\(aq, flipped_merge=False)
Apply the defaults to a Python dictionary having the structure as described
in the OpenConfig standards.
.INDENT 7.0
.TP
.B model
The OpenConfig model to apply the defaults to.
.TP
.B defaults
The dictionary of defaults. This argument must equally be structured
with respect to the OpenConfig standards.
.sp
For ease of use, the keys of these support glob matching, therefore
we don\(aqt have to provide the defaults for each entity but only for
the entity type. See an example below.
.TP
.B delim: \fB//\fP
The key delimiter to use. Generally, \fB//\fP should cover all the possible
cases, and you don\(aqt need to override this value.
.TP
.B flipped_merge: \fBFalse\fP
Whether should merge the model into the defaults, or the defaults
into the model. Default: \fBFalse\fP (merge the model into the defaults,
i.e., any defaults would be overridden by the values from the \fBmodel\fP).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm_formula.defaults \(dq{\(aqinterfaces\(aq: {\(aqinterface\(aq: {\(aqEthernet1\(aq: {\(aqconfig\(aq: {\(aqname\(aq: \(aqEthernet1\(aq}}}}}\(dq \(dq{\(aqinterfaces\(aq: {\(aqinterface\(aq: {\(aq*\(aq: {\(aqconfig\(aq: {\(aqenabled\(aq: True}}}}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As one can notice in the example above, the \fB*\fP corresponds to the
interface name, therefore, the defaults will be applied on all the
interfaces.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_formula.dictupdate(dest, upd, recursive_update=True, merge_lists=False)
Recursive version of the default dict.update
.sp
Merges upd recursively into dest
.sp
If recursive_update=False, will use the classic dict.update, or fall back
on a manual merge (helpful for non\-dict types like \fBFunctionWrapper\fP).
.sp
If \fBmerge_lists=True\fP, will aggregate list object types instead of replace.
The list in \fBupd\fP is added to the list in \fBdest\fP, so the resulting list
is \fBdest[key] + upd[key]\fP\&. This behaviour is only activated when
\fBrecursive_update=True\fP\&. By default \fBmerge_lists=False\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_formula.render_field(dictionary, field, prepend=None, append=None, quotes=False, **opts)
Render a field found under the \fBfield\fP level of the hierarchy in the
\fBdictionary\fP object.
This is useful to render a field in a Jinja template without worrying that
the hierarchy might not exist. For example if we do the following in Jinja:
\fB{{ interfaces.interface.Ethernet5.config.description }}\fP for the
following object:
\fB{\(aqinterfaces\(aq: {\(aqinterface\(aq: {\(aqEthernet1\(aq: {\(aqconfig\(aq: {\(aqenabled\(aq: True}}}}}\fP
it would error, as the \fBEthernet5\fP key does not exist.
With this helper, we can skip this and avoid existence checks. This must be
however used with care.
.INDENT 7.0
.TP
.B dictionary
The dictionary to traverse.
.TP
.B field
The key name or part to traverse in the \fBdictionary\fP\&.
.TP
.B prepend: \fBNone\fP
The text to prepend in front of the text. Usually, we need to have the
name of the field too when generating the configuration.
.TP
.B append: \fBNone\fP
Text to append at the end.
.TP
.B quotes: \fBFalse\fP
Whether should wrap the text around quotes.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm_formula.render_field \(dq{\(aqenabled\(aq: True}\(dq enabled
# This would return the value of the \(ga\(gaenabled\(ga\(ga leaf key
salt \(aq*\(aq napalm_formula.render_field \(dq{\(aqenabled\(aq: True}\(dq description
# This would not error
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Jinja usage example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set config = {\(aqenabled\(aq: True, \(aqdescription\(aq: \(aqInterface description\(aq} %}
{{ salt.napalm_formula.render_field(config, \(aqdescription\(aq, quotes=True) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The example above would be rendered on Arista / Cisco as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
description \(dqInterface description\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
While on Junos (the semicolon is important to be added, otherwise the
configuration won\(aqt be accepted by Junos):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
description \(dqInterface description\(dq;
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_formula.render_fields(dictionary, *fields, **opts)
This function works similarly to
\fI\%render_field\fP but for a
list of fields from the same dictionary, rendering, indenting and
distributing them on separate lines.
.INDENT 7.0
.TP
.B dictionary
The dictionary to traverse.
.TP
.B fields
A list of field names or paths in the dictionary.
.TP
.B indent: \fB0\fP
The indentation to use, prepended to the rendered field.
.TP
.B separator: \fB\en\fP
The separator to use between fields.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm_formula.render_fields \(dq{\(aqmtu\(aq: 68, \(aqdescription\(aq: \(aqInterface description\(aq}\(dq mtu description
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Jinja usage example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set config={\(aqmtu\(aq: 68, \(aqdescription\(aq: \(aqInterface description\(aq} %}
{{ salt.napalm_formula.render_fields(config, \(aqmtu\(aq, \(aqdescription\(aq, quotes=True) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The Jinja example above would generate the following configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mtu \(dq68\(dq
description \(dqInterface description\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_formula.setval(key, val, dict_=None, delim=\(aq:\(aq)
Set a value under the dictionary hierarchy identified
under the key. The target \(aqfoo/bar/baz\(aq returns the
dictionary hierarchy {\(aqfoo\(aq: {\(aqbar\(aq: {\(aqbaz\(aq: {}}}}.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Currently this doesn\(aqt work with integers, i.e.
cannot build lists dynamically.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq formula.setval foo:baz:bar True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_formula.traverse(data, key, default=None, delimiter=\(aq:\(aq)
Traverse a dict or list using a colon\-delimited (or otherwise delimited,
using the \fBdelimiter\fP param) target string. The target \fBfoo:bar:0\fP will
return \fBdata[\(aqfoo\(aq][\(aqbar\(aq][0]\fP if this value exists, and will otherwise
return the dict in the default argument.
Function will automatically determine the target type.
The target \fBfoo:bar:0\fP will return data[\(aqfoo\(aq][\(aqbar\(aq][0] if data like
\fB{\(aqfoo\(aq:{\(aqbar\(aq:[\(aqbaz\(aq]}}\fP , if data like \fB{\(aqfoo\(aq:{\(aqbar\(aq:{\(aq0\(aq:\(aqbaz\(aq}}}\fP
then \fBreturn data[\(aqfoo\(aq][\(aqbar\(aq][\(aq0\(aq]\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm_formula.traverse \(dq{\(aqfoo\(aq: {\(aqbar\(aq: {\(aqbaz\(aq: True}}}\(dq foo:baz:bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.napalm_mod
.SS NAPALM helpers
.sp
Helpers for the NAPALM modules.
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.modules.napalm_mod.alive(**kwargs)
Returns the alive status of the connection layer.
The output is a dictionary under the usual dictionary
output of the NAPALM modules.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.alive
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
result: True
out:
    is_alive: False
comment: \(aq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.call(method, *args, **kwargs)
Execute arbitrary methods from the NAPALM library.
To see the expected output, please consult the NAPALM documentation.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This feature is not recommended to be used in production.
It should be used for testing only!
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.call get_lldp_neighbors
salt \(aq*\(aq napalm.call get_firewall_policies
salt \(aq*\(aq napalm.call get_bgp_config group=\(aqmy\-group\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.compliance_report(filepath=None, string=None, renderer=\(aqjinja|yaml\(aq, **kwargs)
Return the compliance report.
.INDENT 7.0
.TP
.B filepath
The absolute path to the validation file.
.sp
Changed in version 2019.2.0.

.sp
Beginning with release codename \fB2019.2.0\fP, this function has been
enhanced, to be able to leverage the multi\-engine template rendering
of Salt, besides the possibility to retrieve the file source from
remote systems, the URL schemes supported being:
.INDENT 7.0
.IP \(bu 2
\fBsalt://\fP
.IP \(bu 2
\fBhttp://\fP and \fBhttps://\fP
.IP \(bu 2
\fBftp://\fP
.IP \(bu 2
\fBs3://\fP
.IP \(bu 2
\fBswift:/\fP
.UNINDENT
.sp
Or on the local file system (on the Minion).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The rendering result does not necessarily need to be YAML, instead
it can be any format interpreted by Salt\(aqs rendering pipeline
(including pure Python).
.UNINDENT
.UNINDENT
.TP
.B string
New in version 2019.2.0.

.sp
The compliance report send as inline string, to be used as the file to
send through the renderer system. Note, not all renderer modules can
work with strings; the \(aqpy\(aq renderer requires a file, for example.
.TP
.B renderer: \fBjinja|yaml\fP
New in version 2019.2.0.

.sp
The renderer pipe to send the file through; this is overridden by a
\(dqshe\-bang\(dq at the top of the file.
.TP
.B kwargs
Changed in version 2019.2.0.

.sp
Keyword args to pass to Salt\(aqs compile_template() function.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.compliance_report ~/validate.yml
salt \(aq*\(aq napalm.compliance_report salt://path/to/validator.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Validation File Example (pure YAML):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- get_facts:
    os_version: 4.17

\- get_interfaces_ip:
    Management1:
      ipv4:
        10.0.2.14:
          prefix_length: 24
        _mode: strict
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Validation File Example (as Jinja + YAML):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- get_facts:
    os_version: {{ grains.version }}
\- get_interfaces_ip:
    Loopback0:
      ipv4:
        {{ grains.lo0.ipv4 }}:
          prefix_length: 24
        _mode: strict
\- get_bgp_neighbors: {{ pillar.bgp.neighbors }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
device1:
    \-\-\-\-\-\-\-\-\-\-
    comment:
    out:
        \-\-\-\-\-\-\-\-\-\-
        complies:
            False
        get_facts:
            \-\-\-\-\-\-\-\-\-\-
            complies:
                False
            extra:
            missing:
            present:
                \-\-\-\-\-\-\-\-\-\-
                os_version:
                    \-\-\-\-\-\-\-\-\-\-
                    actual_value:
                        15.1F6\-S1.4
                    complies:
                        False
                    nested:
                        False
        get_interfaces_ip:
            \-\-\-\-\-\-\-\-\-\-
            complies:
                False
            extra:
            missing:
                \- Management1
            present:
                \-\-\-\-\-\-\-\-\-\-
        skipped:
    result:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.config_diff_text(source1=\(aqcandidate\(aq, candidate_path=None, source2=\(aqrunning\(aq, running_path=None)
New in version 2019.2.0.

.sp
Return the diff, as text, between the two different configuration sources.
The sources can be either specified using the \fBsource1\fP and \fBsource2\fP
arguments when retrieving from the managed network device.
.INDENT 7.0
.TP
.B source1: \fBcandidate\fP
The source from where to retrieve the configuration to be compared with.
Available options: \fBcandidate\fP, \fBrunning\fP, \fBstartup\fP\&. Default:
\fBcandidate\fP\&.
.TP
.B candidate_path
Absolute or remote path from where to load the candidate configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B source2: \fBrunning\fP
The source from where to retrieve the configuration to compare with.
Available options: \fBcandidate\fP, \fBrunning\fP, \fBstartup\fP\&. Default:
\fBrunning\fP\&.
.TP
.B running_path
Absolute or remote path from where to load the running configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file.
Ignored if \fBcandidate_path\fP or \fBrunning_path\fP is not a
\fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.config_diff_text
salt \(aq*\(aq napalm.config_diff_text candidate_path=https://bit.ly/2mAdq7z
# Would compare the running config with the configuration available at
# https://bit.ly/2mAdq7z
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.config_diff_tree(source1=\(aqcandidate\(aq, candidate_path=None, source2=\(aqrunning\(aq, running_path=None)
New in version 2019.2.0.

.sp
Return the diff, as Python dictionary, between two different sources.
The sources can be either specified using the \fBsource1\fP and \fBsource2\fP
arguments when retrieving from the managed network device.
.INDENT 7.0
.TP
.B source1: \fBcandidate\fP
The source from where to retrieve the configuration to be compared with.
Available options: \fBcandidate\fP, \fBrunning\fP, \fBstartup\fP\&. Default:
\fBcandidate\fP\&.
.TP
.B candidate_path
Absolute or remote path from where to load the candidate configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B source2: \fBrunning\fP
The source from where to retrieve the configuration to compare with.
Available options: \fBcandidate\fP, \fBrunning\fP, \fBstartup\fP\&. Default:
\fBrunning\fP\&.
.TP
.B running_path
Absolute or remote path from where to load the running configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file.
Ignored if \fBcandidate_path\fP or \fBrunning_path\fP is not a
\fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.config_diff_text
salt \(aq*\(aq napalm.config_diff_text candidate_path=https://bit.ly/2mAdq7z
# Would compare the running config with the configuration available at
# https://bit.ly/2mAdq7z
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.config_diff_tree
salt \(aq*\(aq napalm.config_diff_tree running startup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.config_filter_lines(parent_regex, child_regex, source=\(aqrunning\(aq)
New in version 2019.2.0.

.sp
Return a list of detailed matches, for the configuration blocks (parent\-child
relationship) whose parent respects the regular expressions configured via
the \fBparent_regex\fP argument, and the child matches the \fBchild_regex\fP
regular expression. The result is a list of dictionaries with the following
keys:
.INDENT 7.0
.IP \(bu 2
\fBmatch\fP: a boolean value that tells whether \fBchild_regex\fP matched any
children lines.
.IP \(bu 2
\fBparent\fP: the parent line (as text).
.IP \(bu 2
\fBchild\fP: the child line (as text). If no child line matched, this field
will be \fBNone\fP\&.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function is only available only when the underlying library
\fI\%ciscoconfparse\fP
is installed. See
\fI\%ciscoconfparse module\fP for
more details.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B parent_regex
The regular expression to match the parent configuration lines against.
.TP
.B child_regex
The regular expression to match the child configuration lines against.
.TP
.B source: \fBrunning\fP
The configuration type to retrieve from the network device. Default:
\fBrunning\fP\&. Available options: \fBrunning\fP, \fBstartup\fP, \fBcandidate\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.config_filter_lines \(aq^interface\(aq \(aqip address\(aq
salt \(aq*\(aq napalm.config_filter_lines \(aq^interface\(aq \(aqshutdown\(aq source=candidate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.config_find_lines(regex, source=\(aqrunning\(aq)
New in version 2019.2.0.

.sp
Return the configuration lines that match the regular expressions from the
\fBregex\fP argument. The configuration is read from the network device
interrogated.
.INDENT 7.0
.TP
.B regex
The regular expression to match the configuration lines against.
.TP
.B source: \fBrunning\fP
The configuration type to retrieve from the network device. Default:
\fBrunning\fP\&. Available options: \fBrunning\fP, \fBstartup\fP, \fBcandidate\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.config_find_lines \(aq^interface Ethernet1\ed\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.config_lines_w_child(parent_regex, child_regex, source=\(aqrunning\(aq)
.INDENT 7.0
.INDENT 3.5
New in version 2019.2.0.

.UNINDENT
.UNINDENT
.sp
Return the configuration lines that match the regular expressions from the
\fBparent_regex\fP argument, having child lines matching \fBchild_regex\fP\&.
The configuration is read from the network device interrogated.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function is only available only when the underlying library
\fI\%ciscoconfparse\fP
is installed. See
\fI\%ciscoconfparse module\fP for
more details.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B parent_regex
The regular expression to match the parent configuration lines against.
.TP
.B child_regex
The regular expression to match the child configuration lines against.
.TP
.B source: \fBrunning\fP
The configuration type to retrieve from the network device. Default:
\fBrunning\fP\&. Available options: \fBrunning\fP, \fBstartup\fP, \fBcandidate\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.config_lines_w_child \(aq^interface\(aq \(aqip address\(aq
salt \(aq*\(aq napalm.config_lines_w_child \(aq^interface\(aq \(aqshutdown\(aq source=candidate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.config_lines_wo_child(parent_regex, child_regex, source=\(aqrunning\(aq)
.INDENT 7.0
.INDENT 3.5
New in version 2019.2.0.

.UNINDENT
.UNINDENT
.sp
Return the configuration lines that match the regular expressions from the
\fBparent_regex\fP argument, having the child lines \fInot\fP matching
\fBchild_regex\fP\&.
The configuration is read from the network device interrogated.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function is only available only when the underlying library
\fI\%ciscoconfparse\fP
is installed. See
\fI\%ciscoconfparse module\fP for
more details.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B parent_regex
The regular expression to match the parent configuration lines against.
.TP
.B child_regex
The regular expression to match the child configuration lines against.
.TP
.B source: \fBrunning\fP
The configuration type to retrieve from the network device. Default:
\fBrunning\fP\&. Available options: \fBrunning\fP, \fBstartup\fP, \fBcandidate\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.config_lines_wo_child \(aq^interface\(aq \(aqip address\(aq
salt \(aq*\(aq napalm.config_lines_wo_child \(aq^interface\(aq \(aqshutdown\(aq source=candidate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.config_merge_diff(source=\(aqrunning\(aq, merge_config=None, merge_path=None, saltenv=\(aqbase\(aq)
New in version 2019.2.0.

.sp
Return the merge diff, as text, after merging the merge config into the
configuration source requested (without loading the config on the device).
.INDENT 7.0
.TP
.B source: \fBrunning\fP
The configuration type to retrieve from the network device. Default:
\fBrunning\fP\&. Available options: \fBrunning\fP, \fBstartup\fP, \fBcandidate\fP\&.
.TP
.B merge_config
The config to be merged into the initial config, sent as text. This
argument is ignored when \fBmerge_path\fP is set.
.TP
.B merge_path
Absolute or remote path from where to load the merge configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file.
Ignored if \fBmerge_path\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.config_merge_diff merge_path=salt://path/to/merge.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.config_merge_text(source=\(aqrunning\(aq, merge_config=None, merge_path=None, saltenv=\(aqbase\(aq)
New in version 2019.2.0.

.sp
Return the merge result of the configuration from \fBsource\fP with the
merge configuration, as plain text (without loading the config on the
device).
.INDENT 7.0
.TP
.B source: \fBrunning\fP
The configuration type to retrieve from the network device. Default:
\fBrunning\fP\&. Available options: \fBrunning\fP, \fBstartup\fP, \fBcandidate\fP\&.
.TP
.B merge_config
The config to be merged into the initial config, sent as text. This
argument is ignored when \fBmerge_path\fP is set.
.TP
.B merge_path
Absolute or remote path from where to load the merge configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file.
Ignored if \fBmerge_path\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.config_merge_text merge_path=salt://path/to/merge.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.config_merge_tree(source=\(aqrunning\(aq, merge_config=None, merge_path=None, saltenv=\(aqbase\(aq)
New in version 2019.2.0.

.sp
Return the merge tree of the \fBinitial_config\fP with the \fBmerge_config\fP,
as a Python dictionary.
.INDENT 7.0
.TP
.B source: \fBrunning\fP
The configuration type to retrieve from the network device. Default:
\fBrunning\fP\&. Available options: \fBrunning\fP, \fBstartup\fP, \fBcandidate\fP\&.
.TP
.B merge_config
The config to be merged into the initial config, sent as text. This
argument is ignored when \fBmerge_path\fP is set.
.TP
.B merge_path
Absolute or remote path from where to load the merge configuration
text. This argument allows any URI supported by
\fI\%cp.get_url\fP), e.g., \fBsalt://\fP,
\fBhttps://\fP, \fBs3://\fP, \fBftp:/\fP, etc.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file.
Ignored if \fBmerge_path\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.config_merge_tree merge_path=salt://path/to/merge.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.config_tree(source=\(aqrunning\(aq, with_tags=False)
New in version 2019.2.0.

.sp
Transform Cisco IOS style configuration to structured Python dictionary.
Depending on the value of the \fBwith_tags\fP argument, this function may
provide different views, valuable in different situations.
.INDENT 7.0
.TP
.B source: \fBrunning\fP
The configuration type to retrieve from the network device. Default:
\fBrunning\fP\&. Available options: \fBrunning\fP, \fBstartup\fP, \fBcandidate\fP\&.
.TP
.B with_tags: \fBFalse\fP
Whether this function should return a detailed view, with tags.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.config_tree
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.junos_call(fun, *args, **kwargs)
New in version 2019.2.0.

.sp
Execute an arbitrary function from the
\fBjunos execution module\fP\&. To check what \fBargs\fP
and \fBkwargs\fP you must send to the function, please consult the appropriate
documentation.
.INDENT 7.0
.TP
.B fun
The name of the function. E.g., \fBset_hostname\fP\&.
.TP
.B args
List of arguments to send to the \fBjunos\fP function invoked.
.TP
.B kwargs
Dictionary of key\-value arguments to send to the \fBjuno\fP function
invoked.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.junos_fun cli \(aqshow system commit\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.junos_cli(command, format=None, dev_timeout=None, dest=None, **kwargs)
New in version 2019.2.0.

.sp
Execute a CLI command and return the output in the specified format.
.INDENT 7.0
.TP
.B command
The command to execute on the Junos CLI.
.TP
.B format: \fBtext\fP
Format in which to get the CLI output (either \fBtext\fP or \fBxml\fP).
.TP
.B dev_timeout: \fB30\fP
The NETCONF RPC timeout (in seconds).
.TP
.B dest
Destination file where the RPC output is stored. Note that the file will
be stored on the Proxy Minion. To push the files to the Master, use
\fI\%cp.push\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.junos_cli \(aqshow lldp neighbors\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.junos_commit(**kwargs)
New in version 2019.2.0.

.sp
Commit the changes loaded in the candidate configuration.
.INDENT 7.0
.TP
.B dev_timeout: \fB30\fP
The NETCONF RPC timeout (in seconds).
.TP
.B comment
Provide a comment for the commit.
.TP
.B confirm
Provide time in minutes for commit confirmation. If this option is
specified, the commit will be rolled back in the specified amount of time
unless the commit is confirmed.
.TP
.B sync: \fBFalse\fP
When \fBTrue\fP, on dual control plane systems, requests that the candidate
configuration on one control plane be copied to the other control plane,
checked for correct syntax, and committed on both Routing Engines.
.TP
.B force_sync: \fBFalse\fP
When \fBTrue\fP, on dual control plane systems, force the candidate
configuration on one control plane to be copied to the other control
plane.
.TP
.B full
When \fBTrue\fP, requires all the daemons to check and evaluate the new
configuration.
.TP
.B detail
When \fBTrue\fP, return commit detail.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.junos_commit comment=\(aqCommitiing via Salt\(aq detail=True
salt \(aq*\(aq napalm.junos_commit dev_timeout=60 confirm=10
salt \(aq*\(aq napalm.junos_commit sync=True dev_timeout=90
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.junos_copy_file(src, dst, **kwargs)
New in version 2019.2.0.

.sp
Copies the file on the remote Junos device.
.INDENT 7.0
.TP
.B src
The source file path. This argument accepts the usual Salt URIs (e.g.,
\fBsalt://\fP, \fBhttp://\fP, \fBhttps://\fP, \fBs3://\fP, \fBftp://\fP, etc.).
.TP
.B dst
The destination path on the device where to copy the file.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.junos_copy_file https://example.com/junos.cfg /var/tmp/myjunos.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.junos_facts(**kwargs)
New in version 2019.2.0.

.sp
The complete list of Junos facts collected by \fBjunos\-eznc\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.junos_facts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.junos_install_os(path=None, **kwargs)
New in version 2019.2.0.

.sp
Installs the given image on the device.
.INDENT 7.0
.TP
.B path
The image file source. This argument supports the following URIs:
.INDENT 7.0
.IP \(bu 2
Absolute path on the Minion.
.IP \(bu 2
\fBsalt://\fP to fetch from the Salt fileserver.
.IP \(bu 2
\fBhttp://\fP and \fBhttps://\fP
.IP \(bu 2
\fBftp://\fP
.IP \(bu 2
\fBswift:/\fP
.IP \(bu 2
\fBs3://\fP
.UNINDENT
.TP
.B dev_timeout: \fB30\fP
The NETCONF RPC timeout (in seconds)
.TP
.B reboot: \fBFalse\fP
Whether to reboot the device after the installation is complete.
.TP
.B no_copy: \fBFalse\fP
If \fBTrue\fP the software package will not be copied to the remote
device.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.junos_install_os salt://images/junos_16_1.tgz reboot=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.junos_rpc(cmd=None, dest=None, format=None, **kwargs)
New in version 2019.2.0.

.sp
Execute an RPC request on the remote Junos device.
.INDENT 7.0
.TP
.B cmd
The RPC request to the executed. To determine the RPC request, you can
check the from the command line of the device, by executing the usual
command followed by \fB| display xml rpc\fP, e.g.,
\fBshow lldp neighbors | display xml rpc\fP\&.
.TP
.B dest
Destination file where the RPC output is stored. Note that the file will
be stored on the Proxy Minion. To push the files to the Master, use
\fI\%cp.push\fP Execution function.
.TP
.B format: \fBxml\fP
The format in which the RPC reply is received from the device.
.TP
.B dev_timeout: \fB30\fP
The NETCONF RPC timeout.
.TP
.B filter
Used with the \fBget\-config\fP RPC request to filter out the config tree.
.TP
.B terse: \fBFalse\fP
Whether to return terse output.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Some RPC requests may not support this argument.
.UNINDENT
.UNINDENT
.TP
.B interface_name
Name of the interface to query.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.junos_rpc get\-lldp\-neighbors\-information
salt \(aq*\(aq napalm.junos_rpc get\-config <configuration><system><ntp/></system></configuration>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.netmiko_args(**kwargs)
New in version 2019.2.0.

.sp
Return the key\-value arguments used for the authentication arguments for
the netmiko module.
.sp
When running in a non\-native NAPALM driver (e.g., \fBpanos\fP, \fIf5\(ga\fP, \fBmos\fP \-
either from \fI\%https://github.com/napalm\-automation\-community\fP or defined in
user\(aqs own environment, one can specify the Netmiko device type (the
\fBdevice_type\fP argument) via the \fBnetmiko_device_type_map\fP configuration
option / Pillar key, e.g.,
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
netmiko_device_type_map:
  f5: f5_ltm
  dellos10: dell_os10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The configuration above defines the mapping between the NAPALM \fBos\fP Grain
and the Netmiko \fBdevice_type\fP, e.g., when the NAPALM Grain is \fBf5\fP, it
would use the \fBf5_ltm\fP SSH Netmiko driver to execute commands over SSH on
the remote network device.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.netmiko_args
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.netmiko_call(method, *args, **kwargs)
New in version 2019.2.0.

.sp
Execute an arbitrary Netmiko method, passing the authentication details from
the existing NAPALM connection.
.INDENT 7.0
.TP
.B method
The name of the Netmiko method to execute.
.TP
.B args
List of arguments to send to the Netmiko method specified in \fBmethod\fP\&.
.TP
.B kwargs
Key\-value arguments to send to the execution function specified in
\fBmethod\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.netmiko_call send_command \(aqshow version\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.netmiko_commands(*commands, **kwargs)
New in version 2019.2.0.

.sp
Invoke one or more commands to be executed on the remote device, via Netmiko.
Returns a list of strings, with the output from each command.
.INDENT 7.0
.TP
.B commands
A list of commands to be executed.
.TP
.B expect_string
Regular expression pattern to use for determining end of output.
If left blank will default to being based on router prompt.
.TP
.B delay_factor: \fB1\fP
Multiplying factor used to adjust delays (default: \fB1\fP).
.TP
.B max_loops: \fB500\fP
Controls wait time in conjunction with delay_factor. Will default to be
based upon self.timeout.
.TP
.B auto_find_prompt: \fBTrue\fP
Whether it should try to auto\-detect the prompt (default: \fBTrue\fP).
.TP
.B strip_prompt: \fBTrue\fP
Remove the trailing router prompt from the output (default: \fBTrue\fP).
.TP
.B strip_command: \fBTrue\fP
Remove the echo of the command from the output (default: \fBTrue\fP).
.TP
.B normalize: \fBTrue\fP
Ensure the proper enter is sent at end of command (default: \fBTrue\fP).
.TP
.B use_textfsm: \fBFalse\fP
Process command output through TextFSM template (default: \fBFalse\fP).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.netmiko_commands \(aqshow version\(aq \(aqshow interfaces\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.netmiko_config(*config_commands, **kwargs)
New in version 2019.2.0.

.sp
Load a list of configuration commands on the remote device, via Netmiko.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Please remember that \fBnetmiko\fP does not have any rollback safeguards
and any configuration change will be directly loaded into the running
config if the platform doesn\(aqt have the concept of \fBcandidate\fP config.
.sp
On Junos, or other platforms that have this capability, the changes will
not be loaded into the running config, and the user must set the
\fBcommit\fP argument to \fBTrue\fP to transfer the changes from the
candidate into the running config before exiting.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B config_commands
A list of configuration commands to be loaded on the remote device.
.TP
.B config_file
Read the configuration commands from a file. The file can equally be a
template that can be rendered using the engine of choice (see
\fBtemplate_engine\fP).
.sp
This can be specified using the absolute path to the file, or using one
of the following URL schemes:
.INDENT 7.0
.IP \(bu 2
\fBsalt://\fP, to fetch the file from the Salt fileserver.
.IP \(bu 2
\fBhttp://\fP or \fBhttps://\fP
.IP \(bu 2
\fBftp://\fP
.IP \(bu 2
\fBs3://\fP
.IP \(bu 2
\fBswift://\fP
.UNINDENT
.TP
.B exit_config_mode: \fBTrue\fP
Determines whether or not to exit config mode after complete.
.TP
.B delay_factor: \fB1\fP
Factor to adjust delays.
.TP
.B max_loops: \fB150\fP
Controls wait time in conjunction with delay_factor (default: \fB150\fP).
.TP
.B strip_prompt: \fBFalse\fP
Determines whether or not to strip the prompt (default: \fBFalse\fP).
.TP
.B strip_command: \fBFalse\fP
Determines whether or not to strip the command (default: \fBFalse\fP).
.TP
.B config_mode_command
The command to enter into config mode.
.TP
.B commit: \fBFalse\fP
Commit the configuration changes before exiting the config mode. This
option is by default disabled, as many platforms don\(aqt have this
capability natively.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.netmiko_config \(aqset system ntp peer 1.2.3.4\(aq commit=True
salt \(aq*\(aq napalm.netmiko_config https://bit.ly/2sgljCB
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.netmiko_fun(fun, *args, **kwargs)
New in version 2019.2.0.

.sp
Call an arbitrary function from the \fI\%Netmiko\fP
module, passing the authentication details from the existing NAPALM
connection.
.INDENT 7.0
.TP
.B fun
The name of the function from the \fI\%Netmiko\fP
to invoke.
.TP
.B args
List of arguments to send to the execution function specified in
\fBfun\fP\&.
.TP
.B kwargs
Key\-value arguments to send to the execution function specified in
\fBfun\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.netmiko_fun send_command \(aqshow version\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.netmiko_multi_call(*methods, **kwargs)
New in version 2019.2.0.

.sp
Execute a list of arbitrary Netmiko methods, passing the authentication
details from the existing NAPALM connection.
.INDENT 7.0
.TP
.B methods
List of dictionaries with the following keys:
.INDENT 7.0
.IP \(bu 2
\fBname\fP: the name of the Netmiko function to invoke.
.IP \(bu 2
\fBargs\fP: list of arguments to send to the \fBname\fP method.
.IP \(bu 2
\fBkwargs\fP: key\-value arguments to send to the \fBname\fP method.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.netmiko_multi_call \(dq{\(aqname\(aq: \(aqsend_command\(aq, \(aqargs\(aq: [\(aqshow version\(aq]}\(dq \(dq{\(aqname\(aq: \(aqsend_command\(aq, \(aqargs\(aq: [\(aqshow interfaces\(aq]}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.nxos_api_config(commands=None, config_file=None, template_engine=\(aqjinja\(aq, context=None, defaults=None, saltenv=\(aqbase\(aq, **kwargs)
.INDENT 7.0
.INDENT 3.5
New in version 2019.2.0.

.UNINDENT
.UNINDENT
.sp
Configures the Nexus switch with the specified commands, via the NX\-API.
.INDENT 7.0
.TP
.B commands
The list of configuration commands to load on the Nexus switch.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument is ignored when \fBconfig_file\fP is specified.
.UNINDENT
.UNINDENT
.TP
.B config_file
The source file with the configuration commands to be sent to the device.
.sp
The file can also be a template that can be rendered using the template
engine of choice. This can be specified using the absolute path to the
file, or using one of the following URL schemes:
.INDENT 7.0
.IP \(bu 2
\fBsalt://\fP
.IP \(bu 2
\fBhttps://\fP
.IP \(bu 2
\fBftp:/\fP
.IP \(bu 2
\fBs3:/\fP
.IP \(bu 2
\fBswift://\fP
.UNINDENT
.TP
.B template_engine: \fBjinja\fP
The template engine to use when rendering the source file. Default:
\fBjinja\fP\&. To simply fetch the file without attempting to render, set
this argument to \fBNone\fP\&.
.TP
.B context: \fBNone\fP
Variables to add to the template context.
.TP
.B defaults: \fBNone\fP
Default values of the \fBcontext\fP dict.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file. Ignored if
\fBconfig_file\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.nxos_api_config \(aqspanning\-tree mode mstp\(aq
salt \(aq*\(aq napalm.nxos_api_config config_file=https://bit.ly/2LGLcDy context=\(dq{\(aqservers\(aq: [\(aq1.2.3.4\(aq]}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.nxos_api_rpc(commands, method=\(aqcli\(aq, **kwargs)
New in version 2019.2.0.

.sp
Execute an arbitrary RPC request via the Nexus API.
.INDENT 7.0
.TP
.B commands
The RPC commands to be executed.
.TP
.B method: \fBcli\fP
The type of the response, i.e., raw text (\fBcli_ascii\fP) or structured
document (\fBcli\fP). Defaults to \fBcli\fP (structured data).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.nxos_api_rpc \(aqshow version\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.nxos_api_show(commands, raw_text=True, **kwargs)
New in version 2019.2.0.

.sp
Execute one or more show (non\-configuration) commands.
.INDENT 7.0
.TP
.B commands
The commands to be executed.
.TP
.B raw_text: \fBTrue\fP
Whether to return raw text or structured data.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.nxos_api_show \(aqshow version\(aq
salt \(aq*\(aq napalm.nxos_api_show \(aqshow bgp sessions\(aq \(aqshow processes\(aq raw_text=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.pyeapi_call(method, *args, **kwargs)
New in version 2019.2.0.

.sp
Invoke an arbitrary method from the \fBpyeapi\fP library.
This function forwards the existing connection details to the
\fBpyeapi.run_commands\fP
execution function.
.INDENT 7.0
.TP
.B method
The name of the \fBpyeapi\fP method to invoke.
.TP
.B kwargs
Key\-value arguments to send to the \fBpyeapi\fP method.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.pyeapi_call run_commands \(aqshow version\(aq encoding=text
salt \(aq*\(aq napalm.pyeapi_call get_config as_string=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.pyeapi_config(commands=None, config_file=None, template_engine=\(aqjinja\(aq, context=None, defaults=None, saltenv=\(aqbase\(aq, **kwargs)
New in version 2019.2.0.

.sp
Configures the Arista switch with the specified commands, via the \fBpyeapi\fP
library. This function forwards the existing connection details to the
\fBpyeapi.run_commands\fP
execution function.
.INDENT 7.0
.TP
.B commands
The list of configuration commands to load on the Arista switch.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument is ignored when \fBconfig_file\fP is specified.
.UNINDENT
.UNINDENT
.TP
.B config_file
The source file with the configuration commands to be sent to the device.
.sp
The file can also be a template that can be rendered using the template
engine of choice. This can be specified using the absolute path to the
file, or using one of the following URL schemes:
.INDENT 7.0
.IP \(bu 2
\fBsalt://\fP
.IP \(bu 2
\fBhttps://\fP
.IP \(bu 2
\fBftp:/\fP
.IP \(bu 2
\fBs3:/\fP
.IP \(bu 2
\fBswift://\fP
.UNINDENT
.TP
.B template_engine: \fBjinja\fP
The template engine to use when rendering the source file. Default:
\fBjinja\fP\&. To simply fetch the file without attempting to render, set
this argument to \fBNone\fP\&.
.TP
.B context: \fBNone\fP
Variables to add to the template context.
.TP
.B defaults: \fBNone\fP
Default values of the \fBcontext\fP dict.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file. Ignored if
\fBconfig_file\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.pyeapi_config \(aqntp server 1.2.3.4\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.pyeapi_nxos_api_args(**prev_kwargs)
New in version 2019.2.0.

.sp
Return the key\-value arguments used for the authentication arguments for the
\fBpyeapi execution module\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.pyeapi_nxos_api_args
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.pyeapi_run_commands(*commands, **kwargs)
Execute a list of commands on the Arista switch, via the \fBpyeapi\fP library.
This function forwards the existing connection details to the
\fBpyeapi.run_commands\fP
execution function.
.INDENT 7.0
.TP
.B commands
A list of commands to execute.
.TP
.B encoding: \fBjson\fP
The requested encoding of the command output. Valid values for encoding
are \fBjson\fP (default) or \fBtext\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.pyeapi_run_commands \(aqshow version\(aq encoding=text
salt \(aq*\(aq napalm.pyeapi_run_commands \(aqshow ip bgp neighbors\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.reconnect(force=False, **kwargs)
Reconnect the NAPALM proxy when the connection
is dropped by the network device.
The connection can be forced to be restarted
using the \fBforce\fP argument.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function can be used only when running proxy minions.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.reconnect
salt \(aq*\(aq napalm.reconnect force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.rpc(command, **kwargs)
New in version 2019.2.0.

.sp
This is a wrapper to execute RPC requests on various network operating
systems supported by NAPALM, invoking the following functions for the NAPALM
native drivers:
.INDENT 7.0
.IP \(bu 2
\fI\%napalm.junos_rpc\fP for \fBjunos\fP
.IP \(bu 2
\fI\%napalm.pyeapi_run_commands\fP
for \fBeos\fP
.IP \(bu 2
\fI\%napalm.nxos_api_rpc\fP for
\fBnxos\fP
.IP \(bu 2
\fI\%napalm.netmiko_commands\fP
for \fBios\fP, \fBiosxr\fP, and \fBnxos_ssh\fP
.UNINDENT
.INDENT 7.0
.TP
.B command
The RPC command to execute. This depends on the nature of the operating
system.
.TP
.B kwargs
Key\-value arguments to be sent to the underlying Execution function.
.UNINDENT
.sp
The function capabilities are extensible in the user environment via the
\fBnapalm_rpc_map\fP configuration option / Pillar, e.g.,
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
napalm_rpc_map:
  f5: napalm.netmiko_commands
  panos: panos.call
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The mapping above reads: when the NAPALM \fBos\fP Grain is \fBf5\fP, then call
\fBnapalm.netmiko_commands\fP for RPC requests.
.sp
By default, if the user does not specify any map, non\-native NAPALM drivers
will invoke the \fBnapalm.netmiko_commands\fP Execution function.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.rpc \(aqshow version\(aq
salt \(aq*\(aq napalm.rpc get\-interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.scp_get(remote_path, local_path=\(aq\(aq, recursive=False, preserve_times=False, **kwargs)
New in version 2019.2.0.

.sp
Transfer files and directories from remote network device to the localhost
of the Minion.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function is only available only when the underlying library
\fI\%scp\fP
is installed. See
\fI\%scp module\fP for
more details.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B remote_path
Path to retrieve from remote host. Since this is evaluated by scp on the
remote host, shell wildcards and environment variables may be used.
.TP
.B recursive: \fBFalse\fP
Transfer files and directories recursively.
.TP
.B preserve_times: \fBFalse\fP
Preserve \fBmtime\fP and \fBatime\fP of transferred files and directories.
.TP
.B passphrase
Used for decrypting private keys.
.TP
.B pkey
An optional private key to use for authentication.
.TP
.B key_filename
The filename, or list of filenames, of optional private key(s) and/or
certificates to try for authentication.
.TP
.B timeout
An optional timeout (in seconds) for the TCP connect.
.TP
.B socket_timeout: \fB10\fP
The channel socket timeout in seconds.
.TP
.B buff_size: \fB16384\fP
The size of the SCP send buffer.
.TP
.B allow_agent: \fBTrue\fP
Set to \fBFalse\fP to disable connecting to the SSH agent.
.TP
.B look_for_keys: \fBTrue\fP
Set to \fBFalse\fP to disable searching for discoverable private key
files in \fB~/.ssh/\fP
.TP
.B banner_timeout
An optional timeout (in seconds) to wait for the SSH banner to be
presented.
.TP
.B auth_timeout
An optional timeout (in seconds) to wait for an authentication
response.
.TP
.B auto_add_policy: \fBFalse\fP
Automatically add the host to the \fBknown_hosts\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.scp_get /var/tmp/file /tmp/file auto_add_policy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_mod.scp_put(files, remote_path=None, recursive=False, preserve_times=False, saltenv=\(aqbase\(aq, **kwargs)
New in version 2019.2.0.

.sp
Transfer files and directories to remote network device.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function is only available only when the underlying library
\fI\%scp\fP
is installed. See
\fI\%scp module\fP for
more details.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B files
A single path or a list of paths to be transferred.
.TP
.B remote_path
The path on the remote device where to store the files.
.TP
.B recursive: \fBTrue\fP
Transfer files and directories recursively.
.TP
.B preserve_times: \fBFalse\fP
Preserve \fBmtime\fP and \fBatime\fP of transferred files and directories.
.TP
.B saltenv: \fBbase\fP
The name of the Salt environment. Ignored when \fBfiles\fP is not a
\fBsalt://\fP URL.
.TP
.B hostname
The hostname of the remote device.
.TP
.B port: \fB22\fP
The port of the remote device.
.TP
.B username
The username required for SSH authentication on the device.
.TP
.B password
Used for password authentication. It is also used for private key
decryption if \fBpassphrase\fP is not given.
.TP
.B passphrase
Used for decrypting private keys.
.TP
.B pkey
An optional private key to use for authentication.
.TP
.B key_filename
The filename, or list of filenames, of optional private key(s) and/or
certificates to try for authentication.
.TP
.B timeout
An optional timeout (in seconds) for the TCP connect.
.TP
.B socket_timeout: \fB10\fP
The channel socket timeout in seconds.
.TP
.B buff_size: \fB16384\fP
The size of the SCP send buffer.
.TP
.B allow_agent: \fBTrue\fP
Set to \fBFalse\fP to disable connecting to the SSH agent.
.TP
.B look_for_keys: \fBTrue\fP
Set to \fBFalse\fP to disable searching for discoverable private key
files in \fB~/.ssh/\fP
.TP
.B banner_timeout
An optional timeout (in seconds) to wait for the SSH banner to be
presented.
.TP
.B auth_timeout
An optional timeout (in seconds) to wait for an authentication
response.
.TP
.B auto_add_policy: \fBFalse\fP
Automatically add the host to the \fBknown_hosts\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.scp_put /path/to/file /var/tmp/file auto_add_policy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.napalm_netacl
.SS NAPALM ACL
.sp
Generate and load ACL (firewall) configuration on network devices.
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP>
.TP
.B maturity
new
.TP
.B depends
capirca, napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.sp
The firewall configuration is generated by \fI\%Capirca\fP\&.
.sp
To install Capirca, execute: \fBpip install capirca\fP\&.
.sp
To be able to load configuration on network devices,
it requires \fI\%NAPALM\fP library to be installed:  \fBpip install napalm\fP\&.
Please check \fI\%Installation\fP for complete details.
.INDENT 0.0
.TP
.B salt.modules.napalm_netacl.get_filter_pillar(filter_name, pillar_key=\(aqacl\(aq, pillarenv=None, saltenv=None)
Helper that can be used inside a state SLS,
in order to get the filter configuration given its name.
.INDENT 7.0
.TP
.B filter_name
The name of the filter.
.TP
.B pillar_key
The root key of the whole policy config.
.TP
.B pillarenv
Query the master to generate fresh pillar data on the fly,
specifically from the requested pillar environment.
.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_netacl.get_term_pillar(filter_name, term_name, pillar_key=\(aqacl\(aq, pillarenv=None, saltenv=None)
Helper that can be used inside a state SLS,
in order to get the term configuration given its name,
under a certain filter uniquely identified by its name.
.INDENT 7.0
.TP
.B filter_name
The name of the filter.
.TP
.B term_name
The name of the term.
.TP
.B pillar_key: \fBacl\fP
The root key of the whole policy config. Default: \fBacl\fP\&.
.TP
.B pillarenv
Query the master to generate fresh pillar data on the fly,
specifically from the requested pillar environment.
.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_netacl.load_filter_config(filter_name, filter_options=None, terms=None, prepend=True, pillar_key=\(aqacl\(aq, pillarenv=None, saltenv=None, merge_pillar=True, only_lower_merge=False, revision_id=None, revision_no=None, revision_date=True, revision_date_format=\(aq%Y/%m/%d\(aq, test=False, commit=True, debug=False, **kwargs)
Generate and load the configuration of a policy filter.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The order of the terms is very important. The configuration loaded
on the device respects the order defined in the \fBterms\fP and/or
inside the pillar.
.sp
When merging the \fBterms\fP with the pillar data, consider the
\fBprepend\fP argument to make sure the order is correct!
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B filter_name
The name of the policy filter.
.TP
.B filter_options
Additional filter options. These options are platform\-specific.
See the complete list of \fI\%options\fP\&.
.TP
.B terms
List of terms for this policy filter.
If not specified or empty, will try to load the configuration from the pillar,
unless \fBmerge_pillar\fP is set as \fBFalse\fP\&.
.TP
.B prepend: \fBTrue\fP
When \fBmerge_pillar\fP is set as \fBTrue\fP, the final list of terms generated by merging
the terms from \fBterms\fP with those defined in the pillar (if any): new terms are prepended
at the beginning, while existing ones will preserve the position. To add the new terms
at the end of the list, set this argument to \fBFalse\fP\&.
.TP
.B pillar_key: \fBacl\fP
The key in the pillar containing the default attributes values. Default: \fBacl\fP\&.
.TP
.B pillarenv
Query the master to generate fresh pillar data on the fly,
specifically from the requested pillar environment.
.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.TP
.B merge_pillar: \fBTrue\fP
Merge the CLI variables with the pillar. Default: \fBTrue\fP\&.
.sp
The merge logic depends on the \fBprepend\fP argument and
the CLI has higher priority than the pillar.
.TP
.B only_lower_merge: \fBFalse\fP
Specify if it should merge only the terms fields. Otherwise it will try
to merge also filters fields. Default: \fBFalse\fP\&.
This option requires \fBmerge_pillar\fP, otherwise it is ignored.
.TP
.B revision_id
Add a comment in the filter config having the description for the changes applied.
.TP
.B revision_no
The revision count.
.TP
.B revision_date: \fBTrue\fP
Boolean flag: display the date when the filter configuration was generated. Default: \fBTrue\fP\&.
.TP
.B revision_date_format: \fB%Y/%m/%d\fP
The date format to be used when generating the perforce data. Default: \fB%Y/%m/%d\fP (<year>/<month>/<day>).
.TP
.B test: \fBFalse\fP
Dry run? If set as \fBTrue\fP, will apply the config, discard and return the changes.
Default: \fBFalse\fP and will commit the changes on the device.
.TP
.B commit: \fBTrue\fP
Commit? Default: \fBTrue\fP\&.
.TP
.B debug: \fBFalse\fP
Debug mode. Will insert a new key under the output dictionary,
as \fBloaded_config\fP containing the raw configuration loaded on the device.
.UNINDENT
.sp
The output is a dictionary having the same form as \fI\%net.load_config\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqedge01.bjm01\(aq netacl.load_filter_config my\-filter pillar_key=netacl debug=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
edge01.bjm01:
    \-\-\-\-\-\-\-\-\-\-
    already_configured:
        False
    comment:
    diff:
        [edit firewall]
        +    family inet {
        +        /*
        +         ** $Date: 2017/03/22 $
        +         **
        +         */
        +        filter my\-filter {
        +            interface\-specific;
        +            term my\-term {
        +                from {
        +                    source\-port [ 1234 1235 ];
        +                }
        +                then {
        +                    reject;
        +                }
        +            }
        +            term my\-other\-term {
        +                from {
        +                    protocol tcp;
        +                    source\-port 5678\-5680;
        +                }
        +                then accept;
        +            }
        +        }
        +    }
    loaded_config:
        firewall {
            family inet {
                replace:
                /*
                ** $Date: 2017/03/22 $
                **
                */
                filter my\-filter {
                    interface\-specific;
                    term my\-term {
                        from {
                            source\-port [ 1234 1235 ];
                        }
                        then {
                            reject;
                        }
                    }
                    term my\-other\-term {
                        from {
                            protocol tcp;
                            source\-port 5678\-5680;
                        }
                        then accept;
                    }
                }
            }
        }
    result:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The filter configuration has been loaded from the pillar, having the following structure:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
netacl:
  \- my\-filter:
      terms:
        \- my\-term:
            source_port:
             \- 1234
             \- 1235
            action: reject
        \- my\-other\-term:
            source_port:
              \- \- 5678
                \- 5680
            protocol: tcp
            action: accept
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_netacl.load_policy_config(filters=None, prepend=True, pillar_key=\(aqacl\(aq, pillarenv=None, saltenv=None, merge_pillar=True, only_lower_merge=False, revision_id=None, revision_no=None, revision_date=True, revision_date_format=\(aq%Y/%m/%d\(aq, test=False, commit=True, debug=False, **kwargs)
Generate and load the configuration of the whole policy.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The order of the filters and their terms is very important.
The configuration loaded on the device respects the order
defined in the \fBfilters\fP and/or inside the pillar.
.sp
When merging the \fBfilters\fP with the pillar data, consider the
\fBprepend\fP argument to make sure the order is correct!
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B filters
List of filters for this policy.
If not specified or empty, will try to load the configuration from the pillar,
unless \fBmerge_pillar\fP is set as \fBFalse\fP\&.
.TP
.B prepend: \fBTrue\fP
When \fBmerge_pillar\fP is set as \fBTrue\fP, the final list of filters generated by merging
the filters from \fBfilters\fP with those defined in the pillar (if any): new filters are prepended
at the beginning, while existing ones will preserve the position. To add the new filters
at the end of the list, set this argument to \fBFalse\fP\&.
.TP
.B pillar_key: \fBacl\fP
The key in the pillar containing the default attributes values. Default: \fBacl\fP\&.
.TP
.B pillarenv
Query the master to generate fresh pillar data on the fly,
specifically from the requested pillar environment.
.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.TP
.B merge_pillar: \fBTrue\fP
Merge the CLI variables with the pillar. Default: \fBTrue\fP\&.
.sp
The merge logic depends on the \fBprepend\fP argument and
the CLI has higher priority than the pillar.
.TP
.B only_lower_merge: \fBFalse\fP
Specify if it should merge only the filters and terms fields. Otherwise it will try
to merge everything at the policy level. Default: \fBFalse\fP\&.
This option requires \fBmerge_pillar\fP, otherwise it is ignored.
.TP
.B revision_id
Add a comment in the policy config having the description for the changes applied.
.TP
.B revision_no
The revision count.
.TP
.B revision_date: \fBTrue\fP
Boolean flag: display the date when the policy configuration was generated. Default: \fBTrue\fP\&.
.TP
.B revision_date_format: \fB%Y/%m/%d\fP
The date format to be used when generating the perforce data. Default: \fB%Y/%m/%d\fP (<year>/<month>/<day>).
.TP
.B test: \fBFalse\fP
Dry run? If set as \fBTrue\fP, will apply the config, discard and return the changes.
Default: \fBFalse\fP and will commit the changes on the device.
.TP
.B commit: \fBTrue\fP
Commit? Default: \fBTrue\fP\&.
.TP
.B debug: \fBFalse\fP
Debug mode. Will insert a new key under the output dictionary,
as \fBloaded_config\fP containing the raw configuration loaded on the device.
.UNINDENT
.sp
The output is a dictionary having the same form as \fI\%net.load_config\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqedge01.flw01\(aq netacl.load_policy_config debug=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
edge01.flw01:
    \-\-\-\-\-\-\-\-\-\-
    already_configured:
        False
    comment:
    diff:
        \-\-\-
        +++
        @@ \-1228,9 +1228,24 @@
         !
        +ipv4 access\-list my\-filter
        + 10 remark my\-term
        + 20 deny tcp host 1.2.3.4 eq 1234 any
        + 30 deny udp host 1.2.3.4 eq 1234 any
        + 40 deny tcp host 1.2.3.4 eq 1235 any
        + 50 deny udp host 1.2.3.4 eq 1235 any
        + 60 remark my\-other\-term
        + 70 permit tcp any range 5678 5680 any
        +!
        +!
        +ipv4 access\-list block\-icmp
        + 10 remark first\-term
        + 20 deny icmp any any
         !
    loaded_config:
        ! $Date: 2017/03/22 $
        no ipv4 access\-list my\-filter
        ipv4 access\-list my\-filter
         remark my\-term
         deny tcp host 1.2.3.4 eq 1234 any
         deny udp host 1.2.3.4 eq 1234 any
         deny tcp host 1.2.3.4 eq 1235 any
         deny udp host 1.2.3.4 eq 1235 any
         remark my\-other\-term
         permit tcp any range 5678 5680 any
        exit
        no ipv4 access\-list block\-icmp
        ipv4 access\-list block\-icmp
         remark first\-term
         deny icmp any any
        exit
    result:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The policy configuration has been loaded from the pillar, having the following structure:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
acl:
  \- my\-filter:
      terms:
        \- my\-term:
            source_port:
             \- 1234
             \- 1235
            protocol:
              \- tcp
              \- udp
            source_address: 1.2.3.4
            action: reject
        \- my\-other\-term:
            source_port:
              \- [5678, 5680]
            protocol: tcp
            action: accept
  \- block\-icmp:
      terms:
        \- first\-term:
            protocol:
              \- icmp
            action: reject
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_netacl.load_term_config(filter_name, term_name, filter_options=None, pillar_key=\(aqacl\(aq, pillarenv=None, saltenv=None, merge_pillar=True, revision_id=None, revision_no=None, revision_date=True, revision_date_format=\(aq%Y/%m/%d\(aq, test=False, commit=True, debug=False, source_service=None, destination_service=None, **term_fields)
Generate and load the configuration of a policy term.
.INDENT 7.0
.TP
.B filter_name
The name of the policy filter.
.TP
.B term_name
The name of the term.
.TP
.B filter_options
Additional filter options. These options are platform\-specific.
See the complete list of \fI\%options\fP\&.
.TP
.B pillar_key: \fBacl\fP
The key in the pillar containing the default attributes values. Default: \fBacl\fP\&.
If the pillar contains the following structure:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
firewall:
  \- my\-filter:
      terms:
        \- my\-term:
            source_port: 1234
            source_address:
                \- 1.2.3.4/32
                \- 5.6.7.8/32
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBpillar_key\fP field would be specified as \fBfirewall\fP\&.
.TP
.B pillarenv
Query the master to generate fresh pillar data on the fly,
specifically from the requested pillar environment.
.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.TP
.B merge_pillar: \fBTrue\fP
Merge the CLI variables with the pillar. Default: \fBTrue\fP\&.
.sp
The properties specified through the CLI have higher priority than the pillar.
.TP
.B revision_id
Add a comment in the term config having the description for the changes applied.
.TP
.B revision_no
The revision count.
.TP
.B revision_date: \fBTrue\fP
Boolean flag: display the date when the term configuration was generated. Default: \fBTrue\fP\&.
.TP
.B revision_date_format: \fB%Y/%m/%d\fP
The date format to be used when generating the perforce data. Default: \fB%Y/%m/%d\fP (<year>/<month>/<day>).
.TP
.B test: \fBFalse\fP
Dry run? If set as \fBTrue\fP, will apply the config, discard and return the changes.
Default: \fBFalse\fP and will commit the changes on the device.
.TP
.B commit: \fBTrue\fP
Commit? Default: \fBTrue\fP\&.
.TP
.B debug: \fBFalse\fP
Debug mode. Will insert a new key under the output dictionary,
as \fBloaded_config\fP containing the raw configuration loaded on the device.
.TP
.B source_service
A special service to choose from. This is a helper so the user is able to
select a source just using the name, instead of specifying a source_port and protocol.
.sp
As this module is available on Unix platforms only,
it reads the \fI\%IANA\fP port assignment from /etc/services.
.sp
If the user requires additional shortcuts to be referenced, they can add entries under /etc/services,
which can be managed using the \fI\%file state\fP\&.
.TP
.B destination_service
A special service to choose from. This is a helper so the user is able to
select a source just using the name, instead of specifying a destination_port and protocol.
Allows the same options as \fBsource_service\fP\&.
.TP
.B term_fields
Term attributes. To see what fields are supported, please consult the
list of supported \fI\%keywords\fP\&. Some platforms have a few other \fI\%optional\fP
keywords.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The following fields are accepted (some being platform\-specific):
.INDENT 0.0
.IP \(bu 2
action
.IP \(bu 2
address
.IP \(bu 2
address_exclude
.IP \(bu 2
comment
.IP \(bu 2
counter
.IP \(bu 2
expiration
.IP \(bu 2
destination_address
.IP \(bu 2
destination_address_exclude
.IP \(bu 2
destination_port
.IP \(bu 2
destination_prefix
.IP \(bu 2
forwarding_class
.IP \(bu 2
forwarding_class_except
.IP \(bu 2
logging
.IP \(bu 2
log_name
.IP \(bu 2
loss_priority
.IP \(bu 2
option
.IP \(bu 2
policer
.IP \(bu 2
port
.IP \(bu 2
precedence
.IP \(bu 2
principals
.IP \(bu 2
protocol
.IP \(bu 2
protocol_except
.IP \(bu 2
qos
.IP \(bu 2
pan_application
.IP \(bu 2
routing_instance
.IP \(bu 2
source_address
.IP \(bu 2
source_address_exclude
.IP \(bu 2
source_port
.IP \(bu 2
source_prefix
.IP \(bu 2
verbatim
.IP \(bu 2
packet_length
.IP \(bu 2
fragment_offset
.IP \(bu 2
hop_limit
.IP \(bu 2
icmp_type
.IP \(bu 2
ether_type
.IP \(bu 2
traffic_class_count
.IP \(bu 2
traffic_type
.IP \(bu 2
translated
.IP \(bu 2
dscp_set
.IP \(bu 2
dscp_match
.IP \(bu 2
dscp_except
.IP \(bu 2
next_ip
.IP \(bu 2
flexible_match_range
.IP \(bu 2
source_prefix_except
.IP \(bu 2
destination_prefix_except
.IP \(bu 2
vpn
.IP \(bu 2
source_tag
.IP \(bu 2
destination_tag
.IP \(bu 2
source_interface
.IP \(bu 2
destination_interface
.IP \(bu 2
flattened
.IP \(bu 2
flattened_addr
.IP \(bu 2
flattened_saddr
.IP \(bu 2
flattened_daddr
.IP \(bu 2
priority
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The following fields can be also a single value and a list of values:
.INDENT 0.0
.IP \(bu 2
action
.IP \(bu 2
address
.IP \(bu 2
address_exclude
.IP \(bu 2
comment
.IP \(bu 2
destination_address
.IP \(bu 2
destination_address_exclude
.IP \(bu 2
destination_port
.IP \(bu 2
destination_prefix
.IP \(bu 2
forwarding_class
.IP \(bu 2
forwarding_class_except
.IP \(bu 2
logging
.IP \(bu 2
option
.IP \(bu 2
port
.IP \(bu 2
precedence
.IP \(bu 2
principals
.IP \(bu 2
protocol
.IP \(bu 2
protocol_except
.IP \(bu 2
pan_application
.IP \(bu 2
source_address
.IP \(bu 2
source_address_exclude
.IP \(bu 2
source_port
.IP \(bu 2
source_prefix
.IP \(bu 2
verbatim
.IP \(bu 2
icmp_type
.IP \(bu 2
ether_type
.IP \(bu 2
traffic_type
.IP \(bu 2
dscp_match
.IP \(bu 2
dscp_except
.IP \(bu 2
flexible_match_range
.IP \(bu 2
source_prefix_except
.IP \(bu 2
destination_prefix_except
.IP \(bu 2
source_tag
.IP \(bu 2
destination_tag
.IP \(bu 2
source_service
.IP \(bu 2
destination_service
.UNINDENT
.sp
Example: \fBdestination_address\fP can be either defined as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
destination_address: 172.17.17.1/24
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or as a list of destination IP addresses:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
destination_address:
    \- 172.17.17.1/24
    \- 172.17.19.1/24
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or a list of services to be matched:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
source_service:
    \- ntp
    \- snmp
    \- ldap
    \- bgpd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The port fields \fBsource_port\fP and \fBdestination_port\fP can be used as above to select either
a single value, either a list of values, but also they can select port ranges. Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
source_port:
    \- \- 1000
      \- 2000
    \- \- 3000
      \- 4000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With the configuration above, the user is able to select the 1000\-2000 and 3000\-4000 source port ranges.
.UNINDENT
.UNINDENT
.sp
The output is a dictionary having the same form as \fI\%net.load_config\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqedge01.bjm01\(aq netacl.load_term_config filter\-name term\-name source_address=1.2.3.4 destination_address=5.6.7.8 action=accept test=True debug=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
edge01.bjm01:
    \-\-\-\-\-\-\-\-\-\-
    already_configured:
        False
    comment:
        Configuration discarded.
    diff:
        [edit firewall]
        +    family inet {
        +        /*
        +         ** $Date: 2017/03/22 $
        +         **
        +         */
        +        filter filter\-name {
        +            interface\-specific;
        +            term term\-name {
        +                from {
        +                    source\-address {
        +                        1.2.3.4/32;
        +                    }
        +                    destination\-address {
        +                        5.6.7.8/32;
        +                    }
        +                }
        +                then accept;
        +            }
        +        }
        +    }
    loaded_config:
        firewall {
            family inet {
                replace:
                /*
                ** $Date: 2017/03/22 $
                **
                */
                filter filter\-name {
                    interface\-specific;
                    term term\-name {
                        from {
                            source\-address {
                                1.2.3.4/32;
                            }
                            destination\-address {
                                5.6.7.8/32;
                            }
                        }
                        then accept;
                    }
                }
            }
        }
    result:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.napalm_network
.SS NAPALM Network
.sp
Basic methods for interaction with the network device through the virtual proxy \(aqnapalm\(aq.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP> & Jerome Fleury <\fI\%jf@cloudflare.com\fP>
.TP
.B maturity
new
.TP
.B depends
napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
\fI\%napalm proxy minion\fP
.UNINDENT
.sp
New in version 2016.11.0.

.sp
Changed in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.modules.napalm_network.arp(interface=\(aq\(aq, ipaddr=\(aq\(aq, macaddr=\(aq\(aq, **kwargs)
NAPALM returns a list of dictionaries with details of the ARP entries.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinterface\fP \-\- interface name to filter on
.IP \(bu 2
\fBipaddr\fP \-\- IP address to filter on
.IP \(bu 2
\fBmacaddr\fP \-\- MAC address to filter on
.UNINDENT
.TP
.B Returns
List of the entries in the ARP table
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.arp
salt \(aq*\(aq net.arp macaddr=\(aq5c:5e:ab:da:3c:f0\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
    {
        \(aqinterface\(aq : \(aqMgmtEth0/RSP0/CPU0/0\(aq,
        \(aqmac\(aq       : \(aq5c:5e:ab:da:3c:f0\(aq,
        \(aqip\(aq        : \(aq172.17.17.1\(aq,
        \(aqage\(aq       : 1454496274.84
    },
    {
        \(aqinterface\(aq: \(aqMgmtEth0/RSP0/CPU0/0\(aq,
        \(aqmac\(aq       : \(aq66:0e:94:96:e0:ff\(aq,
        \(aqip\(aq        : \(aq172.17.17.2\(aq,
        \(aqage\(aq       : 1435641582.49
    }
]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.blockreplace(marker_start, marker_end, content=\(aq\(aq, append_if_not_found=False, prepend_if_not_found=False, show_changes=True, append_newline=False, source=\(aqrunning\(aq, path=None, test=False, commit=True, debug=False, replace=True)
New in version 2019.2.0.

.sp
Replace content of the configuration source, delimited by the line markers.
.sp
A block of content delimited by comments can help you manage several lines
without worrying about old entries removal.
.INDENT 7.0
.TP
.B marker_start
The line content identifying a line as the start of the content block.
Note that the whole line containing this marker will be considered,
so whitespace or extra content before or after the marker is included
in final output.
.TP
.B marker_end
The line content identifying a line as the end of the content block.
Note that the whole line containing this marker will be considered,
so whitespace or extra content before or after the marker is included
in final output.
.TP
.B content
The content to be used between the two lines identified by
\fBmarker_start\fP and \fBmarker_stop\fP\&.
.TP
.B append_if_not_found: \fBFalse\fP
If markers are not found and set to True then, the markers and content
will be appended to the file.
.TP
.B prepend_if_not_found: \fBFalse\fP
If markers are not found and set to True then, the markers and content
will be prepended to the file.
.TP
.B append_newline: \fBFalse\fP
Controls whether or not a newline is appended to the content block.
If the value of this argument is \fBTrue\fP then a newline will be added
to the content block. If it is \fBFalse\fP, then a newline will not be
added to the content block. If it is \fBNone\fP then a newline will only
be added to the content block if it does not already end in a newline.
.TP
.B show_changes: \fBTrue\fP
Controls how changes are presented. If \fBTrue\fP, this function will
return the of the changes made.
If \fBFalse\fP, then it will return a boolean (\fBTrue\fP if any changes
were made, otherwise False).
.TP
.B source: \fBrunning\fP
The configuration source. Choose from: \fBrunning\fP, \fBcandidate\fP, or
\fBstartup\fP\&. Default: \fBrunning\fP\&.
.TP
.B path: \fBNone\fP
Save the temporary configuration to a specific path, then read from
there. This argument is optional, can be used when you prefers a
particular location of the temporary file.
.TP
.B test: \fBFalse\fP
Dry run? If set as \fBTrue\fP, will apply the config, discard and return
the changes. Default: \fBFalse\fP and will commit the changes on the
device.
.TP
.B commit: \fBTrue\fP
Commit the configuration changes? Default: \fBTrue\fP\&.
.TP
.B debug: \fBFalse\fP
Debug mode. Will insert a new key in the output dictionary, as
\fBloaded_config\fP containing the raw configuration loaded on the device.
.TP
.B replace: \fBTrue\fP
Load and replace the configuration. Default: \fBTrue\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.blockreplace \(aqntp\(aq \(aqinterface\(aq \(aq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.cancel_commit(jid)
New in version 2019.2.0.

.sp
Cancel a commit scheduled to be executed via the \fBcommit_in\fP and
\fBcommit_at\fP arguments from the
\fI\%net.load_template\fP or
\fI\%net.load_config\fP
execution functions. The commit ID is displayed when the commit is scheduled
via the functions named above.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.cancel_commit 20180726083540640360
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.cli(*commands, **kwargs)
Returns a dictionary with the raw output of all commands passed as arguments.
.INDENT 7.0
.TP
.B commands
List of commands to be executed on the device.
.TP
.B textfsm_parse: \fBFalse\fP
Try parsing the outputs using the TextFSM templates.
.sp
New in version 2018.3.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option can be also specified in the minion configuration
file or pillar as \fBnapalm_cli_textfsm_parse\fP\&.
.UNINDENT
.UNINDENT
.TP
.B textfsm_path
The path where the TextFSM templates can be found. This option implies
the usage of the TextFSM index file.
\fBtextfsm_path\fP can be either absolute path on the server,
either specified using the following URL mschemes: \fBfile://\fP,
\fBsalt://\fP, \fBhttp://\fP, \fBhttps://\fP, \fBftp://\fP,
\fBs3://\fP, \fBswift://\fP\&.
.sp
New in version 2018.3.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This needs to be a directory with a flat structure, having an
index file (whose name can be specified using the \fBindex_file\fP option)
and a number of TextFSM templates.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option can be also specified in the minion configuration
file or pillar as \fBtextfsm_path\fP\&.
.UNINDENT
.UNINDENT
.TP
.B textfsm_template
The path to a certain the TextFSM template.
This can be specified using the absolute path
to the file, or using one of the following URL schemes:
.INDENT 7.0
.IP \(bu 2
\fBsalt://\fP, to fetch the template from the Salt fileserver.
.IP \(bu 2
\fBhttp://\fP or \fBhttps://\fP
.IP \(bu 2
\fBftp://\fP
.IP \(bu 2
\fBs3://\fP
.IP \(bu 2
\fBswift://\fP
.UNINDENT
.sp
New in version 2018.3.0.

.TP
.B textfsm_template_dict
A dictionary with the mapping between a command
and the corresponding TextFSM path to use to extract the data.
The TextFSM paths can be specified as in \fBtextfsm_template\fP\&.
.sp
New in version 2018.3.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option can be also specified in the minion configuration
file or pillar as \fBnapalm_cli_textfsm_template_dict\fP\&.
.UNINDENT
.UNINDENT
.TP
.B platform_grain_name: \fBos\fP
The name of the grain used to identify the platform name
in the TextFSM index file. Default: \fBos\fP\&.
.sp
New in version 2018.3.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option can be also specified in the minion configuration
file or pillar as \fBtextfsm_platform_grain\fP\&.
.UNINDENT
.UNINDENT
.TP
.B platform_column_name: \fBPlatform\fP
The column name used to identify the platform,
exactly as specified in the TextFSM index file.
Default: \fBPlatform\fP\&.
.sp
New in version 2018.3.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is field is case sensitive, make sure
to assign the correct value to this option,
exactly as defined in the index file.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option can be also specified in the minion configuration
file or pillar as \fBtextfsm_platform_column_name\fP\&.
.UNINDENT
.UNINDENT
.TP
.B index_file: \fBindex\fP
The name of the TextFSM index file, under the \fBtextfsm_path\fP\&. Default: \fBindex\fP\&.
.sp
New in version 2018.3.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option can be also specified in the minion configuration
file or pillar as \fBtextfsm_index_file\fP\&.
.UNINDENT
.UNINDENT
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file.
Ignored if \fBtextfsm_path\fP is not a \fBsalt://\fP URL.
.sp
New in version 2018.3.0.

.TP
.B include_empty: \fBFalse\fP
Include empty files under the \fBtextfsm_path\fP\&.
.sp
New in version 2018.3.0.

.TP
.B include_pat
Glob or regex to narrow down the files cached from the given path.
If matching with a regex, the regex must be prefixed with \fBE@\fP,
otherwise the expression will be interpreted as a glob.
.sp
New in version 2018.3.0.

.TP
.B exclude_pat
Glob or regex to exclude certain files from being cached from the given path.
If matching with a regex, the regex must be prefixed with \fBE@\fP,
otherwise the expression will be interpreted as a glob.
.sp
New in version 2018.3.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If used with \fBinclude_pat\fP, files matching this pattern will be
excluded from the subset of files defined by \fBinclude_pat\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.cli \(dqshow version\(dq \(dqshow chassis fan\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example with TextFSM template:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.cli textfsm_parse=True textfsm_path=salt://textfsm/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqshow version and haiku\(aq:  \(aqHostname: re0.edge01.arn01
                                  Model: mx480
                                  Junos: 13.3R6.5
                                    Help me, Obi\-Wan
                                    I just saw Episode Two
                                    You\(aqre my only hope
                                 \(aq,
    \(aqshow chassis fan\(aq :   \(aqItem                      Status   RPM     Measurement
                              Top Rear Fan              OK       3840    Spinning at intermediate\-speed
                              Bottom Rear Fan           OK       3840    Spinning at intermediate\-speed
                              Top Middle Fan            OK       3900    Spinning at intermediate\-speed
                              Bottom Middle Fan         OK       3840    Spinning at intermediate\-speed
                              Top Front Fan             OK       3810    Spinning at intermediate\-speed
                              Bottom Front Fan          OK       3840    Spinning at intermediate\-speed
                             \(aq
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output with TextFSM parsing:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
  \(dqcomment\(dq: \(dq\(dq,
  \(dqresult\(dq: true,
  \(dqout\(dq: {
    \(dqsh ver\(dq: [
      {
        \(dqkernel\(dq: \(dq9.1S3.5\(dq,
        \(dqdocumentation\(dq: \(dq9.1S3.5\(dq,
        \(dqboot\(dq: \(dq9.1S3.5\(dq,
        \(dqcrypto\(dq: \(dq9.1S3.5\(dq,
        \(dqchassis\(dq: \(dq\(dq,
        \(dqrouting\(dq: \(dq9.1S3.5\(dq,
        \(dqbase\(dq: \(dq9.1S3.5\(dq,
        \(dqmodel\(dq: \(dqmx960\(dq
      }
    ]
  }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.commit(inherit_napalm_device=None, **kwargs)
Commits the configuration changes made on the network device.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.commit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.compare_config(inherit_napalm_device=None, **kwargs)
Returns the difference between the running config and the candidate config.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.compare_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.config(source=None, **kwargs)
New in version 2017.7.0.

.sp
Return the whole configuration of the network device. By default, it will
return all possible configuration sources supported by the network device.
At most, there will be:
.INDENT 7.0
.IP \(bu 2
running config
.IP \(bu 2
startup config
.IP \(bu 2
candidate config
.UNINDENT
.sp
To return only one of the configurations, you can use the \fBsource\fP
argument.
.INDENT 7.0
.TP
.B source
Which configuration type you want to display, default is all of them.
.sp
Options:
.INDENT 7.0
.IP \(bu 2
running
.IP \(bu 2
candidate
.IP \(bu 2
startup
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
The object returned is a dictionary with the following keys:
.INDENT 7.0
.IP \(bu 2
running (string): Representation of the native running configuration.
.IP \(bu 2
.INDENT 2.0
.TP
.B candidate (string): Representation of the native candidate configuration.
If the device doesn\(aqt differentiate between running and startup
configuration this will an empty string.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B startup (string): Representation of the native startup configuration.
If the device doesn\(aqt differentiate between running and startup
configuration this will an empty string.
.UNINDENT
.UNINDENT

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.config
salt \(aq*\(aq net.config source=candidate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.config_changed(inherit_napalm_device=None, **kwargs)
Will prompt if the configuration has been changed.
.INDENT 7.0
.TP
.B Returns
A tuple with a boolean that specifies if the config was changed on the device.    And a string that provides more details of the reason why the configuration was not changed.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.config_changed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.config_control(inherit_napalm_device=None, **kwargs)
Will check if the configuration was changed.
If differences found, will try to commit.
In case commit unsuccessful, will try to rollback.
.INDENT 7.0
.TP
.B Returns
A tuple with a boolean that specifies if the config was changed/committed/rollbacked on the device.    And a string that provides more details of the reason why the configuration was not committed properly.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.config_control
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.confirm_commit(jid)
New in version 2019.2.0.

.sp
Confirm a commit scheduled to be reverted via the \fBrevert_in\fP and
\fBrevert_at\fP  arguments from the
\fI\%net.load_template\fP or
\fI\%net.load_config\fP
execution functions. The commit ID is displayed when the commit confirmed
is scheduled via the functions named above.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.confirm_commit 20180726083540640360
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.connected(**kwargs)
Specifies if the connection to the device succeeded.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.connected
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.discard_config(inherit_napalm_device=None, **kwargs)
Discards the changes applied.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.discard_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.environment(**kwargs)
Returns the environment of the device.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.environment
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqfans\(aq: {
        \(aqBottom Rear Fan\(aq: {
            \(aqstatus\(aq: True
        },
        \(aqBottom Middle Fan\(aq: {
            \(aqstatus\(aq: True
        },
        \(aqTop Middle Fan\(aq: {
            \(aqstatus\(aq: True
        },
        \(aqBottom Front Fan\(aq: {
            \(aqstatus\(aq: True
        },
        \(aqTop Front Fan\(aq: {
            \(aqstatus\(aq: True
        },
        \(aqTop Rear Fan\(aq: {
            \(aqstatus\(aq: True
        }
    },
    \(aqmemory\(aq: {
        \(aqavailable_ram\(aq: 16349,
        \(aqused_ram\(aq: 4934
    },
    \(aqtemperature\(aq: {
       \(aqFPC 0 Exhaust A\(aq: {
            \(aqis_alert\(aq: False,
            \(aqtemperature\(aq: 35.0,
            \(aqis_critical\(aq: False
        }
    },
    \(aqcpu\(aq: {
        \(aq1\(aq: {
            \(aq%usage\(aq: 19.0
        },
        \(aq0\(aq: {
            \(aq%usage\(aq: 35.0
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.facts(**kwargs)
Returns characteristics of the network device.
:return: a dictionary with the following keys:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
uptime \- Uptime of the device in seconds.
.IP \(bu 2
vendor \- Manufacturer of the device.
.IP \(bu 2
model \- Device model.
.IP \(bu 2
hostname \- Hostname of the device
.IP \(bu 2
fqdn \- Fqdn of the device
.IP \(bu 2
os_version \- String with the OS version running on the device.
.IP \(bu 2
serial_number \- Serial number of the device
.IP \(bu 2
interface_list \- List of the interfaces of the device
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.facts
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqos_version\(aq: \(aq13.3R6.5\(aq,
    \(aquptime\(aq: 10117140,
    \(aqinterface_list\(aq: [
        \(aqlc\-0/0/0\(aq,
        \(aqpfe\-0/0/0\(aq,
        \(aqpfh\-0/0/0\(aq,
        \(aqxe\-0/0/0\(aq,
        \(aqxe\-0/0/1\(aq,
        \(aqxe\-0/0/2\(aq,
        \(aqxe\-0/0/3\(aq,
        \(aqgr\-0/0/10\(aq,
        \(aqip\-0/0/10\(aq
    ],
    \(aqvendor\(aq: \(aqJuniper\(aq,
    \(aqserial_number\(aq: \(aqJN131356FBFA\(aq,
    \(aqmodel\(aq: \(aqMX480\(aq,
    \(aqhostname\(aq: \(aqre0.edge05.syd01\(aq,
    \(aqfqdn\(aq: \(aqre0.edge05.syd01\(aq
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.interfaces(**kwargs)
Returns details of the interfaces on the device.
.INDENT 7.0
.TP
.B Returns
Returns a dictionary of dictionaries. The keys for the first
dictionary will be the interfaces in the devices.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqManagement1\(aq: {
        \(aqis_up\(aq: False,
        \(aqis_enabled\(aq: False,
        \(aqdescription\(aq: \(aq\(aq,
        \(aqlast_flapped\(aq: \-1,
        \(aqspeed\(aq: 1000,
        \(aqmac_address\(aq: \(aqdead:beef:dead\(aq,
    },
    \(aqEthernet1\(aq:{
        \(aqis_up\(aq: True,
        \(aqis_enabled\(aq: True,
        \(aqdescription\(aq: \(aqfoo\(aq,
        \(aqlast_flapped\(aq: 1429978575.1554043,
        \(aqspeed\(aq: 1000,
        \(aqmac_address\(aq: \(aqbeef:dead:beef\(aq,
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.ipaddrs(**kwargs)
Returns IP addresses configured on the device.
.INDENT 7.0
.TP
.B Returns
A dictionary with the IPv4 and IPv6 addresses of the interfaces.
Returns all configured IP addresses on all interfaces as a dictionary
of dictionaries.  Keys of the main dictionary represent the name of the
interface.  Values of the main dictionary represent are dictionaries
that may consist of two keys \(aqipv4\(aq and \(aqipv6\(aq (one, both or none)
which are themselvs dictionaries with the IP addresses as keys.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.ipaddrs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqFastEthernet8\(aq: {
        \(aqipv4\(aq: {
            \(aq10.66.43.169\(aq: {
                \(aqprefix_length\(aq: 22
            }
        }
    },
    \(aqLoopback555\(aq: {
        \(aqipv4\(aq: {
            \(aq192.168.1.1\(aq: {
                \(aqprefix_length\(aq: 24
            }
        },
        \(aqipv6\(aq: {
            \(aq1::1\(aq: {
                \(aqprefix_length\(aq: 64
            },
            \(aq2001:DB8:1::1\(aq: {
                \(aqprefix_length\(aq: 64
            },
            \(aqFE80::3\(aq: {
                \(aqprefix_length\(aq: \(aqN/A\(aq
            }
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.lldp(interface=\(aq\(aq, **kwargs)
Returns a detailed view of the LLDP neighbors.
.INDENT 7.0
.TP
.B Parameters
\fBinterface\fP \-\- interface name to filter on
.TP
.B Returns
A dictionary with the LLDL neighbors. The keys are the
interfaces with LLDP activated on.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.lldp
salt \(aq*\(aq net.lldp interface=\(aqTenGigE0/0/0/8\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqTenGigE0/0/0/8\(aq: [
        {
            \(aqparent_interface\(aq: \(aqBundle\-Ether8\(aq,
            \(aqinterface_description\(aq: \(aqTenGigE0/0/0/8\(aq,
            \(aqremote_chassis_id\(aq: \(aq8c60.4f69.e96c\(aq,
            \(aqremote_system_name\(aq: \(aqswitch\(aq,
            \(aqremote_port\(aq: \(aqEth2/2/1\(aq,
            \(aqremote_port_description\(aq: \(aqEthernet2/2/1\(aq,
            \(aqremote_system_description\(aq: \(aqCisco Nexus Operating System (NX\-OS) Software 7.1(0)N1(1a)
                  TAC support: http://www.cisco.com/tac
                  Copyright (c) 2002\-2015, Cisco Systems, Inc. All rights reserved.\(aq,
            \(aqremote_system_capab\(aq: \(aqB, R\(aq,
            \(aqremote_system_enable_capab\(aq: \(aqB\(aq
        }
    ]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.load_config(filename=None, text=None, test=False, commit=True, debug=False, replace=False, commit_in=None, commit_at=None, revert_in=None, revert_at=None, commit_jid=None, inherit_napalm_device=None, saltenv=\(aqbase\(aq, **kwargs)
Applies configuration changes on the device. It can be loaded from a file or from inline string.
If you send both a filename and a string containing the configuration, the file has higher precedence.
.sp
By default this function will commit the changes. If there are no changes, it does not commit and
the flag \fBalready_configured\fP will be set as \fBTrue\fP to point this out.
.sp
To avoid committing the configuration, set the argument \fBtest\fP to \fBTrue\fP and will discard (dry run).
.sp
To keep the changes but not commit, set \fBcommit\fP to \fBFalse\fP\&.
.sp
To replace the config, set \fBreplace\fP to \fBTrue\fP\&.
.INDENT 7.0
.TP
.B filename
Path to the file containing the desired configuration.
This can be specified using the absolute path to the file,
or using one of the following URL schemes:
.INDENT 7.0
.IP \(bu 2
\fBsalt://\fP, to fetch the template from the Salt fileserver.
.IP \(bu 2
\fBhttp://\fP or \fBhttps://\fP
.IP \(bu 2
\fBftp://\fP
.IP \(bu 2
\fBs3://\fP
.IP \(bu 2
\fBswift://\fP
.UNINDENT
.sp
Changed in version 2018.3.0.

.TP
.B text
String containing the desired configuration.
This argument is ignored when \fBfilename\fP is specified.
.TP
.B test: False
Dry run? If set as \fBTrue\fP, will apply the config, discard and return the changes. Default: \fBFalse\fP
and will commit the changes on the device.
.TP
.B commit: True
Commit? Default: \fBTrue\fP\&.
.TP
.B debug: False
Debug mode. Will insert a new key under the output dictionary, as \fBloaded_config\fP containing the raw
configuration loaded on the device.
.sp
New in version 2016.11.2.

.TP
.B replace: False
Load and replace the configuration. Default: \fBFalse\fP\&.
.sp
New in version 2016.11.2.

.TP
.B commit_in: \fBNone\fP
Commit the changes in a specific number of minutes / hours. Example of
accepted formats: \fB5\fP (commit in 5 minutes), \fB2m\fP (commit in 2
minutes), \fB1h\fP (commit the changes in 1 hour)\(ga, \fB5h30m\fP (commit
the changes in 5 hours and 30 minutes).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This feature works on any platforms, as it does not rely on the
native features of the network operating system.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
After the command is executed and the \fBdiff\fP is not satisfactory,
or for any other reasons you have to discard the commit, you are
able to do so using the
\fI\%net.cancel_commit\fP
execution function, using the commit ID returned by this function.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Using this feature, Salt will load the exact configuration you
expect, however the diff may change in time (i.e., if an user
applies a manual configuration change, or a different process or
command changes the configuration in the meanwhile).
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B commit_at: \fBNone\fP
Commit the changes at a specific time. Example of accepted formats:
\fB1am\fP (will commit the changes at the next 1AM), \fB13:20\fP (will
commit at 13:20), \fB1:20am\fP, etc.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This feature works on any platforms, as it does not rely on the
native features of the network operating system.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
After the command is executed and the \fBdiff\fP is not satisfactory,
or for any other reasons you have to discard the commit, you are
able to do so using the
\fI\%net.cancel_commit\fP
execution function, using the commit ID returned by this function.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Using this feature, Salt will load the exact configuration you
expect, however the diff may change in time (i.e., if an user
applies a manual configuration change, or a different process or
command changes the configuration in the meanwhile).
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B revert_in: \fBNone\fP
Commit and revert the changes in a specific number of minutes / hours.
Example of accepted formats: \fB5\fP (revert in 5 minutes), \fB2m\fP (revert
in 2 minutes), \fB1h\fP (revert the changes in 1 hour)\(ga, \fB5h30m\fP (revert
the changes in 5 hours and 30 minutes).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To confirm the commit, and prevent reverting the changes, you will
have to execute the
\fI\%net.confirm_commit\fP
function, using the commit ID returned by this function.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This works on any platform, regardless if they have or don\(aqt have
native capabilities to confirming a commit. However, please be
\fIvery\fP cautious when using this feature: on Junos (as it is the only
NAPALM core platform supporting this natively) it executes a commit
confirmed as you would do from the command line.
All the other platforms don\(aqt have this capability natively,
therefore the revert is done via Salt. That means, your device needs
to be reachable at the moment when Salt will attempt to revert your
changes. Be cautious when pushing configuration changes that would
prevent you reach the device.
.sp
Similarly, if an user or a different process apply other
configuration changes in the meanwhile (between the moment you
commit and till the changes are reverted), these changes would be
equally reverted, as Salt cannot be aware of them.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B revert_at: \fBNone\fP
Commit and revert the changes at a specific time. Example of accepted
formats: \fB1am\fP (will commit and revert the changes at the next 1AM),
\fB13:20\fP (will commit and revert at 13:20), \fB1:20am\fP, etc.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To confirm the commit, and prevent reverting the changes, you will
have to execute the
\fI\%net.confirm_commit\fP
function, using the commit ID returned by this function.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This works on any platform, regardless if they have or don\(aqt have
native capabilities to confirming a commit. However, please be
\fIvery\fP cautious when using this feature: on Junos (as it is the only
NAPALM core platform supporting this natively) it executes a commit
confirmed as you would do from the command line.
All the other platforms don\(aqt have this capability natively,
therefore the revert is done via Salt. That means, your device needs
to be reachable at the moment when Salt will attempt to revert your
changes. Be cautious when pushing configuration changes that would
prevent you reach the device.
.sp
Similarly, if an user or a different process apply other
configuration changes in the meanwhile (between the moment you
commit and till the changes are reverted), these changes would be
equally reverted, as Salt cannot be aware of them.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B saltenv: \fBbase\fP
Specifies the Salt environment name.
.sp
New in version 2018.3.0.

.UNINDENT
.INDENT 7.0
.TP
.B Returns
a dictionary having the following keys:
.UNINDENT
.INDENT 7.0
.IP \(bu 2
result (bool): if the config was applied successfully. It is \fBFalse\fP only in case of failure. In case     there are no changes to be applied and successfully performs all operations it is still \fBTrue\fP and so will be     the \fBalready_configured\fP flag (example below)
.IP \(bu 2
comment (str): a message for the user
.IP \(bu 2
already_configured (bool): flag to check if there were no changes applied
.IP \(bu 2
loaded_config (str): the configuration loaded on the device. Requires \fBdebug\fP to be set as \fBTrue\fP
.IP \(bu 2
diff (str): returns the config changes applied
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.load_config text=\(aqntp peer 192.168.0.1\(aq
salt \(aq*\(aq net.load_config filename=\(aq/absolute/path/to/your/file\(aq
salt \(aq*\(aq net.load_config filename=\(aq/absolute/path/to/your/file\(aq test=True
salt \(aq*\(aq net.load_config filename=\(aq/absolute/path/to/your/file\(aq commit=False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqcomment\(aq: \(aqConfiguration discarded.\(aq,
    \(aqalready_configured\(aq: False,
    \(aqresult\(aq: True,
    \(aqdiff\(aq: \(aq[edit interfaces xe\-0/0/5]+   description \(dqAdding a description\(dq;\(aq
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.load_template(template_name=None, template_source=None, context=None, defaults=None, template_engine=\(aqjinja\(aq, saltenv=\(aqbase\(aq, template_hash=None, template_hash_name=None, skip_verify=False, test=False, commit=True, debug=False, replace=False, commit_in=None, commit_at=None, revert_in=None, revert_at=None, inherit_napalm_device=None, **template_vars)
Renders a configuration template (default: Jinja) and loads the result on the device.
.sp
By default this function will commit the changes. If there are no changes,
it does not commit, discards he config and the flag \fBalready_configured\fP
will be set as \fBTrue\fP to point this out.
.sp
To avoid committing the configuration, set the argument \fBtest\fP to \fBTrue\fP
and will discard (dry run).
.sp
To preserve the changes, set \fBcommit\fP to \fBFalse\fP\&.
However, this is recommended to be used only in exceptional cases
when there are applied few consecutive states
and/or configuration changes.
Otherwise the user might forget that the config DB is locked
and the candidate config buffer is not cleared/merged in the running config.
.sp
To replace the config, set \fBreplace\fP to \fBTrue\fP\&.
.INDENT 7.0
.TP
.B template_name
Identifies path to the template source.
The template can be either stored on the local machine, either remotely.
The recommended location is under the \fBfile_roots\fP
as specified in the master config file.
For example, let\(aqs suppose the \fBfile_roots\fP is configured as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /etc/salt/states
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Placing the template under \fB/etc/salt/states/templates/example.jinja\fP,
it can be used as \fBsalt://templates/example.jinja\fP\&.
Alternatively, for local files, the user can specify the absolute path.
If remotely, the source can be retrieved via \fBhttp\fP, \fBhttps\fP or \fBftp\fP\&.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBsalt://my_template.jinja\fP
.IP \(bu 2
\fB/absolute/path/to/my_template.jinja\fP
.IP \(bu 2
\fBhttp://example.com/template.cheetah\fP
.IP \(bu 2
\fBhttps:/example.com/template.mako\fP
.IP \(bu 2
\fBftp://example.com/template.py\fP
.UNINDENT
.sp
Changed in version 2019.2.0: This argument can now support a list of templates to be rendered.
The resulting configuration text is loaded at once, as a single
configuration chunk.

.TP
.B template_source: None
Inline config template to be rendered and loaded on the device.
.TP
.B template_hash: None
Hash of the template file. Format: \fB{hash_type: \(aqmd5\(aq, \(aqhsum\(aq: <md5sum>}\fP
.sp
New in version 2016.11.2.

.TP
.B context: None
Overrides default context variables passed to the template.
.sp
New in version 2019.2.0.

.TP
.B template_hash_name: None
When \fBtemplate_hash\fP refers to a remote file,
this specifies the filename to look for in that file.
.sp
New in version 2016.11.2.

.TP
.B saltenv: \fBbase\fP
Specifies the template environment.
This will influence the relative imports inside the templates.
.sp
New in version 2016.11.2.

.TP
.B template_engine: jinja
The following templates engines are supported:
.INDENT 7.0
.IP \(bu 2
\fI\%cheetah\fP
.IP \(bu 2
\fI\%genshi\fP
.IP \(bu 2
\fI\%jinja\fP
.IP \(bu 2
\fI\%mako\fP
.IP \(bu 2
\fI\%py\fP
.IP \(bu 2
\fI\%wempy\fP
.UNINDENT
.sp
New in version 2016.11.2.

.TP
.B skip_verify: True
If \fBTrue\fP, hash verification of remote file sources
(\fBhttp://\fP, \fBhttps://\fP, \fBftp://\fP) will be skipped,
and the \fBsource_hash\fP argument will be ignored.
.sp
New in version 2016.11.2.

.TP
.B test: False
Dry run? If set to \fBTrue\fP, will apply the config,
discard and return the changes.
Default: \fBFalse\fP and will commit the changes on the device.
.TP
.B commit: True
Commit? (default: \fBTrue\fP)
.TP
.B debug: False
Debug mode. Will insert a new key under the output dictionary,
as \fBloaded_config\fP containing the raw result after the template was rendered.
.sp
New in version 2016.11.2.

.TP
.B replace: False
Load and replace the configuration.
.sp
New in version 2016.11.2.

.TP
.B commit_in: \fBNone\fP
Commit the changes in a specific number of minutes / hours. Example of
accepted formats: \fB5\fP (commit in 5 minutes), \fB2m\fP (commit in 2
minutes), \fB1h\fP (commit the changes in 1 hour)\(ga, \fB5h30m\fP (commit
the changes in 5 hours and 30 minutes).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This feature works on any platforms, as it does not rely on the
native features of the network operating system.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
After the command is executed and the \fBdiff\fP is not satisfactory,
or for any other reasons you have to discard the commit, you are
able to do so using the
\fI\%net.cancel_commit\fP
execution function, using the commit ID returned by this function.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Using this feature, Salt will load the exact configuration you
expect, however the diff may change in time (i.e., if an user
applies a manual configuration change, or a different process or
command changes the configuration in the meanwhile).
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B commit_at: \fBNone\fP
Commit the changes at a specific time. Example of accepted formats:
\fB1am\fP (will commit the changes at the next 1AM), \fB13:20\fP (will
commit at 13:20), \fB1:20am\fP, etc.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This feature works on any platforms, as it does not rely on the
native features of the network operating system.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
After the command is executed and the \fBdiff\fP is not satisfactory,
or for any other reasons you have to discard the commit, you are
able to do so using the
\fI\%net.cancel_commit\fP
execution function, using the commit ID returned by this function.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Using this feature, Salt will load the exact configuration you
expect, however the diff may change in time (i.e., if an user
applies a manual configuration change, or a different process or
command changes the configuration in the meanwhile).
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B revert_in: \fBNone\fP
Commit and revert the changes in a specific number of minutes / hours.
Example of accepted formats: \fB5\fP (revert in 5 minutes), \fB2m\fP (revert
in 2 minutes), \fB1h\fP (revert the changes in 1 hour)\(ga, \fB5h30m\fP (revert
the changes in 5 hours and 30 minutes).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To confirm the commit, and prevent reverting the changes, you will
have to execute the
\fI\%net.confirm_commit\fP
function, using the commit ID returned by this function.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This works on any platform, regardless if they have or don\(aqt have
native capabilities to confirming a commit. However, please be
\fIvery\fP cautious when using this feature: on Junos (as it is the only
NAPALM core platform supporting this natively) it executes a commit
confirmed as you would do from the command line.
All the other platforms don\(aqt have this capability natively,
therefore the revert is done via Salt. That means, your device needs
to be reachable at the moment when Salt will attempt to revert your
changes. Be cautious when pushing configuration changes that would
prevent you reach the device.
.sp
Similarly, if an user or a different process apply other
configuration changes in the meanwhile (between the moment you
commit and till the changes are reverted), these changes would be
equally reverted, as Salt cannot be aware of them.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B revert_at: \fBNone\fP
Commit and revert the changes at a specific time. Example of accepted
formats: \fB1am\fP (will commit and revert the changes at the next 1AM),
\fB13:20\fP (will commit and revert at 13:20), \fB1:20am\fP, etc.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To confirm the commit, and prevent reverting the changes, you will
have to execute the
\fI\%net.confirm_commit\fP
function, using the commit ID returned by this function.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This works on any platform, regardless if they have or don\(aqt have
native capabilities to confirming a commit. However, please be
\fIvery\fP cautious when using this feature: on Junos (as it is the only
NAPALM core platform supporting this natively) it executes a commit
confirmed as you would do from the command line.
All the other platforms don\(aqt have this capability natively,
therefore the revert is done via Salt. That means, your device needs
to be reachable at the moment when Salt will attempt to revert your
changes. Be cautious when pushing configuration changes that would
prevent you reach the device.
.sp
Similarly, if an user or a different process apply other
configuration changes in the meanwhile (between the moment you
commit and till the changes are reverted), these changes would be
equally reverted, as Salt cannot be aware of them.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B defaults: None
Default variables/context passed to the template.
.sp
New in version 2016.11.2.

.TP
.B template_vars
Dictionary with the arguments/context to be used when the template is rendered.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Do not explicitly specify this argument. This represents any other
variable that will be sent to the template rendering system.
Please see the examples below!
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
It is more recommended to use the \fBcontext\fP argument to avoid
conflicts between CLI arguments and template variables.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
a dictionary having the following keys:
.UNINDENT
.INDENT 7.0
.IP \(bu 2
result (bool): if the config was applied successfully. It is \fBFalse\fP
only in case of failure. In case there are no changes to be applied and
successfully performs all operations it is still \fBTrue\fP and so will be
the \fBalready_configured\fP flag (example below)
.IP \(bu 2
comment (str): a message for the user
.IP \(bu 2
already_configured (bool): flag to check if there were no changes applied
.IP \(bu 2
loaded_config (str): the configuration loaded on the device, after
rendering the template. Requires \fBdebug\fP to be set as \fBTrue\fP
.IP \(bu 2
diff (str): returns the config changes applied
.UNINDENT
.sp
The template can use variables from the \fBgrains\fP, \fBpillar\fP or \fBopts\fP, for example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set router_model = grains.get(\(aqmodel\(aq) \-%}
{% set router_vendor = grains.get(\(aqvendor\(aq) \-%}
{% set os_version = grains.get(\(aqversion\(aq) \-%}
{% set hostname = pillar.get(\(aqproxy\(aq, {}).get(\(aqhost\(aq) \-%}
{% if router_vendor|lower == \(aqjuniper\(aq %}
system {
    host\-name {{hostname}};
}
{% elif router_vendor|lower == \(aqcisco\(aq %}
hostname {{hostname}}
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.load_template set_ntp_peers peers=[192.168.0.1]  # uses NAPALM default templates

# inline template:
salt \-G \(aqos:junos\(aq net.load_template template_source=\(aqsystem { host\-name {{host_name}}; }\(aq         host_name=\(aqMX480.lab\(aq

# inline template using grains info:
salt \-G \(aqos:junos\(aq net.load_template         template_source=\(aqsystem { host\-name {{grains.model}}.lab; }\(aq
# if the device is a MX480, the command above will set the hostname as: MX480.lab

# inline template using pillar data:
salt \-G \(aqos:junos\(aq net.load_template template_source=\(aqsystem { host\-name {{pillar.proxy.host}}; }\(aq

salt \(aq*\(aq net.load_template https://bit.ly/2OhSgqP hostname=example  # will commit
salt \(aq*\(aq net.load_template https://bit.ly/2OhSgqP hostname=example test=True  # dry run

salt \(aq*\(aq net.load_template salt://templates/example.jinja debug=True  # Using the salt:// URI

# render a mako template:
salt \(aq*\(aq net.load_template salt://templates/example.mako template_engine=mako debug=True

# render remote template
salt \-G \(aqos:junos\(aq net.load_template http://bit.ly/2fReJg7 test=True debug=True peers=[\(aq192.168.0.1\(aq]
salt \-G \(aqos:ios\(aq net.load_template http://bit.ly/2gKOj20 test=True debug=True peers=[\(aq192.168.0.1\(aq]

# render multiple templates at once
salt \(aq*\(aq net.load_template \(dq[\(aqhttps://bit.ly/2OhSgqP\(aq, \(aqsalt://templates/example.jinja\(aq]\(dq context=\(dq{\(aqhostname\(aq: \(aqexample\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqcomment\(aq: \(aq\(aq,
    \(aqalready_configured\(aq: False,
    \(aqresult\(aq: True,
    \(aqdiff\(aq: \(aq[edit system]+  host\-name edge01.bjm01\(aq,
    \(aqloaded_config\(aq: \(aqsystem { host\-name edge01.bjm01; }\(aq\(aq
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.mac(address=\(aq\(aq, interface=\(aq\(aq, vlan=0, **kwargs)
Returns the MAC Address Table on the device.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBaddress\fP \-\- MAC address to filter on
.IP \(bu 2
\fBinterface\fP \-\- Interface name to filter on
.IP \(bu 2
\fBvlan\fP \-\- VLAN identifier
.UNINDENT
.TP
.B Returns
A list of dictionaries representing the entries in the MAC Address Table
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.mac
salt \(aq*\(aq net.mac vlan=10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
    {
        \(aqmac\(aq       : \(aq00:1c:58:29:4a:71\(aq,
        \(aqinterface\(aq : \(aqxe\-3/0/2\(aq,
        \(aqstatic\(aq    : False,
        \(aqactive\(aq    : True,
        \(aqmoves\(aq     : 1,
        \(aqvlan\(aq      : 10,
        \(aqlast_move\(aq : 1454417742.58
    },
    {
        \(aqmac\(aq       : \(aq8c:60:4f:58:e1:c1\(aq,
        \(aqinterface\(aq : \(aqxe\-1/0/1\(aq,
        \(aqstatic\(aq    : False,
        \(aqactive\(aq    : True,
        \(aqmoves\(aq     : 2,
        \(aqvlan\(aq      : 42,
        \(aqlast_move\(aq : 1453191948.11
    }
]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.optics(**kwargs)
New in version 2017.7.0.

.sp
Fetches the power usage on the various transceivers installed
on the network device (in dBm), and returns a view that conforms with the
OpenConfig model openconfig\-platform\-transceiver.yang.
.INDENT 7.0
.TP
.B Returns
.INDENT 7.0
.TP
.B Returns a dictionary where the keys are as listed below:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B intf_name (unicode)
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B physical_channels
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B channels (list of dicts)
.INDENT 7.0
.IP \(bu 2
index (int)
.IP \(bu 2
.INDENT 2.0
.TP
.B state
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B input_power
.INDENT 7.0
.IP \(bu 2
instant (float)
.IP \(bu 2
avg (float)
.IP \(bu 2
min (float)
.IP \(bu 2
max (float)
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B output_power
.INDENT 7.0
.IP \(bu 2
instant (float)
.IP \(bu 2
avg (float)
.IP \(bu 2
min (float)
.IP \(bu 2
max (float)
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B laser_bias_current
.INDENT 7.0
.IP \(bu 2
instant (float)
.IP \(bu 2
avg (float)
.IP \(bu 2
min (float)
.IP \(bu 2
max (float)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.optics
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.patch(patchfile, options=\(aq\(aq, saltenv=\(aqbase\(aq, source_hash=None, show_changes=True, source=\(aqrunning\(aq, path=None, test=False, commit=True, debug=False, replace=True)
New in version 2019.2.0.

.sp
Apply a patch to the configuration source, and load the result into the
running config of the device.
.INDENT 7.0
.TP
.B patchfile
A patch file to apply to the configuration source.
.TP
.B options
Options to pass to patch.
.TP
.B source_hash
If the patch file (specified via the \fBpatchfile\fP argument)  is an
HTTP(S) or FTP URL and the file exists in the minion\(aqs file cache, this
option can be passed to keep the minion from re\-downloading the file if
the cached copy matches the specified hash.
.TP
.B show_changes: \fBTrue\fP
Controls how changes are presented. If \fBTrue\fP, this function will
return the of the changes made.
If \fBFalse\fP, then it will return a boolean (\fBTrue\fP if any changes
were made, otherwise False).
.TP
.B source: \fBrunning\fP
The configuration source. Choose from: \fBrunning\fP, \fBcandidate\fP, or
\fBstartup\fP\&. Default: \fBrunning\fP\&.
.TP
.B path: \fBNone\fP
Save the temporary configuration to a specific path, then read from
there. This argument is optional, can the user prefers a particular
location of the temporary file.
.TP
.B test: \fBFalse\fP
Dry run? If set as \fBTrue\fP, will apply the config, discard and return
the changes. Default: \fBFalse\fP and will commit the changes on the
device.
.TP
.B commit: \fBTrue\fP
Commit the configuration changes? Default: \fBTrue\fP\&.
.TP
.B debug: \fBFalse\fP
Debug mode. Will insert a new key in the output dictionary, as
\fBloaded_config\fP containing the raw configuration loaded on the device.
.TP
.B replace: \fBTrue\fP
Load and replace the configuration. Default: \fBTrue\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.patch https://example.com/running_config.patch
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.ping(destination, source=None, ttl=None, timeout=None, size=None, count=None, vrf=None, **kwargs)
Executes a ping on the network device and returns a dictionary as a result.
.INDENT 7.0
.TP
.B destination
Hostname or IP address of remote host
.TP
.B source
Source address of echo request
.TP
.B ttl
IP time\-to\-live value (IPv6 hop\-limit value) (1..255 hops)
.TP
.B timeout
Maximum wait time after sending final packet (seconds)
.TP
.B size
Size of request packets (0..65468 bytes)
.TP
.B count
Number of ping requests to send (1..2000000000 packets)
.TP
.B vrf
VRF (routing instance) for ping attempt
.sp
New in version 2016.11.4.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.ping 8.8.8.8
salt \(aq*\(aq net.ping 8.8.8.8 ttl=3 size=65468
salt \(aq*\(aq net.ping 8.8.8.8 source=127.0.0.1 timeout=1 count=100
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.replace_pattern(pattern, repl, count=0, flags=8, bufsize=1, append_if_not_found=False, prepend_if_not_found=False, not_found_content=None, search_only=False, show_changes=True, backslash_literal=False, source=None, path=None, test=False, replace=True, debug=False, commit=True)
New in version 2019.2.0.

.sp
Replace occurrences of a pattern in the configuration source. If
\fBshow_changes\fP is \fBTrue\fP, then a diff of what changed will be returned,
otherwise a \fBTrue\fP will be returned when changes are made, and \fBFalse\fP
when no changes are made.
This is a pure Python implementation that wraps Python\(aqs \fI\%sub()\fP\&.
.INDENT 7.0
.TP
.B pattern
A regular expression, to be matched using Python\(aqs
\fI\%search()\fP\&.
.TP
.B repl
The replacement text.
.TP
.B count: \fB0\fP
Maximum number of pattern occurrences to be replaced. If count is a
positive integer \fBn\fP, only \fBn\fP occurrences will be replaced,
otherwise all occurrences will be replaced.
.TP
.B flags (list or int): \fB8\fP
A list of flags defined in the \fBre\fP module documentation from the
Python standard library. Each list item should be a string that will
correlate to the human\-friendly flag name. E.g., \fB[\(aqIGNORECASE\(aq,
\(aqMULTILINE\(aq]\fP\&. Optionally, \fBflags\fP may be an int, with a value
corresponding to the XOR (\fB|\fP) of all the desired flags. Defaults to
8 (which supports \(aqMULTILINE\(aq).
.TP
.B bufsize (int or str): \fB1\fP
How much of the configuration to buffer into memory at once. The
default value \fB1\fP processes one line at a time. The special value
\fBfile\fP may be specified which will read the entire file into memory
before processing.
.TP
.B append_if_not_found: \fBFalse\fP
If set to \fBTrue\fP, and pattern is not found, then the content will be
appended to the file.
.TP
.B prepend_if_not_found: \fBFalse\fP
If set to \fBTrue\fP and pattern is not found, then the content will be
prepended to the file.
.TP
.B not_found_content
Content to use for append/prepend if not found. If None (default), uses
\fBrepl\fP\&. Useful when \fBrepl\fP uses references to group in pattern.
.TP
.B search_only: \fBFalse\fP
If set to true, this no changes will be performed on the file, and this
function will simply return \fBTrue\fP if the pattern was matched, and
\fBFalse\fP if not.
.TP
.B show_changes: \fBTrue\fP
If \fBTrue\fP, return a diff of changes made. Otherwise, return \fBTrue\fP
if changes were made, and \fBFalse\fP if not.
.TP
.B backslash_literal: \fBFalse\fP
Interpret backslashes as literal backslashes for the repl and not
escape characters.  This will help when using append/prepend so that
the backslashes are not interpreted for the repl on the second run of
the state.
.TP
.B source: \fBrunning\fP
The configuration source. Choose from: \fBrunning\fP, \fBcandidate\fP, or
\fBstartup\fP\&. Default: \fBrunning\fP\&.
.TP
.B path
Save the temporary configuration to a specific path, then read from
there.
.TP
.B test: \fBFalse\fP
Dry run? If set as \fBTrue\fP, will apply the config, discard and return
the changes. Default: \fBFalse\fP and will commit the changes on the
device.
.TP
.B commit: \fBTrue\fP
Commit the configuration changes? Default: \fBTrue\fP\&.
.TP
.B debug: \fBFalse\fP
Debug mode. Will insert a new key in the output dictionary, as
\fBloaded_config\fP containing the raw configuration loaded on the device.
.TP
.B replace: \fBTrue\fP
Load and replace the configuration. Default: \fBTrue\fP\&.
.UNINDENT
.sp
If an equal sign (\fB=\fP) appears in an argument to a Salt command it is
interpreted as a keyword argument in the format \fBkey=val\fP\&. That
processing can be bypassed in order to pass an equal sign through to the
remote shell command by manually specifying the kwarg:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.replace_pattern \(dqbind\-address\es*=\(dq \(dqbind\-address:\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.replace_pattern PREFIX\-LIST_NAME new\-prefix\-list\-name
salt \(aq*\(aq net.replace_pattern bgp\-group\-name new\-bgp\-group\-name count=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.rollback(inherit_napalm_device=None, **kwargs)
Rollbacks the configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.rollback
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.save_config(source=None, path=None)
New in version 2019.2.0.

.sp
Save the configuration to a file on the local file system.
.INDENT 7.0
.TP
.B source: \fBrunning\fP
The configuration source. Choose from: \fBrunning\fP, \fBcandidate\fP,
\fBstartup\fP\&. Default: \fBrunning\fP\&.
.TP
.B path
Absolute path to file where to save the configuration.
To push the files to the Master, use
\fI\%cp.push\fP Execution function.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.save_config source=running
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_network.traceroute(destination, source=None, ttl=None, timeout=None, vrf=None, **kwargs)
Calls the method traceroute from the NAPALM driver object and returns a dictionary with the result of the traceroute
command executed on the device.
.INDENT 7.0
.TP
.B destination
Hostname or address of remote host
.TP
.B source
Source address to use in outgoing traceroute packets
.TP
.B ttl
IP maximum time\-to\-live value (or IPv6 maximum hop\-limit value)
.TP
.B timeout
Number of seconds to wait for response (seconds)
.TP
.B vrf
VRF (routing instance) for traceroute attempt
.sp
New in version 2016.11.4.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.traceroute 8.8.8.8
salt \(aq*\(aq net.traceroute 8.8.8.8 source=127.0.0.1 ttl=5 timeout=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.napalm_ntp
.SS NAPALM NTP
.sp
Manages NTP on network devices.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP> & Jerome Fleury <\fI\%jf@cloudflare.com\fP>
.TP
.B maturity
new
.TP
.B depends
napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
\fI\%NAPALM proxy minion\fP
.IP \(bu 2
\fI\%NET basic features\fP
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%NTP peers management state\fP
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.modules.napalm_ntp.delete_peers(*peers, **options)
Removes NTP peers configured on the device.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpeers\fP \-\- list of IP Addresses/Domain Names to be removed as NTP peers
.IP \(bu 2
\fB(\fP\fBbool\fP\fB)\fP (\fIcommit\fP) \-\- discard loaded config. By default \fBtest\fP is False
(will not dicard the changes)
.IP \(bu 2
\fB(\fP\fBbool\fP\fB)\fP \-\- commit loaded config. By default \fBcommit\fP is True
(will commit the changes). Useful when the user does not want to commit
after each change, but after a couple.
.UNINDENT
.UNINDENT
.sp
By default this function will commit the config changes (if any). To load
without committing, use the \fBcommit\fP option. For a dry run, use the
\fBtest\fP argument.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ntp.delete_peers 8.8.8.8 time.apple.com
salt \(aq*\(aq ntp.delete_peers 172.17.17.1 test=True  # only displays the diff
salt \(aq*\(aq ntp.delete_peers 192.168.0.1 commit=False  # preserves the changes, but does not commit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_ntp.delete_servers(*servers, **options)
Removes NTP servers configured on the device.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBservers\fP \-\- list of IP Addresses/Domain Names to be removed as NTP
servers
.IP \(bu 2
\fB(\fP\fBbool\fP\fB)\fP (\fIcommit\fP) \-\- discard loaded config. By default \fBtest\fP is False
(will not dicard the changes)
.IP \(bu 2
\fB(\fP\fBbool\fP\fB)\fP \-\- commit loaded config. By default \fBcommit\fP is True
(will commit the changes). Useful when the user does not want to commit
after each change, but after a couple.
.UNINDENT
.UNINDENT
.sp
By default this function will commit the config changes (if any). To load
without committing, use the \fBcommit\fP option. For dry run use the \fBtest\fP
argument.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ntp.delete_servers 8.8.8.8 time.apple.com
salt \(aq*\(aq ntp.delete_servers 172.17.17.1 test=True  # only displays the diff
salt \(aq*\(aq ntp.delete_servers 192.168.0.1 commit=False  # preserves the changes, but does not commit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_ntp.peers(**kwargs)
Returns a list the NTP peers configured on the network device.
.INDENT 7.0
.TP
.B Returns
configured NTP peers as list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ntp.peers
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
    \(aq192.168.0.1\(aq,
    \(aq172.17.17.1\(aq,
    \(aq172.17.17.2\(aq,
    \(aq2400:cb00:6:1024::c71b:840a\(aq
]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_ntp.servers(**kwargs)
Returns a list of the configured NTP servers on the device.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ntp.servers
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
    \(aq192.168.0.1\(aq,
    \(aq172.17.17.1\(aq,
    \(aq172.17.17.2\(aq,
    \(aq2400:cb00:6:1024::c71b:840a\(aq
]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_ntp.set_peers(*peers, **options)
Configures a list of NTP peers on the device.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpeers\fP \-\- list of IP Addresses/Domain Names
.IP \(bu 2
\fB(\fP\fBbool\fP\fB)\fP (\fItest\fP) \-\- discard loaded config. By default \fBtest\fP is False
(will not dicard the changes)
.UNINDENT
.TP
.B Commit commit (bool)
commit loaded config. By default \fBcommit\fP is True
(will commit the changes). Useful when the user does not want to commit
after each change, but after a couple.
.UNINDENT
.sp
By default this function will commit the config changes (if any). To load without committing, use the \fIcommit\fP
option. For dry run use the \fItest\fP argument.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ntp.set_peers 192.168.0.1 172.17.17.1 time.apple.com
salt \(aq*\(aq ntp.set_peers 172.17.17.1 test=True  # only displays the diff
salt \(aq*\(aq ntp.set_peers 192.168.0.1 commit=False  # preserves the changes, but does not commit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_ntp.set_servers(*servers, **options)
Configures a list of NTP servers on the device.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBservers\fP \-\- list of IP Addresses/Domain Names
.IP \(bu 2
\fB(\fP\fBbool\fP\fB)\fP (\fItest\fP) \-\- discard loaded config. By default \fBtest\fP is False
(will not dicard the changes)
.UNINDENT
.TP
.B Commit commit (bool)
commit loaded config. By default \fBcommit\fP is True
(will commit the changes). Useful when the user does not want to commit
after each change, but after a couple.
.UNINDENT
.sp
By default this function will commit the config changes (if any). To load without committing, use the \fIcommit\fP
option. For dry run use the \fItest\fP argument.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ntp.set_servers 192.168.0.1 172.17.17.1 time.apple.com
salt \(aq*\(aq ntp.set_servers 172.17.17.1 test=True  # only displays the diff
salt \(aq*\(aq ntp.set_servers 192.168.0.1 commit=False  # preserves the changes, but does not commit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_ntp.stats(peer=None, **kwargs)
Returns a dictionary containing synchronization details of the NTP peers.
.INDENT 7.0
.TP
.B Parameters
\fBpeer\fP \-\- Returns only the details of a specific NTP peer.
.TP
.B Returns
a list of dictionaries, with the following keys:
.INDENT 7.0
.IP \(bu 2
remote
.IP \(bu 2
referenceid
.IP \(bu 2
synchronized
.IP \(bu 2
stratum
.IP \(bu 2
type
.IP \(bu 2
when
.IP \(bu 2
hostpoll
.IP \(bu 2
reachability
.IP \(bu 2
delay
.IP \(bu 2
offset
.IP \(bu 2
jitter
.UNINDENT

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ntp.stats
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
    {
        \(aqremote\(aq        : \(aq188.114.101.4\(aq,
        \(aqreferenceid\(aq   : \(aq188.114.100.1\(aq,
        \(aqsynchronized\(aq  : True,
        \(aqstratum\(aq       : 4,
        \(aqtype\(aq          : \(aq\-\(aq,
        \(aqwhen\(aq          : \(aq107\(aq,
        \(aqhostpoll\(aq      : 256,
        \(aqreachability\(aq  : 377,
        \(aqdelay\(aq         : 164.228,
        \(aqoffset\(aq        : \-13.866,
        \(aqjitter\(aq        : 2.695
    }
]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.napalm_probes
.SS NAPALM Probes
.sp
Manages RPM/SLA probes on the network device.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP> & Jerome Fleury <\fI\%jf@cloudflare.com\fP>
.TP
.B maturity
new
.TP
.B depends
napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
\fI\%napalm proxy minion\fP
.IP \(bu 2
\fI\%NET basic features\fP
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Probes configuration management state\fP
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.modules.napalm_probes.config(**kwargs)
Returns the configuration of the RPM probes.
.INDENT 7.0
.TP
.B Returns
A dictionary containing the configuration of the RPM/SLA probes.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq probes.config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqprobe1\(aq:{
        \(aqtest1\(aq: {
            \(aqprobe_type\(aq   : \(aqicmp\-ping\(aq,
            \(aqtarget\(aq       : \(aq192.168.0.1\(aq,
            \(aqsource\(aq       : \(aq192.168.0.2\(aq,
            \(aqprobe_count\(aq  : 13,
            \(aqtest_interval\(aq: 3
        },
        \(aqtest2\(aq: {
            \(aqprobe_type\(aq   : \(aqhttp\-ping\(aq,
            \(aqtarget\(aq       : \(aq172.17.17.1\(aq,
            \(aqsource\(aq       : \(aq192.17.17.2\(aq,
            \(aqprobe_count\(aq  : 5,
            \(aqtest_interval\(aq: 60
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_probes.delete_probes(probes, test=False, commit=True, **kwargs)
Removes RPM/SLA probes from the network device.
Calls the configuration template \(aqdelete_probes\(aq from the NAPALM library,
providing as input a rich formatted dictionary with the configuration details of the probes to be removed
from the configuration of the device.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprobes\fP \-\- Dictionary with a similar format as the output dictionary of
the function config(), where the details are not necessary.
.IP \(bu 2
\fBtest\fP \-\- Dry run? If set as True, will apply the config, discard and
return the changes. Default: False
.IP \(bu 2
\fBcommit\fP \-\- Commit? (default: True) Sometimes it is not needed to commit
the config immediately after loading the changes. E.g.: a state loads a
couple of parts (add / remove / update) and would not be optimal to
commit after each operation.  Also, from the CLI when the user needs to
apply the similar changes before committing, can specify commit=False
and will not discard the config.
.UNINDENT
.TP
.B Raises
\fBMergeConfigException\fP \-\- If there is an error on the configuration sent.
.TP
.B Returns
A dictionary having the following keys:
.UNINDENT
.INDENT 7.0
.IP \(bu 2
result (bool): if the config was applied successfully. It is \fIFalse\fP only
in case of failure. In case there are no changes to be applied and
successfully performs all operations it is still \fITrue\fP and so will be
the \fIalready_configured\fP flag (example below)
.IP \(bu 2
comment (str): a message for the user
.IP \(bu 2
already_configured (bool): flag to check if there were no changes applied
.IP \(bu 2
diff (str): returns the config changes applied
.UNINDENT
.sp
Input example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
probes = {
    \(aqexisting_probe\(aq:{
        \(aqexisting_test1\(aq: {},
        \(aqexisting_test2\(aq: {}
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_probes.results(**kwargs)
Provides the results of the measurements of the RPM/SLA probes.
.sp
:return a dictionary with the results of the probes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq probes.results
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqprobe1\(aq:  {
        \(aqtest1\(aq: {
            \(aqlast_test_min_delay\(aq   : 63.120,
            \(aqglobal_test_min_delay\(aq : 62.912,
            \(aqcurrent_test_avg_delay\(aq: 63.190,
            \(aqglobal_test_max_delay\(aq : 177.349,
            \(aqcurrent_test_max_delay\(aq: 63.302,
            \(aqglobal_test_avg_delay\(aq : 63.802,
            \(aqlast_test_avg_delay\(aq   : 63.438,
            \(aqlast_test_max_delay\(aq   : 65.356,
            \(aqprobe_type\(aq            : \(aqicmp\-ping\(aq,
            \(aqrtt\(aq                   : 63.138,
            \(aqlast_test_loss\(aq        : 0,
            \(aqround_trip_jitter\(aq     : \-59.0,
            \(aqtarget\(aq                : \(aq192.168.0.1\(aq,
            \(aqsource\(aq                : \(aq192.168.0.2\(aq,
            \(aqprobe_count\(aq           : 15,
            \(aqcurrent_test_min_delay\(aq: 63.138
        },
        \(aqtest2\(aq: {
            \(aqlast_test_min_delay\(aq   : 176.384,
            \(aqglobal_test_min_delay\(aq : 169.226,
            \(aqcurrent_test_avg_delay\(aq: 177.098,
            \(aqglobal_test_max_delay\(aq : 292.628,
            \(aqcurrent_test_max_delay\(aq: 180.055,
            \(aqglobal_test_avg_delay\(aq : 177.959,
            \(aqlast_test_avg_delay\(aq   : 177.178,
            \(aqlast_test_max_delay\(aq   : 184.671,
            \(aqprobe_type\(aq            : \(aqicmp\-ping\(aq,
            \(aqrtt\(aq                   : 176.449,
            \(aqlast_test_loss\(aq        : 0,
            \(aqround_trip_jitter\(aq     : \-34.0,
            \(aqtarget\(aq                : \(aq172.17.17.1\(aq,
            \(aqsource\(aq                : \(aq172.17.17.2\(aq,
            \(aqprobe_count\(aq           : 15,
            \(aqcurrent_test_min_delay\(aq: 176.402
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_probes.schedule_probes(probes, test=False, commit=True, **kwargs)
Will schedule the probes. On Cisco devices, it is not enough to define the
probes, it is also necessary to schedule them.
.sp
This function calls the configuration template \fBschedule_probes\fP from the
NAPALM library, providing as input a rich formatted dictionary with the
names of the probes and the tests to be scheduled.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprobes\fP \-\- Dictionary with a similar format as the output dictionary of
the function config(), where the details are not necessary.
.IP \(bu 2
\fBtest\fP \-\- Dry run? If set as True, will apply the config, discard and
return the changes. Default: False
.IP \(bu 2
\fBcommit\fP \-\- Commit? (default: True) Sometimes it is not needed to commit
the config immediately after loading the changes. E.g.: a state loads a
couple of parts (add / remove / update) and would not be optimal to
commit after each operation.  Also, from the CLI when the user needs to
apply the similar changes before committing, can specify commit=False
and will not discard the config.
.UNINDENT
.TP
.B Raises
\fBMergeConfigException\fP \-\- If there is an error on the configuration sent.
.TP
.B Returns
a dictionary having the following keys:
.UNINDENT
.INDENT 7.0
.IP \(bu 2
result (bool): if the config was applied successfully. It is \fIFalse\fP only
in case of failure. In case there are no changes to be applied and
successfully performs all operations it is still \fITrue\fP and so will be
the \fIalready_configured\fP flag (example below)
.IP \(bu 2
comment (str): a message for the user
.IP \(bu 2
already_configured (bool): flag to check if there were no changes applied
.IP \(bu 2
diff (str): returns the config changes applied
.UNINDENT
.sp
Input example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
probes = {
    \(aqnew_probe\(aq:{
        \(aqnew_test1\(aq: {},
        \(aqnew_test2\(aq: {}
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_probes.set_probes(probes, test=False, commit=True, **kwargs)
Configures RPM/SLA probes on the device.
Calls the configuration template \(aqset_probes\(aq from the NAPALM library,
providing as input a rich formatted dictionary with the configuration details of the probes to be configured.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprobes\fP \-\- Dictionary formatted as the output of the function config()
.IP \(bu 2
\fBtest\fP \-\- Dry run? If set as True, will apply the config, discard and return the changes. Default: False
.IP \(bu 2
\fBcommit\fP \-\- Commit? (default: True) Sometimes it is not needed to commit
the config immediately after loading the changes. E.g.: a state loads a
couple of parts (add / remove / update) and would not be optimal to
commit after each operation.  Also, from the CLI when the user needs to
apply the similar changes before committing, can specify commit=False
and will not discard the config.
.UNINDENT
.TP
.B Raises
\fBMergeConfigException\fP \-\- If there is an error on the configuration sent.
.TP
.B Return a dictionary having the following keys
.INDENT 7.0
.IP \(bu 2
result (bool): if the config was applied successfully. It is \fIFalse\fP
only in case of failure. In case there are no changes to be applied
and successfully performs all operations it is still \fITrue\fP and so
will be the \fIalready_configured\fP flag (example below)
.IP \(bu 2
comment (str): a message for the user
.IP \(bu 2
already_configured (bool): flag to check if there were no changes applied
.IP \(bu 2
diff (str): returns the config changes applied
.UNINDENT
.UNINDENT
.sp
Input example \- via state/script:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
probes = {
    \(aqnew_probe\(aq:{
        \(aqnew_test1\(aq: {
            \(aqprobe_type\(aq   : \(aqicmp\-ping\(aq,
            \(aqtarget\(aq       : \(aq192.168.0.1\(aq,
            \(aqsource\(aq       : \(aq192.168.0.2\(aq,
            \(aqprobe_count\(aq  : 13,
            \(aqtest_interval\(aq: 3
        },
        \(aqnew_test2\(aq: {
            \(aqprobe_type\(aq   : \(aqhttp\-ping\(aq,
            \(aqtarget\(aq       : \(aq172.17.17.1\(aq,
            \(aqsource\(aq       : \(aq192.17.17.2\(aq,
            \(aqprobe_count\(aq  : 5,
            \(aqtest_interval\(aq: 60
        }
    }
}
set_probes(probes)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example \- to push changes on the fly (not recommended):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqjunos_minion\(aq probes.set_probes \(dq{\(aqnew_probe\(aq:{\(aqnew_test1\(aq:{\(aqprobe_type\(aq:\(aqicmp\-ping\(aq,            \(aqtarget\(aq:\(aq192.168.0.1\(aq,\(aqsource\(aq:\(aq192.168.0.2\(aq,\(aqprobe_count\(aq:13,\(aqtest_interval\(aq:3}}}\(dq test=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output example \- for the CLI example above:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
junos_minion:
    \-\-\-\-\-\-\-\-\-\-
    already_configured:
        False
    comment:
        Configuration discarded.
    diff:
        [edit services rpm]
             probe transit { ... }
        +    probe new_probe {
        +        test new_test1 {
        +            probe\-type icmp\-ping;
        +            target address 192.168.0.1;
        +            probe\-count 13;
        +            test\-interval 3;
        +            source\-address 192.168.0.2;
        +        }
        +    }
    result:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.napalm_route
.SS NAPALM Route
.sp
Retrieves route details from network devices.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP>
.TP
.B maturity
new
.TP
.B depends
napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
\fI\%NAPALM proxy minion\fP
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.modules.napalm_route.show(destination, protocol=None, **kwargs)
Displays all details for a certain route learned via a specific protocol.
If the protocol is not specified, will return all possible routes.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function return the routes from the RIB.
In case the destination prefix is too short,
there may be too many routes matched.
Therefore in cases of devices having a very high number of routes
it may be necessary to adjust the prefix length and request
using a longer prefix.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B destination
destination prefix.
.TP
.B protocol (optional)
protocol used to learn the routes to the destination.
.UNINDENT
.sp
Changed in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqmy_router\(aq route.show 172.16.0.0/25
salt \(aqmy_router\(aq route.show 172.16.0.0/25 bgp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aq172.16.0.0/25\(aq: [
        {
            \(aqprotocol\(aq: \(aqBGP\(aq,
            \(aqlast_active\(aq: True,
            \(aqcurrent_active\(aq: True,
            \(aqage\(aq: 1178693,
            \(aqrouting_table\(aq: \(aqinet.0\(aq,
            \(aqnext_hop\(aq: \(aq192.168.0.11\(aq,
            \(aqoutgoing_interface\(aq: \(aqxe\-1/1/1.100\(aq,
            \(aqpreference\(aq: 170,
            \(aqselected_next_hop\(aq: False,
            \(aqprotocol_attributes\(aq: {
                \(aqremote_as\(aq: 65001,
                \(aqmetric\(aq: 5,
                \(aqlocal_as\(aq: 13335,
                \(aqas_path\(aq: \(aq\(aq,
                \(aqremote_address\(aq: \(aq192.168.0.11\(aq,
                \(aqmetric2\(aq: 0,
                \(aqlocal_preference\(aq: 0,
                \(aqcommunities\(aq: [
                    \(aq0:2\(aq,
                    \(aqno\-export\(aq
                ],
                \(aqpreference2\(aq: \-1
            },
            \(aqinactive_reason\(aq: \(aq\(aq
        },
        {
            \(aqprotocol\(aq: \(aqBGP\(aq,
            \(aqlast_active\(aq: False,
            \(aqcurrent_active\(aq: False,
            \(aqage\(aq: 2359429,
            \(aqrouting_table\(aq: \(aqinet.0\(aq,
            \(aqnext_hop\(aq: \(aq192.168.0.17\(aq,
            \(aqoutgoing_interface\(aq: \(aqxe\-1/1/1.100\(aq,
            \(aqpreference\(aq: 170,
            \(aqselected_next_hop\(aq: True,
            \(aqprotocol_attributes\(aq: {
                \(aqremote_as\(aq: 65001,
                \(aqmetric\(aq: 5,
                \(aqlocal_as\(aq: 13335,
                \(aqas_path\(aq: \(aq\(aq,
                \(aqremote_address\(aq: \(aq192.168.0.17\(aq,
                \(aqmetric2\(aq: 0,
                \(aqlocal_preference\(aq: 0,
                \(aqcommunities\(aq: [
                    \(aq0:3\(aq,
                    \(aqno\-export\(aq
                ],
                \(aqpreference2\(aq: \-1
            },
            \(aqinactive_reason\(aq: \(aqNot Best in its group \- Router ID\(aq
        }
    ]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.napalm_snmp
.SS NAPALM SNMP
.sp
Manages SNMP on network devices.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP>
.TP
.B maturity
new
.TP
.B depends
napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
\fI\%NAPALM proxy minion\fP
.IP \(bu 2
\fI\%NET basic features\fP
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%SNMP configuration management state\fP
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.modules.napalm_snmp.config(**kwargs)
Returns the SNMP configuration
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snmp.config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_snmp.remove_config(chassis_id=None, community=None, contact=None, location=None, test=False, commit=True, **kwargs)
Removes a configuration element from the SNMP configuration.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBchassis_id\fP \-\- (optional) Chassis ID
.IP \(bu 2
\fBcommunity\fP \-\- (optional) A dictionary having the following optional keys:
.UNINDENT
.UNINDENT
.INDENT 7.0
.IP \(bu 2
acl (if any policy / ACL need to be set)
.IP \(bu 2
mode: rw or ro. Default: ro
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontact\fP \-\- Contact details
.IP \(bu 2
\fBlocation\fP \-\- Location
.IP \(bu 2
\fBtest\fP \-\- Dry run? If set as True, will apply the config, discard and return the changes. Default: False
.IP \(bu 2
\fBcommit\fP \-\- Commit? (default: True) Sometimes it is not needed to commit
the config immediately after loading the changes. E.g.: a state loads a
couple of parts (add / remove / update) and would not be optimal to
commit after each operation.  Also, from the CLI when the user needs to
apply the similar changes before committing, can specify commit=False
and will not discard the config.
.UNINDENT
.TP
.B Raises
\fBMergeConfigException\fP \-\- If there is an error on the configuration sent.
.TP
.B Returns
A dictionary having the following keys:
.UNINDENT
.INDENT 7.0
.IP \(bu 2
result (bool): if the config was applied successfully. It is \fIFalse\fP
only in case of failure. In case there are no changes to be applied
and successfully performs all operations it is still \fITrue\fP and so
will be the \fIalready_configured\fP flag (example below)
.IP \(bu 2
comment (str): a message for the user
.IP \(bu 2
already_configured (bool): flag to check if there were no changes applied
.IP \(bu 2
diff (str): returns the config changes applied
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snmp.remove_config community=\(aqabcd\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_snmp.update_config(chassis_id=None, community=None, contact=None, location=None, test=False, commit=True, **kwargs)
Updates the SNMP configuration.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBchassis_id\fP \-\- (optional) Chassis ID
.IP \(bu 2
\fBcommunity\fP \-\- (optional) A dictionary having the following optional keys:
.UNINDENT
.UNINDENT
.INDENT 7.0
.IP \(bu 2
acl (if any policy / ACL need to be set)
.IP \(bu 2
mode: rw or ro. Default: ro
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontact\fP \-\- Contact details
.IP \(bu 2
\fBlocation\fP \-\- Location
.IP \(bu 2
\fBtest\fP \-\- Dry run? If set as True, will apply the config, discard and return the changes. Default: False
.IP \(bu 2
\fBcommit\fP \-\- Commit? (default: True) Sometimes it is not needed to commit the config immediately
after loading the changes. E.g.: a state loads a couple of parts (add / remove / update)
and would not be optimal to commit after each operation.
Also, from the CLI when the user needs to apply the similar changes before committing,
can specify commit=False and will not discard the config.
.UNINDENT
.TP
.B Raises
\fBMergeConfigException\fP \-\- If there is an error on the configuration sent.
.TP
.B Return a dictionary having the following keys
.UNINDENT
.INDENT 7.0
.IP \(bu 2
result (bool): if the config was applied successfully. It is \fIFalse\fP only
in case of failure. In case there are no changes to be applied and
successfully performs all operations it is still \fITrue\fP and so will be
the \fIalready_configured\fP flag (example below)
.IP \(bu 2
comment (str): a message for the user
.IP \(bu 2
already_configured (bool): flag to check if there were no changes applied
.IP \(bu 2
diff (str): returns the config changes applied
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqedge01.lon01\(aq snmp.update_config location=\(dqGreenwich, UK\(dq test=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output example (for the CLI example above):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
edge01.lon01:
    \-\-\-\-\-\-\-\-\-\-
    already_configured:
        False
    comment:
        Configuration discarded.
    diff:
        [edit snmp]
        \-  location \(dqLondon, UK\(dq;
        +  location \(dqGreenwich, UK\(dq;
    result:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.napalm_users
.SS NAPALM Users
.sp
Manages the configuration of the users on network devices.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP>
.TP
.B maturity
new
.TP
.B depends
napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
\fI\%NAPALM proxy minion\fP
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Users management state\fP
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.modules.napalm_users.config(**kwargs)
Returns the configuration of the users on the device
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq users.config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqmircea\(aq: {
        \(aqlevel\(aq: 15,
        \(aqpassword\(aq: \(aq$1$0P70xKPa$4jt5/10cBTckk6I/w/\(aq,
        \(aqsshkeys\(aq: [
            \(aqssh\-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC4pFn+shPwTb2yELO4L7NtQrKOJXNeCl1je                    l9STXVaGnRAnuc2PXl35vnWmcUq6YbUEcgUTRzzXfmelJKuVJTJIlMXii7h2xkbQp0YZIEs4P                    8ipwnRBAxFfk/ZcDsN3mjep4/yjN56ejk345jhk345jk345jk341p3A/9LIL7l6YewLBCwJj6                    D+fWSJ0/YW+7oH17Fk2HH+tw0L5PcWLHkwA4t60iXn16qDbIk/ze6jv2hDGdCdz7oYQeCE55C                    CHOHMJWYfN3jcL4s0qv8/u6Ka1FVkV7iMmro7ChThoV/5snI4Ljf2wKqgHH7TfNaCfpU0WvHA                    nTs8zhOrGScSrtb mircea@master\-roshi\(aq
        ]
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_users.delete_users(users, test=False, commit=True, **kwargs)
Removes users from the configuration of network devices.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBusers\fP \-\- Dictionary formatted as the output of the function config()
.IP \(bu 2
\fBtest\fP \-\- Dry run? If set as True, will apply the config, discard and return the changes. Default: False
.IP \(bu 2
\fBcommit\fP \-\- Commit? (default: True) Sometimes it is not needed to commit the config immediately
after loading the changes. E.g.: a state loads a couple of parts (add / remove / update)
and would not be optimal to commit after each operation.
Also, from the CLI when the user needs to apply the similar changes before committing,
can specify commit=False and will not discard the config.
.UNINDENT
.TP
.B Raises
\fBMergeConfigException\fP \-\- If there is an error on the configuration sent.
.TP
.B Return a dictionary having the following keys
.INDENT 7.0
.IP \(bu 2
result (bool): if the config was applied successfully. It is \fIFalse\fP
only in case of failure. In case there are no changes to be applied
and successfully performs all operations it is still \fITrue\fP and so
will be the \fIalready_configured\fP flag (example below)
.IP \(bu 2
comment (str): a message for the user
.IP \(bu 2
already_configured (bool): flag to check if there were no changes applied
.IP \(bu 2
diff (str): returns the config changes applied
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq users.delete_users \(dq{\(aqmircea\(aq: {}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_users.set_users(users, test=False, commit=True, **kwargs)
Configures users on network devices.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBusers\fP \-\- Dictionary formatted as the output of the function config()
.IP \(bu 2
\fBtest\fP \-\- Dry run? If set as True, will apply the config, discard and
return the changes. Default: False
.IP \(bu 2
\fBcommit\fP \-\- Commit? (default: True) Sometimes it is not needed to commit
the config immediately after loading the changes. E.g.: a state loads a
couple of parts (add / remove / update) and would not be optimal to
commit after each operation.  Also, from the CLI when the user needs to
apply the similar changes before committing, can specify commit=False
and will not discard the config.
.UNINDENT
.TP
.B Raises
\fBMergeConfigException\fP \-\- If there is an error on the configuration sent.
.TP
.B Return a dictionary having the following keys
.UNINDENT
.INDENT 7.0
.IP \(bu 2
result (bool): if the config was applied successfully. It is \fIFalse\fP only
in case of failure. In case there are no changes to be applied and
successfully performs all operations it is still \fITrue\fP and so will be
the \fIalready_configured\fP flag (example below)
.IP \(bu 2
comment (str): a message for the user
.IP \(bu 2
already_configured (bool): flag to check if there were no changes applied
.IP \(bu 2
diff (str): returns the config changes applied
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq users.set_users \(dq{\(aqmircea\(aq: {}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.napalm_yang_mod
.SS NAPALM YANG
.sp
NAPALM YANG basic operations.
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.modules.napalm_yang_mod.compliance_report(data, *models, **kwargs)
Return the compliance report using YANG objects.
.INDENT 7.0
.TP
.B data
Dictionary structured with respect to the models referenced.
.TP
.B models
A list of models to be used when generating the config.
.TP
.B filepath
The absolute path to the validation file.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm_yang.compliance_report {} models.openconfig_interfaces filepath=~/validate.yml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
  \(dqskipped\(dq: [],
  \(dqcomplies\(dq: true,
  \(dqget_interfaces_ip\(dq: {
    \(dqmissing\(dq: [],
    \(dqcomplies\(dq: true,
    \(dqpresent\(dq: {
      \(dqge\-0/0/0.0\(dq: {
        \(dqcomplies\(dq: true,
        \(dqnested\(dq: true
      }
    },
    \(dqextra\(dq: []
  }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_yang_mod.diff(candidate, running, *models)
Returns the difference between two configuration entities structured
according to the YANG model.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function is recommended to be used mostly as a state helper.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B candidate
First model to compare.
.TP
.B running
Second model to compare.
.TP
.B models
A list of models to be used when comparing.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm_yang.diff {} {} models.openconfig_interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqinterfaces\(dq: {
        \(dqinterface\(dq: {
            \(dqboth\(dq: {
                \(dqPort\-Channel1\(dq: {
                    \(dqconfig\(dq: {
                        \(dqmtu\(dq: {
                            \(dqfirst\(dq: \(dq0\(dq,
                            \(dqsecond\(dq: \(dq9000\(dq
                        }
                    }
                }
            },
            \(dqfirst_only\(dq: [
                \(dqLoopback0\(dq
            ],
            \(dqsecond_only\(dq: [
                \(dqLoopback1\(dq
            ]
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_yang_mod.get_config(data, *models, **kwargs)
Return the native config.
.INDENT 7.0
.TP
.B data
Dictionary structured with respect to the models referenced.
.TP
.B models
A list of models to be used when generating the config.
.TP
.B profiles: \fBNone\fP
Use certain profiles to generate the config.
If not specified, will use the platform default profile(s).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm_yang.get_config {} models.openconfig_interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
interface et1
    ip address 192.168.1.1/24
    description Uplink1
    mtu 9000
interface et2
    ip address 192.168.2.1/24
    description Uplink2
    mtu 9000
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_yang_mod.load_config(data, *models, **kwargs)
Generate and load the config on the device using the OpenConfig or IETF
models and device profiles.
.INDENT 7.0
.TP
.B data
Dictionary structured with respect to the models referenced.
.TP
.B models
A list of models to be used when generating the config.
.TP
.B profiles: \fBNone\fP
Use certain profiles to generate the config.
If not specified, will use the platform default profile(s).
.TP
.B test: \fBFalse\fP
Dry run? If set as \fBTrue\fP, will apply the config, discard
and return the changes. Default: \fBFalse\fP and will commit
the changes on the device.
.TP
.B commit: \fBTrue\fP
Commit? Default: \fBTrue\fP\&.
.TP
.B debug: \fBFalse\fP
Debug mode. Will insert a new key under the output dictionary,
as \fBloaded_config\fP containing the raw configuration loaded on the device.
.TP
.B replace: \fBFalse\fP
Should replace the config with the new generate one?
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm_yang.load_config {} models.openconfig_interfaces test=True debug=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
device1:
    \-\-\-\-\-\-\-\-\-\-
    already_configured:
        False
    comment:
    diff:
        [edit interfaces ge\-0/0/0]
        \-   mtu 1400;
        [edit interfaces ge\-0/0/0 unit 0 family inet]
        \-       dhcp;
        [edit interfaces lo0]
        \-    unit 0 {
        \-        description lo0.0;
        \-    }
        +    unit 1 {
        +        description \(dqnew loopback\(dq;
        +    }
    loaded_config:
        <configuration>
          <interfaces replace=\(dqreplace\(dq>
            <interface>
              <name>ge\-0/0/0</name>
              <unit>
                <name>0</name>
                <family>
                  <inet/>
                </family>
                <description>ge\-0/0/0.0</description>
              </unit>
              <description>management interface</description>
            </interface>
            <interface>
              <name>ge\-0/0/1</name>
              <disable/>
              <description>ge\-0/0/1</description>
            </interface>
            <interface>
              <name>ae0</name>
              <unit>
                <name>0</name>
                <vlan\-id>100</vlan\-id>
                <family>
                  <inet>
                    <address>
                      <name>192.168.100.1/24</name>
                    </address>
                    <address>
                      <name>172.20.100.1/24</name>
                    </address>
                  </inet>
                </family>
                <description>a description</description>
              </unit>
              <vlan\-tagging/>
              <unit>
                <name>1</name>
                <vlan\-id>1</vlan\-id>
                <family>
                  <inet>
                    <address>
                      <name>192.168.101.1/24</name>
                    </address>
                  </inet>
                </family>
                <disable/>
                <description>ae0.1</description>
              </unit>
              <vlan\-tagging/>
              <unit>
                <name>2</name>
                <vlan\-id>2</vlan\-id>
                <family>
                  <inet>
                    <address>
                      <name>192.168.102.1/24</name>
                    </address>
                  </inet>
                </family>
                <description>ae0.2</description>
              </unit>
              <vlan\-tagging/>
            </interface>
            <interface>
              <name>lo0</name>
              <unit>
                <name>1</name>
                <description>new loopback</description>
              </unit>
              <description>lo0</description>
            </interface>
          </interfaces>
        </configuration>
    result:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.napalm_yang_mod.parse(*models, **kwargs)
Parse configuration from the device.
.INDENT 7.0
.TP
.B models
A list of models to be used when parsing.
.TP
.B config: \fBFalse\fP
Parse config.
.TP
.B state: \fBFalse\fP
Parse state.
.TP
.B profiles: \fBNone\fP
Use certain profiles to parse. If not specified, will use the device
default profile(s).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm_yang.parse models.openconfig_interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqinterfaces\(dq: {
        \(dqinterface\(dq: {
            \(dq.local.\(dq: {
                \(dqname\(dq: \(dq.local.\(dq,
                \(dqstate\(dq: {
                    \(dqadmin\-status\(dq: \(dqUP\(dq,
                    \(dqcounters\(dq: {
                        \(dqin\-discards\(dq: 0,
                        \(dqin\-errors\(dq: 0,
                        \(dqout\-errors\(dq: 0
                    },
                    \(dqenabled\(dq: True,
                    \(dqifindex\(dq: 0,
                    \(dqlast\-change\(dq: 0,
                    \(dqoper\-status\(dq: \(dqUP\(dq,
                    \(dqtype\(dq: \(dqsoftwareLoopback\(dq
                },
                \(dqsubinterfaces\(dq: {
                    \(dqsubinterface\(dq: {
                        \(dq.local..0\(dq: {
                            \(dqindex\(dq: \(dq.local..0\(dq,
                            \(dqstate\(dq: {
                                \(dqifindex\(dq: 0,
                                \(dqname\(dq: \(dq.local..0\(dq
                            }
                        }
                    }
                }
            },
            \(dqae0\(dq: {
                \(dqname\(dq: \(dqae0\(dq,
                \(dqstate\(dq: {
                    \(dqadmin\-status\(dq: \(dqUP\(dq,
                    \(dqcounters\(dq: {
                        \(dqin\-discards\(dq: 0,
                        \(dqin\-errors\(dq: 0,
                        \(dqout\-errors\(dq: 0
                    },
                    \(dqenabled\(dq: True,
                    \(dqifindex\(dq: 531,
                    \(dqlast\-change\(dq: 255203,
                    \(dqmtu\(dq: 1518,
                    \(dqoper\-status\(dq: \(dqDOWN\(dq
                },
                \(dqsubinterfaces\(dq: {
                    \(dqsubinterface\(dq: {
                        \(dqae0.0\(dq: {
                            \(dqindex\(dq: \(dqae0.0\(dq,
                            \(dqstate\(dq: {
                                \(dqdescription\(dq: \(dqASDASDASD\(dq,
                                \(dqifindex\(dq: 532,
                                \(dqname\(dq: \(dqae0.0\(dq
                            }
                        }
                        \(dqae0.32767\(dq: {
                            \(dqindex\(dq: \(dqae0.32767\(dq,
                            \(dqstate\(dq: {
                                \(dqifindex\(dq: 535,
                                \(dqname\(dq: \(dqae0.32767\(dq
                            }
                        }
                    }
                }
            },
            \(dqdsc\(dq: {
                \(dqname\(dq: \(dqdsc\(dq,
                \(dqstate\(dq: {
                    \(dqadmin\-status\(dq: \(dqUP\(dq,
                    \(dqcounters\(dq: {
                        \(dqin\-discards\(dq: 0,
                        \(dqin\-errors\(dq: 0,
                        \(dqout\-errors\(dq: 0
                    },
                    \(dqenabled\(dq: True,
                    \(dqifindex\(dq: 5,
                    \(dqlast\-change\(dq: 0,
                    \(dqoper\-status\(dq: \(dqUP\(dq
                }
            },
            \(dqge\-0/0/0\(dq: {
                \(dqname\(dq: \(dqge\-0/0/0\(dq,
                \(dqstate\(dq: {
                    \(dqadmin\-status\(dq: \(dqUP\(dq,
                    \(dqcounters\(dq: {
                        \(dqin\-broadcast\-pkts\(dq: 0,
                        \(dqin\-discards\(dq: 0,
                        \(dqin\-errors\(dq: 0,
                        \(dqin\-multicast\-pkts\(dq: 0,
                        \(dqin\-unicast\-pkts\(dq: 16877,
                        \(dqout\-broadcast\-pkts\(dq: 0,
                        \(dqout\-errors\(dq: 0,
                        \(dqout\-multicast\-pkts\(dq: 0,
                        \(dqout\-unicast\-pkts\(dq: 15742
                    },
                    \(dqdescription\(dq: \(dqmanagement interface\(dq,
                    \(dqenabled\(dq: True,
                    \(dqifindex\(dq: 507,
                    \(dqlast\-change\(dq: 258467,
                    \(dqmtu\(dq: 1400,
                    \(dqoper\-status\(dq: \(dqUP\(dq
                },
                \(dqsubinterfaces\(dq: {
                    \(dqsubinterface\(dq: {
                        \(dqge\-0/0/0.0\(dq: {
                            \(dqindex\(dq: \(dqge\-0/0/0.0\(dq,
                            \(dqstate\(dq: {
                                \(dqdescription\(dq: \(dqge\-0/0/0.0\(dq,
                                \(dqifindex\(dq: 521,
                                \(dqname\(dq: \(dqge\-0/0/0.0\(dq
                            }
                        }
                    }
                }
            }
            \(dqirb\(dq: {
                \(dqname\(dq: \(dqirb\(dq,
                \(dqstate\(dq: {
                    \(dqadmin\-status\(dq: \(dqUP\(dq,
                    \(dqcounters\(dq: {
                        \(dqin\-discards\(dq: 0,
                        \(dqin\-errors\(dq: 0,
                        \(dqout\-errors\(dq: 0
                    },
                    \(dqenabled\(dq: True,
                    \(dqifindex\(dq: 502,
                    \(dqlast\-change\(dq: 0,
                    \(dqmtu\(dq: 1514,
                    \(dqoper\-status\(dq: \(dqUP\(dq,
                    \(dqtype\(dq: \(dqethernetCsmacd\(dq
                }
            },
            \(dqlo0\(dq: {
                \(dqname\(dq: \(dqlo0\(dq,
                \(dqstate\(dq: {
                    \(dqadmin\-status\(dq: \(dqUP\(dq,
                    \(dqcounters\(dq: {
                        \(dqin\-discards\(dq: 0,
                        \(dqin\-errors\(dq: 0,
                        \(dqout\-errors\(dq: 0
                    },
                    \(dqdescription\(dq: \(dqlo0\(dq,
                    \(dqenabled\(dq: True,
                    \(dqifindex\(dq: 6,
                    \(dqlast\-change\(dq: 0,
                    \(dqoper\-status\(dq: \(dqUP\(dq,
                    \(dqtype\(dq: \(dqsoftwareLoopback\(dq
                },
                \(dqsubinterfaces\(dq: {
                    \(dqsubinterface\(dq: {
                        \(dqlo0.0\(dq: {
                            \(dqindex\(dq: \(dqlo0.0\(dq,
                            \(dqstate\(dq: {
                                \(dqdescription\(dq: \(dqlo0.0\(dq,
                                \(dqifindex\(dq: 16,
                                \(dqname\(dq: \(dqlo0.0\(dq
                            }
                        },
                        \(dqlo0.16384\(dq: {
                            \(dqindex\(dq: \(dqlo0.16384\(dq,
                            \(dqstate\(dq: {
                                \(dqifindex\(dq: 21,
                                \(dqname\(dq: \(dqlo0.16384\(dq
                            }
                        },
                        \(dqlo0.16385\(dq: {
                            \(dqindex\(dq: \(dqlo0.16385\(dq,
                            \(dqstate\(dq: {
                                \(dqifindex\(dq: 22,
                                \(dqname\(dq: \(dqlo0.16385\(dq
                            }
                        },
                        \(dqlo0.32768\(dq: {
                            \(dqindex\(dq: \(dqlo0.32768\(dq,
                            \(dqstate\(dq: {
                                \(dqifindex\(dq: 248,
                                \(dqname\(dq: \(dqlo0.32768\(dq
                            }
                        }
                    }
                }
            }
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.netaddress
.sp
Module for getting information about network addresses.
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B depends
netaddr
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netaddress.cidr_broadcast(cidr)
Get the broadcast address associated with a CIDR address.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netaddress.cidr_netmask 192.168.0.0/20
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netaddress.cidr_netmask(cidr)
Get the netmask address associated with a CIDR address.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netaddress.cidr_netmask 192.168.0.0/20
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netaddress.list_cidr_ips(cidr)
Get a list of IP addresses from a CIDR.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netaddress.list_cidr_ips 192.168.0.0/20
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netaddress.list_cidr_ips_ipv6(cidr)
Get a list of IPv6 addresses from a CIDR.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netaddress.list_cidr_ips_ipv6 192.168.0.0/20
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.netbox
.SS NetBox
.sp
Module to query NetBox
.INDENT 0.0
.TP
.B codeauthor
Zach Moody <\fI\%zmoody@do.co\fP>
.TP
.B maturity
new
.TP
.B depends
pynetbox
.UNINDENT
.sp
The following config should be in the minion config file. In order to
work with \fBsecrets\fP you should provide a token and path to your
private key file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
netbox:
  url: <NETBOX_URL>
  token: <NETBOX_USERNAME_API_TOKEN (OPTIONAL)>
  keyfile: </PATH/TO/NETBOX/KEY (OPTIONAL)>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B salt.modules.netbox.create_circuit(name, provider_id, circuit_type, description=None)
New in version 2019.2.0.

.sp
Create a new Netbox circuit
.INDENT 7.0
.TP
.B name
Name of the circuit
.TP
.B provider_id
The netbox id of the circuit provider
.TP
.B circuit_type
The name of the circuit type
.TP
.B asn
The ASN of the circuit provider
.TP
.B description
The description of the circuit
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.create_circuit NEW_CIRCUIT_01 Telia Transit 1299 \(dqNew Telia circuit\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.create_circuit_provider(name, asn=None)
New in version 2019.2.0.

.sp
Create a new Netbox circuit provider
.INDENT 7.0
.TP
.B name
The name of the circuit provider
.TP
.B asn
The ASN of the circuit provider
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.create_circuit_provider Telia 1299
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.create_circuit_termination(circuit, interface, device, speed, xconnect_id=None, term_side=\(aqA\(aq)
New in version 2019.2.0.

.sp
Terminate a circuit on an interface
.INDENT 7.0
.TP
.B circuit
The name of the circuit
.TP
.B interface
The name of the interface to terminate on
.TP
.B device
The name of the device the interface belongs to
.TP
.B speed
The speed of the circuit, in Kbps
.TP
.B xconnect_id
The cross\-connect identifier
.TP
.B term_side
The side of the circuit termination
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.create_circuit_termination NEW_CIRCUIT_01 xe\-0/0/1 myminion 10000 xconnect_id=XCON01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.create_circuit_type(name)
New in version 2019.2.0.

.sp
Create a new Netbox circuit type.
.INDENT 7.0
.TP
.B name
The name of the circuit type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.create_circuit_type Transit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.create_device(name, role, model, manufacturer, site)
New in version 2019.2.0.

.sp
Create a new device with a name, role, model, manufacturer and site.
All these components need to be already in Netbox.
.INDENT 7.0
.TP
.B name
The name of the device, e.g., \fBedge_router\fP
.TP
.B role
String of device role, e.g., \fBrouter\fP
.TP
.B model
String of device model, e.g., \fBMX480\fP
.TP
.B manufacturer
String of device manufacturer, e.g., \fBJuniper\fP
.TP
.B site
String of device site, e.g., \fBBRU\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.create_device edge_router router MX480 Juniper BRU
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.create_device_role(role, color)
New in version 2019.2.0.

.sp
Create a device role
.INDENT 7.0
.TP
.B role
String of device role, e.g., \fBrouter\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.create_device_role router
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.create_device_type(model, manufacturer)
New in version 2019.2.0.

.sp
Create a device type. If the manufacturer doesn\(aqt exist, create a new manufacturer.
.INDENT 7.0
.TP
.B model
String of device model, e.g., \fBMX480\fP
.TP
.B manufacturer
String of device manufacturer, e.g., \fBJuniper\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.create_device_type MX480 Juniper
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.create_interface(device_name, interface_name, mac_address=None, description=None, enabled=None, lag=None, lag_parent=None, form_factor=None)
New in version 2019.2.0.

.sp
Attach an interface to a device. If not all arguments are provided,
they will default to Netbox defaults.
.INDENT 7.0
.TP
.B device_name
The name of the device, e.g., \fBedge_router\fP
.TP
.B interface_name
The name of the interface, e.g., \fBTenGigE0/0/0/0\fP
.TP
.B mac_address
String of mac address, e.g., \fB50:87:89:73:92:C8\fP
.TP
.B description
String of interface description, e.g., \fBNTT\fP
.TP
.B enabled
String of boolean interface status, e.g., \fBTrue\fP
.TP
.B lag:
Boolean of interface lag status, e.g., \fBTrue\fP
.TP
.B lag_parent
String of interface lag parent name, e.g., \fBae13\fP
.TP
.B form_factor
Integer of form factor id, obtained through _choices API endpoint, e.g., \fB200\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.create_interface edge_router ae13 description=\(dqCore uplink\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.create_interface_connection(interface_a, interface_b)
New in version 2019.2.0.

.sp
Create an interface connection between 2 interfaces
.INDENT 7.0
.TP
.B interface_a
Interface id for Side A
.TP
.B interface_b
Interface id for Side B
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.create_interface_connection 123 456
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.create_inventory_item(device_name, item_name, manufacturer_name=None, serial=\(aq\(aq, part_id=\(aq\(aq, description=\(aq\(aq)
New in version 2019.2.0.

.sp
Add an inventory item to an existing device.
.INDENT 7.0
.TP
.B device_name
The name of the device, e.g., \fBedge_router\fP\&.
.TP
.B item_name
String of inventory item name, e.g., \fBTransceiver\fP\&.
.TP
.B manufacturer_name
String of inventory item manufacturer, e.g., \fBFiberstore\fP\&.
.TP
.B serial
String of inventory item serial, e.g., \fBFS1238931\fP\&.
.TP
.B part_id
String of inventory item part id, e.g., \fB740\-01234\fP\&.
.TP
.B description
String of inventory item description, e.g., \fBSFP+\-10G\-LR\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.create_inventory_item edge_router Transceiver part_id=740\-01234
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.create_ipaddress(ip_address, family, device=None, interface=None)
New in version 2019.2.0.

.sp
Add an IP address, and optionally attach it to an interface.
.INDENT 7.0
.TP
.B ip_address
The IP address and CIDR, e.g., \fB192.168.1.1/24\fP
.TP
.B family
Integer of IP family, e.g., \fB4\fP
.TP
.B device
The name of the device to attach IP to, e.g., \fBedge_router\fP
.TP
.B interface
The name of the interface to attach IP to, e.g., \fBae13\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.create_ipaddress 192.168.1.1/24 4 device=edge_router interface=ae13
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.create_manufacturer(name)
New in version 2019.2.0.

.sp
Create a device manufacturer.
.INDENT 7.0
.TP
.B name
The name of the manufacturer, e.g., \fBJuniper\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.create_manufacturer Juniper
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.create_platform(platform)
New in version 2019.2.0.

.sp
Create a new device platform
.INDENT 7.0
.TP
.B platform
String of device platform, e.g., \fBjunos\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.create_platform junos
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.create_site(site)
New in version 2019.2.0.

.sp
Create a new device site
.INDENT 7.0
.TP
.B site
String of device site, e.g., \fBBRU\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.create_site BRU
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.delete_interface(device_name, interface_name)
New in version 2019.2.0.

.sp
Delete an interface from a device.
.INDENT 7.0
.TP
.B device_name
The name of the device, e.g., \fBedge_router\fP\&.
.TP
.B interface_name
The name of the interface, e.g., \fBae13\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.delete_interface edge_router ae13
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.delete_inventory_item(item_id)
New in version 2019.2.0.

.sp
Remove an item from a devices inventory. Identified by the netbox id
.INDENT 7.0
.TP
.B item_id
Integer of item to be deleted
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.delete_inventory_item 1354
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.delete_ipaddress(ipaddr_id)
New in version 2019.2.0.

.sp
Delete an IP address. IP addresses in Netbox are a combination of address
and the interface it is assigned to.
.INDENT 7.0
.TP
.B id
The Netbox id for the IP address.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.delete_ipaddress 9002
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.filter_(app, endpoint, **kwargs)
Get a list of items from NetBox.
.INDENT 7.0
.TP
.B app
String of netbox app, e.g., \fBdcim\fP, \fBcircuits\fP, \fBipam\fP
.TP
.B endpoint
String of app endpoint, e.g., \fBsites\fP, \fBregions\fP, \fBdevices\fP
.TP
.B kwargs
Optional arguments that can be used to filter.
All filter keywords are available in Netbox,
which can be found by surfing to the corresponding API endpoint,
and clicking Filters. e.g., \fBrole=router\fP
.UNINDENT
.sp
Returns a list of dictionaries
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.filter dcim devices status=1 role=router
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.get_(app, endpoint, id=None, **kwargs)
Get a single item from NetBox.
.INDENT 7.0
.TP
.B app
String of netbox app, e.g., \fBdcim\fP, \fBcircuits\fP, \fBipam\fP
.TP
.B endpoint
String of app endpoint, e.g., \fBsites\fP, \fBregions\fP, \fBdevices\fP
.UNINDENT
.sp
Returns a single dictionary
.sp
To get an item based on ID.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.get dcim devices id=123
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or using named arguments that correspond with accepted filters on
the NetBox endpoint.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.get dcim devices name=my\-router
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.get_circuit_provider(name, asn=None)
New in version 2019.2.0.

.sp
Get a circuit provider with a given name and optional ASN.
.INDENT 7.0
.TP
.B name
The name of the circuit provider
.TP
.B asn
The ASN of the circuit provider
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.get_circuit_provider Telia 1299
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.get_interfaces(device_name=None, **kwargs)
New in version 2019.2.0.

.sp
Returns interfaces for a specific device using arbitrary netbox filters
.INDENT 7.0
.TP
.B device_name
The name of the device, e.g., \fBedge_router\fP
.TP
.B kwargs
Optional arguments to be used for filtering
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.get_interfaces edge_router name=\(dqet\-0/0/5\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.get_ipaddresses(device_name=None, **kwargs)
New in version 2019.2.0.

.sp
Filters for an IP address using specified filters
.INDENT 7.0
.TP
.B device_name
The name of the device to check for the IP address
.TP
.B kwargs
Optional arguments that can be used to filter, e.g., \fBfamily=4\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.get_ipaddresses device_name family=4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.make_interface_child(device_name, interface_name, parent_name)
New in version 2019.2.0.

.sp
Set an interface as part of a LAG.
.INDENT 7.0
.TP
.B device_name
The name of the device, e.g., \fBedge_router\fP\&.
.TP
.B interface_name
The name of the interface to be attached to LAG, e.g., \fBxe\-1/0/2\fP\&.
.TP
.B parent_name
The name of the LAG interface, e.g., \fBae13\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.make_interface_child xe\-1/0/2 ae13
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.make_interface_lag(device_name, interface_name)
New in version 2019.2.0.

.sp
Update an interface to be a LAG.
.INDENT 7.0
.TP
.B device_name
The name of the device, e.g., \fBedge_router\fP\&.
.TP
.B interface_name
The name of the interface, e.g., \fBae13\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.make_interface_lag edge_router ae13
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.openconfig_interfaces(device_name=None)
New in version 2019.2.0.

.sp
Return a dictionary structured as standardised in the
\fI\%openconfig\-interfaces\fP
YANG model, containing physical and configuration data available in Netbox,
e.g., IP addresses, MTU, enabled / disabled, etc.
.INDENT 7.0
.TP
.B device_name: \fBNone\fP
The name of the device to query the interface data for. If not provided,
will use the Minion ID.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netbox.openconfig_interfaces
salt \(aq*\(aq netbox.openconfig_interfaces device_name=cr1.thn.lon
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.openconfig_lacp(device_name=None)
New in version 2019.2.0.

.sp
Return a dictionary structured as standardised in the
\fI\%openconfig\-lacp\fP
YANG model, with configuration data for Link Aggregation Control Protocol
(LACP) for aggregate interfaces.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fBinterval\fP and \fBlacp_mode\fP keys have the values set as \fBSLOW\fP
and \fBACTIVE\fP respectively, as this data is not currently available
in Netbox, therefore defaulting to the values defined in the standard.
See \fI\%interval\fP
and \fI\%lacp\-mode\fP
for further details.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B device_name: \fBNone\fP
The name of the device to query the LACP information for. If not provided,
will use the Minion ID.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netbox.openconfig_lacp
salt \(aq*\(aq netbox.openconfig_lacp device_name=cr1.thn.lon
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.slugify(value)
\(aq
Slugify given value.
Credit to Djangoproject \fI\%https://docs.djangoproject.com/en/2.0/_modules/django/utils/text/#slugify\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.update_device(name, **kwargs)
New in version 2019.2.0.

.sp
Add attributes to an existing device, identified by name.
.INDENT 7.0
.TP
.B name
The name of the device, e.g., \fBedge_router\fP
.TP
.B kwargs
Arguments to change in device, e.g., \fBserial=JN2932930\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.update_device edge_router serial=JN2932920
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbox.update_interface(device_name, interface_name, **kwargs)
New in version 2019.2.0.

.sp
Update an existing interface with new attributes.
.INDENT 7.0
.TP
.B device_name
The name of the device, e.g., \fBedge_router\fP
.TP
.B interface_name
The name of the interface, e.g., \fBae13\fP
.TP
.B kwargs
Arguments to change in interface, e.g., \fBmac_address=50:87:69:53:32:D0\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion netbox.update_interface edge_router ae13 mac_address=50:87:69:53:32:D0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.netbsd_sysctl
.sp
Module for viewing and modifying sysctl parameters
.INDENT 0.0
.TP
.B salt.modules.netbsd_sysctl.assign(name, value)
Assign a single sysctl parameter for this minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.assign net.inet.icmp.icmplim 50
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsd_sysctl.get(name)
Return a single sysctl parameter for this minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.get hw.physmem
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsd_sysctl.persist(name, value, config=\(aq/etc/sysctl.conf\(aq)
Assign and persist a simple sysctl parameter for this minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.persist net.inet.icmp.icmplim 50
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsd_sysctl.show(config_file=False)
Return a list of sysctl parameters for this minion
.INDENT 7.0
.TP
.B config: Pull the data from the system configuration file
instead of the live data.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.show
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.netbsdservice
.sp
The service module for NetBSD
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage services on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqservice.start\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsdservice.available(name)
Returns \fBTrue\fP if the specified service is available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.available sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsdservice.disable(name, **kwargs)
Disable the named service to start at boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsdservice.disabled(name)
Return True if the named service is enabled, false otherwise
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsdservice.enable(name, **kwargs)
Enable the named service to start at boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsdservice.enabled(name, **kwargs)
Return True if the named service is enabled, false otherwise
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsdservice.force_reload(name)
Force\-reload the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.force_reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsdservice.get_all()
Return all available boot services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsdservice.get_disabled()
Return a set of services that are installed but disabled
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_disabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsdservice.get_enabled()
Return a list of service that are enabled on boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsdservice.missing(name)
The inverse of service.available.
Returns \fBTrue\fP if the specified service is not available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.missing sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsdservice.reload_(name)
Reload the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsdservice.restart(name)
Restart the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsdservice.start(name)
Start the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsdservice.status(name, sig=None)
Return the status for a service.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.sp
Changed in version 2018.3.0: The service name can now be a glob (e.g. \fBsalt*\fP)

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.IP \(bu 2
\fBsig\fP (\fI\%str\fP) \-\- Signature to use to find the service via ps
.UNINDENT
.TP
.B Returns
True if running, False otherwise
dict: Maps service name to True if running, False otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name> [service signature]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netbsdservice.stop(name)
Stop the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.netmiko_mod
.SS Netmiko Execution Module
.sp
New in version 2019.2.0.

.sp
Execution module to interface the connection with a remote network device. It is
flexible enough to execute the commands both when running under a Netmiko Proxy
Minion, as well as running under a Regular Minion by specifying the connection
arguments, i.e., \fBdevice_type\fP, \fBip\fP, \fBusername\fP, \fBpassword\fP etc.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP> & Kirk Byers <\fI\%ktbyers@twb\-tech.com\fP>
.TP
.B maturity
new
.TP
.B depends
netmiko
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.sp
The \fBnetmiko\fP proxy modules requires Netmiko to be installed: \fBpip install netmiko\fP\&.
.SS Usage
.sp
This module can equally be used via the \fI\%netmiko\fP
Proxy module (check documentation), or directly from an arbitrary (Proxy) Minion
that is running on a server (computer) having access to the network device, and
has the \fBnetmiko\fP library installed.
.sp
When running outside of the \fI\%netmiko Proxy\fP (i.e.,
from another Proxy Minion type, or regular Minion), the netmiko connection
arguments can be either specified from the CLI when executing the command, or
in a configuration block under the \fBnetmiko\fP key in the configuration opts
(i.e., (Proxy) Minion configuration file), or Pillar. The module supports these
simultaneously. These fields are the exact same supported by the \fBnetmiko\fP
Proxy Module:
.INDENT 0.0
.IP \(bu 2
\fBdevice_type\fP \- Class selection based on device type. Supported options:
.INDENT 2.0
.IP \(bu 2
\fBa10\fP: A10 Networks
.IP \(bu 2
\fBaccedian\fP: Accedian Networks
.IP \(bu 2
\fBalcatel_aos\fP: Alcatel AOS
.IP \(bu 2
\fBalcatel_sros\fP: Alcatel SROS
.IP \(bu 2
\fBapresia_aeos\fP: Apresia AEOS
.IP \(bu 2
\fBarista_eos\fP: Arista EOS
.IP \(bu 2
\fBaruba_os\fP: Aruba
.IP \(bu 2
\fBavaya_ers\fP: Avaya ERS
.IP \(bu 2
\fBavaya_vsp\fP: Avaya VSP
.IP \(bu 2
\fBbrocade_fastiron\fP: Brocade Fastiron
.IP \(bu 2
\fBbrocade_netiron\fP: Brocade Netiron
.IP \(bu 2
\fBbrocade_nos\fP: Brocade NOS
.IP \(bu 2
\fBbrocade_vdx\fP: Brocade NOS
.IP \(bu 2
\fBbrocade_vyos\fP: VyOS
.IP \(bu 2
\fBcheckpoint_gaia\fP: Check Point GAiA
.IP \(bu 2
\fBcalix_b6\fP: Calix B6
.IP \(bu 2
\fBciena_saos\fP: Ciena SAOS
.IP \(bu 2
\fBcisco_asa\fP: Cisco SA
.IP \(bu 2
\fBcisco_ios\fP: Cisco IOS
.IP \(bu 2
\fBcisco_nxos\fP: Cisco NX\-oS
.IP \(bu 2
\fBcisco_s300\fP: Cisco S300
.IP \(bu 2
\fBcisco_tp\fP: Cisco TpTcCe
.IP \(bu 2
\fBcisco_wlc\fP: Cisco WLC
.IP \(bu 2
\fBcisco_xe\fP: Cisco IOS
.IP \(bu 2
\fBcisco_xr\fP: Cisco XR
.IP \(bu 2
\fBcoriant\fP: Coriant
.IP \(bu 2
\fBdell_force10\fP: Dell Force10
.IP \(bu 2
\fBdell_os10\fP: Dell OS10
.IP \(bu 2
\fBdell_powerconnect\fP: Dell PowerConnect
.IP \(bu 2
\fBeltex\fP: Eltex
.IP \(bu 2
\fBenterasys\fP: Enterasys
.IP \(bu 2
\fBextreme\fP: Extreme
.IP \(bu 2
\fBextreme_wing\fP: Extreme Wing
.IP \(bu 2
\fBf5_ltm\fP: F5 LTM
.IP \(bu 2
\fBfortinet\fP: Fortinet
.IP \(bu 2
\fBgeneric_termserver\fP: TerminalServer
.IP \(bu 2
\fBhp_comware\fP: HP Comware
.IP \(bu 2
\fBhp_procurve\fP: HP Procurve
.IP \(bu 2
\fBhuawei\fP: Huawei
.IP \(bu 2
\fBhuawei_vrpv8\fP: Huawei VRPV8
.IP \(bu 2
\fBjuniper\fP: Juniper Junos
.IP \(bu 2
\fBjuniper_junos\fP: Juniper Junos
.IP \(bu 2
\fBlinux\fP: Linux
.IP \(bu 2
\fBmellanox\fP: Mellanox
.IP \(bu 2
\fBmrv_optiswitch\fP: MrvOptiswitch
.IP \(bu 2
\fBnetapp_cdot\fP: NetAppcDot
.IP \(bu 2
\fBnetscaler\fP: Netscaler
.IP \(bu 2
\fBovs_linux\fP: OvsLinux
.IP \(bu 2
\fBpaloalto_panos\fP: PaloAlto Panos
.IP \(bu 2
\fBpluribus\fP: Pluribus
.IP \(bu 2
\fBquanta_mesh\fP: Quanta Mesh
.IP \(bu 2
\fBruckus_fastiron\fP: Ruckus Fastiron
.IP \(bu 2
\fBubiquiti_edge\fP: Ubiquiti Edge
.IP \(bu 2
\fBubiquiti_edgeswitch\fP: Ubiquiti Edge
.IP \(bu 2
\fBvyatta_vyos\fP: VyOS
.IP \(bu 2
\fBvyos\fP: VyOS
.IP \(bu 2
\fBbrocade_fastiron_telnet\fP: Brocade Fastiron over Telnet
.IP \(bu 2
\fBbrocade_netiron_telnet\fP: Brocade Netiron over Telnet
.IP \(bu 2
\fBcisco_ios_telnet\fP: Cisco IOS over Telnet
.IP \(bu 2
\fBapresia_aeos_telnet\fP: Apresia AEOS over Telnet
.IP \(bu 2
\fBarista_eos_telnet\fP: Arista EOS over Telnet
.IP \(bu 2
\fBhp_procurve_telnet\fP: HP Procurve over Telnet
.IP \(bu 2
\fBhp_comware_telnet\fP: HP Comware over Telnet
.IP \(bu 2
\fBjuniper_junos_telnet\fP: Juniper Junos over Telnet
.IP \(bu 2
\fBcalix_b6_telnet\fP: Calix B6 over Telnet
.IP \(bu 2
\fBdell_powerconnect_telnet\fP: Dell PowerConnect over Telnet
.IP \(bu 2
\fBgeneric_termserver_telnet\fP: TerminalServer over Telnet
.IP \(bu 2
\fBextreme_telnet\fP: Extreme Networks over Telnet
.IP \(bu 2
\fBruckus_fastiron_telnet\fP: Ruckus Fastiron over Telnet
.IP \(bu 2
\fBcisco_ios_serial\fP: Cisco IOS over serial port
.UNINDENT
.IP \(bu 2
\fBip\fP \- IP address of target device (not required if \fBhost\fP is provided)
.IP \(bu 2
\fBhost\fP \- Hostname of target device (not required if \fBip\fP is provided)
.IP \(bu 2
\fBusername\fP \- Username to authenticate against target device, if required
.IP \(bu 2
\fBpassword\fP \- Password to authenticate against target device, if required
.IP \(bu 2
\fBsecret\fP \- The enable password if target device requires one
.IP \(bu 2
\fBport\fP \- The destination port used to connect to the target device
.IP \(bu 2
\fBglobal_delay_factor\fP \- Multiplication factor affecting Netmiko delays
(default: \fB1\fP)
.IP \(bu 2
\fBuse_keys\fP \- Connect to target device using SSH keys (default: \fBFalse\fP)
.IP \(bu 2
\fBkey_file\fP \- Filename path of the SSH key file to use
.IP \(bu 2
\fBallow_agent\fP \- Enable use of SSH key\-agent
.IP \(bu 2
\fBssh_strict\fP \- Automatically reject unknown SSH host keys (default:
\fBFalse\fP, which means unknown SSH host keys will be accepted)
.IP \(bu 2
\fBsystem_host_keys\fP \- Load host keys from the user\(aqs \(dqknown_hosts\(dq file
(default: \fBFalse\fP)
.IP \(bu 2
\fBalt_host_keys\fP \- If \fBTrue\fP,  host keys will be loaded from the file
specified in \fBalt_key_file\fP (default: \fBFalse\fP)
.IP \(bu 2
\fBalt_key_file\fP \- SSH host key file to use (if \fBalt_host_keys=True\fP)
.IP \(bu 2
\fBssh_config_file\fP \- File name of OpenSSH configuration file
.IP \(bu 2
\fBtimeout\fP \- Connection timeout, in seconds (default: \fB90\fP)
.IP \(bu 2
\fBsession_timeout\fP \- Set a timeout for parallel requests, in seconds
(default: \fB60\fP)
.IP \(bu 2
\fBkeepalive\fP \- Send SSH keepalive packets at a specific interval, in
seconds. Currently defaults to \fB0\fP, for backwards compatibility (it will
not attempt to keep the connection alive using the KEEPALIVE packets).
.IP \(bu 2
\fBdefault_enter\fP \- Character(s) to send to correspond to enter key (default:
\fB\en\fP)
.IP \(bu 2
\fBresponse_return\fP \- Character(s) to use in normalized return data to
represent enter key (default: \fB\en\fP)
.UNINDENT
.sp
Example (when not running in a \fBnetmiko\fP Proxy Minion):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
netmiko:
  username: test
  password: test
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In case the \fBusername\fP and \fBpassword\fP are the same on any device you are
targeting, the block above (besides other parameters specific to your
environment you might need) should suffice to be able to execute commands from
outside a \fBnetmiko\fP Proxy, e.g.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netmiko.send_command \(aqshow version\(aq host=router1.example.com device_type=juniper
salt \(aq*\(aq netmiko.send_config https://bit.ly/2sgljCB host=sw2.example.com device_type=cisco_ios
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Remember that the above applies only when not running in a \fBnetmiko\fP Proxy
Minion. If you want to use the \fB<salt.proxy.netmiko_px>\fP, please follow
the documentation notes for a proper setup.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netmiko_mod.call(method, *args, **kwargs)
Invoke an arbitrary Netmiko method.
.INDENT 7.0
.TP
.B method
The name of the Netmiko method to invoke.
.TP
.B args
A list of arguments to send to the method invoked.
.TP
.B kwargs
Key\-value dictionary to send to the method invoked.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netmiko_mod.commit(**kwargs)
Commit the configuration changes.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This function is supported only on the platforms that support the
\fBcommit\fP operation.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netmiko.commit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netmiko_mod.enter_config_mode(**kwargs)
Enter into config mode.
.INDENT 7.0
.TP
.B config_command
Configuration command to send to the device.
.TP
.B pattern
Pattern to terminate reading of channel.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netmiko.enter_config_mode
salt \(aq*\(aq netmiko.enter_config_mode device_type=\(aqjuniper_junos\(aq ip=\(aq192.168.0.1\(aq username=\(aqexample\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netmiko_mod.exit_config_mode(**kwargs)
Exit from configuration mode.
.INDENT 7.0
.TP
.B exit_config
Command to exit configuration mode.
.TP
.B pattern
Pattern to terminate reading of channel.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netmiko.exit_config_mode
salt \(aq*\(aq netmiko.exit_config_mode device_type=\(aqjuniper\(aq ip=\(aq192.168.0.1\(aq username=\(aqexample\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netmiko_mod.get_connection(**kwargs)
Return the Netmiko connection object.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This function returns an unserializable object, hence it is not meant
to be used on the CLI. This should mainly be used when invoked from
other modules for the low level connection with the network device.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B kwargs
Key\-value dictionary with the authentication details.
.UNINDENT
.sp
USAGE Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
conn = __salt__[\(aqnetmiko.get_connection\(aq](host=\(aqrouter1.example.com\(aq,
                                          username=\(aqexample\(aq,
                                          password=\(aqexample\(aq)
show_if = conn.send_command(\(aqshow interfaces\(aq)
conn.disconnect()
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netmiko_mod.multi_call(*methods, **kwargs)
Invoke multiple Netmiko methods at once, and return their output, as list.
.INDENT 7.0
.TP
.B methods
A list of dictionaries with the following keys:
.INDENT 7.0
.IP \(bu 2
\fBname\fP: the name of the Netmiko method to be executed.
.IP \(bu 2
\fBargs\fP: list of arguments to be sent to the Netmiko method.
.IP \(bu 2
\fBkwargs\fP: dictionary of arguments to be sent to the Netmiko method.
.UNINDENT
.TP
.B kwargs
Key\-value dictionary with the connection details (when not running
under a Proxy Minion).
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netmiko_mod.send_command(command_string, **kwargs)
Execute command_string on the SSH channel using a pattern\-based mechanism.
Generally used for show commands. By default this method will keep waiting
to receive data until the network device prompt is detected. The current
network device prompt will be determined automatically.
.INDENT 7.0
.TP
.B command_string
The command to be executed on the remote device.
.TP
.B expect_string
Regular expression pattern to use for determining end of output.
If left blank will default to being based on router prompt.
.TP
.B delay_factor: \fB1\fP
Multiplying factor used to adjust delays (default: \fB1\fP).
.TP
.B max_loops: \fB500\fP
Controls wait time in conjunction with delay_factor. Will default to be
based upon self.timeout.
.TP
.B auto_find_prompt: \fBTrue\fP
Whether it should try to auto\-detect the prompt (default: \fBTrue\fP).
.TP
.B strip_prompt: \fBTrue\fP
Remove the trailing router prompt from the output (default: \fBTrue\fP).
.TP
.B strip_command: \fBTrue\fP
Remove the echo of the command from the output (default: \fBTrue\fP).
.TP
.B normalize: \fBTrue\fP
Ensure the proper enter is sent at end of command (default: \fBTrue\fP).
.TP
.B use_textfsm: \fBFalse\fP
Process command output through TextFSM template (default: \fBFalse\fP).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netmiko.send_command \(aqshow version\(aq
salt \(aq*\(aq netmiko.send_command \(aqshow_version\(aq host=\(aqrouter1.example.com\(aq username=\(aqexample\(aq device_type=\(aqcisco_ios\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netmiko_mod.send_command_timing(command_string, **kwargs)
Execute command_string on the SSH channel using a delay\-based mechanism.
Generally used for show commands.
.INDENT 7.0
.TP
.B command_string
The command to be executed on the remote device.
.TP
.B delay_factor: \fB1\fP
Multiplying factor used to adjust delays (default: \fB1\fP).
.TP
.B max_loops: \fB500\fP
Controls wait time in conjunction with delay_factor. Will default to be
based upon self.timeout.
.TP
.B strip_prompt: \fBTrue\fP
Remove the trailing router prompt from the output (default: \fBTrue\fP).
.TP
.B strip_command: \fBTrue\fP
Remove the echo of the command from the output (default: \fBTrue\fP).
.TP
.B normalize: \fBTrue\fP
Ensure the proper enter is sent at end of command (default: \fBTrue\fP).
.TP
.B use_textfsm: \fBFalse\fP
Process command output through TextFSM template (default: \fBFalse\fP).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netmiko.send_command_timing \(aqshow version\(aq
salt \(aq*\(aq netmiko.send_command_timing \(aqshow version\(aq host=\(aqrouter1.example.com\(aq username=\(aqexample\(aq device_type=\(aqarista_eos\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netmiko_mod.send_config(config_file=None, config_commands=None, template_engine=\(aqjinja\(aq, commit=False, context=None, defaults=None, saltenv=\(aqbase\(aq, **kwargs)
Send configuration commands down the SSH channel.
Return the configuration lines sent to the device.
.sp
The function is flexible to send the configuration from a local or remote
file, or simply the commands as list.
.INDENT 7.0
.TP
.B config_file
The source file with the configuration commands to be sent to the
device.
.sp
The file can also be a template that can be rendered using the template
engine of choice.
.sp
This can be specified using the absolute path to the file, or using one
of the following URL schemes:
.INDENT 7.0
.IP \(bu 2
\fBsalt://\fP, to fetch the file from the Salt fileserver.
.IP \(bu 2
\fBhttp://\fP or \fBhttps://\fP
.IP \(bu 2
\fBftp://\fP
.IP \(bu 2
\fBs3://\fP
.IP \(bu 2
\fBswift://\fP
.UNINDENT
.TP
.B config_commands
Multiple configuration commands to be sent to the device.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument is ignored when \fBconfig_file\fP is specified.
.UNINDENT
.UNINDENT
.TP
.B template_engine: \fBjinja\fP
The template engine to use when rendering the source file. Default:
\fBjinja\fP\&. To simply fetch the file without attempting to render, set
this argument to \fBNone\fP\&.
.TP
.B commit: \fBFalse\fP
Commit the configuration changes before exiting the config mode. This
option is by default disabled, as many platforms don\(aqt have this
capability natively.
.TP
.B context
Variables to add to the template context.
.TP
.B defaults
Default values of the context_dict.
.TP
.B exit_config_mode: \fBTrue\fP
Determines whether or not to exit config mode after complete.
.TP
.B delay_factor: \fB1\fP
Factor to adjust delays.
.TP
.B max_loops: \fB150\fP
Controls wait time in conjunction with delay_factor (default: \fB150\fP).
.TP
.B strip_prompt: \fBFalse\fP
Determines whether or not to strip the prompt (default: \fBFalse\fP).
.TP
.B strip_command: \fBFalse\fP
Determines whether or not to strip the command (default: \fBFalse\fP).
.TP
.B config_mode_command
The command to enter into config mode.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netmiko.send_config config_commands=\(dq[\(aqinterface GigabitEthernet3\(aq, \(aqno ip address\(aq]\(dq
salt \(aq*\(aq netmiko.send_config config_commands=\(dq[\(aqsnmp\-server location {{ grains.location }}\(aq]\(dq
salt \(aq*\(aq netmiko.send_config config_file=salt://config.txt
salt \(aq*\(aq netmiko.send_config config_file=https://bit.ly/2sgljCB device_type=\(aqcisco_ios\(aq ip=\(aq1.2.3.4\(aq username=\(aqexample\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.netscaler
.sp
Module to provide Citrix Netscaler compatibility to Salt (compatible with netscaler 9.2+)
.sp
New in version 2015.2.0.

.INDENT 0.0
.TP
.B depends
.UNINDENT
.INDENT 0.0
.IP \(bu 2
nsnitro Python module
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
You can install nsnitro using:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install nsnitro
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B configuration
This module accepts connection configuration details either as
parameters, or as configuration settings in /etc/salt/minion on the relevant
minions
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
netscaler.host: 1.2.3.4
netscaler.user: user
netscaler.pass: password
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This data can also be passed into pillar. Options passed into opts will
overwrite options passed into pillar.
.UNINDENT
.sp
CLI Examples:
.INDENT 0.0
.INDENT 3.5
Calls relying on configuration passed using /etc/salt/minion, grains, or pillars:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call netscaler.server_exists server_name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Calls passing configuration as opts
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call netscaler.server_exists server_name netscaler_host=1.2.3.4 netscaler_user=username netscaler_pass=password
salt\-call netscaler.server_exists server_name netscaler_host=1.2.3.5 netscaler_user=username2 netscaler_pass=password2
salt\-call netscaler.server_enable server_name2 netscaler_host=1.2.3.5
salt\-call netscaler.server_up server_name3 netscaler_host=1.2.3.6 netscaler_useSSL=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.server_add(s_name, s_ip, s_state=None, **connection_args)
Add a server
Note: The default server state is ENABLED
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.server_add \(aqserverName\(aq \(aqserverIpAddress\(aq
salt \(aq*\(aq netscaler.server_add \(aqserverName\(aq \(aqserverIpAddress\(aq \(aqserverState\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.server_delete(s_name, **connection_args)
Delete a server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.server_delete \(aqserverName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.server_disable(s_name, **connection_args)
Disable a server globally
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.server_disable \(aqserverName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.server_enable(s_name, **connection_args)
Enables a server globally
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.server_enable \(aqserverName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.server_enabled(s_name, **connection_args)
Check if a server is enabled globally
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.server_enabled \(aqserverName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.server_exists(s_name, ip=None, s_state=None, **connection_args)
Checks if a server exists
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.server_exists \(aqserverName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.server_update(s_name, s_ip, **connection_args)
Update a server\(aqs attributes
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.server_update \(aqserverName\(aq \(aqserverIP\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.service_disable(s_name, s_delay=None, **connection_args)
Disable a service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.service_disable \(aqserviceName\(aq
salt \(aq*\(aq netscaler.service_disable \(aqserviceName\(aq \(aqdelayInSeconds\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.service_enable(s_name, **connection_args)
Enable a service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.service_enable \(aqserviceName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.service_exists(s_name, **connection_args)
Checks if a service exists
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.service_exists \(aqserviceName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.service_up(s_name, **connection_args)
Checks if a service is UP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.service_up \(aqserviceName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.servicegroup_add(sg_name, sg_type=\(aqHTTP\(aq, **connection_args)
Add a new service group
If no service type is specified, HTTP will be used.
Most common service types: HTTP, SSL, and SSL_BRIDGE
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.servicegroup_add \(aqserviceGroupName\(aq
salt \(aq*\(aq netscaler.servicegroup_add \(aqserviceGroupName\(aq \(aqserviceGroupType\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.servicegroup_delete(sg_name, **connection_args)
Delete a new service group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.servicegroup_delete \(aqserviceGroupName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.servicegroup_exists(sg_name, sg_type=None, **connection_args)
Checks if a service group exists
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.servicegroup_exists \(aqserviceGroupName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.servicegroup_server_add(sg_name, s_name, s_port, **connection_args)
Add a server:port member to a servicegroup
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.servicegroup_server_add \(aqserviceGroupName\(aq \(aqserverName\(aq \(aqserverPort\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.servicegroup_server_delete(sg_name, s_name, s_port, **connection_args)
Remove a server:port member from a servicegroup
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.servicegroup_server_delete \(aqserviceGroupName\(aq \(aqserverName\(aq \(aqserverPort\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.servicegroup_server_disable(sg_name, s_name, s_port, **connection_args)
Disable a server:port member of a servicegroup
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.servicegroup_server_disable \(aqserviceGroupName\(aq \(aqserverName\(aq \(aqserverPort\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.servicegroup_server_enable(sg_name, s_name, s_port, **connection_args)
Enable a server:port member of a servicegroup
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.servicegroup_server_enable \(aqserviceGroupName\(aq \(aqserverName\(aq \(aqserverPort\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.servicegroup_server_exists(sg_name, s_name, s_port=None, **connection_args)
Check if a server:port combination is a member of a servicegroup
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.servicegroup_server_exists \(aqserviceGroupName\(aq \(aqserverName\(aq \(aqserverPort\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.servicegroup_server_up(sg_name, s_name, s_port, **connection_args)
Check if a server:port combination is in state UP in a servicegroup
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.servicegroup_server_up \(aqserviceGroupName\(aq \(aqserverName\(aq \(aqserverPort\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.vserver_add(v_name, v_ip, v_port, v_type, **connection_args)
Add a new lb vserver
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.vserver_add \(aqvserverName\(aq \(aqvserverIP\(aq \(aqvserverPort\(aq \(aqvserverType\(aq
salt \(aq*\(aq netscaler.vserver_add \(aqalex.patate.chaude.443\(aq \(aq1.2.3.4\(aq \(aq443\(aq \(aqSSL\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.vserver_delete(v_name, **connection_args)
Delete a lb vserver
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.vserver_delete \(aqvserverName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.vserver_exists(v_name, v_ip=None, v_port=None, v_type=None, **connection_args)
Checks if a vserver exists
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.vserver_exists \(aqvserverName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.vserver_servicegroup_add(v_name, sg_name, **connection_args)
Bind a servicegroup to a vserver
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.vserver_servicegroup_add \(aqvserverName\(aq \(aqserviceGroupName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.vserver_servicegroup_delete(v_name, sg_name, **connection_args)
Unbind a servicegroup from a vserver
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.vserver_servicegroup_delete \(aqvserverName\(aq \(aqserviceGroupName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.vserver_servicegroup_exists(v_name, sg_name, **connection_args)
Checks if a servicegroup is tied to a vserver
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.vserver_servicegroup_exists \(aqvserverName\(aq \(aqserviceGroupName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.vserver_sslcert_add(v_name, sc_name, **connection_args)
Binds a SSL certificate to a vserver
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.vserver_sslcert_add \(aqvserverName\(aq \(aqsslCertificateName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.vserver_sslcert_delete(v_name, sc_name, **connection_args)
Unbinds a SSL certificate from a vserver
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.vserver_sslcert_delete \(aqvserverName\(aq \(aqsslCertificateName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.netscaler.vserver_sslcert_exists(v_name, sc_name, **connection_args)
Checks if a SSL certificate is tied to a vserver
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq netscaler.vserver_sslcert_exists \(aqvserverName\(aq \(aqsslCertificateName\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.network
.sp
Module for gathering and managing network information
.INDENT 0.0
.TP
.B salt.modules.network.active_tcp()
Return a dict containing information on all of the running TCP connections (currently linux and solaris only)
.sp
Changed in version 2015.8.4: Added support for SunOS

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.active_tcp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.arp()
Return the arp table from the minion
.sp
Changed in version 2015.8.0: Added support for SunOS

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.arp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.calc_net(ip_addr, netmask=None)
Returns the CIDR of a subnet based on
an IP address (CIDR notation supported)
and optional netmask.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.calc_net 172.17.0.5 255.255.255.240
salt \(aq*\(aq network.calc_net 2a02:f6e:a000:80:84d8:8332:7866:4e07/64
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.connect(host, port=None, **kwargs)
Test connectivity to a host using a particular
port from the minion.
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.connect archlinux.org 80

salt \(aq*\(aq network.connect archlinux.org 80 timeout=3

salt \(aq*\(aq network.connect archlinux.org 80 timeout=3 family=ipv4

salt \(aq*\(aq network.connect google\-public\-dns\-a.google.com port=53 proto=udp timeout=3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.convert_cidr(cidr)
returns the network address, subnet mask and broadcast address of a cidr address
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.convert_cidr 172.31.0.0/16
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.default_route(family=None)
Return default route(s) from routing table
.sp
Changed in version 2015.8.0: Added support for SunOS (Solaris 10, Illumos, SmartOS)

.sp
Changed in version 2016.11.4: Added support for AIX

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.default_route
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.dig(host)
Performs a DNS lookup with dig
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.dig archlinux.org
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.fqdns()
Return all known FQDNs for the system by enumerating all interfaces and
then trying to reverse resolve them (excluding \(aqlo\(aq interface).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.fqdns
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.get_bufsize(iface)
Return network buffer sizes as a dict (currently linux only)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.get_bufsize eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.get_fqdn()
Get fully qualified domain name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.get_fqdn
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.get_hostname()
Get hostname
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.get_hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.get_route(ip)
Return routing information for given destination ip
.sp
New in version 2015.5.3.

.sp
Changed in version 2015.8.0: Added support for SunOS (Solaris 10, Illumos, SmartOS)
Added support for OpenBSD

.sp
Changed in version 2016.11.4: Added support for AIX

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.get_route 10.10.10.10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.hw_addr(iface)
Return the hardware address (a.k.a. MAC address) for a given interface
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.hw_addr eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.hwaddr(iface)
This function is an alias of \fBhw_addr\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the hardware address (a.k.a. MAC address) for a given interface
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.hw_addr eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.ifacestartswith(cidr)
Retrieve the interface name from a specific CIDR
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ifacestartswith 10.0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.in_subnet(cidr)
Returns True if host is within specified subnet, otherwise False.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.in_subnet 10.0.0.0/16
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.interface(iface)
Return the inet address for a given interface
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.interface eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.interface_ip(iface)
Return the inet address for a given interface
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.interface_ip eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.interfaces()
Return a dictionary of information about all the interfaces on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.ip_addrs(interface=None, include_loopback=False, cidr=None, type=None)
Returns a list of IPv4 addresses assigned to the host. 127.0.0.1 is
ignored, unless \(aqinclude_loopback=True\(aq is indicated. If \(aqinterface\(aq is
provided, then only IP addresses from that interface will be returned.
Providing a CIDR via \(aqcidr=\(dq10.0.0.0/8\(dq\(aq will return only the addresses
which are within that subnet. If \(aqtype\(aq is \(aqpublic\(aq, then only public
addresses will be returned. Ditto for \(aqtype\(aq=\(aqprivate\(aq.
.sp
Changed in version 3001: \fBinterface\fP can now be a single interface name or a list of
interfaces. Globbing is also supported.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ip_addrs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.ip_addrs6(interface=None, include_loopback=False, cidr=None)
Returns a list of IPv6 addresses assigned to the host. ::1 is ignored,
unless \(aqinclude_loopback=True\(aq is indicated. If \(aqinterface\(aq is provided,
then only IP addresses from that interface will be returned.
Providing a CIDR via \(aqcidr=\(dq2000::/3\(dq\(aq will return only the addresses
which are within that subnet.
.sp
Changed in version 3001: \fBinterface\fP can now be a single interface name or a list of
interfaces. Globbing is also supported.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ip_addrs6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.ip_in_subnet(ip_addr, cidr)
Returns True if given IP is within specified subnet, otherwise False.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ip_in_subnet 172.17.0.4 172.16.0.0/12
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.ip_neighs()
Return the ip neighbour (arp) table from the minion for IPv4 addresses
.sp
New in version 3007.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ip_neighs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.ip_neighs6()
Return the ip neighbour (arp) table from the minion for IPv6 addresses
.sp
New in version 3007.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ip_neighs6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.ip_networks(interface=None, include_loopback=False, verbose=False)
New in version 3001.

.sp
Returns a list of IPv4 networks to which the minion belongs.
.INDENT 7.0
.TP
.B interface
Restrict results to the specified interface(s). This value can be
either a single interface name or a list of interfaces. Globbing is
also supported.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ip_networks
salt \(aq*\(aq network.ip_networks interface=docker0
salt \(aq*\(aq network.ip_networks interface=docker0,enp*
salt \(aq*\(aq network.ip_networks interface=eth*
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.ip_networks6(interface=None, include_loopback=False, verbose=False)
New in version 3001.

.sp
Returns a list of IPv6 networks to which the minion belongs.
.INDENT 7.0
.TP
.B interface
Restrict results to the specified interface(s). This value can be
either a single interface name or a list of interfaces. Globbing is
also supported.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ip_networks6
salt \(aq*\(aq network.ip_networks6 interface=docker0
salt \(aq*\(aq network.ip_networks6 interface=docker0,enp*
salt \(aq*\(aq network.ip_networks6 interface=eth*
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.ipaddrs(interface=None, include_loopback=False, cidr=None, type=None)
This function is an alias of \fBip_addrs\fP\&.
.INDENT 7.0
.INDENT 3.5
Returns a list of IPv4 addresses assigned to the host. 127.0.0.1 is
ignored, unless \(aqinclude_loopback=True\(aq is indicated. If \(aqinterface\(aq is
provided, then only IP addresses from that interface will be returned.
Providing a CIDR via \(aqcidr=\(dq10.0.0.0/8\(dq\(aq will return only the addresses
which are within that subnet. If \(aqtype\(aq is \(aqpublic\(aq, then only public
addresses will be returned. Ditto for \(aqtype\(aq=\(aqprivate\(aq.
.sp
Changed in version 3001: \fBinterface\fP can now be a single interface name or a list of
interfaces. Globbing is also supported.

.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ip_addrs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.ipaddrs6(interface=None, include_loopback=False, cidr=None)
This function is an alias of \fBip_addrs6\fP\&.
.INDENT 7.0
.INDENT 3.5
Returns a list of IPv6 addresses assigned to the host. ::1 is ignored,
unless \(aqinclude_loopback=True\(aq is indicated. If \(aqinterface\(aq is provided,
then only IP addresses from that interface will be returned.
Providing a CIDR via \(aqcidr=\(dq2000::/3\(dq\(aq will return only the addresses
which are within that subnet.
.sp
Changed in version 3001: \fBinterface\fP can now be a single interface name or a list of
interfaces. Globbing is also supported.

.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ip_addrs6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.iphexval(ip)
Retrieve the hexadecimal representation of an IP address
.sp
New in version 2016.11.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.iphexval 10.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.ipneighs()
This function is an alias of \fBip_neighs\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the ip neighbour (arp) table from the minion for IPv4 addresses
.sp
New in version 3007.0.

.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ip_neighs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.ipneighs6()
This function is an alias of \fBip_neighs6\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the ip neighbour (arp) table from the minion for IPv6 addresses
.sp
New in version 3007.0.

.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ip_neighs6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.is_loopback(ip_addr)
Check if the given IP address is a loopback address
.sp
New in version 2014.7.0.

.sp
Changed in version 2015.8.0: IPv6 support

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.is_loopback 127.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.is_private(ip_addr)
Check if the given IP address is a private address
.sp
New in version 2014.7.0.

.sp
Changed in version 2015.8.0: IPv6 support

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.is_private 10.0.0.3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.mod_bufsize(iface, *args, **kwargs)
Modify network interface buffers (currently linux only)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.mod_bufsize tx=<val> rx=<val> rx\-mini=<val> rx\-jumbo=<val>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.mod_hostname(hostname)
Modify hostname
.sp
Changed in version 2015.8.0: Added support for SunOS (Solaris 10, Illumos, SmartOS)

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.mod_hostname master.saltstack.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.netstat()
Return information on open ports and states
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On BSD minions, the output contains PID info (where available) for each
netstat entry, fetched from sockstat/fstat output.
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.1.4: Added support for OpenBSD, FreeBSD, and NetBSD

.sp
Changed in version 2015.8.0: Added support for SunOS

.sp
Changed in version 2016.11.4: Added support for AIX

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.netstat
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.ping(host, timeout=False, return_boolean=False)
Performs an ICMP ping to a host
.sp
Changed in version 2015.8.0: Added support for SunOS

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ping archlinux.org
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.5.0.

.sp
Return a True or False instead of ping output.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ping archlinux.org return_boolean=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Set the time to wait for a response in seconds.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ping archlinux.org timeout=3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.reverse_ip(ip_addr)
Returns the reversed IP address
.sp
Changed in version 2015.8.0: IPv6 support

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.reverse_ip 172.17.0.4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.routes(family=None)
Return currently configured routes from routing table
.sp
Changed in version 2015.8.0: Added support for SunOS (Solaris 10, Illumos, SmartOS)

.sp
Changed in version 2016.11.4: Added support for AIX

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.routes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.subnets(interfaces=None)
Returns a list of IPv4 subnets to which the host belongs
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.subnets
salt \(aq*\(aq network.subnets interfaces=eth1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.subnets6()
Returns a list of IPv6 subnets to which the host belongs
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.subnets
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.traceroute(host)
Performs a traceroute to a 3rd party host
.sp
Changed in version 2015.8.0: Added support for SunOS

.sp
Changed in version 2016.11.4: Added support for AIX

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.traceroute archlinux.org
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.network.wol(mac, bcast=\(aq255.255.255.255\(aq, destport=9)
Send Wake On Lan packet to a host
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.wol 08\-00\-27\-13\-69\-77
salt \(aq*\(aq network.wol 080027136977 255.255.255.255 7
salt \(aq*\(aq network.wol 08:00:27:13:69:77 255.255.255.255 7
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.neutron
.sp
Module for handling OpenStack Neutron calls
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
neutronclient Python module
.UNINDENT
.TP
.B configuration
This module is not usable until the user, password, tenant, and
auth URL are specified either in a pillar or in the minion\(aqs config file.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
keystone.user: \(aqadmin\(aq
keystone.password: \(aqpassword\(aq
keystone.tenant: \(aqadmin\(aq
keystone.auth_url: \(aqhttp://127.0.0.1:5000/v2.0/\(aq
keystone.region_name: \(aqRegionOne\(aq
keystone.service_type: \(aqnetwork\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If configuration for multiple OpenStack accounts is required, they can be
set up as different configuration profiles:
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
openstack1:
  keystone.user: \(aqadmin\(aq
  keystone.password: \(aqpassword\(aq
  keystone.tenant: \(aqadmin\(aq
  keystone.auth_url: \(aqhttp://127.0.0.1:5000/v2.0/\(aq
  keystone.region_name: \(aqRegionOne\(aq
  keystone.service_type: \(aqnetwork\(aq

openstack2:
  keystone.user: \(aqadmin\(aq
  keystone.password: \(aqpassword\(aq
  keystone.tenant: \(aqadmin\(aq
  keystone.auth_url: \(aqhttp://127.0.0.2:5000/v2.0/\(aq
  keystone.region_name: \(aqRegionOne\(aq
  keystone.service_type: \(aqnetwork\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With this configuration in place, any of the neutron functions
can make use of a configuration profile by declaring it explicitly.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.network_list profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use keystoneauth1 instead of keystoneclient, include the \fIuse_keystoneauth\fP
option in the pillar or minion config.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
this is required to use keystone v3 as for authentication.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
keystone.user: admin
keystone.password: verybadpass
keystone.tenant: admin
keystone.auth_url: \(aqhttp://127.0.0.1:5000/v3/\(aq
keystone.region_name: \(aqRegionOne\(aq
keystone.service_type: \(aqnetwork\(aq
keystone.use_keystoneauth: true
keystone.verify: \(aq/path/to/custom/certs/ca\-bundle.crt\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note: by default the neutron module will attempt to verify its connection
utilizing the system certificates. If you need to verify against another bundle
of CA certificates or want to skip verification altogether you will need to
specify the \fIverify\fP option. You can specify True or False to verify (or not)
against system certificates, a path to a bundle or CA certs to check against, or
None to allow keystoneauth to search for the certificates on its own.(defaults to True)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.add_gateway_router(router, ext_network, profile=None)
Adds an external network gateway to the specified router
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.add_gateway_router router\-name ext\-network\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrouter\fP \-\- ID or name of the router
.IP \(bu 2
\fBext_network\fP \-\- ID or name of the external network the gateway
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Added Gateway router information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.add_interface_router(router, subnet, profile=None)
Adds an internal network interface to the specified router
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.add_interface_router router\-name subnet\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrouter\fP \-\- ID or name of the router
.IP \(bu 2
\fBsubnet\fP \-\- ID or name of the subnet
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Added interface information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.create_firewall_rule(protocol, action, profile=None, **kwargs)
Creates a new firewall rule
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.create_firewall_rule protocol action
        tenant_id=TENANT_ID name=NAME description=DESCRIPTION ip_version=IP_VERSION
        source_ip_address=SOURCE_IP_ADDRESS destination_ip_address=DESTINATION_IP_ADDRESS source_port=SOURCE_PORT
        destination_port=DESTINATION_PORT shared=SHARED enabled=ENABLED
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprotocol\fP \-\- Protocol for the firewall rule, choose \(dqtcp\(dq,\(dqudp\(dq,\(dqicmp\(dq or \(dqNone\(dq.
.IP \(bu 2
\fBaction\fP \-\- Action for the firewall rule, choose \(dqallow\(dq or \(dqdeny\(dq.
.IP \(bu 2
\fBtenant_id\fP \-\- The owner tenant ID. (Optional)
.IP \(bu 2
\fBname\fP \-\- Name for the firewall rule. (Optional)
.IP \(bu 2
\fBdescription\fP \-\- Description for the firewall rule. (Optional)
.IP \(bu 2
\fBip_version\fP \-\- IP protocol version, default: 4. (Optional)
.IP \(bu 2
\fBsource_ip_address\fP \-\- Source IP address or subnet. (Optional)
.IP \(bu 2
\fBdestination_ip_address\fP \-\- Destination IP address or subnet. (Optional)
.IP \(bu 2
\fBsource_port\fP \-\- Source port (integer in [1, 65535] or range in a:b). (Optional)
.IP \(bu 2
\fBdestination_port\fP \-\- Destination port (integer in [1, 65535] or range in a:b). (Optional)
.IP \(bu 2
\fBshared\fP \-\- Set shared to True, default: False. (Optional)
.IP \(bu 2
\fBenabled\fP \-\- To enable this rule, default: True. (Optional)
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.create_floatingip(floating_network, port=None, profile=None)
Creates a new floatingIP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.create_floatingip network\-name port\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfloating_network\fP \-\- Network name or ID to allocate floatingIP from
.IP \(bu 2
\fBport\fP \-\- Of the port to be associated with the floatingIP (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Created floatingIP information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.create_ikepolicy(name, profile=None, **kwargs)
Creates a new IKEPolicy
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.create_ikepolicy ikepolicy\-name
        phase1_negotiation_mode=main auth_algorithm=sha1
        encryption_algorithm=aes\-128 pfs=group5
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Name of the IKE policy
.IP \(bu 2
\fBphase1_negotiation_mode\fP \-\- IKE Phase1 negotiation mode in lowercase,
default: main (Optional)
.IP \(bu 2
\fBauth_algorithm\fP \-\- Authentication algorithm in lowercase,
default: sha1 (Optional)
.IP \(bu 2
\fBencryption_algorithm\fP \-\- Encryption algorithm in lowercase.
default:aes\-128 (Optional)
.IP \(bu 2
\fBpfs\fP \-\- Prefect Forward Security in lowercase,
default: group5 (Optional)
.IP \(bu 2
\fBunits\fP \-\- IKE lifetime attribute. default: seconds (Optional)
.IP \(bu 2
\fBvalue\fP \-\- IKE lifetime attribute. default: 3600 (Optional)
.IP \(bu 2
\fBike_version\fP \-\- IKE version in lowercase, default: v1 (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.IP \(bu 2
\fBkwargs\fP \-\-
.UNINDENT
.TP
.B Returns
Created IKE policy information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.create_ipsec_site_connection(name, ipsecpolicy, ikepolicy, vpnservice, peer_cidrs, peer_address, peer_id, psk, admin_state_up=True, profile=None, **kwargs)
Creates a new IPsecSiteConnection
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_ipsec_site_connection connection\-name
        ipsec\-policy\-name ikepolicy\-name vpnservice\-name
        192.168.XXX.XXX/24 192.168.XXX.XXX 192.168.XXX.XXX secret
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Set friendly name for the connection
.IP \(bu 2
\fBipsecpolicy\fP \-\- IPSec policy ID or name associated with this connection
.IP \(bu 2
\fBikepolicy\fP \-\- IKE policy ID or name associated with this connection
.IP \(bu 2
\fBvpnservice\fP \-\- VPN service instance ID or name associated with
this connection
.IP \(bu 2
\fBpeer_cidrs\fP \-\- Remote subnet(s) in CIDR format
.IP \(bu 2
\fBpeer_address\fP \-\- Peer gateway public IPv4/IPv6 address or FQDN
.IP \(bu 2
\fBpeer_id\fP \-\- Peer router identity for authentication
Can be IPv4/IPv6 address, e\-mail address, key id, or FQDN
.IP \(bu 2
\fBpsk\fP \-\- Pre\-shared key string
.IP \(bu 2
\fBinitiator\fP \-\- Initiator state in lowercase, default:bi\-directional
.IP \(bu 2
\fBadmin_state_up\fP \-\- Set admin state up to true or false,
default: True (Optional)
.IP \(bu 2
\fBmtu\fP \-\- size for the connection, default:1500 (Optional)
.IP \(bu 2
\fBdpd_action\fP \-\- Dead Peer Detection attribute: hold/clear/disabled/
restart/restart\-by\-peer (Optional)
.IP \(bu 2
\fBdpd_interval\fP \-\- Dead Peer Detection attribute (Optional)
.IP \(bu 2
\fBdpd_timeout\fP \-\- Dead Peer Detection attribute (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Created IPSec site connection information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.create_ipsecpolicy(name, profile=None, **kwargs)
Creates a new IPsecPolicy
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.create_ipsecpolicy ipsecpolicy\-name
        transform_protocol=esp auth_algorithm=sha1
        encapsulation_mode=tunnel encryption_algorithm=aes\-128
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Name of the IPSec policy
.IP \(bu 2
\fBtransform_protocol\fP \-\- Transform protocol in lowercase,
default: esp (Optional)
.IP \(bu 2
\fBauth_algorithm\fP \-\- Authentication algorithm in lowercase,
default: sha1 (Optional)
.IP \(bu 2
\fBencapsulation_mode\fP \-\- Encapsulation mode in lowercase,
default: tunnel (Optional)
.IP \(bu 2
\fBencryption_algorithm\fP \-\- Encryption algorithm in lowercase,
default:aes\-128 (Optional)
.IP \(bu 2
\fBpfs\fP \-\- Prefect Forward Security in lowercase,
default: group5 (Optional)
.IP \(bu 2
\fBunits\fP \-\- IPSec lifetime attribute. default: seconds (Optional)
.IP \(bu 2
\fBvalue\fP \-\- IPSec lifetime attribute. default: 3600 (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Created IPSec policy information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.create_network(name, router_ext=None, admin_state_up=True, network_type=None, physical_network=None, segmentation_id=None, shared=None, profile=None)
Creates a new network
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.create_network network\-name
salt \(aq*\(aq neutron.create_network network\-name profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Name of network to create
.IP \(bu 2
\fBadmin_state_up\fP \-\- should the state of the network be up?
default: True (Optional)
.IP \(bu 2
\fBrouter_ext\fP \-\- True then if create the external network (Optional)
.IP \(bu 2
\fBnetwork_type\fP \-\- the Type of network that the provider is such as GRE, VXLAN, VLAN, FLAT, or LOCAL (Optional)
.IP \(bu 2
\fBphysical_network\fP \-\- the name of the physical network as neutron knows it (Optional)
.IP \(bu 2
\fBsegmentation_id\fP \-\- the vlan id or GRE id (Optional)
.IP \(bu 2
\fBshared\fP \-\- is the network shared or not (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Created network information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.create_port(name, network, device_id=None, admin_state_up=True, profile=None)
Creates a new port
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.create_port network\-name port\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Name of port to create
.IP \(bu 2
\fBnetwork\fP \-\- Network name or ID
.IP \(bu 2
\fBdevice_id\fP \-\- ID of device (Optional)
.IP \(bu 2
\fBadmin_state_up\fP \-\- Set admin state up to true or false,
default: true (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Created port information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.create_router(name, ext_network=None, admin_state_up=True, profile=None)
Creates a new router
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.create_router new\-router\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Name of router to create (must be first)
.IP \(bu 2
\fBext_network\fP \-\- ID or name of the external for the gateway (Optional)
.IP \(bu 2
\fBadmin_state_up\fP \-\- Set admin state up to true or false,
default:true (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Created router information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.create_security_group(name=None, description=None, profile=None)
Creates a new security group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.create_security_group security\-group\-name                 description=\(aqSecurity group for servers\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Name of security group (Optional)
.IP \(bu 2
\fBdescription\fP \-\- Description of security group (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Created security group information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.create_security_group_rule(security_group, remote_group_id=None, direction=\(aqingress\(aq, protocol=None, port_range_min=None, port_range_max=None, ethertype=\(aqIPv4\(aq, profile=None)
Creates a new security group rule
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_security_group_rule security\-group\-rule\-id
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsecurity_group\fP \-\- Security group name or ID to add rule
.IP \(bu 2
\fBremote_group_id\fP \-\- Remote security group name or ID to
apply rule (Optional)
.IP \(bu 2
\fBdirection\fP \-\- Direction of traffic: ingress/egress,
default: ingress (Optional)
.IP \(bu 2
\fBprotocol\fP \-\- Protocol of packet: null/icmp/tcp/udp,
default: null (Optional)
.IP \(bu 2
\fBport_range_min\fP \-\- Starting port range (Optional)
.IP \(bu 2
\fBport_range_max\fP \-\- Ending port range (Optional)
.IP \(bu 2
\fBethertype\fP \-\- IPv4/IPv6, default: IPv4 (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Created security group rule information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.create_subnet(network, cidr, name=None, ip_version=4, profile=None)
Creates a new subnet
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.create_subnet network\-name 192.168.1.0/24
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnetwork\fP \-\- Network ID or name this subnet belongs to
.IP \(bu 2
\fBcidr\fP \-\- CIDR of subnet to create (Ex. \(aq192.168.1.0/24\(aq)
.IP \(bu 2
\fBname\fP \-\- Name of the subnet to create (Optional)
.IP \(bu 2
\fBip_version\fP \-\- Version to use, default is 4(IPv4) (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Created subnet information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.create_vpnservice(subnet, router, name, admin_state_up=True, profile=None)
Creates a new VPN service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.create_vpnservice router\-name name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsubnet\fP \-\- Subnet unique identifier for the VPN service deployment
.IP \(bu 2
\fBrouter\fP \-\- Router unique identifier for the VPN service
.IP \(bu 2
\fBname\fP \-\- Set a name for the VPN service
.IP \(bu 2
\fBadmin_state_up\fP \-\- Set admin state up to true or false,
default:True (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Created VPN service information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.delete_firewall_rule(firewall_rule, profile=None)
Deletes the specified firewall_rule
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.delete_firewall_rule firewall\-rule
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfirewall_rule\fP \-\- ID or name of firewall rule to delete
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
True(Succeed) or False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.delete_floatingip(floatingip_id, profile=None)
Deletes the specified floating IP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.delete_floatingip floatingip\-id
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfloatingip_id\fP \-\- ID of floatingIP to delete
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
True(Succeed) or False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.delete_ikepolicy(ikepolicy, profile=None)
Deletes the specified IKEPolicy
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.delete_ikepolicy ikepolicy\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBikepolicy\fP \-\- ID or name of IKE policy to delete
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
True(Succeed) or False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.delete_ipsec_site_connection(ipsec_site_connection, profile=None)
Deletes the specified IPsecSiteConnection
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.delete_ipsec_site_connection connection\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBipsec_site_connection\fP \-\- ID or name of ipsec site connection to delete
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
True(Succeed) or False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.delete_ipsecpolicy(ipsecpolicy, profile=None)
Deletes the specified IPsecPolicy
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.delete_ipsecpolicy ipsecpolicy\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBipsecpolicy\fP \-\- ID or name of IPSec policy to delete
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
True(Succeed) or False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.delete_network(network, profile=None)
Deletes the specified network
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.delete_network network\-name
salt \(aq*\(aq neutron.delete_network network\-name profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnetwork\fP \-\- ID or name of network to delete
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
True(Succeed) or False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.delete_port(port, profile=None)
Deletes the specified port
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.delete_network port\-name
salt \(aq*\(aq neutron.delete_network port\-name profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBport\fP \-\- port name or ID
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
True(Succeed) or False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.delete_quota(tenant_id, profile=None)
Delete the specified tenant\(aqs quota value
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.update_quota tenant\-id
salt \(aq*\(aq neutron.update_quota tenant\-id profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtenant_id\fP \-\- ID of tenant to quota delete
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
True(Delete succeed) or False(Delete failed)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.delete_router(router, profile=None)
Delete the specified router
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.delete_router router\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrouter\fP \-\- ID or name of router to delete
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
True(Succeed) or False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.delete_security_group(security_group, profile=None)
Deletes the specified security group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.delete_security_group security\-group\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsecurity_group\fP \-\- ID or name of security group to delete
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
True(Succeed) or False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.delete_security_group_rule(security_group_rule_id, profile=None)
Deletes the specified security group rule
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.delete_security_group_rule security\-group\-rule\-id
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsecurity_group_rule_id\fP \-\- ID of security group rule to delete
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
True(Succeed) or False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.delete_subnet(subnet, profile=None)
Deletes the specified subnet
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.delete_subnet subnet\-name
salt \(aq*\(aq neutron.delete_subnet subnet\-name profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsubnet\fP \-\- ID or name of subnet to delete
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
True(Succeed) or False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.delete_vpnservice(vpnservice, profile=None)
Deletes the specified VPN service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.delete_vpnservice vpnservice\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvpnservice\fP \-\- ID or name of vpn service to delete
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
True(Succeed) or False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.get_quotas_tenant(profile=None)
Fetches tenant info in server\(aqs context for following quota operation
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.get_quotas_tenant
salt \(aq*\(aq neutron.get_quotas_tenant profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
Quotas information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_agents(profile=None)
List agents.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_agents
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
agents message.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_extensions(profile=None)
Fetches a list of all extensions on server side
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_extensions
salt \(aq*\(aq neutron.list_extensions profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
List of extensions
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_firewall_rules(profile=None)
Fetches a list of all firewall rules for a tenant
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_firewall_rules
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
List of firewall rules
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_firewalls(profile=None)
Fetches a list of all firewalls for a tenant
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_firewalls
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
List of firewalls
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_floatingips(profile=None)
Fetch a list of all floatingIPs for a tenant
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_floatingips
salt \(aq*\(aq neutron.list_floatingips profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
List of floatingIP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_ikepolicies(profile=None)
Fetches a list of all configured IKEPolicies for a tenant
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_ikepolicies
salt \(aq*\(aq neutron.list_ikepolicies profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
List of IKE policy
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_ipsec_site_connections(profile=None)
Fetches all configured IPsec Site Connections for a tenant
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_ipsec_site_connections
salt \(aq*\(aq neutron.list_ipsec_site_connections profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
List of IPSec site connection
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_ipsecpolicies(profile=None)
Fetches a list of all configured IPsecPolicies for a tenant
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_ipsecpolicies ipsecpolicy\-name
salt \(aq*\(aq neutron.list_ipsecpolicies ipsecpolicy\-name profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
List of IPSec policy
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_l3_agent_hosting_routers(router, profile=None)
List L3 agents hosting a router.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_l3_agent_hosting_routers router
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
:param router:router name or ID to query.
:param profile: Profile to build on (Optional)
:return: L3 agents message.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_networks(profile=None)
Fetches a list of all networks for a tenant
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_networks
salt \(aq*\(aq neutron.list_networks profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
List of network
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_ports(profile=None)
Fetches a list of all networks for a tenant
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_ports
salt \(aq*\(aq neutron.list_ports profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
List of port
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_quotas(profile=None)
Fetches all tenants quotas
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_quotas
salt \(aq*\(aq neutron.list_quotas profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
List of quotas
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_routers(profile=None)
Fetches a list of all routers for a tenant
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_routers
salt \(aq*\(aq neutron.list_routers profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
List of router
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_security_group_rules(profile=None)
Fetches a list of all security group rules for a tenant
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_security_group_rules
salt \(aq*\(aq neutron.list_security_group_rules profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
List of security group rule
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_security_groups(profile=None)
Fetches a list of all security groups for a tenant
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_security_groups
salt \(aq*\(aq neutron.list_security_groups profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
List of security group
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_subnets(profile=None)
Fetches a list of all networks for a tenant
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_subnets
salt \(aq*\(aq neutron.list_subnets profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP \-\- Profile to build on (Optional)
.TP
.B Returns
List of subnet
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.list_vpnservices(retrieve_all=True, profile=None, **kwargs)
Fetches a list of all configured VPN services for a tenant
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.list_vpnservices
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBretrieve_all\fP \-\- True or False, default: True (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
List of VPN service
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.remove_gateway_router(router, profile=None)
Removes an external network gateway from the specified router
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.remove_gateway_router router\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrouter\fP \-\- ID or name of router
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
True(Succeed) or False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.remove_interface_router(router, subnet, profile=None)
Removes an internal network interface from the specified router
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.remove_interface_router router\-name subnet\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrouter\fP \-\- ID or name of the router
.IP \(bu 2
\fBsubnet\fP \-\- ID or name of the subnet
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
True(Succeed) or False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.show_firewall(firewall, profile=None)
Fetches information of a specific firewall rule
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_firewall firewall
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfirewall\fP \-\- ID or name of firewall to look up
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
firewall information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.show_firewall_rule(firewall_rule, profile=None)
Fetches information of a specific firewall rule
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_firewall_rule firewall\-rule\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBipsecpolicy\fP \-\- ID or name of firewall rule to look up
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
firewall rule information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.show_floatingip(floatingip_id, profile=None)
Fetches information of a certain floatingIP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_floatingip floatingip\-id
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfloatingip_id\fP \-\- ID of floatingIP to look up
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Floating IP information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.show_ikepolicy(ikepolicy, profile=None)
Fetches information of a specific IKEPolicy
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_ikepolicy ikepolicy\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBikepolicy\fP \-\- ID or name of ikepolicy to look up
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
IKE policy information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.show_ipsec_site_connection(ipsec_site_connection, profile=None)
Fetches information of a specific IPsecSiteConnection
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_ipsec_site_connection connection\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBipsec_site_connection\fP \-\- ID or name of ipsec site connection
to look up
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
IPSec site connection information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.show_ipsecpolicy(ipsecpolicy, profile=None)
Fetches information of a specific IPsecPolicy
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_ipsecpolicy ipsecpolicy\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBipsecpolicy\fP \-\- ID or name of IPSec policy to look up
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
IPSec policy information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.show_network(network, profile=None)
Fetches information of a certain network
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_network network\-name
salt \(aq*\(aq neutron.show_network network\-name profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnetwork\fP \-\- ID or name of network to look up
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Network information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.show_port(port, profile=None)
Fetches information of a certain port
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_port port\-id
salt \(aq*\(aq neutron.show_port port\-id profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBport\fP \-\- ID or name of port to look up
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Port information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.show_quota(tenant_id, profile=None)
Fetches information of a certain tenant\(aqs quotas
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_quota tenant\-id
salt \(aq*\(aq neutron.show_quota tenant\-id profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtenant_id\fP \-\- ID of tenant
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Quota information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.show_router(router, profile=None)
Fetches information of a certain router
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_router router\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrouter\fP \-\- ID or name of router to look up
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Router information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.show_security_group(security_group, profile=None)
Fetches information of a certain security group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_security_group security\-group\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsecurity_group\fP \-\- ID or name of security group to look up
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Security group information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.show_security_group_rule(security_group_rule_id, profile=None)
Fetches information of a certain security group rule
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_security_group_rule security\-group\-rule\-id
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsecurity_group_rule_id\fP \-\- ID of security group rule to look up
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Security group rule information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.show_subnet(subnet, profile=None)
Fetches information of a certain subnet
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_subnet subnet\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsubnet\fP \-\- ID or name of subnet to look up
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Subnet information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.show_vpnservice(vpnservice, profile=None, **kwargs)
Fetches information of a specific VPN service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.show_vpnservice vpnservice\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvpnservice\fP \-\- ID or name of vpn service to look up
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
VPN service information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.update_firewall_rule(firewall_rule, protocol=None, action=None, name=None, description=None, ip_version=None, source_ip_address=None, destination_ip_address=None, source_port=None, destination_port=None, shared=None, enabled=None, profile=None)
Update a firewall rule
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.update_firewall_rule firewall_rule protocol=PROTOCOL action=ACTION
        name=NAME description=DESCRIPTION ip_version=IP_VERSION
        source_ip_address=SOURCE_IP_ADDRESS destination_ip_address=DESTINATION_IP_ADDRESS
        source_port=SOURCE_PORT destination_port=DESTINATION_PORT shared=SHARED enabled=ENABLED
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfirewall_rule\fP \-\- ID or name of firewall rule to update.
.IP \(bu 2
\fBprotocol\fP \-\- Protocol for the firewall rule, choose \(dqtcp\(dq,\(dqudp\(dq,\(dqicmp\(dq or \(dqNone\(dq. (Optional)
.IP \(bu 2
\fBaction\fP \-\- Action for the firewall rule, choose \(dqallow\(dq or \(dqdeny\(dq. (Optional)
.IP \(bu 2
\fBname\fP \-\- Name for the firewall rule. (Optional)
.IP \(bu 2
\fBdescription\fP \-\- Description for the firewall rule. (Optional)
.IP \(bu 2
\fBip_version\fP \-\- IP protocol version, default: 4. (Optional)
.IP \(bu 2
\fBsource_ip_address\fP \-\- Source IP address or subnet. (Optional)
.IP \(bu 2
\fBdestination_ip_address\fP \-\- Destination IP address or subnet. (Optional)
.IP \(bu 2
\fBsource_port\fP \-\- Source port (integer in [1, 65535] or range in a:b). (Optional)
.IP \(bu 2
\fBdestination_port\fP \-\- Destination port (integer in [1, 65535] or range in a:b). (Optional)
.IP \(bu 2
\fBshared\fP \-\- Set shared to True, default: False. (Optional)
.IP \(bu 2
\fBenabled\fP \-\- To enable this rule, default: True. (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.update_floatingip(floatingip_id, port=None, profile=None)
Updates a floatingIP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.update_floatingip network\-name port\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfloatingip_id\fP \-\- ID of floatingIP
.IP \(bu 2
\fBport\fP \-\- ID or name of port, to associate floatingip to \fINone\fP or do
not specify to disassociate the floatingip (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Value of updated floating IP information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.update_network(network, name, profile=None)
Updates a network
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.update_network network\-name new\-network\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnetwork\fP \-\- ID or name of network to update
.IP \(bu 2
\fBname\fP \-\- Name of this network
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Value of updated network information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.update_port(port, name, admin_state_up=True, profile=None)
Updates a port
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.update_port port\-name network\-name new\-port\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBport\fP \-\- Port name or ID
.IP \(bu 2
\fBname\fP \-\- Name of this port
.IP \(bu 2
\fBadmin_state_up\fP \-\- Set admin state up to true or false,
default: true (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Value of updated port information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.update_quota(tenant_id, subnet=None, router=None, network=None, floatingip=None, port=None, security_group=None, security_group_rule=None, profile=None)
Update a tenant\(aqs quota
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.update_quota tenant\-id subnet=40 router=50
                            network=10 floatingip=30 port=30
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtenant_id\fP \-\- ID of tenant
.IP \(bu 2
\fBsubnet\fP \-\- Value of subnet quota (Optional)
.IP \(bu 2
\fBrouter\fP \-\- Value of router quota (Optional)
.IP \(bu 2
\fBnetwork\fP \-\- Value of network quota (Optional)
.IP \(bu 2
\fBfloatingip\fP \-\- Value of floatingip quota (Optional)
.IP \(bu 2
\fBport\fP \-\- Value of port quota (Optional)
.IP \(bu 2
\fBsecurity_group\fP \-\- Value of security group (Optional)
.IP \(bu 2
\fBsecurity_group_rule\fP \-\- Value of security group rule (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Value of updated quota
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.update_router(router, name=None, admin_state_up=None, profile=None, **kwargs)
Updates a router
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.update_router router_id name=new\-router\-name
        admin_state_up=True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrouter\fP \-\- ID or name of router to update
.IP \(bu 2
\fBname\fP \-\- Name of this router
.IP \(bu 2
\fBext_network\fP \-\- ID or name of the external for the gateway (Optional)
.IP \(bu 2
\fBadmin_state_up\fP \-\- Set admin state up to true or false,
default: true (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.IP \(bu 2
\fBkwargs\fP \-\-
.UNINDENT
.TP
.B Returns
Value of updated router information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.update_security_group(security_group, name=None, description=None, profile=None)
Updates a security group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.update_security_group security\-group\-name                 new\-security\-group\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsecurity_group\fP \-\- ID or name of security group to update
.IP \(bu 2
\fBname\fP \-\- Name of this security group (Optional)
.IP \(bu 2
\fBdescription\fP \-\- Description of security group (Optional)
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Value of updated security group information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.update_subnet(subnet, name, profile=None)
Updates a subnet
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.update_subnet subnet\-name new\-subnet\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsubnet\fP \-\- ID or name of subnet to update
.IP \(bu 2
\fBname\fP \-\- Name of this subnet
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Value of updated subnet information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutron.update_vpnservice(vpnservice, desc, profile=None)
Updates a VPN service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutron.update_vpnservice vpnservice\-name desc=\(aqVPN Service1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvpnservice\fP \-\- ID or name of vpn service to update
.IP \(bu 2
\fBdesc\fP \-\- Set a description for the VPN service
.IP \(bu 2
\fBprofile\fP \-\- Profile to build on (Optional)
.UNINDENT
.TP
.B Returns
Value of updated VPN service information
.UNINDENT
.UNINDENT
.SS salt.modules.neutronng
.sp
Neutron module for interacting with OpenStack Neutron
.sp
New in version 2018.3.0.

.sp
:depends:shade
.sp
Example configuration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
neutron:
  cloud: default
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
neutron:
  auth:
    username: admin
    password: password123
    user_domain_name: mydomain
    project_name: myproject
    project_domain_name: myproject
    auth_url: https://example.org:5000/v3
  identity_api_version: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.compare_changes(obj, **kwargs)
Compare two dicts returning only keys that exist in the first dict and are
different in the second one
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.get_openstack_cloud(auth=None)
Return an openstack_cloud
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.get_operator_cloud(auth=None)
Return an operator_cloud
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.list_networks(auth=None, **kwargs)
List networks
.INDENT 7.0
.TP
.B filters
A Python dictionary of filter conditions to push down
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutronng.list_networks
salt \(aq*\(aq neutronng.list_networks           filters=\(aq{\(dqtenant_id\(dq: \(dq1dcac318a83b4610b7a7f7ba01465548\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.list_subnets(auth=None, **kwargs)
List subnets
.INDENT 7.0
.TP
.B filters
A Python dictionary of filter conditions to push down
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutronng.list_subnets
salt \(aq*\(aq neutronng.list_subnets           filters=\(aq{\(dqtenant_id\(dq: \(dq1dcac318a83b4610b7a7f7ba01465548\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.network_create(auth=None, **kwargs)
Create a network
.INDENT 7.0
.TP
.B name
Name of the network being created
.TP
.B shared
False
If \fBTrue\fP, set the network as shared
.TP
.B admin_state_up
True
If \fBTrue\fP, Set the network administrative state to \(dqup\(dq
.TP
.B external
False
Control whether or not this network is externally accessible
.TP
.B provider
An optional Python dictionary of network provider options
.TP
.B project_id
The project ID on which this network will be created
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutronng.network_create name=network2           shared=True admin_state_up=True external=True

salt \(aq*\(aq neutronng.network_create name=network3           provider=\(aq{\(dqnetwork_type\(dq: \(dqvlan\(dq,                     \(dqsegmentation_id\(dq: \(dq4010\(dq,                     \(dqphysical_network\(dq: \(dqprovider\(dq}\(aq           project_id=1dcac318a83b4610b7a7f7ba01465548
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.network_delete(auth=None, **kwargs)
Delete a network
.INDENT 7.0
.TP
.B name_or_id
Name or ID of the network being deleted
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutronng.network_delete name_or_id=network1
salt \(aq*\(aq neutronng.network_delete name_or_id=1dcac318a83b4610b7a7f7ba01465548
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.network_get(auth=None, **kwargs)
Get a single network
.INDENT 7.0
.TP
.B filters
A Python dictionary of filter conditions to push down
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutronng.network_get name=XLB4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.security_group_create(auth=None, **kwargs)
Create a security group. Use security_group_get to create default.
.INDENT 7.0
.TP
.B project_id
The project ID on which this security group will be created
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutronng.security_group_create name=secgroup1           description=\(dqVery secure security group\(dq
salt \(aq*\(aq neutronng.security_group_create name=secgroup1           description=\(dqVery secure security group\(dq           project_id=1dcac318a83b4610b7a7f7ba01465548
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.security_group_delete(auth=None, **kwargs)
Delete a security group
.INDENT 7.0
.TP
.B name_or_id
The name or unique ID of the security group
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutronng.security_group_delete name_or_id=secgroup1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.security_group_get(auth=None, **kwargs)
Get a single security group. This will create a default security group
if one does not exist yet for a particular project id.
.INDENT 7.0
.TP
.B filters
A Python dictionary of filter conditions to push down
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutronng.security_group_get           name=1dcac318a83b4610b7a7f7ba01465548

salt \(aq*\(aq neutronng.security_group_get           name=default          filters=\(aq{\(dqtenant_id\(dq:\(dq2e778bb64ca64a199eb526b5958d8710\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.security_group_rule_create(auth=None, **kwargs)
Create a rule in a security group
.INDENT 7.0
.TP
.B secgroup_name_or_id
The security group name or ID to associate with this security group
rule. If a non\-unique group name is given, an exception is raised.
.TP
.B port_range_min
The minimum port number in the range that is matched by the security
group rule. If the protocol is TCP or UDP, this value must be less than
or equal to the port_range_max attribute value. If nova is used by the
cloud provider for security groups, then a value of None will be
transformed to \-1.
.TP
.B port_range_max
The maximum port number in the range that is matched by the security
group rule. The port_range_min attribute constrains the port_range_max
attribute. If nova is used by the cloud provider for security groups,
then a value of None will be transformed to \-1.
.TP
.B protocol
The protocol that is matched by the security group rule.  Valid values
are \fBNone\fP, \fBtcp\fP, \fBudp\fP, and \fBicmp\fP\&.
.TP
.B remote_ip_prefix
The remote IP prefix to be associated with this security group rule.
This attribute matches the specified IP prefix as the source IP address
of the IP packet.
.TP
.B remote_group_id
The remote group ID to be associated with this security group rule
.TP
.B direction
Either \fBingress\fP or \fBegress\fP; the direction in which the security
group rule is applied. For a compute instance, an ingress security
group rule is applied to incoming (ingress) traffic for that instance.
An egress rule is applied to traffic leaving the instance
.TP
.B ethertype
Must be IPv4 or IPv6, and addresses represented in CIDR must match the
ingress or egress rules
.TP
.B project_id
Specify the project ID this security group will be created on
(admin\-only)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutronng.security_group_rule_create          secgroup_name_or_id=secgroup1

salt \(aq*\(aq neutronng.security_group_rule_create          secgroup_name_or_id=secgroup2 port_range_min=8080          port_range_max=8080 direction=\(aqegress\(aq

salt \(aq*\(aq neutronng.security_group_rule_create          secgroup_name_or_id=c0e1d1ce\-7296\-405e\-919d\-1c08217be529          protocol=icmp project_id=1dcac318a83b4610b7a7f7ba01465548
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.security_group_rule_delete(auth=None, **kwargs)
Delete a security group
.INDENT 7.0
.TP
.B name_or_id
The unique ID of the security group rule
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutronng.security_group_rule_delete name_or_id=1dcac318a83b4610b7a7f7ba01465548
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.security_group_update(secgroup=None, auth=None, **kwargs)
Update a security group
.INDENT 7.0
.TP
.B secgroup
Name, ID or Raw Object of the security group to update
.TP
.B name
New name for the security group
.TP
.B description
New description for the security group
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutronng.security_group_update secgroup=secgroup1           description=\(dqVery secure security group\(dq
salt \(aq*\(aq neutronng.security_group_update secgroup=secgroup1           description=\(dqVery secure security group\(dq           project_id=1dcac318a83b4610b7a7f7ba01465548
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.setup_clouds(auth=None)
Call functions to create Shade cloud objects in __context__ to take
advantage of Shade\(aqs in\-memory caching across several states
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.subnet_create(auth=None, **kwargs)
Create a subnet
.INDENT 7.0
.TP
.B network_name_or_id
The unique name or ID of the attached network. If a non\-unique name is
supplied, an exception is raised.
.TP
.B cidr
The CIDR
.TP
.B ip_version
The IP version, which is 4 or 6.
.TP
.B enable_dhcp
False
Set to \fBTrue\fP if DHCP is enabled and \fBFalse\fP if disabled
.TP
.B subnet_name
The name of the subnet
.TP
.B tenant_id
The ID of the tenant who owns the network. Only administrative users
can specify a tenant ID other than their own.
.TP
.B allocation_pools
A list of dictionaries of the start and end addresses for the
allocation pools.
.TP
.B gateway_ip
The gateway IP address. When you specify both \fBallocation_pools\fP and
\fBgateway_ip\fP, you must ensure that the gateway IP does not overlap
with the specified allocation pools.
.TP
.B disable_gateway_ip
False
Set to \fBTrue\fP if gateway IP address is disabled and \fBFalse\fP if
enabled. It is not allowed with \fBgateway_ip\fP\&.
.TP
.B dns_nameservers
A list of DNS name servers for the subnet
.TP
.B host_routes
A list of host route dictionaries for the subnet
.TP
.B ipv6_ra_mode
IPv6 Router Advertisement mode. Valid values are \fBdhcpv6\-stateful\fP,
\fBdhcpv6\-stateless\fP, or \fBslaac\fP\&.
.TP
.B ipv6_address_mode
IPv6 address mode. Valid values are \fBdhcpv6\-stateful\fP,
\fBdhcpv6\-stateless\fP, or \fBslaac\fP\&.
.TP
.B use_default_subnetpool
If \fBTrue\fP, use the default subnetpool for \fBip_version\fP to obtain a
CIDR. It is required to pass \fBNone\fP to the \fBcidr\fP argument when
enabling this option.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutronng.subnet_create network_name_or_id=network1
  subnet_name=subnet1

salt \(aq*\(aq neutronng.subnet_create subnet_name=subnet2          network_name_or_id=network2 enable_dhcp=True           allocation_pools=\(aq[{\(dqstart\(dq: \(dq192.168.199.2\(dq,                              \(dqend\(dq: \(dq192.168.199.254\(dq}]\(aq          gateway_ip=\(aq192.168.199.1\(aq cidr=192.168.199.0/24

salt \(aq*\(aq neutronng.subnet_create network_name_or_id=network1           subnet_name=subnet1 dns_nameservers=\(aq[\(dq8.8.8.8\(dq, \(dq8.8.8.7\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.subnet_delete(auth=None, **kwargs)
Delete a subnet
.INDENT 7.0
.TP
.B name
Name or ID of the subnet to update
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutronng.subnet_delete name=subnet1
salt \(aq*\(aq neutronng.subnet_delete           name=1dcac318a83b4610b7a7f7ba01465548
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.subnet_get(auth=None, **kwargs)
Get a single subnet
.INDENT 7.0
.TP
.B filters
A Python dictionary of filter conditions to push down
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutronng.subnet_get name=subnet1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.neutronng.subnet_update(auth=None, **kwargs)
Update a subnet
.INDENT 7.0
.TP
.B name_or_id
Name or ID of the subnet to update
.TP
.B subnet_name
The new name of the subnet
.TP
.B enable_dhcp
Set to \fBTrue\fP if DHCP is enabled and \fBFalse\fP if disabled
.TP
.B gateway_ip
The gateway IP address. When you specify both allocation_pools and
gateway_ip, you must ensure that the gateway IP does not overlap with
the specified allocation pools.
.TP
.B disable_gateway_ip
False
Set to \fBTrue\fP if gateway IP address is disabled and False if enabled.
It is not allowed with \fBgateway_ip\fP\&.
.TP
.B allocation_pools
A list of dictionaries of the start and end addresses for the
allocation pools.
.TP
.B dns_nameservers
A list of DNS name servers for the subnet
.TP
.B host_routes
A list of host route dictionaries for the subnet
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq neutronng.subnet_update name=subnet1 subnet_name=subnet2
salt \(aq*\(aq neutronng.subnet_update name=subnet1 dns_nameservers=\(aq[\(dq8.8.8.8\(dq, \(dq8.8.8.7\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.nexus
.sp
Module for fetching artifacts from Nexus 3.x
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B salt.modules.nexus.get_latest_release(nexus_url, repository, group_id, artifact_id, packaging, target_dir=\(aq/tmp\(aq, target_file=None, classifier=None, username=None, password=None)
Gets the latest release of the artifact
.INDENT 7.0
.TP
.B nexus_url
URL of nexus instance
.TP
.B repository
Release repository in nexus to retrieve artifact from, for example: libs\-releases
.TP
.B group_id
Group Id of the artifact
.TP
.B artifact_id
Artifact Id of the artifact
.TP
.B packaging
Packaging type (jar,war,ear,etc)
.TP
.B target_dir
Target directory to download artifact to (default: /tmp)
.TP
.B target_file
Target file to download artifact to (by default it is target_dir/artifact_id\-version.packaging)
.TP
.B classifier
Artifact classifier name (ex: sources,javadoc,etc). Optional parameter.
.TP
.B username
nexus username. Optional parameter.
.TP
.B password
nexus password. Optional parameter.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nexus.get_latest_snapshot(nexus_url, repository, group_id, artifact_id, packaging, target_dir=\(aq/tmp\(aq, target_file=None, classifier=None, username=None, password=None)
Gets latest snapshot of the given artifact
.INDENT 7.0
.TP
.B nexus_url
URL of nexus instance
.TP
.B repository
Snapshot repository in nexus to retrieve artifact from, for example: libs\-snapshots
.TP
.B group_id
Group Id of the artifact
.TP
.B artifact_id
Artifact Id of the artifact
.TP
.B packaging
Packaging type (jar,war,ear,etc)
.TP
.B target_dir
Target directory to download artifact to (default: /tmp)
.TP
.B target_file
Target file to download artifact to (by default it is target_dir/artifact_id\-snapshot_version.packaging)
.TP
.B classifier
Artifact classifier name (ex: sources,javadoc,etc). Optional parameter.
.TP
.B username
nexus username. Optional parameter.
.TP
.B password
nexus password. Optional parameter.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nexus.get_release(nexus_url, repository, group_id, artifact_id, packaging, version, target_dir=\(aq/tmp\(aq, target_file=None, classifier=None, username=None, password=None)
Gets the specified release of the artifact
.INDENT 7.0
.TP
.B nexus_url
URL of nexus instance
.TP
.B repository
Release repository in nexus to retrieve artifact from, for example: libs\-releases
.TP
.B group_id
Group Id of the artifact
.TP
.B artifact_id
Artifact Id of the artifact
.TP
.B packaging
Packaging type (jar,war,ear,etc)
.TP
.B version
Version of the artifact
.TP
.B target_dir
Target directory to download artifact to (default: /tmp)
.TP
.B target_file
Target file to download artifact to (by default it is target_dir/artifact_id\-version.packaging)
.TP
.B classifier
Artifact classifier name (ex: sources,javadoc,etc). Optional parameter.
.TP
.B username
nexus username. Optional parameter.
.TP
.B password
nexus password. Optional parameter.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nexus.get_snapshot(nexus_url, repository, group_id, artifact_id, packaging, version, snapshot_version=None, target_dir=\(aq/tmp\(aq, target_file=None, classifier=None, username=None, password=None)
Gets snapshot of the desired version of the artifact
.INDENT 7.0
.TP
.B nexus_url
URL of nexus instance
.TP
.B repository
Snapshot repository in nexus to retrieve artifact from, for example: libs\-snapshots
.TP
.B group_id
Group Id of the artifact
.TP
.B artifact_id
Artifact Id of the artifact
.TP
.B packaging
Packaging type (jar,war,ear,etc)
.TP
.B version
Version of the artifact
.TP
.B target_dir
Target directory to download artifact to (default: /tmp)
.TP
.B target_file
Target file to download artifact to (by default it is target_dir/artifact_id\-snapshot_version.packaging)
.TP
.B classifier
Artifact classifier name (ex: sources,javadoc,etc). Optional parameter.
.TP
.B username
nexus username. Optional parameter.
.TP
.B password
nexus password. Optional parameter.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nexus.get_snapshot_version_string(nexus_url, repository, group_id, artifact_id, packaging, version, classifier=None, username=None, password=None)
Gets the specific version string of a snapshot of the desired version of the artifact
.INDENT 7.0
.TP
.B nexus_url
URL of nexus instance
.TP
.B repository
Snapshot repository in nexus to retrieve artifact from, for example: libs\-snapshots
.TP
.B group_id
Group Id of the artifact
.TP
.B artifact_id
Artifact Id of the artifact
.TP
.B packaging
Packaging type (jar,war,ear,etc)
.TP
.B version
Version of the artifact
.TP
.B classifier
Artifact classifier name (ex: sources,javadoc,etc). Optional parameter.
.TP
.B username
nexus username. Optional parameter.
.TP
.B password
nexus password. Optional parameter.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.modules.nexus.nexusError(value)
.UNINDENT
.SS salt.modules.nfs3
.sp
Module for managing NFS version 3.
.INDENT 0.0
.TP
.B salt.modules.nfs3.add_export(exports=\(aq/etc/exports\(aq, path=None, hosts=None, options=None)
Add an export
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nfs3.add_export path=\(aq/srv/test\(aq hosts=\(aq127.0.0.1\(aq options=[\(aqrw\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nfs3.del_export(exports=\(aq/etc/exports\(aq, path=None)
Remove an export
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nfs.del_export /media/storage
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nfs3.list_exports(exports=\(aq/etc/exports\(aq)
List configured exports
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nfs.list_exports
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nfs3.reload_exports()
Trigger a reload of the exports file to apply changes
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nfs3.reload_exports
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.nftables
.sp
Support for nftables
.INDENT 0.0
.TP
.B salt.modules.nftables.append(table=\(aqfilter\(aq, chain=None, rule=None, family=\(aqipv4\(aq)
Append a rule to the specified table & chain.
.INDENT 7.0
.TP
.B This function accepts a rule in a standard nftables command format,
starting with the chain. Trying to force users to adapt to a new
method of creating rules would be irritating at best, and we
already have a parser that can handle it.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.append filter input \e
    rule=\(aqtcp dport 22 log accept\(aq

IPv6:
salt \(aq*\(aq nftables.append filter input \e
    rule=\(aqtcp dport 22 log accept\(aq \e
    family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.build_rule(table=None, chain=None, command=None, position=\(aq\(aq, full=None, family=\(aqipv4\(aq, **kwargs)
Build a well\-formatted nftables rule based on kwargs.
A \fItable\fP and \fIchain\fP are not required, unless \fIfull\fP is True.
.sp
If \fIfull\fP is \fITrue\fP, then \fItable\fP, \fIchain\fP and \fIcommand\fP are required.
\fIcommand\fP may be specified as either insert, append, or delete.
This will return the nftables command, exactly as it would
be used from the command line.
.sp
If a position is required (as with \fIinsert\fP or \fIdelete\fP), it may be specified as
\fIposition\fP\&. This will only be useful if \fIfull\fP is True.
.sp
If \fIconnstate\fP is passed in, it will automatically be changed to \fIstate\fP\&.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.build_rule match=state \e
    connstate=RELATED,ESTABLISHED jump=ACCEPT
salt \(aq*\(aq nftables.build_rule filter input command=insert position=3 \e
    full=True match=state state=related,established jump=accept

IPv6:
salt \(aq*\(aq nftables.build_rule match=state \e
    connstate=related,established jump=accept \e
    family=ipv6
salt \(aq*\(aq nftables.build_rule filter input command=insert position=3 \e
    full=True match=state state=related,established jump=accept \e
    family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.check(table=\(aqfilter\(aq, chain=None, rule=None, family=\(aqipv4\(aq)
Check for the existence of a rule in the table and chain
.INDENT 7.0
.TP
.B This function accepts a rule in a standard nftables command format,
starting with the chain. Trying to force users to adapt to a new
method of creating rules would be irritating at best, and we
already have a parser that can handle it.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.check filter input \e
    rule=\(aqtcp dport 22 log accept\(aq

IPv6:
salt \(aq*\(aq nftables.check filter input \e
    rule=\(aqtcp dport 22 log accept\(aq \e
    family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.check_chain(table=\(aqfilter\(aq, chain=None, family=\(aqipv4\(aq)
New in version 2014.7.0.

.sp
Check for the existence of a chain in the table
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.check_chain filter input

IPv6:
salt \(aq*\(aq nftables.check_chain filter input family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.check_table(table=None, family=\(aqipv4\(aq)
Check for the existence of a table
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.check_table nat
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.delete(table, chain=None, position=None, rule=None, family=\(aqipv4\(aq)
.INDENT 7.0
.TP
.B Delete a rule from the specified table & chain, specifying either the rule
in its entirety, or the rule\(aqs position in the chain.
.TP
.B This function accepts a rule in a standard nftables command format,
starting with the chain. Trying to force users to adapt to a new
method of creating rules would be irritating at best, and we
already have a parser that can handle it.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.delete filter input position=3

salt \(aq*\(aq nftables.delete filter input \e
    rule=\(aqtcp dport 22 log accept\(aq

IPv6:
salt \(aq*\(aq nftables.delete filter input position=3 family=ipv6

salt \(aq*\(aq nftables.delete filter input \e
    rule=\(aqtcp dport 22 log accept\(aq \e
    family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.delete_chain(table=\(aqfilter\(aq, chain=None, family=\(aqipv4\(aq)
New in version 2014.7.0.

.sp
Delete the chain from the specified table.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.delete_chain filter input

salt \(aq*\(aq nftables.delete_chain filter foo

IPv6:
salt \(aq*\(aq nftables.delete_chain filter input family=ipv6

salt \(aq*\(aq nftables.delete_chain filter foo family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.delete_table(table, family=\(aqipv4\(aq)
New in version 2014.7.0.

.sp
Create new custom table.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.delete_table filter

IPv6:
salt \(aq*\(aq nftables.delete_table filter family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.flush(table=\(aqfilter\(aq, chain=\(aq\(aq, family=\(aqipv4\(aq)
Flush the chain in the specified table, flush all chains in the specified
table if chain is not specified.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.flush filter

salt \(aq*\(aq nftables.flush filter input

IPv6:
salt \(aq*\(aq nftables.flush filter input family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.get_policy(table=\(aqfilter\(aq, chain=None, family=\(aqipv4\(aq)
New in version 3002.

.sp
Return the current policy for the specified table/chain
.INDENT 7.0
.TP
.B table
Name of the table containing the chain to check
.TP
.B chain
Name of the chain to get the policy for
.TP
.B family
Networking family, either ipv4 or ipv6
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.get_policy filter input

IPv6:
salt \(aq*\(aq nftables.get_policy filter input family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.get_rule_handle(table=\(aqfilter\(aq, chain=None, rule=None, family=\(aqipv4\(aq)
Get the handle for a particular rule
.INDENT 7.0
.TP
.B This function accepts a rule in a standard nftables command format,
starting with the chain. Trying to force users to adapt to a new
method of creating rules would be irritating at best, and we
already have a parser that can handle it.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.get_rule_handle filter input \e
    rule=\(aqtcp dport 22 log accept\(aq

IPv6:
salt \(aq*\(aq nftables.get_rule_handle filter input \e
    rule=\(aqtcp dport 22 log accept\(aq \e
    family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.get_rules(family=\(aqipv4\(aq)
Return a data structure of the current, in\-memory rules
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.get_rules

salt \(aq*\(aq nftables.get_rules family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.get_rules_json(family=\(aqipv4\(aq)
New in version 3002.

.sp
Return a list of dictionaries comprising the current, in\-memory rules
.INDENT 7.0
.TP
.B family
Networking family, either ipv4 or ipv6
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.get_rules_json

salt \(aq*\(aq nftables.get_rules_json family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.get_saved_rules(conf_file=None)
Return a data structure of the rules in the conf file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.get_saved_rules
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.insert(table=\(aqfilter\(aq, chain=None, position=None, rule=None, family=\(aqipv4\(aq)
Insert a rule into the specified table & chain, at the specified position.
.sp
If position is not specified, rule will be inserted in first position.
.INDENT 7.0
.TP
.B This function accepts a rule in a standard nftables command format,
starting with the chain. Trying to force users to adapt to a new
method of creating rules would be irritating at best, and we
already have a parser that can handle it.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.insert filter input \e
    rule=\(aqtcp dport 22 log accept\(aq

salt \(aq*\(aq nftables.insert filter input position=3 \e
    rule=\(aqtcp dport 22 log accept\(aq

IPv6:
salt \(aq*\(aq nftables.insert filter input \e
    rule=\(aqtcp dport 22 log accept\(aq \e
    family=ipv6

salt \(aq*\(aq nftables.insert filter input position=3 \e
    rule=\(aqtcp dport 22 log accept\(aq \e
    family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.list_tables(family=\(aqipv4\(aq)
Return a data structure of the current, in\-memory tables
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.list_tables

salt \(aq*\(aq nftables.list_tables family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.new_chain(table=\(aqfilter\(aq, chain=None, table_type=None, hook=None, priority=None, family=\(aqipv4\(aq)
New in version 2014.7.0.

.sp
Create new chain to the specified table.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.new_chain filter input

salt \(aq*\(aq nftables.new_chain filter input \e
        table_type=filter hook=input priority=0

salt \(aq*\(aq nftables.new_chain filter foo

IPv6:
salt \(aq*\(aq nftables.new_chain filter input family=ipv6

salt \(aq*\(aq nftables.new_chain filter input \e
        table_type=filter hook=input priority=0 family=ipv6

salt \(aq*\(aq nftables.new_chain filter foo family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.new_table(table, family=\(aqipv4\(aq)
New in version 2014.7.0.

.sp
Create new custom table.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.new_table filter

IPv6:
salt \(aq*\(aq nftables.new_table filter family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.save(filename=None, family=\(aqipv4\(aq)
Changed in version 3002.

.sp
Save the current in\-memory rules to disk. On systems where /etc/nftables is
a directory, a file named salt\-all\-in\-one.nft will be dropped inside by default.
The main nftables configuration will need to include this file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.save /etc/nftables
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.set_policy(table=\(aqfilter\(aq, chain=None, policy=None, family=\(aqipv4\(aq)
New in version 3002.

.sp
Set the current policy for the specified table/chain. This only works on
chains with an existing base chain.
.INDENT 7.0
.TP
.B table
Name of the table containing the chain to modify
.TP
.B chain
Name of the chain to set the policy for
.TP
.B policy
accept or drop
.TP
.B family
Networking family, either ipv4 or ipv6
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.set_policy filter input accept

IPv6:
salt \(aq*\(aq nftables.set_policy filter input accept family=ipv6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nftables.version()
Return version from nftables \-\-version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nftables.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.nginx
.sp
Support for nginx
.INDENT 0.0
.TP
.B salt.modules.nginx.build_info()
Return server and build arguments
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nginx.build_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nginx.configtest()
test configuration and exit
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nginx.configtest
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nginx.signal(signal=None)
Signals nginx to start, reload, reopen or stop.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nginx.signal reload
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nginx.status(url=\(aqhttp://127.0.0.1/status\(aq)
Return the data from an Nginx status page as a dictionary.
\fI\%http://wiki.nginx.org/HttpStubStatusModule\fP
.INDENT 7.0
.TP
.B url
The URL of the status page. Defaults to \(aq\fI\%http://127.0.0.1/status\fP\(aq
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nginx.status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nginx.version()
Return server version from nginx \-v
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nginx.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.nilrt_ip
.sp
The networking module for NI Linux Real\-Time distro
.INDENT 0.0
.TP
.B salt.modules.nilrt_ip.apply_network_settings(**settings)
Apply global network configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.apply_network_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nilrt_ip.build_interface(iface, iface_type, enabled, **settings)
Build an interface script for a network interface.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.build_interface eth0 eth <settings>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nilrt_ip.build_network_settings(**settings)
Build the global network script.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.build_network_settings <settings>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nilrt_ip.disable(interface)
Disable the specified interface
.sp
Change adapter mode to Disabled. If previous adapter mode was EtherCAT, the target will need reboot.
.INDENT 7.0
.TP
.B Parameters
\fBinterface\fP (\fI\%str\fP) \-\- interface label
.TP
.B Returns
True if the service was disabled, otherwise an exception will be thrown.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.disable interface\-label
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nilrt_ip.down(interface, iface_type=None)
Disable the specified interface
.sp
Change adapter mode to Disabled. If previous adapter mode was EtherCAT, the target will need reboot.
.INDENT 7.0
.TP
.B Parameters
\fBinterface\fP (\fI\%str\fP) \-\- interface label
.TP
.B Returns
True if the service was disabled, otherwise an exception will be thrown.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.down interface\-label
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nilrt_ip.enable(interface)
Enable the specified interface
.sp
Change adapter mode to TCP/IP. If previous adapter mode was EtherCAT, the target will need reboot.
.INDENT 7.0
.TP
.B Parameters
\fBinterface\fP (\fI\%str\fP) \-\- interface label
.TP
.B Returns
True if the service was enabled, otherwise an exception will be thrown.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.enable interface\-label
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nilrt_ip.get_interface(iface)
Returns details about given interface.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.get_interface eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nilrt_ip.get_interfaces_details()
Get details about all the interfaces on the minion
.INDENT 7.0
.TP
.B Returns
information about all interfaces omitting loopback
.TP
.B Return type
dictionary
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.get_interfaces_details
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nilrt_ip.get_network_settings()
Return the contents of the global network script.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.get_network_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nilrt_ip.set_dhcp_linklocal_all(interface)
Configure specified adapter to use DHCP with linklocal fallback
.sp
Change adapter mode to TCP/IP. If previous adapter mode was EtherCAT, the target will need reboot.
.INDENT 7.0
.TP
.B Parameters
\fBinterface\fP (\fI\%str\fP) \-\- interface label
.TP
.B Returns
True if the settings were applied, otherwise an exception will be thrown.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.set_dhcp_linklocal_all interface\-label
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nilrt_ip.set_dhcp_only_all(interface)
Configure specified adapter to use DHCP only
.sp
Change adapter mode to TCP/IP. If previous adapter mode was EtherCAT, the target will need reboot.
.INDENT 7.0
.TP
.B Parameters
\fBinterface\fP (\fI\%str\fP) \-\- interface label
.TP
.B Returns
True if the settings were applied, otherwise an exception will be thrown.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.dhcp_only_all interface\-label
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nilrt_ip.set_ethercat(interface, master_id)
Configure specified adapter to use EtherCAT adapter mode. If successful, the target will need reboot if it doesn\(aqt
already use EtherCAT adapter mode, otherwise will return true.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinterface\fP \-\- interface label
.IP \(bu 2
\fBmaster_id\fP \-\- EtherCAT Master ID
.UNINDENT
.TP
.B Returns
True if the settings were applied, otherwise an exception will be thrown.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.set_ethercat interface\-label master\-id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nilrt_ip.set_linklocal_only_all(interface)
Configure specified adapter to use linklocal only
.sp
Change adapter mode to TCP/IP. If previous adapter mode was EtherCAT, the target will need reboot.
.INDENT 7.0
.TP
.B Parameters
\fBinterface\fP (\fI\%str\fP) \-\- interface label
.TP
.B Returns
True if the settings were applied, otherwise an exception will be thrown.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.linklocal_only_all interface\-label
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nilrt_ip.set_static_all(interface, address, netmask, gateway, nameservers=None)
Configure specified adapter to use ipv4 manual settings
.sp
Change adapter mode to TCP/IP. If previous adapter mode was EtherCAT, the target will need reboot.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinterface\fP (\fI\%str\fP) \-\- interface label
.IP \(bu 2
\fBaddress\fP (\fI\%str\fP) \-\- ipv4 address
.IP \(bu 2
\fBnetmask\fP (\fI\%str\fP) \-\- ipv4 netmask
.IP \(bu 2
\fBgateway\fP (\fI\%str\fP) \-\- ipv4 gateway
.IP \(bu 2
\fBnameservers\fP (\fI\%str\fP) \-\- list of nameservers servers separated by spaces (Optional)
.UNINDENT
.TP
.B Returns
True if the settings were applied, otherwise an exception will be thrown.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.set_static_all interface\-label address netmask gateway nameservers
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nilrt_ip.up(interface, iface_type=None)
Enable the specified interface
.sp
Change adapter mode to TCP/IP. If previous adapter mode was EtherCAT, the target will need reboot.
.INDENT 7.0
.TP
.B Parameters
\fBinterface\fP (\fI\%str\fP) \-\- interface label
.TP
.B Returns
True if the service was enabled, otherwise an exception will be thrown.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.up interface\-label
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.nix
.SS Work with Nix packages
.sp
New in version 2017.7.0.

.sp
Does not require the machine to be Nixos, just have Nix installed and available
to use for the user running this command. Their profile must be located in
their home, under \fB$HOME/.nix\-profile/\fP, and the nix store, unless specially
set up, should be in \fB/nix\fP\&. To easily use this with multiple users or a root
user, set up the \fI\%nix\-daemon\fP\&.
.sp
This module exposes most of the common nix operations. Currently not meant to be run as a \fBpkg\fP module, but explicitly as \fBnix.*\fP\&.
.sp
For more information on nix, see the \fI\%nix documentation\fP\&.
.INDENT 0.0
.TP
.B salt.modules.nix.collect_garbage()
Completely removed all currently \(aquninstalled\(aq packages in the nix store.
.sp
Tells the user how many store paths were removed and how much space was freed.
.INDENT 7.0
.TP
.B Returns
How much space was freed and how many derivations were removed
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This is a destructive action on the nix store.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nix.collect_garbage
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nix.install(*pkgs, **kwargs)
Installs a single or multiple packages via nix
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpkgs\fP (\fI\%list\fP\fI(\fP\fI\%str\fP\fI)\fP) \-\- packages to update
.IP \(bu 2
\fBattributes\fP (\fI\%bool\fP) \-\- Pass the list of packages or single package as attribues, not package names.
default: False
.UNINDENT
.TP
.B Returns
Installed packages. Example element: \fBgcc\-3.3.2\fP
.TP
.B Return type
\fI\%list\fP(\fI\%str\fP)
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nix.install package [package2 ...]
salt \(aq*\(aq nix.install attributes=True attr.name [attr.name2 ...]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nix.list_pkgs(installed=True, attributes=True)
Lists installed packages. Due to how nix works, it defaults to just doing a \fBnix\-env \-q\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinstalled\fP (\fI\%bool\fP) \-\- list only installed packages. This can be a very long list (12,000+ elements), so caution is advised.
Default: True
.IP \(bu 2
\fBattributes\fP (\fI\%bool\fP) \-\- show the attributes of the packages when listing all packages.
Default: True
.UNINDENT
.TP
.B Returns
Packages installed or available, along with their attributes.
.TP
.B Return type
\fI\%list\fP(\fI\%list\fP(\fI\%str\fP))
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nix.list_pkgs
salt \(aq*\(aq nix.list_pkgs installed=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nix.uninstall(*pkgs)
Erases a package from the current nix profile. Nix uninstalls work differently than other package managers, and the symlinks in the
profile are removed, while the actual package remains. There is also a \fBnix.purge\fP function, to clear the package cache of unused
packages.
.INDENT 7.0
.TP
.B Parameters
\fBpkgs\fP (\fI\%list\fP\fI(\fP\fI\%str\fP\fI)\fP) \-\- List, single package to uninstall
.TP
.B Returns
Packages that have been uninstalled
.TP
.B Return type
\fI\%list\fP(\fI\%str\fP)
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nix.uninstall pkg1 [pkg2 ...]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nix.upgrade(*pkgs)
Runs an update operation on the specified packages, or all packages if none is specified.
.INDENT 7.0
.TP
.B Parameters
\fBpkgs\fP (\fI\%list\fP\fI(\fP\fI\%str\fP\fI)\fP) \-\- List of packages to update
.TP
.B Returns
The upgraded packages. Example element: \fB[\(aqlibxslt\-1.1.0\(aq, \(aqlibxslt\-1.1.10\(aq]\fP
.TP
.B Return type
\fI\%list\fP(\fI\%tuple\fP(\fI\%str\fP, \fI\%str\fP))
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nix.update
salt \(aq*\(aq nix.update pkgs=one,two
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.nova
.sp
Module for handling OpenStack Nova calls
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
novaclient Python module
.UNINDENT
.TP
.B configuration
This module is not usable until the user, password, tenant, and
auth URL are specified either in a pillar or in the minion\(aqs config file.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
keystone.user: admin
keystone.password: verybadpass
keystone.tenant: admin
keystone.auth_url: \(aqhttp://127.0.0.1:5000/v2.0/\(aq
# Optional
keystone.region_name: \(aqRegionOne\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If configuration for multiple OpenStack accounts is required, they can be
set up as different configuration profiles:
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
openstack1:
  keystone.user: admin
  keystone.password: verybadpass
  keystone.tenant: admin
  keystone.auth_url: \(aqhttp://127.0.0.1:5000/v2.0/\(aq

openstack2:
  keystone.user: admin
  keystone.password: verybadpass
  keystone.tenant: admin
  keystone.auth_url: \(aqhttp://127.0.0.2:5000/v2.0/\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With this configuration in place, any of the nova functions can make use of
a configuration profile by declaring it explicitly.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.flavor_list profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use keystoneauth1 instead of keystoneclient, include the \fIuse_keystoneauth\fP
option in the pillar or minion config.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is required to use keystone v3 as for authentication.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
keystone.user: admin
keystone.password: verybadpass
keystone.tenant: admin
keystone.auth_url: \(aqhttp://127.0.0.1:5000/v3/\(aq
keystone.use_keystoneauth: true
keystone.verify: \(aq/path/to/custom/certs/ca\-bundle.crt\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
By default the nova module will attempt to verify its connection
utilizing the system certificates. If you need to verify against
another bundle of CA certificates or want to skip verification
altogether you will need to specify the \fIverify\fP option. You can
specify True or False to verify (or not) against system certificates, a
path to a bundle or CA certs to check against, or None to allow
keystoneauth to search for the certificates on its own. (defaults to
True)
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.boot(name, flavor_id=0, image_id=0, profile=None, timeout=300)
Boot (create) a new instance
.INDENT 7.0
.TP
.B name
Name of the new instance (must be first)
.TP
.B flavor_id
Unique integer ID for the flavor
.TP
.B image_id
Unique integer ID for the image
.TP
.B timeout
How long to wait, after creating the instance, for the provider to
return information about it (default 300 seconds).
.sp
New in version 2014.1.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.boot myinstance flavor_id=4596 image_id=2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The flavor_id and image_id are obtained from nova.flavor_list and
nova.image_list
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.flavor_list
salt \(aq*\(aq nova.image_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.delete(instance_id, profile=None)
Delete an instance
.INDENT 7.0
.TP
.B instance_id
ID of the instance to be deleted
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.delete 1138
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.flavor_create(name, flavor_id=0, ram=0, disk=0, vcpus=1, profile=None)
Add a flavor to nova (nova flavor\-create). The following parameters are
required:
.INDENT 7.0
.TP
.B name
Name of the new flavor (must be first)
.TP
.B flavor_id
Unique integer ID for the new flavor
.TP
.B ram
Memory size in MB
.TP
.B disk
Disk size in GB
.TP
.B vcpus
Number of vcpus
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.flavor_create myflavor flavor_id=6 ram=4096 disk=10 vcpus=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.flavor_delete(flavor_id, profile=None)
Delete a flavor from nova by id (nova flavor\-delete)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.flavor_delete 7
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.flavor_list(profile=None)
Return a list of available flavors (nova flavor\-list)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.flavor_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.image_list(name=None, profile=None)
Return a list of available images (nova images\-list + nova image\-show)
If a name is provided, only that image will be displayed.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.image_list
salt \(aq*\(aq nova.image_list myimage
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.image_meta_delete(image_id=None, name=None, keys=None, profile=None)
Delete a key=value pair from the metadata for an image
(nova image\-meta set)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.image_meta_delete 6f52b2ff\-0b31\-4d84\-8fd1\-af45b84824f6 keys=cheese
salt \(aq*\(aq nova.image_meta_delete name=myimage keys=salad,beans
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.image_meta_set(image_id=None, name=None, profile=None, **kwargs)
Sets a key=value pair in the metadata for an image (nova image\-meta set)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.image_meta_set 6f52b2ff\-0b31\-4d84\-8fd1\-af45b84824f6 cheese=gruyere
salt \(aq*\(aq nova.image_meta_set name=myimage salad=pasta beans=baked
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.keypair_add(name, pubfile=None, pubkey=None, profile=None)
Add a keypair to nova (nova keypair\-add)
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.keypair_add mykey pubfile=/home/myuser/.ssh/id_rsa.pub
salt \(aq*\(aq nova.keypair_add mykey pubkey=\(aqssh\-rsa <key> myuser@mybox\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.keypair_delete(name, profile=None)
Add a keypair to nova (nova keypair\-delete)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.keypair_delete mykey
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.keypair_list(profile=None)
Return a list of available keypairs (nova keypair\-list)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.keypair_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.list_(profile=None)
To maintain the feel of the nova command line, this function simply calls
the server_list function.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.lock(instance_id, profile=None)
Lock an instance
.INDENT 7.0
.TP
.B instance_id
ID of the instance to be locked
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.lock 1138
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.resume(instance_id, profile=None)
Resume an instance
.INDENT 7.0
.TP
.B instance_id
ID of the instance to be resumed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.resume 1138
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.secgroup_create(name, description, profile=None)
Add a secgroup to nova (nova secgroup\-create)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.secgroup_create mygroup \(aqThis is my security group\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.secgroup_delete(name, profile=None)
Delete a secgroup to nova (nova secgroup\-delete)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.secgroup_delete mygroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.secgroup_list(profile=None)
Return a list of available security groups (nova items\-list)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.secgroup_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.server_by_name(name, profile=None)
Return information about a server
.INDENT 7.0
.TP
.B name
Server Name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.server_by_name myserver profile=openstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.server_list(profile=None)
Return list of active servers
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.server_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.server_list_detailed(profile=None)
Return detailed list of active servers
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.server_list_detailed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.server_show(server_id, profile=None)
Return detailed information for an active server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.server_show <server_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.show(server_id, profile=None)
To maintain the feel of the nova command line, this function simply calls
the server_show function.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.show
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.suspend(instance_id, profile=None)
Suspend an instance
.INDENT 7.0
.TP
.B instance_id
ID of the instance to be suspended
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.suspend 1138
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.volume_attach(name, server_name, device=\(aq/dev/xvdb\(aq, profile=None, timeout=300)
Attach a block storage volume
.INDENT 7.0
.TP
.B name
Name of the new volume to attach
.TP
.B server_name
Name of the server to attach to
.TP
.B device
Name of the device on the server
.TP
.B profile
Profile to build on
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.volume_attach myblock slice.example.com profile=openstack
salt \(aq*\(aq nova.volume_attach myblock server.example.com device=\(aq/dev/xvdb\(aq profile=openstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.volume_create(name, size=100, snapshot=None, voltype=None, profile=None)
Create a block storage volume
.INDENT 7.0
.TP
.B name
Name of the new volume (must be first)
.TP
.B size
Volume size
.TP
.B snapshot
Block storage snapshot id
.TP
.B voltype
Type of storage
.TP
.B profile
Profile to build on
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.volume_create myblock size=300 profile=openstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.volume_delete(name, profile=None)
Destroy the volume
.INDENT 7.0
.TP
.B name
Name of the volume
.TP
.B profile
Profile to build on
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.volume_delete myblock profile=openstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.volume_detach(name, profile=None, timeout=300)
Attach a block storage volume
.INDENT 7.0
.TP
.B name
Name of the new volume to attach
.TP
.B server_name
Name of the server to detach from
.TP
.B profile
Profile to build on
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.volume_detach myblock profile=openstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.volume_list(search_opts=None, profile=None)
List storage volumes
.INDENT 7.0
.TP
.B search_opts
Dictionary of search options
.TP
.B profile
Profile to use
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.volume_list search_opts=\(aq{\(dqdisplay_name\(dq: \(dqmyblock\(dq}\(aq profile=openstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nova.volume_show(name, profile=None)
Create a block storage volume
.INDENT 7.0
.TP
.B name
Name of the volume
.TP
.B profile
Profile to use
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nova.volume_show myblock profile=openstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.npm
.sp
Manage and query NPM packages.
.INDENT 0.0
.TP
.B salt.modules.npm.cache_clean(path=None, runas=None, env=None, force=False)
Clean cached NPM packages.
.sp
If no path for a specific package is provided the entire cache will be cleared.
.INDENT 7.0
.TP
.B path
The cache subpath to delete, or None to clear the entire cache
.TP
.B runas
The user to run NPM with
.TP
.B env
Environment variables to set when invoking npm. Uses the same \fBenv\fP
format as the \fI\%cmd.run\fP execution
function.
.TP
.B force
Force cleaning of cache.  Required for npm@5 and greater
.sp
New in version 2016.11.6.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq npm.cache_clean force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.npm.cache_list(path=None, runas=None, env=None)
List NPM cached packages.
.sp
If no path for a specific package is provided this will list all the cached packages.
.INDENT 7.0
.TP
.B path
The cache subpath to list, or None to list the entire cache
.TP
.B runas
The user to run NPM with
.TP
.B env
Environment variables to set when invoking npm. Uses the same \fBenv\fP
format as the \fI\%cmd.run\fP execution
function.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq npm.cache_clean
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.npm.cache_path(runas=None, env=None)
List path of the NPM cache directory.
.INDENT 7.0
.TP
.B runas
The user to run NPM with
.TP
.B env
Environment variables to set when invoking npm. Uses the same \fBenv\fP
format as the \fI\%cmd.run\fP execution
function.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq npm.cache_path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.npm.install(pkg=None, pkgs=None, dir=None, runas=None, registry=None, env=None, dry_run=False, silent=True)
Install an NPM package.
.sp
If no directory is specified, the package will be installed globally. If
no package is specified, the dependencies (from package.json) of the
package in the given directory will be installed.
.INDENT 7.0
.TP
.B pkg
A package name in any format accepted by NPM, including a version
identifier
.TP
.B pkgs
A list of package names in the same format as the \fBname\fP parameter
.sp
New in version 2014.7.0.

.TP
.B dir
The target directory in which to install the package, or None for
global installation
.TP
.B runas
The user to run NPM with
.TP
.B registry
The NPM registry to install the package from.
.sp
New in version 2014.7.0.

.TP
.B env
Environment variables to set when invoking npm. Uses the same \fBenv\fP
format as the \fI\%cmd.run\fP execution
function.
.sp
New in version 2014.7.0.

.TP
.B silent
Whether or not to run NPM install with \-\-silent flag.
.sp
New in version 2016.3.0.

.TP
.B dry_run
Whether or not to run NPM install with \-\-dry\-run flag.
.sp
New in version 2015.8.4.

.TP
.B silent
Whether or not to run NPM install with \-\-silent flag.
.sp
New in version 2015.8.5.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq npm.install coffee\-script

salt \(aq*\(aq npm.install coffee\-script@1.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.npm.list_(pkg=None, dir=None, runas=None, env=None, depth=None)
List installed NPM packages.
.sp
If no directory is specified, this will return the list of globally\-
installed packages.
.INDENT 7.0
.TP
.B pkg
Limit package listing by name
.TP
.B dir
The directory whose packages will be listed, or None for global
installation
.TP
.B runas
The user to run NPM with
.sp
New in version 2014.7.0.

.TP
.B env
Environment variables to set when invoking npm. Uses the same \fBenv\fP
format as the \fI\%cmd.run\fP execution
function.
.sp
New in version 2014.7.0.

.TP
.B depth
Limit the depth of the packages listed
.sp
New in version 2016.11.6,2017.7.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq npm.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.npm.uninstall(pkg, dir=None, runas=None, env=None)
Uninstall an NPM package.
.sp
If no directory is specified, the package will be uninstalled globally.
.INDENT 7.0
.TP
.B pkg
A package name in any format accepted by NPM
.TP
.B dir
The target directory from which to uninstall the package, or None for
global installation
.TP
.B runas
The user to run NPM with
.TP
.B env
Environment variables to set when invoking npm. Uses the same \fBenv\fP
format as the \fI\%cmd.run\fP execution
function.
.sp
New in version 2015.5.3.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq npm.uninstall coffee\-script
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.nspawn
.sp
Manage nspawn containers
.sp
New in version 2015.8.0.

.sp
\fI\%systemd\-nspawn(1)\fP is a tool used to manage lightweight namespace
containers. This execution module provides several functions to help manage
these containers.
.sp
Minions running systemd >= 219 will place new containers in
\fB/var/lib/machines\fP, while those running systemd < 219 will place them in
\fB/var/lib/container\fP\&.
.INDENT 0.0
.TP
.B salt.modules.nspawn.bootstrap_container(name, dist=None, version=None)
Bootstrap a container from package servers, if dist is None the os the
minion is running as will be created, otherwise the needed bootstrapping
tools will need to be available on the host.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.bootstrap_container <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.bootstrap_salt(name, config=None, approve_key=True, install=True, pub_key=None, priv_key=None, bootstrap_url=None, force_install=False, unconditional_install=False, bootstrap_delay=None, bootstrap_args=None, bootstrap_shell=None)
Bootstrap a container from package servers, if dist is None the os the
minion is running as will be created, otherwise the needed bootstrapping
tools will need to be available on the host.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nspawn.bootstrap_salt arch1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.copy_to(name, source, dest, overwrite=False, makedirs=False)
Copy a file from the host into a container
.INDENT 7.0
.TP
.B name
Container name
.TP
.B source
File to be copied to the container
.TP
.B dest
Destination on the container. Must be an absolute path.
.TP
.B overwrite
False
Unless this option is set to \fBTrue\fP, then if a file exists at the
location specified by the \fBdest\fP argument, an error will be raised.
.UNINDENT
.sp
makedirs : False
.INDENT 7.0
.INDENT 3.5
Create the parent directory on the container if it does not already
exist.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq nspawn.copy_to /tmp/foo /root/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.cp(name, source, dest, overwrite=False, makedirs=False)
This function is an alias of \fBcopy_to\fP\&.
.INDENT 7.0
.INDENT 3.5
Copy a file from the host into a container
.INDENT 0.0
.TP
.B name
Container name
.TP
.B source
File to be copied to the container
.TP
.B dest
Destination on the container. Must be an absolute path.
.TP
.B overwrite
False
Unless this option is set to \fBTrue\fP, then if a file exists at the
location specified by the \fBdest\fP argument, an error will be raised.
.UNINDENT
.sp
makedirs : False
.INDENT 0.0
.INDENT 3.5
Create the parent directory on the container if it does not already
exist.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq nspawn.copy_to /tmp/foo /root/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.destroy(name, stop=False)
This function is an alias of \fBremove\fP\&.
.INDENT 7.0
.INDENT 3.5
Remove the named container
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This function will remove all data associated with the container. It
will not, however, remove the btrfs subvolumes created by pulling
container images (\fI\%nspawn.pull_raw\fP, \fI\%nspawn.pull_tar\fP, \fI\%nspawn.pull_dkr\fP).
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B stop
False
If \fBTrue\fP, the container will be destroyed even if it is
running/frozen.
.UNINDENT
.sp
CLI Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nspawn.remove foo
salt \(aq*\(aq nspawn.remove foo stop=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.disable(name)
Set the named container to \fInot\fP be launched at boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.enable <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.enable(name)
Set the named container to be launched at boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.enable <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.exists(name)
Returns true if the named container exists
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.exists <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.info(name, **kwargs)
Return info about a container
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The container must be running for \fBmachinectl\fP to gather information
about it. If the container is stopped, then this function will start
it.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B start
False
If \fBTrue\fP, then the container will be started to retrieve the info. A
\fBStarted\fP key will be in the return data if the container was
started.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.info arch1
salt myminion nspawn.info arch1 force_start=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.list_()
This function is an alias of \fBlist_running\fP\&.
.INDENT 7.0
.INDENT 3.5
Lists running nspawn containers
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBnspawn.list\fP also works to list running containers
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.list_running
salt myminion nspawn.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.list_all()
Lists all nspawn containers
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.list_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.list_running()
Lists running nspawn containers
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBnspawn.list\fP also works to list running containers
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.list_running
salt myminion nspawn.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.list_stopped()
Lists stopped nspawn containers
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.list_stopped
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.pid(name)
Returns the PID of a container
.INDENT 7.0
.TP
.B name
Container name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.pid arch1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.poweroff(name)
Issue a clean shutdown to the container.  Equivalent to running
\fBmachinectl poweroff\fP on the named container.
.sp
For convenience, running \fBnspawn.stop\(ga\(ga(as shown in the CLI examples
below) is equivalent to running \(ga\(ganspawn.poweroff\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBmachinectl poweroff\fP is only supported in systemd >= 219. On earlier
systemd versions, running this function will simply issue a clean
shutdown via \fBsystemctl\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.poweroff arch1
salt myminion nspawn.stop arch1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.pull_dkr(url, name, index)
Execute a \fBmachinectl pull\-dkr\fP to download a docker image and add it to
/var/lib/machines as a new container.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBRequires systemd >= 219\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B url
URL from which to download the container
.TP
.B name
Name for the new container
.TP
.B index
URL of the Docker index server from which to pull (must be an
\fBhttp://\fP or \fBhttps://\fP URL).
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.pull_dkr centos/centos6 cent6 index=https://get.docker.com
salt myminion nspawn.pull_docker centos/centos6 cent6 index=https://get.docker.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.pull_docker(url, name, index)
This function is an alias of \fBpull_dkr\fP\&.
.INDENT 7.0
.INDENT 3.5
Execute a \fBmachinectl pull\-dkr\fP to download a docker image and add it to
/var/lib/machines as a new container.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBRequires systemd >= 219\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B url
URL from which to download the container
.TP
.B name
Name for the new container
.TP
.B index
URL of the Docker index server from which to pull (must be an
\fBhttp://\fP or \fBhttps://\fP URL).
.UNINDENT
.sp
CLI Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.pull_dkr centos/centos6 cent6 index=https://get.docker.com
salt myminion nspawn.pull_docker centos/centos6 cent6 index=https://get.docker.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.pull_raw(url, name, verify=False)
Execute a \fBmachinectl pull\-raw\fP to download a .qcow2 or raw disk image,
and add it to /var/lib/machines as a new container.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBRequires systemd >= 219\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B url
URL from which to download the container
.TP
.B name
Name for the new container
.TP
.B verify
False
Perform signature or checksum verification on the container. See the
\fBmachinectl(1)\fP man page (section titled \(dqImage Transfer Commands\(dq)
for more information on requirements for image verification. To perform
signature verification, use \fBverify=signature\fP\&. For checksum
verification, use \fBverify=checksum\fP\&. By default, no verification will
be performed.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.pull_raw http://ftp.halifax.rwth\-aachen.de/fedora/linux/releases/21/Cloud/Images/x86_64/Fedora\-Cloud\-Base\-20141203\-21.x86_64.raw.xz fedora21
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.pull_tar(url, name, verify=False)
Execute a \fBmachinectl pull\-raw\fP to download a .tar container image,
and add it to /var/lib/machines as a new container.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBRequires systemd >= 219\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B url
URL from which to download the container
.TP
.B name
Name for the new container
.TP
.B verify
False
Perform signature or checksum verification on the container. See the
\fBmachinectl(1)\fP man page (section titled \(dqImage Transfer Commands\(dq)
for more information on requirements for image verification. To perform
signature verification, use \fBverify=signature\fP\&. For checksum
verification, use \fBverify=checksum\fP\&. By default, no verification will
be performed.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.pull_tar http://foo.domain.tld/containers/archlinux\-2015.02.01.tar.gz arch2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.reboot(name, kill=False)
Reboot the container by sending a SIGINT to its init process. Equivalent
to running \fBmachinectl reboot\fP on the named container.
.sp
For convenience, running \fBnspawn.restart\fP (as shown in the CLI examples
below) is equivalent to running \fBnspawn.reboot\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBmachinectl reboot\fP is only supported in systemd >= 219. On earlier
systemd versions, running this function will instead restart the
container via \fBsystemctl\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.reboot arch1
salt myminion nspawn.restart arch1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.remove(name, stop=False)
Remove the named container
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This function will remove all data associated with the container. It
will not, however, remove the btrfs subvolumes created by pulling
container images (\fI\%nspawn.pull_raw\fP, \fI\%nspawn.pull_tar\fP, \fI\%nspawn.pull_dkr\fP).
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B stop
False
If \fBTrue\fP, the container will be destroyed even if it is
running/frozen.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nspawn.remove foo
salt \(aq*\(aq nspawn.remove foo stop=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.restart(name)
This is a compatibility function which simply calls nspawn.reboot.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.retcode(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, ignore_retcode=False, keep_env=None)
Run \fI\%cmd.retcode\fP within a container
.INDENT 7.0
.TP
.B name
Name of the container in which to run the command
.TP
.B cmd
Command to run
.TP
.B no_start
False
If the container is not running, don\(aqt start it
.TP
.B preserve_state
True
After running the command, return the container to its previous state
.TP
.B stdin
None
Standard input to be used for the command
.TP
.B output_loglevel
debug
Level at which to log the output from the command. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console. Assumes
\fBoutput=all\fP\&.
.TP
.B keep_env
None
If not passed, only a sane default PATH environment variable will be
set. If \fBTrue\fP, all environment variables from the container\(aqs host
will be kept. Otherwise, a comma\-separated list (or Python list) of
environment variable names can be passed, and those environment
variables will be kept.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.retcode mycontainer \(aqip addr show\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.run(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, ignore_retcode=False, keep_env=None)
Run \fI\%cmd.run\fP within a container
.INDENT 7.0
.TP
.B name
Name of the container in which to run the command
.TP
.B cmd
Command to run
.TP
.B no_start
False
If the container is not running, don\(aqt start it
.TP
.B preserve_state
True
After running the command, return the container to its previous state
.TP
.B stdin
None
Standard input to be used for the command
.TP
.B output_loglevel
debug
Level at which to log the output from the command. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console.
.TP
.B keep_env
None
If not passed, only a sane default PATH environment variable will be
set. If \fBTrue\fP, all environment variables from the container\(aqs host
will be kept. Otherwise, a comma\-separated list (or Python list) of
environment variable names can be passed, and those environment
variables will be kept.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.run mycontainer \(aqip addr show\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.run_all(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, ignore_retcode=False, keep_env=None)
Run \fI\%cmd.run_all\fP within a container
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
While the command is run within the container, it is initiated from the
host. Therefore, the PID in the return dict is from the host, not from
the container.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Name of the container in which to run the command
.TP
.B cmd
Command to run
.TP
.B no_start
False
If the container is not running, don\(aqt start it
.TP
.B preserve_state
True
After running the command, return the container to its previous state
.TP
.B stdin
None
Standard input to be used for the command
.TP
.B output_loglevel
debug
Level at which to log the output from the command. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console. Assumes
\fBoutput=all\fP\&.
.TP
.B keep_env
None
If not passed, only a sane default PATH environment variable will be
set. If \fBTrue\fP, all environment variables from the container\(aqs host
will be kept. Otherwise, a comma\-separated list (or Python list) of
environment variable names can be passed, and those environment
variables will be kept.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.run_all mycontainer \(aqip addr show\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.run_stderr(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, ignore_retcode=False, keep_env=None)
Run \fI\%cmd.run_stderr\fP within a container
.INDENT 7.0
.TP
.B name
Name of the container in which to run the command
.TP
.B cmd
Command to run
.TP
.B no_start
False
If the container is not running, don\(aqt start it
.TP
.B preserve_state
True
After running the command, return the container to its previous state
.TP
.B stdin
None
Standard input to be used for the command
.TP
.B output_loglevel
debug
Level at which to log the output from the command. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console. Assumes
\fBoutput=all\fP\&.
.TP
.B keep_env
None
If not passed, only a sane default PATH environment variable will be
set. If \fBTrue\fP, all environment variables from the container\(aqs host
will be kept. Otherwise, a comma\-separated list (or Python list) of
environment variable names can be passed, and those environment
variables will be kept.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.run_stderr mycontainer \(aqip addr show\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.run_stdout(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, ignore_retcode=False, keep_env=None)
Run \fI\%cmd.run_stdout\fP within a container
.INDENT 7.0
.TP
.B name
Name of the container in which to run the command
.TP
.B cmd
Command to run
.TP
.B no_start
False
If the container is not running, don\(aqt start it
.TP
.B preserve_state
True
After running the command, return the container to its previous state
.TP
.B stdin
None
Standard input to be used for the command
.TP
.B output_loglevel
debug
Level at which to log the output from the command. Set to \fBquiet\fP to
suppress logging.
.TP
.B use_vt
False
Use SaltStack\(aqs utils.vt to stream output to console. Assumes
\fBoutput=all\fP\&.
.TP
.B keep_env
None
If not passed, only a sane default PATH environment variable will be
set. If \fBTrue\fP, all environment variables from the container\(aqs host
will be kept. Otherwise, a comma\-separated list (or Python list) of
environment variable names can be passed, and those environment
variables will be kept.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.run_stdout mycontainer \(aqip addr show\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.start(name)
Start the named container
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.start <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.state(name)
Return state of container (running or stopped)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.state <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.stop(name, kill=False)
This is a compatibility function which provides the logic for
nspawn.poweroff and nspawn.terminate.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nspawn.terminate(name)
Kill all processes in the container without issuing a clean shutdown.
Equivalent to running \fBmachinectl terminate\fP on the named container.
.sp
For convenience, running \fBnspawn.stop\fP and passing \fBkill=True\fP (as
shown in the CLI examples below) is equivalent to running
\fBnspawn.terminate\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBmachinectl terminate\fP is only supported in systemd >= 219. On
earlier systemd versions, running this function will simply issue a
clean shutdown via \fBsystemctl\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion nspawn.terminate arch1
salt myminion nspawn.stop arch1 kill=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.nxos
.sp
Execution module for Cisco NX OS Switches.
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B This module supports execution using a Proxy Minion or Native Minion:
1) Proxy Minion: Connect over SSH or NX\-API HTTP(S).
See \fI\%salt.proxy.nxos\fP for proxy minion setup details.
2) Native Minion: Connect over NX\-API Unix Domain Socket (UDS).
Install the minion inside the GuestShell running on the NX\-OS device.
.UNINDENT
.INDENT 0.0
.TP
.B maturity
new
.TP
.B platform
nxos
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To use this module over remote NX\-API the feature must be enabled on the
NX\-OS device by executing \fBfeature nxapi\fP in configuration mode.
.sp
This is not required for NX\-API over UDS.
.sp
Configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
switch# conf t
switch(config)# feature nxapi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To check that NX\-API is properly enabled, execute \fBshow nxapi\fP\&.
.sp
Output example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
switch# show nxapi
nxapi enabled
HTTPS Listen on port 443
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Native minion configuration options:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nxos:
  cookie: \(aqusername\(aq
  save_config: False
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B cookie
Use the option to override the default cookie \(aqadmin:local\(aq when
connecting over UDS and use \(aqusername:local\(aq instead. This is needed when
running the salt\-minion in the GuestShell using a non\-admin user.
.sp
This option is ignored for SSH and NX\-API Proxy minions.
.TP
.B save_config:
If True, \(aqcopy running\-config starting\-config\(aq is issues for every
configuration command.
If False, Running config is not saved to startup config
Default: True
.sp
The recommended approach is to use the \fIsave_running_config\fP function
instead of this option to improve performance.  The default behavior
controlled by this option is preserved for backwards compatibility.
.UNINDENT
.sp
The APIs defined in this execution module can also be executed using
salt\-call from the GuestShell environment as follows.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local nxos.sendline \(aqshow lldp neighbors\(aq raw_text
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The functions in this module should be executed like so:
.sp
salt \(aq*\(aq nxos.<function>
salt \(aq*\(aq nxos.get_user username=admin
.sp
For backwards compatibility, the following syntax will be supported
until the 3001 release.
.sp
salt \(aq*\(aq nxos.cmd <function>
salt \(aq*\(aq nxos.cmd get_user username=admin
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.add_config(lines, **kwargs)
Add one or more config lines to the NX\-OS device running config.
.INDENT 7.0
.TP
.B lines
Configuration lines to add
.TP
.B save_config
If False, don\(aqt save configuration commands to startup configuration.
If True, save configuration to startup configuration.
Default: True
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos.add_config \(aqsnmp\-server community TESTSTRINGHERE group network\-operator\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For more than one config added per command, lines should be a list.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.check_password(username, password, encrypted=False, **kwargs)
Verify user password.
.INDENT 7.0
.TP
.B username
Username on which to perform password check
.TP
.B password
Password to check
.TP
.B encrypted
Whether or not the password is encrypted
Default: False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.check_role(username, role, **kwargs)
Verify role assignment for user.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos.check_role username=admin role=network\-admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.cmd(command, *args, **kwargs)
NOTE: This function is preserved for backwards compatibility.  This allows
commands to be executed using either of the following syntactic forms.
.sp
salt \(aq*\(aq nxos.cmd <function>
.sp
or
.sp
salt \(aq*\(aq nxos.<function>
.INDENT 7.0
.TP
.B command
function from \fIsalt.modules.nxos\fP to run
.TP
.B args
positional args to pass to \fIcommand\fP function
.TP
.B kwargs
key word arguments to pass to \fIcommand\fP function
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos.cmd sendline \(aqshow ver\(aq
salt \(aq*\(aq nxos.cmd show_run
salt \(aq*\(aq nxos.cmd check_password username=admin password=\(aq$5$lkjsdfoi$blahblahblah\(aq encrypted=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.config(commands=None, config_file=None, template_engine=\(aqjinja\(aq, context=None, defaults=None, saltenv=\(aqbase\(aq, **kwargs)
Configures the Nexus switch with the specified commands.
.sp
This method is used to send configuration commands to the switch.  It
will take either a string or a list and prepend the necessary commands
to put the session into config mode.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
All the commands will be applied directly to the running\-config.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B config_file
The source file with the configuration commands to be sent to the
device.
.sp
The file can also be a template that can be rendered using the template
engine of choice.
.sp
This can be specified using the absolute path to the file, or using one
of the following URL schemes:
.INDENT 7.0
.IP \(bu 2
\fBsalt://\fP, to fetch the file from the Salt fileserver.
.IP \(bu 2
\fBhttp://\fP or \fBhttps://\fP
.IP \(bu 2
\fBftp://\fP
.IP \(bu 2
\fBs3://\fP
.IP \(bu 2
\fBswift://\fP
.UNINDENT
.TP
.B commands
The commands to send to the switch in config mode.  If the commands
argument is a string it will be cast to a list.
The list of commands will also be prepended with the necessary commands
to put the session in config mode.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument is ignored when \fBconfig_file\fP is specified.
.UNINDENT
.UNINDENT
.TP
.B template_engine: \fBjinja\fP
The template engine to use when rendering the source file. Default:
\fBjinja\fP\&. To simply fetch the file without attempting to render, set
this argument to \fBNone\fP\&.
.TP
.B context
Variables to add to the template context.
.TP
.B defaults
Default values of the context_dict.
.TP
.B save_config
If False, don\(aqt save configuration commands to startup configuration.
If True, save configuration to startup configuration.
Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos.config commands=\(dq[\(aqspanning\-tree mode mstp\(aq]\(dq
salt \(aq*\(aq nxos.config config_file=salt://config.txt
salt \(aq*\(aq nxos.config config_file=https://bit.ly/2LGLcDy context=\(dq{\(aqservers\(aq: [\(aq1.2.3.4\(aq]}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.delete_config(lines, **kwargs)
Delete one or more config lines to the switch running config.
.INDENT 7.0
.TP
.B lines
Configuration lines to remove.
.TP
.B save_config
If False, don\(aqt save configuration commands to startup configuration.
If True, save configuration to startup configuration.
Default: True
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos.delete_config \(aqsnmp\-server community TESTSTRINGHERE group network\-operator\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For more than one config deleted per command, lines should be a list.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.find(pattern, **kwargs)
Find all instances where the pattern is in the running configuration.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos.find \(aq^snmp\-server.*$\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This uses the \fIre.MULTILINE\fP regex format for python, and runs the
regex against the whole show_run output.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.get_roles(username, **kwargs)
Get roles assigned to a username.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.get_user(username, **kwargs)
Get username line from switch.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.grains(**kwargs)
Get grains for minion.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.grains_refresh(**kwargs)
Refresh the grains for the NX\-OS device.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.ping(**kwargs)
Ping the device on the other end of the connection.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.remove_user(username, **kwargs)
Remove user from switch.
.INDENT 7.0
.TP
.B username
Username to remove
.TP
.B save_config
If False, don\(aqt save configuration commands to startup configuration.
If True, save configuration to startup configuration.
Default: True
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos.remove_user username=daniel
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.replace(old_value, new_value, full_match=False, **kwargs)
Replace string or full line matches in switch\(aqs running config.
.sp
If full_match is set to True, then the whole line will need to be matched
as part of the old value.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos.replace \(aqTESTSTRINGHERE\(aq \(aqNEWTESTSTRINGHERE\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.save_running_config(**kwargs)
Save the running configuration to startup configuration.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos.save_running_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.sendline(command, method=\(aqcli_show_ascii\(aq, **kwargs)
Send arbitrary commands to the NX\-OS device.
.INDENT 7.0
.TP
.B command
The command or list of commands to be sent.
[\(aqcmd1\(aq, \(aqcmd2\(aq] is converted to \(aqcmd1 ; cmd2\(aq.
.TP
.B method:
\fBcli_show_ascii\fP: Return raw test or unstructured output.
\fBcli_show\fP: Return structured output.
\fBcli_conf\fP: Send configuration commands to the device.
Defaults to \fBcli_show_ascii\fP\&.
NOTE: method is ignored for SSH proxy minion.  All data is returned
unstructured.
.TP
.B error_pattern
Use the option to pass in a regular expression to search for in the
returned output of the command that indicates an error has occurred.
This option is only used when proxy minion connection type is ssh and
otherwise ignored.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.set_password(username, password, encrypted=False, role=None, crypt_salt=None, algorithm=\(aqsha256\(aq, **kwargs)
Set users password on switch.
.INDENT 7.0
.TP
.B username
Username to configure
.TP
.B password
Password to configure for username
.TP
.B encrypted
Whether or not to encrypt the password
Default: False
.TP
.B role
Configure role for the username
Default: None
.TP
.B crypt_salt
Configure crypt_salt setting
Default: None
.TP
.B algorithm
Encryption algorithm
Default: sha256
.TP
.B save_config
If False, don\(aqt save configuration commands to startup configuration.
If True, save configuration to startup configuration.
Default: True
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos.set_password admin TestPass
salt \(aq*\(aq nxos.set_password admin \e
    password=\(aq$5$2fWwO2vK$s7.Hr3YltMNHuhywQQ3nfOd.gAPHgs3SOBYYdGT3E.A\(aq \e
    encrypted=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.set_role(username, role, **kwargs)
Assign role to username.
.INDENT 7.0
.TP
.B username
Username for role configuration
.TP
.B role
Configure role for username
.TP
.B save_config
If False, don\(aqt save configuration commands to startup configuration.
If True, save configuration to startup configuration.
Default: True
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos.set_role username=daniel role=vdc\-admin.
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.show(commands, raw_text=True, **kwargs)
Execute one or more show (non\-configuration) commands.
.INDENT 7.0
.TP
.B commands
The commands to be executed.
.TP
.B raw_text: \fBTrue\fP
Whether to return raw text or structured data.
NOTE: raw_text option is ignored for SSH proxy minion.  Data is
returned unstructured.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local nxos.show \(aqshow version\(aq
salt \(aq*\(aq nxos.show \(aqshow bgp sessions ; show processes\(aq raw_text=False
salt \(aqregular\-minion\(aq nxos.show \(aqshow interfaces\(aq host=sw01.example.com username=test password=test
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.show_run(**kwargs)
Shortcut to run \fIshow running\-config\fP on the NX\-OS device.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos.show_run
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.show_ver(**kwargs)
Shortcut to run \fIshow version\fP on the NX\-OS device.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos.show_ver
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.system_info(**kwargs)
Return system information for grains of the minion.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos.system_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos.unset_role(username, role, **kwargs)
Remove role from username.
.INDENT 7.0
.TP
.B username
Username for role removal
.TP
.B role
Role to remove
.TP
.B save_config
If False, don\(aqt save configuration commands to startup configuration.
If True, save configuration to startup configuration.
Default: True
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos.unset_role username=daniel role=vdc\-admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.nxos_api
.sp
Execution module to manage Cisco Nexus Switches (NX\-OS) over the NX\-API
.sp
New in version 2019.2.0.

.sp
Execution module used to interface the interaction with a remote or local Nexus
switch whether we\(aqre running in a Proxy Minion or regular Minion (or regular
Minion running directly on the Nexus switch).
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP>
.TP
.B maturity
new
.TP
.B platform
any
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To be able to use this module you need to enable to NX\-API on your switch,
by executing \fBfeature nxapi\fP in configuration mode.
.sp
Configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
switch# conf t
switch(config)# feature nxapi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To check that NX\-API is properly enabled, execute \fBshow nxapi\fP\&.
.sp
Output example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
switch# show nxapi
nxapi enabled
HTTPS Listen on port 443
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
NX\-API requires modern NXOS distributions, typically at least 7.0 depending
on the hardware. Due to reliability reasons it is recommended to run the
most recent version.
.sp
Check \fI\%https://www.cisco.com/c/en/us/td/docs/switches/datacenter/nexus7000/sw/programmability/guide/b_Cisco_Nexus_7000_Series_NX\-OS_Programmability_Guide/b_Cisco_Nexus_7000_Series_NX\-OS_Programmability_Guide_chapter_0101.html\fP
for more details.
.UNINDENT
.UNINDENT
.SS Usage
.sp
This module can equally be used via the \fI\%nxos_api\fP
Proxy module or directly from an arbitrary (Proxy) Minion that is running on a
machine having access to the network device API. Given that there are no
external dependencies, this module can very well used when using the regular
Salt Minion directly installed on the switch.
.sp
When running outside of the \fI\%nxos_api Proxy\fP
(i.e., from another Proxy Minion type, or regular Minion), the NX\-API connection
arguments can be either specified from the CLI when executing the command, or
in a configuration block under the \fBnxos_api\fP key in the configuration opts
(i.e., (Proxy) Minion configuration file), or Pillar. The module supports these
simultaneously. These fields are the exact same supported by the \fBnxos_api\fP
Proxy Module:
.INDENT 0.0
.TP
.B transport: \fBhttps\fP
Specifies the type of connection transport to use. Valid values for the
connection are \fBhttp\fP, and  \fBhttps\fP\&.
.TP
.B host: \fBlocalhost\fP
The IP address or DNS host name of the connection device.
.TP
.B username: \fBadmin\fP
The username to pass to the device to authenticate the NX\-API connection.
.TP
.B password
The password to pass to the device to authenticate the NX\-API connection.
.TP
.B port
The TCP port of the endpoint for the NX\-API connection. If this keyword is
not specified, the default value is automatically determined by the
transport type (\fB80\fP for \fBhttp\fP, or \fB443\fP for \fBhttps\fP).
.TP
.B timeout: \fB60\fP
Time in seconds to wait for the device to respond. Default: 60 seconds.
.TP
.B verify: \fBTrue\fP
Either a boolean, in which case it controls whether we verify the NX\-API
TLS certificate, or a string, in which case it must be a path to a CA bundle
to use. Defaults to \fBTrue\fP\&.
.sp
When there is no certificate configuration on the device and this option is
set as \fBTrue\fP (default), the commands will fail with the following error:
\fBSSLError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed (_ssl.c:581)\fP\&.
In this case, you either need to configure a proper certificate on the
device (\fIrecommended\fP), or bypass the checks setting this argument as \fBFalse\fP
with all the security risks considered.
.sp
Check \fI\%https://www.cisco.com/c/en/us/td/docs/switches/datacenter/nexus3000/sw/programmability/6_x/b_Cisco_Nexus_3000_Series_NX\-OS_Programmability_Guide/b_Cisco_Nexus_3000_Series_NX\-OS_Programmability_Guide_chapter_01.html\fP
to see how to properly configure the certificate.
.UNINDENT
.sp
Example (when not running in a \fBnxos_api\fP Proxy Minion):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nxos_api:
  username: test
  password: test
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In case the \fBusername\fP and \fBpassword\fP are the same on any device you are
targeting, the block above (besides other parameters specific to your
environment you might need) should suffice to be able to execute commands from
outside a \fBnxos_api\fP Proxy, e.g.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local nxos_api.show \(aqshow lldp neighbors\(aq raw_text
# The command above is available when running in a regular Minion where Salt is installed

salt \(aq*\(aq nxos_api.show \(aqshow version\(aq raw_text=False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Remember that the above applies only when not running in a \fBnxos_api\fP Proxy
Minion. If you want to use the \fI\%nxos_api Proxy\fP,
please follow the documentation notes for a proper setup.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos_api.config(commands=None, config_file=None, template_engine=\(aqjinja\(aq, context=None, defaults=None, saltenv=\(aqbase\(aq, **kwargs)
Configures the Nexus switch with the specified commands.
.sp
This method is used to send configuration commands to the switch.  It
will take either a string or a list and prepend the necessary commands
to put the session into config mode.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
All the commands will be applied directly into the running\-config.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B config_file
The source file with the configuration commands to be sent to the
device.
.sp
The file can also be a template that can be rendered using the template
engine of choice.
.sp
This can be specified using the absolute path to the file, or using one
of the following URL schemes:
.INDENT 7.0
.IP \(bu 2
\fBsalt://\fP, to fetch the file from the Salt fileserver.
.IP \(bu 2
\fBhttp://\fP or \fBhttps://\fP
.IP \(bu 2
\fBftp://\fP
.IP \(bu 2
\fBs3://\fP
.IP \(bu 2
\fBswift://\fP
.UNINDENT
.TP
.B commands
The commands to send to the switch in config mode.  If the commands
argument is a string it will be cast to a list.
The list of commands will also be prepended with the necessary commands
to put the session in config mode.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument is ignored when \fBconfig_file\fP is specified.
.UNINDENT
.UNINDENT
.TP
.B template_engine: \fBjinja\fP
The template engine to use when rendering the source file. Default:
\fBjinja\fP\&. To simply fetch the file without attempting to render, set
this argument to \fBNone\fP\&.
.TP
.B context
Variables to add to the template context.
.TP
.B defaults
Default values of the context_dict.
.TP
.B transport: \fBhttps\fP
Specifies the type of connection transport to use. Valid values for the
connection are \fBhttp\fP, and  \fBhttps\fP\&.
.TP
.B host: \fBlocalhost\fP
The IP address or DNS host name of the connection device.
.TP
.B username: \fBadmin\fP
The username to pass to the device to authenticate the NX\-API connection.
.TP
.B password
The password to pass to the device to authenticate the NX\-API connection.
.TP
.B port
The TCP port of the endpoint for the NX\-API connection. If this keyword is
not specified, the default value is automatically determined by the
transport type (\fB80\fP for \fBhttp\fP, or \fB443\fP for \fBhttps\fP).
.TP
.B timeout: \fB60\fP
Time in seconds to wait for the device to respond. Default: 60 seconds.
.TP
.B verify: \fBTrue\fP
Either a boolean, in which case it controls whether we verify the NX\-API
TLS certificate, or a string, in which case it must be a path to a CA bundle
to use. Defaults to \fBTrue\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nxos_api.config commands=\(dq[\(aqspanning\-tree mode mstp\(aq]\(dq
salt \(aq*\(aq nxos_api.config config_file=salt://config.txt
salt \(aq*\(aq nxos_api.config config_file=https://bit.ly/2LGLcDy context=\(dq{\(aqservers\(aq: [\(aq1.2.3.4\(aq]}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos_api.rpc(commands, method=\(aqcli\(aq, **kwargs)
Execute an arbitrary RPC request via the Nexus API.
.INDENT 7.0
.TP
.B commands
The commands to be executed.
.TP
.B method: \fBcli\fP
The type of the response, i.e., raw text (\fBcli_ascii\fP) or structured
document (\fBcli\fP). Defaults to \fBcli\fP (structured data).
.TP
.B transport: \fBhttps\fP
Specifies the type of connection transport to use. Valid values for the
connection are \fBhttp\fP, and  \fBhttps\fP\&.
.TP
.B host: \fBlocalhost\fP
The IP address or DNS host name of the connection device.
.TP
.B username: \fBadmin\fP
The username to pass to the device to authenticate the NX\-API connection.
.TP
.B password
The password to pass to the device to authenticate the NX\-API connection.
.TP
.B port
The TCP port of the endpoint for the NX\-API connection. If this keyword is
not specified, the default value is automatically determined by the
transport type (\fB80\fP for \fBhttp\fP, or \fB443\fP for \fBhttps\fP).
.TP
.B timeout: \fB60\fP
Time in seconds to wait for the device to respond. Default: 60 seconds.
.TP
.B verify: \fBTrue\fP
Either a boolean, in which case it controls whether we verify the NX\-API
TLS certificate, or a string, in which case it must be a path to a CA bundle
to use. Defaults to \fBTrue\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local nxos_api.rpc \(aqshow version\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos_api.show(commands, raw_text=True, **kwargs)
Execute one or more show (non\-configuration) commands.
.INDENT 7.0
.TP
.B commands
The commands to be executed.  Multiple commands should
be specified as a list.
.TP
.B raw_text: \fBTrue\fP
Whether to return raw text or structured data.
.TP
.B transport: \fBhttps\fP
Specifies the type of connection transport to use. Valid values for the
connection are \fBhttp\fP, and  \fBhttps\fP\&.
.TP
.B host: \fBlocalhost\fP
The IP address or DNS host name of the connection device.
.TP
.B username: \fBadmin\fP
The username to pass to the device to authenticate the NX\-API connection.
.TP
.B password
The password to pass to the device to authenticate the NX\-API connection.
.TP
.B port
The TCP port of the endpoint for the NX\-API connection. If this keyword is
not specified, the default value is automatically determined by the
transport type (\fB80\fP for \fBhttp\fP, or \fB443\fP for \fBhttps\fP).
.TP
.B timeout: \fB60\fP
Time in seconds to wait for the device to respond. Default: 60 seconds.
.TP
.B verify: \fBTrue\fP
Either a boolean, in which case it controls whether we verify the NX\-API
TLS certificate, or a string, in which case it must be a path to a CA bundle
to use. Defaults to \fBTrue\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local nxos_api.show \(aqshow version\(aq
salt \(aq*\(aq nxos_api.show \(dq[\(aqshow bgp sessions\(aq,\(aqshow processes\(aq]\(dq raw_text=False
salt \(aqregular\-minion\(aq nxos_api.show \(aqshow interfaces\(aq host=sw01.example.com username=test password=test
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.nxos_upgrade
.sp
Execution module to upgrade Cisco NX\-OS Switches.
.sp
New in version 3001.

.INDENT 0.0
.TP
.B This module supports execution using a Proxy Minion or Native Minion:
.INDENT 7.0
.IP 1. 3
Proxy Minion: Connect over SSH or NX\-API HTTP(S).
See \fI\%salt.proxy.nxos\fP for proxy minion setup details.
.IP 2. 3
Native Minion: Connect over NX\-API Unix Domain Socket (UDS).
Install the minion inside the GuestShell running on the NX\-OS device.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B maturity
new
.TP
.B platform
nxos
.TP
.B codeauthor
Michael G Wiebe
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To use this module over remote NX\-API the feature must be enabled on the
NX\-OS device by executing \fBfeature nxapi\fP in configuration mode.
.sp
This is not required for NX\-API over UDS.
.sp
Configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
switch# conf t
switch(config)# feature nxapi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To check that NX\-API is properly enabled, execute \fBshow nxapi\fP\&.
.sp
Output example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
switch# show nxapi
nxapi enabled
HTTPS Listen on port 443
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos_upgrade.check_upgrade_impact(system_image, kickstart_image=None, issu=True, **kwargs)
Display upgrade impact information without actually upgrading the device.
.INDENT 7.0
.TP
.B system_image (Mandatory Option)
Path on bootflash: to system image upgrade file.
.TP
.B kickstart_image
Path on bootflash: to kickstart image upgrade file.
(Not required if using combined system/kickstart image file)
Default: None
.TP
.B issu
In Service Software Upgrade (non\-disruptive). When True,
the upgrade will abort if issu is not possible.
When False: Force (disruptive) Upgrade/Downgrade.
Default: True
.TP
.B timeout
Timeout in seconds for long running \(aqinstall all\(aq impact command.
Default: 900
.TP
.B error_pattern
Use the option to pass in a regular expression to search for in the
output of the \(aqinstall all impact\(aq command that indicates an error
has occurred.  This option is only used when proxy minion connection
type is ssh and otherwise ignored.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqn9k\(aq nxos.check_upgrade_impact system_image=nxos.9.2.1.bin
salt \(aqn7k\(aq nxos.check_upgrade_impact system_image=n7000\-s2\-dk9.8.1.1.bin \e
    kickstart_image=n7000\-s2\-kickstart.8.1.1.bin issu=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.nxos_upgrade.upgrade(system_image, kickstart_image=None, issu=True, **kwargs)
Upgrade NX\-OS switch.
.INDENT 7.0
.TP
.B system_image (Mandatory Option)
Path on bootflash: to system image upgrade file.
.TP
.B kickstart_image
Path on bootflash: to kickstart image upgrade file.
(Not required if using combined system/kickstart image file)
Default: None
.TP
.B issu
Set this option to True when an In Service Software Upgrade or
non\-disruptive upgrade is required. The upgrade will abort if issu is
not possible.
Default: True
.TP
.B timeout
Timeout in seconds for long running \(aqinstall all\(aq upgrade command.
Default: 900
.TP
.B error_pattern
Use the option to pass in a regular expression to search for in the
output of the \(aqinstall all upgrade command that indicates an error
has occurred.  This option is only used when proxy minion connection
type is ssh and otherwise ignored.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqn9k\(aq nxos.upgrade system_image=nxos.9.2.1.bin
salt \(aqn7k\(aq nxos.upgrade system_image=n7000\-s2\-dk9.8.1.1.bin \e
    kickstart_image=n7000\-s2\-kickstart.8.1.1.bin issu=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.omapi
.sp
This module interacts with an ISC DHCP Server via OMAPI.
server_ip and server_port params may be set in the minion
config or pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
omapi.server_ip: 127.0.0.1
omapi.server_port: 7991
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
pypureomapi Python module
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.omapi.add_host(mac, name=None, ip=None, ddns=False, group=None, supersede_host=False)
Add a host object for the given mac.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dhcp\-server omapi.add_host ab:ab:ab:ab:ab:ab name=host1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Add ddns\-hostname and a fixed\-ip statements:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dhcp\-server omapi.add_host ab:ab:ab:ab:ab:ab name=host1 ip=10.1.1.1 ddns=true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.omapi.delete_host(mac=None, name=None)
Delete the host with the given mac or name.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dhcp\-server omapi.delete_host name=host1
salt dhcp\-server omapi.delete_host mac=ab:ab:ab:ab:ab:ab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.openbsd_sysctl
.sp
Module for viewing and modifying OpenBSD sysctl parameters
.INDENT 0.0
.TP
.B salt.modules.openbsd_sysctl.assign(name, value)
Assign a single sysctl parameter for this minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.assign net.inet.ip.forwarding 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsd_sysctl.get(name)
Return a single sysctl parameter for this minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.get hw.physmem
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsd_sysctl.persist(name, value, config=\(aq/etc/sysctl.conf\(aq)
Assign and persist a simple sysctl parameter for this minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.persist net.inet.ip.forwarding 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsd_sysctl.show(config_file=False)
Return a list of sysctl parameters for this minion
.INDENT 7.0
.TP
.B config: Pull the data from the system configuration file
instead of the live data.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysctl.show
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.openbsdpkg
.sp
Package support for OpenBSD
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The package repository is configured on each host using \fB/etc/installurl\fP
from OpenBSD 6.1 onwards. Earlier releases relied on \fB/etc/pkg.conf\fP\&.
.UNINDENT
.UNINDENT
.sp
Changed in version 2016.3.5: Package versions on OpenBSD are not normally specified explicitly; instead
packages may be available in multiple \fIflavors\fP, and \fIbranches\fP which are
specified by the format of the package name. This module allows you to use
the same formatting as \fBpkg_add(1)\fP, and will select the empty flavor and
default branch by default. Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- rsync
\- vim\-\-no_x11
\- ruby%2.3
.ft P
.fi
.UNINDENT
.UNINDENT

.INDENT 0.0
.TP
.B salt.modules.openbsdpkg.install(name=None, pkgs=None, sources=None, **kwargs)
Install the passed package
.sp
Return a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example, Install one package:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example, Install more than one package:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dq<package name>\(dq, \(dq<package name>\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example, Install more than one package from a alternate source (e.g.
salt file\-server, HTTP, FTP, local filesystem):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install sources=\(aq[{\(dq<pkg name>\(dq: \(dqsalt://pkgs/<pkg filename>\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdpkg.latest_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdpkg.list_pkgs(versions_as_list=False, **kwargs)
List the packages currently installed as a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdpkg.purge(name=None, pkgs=None, **kwargs)
Remove a package and extra configuration files.
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.purge <package name>
salt \(aq*\(aq pkg.purge <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.purge pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdpkg.remove(name=None, pkgs=None, purge=False, **kwargs)
Remove a single package with pkg_delete
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdpkg.upgrade(name=None, pkgs=None, **kwargs)
Run a full package upgrade (\fBpkg_add \-u\fP), or upgrade a specific package
if \fBname\fP or \fBpkgs\fP is provided.
\fBname\fP is ignored when \fBpkgs\fP is specified.
.sp
Returns a dictionary containing the changes:
.sp
New in version 2019.2.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade
salt \(aq*\(aq pkg.upgrade python%2.7
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdpkg.upgrade_available(name, **kwargs)
Check whether or not an upgrade is available for a given package
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade_available <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdpkg.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.openbsdrcctl_service.py
.sp
The rcctl service module for OpenBSD
.INDENT 0.0
.TP
.B salt.modules.openbsdrcctl_service.available(name)
Return True if the named service is available.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.available sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdrcctl_service.disable(name, **kwargs)
Disable the named service to not start at boot.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdrcctl_service.disabled(name)
Return True if the named service is disabled at boot, False otherwise.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdrcctl_service.enable(name, **kwargs)
Enable the named service to start at boot.
.INDENT 7.0
.TP
.B flags
None
Set optional flags to run the service with.
.UNINDENT
.sp
service.flags can be used to change the default flags.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enable <service name>
salt \(aq*\(aq service.enable <service name> flags=<flags>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdrcctl_service.enabled(name, **kwargs)
Return True if the named service is enabled at boot and the provided
flags match the configured ones (if any). Return False otherwise.
.INDENT 7.0
.TP
.B name
Service name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enabled <service name>
salt \(aq*\(aq service.enabled <service name> flags=<flags>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdrcctl_service.get_all()
Return all installed services.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdrcctl_service.get_disabled()
Return what services are available but not enabled to start at boot.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_disabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdrcctl_service.get_enabled()
Return what services are set to run on boot.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdrcctl_service.missing(name)
The inverse of service.available.
Return True if the named service is not available.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.missing sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdrcctl_service.reload_(name)
Reload the named service.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdrcctl_service.restart(name)
Restart the named service.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdrcctl_service.start(name)
Start the named service.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdrcctl_service.status(name, sig=None)
Return the status for a service, returns a bool whether the service is
running.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdrcctl_service.stop(name)
Stop the named service.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.openbsdservice
.sp
The service module for OpenBSD
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage services on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqservice.start\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdservice.available(name)
New in version 2014.7.0.

.sp
Returns \fBTrue\fP if the specified service is available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.available sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdservice.disabled(name)
New in version 2014.7.0.

.sp
Return True if the named service is disabled, false otherwise
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdservice.enabled(name, **kwargs)
New in version 2014.7.0.

.sp
Return True if the named service is enabled, false otherwise
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdservice.get_all()
New in version 2014.7.0.

.sp
Return all available boot services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdservice.get_disabled()
New in version 2014.7.0.

.sp
Return a set of services that are installed but disabled
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_disabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdservice.get_enabled()
New in version 2014.7.0.

.sp
Return a list of service that are enabled on boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdservice.missing(name)
New in version 2014.7.0.

.sp
The inverse of service.available.
Returns \fBTrue\fP if the specified service is not available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.missing sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdservice.reload_(name)
New in version 2014.7.0.

.sp
Reload the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdservice.restart(name)
Restart the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdservice.start(name)
Start the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdservice.status(name, sig=None)
Return the status for a service.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.sp
Changed in version 2018.3.0: The service name can now be a glob (e.g. \fBsalt*\fP)

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.IP \(bu 2
\fBsig\fP (\fI\%str\fP) \-\- Signature to use to find the service via ps
.UNINDENT
.TP
.B Returns
True if running, False otherwise
dict: Maps service name to True if running, False otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name> [service signature]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openbsdservice.stop(name)
Stop the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.openscap
.sp
Module for OpenSCAP Management
.INDENT 0.0
.TP
.B salt.modules.openscap.xccdf(params)
Run \fBoscap xccdf\fP commands on minions.
It uses cp.push_dir to upload the generated files to the salt master
in the master\(aqs minion files cachedir
(defaults to \fB/var/cache/salt/master/minions/minion\-id/files\fP)
.sp
It needs \fBfile_recv\fP set to \fBTrue\fP in the master configuration file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq  openscap.xccdf \(dqeval \-\-profile Default /usr/share/openscap/scap\-yast2sec\-xccdf.xml\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openscap.xccdf_eval(xccdffile, ovalfiles=None, profile=None, rule=None, oval_results=None, results=None, report=None, fetch_remote_resources=None, tailoring_file=None, tailoring_id=None, remediate=None)
Run \fBoscap xccdf eval\fP commands on minions.
.sp
New in version 3007.0.

.sp
It uses cp.push_dir to upload the generated files to the salt master
in the master\(aqs minion files cachedir
(defaults to \fB/var/cache/salt/master/minions/minion\-id/files\fP)
.sp
It needs \fBfile_recv\fP set to \fBTrue\fP in the master configuration file.
.INDENT 7.0
.TP
.B xccdffile
the path to the xccdf file to evaluate
.TP
.B ovalfiles
additional oval definition files
.TP
.B profile
the name of Profile to be evaluated
.TP
.B rule
the name of a single rule to be evaluated
.TP
.B oval_results
save OVAL results as well (True or False)
.TP
.B results
write XCCDF Results into given file
.TP
.B report
write HTML report into given file
.TP
.B fetch_remote_resources
download remote content referenced by XCCDF (True or False)
.TP
.B tailoring_file
use given XCCDF Tailoring file
.TP
.B tailoring_id
use given DS component as XCCDF Tailoring file
.TP
.B remediate
automatically execute XCCDF fix elements for failed rules.
Use of this option is always at your own risk. (True or False)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq  openscap.xccdf_eval /usr/share/openscap/scap\-yast2sec\-xccdf.xml profile=Default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.openstack_config
.sp
Modify, retrieve, or delete values from OpenStack configuration files.
.INDENT 0.0
.TP
.B maintainer
Jeffrey C. Ollie <\fI\%jeff@ocjtech.us\fP>
.TP
.B maturity
new
.TP
.B depends
.TP
.B platform
linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openstack_config.delete(filename, section, parameter)
Delete a value from an OpenStack configuration file.
.INDENT 7.0
.TP
.B filename
The full path to the configuration file
.TP
.B section
The section from which to delete the parameter
.TP
.B parameter
The parameter to delete
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call openstack_config.delete /etc/keystone/keystone.conf sql connection
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openstack_config.get(filename, section, parameter)
Get a value from an OpenStack configuration file.
.INDENT 7.0
.TP
.B filename
The full path to the configuration file
.TP
.B section
The section from which to search for the parameter
.TP
.B parameter
The parameter to return
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call openstack_config.get /etc/keystone/keystone.conf sql connection
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openstack_config.set_(filename, section, parameter, value)
Set a value in an OpenStack configuration file.
.INDENT 7.0
.TP
.B filename
The full path to the configuration file
.TP
.B section
The section in which the parameter will be set
.TP
.B parameter
The parameter to change
.TP
.B value
The value to set
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call openstack_config.set /etc/keystone/keystone.conf sql connection foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.openstack_mng
.sp
Module for OpenStack Management
.INDENT 0.0
.TP
.B codeauthor
Konrad Mosoń <\fI\%mosonkonrad@gmail.com\fP>
.TP
.B maturity
new
.TP
.B depends
openstack\-utils
.TP
.B platform
linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openstack_mng.restart_service(service_name, minimum_running_time=None)
Restart OpenStack service immediately, or only if it\(aqs running longer than
specified value
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openstack_mng.restart_service neutron
salt \(aq*\(aq openstack_mng.restart_service neutron minimum_running_time=600
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openstack_mng.start_service(service_name)
Start OpenStack service immediately
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openstack_mng.start_service neutron
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openstack_mng.stop_service(service_name)
Stop OpenStack service immediately
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openstack_mng.stop_service neutron
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.openvswitch
.sp
Support for Open vSwitch \- module with basic Open vSwitch commands.
.sp
Suitable for setting up Openstack Neutron.
.INDENT 0.0
.TP
.B codeauthor
Jiri Kotlin <\fI\%jiri.kotlin@ultimum.io\fP>
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.bridge_create(br, may_exist=True, parent=None, vlan=None)
Creates a new bridge.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBbr\fP \-\- string
bridge name
.IP \(bu 2
\fBmay_exist\fP \-\- bool
if False \- attempting to create a bridge that exists returns False.
.IP \(bu 2
\fBparent\fP \-\- string
name of the parent bridge (if the bridge shall be created as a fake
bridge). If specified, vlan must also be specified.
.IP \(bu 2
\fBversionadded:\fP (\fI\&..\fP) \-\- 3006.0:
.IP \(bu 2
\fBvlan\fP \-\- int
VLAN ID of the bridge (if the bridge shall be created as a fake
bridge). If specified, parent must also be specified.
.IP \(bu 2
\fBversionadded:\fP \-\- 3006.0:
.UNINDENT
.TP
.B Returns
True on success, else False.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.bridge_create br0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.bridge_delete(br, if_exists=True)
Deletes bridge and all of  its  ports.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBbr\fP \-\- A string \- bridge name
.IP \(bu 2
\fBif_exists\fP \-\- Bool, if False \- attempting to delete a bridge that does not exist returns False.
.UNINDENT
.TP
.B Returns
True on success, else False.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.bridge_delete br0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.bridge_exists(br)
Tests whether bridge exists as a real or fake  bridge.
.INDENT 7.0
.TP
.B Returns
True if Bridge exists, else False.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.bridge_exists br0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.bridge_list()
Lists all existing real and fake bridges.
.INDENT 7.0
.TP
.B Returns
List of bridges (or empty list), False on failure.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.bridge_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.bridge_to_parent(br)
New in version 3006.0.

.sp
Returns the parent bridge of a bridge.
.INDENT 7.0
.TP
.B Parameters
\fBbr\fP \-\- string
bridge name
.TP
.B Returns
Name of the parent bridge. This is the same as the bridge name if the
bridge is not a fake bridge. If the bridge does not exist, False is
returned.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.bridge_to_parent br0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.bridge_to_vlan(br)
New in version 3006.0.

.sp
Returns the VLAN ID of a bridge.
.INDENT 7.0
.TP
.B Parameters
\fBbr\fP \-\- string
bridge name
.TP
.B Returns
VLAN ID of the bridge. The VLAN ID is 0 if the bridge is not a fake
bridge.  If the bridge does not exist, False is returned.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.bridge_to_parent br0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.db_get(table, record, column, if_exists=False)
New in version 3006.0.

.sp
Gets a column\(aqs value for a specific record.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtable\fP \-\- string
name of the database table
.IP \(bu 2
\fBrecord\fP \-\- string
identifier of the record
.IP \(bu 2
\fBcolumn\fP \-\- string
name of the column
.IP \(bu 2
\fBif_exists\fP \-\- boolean
if True, it is not an error if the record does not exist.
.UNINDENT
.TP
.B Returns
The column\(aqs value.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.db_get Port br0 vlan_mode
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.db_set(table, record, column, value, if_exists=False)
New in version 3006.0.

.sp
Sets a column\(aqs value for a specific record.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtable\fP \-\- string
name of the database table
.IP \(bu 2
\fBrecord\fP \-\- string
identifier of the record
.IP \(bu 2
\fBcolumn\fP \-\- string
name of the column
.IP \(bu 2
\fBvalue\fP \-\- string
the value to be set
.IP \(bu 2
\fBif_exists\fP \-\- boolean
if True, it is not an error if the record does not exist.
.UNINDENT
.TP
.B Returns
None on success and an error message on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.db_set Interface br0 mac 02:03:04:05:06:07
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.interface_get_options(port)
Port\(aqs interface\(aqs optional parameters.
.INDENT 7.0
.TP
.B Parameters
\fBport\fP \-\- A string \- port name.
.TP
.B Returns
String containing optional parameters of port\(aqs interface, False on failure.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.interface_get_options tap0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.interface_get_type(port)
Type of port\(aqs interface.
.INDENT 7.0
.TP
.B Parameters
\fBport\fP \-\- A string \- port name.
.TP
.B Returns
String \- type of interface or empty string, False on failure.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.interface_get_type tap0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.port_add(br, port, may_exist=False, internal=False)
Creates on bridge a new port named port.
.INDENT 7.0
.TP
.B Returns
True on success, else False.
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBbr\fP \-\- A string \- bridge name
.IP \(bu 2
\fBport\fP \-\- A string \- port name
.IP \(bu 2
\fBmay_exist\fP \-\- Bool, if False \- attempting to create a port that exists returns False.
.IP \(bu 2
\fBinternal\fP \-\- A boolean to create an internal interface if one does not exist.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.port_add br0 8080
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.port_create_gre(br, port, id, remote)
Generic Routing Encapsulation \- creates GRE tunnel between endpoints.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBbr\fP \-\- A string \- bridge name.
.IP \(bu 2
\fBport\fP \-\- A string \- port name.
.IP \(bu 2
\fBid\fP \-\- An integer \- unsigned 32\-bit number, tunnel\(aqs key.
.IP \(bu 2
\fBremote\fP \-\- A string \- remote endpoint\(aqs IP address.
.UNINDENT
.TP
.B Returns
True on success, else False.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.port_create_gre br0 gre1 5001 192.168.1.10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.port_create_vlan(br, port, id, internal=False)
Isolate VM traffic using VLANs.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBbr\fP \-\- A string \- bridge name.
.IP \(bu 2
\fBport\fP \-\- A string \- port name.
.IP \(bu 2
\fBid\fP \-\- An integer in the valid range 0 to 4095 (inclusive), name of VLAN.
.IP \(bu 2
\fBinternal\fP \-\- A boolean to create an internal interface if one does not exist.
.UNINDENT
.TP
.B Returns
True on success, else False.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.port_create_vlan br0 tap0 100
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.port_create_vxlan(br, port, id, remote, dst_port=None)
Virtual eXtensible Local Area Network \- creates VXLAN tunnel between endpoints.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBbr\fP \-\- A string \- bridge name.
.IP \(bu 2
\fBport\fP \-\- A string \- port name.
.IP \(bu 2
\fBid\fP \-\- An integer \- unsigned 64\-bit number, tunnel\(aqs key.
.IP \(bu 2
\fBremote\fP \-\- A string \- remote endpoint\(aqs IP address.
.IP \(bu 2
\fBdst_port\fP \-\- An integer \- port to use when creating tunnelport in the switch.
.UNINDENT
.TP
.B Returns
True on success, else False.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.port_create_vxlan br0 vx1 5001 192.168.1.10 8472
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.port_get_tag(port)
Lists tags of the port.
.INDENT 7.0
.TP
.B Parameters
\fBport\fP \-\- A string \- port name.
.TP
.B Returns
List of tags (or empty list), False on failure.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.port_get_tag tap0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.port_list(br)
Lists all of the ports within bridge.
.INDENT 7.0
.TP
.B Parameters
\fBbr\fP \-\- A string \- bridge name.
.TP
.B Returns
List of bridges (or empty list), False on failure.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.port_list br0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.openvswitch.port_remove(br, port, if_exists=True)
.INDENT 7.0
.INDENT 3.5
Deletes port.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBbr\fP \-\- A string \- bridge name (If bridge is None, port is removed from  whatever bridge contains it)
.IP \(bu 2
\fBport\fP \-\- A string \- port name.
.IP \(bu 2
\fBif_exists\fP \-\- Bool, if False \- attempting to delete a por that  does  not exist returns False. (Default True)
.UNINDENT
.TP
.B Returns
True on success, else False.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq openvswitch.port_remove br0 8080
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.opkg
.sp
Support for Opkg
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage packages on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For version comparison support on opkg < 0.3.4, the \fBopkg\-utils\fP package
must be installed.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.available_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.check_extra_requirements(pkgname, pkgver)
Check if the installed package already has the given requirements.
There\(aqs nothing do to here for nipkg.py, therefore it will always
return True.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.del_repo(repo, **kwargs)
Delete a repo from \fB/etc/opkg/*.conf\fP
.sp
If the file does not contain any other repo configuration, the file itself
will be deleted.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.del_repo repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.file_dict(*packages, **kwargs)
List the files that belong to a package, grouped by package. Not
specifying any packages will return a list of _every_ file on the system\(aqs
package database (not generally recommended).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_list httpd
salt \(aq*\(aq pkg.file_list httpd postfix
salt \(aq*\(aq pkg.file_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.file_list(*packages, **kwargs)
List the files that belong to a package. Not specifying any packages will
return a list of _every_ file on the system\(aqs package database (not
generally recommended).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_list httpd
salt \(aq*\(aq pkg.file_list httpd postfix
salt \(aq*\(aq pkg.file_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.get_repo(repo, **kwargs)
Display a repo from the \fB/etc/opkg/*.conf\fP
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.get_repo repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.hold(name=None, pkgs=None, sources=None, **kwargs)
Set package in \(aqhold\(aq state, meaning it will not be upgraded.
.INDENT 7.0
.TP
.B name
The name of the package, e.g., \(aqtmux\(aq
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.hold <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B pkgs
A list of packages to hold. Must be passed as a python list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.hold pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.info_installed(*names, **kwargs)
Return the information of the named package(s), installed on the system.
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnames\fP \-\- Names of the packages to get information about. If none are specified,
will return information for all installed packages.
.IP \(bu 2
\fBattr\fP \-\-
.sp
Comma\-separated package attributes. If no \(aqattr\(aq is specified, all available attributes returned.
.INDENT 2.0
.TP
.B Valid attributes are:
arch, conffiles, conflicts, depends, description, filename, group,
install_date_time_t, md5sum, packager, provides, recommends,
replaces, size, source, suggests, url, version
.UNINDENT

.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.info_installed
salt \(aq*\(aq pkg.info_installed attr=version,packager
salt \(aq*\(aq pkg.info_installed <package1>
salt \(aq*\(aq pkg.info_installed <package1> <package2> <package3> ...
salt \(aq*\(aq pkg.info_installed <package1> attr=version,packager
salt \(aq*\(aq pkg.info_installed <package1> <package2> <package3> ... attr=version,packager
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.install(name=None, refresh=False, pkgs=None, sources=None, reinstall=False, **kwargs)
Install the passed package, add refresh=True to update the opkg database.
.INDENT 7.0
.TP
.B name
The name of the package to be installed. Note that this parameter is
ignored if either \(dqpkgs\(dq or \(dqsources\(dq is passed. Additionally, please
note that this option can only be used to install packages from a
software repository. To install a package file manually, use the
\(dqsources\(dq option.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B refresh
Whether or not to refresh the package database before installing.
.TP
.B version
Install a specific version of the package, e.g. 1.2.3~0ubuntu0. Ignored
if \(dqpkgs\(dq or \(dqsources\(dq is passed.
.sp
New in version 2017.7.0.

.TP
.B reinstall
False
Specifying reinstall=True will use \fBopkg install \-\-force\-reinstall\fP
rather than simply \fBopkg install\fP for requested packages that are
already installed.
.sp
If a version is specified with the requested package, then \fBopkg
install \-\-force\-reinstall\fP will only be used if the installed version
matches the requested version.
.sp
New in version 2017.7.0.

.UNINDENT
.sp
Multiple Package Installation Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to install from a software repository. Must be
passed as a python list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, {\(dqbar\(dq: \(dq1.2.3\-0ubuntu0\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B sources
A list of IPK packages to install. Must be passed as a list of dicts,
with the keys being package names, and the values being the source URI
or local path to the package.  Dependencies are automatically resolved
and marked as auto\-installed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install sources=\(aq[{\(dqfoo\(dq: \(dqsalt://foo.deb\(dq},{\(dqbar\(dq: \(dqsalt://bar.deb\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B install_recommends
Whether to install the packages marked as recommended. Default is True.
.TP
.B only_upgrade
Only upgrade the packages (disallow downgrades), if they are already
installed. Default is False.
.sp
New in version 2017.7.0.

.UNINDENT
.sp
Returns a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.latest_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.list_pkgs(versions_as_list=False, **kwargs)
List the packages currently installed in a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
salt \(aq*\(aq pkg.list_pkgs versions_as_list=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.list_repos(**kwargs)
Lists all repos on \fB/etc/opkg/*.conf\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_repos
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.list_upgrades(refresh=True, **kwargs)
List all available package upgrades.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.mod_repo(repo, **kwargs)
Modify one or more values for a repo.  If the repo does not exist, it will
be created, so long as uri is defined.
.sp
The following options are available to modify a repo definition:
.INDENT 7.0
.TP
.B repo
alias by which opkg refers to the repo.
.TP
.B uri
the URI to the repo.
.TP
.B compressed
defines (True or False) if the index file is compressed
.TP
.B enabled
enable or disable (True or False) repository
but do not remove if disabled.
.TP
.B refresh
enable or disable (True or False) auto\-refresh of the repositories
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.mod_repo repo uri=http://new/uri
salt \(aq*\(aq pkg.mod_repo repo enabled=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.owner(*paths, **kwargs)
Return the name of the package that owns the file. Multiple file paths can
be passed. Like \fBpkg.version <salt.modules.opkg.version\fP, if a single
path is passed, a string will be returned, and if multiple paths are passed,
a dictionary of file/package name pairs will be returned.
.sp
If the file is not owned by a package, or is not present on the minion,
then an empty string will be returned for that path.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.owner /usr/bin/apachectl
salt \(aq*\(aq pkg.owner /usr/bin/apachectl /usr/bin/basename
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.purge(name=None, pkgs=None, **kwargs)
Package purges are not supported by opkg, this function is identical to
\fI\%pkg.remove\fP\&.
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.purge <package name>
salt \(aq*\(aq pkg.purge <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.purge pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.refresh_db(failhard=False, **kwargs)
Updates the opkg database to latest packages based upon repositories
.sp
Returns a dict, with the keys being package databases and the values being
the result of the update attempt. Values can be one of the following:
.INDENT 7.0
.IP \(bu 2
\fBTrue\fP: Database updated successfully
.IP \(bu 2
\fBFalse\fP: Problem updating database
.UNINDENT
.INDENT 7.0
.TP
.B failhard
If False, return results of failed lines as \fBFalse\fP for the package
database that encountered the error.
If True, raise an error with a list of the package databases that
encountered errors.
.sp
New in version 2018.3.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.remove(name=None, pkgs=None, **kwargs)
Remove packages using \fBopkg remove\fP\&.
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.TP
.B remove_dependencies
Remove package and all dependencies
.sp
New in version 2019.2.0.

.TP
.B auto_remove_deps
Remove packages that were installed automatically to satisfy dependencies
.sp
New in version 2019.2.0.

.UNINDENT
.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq remove_dependencies=True auto_remove_deps=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.unhold(name=None, pkgs=None, sources=None, **kwargs)
Set package current in \(aqhold\(aq state to install state,
meaning it will be upgraded.
.INDENT 7.0
.TP
.B name
The name of the package, e.g., \(aqtmux\(aq
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.unhold <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B pkgs
A list of packages to hold. Must be passed as a python list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.unhold pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.upgrade(refresh=True, **kwargs)
Upgrades all packages via \fBopkg upgrade\fP
.sp
Returns a dictionary containing the changes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq:  {\(aqold\(aq: \(aq<old\-version>\(aq,
                \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.upgrade_available(name, **kwargs)
Check whether or not an upgrade is available for a given package
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade_available <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.version_clean(version)
Clean the version string removing extra data.
There\(aqs nothing do to here for nipkg.py, therefore it will always
return the given version.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opkg.version_cmp(pkg1, pkg2, ignore_epoch=False, **kwargs)
Do a cmp\-style comparison on two packages. Return \-1 if pkg1 < pkg2, 0 if
pkg1 == pkg2, and 1 if pkg1 > pkg2. Return None if there was a problem
making the comparison.
.INDENT 7.0
.TP
.B ignore_epoch
False
Set to \fBTrue\fP to ignore the epoch when comparing versions
.sp
New in version 2016.3.4.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version_cmp \(aq0.2.4\-0\(aq \(aq0.2.4.1\-0\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.opsgenie
.sp
Module for sending data to OpsGenie
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B configuration
This module can be used in Reactor System for
posting data to OpsGenie as a remote\-execution function.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
opsgenie_event_poster:
  local.opsgenie.post_data:
    \- tgt: \(aqsalt\-minion\(aq
    \- kwarg:
        name: event.reactor
        api_key: XXXXXXXX\-XXXX\-XXXX\-XXXX\-XXXXXXXXXXXX
        reason: {{ data[\(aqdata\(aq][\(aqreason\(aq] }}
        action_type: Create
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.opsgenie.post_data(api_key=None, name=\(aqOpsGenie Execution Module\(aq, reason=None, action_type=None)
Post data to OpsGenie. It\(aqs designed for Salt\(aqs Event Reactor.
.sp
After configuring the sls reaction file as shown above, you can trigger the
module with your designated tag (og\-tag in this case).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call event.send \(aqog\-tag\(aq \(aq{\(dqreason\(dq : \(dqOverheating CPU!\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required parameters:
.INDENT 7.0
.TP
.B api_key
It\(aqs the API Key you\(aqve copied while adding integration in OpsGenie.
.TP
.B reason
It will be used as alert\(aqs default message in OpsGenie.
.TP
.B action_type
OpsGenie supports the default values Create/Close for action_type. You
can customize this field with OpsGenie\(aqs custom actions for other
purposes like adding notes or acknowledging alerts.
.UNINDENT
.sp
Optional parameters:
.INDENT 7.0
.TP
.B name
It will be used as alert\(aqs alias. If you want to use the close
functionality you must provide name field for both states like in
this case.
.UNINDENT
.UNINDENT
.SS salt.modules.oracle
.sp
Oracle DataBase connection module
.INDENT 0.0
.TP
.B maintainer
Vladimir Bormotov <\fI\%bormotov@gmail.com\fP>
.TP
.B maturity
new
.TP
.B depends
cx_Oracle
.TP
.B platform
all
.TP
.B configuration
module provide connections for multiple Oracle DB instances.
.sp
\fBOS Environment\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ORACLE_HOME: path to oracle product
PATH: path to Oracle Client libs need to be in PATH
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBpillar\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
oracle:
  dbs:
    <db>:
      uri: connection credentials in format:
    user/password@host[:port]/sid[ servicename as {sysdba|sysoper}]
      optional keyword servicename will determine whether it is a sid or service_name
    <db>:
      uri: .....
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.oracle.client_version()
Oracle Client Version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq oracle.client_version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.oracle.run_query(db, query)
Run SQL query and return result
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq oracle.run_query my_db \(dqselect * from my_table\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.oracle.show_dbs(*dbs)
Show databases configuration from pillar. Filter by \fI*args\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq oracle.show_dbs
salt \(aq*\(aq oracle.show_dbs my_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.oracle.show_env()
Show Environment used by Oracle Client
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq oracle.show_env
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
at first _connect() \fBNLS_LANG\fP will forced to \(aq.AL32UTF8\(aq
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.oracle.show_pillar(item=None)
Show Pillar segment oracle.* and subitem with notation \(dqitem:subitem\(dq
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq oracle.show_pillar
salt \(aq*\(aq oracle.show_pillar dbs:my_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.oracle.version(*dbs)
Server Version (select banner  from v$version)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq oracle.version
salt \(aq*\(aq oracle.version my_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.osquery
.sp
Support for OSQuery \- \fI\%https://osquery.io\fP\&.
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B salt.modules.osquery.acpi_tables(attrs=None, where=None)
Return acpi_tables information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.acpi_tables
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.alf(attrs=None, where=None)
Return alf information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.alf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.alf_exceptions(attrs=None, where=None)
Return alf_exceptions information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.alf_exceptions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.alf_explicit_auths(attrs=None, where=None)
Return alf_explicit_auths information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.alf_explicit_auths
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.alf_services(attrs=None, where=None)
Return alf_services information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.alf_services
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.apps(attrs=None, where=None)
Return apps information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.apps
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.apt_sources(attrs=None, where=None)
Return apt_sources information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.apt_sources
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.arp_cache(attrs=None, where=None)
Return arp_cache information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.arp_cache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.block_devices(attrs=None, where=None)
Return block_devices information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.block_devices
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.certificates(attrs=None, where=None)
Return certificates information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.certificates
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.chrome_extensions(attrs=None, where=None)
Return chrome_extensions information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.chrome_extensions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.cpuid(attrs=None, where=None)
Return cpuid information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.cpuid
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.crontab(attrs=None, where=None)
Return crontab information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.crontab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.deb_packages(attrs=None, where=None)
Return deb_packages information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.deb_packages
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.etc_hosts(attrs=None, where=None)
Return etc_hosts information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.etc_hosts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.etc_services(attrs=None, where=None)
Return etc_services information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.etc_services
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.file_(attrs=None, where=None)
Return file information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.file_changes(attrs=None, where=None)
Return file_changes information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.file_changes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.firefox_addons(attrs=None, where=None)
Return firefox_addons information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.firefox_addons
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.groups(attrs=None, where=None)
Return groups information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.groups
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.hardware_events(attrs=None, where=None)
Return hardware_events information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.hardware_events
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.hash_(attrs=None, where=None)
Return hash information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.hash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.homebrew_packages(attrs=None, where=None)
Return homebrew_packages information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.homebrew_packages
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.interface_addresses(attrs=None, where=None)
Return interface_addresses information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.interface_addresses
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.interface_details(attrs=None, where=None)
Return interface_details information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.interface_details
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.iokit_devicetree(attrs=None, where=None)
Return iokit_devicetree information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.iokit_devicetree
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.iokit_registry(attrs=None, where=None)
Return iokit_registry information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.iokit_registry
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.kernel_extensions(attrs=None, where=None)
Return kernel_extensions information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.kernel_extensions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.kernel_info(attrs=None, where=None)
Return kernel_info information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.kernel_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.kernel_integrity(attrs=None, where=None)
Return kernel_integrity information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.kernel_integrity
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.kernel_modules(attrs=None, where=None)
Return kernel_modules information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.kernel_modules
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.keychain_items(attrs=None, where=None)
Return keychain_items information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.keychain_items
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.last(attrs=None, where=None)
Return last information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.last
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.launchd(attrs=None, where=None)
Return launchd information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.launchd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.listening_ports(attrs=None, where=None)
Return listening_ports information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.listening_ports
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.logged_in_users(attrs=None, where=None)
Return logged_in_users information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.logged_in_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.memory_map(attrs=None, where=None)
Return memory_map information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.memory_map
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.mounts(attrs=None, where=None)
Return mounts information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.mounts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.nfs_shares(attrs=None, where=None)
Return nfs_shares information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.nfs_shares
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.nvram(attrs=None, where=None)
Return nvram information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.nvram
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.os_version(attrs=None, where=None)
Return os_version information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.os_version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.osquery_extensions(attrs=None, where=None)
Return osquery_extensions information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.osquery_extensions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.osquery_flags(attrs=None, where=None)
Return osquery_flags information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.osquery_flags
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.osquery_info(attrs=None, where=None)
Return osquery_info information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.osquery_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.osquery_registry(attrs=None, where=None)
Return osquery_registry information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.osquery_registry
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.passwd_changes(attrs=None, where=None)
Return passwd_changes information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.passwd_changes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.pci_devices(attrs=None, where=None)
Return pci_devices information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.pci_devices
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.preferences(attrs=None, where=None)
Return preferences information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.preferences
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.process_envs(attrs=None, where=None)
Return process_envs information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.process_envs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.process_memory_map(attrs=None, where=None)
Return process_memory_map information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.process_memory_map
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.process_open_files(attrs=None, where=None)
Return process_open_files information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.process_open_files
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.process_open_sockets(attrs=None, where=None)
Return process_open_sockets information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.process_open_sockets
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.processes(attrs=None, where=None)
Return processes information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.processes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.quarantine(attrs=None, where=None)
Return quarantine information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.quarantine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.query(sql=None)
Return time information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.query \(dqselect * from users;\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.routes(attrs=None, where=None)
Return routes information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.routes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.rpm_packages(attrs=None, where=None)
Return cpuid information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.rpm_packages
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.safari_extensions(attrs=None, where=None)
Return safari_extensions information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.safari_extensions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.shared_memory(attrs=None, where=None)
Return shared_memory information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.shared_memory
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.shell_history(attrs=None, where=None)
Return shell_history information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.shell_history
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.smbios_tables(attrs=None, where=None)
Return smbios_tables information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.smbios_tables
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.startup_items(attrs=None, where=None)
Return startup_items information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.startup_items
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.suid_bin(attrs=None, where=None)
Return suid_bin information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.suid_bin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.system_controls(attrs=None, where=None)
Return system_controls information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.system_controls
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.time_(attrs=None)
Return time information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.time
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.usb_devices(attrs=None, where=None)
Return usb_devices information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.usb_devices
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.users(attrs=None, where=None)
Return users information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.version()
Return version of osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.xattr_where_from(attrs=None, where=None)
Return xattr_where_from information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.xattr_where_from
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.xprotect_entries(attrs=None, where=None)
Return xprotect_entries information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.xprotect_entries
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.osquery.xprotect_reports(attrs=None, where=None)
Return xprotect_reports information from osquery
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq osquery.xprotect_reports
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.out
.SS Output Module
.sp
New in version 2018.3.0.

.sp
Execution module that processes JSON serializable data
and returns string having the format as processed by the outputters.
.sp
Although this does not bring much value on the CLI, it turns very handy
in applications that require human readable data rather than Python objects.
.sp
For example, inside a Jinja template:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt.out.string_format(complex_object, out=\(aqhighstate\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.out.html_format(data, out=\(aqnested\(aq, opts=None, **kwargs)
Return the formatted string as HTML.
.INDENT 7.0
.TP
.B data
The JSON serializable object.
.TP
.B out: \fBnested\fP
The name of the output to use to transform the data. Default: \fBnested\fP\&.
.TP
.B opts
Dictionary of configuration options. Default: \fB__opts__\fP\&.
.TP
.B kwargs
Arguments to sent to the outputter module.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq out.html_format \(dq{\(aqkey\(aq: \(aqvalue\(aq}\(dq out=yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.out.out_format(data, out=\(aqnested\(aq, opts=None, **kwargs)
Return the formatted outputter string for the Python object.
.INDENT 7.0
.TP
.B data
The JSON serializable object.
.TP
.B out: \fBnested\fP
The name of the output to use to transform the data. Default: \fBnested\fP\&.
.TP
.B opts
Dictionary of configuration options. Default: \fB__opts__\fP\&.
.TP
.B kwargs
Arguments to sent to the outputter module.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq out.out_format \(dq{\(aqkey\(aq: \(aqvalue\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.out.string_format(data, out=\(aqnested\(aq, opts=None, **kwargs)
Return the outputter formatted string, removing the ANSI escape sequences.
.INDENT 7.0
.TP
.B data
The JSON serializable object.
.TP
.B out: \fBnested\fP
The name of the output to use to transform the data. Default: \fBnested\fP\&.
.TP
.B opts
Dictionary of configuration options. Default: \fB__opts__\fP\&.
.TP
.B kwargs
Arguments to sent to the outputter module.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq out.string_format \(dq{\(aqkey\(aq: \(aqvalue\(aq}\(dq out=table
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pacmanpkg
.sp
A module to wrap pacman calls, since Arch is the best
(\fI\%https://wiki.archlinux.org/index.php/Arch_is_the_best\fP)
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage packages on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.available_version(*names, **kwargs)
This function is an alias of \fBlatest_version\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.file_dict(*packages, **kwargs)
List the files that belong to a package, grouped by package. Not
specifying any packages will return a list of _every_ file on the system\(aqs
package database (not generally recommended).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_list httpd
salt \(aq*\(aq pkg.file_list httpd postfix
salt \(aq*\(aq pkg.file_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.file_list(*packages, **kwargs)
List the files that belong to a package. Not specifying any packages will
return a list of _every_ file on the system\(aqs package database (not
generally recommended).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_list httpd
salt \(aq*\(aq pkg.file_list httpd postfix
salt \(aq*\(aq pkg.file_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.group_diff(name)
New in version 2016.11.0.

.sp
Lists which of a group\(aqs packages are installed and which are not
installed
.sp
Compatible with yumpkg.group_diff for easy support of state.pkg.group_installed
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.group_diff \(aqxorg\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.group_info(name)
New in version 2016.11.0.

.sp
Lists all packages in the specified group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.group_info \(aqxorg\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.group_list()
New in version 2016.11.0.

.sp
Lists all groups known by pacman on this system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.group_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.install(name=None, refresh=False, sysupgrade=None, pkgs=None, sources=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any pacman commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Install (\fBpacman \-S\fP) the specified packag(s). Add \fBrefresh=True\fP to
install with \fB\-y\fP, add \fBsysupgrade=True\fP to install with \fB\-u\fP\&.
.INDENT 7.0
.TP
.B name
The name of the package to be installed. Note that this parameter is
ignored if either \fBpkgs\fP or \fBsources\fP is passed. Additionally,
please note that this option can only be used to install packages from
a software repository. To install a package file manually, use the
\fBsources\fP option.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B refresh
Whether or not to refresh the package database before installing.
.TP
.B sysupgrade
Whether or not to upgrade the system packages before installing.
If refresh is set to \fBTrue\fP but sysupgrade is not specified, \fB\-u\fP will be
applied
.UNINDENT
.sp
Multiple Package Installation Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to install from a software repository. Must be
passed as a python list. A specific version number can be specified
by using a single\-element dict representing the package and its
version. As with the \fBversion\fP parameter above, comparison operators
can be used to target a specific version of a package.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, {\(dqbar\(dq: \(dq1.2.3\-4\(dq}]\(aq
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, {\(dqbar\(dq: \(dq<1.2.3\-4\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B sources
A list of packages to install. Must be passed as a list of dicts,
with the keys being package names, and the values being the source URI
or local path to the package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install                 sources=\(aq[{\(dqfoo\(dq: \(dqsalt://foo.pkg.tar.xz\(dq},                 {\(dqbar\(dq: \(dqsalt://bar.pkg.tar.xz\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Returns a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.latest_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.list_pkgs(versions_as_list=False, **kwargs)
List the packages currently installed as a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.list_repo_pkgs(*args, **kwargs)
Returns all available packages. Optionally, package names (and name globs)
can be passed and the results will be filtered to packages matching those
names.
.sp
This function can be helpful in discovering the version or repo to specify
in a \fI\%pkg.installed\fP state.
.sp
The return data will be a dictionary mapping package names to a list of
version numbers, ordered from newest to oldest. If \fBbyrepo\fP is set to
\fBTrue\fP, then the return dictionary will contain repository names at the
top level, and each repository will map packages to lists of version
numbers. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# With byrepo=False (default)
{
    \(aqbash\(aq: [\(aq4.4.005\-2\(aq],
    \(aqnginx\(aq: [\(aq1.10.2\-2\(aq]
}
# With byrepo=True
{
    \(aqcore\(aq: {
        \(aqbash\(aq: [\(aq4.4.005\-2\(aq]
    },
    \(aqextra\(aq: {
        \(aqnginx\(aq: [\(aq1.10.2\-2\(aq]
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B fromrepo
None
Only include results from the specified repo(s). Multiple repos can be
specified, comma\-separated.
.TP
.B byrepo
False
When \fBTrue\fP, the return data for each package will be organized by
repository.
.TP
.B refresh
False
When \fBTrue\fP, the package database will be refreshed (i.e. \fBpacman
\-Sy\fP) before checking for available versions.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_repo_pkgs
salt \(aq*\(aq pkg.list_repo_pkgs foo bar baz
salt \(aq*\(aq pkg.list_repo_pkgs \(aqsamba4*\(aq fromrepo=base,updates
salt \(aq*\(aq pkg.list_repo_pkgs \(aqpython2\-*\(aq byrepo=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.list_upgrades(refresh=False, root=None, **kwargs)
List all available package upgrades on this system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.owner(*paths, **kwargs)
New in version 2014.7.0.

.sp
Return the name of the package that owns the file. Multiple file paths can
be passed. Like \fI\%pkg.version\fP, if a
single path is passed, a string will be returned, and if multiple paths are
passed, a dictionary of file/package name pairs will be returned.
.sp
If the file is not owned by a package, or is not present on the minion,
then an empty string will be returned for that path.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.owner /usr/bin/apachectl
salt \(aq*\(aq pkg.owner /usr/bin/apachectl /usr/bin/zsh
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.purge(name=None, pkgs=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any pacman commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Recursively remove a package and all dependencies which were installed
with it, this will call a \fBpacman \-Rsc\fP
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.purge <package name>
salt \(aq*\(aq pkg.purge <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.purge pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.refresh_db(root=None, **kwargs)
Just run a \fBpacman \-Sy\fP, return a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<database name>\(aq: Bool}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.remove(name=None, pkgs=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any pacman commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Remove packages with \fBpacman \-R\fP\&.
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.upgrade(refresh=False, root=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any pacman commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Run a full system upgrade, a pacman \-Syu
.INDENT 7.0
.TP
.B refresh
Whether or not to refresh the package database before installing.
.UNINDENT
.sp
Returns a dictionary containing the changes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq:  {\(aqold\(aq: \(aq<old\-version>\(aq,
                \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.upgrade_available(name, **kwargs)
Check whether or not an upgrade is available for a given package
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade_available <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pacmanpkg.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pagerduty
.sp
Module for Firing Events via PagerDuty
.sp
New in version 2014.1.0.

.INDENT 0.0
.TP
.B configuration
This module can be used by specifying the name of a
configuration profile in the minion config, minion pillar, or master
config.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my\-pagerduty\-account:
    pagerduty.api_key: F3Rbyjbve43rfFWf2214
    pagerduty.subdomain: mysubdomain
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty.create_event(service_key=None, description=None, details=None, incident_key=None, profile=None)
Create an event in PagerDuty. Designed for use in states.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pagerduty.create_event <service_key> <description> <details>         profile=my\-pagerduty\-account
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B service_key
This key can be found by using pagerduty.list_services.
.TP
.B description
This is a short description of the event.
.TP
.B details
This can be a more detailed description of the event.
.TP
.B profile
This refers to the configuration profile to use to connect to the
PagerDuty service.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty.list_escalation_policies(profile=None, api_key=None)
This function is an alias of \fBlist_policies\fP\&.
.INDENT 7.0
.INDENT 3.5
List escalation policies belonging to this account
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pagerduty.list_policies my\-pagerduty\-account
salt myminion pagerduty.list_escalation_policies my\-pagerduty\-account
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty.list_incidents(profile=None, api_key=None)
List incidents belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pagerduty.list_incidents my\-pagerduty\-account
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty.list_maintenance_windows(profile=None, api_key=None)
This function is an alias of \fBlist_windows\fP\&.
.INDENT 7.0
.INDENT 3.5
List maintenance windows belonging to this account
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pagerduty.list_windows my\-pagerduty\-account
salt myminion pagerduty.list_maintenance_windows my\-pagerduty\-account
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty.list_policies(profile=None, api_key=None)
List escalation policies belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pagerduty.list_policies my\-pagerduty\-account
salt myminion pagerduty.list_escalation_policies my\-pagerduty\-account
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty.list_schedules(profile=None, api_key=None)
List schedules belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pagerduty.list_schedules my\-pagerduty\-account
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty.list_services(profile=None, api_key=None)
List services belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pagerduty.list_services my\-pagerduty\-account
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty.list_users(profile=None, api_key=None)
List users belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pagerduty.list_users my\-pagerduty\-account
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty.list_windows(profile=None, api_key=None)
List maintenance windows belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pagerduty.list_windows my\-pagerduty\-account
salt myminion pagerduty.list_maintenance_windows my\-pagerduty\-account
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pagerduty_util
.sp
Module for manageing PagerDuty resource
.INDENT 0.0
.TP
.B configuration
This module can be used by specifying the name of a
configuration profile in the minion config, minion pillar, or master
config.  The default configuration profile name is \(aqpagerduty.\(aq
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pagerduty:
    pagerduty.api_key: F3Rbyjbve43rfFWf2214
    pagerduty.subdomain: mysubdomain
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
For PagerDuty API details, see \fI\%https://developer.pagerduty.com/documentation/rest\fP
.INDENT 0.0
.TP
.B salt.modules.pagerduty_util.create_or_update_resource(resource_name, identifier_fields, data, diff=None, profile=\(aqpagerduty\(aq, subdomain=None, api_key=None)
create or update any pagerduty resource
Helper method for present().
.sp
Determining if two resources are the same is different for different PD resource, so this method accepts a diff function.
The diff function will be invoked as diff(state_information, object_returned_from_pagerduty), and
should return a dict of data to pass to the PagerDuty update API method, or None if no update
is to be performed.  If no diff method is provided, the default behavor is to scan the keys in the state_information,
comparing the matching values in the object_returned_from_pagerduty, and update any values that differ.
.sp
Examples
.sp
create_or_update_resource(\(dquser\(dq, [\(dqid\(dq,\(dqname\(dq,\(dqemail\(dq])
create_or_update_resource(\(dqescalation_policies\(dq, [\(dqid\(dq,\(dqname\(dq], diff=my_diff_function)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty_util.delete_resource(resource_name, key, identifier_fields, profile=\(aqpagerduty\(aq, subdomain=None, api_key=None)
delete any pagerduty resource
.sp
Helper method for absent()
.sp
Example
.sp
delete_resource(\(dqusers\(dq, key, [\(dqid\(dq,\(dqname\(dq,\(dqemail\(dq]) # delete by id or name or email
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty_util.get_escalation_policies(profile=\(aqpagerduty\(aq, subdomain=None, api_key=None)
List escalation_policies belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pagerduty.get_escalation_policies
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty_util.get_resource(resource_name, key, identifier_fields, profile=\(aqpagerduty\(aq, subdomain=None, api_key=None)
Get any single pagerduty resource by key.
.sp
We allow flexible lookup by any of a list of identifier_fields.
So, for example, you can look up users by email address or name by calling:
.INDENT 7.0
.INDENT 3.5
get_resource(\(aqusers\(aq, key, [\(aqname\(aq, \(aqemail\(aq], ...)
.UNINDENT
.UNINDENT
.sp
This method is mainly used to translate state sls into pagerduty id\(aqs for dependent objects.
For example, a pagerduty escalation policy contains one or more schedules, which must be passed
by their pagerduty id.  We look up the schedules by name (using this method), and then translate
the names into id\(aqs.
.sp
This method is implemented by getting all objects of the resource type (cached into __context__),
then brute force searching through the list and trying to match any of the identifier_fields.
The __context__ cache is purged after any create, update or delete to the resource.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty_util.get_schedules(profile=\(aqpagerduty\(aq, subdomain=None, api_key=None)
List schedules belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pagerduty.get_schedules
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty_util.get_services(profile=\(aqpagerduty\(aq, subdomain=None, api_key=None)
List services belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pagerduty.get_services
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty_util.get_users(profile=\(aqpagerduty\(aq, subdomain=None, api_key=None)
List users belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pagerduty.get_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty_util.resource_absent(resource, identifier_fields, profile=\(aqpagerduty\(aq, subdomain=None, api_key=None, **kwargs)
Generic resource.absent state method.   Pagerduty state modules should be a thin wrapper over this method,
with a custom diff function.
.sp
This method calls delete_resource() and formats the result as a salt state return value.
.sp
Example
.sp
resource_absent(\(dqusers\(dq, [\(dqid\(dq,\(dqname\(dq,\(dqemail\(dq])
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pagerduty_util.resource_present(resource, identifier_fields, diff=None, profile=\(aqpagerduty\(aq, subdomain=None, api_key=None, **kwargs)
Generic resource.present state method.   Pagerduty state modules should be a thin wrapper over this method,
with a custom diff function.
.sp
This method calls create_or_update_resource() and formats the result as a salt state return value.
.sp
Example
.sp
resource_present(\(dqusers\(dq, [\(dqid\(dq,\(dqname\(dq,\(dqemail\(dq])
.UNINDENT
.SS salt.modules.pam
.sp
Support for pam
.INDENT 0.0
.TP
.B salt.modules.pam.read_file(file_name)
This is just a test function, to make sure parsing works
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pam.read_file /etc/pam.d/login
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.panos
.sp
Module to provide Palo Alto compatibility to Salt
.INDENT 0.0
.TP
.B codeauthor
\fBSpencer Ervin <spencer_ervin@hotmail.com>\fP
.TP
.B maturity
new
.TP
.B depends
none
.TP
.B platform
unix
.UNINDENT
.sp
New in version 2018.3.0.

.SS Configuration
.sp
This module accepts connection configuration details either as
parameters, or as configuration settings in pillar as a Salt proxy.
Options passed into opts will be ignored if options are passed into pillar.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Palo Alto Proxy Module\fP
.UNINDENT
.UNINDENT
.SS About
.sp
This execution module was designed to handle connections to a Palo Alto based
firewall. This module adds support to send connections directly to the device
through the XML API or through a brokered connection to Panorama.
.INDENT 0.0
.TP
.B salt.modules.panos.add_config_lock()
Prevent other users from changing configuration until the lock is released.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.add_config_lock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.check_antivirus()
Get anti\-virus information from PaloAlto Networks server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.check_antivirus
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.check_software()
Get software information from PaloAlto Networks server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.check_software
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.clear_commit_tasks()
Clear all commit tasks.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.clear_commit_tasks
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.commit()
Commits the candidate configuration to the running configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.commit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.deactivate_license(key_name=None)
Deactivates an installed license.
Required version 7.0.0 or greater.
.sp
key_name(str): The file name of the license key installed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.deactivate_license key_name=License_File_Name.key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.delete_license(key_name=None)
Remove license keys on disk.
.sp
key_name(str): The file name of the license key to be deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.delete_license key_name=License_File_Name.key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.download_antivirus()
Download the most recent anti\-virus package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.download_antivirus
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.download_software_file(filename=None, synch=False)
Download software packages by filename.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfilename\fP (\fI\%str\fP) \-\- The filename of the PANOS file to download.
.IP \(bu 2
\fBsynch\fP (\fI\%bool\fP) \-\- If true then the file will synch to the peer unit.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.download_software_file PanOS_5000\-8.0.0
salt \(aq*\(aq panos.download_software_file PanOS_5000\-8.0.0 True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.download_software_version(version=None, synch=False)
Download software packages by version number.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\- The version of the PANOS file to download.
.IP \(bu 2
\fBsynch\fP (\fI\%bool\fP) \-\- If true then the file will synch to the peer unit.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.download_software_version 8.0.0
salt \(aq*\(aq panos.download_software_version 8.0.0 True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.fetch_license(auth_code=None)
Get new license(s) using from the Palo Alto Network Server.
.INDENT 7.0
.TP
.B auth_code
The license authorization code.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.fetch_license
salt \(aq*\(aq panos.fetch_license auth_code=foobar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_address(address=None, vsys=\(aq1\(aq)
Get the candidate configuration for the specified get_address object. This will not return address objects that are
marked as pre\-defined objects.
.sp
address(str): The name of the address object.
.sp
vsys(str): The string representation of the VSYS ID.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_address myhost
salt \(aq*\(aq panos.get_address myhost 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_address_group(addressgroup=None, vsys=\(aq1\(aq)
Get the candidate configuration for the specified address group. This will not return address groups that are
marked as pre\-defined objects.
.sp
addressgroup(str): The name of the address group.
.sp
vsys(str): The string representation of the VSYS ID.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_address_group foobar
salt \(aq*\(aq panos.get_address_group foobar 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_admins_active()
Show active administrators.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_admins_active
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_admins_all()
Show all administrators.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_admins_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_antivirus_info()
Show information about available anti\-virus packages.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_antivirus_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_arp()
Show ARP information.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_arp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_cli_idle_timeout()
Show timeout information for this administrative session.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_cli_idle_timeout
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_cli_permissions()
Show cli administrative permissions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_cli_permissions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_disk_usage()
Report filesystem disk space usage.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_disk_usage
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_dns_server_config()
Get the DNS server configuration from the candidate configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_dns_server_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_domain_config()
Get the domain name configuration from the candidate configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_domain_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_dos_blocks()
Show the DoS block\-ip table.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_dos_blocks
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_fqdn_cache()
Print FQDNs used in rules and their IPs.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_fqdn_cache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_ha_config()
Get the high availability configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_ha_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_ha_link()
.INDENT 7.0
.INDENT 3.5
Show high\-availability link\-monitoring state.
.sp
CLI Example:
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_ha_link
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_ha_path()
Show high\-availability path\-monitoring state.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_ha_path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_ha_state()
Show high\-availability state information.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_ha_state
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_ha_transitions()
Show high\-availability transition statistic information.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_ha_transitions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_hostname()
Get the hostname of the device.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_interface_counters(name=\(aqall\(aq)
Get the counter statistics for interfaces.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the interface to view. By default, all interface statistics are viewed.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_interface_counters
salt \(aq*\(aq panos.get_interface_counters ethernet1/1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_interfaces(name=\(aqall\(aq)
Show interface information.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the interface to view. By default, all interface statistics are viewed.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_interfaces
salt \(aq*\(aq panos.get_interfaces ethernet1/1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_job(jid=None)
List all a single job by ID.
.INDENT 7.0
.TP
.B jid
The ID of the job to retrieve.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_job jid=15
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_jobs(state=\(aqall\(aq)
List all jobs on the device.
.INDENT 7.0
.TP
.B state
The state of the jobs to display. Valid options are all, pending, or processed. Pending jobs are jobs
that are currently in a running or waiting state. Processed jobs are jobs that have completed
execution.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_jobs
salt \(aq*\(aq panos.get_jobs state=pending
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_lacp()
Show LACP state.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_lacp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_license_info()
Show information about owned license(s).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_license_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_license_tokens()
Show license token files for manual license deactivation.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_license_tokens
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_lldp_config()
Show lldp config for interfaces.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_lldp_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_lldp_counters()
Show lldp counters for interfaces.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_lldp_counters
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_lldp_local()
Show lldp local info for interfaces.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_lldp_local
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_lldp_neighbors()
Show lldp neighbors info for interfaces.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_lldp_neighbors
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_local_admins()
Show all local administrator accounts.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_local_admins
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_logdb_quota()
Report the logdb quotas.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_logdb_quota
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_master_key()
Get the master key properties.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_master_key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_ntp_config()
Get the NTP configuration from the candidate configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_ntp_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_ntp_servers()
Get list of configured NTP servers.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_ntp_servers
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_operational_mode()
Show device operational mode setting.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_operational_mode
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_panorama_status()
Show panorama connection status.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_panorama_status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_permitted_ips()
Get the IP addresses that are permitted to establish management connections to the device.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_permitted_ips
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_platform()
Get the platform model information and limitations.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_platform
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_predefined_application(application=None)
Get the configuration for the specified pre\-defined application object. This will only return pre\-defined
application objects.
.sp
application(str): The name of the pre\-defined application object.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_predefined_application saltstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_security_rule(rulename=None, vsys=\(aq1\(aq)
Get the candidate configuration for the specified security rule.
.sp
rulename(str): The name of the security rule.
.sp
vsys(str): The string representation of the VSYS ID.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_security_rule rule01
salt \(aq*\(aq panos.get_security_rule rule01 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_service(service=None, vsys=\(aq1\(aq)
Get the candidate configuration for the specified service object. This will not return services that are marked
as pre\-defined objects.
.sp
service(str): The name of the service object.
.sp
vsys(str): The string representation of the VSYS ID.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_service tcp\-443
salt \(aq*\(aq panos.get_service tcp\-443 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_service_group(servicegroup=None, vsys=\(aq1\(aq)
Get the candidate configuration for the specified service group. This will not return service groups that are
marked as pre\-defined objects.
.sp
servicegroup(str): The name of the service group.
.sp
vsys(str): The string representation of the VSYS ID.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_service_group foobar
salt \(aq*\(aq panos.get_service_group foobar 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_session_info()
Show device session statistics.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_session_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_snmp_config()
Get the SNMP configuration from the device.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_snmp_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_software_info()
Show information about available software packages.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_software_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_system_date_time()
Get the system date/time.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_system_date_time
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_system_files()
List important files in the system.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_system_files
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_system_info()
Get the system information.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_system_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_system_services()
Show system services.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_system_services
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_system_state(mask=None)
Show the system state variables.
.INDENT 7.0
.TP
.B mask
Filters by a subtree or a wildcard.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_system_state
salt \(aq*\(aq panos.get_system_state mask=cfg.ha.config.enabled
salt \(aq*\(aq panos.get_system_state mask=cfg.ha.*
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_uncommitted_changes()
Retrieve a list of all uncommitted changes on the device.
Requires PANOS version 8.0.0 or greater.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_uncommitted_changes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_users_config()
Get the local administrative user account configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_users_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_vlans()
Show all VLAN information.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_vlans
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_xpath(xpath=\(aq\(aq)
Retrieve a specified xpath from the candidate configuration.
.sp
xpath(str): The specified xpath in the candidate configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_xpath /config/shared/service
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_zone(zone=\(aq\(aq, vsys=\(aq1\(aq)
Get the candidate configuration for the specified zone.
.sp
zone(str): The name of the zone.
.sp
vsys(str): The string representation of the VSYS ID.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_zone trust
salt \(aq*\(aq panos.get_zone trust 2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.get_zones(vsys=\(aq1\(aq)
Get all the zones in the candidate configuration.
.sp
vsys(str): The string representation of the VSYS ID.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.get_zones
salt \(aq*\(aq panos.get_zones 2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.install_antivirus(version=None, latest=False, synch=False, skip_commit=False)
Install anti\-virus packages.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\- The version of the PANOS file to install.
.IP \(bu 2
\fBlatest\fP (\fI\%bool\fP) \-\- If true, the latest anti\-virus file will be installed.
The specified version option will be ignored.
.IP \(bu 2
\fBsynch\fP (\fI\%bool\fP) \-\- If true, the anti\-virus will synch to the peer unit.
.IP \(bu 2
\fBskip_commit\fP (\fI\%bool\fP) \-\- If true, the install will skip committing to the device.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.install_antivirus 8.0.0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.install_license()
Install the license key(s).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.install_license
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.install_software(version=None)
Upgrade to a software package by version.
.INDENT 7.0
.TP
.B Parameters
\fBversion\fP (\fI\%str\fP) \-\- The version of the PANOS file to install.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.install_license 8.0.0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.reboot()
Reboot a running system.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.reboot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.refresh_fqdn_cache(force=False)
Force refreshes all FQDNs used in rules.
.INDENT 7.0
.TP
.B force
Forces all fqdn refresh
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.refresh_fqdn_cache
salt \(aq*\(aq panos.refresh_fqdn_cache force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.remove_config_lock()
Release config lock previously held.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.remove_config_lock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.resolve_address(address=None, vsys=None)
Resolve address to ip address.
Required version 7.0.0 or greater.
.INDENT 7.0
.TP
.B address
Address name you want to resolve.
.TP
.B vsys
The vsys name.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.resolve_address foo.bar.com
salt \(aq*\(aq panos.resolve_address foo.bar.com vsys=2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.save_device_config(filename=None)
Save device configuration to a named file.
.INDENT 7.0
.TP
.B filename
The filename to save the configuration to.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.save_device_config foo.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.save_device_state()
Save files needed to restore device to local disk.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.save_device_state
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.set_authentication_profile(profile=None, deploy=False)
Set the authentication profile of the Palo Alto proxy minion. A commit will be required before this is processed.
.sp
CLI Example:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fI\%str\fP) \-\- The name of the authentication profile to set.
.IP \(bu 2
\fBdeploy\fP (\fI\%bool\fP) \-\- If true then commit the full candidate configuration, if false only set pending change.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.set_authentication_profile foo
salt \(aq*\(aq panos.set_authentication_profile foo deploy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.set_hostname(hostname=None, deploy=False)
Set the hostname of the Palo Alto proxy minion. A commit will be required before this is processed.
.sp
CLI Example:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhostname\fP (\fI\%str\fP) \-\- The hostname to set
.IP \(bu 2
\fBdeploy\fP (\fI\%bool\fP) \-\- If true then commit the full candidate configuration, if false only set pending change.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.set_hostname newhostname
salt \(aq*\(aq panos.set_hostname newhostname deploy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.set_management_http(enabled=True, deploy=False)
Enables or disables the HTTP management service on the device.
.sp
CLI Example:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBenabled\fP (\fI\%bool\fP) \-\- If true the service will be enabled. If false the service will be disabled.
.IP \(bu 2
\fBdeploy\fP (\fI\%bool\fP) \-\- If true then commit the full candidate configuration, if false only set pending change.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.set_management_http
salt \(aq*\(aq panos.set_management_http enabled=False deploy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.set_management_https(enabled=True, deploy=False)
Enables or disables the HTTPS management service on the device.
.sp
CLI Example:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBenabled\fP (\fI\%bool\fP) \-\- If true the service will be enabled. If false the service will be disabled.
.IP \(bu 2
\fBdeploy\fP (\fI\%bool\fP) \-\- If true then commit the full candidate configuration, if false only set pending change.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.set_management_https
salt \(aq*\(aq panos.set_management_https enabled=False deploy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.set_management_icmp(enabled=True, deploy=False)
Enables or disables the ICMP management service on the device.
.sp
CLI Example:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBenabled\fP (\fI\%bool\fP) \-\- If true the service will be enabled. If false the service will be disabled.
.IP \(bu 2
\fBdeploy\fP (\fI\%bool\fP) \-\- If true then commit the full candidate configuration, if false only set pending change.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.set_management_icmp
salt \(aq*\(aq panos.set_management_icmp enabled=False deploy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.set_management_ocsp(enabled=True, deploy=False)
Enables or disables the HTTP OCSP management service on the device.
.sp
CLI Example:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBenabled\fP (\fI\%bool\fP) \-\- If true the service will be enabled. If false the service will be disabled.
.IP \(bu 2
\fBdeploy\fP (\fI\%bool\fP) \-\- If true then commit the full candidate configuration, if false only set pending change.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.set_management_ocsp
salt \(aq*\(aq panos.set_management_ocsp enabled=False deploy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.set_management_snmp(enabled=True, deploy=False)
Enables or disables the SNMP management service on the device.
.sp
CLI Example:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBenabled\fP (\fI\%bool\fP) \-\- If true the service will be enabled. If false the service will be disabled.
.IP \(bu 2
\fBdeploy\fP (\fI\%bool\fP) \-\- If true then commit the full candidate configuration, if false only set pending change.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.set_management_snmp
salt \(aq*\(aq panos.set_management_snmp enabled=False deploy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.set_management_ssh(enabled=True, deploy=False)
Enables or disables the SSH management service on the device.
.sp
CLI Example:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBenabled\fP (\fI\%bool\fP) \-\- If true the service will be enabled. If false the service will be disabled.
.IP \(bu 2
\fBdeploy\fP (\fI\%bool\fP) \-\- If true then commit the full candidate configuration, if false only set pending change.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.set_management_ssh
salt \(aq*\(aq panos.set_management_ssh enabled=False deploy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.set_management_telnet(enabled=True, deploy=False)
Enables or disables the Telnet management service on the device.
.sp
CLI Example:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBenabled\fP (\fI\%bool\fP) \-\- If true the service will be enabled. If false the service will be disabled.
.IP \(bu 2
\fBdeploy\fP (\fI\%bool\fP) \-\- If true then commit the full candidate configuration, if false only set pending change.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.set_management_telnet
salt \(aq*\(aq panos.set_management_telnet enabled=False deploy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.set_ntp_authentication(target=None, authentication_type=None, key_id=None, authentication_key=None, algorithm=None, deploy=False)
Set the NTP authentication of the Palo Alto proxy minion. A commit will be required before this is processed.
.sp
CLI Example:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtarget\fP (\fI\%str\fP) \-\- Determines the target of the authentication. Valid options are primary, secondary, or both.
.IP \(bu 2
\fBauthentication_type\fP (\fI\%str\fP) \-\- The authentication type to be used. Valid options are symmetric, autokey, and none.
.IP \(bu 2
\fBkey_id\fP (\fI\%int\fP) \-\- The NTP authentication key ID.
.IP \(bu 2
\fBauthentication_key\fP (\fI\%str\fP) \-\- The authentication key.
.IP \(bu 2
\fBalgorithm\fP (\fI\%str\fP) \-\- The algorithm type to be used for a symmetric key. Valid options are md5 and sha1.
.IP \(bu 2
\fBdeploy\fP (\fI\%bool\fP) \-\- If true then commit the full candidate configuration, if false only set pending change.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ntp.set_authentication target=both authentication_type=autokey
salt \(aq*\(aq ntp.set_authentication target=primary authentication_type=none
salt \(aq*\(aq ntp.set_authentication target=both authentication_type=symmetric key_id=15 authentication_key=mykey algorithm=md5
salt \(aq*\(aq ntp.set_authentication target=both authentication_type=symmetric key_id=15 authentication_key=mykey algorithm=md5 deploy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.set_ntp_servers(primary_server=None, secondary_server=None, deploy=False)
Set the NTP servers of the Palo Alto proxy minion. A commit will be required before this is processed.
.sp
CLI Example:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprimary_server\fP (\fI\%str\fP) \-\- The primary NTP server IP address or FQDN.
.IP \(bu 2
\fBsecondary_server\fP (\fI\%str\fP) \-\- The secondary NTP server IP address or FQDN.
.IP \(bu 2
\fBdeploy\fP (\fI\%bool\fP) \-\- If true then commit the full candidate configuration, if false only set pending change.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ntp.set_servers 0.pool.ntp.org 1.pool.ntp.org
salt \(aq*\(aq ntp.set_servers primary_server=0.pool.ntp.org secondary_server=1.pool.ntp.org
salt \(aq*\(aq ntp.ser_servers 0.pool.ntp.org 1.pool.ntp.org deploy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.set_permitted_ip(address=None, deploy=False)
Add an IPv4 address or network to the permitted IP list.
.sp
CLI Example:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBaddress\fP (\fI\%str\fP) \-\- The IPv4 address or network to allow access to add to the Palo Alto device.
.IP \(bu 2
\fBdeploy\fP (\fI\%bool\fP) \-\- If true then commit the full candidate configuration, if false only set pending change.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.set_permitted_ip 10.0.0.1
salt \(aq*\(aq panos.set_permitted_ip 10.0.0.0/24
salt \(aq*\(aq panos.set_permitted_ip 10.0.0.1 deploy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.set_timezone(tz=None, deploy=False)
Set the timezone of the Palo Alto proxy minion. A commit will be required before this is processed.
.sp
CLI Example:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtz\fP (\fI\%str\fP) \-\- The name of the timezone to set.
.IP \(bu 2
\fBdeploy\fP (\fI\%bool\fP) \-\- If true then commit the full candidate configuration, if false only set pending change.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.set_timezone UTC
salt \(aq*\(aq panos.set_timezone UTC deploy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.shutdown()
Shutdown a running system.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.shutdown
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.test_fib_route(ip=None, vr=\(aqvr1\(aq)
Perform a route lookup within active route table (fib).
.sp
ip (str): The destination IP address to test.
.sp
vr (str): The name of the virtual router to test.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.test_fib_route 4.2.2.2
salt \(aq*\(aq panos.test_fib_route 4.2.2.2 my\-vr
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.test_security_policy(sourcezone=None, destinationzone=None, source=None, destination=None, protocol=None, port=None, application=None, category=None, vsys=\(aq1\(aq, allrules=False)
Checks which security policy as connection will match on the device.
.sp
sourcezone (str): The source zone matched against the connection.
.sp
destinationzone (str): The destination zone matched against the connection.
.sp
source (str): The source address. This must be a single IP address.
.sp
destination (str): The destination address. This must be a single IP address.
.sp
protocol (int): The protocol number for the connection. This is the numerical representation of the protocol.
.sp
port (int): The port number for the connection.
.sp
application (str): The application that should be matched.
.sp
category (str): The category that should be matched.
.sp
vsys (int): The numerical representation of the VSYS ID.
.sp
allrules (bool): Show all potential match rules until first allow rule.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.test_security_policy sourcezone=trust destinationzone=untrust protocol=6 port=22
salt \(aq*\(aq panos.test_security_policy sourcezone=trust destinationzone=untrust protocol=6 port=22 vsys=2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.panos.unlock_admin(username=None)
Unlocks a locked administrator account.
.INDENT 7.0
.TP
.B username
Username of the administrator.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq panos.unlock_admin username=bob
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.parallels
.sp
Manage Parallels Desktop VMs with \fBprlctl\fP and \fBprlsrvctl\fP\&.  Only some of
the prlctl commands implemented so far.  Of those that have been implemented,
not all of the options may have been provided yet.  For a complete reference,
see the \fI\%Parallels Desktop Reference Guide\fP\&.
.sp
This module requires the prlctl binary to be installed to run most functions.
To run parallels.prlsrvctl, the prlsrvctl binary is required.
.sp
What has not been implemented yet can be accessed through \fBparallels.prlctl\fP
and \fBparallels.prlsrvctl\fP (note the preceding double dash \fB\-\-\fP as
necessary):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.prlctl installtools macvm runas=macdev
salt \-\- \(aq*\(aq parallels.prlctl capture \(aqmacvm \-\-file macvm.display.png\(aq runas=macdev
salt \-\- \(aq*\(aq parallels.prlsrvctl set \(aq\-\-mem\-limit auto\(aq runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.modules.parallels.clone(name, new_name, linked=False, template=False, runas=None)
Clone a VM
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name/ID of VM to clone
.IP \(bu 2
\fBnew_name\fP (\fI\%str\fP) \-\- Name of the new VM
.IP \(bu 2
\fBlinked\fP (\fI\%bool\fP) \-\- Create a linked virtual machine.
.IP \(bu 2
\fBtemplate\fP (\fI\%bool\fP) \-\- Create a virtual machine template instead of a real virtual machine.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.clone macvm macvm_new runas=macdev
salt \(aq*\(aq parallels.clone macvm macvm_templ template=True runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.delete(name, runas=None)
Delete a VM
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name/ID of VM to clone
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.exec macvm \(aqfind /etc/paths.d\(aq runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.delete_snapshot(name, snap_name, runas=None, all=False)
Delete a snapshot
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Deleting a snapshot from which other snapshots are dervied will not
delete the derived snapshots
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name/ID of VM whose snapshot will be deleted
.IP \(bu 2
\fBsnap_name\fP (\fI\%str\fP) \-\- Name/ID of snapshot to delete
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.IP \(bu 2
\fBall\fP (\fI\%bool\fP) \-\-
.sp
Delete all snapshots having the name given
.sp
New in version 2016.11.0.


.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.delete_snapshot macvm \(aqunneeded snapshot\(aq runas=macdev
salt \(aq*\(aq parallels.delete_snapshot macvm \(aqSnapshot for linked clone\(aq all=True runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.exec_(name, command, runas=None)
Run a command on a VM
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name/ID of VM whose exec will be returned
.IP \(bu 2
\fBcommand\fP (\fI\%str\fP) \-\- Command to run on the VM
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.exec macvm \(aqfind /etc/paths.d\(aq runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.exists(name, runas=None)
Query whether a VM exists
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name/ID of VM
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.exists macvm runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.list_snapshots(name, snap_name=None, tree=False, names=False, runas=None)
List the snapshots
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name/ID of VM whose snapshots will be listed
.IP \(bu 2
\fBsnap_id\fP (\fI\%str\fP) \-\- Name/ID of snapshot to display information about.  If \fBtree=True\fP is
also specified, display the snapshot subtree having this snapshot as
the root snapshot
.IP \(bu 2
\fBtree\fP (\fI\%bool\fP) \-\- List snapshots in tree format rather than tabular format
.IP \(bu 2
\fBnames\fP (\fI\%bool\fP) \-\- List snapshots as ID, name pairs
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.list_snapshots macvm runas=macdev
salt \(aq*\(aq parallels.list_snapshots macvm tree=True runas=macdev
salt \(aq*\(aq parallels.list_snapshots macvm snap_name=original runas=macdev
salt \(aq*\(aq parallels.list_snapshots macvm names=True runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.list_vms(name=None, info=False, all=False, args=None, runas=None, template=False)
List information about the VMs
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\-
.sp
Name/ID of VM to list
.sp
Changed in version 2016.11.0: No longer implies \fBinfo=True\fP


.IP \(bu 2
\fBinfo\fP (\fI\%str\fP) \-\- List extra information
.IP \(bu 2
\fBall\fP (\fI\%bool\fP) \-\- List all non\-template VMs
.IP \(bu 2
\fBargs\fP (\fI\%tuple\fP) \-\- Additional arguments given to \fBprctl list\fP
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.IP \(bu 2
\fBtemplate\fP (\fI\%bool\fP) \-\-
.sp
List the available virtual machine templates.  The real virtual
machines will not be included in the output
.sp
New in version 2016.11.0.


.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.list_vms runas=macdev
salt \(aq*\(aq parallels.list_vms name=macvm info=True runas=macdev
salt \(aq*\(aq parallels.list_vms info=True runas=macdev
salt \(aq*\(aq parallels.list_vms \(aq \-o uuid,status\(aq all=True runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.prlctl(sub_cmd, args=None, runas=None)
Execute a prlctl command
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsub_cmd\fP (\fI\%str\fP) \-\- prlctl subcommand to execute
.IP \(bu 2
\fBargs\fP (\fI\%str\fP) \-\- The arguments supplied to \fBprlctl <sub_cmd>\fP
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.prlctl user list runas=macdev
salt \(aq*\(aq parallels.prlctl exec \(aqmacvm uname\(aq runas=macdev
salt \-\- \(aq*\(aq parallels.prlctl capture \(aqmacvm \-\-file macvm.display.png\(aq runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.prlsrvctl(sub_cmd, args=None, runas=None)
Execute a prlsrvctl command
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsub_cmd\fP (\fI\%str\fP) \-\- prlsrvctl subcommand to execute
.IP \(bu 2
\fBargs\fP (\fI\%str\fP) \-\- The arguments supplied to \fBprlsrvctl <sub_cmd>\fP
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlsrvctl command will be run as
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.prlsrvctl info runas=macdev
salt \(aq*\(aq parallels.prlsrvctl usb list runas=macdev
salt \-\- \(aq*\(aq parallels.prlsrvctl set \(aq\-\-mem\-limit auto\(aq runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.reset(name, runas=None)
Reset a VM by performing a hard shutdown and then a restart
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name/ID of VM to reset
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.reset macvm runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.restart(name, runas=None)
Restart a VM by gracefully shutting it down and then restarting
it
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name/ID of VM to restart
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.restart macvm runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.revert_snapshot(name, snap_name, runas=None)
Revert a VM to a snapshot
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name/ID of VM to revert to a snapshot
.IP \(bu 2
\fBsnap_name\fP (\fI\%str\fP) \-\- Name/ID of snapshot to revert to
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.revert_snapshot macvm base\-with\-updates runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.snapshot(name, snap_name=None, desc=None, runas=None)
Create a snapshot
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name/ID of VM to take a snapshot of
.IP \(bu 2
\fBsnap_name\fP (\fI\%str\fP) \-\- Name of snapshot
.IP \(bu 2
\fBdesc\fP (\fI\%str\fP) \-\- Description of snapshot
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.create_snapshot macvm snap_name=macvm\-original runas=macdev
salt \(aq*\(aq parallels.create_snapshot macvm snap_name=macvm\-updates desc=\(aqclean install with updates\(aq runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.snapshot_id_to_name(name, snap_id, strict=False, runas=None)
Attempt to convert a snapshot ID to a snapshot name.  If the snapshot has
no name or if the ID is not found or invalid, an empty string will be returned
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name/ID of VM whose snapshots are inspected
.IP \(bu 2
\fBsnap_id\fP (\fI\%str\fP) \-\- ID of the snapshot
.IP \(bu 2
\fBstrict\fP (\fI\%bool\fP) \-\- Raise an exception if a name cannot be found for the given \fBsnap_id\fP
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.UNINDENT
.UNINDENT
.sp
Example data
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ID: {a5b8999f\-5d95\-4aff\-82de\-e515b0101b66}
Name: original
Date: 2016\-03\-04 10:50:34
Current: yes
State: poweroff
Description: original state
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.snapshot_id_to_name macvm a5b8999f\-5d95\-4aff\-82de\-e515b0101b66 runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.snapshot_name_to_id(name, snap_name, strict=False, runas=None)
Attempt to convert a snapshot name to a snapshot ID.  If the name is not
found an empty string is returned.  If multiple snapshots share the same
name, a list will be returned
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name/ID of VM whose snapshots are inspected
.IP \(bu 2
\fBsnap_name\fP (\fI\%str\fP) \-\- Name of the snapshot
.IP \(bu 2
\fBstrict\fP (\fI\%bool\fP) \-\- Raise an exception if multiple snapshot IDs are found
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.snapshot_id_to_name macvm original runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.start(name, runas=None)
Start a VM
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name/ID of VM to start
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.start macvm runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.status(name, runas=None)
Status of a VM
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name/ID of VM whose status will be returned
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.status macvm runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parallels.stop(name, kill=False, runas=None)
Stop a VM
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name/ID of VM to stop
.IP \(bu 2
\fBkill\fP (\fI\%bool\fP) \-\- Perform a hard shutdown
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq parallels.stop macvm runas=macdev
salt \(aq*\(aq parallels.stop macvm kill=True runas=macdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.parted_partition
.sp
Module for managing partitions on POSIX\-like systems.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
parted, partprobe, lsblk (usually parted and util\-linux packages)
.UNINDENT
.UNINDENT
.sp
Some functions may not be available, depending on your version of parted.
.sp
Check the manpage for \fBparted(8)\fP for more information, or the online docs
at:
.sp
\fI\%http://www.gnu.org/software/parted/manual/html_chapter/parted_2.html\fP
.sp
In light of parted not directly supporting partition IDs, some of this module
has been written to utilize sfdisk instead. For further information, please
reference the man page for \fBsfdisk(8)\fP\&.
.INDENT 0.0
.TP
.B salt.modules.parted_partition.align_check(device, part_type, partition)
Check if partition satisfies the alignment constraint of part_type.
Type must be \(dqminimal\(dq or \(dqoptimal\(dq.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.align_check /dev/sda minimal 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.check(device, minor)
Checks if the file system on partition <minor> has any errors.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.check 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.cp(device, from_minor, to_minor)
Copies the file system on the partition <from\-minor> to partition
<to\-minor>, deleting the original contents of the destination
partition.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.cp /dev/sda 2 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.disk_set(device, flag, state)
Changes a flag on selected device.
.sp
A flag can be either \(dqon\(dq or \(dqoff\(dq (make sure to use proper
quoting, see \fI\%YAML Idiosyncrasies\fP). Some or all of these flags will be
available, depending on what disk label you are using.
.INDENT 7.0
.TP
.B Valid flags are:
.INDENT 7.0
.IP \(bu 2
cylinder_alignment
.IP \(bu 2
pmbr_boot
.IP \(bu 2
implicit_partition_table
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.disk_set /dev/sda pmbr_boot \(aq\(dqon\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.disk_toggle(device, flag)
Toggle the state of <flag> on <device>. Valid flags are the same
as the disk_set command.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.disk_toggle /dev/sda pmbr_boot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.exists(device=\(aq\(aq)
Check to see if the partition exists
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.exists /dev/sdb1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.get_block_device()
Retrieve a list of disk devices
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.get_block_device
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.get_id(device, minor)
Prints the system ID for the partition. Some typical values are:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
 b: FAT32 (vfat)
 7: HPFS/NTFS
82: Linux Swap
83: Linux
8e: Linux LVM
fd: Linux RAID Auto
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.get_id /dev/sda 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.list_(device, unit=None)
Prints partition information of given <device>
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.list /dev/sda
salt \(aq*\(aq partition.list /dev/sda unit=s
salt \(aq*\(aq partition.list /dev/sda unit=kB
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.mkfs(device, fs_type)
Makes a file system <fs_type> on partition <device>, destroying all data
that resides on that partition. <fs_type> must be one of \(dqext2\(dq, \(dqfat32\(dq,
\(dqfat16\(dq, \(dqlinux\-swap\(dq or \(dqreiserfs\(dq (if libreiserfs is installed)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.mkfs /dev/sda2 fat32
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.mklabel(device, label_type)
Create a new disklabel (partition table) of label_type.
.sp
Type should be one of \(dqaix\(dq, \(dqamiga\(dq, \(dqbsd\(dq, \(dqdvh\(dq, \(dqgpt\(dq, \(dqloop\(dq, \(dqmac\(dq,
\(dqmsdos\(dq, \(dqpc98\(dq, or \(dqsun\(dq.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.mklabel /dev/sda msdos
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.mkpart(device, part_type, fs_type=None, start=None, end=None)
Make a part_type partition for filesystem fs_type, beginning at start and
ending at end (by default in megabytes).  part_type should be one of
\(dqprimary\(dq, \(dqlogical\(dq, or \(dqextended\(dq.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.mkpart /dev/sda primary fs_type=fat32 start=0 end=639
salt \(aq*\(aq partition.mkpart /dev/sda primary start=0 end=639
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.mkpartfs(device, part_type, fs_type=None, start=None, end=None)
The mkpartfs actually is an alias to mkpart and is kept for compatibility.
To know the valid options and usage syntax read mkpart documentation.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.mkpartfs /dev/sda primary fs_type=fat32 start=0 end=639
salt \(aq*\(aq partition.mkpartfs /dev/sda primary start=0 end=639
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.name(device, partition, name)
Set the name of partition to name. This option works only on Mac, PC98, and
GPT disklabels. The name can be placed in quotes, if necessary.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.name /dev/sda 1 \(aqMy Documents\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.probe(*devices)
Ask the kernel to update its local partition data. When no args are
specified all block devices are tried.
.sp
Caution: Generally only works on devices with no mounted partitions and
may take a long time to return if specified devices are in use.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.probe
salt \(aq*\(aq partition.probe /dev/sda
salt \(aq*\(aq partition.probe /dev/sda /dev/sdb
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.rescue(device, start, end)
Rescue a lost partition that was located somewhere between start and end.
If a partition is found, parted will ask if you want to create an
entry for it in the partition table.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.rescue /dev/sda 0 8056
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.resize(device, minor, start, end)
Resizes the partition with number <minor>.
.sp
The partition will start <start> from the beginning of the disk, and end
<end> from the beginning of the disk. resize never changes the minor number.
Extended partitions can be resized, so long as the new extended partition
completely contains all logical partitions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.resize /dev/sda 3 200 850
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.rm(device, minor)
Removes the partition with number <minor>.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.rm /dev/sda 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.set_(device, minor, flag, state)
Changes a flag on the partition with number <minor>.
.sp
A flag can be either \(dqon\(dq or \(dqoff\(dq (make sure to use proper quoting, see
\fI\%YAML Idiosyncrasies\fP). Some or all of these
flags will be available, depending on what disk label you are using.
.INDENT 7.0
.TP
.B Valid flags are:
.INDENT 7.0
.IP \(bu 2
boot
.IP \(bu 2
root
.IP \(bu 2
swap
.IP \(bu 2
hidden
.IP \(bu 2
raid
.IP \(bu 2
lvm
.IP \(bu 2
lba
.IP \(bu 2
hp\-service
.IP \(bu 2
palo
.IP \(bu 2
prep
.IP \(bu 2
msftres
.IP \(bu 2
bios_grub
.IP \(bu 2
atvrecv
.IP \(bu 2
diag
.IP \(bu 2
legacy_boot
.IP \(bu 2
msftdata
.IP \(bu 2
irst
.IP \(bu 2
esp
.IP \(bu 2
type
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.set /dev/sda 1 boot \(aq\(dqon\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.set_id(device, minor, system_id)
Sets the system ID for the partition. Some typical values are:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
 b: FAT32 (vfat)
 7: HPFS/NTFS
82: Linux Swap
83: Linux
8e: Linux LVM
fd: Linux RAID Auto
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.set_id /dev/sda 1 83
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.system_types()
List the system types that are supported by the installed version of sfdisk
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.system_types
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.parted_partition.toggle(device, partition, flag)
.INDENT 7.0
.TP
.B Toggle the state of <flag> on <partition>. Valid flags are the same as
the set command.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq partition.toggle /dev/sda 1 boot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pcs
.SS Configure a Pacemaker/Corosync cluster with PCS
.sp
Configure Pacemaker/Cororsync clusters with the
Pacemaker/Cororsync conifguration system (PCS)
.INDENT 0.0
.TP
.B depends
pcs
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.modules.pcs.auth(nodes, pcsuser=\(aqhacluster\(aq, pcspasswd=\(aqhacluster\(aq, extra_args=None)
Authorize nodes to the cluster
.INDENT 7.0
.TP
.B nodes
a list of nodes which should be authorized to the cluster
.TP
.B pcsuser
user for communitcation with PCS (default: hacluster)
.TP
.B pcspasswd
password for pcsuser (default: hacluster)
.TP
.B extra_args
list of extra option for the \(aqpcs cluster auth\(aq command. The newer cluster host command has no extra args and so will ignore it.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pcs.auth nodes=\(aq[ node1.example.org, node2.example.org ]\(aq pcsuser=hacluster pcspasswd=hoonetorg extra_args=[ \(aq\-\-force\(aq ]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pcs.cib_create(cibfile, scope=\(aqconfiguration\(aq, extra_args=None)
Create a CIB\-file from the current CIB of the cluster
.INDENT 7.0
.TP
.B cibfile
name/path of the file containing the CIB
.TP
.B scope
specific section of the CIB (default: configuration)
.TP
.B extra_args
additional options for creating the CIB\-file
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pcs.cib_create cibfile=\(aq/tmp/VIP_apache_1.cib\(aq scope=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pcs.cib_push(cibfile, scope=\(aqconfiguration\(aq, extra_args=None)
Push a CIB\-file as the new CIB to the cluster
.INDENT 7.0
.TP
.B cibfile
name/path of the file containing the CIB
.TP
.B scope
specific section of the CIB (default: configuration)
.TP
.B extra_args
additional options for creating the CIB\-file
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pcs.cib_push cibfile=\(aq/tmp/VIP_apache_1.cib\(aq scope=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pcs.cluster_destroy(extra_args=None)
Destroy corosync cluster using the pcs command
.INDENT 7.0
.TP
.B extra_args
list of extra option for the \(aqpcs cluster destroy\(aq command (only really \-\-all)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pcs.cluster_destroy extra_args=\-\-all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pcs.cluster_node_add(node, extra_args=None)
Add a node to the pacemaker cluster via pcs command
.INDENT 7.0
.TP
.B node
node that should be added
.TP
.B extra_args
list of extra option for the \(aqpcs cluster node add\(aq command
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pcs.cluster_node_add node=node2.example.org
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pcs.cluster_setup(nodes, pcsclustername=\(aqpcscluster\(aq, extra_args=None)
Setup pacemaker cluster via pcs command
.INDENT 7.0
.TP
.B nodes
a list of nodes which should be set up
.TP
.B pcsclustername
Name of the Pacemaker cluster (default: pcscluster)
.TP
.B extra_args
list of extra option for the \(aqpcs cluster setup\(aq command
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pcs.cluster_setup nodes=\(aq[ node1.example.org, node2.example.org ]\(aq pcsclustername=pcscluster
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pcs.config_show(cibfile=None)
Show config of cluster
.INDENT 7.0
.TP
.B cibfile
name/path of the file containing the CIB
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pcs.config_show cibfile=\(aq/tmp/cib_for_galera\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pcs.is_auth(nodes, pcsuser=\(aqhacluster\(aq, pcspasswd=\(aqhacluster\(aq)
Check if nodes are already authorized
.INDENT 7.0
.TP
.B nodes
a list of nodes to be checked for authorization to the cluster
.TP
.B pcsuser
user for communitcation with PCS (default: hacluster)
.TP
.B pcspasswd
password for pcsuser (default: hacluster)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pcs.is_auth nodes=\(aq[node1.example.org, node2.example.org]\(aq pcsuser=hacluster pcspasswd=hoonetorg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pcs.item_create(item, item_id, item_type, create=\(aqcreate\(aq, extra_args=None, cibfile=None)
Create an item via pcs command
(mainly for use with the pcs state module)
.INDENT 7.0
.TP
.B item
config, property, resource, constraint etc.
.TP
.B item_id
id of the item
.TP
.B item_type
item type
.TP
.B create
create command (create or set f.e., default: create)
.TP
.B extra_args
additional options for the pcs command
.TP
.B cibfile
use cibfile instead of the live CIB
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pcs.item_show(item, item_id=None, item_type=None, show=\(aqshow\(aq, extra_args=None, cibfile=None)
Show an item via pcs command
(mainly for use with the pcs state module)
.INDENT 7.0
.TP
.B item
config, property, resource, constraint etc.
.TP
.B item_id
id of the item
.TP
.B item_type
item type
.TP
.B show
show command (probably None, default: show or status for newer implementation)
.TP
.B extra_args
additional options for the pcs command
.TP
.B cibfile
use cibfile instead of the live CIB
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pcs.prop_set(prop, value, extra_args=None, cibfile=None)
Set the value of a cluster property
.INDENT 7.0
.TP
.B prop
name of the property
.TP
.B value
value of the property prop
.TP
.B extra_args
additional options for the pcs property command
.TP
.B cibfile
use cibfile instead of the live CIB
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pcs.prop_set prop=\(aqno\-quorum\-policy\(aq value=\(aqignore\(aq cibfile=\(aq/tmp/2_node_cluster.cib\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pcs.prop_show(prop, extra_args=None, cibfile=None)
Show the value of a cluster property
.INDENT 7.0
.TP
.B prop
name of the property
.TP
.B extra_args
additional options for the pcs property command
.TP
.B cibfile
use cibfile instead of the live CIB
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pcs.prop_show cibfile=\(aq/tmp/2_node_cluster.cib\(aq prop=\(aqno\-quorum\-policy\(aq cibfile=\(aq/tmp/2_node_cluster.cib\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pcs.resource_create(resource_id, resource_type, resource_options=None, cibfile=None)
Create a resource via pcs command
.INDENT 7.0
.TP
.B resource_id
name for the resource
.TP
.B resource_type
resource type (f.e. ocf:heartbeat:IPaddr2 or VirtualIP)
.TP
.B resource_options
additional options for creating the resource
.TP
.B cibfile
use cibfile instead of the live CIB for manipulation
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pcs.resource_create resource_id=\(aqgalera\(aq resource_type=\(aqocf:heartbeat:galera\(aq resource_options=\(dq[\(aqwsrep_cluster_address=gcomm://node1.example.org,node2.example.org,node3.example.org\(aq, \(aq\-\-master\(aq]\(dq cibfile=\(aq/tmp/cib_for_galera.cib\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pcs.resource_show(resource_id, extra_args=None, cibfile=None)
Show a resource via pcs command
.INDENT 7.0
.TP
.B resource_id
name of the resource
.TP
.B extra_args
additional options for the pcs command
.TP
.B cibfile
use cibfile instead of the live CIB
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pcs.resource_show resource_id=\(aqgalera\(aq cibfile=\(aq/tmp/cib_for_galera.cib\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pcs.stonith_create(stonith_id, stonith_device_type, stonith_device_options=None, cibfile=None)
Create a stonith resource via pcs command
.INDENT 7.0
.TP
.B stonith_id
name for the stonith resource
.TP
.B stonith_device_type
name of the stonith agent fence_eps, fence_xvm f.e.
.TP
.B stonith_device_options
additional options for creating the stonith resource
.TP
.B cibfile
use cibfile instead of the live CIB for manipulation
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pcs.stonith_create stonith_id=\(aqeps_fence\(aq stonith_device_type=\(aqfence_eps\(aq
                            stonith_device_options=\(dq[\(aqpcmk_host_map=node1.example.org:01;node2.example.org:02\(aq, \(aqipaddr=myepsdevice.example.org\(aq, \(aqaction=reboot\(aq, \(aqpower_wait=5\(aq, \(aqverbose=1\(aq, \(aqdebug=/var/log/pcsd/eps_fence.log\(aq, \(aqlogin=hidden\(aq, \(aqpasswd=hoonetorg\(aq]\(dq cibfile=\(aq/tmp/cib_for_stonith.cib\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pcs.stonith_show(stonith_id, extra_args=None, cibfile=None)
Show the value of a cluster stonith
.INDENT 7.0
.TP
.B stonith_id
name for the stonith resource
.TP
.B extra_args
additional options for the pcs stonith command
.TP
.B cibfile
use cibfile instead of the live CIB
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pcs.stonith_show stonith_id=\(aqeps_fence\(aq cibfile=\(aq/tmp/2_node_cluster.cib\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pdbedit
.sp
Manage accounts in Samba\(aqs passdb using pdbedit
.INDENT 0.0
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B platform
posix
.UNINDENT
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.modules.pdbedit.create(login, password, password_hashed=False, machine_account=False)
Create user account
.INDENT 7.0
.TP
.B login
string
login name
.TP
.B password
string
password
.TP
.B password_hashed
boolean
set if password is a nt hash instead of plain text
.TP
.B machine_account
boolean
set to create a machine trust account instead
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pdbedit.create zoe 9764951149F84E770889011E1DC4A927 nthash
salt \(aq*\(aq pdbedit.create river  1sw4ll0w3d4bug
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pdbedit.delete(login)
Delete user account
.INDENT 7.0
.TP
.B login
string
login name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pdbedit.delete wash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pdbedit.generate_nt_hash(password)
Generate a NT HASH
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pdbedit.generate_nt_hash my_passwd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pdbedit.get_user(login, hashes=False)
Get user account details
.INDENT 7.0
.TP
.B login
string
login name
.TP
.B hashes
boolean
include NTHASH and LMHASH in verbose output
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pdbedit.get kaylee
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pdbedit.list_users(verbose=True, hashes=False)
List user accounts
.INDENT 7.0
.TP
.B verbose
boolean
return all information
.TP
.B hashes
boolean
include NT HASH and LM HASH in verbose output
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pdbedit.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pdbedit.modify(login, password=None, password_hashed=False, domain=None, profile=None, script=None, drive=None, homedir=None, fullname=None, account_desc=None, account_control=None, machine_sid=None, user_sid=None, reset_login_hours=False, reset_bad_password_count=False)
Modify user account
.INDENT 7.0
.TP
.B login
string
login name
.TP
.B password
string
password
.TP
.B password_hashed
boolean
set if password is a nt hash instead of plain text
.TP
.B domain
string
users domain
.TP
.B profile
string
profile path
.TP
.B script
string
logon script
.TP
.B drive
string
home drive
.TP
.B homedir
string
home directory
.TP
.B fullname
string
full name
.TP
.B account_desc
string
account description
.TP
.B machine_sid
string
specify the machines new primary group SID or rid
.TP
.B user_sid
string
specify the users new primary group SID or rid
.TP
.B account_control
string
specify user account control properties
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Only the following can be set:
\- N: No password required
\- D: Account disabled
\- H: Home directory required
\- L: Automatic Locking
\- X: Password does not expire
.UNINDENT
.UNINDENT
.TP
.B reset_login_hours
boolean
reset the users allowed logon hours
.TP
.B reset_bad_password_count
boolean
reset the stored bad login counter
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
if user is absent and password is provided, the user will be created
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pdbedit.modify inara fullname=\(aqInara Serra\(aq
salt \(aq*\(aq pdbedit.modify simon password=r1v3r
salt \(aq*\(aq pdbedit.modify jane drive=\(aqV:\(aq homedir=\(aq\e\eserenity\ejane\eprofile\(aq
salt \(aq*\(aq pdbedit.modify mal account_control=NX
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pecl
.sp
Manage PHP pecl extensions.
.INDENT 0.0
.TP
.B salt.modules.pecl.install(pecls, defaults=False, force=False, preferred_state=\(aqstable\(aq)
New in version 0.17.0.

.sp
Installs one or several pecl extensions.
.INDENT 7.0
.TP
.B pecls
The pecl extensions to install.
.TP
.B defaults
Use default answers for extensions such as pecl_http which ask
questions before installation. Without this option, the pecl.installed
state will hang indefinitely when trying to install these extensions.
.TP
.B force
Whether to force the installed version or not
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pecl.install fuse
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pecl.list_(channel=None)
List installed pecl extensions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pecl.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pecl.uninstall(pecls)
Uninstall one or several pecl extensions.
.INDENT 7.0
.TP
.B pecls
The pecl extensions to uninstall.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pecl.uninstall fuse
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pecl.update(pecls)
Update one or several pecl extensions.
.INDENT 7.0
.TP
.B pecls
The pecl extensions to update.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pecl.update fuse
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.peeringdb
.SS PeeringDB Module
.sp
New in version 2019.2.0.

.sp
Execution module for the basic interaction with the
\fI\%PeeringDB\fP API.
.sp
While for GET operations (the functions prefixed by \fBget_\fP) the credentials
are optional, there are some specific details that are visible only to
authenticated users. Moreover, the credentials are required when adding or
updating information. That means, the module can equally work out of the box
without any further configuration with the limitations imposed by the PeeringDB
API.
.sp
For complete API documentation, please refer to \fI\%https://www.peeringdb.com/apidocs/\fP\&.
.sp
Configuration (in the opts or Pillar):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
peeringdb:
  username: salt
  password: 5@1t
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.peeringdb.get_fac(**kwargs)
Return the details of the facility identified using the search
filters specified in the query.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If no \fBid\fP or filter arguments are specified, it will return all the
possible facilities registered in PeeringDB.
.sp
The available filters are documented at:
\fI\%https://www.peeringdb.com/apidocs/#!/netfac/netfac_list\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq peeringdb.get_fac id=1774
salt \(aq*\(aq peeringdb.get_fac state=UT
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.peeringdb.get_ix(**kwargs)
Return the details of an IX (Internet Exchange) using the search filters
specified in the query.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If no \fBid\fP or filter arguments are specified, it will return all the
possible IXs registered in PeeringDB.
.sp
The available filters are documented at:
\fI\%https://www.peeringdb.com/apidocs/#!/ix/ix_list\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq peeringdb.get_ix id=1
salt \(aq*\(aq peeringdb.get_ix city=\(aqMilwaukee\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.peeringdb.get_ixfac(**kwargs)
Return the details of an IX (Internet Exchange) facility using the search
filters specified in the query.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If no \fBid\fP or filter arguments are specified, it will return all the
possible IX facilities registered in PeeringDB.
.sp
The available filters are documented at:
\fI\%https://www.peeringdb.com/apidocs/#!/ixfac/ixfac_list\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq peeringdb.get_ixfac id=1
salt \(aq*\(aq peeringdb.get_ixfac city=\(aqMilwaukee\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.peeringdb.get_ixlan(**kwargs)
Return the details of an IX (Internet Exchange) together with the networks
available in this location (and their details), using the search filters
specified in the query.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If no \fBid\fP or filter arguments are specified, it will return all the
possible IX LAN facilities registered in PeeringDB.
.sp
The available filters are documented at:
\fI\%https://www.peeringdb.com/apidocs/#!/ixlan/ixlan_list\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq peeringdb.get_ixlan id=780
salt \(aq*\(aq peeringdb.get_ixlan city=\(aqMilwaukee\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.peeringdb.get_ixpfx(**kwargs)
Return the details of an IX (Internet Exchange) together with the PeeringDB
IDs of the networks available in this location, using the search filters
specified in the query.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If no \fBid\fP or filter arguments are specified, it will return all the
possible IX LAN facilities registered in PeeringDB.
.sp
The available filters are documented at:
\fI\%https://www.peeringdb.com/apidocs/#!/ixpfx/ixpfx_list\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq peeringdb.get_ixpfx id=780
salt \(aq*\(aq peeringdb.get_ixpfx city=\(aqMilwaukee\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.peeringdb.get_net(**kwargs)
Return the details of a network identified using the search filters
specified in the query.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If no \fBid\fP or filter arguments are specified, it will return all the
possible networks registered in PeeringDB.
.sp
The available filters are documented at:
\fI\%https://www.peeringdb.com/apidocs/#!/net/net_list\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq peeringdb.get_net id=4224
salt \(aq*\(aq peeringdb.get_net asn=13335
salt \(aq*\(aq peeringdb.get_net city=\(aqSalt Lake City\(aq
salt \(aq*\(aq peeringdb.get_net name__startswith=GTT
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.peeringdb.get_netfac(**kwargs)
Return the list of facilities used by a particular network, given the \fBid\fP
or other filters specified in the query.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If no \fBid\fP or filter arguments are specified, it will return all the
possible network facilities registered in PeeringDB.
.sp
The available filters are documented at:
\fI\%https://www.peeringdb.com/apidocs/#!/netfac/netfac_list\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq peeringdb.get_netfac id=780
salt \(aq*\(aq peeringdb.get_netfac city=\(aqMilwaukee\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.peeringdb.get_netixlan(**kwargs)
Return the IP addresses used by a particular network at all the IXs where it
is available. The network is selected either via the \fBid\fP argument or the
other filters specified in the query.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If no \fBid\fP or filter arguments are specified, it will return all the
possible IP addresses, of all networks, at all IXs, registered in
PeeringDB.
.sp
The available filters are documented at:
\fI\%https://www.peeringdb.com/apidocs/#!/netixlan/netixlan_list\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq peeringdb.get_netixlan asn=13335
salt \(aq*\(aq peeringdb.get_netixlan ipaddr4=185.1.114.25
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.peeringdb.get_org(**kwargs)
Return the details of an organisation together with the networks
available in this location, using the search filters specified in the query.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If no \fBid\fP or filter arguments are specified, it will return all the
possible organisations registered in PeeringDB.
.sp
The available filters are documented at:
\fI\%https://www.peeringdb.com/apidocs/#!/org/org_list\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq peeringdb.get_org id=2
salt \(aq*\(aq peeringdb.get_org city=Duesseldorf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.peeringdb.get_poc(**kwargs)
Return the details of a person of contact together using the search filters
specified in the query.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If no \fBid\fP or filter arguments are specified, it will return all the
possible contacts registered in PeeringDB.
.sp
The available filters are documented at:
\fI\%https://www.peeringdb.com/apidocs/#!/poc/poc_list\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq peeringdb.get_poc id=6721
salt \(aq*\(aq peeringdb.get_poc email__contains=\(aq@cloudflare.com\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pf
.sp
Control the OpenBSD packet filter (PF).
.INDENT 0.0
.TP
.B codeauthor
Jasper Lievisse Adriaanse <\fI\%j@jasper.la\fP>
.UNINDENT
.sp
New in version 2019.2.0.

.INDENT 0.0
.TP
.B salt.modules.pf.disable()
Disable the Packet Filter.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pf.disable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pf.enable()
Enable the Packet Filter.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pf.enable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pf.flush(modifier)
Flush the specified packet filter parameters.
.INDENT 7.0
.TP
.B modifier:
Should be one of the following:
.INDENT 7.0
.IP \(bu 2
all
.IP \(bu 2
info
.IP \(bu 2
osfp
.IP \(bu 2
rules
.IP \(bu 2
sources
.IP \(bu 2
states
.IP \(bu 2
tables
.UNINDENT
.sp
Please refer to the OpenBSD \fI\%pfctl(8)\fP
documentation for a detailed explanation of each command.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pf.flush states
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pf.load(file=\(aq/etc/pf.conf\(aq, noop=False)
Load a ruleset from the specific file, overwriting the currently loaded ruleset.
.INDENT 7.0
.TP
.B file:
Full path to the file containing the ruleset.
.TP
.B noop:
Don\(aqt actually load the rules, just parse them.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pf.load /etc/pf.conf.d/lockdown.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pf.loglevel(level)
Set the debug level which limits the severity of log messages printed by \fBpf(4)\fP\&.
.INDENT 7.0
.TP
.B level:
Log level. Should be one of the following: emerg, alert, crit, err, warning, notice,
info or debug (OpenBSD); or none, urgent, misc, loud (FreeBSD).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pf.loglevel emerg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pf.show(modifier)
Show filter parameters.
.INDENT 7.0
.TP
.B modifier:
Modifier to apply for filtering. Only a useful subset of what pfctl supports
can be used with Salt.
.INDENT 7.0
.IP \(bu 2
rules
.IP \(bu 2
states
.IP \(bu 2
tables
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pf.show rules
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pf.table(command, table, **kwargs)
Apply a command on the specified table.
.INDENT 7.0
.TP
.B table:
Name of the table.
.TP
.B command:
Command to apply to the table. Supported commands are:
.INDENT 7.0
.IP \(bu 2
add
.IP \(bu 2
delete
.IP \(bu 2
expire
.IP \(bu 2
flush
.IP \(bu 2
kill
.IP \(bu 2
replace
.IP \(bu 2
show
.IP \(bu 2
test
.IP \(bu 2
zero
.UNINDENT
.sp
Please refer to the OpenBSD \fI\%pfctl(8)\fP
documentation for a detailed explanation of each command.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pf.table expire table=spam_hosts number=300
salt \(aq*\(aq pf.table add table=local_hosts addresses=\(aq[\(dq127.0.0.1\(dq, \(dq::1\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.philips_hue
.sp
Philips HUE lamps module for proxy.
.sp
New in version 2015.8.3.

.SS salt.modules.pillar
.sp
Extract the pillar data for this minion
.INDENT 0.0
.TP
.B salt.modules.pillar.data(*args, pillar=None, pillar_enc=None, pillarenv=None, saltenv=None)
Calls the master for a fresh pillar, generates the pillar data on the
fly (same as \fI\%items()\fP)
.INDENT 7.0
.TP
.B pillar
If specified, allows for a dictionary of pillar data to be made
available to pillar and ext_pillar rendering. these pillar variables
will also override any variables of the same name in pillar or
ext_pillar.
.TP
.B pillar_enc
If specified, the data passed in the \fBpillar\fP argument will be passed
through this renderer to decrypt it.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This will decrypt on the minion side, so the specified renderer
must be set up on the minion for this to work. Alternatively,
pillar data can be decrypted master\-side. For more information, see
the \fI\%Pillar Encryption\fP documentation.
Pillar data that is decrypted master\-side, is not decrypted until
the end of pillar compilation though, so minion\-side decryption
will be necessary if the encrypted pillar data must be made
available in an decrypted state pillar/ext_pillar rendering.
.UNINDENT
.UNINDENT
.TP
.B pillarenv
Pass a specific pillar environment from which to compile pillar data.
If not specified, then the minion\(aqs \fI\%pillarenv\fP option is
not used, and if that also is not specified then all configured pillar
environments will be merged into a single pillar dictionary and
returned.
.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.data
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pillar.ext(external, pillar=None)
Changed in version 2016.3.6,2016.11.3,2017.7.0: The supported ext_pillar types are now tunable using the
\fI\%on_demand_ext_pillar\fP config option. Earlier releases
used a hard\-coded default.

.sp
Generate the pillar and apply an explicit external pillar
.INDENT 7.0
.TP
.B external
A single ext_pillar to add to the ext_pillar configuration. This must
be passed as a single section from the ext_pillar configuration (see
CLI examples below). For more complicated \fBext_pillar\fP
configurations, it can be helpful to use the Python shell to load YAML
configuration into a dictionary, and figure out
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> import salt.utils.yaml
>>> ext_pillar = salt.utils.yaml.safe_load(\(dq\(dq\(dq
\&... ext_pillar:
\&...   \- git:
\&...     \- issue38440 https://github.com/terminalmage/git_pillar:
\&...       \- env: base
\&... \(dq\(dq\(dq)
>>> ext_pillar
{\(aqext_pillar\(aq: [{\(aqgit\(aq: [{\(aqmybranch https://github.com/myuser/myrepo\(aq: [{\(aqenv\(aq: \(aqbase\(aq}]}]}]}
>>> ext_pillar[\(aqext_pillar\(aq][0]
{\(aqgit\(aq: [{\(aqmybranch https://github.com/myuser/myrepo\(aq: [{\(aqenv\(aq: \(aqbase\(aq}]}]}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above example, the value to pass would be
\fB{\(aqgit\(aq: [{\(aqmybranch https://github.com/myuser/myrepo\(aq: [{\(aqenv\(aq: \(aqbase\(aq}]}]}\fP\&.
Note that this would need to be quoted when passing on the CLI (as in
the CLI examples below).
.TP
.B pillar
None
If specified, allows for a dictionary of pillar data to be made
available to pillar and ext_pillar rendering. These pillar variables
will also override any variables of the same name in pillar or
ext_pillar.
.sp
New in version 2015.5.0.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.ext \(aq{libvirt: _}\(aq
salt \(aq*\(aq pillar.ext \(dq{\(aqgit\(aq: [\(aqmaster https://github.com/myuser/myrepo\(aq]}\(dq
salt \(aq*\(aq pillar.ext \(dq{\(aqgit\(aq: [{\(aqmybranch https://github.com/myuser/myrepo\(aq: [{\(aqenv\(aq: \(aqbase\(aq}]}]}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pillar.fetch(key, default=<Constant.NOT_SET>, merge=False, merge_nested_lists=None, delimiter=\(aq:\(aq, pillarenv=None, saltenv=None)
New in version 0.14.0.

.sp
Attempt to retrieve the named value from \fI\%in\-memory pillar data\fP\&. If the pillar key is not present in the in\-memory
pillar, then the value specified in the \fBdefault\fP option (described
below) will be returned.
.sp
If the merge parameter is set to \fBTrue\fP, the default will be recursively
merged into the returned pillar data.
.sp
The value can also represent a value in a nested dict using a \(dq:\(dq delimiter
for the dict. This means that if a dict in pillar looks like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqpkg\(aq: {\(aqapache\(aq: \(aqhttpd\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To retrieve the value associated with the \fBapache\fP key in the \fBpkg\fP
dict this key can be passed as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pkg:apache
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B key
The pillar key to get value from
.TP
.B default
The value specified by this option will be returned if the desired
pillar key does not exist.
.sp
If a default value is not specified, then it will be an empty string,
unless \fI\%pillar_raise_on_missing\fP is set to \fBTrue\fP, in
which case an error will be raised.
.TP
.B merge
\fBFalse\fP
If \fBTrue\fP, the retrieved values will be merged into the passed
default. When the default and the retrieved value are both
dictionaries, the dictionaries will be recursively merged.
.sp
New in version 2014.7.0.

.sp
Changed in version 2016.3.7,2016.11.4,2017.7.0: If the default and the retrieved value are not of the same type,
then merging will be skipped and the retrieved value will be
returned. Earlier releases raised an error in these cases.

.TP
.B merge_nested_lists
If set to \fBFalse\fP, lists nested within the retrieved pillar
dictionary will \fIoverwrite\fP lists in \fBdefault\fP\&. If set to \fBTrue\fP,
nested lists will be \fImerged\fP into lists in \fBdefault\fP\&. If unspecified
(the default), this option is inherited from the
\fBpillar_merge_lists\fP minion config option.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option is ignored when \fBmerge\fP is set to \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.6.

.TP
.B delimiter
Specify an alternate delimiter to use when traversing a nested dict.
This is useful for when the desired key contains a colon. See CLI
example below for usage.
.sp
New in version 2014.7.0.

.TP
.B pillarenv
If specified, this function will query the master to generate fresh
pillar data on the fly, specifically from the requested pillar
environment. Note that this can produce different pillar data than
executing this function without an environment, as its normal behavior
is just to return a value from minion\(aqs pillar data in memory (which
can be sourced from more than one pillar environment).
.sp
Using this argument will not affect the pillar data in memory. It will
however be slightly slower and use more resources on the master due to
the need for the master to generate and send the minion fresh pillar
data. This tradeoff in performance however allows for the use case
where pillar data is desired only from a single environment.
.sp
New in version 2017.7.0.

.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.sp
New in version 2017.7.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.get pkg:apache
salt \(aq*\(aq pillar.get abc::def|ghi delimiter=\(aq|\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pillar.file_exists(path, saltenv=None)
New in version 2016.3.0.

.sp
This is a master\-only function. Calling from the minion is not supported.
.sp
Use the given path and search relative to the pillar environments to see if
a file exists at that path.
.sp
If the \fBsaltenv\fP argument is given, restrict search to that environment
only.
.sp
Will only work with \fBpillar_roots\fP, not external pillars.
.sp
Returns True if the file is found, and False otherwise.
.INDENT 7.0
.TP
.B path
The path to the file in question. Will be treated as a relative path
.TP
.B saltenv
Optional argument to restrict the search to a specific saltenv
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.file_exists foo/bar.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pillar.filter_by(lookup_dict, pillar, merge=None, default=\(aqdefault\(aq, base=None)
New in version 2017.7.0.

.sp
Look up the given pillar in a given dictionary and return the result
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBlookup_dict\fP \-\-
.sp
A dictionary, keyed by a pillar, containing a value or
values relevant to systems matching that pillar. For example, a key
could be a pillar for a role and the value could the name of a package
on that particular OS.
.sp
The dictionary key can be a globbing pattern. The function will return
the corresponding \fBlookup_dict\fP value where the pillar value matches
the  pattern. For example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
# this will render \(aqgot some salt\(aq if \(ga\(garole\(ga\(ga begins with \(aqsalt\(aq
salt \(aq*\(aq pillar.filter_by \(aq{salt*: got some salt, default: salt is not here}\(aq role
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBpillar\fP \-\-
.sp
The name of a pillar to match with the system\(aqs pillar. For
example, the value of the \(dqrole\(dq pillar could be used to pull values
from the \fBlookup_dict\fP dictionary.
.sp
The pillar value can be a list. The function will return the
\fBlookup_dict\fP value for a first found item in the list matching
one of the \fBlookup_dict\fP keys.

.IP \(bu 2
\fBmerge\fP \-\- A dictionary to merge with the results of the pillar
selection from \fBlookup_dict\fP\&. This allows another dictionary to
override the values in the \fBlookup_dict\fP\&.
.IP \(bu 2
\fBdefault\fP \-\- default lookup_dict\(aqs key used if the pillar does not exist
or if the pillar value has no match on lookup_dict.  If unspecified
the value is \(dqdefault\(dq.
.IP \(bu 2
\fBbase\fP \-\- A lookup_dict key to use for a base dictionary.  The
pillar\-selected \fBlookup_dict\fP is merged over this and then finally
the \fBmerge\fP dictionary is merged.  This allows common values for
each case to be collected in the base and overridden by the pillar
selection dictionary and the merge dictionary.  Default is unset.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.filter_by \(aq{web: Serve it up, db: I query, default: x_x}\(aq role
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pillar.get(key, default=<Constant.NOT_SET>, merge=False, merge_nested_lists=None, delimiter=\(aq:\(aq, pillarenv=None, saltenv=None)
New in version 0.14.0.

.sp
Attempt to retrieve the named value from \fI\%in\-memory pillar data\fP\&. If the pillar key is not present in the in\-memory
pillar, then the value specified in the \fBdefault\fP option (described
below) will be returned.
.sp
If the merge parameter is set to \fBTrue\fP, the default will be recursively
merged into the returned pillar data.
.sp
The value can also represent a value in a nested dict using a \(dq:\(dq delimiter
for the dict. This means that if a dict in pillar looks like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqpkg\(aq: {\(aqapache\(aq: \(aqhttpd\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To retrieve the value associated with the \fBapache\fP key in the \fBpkg\fP
dict this key can be passed as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pkg:apache
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B key
The pillar key to get value from
.TP
.B default
The value specified by this option will be returned if the desired
pillar key does not exist.
.sp
If a default value is not specified, then it will be an empty string,
unless \fI\%pillar_raise_on_missing\fP is set to \fBTrue\fP, in
which case an error will be raised.
.TP
.B merge
\fBFalse\fP
If \fBTrue\fP, the retrieved values will be merged into the passed
default. When the default and the retrieved value are both
dictionaries, the dictionaries will be recursively merged.
.sp
New in version 2014.7.0.

.sp
Changed in version 2016.3.7,2016.11.4,2017.7.0: If the default and the retrieved value are not of the same type,
then merging will be skipped and the retrieved value will be
returned. Earlier releases raised an error in these cases.

.TP
.B merge_nested_lists
If set to \fBFalse\fP, lists nested within the retrieved pillar
dictionary will \fIoverwrite\fP lists in \fBdefault\fP\&. If set to \fBTrue\fP,
nested lists will be \fImerged\fP into lists in \fBdefault\fP\&. If unspecified
(the default), this option is inherited from the
\fBpillar_merge_lists\fP minion config option.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option is ignored when \fBmerge\fP is set to \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.6.

.TP
.B delimiter
Specify an alternate delimiter to use when traversing a nested dict.
This is useful for when the desired key contains a colon. See CLI
example below for usage.
.sp
New in version 2014.7.0.

.TP
.B pillarenv
If specified, this function will query the master to generate fresh
pillar data on the fly, specifically from the requested pillar
environment. Note that this can produce different pillar data than
executing this function without an environment, as its normal behavior
is just to return a value from minion\(aqs pillar data in memory (which
can be sourced from more than one pillar environment).
.sp
Using this argument will not affect the pillar data in memory. It will
however be slightly slower and use more resources on the master due to
the need for the master to generate and send the minion fresh pillar
data. This tradeoff in performance however allows for the use case
where pillar data is desired only from a single environment.
.sp
New in version 2017.7.0.

.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.sp
New in version 2017.7.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.get pkg:apache
salt \(aq*\(aq pillar.get abc::def|ghi delimiter=\(aq|\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pillar.item(*args, default=None, delimiter=None, pillarenv=None, saltenv=None)
New in version 0.16.2.

.sp
Return one or more pillar entries from the \fI\%in\-memory pillar data\fP\&.
.INDENT 7.0
.TP
.B delimiter
Delimiter used to traverse nested dictionaries.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is different from \fI\%pillar.get\fP in that no default value can be
specified. \fI\%pillar.get\fP should
probably still be used in most cases to retrieve nested pillar
values, as it is a bit more flexible. One reason to use this
function instead of \fI\%pillar.get\fP
however is when it is desirable to retrieve the values of more than
one key, since \fI\%pillar.get\fP can
only retrieve one key at a time.
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.TP
.B pillarenv
If specified, this function will query the master to generate fresh
pillar data on the fly, specifically from the requested pillar
environment. Note that this can produce different pillar data than
executing this function without an environment, as its normal behavior
is just to return a value from minion\(aqs pillar data in memory (which
can be sourced from more than one pillar environment).
.sp
Using this argument will not affect the pillar data in memory. It will
however be slightly slower and use more resources on the master due to
the need for the master to generate and send the minion fresh pillar
data. This tradeoff in performance however allows for the use case
where pillar data is desired only from a single environment.
.sp
New in version 2017.7.6,2018.3.1.

.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.sp
New in version 2017.7.6,2018.3.1.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.item foo
salt \(aq*\(aq pillar.item foo:bar
salt \(aq*\(aq pillar.item foo bar baz
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pillar.items(*args, pillar=None, pillar_enc=None, pillarenv=None, saltenv=None)
Calls the master for a fresh pillar and generates the pillar data on the
fly
.sp
Contrast with \fI\%raw()\fP which returns the pillar data that is
currently loaded into the minion.
.INDENT 7.0
.TP
.B pillar
If specified, allows for a dictionary of pillar data to be made
available to pillar and ext_pillar rendering. these pillar variables
will also override any variables of the same name in pillar or
ext_pillar.
.sp
New in version 2015.5.0.

.TP
.B pillar_enc
If specified, the data passed in the \fBpillar\fP argument will be passed
through this renderer to decrypt it.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This will decrypt on the minion side, so the specified renderer
must be set up on the minion for this to work. Alternatively,
pillar data can be decrypted master\-side. For more information, see
the \fI\%Pillar Encryption\fP documentation.
Pillar data that is decrypted master\-side, is not decrypted until
the end of pillar compilation though, so minion\-side decryption
will be necessary if the encrypted pillar data must be made
available in an decrypted state pillar/ext_pillar rendering.
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.TP
.B pillarenv
Pass a specific pillar environment from which to compile pillar data.
If not specified, then the minion\(aqs \fI\%pillarenv\fP option is
not used, and if that also is not specified then all configured pillar
environments will be merged into a single pillar dictionary and
returned.
.sp
New in version 2016.11.2.

.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.items
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pillar.keys(key, delimiter=\(aq:\(aq)
New in version 2015.8.0.

.sp
Attempt to retrieve a list of keys from the named value from the pillar.
.sp
The value can also represent a value in a nested dict using a \(dq:\(dq delimiter
for the dict, similar to how pillar.get works.
.INDENT 7.0
.TP
.B delimiter
Specify an alternate delimiter to use when traversing a nested dict
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.keys web:sites
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pillar.ls(*args, pillar=None, pillar_enc=None, pillarenv=None, saltenv=None)
New in version 2015.8.0.

.sp
Calls the master for a fresh pillar, generates the pillar data on the
fly (same as \fI\%items()\fP), but only shows the available main keys.
.INDENT 7.0
.TP
.B pillar
If specified, allows for a dictionary of pillar data to be made
available to pillar and ext_pillar rendering. these pillar variables
will also override any variables of the same name in pillar or
ext_pillar.
.TP
.B pillar_enc
If specified, the data passed in the \fBpillar\fP argument will be passed
through this renderer to decrypt it.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This will decrypt on the minion side, so the specified renderer
must be set up on the minion for this to work. Alternatively,
pillar data can be decrypted master\-side. For more information, see
the \fI\%Pillar Encryption\fP documentation.
Pillar data that is decrypted master\-side, is not decrypted until
the end of pillar compilation though, so minion\-side decryption
will be necessary if the encrypted pillar data must be made
available in an decrypted state pillar/ext_pillar rendering.
.UNINDENT
.UNINDENT
.TP
.B pillarenv
Pass a specific pillar environment from which to compile pillar data.
If not specified, then the minion\(aqs \fI\%pillarenv\fP option is
not used, and if that also is not specified then all configured pillar
environments will be merged into a single pillar dictionary and
returned.
.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.ls
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pillar.obfuscate(*args, pillar=None, pillar_enc=None, pillarenv=None, saltenv=None)
New in version 2015.8.0.

.sp
Same as \fI\%items()\fP, but replace pillar values with a simple type indication.
.sp
This is useful to avoid displaying sensitive information on console or
flooding the console with long output, such as certificates.
For many debug or control purposes, the stakes lie more in dispatching than in
actual values.
.sp
In case the value is itself a collection type, obfuscation occurs within the value.
For mapping types, keys are not obfuscated.
Here are some examples:
.INDENT 7.0
.IP \(bu 2
\fB\(aqsecret password\(aq\fP becomes \fB\(aq<str>\(aq\fP
.IP \(bu 2
\fB[\(aqsecret\(aq, 1]\fP becomes \fB[\(aq<str>\(aq, \(aq<int>\(aq]\fP
.IP \(bu 2
\fB{\(aqlogin\(aq: \(aqsomelogin\(aq, \(aqpwd\(aq: \(aqsecret\(aq}\fP becomes
\fB{\(aqlogin\(aq: \(aq<str>\(aq, \(aqpwd\(aq: \(aq<str>\(aq}\fP
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.obfuscate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pillar.raw(key=None)
Return the raw pillar data that is currently loaded into the minion.
.sp
Contrast with \fI\%items()\fP which calls the master to fetch the most
up\-to\-date Pillar.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.raw
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With the optional key argument, you can select a subtree of the
pillar raw data.:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.raw key=\(aqroles\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pip
.sp
Install Python packages with pip to either the system or a virtualenv
.SS Windows Support
.sp
New in version 2014.7.4.

.sp
Salt now uses a portable python. As a result the entire pip module is now
functional on the salt installation itself. You can pip install dependencies
for your custom modules. You can even upgrade salt itself using pip. For this
to work properly, you must specify the Current Working Directory (\fBcwd\fP) and
the Pip Binary (\fBbin_env\fP) salt should use.  The variable \fBpip_bin\fP can be
either a virtualenv path or the path to the pip binary itself.
.sp
For example, the following command will list all software installed using pip
to your current salt environment:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt <minion> pip.list cwd=\(aqC:\esalt\ebin\eScripts\(aq bin_env=\(aqC:\esalt\ebin\eScripts\epip.exe\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Specifying the \fBcwd\fP and \fBbin_env\fP options ensures you\(aqre modifying the
salt environment. If these are omitted, it will default to the local
installation of python. If python is not installed locally it will fail saying
it couldn\(aqt find pip.
.SS State File Support
.sp
This functionality works in states as well. If you need to pip install colorama
with a state, for example, the following will work:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
install_colorama:
  pip.installed:
    \- name: colorama
    \- cwd: \(aqC:\esalt\ebin\escripts\(aq
    \- bin_env: \(aqC:\esalt\ebin\escripts\epip.exe\(aq
    \- upgrade: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Upgrading Salt using Pip
.sp
You can now update salt using pip to any version from the 2014.7 branch
forward. Previous version require recompiling some of the dependencies which is
painful in windows.
.sp
To do this you just use pip with git to update to the version you want and then
restart the service. Here is a sample state file that upgrades salt to the head
of the 2015.5 branch:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
install_salt:
  pip.installed:
    \- cwd: \(aqC:\esalt\ebin\escripts\(aq
    \- bin_env: \(aqC:\esalt\ebin\escripts\epip.exe\(aq
    \- editable: git+https://github.com/saltstack/salt@2015.5#egg=salt
    \- upgrade: True

restart_service:
  service.running:
    \- name: salt\-minion
    \- enable: True
    \- watch:
      \- pip: install_salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you\(aqre having problems, you might try doubling the back slashes. For
example, cwd: \(aqC:\esalt\ebin\escripts\(aq. Sometimes python thinks the single
back slash is an escape character.
.sp
There is a known incompatibility between Python2 pip>=10.* and Salt <=2018.3.0.
The issue is described here: \fI\%https://github.com/saltstack/salt/issues/46163\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pip.freeze(bin_env=None, user=None, cwd=None, use_vt=False, env_vars=None, **kwargs)
Return a list of installed packages either globally or in the specified
virtualenv
.INDENT 7.0
.TP
.B bin_env
Path to pip (or to a virtualenv). This can be used to specify the path
to the pip to use when more than one Python release is installed (e.g.
\fB/usr/bin/pip\-2.7\fP or \fB/usr/bin/pip\-2.6\fP\&. If a directory path is
specified, it is assumed to be a virtualenv.
.TP
.B user
The user under which to run pip
.TP
.B cwd
Directory from which to run pip
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the version of pip available is older than 8.0.3, the list will not
include the packages \fBpip\fP, \fBwheel\fP, \fBsetuptools\fP, or
\fBdistribute\fP even if they are installed.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.freeze bin_env=/home/code/path/to/virtualenv
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pip.install(pkgs=None, requirements=None, bin_env=None, use_wheel=False, no_use_wheel=False, log=None, proxy=None, timeout=None, editable=None, find_links=None, index_url=None, extra_index_url=None, no_index=False, mirrors=None, build=None, target=None, download=None, download_cache=None, source=None, upgrade=False, force_reinstall=False, ignore_installed=False, exists_action=None, no_deps=False, no_install=False, no_download=False, global_options=None, install_options=None, user=None, cwd=None, pre_releases=False, cert=None, allow_all_external=False, allow_external=None, allow_unverified=None, process_dependency_links=False, saltenv=\(aqbase\(aq, env_vars=None, use_vt=False, trusted_host=None, no_cache_dir=False, extra_args=None, cache_dir=None, no_binary=None, disable_version_check=False, **kwargs)
Install packages with pip
.sp
Install packages individually or from a pip requirements file. Install
packages globally or to a virtualenv.
.INDENT 7.0
.TP
.B pkgs
Comma separated list of packages to install
.TP
.B requirements
Path to requirements
.TP
.B bin_env
Path to pip (or to a virtualenv). This can be used to specify the path
to the pip to use when more than one Python release is installed (e.g.
\fB/usr/bin/pip\-2.7\fP or \fB/usr/bin/pip\-2.6\fP\&. If a directory path is
specified, it is assumed to be a virtualenv.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For Windows, if the pip module is being used to upgrade the pip
package, bin_env should be the path to the virtualenv or to the
python binary that should be used.  The pip command is unable to
upgrade itself in Windows.
.UNINDENT
.UNINDENT
.TP
.B use_wheel
Prefer wheel archives (requires pip>=1.4)
.TP
.B no_use_wheel
Force to not use wheel archives (requires pip>=1.4,<10.0.0)
.TP
.B no_binary
Force to not use binary packages (requires pip >= 7.0.0)
Accepts either :all: to disable all binary packages, :none: to empty the set,
or one or more package names with commas between them
.TP
.B log
Log file where a complete (maximum verbosity) record will be kept.
If this file doesn\(aqt exist and the parent directory is writeable,
it will be created.
.TP
.B proxy
Specify a proxy in the form \fBuser:passwd@proxy.server:port\fP\&. Note
that the \fBuser:password@\fP is optional and required only if you are
behind an authenticated proxy. If you provide
\fBuser@proxy.server:port\fP then you will be prompted for a password.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the Minion has a globaly configured proxy \- it will be used
even if no proxy was set here. To explicitly disable proxy for pip
you should pass \fBFalse\fP as a value.
.UNINDENT
.UNINDENT
.TP
.B timeout
Set the socket timeout (default 15 seconds)
.TP
.B editable
install something editable (e.g.
\fBgit+https://github.com/worldcompany/djangoembed.git#egg=djangoembed\fP)
.TP
.B find_links
URL to search for packages
.TP
.B index_url
Base URL of Python Package Index
.TP
.B extra_index_url
Extra URLs of package indexes to use in addition to \fBindex_url\fP
.TP
.B no_index
Ignore package index
.TP
.B mirrors
Specific mirror URL(s) to query (automatically adds \-\-use\-mirrors)
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This option has been deprecated and removed in pip version 7.0.0.
Please use \fBindex_url\fP and/or \fBextra_index_url\fP instead.
.UNINDENT
.UNINDENT
.TP
.B build
Unpack packages into \fBbuild\fP dir
.TP
.B target
Install packages into \fBtarget\fP dir
.TP
.B download
Download packages into \fBdownload\fP instead of installing them
.TP
.B download_cache | cache_dir
Cache downloaded packages in \fBdownload_cache\fP or \fBcache_dir\fP dir
.TP
.B source
Check out \fBeditable\fP packages into \fBsource\fP dir
.TP
.B upgrade
Upgrade all packages to the newest available version
.TP
.B force_reinstall
When upgrading, reinstall all packages even if they are already
up\-to\-date.
.TP
.B ignore_installed
Ignore the installed packages (reinstalling instead)
.TP
.B exists_action
Default action when a path already exists: (s)witch, (i)gnore, (w)ipe,
(b)ackup
.TP
.B no_deps
Ignore package dependencies
.TP
.B no_install
Download and unpack all packages, but don\(aqt actually install them
.TP
.B no_download
Don\(aqt download any packages, just install the ones already downloaded
(completes an install run with \fB\-\-no\-install\fP)
.TP
.B install_options
Extra arguments to be supplied to the setup.py install command (e.g.
like \fB\-\-install\-option=\(aq\-\-install\-scripts=/usr/local/bin\(aq\fP).  Use
multiple \-\-install\-option options to pass multiple options to setup.py
install. If you are using an option with a directory path, be sure to
use absolute path.
.TP
.B global_options
Extra global options to be supplied to the setup.py call before the
install command.
.TP
.B user
The user under which to run pip
.TP
.B cwd
Directory from which to run pip
.TP
.B pre_releases
Include pre\-releases in the available versions
.TP
.B cert
Provide a path to an alternate CA bundle
.TP
.B allow_all_external
Allow the installation of all externally hosted files
.TP
.B allow_external
Allow the installation of externally hosted files (comma separated
list)
.TP
.B allow_unverified
Allow the installation of insecure and unverifiable files (comma
separated list)
.TP
.B process_dependency_links
Enable the processing of dependency links
.TP
.B env_vars
Set environment variables that some builds will depend on. For example,
a Python C\-module may have a Makefile that needs INCLUDE_PATH set to
pick up a header file while compiling.  This must be in the form of a
dictionary or a mapping.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.install django_app env_vars=\(dq{\(aqCUSTOM_PATH\(aq: \(aq/opt/django_app\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B trusted_host
Mark this host as trusted, even though it does not have valid or any
HTTPS.
.TP
.B use_vt
Use VT terminal emulation (see output while installing)
.TP
.B no_cache_dir
Disable the cache.
.TP
.B extra_args
pip keyword and positional arguments not yet implemented in salt
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.install pandas extra_args=\(dq[{\(aq\-\-latest\-pip\-kwarg\(aq:\(aqparam\(aq}, \(aq\-\-latest\-pip\-arg\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
If unsupported options are passed here that are not supported in a
minion\(aqs version of pip, a \fINo such option error\fP will be thrown.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Will be translated into the following pip command:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pandas \-\-latest\-pip\-kwarg param \-\-latest\-pip\-arg
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B disable_version_check
Pip may periodically check PyPI to determine whether a new version of
pip is available to download. Passing True for this option disables
that check.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.install <package name>,<package2 name>
salt \(aq*\(aq pip.install requirements=/path/to/requirements.txt
salt \(aq*\(aq pip.install <package name> bin_env=/path/to/virtualenv
salt \(aq*\(aq pip.install <package name> bin_env=/path/to/pip_bin
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Complicated CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.install markdown,django                 editable=git+https://github.com/worldcompany/djangoembed.git#egg=djangoembed upgrade=True no_deps=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pip.is_installed(pkgname, bin_env=None, user=None, cwd=None)
New in version 2018.3.0.

.sp
Changed in version 3006.0.

.sp
Filter list of installed modules and return True if \fBpkgname\fP exists in
the list of packages installed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.is_installed salt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pip.list_(prefix=None, bin_env=None, user=None, cwd=None, env_vars=None, **kwargs)
Changed in version 3006.0.

.sp
Output list of installed apps from \fBpip list\fP in JSON format and check to
see if \fBprefix\fP exists in the list of packages installed.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the version of pip available is older than 9.0.0, parsing the
\fBfreeze\fP function output will be used to determine the name and
version of installed modules.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.list salt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pip.list_all_versions(pkg, bin_env=None, include_alpha=False, include_beta=False, include_rc=False, user=None, cwd=None, index_url=None, extra_index_url=None)
New in version 2017.7.3.

.sp
List all available versions of a pip package
.INDENT 7.0
.TP
.B pkg
The package to check
.TP
.B bin_env
Path to pip (or to a virtualenv). This can be used to specify the path
to the pip to use when more than one Python release is installed (e.g.
\fB/usr/bin/pip\-2.7\fP or \fB/usr/bin/pip\-2.6\fP\&. If a directory path is
specified, it is assumed to be a virtualenv.
.TP
.B include_alpha
Include alpha versions in the list
.TP
.B include_beta
Include beta versions in the list
.TP
.B include_rc
Include release candidates versions in the list
.TP
.B user
The user under which to run pip
.TP
.B cwd
Directory from which to run pip
.TP
.B index_url
Base URL of Python Package Index
\&.. versionadded:: 2019.2.0
.TP
.B extra_index_url
Additional URL of Python Package Index
\&.. versionadded:: 2019.2.0
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.list_all_versions <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pip.list_freeze_parse(prefix=None, bin_env=None, user=None, cwd=None, env_vars=None, **kwargs)
New in version 3006.0.

.sp
Filter list of installed apps from \fBfreeze\fP and check to see if
\fBprefix\fP exists in the list of packages installed.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the version of pip available is older than 8.0.3, the packages
\fBwheel\fP, \fBsetuptools\fP, and \fBdistribute\fP will not be reported by
this function even if they are installed. Unlike \fI\%pip.freeze\fP, this function always reports the version of
pip which is installed.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.list_freeze_parse salt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pip.list_upgrades(bin_env=None, user=None, cwd=None)
Check whether or not an upgrade is available for all packages
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pip.uninstall(pkgs=None, requirements=None, bin_env=None, log=None, proxy=None, timeout=None, user=None, cwd=None, saltenv=\(aqbase\(aq, use_vt=False)
Uninstall packages individually or from a pip requirements file
.INDENT 7.0
.TP
.B pkgs
comma separated list of packages to install
.TP
.B requirements
Path to requirements file
.TP
.B bin_env
Path to pip (or to a virtualenv). This can be used to specify the path
to the pip to use when more than one Python release is installed (e.g.
\fB/usr/bin/pip\-2.7\fP or \fB/usr/bin/pip\-2.6\fP\&. If a directory path is
specified, it is assumed to be a virtualenv.
.TP
.B log
Log file where a complete (maximum verbosity) record will be kept
.TP
.B proxy
Specify a proxy in the format \fBuser:passwd@proxy.server:port\fP\&. Note
that the \fBuser:password@\fP is optional and required only if you are
behind an authenticated proxy.  If you provide
\fBuser@proxy.server:port\fP then you will be prompted for a password.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the Minion has a globaly configured proxy \- it will be used
even if no proxy was set here. To explicitly disable proxy for pip
you should pass \fBFalse\fP as a value.
.UNINDENT
.UNINDENT
.TP
.B timeout
Set the socket timeout (default 15 seconds)
.TP
.B user
The user under which to run pip
.TP
.B cwd
Directory from which to run pip
.TP
.B use_vt
Use VT terminal emulation (see output while installing)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.uninstall <package name>,<package2 name>
salt \(aq*\(aq pip.uninstall requirements=/path/to/requirements.txt
salt \(aq*\(aq pip.uninstall <package name> bin_env=/path/to/virtualenv
salt \(aq*\(aq pip.uninstall <package name> bin_env=/path/to/pip_bin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pip.upgrade(bin_env=None, user=None, cwd=None, use_vt=False)
New in version 2015.5.0.

.sp
Upgrades outdated pip packages.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On Windows you can\(aqt update salt from pip using salt, so salt will be
skipped
.UNINDENT
.UNINDENT
.sp
Returns a dict containing the changes.
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B {\(aq<package>\(aq:  {\(aqold\(aq: \(aq<old\-version>\(aq,
\(aqnew\(aq: \(aq<new\-version>\(aq}}
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.upgrade
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pip.upgrade_available(pkg, bin_env=None, user=None, cwd=None)
New in version 2015.5.0.

.sp
Check whether or not an upgrade is available for a given package
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.upgrade_available <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pip.version(bin_env=None, cwd=None, user=None)
New in version 0.17.0.

.sp
Returns the version of pip. Use \fBbin_env\fP to specify the path to a
virtualenv and get the version of pip in that virtualenv.
.sp
If unable to detect the pip version, returns \fBNone\fP\&.
.sp
Changed in version 3001.1: The \fBuser\fP parameter was added, to allow specifying the user who runs
the version command.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pip.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pkg_resource
.sp
Resources needed by pkg providers
.INDENT 0.0
.TP
.B salt.modules.pkg_resource.add_pkg(pkgs, name, pkgver)
Add a package to a dict of installed packages.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg_resource.add_pkg \(aq{}\(aq bind 9
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkg_resource.check_extra_requirements(pkgname, pkgver)
Check if the installed package already has the given requirements.
This function will return the result of \fBpkg.check_extra_requirements\fP if
this function exists for the minion, otherwise it will return True.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg_resource.check_extra_requirements <pkgname> <extra_requirements>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkg_resource.format_pkg_list(packages, versions_as_list, attr)
Formats packages according to parameters for list_pkgs.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkg_resource.format_version(epoch, version, release)
Formats a version string for list_pkgs.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkg_resource.pack_sources(sources, normalize=True)
Accepts list of dicts (or a string representing a list of dicts) and packs
the key/value pairs into a single dict.
.sp
\fB\(aq[{\(dqfoo\(dq: \(dqsalt://foo.rpm\(dq}, {\(dqbar\(dq: \(dqsalt://bar.rpm\(dq}]\(aq\fP would become
\fB{\(dqfoo\(dq: \(dqsalt://foo.rpm\(dq, \(dqbar\(dq: \(dqsalt://bar.rpm\(dq}\fP
.INDENT 7.0
.TP
.B normalize
True
Normalize the package name by removing the architecture, if the
architecture of the package is different from the architecture of the
operating system. The ability to disable this behavior is useful for
poorly\-created packages which include the architecture as an actual
part of the name, such as kernel modules which match a specific kernel
version.
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg_resource.pack_sources \(aq[{\(dqfoo\(dq: \(dqsalt://foo.rpm\(dq}, {\(dqbar\(dq: \(dqsalt://bar.rpm\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkg_resource.parse_targets(name=None, pkgs=None, sources=None, saltenv=\(aqbase\(aq, normalize=True, **kwargs)
Parses the input to pkg.install and returns back the package(s) to be
installed. Returns a list of packages, as well as a string noting whether
the packages are to come from a repository or a binary package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg_resource.parse_targets
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkg_resource.sort_pkglist(pkgs)
Accepts a dict obtained from pkg.list_pkgs() and sorts in place the list of
versions for any packages that have multiple versions installed, so that
two package lists can be compared to one another.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg_resource.sort_pkglist \(aq[\(dq3.45\(dq, \(dq2.13\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkg_resource.stringify(pkgs)
Takes a dict of package name/version information and joins each list of
installed versions into a string.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg_resource.stringify \(aqvim: 7.127\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkg_resource.version(*names, **kwargs)
Common interface for obtaining the version of installed packages.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg_resource.version vim
salt \(aq*\(aq pkg_resource.version foo bar baz
salt \(aq*\(aq pkg_resource.version \(aqpython*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkg_resource.version_clean(verstr)
Clean the version string removing extra data.
This function will simply try to call \fBpkg.version_clean\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg_resource.version_clean <version_string>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkg_resource.version_compare(ver1, oper, ver2, ignore_epoch=False)
New in version 3001.

.sp
Perform a version comparison, using (where available) platform\-specific
version comparison tools to make the comparison.
.INDENT 7.0
.TP
.B ver1
The first version to be compared
.TP
.B oper
One of \fI==\fP, \fI!=\fP, \fI>=\fP, \fI<=\fP, \fI>\fP, \fI<\fP
.TP
.B ver2
The second version to be compared
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To avoid shell interpretation, each of the above values should be
quoted when this function is used on the CLI.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B ignore_epoch
False
If \fBTrue\fP, both package versions will have their epoch prefix
stripped before comparison.
.UNINDENT
.sp
This function is useful in Jinja templates, to perform specific actions
when a package\(aqs version meets certain criteria. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set postfix_version = salt.pkg.version(\(aqpostfix\(aq) %}
{%\- if postfix_version and salt.pkg_resource.version_compare(postfix_version, \(aq>=\(aq, \(aq3.3\(aq, ignore_epoch=True) %}
  {#\- do stuff #}
{%\- endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pkg_resource.version_compare \(aq3.5\(aq \(aq<=\(aq \(aq2.4\(aq
salt myminion pkg_resource.version_compare \(aq3.5\(aq \(aq<=\(aq \(aq2.4\(aq ignore_epoch=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pkgin
.sp
Package support for pkgin based systems, inspired from freebsdpkg module
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage packages on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgin.available_version(*names, **kwargs)
This function is an alias of \fBlatest_version\fP\&.
.INDENT 7.0
.INDENT 3.5
Changed in version 2016.3.0.

.sp
Return the latest version of the named package available for upgrade or
installation.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgin.file_dict(*packages, **kwargs)
Changed in version 2016.3.0.

.sp
List the files that belong to a package.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_dict nginx
salt \(aq*\(aq pkg.file_dict nginx varnish
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgin.file_list(package, **kwargs)
List the files that belong to a package.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_list nginx
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgin.install(name=None, refresh=False, fromrepo=None, pkgs=None, sources=None, **kwargs)
Install the passed package
.INDENT 7.0
.TP
.B name
The name of the package to be installed.
.TP
.B refresh
Whether or not to refresh the package database before installing.
.TP
.B fromrepo
Specify a package repository to install from.
.UNINDENT
.sp
Multiple Package Installation Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to install from a software repository. Must be
passed as a python list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq,\(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B sources
A list of packages to install. Must be passed as a list of dicts,
with the keys being package names, and the values being the source URI
or local path to the package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install sources=\(aq[{\(dqfoo\(dq: \(dqsalt://foo.deb\(dq},{\(dqbar\(dq: \(dqsalt://bar.deb\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Return a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgin.latest_version(*names, **kwargs)
Changed in version 2016.3.0.

.sp
Return the latest version of the named package available for upgrade or
installation.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgin.list_pkgs(versions_as_list=False, **kwargs)
Changed in version 2016.3.0.

.sp
List the packages currently installed as a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgin.list_upgrades(refresh=True, **kwargs)
List all available package upgrades.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B refresh
Whether or not to refresh the package database before installing.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgin.normalize_name(pkgs, **kwargs)
Normalize package names
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Nothing special to do to normalize, just return
the original. (We do need it to be compatible
with the pkg_resource provider.)
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgin.purge(name=None, pkgs=None, **kwargs)
Package purges are not supported, this function is identical to
\fBremove()\fP\&.
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.purge <package name>
salt \(aq*\(aq pkg.purge <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.purge pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgin.refresh_db(force=False, **kwargs)
Use pkg update to get latest pkg_summary
.INDENT 7.0
.TP
.B force
Pass \-f so that the cache is always refreshed.
.sp
New in version 2018.3.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgin.remove(name=None, pkgs=None, **kwargs)
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a list containing the removed packages.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgin.search(pkg_name, **kwargs)
Searches for an exact match using pkgin ^package$
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search \(aqmysql\-server\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgin.upgrade(refresh=True, pkgs=None, **kwargs)
Run pkg upgrade, if pkgin used. Otherwise do nothing
.INDENT 7.0
.TP
.B refresh
Whether or not to refresh the package database before installing.
.UNINDENT
.sp
Multiple Package Upgrade Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to upgrade from a software repository. Must be
passed as a python list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade pkgs=\(aq[\(dqfoo\(dq,\(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Returns a dictionary containing the changes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq:  {\(aqold\(aq: \(aq<old\-version>\(aq,
                \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgin.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pkgng
.sp
Support for \fBpkgng\fP, the new package manager for FreeBSD
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage packages on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module has been completely rewritten. Up to and including version
0.17.x, it was available as the \fBpkgng\fP module, (\fBpkgng.install\fP,
\fBpkgng.delete\fP, etc.), but moving forward this module will no longer be
available as \fBpkgng\fP, as it will behave like a normal Salt \fBpkg\fP
provider. The documentation below should not be considered to apply to this
module in versions <= 0.17.x. If your minion is running a 0.17.x release or
older, then the documentation for this module can be viewed using the
\fBsys.doc\fP function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt bsdminion sys.doc pkgng
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
This module provides an interface to \fBpkg(8)\fP\&. It acts as the default
package provider for FreeBSD 10 and newer. For FreeBSD hosts which have
been upgraded to use pkgng, you will need to override the \fBpkg\fP provider
by setting the \fI\%providers\fP parameter in your Minion config
file, in order to use this module to manage packages, like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
providers:
  pkg: pkgng
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.audit(jail=None, chroot=None, root=None)
Audits installed packages against known vulnerabilities
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.audit
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
Audit packages within the specified jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.audit jail=<jail name or id>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
Audit packages within the specified chroot (ignored if \fBjail\fP is
specified)
.TP
.B root
Audit packages within the specified root (ignored if \fBjail\fP is
specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.audit chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.autoremove(jail=None, chroot=None, root=None, dryrun=False)
Delete packages which were automatically installed as dependencies and are
not required anymore.
.INDENT 7.0
.TP
.B dryrun
Dry\-run mode. The list of changes to packages is always printed,
but no changes are actually made.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.autoremove
salt \(aq*\(aq pkg.autoremove jail=<jail name or id>
salt \(aq*\(aq pkg.autoremove dryrun=True
salt \(aq*\(aq pkg.autoremove jail=<jail name or id> dryrun=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.available_version(*names, **kwargs)
This function is an alias of \fBlatest_version\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package name> jail=<jail name or id>
salt \(aq*\(aq pkg.latest_version <package name> chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.backup(file_name, jail=None, chroot=None, root=None)
Export installed packages into yaml+mtree file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.backup /tmp/pkg
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
Backup packages from the specified jail. Note that this will run the
command within the jail, and so the path to the backup file will be
relative to the root of the jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.backup /tmp/pkg jail=<jail name or id>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
Backup packages from the specified chroot (ignored if \fBjail\fP is
specified). Note that this will run the command within the chroot, and
so the path to the backup file will be relative to the root of the
chroot.
.TP
.B root
Backup packages from the specified root (ignored if \fBjail\fP is
specified). Note that this will run the command within the root, and
so the path to the backup file will be relative to the root of the
root.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.backup /tmp/pkg chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.check(jail=None, chroot=None, root=None, depends=False, recompute=False, checksum=False, checklibs=False)
Sanity checks installed packages
.INDENT 7.0
.TP
.B jail
Perform the sanity check in the specified jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.check jail=<jail name or id>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
Perform the sanity check in the specified chroot (ignored if \fBjail\fP
is specified)
.TP
.B root
Perform the sanity check in the specified root (ignored if \fBjail\fP
is specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.check chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Of the below, at least one must be set to \fBTrue\fP\&.
.INDENT 7.0
.TP
.B depends
Check for and install missing dependencies.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.check depends=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B recompute
Recompute sizes and checksums of installed packages.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.check recompute=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B checksum
Find invalid checksums for installed packages.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.check checksum=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B checklibs
Regenerates the library dependency metadata for a package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.check checklibs=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.clean(jail=None, chroot=None, root=None, clean_all=False, dryrun=False)
Cleans the local cache of fetched remote packages
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.clean
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
Cleans the package cache in the specified jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.clean jail=<jail name or id>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
Cleans the package cache in the specified chroot (ignored if \fBjail\fP
is specified)
.TP
.B root
Cleans the package cache in the specified root (ignored if \fBjail\fP
is specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.clean chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B clean_all
Clean all packages from the local cache (not just those that have been
superseded by newer versions).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
salt \(aq*\(aq pkg.clean clean_all=True
.TP
.B dryrun
Dry\-run mode. This list of changes to the local cache is always
printed, but no changes are actually made.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.clean dryrun=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.delete(name=None, pkgs=None, jail=None, chroot=None, root=None, all_installed=False, force=False, glob=False, dryrun=False, recurse=False, regex=False, pcre=False, **kwargs)
This function is an alias of \fBremove\fP\&.
.INDENT 7.0
.INDENT 3.5
Remove a package from the database and system
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This function can accessed using \fBpkg.delete\fP in addition to
\fBpkg.remove\fP, to more closely match the CLI usage of \fBpkg(8)\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B name
The package to remove
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B jail
Delete the package from the specified jail
.TP
.B chroot
Delete the package from the specified chroot (ignored if \fBjail\fP is
specified)
.TP
.B root
Delete the package from the specified root (ignored if \fBjail\fP is
specified)
.TP
.B all_installed
Deletes all installed packages from the system and empties the
database. USE WITH CAUTION!
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove all all_installed=True force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B force
Forces packages to be removed despite leaving unresolved
dependencies.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name> force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B glob
Treat the package names as shell glob patterns.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name> glob=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B dryrun
Dry run mode. The list of packages to delete is always printed, but
no packages are actually deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name> dryrun=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B recurse
Delete all packages that require the listed package as well.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name> recurse=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B regex
Treat the package names as regular expressions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <regular expression> regex=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B pcre
Treat the package names as extended regular expressions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <extended regular expression> pcre=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.fetch(name, jail=None, chroot=None, root=None, fetch_all=False, quiet=False, fromrepo=None, glob=True, regex=False, pcre=False, local=False, depends=False)
Fetches remote packages
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.fetch <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
Fetch package in the specified jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.fetch <package name> jail=<jail name or id>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
Fetch package in the specified chroot (ignored if \fBjail\fP is
specified)
.TP
.B root
Fetch package in the specified root (ignored if \fBjail\fP is
specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.fetch <package name> chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B fetch_all
Fetch all packages.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.fetch <package name> fetch_all=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B quiet
Quiet mode. Show less output.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.fetch <package name> quiet=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B fromrepo
Fetches packages from the given repo if multiple repo support
is enabled. See \fBpkg.conf(5)\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.fetch <package name> fromrepo=repo
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B glob
Treat pkg_name as a shell glob pattern.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.fetch <package name> glob=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B regex
Treat pkg_name as a regular expression.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.fetch <regular expression> regex=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B pcre
Treat pkg_name is an extended regular expression.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.fetch <extended regular expression> pcre=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B local
Skip updating the repository catalogs with pkg\-update(8). Use the
local cache only.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.fetch <package name> local=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
Fetch the package and its dependencies as well.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.fetch <package name> depends=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.hold(name=None, pkgs=None, **kwargs)
Version\-lock packages
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function is provided primarily for compatibility with some
parts of \fI\%states.pkg\fP\&.
Consider using Consider using \fI\%pkg.lock\fP instead. instead.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the package to be held.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to hold. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.hold <package name>
salt \(aq*\(aq pkg.hold pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.info(*names, **kwargs)
This function is an alias of \fBversion\fP\&.
.INDENT 7.0
.INDENT 3.5
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This function can accessed using \fBpkg.info\fP in addition to
\fBpkg.version\fP, to more closely match the CLI usage of \fBpkg(8)\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B jail
Get package version information for the specified jail
.TP
.B chroot
Get package version information for the specified chroot (ignored if
\fBjail\fP is specified)
.TP
.B root
Get package version information for the specified root (ignored if
\fBjail\fP is specified)
.TP
.B with_origin
False
Return a nested dictionary containing both the origin name and version
for each specified package.
.sp
New in version 2014.1.0.

.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package name> jail=<jail name or id>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.install(name=None, fromrepo=None, pkgs=None, sources=None, jail=None, chroot=None, root=None, orphan=False, force=False, glob=False, local=False, dryrun=False, quiet=False, reinstall_requires=False, regex=False, pcre=False, batch=False, **kwargs)
Install package(s) from a repository
.INDENT 7.0
.TP
.B name
The name of the package to install
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B jail
Install the package into the specified jail
.TP
.B chroot
Install the package into the specified chroot (ignored if \fBjail\fP is
specified)
.TP
.B root
Install the package into the specified root (ignored if \fBjail\fP is
specified)
.TP
.B orphan
Mark the installed package as orphan. Will be automatically removed
if no other packages depend on them. For more information please
refer to \fBpkg\-autoremove(8)\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name> orphan=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B force
Force the reinstallation of the package if already installed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name> force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B glob
Treat the package names as shell glob patterns.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name> glob=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B local
Do not update the repository catalogs with \fBpkg\-update(8)\fP\&.  A
value of \fBTrue\fP here is equivalent to using the \fB\-U\fP flag with
\fBpkg install\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name> local=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B dryrun
Dru\-run mode. The list of changes to packages is always printed,
but no changes are actually made.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name> dryrun=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B quiet
Force quiet output, except when dryrun is used, where pkg install
will always show packages to be installed, upgraded or deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name> quiet=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B reinstall_requires
When used with force, reinstalls any packages that require the
given package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name> reinstall_requires=True force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.7.0: \fBrequire\fP kwarg renamed to \fBreinstall_requires\fP

.TP
.B fromrepo
In multi\-repo mode, override the pkg.conf ordering and only attempt
to download packages from the named repository.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name> fromrepo=repo
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B regex
Treat the package names as a regular expression
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <regular expression> regex=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B pcre
Treat the package names as extended regular expressions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B batch
Use BATCH=true for pkg install, skipping all questions.
Be careful when using in production.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name> batch=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.latest_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package name> jail=<jail name or id>
salt \(aq*\(aq pkg.latest_version <package name> chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.list_locked(**kwargs)
Query the package database those packages which are
locked against reinstallation, modification or deletion.
.sp
Returns returns a list of package names with version strings
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_locked
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
List locked packages within the specified jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_locked jail=<jail name or id>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
List locked packages within the specified chroot (ignored if \fBjail\fP is
specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_locked chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B root
List locked packages within the specified root (ignored if \fBjail\fP is
specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_locked root=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.list_pkgs(versions_as_list=False, jail=None, chroot=None, root=None, with_origin=False, **kwargs)
List the packages currently installed as a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
List the packages in the specified jail
.TP
.B chroot
List the packages in the specified chroot (ignored if \fBjail\fP is
specified)
.TP
.B root
List the packages in the specified root (ignored if \fBjail\fP is
specified)
.TP
.B with_origin
False
Return a nested dictionary containing both the origin name and version
for each installed package.
.sp
New in version 2014.1.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
salt \(aq*\(aq pkg.list_pkgs jail=<jail name or id>
salt \(aq*\(aq pkg.list_pkgs chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.list_upgrades(refresh=True, **kwargs)
List those packages for which an upgrade is available
.sp
The \fBfromrepo\fP argument is also supported, as used in pkg states.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
List upgrades within the specified jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades jail=<jail name or id>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
List upgrades within the specified chroot (ignored if \fBjail\fP is
specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B root
List upgrades within the specified root (ignored if \fBjail\fP is
specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades root=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.lock(name, **kwargs)
Lock the named package against reinstallation, modification or deletion.
.sp
Returns True if the named package was successfully locked.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.lock <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
Lock packages within the specified jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.lock <package name> jail=<jail name or id>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
Lock packages within the specified chroot (ignored if \fBjail\fP is
specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.lock <package name> chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B root
Lock packages within the specified root (ignored if \fBjail\fP is
specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.lock <package name> root=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.locked(name, **kwargs)
Query the package database to determine if the named package
is locked against reinstallation, modification or deletion.
.sp
Returns True if the named package is locked, False otherwise.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.locked <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
Test if a package is locked within the specified jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.locked <package name> jail=<jail name or id>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
Test if a package is locked within the specified chroot (ignored if \fBjail\fP is
specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.locked <package name> chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B root
Test if a package is locked within the specified root (ignored if \fBjail\fP is
specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.locked <package name> root=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.parse_config(file_name=\(aq/usr/local/etc/pkg.conf\(aq)
Return dict of uncommented global variables.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.parse_config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP not working properly right now
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.purge(name=None, pkgs=None, jail=None, chroot=None, root=None, all_installed=False, force=False, glob=False, dryrun=False, recurse=False, regex=False, pcre=False, **kwargs)
This function is an alias of \fBremove\fP\&.
.INDENT 7.0
.INDENT 3.5
Remove a package from the database and system
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This function can accessed using \fBpkg.delete\fP in addition to
\fBpkg.remove\fP, to more closely match the CLI usage of \fBpkg(8)\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B name
The package to remove
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B jail
Delete the package from the specified jail
.TP
.B chroot
Delete the package from the specified chroot (ignored if \fBjail\fP is
specified)
.TP
.B root
Delete the package from the specified root (ignored if \fBjail\fP is
specified)
.TP
.B all_installed
Deletes all installed packages from the system and empties the
database. USE WITH CAUTION!
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove all all_installed=True force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B force
Forces packages to be removed despite leaving unresolved
dependencies.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name> force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B glob
Treat the package names as shell glob patterns.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name> glob=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B dryrun
Dry run mode. The list of packages to delete is always printed, but
no packages are actually deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name> dryrun=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B recurse
Delete all packages that require the listed package as well.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name> recurse=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B regex
Treat the package names as regular expressions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <regular expression> regex=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B pcre
Treat the package names as extended regular expressions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <extended regular expression> pcre=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.refresh_db(jail=None, chroot=None, root=None, force=False, **kwargs)
Refresh PACKAGESITE contents
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function can accessed using \fBpkg.update\fP in addition to
\fBpkg.refresh_db\fP, to more closely match the CLI usage of \fBpkg(8)\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
Refresh the pkg database within the specified jail
.TP
.B chroot
Refresh the pkg database within the specified chroot (ignored if
\fBjail\fP is specified)
.TP
.B root
Refresh the pkg database within the specified root (ignored if
\fBjail\fP is specified)
.TP
.B force
Force a full download of the repository catalog without regard to the
respective ages of the local and remote copies of the catalog.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.remove(name=None, pkgs=None, jail=None, chroot=None, root=None, all_installed=False, force=False, glob=False, dryrun=False, recurse=False, regex=False, pcre=False, **kwargs)
Remove a package from the database and system
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function can accessed using \fBpkg.delete\fP in addition to
\fBpkg.remove\fP, to more closely match the CLI usage of \fBpkg(8)\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The package to remove
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B jail
Delete the package from the specified jail
.TP
.B chroot
Delete the package from the specified chroot (ignored if \fBjail\fP is
specified)
.TP
.B root
Delete the package from the specified root (ignored if \fBjail\fP is
specified)
.TP
.B all_installed
Deletes all installed packages from the system and empties the
database. USE WITH CAUTION!
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove all all_installed=True force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B force
Forces packages to be removed despite leaving unresolved
dependencies.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name> force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B glob
Treat the package names as shell glob patterns.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name> glob=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B dryrun
Dry run mode. The list of packages to delete is always printed, but
no packages are actually deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name> dryrun=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B recurse
Delete all packages that require the listed package as well.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name> recurse=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B regex
Treat the package names as regular expressions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <regular expression> regex=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B pcre
Treat the package names as extended regular expressions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <extended regular expression> pcre=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.restore(file_name, jail=None, chroot=None, root=None)
Reads archive created by pkg backup \-d and recreates the database.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.restore /tmp/pkg
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
Restore database to the specified jail. Note that this will run the
command within the jail, and so the path to the file from which the pkg
database will be restored is relative to the root of the jail.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.restore /tmp/pkg jail=<jail name or id>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
Restore database to the specified chroot (ignored if \fBjail\fP is
specified). Note that this will run the command within the chroot, and
so the path to the file from which the pkg database will be restored is
relative to the root of the chroot.
.TP
.B root
Restore database to the specified root (ignored if \fBjail\fP is
specified). Note that this will run the command within the root, and
so the path to the file from which the pkg database will be restored is
relative to the root of the root.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.restore /tmp/pkg chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.search(name, jail=None, chroot=None, root=None, exact=False, glob=False, regex=False, pcre=False, comment=False, desc=False, full=False, depends=False, size=False, quiet=False, origin=False, prefix=False)
Searches in remote package repositories
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search pattern
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
Perform the search using the \fBpkg.conf(5)\fP from the specified jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search pattern jail=<jail name or id>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
Perform the search using the \fBpkg.conf(5)\fP from the specified chroot
(ignored if \fBjail\fP is specified)
.TP
.B root
Perform the search using the \fBpkg.conf(5)\fP from the specified root
(ignored if \fBjail\fP is specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search pattern chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B exact
Treat pattern as exact pattern.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search pattern exact=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B glob
Treat pattern as a shell glob pattern.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search pattern glob=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B regex
Treat pattern as a regular expression.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search pattern regex=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B pcre
Treat pattern as an extended regular expression.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search pattern pcre=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B comment
Search for pattern in the package comment one\-line description.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search pattern comment=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B desc
Search for pattern in the package description.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search pattern desc=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B full
Displays full information about the matching packages.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search pattern full=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B depends
Displays the dependencies of pattern.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search pattern depends=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B size
Displays the size of the package
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search pattern size=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B quiet
Be quiet. Prints only the requested information without displaying
many hints.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search pattern quiet=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B origin
Displays pattern origin.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search pattern origin=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B prefix
Displays the installation prefix for each package matching pattern.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search pattern prefix=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.stats(local=False, remote=False, jail=None, chroot=None, root=None, bytes=False)
Return pkgng stats.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.stats
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B local
Display stats only for the local package database.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.stats local=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B remote
Display stats only for the remote package database(s).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.stats remote=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B bytes
Display disk space usage in bytes only.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.stats bytes=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B jail
Retrieve stats from the specified jail.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.stats jail=<jail name or id>
salt \(aq*\(aq pkg.stats jail=<jail name or id> local=True
salt \(aq*\(aq pkg.stats jail=<jail name or id> remote=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
Retrieve stats from the specified chroot (ignored if \fBjail\fP is
specified).
.TP
.B root
Retrieve stats from the specified root (ignored if \fBjail\fP is
specified).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.stats chroot=/path/to/chroot
salt \(aq*\(aq pkg.stats chroot=/path/to/chroot local=True
salt \(aq*\(aq pkg.stats chroot=/path/to/chroot remote=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.unhold(name=None, pkgs=None, **kwargs)
Remove version locks
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function is provided primarily for compatibility with some parts of
\fI\%states.pkg\fP\&.  Consider using
\fI\%pkg.unlock\fP instead.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the package to be unheld
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to unhold. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.unhold <package name>
salt \(aq*\(aq pkg.unhold pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.unlock(name, **kwargs)
Unlock the named package against reinstallation, modification or deletion.
.sp
Returns True if the named package was successfully unlocked.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.unlock <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
Unlock packages within the specified jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.unlock <package name> jail=<jail name or id>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
Unlock packages within the specified chroot (ignored if \fBjail\fP is
specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.unlock <package name> chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B root
Unlock packages within the specified root (ignored if \fBjail\fP is
specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.unlock <package name> root=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.update(jail=None, chroot=None, root=None, force=False, **kwargs)
This function is an alias of \fBrefresh_db\fP\&.
.INDENT 7.0
.INDENT 3.5
Refresh PACKAGESITE contents
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This function can accessed using \fBpkg.update\fP in addition to
\fBpkg.refresh_db\fP, to more closely match the CLI usage of \fBpkg(8)\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B jail
Refresh the pkg database within the specified jail
.TP
.B chroot
Refresh the pkg database within the specified chroot (ignored if
\fBjail\fP is specified)
.TP
.B root
Refresh the pkg database within the specified root (ignored if
\fBjail\fP is specified)
.TP
.B force
Force a full download of the repository catalog without regard to the
respective ages of the local and remote copies of the catalog.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.update_package_site(new_url)
Updates remote package repo URL, PACKAGESITE var to be exact.
.sp
Must use \fBhttp://\fP, \fBftp://\fP, or \fBhttps://\fP protocol
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.update_package_site http://127.0.0.1/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.updating(name, jail=None, chroot=None, root=None, filedate=None, filename=None)
\(aq
Displays UPDATING entries of software packages
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.updating foo
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
Perform the action in the specified jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.updating foo jail=<jail name or id>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
Perform the action in the specified chroot (ignored if \fBjail\fP is
specified)
.TP
.B root
Perform the action in the specified root (ignored if \fBjail\fP is
specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.updating foo chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B filedate
Only entries newer than date are shown. Use a YYYYMMDD date format.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.updating foo filedate=20130101
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B filename
Defines an alternative location of the UPDATING file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.updating foo filename=/tmp/UPDATING
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.upgrade(*names, **kwargs)
Upgrade named or all packages (run a \fBpkg upgrade\fP). If <package name> is
omitted, the operation is executed on all packages.
.sp
Returns a dictionary containing the changes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq:  {\(aqold\(aq: \(aq<old\-version>\(aq,
                \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
Audit packages within the specified jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade <package name> jail=<jail name or id>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
Audit packages within the specified chroot (ignored if \fBjail\fP is
specified)
.TP
.B root
Audit packages within the specified root (ignored if \fBjail\fP is
specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade <package name> chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Any of the below options can also be used with \fBjail\fP or \fBchroot\fP\&.
.INDENT 7.0
.TP
.B force
Force reinstalling/upgrading the whole set of packages.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade <package name> force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B local
Do not update the repository catalogs with \fBpkg\-update(8)\fP\&. A value
of \fBTrue\fP here is equivalent to using the \fB\-U\fP flag with \fBpkg
upgrade\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade <package name> local=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B dryrun
Dry\-run mode: show what packages have updates available, but do not
perform any upgrades. Repository catalogs will be updated as usual
unless the local option is also given.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade <package name> dryrun=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B fromrepo
In multi\-repo mode, override the pkg.conf ordering and only attempt
to upgrade packages from the named repository.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade <package name> fromrepo=repo
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B fetchonly
Do not perform installation of packages, merely fetch
packages that should be upgraded and detect possible conflicts.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade <package name> fetchonly=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function can accessed using \fBpkg.info\fP in addition to
\fBpkg.version\fP, to more closely match the CLI usage of \fBpkg(8)\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
Get package version information for the specified jail
.TP
.B chroot
Get package version information for the specified chroot (ignored if
\fBjail\fP is specified)
.TP
.B root
Get package version information for the specified root (ignored if
\fBjail\fP is specified)
.TP
.B with_origin
False
Return a nested dictionary containing both the origin name and version
for each specified package.
.sp
New in version 2014.1.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package name> jail=<jail name or id>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.version_cmp(pkg1, pkg2, ignore_epoch=False, **kwargs)
Do a cmp\-style comparison on two packages. Return \-1 if pkg1 < pkg2, 0 if
pkg1 == pkg2, and 1 if pkg1 > pkg2. Return None if there was a problem
making the comparison.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version_cmp \(aq2.1.11\(aq \(aq2.1.12\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgng.which(path, jail=None, chroot=None, root=None, origin=False, quiet=False)
Displays which package installed a specific file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.which <file name>
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B jail
Perform the check in the specified jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.which <file name> jail=<jail name or id>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B chroot
Perform the check in the specified chroot (ignored if \fBjail\fP is
specified)
.TP
.B root
Perform the check in the specified root (ignored if \fBjail\fP is
specified)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.which <file name> chroot=/path/to/chroot
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B origin
Shows the origin of the package instead of name\-version.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.which <file name> origin=True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B quiet
Quiet output.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.which <file name> quiet=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pkgutil
.sp
Pkgutil support for Solaris
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage packages on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgutil.available_version(*names, **kwargs)
This function is an alias of \fBlatest_version\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgutil.latest_version CSWpython
salt \(aq*\(aq pkgutil.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgutil.install(name=None, refresh=False, version=None, pkgs=None, **kwargs)
Install packages using the pkgutil tool.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package_name>
salt \(aq*\(aq pkg.install SMClgcc346
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple Package Installation Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to install from OpenCSW. Must be passed as a python
list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, {\(dqbar\(dq: \(dq1.2.3\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Returns a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgutil.latest_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgutil.latest_version CSWpython
salt \(aq*\(aq pkgutil.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgutil.list_pkgs(versions_as_list=False, **kwargs)
List the packages currently installed as a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
salt \(aq*\(aq pkg.list_pkgs versions_as_list=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgutil.list_upgrades(refresh=True, **kwargs)
List all available package upgrades on this system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgutil.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgutil.purge(name=None, pkgs=None, **kwargs)
Package purges are not supported, this function is identical to
\fBremove()\fP\&.
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.purge <package name>
salt \(aq*\(aq pkg.purge <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.purge pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgutil.refresh_db()
Updates the pkgutil repo database (pkgutil \-U)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgutil.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgutil.remove(name=None, pkgs=None, **kwargs)
Remove a package and all its dependencies which are not in use by other
packages.
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgutil.upgrade(refresh=True)
Upgrade all of the packages to the latest available version.
.sp
Returns a dict containing the changes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgutil.upgrade
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgutil.upgrade_available(name)
Check if there is an upgrade available for a certain package
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgutil.upgrade_available CSWpython
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pkgutil.version(*names, **kwargs)
Returns a version if the package is installed, else returns an empty string
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgutil.version CSWpython
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.portage_config
.sp
Configure \fBportage(5)\fP
.INDENT 0.0
.TP
.B salt.modules.portage_config.append_to_package_conf(conf, atom=\(aq\(aq, flags=None, string=\(aq\(aq, overwrite=False)
Append a string or a list of flags for a given package or DEPEND atom to a
given configuration file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq portage_config.append_to_package_conf use string=\(dqapp\-admin/salt ldap \-libvirt\(dq
salt \(aq*\(aq portage_config.append_to_package_conf use atom=\(dq> = app\-admin/salt\-0.14.1\(dq flags=\(dq[\(aqldap\(aq, \(aq\-libvirt\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.portage_config.append_use_flags(atom, uses=None, overwrite=False)
Append a list of use flags for a given package or DEPEND atom
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq portage_config.append_use_flags \(dqapp\-admin/salt[ldap, \-libvirt]\(dq
salt \(aq*\(aq portage_config.append_use_flags \(dq>=app\-admin/salt\-0.14.1\(dq \(dq[\(aqldap\(aq, \(aq\-libvirt\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.portage_config.enforce_nice_config()
Enforce a nice tree structure for /etc/portage/package.* configuration
files.
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \fBsalt.modules.ebuild.ex_mod_init()\fP
for information on automatically running this when pkg is used.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq portage_config.enforce_nice_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.portage_config.filter_flags(use, use_expand_hidden, usemasked, useforced)
New in version 2015.8.0.

.sp
Filter function to remove hidden or otherwise not normally
visible USE flags from a list.
.sp
@type use: list
@param use: the USE flag list to be filtered.
@type use_expand_hidden: list
@param  use_expand_hidden: list of flags hidden.
@type usemasked: list
@param usemasked: list of masked USE flags.
@type useforced: list
@param useforced: the forced USE flags.
@rtype: list
@return the filtered USE flags.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.portage_config.get_all_cpv_use(cp)
New in version 2015.8.0.

.sp
Uses portage to determine final USE flags and settings for an emerge.
.sp
@type cp: string
@param cp: eg cat/pkg
@rtype: lists
@return  use, use_expand_hidden, usemask, useforce
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.portage_config.get_cleared_flags(cp)
New in version 2015.8.0.

.sp
Uses portage for compare use flags which is used for installing package
and use flags which now exist int /etc/portage/package.use/
.sp
@type cp: string
@param cp: eg cat/pkg
@rtype: tuple
@rparam: tuple with two lists \- list of used flags and
list of flags which will be used
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.portage_config.get_flags_from_package_conf(conf, atom)
Get flags for a given package or DEPEND atom.
Warning: This only works if the configuration files tree is in the correct
format (the one enforced by enforce_nice_config)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq portage_config.get_flags_from_package_conf license salt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.portage_config.get_installed_use(cp, use=\(aqUSE\(aq)
New in version 2015.8.0.

.sp
Gets the installed USE flags from the VARDB.
.sp
@type: cp: string
@param cp: cat/pkg
@type use: string
@param use: 1 of [\(dqUSE\(dq, \(dqPKGUSE\(dq]
@rtype list
@returns [] or the list of IUSE flags
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.portage_config.get_iuse(cp)
New in version 2015.8.0.

.sp
Gets the current IUSE flags from the tree.
.sp
@type: cpv: string
@param cpv: cat/pkg
@rtype list
@returns [] or the list of IUSE flags
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.portage_config.get_missing_flags(conf, atom, flags)
Find out which of the given flags are currently not set.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq portage_config.get_missing_flags use salt \(dq[\(aqldap\(aq, \(aq\-libvirt\(aq, \(aqopenssl\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.portage_config.has_flag(conf, atom, flag)
Verify if the given package or DEPEND atom has the given flag.
Warning: This only works if the configuration files tree is in the correct
format (the one enforced by enforce_nice_config)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq portage_config.has_flag license salt Apache\-2.0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.portage_config.has_use(atom, use)
Verify if the given package or DEPEND atom has the given use flag.
Warning: This only works if the configuration files tree is in the correct
format (the one enforced by enforce_nice_config)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq portage_config.has_use salt libvirt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.portage_config.is_changed_uses(cp)
New in version 2015.8.0.

.sp
Uses portage for determine if the use flags of installed package
is compatible with use flags in portage configs.
.sp
@type cp: string
@param cp: eg cat/pkg
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.portage_config.is_present(conf, atom)
Tell if a given package or DEPEND atom is present in the configuration
files tree.
Warning: This only works if the configuration files tree is in the correct
format (the one enforced by enforce_nice_config)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq portage_config.is_present unmask salt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.postfix
.sp
Support for Postfix
.sp
This module is currently little more than a config file viewer and editor. It
is able to read the master.cf file (which is one style) and files in the style
of main.cf (which is a different style, that is used in multiple postfix
configuration files).
.sp
The design of this module is such that when files are edited, a minimum of
changes are made to them. Each file should look as if it has been edited by
hand; order, comments and whitespace are all preserved.
.INDENT 0.0
.TP
.B salt.modules.postfix.delete(queue_id)
Delete message(s) from the mail queue
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postfix.delete 5C33CA0DEA

salt \(aq*\(aq postfix.delete ALL
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postfix.hold(queue_id)
Put message(s) on hold from the mail queue
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postfix.hold 5C33CA0DEA

salt \(aq*\(aq postfix.hold ALL
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postfix.requeue(queue_id)
Requeue message(s) in the mail queue
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postfix.requeue 5C33CA0DEA

salt \(aq*\(aq postfix.requeue ALL
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postfix.set_main(key, value, path=\(aq/etc/postfix/main.cf\(aq)
Set a single config value in the main.cf file. If the value does not already
exist, it will be appended to the end.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <minion> postfix.set_main mailq_path /usr/bin/mailq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postfix.set_master(service, conn_type, private=\(aqy\(aq, unpriv=\(aqy\(aq, chroot=\(aqy\(aq, wakeup=\(aqn\(aq, maxproc=\(aq100\(aq, command=\(aq\(aq, write_conf=True, path=\(aq/etc/postfix/master.cf\(aq)
Set a single config value in the master.cf file. If the value does not
already exist, it will be appended to the end.
.sp
Because of shell parsing issues, \(aq\-\(aq cannot be set as a value, as is normal
in the master.cf file; either \(aqy\(aq, \(aqn\(aq or a number should be used when
calling this function from the command line. If the value used matches the
default, it will internally be converted to a \(aq\-\(aq. Calling this function
from the Python API is not affected by this limitation
.sp
The settings and their default values, in order, are: service (required),
conn_type (required), private (y), unpriv (y), chroot (y), wakeup (n),
maxproc (100), command (required).
.sp
By default, this function will write out the changes to the master.cf file,
and then returns the full contents of the file. By setting the
\fBwrite_conf\fP option to \fBFalse\fP, it will skip writing the file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <minion> postfix.set_master smtp inet n y n n 100 smtpd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postfix.show_main(path=\(aq/etc/postfix/main.cf\(aq)
Return a dict of active config values. This does not include comments,
spacing or order. Bear in mind that order is functionally important in the
main.cf file, since keys can be referred to as variables. This means that
the data returned from this function should not be used for direct
modification of the main.cf file; other functions are available for that.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <minion> postfix.show_main
salt <minion> postfix.show_main path=/path/to/main.cf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postfix.show_master(path=\(aq/etc/postfix/master.cf\(aq)
Return a dict of active config values. This does not include comments,
spacing or order.
.sp
The data returned from this function should not be used for direct
modification of the main.cf file; other functions are available for that.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <minion> postfix.show_master
salt <minion> postfix.show_master path=/path/to/master.cf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postfix.show_queue()
Show contents of the mail queue
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postfix.show_queue
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postfix.unhold(queue_id)
Set held message(s) in the mail queue to unheld
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postfix.unhold 5C33CA0DEA

salt \(aq*\(aq postfix.unhold ALL
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.postgres
.sp
Module to provide Postgres compatibility to salt.
.INDENT 0.0
.TP
.B configuration
In order to connect to Postgres, certain configuration is
required in /etc/salt/minion on the relevant minions. Some sample configs
might look like:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
postgres.host: \(aqlocalhost\(aq
postgres.port: \(aq5432\(aq
postgres.user: \(aqpostgres\(aq \-> db user
postgres.pass: \(aq\(aq
postgres.maintenance_db: \(aqpostgres\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The default for the maintenance_db is \(aqpostgres\(aq and in most cases it can
be left at the default setting.
This data can also be passed into pillar. Options passed into opts will
overwrite options passed into pillar
.UNINDENT
.sp
To prevent Postgres commands from running arbitrarily long, a timeout (in seconds) can be set
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
postgres.timeout: 60
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3006.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B note
This module uses MD5 hashing which may not be compliant with certain
security audits.
.TP
.B note
When installing postgres from the official postgres repos, on certain
linux distributions, either the psql or the initdb binary is \fInot\fP
automatically placed on the path. Add a configuration to the location
of the postgres bin\(aqs path to the relevant minion for this module:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
postgres.bins_dir: \(aq/usr/pgsql\-9.5/bin/\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.available_extensions(user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
List available postgresql extensions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.available_extensions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.create_extension(name, if_not_exists=None, schema=None, ext_version=None, from_version=None, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Install a postgresql extension
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.create_extension \(aqadminpack\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.create_metadata(name, ext_version=None, schema=None, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Get lifecycle information about an extension
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.create_metadata adminpack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.datadir_exists(name)
New in version 2016.3.0.

.sp
Checks if postgres data directory has been initialized
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.datadir_exists \(aq/var/lib/pgsql/data\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Name of the directory to check
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.datadir_init(name, auth=\(aqpassword\(aq, user=None, password=None, encoding=\(aqUTF8\(aq, locale=None, waldir=None, checksums=False, runas=None)
New in version 2016.3.0.

.sp
Initializes a postgres data directory
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.datadir_init \(aq/var/lib/pgsql/data\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the directory to initialize
.TP
.B auth
The default authentication method for local connections
.TP
.B password
The password to set for the postgres user
.TP
.B user
The database superuser name
.TP
.B encoding
The default encoding for new databases
.TP
.B locale
The default locale for new databases
.TP
.B waldir
The transaction log (WAL) directory (default is to keep WAL
inside the data directory)
.sp
New in version 2019.2.0.

.TP
.B checksums
If True, the cluster will be created with data page checksums.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Data page checksums are supported since PostgreSQL 9.3.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B runas
The system user the operation should be performed on behalf of
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.db_alter(name, user=None, host=None, port=None, maintenance_db=None, password=None, tablespace=None, owner=None, owner_recurse=False, runas=None)
Change tablespace or/and owner of database.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.db_alter dbname owner=otheruser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.db_create(name, user=None, host=None, port=None, maintenance_db=None, password=None, tablespace=None, encoding=None, lc_collate=None, lc_ctype=None, owner=None, template=None, runas=None)
Adds a databases to the Postgres server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.db_create \(aqdbname\(aq

salt \(aq*\(aq postgres.db_create \(aqdbname\(aq template=template_postgis
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.db_exists(name, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Checks if a database exists on the Postgres server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.db_exists \(aqdbname\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.db_list(user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Return dictionary with information about databases of a Postgres server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.db_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.db_remove(name, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Removes a databases from the Postgres server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.db_remove \(aqdbname\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.drop_extension(name, if_exists=None, restrict=None, cascade=None, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Drop an installed postgresql extension
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.drop_extension \(aqadminpack\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.get_available_extension(name, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Get info about an available postgresql extension
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.get_available_extension plpgsql
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.get_installed_extension(name, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Get info about an installed postgresql extension
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.get_installed_extension plpgsql
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.group_create(groupname, user=None, host=None, port=None, maintenance_db=None, password=None, createdb=None, createroles=None, encrypted=None, login=None, inherit=None, superuser=None, replication=None, rolepassword=None, groups=None, runas=None)
Creates a Postgres group. A group is postgres is similar to a user, but
cannot login.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.group_create \(aqgroupname\(aq user=\(aquser\(aq \e
        host=\(aqhostname\(aq port=\(aqport\(aq password=\(aqpassword\(aq \e
        rolepassword=\(aqrolepassword\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.group_remove(groupname, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Removes a group from the Postgres server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.group_remove \(aqgroupname\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.group_update(groupname, user=None, host=None, port=None, maintenance_db=None, password=None, createdb=None, createroles=None, encrypted=None, inherit=None, login=None, superuser=None, replication=None, rolepassword=None, groups=None, runas=None)
Updates a postgres group
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.group_update \(aqusername\(aq user=\(aquser\(aq \e
        host=\(aqhostname\(aq port=\(aqport\(aq password=\(aqpassword\(aq \e
        rolepassword=\(aqrolepassword\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.has_privileges(name, object_name, object_type, privileges=None, grant_option=None, prepend=\(aqpublic\(aq, maintenance_db=None, user=None, host=None, port=None, password=None, runas=None)
New in version 2016.3.0.

.sp
Check if a role has the specified privileges on an object
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.has_privileges user_name table_name table \e
SELECT,INSERT maintenance_db=db_name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Name of the role whose privileges should be checked on object_type
.TP
.B object_name
Name of the object on which the check is to be performed
.TP
.B object_type
The object type, which can be one of the following:
.INDENT 7.0
.IP \(bu 2
table
.IP \(bu 2
sequence
.IP \(bu 2
schema
.IP \(bu 2
tablespace
.IP \(bu 2
language
.IP \(bu 2
database
.IP \(bu 2
group
.IP \(bu 2
function
.UNINDENT
.TP
.B privileges
Comma separated list of privileges to check, from the list below:
.INDENT 7.0
.IP \(bu 2
INSERT
.IP \(bu 2
CREATE
.IP \(bu 2
TRUNCATE
.IP \(bu 2
CONNECT
.IP \(bu 2
TRIGGER
.IP \(bu 2
SELECT
.IP \(bu 2
USAGE
.IP \(bu 2
TEMPORARY
.IP \(bu 2
UPDATE
.IP \(bu 2
EXECUTE
.IP \(bu 2
REFERENCES
.IP \(bu 2
DELETE
.IP \(bu 2
ALL
.UNINDENT
.TP
.B grant_option
If grant_option is set to True, the grant option check is performed
.TP
.B prepend
Table and Sequence object types live under a schema so this should be
provided if the object is not under the default \fIpublic\fP schema
.TP
.B maintenance_db
The database to connect to
.TP
.B user
database username if different from config or default
.TP
.B password
user password if any password for a specified user
.TP
.B host
Database host if different from config or default
.TP
.B port
Database port if different from config or default
.TP
.B runas
System user all operations should be performed on behalf of
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.installed_extensions(user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
List installed postgresql extensions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.installed_extensions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.is_available_extension(name, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Test if a specific extension is available
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.is_available_extension
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.is_installed_extension(name, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Test if a specific extension is installed
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.is_installed_extension
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.language_create(name, maintenance_db, user=None, host=None, port=None, password=None, runas=None)
New in version 2016.3.0.

.sp
Installs a language into a database
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.language_create plpgsql dbname
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Language to install
.TP
.B maintenance_db
The database to install the language in
.TP
.B user
database username if different from config or default
.TP
.B password
user password if any password for a specified user
.TP
.B host
Database host if different from config or default
.TP
.B port
Database port if different from config or default
.TP
.B runas
System user all operations should be performed on behalf of
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.language_exists(name, maintenance_db, user=None, host=None, port=None, password=None, runas=None)
New in version 2016.3.0.

.sp
Checks if language exists in a database.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.language_exists plpgsql dbname
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Language to check for
.TP
.B maintenance_db
The database to check in
.TP
.B user
database username if different from config or default
.TP
.B password
user password if any password for a specified user
.TP
.B host
Database host if different from config or default
.TP
.B port
Database port if different from config or default
.TP
.B runas
System user all operations should be performed on behalf of
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.language_list(maintenance_db, user=None, host=None, port=None, password=None, runas=None)
New in version 2016.3.0.

.sp
Return a list of languages in a database.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.language_list dbname
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B maintenance_db
The database to check
.TP
.B user
database username if different from config or default
.TP
.B password
user password if any password for a specified user
.TP
.B host
Database host if different from config or default
.TP
.B port
Database port if different from config or default
.TP
.B runas
System user all operations should be performed on behalf of
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.language_remove(name, maintenance_db, user=None, host=None, port=None, password=None, runas=None)
New in version 2016.3.0.

.sp
Removes a language from a database
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.language_remove plpgsql dbname
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Language to remove
.TP
.B maintenance_db
The database to install the language in
.TP
.B user
database username if different from config or default
.TP
.B password
user password if any password for a specified user
.TP
.B host
Database host if different from config or default
.TP
.B port
Database port if different from config or default
.TP
.B runas
System user all operations should be performed on behalf of
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.owner_to(dbname, ownername, user=None, host=None, port=None, password=None, runas=None)
Set the owner of all schemas, functions, tables, views and sequences to
the given username.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.owner_to \(aqdbname\(aq \(aqusername\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.privileges_grant(name, object_name, object_type, privileges=None, grant_option=None, prepend=\(aqpublic\(aq, maintenance_db=None, user=None, host=None, port=None, password=None, runas=None)
New in version 2016.3.0.

.sp
Grant privileges on a postgres object
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.privileges_grant user_name table_name table \e
SELECT,UPDATE maintenance_db=db_name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Name of the role to which privileges should be granted
.TP
.B object_name
Name of the object on which the grant is to be performed
.TP
.B object_type
The object type, which can be one of the following:
.INDENT 7.0
.IP \(bu 2
table
.IP \(bu 2
sequence
.IP \(bu 2
schema
.IP \(bu 2
tablespace
.IP \(bu 2
language
.IP \(bu 2
database
.IP \(bu 2
group
.IP \(bu 2
function
.UNINDENT
.TP
.B privileges
Comma separated list of privileges to grant, from the list below:
.INDENT 7.0
.IP \(bu 2
INSERT
.IP \(bu 2
CREATE
.IP \(bu 2
TRUNCATE
.IP \(bu 2
CONNECT
.IP \(bu 2
TRIGGER
.IP \(bu 2
SELECT
.IP \(bu 2
USAGE
.IP \(bu 2
TEMPORARY
.IP \(bu 2
UPDATE
.IP \(bu 2
EXECUTE
.IP \(bu 2
REFERENCES
.IP \(bu 2
DELETE
.IP \(bu 2
ALL
.UNINDENT
.TP
.B grant_option
If grant_option is set to True, the recipient of the privilege can
in turn grant it to others
.TP
.B prepend
Table and Sequence object types live under a schema so this should be
provided if the object is not under the default \fIpublic\fP schema
.TP
.B maintenance_db
The database to connect to
.TP
.B user
database username if different from config or default
.TP
.B password
user password if any password for a specified user
.TP
.B host
Database host if different from config or default
.TP
.B port
Database port if different from config or default
.TP
.B runas
System user all operations should be performed on behalf of
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.privileges_list(name, object_type, prepend=\(aqpublic\(aq, maintenance_db=None, user=None, host=None, port=None, password=None, runas=None)
New in version 2016.3.0.

.sp
Return a list of privileges for the specified object.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.privileges_list table_name table maintenance_db=db_name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Name of the object for which the permissions should be returned
.TP
.B object_type
The object type, which can be one of the following:
.INDENT 7.0
.IP \(bu 2
table
.IP \(bu 2
sequence
.IP \(bu 2
schema
.IP \(bu 2
tablespace
.IP \(bu 2
language
.IP \(bu 2
database
.IP \(bu 2
group
.IP \(bu 2
function
.UNINDENT
.TP
.B prepend
Table and Sequence object types live under a schema so this should be
provided if the object is not under the default \fIpublic\fP schema
.TP
.B maintenance_db
The database to connect to
.TP
.B user
database username if different from config or default
.TP
.B password
user password if any password for a specified user
.TP
.B host
Database host if different from config or default
.TP
.B port
Database port if different from config or default
.TP
.B runas
System user all operations should be performed on behalf of
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.privileges_revoke(name, object_name, object_type, privileges=None, prepend=\(aqpublic\(aq, maintenance_db=None, user=None, host=None, port=None, password=None, runas=None)
New in version 2016.3.0.

.sp
Revoke privileges on a postgres object
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.privileges_revoke user_name table_name table \e
SELECT,UPDATE maintenance_db=db_name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Name of the role whose privileges should be revoked
.TP
.B object_name
Name of the object on which the revoke is to be performed
.TP
.B object_type
The object type, which can be one of the following:
.INDENT 7.0
.IP \(bu 2
table
.IP \(bu 2
sequence
.IP \(bu 2
schema
.IP \(bu 2
tablespace
.IP \(bu 2
language
.IP \(bu 2
database
.IP \(bu 2
group
.IP \(bu 2
function
.UNINDENT
.TP
.B privileges
Comma separated list of privileges to revoke, from the list below:
.INDENT 7.0
.IP \(bu 2
INSERT
.IP \(bu 2
CREATE
.IP \(bu 2
TRUNCATE
.IP \(bu 2
CONNECT
.IP \(bu 2
TRIGGER
.IP \(bu 2
SELECT
.IP \(bu 2
USAGE
.IP \(bu 2
TEMPORARY
.IP \(bu 2
UPDATE
.IP \(bu 2
EXECUTE
.IP \(bu 2
REFERENCES
.IP \(bu 2
DELETE
.IP \(bu 2
ALL
.UNINDENT
.TP
.B maintenance_db
The database to connect to
.TP
.B user
database username if different from config or default
.TP
.B password
user password if any password for a specified user
.TP
.B host
Database host if different from config or default
.TP
.B port
Database port if different from config or default
.TP
.B runas
System user all operations should be performed on behalf of
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.psql_query(query, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None, write=False)
Run an SQL\-Query and return the results as a list. This command
only supports SELECT statements.  This limitation can be worked around
with a query like this:
.sp
WITH updated AS (UPDATE pg_authid SET rolconnlimit = 2000 WHERE
rolname = \(aqrolename\(aq RETURNING rolconnlimit) SELECT * FROM updated;
.INDENT 7.0
.TP
.B query
The query string.
.TP
.B user
Database username, if different from config or default.
.TP
.B host
Database host, if different from config or default.
.TP
.B port
Database port, if different from the config or default.
.TP
.B maintenance_db
The database to run the query against.
.TP
.B password
User password, if different from the config or default.
.TP
.B runas
User to run the command as.
.TP
.B write
Mark query as READ WRITE transaction.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.psql_query \(aqselect * from pg_stat_activity\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.role_get(name, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None, return_password=False)
Return a dict with information about users of a Postgres server.
.sp
Set return_password to True to get password hash in the result.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.role_get postgres
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.schema_create(dbname, name, owner=None, user=None, db_user=None, db_password=None, db_host=None, db_port=None)
Creates a Postgres schema.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.schema_create dbname name owner=\(aqowner\(aq \e
        user=\(aquser\(aq \e
        db_user=\(aquser\(aq db_password=\(aqpassword\(aq
        db_host=\(aqhostname\(aq db_port=\(aqport\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.schema_exists(dbname, name, user=None, db_user=None, db_password=None, db_host=None, db_port=None)
Checks if a schema exists on the Postgres server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.schema_exists dbname schemaname
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B dbname
Database name we query on
.TP
.B name
Schema name we look for
.TP
.B user
The system user the operation should be performed on behalf of
.TP
.B db_user
database username if different from config or default
.TP
.B db_password
user password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.schema_get(dbname, name, user=None, db_user=None, db_password=None, db_host=None, db_port=None)
Return a dict with information about schemas in a database.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.schema_get dbname name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B dbname
Database name we query on
.TP
.B name
Schema name we look for
.TP
.B user
The system user the operation should be performed on behalf of
.TP
.B db_user
database username if different from config or default
.TP
.B db_password
user password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.schema_list(dbname, user=None, db_user=None, db_password=None, db_host=None, db_port=None)
Return a dict with information about schemas in a Postgres database.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.schema_list dbname
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B dbname
Database name we query on
.TP
.B user
The system user the operation should be performed on behalf of
.TP
.B db_user
database username if different from config or default
.TP
.B db_password
user password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.schema_remove(dbname, name, user=None, db_user=None, db_password=None, db_host=None, db_port=None)
Removes a schema from the Postgres server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.schema_remove dbname schemaname
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B dbname
Database name we work on
.TP
.B schemaname
The schema\(aqs name we\(aqll remove
.TP
.B user
System user all operations should be performed on behalf of
.TP
.B db_user
database username if different from config or default
.TP
.B db_password
user password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.tablespace_alter(name, user=None, host=None, port=None, maintenance_db=None, password=None, new_name=None, new_owner=None, set_option=None, reset_option=None, runas=None)
Change tablespace name, owner, or options.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.tablespace_alter tsname new_owner=otheruser
salt \(aq*\(aq postgres.tablespace_alter index_space new_name=fast_raid
salt \(aq*\(aq postgres.tablespace_alter test set_option=\(dq{\(aqseq_page_cost\(aq: \(aq1.1\(aq}\(dq
salt \(aq*\(aq postgres.tablespace_alter tsname reset_option=seq_page_cost
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.tablespace_create(name, location, options=None, owner=None, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Adds a tablespace to the Postgres server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.tablespace_create tablespacename \(aq/path/datadir\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.tablespace_exists(name, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Checks if a tablespace exists on the Postgres server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.tablespace_exists \(aqdbname\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.tablespace_list(user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Return dictionary with information about tablespaces of a Postgres server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.tablespace_list
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.tablespace_remove(name, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Removes a tablespace from the Postgres server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.tablespace_remove tsname
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.user_create(username, user=None, host=None, port=None, maintenance_db=None, password=None, createdb=None, createroles=None, inherit=None, login=None, connlimit=None, encrypted=None, superuser=None, replication=None, rolepassword=None, valid_until=None, groups=None, runas=None)
Creates a Postgres user.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.user_create \(aqusername\(aq user=\(aquser\(aq \e
        host=\(aqhostname\(aq port=\(aqport\(aq password=\(aqpassword\(aq \e
        rolepassword=\(aqrolepassword\(aq valid_until=\(aqvalid_until\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.user_exists(name, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Checks if a user exists on the Postgres server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.user_exists \(aqusername\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.user_list(user=None, host=None, port=None, maintenance_db=None, password=None, runas=None, return_password=False)
Return a dict with information about users of a Postgres server.
.sp
Set return_password to True to get password hash in the result.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.user_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.user_remove(username, user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Removes a user from the Postgres server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.user_remove \(aqusername\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.user_update(username, user=None, host=None, port=None, maintenance_db=None, password=None, createdb=None, createroles=None, encrypted=None, superuser=None, inherit=None, login=None, connlimit=None, replication=None, rolepassword=None, valid_until=None, groups=None, runas=None)
Updates a Postgres user.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.user_update \(aqusername\(aq user=\(aquser\(aq \e
        host=\(aqhostname\(aq port=\(aqport\(aq password=\(aqpassword\(aq \e
        rolepassword=\(aqrolepassword\(aq valid_until=\(aqvalid_until\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.postgres.version(user=None, host=None, port=None, maintenance_db=None, password=None, runas=None)
Return the version of a Postgres server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq postgres.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.poudriere
.sp
Support for poudriere
.INDENT 0.0
.TP
.B salt.modules.poudriere.bulk_build(jail, pkg_file, keep=False)
Run bulk build on poudriere server.
.sp
Return number of pkg builds, failures, and errors, on error dump to CLI
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-N buildbox_group poudriere.bulk_build 90amd64 /root/pkg_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.poudriere.create_jail(name, arch, version=\(aq9.0\-RELEASE\(aq)
Creates a new poudriere jail if one does not exist
.sp
\fINOTE\fP creating a new jail will take some time the master is not hanging
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq poudriere.create_jail 90amd64 amd64
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.poudriere.create_ports_tree()
Not working need to run portfetch non interactive
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.poudriere.delete_jail(name)
Deletes poudriere jail with \fIname\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq poudriere.delete_jail 90amd64
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.poudriere.info_jail(name)
Show information on \fIname\fP poudriere jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq poudriere.info_jail head\-amd64
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.poudriere.is_jail(name)
Return True if jail exists False if not
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq poudriere.is_jail <jail name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.poudriere.list_jails()
Return a list of current jails managed by poudriere
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq poudriere.list_jails
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.poudriere.list_ports()
Return a list of current port trees managed by poudriere
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq poudriere.list_ports
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.poudriere.make_pkgng_aware(jname)
Make jail \fBjname\fP pkgng aware
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq poudriere.make_pkgng_aware <jail name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.poudriere.parse_config(config_file=None)
Returns a dict of poudriere main configuration definitions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq poudriere.parse_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.poudriere.update_jail(name)
Run freebsd\-update on \fIname\fP poudriere jail
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq poudriere.update_jail freebsd:10:x86:64
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.poudriere.update_ports_tree(ports_tree)
Updates the ports tree, either the default or the \fIports_tree\fP specified
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq poudriere.update_ports_tree staging
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.poudriere.version()
Return poudriere version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq poudriere.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.powerpath
.sp
powerpath support.
.sp
Assumes RedHat
.INDENT 0.0
.TP
.B salt.modules.powerpath.add_license(key)
Add a license
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.powerpath.has_powerpath()
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.powerpath.list_licenses()
returns a list of applied powerpath license keys
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.powerpath.remove_license(key)
Remove a license
.UNINDENT
.SS salt.modules.proxy
.sp
This module allows you to manage proxy settings
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.get_http_proxy
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.proxy.get_ftp_proxy(network_service=\(aqEthernet\(aq)
Returns the current ftp proxy settings
.INDENT 7.0
.TP
.B network_service
The network service to apply the changes to, this only necessary on
macOS
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq proxy.get_ftp_proxy Ethernet
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.proxy.get_http_proxy(network_service=\(aqEthernet\(aq)
Returns the current http proxy settings
.INDENT 7.0
.TP
.B network_service
The network service to apply the changes to, this only necessary on
macOS
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq proxy.get_http_proxy Ethernet
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.proxy.get_https_proxy(network_service=\(aqEthernet\(aq)
Returns the current https proxy settings
.INDENT 7.0
.TP
.B network_service
The network service to apply the changes to, this only necessary on
macOS
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq proxy.get_https_proxy Ethernet
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.proxy.get_proxy_bypass(network_service=\(aqEthernet\(aq)
Returns the current domains that can bypass the proxy
.INDENT 7.0
.TP
.B network_service
The network service to get the bypass domains from, this is only
necessary on macOS
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq proxy.get_proxy_bypass
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.proxy.get_proxy_win()
Gets all of the proxy settings in one call, only available on Windows
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq proxy.get_proxy_win
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.proxy.set_ftp_proxy(server, port, user=None, password=None, network_service=\(aqEthernet\(aq, bypass_hosts=None)
Sets the ftp proxy settings
.INDENT 7.0
.TP
.B server
The proxy server to use
.TP
.B port
The port used by the proxy server
.TP
.B user
The username to use for the proxy server if required
.TP
.B password
The password to use if required by the server
.TP
.B network_service
The network service to apply the changes to, this only necessary on
macOS
.TP
.B bypass_hosts
The hosts that are allowed to by pass the proxy. Only used on Windows
for other OS\(aqs use set_proxy_bypass to edit the bypass hosts.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq proxy.set_ftp_proxy example.com 1080 user=proxy_user password=proxy_pass network_service=Ethernet
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.proxy.set_http_proxy(server, port, user=None, password=None, network_service=\(aqEthernet\(aq, bypass_hosts=None)
Sets the http proxy settings. Note: On Windows this will override any other
proxy settings you have, the preferred method of updating proxies on windows
is using set_proxy.
.INDENT 7.0
.TP
.B server
The proxy server to use
.TP
.B port
The port used by the proxy server
.TP
.B user
The username to use for the proxy server if required
.TP
.B password
The password to use if required by the server
.TP
.B network_service
The network service to apply the changes to, this only necessary on
macOS
.TP
.B bypass_hosts
The hosts that are allowed to by pass the proxy. Only used on Windows
for other OS\(aqs use set_proxy_bypass to edit the bypass hosts.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq proxy.set_http_proxy example.com 1080 user=proxy_user password=proxy_pass network_service=Ethernet
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.proxy.set_https_proxy(server, port, user=None, password=None, network_service=\(aqEthernet\(aq, bypass_hosts=None)
Sets the https proxy settings. Note: On Windows this will override any other
proxy settings you have, the preferred method of updating proxies on windows
is using set_proxy.
.INDENT 7.0
.TP
.B server
The proxy server to use
.TP
.B port
The port used by the proxy server
.TP
.B user
The username to use for the proxy server if required
.TP
.B password
The password to use if required by the server
.TP
.B network_service
The network service to apply the changes to, this only necessary on
macOS
.TP
.B bypass_hosts
The hosts that are allowed to by pass the proxy. Only used on Windows
for other OS\(aqs use set_proxy_bypass to edit the bypass hosts.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq proxy.set_https_proxy example.com 1080 user=proxy_user password=proxy_pass network_service=Ethernet
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.proxy.set_proxy_bypass(domains, network_service=\(aqEthernet\(aq)
Sets the domains that can bypass the proxy
.INDENT 7.0
.TP
.B domains
An array of domains allowed to bypass the proxy
.TP
.B network_service
The network service to apply the changes to, this only necessary on
macOS
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq proxy.set_proxy_bypass \(dq[\(aq127.0.0.1\(aq, \(aqlocalhost\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.proxy.set_proxy_win(server, port, types=None, bypass_hosts=None)
Sets the http proxy settings, only works with Windows.
.INDENT 7.0
.TP
.B server
The proxy server to use
.TP
.B password
The password to use if required by the server
.TP
.B types
The types of proxy connections should be setup with this server. Valid
types are:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBhttp\fP
.IP \(bu 2
\fBhttps\fP
.IP \(bu 2
\fBftp\fP
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B bypass_hosts
The hosts that are allowed to by pass the proxy.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq proxy.set_http_proxy example.com 1080 types=\(dq[\(aqhttp\(aq, \(aqhttps\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.ps
.sp
A salt interface to psutil, a system and process library.
See \fI\%http://code.google.com/p/psutil\fP\&.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
python\-utmp package (optional)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.boot_time(time_format=None)
Return the boot time in number of seconds since the epoch began.
.sp
CLI Example:
.INDENT 7.0
.TP
.B time_format
Optionally specify a \fI\%strftime\fP format string. Use
\fBtime_format=\(aq%c\(aq\fP to get a nicely\-formatted locale specific date and
time (i.e. \fBFri May  2 19:08:32 2014\fP).
.sp
New in version 2014.1.4.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.boot_time
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.cpu_percent(interval=0.1, per_cpu=False)
Return the percent of time the CPU is busy.
.INDENT 7.0
.TP
.B interval
the number of seconds to sample CPU usage over
.TP
.B per_cpu
if True return an array of CPU percent busy for each CPU, otherwise
aggregate all percents into one number
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.cpu_percent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.cpu_times(per_cpu=False)
Return the percent of time the CPU spends in each state,
e.g. user, system, idle, nice, iowait, irq, softirq.
.INDENT 7.0
.TP
.B per_cpu
if True return an array of percents for each CPU, otherwise aggregate
all percents into one number
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.cpu_times
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.disk_io_counters(device=None)
Return disk I/O statistics.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.disk_io_counters

salt \(aq*\(aq ps.disk_io_counters device=sda1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.disk_partition_usage(all=False)
Return a list of disk partitions plus the mount point, filesystem and usage
statistics.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.disk_partition_usage
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.disk_partitions(all=False)
Return a list of disk partitions and their device, mount point, and
filesystem type.
.INDENT 7.0
.TP
.B all
if set to False, only return local, physical partitions (hard disk,
USB, CD/DVD partitions).  If True, return all filesystems.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.disk_partitions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.disk_usage(path)
Given a path, return a dict listing the total available space as well as
the free space, and used space.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.disk_usage /home
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.get_pid_list()
Return a list of process ids (PIDs) for all running processes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.get_pid_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.get_users()
Return logged\-in users.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.get_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.kill_pid(pid, signal=15)
Kill a process by PID.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq ps.kill_pid pid [signal=signal_number]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B pid
PID of process to kill.
.TP
.B signal
Signal to send to the process. See manpage entry for kill
for possible values. Default: 15 (SIGTERM).
.UNINDENT
.sp
\fBExample:\fP
.sp
Send SIGKILL to process with PID 2000:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq ps.kill_pid 2000 signal=9
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.lsof(name)
Retrieve the lsof information of the given process name.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.lsof apache2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.netstat(name)
Retrieve the netstat information of the given process name.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.netstat apache2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.network_io_counters(interface=None)
Return network I/O statistics.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.network_io_counters

salt \(aq*\(aq ps.network_io_counters interface=eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.num_cpus()
Return the number of CPUs.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.num_cpus
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.pgrep(pattern, user=None, full=False, pattern_is_regex=False)
Return the pids for processes matching a pattern.
.sp
If full is true, the full command line is searched for a match,
otherwise only the name of the command is searched.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.pgrep pattern [user=username] [full=(true|false)]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B pattern
Pattern to search for in the process list.
.TP
.B user
Limit matches to the given username. Default: All users.
.TP
.B full
A boolean value indicating whether only the name of the command or
the full command line should be matched against the pattern.
.TP
.B pattern_is_regex
This flag enables ps.pgrep to mirror the regex search functionality
found in the pgrep command line utility.
.sp
New in version 3001.

.UNINDENT
.sp
\fBExamples:\fP
.sp
Find all httpd processes on all \(aqwww\(aq minions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqwww.*\(aq ps.pgrep httpd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Find all bash processes owned by user \(aqtom\(aq:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.pgrep bash user=tom
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.pkill(pattern, user=None, signal=15, full=False)
Kill processes matching a pattern.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.pkill pattern [user=username] [signal=signal_number] \e
        [full=(true|false)]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B pattern
Pattern to search for in the process list.
.TP
.B user
Limit matches to the given username. Default: All users.
.TP
.B signal
Signal to send to the process(es). See manpage entry for kill
for possible values. Default: 15 (SIGTERM).
.TP
.B full
A boolean value indicating whether only the name of the command or
the full command line should be matched against the pattern.
.UNINDENT
.sp
\fBExamples:\fP
.sp
Send SIGHUP to all httpd processes on all \(aqwww\(aq minions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqwww.*\(aq ps.pkill httpd signal=1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Send SIGKILL to all bash processes owned by user \(aqtom\(aq:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.pkill bash signal=9 user=tom
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.proc_info(pid, attrs=None)
Return a dictionary of information for a process id (PID).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.proc_info 2322
salt \(aq*\(aq ps.proc_info 2322 attrs=\(aq[\(dqpid\(dq, \(dqname\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B pid
PID of process to query.
.TP
.B attrs
Optional list of desired process attributes.  The list of possible
attributes can be found here:
\fI\%https://psutil.readthedocs.io/en/latest/#processes\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.psaux(name)
Retrieve information corresponding to a \(dqps aux\(dq filtered
with the given pattern. It could be just a name or a regular
expression (using python search from \(dqre\(dq module).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.psaux www\-data.+apache2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.ss(name)
Retrieve the ss information of the given process name.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.ss apache2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.6.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.status(status)
New in version 3006.0.

.sp
Returns a list of processes according to their state.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.status STATUS
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
where \fBSTATUS\fP is one of
.INDENT 7.0
.IP \(bu 2
running
.IP \(bu 2
sleeping
.IP \(bu 2
disk_sleep
.IP \(bu 2
stopped
.IP \(bu 2
tracing_stop
.IP \(bu 2
zombie
.IP \(bu 2
dead
.IP \(bu 2
wake_kill
.IP \(bu 2
waking
.IP \(bu 2
parked (Linux)
.IP \(bu 2
idle (Linux, macOS, FreeBSD)
.IP \(bu 2
locked (FreeBSD)
.IP \(bu 2
waiting (FreeBSD)
.IP \(bu 2
suspended (NetBSD)
.UNINDENT
.sp
See \fI\%https://psutil.readthedocs.io/en/latest/index.html?highlight=status#process\-status\-constants\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.swap_memory()
New in version 2014.7.0.

.sp
Return a dict that describes swap memory statistics.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function is only available in psutil version 0.6.0 and above.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.swap_memory
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.top(num_processes=5, interval=3)
Return a list of top CPU consuming processes during the interval.
num_processes = return the top N CPU consuming processes
interval = the number of seconds to sample CPU usage over
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.top

salt \(aq*\(aq ps.top 5 10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.total_physical_memory()
Return the total number of bytes of physical memory.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.total_physical_memory
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ps.virtual_memory()
New in version 2014.7.0.

.sp
Return a dict that describes statistics about system memory usage.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function is only available in psutil version 0.6.0 and above.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ps.virtual_memory
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.publish
.sp
Publish a command from a minion to a target
.INDENT 0.0
.TP
.B salt.modules.publish.full_data(tgt, fun, arg=None, tgt_type=\(aqglob\(aq, returner=\(aq\(aq, timeout=5)
Return the full data about the publication, this is invoked in the same
way as the publish function
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt system.example.com publish.full_data \(aq*\(aq cmd.run \(aqls \-la /tmp\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Attention"
.sp
If you need to pass a value to a function argument and that value
contains an equal sign, you \fBmust\fP include the argument name.
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq publish.full_data test.kwarg arg=\(aqcheese=spam\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.publish.publish(tgt, fun, arg=None, tgt_type=\(aqglob\(aq, returner=\(aq\(aq, timeout=5, via_master=None)
Publish a command from the minion out to other minions.
.sp
Publications need to be enabled on the Salt master and the minion
needs to have permission to publish the command. The Salt master
will also prevent a recursive publication loop, this means that a
minion cannot command another minion to command another minion as
that would create an infinite command loop.
.sp
The \fBtgt_type\fP argument is used to pass a target other than a glob into
the execution, the available options are:
.INDENT 7.0
.IP \(bu 2
glob
.IP \(bu 2
pcre
.IP \(bu 2
grain
.IP \(bu 2
grain_pcre
.IP \(bu 2
pillar
.IP \(bu 2
pillar_pcre
.IP \(bu 2
ipcidr
.IP \(bu 2
range
.IP \(bu 2
compound
.UNINDENT
.sp
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Note that for pillar matches must be exact, both in the pillar matcher
and the compound matcher. No globbing is supported.
.sp
The arguments sent to the minion publish function are separated with
commas. This means that for a minion executing a command with multiple
args it will look like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt system.example.com publish.publish \(aq*\(aq user.add \(aqfoo,1020,1020\(aq
salt system.example.com publish.publish \(aqos:Fedora\(aq network.interfaces \(aq\(aq grain
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt system.example.com publish.publish \(aq*\(aq cmd.run \(aqls \-la /tmp\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Attention"
.sp
If you need to pass a value to a function argument and that value
contains an equal sign, you \fBmust\fP include the argument name.
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq publish.publish test.kwarg arg=\(aqcheese=spam\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple keyword arguments should be passed as a list.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq publish.publish test.kwarg arg=\(dq[\(aqcheese=spam\(aq,\(aqspam=cheese\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
When running via salt\-call, the \fIvia_master\fP flag may be set to specific which
master the publication should be sent to. Only one master may be specified. If
unset, the publication will be sent only to the first master in minion configuration.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.publish.runner(fun, arg=None, timeout=5)
Execute a runner on the master and return the data from the runner
function
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt publish.runner manage.down
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.puppet
.sp
Execute puppet routines
.INDENT 0.0
.TP
.B salt.modules.puppet.disable(message=None)
New in version 2014.7.0.

.sp
Disable the puppet agent
.INDENT 7.0
.TP
.B message
New in version 2015.5.2.

.sp
Disable message to send to puppet
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq puppet.disable
salt \(aq*\(aq puppet.disable \(aqDisabled, contact XYZ before enabling\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.puppet.enable()
New in version 2014.7.0.

.sp
Enable the puppet agent
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq puppet.enable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.puppet.fact(name, puppet=False)
Run facter for a specific fact
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq puppet.fact kernel
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.puppet.facts(puppet=False)
Run facter and return the results
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq puppet.facts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.puppet.noop(*args, **kwargs)
Execute a puppet noop run and return a dict with the stderr, stdout,
return code, etc. Usage is the same as for puppet.run.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq puppet.noop
salt \(aq*\(aq puppet.noop tags=basefiles::edit,apache::server
salt \(aq*\(aq puppet.noop debug
salt \(aq*\(aq puppet.noop apply /a/b/manifest.pp modulepath=/a/b/modules tags=basefiles::edit,apache::server
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.puppet.plugin_sync()
Runs a plugin sync between the puppet master and agent
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq puppet.plugin_sync
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.puppet.run(*args, **kwargs)
Execute a puppet run and return a dict with the stderr, stdout,
return code, etc. The first positional argument given is checked as a
subcommand. Following positional arguments should be ordered with arguments
required by the subcommand first, followed by non\-keyword arguments.
Tags are specified by a tag keyword and comma separated list of values. \-\-
\fI\%http://docs.puppetlabs.com/puppet/latest/reference/lang_tags.html\fP
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq puppet.run
salt \(aq*\(aq puppet.run tags=basefiles::edit,apache::server
salt \(aq*\(aq puppet.run agent onetime no\-daemonize no\-usecacheonfailure no\-splay ignorecache
salt \(aq*\(aq puppet.run debug
salt \(aq*\(aq puppet.run apply /a/b/manifest.pp modulepath=/a/b/modules tags=basefiles::edit,apache::server
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.puppet.status()
New in version 2014.7.0.

.sp
Display puppet agent status
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq puppet.status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.puppet.summary()
New in version 2014.7.0.

.sp
Show a summary of the last puppet agent run
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq puppet.summary
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.purefa
.sp
Management of Pure Storage FlashArray
.SS Installation Prerequisites
.INDENT 0.0
.IP \(bu 2
You will need the \fBpurestorage\fP python package in your python installation
path that is running salt.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
pip install purestorage
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
Configure Pure Storage FlashArray authentication. Use one of the following
three methods.
.INDENT 2.0
.IP 1. 3
From the minion config
.UNINDENT
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
pure_tags:
  fa:
    san_ip: management vip or hostname for the FlashArray
    api_token: A valid api token for the FlashArray being managed
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 2.0
.IP 2. 3
From environment (PUREFA_IP and PUREFA_API)
.IP 3. 3
From the pillar (PUREFA_IP and PUREFA_API)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B maintainer
Simon Dodsley (\fI\%simon@purestorage.com\fP)
.TP
.B maturity
new
.TP
.B requires
purestorage
.TP
.B platform
all
.UNINDENT
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B salt.modules.purefa.hg_create(name, host=None, volume=None)
Create a hostgroup on a Pure Storage FlashArray.
.sp
Will return False if hostgroup already exists, or if
named host or volume do not exist.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of hostgroup (truncated to 63 characters)
.TP
.B host
string
name of host to add to hostgroup
.TP
.B volume
string
name of volume to add to hostgroup
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.hg_create foo host=bar volume=vol
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.hg_delete(name)
Delete a hostgroup on a Pure Storage FlashArray (removes all volumes and hosts).
.sp
Will return False is hostgroup is already in a deleted state.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of hostgroup
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.hg_delete foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.hg_remove(name, volume=None, host=None)
Remove a host and/or volume from a hostgroup on a Pure Storage FlashArray.
.sp
Will return False is hostgroup does not exist, or named host or volume are
not in the hostgroup.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of hostgroup
.TP
.B volume
string
name of volume to remove from hostgroup
.TP
.B host
string
name of host to remove from hostgroup
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.hg_remove foo volume=test host=bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.hg_update(name, host=None, volume=None)
Adds entries to a hostgroup on a Pure Storage FlashArray.
.sp
Will return False is hostgroup doesn\(aqt exist, or host
or volume do not exist.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of hostgroup
.TP
.B host
string
name of host to add to hostgroup
.TP
.B volume
string
name of volume to add to hostgroup
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.hg_update foo host=bar volume=vol
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.host_create(name, iqn=None, wwn=None, nqn=None)
Add a host on a Pure Storage FlashArray.
.sp
Will return False if host already exists, or the iSCSI or
Fibre Channel parameters are not in a valid format.
See Pure Storage FlashArray documentation.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of host (truncated to 63 characters)
.TP
.B iqn
string
iSCSI IQN of host
.TP
.B nqn
string
NVMeF NQN of host
\&.. versionadded:: 3006.0
.TP
.B wwn
string
Fibre Channel WWN of host
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.host_create foo iqn=\(aq<Valid iSCSI IQN>\(aq wwn=\(aq<Valid WWN>\(aq nqn=\(aq<Valid NQN>\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.host_delete(name)
Delete a host on a Pure Storage FlashArray (detaches all volumes).
.sp
Will return False if the host doesn\(aqt exist.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of host
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.host_delete foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.host_update(name, iqn=None, wwn=None, nqn=None)
Update a hosts port definitions on a Pure Storage FlashArray.
.sp
Will return False if new port definitions are already in use
by another host, or are not in a valid format.
See Pure Storage FlashArray documentation.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of host
.TP
.B nqn
string
Additional NVMeF NQN of host
\&.. versionadded:: 3006.0
.TP
.B iqn
string
Additional iSCSI IQN of host
.TP
.B wwn
string
Additional Fibre Channel WWN of host
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.host_update foo iqn=\(aq<Valid iSCSI IQN>\(aq wwn=\(aq<Valid WWN>\(aq nqn=\(aq<Valid NQN>\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.pg_create(name, hostgroup=None, host=None, volume=None, enabled=True)
Create a protection group on a Pure Storage FlashArray.
.INDENT 7.0
.TP
.B Will return False is the following cases:
.INDENT 7.0
.IP \(bu 2
Protection Grop already exists
.IP \(bu 2
Protection Group in a deleted state
.IP \(bu 2
More than one type is specified \- protection groups are for only
hostgroups, hosts or volumes
.IP \(bu 2
Named type for protection group does not exist
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of protection group
.TP
.B hostgroup
string
name of hostgroup to add to protection group
.TP
.B host
string
name of host to add to protection group
.TP
.B volume
string
name of volume to add to protection group
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.pg_create foo [hostgroup=foo | host=bar | volume=vol] enabled=[true | false]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.pg_delete(name, eradicate=False)
Delete a protecton group on a Pure Storage FlashArray.
.sp
Will return False if protection group is already in a deleted state.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of protection group
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.pg_delete foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.pg_eradicate(name)
Eradicate a deleted protecton group on a Pure Storage FlashArray.
.sp
Will return False if protection group is not in a deleted state.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of protection group
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.pg_eradicate foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.pg_remove(name, hostgroup=None, host=None, volume=None)
Remove a hostgroup, host or volume from a protection group on a Pure Storage FlashArray.
.INDENT 7.0
.TP
.B Will return False in the following cases:
.INDENT 7.0
.IP \(bu 2
Protection group does not exist
.IP \(bu 2
Specified type is not currently associated with the protection group
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of hostgroup
.TP
.B hostgroup
string
name of hostgroup to remove from protection group
.TP
.B host
string
name of host to remove from hostgroup
.TP
.B volume
string
name of volume to remove from hostgroup
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.pg_remove foo [hostgroup=bar | host=test | volume=bar]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.pg_update(name, hostgroup=None, host=None, volume=None)
Update a protection group on a Pure Storage FlashArray.
.INDENT 7.0
.TP
.B Will return False in the following cases:
.INDENT 7.0
.IP \(bu 2
Protection group does not exist
.IP \(bu 2
Incorrect type selected for current protection group type
.IP \(bu 2
Specified type does not exist
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of protection group
.TP
.B hostgroup
string
name of hostgroup to add to protection group
.TP
.B host
string
name of host to add to protection group
.TP
.B volume
string
name of volume to add to protection group
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.pg_update foo [hostgroup=foo | host=bar | volume=vol]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.snap_create(name, suffix=None)
Create a volume snapshot on a Pure Storage FlashArray.
.sp
Will return False is volume selected to snap does not exist.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of volume to snapshot
.TP
.B suffix
string
if specificed forces snapshot name suffix. If not specified defaults to timestamp.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.snap_create foo
salt \(aq*\(aq purefa.snap_create foo suffix=bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.snap_delete(name, suffix=None, eradicate=False)
Delete a volume snapshot on a Pure Storage FlashArray.
.sp
Will return False if selected snapshot does not exist.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of volume
.TP
.B suffix
string
name of snapshot
.TP
.B eradicate
boolean
Eradicate snapshot after deletion if True. Default is False
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.snap_delete foo suffix=snap eradicate=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.snap_eradicate(name, suffix=None)
Eradicate a deleted volume snapshot on a Pure Storage FlashArray.
.sp
Will return False if snapshot is not in a deleted state.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of volume
.TP
.B suffix
string
name of snapshot
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.snap_eradicate foo suffix=snap
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.snap_volume_create(name, target, overwrite=False)
Create R/W volume from snapshot on a Pure Storage FlashArray.
.sp
Will return False if target volume already exists and
overwrite is not specified, or selected snapshot doesn\(aqt exist.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of volume snapshot
.TP
.B target
string
name of clone volume
.TP
.B overwrite
boolean
overwrite clone if already exists (default: False)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.snap_volume_create foo.bar clone overwrite=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.volume_attach(name, host)
Attach a volume to a host on a Pure Storage FlashArray.
.sp
Host and volume must exist or else will return False.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of volume
.TP
.B host
string
name of host
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.volume_attach foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.volume_clone(name, target, overwrite=False)
Clone an existing volume on a Pure Storage FlashArray.
.sp
Will return False if source volume doesn\(aqt exist, or
target volume already exists and overwrite not specified.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of volume
.TP
.B target
string
name of clone volume
.TP
.B overwrite
boolean
overwrite clone if already exists (default: False)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.volume_clone foo bar overwrite=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.volume_create(name, size=None)
Create a volume on a Pure Storage FlashArray.
.sp
Will return False if volume already exists.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of volume (truncated to 63 characters)
.TP
.B size
string
if specificed capacity of volume. If not specified default to 1G.
Refer to Pure Storage documentation for formatting rules.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.volume_create foo
salt \(aq*\(aq purefa.volume_create foo size=10T
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.volume_delete(name, eradicate=False)
Delete a volume on a Pure Storage FlashArray.
.sp
Will return False if volume doesn\(aqt exist is already in a deleted state.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of volume
.TP
.B eradicate
boolean
Eradicate volume after deletion if True. Default is False
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.volume_delete foo eradicate=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.volume_detach(name, host)
Detach a volume from a host on a Pure Storage FlashArray.
.sp
Will return False if either host or volume do not exist, or
if selected volume isn\(aqt already connected to the host.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of volume
.TP
.B host
string
name of host
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.volume_detach foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.volume_eradicate(name)
Eradicate a deleted volume on a Pure Storage FlashArray.
.sp
Will return False is volume is not in a deleted state.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of volume
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.volume_eradicate foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefa.volume_extend(name, size)
Extend an existing volume on a Pure Storage FlashArray.
.sp
Will return False if new size is less than or equal to existing size.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B name
string
name of volume
.TP
.B size
string
New capacity of volume.
Refer to Pure Storage documentation for formatting rules.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefa.volume_extend foo 10T
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.purefb
.sp
Management of Pure Storage FlashBlade
.SS Installation Prerequisites
.INDENT 0.0
.IP \(bu 2
You will need the \fBpurity_fb\fP python package in your python installation
path that is running salt.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
pip install purity_fb
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
Configure Pure Storage FlashBlade authentication. Use one of the following
three methods.
.INDENT 2.0
.IP 1. 3
From the minion config
.UNINDENT
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
pure_tags:
  fb:
    san_ip: management vip or hostname for the FlashBlade
    api_token: A valid api token for the FlashBlade being managed
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 2.0
.IP 2. 3
From environment (PUREFB_IP and PUREFB_API)
.IP 3. 3
From the pillar (PUREFB_IP and PUREFB_API)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B maintainer
Simon Dodsley (\fI\%simon@purestorage.com\fP)
.TP
.B maturity
new
.TP
.B requires
purity_fb
.TP
.B platform
all
.UNINDENT
.sp
New in version 2019.2.0.

.INDENT 0.0
.TP
.B salt.modules.purefb.fs_create(name, size=None, proto=\(aqNFS\(aq, nfs_rules=\(aq*(rw,no_root_squash)\(aq, snapshot=False)
Create a filesystem on a Pure Storage FlashBlade.
.sp
Will return False if filesystem already exists.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B name
string
name of filesystem (truncated to 63 characters)
.TP
.B proto
string
(Optional) Sharing protocol (NFS, CIFS or HTTP). If not specified default is NFS
.TP
.B snapshot: boolean
(Optional) Are snapshots enabled on the filesystem. Default is False
.TP
.B nfs_rules
string
(Optional) export rules for NFS. If not specified default is
\fB*(rw,no_root_squash)\fP\&. Refer to Pure Storage documentation for
formatting rules.
.TP
.B size
string
if specified capacity of filesystem. If not specified default to 32G.
Refer to Pure Storage documentation for formatting rules.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefb.fs_create foo proto=CIFS
salt \(aq*\(aq purefb.fs_create foo size=10T
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefb.fs_delete(name, eradicate=False)
Delete a share on a Pure Storage FlashBlade.
.sp
Will return False if filesystem doesn\(aqt exist or is already in a deleted state.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B name
string
name of filesystem
.TP
.B eradicate
boolean
(Optional) Eradicate filesystem after deletion if True. Default is False
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefb.fs_delete foo eradicate=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefb.fs_eradicate(name)
Eradicate a deleted filesystem on a Pure Storage FlashBlade.
.sp
Will return False is filesystem is not in a deleted state.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B name
string
name of filesystem
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefb.fs_eradicate foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefb.fs_extend(name, size)
Resize an existing filesystem on a Pure Storage FlashBlade.
.sp
Will return False if new size is less than or equal to existing size.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B name
string
name of filesystem
.TP
.B size
string
New capacity of filesystem.
Refer to Pure Storage documentation for formatting rules.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefb.fs_extend foo 10T
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefb.fs_update(name, rules, snapshot=False)
Update filesystem on a Pure Storage FlashBlade.
.sp
Allows for change of NFS export rules and enabling/disabled
of snapshotting capability.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B name
string
name of filesystem
.TP
.B rules
string
NFS export rules for filesystem
Refer to Pure Storage documentation for formatting rules.
.TP
.B snapshot: boolean
(Optional) Enable/Disable snapshots on the filesystem. Default is False
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefb.fs_nfs_update foo rules=\(aq10.234.112.23(ro), 10.234.112.24(rw)\(aq snapshot=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefb.snap_create(name, suffix=None)
Create a filesystem snapshot on a Pure Storage FlashBlade.
.sp
Will return False if filesystem selected to snap does not exist.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B name
string
name of filesystem to snapshot
.TP
.B suffix
string
if specificed forces snapshot name suffix. If not specified defaults to timestamp.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefb.snap_create foo
salt \(aq*\(aq purefb.snap_create foo suffix=bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefb.snap_delete(name, suffix=None, eradicate=False)
Delete a filesystem snapshot on a Pure Storage FlashBlade.
.sp
Will return False if selected snapshot does not exist.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B name
string
name of filesystem
.TP
.B suffix
string
name of snapshot
.TP
.B eradicate
boolean
Eradicate snapshot after deletion if True. Default is False
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefb.snap_delete foo suffix=snap eradicate=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.purefb.snap_eradicate(name, suffix=None)
Eradicate a deleted filesystem snapshot on a Pure Storage FlashBlade.
.sp
Will return False if snapshot is not in a deleted state.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B name
string
name of filesystem
.TP
.B suffix
string
name of snapshot
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq purefb.snap_eradicate foo suffix=snap
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pushbullet
.sp
Module for sending messages to Pushbullet (\fI\%https://www.pushbullet.com\fP)
.sp
New in version 2015.8.0.

.sp
Requires an \fBapi_key\fP in \fB/etc/salt/minion\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pushbullet:
  api_key: \(aqABC123abc123ABC123abc123ABC123ab\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pushbullet:
  device: \(dqChrome\(dq
  title: \(dqExample push message\(dq
  body: \(dqMessage body.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pushbullet.push_note(device=None, title=None, body=None)
Pushing a text note.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdevice\fP \-\- Pushbullet target device
.IP \(bu 2
\fBtitle\fP \-\- Note title
.IP \(bu 2
\fBbody\fP \-\- Note body
.UNINDENT
.TP
.B Returns
Boolean if message was sent successfully.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq pushbullet.push_note device=\(dqChrome\(dq title=\(dqExample title\(dq body=\(dqExample body.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pushover_notify
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%pushover Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Module for sending messages to Pushover (\fI\%https://www.pushover.net\fP)
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B configuration
This module can be used by either passing an api key and version
directly or by specifying both in a configuration profile in the salt
master/minion config.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pushover:
  token: abAHuZyCLtdH8P4zhmFZmgUHUsv1ei8
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pushover_notify.post_message(user=None, device=None, message=None, title=None, priority=None, expire=None, retry=None, sound=None, api_version=1, token=None)
Send a message to a Pushover user or group.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuser\fP \-\- The user or group to send to, must be key of user or group not email address.
.IP \(bu 2
\fBmessage\fP \-\- The message to send to the PushOver user or group.
.IP \(bu 2
\fBtitle\fP \-\- Specify who the message is from.
.IP \(bu 2
\fBpriority\fP \-\- The priority of the message, defaults to 0.
.IP \(bu 2
\fBexpire\fP \-\- The message should expire after N number of seconds.
.IP \(bu 2
\fBretry\fP \-\- The number of times the message should be retried.
.IP \(bu 2
\fBsound\fP \-\- The sound to associate with the message.
.IP \(bu 2
\fBapi_version\fP \-\- The PushOver API version, if not specified in the configuration.
.IP \(bu 2
\fBtoken\fP \-\- The PushOver token, if not specified in the configuration.
.UNINDENT
.TP
.B Returns
Boolean if message was sent successfully.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pushover.post_message user=\(aqxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\(aq title=\(aqMessage from Salt\(aq message=\(aqBuild is done\(aq

salt \(aq*\(aq pushover.post_message user=\(aqxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\(aq title=\(aqMessage from Salt\(aq message=\(aqBuild is done\(aq priority=\(aq2\(aq expire=\(aq720\(aq retry=\(aq5\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pw_group
.sp
Manage groups on FreeBSD
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage groups on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqgroup.info\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_group.add(name, gid=None, **kwargs)
Changed in version 3006.0.

.sp
Add the specified group
.INDENT 7.0
.TP
.B name
Name of the new group
.TP
.B gid
Use GID for the new group
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.add foo 3456
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_group.adduser(name, username)
Add a user in the group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.adduser foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Verifies if a valid username \(aqbar\(aq as a member of an existing group \(aqfoo\(aq,
if not then adds it.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_group.chgid(name, gid)
Change the gid for a named group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.chgid foo 4376
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_group.delete(name)
Remove the named group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.delete foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_group.deluser(name, username)
Remove a user from the group.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.deluser foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Removes a member user \(aqbar\(aq from a group \(aqfoo\(aq. If group is not present
then returns True.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_group.getent(refresh=False)
Return info on all groups
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.getent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_group.info(name)
Return information about a group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.info foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_group.members(name, members_list)
Replaces members of the group with a provided list.
.sp
New in version 2015.5.4.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.members foo \(aquser1,user2,user3,...\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Replaces a membership list for a local group \(aqfoo\(aq.
foo:x:1234:user1,user2,user3,...
.UNINDENT
.UNINDENT
.SS salt.modules.pw_user
.sp
Manage users with the pw command
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage users on a
minion, and it is using a different module (or gives an error similar to
\fI\(aquser.info\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.add(name, uid=None, gid=None, groups=None, home=None, shell=None, unique=True, fullname=\(aq\(aq, roomnumber=\(aq\(aq, workphone=\(aq\(aq, homephone=\(aq\(aq, createhome=True, loginclass=None, **kwargs)
Add a user to the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.add name <uid> <gid> <groups> <home> <shell>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.chfullname(name, fullname)
Change the user\(aqs Full Name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chfullname foo \(dqFoo Bar\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.chgid(name, gid)
Change the default group of the user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chgid foo 4376
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.chgroups(name, groups, append=False)
Change the groups to which a user belongs
.INDENT 7.0
.TP
.B name
Username to modify
.TP
.B groups
List of groups to set for the user. Can be passed as a comma\-separated
list or a Python list.
.TP
.B append
False
Set to \fBTrue\fP to append these groups to the user\(aqs existing list of
groups. Otherwise, the specified groups will replace any existing
groups for the user.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chgroups foo wheel,root True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.chhome(name, home, persist=False)
Set a new home directory for an existing user
.INDENT 7.0
.TP
.B name
Username to modify
.TP
.B home
New home directory to set
.TP
.B persist
False
Set to \fBTrue\fP to prevent configuration files in the new home
directory from being overwritten by the files from the skeleton
directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chhome foo /home/users/foo True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.chhomephone(name, homephone)
Change the user\(aqs Home Phone
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chhomephone foo \(dq7735551234\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.chloginclass(name, loginclass, root=None)
Change the default login class of the user
.sp
New in version 2016.3.5.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chloginclass foo staff
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.chroomnumber(name, roomnumber)
Change the user\(aqs Room Number
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chroomnumber foo 123
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.chshell(name, shell)
Change the default shell of the user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chshell foo /bin/zsh
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.chuid(name, uid)
Change the uid for a named user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chuid foo 4376
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.chworkphone(name, workphone)
Change the user\(aqs Work Phone
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chworkphone foo \(dq7735550123\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.delete(name, remove=False, force=False)
Remove a user from the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.delete name remove=True force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.get_loginclass(name)
Get the login class of the user
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.get_loginclass foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.getent(refresh=False)
Return the list of all info for all users
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.getent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.info(name)
Return user information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.info root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.list_groups(name)
Return a list of groups the named user belongs to
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.list_groups foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.list_users()
Return a list of all users
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.list_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pw_user.rename(name, new_name)
Change the username for a named user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.rename name new_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.pyenv
.sp
Manage python installations with pyenv.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Git needs to be installed and available via PATH if pyenv is to be
installed automatically by the module.
.UNINDENT
.UNINDENT
.sp
New in version 2014.4.0.

.INDENT 0.0
.TP
.B salt.modules.pyenv.default(python=None, runas=None)
Returns or sets the currently defined default python.
.INDENT 7.0
.TP
.B python=None
The version to set as the default. Should match one of the versions
listed by \fI\%pyenv.versions\fP\&. Leave
blank to return the current default.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyenv.default
salt \(aq*\(aq pyenv.default 2.0.0\-p0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pyenv.do(cmdline=None, runas=None)
Execute a python command with pyenv\(aqs shims from the user or the system.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyenv.do \(aqgem list bundler\(aq
salt \(aq*\(aq pyenv.do \(aqgem list bundler\(aq deploy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pyenv.do_with_python(python, cmdline, runas=None)
Execute a python command with pyenv\(aqs shims using a specific python version.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyenv.do_with_python 2.0.0\-p0 \(aqgem list bundler\(aq
salt \(aq*\(aq pyenv.do_with_python 2.0.0\-p0 \(aqgem list bundler\(aq deploy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pyenv.install(runas=None, path=None)
Install pyenv systemwide
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyenv.install
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pyenv.install_python(python, runas=None)
Install a python implementation.
.INDENT 7.0
.TP
.B python
The version of python to install, should match one of the
versions listed by pyenv.list
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyenv.install_python 2.0.0\-p0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pyenv.is_installed(runas=None)
Check if pyenv is installed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyenv.is_installed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pyenv.list_(runas=None)
List the installable versions of python.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyenv.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pyenv.rehash(runas=None)
Run pyenv rehash to update the installed shims.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyenv.rehash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pyenv.uninstall_python(python, runas=None)
Uninstall a python implementation.
.INDENT 7.0
.TP
.B python
The version of python to uninstall. Should match one of the versions
listed by \fI\%pyenv.versions\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyenv.uninstall_python 2.0.0\-p0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pyenv.update(runas=None, path=None)
Updates the current versions of pyenv and python\-Build
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyenv.update
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.pyenv.versions(runas=None)
List the installed versions of python.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pyenv.versions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.qemu_img
.SS Qemu\-img Command Wrapper
.sp
The qemu img command is wrapped for specific functions
.INDENT 0.0
.TP
.B depends
qemu\-img
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.qemu_img.convert(orig, dest, fmt)
Convert an existing disk image to another format using qemu\-img
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq qemu_img.convert /path/to/original.img /path/to/new.img qcow2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.qemu_img.make_image(location, size, fmt)
Create a blank virtual machine image file of the specified size in
megabytes. The image can be created in any format supported by qemu
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq qemu_img.make_image /tmp/image.qcow 2048 qcow2
salt \(aq*\(aq qemu_img.make_image /tmp/image.raw 10240 raw
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.qemu_nbd
.sp
Qemu Command Wrapper
.sp
The qemu system comes with powerful tools, such as qemu\-img and qemu\-nbd which
are used here to build up kvm images.
.INDENT 0.0
.TP
.B salt.modules.qemu_nbd.clear(mnt)
Pass in the mnt dict returned from nbd_mount to unmount and disconnect
the image from nbd. If all of the partitions are unmounted return an
empty dict, otherwise return a dict containing the still mounted
partitions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq qemu_nbd.clear \(aq{\(dq/mnt/foo\(dq: \(dq/dev/nbd0p1\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.qemu_nbd.connect(image)
Activate nbd for an image file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq qemu_nbd.connect /tmp/image.raw
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.qemu_nbd.init(image, root=None)
Mount the named image via qemu\-nbd and return the mounted roots
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq qemu_nbd.init /srv/image.qcow2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.qemu_nbd.mount(nbd, root=None)
Pass in the nbd connection device location, mount all partitions and return
a dict of mount points
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq qemu_nbd.mount /dev/nbd0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.quota
.sp
Module for managing quotas on POSIX\-like systems.
.INDENT 0.0
.TP
.B salt.modules.quota.get_mode(device)
Report whether the quota system for this device is on or off
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq quota.get_mode
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.quota.off(device)
Turns off the quota system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq quota.off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.quota.on(device)
Turns on the quota system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq quota.on
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.quota.report(mount)
Report on quotas for a specific volume
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq quota.report /media/data
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.quota.set_(device, **kwargs)
Calls out to setquota, for a specific user or group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq quota.set /media/data user=larry block\-soft\-limit=1048576
salt \(aq*\(aq quota.set /media/data group=painters file\-hard\-limit=1000
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.quota.stats()
Runs the quotastats command, and returns the parsed output
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq quota.stats
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.quota.warn()
Runs the warnquota command, to send warning emails to users who
are over their quota limit.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq quota.warn
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.rabbitmq
.sp
Module to provide RabbitMQ compatibility to Salt.
Todo: A lot, need to add cluster support, logging, and minion configuration
data.
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.add_user(name, password=None, runas=None)
Add a rabbitMQ user via rabbitmqctl user_add <user> <password>
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.add_user rabbit_user password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.add_vhost(vhost, runas=None)
Adds a vhost via rabbitmqctl add_vhost.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq add_vhost \(aq<vhost_name>\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.change_password(name, password, runas=None)
Changes a user\(aqs password.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.change_password rabbit_user password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.check_password(name, password, runas=None)
New in version 2016.3.0.

.sp
Checks if a user\(aqs password is valid.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.check_password rabbit_user password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.clear_password(name, runas=None)
Removes a user\(aqs password.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.clear_password rabbit_user
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.cluster_status(runas=None)
return rabbitmq cluster_status
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.cluster_status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.delete_policy(vhost, name, runas=None)
Delete a policy based on rabbitmqctl clear_policy.
.sp
Reference: \fI\%http://www.rabbitmq.com/ha.html\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.delete_policy / HA
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.delete_upstream(name, runas=None)
Deletes an upstream via rabbitmqctl clear_parameter.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the upstream to delete.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The name of the user to run the command as.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.delete_upstream upstream_name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.delete_user(name, runas=None)
Deletes a user via rabbitmqctl delete_user.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.delete_user rabbit_user
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.delete_vhost(vhost, runas=None)
Deletes a vhost rabbitmqctl delete_vhost.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.delete_vhost \(aq<vhost_name>\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.disable_plugin(name, runas=None)
Disable a RabbitMQ plugin via the rabbitmq\-plugins command.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.disable_plugin foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.enable_plugin(name, runas=None)
Enable a RabbitMQ plugin via the rabbitmq\-plugins command.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.enable_plugin foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.force_reset(runas=None)
Forcefully Return a RabbitMQ node to its virgin state
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.force_reset
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.join_cluster(host, user=\(aqrabbit\(aq, ram_node=None, runas=None)
Join a rabbit cluster
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.join_cluster rabbit.example.com rabbit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.list_available_plugins(runas=None)
Returns a list of the names of all available plugins (enabled and disabled).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.list_available_plugins
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.list_enabled_plugins(runas=None)
Returns a list of the names of the enabled plugins.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.list_enabled_plugins
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.list_permissions(vhost, runas=None)
Lists permissions for vhost via rabbitmqctl list_permissions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.list_permissions /myvhost
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.list_policies(vhost=\(aq/\(aq, runas=None)
Return a dictionary of policies nested by vhost and name
based on the data returned from rabbitmqctl list_policies.
.sp
Reference: \fI\%http://www.rabbitmq.com/ha.html\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.list_policies
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.list_queues(runas=None, *args)
Returns queue details of the / virtual host
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.list_queues messages consumers
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.list_queues_vhost(vhost, runas=None, *args)
Returns queue details of specified virtual host. This command will consider
first parameter as the vhost name and rest will be treated as
queueinfoitem. For getting details on vhost \fB/\fP, use \fI\%list_queues\fP instead).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.list_queues messages consumers
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.list_upstreams(runas=None)
Returns a dict of upstreams based on rabbitmqctl list_parameters.
.INDENT 7.0
.TP
.B Parameters
\fBrunas\fP (\fI\%str\fP) \-\- The name of the user to run this command as.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.list_upstreams
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.list_user_permissions(name, runas=None)
List permissions for a user via rabbitmqctl list_user_permissions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.list_user_permissions user
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.list_users(runas=None)
Return a list of users based off of rabbitmqctl user_list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.list_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.list_vhosts(runas=None)
Return a list of vhost based on rabbitmqctl list_vhosts.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.list_vhosts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.plugin_is_enabled(name, runas=None)
Return whether the plugin is enabled.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.plugin_is_enabled rabbitmq_plugin_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.policy_exists(vhost, name, runas=None)
Return whether the policy exists based on rabbitmqctl list_policies.
.sp
Reference: \fI\%http://www.rabbitmq.com/ha.html\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.policy_exists / HA
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.reset(runas=None)
Return a RabbitMQ node to its virgin state
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.reset
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.set_permissions(vhost, user, conf=\(aq.*\(aq, write=\(aq.*\(aq, read=\(aq.*\(aq, runas=None)
Sets permissions for vhost via rabbitmqctl set_permissions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.set_permissions myvhost myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.set_policy(vhost, name, pattern, definition, priority=None, runas=None, apply_to=None)
Set a policy based on rabbitmqctl set_policy.
.sp
Reference: \fI\%http://www.rabbitmq.com/ha.html\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.set_policy / HA \(aq.*\(aq \(aq{\(dqha\-mode\(dq:\(dqall\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.set_upstream(name, uri, prefetch_count=None, reconnect_delay=None, ack_mode=None, trust_user_id=None, exchange=None, max_hops=None, expires=None, message_ttl=None, ha_policy=None, queue=None, runas=None)
Configures an upstream via rabbitmqctl set_parameter. This can be an exchange\-upstream,
a queue\-upstream or both.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the upstream to configure.
.UNINDENT
.sp
The following parameters apply to federated exchanges and federated queues:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuri\fP (\fI\%str\fP) \-\- The AMQP URI(s) for the upstream.
.IP \(bu 2
\fBprefetch_count\fP (\fI\%int\fP) \-\- The maximum number of unacknowledged messages copied
over a link at any one time. Default: 1000
.IP \(bu 2
\fBreconnect_delay\fP (\fI\%int\fP) \-\- The duration (in seconds) to wait before reconnecting
to the broker after being disconnected. Default: 1
.IP \(bu 2
\fBack_mode\fP (\fI\%str\fP) \-\- Determines how the link should acknowledge messages.
If set to \fBon\-confirm\fP (the default), messages are acknowledged to the
upstream broker after they have been confirmed downstream. This handles
network errors and broker failures without losing messages, and is the
slowest option.
If set to \fBon\-publish\fP, messages are acknowledged to the upstream broker
after they have been published downstream. This handles network errors
without losing messages, but may lose messages in the event of broker failures.
If set to \fBno\-ack\fP, message acknowledgements are not used. This is the
fastest option, but may lose messages in the event of network or broker failures.
.IP \(bu 2
\fBtrust_user_id\fP (\fI\%bool\fP) \-\- Determines how federation should interact with the
validated user\-id feature. If set to true, federation will pass through
any validated user\-id from the upstream, even though it cannot validate
it itself. If set to false or not set, it will clear any validated user\-id
it encounters. You should only set this to true if you trust the upstream
server (and by extension, all its upstreams) not to forge user\-ids.
.UNINDENT
.UNINDENT
.sp
The following parameters apply to federated exchanges only:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBexchange\fP (\fI\%str\fP) \-\- The name of the upstream exchange. Default is to use the
same name as the federated exchange.
.IP \(bu 2
\fBmax_hops\fP (\fI\%int\fP) \-\- The maximum number of federation links that a message
published to a federated exchange can traverse before it is discarded.
Default is 1. Note that even if max\-hops is set to a value greater than 1,
messages will never visit the same node twice due to travelling in a loop.
However, messages may still be duplicated if it is possible for them to
travel from the source to the destination via multiple routes.
.IP \(bu 2
\fBexpires\fP (\fI\%int\fP) \-\- The expiry time (in milliseconds) after which an upstream
queue for a federated exchange may be deleted, if a connection to the upstream
broker is lost. The default is \(aqnone\(aq, meaning the queue should never expire.
This setting controls how long the upstream queue will last before it is
eligible for deletion if the connection is lost.
This value is used to set the \(dqx\-expires\(dq argument for the upstream queue.
.IP \(bu 2
\fBmessage_ttl\fP (\fI\%int\fP) \-\- The expiry time for messages in the upstream queue
for a federated exchange (see expires), in milliseconds. Default is \fBNone\fP,
meaning messages should never expire. This does not apply to federated queues.
This value is used to set the \(dqx\-message\-ttl\(dq argument for the upstream queue.
.IP \(bu 2
\fBha_policy\fP (\fI\%str\fP) \-\- Determines the \(dqx\-ha\-policy\(dq argument for the upstream
queue for a federated exchange (see expires). This is only of interest
when connecting to old brokers which determine queue HA mode using this
argument. Default is \fBNone\fP, meaning the queue is not HA.
.UNINDENT
.UNINDENT
.sp
The following parameter applies to federated queues only:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBqueue\fP (\fI\%str\fP) \-\- The name of the upstream queue. Default is to use the same
name as the federated queue.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The name of the user to run the command as.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.set_upstream upstream_name ack_mode=on\-confirm max_hops=1             trust_user_id=True uri=amqp://hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.set_user_tags(name, tags, runas=None)
Add user tags via rabbitmqctl set_user_tags
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.set_user_tags myadmin administrator
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.start_app(runas=None)
Start the RabbitMQ application.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.start_app
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.status(runas=None)
return rabbitmq status
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.stop_app(runas=None)
Stops the RabbitMQ application, leaving the Erlang node running.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.stop_app
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.upstream_exists(name, runas=None)
Return whether the upstreamexists based on rabbitmqctl list_parameters.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the upstream to check for.
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- The name of the user to run the command as.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.upstream_exists rabbit_upstream
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.user_exists(name, runas=None)
Return whether the user exists based on rabbitmqctl list_users.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.user_exists rabbit_user
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.vhost_exists(name, runas=None)
Return whether the vhost exists based on rabbitmqctl list_vhosts.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rabbitmq.vhost_exists rabbit_host
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.rallydev
.sp
Support for RallyDev
.sp
New in version 2015.8.0.

.sp
Requires a \fBusername\fP and a \fBpassword\fP in \fB/etc/salt/minion\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rallydev:
  username: myuser@example.com
  password: 123pass
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rallydev.list_items(name)
List items of a particular type
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion rallydev.list_<item name>s
salt myminion rallydev.list_users
salt myminion rallydev.list_artifacts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rallydev.list_users()
List the users
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion rallydev.list_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rallydev.query_item(name, query_string, order=\(aqRank\(aq)
Query a type of record for one or more items. Requires a valid query string.
See \fI\%https://rally1.rallydev.com/slm/doc/webservice/introduction.jsp\fP for
information on query syntax.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion rallydev.query_<item name> <query string> [<order>]
salt myminion rallydev.query_task \(aq(Name contains github)\(aq
salt myminion rallydev.query_task \(aq(Name contains reactor)\(aq Rank
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rallydev.query_user(query_string, order=\(aqUserName\(aq)
Update a user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion rallydev.query_user \(aq(Name contains Jo)\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rallydev.show_artifact(id_)
Show an artifact
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion rallydev.show_artifact <artifact id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rallydev.show_item(name, id_)
Show an item
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion rallydev.show_<item name> <item id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rallydev.show_user(id_)
Show a user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion rallydev.show_user <user id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rallydev.update_item(name, id_, field=None, value=None, postdata=None)
Update an item. Either a field and a value, or a chunk of POST data, may be
used, but not both.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion rallydev.update_<item name> <item id> field=<field> value=<value>
salt myminion rallydev.update_<item name> <item id> postdata=<post data>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rallydev.update_user(id_, field, value)
Update a user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion rallydev.update_user <user id> <field> <new value>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.random_org
.sp
Module for retrieving random information from Random.org
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B configuration
This module can be used by either passing an api key and version
directly or by specifying both in a configuration profile in the salt
master/minion config.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
random_org:
  api_key: 7be1402d\-5719\-5bd3\-a306\-3def9f135da5
  api_version: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.random_org.generateBlobs(api_key=None, api_version=None, **kwargs)
List all Slack users.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi_key\fP \-\- The Random.org api key.
.IP \(bu 2
\fBapi_version\fP \-\- The Random.org api version.
.IP \(bu 2
\fBformat\fP \-\- Specifies the format in which the
blobs will be returned. Values
allowed are base64 and hex.
.UNINDENT
.TP
.B Returns
The user list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq get_integers number=5 min=1 max=6

salt \(aq*\(aq get_integers number=5 min=1 max=6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.random_org.generateDecimalFractions(api_key=None, api_version=None, **kwargs)
Generates true random decimal fractions
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi_key\fP \-\- The Random.org api key.
.IP \(bu 2
\fBapi_version\fP \-\- The Random.org api version.
.IP \(bu 2
\fBnumber\fP \-\- How many random decimal fractions
you need. Must be within the [1,1e4] range.
.IP \(bu 2
\fBdecimalPlaces\fP \-\- The number of decimal places
to use. Must be within the [1,20] range.
.IP \(bu 2
\fBreplacement\fP \-\- Specifies whether the random numbers should
be picked with replacement. The default (true)
will cause the numbers to be picked with replacement,
i.e., the resulting numbers may contain duplicate
values (like a series of dice rolls). If you want the
numbers picked to be unique (like raffle tickets drawn
from a container), set this value to false.
.UNINDENT
.TP
.B Returns
A list of decimal fraction
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq random_org.generateDecimalFractions number=10 decimalPlaces=4

salt \(aq*\(aq random_org.generateDecimalFractions number=10 decimalPlaces=4 replacement=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.random_org.generateGaussians(api_key=None, api_version=None, **kwargs)
This method generates true random numbers from a
Gaussian distribution (also known as a normal distribution).
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi_key\fP \-\- The Random.org api key.
.IP \(bu 2
\fBapi_version\fP \-\- The Random.org api version.
.IP \(bu 2
\fBnumber\fP \-\- How many random numbers you need.
Must be within the [1,1e4] range.
.IP \(bu 2
\fBmean\fP \-\- The distribution\(aqs mean. Must be
within the [\-1e6,1e6] range.
.IP \(bu 2
\fBstandardDeviation\fP \-\- The distribution\(aqs standard
deviation. Must be within
the [\-1e6,1e6] range.
.IP \(bu 2
\fBsignificantDigits\fP \-\- The number of significant digits
to use. Must be within the [2,20] range.
.UNINDENT
.TP
.B Returns
The user list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq random_org.generateGaussians number=10 mean=0.0 standardDeviation=1.0 significantDigits=8
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.random_org.generateIntegers(api_key=None, api_version=None, **kwargs)
Generate random integers
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi_key\fP \-\- The Random.org api key.
.IP \(bu 2
\fBapi_version\fP \-\- The Random.org api version.
.IP \(bu 2
\fBnumber\fP \-\- The number of integers to generate
.IP \(bu 2
\fBminimum\fP \-\- The lower boundary for the range from which the
random numbers will be picked. Must be within
the [\-1e9,1e9] range.
.IP \(bu 2
\fBmaximum\fP \-\- The upper boundary for the range from which the
random numbers will be picked. Must be within
the [\-1e9,1e9] range.
.IP \(bu 2
\fBreplacement\fP \-\- Specifies whether the random numbers should
be picked with replacement. The default (true)
will cause the numbers to be picked with replacement,
i.e., the resulting numbers may contain duplicate
values (like a series of dice rolls). If you want the
numbers picked to be unique (like raffle tickets drawn
from a container), set this value to false.
.IP \(bu 2
\fBbase\fP \-\- Specifies the base that will be used to display the numbers.
Values allowed are 2, 8, 10 and 16. This affects the JSON
types and formatting of the resulting data as discussed below.
.UNINDENT
.TP
.B Returns
A list of integers.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq random_org.generateIntegers number=5 minimum=1 maximum=6

salt \(aq*\(aq random_org.generateIntegers number=5 minimum=2 maximum=255 base=2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.random_org.generateStrings(api_key=None, api_version=None, **kwargs)
Generate random strings.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi_key\fP \-\- The Random.org api key.
.IP \(bu 2
\fBapi_version\fP \-\- The Random.org api version.
.IP \(bu 2
\fBnumber\fP \-\- The number of strings to generate.
.IP \(bu 2
\fBlength\fP \-\- The length of each string. Must be
within the [1,20] range. All strings
will be of the same length
.IP \(bu 2
\fBcharacters\fP \-\- A string that contains the set of
characters that are allowed to occur
in the random strings. The maximum number
of characters is 80.
.IP \(bu 2
\fBreplacement\fP \-\- Specifies whether the random strings should be picked
with replacement. The default (true) will cause the
strings to be picked with replacement, i.e., the
resulting list of strings may contain duplicates (like
a series of dice rolls). If you want the strings to be
unique (like raffle tickets drawn from a container), set
this value to false.
.UNINDENT
.TP
.B Returns
A list of strings.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq random_org.generateStrings number=5 length=8 characters=\(aqabcdefghijklmnopqrstuvwxyz\(aq

salt \(aq*\(aq random_org.generateStrings number=10 length=16 characters\(aqabcdefghijklmnopqrstuvwxyz\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.random_org.generateUUIDs(api_key=None, api_version=None, **kwargs)
Generate a list of random UUIDs
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi_key\fP \-\- The Random.org api key.
.IP \(bu 2
\fBapi_version\fP \-\- The Random.org api version.
.IP \(bu 2
\fBnumber\fP \-\- How many random UUIDs you need.
Must be within the [1,1e3] range.
.UNINDENT
.TP
.B Returns
A list of UUIDs
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq random_org.generateUUIDs number=5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.random_org.getUsage(api_key=None, api_version=None)
Show current usages statistics
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi_key\fP \-\- The Random.org api key.
.IP \(bu 2
\fBapi_version\fP \-\- The Random.org api version.
.UNINDENT
.TP
.B Returns
The current usage statistics.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq random_org.getUsage

salt \(aq*\(aq random_org.getUsage api_key=peWcBiMOS9HrZG15peWcBiMOS9HrZG15 api_version=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.rbac_solaris
.sp
Module for Solaris\(aq Role\-Based Access Control
.INDENT 0.0
.TP
.B salt.modules.rbac_solaris.auth_add(user, auth)
Add authorization to user
.INDENT 7.0
.TP
.B user
string
username
.TP
.B auth
string
authorization name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbac.auth_add martine solaris.zone.manage
salt \(aq*\(aq rbac.auth_add martine solaris.zone.manage,solaris.mail.mailq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbac_solaris.auth_get(user, computed=True)
List authorization for user
.INDENT 7.0
.TP
.B user
string
username
.TP
.B computed
boolean
merge results from \fIauths\fP command into data from user_attr
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbac.auth_get leo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbac_solaris.auth_list()
List all available authorization
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbac.auth_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbac_solaris.auth_rm(user, auth)
Remove authorization from user
.INDENT 7.0
.TP
.B user
string
username
.TP
.B auth
string
authorization name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbac.auth_rm jorge solaris.zone.manage
salt \(aq*\(aq rbac.auth_rm jorge solaris.zone.manage,solaris.mail.mailq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbac_solaris.profile_add(user, profile)
Add profile to user
.INDENT 7.0
.TP
.B user
string
username
.TP
.B profile
string
profile name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbac.profile_add martine \(aqPrimary Administrator\(aq
salt \(aq*\(aq rbac.profile_add martine \(aqUser Management,User Security\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbac_solaris.profile_get(user, default_hidden=True)
List profiles for user
.INDENT 7.0
.TP
.B user
string
username
.TP
.B default_hidden
boolean
hide default profiles
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbac.profile_get leo
salt \(aq*\(aq rbac.profile_get leo default_hidden=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbac_solaris.profile_list(default_only=False)
List all available profiles
.INDENT 7.0
.TP
.B default_only
boolean
return only default profile
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbac.profile_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbac_solaris.profile_rm(user, profile)
Remove profile from user
.INDENT 7.0
.TP
.B user
string
username
.TP
.B profile
string
profile name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbac.profile_rm jorge \(aqPrimary Administrator\(aq
salt \(aq*\(aq rbac.profile_rm jorge \(aqUser Management,User Security\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbac_solaris.role_add(user, role)
Add role to user
.INDENT 7.0
.TP
.B user
string
username
.TP
.B role
string
role name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbac.role_add martine netcfg
salt \(aq*\(aq rbac.role_add martine netcfg,zfssnap
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbac_solaris.role_get(user)
List roles for user
.INDENT 7.0
.TP
.B user
string
username
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbac.role_get leo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbac_solaris.role_list()
List all available roles
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbac.role_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbac_solaris.role_rm(user, role)
Remove role from user
.INDENT 7.0
.TP
.B user
string
username
.TP
.B role
string
role name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbac.role_rm jorge netcfg
salt \(aq*\(aq rbac.role_rm jorge netcfg,zfssnap
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.rbenv
.sp
Manage ruby installations with rbenv. rbenv is supported on Linux and macOS.
rbenv doesn\(aqt work on Windows (and isn\(aqt really necessary on Windows as there is
no system Ruby on Windows). On Windows, the RubyInstaller and/or Pik are both
good alternatives to work with multiple versions of Ruby on the same box.
.sp
\fI\%http://misheska.com/blog/2013/06/15/using\-rbenv\-to\-manage\-multiple\-versions\-of\-ruby/\fP
.sp
New in version 0.16.0.

.INDENT 0.0
.TP
.B salt.modules.rbenv.default(ruby=None, runas=None)
Returns or sets the currently defined default ruby
.INDENT 7.0
.TP
.B ruby
The version to set as the default. Should match one of the versions
listed by \fI\%rbenv.versions\fP\&.
Leave blank to return the current default.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbenv.default
salt \(aq*\(aq rbenv.default 2.0.0\-p0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbenv.do(cmdline, runas=None, env=None)
Execute a ruby command with rbenv\(aqs shims from the user or the system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbenv.do \(aqgem list bundler\(aq
salt \(aq*\(aq rbenv.do \(aqgem list bundler\(aq deploy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbenv.do_with_ruby(ruby, cmdline, runas=None)
Execute a ruby command with rbenv\(aqs shims using a specific ruby version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbenv.do_with_ruby 2.0.0\-p0 \(aqgem list bundler\(aq
salt \(aq*\(aq rbenv.do_with_ruby 2.0.0\-p0 \(aqgem list bundler\(aq runas=deploy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbenv.install(runas=None, path=None)
Install rbenv systemwide
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbenv.install
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbenv.install_ruby(ruby, runas=None)
Install a ruby implementation.
.INDENT 7.0
.TP
.B ruby
The version of Ruby to install, should match one of the
versions listed by \fBrbenv.list\fP
.TP
.B runas
The user under which to run rbenv. If not specified, then rbenv will be
run as the user under which Salt is running.
.UNINDENT
.sp
Additional environment variables can be configured in pillar /
grains / master:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
rbenv:
  build_env: \(aqCONFIGURE_OPTS=\(dq\-\-no\-tcmalloc\(dq CFLAGS=\(dq\-fno\-tree\-dce\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbenv.install_ruby 2.0.0\-p0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbenv.is_installed(runas=None)
Check if rbenv is installed
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbenv.is_installed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbenv.list_(runas=None)
List the installable versions of ruby
.INDENT 7.0
.TP
.B runas
The user under which to run rbenv. If not specified, then rbenv will be
run as the user under which Salt is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbenv.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbenv.rehash(runas=None)
Run \fBrbenv rehash\fP to update the installed shims
.INDENT 7.0
.TP
.B runas
The user under which to run rbenv. If not specified, then rbenv will be
run as the user under which Salt is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbenv.rehash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbenv.uninstall_ruby(ruby, runas=None)
Uninstall a ruby implementation.
.INDENT 7.0
.TP
.B ruby
The version of ruby to uninstall. Should match one of the versions
listed by \fI\%rbenv.versions\fP\&.
.TP
.B runas
The user under which to run rbenv. If not specified, then rbenv will be
run as the user under which Salt is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbenv.uninstall_ruby 2.0.0\-p0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbenv.update(runas=None, path=None)
Updates the current versions of rbenv and ruby\-build
.INDENT 7.0
.TP
.B runas
The user under which to run rbenv. If not specified, then rbenv will be
run as the user under which Salt is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbenv.update
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rbenv.versions(runas=None)
List the installed versions of ruby
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rbenv.versions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.rdp
.sp
Manage RDP Service on Windows servers
.INDENT 0.0
.TP
.B salt.modules.rdp.disable()
Disable RDP the service on the server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rdp.disable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rdp.disconnect_session(session_id)
Disconnect a session.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Parameters
\fBsession_id\fP \-\- The numeric Id of the session.
.TP
.B Returns
A boolean representing whether the disconnect succeeded.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rdp.disconnect_session session_id

salt \(aq*\(aq rdp.disconnect_session 99
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rdp.enable()
Enable RDP the service on the server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rdp.enable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rdp.get_session(session_id)
Get information about a session.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Parameters
\fBsession_id\fP \-\- The numeric Id of the session.
.TP
.B Returns
A dictionary of session information.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rdp.get_session session_id

salt \(aq*\(aq rdp.get_session 99
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rdp.list_sessions(logged_in_users_only=False)
List information about the sessions.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Parameters
\fBlogged_in_users_only\fP \-\- If True, only return sessions with users logged in.
.TP
.B Returns
A list containing dictionaries of session information.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rdp.list_sessions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rdp.logoff_session(session_id)
Initiate the logoff of a session.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Parameters
\fBsession_id\fP \-\- The numeric Id of the session.
.TP
.B Returns
A boolean representing whether the logoff succeeded.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rdp.logoff_session session_id

salt \(aq*\(aq rdp.logoff_session 99
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rdp.status()
Show if rdp is enabled on the server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rdp.status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.rebootmgr module
.sp
Module for rebootmgr
:maintainer:    Alberto Planas <\fI\%aplanas@suse.com\fP>
:maturity:      new
:depends:       None
:platform:      Linux
.sp
New in version 3004.

.INDENT 0.0
.TP
.B salt.modules.rebootmgr.cancel()
Cancels an already running reboot.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos rebootmgr cancel
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rebootmgr.get_group()
The currently set lock group for etcd.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos rebootmgr get_group
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rebootmgr.get_strategy()
The currently used reboot strategy of rebootmgrd will be printed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos rebootmgr get_strategy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rebootmgr.get_window()
The currently set maintenance window will be printed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos rebootmgr get_window
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rebootmgr.is_active()
Check if the rebootmgrd is running and active or not.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos rebootmgr is_active
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rebootmgr.lock(machine_id=None, group=None)
.INDENT 7.0
.TP
.B Lock a machine. If no group is specified, the local default group
will be used. If no machine\-id is specified, the local machine
will be locked.
.TP
.B machine_id
The machine\-id is a network wide, unique ID. Per default the
ID from /etc/machine\-id is used.
.TP
.B group
Group name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos rebootmgr lock group=group1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rebootmgr.reboot(order=None)
Tells rebootmgr to schedule a reboot.
.sp
With the [now] option, a forced reboot is done, no lock from etcd
is requested and a set maintenance window is ignored. With the
[fast] option, a lock from etcd is requested if needed, but a
defined maintenance window is ignored.
.INDENT 7.0
.TP
.B order
If specified, can be \(dqnow\(dq or \(dqfast\(dq
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos rebootmgr reboot
salt microos rebootmgt reboot order=now
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rebootmgr.set_group(group)
.INDENT 7.0
.TP
.B Set the group, to which this machine belongs to get a reboot lock
from etcd.
.TP
.B group
Group name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos rebootmgr set_group group=group_1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rebootmgr.set_max(max_locks, group=None)
.INDENT 7.0
.TP
.B Set the maximal number of hosts in a group, which are allowed to
reboot at the same time.
.TP
.B number
Maximal number of hosts in a group
.TP
.B group
Group name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos rebootmgr set_max 4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rebootmgr.set_strategy(strategy=None)
A new strategy to reboot the machine is set and written into
/etc/rebootmgr.conf.
.INDENT 7.0
.TP
.B strategy
If specified, must be one of those options:
.INDENT 7.0
.TP
.B best\-effort \- This is the default strategy. If etcd is
running, etcd\-lock is used. If no etcd is running, but a
maintenance window is specified, the strategy will be
maint\-window. If no maintenance window is specified, the
machine is immediately rebooted (instantly).
.TP
.B etcd\-lock \- A lock at etcd for the specified lock\-group will
be acquired before reboot. If a maintenance window is
specified, the lock is only acquired during this window.
.TP
.B maint\-window \- Reboot does happen only during a specified
maintenance window. If no window is specified, the
instantly strategy is followed.
.TP
.B instantly \- Other services will be informed that a reboot will
happen. Reboot will be done without getting any locks or
waiting for a maintenance window.
.TP
.B off \- Reboot requests are temporary
ignored. /etc/rebootmgr.conf is not modified.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos rebootmgr set_strategy stragegy=off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rebootmgr.set_window(time, duration)
Set\(aqs the maintenance window.
.INDENT 7.0
.TP
.B time
The format of time is the same as described in
systemd.time(7).
.TP
.B duration
The format of duration is \(dq[XXh][YYm]\(dq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos rebootmgr set_window time=\(dqThu,Fri 2020\-*\-1,5 11:12:13\(dq duration=1h
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rebootmgr.status()
Returns the current status of rebootmgrd.
.INDENT 7.0
.TP
.B Valid returned values are:
0 \- No reboot requested
1 \- Reboot requested
2 \- Reboot requested, waiting for maintenance window
3 \- Reboot requested, waiting for etcd lock.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos rebootmgr status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rebootmgr.unlock(machine_id=None, group=None)
.INDENT 7.0
.TP
.B Unlock a machine. If no group is specified, the local default group
will be used. If no machine\-id is specified, the local machine
will be locked.
.TP
.B machine_id
The machine\-id is a network wide, unique ID. Per default the
ID from /etc/machine\-id is used.
.TP
.B group
Group name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos rebootmgr unlock group=group1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rebootmgr.version()
Return the version of rebootmgrd
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos rebootmgr version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.redis
.sp
Module to provide redis functionality to Salt
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B configuration
This module requires the redis python module and uses the
following defaults which may be overridden in the minion configuration:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
redis.host: \(aqsalt\(aq
redis.port: 6379
redis.db: 0
redis.password: None
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.bgrewriteaof(host=None, port=None, db=None, password=None)
Asynchronously rewrite the append\-only file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.bgrewriteaof
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.bgsave(host=None, port=None, db=None, password=None)
Asynchronously save the dataset to disk
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.bgsave
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.config_get(pattern=\(aq*\(aq, host=None, port=None, db=None, password=None)
Get redis server configuration values
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.config_get
salt \(aq*\(aq redis.config_get port
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.config_set(name, value, host=None, port=None, db=None, password=None)
Set redis server configuration values
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.config_set masterauth luv_kittens
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.dbsize(host=None, port=None, db=None, password=None)
Return the number of keys in the selected database
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.dbsize
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.delete(*keys, **connection_args)
Deletes the keys from redis, returns number of keys deleted
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.delete foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.exists(key, host=None, port=None, db=None, password=None)
Return true if the key exists in redis
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.exists foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.expire(key, seconds, host=None, port=None, db=None, password=None)
Set a keys time to live in seconds
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.expire foo 300
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.expireat(key, timestamp, host=None, port=None, db=None, password=None)
Set a keys expire at given UNIX time
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.expireat foo 1400000000
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.flushall(host=None, port=None, db=None, password=None)
Remove all keys from all databases
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.flushall
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.flushdb(host=None, port=None, db=None, password=None)
Remove all keys from the selected database
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.flushdb
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.get_key(key, host=None, port=None, db=None, password=None)
Get redis key value
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.get_key foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.get_master_ip(host=None, port=None, password=None)
Get host information about slave
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.get_master_ip
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.hdel(key, *fields, **options)
Delete one of more hash fields.
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.hdel foo_hash bar_field1 bar_field2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.hexists(key, field, host=None, port=None, db=None, password=None)
Determine if a hash fields exists.
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.hexists foo_hash bar_field
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.hget(key, field, host=None, port=None, db=None, password=None)
Get specific field value from a redis hash, returns dict
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.hget foo_hash bar_field
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.hgetall(key, host=None, port=None, db=None, password=None)
Get all fields and values from a redis hash, returns dict
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.hgetall foo_hash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.hincrby(key, field, increment=1, host=None, port=None, db=None, password=None)
Increment the integer value of a hash field by the given number.
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.hincrby foo_hash bar_field 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.hincrbyfloat(key, field, increment=1.0, host=None, port=None, db=None, password=None)
Increment the float value of a hash field by the given number.
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.hincrbyfloat foo_hash bar_field 5.17
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.hlen(key, host=None, port=None, db=None, password=None)
Returns number of fields of a hash.
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.hlen foo_hash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.hmget(key, *fields, **options)
Returns the values of all the given hash fields.
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.hmget foo_hash bar_field1 bar_field2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.hmset(key, **fieldsvals)
Sets multiple hash fields to multiple values.
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.hmset foo_hash bar_field1=bar_value1 bar_field2=bar_value2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.hscan(key, cursor=0, match=None, count=None, host=None, port=None, db=None, password=None)
Incrementally iterate hash fields and associated values.
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.hscan foo_hash match=\(aqfield_prefix_*\(aq count=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.hset(key, field, value, host=None, port=None, db=None, password=None)
Set the value of a hash field.
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.hset foo_hash bar_field bar_value
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.hsetnx(key, field, value, host=None, port=None, db=None, password=None)
Set the value of a hash field only if the field does not exist.
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.hsetnx foo_hash bar_field bar_value
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.hvals(key, host=None, port=None, db=None, password=None)
Return all the values in a hash.
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.hvals foo_hash bar_field1 bar_value1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.info(host=None, port=None, db=None, password=None)
Get information and statistics about the server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.key_type(key, host=None, port=None, db=None, password=None)
Get redis key type
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.type foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.keys(pattern=\(aq*\(aq, host=None, port=None, db=None, password=None)
Get redis keys, supports glob style patterns
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.keys
salt \(aq*\(aq redis.keys test*
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.lastsave(host=None, port=None, db=None, password=None)
Get the UNIX time in seconds of the last successful save to disk
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.lastsave
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.llen(key, host=None, port=None, db=None, password=None)
Get the length of a list in Redis
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.llen foo_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.lrange(key, start, stop, host=None, port=None, db=None, password=None)
Get a range of values from a list in Redis
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.lrange foo_list 0 10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.ping(host=None, port=None, db=None, password=None)
Ping the server, returns False on connection errors
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.save(host=None, port=None, db=None, password=None)
Synchronously save the dataset to disk
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.save
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.sentinel_get_master_ip(master, host=None, port=None, password=None)
Get ip for sentinel master
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.sentinel_get_master_ip \(aqmymaster\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.set_key(key, value, host=None, port=None, db=None, password=None)
Set redis key value
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.set_key foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.shutdown(host=None, port=None, db=None, password=None)
Synchronously save the dataset to disk and then shut down the server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.shutdown
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.slaveof(master_host=None, master_port=None, host=None, port=None, db=None, password=None)
Make the server a slave of another instance, or promote it as master
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Become slave of redis\-n01.example.com:6379
salt \(aq*\(aq redis.slaveof redis\-n01.example.com 6379
salt \(aq*\(aq redis.slaveof redis\-n01.example.com
# Become master
salt \(aq*\(aq redis.slaveof
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.smembers(key, host=None, port=None, db=None, password=None)
Get members in a Redis set
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.smembers foo_set
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.time(host=None, port=None, db=None, password=None)
Return the current server UNIX time in seconds
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.time
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.zcard(key, host=None, port=None, db=None, password=None)
Get the length of a sorted set in Redis
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.zcard foo_sorted
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.redismod.zrange(key, start, stop, host=None, port=None, db=None, password=None)
Get a range of values from a sorted set in Redis by index
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq redis.zrange foo_sorted 0 10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.reg
.sp
Manage the Windows registry
.SS Hives
.sp
Hives are the main sections of the registry and all begin with the word HKEY.
.INDENT 0.0
.IP \(bu 2
HKEY_LOCAL_MACHINE
.IP \(bu 2
HKEY_CURRENT_USER
.IP \(bu 2
HKEY_USER
.UNINDENT
.SS Keys
.sp
Keys are the folders in the registry. Keys can have many nested subkeys. Keys
can have a value assigned to them under the (Default)
.sp
When passing a key on the CLI it must be quoted correctly depending on the
backslashes being used (\fB\e\fP vs \fB\e\e\fP). The following are valid methods of
passing the key on the CLI:
.INDENT 0.0
.TP
.B Using single backslashes:
\fB\(dqSOFTWARE\ePython\(dq\fP
\fB\(aqSOFTWARE\ePython\(aq\fP (will not work on a Windows Master)
.TP
.B Using double backslashes:
\fBSOFTWARE\e\ePython\fP
.UNINDENT
.SS Values or Entries
.sp
Values or Entries are the name/data pairs beneath the keys and subkeys. All keys
have a default name/data pair. The name is \fB(Default)\fP with a displayed value
of \fB(value not set)\fP\&. The actual value is Null.
.sp
Example
.sp
The following example is an export from the Windows startup portion of the
registry:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[HKEY_LOCAL_MACHINE\eSOFTWARE\eMicrosoft\eWindows\eCurrentVersion\eRun]
\(dqRTHDVCPL\(dq=\(dq\e\(dqC:\e\eProgram Files\e\eRealtek\e\eAudio\e\eHDA\e\eRtkNGUI64.exe\e\(dq \-s\(dq
\(dqNvBackend\(dq=\(dq\e\(dqC:\e\eProgram Files (x86)\e\eNVIDIA Corporation\e\eUpdate Core\e\eNvBackend.exe\e\(dq\(dq
\(dqBTMTrayAgent\(dq=\(dqrundll32.exe \e\(dqC:\e\eProgram Files (x86)\e\eIntel\e\eBluetooth\e\ebtmshellex.dll\e\(dq,TrayApp\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example these are the values for each:
.INDENT 0.0
.TP
.B Hive:
\fBHKEY_LOCAL_MACHINE\fP
.TP
.B Key and subkeys:
\fBSOFTWARE\e\eMicrosoft\e\eWindows\e\eCurrentVersion\e\eRun\fP
.TP
.B Value:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B There are 3 value names:
.INDENT 7.0
.IP \(bu 2
\fIRTHDVCPL\fP
.IP \(bu 2
\fINvBackend\fP
.IP \(bu 2
\fIBTMTrayAgent\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
Each value name has a corresponding value
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
salt.utils.win_reg
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.reg.broadcast_change()
Refresh the windows environment.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This will only effect new processes and windows. Services will not see
the change until the system restarts.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq reg.broadcast_change
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.reg.delete_key_recursive(hive, key, use_32bit_registry=False)
New in version 2015.5.4.

.sp
Delete a registry key to include all subkeys and value/data pairs.
.INDENT 7.0
.TP
.B Parameters
\fBhive\fP (\fI\%str\fP) \-\-
.sp
The name of the hive. Can be one of the following
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
HKEY_LOCAL_MACHINE or HKLM
.IP \(bu 2
HKEY_CURRENT_USER or HKCU
.IP \(bu 2
HKEY_USER or HKU
.IP \(bu 2
HKEY_CLASSES_ROOT or HKCR
.IP \(bu 2
HKEY_CURRENT_CONFIG or HKCC
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B key (str):
The key to remove (looks like a path)
.TP
.B use_32bit_registry (bool):
Deletes the 32bit portion of the registry on 64bit
installations. On 32bit machines this is ignored.
.UNINDENT

.TP
.B Returns
.INDENT 7.0
.TP
.B A dictionary listing the keys that deleted successfully as well as
those that failed to delete.
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
The following example will remove \fBdelete_me\fP and all its subkeys from the
\fBSOFTWARE\fP key in \fBHKEY_LOCAL_MACHINE\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq reg.delete_key_recursive HKLM SOFTWARE\e\edelete_me
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.reg.delete_value(hive, key, vname=None, use_32bit_registry=False)
Delete a registry value entry or the default value for a key.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhive\fP (\fI\%str\fP) \-\-
.sp
The name of the hive. Can be one of the following
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
HKEY_LOCAL_MACHINE or HKLM
.IP \(bu 2
HKEY_CURRENT_USER or HKCU
.IP \(bu 2
HKEY_USER or HKU
.IP \(bu 2
HKEY_CLASSES_ROOT or HKCR
.IP \(bu 2
HKEY_CURRENT_CONFIG or HKCC
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The key (looks like a path) to the value name.
.IP \(bu 2
\fBvname\fP (\fI\%str\fP) \-\- The value name. These are the individual name/data pairs under the
key. If not passed, the key (Default) value will be deleted.
.IP \(bu 2
\fBuse_32bit_registry\fP (\fI\%bool\fP) \-\- Deletes the 32bit portion of the registry on 64bit installations. On
32bit machines this is ignored.
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq reg.delete_value HKEY_CURRENT_USER \(aqSOFTWARE\e\eSalt\(aq \(aqversion\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.reg.import_file(source, use_32bit_registry=False)
Import registry settings from a Windows \fBREG\fP file by invoking \fBREG.EXE\fP\&.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- The full path of the \fBREG\fP file. This can be either a local file
path or a URL type supported by salt (e.g. \fBsalt://salt_master_path\fP)
.IP \(bu 2
\fBuse_32bit_registry\fP (\fI\%bool\fP) \-\- If the value of this parameter is \fBTrue\fP then the \fBREG\fP file
will be imported into the Windows 32 bit registry. Otherwise the
Windows 64 bit registry will be used.
.UNINDENT
.TP
.B Returns
True if successful, otherwise an error is raised
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%ValueError\fP \-\- If the value of \fBsource\fP is an invalid path or otherwise
    causes \fBcp.cache_file\fP to return \fBFalse\fP
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If \fBreg.exe\fP exits with a non\-0 exit code
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt machine1 reg.import_file salt://win/printer_config/110_Canon/postinstall_config.reg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.reg.key_exists(hive, key, use_32bit_registry=False)
Check that the key is found in the registry. This refers to keys and not
value/data pairs.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhive\fP (\fI\%str\fP) \-\- The hive to connect to
.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The key to check
.IP \(bu 2
\fBuse_32bit_registry\fP (\fI\%bool\fP) \-\- Look in the 32bit portion of the registry
.UNINDENT
.TP
.B Returns
True if exists, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq reg.key_exists HKLM SOFTWARE\eMicrosoft
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.reg.list_keys(hive, key=None, use_32bit_registry=False)
Enumerates the subkeys in a registry key or hive.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhive\fP (\fI\%str\fP) \-\-
.sp
The name of the hive. Can be one of the following:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
HKEY_LOCAL_MACHINE or HKLM
.IP \(bu 2
HKEY_CURRENT_USER or HKCU
.IP \(bu 2
HKEY_USER or HKU
.IP \(bu 2
HKEY_CLASSES_ROOT or HKCR
.IP \(bu 2
HKEY_CURRENT_CONFIG or HKCC
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The key (looks like a path) to the value name. If a key is not
passed, the keys under the hive will be returned.
.IP \(bu 2
\fBuse_32bit_registry\fP (\fI\%bool\fP) \-\- Accesses the 32bit portion of the registry on 64 bit installations.
On 32bit machines this is ignored.
.UNINDENT
.TP
.B Returns
A list of keys/subkeys under the hive or key.
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq reg.list_keys HKLM \(aqSOFTWARE\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.reg.list_values(hive, key=None, use_32bit_registry=False)
Enumerates the values in a registry key or hive.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fB(Default)\fP value will only be returned if it is set, otherwise it
will not be returned in the list of values.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhive\fP (\fI\%str\fP) \-\-
.sp
The name of the hive. Can be one of the following:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
HKEY_LOCAL_MACHINE or HKLM
.IP \(bu 2
HKEY_CURRENT_USER or HKCU
.IP \(bu 2
HKEY_USER or HKU
.IP \(bu 2
HKEY_CLASSES_ROOT or HKCR
.IP \(bu 2
HKEY_CURRENT_CONFIG or HKCC
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The key (looks like a path) to the value name. If a key is not
passed, the values under the hive will be returned.
.IP \(bu 2
\fBuse_32bit_registry\fP (\fI\%bool\fP) \-\- Accesses the 32bit portion of the registry on 64 bit installations.
On 32bit machines this is ignored.
.UNINDENT
.TP
.B Returns
A list of values under the hive or key.
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq reg.list_values HKLM \(aqSYSTEM\e\eCurrentControlSet\e\eServices\e\eTcpip\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.reg.read_value(hive, key, vname=None, use_32bit_registry=False)
Reads a registry value entry or the default value for a key. To read the
default value, don\(aqt pass \fBvname\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhive\fP (\fI\%str\fP) \-\-
.sp
The name of the hive. Can be one of the following:
.INDENT 2.0
.IP \(bu 2
HKEY_LOCAL_MACHINE or HKLM
.IP \(bu 2
HKEY_CURRENT_USER or HKCU
.IP \(bu 2
HKEY_USER or HKU
.IP \(bu 2
HKEY_CLASSES_ROOT or HKCR
.IP \(bu 2
HKEY_CURRENT_CONFIG or HKCC
.UNINDENT

.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The key (looks like a path) to the value name.
.IP \(bu 2
\fBvname\fP (\fI\%str\fP) \-\- The value name. These are the individual name/data pairs under the
key. If not passed, the key (Default) value will be returned.
.IP \(bu 2
\fBuse_32bit_registry\fP (\fI\%bool\fP) \-\- Accesses the 32bit portion of the registry on 64bit installations.
On 32bit machines this is ignored.
.UNINDENT
.TP
.B Returns
A dictionary containing the passed settings as well as the
value_data if successful. If unsuccessful, sets success to False.
.sp
bool: Returns False if the key is not found
.sp
If vname is not passed:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Returns the first unnamed value (Default) as a string.
.IP \(bu 2
Returns none if first unnamed value is empty.
.UNINDENT
.UNINDENT
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
The following will get the value of the \fBversion\fP value name in the
\fBHKEY_LOCAL_MACHINE\e\eSOFTWARE\e\eSalt\fP key
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq reg.read_value HKEY_LOCAL_MACHINE \(aqSOFTWARE\eSalt\(aq \(aqversion\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
The following will get the default value of the
\fBHKEY_LOCAL_MACHINE\e\eSOFTWARE\e\eSalt\fP key
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq reg.read_value HKEY_LOCAL_MACHINE \(aqSOFTWARE\eSalt\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.reg.set_value(hive, key, vname=None, vdata=None, vtype=\(aqREG_SZ\(aq, use_32bit_registry=False, volatile=False)
Sets a value in the registry. If \fBvname\fP is passed, it will be the value
for that value name, otherwise it will be the default value for the
specified key
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhive\fP (\fI\%str\fP) \-\-
.sp
The name of the hive. Can be one of the following
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
HKEY_LOCAL_MACHINE or HKLM
.IP \(bu 2
HKEY_CURRENT_USER or HKCU
.IP \(bu 2
HKEY_USER or HKU
.IP \(bu 2
HKEY_CLASSES_ROOT or HKCR
.IP \(bu 2
HKEY_CURRENT_CONFIG or HKCC
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The key (looks like a path) to the value name.
.IP \(bu 2
\fBvname\fP (\fI\%str\fP) \-\- The value name. These are the individual name/data pairs under the
key. If not passed, the key (Default) value will be set.
.IP \(bu 2
\fBvdata\fP (\fI\%str\fP\fI, \fP\fI\%int\fP\fI, \fP\fI\%list\fP\fI, \fP\fI\%bytes\fP) \-\-
.sp
The value you\(aqd like to set. If a value name (vname) is passed, this
will be the data for that value name. If not, this will be the
(Default) value for the key.
.sp
The type of data this parameter expects is determined by the value
type specified in \fBvtype\fP\&. The correspondence is as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
REG_BINARY: Binary data (str in Py2, bytes in Py3)
.IP \(bu 2
REG_DWORD: int
.IP \(bu 2
REG_EXPAND_SZ: str
.IP \(bu 2
REG_MULTI_SZ: list of str
.IP \(bu 2
REG_QWORD: int
.IP \(bu 2
REG_SZ: str
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When setting REG_BINARY, string data will be converted to
binary.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The type for the (Default) value is always REG_SZ and cannot be
changed.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This parameter is optional. If \fBvdata\fP is not passed, the Key
will be created with no associated item/value pairs.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBvtype\fP (\fI\%str\fP) \-\- The value type. The possible values of the vtype parameter are
indicated above in the description of the vdata parameter.
.IP \(bu 2
\fBuse_32bit_registry\fP (\fI\%bool\fP) \-\- Sets the 32bit portion of the registry on 64bit installations. On
32bit machines this is ignored.
.IP \(bu 2
\fBvolatile\fP (\fI\%bool\fP) \-\- When this parameter has a value of True, the registry key will be
made volatile (i.e. it will not persist beyond a system reset or
shutdown). This parameter only has an effect when a key is being
created and at no other time.
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
This will set the version value to 2015.5.2 in the SOFTWARESalt key in
the HKEY_LOCAL_MACHINE hive
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq reg.set_value HKEY_LOCAL_MACHINE \(aqSOFTWARE\eSalt\(aq \(aqversion\(aq \(aq2015.5.2\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
This function is strict about the type of vdata. For instance this
example will fail because vtype has a value of REG_SZ and vdata has a
type of int (as opposed to str as expected).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq reg.set_value HKEY_LOCAL_MACHINE \(aqSOFTWARE\eSalt\(aq \(aqstr_data\(aq 1.2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
In this next example vdata is properly quoted and should succeed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq reg.set_value HKEY_LOCAL_MACHINE \(aqSOFTWARE\eSalt\(aq \(aqstr_data\(aq vtype=REG_SZ vdata=\(dq\(aq1.2\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
This is an example of using vtype REG_BINARY.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq reg.set_value HKEY_LOCAL_MACHINE \(aqSOFTWARE\eSalt\(aq \(aqbin_data\(aq vtype=REG_BINARY vdata=\(aqSalty Data\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
An example of using vtype REG_MULTI_SZ is as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq reg.set_value HKEY_LOCAL_MACHINE \(aqSOFTWARE\eSalt\(aq \(aqlist_data\(aq vtype=REG_MULTI_SZ vdata=\(aq[\(dqSalt\(dq, \(dqis\(dq, \(dqgreat\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.reg.value_exists(hive, key, vname, use_32bit_registry=False)
Check that the value/data pair is found in the registry.
.sp
New in version 3000.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhive\fP (\fI\%str\fP) \-\- The hive to connect to
.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The key to check in
.IP \(bu 2
\fBvname\fP (\fI\%str\fP) \-\- The name of the value/data pair you\(aqre checking
.IP \(bu 2
\fBuse_32bit_registry\fP (\fI\%bool\fP) \-\- Look in the 32bit portion of the registry
.UNINDENT
.TP
.B Returns
True if exists, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq reg.value_exists HKLM SOFTWARE\eMicrosoft\eWindows\eCurrentVersion CommonFilesDir
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.rest_pkg
.sp
Package support for the REST example
.INDENT 0.0
.TP
.B salt.modules.rest_pkg.install(name=None, refresh=False, fromrepo=None, pkgs=None, sources=None, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rest_pkg.installed(name, version=None, refresh=False, fromrepo=None, skip_verify=False, pkgs=None, sources=None, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rest_pkg.list_pkgs(versions_as_list=False, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rest_pkg.remove(name=None, pkgs=None, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rest_pkg.upgrade(refresh=True, skip_verify=True, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rest_pkg.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.rest_sample_utils
.sp
Utility functions for the rest_sample
.INDENT 0.0
.TP
.B salt.modules.rest_sample_utils.fix_outage()
\(dqFix\(dq the outage
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqrest\-sample\-proxy\(aq rest_sample.fix_outage
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rest_sample_utils.get_test_string()
Helper function to test cross\-calling to the __proxy__ dunder.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqrest\-sample\-proxy\(aq rest_sample.get_test_string
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.rest_service
.sp
Provide the service module for the proxy\-minion REST sample
.INDENT 0.0
.TP
.B salt.modules.rest_service.enabled(name, sig=None)
Only the \(aqredbull\(aq service is \(aqenabled\(aq in the test
.sp
New in version 2015.8.1.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rest_service.get_all()
Return a list of all available services
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rest_service.list_()
Return a list of all available services.
.sp
New in version 2015.8.1.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rest_service.restart(name, sig=None)
Restart the specified service with rest_sample
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rest_service.running(name, sig=None)
Return whether this service is running.
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rest_service.start(name, sig=None)
Start the specified service on the rest_sample
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rest_service.status(name, sig=None)
Return the status for a service via rest_sample.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.sp
New in version 2015.8.0.

.sp
Changed in version 2018.3.0: The service name can now be a glob (e.g. \fBsalt*\fP)

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.IP \(bu 2
\fBsig\fP (\fI\%str\fP) \-\- Not implemented
.UNINDENT
.TP
.B Returns
True if running, False otherwise
dict: Maps service name to True if running, False otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rest_service.stop(name, sig=None)
Stop the specified service on the rest_sample
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.restartcheck
.sp
checkrestart functionality for Debian and Red Hat Based systems
.sp
Identifies services (processes) that are linked against deleted files (for example after downloading an updated
binary of a shared library).
.sp
Based on checkrestart script from debian\-goodies (written  by Matt Zimmerman for the Debian GNU/Linux distribution,
\fI\%https://packages.debian.org/debian\-goodies\fP) and psdel by Sam Morris.
.INDENT 0.0
.TP
.B codeauthor
Jiri Kotlin <\fI\%jiri.kotlin@ultimum.io\fP>
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.restartcheck.restartcheck(ignorelist=None, blacklist=None, excludepid=None, **kwargs)
Analyzes files openeded by running processes and seeks for packages which need to be restarted.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBignorelist\fP \-\- string or list of packages to be ignored.
.IP \(bu 2
\fBblacklist\fP \-\- string or list of file paths to be ignored.
.IP \(bu 2
\fBexcludepid\fP \-\- string or list of process IDs to be ignored.
.IP \(bu 2
\fBverbose\fP \-\- boolean, enables extensive output.
.IP \(bu 2
\fBtimeout\fP \-\- int, timeout in minute.
.UNINDENT
.TP
.B Returns
\fB{ \(aqresult\(aq: False, \(aqcomment\(aq: \(aq<reason>\(aq }\fP\&.
String with checkrestart output if some package seems to need to be restarted or
if no packages need restarting.
.TP
.B Return type
Dict on error
.UNINDENT
.sp
New in version 2015.8.3.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq restartcheck.restartcheck
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.restconf
.sp
Execution module for RESTCONF Proxy minions
.INDENT 0.0
.TP
.B codeauthor
Jamie (Bear) Murphy <\fI\%jamiemurphyit@gmail.com\fP>
.TP
.B maturity
new
.TP
.B platform
any
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.restconf.get_data(path)
Returns an object containing the content of the request path with a GET request.
Data returned will contain a dict with at minimum a key of \(dqstatus\(dq containing the http status code
Other keys that should be available error (if http error), body, dict (parsed json to dict)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq restconf.get_data restconf/yang\-library\-version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.restconf.info()
Returns the RESTCONF capabilities PATH
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq restconf.info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.restconf.path_check(primary_path, init_path)
Used to check which path responds with a 200 status
Returns an array of True/False and a dict with keys path + path_method + response data, used in states code.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq restconf.path_check restconf/yang\-library\-version/specifc_item restconf/yang\-library\-version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.restconf.set_data(path, method, dict_payload)
Sends a post/patch/other type of rest method to a specified path with the specified method with specified payload
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq restconf.set_data restconf/yang\-library\-version method=PATCH dict_payload=\(dq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.ret
.sp
Module to integrate with the returner system and retrieve data sent to a salt returner
.INDENT 0.0
.TP
.B salt.modules.ret.get_fun(returner, fun)
Return info about last time fun was called on each minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ret.get_fun mysql network.interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ret.get_jid(returner, jid)
Return the information for a specified job id
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ret.get_jid redis 20421104181954700505
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ret.get_jids(returner)
Return a list of all job ids
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ret.get_jids mysql
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ret.get_minions(returner)
Return a list of all minions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ret.get_minions mysql
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.rh_ip
.sp
The networking module for RHEL/Fedora based distros
.INDENT 0.0
.TP
.B salt.modules.rh_ip.apply_network_settings(**settings)
Apply global network configuration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.apply_network_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_ip.build_interface(iface, iface_type, enabled, **settings)
Build an interface script for a network interface.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.build_interface eth0 eth <settings>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_ip.build_network_settings(**settings)
Build the global network script.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.build_network_settings <settings>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_ip.build_routes(iface, **settings)
Build a route script for a network interface.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.build_routes eth0 <settings>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_ip.down(iface, iface_type)
Shutdown a network interface
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.down eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_ip.get_interface(iface)
Return the contents of an interface script
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.get_interface eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_ip.get_network_settings()
Return the contents of the global network script.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.get_network_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_ip.get_routes(iface)
Return the contents of the interface routes script.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.get_routes eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_ip.up(iface, iface_type)
Start up a network interface
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.up eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.rh_service
.sp
Service support for RHEL\-based systems, including support for both upstart and sysvinit
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage services on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqservice.start\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_service.available(name, limit=\(aq\(aq)
Return True if the named service is available.  Use the \fBlimit\fP param to
restrict results to services of that type.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.available sshd
salt \(aq*\(aq service.available sshd limit=upstart
salt \(aq*\(aq service.available sshd limit=sysvinit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_service.delete(name, **kwargs)
Delete the named service
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.delete <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_service.disable(name, **kwargs)
Disable the named service to start at boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_service.disabled(name)
Check to see if the named service is disabled to start on boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_service.enable(name, **kwargs)
Enable the named service to start at boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_service.enabled(name, **kwargs)
Check to see if the named service is enabled to start on boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_service.get_all(limit=\(aq\(aq)
Return all installed services. Use the \fBlimit\fP param to restrict results
to services of that type.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
salt \(aq*\(aq service.get_all limit=upstart
salt \(aq*\(aq service.get_all limit=sysvinit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_service.get_disabled(limit=\(aq\(aq)
Return the disabled services. Use the \fBlimit\fP param to restrict results
to services of that type.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_disabled
salt \(aq*\(aq service.get_disabled limit=upstart
salt \(aq*\(aq service.get_disabled limit=sysvinit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_service.get_enabled(limit=\(aq\(aq)
Return the enabled services. Use the \fBlimit\fP param to restrict results
to services of that type.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_enabled
salt \(aq*\(aq service.get_enabled limit=upstart
salt \(aq*\(aq service.get_enabled limit=sysvinit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_service.missing(name, limit=\(aq\(aq)
The inverse of service.available.
Return True if the named service is not available.  Use the \fBlimit\fP param to
restrict results to services of that type.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.missing sshd
salt \(aq*\(aq service.missing sshd limit=upstart
salt \(aq*\(aq service.missing sshd limit=sysvinit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_service.reload_(name)
Reload the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_service.restart(name)
Restart the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_service.start(name)
Start the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_service.status(name, sig=None)
Return the status for a service.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.sp
Changed in version 2018.3.0: The service name can now be a glob (e.g. \fBsalt*\fP)

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.IP \(bu 2
\fBsig\fP (\fI\%str\fP) \-\- Signature to use to find the service via ps
.UNINDENT
.TP
.B Returns
True if running, False otherwise
dict: Maps service name to True if running, False otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name> [service signature]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rh_service.stop(name)
Stop the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.riak
.sp
Riak Salt Module
.INDENT 0.0
.TP
.B salt.modules.riak.cluster_commit()
Commit Cluster Changes
.sp
Changed in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq riak.cluster_commit
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.riak.cluster_join(username, hostname)
Join a Riak cluster
.sp
Changed in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq riak.cluster_join <user> <host>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
username \- The riak username to join the cluster
hostname \- The riak hostname you are connecting to
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.riak.cluster_leave(username, hostname)
Leave a Riak cluster
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq riak.cluster_leave <username> <host>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
username \- The riak username to join the cluster
hostname \- The riak hostname you are connecting to
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.riak.cluster_plan()
Review Cluster Plan
.sp
Changed in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq riak.cluster_plan
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.riak.member_status()
Get cluster member status
.sp
Changed in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq riak.member_status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.riak.services()
List available services on a node
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq riak.services
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.riak.start()
Start Riak
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq riak.start
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.riak.status()
Current node status
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq riak.status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.riak.stop()
Stop Riak
.sp
Changed in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq riak.stop
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.riak.test()
Runs a test of a few standard Riak operations
.sp
New in version 2015.8.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq riak.test
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.rpm_lowpkg
.sp
Support for rpm
.INDENT 0.0
.TP
.B salt.modules.rpm_lowpkg.bin_pkg_info(path, saltenv=\(aqbase\(aq)
New in version 2015.8.0.

.sp
Parses RPM metadata and returns a dictionary of information about the
package (name, version, etc.).
.INDENT 7.0
.TP
.B path
Path to the file. Can either be an absolute path to a file on the
minion, or a salt fileserver URL (e.g. \fBsalt://path/to/file.rpm\fP).
If a salt fileserver URL is passed, the file will be cached to the
minion so that it can be examined.
.TP
.B saltenv
base
Salt fileserver environment from which to retrieve the package. Ignored
if \fBpath\fP is a local file path on the minion.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.bin_pkg_info /root/salt\-2015.5.1\-2.el7.noarch.rpm
salt \(aq*\(aq lowpkg.bin_pkg_info salt://salt\-2015.5.1\-2.el7.noarch.rpm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rpm_lowpkg.checksum(*paths, **kwargs)
Return if the signature of a RPM file is valid.
.INDENT 7.0
.TP
.B root
use root as top level directory (default: \(dq/\(dq)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.checksum /path/to/package1.rpm
salt \(aq*\(aq lowpkg.checksum /path/to/package1.rpm /path/to/package2.rpm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rpm_lowpkg.diff(package_path, path)
Return a formatted diff between current file and original in a package.
NOTE: this function includes all files (configuration and not), but does
not work on binary content.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpackage\fP \-\- Full pack of the RPM file
.IP \(bu 2
\fBpath\fP \-\- Full path to the installed file
.UNINDENT
.TP
.B Returns
Difference or empty string. For binary files only a notification.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.diff /path/to/apache2.rpm /etc/apache2/httpd.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rpm_lowpkg.file_dict(*packages, **kwargs)
List the files that belong to a package, sorted by group. Not specifying
any packages will return a list of _every_ file on the system\(aqs rpm
database (not generally recommended).
.INDENT 7.0
.TP
.B root
use root as top level directory (default: \(dq/\(dq)
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.file_dict httpd
salt \(aq*\(aq lowpkg.file_dict httpd postfix
salt \(aq*\(aq lowpkg.file_dict
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rpm_lowpkg.file_list(*packages, **kwargs)
List the files that belong to a package. Not specifying any packages will
return a list of _every_ file on the system\(aqs rpm database (not generally
recommended).
.INDENT 7.0
.TP
.B root
use root as top level directory (default: \(dq/\(dq)
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.file_list httpd
salt \(aq*\(aq lowpkg.file_list httpd postfix
salt \(aq*\(aq lowpkg.file_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rpm_lowpkg.info(*packages, **kwargs)
Return a detailed package(s) summary information.
If no packages specified, all packages will be returned.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpackages\fP \-\-
.IP \(bu 2
\fBattr\fP \-\-
.sp
Comma\-separated package attributes. If no \(aqattr\(aq is specified, all available attributes returned.
.INDENT 2.0
.TP
.B Valid attributes are:
version, vendor, release, build_date, build_date_time_t, install_date, install_date_time_t,
build_host, group, source_rpm, arch, epoch, size, license, signature, packager, url, summary, description.
.UNINDENT

.IP \(bu 2
\fBall_versions\fP \-\- Return information for all installed versions of the packages
.IP \(bu 2
\fBroot\fP \-\- use root as top level directory (default: \(dq/\(dq)
.UNINDENT
.TP
.B Returns

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.info apache2 bash
salt \(aq*\(aq lowpkg.info apache2 bash attr=version
salt \(aq*\(aq lowpkg.info apache2 bash attr=version,build_date_iso,size
salt \(aq*\(aq lowpkg.info apache2 bash attr=version,build_date_iso,size all_versions=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rpm_lowpkg.list_pkgs(*packages, **kwargs)
List the packages currently installed in a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B root
use root as top level directory (default: \(dq/\(dq)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rpm_lowpkg.modified(*packages, **flags)
List the modified files that belong to a package. Not specifying any packages
will return a list of _all_ modified files on the system\(aqs RPM database.
.sp
New in version 2015.5.0.

.INDENT 7.0
.TP
.B root
use root as top level directory (default: \(dq/\(dq)
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.modified httpd
salt \(aq*\(aq lowpkg.modified httpd postfix
salt \(aq*\(aq lowpkg.modified
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rpm_lowpkg.owner(*paths, **kwargs)
Return the name of the package that owns the file. Multiple file paths can
be passed. If a single path is passed, a string will be returned,
and if multiple paths are passed, a dictionary of file/package name pairs
will be returned.
.sp
If the file is not owned by a package, or is not present on the minion,
then an empty string will be returned for that path.
.INDENT 7.0
.TP
.B root
use root as top level directory (default: \(dq/\(dq)
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.owner /usr/bin/apachectl
salt \(aq*\(aq lowpkg.owner /usr/bin/apachectl /etc/httpd/conf/httpd.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rpm_lowpkg.verify(*packages, **kwargs)
Runs an rpm \-Va on a system, and returns the results in a dict
.INDENT 7.0
.TP
.B root
use root as top level directory (default: \(dq/\(dq)
.UNINDENT
.sp
Files with an attribute of config, doc, ghost, license or readme in the
package header can be ignored using the \fBignore_types\fP keyword argument
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lowpkg.verify
salt \(aq*\(aq lowpkg.verify httpd
salt \(aq*\(aq lowpkg.verify httpd postfix
salt \(aq*\(aq lowpkg.verify httpd postfix ignore_types=[\(aqconfig\(aq,\(aqdoc\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rpm_lowpkg.version_cmp(ver1, ver2, ignore_epoch=False)
New in version 2015.8.9.

.sp
Do a cmp\-style comparison on two packages. Return \-1 if ver1 < ver2, 0 if
ver1 == ver2, and 1 if ver1 > ver2. Return None if there was a problem
making the comparison.
.INDENT 7.0
.TP
.B ignore_epoch
False
Set to \fBTrue\fP to ignore the epoch when comparing versions
.sp
New in version 2015.8.10,2016.3.2.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version_cmp \(aq0.2\-001\(aq \(aq0.2.0.1\-002\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.rpmbuild_pkgbuild
.sp
RPM Package builder system
.sp
New in version 2015.8.0.

.sp
This system allows for all of the components to build rpms safely in chrooted
environments. This also provides a function to generate yum repositories
.sp
This module implements the pkgbuild interface
.INDENT 0.0
.TP
.B salt.modules.rpmbuild_pkgbuild.build(runas, tgt, dest_dir, spec, sources, deps, env, template, saltenv=\(aqbase\(aq, log_dir=\(aq/var/log/salt/pkgbuild\(aq)
Given the package destination directory, the spec file source and package
sources, use mock to safely build the rpm defined in the spec file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgbuild.build mock epel\-7\-x86_64 /var/www/html
            https://raw.githubusercontent.com/saltstack/libnacl/master/pkg/rpm/python\-libnacl.spec
            https://pypi.python.org/packages/source/l/libnacl/libnacl\-1.3.5.tar.gz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example command should build the libnacl package for rhel 7 using user
mock and place it in /var/www/html/ on the minion
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rpmbuild_pkgbuild.make_repo(repodir, keyid=None, env=None, use_passphrase=False, gnupghome=\(aq/etc/salt/gpgkeys\(aq, runas=\(aqroot\(aq, timeout=15.0)
Make a package repository and optionally sign packages present
.sp
Given the repodir, create a \fByum\fP repository out of the rpms therein
and optionally sign it and packages present, the name is directory to
turn into a repo. This state is best used with onchanges linked to
your package building states.
.INDENT 7.0
.TP
.B repodir
The directory to find packages that will be in the repository.
.TP
.B keyid
Changed in version 2016.3.0.

.sp
Optional Key ID to use in signing packages and repository.
Utilizes Public and Private keys associated with keyid which have
been loaded into the minion\(aqs Pillar data.
.sp
For example, contents from a Pillar data file with named Public
and Private keys as follows:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
gpg_pkg_priv_key: |
  \-\-\-\-\-BEGIN PGP PRIVATE KEY BLOCK\-\-\-\-\-
  Version: GnuPG v1

  lQO+BFciIfQBCADAPCtzx7I5Rl32escCMZsPzaEKWe7bIX1em4KCKkBoX47IG54b
  w82PCE8Y1jF/9Uk2m3RKVWp3YcLlc7Ap3gj6VO4ysvVz28UbnhPxsIkOlf2cq8qc
  .
  .
  Ebe+8JCQTwqSXPRTzXmy/b5WXDeM79CkLWvuGpXFor76D+ECMRPv/rawukEcNptn
  R5OmgHqvydEnO4pWbn8JzQO9YX/Us0SMHBVzLC8eIi5ZIopzalvX
  =JvW8
  \-\-\-\-\-END PGP PRIVATE KEY BLOCK\-\-\-\-\-

gpg_pkg_priv_keyname: gpg_pkg_key.pem

gpg_pkg_pub_key: |
  \-\-\-\-\-BEGIN PGP PUBLIC KEY BLOCK\-\-\-\-\-
  Version: GnuPG v1

  mQENBFciIfQBCADAPCtzx7I5Rl32escCMZsPzaEKWe7bIX1em4KCKkBoX47IG54b
  w82PCE8Y1jF/9Uk2m3RKVWp3YcLlc7Ap3gj6VO4ysvVz28UbnhPxsIkOlf2cq8qc
  .
  .
  bYP7t5iwJmQzRMyFInYRt77wkJBPCpJc9FPNebL9vlZcN4zv0KQta+4alcWivvoP
  4QIxE+/+trC6QRw2m2dHk6aAeq/J0Sc7ilZufwnNA71hf9SzRIwcFXMsLx4iLlki
  inNqW9c=
  =s1CX
  \-\-\-\-\-END PGP PUBLIC KEY BLOCK\-\-\-\-\-

gpg_pkg_pub_keyname: gpg_pkg_key.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B env
Changed in version 2016.3.0.

.sp
A dictionary of environment variables to be utilized in creating the
repository.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This parameter is not used for making \fByum\fP repositories.
.UNINDENT
.UNINDENT
.TP
.B use_passphrase
False
New in version 2016.3.0.

.sp
Use a passphrase with the signing key presented in \fBkeyid\fP\&.
Passphrase is received from Pillar data which could be passed on the
command line with \fBpillar\fP parameter.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pillar=\(aq{ \(dqgpg_passphrase\(dq : \(dqmy_passphrase\(dq }\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3001.1.

.sp
RHEL 8 and above leverages gpg\-agent and gpg\-preset\-passphrase for
caching keys, etc.
.TP
.B gnupghome
/etc/salt/gpgkeys
New in version 2016.3.0.

.sp
Location where GPG related files are stored, used with \fBkeyid\fP\&.
.TP
.B runas
root
New in version 2016.3.0.

.sp
User to create the repository as, and optionally sign packages.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Ensure the user has correct permissions to any files and
directories which are to be utilized.
.UNINDENT
.UNINDENT
.TP
.B timeout
15.0
New in version 2016.3.4.

.sp
Timeout in seconds to wait for the prompt for inputting the passphrase.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgbuild.make_repo /var/www/html/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rpmbuild_pkgbuild.make_src_pkg(dest_dir, spec, sources, env=None, template=None, saltenv=\(aqbase\(aq, runas=\(aqroot\(aq)
Create a source rpm from the given spec file and sources
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkgbuild.make_src_pkg /var/www/html/
        https://raw.githubusercontent.com/saltstack/libnacl/master/pkg/rpm/python\-libnacl.spec
        https://pypi.python.org/packages/source/l/libnacl/libnacl\-1.3.5.tar.gz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example command should build the libnacl SOURCE package and place it in
/var/www/html/ on the minion
.sp
Changed in version 2017.7.0.

.INDENT 7.0
.TP
.B dest_dir
The directory on the minion to place the built package(s)
.TP
.B spec
The location of the spec file (used for rpms)
.TP
.B sources
The list of package sources
.TP
.B env
A dictionary of environment variables to be set prior to execution.
.TP
.B template
Run the spec file through a templating engine
Optional argument, allows for no templating engine used to be
if none is desired.
.TP
.B saltenv
The saltenv to use for files downloaded from the salt filesever
.TP
.B runas
The user to run the build process as
.sp
New in version 2018.3.3.

.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
using SHA256 as digest and minimum level dist el6
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.rsync
.sp
Wrapper for rsync
.sp
New in version 2014.1.0.

.sp
This data can also be passed into \fI\%pillar\fP\&.
Options passed into opts will overwrite options passed into pillar.
.INDENT 0.0
.TP
.B salt.modules.rsync.config(conf_path=\(aq/etc/rsyncd.conf\(aq)
Changed in version 2016.3.0: Return data now contains just the contents of the rsyncd.conf as a
string, instead of a dictionary as returned from \fI\%cmd.run_all\fP\&.

.sp
Returns the contents of the rsync config file
.INDENT 7.0
.TP
.B conf_path
/etc/rsyncd.conf
Path to the config file
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rsync.config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rsync.rsync(src, dst, delete=False, force=False, update=False, passwordfile=None, exclude=None, excludefrom=None, dryrun=False, rsh=None, additional_opts=None, saltenv=\(aqbase\(aq)
Changed in version 2016.3.0: Return data now contains just the output of the rsync command, instead
of a dictionary as returned from \fI\%cmd.run_all\fP\&.

.sp
Rsync files from src to dst
.INDENT 7.0
.TP
.B src
The source location where files will be rsynced from.
.TP
.B dst
The destination location where files will be rsynced to.
.TP
.B delete
False
Whether to enable the rsync \fI\-\-delete\fP flag, which
will delete extraneous files from dest dirs
.TP
.B force
False
Whether to enable the rsync \fI\-\-force\fP flag, which
will force deletion of dirs even if not empty.
.TP
.B update
False
Whether to enable the rsync \fI\-\-update\fP flag, which
forces rsync to skip any files which exist on the
destination and have a modified time that is newer
than the source file.
.TP
.B passwordfile
A file that contains a password for accessing an
rsync daemon.  The file should contain just the
password.
.TP
.B exclude
Whether to enable the rsync \fI\-\-exclude\fP flag, which
will exclude files matching a PATTERN.
.TP
.B excludefrom
Whether to enable the rsync \fI\-\-excludefrom\fP flag, which
will read exclude patterns from a file.
.TP
.B dryrun
False
Whether to enable the rsync \fI\-\-dry\-run\fP flag, which
will perform a trial run with no changes made.
.TP
.B rsh
Whether to enable the rsync \fI\-\-rsh\fP flag, to
specify the remote shell to use.
.TP
.B additional_opts
Any additional rsync options, should be specified as a list.
.TP
.B saltenv
Specify a salt fileserver environment to be used.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rsync.rsync /path/to/src /path/to/dest delete=True update=True passwordfile=/etc/pass.crt exclude=exclude/dir
salt \(aq*\(aq rsync.rsync /path/to/src delete=True excludefrom=/xx.ini
salt \(aq*\(aq rsync.rsync /path/to/src delete=True exclude=\(aq[exclude1/dir,exclude2/dir]\(aq additional_opts=\(aq[\(dq\-\-partial\(dq, \(dq\-\-bwlimit=5000\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rsync.version()
Changed in version 2016.3.0: Return data now contains just the version number as a string, instead
of a dictionary as returned from \fI\%cmd.run_all\fP\&.

.sp
Returns rsync version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rsync.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.runit
.sp
runit service module
(\fI\%http://smarden.org/runit\fP)
.sp
This module is compatible with the \fI\%service\fP states,
so it can be used to maintain services using the \fBprovider\fP argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myservice:
  service:
    \- running
    \- provider: runit
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Provides virtual \fIservice\fP module on systems using runit as init.
.sp
Service management rules (\fIsv\fP command):
.INDENT 0.0
.INDENT 3.5
service $n is ENABLED   if file SERVICE_DIR/$n/run exists
service $n is AVAILABLE if ENABLED or if file AVAIL_SVR_DIR/$n/run exists
service $n is DISABLED  if AVAILABLE but not ENABLED
.sp
SERVICE_DIR/$n is normally a symlink to a AVAIL_SVR_DIR/$n folder
.UNINDENT
.UNINDENT
.sp
Service auto\-start/stop mechanism:
.INDENT 0.0
.INDENT 3.5
\fIsv\fP (auto)starts/stops service as soon as SERVICE_DIR/<service> is
created/deleted, both on service creation or a boot time.
.sp
autostart feature is disabled if file SERVICE_DIR/<n>/down exists. This
does not affect the current\(aqs service status (if already running) nor
manual service management.
.UNINDENT
.UNINDENT
.sp
Service\(aqs alias:
.INDENT 0.0
.INDENT 3.5
Service \fIsva\fP is an alias of service \fIsvc\fP when \fIAVAIL_SVR_DIR/sva\fP symlinks
to folder \fIAVAIL_SVR_DIR/svc\fP\&. \fIsvc\fP can\(aqt be enabled if it is already
enabled through an alias already enabled, since \fIsv\fP files are stored in
folder \fISERVICE_DIR/svc/\fP\&.
.sp
XBPS package management uses a service\(aqs alias to provides service
alternative(s), such as chrony and openntpd both aliased to ntpd.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.add_svc_avail_path(path)
Add a path that may contain available services.
Return \fBTrue\fP if added (or already present), \fBFalse\fP on error.
.INDENT 7.0
.TP
.B path
directory to add to AVAIL_SVR_DIRS
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.available(name)
Returns \fBTrue\fP if the specified service is available, otherwise returns
\fBFalse\fP\&.
.INDENT 7.0
.TP
.B name
the service\(aqs name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq runit.available <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.disable(name, stop=False, **kwargs)
Don\(aqt start service \fBname\fP at boot
Returns \fBTrue\fP if operation is successful
.INDENT 7.0
.TP
.B name
the service\(aqs name
.TP
.B stop
if True, also stops the service
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disable <name> [stop=True]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.disabled(name)
Return \fBTrue\fP if the named service is disabled, \fBFalse\fP  otherwise
.INDENT 7.0
.TP
.B name
the service\(aqs name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.enable(name, start=False, **kwargs)
Start service \fBname\fP at boot.
Returns \fBTrue\fP if operation is successful
.INDENT 7.0
.TP
.B name
the service\(aqs name
.TP
.B start
False
If \fBTrue\fP, start the service once enabled.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enable <name> [start=True]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.enabled(name)
Return \fBTrue\fP if the named service is enabled, \fBFalse\fP otherwise
.INDENT 7.0
.TP
.B name
the service\(aqs name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.full_restart(name)
Calls runit.restart()
.INDENT 7.0
.TP
.B name
the service\(aqs name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq runit.full_restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.get_all()
Return a list of all available services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq runit.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.get_disabled()
Return a list of all disabled services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_disabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.get_enabled()
Return a list of all enabled services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.get_svc_alias()
Returns the list of service\(aqs name that are aliased and their alias path(s)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.get_svc_avail_path()
Return list of paths that may contain available services
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.get_svc_broken_path(name=\(aq*\(aq)
Return list of broken path(s) in SERVICE_DIR that match \fBname\fP
.sp
A path is broken if it is a broken symlink or can not be a runit service
.INDENT 7.0
.TP
.B name
a glob for service name. default is \(aq*\(aq
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq runit.get_svc_broken_path <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.missing(name)
The inverse of runit.available.
Returns \fBTrue\fP if the specified service is not available, otherwise returns
\fBFalse\fP\&.
.INDENT 7.0
.TP
.B name
the service\(aqs name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq runit.missing <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.reload_(name)
Reload service
.INDENT 7.0
.TP
.B name
the service\(aqs name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq runit.reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.remove(name)
Remove the service <name> from system.
Returns \fBTrue\fP if operation is successful.
The service will be also stopped.
.INDENT 7.0
.TP
.B name
the service\(aqs name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.remove <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.restart(name)
Restart service
.INDENT 7.0
.TP
.B name
the service\(aqs name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq runit.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.show(name)
Show properties of one or more units/jobs or the manager
.INDENT 7.0
.TP
.B name
the service\(aqs name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.show <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.start(name)
Start service
.INDENT 7.0
.TP
.B name
the service\(aqs name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq runit.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.status(name, sig=None)
Return \fBTrue\fP if service is running
.INDENT 7.0
.TP
.B name
the service\(aqs name
.TP
.B sig
signature to identify with ps
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq runit.status <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.status_autostart(name)
Return \fBTrue\fP if service <name> is autostarted by sv
(file $service_folder/down does not exist)
NB: return \fBFalse\fP if the service is not enabled.
.INDENT 7.0
.TP
.B name
the service\(aqs name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq runit.status_autostart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.runit.stop(name)
Stop service
.INDENT 7.0
.TP
.B name
the service\(aqs name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq runit.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.rvm
.sp
Manage ruby installations and gemsets with RVM, the Ruby Version Manager.
.INDENT 0.0
.TP
.B salt.modules.rvm.do(ruby, command, runas=None, cwd=None, env=None)
Execute a command in an RVM controlled environment.
.INDENT 7.0
.TP
.B ruby
Which ruby to use
.TP
.B command
The rvm command to execute
.TP
.B runas
The user under which to run rvm. If not specified, then rvm will be run
as the user under which Salt is running.
.TP
.B cwd
The directory from which to run the rvm command. Defaults to the user\(aqs
home directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.do 2.0.0 <command>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rvm.gemset_copy(source, destination, runas=None)
Copy all gems from one gemset to another.
.INDENT 7.0
.TP
.B source
The name of the gemset to copy, complete with ruby version
.TP
.B destination
The destination gemset
.TP
.B runas
The user under which to run rvm. If not specified, then rvm will be run
as the user under which Salt is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.gemset_copy foobar bazquo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rvm.gemset_create(ruby, gemset, runas=None)
Creates a gemset.
.INDENT 7.0
.TP
.B ruby
The ruby version for which to create the gemset
.TP
.B gemset
The name of the gemset to create
.TP
.B runas
The user under which to run rvm. If not specified, then rvm will be run
as the user under which Salt is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.gemset_create 2.0.0 foobar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rvm.gemset_delete(ruby, gemset, runas=None)
Delete a gemset
.INDENT 7.0
.TP
.B ruby
The ruby version to which the gemset belongs
.TP
.B gemset
The gemset to delete
.TP
.B runas
The user under which to run rvm. If not specified, then rvm will be run
as the user under which Salt is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.gemset_delete 2.0.0 foobar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rvm.gemset_empty(ruby, gemset, runas=None)
Remove all gems from a gemset.
.INDENT 7.0
.TP
.B ruby
The ruby version to which the gemset belongs
.TP
.B gemset
The gemset to empty
.TP
.B runas
The user under which to run rvm. If not specified, then rvm will be run
as the user under which Salt is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.gemset_empty 2.0.0 foobar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rvm.gemset_list(ruby=\(aqdefault\(aq, runas=None)
List all gemsets for the given ruby.
.INDENT 7.0
.TP
.B ruby
default
The ruby version for which to list the gemsets
.TP
.B runas
The user under which to run rvm. If not specified, then rvm will be run
as the user under which Salt is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.gemset_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rvm.gemset_list_all(runas=None)
List all gemsets for all installed rubies.
.sp
Note that you must have set a default ruby before this can work.
.INDENT 7.0
.TP
.B runas
The user under which to run rvm. If not specified, then rvm will be run
as the user under which Salt is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.gemset_list_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rvm.get(version=\(aqstable\(aq, runas=None)
Update RVM
.INDENT 7.0
.TP
.B version
stable
Which version of RVM to install, (e.g. stable or head)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.get
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rvm.install(runas=None)
Install RVM system\-wide
.INDENT 7.0
.TP
.B runas
The user under which to run the rvm installer script. If not specified,
then it be run as the user under which Salt is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.install
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rvm.install_ruby(ruby, runas=None, opts=None, env=None)
Install a ruby implementation.
.INDENT 7.0
.TP
.B ruby
The version of ruby to install
.TP
.B runas
The user under which to run rvm. If not specified, then rvm will be run
as the user under which Salt is running.
.TP
.B env
Environment to set for the install command. Useful for exporting compilation
flags such as RUBY_CONFIGURE_OPTS
.TP
.B opts
List of options to pass to the RVM installer (ie \-C, \-\-patch, etc)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.install_ruby 1.9.3\-p385
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rvm.is_installed(runas=None)
Check if RVM is installed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.is_installed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rvm.list_(runas=None)
List all rvm\-installed rubies
.INDENT 7.0
.TP
.B runas
The user under which to run rvm. If not specified, then rvm will be run
as the user under which Salt is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rvm.reinstall_ruby(ruby, runas=None, env=None)
Reinstall a ruby implementation
.INDENT 7.0
.TP
.B ruby
The version of ruby to reinstall
.TP
.B runas
The user under which to run rvm. If not specified, then rvm will be run
as the user under which Salt is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.reinstall_ruby 1.9.3\-p385
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rvm.rubygems(ruby, version, runas=None)
Installs a specific rubygems version in the given ruby
.INDENT 7.0
.TP
.B ruby
The ruby for which to install rubygems
.TP
.B version
The version of rubygems to install, or \(aqremove\(aq to use the version that
ships with 1.9
.TP
.B runas
The user under which to run rvm. If not specified, then rvm will be run
as the user under which Salt is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.rubygems 2.0.0 1.8.24
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rvm.set_default(ruby, runas=None)
Set the default ruby
.INDENT 7.0
.TP
.B ruby
The version of ruby to make the default
.TP
.B runas
The user under which to run rvm. If not specified, then rvm will be run
as the user under which Salt is running.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.set_default 2.0.0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.rvm.wrapper(ruby_string, wrapper_prefix, runas=None, *binaries)
Install RVM wrapper scripts
.INDENT 7.0
.TP
.B ruby_string
Ruby/gemset to install wrappers for
.TP
.B wrapper_prefix
What to prepend to the name of the generated wrapper binaries
.TP
.B runas
The user under which to run rvm. If not specified, then rvm will be run
as the user under which Salt is running.
.TP
.B binaries
None
The names of the binaries to create wrappers for. When nothing is
given, wrappers for ruby, gem, rake, irb, rdoc, ri and testrb are
generated.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq rvm.wrapper <ruby_string> <wrapper_prefix>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.s3
.sp
Connection module for Amazon S3
.INDENT 0.0
.TP
.B configuration
This module accepts explicit s3 credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
\fI\%http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html\fP
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
s3.keyid: GKTADJGHEIQSXMKKRBJ08H
s3.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This is literally the pillar key \fBs3.keyid\fP or the config option \fBs3.keyid\fP,
not:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
s3:
  keyid: blah
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
A \fBservice_url\fP may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
s3.service_url: s3.amazonaws.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A \fBrole_arn\fP may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
s3.role_arn: arn:aws:iam::111111111111:role/my\-role\-to\-assume
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a \fBservice_url\fP is not specified, the default is \fBs3.amazonaws.com\fP\&. This
may appear in various documentation as an \(dqendpoint\(dq. A comprehensive list
for Amazon S3 may be found at:
.INDENT 7.0
.INDENT 3.5
\fI\%http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region\fP
.UNINDENT
.UNINDENT
.sp
The \fBservice_url\fP will form the basis for the final endpoint that is used to
query the service.
.sp
Path style can be enabled:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
s3.path_style: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This can be useful if you need to use Salt with a proxy for a S3 compatible storage.
.sp
You can use either HTTPS protocol or HTTP protocol:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
s3.https_enable: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
SSL verification may also be turned off in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
s3.verify_ssl: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is required if using S3 bucket names that contain a period, as
these will not match Amazon\(aqs S3 wildcard certificates. Certificate
verification is enabled by default.
.sp
AWS region may be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
s3.location: eu\-central\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Default is \fBus\-east\-1\fP\&.
.sp
This module should be usable to query other S3\-like services, such as
Eucalyptus.
.UNINDENT
.INDENT 0.0
.TP
.B depends
requests
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.s3.delete(bucket, path=None, action=None, key=None, keyid=None, service_url=None, verify_ssl=None, kms_keyid=None, location=None, role_arn=None, path_style=None, https_enable=None)
Delete a bucket, or delete an object from a bucket.
.sp
CLI Example to delete a bucket:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion s3.delete mybucket
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example to delete an object from a bucket:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion s3.delete mybucket remoteobject
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.s3.get(bucket=\(aq\(aq, path=\(aq\(aq, return_bin=False, action=None, local_file=None, key=None, keyid=None, service_url=None, verify_ssl=None, kms_keyid=None, location=None, role_arn=None, path_style=None, https_enable=None)
List the contents of a bucket, or return an object from a bucket. Set
return_bin to True in order to retrieve an object wholesale. Otherwise,
Salt will attempt to parse an XML response.
.sp
CLI Example to list buckets:
.INDENT 7.0
.INDENT 3.5
salt myminion s3.get
.UNINDENT
.UNINDENT
.sp
CLI Example to list the contents of a bucket:
.INDENT 7.0
.INDENT 3.5
salt myminion s3.get mybucket
.UNINDENT
.UNINDENT
.sp
CLI Example to return the binary contents of an object:
.INDENT 7.0
.INDENT 3.5
salt myminion s3.get mybucket myfile.png return_bin=True
.UNINDENT
.UNINDENT
.sp
CLI Example to save the binary contents of an object to a local file:
.INDENT 7.0
.INDENT 3.5
salt myminion s3.get mybucket myfile.png local_file=/tmp/myfile.png
.UNINDENT
.UNINDENT
.sp
It is also possible to perform an action on a bucket. Currently, S3
supports the following actions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
acl
cors
lifecycle
policy
location
logging
notification
tagging
versions
requestPayment
versioning
website
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To perform an action on a bucket:
.INDENT 7.0
.INDENT 3.5
salt myminion s3.get mybucket myfile.png action=acl
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.s3.head(bucket, path=\(aq\(aq, key=None, keyid=None, service_url=None, verify_ssl=None, kms_keyid=None, location=None, role_arn=None, path_style=None, https_enable=None)
Return the metadata for a bucket, or an object in a bucket.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion s3.head mybucket
salt myminion s3.head mybucket myfile.png
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.s3.put(bucket, path=None, return_bin=False, action=None, local_file=None, key=None, keyid=None, service_url=None, verify_ssl=None, kms_keyid=None, location=None, role_arn=None, path_style=None, https_enable=None)
Create a new bucket, or upload an object to a bucket.
.sp
CLI Example to create a bucket:
.INDENT 7.0
.INDENT 3.5
salt myminion s3.put mybucket
.UNINDENT
.UNINDENT
.sp
CLI Example to upload an object to a bucket:
.INDENT 7.0
.INDENT 3.5
salt myminion s3.put mybucket remotepath local_file=/path/to/file
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.s6
.sp
s6 service module
.sp
This module is compatible with the \fI\%service\fP states,
so it can be used to maintain services using the \fBprovider\fP argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myservice:
  service:
    \- running
    \- provider: s6
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that the \fBenabled\fP argument is not available with this provider.
.INDENT 0.0
.TP
.B codeauthor
Marek Skrobacki <\fI\%skrobul@skrobul.com\fP>
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.s6.available(name)
Returns \fBTrue\fP if the specified service is available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq s6.available foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.s6.full_restart(name)
Calls s6.restart() function
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq s6.full_restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.s6.get_all()
Return a list of all available services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq s6.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.s6.missing(name)
The inverse of s6.available.
Returns \fBTrue\fP if the specified service is not available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq s6.missing foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.s6.reload_(name)
Send a HUP to service via s6
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq s6.reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.s6.restart(name)
Restart service via s6. This will stop/start service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq s6.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.s6.start(name)
Starts service via s6
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq s6.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.s6.status(name, sig=None)
Return the status for a service via s6, return pid if running
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq s6.status <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.s6.stop(name)
Stops service via s6
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq s6.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.s6.term(name)
Send a TERM to service via s6
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq s6.term <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.salt_proxy
.sp
Salt proxy module
.sp
New in version 2015.8.3.

.sp
Module to deploy and manage salt\-proxy processes
on a minion.
.INDENT 0.0
.TP
.B salt.modules.salt_proxy.configure_proxy(proxyname, start=True)
Create the salt proxy file and start the proxy process
if required
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBproxyname\fP \-\- Name to be used for this proxy (should match entries in pillar)
.IP \(bu 2
\fBstart\fP \-\- Boolean indicating if the process should be started
default = True
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt deviceminion salt_proxy.configure_proxy p8000
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.salt_proxy.is_running(proxyname)
Check if the salt\-proxy process associated
with this proxy (name) is running.
.sp
Returns True if the process is running
False otherwise
.INDENT 7.0
.TP
.B Parameters
\fBproxyname\fP \-\- String name of the proxy (p8000 for example)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt deviceminion salt_proxy.is_running p8000
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.salt_version
.sp
Access Salt\(aqs elemental release code\-names.
.sp
New in version 3000.

.sp
Salt\(aqs feature release schedule is based on the Periodic Table, as described
in the \fI\%Version Numbers\fP documentation.
.sp
When a feature was added (or removed) in a specific release, it can be
difficult to build out future\-proof functionality that is dependent on
a naming scheme that moves.
.sp
For example, a state syntax needs to change to support an option that will be
removed in the future, but there are many Minion versions in use across an
infrastructure. It would be handy to use some Jinja syntax to check for these
instances to perform one state syntax over another.
.sp
A simple example might be something like the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{# a boolean check #}
{% set option_deprecated = salt[\(aqsalt_version.less_than\(aq](\(dqSodium\(dq) %}

{% if option_deprecated %}
  <use old syntax>
{% else %}
  <use new syntax>
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.salt_version.equal(name)
Returns a boolean (True) if the minion\(aqs current version
code name matches the named version.
.INDENT 7.0
.TP
.B name
The release code name to check the version against.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq salt_version.equal \(aqOxygen\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.salt_version.get_release_number(name)
Returns the release number of a given release code name in a
\fBMAJOR.PATCH\fP format (for Salt versions < 3000) or \fBMAJOR\fP for newer Salt versions.
.sp
If the release name has not been given an assigned release number, the
function returns a string. If the release cannot be found, it returns
\fBNone\fP\&.
.INDENT 7.0
.TP
.B name
The release code name for which to find a release number.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq salt_version.get_release_number \(aqOxygen\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.salt_version.greater_than(name)
Returns a boolean (True) if the minion\(aqs current
version code name is greater than the named version.
.INDENT 7.0
.TP
.B name
The release code name to check the version against.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq salt_version.greater_than \(aqOxygen\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.salt_version.less_than(name)
Returns a boolean (True) if the minion\(aqs current
version code name is less than the named version.
.INDENT 7.0
.TP
.B name
The release code name to check the version against.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq salt_version.less_than \(aqOxygen\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.saltcheck
.sp
A module for testing the logic of states and highstates on salt minions
.INDENT 0.0
.TP
.B codeauthor
William Cannon <\fI\%william.cannon@gmail.com\fP>
.TP
.B maturity
new
.UNINDENT
.sp
Saltcheck provides unittest like functionality requiring only the knowledge of
salt module execution and yaml. Saltcheck uses salt modules to return data, then
runs an assertion against that return. This allows for testing with all the
features included in salt modules.
.sp
In order to run state and highstate saltcheck tests, a sub\-folder in the state directory
must be created and named \fBsaltcheck\-tests\fP\&. Tests for a state should be created in files
ending in \fB*.tst\fP and placed in the \fBsaltcheck\-tests\fP folder. \fBtst\fP files are run
through the salt rendering system, enabling tests to be written in yaml (or renderer of choice),
and include jinja, as well as the usual grain and pillar information. Like states, multiple tests can
be specified in a \fBtst\fP file. Multiple \fBtst\fP files can be created in the \fBsaltcheck\-tests\fP
folder, and should be named the same as the associated state. The \fBid\fP of a test works in the
same manner as in salt state files and should be unique and descriptive.
.sp
New in version 3000: The \fBsaltcheck\-tests\fP folder can be customized using the \fBsaltcheck_test_location\fP minion
configuration setting.  This setting is a relative path from the formula\(aqs \fBsalt://\fP path
to the test files.

.SS Usage
.sp
Example Default file system layout:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/srv/salt/apache/
    init.sls
    config.sls
    saltcheck\-tests/
        init.tst
        config.tst
        deployment_validation.tst
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternative example file system layout with custom saltcheck_test_location:
.SS Minion configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
saltcheck_test_location: tests/integration/saltcheck
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Filesystem layout:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/srv/salt/apache/
    init.sls
    config.sls
    tests/integration/saltcheck/
        init.tst
        config.tst
        deployment_validation.tst
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Tests can be run for each state by name, for all \fBapache/saltcheck/*.tst\fP
files, or for all states assigned to the minion in top.sls. Tests may also be
created with no associated state. These tests will be run through the use of
\fBsaltcheck.run_state_tests\fP, but will not be automatically run by
\fBsaltcheck.run_highstate_tests\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltcheck.run_state_tests apache,apache.config
salt \(aq*\(aq saltcheck.run_state_tests apache check_all=True
salt \(aq*\(aq saltcheck.run_highstate_tests
salt \(aq*\(aq saltcheck.run_state_tests apache.deployment_validation
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Saltcheck Keywords
.INDENT 0.0
.TP
\fBmodule_and_function:\fP
(str) This is the salt module which will be run locally,
the same as \fBsalt\-call \-\-local <module>\fP\&. The \fBsaltcheck.state_apply\fP module name is
special as it bypasses the local option in order to resolve state names when run in
a master/minion environment.
.TP
\fBargs:\fP
(list) Optional arguments passed to the salt module
.TP
\fBkwargs:\fP
(dict) Optional keyword arguments to be passed to the salt module
.TP
\fBassertion:\fP
(str) One of the supported assertions and required except for \fBsaltcheck.state_apply\fP
Tests which fail the assertion and expected_return, cause saltcheck to exit which a non\-zero exit code.
.TP
\fBexpected_return:\fP
(str) Required except by \fBassertEmpty\fP, \fBassertNotEmpty\fP, \fBassertTrue\fP,
\fBassertFalse\fP\&. The return of module_and_function is compared to this value in the assertion.
.TP
\fBassertion_section:\fP
(str) Optional keyword used to parse the module_and_function return. If a salt module
returns a dictionary as a result, the \fBassertion_section\fP value is used to lookup a specific value
in that return for the assertion comparison.
.TP
\fBassertion_section_delimiter:\fP
(str) Optional delimiter to use when splitting a nested structure.
Defaults to \(aq:\(aq
.TP
\fBprint_result:\fP
(bool) Optional keyword to show results in the \fBassertEqual\fP, \fBassertNotEqual\fP,
\fBassertIn\fP, and \fBassertNotIn\fP output. Defaults to True.
.TP
\fBoutput_details:\fP
(bool) Optional keyword to display \fBmodule_and_function\fP, \fBargs\fP, \fBassertion_section\fP,
and assertion results text in the output. If print_result is False, assertion results will be hidden.
This is a per test setting, but can be set globally for all tests by adding \fBsaltcheck_output_details: True\fP
in the minion configuration file.
Defaults to False
.TP
\fBpillar_data:\fP
(dict) Optional keyword for passing in pillar data. Intended for use in potential test
setup or teardown with the \fBsaltcheck.state_apply\fP function.
.TP
\fBskip:\fP
(bool) Optional keyword to skip running the individual test
.UNINDENT
.sp
New in version 3000: Multiple assertions can be run against the output of a single \fBmodule_and_function\fP call. The \fBassertion\fP,
\fBexpected_return\fP, \fBassertion_section\fP, and \fBassertion_section_delimiter\fP keys can be placed in a list under an
\fBassertions\fP key. See the multiple assertions example below.

.SS Sample Cases/Examples
.SS Basic Example
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
echo_test_hello:
  module_and_function: test.echo
  args:
    \- \(dqhello\(dq
  kwargs:
  assertion: assertEqual
  expected_return:  \(aqhello\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Example with jinja
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% for package in [\(dqapache2\(dq, \(dqopenssh\(dq] %}
{# or another example #}
{# for package in salt[\(aqpillar.get\(aq](\(dqpackages\(dq) #}
test_{{ package }}_latest:
  module_and_function: pkg.upgrade_available
  args:
    \- {{ package }}
  assertion: assertFalse
{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Example with setup state including pillar
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
setup_test_environment:
  module_and_function: saltcheck.state_apply
  args:
    \- common
  pillar_data:
    data: value

verify_vim:
  module_and_function: pkg.version
  args:
    \- vim
  assertion: assertNotEmpty
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Example with jinja
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% for package in [\(dqapache2\(dq, \(dqopenssh\(dq] %}
{# or another example #}
{# for package in salt[\(aqpillar.get\(aq](\(dqpackages\(dq) #}
test_{{ package }}_latest:
  module_and_function: pkg.upgrade_available
  args:
    \- {{ package }}
  assertion: assertFalse
{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Example with setup state including pillar
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
setup_test_environment:
  module_and_function: saltcheck.state_apply
  args:
    \- common
  pillar\-data:
    data: value

verify_vim:
  module_and_function: pkg.version
  args:
    \- vim
  assertion: assertNotEmpty
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Example with skip
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
package_latest:
  module_and_function: pkg.upgrade_available
  args:
    \- apache2
  assertion: assertFalse
  skip: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Example with assertion_section
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
validate_shell:
  module_and_function: user.info
  args:
    \- root
  assertion: assertEqual
  expected_return: /bin/bash
  assertion_section: shell
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Example with a nested assertion_section
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
validate_smb_signing:
  module_and_function: lgpo.get
  args:
    \- \(aqMachine\(aq
  kwargs:
    return_full_policy_names: True
  assertion: assertEqual
  expected_return: Enabled
  assertion_section: \(aqComputer Configuration|Microsoft network client: Digitally sign communications (always)\(aq
  assertion_section_delimiter: \(aq|\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Example suppressing print results
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
validate_env_nameNode:
  module_and_function: hadoop.dfs
  args:
    \- text
    \- /oozie/common/env.properties
  expected_return: nameNode = hdfs://nameservice2
  assertion: assertNotIn
  print_result: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Example with multiple assertions and output_details
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
multiple_validations:
  module_and_function: network.netstat
  assertions:
    \- assertion: assertEqual
      assertion_section: \(dq0:program\(dq
      expected_return: \(dqsystemd\-resolve\(dq
    \- assertion: assertEqual
      assertion_section: \(dq0:proto\(dq
      expected_return: \(dqudp\(dq
  output_details: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Supported assertions
.INDENT 0.0
.IP \(bu 2
assertEqual
.IP \(bu 2
assertNotEqual
.IP \(bu 2
assertTrue
.IP \(bu 2
assertFalse
.IP \(bu 2
assertIn
.IP \(bu 2
assertNotIn
.IP \(bu 2
assertGreater
.IP \(bu 2
assertGreaterEqual
.IP \(bu 2
assertLess
.IP \(bu 2
assertLessEqual
.IP \(bu 2
assertEmpty
.IP \(bu 2
assertNotEmpty
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
The saltcheck.state_apply function is an alias for
\fBstate.apply\fP\&. If using the
\fI\%ACL system\fP \fBsaltcheck.*\fP might provide more capability
than intended if only \fBsaltcheck.run_state_tests\fP and
\fBsaltcheck.run_highstate_tests\fP are needed.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.saltcheck.SaltCheck(saltenv=\(aqbase\(aq)
This class validates and runs the saltchecks
.INDENT 7.0
.TP
.B run_test(test_dict)
Run a single saltcheck test
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.saltcheck.StateTestLoader(saltenv=\(aqbase\(aq)
Class loads in test files for a state
e.g. state_dir/saltcheck\-tests/[1.tst, 2.tst, 3.tst]
.INDENT 7.0
.TP
.B add_test_files_for_sls(sls_name, check_all=False)
Detects states used, caches needed files, and adds to test list
.UNINDENT
.INDENT 7.0
.TP
.B load_test_suite()
Load tests either from one file, or a set of files
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltcheck.parallel_scheck(data)
triggers salt\-call in parallel
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltcheck.report_highstate_tests(saltenv=None)
Report on tests for states assigned to the minion through highstate.
Quits with the exit code for the number of missing tests.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltcheck.report_highstate_tests
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltcheck.run_highstate_tests(saltenv=None, only_fails=False, junit=False)
Execute all tests for states assigned to the minion through highstate and return results
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- optional saltenv. Defaults to base
.IP \(bu 2
\fBonly_fails\fP (\fI\%bool\fP) \-\- boolean to only print failure results
.IP \(bu 2
\fBjunit\fP (\fI\%bool\fP) \-\- boolean to print results in junit format
\&.. versionadded:: 3007.0
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltcheck.run_highstate_tests
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltcheck.run_state_tests(state, saltenv=None, check_all=False, only_fails=False, junit=False)
Execute tests for a salt state and return results
Nested states will also be tested
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstate\fP (\fI\%str\fP) \-\- state name for which to run associated .tst test files
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- optional saltenv. Defaults to base
.IP \(bu 2
\fBcheck_all\fP (\fI\%bool\fP) \-\- boolean to run all tests in state/saltcheck\-tests directory
.IP \(bu 2
\fBonly_fails\fP (\fI\%bool\fP) \-\- boolean to only print failure results
.IP \(bu 2
\fBjunit\fP (\fI\%bool\fP) \-\- boolean to print results in junit format
\&.. versionadded:: 3007.0
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltcheck.run_state_tests postfix,common
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Tests will be run in parallel by adding \(dqsaltcheck_parallel: True\(dq in minion config.
When enabled, saltcheck will use up to the number of cores detected. This can be limited
by setting the \(dqsaltcheck_processes\(dq value to an integer to set the maximum number
of parallel processes.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltcheck.run_state_tests_ssh(state, saltenv=None, check_all=False, only_fails=False, junit=False)
This function is an alias of \fBrun_state_tests\fP\&.
.INDENT 7.0
.INDENT 3.5
Execute tests for a salt state and return results
Nested states will also be tested
.INDENT 0.0
.TP
.B param str state
state name for which to run associated .tst test files
.TP
.B param str saltenv
optional saltenv. Defaults to base
.TP
.B param bool check_all
boolean to run all tests in state/saltcheck\-tests directory
.TP
.B param bool only_fails
boolean to only print failure results
.TP
.B param bool junit
boolean to print results in junit format
\&.. versionadded:: 3007.0
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltcheck.run_state_tests postfix,common
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Tests will be run in parallel by adding \(dqsaltcheck_parallel: True\(dq in minion config.
When enabled, saltcheck will use up to the number of cores detected. This can be limited
by setting the \(dqsaltcheck_processes\(dq value to an integer to set the maximum number
of parallel processes.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltcheck.run_test(**kwargs)
Execute one saltcheck test and return result
.INDENT 7.0
.TP
.B Parameters
\fBtest\fP (\fIkeyword arg\fP) \-\-
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltcheck.run_test
    test=\(aq{\(dqmodule_and_function\(dq: \(dqtest.echo\(dq,
           \(dqassertion\(dq: \(dqassertEqual\(dq,
           \(dqexpected_return\(dq: \(dqThis works!\(dq,
           \(dqargs\(dq:[\(dqThis works!\(dq] }\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltcheck.state_apply(state_name, **kwargs)
Runs \fBstate.apply\fP with given options to set up test data.
Intended to be used for optional test setup or teardown
.sp
Reference the \fBstate.apply\fP module documentation for arguments and usage options
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltcheck.state_apply postfix
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.saltcloudmod
.sp
Control a salt cloud system
.INDENT 0.0
.TP
.B salt.modules.saltcloudmod.create(name, profile)
Create the named vm
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <minion\-id> saltcloud.create webserver rackspace_centos_512
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.saltutil
.sp
The Saltutil module is used to manage the state of the salt minion itself. It
is used to manage minion modules as well as automate updates to the salt
minion.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
esky Python module for update functionality
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.clear_cache()
Forcibly removes all caches on a minion.
.sp
New in version 2014.7.0.

.sp
WARNING: The safest way to clear a minion cache is by first stopping
the minion and then deleting the cache files before restarting it.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.clear_cache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.clear_job_cache(hours=24)
Forcibly removes job cache folders and files on a minion.
.sp
New in version 2018.3.0.

.sp
WARNING: The safest way to clear a minion cache is by first stopping
the minion and then deleting the cache files before restarting it.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.clear_job_cache hours=12
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.cmd(tgt, fun, arg=(), timeout=None, tgt_type=\(aqglob\(aq, ret=\(aq\(aq, kwarg=None, ssh=False, **kwargs)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Assuming this minion is a master, execute a salt command
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.cmd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.cmd_iter(tgt, fun, arg=(), timeout=None, tgt_type=\(aqglob\(aq, ret=\(aq\(aq, kwarg=None, ssh=False, **kwargs)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Assuming this minion is a master, execute a salt command
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.cmd_iter
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.find_cached_job(jid)
Return the data for a specific cached job id. Note this only works if
cache_jobs has previously been set to True on the minion.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.find_cached_job <job id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.find_job(jid)
Return the data for a specific job id that is currently running.
.INDENT 7.0
.TP
.B jid
The job id to search for and return data.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.find_job <job id>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that the find_job function only returns job information when the job is still running. If
the job is currently running, the output looks something like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# salt my\-minion saltutil.find_job 20160503150049487736
my\-minion:
    \-\-\-\-\-\-\-\-\-\-
    arg:
        \- 30
    fun:
        test.sleep
    jid:
        20160503150049487736
    pid:
        9601
    ret:
    tgt:
        my\-minion
    tgt_type:
        glob
    user:
        root
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the job has already completed, the job cannot be found and therefore the function returns
an empty dictionary, which looks like this on the CLI:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# salt my\-minion saltutil.find_job 20160503150049487736
my\-minion:
    \-\-\-\-\-\-\-\-\-\-
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.is_running(fun)
If the named function is running return the data associated with it/them.
The argument can be a glob
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.is_running state.highstate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.kill_all_jobs()
Sends a kill signal (SIGKILL 9) to all currently running jobs
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.kill_all_jobs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.kill_job(jid)
Sends a kill signal (SIGKILL 9) to the named salt job\(aqs process
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.kill_job <job id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.list_extmods()
New in version 2017.7.0.

.sp
List Salt modules which have been synced externally
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.list_extmods
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.mmodule(saltenv, fun, *args, **kwargs)
Loads minion modules from an environment so that they can be used in pillars
for that environment
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.mmodule base test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.pillar_refresh(wait=False, timeout=30, clean_cache=True)
This function is an alias of \fBrefresh_pillar\fP\&.
.INDENT 7.0
.INDENT 3.5
Signal the minion to refresh the in\-memory pillar data. See \fI\%In\-Memory Pillar Data vs. On\-Demand Pillar Data\fP\&.
.INDENT 0.0
.TP
.B param wait
Wait for pillar refresh to complete, defaults to False.
.TP
.B type wait
bool, optional
.TP
.B param timeout
How long to wait in seconds, only used when wait is True, defaults to 30.
.TP
.B type timeout
int, optional
.TP
.B param clean_cache
Clean the pillar cache, only used when \fIpillar_cache\fP is True. Defaults to True
.TP
.B type clean_cache
bool, optional
\&.. versionadded:: 3005
.TP
.B return
Boolean status, True when the pillar_refresh event was fired successfully.
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.refresh_pillar
salt \(aq*\(aq saltutil.refresh_pillar wait=True timeout=60
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.refresh_beacons()
Signal the minion to refresh the beacons.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.refresh_beacons
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.refresh_grains(**kwargs)
New in version 2016.3.6,2016.11.4,2017.7.0.

.sp
Refresh the minion\(aqs grains without syncing custom grains modules from
\fBsalt://_grains\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The available execution modules will be reloaded as part of this
proceess, as grains can affect which modules are available.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B refresh_pillar
True
Set to \fBFalse\fP to keep pillar data from being refreshed.
.TP
.B clean_pillar_cache
False
Set to \fBTrue\fP to refresh pillar cache.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.refresh_grains
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.refresh_matchers()
Signal the minion to refresh its matchers.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.refresh_matchers
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.refresh_modules(**kwargs)
Signal the minion to refresh the module and grain data
.sp
The default is to refresh module asynchronously. To block
until the module refresh is complete, set the \(aqasync\(aq flag
to False.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.refresh_modules
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.refresh_pillar(wait=False, timeout=30, clean_cache=True)
Signal the minion to refresh the in\-memory pillar data. See \fI\%In\-Memory Pillar Data vs. On\-Demand Pillar Data\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBwait\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- Wait for pillar refresh to complete, defaults to False.
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP\fI, \fP\fIoptional\fP) \-\- How long to wait in seconds, only used when wait is True, defaults to 30.
.IP \(bu 2
\fBclean_cache\fP (\fI\%bool\fP\fI, \fP\fIoptional
\&.. versionadded:: 3005\fP) \-\- Clean the pillar cache, only used when \fIpillar_cache\fP is True. Defaults to True
.UNINDENT
.TP
.B Returns
Boolean status, True when the pillar_refresh event was fired successfully.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.refresh_pillar
salt \(aq*\(aq saltutil.refresh_pillar wait=True timeout=60
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.regen_keys()
Used to regenerate the minion keys.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.regen_keys
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.revoke_auth(preserve_minion_cache=False)
The minion sends a request to the master to revoke its own key.
Note that the minion session will be revoked and the minion may
not be able to return the result of this command back to the master.
.sp
If the \(aqpreserve_minion_cache\(aq flag is set to True, the master
cache for this minion will not be removed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.revoke_auth
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.runner(name, arg=None, kwarg=None, full_return=False, saltenv=\(aqbase\(aq, jid=None, **kwargs)
Execute a runner function. This function must be run on the master,
either by targeting a minion running on a master or by using
salt\-call on a master.
.sp
New in version 2014.7.0.

.INDENT 7.0
.TP
.B name
The name of the function to run
.TP
.B kwargs
Any keyword arguments to pass to the runner function
.UNINDENT
.sp
CLI Example:
.sp
In this example, assume that \fImaster_minion\fP is a minion running
on a master.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt master_minion saltutil.runner jobs.list_jobs
salt master_minion saltutil.runner test.arg arg=\(dq[\(aqbaz\(aq]\(dq kwarg=\(dq{\(aqfoo\(aq: \(aqbar\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.running()
Return the data on all running salt processes on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.running
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.signal_job(jid, sig)
Sends a signal to the named salt job\(aqs process
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.signal_job <job id> 15
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_all(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None, clean_pillar_cache=False)
Changed in version 3007.0: On masterless minions, master top modules are now synced as well.
When \fBrefresh\fP is set to \fBTrue\fP, this module\(aqs cache containing
the environments from which extension modules are synced when
\fBsaltenv\fP is not specified will be refreshed.

.sp
Changed in version 2015.8.11,2016.3.2: On masterless minions, pillar modules are now synced, and refreshed
when \fBrefresh\fP is set to \fBTrue\fP\&.

.sp
Sync down all of the dynamic modules from the file server for a specific
environment. This function synchronizes custom modules, states, beacons,
grains, returners, output modules, renderers, and utils.
.INDENT 7.0
.TP
.B refresh
True
Also refresh the execution modules and recompile pillar data available
to the minion. If this is a masterless minion, also refresh the environments
from which extension modules are synced after syncing master tops.
This refresh will be performed even if no new dynamic
modules are synced. Set to \fBFalse\fP to prevent this refresh.
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
If this function is executed using a \fI\%module.run\fP state, the SLS file will not have access to
newly synced execution modules unless a \fBrefresh\fP argument is
added to the state, like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
load_my_custom_module:
  module.run:
    \- name: saltutil.sync_all
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See \fI\%here\fP for a more detailed explanation of
why this is necessary.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B extmod_whitelist
None
dictionary of modules to sync based on type
.TP
.B extmod_blacklist
None
dictionary of modules to blacklist based on type
.TP
.B clean_pillar_cache
False
Set to \fBTrue\fP to refresh pillar cache.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_all
salt \(aq*\(aq saltutil.sync_all saltenv=dev
salt \(aq*\(aq saltutil.sync_all saltenv=base,dev
salt \(aq*\(aq saltutil.sync_all extmod_whitelist={\(aqmodules\(aq: [\(aqcustom_module\(aq]}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_beacons(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)
New in version 2015.5.1.

.sp
Sync beacons from \fBsalt://_beacons\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for beacons to sync. If no top files are
found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available beacons on the minion. This refresh
will be performed even if no new beacons are synced. Set to \fBFalse\fP
to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_beacons
salt \(aq*\(aq saltutil.sync_beacons saltenv=dev
salt \(aq*\(aq saltutil.sync_beacons saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_clouds(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)
New in version 2017.7.0.

.sp
Sync cloud modules from \fBsalt://_cloud\fP to the minion
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available execution modules on the minion.
This refresh will be performed even if no new utility modules are
synced. Set to \fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_clouds
salt \(aq*\(aq saltutil.sync_clouds saltenv=dev
salt \(aq*\(aq saltutil.sync_clouds saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_engines(saltenv=None, refresh=False, extmod_whitelist=None, extmod_blacklist=None)
New in version 2016.3.0.

.sp
Sync engine modules from \fBsalt://_engines\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for engines to sync. If no top files are
found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available execution modules on the minion.
This refresh will be performed even if no new engine modules are synced.
Set to \fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_engines
salt \(aq*\(aq saltutil.sync_engines saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_executors(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)
New in version 3000.

.sp
Sync executors from \fBsalt://_executors\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for log handlers to sync. If no top files
are found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available execution modules on the minion.
This refresh will be performed even if no new log handlers are synced.
Set to \fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-seperated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-seperated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_executors
salt \(aq*\(aq saltutil.sync_executors saltenv=dev
salt \(aq*\(aq saltutil.sync_executors saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_grains(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None, clean_pillar_cache=False)
New in version 0.10.0.

.sp
Sync grains modules from \fBsalt://_grains\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for grains modules to sync. If no top
files are found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available execution modules and recompile
pillar data for the minion. This refresh will be performed even if no
new grains modules are synced. Set to \fBFalse\fP to prevent this
refresh.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.TP
.B clean_pillar_cache
False
Set to \fBTrue\fP to refresh pillar cache.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_grains
salt \(aq*\(aq saltutil.sync_grains saltenv=dev
salt \(aq*\(aq saltutil.sync_grains saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_log_handlers(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)
New in version 2015.8.0.

.sp
Sync log handlers from \fBsalt://_log_handlers\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for log handlers to sync. If no top files
are found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available execution modules on the minion.
This refresh will be performed even if no new log handlers are synced.
Set to \fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_log_handlers
salt \(aq*\(aq saltutil.sync_log_handlers saltenv=dev
salt \(aq*\(aq saltutil.sync_log_handlers saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_matchers(saltenv=None, refresh=False, extmod_whitelist=None, extmod_blacklist=None)
New in version 2019.2.0.

.sp
Sync engine modules from \fBsalt://_matchers\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for engines to sync. If no top files are
found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available execution modules on the minion.
This refresh will be performed even if no new matcher modules are synced.
Set to \fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_matchers
salt \(aq*\(aq saltutil.sync_matchers saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_modules(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)
New in version 0.10.0.

.sp
Sync execution modules from \fBsalt://_modules\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for execution modules to sync. If no top
files are found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available execution modules on the minion.
This refresh will be performed even if no new execution modules are
synced. Set to \fBFalse\fP to prevent this refresh.
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
If this function is executed using a \fI\%module.run\fP state, the SLS file will not have access to
newly synced execution modules unless a \fBrefresh\fP argument is
added to the state, like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
load_my_custom_module:
  module.run:
    \- name: saltutil.sync_modules
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See \fI\%here\fP for a more detailed explanation of
why this is necessary.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_modules
salt \(aq*\(aq saltutil.sync_modules saltenv=dev
salt \(aq*\(aq saltutil.sync_modules saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_output(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)
Sync outputters from \fBsalt://_output\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for outputters to sync. If no top files
are found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available execution modules on the minion.
This refresh will be performed even if no new outputters are synced.
Set to \fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_output
salt \(aq*\(aq saltutil.sync_output saltenv=dev
salt \(aq*\(aq saltutil.sync_output saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_outputters(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)
This function is an alias of \fBsync_output\fP\&.
.INDENT 7.0
.INDENT 3.5
Sync outputters from \fBsalt://_output\fP to the minion
.INDENT 0.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for outputters to sync. If no top files
are found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available execution modules on the minion.
This refresh will be performed even if no new outputters are synced.
Set to \fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_output
salt \(aq*\(aq saltutil.sync_output saltenv=dev
salt \(aq*\(aq saltutil.sync_output saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_pillar(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None, clean_pillar_cache=False)
New in version 2015.8.11,2016.3.2.

.sp
Sync pillar modules from the \fBsalt://_pillar\fP directory on the Salt
fileserver. This function is environment\-aware, pass the desired
environment to grab the contents of the \fB_pillar\fP directory from that
environment. The default environment, if none is specified,  is \fBbase\fP\&.
.INDENT 7.0
.TP
.B refresh
True
Also refresh the execution modules available to the minion, and refresh
pillar data.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.TP
.B clean_pillar_cache
False
Set to \fBTrue\fP to refresh pillar cache.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function will raise an error if executed on a traditional (i.e.
not masterless) minion
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_pillar
salt \(aq*\(aq saltutil.sync_pillar saltenv=dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_proxymodules(saltenv=None, refresh=False, extmod_whitelist=None, extmod_blacklist=None)
New in version 2015.8.2.

.sp
Sync proxy modules from \fBsalt://_proxy\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for proxy modules to sync. If no top
files are found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available execution modules on the minion.
This refresh will be performed even if no new proxy modules are synced.
Set to \fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_proxymodules
salt \(aq*\(aq saltutil.sync_proxymodules saltenv=dev
salt \(aq*\(aq saltutil.sync_proxymodules saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_renderers(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)
New in version 0.10.0.

.sp
Sync renderers from \fBsalt://_renderers\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for renderers to sync. If no top files
are found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available execution modules on the minion.
This refresh will be performed even if no new renderers are synced.
Set to \fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_renderers
salt \(aq*\(aq saltutil.sync_renderers saltenv=dev
salt \(aq*\(aq saltutil.sync_renderers saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_returners(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)
New in version 0.10.0.

.sp
Sync returners from \fBsalt://_returners\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for returners to sync. If no top files
are found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available execution modules on the minion.
This refresh will be performed even if no new returners are synced. Set
to \fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_returners
salt \(aq*\(aq saltutil.sync_returners saltenv=dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_sdb(saltenv=None, extmod_whitelist=None, extmod_blacklist=None)
New in version 2015.5.8,2015.8.3.

.sp
Sync sdb modules from \fBsalt://_sdb\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for sdb modules to sync. If no top files
are found, then the \fBbase\fP environment will be synced.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_sdb
salt \(aq*\(aq saltutil.sync_sdb saltenv=dev
salt \(aq*\(aq saltutil.sync_sdb saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_serializers(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)
New in version 2019.2.0.

.sp
Sync serializers from \fBsalt://_serializers\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for serializer modules to sync. If no top
files are found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available execution modules on the minion.
This refresh will be performed even if no new serializer modules are
synced. Set to \fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-seperated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-seperated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_serializers
salt \(aq*\(aq saltutil.sync_serializers saltenv=dev
salt \(aq*\(aq saltutil.sync_serializers saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_states(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)
New in version 0.10.0.

.sp
Sync state modules from \fBsalt://_states\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for state modules to sync. If no top
files are found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available states on the minion. This refresh
will be performed even if no new state modules are synced. Set to
\fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_states
salt \(aq*\(aq saltutil.sync_states saltenv=dev
salt \(aq*\(aq saltutil.sync_states saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_thorium(saltenv=None, refresh=False, extmod_whitelist=None, extmod_blacklist=None)
New in version 2018.3.0.

.sp
Sync Thorium modules from \fBsalt://_thorium\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for engines to sync. If no top files are
found, then the \fBbase\fP environment will be synced.
.TP
.B refresh: \fBTrue\fP
If \fBTrue\fP, refresh the available execution modules on the minion.
This refresh will be performed even if no new Thorium modules are synced.
Set to \fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_thorium
salt \(aq*\(aq saltutil.sync_thorium saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_tops(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)
New in version 3007.0.

.sp
Sync master tops from \fBsalt://_tops\fP to the minion.
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for master tops to sync. If no top files
are found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
Refresh this module\(aqs cache containing the environments from which
extension modules are synced when \fBsaltenv\fP is not specified.
This refresh will be performed even if no new master tops are synced.
Set to \fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function will raise an error if executed on a traditional (i.e.
not masterless) minion
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_tops
salt \(aq*\(aq saltutil.sync_tops saltenv=dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_utils(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)
New in version 2014.7.0.

.sp
Sync utility modules from \fBsalt://_utils\fP to the minion
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for utility modules to sync. If no top
files are found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available execution modules on the minion.
This refresh will be performed even if no new utility modules are
synced. Set to \fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_utils
salt \(aq*\(aq saltutil.sync_utils saltenv=dev
salt \(aq*\(aq saltutil.sync_utils saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.sync_wrapper(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)
New in version 3007.0.

.sp
Sync salt\-ssh wrapper modules from \fBsalt://_wrapper\fP to the minion.
.INDENT 7.0
.TP
.B saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.sp
If not passed, then all environments configured in the \fI\%top files\fP will be checked for wrappers to sync. If no top files
are found, then the \fBbase\fP environment will be synced.
.TP
.B refresh
True
If \fBTrue\fP, refresh the available wrapper modules on the minion.
This refresh will be performed even if no wrappers are synced.
Set to \fBFalse\fP to prevent this refresh.
.TP
.B extmod_whitelist
None
comma\-seperated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-seperated list of modules to blacklist based on type
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function will raise an error if executed on a traditional (i.e.
not masterless) minion.
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_wrapper
salt \(aq*\(aq saltutil.sync_wrapper saltenv=dev
salt \(aq*\(aq saltutil.sync_wrapper saltenv=base,dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.term_all_jobs()
Sends a termination signal (SIGTERM 15) to all currently running jobs
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.term_all_jobs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.term_job(jid)
Sends a termination signal (SIGTERM 15) to the named salt job\(aqs process
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.term_job <job id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.update(version=None)
Update the salt minion from the URL defined in opts[\(aqupdate_url\(aq]
VMware, Inc provides the latest builds here:
update_url: \fI\%https://repo.saltproject.io/windows/\fP
.sp
Be aware that as of 2014\-8\-11 there\(aqs a bug in esky such that only the
latest version available in the update_url can be downloaded and installed.
.sp
This feature requires the minion to be running a bdist_esky build.
.sp
The version number is optional and will default to the most recent version
available at opts[\(aqupdate_url\(aq].
.sp
Returns details about the transaction upon completion.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.update
salt \(aq*\(aq saltutil.update 0.10.3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.saltutil.wheel(name, *args, **kwargs)
Execute a wheel module and function. This function must be run against a
minion that is local to the master.
.sp
New in version 2014.7.0.

.INDENT 7.0
.TP
.B name
The name of the function to run
.TP
.B args
Any positional arguments to pass to the wheel function. A common example
of this would be the \fBmatch\fP arg needed for key functions.
.sp
New in version 2015.8.11.

.TP
.B kwargs
Any keyword arguments to pass to the wheel function
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt my\-local\-minion saltutil.wheel key.accept jerry
salt my\-local\-minion saltutil.wheel minions.connected
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Since this function must be run against a minion that is running locally
on the master in order to get accurate returns, if this function is run
against minions that are not local to the master, \(dqempty\(dq returns are
expected. The remote minion does not have access to wheel functions and
their return data.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.schedule
.sp
Module for managing the Salt schedule on a minion
.sp
Requires that python\-dateutil is installed on the minion.
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B salt.modules.schedule.add(name, **kwargs)
Add a job to the schedule
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.add job1 function=\(aqtest.ping\(aq seconds=3600
# If function have some arguments, use job_args
salt \(aq*\(aq schedule.add job2 function=\(aqcmd.run\(aq job_args=\(dq[\(aqdate >> /tmp/date.log\(aq]\(dq seconds=60

# Add job to Salt minion when the Salt minion is not running
salt \(aq*\(aq schedule.add job1 function=\(aqtest.ping\(aq seconds=3600 offline=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.build_schedule_item(name, **kwargs)
Build a schedule job
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.build_schedule_item job1 function=\(aqtest.ping\(aq seconds=3600
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.copy(name, target, **kwargs)
Copy scheduled job to another minion or minions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.copy jobname target
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.delete(name, **kwargs)
Delete a job from the minion\(aqs schedule
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.delete job1

# Delete job on Salt minion when the Salt minion is not running
salt \(aq*\(aq schedule.delete job1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.disable(**kwargs)
Disable all scheduled jobs on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.disable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.disable_job(name, **kwargs)
Disable a job in the minion\(aqs schedule
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.disable_job job1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.enable(**kwargs)
Enable all scheduled jobs on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.enable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.enable_job(name, **kwargs)
Enable a job in the minion\(aqs schedule
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.enable_job job1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.is_enabled(name=None)
List a Job only if its enabled
.sp
If job is not specified, indicate
if the scheduler is enabled or disabled.
.sp
New in version 2015.5.3.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.is_enabled name=job_name
salt \(aq*\(aq schedule.is_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.job_status(name, time_fmt=\(aq%Y\-%m\-%dT%H:%M:%S\(aq)
Show the information for a particular job.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.job_status job_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.list_(show_all=False, show_disabled=True, where=None, return_yaml=True, offline=False)
List the jobs currently scheduled on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.list

# Show all jobs including hidden internal jobs
salt \(aq*\(aq schedule.list show_all=True

# Hide disabled jobs from list of jobs
salt \(aq*\(aq schedule.list show_disabled=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.modify(name, **kwargs)
Modify an existing job in the schedule
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.modify job1 function=\(aqtest.ping\(aq seconds=3600

# Modify job on Salt minion when the Salt minion is not running
salt \(aq*\(aq schedule.modify job1 function=\(aqtest.ping\(aq seconds=3600 offline=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.move(name, target, **kwargs)
Move scheduled job to another minion or minions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.move jobname target
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.postpone_job(name, current_time, new_time, **kwargs)
Postpone a job in the minion\(aqs schedule
.sp
Current time and new time should be in date string format,
default value is %Y\-%m\-%dT%H:%M:%S.
.sp
New in version 2018.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.postpone_job job current_time new_time

salt \(aq*\(aq schedule.postpone_job job current_time new_time time_fmt=\(aq%Y\-%m\-%dT%H:%M:%S\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.purge(**kwargs)
Purge all the jobs currently scheduled on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.purge

# Purge jobs on Salt minion
salt \(aq*\(aq schedule.purge
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.reload_()
Reload saved scheduled jobs on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.reload
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.run_job(name, force=False)
Run a scheduled job on the minion immediately
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.run_job job1

salt \(aq*\(aq schedule.run_job job1 force=True
Force the job to run even if it is disabled.
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.save(**kwargs)
Save all scheduled jobs on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.save
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.show_next_fire_time(name, **kwargs)
Show the next fire time for scheduled job
.sp
New in version 2018.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.show_next_fire_time job_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.schedule.skip_job(name, current_time, **kwargs)
Skip a job in the minion\(aqs schedule at specified time.
.sp
Time to skip should be specified as date string format,
default value is %Y\-%m\-%dT%H:%M:%S.
.sp
New in version 2018.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq schedule.skip_job job time
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.scp
.SS SCP Module
.sp
New in version 2019.2.0.

.sp
Module to copy files via \fI\%SCP\fP
.INDENT 0.0
.TP
.B salt.modules.scp_mod.get(remote_path, local_path=\(aq\(aq, recursive=False, preserve_times=False, **kwargs)
Transfer files and directories from remote host to the localhost of the
Minion.
.INDENT 7.0
.TP
.B remote_path
Path to retrieve from remote host. Since this is evaluated by scp on the
remote host, shell wildcards and environment variables may be used.
.TP
.B recursive: \fBFalse\fP
Transfer files and directories recursively.
.TP
.B preserve_times: \fBFalse\fP
Preserve \fBmtime\fP and \fBatime\fP of transferred files and directories.
.TP
.B hostname
The hostname of the remote device.
.TP
.B port: \fB22\fP
The port of the remote device.
.TP
.B username
The username required for SSH authentication on the device.
.TP
.B password
Used for password authentication. It is also used for private key
decryption if \fBpassphrase\fP is not given.
.TP
.B passphrase
Used for decrypting private keys.
.TP
.B pkey
An optional private key to use for authentication.
.TP
.B key_filename
The filename, or list of filenames, of optional private key(s) and/or
certificates to try for authentication.
.TP
.B timeout
An optional timeout (in seconds) for the TCP connect.
.TP
.B socket_timeout: \fB10\fP
The channel socket timeout in seconds.
.TP
.B buff_size: \fB16384\fP
The size of the SCP send buffer.
.TP
.B allow_agent: \fBTrue\fP
Set to \fBFalse\fP to disable connecting to the SSH agent.
.TP
.B look_for_keys: \fBTrue\fP
Set to \fBFalse\fP to disable searching for discoverable private key
files in \fB~/.ssh/\fP
.TP
.B banner_timeout
An optional timeout (in seconds) to wait for the SSH banner to be
presented.
.TP
.B auth_timeout
An optional timeout (in seconds) to wait for an authentication
response.
.TP
.B auto_add_policy: \fBFalse\fP
Automatically add the host to the \fBknown_hosts\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq scp.get /var/tmp/file /tmp/file hostname=10.10.10.1 auto_add_policy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.scp_mod.put(files, remote_path=None, recursive=False, preserve_times=False, saltenv=\(aqbase\(aq, **kwargs)
Transfer files and directories to remote host.
.INDENT 7.0
.TP
.B files
A single path or a list of paths to be transferred.
.TP
.B remote_path
The path on the remote device where to store the files.
.TP
.B recursive: \fBTrue\fP
Transfer files and directories recursively.
.TP
.B preserve_times: \fBFalse\fP
Preserve \fBmtime\fP and \fBatime\fP of transferred files and directories.
.TP
.B hostname
The hostname of the remote device.
.TP
.B port: \fB22\fP
The port of the remote device.
.TP
.B username
The username required for SSH authentication on the device.
.TP
.B password
Used for password authentication. It is also used for private key
decryption if \fBpassphrase\fP is not given.
.TP
.B passphrase
Used for decrypting private keys.
.TP
.B pkey
An optional private key to use for authentication.
.TP
.B key_filename
The filename, or list of filenames, of optional private key(s) and/or
certificates to try for authentication.
.TP
.B timeout
An optional timeout (in seconds) for the TCP connect.
.TP
.B socket_timeout: \fB10\fP
The channel socket timeout in seconds.
.TP
.B buff_size: \fB16384\fP
The size of the SCP send buffer.
.TP
.B allow_agent: \fBTrue\fP
Set to \fBFalse\fP to disable connecting to the SSH agent.
.TP
.B look_for_keys: \fBTrue\fP
Set to \fBFalse\fP to disable searching for discoverable private key
files in \fB~/.ssh/\fP
.TP
.B banner_timeout
An optional timeout (in seconds) to wait for the SSH banner to be
presented.
.TP
.B auth_timeout
An optional timeout (in seconds) to wait for an authentication
response.
.TP
.B auto_add_policy: \fBFalse\fP
Automatically add the host to the \fBknown_hosts\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq scp.put /path/to/file /var/tmp/file hostname=server1 auto_add_policy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.scsi
.sp
SCSI administration module
.INDENT 0.0
.TP
.B salt.modules.scsi.ls_(get_size=True)
List SCSI devices, with details
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq scsi.ls
salt \(aq*\(aq scsi.ls get_size=False
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B get_size
True
Get the size information for scsi devices.  This option
should be set to False for older OS distributions (RHEL6 and older)
due to lack of support for the \(aq\-s\(aq option in lsscsi.
.sp
New in version 2015.5.10.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.scsi.rescan_all(host)
List scsi devices
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq scsi.rescan_all 0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.sdb
.SS Module for Manipulating Data via the Salt DB API
.INDENT 0.0
.TP
.B salt.modules.sdb.delete(uri)
Delete a value from a db, using a uri in the form of \fBsdb://<profile>/<key>\fP\&.
If the uri provided does not start with \fBsdb://\fP or the value is not
successfully deleted, return \fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sdb.delete sdb://mymemcached/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sdb.get(uri, strict=False)
Get a value from a db, using a uri in the form of \fBsdb://<profile>/<key>\fP\&. If
the uri provided is not valid, then it will be returned as\-is, unless \fBstrict=True\fP was passed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sdb.get sdb://mymemcached/foo strict=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sdb.get_or_set_hash(uri, length=8, chars=\(aqabcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(\-_=+)\(aq)
Perform a one\-time generation of a hash and write it to sdb.
If that value has already been set return the value instead.
.sp
This is useful for generating passwords or keys that are specific to
multiple minions that need to be stored somewhere centrally.
.sp
State Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
some_mysql_user:
  mysql_user:
    \- present
    \- host: localhost
    \- password: \(aq{{ salt[\(dqsdb.get_or_set_hash\(dq](\(dqsdb://mymemcached/some_user_pass\(dq) }}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sdb.get_or_set_hash \(aqsdb://mymemcached/SECRET_KEY\(aq 50
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This function could return strings which may contain characters which are reserved
as directives by the YAML parser, such as strings beginning with \fB%\fP\&. To avoid
issues when using the output of this function in an SLS file containing YAML+Jinja,
surround the call with single quotes.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sdb.set_(uri, value)
Set a value in a db, using a uri in the form of \fBsdb://<profile>/<key>\fP\&.
If the uri provided does not start with \fBsdb://\fP or the value is not
successfully set, return \fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sdb.set sdb://mymemcached/foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.seed
.sp
Virtual machine image management tools
.INDENT 0.0
.TP
.B salt.modules.seed.apply_(path, id_=None, config=None, approve_key=True, install=True, prep_install=False, pub_key=None, priv_key=None, mount_point=None)
Seed a location (disk image, directory, or block device) with the
minion config, approve the minion\(aqs key, and/or install salt\-minion.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq seed.apply path id [config=config_data] \e
        [gen_key=(true|false)] [approve_key=(true|false)] \e
        [install=(true|false)]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
Full path to the directory, device, or disk image  on the target
minion\(aqs file system.
.TP
.B id
Minion id with which to seed the path.
.TP
.B config
Minion configuration options. By default, the \(aqmaster\(aq option is set to
the target host\(aqs \(aqmaster\(aq.
.TP
.B approve_key
Request a pre\-approval of the generated minion key. Requires
that the salt\-master be configured to either auto\-accept all keys or
expect a signing request from the target host. Default: true.
.TP
.B install
Install salt\-minion, if absent. Default: true.
.TP
.B prep_install
Prepare the bootstrap script, but don\(aqt run it. Default: false
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.seed.mkconfig(config=None, tmp=None, id_=None, approve_key=True, pub_key=None, priv_key=None)
Generate keys and config and put them in a tmp directory.
.INDENT 7.0
.TP
.B pub_key
absolute path or file content of an optional preseeded salt key
.TP
.B priv_key
absolute path or file content of an optional preseeded salt key
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq seed.mkconfig [config=config_data] [tmp=tmp_dir] \e
        [id_=minion_id] [approve_key=(true|false)]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.seed.prep_bootstrap(mpt)
Update and get the random script to a random place
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq seed.prep_bootstrap /tmp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.selinux
.sp
Execute calls on selinux
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This module requires the \fBsemanage\fP, \fBsetsebool\fP, and \fBsemodule\fP
commands to be available on the minion. On RHEL\-based distributions,
ensure that the \fBpolicycoreutils\fP and \fBpolicycoreutils\-python\fP
packages are installed. If not on a Fedora or RHEL\-based distribution,
consult the selinux documentation for your distribution to ensure that the
proper packages are installed.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.fcontext_add_policy(name, filetype=None, sel_type=None, sel_user=None, sel_level=None)
New in version 2019.2.0.

.sp
Adds the SELinux policy for a given filespec and other optional parameters.
.sp
Returns the result of the call to semanage.
.sp
Note that you don\(aqt have to remove an entry before setting a new
one for a given filespec and filetype, as adding one with semanage
automatically overwrites a previously configured SELinux context.
.INDENT 7.0
.TP
.B name
filespec of the file or directory. Regex syntax is allowed.
.TP
.B file_type
The SELinux filetype specification. Use one of [a, f, d, c, b,
s, l, p]. See also \fBman semanage\-fcontext\fP\&. Defaults to \(aqa\(aq
(all files).
.TP
.B sel_type
SELinux context type. There are many.
.TP
.B sel_user
SELinux user. Use \fBsemanage login \-l\fP to determine which ones
are available to you.
.TP
.B sel_level
The MLS range of the SELinux context.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.fcontext_add_policy my\-policy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.fcontext_apply_policy(name, recursive=False)
New in version 2017.7.0.

.sp
Applies SElinux policies to filespec using \fIrestorecon [\-R]
filespec\fP\&. Returns dict with changes if successful, the output of
the restorecon command otherwise.
.INDENT 7.0
.TP
.B name
filespec of the file or directory. Regex syntax is allowed.
.TP
.B recursive
Recursively apply SELinux policies.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.fcontext_apply_policy my\-policy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.fcontext_delete_policy(name, filetype=None, sel_type=None, sel_user=None, sel_level=None)
New in version 2019.2.0.

.sp
Deletes the SELinux policy for a given filespec and other optional parameters.
.sp
Returns the result of the call to semanage.
.sp
Note that you don\(aqt have to remove an entry before setting a new
one for a given filespec and filetype, as adding one with semanage
automatically overwrites a previously configured SELinux context.
.INDENT 7.0
.TP
.B name
filespec of the file or directory. Regex syntax is allowed.
.TP
.B file_type
The SELinux filetype specification. Use one of [a, f, d, c, b,
s, l, p]. See also \fBman semanage\-fcontext\fP\&. Defaults to \(aqa\(aq
(all files).
.TP
.B sel_type
SELinux context type. There are many.
.TP
.B sel_user
SELinux user. Use \fBsemanage login \-l\fP to determine which ones
are available to you.
.TP
.B sel_level
The MLS range of the SELinux context.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.fcontext_delete_policy my\-policy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.fcontext_get_policy(name, filetype=None, sel_type=None, sel_user=None, sel_level=None)
New in version 2017.7.0.

.sp
Returns the current entry in the SELinux policy list as a
dictionary. Returns None if no exact match was found.
.sp
Returned keys are:
.INDENT 7.0
.IP \(bu 2
filespec (the name supplied and matched)
.IP \(bu 2
filetype (the descriptive name of the filetype supplied)
.IP \(bu 2
sel_user, sel_role, sel_type, sel_level (the selinux context)
.UNINDENT
.sp
For a more in\-depth explanation of the selinux context, go to
\fI\%https://access.redhat.com/documentation/en\-US/Red_Hat_Enterprise_Linux/6/html/Security\-Enhanced_Linux/chap\-Security\-Enhanced_Linux\-SELinux_Contexts.html\fP
.INDENT 7.0
.TP
.B name
filespec of the file or directory. Regex syntax is allowed.
.TP
.B filetype
The SELinux filetype specification. Use one of [a, f, d, c, b,
s, l, p]. See also \fIman semanage\-fcontext\fP\&. Defaults to \(aqa\(aq
(all files).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.fcontext_get_policy my\-policy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.fcontext_policy_is_applied(name, recursive=False)
New in version 2017.7.0.

.sp
Returns an empty string if the SELinux policy for a given filespec
is applied, returns string with differences in policy and actual
situation otherwise.
.INDENT 7.0
.TP
.B name
filespec of the file or directory. Regex syntax is allowed.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.fcontext_policy_is_applied my\-policy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.filetype_id_to_string(filetype=\(aqa\(aq)
New in version 2017.7.0.

.sp
Translates SELinux filetype single\-letter representation to a more
human\-readable version (which is also used in \fIsemanage fcontext
\-l\fP).
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.getconfig()
Return the selinux mode from the config file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.getconfig
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.getenforce()
Return the mode selinux is running in
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.getenforce
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.getsebool(boolean)
Return the information on a specific selinux boolean
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.getsebool virt_use_usb
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.getsemod(module)
Return the information on a specific selinux module
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.getsemod mysql
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.install_semod(module_path)
Install custom SELinux module from file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.install_semod [salt://]path/to/module.pp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.6.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.list_sebool()
Return a structure listing all of the selinux booleans on the system and
what state they are in
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.list_sebool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.list_semod()
Return a structure listing all of the selinux modules on the system and
what state they are in
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.list_semod
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.port_add_policy(name, sel_type=None, protocol=None, port=None, sel_range=None)
New in version 2019.2.0.

.sp
Adds the SELinux policy for a given protocol and port.
.sp
Returns the result of the call to semanage.
.INDENT 7.0
.TP
.B name
The protocol and port spec. Can be formatted as \fB(tcp|udp)/(port|port\-range)\fP\&.
.TP
.B sel_type
The SELinux Type. Required.
.TP
.B protocol
The protocol for the port, \fBtcp\fP or \fBudp\fP\&. Required if name is not formatted.
.TP
.B port
The port or port range. Required if name is not formatted.
.TP
.B sel_range
The SELinux MLS/MCS Security Range.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.port_add_policy tcp/8080 http_port_t
salt \(aq*\(aq selinux.port_add_policy foobar http_port_t protocol=tcp port=8091
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.port_delete_policy(name, protocol=None, port=None)
New in version 2019.2.0.

.sp
Deletes the SELinux policy for a given protocol and port.
.sp
Returns the result of the call to semanage.
.INDENT 7.0
.TP
.B name
The protocol and port spec. Can be formatted as \fB(tcp|udp)/(port|port\-range)\fP\&.
.TP
.B protocol
The protocol for the port, \fBtcp\fP or \fBudp\fP\&. Required if name is not formatted.
.TP
.B port
The port or port range. Required if name is not formatted.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.port_delete_policy tcp/8080
salt \(aq*\(aq selinux.port_delete_policy foobar protocol=tcp port=8091
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.port_get_policy(name, sel_type=None, protocol=None, port=None)
New in version 2019.2.0.

.sp
Returns the current entry in the SELinux policy list as a
dictionary. Returns None if no exact match was found.
.sp
Returned keys are:
.INDENT 7.0
.IP \(bu 2
sel_type (the selinux type)
.IP \(bu 2
proto (the protocol)
.IP \(bu 2
port (the port(s) and/or port range(s))
.UNINDENT
.INDENT 7.0
.TP
.B name
The protocol and port spec. Can be formatted as \fB(tcp|udp)/(port|port\-range)\fP\&.
.TP
.B sel_type
The SELinux Type.
.TP
.B protocol
The protocol for the port, \fBtcp\fP or \fBudp\fP\&. Required if name is not formatted.
.TP
.B port
The port or port range. Required if name is not formatted.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.port_get_policy tcp/80
salt \(aq*\(aq selinux.port_get_policy foobar protocol=tcp port=80
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.port_modify_policy(name, sel_type=None, protocol=None, port=None, sel_range=None)
New in version 2019.2.0.

.sp
Modifies the SELinux policy for a given protocol and port.
.sp
Returns the result of the call to semanage.
.INDENT 7.0
.TP
.B name
The protocol and port spec. Can be formatted as \fB(tcp|udp)/(port|port\-range)\fP\&.
.TP
.B sel_type
The SELinux Type. Required.
.TP
.B protocol
The protocol for the port, \fBtcp\fP or \fBudp\fP\&. Required if name is not formatted.
.TP
.B port
The port or port range. Required if name is not formatted.
.TP
.B sel_range
The SELinux MLS/MCS Security Range.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.port_modify_policy tcp/8080 http_port_t
salt \(aq*\(aq selinux.port_modify_policy foobar http_port_t protocol=tcp port=8091
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.remove_semod(module)
Remove SELinux module
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.remove_semod module_name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.6.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.selinux_fs_path()
Return the location of the SELinux VFS directory
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.selinux_fs_path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.setenforce(mode)
Set the SELinux enforcing mode
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.setenforce enforcing
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.setsebool(boolean, value, persist=False)
Set the value for a boolean
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.setsebool virt_use_usb off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.setsebools(pairs, persist=False)
Set the value of multiple booleans
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.setsebools \(aq{virt_use_usb: on, squid_use_tproxy: off}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.selinux.setsemod(module, state)
Enable or disable an SELinux module.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq selinux.setsemod nagios Enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.UNINDENT
.SS salt.modules.sensehat
.sp
Module for controlling the LED matrix or reading environment data on the SenseHat of a Raspberry Pi.
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B maintainer
Benedikt Werner <\fI\%1benediktwerner@gmail.com\fP>, Joachim Werner <\fI\%joe@suse.com\fP>
.TP
.B maturity
new
.TP
.B depends
sense_hat Python module
.UNINDENT
.sp
The rotation of the Pi can be specified in a pillar.
This is useful if the Pi is used upside down or sideways to correct the orientation of the image being shown.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sensehat:
    rotation: 90
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sensehat.clear(color=None)
Sets the LED matrix to a single color or turns all LEDs off.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqraspberry\(aq sensehat.clear
salt \(aqraspberry\(aq sensehat.clear \(aq[255, 0, 0]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sensehat.get_humidity()
Get the percentage of relative humidity from the humidity sensor.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sensehat.get_pixel(x, y)
Returns the color of a single pixel on the LED matrix.
.INDENT 7.0
.TP
.B x
The x coordinate of the pixel. Ranges from 0 on the left to 7 on the right.
.TP
.B y
The y coordinate of the pixel. Ranges from 0 at the top to 7 at the bottom.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Please read the note for \fBget_pixels\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sensehat.get_pixels()
Returns a list of 64 smaller lists of \fB[R, G, B]\fP pixels representing the
the currently displayed image on the LED matrix.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using \fBset_pixels\fP the pixel values can sometimes change when
you read them again using \fBget_pixels\fP\&. This is because we specify each
pixel element as 8 bit numbers (0 to 255) but when they\(aqre passed into the
Linux frame buffer for the LED matrix the numbers are bit shifted down
to fit into RGB 565. 5 bits for red, 6 bits for green and 5 bits for blue.
The loss of binary precision when performing this conversion
(3 bits lost for red, 2 for green and 3 for blue) accounts for the
discrepancies you see.
.sp
The \fBget_pixels\fP method provides an accurate representation of how the
pixels end up in frame buffer memory after you have called \fBset_pixels\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sensehat.get_pressure()
Gets the current pressure in Millibars from the pressure sensor.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sensehat.get_temperature()
Gets the temperature in degrees Celsius from the humidity sensor.
Equivalent to calling \fBget_temperature_from_humidity\fP\&.
.sp
If you get strange results try using \fBget_temperature_from_pressure\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sensehat.get_temperature_from_humidity()
Gets the temperature in degrees Celsius from the humidity sensor.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sensehat.get_temperature_from_pressure()
Gets the temperature in degrees Celsius from the pressure sensor.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sensehat.low_light(low_light=True)
Sets the LED matrix to low light mode. Useful in a dark environment.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqraspberry\(aq sensehat.low_light
salt \(aqraspberry\(aq sensehat.low_light False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sensehat.set_pixel(x, y, color)
Sets a single pixel on the LED matrix to a specified color.
.INDENT 7.0
.TP
.B x
The x coordinate of the pixel. Ranges from 0 on the left to 7 on the right.
.TP
.B y
The y coordinate of the pixel. Ranges from 0 at the top to 7 at the bottom.
.TP
.B color
The new color of the pixel as a list of \fB[R, G, B]\fP values.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqraspberry\(aq sensehat.set_pixel 0 0 \(aq[255, 0, 0]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sensehat.set_pixels(pixels)
Sets the entire LED matrix based on a list of 64 pixel values
.INDENT 7.0
.TP
.B pixels
A list of 64 \fB[R, G, B]\fP color values.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sensehat.show_image(image)
Displays an 8 x 8 image on the LED matrix.
.INDENT 7.0
.TP
.B image
The path to the image to display. The image must be 8 x 8 pixels in size.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqraspberry\(aq sensehat.show_image /tmp/my_image.png
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sensehat.show_letter(letter, text_color=None, back_color=None)
Displays a single letter on the LED matrix.
.INDENT 7.0
.TP
.B letter
The letter to display
.TP
.B text_color
The color in which the letter is shown. Defaults to \(aq[255, 255, 255]\(aq (white).
.TP
.B back_color
The background color of the display. Defaults to \(aq[0, 0, 0]\(aq (black).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqraspberry\(aq sensehat.show_letter O
salt \(aqraspberry\(aq sensehat.show_letter X \(aq[255, 0, 0]\(aq
salt \(aqraspberry\(aq sensehat.show_letter B \(aq[0, 0, 255]\(aq \(aq[255, 255, 0]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sensehat.show_message(message, msg_type=None, text_color=None, back_color=None, scroll_speed=0.1)
Displays a message on the LED matrix.
.INDENT 7.0
.TP
.B message
The message to display
.TP
.B msg_type
The type of the message. Changes the appearance of the message.
.sp
Available types are:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
error:      red text
warning:    orange text
success:    green text
info:       blue text
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B scroll_speed
The speed at which the message moves over the LED matrix.
This value represents the time paused for between shifting the text
to the left by one column of pixels. Defaults to \(aq0.1\(aq.
.TP
.B text_color
The color in which the message is shown. Defaults to \(aq[255, 255, 255]\(aq (white).
.TP
.B back_color
The background color of the display. Defaults to \(aq[0, 0, 0]\(aq (black).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqraspberry\(aq sensehat.show_message \(aqStatus ok\(aq
salt \(aqraspberry\(aq sensehat.show_message \(aqSomething went wrong\(aq error
salt \(aqraspberry\(aq sensehat.show_message \(aqRed\(aq text_color=\(aq[255, 0, 0]\(aq
salt \(aqraspberry\(aq sensehat.show_message \(aqHello world\(aq None \(aq[0, 0, 255]\(aq \(aq[255, 255, 0]\(aq 0.2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.sensors
.sp
Read lm\-sensors
.sp
New in version 2014.1.3.

.INDENT 0.0
.TP
.B salt.modules.sensors.sense(chip, fahrenheit=False)
Gather lm\-sensors data from a given chip
.sp
To determine the chip to query, use the \(aqsensors\(aq command
and see the leading line in the block.
.sp
Example:
.sp
/usr/bin/sensors
.sp
coretemp\-isa\-0000
Adapter: ISA adapter
Physical id 0:  +56.0°C  (high = +87.0°C, crit = +105.0°C)
Core 0:         +52.0°C  (high = +87.0°C, crit = +105.0°C)
Core 1:         +50.0°C  (high = +87.0°C, crit = +105.0°C)
Core 2:         +56.0°C  (high = +87.0°C, crit = +105.0°C)
Core 3:         +53.0°C  (high = +87.0°C, crit = +105.0°C)
.sp
Given the above, the chip is \(aqcoretemp\-isa\-0000\(aq.
.UNINDENT
.SS salt.modules.serverdensity_device
.SS Wrapper around Server Density API
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B salt.modules.serverdensity_device.create(name, **params)
Function to create device in Server Density. For more info, see the \fI\%API
docs\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq serverdensity_device.create lama
salt \(aq*\(aq serverdensity_device.create rich_lama group=lama_band installedRAM=32768
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.serverdensity_device.delete(device_id)
Delete a device from Server Density. For more information, see the \fI\%API
docs\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq serverdensity_device.delete 51f7eafcdba4bb235e000ae4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.serverdensity_device.get_sd_auth(val, sd_auth_pillar_name=\(aqserverdensity\(aq)
Returns requested Server Density authentication value from pillar.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq serverdensity_device.get_sd_auth <val>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.serverdensity_device.install_agent(agent_key, agent_version=1)
Function downloads Server Density installation agent, and installs sd\-agent
with agent_key. Optionally the agent_version would select the series to
use (defaults on the v1 one).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq serverdensity_device.install_agent c2bbdd6689ff46282bdaa07555641498
salt \(aq*\(aq serverdensity_device.install_agent c2bbdd6689ff46282bdaa07555641498 2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.serverdensity_device.ls(**params)
List devices in Server Density
.sp
Results will be filtered by any params passed to this function. For more
information, see the API docs on \fI\%listing\fP and \fI\%searching\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq serverdensity_device.ls
salt \(aq*\(aq serverdensity_device.ls name=lama
salt \(aq*\(aq serverdensity_device.ls name=lama group=lama_band installedRAM=32768
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.serverdensity_device.update(device_id, **params)
Updates device information in Server Density. For more information see the
\fI\%API docs\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq serverdensity_device.update 51f7eafcdba4bb235e000ae4 name=lama group=lama_band
salt \(aq*\(aq serverdensity_device.update 51f7eafcdba4bb235e000ae4 name=better_lama group=rock_lamas swapSpace=512
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.servicenow
.sp
Module for execution of ServiceNow CI (configuration items)
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B depends
servicenow_rest python module
.TP
.B configuration
Configure this module by specifying the name of a configuration
profile in the minion config, minion pillar, or master config. The module
will use the \(aqservicenow\(aq key by default, if defined.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
servicenow:
  instance_name: \(aq\(aq
  username: \(aq\(aq
  password: \(aq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.servicenow.delete_record(table, sys_id)
Delete an existing record
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtable\fP (\fBstr\fP) \-\- The table name, e.g. sys_user
.IP \(bu 2
\fBsys_id\fP (\fBstr\fP) \-\- The unique ID of the record
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion servicenow.delete_record sys_computer 2134566
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.servicenow.non_structured_query(table, query=None, **kwargs)
Run a non\-structed (not a dict) query on a servicenow table.
See \fI\%http://wiki.servicenow.com/index.php?title=Encoded_Query_Strings#gsc.tab=0\fP
for help on constructing a non\-structured query string.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtable\fP (\fBstr\fP) \-\- The table name, e.g. sys_user
.IP \(bu 2
\fBquery\fP (\fBstr\fP) \-\- The query to run (or use keyword arguments to filter data)
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion servicenow.non_structured_query sys_computer \(aqrole=web\(aq
salt myminion servicenow.non_structured_query sys_computer role=web type=computer
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.servicenow.set_change_request_state(change_id, state=\(aqapproved\(aq)
Set the approval state of a change request/record
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBchange_id\fP (\fBstr\fP) \-\- The ID of the change request, e.g. CHG123545
.IP \(bu 2
\fBstate\fP (\fBstr\fP) \-\- The target state, e.g. approved
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion servicenow.set_change_request_state CHG000123 declined
salt myminion servicenow.set_change_request_state CHG000123 approved
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.servicenow.update_record_field(table, sys_id, field, value)
Update the value of a record\(aqs field in a servicenow table
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtable\fP (\fBstr\fP) \-\- The table name, e.g. sys_user
.IP \(bu 2
\fBsys_id\fP (\fBstr\fP) \-\- The unique ID of the record
.IP \(bu 2
\fBfield\fP (\fBstr\fP) \-\- The new value
.IP \(bu 2
\fBvalue\fP (\fBstr\fP) \-\- The new value
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion servicenow.update_record_field sys_user 2348234 first_name jimmy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.slack_notify
.sp
Module for sending messages to Slack
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B configuration
This module can be used by either passing an api key and version
directly or by specifying both in a configuration profile in the salt
master/minion config.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
slack:
  api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slack_notify.call_hook(message, attachment=None, color=\(aqgood\(aq, short=False, identifier=None, channel=None, username=None, icon_emoji=None)
Send message to Slack incoming webhook.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmessage\fP \-\- The topic of message.
.IP \(bu 2
\fBattachment\fP \-\- The message to send to the Slack WebHook.
.IP \(bu 2
\fBcolor\fP \-\- The color of border of left side
.IP \(bu 2
\fBshort\fP \-\- An optional flag indicating whether the value is short
enough to be displayed side\-by\-side with other values.
.IP \(bu 2
\fBidentifier\fP \-\- The identifier of WebHook.
.IP \(bu 2
\fBchannel\fP \-\- The channel to use instead of the WebHook default.
.IP \(bu 2
\fBusername\fP \-\- Username to use instead of WebHook default.
.IP \(bu 2
\fBicon_emoji\fP \-\- Icon to use instead of WebHook default.
.UNINDENT
.TP
.B Returns
Boolean if message was sent successfully.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq slack.call_hook message=\(aqHello, from SaltStack\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slack_notify.find_room(name, api_key=None)
Find a room by name and return it.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The room name.
.IP \(bu 2
\fBapi_key\fP \-\- The Slack admin api key.
.UNINDENT
.TP
.B Returns
The room object.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq slack.find_room name=\(dqrandom\(dq

salt \(aq*\(aq slack.find_room name=\(dqrandom\(dq api_key=peWcBiMOS9HrZG15peWcBiMOS9HrZG15
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slack_notify.find_user(name, api_key=None)
Find a user by name and return it.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The user name.
.IP \(bu 2
\fBapi_key\fP \-\- The Slack admin api key.
.UNINDENT
.TP
.B Returns
The user object.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq slack.find_user name=\(dqThomasHatch\(dq

salt \(aq*\(aq slack.find_user name=\(dqThomasHatch\(dq api_key=peWcBiMOS9HrZG15peWcBiMOS9HrZG15
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slack_notify.list_rooms(api_key=None)
List all Slack rooms.
.INDENT 7.0
.TP
.B Parameters
\fBapi_key\fP \-\- The Slack admin api key.
.TP
.B Returns
The room list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq slack.list_rooms

salt \(aq*\(aq slack.list_rooms api_key=peWcBiMOS9HrZG15peWcBiMOS9HrZG15
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slack_notify.list_users(api_key=None)
List all Slack users.
.INDENT 7.0
.TP
.B Parameters
\fBapi_key\fP \-\- The Slack admin api key.
.TP
.B Returns
The user list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq slack.list_users

salt \(aq*\(aq slack.list_users api_key=peWcBiMOS9HrZG15peWcBiMOS9HrZG15
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slack_notify.post_message(channel, message, from_name, api_key=None, icon=None, attachments=None, blocks=None)
Send a message to a Slack channel.
.sp
Changed in version 3003: Added \fIattachments\fP and \fIblocks\fP kwargs

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBchannel\fP \-\- The channel name, either will work.
.IP \(bu 2
\fBmessage\fP \-\- The message to send to the Slack channel.
.IP \(bu 2
\fBfrom_name\fP \-\- Specify who the message is from.
.IP \(bu 2
\fBapi_key\fP \-\- The Slack api key, if not specified in the configuration.
.IP \(bu 2
\fBicon\fP \-\- URL to an image to use as the icon for this message
.IP \(bu 2
\fBattachments\fP \-\- Any attachments to be sent with the message.
.IP \(bu 2
\fBblocks\fP \-\- Any blocks to be sent with the message.
.UNINDENT
.TP
.B Returns
Boolean if message was sent successfully.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq slack.post_message channel=\(dqDevelopment Room\(dq message=\(dqBuild is done\(dq from_name=\(dqBuild Server\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.slackware_service
.sp
The service module for Slackware
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage services on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqservice.start\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slackware_service.available(name)
Returns \fBTrue\fP if the specified service is available, otherwise returns
\fBFalse\fP\&.
.sp
New in version 3002.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.available sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slackware_service.disable(name, **kwargs)
Disable the named service to start at boot
.sp
New in version 3002.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slackware_service.disabled(name)
Return True if the named service is enabled, false otherwise
.sp
New in version 3002.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slackware_service.enable(name, **kwargs)
Enable the named service to start at boot
.sp
New in version 3002.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slackware_service.enabled(name, **kwargs)
Return True if the named service is enabled, false otherwise
.sp
New in version 3002.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slackware_service.force_reload(name)
Force\-reload the named service
.sp
New in version 3002.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.force_reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slackware_service.get_all()
Return all available boot services
.sp
New in version 3002.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slackware_service.get_disabled()
Return a set of services that are installed but disabled
.sp
New in version 3002.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_disabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slackware_service.get_enabled()
Return a list of service that are enabled on boot
.sp
New in version 3002.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slackware_service.missing(name)
The inverse of service.available.
Returns \fBTrue\fP if the specified service is not available, otherwise returns
\fBFalse\fP\&.
.sp
New in version 3002.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.missing sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slackware_service.reload_(name)
Reload the named service
.sp
New in version 3002.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slackware_service.restart(name)
Restart the named service
.sp
New in version 3002.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slackware_service.start(name)
Start the specified service
.sp
New in version 3002.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slackware_service.status(name, sig=None)
Return the status for a service.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.sp
New in version 3002.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.IP \(bu 2
\fBsig\fP (\fI\%str\fP) \-\- Signature to use to find the service via ps
.UNINDENT
.TP
.B Returns
True if running, False otherwise
dict: Maps service name to True if running, False otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name> [service signature]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slackware_service.stop(name)
Stop the specified service
.sp
New in version 3002.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.slsutil
.sp
Utility functions for use with or in SLS files
.INDENT 0.0
.TP
.B salt.modules.slsutil.banner(width=72, commentchar=\(aq#\(aq, borderchar=\(aq#\(aq, blockstart=None, blockend=None, title=None, text=None, newline=False)
Create a standardized comment block to include in a templated file.
.sp
A common technique in configuration management is to include a comment
block in managed files, warning users not to modify the file. This
function simplifies and standardizes those comment blocks.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBwidth\fP \-\- The width, in characters, of the banner. Default is 72.
.IP \(bu 2
\fBcommentchar\fP \-\- The character to be used in the starting position of
each line. This value should be set to a valid line comment character
for the syntax of the file in which the banner is being inserted.
Multiple character sequences, like \(aq//\(aq are supported.
If the file\(aqs syntax does not support line comments (such as XML),
use the \fBblockstart\fP and \fBblockend\fP options.
.IP \(bu 2
\fBborderchar\fP \-\- The character to use in the top and bottom border of
the comment box. Must be a single character.
.IP \(bu 2
\fBblockstart\fP \-\- The character sequence to use at the beginning of a
block comment. Should be used in conjunction with \fBblockend\fP
.IP \(bu 2
\fBblockend\fP \-\- The character sequence to use at the end of a
block comment. Should be used in conjunction with \fBblockstart\fP
.IP \(bu 2
\fBtitle\fP \-\- The first field of the comment block. This field appears
centered at the top of the box.
.IP \(bu 2
\fBtext\fP \-\- The second filed of the comment block. This field appears
left\-justified at the bottom of the box.
.IP \(bu 2
\fBnewline\fP \-\- Boolean value to indicate whether the comment block should
end with a newline. Default is \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBExample 1 \- the default banner:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt[\(aqslsutil.banner\(aq]() }}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
########################################################################
#                                                                      #
#              THIS FILE IS MANAGED BY SALT \- DO NOT EDIT              #
#                                                                      #
# The contents of this file are managed by Salt. Any changes to this   #
# file may be overwritten automatically and without warning.           #
########################################################################
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample 2 \- a Javadoc\-style banner:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt[\(aqslsutil.banner\(aq](commentchar=\(aq *\(aq, borderchar=\(aq*\(aq, blockstart=\(aq/**\(aq, blockend=\(aq */\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/**
 ***********************************************************************
 *                                                                     *
 *              THIS FILE IS MANAGED BY SALT \- DO NOT EDIT             *
 *                                                                     *
 * The contents of this file are managed by Salt. Any changes to this  *
 * file may be overwritten automatically and without warning.          *
 ***********************************************************************
 */
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample 3 \- custom text:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{{ set copyright=\(aqThis file may not be copied or distributed without permission of VMware, Inc.\(aq }}
{{ salt[\(aqslsutil.banner\(aq](title=\(aqCopyright 2019 VMware, Inc.\(aq, text=copyright, width=60) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
############################################################
#                                                          #
#              Copyright 2019 VMware, Inc.                 #
#                                                          #
# This file may not be copied or distributed without       #
# permission of VMware, Inc.                               #
############################################################
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slsutil.boolstr(value, true=\(aqtrue\(aq, false=\(aqfalse\(aq)
Convert a boolean value into a string. This function is
intended to be used from within file templates to provide
an easy way to take boolean values stored in Pillars or
Grains, and write them out in the appropriate syntax for
a particular file template.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvalue\fP \-\- The boolean value to be converted
.IP \(bu 2
\fBtrue\fP \-\- The value to return if \fBvalue\fP is \fBTrue\fP
.IP \(bu 2
\fBfalse\fP \-\- The value to return if \fBvalue\fP is \fBFalse\fP
.UNINDENT
.UNINDENT
.sp
In this example, a pillar named \fBsmtp:encrypted\fP stores a boolean
value, but the template that uses that value needs \fByes\fP or \fBno\fP
to be written, based on the boolean value.
.sp
\fINote: this is written on two lines for clarity. The same result
could be achieved in one line.\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set encrypted = salt[pillar.get](\(aqsmtp:encrypted\(aq, false) %}
use_tls: {{ salt[\(aqslsutil.boolstr\(aq](encrypted, \(aqyes\(aq, \(aqno\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Result (assuming the value is \fBTrue\fP):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
use_tls: yes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slsutil.deserialize(serializer, stream_or_string, **mod_kwargs)
Deserialize a Python object using one of the available
\fI\%serializer modules\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq slsutil.deserialize \(aqjson\(aq \(aq{\(dqfoo\(dq: \(dqFoo!\(dq}\(aq
salt \(aq*\(aq \-\-no\-parse=stream_or_string slsutil.deserialize \(aqjson\(aq \e
    stream_or_string=\(aq{\(dqfoo\(dq: \(dqFoo!\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Jinja Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set python_object = salt.slsutil.deserialize(\(aqjson\(aq,
    \(aq{\(dqfoo\(dq: \(dqFoo!\(dq}\(aq) %}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slsutil.dir_exists(path, saltenv=\(aqbase\(aq)
Return \fBTrue\fP if a directory exists in the state tree, \fBFalse\fP otherwise.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The fully qualified path to a directory in the state tree.
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- The fileserver environment to search. Default: \fBbase\fP
.UNINDENT
.UNINDENT
.sp
New in version 3004.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq slsutil.dir_exists nginx/files
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slsutil.file_exists(path, saltenv=\(aqbase\(aq)
Return \fBTrue\fP if a file exists in the state tree, \fBFalse\fP otherwise.
.sp
New in version 3004.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The fully qualified path to a file in the state tree.
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- The fileserver environment to search. Default: \fBbase\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq slsutil.file_exists nginx/defaults.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slsutil.findup(startpath, filenames, saltenv=\(aqbase\(aq)
Find the first path matching a filename or list of filenames in a specified
directory or the nearest ancestor directory. Returns the full path to the
first file found.
.sp
New in version 3004.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstartpath\fP (\fI\%str\fP) \-\- The fileserver path from which to begin the search.
An empty string refers to the state tree root.
.IP \(bu 2
\fBfilenames\fP \-\- A filename or list of filenames to search for. Searching for
directory names is also supported.
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- The fileserver environment to search. Default: \fBbase\fP
.UNINDENT
.UNINDENT
.sp
Example: return the path to \fBdefaults.yaml\fP, walking up the tree from the
state file currently being processed.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt[\(dqslsutil.findup\(dq](tplfile, \(dqdefaults.yaml\(dq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq slsutil.findup formulas/shared/nginx map.jinja
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slsutil.merge(obj_a, obj_b, strategy=\(aqsmart\(aq, renderer=\(aqyaml\(aq, merge_lists=False)
Merge a data structure into another by choosing a merge strategy
.sp
Strategies:
.INDENT 7.0
.IP \(bu 2
aggregate
.IP \(bu 2
list
.IP \(bu 2
overwrite
.IP \(bu 2
recurse
.IP \(bu 2
smart
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq slsutil.merge \(aq{foo: Foo}\(aq \(aq{bar: Bar}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slsutil.merge_all(lst, strategy=\(aqsmart\(aq, renderer=\(aqyaml\(aq, merge_lists=False)
New in version 2019.2.0.

.sp
Merge a list of objects into each other in order
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBlst\fP (\fIIterable\fP) \-\- List of objects to be merged.
.IP \(bu 2
\fBstrategy\fP (\fIString\fP) \-\- Merge strategy. See utils.dictupdate.
.IP \(bu 2
\fBrenderer\fP (\fIString\fP) \-\- Renderer type. Used to determine strategy when strategy is \(aqsmart\(aq.
.IP \(bu 2
\fBmerge_lists\fP (\fIBool\fP) \-\- Defines whether to merge embedded object lists.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-call \-\-output=txt slsutil.merge_all \(aq[{foo: Foo}, {foo: Bar}]\(aq
local: {u\(aqfoo\(aq: u\(aqBar\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slsutil.path_exists(path, saltenv=\(aqbase\(aq)
Return \fBTrue\fP if a path exists in the state tree, \fBFalse\fP otherwise. The path
could refer to a file or directory.
.sp
New in version 3004.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The fully qualified path to a file or directory in the state tree.
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- The fileserver environment to search. Default: \fBbase\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq slsutil.path_exists nginx/defaults.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slsutil.renderer(path=None, string=None, default_renderer=\(aqjinja|yaml\(aq, **kwargs)
Parse a string or file through Salt\(aqs renderer system
.sp
Changed in version 2018.3.0: Add support for Salt fileserver URIs.

.sp
This is an open\-ended function and can be used for a variety of tasks. It
makes use of Salt\(aqs \(dqrenderer pipes\(dq system to run a string or file through
a pipe of any of the loaded renderer modules.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP \-\- The path to a file on Salt\(aqs fileserver (any URIs supported by
\fI\%cp.get_url\fP) or on the local file
system.
.IP \(bu 2
\fBstring\fP \-\- An inline string to be used as the file to send through the
renderer system. Note, not all renderer modules can work with strings;
the \(aqpy\(aq renderer requires a file, for example.
.IP \(bu 2
\fBdefault_renderer\fP \-\- The renderer pipe to send the file through; this
is overridden by a \(dqshe\-bang\(dq at the top of the file.
.IP \(bu 2
\fBkwargs\fP \-\- Keyword args to pass to Salt\(aqs compile_template() function.
.UNINDENT
.UNINDENT
.sp
Keep in mind the goal of each renderer when choosing a render\-pipe; for
example, the Jinja renderer processes a text file and produces a string,
however the YAML renderer processes a text file and produces a data
structure.
.sp
One possible use is to allow writing \(dqmap files\(dq, as are commonly seen in
Salt formulas, but without tying the renderer of the map file to the
renderer used in the other sls files. In other words, a map file could use
the Python renderer and still be included and used by an sls file that uses
the default \(aqjinja|yaml\(aq renderer.
.sp
For example, the two following map files produce identical results but one
is written using the normal \(aqjinja|yaml\(aq and the other is using \(aqpy\(aq:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
#!jinja|yaml
{% set apache = salt.grains.filter_by({
    ...normal jinja map file here...
}, merge=salt.pillar.get(\(aqapache:lookup\(aq)) %}
{{ apache | yaml() }}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
#!py
def run():
    apache = __salt__.grains.filter_by({
        ...normal map here but as a python dict...
    }, merge=__salt__.pillar.get(\(aqapache:lookup\(aq))
    return apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Regardless of which of the above map files is used, it can be accessed from
any other sls file by calling this function. The following is a usage
example in Jinja:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set apache = salt.slsutil.renderer(\(aqmap.sls\(aq) %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq slsutil.renderer salt://path/to/file
salt \(aq*\(aq slsutil.renderer /path/to/file
salt \(aq*\(aq slsutil.renderer /path/to/file.jinja default_renderer=\(aqjinja\(aq
salt \(aq*\(aq slsutil.renderer /path/to/file.sls default_renderer=\(aqjinja|yaml\(aq
salt \(aq*\(aq slsutil.renderer string=\(aqInline template! {{ saltenv }}\(aq
salt \(aq*\(aq slsutil.renderer string=\(aqHello, {{ name }}.\(aq name=\(aqworld\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slsutil.serialize(serializer, obj, **mod_kwargs)
Serialize a Python object using one of the available
\fI\%serializer modules\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq \-\-no\-parse=obj slsutil.serialize \(aqjson\(aq obj=\(dq{\(aqfoo\(aq: \(aqFoo!\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Jinja Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set json_string = salt.slsutil.serialize(\(aqjson\(aq,
    {\(aqfoo\(aq: \(aqFoo!\(aq}) %}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.slsutil.update(dest, upd, recursive_update=True, merge_lists=False)
Merge \fBupd\fP recursively into \fBdest\fP
.sp
If \fBmerge_lists=True\fP, will aggregate list object types instead of
replacing. This behavior is only activated when \fBrecursive_update=True\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq slsutil.update \(aq{foo: Foo}\(aq \(aq{bar: Bar}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.smartos_imgadm
.sp
Module for running imgadm command on SmartOS
.INDENT 0.0
.TP
.B salt.modules.smartos_imgadm.avail(search=None, verbose=False)
Return a list of available images
.INDENT 7.0
.TP
.B search
string
search keyword
.TP
.B verbose
boolean (False)
toggle verbose output
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq imgadm.avail [percona]
salt \(aq*\(aq imgadm.avail verbose=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_imgadm.delete(uuid)
Remove an installed image
.INDENT 7.0
.TP
.B uuid
string
Specifies uuid to import
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq imgadm.delete e42f8c84\-bbea\-11e2\-b920\-078fab2aab1f
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_imgadm.docker_to_uuid(uuid)
Get the image uuid from an imported docker image
.sp
New in version 2019.2.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_imgadm.get(uuid)
Return info on an installed image
.INDENT 7.0
.TP
.B uuid
string
uuid of image
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq imgadm.get e42f8c84\-bbea\-11e2\-b920\-078fab2aab1f
salt \(aq*\(aq imgadm.get plexinc/pms\-docker:plexpass
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_imgadm.import_image(uuid, verbose=False)
Import an image from the repository
.INDENT 7.0
.TP
.B uuid
string
uuid to import
.TP
.B verbose
boolean (False)
toggle verbose output
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq imgadm.import e42f8c84\-bbea\-11e2\-b920\-078fab2aab1f [verbose=True]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_imgadm.list_installed(verbose=False)
Return a list of installed images
.INDENT 7.0
.TP
.B verbose
boolean (False)
toggle verbose output
.UNINDENT
.sp
Changed in version 2019.2.0: Docker images are now also listed

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq imgadm.list
salt \(aq*\(aq imgadm.list docker=True
salt \(aq*\(aq imgadm.list verbose=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_imgadm.show(uuid)
Show manifest of a given image
.INDENT 7.0
.TP
.B uuid
string
uuid of image
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq imgadm.show e42f8c84\-bbea\-11e2\-b920\-078fab2aab1f
salt \(aq*\(aq imgadm.show plexinc/pms\-docker:plexpass
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_imgadm.source_add(source, source_type=\(aqimgapi\(aq)
Add a new source
.INDENT 7.0
.TP
.B source
string
source url to add
.TP
.B source_trype
string (imgapi)
source type, either imgapi or docker
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq imgadm.source_add https://updates.joyent.com
salt \(aq*\(aq imgadm.source_add https://docker.io docker
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_imgadm.source_delete(source)
Delete a source
.INDENT 7.0
.TP
.B source
string
source url to delete
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq imgadm.source_delete https://updates.joyent.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_imgadm.sources(verbose=False)
Return a list of available sources
.INDENT 7.0
.TP
.B verbose
boolean (False)
toggle verbose output
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq imgadm.sources
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_imgadm.update_installed(uuid=\(aq\(aq)
Gather info on unknown image(s) (locally installed)
.INDENT 7.0
.TP
.B uuid
string
optional uuid of image
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq imgadm.update [uuid]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_imgadm.vacuum(verbose=False)
Remove unused images
.INDENT 7.0
.TP
.B verbose
boolean (False)
toggle verbose output
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq imgadm.vacuum [verbose=True]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_imgadm.version()
Return imgadm version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq imgadm.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.smartos_nictagadm
.sp
Module for running nictagadm command on SmartOS
:maintainer:    Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
:maturity:      new
:depends:       nictagadm binary, dladm binary
:platform:      smartos
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.modules.smartos_nictagadm.add(name, mac, mtu=1500)
Add a new nictag
.INDENT 7.0
.TP
.B name
string
name of new nictag
.TP
.B mac
string
mac of parent interface or \(aqetherstub\(aq to create a ether stub
.TP
.B mtu
int
MTU (ignored for etherstubs)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nictagadm.add storage0 etherstub
salt \(aq*\(aq nictagadm.add trunk0 \(aqDE:AD:OO:OO:BE:EF\(aq 9000
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_nictagadm.delete(name, force=False)
Delete nictag
.INDENT 7.0
.TP
.B name
string
nictag to delete
.TP
.B force
boolean
force delete even if vms attached
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nictagadm.exists admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_nictagadm.exists(*nictag, **kwargs)
Check if nictags exists
.INDENT 7.0
.TP
.B nictag
string
one or more nictags to check
.TP
.B verbose
boolean
return list of nictags
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nictagadm.exists admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_nictagadm.list_nictags(include_etherstubs=True)
List all nictags
.INDENT 7.0
.TP
.B include_etherstubs
boolean
toggle include of etherstubs
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nictagadm.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_nictagadm.update(name, mac=None, mtu=None)
Update a nictag
.INDENT 7.0
.TP
.B name
string
name of nictag
.TP
.B mac
string
optional new mac for nictag
.TP
.B mtu
int
optional new MTU for nictag
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nictagadm.update trunk mtu=9000
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_nictagadm.vms(nictag)
List all vms connect to nictag
.INDENT 7.0
.TP
.B nictag
string
name of nictag
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq nictagadm.vms admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.smartos_virt
.sp
virst compatibility module for managing VMs on SmartOS
.INDENT 0.0
.TP
.B salt.modules.smartos_virt.get_macs(domain)
Return a list off MAC addresses from the named VM
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.get_macs <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_virt.init(**kwargs)
Initialize a new VM
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.init image_uuid=\(aq...\(aq alias=\(aq...\(aq [...]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_virt.list_active_vms()
Return a list of uuids for active virtual machine on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.list_active_vms
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_virt.list_domains()
Return a list of virtual machine names on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.list_domains
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_virt.list_inactive_vms()
Return a list of uuids for inactive virtual machine on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.list_inactive_vms
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_virt.reboot(domain)
Reboot a domain via ACPI request
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.reboot <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_virt.setmem(domain, memory)
Change the amount of memory allocated to VM.
<memory> is to be specified in MB.
.sp
Note for KVM : this would require a restart of the VM.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.setmem <domain> 512
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_virt.shutdown(domain)
Send a soft shutdown signal to the named vm
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.shutdown <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_virt.start(domain)
Start a defined domain
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.start <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_virt.stop(domain)
Hard power down the virtual machine, this is equivalent to powering off the hardware.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.destroy <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_virt.vm_info(domain)
Return a dict with information about the specified VM on this CN
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.vm_info <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_virt.vm_virt_type(domain)
Return VM virtualization type : OS or KVM
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.vm_virt_type <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.smartos_vmadm
.sp
Module for running vmadm command on SmartOS
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.create(from_file=None, **kwargs)
Create a new vm
.INDENT 7.0
.TP
.B from_file
string
json file to create the vm from \-\- if present, all other options will be ignored
.TP
.B kwargs
string|int|...
options to set for the vm
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.create from_file=/tmp/new_vm.json
salt \(aq*\(aq vmadm.create image_uuid=\(aq...\(aq alias=\(aq...\(aq nics=\(aq[{ \(dqnic_tag\(dq: \(dqadmin\(dq, \(dqip\(dq: \(dq198.51.100.123\(dq, ...}, {...}]\(aq [...]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.create_snapshot(vm, name, key=\(aquuid\(aq)
Create snapshot of a vm
.INDENT 7.0
.TP
.B vm
string
vm to be targeted
.TP
.B name
string.INDENT 7.0
.TP
.B snapshot name
The snapname must be 64 characters or less
and must only contain alphanumeric characters and
characters in the set [\-_.:%] to comply with ZFS restrictions.
.UNINDENT
.TP
.B key
string [uuid|alias|hostname]
value type of \(aqvm\(aq parameter
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.create_snapshot 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543 baseline
salt \(aq*\(aq vmadm.create_snapshot nacl baseline key=alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.delete(vm, key=\(aquuid\(aq)
Delete a vm
.INDENT 7.0
.TP
.B vm
string
vm to be deleted
.TP
.B key
string [uuid|alias|hostname]
value type of \(aqvm\(aq parameter
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.delete 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543
salt \(aq*\(aq vmadm.delete nacl key=alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.delete_snapshot(vm, name, key=\(aquuid\(aq)
Delete snapshot of a vm
.INDENT 7.0
.TP
.B vm
string
vm to be targeted
.TP
.B name
string.INDENT 7.0
.TP
.B snapshot name
The snapname must be 64 characters or less
and must only contain alphanumeric characters and
characters in the set [\-_.:%] to comply with ZFS restrictions.
.UNINDENT
.TP
.B key
string [uuid|alias|hostname]
value type of \(aqvm\(aq parameter
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.delete_snapshot 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543 baseline
salt \(aq*\(aq vmadm.delete_snapshot nacl baseline key=alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.get(vm, key=\(aquuid\(aq)
Output the JSON object describing a VM
.INDENT 7.0
.TP
.B vm
string
vm to be targeted
.TP
.B key
string [uuid|alias|hostname]
value type of \(aqvm\(aq parameter
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.get 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543
salt \(aq*\(aq vmadm.get nacl key=alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.info(vm, info_type=\(aqall\(aq, key=\(aquuid\(aq)
Lookup info on running kvm
.INDENT 7.0
.TP
.B vm
string
vm to be targeted
.TP
.B info_type
string [all|block|blockstats|chardev|cpus|kvm|pci|spice|version|vnc]
info type to return
.TP
.B key
string [uuid|alias|hostname]
value type of \(aqvm\(aq parameter
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.info 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543
salt \(aq*\(aq vmadm.info 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543 vnc
salt \(aq*\(aq vmadm.info nacl key=alias
salt \(aq*\(aq vmadm.info nacl vnc key=alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.list_vms(search=None, sort=None, order=\(aquuid,type,ram,state,alias\(aq, keyed=True)
Return a list of VMs
.INDENT 7.0
.TP
.B search
string
vmadm filter property
.TP
.B sort
string
vmadm sort (\-s) property
.TP
.B order
string
vmadm order (\-o) property \-\- Default: uuid,type,ram,state,alias
.TP
.B keyed
boolean.INDENT 7.0
.TP
.B specified if the output should be an array (False) or dict (True)
For a dict the key is the first item from the order parameter.
Note: If key is not unique last vm wins.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.list
salt \(aq*\(aq vmadm.list order=alias,ram,cpu_cap sort=\-ram,\-cpu_cap
salt \(aq*\(aq vmadm.list search=\(aqtype=KVM\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.lookup(search=None, order=None, one=False)
Return a list of VMs using lookup
.INDENT 7.0
.TP
.B search
string
vmadm filter property
.TP
.B order
string
vmadm order (\-o) property \-\- Default: uuid,type,ram,state,alias
.TP
.B one
boolean
return only one result (vmadm\(aqs \-1)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.lookup search=\(aqstate=running\(aq
salt \(aq*\(aq vmadm.lookup search=\(aqstate=running\(aq order=uuid,alias,hostname
salt \(aq*\(aq vmadm.lookup search=\(aqalias=nacl\(aq one=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.reboot(vm, force=False, key=\(aquuid\(aq)
Reboot a vm
.INDENT 7.0
.TP
.B vm
string
vm to be rebooted
.TP
.B force
boolean
force reboot of vm if true
.TP
.B key
string [uuid|alias|hostname]
value type of \(aqvm\(aq parameter
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.reboot 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543
salt \(aq*\(aq vmadm.reboot 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543 True
salt \(aq*\(aq vmadm.reboot vm=nacl key=alias
salt \(aq*\(aq vmadm.reboot vm=nina.example.org key=hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.receive(uuid, source)
Receive a vm from a directory
.INDENT 7.0
.TP
.B uuid
string
uuid of vm to be received
.TP
.B source
string
source directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.receive 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543 /opt/backups
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.reprovision(vm, image, key=\(aquuid\(aq)
Reprovision a vm
.INDENT 7.0
.TP
.B vm
string
vm to be reprovisioned
.TP
.B image
string
uuid of new image
.TP
.B key
string [uuid|alias|hostname]
value type of \(aqvm\(aq parameter
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.reprovision 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543 c02a2044\-c1bd\-11e4\-bd8c\-dfc1db8b0182
salt \(aq*\(aq vmadm.reprovision nacl c02a2044\-c1bd\-11e4\-bd8c\-dfc1db8b0182 key=alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.rollback_snapshot(vm, name, key=\(aquuid\(aq)
Rollback snapshot of a vm
.INDENT 7.0
.TP
.B vm
string
vm to be targeted
.TP
.B name
string.INDENT 7.0
.TP
.B snapshot name
The snapname must be 64 characters or less
and must only contain alphanumeric characters and
characters in the set [\-_.:%] to comply with ZFS restrictions.
.UNINDENT
.TP
.B key
string [uuid|alias|hostname]
value type of \(aqvm\(aq parameter
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.rollback_snapshot 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543 baseline
salt \(aq*\(aq vmadm.rollback_snapshot nacl baseline key=alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.send(vm, target, key=\(aquuid\(aq)
Send a vm to a directory
.INDENT 7.0
.TP
.B vm
string
vm to be sent
.TP
.B target
string
target directory
.TP
.B key
string [uuid|alias|hostname]
value type of \(aqvm\(aq parameter
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.send 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543 /opt/backups
salt \(aq*\(aq vmadm.send vm=nacl target=/opt/backups key=alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.start(vm, options=None, key=\(aquuid\(aq)
Start a vm
.INDENT 7.0
.TP
.B vm
string
vm to be started
.TP
.B options
string
optional additional options
.TP
.B key
string [uuid|alias|hostname]
value type of \(aqvm\(aq parameter
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.start 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543
salt \(aq*\(aq vmadm.start 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543 \(aqorder=c,once=d cdrom=/path/to/image.iso,ide\(aq
salt \(aq*\(aq vmadm.start vm=nacl key=alias
salt \(aq*\(aq vmadm.start vm=nina.example.org key=hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.stop(vm, force=False, key=\(aquuid\(aq)
Stop a vm
.INDENT 7.0
.TP
.B vm
string
vm to be stopped
.TP
.B force
boolean
force stop of vm if true
.TP
.B key
string [uuid|alias|hostname]
value type of \(aqvm\(aq parameter
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.stop 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543
salt \(aq*\(aq vmadm.stop 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543 True
salt \(aq*\(aq vmadm.stop vm=nacl key=alias
salt \(aq*\(aq vmadm.stop vm=nina.example.org key=hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.sysrq(vm, action=\(aqnmi\(aq, key=\(aquuid\(aq)
Send non\-maskable interrupt to vm or capture a screenshot
.INDENT 7.0
.TP
.B vm
string
vm to be targeted
.TP
.B action
string
nmi or screenshot \-\- Default: nmi
.TP
.B key
string [uuid|alias|hostname]
value type of \(aqvm\(aq parameter
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.sysrq 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543 nmi
salt \(aq*\(aq vmadm.sysrq 186da9ab\-7392\-4f55\-91a5\-b8f1fe770543 screenshot
salt \(aq*\(aq vmadm.sysrq nacl nmi key=alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smartos_vmadm.update(vm, from_file=None, key=\(aquuid\(aq, **kwargs)
Update a new vm
.INDENT 7.0
.TP
.B vm
string
vm to be updated
.TP
.B from_file
string
json file to update the vm with \-\- if present, all other options will be ignored
.TP
.B key
string [uuid|alias|hostname]
value type of \(aqvm\(aq parameter
.TP
.B kwargs
string|int|...
options to update for the vm
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmadm.update vm=186da9ab\-7392\-4f55\-91a5\-b8f1fe770543 from_file=/tmp/new_vm.json
salt \(aq*\(aq vmadm.update vm=nacl key=alias from_file=/tmp/new_vm.json
salt \(aq*\(aq vmadm.update vm=186da9ab\-7392\-4f55\-91a5\-b8f1fe770543 max_physical_memory=1024
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.smbios
.sp
Interface to SMBIOS/DMI
.sp
(Parsing through dmidecode)
.SS External References
.nf
\fI\%Desktop Management Interface (DMI)\fP
\fI\%System Management BIOS\fP
\fI\%DMIdecode\fP
.fi
.sp
.INDENT 0.0
.TP
.B salt.modules.smbios.get(string, clean=True)
Get an individual DMI string from SMBIOS info
.INDENT 7.0
.TP
.B string
.INDENT 7.0
.TP
.B The string to fetch. DMIdecode supports:
.INDENT 7.0
.IP \(bu 2
\fBbios\-vendor\fP
.IP \(bu 2
\fBbios\-version\fP
.IP \(bu 2
\fBbios\-release\-date\fP
.IP \(bu 2
\fBsystem\-manufacturer\fP
.IP \(bu 2
\fBsystem\-product\-name\fP
.IP \(bu 2
\fBsystem\-version\fP
.IP \(bu 2
\fBsystem\-serial\-number\fP
.IP \(bu 2
\fBsystem\-uuid\fP
.IP \(bu 2
\fBbaseboard\-manufacturer\fP
.IP \(bu 2
\fBbaseboard\-product\-name\fP
.IP \(bu 2
\fBbaseboard\-version\fP
.IP \(bu 2
\fBbaseboard\-serial\-number\fP
.IP \(bu 2
\fBbaseboard\-asset\-tag\fP
.IP \(bu 2
\fBchassis\-manufacturer\fP
.IP \(bu 2
\fBchassis\-type\fP
.IP \(bu 2
\fBchassis\-version\fP
.IP \(bu 2
\fBchassis\-serial\-number\fP
.IP \(bu 2
\fBchassis\-asset\-tag\fP
.IP \(bu 2
\fBprocessor\-family\fP
.IP \(bu 2
\fBprocessor\-manufacturer\fP
.IP \(bu 2
\fBprocessor\-version\fP
.IP \(bu 2
\fBprocessor\-frequency\fP
.UNINDENT
.UNINDENT
.TP
.B clean
.nf
Don\(aqt return well\-known false information
(invalid UUID\(aqs, serial 000000000\(aqs, etcetera)
Defaults to \fBTrue\fP
.fi
.sp
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq smbios.get system\-uuid clean=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smbios.records(rec_type=None, fields=None, clean=True)
Return DMI records from SMBIOS
.INDENT 7.0
.TP
.B type
Return only records of type(s)
The SMBIOS specification defines the following DMI types:
.TS
center;
|l|l|.
_
T{
Type
T}	T{
Information
T}
_
T{
0
T}	T{
BIOS
T}
_
T{
1
T}	T{
System
T}
_
T{
2
T}	T{
Baseboard
T}
_
T{
3
T}	T{
Chassis
T}
_
T{
4
T}	T{
Processor
T}
_
T{
5
T}	T{
Memory Controller
T}
_
T{
6
T}	T{
Memory Module
T}
_
T{
7
T}	T{
Cache
T}
_
T{
8
T}	T{
Port Connector
T}
_
T{
9
T}	T{
System Slots
T}
_
T{
10
T}	T{
On Board Devices
T}
_
T{
11
T}	T{
OEM Strings
T}
_
T{
12
T}	T{
System Configuration Options
T}
_
T{
13
T}	T{
BIOS Language
T}
_
T{
14
T}	T{
Group Associations
T}
_
T{
15
T}	T{
System Event Log
T}
_
T{
16
T}	T{
Physical Memory Array
T}
_
T{
17
T}	T{
Memory Device
T}
_
T{
18
T}	T{
32\-bit Memory Error
T}
_
T{
19
T}	T{
Memory Array Mapped Address
T}
_
T{
20
T}	T{
Memory Device Mapped Address
T}
_
T{
21
T}	T{
Built\-in Pointing Device
T}
_
T{
22
T}	T{
Portable Battery
T}
_
T{
23
T}	T{
System Reset
T}
_
T{
24
T}	T{
Hardware Security
T}
_
T{
25
T}	T{
System Power Controls
T}
_
T{
26
T}	T{
Voltage Probe
T}
_
T{
27
T}	T{
Cooling Device
T}
_
T{
28
T}	T{
Temperature Probe
T}
_
T{
29
T}	T{
Electrical Current Probe
T}
_
T{
30
T}	T{
Out\-of\-band Remote Access
T}
_
T{
31
T}	T{
Boot Integrity Services
T}
_
T{
32
T}	T{
System Boot
T}
_
T{
33
T}	T{
64\-bit Memory Error
T}
_
T{
34
T}	T{
Management Device
T}
_
T{
35
T}	T{
Management Device Component
T}
_
T{
36
T}	T{
Management Device Threshold Data
T}
_
T{
37
T}	T{
Memory Channel
T}
_
T{
38
T}	T{
IPMI Device
T}
_
T{
39
T}	T{
Power Supply
T}
_
T{
40
T}	T{
Additional Information
T}
_
T{
41
T}	T{
Onboard Devices Extended Information
T}
_
T{
42
T}	T{
Management Controller Host Interface
T}
_
.TE
.TP
.B clean
.nf
Don\(aqt return well\-known false information
(invalid UUID\(aqs, serial 000000000\(aqs, etcetera)
Defaults to \fBTrue\fP
.fi
.sp
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq smbios.records clean=False
salt \(aq*\(aq smbios.records 14
salt \(aq*\(aq smbios.records 4 core_count,thread_count,current_speed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.smf_service
.sp
Service support for Solaris 10 and 11, should work with other systems
that use SMF also. (e.g. SmartOS)
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage services on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqservice.start\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.available(name)
Returns \fBTrue\fP if the specified service is available, otherwise returns
\fBFalse\fP\&.
.sp
We look up the name with the svcs command to get back the FMRI
This allows users to use simpler service names
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.available net\-snmp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.disable(name, **kwargs)
Disable the named service to start at boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.disabled(name)
Check to see if the named service is disabled to start on boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.enable(name, **kwargs)
Enable the named service to start at boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.enabled(name, **kwargs)
Check to see if the named service is enabled to start on boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.get_all()
Return all installed services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.get_disabled()
Return the disabled services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_disabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.get_enabled()
Return the enabled services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.get_running()
Return the running services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_running
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.get_stopped()
Return the stopped services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_stopped
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.missing(name)
The inverse of service.available.
Returns \fBTrue\fP if the specified service is not available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.missing net\-snmp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.reload_(name)
Reload the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.restart(name)
Restart the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.start(name)
Start the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.status(name, sig=None)
Return the status for a service.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.sp
Changed in version 2018.3.0: The service name can now be a glob (e.g. \fBsalt*\fP)

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.IP \(bu 2
\fBsig\fP (\fI\%str\fP) \-\- Not implemented
.UNINDENT
.TP
.B Returns
True if running, False otherwise
dict: Maps service name to True if running, False otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smf_service.stop(name)
Stop the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.smtp
.sp
Module for Sending Messages via SMTP
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
smtplib python module
.UNINDENT
.TP
.B configuration
This module can be used by either passing a jid and password
directly to send_message, or by specifying the name of a configuration
profile in the minion config, minion pillar, or master config.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my\-smtp\-login:
    smtp.server: smtp.domain.com
    smtp.tls: True
    smtp.sender: admin@domain.com
    smtp.username: myuser
    smtp.password: verybadpass
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The resourcename refers to the resource that is using this account. It is
user\-definable, and optional. The following configurations are both valid:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my\-smtp\-login:
    smtp.server: smtp.domain.com
    smtp.tls: True
    smtp.sender: admin@domain.com
    smtp.username: myuser
    smtp.password: verybadpass

another\-smtp\-login:
    smtp.server: smtp.domain.com
    smtp.tls: True
    smtp.sender: admin@domain.com
    smtp.username: myuser
    smtp.password: verybadpass
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.smtp.send_msg(recipient, message, subject=\(aqMessage from Salt\(aq, sender=None, server=None, use_ssl=\(aqTrue\(aq, username=None, password=None, profile=None, attachments=None)
Send a message to an SMTP recipient. To send a message to multiple     recipients, the recipients should be in a comma\-seperated Python string.     Designed for use in states.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq smtp.send_msg \(aqadmin@example.com\(aq \(aqThis is a salt module test\(aq profile=\(aqmy\-smtp\-account\(aq
salt \(aq*\(aq smtp.send_msg \(aqadmin@example.com,admin2@example.com\(aq \(aqThis is a salt module test for multiple recipients\(aq profile=\(aqmy\-smtp\-account\(aq
salt \(aq*\(aq smtp.send_msg \(aqadmin@example.com\(aq \(aqThis is a salt module test\(aq username=\(aqmyuser\(aq password=\(aqverybadpass\(aq sender=\(aqadmin@example.com\(aq server=\(aqsmtp.domain.com\(aq
salt \(aq*\(aq smtp.send_msg \(aqadmin@example.com\(aq \(aqThis is a salt module test\(aq username=\(aqmyuser\(aq password=\(aqverybadpass\(aq sender=\(aqadmin@example.com\(aq server=\(aqsmtp.domain.com\(aq attachments=\(dq[\(aq/var/log/messages\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.snapper
.sp
Module to manage filesystem snapshots with snapper
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B codeauthor
Duncan Mac\-Vicar P. <\fI\%dmacvicar@suse.de\fP>
.TP
.B codeauthor
Pablo Suárez Hernández <\fI\%psuarezhernandez@suse.de\fP>
.TP
.B depends
\fBdbus\fP Python module.
.TP
.B depends
\fBsnapper\fP \fI\%http://snapper.io\fP, available in most distros
.TP
.B maturity
new
.TP
.B platform
Linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.changed_files(config=\(aqroot\(aq, num_pre=None, num_post=None)
Returns the files changed between two snapshots
.INDENT 7.0
.TP
.B config
Configuration name.
.TP
.B num_pre
first snapshot ID to compare. Default is last snapshot
.TP
.B num_post
last snapshot ID to compare. Default is 0 (current state)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.changed_files
salt \(aq*\(aq snapper.changed_files num_pre=19 num_post=20
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.create_baseline(tag=\(aqbaseline\(aq, config=\(aqroot\(aq)
Creates a snapshot marked as baseline
.INDENT 7.0
.TP
.B tag
Tag name for the baseline
.TP
.B config
Configuration name.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.create_baseline
salt \(aq*\(aq snapper.create_baseline my_custom_baseline
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.create_config(name=None, subvolume=None, fstype=None, template=None, extra_opts=None)
Creates a new Snapper configuration
.INDENT 7.0
.TP
.B name
Name of the new Snapper configuration.
.TP
.B subvolume
Path to the related subvolume.
.TP
.B fstype
Filesystem type of the subvolume.
.TP
.B template
Configuration template to use. (Default: default)
.TP
.B extra_opts
Extra Snapper configuration opts dictionary. It will override the values provided
by the given template (if any).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.create_config name=myconfig subvolume=/foo/bar/ fstype=btrfs
salt \(aq*\(aq snapper.create_config name=myconfig subvolume=/foo/bar/ fstype=btrfs template=\(dqdefault\(dq
salt \(aq*\(aq snapper.create_config name=myconfig subvolume=/foo/bar/ fstype=btrfs extra_opts=\(aq{\(dqNUMBER_CLEANUP\(dq: False}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.create_snapshot(config=\(aqroot\(aq, snapshot_type=\(aqsingle\(aq, pre_number=None, description=None, cleanup_algorithm=\(aqnumber\(aq, userdata=None, **kwargs)
Creates an snapshot
.INDENT 7.0
.TP
.B config
Configuration name.
.TP
.B snapshot_type
Specifies the type of the new snapshot. Possible values are
single, pre and post.
.TP
.B pre_number
For post snapshots the number of the pre snapshot must be
provided.
.TP
.B description
Description for the snapshot. If not given, the salt job will be used.
.TP
.B cleanup_algorithm
Set the cleanup algorithm for the snapshot.
.TP
.B number
Deletes old snapshots when a certain number of snapshots
is reached.
.TP
.B timeline
Deletes old snapshots but keeps a number of hourly,
daily, weekly, monthly and yearly snapshots.
.TP
.B empty\-pre\-post
Deletes pre/post snapshot pairs with empty diffs.
.TP
.B userdata
Set userdata for the snapshot (key\-value pairs).
.UNINDENT
.sp
Returns the number of the created snapshot.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.create_snapshot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.delete_snapshot(snapshots_ids=None, config=\(aqroot\(aq)
Deletes an snapshot
.INDENT 7.0
.TP
.B config
Configuration name. (Default: root)
.TP
.B snapshots_ids
List of the snapshots IDs to be deleted.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.delete_snapshot 54
salt \(aq*\(aq snapper.delete_snapshot config=root 54
salt \(aq*\(aq snapper.delete_snapshot config=root snapshots_ids=[54,55,56]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.diff(config=\(aqroot\(aq, filename=None, num_pre=None, num_post=None)
Returns the differences between two snapshots
.INDENT 7.0
.TP
.B config
Configuration name.
.TP
.B filename
if not provided the showing differences between snapshots for
all \(dqtext\(dq files
.TP
.B num_pre
first snapshot ID to compare. Default is last snapshot
.TP
.B num_post
last snapshot ID to compare. Default is 0 (current state)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.diff
salt \(aq*\(aq snapper.diff filename=/var/log/snapper.log num_pre=19 num_post=20
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.diff_jid(jid, config=\(aqroot\(aq)
Returns the changes applied by a \fIjid\fP
.INDENT 7.0
.TP
.B jid
The job id to lookup
.TP
.B config
Configuration name.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.diff_jid jid=20160607130930720112
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.get_config(name=\(aqroot\(aq)
Retrieves all values from a given configuration
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.get_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.get_snapshot(number=0, config=\(aqroot\(aq)
Get detailed information about a given snapshot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.get_snapshot 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.list_configs()
List all available configs
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.list_configs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.list_snapshots(config=\(aqroot\(aq)
List available snapshots
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.list_snapshots config=myconfig
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.modify_snapshot(snapshot_id=None, description=None, userdata=None, cleanup=None, config=\(aqroot\(aq)
Modify attributes of an existing snapshot.
.INDENT 7.0
.TP
.B config
Configuration name. (Default: root)
.TP
.B snapshot_id
ID of the snapshot to be modified.
.TP
.B cleanup
Change the cleanup method of the snapshot. (str)
.TP
.B description
Change the description of the snapshot. (str)
.TP
.B userdata
Change the userdata dictionary of the snapshot. (dict)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.modify_snapshot 54 description=\(dqmy snapshot description\(dq
salt \(aq*\(aq snapper.modify_snapshot 54 description=\(dqmy snapshot description\(dq
salt \(aq*\(aq snapper.modify_snapshot 54 userdata=\(aq{\(dqfoo\(dq: \(dqbar\(dq}\(aq
salt \(aq*\(aq snapper.modify_snapshot snapshot_id=54 cleanup=\(dqnumber\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.run(function, *args, **kwargs)
Runs a function from an execution module creating pre and post snapshots
and associating the salt job id with those snapshots for easy undo and
cleanup.
.INDENT 7.0
.TP
.B function
Salt function to call.
.TP
.B config
Configuration name. (default: \(dqroot\(dq)
.TP
.B description
A description for the snapshots. (default: None)
.TP
.B userdata
Data to include in the snapshot metadata. (default: None)
.TP
.B cleanup_algorithm
Snapper cleanup algorithm. (default: \(dqnumber\(dq)
.TP
.B \fI*args\fP
args for the function to call. (default: None)
.TP
.B \fI**kwargs\fP
kwargs for the function to call (default: None)
.UNINDENT
.sp
This  would run append text to /etc/motd using the file.append
module, and will create two snapshots, pre and post with the associated
metadata. The jid will be available as salt_jid in the userdata of the
snapshot.
.sp
You can immediately see the changes
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.run file.append args=\(aq[\(dq/etc/motd\(dq, \(dqsome text\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.set_config(name=\(aqroot\(aq, **kwargs)
Set configuration values
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.set_config SYNC_ACL=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Keys are case insensitive as they will be always uppercased to snapper
convention. The above example is equivalent to:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.set_config sync_acl=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.status(config=\(aqroot\(aq, num_pre=None, num_post=None)
Returns a comparison between two snapshots
.INDENT 7.0
.TP
.B config
Configuration name.
.TP
.B num_pre
first snapshot ID to compare. Default is last snapshot
.TP
.B num_post
last snapshot ID to compare. Default is 0 (current state)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.status
salt \(aq*\(aq snapper.status num_pre=19 num_post=20
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.status_to_string(dbus_status)
Converts a numeric dbus snapper status into a string
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.status_to_string <dbus_status>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.undo(config=\(aqroot\(aq, files=None, num_pre=None, num_post=None)
Undo all file changes that happened between num_pre and num_post, leaving
the files into the state of num_pre.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
If one of the files has changes after num_post, they will be overwritten
The snapshots are used to determine the file list, but the current
version of the files will be overwritten by the versions in num_pre.
.sp
You to undo changes between num_pre and the current version of the
files use num_post=0.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.undo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.snapper.undo_jid(jid, config=\(aqroot\(aq)
Undo the changes applied by a salt job
.INDENT 7.0
.TP
.B jid
The job id to lookup
.TP
.B config
Configuration name.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq snapper.undo_jid jid=20160607130930720112
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.solaris_fmadm
.sp
Module for running fmadm and fmdump on Solaris
.INDENT 0.0
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B platform
solaris,illumos
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.modules.solaris_fmadm.acquit(fmri)
Acquit resource or acquit case
.INDENT 7.0
.TP
.B fmri: string
fmri or uuid
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq fmadm.acquit fmri | uuid
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_fmadm.config()
Display fault manager configuration
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq fmadm.config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_fmadm.faulty()
Display list of faulty resources
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq fmadm.faulty
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_fmadm.flush(fmri)
Flush cached state for resource
.INDENT 7.0
.TP
.B fmri: string
fmri
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq fmadm.flush fmri
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_fmadm.healthy()
Return whether fmadm is reporting faults
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq fmadm.healthy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_fmadm.list_records(after=None, before=None)
Display fault management logs
.INDENT 7.0
.TP
.B after
string
filter events after time, see man fmdump for format
.TP
.B before
string
filter events before time, see man fmdump for format
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq fmadm.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_fmadm.load(path)
Load specified fault manager module
.INDENT 7.0
.TP
.B path: string
path of fault manager module
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq fmadm.load /module/path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_fmadm.repaired(fmri)
Notify fault manager that resource has been repaired
.INDENT 7.0
.TP
.B fmri: string
fmri
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq fmadm.repaired fmri
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_fmadm.replaced(fmri)
Notify fault manager that resource has been replaced
.INDENT 7.0
.TP
.B fmri: string
fmri
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq fmadm.repaired fmri
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_fmadm.reset(module, serd=None)
Reset module or sub\-component
.INDENT 7.0
.TP
.B module: string
module to unload
.TP
.B serd
string
serd sub module
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq fmadm.reset software\-response
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_fmadm.show(uuid)
Display log details
.INDENT 7.0
.TP
.B uuid: string
uuid of fault
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq fmadm.show 11b4070f\-4358\-62fa\-9e1e\-998f485977e1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_fmadm.unload(module)
Unload specified fault manager module
.INDENT 7.0
.TP
.B module: string
module to unload
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq fmadm.unload software\-response
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.solaris_group
.sp
Manage groups on Solaris
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage groups on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqgroup.info\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_group.add(name, gid=None, **kwargs)
Add the specified group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.add foo 3456
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_group.chgid(name, gid)
Change the gid for a named group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.chgid foo 4376
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_group.delete(name)
Remove the named group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.delete foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_group.getent(refresh=False)
Return info on all groups
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.getent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_group.info(name)
Return information about a group
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.info foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.solaris_shadow
.sp
Manage the password database on Solaris systems
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage passwords on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqshadow.info\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_shadow.default_hash()
Returns the default hash used for unset passwords
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.default_hash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_shadow.del_password(name)
New in version 2015.8.8.

.sp
Delete the password from name user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.del_password username
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_shadow.gen_password(password, crypt_salt=None, algorithm=\(aqsha512\(aq)
New in version 2015.8.8.

.sp
Generate hashed password
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When called this function is called directly via remote\-execution,
the password argument may be displayed in the system\(aqs process list.
This may be a security risk on certain systems.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B password
Plaintext password to be hashed.
.TP
.B crypt_salt
Crpytographic salt. If not given, a random 8\-character salt will be
generated.
.TP
.B algorithm
The following hash algorithms are supported:
.INDENT 7.0
.IP \(bu 2
md5
.IP \(bu 2
blowfish (not in mainline glibc, only available in distros that add it)
.IP \(bu 2
sha256
.IP \(bu 2
sha512 (default)
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.gen_password \(aqI_am_password\(aq
salt \(aq*\(aq shadow.gen_password \(aqI_am_password\(aq crypt_salt=\(aqI_am_salt\(aq algorithm=sha256
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_shadow.info(name)
Return information for the specified user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.info root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_shadow.set_maxdays(name, maxdays)
Set the maximum number of days during which a password is valid. See man
passwd.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_maxdays username 90
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_shadow.set_mindays(name, mindays)
Set the minimum number of days between password changes. See man passwd.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_mindays username 7
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_shadow.set_password(name, password)
Set the password for a named user. The password must be a properly defined
hash, the password hash can be generated with this command:
\fBopenssl passwd \-1 <plaintext password>\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_password root $1$UYCIxa628.9qXjpQCjM4a..
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_shadow.set_warndays(name, warndays)
Set the number of days of warning before a password change is required.
See man passwd.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_warndays username 7
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.solaris_system
.sp
Support for reboot, shutdown, etc
.sp
This module is assumes we are using solaris\-like shutdown
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.modules.solaris_system.halt()
Halt a running system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.halt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_system.init(state)
Change the system runlevel on sysV compatible systems
.sp
CLI Example:
.INDENT 7.0
.TP
.B state
string
Init state
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.init 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_system.poweroff()
Poweroff a running system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.poweroff
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_system.reboot(delay=0, message=None)
Reboot the system
.INDENT 7.0
.TP
.B delay
int
Optional wait time in seconds before the system will be rebooted.
.TP
.B message
string
Optional message to broadcast before rebooting.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.reboot
salt \(aq*\(aq system.reboot 60 \(dq=== system upgraded ===\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_system.shutdown(delay=0, message=None)
Shutdown a running system
.INDENT 7.0
.TP
.B delay
int
Optional wait time in seconds before the system will be shutdown.
.TP
.B message
string
Optional message to broadcast before rebooting.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.shutdown
salt \(aq*\(aq system.shutdown 60 \(dq=== disk replacement ===\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.solaris_user
.sp
Manage users with the useradd command
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage users on a
minion, and it is using a different module (or gives an error similar to
\fI\(aquser.info\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.add(name, uid=None, gid=None, groups=None, home=None, shell=None, unique=True, fullname=\(aq\(aq, roomnumber=\(aq\(aq, workphone=\(aq\(aq, homephone=\(aq\(aq, createhome=True, **kwargs)
Add a user to the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.add name <uid> <gid> <groups> <home> <shell>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.chfullname(name, fullname)
Change the user\(aqs Full Name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chfullname foo \(dqFoo Bar\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.chgid(name, gid)
Change the default group of the user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chgid foo 4376
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.chgroups(name, groups, append=False)
Change the groups to which a user belongs
.INDENT 7.0
.TP
.B name
Username to modify
.TP
.B groups
List of groups to set for the user. Can be passed as a comma\-separated
list or a Python list.
.TP
.B append
False
Set to \fBTrue\fP to append these groups to the user\(aqs existing list of
groups. Otherwise, the specified groups will replace any existing
groups for the user.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chgroups foo wheel,root True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.chhome(name, home, persist=False)
Set a new home directory for an existing user
.INDENT 7.0
.TP
.B name
Username to modify
.TP
.B home
New home directory to set
.TP
.B persist
False
Set to \fBTrue\fP to prevent configuration files in the new home
directory from being overwritten by the files from the skeleton
directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chhome foo /home/users/foo True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.chhomephone(name, homephone)
Change the user\(aqs Home Phone
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chhomephone foo \(dq7735551234\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.chroomnumber(name, roomnumber)
Change the user\(aqs Room Number
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chroomnumber foo 123
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.chshell(name, shell)
Change the default shell of the user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chshell foo /bin/zsh
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.chuid(name, uid)
Change the uid for a named user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chuid foo 4376
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.chworkphone(name, workphone)
Change the user\(aqs Work Phone
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chworkphone foo \(dq7735550123\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.delete(name, remove=False, force=False)
Remove a user from the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.delete name remove=True force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.getent(refresh=False)
Return the list of all info for all users
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.getent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.info(name)
Return user information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.info root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.list_groups(name)
Return a list of groups the named user belongs to
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.list_groups foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.list_users()
Return a list of all users
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.list_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solaris_user.rename(name, new_name)
Change the username for a named user
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.rename name new_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.solarisipspkg
.sp
IPS pkg support for Solaris
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage packages on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
This module provides support for Solaris 11 new package management \- IPS (Image Packaging System).
This is the default pkg module for Solaris 11 (and later).
.sp
If you want to use also other packaging module (e.g. pkgutil) together with IPS, you need to override the \fBpkg\fP provider
in sls for each package:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mypackage:
  pkg.installed:
    \- provider: pkgutil
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or you can override it globally by setting the \fI\%providers\fP parameter in your Minion config file like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
providers:
  pkg: pkgutil
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or you can override it globally by setting the \fI\%providers\fP parameter in your Minion config file like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
providers:
  pkg: pkgutil
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarisipspkg.available_version(*names, **kwargs)
This function is an alias of \fBlatest_version\fP\&.
.INDENT 7.0
.INDENT 3.5
The available version of packages in the repository.
Accepts full or partial FMRI. Partial FMRI is returned if the full FMRI
could not be resolved.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
Please use pkg.latest_version as pkg.available_version is being deprecated.
.sp
Changed in version 2019.2.0: Support for multiple package names added.

.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version bash
salt \(aq*\(aq pkg.latest_version pkg://solaris/entire
salt \(aq*\(aq pkg.latest_version postfix sendmail
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarisipspkg.get_fmri(name, **kwargs)
Returns FMRI from partial name. Returns empty string (\(aq\(aq) if not found.
In case of multiple match, the function returns list of all matched packages.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.get_fmri bash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarisipspkg.install(name=None, refresh=False, pkgs=None, version=None, test=False, **kwargs)
Install the named package using the IPS pkg command.
Accepts full or partial FMRI.
.sp
Returns a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple Package Installation Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to install. Must be passed as a python list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install vim
salt \(aq*\(aq pkg.install pkg://solaris/editor/vim
salt \(aq*\(aq pkg.install pkg://solaris/editor/vim refresh=True
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarisipspkg.is_installed(name, **kwargs)
Returns True if the package is installed. Otherwise returns False.
Name can be full or partial FMRI.
In case of multiple match from partial FMRI name, it returns True.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.is_installed bash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarisipspkg.latest_version(*names, **kwargs)
The available version of packages in the repository.
Accepts full or partial FMRI. Partial FMRI is returned if the full FMRI
could not be resolved.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
Please use pkg.latest_version as pkg.available_version is being deprecated.
.sp
Changed in version 2019.2.0: Support for multiple package names added.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version bash
salt \(aq*\(aq pkg.latest_version pkg://solaris/entire
salt \(aq*\(aq pkg.latest_version postfix sendmail
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarisipspkg.list_pkgs(versions_as_list=False, **kwargs)
List the currently installed packages as a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarisipspkg.list_upgrades(refresh=True, **kwargs)
Lists all packages available for update.
.sp
When run in global zone, it reports only upgradable packages for the global
zone.
.sp
When run in non\-global zone, it can report more upgradable packages than
\fBpkg update \-vn\fP, because \fBpkg update\fP hides packages that require
newer version of \fBpkg://solaris/entire\fP (which means that they can be
upgraded only from the global zone). If \fBpkg://solaris/entire\fP is found
in the list of upgrades, then the global zone should be updated to get all
possible updates. Use \fBrefresh=True\fP to refresh the package database.
.INDENT 7.0
.TP
.B refresh
True
Runs a full package database refresh before listing. Set to \fBFalse\fP to
disable running the refresh.
.sp
Changed in version 2017.7.0.

.sp
In previous versions of Salt, \fBrefresh\fP defaulted to \fBFalse\fP\&. This was
changed to default to \fBTrue\fP in the 2017.7.0 release to make the behavior
more consistent with the other package modules, which all default to \fBTrue\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
salt \(aq*\(aq pkg.list_upgrades refresh=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarisipspkg.normalize_name(name, **kwargs)
Internal function. Normalizes pkg name to full FMRI before running
pkg.install. In case of multiple matches or no match, it returns the name
without modifications.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.normalize_name vim
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarisipspkg.purge(name, **kwargs)
Remove specified package. Accepts full or partial FMRI.
.sp
Returns a list containing the removed packages.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.purge <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarisipspkg.refresh_db(full=False, **kwargs)
Updates the remote repos database.
.sp
full : False
.INDENT 7.0
.INDENT 3.5
Set to \fBTrue\fP to force a refresh of the pkg DB from all publishers,
regardless of the last refresh time.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db
salt \(aq*\(aq pkg.refresh_db full=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarisipspkg.remove(name=None, pkgs=None, **kwargs)
Remove specified package. Accepts full or partial FMRI.
In case of multiple match, the command fails and won\(aqt modify the OS.
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
Returns a list containing the removed packages.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove tcsh
salt \(aq*\(aq pkg.remove pkg://solaris/shell/tcsh
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarisipspkg.search(name, versions_as_list=False, **kwargs)
Searches the repository for given pkg name.
The name can be full or partial FMRI. All matches are printed. Globs are
also supported.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search bash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarisipspkg.upgrade(refresh=False, **kwargs)
Upgrade all packages to the latest possible version.
When run in global zone, it updates also all non\-global zones.
In non\-global zones upgrade is limited by dependency constrains linked to
the version of pkg://solaris/entire.
.sp
Returns a dictionary containing the changes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq:  {\(aqold\(aq: \(aq<old\-version>\(aq,
                \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When there is a failure, an explanation is also included in the error
message, based on the return code of the \fBpkg update\fP command.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarisipspkg.upgrade_available(name, **kwargs)
Check if there is an upgrade available for a certain package
Accepts full or partial FMRI. Returns all matches found.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade_available apache\-22
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarisipspkg.version(*names, **kwargs)
Common interface for obtaining the version of installed packages.
Accepts full or partial FMRI. If called using pkg_resource, full FMRI is required.
Partial FMRI is returned if the package is not installed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version vim
salt \(aq*\(aq pkg.version foo bar baz
salt \(aq*\(aq pkg_resource.version pkg://solaris/entire
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.solarispkg
.sp
Package support for Solaris
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage packages on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarispkg.available_version(*names, **kwargs)
This function is an alias of \fBlatest_version\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
NOTE: As package repositories are not presently supported for Solaris
pkgadd, this function will always return an empty string for a given
package.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarispkg.install(name=None, sources=None, saltenv=\(aqbase\(aq, **kwargs)
Install the passed package. Can install packages from the following
sources:
.INDENT 7.0
.IP \(bu 2
Locally (package already exists on the minion
.IP \(bu 2
HTTP/HTTPS server
.IP \(bu 2
FTP server
.IP \(bu 2
Salt master
.UNINDENT
.sp
Returns a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Installing a data stream pkg that already exists on the minion

salt \(aq*\(aq pkg.install sources=\(aq[{\(dq<pkg name>\(dq: \(dq/dir/on/minion/<pkg filename>\(dq}]\(aq
salt \(aq*\(aq pkg.install sources=\(aq[{\(dqSMClgcc346\(dq: \(dq/var/spool/pkg/gcc\-3.4.6\-sol10\-sparc\-local.pkg\(dq}]\(aq

# Installing a data stream pkg that exists on the salt master

salt \(aq*\(aq pkg.install sources=\(aq[{\(dq<pkg name>\(dq: \(dqsalt://pkgs/<pkg filename>\(dq}]\(aq
salt \(aq*\(aq pkg.install sources=\(aq[{\(dqSMClgcc346\(dq: \(dqsalt://pkgs/gcc\-3.4.6\-sol10\-sparc\-local.pkg\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Installing a data stream pkg that exists on a HTTP server
salt \(aq*\(aq pkg.install sources=\(aq[{\(dq<pkg name>\(dq: \(dqhttp://packages.server.com/<pkg filename>\(dq}]\(aq
salt \(aq*\(aq pkg.install sources=\(aq[{\(dqSMClgcc346\(dq: \(dqhttp://packages.server.com/gcc\-3.4.6\-sol10\-sparc\-local.pkg\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If working with solaris zones and you want to install a package only in the
global zone you can pass \(aqcurrent_zone_only=True\(aq to salt to have the
package only installed in the global zone. (Behind the scenes this is
passing \(aq\-G\(aq to the pkgadd command.) Solaris default when installing a
package in the global zone is to install it in all zones. This overrides
that and installs the package only in the global.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Installing a data stream package only in the global zone:
salt \(aqglobal_zone\(aq pkg.install sources=\(aq[{\(dqSMClgcc346\(dq: \(dq/var/spool/pkg/gcc\-3.4.6\-sol10\-sparc\-local.pkg\(dq}]\(aq current_zone_only=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default salt automatically provides an adminfile, to automate package
installation, with these options set:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
email=
instance=quit
partial=nocheck
runlevel=nocheck
idepend=nocheck
rdepend=nocheck
space=nocheck
setuid=nocheck
conflict=nocheck
action=nocheck
basedir=default
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can override any of these options in two ways. First you can optionally
pass any of the options as a kwarg to the module/state to override the
default value or you can optionally pass the \(aqadmin_source\(aq option
providing your own adminfile to the minions.
.sp
Note: You can find all of the possible options to provide to the adminfile
by reading the admin man page:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
man \-s 4 admin
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Overriding the \(aqinstance\(aq adminfile option when calling the module directly
salt \(aq*\(aq pkg.install sources=\(aq[{\(dq<pkg name>\(dq: \(dqsalt://pkgs/<pkg filename>\(dq}]\(aq instance=\(dqoverwrite\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Overriding the \(aqinstance\(aq adminfile option when used in a state

SMClgcc346:
  pkg.installed:
    \- sources:
      \- SMClgcc346: salt://srv/salt/pkgs/gcc\-3.4.6\-sol10\-sparc\-local.pkg
    \- instance: overwrite
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The ID declaration is ignored, as the package name is read from the
\fBsources\fP parameter.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Providing your own adminfile when calling the module directly

salt \(aq*\(aq pkg.install sources=\(aq[{\(dq<pkg name>\(dq: \(dqsalt://pkgs/<pkg filename>\(dq}]\(aq admin_source=\(aqsalt://pkgs/<adminfile filename>\(aq

# Providing your own adminfile when using states

<pkg name>:
  pkg.installed:
    \- sources:
      \- <pkg name>: salt://pkgs/<pkg filename>
    \- admin_source: salt://pkgs/<adminfile filename>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The ID declaration is ignored, as the package name is read from the
\fBsources\fP parameter.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarispkg.latest_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
NOTE: As package repositories are not presently supported for Solaris
pkgadd, this function will always return an empty string for a given
package.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarispkg.list_pkgs(versions_as_list=False, **kwargs)
List the packages currently installed as a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarispkg.purge(name=None, pkgs=None, **kwargs)
Package purges are not supported, this function is identical to
\fBremove()\fP\&.
.INDENT 7.0
.TP
.B name
The name of the package to be deleted
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.purge <package name>
salt \(aq*\(aq pkg.purge <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.purge pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarispkg.remove(name=None, pkgs=None, saltenv=\(aqbase\(aq, **kwargs)
Remove packages with pkgrm
.INDENT 7.0
.TP
.B name
The name of the package to be deleted
.UNINDENT
.sp
By default salt automatically provides an adminfile, to automate package
removal, with these options set:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
email=
instance=quit
partial=nocheck
runlevel=nocheck
idepend=nocheck
rdepend=nocheck
space=nocheck
setuid=nocheck
conflict=nocheck
action=nocheck
basedir=default
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can override any of these options in two ways. First you can optionally
pass any of the options as a kwarg to the module/state to override the
default value or you can optionally pass the \(aqadmin_source\(aq option
providing your own adminfile to the minions.
.sp
Note: You can find all of the possible options to provide to the adminfile
by reading the admin man page:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
man \-s 4 admin
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove SUNWgit
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarispkg.upgrade_available(name, **kwargs)
Check whether or not an upgrade is available for a given package
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade_available <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solarispkg.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.solr
.sp
Apache Solr Salt Module
.sp
Author: Jed Glazner
Version: 0.2.1
Modified: 12/09/2011
.sp
This module uses HTTP requests to talk to the apache solr request handlers
to gather information and report errors. Because of this the minion doesn\(aqt
necessarily need to reside on the actual slave.  However if you want to
use the signal function the minion must reside on the physical solr host.
.sp
This module supports multi\-core and standard setups.  Certain methods are
master/slave specific.  Make sure you set the solr.type. If you have
questions or want a feature request please ask.
.SS Coming Features in 0.3
.INDENT 0.0
.IP 1. 3
Add command for checking for replication failures on slaves
.IP 2. 3
Improve match_index_versions since it\(aqs pointless on busy solr masters
.IP 3. 3
Add additional local fs checks for backups to make sure they succeeded
.UNINDENT
.SS Override these in the minion config
.INDENT 0.0
.TP
.B solr.cores
A list of core names e.g. [\(aqcore1\(aq,\(aqcore2\(aq].
An empty list indicates non\-multicore setup.
.TP
.B solr.baseurl
The root level URL to access solr via HTTP
.TP
.B solr.request_timeout
The number of seconds before timing out an HTTP/HTTPS/FTP request. If
nothing is specified then the python global timeout setting is used.
.TP
.B solr.type
Possible values are \(aqmaster\(aq or \(aqslave\(aq
.TP
.B solr.backup_path
The path to store your backups. If you are using cores and you can specify
to append the core name to the path in the backup method.
.TP
.B solr.num_backups
For versions of solr >= 3.5. Indicates the number of backups to keep. This
option is ignored if your version is less.
.TP
.B solr.init_script
The full path to your init script with start/stop options
.TP
.B solr.dih.options
A list of options to pass to the DIH.
.UNINDENT
.SS Required Options for DIH
.INDENT 0.0
.TP
.B clean
False
Clear the index before importing
.TP
.B commit
True
Commit the documents to the index upon completion
.TP
.B optimize
True
Optimize the index after commit is complete
.TP
.B verbose
True
Get verbose output
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.abort_import(handler, host=None, core_name=None, verbose=False)
MASTER ONLY
Aborts an existing import command to the specified handler.
This command can only be run if the minion is configured with
solr.type=master
.INDENT 7.0
.TP
.B handler
str
The name of the data import handler.
.TP
.B host
str (None)
The solr host to query. __opts__[\(aqhost\(aq] is default.
.TP
.B core
str (None)
The core the handler belongs to.
.TP
.B verbose
boolean (False)
Run the command with verbose output.
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.abort_import dataimport None music {\(aqclean\(aq:True}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.backup(host=None, core_name=None, append_core_to_path=False)
Tell solr make a backup.  This method can be mis\-leading since it uses the
backup API.  If an error happens during the backup you are not notified.
The status: \(aqOK\(aq in the response simply means that solr received the
request successfully.
.INDENT 7.0
.TP
.B host
str (None)
The solr host to query. __opts__[\(aqhost\(aq] is default.
.TP
.B core_name
str (None)
The name of the solr core if using cores. Leave this blank if you are
not using cores or if you want to check all cores.
.TP
.B append_core_to_path
boolean (False)
If True add the name of the core to the backup path. Assumes that
minion backup path is not None.
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.backup music
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.core_status(host=None, core_name=None)
MULTI\-CORE HOSTS ONLY
Get the status for a given core or all cores if no core is specified
.INDENT 7.0
.TP
.B host
str (None)
The solr host to query. __opts__[\(aqhost\(aq] is default.
.TP
.B core_name
str
The name of the core to reload
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.core_status None music
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.delta_import(handler, host=None, core_name=None, options=None, extra=None)
Submits an import command to the specified handler using specified options.
This command can only be run if the minion is configured with
solr.type=master
.INDENT 7.0
.TP
.B handler
str
The name of the data import handler.
.TP
.B host
str (None)
The solr host to query. __opts__[\(aqhost\(aq] is default.
.TP
.B core
str (None)
The core the handler belongs to.
.TP
.B options
dict (__opts__)
A list of options such as clean, optimize commit, verbose, and
pause_replication. leave blank to use __opts__ defaults. options will
be merged with __opts__
.TP
.B extra
dict ([])
Extra name value pairs to pass to the handler. e.g. [\(dqname=value\(dq]
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.delta_import dataimport None music {\(aqclean\(aq:True}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.full_import(handler, host=None, core_name=None, options=None, extra=None)
MASTER ONLY
Submits an import command to the specified handler using specified options.
This command can only be run if the minion is configured with
solr.type=master
.INDENT 7.0
.TP
.B handler
str
The name of the data import handler.
.TP
.B host
str (None)
The solr host to query. __opts__[\(aqhost\(aq] is default.
.TP
.B core
str (None)
The core the handler belongs to.
.TP
.B options
dict (__opts__)
A list of options such as clean, optimize commit, verbose, and
pause_replication. leave blank to use __opts__ defaults. options will
be merged with __opts__
.TP
.B extra
dict ([])
Extra name value pairs to pass to the handler. e.g. [\(dqname=value\(dq]
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.full_import dataimport None music {\(aqclean\(aq:True}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.import_status(handler, host=None, core_name=None, verbose=False)
Submits an import command to the specified handler using specified options.
This command can only be run if the minion is configured with
solr.type: \(aqmaster\(aq
.INDENT 7.0
.TP
.B handler
str
The name of the data import handler.
.TP
.B host
str (None)
The solr host to query. __opts__[\(aqhost\(aq] is default.
.TP
.B core
str (None)
The core the handler belongs to.
.TP
.B verbose
boolean (False)
Specifies verbose output
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.import_status dataimport None music False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.is_replication_enabled(host=None, core_name=None)
SLAVE CALL
Check for errors, and determine if a slave is replicating or not.
.INDENT 7.0
.TP
.B host
str (None)
The solr host to query. __opts__[\(aqhost\(aq] is default.
.TP
.B core_name
str (None)
The name of the solr core if using cores. Leave this blank if you are
not using cores or if you want to check all cores.
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.is_replication_enabled music
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.lucene_version(core_name=None)
Gets the lucene version that solr is using. If you are running a multi\-core
setup you should specify a core name since all the cores run under the same
servlet container, they will all have the same version.
.INDENT 7.0
.TP
.B core_name
str (None)
The name of the solr core if using cores. Leave this blank if you are
not using cores or if you want to check all cores.
.UNINDENT
.sp
Return: dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.lucene_version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.match_index_versions(host=None, core_name=None)
SLAVE CALL
Verifies that the master and the slave versions are in sync by
comparing the index version. If you are constantly pushing updates
the index the master and slave versions will seldom match. A solution
to this is pause indexing every so often to allow the slave to replicate
and then call this method before allowing indexing to resume.
.INDENT 7.0
.TP
.B host
str (None)
The solr host to query. __opts__[\(aqhost\(aq] is default.
.TP
.B core_name
str (None)
The name of the solr core if using cores. Leave this blank if you are
not using cores or if you want to check all cores.
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.match_index_versions music
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.optimize(host=None, core_name=None)
Search queries fast, but it is a very expensive operation. The ideal
process is to run this with a master/slave configuration.  Then you
can optimize the master, and push the optimized index to the slaves.
If you are running a single solr instance, or if you are going to run
this on a slave be aware than search performance will be horrible
while this command is being run. Additionally it can take a LONG time
to run and your HTTP request may timeout. If that happens adjust your
timeout settings.
.INDENT 7.0
.TP
.B host
str (None)
The solr host to query. __opts__[\(aqhost\(aq] is default.
.TP
.B core_name
str (None)
The name of the solr core if using cores. Leave this blank if you are
not using cores or if you want to check all cores.
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.optimize music
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.ping(host=None, core_name=None)
Does a health check on solr, makes sure solr can talk to the indexes.
.INDENT 7.0
.TP
.B host
str (None)
The solr host to query. __opts__[\(aqhost\(aq] is default.
.TP
.B core_name
str (None)
The name of the solr core if using cores. Leave this blank if you are
not using cores or if you want to check all cores.
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.ping music
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.reload_core(host=None, core_name=None)
MULTI\-CORE HOSTS ONLY
Load a new core from the same configuration as an existing registered core.
While the \(dqnew\(dq core is initializing, the \(dqold\(dq one will continue to accept
requests. Once it has finished, all new request will go to the \(dqnew\(dq core,
and the \(dqold\(dq core will be unloaded.
.INDENT 7.0
.TP
.B host
str (None)
The solr host to query. __opts__[\(aqhost\(aq] is default.
.TP
.B core_name
str
The name of the core to reload
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.reload_core None music
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Return data is in the following format:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:bool, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.reload_import_config(handler, host=None, core_name=None, verbose=False)
MASTER ONLY
re\-loads the handler config XML file.
This command can only be run if the minion is a \(aqmaster\(aq type
.INDENT 7.0
.TP
.B handler
str
The name of the data import handler.
.TP
.B host
str (None)
The solr host to query. __opts__[\(aqhost\(aq] is default.
.TP
.B core
str (None)
The core the handler belongs to.
.TP
.B verbose
boolean (False)
Run the command with verbose output.
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.reload_import_config dataimport None music {\(aqclean\(aq:True}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.replication_details(host=None, core_name=None)
Get the full replication details.
.INDENT 7.0
.TP
.B host
str (None)
The solr host to query. __opts__[\(aqhost\(aq] is default.
.TP
.B core_name
str (None)
The name of the solr core if using cores. Leave this blank if you are
not using cores or if you want to check all cores.
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.replication_details music
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.set_is_polling(polling, host=None, core_name=None)
SLAVE CALL
Prevent the slaves from polling the master for updates.
.INDENT 7.0
.TP
.B polling
boolean
True will enable polling. False will disable it.
.TP
.B host
str (None)
The solr host to query. __opts__[\(aqhost\(aq] is default.
.TP
.B core_name
str (None)
The name of the solr core if using cores. Leave this blank if you are
not using cores or if you want to check all cores.
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.set_is_polling False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.set_replication_enabled(status, host=None, core_name=None)
MASTER ONLY
Sets the master to ignore poll requests from the slaves. Useful when you
don\(aqt want the slaves replicating during indexing or when clearing the
index.
.INDENT 7.0
.TP
.B status
boolean
Sets the replication status to the specified state.
.TP
.B host
str (None)
The solr host to query. __opts__[\(aqhost\(aq] is default.
.TP
.B core_name
str (None)
The name of the solr core if using cores. Leave this blank if you are
not using cores or if you want to set the status on all cores.
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.set_replication_enabled false, None, music
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.signal(signal=None)
Signals Apache Solr to start, stop, or restart. Obviously this is only
going to work if the minion resides on the solr host. Additionally Solr
doesn\(aqt ship with an init script so one must be created.
.INDENT 7.0
.TP
.B signal
str (None)
The command to pass to the apache solr init valid values are \(aqstart\(aq,
\(aqstop\(aq, and \(aqrestart\(aq
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.signal restart
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solr.version(core_name=None)
Gets the solr version for the core specified.  You should specify a core
here as all the cores will run under the same servlet container and so will
all have the same version.
.INDENT 7.0
.TP
.B core_name
str (None)
The name of the solr core if using cores. Leave this blank if you are
not using cores or if you want to check all cores.
.UNINDENT
.sp
Return : dict<str,obj>:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsuccess\(aq:boolean, \(aqdata\(aq:dict, \(aqerrors\(aq:list, \(aqwarnings\(aq:list}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solr.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.solrcloud
.sp
Module for solrcloud configuration
.sp
New in version 2017.7.0.

.sp
For now, module is limited to http\-exposed API. It doesn\(aqt implement config upload via Solr zkCli
.INDENT 0.0
.TP
.B salt.modules.solrcloud.BOOL_PROPS_LIST  =  [\(aqtransient\(aq, \(aqloadOnStartup\(aq]
Collections options type definition
Reference: \fI\%https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI\-api1\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.DICT_OPTIONS_LIST  =  [\(aqproperties\(aq]
Collection unmodifiable options
Reference: \fI\%https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI\-modifycoll\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.alias_exists(alias_name, **kwargs)
Check alias existence
.sp
Additional parameters (kwargs) may be passed, they will be proxied to http.query
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.alias_exists my_alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.alias_get_collections(alias_name, **kwargs)
Get collection list for an alias
.sp
Additional parameters (kwargs) may be passed, they will be proxied to http.query
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.alias_get my_alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.alias_set_collections(alias_name, collections=None, **kwargs)
Define an alias
.sp
Additional parameters (kwargs) may be passed, they will be proxied to http.query
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.alias_set my_alias collections=[collection1, colletion2]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.cluster_status(**kwargs)
Get cluster status
.sp
Additional parameters (kwargs) may be passed, they will be proxied to http.query
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.cluster_status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.collection_backup(collection_name, location, backup_name=None, **kwargs)
Create a backup for a collection.
.sp
Additional parameters (kwargs) may be passed, they will be proxied to http.query
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.core_backup collection_name /mnt/nfs_backup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.collection_backup_all(location, backup_name=None, **kwargs)
Create a backup for all collection present on the server.
.sp
Additional parameters (kwargs) may be passed, they will be proxied to http.query
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.core_backup /mnt/nfs_backup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.collection_check_options(options)
Check collections options
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.collection_check_options \(aq{\(dqreplicationFactor\(dq:4}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.collection_create(collection_name, options=None, **kwargs)
Create a collection,
.sp
Additional parameters (kwargs) may be passed, they will be proxied to http.query
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.collection_create collection_name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Collection creation options may be passed using the \(dqoptions\(dq parameter.
Do not include option \(dqname\(dq since it already specified by the mandatory parameter \(dqcollection_name\(dq
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.collection_create collection_name options={\(dqreplicationFactor\(dq:2, \(dqnumShards\(dq:3}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Cores options may be passed using the \(dqproperties\(dq key in options.
Do not include property \(dqname\(dq
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.collection_create collection_name options={\(dqreplicationFactor\(dq:2, \(dqnumShards\(dq:3,             \(dqproperties\(dq:{\(dqdataDir\(dq:\(dq/srv/solr/hugePartitionSollection\(dq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.collection_creation_options()
Get collection option list that can only be defined at creation
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.collection_creation_options
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.collection_exists(collection_name, **kwargs)
Check if a collection exists
.sp
Additional parameters (kwargs) may be passed, they will be proxied to http.query
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.collection_exists collection_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.collection_get_options(collection_name, **kwargs)
Get collection options
.sp
Additional parameters (kwargs) may be passed, they will be proxied to http.query
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.collection_get_options collection_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.collection_list(**kwargs)
List all collections
.sp
Additional parameters (kwargs) may be passed, they will be proxied to http.query
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.collection_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.collection_reload(collection, **kwargs)
Check if a collection exists
.sp
Additional parameters (kwargs) may be passed, they will be proxied to http.query
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.collection_reload collection_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.collection_set_options(collection_name, options, **kwargs)
Change collection options
.sp
Additional parameters (kwargs) may be passed, they will be proxied to http.query
.sp
Note that not every parameter can be changed after collection creation
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq solrcloud.collection_set_options collection_name options={\(dqreplicationFactor\(dq:4}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.solrcloud.log  =  <SaltLoggingClass salt.modules.solrcloud (GARBAGE)>
Core properties type definition.
Reference: \fI\%https://cwiki.apache.org/confluence/display/solr/Defining+core.properties\fP
.UNINDENT
.SS salt.modules.splunk
.sp
Module for interop with the Splunk API
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
splunk\-sdk python module
.UNINDENT
.TP
.B configuration
Configure this module by specifying the name of a configuration
profile in the minion config, minion pillar, or master config. The module
will use the \(aqsplunk\(aq key by default, if defined.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
splunk:
    username: alice
    password: abc123
    host: example.splunkcloud.com
    port: 8080
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.splunk.create_user(email, profile=\(aqsplunk\(aq, **kwargs)
create a splunk user by name/email
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion splunk.create_user user@example.com roles=[\(aquser\(aq] realname=\(dqTest User\(dq name=testuser
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.splunk.delete_user(email, profile=\(aqsplunk\(aq)
Delete a splunk user by email
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion splunk_user.delete \(aquser@example.com\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.splunk.get_user(email, profile=\(aqsplunk\(aq, **kwargs)
Get a splunk user by name/email
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion splunk.get_user \(aquser@example.com\(aq user_details=false
salt myminion splunk.get_user \(aquser@example.com\(aq user_details=true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.splunk.list_users(profile=\(aqsplunk\(aq)
List all users in the splunk DB
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion splunk.list_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.splunk.update_user(email, profile=\(aqsplunk\(aq, **kwargs)
Create a splunk user by email
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion splunk.update_user example@domain.com roles=[\(aquser\(aq] realname=\(dqTest User\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.splunk_search
.sp
Module for interop with the Splunk API
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
splunk\-sdk python module
.UNINDENT
.TP
.B configuration
Configure this module by specifying the name of a configuration
profile in the minion config, minion pillar, or master config. The module
will use the \(aqsplunk\(aq key by default, if defined.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
splunk:
    username: alice
    password: abc123
    host: example.splunkcloud.com
    port: 8080
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.splunk_search.create(name, profile=\(aqsplunk\(aq, **kwargs)
Create a splunk search
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
splunk_search.create \(aqmy search name\(aq search=\(aqerror msg\(aq
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.splunk_search.delete(name, profile=\(aqsplunk\(aq)
Delete a splunk search
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
splunk_search.delete \(aqmy search name\(aq
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.splunk_search.get(name, profile=\(aqsplunk\(aq)
Get a splunk search
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
splunk_search.get \(aqmy search name\(aq
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.splunk_search.list_(profile=\(aqsplunk\(aq)
List splunk searches (names only)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
splunk_search.list
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.splunk_search.list_all(prefix=None, app=None, owner=None, description_contains=None, name_not_contains=None, profile=\(aqsplunk\(aq)
Get all splunk search details. Produces results that can be used to create
an sls file.
.sp
if app or owner are specified, results will be limited to matching saved
searches.
.sp
if description_contains is specified, results will be limited to those
where \(dqdescription_contains in description\(dq is true if name_not_contains is
specified, results will be limited to those where \(dqname_not_contains not in
name\(dq is true.
.sp
If prefix parameter is given, alarm names in the output will be prepended
with the prefix; alarms that have the prefix will be skipped. This can be
used to convert existing alarms to be managed by salt, as follows:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP 1. 3
.INDENT 3.0
.TP
.B Make a \(dqbackup\(dq of all existing searches
$ salt\-call splunk_search.list_all \-\-out=txt | sed \(dqs/local: //\(dq > legacy_searches.sls
.UNINDENT
.IP 2. 3
.INDENT 3.0
.TP
.B Get all searches with new prefixed names
$ salt\-call splunk_search.list_all \(dqprefix=**MANAGED BY SALT** \(dq \-\-out=txt | sed \(dqs/local: //\(dq > managed_searches.sls
.UNINDENT
.IP 3. 3
.INDENT 3.0
.TP
.B Insert the managed searches into splunk
$ salt\-call state.sls managed_searches.sls
.UNINDENT
.IP 4. 3
Manually verify that the new searches look right
.IP 5. 3
Delete the original searches
$ sed s/present/absent/ legacy_searches.sls > remove_legacy_searches.sls
$ salt\-call state.sls remove_legacy_searches.sls
.IP 6. 3
Get all searches again, verify no changes
$ salt\-call splunk_search.list_all \-\-out=txt | sed \(dqs/local: //\(dq > final_searches.sls
$ diff final_searches.sls managed_searches.sls
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.splunk_search.update(name, profile=\(aqsplunk\(aq, **kwargs)
Update a splunk search
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
splunk_search.update \(aqmy search name\(aq sharing=app
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.sqlite3
.sp
Support for SQLite3
.INDENT 0.0
.TP
.B salt.modules.sqlite3.fetch(db=None, sql=None)
Retrieve data from an sqlite3 db (returns all rows, be careful!)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sqlite3.fetch /root/test.db \(aqSELECT * FROM test;\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sqlite3.indexes(db=None)
Show all indices in the database, for people with poor spelling skills
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sqlite3.indexes /root/test.db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sqlite3.indices(db=None)
Show all indices in the database
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sqlite3.indices /root/test.db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sqlite3.modify(db=None, sql=None)
Issue an SQL query to sqlite3 (with no return data), usually used
to modify the database in some way (insert, delete, create, etc)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sqlite3.modify /root/test.db \(aqCREATE TABLE test(id INT, testdata TEXT);\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sqlite3.sqlite_version()
Return version of sqlite
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sqlite3.sqlite_version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sqlite3.tables(db=None)
Show all tables in the database
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sqlite3.tables /root/test.db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sqlite3.version()
Return version of pysqlite
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sqlite3.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.ssh
.sp
Manage client ssh components
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This module requires the use of MD5 hashing. Certain security audits may
not permit the use of MD5. For those cases, this module should be disabled
or removed.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.auth_keys(user=None, config=\(aq.ssh/authorized_keys\(aq, fingerprint_hash_type=None)
Return the authorized keys for users
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.auth_keys
salt \(aq*\(aq ssh.auth_keys root
salt \(aq*\(aq ssh.auth_keys user=root
salt \(aq*\(aq ssh.auth_keys user=\(dq[user1, user2]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.check_key(user, key, enc, comment, options, config=\(aq.ssh/authorized_keys\(aq, cache_keys=None, fingerprint_hash_type=None)
Check to see if a key needs updating, returns \(dqupdate\(dq, \(dqadd\(dq or \(dqexists\(dq
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.check_key <user> <key> <enc> <comment> <options>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.check_key_file(user, source, config=\(aq.ssh/authorized_keys\(aq, saltenv=\(aqbase\(aq, fingerprint_hash_type=None)
Check a keyfile from a source destination against the local keys and
return the keys to change
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.check_key_file root salt://ssh/keyfile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.check_known_host(user=None, hostname=None, key=None, fingerprint=None, config=None, port=None, fingerprint_hash_type=None)
Check the record in known_hosts file, either by its value or by fingerprint
(it\(aqs enough to set up either key or fingerprint, you don\(aqt need to set up
both).
.sp
If provided key or fingerprint doesn\(aqt match with stored value, return
\(dqupdate\(dq, if no value is found for a given host, return \(dqadd\(dq, otherwise
return \(dqexists\(dq.
.sp
If neither key, nor fingerprint is defined, then additional validation is
not performed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.check_known_host <user> <hostname> key=\(aqAAAA...FAaQ==\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.get_known_host_entries(user, hostname, config=None, port=None, fingerprint_hash_type=None)
New in version 2018.3.0.

.sp
Return information about known host entries from the configfile, if any.
If there are no entries for a matching hostname, return None.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.get_known_host_entries <user> <hostname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.hash_known_hosts(user=None, config=None)
Hash all the hostnames in the known hosts file.
.sp
New in version 2014.7.0.

.INDENT 7.0
.TP
.B user
hash known hosts of this user
.TP
.B config
path to known hosts file: can be absolute or relative to user\(aqs home
directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.hash_known_hosts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.host_keys(keydir=None, private=True, certs=True)
Return the minion\(aqs host keys
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.host_keys
salt \(aq*\(aq ssh.host_keys keydir=/etc/ssh
salt \(aq*\(aq ssh.host_keys keydir=/etc/ssh private=False
salt \(aq*\(aq ssh.host_keys keydir=/etc/ssh certs=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.key_is_encrypted(key)
New in version 2015.8.7.

.sp
Function to determine whether or not a private key is encrypted with a
passphrase.
.sp
Checks key for a \fBProc\-Type\fP header with \fBENCRYPTED\fP in the value. If
found, returns \fBTrue\fP, otherwise returns \fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.key_is_encrypted /root/id_rsa
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.recv_known_host_entries(hostname, enc=None, port=None, hash_known_hosts=True, timeout=5, fingerprint_hash_type=None)
New in version 2018.3.0.

.sp
Retrieve information about host public keys from remote server
.INDENT 7.0
.TP
.B hostname
The name of the remote host (e.g. \(dqgithub.com\(dq)
.TP
.B enc
Defines what type of key is being used, can be ed25519, ecdsa,
ssh\-rsa, ssh\-dss or any other type as of openssh server version 8.7.
.TP
.B port
Optional parameter, denoting the port of the remote host on which an
SSH daemon is running. By default the port 22 is used.
.TP
.B hash_known_hosts
True
Hash all hostnames and addresses in the known hosts file.
.TP
.B timeout
int
Set the timeout for connection attempts.  If \fBtimeout\fP seconds have
elapsed since a connection was initiated to a host or since the last
time anything was read from that host, then the connection is closed
and the host in question considered unavailable.  Default is 5 seconds.
.TP
.B fingerprint_hash_type
The fingerprint hash type that the public key fingerprints were
originally hashed with. This defaults to \fBsha256\fP if not specified.
.sp
New in version 2016.11.4.

.sp
Changed in version 2017.7.0: default changed from \fBmd5\fP to \fBsha256\fP

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.recv_known_host_entries <hostname> enc=<enc> port=<port>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.rm_auth_key(user, key, config=\(aq.ssh/authorized_keys\(aq, fingerprint_hash_type=None)
Remove an authorized key from the specified user\(aqs authorized key file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.rm_auth_key <user> <key>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.rm_auth_key_from_file(user, source, config=\(aq.ssh/authorized_keys\(aq, saltenv=\(aqbase\(aq, fingerprint_hash_type=None)
Remove an authorized key from the specified user\(aqs authorized key file,
using a file as source
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.rm_auth_key_from_file <user> salt://ssh_keys/<user>.id_rsa.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.rm_known_host(user=None, hostname=None, config=None, port=None)
Remove all keys belonging to hostname from a known_hosts file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.rm_known_host <user> <hostname>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.set_auth_key(user, key, enc=\(aqssh\-rsa\(aq, comment=\(aq\(aq, options=None, config=\(aq.ssh/authorized_keys\(aq, cache_keys=None, fingerprint_hash_type=None)
Add a key to the authorized_keys file. The \(dqkey\(dq parameter must only be the
string of text that is the encoded key. If the key begins with \(dqssh\-rsa\(dq
or ends with \fI\%user@host\fP, remove those from the key before passing it to this
function.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.set_auth_key <user> \(aq<key>\(aq enc=\(aqdsa\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.set_auth_key_from_file(user, source, config=\(aq.ssh/authorized_keys\(aq, saltenv=\(aqbase\(aq, fingerprint_hash_type=None)
Add a key to the authorized_keys file, using a file as the source.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.set_auth_key_from_file <user> salt://ssh_keys/<user>.id_rsa.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.set_known_host(user=None, hostname=None, fingerprint=None, key=None, port=None, enc=None, config=None, hash_known_hosts=True, timeout=5, fingerprint_hash_type=None)
Download SSH public key from remote host \(dqhostname\(dq, optionally validate
its fingerprint against \(dqfingerprint\(dq variable and save the record in the
known_hosts file.
.sp
If such a record does already exists in there, do nothing.
.INDENT 7.0
.TP
.B user
The user who owns the ssh authorized keys file to modify
.TP
.B hostname
The name of the remote host (e.g. \(dqgithub.com\(dq)
.TP
.B fingerprint
The fingerprint of the key which must be present in the known_hosts
file (optional if key specified)
.TP
.B key
The public key which must be presented in the known_hosts file
(optional if fingerprint specified)
.TP
.B port
optional parameter, denoting the port of the remote host, which will be
used in case, if the public key will be requested from it. By default
the port 22 is used.
.TP
.B enc
Defines what type of key is being used, can be ed25519, ecdsa,
ssh\-rsa, ssh\-dss or any other type as of openssh server version 8.7.
.TP
.B config
The location of the authorized keys file relative to the user\(aqs home
directory, defaults to \(dq.ssh/known_hosts\(dq. If no user is specified,
defaults to \(dq/etc/ssh/ssh_known_hosts\(dq. If present, must be an
absolute path when a user is not specified.
.TP
.B hash_known_hosts
True
Hash all hostnames and addresses in the known hosts file.
.TP
.B timeout
int
Set the timeout for connection attempts.  If \fBtimeout\fP seconds have
elapsed since a connection was initiated to a host or since the last
time anything was read from that host, then the connection is closed
and the host in question considered unavailable.  Default is 5 seconds.
.sp
New in version 2016.3.0.

.TP
.B fingerprint_hash_type
The public key fingerprint hash type that the public key fingerprint
was originally hashed with. This defaults to \fBsha256\fP if not specified.
.sp
New in version 2016.11.4.

.sp
Changed in version 2017.7.0: default changed from \fBmd5\fP to \fBsha256\fP

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.set_known_host <user> fingerprint=\(aqxx:xx:..:xx\(aq enc=\(aqssh\-rsa\(aq config=\(aq.ssh/known_hosts\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh.user_keys(user=None, pubfile=None, prvfile=None)
Return the user\(aqs ssh keys on the minion
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ssh.user_keys
salt \(aq*\(aq ssh.user_keys user=user1
salt \(aq*\(aq ssh.user_keys user=user1 pubfile=/home/user1/.ssh/id_rsa.pub prvfile=/home/user1/.ssh/id_rsa
salt \(aq*\(aq ssh.user_keys user=user1 prvfile=False
salt \(aq*\(aq ssh.user_keys user=\(dq[\(aquser1\(aq,\(aquser2\(aq] pubfile=id_rsa.pub prvfile=id_rsa
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As you can see you can tell Salt not to read from the user\(aqs private (or
public) key file by setting the file path to \fBFalse\fP\&. This can be useful
to prevent Salt from publishing private data via Salt Mine or others.
.UNINDENT
.SS salt.modules.ssh_pkg
.sp
Service support for the REST example
.INDENT 0.0
.TP
.B salt.modules.ssh_pkg.install(name=None, refresh=False, fromrepo=None, pkgs=None, sources=None, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh_pkg.list_pkgs(versions_as_list=False, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh_pkg.remove(name=None, pkgs=None, **kwargs)
.UNINDENT
.SS salt.modules.ssh_service
.sp
Provide the service module for the proxy\-minion SSH sample
\&.. versionadded:: 2015.8.2
.INDENT 0.0
.TP
.B salt.modules.ssh_service.enabled(name, sig=None)
Only the \(aqredbull\(aq service is \(aqenabled\(aq in the test
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh_service.get_all()
Return a list of all available services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh_service.list_()
Return a list of all available services.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh_service.restart(name, sig=None)
Restart the specified service with rest_sample
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh_service.running(name, sig=None)
Return whether this service is running.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh_service.start(name, sig=None)
Start the specified service on the ssh_sample
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh_service.status(name, sig=None)
Return the status for a service via ssh_sample.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.sp
Changed in version 2018.3.0: The service name can now be a glob (e.g. \fBsalt*\fP)

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.IP \(bu 2
\fBsig\fP (\fI\%str\fP) \-\- Not implemented
.UNINDENT
.TP
.B Returns
True if running, False otherwise
dict: Maps service name to True if running, False otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.ssh_service.stop(name, sig=None)
Stop the specified service on the rest_sample
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.state
.sp
Control the state system on the minion.
.SS State Caching
.sp
When a highstate is called, the minion automatically caches a copy of the last
high data. If you then run a highstate with cache=True it will use that cached
highdata and won\(aqt hit the fileserver except for \fBsalt://\fP links in the
states themselves.
.INDENT 0.0
.TP
.B salt.modules.state.apply_(mods=None, **kwargs)
New in version 2015.5.0.

.sp
This function will call \fI\%state.highstate\fP or \fI\%state.sls\fP based on the arguments passed to this function.
It exists as a more intuitive way of applying states.
.sp
APPLYING ALL STATES CONFIGURED IN TOP.SLS (A.K.A. \fI\%HIGHSTATE\fP)
.sp
To apply all configured states, simply run \fBstate.apply\fP with no SLS
targets, like so:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following additional arguments are also accepted when applying all
states configured in top.sls:
.INDENT 7.0
.TP
.B test
Run states in test\-only (dry\-run) mode
.TP
.B mock
The mock option allows for the state run to execute without actually
calling any states. This then returns a mocked return which will show
the requisite ordering as well as fully validate the state run.
.sp
New in version 2015.8.4.

.TP
.B pillar
Custom Pillar values, passed as a dictionary of key\-value pairs
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply stuff pillar=\(aq{\(dqfoo\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Values passed this way will override Pillar values set via
\fBpillar_roots\fP or an external Pillar source.
.UNINDENT
.UNINDENT
.TP
.B exclude
Exclude specific states from execution. Accepts a list of sls names, a
comma\-separated string of sls names, or a list of dictionaries
containing \fBsls\fP or \fBid\fP keys. Glob\-patterns may be used to match
multiple states.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply exclude=bar,baz
salt \(aq*\(aq state.apply exclude=foo*
salt \(aq*\(aq state.apply exclude=\(dq[{\(aqid\(aq: \(aqid_to_exclude\(aq}, {\(aqsls\(aq: \(aqsls_to_exclude\(aq}]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B queue
False
Instead of failing immediately when another state run is in progress,
a value of \fBTrue\fP will queue the new state run to begin running once
the other has finished.
.sp
This option starts a new thread for each queued state run, so use this
option sparingly.
.sp
Changed in version 3006.0: This parameter can also be set via the \fBstate_queue\fP configuration
option. Additionally, it can now be set to an integer representing
the maximum queue size which can be attained before the state runs
will fail to be queued. This can prevent runaway conditions where
new threads are started until system performance is hampered.

.TP
.B localconfig
Optionally, instead of using the minion config, load minion opts from
the file specified by this argument, and then merge them with the
options from the minion config. This functionality allows for specific
states to be run with their own custom minion configuration, including
different pillars, file_roots, etc.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply localconfig=/path/to/minion.yml
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B state_events
The state_events option sends progress events as each function in
a state run completes execution.
.sp
New in version 3006.0.

.UNINDENT
.sp
APPLYING INDIVIDUAL SLS FILES (A.K.A. \fI\%STATE.SLS\fP)
.sp
To apply individual SLS files, pass them as a comma\-separated list:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Run the states configured in salt://stuff.sls (or salt://stuff/init.sls)
salt \(aq*\(aq state.apply stuff

# Run the states configured in salt://stuff.sls (or salt://stuff/init.sls)
# and salt://pkgs.sls (or salt://pkgs/init.sls).
salt \(aq*\(aq state.apply stuff,pkgs

# Run the states configured in a more deeply nested directory such as salt://my/organized/stuff.sls (or salt://my/organized/stuff/init.sls)
salt \(aq*\(aq state.apply my.organized.stuff
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following additional arguments are also accepted when applying
individual SLS files:
.INDENT 7.0
.TP
.B test
Run states in test\-only (dry\-run) mode
.TP
.B mock
The mock option allows for the state run to execute without actually
calling any states. This then returns a mocked return which will show
the requisite ordering as well as fully validate the state run.
.sp
New in version 2015.8.4.

.TP
.B pillar
Custom Pillar values, passed as a dictionary of key\-value pairs
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply stuff pillar=\(aq{\(dqfoo\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Values passed this way will override Pillar values set via
\fBpillar_roots\fP or an external Pillar source.
.UNINDENT
.UNINDENT
.TP
.B queue
False
Instead of failing immediately when another state run is in progress,
a value of \fBTrue\fP will queue the new state run to begin running once
the other has finished.
.sp
This option starts a new thread for each queued state run, so use this
option sparingly.
.sp
Changed in version 3006.0: This parameter can also be set via the \fBstate_queue\fP configuration
option. Additionally, it can now be set to an integer representing
the maximum queue size which can be attained before the state runs
will fail to be queued. This can prevent runaway conditions where
new threads are started until system performance is hampered.

.TP
.B concurrent
False
Execute state runs concurrently instead of serially
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This flag is potentially dangerous. It is designed for use when
multiple state runs can safely be run at the same time. Do \fInot\fP
use this flag for performance optimization.
.UNINDENT
.UNINDENT
.TP
.B saltenv
Specify a salt fileserver environment to be used when applying states
.sp
Changed in version 0.17.0: Argument name changed from \fBenv\fP to \fBsaltenv\fP

.sp
Changed in version 2014.7.0: If no saltenv is specified, the minion config will be checked for an
\fBenvironment\fP parameter and if found, it will be used. If none is
found, \fBbase\fP will be used. In prior releases, the minion config
was not checked and \fBbase\fP would always be assumed when the
saltenv was not explicitly set.

.TP
.B pillarenv
Specify a Pillar environment to be used when applying states. This
can also be set in the minion config file using the
\fI\%pillarenv\fP option. When neither the
\fI\%pillarenv\fP minion config option nor this CLI argument is
used, all Pillar environments will be merged together.
.TP
.B localconfig
Optionally, instead of using the minion config, load minion opts from
the file specified by this argument, and then merge them with the
options from the minion config. This functionality allows for specific
states to be run with their own custom minion configuration, including
different pillars, file_roots, etc.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply stuff localconfig=/path/to/minion.yml
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B sync_mods
If specified, the desired custom module types will be synced prior to
running the SLS files:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply stuff sync_mods=states,modules
salt \(aq*\(aq state.apply stuff sync_mods=all
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option is ignored when no SLS files are specified, as a
\fI\%highstate\fP automatically syncs all custom
module types.
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.8,2018.3.3,2019.2.0.

.TP
.B state_events
The state_events option sends progress events as each function in
a state run completes execution.
.sp
New in version 3006.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.check_request(name=None)
New in version 2015.5.0.

.sp
Return the state request information, if any
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.check_request
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.clear_cache()
Clear out cached state files, forcing even cache runs to refresh the cache
on the next state execution.
.sp
Remember that the state cache is completely disabled by default, this
execution only applies if cache=True is used in states
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.clear_cache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.clear_request(name=None)
New in version 2015.5.0.

.sp
Clear out the state execution request without executing it
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.clear_request
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.disable(states)
Disable state runs.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.disable highstate

salt \(aq*\(aq state.disable highstate,test.succeed_without_changes
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To disable a state file from running provide the same name that would
be passed in a state.sls call.
.sp
salt \(aq*\(aq state.disable bind.config
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.enable(states)
Enable state function or sls run
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.enable highstate

salt \(aq*\(aq state.enable test.succeed_without_changes
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To enable a state file from running provide the same name that would
be passed in a state.sls call.
.sp
salt \(aq*\(aq state.disable bind.config
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.event(tagmatch=\(aq*\(aq, count=\-1, quiet=False, sock_dir=None, pretty=False, node=\(aqminion\(aq)
Watch Salt\(aqs event bus and block until the given tag is matched
.sp
New in version 2016.3.0.

.sp
Changed in version 2019.2.0: \fBtagmatch\fP can now be either a glob or regular expression.

.sp
This is useful for utilizing Salt\(aqs event bus from shell scripts or for
taking simple actions directly from the CLI.
.sp
Enable debug logging to see ignored events.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtagmatch\fP \-\- the event is written to stdout for each tag that matches
this glob or regular expression.
.IP \(bu 2
\fBcount\fP \-\- this number is decremented for each event that matches the
\fBtagmatch\fP parameter; pass \fB\-1\fP to listen forever.
.IP \(bu 2
\fBquiet\fP \-\- do not print to stdout; just block
.IP \(bu 2
\fBsock_dir\fP \-\- path to the Salt master\(aqs event socket file.
.IP \(bu 2
\fBpretty\fP \-\- Output the JSON all on a single line if \fBFalse\fP (useful
for shell tools); pretty\-print the JSON output if \fBTrue\fP\&.
.IP \(bu 2
\fBnode\fP \-\- Watch the minion\-side or master\-side event bus.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local state.event pretty=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.get_pauses(jid=None)
Get a report on all of the currently paused state runs and pause
run settings.
Optionally send in a jid if you only desire to see a single pause
data set.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.high(data, test=None, queue=None, **kwargs)
Execute the compound calls stored in a single set of high data
.sp
This function is mostly intended for testing the state system and is not
likely to be needed in everyday usage.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.high \(aq{\(dqvim\(dq: {\(dqpkg\(dq: [\(dqinstalled\(dq]}}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.highstate(test=None, queue=None, state_events=None, **kwargs)
Retrieve the state data from the salt master for this minion and execute it
.INDENT 7.0
.TP
.B test
Run states in test\-only (dry\-run) mode
.TP
.B pillar
Custom Pillar values, passed as a dictionary of key\-value pairs
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.highstate stuff pillar=\(aq{\(dqfoo\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Values passed this way will override Pillar values set via
\fBpillar_roots\fP or an external Pillar source.
.UNINDENT
.UNINDENT
.sp
Changed in version 2016.3.0: GPG\-encrypted CLI Pillar data is now supported via the GPG
renderer. See \fI\%here\fP for details.

.TP
.B pillar_enc
Specify which renderer to use to decrypt encrypted data located within
the \fBpillar\fP value. Currently, only \fBgpg\fP is supported.
.sp
New in version 2016.3.0.

.TP
.B exclude
Exclude specific states from execution. Accepts a list of sls names, a
comma\-separated string of sls names, or a list of dictionaries
containing \fBsls\fP or \fBid\fP keys. Glob\-patterns may be used to match
multiple states.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.highstate exclude=bar,baz
salt \(aq*\(aq state.highstate exclude=foo*
salt \(aq*\(aq state.highstate exclude=\(dq[{\(aqid\(aq: \(aqid_to_exclude\(aq}, {\(aqsls\(aq: \(aqsls_to_exclude\(aq}]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B saltenv
Specify a salt fileserver environment to be used when applying states
.sp
Changed in version 0.17.0: Argument name changed from \fBenv\fP to \fBsaltenv\fP\&.

.sp
Changed in version 2014.7.0: If no saltenv is specified, the minion config will be checked for a
\fBsaltenv\fP parameter and if found, it will be used. If none is
found, \fBbase\fP will be used. In prior releases, the minion config
was not checked and \fBbase\fP would always be assumed when the
saltenv was not explicitly set.

.TP
.B pillarenv
Specify a Pillar environment to be used when applying states. This
can also be set in the minion config file using the
\fI\%pillarenv\fP option. When neither the
\fI\%pillarenv\fP minion config option nor this CLI argument is
used, all Pillar environments will be merged together.
.TP
.B queue
False
Instead of failing immediately when another state run is in progress,
a value of \fBTrue\fP will queue the new state run to begin running once
the other has finished.
.sp
This option starts a new thread for each queued state run, so use this
option sparingly.
.sp
Changed in version 3006.0: This parameter can also be set via the \fBstate_queue\fP configuration
option. Additionally, it can now be set to an integer representing
the maximum queue size which can be attained before the state runs
will fail to be queued. This can prevent runaway conditions where
new threads are started until system performance is hampered.

.TP
.B concurrent
False
Execute state runs concurrently instead of serially
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This flag is potentially dangerous. It is designed for use when
multiple state runs can safely be run at the same time. Do \fInot\fP
use this flag for performance optimization.
.UNINDENT
.UNINDENT
.TP
.B localconfig
Optionally, instead of using the minion config, load minion opts from
the file specified by this argument, and then merge them with the
options from the minion config. This functionality allows for specific
states to be run with their own custom minion configuration, including
different pillars, file_roots, etc.
.TP
.B mock
The mock option allows for the state run to execute without actually
calling any states. This then returns a mocked return which will show
the requisite ordering as well as fully validate the state run.
.sp
New in version 2015.8.4.

.TP
.B state_events
The state_events option sends progress events as each function in
a state run completes execution.
.sp
New in version 3006.0.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.highstate

salt \(aq*\(aq state.highstate whitelist=sls1_to_run,sls2_to_run
salt \(aq*\(aq state.highstate exclude=sls_to_exclude
salt \(aq*\(aq state.highstate exclude=\(dq[{\(aqid\(aq: \(aqid_to_exclude\(aq}, {\(aqsls\(aq: \(aqsls_to_exclude\(aq}]\(dq

salt \(aq*\(aq state.highstate pillar=\(dq{foo: \(aqFoo!\(aq, bar: \(aqBar!\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.id_exists(ids, mods, test=None, queue=None, **kwargs)
Tests for the existence of a specific ID or list of IDs within the
specified SLS file(s). Similar to \fI\%state.sls_exists\fP, returns True or False. The default
environment is base\(ga\(ga, use \fBsaltenv\fP to specify a different environment.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B saltenv
Specify a salt fileserver environment from which to look for the SLS files
specified in the \fBmods\fP argument
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.id_exists create_myfile,update_template filestate saltenv=dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.list_disabled()
List the states which are currently disabled
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.list_disabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.low(data, queue=None, **kwargs)
Execute a single low data call
.sp
This function is mostly intended for testing the state system and is not
likely to be needed in everyday usage.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.low \(aq{\(dqstate\(dq: \(dqpkg\(dq, \(dqfun\(dq: \(dqinstalled\(dq, \(dqname\(dq: \(dqvi\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.orchestrate(mods, saltenv=\(aqbase\(aq, test=None, exclude=None, pillar=None, pillarenv=None)
New in version 2016.11.0.

.sp
Execute the orchestrate runner from a masterless minion.
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
More Orchestrate documentation
.INDENT 0.0
.IP \(bu 2
\fI\%Full Orchestrate Tutorial\fP
.IP \(bu 2
Docs for the salt state module \fI\%salt.states.saltmod\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local state.orchestrate webserver
salt\-call \-\-local state.orchestrate webserver saltenv=dev test=True
salt\-call \-\-local state.orchestrate webserver saltenv=dev pillarenv=aws
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.pause(jid, state_id=None, duration=None)
Set up a state id pause, this instructs a running state to pause at a given
state id. This needs to pass in the jid of the running state and can
optionally pass in a duration in seconds. If a state_id is not passed then
the jid referenced will be paused at the beginning of the next state run.
.sp
The given state id is the id got a given state execution, so given a state
that looks like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The state_id to pass to \fIpause\fP is \fIvim\fP
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.pause 20171130110407769519
salt \(aq*\(aq state.pause 20171130110407769519 vim
salt \(aq*\(aq state.pause 20171130110407769519 vim 20
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.pkg(pkg_path, pkg_sum, hash_type, test=None, **kwargs)
Execute a packaged state run, the packaged state run will exist in a
tarball available locally. This packaged state
can be generated using salt\-ssh.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.pkg /tmp/salt_state.tgz 760a9353810e36f6d81416366fc426dc md5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.request(mods=None, **kwargs)
New in version 2015.5.0.

.sp
Request that the local admin execute a state run via
\fIsalt\-call state.run_request\fP\&.
All arguments match those of state.apply.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.request
salt \(aq*\(aq state.request stuff
salt \(aq*\(aq state.request stuff,pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.resume(jid, state_id=None)
Remove a pause from a jid, allowing it to continue. If the state_id is
not specified then the a general pause will be resumed.
.sp
The given state_id is the id got a given state execution, so given a state
that looks like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The state_id to pass to \fIrm_pause\fP is \fIvim\fP
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.resume 20171130110407769519
salt \(aq*\(aq state.resume 20171130110407769519 vim
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.run_request(name=\(aqdefault\(aq, **kwargs)
New in version 2015.5.0.

.sp
Execute the pending state request
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.run_request
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.running(concurrent=False)
Return a list of strings that contain state return data if a state function
is already running. This function is used to prevent multiple state calls
from being run at the same time.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.running
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.show_highstate(queue=None, **kwargs)
Retrieve the highstate data from the salt master and display it
.sp
Custom Pillar data can be passed with the \fBpillar\fP kwarg.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.show_highstate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.show_low_sls(mods, test=None, queue=None, **kwargs)
Display the low data from a specific sls. The default environment is
\fBbase\fP, use \fBsaltenv\fP to specify a different environment.
.INDENT 7.0
.TP
.B saltenv
Specify a salt fileserver environment to be used when applying states
.TP
.B pillar
Custom Pillar values, passed as a dictionary of key\-value pairs
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.show_low_sls stuff pillar=\(aq{\(dqfoo\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Values passed this way will override Pillar values set via
\fBpillar_roots\fP or an external Pillar source.
.UNINDENT
.UNINDENT
.TP
.B pillarenv
Specify a Pillar environment to be used when applying states. This
can also be set in the minion config file using the
\fI\%pillarenv\fP option. When neither the
\fI\%pillarenv\fP minion config option nor this CLI argument is
used, all Pillar environments will be merged together.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.show_low_sls foo
salt \(aq*\(aq state.show_low_sls foo saltenv=dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.show_lowstate(queue=None, **kwargs)
List out the low data that will be applied to this minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.show_lowstate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.show_sls(mods, test=None, queue=None, **kwargs)
Display the state data from a specific sls or list of sls files on the
master. The default environment is \fBbase\fP, use \fBsaltenv\fP to specify a
different environment.
.sp
This function does not support topfiles.  For \fBtop.sls\fP please use
\fBshow_top\fP instead.
.sp
Custom Pillar data can be passed with the \fBpillar\fP kwarg.
.INDENT 7.0
.TP
.B saltenv
Specify a salt fileserver environment to be used when applying states
.TP
.B pillarenv
Specify a Pillar environment to be used when applying states. This
can also be set in the minion config file using the
\fI\%pillarenv\fP option. When neither the
\fI\%pillarenv\fP minion config option nor this CLI argument is
used, all Pillar environments will be merged together.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.show_sls core,edit.vim saltenv=dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.show_state_usage(queue=None, **kwargs)
Retrieve the highstate data from the salt master to analyse used and unused states
.sp
Custom Pillar data can be passed with the \fBpillar\fP kwarg.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.show_state_usage
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.show_states(queue=None, **kwargs)
Returns the list of states that will be applied on highstate.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.show_states
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.show_top(queue=None, **kwargs)
Return the top data that the minion will use for a highstate
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.show_top
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.single(fun, name, test=None, queue=None, **kwargs)
Execute a single state function with the named kwargs, returns False if
insufficient data is sent to the command
.sp
By default, the values of the kwargs will be parsed as YAML. So, you can
specify lists values, or lists of single entry key\-value maps, as you
would in a YAML salt file. Alternatively, JSON format of keyword values
is also supported.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.single pkg.installed name=vim
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.sls(mods, test=None, exclude=None, queue=None, sync_mods=None, state_events=None, **kwargs)
Execute the states in one or more SLS files
.INDENT 7.0
.TP
.B test
Run states in test\-only (dry\-run) mode
.TP
.B pillar
Custom Pillar values, passed as a dictionary of key\-value pairs
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.sls stuff pillar=\(aq{\(dqfoo\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Values passed this way will override existing Pillar values set via
\fBpillar_roots\fP or an external Pillar source.  Pillar values that
are not included in the kwarg will not be overwritten.
.UNINDENT
.UNINDENT
.sp
Changed in version 2016.3.0: GPG\-encrypted CLI Pillar data is now supported via the GPG
renderer. See \fI\%here\fP for details.

.TP
.B pillar_enc
Specify which renderer to use to decrypt encrypted data located within
the \fBpillar\fP value. Currently, only \fBgpg\fP is supported.
.sp
New in version 2016.3.0.

.TP
.B exclude
Exclude specific states from execution. Accepts a list of sls names, a
comma\-separated string of sls names, or a list of dictionaries
containing \fBsls\fP or \fBid\fP keys. Glob\-patterns may be used to match
multiple states.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.sls foo,bar,baz exclude=bar,baz
salt \(aq*\(aq state.sls foo,bar,baz exclude=ba*
salt \(aq*\(aq state.sls foo,bar,baz exclude=\(dq[{\(aqid\(aq: \(aqid_to_exclude\(aq}, {\(aqsls\(aq: \(aqsls_to_exclude\(aq}]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B queue
False
Instead of failing immediately when another state run is in progress,
a value of \fBTrue\fP will queue the new state run to begin running once
the other has finished.
.sp
This option starts a new thread for each queued state run, so use this
option sparingly.
.sp
Changed in version 3006.0: This parameter can also be set via the \fBstate_queue\fP configuration
option. Additionally, it can now be set to an integer representing
the maximum queue size which can be attained before the state runs
will fail to be queued. This can prevent runaway conditions where
new threads are started until system performance is hampered.

.TP
.B concurrent
False
Execute state runs concurrently instead of serially
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This flag is potentially dangerous. It is designed for use when
multiple state runs can safely be run at the same time. Do \fInot\fP
use this flag for performance optimization.
.UNINDENT
.UNINDENT
.TP
.B saltenv
Specify a salt fileserver environment to be used when applying states
.sp
Changed in version 0.17.0: Argument name changed from \fBenv\fP to \fBsaltenv\fP\&.

.sp
Changed in version 2014.7.0: If no saltenv is specified, the minion config will be checked for an
\fBenvironment\fP parameter and if found, it will be used. If none is
found, \fBbase\fP will be used. In prior releases, the minion config
was not checked and \fBbase\fP would always be assumed when the
saltenv was not explicitly set.

.TP
.B pillarenv
Specify a Pillar environment to be used when applying states. This
can also be set in the minion config file using the
\fI\%pillarenv\fP option. When neither the
\fI\%pillarenv\fP minion config option nor this CLI argument is
used, all Pillar environments will be merged together.
.TP
.B localconfig
Optionally, instead of using the minion config, load minion opts from
the file specified by this argument, and then merge them with the
options from the minion config. This functionality allows for specific
states to be run with their own custom minion configuration, including
different pillars, file_roots, etc.
.TP
.B mock
The mock option allows for the state run to execute without actually
calling any states. This then returns a mocked return which will show
the requisite ordering as well as fully validate the state run.
.sp
New in version 2015.8.4.

.TP
.B sync_mods
If specified, the desired custom module types will be synced prior to
running the SLS files:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.sls stuff sync_mods=states,modules
salt \(aq*\(aq state.sls stuff sync_mods=all
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.8,2018.3.3,2019.2.0.

.TP
.B state_events
The state_events option sends progress events as each function in
a state run completes execution.
.sp
New in version 3006.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Run the states configured in salt://example.sls (or salt://example/init.sls)
salt \(aq*\(aq state.apply example

# Run the states configured in salt://core.sls (or salt://core/init.sls)
# and salt://edit/vim.sls (or salt://edit/vim/init.sls)
salt \(aq*\(aq state.sls core,edit.vim

# Run the states configured in a more deeply nested directory such as salt://my/nested/state.sls (or salt://my/nested/state/init.sls)
salt \(aq*\(aq state.sls my.nested.state

salt \(aq*\(aq state.sls core exclude=\(dq[{\(aqid\(aq: \(aqid_to_exclude\(aq}, {\(aqsls\(aq: \(aqsls_to_exclude\(aq}]\(dq
salt \(aq*\(aq state.sls myslsfile pillar=\(dq{foo: \(aqFoo!\(aq, bar: \(aqBar!\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.sls_exists(mods, test=None, queue=None, **kwargs)
Tests for the existence the of a specific SLS or list of SLS files on the
master. Similar to \fI\%state.show_sls\fP,
rather than returning state details, returns True or False. The default
environment is \fBbase\fP, use \fBsaltenv\fP to specify a different environment.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B saltenv
Specify a salt fileserver environment from which to look for the SLS files
specified in the \fBmods\fP argument
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.sls_exists core,edit.vim saltenv=dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.sls_id(id_, mods, test=None, queue=None, state_events=None, **kwargs)
Call a single ID from the named module(s) and handle all requisites
.sp
The state ID comes \fIbefore\fP the module ID(s) on the command line.
.INDENT 7.0
.TP
.B id
ID to call
.TP
.B mods
Comma\-delimited list of modules to search for given id and its requisites
.UNINDENT
.sp
New in version 2014.7.0.

.INDENT 7.0
.TP
.B saltenv
base
Specify a salt fileserver environment to be used when applying states
.TP
.B pillarenv
Specify a Pillar environment to be used when applying states. This
can also be set in the minion config file using the
\fI\%pillarenv\fP option. When neither the
\fI\%pillarenv\fP minion config option nor this CLI argument is
used, all Pillar environments will be merged together.
.TP
.B pillar
Custom Pillar values, passed as a dictionary of key\-value pairs
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.sls_id my_state my_module pillar=\(aq{\(dqfoo\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Values passed this way will override existing Pillar values set via
\fBpillar_roots\fP or an external Pillar source.  Pillar values that
are not included in the kwarg will not be overwritten.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.sls_id my_state my_module

salt \(aq*\(aq state.sls_id my_state my_module,a_common_module
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.soft_kill(jid, state_id=None)
Set up a state run to die before executing the given state id,
this instructs a running state to safely exit at a given
state id. This needs to pass in the jid of the running state.
If a state_id is not passed then the jid referenced will be safely exited
at the beginning of the next state run.
.sp
The given state id is the id got a given state execution, so given a state
that looks like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The state_id to pass to \fIsoft_kill\fP is \fIvim\fP
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.soft_kill 20171130110407769519
salt \(aq*\(aq state.soft_kill 20171130110407769519 vim
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.template(tem, queue=None, **kwargs)
Execute the information stored in a template file on the minion.
.sp
This function does not ask a master for a SLS file to render but
instead directly processes the file at the provided path on the minion.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.template \(aq<Path to template on the minion>\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.template_str(tem, queue=None, **kwargs)
Execute the information stored in a string from an sls template
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.template_str \(aq<Template String>\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.test(*args, **kwargs)
New in version 3001.

.sp
Alias for \fIstate.apply\fP with the kwarg \fItest\fP forced to \fITrue\fP\&.
.sp
This is a nicety to avoid the need to type out \fItest=True\fP and the possibility of
a typo causing changes you do not intend.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.state.top(topfn, test=None, queue=None, **kwargs)
Execute a specific top file instead of the default. This is useful to apply
configurations from a different environment (for example, dev or prod), without
modifying the default top file.
.INDENT 7.0
.TP
.B queue
False
Instead of failing immediately when another state run is in progress,
a value of \fBTrue\fP will queue the new state run to begin running once
the other has finished.
.sp
This option starts a new thread for each queued state run, so use this
option sparingly.
.sp
Changed in version 3006.0: This parameter can also be set via the \fBstate_queue\fP configuration
option. Additionally, it can now be set to an integer representing
the maximum queue size which can be attained before the state runs
will fail to be queued. This can prevent runaway conditions where
new threads are started until system performance is hampered.

.TP
.B saltenv
Specify a salt fileserver environment to be used when applying states
.TP
.B pillarenv
Specify a Pillar environment to be used when applying states. This
can also be set in the minion config file using the
\fI\%pillarenv\fP option. When neither the
\fI\%pillarenv\fP minion config option nor this CLI argument is
used, all Pillar environments will be merged together.
.sp
New in version 2017.7.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.top reverse_top.sls
salt \(aq*\(aq state.top prod_top.sls exclude=sls_to_exclude
salt \(aq*\(aq state.top dev_top.sls exclude=\(dq[{\(aqid\(aq: \(aqid_to_exclude\(aq}, {\(aqsls\(aq: \(aqsls_to_exclude\(aq}]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.status
.sp
Module for returning various status data about a minion.
These data can be useful for compiling into stats later.
.INDENT 0.0
.TP
.B salt.modules.status.all_status()
Return a composite of all status data and info for this minion.
Warning: There is a LOT here!
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.all_status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.cpuinfo()
Changed in version 2016.3.2: Return the CPU info for this minion

.sp
Changed in version 2016.11.4: Added support for AIX

.sp
Changed in version 2018.3.0: Added support for NetBSD and OpenBSD

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.cpuinfo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.cpustats()
Return the CPU stats for this minion
.sp
Changed in version 2016.11.4: Added support for AIX

.sp
Changed in version 2018.3.0: Added support for OpenBSD

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.cpustats
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.custom()
Return a custom composite of status data and info for this minion,
based on the minion config file. An example config like might be:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
status.cpustats.custom: [ \(aqcpu\(aq, \(aqctxt\(aq, \(aqbtime\(aq, \(aqprocesses\(aq ]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Where status refers to status.py, cpustats is the function
where we get our data, and custom is this function It is followed
by a list of keys that we want returned.
.sp
This function is meant to replace all_status(), which returns
anything and everything, which we probably don\(aqt want.
.sp
By default, nothing is returned. Warning: Depending on what you
include, there can be a LOT here!
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.custom
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.diskstats()
Changed in version 2016.3.2: Return the disk stats for this minion

.sp
Changed in version 2016.11.4: Added support for AIX

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.diskstats
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.diskusage(*args)
Return the disk usage for this minion
.sp
Usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.diskusage [paths and/or filesystem types]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.diskusage         # usage for all filesystems
salt \(aq*\(aq status.diskusage / /tmp  # usage for / and /tmp
salt \(aq*\(aq status.diskusage ext?    # usage for ext[234] filesystems
salt \(aq*\(aq status.diskusage / ext?  # usage for / and all ext filesystems
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.loadavg()
Return the load averages for this minion
.sp
Changed in version 2016.11.4: Added support for AIX

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.loadavg

:raises CommandExecutionError: If the system cannot report loadaverages to Python
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.master(master=None, connected=True)
New in version 2014.7.0.

.sp
Return the connection status with master. Fire an event if the
connection to master is not as expected. This function is meant to be
run via a scheduled job from the minion. If master_ip is an FQDN/Hostname,
it must be resolvable to a valid IPv4 address.
.sp
Changed in version 2016.11.4: Added support for AIX

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.master
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.meminfo()
Return the memory info for this minion
.sp
Changed in version 2016.11.4: Added support for AIX

.sp
Changed in version 2018.3.0: Added support for OpenBSD

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.meminfo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.netdev()
Changed in version 2016.3.2: Return the network device stats for this minion

.sp
Changed in version 2016.11.4: Added support for AIX

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.netdev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.netstats()
Return the network stats for this minion
.sp
Changed in version 2016.11.4: Added support for AIX

.sp
Changed in version 2018.3.0: Added support for OpenBSD

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.netstats
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.nproc()
Return the number of processing units available on this system
.sp
Changed in version 2016.11.4: Added support for AIX

.sp
Changed in version 2018.3.0: Added support for Darwin, FreeBSD and OpenBSD

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.nproc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.pid(sig)
Return the PID or an empty string if the process is running or not.
Pass a signature to use to find the process via ps.  Note you can pass
a Python\-compatible regular expression to return all pids of
processes matching the regexp.
.sp
Changed in version 2016.11.4: Added support for AIX

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.pid <sig>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.ping_master(master)
New in version 2016.3.0.

.sp
Sends ping request to the given master. Fires \(aq__master_failback\(aq event on success.
Returns bool result.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.ping_master localhost
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.procs()
Return the process data
.sp
Changed in version 2016.11.4: Added support for AIX

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.procs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.proxy_reconnect(proxy_name, opts=None)
Forces proxy minion reconnection when not alive.
.INDENT 7.0
.TP
.B proxy_name
The virtual name of the proxy module.
.TP
.B opts: None
Opts dictionary. Not intended for CLI usage.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.proxy_reconnect rest_sample
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.time_(format=\(aq%A, %d. %B %Y %I:%M%p\(aq)
New in version 2016.3.0.

.sp
Return the current time on the minion,
formatted based on the format parameter.
.sp
Default date format: Monday, 27. July 2015 07:55AM
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.time

salt \(aq*\(aq status.time \(aq%s\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.uptime()
Return the uptime for this system.
.sp
Changed in version 2015.8.9: The uptime function was changed to return a dictionary of easy\-to\-read
key/value pairs containing uptime information, instead of the output
from a \fBcmd.run\fP call.

.sp
Changed in version 2016.11.0: Support for OpenBSD, FreeBSD, NetBSD, MacOS, and Solaris

.sp
Changed in version 2016.11.4: Added support for AIX

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.uptime
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.version()
Return the system version for this minion
.sp
Changed in version 2016.11.4: Added support for AIX

.sp
Changed in version 2018.3.0: Added support for OpenBSD

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.vmstats()
Changed in version 2016.3.2: Return the virtual memory stats for this minion

.sp
Changed in version 2016.11.4: Added support for AIX

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.vmstats
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.status.w()
Return a list of logged in users for this minion, using the w command
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.w
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.statuspage
.SS StatusPage
.sp
Handle requests for the \fI\%StatusPage\fP \fI\%API\fP\&.
.sp
In the minion configuration file, the following block is required:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
statuspage:
  api_key: <API_KEY>
  page_id: <PAGE_ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.modules.statuspage.create(endpoint=\(aqincidents\(aq, api_url=None, page_id=None, api_key=None, api_version=None, **kwargs)
Insert a new entry under a specific endpoint.
.INDENT 7.0
.TP
.B endpoint: incidents
Insert under this specific endpoint.
.TP
.B page_id
Page ID. Can also be specified in the config file.
.TP
.B api_key
API key. Can also be specified in the config file.
.TP
.B api_version: 1
API version. Can also be specified in the config file.
.TP
.B api_url
Custom API URL in case the user has a StatusPage service running in a custom environment.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq statuspage.create endpoint=\(aqcomponents\(aq name=\(aqmy component\(aq group_id=\(aq993vgplshj12\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
minion:
    \-\-\-\-\-\-\-\-\-\-
    comment:
    out:
        \-\-\-\-\-\-\-\-\-\-
        created_at:
            2017\-01\-05T19:35:27.135Z
        description:
            None
        group_id:
            993vgplshj12
        id:
            mjkmtt5lhdgc
        name:
            my component
        page_id:
            ksdhgfyiuhaa
        position:
            7
        status:
            operational
        updated_at:
            2017\-01\-05T19:35:27.135Z
    result:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.statuspage.delete(endpoint=\(aqincidents\(aq, id=None, api_url=None, page_id=None, api_key=None, api_version=None)
Remove an entry from an endpoint.
.INDENT 7.0
.TP
.B endpoint: incidents
Request a specific endpoint.
.TP
.B page_id
Page ID. Can also be specified in the config file.
.TP
.B api_key
API key. Can also be specified in the config file.
.TP
.B api_version: 1
API version. Can also be specified in the config file.
.TP
.B api_url
Custom API URL in case the user has a StatusPage service running in a custom environment.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq statuspage.delete endpoint=\(aqcomponents\(aq id=\(aqftgks51sfs2d\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
minion:
    \-\-\-\-\-\-\-\-\-\-
    comment:
    out:
        None
    result:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.statuspage.retrieve(endpoint=\(aqincidents\(aq, api_url=None, page_id=None, api_key=None, api_version=None)
Retrieve a specific endpoint from the Statuspage API.
.INDENT 7.0
.TP
.B endpoint: incidents
Request a specific endpoint.
.TP
.B page_id
Page ID. Can also be specified in the config file.
.TP
.B api_key
API key. Can also be specified in the config file.
.TP
.B api_version: 1
API version. Can also be specified in the config file.
.TP
.B api_url
Custom API URL in case the user has a StatusPage service running in a custom environment.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq statuspage.retrieve components
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
minion:
    \-\-\-\-\-\-\-\-\-\-
    comment:
    out:
        |_
          \-\-\-\-\-\-\-\-\-\-
          backfilled:
              False
          created_at:
              2015\-01\-26T20:25:02.702Z
          id:
              kh2qwjbheqdc36
          impact:
              major
          impact_override:
              None
          incident_updates:
              |_
                \-\-\-\-\-\-\-\-\-\-
                affected_components:
                    None
                body:
                    We are currently investigating this issue.
                created_at:
                    2015\-01\-26T20:25:02.849Z
                display_at:
                    2015\-01\-26T20:25:02.849Z
                id:
                    zvx7xz2z5skr
                incident_id:
                    kh2qwjbheqdc36
                status:
                    investigating
                twitter_updated_at:
                    None
                updated_at:
                    2015\-01\-26T20:25:02.849Z
                wants_twitter_update:
                    False
          monitoring_at:
              None
          name:
              just testing some stuff
          page_id:
              ksdhgfyiuhaa
          postmortem_body:
              None
          postmortem_body_last_updated_at:
              None
          postmortem_ignored:
              False
          postmortem_notified_subscribers:
              False
          postmortem_notified_twitter:
              False
          postmortem_published_at:
              None
          resolved_at:
              None
          scheduled_auto_completed:
              False
          scheduled_auto_in_progress:
              False
          scheduled_for:
              None
          scheduled_remind_prior:
              False
          scheduled_reminded_at:
              None
          scheduled_until:
              None
          shortlink:
              http://stspg.io/voY
          status:
              investigating
          updated_at:
              2015\-01\-26T20:25:13.379Z
    result:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.statuspage.update(endpoint=\(aqincidents\(aq, id=None, api_url=None, page_id=None, api_key=None, api_version=None, **kwargs)
Update attribute(s) of a specific endpoint.
.INDENT 7.0
.TP
.B id
The unique ID of the endpoint entry.
.TP
.B endpoint: incidents
Endpoint name.
.TP
.B page_id
Page ID. Can also be specified in the config file.
.TP
.B api_key
API key. Can also be specified in the config file.
.TP
.B api_version: 1
API version. Can also be specified in the config file.
.TP
.B api_url
Custom API URL in case the user has a StatusPage service running in a custom environment.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq statuspage.update id=dz959yz2nd4l status=resolved
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
minion:
    \-\-\-\-\-\-\-\-\-\-
    comment:
    out:
        \-\-\-\-\-\-\-\-\-\-
        created_at:
            2017\-01\-03T15:25:30.718Z
        description:
            None
        group_id:
            993vgplshj12
        id:
            dz959yz2nd4l
        name:
            Management Portal
        page_id:
            xzwjjdw87vpf
        position:
            11
        status:
            resolved
        updated_at:
            2017\-01\-05T15:34:27.676Z
    result:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.supervisord
.sp
Provide the service module for system supervisord or supervisord in a
virtualenv
.INDENT 0.0
.TP
.B salt.modules.supervisord.add(name, user=None, conf_file=None, bin_env=None)
Activates any updates in config for process/group.
.INDENT 7.0
.TP
.B user
user to run supervisorctl as
.TP
.B conf_file
path to supervisord config file
.TP
.B bin_env
path to supervisorctl bin or path to virtualenv with supervisor
installed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq supervisord.add <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.supervisord.custom(command, user=None, conf_file=None, bin_env=None)
Run any custom supervisord command
.INDENT 7.0
.TP
.B user
user to run supervisorctl as
.TP
.B conf_file
path to supervisord config file
.TP
.B bin_env
path to supervisorctl bin or path to virtualenv with supervisor
installed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq supervisord.custom \(dqmstop \(aq*gunicorn*\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.supervisord.options(name, conf_file=None)
New in version 2014.1.0.

.sp
Read the config file and return the config options for a given process
.INDENT 7.0
.TP
.B name
Name of the configured process
.TP
.B conf_file
path to supervisord config file
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq supervisord.options foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.supervisord.remove(name, user=None, conf_file=None, bin_env=None)
Removes process/group from active config
.INDENT 7.0
.TP
.B user
user to run supervisorctl as
.TP
.B conf_file
path to supervisord config file
.TP
.B bin_env
path to supervisorctl bin or path to virtualenv with supervisor
installed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq supervisord.remove <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.supervisord.reread(user=None, conf_file=None, bin_env=None)
Reload the daemon\(aqs configuration files
.INDENT 7.0
.TP
.B user
user to run supervisorctl as
.TP
.B conf_file
path to supervisord config file
.TP
.B bin_env
path to supervisorctl bin or path to virtualenv with supervisor
installed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq supervisord.reread
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.supervisord.restart(name=\(aqall\(aq, user=None, conf_file=None, bin_env=None)
Restart the named service.
Process group names should not include a trailing asterisk.
.INDENT 7.0
.TP
.B user
user to run supervisorctl as
.TP
.B conf_file
path to supervisord config file
.TP
.B bin_env
path to supervisorctl bin or path to virtualenv with supervisor
installed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq supervisord.restart <service>
salt \(aq*\(aq supervisord.restart <group>:
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.supervisord.start(name=\(aqall\(aq, user=None, conf_file=None, bin_env=None)
Start the named service.
Process group names should not include a trailing asterisk.
.INDENT 7.0
.TP
.B user
user to run supervisorctl as
.TP
.B conf_file
path to supervisord config file
.TP
.B bin_env
path to supervisorctl bin or path to virtualenv with supervisor
installed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq supervisord.start <service>
salt \(aq*\(aq supervisord.start <group>:
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.supervisord.status(name=None, user=None, conf_file=None, bin_env=None)
List programs and its state
.INDENT 7.0
.TP
.B user
user to run supervisorctl as
.TP
.B conf_file
path to supervisord config file
.TP
.B bin_env
path to supervisorctl bin or path to virtualenv with supervisor
installed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq supervisord.status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.supervisord.status_bool(name, expected_state=None, user=None, conf_file=None, bin_env=None)
Check for status of a specific supervisord process and return boolean result.
.INDENT 7.0
.TP
.B name
name of the process to check
.TP
.B expected_state
search for a specific process state. If set to \fBNone\fP \- any process state will match.
.TP
.B user
user to run supervisorctl as
.TP
.B conf_file
path to supervisord config file
.TP
.B bin_env
path to supervisorctl bin or path to virtualenv with supervisor
installed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq supervisord.status_bool nginx expected_state=\(aqRUNNING\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.supervisord.status_raw(name=None, user=None, conf_file=None, bin_env=None)
Display the raw output of status
.INDENT 7.0
.TP
.B user
user to run supervisorctl as
.TP
.B conf_file
path to supervisord config file
.TP
.B bin_env
path to supervisorctl bin or path to virtualenv with supervisor
installed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq supervisord.status_raw
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.supervisord.stop(name=\(aqall\(aq, user=None, conf_file=None, bin_env=None)
Stop the named service.
Process group names should not include a trailing asterisk.
.INDENT 7.0
.TP
.B user
user to run supervisorctl as
.TP
.B conf_file
path to supervisord config file
.TP
.B bin_env
path to supervisorctl bin or path to virtualenv with supervisor
installed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq supervisord.stop <service>
salt \(aq*\(aq supervisord.stop <group>:
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.supervisord.update(user=None, conf_file=None, bin_env=None, name=None)
Reload config and add/remove/update as necessary
.INDENT 7.0
.TP
.B user
user to run supervisorctl as
.TP
.B conf_file
path to supervisord config file
.TP
.B bin_env
path to supervisorctl bin or path to virtualenv with supervisor
installed
.TP
.B name
name of the process group to update. if none then update any
process group that has changes
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq supervisord.update
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.suse_apache
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%apache Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Support for Apache
.sp
Please note: The functions in here are SUSE\-specific. Placing them in this
separate file will allow them to load only on SUSE systems, while still
loading under the \fBapache\fP namespace.
.INDENT 0.0
.TP
.B salt.modules.suse_apache.a2dismod(mod)
Runs a2dismod for the given mod.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.a2dismod vhost_alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.suse_apache.a2enmod(mod)
Runs a2enmod for the given mod.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.a2enmod vhost_alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.suse_apache.check_mod_enabled(mod)
Checks to see if the specific apache mod is enabled.
.sp
This will only be functional on operating systems that support
\fIa2enmod \-l\fP to list the enabled mods.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq apache.check_mod_enabled status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.suse_ip
.sp
The networking module for SUSE based distros
.sp
New in version 3005.

.INDENT 0.0
.TP
.B salt.modules.suse_ip.apply_network_settings(**settings)
Apply global network configuration.
.INDENT 7.0
.TP
.B :param
param settings:
The network settings to apply
.UNINDENT
.INDENT 7.0
.TP
.B Returns
The result of \fBservice.reload\fP for \fBnetwork\fP service
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.apply_network_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.suse_ip.build_interface(iface, iface_type, enabled, **settings)
Build an interface script for a network interface.
.INDENT 7.0
.TP
.B :param
param iface:
The name of the interface to build the configuration for
.TP
.B :param
param iface_type:.INDENT 7.0
.TP
.B The type of the interface. The following types are possible:
.INDENT 7.0
.IP \(bu 2
eth
.IP \(bu 2
bond
.IP \(bu 2
alias
.IP \(bu 2
clone
.IP \(bu 2
ipsec
.IP \(bu 2
dialup
.IP \(bu 2
bridge
.IP \(bu 2
slave
.IP \(bu 2
vlan
.IP \(bu 2
ipip
.IP \(bu 2
ib
.UNINDENT
.UNINDENT
.TP
.B :param
param enabled:
Build the interface enabled or disabled
.TP
.B :param
param settings:
The settings for the interface
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary of file/content
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.build_interface eth0 eth <settings>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.suse_ip.build_network_settings(**settings)
Build the global network script.
.INDENT 7.0
.TP
.B :param
param settings:
The network settings
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary of file/content
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.build_network_settings <settings>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.suse_ip.build_routes(iface, **settings)
Build a route script for a network interface.
.INDENT 7.0
.TP
.B :param
param iface:
The name of the interface to build the routes for
.TP
.B :param
param settings:
The settings for the routes
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary of file/content
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.build_routes eth0 <settings>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.suse_ip.down(iface, iface_type=None)
Shutdown a network interface
.INDENT 7.0
.TP
.B :param
param iface:
The name of the interface to shutdown
.TP
.B :param
param iface_type:
The type of the interface
If \fBslave\fP is specified, no any action is performing
Default is \fBNone\fP
.UNINDENT
.INDENT 7.0
.TP
.B Returns
The result of \fBifdown\fP command or \fBNone\fP if \fBslave\fP
iface_type was specified
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.down eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.suse_ip.get_interface(iface)
Return the contents of an interface script
.INDENT 7.0
.TP
.B :param
param iface:
The name of the interface to get settings for
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary of file/content
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.get_interface eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.suse_ip.get_network_settings()
Return the contents of the global network script.
.INDENT 7.0
.TP
.B :param
param iface:
The name of the interface to start up
.TP
.B :param
param iface_type:
The type of the interface
If \fBslave\fP is specified, no any action is performing
Default is \fBNone\fP
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary of file/content
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.get_network_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.suse_ip.get_routes(iface)
Return the contents of the interface routes script.
.INDENT 7.0
.TP
.B :param
param iface:
The name of the interface to get the routes for
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary of file/content
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.get_routes eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.suse_ip.up(iface, iface_type=None)
Start up a network interface
.INDENT 7.0
.TP
.B :param
param iface:
The name of the interface to start up
.TP
.B :param
param iface_type:
The type of the interface
If \fBslave\fP is specified, no any action is performing
Default is \fBNone\fP
.UNINDENT
.INDENT 7.0
.TP
.B Returns
The result of \fBifup\fP command or \fBNone\fP if \fBslave\fP
iface_type was specified
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ip.up eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.svn
.sp
Subversion SCM
.INDENT 0.0
.TP
.B salt.modules.svn.add(cwd, targets, user=None, username=None, password=None, *opts)
Add files to be tracked by the Subversion working\-copy checkout
.INDENT 7.0
.TP
.B cwd
The path to the Subversion repository
.TP
.B targets
None
files and directories to pass to the command as arguments
.TP
.B user
None
Run svn as a user other than what the minion runs as
.TP
.B username
None
Connect to the Subversion server as another user
.TP
.B password
None
Connect to the Subversion server with this password
.sp
New in version 0.17.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq svn.add /path/to/repo /path/to/new/file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.svn.checkout(cwd, remote, target=None, user=None, username=None, password=None, *opts)
Download a working copy of the remote Subversion repository
directory or file
.INDENT 7.0
.TP
.B cwd
The path to the Subversion repository
.TP
.B remote
None
URL to checkout
.TP
.B target
None
The name to give the file or directory working copy
Default: svn uses the remote basename
.TP
.B user
None
Run svn as a user other than what the minion runs as
.TP
.B username
None
Connect to the Subversion server as another user
.TP
.B password
None
Connect to the Subversion server with this password
.sp
New in version 0.17.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq svn.checkout /path/to/repo svn://remote/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.svn.commit(cwd, targets=None, msg=None, user=None, username=None, password=None, *opts)
Commit the current directory, files, or directories to
the remote Subversion repository
.INDENT 7.0
.TP
.B cwd
The path to the Subversion repository
.TP
.B targets
None
files and directories to pass to the command as arguments
Default: svn uses \(aq.\(aq
.TP
.B msg
None
Message to attach to the commit log
.TP
.B user
None
Run svn as a user other than what the minion runs as
.TP
.B username
None
Connect to the Subversion server as another user
.TP
.B password
None
Connect to the Subversion server with this password
.sp
New in version 0.17.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq svn.commit /path/to/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.svn.diff(cwd, targets=None, user=None, username=None, password=None, *opts)
Return the diff of the current directory, files, or directories from
the remote Subversion repository
.INDENT 7.0
.TP
.B cwd
The path to the Subversion repository
.TP
.B targets
None
files and directories to pass to the command as arguments
Default: svn uses \(aq.\(aq
.TP
.B user
None
Run svn as a user other than what the minion runs as
.TP
.B username
None
Connect to the Subversion server as another user
.TP
.B password
None
Connect to the Subversion server with this password
.sp
New in version 0.17.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq svn.diff /path/to/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.svn.export(cwd, remote, target=None, user=None, username=None, password=None, revision=\(aqHEAD\(aq, *opts)
Create an unversioned copy of a tree.
.INDENT 7.0
.TP
.B cwd
The path to the Subversion repository
.TP
.B remote
None
URL and path to file or directory checkout
.TP
.B target
None
The name to give the file or directory working copy
Default: svn uses the remote basename
.TP
.B user
None
Run svn as a user other than what the minion runs as
.TP
.B username
None
Connect to the Subversion server as another user
.TP
.B password
None
Connect to the Subversion server with this password
.sp
New in version 0.17.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq svn.export /path/to/repo svn://remote/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.svn.info(cwd, targets=None, user=None, username=None, password=None, fmt=\(aqstr\(aq)
Display the Subversion information from the checkout.
.INDENT 7.0
.TP
.B cwd
The path to the Subversion repository
.TP
.B targets
None
files, directories, and URLs to pass to the command as arguments
svn uses \(aq.\(aq by default
.TP
.B user
None
Run svn as a user other than what the minion runs as
.TP
.B username
None
Connect to the Subversion server as another user
.TP
.B password
None
Connect to the Subversion server with this password
.sp
New in version 0.17.0.

.TP
.B fmt
str
How to fmt the output from info.
(str, xml, list, dict)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq svn.info /path/to/svn/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.svn.remove(cwd, targets, msg=None, user=None, username=None, password=None, *opts)
Remove files and directories from the Subversion repository
.INDENT 7.0
.TP
.B cwd
The path to the Subversion repository
.TP
.B targets
None
files, directories, and URLs to pass to the command as arguments
.TP
.B msg
None
Message to attach to the commit log
.TP
.B user
None
Run svn as a user other than what the minion runs as
.TP
.B username
None
Connect to the Subversion server as another user
.TP
.B password
None
Connect to the Subversion server with this password
.sp
New in version 0.17.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq svn.remove /path/to/repo /path/to/repo/remove
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.svn.status(cwd, targets=None, user=None, username=None, password=None, *opts)
Display the status of the current directory, files, or
directories in the Subversion repository
.INDENT 7.0
.TP
.B cwd
The path to the Subversion repository
.TP
.B targets
None
files, directories, and URLs to pass to the command as arguments
Default: svn uses \(aq.\(aq
.TP
.B user
None
Run svn as a user other than what the minion runs as
.TP
.B username
None
Connect to the Subversion server as another user
.TP
.B password
None
Connect to the Subversion server with this password
.sp
New in version 0.17.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq svn.status /path/to/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.svn.switch(cwd, remote, target=None, user=None, username=None, password=None, *opts)
New in version 2014.1.0.

.sp
Switch a working copy of a remote Subversion repository
directory
.INDENT 7.0
.TP
.B cwd
The path to the Subversion repository
.TP
.B remote
None
URL to switch
.TP
.B target
None
The name to give the file or directory working copy
Default: svn uses the remote basename
.TP
.B user
None
Run svn as a user other than what the minion runs as
.TP
.B username
None
Connect to the Subversion server as another user
.TP
.B password
None
Connect to the Subversion server with this password
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq svn.switch /path/to/repo svn://remote/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.svn.update(cwd, targets=None, user=None, username=None, password=None, *opts)
Update the current directory, files, or directories from
the remote Subversion repository
.INDENT 7.0
.TP
.B cwd
The path to the Subversion repository
.TP
.B targets
None
files and directories to pass to the command as arguments
Default: svn uses \(aq.\(aq
.TP
.B user
None
Run svn as a user other than what the minion runs as
.TP
.B password
None
Connect to the Subversion server with this password
.sp
New in version 0.17.0.

.TP
.B username
None
Connect to the Subversion server as another user
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq svn.update /path/to/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.swarm
.SS Docker Swarm Module using Docker\(aqs Python SDK
.INDENT 0.0
.TP
.B codeauthor
Tyler Jones <\fI\%jonestyler806@gmail.com\fP>
.UNINDENT
.sp
New in version 2018.3.0.

.sp
The Docker Swarm Module is used to manage and create Docker Swarms.
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
Docker installed on the host
.IP \(bu 2
Docker python sdk >= 2.5.1
.UNINDENT
.SS Docker Python SDK
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install \-U docker
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
More information: \fI\%https://docker\-py.readthedocs.io/en/stable/\fP
.INDENT 0.0
.TP
.B salt.modules.swarm.joinswarm(remote_addr=<class \(aqint\(aq>, listen_addr=<class \(aqint\(aq>, token=<class \(aqstr\(aq>)
Join a Swarm Worker to the cluster
.INDENT 7.0
.TP
.B remote_addr
The manager node you want to connect to for the swarm
.TP
.B listen_addr
Listen address used for inter\-manager communication if the node gets promoted to manager,
as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP)
.TP
.B token
Either the manager join token or the worker join token.
You can get the worker or manager token via \fBsalt \(aq*\(aq swarm.swarm_tokens\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq swarm.joinswarm remote_addr=192.168.50.10 listen_addr=\(aq0.0.0.0\(aq             token=\(aqSWMTKN\-1\-64tux2g0701r84ofq93zppcih0pe081akq45owe9ts61f30x4t\-06trjugdu7x2z47j938s54il\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.swarm.leave_swarm(force=<class \(aqbool\(aq>)
Force the minion to leave the swarm
.INDENT 7.0
.TP
.B force
Will force the minion/worker/manager to leave the swarm
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq swarm.leave_swarm force=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.swarm.node_ls(server=<class \(aqstr\(aq>)
Displays Information about Swarm Nodes with passing in the server
.INDENT 7.0
.TP
.B server
The minion/server name
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq swarm.node_ls server=minion1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.swarm.remove_node(node_id=<class \(aqstr\(aq>, force=<class \(aqbool\(aq>)
Remove a node from a swarm and the target needs to be a swarm manager
.INDENT 7.0
.TP
.B node_id
The node id from the return of swarm.node_ls
.TP
.B force
Forcefully remove the node/minion from the service
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq swarm.remove_node node_id=z4gjbe9rwmqahc2a91snvolm5 force=false
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.swarm.remove_service(service=<class \(aqstr\(aq>)
Remove Swarm Service
.INDENT 7.0
.TP
.B service
The name of the service
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq swarm.remove_service service=Test_Service
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.swarm.service_create(image=<class \(aqstr\(aq>, name=<class \(aqstr\(aq>, command=<class \(aqstr\(aq>, hostname=<class \(aqstr\(aq>, replicas=<class \(aqint\(aq>, target_port=<class \(aqint\(aq>, published_port=<class \(aqint\(aq>)
Create Docker Swarm Service Create
.INDENT 7.0
.TP
.B image
The docker image
.TP
.B name
Is the service name
.TP
.B command
The docker command to run in the container at launch
.TP
.B hostname
The hostname of the containers
.TP
.B replicas
How many replicas you want running in the swarm
.TP
.B target_port
The target port on the container
.TP
.B published_port
port that\(aqs published on the host/os
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq swarm.service_create image=httpd name=Test_Service             command=None hostname=salthttpd replicas=6 target_port=80 published_port=80
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.swarm.swarm_init(advertise_addr=<class \(aqstr\(aq>, listen_addr=<class \(aqint\(aq>, force_new_cluster=<class \(aqbool\(aq>)
Initialize Docker on Minion as a Swarm Manager
.INDENT 7.0
.TP
.B advertise_addr
The ip of the manager
.TP
.B listen_addr
Listen address used for inter\-manager communication,
as well as determining the networking interface used
for the VXLAN Tunnel Endpoint (VTEP).
This can either be an address/port combination in
the form 192.168.1.1:4567,
or an interface followed by a port number,
like eth0:4567
.TP
.B force_new_cluster
Force a new cluster if True is passed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq swarm.swarm_init advertise_addr=\(aq192.168.50.10\(aq listen_addr=\(aq0.0.0.0\(aq force_new_cluster=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.swarm.swarm_service_info(service_name=<class \(aqstr\(aq>)
Swarm Service Information
.INDENT 7.0
.TP
.B service_name
The name of the service that you want information on about the service
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq swarm.swarm_service_info service_name=Test_Service
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.swarm.swarm_tokens()
Get the Docker Swarm Manager or Worker join tokens
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq swarm.swarm_tokens
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.swarm.update_node(availability=<class \(aqstr\(aq>, node_name=<class \(aqstr\(aq>, role=<class \(aqstr\(aq>, node_id=<class \(aqstr\(aq>, version=<class \(aqint\(aq>)
Updates docker swarm nodes/needs to target a manager node/minion
.INDENT 7.0
.TP
.B availability
Drain or Active
.TP
.B node_name
minion/node
.TP
.B role
role of manager or worker
.TP
.B node_id
The Id and that can be obtained via swarm.node_ls
.TP
.B version
Is obtained by swarm.node_ls
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq swarm.update_node availability=drain node_name=minion2             role=worker node_id=3k9x7t8m4pel9c0nqr3iajnzp version=19
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.swift
.sp
Module for handling OpenStack Swift calls
Author: Anthony Stanton <\fI\%anthony.stanton@gmail.com\fP>
.sp
Inspired by the S3 and Nova modules
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
swiftclient Python module
.UNINDENT
.TP
.B configuration
This module is not usable until the user, tenant, auth URL, and password or auth_key
are specified either in a pillar or in the minion\(aqs config file.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
keystone.user: admin
keystone.tenant: admin
keystone.auth_url: \(aqhttp://127.0.0.1:5000/v2.0/\(aq
keystone.password: verybadpass
# or
keystone.auth_key: 203802934809284k2j34lkj2l3kj43k
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If configuration for multiple OpenStack accounts is required, they can be
set up as different configuration profiles:
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
openstack1:
  keystone.user: admin
  keystone.tenant: admin
  keystone.auth_url: \(aqhttp://127.0.0.1:5000/v2.0/\(aq
  keystone.password: verybadpass
  # or
  keystone.auth_key: 203802934809284k2j34lkj2l3kj43k

openstack2:
  keystone.user: admin
  keystone.tenant: admin
  keystone.auth_url: \(aqhttp://127.0.0.2:5000/v2.0/\(aq
  keystone.password: verybadpass
  # or
  keystone.auth_key: 303802934809284k2j34lkj2l3kj43k
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With this configuration in place, any of the swift functions can make use of
a configuration profile by declaring it explicitly.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq swift.get mycontainer myfile /tmp/file profile=openstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
NOTE: For Rackspace cloud files setting keystone.auth_version = 1 is recommended.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.swift.delete(cont, path=None, profile=None)
Delete a container, or delete an object from a container.
.sp
CLI Example to delete a container:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion swift.delete mycontainer
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example to delete an object from a container:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion swift.delete mycontainer remoteobject
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.swift.get(cont=None, path=None, local_file=None, return_bin=False, profile=None)
List the contents of a container, or return an object from a container. Set
return_bin to True in order to retrieve an object wholesale. Otherwise,
Salt will attempt to parse an XML response.
.sp
CLI Example to list containers:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion swift.get
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example to list the contents of a container:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion swift.get mycontainer
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example to return the binary contents of an object:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion swift.get mycontainer myfile.png return_bin=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example to save the binary contents of an object to a local file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion swift.get mycontainer myfile.png local_file=/tmp/myfile.png
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.swift.head()
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.swift.put(cont, path=None, local_file=None, profile=None)
Create a new container, or upload an object to a container.
.sp
CLI Example to create a container:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion swift.put mycontainer
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example to upload an object to a container:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion swift.put mycontainer remotepath local_file=/path/to/file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.sysbench
.sp
The \(aqsysbench\(aq module is used to analyze the
performance of the minions, right from the master!
It measures various system parameters such as
CPU, Memory, File I/O, Threads and Mutex.
.INDENT 0.0
.TP
.B salt.modules.sysbench.cpu()
Tests for the CPU performance of minions.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysbench.cpu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysbench.fileio()
This tests for the file read and write operations
Various modes of operations are
.INDENT 7.0
.IP \(bu 2
sequential write
.IP \(bu 2
sequential rewrite
.IP \(bu 2
sequential read
.IP \(bu 2
random read
.IP \(bu 2
random write
.IP \(bu 2
random read and write
.UNINDENT
.sp
The test works with 32 files with each file being 1Gb in size
The test consumes a lot of time. Be patient!
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysbench.fileio
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysbench.memory()
This tests the memory for read and write operations.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysbench.memory
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysbench.mutex()
Tests the implementation of mutex
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysbench.mutex
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysbench.ping()
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysbench.threads()
This tests the performance of the processor\(aqs scheduler
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysbench.threads
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.sysfs
.sp
Module for interfacing with SysFS
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%https://www.kernel.org/doc/Documentation/filesystems/sysfs.txt\fP
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.modules.sysfs.attr(key, value=None)
Access/write a SysFS attribute.
If the attribute is a symlink, its destination is returned
.INDENT 7.0
.TP
.B Returns
value or bool
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysfs.attr block/sda/queue/logical_block_size
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysfs.interfaces(root)
Generate a dictionary with all available interfaces relative to root.
Symlinks are not followed.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysfs.interfaces block/bcache0/bcache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Output example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
   \(dqr\(dq: [
     \(dqstate\(dq,
     \(dqpartial_stripes_expensive\(dq,
     \(dqwriteback_rate_debug\(dq,
     \(dqstripe_size\(dq,
     \(dqdirty_data\(dq,
     \(dqstats_total/cache_hits\(dq,
     \(dqstats_total/cache_bypass_misses\(dq,
     \(dqstats_total/bypassed\(dq,
     \(dqstats_total/cache_readaheads\(dq,
     \(dqstats_total/cache_hit_ratio\(dq,
     \(dqstats_total/cache_miss_collisions\(dq,
     \(dqstats_total/cache_misses\(dq,
     \(dqstats_total/cache_bypass_hits\(dq,
   ],
   \(dqrw\(dq: [
     \(dqwriteback_rate\(dq,
     \(dqwriteback_rate_update_seconds\(dq,
     \(dqcache_mode\(dq,
     \(dqwriteback_delay\(dq,
     \(dqlabel\(dq,
     \(dqwriteback_running\(dq,
     \(dqwriteback_metadata\(dq,
     \(dqrunning\(dq,
     \(dqwriteback_rate_p_term_inverse\(dq,
     \(dqsequential_cutoff\(dq,
     \(dqwriteback_percent\(dq,
     \(dqwriteback_rate_d_term\(dq,
     \(dqreadahead\(dq
   ],
   \(dqw\(dq: [
     \(dqstop\(dq,
     \(dqclear_stats\(dq,
     \(dqattach\(dq,
     \(dqdetach\(dq
   ]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\(aqr\(aq interfaces are read\-only
.IP \(bu 2
\(aqw\(aq interfaces are write\-only (e.g. actions)
.IP \(bu 2
\(aqrw\(aq are interfaces that can both be read or written
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysfs.read(key, root=\(aq\(aq)
Read from SysFS
.INDENT 7.0
.TP
.B Parameters
\fBkey\fP \-\- file or path in SysFS; if key is a list then root will be prefixed on each key
.TP
.B Returns
the full (tree of) SysFS attributes under key
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysfs.read class/net/em1/statistics
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysfs.target(key, full=True)
Return the basename of a SysFS key path
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkey\fP \-\- the location to resolve within SysFS
.IP \(bu 2
\fBfull\fP \-\- full path instead of basename
.UNINDENT
.TP
.B Returns
fullpath or basename of path
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysfs.read class/ttyS0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysfs.write(key, value)
Write a SysFS attribute/action
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysfs.write devices/system/cpu/cpu0/cpufreq/scaling_governor \(aqperformance\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.syslog_ng
.sp
Module for getting information about syslog\-ng
.INDENT 0.0
.TP
.B maintainer
Tibor Benke <\fI\%btibi@sch.bme.hu\fP>
.TP
.B maturity
new
.TP
.B depends
cmd
.TP
.B platform
all
.UNINDENT
.sp
This module is capable of managing syslog\-ng instances which were installed
via a package manager or from source. Users can use a directory as a parameter
in the case of most functions, which contains the syslog\-ng and syslog\-ng\-ctl
binaries.
.sp
Syslog\-ng can be installed via a package manager or from source. In the
latter case, the syslog\-ng and syslog\-ng\-ctl binaries are not available
from the PATH, so users should set location of the sbin directory with
\fI\%syslog_ng.set_binary_path\fP\&.
.sp
Similarly, users can specify the location of the configuration file with
\fI\%syslog_ng.set_config_file\fP, then
the module will use it. If it is not set, syslog\-ng uses the default
configuration file.
.INDENT 0.0
.TP
.B class  salt.modules.syslog_ng.Argument(value=\(aq\(aq)
A TypedParameterValue has one or more Arguments. For example this can be
the value of key_file.
.sp
Does not need examples.
.INDENT 7.0
.TP
.B build()
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.syslog_ng.Buildable(iterable, join_body_on=\(aq\(aq, append_extra_newline=True)
Base class of most classes, which have a build method.
.sp
It contains a common build function.
.sp
Does not need examples.
.INDENT 7.0
.TP
.B build()
Builds the textual representation of the whole configuration object
with its children.
.UNINDENT
.INDENT 7.0
.TP
.B build_body()
Builds the body of a syslog\-ng configuration object.
.UNINDENT
.INDENT 7.0
.TP
.B build_header()
Builds the header of a syslog\-ng configuration object.
.UNINDENT
.INDENT 7.0
.TP
.B build_tail()
Builds the tail of a syslog\-ng configuration object.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.syslog_ng.GivenStatement(value, add_newline=True)
.INDENT 7.0
.TP
.B This statement returns a string without modification. It can be used to
use existing configuration snippets.
.UNINDENT
.sp
Does not need examples.
.INDENT 7.0
.TP
.B build()
Builds the textual representation of the whole configuration object
with its children.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.syslog_ng.NamedStatement(type, id=\(aq\(aq, options=None)
It represents a configuration statement, which has a name, e.g. a source.
.sp
Does not need examples.
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.syslog_ng.Option(type=\(aq\(aq, params=None)
A Statement class contains Option instances.
.sp
An instance of Option can represent a file(), tcp(), udp(), etc.  option.
.sp
Does not need examples.
.INDENT 7.0
.TP
.B add_parameter(param)
.UNINDENT
.INDENT 7.0
.TP
.B build()
Builds the textual representation of the whole configuration object
with its children.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.syslog_ng.Parameter(iterable=None, join_body_on=\(aq\(aq)
An Option has one or more Parameter instances.
.sp
Does not need examples.
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.syslog_ng.ParameterValue(iterable=None, join_body_on=\(aq\(aq)
A TypedParameter can have one or more values.
.sp
Does not need examples.
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.syslog_ng.SimpleParameter(value=\(aq\(aq)
A Parameter is a SimpleParameter, if it\(aqs just a simple type, like a
string.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
destination d_file {
    file(
        \(aq/var/log/messages\(aq
    );
};
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/var/log/messages\fP is a SimpleParameter.
.sp
Does not need examples.
.INDENT 7.0
.TP
.B build()
Builds the textual representation of the whole configuration object
with its children.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.syslog_ng.SimpleParameterValue(value=\(aq\(aq)
A ParameterValuem which holds a simple type, like a string or a number.
.sp
For example in ip(127.0.0.1) 127.0.0.1 is a SimpleParameterValue.
.sp
Does not need examples.
.INDENT 7.0
.TP
.B build()
Builds the textual representation of the whole configuration object
with its children.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.syslog_ng.Statement(type, id=\(aq\(aq, options=None, has_name=True)
It represents a syslog\-ng configuration statement, e.g. source, destination,
filter.
.sp
Does not need examples.
.INDENT 7.0
.TP
.B add_child(option)
.UNINDENT
.INDENT 7.0
.TP
.B build_header()
Builds the header of a syslog\-ng configuration object.
.UNINDENT
.INDENT 7.0
.TP
.B build_tail()
Builds the tail of a syslog\-ng configuration object.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.modules.syslog_ng.SyslogNgError
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.syslog_ng.TypedParameter(type=\(aq\(aq, values=None)
A Parameter, which has a type:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
destination d_tcp {
    tcp(
        ip(127.0.0.1)
    );
};
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBip(127.0.0.1)\fP is a TypedParameter.
.sp
Does not need examples.
.INDENT 7.0
.TP
.B add_value(value)
.UNINDENT
.INDENT 7.0
.TP
.B build()
Builds the textual representation of the whole configuration object
with its children.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.syslog_ng.TypedParameterValue(type=\(aq\(aq, arguments=None)
We have to go deeper...
.sp
A TypedParameter can have a \(aqparameter\(aq, which also have a type. For example
key_file and cert_file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
source demo_tls_source {
    tcp(
        ip(0.0.0.0)
        port(1999)
        tls(
            key_file(\(aq/opt/syslog\-ng/etc/syslog\-ng/key.d/syslog\-ng.key\(aq)
            cert_file(\(aq/opt/syslog\-ng/etc/syslog\-ng/cert.d/syslog\-ng.cert\(aq)
        )
    );
};
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Does not need examples.
.INDENT 7.0
.TP
.B add_argument(arg)
.UNINDENT
.INDENT 7.0
.TP
.B build()
Builds the textual representation of the whole configuration object
with its children.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.syslog_ng.UnnamedStatement(type, options=None)
It represents a configuration statement, which doesn\(aqt have a name, e.g. a
log path.
.sp
Does not need examples.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.syslog_ng.config(name, config, write=True)
Builds syslog\-ng configuration. This function is intended to be used from
the state module, users should not use it directly!
.sp
name : the id of the Salt document or it is the format of <statement name>.id
config : the parsed YAML code
write : if True, it writes  the config into the configuration file,
otherwise just returns it
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq syslog_ng.config name=\(aqs_local\(aq config=\(dq[{\(aqtcp\(aq:[{\(aqip\(aq:\(aq127.0.0.1\(aq},{\(aqport\(aq:1233}]}]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.syslog_ng.config_test(syslog_ng_sbin_dir=None, cfgfile=None)
Runs syntax check against cfgfile. If syslog_ng_sbin_dir is specified, it
is added to the PATH during the test.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq syslog_ng.config_test
salt \(aq*\(aq syslog_ng.config_test /home/user/install/syslog\-ng/sbin
salt \(aq*\(aq syslog_ng.config_test /home/user/install/syslog\-ng/sbin /etc/syslog\-ng/syslog\-ng.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.syslog_ng.get_config_file()
Returns the configuration directory, which contains syslog\-ng.conf.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq syslog_ng.get_config_file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.syslog_ng.modules(syslog_ng_sbin_dir=None)
Returns the available modules. If syslog_ng_sbin_dir is specified, it
is added to the PATH during the execution of the command syslog\-ng.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq syslog_ng.modules
salt \(aq*\(aq syslog_ng.modules /home/user/install/syslog\-ng/sbin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.syslog_ng.reload_(name)
Reloads syslog\-ng. This function is intended to be used from states.
.sp
If \fI\%syslog_ng.set_config_file\fP, is called before, this function
will use the set binary path.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq syslog_ng.reload
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.syslog_ng.set_binary_path(name)
Sets the path, where the syslog\-ng binary can be found. This function is
intended to be used from states.
.sp
If syslog\-ng is installed via a package manager, users don\(aqt need to use
this function.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq syslog_ng.set_binary_path name=/usr/sbin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.syslog_ng.set_config_file(name)
Sets the configuration\(aqs name. This function is intended to be used from
states.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq syslog_ng.set_config_file name=/etc/syslog\-ng
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.syslog_ng.set_parameters(version=None, binary_path=None, config_file=None, *args, **kwargs)
Sets variables.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq syslog_ng.set_parameters version=\(aq3.6\(aq
salt \(aq*\(aq syslog_ng.set_parameters  binary_path=/home/user/install/syslog\-ng/sbin config_file=/home/user/install/syslog\-ng/etc/syslog\-ng.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.syslog_ng.start(name=None, user=None, group=None, chroot=None, caps=None, no_caps=False, pidfile=None, enable_core=False, fd_limit=None, verbose=False, debug=False, trace=False, yydebug=False, persist_file=None, control=None, worker_threads=None)
Ensures, that syslog\-ng is started via the given parameters. This function
is intended to be used from the state module.
.sp
Users shouldn\(aqt use this function, if the service module is available on
their system. If \fI\%syslog_ng.set_config_file\fP, is called before, this function
will use the set binary path.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq syslog_ng.start
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.syslog_ng.stats(syslog_ng_sbin_dir=None)
Returns statistics from the running syslog\-ng instance. If
syslog_ng_sbin_dir is specified, it is added to the PATH during the
execution of the command syslog\-ng\-ctl.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq syslog_ng.stats
salt \(aq*\(aq syslog_ng.stats /home/user/install/syslog\-ng/sbin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.syslog_ng.stop(name=None)
Kills syslog\-ng. This function is intended to be used from the state module.
.sp
Users shouldn\(aqt use this function, if the service module is available on
their system.  If \fI\%syslog_ng.set_config_file\fP is called before, this function
will use the set binary path.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq syslog_ng.stop
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.syslog_ng.version(syslog_ng_sbin_dir=None)
Returns the version of the installed syslog\-ng. If syslog_ng_sbin_dir is
specified, it is added to the PATH during the execution of the command
syslog\-ng.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq syslog_ng.version
salt \(aq*\(aq syslog_ng.version /home/user/install/syslog\-ng/sbin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.syslog_ng.write_config(config, newlines=2)
Writes the given parameter config into the config file. This function is
intended to be used from states.
.sp
If \fI\%syslog_ng.set_config_file\fP, is called before, this function
will use the set config file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq syslog_ng.write_config config=\(aq# comment\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.syslog_ng.write_version(name)
Removes the previous configuration file, then creates a new one and writes
the name line. This function is intended to be used from states.
.sp
If \fI\%syslog_ng.set_config_file\fP, is called before, this function
will use the set config file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq syslog_ng.write_version name=\(dq3.6\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.sysmod
.sp
The sys module provides information about the available functions on the minion
.INDENT 0.0
.TP
.B salt.modules.sysmod.argspec(module=\(aq\(aq)
Return the argument specification of functions in Salt execution
modules.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.argspec pkg.install
salt \(aq*\(aq sys.argspec sys
salt \(aq*\(aq sys.argspec
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Module names can be specified as globs.
.sp
New in version 2015.5.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.argspec \(aqpkg.*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.doc(*args)
Return the docstrings for all modules. Optionally, specify a module or a
function to narrow the selection.
.sp
The strings are aggregated into a single document on the master for easy
reading.
.sp
Multiple modules/functions can be specified.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.doc
salt \(aq*\(aq sys.doc sys
salt \(aq*\(aq sys.doc sys.doc
salt \(aq*\(aq sys.doc network.traceroute user.info
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Modules can be specified as globs.
.sp
New in version 2015.5.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.doc \(aqsys.*\(aq
salt \(aq*\(aq sys.doc \(aqsys.list_*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.list_functions(*args, **kwargs)
List the functions for all modules. Optionally, specify a module or modules
from which to list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_functions
salt \(aq*\(aq sys.list_functions sys
salt \(aq*\(aq sys.list_functions sys user
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 0.12.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_functions \(aqmodule.specific_function\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Function names can be specified as globs.
.sp
New in version 2015.5.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_functions \(aqsys.list_*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.list_modules(*args)
List the modules loaded on the minion
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_modules
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Module names can be specified as globs.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_modules \(aqs*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.list_renderers(*args)
List the renderers loaded on the minion
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_renderers
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Render names can be specified as globs.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_renderers \(aqyaml*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.list_returner_functions(*args, **kwargs)
List the functions for all returner modules. Optionally, specify a returner
module or modules from which to list.
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_returner_functions
salt \(aq*\(aq sys.list_returner_functions mysql
salt \(aq*\(aq sys.list_returner_functions mysql etcd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returner names can be specified as globs.
.sp
New in version 2015.5.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_returner_functions \(aqsqlite3.get_*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.list_returners(*args)
List the returners loaded on the minion
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_returners
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returner names can be specified as globs.
.sp
New in version 2015.5.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_returners \(aqs*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.list_runner_functions(*args, **kwargs)
List the functions for all runner modules. Optionally, specify a runner
module or modules from which to list.
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_runner_functions
salt \(aq*\(aq sys.list_runner_functions state
salt \(aq*\(aq sys.list_runner_functions state virt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Runner function names can be specified as globs.
.sp
New in version 2015.5.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_runner_functions \(aqstate.*\(aq \(aqvirt.*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.list_runners(*args)
List the runners loaded on the minion
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_runners
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Runner names can be specified as globs.
.sp
New in version 2015.5.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_runners \(aqm*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.list_state_functions(*args, **kwargs)
List the functions for all state modules. Optionally, specify a state
module or modules from which to list.
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_state_functions
salt \(aq*\(aq sys.list_state_functions file
salt \(aq*\(aq sys.list_state_functions pkg user
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
State function names can be specified as globs.
.sp
New in version 2015.5.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_state_functions \(aqfile.*\(aq
salt \(aq*\(aq sys.list_state_functions \(aqfile.s*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.9.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_state_functions \(aqmodule.specific_function\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.list_state_modules(*args)
List the modules loaded on the minion
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_state_modules
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
State module names can be specified as globs.
.sp
New in version 2015.5.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.list_state_modules \(aqmysql_*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.reload_modules()
Tell the minion to reload the execution modules
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.reload_modules
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.renderer_doc(*args)
Return the docstrings for all renderers. Optionally, specify a renderer or a
function to narrow the selection.
.sp
The strings are aggregated into a single document on the master for easy
reading.
.sp
Multiple renderers can be specified.
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.renderer_doc
salt \(aq*\(aq sys.renderer_doc cheetah
salt \(aq*\(aq sys.renderer_doc jinja json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Renderer names can be specified as globs.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.renderer_doc \(aqc*\(aq \(aqj*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.returner_argspec(module=\(aq\(aq)
Return the argument specification of functions in Salt returner
modules.
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.returner_argspec xmpp
salt \(aq*\(aq sys.returner_argspec xmpp smtp
salt \(aq*\(aq sys.returner_argspec
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returner names can be specified as globs.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.returner_argspec \(aqsqlite3.*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.returner_doc(*args)
Return the docstrings for all returners. Optionally, specify a returner or a
function to narrow the selection.
.sp
The strings are aggregated into a single document on the master for easy
reading.
.sp
Multiple returners/functions can be specified.
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.returner_doc
salt \(aq*\(aq sys.returner_doc sqlite3
salt \(aq*\(aq sys.returner_doc sqlite3.get_fun
salt \(aq*\(aq sys.returner_doc sqlite3.get_fun etcd.get_fun
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returner names can be specified as globs.
.sp
New in version 2015.5.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.returner_doc \(aqsqlite3.get_*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.runner_argspec(module=\(aq\(aq)
Return the argument specification of functions in Salt runner
modules.
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.runner_argspec state
salt \(aq*\(aq sys.runner_argspec http
salt \(aq*\(aq sys.runner_argspec
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Runner names can be specified as globs.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.runner_argspec \(aqwinrepo.*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.runner_doc(*args)
Return the docstrings for all runners. Optionally, specify a runner or a
function to narrow the selection.
.sp
The strings are aggregated into a single document on the master for easy
reading.
.sp
Multiple runners/functions can be specified.
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.runner_doc
salt \(aq*\(aq sys.runner_doc cache
salt \(aq*\(aq sys.runner_doc cache.grains
salt \(aq*\(aq sys.runner_doc cache.grains mine.get
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Runner names can be specified as globs.
.sp
New in version 2015.5.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.runner_doc \(aqcache.clear_*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.state_argspec(module=\(aq\(aq)
Return the argument specification of functions in Salt state
modules.
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.state_argspec pkg.installed
salt \(aq*\(aq sys.state_argspec file
salt \(aq*\(aq sys.state_argspec
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
State names can be specified as globs.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.state_argspec \(aqpkg.*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.state_doc(*args)
Return the docstrings for all states. Optionally, specify a state or a
function to narrow the selection.
.sp
The strings are aggregated into a single document on the master for easy
reading.
.sp
Multiple states/functions can be specified.
.sp
New in version 2014.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.state_doc
salt \(aq*\(aq sys.state_doc service
salt \(aq*\(aq sys.state_doc service.running
salt \(aq*\(aq sys.state_doc service.running ipables.append
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
State names can be specified as globs.
.sp
New in version 2015.5.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.state_doc \(aqservice.*\(aq \(aqiptables.*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysmod.state_schema(module=\(aq\(aq)
Return a JSON Schema for the given state function(s)
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sys.state_schema
salt \(aq*\(aq sys.state_schema pkg.installed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.sysrc
.sp
sysrc module for FreeBSD
.INDENT 0.0
.TP
.B salt.modules.sysrc.get(**kwargs)
Return system rc configuration variables
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysrc.get includeDefaults=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysrc.remove(name, **kwargs)
Remove system rc configuration variables
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysrc.remove name=sshd_enable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.sysrc.set_(name, value, **kwargs)
Set system rc configuration variables
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq sysrc.set name=sshd_flags value=\(dq\-p 2222\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.system
.sp
Support for reboot, shutdown, etc on POSIX\-like systems.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If a wrapper such as \fBmolly\-guard\fP to intercept \fIinteractive\fP shutdown
commands is configured, calling \fI\%system.halt\fP,
\fI\%system.poweroff\fP,
\fI\%system.reboot\fP, and
\fI\%system.shutdown\fP with \fBsalt\-call\fP will
hang indefinitely while the wrapper script waits for user input. Calling them
with \fBsalt\fP will work as expected.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.get_computer_desc()
Get \fBPRETTY_HOSTNAME\fP value stored in \fB/etc/machine\-info\fP
If this file doesn\(aqt exist or the variable doesn\(aqt exist
return \fBFalse\fP\&.
.INDENT 7.0
.TP
.B Returns
Value of \fBPRETTY_HOSTNAME\fP in \fB/etc/machine\-info\fP\&.
If file/variable does not exist \fBFalse\fP\&.
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_computer_desc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.get_computer_name()
Get hostname.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.get_hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.get_reboot_required_witnessed()
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This only applies to Minions running on NI Linux RT
.UNINDENT
.UNINDENT
.sp
Determine if at any time during the current boot session the salt minion
witnessed an event indicating that a reboot is required.
.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if the a reboot request was witnessed, \fBFalse\fP otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_reboot_required_witnessed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.get_system_date(utc_offset=None)
Get the system date
.INDENT 7.0
.TP
.B Parameters
\fButc_offset\fP (\fI\%str\fP) \-\- The UTC offset in 4 digit (\fB+0600\fP) format with an
optional sign (\fB+\fP/\fB\-\fP).  Will default to \fBNone\fP which will use the local
timezone. To set the time based off of UTC use \fB+0000\fP\&. Note: If
being passed through the command line will need to be quoted twice to
allow negative offsets (e.g. \fB\(dq\(aq+0000\(aq\(dq\fP).
.TP
.B Returns
Returns the system date.
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_system_date
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.get_system_date_time(utc_offset=None)
Get the system date/time.
.INDENT 7.0
.TP
.B Parameters
\fButc_offset\fP (\fI\%str\fP) \-\- The UTC offset in 4 digit (\fB+0600\fP) format with an
optional sign (\fB+\fP/\fB\-\fP).  Will default to \fBNone\fP which will use the local
timezone. To set the time based off of UTC use \fB+0000\fP\&. Note: If
being passed through the command line will need to be quoted twice to
allow negative offsets (e.g. \fB\(dq\(aq+0000\(aq\(dq\fP).
.TP
.B Returns
Returns the system time in \fBYYYY\-MM\-DD hh:mm:ss\fP format.
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_system_date_time \(dq\(aq\-0500\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.get_system_time(utc_offset=None)
Get the system time.
.INDENT 7.0
.TP
.B Parameters
\fButc_offset\fP (\fI\%str\fP) \-\- The UTC offset in 4 digit (e.g. \fB+0600\fP) format with an
optional sign (\fB+\fP/\fB\-\fP).  Will default to \fBNone\fP which will use the local
timezone. To set the time based off of UTC use \fB+0000\fP\&. Note: If
being passed through the command line will need to be quoted twice to
allow negative offsets (e.g. \fB\(dq\(aq+0000\(aq\(dq\fP).
.TP
.B Returns
Returns the system time in \fBHH:MM:SS AM/PM\fP format.
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_system_time
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.halt()
Halt a running system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.halt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.has_settable_hwclock()
Returns \fBTrue\fP if the system has a hardware clock capable of being
set from software.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.has_settable_hwclock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.init(runlevel)
Change the system runlevel on sysV compatible systems
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.init 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.poweroff()
Poweroff a running system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.poweroff
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.reboot(at_time=None)
Reboot the system
.INDENT 7.0
.TP
.B at_time
The wait time in minutes before the system will be rebooted.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.reboot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.set_computer_desc(desc)
Set \fBPRETTY_HOSTNAME\fP value stored in \fB/etc/machine\-info\fP
This will create the file if it does not exist. If
it is unable to create or modify this file, \fBFalse\fP is returned.
.INDENT 7.0
.TP
.B Parameters
\fBdesc\fP (\fI\%str\fP) \-\- The computer description
.TP
.B Returns
\fBFalse\fP on failure. \fBTrue\fP if successful.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_computer_desc \(dqMichael\(aqs laptop\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.set_computer_name(hostname)
Modify hostname.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_computer_name master.saltstack.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.set_reboot_required_witnessed()
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This only applies to Minions running on NI Linux RT
.UNINDENT
.UNINDENT
.sp
This function is used to remember that an event indicating that a reboot is
required was witnessed. This function writes to a temporary filesystem so
the event gets cleared upon reboot.
.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_reboot_required_witnessed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.set_system_date(newdate, utc_offset=None)
Set the system date. Use \fB<mm\-dd\-yy>\fP format for the date.
.INDENT 7.0
.TP
.B Parameters
\fBnewdate\fP (\fI\%str\fP) \-\-
.sp
The date to set. Can be any of the following formats:
.INDENT 7.0
.IP \(bu 2
\fBYYYY\-MM\-DD\fP
.IP \(bu 2
\fBMM\-DD\-YYYY\fP
.IP \(bu 2
\fBMM\-DD\-YY\fP
.IP \(bu 2
\fBMM/DD/YYYY\fP
.IP \(bu 2
\fBMM/DD/YY\fP
.IP \(bu 2
\fBYYYY/MM/DD\fP
.UNINDENT

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_system_date \(aq03\-28\-13\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.set_system_date_time(years=None, months=None, days=None, hours=None, minutes=None, seconds=None, utc_offset=None)
Set the system date and time. Each argument is an element of the date, but
not required. If an element is not passed, the current system value for
that element will be used. For example, if the year is not passed, the
current system year will be used. (Used by
\fI\%system.set_system_date\fP and
\fI\%system.set_system_time\fP)
.sp
Updates hardware clock, if present, in addition to software
(kernel) clock.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fByears\fP (\fI\%int\fP) \-\- Years digit, e.g.: \fB2015\fP
.IP \(bu 2
\fBmonths\fP (\fI\%int\fP) \-\- Months digit: \fB1\fP\-\fB12\fP
.IP \(bu 2
\fBdays\fP (\fI\%int\fP) \-\- Days digit: \fB1\fP\-\fB31\fP
.IP \(bu 2
\fBhours\fP (\fI\%int\fP) \-\- Hours digit: \fB0\fP\-\fB23\fP
.IP \(bu 2
\fBminutes\fP (\fI\%int\fP) \-\- Minutes digit: \fB0\fP\-\fB59\fP
.IP \(bu 2
\fBseconds\fP (\fI\%int\fP) \-\- Seconds digit: \fB0\fP\-\fB59\fP
.IP \(bu 2
\fButc_offset\fP (\fI\%str\fP) \-\- The UTC offset in 4 digit (\fB+0600\fP) format with an
optional sign (\fB+\fP/\fB\-\fP).  Will default to \fBNone\fP which will use the local
timezone. To set the time based off of UTC use \fB+0000\fP\&. Note: If
being passed through the command line will need to be quoted twice to
allow negative offsets (e.g. \fB\(dq\(aq+0000\(aq\(dq\fP).
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful. Otherwise \fBFalse\fP\&.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_system_date_time 2015 5 12 11 37 53 \(dq\(aq\-0500\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.set_system_time(newtime, utc_offset=None)
Set the system time.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnewtime\fP (\fI\%str\fP) \-\-
.sp
The time to set. Can be any of the following formats.
.INDENT 2.0
.IP \(bu 2
\fBHH:MM:SS AM/PM\fP
.IP \(bu 2
\fBHH:MM AM/PM\fP
.IP \(bu 2
\fBHH:MM:SS\fP (24 hour)
.IP \(bu 2
\fBHH:MM\fP (24 hour)
.UNINDENT
.sp
Note that the Salt command line parser parses the date/time
before we obtain the argument (preventing us from doing UTC)
Therefore the argument must be passed in as a string.
Meaning the text might have to be quoted twice on the command line.

.IP \(bu 2
\fButc_offset\fP (\fI\%str\fP) \-\- The UTC offset in 4 digit (\fB+0600\fP) format with an
optional sign (\fB+\fP/\fB\-\fP).  Will default to \fBNone\fP which will use the local
timezone. To set the time based off of UTC use \fB+0000\fP\&. Note: If
being passed through the command line will need to be quoted twice to
allow negative offsets (e.g. \fB\(dq\(aq+0000\(aq\(dq\fP)
.UNINDENT
.TP
.B Returns
Returns \fBTrue\fP if successful. Otherwise \fBFalse\fP\&.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_system_time \(dq\(aq11:20\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system.shutdown(at_time=None)
Shutdown a running system
.INDENT 7.0
.TP
.B at_time
The wait time in minutes before the system will be shutdown.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.shutdown 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.system_profiler
.sp
System Profiler Module
.sp
Interface with macOS\(aqs command\-line System Profiler utility to get
information about package receipts and installed applications.
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B salt.modules.system_profiler.applications()
Return the results of a call to
\fBsystem_profiler \-xml \-detail full SPApplicationsDataType\fP
as a dictionary.  Top\-level keys of the dictionary
are the names of each set of install receipts, since
there can be multiple receipts with the same name.
Contents of each key are a list of dictionaries.
.sp
Note that this can take a long time depending on how many
applications are installed on the target Mac.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq systemprofiler.applications
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.system_profiler.receipts()
Return the results of a call to
\fBsystem_profiler \-xml \-detail full SPInstallHistoryDataType\fP
as a dictionary.  Top\-level keys of the dictionary
are the names of each set of install receipts, since
there can be multiple receipts with the same name.
Contents of each key are a list of dictionaries.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq systemprofiler.receipts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.systemd_service
.sp
Provides the service module for systemd
.sp
New in version 0.10.0.

.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage services on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqservice.start\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
This is an implementation of virtual \(aqservice\(aq module. As such, you must
call it under the name \(aqservice\(aq and NOT \(aqsystemd\(aq. You can see that also
in the examples below.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.available(name)
New in version 0.10.4.

.sp
Check that the given service is available taking into account template
units.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.available sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.disable(name, no_block=False, root=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands run by this function from the \fBsalt\-minion\fP daemon\(aqs
control group. This is done to avoid a race condition in cases where
the \fBsalt\-minion\fP service is restarted while a service is being
modified. If desired, usage of \fI\%systemd\-run(1)\fP can be suppressed by
setting a \fI\%config option\fP called
\fBsystemd.scope\fP, with a value of \fBFalse\fP (no quotes).

.sp
Disable the named service to not start when the system boots
.INDENT 7.0
.TP
.B no_block
False
Set to \fBTrue\fP to start the service using \fB\-\-no\-block\fP\&.
.sp
New in version 2017.7.0.

.TP
.B root
Enable/disable/mask unit files in the specified root directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.disabled(name, root=None)
Return if the named service is disabled from starting on boot
.INDENT 7.0
.TP
.B root
Enable/disable/mask unit files in the specified root directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.enable(name, no_block=False, unmask=False, unmask_runtime=False, root=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands run by this function from the \fBsalt\-minion\fP daemon\(aqs
control group. This is done to avoid a race condition in cases where
the \fBsalt\-minion\fP service is restarted while a service is being
modified. If desired, usage of \fI\%systemd\-run(1)\fP can be suppressed by
setting a \fI\%config option\fP called
\fBsystemd.scope\fP, with a value of \fBFalse\fP (no quotes).

.sp
Enable the named service to start when the system boots
.INDENT 7.0
.TP
.B no_block
False
Set to \fBTrue\fP to start the service using \fB\-\-no\-block\fP\&.
.sp
New in version 2017.7.0.

.TP
.B unmask
False
Set to \fBTrue\fP to remove an indefinite mask before attempting to
enable the service.
.sp
New in version 2017.7.0: In previous releases, Salt would simply unmask a service before
enabling. This behavior is no longer the default.

.TP
.B unmask_runtime
False
Set to \fBTrue\fP to remove a runtime mask before attempting to enable
the service.
.sp
New in version 2017.7.0: In previous releases, Salt would simply unmask a service before
enabling. This behavior is no longer the default.

.TP
.B root
Enable/disable/mask unit files in the specified root directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.enabled(name, root=None, **kwargs)
Return if the named service is enabled to start on boot
.INDENT 7.0
.TP
.B root
Enable/disable/mask unit files in the specified root directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.execs(root=None)
New in version 2014.7.0.

.sp
Return a list of all files specified as \fBExecStart\fP for all services.
.INDENT 7.0
.TP
.B root
Enable/disable/mask unit files in the specified root directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.execs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.firstboot(locale=None, locale_message=None, keymap=None, timezone=None, hostname=None, machine_id=None, root=None)
New in version 3001.

.sp
Call systemd\-firstboot to configure basic settings of the system
.INDENT 7.0
.TP
.B locale
Set primary locale (LANG=)
.TP
.B locale_message
Set message locale (LC_MESSAGES=)
.TP
.B keymap
Set keymap
.TP
.B timezone
Set timezone
.TP
.B hostname
Set host name
.TP
.B machine_id
Set machine ID
.TP
.B root
Operate on an alternative filesystem root
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.firstboot keymap=jp locale=en_US.UTF\-8
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.force_reload(name, no_block=True, unmask=False, unmask_runtime=False)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands run by this function from the \fBsalt\-minion\fP daemon\(aqs
control group. This is done to avoid a race condition in cases where
the \fBsalt\-minion\fP service is restarted while a service is being
modified. If desired, usage of \fI\%systemd\-run(1)\fP can be suppressed by
setting a \fI\%config option\fP called
\fBsystemd.scope\fP, with a value of \fBFalse\fP (no quotes).

.sp
New in version 0.12.0.

.sp
Force\-reload the specified service with systemd
.INDENT 7.0
.TP
.B no_block
False
Set to \fBTrue\fP to start the service using \fB\-\-no\-block\fP\&.
.sp
New in version 2017.7.0.

.TP
.B unmask
False
Set to \fBTrue\fP to remove an indefinite mask before attempting to
force\-reload the service.
.sp
New in version 2017.7.0: In previous releases, Salt would simply unmask a service before
force\-reloading. This behavior is no longer the default.

.TP
.B unmask_runtime
False
Set to \fBTrue\fP to remove a runtime mask before attempting to
force\-reload the service.
.sp
New in version 2017.7.0: In previous releases, Salt would simply unmask a service before
force\-reloading. This behavior is no longer the default.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.force_reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.get_all(root=None)
Return a list of all available services
.INDENT 7.0
.TP
.B root
Enable/disable/mask unit files in the specified root directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.get_disabled(root=None)
Return a list of all disabled services
.INDENT 7.0
.TP
.B root
Enable/disable/mask unit files in the specified root directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_disabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.get_enabled(root=None)
Return a list of all enabled services
.INDENT 7.0
.TP
.B root
Enable/disable/mask unit files in the specified root directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.get_running()
Return a list of all running services, so far as systemd is concerned
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_running
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.get_static(root=None)
New in version 2015.8.5.

.sp
Return a list of all static services
.INDENT 7.0
.TP
.B root
Enable/disable/mask unit files in the specified root directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_static
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.mask(name, runtime=False, root=None)
New in version 2015.5.0.

.sp
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands run by this function from the \fBsalt\-minion\fP daemon\(aqs
control group. This is done to avoid a race condition in cases where
the \fBsalt\-minion\fP service is restarted while a service is being
modified. If desired, usage of \fI\%systemd\-run(1)\fP can be suppressed by
setting a \fI\%config option\fP called
\fBsystemd.scope\fP, with a value of \fBFalse\fP (no quotes).

.sp
Mask the specified service with systemd
.INDENT 7.0
.TP
.B runtime
False
Set to \fBTrue\fP to mask this service only until the next reboot
.sp
New in version 2015.8.5.

.TP
.B root
Enable/disable/mask unit files in the specified root directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.mask foo
salt \(aq*\(aq service.mask foo runtime=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.masked(name, runtime=False, root=None)
New in version 2015.8.0.

.sp
Changed in version 2015.8.5: The return data for this function has changed. If the service is
masked, the return value will now be the output of the \fBsystemctl
is\-enabled\fP command (so that a persistent mask can be distinguished
from a runtime mask). If the service is not masked, then \fBFalse\fP will
be returned.

.sp
Changed in version 2017.7.0: This function now returns a boolean telling the user whether a mask
specified by the new \fBruntime\fP argument is set. If \fBruntime\fP is
\fBFalse\fP, this function will return \fBTrue\fP if an indefinite mask is
set for the named service (otherwise \fBFalse\fP will be returned). If
\fBruntime\fP is \fBFalse\fP, this function will return \fBTrue\fP if a
runtime mask is set, otherwise \fBFalse\fP\&.

.sp
Check whether or not a service is masked
.INDENT 7.0
.TP
.B runtime
False
Set to \fBTrue\fP to check for a runtime mask
.sp
New in version 2017.7.0: In previous versions, this function would simply return the output
of \fBsystemctl is\-enabled\fP when the service was found to be
masked. However, since it is possible to both have both indefinite
and runtime masks on a service simultaneously, this function now
only checks for runtime masks if this argument is set to \fBTrue\fP\&.
Otherwise, it will check for an indefinite mask.

.TP
.B root
Enable/disable/mask unit files in the specified root directory
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.masked foo
salt \(aq*\(aq service.masked foo runtime=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.missing(name)
New in version 2014.1.0.

.sp
The inverse of \fBservice.available\fP\&. Returns \fBTrue\fP if the specified
service is not available, otherwise returns \fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.missing sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.offline()
New in version 3004.

.sp
Check if systemd is working in offline mode, where is not possible
to talk with PID 1.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.offline
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.reload_(name, no_block=False, unmask=False, unmask_runtime=False)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands run by this function from the \fBsalt\-minion\fP daemon\(aqs
control group. This is done to avoid a race condition in cases where
the \fBsalt\-minion\fP service is restarted while a service is being
modified. If desired, usage of \fI\%systemd\-run(1)\fP can be suppressed by
setting a \fI\%config option\fP called
\fBsystemd.scope\fP, with a value of \fBFalse\fP (no quotes).

.sp
Reload the specified service with systemd
.INDENT 7.0
.TP
.B no_block
False
Set to \fBTrue\fP to reload the service using \fB\-\-no\-block\fP\&.
.sp
New in version 2017.7.0.

.TP
.B unmask
False
Set to \fBTrue\fP to remove an indefinite mask before attempting to
reload the service.
.sp
New in version 2017.7.0: In previous releases, Salt would simply unmask a service before
reloading. This behavior is no longer the default.

.TP
.B unmask_runtime
False
Set to \fBTrue\fP to remove a runtime mask before attempting to reload
the service.
.sp
New in version 2017.7.0: In previous releases, Salt would simply unmask a service before
reloading. This behavior is no longer the default.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.restart(name, no_block=False, unmask=False, unmask_runtime=False)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands run by this function from the \fBsalt\-minion\fP daemon\(aqs
control group. This is done to avoid a race condition in cases where
the \fBsalt\-minion\fP service is restarted while a service is being
modified. If desired, usage of \fI\%systemd\-run(1)\fP can be suppressed by
setting a \fI\%config option\fP called
\fBsystemd.scope\fP, with a value of \fBFalse\fP (no quotes).

.sp
Restart the specified service with systemd
.INDENT 7.0
.TP
.B no_block
False
Set to \fBTrue\fP to start the service using \fB\-\-no\-block\fP\&.
.sp
New in version 2017.7.0.

.TP
.B unmask
False
Set to \fBTrue\fP to remove an indefinite mask before attempting to
restart the service.
.sp
New in version 2017.7.0: In previous releases, Salt would simply unmask a service before
restarting. This behavior is no longer the default.

.TP
.B unmask_runtime
False
Set to \fBTrue\fP to remove a runtime mask before attempting to restart
the service.
.sp
New in version 2017.7.0: In previous releases, Salt would simply unmask a service before
restarting. This behavior is no longer the default.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.show(name, root=None)
New in version 2014.7.0.

.sp
Show properties of one or more units/jobs or the manager
.INDENT 7.0
.TP
.B root
Enable/disable/mask unit files in the specified root directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.show <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.start(name, no_block=False, unmask=False, unmask_runtime=False)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands run by this function from the \fBsalt\-minion\fP daemon\(aqs
control group. This is done to avoid a race condition in cases where
the \fBsalt\-minion\fP service is restarted while a service is being
modified. If desired, usage of \fI\%systemd\-run(1)\fP can be suppressed by
setting a \fI\%config option\fP called
\fBsystemd.scope\fP, with a value of \fBFalse\fP (no quotes).

.sp
Start the specified service with systemd
.INDENT 7.0
.TP
.B no_block
False
Set to \fBTrue\fP to start the service using \fB\-\-no\-block\fP\&.
.sp
New in version 2017.7.0.

.TP
.B unmask
False
Set to \fBTrue\fP to remove an indefinite mask before attempting to start
the service.
.sp
New in version 2017.7.0: In previous releases, Salt would simply unmask a service before
starting. This behavior is no longer the default.

.TP
.B unmask_runtime
False
Set to \fBTrue\fP to remove a runtime mask before attempting to start the
service.
.sp
New in version 2017.7.0: In previous releases, Salt would simply unmask a service before
starting. This behavior is no longer the default.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.status(name, sig=None)
Return the status for a service via systemd.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.sp
Changed in version 2018.3.0: The service name can now be a glob (e.g. \fBsalt*\fP)

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.IP \(bu 2
\fBsig\fP (\fI\%str\fP) \-\- Not implemented
.UNINDENT
.TP
.B Returns
True if running, False otherwise
dict: Maps service name to True if running, False otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name> [service signature]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.stop(name, no_block=False)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands run by this function from the \fBsalt\-minion\fP daemon\(aqs
control group. This is done to avoid a race condition in cases where
the \fBsalt\-minion\fP service is restarted while a service is being
modified. If desired, usage of \fI\%systemd\-run(1)\fP can be suppressed by
setting a \fI\%config option\fP called
\fBsystemd.scope\fP, with a value of \fBFalse\fP (no quotes).

.sp
Stop the specified service with systemd
.INDENT 7.0
.TP
.B no_block
False
Set to \fBTrue\fP to start the service using \fB\-\-no\-block\fP\&.
.sp
New in version 2017.7.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.systemctl_reload()
New in version 0.15.0.

.sp
Reloads systemctl, an action needed whenever unit files are updated.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.systemctl_reload
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.systemd_service.unmask_(name, runtime=False, root=None)
New in version 2015.5.0.

.sp
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands run by this function from the \fBsalt\-minion\fP daemon\(aqs
control group. This is done to avoid a race condition in cases where
the \fBsalt\-minion\fP service is restarted while a service is being
modified. If desired, usage of \fI\%systemd\-run(1)\fP can be suppressed by
setting a \fI\%config option\fP called
\fBsystemd.scope\fP, with a value of \fBFalse\fP (no quotes).

.sp
Unmask the specified service with systemd
.INDENT 7.0
.TP
.B runtime
False
Set to \fBTrue\fP to unmask this service only until the next reboot
.sp
New in version 2017.7.0: In previous versions, this function would remove whichever mask was
identified by running \fBsystemctl is\-enabled\fP on the service.
However, since it is possible to both have both indefinite and
runtime masks on a service simultaneously, this function now
removes a runtime mask only when this argument is set to \fBTrue\fP,
and otherwise removes an indefinite mask.

.TP
.B root
Enable/disable/mask unit files in the specified root directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.unmask foo
salt \(aq*\(aq service.unmask foo runtime=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.telegram
.sp
Module for sending messages via Telegram.
.INDENT 0.0
.TP
.B configuration
In order to send a message via the Telegram, certain
configuration is required in /etc/salt/minion on the relevant minions or
in the pillar. Some sample configs might look like:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
telegram.chat_id: \(aq123456789\(aq
telegram.token: \(aq00000000:xxxxxxxxxxxxxxxxxxxxxxxx\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.telegram.post_message(message, chat_id=None, token=None)
Send a message to a Telegram chat.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmessage\fP \-\- The message to send to the Telegram chat.
.IP \(bu 2
\fBchat_id\fP \-\- (optional) The Telegram chat id.
.IP \(bu 2
\fBtoken\fP \-\- (optional) The Telegram API token.
.UNINDENT
.TP
.B Returns
Boolean if message was sent successfully.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq telegram.post_message message=\(dqHello Telegram!\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.telemetry
.sp
Connection module for Telemetry
.sp
New in version 2016.3.0.

.sp
\fI\%https://github.com/mongolab/mongolab\-telemetry\-api\-docs/blob/master/alerts.md\fP
.INDENT 0.0
.TP
.B configuration
This module accepts explicit telemetry credentials or
can also read api key credentials from a pillar. More Information available
\fI\%here\fP\&.
.UNINDENT
.sp
In the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
telemetry.telemetry_api_keys:
  \- abc123  # Key 1
  \- efg321  # Backup Key 1
telemetry_api_base_url: https://telemetry\-api.mongolab.com/v0
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
requests
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.telemetry.create_alarm(deployment_id, metric_name, data, api_key=None, profile=\(aqtelemetry\(aq)
create an telemetry alarms.
.sp
data is a dict of alert configuration data.
.sp
Returns (bool success, str message) tuple.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion telemetry.create_alarm rs\-ds033197 {} profile=telemetry
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.telemetry.delete_alarms(deployment_id, alert_id=None, metric_name=None, api_key=None, profile=\(aqtelemetry\(aq)
.INDENT 7.0
.TP
.B delete an alert specified by alert_id or if not specified blows away all the alerts
in the current deployment.
.UNINDENT
.sp
Returns (bool success, str message) tuple.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion telemetry.delete_alarms rs\-ds033197 profile=telemetry
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.telemetry.get_alarms(deployment_id, profile=\(aqtelemetry\(aq)
get all the alarms set up against the current deployment
.sp
Returns dictionary of alarm information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion telemetry.get_alarms rs\-ds033197 profile=telemetry
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.telemetry.get_alert_config(deployment_id, metric_name=None, api_key=None, profile=\(aqtelemetry\(aq)
Get all alert definitions associated with a given deployment or if metric_name
is specified, obtain the specific alert config
.sp
Returns dictionary or list of dictionaries.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion telemetry.get_alert_config rs\-ds033197 currentConnections profile=telemetry
salt myminion telemetry.get_alert_config rs\-ds033197 profile=telemetry
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.telemetry.get_notification_channel_id(notify_channel, profile=\(aqtelemetry\(aq)
Given an email address, creates a notification\-channels
if one is not found and also returns the corresponding
notification channel id.
.INDENT 7.0
.TP
.B notify_channel
Email escalation policy
.TP
.B profile
A dict of telemetry config information.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion telemetry.get_notification_channel_id userx@company.com profile=telemetry
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.telemetry.update_alarm(deployment_id, metric_name, data, api_key=None, profile=\(aqtelemetry\(aq)
update an telemetry alarms. data is a dict of alert configuration data.
.sp
Returns (bool success, str message) tuple.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion telemetry.update_alarm rs\-ds033197 {} profile=telemetry
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.temp
.sp
Simple module for creating temporary directories and files
.sp
This is a thin wrapper around Pythons tempfile module
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B salt.modules.temp.dir(suffix=\(aq\(aq, prefix=\(aqtmp\(aq, parent=None)
Create a temporary directory
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq temp.dir
salt \(aq*\(aq temp.dir prefix=\(aqmytemp\-\(aq parent=\(aq/var/run/\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.temp.file(suffix=\(aq\(aq, prefix=\(aqtmp\(aq, parent=None)
Create a temporary file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq temp.file
salt \(aq*\(aq temp.file prefix=\(aqmytemp\-\(aq parent=\(aq/var/run/\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.test
.sp
Module for running arbitrary tests
.INDENT 0.0
.TP
.B salt.modules.test.arg(*args, **kwargs)
Print out the data passed into the function \fB*args\fP and \fBkwargs\fP, this
is used to both test the publication data and CLI argument passing, but
also to display the information available within the publication data.
.INDENT 7.0
.TP
.B Returns
\fB{\(dqargs\(dq: args, \(dqkwargs\(dq: kwargs}\fP
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.arg 1 \(dqtwo\(dq 3.1 txt=\(dqhello\(dq wow=\(aq{a: 1, b: \(dqhello\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.arg_clean(*args, **kwargs)
Like \fI\%test.arg\fP but cleans \fBkwargs\fP of the \fB__pub*\fP items
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.arg_clean 1 \(dqtwo\(dq 3.1 txt=\(dqhello\(dq wow=\(aq{a: 1, b: \(dqhello\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.arg_repr(*args, **kwargs)
Print out the data passed into the function \fB*args\fP and \fBkwargs\fP, this
is used to both test the publication data and CLI argument passing, but
also to display the information available within the publication data.
.INDENT 7.0
.TP
.B Returns
\fB{\(dqargs\(dq: repr(args), \(dqkwargs\(dq: repr(kwargs)}\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.arg_repr 1 \(dqtwo\(dq 3.1 txt=\(dqhello\(dq wow=\(aq{a: 1, b: \(dqhello\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.arg_type(*args, **kwargs)
Print out the types of the \fBargs\fP and \fBkwargs\fP\&. This is used to test the types
of the \fBargs\fP and \fBkwargs\fP passed down to the Minion
.INDENT 7.0
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.arg_type 1 \(aqint\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.assertion(assertion)
Assert the given argument
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.assertion False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.attr_call()
Call grains.items via the attribute
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.attr_call
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.collatz(start)
Execute the collatz conjecture from the passed starting number,
returns the sequence and the time it took to compute. Used for
performance tests.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.collatz 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.conf_test()
Return the value for test.foo in the minion configuration file, or return
the default value
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.conf_test
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.cross_test(func, args=None)
Execute a minion function via the \fB__salt__\fP object in the test
module, used to verify that the Minion functions can be called
via the \fB__salt__\fP module.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.cross_test file.gid_to_group 0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.deprecation_warning()
Return True, but also produce two DeprecationWarnings. One by date, the
other by the codename \- release Oganesson, which should correspond to Salt
3108.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \e* test.deprecation_warning
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.echo(text)
Return a string \- used for testing the connection
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.echo \(aqfoo bar baz quo qux\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.exception(message=\(aqTest Exception\(aq)
Raise an exception
.sp
Optionally provide an error message or output the full stack.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.exception \(aqOh noes!\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.false_()
Always return \fBFalse\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.false
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.fib(num)
Return the \fBnum\fP\-th Fibonacci number, and the time it took to compute in
seconds. Used for performance tests.
.sp
This function is designed to have terrible performance.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.fib 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.get_opts()
Return the configuration options passed to this minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.get_opts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.kwarg(**kwargs)
Print out the data passed into the function \fB**kwargs\fP, this is used to
both test the publication data and CLI \fBkwarg\fP passing, but also to display
the information available within the publication data.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.kwarg num=1 txt=\(dqtwo\(dq env=\(aq{a: 1, b: \(dqhello\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.missing_func()
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.module_report()
Return a dict containing all of the execution modules with a report on
the overall availability via different references
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.module_report
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.not_loaded()
List the modules that were not loaded by the salt loader system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.not_loaded
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.opts_pkg()
Return an \fBopts\fP package with the \fBgrains\fP and \fBopts\fP for this Minion.
This is primarily used to create the options used for Master side
state compiling routines
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.opts_pkg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.outputter(data)
Test the outputter, pass in data to return
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.outputter foobar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.ping()
Used to make sure the minion is up and responding. Not an ICMP ping.
.sp
Returns \fBTrue\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.provider(module)
Pass in a function name to discover what provider is being used
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.provider service
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.providers()
Return a dict of the provider names and the files that provided them
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.providers
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.raise_exception(name, *args, **kwargs)
Raise an exception. Built\-in exceptions and those in
\fBsalt.exceptions\fP
can be raised by this test function. If no matching exception is found,
then no exception will be raised and this function will return \fBFalse\fP\&.
.sp
This function is designed to test Salt\(aqs exception and return code
handling.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.raise_exception TypeError \(dqAn integer is required\(dq
salt \(aq*\(aq test.raise_exception salt.exceptions.CommandExecutionError \(dqSomething went wrong\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.rand_sleep(max=60)
Sleep for a random number of seconds, used to test long\-running commands
and minions returning at differing intervals
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.rand_sleep 60
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.rand_str(size=9999999999, hash_type=None)
This function has been renamed to
\fI\%test.random_hash\fP\&. This function will stay to
ensure backwards compatibility, but please switch to using the preferred name
\fI\%test.random_hash\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.random_hash(size=9999999999, hash_type=None)
New in version 2015.5.2.

.sp
Changed in version 2018.3.0: Function has been renamed from \fBtest.rand_str\fP to
\fBtest.random_hash\fP

.sp
Generates a random number between 1 and \fBsize\fP, then returns a hash of
that number. If no \fBhash_type\fP is passed, the \fBhash_type\fP specified by the
Minion\(aqs \fI\%hash_type\fP config option is used.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.random_hash
salt \(aq*\(aq test.random_hash hash_type=sha512
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.retcode(code=42)
Test that the returncode system is functioning correctly
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.retcode 42
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.sleep(length)
Instruct the minion to initiate a process that will sleep for a given
period of time.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.sleep 20
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.stack()
Return the current stack trace
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.stack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.true_()
Always return \fBTrue\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.try_(module, return_try_exception=False, **kwargs)
Try to run a module command. On an exception return \fBNone\fP\&.
If \fBreturn_try_exception\fP is set to \fBTrue\fP, return the exception.
This can be helpful in templates where running a module might fail as expected.
.sp
Jinja Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% for i in range(0,230) %}
    {{ salt[\(aqtest.try\(aq](module=\(aqipmi.get_users\(aq, bmc_host=\(aq172.2.2.\(aq+i)|yaml(False) }}
{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.tty(*args, **kwargs)
Deprecated! Moved to \fI\%cmd.tty\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.tty tty0 \(aqThis is a test\(aq
salt \(aq*\(aq test.tty pts3 \(aqThis is a test\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.version()
Return the version of salt on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.versions()
This function is an alias of \fBversions_report\fP\&.
.INDENT 7.0
.INDENT 3.5
Returns versions of components used by salt
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.versions_report
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.versions_information()
Report the versions of dependent and system software
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.versions_information
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.test.versions_report()
Returns versions of components used by salt
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq test.versions_report
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.test_virtual
.sp
Module for testing that a __virtual__ function returning False will not be
available via the Salt Loader.
.INDENT 0.0
.TP
.B salt.modules.test_virtual.ping()
.UNINDENT
.SS salt.modules.testinframod
.sp
This module exposes the functionality of the TestInfra library
for use with SaltStack in order to verify the state of your minions.
In order to allow for the addition of new resource types in TestInfra this
module dynamically generates wrappers for the various resources by iterating
over the values in the \fB__all__\fP variable exposed by the testinfra.modules
namespace.
.INDENT 0.0
.TP
.B exception  salt.modules.testinframod.InvalidArgumentError
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.testinframod.camel_to_snake_case(camel_input)
Converts camelCase (or CamelCase) to snake_case.
From \fI\%https://codereview.stackexchange.com/questions/185966/functions\-to\-convert\-camelcase\-strings\-to\-snake\-case\fP
.INDENT 7.0
.TP
.B Parameters
\fBcamel_input\fP (\fI\%str\fP) \-\- The camelcase or CamelCase string to convert to snake_case
.UNINDENT
.sp
:return str
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.testinframod.snake_to_camel_case(snake_input, uppercamel=False)
Converts snake_case to camelCase (or CamelCase if uppercamel is \fBTrue\fP).
Inspired by \fI\%https://codereview.stackexchange.com/questions/85311/transform\-snake\-case\-to\-camelcase\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsnake_input\fP (\fI\%str\fP) \-\- The input snake_case string to convert to camelCase
.IP \(bu 2
\fBuppercamel\fP (\fI\%bool\fP) \-\- Whether or not to convert to CamelCase instead
.UNINDENT
.UNINDENT
.sp
:return str
.UNINDENT
.SS salt.modules.textfsm_mod
.SS TextFSM
.sp
New in version 2018.3.0.

.sp
Execution module that processes plain text and extracts data
using TextFSM templates. The output is presented in JSON serializable
data, and can be easily re\-used in other modules, or directly
inside the renderer (Jinja, Mako, Genshi, etc.).
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
textfsm Python library
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Install  \fBtextfsm\fP library: \fBpip install textfsm\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.textfsm_mod.extract(template_path, raw_text=None, raw_text_file=None, saltenv=\(aqbase\(aq)
Extracts the data entities from the unstructured
raw text sent as input and returns the data
mapping, processing using the TextFSM template.
.INDENT 7.0
.TP
.B template_path
The path to the TextFSM template.
This can be specified using the absolute path
to the file, or using one of the following URL schemes:
.INDENT 7.0
.IP \(bu 2
\fBsalt://\fP, to fetch the template from the Salt fileserver.
.IP \(bu 2
\fBhttp://\fP or \fBhttps://\fP
.IP \(bu 2
\fBftp://\fP
.IP \(bu 2
\fBs3://\fP
.IP \(bu 2
\fBswift://\fP
.UNINDENT
.TP
.B raw_text: \fBNone\fP
The unstructured text to be parsed.
.TP
.B raw_text_file: \fBNone\fP
Text file to read, having the raw text to be parsed using the TextFSM template.
Supports the same URL schemes as the \fBtemplate_path\fP argument.
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file.
Ignored if \fBtemplate_path\fP is not a \fBsalt://\fP URL.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq textfsm.extract salt://textfsm/juniper_version_template raw_text_file=s3://junos_ver.txt
salt \(aq*\(aq textfsm.extract http://some\-server/textfsm/juniper_version_template raw_text=\(aqHostname: router.abc ... snip ...\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Jinja template example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set raw_text = \(aqHostname: router.abc ... snip ...\(aq \-%}
{%\- set textfsm_extract = salt.textfsm.extract(\(aqhttps://some\-server/textfsm/juniper_version_template\(aq, raw_text) \-%}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Raw text example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Hostname: router.abc
Model: mx960
JUNOS Base OS boot [9.1S3.5]
JUNOS Base OS Software Suite [9.1S3.5]
JUNOS Kernel Software Suite [9.1S3.5]
JUNOS Crypto Software Suite [9.1S3.5]
JUNOS Packet Forwarding Engine Support (M/T Common) [9.1S3.5]
JUNOS Packet Forwarding Engine Support (MX Common) [9.1S3.5]
JUNOS Online Documentation [9.1S3.5]
JUNOS Routing Software Suite [9.1S3.5]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
TextFSM Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Value Chassis (\eS+)
Value Required Model (\eS+)
Value Boot (.*)
Value Base (.*)
Value Kernel (.*)
Value Crypto (.*)
Value Documentation (.*)
Value Routing (.*)

Start
# Support multiple chassis systems.
  ^\eS+:$$ \-> Continue.Record
  ^${Chassis}:$$
  ^Model: ${Model}
  ^JUNOS Base OS boot \e[${Boot}\e]
  ^JUNOS Software Release \e[${Base}\e]
  ^JUNOS Base OS Software Suite \e[${Base}\e]
  ^JUNOS Kernel Software Suite \e[${Kernel}\e]
  ^JUNOS Crypto Software Suite \e[${Crypto}\e]
  ^JUNOS Online Documentation \e[${Documentation}\e]
  ^JUNOS Routing Software Suite \e[${Routing}\e]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqcomment\(dq: \(dq\(dq,
    \(dqresult\(dq: true,
    \(dqout\(dq: [
        {
            \(dqkernel\(dq: \(dq9.1S3.5\(dq,
            \(dqdocumentation\(dq: \(dq9.1S3.5\(dq,
            \(dqboot\(dq: \(dq9.1S3.5\(dq,
            \(dqcrypto\(dq: \(dq9.1S3.5\(dq,
            \(dqchassis\(dq: \(dq\(dq,
            \(dqrouting\(dq: \(dq9.1S3.5\(dq,
            \(dqbase\(dq: \(dq9.1S3.5\(dq,
            \(dqmodel\(dq: \(dqmx960\(dq
        }
    ]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.textfsm_mod.index(command, platform=None, platform_grain_name=None, platform_column_name=None, output=None, output_file=None, textfsm_path=None, index_file=None, saltenv=\(aqbase\(aq, include_empty=False, include_pat=None, exclude_pat=None)
Dynamically identify the template required to extract the
information from the unstructured raw text.
.sp
The output has the same structure as the \fBextract\fP execution
function, the difference being that \fBindex\fP is capable
to identify what template to use, based on the platform
details and the \fBcommand\fP\&.
.INDENT 7.0
.TP
.B command
The command executed on the device, to get the output.
.TP
.B platform
The platform name, as defined in the TextFSM index file.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For ease of use, it is recommended to define the TextFSM
indexfile with values that can be matches using the grains.
.UNINDENT
.UNINDENT
.TP
.B platform_grain_name
The name of the grain used to identify the platform name
in the TextFSM index file.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option can be also specified in the minion configuration
file or pillar as \fBtextfsm_platform_grain\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option is ignored when \fBplatform\fP is specified.
.UNINDENT
.UNINDENT
.TP
.B platform_column_name: \fBPlatform\fP
The column name used to identify the platform,
exactly as specified in the TextFSM index file.
Default: \fBPlatform\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is field is case sensitive, make sure
to assign the correct value to this option,
exactly as defined in the index file.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option can be also specified in the minion configuration
file or pillar as \fBtextfsm_platform_column_name\fP\&.
.UNINDENT
.UNINDENT
.TP
.B output
The raw output from the device, to be parsed
and extract the structured data.
.TP
.B output_file
The path to a file that contains the raw output from the device,
used to extract the structured data.
This option supports the usual Salt\-specific schemes: \fBfile://\fP,
\fBsalt://\fP, \fBhttp://\fP, \fBhttps://\fP, \fBftp://\fP, \fBs3://\fP, \fBswift://\fP\&.
.TP
.B textfsm_path
The path where the TextFSM templates can be found. This can be either
absolute path on the server, either specified using the following URL
schemes: \fBfile://\fP, \fBsalt://\fP, \fBhttp://\fP, \fBhttps://\fP, \fBftp://\fP,
\fBs3://\fP, \fBswift://\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This needs to be a directory with a flat structure, having an
index file (whose name can be specified using the \fBindex_file\fP option)
and a number of TextFSM templates.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option can be also specified in the minion configuration
file or pillar as \fBtextfsm_path\fP\&.
.UNINDENT
.UNINDENT
.TP
.B index_file: \fBindex\fP
The name of the TextFSM index file, under the \fBtextfsm_path\fP\&. Default: \fBindex\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option can be also specified in the minion configuration
file or pillar as \fBtextfsm_index_file\fP\&.
.UNINDENT
.UNINDENT
.TP
.B saltenv: \fBbase\fP
Salt fileserver environment from which to retrieve the file.
Ignored if \fBtextfsm_path\fP is not a \fBsalt://\fP URL.
.TP
.B include_empty: \fBFalse\fP
Include empty files under the \fBtextfsm_path\fP\&.
.TP
.B include_pat
Glob or regex to narrow down the files cached from the given path.
If matching with a regex, the regex must be prefixed with \fBE@\fP,
otherwise the expression will be interpreted as a glob.
.TP
.B exclude_pat
Glob or regex to exclude certain files from being cached from the given path.
If matching with a regex, the regex must be prefixed with \fBE@\fP,
otherwise the expression will be interpreted as a glob.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If used with \fBinclude_pat\fP, files matching this pattern will be
excluded from the subset of files defined by \fBinclude_pat\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq textfsm.index \(aqsh ver\(aq platform=Juniper output_file=salt://textfsm/juniper_version_example textfsm_path=salt://textfsm/
salt \(aq*\(aq textfsm.index \(aqsh ver\(aq output_file=salt://textfsm/juniper_version_example textfsm_path=ftp://textfsm/ platform_column_name=Vendor
salt \(aq*\(aq textfsm.index \(aqsh ver\(aq output_file=salt://textfsm/juniper_version_example textfsm_path=https://some\-server/textfsm/ platform_column_name=Vendor platform_grain_name=vendor
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
TextFSM index file example:
.sp
\fBsalt://textfsm/index\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Template, Hostname, Vendor, Command
juniper_version_template, .*, Juniper, sh[[ow]] ve[[rsion]]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The usage can be simplified,
by defining (some of) the following options: \fBtextfsm_platform_grain\fP,
\fBtextfsm_path\fP, \fBtextfsm_platform_column_name\fP, or \fBtextfsm_index_file\fP,
in the (proxy) minion configuration file or pillar.
.sp
Configuration example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
textfsm_platform_grain: vendor
textfsm_path: salt://textfsm/
textfsm_platform_column_name: Vendor
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And the CLI usage becomes as simple as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq textfsm.index \(aqsh ver\(aq output_file=salt://textfsm/juniper_version_example
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Usgae inside a Jinja template:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set command = \(aqsh ver\(aq \-%}
{%\- set output = salt.net.cli(command) \-%}
{%\- set textfsm_extract = salt.textfsm.index(command, output=output) \-%}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.timezone
.sp
Module for managing timezone on POSIX\-like systems.
.INDENT 0.0
.TP
.B salt.modules.timezone.get_hwclock()
Get current hardware clock setting (UTC or localtime)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_hwclock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.timezone.get_offset()
Get current numeric timezone offset from UTC (i.e. \-0700)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_offset
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.timezone.get_zone()
Get current timezone (i.e. America/Denver)
.sp
Changed in version 2016.11.4.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On AIX operating systems, Posix values can also be returned
\(aqCST6CDT,M3.2.0/2:00:00,M11.1.0/2:00:00\(aq
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_zone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.timezone.get_zonecode()
Get current timezone (i.e. PST, MDT, etc)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_zonecode
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.timezone.set_hwclock(clock)
Sets the hardware clock to be either UTC or localtime
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.set_hwclock UTC
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.timezone.set_zone(timezone)
Unlinks, then symlinks /etc/localtime to the set timezone.
.sp
The timezone is crucial to several system processes, each of which SHOULD
be restarted (for instance, whatever you system uses as its cron and
syslog daemons). This will not be automagically done and must be done
manually!
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.set_zone \(aqAmerica/Denver\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2016.11.4.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On AIX operating systems, Posix values are also allowed, see below
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.set_zone \(aqCST6CDT,M3.2.0/2:00:00,M11.1.0/2:00:00\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.timezone.zone_compare(timezone)
Compares the given timezone name with the system timezone name.
Checks the hash sum between the given timezone, and the one set in
/etc/localtime. Returns True if names and hash sums match, and False if not.
Mostly useful for running state checks.
.sp
Changed in version 2016.3.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On Solaris\-like operating systems only a string comparison is done.
.UNINDENT
.UNINDENT
.sp
Changed in version 2016.11.4.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On AIX operating systems only a string comparison is done.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.zone_compare \(aqAmerica/Denver\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.tls
.sp
A salt module for SSL/TLS.  Can create a Certificate Authority (CA)
or use Self\-Signed certificates.
.INDENT 0.0
.TP
.B depends
PyOpenSSL Python module (0.10 or later, 0.14 or later for X509
extension support)
.TP
.B configuration
Add the following values in /etc/salt/minion for the CA module
to function properly:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ca.cert_base_path: \(aq/etc/pki\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example #1:
Creating a CA, a server request and its signed certificate:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call tls.create_ca my_little \e
days=5 \e
CN=\(aqMy Little CA\(aq \e
C=US \e
ST=Utah \e
L=Salt Lake City \e
O=Saltstack \e
emailAddress=pleasedontemail@example.com

Created Private Key: \(dq/etc/pki/my_little/my_little_ca_cert.key\(dq
Created CA \(dqmy_little_ca\(dq: \(dq/etc/pki/my_little_ca/my_little_ca_cert.crt\(dq

# salt\-call tls.create_csr my_little CN=www.example.com
Created Private Key: \(dq/etc/pki/my_little/certs/www.example.com.key
Created CSR for \(dqwww.example.com\(dq: \(dq/etc/pki/my_little/certs/www.example.com.csr\(dq

# salt\-call tls.create_ca_signed_cert my_little CN=www.example.com
Created Certificate for \(dqwww.example.com\(dq: /etc/pki/my_little/certs/www.example.com.crt\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example #2:
Creating a client request and its signed certificate
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call tls.create_csr my_little CN=DBReplica_No.1 cert_type=client
Created Private Key: \(dq/etc/pki/my_little/certs//DBReplica_No.1.key\(dq
Created CSR for \(dqDBReplica_No.1\(dq: \(dq/etc/pki/my_little/certs/DBReplica_No.1.csr\(dq

# salt\-call tls.create_ca_signed_cert my_little CN=DBReplica_No.1
Created Certificate for \(dqDBReplica_No.1\(dq: \(dq/etc/pki/my_little/certs/DBReplica_No.1.crt\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example #3:
Creating both a server and client req + cert for the same CN
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call tls.create_csr my_little CN=MasterDBReplica_No.2  \e
    cert_type=client
Created Private Key: \(dq/etc/pki/my_little/certs/MasterDBReplica_No.2.key\(dq
Created CSR for \(dqDBReplica_No.1\(dq: \(dq/etc/pki/my_little/certs/MasterDBReplica_No.2.csr\(dq

# salt\-call tls.create_ca_signed_cert my_little CN=MasterDBReplica_No.2
Created Certificate for \(dqDBReplica_No.1\(dq: \(dq/etc/pki/my_little/certs/DBReplica_No.1.crt\(dq

# salt\-call tls.create_csr my_little CN=MasterDBReplica_No.2 \e
    cert_type=server
Certificate \(dqMasterDBReplica_No.2\(dq already exists

(doh!)

# salt\-call tls.create_csr my_little CN=MasterDBReplica_No.2 \e
    cert_type=server type_ext=True
Created Private Key: \(dq/etc/pki/my_little/certs/DBReplica_No.1_client.key\(dq
Created CSR for \(dqDBReplica_No.1\(dq: \(dq/etc/pki/my_little/certs/DBReplica_No.1_client.csr\(dq

# salt\-call tls.create_ca_signed_cert my_little CN=MasterDBReplica_No.2
Certificate \(dqMasterDBReplica_No.2\(dq already exists

(DOH!)

# salt\-call tls.create_ca_signed_cert my_little CN=MasterDBReplica_No.2 \e
    cert_type=server type_ext=True
Created Certificate for \(dqMasterDBReplica_No.2\(dq: \(dq/etc/pki/my_little/certs/MasterDBReplica_No.2_server.crt\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example #4:
Create a server req + cert with non\-CN filename for the cert
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call tls.create_csr my_little CN=www.anothersometh.ing \e
    cert_type=server type_ext=True
Created Private Key: \(dq/etc/pki/my_little/certs/www.anothersometh.ing_server.key\(dq
Created CSR for \(dqDBReplica_No.1\(dq: \(dq/etc/pki/my_little/certs/www.anothersometh.ing_server.csr\(dq

# salt\-call tls_create_ca_signed_cert my_little CN=www.anothersometh.ing \e
    cert_type=server cert_filename=\(dqsomething_completely_different\(dq
Created Certificate for \(dqwww.anothersometh.ing\(dq: /etc/pki/my_little/certs/something_completely_different.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.ca_exists(ca_name, cacert_path=None, ca_filename=None)
Verify whether a Certificate Authority (CA) already exists
.INDENT 7.0
.TP
.B ca_name
name of the CA
.TP
.B cacert_path
absolute path to ca certificates root directory
.TP
.B ca_filename
alternative filename for the CA
.sp
New in version 2015.5.3.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.ca_exists test_ca /etc/certs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.cert_base_path(cacert_path=None)
Return the base path for certs from CLI or from options
.INDENT 7.0
.TP
.B cacert_path
absolute path to ca certificates root directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.cert_base_path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.cert_info(cert, digest=\(aqsha256\(aq)
Return information for a particular certificate
.INDENT 7.0
.TP
.B cert
path to the certifiate PEM file or string
.sp
Changed in version 2018.3.4.

.TP
.B digest
what digest to use for fingerprinting
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.cert_info /dir/for/certs/cert.pem
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.create_ca(ca_name, bits=2048, days=365, CN=\(aqlocalhost\(aq, C=\(aqUS\(aq, ST=\(aqUtah\(aq, L=\(aqSalt Lake City\(aq, O=\(aqSaltStack\(aq, OU=None, emailAddress=None, fixmode=False, cacert_path=None, ca_filename=None, digest=\(aqsha256\(aq, onlyif=None, unless=None, replace=False)
Create a Certificate Authority (CA)
.INDENT 7.0
.TP
.B ca_name
name of the CA
.TP
.B bits
number of RSA key bits, default is 2048
.TP
.B days
number of days the CA will be valid, default is 365
.TP
.B CN
common name in the request, default is \(dqlocalhost\(dq
.TP
.B C
country, default is \(dqUS\(dq
.TP
.B ST
state, default is \(dqUtah\(dq
.TP
.B L
locality, default is \(dqCenterville\(dq, the city where SaltStack originated
.TP
.B O
organization, default is \(dqSaltStack\(dq
.TP
.B OU
organizational unit, default is None
.TP
.B emailAddress
email address for the CA owner, default is None
.TP
.B cacert_path
absolute path to ca certificates root directory
.TP
.B ca_filename
alternative filename for the CA
.sp
New in version 2015.5.3.

.TP
.B digest
The message digest algorithm. Must be a string describing a digest
algorithm supported by OpenSSL (by EVP_get_digestbyname, specifically).
For example, \(dqmd5\(dq or \(dqsha1\(dq. Default: \(aqsha256\(aq
.TP
.B replace
Replace this certificate even if it exists
.sp
New in version 2015.5.1.

.UNINDENT
.sp
Writes out a CA certificate based upon defined config values. If the file
already exists, the function just returns assuming the CA certificate
already exists.
.sp
If the following values were set:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ca.cert_base_path=\(aq/etc/pki\(aq
ca_name=\(aqkoji\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
the resulting CA, and corresponding key, would be written in the following
location with appropriate permissions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/pki/koji/koji_ca_cert.crt
/etc/pki/koji/koji_ca_cert.key
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.create_ca test_ca
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.create_ca_signed_cert(ca_name, CN, days=365, cacert_path=None, ca_filename=None, cert_path=None, cert_filename=None, digest=\(aqsha256\(aq, cert_type=None, type_ext=False, replace=False)
Create a Certificate (CERT) signed by a named Certificate Authority (CA)
.sp
If the certificate file already exists, the function just returns assuming
the CERT already exists.
.sp
The CN \fImust\fP match an existing CSR generated by create_csr. If it
does not, this method does nothing.
.INDENT 7.0
.TP
.B ca_name
name of the CA
.TP
.B CN
common name matching the certificate signing request
.TP
.B days
number of days certificate is valid, default is 365 (1 year)
.TP
.B cacert_path
absolute path to ca certificates root directory
.TP
.B ca_filename
alternative filename for the CA
.sp
New in version 2015.5.3.

.TP
.B cert_path
full path to the certificates directory
.TP
.B cert_filename
alternative filename for the certificate, useful when using special
characters in the CN. If this option is set it will override
the certificate filename output effects of \fBcert_type\fP\&.
\fBtype_ext\fP will be completely overridden.
.sp
New in version 2015.5.3.

.TP
.B digest
The message digest algorithm. Must be a string describing a digest
algorithm supported by OpenSSL (by EVP_get_digestbyname, specifically).
For example, \(dqmd5\(dq or \(dqsha1\(dq. Default: \(aqsha256\(aq
.TP
.B replace
Replace this certificate even if it exists
.sp
New in version 2015.5.1.

.TP
.B cert_type
string. Either \(aqserver\(aq or \(aqclient\(aq (see create_csr() for details).
.sp
If create_csr(type_ext=True) this function \fBmust\fP be called with the
same cert_type so it can find the CSR file.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
create_csr() defaults to cert_type=\(aqserver\(aq; therefore, if it was also
called with type_ext, cert_type becomes a required argument for
create_ca_signed_cert()
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B type_ext
bool. If set True, use \fBcert_type\fP as an extension to the CN when
formatting the filename.
.sp
e.g.: some_subject_CN_server.crt or some_subject_CN_client.crt
.sp
This facilitates the context where both types are required for the same
subject
.sp
If \fBcert_filename\fP is \fInot None\fP, setting \fBtype_ext\fP has no
effect
.UNINDENT
.sp
If the following values were set:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ca.cert_base_path=\(aq/etc/pki\(aq
ca_name=\(aqkoji\(aq
CN=\(aqtest.egavas.org\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
the resulting signed certificate would be written in the following
location:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/pki/koji/certs/test.egavas.org.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.create_ca_signed_cert test localhost
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.create_csr(ca_name, bits=2048, CN=\(aqlocalhost\(aq, C=\(aqUS\(aq, ST=\(aqUtah\(aq, L=\(aqSalt Lake City\(aq, O=\(aqSaltStack\(aq, OU=None, emailAddress=None, subjectAltName=None, cacert_path=None, ca_filename=None, csr_path=None, csr_filename=None, digest=\(aqsha256\(aq, type_ext=False, cert_type=\(aqserver\(aq, replace=False)
Create a Certificate Signing Request (CSR) for a
particular Certificate Authority (CA)
.INDENT 7.0
.TP
.B ca_name
name of the CA
.TP
.B bits
number of RSA key bits, default is 2048
.TP
.B CN
common name in the request, default is \(dqlocalhost\(dq
.TP
.B C
country, default is \(dqUS\(dq
.TP
.B ST
state, default is \(dqUtah\(dq
.TP
.B L
locality, default is \(dqCenterville\(dq, the city where SaltStack originated
.TP
.B O
organization, default is \(dqSaltStack\(dq
NOTE: Must the same as CA certificate or an error will be raised
.TP
.B OU
organizational unit, default is None
.TP
.B emailAddress
email address for the request, default is None
.TP
.B subjectAltName
valid subjectAltNames in full form, e.g. to add DNS entry you would call
this function with this value:
.INDENT 7.0
.TP
.B examples: [\(aq\fI\%DNS:somednsname.com\fP\(aq,
\(aq\fI\%DNS:1.2.3.4\fP\(aq,
\(aqIP:1.2.3.4\(aq,
\(aqIP:2001:4801:7821:77:be76:4eff:fe11:e51\(aq,
\(aqemail:me@i.like.pie.com\(aq]
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
some libraries do not properly query IP: prefixes, instead looking
for the given req. source with a DNS: prefix. To be thorough, you
may want to include both DNS: and IP: entries if you are using
subjectAltNames for destinations for your TLS connections.
e.g.:
requests to \fI\%https://1.2.3.4\fP will fail from python\(aqs
requests library w/out the second entry in the above list
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B cert_type
Specify the general certificate type. Can be either \fIserver\fP or
\fIclient\fP\&. Indicates the set of common extensions added to the CSR.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
server: {
   \(aqbasicConstraints\(aq: \(aqCA:FALSE\(aq,
   \(aqextendedKeyUsage\(aq: \(aqserverAuth\(aq,
   \(aqkeyUsage\(aq: \(aqdigitalSignature, keyEncipherment\(aq
}

client: {
   \(aqbasicConstraints\(aq: \(aqCA:FALSE\(aq,
   \(aqextendedKeyUsage\(aq: \(aqclientAuth\(aq,
   \(aqkeyUsage\(aq: \(aqnonRepudiation, digitalSignature, keyEncipherment\(aq
}
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B type_ext
boolean.  Whether or not to extend the filename with CN_[cert_type]
This can be useful if a server and client certificate are needed for
the same CN. Defaults to False to avoid introducing an unexpected file
naming pattern
.sp
The files normally named some_subject_CN.csr and some_subject_CN.key
will then be saved
.TP
.B replace
Replace this signing request even if it exists
.sp
New in version 2015.5.1.

.UNINDENT
.sp
Writes out a Certificate Signing Request (CSR) If the file already
exists, the function just returns assuming the CSR already exists.
.sp
If the following values were set:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ca.cert_base_path=\(aq/etc/pki\(aq
ca_name=\(aqkoji\(aq
CN=\(aqtest.egavas.org\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
the resulting CSR, and corresponding key, would be written in the
following location with appropriate permissions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/pki/koji/certs/test.egavas.org.csr
/etc/pki/koji/certs/test.egavas.org.key
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.create_csr test
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.create_empty_crl(ca_name, cacert_path=None, ca_filename=None, crl_file=None, digest=\(aqsha256\(aq)
Create an empty Certificate Revocation List.
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B ca_name
name of the CA
.TP
.B cacert_path
absolute path to ca certificates root directory
.TP
.B ca_filename
alternative filename for the CA
.sp
New in version 2015.5.3.

.TP
.B crl_file
full path to the CRL file
.TP
.B digest
The message digest algorithm. Must be a string describing a digest
algorithm supported by OpenSSL (by EVP_get_digestbyname, specifically).
For example, \(dqmd5\(dq or \(dqsha1\(dq. Default: \(aqsha256\(aq
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.create_empty_crl ca_name=\(aqkoji\(aq                 ca_filename=\(aqca\(aq                 crl_file=\(aq/etc/openvpn/team1/crl.pem\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.create_pkcs12(ca_name, CN, passphrase=\(aq\(aq, cacert_path=None, replace=False)
Create a PKCS#12 browser certificate for a particular Certificate (CN)
.INDENT 7.0
.TP
.B ca_name
name of the CA
.TP
.B CN
common name matching the certificate signing request
.TP
.B passphrase
used to unlock the PKCS#12 certificate when loaded into the browser
.TP
.B cacert_path
absolute path to ca certificates root directory
.TP
.B replace
Replace this certificate even if it exists
.sp
New in version 2015.5.1.

.UNINDENT
.sp
If the following values were set:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ca.cert_base_path=\(aq/etc/pki\(aq
ca_name=\(aqkoji\(aq
CN=\(aqtest.egavas.org\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
the resulting signed certificate would be written in the
following location:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/pki/koji/certs/test.egavas.org.p12
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.create_pkcs12 test localhost
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.create_self_signed_cert(tls_dir=\(aqtls\(aq, bits=2048, days=365, CN=\(aqlocalhost\(aq, C=\(aqUS\(aq, ST=\(aqUtah\(aq, L=\(aqSalt Lake City\(aq, O=\(aqSaltStack\(aq, OU=None, emailAddress=None, cacert_path=None, cert_filename=None, digest=\(aqsha256\(aq, replace=False)
Create a Self\-Signed Certificate (CERT)
.INDENT 7.0
.TP
.B tls_dir
location appended to the ca.cert_base_path, default is \(aqtls\(aq
.TP
.B bits
number of RSA key bits, default is 2048
.TP
.B CN
common name in the request, default is \(dqlocalhost\(dq
.TP
.B C
country, default is \(dqUS\(dq
.TP
.B ST
state, default is \(dqUtah\(dq
.TP
.B L
locality, default is \(dqCenterville\(dq, the city where SaltStack originated
.TP
.B O
organization, default is \(dqSaltStack\(dq
NOTE: Must the same as CA certificate or an error will be raised
.TP
.B OU
organizational unit, default is None
.TP
.B emailAddress
email address for the request, default is None
.TP
.B cacert_path
absolute path to ca certificates root directory
.TP
.B digest
The message digest algorithm. Must be a string describing a digest
algorithm supported by OpenSSL (by EVP_get_digestbyname, specifically).
For example, \(dqmd5\(dq or \(dqsha1\(dq. Default: \(aqsha256\(aq
.TP
.B replace
Replace this certificate even if it exists
.sp
New in version 2015.5.1.

.UNINDENT
.sp
Writes out a Self\-Signed Certificate (CERT). If the file already
exists, the function just returns.
.sp
If the following values were set:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ca.cert_base_path=\(aq/etc/pki\(aq
tls_dir=\(aqkoji\(aq
CN=\(aqtest.egavas.org\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
the resulting CERT, and corresponding key, would be written in the
following location with appropriate permissions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/pki/koji/certs/test.egavas.org.crt
/etc/pki/koji/certs/test.egavas.org.key
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.create_self_signed_cert
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Passing options from the command line:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\(aq tls.create_self_signed_cert CN=\(aqtest.mysite.org\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.get_ca(ca_name, as_text=False, cacert_path=None)
Get the certificate path or content
.INDENT 7.0
.TP
.B ca_name
name of the CA
.TP
.B as_text
if true, return the certificate content instead of the path
.TP
.B cacert_path
absolute path to ca certificates root directory
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.get_ca test_ca as_text=False cacert_path=/etc/certs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.get_ca_signed_cert(ca_name, CN=\(aqlocalhost\(aq, as_text=False, cacert_path=None, cert_filename=None)
Get the certificate path or content
.INDENT 7.0
.TP
.B ca_name
name of the CA
.TP
.B CN
common name of the certificate
.TP
.B as_text
if true, return the certificate content instead of the path
.TP
.B cacert_path
absolute path to certificates root directory
.TP
.B cert_filename
alternative filename for the certificate, useful when using special characters in the CN
.sp
New in version 2015.5.3.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.get_ca_signed_cert test_ca CN=localhost as_text=False cacert_path=/etc/certs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.get_ca_signed_key(ca_name, CN=\(aqlocalhost\(aq, as_text=False, cacert_path=None, key_filename=None)
Get the certificate path or content
.INDENT 7.0
.TP
.B ca_name
name of the CA
.TP
.B CN
common name of the certificate
.TP
.B as_text
if true, return the certificate content instead of the path
.TP
.B cacert_path
absolute path to certificates root directory
.TP
.B key_filename
alternative filename for the key, useful when using special characters
.sp
New in version 2015.5.3.

.sp
in the CN
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.get_ca_signed_key                 test_ca CN=localhost                 as_text=False                 cacert_path=/etc/certs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.get_expiration_date(cert, date_format=\(aq%Y\-%m\-%d\(aq)
New in version 2019.2.0.

.sp
Get a certificate\(aqs expiration date
.INDENT 7.0
.TP
.B cert
Full path to the certificate
.TP
.B date_format
By default this will return the expiration date in YYYY\-MM\-DD format,
use this to specify a different strftime format string. Note that the
expiration time will be in UTC.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.get_expiration_date /path/to/foo.crt
salt \(aq*\(aq tls.get_expiration_date /path/to/foo.crt date_format=\(aq%d/%m/%Y\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.get_extensions(cert_type)
Fetch X509 and CSR extension definitions from tls:extensions:
(common|server|client) or set them to standard defaults.
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B cert_type:
The type of certificate such as \fBserver\fP or \fBclient\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.get_extensions client
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.maybe_fix_ssl_version(ca_name, cacert_path=None, ca_filename=None)
Check that the X509 version is correct
(was incorrectly set in previous salt versions).
This will fix the version if needed.
.INDENT 7.0
.TP
.B ca_name
ca authority name
.TP
.B cacert_path
absolute path to ca certificates root directory
.TP
.B ca_filename
alternative filename for the CA
.sp
New in version 2015.5.3.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.maybe_fix_ssl_version test_ca /etc/certs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.revoke_cert(ca_name, CN, cacert_path=None, ca_filename=None, cert_path=None, cert_filename=None, crl_file=None, digest=\(aqsha256\(aq)
Revoke a certificate.
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B ca_name
Name of the CA.
.TP
.B CN
Common name matching the certificate signing request.
.TP
.B cacert_path
Absolute path to ca certificates root directory.
.TP
.B ca_filename
Alternative filename for the CA.
.TP
.B cert_path
Path to the cert file.
.TP
.B cert_filename
Alternative filename for the certificate, useful when using special
characters in the CN.
.TP
.B crl_file
Full path to the CRL file.
.TP
.B digest
The message digest algorithm. Must be a string describing a digest
algorithm supported by OpenSSL (by EVP_get_digestbyname, specifically).
For example, \(dqmd5\(dq or \(dqsha1\(dq. Default: \(aqsha256\(aq
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.revoke_cert ca_name=\(aqkoji\(aq                 ca_filename=\(aqca\(aq                 crl_file=\(aq/etc/openvpn/team1/crl.pem\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.set_ca_path(cacert_path)
If wanted, store the aforementioned cacert_path in context
to be used as the basepath for further operations
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tls.set_ca_path /etc/certs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tls.validate(cert, ca_name, crl_file)
New in version 3000.

.sp
Validate a certificate against a given CA/CRL.
.INDENT 7.0
.TP
.B cert
path to the certifiate PEM file or string
.TP
.B ca_name
name of the CA
.TP
.B crl_file
full path to the CRL file
.UNINDENT
.UNINDENT
.SS salt.modules.tomcat
.sp
Support for Tomcat
.sp
This module uses the manager webapp to manage Apache tomcat webapps.
If the manager webapp is not configured some of the functions won\(aqt work.
.INDENT 0.0
.TP
.B configuration
.INDENT 7.0
.IP \(bu 2
Java bin path should be in default path
.IP \(bu 2
If ipv6 is enabled make sure you permit manager access to ipv6 interface
\(dq0:0:0:0:0:0:0:1\(dq
.IP \(bu 2
If you are using tomcat.tar.gz it has to be installed or symlinked under
\fB/opt\fP, preferably using name tomcat
.IP \(bu 2
\(dqtomcat.signal start/stop\(dq works but it does not use the startup scripts
.UNINDENT
.UNINDENT
.sp
The following grains/pillar should be set:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tomcat\-manager:
  user: <username>
  passwd: <password>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or the old format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tomcat\-manager.user: <username>
tomcat\-manager.passwd: <password>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Also configure a user in the conf/tomcat\-users.xml file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<?xml version=\(aq1.0\(aq encoding=\(aqutf\-8\(aq?>
<tomcat\-users>
    <role rolename=\(dqmanager\-script\(dq/>
    <user username=\(dqtomcat\(dq password=\(dqtomcat\(dq roles=\(dqmanager\-script\(dq/>
</tomcat\-users>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
More information about tomcat manager:
\fI\%http://tomcat.apache.org/tomcat\-7.0\-doc/manager\-howto.html\fP
.IP \(bu 2
if you use only this module for deployments you\(aqve might want to strict
access to the manager only from localhost for more info:
\fI\%http://tomcat.apache.org/tomcat\-7.0\-doc/manager\-howto.html#Configuring_Manager_Application_Access\fP
.IP \(bu 2
Tested on:
.INDENT 2.0
.TP
.B JVM Vendor:
Sun Microsystems Inc.
.TP
.B JVM Version:
1.6.0_43\-b01
.TP
.B OS Architecture:
amd64
.TP
.B OS Name:
Linux
.TP
.B OS Version:
2.6.32\-358.el6.x86_64
.TP
.B Tomcat Version:
Apache Tomcat/7.0.37
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.deploy_war(war, context, force=\(aqno\(aq, url=\(aqhttp://localhost:8080/manager\(aq, saltenv=\(aqbase\(aq, timeout=180, temp_war_location=None, version=True)
Deploy a WAR file
.INDENT 7.0
.TP
.B war
absolute path to WAR file (should be accessible by the user running
tomcat) or a path supported by the salt.modules.cp.get_file function
.TP
.B context
the context path to deploy
.TP
.B force
False
set True to deploy the webapp even one is deployed in the context
.TP
.B url
\fI\%http://localhost:8080/manager\fP
the URL of the server manager webapp
.TP
.B saltenv
base
the environment for WAR file in used by salt.modules.cp.get_url
function
.TP
.B timeout
180
timeout for HTTP request
.TP
.B temp_war_location
None
use another location to temporarily copy to war file
by default the system\(aqs temp directory is used
.TP
.B version
\(aq\(aq
Specify the war version.  If this argument is provided, it overrides
the version encoded in the war file name, if one is present.
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.deploy_war salt://salt\-2015.8.6.war version=2015.08.r6
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.6.

.UNINDENT
.sp
CLI Examples:
.sp
cp module
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.deploy_war salt://application.war /api
salt \(aq*\(aq tomcat.deploy_war salt://application.war /api no
salt \(aq*\(aq tomcat.deploy_war salt://application.war /api yes http://localhost:8080/manager
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
minion local file system
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.deploy_war /tmp/application.war /api
salt \(aq*\(aq tomcat.deploy_war /tmp/application.war /api no
salt \(aq*\(aq tomcat.deploy_war /tmp/application.war /api yes http://localhost:8080/manager
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.extract_war_version(war)
Extract the version from the war file name. There does not seem to be a
standard for encoding the version into the \fI\%war file name\fP
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/path/salt\-2015.8.6.war \-> 2015.8.6
/path/V6R2013xD5.war \-> None
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.fullversion()
Return all server information from catalina.sh version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.fullversion
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.leaks(url=\(aqhttp://localhost:8080/manager\(aq, timeout=180)
Find memory leaks in tomcat
.INDENT 7.0
.TP
.B url
\fI\%http://localhost:8080/manager\fP
the URL of the server manager webapp
.TP
.B timeout
180
timeout for HTTP request
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.leaks
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.ls(url=\(aqhttp://localhost:8080/manager\(aq, timeout=180)
list all the deployed webapps
.INDENT 7.0
.TP
.B url
\fI\%http://localhost:8080/manager\fP
the URL of the server manager webapp
.TP
.B timeout
180
timeout for HTTP request
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.ls
salt \(aq*\(aq tomcat.ls http://localhost:8080/manager
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.passwd(passwd, user=\(aq\(aq, alg=\(aqsha1\(aq, realm=None)
This function replaces the $CATALINA_HOME/bin/digest.sh script
convert a clear\-text password to the $CATALINA_BASE/conf/tomcat\-users.xml
format
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.passwd secret
salt \(aq*\(aq tomcat.passwd secret tomcat sha1
salt \(aq*\(aq tomcat.passwd secret tomcat sha1 \(aqProtected Realm\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.reload_(app, url=\(aqhttp://localhost:8080/manager\(aq, timeout=180)
Reload the webapp
.INDENT 7.0
.TP
.B app
the webapp context path
.TP
.B url
\fI\%http://localhost:8080/manager\fP
the URL of the server manager webapp
.TP
.B timeout
180
timeout for HTTP request
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.reload /jenkins
salt \(aq*\(aq tomcat.reload /jenkins http://localhost:8080/manager
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.serverinfo(url=\(aqhttp://localhost:8080/manager\(aq, timeout=180)
return details about the server
.INDENT 7.0
.TP
.B url
\fI\%http://localhost:8080/manager\fP
the URL of the server manager webapp
.TP
.B timeout
180
timeout for HTTP request
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.serverinfo
salt \(aq*\(aq tomcat.serverinfo http://localhost:8080/manager
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.sessions(app, url=\(aqhttp://localhost:8080/manager\(aq, timeout=180)
return the status of the webapp sessions
.INDENT 7.0
.TP
.B app
the webapp context path
.TP
.B url
\fI\%http://localhost:8080/manager\fP
the URL of the server manager webapp
.TP
.B timeout
180
timeout for HTTP request
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.sessions /jenkins
salt \(aq*\(aq tomcat.sessions /jenkins http://localhost:8080/manager
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.signal(signal=None)
Signals catalina to start, stop, securestart, forcestop.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.signal start
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.start(app, url=\(aqhttp://localhost:8080/manager\(aq, timeout=180)
Start the webapp
.INDENT 7.0
.TP
.B app
the webapp context path
.TP
.B url
\fI\%http://localhost:8080/manager\fP
the URL of the server manager webapp
.TP
.B timeout
timeout for HTTP request
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.start /jenkins
salt \(aq*\(aq tomcat.start /jenkins http://localhost:8080/manager
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.status(url=\(aqhttp://localhost:8080/manager\(aq, timeout=180)
Used to test if the tomcat manager is up
.INDENT 7.0
.TP
.B url
\fI\%http://localhost:8080/manager\fP
the URL of the server manager webapp
.TP
.B timeout
180
timeout for HTTP request
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.status
salt \(aq*\(aq tomcat.status http://localhost:8080/manager
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.status_webapp(app, url=\(aqhttp://localhost:8080/manager\(aq, timeout=180)
return the status of the webapp (stopped | running | missing)
.INDENT 7.0
.TP
.B app
the webapp context path
.TP
.B url
\fI\%http://localhost:8080/manager\fP
the URL of the server manager webapp
.TP
.B timeout
180
timeout for HTTP request
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.status_webapp /jenkins
salt \(aq*\(aq tomcat.status_webapp /jenkins http://localhost:8080/manager
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.stop(app, url=\(aqhttp://localhost:8080/manager\(aq, timeout=180)
Stop the webapp
.INDENT 7.0
.TP
.B app
the webapp context path
.TP
.B url
\fI\%http://localhost:8080/manager\fP
the URL of the server manager webapp
.TP
.B timeout
180
timeout for HTTP request
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.stop /jenkins
salt \(aq*\(aq tomcat.stop /jenkins http://localhost:8080/manager
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.undeploy(app, url=\(aqhttp://localhost:8080/manager\(aq, timeout=180)
Undeploy a webapp
.INDENT 7.0
.TP
.B app
the webapp context path
.TP
.B url
\fI\%http://localhost:8080/manager\fP
the URL of the server manager webapp
.TP
.B timeout
180
timeout for HTTP request
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.undeploy /jenkins
salt \(aq*\(aq tomcat.undeploy /jenkins http://localhost:8080/manager
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tomcat.version()
Return server version from catalina.sh version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tomcat.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.trafficserver
.sp
Apache Traffic Server execution module.
.sp
New in version 2015.8.0.

.sp
\fBtraffic_ctl\fP is used to execute individual Traffic Server commands and to
script multiple commands in a shell.
.INDENT 0.0
.TP
.B salt.modules.trafficserver.alarms()
List all alarm events that have not been acknowledged (cleared).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.alarms
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.bounce_cluster()
Bounce all Traffic Server nodes in the cluster. Bouncing Traffic Server
shuts down and immediately restarts Traffic Server, node\-by\-node.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.bounce_cluster
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.bounce_local(drain=False)
Bounce Traffic Server on the local node. Bouncing Traffic Server shuts down
and immediately restarts the Traffic Server node.
.INDENT 7.0
.TP
.B drain
This option modifies the restart behavior such that traffic_server
is not shut down until the number of active client connections
drops to the number given by the
proxy.config.restart.active_client_threshold configuration
variable.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.bounce_local
salt \(aq*\(aq trafficserver.bounce_local drain=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.clear_alarms(alarm)
Clear (acknowledge) an alarm event. The arguments are “all” for all current
alarms, a specific alarm number (e.g. ‘‘1’‘), or an alarm string identifier
(e.g. ‘’MGMT_ALARM_PROXY_CONFIG_ERROR’‘).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.clear_alarms [all | #event | name]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.clear_cluster()
Clears accumulated statistics on all nodes in the cluster.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.clear_cluster
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.clear_node()
Clears accumulated statistics on the local node.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.clear_node
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.match_config(regex)
Display the current values of all configuration variables whose
names match the given regular expression.
.sp
New in version 2016.11.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.match_config regex
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.match_metric(regex)
Display the current values of all metrics whose names match the
given regular expression.
.sp
New in version 2016.11.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.match_metric regex
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.offline(path)
Mark a cache storage device as offline. The storage is identified by a path
which must match exactly a path specified in storage.config. This removes
the storage from the cache and redirects requests that would have used this
storage to other storage. This has exactly the same effect as a disk
failure for that storage. This does not persist across restarts of the
traffic_server process.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.offline /path/to/cache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.read_config(*args)
Read Traffic Server configuration variable definitions.
.sp
New in version 2016.11.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.read_config proxy.config.http.keep_alive_post_out
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.read_metric(*args)
Read Traffic Server one or more metrics.
.sp
New in version 2016.11.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.read_metric proxy.process.http.tcp_hit_count_stat
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.refresh()
Initiate a Traffic Server configuration file reread. Use this command to
update the running configuration after any configuration file modification.
.sp
The timestamp of the last reconfiguration event (in seconds since epoch) is
published in the proxy.node.config.reconfigure_time metric.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.refresh
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.restart_cluster()
Restart the traffic_manager process and the traffic_server process on all
the nodes in a cluster.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.restart_cluster
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.restart_local(drain=False)
Restart the traffic_manager and traffic_server processes on the local node.
.INDENT 7.0
.TP
.B drain
This option modifies the restart behavior such that
\fBtraffic_server\fP is not shut down until the number of
active client connections drops to the number given by the
\fBproxy.config.restart.active_client_threshold\fP configuration
variable.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.restart_local
salt \(aq*\(aq trafficserver.restart_local drain=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.set_config(variable, value)
Set the value of a Traffic Server configuration variable.
.INDENT 7.0
.TP
.B variable
Name of a Traffic Server configuration variable.
.TP
.B value
The new value to set.
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.set_config proxy.config.http.keep_alive_post_out 0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.shutdown()
Shut down Traffic Server on the local node.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.shutdown
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.startup()
Start Traffic Server on the local node.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.start
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.status()
Show the current proxy server status, indicating if we’re running or not.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.zero_cluster()
Reset performance statistics to zero across the cluster.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.zero_cluster
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.trafficserver.zero_node()
Reset performance statistics to zero on the local node.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq trafficserver.zero_cluster
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.transactional_update module
.SS Transactional update
.sp
New in version 3004.

.sp
A transactional system, like \fI\%MicroOS\fP, can present some challenges
when the user decided to manage it via Salt.
.sp
MicroOS provides a read\-only rootfs and a tool,
\fBtransactional\-update\fP, that takes care of the management of the
system (updating, upgrading, installation or reboot, among others) in
an atomic way.
.sp
Atomicity is the main feature of MicroOS, and to guarantee this
property, this model leverages \fBsnapper\fP, \fBzypper\fP, \fBbtrfs\fP and
\fBoverlayfs\fP to create snapshots that will be updated independently
of the currently running system, and that are activated after the
reboot.  This implies, for example, that some changes made on the
system are not visible until the next reboot, as those changes are
living in a different snapshot of the file system.
.sp
This model presents a lot of problems with the traditional Salt model,
where the inspections (like \(aqis this package installed?\(aq) are executed
in order to determine if a subsequent action is required (like
\(aqinstall this package\(aq).
.sp
Lets consider this use case, to see how it works on a traditional
system, and in a transactional system:
.INDENT 0.0
.IP 1. 3
Check if \fBapache\fP is installed
.IP 2. 3
If it is not installed, install it
.IP 3. 3
Check that a \fBvhost\fP is configured for \fBapache\fP
.IP 4. 3
Make sure that \fBapache2.service\fP is enabled
.IP 5. 3
If the configuration changes, restart \fBapache2.service\fP
.UNINDENT
.sp
In the traditional system everything will work as expected.  The
system can see if the package is present or not, install it if it
isn\(aqt, and a re\-check will shows that is already present.  The same
will happen to the configuration file in \fB/etc/apache2\fP, that will
be available as soon the package gets installed.  Salt can inspect the
current form of this file, and add the missing bits if required.  Salt
can annotate that a change is present, and restart the service.
.sp
In a transactional system we will have multiple issues.  The first one
is that Salt can only see the content of the snapshot where the system
booted from.  Later snapshots may contain different content, including
the presence of \fBapache\fP\&.  If Salt decides to install \fBapache\fP
calling \fBzypper\fP, it will fail, as this will try to write into the
read\-only rootfs.  Even if Salt would call \fBtransactional\-update pkg
install\fP, the package would only be present in the new transaction
(snapshot), and will not be found in the currently running system when
later Salt tries to validate the presence of the package in the
current one.
.sp
Any change in \fB/etc\fP alone will have also problems, as the changes
will be alive in a different overlay, only visible after the reboot.
And, finally, the service can only be enabled and restarted if the
service file is already present in the current \fB/etc\fP\&.
.SS General strategy
.sp
\fBtransactional\-update\fP is the reference tool used for the
administration of transactional systems.  Newer versions of this tool
support the execution of random commands in the new transaction, the
continuation of a transaction, the automatic detection of changes in
new transactions and the merge of \fB/etc\fP overlays.
.SS Continue a transaction
.sp
One prerequisite already present is the support for branching from a
different snapshot than the current one in snapper.
.sp
With this feature we can represent in \fBtransactional\-update\fP the
action of creating a transaction snapshot based on one that is planned
to be the active one after the reboot.  This feature removes a lot of
user complains (like, for example, losing changes that are stored in a
transaction not yet activated), but also provide a more simple model
to work with.
.sp
So, for example, if the user have this scenario:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
  +\-\-\-\-\-+  *=====*  +\-\-V\-\-+
\-\-| T.1 |\-\-| T.2 |\-\-| T.3 |
  +\-\-\-\-\-+  *=====*  +\-\-A\-\-+
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
where T.2 is the current active one, and T.3 is an snapshot generated
from T.2 with a new package (\fBapache2\fP), and is marked to be the
active after the reboot.
.sp
Previously, if the user (that is still on T.2) created a new
transaction, maybe for adding a new package (\fBtomcat\fP, for example),
the new T.4 will be based on the content of T.2 again, and not T.3, so
the new T.4 will have lost the changes of T.3 (i.e. \fIapache2\fP will not
be present in T.4).
.sp
With the \fB\-\-continue\fP parameter, \fBtransactional\-update\fP will
create T.4 based on T.3, and nothing will be lost.
.SS Command execution inside a new transaction
.sp
With \fBtransactional\-update run\fP we will create a new transaction
based on the current one (T.2), where we can send interactive commands
that can modify the new transaction, and as commented, with
\fBtransactional\-update \-\-continue run\fP, we will create a new
transaction based on the last created (T.3)
.sp
The \fBrun\fP command can execute any application inside the new
transaction namespace.  This module uses this feature to execute the
different Salt execution modules, via \fBcall()\fP\&. Or even the full
\fBsalt\-thin\fP or \fBsalt\-call\fP via \fBsls()\fP, \fBapply()\fP,
\fBsingle()\fP or \fBhighstate\fP\&.
.SS \fBtransactional\-update\fP will drop empty snapshots
.sp
The option \fB\-\-drop\-if\-no\-change\fP is used to detect whether there is
any change in the file system on the read\-only subvolume of the new
transaction will be added.  If a change is present, the new
transaction will remain, if not it will be discarded.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
transactional\-update \-\-continue \-\-drop\-if\-no\-change run zypper in apache2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If we are in the scenario described before, \fBapache2\fP is already
present in T.3.  In this case a new transaction, T.4, will be created
based on T.3, \fBzypper\fP will detect that the package is already
present and no change will be produced on T.4.  At the end of the
execution, \fBtransactional\-update\fP will validate that T.3 and T.4 are
equivalent and T.4 will be discarded.
.sp
If the command is:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
transactional\-update \-\-continue \-\-drop\-if\-no\-change run zypper in tomcat
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
the new T.4 will be indeed different from T.3, and will remain after
the transaction is closed.
.sp
With this feature, every time that we call any function of this
execution module, we will minimize the amount of transaction, while
maintaining the idempotence so some operations.
.SS Report for pending transaction
.sp
A change in the system will create a new transaction, that needs to be
activated via a reboot.  With \fBpending_transaction()\fP we can check
if a reboot is needed.  We can execute the reboot using the
\fBreboot()\fP function, that will follow the plan established by the
functions of the \fBrebootmgr\fP execution module.
.SS \fB/etc\fP overlay merge when no new transaction is created
.sp
In a transactional model, \fB/etc\fP is an overlay file system.  Changes
done during the update are only present in the new transaction, and so
will only be available after the reboot.  Or worse, if the transaction
gets dropped, because there is no change in the \fBrootfs\fP, the
changes in \fB/etc\fP will be dropped too!.  This is designed like that
in order to make the configuration files for the new package available
only when new package is also available to the user.  So, after the
reboot.
.sp
This makes sense for the case when, for example, \fBapache2\fP is not
present in the current transaction, but we installed it.  The new
snapshot contains the \fBapache2\fP service, and the configuration files
in \fB/etc\fP will be accessible only after the reboot.
.sp
But this model presents an issue.  If we use \fBtransactional\-update
\-\-continue \-\-drop\-if\-no\-change run <command>\fP, where \fB<command>\fP
does not make any change in the read\-only subvolume, but only in
\fB/etc\fP (which is also read\-write in the running system), the new
overlay with the changes in \fB/etc\fP will be dropped together with the
transaction.
.sp
To fix this, \fBtransactional\-update\fP will detect that when no change
has been made on the read\-only subvolume, but done in the overlay, the
transaction will be dropped and the changes in the overlay will be
merged back into \fB/etc\fP overlay of the current transaction.
.SS Using the execution module
.sp
With this module we can create states that leverage Salt into this
kind of systems:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Install apache (low\-level API)
salt\-call transactional_update.pkg_install apache2

# We can call any execution module
salt\-call transactional_update.call pkg.install apache2

# Or via a state
salt\-call transactional_update.single pkg.installed name=apache2

# We can also execute a zypper directly
salt\-call transactional_update run \(dqzypper in apache2\(dq snapshot=\(dqcontinue\(dq

# We can reuse SLS states
salt\-call transactional_update.apply install_and_configure_apache

# Or apply the full highstate
salt\-call transactional_update.highstate

# Is there any change done in the system?
salt\-call transactional_update pending_transaction

# If so, reboot via rebootmgr
salt\-call transactional_update reboot

# We can enable the service
salt\-call service.enable apache2

# If apache2 is available, this will work too
salt\-call service.restart apache2
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Fixing some expectations
.sp
This module alone is an improvement over the current state, but is
easy to see some limitations and problems:
.SS Is not a fully transparent approach
.sp
The user needs to know if the system is transactional or not, as not
everything can be expressed inside a transaction (for example,
restarting a service inside transaction is not allowed).
.SS Two step for service restart
.sp
In the \fBapache2\fP example from the beginning we can observe the
biggest drawback.  If the package \fBapache2\fP is missing, the new
module will create a new transaction, will execute \fBpkg.install\fP
inside the transaction (creating the salt\-thin, moving it inside and
delegating the execution to \fBtransactional\-update\fP CLI as part of the
full state).  Inside the transaction we can do too the required
changes in \fB/etc\fP for adding the new \fBvhost\fP, and we can enable the
service via systemctl inside the same transaction.
.sp
At this point we will not merge the \fB/etc\fP overlay into the current
one, and we expect from the user call the \fBreboot\fP function inside
this module, in order to activate the new transaction and start the
\fBapache2\fP service.
.sp
In the case that the package is already there, but the configuration
for the \fBvhost\fP is required, the new transaction will be dropped and
the \fB/etc\fP overlay will be visible in the live system.  Then from
outside the transaction, via a different call to Salt, we can command
a restart of the \fBapache2\fP service.
.sp
We can see that in both cases we break the user expectation, where a
change on the configuration will trigger automatically the restart of
the associated service.  In a transactional scenario we need two
different steps: or a reboot, or a restart from outside of the
transaction.
.INDENT 0.0
.TP
.B maintainer
Alberto Planas <\fI\%aplanas@suse.com\fP>
.TP
.B maturity
new
.TP
.B depends
None
.TP
.B platform
Linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.apply_(mods=None, **kwargs)
Apply an state inside a transaction.
.sp
This function will call \fItransactional_update.highstate\fP or
\fItransactional_update.sls\fP based on the arguments passed to this
function. It exists as a more intuitive way of applying states.
.sp
For a formal description of the possible parameters accepted in
this function, check \fIstate.apply_\fP documentation.
.INDENT 7.0
.TP
.B activate_transaction
If at the end of the transaction there is a pending activation
(i.e there is a new snapshot in the system), a new reboot will
be scheduled (default False)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update.apply
salt microos transactional_update.apply stuff
salt microos transactional_update.apply stuff pillar=\(aq{\(dqfoo\(dq: \(dqbar\(dq}\(aq
salt microos transactional_update.apply stuff activate_transaction=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.bootloader(self_update=False, snapshot=None)
Reinstall the bootloader
.sp
Same as grub.cfg, but will also rewrite the bootloader itself.
.INDENT 7.0
.TP
.B self_update
Check for newer transactional\-update versions.
.TP
.B snapshot
Use the given snapshot or, if no number is given, the current
default snapshot as a base for the next snapshot. Use
\(dqcontinue\(dq to indicate the last snapshot done.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update bootloader snapshot=\(dqcontinue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.call(function, *args, **kwargs)
Executes a Salt function inside a transaction.
.sp
The chroot does not need to have Salt installed, but Python is
required.
.INDENT 7.0
.TP
.B function
Salt execution module function
.TP
.B activate_transaction
If at the end of the transaction there is a pending activation
(i.e there is a new snapshot in the system), a new reboot will
be scheduled (default False)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update.call test.ping
salt microos transactional_update.call ssh.set_auth_key user key=mykey
salt microos transactional_update.call pkg.install emacs activate_transaction=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.cleanup(self_update=False)
Run both cleanup\-snapshots and cleanup\-overlays.
.sp
Identical to calling both cleanup\-snapshots and cleanup\-overlays.
.INDENT 7.0
.TP
.B self_update
Check for newer transactional\-update versions.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update cleanup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.cleanup_overlays(self_update=False)
Remove unused overlay layers.
.sp
Removes all unreferenced (and thus unused) /etc overlay
directories in /var/lib/overlay.
.INDENT 7.0
.TP
.B self_update
Check for newer transactional\-update versions.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update cleanup_overlays
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.cleanup_snapshots(self_update=False)
Mark unused snapshots for snapper removal.
.sp
If the current root filesystem is identical to the active root
filesystem (means after a reboot, before transactional\-update
creates a new snapshot with updates), all old snapshots without a
cleanup algorithm get a cleanup algorithm set. This is to make
sure, that old snapshots will be deleted by snapper. See the
section about cleanup algorithms in snapper(8).
.INDENT 7.0
.TP
.B self_update
Check for newer transactional\-update versions.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update cleanup_snapshots
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.dup(self_update=False, snapshot=None)
Call \(aqzypper dup\(aq
.sp
If new updates are available, a new snapshot is created and zypper
dup \-\-no\-allow\-vendor\-change is used to update the
snapshot. Afterwards, the snapshot is activated and will be used
as the new root filesystem during next boot.
.INDENT 7.0
.TP
.B self_update
Check for newer transactional\-update versions.
.TP
.B snapshot
Use the given snapshot or, if no number is given, the current
default snapshot as a base for the next snapshot. Use
\(dqcontinue\(dq to indicate the last snapshot done.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update dup snapshot=\(dqcontinue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.grub_cfg(self_update=False, snapshot=None)
Regenerate grub.cfg
.sp
grub2\-mkconfig(8) is called to create a new /boot/grub2/grub.cfg
configuration file for the bootloader.
.INDENT 7.0
.TP
.B self_update
Check for newer transactional\-update versions.
.TP
.B snapshot
Use the given snapshot or, if no number is given, the current
default snapshot as a base for the next snapshot. Use
\(dqcontinue\(dq to indicate the last snapshot done.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update grub_cfg snapshot=\(dqcontinue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.highstate(activate_transaction=False, queue=False, **kwargs)
Retrieve the state data from the salt master for this minion and
execute it inside a transaction.
.sp
For a formal description of the possible parameters accepted in
this function, check \fIstate.highstate\fP documentation.
.INDENT 7.0
.TP
.B activate_transaction
If at the end of the transaction there is a pending activation
(i.e there is a new snapshot in the system), a new reboot will
be scheduled (Default: False).
.TP
.B queue
Instead of failing immediately when another state run is in progress,
queue the new state run to begin running once the other has finished.
.sp
This option starts a new thread for each queued state run, so use this
option sparingly (Default: False).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update.highstate
salt microos transactional_update.highstate pillar=\(aq{\(dqfoo\(dq: \(dqbar\(dq}\(aq
salt microos transactional_update.highstate activate_transaction=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.in_transaction()
Check if Salt is executing while in a transaction
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update in_transaction
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.initrd(self_update=False, snapshot=None)
Regenerate initrd
.sp
A new initrd is created in a snapshot.
.INDENT 7.0
.TP
.B self_update
Check for newer transactional\-update versions.
.TP
.B snapshot
Use the given snapshot or, if no number is given, the current
default snapshot as a base for the next snapshot. Use
\(dqcontinue\(dq to indicate the last snapshot done.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update initrd snapshot=\(dqcontinue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.kdump(self_update=False, snapshot=None)
Regenerate kdump initrd
.sp
A new initrd for kdump is created in a snapshot.
.INDENT 7.0
.TP
.B self_update
Check for newer transactional\-update versions.
.TP
.B snapshot
Use the given snapshot or, if no number is given, the current
default snapshot as a base for the next snapshot. Use
\(dqcontinue\(dq to indicate the last snapshot done.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update kdump snapshot=\(dqcontinue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.migration(self_update=False, snapshot=None)
Updates systems registered via SCC / SMT
.sp
On systems which are registered against the SUSE Customer Center
(SCC) or SMT, a migration to a new version of the installed
products can be made with this option.
.INDENT 7.0
.TP
.B self_update
Check for newer transactional\-update versions.
.TP
.B snapshot
Use the given snapshot or, if no number is given, the current
default snapshot as a base for the next snapshot. Use
\(dqcontinue\(dq to indicate the last snapshot done.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update migration snapshot=\(dqcontinue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.patch(self_update=False, snapshot=None)
Call \(aqzypper patch\(aq
.sp
If new updates are available, a new snapshot is created and zypper
patch is used to update the snapshot. Afterwards, the snapshot is
activated and will be used as the new root filesystem during next
boot.
.INDENT 7.0
.TP
.B self_update
Check for newer transactional\-update versions.
.TP
.B snapshot
Use the given snapshot or, if no number is given, the current
default snapshot as a base for the next snapshot. Use
\(dqcontinue\(dq to indicate the last snapshot done.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update patch snapshot=\(dqcontinue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.pending_transaction()
Check if there is a pending transaction
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update pending_transaction
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.pkg_install(pkg=None, pkgs=None, args=None, self_update=False, snapshot=None)
Install individual packages
.sp
Installs additional software. See the install description in the
\(dqPackage Management Commands\(dq section of zypper\(aqs man page for all
available arguments.
.INDENT 7.0
.TP
.B pkg
Package name to install
.TP
.B pkgs
List of packages names to install
.TP
.B args
String or list of extra parameters for zypper
.TP
.B self_update
Check for newer transactional\-update versions.
.TP
.B snapshot
Use the given snapshot or, if no number is given, the current
default snapshot as a base for the next snapshot. Use
\(dqcontinue\(dq to indicate the last snapshot done.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update pkg_install pkg=emacs snapshot=\(dqcontinue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.pkg_remove(pkg=None, pkgs=None, args=None, self_update=False, snapshot=None)
Remove individual packages
.sp
Removes installed software. See the remove description in the
\(dqPackage Management Commands\(dq section of zypper\(aqs man page for all
available arguments.
.INDENT 7.0
.TP
.B pkg
Package name to install
.TP
.B pkgs
List of packages names to install
.TP
.B args
String or list of extra parameters for zypper
.TP
.B self_update
Check for newer transactional\-update versions.
.TP
.B snapshot
Use the given snapshot or, if no number is given, the current
default snapshot as a base for the next snapshot. Use
\(dqcontinue\(dq to indicate the last snapshot done.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update pkg_remove pkg=vim snapshot=\(dqcontinue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.pkg_update(pkg=None, pkgs=None, args=None, self_update=False, snapshot=None)
Updates individual packages
.sp
Update selected software. See the update description in the
\(dqUpdate Management Commands\(dq section of zypper\(aqs man page for all
available arguments.
.INDENT 7.0
.TP
.B pkg
Package name to install
.TP
.B pkgs
List of packages names to install
.TP
.B args
String or list of extra parameters for zypper
.TP
.B self_update
Check for newer transactional\-update versions.
.TP
.B snapshot
Use the given snapshot or, if no number is given, the current
default snapshot as a base for the next snapshot. Use
\(dqcontinue\(dq to indicate the last snapshot done.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update pkg_update pkg=emacs snapshot=\(dqcontinue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.reboot(self_update=False)
Reboot after update
.sp
Trigger a reboot after updating the system.
.sp
Several different reboot methods are supported, configurable via
the REBOOT_METHOD configuration option in
transactional\-update.conf(5). By default rebootmgrd(8) will be
used to reboot the system according to the configured policies if
the service is running, otherwise systemctl reboot will be called.
.INDENT 7.0
.TP
.B self_update
Check for newer transactional\-update versions.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update reboot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.rollback(snapshot=None)
Set the current, given or last working snapshot as default snapshot
.sp
Sets the default root file system. On a read\-only system the root
file system is set directly using btrfs. On read\-write systems
snapper(8) rollback is called.
.sp
If no snapshot number is given, the current root file system is
set as the new default root file system. Otherwise number can
either be a snapshot number (as displayed by snapper list) or the
word last. last will try to reset to the latest working snapshot.
.INDENT 7.0
.TP
.B snapshot
Use the given snapshot or, if no number is given, the current
default snapshot as a base for the next snapshot. Use
\(dqlast\(dq to indicate the last working snapshot done.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update rollback
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.run(command, self_update=False, snapshot=None)
Run a command in a new snapshot
.sp
Execute the command inside a new snapshot. By default this snapshot
will remain, but if \-\-drop\-if\-no\-change is set, the new snapshot
will be dropped if there is no change in the file system.
.INDENT 7.0
.TP
.B command
Command with parameters that will be executed (as string or
array)
.TP
.B self_update
Check for newer transactional\-update versions.
.TP
.B snapshot
Use the given snapshot or, if no number is given, the current
default snapshot as a base for the next snapshot. Use
\(dqcontinue\(dq to indicate the last snapshot done.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update run \(dqmkdir /tmp/dir\(dq snapshot=\(dqcontinue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.single(fun, name, activate_transaction=False, queue=False, **kwargs)
Execute a single state function with the named kwargs, returns
False if insufficient data is sent to the command
.sp
By default, the values of the kwargs will be parsed as YAML. So,
you can specify lists values, or lists of single entry key\-value
maps, as you would in a YAML salt file. Alternatively, JSON format
of keyword values is also supported.
.INDENT 7.0
.TP
.B activate_transaction
If at the end of the transaction there is a pending activation
(i.e there is a new snapshot in the system), a new reboot will
be scheduled (Default: False).
.TP
.B queue
Instead of failing immediately when another state run is in progress,
queue the new state run to begin running once the other has finished.
.sp
This option starts a new thread for each queued state run, so use this
option sparingly (Default: False).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update.single pkg.installed name=emacs
salt microos transactional_update.single pkg.installed name=emacs activate_transaction=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.sls(mods, activate_transaction=False, queue=False, **kwargs)
Execute the states in one or more SLS files inside a transaction.
.INDENT 7.0
.TP
.B saltenv
Specify a salt fileserver environment to be used when applying
states
.TP
.B mods
List of states to execute
.TP
.B test
Run states in test\-only (dry\-run) mode
.TP
.B exclude
Exclude specific states from execution. Accepts a list of sls
names, a comma\-separated string of sls names, or a list of
dictionaries containing \fBsls\fP or \fBid\fP keys. Glob\-patterns
may be used to match multiple states.
.TP
.B activate_transaction
If at the end of the transaction there is a pending activation
(i.e there is a new snapshot in the system), a new reboot will
be scheduled (Default: False).
.TP
.B queue
Instead of failing immediately when another state run is in progress,
queue the new state run to begin running once the other has finished.
.sp
This option starts a new thread for each queued state run, so use this
option sparingly (Default: False).
.UNINDENT
.sp
For a formal description of the possible parameters accepted in
this function, check \fIstate.sls\fP documentation.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update.sls stuff pillar=\(aq{\(dqfoo\(dq: \(dqbar\(dq}\(aq
salt microos transactional_update.sls stuff activate_transaction=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.transactional()
Check if the system is a transactional system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update transactional
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.transactional_update.up(self_update=False, snapshot=None)
Call \(aqzypper up\(aq
.sp
If new updates are available, a new snapshot is created and zypper
up is used to update the snapshot. Afterwards, the snapshot is
activated and will be used as the new root filesystem during next
boot.
.INDENT 7.0
.TP
.B self_update
Check for newer transactional\-update versions.
.TP
.B snapshot
Use the given snapshot or, if no number is given, the current
default snapshot as a base for the next snapshot. Use
\(dqcontinue\(dq to indicate the last snapshot done.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt microos transactional_update up snapshot=\(dqcontinue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.travisci
.sp
Commands for working with travisci.
.INDENT 0.0
.TP
.B depends
pyOpenSSL >= 16.0.0
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.travisci.verify_webhook(signature, body)
Verify the webhook signature from travisci
.INDENT 7.0
.TP
.B signature
The signature header from the webhook header
.TP
.B body
The full payload body from the webhook post
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The body needs to be the urlencoded version of the body.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq travisci.verify_webhook \(aqM6NucCX5722bxisQs7e...\(aq \(aqpayload=%7B%22id%22%3A183791261%2C%22repository...\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.tuned
.sp
Interface to Red Hat tuned\-adm module
.INDENT 0.0
.TP
.B maintainer
Syed Ali <\fI\%alicsyed@gmail.com\fP>
.TP
.B maturity
new
.TP
.B depends
tuned\-adm
.TP
.B platform
Linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tuned.active()
Return current active profile in stdout key if retcode is 0, otherwise raw result
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tuned.active
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tuned.list_()
List the profiles available
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tuned.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tuned.off()
Turn off all profiles
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tuned.off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.tuned.profile(profile_name)
Activate specified profile
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq tuned.profile virtual\-guest
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.twilio_notify
.sp
Module for notifications via Twilio
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
twilio python module
.UNINDENT
.TP
.B configuration
Configure this module by specifying the name of a configuration
profile in the minion config, minion pillar, or master config (with \fI\%pillar_opts\fP set to True).
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my\-twilio\-account:
    twilio.account_sid: AC32a3c83990934481addd5ce1659f04d2
    twilio.auth_token: mytoken
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.twilio_notify.send_sms(profile, body, to, from_)
Send an sms
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
twilio.send_sms my\-twilio\-account \(aqTest sms\(aq \(aq+18019999999\(aq \(aq+18011111111\(aq
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.udev
.sp
Manage and query udev info
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B salt.modules.udev.env(dev)
Return all environment variables udev has for dev
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq udev.env /dev/sda
salt \(aq*\(aq udev.env /sys/class/net/eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.udev.exportdb()
Return all the udev database
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq udev.exportdb
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.udev.info(dev)
Extract all info delivered by udevadm
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq udev.info /dev/sda
salt \(aq*\(aq udev.info /sys/class/net/eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.udev.links(dev)
Return all udev\-created device symlinks
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq udev.links /dev/sda
salt \(aq*\(aq udev.links /sys/class/net/eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.udev.name(dev)
Return the actual dev name(s?) according to udev for dev
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq udev.dev /dev/sda
salt \(aq*\(aq udev.dev /sys/class/net/eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.udev.path(dev)
Return the physical device path(s?) according to udev for dev
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq udev.path /dev/sda
salt \(aq*\(aq udev.path /sys/class/net/eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.upstart_service
.sp
Module for the management of upstart systems. The Upstart system only supports
service starting, stopping and restarting.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage services on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqservice.start\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
Currently (as of Ubuntu 12.04) there is no tool available to disable
Upstart services (like update\-rc.d). This[1] is the recommended way to
disable an Upstart service. So we assume that all Upstart services
that have not been disabled in this manner are enabled.
.sp
But this is broken because we do not check to see that the dependent
services are enabled. Otherwise we would have to do something like
parse the output of \(dqinitctl show\-config\(dq to determine if all service
dependencies are enabled to start on boot. For example, see the \(dqstart
on\(dq condition for the lightdm service below[2]. And this would be too
hard. So we wait until the upstart developers have solved this
problem. :) This is to say that an Upstart service that is enabled may
not really be enabled.
.sp
Also, when an Upstart service is enabled, should the dependent
services be enabled too? Probably not. But there should be a notice
about this, at least.
.sp
[1] \fI\%http://upstart.ubuntu.com/cookbook/#disabling\-a\-job\-from\-automatically\-starting\fP
.sp
[2] example upstart configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lightdm
emits login\-session\-start
emits desktop\-session\-start
emits desktop\-shutdown
start on ((((filesystem and runlevel [!06]) and started dbus) and (drm\-device\-added card0 PRIMARY_DEVICE_FOR_DISPLAY=1 or stopped udev\-fallback\-graphics)) or runlevel PREVLEVEL=S)
stop on runlevel [016]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module should not be used on Red Hat systems. For these,
the \fI\%rh_service\fP module should be
used, as it supports the hybrid upstart/sysvinit system used in
RHEL/CentOS 6.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.available(name)
Returns \fBTrue\fP if the specified service is available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.available sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.disable(name, **kwargs)
Disable the named service from starting on boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.disabled(name)
Check to see if the named service is disabled to start on boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.enable(name, **kwargs)
Enable the named service to start at boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.enabled(name, **kwargs)
Check to see if the named service is enabled to start on boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.force_reload(name)
Force\-reload the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.force_reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.full_restart(name)
Do a full restart (stop/start) of the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.full_restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.get_all()
Return all installed services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.get_disabled()
Return the disabled services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_disabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.get_enabled()
Return the enabled services
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.missing(name)
The inverse of service.available.
Returns \fBTrue\fP if the specified service is not available, otherwise returns
\fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.missing sshd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.reload_(name)
Reload the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.reload <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.restart(name)
Restart the named service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.start(name)
Start the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.status(name, sig=None)
Return the status for a service.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.sp
Changed in version 2018.3.0: The service name can now be a glob (e.g. \fBsalt*\fP)

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.IP \(bu 2
\fBsig\fP (\fI\%str\fP) \-\- Signature to use to find the service via ps
.UNINDENT
.TP
.B Returns
True if running, False otherwise
dict: Maps service name to True if running, False otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name> [service signature]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.upstart_service.stop(name)
Stop the specified service
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.uptime
.SS Wrapper around uptime API
.INDENT 0.0
.TP
.B salt.modules.uptime.check_exists(name)
Check if a given URL is in being monitored by uptime
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq uptime.check_exists http://example.org
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.uptime.checks_list()
List URL checked by uptime
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq uptime.checks_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.uptime.create(name, **params)
Create a check on a given URL.
.sp
Additional parameters can be used and are passed to API (for
example interval, maxTime, etc). See the documentation
\fI\%https://github.com/fzaninotto/uptime\fP for a full list of the
parameters.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq uptime.create http://example.org
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.uptime.delete(name)
Delete a check on a given URL
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq uptime.delete http://example.org
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.useradd
.sp
Manage users with the useradd command
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage users on a
minion, and it is using a different module (or gives an error similar to
\fI\(aquser.info\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.add(name, uid=None, gid=None, groups=None, home=None, shell=None, unique=True, system=False, fullname=\(aq\(aq, roomnumber=\(aq\(aq, workphone=\(aq\(aq, homephone=\(aq\(aq, other=\(aq\(aq, createhome=True, loginclass=None, nologinit=False, root=None, usergroup=None, local=False)
Add a user to the minion
.INDENT 7.0
.TP
.B name
Username LOGIN to add
.TP
.B uid
User ID of the new account
.TP
.B gid
Name or ID of the primary group of the new account
.TP
.B groups
List of supplementary groups of the new account
.TP
.B home
Home directory of the new account
.TP
.B shell
Login shell of the new account
.TP
.B unique
If not True, the user account can have a non\-unique UID
.TP
.B system
Create a system account
.TP
.B fullname
GECOS field for the full name
.TP
.B roomnumber
GECOS field for the room number
.TP
.B workphone
GECOS field for the work phone
.TP
.B homephone
GECOS field for the home phone
.TP
.B other
GECOS field for other information
.TP
.B createhome
Create the user\(aqs home directory
.TP
.B loginclass
Login class for the new account (OpenBSD)
.TP
.B nologinit
Do not add the user to the lastlog and faillog databases
.TP
.B root
Directory to chroot into
.TP
.B usergroup
Create and add the user to a new primary group of the same name
.TP
.B local (Only on systems with luseradd available)
Specifically add the user locally rather than possibly through remote providers (e.g. LDAP)
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.add name <uid> <gid> <groups> <home> <shell>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.chfullname(name, fullname, root=None)
Change the user\(aqs Full Name
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B fullname
GECOS field for the full name
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chfullname foo \(dqFoo Bar\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.chgid(name, gid, root=None)
Change the default group of the user
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B gid
Force use GID as new primary group
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chgid foo 4376
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.chgroups(name, groups, append=False, root=None)
Change the groups to which this user belongs
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B groups
Groups to set for the user
.TP
.B append
False
If \fBTrue\fP, append the specified group(s). Otherwise, this function
will replace the user\(aqs groups with the specified group(s).
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chgroups foo wheel,root
salt \(aq*\(aq user.chgroups foo wheel,root append=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.chhome(name, home, persist=False, root=None)
Change the home directory of the user, pass True for persist to move files
to the new home directory if the old home directory exist.
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B home
New home directory for the user account
.TP
.B persist
Move contents of the home directory to the new location
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chhome foo /home/users/foo True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.chhomephone(name, homephone, root=None)
Change the user\(aqs Home Phone
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B homephone
GECOS field for the home phone
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chhomephone foo 7735551234
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.chloginclass(name, loginclass, root=None)
Change the default login class of the user
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B loginclass
Login class for the new account
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function only applies to OpenBSD systems.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chloginclass foo staff
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.chother(name, other, root=None)
Change the user\(aqs other GECOS attribute
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B other
GECOS field for other information
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chother foobar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.chroomnumber(name, roomnumber, root=None)
Change the user\(aqs Room Number
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chroomnumber foo 123
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.chshell(name, shell, root=None)
Change the default shell of the user
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B shell
New login shell for the user account
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chshell foo /bin/zsh
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.chuid(name, uid, root=None)
Change the uid for a named user
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B uid
New UID for the user account
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chuid foo 4376
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.chworkphone(name, workphone, root=None)
Change the user\(aqs Work Phone
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B workphone
GECOS field for the work phone
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chworkphone foo 7735550123
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.delete(name, remove=False, force=False, root=None, local=False)
Remove a user from the minion
.INDENT 7.0
.TP
.B name
Username to delete
.TP
.B remove
Remove home directory and mail spool
.TP
.B force
Force some actions that would fail otherwise
.TP
.B root
Directory to chroot into
.TP
.B local (Only on systems with luserdel available):
Ensure the user account is removed locally ignoring global
account management (default is False).
.sp
New in version 3007.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.delete name remove=True force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.get_loginclass(name)
Get the login class of the user
.INDENT 7.0
.TP
.B name
User to get the information
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function only applies to OpenBSD systems.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.get_loginclass foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.getent(refresh=False, root=None)
Return the list of all info for all users
.INDENT 7.0
.TP
.B refresh
Force a refresh of user information
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.getent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.info(name, root=None)
Return user information
.INDENT 7.0
.TP
.B name
User to get the information
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.info root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.list_groups(name)
Return a list of groups the named user belongs to
.INDENT 7.0
.TP
.B name
User to get the information
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.list_groups foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.list_users(root=None)
Return a list of all users
.INDENT 7.0
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.list_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.primary_group(name)
Return the primary group of the named user
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
User to get the information
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.primary_group saltadmin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.useradd.rename(name, new_name, root=None)
Change the username for a named user
.INDENT 7.0
.TP
.B name
User to modify
.TP
.B new_name
New value of the login name
.TP
.B root
Directory to chroot into
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.rename name new_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.uwsgi
.sp
uWSGI stats server \fI\%https://uwsgi\-docs.readthedocs.io/en/latest/StatsServer.html\fP
.INDENT 0.0
.TP
.B maintainer
Peter Baumgartner <\fI\%pete@lincolnloop.com\fP>
.TP
.B maturity
new
.TP
.B platform
all
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.uwsgi.stats(socket)
Return the data from \fIuwsgi \-\-connect\-and\-read\fP as a dictionary.
.INDENT 7.0
.TP
.B socket
The socket the uWSGI stats server is listening on
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq uwsgi.stats /var/run/mystatsserver.sock

salt \(aq*\(aq uwsgi.stats 127.0.0.1:5050
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.vagrant
.sp
Work with virtual machines managed by Vagrant.
.sp
New in version 2018.3.0.

.sp
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sdb must be configured. An SQLite
database is the recommended storage method.  The URI used for
the sdb lookup is \(dqsdb://vagrant_sdb_data\(dq.
.INDENT 0.0
.TP
.B requirements:
.INDENT 7.0
.IP \(bu 2
the VM host machine must have salt\-minion, Vagrant and a vm provider installed.
.IP \(bu 2
the VM host must have a valid definition for \fIsdb://vagrant_sdb_data\fP
.UNINDENT
.INDENT 7.0
.INDENT 3.5
Configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# file /etc/salt/minion.d/vagrant_sdb.conf
vagrant_sdb_data:
  driver: sqlite3
  database: /var/cache/salt/vagrant.sqlite
  table: sdb
  create_table: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vagrant.destroy(name)
Destroy and delete a virtual machine. (vagrant destroy \-f)
.sp
This also removes the salt_id name defined by vagrant.init.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <host> vagrant.destroy <salt_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vagrant.get_machine_id(machine, cwd)
returns the salt_id name of the Vagrant VM
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmachine\fP \-\- the Vagrant machine name
.IP \(bu 2
\fBcwd\fP \-\- the path to Vagrantfile
.UNINDENT
.TP
.B Returns
salt_id name
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vagrant.get_ssh_config(name, network_mask=\(aq\(aq, get_private_key=False)
Retrieve hints of how you might connect to a Vagrant VM.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- the salt_id of the machine
.IP \(bu 2
\fBnetwork_mask\fP \-\- a CIDR mask to search for the VM\(aqs address
.IP \(bu 2
\fBget_private_key\fP \-\- (default: False) return the key used for ssh login
.UNINDENT
.TP
.B Returns
a dict of ssh login information for the VM
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <host> vagrant.get_ssh_config <salt_id>
salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The returned dictionary contains:
.INDENT 7.0
.IP \(bu 2
key_filename:  the name of the private key file on the VM host computer
.IP \(bu 2
ssh_username:  the username to be used to log in to the VM
.IP \(bu 2
ssh_host:  the IP address used to log in to the VM.  (This will usually be \fI127.0.0.1\fP)
.IP \(bu 2
ssh_port:  the TCP port used to log in to the VM.  (This will often be \fI2222\fP)
.IP \(bu 2
[ip_address:]  (if \fInetwork_mask\fP is defined. see below)
.IP \(bu 2
[private_key:]  (if \fIget_private_key\fP is True) the private key for ssh_username
.UNINDENT
.sp
About \fInetwork_mask\fP:
.sp
Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.
This redirected port and its IP address are \(dqssh_port\(dq and \(dqssh_host\(dq.  The ssh_host is
usually the localhost (127.0.0.1).
This makes it impossible for a third machine (such as a salt\-cloud master) to contact the VM
unless the VM has another network interface defined.  You will usually want a bridged network
defined by having a \fIconfig.vm.network \(dqpublic_network\(dq\fP statement in your \fIVagrantfile\fP\&.
.sp
The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,
but you should be able to determine what IP network the address will be chosen from.
If you enter a CIDR network mask, Salt will attempt to find the VM\(aqs address for you.
The host machine will send an \(dqip link show\(dq or \(dqifconfig\(dq command to the VM
(using ssh to \fIssh_host\fP:\fIssh_port\fP) and return the IP address of the first interface it
can find which matches your mask.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vagrant.get_vm_info(name)
get the information for a VM.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- salt_id name
.TP
.B Returns
dictionary of {\(aqmachine\(aq: x, \(aqcwd\(aq: y, ...}.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vagrant.init(name, cwd=None, machine=\(aq\(aq, runas=None, start=False, vagrant_provider=\(aq\(aq, vm=None)
Initialize a new Vagrant VM.
.sp
This inputs all the information needed to start a Vagrant VM.  These settings are stored in
a Salt sdb database on the Vagrant host minion and used to start, control, and query the
guest VMs. The salt_id assigned here is the key field for that database and must be unique.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The salt_id name you will use to control this VM
.IP \(bu 2
\fBcwd\fP \-\- The path to the directory where the Vagrantfile is located
.IP \(bu 2
\fBmachine\fP \-\- The machine name in the Vagrantfile. If blank, the primary machine will be used.
.IP \(bu 2
\fBrunas\fP \-\- The username on the host who owns the Vagrant work files.
.IP \(bu 2
\fBstart\fP \-\- (default: False) Start the virtual machine now.
.IP \(bu 2
\fBvagrant_provider\fP \-\- The name of a Vagrant VM provider (if not the default).
.IP \(bu 2
\fBvm\fP \-\- Optionally, all the above information may be supplied in this dictionary.
.UNINDENT
.TP
.B Returns
A string indicating success, or False.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <host> vagrant.init <salt_id> /path/to/Vagrantfile
salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vagrant.list_active_vms(cwd=None)
Return a list of machine names for active virtual machine on the host,
which are defined in the Vagrantfile at the indicated path.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vagrant.list_active_vms  cwd=/projects/project_1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vagrant.list_domains()
Return a list of the salt_id names of all available Vagrant VMs on
this host without regard to the path where they are defined.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vagrant.list_domains \-\-log\-level=info
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The log shows information about all known Vagrant environments
on this machine. This data is cached and may not be completely
up\-to\-date.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vagrant.list_inactive_vms(cwd=None)
Return a list of machine names for inactive virtual machine on the host,
which are defined in the Vagrantfile at the indicated path.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.list_inactive_vms cwd=/projects/project_1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vagrant.pause(name)
Pause (vagrant suspend) the named VM.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <host> vagrant.pause <salt_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vagrant.reboot(name, provision=False)
Reboot a VM. (vagrant reload)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <host> vagrant.reboot <salt_id> provision=True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The salt_id name you will use to control this VM
.IP \(bu 2
\fBprovision\fP \-\- (False) also re\-run the Vagrant provisioning scripts.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vagrant.shutdown(name)
Send a soft shutdown (vagrant halt) signal to the named vm.
.sp
This does the same thing as vagrant.stop. Other\-VM control
modules use \(dqstop\(dq and \(dqshutdown\(dq to differentiate between
hard and soft shutdowns.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <host> vagrant.shutdown <salt_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vagrant.start(name)
Start (vagrant up) a virtual machine defined by salt_id name.
The machine must have been previously defined using \(dqvagrant.init\(dq.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <host> vagrant.start <salt_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vagrant.stop(name)
Hard shutdown the virtual machine. (vagrant halt)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <host> vagrant.stop <salt_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vagrant.version()
Return the version of Vagrant on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vagrant.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vagrant.vm_state(name=\(aq\(aq, cwd=None)
Return list of information for all the vms indicating their state.
.sp
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs defined by
the Vagrantfile in the \fIcwd\fP directory.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vagrant.vm_state <name>  cwd=/projects/project_1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
returns a list of dictionaries with machine name, state, provider,
and salt_id name.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
datum = {\(aqmachine\(aq: _, # Vagrant machine name,
         \(aqstate\(aq: _, # string indicating machine state, like \(aqrunning\(aq
         \(aqprovider\(aq: _, # the Vagrant VM provider
         \(aqname\(aq: _} # salt_id name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Known bug: if there are multiple machines in your Vagrantfile, and you request
the status of the \fBprimary\fP machine, which you defined by leaving the \fBmachine\fP
parameter blank, then you may receive the status of all of them.
Please specify the actual machine name for each VM if there are more than one.
.UNINDENT
.SS salt.modules.varnish
.sp
Support for Varnish
.sp
New in version 2014.7.0.

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
These functions are designed to work with all implementations of Varnish
from 3.x onwards
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.varnish.ban(ban_expression)
Add ban to the varnish cache
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq varnish.ban ban_expression
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.varnish.ban_list()
List varnish cache current bans
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq varnish.ban_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.varnish.param_set(param, value)
Set a param in varnish cache
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq varnish.param_set param value
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.varnish.param_show(param=None)
Show params of varnish cache
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq varnish.param_show param
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.varnish.purge()
Purge the varnish cache
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq varnish.purge
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.varnish.version()
Return server version from varnishd \-V
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq varnish.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.vault
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%vault Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.SS Functions to interact with Hashicorp Vault.
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
new
.TP
.B platform
all
.TP
.B note
If you see the following error, you\(aqll need to upgrade \fBrequests\fP to at least 2.4.2
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<timestamp> [salt.pillar][CRITICAL][14337] Pillar render error: Failed to load ext_pillar vault: {\(aqerror\(aq: \(dqrequest() got an unexpected keyword argument \(aqjson\(aq\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configuration
.sp
In addition to the module configuration, it is required for the Salt master
to be configured to allow peer runs in order to use the Vault integration.
.sp
Changed in version 3007.0: The \fBvault\fP configuration structure has changed significantly to account
for many new features. If found, the old structure will be automatically
translated to the new one.
.sp
\fBPlease update your peer_run configuration\fP to take full advantage of the
updated modules. The old endpoint (\fBvault.generate_token\fP) will continue
to work, but result in unnecessary roundtrips once your minions have been
updated.

.sp
To allow minions to pull configuration and credentials from the Salt master,
add this segment to the master configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
peer_run:
    .*:
        \- vault.get_config          # always
        \- vault.generate_new_token  # relevant when \(gatoken\(ga == \(gaissue:type\(ga
        \- vault.generate_secret_id  # relevant when \(gaapprole\(ga == \(gaissue:type\(ga
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimally required configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vault:
  auth:
    token: abcdefg\-hijklmnop\-qrstuvw
  server:
    url: https://vault.example.com:8200
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A sensible example configuration, e.g. in \fB/etc/salt/master.d/vault.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vault:
  auth:
    method: approle
    role_id: e5a7b66e\-5d08\-da9c\-7075\-71984634b882
    secret_id: 841771dc\-11c9\-bbc7\-bcac\-6a3945a69cd9
  cache:
    backend: file
  issue:
    token:
      role_name: salt_minion
      params:
        explicit_max_ttl: 30
        num_uses: 10
  policies:
    assign:
      \- salt_minion
      \- salt_role_{pillar[roles]}
  server:
    url: https://vault.example.com:8200
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above configuration requires the following policies for the master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Issue tokens
path \(dqauth/token/create\(dq {
  capabilities = [\(dqcreate\(dq, \(dqread\(dq, \(dqupdate\(dq]
}

# Issue tokens with token roles
path \(dqauth/token/create/*\(dq {
  capabilities = [\(dqcreate\(dq, \(dqread\(dq, \(dqupdate\(dq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A sensible example configuration that issues AppRoles to minions
from a separate authentication endpoint (notice differing mounts):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vault:
  auth:
    method: approle
    mount: approle         # <\-\- mount the salt master authenticates at
    role_id: e5a7b66e\-5d08\-da9c\-7075\-71984634b882
    secret_id: 841771dc\-11c9\-bbc7\-bcac\-6a3945a69cd9
  cache:
    backend: file
  issue:
    type: approle
    approle:
      mount: salt\-minions  # <\-\- mount the salt master manages
  metadata:
    entity:
      minion\-id: \(aq{minion}\(aq
      role: \(aq{pillar[role]}\(aq
  server:
    url: https://vault.example.com:8200
ext_pillar:
  \- vault: path=salt/minions/{minion}
  \- vault: path=salt/roles/{pillar[role]}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above configuration requires the following policies for the master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# List existing AppRoles
path \(dqauth/salt\-minions/role\(dq {
  capabilities = [\(dqlist\(dq]
}

# Manage AppRoles
path \(dqauth/salt\-minions/role/*\(dq {
  capabilities = [\(dqread\(dq, \(dqcreate\(dq, \(dqupdate\(dq, \(dqdelete\(dq]
}

# Lookup mount accessor
path \(dqsys/auth/salt\-minions\(dq {
  capabilities = [\(dqread\(dq, \(dqsudo\(dq]
}

# Lookup entities by alias name (role\-id) and alias mount accessor
path \(dqidentity/lookup/entity\(dq {
  capabilities = [\(dqcreate\(dq, \(dqupdate\(dq]
  allowed_parameters = {
    \(dqalias_name\(dq = []
    \(dqalias_mount_accessor\(dq = [\(dqauth_approle_0a1b2c3d\(dq]
  }
}

# Manage entities with name prefix salt_minion_
path \(dqidentity/entity/name/salt_minion_*\(dq {
  capabilities = [\(dqread\(dq, \(dqcreate\(dq, \(dqupdate\(dq, \(dqdelete\(dq]
}

# Create entity aliases – you can restrict the mount_accessor
# This might allow privilege escalation in case the salt master
# is compromised and the attacker knows the entity ID of an
# entity with relevant policies attached \- although you might
# have other problems at that point.
path \(dqidentity/entity\-alias\(dq {
  capabilities = [\(dqcreate\(dq, \(dqupdate\(dq]
  allowed_parameters = {
    \(dqid\(dq = []
    \(dqcanonical_id\(dq = []
    \(dqmount_accessor\(dq = [\(dqauth_approle_0a1b2c3d\(dq]
    \(dqname\(dq = []
  }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This enables you to write templated ACL policies like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
path \(dqsalt/data/minions/{{identity.entity.metadata.minion\-id}}\(dq {
    capabilities = [\(dqread\(dq]
}

path \(dqsalt/data/roles/{{identity.entity.metadata.role}}\(dq {
    capabilities = [\(dqread\(dq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
AppRole policies and entity metadata are generally not updated
automatically. After a change, you will need to synchronize
them by running \fI\%vault.sync_approles\fP
or \fI\%vault.sync_entities\fP respectively.
.UNINDENT
.UNINDENT
.sp
All possible master configuration options with defaults:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vault:
  auth:
    approle_mount: approle
    approle_name: salt\-master
    method: token
    role_id: <required if auth:method == approle>
    secret_id: null
    token: <required if auth:method == token>
    token_lifecycle:
      minimum_ttl: 10
      renew_increment: null
  cache:
    backend: session
    config: 3600
    kv_metadata: connection
    secret: ttl
  issue:
    allow_minion_override_params: false
    type: token
    approle:
      mount: salt\-minions
      params:
        bind_secret_id: true
        secret_id_num_uses: 1
        secret_id_ttl: 60
        token_explicit_max_ttl: 60
        token_num_uses: 10
        secret_id_bound_cidrs: null
        token_ttl: null
        token_max_ttl: null
        token_no_default_policy: false
        token_period: null
        token_bound_cidrs: null
    token:
      role_name: null
      params:
        explicit_max_ttl: null
        num_uses: 1
        ttl: null
        period: null
        no_default_policy: false
        renewable: true
    wrap: 30s
  keys: []
  metadata:
    entity:
      minion\-id: \(aq{minion}\(aq
    secret:
      saltstack\-jid: \(aq{jid}\(aq
      saltstack\-minion: \(aq{minion}\(aq
      saltstack\-user: \(aq{user}\(aq
  policies:
    assign:
      \- saltstack/minions
      \- saltstack/{minion}
    cache_time: 60
    refresh_pillar: null
  server:
    url: <required, e. g. https://vault.example.com:8200>
    namespace: null
    verify: null
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBauth\fP
.sp
Contains authentication information for the local machine.
.INDENT 0.0
.TP
.B approle_mount
New in version 3007.0.

.sp
The name of the AppRole authentication mount point. Defaults to \fBapprole\fP\&.
.TP
.B approle_name
New in version 3007.0.

.sp
The name of the AppRole. Defaults to \fBsalt\-master\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Only relevant when a locally configured role_id/secret_id uses
response wrapping.
.UNINDENT
.UNINDENT
.TP
.B method
Currently only \fBtoken\fP and \fBapprole\fP auth types are supported.
Defaults to \fBtoken\fP\&.
.sp
AppRole is the preferred way to authenticate with Vault as it provides
some advanced options to control the authentication process.
Please see the \fI\%Vault documentation\fP
for more information.
.TP
.B role_id
The role ID of the AppRole. Required if \fBauth:method\fP == \fBapprole\fP\&.
.sp
Changed in version 3007.0: In addition to a plain string, this can also be specified as a
dictionary that includes \fBwrap_info\fP, i.e. the return payload
of a wrapping request.

.TP
.B secret_id
The secret ID of the AppRole.
Only required if the configured AppRole requires it.
.sp
Changed in version 3007.0: In addition to a plain string, this can also be specified as a
dictionary that includes \fBwrap_info\fP, i.e. the return payload
of a wrapping request.

.TP
.B token
Token to authenticate to Vault with. Required if \fBauth:method\fP == \fBtoken\fP\&.
.sp
The token must be able to create tokens with the policies that should be
assigned to minions.
You can still use the token auth via a OS environment variable via this
config example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
vault:
  auth:
    method: token
    token: sdb://osenv/VAULT_TOKEN
  server:
    url: https://vault.service.domain:8200

osenv:
  driver: env
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And then export the VAULT_TOKEN variable in your OS:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
export VAULT_TOKEN=11111111\-1111\-1111\-1111\-1111111111111
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3007.0: In addition to a plain string, this can also be specified as a
dictionary that includes \fBwrap_info\fP, i.e. the return payload
of a wrapping request.

.TP
.B token_lifecycle
Token renewal settings.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This setting can be specified inside a minion\(aqs configuration as well
and will override the master\(aqs default for the minion.
.sp
Token lifecycle settings have significancy for any authentication method,
not just \fBtoken\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBminimum_ttl\fP specifies the time (in seconds or as a time string like \fB24h\fP)
an in\-use token should be valid for. If the current validity period is less
than this and the token is renewable, a renewal will be attempted. If it is
not renewable or a renewal does not extend the ttl beyond the specified minimum,
a new token will be generated.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Since leases like database credentials are tied to a token, setting this to
a much higher value than the default can be necessary, depending on your
specific use case and configuration.
.UNINDENT
.UNINDENT
.sp
\fBrenew_increment\fP specifies the amount of time the token\(aqs validity should
be requested to be renewed for when renewing a token. When unset, will extend
the token\(aqs validity by its default ttl.
Set this to \fBfalse\fP to disable token renewals.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The Vault server is allowed to disregard this request.
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fBcache\fP
.sp
Configures token/lease and metadata cache (for KV secrets) on all hosts
as well as configuration cache on minions that receive issued credentials.
.INDENT 0.0
.TP
.B backend
Changed in version 3007.0: This used to be found in \fBauth:token_backend\fP\&.

.sp
The cache backend in use. Defaults to \fBsession\fP, which will store the
Vault configuration in memory only for that specific Salt run.
\fBdisk\fP/\fBfile\fP/\fBlocalfs\fP will force using the localfs driver, regardless
of configured minion data cache.
Setting this to anything else will use the default configured cache for
minion data (\fI\%cache\fP), by default the local filesystem
as well.
.TP
.B clear_attempt_revocation
New in version 3007.0.

.sp
When flushing still valid cached tokens and leases, attempt to have them
revoked after a (short) delay. Defaults to \fB60\fP\&.
Set this to false to disable revocation (not recommended).
.TP
.B clear_on_unauthorized
New in version 3007.0.

.sp
When encountering an \fBUnauthorized\fP response with an otherwise valid token,
flush the cache and request new credentials. Defaults to true.
If your policies are relatively stable, disabling this will prevent
a lot of unnecessary overhead, with the tradeoff that once they change,
you might have to clear the cache manually or wait for the token to expire.
.TP
.B config
New in version 3007.0.

.sp
The time in seconds to cache queried configuration from the master.
Defaults to \fB3600\fP (one hour). Set this to \fBnull\fP to disable
cache expiration. Changed \fBserver\fP configuration on the master will
still be recognized, but changes in \fBauth\fP and \fBcache\fP will need
a manual update using \fBvault.update_config\fP or cache clearance
using \fBvault.clear_cache\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Expiring the configuration will also clear cached authentication
credentials and leases.
.UNINDENT
.UNINDENT
.TP
.B expire_events
New in version 3007.0.

.sp
Fire an event when the session cache containing leases is cleared
(\fBvault/cache/<scope>/clear\fP) or cached leases have expired
(\fBvault/lease/<cache_key>/expire\fP).
A reactor can be employed to ensure fresh leases are issued.
Defaults to false.
.TP
.B kv_metadata
New in version 3007.0.

.sp
The time in seconds to cache KV metadata used to determine if a path
is using version 1/2 for. Defaults to \fBconnection\fP, which will clear
the metadata cache once a new configuration is requested from the
master. Setting this to \fBnull\fP will keep the information
indefinitely until the cache is cleared manually using
\fBvault.clear_cache\fP with \fBconnection=false\fP\&.
.TP
.B secret
New in version 3007.0.

.sp
The time in seconds to cache tokens/secret IDs for. Defaults to \fBttl\fP,
which caches the secret for as long as it is valid, unless a new configuration
is requested from the master.
.UNINDENT
.SS \fBissue\fP
.sp
Configures authentication data issued by the master to minions.
.INDENT 0.0
.TP
.B type
New in version 3007.0.

.sp
The type of authentication to issue to minions. Can be \fBtoken\fP or \fBapprole\fP\&.
Defaults to \fBtoken\fP\&.
.sp
To be able to issue AppRoles to minions, the master needs to be able to
create new AppRoles on the configured auth mount (see policy example above).
It is strongly encouraged to create a separate mount dedicated to minions.
.TP
.B approle
New in version 3007.0.

.sp
Configuration regarding issued AppRoles.
.sp
\fBmount\fP specifies the name of the auth mount the master manages.
Defaults to \fBsalt\-minions\fP\&. This mount should be exclusively dedicated
to the Salt master.
.sp
\fBparams\fP configures the AppRole the master creates for minions. See the
\fI\%Vault AppRole API docs\fP
for details. If you update these params, you can update the minion AppRoles
manually using the vault runner: \fBsalt\-run vault.sync_approles\fP, but they
will be updated automatically during a request by a minion as well.
.TP
.B token
New in version 3007.0.

.sp
Configuration regarding issued tokens.
.sp
\fBrole_name\fP specifies the role name for minion tokens created. Optional.
.sp
Changed in version 3007.0: This used to be found in \fBrole_name\fP\&.

.sp
If omitted, minion tokens will be created without any role, thus being able
to inherit any master token policy (including token creation capabilities).
.sp
Example configuration:
\fI\%https://www.nomadproject.io/docs/vault\-integration/index.html#vault\-token\-role\-configuration\fP
.sp
\fBparams\fP configures the tokens the master issues to minions.
.sp
Changed in version 3007.0: This used to be found in \fBauth:ttl\fP and \fBauth:uses\fP\&.
The possible parameters were synchronized with the Vault nomenclature:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBttl\fP previously was mapped to \fBexplicit_max_ttl\fP on Vault, not \fBttl\fP\&.
For the same behavior as before, you will need to set \fBexplicit_max_ttl\fP now.
.IP \(bu 2
\fBuses\fP is now called \fBnum_uses\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT

.sp
See the \fI\%Vault token API docs\fP
for details. To make full use of multi\-use tokens, you should configure a cache
that survives a single session (e.g. \fBdisk\fP).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If unset, the master issues single\-use tokens to minions, which can be quite expensive.
.UNINDENT
.UNINDENT
.TP
.B allow_minion_override_params
Changed in version 3007.0: This used to be found in \fBauth:allow_minion_override\fP\&.

.sp
Whether to allow minions to request to override parameters for issuing credentials.
See \fBissue_params\fP below.
.TP
.B wrap
New in version 3007.0.

.sp
The time a minion has to unwrap a wrapped secret issued by the master.
Set this to false to disable wrapping, otherwise a time string like \fB30s\fP
can be used. Defaults to \fB30s\fP\&.
.UNINDENT
.SS \fBkeys\fP
.INDENT 0.0
.INDENT 3.5
List of keys to use to unseal vault server with the \fBvault.unseal\fP runner.
.UNINDENT
.UNINDENT
.SS \fBmetadata\fP
.sp
New in version 3007.0.

.sp
Configures metadata for the issued entities/secrets. Values have to be strings
and can be templated with the following variables:
.INDENT 0.0
.IP \(bu 2
\fB{jid}\fP Salt job ID that issued the secret.
.IP \(bu 2
\fB{minion}\fP The minion ID the secret was issued for.
.IP \(bu 2
\fB{user}\fP The user the Salt daemon issuing the secret was running as.
.IP \(bu 2
\fB{pillar[<var>]}\fP A minion pillar value that does not depend on Vault.
.IP \(bu 2
\fB{grains[<var>]}\fP A minion grain value.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Values have to be strings, hence templated variables that resolve to lists
will be concatenated to a lexicographically sorted comma\-separated list
(Python \fBlist.sort()\fP).
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B entity
Configures the metadata associated with the minion entity inside Vault.
Entities are only created when issuing AppRoles to minions.
.TP
.B secret
Configures the metadata associated with issued tokens/secret IDs. They
are logged in plaintext to the Vault audit log.
.UNINDENT
.SS \fBpolicies\fP
.sp
Changed in version 3007.0: This used to specify the list of policies associated with a minion token only.
The equivalent is found in \fBassign\fP\&.

.INDENT 0.0
.TP
.B assign
List of policies that are assigned to issued minion authentication data,
either token or AppRole.
.sp
They can be static strings or string templates with
.INDENT 7.0
.IP \(bu 2
\fB{minion}\fP The minion ID.
.IP \(bu 2
\fB{pillar[<var>]}\fP A minion pillar value.
.IP \(bu 2
\fB{grains[<var>]}\fP A minion grain value.
.UNINDENT
.sp
For pillar and grain values, lists are expanded, so \fBsalt_role_{pillar[roles]}\fP
with \fB[a, b]\fP results in \fBsalt_role_a\fP and \fBsalt_role_b\fP to be issued.
.sp
Defaults to \fB[saltstack/minions, saltstack/{minion}]\fP\&.
.sp
New in version 3006.0: Policies can be templated with pillar values as well: \fBsalt_role_{pillar[roles]}\fP\&.
Make sure to only reference pillars that are not sourced from Vault since the latter
ones might be unavailable during policy rendering. If you use the Vault
integration in one of your pillar \fBsls\fP files, all values from that file
will be absent during policy rendering, even the ones that do not depend on Vault.

.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
See \fI\%Is Targeting using Grain Data Secure?\fP for important security information. In short,
everything except \fBgrains[id]\fP is minion\-controlled.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
List members which do not have simple string representations,
such as dictionaries or objects, do not work and will
throw an exception. Strings and numbers are examples of
types which work well.
.UNINDENT
.UNINDENT
.TP
.B cache_time
New in version 3007.0.

.sp
Number of seconds compiled templated policies are cached on the master.
This is important when using pillar values in templates, since compiling
the pillar is an expensive operation.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Only effective when issuing tokens to minions. Token policies
need to be compiled every time a token is requested, while AppRole\-associated
policies are written to Vault configuration the first time authentication data
is requested (they can be refreshed on demand by running
\fBsalt\-run vault.sync_approles\fP).
.sp
They will also be refreshed in case other issuance parameters are changed
(such as uses/ttl), either on the master or the minion
(if allow_minion_override_params is True).
.UNINDENT
.UNINDENT
.TP
.B refresh_pillar
New in version 3007.0.

.sp
Whether to refresh the minion pillar when compiling templated policies
that contain pillar variables.
Only effective when issuing tokens to minions (see note on cache_time above).
.INDENT 7.0
.IP \(bu 2
\fBnull\fP (default) only compiles the pillar when no cached pillar is found.
.IP \(bu 2
\fBfalse\fP never compiles the pillar. This means templated policies that
contain pillar values are skipped if no cached pillar is found.
.IP \(bu 2
\fBtrue\fP always compiles the pillar. This can cause additional strain
on the master since the compilation is costly.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Hardcoded to True when issuing AppRoles.
.sp
Using cached pillar data only (refresh_pillar=False) might cause the policies
to be out of sync. If there is no cached pillar data available for the minion,
pillar templates will fail to render at all.
.sp
If you use pillar values for templating policies and do not disable
refreshing pillar data, make sure the relevant values are not sourced
from Vault (ext_pillar, sdb) or from a pillar sls file that uses the vault
execution/sdb module. Although this will often work when cached pillar data is
available, if the master needs to compile the pillar data during policy rendering,
all Vault modules will be broken to prevent an infinite loop.
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fBserver\fP
.sp
Changed in version 3007.0: The values found in here were found in the \fBvault\fP root namespace previously.

.sp
Configures Vault server details.
.INDENT 0.0
.TP
.B url
URL of your Vault installation. Required.
.TP
.B verify
Configures certificate verification behavior when issuing requests to the
Vault server. If unset, requests will use the CA certificates bundled with \fBcertifi\fP\&.
.sp
For details, please see \fI\%the requests documentation\fP\&.
.sp
New in version 2018.3.0.

.sp
Changed in version 3007.0: Minions again respect the master configuration value, which was changed
implicitly in v3001. If this value is set in the minion configuration
as well, it will take precedence.
.sp
In addition, this value can now be set to a PEM\-encoded CA certificate
to use as the sole trust anchor for certificate chain verification.

.TP
.B namespace
Optional Vault namespace. Used with Vault Enterprise.
.sp
For details please see:
\fI\%https://www.vaultproject.io/docs/enterprise/namespaces\fP
.sp
New in version 3004.

.UNINDENT
.sp
Minion configuration (optional):
.SS \fBconfig_location\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
Where to get the connection details for calling vault. By default,
vault will try to determine if it needs to request the connection
details from the master or from the local config. This optional option
will force vault to use the connection details from the master or the
local config. Can only be either \fBmaster\fP or \fBlocal\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 3006.0.

.UNINDENT
.UNINDENT
.SS \fBissue_params\fP
.INDENT 0.0
.INDENT 3.5
Request overrides for token/AppRole issuance. This needs to be allowed
on the master by setting \fBissue:allow_minion_override_params\fP to true.
See the master configuration \fBissue:token:params\fP or \fBissue:approle:params\fP
for reference.
.sp
Changed in version 3007.0: For token issuance, this used to be found in \fBauth:ttl\fP and \fBauth:uses\fP\&.
Mind that the parameter names have been synchronized with Vault, see notes
above (TLDR: \fBttl\fP => \fBexplicit_max_ttl\fP, \fBuses\fP => \fBnum_uses\fP\&.

.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBauth:token_lifecycle\fP and \fBserver:verify\fP can be set on the minion as well.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.clear_cache(connection=True, session=False)
New in version 3007.0.

.sp
Delete Vault caches. Will ensure the current token and associated leases
are revoked by default.
.sp
The cache is organized in a hierarchy: \fB/vault/connection/session/leases\fP\&.
(\fIitalics\fP mark data that is only cached when receiving configuration from a master)
.sp
\fBconnection\fP contains KV metadata (by default), \fIconfiguration\fP and \fI(AppRole) auth credentials\fP\&.
\fBsession\fP contains the currently active token.
\fBleases\fP contains leases issued to the currently active token like database credentials.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.clear_cache
salt \(aq*\(aq vault.clear_cache session=True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B connection
Only clear the cached data scoped to a connection. This includes
configuration, auth credentials, the currently active auth token
as well as leases and KV metadata (by default). Defaults to true.
Set this to false to clear all Vault caches.
.TP
.B session
Only clear the cached data scoped to a session. This only includes
leases and the currently active auth token, but not configuration
or (AppRole) auth credentials. Defaults to false.
Setting this to true will keep the connection cache, regardless
of \fBconnection\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.clear_token_cache()
Changed in version 3001.

.sp
Changed in version 3007.0: This is now an alias for \fBvault.clear_cache\fP with \fBconnection=True\fP\&.

.sp
Delete minion Vault token cache.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.clear_token_cache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.delete_secret(path, *args)
Delete secret at <path>. The vault policy used must allow this.
If <path> is on KV v2, the secret will be soft\-deleted.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.delete_secret \(dqsecret/my/secret\(dq
salt \(aq*\(aq vault.delete_secret \(dqsecret/my/secret\(dq 1 2 3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required policy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
path \(dq<mount>/<secret>\(dq {
    capabilities = [\(dqdelete\(dq]
}

# or KV v2
path \(dq<mount>/data/<secret>\(dq {
    capabilities = [\(dqdelete\(dq]
}

# KV v2 versions
path \(dq<mount>/delete/<secret>\(dq {
    capabilities = [\(dqupdate\(dq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
The path to the secret, including mount.
.UNINDENT
.sp
New in version 3007.0: For KV v2, you can specify versions to soft\-delete as supplemental
positional arguments.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.destroy_secret(path, *args)
New in version 3001.

.sp
Destroy specified secret versions <path>. The vault policy
used must allow this. Only supported on Vault KV version 2.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.destroy_secret \(dqsecret/my/secret\(dq 1 2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required policy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
path \(dq<mount>/destroy/<secret>\(dq {
    capabilities = [\(dqupdate\(dq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
The path to the secret, including mount.
.UNINDENT
.sp
You can specify versions to destroy as supplemental positional arguments.
At least one is required.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.get_server_config()
New in version 3007.0.

.sp
Return the server connection configuration that\(aqs currently in use by Salt.
Contains \fBurl\fP, \fBverify\fP and \fBnamespace\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.get_server_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.list_secrets(path, default=<Constant.NOT_SET>, keys_only=False)
List secret keys at <path>. The vault policy used must allow this.
The path should end with a trailing slash.
.sp
Changed in version 3001: The \fBdefault\fP argument has been added. When the path or path/key
combination is not found, an exception will be raised, unless a default
is provided.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.list_secrets \(dqsecret/my/\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required policy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
path \(dq<mount>/<path>\(dq {
    capabilities = [\(dqlist\(dq]
}

# or KV v2
path \(dq<mount>/metadata/<path>\(dq {
    capabilities = [\(dqlist\(dq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
The path to the secret, including mount.
.TP
.B default
New in version 3001.

.sp
When the path is not found, an exception will be raised, unless a default
is provided here.
.TP
.B keys_only
New in version 3007.0.

.sp
This function used to return a dictionary like \fB{\(dqkeys\(dq: [\(dqsome/\(dq, \(dqsome/key\(dq]}\fP\&.
Setting this to True will only return the list of keys.
For backwards\-compatibility reasons, this defaults to False.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.patch_secret(path, **kwargs)
Patch secret dataset at <path>. Fields are specified as arbitrary keyword arguments.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This works even for older Vault versions, KV v1 and with missing
\fBpatch\fP capability, but will use more than one request to simulate
the functionality by issuing a read and update request.
.sp
For proper, single\-request patching, requires versions of KV v2 that
support the \fBpatch\fP capability and the \fBpatch\fP capability to be available
for the path.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This uses JSON Merge Patch format internally.
Keys set to \fBnull\fP (JSON/YAML)/\fBNone\fP (Python) will be deleted.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.patch_secret \(dqsecret/my/secret\(dq password=\(dqbaz\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required policy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Proper patching
path \(dq<mount>/data/<secret>\(dq {
    capabilities = [\(dqpatch\(dq]
}

# OR (!), for older KV v2 setups:

path \(dq<mount>/data/<secret>\(dq {
    capabilities = [\(dqread\(dq, \(dqupdate\(dq]
}

# OR (!), for KV v1 setups:

path \(dq<mount>/<secret>\(dq {
    capabilities = [\(dqread\(dq, \(dqupdate\(dq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
The path to the secret, including mount.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.policies_list()
New in version 3007.0.

.sp
List all ACL policies.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.policies_list
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required policy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
path \(dqsys/policy\(dq {
    capabilities = [\(dqread\(dq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.policy_delete(policy)
New in version 3007.0.

.sp
Delete an ACL policy. Returns False if the policy did not exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.policy_delete salt_minion
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required policy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
path \(dqsys/policy/<policy>\(dq {
    capabilities = [\(dqdelete\(dq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B policy
The name of the policy to delete.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.policy_fetch(policy)
New in version 3007.0.

.sp
Fetch the rules associated with an ACL policy. Returns None if the policy
does not exist.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.policy_fetch salt_minion
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required policy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
path \(dqsys/policy/<policy>\(dq {
    capabilities = [\(dqread\(dq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B policy
The name of the policy to fetch.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.policy_write(policy, rules)
New in version 3007.0.

.sp
Create or update an ACL policy.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.policy_write salt_minion \(aqpath \(dqsecret/foo\(dq {...}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required policy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
path \(dqsys/policy/<policy>\(dq {
    capabilities = [\(dqcreate\(dq, \(dqupdate\(dq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B policy
The name of the policy to create/update.
.TP
.B rules
Rules to write, formatted as in\-line HCL.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.query(method, endpoint, payload=None)
New in version 3007.0.

.sp
Issue arbitrary queries against the Vault API.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.query GET auth/token/lookup\-self
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required policy: Depends on the query.
.sp
You can ask the vault CLI to output the necessary policy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
vault read \-output\-policy auth/token/lookup\-self
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B method
HTTP method to use.
.TP
.B endpoint
Vault API endpoint to issue the request against. Do not include \fB/v1/\fP\&.
.TP
.B payload
Optional dictionary to use as JSON payload.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.read_secret(path, key=None, metadata=False, default=<Constant.NOT_SET>)
Return the value of <key> at <path> in vault, or entire secret.
.sp
Changed in version 3001: The \fBdefault\fP argument has been added. When the path or path/key
combination is not found, an exception will be raised, unless a default
is provided.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.read_secret salt/kv/secret
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required policy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
path \(dq<mount>/<secret>\(dq {
    capabilities = [\(dqread\(dq]
}

# or KV v2
path \(dq<mount>/data/<secret>\(dq {
    capabilities = [\(dqread\(dq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
The path to the secret, including mount.
.TP
.B key
The data field at <path> to read. If unspecified, returns the
whole dataset.
.TP
.B metadata
New in version 3001.

.sp
If using KV v2 backend, display full results, including metadata.
Defaults to False.
.TP
.B default
New in version 3001.

.sp
When the path or path/key combination is not found, an exception will
be raised, unless a default is provided here.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.update_config(keep_session=False)
New in version 3007.0.

.sp
Attempt to update the cached configuration without clearing the
currently active Vault session.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.update_config
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B keep_session
Only update configuration that can be updated without
creating a new login session.
If this is false, still tries to keep the active session,
but might clear it if the server configuration has changed
significantly.
Defaults to False.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.write_raw(path, raw)
Set raw data at <path>. The vault policy used must allow this.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.write_raw \(dqsecret/my/secret\(dq \(aq{\(dquser\(dq:\(dqfoo\(dq,\(dqpassword\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required policy: see write_secret
.INDENT 7.0
.TP
.B path
The path to the secret, including mount.
.TP
.B raw
Secret data to write to <path>. Has to be a mapping.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vault.write_secret(path, **kwargs)
Set secret dataset at <path>. The vault policy used must allow this.
Fields are specified as arbitrary keyword arguments.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vault.write_secret \(dqsecret/my/secret\(dq user=\(dqfoo\(dq password=\(dqbar\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required policy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
path \(dq<mount>/<secret>\(dq {
    capabilities = [\(dqcreate\(dq, \(dqupdate\(dq]
}

# or KV v2
path \(dq<mount>/data/<secret>\(dq {
    capabilities = [\(dqcreate\(dq, \(dqupdate\(dq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path
The path to the secret, including mount.
.UNINDENT
.UNINDENT
.SS salt.modules.vbox_guest
.sp
VirtualBox Guest Additions installer
.INDENT 0.0
.TP
.B salt.modules.vbox_guest.additions_install(**kwargs)
Install VirtualBox Guest Additions. Uses the CD, connected by VirtualBox.
.sp
To connect VirtualBox Guest Additions via VirtualBox graphical interface
press \(aqHost+D\(aq (\(aqHost\(aq is usually \(aqRight Ctrl\(aq).
.sp
See \fI\%https://www.virtualbox.org/manual/ch04.html#idp52733088\fP for more details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vbox_guest.additions_install
salt \(aq*\(aq vbox_guest.additions_install reboot=True
salt \(aq*\(aq vbox_guest.additions_install upgrade_os=True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBreboot\fP (\fI\%bool\fP) \-\- reboot computer to complete installation
.IP \(bu 2
\fBupgrade_os\fP (\fI\%bool\fP) \-\- upgrade OS (to ensure the latests version of kernel and developer tools are installed)
.UNINDENT
.TP
.B Returns
version of VirtualBox Guest Additions or string with error
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vbox_guest.additions_mount()
Mount VirtualBox Guest Additions CD to the temp directory.
.sp
To connect VirtualBox Guest Additions via VirtualBox graphical interface
press \(aqHost+D\(aq (\(aqHost\(aq is usually \(aqRight Ctrl\(aq).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vbox_guest.additions_mount
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
True or OSError exception
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vbox_guest.additions_remove(**kwargs)
Remove VirtualBox Guest Additions.
.sp
Firstly it tries to uninstall itself by executing
\(aq/opt/VBoxGuestAdditions\-VERSION/uninstall.run uninstall\(aq.
It uses the CD, connected by VirtualBox if it failes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vbox_guest.additions_remove
salt \(aq*\(aq vbox_guest.additions_remove force=True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBforce\fP (\fI\%bool\fP) \-\- force VirtualBox Guest Additions removing
.TP
.B Returns
True if VirtualBox Guest Additions were removed successfully else False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vbox_guest.additions_umount(mount_point)
Unmount VirtualBox Guest Additions CD from the temp directory.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vbox_guest.additions_umount
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBmount_point\fP \-\- directory VirtualBox Guest Additions is mounted to
.TP
.B Returns
True or an string with error
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vbox_guest.additions_version()
Check VirtualBox Guest Additions version.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vbox_guest.additions_version
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
version of VirtualBox Guest Additions or False if they are not installed
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vbox_guest.grant_access_to_shared_folders_to(name, users=None)
Grant access to auto\-mounted shared folders to the users.
.sp
User is specified by its name. To grant access for several users use argument \fIusers\fP\&.
Access will be denied to the users not listed in \fIusers\fP argument.
.sp
See \fI\%https://www.virtualbox.org/manual/ch04.html#sf_mount_auto\fP for more details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vbox_guest.grant_access_to_shared_folders_to fred
salt \(aq*\(aq vbox_guest.grant_access_to_shared_folders_to users [\(aqfred\(aq, \(aqroman\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- name of the user to grant access to auto\-mounted shared folders to
.IP \(bu 2
\fBusers\fP (\fI\%list\fP\fI of \fP\fI\%str\fP) \-\- list of names of users to grant access to auto\-mounted shared folders to (if specified, \fIname\fP will not be taken into account)
.UNINDENT
.TP
.B Returns
list of users who have access to auto\-mounted shared folders
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vbox_guest.list_shared_folders_users()
List users who have access to auto\-mounted shared folders.
.sp
See \fI\%https://www.virtualbox.org/manual/ch04.html#sf_mount_auto\fP for more details.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vbox_guest.list_shared_folders_users
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
list of users who have access to auto\-mounted shared folders
.UNINDENT
.UNINDENT
.SS salt.modules.vboxmanage
.sp
Support for VirtualBox using the VBoxManage command
.sp
New in version 2016.3.0.

.sp
If the \fBvboxdrv\fP kernel module is not loaded, this module can automatically
load it by configuring \fBautoload_vboxdrv\fP in \fB/etc/salt/minion\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
autoload_vboxdrv: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The default for this setting is \fBFalse\fP\&.
.INDENT 0.0
.TP
.B depends
virtualbox
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vboxmanage.clonemedium(medium, uuid_in=None, file_in=None, uuid_out=None, file_out=None, mformat=None, variant=None, existing=False, **kwargs)
Clone a new VM from an existing VM
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqhypervisor\(aq vboxmanage.clonemedium <name> <new_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vboxmanage.clonevm(name=None, uuid=None, new_name=None, snapshot_uuid=None, snapshot_name=None, mode=\(aqmachine\(aq, options=None, basefolder=None, new_uuid=None, register=False, groups=None, **kwargs)
Clone a new VM from an existing VM
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqhypervisor\(aq vboxmanage.clonevm <name> <new_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vboxmanage.create(name, groups=None, ostype=None, register=True, basefolder=None, new_uuid=None, **kwargs)
Create a new VM
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqhypervisor\(aq vboxmanage.create <name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vboxmanage.destroy(name)
Unregister and destroy a VM
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vboxmanage.destroy my_vm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vboxmanage.list_items(item, details=False, group_by=\(aqUUID\(aq)
Return a list of a specific type of item. The following items are available:
.INDENT 7.0
.INDENT 3.5
vms
runningvms
ostypes
hostdvds
hostfloppies
intnets
bridgedifs
hostonlyifs
natnets
dhcpservers
hostinfo
hostcpuids
hddbackends
hdds
dvds
floppies
usbhost
usbfilters
systemproperties
extpacks
groups
webcams
screenshotformats
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqhypervisor\(aq vboxmanage.items <item>
salt \(aqhypervisor\(aq vboxmanage.items <item> details=True
salt \(aqhypervisor\(aq vboxmanage.items <item> details=True group_by=Name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Some items do not display well, or at all, unless \fBdetails\fP is set to
\fBTrue\fP\&. By default, items are grouped by the \fBUUID\fP field, but not all
items contain that field. In those cases, another field must be specified.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vboxmanage.list_nodes()
Return a list of registered VMs
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vboxmanage.list_nodes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vboxmanage.list_nodes_full()
Return a list of registered VMs, with detailed information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vboxmanage.list_nodes_full
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vboxmanage.list_nodes_min()
Return a list of registered VMs, with minimal information
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vboxmanage.list_nodes_min
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vboxmanage.list_ostypes()
List the available OS Types
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vboxmanage.list_ostypes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vboxmanage.register(filename)
Register a VM
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vboxmanage.register my_vm_filename
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vboxmanage.start(name)
Start a VM
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vboxmanage.start my_vm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vboxmanage.stop(name)
Stop a VM
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vboxmanage.stop my_vm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vboxmanage.unregister(name, delete=False)
Unregister a VM
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vboxmanage.unregister my_vm_filename
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vboxmanage.vboxcmd()
Return the location of the VBoxManage command
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vboxmanage.vboxcmd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.vcenter
.sp
Module used to access the vcenter proxy connection methods
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be deprecated in a future release of Salt. VMware strongly
recommends using the
\fI\%VMware Salt extensions\fP
instead of the vCenter module. Because the Salt extensions are newer and
actively supported by VMware, they are more compatible with current versions
of ESXi and they work well with the latest features in the VMware product
line.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vcenter.get_details()
.UNINDENT
.SS salt.modules.victorops
.sp
Support for VictorOps
.sp
New in version 2015.8.0.

.sp
Requires an \fBapi_key\fP in \fB/etc/salt/minion\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
victorops:
  api_key: \(aq280d4699\-a817\-4719\-ba6f\-ca56e573e44f\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.victorops.create_event(message_type=None, routing_key=\(aqeverybody\(aq, **kwargs)
Create an event in VictorOps. Designed for use in states.
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B Parameters
\fBmessage_type\fP \-\- One of the following values: INFO, WARNING, ACKNOWLEDGEMENT, CRITICAL, RECOVERY.
.UNINDENT
.sp
The following parameters are optional:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrouting_key\fP \-\- The key for where messages should be routed. By default, sent to
\(aqeveryone\(aq route.
.IP \(bu 2
\fBentity_id\fP \-\- The name of alerting entity. If not provided, a random name will be assigned.
.IP \(bu 2
\fBtimestamp\fP \-\- Timestamp of the alert in seconds since epoch. Defaults to the
time the alert is received at VictorOps.
.UNINDENT
.UNINDENT
.sp
:param timestamp_fmt            The date format for the timestamp parameter.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstate_start_time\fP \-\- The time this entity entered its current state
(seconds since epoch). Defaults to the time alert is received.
.IP \(bu 2
\fBstate_start_time_fmt\fP \-\- The date format for the timestamp parameter.
.IP \(bu 2
\fBstate_message\fP \-\- Any additional status information from the alert item.
.IP \(bu 2
\fBentity_is_host\fP \-\- Used within VictorOps to select the appropriate
display format for the incident.
.IP \(bu 2
\fBentity_display_name\fP \-\- Used within VictorOps to display a human\-readable name for the entity.
.IP \(bu 2
\fBack_message\fP \-\- A user entered comment for the acknowledgment.
.IP \(bu 2
\fBack_author\fP \-\- The user that acknowledged the incident.
.UNINDENT
.TP
.B Returns
A dictionary with result, entity_id, and message if result was failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion victorops.create_event message_type=\(aqCRITICAL\(aq routing_key=\(aqeveryone\(aq                  entity_id=\(aqhostname/diskspace\(aq

salt myminion victorops.create_event message_type=\(aqACKNOWLEDGEMENT\(aq routing_key=\(aqeveryone\(aq                  entity_id=\(aqhostname/diskspace\(aq ack_message=\(aqAcknowledged\(aq ack_author=\(aqusername\(aq

salt myminion victorops.create_event message_type=\(aqRECOVERY\(aq routing_key=\(aqeveryone\(aq                  entity_id=\(aqhostname/diskspace\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B The following parameters are required:
message_type
.UNINDENT
.UNINDENT
.SS salt.modules.virt
.sp
Work with virtual machines managed by libvirt
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
libvirt Python module
.IP \(bu 2
libvirt client
.IP \(bu 2
qemu\-img
.IP \(bu 2
grep
.UNINDENT
.UNINDENT
.SS Connection
.sp
The connection to the virtualization host can be either setup in the minion configuration,
pillar data or overridden for each individual call.
.sp
By default, the libvirt connection URL will be guessed: the first available libvirt
hypervisor driver will be used. This can be overridden like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
virt:
  connection:
    uri: lxc:///
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the connection requires an authentication like for ESXi, this can be defined in the
minion pillar data like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
virt:
  connection:
    uri: esx://10.1.1.101/?no_verify=1&auto_answer=1
    auth:
      username: user
      password: secret
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Connecting with SSH protocol
.sp
Libvirt can connect to remote hosts using SSH using one of the \fBssh\fP, \fBlibssh\fP and
\fBlibssh2\fP transports. Note that \fBlibssh2\fP is likely to fail as it doesn\(aqt read the
\fBknown_hosts\fP file. Libvirt may also have been built without \fBlibssh\fP or \fBlibssh2\fP
support.
.sp
To use the SSH transport, on the minion setup an SSH agent with a key authorized on
the remote libvirt machine.
.SS Per call connection setup
.sp
New in version 2019.2.0.

.sp
All the calls requiring the libvirt connection configuration as mentioned above can
override this configuration using \fBconnection\fP, \fBusername\fP and \fBpassword\fP parameters.
.sp
This means that the following will list the domains on the local LXC libvirt driver,
whatever the \fBvirt:connection\fP is.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqhypervisor\(aq virt.list_domains connection=lxc:///
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The calls not using the libvirt connection setup are:
.INDENT 0.0
.IP \(bu 2
\fBseed_non_shared_migrate\fP
.IP \(bu 2
\fBvirt_type\fP
.IP \(bu 2
\fBis_*hyper\fP
.IP \(bu 2
all migration functions
.IP \(bu 2
\fI\%libvirt ESX URI format\fP
.IP \(bu 2
\fI\%libvirt URI format\fP
.IP \(bu 2
\fI\%libvirt authentication configuration\fP
.UNINDENT
.SS Units
.sp
Units specification
.sp
New in version 3002.

.sp
The string should contain a number optionally followed
by a unit. The number may have a decimal fraction. If
the unit is not given then MiB are set by default.
Units can optionally be given in IEC style (such as MiB),
although the standard single letter style (such as M) is
more convenient.
.sp
Valid units include:
.TS
center;
|l|l|l|l|l|.
_
T{
Standard
T}	T{
IEC
T}	T{
Standard
T}	T{
IEC
T}	T{
T}
_
T{
Unit
T}	T{
Unit
T}	T{
Name
T}	T{
Name
T}	T{
Factor
T}
_
T{
B
T}	T{
T}	T{
Bytes
T}	T{
T}	T{
1
T}
_
T{
K
T}	T{
KiB
T}	T{
Kilobytes
T}	T{
Kibibytes
T}	T{
2**10
T}
_
T{
M
T}	T{
MiB
T}	T{
Megabytes
T}	T{
Mebibytes
T}	T{
2**20
T}
_
T{
G
T}	T{
GiB
T}	T{
Gigabytes
T}	T{
Gibibytes
T}	T{
2**30
T}
_
T{
T
T}	T{
TiB
T}	T{
Terabytes
T}	T{
Tebibytes
T}	T{
2**40
T}
_
T{
P
T}	T{
PiB
T}	T{
Petabytes
T}	T{
Pebibytes
T}	T{
2**50
T}
_
T{
E
T}	T{
EiB
T}	T{
Exabytes
T}	T{
Exbibytes
T}	T{
2**60
T}
_
T{
Z
T}	T{
ZiB
T}	T{
Zettabytes
T}	T{
Zebibytes
T}	T{
2**70
T}
_
T{
Y
T}	T{
YiB
T}	T{
Yottabytes
T}	T{
Yobibytes
T}	T{
2**80
T}
_
.TE
.sp
Additional decimal based units:
.TS
center;
|l|l|.
_
T{
Unit
T}	T{
Factor
T}
_
T{
KB
T}	T{
10**3
T}
_
T{
MB
T}	T{
10**6
T}
_
T{
GB
T}	T{
10**9
T}
_
T{
TB
T}	T{
10**12
T}
_
T{
PB
T}	T{
10**15
T}
_
T{
EB
T}	T{
10**18
T}
_
T{
ZB
T}	T{
10**21
T}
_
T{
YB
T}	T{
10**24
T}
_
.TE
.INDENT 0.0
.TP
.B salt.modules.virt.all_capabilities(**kwargs)
Return the host and domain capabilities in a single call.
.sp
New in version 3001.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.all_capabilities
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.capabilities(**kwargs)
Return the hypervisor connection capabilities.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.capabilities
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.cpu_baseline(full=False, migratable=False, out=\(aqlibvirt\(aq, **kwargs)
Return the optimal \(aqcustom\(aq CPU baseline config for VM\(aqs on this minion
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfull\fP \-\- Return all CPU features rather than the ones on top of the closest CPU model
.IP \(bu 2
\fBmigratable\fP \-\- Exclude CPU features that are unmigratable (libvirt 2.13+)
.IP \(bu 2
\fBout\fP \-\- \(aqlibvirt\(aq (default) for usable libvirt XML definition, \(aqsalt\(aq for nice dict
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.cpu_baseline
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.create_xml_path(path, **kwargs)
Start a transient domain based on the XML\-file path passed to the function
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP \-\- path to a file containing the libvirt XML definition of the domain
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.create_xml_path <path to XML file on the node>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.create_xml_str(xml, **kwargs)
Start a transient domain based on the XML passed to the function
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBxml\fP \-\- libvirt XML definition of the domain
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.create_xml_str <XML in string format>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.ctrl_alt_del(vm_, **kwargs)
Sends CTRL+ALT+DEL to a VM
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.ctrl_alt_del <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.define_vol_xml_path(path, pool=None, **kwargs)
Define a volume based on the XML\-file path passed to the function
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP \-\- path to a file containing the libvirt XML definition of the volume
.IP \(bu 2
\fBpool\fP \-\-
.sp
storage pool name to define the volume in.
If defined, this parameter will override the configuration setting.
.sp
New in version 3001.


.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.define_vol_xml_path <path to XML file on the node>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.define_vol_xml_str(xml, pool=None, **kwargs)
Define a volume based on the XML passed to the function
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBxml\fP \-\- libvirt XML definition of the storage volume
.IP \(bu 2
\fBpool\fP \-\-
.sp
storage pool name to define the volume in.
If defined, this parameter will override the configuration setting.
.sp
New in version 3001.


.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.define_vol_xml_str <XML in string format>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The storage pool where the disk image will be defined is \fBdefault\fP
unless changed with the pool parameter or a configuration like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
virt:
    storagepool: mine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.define_xml_path(path, **kwargs)
Define a persistent domain based on the XML\-file path passed to the function
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP \-\- path to a file containing the libvirt XML definition of the domain
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.define_xml_path <path to XML file on the node>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.define_xml_str(xml, **kwargs)
Define a persistent domain based on the XML passed to the function
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBxml\fP \-\- libvirt XML definition of the domain
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.define_xml_str <XML in string format>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.delete_snapshots(name, *names, **kwargs)
Delete one or more snapshots of the given VM.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- domain name
.IP \(bu 2
\fBnames\fP \-\- names of the snapshots to remove
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.delete_snapshots <domain> all=True
salt \(aq*\(aq virt.delete_snapshots <domain> <snapshot>
salt \(aq*\(aq virt.delete_snapshots <domain> <snapshot1> <snapshot2> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.domain_capabilities(emulator=None, arch=None, machine=None, domain=None, **kwargs)
Return the domain capabilities given an emulator, architecture, machine or virtualization type.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBemulator\fP \-\- return the capabilities for the given emulator binary
.IP \(bu 2
\fBarch\fP \-\- return the capabilities for the given CPU architecture
.IP \(bu 2
\fBmachine\fP \-\- return the capabilities for the given emulated machine type
.IP \(bu 2
\fBdomain\fP \-\- return the capabilities for the given virtualization type.
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
The list of the possible emulator, arch, machine and domain can be found in
the host capabilities output.
.sp
If none of the parameters is provided, the libvirt default one is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.domain_capabilities arch=\(aqx86_64\(aq domain=\(aqkvm\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.freecpu(**kwargs)
Return an int representing the number of unallocated cpus on this
hypervisor
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.freecpu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.freemem(**kwargs)
Return an int representing the amount of memory (in MB) that has not
been given to virtual machines on this node
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.freemem
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.full_info(**kwargs)
Return the node_info, vm_info and freemem
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.full_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.get_disks(vm_, **kwargs)
Return the disks of a named vm
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- name of the domain
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.get_disks <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.get_graphics(vm_, **kwargs)
Returns the information on vnc for a given vm
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- name of the domain
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.get_graphics <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.get_hypervisor()
Returns the name of the hypervisor running on this node or \fBNone\fP\&.
.sp
Detected hypervisors:
.INDENT 7.0
.IP \(bu 2
kvm
.IP \(bu 2
xen
.IP \(bu 2
bhyve
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.get_hypervisor
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0: the function and the \fBkvm\fP, \fBxen\fP and \fBbhyve\fP hypervisors support

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.get_loader(vm_, **kwargs)
Returns the information on the loader for a given vm
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- name of the domain
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.get_loader <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.get_macs(vm_, **kwargs)
Return a list off MAC addresses from the named vm
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- name of the domain
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.get_macs <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.get_nics(vm_, **kwargs)
Return info about the network interfaces of a named vm
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- name of the domain
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.get_nics <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.get_profiles(hypervisor=None, **kwargs)
Return the virt profiles for hypervisor.
.sp
Currently there are profiles for:
.INDENT 7.0
.IP \(bu 2
nic
.IP \(bu 2
disk
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhypervisor\fP \-\- override the default machine type.
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.get_profiles
salt \(aq*\(aq virt.get_profiles hypervisor=vmware
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.get_xml(vm_, **kwargs)
Returns the XML for a given vm
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.get_xml <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.init(name, cpu, mem, nic=\(aqdefault\(aq, interfaces=None, hypervisor=None, start=True, disk=\(aqdefault\(aq, disks=None, saltenv=\(aqbase\(aq, seed=True, install=True, pub_key=None, priv_key=None, seed_cmd=\(aqseed.apply\(aq, graphics=None, os_type=None, arch=None, boot=None, boot_dev=None, numatune=None, hypervisor_features=None, clock=None, serials=None, consoles=None, stop_on_reboot=False, host_devices=None, **kwargs)
Initialize a new vm
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name of the virtual machine to create
.IP \(bu 2
\fBcpu\fP \-\-
.sp
Number of virtual CPUs to assign to the virtual machine or a dictionary with detailed information to configure
cpu model and topology, numa node tuning, cpu tuning and iothreads allocation. The structure of the dictionary is
documented in \fI\%cpu parameters definition\fP\&.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
cpu:
  placement: static
  cpuset: 0\-11
  current: 5
  maximum: 12
  vcpus:
    0:
      enabled: True
      hotpluggable: False
      order: 1
    1:
      enabled: False
      hotpluggable: True
  match: minimum
  mode: custom
  check: full
  vendor: Intel
  model:
    name: core2duo
    fallback: allow
    vendor_id: GenuineIntel
  topology:
    sockets: 1
    cores: 12
    threads: 1
  cache:
    level: 3
    mode: emulate
  features:
    lahf: optional
    pcid: require
  numa:
    0:
       cpus: 0\-3
       memory: 1g
       discard: True
       distances:
         0: 10     # sibling id : value
         1: 21
         2: 31
         3: 41
    1:
       cpus: 4\-6
       memory: 1g
       memAccess: shared
       distances:
         0: 21
         1: 10
         2: 21
         3: 31
  tuning:
       vcpupin:
         0: 1\-4,^2  # vcpuid : cpuset
         1: 0,1
         2: 2,3
         3: 0,4
       emulatorpin: 1\-3
       iothreadpin:
         1: 5,6    # iothread id: cpuset
         2: 7,8
       shares: 2048
       period: 1000000
       quota: \-1
       global_period: 1000000
       global_quota: \-1
       emulator_period: 1000000
       emulator_quota: \-1
       iothread_period: 1000000
       iothread_quota: \-1
       vcpusched:
         \- scheduler: fifo
           priority: 1
           vcpus: 0,3\-5
         \- scheduler: rr
           priority: 3
       iothreadsched:
         \- scheduler: idle
         \- scheduler: batch
           iothreads: 2,3
       emulatorsched:
         \- scheduler: batch
       cachetune:
         0\-3:      # vcpus set
           0:      # cache id
             level: 3
             type: both
             size: 4
           1:
             level: 3
             type: both
             size: 6
           monitor:
             1: 3
             0\-3: 3
         4\-5:
           monitor:
             4: 3  # vcpus: level
             5: 3
       memorytune:
         0\-3:      # vcpus set
           0: 60   # node id: bandwidth
         4\-5:
           0: 60
  iothreads: 4
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBmem\fP \-\-
.sp
Amount of memory to allocate to the virtual machine in MiB. Since 3002, a dictionary can be used to
contain detailed configuration which support memory allocation or tuning. Supported parameters are \fBboot\fP,
\fBcurrent\fP, \fBmax\fP, \fBslots\fP, \fBhard_limit\fP, \fBsoft_limit\fP, \fBswap_hard_limit\fP, \fBmin_guarantee\fP,
\fBhugepages\fP ,  \fBnosharepages\fP, \fBlocked\fP, \fBsource\fP, \fBaccess\fP, \fBallocation\fP and \fBdiscard\fP\&. The structure
of the dictionary is documented in  \fI\%Memory parameter definition\fP\&. Both decimal and binary base are supported. Detail unit
specification is documented  in \fI\%Units specification\fP\&. Please note that the value for \fBslots\fP must be an integer.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqboot\(aq: 1g,
    \(aqcurrent\(aq: 1g,
    \(aqmax\(aq: 1g,
    \(aqslots\(aq: 10,
    \(aqhard_limit\(aq: \(aq1024\(aq,
    \(aqsoft_limit\(aq: \(aq512m\(aq,
    \(aqswap_hard_limit\(aq: \(aq1g\(aq,
    \(aqmin_guarantee\(aq: \(aq512mib\(aq,
    \(aqhugepages\(aq: [{\(aqnodeset\(aq: \(aq0\-3,^2\(aq, \(aqsize\(aq: \(aq1g\(aq}, {\(aqnodeset\(aq: \(aq2\(aq, \(aqsize\(aq: \(aq2m\(aq}],
    \(aqnosharepages\(aq: True,
    \(aqlocked\(aq: True,
    \(aqsource\(aq: \(aqfile\(aq,
    \(aqaccess\(aq: \(aqshared\(aq,
    \(aqallocation\(aq: \(aqimmediate\(aq,
    \(aqdiscard\(aq: True
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3002.


.IP \(bu 2
\fBnic\fP \-\- NIC profile to use (Default: \fB\(aqdefault\(aq\fP).
The profile interfaces can be customized / extended with the interfaces parameter.
If set to \fBNone\fP, no profile will be used.
.IP \(bu 2
\fBinterfaces\fP \-\-
.sp
List of dictionaries providing details on the network interfaces to create.
These data are merged with the ones from the nic profile. The structure of
each dictionary is documented in \fI\%Network Interfaces Definitions\fP\&.
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBhypervisor\fP \-\- the virtual machine type. By default the value will be computed according
to the virtual host capabilities.
.IP \(bu 2
\fBstart\fP \-\- \fBTrue\fP to start the virtual machine after having defined it (Default: \fBTrue\fP)
.IP \(bu 2
\fBdisk\fP \-\- Disk profile to use (Default: \fB\(aqdefault\(aq\fP). If set to \fBNone\fP, no profile will be used.
.IP \(bu 2
\fBdisks\fP \-\-
.sp
List of dictionaries providing details on the disk devices to create.
These data are merged with the ones from the disk profile. The structure of
each dictionary is documented in \fI\%Disks Definitions\fP\&.
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBsaltenv\fP \-\- Fileserver environment (Default: \fB\(aqbase\(aq\fP).
See \fI\%cp module for more details\fP
.IP \(bu 2
\fBseed\fP \-\- \fBTrue\fP to seed the disk image. Only used when the \fBimage\fP parameter is provided.
(Default: \fBTrue\fP)
.IP \(bu 2
\fBinstall\fP \-\- install salt minion if absent (Default: \fBTrue\fP)
.IP \(bu 2
\fBpub_key\fP \-\- public key to seed with (Default: \fBNone\fP)
.IP \(bu 2
\fBpriv_key\fP \-\- public key to seed with (Default: \fBNone\fP)
.IP \(bu 2
\fBseed_cmd\fP \-\- Salt command to execute to seed the image. (Default: \fB\(aqseed.apply\(aq\fP)
.IP \(bu 2
\fBgraphics\fP \-\-
.sp
Dictionary providing details on the graphics device to create. (Default: \fBNone\fP)
See \fI\%Graphics Definition\fP for more details on the possible values.
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBos_type\fP \-\-
.sp
type of virtualization as found in the \fB//os/type\fP element of the libvirt definition.
The default value is taken from the host capabilities, with a preference for \fBhvm\fP\&.
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBarch\fP \-\-
.sp
architecture of the virtual machine. The default value is taken from the host capabilities,
but \fBx86_64\fP is prefed over \fBi686\fP\&.
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBconfig\fP \-\- minion configuration to use when seeding.
See \fI\%seed module for more details\fP
.IP \(bu 2
\fBboot_dev\fP \-\- String of space\-separated devices to boot from (Default: \fB\(aqhd\(aq\fP)
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBstop_on_reboot\fP \-\-
.sp
If set to \fBTrue\fP the guest will stop instead of rebooting.
This is specially useful when creating a virtual machine with an installation cdrom or
an autoinstallation needing a special first boot configuration.
Defaults to \fBFalse\fP
.sp
New in version 3003.


.IP \(bu 2
\fBboot\fP \-\-
.sp
Specifies kernel, initial ramdisk and kernel command line parameters for the virtual machine.
This is an optional parameter, all of the keys are optional within the dictionary. The structure of
the dictionary is documented in \fI\%Boot parameters definition\fP\&. If a remote path is provided to kernel or initrd,
salt will handle the downloading of the specified remote file and modify the XML accordingly.
To boot VM with UEFI, specify loader and nvram path or specify \(aqefi\(aq: \fBTrue\fP if your libvirtd version
is >= 5.2.0 and QEMU >= 3.0.0.
.sp
New in version 3000.

.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqkernel\(aq: \(aq/root/f8\-i386\-vmlinuz\(aq,
    \(aqinitrd\(aq: \(aq/root/f8\-i386\-initrd\(aq,
    \(aqcmdline\(aq: \(aqconsole=ttyS0 ks=http://example.com/f8\-i386/os/\(aq,
    \(aqloader\(aq: \(aq/usr/share/OVMF/OVMF_CODE.fd\(aq,
    \(aqnvram\(aq: \(aq/usr/share/OVMF/OVMF_VARS.ms.fd\(aq
}
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBboot_dev\fP \-\-
.sp
Space separated list of devices to boot from sorted by decreasing priority.
Values can be \fBhd\fP, \fBfd\fP, \fBcdrom\fP or \fBnetwork\fP\&.
.sp
By default, the value will \fB\(dqhd\(dq\fP\&.

.IP \(bu 2
\fBnumatune\fP \-\-
.sp
The optional numatune element provides details of how to tune the performance of a NUMA host via controlling NUMA
policy for domain process. The optional \fBmemory\fP element specifies how to allocate memory for the domain process
on a NUMA host. \fBmemnode\fP elements can specify memory allocation policies per each guest NUMA node. The definition
used in the dictionary can be found at \fI\%cpu parameters definition\fP\&.
.sp
New in version 3003.

.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqmemory\(aq: {\(aqmode\(aq: \(aqstrict\(aq, \(aqnodeset\(aq: \(aq0\-11\(aq},
    \(aqmemnodes\(aq: {0: {\(aqmode\(aq: \(aqstrict\(aq, \(aqnodeset\(aq: 1}, 1: {\(aqmode\(aq: \(aqpreferred\(aq, \(aqnodeset\(aq: 2}}
}
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBhypervisor_features\fP \-\-
.sp
Enable or disable hypervisor\-specific features on the virtual machine.
.sp
New in version 3003.

.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
hypervisor_features:
  kvm\-hint\-dedicated: True
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBclock\fP \-\-
.sp
Configure the guest clock.
The value is a dictionary with the following keys:
.INDENT 2.0
.TP
.B adjustment
time adjustment in seconds or \fBreset\fP
.TP
.B utc
set to \fBFalse\fP to use the host local time as the guest clock. Defaults to \fBTrue\fP\&.
.TP
.B timezone
synchronize the guest to the correspding timezone
.TP
.B timers
a dictionary associating the timer name with its configuration.
This configuration is a dictionary with the properties \fBtrack\fP, \fBtickpolicy\fP,
\fBcatchup\fP, \fBfrequency\fP, \fBmode\fP, \fBpresent\fP, \fBslew\fP, \fBthreshold\fP and \fBlimit\fP\&.
See \fI\%libvirt time keeping documentation\fP for the possible values.
.UNINDENT
.sp
New in version 3003.

.sp
Set the clock to local time using an offset in seconds
\&.. code\-block:: yaml
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B clock:
adjustment: 3600
utc: False
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Set the clock to a specific time zone:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
clock:
  timezone: CEST
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Tweak guest timers:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
clock:
  timers:
    tsc:
      frequency: 3504000000
      mode: native
    rtc:
      track: wall
      tickpolicy: catchup
      slew: 4636
      threshold: 123
      limit: 2342
    hpet:
      present: False
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBserials\fP \-\-
.sp
Dictionary providing details on the serials connection to create. (Default: \fBNone\fP)
See \fI\%Serials and Consoles Definitions\fP for more details on the possible values.
.sp
New in version 3003.


.IP \(bu 2
\fBconsoles\fP \-\-
.sp
Dictionary providing details on the consoles device to create. (Default: \fBNone\fP)
See \fI\%Serials and Consoles Definitions\fP for more details on the possible values.
.sp
New in version 3003.


.IP \(bu 2
\fBhost_devices\fP \-\-
.sp
List of host devices to passthrough to the guest.
The value is a list of device names as provided by the \fI\%node_devices()\fP function.
(Default: \fBNone\fP)
.sp
New in version 3003.


.UNINDENT
.UNINDENT
.sp
cpu parameters definition
.sp
The cpu parameters dictionary can contain the following properties:
.INDENT 7.0
.TP
.B cpuset
a comma\-separated list of physical CPU numbers that domain process and virtual CPUs can be pinned to by default.
eg. \fB1\-4,^3\fP cpuset 3 is excluded.
.TP
.B current
the number of virtual cpus available at startup
.TP
.B placement
indicate the CPU placement mode for domain process. the value can be either \fBstatic\fP or \fBauto\fP
.TP
.B vcpus
specify the state of individual vcpu. Possible attribute for each individual vcpu include: \fBid\fP, \fBenabled\fP,
\fBhotpluggable\fP and \fBorder\fP\&. Valid \fBids\fP are from 0 to the maximum vCPU count minus 1. \fBenabled\fP takes
boolean values which controls the state of the vcpu. \fBhotpluggable\fP take boolean value which controls whether
given vCPU can be hotplugged and hotunplugged. \fBorder\fP takes an integer value which specifies the order to add
the online vCPUs.
.TP
.B match
The cpu attribute \fBmatch\fP attribute specifies how strictly the virtual CPU provided to the guest matches the CPU
requirements, possible values are \fBminimum\fP, \fBexact\fP or \fBstrict\fP\&.
.TP
.B check
Optional cpu attribute \fBcheck\fP attribute can be used to request a specific way of checking whether the virtual
CPU matches the specification, possible values are \fBnone\fP, \fBpartial\fP and \fBfull\fP\&.
.TP
.B mode
Optional cpu attribute \fBmode\fP attribute may be used to make it easier to configure a guest CPU to be as close
to host CPU as possible, possible values are \fBcustom\fP, \fBhost\-model\fP and \fBhost\-passthrough\fP\&.
.TP
.B model
specifies CPU model requested by the guest. An optional \fBfallback\fP attribute can be used to forbid libvirt falls
back to the closest model supported by the hypervisor, possible values are \fBallow\fP or \fBforbid\fP\&. \fBvendor_id\fP
attribute can be used to set the vendor id seen by the guest, the length must be exactly 12 characters long.
.TP
.B vendor
specifies CPU vendor requested by the guest.
.TP
.B topology
specifies requested topology of virtual CPU provided to the guest. Four possible attributes , \fBsockets\fP, \fBdies\fP,
\fBcores\fP, and \fBthreads\fP, accept non\-zero positive integer values. They refer to the number of CPU sockets per
NUMA node, number of dies per socket, number of cores per die, and number of threads per core, respectively.
.TP
.B features
A dictionary contains a set of cpu features to fine\-tune features provided by the selected CPU model. Use cpu
feature \fBname\fP as the key and the \fBpolicy\fP as the value. \fBpolicy\fP Attribute takes \fBforce\fP, \fBrequire\fP,
\fBoptional\fP, \fBdisable\fP or \fBforbid\fP\&.
.TP
.B cache
describes the virtual CPU cache. Optional attribute \fBlevel\fP takes an integer value which describes cache level
\fBmode\fP attribute supported three possible values: \fBemulate\fP, \fBpassthrough\fP, \fBdisable\fP
.TP
.B numa
specify the guest numa topology. \fBcell\fP element specifies a NUMA cell or a NUMA node, \fBcpus\fP specifies the
CPU or range of CPUs that are part of the node, \fBmemory\fP specifies the size of the node memory. All cells
should have \fBid\fP attribute in case referring to some cell is necessary in the code. optional attribute
\fBmemAccess\fP control whether the memory is to be mapped as \fBshared\fP or \fBprivate\fP, \fBdiscard\fP attribute which
fine tunes the discard feature for given numa node, possible values are \fBTrue\fP or \fBFalse\fP\&.  \fBdistances\fP
element define the distance between NUMA cells and \fBsibling\fP sub\-element is used to specify the distance value
between sibling NUMA cells.
.TP
.B vcpupin
The optional vcpupin element specifies which of host\(aqs physical CPUs the domain vCPU will be pinned to.
.TP
.B emulatorpin
The optional emulatorpin element specifies which of host physical CPUs the \(dqemulator\(dq, a subset of a domain not
including vCPU or iothreads will be pinned to.
.TP
.B iothreadpin
The optional iothreadpin element specifies which of host physical CPUs the IOThreads will be pinned to.
.TP
.B shares
The optional shares element specifies the proportional weighted share for the domain.
.TP
.B period
The optional period element specifies the enforcement interval (unit: microseconds).
.TP
.B quota
The optional quota element specifies the maximum allowed bandwidth (unit: microseconds).
.TP
.B global_period
The optional global_period element specifies the enforcement CFS scheduler interval (unit: microseconds) for the
whole domain in contrast with period which enforces the interval per vCPU.
.TP
.B global_quota
The optional global_quota element specifies the maximum allowed bandwidth (unit: microseconds) within a period
for the whole domain.
.TP
.B emulator_period
The optional emulator_period element specifies the enforcement interval (unit: microseconds).
.TP
.B emulator_quota
The optional emulator_quota element specifies the maximum allowed bandwidth (unit: microseconds) for domain\(aqs
emulator threads (those excluding vCPUs).
.TP
.B iothread_period
The optional iothread_period element specifies the enforcement interval (unit: microseconds) for IOThreads.
.TP
.B iothread_quota
The optional iothread_quota element specifies the maximum allowed bandwidth (unit: microseconds) for IOThreads.
.TP
.B vcpusched
specify the scheduler type for vCPUs.
The value is a list of dictionaries with the \fBscheduler\fP key (values \fBbatch\fP, \fBidle\fP, \fBfifo\fP, \fBrr\fP)
and the optional \fBpriority\fP and \fBvcpus\fP keys. The \fBpriority\fP value usually is a positive integer and the
\fBvcpus\fP value is a cpu set like \fB1\-4,^3,6\fP or simply the vcpu id.
.TP
.B iothreadsched
specify the scheduler type for IO threads.
The value is a list of dictionaries with the \fBscheduler\fP key (values \fBbatch\fP, \fBidle\fP, \fBfifo\fP, \fBrr\fP)
and the optional \fBpriority\fP and \fBvcpus\fP keys. The \fBpriority\fP value usually is a positive integer and the
\fBvcpus\fP value is a cpu set like \fB1\-4,^3,6\fP or simply the vcpu id.
.TP
.B emulatorsched
specify the scheduler type (values batch, idle, fifo, rr) for particular the emulator.
The value is a dictionary with the \fBscheduler\fP key (values \fBbatch\fP, \fBidle\fP, \fBfifo\fP, \fBrr\fP)
and the optional \fBpriority\fP and \fBvcpus\fP keys. The \fBpriority\fP value usually is a positive integer.
.TP
.B cachetune
Optional cachetune element can control allocations for CPU caches using the resctrl on the host.
.TP
.B monitor
The optional element monitor creates the cache monitor(s) for current cache allocation.
.TP
.B memorytune
Optional memorytune element can control allocations for memory bandwidth using the resctrl on the host.
.TP
.B iothreads
Number of threads for supported disk devices to perform I/O requests. iothread id will be numbered from 1 to
the provided number (Default: None).
.UNINDENT
.sp
Boot parameters definition
.sp
The boot parameters dictionary can contains the following properties:
.INDENT 7.0
.TP
.B kernel
The URL or path to the kernel to run the virtual machine with.
.TP
.B initrd
The URL or path to the initrd file to run the virtual machine with.
.TP
.B cmdline
The parameters to pass to the kernel provided in the \fIkernel\fP property.
.TP
.B loader
The path to the UEFI binary loader to use.
.sp
New in version 3001.

.TP
.B nvram
The path to the UEFI data template. The file will be copied when creating the virtual machine.
.sp
New in version 3001.

.TP
.B efi
A boolean value.
.sp
New in version 3001.

.UNINDENT
.sp
Memory parameter definition
.sp
Memory parameter can contain the following properties:
.INDENT 7.0
.TP
.B boot
The maximum allocation of memory for the guest at boot time
.TP
.B current
The actual allocation of memory for the guest
.TP
.B max
The run time maximum memory allocation of the guest
.TP
.B slots
specifies the number of slots available for adding memory to the guest
.TP
.B hard_limit
the maximum memory the guest can use
.TP
.B soft_limit
memory limit to enforce during memory contention
.TP
.B swap_hard_limit
the maximum memory plus swap the guest can use
.TP
.B min_guarantee
the guaranteed minimum memory allocation for the guest
.TP
.B hugepages
memory allocated using \fBhugepages\fP instead of the normal native page size. It takes a list of
dictionaries with \fBnodeset\fP and \fBsize\fP keys.
For example \fB\(dqhugepages\(dq: [{\(dqnodeset\(dq: \(dq1\-4,^3\(dq, \(dqsize\(dq: \(dq2m\(dq}, {\(dqnodeset\(dq: \(dq3\(dq, \(dqsize\(dq: \(dq1g\(dq}]\fP\&.
.TP
.B nosharepages
boolean value to instruct hypervisor to disable shared pages (memory merge, KSM) for this domain
.TP
.B locked
boolean value that allows memory pages belonging to the domain will be locked in host\(aqs memory and the host will
not be allowed to swap them out, which might be required for some workloads such as real\-time.
.TP
.B source
possible values are \fBfile\fP which utilizes file memorybacking, \fBanonymous\fP by default and \fBmemfd\fP backing.
(QEMU/KVM only)
.TP
.B access
specify if the memory is to be \fBshared\fP or \fBprivate\fP\&. This can be overridden per numa node by memAccess.
.TP
.B allocation
specify when to allocate the memory by supplying either \fBimmediate\fP or \fBondemand\fP\&.
.TP
.B discard
boolean value to ensure the memory content is discarded just before guest shuts down (or when DIMM module is
unplugged). Please note that this is just an optimization and is not guaranteed to work in all cases
(e.g. when hypervisor crashes). (QEMU/KVM only)
.UNINDENT
.sp
Network Interfaces Definitions
.sp
Network interfaces dictionaries can contain the following properties:
.INDENT 7.0
.TP
.B name
Name of the network interface. This is only used as a key to merge with the profile data
.TP
.B type
Network type. One of \fB\(aqbridge\(aq\fP, \fB\(aqnetwork\(aq\fP
.TP
.B source
The network source, typically the bridge or network name
.TP
.B mac
The desired mac address, computed if \fBNone\fP (Default: \fBNone\fP).
.TP
.B model
The network card model (Default: depends on the hypervisor)
.UNINDENT
.sp
Disks Definitions
.sp
Disk dictionaries can contain the following properties:
.INDENT 7.0
.TP
.B name
Name of the disk. This is mostly used in the name of the disk image and as a key to merge
with the profile data.
.TP
.B format
Format of the disk image, like \fB\(aqqcow2\(aq\fP, \fB\(aqraw\(aq\fP, \fB\(aqvmdk\(aq\fP\&.
(Default: depends on the hypervisor)
.TP
.B size
Disk size in MiB
.TP
.B pool
Path to the folder or name of the pool where disks should be created.
(Default: depends on hypervisor and the virt:storagepool configuration)
.sp
Changed in version 3001.

.sp
If the value contains no \(aq/\(aq, it is considered a pool name where to create a volume.
Using volumes will be mandatory for some pools types like rdb, iscsi, etc.
.TP
.B model
One of the disk busses allowed by libvirt (Default: depends on hypervisor)
.sp
See the libvirt \fI\%disk element\fP documentation for the allowed bus types.
.TP
.B image
Path to the image to use for the disk. If no image is provided, an empty disk will be created
(Default: \fBNone\fP)
.sp
Note that some pool types do not support uploading an image. This list can evolve with libvirt
versions.
.TP
.B overlay_image
\fBTrue\fP to create a QCOW2 disk image with \fBimage\fP as backing file. If \fBFalse\fP
the file pointed to by the \fBimage\fP property will simply be copied. (Default: \fBFalse\fP)
.sp
Changed in version 3001.

.sp
This property is only valid on path\-based disks, not on volumes. To create a volume with a
backing store, set the \fBbacking_store_path\fP and \fBbacking_store_format\fP properties.
.TP
.B backing_store_path
Path to the backing store image to use. This can also be the name of a volume to use as
backing store within the same pool.
.sp
New in version 3001.

.TP
.B backing_store_format
Image format of the disk or volume to use as backing store. This property is mandatory when
using \fBbacking_store_path\fP to avoid \fI\%problems\fP
.sp
New in version 3001.

.TP
.B source_file
Absolute path to the disk image to use. Not to be confused with \fBimage\fP parameter. This
parameter is useful to use disk images that are created outside of this module. Can also
be \fBNone\fP for devices that have no associated image like cdroms.
.sp
Changed in version 3001.

.sp
For volume disks, this can be the name of a volume already existing in the storage pool.
.TP
.B device
Type of device of the disk. Can be one of \(aqdisk\(aq, \(aqcdrom\(aq, \(aqfloppy\(aq or \(aqlun\(aq.
(Default: \fB\(aqdisk\(aq\fP)
.TP
.B hostname_property
When using ZFS volumes, setting this value to a ZFS property ID will make Salt store the name of the
virtual machine inside this property. (Default: \fBNone\fP)
.TP
.B sparse_volume
Boolean to specify whether to use a thin provisioned ZFS volume.
.sp
Example profile for a bhyve VM with two ZFS disks. The first is
cloned from the specified image. The second disk is a thin
provisioned volume.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
virt:
  disk:
    two_zvols:
      \- system:
          image: zroot/bhyve/CentOS\-7\-x86_64\-v1@v1.0.5
          hostname_property: virt:hostname
          pool: zroot/bhyve/guests
      \- data:
          pool: tank/disks
          size: 20G
          hostname_property: virt:hostname
          sparse_volume: True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B io
I/O control policy. String value amongst \fBnative\fP, \fBthreads\fP and \fBio_uring\fP\&.
(Default: \fBnative\fP)
.sp
New in version 3003.

.TP
.B iothread_id
I/O thread id to assign the disk to.
(Default: none assigned)
.sp
New in version 3003.

.UNINDENT
.sp
Graphics Definition
.sp
The graphics dictionary can have the following properties:
.INDENT 7.0
.TP
.B type
Graphics type. The possible values are \fBnone\fP, \fB\(aqspice\(aq\fP, \fB\(aqvnc\(aq\fP and other values
allowed as a libvirt graphics type (Default: \fBNone\fP)
.sp
See the libvirt \fI\%graphics element\fP documentation for more details on the possible types.
.TP
.B port
Port to export the graphics on for \fBvnc\fP, \fBspice\fP and \fBrdp\fP types.
.TP
.B tls_port
Port to export the graphics over a secured connection for \fBspice\fP type.
.TP
.B listen
Dictionary defining on what address to listen on for \fBvnc\fP, \fBspice\fP and \fBrdp\fP\&.
It has a \fBtype\fP property with \fBaddress\fP and \fBNone\fP as possible values, and an
\fBaddress\fP property holding the IP or hostname to listen on.
.sp
By default, not setting the \fBlisten\fP part of the dictionary will default to
listen on all addresses.
.UNINDENT
.sp
Serials and Consoles Definitions
.sp
Serial dictionaries can contain the following properties:
.INDENT 7.0
.TP
.B type
Type of the serial connection, like \fB\(aqtcp\(aq\fP, \fB\(aqpty\(aq\fP, \fB\(aqfile\(aq\fP, \fB\(aqudp\(aq\fP, \fB\(aqdev\(aq\fP,
\fB\(aqpipe\(aq\fP, \fB\(aqunix\(aq\fP\&.
.TP
.B path
Path to the source device. Can be a log file, a host character device to pass through,
a unix socket, a named pipe path.
.TP
.B host
The serial UDP or TCP host name.
(Default: 23023)
.TP
.B port
The serial UDP or TCP port number.
(Default: 23023)
.TP
.B protocol
Name of the TCP connection protocol.
(Default: telnet)
.TP
.B tls
Boolean value indicating whether to use hypervisor TLS certificates environment for TCP devices.
.TP
.B target_port
The guest device port number starting from 0
.TP
.B target_type
The guest device type. Common values are \fBserial\fP, \fBvirtio\fP or \fBusb\-serial\fP, but more are documented in
\fI\%the libvirt documentation\fP\&.
.UNINDENT
.sp
CLI Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqhypervisor\(aq virt.init vm_name 4 512 salt://path/to/image.raw
salt \(aqhypervisor\(aq virt.init vm_name 4 512 /var/lib/libvirt/images/img.raw
salt \(aqhypervisor\(aq virt.init vm_name 4 512 nic=profile disk=profile
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The disk images will be created in an image folder within the directory
defined by the \fBvirt:images\fP option. Its default value is
\fB/srv/salt\-images/\fP but this can changed with such a configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
virt:
    images: /data/my/vm/images/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.is_hyper()
Returns a bool whether or not this node is a hypervisor of any kind
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.is_hyper
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.list_active_vms(**kwargs)
Return a list of names for active virtual machine on the minion
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.list_active_vms
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.list_domains(**kwargs)
Return a list of available domains.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.list_domains
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.list_inactive_vms(**kwargs)
Return a list of names for inactive virtual machine on the minion
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.list_inactive_vms
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.list_networks(**kwargs)
List all virtual networks.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.list_networks
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.list_pools(**kwargs)
List all storage pools.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.list_pools
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.list_snapshots(domain=None, **kwargs)
List available snapshots for certain vm or for all.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdomain\fP \-\- domain name
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.list_snapshots
salt \(aq*\(aq virt.list_snapshots <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.migrate(vm_, target, **kwargs)
Shared storage migration
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBtarget\fP \-\- target libvirt URI or host name
.IP \(bu 2
\fBkwargs\fP \-\- .INDENT 2.0
.IP \(bu 2
live:            Use live migration. Default value is True.
.IP \(bu 2
.INDENT 2.0
.TP
.B persistent:      Leave the domain persistent on destination host.
Default value is True.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B undefinesource:  Undefine the domain on the source host.
Default value is True.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B offline:         If set to True it will migrate the domain definition
without starting the domain on destination and without
stopping it on source host. Default value is False.
.UNINDENT
.IP \(bu 2
max_bandwidth:   The maximum bandwidth (in MiB/s) that will be used.
.IP \(bu 2
.INDENT 2.0
.TP
.B max_downtime:    Set maximum tolerable downtime for live\-migration.
The value represents a number of milliseconds the guest
is allowed to be down at the end of live migration.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B parallel_connections: Specify a number of parallel network connections
to be used to send memory pages to the destination host.
.UNINDENT
.IP \(bu 2
compressed:      Activate compression.
.IP \(bu 2
.INDENT 2.0
.TP
.B comp_methods:    A comma\-separated list of compression methods. Supported
methods are \(dqmt\(dq and \(dqxbzrle\(dq and can be  used in any
combination. QEMU defaults to \(dqxbzrle\(dq.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B comp_mt_level:   Set compression level. Values are in range from 0 to 9,
where 1 is maximum speed and 9 is  maximum compression.
.UNINDENT
.IP \(bu 2
comp_mt_threads: Set number of compress threads on source host.
.IP \(bu 2
comp_mt_dthreads: Set number of decompress threads on target host.
.IP \(bu 2
comp_xbzrle_cache: Set the size of page cache for xbzrle compression in bytes.
.IP \(bu 2
.INDENT 2.0
.TP
.B copy_storage:    Migrate non\-shared storage. It must be one of the following
values: all (full disk copy) or incremental (Incremental copy)
.UNINDENT
.IP \(bu 2
postcopy:        Enable the use of post\-copy migration.
.IP \(bu 2
postcopy_bandwidth: The maximum bandwidth allowed in post\-copy phase. (MiB/s)
.IP \(bu 2
username:        Username to connect with target host
.IP \(bu 2
password:        Password to connect with target host
.UNINDENT
.sp
New in version 3002.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.migrate <domain> <target hypervisor URI>
salt src virt.migrate guest qemu+ssh://dst/system
salt src virt.migrate guest qemu+tls://dst/system
salt src virt.migrate guest qemu+tcp://dst/system
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A tunnel data migration can be performed by setting this in the
configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
virt:
    tunnel: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For more details on tunnelled data migrations, report to
\fI\%https://libvirt.org/migration.html#transporttunnel\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.migrate_start_postcopy(vm_)
Starts post\-copy migration. This function has to be called
while live migration is in progress and it has been initiated
with the \fIpostcopy=True\fP option.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.migrate_start_postcopy <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.nesthash(value=None)
create default dict that allows arbitrary level of nesting
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.network_define(name, bridge, forward, ipv4_config=None, ipv6_config=None, vport=None, tag=None, autostart=True, start=True, mtu=None, domain=None, nat=None, interfaces=None, addresses=None, physical_function=None, dns=None, **kwargs)
Create libvirt network.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Network name.
.IP \(bu 2
\fBbridge\fP \-\- Bridge name.
.IP \(bu 2
\fBforward\fP \-\-
.sp
Forward mode (bridge, router, nat).
.sp
Changed in version 3003: a \fBNone\fP value creates an isolated network with no forwarding at all


.IP \(bu 2
\fBvport\fP \-\-
.sp
Virtualport type.
The value can also be a dictionary with \fBtype\fP and \fBparameters\fP keys.
The \fBparameters\fP value is a dictionary of virtual port parameters.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- vport:
    type: openvswitch
    parameters:
      interfaceid: 09b11c53\-8b5c\-4eeb\-8f00\-d84eaa0aaa4f
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3003: possible dictionary value


.IP \(bu 2
\fBtag\fP \-\-
.sp
Vlan tag.
The value can also be a dictionary with the \fBtags\fP and optional \fBtrunk\fP keys.
\fBtrunk\fP is a boolean value indicating whether to use VLAN trunking.
\fBtags\fP is a list of dictionaries with keys \fBid\fP and \fBnativeMode\fP\&.
The \fBnativeMode\fP value can be one of \fBtagged\fP or \fBuntagged\fP\&.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- tag:
    trunk: True
    tags:
      \- id: 42
        nativeMode: untagged
      \- id: 47
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3003: possible dictionary value


.IP \(bu 2
\fBautostart\fP \-\- Network autostart (default True).
.IP \(bu 2
\fBstart\fP \-\- Network start (default True).
.IP \(bu 2
\fBipv4_config\fP (\fI\%dict\fP\fI or \fP\fINone\fP) \-\-
.sp
IP v4 configuration.
Dictionary describing the IP v4 setup like IP range and
a possible DHCP configuration. The structure is documented
in \fI\%net\-define\-ip\fP\&.
.sp
New in version 3000.


.IP \(bu 2
\fBipv6_config\fP (\fI\%dict\fP\fI or \fP\fINone\fP) \-\-
.sp
IP v6 configuration.
Dictionary describing the IP v6 setup like IP range and
a possible DHCP configuration. The structure is documented
in \fI\%net\-define\-ip\fP\&.
.sp
New in version 3000.


.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults.
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults.
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults.
.IP \(bu 2
\fBmtu\fP \-\-
.sp
size of the Maximum Transmission Unit (MTU) of the network.
(default \fBNone\fP)
.sp
New in version 3003.


.IP \(bu 2
\fBdomain\fP \-\-
.sp
DNS domain name of the DHCP server.
The value is a dictionary with a mandatory \fBname\fP property and an optional \fBlocalOnly\fP boolean one.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- domain:
    name: lab.acme.org
    localOnly: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBnat\fP \-\-
.sp
addresses and ports to route in NAT forward mode.
The value is a dictionary with optional keys \fBaddress\fP and \fBport\fP\&.
Both values are a dictionary with \fBstart\fP and \fBend\fP values.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: nat
\- nat:
    address:
      start: 1.2.3.4
      end: 1.2.3.10
    port:
      start: 500
      end: 1000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBinterfaces\fP \-\-
.sp
whitespace separated list of network interfaces devices that can be used for this network.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: passthrough
\- interfaces: \(dqeth10 eth11 eth12\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBaddresses\fP \-\-
.sp
whitespace separated list of addresses of PCI devices that can be used for this network in \fIhostdev\fP forward mode.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: hostdev
\- interfaces: \(dq0000:04:00.1 0000:e3:01.2\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBphysical_function\fP \-\-
.sp
device name of the physical interface to use in \fBhostdev\fP forward mode.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: hostdev
\- physical_function: \(dqeth0\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBdns\fP \-\-
.sp
virtual network DNS configuration.
The value is a dictionary described in \fI\%net\-define\-dns\fP\&.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- dns:
    forwarders:
      \- domain: example.com
        addr: 192.168.1.1
      \- addr: 8.8.8.8
      \- domain: www.example.com
    txt:
      example.com: \(dqv=spf1 a \-all\(dq
      _http.tcp.example.com: \(dqname=value,paper=A4\(dq
    hosts:
      192.168.1.2:
        \- mirror.acme.lab
        \- test.acme.lab
    srvs:
      \- name: ldap
        protocol: tcp
        domain: ldapserver.example.com
        target: .
        port: 389
        priority: 1
        weight: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.UNINDENT
.UNINDENT
.sp
IP configuration definition
.sp
Both the IPv4 and IPv6 configuration dictionaries can contain the following properties:
.INDENT 7.0
.TP
.B cidr
CIDR notation for the network. For example \(aq192.168.124.0/24\(aq
.TP
.B dhcp_ranges
A list of dictionaries with \fB\(aqstart\(aq\fP and \fB\(aqend\(aq\fP properties.
.TP
.B hosts
A list of dictionaries with \fBip\fP property and optional \fBname\fP, \fBmac\fP and \fBid\fP properties.
.sp
New in version 3003.

.TP
.B bootp
A dictionary with a \fBfile\fP property and an optional \fBserver\fP one.
.sp
New in version 3003.

.TP
.B tftp
The path to the TFTP root directory to serve.
.sp
New in version 3003.

.UNINDENT
.sp
DNS configuration definition
.sp
The DNS configuration dictionary contains the following optional properties:
.INDENT 7.0
.TP
.B forwarders
List of alternate DNS forwarders to use.
Each item is a dictionary with the optional \fBdomain\fP and \fBaddr\fP keys.
If both are provided, the requests to the domain are forwarded to the server at the \fBaddr\fP\&.
If only \fBdomain\fP is provided the requests matching this domain will be resolved locally.
If only \fBaddr\fP is provided all requests will be forwarded to this DNS server.
.TP
.B txt:
Dictionary of TXT fields to set.
.TP
.B hosts:
Dictionary of host DNS entries.
The key is the IP of the host, and the value is a list of hostnames for it.
.TP
.B srvs:
List of SRV DNS entries.
Each entry is a dictionary with the mandatory \fBname\fP and \fBprotocol\fP keys.
Entries can also have \fBtarget\fP, \fBport\fP, \fBpriority\fP, \fBdomain\fP and \fBweight\fP optional properties.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.network_define network main bridge openvswitch
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.network_get_xml(name, **kwargs)
Return the XML definition of a virtual network
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- libvirt network name
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.network_get_xml default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.network_info(name=None, **kwargs)
Return information on a virtual network provided its name.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- virtual network name
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
If no name is provided, return the infos for all defined virtual networks.
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.network_info default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.network_set_autostart(name, state=\(aqon\(aq, **kwargs)
Set the autostart flag on a virtual network so that the network
will start with the host system on reboot.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- virtual network name
.IP \(bu 2
\fBstate\fP \-\- \(aqon\(aq to auto start the network, anything else to mark the
virtual network not to be started when the host boots
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq virt.network_set_autostart <pool> <on | off>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.network_start(name, **kwargs)
Start a defined virtual network.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- virtual network name
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.network_start default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.network_stop(name, **kwargs)
Stop a defined virtual network.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- virtual network name
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.network_stop default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.network_undefine(name, **kwargs)
Remove a defined virtual network. This does not stop the virtual network.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- virtual network name
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.network_undefine default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.network_update(name, bridge, forward, ipv4_config=None, ipv6_config=None, vport=None, tag=None, mtu=None, domain=None, nat=None, interfaces=None, addresses=None, physical_function=None, dns=None, test=False, **kwargs)
Update a virtual network if needed.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Network name.
.IP \(bu 2
\fBbridge\fP \-\- Bridge name.
.IP \(bu 2
\fBforward\fP \-\- Forward mode (bridge, router, nat).
A \fBNone\fP value creates an isolated network with no forwarding at all.
.IP \(bu 2
\fBvport\fP \-\-
.sp
Virtualport type.
The value can also be a dictionary with \fBtype\fP and \fBparameters\fP keys.
The \fBparameters\fP value is a dictionary of virtual port parameters.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- vport:
    type: openvswitch
    parameters:
      interfaceid: 09b11c53\-8b5c\-4eeb\-8f00\-d84eaa0aaa4f
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBtag\fP \-\-
.sp
Vlan tag.
The value can also be a dictionary with the \fBtags\fP and optional \fBtrunk\fP keys.
\fBtrunk\fP is a boolean value indicating whether to use VLAN trunking.
\fBtags\fP is a list of dictionaries with keys \fBid\fP and \fBnativeMode\fP\&.
The \fBnativeMode\fP value can be one of \fBtagged\fP or \fBuntagged\fP\&.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- tag:
    trunk: True
    tags:
      \- id: 42
        nativeMode: untagged
      \- id: 47
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBipv4_config\fP (\fI\%dict\fP\fI or \fP\fINone\fP) \-\- IP v4 configuration.
Dictionary describing the IP v4 setup like IP range and
a possible DHCP configuration. The structure is documented
in \fI\%net\-define\-ip\fP\&.
.IP \(bu 2
\fBipv6_config\fP (\fI\%dict\fP\fI or \fP\fINone\fP) \-\- IP v6 configuration.
Dictionary describing the IP v6 setup like IP range and
a possible DHCP configuration. The structure is documented
in \fI\%net\-define\-ip\fP\&.
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults.
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults.
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults.
.IP \(bu 2
\fBmtu\fP \-\- size of the Maximum Transmission Unit (MTU) of the network.
(default \fBNone\fP)
.IP \(bu 2
\fBdomain\fP \-\-
.sp
DNS domain name of the DHCP server.
The value is a dictionary with a mandatory \fBname\fP property and an optional \fBlocalOnly\fP boolean one.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- domain:
    name: lab.acme.org
    localOnly: True
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBnat\fP \-\-
.sp
addresses and ports to route in NAT forward mode.
The value is a dictionary with optional keys \fBaddress\fP and \fBport\fP\&.
Both values are a dictionary with \fBstart\fP and \fBend\fP values.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: nat
\- nat:
    address:
      start: 1.2.3.4
      end: 1.2.3.10
    port:
      start: 500
      end: 1000
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBinterfaces\fP \-\-
.sp
whitespace separated list of network interfaces devices that can be used for this network.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: passthrough
\- interfaces: \(dqeth10 eth11 eth12\(dq
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBaddresses\fP \-\-
.sp
whitespace separated list of addresses of PCI devices that can be used for this network in \fIhostdev\fP forward mode.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: hostdev
\- interfaces: \(dq0000:04:00.1 0000:e3:01.2\(dq
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBphysical_function\fP \-\-
.sp
device name of the physical interface to use in \fBhostdev\fP forward mode.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: hostdev
\- physical_function: \(dqeth0\(dq
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBdns\fP \-\-
.sp
virtual network DNS configuration.
The value is a dictionary described in \fI\%net\-define\-dns\fP\&.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- dns:
    forwarders:
      \- domain: example.com
        addr: 192.168.1.1
      \- addr: 8.8.8.8
      \- domain: www.example.com
    txt:
      example.com: \(dqv=spf1 a \-all\(dq
      _http.tcp.example.com: \(dqname=value,paper=A4\(dq
    hosts:
      192.168.1.2:
        \- mirror.acme.lab
        \- test.acme.lab
    srvs:
      \- name: ldap
        protocol: tcp
        domain: ldapserver.example.com
        target: .
        port: 389
        priority: 1
        weight: 10
.ft P
.fi
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
New in version 3003.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.node_devices(**kwargs)
List the host available devices.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 3003.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.node_info(**kwargs)
Return a dict with information about this node
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.node_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.pause(vm_, **kwargs)
Pause the named vm
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.pause <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.pool_build(name, **kwargs)
Build a defined libvirt storage pool.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- libvirt storage pool name
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.pool_build default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.pool_capabilities(**kwargs)
Return the hypervisor connection storage pool capabilities.
.sp
The returned data are either directly extracted from libvirt or computed.
In the latter case some pool types could be listed as supported while they
are not. To distinguish between the two cases, check the value of the \fBcomputed\fP property.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.pool_capabilities
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.pool_define(name, ptype, target=None, permissions=None, source_devices=None, source_dir=None, source_initiator=None, source_adapter=None, source_hosts=None, source_auth=None, source_name=None, source_format=None, transient=False, start=True, **kwargs)
Create libvirt pool.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Pool name
.IP \(bu 2
\fBptype\fP \-\- Pool type. See \fI\%libvirt documentation\fP  for the
possible values.
.IP \(bu 2
\fBtarget\fP \-\- Pool full path target
.IP \(bu 2
\fBpermissions\fP \-\- Permissions to set on the target folder. This is mostly used for filesystem\-based
pool types. See \fI\%Permissions definition\fP for more details on this structure.
.IP \(bu 2
\fBsource_devices\fP \-\-
.sp
List of source devices for pools backed by physical devices. (Default: \fBNone\fP)
.sp
Each item in the list is a dictionary with \fBpath\fP and optionally \fBpart_separator\fP
keys. The path is the qualified name for iSCSI devices.
.sp
Report to \fI\%this libvirt page\fP
for more information on the use of \fBpart_separator\fP

.IP \(bu 2
\fBsource_dir\fP \-\- Path to the source directory for pools of type \fBdir\fP, \fBnetfs\fP or \fBgluster\fP\&.
(Default: \fBNone\fP)
.IP \(bu 2
\fBsource_initiator\fP \-\-
.sp
Initiator IQN for libiscsi\-direct pool types. (Default: \fBNone\fP)
.sp
New in version 3000.


.IP \(bu 2
\fBsource_adapter\fP \-\-
.sp
SCSI source definition. The value is a dictionary with \fBtype\fP, \fBname\fP, \fBparent\fP,
\fBmanaged\fP, \fBparent_wwnn\fP, \fBparent_wwpn\fP, \fBparent_fabric_wwn\fP, \fBwwnn\fP, \fBwwpn\fP
and \fBparent_address\fP keys.
.sp
The \fBparent_address\fP value is a dictionary with \fBunique_id\fP and \fBaddress\fP keys.
The address represents a PCI address and is itself a dictionary with \fBdomain\fP, \fBbus\fP,
\fBslot\fP and \fBfunction\fP properties.
Report to \fI\%this libvirt page\fP
for the meaning and possible values of these properties.

.IP \(bu 2
\fBsource_hosts\fP \-\- List of source for pools backed by storage from remote servers. Each item is the hostname
optionally followed by the port separated by a colon. (Default: \fBNone\fP)
.IP \(bu 2
\fBsource_auth\fP \-\-
.sp
Source authentication details. (Default: \fBNone\fP)
.sp
The value is a dictionary with \fBtype\fP, \fBusername\fP and \fBsecret\fP keys. The type
can be one of \fBceph\fP for Ceph RBD or \fBchap\fP for iSCSI sources.
.sp
The \fBsecret\fP value links to a libvirt secret object. It is a dictionary with
\fBtype\fP and \fBvalue\fP keys. The type value can be either \fBuuid\fP or \fBusage\fP\&.
.sp
Examples:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
source_auth={
    \(aqtype\(aq: \(aqceph\(aq,
    \(aqusername\(aq: \(aqadmin\(aq,
    \(aqsecret\(aq: {
        \(aqtype\(aq: \(aquuid\(aq,
        \(aqvalue\(aq: \(aq2ec115d7\-3a88\-3ceb\-bc12\-0ac909a6fd87\(aq
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
source_auth={
    \(aqtype\(aq: \(aqchap\(aq,
    \(aqusername\(aq: \(aqmyname\(aq,
    \(aqsecret\(aq: {
        \(aqtype\(aq: \(aqusage\(aq,
        \(aqvalue\(aq: \(aqmycluster_myname\(aq
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Since 3000, instead the source authentication can only contain \fBusername\fP
and \fBpassword\fP properties. In this case the libvirt secret will be defined and used.
For Ceph authentications a base64 encoded key is expected.

.IP \(bu 2
\fBsource_name\fP \-\- Identifier of name\-based sources.
.IP \(bu 2
\fBsource_format\fP \-\-
.sp
String representing the source format. The possible values are depending on the
source type. See \fI\%libvirt documentation\fP for
the possible values.

.IP \(bu 2
\fBstart\fP \-\- Pool start (default True)
.IP \(bu 2
\fBtransient\fP \-\- When \fBTrue\fP, the pool will be automatically undefined after being stopped.
Note that a transient pool will force \fBstart\fP to \fBTrue\fP\&. (Default: \fBFalse\fP)
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
Permissions definition
.sp
The permissions are described by a dictionary containing the following keys:
.INDENT 7.0
.TP
.B mode
The octal representation of the permissions. (Default: \fI0711\fP)
.TP
.B owner
the numeric user ID of the owner. (Default: from the parent folder)
.TP
.B group
the numeric ID of the group. (Default: from the parent folder)
.TP
.B label
the SELinux label. (Default: \fINone\fP)
.UNINDENT
.sp
CLI Example:
.sp
Local folder pool:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.pool_define somepool dir target=/srv/mypool                                   permissions=\(dq{\(aqmode\(aq: \(aq0744\(aq \(aqower\(aq: 107, \(aqgroup\(aq: 107 }\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CIFS backed pool:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.pool_define myshare netfs source_format=cifs                                   source_dir=samba_share source_hosts=\(dq[\(aqexample.com\(aq]\(dq target=/mnt/cifs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.pool_delete(name, **kwargs)
Delete the resources of a defined libvirt storage pool.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- libvirt storage pool name
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.pool_delete default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.pool_get_xml(name, **kwargs)
Return the XML definition of a virtual storage pool
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- libvirt storage pool name
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.pool_get_xml default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.pool_info(name=None, **kwargs)
Return information on a storage pool provided its name.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- libvirt storage pool name
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
If no name is provided, return the infos for all defined storage pools.
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.pool_info default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.pool_list_volumes(name, **kwargs)
List the volumes contained in a defined libvirt storage pool.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- libvirt storage pool name
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq virt.pool_list_volumes <pool>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.pool_refresh(name, **kwargs)
Refresh a defined libvirt storage pool.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- libvirt storage pool name
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.pool_refresh default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.pool_set_autostart(name, state=\(aqon\(aq, **kwargs)
Set the autostart flag on a libvirt storage pool so that the storage pool
will start with the host system on reboot.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- libvirt storage pool name
.IP \(bu 2
\fBstate\fP \-\- \(aqon\(aq to auto start the pool, anything else to mark the
pool not to be started when the host boots
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq virt.pool_set_autostart <pool> <on | off>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.pool_start(name, **kwargs)
Start a defined libvirt storage pool.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- libvirt storage pool name
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.pool_start default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.pool_stop(name, **kwargs)
Stop a defined libvirt storage pool.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- libvirt storage pool name
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.pool_stop default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.pool_undefine(name, **kwargs)
Remove a defined libvirt storage pool. The pool needs to be stopped before calling.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- libvirt storage pool name
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.pool_undefine default
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.pool_update(name, ptype, target=None, permissions=None, source_devices=None, source_dir=None, source_initiator=None, source_adapter=None, source_hosts=None, source_auth=None, source_name=None, source_format=None, test=False, **kwargs)
Update a libvirt storage pool if needed.
If called with test=True, this is also reporting whether an update would be performed.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Pool name
.IP \(bu 2
\fBptype\fP \-\-
.sp
Pool type. See \fI\%libvirt documentation\fP  for the
possible values.

.IP \(bu 2
\fBtarget\fP \-\- Pool full path target
.IP \(bu 2
\fBpermissions\fP \-\- Permissions to set on the target folder. This is mostly used for filesystem\-based
pool types. See \fI\%Permissions definition\fP for more details on this structure.
.IP \(bu 2
\fBsource_devices\fP \-\-
.sp
List of source devices for pools backed by physical devices. (Default: \fBNone\fP)
.sp
Each item in the list is a dictionary with \fBpath\fP and optionally \fBpart_separator\fP
keys. The path is the qualified name for iSCSI devices.
.sp
Report to \fI\%this libvirt page\fP
for more information on the use of \fBpart_separator\fP

.IP \(bu 2
\fBsource_dir\fP \-\- Path to the source directory for pools of type \fBdir\fP, \fBnetfs\fP or \fBgluster\fP\&.
(Default: \fBNone\fP)
.IP \(bu 2
\fBsource_initiator\fP \-\-
.sp
Initiator IQN for libiscsi\-direct pool types. (Default: \fBNone\fP)
.sp
New in version 3000.


.IP \(bu 2
\fBsource_adapter\fP \-\-
.sp
SCSI source definition. The value is a dictionary with \fBtype\fP, \fBname\fP, \fBparent\fP,
\fBmanaged\fP, \fBparent_wwnn\fP, \fBparent_wwpn\fP, \fBparent_fabric_wwn\fP, \fBwwnn\fP, \fBwwpn\fP
and \fBparent_address\fP keys.
.sp
The \fBparent_address\fP value is a dictionary with \fBunique_id\fP and \fBaddress\fP keys.
The address represents a PCI address and is itself a dictionary with \fBdomain\fP, \fBbus\fP,
\fBslot\fP and \fBfunction\fP properties.
Report to \fI\%this libvirt page\fP
for the meaning and possible values of these properties.

.IP \(bu 2
\fBsource_hosts\fP \-\- List of source for pools backed by storage from remote servers. Each item is the hostname
optionally followed by the port separated by a colon. (Default: \fBNone\fP)
.IP \(bu 2
\fBsource_auth\fP \-\-
.sp
Source authentication details. (Default: \fBNone\fP)
.sp
The value is a dictionary with \fBtype\fP, \fBusername\fP and \fBsecret\fP keys. The type
can be one of \fBceph\fP for Ceph RBD or \fBchap\fP for iSCSI sources.
.sp
The \fBsecret\fP value links to a libvirt secret object. It is a dictionary with
\fBtype\fP and \fBvalue\fP keys. The type value can be either \fBuuid\fP or \fBusage\fP\&.
.sp
Examples:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
source_auth={
    \(aqtype\(aq: \(aqceph\(aq,
    \(aqusername\(aq: \(aqadmin\(aq,
    \(aqsecret\(aq: {
        \(aqtype\(aq: \(aquuid\(aq,
        \(aquuid\(aq: \(aq2ec115d7\-3a88\-3ceb\-bc12\-0ac909a6fd87\(aq
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
source_auth={
    \(aqtype\(aq: \(aqchap\(aq,
    \(aqusername\(aq: \(aqmyname\(aq,
    \(aqsecret\(aq: {
        \(aqtype\(aq: \(aqusage\(aq,
        \(aquuid\(aq: \(aqmycluster_myname\(aq
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Since 3000, instead the source authentication can only contain \fBusername\fP
and \fBpassword\fP properties. In this case the libvirt secret will be defined and used.
For Ceph authentications a base64 encoded key is expected.

.IP \(bu 2
\fBsource_name\fP \-\- Identifier of name\-based sources.
.IP \(bu 2
\fBsource_format\fP \-\-
.sp
String representing the source format. The possible values are depending on the
source type. See \fI\%libvirt documentation\fP for
the possible values.

.IP \(bu 2
\fBtest\fP \-\- run in dry\-run mode if set to True
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
Example:
.sp
Local folder pool:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.pool_update somepool dir target=/srv/mypool                                   permissions=\(dq{\(aqmode\(aq: \(aq0744\(aq \(aqower\(aq: 107, \(aqgroup\(aq: 107 }\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CIFS backed pool:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.pool_update myshare netfs source_format=cifs                                   source_dir=samba_share source_hosts=\(dq[\(aqexample.com\(aq]\(dq target=/mnt/cifs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.purge(vm_, dirs=False, removables=False, **kwargs)
Recursively destroy and delete a persistent virtual machine, pass True for
dir\(aqs to also delete the directories containing the virtual machine disk
images \- USE WITH EXTREME CAUTION!
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBdirs\fP \-\- pass True to remove containing directories
.IP \(bu 2
\fBremovables\fP \-\-
.sp
pass True to remove removable devices
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.purge <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.reboot(name, **kwargs)
Reboot a domain via ACPI request
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.reboot <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.reset(vm_, **kwargs)
Reset a VM by emulating the reset button on a physical machine
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.reset <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.resume(vm_, **kwargs)
Resume the named vm
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.resume <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.revert_snapshot(name, vm_snapshot=None, cleanup=False, **kwargs)
Revert snapshot to the previous from current (if available) or to the specific.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- domain name
.IP \(bu 2
\fBvm_snapshot\fP \-\- name of the snapshot to revert
.IP \(bu 2
\fBcleanup\fP \-\- Remove all newer than reverted snapshots. Values: True or False (default False).
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.revert <domain>
salt \(aq*\(aq virt.revert <domain> <snapshot>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.seed_non_shared_migrate(disks, force=False)
Non shared migration requires that the disks be present on the migration
destination, pass the disks information via this function, to the
migration destination before executing the migration.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdisks\fP \-\- the list of disk data as provided by virt.get_disks
.IP \(bu 2
\fBforce\fP \-\- skip checking the compatibility of source and target disk
images if True. (default: False)
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.seed_non_shared_migrate <disks>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.set_autostart(vm_, state=\(aqon\(aq, **kwargs)
Set the autostart flag on a VM so that the VM will start with the host
system on reboot.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBstate\fP \-\- \(aqon\(aq to auto start the VM, \(aqoff\(aq to mark the VM not to be
started when the host boots
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq virt.set_autostart <domain> <on | off>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.setmem(vm_, memory, config=False, **kwargs)
Changes the amount of memory allocated to VM. The VM must be shutdown
for this to work.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- name of the domain
.IP \(bu 2
\fBmemory\fP \-\- memory amount to set in MB
.IP \(bu 2
\fBconfig\fP \-\- if True then libvirt will be asked to modify the config as well
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.setmem <domain> <size>
salt \(aq*\(aq virt.setmem my_domain 768
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.setvcpus(vm_, vcpus, config=False, **kwargs)
Changes the amount of vcpus allocated to VM. The VM must be shutdown
for this to work.
.sp
If config is True then we ask libvirt to modify the config as well
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- name of the domain
.IP \(bu 2
\fBvcpus\fP \-\- integer representing the number of CPUs to be assigned
.IP \(bu 2
\fBconfig\fP \-\- if True then libvirt will be asked to modify the config as well
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.setvcpus <domain> <amount>
salt \(aq*\(aq virt.setvcpus my_domain 4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.shutdown(vm_, **kwargs)
Send a soft shutdown signal to the named vm
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.shutdown <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.snapshot(domain, name=None, suffix=None, **kwargs)
Create a snapshot of a VM.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdomain\fP \-\- domain name
.IP \(bu 2
\fBname\fP \-\- Name of the snapshot. If the name is omitted, then will be used original domain
name with ISO 8601 time as a suffix.
.IP \(bu 2
\fBsuffix\fP \-\- Add suffix for the new name. Useful in states, where such snapshots
can be distinguished from manually created.
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.snapshot <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.start(name, **kwargs)
Start a defined domain
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.start <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.stop(name, **kwargs)
Hard power down the virtual machine, this is equivalent to pulling the power.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.stop <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.undefine(vm_, **kwargs)
Remove a defined vm, this does not purge the virtual machine image, and
this only works if the vm is powered down
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.undefine <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.update(name, cpu=0, mem=0, disk_profile=None, disks=None, nic_profile=None, interfaces=None, graphics=None, live=True, boot=None, numatune=None, test=False, boot_dev=None, hypervisor_features=None, clock=None, serials=None, consoles=None, stop_on_reboot=False, host_devices=None, autostart=False, **kwargs)
Update the definition of an existing domain.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Name of the domain to update
.IP \(bu 2
\fBcpu\fP \-\-
.sp
Number of virtual CPUs to assign to the virtual machine or a dictionary with detailed information to configure
cpu model and topology, numa node tuning, cpu tuning and iothreads allocation. The structure of the dictionary is
documented in \fI\%cpu parameters definition\fP\&.
.sp
To update any cpu parameters specify the new values to the corresponding tag. To remove any element or attribute,
specify \fBNone\fP object. Please note that \fBNone\fP object is mapped to \fBnull\fP in yaml, use \fBnull\fP in sls file
instead.

.IP \(bu 2
\fBmem\fP \-\-
.sp
Amount of memory to allocate to the virtual machine in MiB. Since 3002, a dictionary can be used to
contain detailed configuration which support memory allocation or tuning. Supported parameters are \fBboot\fP,
\fBcurrent\fP, \fBmax\fP, \fBslots\fP, \fBhard_limit\fP, \fBsoft_limit\fP, \fBswap_hard_limit\fP, \fBmin_guarantee\fP,
\fBhugepages\fP ,  \fBnosharepages\fP, \fBlocked\fP, \fBsource\fP, \fBaccess\fP, \fBallocation\fP and \fBdiscard\fP\&. The structure
of the dictionary is documented in  \fI\%Memory parameter definition\fP\&. Both decimal and binary base are supported. Detail unit
specification is documented  in \fI\%Units specification\fP\&. Please note that the value for \fBslots\fP must be an integer.
.sp
To remove any parameters, pass a None object, for instance: \(aqsoft_limit\(aq: \fBNone\fP\&. Please note  that \fBNone\fP
is mapped to \fBnull\fP in sls file, pass \fBnull\fP in sls file instead.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- mem:
    hard_limit: null
    soft_limit: null
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3002.


.IP \(bu 2
\fBdisk_profile\fP \-\- disk profile to use
.IP \(bu 2
\fBdisks\fP \-\- Disk definitions as documented in the \fI\%init()\fP function.
If neither the profile nor this parameter are defined, the disk devices
will not be changed. However to clear disks set this parameter to empty list.
.IP \(bu 2
\fBnic_profile\fP \-\- network interfaces profile to use
.IP \(bu 2
\fBinterfaces\fP \-\- Network interface definitions as documented in the \fI\%init()\fP function.
If neither the profile nor this parameter are defined, the interface devices
will not be changed. However to clear network interfaces set this parameter
to empty list.
.IP \(bu 2
\fBgraphics\fP \-\- The new graphics definition as defined in \fI\%Graphics Definition\fP\&. If not set,
the graphics will not be changed. To remove a graphics device, set this parameter
to \fB{\(aqtype\(aq: \(aqnone\(aq}\fP\&.
.IP \(bu 2
\fBlive\fP \-\- \fBFalse\fP to avoid trying to live update the definition. In such a case, the
new definition is applied at the next start of the virtual machine. If \fBTrue\fP,
not all aspects of the definition can be live updated, but as much as possible
will be attempted. (Default: \fBTrue\fP)
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.IP \(bu 2
\fBboot\fP \-\-
.sp
Specifies kernel, initial ramdisk and kernel command line parameters for the virtual machine.
This is an optional parameter, all of the keys are optional within the dictionary.
.sp
Refer to \fI\%Boot parameters definition\fP for the complete boot parameter description.
.sp
To update any boot parameters, specify the new path for each. To remove any boot parameters, pass \fBNone\fP object,
for instance: \(aqkernel\(aq: \fBNone\fP\&. To switch back to BIOS boot, specify (\(aqloader\(aq: \fBNone\fP and \(aqnvram\(aq: \fBNone\fP)
or \(aqefi\(aq: \fBFalse\fP\&. Please note that \fBNone\fP is mapped to \fBnull\fP in sls file, pass \fBnull\fP in sls file instead.
.sp
SLS file Example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- boot:
    loader: null
    nvram: null
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3000.


.IP \(bu 2
\fBboot_dev\fP \-\-
.sp
Space separated list of devices to boot from sorted by decreasing priority.
Values can be \fBhd\fP, \fBfd\fP, \fBcdrom\fP or \fBnetwork\fP\&.
.sp
By default, the value will \fB\(dqhd\(dq\fP\&.
.sp
New in version 3002.


.IP \(bu 2
\fBnumatune\fP \-\-
.sp
The optional numatune element provides details of how to tune the performance of a NUMA host via controlling NUMA
policy for domain process. The optional \fBmemory\fP element specifies how to allocate memory for the domain process
on a NUMA host. \fBmemnode\fP elements can specify memory allocation policies per each guest NUMA node. The definition
used in the dictionary can be found at \fI\%cpu parameters definition\fP\&.
.sp
To update any numatune parameters, specify the new value. To remove any \fBnumatune\fP parameters, pass a None object,
for instance: \(aqnumatune\(aq: \fBNone\fP\&. Please note that \fBNone\fP is mapped to \fBnull\fP in sls file, pass \fBnull\fP in
sls file instead.
.sp
New in version 3003.


.IP \(bu 2
\fBserials\fP \-\-
.sp
Dictionary providing details on the serials connection to create. (Default: \fBNone\fP)
See \fI\%Serials and Consoles Definitions\fP for more details on the possible values.
.sp
New in version 3003.


.IP \(bu 2
\fBconsoles\fP \-\-
.sp
Dictionary providing details on the consoles device to create. (Default: \fBNone\fP)
See \fI\%Serials and Consoles Definitions\fP for more details on the possible values.
.sp
New in version 3003.


.IP \(bu 2
\fBstop_on_reboot\fP \-\-
.sp
If set to \fBTrue\fP the guest will stop instead of rebooting.
This is specially useful when creating a virtual machine with an installation cdrom or
an autoinstallation needing a special first boot configuration.
Defaults to \fBFalse\fP
.sp
New in version 3003.


.IP \(bu 2
\fBtest\fP \-\-
.sp
run in dry\-run mode if set to True
.sp
New in version 3001.


.IP \(bu 2
\fBhypervisor_features\fP \-\-
.sp
Enable or disable hypervisor\-specific features on the virtual machine.
.sp
New in version 3003.

.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
hypervisor_features:
  kvm\-hint\-dedicated: True
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBclock\fP \-\-
.sp
Configure the guest clock.
The value is a dictionary with the following keys:
.INDENT 2.0
.TP
.B adjustment
time adjustment in seconds or \fBreset\fP
.TP
.B utc
set to \fBFalse\fP to use the host local time as the guest clock. Defaults to \fBTrue\fP\&.
.TP
.B timezone
synchronize the guest to the correspding timezone
.TP
.B timers
a dictionary associating the timer name with its configuration.
This configuration is a dictionary with the properties \fBtrack\fP, \fBtickpolicy\fP,
\fBcatchup\fP, \fBfrequency\fP, \fBmode\fP, \fBpresent\fP, \fBslew\fP, \fBthreshold\fP and \fBlimit\fP\&.
See \fI\%libvirt time keeping documentation\fP for the possible values.
.UNINDENT
.sp
New in version 3003.

.sp
Set the clock to local time using an offset in seconds
\&.. code\-block:: yaml
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B clock:
adjustment: 3600
utc: False
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Set the clock to a specific time zone:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
clock:
  timezone: CEST
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Tweak guest timers:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
clock:
  timers:
    tsc:
      frequency: 3504000000
      mode: native
    rtc:
      track: wall
      tickpolicy: catchup
      slew: 4636
      threshold: 123
      limit: 2342
    hpet:
      present: False
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBhost_devices\fP \-\-
.sp
List of host devices to passthrough to the guest.
The value is a list of device names as provided by the \fI\%node_devices()\fP function.
(Default: \fBNone\fP)
.sp
New in version 3003.


.IP \(bu 2
\fBautostart\fP \-\- If set to \fBTrue\fP the host will start the guest after boot.
(Default: \fBFalse\fP)
.UNINDENT
.TP
.B Returns
Returns a dictionary indicating the status of what has been done. It is structured in
the following way:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
  \(aqdefinition\(aq: True,
  \(aqcpu\(aq: True,
  \(aqmem\(aq: True,
  \(aqdisks\(aq: {\(aqattached\(aq: [list of actually attached disks],
            \(aqdetached\(aq: [list of actually detached disks]},
  \(aqnics\(aq: {\(aqattached\(aq: [list of actually attached nics],
           \(aqdetached\(aq: [list of actually detached nics]},
  \(aqerrors\(aq: [\(aqerror messages for failures\(aq]
}
.ft P
.fi
.UNINDENT
.UNINDENT

.UNINDENT
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.update domain cpu=2 mem=1024
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.virt_type()
Returns the virtual machine type as a string
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.virt_type
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.vm_cputime(vm_=None, **kwargs)
Return cputime used by the vms on this hyper in a
list of dicts:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
    \(aqyour\-vm\(aq: {
        \(aqcputime\(aq <int>
        \(aqcputime_percent\(aq <int>
        },
    ...
    ]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.vm_cputime
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.vm_diskstats(vm_=None, **kwargs)
Return disk usage counters used by the vms on this hyper in a
list of dicts:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
    \(aqyour\-vm\(aq: {
        \(aqrd_req\(aq   : 0,
        \(aqrd_bytes\(aq : 0,
        \(aqwr_req\(aq   : 0,
        \(aqwr_bytes\(aq : 0,
        \(aqerrs\(aq     : 0
        },
    ...
    ]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.vm_blockstats
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.vm_info(vm_=None, **kwargs)
Return detailed information about the vms on this hyper in a
list of dicts:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- name of the domain
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
    \(aqyour\-vm\(aq: {
        \(aqcpu\(aq: <int>,
        \(aqmaxMem\(aq: <int>,
        \(aqmem\(aq: <int>,
        \(aqstate\(aq: \(aq<state>\(aq,
        \(aqcputime\(aq <int>
        },
    ...
    ]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.vm_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.vm_netstats(vm_=None, **kwargs)
Return combined network counters used by the vms on this hyper in a
list of dicts:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- domain name
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
    \(aqyour\-vm\(aq: {
        \(aqrx_bytes\(aq   : 0,
        \(aqrx_packets\(aq : 0,
        \(aqrx_errs\(aq    : 0,
        \(aqrx_drop\(aq    : 0,
        \(aqtx_bytes\(aq   : 0,
        \(aqtx_packets\(aq : 0,
        \(aqtx_errs\(aq    : 0,
        \(aqtx_drop\(aq    : 0
        },
    ...
    ]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.vm_netstats
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.vm_state(vm_=None, **kwargs)
Return list of all the vms and their state.
.sp
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvm\fP \-\- name of the domain
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.vm_state <domain>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.volume_define(pool, name, size, allocation=0, format=None, type=None, permissions=None, backing_store=None, nocow=False, **kwargs)
Create libvirt volume.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpool\fP \-\- name of the pool to create the volume in
.IP \(bu 2
\fBname\fP \-\- name of the volume to define
.IP \(bu 2
\fBsize\fP \-\- capacity of the volume to define in MiB
.IP \(bu 2
\fBallocation\fP \-\- allocated size of the volume in MiB. Defaults to 0.
.IP \(bu 2
\fBformat\fP \-\- volume format. The allowed values are depending on the pool type.
Check the virt.pool_capabilities output for the possible values and the default.
.IP \(bu 2
\fBtype\fP \-\- type of the volume. One of file, block, dir, network, netdiri, ploop or None.
By default, the type is guessed by libvirt from the pool type.
.IP \(bu 2
\fBpermissions\fP \-\- Permissions to set on the target folder. This is mostly used for filesystem\-based
pool types. See \fI\%Permissions definition\fP for more details on this structure.
.IP \(bu 2
\fBbacking_store\fP \-\-
.sp
dictionary describing a backing file for the volume. It must contain a \fBpath\fP
property pointing to the base volume and a \fBformat\fP property defining the format
of the base volume.
.sp
The base volume format will not be guessed for security reasons and is thus mandatory.

.IP \(bu 2
\fBnocow\fP \-\- disable COW for the volume.
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
CLI Example:
.sp
Volume on ESX:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.volume_define \(dq[local\-storage]\(dq myvm/myvm.vmdk vmdk 8192
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
QCow2 volume with backing file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.volume_define default myvm.qcow2 qcow2 8192                             permissions=\(dq{\(aqmode\(aq: \(aq0775\(aq, \(aqowner\(aq: \(aq123\(aq, \(aqgroup\(aq: \(aq345\(aq\(dq}\(dq                             backing_store=\(dq{\(aqpath\(aq: \(aq/path/to/base.img\(aq, \(aqformat\(aq: \(aqraw\(aq}\(dq                             nocow=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.volume_delete(pool, volume, **kwargs)
Delete a libvirt managed volume.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpool\fP \-\- libvirt storage pool name
.IP \(bu 2
\fBvolume\fP \-\- name of the volume to delete
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq virt.volume_delete <pool> <volume>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.volume_infos(pool=None, volume=None, **kwargs)
Provide details on a storage volume. If no volume name is provided, the infos
all the volumes contained in the pool are provided. If no pool is provided,
the infos of the volumes of all pools are output.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpool\fP \-\- libvirt storage pool name (default: \fBNone\fP)
.IP \(bu 2
\fBvolume\fP \-\- name of the volume to get infos from (default: \fBNone\fP)
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq virt.volume_infos <pool> <volume>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virt.volume_upload(pool, volume, file, offset=0, length=0, sparse=False, **kwargs)
Create libvirt volume.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpool\fP \-\- name of the pool to create the volume in
.IP \(bu 2
\fBname\fP \-\- name of the volume to define
.IP \(bu 2
\fBfile\fP \-\- the file to upload to the volume
.IP \(bu 2
\fBoffset\fP \-\- where to start writing the data in the volume
.IP \(bu 2
\fBlength\fP \-\- amount of bytes to transfer to the volume
.IP \(bu 2
\fBsparse\fP \-\- set to True to preserve data sparsiness.
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.volume_upload default myvm.qcow2 /path/to/disk.qcow2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.SS salt.modules.virtualenv
.sp
Create virtualenv environments.
.sp
New in version 0.17.0.

.INDENT 0.0
.TP
.B salt.modules.virtualenv_mod.create(path, venv_bin=None, system_site_packages=False, distribute=False, clear=False, python=None, extra_search_dir=None, never_download=None, prompt=None, pip=False, symlinks=None, upgrade=None, user=None, use_vt=False, saltenv=\(aqbase\(aq, **kwargs)
Create a virtualenv
.INDENT 7.0
.TP
.B path
The path to the virtualenv to be created
.TP
.B venv_bin
The name (and optionally path) of the virtualenv command. This can also
be set globally in the minion config file as \fBvirtualenv.venv_bin\fP\&.
Defaults to \fBvirtualenv\fP\&.
.TP
.B system_site_packages
False
Passthrough argument given to virtualenv or pyvenv
.TP
.B distribute
False
Passthrough argument given to virtualenv
.TP
.B pip
False
Install pip after creating a virtual environment. Implies
\fBdistribute=True\fP
.TP
.B clear
False
Passthrough argument given to virtualenv or pyvenv
.TP
.B python
None (default)
Passthrough argument given to virtualenv
.TP
.B extra_search_dir
None (default)
Passthrough argument given to virtualenv
.TP
.B never_download
None (default)
Passthrough argument given to virtualenv if True
.TP
.B prompt
None (default)
Passthrough argument given to virtualenv if not None
.TP
.B symlinks
None
Passthrough argument given to pyvenv if True
.TP
.B upgrade
None
Passthrough argument given to pyvenv if True
.TP
.B user
None
Set ownership for the virtualenv
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On Windows you must also pass a \fBpassword\fP parameter. Additionally,
the user must have permissions to the location where the virtual
environment is being created
.UNINDENT
.UNINDENT
.TP
.B runas
None
Set ownership for the virtualenv
.sp
Deprecated since version 2014.1.0: \fBuser\fP should be used instead

.TP
.B use_vt
False
Use VT terminal emulation (see output while installing)
.sp
New in version 2015.5.0.

.TP
.B saltenv
\(aqbase\(aq
Specify a different environment. The default environment is \fBbase\fP\&.
.sp
New in version 2014.1.0.

.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fBrunas\fP argument is deprecated as of 2014.1.0. \fBuser\fP should be
used instead.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
   salt \(aq*\(aq virtualenv.create /path/to/new/virtualenv

Example of using \-\-always\-copy environment variable (in case your fs doesn\(aqt support symlinks).
This will copy files into the virtualenv instead of symlinking them.

\&.. code\-block:: yaml

    \- env:
      \- VIRTUALENV_ALWAYS_COPY: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virtualenv_mod.get_distribution_path(venv, distribution)
Return the path to a distribution installed inside a virtualenv
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B venv
Path to the virtualenv.
.TP
.B distribution
Name of the distribution. Note, all non\-alphanumeric characters
will be converted to dashes.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virtualenv.get_distribution_path /path/to/my/venv my_distribution
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virtualenv_mod.get_resource_content(venv, package=None, resource=None)
Return the content of a package resource installed inside a virtualenv
.sp
New in version 2015.5.0.

.INDENT 7.0
.TP
.B venv
Path to the virtualenv
.TP
.B package
Name of the package in which the resource resides
.sp
New in version 2016.3.0.

.TP
.B resource
Name of the resource of which the content is to be returned
.sp
New in version 2016.3.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virtualenv.get_resource_content /path/to/my/venv my_package my/resource.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virtualenv_mod.get_resource_path(venv, package=None, resource=None)
Return the path to a package resource installed inside a virtualenv
.sp
New in version 2015.5.0.

.INDENT 7.0
.TP
.B venv
Path to the virtualenv
.TP
.B package
Name of the package in which the resource resides
.sp
New in version 2016.3.0.

.TP
.B resource
Name of the resource of which the path is to be returned
.sp
New in version 2016.3.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virtualenv.get_resource_path /path/to/my/venv my_package my/resource.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virtualenv_mod.get_site_packages(venv)
Return the path to the site\-packages directory of a virtualenv
.INDENT 7.0
.TP
.B venv
Path to the virtualenv.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virtualenv.get_site_packages /path/to/my/venv
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.virtualenv_mod.virtualenv_ver(venv_bin, user=None, **kwargs)
return virtualenv version if exists
.UNINDENT
.SS salt.modules.vmctl
.sp
Manage vms running on the OpenBSD VMM hypervisor using vmctl(8).
.sp
New in version 2019.2.0.

.INDENT 0.0
.TP
.B codeauthor
\fBJasper Lievisse Adriaanse <jasper@openbsd.org>\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This module requires the \fIvmd\fP service to be running on the OpenBSD
target machine.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vmctl.create_disk(name, size)
Create a VMM disk with the specified \fIname\fP and \fIsize\fP\&.
.INDENT 7.0
.TP
.B size:
Size in megabytes, or use a specifier such as M, G, T.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmctl.create_disk /path/to/disk.img size=10G
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vmctl.load(path)
Load additional configuration from the specified file.
.INDENT 7.0
.TP
.B path
Path to the configuration file.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmctl.load path=/etc/vm.switches.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vmctl.reload()
Remove all stopped VMs and reload configuration from the default configuration file.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmctl.reload
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vmctl.reset(all=False, vms=False, switches=False)
Reset the running state of VMM or a subsystem.
.INDENT 7.0
.TP
.B all:
Reset the running state.
.TP
.B switches:
Reset the configured switches.
.TP
.B vms:
Reset and terminate all VMs.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmctl.reset all=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vmctl.start(name=None, id=None, bootpath=None, disk=None, disks=None, local_iface=False, memory=None, nics=0, switch=None)
Starts a VM defined by the specified parameters.
When both a name and id are provided, the id is ignored.
.INDENT 7.0
.TP
.B name:
Name of the defined VM.
.TP
.B id:
VM id.
.TP
.B bootpath:
Path to a kernel or BIOS image to load.
.TP
.B disk:
Path to a single disk to use.
.TP
.B disks:
List of multiple disks to use.
.TP
.B local_iface:
Whether to add a local network interface. See \(dqLOCAL INTERFACES\(dq
in the vmctl(8) manual page for more information.
.TP
.B memory:
Memory size of the VM specified in megabytes.
.TP
.B switch:
Add a network interface that is attached to the specified
virtual switch on the host.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmctl.start 2   # start VM with id 2
salt \(aq*\(aq vmctl.start name=web1 bootpath=\(aq/bsd.rd\(aq nics=2 memory=512M disk=\(aq/disk.img\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vmctl.status(name=None, id=None)
List VMs running on the host, or only the VM specified by \fBid\fP\&.  When
both a name and id are provided, the id is ignored.
.INDENT 7.0
.TP
.B name:
Name of the defined VM.
.TP
.B id:
VM id.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmctl.status           # to list all VMs
salt \(aq*\(aq vmctl.status name=web1 # to get a single VM
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vmctl.stop(name=None, id=None)
Stop (terminate) the VM identified by the given id or name.
When both a name and id are provided, the id is ignored.
.INDENT 7.0
.TP
.B name:
Name of the defined VM.
.TP
.B id:
VM id.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vmctl.stop name=alpine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.vsphere
.sp
Manage VMware vCenter servers and ESXi hosts.
.sp
New in version 2015.8.4.

.INDENT 0.0
.TP
.B codeauthor
Alexandru Bleotu <\fI\%alexandru.bleotu@morganstaley.com\fP>
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
pyVmomi Python Module
.IP \(bu 2
ESXCLI
.UNINDENT
.SS pyVmomi
.sp
PyVmomi can be installed via pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Version 6.0 of pyVmomi has some problems with SSL error handling on certain
versions of Python. If using version 6.0 of pyVmomi, Python 2.7.9,
or newer must be present. This is due to an upstream dependency
in pyVmomi 6.0 that is not supported in Python versions 2.7 to 2.7.8. If the
version of Python is not in the supported range, you will need to install an
earlier version of pyVmomi. See \fI\%Issue #29537\fP for more information.
.UNINDENT
.UNINDENT
.sp
Based on the note above, to install an earlier version of pyVmomi than the
version currently listed in PyPi, run the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi==5.5.0.2014.1.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The 5.5.0.2014.1.1 is a known stable version that this original vSphere Execution
Module was developed against.
.SS vSphere Automation SDK
.sp
vSphere Automation SDK can be installed via pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install \-\-upgrade pip setuptools
pip install \-\-upgrade git+https://github.com/vmware/vsphere\-automation\-sdk\-python.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The SDK also requires OpenSSL 1.0.1+ if you want to connect to vSphere 6.5+ in order to support
TLS1.1 & 1.2.
.sp
In order to use the tagging functions in this module, vSphere Automation SDK is necessary to
install.
.UNINDENT
.UNINDENT
.sp
The module is currently in version 1.0.3
(as of 8/26/2019)
.SS ESXCLI
.sp
Currently, about a third of the functions used in the vSphere Execution Module require
the ESXCLI package be installed on the machine running the Proxy Minion process.
.sp
The ESXCLI package is also referred to as the VMware vSphere CLI, or vCLI. VMware
provides vCLI package installation instructions for \fI\%vSphere 5.5\fP and
\fI\%vSphere 6.0\fP\&.
.sp
Once all of the required dependencies are in place and the vCLI package is
installed, you can check to see if you can connect to your ESXi host or vCenter
server by running the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
esxcli \-s <host\-location> \-u <username> \-p <password> system syslog config get
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the connection was successful, ESXCLI was successfully installed on your system.
You should see output related to the ESXi host\(aqs syslog configuration.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Be aware that some functionality in this execution module may depend on the
type of license attached to a vCenter Server or ESXi host(s).
.sp
For example, certain services are only available to manipulate service state
or policies with a VMware vSphere Enterprise or Enterprise Plus license, while
others are available with a Standard license. The \fBntpd\fP service is restricted
to an Enterprise Plus license, while \fBssh\fP is available via the Standard
license.
.sp
Please see the \fI\%vSphere Comparison\fP page for more information.
.UNINDENT
.UNINDENT
.SS About
.sp
This execution module was designed to be able to handle connections both to a
vCenter Server, as well as to an ESXi host. It utilizes the pyVmomi Python
library and the ESXCLI package to run remote execution functions against either
the defined vCenter server or the ESXi host.
.sp
Whether or not the function runs against a vCenter Server or an ESXi host depends
entirely upon the arguments passed into the function. Each function requires a
\fBhost\fP location, \fBusername\fP, and \fBpassword\fP\&. If the credentials provided
apply to a vCenter Server, then the function will be run against the vCenter
Server. For example, when listing hosts using vCenter credentials, you\(aqll get a
list of hosts associated with that vCenter Server:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt my\-minion vsphere.list_hosts <vcenter\-ip> <vcenter\-user> <vcenter\-password>
my\-minion:
\- esxi\-1.example.com
\- esxi\-2.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, some functions should be used against ESXi hosts, not vCenter Servers.
Functionality such as getting a host\(aqs coredump network configuration should be
performed against a host and not a vCenter server. If the authentication
information you\(aqre using is against a vCenter server and not an ESXi host, you
can provide the host name that is associated with the vCenter server in the
command, as a list, using the \fBhost_names\fP or \fBesxi_host\fP kwarg. For
example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt my\-minion vsphere.get_coredump_network_config <vcenter\-ip> <vcenter\-user>         <vcenter\-password> esxi_hosts=\(aq[esxi\-1.example.com, esxi\-2.example.com]\(aq
my\-minion:
\-\-\-\-\-\-\-\-\-\-
    esxi\-1.example.com:
        \-\-\-\-\-\-\-\-\-\-
        Coredump Config:
            \-\-\-\-\-\-\-\-\-\-
            enabled:
                False
    esxi\-2.example.com:
        \-\-\-\-\-\-\-\-\-\-
        Coredump Config:
            \-\-\-\-\-\-\-\-\-\-
            enabled:
                True
            host_vnic:
                vmk0
            ip:
                coredump\-location.example.com
            port:
                6500
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also use these functions against an ESXi host directly by establishing a
connection to an ESXi host using the host\(aqs location, username, and password. If ESXi
connection credentials are used instead of vCenter credentials, the \fBhost_names\fP and
\fBesxi_hosts\fP arguments are not needed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt my\-minion vsphere.get_coredump_network_config esxi\-1.example.com root <host\-password>
local:
\-\-\-\-\-\-\-\-\-\-
    10.4.28.150:
        \-\-\-\-\-\-\-\-\-\-
        Coredump Config:
            \-\-\-\-\-\-\-\-\-\-
            enabled:
                True
            host_vnic:
                vmk0
            ip:
                coredump\-location.example.com
            port:
                6500
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.add_capacity_to_diskgroup(cache_disk_id, capacity_disk_ids, safety_checks=True, service_instance=None)
Adds capacity disks to the disk group with the specified cache disk.
.INDENT 7.0
.TP
.B cache_disk_id
The canonical name of the cache disk.
.TP
.B capacity_disk_ids
A list containing canonical names of the capacity disks to add.
.TP
.B safety_checks
Specify whether to perform safety check or to skip the checks and try
performing the required task. Default value is True.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.add_capacity_to_diskgroup
    cache_disk_id=\(aqnaa.000000000000001\(aq
    capacity_disk_ids=\(aq[naa.000000000000002, naa.000000000000003]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.add_host_to_dvs(host, username, password, vmknic_name, vmnic_name, dvs_name, target_portgroup_name, uplink_portgroup_name, protocol=None, port=None, host_names=None, verify_ssl=True)
Adds an ESXi host to a vSphere Distributed Virtual Switch and migrates
the desired adapters to the DVS from the standard switch.
.INDENT 7.0
.TP
.B host
The location of the vCenter server.
.TP
.B username
The username used to login to the vCenter server.
.TP
.B password
The password used to login to the vCenter server.
.TP
.B vmknic_name
The name of the virtual NIC to migrate.
.TP
.B vmnic_name
The name of the physical NIC to migrate.
.TP
.B dvs_name
The name of the Distributed Virtual Switch.
.TP
.B target_portgroup_name
The name of the distributed portgroup in which to migrate the
virtual NIC.
.TP
.B uplink_portgroup_name
The name of the uplink portgroup in which to migrate the
physical NIC.
.TP
.B protocol
Optionally set to alternate protocol if the vCenter server or ESX/ESXi host is not
using the default protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the vCenter server or ESX/ESXi host is not
using the default port. Default port is \fB443\fP\&.
.TP
.B host_names:
An array of VMware host names to migrate
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt some_host vsphere.add_host_to_dvs host=\(aqvsphere.corp.com\(aq
    username=\(aqadministrator@vsphere.corp.com\(aq password=\(aqvsphere_password\(aq
    vmknic_name=\(aqvmk0\(aq vmnic_name=\(aqvnmic0\(aq dvs_name=\(aqDSwitch\(aq
    target_portgroup_name=\(aqDPortGroup\(aq uplink_portgroup_name=\(aqDSwitch1\-DVUplinks\-181\(aq
    protocol=\(aqhttps\(aq port=\(aq443\(aq, host_names=\(dq[\(aqesxi1.corp.com\(aq,\(aqesxi2.corp.com\(aq,\(aqesxi3.corp.com\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Return Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
somehost:
    \-\-\-\-\-\-\-\-\-\-
    esxi1.corp.com:
        \-\-\-\-\-\-\-\-\-\-
        dvs:
            DSwitch
        portgroup:
            DPortGroup
        status:
            True
        uplink:
            DSwitch\-DVUplinks\-181
        vmknic:
            vmk0
        vmnic:
            vmnic0
    esxi2.corp.com:
        \-\-\-\-\-\-\-\-\-\-
        dvs:
            DSwitch
        portgroup:
            DPortGroup
        status:
            True
        uplink:
            DSwitch\-DVUplinks\-181
        vmknic:
            vmk0
        vmnic:
            vmnic0
    esxi3.corp.com:
        \-\-\-\-\-\-\-\-\-\-
        dvs:
            DSwitch
        portgroup:
            DPortGroup
        status:
            True
        uplink:
            DSwitch\-DVUplinks\-181
        vmknic:
            vmk0
        vmnic:
            vmnic0
    message:
    success:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This was very difficult to figure out.  VMware\(aqs PyVmomi documentation at
.sp
\fI\%https://github.com/vmware/pyvmomi/blob/master/docs/vim/DistributedVirtualSwitch.rst\fP
(which is a copy of the official documentation here:
\fI\%https://www.vmware.com/support/developer/converter\-sdk/conv60_apireference/vim.DistributedVirtualSwitch.html\fP)
.sp
says to create the DVS, create distributed portgroups, and then add the
host to the DVS specifying which physical NIC to use as the port backing.
However, if the physical NIC is in use as the only link from the host
to vSphere, this will fail with an unhelpful \(dqbusy\(dq error.
.sp
There is, however, a Powershell PowerCLI cmdlet called Add\-VDSwitchPhysicalNetworkAdapter
that does what we want.  I used Onyx (\fI\%https://labs.vmware.com/flings/onyx\fP)
to sniff the SOAP stream from Powershell to our vSphere server and got
this snippet out:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
<UpdateNetworkConfig xmlns=\(dqurn:vim25\(dq>
  <_this type=\(dqHostNetworkSystem\(dq>networkSystem\-187</_this>
  <config>
    <vswitch>
      <changeOperation>edit</changeOperation>
      <name>vSwitch0</name>
      <spec>
        <numPorts>7812</numPorts>
      </spec>
    </vswitch>
    <proxySwitch>
        <changeOperation>edit</changeOperation>
        <uuid>73 a4 05 50 b0 d2 7e b9\-38 80 5d 24 65 8f da 70</uuid>
        <spec>
        <backing xsi:type=\(dqDistributedVirtualSwitchHostMemberPnicBacking\(dq>
            <pnicSpec><pnicDevice>vmnic0</pnicDevice></pnicSpec>
        </backing>
        </spec>
    </proxySwitch>
    <portgroup>
      <changeOperation>remove</changeOperation>
      <spec>
        <name>Management Network</name><vlanId>\-1</vlanId><vswitchName /><policy />
      </spec>
    </portgroup>
    <vnic>
      <changeOperation>edit</changeOperation>
      <device>vmk0</device>
      <portgroup />
      <spec>
        <distributedVirtualPort>
          <switchUuid>73 a4 05 50 b0 d2 7e b9\-38 80 5d 24 65 8f da 70</switchUuid>
          <portgroupKey>dvportgroup\-191</portgroupKey>
        </distributedVirtualPort>
      </spec>
    </vnic>
  </config>
  <changeMode>modify</changeMode>
</UpdateNetworkConfig>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The SOAP API maps closely to PyVmomi, so from there it was (relatively)
easy to figure out what Python to write.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.add_license(key, description, safety_checks=True, service_instance=None)
Adds a license to the vCenter or ESXi host
.INDENT 7.0
.TP
.B key
License key.
.TP
.B description
License description added in as a label.
.TP
.B safety_checks
Specify whether to perform safety check or to skip the checks and try
performing the required task
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.add_license key=<license_key> desc=\(aqLicense desc\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.assign_default_storage_policy_to_datastore(policy, datastore, service_instance=None)
Assigns a storage policy as the default policy to a datastore.
.INDENT 7.0
.TP
.B policy
Name of the policy to assign.
.TP
.B datastore
Name of the datastore to assign.
The datastore needs to be visible to the VMware entity the proxy
points to.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.assign_storage_policy_to_datastore
    policy=\(aqpolicy name\(aq datastore=ds1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.assign_license(license_key, license_name, entity, entity_display_name, safety_checks=True, service_instance=None)
Assigns a license to an entity
.INDENT 7.0
.TP
.B license_key
Key of the license to assign
See \fB_get_entity\fP docstrings for format.
.TP
.B license_name
Display name of license
.TP
.B entity
Dictionary representation of an entity
.TP
.B entity_display_name
Entity name used in logging
.TP
.B safety_checks
Specify whether to perform safety check or to skip the checks and try
performing the required task. Default is False.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.assign_license license_key=AAAAA\-11111\-AAAAA\-11111\-AAAAA
    license_name=test entity={type:cluster,datacenter:dc,cluster:cl}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.attach_tag(object_id, tag_id, managed_obj=\(aqClusterComputeResource\(aq, server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None)
Attach an existing tag to an input object.
.sp
The tag needs to meet the cardinality (\fICategoryModel.cardinality\fP) and
associability (\fICategoryModel.associable_types\fP) criteria in order to be
eligible for attachment. If the tag is already attached to the object,
then this method is a no\-op and an error will not be thrown. To invoke
this method, you need the attach tag privilege on the tag and the read
privilege on the object.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt vm_minion vsphere.attach_tag domain\-c2283                 urn:vmomi:InventoryServiceTag:b55ecc77\-f4a5\-49f8\-ab52\-38865467cfbe:GLOBAL
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBobject_id\fP (\fI\%str\fP) \-\- The identifier of the input object.
.IP \(bu 2
\fBtag_id\fP (\fI\%str\fP) \-\- The identifier of the tag object.
.IP \(bu 2
\fBmanaged_obj\fP (\fI\%str\fP) \-\- Classes that contain methods for creating and deleting resources
typically contain a class attribute specifying the resource type
for the resources being created and deleted.
.IP \(bu 2
\fBserver\fP (\fIbasestring\fP) \-\- Target DNS or IP of vCenter center.
.IP \(bu 2
\fBusername\fP (\fIbasestring\fP) \-\- Username associated with the vCenter center.
.IP \(bu 2
\fBpassword\fP (\fIbasestring\fP) \-\- Password associated with the vCenter center.
.IP \(bu 2
\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True
.IP \(bu 2
\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates.
.UNINDENT
.TP
.B Returns
The list of all tag identifiers that correspond to the
tags attached to the given object.
.TP
.B Return type
\fI\%list\fP of tags
.TP
.B Raise
Unauthorized
if you do not have the privilege to read the object.
.TP
.B Raise
Unauthenticated
if the user can not be authenticated.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.compare_vm_configs(new_config, current_config)
Compares virtual machine current and new configuration, the current is the
one which is deployed now, and the new is the target config. Returns the
differences between the objects in a dictionary, the keys are the
configuration parameter keys and the values are differences objects: either
list or recursive difference
.INDENT 7.0
.TP
.B new_config:
New config dictionary with every available parameter
.TP
.B current_config
Currently deployed configuration
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.configure_host_cache(enabled, datastore=None, swap_size_MiB=None, service_instance=None)
Configures the host cache on the selected host.
.INDENT 7.0
.TP
.B enabled
Boolean flag specifying whether the host cache is enabled.
.TP
.B datastore
Name of the datastore that contains the host cache. Must be set if
enabled is \fBtrue\fP\&.
.TP
.B swap_size_MiB
Swap size in Mibibytes. Needs to be set if enabled is \fBtrue\fP\&. Must be
smaller than the datastore size.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.configure_host_cache enabled=False

salt \(aq*\(aq vsphere.configure_host_cache enabled=True datastore=ds1
    swap_size_MiB=1024
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.coredump_network_enable(host, username, password, enabled, protocol=None, port=None, esxi_hosts=None, credstore=None)
Enable or disable ESXi core dump collection. Returns \fBTrue\fP if coredump is enabled
and returns \fBFalse\fP if core dump is not enabled. If there was an error, the error
will be the value printed in the \fBError\fP key dictionary for the given host.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B enabled
Python True or False to enable or disable coredumps.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B esxi_hosts
If \fBhost\fP is a vCenter host, then use esxi_hosts to execute this function
on a list of one or more ESXi machines.
.TP
.B credstore
Optionally set to path to the credential store file.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for ESXi host connection information
salt \(aq*\(aq vsphere.coredump_network_enable my.esxi.host root bad\-password True

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.coredump_network_enable my.vcenter.location root bad\-password True             esxi_hosts=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.create_cluster(cluster_dict, datacenter=None, cluster=None, service_instance=None)
Creates a cluster.
.sp
Note: cluster_dict[\(aqname\(aq] will be overridden by the cluster param value
.INDENT 7.0
.TP
.B config_dict
Dictionary with the config values of the new cluster.
.TP
.B datacenter
Name of datacenter containing the cluster.
Ignored if already contained by proxy details.
Default value is None.
.TP
.B cluster
Name of cluster.
Ignored if already contained by proxy details.
Default value is None.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# esxdatacenter proxy
salt \(aq*\(aq vsphere.create_cluster cluster_dict=$cluster_dict cluster=cl1

# esxcluster proxy
salt \(aq*\(aq vsphere.create_cluster cluster_dict=$cluster_dict
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.create_datacenter(datacenter_name, service_instance=None)
Creates a datacenter.
.sp
Supported proxies: esxdatacenter
.INDENT 7.0
.TP
.B datacenter_name
The datacenter name
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.create_datacenter dc1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.create_diskgroup(cache_disk_id, capacity_disk_ids, safety_checks=True, service_instance=None)
Creates disk group on an ESXi host with the specified cache and
capacity disks.
.INDENT 7.0
.TP
.B cache_disk_id
The canonical name of the disk to be used as a cache. The disk must be
ssd.
.TP
.B capacity_disk_ids
A list containing canonical names of the capacity disks. Must contain at
least one id. Default is True.
.TP
.B safety_checks
Specify whether to perform safety check or to skip the checks and try
performing the required task. Default value is True.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.create_diskgroup cache_disk_id=\(aqnaa.000000000000001\(aq
    capacity_disk_ids=\(aq[naa.000000000000002, naa.000000000000003]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.create_dvportgroup(portgroup_dict, portgroup_name, dvs, service_instance=None)
Creates a distributed virtual portgroup.
.sp
Note: The \fBportgroup_name\fP param will override any name already set
in \fBportgroup_dict\fP\&.
.INDENT 7.0
.TP
.B portgroup_dict
Dictionary with the config values the portgroup should be created with
(example in salt.states.dvs).
.TP
.B portgroup_name
Name of the portgroup to be created.
.TP
.B dvs
Name of the DVS that will contain the portgroup.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.create_dvportgroup portgroup_dict=<dict>
    portgroup_name=pg1 dvs=dvs1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.create_dvs(dvs_dict, dvs_name, service_instance=None)
Creates a distributed virtual switch (DVS).
.sp
Note: The \fBdvs_name\fP param will override any name set in \fBdvs_dict\fP\&.
.INDENT 7.0
.TP
.B dvs_dict
Dict representation of the new DVS (example in salt.states.dvs)
.TP
.B dvs_name
Name of the DVS to be created.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.create_dvs dvs dict=$dvs_dict dvs_name=dvs_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.create_storage_policy(policy_name, policy_dict, service_instance=None)
Creates a storage policy.
.sp
Supported capability types: scalar, set, range.
.INDENT 7.0
.TP
.B policy_name
Name of the policy to create.
The value of the argument will override any existing name in
\fBpolicy_dict\fP\&.
.TP
.B policy_dict
Dictionary containing the changes to apply to the policy.
(example in salt.states.pbm)
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.create_storage_policy policy_name=\(aqpolicy name\(aq
    policy_dict=\(dq$policy_dict\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.create_tag(name, description, category_id, server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None)
Create a tag under a category with given description.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt vm_minion vsphere.create_tag
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBserver\fP (\fIbasestring\fP) \-\- Target DNS or IP of vCenter client.
.IP \(bu 2
\fBusername\fP (\fIbasestring\fP) \-\- Username associated with the vCenter client.
.IP \(bu 2
\fBpassword\fP (\fIbasestring\fP) \-\- Password associated with the vCenter client.
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name of tag category to create (ex. Machine, OS, Availability, etc.)
.IP \(bu 2
\fBdescription\fP (\fI\%str\fP) \-\- Given description of tag category.
.IP \(bu 2
\fBcategory_id\fP (\fI\%str\fP) \-\- Value of category_id representative of the category created previously.
.IP \(bu 2
\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True
.IP \(bu 2
\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates.
.UNINDENT
.TP
.B Returns
The identifier of the created tag.
.TP
.B Return type
\fI\%str\fP
.TP
.B Raise
AlreadyExists
if the name provided in the create_spec is the name of an already
existing tag in the input category.
.TP
.B Raise
InvalidArgument
if any of the input information in the create_spec is invalid.
.TP
.B Raise
NotFound
if the category for in the given create_spec does not exist in
the system.
.TP
.B Raise
Unauthorized
if you do not have the privilege to create tag.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.create_tag_category(name, description, cardinality, server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None)
Create a category with given cardinality.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt vm_minion vsphere.create_tag_category
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name of tag category to create (ex. Machine, OS, Availability, etc.)
.IP \(bu 2
\fBdescription\fP (\fI\%str\fP) \-\- Given description of tag category.
.IP \(bu 2
\fBcardinality\fP (\fI\%str\fP) \-\- The associated cardinality (SINGLE, MULTIPLE) of the category.
.IP \(bu 2
\fBserver\fP (\fIbasestring\fP) \-\- Target DNS or IP of vCenter center.
.IP \(bu 2
\fBusername\fP (\fIbasestring\fP) \-\- Username associated with the vCenter center.
.IP \(bu 2
\fBpassword\fP (\fIbasestring\fP) \-\- Password associated with the vCenter center.
.IP \(bu 2
\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True
.IP \(bu 2
\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates.
.UNINDENT
.TP
.B Returns
Identifier of the created category.
.TP
.B Return type
\fI\%str\fP
.TP
.B Raise
AlreadyExists
if the name\(ga provided in the create_spec is the name of an already
existing category.
.TP
.B Raise
InvalidArgument
if any of the information in the create_spec is invalid.
.TP
.B Raise
Unauthorized
if you do not have the privilege to create a category.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.create_vm(vm_name, cpu, memory, image, version, datacenter, datastore, placement, interfaces, disks, scsi_devices, serial_ports=None, ide_controllers=None, sata_controllers=None, cd_drives=None, advanced_configs=None, service_instance=None)
Creates a virtual machine container.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt vm_minion vsphere.create_vm vm_name=vmname cpu=\(aq{count: 2, nested: True}\(aq ...
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B vm_name
Name of the virtual machine
.TP
.B cpu
Properties of CPUs for freshly created machines
.TP
.B memory
Memory size for freshly created machines
.TP
.B image
Virtual machine guest OS version identifier
VirtualMachineGuestOsIdentifier
.TP
.B version
Virtual machine container hardware version
.TP
.B datacenter
Datacenter where the virtual machine will be deployed (mandatory)
.TP
.B datastore
Datastore where the virtual machine files will be placed
.TP
.B placement
Resource pool or cluster or host or folder where the virtual machine
will be deployed
.TP
.B devices
interfaces
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
interfaces:
  adapter: \(aqNetwork adapter 1\(aq
  name: vlan100
  switch_type: distributed or standard
  adapter_type: vmxnet3 or vmxnet, vmxnet2, vmxnet3, e1000, e1000e
  mac: \(aq00:11:22:33:44:55\(aq
  connectable:
    allow_guest_control: True
    connected: True
    start_connected: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
disks
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
disks:
  adapter: \(aqHard disk 1\(aq
  size: 16
  unit: GB
  address: \(aq0:0\(aq
  controller: \(aqSCSI controller 0\(aq
  thin_provision: False
  eagerly_scrub: False
  datastore: \(aqmyshare\(aq
  filename: \(aqvm/mydisk.vmdk\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
scsi_devices
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scsi_devices:
  controller: \(aqSCSI controller 0\(aq
  type: paravirtual
  bus_sharing: no_sharing
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
serial_ports
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
serial_ports:
  adapter: \(aqSerial port 1\(aq
  type: network
  backing:
    uri: \(aqtelnet://something:port\(aq
    direction: <client|server>
    filename: \(aqservice_uri\(aq
  connectable:
    allow_guest_control: True
    connected: True
    start_connected: True
  yield: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
cd_drives
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cd_drives:
  adapter: \(aqCD/DVD drive 0\(aq
  controller: \(aqIDE 0\(aq
  device_type: datastore_iso_file
  datastore_iso_file:
    path: path_to_iso
  connectable:
    allow_guest_control: True
    connected: True
    start_connected: True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B advanced_config
Advanced config parameters to be set for the virtual machine
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.create_vmfs_datastore(datastore_name, disk_id, vmfs_major_version, safety_checks=True, service_instance=None)
Creates a ESXi host disk group with the specified cache and capacity disks.
.INDENT 7.0
.TP
.B datastore_name
The name of the datastore to be created.
.TP
.B disk_id
The disk id (canonical name) on which the datastore is created.
.TP
.B vmfs_major_version
The VMFS major version.
.TP
.B safety_checks
Specify whether to perform safety check or to skip the checks and try
performing the required task. Default is True.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.create_vmfs_datastore datastore_name=ds1 disk_id=
    vmfs_major_version=5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.delete_advanced_configs(vm_name, datacenter, advanced_configs, service_instance=None)
Removes extra config parameters from a virtual machine
.INDENT 7.0
.TP
.B vm_name
Virtual machine name
.TP
.B datacenter
Datacenter name where the virtual machine is available
.TP
.B advanced_configs
List of advanced config values to be removed
.TP
.B service_instance
vCenter service instance for connection and configuration
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.delete_tag(tag_id, server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None)
Delete a tag.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt vm_minion vsphere.delete_tag
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtag_id\fP (\fI\%str\fP) \-\- The identifier of tag to be deleted.
The parameter must be an identifier for the resource type:
\fBcom.vmware.cis.tagging.Tag\fP\&.
.IP \(bu 2
\fBserver\fP (\fIbasestring\fP) \-\- Target DNS or IP of vCenter center.
.IP \(bu 2
\fBusername\fP (\fIbasestring\fP) \-\- Username associated with the vCenter center.
.IP \(bu 2
\fBpassword\fP (\fIbasestring\fP) \-\- Password associated with the vCenter center.
.IP \(bu 2
\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True
.IP \(bu 2
\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates.
.UNINDENT
.TP
.B Raise
AlreadyExists
if the name provided in the create_spec is the name of an already
existing category.
.TP
.B Raise
InvalidArgument
if any of the information in the create_spec is invalid.
.TP
.B Raise
Unauthorized
if you do not have the privilege to create a category.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.delete_tag_category(category_id, server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None)
Delete a category.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt vm_minion vsphere.delete_tag_category
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcategory_id\fP (\fI\%str\fP) \-\- The identifier of category to be deleted.
The parameter must be an identifier for the resource type:
\fBcom.vmware.cis.tagging.Category\fP\&.
.IP \(bu 2
\fBserver\fP (\fIbasestring\fP) \-\- Target DNS or IP of vCenter center.
.IP \(bu 2
\fBusername\fP (\fIbasestring\fP) \-\- Username associated with the vCenter center.
.IP \(bu 2
\fBpassword\fP (\fIbasestring\fP) \-\- Password associated with the vCenter center.
.IP \(bu 2
\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True
.IP \(bu 2
\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates.
.UNINDENT
.TP
.B Raise
NotFound
if the tag for the given tag_id does not exist in the system.
.TP
.B Raise
Unauthorized
if you do not have the privilege to delete the tag.
.TP
.B Raise
Unauthenticated
if the user can not be authenticated.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.delete_vm(name, datacenter, placement=None, power_off=False, service_instance=None)
Deletes a virtual machine defined by name and placement
.INDENT 7.0
.TP
.B name
Name of the virtual machine
.TP
.B datacenter
Datacenter of the virtual machine
.TP
.B placement
Placement information of the virtual machine
.TP
.B service_instance
vCenter service instance for connection and configuration
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.delete_vm name=my_vm datacenter=my_datacenter
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.disconnect(service_instance)
Disconnects from a vCenter or ESXi host
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Should be used by state functions, not invoked directly.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B service_instance
Service instance (vim.ServiceInstance)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
See note above.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.enable_firewall_ruleset(host, username, password, ruleset_enable, ruleset_name, protocol=None, port=None, esxi_hosts=None, credstore=None)
Enable or disable an ESXi firewall rule set.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B ruleset_enable
True to enable the ruleset, false to disable.
.TP
.B ruleset_name
Name of ruleset to target.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B esxi_hosts
If \fBhost\fP is a vCenter host, then use esxi_hosts to execute this function
on a list of one or more ESXi machines.
.TP
.B credstore
Optionally set to path to the credential store file.
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A standard cmd.run_all dictionary, per host.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for ESXi host connection information
salt \(aq*\(aq vsphere.enable_firewall_ruleset my.esxi.host root bad\-password True \(aqsyslog\(aq

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.enable_firewall_ruleset my.vcenter.location root bad\-password True \(aqsyslog\(aq             esxi_hosts=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.erase_disk_partitions(disk_id=None, scsi_address=None, service_instance=None)
Erases the partitions on a disk.
The disk can be specified either by the canonical name, or by the
scsi_address.
.INDENT 7.0
.TP
.B disk_id
Canonical name of the disk.
Either \fBdisk_id\fP or \fBscsi_address\fP needs to be specified
(\fBdisk_id\fP supersedes \fBscsi_address\fP\&.
.TP
.B scsi_address
Scsi address of the disk.
\fBdisk_id\fP or \fBscsi_address\fP needs to be specified
(\fBdisk_id\fP supersedes \fBscsi_address\fP\&.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.erase_disk_partitions scsi_address=\(aqvmhaba0:C0:T0:L0\(aq

salt \(aq*\(aq vsphere.erase_disk_partitions disk_id=\(aqnaa.000000000000001\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.esxcli_cmd(cmd_str, host=None, username=None, password=None, protocol=None, port=None, esxi_hosts=None, credstore=None)
Run an ESXCLI command directly on the host or list of hosts.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B cmd_str
The ESXCLI command to run. Note: This should not include the \fB\-s\fP, \fB\-u\fP,
\fB\-p\fP, \fB\-h\fP, \fB\-\-protocol\fP, or \fB\-\-portnumber\fP arguments that are
frequently passed when using a bare ESXCLI command from the command line.
Those arguments are handled by this function via the other args and kwargs.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B esxi_hosts
If \fBhost\fP is a vCenter host, then use esxi_hosts to execute this function
on a list of one or more ESXi machines.
.TP
.B credstore
Optionally set to path to the credential store file.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for ESXi host connection information
salt \(aq*\(aq vsphere.esxcli_cmd my.esxi.host root bad\-password             \(aqsystem coredump network get\(aq

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.esxcli_cmd my.vcenter.location root bad\-password             \(aqsystem coredump network get\(aq esxi_hosts=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_advanced_configs(vm_name, datacenter, service_instance=None)
Returns extra config parameters from a virtual machine advanced config list
.INDENT 7.0
.TP
.B vm_name
Virtual machine name
.TP
.B datacenter
Datacenter name where the virtual machine is available
.TP
.B service_instance
vCenter service instance for connection and configuration
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_coredump_network_config(host, username, password, protocol=None, port=None, esxi_hosts=None, credstore=None)
Retrieve information on ESXi or vCenter network dump collection and
format it into a dictionary.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B esxi_hosts
If \fBhost\fP is a vCenter host, then use esxi_hosts to execute this function
on a list of one or more ESXi machines.
.TP
.B credstore
Optionally set to path to the credential store file.
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary with the network configuration, or, if getting
the network config failed, a an error message retrieved from the
standard cmd.run_all dictionary, per host.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for ESXi host connection information
salt \(aq*\(aq vsphere.get_coredump_network_config my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.get_coredump_network_config my.vcenter.location root bad\-password             esxi_hosts=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_firewall_status(host, username, password, protocol=None, port=None, esxi_hosts=None, credstore=None)
Show status of all firewall rule sets.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B esxi_hosts
If \fBhost\fP is a vCenter host, then use esxi_hosts to execute this function
on a list of one or more ESXi machines.
.TP
.B credstore
Optionally set to path to the credential store file.
.UNINDENT
.INDENT 7.0
.TP
.B Returns
Nested dictionary with two toplevel keys \fBrulesets\fP and \fBsuccess\fP
\fBsuccess\fP will be True or False depending on query success
\fBrulesets\fP will list the rulesets and their statuses if \fBsuccess\fP
was true, per host.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for ESXi host connection information
salt \(aq*\(aq vsphere.get_firewall_status my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.get_firewall_status my.vcenter.location root bad\-password             esxi_hosts=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_host_cache(service_instance=None)
Returns the host cache configuration on the proxy host.
.INDENT 7.0
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.get_host_cache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_host_datetime(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True)
Get the date/time information for a given host or list of host_names.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to tell
vCenter the hosts for which to get date/time information.
.sp
If host_names is not provided, the date/time information will be retrieved for the
\fBhost\fP location instead. This is useful for when service instance connection
information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.get_host_datetime my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.get_host_datetime my.vcenter.location root bad\-password         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_ntp_config(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True)
Get the NTP configuration information for a given host or list of host_names.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to tell
vCenter the hosts for which to get ntp configuration information.
.sp
If host_names is not provided, the NTP configuration will be retrieved for the
\fBhost\fP location instead. This is useful for when service instance connection
information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.get_ntp_config my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.get_ntp_config my.vcenter.location root bad\-password         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_proxy_type()
Returns the proxy type retrieved either from the pillar of from the proxy
minion\(aqs config.  Returns \fB<undefined>\fP otherwise.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.get_proxy_type
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_service_instance_via_proxy(service_instance=None)
Returns a service instance to the proxied endpoint (vCenter/ESXi host).
.INDENT 7.0
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Should be used by state functions not invoked directly.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
See note above
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_service_policy(host, username, password, service_name, protocol=None, port=None, host_names=None, verify_ssl=True)
Get the service name\(aqs policy for a given host or list of hosts.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B service_name
.INDENT 7.0
.TP
.B The name of the service for which to retrieve the policy. Supported service names are:
.INDENT 7.0
.IP \(bu 2
DCUI
.IP \(bu 2
TSM
.IP \(bu 2
SSH
.IP \(bu 2
lbtd
.IP \(bu 2
lsassd
.IP \(bu 2
lwiod
.IP \(bu 2
netlogond
.IP \(bu 2
ntpd
.IP \(bu 2
sfcbd\-watchdog
.IP \(bu 2
snmpd
.IP \(bu 2
vprobed
.IP \(bu 2
vpxa
.IP \(bu 2
xorg
.UNINDENT
.UNINDENT
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to tell
vCenter the hosts for which to get service policy information.
.sp
If host_names is not provided, the service policy information will be retrieved
for the \fBhost\fP location instead. This is useful for when service instance
connection information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.get_service_policy my.esxi.host root bad\-password \(aqssh\(aq

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.get_service_policy my.vcenter.location root bad\-password \(aqntpd\(aq         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_service_running(host, username, password, service_name, protocol=None, port=None, host_names=None, verify_ssl=True)
Get the service name\(aqs running state for a given host or list of hosts.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B service_name
.INDENT 7.0
.TP
.B The name of the service for which to retrieve the policy. Supported service names are:
.INDENT 7.0
.IP \(bu 2
DCUI
.IP \(bu 2
TSM
.IP \(bu 2
SSH
.IP \(bu 2
lbtd
.IP \(bu 2
lsassd
.IP \(bu 2
lwiod
.IP \(bu 2
netlogond
.IP \(bu 2
ntpd
.IP \(bu 2
sfcbd\-watchdog
.IP \(bu 2
snmpd
.IP \(bu 2
vprobed
.IP \(bu 2
vpxa
.IP \(bu 2
xorg
.UNINDENT
.UNINDENT
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to tell
vCenter the hosts for which to get the service\(aqs running state.
.sp
If host_names is not provided, the service\(aqs running state will be retrieved
for the \fBhost\fP location instead. This is useful for when service instance
connection information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.get_service_running my.esxi.host root bad\-password \(aqssh\(aq

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.get_service_running my.vcenter.location root bad\-password \(aqntpd\(aq         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_ssh_key(host, username, password, protocol=None, port=None, certificate_verify=None)
Retrieve the authorized_keys entry for root.
This function only works for ESXi, not vCenter.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhost\fP \-\- The location of the ESXi Host
.IP \(bu 2
\fBusername\fP \-\- Username to connect as
.IP \(bu 2
\fBpassword\fP \-\- Password for the ESXi web endpoint
.IP \(bu 2
\fBprotocol\fP \-\- defaults to https, can be http if ssl is disabled on ESXi
.IP \(bu 2
\fBport\fP \-\- defaults to 443 for https
.IP \(bu 2
\fBcertificate_verify\fP \-\- If true require that the SSL connection present
a valid certificate. Default: True
.UNINDENT
.TP
.B Returns
True if upload is successful
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.get_ssh_key my.esxi.host root bad\-password certificate_verify=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_syslog_config(host, username, password, protocol=None, port=None, esxi_hosts=None, credstore=None)
Retrieve the syslog configuration.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B esxi_hosts
If \fBhost\fP is a vCenter host, then use esxi_hosts to execute this function
on a list of one or more ESXi machines.
.TP
.B credstore
Optionally set to path to the credential store file.
.UNINDENT
.INDENT 7.0
.TP
.B Returns
Dictionary with keys and values corresponding to the
syslog configuration, per host.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for ESXi host connection information
salt \(aq*\(aq vsphere.get_syslog_config my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.get_syslog_config my.vcenter.location root bad\-password             esxi_hosts=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_vm(name, datacenter=None, vm_properties=None, traversal_spec=None, parent_ref=None, service_instance=None)
Returns vm object properties.
.INDENT 7.0
.TP
.B name
Name of the virtual machine.
.TP
.B datacenter
Datacenter name
.TP
.B vm_properties
List of vm properties.
.TP
.B traversal_spec
Traversal Spec object(s) for searching.
.TP
.B parent_ref
Container Reference object for searching under a given object.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_vm_config(name, datacenter=None, objects=True, service_instance=None)
Queries and converts the virtual machine properties to the available format
from the schema. If the objects attribute is True the config objects will
have extra properties, like \(aqobject\(aq which will include the
vim.vm.device.VirtualDevice, this is necessary for deletion and update
actions.
.INDENT 7.0
.TP
.B name
Name of the virtual machine
.TP
.B datacenter
Datacenter\(aqs name where the virtual machine is available
.TP
.B objects
Indicates whether to return the vmware object properties
(eg. object, key) or just the properties which can be set
.TP
.B service_instance
vCenter service instance for connection and configuration
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_vm_config_file(name, datacenter, placement, datastore, service_instance=None)
Queries the virtual machine config file and returns
vim.host.DatastoreBrowser.SearchResults object on success None on failure
.INDENT 7.0
.TP
.B name
Name of the virtual machine
.TP
.B datacenter
Datacenter name
.TP
.B datastore
Datastore where the virtual machine files are stored
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_vmotion_enabled(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True)
Get the VMotion enabled status for a given host or a list of host_names. Returns \fBTrue\fP
if VMotion is enabled, \fBFalse\fP if it is not enabled.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to
tell vCenter which hosts to check if VMotion is enabled.
.sp
If host_names is not provided, the VMotion status will be retrieved for the
\fBhost\fP location instead. This is useful for when service instance
connection information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.get_vmotion_enabled my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.get_vmotion_enabled my.vcenter.location root bad\-password         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_vsan_eligible_disks(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True)
Returns a list of VSAN\-eligible disks for a given host or list of host_names.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to
tell vCenter which hosts to check if any VSAN\-eligible disks are available.
.sp
If host_names is not provided, the VSAN\-eligible disks will be retrieved
for the \fBhost\fP location instead. This is useful for when service instance
connection information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.get_vsan_eligible_disks my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.get_vsan_eligible_disks my.vcenter.location root bad\-password         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.get_vsan_enabled(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True)
Get the VSAN enabled status for a given host or a list of host_names. Returns \fBTrue\fP
if VSAN is enabled, \fBFalse\fP if it is not enabled, and \fBNone\fP if a VSAN Host Config
is unset, per host.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to
tell vCenter which hosts to check if VSAN enabled.
.sp
If host_names is not provided, the VSAN status will be retrieved for the
\fBhost\fP location instead. This is useful for when service instance
connection information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.get_vsan_enabled my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.get_vsan_enabled my.vcenter.location root bad\-password         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_assigned_licenses(entity, entity_display_name, license_keys=None, service_instance=None)
Lists the licenses assigned to an entity
.INDENT 7.0
.TP
.B entity
Dictionary representation of an entity.
See \fB_get_entity\fP docstrings for format.
.TP
.B entity_display_name
Entity name used in logging
.TP
.B license_keys:
List of license keys to be retrieved. Default is None.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_assigned_licenses
    entity={type:cluster,datacenter:dc,cluster:cl}
    entiy_display_name=cl
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_attached_tags(object_id, managed_obj=\(aqClusterComputeResource\(aq, server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None)
List existing tags a user has access to.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt vm_minion vsphere.list_attached_tags domain\-c2283
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBobject_id\fP (\fI\%str\fP) \-\- The identifier of the input object.
.IP \(bu 2
\fBmanaged_obj\fP (\fI\%str\fP) \-\- Classes that contain methods for creating and deleting resources
typically contain a class attribute specifying the resource type
for the resources being created and deleted.
.IP \(bu 2
\fBserver\fP (\fIbasestring\fP) \-\- Target DNS or IP of vCenter center.
.IP \(bu 2
\fBusername\fP (\fIbasestring\fP) \-\- Username associated with the vCenter center.
.IP \(bu 2
\fBpassword\fP (\fIbasestring\fP) \-\- Password associated with the vCenter center.
.IP \(bu 2
\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True
.IP \(bu 2
\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates.
.UNINDENT
.TP
.B Returns
The list of all tag identifiers that correspond to the
tags attached to the given object.
.TP
.B Return type
\fI\%list\fP of tags
.TP
.B Raise
Unauthorized
if you do not have the privilege to read the object.
.TP
.B Raise
Unauthenticated
if the user can not be authenticated.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_capability_definitions(service_instance=None)
Returns a list of the metadata of all capabilities in the vCenter.
.INDENT 7.0
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_capabilities
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_cluster(datacenter=None, cluster=None, service_instance=None)
Returns a dict representation of an ESX cluster.
.INDENT 7.0
.TP
.B datacenter
Name of datacenter containing the cluster.
Ignored if already contained by proxy details.
Default value is None.
.TP
.B cluster
Name of cluster.
Ignored if already contained by proxy details.
Default value is None.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# vcenter proxy
salt \(aq*\(aq vsphere.list_cluster datacenter=dc1 cluster=cl1

# esxdatacenter proxy
salt \(aq*\(aq vsphere.list_cluster cluster=cl1

# esxcluster proxy
salt \(aq*\(aq vsphere.list_cluster
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_clusters(host, username, password, protocol=None, port=None, verify_ssl=True)
Returns a list of clusters for the specified host.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_clusters 1.2.3.4 root bad\-password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_datacenters(host, username, password, protocol=None, port=None, verify_ssl=True)
Returns a list of datacenters for the specified host.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_datacenters 1.2.3.4 root bad\-password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_datacenters_via_proxy(datacenter_names=None, service_instance=None)
Returns a list of dict representations of VMware datacenters.
Connection is done via the proxy details.
.sp
Supported proxies: esxdatacenter
.INDENT 7.0
.TP
.B datacenter_names
List of datacenter names.
Default is None.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_datacenters_via_proxy

salt \(aq*\(aq vsphere.list_datacenters_via_proxy dc1

salt \(aq*\(aq vsphere.list_datacenters_via_proxy dc1,dc2

salt \(aq*\(aq vsphere.list_datacenters_via_proxy datacenter_names=[dc1, dc2]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_datastore_clusters(host, username, password, protocol=None, port=None, verify_ssl=True)
Returns a list of datastore clusters for the specified host.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_datastore_clusters 1.2.3.4 root bad\-password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_datastores(host, username, password, protocol=None, port=None, verify_ssl=True)
Returns a list of datastores for the specified host.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_datastores 1.2.3.4 root bad\-password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_datastores_via_proxy(datastore_names=None, backing_disk_ids=None, backing_disk_scsi_addresses=None, service_instance=None)
Returns a list of dict representations of the datastores visible to the
proxy object. The list of datastores can be filtered by datastore names,
backing disk ids (canonical names) or backing disk scsi addresses.
.sp
Supported proxy types: esxi, esxcluster, esxdatacenter
.INDENT 7.0
.TP
.B datastore_names
List of the names of datastores to filter on
.TP
.B backing_disk_ids
List of canonical names of the backing disks of the datastores to filer.
Default is None.
.TP
.B backing_disk_scsi_addresses
List of scsi addresses of the backing disks of the datastores to filter.
Default is None.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_datastores_via_proxy

salt \(aq*\(aq vsphere.list_datastores_via_proxy datastore_names=[ds1, ds2]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_default_storage_policy_of_datastore(datastore, service_instance=None)
Returns a list of datastores assign the storage policies.
.INDENT 7.0
.TP
.B datastore
Name of the datastore to assign.
The datastore needs to be visible to the VMware entity the proxy
points to.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_default_storage_policy_of_datastore datastore=ds1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_default_vsan_policy(service_instance=None)
Returns the default vsan storage policy.
.INDENT 7.0
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_default_vsan_policy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_disk_partitions(disk_id=None, scsi_address=None, service_instance=None)
Lists the partitions on a disk.
The disk can be specified either by the canonical name, or by the
scsi_address.
.INDENT 7.0
.TP
.B disk_id
Canonical name of the disk.
Either \fBdisk_id\fP or \fBscsi_address\fP needs to be specified
(\fBdisk_id\fP supersedes \fBscsi_address\fP\&.
.TP
.B scsi_address\(ga
Scsi address of the disk.
\fBdisk_id\fP or \fBscsi_address\fP needs to be specified
(\fBdisk_id\fP supersedes \fBscsi_address\fP\&.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_disk_partitions scsi_address=\(aqvmhaba0:C0:T0:L0\(aq

salt \(aq*\(aq vsphere.list_disk_partitions disk_id=\(aqnaa.000000000000001\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_diskgroups(cache_disk_ids=None, service_instance=None)
Returns a list of disk group dict representation on an ESXi host.
The list of disk groups can be filtered by the cache disks
canonical names. If no filtering is applied, all disk groups are returned.
.INDENT 7.0
.TP
.B cache_disk_ids:
List of cache disk canonical names of the disk groups to be retrieved.
Default is None.
.TP
.B use_proxy_details
Specify whether to use the proxy minion\(aqs details instead of the
arguments
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_diskgroups

salt \(aq*\(aq vsphere.list_diskgroups cache_disk_ids=\(aq[naa.000000000000001]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_disks(disk_ids=None, scsi_addresses=None, service_instance=None)
Returns a list of dict representations of the disks in an ESXi host.
The list of disks can be filtered by disk canonical names or
scsi addresses.
.INDENT 7.0
.TP
.B disk_ids:
List of disk canonical names to be retrieved. Default is None.
.TP
.B scsi_addresses
List of scsi addresses of disks to be retrieved. Default is None
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_disks

salt \(aq*\(aq vsphere.list_disks disk_ids=\(aq[naa.00, naa.001]\(aq

salt \(aq*\(aq vsphere.list_disks
    scsi_addresses=\(aq[vmhba0:C0:T0:L0, vmhba1:C0:T0:L0]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_dvportgroups(dvs=None, portgroup_names=None, service_instance=None)
Returns a list of distributed virtual switch portgroups.
The list can be filtered by the portgroup names or by the DVS.
.INDENT 7.0
.TP
.B dvs
Name of the DVS containing the portgroups.
Default value is None.
.TP
.B portgroup_names
List of portgroup names to look for. If None, all portgroups are
returned.
Default value is None
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_dvportgroups

salt \(aq*\(aq vsphere.list_dvportgroups dvs=dvs1

salt \(aq*\(aq vsphere.list_dvportgroups portgroup_names=[pg1]

salt \(aq*\(aq vsphere.list_dvportgroups dvs=dvs1 portgroup_names=[pg1]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_dvs(host, username, password, protocol=None, port=None, verify_ssl=True)
Returns a list of distributed virtual switches for the specified host.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_dvs 1.2.3.4 root bad\-password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_dvss(datacenter=None, dvs_names=None, service_instance=None)
Returns a list of distributed virtual switches (DVSs).
The list can be filtered by the datacenter or DVS names.
.INDENT 7.0
.TP
.B datacenter
The datacenter to look for DVSs in.
Default value is None.
.TP
.B dvs_names
List of DVS names to look for. If None, all DVSs are returned.
Default value is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_dvss

salt \(aq*\(aq vsphere.list_dvss dvs_names=[dvs1,dvs2]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_folders(host, username, password, protocol=None, port=None, verify_ssl=True)
Returns a list of folders for the specified host.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_folders 1.2.3.4 root bad\-password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_hosts(host, username, password, protocol=None, port=None, verify_ssl=True)
Returns a list of hosts for the specified VMware environment.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_hosts 1.2.3.4 root bad\-password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_hosts_via_proxy(hostnames=None, datacenter=None, cluster=None, service_instance=None)
Returns a list of hosts for the specified VMware environment. The list
of hosts can be filtered by datacenter name and/or cluster name
.INDENT 7.0
.TP
.B hostnames
Hostnames to filter on.
.TP
.B datacenter_name
Name of datacenter. Only hosts in this datacenter will be retrieved.
Default is None.
.TP
.B cluster_name
Name of cluster. Only hosts in this cluster will be retrieved. If a
datacenter is not specified the first cluster with this name will be
considerred. Default is None.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_hosts_via_proxy

salt \(aq*\(aq vsphere.list_hosts_via_proxy hostnames=[esxi1.example.com]

salt \(aq*\(aq vsphere.list_hosts_via_proxy datacenter=dc1 cluster=cluster1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_licenses(service_instance=None)
Lists all licenses on a vCenter.
.INDENT 7.0
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_licenses
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_networks(host, username, password, protocol=None, port=None, verify_ssl=True)
Returns a list of networks for the specified host.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_networks 1.2.3.4 root bad\-password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_non_ssds(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True)
Returns a list of Non\-SSD disks for the given host or list of host_names.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
In the pyVmomi StorageSystem, ScsiDisks may, or may not have an \fBssd\fP attribute.
This attribute indicates if the ScsiDisk is SSD backed. As this option is optional,
if a relevant disk in the StorageSystem does not have \fBssd = true\fP, it will end
up in the \fBnon_ssds\fP list here.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to
tell vCenter the hosts for which to retrieve Non\-SSD disks.
.sp
If host_names is not provided, Non\-SSD disks will be retrieved for the
\fBhost\fP location instead. This is useful for when service instance
connection information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.list_non_ssds my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.list_non_ssds my.vcenter.location root bad\-password         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_resourcepools(host, username, password, protocol=None, port=None, verify_ssl=True)
Returns a list of resource pools for the specified host.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_resourcepools 1.2.3.4 root bad\-password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_ssds(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True)
Returns a list of SSDs for the given host or list of host_names.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to
tell vCenter the hosts for which to retrieve SSDs.
.sp
If host_names is not provided, SSDs will be retrieved for the
\fBhost\fP location instead. This is useful for when service instance
connection information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.list_ssds my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.list_ssds my.vcenter.location root bad\-password         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_storage_policies(policy_names=None, service_instance=None)
Returns a list of storage policies.
.INDENT 7.0
.TP
.B policy_names
Names of policies to list. If None, all policies are listed.
Default is None.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_storage_policies

salt \(aq*\(aq vsphere.list_storage_policies policy_names=[policy_name]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_tag_categories(server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None)
List existing categories a user has access to.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt vm_minion vsphere.list_tag_categories
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBserver\fP (\fIbasestring\fP) \-\- Target DNS or IP of vCenter center.
.IP \(bu 2
\fBusername\fP (\fIbasestring\fP) \-\- Username associated with the vCenter center.
.IP \(bu 2
\fBpassword\fP (\fIbasestring\fP) \-\- Password associated with the vCenter center.
.IP \(bu 2
\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True
.IP \(bu 2
\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates.
.UNINDENT
.TP
.B Returns
Value(s) of category_id.
.TP
.B Return type
\fI\%list\fP of \fI\%str\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_tags(server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None)
List existing tags a user has access to.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt vm_minion vsphere.list_tags
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBserver\fP (\fIbasestring\fP) \-\- Target DNS or IP of vCenter center.
.IP \(bu 2
\fBusername\fP (\fIbasestring\fP) \-\- Username associated with the vCenter center.
.IP \(bu 2
\fBpassword\fP (\fIbasestring\fP) \-\- Password associated with the vCenter center.
.IP \(bu 2
\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True
.IP \(bu 2
\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates.
.UNINDENT
.TP
.B Returns
Value(s) of tag_id.
.TP
.B Return type
\fI\%list\fP of \fI\%str\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_uplink_dvportgroup(dvs, service_instance=None)
Returns the uplink portgroup of a distributed virtual switch.
.INDENT 7.0
.TP
.B dvs
Name of the DVS containing the portgroup.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_uplink_dvportgroup dvs=dvs_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_vapps(host, username, password, protocol=None, port=None, verify_ssl=True)
Returns a list of vApps for the specified host.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# List vapps from all minions
salt \(aq*\(aq vsphere.list_vapps 1.2.3.4 root bad\-password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.list_vms(host, username, password, protocol=None, port=None, verify_ssl=True)
Returns a list of VMs for the specified host.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.list_vms 1.2.3.4 root bad\-password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.power_off_vm(name, datacenter=None, service_instance=None)
Powers off a virtual machine specified by its name.
.INDENT 7.0
.TP
.B name
Name of the virtual machine
.TP
.B datacenter
Datacenter of the virtual machine
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.power_off_vm name=my_vm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.power_on_vm(name, datacenter=None, service_instance=None)
Powers on a virtual machine specified by its name.
.INDENT 7.0
.TP
.B name
Name of the virtual machine
.TP
.B datacenter
Datacenter of the virtual machine
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.power_on_vm name=my_vm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.register_vm(name, datacenter, placement, vmx_path, service_instance=None)
Registers a virtual machine to the inventory with the given vmx file.
Returns comments and change list
.INDENT 7.0
.TP
.B name
Name of the virtual machine
.TP
.B datacenter
Datacenter of the virtual machine
.TP
.B placement
Placement dictionary of the virtual machine, host or cluster
.TP
.B vmx_path:
Full path to the vmx file, datastore name should be included
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.remove_capacity_from_diskgroup(cache_disk_id, capacity_disk_ids, data_evacuation=True, safety_checks=True, service_instance=None)
Remove capacity disks from the disk group with the specified cache disk.
.INDENT 7.0
.TP
.B cache_disk_id
The canonical name of the cache disk.
.TP
.B capacity_disk_ids
A list containing canonical names of the capacity disks to add.
.TP
.B data_evacuation
Specifies whether to gracefully evacuate the data on the capacity disks
before removing them from the disk group. Default value is True.
.TP
.B safety_checks
Specify whether to perform safety check or to skip the checks and try
performing the required task. Default value is True.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.remove_capacity_from_diskgroup
    cache_disk_id=\(aqnaa.000000000000001\(aq
    capacity_disk_ids=\(aq[naa.000000000000002, naa.000000000000003]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.remove_datastore(datastore, service_instance=None)
Removes a datastore. If multiple datastores an error is raised.
.INDENT 7.0
.TP
.B datastore
Datastore name
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.remove_datastore ds_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.remove_diskgroup(cache_disk_id, data_accessibility=True, service_instance=None)
Remove the diskgroup with the specified cache disk.
.INDENT 7.0
.TP
.B cache_disk_id
The canonical name of the cache disk.
.TP
.B data_accessibility
Specifies whether to ensure data accessibility. Default value is True.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.remove_diskgroup cache_disk_id=\(aqnaa.000000000000001\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.remove_dvportgroup(portgroup, dvs, service_instance=None)
Removes a distributed virtual portgroup.
.INDENT 7.0
.TP
.B portgroup
Name of the portgroup to be removed.
.TP
.B dvs
Name of the DVS containing the portgroups.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.remove_dvportgroup portgroup=pg1 dvs=dvs1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.rename_datastore(datastore_name, new_datastore_name, service_instance=None)
Renames a datastore. The datastore needs to be visible to the proxy.
.INDENT 7.0
.TP
.B datastore_name
Current datastore name.
.TP
.B new_datastore_name
New datastore name.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter/ESXi host.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.rename_datastore old_name new_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.reset_syslog_config(host, username, password, protocol=None, port=None, syslog_config=None, esxi_hosts=None, credstore=None)
Reset the syslog service to its default settings.
.sp
Valid syslog_config values are \fBlogdir\fP, \fBloghost\fP, \fBlogdir\-unique\fP,
\fBdefault\-rotate\fP, \fBdefault\-size\fP, \fBdefault\-timeout\fP,
or \fBall\fP for all of these.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B syslog_config
List of parameters to reset, provided as a comma\-delimited string, or \(aqall\(aq to
reset all syslog configuration parameters. Required.
.TP
.B esxi_hosts
If \fBhost\fP is a vCenter host, then use esxi_hosts to execute this function
on a list of one or more ESXi machines.
.TP
.B credstore
Optionally set to path to the credential store file.
.UNINDENT
.INDENT 7.0
.TP
.B Returns
Dictionary with a top\-level key of \(aqsuccess\(aq which indicates
if all the parameters were reset, and individual keys
for each parameter indicating which succeeded or failed, per host.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBsyslog_config\fP can be passed as a quoted, comma\-separated string. See CLI Example for details.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for ESXi host connection information
salt \(aq*\(aq vsphere.reset_syslog_config my.esxi.host root bad\-password             syslog_config=\(aqlogdir,loghost\(aq

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.reset_syslog_config my.vcenter.location root bad\-password             syslog_config=\(aqlogdir,loghost\(aq esxi_hosts=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.service_restart(host, username, password, service_name, protocol=None, port=None, host_names=None, verify_ssl=True)
Restart the named service for the given host or list of hosts.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B service_name
.INDENT 7.0
.TP
.B The name of the service for which to set the policy. Supported service names are:
.INDENT 7.0
.IP \(bu 2
DCUI
.IP \(bu 2
TSM
.IP \(bu 2
SSH
.IP \(bu 2
lbtd
.IP \(bu 2
lsassd
.IP \(bu 2
lwiod
.IP \(bu 2
netlogond
.IP \(bu 2
ntpd
.IP \(bu 2
sfcbd\-watchdog
.IP \(bu 2
snmpd
.IP \(bu 2
vprobed
.IP \(bu 2
vpxa
.IP \(bu 2
xorg
.UNINDENT
.UNINDENT
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to tell
vCenter the hosts for which to restart the service.
.sp
If host_names is not provided, the service will be restarted for the \fBhost\fP
location instead. This is useful for when service instance connection information
is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.service_restart my.esxi.host root bad\-password \(aqntpd\(aq

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.service_restart my.vcenter.location root bad\-password \(aqntpd\(aq         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.service_start(host, username, password, service_name, protocol=None, port=None, host_names=None, verify_ssl=True)
Start the named service for the given host or list of hosts.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B service_name
.INDENT 7.0
.TP
.B The name of the service for which to set the policy. Supported service names are:
.INDENT 7.0
.IP \(bu 2
DCUI
.IP \(bu 2
TSM
.IP \(bu 2
SSH
.IP \(bu 2
lbtd
.IP \(bu 2
lsassd
.IP \(bu 2
lwiod
.IP \(bu 2
netlogond
.IP \(bu 2
ntpd
.IP \(bu 2
sfcbd\-watchdog
.IP \(bu 2
snmpd
.IP \(bu 2
vprobed
.IP \(bu 2
vpxa
.IP \(bu 2
xorg
.UNINDENT
.UNINDENT
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to tell
vCenter the hosts for which to start the service.
.sp
If host_names is not provided, the service will be started for the \fBhost\fP
location instead. This is useful for when service instance connection information
is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.service_start my.esxi.host root bad\-password \(aqntpd\(aq

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.service_start my.vcenter.location root bad\-password \(aqntpd\(aq         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.service_stop(host, username, password, service_name, protocol=None, port=None, host_names=None, verify_ssl=True)
Stop the named service for the given host or list of hosts.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B service_name
.INDENT 7.0
.TP
.B The name of the service for which to set the policy. Supported service names are:
.INDENT 7.0
.IP \(bu 2
DCUI
.IP \(bu 2
TSM
.IP \(bu 2
SSH
.IP \(bu 2
lbtd
.IP \(bu 2
lsassd
.IP \(bu 2
lwiod
.IP \(bu 2
netlogond
.IP \(bu 2
ntpd
.IP \(bu 2
sfcbd\-watchdog
.IP \(bu 2
snmpd
.IP \(bu 2
vprobed
.IP \(bu 2
vpxa
.IP \(bu 2
xorg
.UNINDENT
.UNINDENT
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to tell
vCenter the hosts for which to stop the service.
.sp
If host_names is not provided, the service will be stopped for the \fBhost\fP
location instead. This is useful for when service instance connection information
is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.service_stop my.esxi.host root bad\-password \(aqssh\(aq

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.service_stop my.vcenter.location root bad\-password \(aqssh\(aq         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.set_advanced_configs(vm_name, datacenter, advanced_configs, service_instance=None)
Appends extra config parameters to a virtual machine advanced config list
.INDENT 7.0
.TP
.B vm_name
Virtual machine name
.TP
.B datacenter
Datacenter name where the virtual machine is available
.TP
.B advanced_configs
Dictionary with advanced parameter key value pairs
.TP
.B service_instance
vCenter service instance for connection and configuration
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.set_coredump_network_config(host, username, password, dump_ip, protocol=None, port=None, host_vnic=\(aqvmk0\(aq, dump_port=6500, esxi_hosts=None, credstore=None)
Set the network parameters for a network coredump collection.
Note that ESXi requires that the dumps first be enabled (see
\fIcoredump_network_enable\fP) before these parameters may be set.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B dump_ip
IP address of host that will accept the dump.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B esxi_hosts
If \fBhost\fP is a vCenter host, then use esxi_hosts to execute this function
on a list of one or more ESXi machines.
.TP
.B host_vnic
Host VNic port through which to communicate. Defaults to \fBvmk0\fP\&.
.TP
.B dump_port
TCP port to use for the dump, defaults to \fB6500\fP\&.
.TP
.B credstore
Optionally set to path to the credential store file.
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A standard cmd.run_all dictionary with a \fIsuccess\fP key added, per host.
\fIsuccess\fP will be True if the set succeeded, False otherwise.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for ESXi host connection information
salt \(aq*\(aq vsphere.set_coredump_network_config my.esxi.host root bad\-password \(aqdump_ip.host.com\(aq

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.set_coredump_network_config my.vcenter.location root bad\-password \(aqdump_ip.host.com\(aq             esxi_hosts=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.set_ntp_config(host, username, password, ntp_servers, protocol=None, port=None, host_names=None, verify_ssl=True)
Set NTP configuration for a given host of list of host_names.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B ntp_servers
A list of servers that should be added to and configured for the specified
host\(aqs NTP configuration.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to tell
vCenter which hosts to configure ntp servers.
.sp
If host_names is not provided, the NTP servers will be configured for the
\fBhost\fP location instead. This is useful for when service instance connection
information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.ntp_configure my.esxi.host root bad\-password \(aq[192.174.1.100, 192.174.1.200]\(aq

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.ntp_configure my.vcenter.location root bad\-password \(aq[192.174.1.100, 192.174.1.200]\(aq         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.set_service_policy(host, username, password, service_name, service_policy, protocol=None, port=None, host_names=None, verify_ssl=True)
Set the service name\(aqs policy for a given host or list of hosts.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B service_name
.INDENT 7.0
.TP
.B The name of the service for which to set the policy. Supported service names are:
.INDENT 7.0
.IP \(bu 2
DCUI
.IP \(bu 2
TSM
.IP \(bu 2
SSH
.IP \(bu 2
lbtd
.IP \(bu 2
lsassd
.IP \(bu 2
lwiod
.IP \(bu 2
netlogond
.IP \(bu 2
ntpd
.IP \(bu 2
sfcbd\-watchdog
.IP \(bu 2
snmpd
.IP \(bu 2
vprobed
.IP \(bu 2
vpxa
.IP \(bu 2
xorg
.UNINDENT
.UNINDENT
.TP
.B service_policy
The policy to set for the service. For example, \(aqautomatic\(aq.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to tell
vCenter the hosts for which to set the service policy.
.sp
If host_names is not provided, the service policy information will be retrieved
for the \fBhost\fP location instead. This is useful for when service instance
connection information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.set_service_policy my.esxi.host root bad\-password \(aqntpd\(aq \(aqautomatic\(aq

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.set_service_policy my.vcenter.location root bad\-password \(aqntpd\(aq \(aqautomatic\(aq         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.set_syslog_config(host, username, password, syslog_config, config_value, protocol=None, port=None, firewall=True, reset_service=True, esxi_hosts=None, credstore=None)
Set the specified syslog configuration parameter. By default, this function will
reset the syslog service after the configuration is set.
.INDENT 7.0
.TP
.B host
ESXi or vCenter host to connect to.
.TP
.B username
User to connect as, usually root.
.TP
.B password
Password to connect with.
.TP
.B syslog_config
Name of parameter to set (corresponds to the command line switch for
esxcli without the double dashes (\-\-))
.sp
Valid syslog_config values are \fBlogdir\fP, \fBloghost\fP, \fBdefault\-rotate\(ga,
\(ga\(gadefault\-size\fP, \fBdefault\-timeout\fP, and \fBlogdir\-unique\fP\&.
.TP
.B config_value
Value for the above parameter. For \fBloghost\fP, URLs or IP addresses to
use for logging. Multiple log servers can be specified by listing them,
comma\-separated, but without spaces before or after commas.
.sp
(reference: \fI\%https://blogs.vmware.com/vsphere/2012/04/configuring\-multiple\-syslog\-servers\-for\-esxi\-5.html\fP)
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B firewall
Enable the firewall rule set for syslog. Defaults to \fBTrue\fP\&.
.TP
.B reset_service
After a successful parameter set, reset the service. Defaults to \fBTrue\fP\&.
.TP
.B esxi_hosts
If \fBhost\fP is a vCenter host, then use esxi_hosts to execute this function
on a list of one or more ESXi machines.
.TP
.B credstore
Optionally set to path to the credential store file.
.UNINDENT
.INDENT 7.0
.TP
.B Returns
Dictionary with a top\-level key of \(aqsuccess\(aq which indicates
if all the parameters were reset, and individual keys
for each parameter indicating which succeeded or failed, per host.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for ESXi host connection information
salt \(aq*\(aq vsphere.set_syslog_config my.esxi.host root bad\-password             loghost ssl://localhost:5432,tcp://10.1.0.1:1514

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.set_syslog_config my.vcenter.location root bad\-password             loghost ssl://localhost:5432,tcp://10.1.0.1:1514             esxi_hosts=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.syslog_service_reload(host, username, password, protocol=None, port=None, esxi_hosts=None, credstore=None)
Reload the syslog service so it will pick up any changes.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B esxi_hosts
If \fBhost\fP is a vCenter host, then use esxi_hosts to execute this function
on a list of one or more ESXi machines.
.TP
.B credstore
Optionally set to path to the credential store file.
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A standard cmd.run_all dictionary.  This dictionary will at least
have a \fIretcode\fP key.  If \fIretcode\fP is 0 the command was successful.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for ESXi host connection information
salt \(aq*\(aq vsphere.syslog_service_reload my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.syslog_service_reload my.vcenter.location root bad\-password             esxi_hosts=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.system_info(host, username, password, protocol=None, port=None, verify_ssl=True)
Return system information about a VMware environment.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.system_info 1.2.3.4 root bad\-password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.test_vcenter_connection(service_instance=None)
Checks if a connection is to a vCenter
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.test_vcenter_connection
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.unregister_vm(name, datacenter, placement=None, power_off=False, service_instance=None)
Unregisters a virtual machine defined by name and placement
.INDENT 7.0
.TP
.B name
Name of the virtual machine
.TP
.B datacenter
Datacenter of the virtual machine
.TP
.B placement
Placement information of the virtual machine
.TP
.B service_instance
vCenter service instance for connection and configuration
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.unregister_vm name=my_vm datacenter=my_datacenter
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.update_cluster(cluster_dict, datacenter=None, cluster=None, service_instance=None)
Updates a cluster.
.INDENT 7.0
.TP
.B config_dict
Dictionary with the config values of the new cluster.
.TP
.B datacenter
Name of datacenter containing the cluster.
Ignored if already contained by proxy details.
Default value is None.
.TP
.B cluster
Name of cluster.
Ignored if already contained by proxy details.
Default value is None.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# esxdatacenter proxy
salt \(aq*\(aq vsphere.update_cluster cluster_dict=$cluster_dict cluster=cl1

# esxcluster proxy
salt \(aq*\(aq vsphere.update_cluster cluster_dict=$cluster_dict
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.update_dvportgroup(portgroup_dict, portgroup, dvs, service_instance=True)
Updates a distributed virtual portgroup.
.INDENT 7.0
.TP
.B portgroup_dict
Dictionary with the values the portgroup should be update with
(example in salt.states.dvs).
.TP
.B portgroup
Name of the portgroup to be updated.
.TP
.B dvs
Name of the DVS containing the portgroups.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.update_dvportgroup portgroup_dict=<dict>
    portgroup=pg1

salt \(aq*\(aq vsphere.update_dvportgroup portgroup_dict=<dict>
    portgroup=pg1 dvs=dvs1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.update_dvs(dvs_dict, dvs, service_instance=None)
Updates a distributed virtual switch (DVS).
.INDENT 7.0
.TP
.B Note: Updating the product info, capability, uplinks of a DVS is not
supported so the corresponding entries in \fBdvs_dict\fP will be
ignored.
.TP
.B dvs_dict
Dictionary with the values the DVS should be update with
(example in salt.states.dvs)
.TP
.B dvs
Name of the DVS to be updated.
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.update_dvs dvs_dict=$dvs_dict dvs=dvs1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.update_host_datetime(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True)
Update the date/time on the given host or list of host_names. This function should be
used with caution since network delays and execution delays can result in time skews.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to
tell vCenter which hosts should update their date/time.
.sp
If host_names is not provided, the date/time will be updated for the \fBhost\fP
location instead. This is useful for when service instance connection
information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.update_date_time my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.update_date_time my.vcenter.location root bad\-password         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.update_host_password(host, username, password, new_password, protocol=None, port=None, verify_ssl=True)
Update the password for a given host.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Currently only works with connections to ESXi hosts. Does not work with vCenter servers.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B host
The location of the ESXi host.
.TP
.B username
The username used to login to the ESXi host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the ESXi host.
.TP
.B new_password
The new password that will be updated for the provided username on the ESXi host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.update_host_password my.esxi.host root original\-bad\-password new\-bad\-password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.update_storage_policy(policy, policy_dict, service_instance=None)
Updates a storage policy.
.sp
Supported capability types: scalar, set, range.
.INDENT 7.0
.TP
.B policy
Name of the policy to update.
.TP
.B policy_dict
Dictionary containing the changes to apply to the policy.
(example in salt.states.pbm)
.TP
.B service_instance
Service instance (vim.ServiceInstance) of the vCenter.
Default is None.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.update_storage_policy policy=\(aqpolicy name\(aq
    policy_dict=\(dq$policy_dict\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.update_vm(vm_name, cpu=None, memory=None, image=None, version=None, interfaces=None, disks=None, scsi_devices=None, serial_ports=None, datacenter=None, datastore=None, cd_dvd_drives=None, sata_controllers=None, advanced_configs=None, service_instance=None)
Updates the configuration of the virtual machine if the config differs
.INDENT 7.0
.TP
.B vm_name
Virtual Machine name to be updated
.TP
.B cpu
CPU configuration options
.TP
.B memory
Memory configuration options
.TP
.B version
Virtual machine container hardware version
.TP
.B image
Virtual machine guest OS version identifier
VirtualMachineGuestOsIdentifier
.TP
.B interfaces
Network interfaces configuration options
.TP
.B disks
Disks configuration options
.TP
.B scsi_devices
SCSI devices configuration options
.TP
.B serial_ports
Serial ports configuration options
.TP
.B datacenter
Datacenter where the virtual machine is available
.TP
.B datastore
Datastore where the virtual machine config files are available
.TP
.B cd_dvd_drives
CD/DVD drives configuration options
.TP
.B advanced_config
Advanced config parameters to be set for the virtual machine
.TP
.B service_instance
vCenter service instance for connection and configuration
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.upload_ssh_key(host, username, password, ssh_key=None, ssh_key_file=None, protocol=None, port=None, certificate_verify=None)
Upload an ssh key for root to an ESXi host via http PUT.
This function only works for ESXi, not vCenter.
Only one ssh key can be uploaded for root.  Uploading a second key will
replace any existing key.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhost\fP \-\- The location of the ESXi Host
.IP \(bu 2
\fBusername\fP \-\- Username to connect as
.IP \(bu 2
\fBpassword\fP \-\- Password for the ESXi web endpoint
.IP \(bu 2
\fBssh_key\fP \-\- Public SSH key, will be added to authorized_keys on ESXi
.IP \(bu 2
\fBssh_key_file\fP \-\- File containing the SSH key.  Use \(aqssh_key\(aq or
ssh_key_file, but not both.
.IP \(bu 2
\fBprotocol\fP \-\- defaults to https, can be http if ssl is disabled on ESXi
.IP \(bu 2
\fBport\fP \-\- defaults to 443 for https
.IP \(bu 2
\fBcertificate_verify\fP \-\- If true require that the SSL connection present
a valid certificate. Default: True
.UNINDENT
.TP
.B Returns
Dictionary with a \(aqstatus\(aq key, True if upload is successful.
If upload is unsuccessful, \(aqstatus\(aq key will be False and
an \(aqError\(aq key will have an informative message.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq vsphere.upload_ssh_key my.esxi.host root bad\-password ssh_key_file=\(aq/etc/salt/my_keys/my_key.pub\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.vmotion_disable(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True)
Disable vMotion for a given host or list of host_names.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to
tell vCenter which hosts should disable VMotion.
.sp
If host_names is not provided, VMotion will be disabled for the \fBhost\fP
location instead. This is useful for when service instance connection
information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.vmotion_disable my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.vmotion_disable my.vcenter.location root bad\-password         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.vmotion_enable(host, username, password, protocol=None, port=None, host_names=None, device=\(aqvmk0\(aq, verify_ssl=True)
Enable vMotion for a given host or list of host_names.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to
tell vCenter which hosts should enable VMotion.
.sp
If host_names is not provided, VMotion will be enabled for the \fBhost\fP
location instead. This is useful for when service instance connection
information is used for a single ESXi host.
.TP
.B device
The device that uniquely identifies the VirtualNic that will be used for
VMotion for each host. Defaults to \fBvmk0\fP\&.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.vmotion_enable my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.vmotion_enable my.vcenter.location root bad\-password         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.vsan_add_disks(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True)
Add any VSAN\-eligible disks to the VSAN System for the given host or list of host_names.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to
tell vCenter which hosts need to add any VSAN\-eligible disks to the host\(aqs
VSAN system.
.sp
If host_names is not provided, VSAN\-eligible disks will be added to the hosts\(aqs
VSAN system for the \fBhost\fP location instead. This is useful for when service
instance connection information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.vsan_add_disks my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.vsan_add_disks my.vcenter.location root bad\-password         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.vsan_disable(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True)
Disable VSAN for a given host or list of host_names.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to
tell vCenter which hosts should disable VSAN.
.sp
If host_names is not provided, VSAN will be disabled for the \fBhost\fP
location instead. This is useful for when service instance connection
information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.vsan_disable my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.vsan_disable my.vcenter.location root bad\-password         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.vsphere.vsan_enable(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True)
Enable VSAN for a given host or list of host_names.
.INDENT 7.0
.TP
.B host
The location of the host.
.TP
.B username
The username used to login to the host, such as \fBroot\fP\&.
.TP
.B password
The password used to login to the host.
.TP
.B protocol
Optionally set to alternate protocol if the host is not using the default
protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the host is not using the default
port. Default port is \fB443\fP\&.
.TP
.B host_names
List of ESXi host names. When the host, username, and password credentials
are provided for a vCenter Server, the host_names argument is required to
tell vCenter which hosts should enable VSAN.
.sp
If host_names is not provided, VSAN will be enabled for the \fBhost\fP
location instead. This is useful for when service instance connection
information is used for a single ESXi host.
.TP
.B verify_ssl
Verify the SSL certificate. Default: True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Used for single ESXi host connection information
salt \(aq*\(aq vsphere.vsan_enable my.esxi.host root bad\-password

# Used for connecting to a vCenter Server
salt \(aq*\(aq vsphere.vsan_enable my.vcenter.location root bad\-password         host_names=\(aq[esxi\-1.host.com, esxi\-2.host.com]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.webutil
.sp
Support for htpasswd command. Requires the apache2\-utils package for Debian\-based distros.
.sp
New in version 2014.1.0.

.sp
The functions here will load inside the webutil module. This allows other
functions that don\(aqt use htpasswd to use the webutil module name.
.INDENT 0.0
.TP
.B salt.modules.webutil.useradd(pwfile, user, password, opts=\(aq\(aq, runas=None)
Add a user to htpasswd file using the htpasswd command. If the htpasswd
file does not exist, it will be created.
.INDENT 7.0
.TP
.B pwfile
Path to htpasswd file
.TP
.B user
User name
.TP
.B password
User password
.TP
.B opts
Valid options that can be passed are:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fIn\fP  Don\(aqt update file; display results on stdout.
.IP \(bu 2
\fIm\fP  Force MD5 encryption of the password (default).
.IP \(bu 2
\fId\fP  Force CRYPT encryption of the password.
.IP \(bu 2
\fIp\fP  Do not encrypt the password (plaintext).
.IP \(bu 2
\fIs\fP  Force SHA encryption of the password.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B runas
The system user to run htpasswd command with
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq webutil.useradd /etc/httpd/htpasswd larry badpassword
salt \(aq*\(aq webutil.useradd /etc/httpd/htpasswd larry badpass opts=ns
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.webutil.userdel(pwfile, user, runas=None, all_results=False)
Delete a user from the specified htpasswd file.
.INDENT 7.0
.TP
.B pwfile
Path to htpasswd file
.TP
.B user
User name
.TP
.B runas
The system user to run htpasswd command with
.TP
.B all_results
Return stdout, stderr, and retcode, not just stdout
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq webutil.userdel /etc/httpd/htpasswd larry
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.webutil.verify(pwfile, user, password, opts=\(aq\(aq, runas=None)
Return True if the htpasswd file exists, the user has an entry, and their
password matches.
.INDENT 7.0
.TP
.B pwfile
Fully qualified path to htpasswd file
.TP
.B user
User name
.TP
.B password
User password
.TP
.B opts
Valid options that can be passed are:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fIm\fP  Force MD5 encryption of the password (default).
.IP \(bu 2
\fId\fP  Force CRYPT encryption of the password.
.IP \(bu 2
\fIp\fP  Do not encrypt the password (plaintext).
.IP \(bu 2
\fIs\fP  Force SHA encryption of the password.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B runas
The system user to run htpasswd command with
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq webutil.verify /etc/httpd/htpasswd larry maybepassword
salt \(aq*\(aq webutil.verify /etc/httpd/htpasswd larry maybepassword opts=ns
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_appx
.SS Manage provisioned apps
.sp
New in version 3007.0.

.sp
Provisioned apps are part of the image and are installed for every user the
first time the user logs on. Provisioned apps are also updated and sometimes
reinstalled when the system is updated.
.sp
Apps removed with this module will remove the app for all users and deprovision
the app. Deprovisioned apps will neither be installed for new users nor will
they be upgraded.
.sp
An app removed with this module can only be re\-provisioned on the machine, but
it can\(aqt be re\-installed for all users. Also, once a package has been
deprovisioned, the only way to reinstall it is to download the package. This is
difficult. The steps are outlined below:
.INDENT 0.0
.IP 1. 3
.INDENT 3.0
.TP
.B Obtain the Microsoft Store URL for the app:
.INDENT 7.0
.IP \(bu 2
Open the page for the app in the Microsoft Store
.IP \(bu 2
Click the share button and copy the URL
.UNINDENT
.UNINDENT
.IP 2. 3
.INDENT 3.0
.TP
.B Look up the packages on \fI\%https://store.rg\-adguard.net/\fP:
.INDENT 7.0
.IP \(bu 2
Ensure \fBURL (link)\fP is selected in the first dropdown
.IP \(bu 2
Paste the URL in the search field
.IP \(bu 2
Ensure Retail is selected in the 2nd dropdown
.IP \(bu 2
Click the checkmark button
.UNINDENT
.UNINDENT
.UNINDENT
.sp
This should return a list of URLs for the package and all dependencies for all
architectures. Download the package and all dependencies for your system
architecture. These will usually have one of the following file extensions:
.INDENT 0.0
.IP \(bu 2
\fB\&.appx\fP
.IP \(bu 2
\fB\&.appxbundle\fP
.IP \(bu 2
\fB\&.msix\fP
.IP \(bu 2
\fB\&.msixbundle\fP
.UNINDENT
.sp
Dependencies will need to be installed first.
.sp
Not all packages can be found this way, but it seems like most of them can.
.sp
Use the \fBappx.install\fP function to provision the new app.
.INDENT 0.0
.TP
.B salt.modules.win_appx.install(package)
This function uses \fBdism\fP to provision a package. This means that it will
be made a part of the online image and added to new users on the system. If
a package has dependencies, those must be installed first.
.sp
If a package installed using this function has been deprovisioned
previously, the registry entry marking it as deprovisioned will be removed.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
There is no \fBappx.present\fP state. Instead, use the
\fBdism.provisioned_package_installed\fP state.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBpackage\fP (\fI\%str\fP) \-\-
.sp
The full path to the package to install. Can be one of the
following:
.INDENT 7.0
.IP \(bu 2
\fB\&.appx\fP or \fB\&.appxbundle\fP
.IP \(bu 2
\fB\&.msix\fP or \fB\&.msixbundle\fP
.IP \(bu 2
\fB\&.ppkg\fP
.UNINDENT

.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq appx.install \(dqC:\eTemp\eMicrosoft.ZuneMusic.msixbundle\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_appx.list_(query=None, field=\(aqName\(aq, include_store=False, frameworks=False, bundles=True)
Get a list of Microsoft Store packages installed on the system.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBquery\fP (\fI\%str\fP) \-\-
.sp
The query string to use to filter packages to be listed. The string
can match multiple packages. \fBNone\fP will return all packages. Here
are some example strings:
.INDENT 2.0
.IP \(bu 2
\fB*teams*\fP \- Returns Microsoft Teams
.IP \(bu 2
\fB*zune*\fP \- Returns Windows Media Player and ZuneVideo
.IP \(bu 2
\fB*zuneMusic*\fP \- Only returns Windows Media Player
.IP \(bu 2
\fB*xbox*\fP \- Returns all xbox packages, there are 5 by default
.IP \(bu 2
\fB*\fP \- Returns everything but the Microsoft Store, unless
\fBinclude_store=True\fP
.UNINDENT

.IP \(bu 2
\fBfield\fP (\fI\%str\fP) \-\-
.sp
This function returns a list of packages on the system. It can
display a short name or a full name. If \fBNone\fP is passed, a
dictionary will be returned with some common fields. The default is
\fBName\fP\&. Valid options are any fields returned by the powershell
command \fBGet\-AppxPackage\fP\&. Here are some useful fields:
.INDENT 2.0
.IP \(bu 2
Name
.IP \(bu 2
Version
.IP \(bu 2
PackageFullName
.IP \(bu 2
PackageFamilyName
.UNINDENT

.IP \(bu 2
\fBinclude_store\fP (\fI\%bool\fP) \-\- Include the Microsoft Store in the results. Default is \fBFalse\fP
.IP \(bu 2
\fBframeworks\fP (\fI\%bool\fP) \-\- Include frameworks in the results. Default is \fBFalse\fP
.IP \(bu 2
\fBbundles\fP (\fI\%bool\fP) \-\- If \fBTrue\fP, this will return application bundles only. If
\fBFalse\fP, this will return individual packages only, even if they
are part of a bundle.
.UNINDENT
.TP
.B Returns
A list of packages ordered by the string passed in field
list: A list of dictionaries of package information if field is \fBNone\fP
.TP
.B Return type
\fI\%list\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- If an error is encountered retrieving packages
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# List installed apps that contain the word \(dqcandy\(dq
salt \(aq*\(aq appx.list *candy*

# Return more information about the package
salt \(aq*\(aq appx.list *candy* field=None

# List all installed apps, including the Microsoft Store
salt \(aq*\(aq appx.list include_store=True

# List all installed apps, including frameworks
salt \(aq*\(aq appx.list frameworks=True

# List all installed apps that are bundles
salt \(aq*\(aq appx.list bundles=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_appx.list_deprovisioned(query=None)
When an app is deprovisioned, a registry key is created that will keep it
from being reinstalled during a major system update. This function returns a
list of keys for apps that have been deprovisioned.
.INDENT 7.0
.TP
.B Parameters
\fBquery\fP (\fI\%str\fP) \-\-
.sp
The query string to use to filter packages to be listed. The string
can match multiple packages. \fBNone\fP will return all packages. Here
are some example strings:
.INDENT 7.0
.IP \(bu 2
\fB*teams*\fP \- Returns Microsoft Teams
.IP \(bu 2
\fB*zune*\fP \- Returns Windows Media Player and ZuneVideo
.IP \(bu 2
\fB*zuneMusic*\fP \- Only returns Windows Media Player
.IP \(bu 2
\fB*xbox*\fP \- Returns all xbox packages, there are 5 by default
.IP \(bu 2
\fB*\fP \- Returns everything but the Microsoft Store, unless
\fBinclude_store=True\fP
.UNINDENT

.TP
.B Returns
A list of packages matching the query criteria
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq appx.list_deprovisioned *zune*
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_appx.remove(query=None, include_store=False, frameworks=False, deprovision_only=False)
Removes Microsoft Store packages from the system. If the package is part of
a bundle, the entire bundle will be removed.
.sp
This function removes the package for all users on the system. It also
deprovisions the package so that it isn\(aqt re\-installed by later system
updates. To only deprovision a package and not remove it for all users, set
\fBdeprovision_only=True\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBquery\fP (\fI\%str\fP) \-\-
.sp
The query string to use to select the packages to be removed. If the
string matches multiple packages, they will all be removed. Here are
some example strings:
.INDENT 2.0
.IP \(bu 2
\fB*teams*\fP \- Remove Microsoft Teams
.IP \(bu 2
\fB*zune*\fP \- Remove Windows Media Player and ZuneVideo
.IP \(bu 2
\fB*zuneMusic*\fP \- Only remove Windows Media Player
.IP \(bu 2
\fB*xbox*\fP \- Remove all xbox packages, there are 5 by default
.IP \(bu 2
\fB*\fP \- Remove everything but the Microsoft Store, unless
\fBinclude_store=True\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
Use the \fBappx.list\fP function to make sure your query is
returning what you expect. Then use the same query to remove
those packages
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBinclude_store\fP (\fI\%bool\fP) \-\- Include the Microsoft Store in the results of the query to be
removed. Use this with caution. It is difficult to reinstall the
Microsoft Store once it has been removed with this function. Default
is \fBFalse\fP
.IP \(bu 2
\fBframeworks\fP (\fI\%bool\fP) \-\- Include frameworks in the results of the query to be removed.
Default is \fBFalse\fP
.IP \(bu 2
\fBdeprovision_only\fP (\fI\%bool\fP) \-\- Only deprovision the package. The package will be removed from the
current user and added to the list of deprovisioned packages. The
package will not be re\-installed in future system updates. New users
of the system will not have the package installed. However, the
package will still be installed for existing users. Default is
\fBFalse\fP
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, \fBNone\fP if no packages found
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- On errors encountered removing the package
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq appx.remove *candy*
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_auditpol
.sp
A salt module for modifying the audit policies on the machine
.sp
Though this module does not set group policy for auditing, it displays how all
auditing configuration is applied on the machine, either set directly or via
local or domain group policy.
.sp
New in version 2018.3.4.

.sp
New in version 2019.2.1.

.sp
This module allows you to view and modify the audit settings as they are applied
on the machine. The audit settings are broken down into nine categories:
.INDENT 0.0
.IP \(bu 2
Account Logon
.IP \(bu 2
Account Management
.IP \(bu 2
Detailed Tracking
.IP \(bu 2
DS Access
.IP \(bu 2
Logon/Logoff
.IP \(bu 2
Object Access
.IP \(bu 2
Policy Change
.IP \(bu 2
Privilege Use
.IP \(bu 2
System
.UNINDENT
.sp
The \fBget_settings\fP function will return the subcategories for all nine of
the above categories in one dictionary along with their auditing status.
.sp
To modify a setting you only need to specify the subcategory name and the value
you wish to set. Valid settings are:
.INDENT 0.0
.IP \(bu 2
No Auditing
.IP \(bu 2
Success
.IP \(bu 2
Failure
.IP \(bu 2
Success and Failure
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Get current state of all audit settings
salt * auditpol.get_settings

# Get the current state of all audit settings in the \(dqAccount Logon\(dq
# category
salt * auditpol.get_settings category=\(dqAccount Logon\(dq

# Get current state of the \(dqCredential Validation\(dq setting
salt * auditpol.get_setting name=\(dqCredential Validation\(dq

# Set the state of the \(dqCredential Validation\(dq setting to Success and
# Failure
salt * auditpol.set_setting name=\(dqCredential Validation\(dq value=\(dqSuccess and Failure\(dq

# Set the state of the \(dqCredential Validation\(dq setting to No Auditing
salt * auditpol.set_setting name=\(dqCredential Validation\(dq value=\(dqNo Auditing\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_auditpol.get_setting(name)
Get the current configuration for the named audit setting
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the setting to retrieve
.TP
.B Returns
The current configuration for the named setting
.TP
.B Return type
\fI\%str\fP
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%KeyError\fP \-\- On invalid setting name
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If an error is encountered retrieving the settings
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Get current state of the \(dqCredential Validation\(dq setting
salt * auditpol.get_setting \(dqCredential Validation\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_auditpol.get_settings(category=\(aqAll\(aq)
Get the current configuration for all audit settings specified in the
category
.INDENT 7.0
.TP
.B Parameters
\fBcategory\fP (\fI\%str\fP) \-\-
.sp
One of the nine categories to return. Can also be \fBAll\fP to return
the settings for all categories. Valid options are:
.INDENT 7.0
.IP \(bu 2
Account Logon
.IP \(bu 2
Account Management
.IP \(bu 2
Detailed Tracking
.IP \(bu 2
DS Access
.IP \(bu 2
Logon/Logoff
.IP \(bu 2
Object Access
.IP \(bu 2
Policy Change
.IP \(bu 2
Privilege Use
.IP \(bu 2
System
.IP \(bu 2
All
.UNINDENT
.sp
Default value is \fBAll\fP

.TP
.B Returns
.INDENT 7.0
.TP
.B A dictionary containing all subcategories for the specified
category along with their current configuration
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%KeyError\fP \-\- On invalid category
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If an error is encountered retrieving the settings
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Get current state of all audit settings
salt * auditipol.get_settings

# Get the current state of all audit settings in the \(dqAccount Logon\(dq
# category
salt * auditpol.get_settings \(dqAccount Logon\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_auditpol.set_setting(name, value)
Set the configuration for the named audit setting
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the setting to configure
.IP \(bu 2
\fBvalue\fP (\fI\%str\fP) \-\-
.sp
The configuration for the named value. Valid options are:
.INDENT 2.0
.IP \(bu 2
No Auditing
.IP \(bu 2
Success
.IP \(bu 2
Failure
.IP \(bu 2
Success and Failure
.UNINDENT

.UNINDENT
.TP
.B Returns
True if successful
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%KeyError\fP \-\- On invalid \fBname\fP or \fBvalue\fP
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If an error is encountered modifying the setting
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Set the state of the \(dqCredential Validation\(dq setting to Success and
# Failure
salt * auditpol.set_setting \(dqCredential Validation\(dq \(dqSuccess and Failure\(dq

# Set the state of the \(dqCredential Validation\(dq setting to No Auditing
salt * auditpol.set_setting \(dqCredential Validation\(dq \(dqNo Auditing\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_autoruns
.sp
Module for listing programs that automatically run on startup
(very alpha...not tested on anything but my Win 7x64)
.INDENT 0.0
.TP
.B salt.modules.win_autoruns.list_()
Get a list of automatically running programs
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq autoruns.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_certutil
.sp
This module allows you to install certificates into the windows certificate
manager.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq certutil.add_store salt://cert.cer \(dqTrustedPublisher\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_certutil.add_store(source, store, retcode=False, saltenv=\(aqbase\(aq)
Add the cert to the given Certificate Store
.INDENT 7.0
.TP
.B source (str):
The source certificate file. This is either the path to a local file or
a file from the file server in the form of \fBsalt://path/to/file\fP
.TP
.B store (str):
The certificate store to add the certificate to
.TP
.B retcode (bool):
If \fBTrue\fP, return the retcode instead of stdout. Default is \fBFalse\fP
.TP
.B saltenv (str):
The salt environment to use. This is ignored if the path is local
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq certutil.add_store salt://cert.cer TrustedPublisher
salt \(aq*\(aq certutil.add_store C:\epath\eto\elocal.cer TrustedPublisher
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_certutil.del_store(source, store, retcode=False, saltenv=\(aqbase\(aq)
Delete the cert from the given Certificate Store
.INDENT 7.0
.TP
.B source (str):
The source certificate file. This is either the path to a local file or
a file from the file server in the form of \fBsalt://path/to/file\fP
.TP
.B store (str):
The certificate store to delete the certificate from
.TP
.B retcode (bool):
If \fBTrue\fP, return the retcode instead of stdout. Default is \fBFalse\fP
.TP
.B saltenv (str):
The salt environment to use. This is ignored if the path is local
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq certutil.del_store salt://cert.cer TrustedPublisher
salt \(aq*\(aq certutil.del_store C:\epath\eto\elocal.cer TrustedPublisher
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_certutil.get_cert_serial(cert_file, saltenv=\(aqbase\(aq)
Get the serial number of a certificate file
.INDENT 7.0
.TP
.B cert_file (str):
The certificate file to find the serial for. Can be a local file or a
a file on the file server (\fBsalt://\fP)
.UNINDENT
.INDENT 7.0
.TP
.B Returns
The serial number of the certificate if found, otherwise None
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq certutil.get_cert_serial <certificate name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_certutil.get_stored_cert_serials(store)
Get all of the certificate serials in the specified store
.INDENT 7.0
.TP
.B store (str):
The store to get all the certificate serials from
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A list of serial numbers found, or an empty list if none found
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq certutil.get_stored_cert_serials <store>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_dacl
.sp
Manage DACLs on Windows
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
winreg Python module
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dacl.add_ace(path, objectType, user, permission, acetype, propagation)
add an ace to an object
.sp
path:  path to the object (i.e. c:\etemp\efile, HKEY_LOCAL_MACHINE\eSOFTWARE\eKEY, etc)
user: user to add
permission:  permissions for the user
acetype:  either allow/deny for each user/permission (ALLOW, DENY)
propagation: how the ACE applies to children for Registry Keys and Directories(KEY, KEY&SUBKEYS, SUBKEYS)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
allow domain\efakeuser full control on HKLM\e\eSOFTWARE\e\esomekey, propagate to this key and subkeys
    salt \(aqmyminion\(aq win_dacl.add_ace \(aqHKEY_LOCAL_MACHINE\e\eSOFTWARE\e\esomekey\(aq \(aqRegistry\(aq \(aqdomain\efakeuser\(aq \(aqFULLCONTROL\(aq \(aqALLOW\(aq \(aqKEY&SUBKEYS\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dacl.check_ace(path, objectType, user, permission=None, acetype=None, propagation=None, exactPermissionMatch=False)
Checks a path to verify the ACE (access control entry) specified exists
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP \-\- path to the file/reg key
.IP \(bu 2
\fBobjectType\fP \-\- The type of object (FILE, DIRECTORY, REGISTRY)
.IP \(bu 2
\fBuser\fP \-\- user that the ACL is for
.IP \(bu 2
\fBpermission\fP \-\- permission to test for (READ, FULLCONTROL, etc)
.IP \(bu 2
\fBacetype\fP \-\- the type of ACE (ALLOW or DENY)
.IP \(bu 2
\fBpropagation\fP \-\- the propagation type of the ACE (FILES, FOLDERS, KEY, KEY&SUBKEYS, SUBKEYS, etc)
.IP \(bu 2
\fBexactPermissionMatch\fP \-\- the ACL must match exactly, IE if READ is specified, the user must have READ exactly and not FULLCONTROL (which also has the READ permission obviously)
.UNINDENT
.UNINDENT
.sp
Returns (dict): \(aqExists\(aq true if the ACE exists, false if it does not
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq win_dacl.check_ace c:  emp directory <username> fullcontrol
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dacl.check_inheritance(path, objectType, user=None)
Check a specified path to verify if inheritance is enabled
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP \-\- path of the registry key or file system object to check
.IP \(bu 2
\fBobjectType\fP \-\- The type of object (FILE, DIRECTORY, REGISTRY)
.IP \(bu 2
\fBuser\fP \-\- if provided, will consider only the ACEs for that user
.UNINDENT
.UNINDENT
.sp
Returns (bool): \(aqInheritance\(aq of True/False
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq win_dacl.check_inheritance c:  emp directory <username>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.win_dacl.daclConstants
DACL constants used throughout the module
.INDENT 7.0
.TP
.B getAceTypeBit(t)
returns the acetype bit of a text value
.UNINDENT
.INDENT 7.0
.TP
.B getAceTypeText(t)
returns the textual representation of a acetype bit
.UNINDENT
.INDENT 7.0
.TP
.B getObjectTypeBit(t)
returns the bit value of the string object type
.UNINDENT
.INDENT 7.0
.TP
.B getPermissionBit(t, m)
returns a permission bit of the string permission value for the specified object type
.UNINDENT
.INDENT 7.0
.TP
.B getPermissionText(t, m)
returns the permission textual representation of a specified permission bit/object type
.UNINDENT
.INDENT 7.0
.TP
.B getPropagationBit(t, p)
returns the propagation bit of a text value
.UNINDENT
.INDENT 7.0
.TP
.B getPropagationText(t, p)
returns the textual representation of a propagation bit
.UNINDENT
.INDENT 7.0
.TP
.B getSecurityHkey(s)
returns the necessary string value for an HKEY for the win32security module
.UNINDENT
.INDENT 7.0
.TP
.B processPath(path, objectType)
.INDENT 7.0
.TP
.B processes a path/object type combo and returns:
registry types with the correct HKEY text representation
files/directories with environment variables expanded
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dacl.disable_inheritance(path, objectType, copy=True)
Disable inheritance on an object
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP \-\- The path to the object
.IP \(bu 2
\fBobjectType\fP \-\- The type of object (FILE, DIRECTORY, REGISTRY)
.IP \(bu 2
\fBcopy\fP \-\- True will copy the Inherited ACEs to the DACL before disabling inheritance
.UNINDENT
.UNINDENT
.sp
Returns (dict): A dictionary containing the results
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq win_dacl.disable_inheritance c:        emp directory
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dacl.enable_inheritance(path, objectType, clear=False)
enable/disable inheritance on an object
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP \-\- The path to the object
.IP \(bu 2
\fBobjectType\fP \-\- The type of object (FILE, DIRECTORY, REGISTRY)
.IP \(bu 2
\fBclear\fP \-\- True will remove non\-Inherited ACEs from the ACL
.UNINDENT
.UNINDENT
.sp
Returns (dict): A dictionary containing the results
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq win_dacl.enable_inheritance c: emp directory
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dacl.get(path, objectType, user=None)
Get the ACL of an object. Will filter by user if one is provided.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP \-\- The path to the object
.IP \(bu 2
\fBobjectType\fP \-\- The type of object (FILE, DIRECTORY, REGISTRY)
.IP \(bu 2
\fBuser\fP \-\- A user name to filter by
.UNINDENT
.UNINDENT
.sp
Returns (dict): A dictionary containing the ACL
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq win_dacl.get c:        emp directory
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dacl.rm_ace(path, objectType, user, permission=None, acetype=None, propagation=None)
remove an ace to an object
.sp
path:  path to the object (i.e. c:\etemp\efile, HKEY_LOCAL_MACHINE\eSOFTWARE\eKEY, etc)
user: user to remove
permission:  permissions for the user
acetypes:  either allow/deny for each user/permission (ALLOW, DENY)
propagation: how the ACE applies to children for Registry Keys and Directories(KEY, KEY&SUBKEYS, SUBKEYS)
.sp
If any of the optional parameters are omitted (or set to None) they act as wildcards.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
remove allow domain\efakeuser full control on HKLM\e\eSOFTWARE\e\esomekey propagated to this key and subkeys
    salt \(aqmyminion\(aq win_dacl.rm_ace \(aqRegistry\(aq \(aqHKEY_LOCAL_MACHINE\e\eSOFTWARE\e\esomekey\(aq \(aqdomain\efakeuser\(aq \(aqFULLCONTROL\(aq \(aqALLOW\(aq \(aqKEY&SUBKEYS\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_disk
.sp
Module for gathering disk information on Windows
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
win32api Python module
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_disk.usage()
Return usage information for volumes mounted on this minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq disk.usage
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_dism
.sp
Install features/packages for Windows using DISM, which is useful for minions
not running server versions\ of Windows. Some functions are only available on
Windows 10.
.INDENT 0.0
.TP
.B salt.modules.win_dism.add_capability(capability, source=None, limit_access=False, image=None, restart=False)
Install a capability
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcapability\fP (\fI\%str\fP) \-\- The capability to install
.IP \(bu 2
\fBsource\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The optional source of the capability. Default
is set by group policy and can be Windows Update.
.IP \(bu 2
\fBlimit_access\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Prevent DISM from contacting Windows
Update for the source package
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the install
.UNINDENT
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%NotImplementedError\fP \-\- For all versions of Windows that are not Windows 10
.IP \(bu 2
\fBand later. Server editions\fP\fB of \fP\fBWindows use ServerManager instead.\fP \-\-
.UNINDENT
.TP
.B Returns
A dictionary containing the results of the command
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dism.add_capability Tools.Graphics.DirectX~~~~0.0.1.0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.add_feature(feature, package=None, source=None, limit_access=False, enable_parent=False, image=None, restart=False)
Install a feature using DISM
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfeature\fP (\fI\%str\fP) \-\- The feature to install
.IP \(bu 2
\fBpackage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The parent package for the feature. You do not
have to specify the package if it is the Windows Foundation Package.
Otherwise, use package to specify the parent package of the feature
.IP \(bu 2
\fBsource\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The optional source of the capability. Default
is set by group policy and can be Windows Update
.IP \(bu 2
\fBlimit_access\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Prevent DISM from contacting Windows
Update for the source package
.IP \(bu 2
\fBenable_parent\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- True will enable all parent features of
the specified feature
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the install
.UNINDENT
.TP
.B Returns
A dictionary containing the results of the command
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dism.add_feature NetFx3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.add_package(package, ignore_check=False, prevent_pending=False, image=None, restart=False)
Install a package using DISM
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpackage\fP (\fI\%str\fP) \-\-
.sp
The package to install. Can be a .cab file, a .msu file, or a folder
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
An \fI\&.msu\fP package is supported only when the target image is
offline, either mounted or applied.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBignore_check\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Skip installation of the package if the applicability checks fail
.IP \(bu 2
\fBprevent_pending\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Skip the installation of the package if there are pending online
actions
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline Windows image. If
\fBNone\fP is passed, the running operating system is targeted.
Default is None.
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the install
.UNINDENT
.TP
.B Returns
A dictionary containing the results of the command
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dism.add_package C:\ePackages\epackage.cab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.add_provisioned_package(package, image=None, restart=False)
Provision a package using DISM. A provisioned package will install for new
users on the system. It will also be reinstalled on each user if the system
is updated.
.sp
New in version 3007.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpackage\fP (\fI\%str\fP) \-\-
.sp
The package to install. Can be one of the following:
.INDENT 2.0
.IP \(bu 2
\fB\&.appx\fP or \fB\&.appxbundle\fP
.IP \(bu 2
\fB\&.msix\fP or \fB\&.msixbundle\fP
.IP \(bu 2
\fB\&.ppkg\fP
.UNINDENT

.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline Windows image. If
\fBNone\fP is passed, the running operating system is targeted.
Default is \fBNone\fP\&.
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the installation. Default is
\fBFalse\fP
.UNINDENT
.TP
.B Returns
A dictionary containing the results of the command
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dism.add_provisioned_package C:\ePackages\epackage.appx
salt \(aq*\(aq dism.add_provisioned_package C:\ePackages\epackage.appxbundle
salt \(aq*\(aq dism.add_provisioned_package C:\ePackages\epackage.msix
salt \(aq*\(aq dism.add_provisioned_package C:\ePackages\epackage.msixbundle
salt \(aq*\(aq dism.add_provisioned_package C:\ePackages\epackage.ppkg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.available_capabilities(image=None)
List the capabilities available on the system
.INDENT 7.0
.TP
.B Parameters
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%NotImplementedError\fP \-\- For all versions of Windows that are not Windows 10
.IP \(bu 2
\fBand later. Server editions\fP\fB of \fP\fBWindows use ServerManager instead.\fP \-\-
.UNINDENT
.TP
.B Returns
A list of available capabilities
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dism.installed_capabilities
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.available_features(image=None)
List the features available on the system
.INDENT 7.0
.TP
.B Parameters
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.TP
.B Returns
A list of available features
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dism.available_features
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.get_capabilities(image=None)
List all capabilities on the system
.INDENT 7.0
.TP
.B Parameters
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%NotImplementedError\fP \-\- For all versions of Windows that are not Windows 10
.IP \(bu 2
\fBand later. Server editions\fP\fB of \fP\fBWindows use ServerManager instead.\fP \-\-
.UNINDENT
.TP
.B Returns
A list of capabilities
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dism.get_capabilities
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.get_features(package=None, image=None)
List features on the system or in a package
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpackage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\-
.sp
The full path to the package. Can be either a
\&.cab file or a folder. Should point to the original source of the
package, not to where the file is installed. You cannot use this
command to get package information for .msu files
.sp
This can also be the name of a package as listed in
\fBdism.installed_packages\fP

.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.UNINDENT
.TP
.B Returns
A list of features
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Return all features on the system
salt \(aq*\(aq dism.get_features

# Return all features in package.cab
salt \(aq*\(aq dism.get_features C:\epackages\epackage.cab

# Return all features in the calc package
salt \(aq*\(aq dism.get_features Microsoft.Windows.Calc.Demo~6595b6144ccf1df~x86~en~1.0.0.0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.get_kb_package_name(kb, image=None)
Get the actual package name on the system based on the KB name
.sp
New in version 3006.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkb\fP (\fI\%str\fP) \-\- The name of the KB to remove. Can also be just the KB number
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.UNINDENT
.TP
.B Returns
The name of the package found on the system
None: If the package is not installed on the system
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Get the package name for KB1231231
salt \(aq*\(aq dism.get_kb_package_name KB1231231

# Get the package name for KB1231231 using just the number
salt \(aq*\(aq dism.get_kb_package_name 1231231
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.installed_capabilities(image=None)
List the capabilities installed on the system
.INDENT 7.0
.TP
.B Parameters
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%NotImplementedError\fP \-\- For all versions of Windows that are not Windows 10
.IP \(bu 2
\fBand later. Server editions\fP\fB of \fP\fBWindows use ServerManager instead.\fP \-\-
.UNINDENT
.TP
.B Returns
A list of installed capabilities
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dism.installed_capabilities
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.installed_features(image=None)
List the features installed on the system
.INDENT 7.0
.TP
.B Parameters
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.TP
.B Returns
A list of installed features
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dism.installed_features
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.installed_packages(image=None)
List the packages installed on the system
.INDENT 7.0
.TP
.B Parameters
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.TP
.B Returns
A list of installed packages
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dism.installed_packages
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.package_info(package, image=None)
Display information about a package
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpackage\fP (\fI\%str\fP) \-\- The full path to the package. Can be either a .cab file
or a folder. Should point to the original source of the package, not
to where the file is installed. You cannot use this command to get
package information for .msu files
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.UNINDENT
.TP
.B Returns
A dictionary containing the results of the command
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dism.package_info C:\epackages\epackage.cab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.provisioned_packages(image=None)
List the packages installed on the system
.sp
New in version 3007.0.

.INDENT 7.0
.TP
.B Parameters
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.TP
.B Returns
A list of installed packages
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dism.installed_packages
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.remove_capability(capability, image=None, restart=False)
Uninstall a capability
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcapability\fP (\fI\%str\fP) \-\- The capability to be removed
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the install
.UNINDENT
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%NotImplementedError\fP \-\- For all versions of Windows that are not Windows 10
.IP \(bu 2
\fBand later. Server editions\fP\fB of \fP\fBWindows use ServerManager instead.\fP \-\-
.UNINDENT
.TP
.B Returns
A dictionary containing the results of the command
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dism.remove_capability Tools.Graphics.DirectX~~~~0.0.1.0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.remove_feature(feature, remove_payload=False, image=None, restart=False)
Disables the feature.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfeature\fP (\fI\%str\fP) \-\- The feature to uninstall
.IP \(bu 2
\fBremove_payload\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Remove the feature\(aqs payload. Must
supply source when enabling in the future.
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the install
.UNINDENT
.TP
.B Returns
A dictionary containing the results of the command
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dism.remove_feature NetFx3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.remove_kb(kb, image=None, restart=False)
Remove a package by passing a KB number. This searches the installed
packages to get the full package name of the KB. It then calls the
\fBdism.remove_package\fP function to remove the package.
.sp
New in version 3006.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkb\fP (\fI\%str\fP) \-\- The name of the KB to remove. Can also be just the KB number
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the
uninstall
.UNINDENT
.TP
.B Returns
A dictionary containing the results of the command
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Remove the KB5007575 just passing the number
salt \(aq*\(aq dism.remove_kb 5007575

# Remove the KB5007575 just passing the full name
salt \(aq*\(aq dism.remove_kb KB5007575
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dism.remove_package(package, image=None, restart=False)
Uninstall a package
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpackage\fP (\fI\%str\fP) \-\- The full path to the package. Can be either a .cab file
or a folder. Should point to the original source of the package, not
to where the file is installed. This can also be the name of a
package as listed in \fBdism.installed_packages\fP
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline
Windows image. If \fINone\fP is passed, the running operating system is
targeted. Default is None.
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the
uninstall
.UNINDENT
.TP
.B Returns
A dictionary containing the results of the command
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Remove the Calc Package
salt \(aq*\(aq dism.remove_package Microsoft.Windows.Calc.Demo~6595b6144ccf1df~x86~en~1.0.0.0

# Remove the package.cab (does not remove C:\epackages\epackage.cab)
salt \(aq*\(aq dism.remove_package C:\epackages\epackage.cab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_dns_client
.sp
Module for configuring DNS Client on Windows systems
.INDENT 0.0
.TP
.B salt.modules.win_dns_client.add_dns(ip, interface=\(aqLocal Area Connection\(aq, index=1)
Add the DNS server to the network interface
(index starts from 1)
.sp
Note: if the interface DNS is configured by DHCP, all the DNS servers will
be removed from the interface and the requested DNS will be the only one
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_dns_client.add_dns <ip> <interface> <index>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dns_client.dns_dhcp(interface=\(aqLocal Area Connection\(aq)
Configure the interface to get its DNS servers from the DHCP server
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_dns_client.dns_dhcp <interface>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dns_client.get_dns_config(interface=\(aqLocal Area Connection\(aq)
Get the type of DNS configuration (dhcp / static).
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinterface\fP (\fI\%str\fP) \-\- The name of the network interface. This is the
.IP \(bu 2
\fBdevice\fP (\fIDescription in the Network Connection Details for the\fP) \-\-
.UNINDENT
.TP
.B Returns
\fBTrue\fP if DNS is configured, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_dns_client.get_dns_config \(aqLocal Area Connection\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dns_client.get_dns_servers(interface=\(aqLocal Area Connection\(aq)
Return a list of the configured DNS servers of the specified interface
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinterface\fP (\fI\%str\fP) \-\- The name of the network interface. This is the name as
.IP \(bu 2
\fBConnections\fP (\fIit appears in the Control Panel under Network\fP) \-\-
.UNINDENT
.TP
.B Returns
A list of dns servers
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_dns_client.get_dns_servers \(aqLocal Area Connection\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dns_client.rm_dns(ip, interface=\(aqLocal Area Connection\(aq)
Remove the DNS server from the network interface
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_dns_client.rm_dns <ip> <interface>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_dsc
.sp
Module for working with Windows PowerShell DSC (Desired State Configuration)
.sp
This module is Alpha
.sp
This module applies DSC Configurations in the form of PowerShell scripts or
MOF (Managed Object Format) schema files.
.sp
Use the \fBpsget\fP module to manage PowerShell resources.
.sp
The idea is to leverage Salt to push DSC configuration scripts or MOF files to
the Minion.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
PowerShell 5.0
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dsc.apply_config(path, source=None, salt_env=\(aqbase\(aq)
Run an compiled DSC configuration (a folder containing a .mof file). The
folder can be cached from the salt master using the \fBsource\fP option.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- Local path to the directory that contains the .mof
configuration file to apply. Required.
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- Path to the directory that contains the .mof file on the
\fBfile_roots\fP\&. The source directory will be copied to the path
directory and then executed. If the path and source directories
differ, the source directory will be applied. If source is not
passed, the config located at \fBpath\fP will be applied. Optional.
.IP \(bu 2
\fBsalt_env\fP (\fI\%str\fP) \-\- The salt environment to use when copying your source.
Default is \(aqbase\(aq
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.sp
To apply a config that already exists on the system
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dsc.apply_config C:\e\eDSC\e\eWebSiteConfiguration
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To cache a configuration from the master and apply it:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dsc.apply_config C:\e\eDSC\e\eWebSiteConfiguration salt://dsc/configs/WebSiteConfiguration
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dsc.compile_config(path, source=None, config_name=None, config_data=None, config_data_source=None, script_parameters=None, salt_env=\(aqbase\(aq)
Compile a config from a PowerShell script (\fB\&.ps1\fP)
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- Path (local) to the script that will create the \fB\&.mof\fP
configuration file. If no source is passed, the file must exist
locally. Required.
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- Path to the script on \fBfile_roots\fP to cache at the
location specified by \fBpath\fP\&. The source file will be cached
locally and then executed. If source is not passed, the config
script located at \fBpath\fP will be compiled. Optional.
.IP \(bu 2
\fBconfig_name\fP (\fI\%str\fP) \-\- The name of the Configuration within the script to
apply. If the script contains multiple configurations within the
file a \fBconfig_name\fP must be specified. If the \fBconfig_name\fP is
not specified, the name of the file will be used as the
\fBconfig_name\fP to run. Optional.
.IP \(bu 2
\fBconfig_data\fP (\fI\%str\fP) \-\-
.sp
Configuration data in the form of a hash table that
will be passed to the \fBConfigurationData\fP parameter when the
\fBconfig_name\fP is compiled. This can be the path to a \fB\&.psd1\fP
file containing the proper hash table or the PowerShell code to
create the hash table.
.sp
New in version 2017.7.0.


.IP \(bu 2
\fBconfig_data_source\fP (\fI\%str\fP) \-\-
.sp
The path to the \fB\&.psd1\fP file on
\fBfile_roots\fP to cache at the location specified by
\fBconfig_data\fP\&. If this is specified, \fBconfig_data\fP must be a
local path instead of a hash table.
.sp
New in version 2017.7.0.


.IP \(bu 2
\fBscript_parameters\fP (\fI\%str\fP) \-\-
.sp
Any additional parameters expected by the
configuration script. These must be defined in the script itself.
.sp
New in version 2017.7.0.


.IP \(bu 2
\fBsalt_env\fP (\fI\%str\fP) \-\- The salt environment to use when copying the source.
Default is \(aqbase\(aq
.UNINDENT
.TP
.B Returns
A dictionary containing the results of the compilation
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.sp
To compile a config from a script that already exists on the system:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dsc.compile_config C:\e\eDSC\e\eWebsiteConfig.ps1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To cache a config script to the system from the master and compile it:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dsc.compile_config C:\e\eDSC\e\eWebsiteConfig.ps1 salt://dsc/configs/WebsiteConfig.ps1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dsc.get_config()
Get the current DSC Configuration
.INDENT 7.0
.TP
.B Returns
A dictionary representing the DSC Configuration on the machine
.TP
.B Return type
\fI\%dict\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- On failure
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dsc.get_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dsc.get_config_status()
Get the status of the current DSC Configuration
.INDENT 7.0
.TP
.B Returns
.INDENT 7.0
.TP
.B A dictionary representing the status of the current DSC
Configuration on the machine
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dsc.get_config_status
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dsc.get_lcm_config()
Get the current Local Configuration Manager settings
.INDENT 7.0
.TP
.B Returns
.INDENT 7.0
.TP
.B A dictionary representing the Local Configuration Manager settings
on the machine
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dsc.get_lcm_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dsc.remove_config(reset=False)
Remove the current DSC Configuration. Removes current, pending, and previous
dsc configurations.
.sp
New in version 2017.7.5.

.INDENT 7.0
.TP
.B Parameters
\fBreset\fP (\fI\%bool\fP) \-\-
.sp
Attempts to reset the DSC configuration by removing the following
from \fBC:\eWindows\eSystem32\eConfiguration\fP:
.INDENT 7.0
.IP \(bu 2
File: DSCStatusHistory.mof
.IP \(bu 2
File: DSCEngineCache.mof
.IP \(bu 2
Dir: ConfigurationStatus
.UNINDENT
.sp
Default is False
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
\fBremove_config\fP may fail to reset the DSC environment if any
of the files in the \fBConfigurationStatus\fP directory are in
use. If you wait a few minutes and run again, it may complete
successfully.
.UNINDENT
.UNINDENT

.TP
.B Returns
True if successful
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- On failure
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dsc.remove_config True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dsc.restore_config()
Reapplies the previous configuration.
.sp
New in version 2017.7.5.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The current configuration will be come the previous configuration. If
run a second time back\-to\-back it is like toggling between two configs.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
True if successfully restored
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- On failure
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dsc.restore_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dsc.run_config(path, source=None, config_name=None, config_data=None, config_data_source=None, script_parameters=None, salt_env=\(aqbase\(aq)
Compile a DSC Configuration in the form of a PowerShell script (.ps1) and
apply it. The PowerShell script can be cached from the master using the
\fBsource\fP option. If there is more than one config within the PowerShell
script, the desired configuration can be applied by passing the name in the
\fBconfig\fP option.
.sp
This command would be the equivalent of running \fBdsc.compile_config\fP
followed by \fBdsc.apply_config\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The local path to the PowerShell script that contains the
DSC Configuration. Required.
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- The path to the script on \fBfile_roots\fP to cache at the
location specified by \fBpath\fP\&. The source file will be cached
locally and then executed. If source is not passed, the config
script located at \fBpath\fP will be compiled. Optional.
.IP \(bu 2
\fBconfig_name\fP (\fI\%str\fP) \-\- The name of the Configuration within the script to
apply. If the script contains multiple configurations within the
file a \fBconfig_name\fP must be specified. If the \fBconfig_name\fP is
not specified, the name of the file will be used as the
\fBconfig_name\fP to run. Optional.
.IP \(bu 2
\fBconfig_data\fP (\fI\%str\fP) \-\-
.sp
Configuration data in the form of a hash table that
will be passed to the \fBConfigurationData\fP parameter when the
\fBconfig_name\fP is compiled. This can be the path to a \fB\&.psd1\fP
file containing the proper hash table or the PowerShell code to
create the hash table.
.sp
New in version 2017.7.0.


.IP \(bu 2
\fBconfig_data_source\fP (\fI\%str\fP) \-\-
.sp
The path to the \fB\&.psd1\fP file on
\fBfile_roots\fP to cache at the location specified by
\fBconfig_data\fP\&. If this is specified, \fBconfig_data\fP must be a
local path instead of a hash table.
.sp
New in version 2017.7.0.


.IP \(bu 2
\fBscript_parameters\fP (\fI\%str\fP) \-\-
.sp
Any additional parameters expected by the
configuration script. These must be defined in the script itself.
Note that these are passed to the script (the outermost scope), and
not to the dsc configuration inside the script (the inner scope).
.sp
New in version 2017.7.0.


.IP \(bu 2
\fBsalt_env\fP (\fI\%str\fP) \-\- The salt environment to use when copying the source.
Default is \(aqbase\(aq
.UNINDENT
.TP
.B Returns
True if successfully compiled and applied, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.sp
To compile a config from a script that already exists on the system:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dsc.run_config C:\e\eDSC\e\eWebsiteConfig.ps1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To cache a config script to the system from the master and compile it:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dsc.run_config C:\e\eDSC\e\eWebsiteConfig.ps1 salt://dsc/configs/WebsiteConfig.ps1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To cache a config script to the system from the master and compile it, passing in \fIscript_parameters\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dsc.run_config path=C:\e\eDSC\e\eWebsiteConfig.ps1 source=salt://dsc/configs/WebsiteConfig.ps1 script_parameters=\(dq\-hostname \(aqmy\-computer\(aq \-ip \(aq192.168.1.10\(aq \-DnsArray \(aq192.168.1.3\(aq,\(aq192.168.1.4\(aq,\(aq1.1.1.1\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dsc.set_lcm_config(config_mode=None, config_mode_freq=None, refresh_freq=None, reboot_if_needed=None, action_after_reboot=None, refresh_mode=None, certificate_id=None, configuration_id=None, allow_module_overwrite=None, debug_mode=False, status_retention_days=None)
For detailed descriptions of the parameters see:
\fI\%https://msdn.microsoft.com/en\-us/PowerShell/DSC/metaConfig\fP
.INDENT 7.0
.TP
.B config_mode (str): How the LCM applies the configuration. Valid values
are:
.INDENT 7.0
.IP \(bu 2
ApplyOnly
.IP \(bu 2
ApplyAndMonitor
.IP \(bu 2
ApplyAndAutoCorrect
.UNINDENT
.TP
.B config_mode_freq (int): How often, in minutes, the current configuration
is checked and applied. Ignored if config_mode is set to ApplyOnly.
Default is 15.
.UNINDENT
.sp
refresh_mode (str): How the LCM gets configurations. Valid values are:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Disabled
.IP \(bu 2
Push
.IP \(bu 2
Pull
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B refresh_freq (int): How often, in minutes, the LCM checks for updated
configurations. (pull mode only) Default is 30.
.TP
.B reboot_if_needed (bool): Reboot the machine if needed after a
configuration is applied. Default is False.
.TP
.B action_after_reboot (str): Action to take after reboot. Valid values
are:
.INDENT 7.0
.IP \(bu 2
ContinueConfiguration
.IP \(bu 2
StopConfiguration
.UNINDENT
.TP
.B certificate_id (guid): A GUID that specifies a certificate used to
access the configuration: (pull mode)
.TP
.B configuration_id (guid): A GUID that identifies the config file to get
from a pull server. (pull mode)
.TP
.B allow_module_overwrite (bool): New configs are allowed to overwrite old
ones on the target node.
.UNINDENT
.sp
debug_mode (str): Sets the debug level. Valid values are:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
None
.IP \(bu 2
ForceModuleImport
.IP \(bu 2
All
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B status_retention_days (int): Number of days to keep status of the
current config.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Either \fBconfig_mode_freq\fP or \fBrefresh_freq\fP needs to be a
multiple of the other. See documentation on MSDN for more details.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dsc.set_lcm_config ApplyOnly
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_dsc.test_config()
Tests the current applied DSC Configuration
.INDENT 7.0
.TP
.B Returns
True if successfully applied, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq dsc.test_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_event
.sp
A module for working with the Windows Event log system.
\&.. versionadded:: 3006.0
.INDENT 0.0
.TP
.B salt.modules.win_event.add(log_name, event_id, event_category=0, event_type=None, event_strings=None, event_data=None, event_sid=None)
Adds an event to the application event log.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBlog_name\fP (\fI\%str\fP) \-\- The name of the application or source
.IP \(bu 2
\fBevent_id\fP (\fI\%int\fP) \-\- The event ID
.IP \(bu 2
\fBevent_category\fP (\fI\%int\fP) \-\- The event category
.IP \(bu 2
\fBevent_type\fP (\fI\%str\fP) \-\-
.sp
The event category. Must be one of:
.INDENT 2.0
.IP \(bu 2
Success
.IP \(bu 2
Error
.IP \(bu 2
Warning
.IP \(bu 2
Information
.IP \(bu 2
AuditSuccess
.IP \(bu 2
AuditFailure
.UNINDENT

.IP \(bu 2
\fBevent_strings\fP (\fI\%list\fP) \-\- A list of strings
.IP \(bu 2
\fBevent_data\fP (\fI\%bytes\fP) \-\- Event data. Strings will be converted to bytes
.IP \(bu 2
\fBevent_sid\fP (\fIsid\fP) \-\- The SID for the event
.UNINDENT
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- event_id is not an integer
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- event_category is not an integer
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- event_type is not one of the valid event types
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- event_strings is not a list or string
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# A simple Application event log warning entry
salt \(aq*\(aq win_event.add Application 1234 12 Warning

# A more complex System event log information entry
salt \(aq*\(aq win_event.add System 1234 12 Information \(dq[\(aqEvent string data 1\(aq, \(aqEvent string data 2\(aq]\(dq \(dqSome event data\(dq

# Log to the System Event log with the source \(dqService Control Manager\(dq
salt \(aq*\(aq win_event.add \(dqService Control Manager\(dq 1234 12 Warning \(dq[\(aqEvent string data 1\(aq, \(aqEvent string data 2\(aq]\(dq \(dqSome event data\(dq

# Log to the PowerShell event log with the source \(dqPowerShell (PowerShell)\(dq
salt\-call \-\-local win_event.add \(dqPowerShell\(dq 6969 12 Warning
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_event.clear(log_name, backup=None)
Clears the specified event log.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A clear log event will be added to the log after it is cleared.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBlog_name\fP (\fI\%str\fP) \-\- The name of the log to clear
.IP \(bu 2
\fBbackup\fP (\fI\%str\fP) \-\- Path to backup file
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq win_event.clear Application
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_event.count(log_name)
Gets the number of events in the specified.
.INDENT 7.0
.TP
.B Parameters
\fBlog_name\fP (\fI\%str\fP) \-\- The name of the log
.TP
.B Returns
The number of events the log contains
.TP
.B Return type
\fI\%int\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq win_event.count Application
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_event.get(log_name)
Get events from the specified log. Get a list of available logs using the
\fI\%win_event.get_log_names\fP
function.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Running this command on a log with thousands of events, such as the
\fBApplications\fP log, can take a long time.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBlog_name\fP (\fI\%str\fP) \-\- The name of the log to retrieve.
.UNINDENT
.INDENT 7.0
.TP
.B Returns
tuple: A tuple of events as dictionaries
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_event.get Application
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_event.get_filtered(log_name, all_requirements=True, **kwargs)
Will find events that match the fields and values specified in the kwargs.
Kwargs can be any item in the return for the event.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Running this command on a log with thousands of events, such as the
\fBApplications\fP log, can take a long time.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBlog_name\fP (\fI\%str\fP) \-\- The name of the log to retrieve
.IP \(bu 2
\fBall_requirements\fP (\fI\%bool\fP) \-\- \fBTrue\fP matches all requirements. \fBFalse\fP
matches any requirement. Default is \fBTrue\fP
.UNINDENT
.UNINDENT
.sp
Kwargs:
.INDENT 7.0
.INDENT 3.5
eventID (int): The event ID number
.INDENT 0.0
.TP
.B eventType (int): The event type number. Valid options and their
corresponding meaning are:
.INDENT 7.0
.IP \(bu 2
0 : Success
.IP \(bu 2
1 : Error
.IP \(bu 2
2 : Warning
.IP \(bu 2
4 : Information
.IP \(bu 2
8 : Audit Success
.IP \(bu 2
10 : Audit Failure
.UNINDENT
.UNINDENT
.sp
year (int): The year
.sp
month (int): The month
.sp
day (int): The day of the month
.sp
hour (int): The hour
.sp
minute (int): The minute
.sp
second (int): The second
.sp
eventCategory (int): The event category number
.sp
sid (sid): The SID of the user that created the event
.sp
sourceName (str): The name of the event source
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A tuple of dicts of each filtered event
.TP
.B Return type
\fI\%tuple\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Return all events from the Security log with an ID of 1100
salt \(dq*\(dq win_event.get_filtered Security eventID=1100

# Return all events from the System log with an Error (1) event type
salt \(dq*\(dq win_event.get_filtered System eventType=1

# Return all events from System log with an Error (1) type, source is Service Control Manager, and data is netprofm
salt \(dq*\(dq win_event.get_filtered System eventType=1 sourceName=\(dqService Control Manager\(dq data=\(dqnetprofm\(dq

# Return events from the System log that match any of the kwargs below
salt \(dq*\(dq win_event.get_filtered System eventType=1 sourceName=\(dqService Control Manager\(dq data=\(dqnetprofm\(dq all_requirements=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_event.get_log_names()
Get a list of event logs available on the system
.INDENT 7.0
.TP
.B Returns
A list of event logs available on the system
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(dq*\(dq win_event.get_log_names
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_event.query(log_name, query_text=None, records=20, latest=True, raw=False)
Query a log for a specific event_id. Return the top number of records
specified. Use the
\fI\%win_event.get_log_names\fP
to see a list of available logs on the system.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
You can use the Windows Event Viewer to create the XPath query for the
\fBquery_text\fP parameter. Click on \fBFilter Current Log\fP, configure the
filter, then click on the XML tab. Copy the text between the two
\fB<Select>\fP tags. This will be the contents of the \fBquery_text\fP
parameter. You will have to convert some codes. For example, \fB&gt;\fP
becomes \fB>\fP, \fB&lt;\fP becomes \fB<\fP\&. Additionally, you\(aqll need to
put spaces between comparison operators. For example: \fBthis >= that\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBlog_name\fP (\fI\%str\fP) \-\- The name of the log to query
.IP \(bu 2
\fBquery_text\fP (\fI\%str\fP) \-\- The filter to apply to the log
.IP \(bu 2
\fBrecords\fP (\fI\%int\fP) \-\- The number of records to return
.IP \(bu 2
\fBlatest\fP (\fI\%bool\fP) \-\- \fBTrue\fP will return the newest events. \fBFalse\fP will
return the oldest events. Default is \fBTrue\fP
.IP \(bu 2
\fBraw\fP (\fI\%bool\fP) \-\- \fBTrue\fP will return the raw xml results. \fBFalse\fP will
return the xml converted to a dictionary. Default is \fBFalse\fP
.UNINDENT
.TP
.B Returns
A list of dict objects that contain information about the event
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Return the 20 most recent events from the Application log with an event ID of 22
salt \(aq*\(aq win_event.query Application \(dq*[System[(EventID=22)]]\(dq

# Return the 20 most recent events from the Application log with an event ID of 22
# Return raw xml
salt \(aq*\(aq win_event.query Application \(dq*[System[(EventID=22)]]\(dq raw=True

# Return the 20 oldest events from the Application log with an event ID of 22
salt \(aq*\(aq win_event.query Application \(dq*[System[(EventID=22)]]\(dq latest=False

# Return the 20 most recent Critical (1) events from the Application log in the last 12 hours
salt \(aq*\(dq win_event.query Application \(dq*[System[(Level=1) and TimeCreated[timediff(@SystemTime) <= 43200000]]]\(dq

# Return the 5 most recent Error (2) events from the application log
salt \(aq*\(dq win_event.query Application \(dq*[System[(Level=2)]]\(dq records=5

# Return the 20 most recent Warning (3) events from the Windows PowerShell log where the Event Source is PowerShell
salt \(aq*\(dq win_event.query \(dqWindows PowerShell\(dq \(dq*[System[Provider[@Name=\(aqPowerShell\(aq] and (Level=3)]]\(dq

# Return the 20 most recent Information (0 or 4) events from the Microsoft\-Windows\-PowerShell/Operational on 2022\-08\-24 with an Event ID of 4103
salt \(aq*\(dq win_event.query \(dqMicrosoft\-Windows\-PowerShell/Operational\(dq \(dq*[System[(Level=4 or Level=0) and (EventID=4103) and TimeCreated[@SystemTime >= \(aq2022\-08\-24T06:00:00.000Z\(aq]]]\(dq

# Return the 20 most recent Information (0 or 4) events from the Microsoft\-Windows\-PowerShell/Operational within the last hour
salt \(aq*\(dq win_event.query \(dqMicrosoft\-Windows\-PowerShell/Operational\(dq \(dq*[System[(Level=4 or Level=0) and TimeCreated[timediff(@SystemTime) <= 3600000]]]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_file
.sp
Manage information about files on the minion, set/read user, group
data, modify the ACL of files/directories
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
win32api
.IP \(bu 2
win32file
.IP \(bu 2
win32con
.IP \(bu 2
salt.utils.win_dacl
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.check_perms(path, ret=None, owner=None, grant_perms=None, deny_perms=None, inheritance=True, reset=False)
Check owner and permissions for the passed directory. This function checks
the permissions and sets them, returning the changes made. Used by the file
state to populate the return dict
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The full path to the directory.
.IP \(bu 2
\fBret\fP (\fI\%dict\fP) \-\- A dictionary to append changes to and return. If not passed, will
create a new dictionary to return.
.IP \(bu 2
\fBowner\fP (\fI\%str\fP) \-\- The owner to set for the directory.
.IP \(bu 2
\fBgrant_perms\fP (\fI\%dict\fP) \-\- A dictionary containing the user/group and the basic permissions to
check/grant, ie: \fB{\(aquser\(aq: {\(aqperms\(aq: \(aqbasic_permission\(aq}}\fP\&.
Default is \fBNone\fP\&.
.IP \(bu 2
\fBdeny_perms\fP (\fI\%dict\fP) \-\- A dictionary containing the user/group and permissions to
check/deny. Default is \fBNone\fP\&.
.IP \(bu 2
\fBinheritance\fP (\fI\%bool\fP) \-\- \fBTrue will check if inheritance is enabled and enable it. \(ga\(gaFalse\fP
will check if inheritance is disabled and disable it. Default is
\fBTrue\fP\&.
.IP \(bu 2
\fBreset\fP (\fI\%bool\fP) \-\- \fBTrue\fP will show what permissions will be removed by resetting the
DACL. \fBFalse\fP will do nothing. Default is \fBFalse\fP\&.
.UNINDENT
.TP
.B Returns
A dictionary of changes that have been made
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# To see changes to \(ga\(gaC:\eTemp\(ga\(ga if the \(aqUsers\(aq group is given \(aqread & execute\(aq permissions.
salt \(aq*\(aq file.check_perms C:\eTemp\e {} Administrators \(dq{\(aqUsers\(aq: {\(aqperms\(aq: \(aqread_execute\(aq}}\(dq

# Locally using salt call
salt\-call file.check_perms C:\eTemp\e {} Administrators \(dq{\(aqUsers\(aq: {\(aqperms\(aq: \(aqread_execute\(aq, \(aqapplies_to\(aq: \(aqthis_folder_only\(aq}}\(dq

# Specify advanced attributes with a list
salt \(aq*\(aq file.check_perms C:\eTemp\e {} Administrators \(dq{\(aqjsnuffy\(aq: {\(aqperms\(aq: [\(aqread_attributes\(aq, \(aqread_ea\(aq], \(aqapplies_to\(aq: \(aqfiles_only\(aq}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.chgrp(path, group)
Change the group of a file
.sp
Under Windows, this will do nothing.
.sp
While a file in Windows does have a \(aqprimary group\(aq, this rarely used
attribute generally has no bearing on permissions unless intentionally
configured and is only used to support Unix compatibility features (e.g.
Services For Unix, NFS services).
.sp
Salt, therefore, remaps this function to do nothing while still being
compatible with Unix behavior. When managing Windows systems,
this function is superfluous and will generate an info level log entry if
used directly.
.sp
If you do actually want to set the \(aqprimary group\(aq of a file, use \fBfile
\&.chpgrp\fP\&.
.sp
To set group permissions use \fBfile.set_perms\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path to the file or directory
.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- The group (unused)
.UNINDENT
.TP
.B Returns
None
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.chgrp c:\etemp\etest.txt administrators
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.chown(path, user, group=None, pgroup=None, follow_symlinks=True)
Chown a file, pass the file the desired user and group
.sp
Under Windows, the group parameter will be ignored.
.sp
This is because while files in Windows do have a \(aqprimary group\(aq
property, this is rarely used.  It generally has no bearing on
permissions unless intentionally configured and is most commonly used to
provide Unix compatibility (e.g. Services For Unix, NFS services).
.sp
If you do want to change the \(aqprimary group\(aq property and understand the
implications, pass the Windows only parameter, pgroup, instead.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path to the file or directory
.IP \(bu 2
\fBuser\fP (\fI\%str\fP) \-\- The name of the user to own the file
.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- The group (not used)
.IP \(bu 2
\fBpgroup\fP (\fI\%str\fP) \-\- The primary group to assign
.IP \(bu 2
\fBfollow_symlinks\fP (\fI\%bool\fP) \-\- If the object specified by \fBpath\fP is a symlink, get attributes of
the linked file instead of the symlink itself. Default is True
.UNINDENT
.TP
.B Returns
True if successful, otherwise error
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.chown c:\etemp\etest.txt myusername
salt \(aq*\(aq file.chown c:\etemp\etest.txt myusername pgroup=Administrators
salt \(aq*\(aq file.chown c:\etemp\etest.txt myusername \(dqpgroup=\(aqNone\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.chpgrp(path, group)
Change the group of a file
.sp
Under Windows, this will set the rarely used primary group of a file.
This generally has no bearing on permissions unless intentionally
configured and is most commonly used to provide Unix compatibility (e.g.
Services For Unix, NFS services).
.sp
Ensure you know what you are doing before using this function.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path to the file or directory
.IP \(bu 2
\fBpgroup\fP (\fI\%str\fP) \-\- The primary group to assign
.UNINDENT
.TP
.B Returns
True if successful, otherwise error
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.chpgrp c:\etemp\etest.txt Administrators
salt \(aq*\(aq file.chpgrp c:\etemp\etest.txt \(dq\(aqNone\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.get_attributes(path)
Return a dictionary object with the Windows
file attributes for a file.
.INDENT 7.0
.TP
.B Parameters
\fBpath\fP (\fI\%str\fP) \-\- The path to the file or directory
.TP
.B Returns
A dictionary of file attributes
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_attributes c:\etemp\ea.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.get_gid(path, follow_symlinks=True)
Return the id of the group that owns a given file
.sp
Under Windows, this will return the uid of the file.
.sp
While a file in Windows does have a \(aqprimary group\(aq, this rarely used
attribute generally has no bearing on permissions unless intentionally
configured and is only used to support Unix compatibility features (e.g.
Services For Unix, NFS services).
.sp
Salt, therefore, remaps this function to provide functionality that
somewhat resembles Unix behavior for API compatibility reasons. When
managing Windows systems, this function is superfluous and will generate
an info level log entry if used directly.
.sp
If you do actually want to access the \(aqprimary group\(aq of a file, use
\fIfile.get_pgid\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path to the file or directory
.IP \(bu 2
\fBfollow_symlinks\fP (\fI\%bool\fP) \-\- If the object specified by \fBpath\fP is a symlink, get attributes of
the linked file instead of the symlink itself. Default is True
.UNINDENT
.TP
.B Returns
The gid of the owner
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_gid c:\etemp\etest.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.get_group(path, follow_symlinks=True)
Return the group that owns a given file
.sp
Under Windows, this will return the user (owner) of the file.
.sp
While a file in Windows does have a \(aqprimary group\(aq, this rarely used
attribute generally has no bearing on permissions unless intentionally
configured and is only used to support Unix compatibility features (e.g.
Services For Unix, NFS services).
.sp
Salt, therefore, remaps this function to provide functionality that
somewhat resembles Unix behavior for API compatibility reasons. When
managing Windows systems, this function is superfluous and will generate
an info level log entry if used directly.
.sp
If you do actually want to access the \(aqprimary group\(aq of a file, use
\fIfile.get_pgroup\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path to the file or directory
.IP \(bu 2
\fBfollow_symlinks\fP (\fI\%bool\fP) \-\- If the object specified by \fBpath\fP is a symlink, get attributes of
the linked file instead of the symlink itself. Default is True
.UNINDENT
.TP
.B Returns
The name of the owner
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_group c:\etemp\etest.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.get_mode(path)
Return the mode of a file
.sp
Right now we\(aqre just returning None because Windows\(aq doesn\(aqt have a mode
like Linux
.INDENT 7.0
.TP
.B Parameters
\fBpath\fP (\fI\%str\fP) \-\- The path to the file or directory
.TP
.B Returns
None
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_mode /etc/passwd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.get_pgid(path, follow_symlinks=True)
Return the id of the primary group that owns a given file (Windows only)
.sp
This function will return the rarely used primary group of a file. This
generally has no bearing on permissions unless intentionally configured
and is most commonly used to provide Unix compatibility (e.g. Services
For Unix, NFS services).
.sp
Ensure you know what you are doing before using this function.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path to the file or directory
.IP \(bu 2
\fBfollow_symlinks\fP (\fI\%bool\fP) \-\- If the object specified by \fBpath\fP is a symlink, get attributes of
the linked file instead of the symlink itself. Default is True
.UNINDENT
.TP
.B Returns
The gid of the primary group
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_pgid c:\etemp\etest.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.get_pgroup(path, follow_symlinks=True)
Return the name of the primary group that owns a given file (Windows only)
.sp
This function will return the rarely used primary group of a file. This
generally has no bearing on permissions unless intentionally configured
and is most commonly used to provide Unix compatibility (e.g. Services
For Unix, NFS services).
.sp
Ensure you know what you are doing before using this function.
.sp
The return value may be \(aqNone\(aq, e.g. if the user is not on a domain. This is
a valid group \- do not confuse this with the Salt/Python value of None which
means no value was returned. To be certain, use the \fIget_pgid\fP function
which will return the SID, including for the system \(aqNone\(aq group.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path to the file or directory
.IP \(bu 2
\fBfollow_symlinks\fP (\fI\%bool\fP) \-\- If the object specified by \fBpath\fP is a symlink, get attributes of
the linked file instead of the symlink itself. Default is True
.UNINDENT
.TP
.B Returns
The name of the primary group
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_pgroup c:\etemp\etest.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.get_uid(path, follow_symlinks=True)
Return the id of the user that owns a given file
.sp
Symlinks are followed by default to mimic Unix behavior. Specify
\fIfollow_symlinks=False\fP to turn off this behavior.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path to the file or directory
.IP \(bu 2
\fBfollow_symlinks\fP (\fI\%bool\fP) \-\- If the object specified by \fBpath\fP is a symlink, get attributes of
the linked file instead of the symlink itself. Default is True
.UNINDENT
.TP
.B Returns
The uid of the owner
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_uid c:\etemp\etest.txt
salt \(aq*\(aq file.get_uid c:\etemp\etest.txt follow_symlinks=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.get_user(path, follow_symlinks=True)
Return the user that owns a given file
.sp
Symlinks are followed by default to mimic Unix behavior. Specify
\fIfollow_symlinks=False\fP to turn off this behavior.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path to the file or directory
.IP \(bu 2
\fBfollow_symlinks\fP (\fI\%bool\fP) \-\- If the object specified by \fBpath\fP is a symlink, get attributes of
the linked file instead of the symlink itself. Default is True
.UNINDENT
.TP
.B Returns
The name of the owner
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.get_user c:\etemp\etest.txt
salt \(aq*\(aq file.get_user c:\etemp\etest.txt follow_symlinks=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.gid_to_group(gid)
Convert the group id to the group name on this system
.sp
Under Windows, because groups are just another ACL entity, this function
behaves the same as uid_to_user.
.sp
For maintaining Windows systems, this function is superfluous and only
exists for API compatibility with Unix. Use the uid_to_user function
instead; an info level log entry will be generated if this function is used
directly.
.INDENT 7.0
.TP
.B Parameters
\fBgid\fP (\fI\%str\fP) \-\- The gid of the group
.TP
.B Returns
The name of the group
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.gid_to_group S\-1\-5\-21\-626487655\-2533044672\-482107328\-1010
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.group_to_gid(group)
Convert the group to the gid on this system
.sp
Under Windows, because groups are just another ACL entity, this function
behaves the same as user_to_uid, except if None is given, \(aq\(aq is returned.
.sp
For maintaining Windows systems, this function is superfluous and only
exists for API compatibility with Unix. Use the user_to_uid function
instead; an info level log entry will be generated if this function is used
directly.
.INDENT 7.0
.TP
.B Parameters
\fBgroup\fP (\fI\%str\fP) \-\- The name of the group
.TP
.B Returns
The gid of the group
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.group_to_gid administrators
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.is_link(path)
Check if the path is a symlink
.sp
This is only supported on Windows Vista or later.
.sp
Inline with Unix behavior, this function will raise an error if the path
is not a symlink, however, the error raised will be a SaltInvocationError,
not an OSError.
.INDENT 7.0
.TP
.B Parameters
\fBpath\fP (\fI\%str\fP) \-\- The path to a file or directory
.TP
.B Returns
True if path is a symlink, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.is_link /path/to/link
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.lchown(path, user, group=None, pgroup=None)
Chown a file, pass the file the desired user and group without following any
symlinks.
.sp
Under Windows, the group parameter will be ignored.
.sp
This is because while files in Windows do have a \(aqprimary group\(aq
property, this is rarely used.  It generally has no bearing on
permissions unless intentionally configured and is most commonly used to
provide Unix compatibility (e.g. Services For Unix, NFS services).
.sp
If you do want to change the \(aqprimary group\(aq property and understand the
implications, pass the Windows only parameter, pgroup, instead.
.sp
To set the primary group to \(aqNone\(aq, it must be specified in quotes.
Otherwise Salt will interpret it as the Python value of None and no primary
group changes will occur. See the example below.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path to the file or directory
.IP \(bu 2
\fBuser\fP (\fI\%str\fP) \-\- The name of the user to own the file
.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- The group (not used)
.IP \(bu 2
\fBpgroup\fP (\fI\%str\fP) \-\- The primary group to assign
.UNINDENT
.TP
.B Returns
True if successful, otherwise error
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.lchown c:\etemp\etest.txt myusername
salt \(aq*\(aq file.lchown c:\etemp\etest.txt myusername pgroup=Administrators
salt \(aq*\(aq file.lchown c:\etemp\etest.txt myusername \(dqpgroup=\(aqNone\(aq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.makedirs_(path, owner=None, grant_perms=None, deny_perms=None, inheritance=True, reset=False)
Ensure that the parent directory containing this path is available.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\-
.sp
The full path to the directory.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The path must end with a trailing slash otherwise the
directory(s) will be created up to the parent directory. For
example if path is \fBC:\etemp\etest\fP, then it would be treated
as \fBC:\etemp\e\fP but if the path ends with a trailing slash
like \fBC:\etemp\etest\e\fP, then it would be treated as
\fBC:\etemp\etest\e\fP\&.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBowner\fP (\fI\%str\fP) \-\- The owner of the directory. If not passed, it will be the account
that created the directory, likely SYSTEM.
.IP \(bu 2
\fBgrant_perms\fP (\fI\%dict\fP) \-\-
.sp
A dictionary containing the user/group and the basic permissions to
grant, ie: \fB{\(aquser\(aq: {\(aqperms\(aq: \(aqbasic_permission\(aq}}\fP\&. You can also
set the \fBapplies_to\fP setting here. The default is
\fBthis_folder_subfolders_files\fP\&. Specify another \fBapplies_to\fP
setting like this:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aquser\(aq: {\(aqperms\(aq: \(aqfull_control\(aq, \(aqapplies_to\(aq: \(aqthis_folder\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To set advanced permissions use a list for the \fBperms\fP parameter, ie:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aquser\(aq: {\(aqperms\(aq: [\(aqread_attributes\(aq, \(aqread_ea\(aq], \(aqapplies_to\(aq: \(aqthis_folder\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBdeny_perms\fP (\fI\%dict\fP) \-\- A dictionary containing the user/group and permissions to deny along
with the \fBapplies_to\fP setting. Use the same format used for the
\fBgrant_perms\fP parameter. Remember, deny permissions supersede
grant permissions.
.IP \(bu 2
\fBinheritance\fP (\fI\%bool\fP) \-\- If True the object will inherit permissions from the parent, if
False, inheritance will be disabled. Inheritance setting will not
apply to parent directories if they must be created.
.IP \(bu 2
\fBreset\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP the existing DACL will be cleared and replaced with the
settings defined in this function. If \fBFalse\fP, new entries will be
appended to the existing DACL. Default is \fBFalse\fP\&.
.sp
New in version 2018.3.0.


.UNINDENT
.TP
.B Returns
True if successful
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- If unsuccessful
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# To grant the \(aqUsers\(aq group \(aqread & execute\(aq permissions.
salt \(aq*\(aq file.makedirs C:\eTemp\e Administrators \(dq{\(aqUsers\(aq: {\(aqperms\(aq: \(aqread_execute\(aq}}\(dq

# Locally using salt call
salt\-call file.makedirs C:\eTemp\e Administrators \(dq{\(aqUsers\(aq: {\(aqperms\(aq: \(aqread_execute\(aq, \(aqapplies_to\(aq: \(aqthis_folder_only\(aq}}\(dq

# Specify advanced attributes with a list
salt \(aq*\(aq file.makedirs C:\eTemp\e Administrators \(dq{\(aqjsnuffy\(aq: {\(aqperms\(aq: [\(aqread_attributes\(aq, \(aqread_ea\(aq], \(aqapplies_to\(aq: \(aqthis_folder_only\(aq}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.makedirs_perms(path, owner=None, grant_perms=None, deny_perms=None, inheritance=True, reset=True)
Set owner and permissions for each directory created.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The full path to the directory.
.IP \(bu 2
\fBowner\fP (\fI\%str\fP) \-\- The owner of the directory. If not passed, it will be the account
that created the directory, likely SYSTEM.
.IP \(bu 2
\fBgrant_perms\fP (\fI\%dict\fP) \-\-
.sp
A dictionary containing the user/group and the basic permissions to
grant, ie: \fB{\(aquser\(aq: {\(aqperms\(aq: \(aqbasic_permission\(aq}}\fP\&. You can also
set the \fBapplies_to\fP setting here. The default is
\fBthis_folder_subfolders_files\fP\&. Specify another \fBapplies_to\fP
setting like this:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aquser\(aq: {\(aqperms\(aq: \(aqfull_control\(aq, \(aqapplies_to\(aq: \(aqthis_folder\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To set advanced permissions use a list for the \fBperms\fP parameter, ie:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aquser\(aq: {\(aqperms\(aq: [\(aqread_attributes\(aq, \(aqread_ea\(aq], \(aqapplies_to\(aq: \(aqthis_folder\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBdeny_perms\fP (\fI\%dict\fP) \-\- A dictionary containing the user/group and permissions to deny along
with the \fBapplies_to\fP setting. Use the same format used for the
\fBgrant_perms\fP parameter. Remember, deny permissions supersede
grant permissions.
.IP \(bu 2
\fBinheritance\fP (\fI\%bool\fP) \-\- If \fBTrue\fP the object will inherit permissions from the parent, if
\fBFalse\fP, inheritance will be disabled. Inheritance setting will
not apply to parent directories if they must be created
.IP \(bu 2
\fBreset\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP the existing DACL will be cleared and replaced with the
settings defined in this function. If \fBFalse\fP, new entries will be
appended to the existing DACL. Default is \fBFalse\fP\&.
.sp
New in version 2018.3.0.


.UNINDENT
.TP
.B Returns
True if successful, otherwise raises an error
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# To grant the \(aqUsers\(aq group \(aqread & execute\(aq permissions.
salt \(aq*\(aq file.makedirs_perms C:\eTemp\e Administrators \(dq{\(aqUsers\(aq: {\(aqperms\(aq: \(aqread_execute\(aq}}\(dq

# Locally using salt call
salt\-call file.makedirs_perms C:\eTemp\e Administrators \(dq{\(aqUsers\(aq: {\(aqperms\(aq: \(aqread_execute\(aq, \(aqapplies_to\(aq: \(aqthis_folder_only\(aq}}\(dq

# Specify advanced attributes with a list
salt \(aq*\(aq file.makedirs_perms C:\eTemp\e Administrators \(dq{\(aqjsnuffy\(aq: {\(aqperms\(aq: [\(aqread_attributes\(aq, \(aqread_ea\(aq], \(aqapplies_to\(aq: \(aqthis_folder_files\(aq}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.mkdir(path, owner=None, grant_perms=None, deny_perms=None, inheritance=True, reset=False)
Ensure that the directory is available and permissions are set.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The full path to the directory.
.IP \(bu 2
\fBowner\fP (\fI\%str\fP) \-\- The owner of the directory. If not passed, it will be the account
that created the directory, likely SYSTEM
.IP \(bu 2
\fBgrant_perms\fP (\fI\%dict\fP) \-\-
.sp
A dictionary containing the user/group and the basic permissions to
grant, ie: \fB{\(aquser\(aq: {\(aqperms\(aq: \(aqbasic_permission\(aq}}\fP\&. You can also
set the \fBapplies_to\fP setting here. The default is
\fBthis_folder_subfolders_files\fP\&. Specify another \fBapplies_to\fP
setting like this:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aquser\(aq: {\(aqperms\(aq: \(aqfull_control\(aq, \(aqapplies_to\(aq: \(aqthis_folder\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To set advanced permissions use a list for the \fBperms\fP parameter,
ie:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aquser\(aq: {\(aqperms\(aq: [\(aqread_attributes\(aq, \(aqread_ea\(aq], \(aqapplies_to\(aq: \(aqthis_folder\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBdeny_perms\fP (\fI\%dict\fP) \-\- A dictionary containing the user/group and permissions to deny along
with the \fBapplies_to\fP setting. Use the same format used for the
\fBgrant_perms\fP parameter. Remember, deny permissions supersede
grant permissions.
.IP \(bu 2
\fBinheritance\fP (\fI\%bool\fP) \-\- If True the object will inherit permissions from the parent, if
\fBFalse\fP, inheritance will be disabled. Inheritance setting will
not apply to parent directories if they must be created.
.IP \(bu 2
\fBreset\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP the existing DACL will be cleared and replaced with the
settings defined in this function. If \fBFalse\fP, new entries will be
appended to the existing DACL. Default is \fBFalse\fP\&.
.sp
New in version 2018.3.0.


.UNINDENT
.TP
.B Returns
True if successful
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- If unsuccessful
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# To grant the \(aqUsers\(aq group \(aqread & execute\(aq permissions.
salt \(aq*\(aq file.mkdir C:\eTemp\e Administrators \(dq{\(aqUsers\(aq: {\(aqperms\(aq: \(aqread_execute\(aq}}\(dq

# Locally using salt call
salt\-call file.mkdir C:\eTemp\e Administrators \(dq{\(aqUsers\(aq: {\(aqperms\(aq: \(aqread_execute\(aq, \(aqapplies_to\(aq: \(aqthis_folder_only\(aq}}\(dq

# Specify advanced attributes with a list
salt \(aq*\(aq file.mkdir C:\eTemp\e Administrators \(dq{\(aqjsnuffy\(aq: {\(aqperms\(aq: [\(aqread_attributes\(aq, \(aqread_ea\(aq], \(aqapplies_to\(aq: \(aqthis_folder_only\(aq}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.remove(path, force=False)
Remove the named file or directory
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path to the file or directory to remove.
.IP \(bu 2
\fBforce\fP (\fI\%bool\fP) \-\- Remove even if marked Read\-Only. Default is False
.UNINDENT
.TP
.B Returns
True if successful, False if unsuccessful
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.remove C:\eTemp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.set_attributes(path, archive=None, hidden=None, normal=None, notIndexed=None, readonly=None, system=None, temporary=None)
Set file attributes for a file.  Note that the normal attribute
means that all others are false.  So setting it will clear all others.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path to the file or directory
.IP \(bu 2
\fBarchive\fP (\fI\%bool\fP) \-\- Sets the archive attribute. Default is None
.IP \(bu 2
\fBhidden\fP (\fI\%bool\fP) \-\- Sets the hidden attribute. Default is None
.IP \(bu 2
\fBnormal\fP (\fI\%bool\fP) \-\- Resets the file attributes. Cannot be used in conjunction with any
other attribute. Default is None
.IP \(bu 2
\fBnotIndexed\fP (\fI\%bool\fP) \-\- Sets the indexed attribute. Default is None
.IP \(bu 2
\fBreadonly\fP (\fI\%bool\fP) \-\- Sets the readonly attribute. Default is None
.IP \(bu 2
\fBsystem\fP (\fI\%bool\fP) \-\- Sets the system attribute. Default is None
.IP \(bu 2
\fBtemporary\fP (\fI\%bool\fP) \-\- Sets the temporary attribute. Default is None
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.set_attributes c:\etemp\ea.txt normal=True
salt \(aq*\(aq file.set_attributes c:\etemp\ea.txt readonly=True hidden=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.set_mode(path, mode)
Set the mode of a file
.sp
This just calls get_mode, which returns None because we don\(aqt use mode on
Windows
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP \-\- The path to the file or directory
.IP \(bu 2
\fBmode\fP \-\- The mode (not used)
.UNINDENT
.TP
.B Returns
None
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.set_mode /etc/passwd 0644
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.set_perms(path, grant_perms=None, deny_perms=None, inheritance=True, reset=False)
Set permissions for the given path
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The full path to the directory.
.IP \(bu 2
\fBgrant_perms\fP (\fI\%dict\fP) \-\-
.sp
A dictionary containing the user/group and the basic permissions to
grant, ie: \fB{\(aquser\(aq: {\(aqperms\(aq: \(aqbasic_permission\(aq}}\fP\&. You can also
set the \fBapplies_to\fP setting here for directories. The default for
\fBapplies_to\fP is \fBthis_folder_subfolders_files\fP\&. Specify another
\fBapplies_to\fP setting like this:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aquser\(aq: {\(aqperms\(aq: \(aqfull_control\(aq, \(aqapplies_to\(aq: \(aqthis_folder\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To set advanced permissions use a list for the \fBperms\fP parameter,
ie:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aquser\(aq: {\(aqperms\(aq: [\(aqread_attributes\(aq, \(aqread_ea\(aq], \(aqapplies_to\(aq: \(aqthis_folder\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To see a list of available attributes and applies to settings see
the documentation for salt.utils.win_dacl.
.sp
A value of \fBNone\fP will make no changes to the \fBgrant\fP portion of
the DACL. Default is \fBNone\fP\&.

.IP \(bu 2
\fBdeny_perms\fP (\fI\%dict\fP) \-\-
.sp
A dictionary containing the user/group and permissions to deny along
with the \fBapplies_to\fP setting. Use the same format used for the
\fBgrant_perms\fP parameter. Remember, deny permissions supersede
grant permissions.
.sp
A value of \fBNone\fP will make no changes to the \fBdeny\fP portion of
the DACL. Default is \fBNone\fP\&.

.IP \(bu 2
\fBinheritance\fP (\fI\%bool\fP) \-\- If \fBTrue\fP the object will inherit permissions from the parent, if
\fBFalse\fP, inheritance will be disabled. Inheritance setting will
not apply to parent directories if they must be created. Default is
\fBFalse\fP\&.
.IP \(bu 2
\fBreset\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP the existing DCL will be cleared and replaced with the
settings defined in this function. If \fBFalse\fP, new entries will be
appended to the existing DACL. Default is \fBFalse\fP\&.
.sp
New in version 2018.3.0.


.UNINDENT
.TP
.B Returns
True if successful
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- If unsuccessful
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# To grant the \(aqUsers\(aq group \(aqread & execute\(aq permissions.
salt \(aq*\(aq file.set_perms C:\eTemp\e \(dq{\(aqUsers\(aq: {\(aqperms\(aq: \(aqread_execute\(aq}}\(dq

# Locally using salt call
salt\-call file.set_perms C:\eTemp\e \(dq{\(aqUsers\(aq: {\(aqperms\(aq: \(aqread_execute\(aq, \(aqapplies_to\(aq: \(aqthis_folder_only\(aq}}\(dq

# Specify advanced attributes with a list
salt \(aq*\(aq file.set_perms C:\eTemp\e \(dq{\(aqjsnuffy\(aq: {\(aqperms\(aq: [\(aqread_attributes\(aq, \(aqread_ea\(aq], \(aqapplies_to\(aq: \(aqthis_folder_only\(aq}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.stats(path, hash_type=\(aqsha256\(aq, follow_symlinks=True)
Return a dict containing the stats about a given file
.sp
Under Windows, \fIgid\fP will equal \fIuid\fP and \fIgroup\fP will equal \fIuser\fP\&.
.sp
While a file in Windows does have a \(aqprimary group\(aq, this rarely used
attribute generally has no bearing on permissions unless intentionally
configured and is only used to support Unix compatibility features (e.g.
Services For Unix, NFS services).
.sp
Salt, therefore, remaps these properties to keep some kind of
compatibility with Unix behavior. If the \(aqprimary group\(aq is required, it
can be accessed in the \fIpgroup\fP and \fIpgid\fP properties.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The path to the file or directory
.IP \(bu 2
\fBhash_type\fP (\fI\%str\fP) \-\- The type of hash to return
.IP \(bu 2
\fBfollow_symlinks\fP (\fI\%bool\fP) \-\- If the object specified by \fBpath\fP is a symlink, get attributes of
the linked file instead of the symlink itself. Default is True
.UNINDENT
.TP
.B Returns
A dictionary of file/directory stats
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.stats /etc/passwd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.symlink(src, link, force=False, atomic=False, follow_symlinks=True)
Create a symbolic link to a file
.sp
This is only supported with Windows Vista or later and must be executed by
a user with the SeCreateSymbolicLink privilege.
.sp
The behavior of this function matches the Unix equivalent, with one
exception \- invalid symlinks cannot be created. The source path must exist.
If it doesn\(aqt, an error will be raised.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsrc\fP (\fI\%str\fP) \-\- The path to a file or directory
.IP \(bu 2
\fBlink\fP (\fI\%str\fP) \-\- The path to the link. Must be an absolute path
.IP \(bu 2
\fBforce\fP (\fI\%bool\fP) \-\- Overwrite an existing symlink with the same name
\&.. versionadded:: 3005
.IP \(bu 2
\fBatomic\fP (\fI\%bool\fP) \-\- Use atomic file operations to create the symlink
\&.. versionadded:: 3006.0
.IP \(bu 2
\fBfollow_symlinks\fP (\fI\%bool\fP) \-\- If set to \fBFalse\fP, use \fBos.path.lexists()\fP for existence checks
instead of \fBos.path.exists()\fP\&.
\&.. versionadded:: 3007.0
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise raises \fBCommandExecutionError\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.symlink /path/to/file /path/to/link
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.uid_to_user(uid)
Convert a uid to a user name
.INDENT 7.0
.TP
.B Parameters
\fBuid\fP (\fI\%str\fP) \-\- The user id to lookup
.TP
.B Returns
The name of the user
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.uid_to_user S\-1\-5\-21\-626487655\-2533044672\-482107328\-1010
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.user_to_uid(user)
Convert user name to a uid
.INDENT 7.0
.TP
.B Parameters
\fBuser\fP (\fI\%str\fP) \-\- The user to lookup
.TP
.B Returns
The user id of the user
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq file.user_to_uid myusername
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.version(path)
New in version 3005.

.sp
Get the version of a file.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Not all files have version information. The following are common file
types that contain version information:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\&.exe
.IP \(bu 2
\&.dll
.IP \(bu 2
\&.sys
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBpath\fP (\fI\%str\fP) \-\- The path to the file.
.TP
.B Returns
.INDENT 7.0
.TP
.B The version of the file if the file contains it. Otherwise, an
empty string will be returned.
.UNINDENT

.TP
.B Return type
\fI\%str\fP
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If the file does not exist
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If the path is not a file
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt * file.version C:\eWindows\enotepad.exe
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_file.version_details(path)
New in version 3005.

.sp
Get file details for a file. Similar to what\(aqs in the details tab on the
file properties.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Not all files have version information. The following are common file
types that contain version information:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\&.exe
.IP \(bu 2
\&.dll
.IP \(bu 2
\&.sys
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBpath\fP (\fI\%str\fP) \-\- The path to the file.
.TP
.B Returns
.INDENT 7.0
.TP
.B A dictionary containing details about the file related to version.
An empty dictionary if the file contains no version information.
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If the file does not exist
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If the path is not a file
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt * file.version_details C:\eWindows\enotepad.exe
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_firewall
.sp
Module for configuring Windows Firewall using \fBnetsh\fP
.INDENT 0.0
.TP
.B salt.modules.win_firewall.add_rule(name, localport, protocol=\(aqtcp\(aq, action=\(aqallow\(aq, dir=\(aqin\(aq, remoteip=\(aqany\(aq)
New in version 2015.5.0.

.sp
Add a new inbound or outbound rule to the firewall policy
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the rule. Must be unique and cannot be \(dqall\(dq.
Required.
.IP \(bu 2
\fBlocalport\fP (\fI\%int\fP) \-\- The port the rule applies to. Must be a number between
0 and 65535. Can be a range. Can specify multiple ports separated by
commas. Required.
.IP \(bu 2
\fBprotocol\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\-
.sp
The protocol. Can be any of the following:
.INDENT 2.0
.IP \(bu 2
A number between 0 and 255
.IP \(bu 2
icmpv4
.IP \(bu 2
icmpv6
.IP \(bu 2
tcp
.IP \(bu 2
udp
.IP \(bu 2
any
.UNINDENT

.IP \(bu 2
\fBaction\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\-
.sp
The action the rule performs. Can be any of the
following:
.INDENT 2.0
.IP \(bu 2
allow
.IP \(bu 2
block
.IP \(bu 2
bypass
.UNINDENT

.IP \(bu 2
\fBdir\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The direction. Can be \fBin\fP or \fBout\fP\&.
.IP \(bu 2
\fBremoteip\fP (\fIOptional\fP\fI [\fP\fI\%str\fP\fI]\fP) \-\-
.sp
The remote IP. Can be any of the following:
.INDENT 2.0
.IP \(bu 2
any
.IP \(bu 2
localsubnet
.IP \(bu 2
dns
.IP \(bu 2
dhcp
.IP \(bu 2
wins
.IP \(bu 2
defaultgateway
.IP \(bu 2
Any valid IPv4 address (192.168.0.12)
.IP \(bu 2
Any valid IPv6 address (2002:9b3b:1a31:4:208:74ff:fe39:6c43)
.IP \(bu 2
Any valid subnet (192.168.1.0/24)
.IP \(bu 2
Any valid range of IP addresses (192.168.0.1\-192.168.0.12)
.IP \(bu 2
A list of valid IP addresses
.UNINDENT
.sp
Can be combinations of the above separated by commas.

.UNINDENT
.TP
.B Returns
True if successful
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- If the command fails
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewall.add_rule \(aqtest\(aq \(aq8080\(aq \(aqtcp\(aq
salt \(aq*\(aq firewall.add_rule \(aqtest\(aq \(aq1\(aq \(aqicmpv4\(aq
salt \(aq*\(aq firewall.add_rule \(aqtest_remote_ip\(aq \(aq8000\(aq \(aqtcp\(aq \(aqallow\(aq \(aqin\(aq \(aq192.168.0.1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_firewall.delete_rule(name=None, localport=None, protocol=None, dir=None, remoteip=None)
New in version 2015.8.0.

.sp
Delete an existing firewall rule identified by name and optionally by ports,
protocols, direction, and remote IP.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the rule to delete. If the name \fBall\fP is used
you must specify additional parameters.
.IP \(bu 2
\fBlocalport\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The port of the rule. If protocol is not
specified, protocol will be set to \fBtcp\fP
.IP \(bu 2
\fBprotocol\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The protocol of the rule. Default is \fBtcp\fP
when \fBlocalport\fP is specified
.IP \(bu 2
\fBdir\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The direction of the rule.
.IP \(bu 2
\fBremoteip\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The remote IP of the rule.
.UNINDENT
.TP
.B Returns
True if successful
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- If the command fails
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Delete incoming tcp port 8080 in the rule named \(aqtest\(aq
salt \(aq*\(aq firewall.delete_rule \(aqtest\(aq \(aq8080\(aq \(aqtcp\(aq \(aqin\(aq

# Delete the incoming tcp port 8000 from 192.168.0.1 in the rule named
# \(aqtest_remote_ip\(aq
salt \(aq*\(aq firewall.delete_rule \(aqtest_remote_ip\(aq \(aq8000\(aq \(aqtcp\(aq \(aqin\(aq \(aq192.168.0.1\(aq

# Delete all rules for local port 80:
salt \(aq*\(aq firewall.delete_rule all 80 tcp

# Delete a rule called \(aqallow80\(aq:
salt \(aq*\(aq firewall.delete_rule allow80
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_firewall.disable(profile=\(aqallprofiles\(aq)
Disable firewall profile
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\-
.sp
The name of the profile to disable. Default is
\fBallprofiles\fP\&. Valid options are:
.INDENT 7.0
.IP \(bu 2
allprofiles
.IP \(bu 2
domainprofile
.IP \(bu 2
privateprofile
.IP \(bu 2
publicprofile
.UNINDENT

.TP
.B Returns
True if successful
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- If the command fails
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewall.disable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_firewall.enable(profile=\(aqallprofiles\(aq)
New in version 2015.5.0.

.sp
Enable firewall profile
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\-
.sp
The name of the profile to enable. Default is
\fBallprofiles\fP\&. Valid options are:
.INDENT 7.0
.IP \(bu 2
allprofiles
.IP \(bu 2
domainprofile
.IP \(bu 2
privateprofile
.IP \(bu 2
publicprofile
.UNINDENT

.TP
.B Returns
True if successful
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- If the command fails
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewall.enable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_firewall.get_all_profiles(store=\(aqlocal\(aq)
Gets all properties for all profiles in the specified store
.sp
New in version 2018.3.4.

.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B Parameters
\fBstore\fP (\fI\%str\fP) \-\-
.sp
The store to use. This is either the local firewall policy or the
policy defined by local group policy. Valid options are:
.INDENT 7.0
.IP \(bu 2
lgpo
.IP \(bu 2
local
.UNINDENT
.sp
Default is \fBlocal\fP

.TP
.B Returns
A dictionary containing the specified settings for each profile
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Get all firewall settings for all profiles
salt * firewall.get_all_settings

# Get all firewall settings for all profiles as defined by local group
# policy

salt * firewall.get_all_settings lgpo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_firewall.get_all_settings(domain, store=\(aqlocal\(aq)
Gets all the properties for the specified profile in the specified store
.sp
New in version 2018.3.4.

.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fI\%str\fP) \-\-
.sp
The firewall profile to query. Valid options are:
.INDENT 2.0
.IP \(bu 2
domain
.IP \(bu 2
public
.IP \(bu 2
private
.UNINDENT

.IP \(bu 2
\fBstore\fP (\fI\%str\fP) \-\-
.sp
The store to use. This is either the local firewall policy or the
policy defined by local group policy. Valid options are:
.INDENT 2.0
.IP \(bu 2
lgpo
.IP \(bu 2
local
.UNINDENT
.sp
Default is \fBlocal\fP

.UNINDENT
.TP
.B Returns
A dictionary containing the specified settings
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Get all firewall settings for connections on the domain profile
salt * win_firewall.get_all_settings domain

# Get all firewall settings for connections on the domain profile as
# defined by local group policy
salt * win_firewall.get_all_settings domain lgpo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_firewall.get_config()
Get the status of all the firewall profiles
.INDENT 7.0
.TP
.B Returns
A dictionary of all profiles on the system
.TP
.B Return type
\fI\%dict\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- If the command fails
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewall.get_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_firewall.get_rule(name=\(aqall\(aq)
New in version 2015.5.0.

.sp
Display all matching rules as specified by name
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The full name of the rule. \fBall\fP will return all
rules. Default is \fBall\fP
.TP
.B Returns
A dictionary of all rules or rules that match the name exactly
.TP
.B Return type
\fI\%dict\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- If the command fails
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq firewall.get_rule \(aqMyAppPort\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_firewall.get_settings(profile, section, store=\(aqlocal\(aq)
Get the firewall property from the specified profile in the specified store
as returned by \fBnetsh advfirewall\fP\&.
.sp
New in version 2018.3.4.

.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fI\%str\fP) \-\-
.sp
The firewall profile to query. Valid options are:
.INDENT 2.0
.IP \(bu 2
domain
.IP \(bu 2
public
.IP \(bu 2
private
.UNINDENT

.IP \(bu 2
\fBsection\fP (\fI\%str\fP) \-\-
.sp
The property to query within the selected profile. Valid options
are:
.INDENT 2.0
.IP \(bu 2
firewallpolicy : inbound/outbound behavior
.IP \(bu 2
logging : firewall logging settings
.IP \(bu 2
settings : firewall properties
.IP \(bu 2
state : firewalls state (on | off)
.UNINDENT

.IP \(bu 2
\fBstore\fP (\fI\%str\fP) \-\-
.sp
The store to use. This is either the local firewall policy or the
policy defined by local group policy. Valid options are:
.INDENT 2.0
.IP \(bu 2
lgpo
.IP \(bu 2
local
.UNINDENT
.sp
Default is \fBlocal\fP

.UNINDENT
.TP
.B Returns
A dictionary containing the properties for the specified profile
.TP
.B Return type
\fI\%dict\fP
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If an error occurs
.IP \(bu 2
\fI\%ValueError\fP \-\- If the parameters are incorrect
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Get the inbound/outbound firewall settings for connections on the
# local domain profile
salt * win_firewall.get_settings domain firewallpolicy

# Get the inbound/outbound firewall settings for connections on the
# domain profile as defined by local group policy
salt * win_firewall.get_settings domain firewallpolicy lgpo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_firewall.rule_exists(name)
New in version 2016.11.6.

.sp
Checks if a firewall rule exists in the firewall policy
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the rule
.TP
.B Returns
True if exists, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Is there a rule named RemoteDesktop
salt \(aq*\(aq firewall.rule_exists RemoteDesktop
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_firewall.set_firewall_settings(profile, inbound=None, outbound=None, store=\(aqlocal\(aq)
Set the firewall inbound/outbound settings for the specified profile and
store
.sp
New in version 2018.3.4.

.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fI\%str\fP) \-\-
.sp
The firewall profile to query. Valid options are:
.INDENT 2.0
.IP \(bu 2
domain
.IP \(bu 2
public
.IP \(bu 2
private
.UNINDENT

.IP \(bu 2
\fBinbound\fP (\fI\%str\fP) \-\-
.sp
The inbound setting. If \fBNone\fP is passed, the setting will remain
unchanged. Valid values are:
.INDENT 2.0
.IP \(bu 2
blockinbound
.IP \(bu 2
blockinboundalways
.IP \(bu 2
allowinbound
.IP \(bu 2
notconfigured
.UNINDENT
.sp
Default is \fBNone\fP

.IP \(bu 2
\fBoutbound\fP (\fI\%str\fP) \-\-
.sp
The outbound setting. If \fBNone\fP is passed, the setting will remain
unchanged. Valid values are:
.INDENT 2.0
.IP \(bu 2
allowoutbound
.IP \(bu 2
blockoutbound
.IP \(bu 2
notconfigured
.UNINDENT
.sp
Default is \fBNone\fP

.IP \(bu 2
\fBstore\fP (\fI\%str\fP) \-\-
.sp
The store to use. This is either the local firewall policy or the
policy defined by local group policy. Valid options are:
.INDENT 2.0
.IP \(bu 2
lgpo
.IP \(bu 2
local
.UNINDENT
.sp
Default is \fBlocal\fP

.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If an error occurs
.IP \(bu 2
\fI\%ValueError\fP \-\- If the parameters are incorrect
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Set the inbound setting for the domain profile to block inbound
# connections
salt * firewall.set_firewall_settings domain=\(aqdomain\(aq inbound=\(aqblockinbound\(aq

# Set the outbound setting for the domain profile to allow outbound
# connections
salt * firewall.set_firewall_settings domain=\(aqdomain\(aq outbound=\(aqallowoutbound\(aq

# Set inbound/outbound settings for the domain profile in the group
# policy to block inbound and allow outbound
salt * firewall.set_firewall_settings domain=\(aqdomain\(aq inbound=\(aqblockinbound\(aq outbound=\(aqallowoutbound\(aq store=\(aqlgpo\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_firewall.set_logging_settings(profile, setting, value, store=\(aqlocal\(aq)
Configure logging settings for the Windows firewall.
.sp
New in version 2018.3.4.

.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fI\%str\fP) \-\-
.sp
The firewall profile to configure. Valid options are:
.INDENT 2.0
.IP \(bu 2
domain
.IP \(bu 2
public
.IP \(bu 2
private
.UNINDENT

.IP \(bu 2
\fBsetting\fP (\fI\%str\fP) \-\-
.sp
The logging setting to configure. Valid options are:
.INDENT 2.0
.IP \(bu 2
allowedconnections
.IP \(bu 2
droppedconnections
.IP \(bu 2
filename
.IP \(bu 2
maxfilesize
.UNINDENT

.IP \(bu 2
\fBvalue\fP (\fI\%str\fP) \-\-
.sp
The value to apply to the setting. Valid values are dependent upon
the setting being configured. Valid options are:
.sp
allowedconnections:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
enable
.IP \(bu 2
disable
.IP \(bu 2
notconfigured
.UNINDENT
.UNINDENT
.UNINDENT
.sp
droppedconnections:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
enable
.IP \(bu 2
disable
.IP \(bu 2
notconfigured
.UNINDENT
.UNINDENT
.UNINDENT
.sp
filename:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Full path and name of the firewall log file
.IP \(bu 2
notconfigured
.UNINDENT
.UNINDENT
.UNINDENT
.sp
maxfilesize:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
1 \- 32767
.IP \(bu 2
notconfigured
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
\fBnotconfigured\fP can only be used when using the lgpo store
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBstore\fP (\fI\%str\fP) \-\-
.sp
The store to use. This is either the local firewall policy or the
policy defined by local group policy. Valid options are:
.INDENT 2.0
.IP \(bu 2
lgpo
.IP \(bu 2
local
.UNINDENT
.sp
Default is \fBlocal\fP

.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If an error occurs
.IP \(bu 2
\fI\%ValueError\fP \-\- If the parameters are incorrect
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Log allowed connections and set that in local group policy
salt * firewall.set_logging_settings domain allowedconnections enable lgpo

# Don\(aqt log dropped connections
salt * firewall.set_logging_settings profile=private setting=droppedconnections value=disable

# Set the location of the log file
salt * firewall.set_logging_settings domain filename C:\ewindows\elogs\efirewall.log

# You can also use environment variables
salt * firewall.set_logging_settings domain filename %systemroot%\esystem32\eLogFiles\eFirewall\epfirewall.log

# Set the max file size of the log to 2048 Kb
salt * firewall.set_logging_settings domain maxfilesize 2048
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_firewall.set_settings(profile, setting, value, store=\(aqlocal\(aq)
Configure firewall settings.
.sp
New in version 2018.3.4.

.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fI\%str\fP) \-\-
.sp
The firewall profile to configure. Valid options are:
.INDENT 2.0
.IP \(bu 2
domain
.IP \(bu 2
public
.IP \(bu 2
private
.UNINDENT

.IP \(bu 2
\fBsetting\fP (\fI\%str\fP) \-\-
.sp
The firewall setting to configure. Valid options are:
.INDENT 2.0
.IP \(bu 2
localfirewallrules
.IP \(bu 2
localconsecrules
.IP \(bu 2
inboundusernotification
.IP \(bu 2
remotemanagement
.IP \(bu 2
unicastresponsetomulticast
.UNINDENT

.IP \(bu 2
\fBvalue\fP (\fI\%str\fP) \-\-
.sp
The value to apply to the setting. Valid options are
.INDENT 2.0
.IP \(bu 2
enable
.IP \(bu 2
disable
.IP \(bu 2
notconfigured
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
\fBnotconfigured\fP can only be used when using the lgpo store
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBstore\fP (\fI\%str\fP) \-\-
.sp
The store to use. This is either the local firewall policy or the
policy defined by local group policy. Valid options are:
.INDENT 2.0
.IP \(bu 2
lgpo
.IP \(bu 2
local
.UNINDENT
.sp
Default is \fBlocal\fP

.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If an error occurs
.IP \(bu 2
\fI\%ValueError\fP \-\- If the parameters are incorrect
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Merge local rules with those distributed through group policy
salt * firewall.set_settings domain localfirewallrules enable

# Allow remote management of Windows Firewall
salt * firewall.set_settings domain remotemanagement enable
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_firewall.set_state(profile, state, store=\(aqlocal\(aq)
Configure the firewall state.
.sp
New in version 2018.3.4.

.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fI\%str\fP) \-\-
.sp
The firewall profile to configure. Valid options are:
.INDENT 2.0
.IP \(bu 2
domain
.IP \(bu 2
public
.IP \(bu 2
private
.UNINDENT

.IP \(bu 2
\fBstate\fP (\fI\%str\fP) \-\-
.sp
The firewall state. Valid options are:
.INDENT 2.0
.IP \(bu 2
on
.IP \(bu 2
off
.IP \(bu 2
notconfigured
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
\fBnotconfigured\fP can only be used when using the lgpo store
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBstore\fP (\fI\%str\fP) \-\-
.sp
The store to use. This is either the local firewall policy or the
policy defined by local group policy. Valid options are:
.INDENT 2.0
.IP \(bu 2
lgpo
.IP \(bu 2
local
.UNINDENT
.sp
Default is \fBlocal\fP

.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If an error occurs
.IP \(bu 2
\fI\%ValueError\fP \-\- If the parameters are incorrect
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Turn the firewall off when the domain profile is active
salt * firewall.set_state domain off

# Turn the firewall on when the public profile is active and set that in
# the local group policy
salt * firewall.set_state public on lgpo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_groupadd
.sp
Manage groups on Windows
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage groups on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqgroup.info\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_groupadd.add(name, **kwargs)
Add the specified group
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the group to add
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.add foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_groupadd.adduser(name, username, **kwargs)
Add a user to a group
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the group to modify
.IP \(bu 2
\fBusername\fP (\fI\%str\fP) \-\- The name of the user to add to the group
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.adduser foo username
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_groupadd.delete(name, **kwargs)
Remove the named group
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the group to remove
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.delete foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_groupadd.deluser(name, username, **kwargs)
Remove a user from a group
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the group to modify
.IP \(bu 2
\fBusername\fP (\fI\%str\fP) \-\- The name of the user to remove from the group
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.deluser foo username
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_groupadd.getent(refresh=False)
Return info on all groups
.INDENT 7.0
.TP
.B Parameters
\fBrefresh\fP (\fI\%bool\fP) \-\- Refresh the info for all groups in \fB__context__\fP\&. If False only
the groups in \fB__context__\fP will be returned. If True the
\fB__context__\fP will be refreshed with current data and returned.
Default is False
.TP
.B Returns
A list of groups and their information
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.getent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_groupadd.info(name)
Return information about a group
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the group for which to get information
.TP
.B Returns
A dictionary of information about the group
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.info foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_groupadd.list_groups(refresh=False)
Return a list of groups
.INDENT 7.0
.TP
.B Parameters
\fBrefresh\fP (\fI\%bool\fP) \-\- Refresh the info for all groups in \fB__context__\fP\&. If False only
the groups in \fB__context__\fP will be returned. If True, the
\fB__context__\fP will be refreshed with current data and returned.
Default is False
.TP
.B Returns
A list of groups on the machine
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.list_groups
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_groupadd.members(name, members_list, **kwargs)
Ensure a group contains only the members in the list
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the group to modify
.IP \(bu 2
\fBmembers_list\fP (\fI\%str\fP) \-\- A single user or a comma separated list of users. The group will
contain only the users specified in this list.
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq group.members foo \(aquser1,user2,user3\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_iis
.sp
Microsoft IIS site management via WebAdministration powershell module
.INDENT 0.0
.TP
.B maintainer
Shane Lee <\fI\%slee@saltstack.com\fP>, Robert Booth <\fI\%rbooth@saltstack.com\fP>
.TP
.B platform
Windows
.TP
.B depends
PowerShell
.TP
.B depends
WebAdministration module (PowerShell) (IIS)
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.modules.win_iis.create_app(name, site, sourcepath, apppool=None)
Create an IIS application.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function only validates against the application name, and will
return True even if the application already exists with a different
configuration. It will not modify the configuration of an existing
application.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The IIS application.
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBsourcepath\fP (\fI\%str\fP) \-\- The physical path.
.IP \(bu 2
\fBapppool\fP (\fI\%str\fP) \-\- The name of the IIS application pool.
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.create_app name=\(aqapp0\(aq site=\(aqsite0\(aq sourcepath=\(aqC:\esite0\(aq apppool=\(aqsite0\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.create_apppool(name)
Create an IIS application pool.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function only validates against the application pool name, and will
return True even if the application pool already exists with a different
configuration. It will not modify the configuration of an existing
application pool.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the IIS application pool.
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.create_apppool name=\(aqMyTestPool\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.create_backup(name)
Backup an IIS Configuration on the System.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Backups are stored in the \fB$env:Windir\eSystem32\einetsrv\ebackup\fP
folder.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name to give the backup
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.create_backup good_config_20170209
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.create_binding(site, hostheader=\(aq\(aq, ipaddress=\(aq*\(aq, port=80, protocol=\(aqhttp\(aq, sslflags=None)
Create an IIS Web Binding.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function only validates against the binding
ipaddress:port:hostheader combination, and will return True even if the
binding already exists with a different configuration. It will not
modify the configuration of an existing binding.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBhostheader\fP (\fI\%str\fP) \-\- The host header of the binding. Usually a hostname.
.IP \(bu 2
\fBipaddress\fP (\fI\%str\fP) \-\- The IP address of the binding.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The TCP port of the binding.
.IP \(bu 2
\fBprotocol\fP (\fI\%str\fP) \-\- The application protocol of the binding.
.IP \(bu 2
\fBsslflags\fP (\fI\%str\fP) \-\- The flags representing certificate type and storage of
the binding.
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.create_binding site=\(aqsite0\(aq hostheader=\(aqexample.com\(aq ipaddress=\(aq*\(aq port=\(aq80\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.create_cert_binding(name, site, hostheader=\(aq\(aq, ipaddress=\(aq*\(aq, port=443, sslflags=0)
Assign a certificate to an IIS Web Binding.
.sp
New in version 2016.11.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The web binding that the certificate is being assigned to must already
exist.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The thumbprint of the certificate.
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBhostheader\fP (\fI\%str\fP) \-\- The host header of the binding.
.IP \(bu 2
\fBipaddress\fP (\fI\%str\fP) \-\- The IP address of the binding.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The TCP port of the binding.
.IP \(bu 2
\fBsslflags\fP (\fI\%int\fP) \-\- Flags representing certificate type and certificate storage of the binding.
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.create_cert_binding name=\(aqAAA000\(aq site=\(aqsite0\(aq hostheader=\(aqexample.com\(aq ipaddress=\(aq*\(aq port=\(aq443\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.create_site(name, sourcepath, apppool=\(aq\(aq, hostheader=\(aq\(aq, ipaddress=\(aq*\(aq, port=80, protocol=\(aqhttp\(aq)
Create a basic website in IIS.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function only validates against the site name, and will return True
even if the site already exists with a different configuration. It will
not modify the configuration of an existing site.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBsourcepath\fP (\fI\%str\fP) \-\- The physical path of the IIS site.
.IP \(bu 2
\fBapppool\fP (\fI\%str\fP) \-\- The name of the IIS application pool.
.IP \(bu 2
\fBhostheader\fP (\fI\%str\fP) \-\- The host header of the binding. Usually the hostname
or website name, ie: www.contoso.com
.IP \(bu 2
\fBipaddress\fP (\fI\%str\fP) \-\- The IP address of the binding.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The TCP port of the binding.
.IP \(bu 2
\fBprotocol\fP (\fI\%str\fP) \-\- The application protocol of the binding. (http, https,
etc.)
.UNINDENT
.TP
.B Returns
True if successful, otherwise False.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If an application pool is specified, and that application pool does not
already exist, it will be created.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.create_site name=\(aqMy Test Site\(aq sourcepath=\(aqc:\estage\(aq apppool=\(aqTestPool\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.create_vdir(name, site, sourcepath, app=\(aq/\(aq)
Create an IIS virtual directory.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function only validates against the virtual directory name, and
will return True even if the virtual directory already exists with a
different configuration. It will not modify the configuration of an
existing virtual directory.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The virtual directory name.
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBsourcepath\fP (\fI\%str\fP) \-\- The physical path.
.IP \(bu 2
\fBapp\fP (\fI\%str\fP) \-\- The IIS application.
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.create_vdir name=\(aqvd0\(aq site=\(aqsite0\(aq sourcepath=\(aqC:\einetpub\evdirs\evd0\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.get_container_setting(name, container, settings)
Get the value of the setting for the IIS container.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the IIS container.
.IP \(bu 2
\fBcontainer\fP (\fI\%str\fP) \-\- The type of IIS container. The container types are:
AppPools, Sites, SslBindings
.IP \(bu 2
\fBsettings\fP (\fI\%dict\fP) \-\- A dictionary of the setting names and their values.
.UNINDENT
.TP
.B Returns
A dictionary of the provided settings and their values.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.get_container_setting name=\(aqMyTestPool\(aq container=\(aqAppPools\(aq
    settings=\(dq[\(aqprocessModel.identityType\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.get_webapp_settings(name, site, settings)
New in version 2017.7.0.

.sp
Get the value of the setting for the IIS web application.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Params are case sensitive
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the IIS web application.
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The site name contains the web application.
Example: Default Web Site
.IP \(bu 2
\fBsettings\fP (\fI\%str\fP) \-\- A dictionary of the setting names and their values.
Available settings: physicalPath, applicationPool, userName, password
.UNINDENT
.TP
.B Returns
A dictionary of the provided settings and their values.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.get_webapp_settings name=\(aqapp0\(aq site=\(aqDefault Web Site\(aq
    settings=\(dq[\(aqphysicalPath\(aq,\(aqapplicationPool\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.get_webconfiguration_settings(name, settings)
Get the webconfiguration settings for the IIS PSPath.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The PSPath of the IIS webconfiguration settings.
.IP \(bu 2
\fBsettings\fP (\fI\%list\fP) \-\- A list of dictionaries containing setting name and filter.
.UNINDENT
.TP
.B Returns
A list of dictionaries containing setting name, filter and value.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.get_webconfiguration_settings name=\(aqIIS:\e\(aq settings=\(dq[{\(aqname\(aq: \(aqenabled\(aq, \(aqfilter\(aq: \(aqsystem.webServer/security/authentication/anonymousAuthentication\(aq}]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.list_apppools()
List all configured IIS application pools.
.INDENT 7.0
.TP
.B Returns
A dictionary of IIS application pools and their details.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.list_apppools
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.list_apps(site)
Get all configured IIS applications for the specified site.
.INDENT 7.0
.TP
.B Parameters
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.UNINDENT
.sp
Returns: A dictionary of the application names and properties.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.list_apps site
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.list_backups()
List the IIS Configuration Backups on the System.
.sp
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Backups are made when a configuration is edited. Manual backups are
stored in the \fB$env:Windir\eSystem32\einetsrv\ebackup\fP folder.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary of IIS Configurations backed up on the system.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.list_backups
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.list_bindings(site)
Get all configured IIS bindings for the specified site.
.INDENT 7.0
.TP
.B Parameters
\fBsite\fP (\fI\%str\fP) \-\- The name if the IIS Site
.TP
.B Returns
A dictionary of the binding names and properties.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.list_bindings site
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.list_cert_bindings(site)
List certificate bindings for an IIS site.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Parameters
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.TP
.B Returns
A dictionary of the binding names and properties.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.list_bindings site
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.list_sites()
List all the currently deployed websites.
.INDENT 7.0
.TP
.B Returns
A dictionary of the IIS sites and their properties.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.list_sites
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.list_vdirs(site, app=\(aq/\(aq)
Get all configured IIS virtual directories for the specified site, or for
the combination of site and application.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBapp\fP (\fI\%str\fP) \-\- The IIS application.
.UNINDENT
.TP
.B Returns
A dictionary of the virtual directory names and properties.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.list_vdirs site
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.list_worker_processes(apppool)
Returns a list of worker processes that correspond to the passed
application pool.
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B Parameters
\fBapppool\fP (\fI\%str\fP) \-\- The application pool to query
.TP
.B Returns
A dictionary of worker processes with their process IDs
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.list_worker_processes \(aqMy App Pool\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.modify_binding(site, binding, hostheader=None, ipaddress=None, port=None, sslflags=None)
Modify an IIS Web Binding. Use \fBsite\fP and \fBbinding\fP to target the
binding.
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBbinding\fP (\fI\%str\fP) \-\- The binding to edit. This is a combination of the
IP address, port, and hostheader. It is in the following format:
ipaddress:port:hostheader. For example, \fB*:80:\fP or
\fB*:80:salt.com\fP
.IP \(bu 2
\fBhostheader\fP (\fI\%str\fP) \-\- The host header of the binding. Usually the hostname.
.IP \(bu 2
\fBipaddress\fP (\fI\%str\fP) \-\- The IP address of the binding.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The TCP port of the binding.
.IP \(bu 2
\fBsslflags\fP (\fI\%str\fP) \-\- The flags representing certificate type and storage of
the binding.
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.sp
The following will seat the host header of binding \fB*:80:\fP for \fBsite0\fP
to \fBexample.com\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.modify_binding site=\(aqsite0\(aq binding=\(aq*:80:\(aq hostheader=\(aqexample.com\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.modify_site(name, sourcepath=None, apppool=None)
Modify a basic website in IIS.
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBsourcepath\fP (\fI\%str\fP) \-\- The physical path of the IIS site.
.IP \(bu 2
\fBapppool\fP (\fI\%str\fP) \-\- The name of the IIS application pool.
.UNINDENT
.TP
.B Returns
True if successful, otherwise False.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If an application pool is specified, and that application pool does not
already exist, it will be created.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.modify_site name=\(aqMy Test Site\(aq sourcepath=\(aqc:\enew_path\(aq apppool=\(aqNewTestPool\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.remove_app(name, site)
Remove an IIS application.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The application name.
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.remove_app name=\(aqapp0\(aq site=\(aqsite0\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.remove_apppool(name)
Remove an IIS application pool.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the IIS application pool.
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.remove_apppool name=\(aqMyTestPool\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.remove_backup(name)
Remove an IIS Configuration backup from the System.
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the backup to remove
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.remove_backup backup_20170209
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.remove_binding(site, hostheader=\(aq\(aq, ipaddress=\(aq*\(aq, port=80)
Remove an IIS binding.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBhostheader\fP (\fI\%str\fP) \-\- The host header of the binding.
.IP \(bu 2
\fBipaddress\fP (\fI\%str\fP) \-\- The IP address of the binding.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The TCP port of the binding.
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.remove_binding site=\(aqsite0\(aq hostheader=\(aqexample.com\(aq ipaddress=\(aq*\(aq port=\(aq80\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.remove_cert_binding(name, site, hostheader=\(aq\(aq, ipaddress=\(aq*\(aq, port=443)
Remove a certificate from an IIS Web Binding.
.sp
New in version 2016.11.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function only removes the certificate from the web binding. It does
not remove the web binding itself.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The thumbprint of the certificate.
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBhostheader\fP (\fI\%str\fP) \-\- The host header of the binding.
.IP \(bu 2
\fBipaddress\fP (\fI\%str\fP) \-\- The IP address of the binding.
.IP \(bu 2
\fBport\fP (\fI\%int\fP) \-\- The TCP port of the binding.
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.remove_cert_binding name=\(aqAAA000\(aq site=\(aqsite0\(aq hostheader=\(aqexample.com\(aq ipaddress=\(aq*\(aq port=\(aq443\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.remove_site(name)
Delete a website from IIS.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The IIS site name.
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This will not remove the application pool used by the site.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.remove_site name=\(aqMy Test Site\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.remove_vdir(name, site, app=\(aq/\(aq)
Remove an IIS virtual directory.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The virtual directory name.
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBapp\fP (\fI\%str\fP) \-\- The IIS application.
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.remove_vdir name=\(aqvdir0\(aq site=\(aqsite0\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.restart_apppool(name)
Restart an IIS application pool.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the IIS application pool.
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.restart_apppool name=\(aqMyTestPool\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.restart_site(name)
Restart a Web Site in IIS.
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the website to restart.
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.restart_site name=\(aqMy Test Site\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.set_container_setting(name, container, settings)
Set the value of the setting for an IIS container.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the IIS container.
.IP \(bu 2
\fBcontainer\fP (\fI\%str\fP) \-\- The type of IIS container. The container types are:
AppPools, Sites, SslBindings
.IP \(bu 2
\fBsettings\fP (\fI\%dict\fP) \-\- A dictionary of the setting names and their values.
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.set_container_setting name=\(aqMyTestPool\(aq container=\(aqAppPools\(aq
    settings=\(dq{\(aqmanagedPipeLineMode\(aq: \(aqIntegrated\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.set_webapp_settings(name, site, settings)
New in version 2017.7.0.

.sp
Configure an IIS application.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function only configures an existing app. Params are case
sensitive.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The IIS application.
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBsettings\fP (\fI\%str\fP) \-\- A dictionary of the setting names and their values.
\- physicalPath: The physical path of the webapp.
\- applicationPool: The application pool for the webapp.
\- userName: \(dqconnectAs\(dq user
\- password: \(dqconnectAs\(dq password for user
.UNINDENT
.TP
.B Returns
A boolean representing whether all changes succeeded.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.set_webapp_settings name=\(aqapp0\(aq site=\(aqsite0\(aq settings=\(dq{\(aqphysicalPath\(aq: \(aqC:\esite0\(aq, \(aqapppool\(aq: \(aqsite0\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.set_webconfiguration_settings(name, settings)
Set the value of the setting for an IIS container.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The PSPath of the IIS webconfiguration settings.
.IP \(bu 2
\fBsettings\fP (\fI\%list\fP) \-\- A list of dictionaries containing setting name, filter and value.
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.set_webconfiguration_settings name=\(aqIIS:\e\(aq settings=\(dq[{\(aqname\(aq: \(aqenabled\(aq, \(aqfilter\(aq: \(aqsystem.webServer/security/authentication/anonymousAuthentication\(aq, \(aqvalue\(aq: False}]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.start_apppool(name)
Start an IIS application pool.
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the App Pool to start.
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.start_apppool name=\(aqMyTestPool\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.start_site(name)
Start a Web Site in IIS.
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the website to start.
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.start_site name=\(aqMy Test Site\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.stop_apppool(name)
Stop an IIS application pool.
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the App Pool to stop.
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.stop_apppool name=\(aqMyTestPool\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_iis.stop_site(name)
Stop a Web Site in IIS.
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the website to stop.
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_iis.stop_site name=\(aqMy Test Site\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_ip
.sp
The networking module for Windows based systems
.INDENT 0.0
.TP
.B salt.modules.win_ip.disable(iface)
Disable an interface
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos_family:Windows\(aq ip.disable \(aqLocal Area Connection #2\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_ip.enable(iface)
Enable an interface
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos_family:Windows\(aq ip.enable \(aqLocal Area Connection #2\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_ip.get_all_interfaces()
Return configs for all interfaces
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos_family:Windows\(aq ip.get_all_interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_ip.get_default_gateway()
Set DNS source to DHCP on Windows
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos_family:Windows\(aq ip.get_default_gateway
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_ip.get_interface(iface)
Return the configuration of a network interface
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos_family:Windows\(aq ip.get_interface \(aqLocal Area Connection\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_ip.get_subnet_length(mask)
Convenience function to convert the netmask to the CIDR subnet length
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos_family:Windows\(aq ip.get_subnet_length 255.255.255.0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_ip.is_disabled(iface)
Returns \fBTrue\fP if interface is disabled, otherwise \fBFalse\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos_family:Windows\(aq ip.is_disabled \(aqLocal Area Connection #2\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_ip.is_enabled(iface)
Returns \fBTrue\fP if interface is enabled, otherwise \fBFalse\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos_family:Windows\(aq ip.is_enabled \(aqLocal Area Connection #2\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_ip.raw_interface_configs()
Return raw configs for all interfaces
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos_family:Windows\(aq ip.raw_interface_configs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_ip.set_dhcp_all(iface)
Set both IP Address and DNS to DHCP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos_family:Windows\(aq ip.set_dhcp_all \(aqLocal Area Connection\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_ip.set_dhcp_dns(iface)
Set DNS source to DHCP on Windows
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos_family:Windows\(aq ip.set_dhcp_dns \(aqLocal Area Connection\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_ip.set_dhcp_ip(iface)
Set Windows NIC to get IP from DHCP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos_family:Windows\(aq ip.set_dhcp_ip \(aqLocal Area Connection\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_ip.set_static_dns(iface, *addrs)
Set static DNS configuration on a Windows NIC
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBiface\fP (\fI\%str\fP) \-\- The name of the interface to set
.IP \(bu 2
\fBaddrs\fP \-\- One or more DNS servers to be added. To clear the list of DNS
servers pass an empty list (\fB[]\fP). If undefined or \fBNone\fP no
changes will be made.
.UNINDENT
.TP
.B Returns
A dictionary containing the new DNS settings
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos_family:Windows\(aq ip.set_static_dns \(aqLocal Area Connection\(aq \(aq192.168.1.1\(aq
salt \-G \(aqos_family:Windows\(aq ip.set_static_dns \(aqLocal Area Connection\(aq \(aq192.168.1.252\(aq \(aq192.168.1.253\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_ip.set_static_ip(iface, addr, gateway=None, append=False)
Set static IP configuration on a Windows NIC
.INDENT 7.0
.TP
.B iface
The name of the interface to manage
.TP
.B addr
IP address with subnet length (ex. \fB10.1.2.3/24\fP). The
\fI\%ip.get_subnet_length\fP
function can be used to calculate the subnet length from a netmask.
.TP
.B gateway
None
If specified, the default gateway will be set to this value.
.TP
.B append
False
If \fBTrue\fP, this IP address will be added to the interface. Default is
\fBFalse\fP, which overrides any existing configuration for the interface
and sets \fBaddr\fP as the only address on the interface.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos_family:Windows\(aq ip.set_static_ip \(aqLocal Area Connection\(aq 10.1.2.3/24 gateway=10.1.2.1
salt \-G \(aqos_family:Windows\(aq ip.set_static_ip \(aqLocal Area Connection\(aq 10.1.2.4/24 append=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_lgpo
.sp
Manage Local Policy on Windows
.sp
This module allows configuring local group policy (i.e. \fBgpedit.msc\fP) on a
Windows machine.
.sp
New in version 2016.11.0.

.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Local Group Policy will always be superseded by Domain Group policy. If
policies are configured with Local Group Policy that are also configured
with Domain Group policy, the Domain Group policy will take precedence.
.UNINDENT
.UNINDENT
.SS Administrative Templates
.sp
Administrative template policies are dynamically read from ADMX/ADML files on
the server.
.SS Windows Settings
.sp
Policies contained in the \(dqWindows Settings\(dq section of the \fBgpedit.msc\fP GUI
are statically defined in this module. Each policy is configured for the section
(Machine/User) in the module\(aqs _policy_info class. The \fB_policy_info\fP class
contains a \(dqpolicies\(dq dict on how the module will configure the policy, where
the policy resides in the GUI (for display purposes), data validation data, data
transformation data, etc.
.SS Current known limitations
.INDENT 0.0
.IP \(bu 2
At this time, start/shutdown scripts policies are displayed, but are not
configurable.
.IP \(bu 2
Not all \(dqSecurity Settings\(dq policies exist in the _policy_info class
.UNINDENT
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
pywin32 Python module
.IP \(bu 2
lxml
.IP \(bu 2
uuid
.IP \(bu 2
struct
.IP \(bu 2
salt.utils.win_reg
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_lgpo.clear_policy_cache()
Clears the policy definitions and resource stored in \fB__context__\fP\&. They
will be rebuilt the next time a policy is applied.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lgpo.clear_policy_cache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_lgpo.get(policy_class=None, return_full_policy_names=True, hierarchical_return=False, adml_language=\(aqen\-US\(aq, return_not_configured=False)
Get a policy value
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpolicy_class\fP (\fI\%str\fP) \-\- Some policies are both user and computer, by default all policies
will be pulled, but this can be used to retrieve only a specific
policy class User/USER/user = retrieve user policies
Machine/MACHINE/machine/Computer/COMPUTER/computer = retrieve
machine/computer policies
.IP \(bu 2
\fBreturn_full_policy_names\fP (\fI\%bool\fP) \-\- True/False to return the policy name as it is seen in the
\fBgpedit.msc\fP GUI or to only return the policy key/id.
.IP \(bu 2
\fBhierarchical_return\fP (\fI\%bool\fP) \-\- True/False to return the policy data in the hierarchy as seen in the
\fBgpedit.msc\fP GUI. The default of False will return data split only
into User/Computer configuration sections
.IP \(bu 2
\fBadml_language\fP (\fI\%str\fP) \-\- The ADML language to use for processing display/descriptive names
and enumeration values of ADMX template data, defaults to en\-US
.IP \(bu 2
\fBreturn_not_configured\fP (\fI\%bool\fP) \-\- Include Administrative Template policies that are \(aqNot Configured\(aq
in the return data
.UNINDENT
.TP
.B Returns
A dictionary containing the policy values for the specified class
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lgpo.get machine return_full_policy_names=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_lgpo.get_policy(policy_name, policy_class, adml_language=\(aqen\-US\(aq, return_value_only=True, return_full_policy_names=True, hierarchical_return=False)
Get the current settings for a single policy on the machine
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpolicy_name\fP (\fI\%str\fP) \-\- The name of the policy to retrieve. Can be the any of the names
or alieses returned by \fBlgpo.get_policy_info\fP
.IP \(bu 2
\fBpolicy_class\fP (\fI\%str\fP) \-\- The policy class. Must be one of \fBmachine\fP or \fBuser\fP
.IP \(bu 2
\fBadml_language\fP (\fI\%str\fP) \-\- The language code for the adml file to use for localization. The
default is \fBen\-US\fP
.IP \(bu 2
\fBreturn_value_only\fP (\fI\%bool\fP) \-\- \fBTrue\fP will return only the value for the policy, without the
name of the policy. \fBreturn_full_policy_names\fP and
\fBhierarchical_return\fP will be ignored. Default is \fBTrue\fP
.IP \(bu 2
\fBreturn_full_policy_names\fP (\fI\%bool\fP) \-\-
.sp
Returns the full policy name regardless of what was passed in
\fBpolicy_name\fP
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This setting applies to sub\-elements of the policy if they
exist. The value passed in \fBpolicy_name\fP will always be used
as the policy name when this setting is \fBFalse\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBhierarchical_return\fP (\fI\%bool\fP) \-\- Returns a hierarchical view of the policy showing its parents
.UNINDENT
.TP
.B Returns
A dictionary containing the policy settings
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Using the policy id
salt * lgpo.get_policy LockoutDuration machine
salt * lgpo.get_policy AutoUpdateCfg machine

# Using the full name
salt * lgpo.get_policy \(dqAccount lockout duration\(dq machine
salt * lgpo.get_policy \(dqConfigure Automatic Updates\(dq machine

# Using full path and name
salt * lgpo.get_policy \(dqWindows Components\eWindows Update\eConfigure Automatic Updates\(dq machine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_lgpo.get_policy_info(policy_name, policy_class, adml_language=\(aqen\-US\(aq)
Returns information about a specified policy
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpolicy_name\fP (\fI\%str\fP) \-\- The name of the policy to lookup
.IP \(bu 2
\fBpolicy_class\fP (\fI\%str\fP) \-\- The class of policy, i.e. machine, user, both
.IP \(bu 2
\fBadml_language\fP (\fI\%str\fP) \-\- The ADML language to use for Administrative Template data lookup
.UNINDENT
.TP
.B Returns
Information about the specified policy
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lgpo.get_policy_info \(aqMaximum password age\(aq machine
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can use \fBlgpo.get_policy_info\fP to get all the possible names that
could be used in a state file or from the command line (along with elements
that need to be set/etc). The key is to match the text you see in the
\fBgpedit.msc\fP gui exactly, including quotes around words or phrases. The
\(dqfull path\(dq style is really only needed when there are multiple policies
that use the same base name. For example, \fBAccess data sources across
domains\fP exists in ~10 different paths. If you put that through
\fBget_policy_info\fP you\(aqll get back a message that it is used for multiple
policies and you need to be more specific.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local lgpo.get_policy_info ShellRemoveOrderPrints_2 machine

local:
    \-\-\-\-\-\-\-\-\-\-
    message:
    policy_aliases:
        \- Turn off the \(dqOrder Prints\(dq picture task
        \- ShellRemoveOrderPrints_2
        \- System\eInternet Communication Management\eInternet Communication settings\eTurn off the \(dqOrder Prints\(dq picture task
    policy_class:
        machine
    policy_elements:
    policy_found:
        True
    policy_name:
        ShellRemoveOrderPrints_2
    rights_assignment:
        False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Escaping can get tricky in cmd/Powershell. The following is an example of
escaping in Powershell using backquotes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
PS>salt\-call \-\-local lgpo.get_policy_info \(dqTurn off the \(ga\e\(ga\(dqOrder Prints\(ga\e\(ga\(dq picture task\(dq machine

local:
    \-\-\-\-\-\-\-\-\-\-
    message:
    policy_aliases:
        \- Turn off the \(dqOrder Prints\(dq picture task
        \- ShellRemoveOrderPrints_2
        \- System\eInternet Communication Management\eInternet Communication settings\eTurn off the \(dqOrder Prints\(dq picture task
    policy_class:
        machine
    policy_elements:
    policy_found:
        True
    policy_name:
        Turn off the \(dqOrder Prints\(dq picture task
    rights_assignment:
        False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This function can then be used to get the options available for specifying
Group Policy Objects to be used in state files. Based on the above any of
these \fIshould\fP be usable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
internet_communications_settings:
  lgpo.set:
    \- computer_policy:
        Turn off the \(dqOrder Prints\(dq picture task: Enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
internet_communications_settings:
  lgpo.set:
    \- computer_policy:
        ShellRemoveOrderPrints_2: Enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When using the full path, it might be a good idea to use single quotes
around the path:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
internet_communications_settings:
  lgpo.set:
    \- computer_policy:
        \(aqSystem\eInternet Communication Management\eInternet Communication settings\eTurn off the \(dqOrder Prints\(dq picture task\(aq: \(aqEnabled\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you struggle to find the policy from \fBget_policy_info\fP using the name
as you see in \fBgpedit.msc\fP, the names such as \(dqShellRemoveOrderPrints_2\(dq
come from the \fB\&.admx\fP files. If you know nothing about \fB\&.admx/.adml\fP
relationships (ADML holds what you see in the GUI, ADMX holds the more
technical details), then this may be a little bit too much info, but here is
an example with the above policy using Powershell:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
PS>Get\-ChildItem \-Path C:\eWindows\ePolicyDefinitions \-Recurse \-Filter *.adml | Select\-String \(dqOrder Prints\(dq

C:\ewindows\ePolicyDefinitions\een\-US\eICM.adml:152:      <string id=\(dqShellRemoveOrderPrints\(dq>Turn off the \(dqOrder Prints\(dq picture task</string>
C:\ewindows\ePolicyDefinitions\een\-US\eICM.adml:153:      <string id=\(dqShellRemoveOrderPrints_Help\(dq>This policy setting specifies whether the \(dqOrder Prints Online\(dq task is available from Picture Tasks in Windows folders.
C:\ewindows\ePolicyDefinitions\een\-US\eICM.adml:155:The Order Prints Online Wizard is used to download a list of providers and allow users to order prints online.
C:\ewindows\ePolicyDefinitions\een\-US\eICM.adml:157:If you enable this policy setting, the task \(dqOrder Prints Online\(dq is removed from Picture Tasks in File Explorer folders.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
From this grep, we can see id \(dqShellRemoveOrderPrints\(dq is the ID of the
string used to describe this policy, then we search for it in the ADMX:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
PS>Get\-ChildItem \-Path C:\eWindows\ePolicyDefinitions \-Recurse \-Filter *.admx | Select\-String \(dqShellRemoveOrderPrints\(dq

C:\ewindows\ePolicyDefinitions\eICM.admx:661:    <policy name=\(dqShellRemoveOrderPrints_1\(dq class=\(dqUser\(dq displayName=\(dq$(string.ShellRemoveOrderPrints)\(dq explainText=\(dq$(string.ShellRemoveOrderPrints_Help)\(dq key=\(dqSoftware\eMicrosoft\eWindows\eCurrentVersion\ePolicies\eExplorer\(dq valueName=\(dqNoOnlinePrintsWizard\(dq>
C:\ewindows\ePolicyDefinitions\eICM.admx:671:    <policy name=\(dqShellRemoveOrderPrints_2\(dq class=\(dqMachine\(dq displayName=\(dq$(string.ShellRemoveOrderPrints)\(dq explainText=\(dq$(string.ShellRemoveOrderPrints_Help)\(dq key=\(dqSoftware\eMicrosoft\eWindows\eCurrentVersion\ePolicies\eExplorer\(dq valueName=\(dqNoOnlinePrintsWizard\(dq>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now we have two to pick from. And if you notice the \fBclass=\(dqMachine\(dq\fP and
\fBclass=\(dqUser\(dq\fP (which details if it is a computer policy or user policy
respectively) the \fBShellRemoveOrderPrints_2\fP is the \(dqshort name\(dq we could
use to pass through \fBget_policy_info\fP to see what the module itself is
expecting.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_lgpo.set_(computer_policy=None, user_policy=None, cumulative_rights_assignments=True, adml_language=\(aqen\-US\(aq)
Set a local server policy.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcomputer_policy\fP (\fI\%dict\fP) \-\-
.sp
A dictionary of \(dqpolicyname: value\(dq pairs of computer policies to
set. \(aqvalue\(aq should be how it is displayed in the gpedit GUI, i.e.
if a setting can be \(aqEnabled\(aq/\(aqDisabled\(aq, then that should be passed
.sp
Administrative Template data may require dicts within dicts, to
specify each element of the Administrative Template policy.
Administrative Templates policies are always cumulative.
.sp
Policy names can be specified in a number of ways based on the type
of policy:
.INDENT 2.0
.INDENT 3.5
Windows Settings Policies:
.INDENT 0.0
.INDENT 3.5
These policies can be specified using the GUI display name
or the key name from the _policy_info class in this module.
The GUI display name is also contained in the _policy_info
class in this module.
.UNINDENT
.UNINDENT
.sp
Administrative Template Policies:
.INDENT 0.0
.INDENT 3.5
These can be specified using the policy name as displayed in
the GUI (case sensitive). Some policies have the same name,
but a different location (for example, \(dqAccess data sources
across domains\(dq). These can be differentiated by the \(dqpath\(dq
in the GUI (for example, \(dqWindows ComponentsInternet
ExplorerInternet Control PanelSecurity PageInternet
ZoneAccess data sources across domains\(dq).
.sp
Additionally, policies can be specified using the \(dqname\(dq and
\(dqid\(dq attributes from the ADMX files.
.sp
For Administrative Templates that have policy elements, each
element can be specified using the text string as seen in
the GUI or using the ID attribute from the ADMX file. Due to
the way some of the GUI text is laid out, some policy
element names could include descriptive text that appears
lbefore the policy element in the GUI.
.sp
Use the get_policy_info function for the policy name to view
the element ID/names that the module will accept.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBuser_policy\fP (\fI\%dict\fP) \-\- The same setup as the computer_policy, except with data to configure
the local user policy.
.IP \(bu 2
\fBcumulative_rights_assignments\fP (\fI\%bool\fP) \-\-
.sp
Determine how user rights assignment policies are configured.
.sp
If True, user right assignment specifications are simply added to
the existing policy
.sp
If False, only the users specified will get the right (any existing
will have the right revoked)

.IP \(bu 2
\fBadml_language\fP (\fI\%str\fP) \-\- The language files to use for looking up Administrative Template
policy data (i.e. how the policy is displayed in the GUI). Defaults
to \(aqen\-US\(aq (U.S. English).
.UNINDENT
.TP
.B Returns
True is successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lgpo.set computer_policy=\(dq{\(aqLockoutDuration\(aq: 2, \(aqRestrictAnonymous\(aq: \(aqEnabled\(aq, \(aqAuditProcessTracking\(aq: \(aqSucces, Failure\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_lgpo.set_computer_policy(name, setting, cumulative_rights_assignments=True, adml_language=\(aqen\-US\(aq)
Set a single computer policy
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the policy to configure
.IP \(bu 2
\fBsetting\fP (\fI\%str\fP) \-\- The setting to configure the named policy with
.IP \(bu 2
\fBcumulative_rights_assignments\fP (\fI\%bool\fP) \-\- Determine how user rights
assignment policies are configured. If True, user right assignment
specifications are simply added to the existing policy. If False,
only the users specified will get the right (any existing will have
the right revoked)
.IP \(bu 2
\fBadml_language\fP (\fI\%str\fP) \-\- The language files to use for looking up
Administrative Template policy data (i.e. how the policy is
displayed in the GUI).  Defaults to \(aqen\-US\(aq (U.S. English).
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lgpo.set_computer_policy LockoutDuration 1440
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_lgpo.set_user_policy(name, setting, adml_language=\(aqen\-US\(aq)
Set a single user policy
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the policy to configure
.IP \(bu 2
\fBsetting\fP (\fI\%str\fP) \-\- The setting to configure the named policy with
.IP \(bu 2
\fBadml_language\fP (\fI\%str\fP) \-\- The language files to use for looking up Administrative Template
policy data (i.e. how the policy is displayed in the GUI). Defaults
to \(aqen\-US\(aq (U.S. English).
.UNINDENT
.TP
.B Returns
True if successful, Otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq lgpo.set_user_policy \(dqControl Panel\eDisplay\eDisable the Display Control Panel\(dq Enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_lgpo_reg
.SS LGPO \- Registry.pol
.sp
New in version 3006.0.

.sp
A module for working with registry based policies in Windows Local Group Policy
(LGPO). This module contains functions for working with the \fBRegistry.pol\fP
file. The \fBRegistry.pol\fP file is the source of truth for registry settings
and LGPO.
.sp
Group Policy is refreshed every 90 seconds by default. During that refresh the
contents of the \fBRegistry.pol\fP file are applied to the Registry. If the
setting is changed outside of Group Policy to something other than what is
contained in the \fBRegistry.pol\fP file, it will be changed back during the next
refresh.
.sp
In the Group Policy Editor (\fBgpedit.msc\fP) these policies can be set to three
states:
.INDENT 0.0
.IP \(bu 2
Not Configured
.IP \(bu 2
Enabled
.IP \(bu 2
Disabled
.UNINDENT
.sp
A policy that is \(dqNot Configured\(dq does not have an entry in the \fBRegistry.pol\fP
file. A Group Policy refresh will not make any changes to key/value pairs in the
registry that are not specified in the \fBRegistry.pol\fP file.
.sp
An \(dqEnabled\(dq policy will have an entry in the \fBRegistry.pol\fP files that
contains its key path, value name, value type, value size, and value data. When
Group Policy is refreshed, existing values will be overwritten with those
contained in the \fBRegistry.pol\fP file.
.sp
A \(dqDisabled\(dq policy will have an entry in the \fBRegistry.pol\fP file with the key
path and the value name, but the value name will be prepended with \fB**del.\fP\&.
When Group Policy is refreshed the key/value will be deleted from the registry.
If the key contains no values, it will also be deleted.
.SS Working with LGPO Reg
.sp
The easiest way to figure out the values needed for this module is to set the
policy using the Group Policy Editor (\fBgpedit.msc\fP) and then run the
\fBlgpo_reg.read_reg_pol\fP function. This function will display a dictionary of
all registry\-based policies in the \fBRegistry.pol\fP file. From its return you
can get the \fBkey\fP, \fBv_name\fP, \fBv_type\fP, and \fBv_data\fP required to \(dqenable\(dq
that policy. Use those values to set/disable/delete policies using this module.
The same values can also be used to create states for setting these policies.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Not all policies in the Group Policy Editor (\fBgpedit.msc\fP) that write to
the registry make that change in the \fBRegistry.pol\fP file. Those policies
could still be enforced via the \fBRegistry.pol\fP file... theoretically. But
you will have to find the values needed to set them with this module using a
different method.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_lgpo_reg.delete_value(key, v_name, policy_class=\(aqMachine\(aq)
Delete a key/value pair from the Registry.pol file. This bypasses the
admx/adml style policies. This is the equivalent of setting the policy to
\fBNot Configured\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The registry key path
.IP \(bu 2
\fBv_name\fP (\fI\%str\fP) \-\- The registry value name within the key
.IP \(bu 2
\fBpolicy_class\fP (\fI\%str\fP) \-\-
.sp
The registry class to write to. Can be one of the
following:
.INDENT 2.0
.IP \(bu 2
Computer
.IP \(bu 2
Machine
.IP \(bu 2
User
.UNINDENT
.sp
Default is \fBMachine\fP

.UNINDENT
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%SaltInvocationError\fP \-\- Invalid policy_class
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- On failure
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
None: Key/value not present
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Delete all values under a key
salt \(aq*\(aq lgpo_reg.delete_value \(dqSOFTWARE\eMyKey\(dq \(dqMyValue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_lgpo_reg.disable_value(key, v_name, policy_class=\(aqmachine\(aq)
Mark a registry value for deletion in the registry.pol file. This bypasses
the admx/adml style policies. This is the equivalent of setting the policy
to \fBDisabled\fP in the Group Policy editor (\fBgpedit.msc\fP)
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The registry key path
.IP \(bu 2
\fBv_name\fP (\fI\%str\fP) \-\- The registry value name within the key
.IP \(bu 2
\fBpolicy_class\fP (\fI\%str\fP) \-\-
.sp
The registry class to write to. Can be one of the
following:
.INDENT 2.0
.IP \(bu 2
Computer
.IP \(bu 2
Machine
.IP \(bu 2
User
.UNINDENT
.sp
Default is \fBMachine\fP

.UNINDENT
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%SaltInvocationError\fP \-\- Invalid policy_class
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- On failure
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
None: If already disabled
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Delete a value
salt \(aq*\(aq lgpo_reg.delete_value \(dqSOFTWARE\eMyKey\(dq \(dqMyValue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_lgpo_reg.get_key(key, policy_class=\(aqMachine\(aq)
Get all the values set in a key in the \fBRegistry.pol\fP file.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The registry key where the values reside
.IP \(bu 2
\fBpolicy_class\fP (\fI\%str\fP) \-\- The registry class to read from. Can be one of the
following:
.UNINDENT
.TP
.B Raises
\fI\%SaltInvocationError\fP \-\- Invalid policy class
.TP
.B Returns
A dictionary containing the value data and the value type
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Get all values from a key
salt \(aq*\(aq lgpo_reg.get_key \(dqSOFTWARE\eMyKey\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_lgpo_reg.get_value(key, v_name, policy_class=\(aqMachine\(aq)
Get the value of a single value pair as set in the \fBRegistry.pol\fP
file.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The registry key where the value name resides
.IP \(bu 2
\fBv_name\fP (\fI\%str\fP) \-\- The value name to retrieve
.IP \(bu 2
\fBpolicy_class\fP (\fI\%str\fP) \-\- The registry class to read from. Can be one of the
following:
.UNINDENT
.TP
.B Raises
\fI\%SaltInvocationError\fP \-\- Invalid policy class
.TP
.B Returns
A dictionary containing the value data and the value type found
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Get a value
salt \(aq*\(aq lgpo_reg.get_value \(dqSOFTWARE\eMyKey\(dq \(dqMyValue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_lgpo_reg.read_reg_pol(policy_class=\(aqMachine\(aq)
Read the contents of the Registry.pol file. Display the contents as a
human\-readable dictionary.
.INDENT 7.0
.TP
.B Parameters
\fBpolicy_class\fP (\fI\%str\fP) \-\-
.sp
The registry class to retrieve. Can be one of the
following:
.INDENT 7.0
.IP \(bu 2
Computer
.IP \(bu 2
Machine
.IP \(bu 2
User
.UNINDENT
.sp
Default is \fBMachine\fP

.TP
.B Raises
\fI\%SaltInvocationError\fP \-\- Invalid policy class
.TP
.B Returns
A dictionary representing the contents of the Registry.pol file
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Read the machine Registry.pol
salt \(aq*\(aq lgpo_reg.read_reg_pol
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_lgpo_reg.set_value(key, v_name, v_data, v_type=\(aqREG_DWORD\(aq, policy_class=\(aqMachine\(aq)
Add a key/value pair to the registry.pol file. This bypasses the admx/adml
style policies. This is the equivalent of setting a policy to \fBEnabled\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The registry key path
.IP \(bu 2
\fBv_name\fP (\fI\%str\fP) \-\- The registry value name within the key
.IP \(bu 2
\fBv_data\fP (\fI\%str\fP) \-\- The registry value
.IP \(bu 2
\fBv_type\fP (\fI\%str\fP) \-\-
.sp
The registry value type. Must be one of the following:
.INDENT 2.0
.IP \(bu 2
REG_BINARY
.IP \(bu 2
REG_DWORD
.IP \(bu 2
REG_EXPAND_SZ
.IP \(bu 2
REG_MULTI_SZ
.IP \(bu 2
REG_QWORD
.IP \(bu 2
REG_SZ
.UNINDENT
.sp
Default is REG_DWORD

.IP \(bu 2
\fBpolicy_class\fP (\fI\%str\fP) \-\-
.sp
The registry class to write to. Can be one of the
following:
.INDENT 2.0
.IP \(bu 2
Computer
.IP \(bu 2
Machine
.IP \(bu 2
User
.UNINDENT
.sp
Default is \fBMachine\fP

.UNINDENT
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%SaltInvocationError\fP \-\- Invalid policy_class
.IP \(bu 2
\fI\%SaltInvocationError\fP \-\- Invalid v_type
.IP \(bu 2
\fI\%SaltInvocationError\fP \-\- v_data doesn\(aqt match v_type
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Set REG_DWORD value (default)
salt \(aq*\(aq lgpo_reg.set_value \(dqSOFTWARE\eMyKey\(dq \(dqMyValue\(dq 1

# Set REG_SZ value
salt \(aq*\(aq lgpo_reg.set_value \(dqSOFTWARE\eMyKey\(dq \(dqMyValue\(dq \(dqstring value\(dq \(dqREG_SZ\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_lgpo_reg.write_reg_pol(data, policy_class=\(aqMachine\(aq)
Write data to the Registry.pol file. The data is a dictionary that is then
converted to the appropriate bytes format expected by Registry.pol
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdata\fP (\fI\%dict\fP) \-\- A dictionary containing Registry.pol data
.IP \(bu 2
\fBpolicy_class\fP (\fI\%str\fP) \-\-
.sp
The registry class to write to. Can be one of the
following:
.INDENT 2.0
.IP \(bu 2
Computer
.IP \(bu 2
Machine
.IP \(bu 2
User
.UNINDENT
.sp
Default is \fBMachine\fP

.UNINDENT
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%SaltInvocationError\fP \-\- Invalid policy class
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- On failure
.UNINDENT
.TP
.B Returns
True if successful
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Write to Machine Registry.pol
salt \(aq*\(aq lgpo_reg.write_reg_pol \(dq{\(aqSOFTWARE\eMyKey\(aq: {\(aqMyValue\(aq: \(aqdata\(aq: 1, \(aqtype\(aq: \(aqREG_DWORD\(aq}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_license
.sp
This module allows you to manage windows licensing via slmgr.vbs
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq license.install XXXXX\-XXXXX\-XXXXX\-XXXXX\-XXXXX
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_license.activate()
Attempt to activate the current machine via Windows Activation
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq license.activate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_license.info()
Return information about the license, if the license is not
correctly activated this will return None.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq license.info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_license.install(product_key)
Install the given product key
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq license.install XXXXX\-XXXXX\-XXXXX\-XXXXX\-XXXXX
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_license.installed(product_key)
Check to see if the product key is already installed.
.INDENT 7.0
.TP
.B Note: This is not 100% accurate as we can only see the last
5 digits of the license.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq license.installed XXXXX\-XXXXX\-XXXXX\-XXXXX\-XXXXX
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_license.licensed()
Return true if the current machine is licensed correctly
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq license.licensed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_license.uninstall()
Uninstall the current product key
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq license.uninstall
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_network
.sp
Module for gathering and managing network information
.INDENT 0.0
.TP
.B salt.modules.win_network.connect(host, port=None, **kwargs)
Test connectivity to a host using a particular
port from the minion.
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.connect archlinux.org 80

salt \(aq*\(aq network.connect archlinux.org 80 timeout=3

salt \(aq*\(aq network.connect archlinux.org 80 timeout=3 family=ipv4

salt \(aq*\(aq network.connect google\-public\-dns\-a.google.com port=53 proto=udp timeout=3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.dig(host)
Performs a DNS lookup with dig
.sp
Note: dig must be installed on the Windows minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.dig archlinux.org
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.get_route(ip)
Return routing information for given destination ip
.sp
New in version 2016.11.5.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.get_route 10.10.10.10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.hw_addr(iface)
Return the hardware address (a.k.a. MAC address) for a given interface
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.hw_addr \(aqWireless Connection #1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.hwaddr(iface)
This function is an alias of \fBhw_addr\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the hardware address (a.k.a. MAC address) for a given interface
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.hw_addr \(aqWireless Connection #1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.in_subnet(cidr)
Returns True if host is within specified subnet, otherwise False
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.in_subnet 10.0.0.0/16
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.interfaces()
Return a dictionary of information about all the interfaces on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.interfaces_names()
Return a list of all the interfaces names
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.interfaces_names
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.ip_addrs(interface=None, include_loopback=False, cidr=None, type=None)
Returns a list of IPv4 addresses assigned to the host.
.INDENT 7.0
.TP
.B interface
Only IP addresses from that interface will be returned.
.TP
.B include_loopback
False
Include loopback 127.0.0.1 IPv4 address.
.TP
.B cidr
.INDENT 7.0
.INDENT 3.5
Describes subnet using CIDR notation and only IPv4 addresses that belong
to this subnet will be returned.
.UNINDENT
.UNINDENT
.sp
Changed in version 2019.2.0.

.TP
.B type
If option set to \(aqpublic\(aq then only public addresses will be returned.
Ditto for \(aqprivate\(aq.
.sp
Changed in version 2019.2.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ip_addrs
salt \(aq*\(aq network.ip_addrs cidr=10.0.0.0/8
salt \(aq*\(aq network.ip_addrs cidr=192.168.0.0/16 type=private
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.ip_addrs6(interface=None, include_loopback=False, cidr=None)
Returns a list of IPv6 addresses assigned to the host.
.INDENT 7.0
.TP
.B interface
Only IP addresses from that interface will be returned.
.TP
.B include_loopback
False
Include loopback ::1 IPv6 address.
.TP
.B cidr
Describes subnet using CIDR notation and only IPv6 addresses that belong
to this subnet will be returned.
.sp
Changed in version 2019.2.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ip_addrs6
salt \(aq*\(aq network.ip_addrs6 cidr=2000::/3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.ipaddrs(interface=None, include_loopback=False, cidr=None, type=None)
This function is an alias of \fBip_addrs\fP\&.
.INDENT 7.0
.INDENT 3.5
Returns a list of IPv4 addresses assigned to the host.
.INDENT 0.0
.TP
.B interface
Only IP addresses from that interface will be returned.
.TP
.B include_loopback
False
Include loopback 127.0.0.1 IPv4 address.
.TP
.B cidr
.INDENT 7.0
.INDENT 3.5
Describes subnet using CIDR notation and only IPv4 addresses that belong
to this subnet will be returned.
.UNINDENT
.UNINDENT
.sp
Changed in version 2019.2.0.

.TP
.B type
If option set to \(aqpublic\(aq then only public addresses will be returned.
Ditto for \(aqprivate\(aq.
.sp
Changed in version 2019.2.0.

.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ip_addrs
salt \(aq*\(aq network.ip_addrs cidr=10.0.0.0/8
salt \(aq*\(aq network.ip_addrs cidr=192.168.0.0/16 type=private
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.ipaddrs6(interface=None, include_loopback=False, cidr=None)
This function is an alias of \fBip_addrs6\fP\&.
.INDENT 7.0
.INDENT 3.5
Returns a list of IPv6 addresses assigned to the host.
.INDENT 0.0
.TP
.B interface
Only IP addresses from that interface will be returned.
.TP
.B include_loopback
False
Include loopback ::1 IPv6 address.
.TP
.B cidr
Describes subnet using CIDR notation and only IPv6 addresses that belong
to this subnet will be returned.
.sp
Changed in version 2019.2.0.

.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ip_addrs6
salt \(aq*\(aq network.ip_addrs6 cidr=2000::/3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.is_private(ip_addr)
Check if the given IP address is a private address
.sp
New in version 2019.2.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.is_private 10.0.0.3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.netstat()
Return information on open ports and states
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.netstat
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.nslookup(host)
Query DNS for information about a domain or ip address
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.nslookup archlinux.org
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.ping(host, timeout=False, return_boolean=False)
Performs a ping to a host
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ping archlinux.org
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.sp
Return a True or False instead of ping output.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ping archlinux.org return_boolean=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Set the time to wait for a response in seconds.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.ping archlinux.org timeout=3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.subnets()
Returns a list of subnets to which the host belongs
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.subnets
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_network.traceroute(host)
Performs a traceroute to a 3rd party host
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq network.traceroute archlinux.org
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_ntp
.sp
Management of NTP servers on Windows
.sp
New in version 2014.1.0.

.INDENT 0.0
.TP
.B salt.modules.win_ntp.get_servers()
Get list of configured NTP servers
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ntp.get_servers
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_ntp.set_servers(*servers)
Set Windows to use a list of NTP servers
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq ntp.set_servers \(aqpool.ntp.org\(aq \(aqus.pool.ntp.org\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_path
.sp
Manage the Windows System PATH
.sp
Note that not all Windows applications will rehash the PATH environment variable,
Only the ones that listen to the WM_SETTINGCHANGE message.
.INDENT 0.0
.TP
.B salt.modules.win_path.add(path, index=None, **kwargs)
Add the directory to the SYSTEM path in the index location. Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP\&.
.INDENT 7.0
.TP
.B path
Directory to add to path
.TP
.B index
Optionally specify an index at which to insert the directory
.TP
.B rehash
True
If the registry was updated, and this value is set to \fBTrue\fP, sends a
WM_SETTINGCHANGE broadcast to refresh the environment variables. Set
this to \fBFalse\fP to skip this broadcast.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Will add to the beginning of the path
salt \(aq*\(aq win_path.add \(aqc:\epython27\(aq 0

# Will add to the end of the path
salt \(aq*\(aq win_path.add \(aqc:\epython27\(aq index=\(aq\-1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_path.exists(path)
Check if the directory is configured in the SYSTEM path
Case\-insensitive and ignores trailing backslash
.INDENT 7.0
.TP
.B Returns
boolean True if path exists, False if not
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_path.exists \(aqc:\epython27\(aq
salt \(aq*\(aq win_path.exists \(aqc:\epython27\e\(aq
salt \(aq*\(aq win_path.exists \(aqC:\epyThon27\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_path.get_path()
Returns a list of items in the SYSTEM path
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_path.get_path
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_path.rehash()
Send a WM_SETTINGCHANGE Broadcast to Windows to refresh the Environment
variables for new processes.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This will only affect new processes that aren\(aqt launched by services. To
apply changes to the path to services, the host must be restarted. The
\fBsalt\-minion\fP, if running as a service, will not see changes to the
environment until the system is restarted. See
\fI\%MSDN Documentation\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_path.rehash
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_path.remove(path, **kwargs)
Remove the directory from the SYSTEM path
.INDENT 7.0
.TP
.B Returns
boolean True if successful, False if unsuccessful
.UNINDENT
.INDENT 7.0
.TP
.B rehash
True
If the registry was updated, and this value is set to \fBTrue\fP, sends a
WM_SETTINGCHANGE broadcast to refresh the environment variables. Set
this to \fBFalse\fP to skip this broadcast.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Will remove C:\ePython27 from the path
salt \(aq*\(aq win_path.remove \(aqc:\e\epython27\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_pkg
.sp
A module to manage software on Windows
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage packages on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
The following functions require the existence of a \fI\%windows repository\fP metadata DB, typically created by running
\fI\%pkg.refresh_db\fP:
.INDENT 0.0
.IP \(bu 2
\fI\%pkg.get_repo_data\fP
.IP \(bu 2
\fI\%pkg.install\fP
.IP \(bu 2
\fI\%pkg.latest_version\fP
.IP \(bu 2
\fI\%pkg.list_available\fP
.IP \(bu 2
\fI\%pkg.list_pkgs\fP
.IP \(bu 2
\fI\%pkg.list_upgrades\fP
.IP \(bu 2
\fI\%pkg.remove\fP
.UNINDENT
.sp
If a metadata DB does not already exist and one of these functions is run, then
one will be created from the repo SLS files that are present.
.sp
As the creation of this metadata can take some time, the
\fI\%winrepo_cache_expire_min\fP minion config option can be used to
suppress refreshes when the metadata is less than a given number of seconds
old.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Version numbers can be \fBversion number string\fP, \fBlatest\fP and \fBNot
Found\fP, where \fBNot Found\fP means this module was not able to determine
the version of the software installed, it can also be used as the version
number in sls definitions file in these cases. Versions numbers are sorted
in order of 0, \fBNot Found\fP, \fBorder version numbers\fP, ..., \fBlatest\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.compare_versions(ver1=\(aq\(aq, oper=\(aq==\(aq, ver2=\(aq\(aq)
Compare software package versions. Made public for use with Jinja
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBver1\fP (\fI\%str\fP) \-\- A software version to compare
.IP \(bu 2
\fBoper\fP (\fI\%str\fP) \-\- The operand to use to compare
.IP \(bu 2
\fBver2\fP (\fI\%str\fP) \-\- A software version to compare
.UNINDENT
.TP
.B Returns
True if the comparison is valid, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.compare_versions 1.2 >= 1.3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.genrepo(**kwargs)
Generate package metadata db based on files within the winrepo_source_dir
.sp
Kwargs:
.INDENT 7.0
.INDENT 3.5
saltenv (str): Salt environment. Default: \fBbase\fP
.INDENT 0.0
.TP
.B verbose (bool):
Return verbose data structure which includes \(aqsuccess_list\(aq, a list
of all sls files and the package names contained within.
Default \fBFalse\fP\&.
.TP
.B failhard (bool):
If \fBTrue\fP, an error will be raised if any repo SLS files failed
to process. If \fBFalse\fP, no error will be raised, and a dictionary
containing the full results will be returned.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Hidden directories (directories beginning with \(aq\fI\&.\fP\(aq, such as
\(aq\fI\&.git\fP\(aq) will be ignored.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary of the results of the command
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run pkg.genrepo
salt \-G \(aqos:windows\(aq pkg.genrepo verbose=true failhard=false
salt \-G \(aqos:windows\(aq pkg.genrepo saltenv=base
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.get_package_info(name, saltenv=\(aqbase\(aq)
Get information about the package as found in the winrepo database
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- The salt environment to use. Default is \(dqbase\(dq
.UNINDENT
.TP
.B Returns
A dictionary of package info, empty if package not available
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.get_package_info chrome
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.get_repo_data(saltenv=\(aqbase\(aq)
Returns the existing package metadata db. Will create it, if it does not
exist, however will not refresh it.
.INDENT 7.0
.TP
.B Parameters
\fBsaltenv\fP (\fI\%str\fP) \-\- Salt environment. Default \fBbase\fP
.TP
.B Returns
A dict containing contents of metadata db.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.get_repo_data
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.install(name=None, refresh=False, pkgs=None, **kwargs)
Install the passed package(s) on the system using winrepo
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of a single package, or a comma\-separated list of packages
to install. (no spaces after the commas)
.IP \(bu 2
\fBrefresh\fP (\fI\%bool\fP) \-\- Boolean value representing whether or not to refresh the winrepo db.
Default \fBFalse\fP\&.
.IP \(bu 2
\fBpkgs\fP (\fI\%list\fP) \-\-
.sp
A list of packages to install from a software repository. All
packages listed under \fBpkgs\fP will be installed via a single
command.
.sp
You can specify a version by passing the item as a dict:
.sp
CLI Example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
# will install the latest version of foo and bar
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq

# will install the latest version of foo and version 1.2.3 of bar
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, {\(dqbar\(dq: \(dq1.2.3\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Kwargs:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B version (str):
The specific version to install. If omitted, the latest version will
be installed. Recommend for use when installing a single package.
.sp
If passed with a list of packages in the \fBpkgs\fP parameter, the
version will be ignored.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Version is ignored
salt \(aq*\(aq pkg.install pkgs=\(dq[\(aqfoo\(aq, \(aqbar\(aq]\(dq version=1.2.3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
If passed with a comma separated list in the \fBname\fP parameter, the
version will apply to all packages in the list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Version 1.2.3 will apply to packages foo and bar
salt \(aq*\(aq pkg.install foo,bar version=1.2.3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B extra_install_flags (str):
Additional install flags that will be appended to the
\fBinstall_flags\fP defined in the software definition file. Only
applies when single package is passed.
.TP
.B saltenv (str):
Salt environment. Default \(aqbase\(aq
.TP
.B report_reboot_exit_codes (bool):
If the installer exits with a recognized exit code indicating that
a reboot is required, the module function
.INDENT 7.0
.INDENT 3.5
\fIwin_system.set_reboot_required_witnessed\fP
.UNINDENT
.UNINDENT
.sp
will be called, preserving the knowledge of this event for the
remainder of the current boot session. For the time being, 3010 is
the only recognized exit code. The value of this param defaults to
True.
.sp
New in version 2016.11.0.

.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
Return a dict containing the new package names and versions. If
the package is already installed, an empty dict is returned.
.sp
If the package is installed by \fBpkg.install\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
The following example will refresh the winrepo and install a single
package, 7zip.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install 7zip refresh=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install 7zip
salt \(aq*\(aq pkg.install 7zip,filezilla
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dq7zip\(dq,\(dqfilezilla\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
WinRepo Definition File Examples:
.sp
The following example demonstrates the use of \fBcache_file\fP\&. This would be
used if you have multiple installers in the same directory that use the
same \fBinstall.ini\fP file and you don\(aqt want to download the additional
installers.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ntp:
  4.2.8:
    installer: \(aqsalt://win/repo/ntp/ntp\-4.2.8\-win32\-setup.exe\(aq
    full_name: Meinberg NTP Windows Client
    locale: en_US
    reboot: False
    cache_file: \(aqsalt://win/repo/ntp/install.ini\(aq
    install_flags: \(aq/USEFILE=C:\esalt\evar\ecache\esalt\eminion\efiles\ebase\ewin\erepo\entp\einstall.ini\(aq
    uninstaller: \(aqNTP/uninst.exe\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following example demonstrates the use of \fBcache_dir\fP\&. It assumes a
file named \fBinstall.ini\fP resides in the same directory as the installer.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ntp:
  4.2.8:
    installer: \(aqsalt://win/repo/ntp/ntp\-4.2.8\-win32\-setup.exe\(aq
    full_name: Meinberg NTP Windows Client
    locale: en_US
    reboot: False
    cache_dir: True
    install_flags: \(aq/USEFILE=C:\esalt\evar\ecache\esalt\eminion\efiles\ebase\ewin\erepo\entp\einstall.ini\(aq
    uninstaller: \(aqNTP/uninst.exe\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.latest_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Since this is looking for the latest version available, a refresh_db
will be triggered by default. This can take some time. To avoid this set
\fBrefresh\fP to \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBnames\fP (\fI\%str\fP) \-\- A single or multiple names to lookup
.UNINDENT
.INDENT 7.0
.TP
.B Kwargs:
saltenv (str): Salt environment. Default \fBbase\fP
refresh (bool): Refresh package metadata. Default \fBTrue\fP
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary of packages with the latest version available
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.list_available(*names, **kwargs)
Return a list of available versions of the specified package.
.INDENT 7.0
.TP
.B Parameters
\fBnames\fP (\fI\%str\fP) \-\- One or more package names
.UNINDENT
.sp
Kwargs:
.INDENT 7.0
.INDENT 3.5
saltenv (str): The salt environment to use. Default \fBbase\fP\&.
.sp
refresh (bool): Refresh package metadata. Default \fBFalse\fP\&.
.INDENT 0.0
.TP
.B return_dict_always (bool):
Default \fBFalse\fP dict when a single package name is queried.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
The package name with its available versions
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package name>\(aq: [\(aq<version>\(aq, \(aq<version>\(aq, ]}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_available <package name> return_dict_always=True
salt \(aq*\(aq pkg.list_available <package name01> <package name02>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.list_pkgs(versions_as_list=False, include_components=True, include_updates=True, **kwargs)
List the packages currently installed.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To view installed software as displayed in the Add/Remove Programs, set
\fBinclude_components\fP and \fBinclude_updates\fP to False.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBversions_as_list\fP (\fI\%bool\fP) \-\- Returns the versions as a list
.IP \(bu 2
\fBinclude_components\fP (\fI\%bool\fP) \-\- Include sub components of installed software. Default is \fBTrue\fP
.IP \(bu 2
\fBinclude_updates\fP (\fI\%bool\fP) \-\- Include software updates and Windows updates. Default is \fBTrue\fP
.UNINDENT
.UNINDENT
.sp
Kwargs:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B saltenv (str):
The salt environment to use. Default \fBbase\fP
.TP
.B refresh (bool):
Refresh package metadata. Default \fBFalse\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary of installed software with versions installed
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
salt \(aq*\(aq pkg.list_pkgs versions_as_list=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.list_upgrades(refresh=True, **kwargs)
List all available package upgrades on this system
.INDENT 7.0
.TP
.B Parameters
\fBrefresh\fP (\fI\%bool\fP) \-\- Refresh package metadata. Default \fBTrue\fP
.UNINDENT
.INDENT 7.0
.TP
.B Kwargs:
saltenv (str): Salt environment. Default \fBbase\fP
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary of packages with available upgrades
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.normalize_name(name)
Nothing to do on Windows. We need this function so that Salt doesn\(aqt go
through every module looking for \fBpkg.normalize_name\fP\&.
.sp
New in version 3006.0.

.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the package
.TP
.B Returns
The name of the package
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.normalize_name git
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.purge(name=None, pkgs=None, **kwargs)
Package purges are not supported on Windows, this function is identical to
\fBremove()\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
At some point in the future, \fBpkg.purge\fP may direct the installer to
remove all configs and settings for software packages that support that
option.
.UNINDENT
.UNINDENT
.sp
New in version 0.16.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to be deleted.
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\- The version of the package to be deleted. If this option is
used in combination with the \fBpkgs\fP option below, then this
version will be applied to all targeted packages.
.IP \(bu 2
\fBpkgs\fP (\fI\%list\fP) \-\- A list of packages to delete. Must be passed as a python
list. The \fBname\fP parameter will be ignored if this option is
passed.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Kwargs:
saltenv (str): Salt environment. Default \fBbase\fP
refresh (bool): Refresh package metadata. Default \fBFalse\fP
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dict containing the changes.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.purge <package name>
salt \(aq*\(aq pkg.purge <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.purge pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.refresh_db(**kwargs)
Generates the local software metadata database (\fIwinrepo.p\fP) on the minion.
The database is stored in a serialized format located by default at the
following location:
.sp
\fBC:\eProgramData\eSalt Project\eSalt\evar\ecache\esalt\eminion\efiles\ebase\ewin\erepo\-ng\ewinrepo.p\fP
.sp
This module performs the following steps to generate the software metadata
database:
.INDENT 7.0
.IP \(bu 2
Fetch the package definition files (.sls) from \fIwinrepo_source_dir\fP
(default \fIsalt://win/repo\-ng\fP) and cache them in
\fI<cachedir>files<saltenv><winrepo_source_dir>\fP
(default: \fBC:\eProgramData\eSalt Project\eSalt\evar\ecache\esalt\eminion\efiles\ebase\ewin\erepo\-ng\fP)
.IP \(bu 2
Call \fI\%pkg.genrepo\fP to parse the
package definition files and generate the repository metadata database
file (\fIwinrepo.p\fP)
.IP \(bu 2
Return the report received from
\fI\%pkg.genrepo\fP
.UNINDENT
.sp
The default winrepo directory on the master is \fI/srv/salt/win/repo\-ng\fP\&. All
files that end with \fI\&.sls\fP in this and all subdirectories will be used to
generate the repository metadata database (\fIwinrepo.p\fP).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Hidden directories (directories beginning with \(aq\fI\&.\fP\(aq, such as
\(aq\fI\&.git\fP\(aq) will be ignored.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
There is no need to call \fIpkg.refresh_db\fP every time you work with the
pkg module. Automatic refresh will occur based on the following minion
configuration settings:
.INDENT 0.0
.IP \(bu 2
\fIwinrepo_cache_expire_min\fP
.IP \(bu 2
\fIwinrepo_cache_expire_max\fP
.UNINDENT
.sp
However, if the package definition files have changed, as would be the
case if you are developing a new package definition, this function
should be called to ensure the minion has the latest information about
packages available to it.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Directories and files fetched from <winrepo_source_dir>
(\fI/srv/salt/win/repo\-ng\fP) will be processed in alphabetical order. If
two or more software definition files contain the same name, the last
one processed replaces all data from the files processed before it.
.UNINDENT
.UNINDENT
.sp
For more information see
\fI\%Windows Software Repository\fP
.sp
Arguments:
.sp
saltenv (str): Salt environment. Default: \fBbase\fP
.INDENT 7.0
.TP
.B verbose (bool):
Return a verbose data structure which includes \(aqsuccess_list\(aq, a
list of all sls files and the package names contained within.
Default is \(aqFalse\(aq
.TP
.B failhard (bool):
If \fBTrue\fP, an error will be raised if any repo SLS files fails to
process. If \fBFalse\fP, no error will be raised, and a dictionary
containing the full results will be returned.
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary containing the results of the database refresh.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A result with a \fItotal: 0\fP generally means that the files are in the
wrong location on the master. Try running the following command on the
minion: \fIsalt\-call \-l debug pkg.refresh saltenv=base\fP
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
When calling this command from a state using \fImodule.run\fP be sure to
pass \fIfailhard: False\fP\&. Otherwise, the state will report failure if it
encounters a bad software definition file.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db
salt \(aq*\(aq pkg.refresh_db saltenv=base
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.remove(name=None, pkgs=None, **kwargs)
Remove the passed package(s) from the system using winrepo
.sp
New in version 0.16.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name(s) of the package(s) to be uninstalled. Can be a
single package or a comma delimited list of packages, no spaces.
.IP \(bu 2
\fBpkgs\fP (\fI\%list\fP) \-\- A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.UNINDENT
.sp
Kwargs:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B version (str):
The version of the package to be uninstalled. If this option is
used to to uninstall multiple packages, then this version will be
applied to all targeted packages. Recommended using only when
uninstalling a single package. If this parameter is omitted, the
latest version will be uninstalled.
.UNINDENT
.sp
saltenv (str): Salt environment. Default \fBbase\fP
refresh (bool): Refresh package metadata. Default \fBFalse\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
Returns a dict containing the changes.
.sp
If the package is removed by \fBpkg.remove\fP:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B {\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
\(aqnew\(aq: \(aq<new\-version>\(aq}}
.UNINDENT
.UNINDENT
.UNINDENT
.sp
If the package is already uninstalled:
.INDENT 7.0
.INDENT 3.5
{\(aq<package>\(aq: {\(aqcurrent\(aq: \(aqnot installed\(aq}}
.UNINDENT
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.upgrade(**kwargs)
Upgrade all software. Currently not implemented
.INDENT 7.0
.TP
.B Kwargs:
saltenv (str): The salt environment to use. Default \fBbase\fP\&.
refresh (bool): Refresh package metadata. Default \fBTrue\fP\&.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This feature is not yet implemented for Windows.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
Empty dict, until implemented
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.upgrade_available(name, **kwargs)
Check whether or not an upgrade is available for a given package
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of a single package
.UNINDENT
.INDENT 7.0
.TP
.B Kwargs:
refresh (bool): Refresh package metadata. Default \fBTrue\fP
saltenv (str): The salt environment. Default \fBbase\fP
.UNINDENT
.INDENT 7.0
.TP
.B Returns
True if new version available, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade_available <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pkg.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- One or more package names
.UNINDENT
.INDENT 7.0
.TP
.B Kwargs:
saltenv (str): The salt environment to use. Default \fBbase\fP\&.
refresh (bool): Refresh package metadata. Default \fBFalse\fP\&.
.UNINDENT
.INDENT 7.0
.TP
.B Returns
version string when a single package is specified.
dict: The package name(s) with the installed versions.
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{[\(aq<version>\(aq, \(aq<version>\(aq, ]} OR
{\(aq<package name>\(aq: [\(aq<version>\(aq, \(aq<version>\(aq, ]}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package name01> <package name02>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_pki
.sp
Microsoft certificate management via the PKI Client PowerShell module.
\fI\%https://technet.microsoft.com/en\-us/itpro/powershell/windows/pkiclient/pkiclient\fP
.sp
The PKI Client PowerShell module is only available on Windows 8+ and Windows
Server 2012+.
\fI\%https://technet.microsoft.com/en\-us/library/hh848636(v=wps.620).aspx\fP
.INDENT 0.0
.TP
.B platform
Windows
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
PowerShell 4
.IP \(bu 2
PKI Client Module (Windows 8+ / Windows Server 2012+)
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.modules.win_pki.export_cert(name, thumbprint, cert_format=\(aqcer\(aq, context=\(aqLocalMachine\(aq, store=\(aqMy\(aq, password=\(aq\(aq)
Export the certificate to a file from the given certificate store.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The destination path for the exported certificate file.
.IP \(bu 2
\fBthumbprint\fP (\fI\%str\fP) \-\- The thumbprint value of the target certificate.
.IP \(bu 2
\fBcert_format\fP (\fI\%str\fP) \-\- The certificate format. Specify \(aqcer\(aq for X.509, or
\(aqpfx\(aq for PKCS #12.
.IP \(bu 2
\fBcontext\fP (\fI\%str\fP) \-\- The name of the certificate store location context.
.IP \(bu 2
\fBstore\fP (\fI\%str\fP) \-\- The name of the certificate store.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- The password of the certificate. Only applicable to pfx
format. Note that if used interactively, the password will be seen by all minions.
To protect the password, use a state and get the password from pillar.
.UNINDENT
.TP
.B Returns
A boolean representing whether all changes succeeded.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_pki.export_cert name=\(aqC:\ecerts\eexample.cer\(aq thumbprint=\(aqAAA000\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pki.get_cert_file(name, cert_format=\(aqcer\(aq, password=\(aq\(aq)
Get the details of the certificate file.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The filesystem path of the certificate file.
.IP \(bu 2
\fBcert_format\fP (\fI\%str\fP) \-\- The certificate format. Specify \(aqcer\(aq for X.509, or
\(aqpfx\(aq for PKCS #12.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- The password of the certificate. Only applicable to pfx
format. Note that if used interactively, the password will be seen by all minions.
To protect the password, use a state and get the password from pillar.
.UNINDENT
.TP
.B Returns
A dictionary of the certificate thumbprints and properties.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_pki.get_cert_file name=\(aqC:\ecerts\eexample.cer\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pki.get_certs(context=\(aqLocalMachine\(aq, store=\(aqMy\(aq)
Get the available certificates in the given store.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontext\fP (\fI\%str\fP) \-\- The name of the certificate store location context.
.IP \(bu 2
\fBstore\fP (\fI\%str\fP) \-\- The name of the certificate store.
.UNINDENT
.TP
.B Returns
A dictionary of the certificate thumbprints and properties.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_pki.get_certs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pki.get_stores()
Get the certificate location contexts and their corresponding stores.
.INDENT 7.0
.TP
.B Returns
A dictionary of the certificate location contexts and stores.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_pki.get_stores
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pki.import_cert(name, cert_format=\(aqcer\(aq, context=\(aqLocalMachine\(aq, store=\(aqMy\(aq, exportable=True, password=\(aq\(aq, saltenv=\(aqbase\(aq)
Import the certificate file into the given certificate store.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The path of the certificate file to import.
.IP \(bu 2
\fBcert_format\fP (\fI\%str\fP) \-\- The certificate format. Specify \(aqcer\(aq for X.509, or
\(aqpfx\(aq for PKCS #12.
.IP \(bu 2
\fBcontext\fP (\fI\%str\fP) \-\- The name of the certificate store location context.
.IP \(bu 2
\fBstore\fP (\fI\%str\fP) \-\- The name of the certificate store.
.IP \(bu 2
\fBexportable\fP (\fI\%bool\fP) \-\- Mark the certificate as exportable. Only applicable
to pfx format.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- The password of the certificate. Only applicable to pfx
format. Note that if used interactively, the password will be seen by all minions.
To protect the password, use a state and get the password from pillar.
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- The environment the file resides in.
.UNINDENT
.TP
.B Returns
A boolean representing whether all changes succeeded.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_pki.import_cert name=\(aqsalt://cert.cer\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pki.remove_cert(thumbprint, context=\(aqLocalMachine\(aq, store=\(aqMy\(aq)
Remove the certificate from the given certificate store.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBthumbprint\fP (\fI\%str\fP) \-\- The thumbprint value of the target certificate.
.IP \(bu 2
\fBcontext\fP (\fI\%str\fP) \-\- The name of the certificate store location context.
.IP \(bu 2
\fBstore\fP (\fI\%str\fP) \-\- The name of the certificate store.
.UNINDENT
.TP
.B Returns
A boolean representing whether all changes succeeded.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_pki.remove_cert thumbprint=\(aqAAA000\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_pki.test_cert(thumbprint, context=\(aqLocalMachine\(aq, store=\(aqMy\(aq, untrusted_root=False, dns_name=\(aq\(aq, eku=\(aq\(aq)
Check the certificate for validity.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBthumbprint\fP (\fI\%str\fP) \-\- The thumbprint value of the target certificate.
.IP \(bu 2
\fBcontext\fP (\fI\%str\fP) \-\- The name of the certificate store location context.
.IP \(bu 2
\fBstore\fP (\fI\%str\fP) \-\- The name of the certificate store.
.IP \(bu 2
\fBuntrusted_root\fP (\fI\%bool\fP) \-\- Whether the root certificate is required to be
trusted in chain building.
.IP \(bu 2
\fBdns_name\fP (\fI\%str\fP) \-\- The DNS name to verify as valid for the certificate.
.IP \(bu 2
\fBeku\fP (\fI\%str\fP) \-\- The enhanced key usage object identifiers to verify for the
certificate chain.
.UNINDENT
.TP
.B Returns
A boolean representing whether the certificate was considered
valid.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_pki.test_cert thumbprint=\(aqAAA000\(aq dns_name=\(aqexample.test\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_powercfg
.sp
This module allows you to control the power settings of a windows minion via
powercfg.
.sp
New in version 2015.8.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Set monitor to never turn off on Battery power
salt \(aq*\(aq powercfg.set_monitor_timeout 0 power=dc
# Set disk timeout to 120 minutes on AC power
salt \(aq*\(aq powercfg.set_disk_timeout 120 power=ac
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_powercfg.get_disk_timeout(scheme=None)
Get the current disk timeout of the given scheme
.INDENT 7.0
.TP
.B Parameters
\fBscheme\fP (\fI\%str\fP) \-\-
.sp
The scheme to use, leave as \fBNone\fP to use the current. Default is
\fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known
Aliases are:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBSCHEME_BALANCED\fP \- Balanced
.IP \(bu 2
\fBSCHEME_MAX\fP \- Power saver
.IP \(bu 2
\fBSCHEME_MIN\fP \- High performance
.UNINDENT
.UNINDENT
.UNINDENT

.TP
.B Returns
A dictionary of both the AC and DC settings
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq powercfg.get_disk_timeout
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_powercfg.get_hibernate_timeout(scheme=None)
Get the current hibernate timeout of the given scheme
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B scheme (str):
The scheme to use, leave as \fBNone\fP to use the current. Default is
\fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known
Aliases are:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBSCHEME_BALANCED\fP \- Balanced
.IP \(bu 2
\fBSCHEME_MAX\fP \- Power saver
.IP \(bu 2
\fBSCHEME_MIN\fP \- High performance
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary of both the AC and DC settings
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq powercfg.get_hibernate_timeout
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_powercfg.get_monitor_timeout(scheme=None)
Get the current monitor timeout of the given scheme
.INDENT 7.0
.TP
.B Parameters
\fBscheme\fP (\fI\%str\fP) \-\-
.sp
The scheme to use, leave as \fBNone\fP to use the current. Default is
\fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known
Aliases are:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBSCHEME_BALANCED\fP \- Balanced
.IP \(bu 2
\fBSCHEME_MAX\fP \- Power saver
.IP \(bu 2
\fBSCHEME_MIN\fP \- High performance
.UNINDENT
.UNINDENT
.UNINDENT

.TP
.B Returns
A dictionary of both the AC and DC settings
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq powercfg.get_monitor_timeout
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_powercfg.get_standby_timeout(scheme=None)
Get the current standby timeout of the given scheme
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B scheme (str):
The scheme to use, leave as \fBNone\fP to use the current. Default is
\fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known
Aliases are:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBSCHEME_BALANCED\fP \- Balanced
.IP \(bu 2
\fBSCHEME_MAX\fP \- Power saver
.IP \(bu 2
\fBSCHEME_MIN\fP \- High performance
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary of both the AC and DC settings
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq powercfg.get_standby_timeout
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_powercfg.set_disk_timeout(timeout, power=\(aqac\(aq, scheme=None)
Set the disk timeout in minutes for the given power scheme
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- The amount of time in minutes before the disk will timeout
.IP \(bu 2
\fBpower\fP (\fI\%str\fP) \-\-
.sp
Set the value for AC or DC power. Default is \fBac\fP\&. Valid options
are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBac\fP (AC Power)
.IP \(bu 2
\fBdc\fP (Battery)
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBscheme\fP (\fI\%str\fP) \-\-
.sp
The scheme to use, leave as \fBNone\fP to use the current. Default is
\fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known
Aliases are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBSCHEME_BALANCED\fP \- Balanced
.IP \(bu 2
\fBSCHEME_MAX\fP \- Power saver
.IP \(bu 2
\fBSCHEME_MIN\fP \- High performance
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Sets the disk timeout to 30 minutes on battery
salt \(aq*\(aq powercfg.set_disk_timeout 30 power=dc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_powercfg.set_hibernate_timeout(timeout, power=\(aqac\(aq, scheme=None)
Set the hibernate timeout in minutes for the given power scheme
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- The amount of time in minutes before the computer hibernates
.IP \(bu 2
\fBpower\fP (\fI\%str\fP) \-\-
.sp
Set the value for AC or DC power. Default is \fBac\fP\&. Valid options
are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBac\fP (AC Power)
.IP \(bu 2
\fBdc\fP (Battery)
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBscheme\fP (\fI\%str\fP) \-\-
.sp
The scheme to use, leave as \fBNone\fP to use the current. Default is
\fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known
Aliases are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBSCHEME_BALANCED\fP \- Balanced
.IP \(bu 2
\fBSCHEME_MAX\fP \- Power saver
.IP \(bu 2
\fBSCHEME_MIN\fP \- High performance
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Sets the hibernate timeout to 30 minutes on Battery
salt \(aq*\(aq powercfg.set_hibernate_timeout 30 power=dc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_powercfg.set_monitor_timeout(timeout, power=\(aqac\(aq, scheme=None)
Set the monitor timeout in minutes for the given power scheme
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- The amount of time in minutes before the monitor will timeout
.IP \(bu 2
\fBpower\fP (\fI\%str\fP) \-\-
.sp
Set the value for AC or DC power. Default is \fBac\fP\&. Valid options
are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBac\fP (AC Power)
.IP \(bu 2
\fBdc\fP (Battery)
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBscheme\fP (\fI\%str\fP) \-\-
.sp
The scheme to use, leave as \fBNone\fP to use the current. Default is
\fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known
Aliases are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBSCHEME_BALANCED\fP \- Balanced
.IP \(bu 2
\fBSCHEME_MAX\fP \- Power saver
.IP \(bu 2
\fBSCHEME_MIN\fP \- High performance
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Sets the monitor timeout to 30 minutes
salt \(aq*\(aq powercfg.set_monitor_timeout 30
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_powercfg.set_standby_timeout(timeout, power=\(aqac\(aq, scheme=None)
Set the standby timeout in minutes for the given power scheme
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- The amount of time in minutes before the computer sleeps
.IP \(bu 2
\fBpower\fP (\fI\%str\fP) \-\-
.sp
Set the value for AC or DC power. Default is \fBac\fP\&. Valid options
are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBac\fP (AC Power)
.IP \(bu 2
\fBdc\fP (Battery)
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBscheme\fP (\fI\%str\fP) \-\-
.sp
The scheme to use, leave as \fBNone\fP to use the current. Default is
\fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known
Aliases are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBSCHEME_BALANCED\fP \- Balanced
.IP \(bu 2
\fBSCHEME_MAX\fP \- Power saver
.IP \(bu 2
\fBSCHEME_MIN\fP \- High performance
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Sets the system standby timeout to 30 minutes on Battery
salt \(aq*\(aq powercfg.set_standby_timeout 30 power=dc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_psget
.sp
Module for managing PowerShell through PowerShellGet (PSGet)
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
PowerShell 5.0
.IP \(bu 2
PSGet
.UNINDENT
.UNINDENT
.sp
Support for PowerShell
.INDENT 0.0
.TP
.B salt.modules.win_psget.avail_modules(desc=False)
List available modules in registered Powershell module repositories.
.INDENT 7.0
.TP
.B Parameters
\fBdesc\fP (\fBbool\fP) \-\- If \fBTrue\fP, the verbose description will be returned.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqwin01\(aq psget.avail_modules
salt \(aqwin01\(aq psget.avail_modules desc=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_psget.bootstrap()
Make sure that nuget\-anycpu.exe is installed.
This will download the official nuget\-anycpu.exe from the internet.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqwin01\(aq psget.bootstrap
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_psget.get_repository(name)
Get the details of a local PSGet repository
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fBstr\fP) \-\- Name of the repository
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqwin01\(aq psget.get_repository MyRepo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_psget.install(name, minimum_version=None, required_version=None, scope=None, repository=None)
Install a Powershell module from powershell gallery on the system.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Name of a Powershell module
.IP \(bu 2
\fBminimum_version\fP (\fBstr\fP) \-\- The maximum version to install, e.g. 1.23.2
.IP \(bu 2
\fBrequired_version\fP (\fBstr\fP) \-\- Install a specific version
.IP \(bu 2
\fBscope\fP (\fBstr\fP) \-\- The scope to install the module to, e.g. CurrentUser, Computer
.IP \(bu 2
\fBrepository\fP (\fBstr\fP) \-\- The friendly name of a private repository, e.g. MyREpo
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqwin01\(aq psget.install PowerPlan
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_psget.list_modules(desc=False)
List currently installed PSGet Modules on the system.
.INDENT 7.0
.TP
.B Parameters
\fBdesc\fP (\fBbool\fP) \-\- If \fBTrue\fP, the verbose description will be returned.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqwin01\(aq psget.list_modules
salt \(aqwin01\(aq psget.list_modules desc=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_psget.register_repository(name, location, installation_policy=None)
Register a PSGet repository on the local machine
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- The name for the repository
.IP \(bu 2
\fBlocation\fP (\fBstr\fP) \-\- The URI for the repository
.IP \(bu 2
\fBinstallation_policy\fP (\fBstr\fP) \-\- The installation policy
for packages, e.g. Trusted, Untrusted
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqwin01\(aq psget.register_repository MyRepo https://myrepo.mycompany.com/packages
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_psget.remove(name)
Remove a Powershell DSC module from the system.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fBstr\fP) \-\- Name of a Powershell DSC module
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqwin01\(aq psget.remove PowerPlan
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_psget.update(name, maximum_version=None, required_version=None)
Update a PowerShell module to a specific version, or the newest
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Name of a Powershell module
.IP \(bu 2
\fBmaximum_version\fP (\fBstr\fP) \-\- The maximum version to install, e.g. 1.23.2
.IP \(bu 2
\fBrequired_version\fP (\fBstr\fP) \-\- Install a specific version
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqwin01\(aq psget.update PowerPlan
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_servermanager
.sp
Manage Windows features via the ServerManager powershell module. Can list
available and installed roles/features. Can install and remove roles/features.
.INDENT 0.0
.TP
.B maintainer
Shane Lee <\fI\%slee@saltstack.com\fP>
.TP
.B platform
Windows Server 2008R2 or greater
.TP
.B depends
PowerShell module \fBServerManager\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_servermanager.install(feature, recurse=False, restart=False, source=None, exclude=None)
Install a feature
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Some features require reboot after un/installation, if so until the
server is restarted other features can not be installed!
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Some features take a long time to complete un/installation, set \-t with
a long timeout
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfeature\fP (\fI\%str\fP\fI, \fP\fI\%list\fP) \-\-
.sp
The name of the feature(s) to install. This can be a single feature,
a string of features in a comma delimited list (no spaces), or a
list of features.
.sp
New in version 2018.3.0: Added the ability to pass a list of features to be installed.


.IP \(bu 2
\fBrecurse\fP (\fIOptions\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Install all sub\-features. Default is False
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Restarts the computer when installation is complete, if required by
the role/feature installed. Will also trigger a reboot if an item
in \fBexclude\fP requires a reboot to be properly removed. Default is
False
.IP \(bu 2
\fBsource\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- Path to the source files if missing from the target system. None
means that the system will use windows update services to find the
required files. Default is None
.IP \(bu 2
\fBexclude\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\-
.sp
The name of the feature to exclude when installing the named
feature. This can be a single feature, a string of features in a
comma\-delimited list (no spaces), or a list of features.
.sp
\fBWARNING:\fP
.INDENT 2.0
.INDENT 3.5
As there is no exclude option for the \fBAdd\-WindowsFeature\fP
or \fBInstall\-WindowsFeature\fP PowerShell commands the features
named in \fBexclude\fP will be installed with other sub\-features
and will then be removed. \fBIf the feature named in \(ga\(gaexclude\(ga\(ga
is not a sub\-feature of one of the installed items it will still
be removed.\fP
.UNINDENT
.UNINDENT

.UNINDENT
.TP
.B Returns
A dictionary containing the results of the install
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Install the Telnet Client passing a single string
salt \(aq*\(aq win_servermanager.install Telnet\-Client

# Install the TFTP Client and the SNMP Service passing a comma\-delimited
# string. Install all sub\-features
salt \(aq*\(aq win_servermanager.install TFTP\-Client,SNMP\-Service recurse=True

# Install the TFTP Client from d:\eside\-by\-side
salt \(aq*\(aq win_servermanager.install TFTP\-Client source=d:\e\eside\-by\-side

# Install the XPS Viewer, SNMP Service, and Remote Access passing a
# list. Install all sub\-features, but exclude the Web Server
salt \(aq*\(aq win_servermanager.install \(dq[\(aqXPS\-Viewer\(aq, \(aqSNMP\-Service\(aq, \(aqRemoteAccess\(aq]\(dq True recurse=True exclude=\(dqWeb\-Server\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_servermanager.list_available()
List available features to install
.INDENT 7.0
.TP
.B Returns
A list of available features as returned by the
\fBGet\-WindowsFeature\fP PowerShell command
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_servermanager.list_available
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_servermanager.list_installed()
List installed features. Supported on Windows Server 2008 and Windows 8 and
newer.
.INDENT 7.0
.TP
.B Returns
A dictionary of installed features
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_servermanager.list_installed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_servermanager.remove(feature, remove_payload=False, restart=False)
Remove an installed feature
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Some features require a reboot after installation/uninstallation. If
one of these features are modified, then other features cannot be
installed until the server is restarted. Additionally, some features
take a while to complete installation/uninstallation, so it is a good
idea to use the \fB\-t\fP option to set a longer timeout.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfeature\fP (\fI\%str\fP\fI, \fP\fI\%list\fP) \-\-
.sp
The name of the feature(s) to remove. This can be a single feature,
a string of features in a comma delimited list (no spaces), or a
list of features.
.sp
New in version 2018.3.0: Added the ability to pass a list of features to be removed.


.IP \(bu 2
\fBremove_payload\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- True will cause the feature to be removed from the side\-by\-side
store (\fB%SystemDrive%:\eWindows\eWinSxS\fP). Default is False
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Restarts the computer when uninstall is complete, if required by the
role/feature removed. Default is False
.UNINDENT
.TP
.B Returns
A dictionary containing the results of the uninstall
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-t 600 \(aq*\(aq win_servermanager.remove Telnet\-Client
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_service
.sp
Windows Service module.
.sp
Changed in version 2016.11.0: Rewritten to use PyWin32

.INDENT 0.0
.TP
.B salt.modules.win_service.available(name)
Check if a service is available on the system.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.TP
.B Returns
\fBTrue\fP if the service is available, \fBFalse\fP otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.available <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.create(name, bin_path, exe_args=None, display_name=None, description=None, service_type=\(aqown\(aq, start_type=\(aqmanual\(aq, start_delayed=False, error_control=\(aqnormal\(aq, load_order_group=None, dependencies=None, account_name=\(aq.\e\eLocalSystem\(aq, account_password=None, run_interactive=False, **kwargs)
Create the named service.
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Specifies the service name. This is not the display_name
.IP \(bu 2
\fBbin_path\fP (\fI\%str\fP) \-\- Specifies the path to the service binary file. Backslashes must be
escaped, eg: \fBC:\epath\eto\ebinary.exe\fP
.IP \(bu 2
\fBexe_args\fP (\fI\%str\fP) \-\- Any additional arguments required by the service binary.
.IP \(bu 2
\fBdisplay_name\fP (\fI\%str\fP) \-\- The name to be displayed in the service manager. If not passed, the
\fBname\fP will be used
.IP \(bu 2
\fBdescription\fP (\fI\%str\fP) \-\- A description of the service
.IP \(bu 2
\fBservice_type\fP (\fI\%str\fP) \-\-
.sp
Specifies the service type. Default is \fBown\fP\&. Valid options are as
follows:
.INDENT 2.0
.IP \(bu 2
kernel: Driver service
.IP \(bu 2
filesystem: File system driver service
.IP \(bu 2
adapter: Adapter driver service (reserved)
.IP \(bu 2
recognizer: Recognizer driver service (reserved)
.IP \(bu 2
own (default): Service runs in its own process
.IP \(bu 2
share: Service shares a process with one or more other services
.UNINDENT

.IP \(bu 2
\fBstart_type\fP (\fI\%str\fP) \-\-
.sp
Specifies the service start type. Valid options are as follows:
.INDENT 2.0
.IP \(bu 2
boot: Device driver that is loaded by the boot loader
.IP \(bu 2
system: Device driver that is started during kernel initialization
.IP \(bu 2
auto: Service that automatically starts
.IP \(bu 2
manual (default): Service must be started manually
.IP \(bu 2
disabled: Service cannot be started
.UNINDENT

.IP \(bu 2
\fBstart_delayed\fP (\fI\%bool\fP) \-\- Set the service to Auto(Delayed Start). Only valid if the start_type
is set to \fBAuto\fP\&. If service_type is not passed, but the service
is already set to \fBAuto\fP, then the flag will be set. Default is
\fBFalse\fP
.IP \(bu 2
\fBerror_control\fP (\fI\%str\fP) \-\-
.sp
The severity of the error, and action taken, if this service fails
to start. Valid options are as follows:
.INDENT 2.0
.IP \(bu 2
normal (normal): Error is logged and a message box is displayed
.IP \(bu 2
severe: Error is logged and computer attempts a restart with the
last known good configuration
.IP \(bu 2
critical: Error is logged, computer attempts to restart with the
last known good configuration, system halts on failure
.IP \(bu 2
ignore: Error is logged and startup continues, no notification is
given to the user
.UNINDENT

.IP \(bu 2
\fBload_order_group\fP (\fI\%str\fP) \-\- The name of the load order group to which this service belongs
.IP \(bu 2
\fBdependencies\fP (\fI\%list\fP) \-\- A list of services or load ordering groups that must start before
this service
.IP \(bu 2
\fBaccount_name\fP (\fI\%str\fP) \-\-
.sp
The name of the account under which the service should run. For
\fBown\fP type services this should be in the \fBdomain\eusername\fP
format. The following are examples of valid built\-in service
accounts:
.INDENT 2.0
.IP \(bu 2
NT AuthorityLocalService
.IP \(bu 2
NT AuthorityNetworkService
.IP \(bu 2
NT AuthorityLocalSystem
.IP \(bu 2
\&.LocalSystem
.UNINDENT

.IP \(bu 2
\fBaccount_password\fP (\fI\%str\fP) \-\- The password for the account name specified in \fBaccount_name\fP\&. For
the above built\-in accounts, this can be None. Otherwise a password
must be specified.
.IP \(bu 2
\fBrun_interactive\fP (\fI\%bool\fP) \-\- If this setting is True, the service will be allowed to interact
with the user. Not recommended for services that run with elevated
privileges.
.UNINDENT
.TP
.B Returns
A dictionary containing information about the new service
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.create <service name> <path to exe> display_name=\(aq<display name>\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.create_win_salt_restart_task()
Create a task in Windows task scheduler to enable restarting the salt\-minion
.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.create_win_salt_restart_task()
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.delete(name, timeout=90)
Delete the named service
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to delete
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\-
.sp
The time in seconds to wait for the service to be deleted before
returning. This is necessary because a service must be stopped
before it can be deleted. Default is 90 seconds
.sp
New in version 2017.7.9,2018.3.4.


.UNINDENT
.TP
.B Returns
.INDENT 7.0
.TP
.B \fBTrue\fP if successful, otherwise \fBFalse\fP\&. Also returns \fBTrue\fP
if the service is not present
.UNINDENT

.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.delete <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.disable(name, **kwargs)
Disable the named service to start at boot
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the service to disable
.TP
.B Returns
\fBTrue\fP if disabled, \fBFalse\fP otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.disabled(name)
Check to see if the named service is disabled to start on boot
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.TP
.B Returns
True if the service is disabled
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.disabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.enable(name, start_type=\(aqauto\(aq, start_delayed=False, **kwargs)
Enable the named service to start at boot
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to enable.
.IP \(bu 2
\fBstart_type\fP (\fI\%str\fP) \-\-
.sp
Specifies the service start type. Valid options are as
follows:
.INDENT 2.0
.IP \(bu 2
boot: Device driver that is loaded by the boot loader
.IP \(bu 2
system: Device driver that is started during kernel initialization
.IP \(bu 2
auto: Service that automatically starts
.IP \(bu 2
manual: Service must be started manually
.IP \(bu 2
disabled: Service cannot be started
.UNINDENT

.IP \(bu 2
\fBstart_delayed\fP (\fI\%bool\fP) \-\- Set the service to Auto(Delayed Start). Only valid
if the start_type is set to \fBAuto\fP\&. If service_type is not passed,
but the service is already set to \fBAuto\fP, then the flag will be
set.
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, \fBFalse\fP otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enable <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.enabled(name, **kwargs)
Check to see if the named service is enabled to start on boot
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.TP
.B Returns
True if the service is set to start
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.enabled <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.execute_salt_restart_task()
Run the Windows Salt restart task
.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.execute_salt_restart_task()
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.get_all()
Return all installed services
.INDENT 7.0
.TP
.B Returns
Returns a list of all services on the system.
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.get_disabled()
Return a list of disabled services. Disabled is defined as a service that is
marked \(aqDisabled\(aq or \(aqManual\(aq.
.INDENT 7.0
.TP
.B Returns
A list of disabled services.
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_disabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.get_enabled()
Return a list of enabled services. Enabled is defined as a service that is
marked to Auto Start.
.INDENT 7.0
.TP
.B Returns
A list of enabled services
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.get_service_name(*args)
The Display Name is what is displayed in Windows when services.msc is
executed.  Each Display Name has an associated Service Name which is the
actual name of the service.  This function allows you to discover the
Service Name by returning a dictionary of Display Names and Service Names,
or filter by adding arguments of Display Names.
.sp
If no args are passed, return a dict of all services where the keys are the
service Display Names and the values are the Service Names.
.sp
If arguments are passed, create a dict of Display Names and Service Names
.INDENT 7.0
.TP
.B Returns
A dictionary of display names and service names
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.get_service_name
salt \(aq*\(aq service.get_service_name \(aqGoogle Update Service (gupdate)\(aq \(aqDHCP Client\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.getsid(name)
Return the SID for this windows service
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the service for which to return the SID
.TP
.B Returns
A string representing the SID for the service
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.getsid <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.info(name)
Get information about a service on the system
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the service. This is not the display name. Use
\fBget_service_name\fP to find the service name.
.TP
.B Returns
A dictionary containing information about the service.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.info spooler
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.missing(name)
The inverse of service.available.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.TP
.B Returns
\fBTrue\fP if the service is missing, \fBFalse\fP otherwise
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.missing <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.modify(name, bin_path=None, exe_args=None, display_name=None, description=None, service_type=None, start_type=None, start_delayed=None, error_control=None, load_order_group=None, dependencies=None, account_name=None, account_password=None, run_interactive=None)
Modify a service\(aqs parameters. Changes will not be made for parameters that
are not passed.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service. Can be found using the
\fBservice.get_service_name\fP function
.IP \(bu 2
\fBbin_path\fP (\fI\%str\fP) \-\- The path to the service executable. Backslashes must be escaped, eg:
\fBC:\epath\eto\ebinary.exe\fP
.IP \(bu 2
\fBexe_args\fP (\fI\%str\fP) \-\- Any arguments required by the service executable
.IP \(bu 2
\fBdisplay_name\fP (\fI\%str\fP) \-\- The name to display in the service manager
.IP \(bu 2
\fBdescription\fP (\fI\%str\fP) \-\- The description to display for the service
.IP \(bu 2
\fBservice_type\fP (\fI\%str\fP) \-\-
.sp
Specifies the service type. Default is \fBown\fP\&. Valid options are as
follows:
.INDENT 2.0
.IP \(bu 2
kernel: Driver service
.IP \(bu 2
filesystem: File system driver service
.IP \(bu 2
adapter: Adapter driver service (reserved)
.IP \(bu 2
recognizer: Recognizer driver service (reserved)
.IP \(bu 2
own (default): Service runs in its own process
.IP \(bu 2
share: Service shares a process with one or more other services
.UNINDENT

.IP \(bu 2
\fBstart_type\fP (\fI\%str\fP) \-\-
.sp
Specifies the service start type. Valid options are as follows:
.INDENT 2.0
.IP \(bu 2
boot: Device driver that is loaded by the boot loader
.IP \(bu 2
system: Device driver that is started during kernel initialization
.IP \(bu 2
auto: Service that automatically starts
.IP \(bu 2
manual: Service must be started manually
.IP \(bu 2
disabled: Service cannot be started
.UNINDENT

.IP \(bu 2
\fBstart_delayed\fP (\fI\%bool\fP) \-\- Set the service to Auto(Delayed Start). Only valid if the start_type
is set to \fBAuto\fP\&. If service_type is not passed, but the service
is already set to \fBAuto\fP, then the flag will be set.
.IP \(bu 2
\fBerror_control\fP (\fI\%str\fP) \-\-
.sp
The severity of the error, and action taken, if this service fails
to start. Valid options are as follows:
.INDENT 2.0
.IP \(bu 2
normal: Error is logged and a message box is displayed
.IP \(bu 2
severe: Error is logged and computer attempts a restart with the
last known good configuration
.IP \(bu 2
critical: Error is logged, computer attempts to restart with the
last known good configuration, system halts on failure
.IP \(bu 2
ignore: Error is logged and startup continues, no notification is
given to the user
.UNINDENT

.IP \(bu 2
\fBload_order_group\fP (\fI\%str\fP) \-\- The name of the load order group to which this service belongs
.IP \(bu 2
\fBdependencies\fP (\fI\%list\fP) \-\- A list of services or load ordering groups that must start before
this service
.IP \(bu 2
\fBaccount_name\fP (\fI\%str\fP) \-\-
.sp
The name of the account under which the service should run. For
\fBown\fP type services this should be in the \fBdomain\eusername\fP
format. The following are examples of valid built\-in service
accounts:
.INDENT 2.0
.IP \(bu 2
NT AuthorityLocalService
.IP \(bu 2
NT AuthorityNetworkService
.IP \(bu 2
NT AuthorityLocalSystem
.IP \(bu 2
\&.LocalSystem
.UNINDENT

.IP \(bu 2
\fBaccount_password\fP (\fI\%str\fP) \-\- The password for the account name specified in \fBaccount_name\fP\&. For
the above built\-in accounts, this can be None. Otherwise a password
must be specified.
.IP \(bu 2
\fBrun_interactive\fP (\fI\%bool\fP) \-\- If this setting is True, the service will be allowed to interact
with the user. Not recommended for services that run with elevated
privileges.
.UNINDENT
.TP
.B Returns
a dictionary of changes made
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.modify spooler start_type=disabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.restart(name, timeout=90)
Restart the named service. This issues a stop command followed by a start.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\-
.sp
The name of the service to restart.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
If the name passed is \fBsalt\-minion\fP a scheduled task is
created and executed to restart the salt\-minion service.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\-
.sp
The time in seconds to wait for the service to stop and start before
returning. Default is 90 seconds
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The timeout is cumulative meaning it is applied to the stop and
then to the start command. A timeout of 90 could take up to 180
seconds if the service is long in stopping and starting
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.9,2018.3.4.


.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.restart <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.start(name, timeout=90)
Start the specified service.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
You cannot start a disabled service in Windows. If the service is
disabled, it will be changed to \fBManual\fP start.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to start
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\-
.sp
The time in seconds to wait for the service to start before
returning. Default is 90 seconds
.sp
New in version 2017.7.9,2018.3.4.


.UNINDENT
.TP
.B Returns
.INDENT 7.0
.TP
.B \fBTrue\fP if successful, otherwise \fBFalse\fP\&. Also returns \fBTrue\fP
if the service is already started
.UNINDENT

.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.start <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.status(name, *args, **kwargs)
Return the status for a service.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.sp
Changed in version 2018.3.0: The service name can now be a glob (e.g. \fBsalt*\fP)

.sp
Changed in version 3006.0: Returns \(dqNot Found\(dq if the service is not found on the system

.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the service to check
.TP
.B Returns
True if running, False otherwise
dict: Maps service name to True if running, False otherwise
str: Not Found if the service is not found on the system
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.status <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_service.stop(name, timeout=90)
Stop the specified service
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the service to stop
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\-
.sp
The time in seconds to wait for the service to stop before
returning. Default is 90 seconds
.sp
New in version 2017.7.9,2018.3.4.


.UNINDENT
.TP
.B Returns
.INDENT 7.0
.TP
.B \fBTrue\fP if successful, otherwise \fBFalse\fP\&. Also returns \fBTrue\fP
if the service is already stopped
.UNINDENT

.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq service.stop <service name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_shadow
.sp
Manage the shadow file
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage passwords on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqshadow.info\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_shadow.info(name)
Return information for the specified user
This is just returns dummy data so that salt states can work.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the user account to show.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.info root
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_shadow.require_password_change(name)
Require the user to change their password the next time they log in.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- The name of the user account to require a password change.
.TP
.B Returns
True if successful. False if unsuccessful.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.require_password_change <username>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_shadow.set_expire(name, expire)
Set the expiration date for a user account.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The name of the user account to edit.
.IP \(bu 2
\fBexpire\fP \-\- The date the account will expire.
.UNINDENT
.TP
.B Returns
True if successful. False if unsuccessful.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_expire <username> 2016/7/1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_shadow.set_password(name, password)
Set the password for a named user.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the user account
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- The new password
.UNINDENT
.TP
.B Returns
True if successful. False if unsuccessful.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.set_password root mysecretpassword
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_shadow.unlock_account(name)
Unlocks a user account.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- The name of the user account to unlock.
.TP
.B Returns
True if successful. False if unsuccessful.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq shadow.unlock_account <username>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_shortcut
.sp
Execution module for creating shortcuts on Windows. Handles file shortcuts
(\fI\&.lnk\fP) and url shortcuts (\fI\&.url\fP). Allows for the configuration of icons and
hot keys on file shortcuts. Changing the icon and hot keys are unsupported for
url shortcuts.
.sp
New in version 3005.

.INDENT 0.0
.TP
.B salt.modules.win_shortcut.create(path, target, arguments=\(aq\(aq, description=\(aq\(aq, hot_key=\(aq\(aq, icon_index=0, icon_location=\(aq\(aq, window_style=\(aqNormal\(aq, working_dir=\(aq\(aq, backup=False, force=False, make_dirs=False, user=None)
Create a new shortcut. This can be a file shortcut (\fB\&.lnk\fP) or a url
shortcut (\fB\&.url\fP).
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The full path to the shortcut. Must have a \fI\&.lnk\fP or \fI\&.url\fP
file extension.
.IP \(bu 2
\fBtarget\fP (\fI\%str\fP) \-\- The full path to the target
.IP \(bu 2
\fBarguments\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- Any arguments to be passed to the target
.IP \(bu 2
\fBdescription\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The description for the shortcut. This is
shown in the \fBComment\fP field of the dialog box. Default is an
empty string
.IP \(bu 2
\fBhot_key\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\-
.sp
A combination of hot Keys to trigger this
shortcut. This is something like \fBCtrl+Alt+D\fP\&. This is shown in
the \fBShortcut key\fP field in the dialog box. Default is an empty
string. Available options are:
.INDENT 2.0
.IP \(bu 2
Ctrl
.IP \(bu 2
Alt
.IP \(bu 2
Shift
.IP \(bu 2
Ext
.UNINDENT

.IP \(bu 2
\fBicon_index\fP (\fI\%int\fP\fI, \fP\fIoptional\fP) \-\- The index for the icon to use in files that
contain multiple icons. Default is 0
.IP \(bu 2
\fBicon_location\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The full path to a file containing icons.
This is shown in the \fBChange Icon\fP dialog box by clicking the
\fBChange Icon\fP button. If no file is specified and a binary is
passed as the target, Windows will attempt to get the icon from the
binary file. Default is an empty string
.IP \(bu 2
\fBwindow_style\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\-
.sp
The window style the program should start
in. This is shown in the \fBRun\fP field of the dialog box. Default is
\fBNormal\fP\&. Valid options are:
.INDENT 2.0
.IP \(bu 2
Normal
.IP \(bu 2
Minimized
.IP \(bu 2
Maximized
.UNINDENT

.IP \(bu 2
\fBworking_dir\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The full path to the working directory for
the program to run in. This is shown in the \fBStart in\fP field of
the dialog box.
.IP \(bu 2
\fBbackup\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- If there is already a shortcut with the same
name, set this value to \fBTrue\fP to backup the existing shortcut and
continue creating the new shortcut. Default is \fBFalse\fP
.IP \(bu 2
\fBforce\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- If there is already a shortcut with the same
name and you aren\(aqt backing up the shortcut, set this value to
\fBTrue\fP to remove the existing shortcut and create a new with these
settings. Default is \fBFalse\fP
.IP \(bu 2
\fBmake_dirs\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- If the parent directory structure does not
exist for the new shortcut, create it. Default is \fBFalse\fP
.IP \(bu 2
\fBuser\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The user to be the owner of any directories
created by setting \fBmake_dirs\fP to \fBTrue\fP\&. If no value is passed
Salt will use the user account that it is running under. Default is
an empty string.
.UNINDENT
.TP
.B Returns
True if successful
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If the path is not a \fB\&.lnk\fP or \fB\&.url\fP file
    extension.
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If there is an existing shortcut with the same
    name and \fBbackup\fP and \fBforce\fP are both \fBFalse\fP
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If the parent directory is not created and
    \fBmake_dirs\fP is \fBFalse\fP
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\- If there was an error creating the parent
    directories
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Create a shortcut and set the \(ga\(gaShortcut key\(ga\(ga (\(ga\(gahot_key\(ga\(ga)
salt * shortcut.create \(dqC:\epath\eto\eshortcut.lnk\(dq \(dqC:\eWindows\enotepad.exe\(dq hot_key=\(dqCtrl+Alt+N\(dq

# Create a shortcut and change the icon to the 3rd one in the icon file
salt * shortcut.create \(dqC:\epath\eto\eshortcut.lnk\(dq \(dqC:\eWindows\enotepad.exe\(dq icon_location=\(dqC:\epath\eto\eicon.ico\(dq icon_index=2

# Create a shortcut and change the startup mode to full screen
salt * shortcut.create \(dqC:\epath\eto\eshortcut.lnk\(dq \(dqC:\eWindows\enotepad.exe\(dq window_style=\(dqMaximized\(dq

# Create a shortcut and change the icon
salt * shortcut.create \(dqC:\epath\eto\eshortcut.lnk\(dq \(dqC:\eWindows\enotepad.exe\(dq icon_location=\(dqC:\epath\eto\eicon.ico\(dq

# Create a shortcut and force it to overwrite an existing shortcut
salt * shortcut.create \(dqC:\epath\eto\eshortcut.lnk\(dq \(dqC:\eWindows\enotepad.exe\(dq force=True

# Create a shortcut and create any parent directories if they are missing
salt * shortcut.create \(dqC:\epath\eto\eshortcut.lnk\(dq \(dqC:\eWindows\enotepad.exe\(dq make_dirs=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_shortcut.get(path)
Gets the properties for a shortcut
.INDENT 7.0
.TP
.B Parameters
\fBpath\fP (\fI\%str\fP) \-\- The path to the shortcut. Must have a \fI\&.lnk\fP or \fI\&.url\fP file
extension.
.TP
.B Returns
.INDENT 7.0
.TP
.B A dictionary containing all available properties for the specified
shortcut
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt * shortcut.get path=\(dqC:\epath\eto\eshortcut.lnk\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_shortcut.modify(path, target=\(aq\(aq, arguments=\(aq\(aq, description=\(aq\(aq, hot_key=\(aq\(aq, icon_index=0, icon_location=\(aq\(aq, window_style=\(aqNormal\(aq, working_dir=\(aq\(aq)
Modify an existing shortcut. This can be a file shortcut (\fB\&.lnk\fP) or a
url shortcut (\fB\&.url\fP).
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The full path to the shortcut. Must have a \fI\&.lnk\fP or \fI\&.url\fP
file extension.
.IP \(bu 2
\fBtarget\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The full path to the target
.IP \(bu 2
\fBarguments\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- Any arguments to be passed to the target
.IP \(bu 2
\fBdescription\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The description for the shortcut. This is
shown in the \fBComment\fP field of the dialog box. Default is an
empty string
.IP \(bu 2
\fBhot_key\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\-
.sp
A combination of hot Keys to trigger this
shortcut. This is something like \fBCtrl+Alt+D\fP\&. This is shown in
the \fBShortcut key\fP field in the dialog box. Default is an empty
string. Available options are:
.INDENT 2.0
.IP \(bu 2
Ctrl
.IP \(bu 2
Alt
.IP \(bu 2
Shift
.IP \(bu 2
Ext
.UNINDENT

.IP \(bu 2
\fBicon_index\fP (\fI\%int\fP\fI, \fP\fIoptional\fP) \-\- The index for the icon to use in files that
contain multiple icons. Default is 0
.IP \(bu 2
\fBicon_location\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The full path to a file containing icons.
This is shown in the \fBChange Icon\fP dialog box by clicking the
\fBChange Icon\fP button. If no file is specified and a binary is
passed as the target, Windows will attempt to get the icon from the
binary file. Default is an empty string
.IP \(bu 2
\fBwindow_style\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\-
.sp
The window style the program should start
in. This is shown in the \fBRun\fP field of the dialog box. Default is
\fBNormal\fP\&. Valid options are:
.INDENT 2.0
.IP \(bu 2
Normal
.IP \(bu 2
Minimized
.IP \(bu 2
Maximized
.UNINDENT

.IP \(bu 2
\fBworking_dir\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The full path to the working directory for
the program to run in. This is shown in the \fBStart in\fP field of
the dialog box.
.UNINDENT
.TP
.B Returns
True if successful
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Modify an existing shortcut. Set it to target notepad.exe
salt * shortcut.modify \(dqC:\epath\eto\eshortcut.lnk\(dq \(dqC:\eWindows\enotepad.exe\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_smtp_server
.sp
Module for managing IIS SMTP server configuration on Windows servers.
The Windows features \(aqSMTP\-Server\(aq and \(aqWeb\-WMI\(aq must be installed.
.INDENT 0.0
.TP
.B depends
wmi
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_smtp_server.get_connection_ip_list(as_wmi_format=False, server=\(aqSmtpSvc/1\(aq)
Get the IPGrant list for the SMTP virtual server.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBas_wmi_format\fP (\fI\%bool\fP) \-\- Returns the connection IPs as a list in the format WMI expects.
.IP \(bu 2
\fBserver\fP (\fI\%str\fP) \-\- The SMTP server name.
.UNINDENT
.TP
.B Returns
A dictionary of the IP and subnet pairs.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_smtp_server.get_connection_ip_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_smtp_server.get_log_format(server=\(aqSmtpSvc/1\(aq)
Get the active log format for the SMTP virtual server.
.INDENT 7.0
.TP
.B Parameters
\fBserver\fP (\fI\%str\fP) \-\- The SMTP server name.
.TP
.B Returns
A string of the log format name.
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_smtp_server.get_log_format
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_smtp_server.get_log_format_types()
Get all available log format names and ids.
.INDENT 7.0
.TP
.B Returns
A dictionary of the log format names and ids.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_smtp_server.get_log_format_types
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_smtp_server.get_relay_ip_list(server=\(aqSmtpSvc/1\(aq)
Get the RelayIpList list for the SMTP virtual server.
.INDENT 7.0
.TP
.B Parameters
\fBserver\fP (\fI\%str\fP) \-\- The SMTP server name.
.TP
.B Returns
A list of the relay IPs.
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A return value of None corresponds to the restrictive \(aqOnly the list below\(aq GUI parameter
with an empty access list, and setting an empty list/tuple corresponds to the more
permissive \(aqAll except the list below\(aq GUI parameter.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_smtp_server.get_relay_ip_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_smtp_server.get_server_setting(settings, server=\(aqSmtpSvc/1\(aq)
Get the value of the setting for the SMTP virtual server.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsettings\fP (\fI\%str\fP) \-\- A list of the setting names.
.IP \(bu 2
\fBserver\fP (\fI\%str\fP) \-\- The SMTP server name.
.UNINDENT
.TP
.B Returns
A dictionary of the provided settings and their values.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_smtp_server.get_server_setting settings=\(dq[\(aqMaxRecipients\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_smtp_server.get_servers()
Get the SMTP virtual server names.
.INDENT 7.0
.TP
.B Returns
A list of the SMTP virtual servers.
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_smtp_server.get_servers
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_smtp_server.set_connection_ip_list(addresses=None, grant_by_default=False, server=\(aqSmtpSvc/1\(aq)
Set the IPGrant list for the SMTP virtual server.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBaddresses\fP (\fI\%str\fP) \-\- A dictionary of IP + subnet pairs.
.IP \(bu 2
\fBgrant_by_default\fP (\fI\%bool\fP) \-\- Whether the addresses should be a blacklist or whitelist.
.IP \(bu 2
\fBserver\fP (\fI\%str\fP) \-\- The SMTP server name.
.UNINDENT
.TP
.B Returns
A boolean representing whether the change succeeded.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_smtp_server.set_connection_ip_list addresses=\(dq{\(aq127.0.0.1\(aq: \(aq255.255.255.255\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_smtp_server.set_log_format(log_format, server=\(aqSmtpSvc/1\(aq)
Set the active log format for the SMTP virtual server.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBlog_format\fP (\fI\%str\fP) \-\- The log format name.
.IP \(bu 2
\fBserver\fP (\fI\%str\fP) \-\- The SMTP server name.
.UNINDENT
.TP
.B Returns
A boolean representing whether the change succeeded.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_smtp_server.set_log_format \(aqMicrosoft IIS Log File Format\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_smtp_server.set_relay_ip_list(addresses=None, server=\(aqSmtpSvc/1\(aq)
Set the RelayIpList list for the SMTP virtual server.
.sp
Due to the unusual way that Windows stores the relay IPs, it is advisable to retrieve
the existing list you wish to set from a pre\-configured server.
.sp
For example, setting \(aq127.0.0.1\(aq as an allowed relay IP through the GUI would generate
an actual relay IP list similar to the following:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[\(aq24.0.0.128\(aq, \(aq32.0.0.128\(aq, \(aq60.0.0.128\(aq, \(aq68.0.0.128\(aq, \(aq1.0.0.0\(aq, \(aq76.0.0.0\(aq,
 \(aq0.0.0.0\(aq, \(aq0.0.0.0\(aq, \(aq1.0.0.0\(aq, \(aq1.0.0.0\(aq, \(aq2.0.0.0\(aq, \(aq2.0.0.0\(aq, \(aq4.0.0.0\(aq,
 \(aq0.0.0.0\(aq, \(aq76.0.0.128\(aq, \(aq0.0.0.0\(aq, \(aq0.0.0.0\(aq, \(aq0.0.0.0\(aq, \(aq0.0.0.0\(aq,
 \(aq255.255.255.255\(aq, \(aq127.0.0.1\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Setting the list to None corresponds to the restrictive \(aqOnly the list below\(aq GUI parameter
with an empty access list configured, and setting an empty list/tuple corresponds to the
more permissive \(aqAll except the list below\(aq GUI parameter.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBaddresses\fP (\fI\%str\fP) \-\- A list of the relay IPs. The order of the list is important.
.IP \(bu 2
\fBserver\fP (\fI\%str\fP) \-\- The SMTP server name.
.UNINDENT
.TP
.B Returns
A boolean representing whether the change succeeded.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_smtp_server.set_relay_ip_list addresses=\(dq[\(aq192.168.1.1\(aq, \(aq172.16.1.1\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_smtp_server.set_server_setting(settings, server=\(aqSmtpSvc/1\(aq)
Set the value of the setting for the SMTP virtual server.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The setting names are case\-sensitive.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsettings\fP (\fI\%str\fP) \-\- A dictionary of the setting names and their values.
.IP \(bu 2
\fBserver\fP (\fI\%str\fP) \-\- The SMTP server name.
.UNINDENT
.TP
.B Returns
A boolean representing whether all changes succeeded.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_smtp_server.set_server_setting settings=\(dq{\(aqMaxRecipients\(aq: \(aq500\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_snmp
.sp
Module for managing SNMP service settings on Windows servers.
The Windows feature \(aqSNMP\-Service\(aq must be installed.
.INDENT 0.0
.TP
.B salt.modules.win_snmp.get_agent_service_types()
Get the sysServices types that can be configured.
.INDENT 7.0
.TP
.B Returns
A list of service types.
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_snmp.get_agent_service_types
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_snmp.get_agent_settings()
Determine the value of the SNMP sysContact, sysLocation, and sysServices
settings.
.INDENT 7.0
.TP
.B Returns
A dictionary of the agent settings.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_snmp.get_agent_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_snmp.get_auth_traps_enabled()
Determine whether the host is configured to send authentication traps.
.INDENT 7.0
.TP
.B Returns
True if traps are enabled, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_snmp.get_auth_traps_enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_snmp.get_community_names()
Get the current accepted SNMP community names and their permissions.
.sp
If community names are being managed by Group Policy, those values will be
returned instead like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
TestCommunity:
    Managed by GPO
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Community names managed normally will denote the permission instead:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
TestCommunity:
    Read Only
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary of community names and permissions.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_snmp.get_community_names
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_snmp.get_permission_types()
Get the permission types that can be configured for communities.
.INDENT 7.0
.TP
.B Returns
A list of permission types.
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_snmp.get_permission_types
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_snmp.set_agent_settings(contact=None, location=None, services=None)
Manage the SNMP sysContact, sysLocation, and sysServices settings.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontact\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The SNMP contact.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The SNMP location.
.IP \(bu 2
\fBservices\fP (\fI\%list\fP\fI, \fP\fIoptional\fP) \-\- A list of selected services. The possible
service names can be found via \fBwin_snmp.get_agent_service_types\fP\&.
To disable all services pass a list of None, ie: [\(aqNone\(aq]
.UNINDENT
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_snmp.set_agent_settings contact=\(aqContact Name\(aq location=\(aqPlace\(aq services=\(dq[\(aqPhysical\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_snmp.set_auth_traps_enabled(status=True)
Manage the sending of authentication traps.
.INDENT 7.0
.TP
.B Parameters
\fBstatus\fP (\fI\%bool\fP) \-\- True to enable traps. False to disable.
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_snmp.set_auth_traps_enabled status=\(aqTrue\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_snmp.set_community_names(communities)
Manage the SNMP accepted community names and their permissions.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Settings managed by Group Policy will always take precedence over those
set using the SNMP interface. Therefore if this function finds Group
Policy settings it will raise a CommandExecutionError
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBcommunities\fP (\fI\%dict\fP) \-\- A dictionary of SNMP community names and
permissions. The possible permissions can be found via
\fBwin_snmp.get_permission_types\fP\&.
.TP
.B Returns
True if successful, otherwise False
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- If SNMP settings are being managed by Group Policy
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_snmp.set_community_names communities=\(dq{\(aqTestCommunity\(aq: \(aqRead Only\(aq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_status
.sp
Module for returning various status data about a minion.
These data can be useful for compiling into stats later,
or for problem solving if your minion is having problems.
.sp
New in version 0.12.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
wmi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.win_status.SYSTEM_PERFORMANCE_INFORMATION
.INDENT 7.0
.TP
.B AvailablePagedPoolPages
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B AvailablePages
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CacheIoCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CacheReadCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CacheTransitionCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcCopyReadNoWait
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcCopyReadNoWaitMiss
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcCopyReadWait
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcCopyReadWaitMiss
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcDataFlushes
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcDataPages
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcDirtyPagesThreshold
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcFastMdlReadNoWait
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcFastMdlReadNotPossible
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcFastMdlReadResourceMiss
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcFastMdlReadWait
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcFastReadNoWait
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcFastReadNotPossible
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcFastReadResourceMiss
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcFastReadWait
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcLazyWriteIos
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcLazyWritePages
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcMapDataNoWait
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcMapDataNoWaitMiss
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcMapDataWait
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcMapDataWaitMiss
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcMdlReadNoWait
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcMdlReadNoWaitMiss
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcMdlReadWait
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcMdlReadWaitMiss
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcPinMappedDataCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcPinReadNoWait
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcPinReadNoWaitMiss
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcPinReadWait
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcPinReadWaitMiss
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcReadAheadIos
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CcTotalDirtyPages
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CommitLimit
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CommittedPages
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B ContextSwitches
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B CopyOnWriteCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B DemandZeroCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B DirtyPagesWriteCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B DirtyWriteIoCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B FirstLevelTbFills
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B FreeSystemPtes
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B IdleProcessTime
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B IoOtherOperationCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B IoOtherTransferCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B IoReadOperationCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B IoReadTransferCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B IoWriteOperationCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B IoWriteTransferCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B MappedPagesWriteCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B MappedWriteIoCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B NonPagedPoolAllocs
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B NonPagedPoolFrees
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B NonPagedPoolLookasideHits
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B NonPagedPoolPages
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B PageFaultCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B PageReadCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B PageReadIoCount
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B PagedPoolAllocs
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B PagedPoolFrees
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B PagedPoolLookasideHits
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B PagedPoolPages
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B PeakCommitment
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B ResidentAvailablePages
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B ResidentPagedPoolPage
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B ResidentSystemCachePage
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B ResidentSystemCodePage
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B ResidentSystemDriverPage
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B SecondLevelTbFills
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B SharedCommittedPages
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B SystemCalls
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B TotalSystemCodePages
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B TotalSystemDriverPages
Structure/Union member
.UNINDENT
.INDENT 7.0
.TP
.B TransitionCount
Structure/Union member
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_status.cpuload()
New in version 2015.8.0.

.sp
Return the processor load as a percentage
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.cpuload
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_status.cpustats()
Return information about the CPU.
.INDENT 7.0
.TP
.B Returns
dict: A dictionary containing information about the CPU stats
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt * status.cpustats
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_status.diskusage(human_readable=False, path=None)
New in version 2015.8.0.

.sp
Return the disk usage for this minion
.INDENT 7.0
.TP
.B human_readable
False
If \fBTrue\fP, usage will be in KB/MB/GB etc.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.diskusage path=c:/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_status.loadavg()
Returns counter information related to the load of the machine
.INDENT 7.0
.TP
.B Returns
A dictionary of counters
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt * status.loadavg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_status.master(master=None, connected=True)
New in version 2015.5.0.

.sp
Fire an event if the minion gets disconnected from its master. This
function is meant to be run via a scheduled job from the minion. If
master_ip is an FQDN/Hostname, is must be resolvable to a valid IPv4
address.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.master
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_status.meminfo()
Return information about physical and virtual memory on the system
.INDENT 7.0
.TP
.B Returns
A dictionary of information about memory on the system
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt * status.meminfo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_status.procs(count=False)
Return the process data
.INDENT 7.0
.TP
.B count
False
If \fBTrue\fP, this function will simply return the number of processes.
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.procs
salt \(aq*\(aq status.procs count
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_status.saltmem(human_readable=False)
New in version 2015.8.0.

.sp
Returns the amount of memory that salt is using
.INDENT 7.0
.TP
.B human_readable
False
return the value in a nicely formatted number
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.saltmem
salt \(aq*\(aq status.saltmem human_readable=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_status.uptime(human_readable=False)
New in version 2015.8.0.

.sp
Return the system uptime for the machine
.INDENT 7.0
.TP
.B Parameters
\fBhuman_readable\fP (\fI\%bool\fP) \-\-
.sp
Return uptime in human readable format if \fBTrue\fP, otherwise
return seconds. Default is \fBFalse\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Human readable format is \fBdays, hours:min:sec\fP\&. Days will only
be displayed if more than 0
.UNINDENT
.UNINDENT

.TP
.B Returns
The uptime in seconds or human readable format depending on the
value of \fBhuman_readable\fP
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq status.uptime
salt \(aq*\(aq status.uptime human_readable=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_status.vmstats()
Return information about the virtual memory on the machine
.INDENT 7.0
.TP
.B Returns
A dictionary of virtual memory stats
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt * status.vmstats
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_system
.sp
Module for managing Windows systems and getting Windows system information.
Support for reboot, shutdown, join domain, rename
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
pywintypes
.IP \(bu 2
win32api
.IP \(bu 2
win32con
.IP \(bu 2
win32net
.IP \(bu 2
wmi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_computer_desc()
Get the Windows computer description
.INDENT 7.0
.TP
.B Returns
Returns the computer description if found. Otherwise returns
\fBFalse\fP\&.
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.get_computer_desc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_computer_description()
This function is an alias of \fBget_computer_desc\fP\&.
.INDENT 7.0
.INDENT 3.5
Get the Windows computer description
.INDENT 0.0
.TP
.B Returns:
str: Returns the computer description if found. Otherwise returns
\fBFalse\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.get_computer_desc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_computer_name()
Get the Windows computer name
.INDENT 7.0
.TP
.B Returns
Returns the computer name if found. Otherwise returns \fBFalse\fP\&.
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.get_computer_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_domain_workgroup()
Get the domain or workgroup the computer belongs to.
.sp
New in version 2015.5.7.

.sp
New in version 2015.8.2.

.INDENT 7.0
.TP
.B Returns
The name of the domain or workgroup
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.get_domain_workgroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_hostname()
Get the hostname of the windows minion
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Returns
Returns the hostname of the windows minion
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.get_hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_pending_component_servicing()
Determine whether there are pending Component Based Servicing tasks that
require a reboot.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if there are pending Component Based Servicing tasks,
otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_pending_component_servicing
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_pending_computer_name()
Get a pending computer name. If the computer name has been changed, and the
change is pending a system reboot, this function will return the pending
computer name. Otherwise, \fBNone\fP will be returned. If there was an error
retrieving the pending computer name, \fBFalse\fP will be returned, and an
error message will be logged to the minion log.
.INDENT 7.0
.TP
.B Returns
Returns the pending name if pending restart. Returns \fBNone\fP if not
pending restart.
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.get_pending_computer_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_pending_domain_join()
Determine whether there is a pending domain join action that requires a
reboot.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if there is a pending domain join action, otherwise
\fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_pending_domain_join
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_pending_file_rename()
Determine whether there are pending file rename operations that require a
reboot.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if there are pending file rename operations, otherwise
\fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_pending_file_rename
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_pending_reboot()
Determine whether there is a reboot pending.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if the system is pending reboot, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_pending_reboot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_pending_reboot_details()
Determine which check is signalling that the system is pending a reboot.
Useful in determining why your system is signalling that it needs a reboot.
.sp
New in version 3001.

.INDENT 7.0
.TP
.B Returns
A dictionary of the results of each system that would indicate a
pending reboot
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_pending_reboot_details
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_pending_servermanager()
Determine whether there are pending Server Manager tasks that require a
reboot.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if there are pending Server Manager tasks, otherwise
\fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_pending_servermanager
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_pending_update()
Determine whether there are pending updates that require a reboot.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if there are pending updates, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_pending_update
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_pending_windows_update()
Check the Windows Update system for a pending reboot state.
.sp
This leverages the Windows Update System to determine if the system is
pending a reboot.
.sp
New in version 3001.

.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if the Windows Update system reports a pending update,
otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_pending_windows_update
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_reboot_required_witnessed()
Determine if at any time during the current boot session the salt minion
witnessed an event indicating that a reboot is required.
.sp
This function will return \fBTrue\fP if an install completed with exit
code 3010 during the current boot session and can be extended where
appropriate in the future.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if the \fBRequires reboot\fP registry flag is set to \fB1\fP,
otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_reboot_required_witnessed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_system_date()
Get the Windows system date
.INDENT 7.0
.TP
.B Returns
Returns the system date
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.get_system_date
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_system_info()
Get system information.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Not all system info is available across all versions of Windows. If it
is not available on an older version, it will be skipped
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
Dictionary containing information about the system to include
name, description, version, etc...
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.get_system_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.get_system_time()
Get the system time.
.INDENT 7.0
.TP
.B Returns
Returns the system time in HH:MM:SS AM/PM format.
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.get_system_time
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.halt(timeout=5, in_seconds=False)
Halt a running system.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- Number of seconds before halting the system. Default is 5 seconds.
.IP \(bu 2
\fBin_seconds\fP (\fI\%bool\fP) \-\-
.sp
Whether to treat timeout as seconds or minutes.
.sp
New in version 2015.8.0.


.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.halt 5 True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.init(runlevel)
Change the system runlevel on sysV compatible systems. Not applicable to
Windows
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.init 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.join_domain(domain, username=None, password=None, account_ou=None, account_exists=False, restart=False)
Join a computer to an Active Directory domain. Requires a reboot.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdomain\fP (\fI\%str\fP) \-\- The domain to which the computer should be joined, e.g.
\fBexample.com\fP
.IP \(bu 2
\fBusername\fP (\fI\%str\fP) \-\- Username of an account which is authorized to join computers to the
specified domain. Needs to be either fully qualified like
\fBuser@domain.tld\fP or simply \fBuser\fP
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- Password of the specified user
.IP \(bu 2
\fBaccount_ou\fP (\fI\%str\fP) \-\- The DN of the OU below which the account for this computer should be
created when joining the domain, e.g.
\fBou=computers,ou=departm_432,dc=my\-company,dc=com\fP
.IP \(bu 2
\fBaccount_exists\fP (\fI\%bool\fP) \-\- If set to \fBTrue\fP the computer will only join the domain if the
account already exists. If set to \fBFalse\fP the computer account
will be created if it does not exist, otherwise it will use the
existing account. Default is \fBFalse\fP
.IP \(bu 2
\fBrestart\fP (\fI\%bool\fP) \-\-
.sp
\fBTrue\fP will restart the computer after a successful join. Default
is \fBFalse\fP
.sp
New in version 2015.5.7,2015.8.2.


.UNINDENT
.TP
.B Returns
Returns a dictionary if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.join_domain domain=\(aqdomain.tld\(aq \e
                 username=\(aqjoinuser\(aq password=\(aqjoinpassword\(aq \e
                 account_ou=\(aqou=clients,ou=org,dc=domain,dc=tld\(aq \e
                 account_exists=False, restart=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.lock()
Lock the workstation.
.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.lock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.poweroff(timeout=5, in_seconds=False)
Power off a running system.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- Number of seconds before powering off the system. Default is 5
seconds.
.IP \(bu 2
\fBin_seconds\fP (\fI\%bool\fP) \-\-
.sp
Whether to treat timeout as seconds or minutes.
.sp
New in version 2015.8.0.


.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.poweroff 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.reboot(timeout=5, in_seconds=False, wait_for_reboot=False, only_on_pending_reboot=False)
Reboot a running system.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\- The number of minutes/seconds before rebooting the system. Use of
minutes or seconds depends on the value of \fBin_seconds\fP\&. Default
is 5 minutes.
.IP \(bu 2
\fBin_seconds\fP (\fI\%bool\fP) \-\- .INDENT 2.0
.TP
.B \fBTrue\fP will cause the \fBtimeout\fP parameter to be in seconds.
\fBFalse\fP will be in minutes. Default is \fBFalse\fP\&.
.UNINDENT
.sp
New in version 2015.8.0.


.IP \(bu 2
\fBwait_for_reboot\fP (\fI\%bool\fP) \-\-
.sp
\fBTrue\fP will sleep for timeout + 30 seconds after reboot has been
initiated. This is useful for use in a highstate. For example, you
may have states that you want to apply only after the reboot.
Default is \fBFalse\fP\&.
.sp
New in version 2015.8.0.


.IP \(bu 2
\fBonly_on_pending_reboot\fP (\fI\%bool\fP) \-\- If this is set to \fBTrue\fP, then the reboot will only proceed
if the system reports a pending reboot. Setting this parameter to
\fBTrue\fP could be useful when calling this function from a final
housekeeping state intended to be executed at the end of a state run
(using \fIorder: last\fP). Default is \fBFalse\fP\&.
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful (a reboot will occur), otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.reboot 5
salt \(aq*\(aq system.reboot 5 True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Invoking this function from a final housekeeping state:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
final_housekeeping:
   module.run:
      \- name: system.reboot
      \- only_on_pending_reboot: True
      \- order: last
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.set_computer_desc(desc=None)
Set the Windows computer description
.INDENT 7.0
.TP
.B Parameters
\fBdesc\fP (\fI\%str\fP) \-\- The computer description
.TP
.B Returns
Description if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.set_computer_desc \(aqThis computer belongs to Dave!\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.set_computer_description(desc=None)
This function is an alias of \fBset_computer_desc\fP\&.
.INDENT 7.0
.INDENT 3.5
Set the Windows computer description
.sp
Args:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B desc (str):
The computer description
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B Returns:
str: Description if successful, otherwise \fBFalse\fP
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.set_computer_desc \(aqThis computer belongs to Dave!\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.set_computer_name(name)
Set the Windows computer name
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The new name to give the computer. Requires a reboot to take effect.
.TP
.B Returns
Returns a dictionary containing the old and new names if successful.
\fBFalse\fP if not.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.set_computer_name \(aqDavesComputer\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.set_domain_workgroup(workgroup)
Set the domain or workgroup the computer belongs to.
.sp
New in version 3001.

.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.set_domain_workgroup LOCAL
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.set_hostname(hostname)
Set the hostname of the windows minion, requires a restart before this will
be updated.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
\fBhostname\fP (\fI\%str\fP) \-\- The hostname to set
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.set_hostname newhostname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.set_reboot_required_witnessed()
This function is used to remember that an event indicating that a reboot is
required was witnessed. This function relies on the salt\-minion\(aqs ability to
create the following volatile registry key in the \fIHKLM\fP hive:
.INDENT 7.0
.INDENT 3.5
\fISYSTEM\eCurrentControlSet\eServices\esalt\-minion\eVolatile\-Data\fP
.UNINDENT
.UNINDENT
.sp
Because this registry key is volatile, it will not persist beyond the
current boot session. Also, in the scope of this key, the name \fI\(aqReboot
required\(aq\fP will be assigned the value of \fI1\fP\&.
.sp
For the time being, this function is being used whenever an install
completes with exit code 3010 and can be extended where appropriate in the
future.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_reboot_required_witnessed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.set_system_date(newdate)
Set the Windows system date. Use <mm\-dd\-yy> format for the date.
.INDENT 7.0
.TP
.B Parameters
\fBnewdate\fP (\fI\%str\fP) \-\-
.sp
The date to set. Can be any of the following formats
.INDENT 7.0
.IP \(bu 2
YYYY\-MM\-DD
.IP \(bu 2
MM\-DD\-YYYY
.IP \(bu 2
MM\-DD\-YY
.IP \(bu 2
MM/DD/YYYY
.IP \(bu 2
MM/DD/YY
.IP \(bu 2
YYYY/MM/DD
.UNINDENT

.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_system_date \(aq03\-28\-13\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.set_system_date_time(years=None, months=None, days=None, hours=None, minutes=None, seconds=None)
Set the system date and time. Each argument is an element of the date, but
not required. If an element is not passed, the current system value for that
element will be used. For example, if you don\(aqt pass the year, the current
system year will be used. (Used by set_system_date and set_system_time)
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fByears\fP (\fI\%int\fP) \-\- Years digit, ie: 2015
.IP \(bu 2
\fBmonths\fP (\fI\%int\fP) \-\- Months digit: 1 \- 12
.IP \(bu 2
\fBdays\fP (\fI\%int\fP) \-\- Days digit: 1 \- 31
.IP \(bu 2
\fBhours\fP (\fI\%int\fP) \-\- Hours digit: 0 \- 23
.IP \(bu 2
\fBminutes\fP (\fI\%int\fP) \-\- Minutes digit: 0 \- 59
.IP \(bu 2
\fBseconds\fP (\fI\%int\fP) \-\- Seconds digit: 0 \- 59
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.set_system_date_ time 2015 5 12 11 37 53
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.set_system_time(newtime)
Set the system time.
.INDENT 7.0
.TP
.B Parameters
\fBnewtime\fP (\fI\%str\fP) \-\-
.sp
The time to set. Can be any of the following formats:
.INDENT 7.0
.IP \(bu 2
HH:MM:SS AM/PM
.IP \(bu 2
HH:MM AM/PM
.IP \(bu 2
HH:MM:SS (24 hour)
.IP \(bu 2
HH:MM (24 hour)
.UNINDENT

.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.set_system_time 12:01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.shutdown(message=None, timeout=5, force_close=True, reboot=False, in_seconds=False, only_on_pending_reboot=False)
Shutdown a running system.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmessage\fP (\fI\%str\fP) \-\- The message to display to the user before shutting down.
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\-
.sp
The length of time (in seconds) that the shutdown dialog box should
be displayed. While this dialog box is displayed, the shutdown can
be aborted using the \fBsystem.shutdown_abort\fP function.
.sp
If timeout is not zero, InitiateSystemShutdown displays a dialog box
on the specified computer. The dialog box displays the name of the
user who called the function, the message specified by the lpMessage
parameter, and prompts the user to log off. The dialog box beeps
when it is created and remains on top of other windows (system
modal). The dialog box can be moved but not closed. A timer counts
down the remaining time before the shutdown occurs.
.sp
If timeout is zero, the computer shuts down immediately without
displaying the dialog box and cannot be stopped by
\fBsystem.shutdown_abort\fP\&.
.sp
Default is 5 minutes

.IP \(bu 2
\fBin_seconds\fP (\fI\%bool\fP) \-\- .INDENT 2.0
.TP
.B \fBTrue\fP will cause the \fBtimeout\fP parameter to be in seconds.
\fBFalse\fP will be in minutes. Default is \fBFalse\fP\&.
.UNINDENT
.sp
New in version 2015.8.0.


.IP \(bu 2
\fBforce_close\fP (\fI\%bool\fP) \-\- \fBTrue\fP will force close all open applications. \fBFalse\fP will
display a dialog box instructing the user to close open
applications. Default is \fBTrue\fP\&.
.IP \(bu 2
\fBreboot\fP (\fI\%bool\fP) \-\- \fBTrue\fP restarts the computer immediately after shutdown. \fBFalse\fP
powers down the system. Default is \fBFalse\fP\&.
.IP \(bu 2
\fBonly_on_pending_reboot\fP (\fI\%bool\fP) \-\- If this is set to True, then the shutdown
will only proceed if the system reports a pending reboot. To
optionally shutdown in a highstate, consider using the shutdown
state instead of this module.
.IP \(bu 2
\fBonly_on_pending_reboot\fP \-\- If \fBTrue\fP the shutdown will only proceed if there is a reboot
pending. \fBFalse\fP will shutdown the system. Default is \fBFalse\fP\&.
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful (a shutdown or reboot will occur), otherwise
\fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.shutdown \(dqSystem will shutdown in 5 minutes\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.shutdown_abort()
Abort a shutdown. Only available while the dialog box is being
displayed to the user. Once the shutdown has initiated, it cannot be
aborted.
.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.shutdown_abort
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.shutdown_hard()
Shutdown a running system with no timeout or warning.
.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.shutdown_hard
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.start_time_service()
Start the Windows time service
.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.start_time_service
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.stop_time_service()
Stop the Windows time service
.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq system.stop_time_service
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_system.unjoin_domain(username=None, password=None, domain=None, workgroup=\(aqWORKGROUP\(aq, disable=False, restart=False)
Unjoin a computer from an Active Directory Domain. Requires a restart.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBusername\fP (\fI\%str\fP) \-\- Username of an account which is authorized to manage computer
accounts on the domain. Needs to be a fully qualified name like
\fBuser@domain.tld\fP or \fBdomain.tld\euser\fP\&. If the domain is not
specified, the passed domain will be used. If the computer account
doesn\(aqt need to be disabled after the computer is unjoined, this can
be \fBNone\fP\&.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- The password of the specified user
.IP \(bu 2
\fBdomain\fP (\fI\%str\fP) \-\- The domain from which to unjoin the computer. Can be \fBNone\fP
.IP \(bu 2
\fBworkgroup\fP (\fI\%str\fP) \-\-
.sp
The workgroup to join the computer to. Default is \fBWORKGROUP\fP
.sp
New in version 2015.5.7,2015.8.2.


.IP \(bu 2
\fBdisable\fP (\fI\%bool\fP) \-\- \fBTrue\fP to disable the computer account in Active Directory.
Default is \fBFalse\fP
.IP \(bu 2
\fBrestart\fP (\fI\%bool\fP) \-\-
.sp
\fBTrue\fP will restart the computer after successful unjoin. Default
is \fBFalse\fP
.sp
New in version 2015.5.7,2015.8.2.


.UNINDENT
.TP
.B Returns
Returns a dictionary if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq system.unjoin_domain restart=True

salt \(aqminion\-id\(aq system.unjoin_domain username=\(aqunjoinuser\(aq \e
                 password=\(aqunjoinpassword\(aq disable=True \e
                 restart=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_task
.sp
Windows Task Scheduler Module
\&.. versionadded:: 2016.3.0
.sp
A module for working with the Windows Task Scheduler.
You can add and edit existing tasks.
You can add and clear triggers and actions.
You can list all tasks, folders, triggers, and actions.
.INDENT 0.0
.TP
.B salt.modules.win_task.add_action(name=None, location=\(aq\e\e\(aq, action_type=\(aqExecute\(aq, **kwargs)
Add an action to a task.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task to which to add the action.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location of the task. Default is
\fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.IP \(bu 2
\fBaction_type\fP (\fI\%str\fP) \-\-
.sp
The type of action to add. There are three action types. Each one
requires its own set of Keyword Arguments (kwargs). Valid values
are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Execute
.IP \(bu 2
Email
.IP \(bu 2
Message
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Required arguments for each action_type:
.sp
\fBExecute\fP
.INDENT 7.0
.INDENT 3.5
Execute a command or an executable
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B cmd (str):
(required) The command or executable to run.
.TP
.B arguments (str):
(optional) Arguments to be passed to the command or executable.
To launch a script the first command will need to be the
interpreter for the script. For example, to run a vbscript you
would pass \fBcscript.exe\fP in the \fBcmd\fP parameter and pass the
script in the \fBarguments\fP parameter as follows:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBcmd=\(aqcscript.exe\(aq arguments=\(aqc:\escripts\emyscript.vbs\(aq\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Batch files do not need an interpreter and may be passed to the
cmd parameter directly.
.TP
.B start_in (str):
(optional) The current working directory for the command.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBEmail\fP
.INDENT 7.0
.INDENT 3.5
Send and email. Requires \fBserver\fP, \fBfrom\fP, and \fBto\fP or \fBcc\fP\&.
.INDENT 0.0
.INDENT 3.5
from (str): The sender
.sp
reply_to (str): Who to reply to
.sp
to (str): The recipient
.sp
cc (str): The CC recipient
.sp
bcc (str): The BCC recipient
.sp
subject (str): The subject of the email
.sp
body (str): The Message Body of the email
.sp
server (str): The server used to send the email
.INDENT 0.0
.TP
.B attachments (list):
A list of attachments. These will be the paths to the files to
attach. ie: \fBattachments=\(dq[\(aqC:\eattachment1.txt\(aq,
\(aqC:\eattachment2.txt\(aq]\(dq\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBMessage\fP
.INDENT 7.0
.INDENT 3.5
Display a dialog box. The task must be set to \(dqRun only when user is
logged on\(dq in order for the dialog box to display. Both parameters are
required.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B title (str):
The dialog box title.
.TP
.B message (str):
The dialog box message body
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary containing the task configuration
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq task.add_action <task_name> cmd=\(aqdel /Q /S C:\e\eTemp\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.add_trigger(name=None, location=\(aq\e\e\(aq, trigger_type=None, trigger_enabled=True, start_date=None, start_time=None, end_date=None, end_time=None, random_delay=None, repeat_interval=None, repeat_duration=None, repeat_stop_at_duration_end=False, execution_time_limit=None, delay=None, **kwargs)
Add a trigger to a Windows Scheduled task
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Arguments are parsed by the YAML loader and are subject to
yaml\(aqs idiosyncrasies. Therefore, time values in some
formats (\fB%H:%M:%S\fP and \fB%H:%M\fP) should to be quoted.
See \fI\%YAML IDIOSYNCRASIES\fP for more details.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task to which to add the trigger.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location of the task. Default is
\fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.IP \(bu 2
\fBtrigger_type\fP (\fI\%str\fP) \-\-
.sp
The type of trigger to create. This is defined when the trigger is
created and cannot be changed later. Options are as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Event
.IP \(bu 2
Once
.IP \(bu 2
Daily
.IP \(bu 2
Weekly
.IP \(bu 2
Monthly
.IP \(bu 2
MonthlyDay
.IP \(bu 2
OnIdle
.IP \(bu 2
OnTaskCreation
.IP \(bu 2
OnBoot
.IP \(bu 2
OnLogon
.IP \(bu 2
OnSessionChange
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBtrigger_enabled\fP (\fI\%bool\fP) \-\- Boolean value that indicates whether the trigger is enabled.
.IP \(bu 2
\fBstart_date\fP (\fI\%str\fP) \-\-
.sp
The date when the trigger is activated. If no value is passed, the
current date will be used. Can be one of the following formats:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
%Y\-%m\-%d
.IP \(bu 2
%m\-%d\-%y
.IP \(bu 2
%m\-%d\-%Y
.IP \(bu 2
%m/%d/%y
.IP \(bu 2
%m/%d/%Y
.IP \(bu 2
%Y/%m/%d
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBstart_time\fP (\fI\%str\fP) \-\-
.sp
The time when the trigger is activated. If no value is passed,
midnight will be used. Can be one of the following formats:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
%I:%M:%S %p
.IP \(bu 2
%I:%M %p
.IP \(bu 2
%H:%M:%S
.IP \(bu 2
%H:%M
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBend_date\fP (\fI\%str\fP) \-\-
.sp
The date when the trigger is deactivated. The trigger cannot start
the task after it is deactivated. Can be one of the following
formats:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
%Y\-%m\-%d
.IP \(bu 2
%m\-%d\-%y
.IP \(bu 2
%m\-%d\-%Y
.IP \(bu 2
%m/%d/%y
.IP \(bu 2
%m/%d/%Y
.IP \(bu 2
%Y/%m/%d
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBend_time\fP (\fI\%str\fP) \-\-
.sp
The time when the trigger is deactivated. If this is not passed
with \fBend_date\fP it will be set to midnight. Can be one of the
following formats:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
%I:%M:%S %p
.IP \(bu 2
%I:%M %p
.IP \(bu 2
%H:%M:%S
.IP \(bu 2
%H:%M
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBrandom_delay\fP (\fI\%str\fP) \-\-
.sp
The delay time that is randomly added to the start time of the
trigger. Valid values are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
30 seconds
.IP \(bu 2
1 minute
.IP \(bu 2
30 minutes
.IP \(bu 2
1 hour
.IP \(bu 2
8 hours
.IP \(bu 2
1 day
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This parameter applies to the following trigger types
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Once
.IP \(bu 2
Daily
.IP \(bu 2
Weekly
.IP \(bu 2
Monthly
.IP \(bu 2
MonthlyDay
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBrepeat_interval\fP (\fI\%str\fP) \-\-
.sp
The amount of time between each restart of the task. Valid values
are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
5 minutes
.IP \(bu 2
10 minutes
.IP \(bu 2
15 minutes
.IP \(bu 2
30 minutes
.IP \(bu 2
1 hour
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBrepeat_duration\fP (\fI\%str\fP) \-\-
.sp
How long the pattern is repeated. Valid values are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Indefinitely
.IP \(bu 2
15 minutes
.IP \(bu 2
30 minutes
.IP \(bu 2
1 hour
.IP \(bu 2
12 hours
.IP \(bu 2
1 day
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBrepeat_stop_at_duration_end\fP (\fI\%bool\fP) \-\- Boolean value that indicates if a running instance of the task is
stopped at the end of the repetition pattern duration.
.IP \(bu 2
\fBexecution_time_limit\fP (\fI\%str\fP) \-\-
.sp
The maximum amount of time that the task launched by the trigger is
allowed to run. Valid values are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
30 minutes
.IP \(bu 2
1 hour
.IP \(bu 2
2 hours
.IP \(bu 2
4 hours
.IP \(bu 2
8 hours
.IP \(bu 2
12 hours
.IP \(bu 2
1 day
.IP \(bu 2
3 days (default)
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBdelay\fP (\fI\%str\fP) \-\-
.sp
The time the trigger waits after its activation to start the task.
Valid values are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
15 seconds
.IP \(bu 2
30 seconds
.IP \(bu 2
1 minute
.IP \(bu 2
30 minutes
.IP \(bu 2
1 hour
.IP \(bu 2
8 hours
.IP \(bu 2
1 day
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This parameter applies to the following trigger types:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
OnLogon
.IP \(bu 2
OnBoot
.IP \(bu 2
Event
.IP \(bu 2
OnTaskCreation
.IP \(bu 2
OnSessionChange
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
\fBkwargs\fP
.sp
There are optional keyword arguments determined by the type of trigger
being defined. They are as follows:
.sp
\fIEvent\fP
.INDENT 7.0
.INDENT 3.5
The trigger will be fired by an event.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B subscription (str):
An event definition in xml format that fires the trigger. The
easiest way to get this would is to create an event in Windows
Task Scheduler and then copy the xml text.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fIOnce\fP
.INDENT 7.0
.INDENT 3.5
No special parameters required.
.UNINDENT
.UNINDENT
.sp
\fIDaily\fP
.INDENT 7.0
.INDENT 3.5
The task will run daily.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B days_interval (int):
The interval between days in the schedule. An interval of 1
produces a daily schedule. An interval of 2 produces an
every\-other day schedule. If no interval is specified, 1 is
used. Valid entries are 1 \- 999.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fIWeekly\fP
.INDENT 7.0
.INDENT 3.5
The task will run weekly.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B weeks_interval (int):
The interval between weeks in the schedule. An interval of 1
produces a weekly schedule. An interval of 2 produces an
every\-other week schedule. If no interval is specified, 1 is
used. Valid entries are 1 \- 52.
.TP
.B days_of_week (list):
Sets the days of the week on which the task runs. Should be a
list. ie: \fB[\(aqMonday\(aq,\(aqWednesday\(aq,\(aqFriday\(aq]\fP\&. Valid entries are
the names of the days of the week.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fIMonthly\fP
.INDENT 7.0
.INDENT 3.5
The task will run monthly.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B months_of_year (list):
Sets the months of the year during which the task runs. Should
be a list. ie: \fB[\(aqJanuary\(aq,\(aqJuly\(aq]\fP\&. Valid entries are the
full names of all the months.
.TP
.B days_of_month (list):
Sets the days of the month during which the task runs. Should be
a list. ie: \fB[1, 15, \(aqLast\(aq]\fP\&. Options are all days of the
month 1 \- 31 and the word \(aqLast\(aq to indicate the last day of the
month.
.TP
.B last_day_of_month (bool):
Boolean value that indicates that the task runs on the last day
of the month regardless of the actual date of that day.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
You can set the task to run on the last day of the month by
either including the word \(aqLast\(aq in the list of days, or
setting the parameter \(aqlast_day_of_month\(aq equal to \fBTrue\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fIMonthlyDay\fP
.INDENT 7.0
.INDENT 3.5
The task will run monthly on the specified day.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B months_of_year (list):
Sets the months of the year during which the task runs. Should
be a list. ie: \fB[\(aqJanuary\(aq,\(aqJuly\(aq]\fP\&. Valid entries are the
full names of all the months.
.TP
.B weeks_of_month (list):
Sets the weeks of the month during which the task runs. Should
be a list. ie: \fB[\(aqFirst\(aq,\(aqThird\(aq]\fP\&. Valid options are:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
First
.IP \(bu 2
Second
.IP \(bu 2
Third
.IP \(bu 2
Fourth
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B last_week_of_month (bool):
Boolean value that indicates that the task runs on the last week
of the month.
.TP
.B days_of_week (list):
Sets the days of the week during which the task runs. Should be
a list. ie: \fB[\(aqMonday\(aq,\(aqWednesday\(aq,\(aqFriday\(aq]\fP\&.  Valid entries
are the names of the days of the week.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fIOnIdle\fP
.INDENT 7.0
.INDENT 3.5
No special parameters required.
.UNINDENT
.UNINDENT
.sp
\fIOnTaskCreation\fP
.INDENT 7.0
.INDENT 3.5
No special parameters required.
.UNINDENT
.UNINDENT
.sp
\fIOnBoot\fP
.INDENT 7.0
.INDENT 3.5
No special parameters required.
.UNINDENT
.UNINDENT
.sp
\fIOnLogon\fP
.INDENT 7.0
.INDENT 3.5
No special parameters required.
.UNINDENT
.UNINDENT
.sp
\fIOnSessionChange\fP
.INDENT 7.0
.INDENT 3.5
The task will be triggered by a session change.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B session_user_name (str):
Sets the user for the Terminal Server session. When a session
state change is detected for this user, a task is started. To
detect session status change for any user, do not pass this
parameter.
.TP
.B state_change (str):
Sets the kind of Terminal Server session change that would
trigger a task launch. Valid options are:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
ConsoleConnect: When you connect to a user session (switch
users)
.IP \(bu 2
ConsoleDisconnect: When you disconnect a user session
(switch users)
.IP \(bu 2
RemoteConnect: When a user connects via Remote Desktop
.IP \(bu 2
RemoteDisconnect: When a user disconnects via Remote
Desktop
.IP \(bu 2
SessionLock: When the workstation is locked
.IP \(bu 2
SessionUnlock: When the workstation is unlocked
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq task.add_trigger <task_name> trigger_type=Once trigger_enabled=True start_date=2016/12/1 start_time=\(aq\(dq12:01\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.clear_triggers(name, location=\(aq\e\e\(aq)
Remove all triggers from the task.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task from which to clear all triggers.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location of the task. Default is
\fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq task.clear_trigger <task_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.create_folder(name, location=\(aq\e\e\(aq)
Create a folder in which to create tasks.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the folder. This will be displayed in the task
scheduler.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location in which to create the
folder. Default is \fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq task.create_folder <folder_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.create_task(name, location=\(aq\e\e\(aq, user_name=\(aqSystem\(aq, password=None, force=False, **kwargs)
Create a new task in the designated location. This function has many keyword
arguments that are not listed here. For additional arguments see:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fI\%edit_task()\fP
.IP \(bu 2
\fI\%add_action()\fP
.IP \(bu 2
\fI\%add_trigger()\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task. This will be displayed in the task scheduler.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location in which to create the
task. Default is \fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.IP \(bu 2
\fBuser_name\fP (\fI\%str\fP) \-\- The user account under which to run the task. To specify the
\(aqSystem\(aq account, use \(aqSystem\(aq. The password will be ignored.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- The password to use for authentication. This should set the task to
run whether the user is logged in or not, but is currently not
working.
.IP \(bu 2
\fBforce\fP (\fI\%bool\fP) \-\- If the task exists, overwrite the existing task.
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq task.create_task <task_name> user_name=System force=True action_type=Execute cmd=\(aqdel /Q /S C:\e\eTemp\(aq trigger_type=Once start_date=2016\-12\-1 start_time=\(aq\(dq01:00\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.create_task_from_xml(name, location=\(aq\e\e\(aq, xml_text=None, xml_path=None, user_name=\(aqSystem\(aq, password=None)
Create a task based on XML. Source can be a file or a string of XML.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task. This will be displayed in the task scheduler.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location in which to create the
task. Default is \fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.IP \(bu 2
\fBxml_text\fP (\fI\%str\fP) \-\- A string of xml representing the task to be created. This will be
overridden by \fBxml_path\fP if passed.
.IP \(bu 2
\fBxml_path\fP (\fI\%str\fP) \-\- The path to an XML file on the local system containing the xml that
defines the task. This will override \fBxml_text\fP
.IP \(bu 2
\fBuser_name\fP (\fI\%str\fP) \-\- The user account under which to run the task. To specify the
\(aqSystem\(aq account, use \(aqSystem\(aq. The password will be ignored.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- The password to use for authentication. This should set the task to
run whether the user is logged in or not, but is currently not
working.
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
str: A string with the error message if there is an error
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
.INDENT 7.0
.IP \(bu 2
\fI\%ArgumentValueError\fP \-\- If arguments are invalid
.IP \(bu 2
\fI\%CommandExecutionError\fP \-\-
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq task.create_task_from_xml <task_name> xml_path=C:\etask.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.delete_folder(name, location=\(aq\e\e\(aq)
Delete a folder from the task scheduler.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the folder to delete.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location of the folder.  Default is
\fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq task.delete_folder <folder_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.delete_task(name, location=\(aq\e\e\(aq)
Delete a task from the task scheduler.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task to delete.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location of the task. Default is
\fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq task.delete_task <task_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.edit_task(name=None, location=\(aq\e\e\(aq, user_name=None, password=None, description=None, enabled=None, hidden=None, run_if_idle=None, idle_duration=None, idle_wait_timeout=None, idle_stop_on_end=None, idle_restart=None, ac_only=None, stop_if_on_batteries=None, wake_to_run=None, run_if_network=None, network_id=None, network_name=None, allow_demand_start=None, start_when_available=None, restart_every=None, restart_count=3, execution_time_limit=None, force_stop=None, delete_after=None, multiple_instances=None, **kwargs)
Edit the parameters of a task. Triggers and Actions cannot be edited yet.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task. This will be displayed in the task scheduler.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location in which to create the
task. Default is \fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.IP \(bu 2
\fBuser_name\fP (\fI\%str\fP) \-\- The user account under which to run the task. To specify the
\(aqSystem\(aq account, use \(aqSystem\(aq. The password will be ignored.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\-
.sp
The password to use for authentication. This should set the task to
run whether the user is logged in or not, but is currently not
working.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The combination of user_name and password determine how the
task runs. For example, if a username is passed without at
password the task will only run when the user is logged in. If a
password is passed as well the task will run whether the user is
logged on or not. If you pass \(aqSystem\(aq as the username the task
will run as the system account (the password parameter is
ignored).
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBdescription\fP (\fI\%str\fP) \-\- A string representing the text that will be displayed in the
description field in the task scheduler.
.IP \(bu 2
\fBenabled\fP (\fI\%bool\fP) \-\- A boolean value representing whether or not the task is enabled.
.IP \(bu 2
\fBhidden\fP (\fI\%bool\fP) \-\- A boolean value representing whether or not the task is hidden.
.IP \(bu 2
\fBrun_if_idle\fP (\fI\%bool\fP) \-\- Boolean value that indicates that the Task Scheduler will run the
task only if the computer is in an idle state.
.IP \(bu 2
\fBidle_duration\fP (\fI\%str\fP) \-\-
.sp
A value that indicates the amount of time that the computer must be
in an idle state before the task is run. Valid values are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
1 minute
.IP \(bu 2
5 minutes
.IP \(bu 2
10 minutes
.IP \(bu 2
15 minutes
.IP \(bu 2
30 minutes
.IP \(bu 2
1 hour
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBidle_wait_timeout\fP (\fI\%str\fP) \-\-
.sp
A value that indicates the amount of time that the Task Scheduler
will wait for an idle condition to occur. Valid values are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Do not wait
.IP \(bu 2
1 minute
.IP \(bu 2
5 minutes
.IP \(bu 2
10 minutes
.IP \(bu 2
15 minutes
.IP \(bu 2
30 minutes
.IP \(bu 2
1 hour
.IP \(bu 2
2 hours
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBidle_stop_on_end\fP (\fI\%bool\fP) \-\- Boolean value that indicates that the Task Scheduler will terminate
the task if the idle condition ends before the task is completed.
.IP \(bu 2
\fBidle_restart\fP (\fI\%bool\fP) \-\- Boolean value that indicates whether the task is restarted when the
computer cycles into an idle condition more than once.
.IP \(bu 2
\fBac_only\fP (\fI\%bool\fP) \-\- Boolean value that indicates that the Task Scheduler will launch the
task only while on AC power.
.IP \(bu 2
\fBstop_if_on_batteries\fP (\fI\%bool\fP) \-\- Boolean value that indicates that the task will be stopped if the
computer begins to run on battery power.
.IP \(bu 2
\fBwake_to_run\fP (\fI\%bool\fP) \-\- Boolean value that indicates that the Task Scheduler will wake the
computer when it is time to run the task.
.IP \(bu 2
\fBrun_if_network\fP (\fI\%bool\fP) \-\- Boolean value that indicates that the Task Scheduler will run the
task only when a network is available.
.IP \(bu 2
\fBnetwork_id\fP (\fIguid\fP) \-\- GUID value that identifies a network profile.
.IP \(bu 2
\fBnetwork_name\fP (\fI\%str\fP) \-\- Sets the name of a network profile. The name is used for display
purposes.
.IP \(bu 2
\fBallow_demand_start\fP (\fI\%bool\fP) \-\- Boolean value that indicates that the task can be started by using
either the Run command or the Context menu.
.IP \(bu 2
\fBstart_when_available\fP (\fI\%bool\fP) \-\- Boolean value that indicates that the Task Scheduler can start the
task at any time after its scheduled time has passed.
.IP \(bu 2
\fBrestart_every\fP (\fI\%str\fP) \-\-
.sp
A value that specifies the interval between task restart attempts.
Valid values are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
False (to disable)
.IP \(bu 2
1 minute
.IP \(bu 2
5 minutes
.IP \(bu 2
10 minutes
.IP \(bu 2
15 minutes
.IP \(bu 2
30 minutes
.IP \(bu 2
1 hour
.IP \(bu 2
2 hours
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBrestart_count\fP (\fI\%int\fP) \-\- The number of times the Task Scheduler will attempt to restart the
task. Valid values are integers 1 \- 999.
.IP \(bu 2
\fBexecution_time_limit\fP (\fI\%bool\fP\fI, \fP\fI\%str\fP) \-\-
.sp
The amount of time allowed to complete the task. Valid values are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
False (to disable)
.IP \(bu 2
1 hour
.IP \(bu 2
2 hours
.IP \(bu 2
4 hours
.IP \(bu 2
8 hours
.IP \(bu 2
12 hours
.IP \(bu 2
1 day
.IP \(bu 2
3 days
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBforce_stop\fP (\fI\%bool\fP) \-\- Boolean value that indicates that the task may be terminated by
using TerminateProcess.
.IP \(bu 2
\fBdelete_after\fP (\fI\%bool\fP\fI, \fP\fI\%str\fP) \-\-
.sp
The amount of time that the Task Scheduler will wait before deleting
the task after it expires. Requires a trigger with an expiration
date. Valid values are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
False (to disable)
.IP \(bu 2
Immediately
.IP \(bu 2
30 days
.IP \(bu 2
90 days
.IP \(bu 2
180 days
.IP \(bu 2
365 days
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBmultiple_instances\fP (\fI\%str\fP) \-\-
.sp
Sets the policy that defines how the Task Scheduler deals with
multiple instances of the task. Valid values are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Parallel
.IP \(bu 2
Queue
.IP \(bu 2
No New Instance
.IP \(bu 2
Stop Existing
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq task.edit_task <task_name> description=\(aqThis task is awesome\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.info(name, location=\(aq\e\e\(aq)
Get the details about a task in the task scheduler.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task for which to return the status
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location of the task. Default is
\fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.UNINDENT
.TP
.B Returns
A dictionary containing the task configuration
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq task.info <task_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.list_actions(name, location=\(aq\e\e\(aq)
List all actions that pertain to a task in the specified location.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task for which list actions.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location of the task from which to
list actions. Default is \fB\e\fP which is the root for the task
scheduler (\fBC:\eWindows\eSystem32\etasks\fP).
.UNINDENT
.TP
.B Returns
Returns a list of actions.
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# List all actions for a task in the default location
salt \(aqminion\-id\(aq task.list_actions <task_name>

# List all actions for the XblGameSaveTask in the Microsoft\eXblGameSave
# location
salt \(aqminion\-id\(aq task.list_actions XblGameSaveTask Microsoft\eXblGameSave
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.list_folders(location=\(aq\e\e\(aq)
List all folders located in a specific location in the task scheduler.
.INDENT 7.0
.TP
.B Parameters
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the folder from which you want to list
tasks. Default is \fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.TP
.B Returns
Returns a list of folders.
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# List all folders in the default location
salt \(aqminion\-id\(aq task.list_folders

# List all folders in the Microsoft directory
salt \(aqminion\-id\(aq task.list_folders Microsoft
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.list_tasks(location=\(aq\e\e\(aq)
List all tasks located in a specific location in the task scheduler.
.INDENT 7.0
.TP
.B Parameters
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the folder from which you want to list
tasks. Default is \fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.TP
.B Returns
Returns a list of tasks
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# List all tasks in the default location
salt \(aqminion\-id\(aq task.list_tasks

# List all tasks in the Microsoft\eXblGameSave Directory
salt \(aqminion\-id\(aq task.list_tasks Microsoft\eXblGameSave
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.list_triggers(name, location=\(aq\e\e\(aq)
List all triggers that pertain to a task in the specified location.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task for which list triggers.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location of the task from which to
list triggers. Default is \fB\e\fP which is the root for the task
scheduler (\fBC:\eWindows\eSystem32\etasks\fP).
.UNINDENT
.TP
.B Returns
Returns a list of triggers.
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# List all triggers for a task in the default location
salt \(aqminion\-id\(aq task.list_triggers <task_name>

# List all triggers for the XblGameSaveTask in the Microsoft\eXblGameSave
# location
salt \(aq*\(aq task.list_triggers XblGameSaveTask Microsoft\eXblGameSave
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.run(name, location=\(aq\e\e\(aq)
Run a scheduled task manually.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task to run.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location of the task. Default is
\fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq task.run <task_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.run_wait(name, location=\(aq\e\e\(aq)
Run a scheduled task and return when the task finishes
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task to run.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location of the task. Default is
\fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq task.run_wait <task_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.status(name, location=\(aq\e\e\(aq)
Determine the status of a task. Is it Running, Queued, Ready, etc.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task for which to return the status
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location of the task. Default is
\fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.UNINDENT
.TP
.B Returns
The current status of the task. Will be one of the following:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Unknown
.IP \(bu 2
Disabled
.IP \(bu 2
Queued
.IP \(bu 2
Ready
.IP \(bu 2
Running
.UNINDENT
.UNINDENT
.UNINDENT

.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq task.list_status <task_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_task.stop(name, location=\(aq\e\e\(aq)
Stop a scheduled task.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task to stop.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location of the task. Default is
\fB\e\fP which is the root for the task scheduler
(\fBC:\eWindows\eSystem32\etasks\fP).
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqminion\-id\(aq task.list_stop <task_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_timezone
.sp
Module for managing timezone on Windows systems.
.INDENT 0.0
.TP
.B class  salt.modules.win_timezone.TzMapper(unix_to_win)
.INDENT 7.0
.TP
.B add(k, v)
.UNINDENT
.INDENT 7.0
.TP
.B get_unix(key, default=None)
.UNINDENT
.INDENT 7.0
.TP
.B get_win(key, default=None)
.UNINDENT
.INDENT 7.0
.TP
.B list_unix()
.UNINDENT
.INDENT 7.0
.TP
.B list_win()
.UNINDENT
.INDENT 7.0
.TP
.B remove(k)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_timezone.get_hwclock()
Get current hardware clock setting (UTC or localtime)
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The hardware clock is always local time on Windows so this will always
return \(dqlocaltime\(dq
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_hwclock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_timezone.get_offset()
Get current numeric timezone offset from UTC (i.e. \-0700)
.INDENT 7.0
.TP
.B Returns
Offset from UTC
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_offset
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_timezone.get_zone()
Get current timezone (i.e. America/Denver)
.INDENT 7.0
.TP
.B Returns
Timezone in unix format
.TP
.B Return type
\fI\%str\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- If timezone could not be gathered
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_zone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_timezone.get_zonecode()
Get current timezone (i.e. PST, MDT, etc)
.INDENT 7.0
.TP
.B Returns
An abbreviated timezone code
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.get_zonecode
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_timezone.list(unix_style=True)
Return a list of Timezones that this module supports. These can be in either
Unix or Windows format.
.sp
New in version 2018.3.3.

.INDENT 7.0
.TP
.B Parameters
\fBunix_style\fP (\fI\%bool\fP) \-\- \fBTrue\fP returns Unix\-style timezones. \fBFalse\fP returns
Windows\-style timezones. Default is \fBTrue\fP
.TP
.B Returns
A list of supported timezones
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Unix\-style timezones
salt \(aq*\(aq timezone.list

# Windows\-style timezones
salt \(aq*\(aq timezone.list unix_style=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_timezone.set_hwclock(clock)
Sets the hardware clock to be either UTC or localtime
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The hardware clock is always local time on Windows so this will always
return \fBFalse\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.set_hwclock UTC
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_timezone.set_zone(timezone)
Sets the timezone using the tzutil.
.INDENT 7.0
.TP
.B Parameters
\fBtimezone\fP (\fI\%str\fP) \-\- A valid timezone
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- If invalid timezone is passed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.set_zone \(aqAmerica/Denver\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_timezone.zone_compare(timezone)
Compares the given timezone with the machine timezone. Mostly useful for
running state checks.
.INDENT 7.0
.TP
.B Parameters
\fBtimezone\fP (\fI\%str\fP) \-\- The timezone to compare. This can be in Windows or Unix format. Can
be any of the values returned by the \fBtimezone.list\fP function
.TP
.B Returns
\fBTrue\fP if they match, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq timezone.zone_compare \(aqAmerica/Denver\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_useradd
.sp
Module for managing Windows Users.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage users on a
minion, and it is using a different module (or gives an error similar to
\fI\(aquser.info\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
pywintypes
.IP \(bu 2
win32api
.IP \(bu 2
win32con
.IP \(bu 2
win32net
.IP \(bu 2
win32netcon
.IP \(bu 2
win32profile
.IP \(bu 2
win32security
.IP \(bu 2
win32ts
.IP \(bu 2
wmi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This currently only works with local user accounts, not domain accounts
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.add(name, password=None, fullname=None, description=None, groups=None, home=None, homedrive=None, profile=None, logonscript=None)
Add a user to the minion.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The username for the new account
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- User\(aqs password in plain text.
.IP \(bu 2
\fBfullname\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The user\(aqs full name.
.IP \(bu 2
\fBdescription\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- A brief description of the user account.
.IP \(bu 2
\fBgroups\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- A list of groups to add the user to.
(see chgroups)
.IP \(bu 2
\fBhome\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The path to the user\(aqs home directory.
.IP \(bu 2
\fBhomedrive\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The drive letter to assign to the home
directory. Must be the Drive Letter followed by a colon. ie: U:
.IP \(bu 2
\fBprofile\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- An explicit path to a profile. Can be a UNC or
a folder on the system. If left blank, windows uses its default
profile directory.
.IP \(bu 2
\fBlogonscript\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- Path to a login script to run when the user
logs on.
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP\&.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.add name password
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.addgroup(name, group)
Add user to a group
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The username to add to the group
.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- The name of the group to which to add the user
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP\&.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.addgroup jsnuffy \(aqPower Users\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.chfullname(name, fullname)
Change the full name of the user
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The username for which to change the full name
.IP \(bu 2
\fBfullname\fP (\fI\%str\fP) \-\- The new value for the full name
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP\&.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chfullname user \(aqFirst Last\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.chgroups(name, groups, append=True)
Change the groups this user belongs to, add append=False to make the user a
member of only the specified groups
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The username for which to change groups
.IP \(bu 2
\fBgroups\fP (\fI\%str\fP\fI, \fP\fI\%list\fP) \-\- A single group or a list of groups to assign to the
user. For multiple groups this can be a comma delimited string or a
list.
.IP \(bu 2
\fBappend\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- True adds the passed groups to the user\(aqs
current groups. False sets the user\(aqs groups to the passed groups
only. Default is True.
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP\&.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chgroups jsnuffy Administrators,Users True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.chhome(name, home, **kwargs)
Change the home directory of the user, pass True for persist to move files
to the new home directory if the old home directory exist.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the user whose home directory you wish to change
.IP \(bu 2
\fBhome\fP (\fI\%str\fP) \-\- The new location of the home directory
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP\&.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chhome foo \e\efileserver\ehome\efoo True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.chprofile(name, profile)
Change the profile directory of the user
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the user whose profile you wish to change
.IP \(bu 2
\fBprofile\fP (\fI\%str\fP) \-\- The new location of the profile
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP\&.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.chprofile foo \e\efileserver\eprofiles\efoo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.current(sam=False)
Get the username that salt\-minion is running under. If salt\-minion is
running as a service it should return the Local System account. If salt is
running from a command prompt it should return the username that started the
command prompt.
.sp
New in version 2015.5.6.

.INDENT 7.0
.TP
.B Parameters
\fBsam\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- False returns just the username without any domain
notation. True returns the domain with the username in the SAM
format. Ie: \fBdomain\eusername\fP
.TP
.B Returns
Returns username
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.current
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.delete(name, purge=False, force=False)
Remove a user from the minion
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the user to delete
.IP \(bu 2
\fBpurge\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- Boolean value indicating that the user profile
should also be removed when the user account is deleted. If set to
True the profile will be removed. Default is False.
.IP \(bu 2
\fBforce\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- Boolean value indicating that the user account
should be deleted even if the user is logged in. True will log the
user out and delete user.
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP\&.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.delete name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.getUserSid(username)
Deprecated function. Please use get_user_sid instead
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.get_user_sid jsnuffy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.get_user_sid(username)
Get the Security ID for the user
.INDENT 7.0
.TP
.B Parameters
\fBusername\fP (\fI\%str\fP) \-\- The username for which to look up the SID
.TP
.B Returns
The user SID
.TP
.B Return type
\fI\%str\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.get_user_sid jsnuffy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.getent(refresh=False)
Return the list of all info for all users
.INDENT 7.0
.TP
.B Parameters
\fBrefresh\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- Refresh the cached user information. Useful
when used from within a state function. Default is False.
.TP
.B Returns
A dictionary containing information about all users on the system
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.getent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.info(name)
Return user information
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- Username for which to display information
.TP
.B Returns
.INDENT 7.0
.TP
.B A dictionary containing user information
.INDENT 7.0
.IP \(bu 2
fullname
.IP \(bu 2
username
.IP \(bu 2
SID
.IP \(bu 2
passwd (will always return None)
.IP \(bu 2
comment (same as description, left here for backwards compatibility)
.IP \(bu 2
description
.IP \(bu 2
active
.IP \(bu 2
logonscript
.IP \(bu 2
profile
.IP \(bu 2
home
.IP \(bu 2
homedrive
.IP \(bu 2
groups
.IP \(bu 2
password_changed
.IP \(bu 2
successful_logon_attempts
.IP \(bu 2
failed_logon_attempts
.IP \(bu 2
last_logon
.IP \(bu 2
account_disabled
.IP \(bu 2
account_locked
.IP \(bu 2
expiration_date
.IP \(bu 2
password_never_expires
.IP \(bu 2
disallow_change_password
.IP \(bu 2
gid
.UNINDENT
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.info jsnuffy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.list_groups(name)
Return a list of groups the named user belongs to
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The username for which to list groups
.TP
.B Returns
A list of groups to which the user belongs
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.list_groups foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.list_users()
Return a list of all users on Windows
.INDENT 7.0
.TP
.B Returns
A list of all users on the system
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.list_users
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.removegroup(name, group)
Remove user from a group
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The username to remove from the group
.IP \(bu 2
\fBgroup\fP (\fI\%str\fP) \-\- The name of the group from which to remove the user
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP\&.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.removegroup jsnuffy \(aqPower Users\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.rename(name, new_name)
Change the username for a named user
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The username to change
.IP \(bu 2
\fBnew_name\fP (\fI\%str\fP) \-\- The new name for the current user
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP\&.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.rename jsnuffy jshmoe
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.setpassword(name, password)
Set the user\(aqs password
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The username for which to set the password
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- The new password
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP\&.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.setpassword jsnuffy sup3rs3cr3t
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_useradd.update(name, password=None, fullname=None, description=None, home=None, homedrive=None, logonscript=None, profile=None, expiration_date=None, expired=None, account_disabled=None, unlock_account=None, password_never_expires=None, disallow_change_password=None)
Updates settings for the Windows user. Name is the only required parameter.
Settings will only be changed if the parameter is passed a value.
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The username to update.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- New user password in plain text.
.IP \(bu 2
\fBfullname\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The user\(aqs full name.
.IP \(bu 2
\fBdescription\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- A brief description of the user account.
.IP \(bu 2
\fBhome\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The path to the user\(aqs home directory.
.IP \(bu 2
\fBhomedrive\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The drive letter to assign to the home
directory. Must be the Drive Letter followed by a colon. ie: U:
.IP \(bu 2
\fBlogonscript\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The path to the logon script.
.IP \(bu 2
\fBprofile\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The path to the user\(aqs profile directory.
.IP \(bu 2
\fBexpiration_date\fP (\fIdate\fP\fI, \fP\fIoptional\fP) \-\- The date and time when the account
expires. Can be a valid date/time string. To set to never expire
pass the string \(aqNever\(aq.
.IP \(bu 2
\fBexpired\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- Pass \fITrue\fP to expire the account. The user
will be prompted to change their password at the next logon. Pass
\fIFalse\fP to mark the account as \(aqnot expired\(aq. You can\(aqt use this to
negate the expiration if the expiration was caused by the account
expiring. You\(aqll have to change the \fIexpiration_date\fP as well.
.IP \(bu 2
\fBaccount_disabled\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- True disables the account. False
enables the account.
.IP \(bu 2
\fBunlock_account\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- True unlocks a locked user account.
False is ignored.
.IP \(bu 2
\fBpassword_never_expires\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- True sets the password to never
expire. False allows the password to expire.
.IP \(bu 2
\fBdisallow_change_password\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- True blocks the user from
changing the password. False allows the user to change the password.
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP\&.
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq user.update bob password=secret profile=C:\eUsers\eBob
         home=\eserver\ehomeshare\ebob homedrive=U:
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_wua
.sp
Module for managing Windows Updates using the Windows Update Agent.
.sp
List updates on the system using the following functions:
.INDENT 0.0
.IP \(bu 2
\fI\%win_wua.available\fP
.IP \(bu 2
\fBwin_wua.list\fP
.UNINDENT
.sp
This is an easy way to find additional information about updates available to
to the system, such as the GUID, KB number, or description.
.sp
Once you have the GUID or a KB number for the update you can get information
about the update, download, install, or uninstall it using these functions:
.INDENT 0.0
.IP \(bu 2
\fI\%win_wua.get\fP
.IP \(bu 2
\fI\%win_wua.download\fP
.IP \(bu 2
\fI\%win_wua.install\fP
.IP \(bu 2
\fI\%win_wua.uninstall\fP
.UNINDENT
.sp
The get function expects a name in the form of a GUID, KB, or Title and should
return information about a single update. The other functions accept either a
single item or a list of items for downloading/installing/uninstalling a
specific list of items.
.sp
The \fBwin_wua.list\fP and
\fI\%win_wua.get\fP functions are utility
functions. In addition to returning information about updates they can also
download and install updates by setting \fBdownload=True\fP or \fBinstall=True\fP\&.
So, with py:func:\fIwin_wua.list <salt.modules.win_wua.list_>\fP for example, you
could run the function with the filters you want to see what is available. Then
just add \fBinstall=True\fP to install everything on that list.
.sp
If you want to download, install, or uninstall specific updates, use
\fI\%win_wua.download\fP,
\fI\%win_wua.install\fP, or
\fI\%win_wua.uninstall\fP\&. To update your
system with the latest updates use \fBwin_wua.list\fP and set \fBinstall=True\fP
.sp
You can also adjust the Windows Update settings using the
\fI\%win_wua.set_wu_settings\fP
function. This function is only supported on the following operating systems:
.INDENT 0.0
.IP \(bu 2
Windows Vista / Server 2008
.IP \(bu 2
Windows 7 / Server 2008R2
.IP \(bu 2
Windows 8 / Server 2012
.IP \(bu 2
Windows 8.1 / Server 2012R2
.UNINDENT
.sp
As of Windows 10 and Windows Server 2016, the ability to modify the Windows
Update settings has been restricted. The settings can be modified in the Local
Group Policy using the \fBlgpo\fP module.
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B depends
salt.utils.win_update
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_wua.available(software=True, drivers=True, summary=False, skip_installed=True, skip_hidden=True, skip_mandatory=False, skip_reboot=False, categories=None, severities=None, online=True)
New in version 2017.7.0.

.sp
List updates that match the passed criteria. This allows for more filter
options than \fI\%list()\fP\&. Good for finding a specific GUID or KB.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsoftware\fP (\fI\%bool\fP) \-\- Include software updates in the results. Default is \fBTrue\fP
.IP \(bu 2
\fBdrivers\fP (\fI\%bool\fP) \-\- Include driver updates in the results. Default is \fBTrue\fP
.IP \(bu 2
\fBsummary\fP (\fI\%bool\fP) \-\- .INDENT 2.0
.IP \(bu 2
\fBTrue\fP: Return a summary of updates available for each category.
.IP \(bu 2
\fBFalse\fP (default): Return a detailed list of available updates.
.UNINDENT

.IP \(bu 2
\fBskip_installed\fP (\fI\%bool\fP) \-\- Skip updates that are already installed. Default is \fBTrue\fP
.IP \(bu 2
\fBskip_hidden\fP (\fI\%bool\fP) \-\- Skip updates that have been hidden. Default is \fBTrue\fP
.IP \(bu 2
\fBskip_mandatory\fP (\fI\%bool\fP) \-\- Skip mandatory updates. Default is \fBFalse\fP
.IP \(bu 2
\fBskip_reboot\fP (\fI\%bool\fP) \-\- Skip updates that require a reboot. Default is \fBFalse\fP
.IP \(bu 2
\fBcategories\fP (\fI\%list\fP) \-\-
.sp
Specify the categories to list. Must be passed as a list. All
categories returned by default.
.sp
Categories include the following:
.INDENT 2.0
.IP \(bu 2
Critical Updates
.IP \(bu 2
Definition Updates
.IP \(bu 2
Drivers (make sure you set \fBdrivers=True\fP)
.IP \(bu 2
Feature Packs
.IP \(bu 2
Security Updates
.IP \(bu 2
Update Rollups
.IP \(bu 2
Updates
.IP \(bu 2
Update Rollups
.IP \(bu 2
Windows 7
.IP \(bu 2
Windows 8.1
.IP \(bu 2
Windows 8.1 drivers
.IP \(bu 2
Windows 8.1 and later drivers
.IP \(bu 2
Windows Defender
.UNINDENT

.IP \(bu 2
\fBseverities\fP (\fI\%list\fP) \-\-
.sp
Specify the severities to include. Must be passed as a list. All
severities returned by default.
.sp
Severities include the following:
.INDENT 2.0
.IP \(bu 2
Critical
.IP \(bu 2
Important
.UNINDENT

.IP \(bu 2
\fBonline\fP (\fI\%bool\fP) \-\-
.sp
Tells the Windows Update Agent go online to update its local update
database. \fBTrue\fP will go online. \fBFalse\fP will use the local
update database as is. Default is \fBTrue\fP
.sp
New in version 3001.


.UNINDENT
.TP
.B Returns
Returns a dict containing either a summary or a list of updates:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Dict of Updates:
{\(aq<GUID>\(aq: {
    \(aqTitle\(aq: <title>,
    \(aqKB\(aq: <KB>,
    \(aqGUID\(aq: <the globally unique identifier for the update>,
    \(aqDescription\(aq: <description>,
    \(aqDownloaded\(aq: <has the update been downloaded>,
    \(aqInstalled\(aq: <has the update been installed>,
    \(aqMandatory\(aq: <is the update mandatory>,
    \(aqUserInput\(aq: <is user input required>,
    \(aqEULAAccepted\(aq: <has the EULA been accepted>,
    \(aqSeverity\(aq: <update severity>,
    \(aqNeedsReboot\(aq: <is the update installed and awaiting reboot>,
    \(aqRebootBehavior\(aq: <will the update require a reboot>,
    \(aqCategories\(aq: [
        \(aq<category 1>\(aq,
        \(aq<category 2>\(aq,
        ... ]
}}

Summary of Updates:
{\(aqTotal\(aq: <total number of updates returned>,
 \(aqAvailable\(aq: <updates that are not downloaded or installed>,
 \(aqDownloaded\(aq: <updates that are downloaded but not installed>,
 \(aqInstalled\(aq: <updates installed (usually 0 unless installed=True)>,
 \(aqCategories\(aq: {
    <category 1>: <total for that category>,
    <category 2>: <total for category 2>,
    ... }
}
.ft P
.fi
.UNINDENT
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Normal Usage (list all software updates)
salt \(aq*\(aq win_wua.available

# List all updates with categories of Critical Updates and Drivers
salt \(aq*\(aq win_wua.available categories=[\(dqCritical Updates\(dq,\(dqDrivers\(dq]

# List all Critical Security Updates
salt \(aq*\(aq win_wua.available categories=[\(dqSecurity Updates\(dq] severities=[\(dqCritical\(dq]

# List all updates with a severity of Critical
salt \(aq*\(aq win_wua.available severities=[\(dqCritical\(dq]

# A summary of all available updates
salt \(aq*\(aq win_wua.available summary=True

# A summary of all Feature Packs and Windows 8.1 Updates
salt \(aq*\(aq win_wua.available categories=[\(dqFeature Packs\(dq,\(dqWindows 8.1\(dq] summary=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_wua.download(names)
New in version 2017.7.0.

.sp
Downloads updates that match the list of passed identifiers. It\(aqs easier to
use this function by using list_updates and setting \fBdownload=True\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBnames\fP (\fI\%str\fP\fI, \fP\fI\%list\fP) \-\-
.sp
A single update or a list of updates to download. This can be any
combination of GUIDs, KB numbers, or names. GUIDs or KBs are
preferred.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
An error will be raised if there are more results than there are
items in the names parameter
.UNINDENT
.UNINDENT

.TP
.B Returns
A dictionary containing the details about the downloaded updates
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Normal Usage
salt \(aq*\(aq win_wua.download names=[\(aq12345678\-abcd\-1234\-abcd\-1234567890ab\(aq, \(aqKB2131233\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_wua.get(name, download=False, install=False, online=True)
New in version 2017.7.0.

.sp
Returns details for the named update
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the update you\(aqre searching for. This can be the GUID, a
KB number, or any part of the name of the update. GUIDs and KBs are
preferred. Run \fBlist\fP to get the GUID for the update you\(aqre
looking for.
.IP \(bu 2
\fBdownload\fP (\fI\%bool\fP) \-\- Download the update returned by this function. Run this function
first to see if the update exists, then set \fBdownload=True\fP to
download the update.
.IP \(bu 2
\fBinstall\fP (\fI\%bool\fP) \-\- Install the update returned by this function. Run this function
first to see if the update exists, then set \fBinstall=True\fP to
install the update.
.IP \(bu 2
\fBonline\fP (\fI\%bool\fP) \-\-
.sp
Tells the Windows Update Agent go online to update its local update
database. \fBTrue\fP will go online. \fBFalse\fP will use the local
update database as is. Default is \fBTrue\fP
.sp
New in version 3001.


.UNINDENT
.TP
.B Returns
.INDENT 7.0
.TP
.B Returns a dict containing a list of updates that match the name if
download and install are both set to False. Should usually be a
single update, but can return multiple if a partial name is given.
.UNINDENT
.sp
If download or install is set to true it will return the results of the
operation.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Dict of Updates:
{\(aq<GUID>\(aq: {
    \(aqTitle\(aq: <title>,
    \(aqKB\(aq: <KB>,
    \(aqGUID\(aq: <the globally unique identifier for the update>,
    \(aqDescription\(aq: <description>,
    \(aqDownloaded\(aq: <has the update been downloaded>,
    \(aqInstalled\(aq: <has the update been installed>,
    \(aqMandatory\(aq: <is the update mandatory>,
    \(aqUserInput\(aq: <is user input required>,
    \(aqEULAAccepted\(aq: <has the EULA been accepted>,
    \(aqSeverity\(aq: <update severity>,
    \(aqNeedsReboot\(aq: <is the update installed and awaiting reboot>,
    \(aqRebootBehavior\(aq: <will the update require a reboot>,
    \(aqCategories\(aq: [
        \(aq<category 1>\(aq,
        \(aq<category 2>\(aq,
        ... ]
}}
.ft P
.fi
.UNINDENT
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Recommended Usage using GUID without braces
# Use this to find the status of a specific update
salt \(aq*\(aq win_wua.get 12345678\-abcd\-1234\-abcd\-1234567890ab

# Use the following if you don\(aqt know the GUID:

# Using a KB number
# Not all updates have an associated KB
salt \(aq*\(aq win_wua.get KB3030298

# Using part or all of the name of the update
# Could possibly return multiple results
# Not all updates have an associated KB
salt \(aq*\(aq win_wua.get \(aqMicrosoft Camera Codec Pack\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_wua.get_needs_reboot()
Determines if the system needs to be rebooted.
.INDENT 7.0
.TP
.B Returns
\fBTrue\fP if the system requires a reboot, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_wua.get_needs_reboot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_wua.get_wu_settings()
Get current Windows Update settings.
.INDENT 7.0
.TP
.B Returns
A dictionary of Windows Update settings:
.INDENT 7.0
.TP
.B Featured Updates:
Boolean value that indicates whether to display notifications for
featured updates.
.TP
.B Group Policy Required (Read\-only):
Boolean value that indicates whether Group Policy requires the
Automatic Updates service.
.TP
.B Microsoft Update:
Boolean value that indicates whether to turn on Microsoft Update for
other Microsoft Products
.TP
.B Needs Reboot:
Boolean value that indicates whether the machine is in a reboot
pending state.
.TP
.B Non Admins Elevated:
Boolean value that indicates whether non\-administrators can perform
some update\-related actions without administrator approval.
.UNINDENT
.sp
Notification Level:
.INDENT 7.0
.INDENT 3.5
Number 1 to 4 indicating the update level:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP 1. 3
Never check for updates
.IP 2. 3
Check for updates but let me choose whether to download and
install them
.IP 3. 3
Download updates but let me choose whether to install them
.IP 4. 3
Install updates automatically
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Read Only (Read\-only):
Boolean value that indicates whether the Automatic Update
settings are read\-only.
.TP
.B Recommended Updates:
Boolean value that indicates whether to include optional or
recommended updates when a search for updates and installation of
updates is performed.
.TP
.B Scheduled Day:
Days of the week on which Automatic Updates installs or uninstalls
updates.
.TP
.B Scheduled Time:
Time at which Automatic Updates installs or uninstalls updates.
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_wua.get_wu_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_wua.install(names)
New in version 2017.7.0.

.sp
Installs updates that match the list of identifiers. It may be easier to use
the list_updates function and set \fBinstall=True\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBnames\fP (\fI\%str\fP\fI, \fP\fI\%list\fP) \-\- A single update or a list of updates to install. This can be any
combination of GUIDs, KB numbers, or names. GUIDs or KBs are
preferred.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
An error will be raised if there are more results than there are items
in the names parameter
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
A dictionary containing the details about the installed updates
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Normal Usage
salt \(aq*\(aq win_wua.install KB12323211
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_wua.installed(summary=False, kbs_only=False)
New in version 3001.

.sp
Get a list of all updates that are currently installed on the system.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This list may not necessarily match the Update History on the machine.
This will only show the updates that apply to the current build of
Windows. So, for example, the system may have shipped with Windows 10
Build 1607. That machine received updates to the 1607 build. Later the
machine was upgraded to a newer feature release, 1803 for example. Then
more updates were applied. This will only return the updates applied to
the 1803 build and not those applied when the system was at the 1607
build.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsummary\fP (\fI\%bool\fP) \-\- Return a summary instead of a detailed list of updates. \fBTrue\fP
will return a Summary, \fBFalse\fP will return a detailed list of
installed updates. Default is \fBFalse\fP
.IP \(bu 2
\fBkbs_only\fP (\fI\%bool\fP) \-\- Only return a list of KBs installed on the system. If this parameter
is passed, the \fBsummary\fP parameter will be ignored. Default is
\fBFalse\fP
.UNINDENT
.TP
.B Returns
.INDENT 7.0
.TP
.B Returns a dictionary of either a Summary or a detailed list of
updates installed on the system when \fBkbs_only=False\fP
.TP
.B list:
Returns a list of KBs installed on the system when \fBkbs_only=True\fP
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Get a detailed list of all applicable updates installed on the system
salt \(aq*\(aq win_wua.installed

# Get a summary of all applicable updates installed on the system
salt \(aq*\(aq win_wua.installed summary=True

# Get a simple list of KBs installed on the system
salt \(aq*\(aq win_wua.installed kbs_only=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_wua.list(software=True, drivers=False, summary=False, skip_installed=True, categories=None, severities=None, download=False, install=False, online=True)
New in version 2017.7.0.

.sp
Returns a detailed list of available updates or a summary. If \fBdownload\fP
or \fBinstall\fP is \fBTrue\fP the same list will be downloaded and/or
installed.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsoftware\fP (\fI\%bool\fP) \-\- Include software updates in the results. Default is \fBTrue\fP
.IP \(bu 2
\fBdrivers\fP (\fI\%bool\fP) \-\- Include driver updates in the results. Default is \fBFalse\fP
.IP \(bu 2
\fBsummary\fP (\fI\%bool\fP) \-\- .INDENT 2.0
.IP \(bu 2
\fBTrue\fP: Return a summary of updates available for each category.
.IP \(bu 2
\fBFalse\fP (default): Return a detailed list of available updates.
.UNINDENT

.IP \(bu 2
\fBskip_installed\fP (\fI\%bool\fP) \-\- Skip installed updates in the results. Default is \fBTrue\fP
.IP \(bu 2
\fBdownload\fP (\fI\%bool\fP) \-\- (Overrides reporting functionality) Download the list of updates
returned by this function. Run this function first with
\fBdownload=False\fP to see what will be downloaded, then set
\fBdownload=True\fP to download the updates. Default is \fBFalse\fP
.IP \(bu 2
\fBinstall\fP (\fI\%bool\fP) \-\- (Overrides reporting functionality) Install the list of updates
returned by this function. Run this function first with
\fBinstall=False\fP to see what will be installed, then set
\fBinstall=True\fP to install the updates. Default is \fBFalse\fP
.IP \(bu 2
\fBcategories\fP (\fI\%list\fP) \-\-
.sp
Specify the categories to list. Must be passed as a list. All
categories returned by default.
.sp
Categories include the following:
.INDENT 2.0
.IP \(bu 2
Critical Updates
.IP \(bu 2
Definition Updates
.IP \(bu 2
Drivers (make sure you set \fBdrivers=True\fP)
.IP \(bu 2
Feature Packs
.IP \(bu 2
Security Updates
.IP \(bu 2
Update Rollups
.IP \(bu 2
Updates
.IP \(bu 2
Update Rollups
.IP \(bu 2
Windows 7
.IP \(bu 2
Windows 8.1
.IP \(bu 2
Windows 8.1 drivers
.IP \(bu 2
Windows 8.1 and later drivers
.IP \(bu 2
Windows Defender
.UNINDENT

.IP \(bu 2
\fBseverities\fP (\fI\%list\fP) \-\-
.sp
Specify the severities to include. Must be passed as a list. All
severities returned by default.
.sp
Severities include the following:
.INDENT 2.0
.IP \(bu 2
Critical
.IP \(bu 2
Important
.UNINDENT

.IP \(bu 2
\fBonline\fP (\fI\%bool\fP) \-\-
.sp
Tells the Windows Update Agent go online to update its local update
database. \fBTrue\fP will go online. \fBFalse\fP will use the local
update database as is. Default is \fBTrue\fP
.sp
New in version 3001.


.UNINDENT
.TP
.B Returns
Returns a dict containing either a summary or a list of updates:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Dict of Updates:
{\(aq<GUID>\(aq: {
    \(aqTitle\(aq: <title>,
    \(aqKB\(aq: <KB>,
    \(aqGUID\(aq: <the globally unique identifier for the update>,
    \(aqDescription\(aq: <description>,
    \(aqDownloaded\(aq: <has the update been downloaded>,
    \(aqInstalled\(aq: <has the update been installed>,
    \(aqMandatory\(aq: <is the update mandatory>,
    \(aqUserInput\(aq: <is user input required>,
    \(aqEULAAccepted\(aq: <has the EULA been accepted>,
    \(aqSeverity\(aq: <update severity>,
    \(aqNeedsReboot\(aq: <is the update installed and awaiting reboot>,
    \(aqRebootBehavior\(aq: <will the update require a reboot>,
    \(aqCategories\(aq: [
        \(aq<category 1>\(aq,
        \(aq<category 2>\(aq,
        ... ]
}}

Summary of Updates:
{\(aqTotal\(aq: <total number of updates returned>,
 \(aqAvailable\(aq: <updates that are not downloaded or installed>,
 \(aqDownloaded\(aq: <updates that are downloaded but not installed>,
 \(aqInstalled\(aq: <updates installed (usually 0 unless installed=True)>,
 \(aqCategories\(aq: {
    <category 1>: <total for that category>,
    <category 2>: <total for category 2>,
    ... }
}
.ft P
.fi
.UNINDENT
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Normal Usage (list all software updates)
salt \(aq*\(aq win_wua.list

# List all updates with categories of Critical Updates and Drivers
salt \(aq*\(aq win_wua.list categories=[\(aqCritical Updates\(aq,\(aqDrivers\(aq]

# List all Critical Security Updates
salt \(aq*\(aq win_wua.list categories=[\(aqSecurity Updates\(aq] severities=[\(aqCritical\(aq]

# List all updates with a severity of Critical
salt \(aq*\(aq win_wua.list severities=[\(aqCritical\(aq]

# A summary of all available updates
salt \(aq*\(aq win_wua.list summary=True

# A summary of all Feature Packs and Windows 8.1 Updates
salt \(aq*\(aq win_wua.list categories=[\(aqFeature Packs\(aq,\(aqWindows 8.1\(aq] summary=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_wua.set_wu_settings(level=None, recommended=None, featured=None, elevated=None, msupdate=None, day=None, time=None)
Change Windows Update settings. If no parameters are passed, the current
value will be returned.
.INDENT 7.0
.TP
.B Supported:
.INDENT 7.0
.IP \(bu 2
Windows Vista / Server 2008
.IP \(bu 2
Windows 7 / Server 2008R2
.IP \(bu 2
Windows 8 / Server 2012
.IP \(bu 2
Windows 8.1 / Server 2012R2
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBlevel\fP (\fI\%int\fP) \-\-
.sp
Number from 1 to 4 indicating the update level:
.INDENT 2.0
.IP 1. 3
Never check for updates
.IP 2. 3
Check for updates but let me choose whether to download and
install them
.IP 3. 3
Download updates but let me choose whether to install them
.IP 4. 3
Install updates automatically
.UNINDENT

.IP \(bu 2
\fBrecommended\fP (\fI\%bool\fP) \-\- Boolean value that indicates whether to include optional or
recommended updates when a search for updates and installation of
updates is performed.
.IP \(bu 2
\fBfeatured\fP (\fI\%bool\fP) \-\- Boolean value that indicates whether to display notifications for
featured updates.
.IP \(bu 2
\fBelevated\fP (\fI\%bool\fP) \-\- Boolean value that indicates whether non\-administrators can perform
some update\-related actions without administrator approval.
.IP \(bu 2
\fBmsupdate\fP (\fI\%bool\fP) \-\- Boolean value that indicates whether to turn on Microsoft Update for
other Microsoft products
.IP \(bu 2
\fBday\fP (\fI\%str\fP) \-\-
.sp
Days of the week on which Automatic Updates installs or uninstalls
updates. Accepted values:
.INDENT 2.0
.IP \(bu 2
Everyday
.IP \(bu 2
Monday
.IP \(bu 2
Tuesday
.IP \(bu 2
Wednesday
.IP \(bu 2
Thursday
.IP \(bu 2
Friday
.IP \(bu 2
Saturday
.UNINDENT

.IP \(bu 2
\fBtime\fP (\fI\%str\fP) \-\- Time at which Automatic Updates installs or uninstalls updates. Must
be in the ##:## 24hr format, eg. 3:00 PM would be 15:00. Must be in
1 hour increments.
.UNINDENT
.TP
.B Returns
Returns a dictionary containing the results.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq win_wua.set_wu_settings level=4 recommended=True featured=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_wua.uninstall(names)
New in version 2017.7.0.

.sp
Uninstall updates.
.INDENT 7.0
.TP
.B Parameters
\fBnames\fP (\fI\%str\fP\fI, \fP\fI\%list\fP) \-\- A single update or a list of updates to uninstall. This can be any
combination of GUIDs, KB numbers, or names. GUIDs or KBs are
preferred.
.TP
.B Returns
A dictionary containing the details about the uninstalled updates
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Normal Usage
salt \(aq*\(aq win_wua.uninstall KB3121212

# As a list
salt \(aq*\(aq win_wua.uninstall guid=[\(aq12345678\-abcd\-1234\-abcd\-1234567890ab\(aq, \(aqKB1231231\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.win_wusa
.sp
Microsoft Update files management via wusa.exe
.INDENT 0.0
.TP
.B maintainer
Thomas Lemarchand
.TP
.B platform
Windows
.TP
.B depends
PowerShell
.UNINDENT
.sp
New in version 2018.3.4.

.INDENT 0.0
.TP
.B salt.modules.win_wusa.install(path, restart=False)
Install a KB from a .msu file.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The full path to the msu file to install
.IP \(bu 2
\fBrestart\fP (\fI\%bool\fP) \-\- \fBTrue\fP to force a restart if required by the installation. Adds
the \fB/forcerestart\fP switch to the \fBwusa.exe\fP command. \fBFalse\fP
will add the \fB/norestart\fP switch instead. Default is \fBFalse\fP
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- If the package is already installed or an error
    is encountered
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq wusa.install C:/temp/KB123456.msu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_wusa.is_installed(name)
Check if a specific KB is installed.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the KB to check
.TP
.B Returns
\fBTrue\fP if installed, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq wusa.is_installed KB123456
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_wusa.list_()
Get a list of updates installed on the machine
.INDENT 7.0
.TP
.B Returns
A list of installed updates
.TP
.B Return type
\fI\%list\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq wusa.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.win_wusa.uninstall(path, restart=False)
Uninstall a specific KB.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- The full path to the msu file to uninstall. This can also be just
the name of the KB to uninstall
.IP \(bu 2
\fBrestart\fP (\fI\%bool\fP) \-\- \fBTrue\fP to force a restart if required by the installation. Adds
the \fB/forcerestart\fP switch to the \fBwusa.exe\fP command. \fBFalse\fP
will add the \fB/norestart\fP switch instead. Default is \fBFalse\fP
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- If an error is encountered
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq wusa.uninstall KB123456

# or

salt \(aq*\(aq wusa.uninstall C:/temp/KB123456.msu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.winrepo
.sp
Module to manage Windows software repo on a Standalone Minion
.sp
\fBfile_client: local\fP must be set in the minion config file.
.sp
For documentation on Salt\(aqs Windows Repo feature, see \fI\%here\fP\&.
.INDENT 0.0
.TP
.B salt.modules.winrepo.genrepo()
Generate winrepo_cachefile based on sls files in the winrepo_dir
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call winrepo.genrepo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.winrepo.show_sls(name, saltenv=\(aqbase\(aq)
New in version 2015.8.0.

.sp
Display the rendered software definition from a specific sls file in the
local winrepo cache. This will parse all Jinja. Run pkg.refresh_db to pull
the latest software definitions from the master.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function does not ask a master for an sls file to render. Instead
it directly processes the file specified in \fIname\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstr\fP (\fIsaltenv\fP) \-\- The name/path of the package you want to view. This can be the
.IP \(bu 2
\fBlocal\fP (\fIfull path to a file on the minion file system\fP\fI or \fP\fIa file on the\fP) \-\-
.IP \(bu 2
\fBcache.\fP (\fIminion\fP) \-\-
.IP \(bu 2
\fBstr\fP \-\- The default environment is \fBbase\fP
.UNINDENT
.TP
.B Returns
Returns a dictionary containing the rendered data structure
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To use a file from the minion cache start from the local winrepo root
(\fBC:\esalt\evar\ecache\esalt\eminion\efiles\ebase\ewin\erepo\-ng\fP). If you have
\fB\&.sls\fP files organized in subdirectories you\(aqll have to denote them
with \fB\&.\fP\&. For example, if you have a \fBtest\fP directory in the winrepo
root with a \fBgvim.sls\fP file inside, would target that file like so:
\fBtest.gvim\fP\&. Directories can be targeted as well as long as they
contain an \fBinit.sls\fP inside. For example, if you have a \fBnode\fP
directory with an \fBinit.sls\fP inside, target that like so: \fBnode\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq winrepo.show_sls gvim
salt \(aq*\(aq winrepo.show_sls test.npp
salt \(aq*\(aq winrepo.show_sls C:\etest\egvim.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.winrepo.update_git_repos(clean=False)
Checkout git repos containing \fI\%Windows Software Package Definitions\fP\&.
.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
This function requires \fI\%Git for Windows\fP to be installed in order to
work. When installing, make sure to select an installation option which
permits the git executable to be run from the Command Prompt.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B clean
False
Clean repo cachedirs which are not configured under
\fI\%winrepo_remotes\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option only applies if either \fI\%pygit2\fP or \fI\%GitPython\fP is
installed into Salt\(aqs bundled Python.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This argument should not be set to \fBTrue\fP if a mix of git and
non\-git repo definitions are being used, as it will result in the
non\-git repo definitions being removed.
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call winrepo.update_git_repos
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.wordpress
.sp
This module is used to manage Wordpress installations
.INDENT 0.0
.TP
.B depends
wp binary from \fI\%http://wp\-cli.org/\fP
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.wordpress.Plugin(name, status, update, versino)
.INDENT 7.0
.TP
.B name
Alias for field number 0
.UNINDENT
.INDENT 7.0
.TP
.B status
Alias for field number 1
.UNINDENT
.INDENT 7.0
.TP
.B update
Alias for field number 2
.UNINDENT
.INDENT 7.0
.TP
.B versino
Alias for field number 3
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.wordpress.activate(name, path, user)
Activate a wordpress plugin
.INDENT 7.0
.TP
.B name
Wordpress plugin name
.TP
.B path
path to wordpress install location
.TP
.B user
user to run the command as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq wordpress.activate HyperDB /var/www/html apache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.wordpress.deactivate(name, path, user)
Deactivate a wordpress plugin
.INDENT 7.0
.TP
.B name
Wordpress plugin name
.TP
.B path
path to wordpress install location
.TP
.B user
user to run the command as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq wordpress.deactivate HyperDB /var/www/html apache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.wordpress.install(path, user, admin_user, admin_password, admin_email, title, url)
Run the initial setup functions for a wordpress install
.INDENT 7.0
.TP
.B path
path to wordpress install location
.TP
.B user
user to run the command as
.TP
.B admin_user
Username for the Administrative user for the wordpress install
.TP
.B admin_password
Initial Password for the Administrative user for the wordpress install
.TP
.B admin_email
Email for the Administrative user for the wordpress install
.TP
.B title
Title of the wordpress website for the wordpress install
.TP
.B url
Url for the wordpress install
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq wordpress.install /var/www/html apache dwallace password123             dwallace@example.com \(dqDaniel\(aqs Awesome Blog\(dq https://blog.dwallace.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.wordpress.is_installed(path, user=None)
Check if wordpress is installed and setup
.INDENT 7.0
.TP
.B path
path to wordpress install location
.TP
.B user
user to run the command as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq wordpress.is_installed /var/www/html apache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.wordpress.list_plugins(path, user)
List plugins in an installed wordpress path
.INDENT 7.0
.TP
.B path
path to wordpress install location
.TP
.B user
user to run the command as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq wordpress.list_plugins /var/www/html apache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.wordpress.show_plugin(name, path, user)
Show a plugin in a wordpress install and check if it is installed
.INDENT 7.0
.TP
.B name
Wordpress plugin name
.TP
.B path
path to wordpress install location
.TP
.B user
user to run the command as
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq wordpress.show_plugin HyperDB /var/www/html apache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.x509
.sp
Manage X509 certificates
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B depends
M2Crypto
.UNINDENT
.sp
Deprecated since version 3006.0.

.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module has been deprecated and will be removed
in Salt 3009 (Potassium). Please migrate to the replacement
modules. For breaking changes between both versions,
you can refer to the \fI\%x509_v2 execution module docs\fP\&.
.sp
They will become the default \fBx509\fP modules in Salt 3008 (Argon).
You can explicitly switch to the new modules before that release
by setting \fBfeatures: {x509_v2: true}\fP in your minion configuration.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.create_certificate(path=None, text=False, overwrite=True, ca_server=None, **kwargs)
Create an X509 certificate.
.INDENT 7.0
.TP
.B path:
Path to write the certificate to.
.TP
.B text:
If \fBTrue\fP, return the PEM text without writing to a file.
Default \fBFalse\fP\&.
.TP
.B overwrite:
If \fBTrue\fP (default), create_certificate will overwrite the entire PEM
file. Set False to preserve existing private keys and dh params that
may exist in the PEM file.
.TP
.B kwargs:
Any of the properties below can be included as additional
keyword arguments.
.TP
.B ca_server:
Request a remotely signed certificate from ca_server. For this to
work, a \fBsigning_policy\fP must be specified, and that same policy
must be configured on the ca_server. See \fBsigning_policy\fP for
details. Also, the salt master must permit peers to call the
\fBsign_remote_certificate\fP function.
.sp
Example:
.sp
/etc/salt/master.d/peer.conf
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
peer:
  .*:
    \- x509.sign_remote_certificate
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B subject properties:
Any of the values below can be included to set subject properties
Any other subject properties supported by OpenSSL should also work.
.INDENT 7.0
.TP
.B C:
2 letter Country code
.TP
.B CN:
Certificate common name, typically the FQDN.
.TP
.B Email:
Email address
.TP
.B GN:
Given Name
.TP
.B L:
Locality
.TP
.B O:
Organization
.TP
.B OU:
Organization Unit
.TP
.B SN:
SurName
.TP
.B ST:
State or Province
.UNINDENT
.TP
.B signing_private_key:
A path or string of the private key in PEM format that will be used
to sign this certificate. If neither \fBsigning_cert\fP, \fBpublic_key\fP,
or \fBcsr\fP are included, it will be assumed that this is a self\-signed
certificate, and the public key matching \fBsigning_private_key\fP will
be used to create the certificate.
.TP
.B signing_private_key_passphrase:
Passphrase used to decrypt the signing_private_key.
.TP
.B signing_cert:
A certificate matching the private key that will be used to sign this
certificate. This is used to populate the issuer values in the
resulting certificate. Do not include this value for
self\-signed certificates.
.TP
.B public_key:
The public key to be included in this certificate. This can be sourced
from a public key, certificate, CSR or private key. If a private key
is used, the matching public key from the private key will be
generated before any processing is done. This means you can request a
certificate from a remote CA using a private key file as your
public_key and only the public key will be sent across the network to
the CA. If neither \fBpublic_key\fP or \fBcsr\fP are specified, it will be
assumed that this is a self\-signed certificate, and the public key
derived from \fBsigning_private_key\fP will be used. Specify either
\fBpublic_key\fP or \fBcsr\fP, not both. Because you can input a CSR as a
public key or as a CSR, it is important to understand the difference.
If you import a CSR as a public key, only the public key will be added
to the certificate, subject or extension information in the CSR will
be lost.
.TP
.B public_key_passphrase:
If the public key is supplied as a private key, this is the passphrase
used to decrypt it.
.TP
.B csr:
A file or PEM string containing a certificate signing request. This
will be used to supply the subject, extensions and public key of a
certificate. Any subject or extensions specified explicitly will
overwrite any in the CSR.
.TP
.B basicConstraints:
X509v3 Basic Constraints extension.
.TP
.B extensions:
The following arguments set X509v3 Extension values. If the value
starts with \fBcritical\fP, the extension will be marked as critical.
.sp
Some special extensions are \fBsubjectKeyIdentifier\fP and
\fBauthorityKeyIdentifier\fP\&.
.sp
\fBsubjectKeyIdentifier\fP can be an explicit value or it can be the
special string \fBhash\fP\&. \fBhash\fP will set the subjectKeyIdentifier
equal to the SHA1 hash of the modulus of the public key in this
certificate. Note that this is not the exact same hashing method used
by OpenSSL when using the hash value.
.sp
\fBauthorityKeyIdentifier\fP Use values acceptable to the openssl CLI
tools. This will automatically populate \fBauthorityKeyIdentifier\fP
with the \fBsubjectKeyIdentifier\fP of \fBsigning_cert\fP\&. If this is a
self\-signed cert these values will be the same.
.INDENT 7.0
.TP
.B basicConstraints:
X509v3 Basic Constraints
.TP
.B keyUsage:
X509v3 Key Usage
.TP
.B extendedKeyUsage:
X509v3 Extended Key Usage
.TP
.B subjectKeyIdentifier:
X509v3 Subject Key Identifier
.TP
.B issuerAltName:
X509v3 Issuer Alternative Name
.TP
.B subjectAltName:
X509v3 Subject Alternative Name
.TP
.B crlDistributionPoints:
X509v3 CRL Distribution Points
.TP
.B issuingDistributionPoint:
X509v3 Issuing Distribution Point
.TP
.B certificatePolicies:
X509v3 Certificate Policies
.TP
.B policyConstraints:
X509v3 Policy Constraints
.TP
.B inhibitAnyPolicy:
X509v3 Inhibit Any Policy
.TP
.B nameConstraints:
X509v3 Name Constraints
.TP
.B noCheck:
X509v3 OCSP No Check
.TP
.B nsComment:
Netscape Comment
.TP
.B nsCertType:
Netscape Certificate Type
.UNINDENT
.TP
.B days_valid:
The number of days this certificate should be valid. This sets the
\fBnotAfter\fP property of the certificate. Defaults to 365.
.TP
.B version:
The version of the X509 certificate. Defaults to 3. This is
automatically converted to the version value, so \fBversion=3\fP
sets the certificate version field to 0x2.
.TP
.B serial_number:
The serial number to assign to this certificate. If omitted a random
serial number of size \fBserial_bits\fP is generated.
.TP
.B serial_bits:
The number of bits to use when randomly generating a serial number.
Defaults to 64.
.TP
.B algorithm:
The hashing algorithm to be used for signing this certificate.
Defaults to sha256.
.TP
.B copypath:
An additional path to copy the resulting certificate to. Can be used
to maintain a copy of all certificates issued for revocation purposes.
.TP
.B prepend_cn:
If set to True, the CN and a dash will be prepended to the copypath\(aqs filename.
.INDENT 7.0
.TP
.B Example:
/etc/pki/issued_certs/www.example.com\-DE:CA:FB:AD:00:00:00:00.crt
.UNINDENT
.TP
.B signing_policy:
A signing policy that should be used to create this certificate.
Signing policies should be defined in the minion configuration, or in
a minion pillar. It should be a YAML formatted list of arguments
which will override any arguments passed to this function. If the
\fBminions\fP key is included in the signing policy, only minions
matching that pattern (see match.glob and match.compound) will be
permitted to remotely request certificates from that policy.
In order to \fBmatch.compound\fP to work salt master must peers permit
peers to call it.
.sp
Example:
.sp
/etc/salt/master.d/peer.conf
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
peer:
  .*:
    \- match.compound
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
x509_signing_policies:
  www:
    \- minions: \(aqwww*\(aq
    \- signing_private_key: /etc/pki/ca.key
    \- signing_cert: /etc/pki/ca.crt
    \- C: US
    \- ST: Utah
    \- L: Salt Lake City
    \- basicConstraints: \(dqcritical CA:false\(dq
    \- keyUsage: \(dqcritical cRLSign, keyCertSign\(dq
    \- subjectKeyIdentifier: hash
    \- authorityKeyIdentifier: keyid,issuer:always
    \- days_valid: 90
    \- copypath: /etc/pki/issued_certs/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above signing policy can be invoked with \fBsigning_policy=www\fP
.TP
.B not_before:
Initial validity date for the certificate. This date must be specified
in the format \(aq%Y\-%m\-%d %H:%M:%S\(aq.
.sp
New in version 3001.

.TP
.B not_after:
Final validity date for the certificate. This date must be specified in
the format \(aq%Y\-%m\-%d %H:%M:%S\(aq.
.sp
New in version 3001.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.create_certificate path=/etc/pki/myca.crt signing_private_key=\(aq/etc/pki/myca.key\(aq csr=\(aq/etc/pki/myca.csr\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.create_crl(path=None, text=False, signing_private_key=None, signing_private_key_passphrase=None, signing_cert=None, revoked=None, include_expired=False, days_valid=100, digest=\(aq\(aq)
Create a CRL
.INDENT 7.0
.TP
.B Depends
.INDENT 7.0
.IP \(bu 2
PyOpenSSL Python module
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B path:
Path to write the CRL to.
.TP
.B text:
If \fBTrue\fP, return the PEM text without writing to a file.
Default \fBFalse\fP\&.
.TP
.B signing_private_key:
A path or string of the private key in PEM format that will be used
to sign the CRL. This is required.
.TP
.B signing_private_key_passphrase:
Passphrase to decrypt the private key.
.TP
.B signing_cert:
A certificate matching the private key that will be used to sign
the CRL. This is required.
.TP
.B revoked:
A list of dicts containing all the certificates to revoke. Each dict
represents one certificate. A dict must contain either the key
\fBserial_number\fP with the value of the serial number to revoke, or
\fBcertificate\fP with either the PEM encoded text of the certificate,
or a path to the certificate to revoke.
.sp
The dict can optionally contain the \fBrevocation_date\fP key. If this
key is omitted the revocation date will be set to now. If should be a
string in the format \(dq%Y\-%m\-%d %H:%M:%S\(dq.
.sp
The dict can also optionally contain the \fBnot_after\fP key. This is
redundant if the \fBcertificate\fP key is included. If the
\fBCertificate\fP key is not included, this can be used for the logic
behind the \fBinclude_expired\fP parameter. If should be a string in
the format \(dq%Y\-%m\-%d %H:%M:%S\(dq.
.sp
The dict can also optionally contain the \fBreason\fP key. This is the
reason code for the revocation. Available choices are \fBunspecified\fP,
\fBkeyCompromise\fP, \fBCACompromise\fP, \fBaffiliationChanged\fP,
\fBsuperseded\fP, \fBcessationOfOperation\fP and \fBcertificateHold\fP\&.
.TP
.B include_expired:
Include expired certificates in the CRL. Default is \fBFalse\fP\&.
.TP
.B days_valid:
The number of days that the CRL should be valid. This sets the Next
Update field in the CRL.
.TP
.B digest:
The digest to use for signing the CRL.
This has no effect on versions of pyOpenSSL less than 0.14
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.create_crl path=/etc/pki/mykey.key \e
        signing_private_key=/etc/pki/ca.key \e
        signing_cert=/etc/pki/ca.crt \e
        revoked=\(dq{\(aqcompromized\-web\-key\(aq: {\(aqcertificate\(aq: \(aq/etc/pki/certs/www1.crt\(aq, \(aqrevocation_date\(aq: \(aq2015\-03\-01 00:00:00\(aq}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.create_csr(path=None, text=False, **kwargs)
Create a certificate signing request.
.INDENT 7.0
.TP
.B path:
Path to write the certificate to.
.TP
.B text:
If \fBTrue\fP, return the PEM text without writing to a file.
Default \fBFalse\fP\&.
.TP
.B algorithm:
The hashing algorithm to be used for signing this request. Defaults to sha256.
.TP
.B kwargs:
The subject, extension and version arguments from
\fI\%x509.create_certificate\fP
can be used.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.create_csr path=/etc/pki/myca.csr public_key=\(aq/etc/pki/myca.key\(aq CN=\(aqMy Cert\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.create_private_key(path=None, text=False, bits=2048, passphrase=None, cipher=\(aqaes_128_cbc\(aq, verbose=True)
Creates a private key in PEM format.
.INDENT 7.0
.TP
.B path:
The path to write the file to, either \fBpath\fP or \fBtext\fP
are required.
.TP
.B text:
If \fBTrue\fP, return the PEM text without writing to a file.
Default \fBFalse\fP\&.
.TP
.B bits:
Length of the private key in bits. Default 2048
.TP
.B passphrase:
Passphrase for encrypting the private key
.TP
.B cipher:
Cipher for encrypting the private key. Has no effect if passphrase is None.
.TP
.B verbose:
Provide visual feedback on stdout. Default True
.sp
New in version 2016.11.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.create_private_key path=/etc/pki/mykey.key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.expired(certificate)
Returns a dict containing limited details of a
certificate and whether the certificate has expired.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B certificate:
The certificate to be read. Can be a path to a certificate file,
or a string containing the PEM formatted text of the certificate.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.expired \(dq/etc/pki/mycert.crt\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.get_pem_entries(glob_path)
Returns a dict containing PEM entries in files matching a glob
.INDENT 7.0
.TP
.B glob_path:
A path to certificates to be read and returned.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.get_pem_entries \(dq/etc/pki/*.crt\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.get_pem_entry(text, pem_type=None)
Returns a properly formatted PEM string from the input text fixing
any whitespace or line\-break issues
.INDENT 7.0
.TP
.B text:
Text containing the X509 PEM entry to be returned or path to
a file containing the text.
.TP
.B pem_type:
If specified, this function will only return a pem of a certain type,
for example \(aqCERTIFICATE\(aq or \(aqCERTIFICATE REQUEST\(aq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.get_pem_entry \(dq\-\-\-\-\-BEGIN CERTIFICATE REQUEST\-\-\-\-\-MIICyzCC Ar8CAQI...\-\-\-\-\-END CERTIFICATE REQUEST\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.get_private_key_size(private_key, passphrase=None)
Returns the bit length of a private key in PEM format.
.INDENT 7.0
.TP
.B private_key:
A path or PEM encoded string containing a private key.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.get_private_key_size /etc/pki/mycert.key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.get_public_key(key, passphrase=None, asObj=False)
Returns a string containing the public key in PEM format.
.INDENT 7.0
.TP
.B key:
A path or PEM encoded string containing a CSR, Certificate or
Private Key from which a public key can be retrieved.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.get_public_key /etc/pki/mycert.cer
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.get_signing_policy(signing_policy_name)
Returns the details of a names signing policy, including the text of
the public key that will be used to sign it. Does not return the
private key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.get_signing_policy www
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.read_certificate(certificate)
Returns a dict containing details of a certificate. Input can be a PEM
string or file path.
.INDENT 7.0
.TP
.B certificate:
The certificate to be read. Can be a path to a certificate file, or
a string containing the PEM formatted text of the certificate.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.read_certificate /etc/pki/mycert.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.read_certificates(glob_path)
Returns a dict containing details of all certificates matching a glob
.INDENT 7.0
.TP
.B glob_path:
A path to certificates to be read and returned.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.read_certificates \(dq/etc/pki/*.crt\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.read_crl(crl)
Returns a dict containing details of a certificate revocation list.
Input can be a PEM string or file path.
.INDENT 7.0
.TP
.B Depends
.INDENT 7.0
.IP \(bu 2
OpenSSL command line tool
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B crl:
A path or PEM encoded string containing the CRL to read.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.read_crl /etc/pki/mycrl.crl
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.read_csr(csr)
Returns a dict containing details of a certificate request.
.INDENT 7.0
.TP
.B Depends
.INDENT 7.0
.IP \(bu 2
OpenSSL command line tool
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B csr:
A path or PEM encoded string containing the CSR to read.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.read_csr /etc/pki/mycert.csr
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.sign_remote_certificate(argdic, **kwargs)
Request a certificate to be remotely signed according to a signing policy.
.INDENT 7.0
.TP
.B argdic:
A dict containing all the arguments to be passed into the
create_certificate function. This will become kwargs when passed
to create_certificate.
.TP
.B kwargs:
kwargs delivered from publish.publish
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.sign_remote_certificate argdic=\(dq{\(aqpublic_key\(aq: \(aq/etc/pki/www.key\(aq, \(aqsigning_policy\(aq: \(aqwww\(aq}\(dq __pub_id=\(aqwww1\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.verify_crl(crl, cert)
Validate a CRL against a certificate.
Parses openssl command line output, this is a workaround for M2Crypto\(aqs
inability to get them from CSR objects.
.INDENT 7.0
.TP
.B crl:
The CRL to verify
.TP
.B cert:
The certificate to verify the CRL against
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.verify_crl crl=/etc/pki/myca.crl cert=/etc/pki/myca.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.verify_private_key(private_key, public_key, passphrase=None)
Verify that \(aqprivate_key\(aq matches \(aqpublic_key\(aq
.INDENT 7.0
.TP
.B private_key:
The private key to verify, can be a string or path to a private
key in PEM format.
.TP
.B public_key:
The public key to verify, can be a string or path to a PEM formatted
certificate, CSR, or another private key.
.TP
.B passphrase:
Passphrase to decrypt the private key.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.verify_private_key private_key=/etc/pki/myca.key \e
        public_key=/etc/pki/myca.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.verify_signature(certificate, signing_pub_key=None, signing_pub_key_passphrase=None)
Verify that \fBcertificate\fP has been signed by \fBsigning_pub_key\fP
.INDENT 7.0
.TP
.B certificate:
The certificate to verify. Can be a path or string containing a
PEM formatted certificate.
.TP
.B signing_pub_key:
The public key to verify, can be a string or path to a PEM formatted
certificate, CSR, or private key.
.TP
.B signing_pub_key_passphrase:
Passphrase to the signing_pub_key if it is an encrypted private key.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.verify_signature /etc/pki/mycert.pem \e
        signing_pub_key=/etc/pki/myca.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.will_expire(certificate, days)
Returns a dict containing details of a certificate and whether
the certificate will expire in the specified number of days.
Input can be a PEM string or file path.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B certificate:
The certificate to be read. Can be a path to a certificate file,
or a string containing the PEM formatted text of the certificate.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.will_expire \(dq/etc/pki/mycert.crt\(dq days=30
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509.write_pem(text, path, overwrite=True, pem_type=None)
Writes out a PEM string fixing any formatting or whitespace
issues before writing.
.INDENT 7.0
.TP
.B text:
PEM string input to be written out.
.TP
.B path:
Path of the file to write the PEM out to.
.TP
.B overwrite:
If \fBTrue\fP (default), write_pem will overwrite the entire PEM file.
Set False to preserve existing private keys and dh params that may
exist in the PEM file.
.TP
.B pem_type:
The PEM type to be saved, for example \fBCERTIFICATE\fP or
\fBPUBLIC KEY\fP\&. Adding this will allow the function to take
input that may contain multiple PEM types.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.write_pem \(dq\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-MIIGMzCCBBugA...\(dq path=/etc/pki/mycert.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.x509_v2
.SS Manage X.509 certificates
.INDENT 0.0
.TP
.B depends
cryptography
.UNINDENT
.sp
New in version 3006.0: This module represents a complete rewrite of the original \fBx509\fP modules
and is named \fBx509_v2\fP since it introduces breaking changes.

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
PKCS12\-related operations require at least cryptography release 36.
.IP \(bu 2
PKCS12\-related operations with Edwards\-curve keys require at least cryptography release 37.
.IP \(bu 2
PKCS7\-related operations require at least cryptography release 37.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Configuration
.SS Explicit activation
.sp
Since this module uses the same virtualname as the previous \fBx509\fP modules,
but is incompatible with them, it needs to be explicitly activated on each
minion by including the following line in the minion configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/minion.d/x509.conf

features:
  x509_v2: true
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Peer communication
.sp
To be able to remotely sign certificates, it is required to configure the Salt
master to allow \fI\%Peer Communication\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/master.d/peer.conf

peer:
  .*:
    \- x509.sign_remote_certificate
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In order for the \fI\%Compound Matcher\fP to work with restricting signing
policies to a subset of minions, in addition calls to
\fI\%match.compound_matches\fP
by the minion acting as the CA must be permitted:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/master.d/peer.conf

peer:
  .*:
    \- x509.sign_remote_certificate

peer_run:
  ca_server:
    \- match.compound_matches
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When compound match expressions are employed, pillar values can only be matched
literally. This is a barrier to enumeration attacks by the CA server.
.sp
Also note that compound matching requires a minion data cache on the master.
Any certificate signing request will be denied if \fI\%minion_data_cache\fP is
disabled (it is enabled by default).
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Since grain values are controlled by minions, you should avoid using them
to restrict certificate issuance.
.sp
See \fI\%Is Targeting using Grain Data Secure?\fP\&.
.UNINDENT
.UNINDENT
.sp
Changed in version 3007.0: Previously, a compound expression match was validated by the requesting minion
itself via peer publishing, which did not protect from compromised minions.
The new match validation takes place on the master using peer running.

.SS Signing policies
.sp
In addition, the minion representing the CA needs to have at least one
signing policy configured, remote calls not referencing one are always
rejected.
.sp
The parameters specified in this signing policy override any
parameters passed from the minion requesting the certificate. It can be
configured in the CA minion\(aqs pillar, which takes precedence, or any
location \fI\%config.get\fP looks up in.
Signing policies are defined under \fBx509_signing_policies\fP\&.
.sp
You can restrict which minions can request a certificate under a configured
signing policy by specifying a matcher in \fBminions\fP\&. This can be a glob
or compound matcher (for the latter, see the notes above).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
x509_signing_policies:
  www:
    \- minions: \(aqwww*\(aq
    \- signing_private_key: /etc/pki/ca.key
    \- signing_cert: /etc/pki/ca.crt
    \- C: US
    \- ST: Utah
    \- L: Salt Lake City
    \- basicConstraints: \(dqcritical, CA:false\(dq
    \- keyUsage: \(dqcritical, cRLSign, keyCertSign\(dq
    \- subjectKeyIdentifier: hash
    \- authorityKeyIdentifier: keyid,issuer:always
    \- days_valid: 90
    \- copypath: /etc/pki/issued_certs/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The following semantics are applied regarding the order of preference
for specifying the subject name:
.INDENT 0.0
.IP \(bu 2
If neither \fBsubject\fP nor any name attributes (like \fBCN\fP) are part of the policy,
issued certificates can contain any requested ones.
.IP \(bu 2
If any name attributes are specified in the signing policy, \fBsubject\fP contained
in requests is ignored.
.IP \(bu 2
If \fBsubject\fP is specified in the signing policy, any name attributes are ignored.
If the request contains the same data type for \fBsubject\fP as the signing policy
(for dicts and lists, and only then), merging is performed, otherwise \fBsubject\fP
is taken from the signing policy. Dicts are merged and list items are appended,
with the items taken from the signing policy having priority.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Breaking changes versus the previous \fBx509\fP modules
.INDENT 0.0
.IP \(bu 2
The output format has changed for all \fBread_*\fP functions as well as the state return dict.
.IP \(bu 2
The formatting of some extension definitions might have changed, but should
be stable for most basic use cases.
.IP \(bu 2
The default ordering of RDNs/Name Attributes in the subject\(aqs Distinguished Name
has been adapted to industry standards. This might cause a reissuance
during the first state run.
.IP \(bu 2
For \fBx509.private_key_managed\fP, the file mode defaults to \fB0400\fP\&. This should
be considered a bug fix because writing private keys with world\-readable
permissions by default is a security issue.
.IP \(bu 2
Restricting signing policies using compound match expressions requires peer run
permissions instead of peer publishing permissions:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# x509, x509_v2 in 3006.*
peer:
  ca_server:
    \- match.compound

# x509_v2 from 3007.0 onwards
peer_run:
  ca_server:
    \- match.compound_matches
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that when a \fBca_server\fP is involved, both peers must use the updated module version.
.INDENT 0.0
.TP
.B salt.modules.x509_v2.create_certificate(ca_server=None, signing_policy=None, encoding=\(aqpem\(aq, append_certs=None, pkcs12_passphrase=None, pkcs12_encryption_compat=False, pkcs12_friendlyname=None, path=None, overwrite=True, raw=False, **kwargs)
Create an X.509 certificate and return an encoded version of it.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
All parameters that take a public key, private key or certificate
can be specified either as a PEM/hex/base64 string or a path to a
local file encoded in all supported formats for the type.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.create_certificate signing_private_key=\(aq/etc/pki/myca.key\(aq csr=\(aq/etc/pki/my.csr\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B ca_server
Request a remotely signed certificate from ca_server. For this to
work, a \fBsigning_policy\fP must be specified, and that same policy
must be configured on the ca_server. See \fI\%Signing policies\fP for
details. Also, the Salt master must permit peers to call the
\fBsign_remote_certificate\fP function, see \fI\%Peer communication\fP\&.
.TP
.B signing_policy
The name of a configured signing policy. Parameters specified in there
are hardcoded and cannot be overridden. This is required for remote signing,
otherwise optional. See \fI\%Signing policies\fP for details.
.TP
.B encoding
Specify the encoding of the resulting certificate. It can be returned
as a \fBpem\fP (or \fBpkcs7_pem\fP) string or several (base64\-encoded)
binary formats (\fBder\fP, \fBpkcs7_der\fP, \fBpkcs12\fP). Defaults to \fBpem\fP\&.
.TP
.B append_certs
A list of additional certificates to append to the new one, e.g. to create a CA chain.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Mind that when \fBder\fP encoding is in use, appending certificatees is prohibited.
.UNINDENT
.UNINDENT
.TP
.B copypath
Create a copy of the issued certificate in PEM format in this directory.
The file will be named \fB<serial_number>.crt\fP if prepend_cn is False.
.TP
.B prepend_cn
When \fBcopypath\fP is set, prepend the common name of the certificate to
the file name like so: \fB<CN>\-<serial_number>.crt\fP\&. Defaults to false.
.TP
.B pkcs12_passphrase
When encoding a certificate as \fBpkcs12\fP, encrypt it with this passphrase.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
PKCS12 encryption is very weak and \fI\%should not be relied on for security\fP\&.
.UNINDENT
.UNINDENT
.TP
.B pkcs12_encryption_compat
OpenSSL 3 and cryptography v37 switched to a much more secure default
encryption for PKCS12, which might be incompatible with some systems.
This forces the legacy encryption. Defaults to False.
.TP
.B pkcs12_friendlyname
When encoding a certificate as \fBpkcs12\fP, a name for the certificate can be included.
.TP
.B path
Instead of returning the certificate, write it to this file path.
.TP
.B overwrite
If \fBpath\fP is specified and the file exists, overwrite it.
Defaults to true.
.TP
.B raw
Return the encoded raw bytes instead of a string. Defaults to false.
.TP
.B digest
The hashing algorithm to use for the signature. Valid values are:
sha1, sha224, sha256, sha384, sha512, sha512_224, sha512_256, sha3_224,
sha3_256, sha3_384, sha3_512. Defaults to \fBsha256\fP\&.
This will be ignored for \fBed25519\fP and \fBed448\fP key types.
.TP
.B private_key
The private key corresponding to the public key the certificate should
be issued for. This is one way of specifying the public key that will
be included in the certificate, the other ones being \fBpublic_key\fP and \fBcsr\fP\&.
.TP
.B private_key_passphrase
If \fBprivate_key\fP is specified and encrypted, the passphrase to decrypt it.
.TP
.B public_key
The public key the certificate should be issued for. Other ways of passing
the required information are \fBprivate_key\fP and \fBcsr\fP\&. If neither are set,
the public key of the \fBsigning_private_key\fP will be included, i.e.
a self\-signed certificate is generated.
.TP
.B csr
A certificate signing request to use as a base for generating the certificate.
The following information will be respected, depending on configuration:
* public key
* extensions, if not otherwise specified (arguments, signing_policy)
.TP
.B signing_cert
The CA certificate to be used for signing the issued certificate.
.TP
.B signing_private_key
The private key corresponding to the public key in \fBsigning_cert\fP\&. Required.
.TP
.B signing_private_key_passphrase
If \fBsigning_private_key\fP is encrypted, the passphrase to decrypt it.
.TP
.B serial_number
A serial number to be embedded in the certificate. If unspecified, will
autogenerate one. This should be an integer, either in decimal or
hexadecimal notation.
.TP
.B not_before
Set a specific date the certificate should not be valid before.
The format should follow \fB%Y\-%m\-%d %H:%M:%S\fP and will be interpreted as GMT/UTC.
Defaults to the time of issuance.
.TP
.B not_after
Set a specific date the certificate should not be valid after.
The format should follow \fB%Y\-%m\-%d %H:%M:%S\fP and will be interpreted as GMT/UTC.
If unspecified, defaults to the current time plus \fBdays_valid\fP days.
.TP
.B days_valid
If \fBnot_after\fP is unspecified, the number of days from the time of issuance
the certificate should be valid for. Defaults to \fB30\fP\&.
.TP
.B subject
The subject\(aqs distinguished name embedded in the certificate. This is one way of
passing this information (see \fBkwargs\fP below for the other).
This argument will be preferred and allows to control the order of RDNs in the DN
as well as to embed RDNs with multiple attributes.
This can be specified as an RFC4514\-encoded string (\fBCN=example.com,O=Example Inc,C=US\fP,
mind that the rendered order is reversed from what is embedded), a list
of RDNs encoded as in RFC4514 (\fB[\(dqC=US\(dq, \(dqO=Example Inc\(dq, \(dqCN=example.com\(dq]\fP)
or a dictionary (\fB{\(dqCN\(dq: \(dqexample.com\(dq, \(dqC\(dq: \(dqUS\(dq, \(dqO\(dq: \(dqExample Inc\(dq}\fP,
default ordering).
Multiple name attributes per RDN are concatenated with a \fB+\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Parsing of RFC4514 strings requires at least cryptography release 37.
.UNINDENT
.UNINDENT
.TP
.B kwargs
Embedded X.509v3 extensions and the subject\(aqs distinguished name can be
controlled via supplemental keyword arguments. See the following for an overview.
.TP
.B Subject properties in kwargs
C, ST, L, STREET, O, OU, CN, MAIL, SN, GN, UID, SERIALNUMBER
.TP
.B X.509v3 extensions in kwargs
Most extensions can be configured using the same string format as OpenSSL,
while some require adjustments. In general, since the strings are
parsed to dicts/lists, you can always use the latter formats directly.
Marking an extension as critical is done by including it at the beginning
of the configuration string, in the list or as a key in the dictionary
with the value \fBtrue\fP\&.
.sp
Examples (some showcase dict/list correspondance):
.INDENT 7.0
.TP
.B basicConstraints
\fBcritical, CA:TRUE, pathlen:1\fP or
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- basicConstraints:
    critical: true
    ca: true
    pathlen: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B keyUsage
\fBcritical, cRLSign, keyCertSign\fP or
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- keyUsage:
    \- critical
    \- cRLSign
    \- keyCertSign
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B subjectKeyIdentifier
This can be an explicit value or \fBhash\fP, in which case the value
will be set to the SHA1 hash of some encoding of the associated public key,
depending on the underlying algorithm (RSA/ECDSA/EdDSA).
.TP
.B authorityKeyIdentifier
\fBkeyid:always, issuer\fP
.TP
.B subjectAltName
There is support for all OpenSSL\-defined types except \fBotherName\fP\&.
.sp
\fBemail:me@example.com,DNS:example.com\fP or
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# mind this being a list, not a dict
\- subjectAltName:
    \- email:me@example.com
    \- DNS:example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B issuerAltName
The syntax is the same as for \fBsubjectAltName\fP, except that the additional
value \fBissuer:copy\fP is supported, which will copy the values of
\fBsubjectAltName\fP in the issuer\(aqs certificate.
.TP
.B authorityInfoAccess
\fBOCSP;URI:http://ocsp.example.com/,caIssuers;URI:http://myca.example.com/ca.cer\fP
.TP
.B crlDistributionPoints
When set to a string value, items are interpreted as fullnames:
.sp
\fBURI:http://example.com/myca.crl, URI:http://example.org/my.crl\fP
.sp
There is also support for more attributes using the full form:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- crlDistributionPoints:
    \- fullname: URI:http://example.com/myca.crl
      crlissuer: DNS:example.org
      reasons:
        \- keyCompromise
    \- URI:http://example.org/my.crl
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B certificatePolicies
\fBcritical, 1.2.4.5, 1.1.3.4\fP
.sp
Again, there is support for more attributes using the full form:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- certificatePolicies:
    critical: true
    1.2.3.4.5: https://my.ca.com/pratice_statement
    1.2.4.5.6:
      \- https://my.ca.com/pratice_statement
      \- organization: myorg
        noticeNumbers: [1, 2, 3]
        text: mytext
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B policyConstraints
\fBrequireExplicitPolicy:3,inhibitPolicyMapping:1\fP
.TP
.B inhibitAnyPolicy
The value is just an integer: \fB\- inhibitAnyPolicy: 1\fP
.TP
.B nameConstraints
\fBcritical,permitted;IP:192.168.0.0/255.255.0.0,permitted;email:.example.com,excluded;email:.com\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- nameConstraints:
    critical: true
    permitted:
      \- IP:192.168.0.0/24
      \- email:.example.com
    excluded:
      \- email:.com
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B noCheck
This extension does not take any values, except \fBcritical\fP\&. Just the presence
in the keyword args will include it.
.TP
.B tlsfeature
\fBstatus_request\fP
.UNINDENT
.sp
For more information, visit the \fI\%OpenSSL docs\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.create_crl(signing_private_key, revoked, signing_cert=None, signing_private_key_passphrase=None, include_expired=False, days_valid=None, digest=\(aqsha256\(aq, encoding=\(aqpem\(aq, extensions=None, path=None, raw=False, **kwargs)
Create a certificate revocation list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.create_crl signing_cert=/etc/pki/ca.crt                 signing_private_key=/etc/pki/ca.key                 revoked=\(dq[{\(aqcertificate\(aq: \(aq/etc/pki/certs/www1.crt\(aq, \(aqrevocation_date\(aq: \(aq2015\-03\-01 00:00:00\(aq}]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B signing_private_key
Your certificate authority\(aqs private key. It will be used to sign
the CRL. Required.
.TP
.B revoked
A list of dicts containing all the certificates to revoke. Each dict
represents one certificate. A dict must contain either the key
\fBserial_number\fP with the value of the serial number to revoke, or
\fBcertificate\fP with some reference to the certificate to revoke.
.sp
The dict can optionally contain the \fBrevocation_date\fP key. If this
key is omitted, the revocation date will be set to now. It should be a
string in the format \(dq%Y\-%m\-%d %H:%M:%S\(dq.
.sp
The dict can also optionally contain the \fBnot_after\fP key. This is
redundant if the \fBcertificate\fP key is included, since it will be
sourced from the certificate. If the \fBcertificate\fP key is not included,
this can be used for the logic behind the \fBinclude_expired\fP parameter.
It should be a string in the format \(dq%Y\-%m\-%d %H:%M:%S\(dq.
.sp
The dict can also optionally contain the \fBextensions\fP key, which
allows to set CRL entry\-specific extensions. The following extensions
are supported:
.INDENT 7.0
.TP
.B certificateIssuer
Identifies the certificate issuer associated with an entry in an
indirect CRL. The format is the same as for subjectAltName.
.TP
.B CRLReason
Identifies the reason for certificate revocation.
Available choices are \fBunspecified\fP, \fBkeyCompromise\fP, \fBCACompromise\fP,
\fBaffiliationChanged\fP, \fBsuperseded\fP, \fBcessationOfOperation\fP,
\fBcertificateHold\fP, \fBprivilegeWithdrawn\fP, \fBaACompromise\fP and
\fBremoveFromCRL\fP\&.
.TP
.B invalidityDate
Provides the date on which the certificate likely became invalid.
The value should be a string in the same format as \fBrevocation_date\fP\&.
.UNINDENT
.TP
.B signing_cert
The CA certificate to be used for signing the CRL.
.TP
.B signing_private_key_passphrase
If \fBsigning_private_key\fP is encrypted, the passphrase to decrypt it.
.TP
.B include_expired
Also include already expired certificates in the CRL. Defaults to false.
.TP
.B days_valid
The number of days the CRL should be valid for. This sets the \fBNext Update\fP
field. Defaults to \fB100\fP (until v3009) or \fB7\fP (from v3009 onwards).
.TP
.B digest
The hashing algorithm to use for the signature. Valid values are:
sha1, sha224, sha256, sha384, sha512, sha512_224, sha512_256, sha3_224,
sha3_256, sha3_384, sha3_512. Defaults to \fBsha256\fP\&.
This will be ignored for \fBed25519\fP and \fBed448\fP key types.
.TP
.B encoding
Specify the encoding of the resulting certificate revocation list.
It can be returned as a \fBpem\fP string or base64\-encoded \fBder\fP\&.
Defaults to \fBpem\fP\&.
.TP
.B extensions
Add CRL extensions. The following are available:
.INDENT 7.0
.TP
.B authorityKeyIdentifier
See \fI\%x509.create_certificate\fP\&.
.TP
.B authorityInfoAccess
See \fI\%x509.create_certificate\fP\&.
.TP
.B cRLNumber
Specifies a sequential number for each CRL issued by a CA.
Values must be integers.
.TP
.B deltaCRLIndicator
If the CRL is a delta CRL, this value points to the cRLNumber
of the base cRL. Values must be integers.
.TP
.B freshestCRL
Identifies how delta CRL information is obtained. The format
is the same as \fBcrlDistributionPoints\fP\&.
.TP
.B issuerAltName
See \fI\%x509.create_certificate\fP\&.
.TP
.B issuingDistributionPoint
Identifies the CRL distribution point for a particular CRL and
indicates what kinds of revocation it covers. The format is
comparable to \fBcrlDistributionPoints\fP\&. Specify as follows:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
issuingDistributionPoint:
  fullname:  # or relativename with RDN
    \- URI:http://example.com/myca.crl
  onlysomereasons:
    \- keyCompromise
  onlyuser: true
  onlyCA: true
  onlyAA: true
  indirectCRL: false
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B path
Instead of returning the CRL, write it to this file path.
.TP
.B raw
Return the encoded raw bytes instead of a string. Defaults to false.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.create_csr(private_key, private_key_passphrase=None, digest=\(aqsha256\(aq, encoding=\(aqpem\(aq, path=None, raw=False, **kwargs)
Create a certificate signing request.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.create_csr private_key=\(aq/etc/pki/myca.key\(aq CN=\(aqMy Cert\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B private_key
The private key corresponding to the public key the certificate should
be issued for. The CSR will be signed by it. Required.
.TP
.B private_key_passphrase
If \fBprivate_key\fP is encrypted, the passphrase to decrypt it.
.TP
.B digest
The hashing algorithm to use for the signature. Valid values are:
sha1, sha224, sha256, sha384, sha512, sha512_224, sha512_256, sha3_224,
sha3_256, sha3_384, sha3_512. Defaults to \fBsha256\fP\&.
This will be ignored for \fBed25519\fP and \fBed448\fP key types.
.TP
.B encoding
Specify the encoding of the resulting certificate signing request.
It can be returned as a \fBpem\fP string or base64\-encoded \fBder\fP\&.
Defaults to \fBpem\fP\&.
.TP
.B path
Instead of returning the CSR, write it to this file path.
.TP
.B raw
Return the encoded raw bytes instead of a string. Defaults to false.
.TP
.B kwargs
Embedded X.509v3 extensions and the subject\(aqs distinguished name can be
controlled via supplemental keyword arguments.
See \fI\%x509.create_certificate\fP
for an overview. Mind that some extensions are not available for CSR
(\fBauthorityInfoAccess\fP, \fBauthorityKeyIdentifier\fP,
\fBissuerAltName\fP, \fBcrlDistributionPoints\fP).
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.create_private_key(algo=\(aqrsa\(aq, keysize=None, passphrase=None, encoding=\(aqpem\(aq, pkcs12_encryption_compat=False, path=None, raw=False, **kwargs)
Create a private key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.create_private_key algo=ec keysize=384
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B algo
The digital signature scheme the private key should be based on.
Available: \fBrsa\fP, \fBec\fP, \fBed25519\fP, \fBed448\fP\&. Defaults to \fBrsa\fP\&.
.TP
.B keysize
For \fBrsa\fP, specifies the bitlength of the private key (2048, 3072, 4096).
For \fBec\fP, specifies the NIST curve to use (256, 384, 521).
Irrelevant for Edwards\-curve schemes (\fBed25519\fP, \fBed448\fP).
Defaults to 2048 for RSA and 256 for EC.
.TP
.B passphrase
If this is specified, the private key will be encrypted using this
passphrase. The encryption algorithm cannot be selected, it will be
determined automatically as the best available one.
.TP
.B encoding
Specify the encoding of the resulting private key. It can be returned
as a \fBpem\fP string, base64\-encoded \fBder\fP or base64\-encoded \fBpkcs12\fP\&.
Defaults to \fBpem\fP\&.
.TP
.B pkcs12_encryption_compat
Some operating systems are incompatible with the encryption defaults
for PKCS12 used since OpenSSL v3. This switch triggers a fallback to
\fBPBESv1SHA1And3KeyTripleDESCBC\fP\&.
Please consider the \fI\%notes on PKCS12 encryption\fP\&.
.TP
.B path
Instead of returning the private key, write it to this file path.
Note that this does not use safe permissions and should be avoided.
.TP
.B raw
Return the encoded raw bytes instead of a string. Defaults to false.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.encode_certificate(certificate, encoding=\(aqpem\(aq, append_certs=None, private_key=None, private_key_passphrase=None, pkcs12_passphrase=None, pkcs12_encryption_compat=False, pkcs12_friendlyname=None, raw=False)
Create an encoded representation of a certificate, optionally including
other structures. This can be used to create certificate chains, convert
a certificate into a different encoding or embed the corresponding
private key (for \fBpkcs12\fP).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.encode_certificate /etc/pki/my.crt pem /etc/pki/ca.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B certificate
The certificate to encode.
.TP
.B encoding
Specify the encoding of the resulting certificate. It can be returned
as a \fBpem\fP (or \fBpkcs7_pem\fP) string or several (base64\-encoded)
binary formats (\fBder\fP, \fBpkcs7_der\fP, \fBpkcs12\fP). Defaults to \fBpem\fP\&.
.TP
.B append_certs
A list of additional certificates to encode with the new one, e.g. to create a CA chain.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Mind that when \fBder\fP encoding is in use, appending certificatees is prohibited.
.UNINDENT
.UNINDENT
.TP
.B private_key
For \fBpkcs12\fP, the private key corresponding to the public key of the \fBcertificate\fP
to be embedded.
.TP
.B private_key_passphrase
For \fBpkcs12\fP, if the private key to embed is encrypted, specify the corresponding
passphrase.
.TP
.B pkcs12_passphrase
For \fBpkcs12\fP, the container can be encrypted. Specify the passphrase to use here.
Mind that PKCS12 encryption should not be relied on for security purposes, see
note above in \fI\%x509.create_certificate\fP\&.
.TP
.B pkcs12_encryption_compat
OpenSSL 3 and cryptography v37 switched to a much more secure default
encryption for PKCS12, which might be incompatible with some systems.
This forces the legacy encryption. Defaults to False.
.TP
.B pkcs12_friendlyname
When encoding a certificate as \fBpkcs12\fP, a name for the certificate can be included.
.TP
.B raw
Return the encoded raw bytes instead of a string. Defaults to false.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.encode_crl(crl, encoding=\(aqpem\(aq, raw=False)
Create an encoded representation of a certificate revocation list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.encode_crl /etc/pki/my.crl der
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B crl
The certificate revocation list to encode.
.TP
.B encoding
Specify the encoding of the resulting certificate revocation list.
It can be returned as a \fBpem\fP string or base64\-encoded \fBder\fP\&.
Defaults to \fBpem\fP\&.
.TP
.B raw
Return the encoded raw bytes instead of a string. Defaults to false.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.encode_csr(csr, encoding=\(aqpem\(aq, raw=False)
Create an encoded representation of a certificate signing request.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.encode_csr /etc/pki/my.csr der
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B csr
The certificate signing request to encode.
.TP
.B encoding
Specify the encoding of the resulting certificate signing request.
It can be returned as a \fBpem\fP string or base64\-encoded \fBder\fP\&.
Defaults to \fBpem\fP\&.
.TP
.B raw
Return the encoded raw bytes instead of a string. Defaults to false.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.encode_private_key(private_key, encoding=\(aqpem\(aq, passphrase=None, private_key_passphrase=None, pkcs12_encryption_compat=False, raw=False)
Create an encoded representation of a private key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.encode_private_key /etc/pki/my.key der
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B private_key
The private key to encode.
.TP
.B encoding
Specify the encoding of the resulting private key. It can be returned
as a \fBpem\fP string, base64\-encoded \fBder\fP and base64\-encoded \fBpkcs12\fP\&.
Defaults to \fBpem\fP\&.
.TP
.B passphrase
If this is specified, the private key will be encrypted using this
passphrase. The encryption algorithm cannot be selected, it will be
determined automatically as the best available one.
.TP
.B private_key_passphrase
New in version 3006.2.

.sp
If the current \fBprivate_key\fP is encrypted, the passphrase to
decrypt it.
.TP
.B pkcs12_encryption_compat
Some operating systems are incompatible with the encryption defaults
for PKCS12 used since OpenSSL v3. This switch triggers a fallback to
\fBPBESv1SHA1And3KeyTripleDESCBC\fP\&.
Please consider the \fI\%notes on PKCS12 encryption\fP\&.
.TP
.B raw
Return the encoded raw bytes instead of a string. Defaults to false.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.expired(certificate)
Returns a dict containing limited details of a
certificate and whether the certificate has expired.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.expired /etc/pki/mycert.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B certificate
The certificate to check.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.expires(certificate, days=0)
Determine whether a certificate will expire or has expired already.
Returns a boolean only.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.expires /etc/pki/my.crt days=7
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B certificate
The certificate to check.
.TP
.B days
If specified, determine expiration x days in the future.
Defaults to \fB0\fP, which checks for the current time.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.get_pem_entries(glob_path)
Returns a dict containing PEM entries in files matching a glob.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.get_pem_entries \(dq/etc/pki/*.crt\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B glob_path
A path representing certificates to be read and returned.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.get_pem_entry(text, pem_type=None)
Returns a properly formatted PEM string from the input text,
fixing any whitespace or line\-break issues.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.get_pem_entry \(dq\-\-\-\-\-BEGIN CERTIFICATE REQUEST\-\-\-\-\-MIICyzCC Ar8CAQI...\-\-\-\-\-END CERTIFICATE REQUEST\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B text
Text containing the X509 PEM entry to be returned or path to
a file containing the text.
.TP
.B pem_type
If specified, this function will only return a pem of a certain type,
for example \(aqCERTIFICATE\(aq or \(aqCERTIFICATE REQUEST\(aq.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.get_private_key_size(private_key, passphrase=None)
Return information about the keysize of a private key (RSA/EC).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.get_private_key_size /etc/pki/my.key
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B private_key
The private key to check.
.TP
.B passphrase
If \fBprivate_key\fP is encrypted, the passphrase to decrypt it.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.get_public_key(key, passphrase=None, asObj=None)
Returns a PEM\-encoded public key derived from some reference.
The reference should be a public key, certificate, private key or CSR.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.get_public_key /etc/pki/my.key
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B key
A reference to the structure to look the public key up for.
.TP
.B passphrase
If \fBkey\fP is encrypted, the passphrase to decrypt it.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.get_signing_policy(signing_policy, ca_server=None)
Returns the specified named signing policy.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.get_signing_policy www
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B signing_policy
The name of the signing policy to return.
.TP
.B ca_server
If this is set, the CA server will be queried for the
signing policy instead of looking it up locally.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.read_certificate(certificate)
Returns a dict containing details of a certificate.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.read_certificate /etc/pki/mycert.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B certificate
The certificate to read.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.read_certificates(glob_path)
Returns a dict containing details of all certificates matching a glob.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.read_certificates \(dq/etc/pki/*.crt\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B glob_path
A path to certificates to be read and returned.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.read_crl(crl)
Returns a dict containing details of a certificate revocation list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.read_crl /etc/pki/my.crl
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B crl
The certificate revocation list to read.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.read_csr(csr)
Returns a dict containing details of a certificate signing request.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.read_csr /etc/pki/mycert.csr
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B csr
The certificate signing request to read.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.sign_remote_certificate(signing_policy, kwargs, get_signing_policy_only=False, **more_kwargs)
Request a certificate to be remotely signed according to a signing policy.
This is mostly for internal use and does not make much sense on the CLI.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.sign_remote_certificate www kwargs=\(dq{\(aqpublic_key\(aq: \(aq/etc/pki/www.key\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B signing_policy
The name of the signing policy to use. Required.
.TP
.B kwargs
A dict containing all the arguments to be passed into the
\fI\%x509.create_certificate\fP function.
.TP
.B get_signing_policy_only
Only return the named signing policy. Defaults to false.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.verify_crl(crl, cert)
Verify that a signature on a certificate revocation list was made
by the private key corresponding to the public key associated
with the specified certificate.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.verify_crl /etc/pki/my.crl /etc/pki/my.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B crl
The certificate revocation list to check the signature on.
.TP
.B cert
The certificate (or any reference that can be passed
to \fBget_public_key\fP) to retrieve the public key from.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.verify_private_key(private_key, public_key, passphrase=None)
Verify that a private key belongs to the specified public key.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.verify_private_key /etc/pki/my.key /etc/pki/my.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B private_key
The private key to check.
.TP
.B public_key
The certificate (or any reference that can be passed
to \fBget_public_key\fP) to retrieve the public key from.
.TP
.B passphrase
If \fBprivate_key\fP is encrypted, the passphrase to decrypt it.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.verify_signature(certificate, signing_pub_key=None, signing_pub_key_passphrase=None)
Verify that a signature on a certificate was made
by the private key corresponding to the public key associated
with the specified certificate.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.verify_signature /etc/pki/my.key /etc/pki/my.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B certificate
The certificate to check the signature on.
.TP
.B signing_pub_key
Any reference that can be passed to \fBget_public_key\fP to retrieve
the public key of the signing entity from. If unspecified, will
take the public key of \fBcertificate\fP, i.e. verify a self\-signed
certificate.
.UNINDENT
.sp
signing_pub_key_passphrase
.INDENT 7.0
.INDENT 3.5
If \fBsigning_pub_key\fP is encrypted, the passphrase to decrypt it.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.will_expire(certificate, days)
Returns a dict containing details of a certificate and whether
the certificate will expire in the specified number of days.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.will_expire \(dq/etc/pki/mycert.crt\(dq days=30
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B certificate
The certificate to check.
.TP
.B days
The number of days in the future to check the validity for.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.x509_v2.write_pem(text, path, overwrite=True, pem_type=None)
Writes out a PEM string, fixing any formatting or whitespace
issues before writing.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq x509.write_pem \(dq\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-MIIGMzCCBBugA...\(dq path=/etc/pki/mycert.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B text
PEM string input to be written out.
.TP
.B path
Path of the file to write the PEM out to.
.TP
.B overwrite
If \fBTrue\fP (default), write_pem will overwrite the entire PEM file.
Set to \fBFalse\fP to preserve existing private keys and DH params that may
exist in the PEM file.
.TP
.B pem_type
The PEM type to be saved, for example \fBCERTIFICATE\fP or
\fBPUBLIC KEY\fP\&. Adding this will allow the function to take
input that may contain multiple PEM types.
.UNINDENT
.UNINDENT
.SS salt.modules.xapi_virt
.sp
This module (mostly) uses the XenAPI to manage Xen virtual machines.
.sp
Big fat warning: the XenAPI used in this file is the one bundled with
Xen Source, NOT XenServer nor Xen Cloud Platform. As a matter of fact it
\fIwill\fP fail under those platforms. From what I\(aqve read, little work is needed
to adapt this code to XS/XCP, mostly playing with XenAPI version, but as
XCP is not taking precedence on Xen Source on many platforms, please keep
compatibility in mind.
.sp
Useful documentation:
.sp
\&. \fI\%http://downloads.xen.org/Wiki/XenAPI/xenapi\-1.0.6.pdf\fP
\&. \fI\%http://docs.vmd.citrix.com/XenServer/6.0.0/1.0/en_gb/api/\fP
\&. \fI\%https://github.com/xapi\-project/xen\-api/tree/master/scripts/examples/python\fP
\&. \fI\%http://xenbits.xen.org/gitweb/?p=xen.git;a=tree;f=tools/python/xen/xm;hb=HEAD\fP
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.freecpu()
Return an int representing the number of unallocated cpus on this
hypervisor
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.freecpu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.freemem()
Return an int representing the amount of memory that has not been given
to virtual machines on this node
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.freemem
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.full_info()
Return the node_info, vm_info and freemem
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.full_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.get_disks(vm_)
Return the disks of a named vm
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.get_disks <vm name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.get_macs(vm_)
Return a list off MAC addresses from the named vm
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.get_macs <vm name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.get_nics(vm_)
Return info about the network interfaces of a named vm
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.get_nics <vm name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.is_hyper()
Returns a bool whether or not this node is a hypervisor of any kind
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.is_hyper
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.list_domains()
Return a list of virtual machine names on the minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.list_domains
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.migrate(vm_, target, live=1, port=0, node=\-1, ssl=None, change_home_server=0)
Migrates the virtual machine to another hypervisor
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.migrate <vm name> <target hypervisor> [live] [port] [node] [ssl] [change_home_server]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Optional values:
.INDENT 7.0
.TP
.B live
Use live migration
.TP
.B port
Use a specified port
.TP
.B node
Use specified NUMA node on target
.TP
.B ssl
use ssl connection for migration
.TP
.B change_home_server
change home server for managed domains
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.node_info()
Return a dict with information about this node
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.node_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.pause(vm_)
Pause the named vm
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.pause <vm name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.reboot(vm_)
Reboot a domain via ACPI request
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.reboot <vm name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.reset(vm_)
Reset a VM by emulating the reset button on a physical machine
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.reset <vm name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.resume(vm_)
Resume the named vm
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.resume <vm name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.setmem(vm_, memory)
Changes the amount of memory allocated to VM.
.sp
Memory is to be specified in MB
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.setmem myvm 768
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.setvcpus(vm_, vcpus)
Changes the amount of vcpus allocated to VM.
.sp
vcpus is an int representing the number to be assigned
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.setvcpus myvm 2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.shutdown(vm_)
Send a soft shutdown signal to the named vm
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.shutdown <vm name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.start(config_)
Start a defined domain
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.start <path to Xen cfg file>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.stop(vm_)
Hard power down the virtual machine, this is equivalent to pulling the
power
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.stop <vm name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.vcpu_pin(vm_, vcpu, cpus)
Set which CPUs a VCPU can use.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqfoo\(aq virt.vcpu_pin domU\-id 2 1
salt \(aqfoo\(aq virt.vcpu_pin domU\-id 2 2\-6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.vm_cputime(vm_=None)
Return cputime used by the vms on this hyper in a
list of dicts:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
    \(aqyour\-vm\(aq: {
        \(aqcputime\(aq <int>
        \(aqcputime_percent\(aq <int>
        },
    ...
    ]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.vm_cputime
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.vm_diskstats(vm_=None)
Return disk usage counters used by the vms on this hyper in a
list of dicts:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
    \(aqyour\-vm\(aq: {
        \(aqio_read_kbs\(aq   : 0,
        \(aqio_write_kbs\(aq  : 0
        },
    ...
    ]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.vm_diskstats
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.vm_info(vm_=None)
Return detailed information about the vms.
.sp
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.vm_info
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.vm_netstats(vm_=None)
Return combined network counters used by the vms on this hyper in a
list of dicts:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
    \(aqyour\-vm\(aq: {
        \(aqio_read_kbs\(aq           : 0,
        \(aqio_total_read_kbs\(aq     : 0,
        \(aqio_total_write_kbs\(aq    : 0,
        \(aqio_write_kbs\(aq          : 0
        },
    ...
    ]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.vm_netstats
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xapi_virt.vm_state(vm_=None)
Return list of all the vms and their state.
.sp
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq virt.vm_state <vm name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.xbpspkg
.sp
Package support for XBPS package manager (used by VoidLinux)
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.modules.xbpspkg.add_repo(repo, conffile=\(aq/usr/share/xbps.d/15\-saltstack.conf\(aq)
Add an XBPS repository to the system.
.INDENT 7.0
.TP
.B repo
url of repo to add (persistent).
.TP
.B conffile
path to xbps conf file to add this repo
default: /usr/share/xbps.d/15\-saltstack.conf
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.add_repo <repo url> [conffile=/path/to/xbps/repo.conf]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xbpspkg.available_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xbpspkg.del_repo(repo, **kwargs)
Remove an XBPS repository from the system.
.INDENT 7.0
.TP
.B repo
url of repo to remove (persistent).
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.del_repo <repo url>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xbpspkg.get_repo(repo, **kwargs)
Display information about the repo.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.get_repo \(aqrepo\-url\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xbpspkg.install(name=None, refresh=False, fromrepo=None, pkgs=None, sources=None, **kwargs)
Install the passed package
.INDENT 7.0
.TP
.B name
The name of the package to be installed.
.TP
.B refresh
Whether or not to refresh the package database before installing.
.TP
.B fromrepo
Specify a package repository (url) to install from.
.UNINDENT
.sp
Multiple Package Installation Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to install from a software repository. Must be
passed as a python list.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq,\(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B sources
A list of packages to install. Must be passed as a list of dicts,
with the keys being package names, and the values being the source URI
or local path to the package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install sources=\(aq[{\(dqfoo\(dq: \(dqsalt://foo.deb\(dq},{\(dqbar\(dq: \(dqsalt://bar.deb\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Return a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xbpspkg.latest_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xbpspkg.list_pkgs(versions_as_list=False, **kwargs)
List the packages currently installed as a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xbpspkg.list_repos(**kwargs)
List all repos known by XBPS
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_repos
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xbpspkg.list_upgrades(refresh=True, **kwargs)
Check whether or not an upgrade is available for all packages
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xbpspkg.refresh_db(**kwargs)
Update list of available packages from installed repos
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xbpspkg.remove(name=None, pkgs=None, recursive=True, **kwargs)
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.TP
.B recursive
Also remove dependent packages (not required elsewhere).
Default mode: enabled.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
Returns a list containing the removed packages.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name> [recursive=False]
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3> [recursive=False]
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq [recursive=False]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xbpspkg.upgrade(refresh=True, **kwargs)
Run a full system upgrade
.INDENT 7.0
.TP
.B refresh
Whether or not to refresh the package database before installing.
Default is \fITrue\fP\&.
.UNINDENT
.sp
Returns a dictionary containing the changes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq:  {\(aqold\(aq: \(aq<old\-version>\(aq,
                \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xbpspkg.upgrade_available(name, **kwargs)
Check whether or not an upgrade is available for a given package
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade_available <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xbpspkg.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.xfs
.sp
Module for managing XFS file systems.
.INDENT 0.0
.TP
.B salt.modules.xfs.defragment(device)
Defragment mounted XFS filesystem.
In order to mount a filesystem, device should be properly mounted and writable.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xfs.defragment /dev/sda1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xfs.devices()
Get known XFS formatted devices on the system.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xfs.devices
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xfs.dump(device, destination, level=0, label=None, noerase=None)
Dump filesystem device to the media (file, tape etc).
.sp
Required parameters:
.INDENT 7.0
.IP \(bu 2
\fBdevice\fP: XFS device, content of which to be dumped.
.IP \(bu 2
\fBdestination\fP: Specifies a dump destination.
.UNINDENT
.sp
Valid options are:
.INDENT 7.0
.IP \(bu 2
\fBlabel\fP: Label of the dump. Otherwise automatically generated label is used.
.IP \(bu 2
\fBlevel\fP: Specifies a dump level of 0 to 9.
.IP \(bu 2
\fBnoerase\fP: Pre\-erase media.
.UNINDENT
.sp
Other options are not used in order to let \fBxfsdump\fP use its default
values, as they are most optimal. See the \fBxfsdump(8)\fP manpage for
a more complete description of these options.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xfs.dump /dev/sda1 /detination/on/the/client
salt \(aq*\(aq xfs.dump /dev/sda1 /detination/on/the/client label=\(aqCompany accountancy\(aq
salt \(aq*\(aq xfs.dump /dev/sda1 /detination/on/the/client noerase=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xfs.estimate(path)
Estimate the space that an XFS filesystem will take.
For each directory estimate the space that directory would take
if it were copied to an XFS filesystem.
Estimation does not cross mount points.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xfs.estimate /path/to/file
salt \(aq*\(aq xfs.estimate /path/to/dir/*
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xfs.info(device)
Get filesystem geometry information.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xfs.info /dev/sda1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xfs.inventory()
Display XFS dump inventory without restoration.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xfs.inventory
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xfs.mkfs(device, label=None, ssize=None, noforce=None, bso=None, gmo=None, ino=None, lso=None, rso=None, nmo=None, dso=None)
Create a file system on the specified device. By default wipes out with force.
.sp
General options:
.INDENT 7.0
.IP \(bu 2
\fBlabel\fP: Specify volume label.
.IP \(bu 2
\fBssize\fP: Specify the fundamental sector size of the filesystem.
.IP \(bu 2
\fBnoforce\fP: Do not force create filesystem, if disk is already formatted.
.UNINDENT
.sp
Filesystem geometry options:
.INDENT 7.0
.IP \(bu 2
\fBbso\fP: Block size options.
.IP \(bu 2
\fBgmo\fP: Global metadata options.
.IP \(bu 2
.INDENT 2.0
.TP
\fBdso\fP: Data section options. These options specify the location, size,
and other parameters of the data section of the filesystem.
.UNINDENT
.IP \(bu 2
\fBino\fP: Inode options to specify the inode size of the filesystem, and other inode allocation parameters.
.IP \(bu 2
\fBlso\fP: Log section options.
.IP \(bu 2
\fBnmo\fP: Naming options.
.IP \(bu 2
\fBrso\fP: Realtime section options.
.UNINDENT
.sp
See the \fBmkfs.xfs(8)\fP manpage for a more complete description of corresponding options description.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xfs.mkfs /dev/sda1
salt \(aq*\(aq xfs.mkfs /dev/sda1 dso=\(aqsu=32k,sw=6\(aq noforce=True
salt \(aq*\(aq xfs.mkfs /dev/sda1 dso=\(aqsu=32k,sw=6\(aq lso=\(aqlogdev=/dev/sda2,size=10000b\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xfs.modify(device, label=None, lazy_counting=None, uuid=None)
Modify parameters of an XFS filesystem.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xfs.modify /dev/sda1 label=\(aqMy backup\(aq lazy_counting=False
salt \(aq*\(aq xfs.modify /dev/sda1 uuid=False
salt \(aq*\(aq xfs.modify /dev/sda1 uuid=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xfs.prune_dump(sessionid)
Prunes the dump session identified by the given session id.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xfs.prune_dump b74a3586\-e52e\-4a4a\-8775\-c3334fa8ea2c
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.xml
.sp
XML file manager
.sp
New in version 3000.

.INDENT 0.0
.TP
.B salt.modules.xml.get_attribute(file, element)
Return the attributes of the matched xpath element.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xml.get_attribute /tmp/test.xml \(dq.//element[@id=\(aq3\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xml.get_value(file, element)
Returns the value of the matched xpath element
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xml.get_value /tmp/test.xml \(dq.//element\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xml.set_attribute(file, element, key, value)
Set the requested attribute key and value for matched xpath element.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xml.set_attribute /tmp/test.xml \(dq.//element[@id=\(aq3\(aq]\(dq editedby \(dqgal\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xml.set_value(file, element, value)
Sets the value of the matched xpath element
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq xml.set_value /tmp/test.xml \(dq.//element\(dq \(dqnew value\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.xmpp
.sp
Module for Sending Messages via XMPP (a.k.a. Jabber)
.sp
New in version 2014.1.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
sleekxmpp>=1.3.1
.IP \(bu 2
pyasn1
.IP \(bu 2
pyasn1\-modules
.IP \(bu 2
dnspython
.UNINDENT
.TP
.B configuration
This module can be used by either passing a jid and password
directly to send_message, or by specifying the name of a configuration
profile in the minion config, minion pillar, or master config.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my\-xmpp\-login:
    xmpp.jid: myuser@jabber.example.org/resourcename
    xmpp.password: verybadpass
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The resourcename refers to the resource that is using this account. It is
user\-definable, and optional. The following configurations are both valid:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my\-xmpp\-login:
    xmpp.jid: myuser@jabber.example.org/salt
    xmpp.password: verybadpass

my\-xmpp\-login:
    xmpp.jid: myuser@jabber.example.org
    xmpp.password: verybadpass
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.xmpp.SendMsgBot(jid, password, recipient, msg)
.INDENT 7.0
.TP
.B classmethod  create_multi(jid, password, msg, recipients=None, rooms=None, nick=\(aqSaltStack Bot\(aq)
Alternate constructor that accept multiple recipients and rooms
.UNINDENT
.INDENT 7.0
.TP
.B start(event)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.xmpp.SleekXMPPMUC(name=\(aq\(aq)
.INDENT 7.0
.TP
.B filter(record)
Determine if the specified record is to be logged.
.sp
Returns True if the record should be logged, or False otherwise.
If deemed appropriate, the record may be modified in\-place.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xmpp.send_msg(recipient, message, jid=None, password=None, profile=None)
Send a message to an XMPP recipient. Designed for use in states.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
xmpp.send_msg \(aqadmins@xmpp.example.com\(aq \(aqThis is a salt module test\(aq             profile=\(aqmy\-xmpp\-account\(aq
xmpp.send_msg \(aqadmins@xmpp.example.com\(aq \(aqThis is a salt module test\(aq             jid=\(aqmyuser@xmpp.example.com/salt\(aq password=\(aqverybadpass\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.xmpp.send_msg_multi(message, recipients=None, rooms=None, jid=None, password=None, nick=\(aqSaltStack Bot\(aq, profile=None)
Send a message to an XMPP recipient, support send message to
multiple recipients or chat room.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
xmpp.send_msg recipients=[\(aqadmins@xmpp.example.com\(aq]             rooms=[\(aqsecret@conference.xmpp.example.com\(aq]             \(aqThis is a salt module test\(aq             profile=\(aqmy\-xmpp\-account\(aq
xmpp.send_msg recipients=[\(aqadmins@xmpp.example.com\(aq]             rooms=[\(aqsecret@conference.xmpp.example.com\(aq]            \(aqThis is a salt module test\(aq             jid=\(aqmyuser@xmpp.example.com/salt\(aq password=\(aqverybadpass\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.yaml
.sp
Yaml helper module for troubleshooting yaml
.sp
New in version 3005.

.INDENT 0.0
.TP
.B depends
yamllint >= 1.20.0
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yaml.lint(source, saltenv=None, pre_render=None, **kwargs)
lint the output after detecting a sucsessful render.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- managed source file
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- the saltenv to use, defaults
to minions enviroment or base if not set
.IP \(bu 2
\fBpre_render\fP (\fI\%str\fP) \-\- The render options passed to
slsutil.renderer other wise file is cached and loaded as stream
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq yaml.lint salt://example/bad_yaml.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.yumpkg
.sp
Support for YUM/DNF
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage packages on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
DNF is fully supported as of version 2015.5.10 and 2015.8.4 (partial
support for DNF was initially added in 2015.8.0), and DNF is used
automatically in place of YUM in Fedora 22 and newer.
.UNINDENT
.UNINDENT
.sp
New in version 3003: Support for \fBtdnf\fP on Photon OS.

.sp
New in version 3007.0: Support for \fBdnf5\(ga\fP on Fedora 39

.INDENT 0.0
.TP
.B class  salt.modules.yumpkg.AvailablePackages(*args, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.available_version(*names, **kwargs)
This function is an alias of \fBlatest_version\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
A specific repo can be requested using the \fBfromrepo\fP keyword argument,
and the \fBdisableexcludes\fP option is also supported.
.sp
New in version 2014.7.0: Support for the \fBdisableexcludes\fP option

.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package name> fromrepo=epel\-testing
salt \(aq*\(aq pkg.latest_version <package name> disableexcludes=main
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.clean_metadata(**kwargs)
New in version 2014.1.0.

.sp
Cleans local yum metadata. Functionally identical to \fI\%refresh_db()\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.clean_metadata
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.del_repo(repo, basedir=None, **kwargs)
Delete a repo from <basedir> (default basedir: all dirs in \fIreposdir\fP yum
option).
.sp
If the .repo file in which the repo exists does not contain any other repo
configuration, the file itself will be deleted.
.sp
Strict parsing of configuration files is the default, this can be disabled
using the  \fBstrict_config\fP keyword argument set to False
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.del_repo myrepo
salt \(aq*\(aq pkg.del_repo myrepo basedir=/path/to/dir strict_config=False
salt \(aq*\(aq pkg.del_repo myrepo basedir=/path/to/dir,/path/to/another/dir
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.diff(*paths, **kwargs)
Return a formatted diff between current files and original in a package.
NOTE: this function includes all files (configuration and not), but does
not work on binary content.
.INDENT 7.0
.TP
.B Parameters
\fBpath\fP \-\- Full path to the installed file
.TP
.B Returns
Difference string or raises and exception if examined file is binary.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.diff /etc/apache2/httpd.conf /etc/sudoers
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.download(*packages, **kwargs)
New in version 2015.5.0.

.sp
Download packages to the local disk. Requires \fByumdownloader\fP from
\fByum\-utils\fP package.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fByum\-utils\fP will already be installed on the minion if the package
was installed from the Fedora / EPEL repositories.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.download httpd
salt \(aq*\(aq pkg.download httpd postfix
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.file_dict(*packages, **kwargs)
New in version 2014.1.0.

.sp
List the files that belong to a package, grouped by package. Not
specifying any packages will return a list of \fIevery\fP file on the system\(aqs
rpm database (not generally recommended).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_list httpd
salt \(aq*\(aq pkg.file_list httpd postfix
salt \(aq*\(aq pkg.file_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.file_list(*packages, **kwargs)
New in version 2014.1.0.

.sp
List the files that belong to a package. Not specifying any packages will
return a list of \fIevery\fP file on the system\(aqs rpm database (not generally
recommended).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_list httpd
salt \(aq*\(aq pkg.file_list httpd postfix
salt \(aq*\(aq pkg.file_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.get_locked_packages(pattern=\(aq[\e\ew+]+(?:[.\-][^\-]+)*\(aq, full=True)
This function is an alias of \fBlist_holds\fP\&.
.INDENT 7.0
.INDENT 3.5
Changed in version 2015.5.10,2015.8.4,2016.3.0: Function renamed from \fBpkg.get_locked_pkgs\fP to \fBpkg.list_holds\fP\&.

.sp
List information on locked packages
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Requires the appropriate \fBversionlock\fP plugin package to be installed:
.INDENT 0.0
.IP \(bu 2
On RHEL 5: \fByum\-versionlock\fP
.IP \(bu 2
On RHEL 6 & 7: \fByum\-plugin\-versionlock\fP
.IP \(bu 2
On Fedora: \fBpython\-dnf\-plugins\-extras\-versionlock\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B pattern
w+(?:[.\-][^\-]+)*
Regular expression used to match the package name
.TP
.B full
True
Show the full hold definition including version and epoch. Set to
\fBFalse\fP to return just the name of the package(s) being held.
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_holds
salt \(aq*\(aq pkg.list_holds full=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.get_repo(repo, basedir=None, **kwargs)
Display a repo from <basedir> (default basedir: all dirs in \fBreposdir\fP
yum option).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.get_repo myrepo
salt \(aq*\(aq pkg.get_repo myrepo basedir=/path/to/dir
salt \(aq*\(aq pkg.get_repo myrepo basedir=/path/to/dir,/path/to/another/dir
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.group_diff(name, **kwargs)
New in version 2014.1.0.

.sp
Changed in version 2015.5.10,2015.8.4,2016.3.0: Environment groups are now supported. The key names have been renamed,
similar to the changes made in \fI\%pkg.group_info\fP\&.

.sp
Changed in version 3006.2: Support for \fBfromrepo\fP, \fBenablerepo\fP, and \fBdisablerepo\fP (as used
in \fI\%pkg.install\fP) has been
added.

.sp
Lists which of a group\(aqs packages are installed and which are not
installed
.INDENT 7.0
.TP
.B name
The name of the group to check
.TP
.B fromrepo
Restrict \fByum groupinfo\fP to the specified repo(s).
(e.g., \fByum \-\-disablerepo=\(aq*\(aq \-\-enablerepo=\(aqsomerepo\(aq\fP)
.sp
New in version 3006.2.

.TP
.B enablerepo (ignored if \fBfromrepo\fP is specified)
Specify a disabled package repository (or repositories) to enable.
(e.g., \fByum \-\-enablerepo=\(aqsomerepo\(aq\fP)
.sp
New in version 3006.2.

.TP
.B disablerepo (ignored if \fBfromrepo\fP is specified)
Specify an enabled package repository (or repositories) to disable.
(e.g., \fByum \-\-disablerepo=\(aqsomerepo\(aq\fP)
.sp
New in version 3006.2.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.group_diff \(aqPerl Support\(aq
salt \(aq*\(aq pkg.group_diff \(aqPerl Support\(aq fromrepo=base,updates
salt \(aq*\(aq pkg.group_diff \(aqPerl Support\(aq enablerepo=somerepo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.group_info(name, expand=False, ignore_groups=None, **kwargs)
New in version 2014.1.0.

.sp
Changed in version 2015.5.10,2015.8.4,2016.3.0,3001: The return data has changed. A new key \fBtype\fP has been added to
distinguish environment groups from package groups. Also, keys for the
group name and group ID have been added. The \fBmandatory packages\fP,
\fBoptional packages\fP, and \fBdefault packages\fP keys have been renamed
to \fBmandatory\fP, \fBoptional\fP, and \fBdefault\fP for accuracy, as
environment groups include other groups, and not packages. Finally,
this function now properly identifies conditional packages.

.sp
Changed in version 3006.2: Support for \fBfromrepo\fP, \fBenablerepo\fP, and \fBdisablerepo\fP (as used
in \fI\%pkg.install\fP) has been
added.

.sp
Lists packages belonging to a certain group
.INDENT 7.0
.TP
.B name
Name of the group to query
.TP
.B expand
False
If the specified group is an environment group, then the group will be
expanded and the return data will include package names instead of
group names.
.sp
New in version 2016.3.0.

.TP
.B ignore_groups
None
This parameter can be used to pass a list of groups to ignore when
expanding subgroups. It is used during recursion in order to prevent
expanding the same group multiple times.
.sp
New in version 3001.

.TP
.B fromrepo
Restrict \fByum groupinfo\fP to the specified repo(s).
(e.g., \fByum \-\-disablerepo=\(aq*\(aq \-\-enablerepo=\(aqsomerepo\(aq\fP)
.sp
New in version 3006.2.

.TP
.B enablerepo (ignored if \fBfromrepo\fP is specified)
Specify a disabled package repository (or repositories) to enable.
(e.g., \fByum \-\-enablerepo=\(aqsomerepo\(aq\fP)
.sp
New in version 3006.2.

.TP
.B disablerepo (ignored if \fBfromrepo\fP is specified)
Specify an enabled package repository (or repositories) to disable.
(e.g., \fByum \-\-disablerepo=\(aqsomerepo\(aq\fP)
.sp
New in version 3006.2.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.group_info \(aqPerl Support\(aq
salt \(aq*\(aq pkg.group_info \(aqPerl Support\(aq fromrepo=base,updates
salt \(aq*\(aq pkg.group_info \(aqPerl Support\(aq enablerepo=somerepo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.group_install(name, skip=(), include=(), **kwargs)
New in version 2014.1.0.

.sp
Install the passed package group(s). This is basically a wrapper around
\fI\%pkg.install\fP, which performs
package group resolution for the user. This function is currently
considered experimental, and should be expected to undergo changes.
.INDENT 7.0
.TP
.B name
Package group to install. To install more than one group, either use a
comma\-separated list or pass the value as a python list.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.group_install \(aqGroup 1\(aq
salt \(aq*\(aq pkg.group_install \(aqGroup 1,Group 2\(aq
salt \(aq*\(aq pkg.group_install \(aq[\(dqGroup 1\(dq, \(dqGroup 2\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B skip
Packages that would normally be installed by the package group
(\(dqdefault\(dq packages), which should not be installed. Can be passed
either as a comma\-separated list or a python list.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.group_install \(aqMy Group\(aq skip=\(aqfoo,bar\(aq
salt \(aq*\(aq pkg.group_install \(aqMy Group\(aq skip=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B include
Packages which are included in a group, which would not normally be
installed by a \fByum groupinstall\fP (\(dqoptional\(dq packages). Note that
this will not enforce group membership; if you include packages which
are not members of the specified groups, they will still be installed.
Can be passed either as a comma\-separated list or a python list.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.group_install \(aqMy Group\(aq include=\(aqfoo,bar\(aq
salt \(aq*\(aq pkg.group_install \(aqMy Group\(aq include=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Because this is essentially a wrapper around pkg.install, any argument
which can be passed to pkg.install may also be included here, and it
will be passed along wholesale.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.group_list()
New in version 2014.1.0.

.sp
Lists all groups known by yum on this system
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.group_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.groupinstall(name, skip=(), include=(), **kwargs)
This function is an alias of \fBgroup_install\fP\&.
.INDENT 7.0
.INDENT 3.5
New in version 2014.1.0.

.sp
Install the passed package group(s). This is basically a wrapper around
\fI\%pkg.install\fP, which performs
package group resolution for the user. This function is currently
considered experimental, and should be expected to undergo changes.
.INDENT 0.0
.TP
.B name
Package group to install. To install more than one group, either use a
comma\-separated list or pass the value as a python list.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.group_install \(aqGroup 1\(aq
salt \(aq*\(aq pkg.group_install \(aqGroup 1,Group 2\(aq
salt \(aq*\(aq pkg.group_install \(aq[\(dqGroup 1\(dq, \(dqGroup 2\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B skip
Packages that would normally be installed by the package group
(\(dqdefault\(dq packages), which should not be installed. Can be passed
either as a comma\-separated list or a python list.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.group_install \(aqMy Group\(aq skip=\(aqfoo,bar\(aq
salt \(aq*\(aq pkg.group_install \(aqMy Group\(aq skip=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B include
Packages which are included in a group, which would not normally be
installed by a \fByum groupinstall\fP (\(dqoptional\(dq packages). Note that
this will not enforce group membership; if you include packages which
are not members of the specified groups, they will still be installed.
Can be passed either as a comma\-separated list or a python list.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.group_install \(aqMy Group\(aq include=\(aqfoo,bar\(aq
salt \(aq*\(aq pkg.group_install \(aqMy Group\(aq include=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Because this is essentially a wrapper around pkg.install, any argument
which can be passed to pkg.install may also be included here, and it
will be passed along wholesale.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.hold(name=None, pkgs=None, sources=None, normalize=True, **kwargs)
New in version 2014.7.0.

.sp
Version\-lock packages
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Requires the appropriate \fBversionlock\fP plugin package to be installed:
.INDENT 0.0
.IP \(bu 2
On RHEL 5: \fByum\-versionlock\fP
.IP \(bu 2
On RHEL 6 & 7: \fByum\-plugin\-versionlock\fP
.IP \(bu 2
On Fedora: \fBpython\-dnf\-plugins\-extras\-versionlock\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the package to be held.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to hold. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.hold <package name>
salt \(aq*\(aq pkg.hold pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.info_installed(*names, **kwargs)
New in version 2015.8.1.

.sp
Return the information of the named package(s), installed on the system.
.INDENT 7.0
.TP
.B Parameters
\fBall_versions\fP \-\- Include information for all versions of the packages installed on the minion.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.info_installed <package1>
salt \(aq*\(aq pkg.info_installed <package1> <package2> <package3> ...
salt \(aq*\(aq pkg.info_installed <package1> <package2> <package3> all_versions=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.install(name=None, refresh=False, skip_verify=False, pkgs=None, sources=None, downloadonly=False, reinstall=False, normalize=True, update_holds=False, saltenv=\(aqbase\(aq, ignore_epoch=False, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any yum/dnf commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Install the passed package(s), add refresh=True to clean the yum database
before package is installed.
.INDENT 7.0
.TP
.B name
The name of the package to be installed. Note that this parameter is
ignored if either \(dqpkgs\(dq or \(dqsources\(dq is passed. Additionally, please
note that this option can only be used to install packages from a
software repository. To install a package file manually, use the
\(dqsources\(dq option.
.sp
32\-bit packages can be installed on 64\-bit systems by appending the
architecture designation (\fB\&.i686\fP, \fB\&.i586\fP, etc.) to the end of the
package name.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B refresh
Whether or not to update the yum database before executing.
.TP
.B reinstall
Specifying reinstall=True will use \fByum reinstall\fP rather than
\fByum install\fP for requested packages that are already installed.
.sp
If a version is specified with the requested package, then
\fByum reinstall\fP will only be used if the installed version
matches the requested version.
.sp
Works with \fBsources\fP when the package header of the source can be
matched to the name and version of an installed package.
.sp
New in version 2014.7.0.

.TP
.B skip_verify
Skip the GPG verification check (e.g., \fB\-\-nogpgcheck\fP)
.TP
.B downloadonly
Only download the packages, do not install.
.TP
.B version
Install a specific version of the package, e.g. 1.2.3\-4.el5. Ignored
if \(dqpkgs\(dq or \(dqsources\(dq is passed.
.sp
Changed in version 2018.3.0: version can now contain comparison operators (e.g. \fB>1.2.3\fP,
\fB<=2.0\fP, etc.)

.TP
.B update_holds
False
If \fBTrue\fP, and this function would update the package version, any
packages held using the yum/dnf \(dqversionlock\(dq plugin will be unheld so
that they can be updated. Otherwise, if this function attempts to
update a held package, the held package(s) will be skipped and an
error will be raised.
.sp
New in version 2016.11.0.

.TP
.B setopt
A comma\-separated or Python list of key=value options. This list will
be expanded and \fB\-\-setopt\fP prepended to each in the yum/dnf command
that is run.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install foo setopt=\(aqobsoletes=0,plugins=0\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.UNINDENT
.sp
Repository Options:
.INDENT 7.0
.TP
.B fromrepo
Specify a package repository (or repositories) from which to install.
(e.g., \fByum \-\-disablerepo=\(aq*\(aq \-\-enablerepo=\(aqsomerepo\(aq\fP)
.TP
.B enablerepo (ignored if \fBfromrepo\fP is specified)
Specify a disabled package repository (or repositories) to enable.
(e.g., \fByum \-\-enablerepo=\(aqsomerepo\(aq\fP)
.TP
.B disablerepo (ignored if \fBfromrepo\fP is specified)
Specify an enabled package repository (or repositories) to disable.
(e.g., \fByum \-\-disablerepo=\(aqsomerepo\(aq\fP)
.TP
.B disableexcludes
Disable exclude from main, for a repo or for everything.
(e.g., \fByum \-\-disableexcludes=\(aqmain\(aq\fP)
.sp
New in version 2014.7.0.

.TP
.B ignore_epoch
False
Only used when the version of a package is specified using a comparison
operator (e.g. \fB>4.1\fP). If set to \fBTrue\fP, then the epoch will be
ignored when comparing the currently\-installed version to the desired
version.
.sp
New in version 2018.3.0.

.UNINDENT
.sp
Multiple Package Installation Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to install from a software repository. Must be
passed as a python list. A specific version number can be specified
by using a single\-element dict representing the package and its
version.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, {\(dqbar\(dq: \(dq1.2.3\-4.el5\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B sources
A list of RPM packages to install. Must be passed as a list of dicts,
with the keys being package names, and the values being the source URI
or local path to the package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install sources=\(aq[{\(dqfoo\(dq: \(dqsalt://foo.rpm\(dq}, {\(dqbar\(dq: \(dqsalt://bar.rpm\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B normalize
True
Normalize the package name by removing the architecture. This is useful
for poorly created packages which might include the architecture as an
actual part of the name such as kernel modules which match a specific
kernel version.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G role:nsd pkg.install gpfs.gplbin\-2.6.32\-279.31.1.el6.x86_64 normalize=False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2014.7.0.

.TP
.B split_arch
True
If set to False it prevents package name normalization more strict way
than \fBnormalize\fP set to \fBFalse\fP does.
.sp
New in version 3006.0.

.TP
.B diff_attr:
If a list of package attributes is specified, returned value will
contain them, eg.:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {
    \(aqold\(aq: {
        \(aqversion\(aq: \(aq<old\-version>\(aq,
        \(aqarch\(aq: \(aq<old\-arch>\(aq},

    \(aqnew\(aq: {
        \(aqversion\(aq: \(aq<new\-version>\(aq,
        \(aqarch\(aq: \(aq<new\-arch>\(aq}}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Valid attributes are: \fBepoch\fP, \fBversion\fP, \fBrelease\fP, \fBarch\fP,
\fBinstall_date\fP, \fBinstall_date_time_t\fP\&.
.sp
If \fBall\fP is specified, all valid attributes will be returned.
.sp
New in version 2018.3.0.

.UNINDENT
.sp
Returns a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If an attribute list in diff_attr is specified, the dict will also contain
any specified attribute, eg.:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {
    \(aqold\(aq: {
        \(aqversion\(aq: \(aq<old\-version>\(aq,
        \(aqarch\(aq: \(aq<old\-arch>\(aq},

    \(aqnew\(aq: {
        \(aqversion\(aq: \(aq<new\-version>\(aq,
        \(aqarch\(aq: \(aq<new\-arch>\(aq}}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.latest_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
string will be returned for that package.
.sp
A specific repo can be requested using the \fBfromrepo\fP keyword argument,
and the \fBdisableexcludes\fP option is also supported.
.sp
New in version 2014.7.0: Support for the \fBdisableexcludes\fP option

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package name> fromrepo=epel\-testing
salt \(aq*\(aq pkg.latest_version <package name> disableexcludes=main
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.list_downloaded(**kwargs)
New in version 2017.7.0.

.sp
List prefetched packages downloaded by Yum in the local disk.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_downloaded
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.list_holds(pattern=\(aq[\e\ew+]+(?:[.\-][^\-]+)*\(aq, full=True)
Changed in version 2015.5.10,2015.8.4,2016.3.0: Function renamed from \fBpkg.get_locked_pkgs\fP to \fBpkg.list_holds\fP\&.

.sp
List information on locked packages
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Requires the appropriate \fBversionlock\fP plugin package to be installed:
.INDENT 0.0
.IP \(bu 2
On RHEL 5: \fByum\-versionlock\fP
.IP \(bu 2
On RHEL 6 & 7: \fByum\-plugin\-versionlock\fP
.IP \(bu 2
On Fedora: \fBpython\-dnf\-plugins\-extras\-versionlock\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B pattern
w+(?:[.\-][^\-]+)*
Regular expression used to match the package name
.TP
.B full
True
Show the full hold definition including version and epoch. Set to
\fBFalse\fP to return just the name of the package(s) being held.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_holds
salt \(aq*\(aq pkg.list_holds full=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.list_installed_patches(**kwargs)
New in version 2017.7.0.

.sp
List installed advisory patches on the system.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_installed_patches
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.list_patches(refresh=False, **kwargs)
New in version 2017.7.0.

.sp
List all known advisory patches from available repos.
.INDENT 7.0
.TP
.B refresh
force a refresh if set to True.
If set to False (default) it depends on yum if a refresh is
executed.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_patches
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.list_pkgs(versions_as_list=False, **kwargs)
List the packages currently installed as a dict. By default, the dict
contains versions as a comma separated string:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>[,<version>...]\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B versions_as_list:
If set to true, the versions are provided as a list
.sp
{\(aq<package_name>\(aq: [\(aq<version>\(aq, \(aq<version>\(aq]}
.TP
.B attr:
If a list of package attributes is specified, returned value will
contain them in addition to version, eg.:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: [{\(aqversion\(aq : \(aqversion\(aq, \(aqarch\(aq : \(aqarch\(aq}]}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Valid attributes are: \fBepoch\fP, \fBversion\fP, \fBrelease\fP, \fBarch\fP,
\fBinstall_date\fP, \fBinstall_date_time_t\fP\&.
.sp
If \fBall\fP is specified, all valid attributes will be returned.
.INDENT 7.0
.INDENT 3.5
New in version 2018.3.0.

.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
salt \(aq*\(aq pkg.list_pkgs attr=version,arch
salt \(aq*\(aq pkg.list_pkgs attr=\(aq[\(dqversion\(dq, \(dqarch\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.list_repo_pkgs(*args, **kwargs)
New in version 2014.1.0.

.sp
Changed in version 2014.7.0: All available versions of each package are now returned. This required
a slight modification to the structure of the return dict. The return
data shown below reflects the updated return dict structure. Note that
packages which are version\-locked using \fI\%pkg.hold\fP will only show the currently\-installed
version, as locking a package will make other versions appear
unavailable to yum/dnf.

.sp
Changed in version 2017.7.0: By default, the versions for each package are no longer organized by
repository. To get results organized by repository, use
\fBbyrepo=True\fP\&.

.sp
Returns all available packages. Optionally, package names (and name globs)
can be passed and the results will be filtered to packages matching those
names. This is recommended as it speeds up the function considerably.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Running this function on RHEL/CentOS 6 and earlier will be more
resource\-intensive, as the version of yum that ships with older
RHEL/CentOS has no yum subcommand for listing packages from a
repository. Thus, a \fByum list installed\fP and \fByum list available\fP
are run, which generates a lot of output, which must then be analyzed
to determine which package information to include in the return data.
.UNINDENT
.UNINDENT
.sp
This function can be helpful in discovering the version or repo to specify
in a \fI\%pkg.installed\fP state.
.sp
The return data will be a dictionary mapping package names to a list of
version numbers, ordered from newest to oldest. If \fBbyrepo\fP is set to
\fBTrue\fP, then the return dictionary will contain repository names at the
top level, and each repository will map packages to lists of version
numbers. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# With byrepo=False (default)
{
    \(aqbash\(aq: [\(aq4.1.2\-15.el6_5.2\(aq,
             \(aq4.1.2\-15.el6_5.1\(aq,
             \(aq4.1.2\-15.el6_4\(aq],
    \(aqkernel\(aq: [\(aq2.6.32\-431.29.2.el6\(aq,
               \(aq2.6.32\-431.23.3.el6\(aq,
               \(aq2.6.32\-431.20.5.el6\(aq,
               \(aq2.6.32\-431.20.3.el6\(aq,
               \(aq2.6.32\-431.17.1.el6\(aq,
               \(aq2.6.32\-431.11.2.el6\(aq,
               \(aq2.6.32\-431.5.1.el6\(aq,
               \(aq2.6.32\-431.3.1.el6\(aq,
               \(aq2.6.32\-431.1.2.0.1.el6\(aq,
               \(aq2.6.32\-431.el6\(aq]
}
# With byrepo=True
{
    \(aqbase\(aq: {
        \(aqbash\(aq: [\(aq4.1.2\-15.el6_4\(aq],
        \(aqkernel\(aq: [\(aq2.6.32\-431.el6\(aq]
    },
    \(aqupdates\(aq: {
        \(aqbash\(aq: [\(aq4.1.2\-15.el6_5.2\(aq, \(aq4.1.2\-15.el6_5.1\(aq],
        \(aqkernel\(aq: [\(aq2.6.32\-431.29.2.el6\(aq,
                   \(aq2.6.32\-431.23.3.el6\(aq,
                   \(aq2.6.32\-431.20.5.el6\(aq,
                   \(aq2.6.32\-431.20.3.el6\(aq,
                   \(aq2.6.32\-431.17.1.el6\(aq,
                   \(aq2.6.32\-431.11.2.el6\(aq,
                   \(aq2.6.32\-431.5.1.el6\(aq,
                   \(aq2.6.32\-431.3.1.el6\(aq,
                   \(aq2.6.32\-431.1.2.0.1.el6\(aq]
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B fromrepo
None
Only include results from the specified repo(s). Multiple repos can be
specified, comma\-separated.
.TP
.B enablerepo (ignored if \fBfromrepo\fP is specified)
Specify a disabled package repository (or repositories) to enable.
(e.g., \fByum \-\-enablerepo=\(aqsomerepo\(aq\fP)
.sp
New in version 2017.7.0.

.TP
.B disablerepo (ignored if \fBfromrepo\fP is specified)
Specify an enabled package repository (or repositories) to disable.
(e.g., \fByum \-\-disablerepo=\(aqsomerepo\(aq\fP)
.sp
New in version 2017.7.0.

.TP
.B byrepo
False
When \fBTrue\fP, the return data for each package will be organized by
repository.
.sp
New in version 2017.7.0.

.TP
.B cacheonly
False
When \fBTrue\fP, the repo information will be retrieved from the cached
repo metadata. This is equivalent to passing the \fB\-C\fP option to
yum/dnf.
.sp
New in version 2017.7.0.

.TP
.B setopt
A comma\-separated or Python list of key=value options. This list will
be expanded and \fB\-\-setopt\fP prepended to each in the yum/dnf command
that is run.
.sp
New in version 2019.2.0.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_repo_pkgs
salt \(aq*\(aq pkg.list_repo_pkgs foo bar baz
salt \(aq*\(aq pkg.list_repo_pkgs \(aqsamba4*\(aq fromrepo=base,updates
salt \(aq*\(aq pkg.list_repo_pkgs \(aqpython2\-*\(aq byrepo=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.list_repos(basedir=None, **kwargs)
Lists all repos in <basedir> (default: all dirs in \fIreposdir\fP yum option).
.sp
Strict parsing of configuration files is the default, this can be disabled
using the  \fBstrict_config\fP keyword argument set to False
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_repos
salt \(aq*\(aq pkg.list_repos basedir=/path/to/dir
salt \(aq*\(aq pkg.list_repos basedir=/path/to/dir,/path/to/another/dir strict_config=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.list_updates(refresh=True, **kwargs)
This function is an alias of \fBlist_upgrades\fP\&.
.INDENT 7.0
.INDENT 3.5
Check whether or not an upgrade is available for all packages
.sp
The \fBfromrepo\fP, \fBenablerepo\fP, and \fBdisablerepo\fP arguments are
supported, as used in pkg states, and the \fBdisableexcludes\fP option is
also supported.
.sp
New in version 2014.7.0: Support for the \fBdisableexcludes\fP option

.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.list_upgrades(refresh=True, **kwargs)
Check whether or not an upgrade is available for all packages
.sp
The \fBfromrepo\fP, \fBenablerepo\fP, and \fBdisablerepo\fP arguments are
supported, as used in pkg states, and the \fBdisableexcludes\fP option is
also supported.
.sp
New in version 2014.7.0: Support for the \fBdisableexcludes\fP option

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.mod_repo(repo, basedir=None, **kwargs)
Modify one or more values for a repo. If the repo does not exist, it will
be created, so long as the following values are specified:
.INDENT 7.0
.TP
.B repo
name by which the yum refers to the repo
.TP
.B name
a human\-readable name for the repo
.TP
.B baseurl
the URL for yum to reference
.TP
.B mirrorlist
the URL for yum to reference
.UNINDENT
.sp
Key/Value pairs may also be removed from a repo\(aqs configuration by setting
a key to a blank value. Bear in mind that a name cannot be deleted, and a
baseurl can only be deleted if a mirrorlist is specified (or vice versa).
.sp
Strict parsing of configuration files is the default, this can be disabled
using the  \fBstrict_config\fP keyword argument set to False
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.mod_repo reponame enabled=1 gpgcheck=1
salt \(aq*\(aq pkg.mod_repo reponame basedir=/path/to/dir enabled=1 strict_config=False
salt \(aq*\(aq pkg.mod_repo reponame baseurl= mirrorlist=http://host.com/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.modified(*packages, **flags)
List the modified files that belong to a package. Not specifying any packages
will return a list of _all_ modified files on the system\(aqs RPM database.
.sp
New in version 2015.5.0.

.sp
Filtering by flags (True or False):
.INDENT 7.0
.TP
.B size
Include only files where size changed.
.TP
.B mode
Include only files which file\(aqs mode has been changed.
.TP
.B checksum
Include only files which MD5 checksum has been changed.
.TP
.B device
Include only files which major and minor numbers has been changed.
.TP
.B symlink
Include only files which are symbolic link contents.
.TP
.B owner
Include only files where owner has been changed.
.TP
.B group
Include only files where group has been changed.
.TP
.B time
Include only files where modification time of the file has been
changed.
.TP
.B capabilities
Include only files where capabilities differ or not. Note: supported
only on newer RPM versions.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.modified
salt \(aq*\(aq pkg.modified httpd
salt \(aq*\(aq pkg.modified httpd postfix
salt \(aq*\(aq pkg.modified httpd owner=True group=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.normalize_name(name)
Strips the architecture from the specified package name, if necessary.
Circumstances where this would be done include:
.INDENT 7.0
.IP \(bu 2
If the arch is 32 bit and the package name ends in a 32\-bit arch.
.IP \(bu 2
If the arch matches the OS arch, or is \fBnoarch\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.normalize_name zsh.x86_64
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.owner(*paths, **kwargs)
New in version 2014.7.0.

.sp
Return the name of the package that owns the file. Multiple file paths can
be passed. Like \fI\%pkg.version\fP, if a
single path is passed, a string will be returned, and if multiple paths are
passed, a dictionary of file/package name pairs will be returned.
.sp
If the file is not owned by a package, or is not present on the minion,
then an empty string will be returned for that path.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.owner /usr/bin/apachectl
salt \(aq*\(aq pkg.owner /usr/bin/apachectl /etc/httpd/conf/httpd.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.parse_arch(name)
Parse name and architecture from the specified package name.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.parse_arch zsh.x86_64
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.purge(name=None, pkgs=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any yum/dnf commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Package purges are not supported by yum, this function is identical to
\fI\%pkg.remove\fP\&.
.INDENT 7.0
.TP
.B name
The name of the package to be purged
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.purge <package name>
salt \(aq*\(aq pkg.purge <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.purge pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.refresh_db(**kwargs)
Check the yum repos for updated packages
.sp
Returns:
.INDENT 7.0
.IP \(bu 2
\fBTrue\fP: Updates are available
.IP \(bu 2
\fBFalse\fP: An error occurred
.IP \(bu 2
\fBNone\fP: No updates are available
.UNINDENT
.INDENT 7.0
.TP
.B repo
Refresh just the specified repo
.TP
.B disablerepo
Do not refresh the specified repo
.TP
.B enablerepo
Refresh a disabled repo using this option
.TP
.B branch
Add the specified branch when refreshing
.TP
.B disableexcludes
Disable the excludes defined in your config files. Takes one of three
options:
\- \fBall\fP \- disable all excludes
\- \fBmain\fP \- disable excludes defined in [main] in yum.conf
\- \fBrepoid\fP \- disable excludes defined for that repo
.TP
.B setopt
A comma\-separated or Python list of key=value options. This list will
be expanded and \fB\-\-setopt\fP prepended to each in the yum/dnf command
that is run.
.sp
New in version 2019.2.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.remove(name=None, pkgs=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any yum/dnf commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Remove packages
.INDENT 7.0
.TP
.B name
The name of the package to be removed
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
New in version 0.16.0.

.INDENT 7.0
.TP
.B split_arch
True
If set to False it prevents package name normalization by removing arch.
.sp
New in version 3006.0.

.UNINDENT
.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.services_need_restart(**kwargs)
New in version 3003.

.sp
List services that use files which have been changed by the
package manager. It might be needed to restart them.
.sp
Requires systemd.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.services_need_restart
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.unhold(name=None, pkgs=None, sources=None, **kwargs)
New in version 2014.7.0.

.sp
Remove version locks
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Requires the appropriate \fBversionlock\fP plugin package to be installed:
.INDENT 0.0
.IP \(bu 2
On RHEL 5: \fByum\-versionlock\fP
.IP \(bu 2
On RHEL 6 & 7: \fByum\-plugin\-versionlock\fP
.IP \(bu 2
On Fedora: \fBpython\-dnf\-plugins\-extras\-versionlock\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the package to be unheld
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to unhold. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.UNINDENT
.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.unhold <package name>
salt \(aq*\(aq pkg.unhold pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.update(name=None, pkgs=None, refresh=True, skip_verify=False, normalize=True, minimal=False, obsoletes=False, **kwargs)
New in version 2019.2.0.

.sp
Calls \fI\%pkg.upgrade\fP with
\fBobsoletes=False\fP\&. Mirrors the CLI behavior of \fByum update\fP\&.
See \fI\%pkg.upgrade\fP for
further documentation.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.update
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.upgrade(name=None, pkgs=None, refresh=True, skip_verify=False, normalize=True, minimal=False, obsoletes=True, diff_attr=None, **kwargs)
Run a full system upgrade (a \fByum upgrade\fP or \fBdnf upgrade\fP), or
upgrade specified packages. If the packages aren\(aqt installed, they will
not be installed.
.sp
Changed in version 2014.7.0.

.sp
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any yum/dnf commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Changed in version 2019.2.0: Added \fBobsoletes\fP and \fBminimal\fP arguments

.sp
Returns a dictionary containing the changes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq:  {\(aqold\(aq: \(aq<old\-version>\(aq,
                \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade
salt \(aq*\(aq pkg.upgrade name=openssl
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Repository Options:
.INDENT 7.0
.TP
.B fromrepo
Specify a package repository (or repositories) from which to install.
(e.g., \fByum \-\-disablerepo=\(aq*\(aq \-\-enablerepo=\(aqsomerepo\(aq\fP)
.TP
.B enablerepo (ignored if \fBfromrepo\fP is specified)
Specify a disabled package repository (or repositories) to enable.
(e.g., \fByum \-\-enablerepo=\(aqsomerepo\(aq\fP)
.TP
.B disablerepo (ignored if \fBfromrepo\fP is specified)
Specify an enabled package repository (or repositories) to disable.
(e.g., \fByum \-\-disablerepo=\(aqsomerepo\(aq\fP)
.TP
.B disableexcludes
Disable exclude from main, for a repo or for everything.
(e.g., \fByum \-\-disableexcludes=\(aqmain\(aq\fP)
.sp
New in version 2014.7.0.

.TP
.B name
The name of the package to be upgraded. Note that this parameter is
ignored if \(dqpkgs\(dq is passed.
.sp
32\-bit packages can be upgraded on 64\-bit systems by appending the
architecture designation (\fB\&.i686\fP, \fB\&.i586\fP, etc.) to the end of the
package name.
.sp
Warning: if you forget \(aqname=\(aq and run pkg.upgrade openssl, ALL packages
are upgraded. This will be addressed in next releases.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade name=openssl
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.TP
.B pkgs
A list of packages to upgrade from a software repository. Must be
passed as a python list. A specific version number can be specified
by using a single\-element dict representing the package and its
version. If the package was not already installed on the system,
it will not be installed.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
salt \(aq*\(aq pkg.upgrade pkgs=\(aq[\(dqfoo\(dq, {\(dqbar\(dq: \(dq1.2.3\-4.el5\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.TP
.B normalize
True
Normalize the package name by removing the architecture. This is useful
for poorly created packages which might include the architecture as an
actual part of the name such as kernel modules which match a specific
kernel version.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G role:nsd pkg.upgrade gpfs.gplbin\-2.6.32\-279.31.1.el6.x86_64 normalize=False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.TP
.B minimal
False
Use upgrade\-minimal instead of upgrade (e.g., \fByum upgrade\-minimal\fP)
Goes to the \(aqnewest\(aq package match which fixes a problem that affects your system.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade minimal=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B obsoletes
True
Controls whether yum/dnf should take obsoletes into account and remove them.
If set to \fBFalse\fP yum will use \fBupdate\fP instead of \fBupgrade\fP
and dnf will be run with \fB\-\-obsoletes=False\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade obsoletes=False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B setopt
A comma\-separated or Python list of key=value options. This list will
be expanded and \fB\-\-setopt\fP prepended to each in the yum/dnf command
that is run.
.sp
New in version 2019.2.0.

.TP
.B diff_attr:
If a list of package attributes is specified, returned value will
contain them, eg.:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {
    \(aqold\(aq: {
        \(aqversion\(aq: \(aq<old\-version>\(aq,
        \(aqarch\(aq: \(aq<old\-arch>\(aq},

    \(aqnew\(aq: {
        \(aqversion\(aq: \(aq<new\-version>\(aq,
        \(aqarch\(aq: \(aq<new\-arch>\(aq}}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Valid attributes are: \fBepoch\fP, \fBversion\fP, \fBrelease\fP, \fBarch\fP,
\fBinstall_date\fP, \fBinstall_date_time_t\fP\&.
.sp
If \fBall\fP is specified, all valid attributes will be returned.
.sp
New in version 3006.0.

.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To add extra arguments to the \fByum upgrade\fP command, pass them as key
word arguments. For arguments without assignments, pass \fBTrue\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade security=True exclude=\(aqkernel*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.upgrade_available(name, **kwargs)
Check whether or not an upgrade is available for a given package
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade_available <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.verify(*names, **kwargs)
New in version 2014.1.0.

.sp
Runs an rpm \-Va on a system, and returns the results in a dict
.sp
Pass options to modify rpm verify behavior using the \fBverify_options\fP
keyword argument
.sp
Files with an attribute of config, doc, ghost, license or readme in the
package header can be ignored using the \fBignore_types\fP keyword argument
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.verify
salt \(aq*\(aq pkg.verify httpd
salt \(aq*\(aq pkg.verify \(aqhttpd postfix\(aq
salt \(aq*\(aq pkg.verify \(aqhttpd postfix\(aq ignore_types=[\(aqconfig\(aq,\(aqdoc\(aq]
salt \(aq*\(aq pkg.verify \(aqhttpd postfix\(aq verify_options=[\(aqnodeps\(aq,\(aqnosize\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.version(*names, **kwargs)
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.yumpkg.version_cmp(pkg1, pkg2, ignore_epoch=False, **kwargs)
New in version 2015.5.4.

.sp
Do a cmp\-style comparison on two packages. Return \-1 if pkg1 < pkg2, 0 if
pkg1 == pkg2, and 1 if pkg1 > pkg2. Return None if there was a problem
making the comparison.
.INDENT 7.0
.TP
.B ignore_epoch
False
Set to \fBTrue\fP to ignore the epoch when comparing versions
.sp
New in version 2015.8.10,2016.3.2.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version_cmp \(aq0.2\-001\(aq \(aq0.2.0.1\-002\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.zabbix
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%zabbix Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Support for Zabbix
.INDENT 0.0
.TP
.B optdepends
.INDENT 7.0
.IP \(bu 2
zabbix server
.UNINDENT
.TP
.B configuration
This module is not usable until the zabbix user and zabbix password are specified either in a pillar
or in the minion\(aqs config file. Zabbix url should be also specified.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zabbix.user: Admin
zabbix.password: mypassword
zabbix.url: http://127.0.0.1/zabbix/api_jsonrpc.php
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Connection arguments from the minion config file can be overridden on the CLI by using arguments with
\fB_connection_\fP prefix.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zabbix.apiinfo_version _connection_user=Admin _connection_password=zabbix _connection_url=http://host/zabbix/
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B codeauthor
Jiri Kotlin <\fI\%jiri.kotlin@ultimum.io\fP>
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.apiinfo_version(**connection_args)
Retrieve the version of the Zabbix API.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
On success string with Zabbix API version, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.apiinfo_version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.compare_params(defined, existing, return_old_value=False)
New in version 2017.7.0.

.sp
Compares Zabbix object definition against existing Zabbix object.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdefined\fP \-\- Zabbix object definition taken from sls file.
.IP \(bu 2
\fBexisting\fP \-\- Existing Zabbix object taken from result of an API call.
.IP \(bu 2
\fBreturn_old_value\fP \-\- Default False. If True, returns dict(\(dqold\(dq=old_val, \(dqnew\(dq=new_val) for rollback purpose.
.UNINDENT
.TP
.B Returns
Params that are different from existing object. Result extended by
object ID can be passed directly to Zabbix API update method.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.compare_params new_zabbix_object_dict existing_zabbix_onject_dict
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.configuration_import(config_file, rules=None, file_format=\(aqxml\(aq, **connection_args)
New in version 2017.7.0.

.sp
Imports Zabbix configuration specified in file to Zabbix server.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconfig_file\fP \-\- File with Zabbix config (local or remote)
.IP \(bu 2
\fBrules\fP \-\- Optional \- Rules that have to be different from default (defaults are the same as in Zabbix web UI.)
.IP \(bu 2
\fBfile_format\fP \-\- Config file format (default: xml)
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.configuration_import salt://zabbix/config/zabbix_templates.xml         \(dq{\(aqscreens\(aq: {\(aqcreateMissing\(aq: True, \(aqupdateExisting\(aq: True}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.get_object_id_by_params(obj, params=None, **connection_args)
New in version 2017.7.0.

.sp
Get ID of single Zabbix object specified by its name.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBobj\fP \-\- Zabbix object type
.IP \(bu 2
\fBparams\fP \-\- Parameters by which object is uniquely identified
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
object ID
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.get_object_id_by_params object_type params=zabbix_api_query_parameters_dict
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.get_zabbix_id_mapper()
New in version 2017.7.0.

.sp
Make ZABBIX_ID_MAPPER constant available to state modules.
.INDENT 7.0
.TP
.B Returns
ZABBIX_ID_MAPPER
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.get_zabbix_id_mapper
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.host_create(host, groups, interfaces, **connection_args)
New in version 2016.3.0.

.sp
Create new host
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all standard host properties: keyword argument
names differ depending on your zabbix version, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhost\fP \-\- technical name of the host
.IP \(bu 2
\fBgroups\fP \-\- groupids of host groups to add the host to
.IP \(bu 2
\fBinterfaces\fP \-\- interfaces to be created for the host
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.IP \(bu 2
\fBvisible_name\fP \-\- string with visible name of the host, use
\(aqvisible_name\(aq instead of \(aqname\(aq parameter to not mess with value
supplied from Salt sls file.
.UNINDENT
.UNINDENT
.sp
return: ID of the created host.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.host_create technicalname 4
interfaces=\(aq{type: 1, main: 1, useip: 1, ip: \(dq192.168.3.1\(dq, dns: \(dq\(dq, port: 10050}\(aq
visible_name=\(aqHost Visible Name\(aq inventory_mode=0 inventory=\(aq{\(dqalias\(dq: \(dqsomething\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.host_delete(hostids, **connection_args)
Delete hosts.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhostids\fP \-\- Hosts (hostids) to delete.
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
IDs of the deleted hosts.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.host_delete 10106
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.host_exists(host=None, hostid=None, name=None, node=None, nodeids=None, **connection_args)
Checks if at least one host that matches the given filter criteria exists.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhost\fP \-\- technical name of the host
.IP \(bu 2
\fBhostids\fP \-\- Hosts (hostids) to delete.
.IP \(bu 2
\fBname\fP \-\- visible name of the host
.IP \(bu 2
\fBnode\fP \-\- name of the node the hosts must belong to (zabbix API < 2.4)
.IP \(bu 2
\fBnodeids\fP \-\- IDs of the node the hosts must belong to (zabbix API < 2.4)
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
IDs of the deleted hosts, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.host_exists \(aqZabbix server\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.host_get(host=None, name=None, hostids=None, **connection_args)
New in version 2016.3.0.

.sp
Retrieve hosts according to the given parameters
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all optional host.get parameters: keyword
argument names differ depending on your zabbix version, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhost\fP \-\- technical name of the host
.IP \(bu 2
\fBname\fP \-\- visible name of the host
.IP \(bu 2
\fBhostids\fP \-\- ids of the hosts
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
Array with convenient hosts details, False if no host found or on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.host_get \(aqZabbix server\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.host_inventory_get(hostids, **connection_args)
Retrieve host inventory according to the given parameters.
See: \fI\%https://www.zabbix.com/documentation/2.4/manual/api/reference/host/object#host_inventory\fP
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhostids\fP \-\- ID of the host to query
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
Array with host inventory fields, populated or not, False if host inventory is disabled or on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.host_inventory_get 101054
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.host_inventory_set(hostid, **connection_args)
Update host inventory items
NOTE: This function accepts all standard host: keyword argument names for inventory
see: \fI\%https://www.zabbix.com/documentation/2.4/manual/api/reference/host/object#host_inventory\fP
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhostid\fP \-\- ID of the host to update
.IP \(bu 2
\fBclear_old\fP \-\- Set to True in order to remove all existing inventory items before setting the specified items
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
ID of the updated host, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.host_inventory_set 101054 asset_tag=jml3322 type=vm clear_old=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.host_list(**connection_args)
Retrieve all hosts.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
Array with details about hosts, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.host_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.host_update(hostid, **connection_args)
New in version 2016.3.0.

.sp
Update existing hosts
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all standard host and host.update properties:
keyword argument names differ depending on your zabbix version, see the
documentation for \fI\%host objects\fP and the documentation for \fI\%updating
hosts\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhostid\fP \-\- ID of the host to update
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.IP \(bu 2
\fBvisible_name\fP \-\- string with visible name of the host, use
\(aqvisible_name\(aq instead of \(aqname\(aq parameter to not mess with value
supplied from Salt sls file.
.UNINDENT
.TP
.B Returns
ID of the updated host.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.host_update 10084 name=\(aqZabbix server2\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.hostgroup_create(name, **connection_args)
New in version 2016.3.0.

.sp
Create a host group
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all standard host group properties: keyword
argument names differ depending on your zabbix version, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name of the host group
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
ID of the created host group.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.hostgroup_create MyNewGroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.hostgroup_delete(hostgroupids, **connection_args)
Delete the host group.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhostgroupids\fP \-\- IDs of the host groups to delete
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
ID of the deleted host groups, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.hostgroup_delete 23
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.hostgroup_exists(name=None, groupid=None, node=None, nodeids=None, **connection_args)
Checks if at least one host group that matches the given filter criteria exists.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- names of the host groups
.IP \(bu 2
\fBgroupid\fP \-\- host group IDs
.IP \(bu 2
\fBnode\fP \-\- name of the node the host groups must belong to (zabbix API < 2.4)
.IP \(bu 2
\fBnodeids\fP \-\- IDs of the nodes the host groups must belong to (zabbix API < 2.4)
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
True if at least one host group exists, False if not or on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.hostgroup_exists MyNewGroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.hostgroup_get(name=None, groupids=None, hostids=None, **connection_args)
New in version 2016.3.0.

.sp
Retrieve host groups according to the given parameters
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all standard hostgroup.get properities: keyword
argument names differ depending on your zabbix version, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- names of the host groups
.IP \(bu 2
\fBgroupid\fP \-\- host group IDs
.IP \(bu 2
\fBnode\fP \-\- name of the node the host groups must belong to
.IP \(bu 2
\fBnodeids\fP \-\- IDs of the nodes the host groups must belong to
.IP \(bu 2
\fBhostids\fP \-\- return only host groups that contain the given hosts
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
Array with host groups details, False if no convenient host group found or on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.hostgroup_get MyNewGroup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.hostgroup_list(**connection_args)
Retrieve all host groups.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
Array with details about host groups, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.hostgroup_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.hostgroup_update(groupid, name=None, **connection_args)
New in version 2016.3.0.

.sp
Update existing hosts group
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all standard host group properties: keyword
argument names differ depending on your zabbix version, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBgroupid\fP \-\- ID of the host group to update
.IP \(bu 2
\fBname\fP \-\- name of the host group
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
IDs of updated host groups.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.hostgroup_update 24 name=\(aqRenamed Name\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.hostinterface_create(hostid, ip_, dns=\(aq\(aq, main=1, if_type=1, useip=1, port=None, **connection_args)
New in version 2016.3.0.

.sp
Create new host interface
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all standard host group interface: keyword
argument names differ depending on your zabbix version, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhostid\fP \-\- ID of the host the interface belongs to
.IP \(bu 2
\fBip\fP \-\- IP address used by the interface
.IP \(bu 2
\fBdns\fP \-\- DNS name used by the interface
.IP \(bu 2
\fBmain\fP \-\- whether the interface is used as default on the host (0 \- not default, 1 \- default)
.IP \(bu 2
\fBport\fP \-\- port number used by the interface
.IP \(bu 2
\fBtype\fP \-\- Interface type (1 \- agent; 2 \- SNMP; 3 \- IPMI; 4 \- JMX)
.IP \(bu 2
\fBuseip\fP \-\- Whether the connection should be made via IP (0 \- connect
using host DNS name; 1 \- connect using host IP address for this host
interface)
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or
pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in
opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set
in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
ID of the created host interface, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.hostinterface_create 10105 192.193.194.197
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.hostinterface_delete(interfaceids, **connection_args)
Delete host interface
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinterfaceids\fP \-\- IDs of the host interfaces to delete
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
ID of deleted host interfaces, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.hostinterface_delete 50
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.hostinterface_get(hostids, **connection_args)
New in version 2016.3.0.

.sp
Retrieve host groups according to the given parameters
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all standard hostinterface.get properities:
keyword argument names differ depending on your zabbix version, see
\fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhostids\fP \-\- Return only host interfaces used by the given hosts.
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
Array with host interfaces details, False if no convenient host interfaces found or on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.hostinterface_get 101054
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.hostinterface_update(interfaceid, **connection_args)
New in version 2016.3.0.

.sp
Update host interface
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all standard hostinterface: keyword argument
names differ depending on your zabbix version, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinterfaceid\fP \-\- ID of the hostinterface to update
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
ID of the updated host interface, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.hostinterface_update 6 ip_=0.0.0.2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.mediatype_create(name, mediatype, **connection_args)
Create new mediatype
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all standard mediatype properties: keyword
argument names differ depending on your zabbix version, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmediatype\fP \-\- media type \- 0: email, 1: script, 2: sms, 3: Jabber, 100: Ez Texting
.IP \(bu 2
\fBexec_path\fP \-\- exec path \- Required for script and Ez Texting types, see Zabbix API docs
.IP \(bu 2
\fBgsm_modem\fP \-\- exec path \- Required for sms type, see Zabbix API docs
.IP \(bu 2
\fBsmtp_email\fP \-\- email address from which notifications will be sent, required for email type
.IP \(bu 2
\fBsmtp_helo\fP \-\- SMTP HELO, required for email type
.IP \(bu 2
\fBsmtp_server\fP \-\- SMTP server, required for email type
.IP \(bu 2
\fBstatus\fP \-\- whether the media type is enabled \- 0: enabled, 1: disabled
.IP \(bu 2
\fBusername\fP \-\- authentication user, required for Jabber and Ez Texting types
.IP \(bu 2
\fBpasswd\fP \-\- authentication password, required for Jabber and Ez Texting types
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.sp
return: ID of the created mediatype.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.mediatype_create \(aqEmail\(aq 0 smtp_email=\(aqnoreply@example.com\(aq
smtp_server=\(aqmailserver.example.com\(aq smtp_helo=\(aqzabbix.example.com\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.mediatype_delete(mediatypeids, **connection_args)
Delete mediatype
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinterfaceids\fP \-\- IDs of the mediatypes to delete
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
ID of deleted mediatype, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.mediatype_delete 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.mediatype_get(name=None, mediatypeids=None, **connection_args)
Retrieve mediatypes according to the given parameters.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Name or description of the mediatype
.IP \(bu 2
\fBmediatypeids\fP \-\- ids of the mediatypes
.IP \(bu 2
\fBconnection_args\fP (\fIoptional\fP) \-\-
.sp
_connection_user: zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
_connection_password: zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
_connection_url: url of zabbix frontend (can also be set in opts or pillar, see module\(aqs docstring)
.sp
all optional mediatype.get parameters: keyword argument names depends on your zabbix version, see:
.sp
\fI\%https://www.zabbix.com/documentation/2.2/manual/api/reference/mediatype/get\fP

.UNINDENT
.TP
.B Returns
Array with mediatype details, False if no mediatype found or on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.mediatype_get name=\(aqEmail\(aq
salt \(aq*\(aq zabbix.mediatype_get mediatypeids=\(dq[\(aq1\(aq, \(aq2\(aq, \(aq3\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.mediatype_update(mediatypeid, name=False, mediatype=False, **connection_args)
Update existing mediatype
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all standard mediatype properties: keyword
argument names differ depending on your zabbix version, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmediatypeid\fP \-\- ID of the mediatype to update
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
IDs of the updated mediatypes, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.usergroup_update 8 name=\(dqEmail update\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.run_query(method, params, **connection_args)
Send Zabbix API call
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmethod\fP \-\- actual operation to perform via the API
.IP \(bu 2
\fBparams\fP \-\- parameters required for specific method
.IP \(bu 2
\fBconnection_args\fP (\fIoptional\fP) \-\-
.sp
_connection_user: zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
_connection_password: zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
_connection_url: url of zabbix frontend (can also be set in opts or pillar, see module\(aqs docstring)
.sp
all optional template.get parameters: keyword argument names depends on your zabbix version, see:
.sp
\fI\%https://www.zabbix.com/documentation/2.4/manual/api/reference/\fP

.UNINDENT
.TP
.B Returns
Response from Zabbix API
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.run_query proxy.create \(aq{\(dqhost\(dq: \(dqzabbixproxy.domain.com\(dq, \(dqstatus\(dq: \(dq5\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.substitute_params(input_object, extend_params=None, filter_key=\(aqname\(aq, **kwargs)
New in version 2017.7.0.

.sp
Go through Zabbix object params specification and if needed get given object ID from Zabbix API and put it back
as a value. Definition of the object is done via dict with keys \(dqquery_object\(dq and \(dqquery_name\(dq.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinput_object\fP \-\- Zabbix object type specified in state file
.IP \(bu 2
\fBextend_params\fP \-\- Specify query with params
.IP \(bu 2
\fBfilter_key\fP \-\- Custom filtering key (default: name)
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
Params structure with values converted to string for further comparison purposes
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.substitute_params \(aq{\(dqquery_object\(dq: \(dqobject_name\(dq, \(dqquery_name\(dq: \(dqspecific_object_name\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.template_get(name=None, host=None, templateids=None, **connection_args)
Retrieve templates according to the given parameters.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhost\fP \-\- technical name of the template
.IP \(bu 2
\fBname\fP \-\- visible name of the template
.IP \(bu 2
\fBhostids\fP \-\- ids of the templates
.IP \(bu 2
\fBconnection_args\fP (\fIoptional\fP) \-\-
.sp
_connection_user: zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
_connection_password: zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
_connection_url: url of zabbix frontend (can also be set in opts or pillar, see module\(aqs docstring)
.sp
all optional template.get parameters: keyword argument names depends on your zabbix version, see:
.sp
\fI\%https://www.zabbix.com/documentation/2.4/manual/api/reference/template/get\fP

.UNINDENT
.TP
.B Returns
Array with convenient template details, False if no template found or on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.template_get name=\(aqTemplate OS Linux\(aq
salt \(aq*\(aq zabbix.template_get templateids=\(dq[\(aq10050\(aq, \(aq10001\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.user_addmedia(userids, active, mediatypeid, period, sendto, severity, **connection_args)
Add new media to multiple users. Available only for Zabbix version 3.4 or older.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuserids\fP \-\- ID of the user that uses the media
.IP \(bu 2
\fBactive\fP \-\- Whether the media is enabled (0 enabled, 1 disabled)
.IP \(bu 2
\fBmediatypeid\fP \-\- ID of the media type used by the media
.IP \(bu 2
\fBperiod\fP \-\- Time when the notifications can be sent as a time period
.IP \(bu 2
\fBsendto\fP \-\- Address, user name or other identifier of the recipient
.IP \(bu 2
\fBseverity\fP \-\- Trigger severities to send notifications about
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
IDs of the created media.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.user_addmedia 4 active=0 mediatypeid=1 period=\(aq1\-7,00:00\-24:00\(aq sendto=\(aqsupport2@example.com\(aq
severity=63
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.user_create(alias, passwd, usrgrps, **connection_args)
New in version 2016.3.0.

.sp
Create new zabbix user
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all standard user properties: keyword argument
names differ depending on your zabbix version, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBalias\fP \-\- user alias
.IP \(bu 2
\fBpasswd\fP \-\- user\(aqs password
.IP \(bu 2
\fBusrgrps\fP \-\- user groups to add the user to
.IP \(bu 2
\fB_connection_user\fP \-\- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- url of zabbix frontend (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fBfirstname\fP \-\- string with firstname of the user, use \(aqfirstname\(aq instead of \(aqname\(aq parameter to not mess
with value supplied from Salt sls file.
.UNINDENT
.TP
.B Returns
On success string with id of the created user.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.user_create james password007 \(aq[7, 12]\(aq firstname=\(aqJames Bond\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.user_delete(users, **connection_args)
Delete zabbix users.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBusers\fP \-\- array of users (userids) to delete
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
On success array with userids of deleted users.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.user_delete 15
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.user_deletemedia(mediaids, **connection_args)
Delete media by id. Available only for Zabbix version 3.4 or older.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmediaids\fP \-\- IDs of the media to delete
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
IDs of the deleted media, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.user_deletemedia 27
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.user_exists(alias, **connection_args)
Checks if user with given alias exists.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBalias\fP \-\- user alias
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
True if user exists, else False.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.user_exists james
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.user_get(alias=None, userids=None, **connection_args)
Retrieve users according to the given parameters.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBalias\fP \-\- user alias
.IP \(bu 2
\fBuserids\fP \-\- return only users with the given IDs
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
Array with details of convenient users, False on failure of if no user found.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.user_get james
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.user_getmedia(userids=None, **connection_args)
New in version 2016.3.0.

.sp
Retrieve media according to the given parameters
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all standard usermedia.get properties: keyword
argument names differ depending on your zabbix version, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuserids\fP \-\- return only media that are used by the given users
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
List of retrieved media, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.user_getmedia
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.user_list(**connection_args)
Retrieve all of the configured users.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
Array with user details.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.user_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.user_update(userid, **connection_args)
New in version 2016.3.0.

.sp
Update existing users
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all standard user properties: keyword argument
names differ depending on your zabbix version, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuserid\fP \-\- id of the user to update
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
Id of the updated user on success.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.user_update 16 visible_name=\(aqJames Brown\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.usergroup_create(name, **connection_args)
New in version 2016.3.0.

.sp
Create new user group
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all standard user group properties: keyword
argument names differ depending on your zabbix version, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name of the user group
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
IDs of the created user groups.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.usergroup_create GroupName
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.usergroup_delete(usergroupids, **connection_args)
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBusergroupids\fP \-\- IDs of the user groups to delete
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
IDs of the deleted user groups.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.usergroup_delete 28
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.usergroup_exists(name=None, node=None, nodeids=None, **connection_args)
Checks if at least one user group that matches the given filter criteria exists
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- names of the user groups
.IP \(bu 2
\fBnode\fP \-\- name of the node the user groups must belong to (This will override the nodeids parameter.)
.IP \(bu 2
\fBnodeids\fP \-\- IDs of the nodes the user groups must belong to
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
True if at least one user group that matches the given filter criteria exists, else False.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.usergroup_exists Guests
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.usergroup_get(name=None, usrgrpids=None, userids=None, **connection_args)
New in version 2016.3.0.

.sp
Retrieve user groups according to the given parameters
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all usergroup_get properties: keyword argument
names differ depending on your zabbix version, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- names of the user groups
.IP \(bu 2
\fBusrgrpids\fP \-\- return only user groups with the given IDs
.IP \(bu 2
\fBuserids\fP \-\- return only user groups that contain the given users
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
Array with convenient user groups details, False if no user group found or on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.usergroup_get Guests
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.usergroup_list(**connection_args)
Retrieve all enabled user groups.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
Array with enabled user groups details, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.usergroup_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.usergroup_update(usrgrpid, **connection_args)
New in version 2016.3.0.

.sp
Update existing user group
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function accepts all standard user group properties: keyword
argument names differ depending on your zabbix version, see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBusrgrpid\fP \-\- ID of the user group to update.
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
IDs of the updated user group, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.usergroup_update 8 name=guestsRenamed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.usermacro_create(macro, value, hostid, **connection_args)
Create new host usermacro.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmacro\fP \-\- name of the host usermacro
.IP \(bu 2
\fBvalue\fP \-\- value of the host usermacro
.IP \(bu 2
\fBhostid\fP \-\- hostid or templateid
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.sp
return: ID of the created host usermacro.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.usermacro_create \(aq{$SNMP_COMMUNITY}\(aq \(aqpublic\(aq 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.usermacro_createglobal(macro, value, **connection_args)
Create new global usermacro.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmacro\fP \-\- name of the global usermacro
.IP \(bu 2
\fBvalue\fP \-\- value of the global usermacro
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.sp
return: ID of the created global usermacro.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.usermacro_createglobal \(aq{$SNMP_COMMUNITY}\(aq \(aqpublic\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.usermacro_delete(macroids, **connection_args)
Delete host usermacros.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmacroids\fP \-\- macroids of the host usermacros
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.sp
return: IDs of the deleted host usermacro.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.usermacro_delete 21
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.usermacro_deleteglobal(macroids, **connection_args)
Delete global usermacros.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmacroids\fP \-\- macroids of the global usermacros
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.sp
return: IDs of the deleted global usermacro.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.usermacro_deleteglobal 21
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.usermacro_get(macro=None, hostids=None, templateids=None, hostmacroids=None, globalmacroids=None, globalmacro=False, **connection_args)
Retrieve user macros according to the given parameters.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmacro\fP \-\- name of the usermacro
.IP \(bu 2
\fBhostids\fP \-\- Return macros for the given hostids
.IP \(bu 2
\fBtemplateids\fP \-\- Return macros for the given templateids
.IP \(bu 2
\fBhostmacroids\fP \-\- Return macros with the given hostmacroids
.IP \(bu 2
\fBglobalmacroids\fP \-\- Return macros with the given globalmacroids (implies globalmacro=True)
.IP \(bu 2
\fBglobalmacro\fP \-\- if True, returns only global macros
.IP \(bu 2
\fBconnection_args\fP (\fIoptional\fP) \-\- _connection_user: zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
_connection_password: zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
_connection_url: url of zabbix frontend (can also be set in opts or pillar, see module\(aqs docstring)
.UNINDENT
.TP
.B Returns
Array with usermacro details, False if no usermacro found or on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.usermacro_get macro=\(aq{$SNMP_COMMUNITY}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.usermacro_update(hostmacroid, value, **connection_args)
Update existing host usermacro.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhostmacroid\fP \-\- id of the host usermacro
.IP \(bu 2
\fBvalue\fP \-\- new value of the host usermacro
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.sp
return: ID of the update host usermacro.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.usermacro_update 1 \(aqpublic\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zabbix.usermacro_updateglobal(globalmacroid, value, **connection_args)
Update existing global usermacro.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBglobalmacroid\fP \-\- id of the host usermacro
.IP \(bu 2
\fBvalue\fP \-\- new value of the host usermacro
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.sp
return: ID of the update global usermacro.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zabbix.usermacro_updateglobal 1 \(aqpublic\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.zcbuildout
.sp
Management of zc.buildout
.sp
New in version 2014.1.0.

.sp
This module is inspired by \fI\%minitage\(aqs buildout maker\fP
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The zc.buildout integration is still in beta; the API is subject to change
.UNINDENT
.UNINDENT
.SS General notes
.sp
You have those following methods:
.INDENT 0.0
.IP \(bu 2
upgrade_bootstrap
.IP \(bu 2
bootstrap
.IP \(bu 2
run_buildout
.IP \(bu 2
buildout
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zcbuildout.bootstrap(*a, **kw)
Run the buildout bootstrap dance (python bootstrap.py).
.INDENT 7.0
.TP
.B directory
directory to execute in
.TP
.B config
alternative buildout configuration file to use
.TP
.B runas
User used to run buildout as
.TP
.B env
environment variables to set when running
.TP
.B buildout_ver
force a specific buildout version (1 | 2)
.TP
.B test_release
buildout accept test release
.TP
.B offline
are we executing buildout in offline mode
.TP
.B distribute
Forcing use of distribute
.TP
.B new_st
Forcing use of setuptools >= 0.7
.TP
.B python
path to a python executable to use in place of default (salt one)
.TP
.B onlyif
Only execute cmd if statement on the host return 0
.TP
.B unless
Do not execute cmd if statement on the host return 0
.TP
.B use_vt
Use the new salt VT to stream output [experimental]
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq buildout.bootstrap /srv/mybuildout
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zcbuildout.buildout(*a, **kw)
Run buildout in a directory.
.INDENT 7.0
.TP
.B directory
directory to execute in
.TP
.B config
buildout config to use
.TP
.B parts
specific buildout parts to run
.TP
.B runas
user used to run buildout as
.TP
.B env
environment variables to set when running
.TP
.B buildout_ver
force a specific buildout version (1 | 2)
.TP
.B test_release
buildout accept test release
.TP
.B new_st
Forcing use of setuptools >= 0.7
.TP
.B distribute
use distribute over setuptools if possible
.TP
.B offline
does buildout run offline
.TP
.B python
python to use
.TP
.B debug
run buildout with \-D debug flag
.TP
.B onlyif
Only execute cmd if statement on the host return 0
.TP
.B unless
Do not execute cmd if statement on the host return 0
.TP
.B newest
run buildout in newest mode
.TP
.B verbose
run buildout in verbose mode (\-vvvvv)
.TP
.B use_vt
Use the new salt VT to stream output [experimental]
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq buildout.buildout /srv/mybuildout
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zcbuildout.run_buildout(*a, **kw)
Run a buildout in a directory.
.INDENT 7.0
.TP
.B directory
directory to execute in
.TP
.B config
alternative buildout configuration file to use
.TP
.B offline
are we executing buildout in offline mode
.TP
.B runas
user used to run buildout as
.TP
.B env
environment variables to set when running
.TP
.B onlyif
Only execute cmd if statement on the host return 0
.TP
.B unless
Do not execute cmd if statement on the host return 0
.TP
.B newest
run buildout in newest mode
.TP
.B force
run buildout unconditionally
.TP
.B verbose
run buildout in verbose mode (\-vvvvv)
.TP
.B use_vt
Use the new salt VT to stream output [experimental]
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq buildout.run_buildout /srv/mybuildout
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zcbuildout.upgrade_bootstrap(*a, **kw)
Upgrade current bootstrap.py with the last released one.
.sp
Indeed, when we first run a buildout, a common source of problem
is to have a locally stale bootstrap, we just try to grab a new copy
.INDENT 7.0
.TP
.B directory
directory to execute in
.TP
.B offline
are we executing buildout in offline mode
.TP
.B buildout_ver
forcing to use a specific buildout version (1 | 2)
.TP
.B onlyif
Only execute cmd if statement on the host return 0
.TP
.B unless
Do not execute cmd if statement on the host return 0
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq buildout.upgrade_bootstrap /srv/mybuildout
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.zenoss
.sp
Module for working with the Zenoss API
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B configuration
This module requires a \(aqzenoss\(aq entry in the master/minion config.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zenoss:
  hostname: https://zenoss.example.com
  username: admin
  password: admin123
  verify_ssl: True
  ca_bundle: /etc/ssl/certs/ca\-certificates.crt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zenoss.add_device(device=None, device_class=None, collector=\(aqlocalhost\(aq, prod_state=1000)
A function to connect to a zenoss server and add a new device entry.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdevice\fP \-\- (Optional) Will use the grain \(aqfqdn\(aq by default.
.IP \(bu 2
\fBdevice_class\fP \-\- (Optional) The device class to use. If none, will determine based on kernel grain.
.IP \(bu 2
\fBcollector\fP \-\- (Optional) The collector to use for this device. Defaults to \(aqlocalhost\(aq.
.IP \(bu 2
\fBprod_state\fP \-\- (Optional) The prodState to set on the device. If none, defaults to 1000 ( production )
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zenoss.add_device
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zenoss.device_exists(device=None)
Check to see if a device already exists in Zenoss.
.INDENT 7.0
.TP
.B Parameters
\fBdevice\fP \-\- (Optional) Will use the grain \(aqfqdn\(aq by default
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zenoss.device_exists
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zenoss.find_device(device=None)
Find a device in Zenoss. If device not found, returns None.
.INDENT 7.0
.TP
.B Parameters
\fBdevice\fP \-\- (Optional) Will use the grain \(aqfqdn\(aq by default
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zenoss.find_device
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zenoss.set_prod_state(prod_state, device=None)
A function to set the prod_state in zenoss.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprod_state\fP \-\- (Required) Integer value of the state
.IP \(bu 2
\fBdevice\fP \-\- (Optional) Will use the grain \(aqfqdn\(aq by default.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt zenoss.set_prod_state 1000 hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.zfs
.sp
Module for running ZFS command
.INDENT 0.0
.TP
.B codeauthor
Nitin Madhok <\fI\%nmadhok@g.clemson.edu\fP>, Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B depends
salt.utils.zfs
.TP
.B platform
illumos,freebsd,linux
.UNINDENT
.sp
Changed in version 2018.3.1: Big refactor to remove duplicate code, better type conversions and improved
consistency in output.

.INDENT 0.0
.TP
.B salt.modules.zfs.bookmark(snapshot, bookmark)
Creates a bookmark of the given snapshot
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Bookmarks mark the point in time when the snapshot was created,
and can be used as the incremental source for a zfs send command.
.sp
This feature must be enabled to be used. See zpool\-features(5) for
details on ZFS feature flags and the bookmarks feature.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B snapshot
string
name of snapshot to bookmark
.TP
.B bookmark
string
name of bookmark
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.bookmark myzpool/mydataset@yesterday myzpool/mydataset#complete
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.clone(name_a, name_b, **kwargs)
Creates a clone of the given snapshot.
.INDENT 7.0
.TP
.B name_a
string
name of snapshot
.TP
.B name_b
string
name of filesystem or volume
.TP
.B create_parent
boolean
creates all the non\-existing parent datasets. any property specified on the
command line using the \-o option is ignored.
.TP
.B properties
dict
additional zfs properties (\-o)
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
ZFS properties can be specified at the time of creation of the filesystem by
passing an additional argument called \(dqproperties\(dq and specifying the properties
with their respective values in the form of a python dictionary:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
properties=\(dq{\(aqproperty1\(aq: \(aqvalue1\(aq, \(aqproperty2\(aq: \(aqvalue2\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.clone myzpool/mydataset@yesterday myzpool/mydataset_yesterday
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.create(name, **kwargs)
Create a ZFS File System.
.INDENT 7.0
.TP
.B name
string
name of dataset or volume
.TP
.B volume_size
string
if specified, a zvol will be created instead of a dataset
.TP
.B sparse
boolean
create sparse volume
.TP
.B create_parent
boolean
creates all the non\-existing parent datasets. any property specified on the
command line using the \-o option is ignored.
.TP
.B properties
dict
additional zfs properties (\-o)
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
ZFS properties can be specified at the time of creation of the filesystem by
passing an additional argument called \(dqproperties\(dq and specifying the properties
with their respective values in the form of a python dictionary:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
properties=\(dq{\(aqproperty1\(aq: \(aqvalue1\(aq, \(aqproperty2\(aq: \(aqvalue2\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.create myzpool/mydataset [create_parent=True|False]
salt \(aq*\(aq zfs.create myzpool/mydataset properties=\(dq{\(aqmountpoint\(aq: \(aq/export/zfs\(aq, \(aqsharenfs\(aq: \(aqon\(aq}\(dq
salt \(aq*\(aq zfs.create myzpool/volume volume_size=1G [sparse=True|False]\(ga
salt \(aq*\(aq zfs.create myzpool/volume volume_size=1G properties=\(dq{\(aqvolblocksize\(aq: \(aq512\(aq}\(dq [sparse=True|False]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.destroy(name, **kwargs)
Destroy a ZFS File System.
.INDENT 7.0
.TP
.B name
string
name of dataset, volume, or snapshot
.TP
.B force
boolean
force an unmount of any file systems using the unmount \-f command.
.TP
.B recursive
boolean
recursively destroy all children. (\-r)
.TP
.B recursive_all
boolean
recursively destroy all dependents, including cloned file systems
outside the target hierarchy. (\-R)
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
watch out when using recursive and recursive_all
.UNINDENT
.UNINDENT
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.destroy myzpool/mydataset [force=True|False]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.diff(name_a, name_b=None, **kwargs)
Display the difference between a snapshot of a given filesystem and
another snapshot of that filesystem from a later time or the current
contents of the filesystem.
.INDENT 7.0
.TP
.B name_a
string
name of snapshot
.TP
.B name_b
string
(optional) name of snapshot or filesystem
.TP
.B show_changetime
boolean
display the path\(aqs inode change time as the first column of output. (default = True)
.TP
.B show_indication
boolean
display an indication of the type of file. (default = True)
.TP
.B parsable
boolean
if true we don\(aqt parse the timestamp to a more readable date (default = True)
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.diff myzpool/mydataset@yesterday myzpool/mydataset
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.exists(name, **kwargs)
Check if a ZFS filesystem or volume or snapshot exists.
.INDENT 7.0
.TP
.B name
string
name of dataset
.TP
.B type
string
also check if dataset is of a certain type, valid choices are:
filesystem, snapshot, volume, bookmark, or all.
.UNINDENT
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.exists myzpool/mydataset
salt \(aq*\(aq zfs.exists myzpool/myvolume type=volume
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.get(*dataset, **kwargs)
Displays properties for the given datasets.
.INDENT 7.0
.TP
.B dataset
string
name of snapshot(s), filesystem(s), or volume(s)
.TP
.B properties
string
comma\-separated list of properties to list, defaults to all
.TP
.B recursive
boolean
recursively list children
.TP
.B depth
int
recursively list children to depth
.TP
.B fields
string
comma\-separated list of fields to include, the name and property field will always be added
.TP
.B type
string
comma\-separated list of types to display, where type is one of
filesystem, snapshot, volume, bookmark, or all.
.sp
Changed in version 3004.

.sp
type is ignored on Solaris 10 and 11 since not a valid parameter on those platforms
.TP
.B source
string
comma\-separated list of sources to display. Must be one of the following:
local, default, inherited, temporary, and none. The default value is all sources.
.TP
.B parsable
boolean
display numbers in parsable (exact) values (default = True)
\&.. versionadded:: 2018.3.0
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If no datasets are specified, then the command displays properties
for all datasets on the system.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.get
salt \(aq*\(aq zfs.get myzpool/mydataset [recursive=True|False]
salt \(aq*\(aq zfs.get myzpool/mydataset properties=\(dqsharenfs,mountpoint\(dq [recursive=True|False]
salt \(aq*\(aq zfs.get myzpool/mydataset myzpool/myotherdataset properties=available fields=value depth=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.hold(tag, *snapshot, **kwargs)
Adds a single reference, named with the tag argument, to the specified
snapshot or snapshots.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Each snapshot has its own tag namespace, and tags must be unique within that space.
.sp
If a hold exists on a snapshot, attempts to destroy that snapshot by
using the zfs destroy command return EBUSY.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B tag
string
name of tag
.TP
.B snapshot
string
name of snapshot(s)
.TP
.B recursive
boolean
specifies that a hold with the given tag is applied recursively to
the snapshots of all descendent file systems.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
Changed in version 2018.3.1.

.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
As of 2018.3.1 the tag parameter no longer accepts a comma\-separated value.
It\(aqs is now possible to create a tag that contains a comma, this was impossible before.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.hold mytag myzpool/mydataset@mysnapshot [recursive=True]
salt \(aq*\(aq zfs.hold mytag myzpool/mydataset@mysnapshot myzpool/mydataset@myothersnapshot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.holds(snapshot, **kwargs)
Lists all existing user references for the given snapshot or snapshots.
.INDENT 7.0
.TP
.B snapshot
string
name of snapshot
.TP
.B recursive
boolean
lists the holds that are set on the named descendent snapshots also.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.holds myzpool/mydataset@baseline
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.inherit(prop, name, **kwargs)
Clears the specified property
.INDENT 7.0
.TP
.B prop
string
name of property
.TP
.B name
string
name of the filesystem, volume, or snapshot
.TP
.B recursive
boolean
recursively inherit the given property for all children.
.TP
.B revert
boolean
revert the property to the received value if one exists; otherwise
operate as if the \-S option was not specified.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.inherit canmount myzpool/mydataset [recursive=True|False]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.list_(name=None, **kwargs)
Return a list of all datasets or a specified dataset on the system and the
values of their used, available, referenced, and mountpoint properties.
.INDENT 7.0
.TP
.B name
string
name of dataset, volume, or snapshot
.TP
.B recursive
boolean
recursively list children
.TP
.B depth
int
limit recursion to depth
.TP
.B properties
string
comma\-separated list of properties to list, the name property will always be added
.TP
.B type
string
comma\-separated list of types to display, where type is one of
filesystem, snapshot, volume, bookmark, or all.
.TP
.B sort
string
property to sort on (default = name)
.TP
.B order
string [ascending|descending]
sort order (default = ascending)
.TP
.B parsable
boolean
display numbers in parsable (exact) values
\&.. versionadded:: 2018.3.0
.UNINDENT
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.list
salt \(aq*\(aq zfs.list myzpool/mydataset [recursive=True|False]
salt \(aq*\(aq zfs.list myzpool/mydataset properties=\(dqsharenfs,mountpoint\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.list_mount()
List mounted zfs filesystems
.sp
New in version 2018.3.1.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.list_mount
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.mount(name=None, **kwargs)
Mounts ZFS file systems
.INDENT 7.0
.TP
.B name
string
name of the filesystem, having this set to None will mount all filesystems. (this is the default)
.TP
.B overlay
boolean
perform an overlay mount.
.TP
.B options
string
optional comma\-separated list of mount options to use temporarily for
the duration of the mount.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
Changed in version 2018.3.1.

.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Passing \(aq\-a\(aq as name is deprecated and will be removed in 3001.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.mount
salt \(aq*\(aq zfs.mount myzpool/mydataset
salt \(aq*\(aq zfs.mount myzpool/mydataset options=ro
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.promote(name)
Promotes a clone file system to no longer be dependent on its \(dqorigin\(dq
snapshot.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This makes it possible to destroy the file system that the
clone was created from. The clone parent\-child dependency relationship
is reversed, so that the origin file system becomes a clone of the
specified file system.
.sp
The snapshot that was cloned, and any snapshots previous to this
snapshot, are now owned by the promoted clone. The space they use moves
from the origin file system to the promoted clone, so enough space must
be available to accommodate these snapshots. No new space is consumed
by this operation, but the space accounting is adjusted. The promoted
clone must not have any conflicting snapshot names of its own. The
rename subcommand can be used to rename any conflicting snapshots.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
string
name of clone\-filesystem
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.promote myzpool/myclone
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.release(tag, *snapshot, **kwargs)
Removes a single reference, named with the tag argument, from the
specified snapshot or snapshots.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The tag must already exist for each snapshot.
If a hold exists on a snapshot, attempts to destroy that
snapshot by using the zfs destroy command return EBUSY.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B tag
string
name of tag
.TP
.B snapshot
string
name of snapshot(s)
.TP
.B recursive
boolean
recursively releases a hold with the given tag on the snapshots of
all descendent file systems.
.UNINDENT
.sp
New in version 2016.3.0.

.sp
Changed in version 2018.3.1.

.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
As of 2018.3.1 the tag parameter no longer accepts a comma\-separated value.
It\(aqs is now possible to create a tag that contains a comma, this was impossible before.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.release mytag myzpool/mydataset@mysnapshot [recursive=True]
salt \(aq*\(aq zfs.release mytag myzpool/mydataset@mysnapshot myzpool/mydataset@myothersnapshot
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.rename(name, new_name, **kwargs)
Rename or Relocate a ZFS File System.
.INDENT 7.0
.TP
.B name
string
name of dataset, volume, or snapshot
.TP
.B new_name
string
new name of dataset, volume, or snapshot
.TP
.B force
boolean
force unmount any filesystems that need to be unmounted in the process.
.TP
.B create_parent
boolean
creates all the nonexistent parent datasets. Datasets created in
this manner are automatically mounted according to the mountpoint
property inherited from their parent.
.TP
.B recursive
boolean
recursively rename the snapshots of all descendent datasets.
snapshots are the only dataset that can be renamed recursively.
.UNINDENT
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.rename myzpool/mydataset myzpool/renameddataset
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.rollback(name, **kwargs)
Roll back the given dataset to a previous snapshot.
.INDENT 7.0
.TP
.B name
string
name of snapshot
.TP
.B recursive
boolean
destroy any snapshots and bookmarks more recent than the one
specified.
.TP
.B recursive_all
boolean
destroy any more recent snapshots and bookmarks, as well as any
clones of those snapshots.
.TP
.B force
boolean
used with the \-R option to force an unmount of any clone file
systems that are to be destroyed.
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
When a dataset is rolled back, all data that has changed since
the snapshot is discarded, and the dataset reverts to the state
at the time of the snapshot. By default, the command refuses to
roll back to a snapshot other than the most recent one.
.sp
In order to do so, all intermediate snapshots and bookmarks
must be destroyed by specifying the \-r option.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.rollback myzpool/mydataset@yesterday
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.set(*dataset, **kwargs)
Sets the property or list of properties to the given value(s) for each dataset.
.INDENT 7.0
.TP
.B dataset
string
name of snapshot(s), filesystem(s), or volume(s)
.TP
.B properties
string
additional zfs properties pairs
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
properties are passed as key\-value pairs. e.g.
.INDENT 0.0
.INDENT 3.5
compression=off
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Only some properties can be edited.
.sp
See the Properties section for more information on what properties
can be set and acceptable values.
.sp
Numeric values can be specified as exact values, or in a human\-readable
form with a suffix of B, K, M, G, T, P, E (for bytes, kilobytes,
megabytes, gigabytes, terabytes, petabytes, or exabytes respectively).
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.set myzpool/mydataset compression=off
salt \(aq*\(aq zfs.set myzpool/mydataset myzpool/myotherdataset compression=off
salt \(aq*\(aq zfs.set myzpool/mydataset myzpool/myotherdataset compression=lz4 canmount=off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.snapshot(*snapshot, **kwargs)
Creates snapshots with the given names.
.INDENT 7.0
.TP
.B snapshot
string
name of snapshot(s)
.TP
.B recursive
boolean
recursively create snapshots of all descendent datasets.
.TP
.B properties
dict
additional zfs properties (\-o)
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
ZFS properties can be specified at the time of creation of the filesystem by
passing an additional argument called \(dqproperties\(dq and specifying the properties
with their respective values in the form of a python dictionary:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
properties=\(dq{\(aqproperty1\(aq: \(aqvalue1\(aq, \(aqproperty2\(aq: \(aqvalue2\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.snapshot myzpool/mydataset@yesterday [recursive=True]
salt \(aq*\(aq zfs.snapshot myzpool/mydataset@yesterday myzpool/myotherdataset@yesterday [recursive=True]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zfs.unmount(name, **kwargs)
Unmounts ZFS file systems
.INDENT 7.0
.TP
.B name
string
name of the filesystem, you can use None to unmount all mounted filesystems.
.TP
.B force
boolean
forcefully unmount the file system, even if it is currently in use.
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Using \fB\-a\fP for the name parameter will probably break your system, unless your rootfs is not on zfs.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.sp
Changed in version 2018.3.1.

.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Passing \(aq\-a\(aq as name is deprecated and will be removed in 3001.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zfs.unmount myzpool/mydataset [force=True|False]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.zk_concurrency
.SS Concurrency controls in zookeeper
.INDENT 0.0
.TP
.B depends
kazoo
.TP
.B configuration
See \fI\%salt.modules.zookeeper\fP for setup instructions.
.UNINDENT
.sp
This module allows you to acquire and release a slot. This is primarily useful
for ensureing that no more than N hosts take a specific action at once. This can
also be used to coordinate between masters.
.INDENT 0.0
.TP
.B salt.modules.zk_concurrency.lock(path, zk_hosts=None, identifier=None, max_concurrency=1, timeout=None, ephemeral_lease=False, force=False, profile=None, scheme=None, username=None, password=None, default_acl=None)
Get lock (with optional timeout)
.INDENT 7.0
.TP
.B path
The path in zookeeper where the lock is
.TP
.B zk_hosts
zookeeper connect string
.TP
.B identifier
Name to identify this minion, if unspecified defaults to the hostname
.TP
.B max_concurrency
Maximum number of lock holders
.TP
.B timeout
timeout to wait for the lock. A None timeout will block forever
.TP
.B ephemeral_lease
Whether the locks in zookeper should be ephemeral
.TP
.B force
Forcibly acquire the lock regardless of available slots
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion zk_concurrency.lock /lock/path host1:1234,host2:1234
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zk_concurrency.lock_holders(path, zk_hosts=None, identifier=None, max_concurrency=1, timeout=None, ephemeral_lease=False, profile=None, scheme=None, username=None, password=None, default_acl=None)
Return an un\-ordered list of lock holders
.INDENT 7.0
.TP
.B path
The path in zookeeper where the lock is
.TP
.B zk_hosts
zookeeper connect string
.TP
.B identifier
Name to identify this minion, if unspecified defaults to hostname
.TP
.B max_concurrency
Maximum number of lock holders
.TP
.B timeout
timeout to wait for the lock. A None timeout will block forever
.TP
.B ephemeral_lease
Whether the locks in zookeper should be ephemeral
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion zk_concurrency.lock_holders /lock/path host1:1234,host2:1234
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zk_concurrency.party_members(path, zk_hosts=None, min_nodes=1, blocking=False, profile=None, scheme=None, username=None, password=None, default_acl=None)
Get the List of identifiers in a particular party, optionally waiting for the
specified minimum number of nodes (min_nodes) to appear
.INDENT 7.0
.TP
.B path
The path in zookeeper where the lock is
.TP
.B zk_hosts
zookeeper connect string
.TP
.B min_nodes
The minimum number of nodes expected to be present in the party
.TP
.B blocking
The boolean indicating if we need to block until min_nodes are available
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion zk_concurrency.party_members /lock/path host1:1234,host2:1234
salt minion zk_concurrency.party_members /lock/path host1:1234,host2:1234 min_nodes=3 blocking=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zk_concurrency.unlock(path, zk_hosts=None, identifier=None, max_concurrency=1, ephemeral_lease=False, scheme=None, profile=None, username=None, password=None, default_acl=None)
Remove lease from semaphore
.INDENT 7.0
.TP
.B path
The path in zookeeper where the lock is
.TP
.B zk_hosts
zookeeper connect string
.TP
.B identifier
Name to identify this minion, if unspecified defaults to hostname
.TP
.B max_concurrency
Maximum number of lock holders
.TP
.B timeout
timeout to wait for the lock. A None timeout will block forever
.TP
.B ephemeral_lease
Whether the locks in zookeper should be ephemeral
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion zk_concurrency.unlock /lock/path host1:1234,host2:1234
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.znc
.sp
znc \- An advanced IRC bouncer
.sp
New in version 2014.7.0.

.sp
Provides an interface to basic ZNC functionality
.INDENT 0.0
.TP
.B salt.modules.znc.buildmod(*modules)
Build module using znc\-buildmod
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq znc.buildmod module.cpp [...]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.znc.dumpconf()
Write the active configuration state to config file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq znc.dumpconf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.znc.rehashconf()
Rehash the active configuration state from config file
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq znc.rehashconf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.znc.version()
Return server version from znc \-\-version
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq znc.version
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.zoneadm
.sp
Module for Solaris 10\(aqs zoneadm
.INDENT 0.0
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B platform
OmniOS,OpenIndiana,SmartOS,OpenSolaris,Solaris 10
.UNINDENT
.sp
New in version 2017.7.0.

.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Oracle Solaris 11\(aqs zoneadm is not supported by this module!
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zoneadm.attach(zone, force=False, brand_opts=None)
Attach the specified zone.
.INDENT 7.0
.TP
.B zone
string
name of the zone
.TP
.B force
boolean
force the zone into the \(dqinstalled\(dq state with no validation
.TP
.B brand_opts
string
brand specific options to pass
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zoneadm.attach lawrence
salt \(aq*\(aq zoneadm.attach lawrence True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zoneadm.boot(zone, single=False, altinit=None, smf_options=None)
Boot (or activate) the specified zone.
.INDENT 7.0
.TP
.B zone
string
name or uuid of the zone
.TP
.B single
boolean
boots only to milestone svc:/milestone/single\-user:default.
.TP
.B altinit
string
valid path to an alternative executable to be the primordial process.
.TP
.B smf_options
string
include two categories of options to control booting behavior of
the service management facility: recovery options and messages options.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zoneadm.boot clementine
salt \(aq*\(aq zoneadm.boot maeve single=True
salt \(aq*\(aq zoneadm.boot teddy single=True smf_options=verbose
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zoneadm.clone(zone, source, snapshot=None)
Install a zone by copying an existing installed zone.
.INDENT 7.0
.TP
.B zone
string
name of the zone
.TP
.B source
string
zone to clone from
.TP
.B snapshot
string
optional name of snapshot to use as source
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zoneadm.clone clementine dolores
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zoneadm.detach(zone)
Detach the specified zone.
.INDENT 7.0
.TP
.B zone
string
name or uuid of the zone
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zoneadm.detach kissy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zoneadm.halt(zone)
Halt the specified zone.
.INDENT 7.0
.TP
.B zone
string
name or uuid of the zone
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To cleanly shutdown the zone use the shutdown function.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zoneadm.halt hector
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zoneadm.install(zone, nodataset=False, brand_opts=None)
Install the specified zone from the system.
.INDENT 7.0
.TP
.B zone
string
name of the zone
.TP
.B nodataset
boolean
do not create a ZFS file system
.TP
.B brand_opts
string
brand specific options to pass
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zoneadm.install dolores
salt \(aq*\(aq zoneadm.install teddy True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zoneadm.list_zones(verbose=True, installed=False, configured=False, hide_global=True)
List all zones
.INDENT 7.0
.TP
.B verbose
boolean
display additional zone information
.TP
.B installed
boolean
include installed zones in output
.TP
.B configured
boolean
include configured zones in output
.TP
.B hide_global
boolean
do not include global zone
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zoneadm.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zoneadm.move(zone, zonepath)
Move zone to new zonepath.
.INDENT 7.0
.TP
.B zone
string
name or uuid of the zone
.TP
.B zonepath
string
new zonepath
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zoneadm.move meave /sweetwater/meave
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zoneadm.ready(zone)
Prepares a zone for running applications.
.INDENT 7.0
.TP
.B zone
string
name or uuid of the zone
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zoneadm.ready clementine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zoneadm.reboot(zone, single=False, altinit=None, smf_options=None)
Restart the zone. This is equivalent to a halt boot sequence.
.INDENT 7.0
.TP
.B zone
string
name or uuid of the zone
.TP
.B single
boolean
boots only to milestone svc:/milestone/single\-user:default.
.TP
.B altinit
string
valid path to an alternative executable to be the primordial process.
.TP
.B smf_options
string
include two categories of options to control booting behavior of
the service management facility: recovery options and messages options.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zoneadm.reboot dolores
salt \(aq*\(aq zoneadm.reboot teddy single=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zoneadm.shutdown(zone, reboot=False, single=False, altinit=None, smf_options=None)
Gracefully shutdown the specified zone.
.INDENT 7.0
.TP
.B zone
string
name or uuid of the zone
.TP
.B reboot
boolean
reboot zone after shutdown (equivalent of shutdown \-i6 \-g0 \-y)
.TP
.B single
boolean
boots only to milestone svc:/milestone/single\-user:default.
.TP
.B altinit
string
valid path to an alternative executable to be the primordial process.
.TP
.B smf_options
string
include two categories of options to control booting behavior of
the service management facility: recovery options and messages options.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zoneadm.shutdown peter
salt \(aq*\(aq zoneadm.shutdown armistice reboot=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zoneadm.uninstall(zone)
Uninstall the specified zone from the system.
.INDENT 7.0
.TP
.B zone
string
name or uuid of the zone
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The \-F flag is always used to avoid the prompts when uninstalling.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zoneadm.uninstall teddy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zoneadm.verify(zone)
Check to make sure the configuration of the specified
zone can safely be installed on the machine.
.INDENT 7.0
.TP
.B zone
string
name of the zone
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zoneadm.verify dolores
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.zonecfg
.sp
Module for Solaris 10\(aqs zonecfg
.INDENT 0.0
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B platform
OmniOS,OpenIndiana,SmartOS,OpenSolaris,Solaris 10
.TP
.B depend
salt.modules.file
.UNINDENT
.sp
New in version 2017.7.0.

.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Oracle Solaris 11\(aqs zonecfg is not supported by this module!
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zonecfg.add_resource(zone, resource_type, **kwargs)
Add a resource
.INDENT 7.0
.TP
.B zone
string
name of zone
.TP
.B resource_type
string
type of resource
.TP
.B kwargs
string|int|...
resource properties
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zonecfg.add_resource tallgeese rctl name=zone.max\-locked\-memory value=\(aq(priv=privileged,limit=33554432,action=deny)\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zonecfg.clear_property(zone, key)
Clear a property
.INDENT 7.0
.TP
.B zone
string
name of zone
.TP
.B key
string
name of property
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zonecfg.clear_property deathscythe cpu\-shares
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zonecfg.create(zone, brand, zonepath, force=False)
Create an in\-memory configuration for the specified zone.
.INDENT 7.0
.TP
.B zone
string
name of zone
.TP
.B brand
string
brand name
.TP
.B zonepath
string
path of zone
.TP
.B force
boolean
overwrite configuration
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zonecfg.create deathscythe ipkg /zones/deathscythe
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zonecfg.create_from_template(zone, template)
Create an in\-memory configuration from a template for the specified zone.
.INDENT 7.0
.TP
.B zone
string
name of zone
.TP
.B template
string
name of template
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
existing config will be overwritten!
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zonecfg.create_from_template leo tallgeese
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zonecfg.delete(zone)
Delete the specified configuration from memory and stable storage.
.INDENT 7.0
.TP
.B zone
string
name of zone
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zonecfg.delete epyon
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zonecfg.export(zone, path=None)
Export the configuration from memory to stable storage.
.INDENT 7.0
.TP
.B zone
string
name of zone
.TP
.B path
string
path of file to export to
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zonecfg.export epyon
salt \(aq*\(aq zonecfg.export epyon /zones/epyon.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zonecfg.import_(zone, path)
Import the configuration to memory from stable storage.
.INDENT 7.0
.TP
.B zone
string
name of zone
.TP
.B path
string
path of file to export to
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zonecfg.import epyon /zones/epyon.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zonecfg.info(zone, show_all=False)
Display the configuration from memory
.INDENT 7.0
.TP
.B zone
string
name of zone
.TP
.B show_all
boolean
also include calculated values like capped\-cpu, cpu\-shares, ...
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zonecfg.info tallgeese
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zonecfg.remove_resource(zone, resource_type, resource_key, resource_value)
Remove a resource
.INDENT 7.0
.TP
.B zone
string
name of zone
.TP
.B resource_type
string
type of resource
.TP
.B resource_key
string
key for resource selection
.TP
.B resource_value
string
value for resource selection
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Set resource_selector to None for resource that do not require one.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zonecfg.remove_resource tallgeese rctl name zone.max\-locked\-memory
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zonecfg.set_property(zone, key, value)
Set a property
.INDENT 7.0
.TP
.B zone
string
name of zone
.TP
.B key
string
name of property
.TP
.B value
string
value of property
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zonecfg.set_property deathscythe cpu\-shares 100
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zonecfg.update_resource(zone, resource_type, resource_selector, **kwargs)
Add a resource
.INDENT 7.0
.TP
.B zone
string
name of zone
.TP
.B resource_type
string
type of resource
.TP
.B resource_selector
string
unique resource identifier
.TP
.B kwargs
string|int|...
resource properties
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Set resource_selector to None for resource that do not require one.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zonecfg.update_resource tallgeese rctl name name=zone.max\-locked\-memory value=\(aq(priv=privileged,limit=33554432,action=deny)\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.zookeeper
.SS Zookeeper Module
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
new
.TP
.B platform
all
.TP
.B depends
kazoo
.UNINDENT
.sp
New in version 2018.3.0.

.SS Configuration
.INDENT 0.0
.TP
.B configuration
This module is not usable until the following are specified
either in a pillar or in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zookeeper:
  hosts: zoo1,zoo2,zoo3
  default_acl:
    \- username: daniel
      password: test
      read: true
      write: true
      create: true
      delete: true
      admin: true
  username: daniel
  password: test
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If configuration for multiple zookeeper environments is required, they can
be set up as different configuration profiles. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zookeeper:
  prod:
    hosts: zoo1,zoo2,zoo3
    default_acl:
      \- username: daniel
        password: test
        read: true
        write: true
        create: true
        delete: true
        admin: true
    username: daniel
    password: test
  dev:
    hosts:
      \- dev1
      \- dev2
      \- dev3
    default_acl:
      \- username: daniel
        password: test
        read: true
        write: true
        create: true
        delete: true
        admin: true
    username: daniel
    password: test
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zookeeper.create(path, value=\(aq\(aq, acls=None, ephemeral=False, sequence=False, makepath=False, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None)
Create Znode
.INDENT 7.0
.TP
.B path
path of znode to create
.TP
.B value
value to assign to znode (Default: \(aq\(aq)
.TP
.B acls
list of acl dictionaries to be assigned (Default: None)
.TP
.B ephemeral
indicate node is ephemeral (Default: False)
.TP
.B sequence
indicate node is suffixed with a unique index (Default: False)
.TP
.B makepath
Create parent paths if they do not exist (Default: False)
.TP
.B profile
Configured Zookeeper profile to authenticate with (Default: None)
.TP
.B hosts
Lists of Zookeeper Hosts (Default: \(aq127.0.0.1:2181)
.TP
.B scheme
Scheme to authenticate with (Default: \(aqdigest\(aq)
.TP
.B username
Username to authenticate (Default: None)
.TP
.B password
Password to authenticate (Default: None)
.TP
.B default_acl
Default acls to assign if a node is created in this connection (Default: None)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion1 zookeeper.create /test/name daniel profile=prod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zookeeper.delete(path, version=\-1, recursive=False, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None)
Delete znode
.INDENT 7.0
.TP
.B path
path to znode
.TP
.B version
only delete if version matches (Default: \-1 (always matches))
.TP
.B profile
Configured Zookeeper profile to authenticate with (Default: None)
.TP
.B hosts
Lists of Zookeeper Hosts (Default: \(aq127.0.0.1:2181)
.TP
.B scheme
Scheme to authenticate with (Default: \(aqdigest\(aq)
.TP
.B username
Username to authenticate (Default: None)
.TP
.B password
Password to authenticate (Default: None)
.TP
.B default_acl
Default acls to assign if a node is created in this connection (Default: None)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion1 zookeeper.delete /test/name profile=prod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zookeeper.ensure_path(path, acls=None, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None)
Ensure Znode path exists
.INDENT 7.0
.TP
.B path
Parent path to create
.TP
.B acls
list of acls dictionaries to be assigned (Default: None)
.TP
.B profile
Configured Zookeeper profile to authenticate with (Default: None)
.TP
.B hosts
Lists of Zookeeper Hosts (Default: \(aq127.0.0.1:2181)
.TP
.B scheme
Scheme to authenticate with (Default: \(aqdigest\(aq)
.TP
.B username
Username to authenticate (Default: None)
.TP
.B password
Password to authenticate (Default: None)
.TP
.B default_acl
Default acls to assign if a node is created in this connection (Default: None)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion1 zookeeper.ensure_path /test/name profile=prod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zookeeper.exists(path, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None)
Check if path exists
.INDENT 7.0
.TP
.B path
path to check
.TP
.B profile
Configured Zookeeper profile to authenticate with (Default: None)
.TP
.B hosts
Lists of Zookeeper Hosts (Default: \(aq127.0.0.1:2181)
.TP
.B scheme
Scheme to authenticate with (Default: \(aqdigest\(aq)
.TP
.B username
Username to authenticate (Default: None)
.TP
.B password
Password to authenticate (Default: None)
.TP
.B default_acl
Default acls to assign if a node is created in this connection (Default: None)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion1 zookeeper.exists /test/name profile=prod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zookeeper.get(path, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None)
Get value saved in znode
.INDENT 7.0
.TP
.B path
path to check
.TP
.B profile
Configured Zookeeper profile to authenticate with (Default: None)
.TP
.B hosts
Lists of Zookeeper Hosts (Default: \(aq127.0.0.1:2181)
.TP
.B scheme
Scheme to authenticate with (Default: \(aqdigest\(aq)
.TP
.B username
Username to authenticate (Default: None)
.TP
.B password
Password to authenticate (Default: None)
.TP
.B default_acl
Default acls to assign if a node is created in this connection (Default: None)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion1 zookeeper.get /test/name profile=prod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zookeeper.get_acls(path, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None)
Get acls on a znode
.INDENT 7.0
.TP
.B path
path to znode
.TP
.B profile
Configured Zookeeper profile to authenticate with (Default: None)
.TP
.B hosts
Lists of Zookeeper Hosts (Default: \(aq127.0.0.1:2181)
.TP
.B scheme
Scheme to authenticate with (Default: \(aqdigest\(aq)
.TP
.B username
Username to authenticate (Default: None)
.TP
.B password
Password to authenticate (Default: None)
.TP
.B default_acl
Default acls to assign if a node is created in this connection (Default: None)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion1 zookeeper.get_acls /test/name profile=prod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zookeeper.get_children(path, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None)
Get children in znode path
.INDENT 7.0
.TP
.B path
path to check
.TP
.B profile
Configured Zookeeper profile to authenticate with (Default: None)
.TP
.B hosts
Lists of Zookeeper Hosts (Default: \(aq127.0.0.1:2181)
.TP
.B scheme
Scheme to authenticate with (Default: \(aqdigest\(aq)
.TP
.B username
Username to authenticate (Default: None)
.TP
.B password
Password to authenticate (Default: None)
.TP
.B default_acl
Default acls to assign if a node is created in this connection (Default: None)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion1 zookeeper.get_children /test profile=prod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zookeeper.make_digest_acl(username, password, read=False, write=False, create=False, delete=False, admin=False, allperms=False)
Generate acl object
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is heavily used in the zookeeper state and probably is not useful as a cli module
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B username
username of acl
.TP
.B password
plain text password of acl
.TP
.B read
read acl
.TP
.B write
write acl
.TP
.B create
create acl
.TP
.B delete
delete acl
.TP
.B admin
admin acl
.TP
.B allperms
set all other acls to True
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion1 zookeeper.make_digest_acl username=daniel password=mypass allperms=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zookeeper.set(path, value, version=\-1, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None)
Update znode with new value
.INDENT 7.0
.TP
.B path
znode to update
.TP
.B value
value to set in znode
.TP
.B version
only update znode if version matches (Default: \-1 (always matches))
.TP
.B profile
Configured Zookeeper profile to authenticate with (Default: None)
.TP
.B hosts
Lists of Zookeeper Hosts (Default: \(aq127.0.0.1:2181)
.TP
.B scheme
Scheme to authenticate with (Default: \(aqdigest\(aq)
.TP
.B username
Username to authenticate (Default: None)
.TP
.B password
Password to authenticate (Default: None)
.TP
.B default_acl
Default acls to assign if a node is created in this connection (Default: None)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion1 zookeeper.set /test/name gtmanfred profile=prod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zookeeper.set_acls(path, acls, version=\-1, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None)
Set acls on a znode
.INDENT 7.0
.TP
.B path
path to znode
.TP
.B acls
list of acl dictionaries to set on the znode
.TP
.B version
only set acls if version matches (Default: \-1 (always matches))
.TP
.B profile
Configured Zookeeper profile to authenticate with (Default: None)
.TP
.B hosts
Lists of Zookeeper Hosts (Default: \(aq127.0.0.1:2181)
.TP
.B scheme
Scheme to authenticate with (Default: \(aqdigest\(aq)
.TP
.B username
Username to authenticate (Default: None)
.TP
.B password
Password to authenticate (Default: None)
.TP
.B default_acl
Default acls to assign if a node is created in this connection (Default: None)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion1 zookeeper.set_acls /test/name acls=\(aq[{\(dqusername\(dq: \(dqgtmanfred\(dq, \(dqpassword\(dq: \(dqtest\(dq, \(dqall\(dq: True}]\(aq profile=prod
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.zpool
.sp
Module for running ZFS zpool command
.INDENT 0.0
.TP
.B codeauthor
Nitin Madhok <\fI\%nmadhok@g.clemson.edu\fP>, Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B depends
salt.utils.zfs
.TP
.B platform
illumos,freebsd,linux
.UNINDENT
.sp
Changed in version 2018.3.1: Big refactor to remove duplicate code, better type conversions and improved
consistency in output.

.INDENT 0.0
.TP
.B salt.modules.zpool.add(zpool, *vdevs, **kwargs)
Add the specified vdev\(aqs to the given storage pool
.INDENT 7.0
.TP
.B zpool
string
Name of storage pool
.TP
.B vdevs
string
One or more devices
.TP
.B force
boolean
Forces use of device
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.add myzpool /path/to/vdev1 /path/to/vdev2 [...]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.attach(zpool, device, new_device, force=False)
Attach specified device to zpool
.INDENT 7.0
.TP
.B zpool
string
Name of storage pool
.TP
.B device
string
Existing device name too
.TP
.B new_device
string
New device name (to be attached to \fBdevice\fP)
.TP
.B force
boolean
Forces use of device
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.attach myzpool /path/to/vdev1 /path/to/vdev2 [...]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.clear(zpool, device=None)
Clears device errors in a pool.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The device must not be part of an active pool configuration.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B zpool
string
name of storage pool
.TP
.B device
string
(optional) specific device to clear
.UNINDENT
.sp
New in version 2018.3.1.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.clear mypool
salt \(aq*\(aq zpool.clear mypool /path/to/dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.create(zpool, *vdevs, **kwargs)
New in version 2015.5.0.

.sp
Create a simple zpool, a mirrored zpool, a zpool having nested VDEVs, a hybrid zpool with cache, spare and log drives or a zpool with RAIDZ\-1, RAIDZ\-2 or RAIDZ\-3
.INDENT 7.0
.TP
.B zpool
string
Name of storage pool
.TP
.B vdevs
string
One or move devices
.TP
.B force
boolean
Forces use of vdevs, even if they appear in use or specify a
conflicting replication level.
.TP
.B mountpoint
string
Sets the mount point for the root dataset
.TP
.B altroot
string
Equivalent to \(dq\-o cachefile=none,altroot=root\(dq
.TP
.B properties
dict
Additional pool properties
.TP
.B filesystem_properties
dict
Additional filesystem properties
.TP
.B createboot
boolean
create a boot partition
.sp
New in version 2018.3.0.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.create myzpool /path/to/vdev1 [...] [force=True|False]
salt \(aq*\(aq zpool.create myzpool mirror /path/to/vdev1 /path/to/vdev2 [...] [force=True|False]
salt \(aq*\(aq zpool.create myzpool raidz1 /path/to/vdev1 /path/to/vdev2 raidz2 /path/to/vdev3 /path/to/vdev4 /path/to/vdev5 [...] [force=True|False]
salt \(aq*\(aq zpool.create myzpool mirror /path/to/vdev1 [...] mirror /path/to/vdev2 /path/to/vdev3 [...] [force=True|False]
salt \(aq*\(aq zpool.create myhybridzpool mirror /tmp/file1 [...] log mirror /path/to/vdev1 [...] cache /path/to/vdev2 [...] spare /path/to/vdev3 [...] [force=True|False]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Zpool properties can be specified at the time of creation of the pool
by passing an additional argument called \(dqproperties\(dq and specifying
the properties with their respective values in the form of a python
dictionary:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
properties=\(dq{\(aqproperty1\(aq: \(aqvalue1\(aq, \(aqproperty2\(aq: \(aqvalue2\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Filesystem properties can be specified at the time of creation of the
pool by passing an additional argument called \(dqfilesystem_properties\(dq
and specifying the properties with their respective values in the form
of a python dictionary:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
filesystem_properties=\(dq{\(aqproperty1\(aq: \(aqvalue1\(aq, \(aqproperty2\(aq: \(aqvalue2\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.create myzpool /path/to/vdev1 [...] properties=\(dq{\(aqproperty1\(aq: \(aqvalue1\(aq, \(aqproperty2\(aq: \(aqvalue2\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.create myzpool /path/to/vdev1 [...] [force=True|False]
salt \(aq*\(aq zpool.create myzpool mirror /path/to/vdev1 /path/to/vdev2 [...] [force=True|False]
salt \(aq*\(aq zpool.create myzpool raidz1 /path/to/vdev1 /path/to/vdev2 raidz2 /path/to/vdev3 /path/to/vdev4 /path/to/vdev5 [...] [force=True|False]
salt \(aq*\(aq zpool.create myzpool mirror /path/to/vdev1 [...] mirror /path/to/vdev2 /path/to/vdev3 [...] [force=True|False]
salt \(aq*\(aq zpool.create myhybridzpool mirror /tmp/file1 [...] log mirror /path/to/vdev1 [...] cache /path/to/vdev2 [...] spare /path/to/vdev3 [...] [force=True|False]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.create_file_vdev(size, *vdevs)
Creates file based virtual devices for a zpool
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.create_file_vdev 7G /path/to/vdev1 [/path/to/vdev2] [...]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Depending on file size, the above command may take a while to return.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.destroy(zpool, force=False)
Destroys a storage pool
.INDENT 7.0
.TP
.B zpool
string
Name of storage pool
.TP
.B force
boolean
Force destroy of pool
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.destroy myzpool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.detach(zpool, device)
Detach specified device to zpool
.INDENT 7.0
.TP
.B zpool
string
Name of storage pool
.TP
.B device
string
Device to detach
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.detach myzpool /path/to/vdev1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.exists(zpool)
Check if a ZFS storage pool is active
.INDENT 7.0
.TP
.B zpool
string
Name of storage pool
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.exists myzpool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.export(*pools, **kwargs)
New in version 2015.5.0.

.sp
Export storage pools
.INDENT 7.0
.TP
.B pools
string
One or more storage pools to export
.TP
.B force
boolean
Force export of storage pools
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.export myzpool ... [force=True|False]
salt \(aq*\(aq zpool.export myzpool2 myzpool2 ... [force=True|False]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.get(zpool, prop=None, show_source=False, parsable=True)
New in version 2016.3.0.

.sp
Retrieves the given list of properties
.INDENT 7.0
.TP
.B zpool
string
Name of storage pool
.TP
.B prop
string
Optional name of property to retrieve
.TP
.B show_source
boolean
Show source of property
.TP
.B parsable
boolean
Display numbers in parsable (exact) values
.sp
New in version 2018.3.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.get myzpool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.healthy()
Check if all zpools are healthy
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.healthy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.history(zpool=None, internal=False, verbose=False)
New in version 2016.3.0.

.sp
Displays the command history of the specified pools, or all pools if no
pool is specified
.INDENT 7.0
.TP
.B zpool
string
Optional storage pool
.TP
.B internal
boolean
Toggle display of internally logged ZFS events
.TP
.B verbose
boolean
Toggle display of the user name, the hostname, and the zone in which
the operation was performed
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.upgrade myzpool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.import_(zpool=None, new_name=None, **kwargs)
New in version 2015.5.0.

.sp
Import storage pools or list pools available for import
.INDENT 7.0
.TP
.B zpool
string
Optional name of storage pool
.TP
.B new_name
string
Optional new name for the storage pool
.TP
.B mntopts
string
Comma\-separated list of mount options to use when mounting datasets
within the pool.
.TP
.B force
boolean
Forces import, even if the pool appears to be potentially active.
.TP
.B altroot
string
Equivalent to \(dq\-o cachefile=none,altroot=root\(dq
.TP
.B dir
string
Searches for devices or files in dir, multiple dirs can be specified as
follows: \fBdir=\(dqdir1,dir2\(dq\fP
.TP
.B no_mount
boolean
Import the pool without mounting any file systems.
.TP
.B only_destroyed
boolean
Imports destroyed pools only. This also sets \fBforce=True\fP\&.
.TP
.B recovery
bool|str
false: do not try to recovery broken pools
true: try to recovery the pool by rolling back the latest transactions
test: check if a pool can be recovered, but don\(aqt import it
nolog: allow import without log device, recent transactions might be lost
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If feature flags are not support this forced to the default of \(aqfalse\(aq
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
When recovery is set to \(aqtest\(aq the result will be have imported set to True if the pool
can be imported. The pool might also be imported if the pool was not broken to begin with.
.UNINDENT
.UNINDENT
.TP
.B properties
dict
Additional pool properties
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Zpool properties can be specified at the time of creation of the pool
by passing an additional argument called \(dqproperties\(dq and specifying
the properties with their respective values in the form of a python
dictionary:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
properties=\(dq{\(aqproperty1\(aq: \(aqvalue1\(aq, \(aqproperty2\(aq: \(aqvalue2\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.import [force=True|False]
salt \(aq*\(aq zpool.import myzpool [mynewzpool] [force=True|False]
salt \(aq*\(aq zpool.import myzpool dir=\(aq/tmp\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.iostat(zpool=None, sample_time=5, parsable=True)
Display I/O statistics for the given pools
.INDENT 7.0
.TP
.B zpool
string
optional name of storage pool
.TP
.B sample_time
int
seconds to capture data before output
default a sample of 5 seconds is used
.TP
.B parsable
boolean
display data in pythonc values (True, False, Bytes,...)
.UNINDENT
.sp
New in version 2016.3.0.

.sp
Changed in version 2018.3.1: Added \fB\(gaparsable\(ga\fP parameter that defaults to True

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.iostat myzpool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.labelclear(device, force=False)
New in version 2018.3.0.

.sp
Removes ZFS label information from the specified device
.INDENT 7.0
.TP
.B device
string
Device name; must not be part of an active pool configuration.
.TP
.B force
boolean
Treat exported or foreign devices as inactive
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.labelclear /path/to/dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.list_(properties=\(aqsize,alloc,free,cap,frag,health\(aq, zpool=None, parsable=True)
New in version 2015.5.0.

.sp
Return information about (all) storage pools
.INDENT 7.0
.TP
.B zpool
string
optional name of storage pool
.TP
.B properties
string
comma\-separated list of properties to list
.TP
.B parsable
boolean
display numbers in parsable (exact) values
.sp
New in version 2018.3.0.

.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fBname\fP property will always be included, while the \fBfrag\fP
property will get removed if not available
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B zpool
string
optional zpool
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Multiple storage pool can be provided as a space separated list
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.list
salt \(aq*\(aq zpool.list zpool=tank
salt \(aq*\(aq zpool.list \(aqsize,free\(aq
salt \(aq*\(aq zpool.list \(aqsize,free\(aq tank
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.offline(zpool, *vdevs, **kwargs)
New in version 2015.5.0.

.sp
Ensure that the specified devices are offline
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
By default, the \fBOFFLINE\fP state is persistent. The device remains
offline when the system is rebooted. To temporarily take a device
offline, use \fBtemporary=True\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B zpool
string
name of storage pool
.TP
.B vdevs
string
One or more devices
.TP
.B temporary
boolean
Enable temporarily offline
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.offline myzpool /path/to/vdev1 [...] [temporary=True|False]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.online(zpool, *vdevs, **kwargs)
New in version 2015.5.0.

.sp
Ensure that the specified devices are online
.INDENT 7.0
.TP
.B zpool
string
name of storage pool
.TP
.B vdevs
string
one or more devices
.TP
.B expand
boolean
Expand the device to use all available space.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the device is part of a mirror or raidz then all devices must be
expanded before the new space will become available to the pool.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.online myzpool /path/to/vdev1 [...]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.reguid(zpool)
Generates a new unique identifier for the pool
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
You must ensure that all devices in this pool are online and healthy
before performing this action.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B zpool
string
name of storage pool
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.reguid myzpool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.reopen(zpool)
Reopen all the vdevs associated with the pool
.INDENT 7.0
.TP
.B zpool
string
name of storage pool
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.reopen myzpool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.replace(zpool, old_device, new_device=None, force=False)
Replaces \fBold_device\fP with \fBnew_device\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is equivalent to attaching \fBnew_device\fP,
waiting for it to resilver, and then detaching \fBold_device\fP\&.
.sp
The size of \fBnew_device\fP must be greater than or equal to the minimum
size of all the devices in a mirror or raidz configuration.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B zpool
string
Name of storage pool
.TP
.B old_device
string
Old device to replace
.TP
.B new_device
string
Optional new device
.TP
.B force
boolean
Forces use of new_device, even if its appears to be in use.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.replace myzpool /path/to/vdev1 /path/to/vdev2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.scrub(zpool, stop=False, pause=False)
Scrub a storage pool
.INDENT 7.0
.TP
.B zpool
string
Name of storage pool
.TP
.B stop
boolean
If \fBTrue\fP, cancel ongoing scrub
.TP
.B pause
boolean
If \fBTrue\fP, pause ongoing scrub
.sp
New in version 2018.3.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Pause is only available on recent versions of ZFS.
.sp
If both \fBpause\fP and \fBstop\fP are \fBTrue\fP, then \fBstop\fP will
win.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.scrub myzpool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.set(zpool, prop, value)
Sets the given property on the specified pool
.INDENT 7.0
.TP
.B zpool
string
Name of storage pool
.TP
.B prop
string
Name of property to set
.TP
.B value
string
Value to set for the specified property
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.set myzpool readonly yes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.split(zpool, newzpool, **kwargs)
New in version 2018.3.0.

.sp
Splits devices off pool creating newpool.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
All vdevs in pool must be mirrors.  At the time of the split,
\fBnewzpool\fP will be a replica of \fBzpool\fP\&.
.sp
After splitting, do not forget to import the new pool!
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B zpool
string
Name of storage pool
.TP
.B newzpool
string
Name of new storage pool
.TP
.B mountpoint
string
Sets the mount point for the root dataset
.TP
.B altroot
string
Sets altroot for newzpool
.TP
.B properties
dict
Additional pool properties for newzpool
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.split datamirror databackup
salt \(aq*\(aq zpool.split datamirror databackup altroot=/backup
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Zpool properties can be specified at the time of creation of the pool
by passing an additional argument called \(dqproperties\(dq and specifying
the properties with their respective values in the form of a python
dictionary:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
properties=\(dq{\(aqproperty1\(aq: \(aqvalue1\(aq, \(aqproperty2\(aq: \(aqvalue2\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.split datamirror databackup properties=\(dq{\(aqreadonly\(aq: \(aqon\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.split datamirror databackup
salt \(aq*\(aq zpool.split datamirror databackup altroot=/backup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.status(zpool=None)
Return the status of the named zpool
.INDENT 7.0
.TP
.B zpool
string
optional name of storage pool
.UNINDENT
.sp
New in version 2016.3.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.status myzpool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zpool.upgrade(zpool=None, version=None)
New in version 2016.3.0.

.sp
Enables all supported features on the given pool
.INDENT 7.0
.TP
.B zpool
string
Optional storage pool, applies to all otherwize
.TP
.B version
int
Version to upgrade to, if unspecified upgrade to the highest possible
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Once this is done, the pool will no longer be accessible on systems that do not
support feature flags. See zpool\-features(5) for details on compatibility with
systems that support feature flags, but do not support all features enabled on the pool.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq zpool.upgrade myzpool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.modules.zypperpkg
.sp
Package support for openSUSE via the zypper package manager
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
\fBrpm\fP Python module.  Install with \fBzypper install rpm\-python\fP
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
If you feel that Salt should be using this module to manage packages on a
minion, and it is using a different module (or gives an error similar to
\fI\(aqpkg.install\(aq is not available\fP), see \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.modules.zypperpkg.Wildcard(zypper)
New in version 2017.7.0.

.sp
Converts string wildcard to a zypper query.
\&.. rubric:: Example
.sp
\(aq1.2.3.4*\(aq is \(aq1.2.3.4.whatever.is.here\(aq and is equal to:
\(aq1.2.3.4 >= and < 1.2.3.5\(aq
.INDENT 7.0
.TP
.B Parameters
\fBptn\fP \-\- Pattern
.TP
.B Returns
Query range
.UNINDENT
.INDENT 7.0
.TP
.B Z_OP  =  [\(aq<\(aq, \(aq<=\(aq, \(aq=\(aq, \(aq>=\(aq, \(aq>\(aq]
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.available_version(*names, **kwargs)
This function is an alias of \fBlatest_version\fP\&.
.INDENT 7.0
.INDENT 3.5
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
dict will be returned for that package.
.INDENT 0.0
.TP
.B refresh
force a refresh if set to True (default).
If set to False it depends on zypper if a refresh is
executed or not.
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.clean_locks(root=None)
Remove unused locks that do not currently (with regard to repositories
used) lock any package.
.INDENT 7.0
.TP
.B root
Operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.clean_locks
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.del_repo(repo, root=None)
Delete a repo.
.INDENT 7.0
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.del_repo alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.diff(*paths, **kwargs)
Return a formatted diff between current files and original in a package.
NOTE: this function includes all files (configuration and not), but does
not work on binary content.
.sp
The root parameter can also be passed via the keyword argument.
.INDENT 7.0
.TP
.B Parameters
\fBpath\fP \-\- Full path to the installed file
.TP
.B Returns
Difference string or raises and exception if examined file is binary.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.diff /etc/apache2/httpd.conf /etc/sudoers
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.download(*packages, **kwargs)
Download packages to the local disk.
.INDENT 7.0
.TP
.B refresh
force a refresh if set to True.
If set to False (default) it depends on zypper if a refresh is
executed.
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.download httpd
salt \(aq*\(aq pkg.download httpd postfix
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.file_dict(*packages, **kwargs)
List the files that belong to a package, grouped by package. Not
specifying any packages will return a list of \fIevery\fP file on the system\(aqs
rpm database (not generally recommended).
.sp
The root parameter can also be passed via the keyword argument.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_list httpd
salt \(aq*\(aq pkg.file_list httpd postfix
salt \(aq*\(aq pkg.file_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.file_list(*packages, **kwargs)
List the files that belong to a package. Not specifying any packages will
return a list of \fIevery\fP file on the system\(aqs rpm database (not generally
recommended).
.sp
The root parameter can also be passed via the keyword argument.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.file_list httpd
salt \(aq*\(aq pkg.file_list httpd postfix
salt \(aq*\(aq pkg.file_list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.get_repo(repo, root=None, **kwargs)
Display a repo.
.INDENT 7.0
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.get_repo alias
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.hold(name=None, pkgs=None, root=None, **kwargs)
New in version 3003.

.sp
Add a package hold.  Specify one of \fBname\fP and \fBpkgs\fP\&.
.INDENT 7.0
.TP
.B name
A package name to hold, or a comma\-separated list of package names to
hold.
.TP
.B pkgs
A list of packages to hold.  The \fBname\fP parameter will be ignored if
this option is passed.
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.hold <package name>
salt \(aq*\(aq pkg.hold <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.hold pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.info_available(*names, **kwargs)
Return the information of the named package available for the system.
.INDENT 7.0
.TP
.B refresh
force a refresh if set to True (default).
If set to False it depends on zypper if a refresh is
executed or not.
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.info_available <package1>
salt \(aq*\(aq pkg.info_available <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.info_installed(*names, **kwargs)
Return the information of the named package(s), installed on the system.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnames\fP \-\- Names of the packages to get information about.
.IP \(bu 2
\fBattr\fP \-\-
.sp
Comma\-separated package attributes. If no \(aqattr\(aq is specified, all available attributes returned.
.INDENT 2.0
.TP
.B Valid attributes are:
version, vendor, release, build_date, build_date_time_t, install_date, install_date_time_t,
build_host, group, source_rpm, arch, epoch, size, license, signature, packager, url,
summary, description.
.UNINDENT

.IP \(bu 2
\fBerrors\fP \-\-
.sp
Handle RPM field errors. If \(aqignore\(aq is chosen, then various mistakes are simply ignored and omitted
from the texts or strings. If \(aqreport\(aq is chonen, then a field with a mistake is not returned, instead
a \(aqN/A (broken)\(aq (not available, broken) text is placed.
.INDENT 2.0
.TP
.B Valid attributes are:
ignore, report
.UNINDENT

.IP \(bu 2
\fBall_versions\fP \-\- Include information for all versions of the packages installed on the minion.
.IP \(bu 2
\fBroot\fP \-\- Operate on a different root directory.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.info_installed <package1>
salt \(aq*\(aq pkg.info_installed <package1> <package2> <package3> ...
salt \(aq*\(aq pkg.info_installed <package1> <package2> <package3> all_versions=True
salt \(aq*\(aq pkg.info_installed <package1> attr=version,vendor all_versions=True
salt \(aq*\(aq pkg.info_installed <package1> <package2> <package3> ... attr=version,vendor
salt \(aq*\(aq pkg.info_installed <package1> <package2> <package3> ... attr=version,vendor errors=ignore
salt \(aq*\(aq pkg.info_installed <package1> <package2> <package3> ... attr=version,vendor errors=report
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.install(name=None, refresh=False, fromrepo=None, pkgs=None, sources=None, downloadonly=None, skip_verify=False, version=None, ignore_repo_failure=False, no_recommends=False, root=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any zypper commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Install the passed package(s), add refresh=True to force a \(aqzypper refresh\(aq
before package is installed.
.INDENT 7.0
.TP
.B name
The name of the package to be installed. Note that this parameter is
ignored if either \fBpkgs\fP or \fBsources\fP is passed. Additionally,
please note that this option can only be used to install packages from
a software repository. To install a package file manually, use the
\fBsources\fP option.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B refresh
force a refresh if set to True.
If set to False (default) it depends on zypper if a refresh is
executed.
.TP
.B fromrepo
Specify a package repository to install from.
.TP
.B downloadonly
Only download the packages, do not install.
.TP
.B skip_verify
Skip the GPG verification check (e.g., \fB\-\-no\-gpg\-checks\fP)
.TP
.B version
Can be either a version number, or the combination of a comparison
operator (<, >, <=, >=, =) and a version number (ex. \(aq>1.2.3\-4\(aq).
This parameter is ignored if \fBpkgs\fP or \fBsources\fP is passed.
.TP
.B resolve_capabilities
If this option is set to True zypper will take capabilities into
account. In this case names which are just provided by a package
will get installed. Default is False.
.UNINDENT
.sp
Multiple Package Installation Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to install from a software repository. Must be
passed as a python list. A specific version number can be specified
by using a single\-element dict representing the package and its
version. As with the \fBversion\fP parameter above, comparison operators
can be used to target a specific version of a package.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, {\(dqbar\(dq: \(dq1.2.3\-4\(dq}]\(aq
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, {\(dqbar\(dq: \(dq<1.2.3\-4\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B sources
A list of RPM packages to install. Must be passed as a list of dicts,
with the keys being package names, and the values being the source URI
or local path to the package.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install sources=\(aq[{\(dqfoo\(dq: \(dqsalt://foo.rpm\(dq},{\(dqbar\(dq: \(dqsalt://bar.rpm\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B ignore_repo_failure
Zypper returns error code 106 if one of the repositories are not available for various reasons.
In case to set strict check, this parameter needs to be set to True. Default: False.
.TP
.B no_recommends
Do not install recommended packages, only required ones.
.TP
.B root
operate on a different root directory.
.TP
.B diff_attr:
If a list of package attributes is specified, returned value will
contain them, eg.:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {
    \(aqold\(aq: {
        \(aqversion\(aq: \(aq<old\-version>\(aq,
        \(aqarch\(aq: \(aq<old\-arch>\(aq},

    \(aqnew\(aq: {
        \(aqversion\(aq: \(aq<new\-version>\(aq,
        \(aqarch\(aq: \(aq<new\-arch>\(aq}}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Valid attributes are: \fBepoch\fP, \fBversion\fP, \fBrelease\fP, \fBarch\fP,
\fBinstall_date\fP, \fBinstall_date_time_t\fP\&.
.sp
If \fBall\fP is specified, all valid attributes will be returned.
.sp
New in version 2018.3.0.

.UNINDENT
.sp
Returns a dict containing the new package names and versions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqold\(aq: \(aq<old\-version>\(aq,
               \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If an attribute list is specified in \fBdiff_attr\fP, the dict will also contain
any specified attribute, eg.:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {
    \(aqold\(aq: {
        \(aqversion\(aq: \(aq<old\-version>\(aq,
        \(aqarch\(aq: \(aq<old\-arch>\(aq},

    \(aqnew\(aq: {
        \(aqversion\(aq: \(aq<new\-version>\(aq,
        \(aqarch\(aq: \(aq<new\-arch>\(aq}}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.latest_version(*names, **kwargs)
Return the latest version of the named package available for upgrade or
installation. If more than one package name is specified, a dict of
name/version pairs is returned.
.sp
If the latest version of a given package is already installed, an empty
dict will be returned for that package.
.INDENT 7.0
.TP
.B refresh
force a refresh if set to True (default).
If set to False it depends on zypper if a refresh is
executed or not.
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.latest_version <package name>
salt \(aq*\(aq pkg.latest_version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.list_downloaded(root=None, **kwargs)
New in version 2017.7.0.

.sp
List prefetched packages downloaded by Zypper in the local disk.
.INDENT 7.0
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_downloaded
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.list_holds(pattern=None, full=True, root=None, **kwargs)
New in version 3005.

.sp
List information on locked packages.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function returns the computed output of \fBlist_locks\fP
to show exact locked packages.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B pattern
Regular expression used to match the package name
.TP
.B full
True
Show the full hold definition including version and epoch. Set to
\fBFalse\fP to return just the name of the package(s) being held.
.TP
.B root
Operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_holds
salt \(aq*\(aq pkg.list_holds full=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.list_installed_patches(root=None, **kwargs)
New in version 2017.7.0.

.sp
List installed advisory patches on the system.
.INDENT 7.0
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_installed_patches
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.list_installed_patterns(root=None)
List installed patterns on the system.
.INDENT 7.0
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_installed_patterns
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.list_locks(root=None)
List current package locks.
.INDENT 7.0
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
Return a dict containing the locked package with attributes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {\(aqcase_sensitive\(aq: \(aq<case_sensitive>\(aq,
               \(aqmatch_type\(aq: \(aq<match_type>\(aq
               \(aqtype\(aq: \(aq<type>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_locks
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.list_patches(refresh=False, root=None, **kwargs)
New in version 2017.7.0.

.sp
List all known advisory patches from available repos.
.INDENT 7.0
.TP
.B refresh
force a refresh if set to True.
If set to False (default) it depends on zypper if a refresh is
executed.
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_patches
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.list_patterns(refresh=False, root=None)
List all known patterns from available repos.
.INDENT 7.0
.TP
.B refresh
force a refresh if set to True.
If set to False (default) it depends on zypper if a refresh is
executed.
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_patterns
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.list_pkgs(versions_as_list=False, root=None, includes=None, **kwargs)
List the packages currently installed as a dict. By default, the dict
contains versions as a comma separated string:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: \(aq<version>[,<version>...]\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B versions_as_list:
If set to true, the versions are provided as a list
.sp
{\(aq<package_name>\(aq: [\(aq<version>\(aq, \(aq<version>\(aq]}
.TP
.B root:
operate on a different root directory.
.TP
.B includes:
List of types of packages to include (package, patch, pattern, product)
By default packages are always included
.TP
.B attr:
If a list of package attributes is specified, returned value will
contain them in addition to version, eg.:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package_name>\(aq: [{\(aqversion\(aq : \(aqversion\(aq, \(aqarch\(aq : \(aqarch\(aq}]}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Valid attributes are: \fBepoch\fP, \fBversion\fP, \fBrelease\fP, \fBarch\fP,
\fBinstall_date\fP, \fBinstall_date_time_t\fP\&.
.sp
If \fBall\fP is specified, all valid attributes will be returned.
.INDENT 7.0
.INDENT 3.5
New in version 2018.3.0.

.UNINDENT
.UNINDENT
.TP
.B removed:
not supported
.TP
.B purge_desired:
not supported
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_pkgs
salt \(aq*\(aq pkg.list_pkgs attr=version,arch
salt \(aq*\(aq pkg.list_pkgs attr=\(aq[\(dqversion\(dq, \(dqarch\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.list_products(all=False, refresh=False, root=None)
List all available or installed SUSE products.
.INDENT 7.0
.TP
.B all
List all products available or only installed. Default is False.
.TP
.B refresh
force a refresh if set to True.
If set to False (default) it depends on zypper if a refresh is
executed.
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
Includes handling for OEM products, which read the OEM productline file
and overwrite the release value.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_products
salt \(aq*\(aq pkg.list_products all=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.list_provides(root=None, **kwargs)
New in version 2018.3.0.

.sp
List package provides of installed packages as a dict.
{\(aq<provided_name>\(aq: [\(aq<package_name>\(aq, \(aq<package_name>\(aq, ...]}
.INDENT 7.0
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_provides
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.list_repo_pkgs(*args, **kwargs)
New in version 2017.7.5,2018.3.1.

.sp
Returns all available packages. Optionally, package names (and name globs)
can be passed and the results will be filtered to packages matching those
names. This is recommended as it speeds up the function considerably.
.sp
This function can be helpful in discovering the version or repo to specify
in a \fI\%pkg.installed\fP state.
.sp
The return data will be a dictionary mapping package names to a list of
version numbers, ordered from newest to oldest. If \fBbyrepo\fP is set to
\fBTrue\fP, then the return dictionary will contain repository names at the
top level, and each repository will map packages to lists of version
numbers. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# With byrepo=False (default)
{
    \(aqbash\(aq: [\(aq4.3\-83.3.1\(aq,
             \(aq4.3\-82.6\(aq],
    \(aqvim\(aq: [\(aq7.4.326\-12.1\(aq]
}
{
    \(aqOSS\(aq: {
        \(aqbash\(aq: [\(aq4.3\-82.6\(aq],
        \(aqvim\(aq: [\(aq7.4.326\-12.1\(aq]
    },
    \(aqOSS Update\(aq: {
        \(aqbash\(aq: [\(aq4.3\-83.3.1\(aq]
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B fromrepo
None
Only include results from the specified repo(s). Multiple repos can be
specified, comma\-separated.
.TP
.B byrepo
False
When \fBTrue\fP, the return data for each package will be organized by
repository.
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_repo_pkgs
salt \(aq*\(aq pkg.list_repo_pkgs foo bar baz
salt \(aq*\(aq pkg.list_repo_pkgs \(aqpython2\-*\(aq byrepo=True
salt \(aq*\(aq pkg.list_repo_pkgs \(aqpython2\-*\(aq fromrepo=\(aqOSS Updates\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.list_repos(root=None, **kwargs)
Lists all repos.
.INDENT 7.0
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_repos
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.list_updates(refresh=True, root=None, **kwargs)
This function is an alias of \fBlist_upgrades\fP\&.
.INDENT 7.0
.INDENT 3.5
List all available package upgrades on this system
.INDENT 0.0
.TP
.B refresh
force a refresh if set to True (default).
If set to False it depends on zypper if a refresh is
executed.
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.list_upgrades(refresh=True, root=None, **kwargs)
List all available package upgrades on this system
.INDENT 7.0
.TP
.B refresh
force a refresh if set to True (default).
If set to False it depends on zypper if a refresh is
executed.
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.list_upgrades
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.mod_repo(repo, **kwargs)
Modify one or more values for a repo. If the repo does not exist, it will
be created, so long as the following values are specified:
.INDENT 7.0
.TP
.B repo or alias
alias by which Zypper refers to the repo
.TP
.B url, mirrorlist or baseurl
the URL for Zypper to reference
.TP
.B enabled
Enable or disable (True or False) repository,
but do not remove if disabled.
.TP
.B name
This is used as the descriptive name value in the repo file.
.TP
.B refresh
Enable or disable (True or False) auto\-refresh of the repository.
.TP
.B cache
Enable or disable (True or False) RPM files caching.
.TP
.B gpgcheck
Enable or disable (True or False) GPG check for this repository.
.TP
.B gpgautoimport
False
If set to True, automatically trust and import public GPG key for
the repository.
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
Key/Value pairs may also be removed from a repo\(aqs configuration by setting
a key to a blank value. Bear in mind that a name cannot be deleted, and a
URL can only be deleted if a \fBmirrorlist\fP is specified (or vice versa).
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.mod_repo alias alias=new_alias
salt \(aq*\(aq pkg.mod_repo alias url= mirrorlist=http://host.com/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.modified(*packages, **flags)
List the modified files that belong to a package. Not specifying any packages
will return a list of _all_ modified files on the system\(aqs RPM database.
.sp
New in version 2015.5.0.

.sp
Filtering by flags (True or False):
.INDENT 7.0
.TP
.B size
Include only files where size changed.
.TP
.B mode
Include only files which file\(aqs mode has been changed.
.TP
.B checksum
Include only files which MD5 checksum has been changed.
.TP
.B device
Include only files which major and minor numbers has been changed.
.TP
.B symlink
Include only files which are symbolic link contents.
.TP
.B owner
Include only files where owner has been changed.
.TP
.B group
Include only files where group has been changed.
.TP
.B time
Include only files where modification time of the file has been changed.
.TP
.B capabilities
Include only files where capabilities differ or not. Note: supported only on newer RPM versions.
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.modified
salt \(aq*\(aq pkg.modified httpd
salt \(aq*\(aq pkg.modified httpd postfix
salt \(aq*\(aq pkg.modified httpd owner=True group=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.normalize_name(name)
Strips the architecture from the specified package name, if necessary.
Circumstances where this would be done include:
.INDENT 7.0
.IP \(bu 2
If the arch is 32 bit and the package name ends in a 32\-bit arch.
.IP \(bu 2
If the arch matches the OS arch, or is \fBnoarch\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.normalize_name zsh.x86_64
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.owner(*paths, **kwargs)
Return the name of the package that owns the file. Multiple file paths can
be passed. If a single path is passed, a string will be returned,
and if multiple paths are passed, a dictionary of file/package name
pairs will be returned.
.sp
If the file is not owned by a package, or is not present on the minion,
then an empty string will be returned for that path.
.sp
The root parameter can also be passed via the keyword argument.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.owner /usr/bin/apachectl
salt \(aq*\(aq pkg.owner /usr/bin/apachectl /etc/httpd/conf/httpd.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.parse_arch(name)
Parse name and architecture from the specified package name.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.parse_arch zsh.x86_64
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.purge(name=None, pkgs=None, root=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any zypper commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Recursively remove a package and all dependencies which were installed
with it, this will call a \fBzypper \-n remove \-u\fP
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.TP
.B root
Operate on a different root directory.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.purge <package name>
salt \(aq*\(aq pkg.purge <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.purge pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.refresh_db(force=None, root=None, gpgautoimport=False, **kwargs)
Trigger a repository refresh by calling \fBzypper refresh\fP\&. Refresh will run
with \fB\-\-force\fP if the \(dqforce=True\(dq flag is passed on the CLI or
\fBrefreshdb_force\fP is set to \fBtrue\fP in the pillar. The CLI option
overrides the pillar setting.
.sp
It will return a dict:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<database name>\(aq: Bool}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B gpgautoimport
False
If set to True, automatically trust and import public GPG key for
the repository.
.sp
New in version 3007.0.

.TP
.B repos
Refresh just the specified repos
.sp
New in version 3007.0.

.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.refresh_db [force=true|false]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pillar Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zypper:
  refreshdb_force: false
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.remove(name=None, pkgs=None, root=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any zypper commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Remove packages with \fBzypper \-n remove\fP
.INDENT 7.0
.TP
.B name
The name of the package to be deleted.
.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to delete. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed.
.TP
.B root
Operate on a different root directory.
.UNINDENT
.sp
New in version 0.16.0.

.sp
Returns a dict containing the changes.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.remove <package name>
salt \(aq*\(aq pkg.remove <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.remove pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3007.0: Can now remove also PTF packages which require a different handling in the backend.

.sp
Can now remove also PTF packages which require a different handling in the backend.
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.resolve_capabilities(pkgs, refresh=False, root=None, **kwargs)
New in version 2018.3.0.

.sp
Convert name provides in \fBpkgs\fP into real package names if
\fBresolve_capabilities\fP parameter is set to True. In case of
\fBresolve_capabilities\fP is set to False the package list
is returned unchanged.
.INDENT 7.0
.TP
.B refresh
force a refresh if set to True.
If set to False (default) it depends on zypper if a refresh is
executed.
.TP
.B root
operate on a different root directory.
.TP
.B resolve_capabilities
If this option is set to True the input will be checked if
a package with this name exists. If not, this function will
search for a package which provides this name. If one is found
the output is exchanged with the real package name.
In case this option is set to False (Default) the input will
be returned unchanged.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.resolve_capabilities resolve_capabilities=True w3m_ssl
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.search(criteria, refresh=False, **kwargs)
List known packages, available to the system.
.INDENT 7.0
.TP
.B refresh
force a refresh if set to True.
If set to False (default) it depends on zypper if a refresh is
executed.
.TP
.B match (str)
One of \fIexact\fP, \fIwords\fP, \fIsubstrings\fP\&. Search for an \fIexact\fP match
or for the whole \fIwords\fP only. Default to \fIsubstrings\fP to patch
partial words.
.TP
.B provides (bool)
Search for packages which provide the search strings.
.TP
.B recommends (bool)
Search for packages which recommend the search strings.
.TP
.B requires (bool)
Search for packages which require the search strings.
.TP
.B suggests (bool)
Search for packages which suggest the search strings.
.TP
.B conflicts (bool)
Search packages conflicting with search strings.
.TP
.B obsoletes (bool)
Search for packages which obsolete the search strings.
.TP
.B file_list (bool)
Search for a match in the file list of packages.
.TP
.B search_descriptions (bool)
Search also in package summaries and descriptions.
.TP
.B case_sensitive (bool)
Perform case\-sensitive search.
.TP
.B installed_only (bool)
Show only installed packages.
.TP
.B not_installed_only (bool)
Show only packages which are not installed.
.TP
.B details (bool)
Show version and repository
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.search <criteria>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.services_need_restart(root=None, **kwargs)
New in version 3003.

.sp
List services that use files which have been changed by the
package manager. It might be needed to restart them.
.INDENT 7.0
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.services_need_restart
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.unhold(name=None, pkgs=None, root=None, **kwargs)
New in version 3003.

.sp
Remove a package hold.
.INDENT 7.0
.TP
.B name
A package name to unhold, or a comma\-separated list of package names to
unhold.
.TP
.B pkgs
A list of packages to unhold.  The \fBname\fP parameter will be ignored if
this option is passed.
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.unhold <package name>
salt \(aq*\(aq pkg.unhold <package1>,<package2>,<package3>
salt \(aq*\(aq pkg.unhold pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.upgrade(name=None, pkgs=None, refresh=True, dryrun=False, dist_upgrade=False, fromrepo=None, novendorchange=False, skip_verify=False, no_recommends=False, root=None, diff_attr=None, **kwargs)
Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to
isolate commands which modify installed packages from the
\fBsalt\-minion\fP daemon\(aqs control group. This is done to keep systemd
from killing any zypper commands spawned by Salt when the
\fBsalt\-minion\fP service is restarted. (see \fBKillMode\fP in the
\fI\%systemd.kill(5)\fP manpage for more information). If desired, usage of
\fI\%systemd\-run(1)\fP can be suppressed by setting a \fI\%config option\fP called \fBsystemd.scope\fP, with a value of
\fBFalse\fP (no quotes).

.sp
Run a full system upgrade, a zypper upgrade
.INDENT 7.0
.TP
.B name
The name of the package to be installed. Note that this parameter is
ignored if \fBpkgs\fP is passed or if \fBdryrun\fP is set to True.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install name=<package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B pkgs
A list of packages to install from a software repository. Must be
passed as a python list. Note that this parameter is ignored if
\fBdryrun\fP is set to True.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.install pkgs=\(aq[\(dqfoo\(dq, \(dqbar\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B refresh
force a refresh if set to True (default).
If set to False it depends on zypper if a refresh is
executed.
.TP
.B dryrun
If set to True, it creates a debug solver log file and then perform
a dry\-run upgrade (no changes are made). Default: False
.TP
.B dist_upgrade
Perform a system dist\-upgrade. Default: False
.TP
.B fromrepo
Specify a list of package repositories to upgrade from. Default: None
.TP
.B novendorchange
If set to True, no allow vendor changes. Default: False
.TP
.B skip_verify
Skip the GPG verification check (e.g., \fB\-\-no\-gpg\-checks\fP)
.TP
.B no_recommends
Do not install recommended packages, only required ones.
.TP
.B root
Operate on a different root directory.
.TP
.B diff_attr:
If a list of package attributes is specified, returned value will
contain them, eg.:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq: {
    \(aqold\(aq: {
        \(aqversion\(aq: \(aq<old\-version>\(aq,
        \(aqarch\(aq: \(aq<old\-arch>\(aq},

    \(aqnew\(aq: {
        \(aqversion\(aq: \(aq<new\-version>\(aq,
        \(aqarch\(aq: \(aq<new\-arch>\(aq}}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Valid attributes are: \fBepoch\fP, \fBversion\fP, \fBrelease\fP, \fBarch\fP,
\fBinstall_date\fP, \fBinstall_date_time_t\fP\&.
.sp
If \fBall\fP is specified, all valid attributes will be returned.
.sp
New in version 3006.0.

.UNINDENT
.sp
Returns a dictionary containing the changes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aq<package>\(aq:  {\(aqold\(aq: \(aq<old\-version>\(aq,
                \(aqnew\(aq: \(aq<new\-version>\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If an attribute list is specified in \fBdiff_attr\fP, the dict will also contain
any specified attribute, eg.:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\&.. code\-block:: python
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B {\(aq<package>\(aq: {
.INDENT 7.0
.TP
.B \(aqold\(aq: {
\(aqversion\(aq: \(aq<old\-version>\(aq,
\(aqarch\(aq: \(aq<old\-arch>\(aq},
.TP
.B \(aqnew\(aq: {
\(aqversion\(aq: \(aq<new\-version>\(aq,
\(aqarch\(aq: \(aq<new\-arch>\(aq}}}
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade
salt \(aq*\(aq pkg.upgrade name=mypackage
salt \(aq*\(aq pkg.upgrade pkgs=\(aq[\(dqpackage1\(dq, \(dqpackage2\(dq]\(aq
salt \(aq*\(aq pkg.upgrade dist_upgrade=True fromrepo=\(aq[\(dqMyRepoName\(dq]\(aq novendorchange=True
salt \(aq*\(aq pkg.upgrade dist_upgrade=True dryrun=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.upgrade_available(name, **kwargs)
Check whether or not an upgrade is available for a given package
.INDENT 7.0
.TP
.B refresh
force a refresh if set to True (default).
If set to False it depends on zypper if a refresh is
executed or not.
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.upgrade_available <package name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.verify(*names, **kwargs)
Runs an rpm \-Va on a system, and returns the results in a dict
.sp
Files with an attribute of config, doc, ghost, license or readme in the
package header can be ignored using the \fBignore_types\fP keyword argument.
.sp
The root parameter can also be passed via the keyword argument.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.verify
salt \(aq*\(aq pkg.verify httpd
salt \(aq*\(aq pkg.verify \(aqhttpd postfix\(aq
salt \(aq*\(aq pkg.verify \(aqhttpd postfix\(aq ignore_types=[\(aqconfig\(aq,\(aqdoc\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.version(*names, **kwargs)
Returns a string representing the package version or an empty dict if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
.INDENT 7.0
.TP
.B root
operate on a different root directory.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version <package name>
salt \(aq*\(aq pkg.version <package1> <package2> <package3> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.modules.zypperpkg.version_cmp(ver1, ver2, ignore_epoch=False, **kwargs)
New in version 2015.5.4.

.sp
Do a cmp\-style comparison on two packages. Return \-1 if ver1 < ver2, 0 if
ver1 == ver2, and 1 if ver1 > ver2. Return None if there was a problem
making the comparison.
.INDENT 7.0
.TP
.B ignore_epoch
False
Set to \fBTrue\fP to ignore the epoch when comparing versions
.sp
New in version 2015.8.10,2016.3.2.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pkg.version_cmp \(aq0.2\-001\(aq \(aq0.2.0.1\-002\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS executors modules
.TS
center;
|l|l|.
_
T{
\fI\%direct_call\fP
T}	T{
Direct call executor module
T}
_
T{
\fI\%docker\fP
T}	T{
T}
_
T{
\fI\%splay\fP
T}	T{
Splay function calls across targeted minions
T}
_
T{
\fI\%sudo\fP
T}	T{
Sudo executor module
T}
_
T{
\fI\%transactional_update\fP
T}	T{
Transactional executor module
T}
_
.TE
.SS salt.executors.direct_call
.sp
Direct call executor module
.INDENT 0.0
.TP
.B salt.executors.direct_call.execute(opts, data, func, args, kwargs)
Directly calls the given function with arguments
.UNINDENT
.SS salt.executors.docker
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%docker Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Docker executor module
.sp
New in version 2019.2.0.

.sp
Used with the docker proxy minion.
.INDENT 0.0
.TP
.B salt.executors.docker.allow_missing_func(function)
Allow all calls to be passed through to docker container.
.sp
The docker call will use direct_call, which will return back if the module
was unable to be run.
.UNINDENT
.INDENT 0.0
.TP
.B salt.executors.docker.execute(opts, data, func, args, kwargs)
Directly calls the given function with arguments
.UNINDENT
.SS salt.executors.splay
.sp
Splay function calls across targeted minions
.INDENT 0.0
.TP
.B salt.executors.splay.execute(opts, data, func, args, kwargs)
Splay a salt function call execution time across minions over
a number of seconds (default: 300)
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
You \fIprobably\fP want to use \-\-async here and look up the job results later.
If you\(aqre dead set on getting the output from the CLI command, then make
sure to set the timeout (with the \-t flag) to something greater than the
splaytime (max splaytime + time to execute job).
Otherwise, it\(aqs very likely that the cli will time out before the job returns.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# With default splaytime
salt \-\-async \-\-module\-executors=\(aq[splay, direct_call]\(aq \(aq*\(aq pkg.install cowsay version=3.03\-8.el6
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# With specified splaytime (5 minutes) and timeout with 10 second buffer
salt \-t 310 \-\-module\-executors=\(aq[splay, direct_call]\(aq \-\-executor\-opts=\(aq{splaytime: 300}\(aq \(aq*\(aq pkg.version cowsay
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.executors.sudo
.sp
Sudo executor module
.INDENT 0.0
.TP
.B salt.executors.sudo.execute(opts, data, func, args, kwargs)
Allow for the calling of execution modules via sudo.
.sp
This module is invoked by the minion if the \fBsudo_user\fP minion config is
present.
.sp
Example minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sudo_user: saltdev
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once this setting is made, any execution module call done by the minion will be
run under \fBsudo \-u <sudo_user> salt\-call\fP\&.  For example, with the above
minion config,
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt sudo_minion cmd.run \(aqcat /etc/sudoers\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
is equivalent to
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sudo \-u saltdev salt\-call cmd.run \(aqcat /etc/sudoers\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
being run on \fBsudo_minion\fP\&.
.UNINDENT
.SS salt.executors.transactional_update module
.sp
Transactional executor module
.sp
New in version 3004.

.INDENT 0.0
.TP
.B salt.executors.transactional_update.execute(opts, data, func, args, kwargs)
Delegate into transactional_update module
.sp
The \fBtransactional_update\fP module support the execution of
functions inside a transaction, as support apply a state (via
\fBapply\fP, \fBsls\fP, \fBsingle\fP or \fBhighstate\fP).
.sp
This execution module can be used to route some Salt modules and
functions to be executed inside the transaction snapshot.
.sp
Add this executor in the minion configuration file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
module_executors:
  \- transactional_update
  \- direct_call
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or use the command line parameter:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-module\-executors=\(aq[transactional_update, direct_call]\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also schedule a reboot if needed:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-module\-executors=\(aq[transactional_update]\(aq state.sls stuff activate_transaction=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There are some configuration parameters supported:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Replace the list of default modules that all the functions
# are delegated to \(gatransactional_update.call()\(ga
delegated_modules: [cmd, pkg]

# Replace the list of default functions that are delegated to
# \(gatransactional_update.call()\(ga
delegated_functions: [pip.install]

# Expand the default list of modules
add_delegated_modules: [ansible]

# Expand the default list of functions
add_delegated_functions: [file.copy]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS fileserver modules
.TS
center;
|l|l|.
_
T{
\fI\%gitfs\fP
T}	T{
Git Fileserver Backend
T}
_
T{
\fI\%hgfs\fP
T}	T{
Mercurial Fileserver Backend
T}
_
T{
\fI\%minionfs\fP
T}	T{
Fileserver backend which serves files pushed to the Master
T}
_
T{
\fI\%roots\fP
T}	T{
The default file server backend
T}
_
T{
\fI\%s3fs\fP
T}	T{
Amazon S3 Fileserver Backend
T}
_
T{
\fI\%svnfs\fP
T}	T{
Subversion Fileserver Backend
T}
_
.TE
.SS salt.fileserver.gitfs
.sp
Git Fileserver Backend
.sp
With this backend, branches and tags in a remote git repository are exposed to
salt as different environments.
.sp
To enable, add \fBgitfs\fP to the \fI\%fileserver_backend\fP option in the
Master config file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_backend:
  \- gitfs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBgit\fP also works here. Prior to the 2018.3.0 release, \fIonly\fP \fBgit\fP
would work.
.UNINDENT
.UNINDENT
.sp
The Git fileserver backend supports both \fI\%pygit2\fP and \fI\%GitPython\fP, to provide the
Python interface to git. If both are present, the order of preference for which
one will be chosen is the same as the order in which they were listed: pygit2,
then GitPython.
.sp
An optional master config parameter (\fI\%gitfs_provider\fP) can be used
to specify which provider should be used, in the event that compatible versions
of both \fI\%pygit2\fP and \fI\%GitPython\fP are installed.
.sp
More detailed information on how to use GitFS can be found in the \fI\%GitFS
Walkthrough\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Minimum requirements
.sp
To use \fI\%pygit2\fP for GitFS requires a minimum \fI\%pygit2\fP version of 0.20.3.
\fI\%pygit2\fP 0.20.3 requires \fI\%libgit2\fP 0.20.0. \fI\%pygit2\fP and \fI\%libgit2\fP are developed
alongside one another, so it is recommended to keep them both at the same
major release to avoid unexpected behavior. For example, \fI\%pygit2\fP 0.21.x
requires \fI\%libgit2\fP 0.21.x, \fI\%pygit2\fP 0.22.x will require \fI\%libgit2\fP 0.22.x, etc.
.sp
To use \fI\%GitPython\fP for GitFS requires a minimum GitPython version of 0.3.0,
as well as the git CLI utility. Instructions for installing GitPython can
be found \fI\%here\fP\&.
.sp
To clear stale refs the git CLI utility must also be installed.
.UNINDENT
.UNINDENT
.SS salt.fileserver.hgfs
.sp
Mercurial Fileserver Backend
.sp
To enable, add \fBhgfs\fP to the \fI\%fileserver_backend\fP option in the
Master config file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_backend:
  \- hgfs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBhg\fP also works here. Prior to the 2018.3.0 release, \fIonly\fP \fBhg\fP would
work.
.UNINDENT
.UNINDENT
.sp
After enabling this backend, branches, bookmarks, and tags in a remote
mercurial repository are exposed to salt as different environments. This
feature is managed by the \fI\%fileserver_backend\fP option in the salt
master config file.
.sp
This fileserver has an additional option \fI\%hgfs_branch_method\fP that
will set the desired branch method. Possible values are: \fBbranches\fP,
\fBbookmarks\fP, or \fBmixed\fP\&. If using \fBbranches\fP or \fBmixed\fP, the
\fBdefault\fP branch will be mapped to \fBbase\fP\&.
.sp
Changed in version 2014.1.0: The \fI\%hgfs_base\fP master config parameter was added, allowing
for a branch other than \fBdefault\fP to be used for the \fBbase\fP
environment, and allowing for a \fBbase\fP environment to be specified when
using an \fI\%hgfs_branch_method\fP of \fBbookmarks\fP\&.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
mercurial
.IP \(bu 2
python bindings for mercurial (\fBpython\-hglib\fP)
.UNINDENT
.UNINDENT
.SS salt.fileserver.minionfs
.sp
Fileserver backend which serves files pushed to the Master
.sp
The \fI\%cp.push\fP function allows Minions to push files
up to the Master. Using this backend, these pushed files are exposed to other
Minions via the Salt fileserver.
.sp
To enable minionfs, \fI\%file_recv\fP needs to be set to \fBTrue\fP in the
master config file (otherwise \fI\%cp.push\fP will not be
allowed to push files to the Master), and \fBminionfs\fP must be added to the
\fBfileserver_backends\fP list.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_backend:
  \- minionfs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBminion\fP also works here. Prior to the 2018.3.0 release, \fIonly\fP
\fBminion\fP would work.
.UNINDENT
.UNINDENT
.sp
Other minionfs settings include: \fI\%minionfs_whitelist\fP,
\fI\%minionfs_blacklist\fP, \fI\%minionfs_mountpoint\fP, and
\fI\%minionfs_env\fP\&.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%MinionFS Backend Walkthrough\fP
.UNINDENT
.UNINDENT
.SS salt.fileserver.roots
.sp
The default file server backend
.sp
This fileserver backend serves files from the Master\(aqs local filesystem. If
\fI\%fileserver_backend\fP is not defined in the Master config file,
then this backend is enabled by default. If it \fIis\fP defined then \fBroots\fP must
be in the \fI\%fileserver_backend\fP list to enable this backend.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_backend:
  \- roots
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Fileserver environments are defined using the \fI\%file_roots\fP
configuration option.
.SS salt.fileserver.s3fs
.sp
Amazon S3 Fileserver Backend
.sp
New in version 0.16.0.

.sp
This backend exposes directories in S3 buckets as Salt environments. To enable
this backend, add \fBs3fs\fP to the \fI\%fileserver_backend\fP option in the
Master config file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_backend:
  \- s3fs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
S3 credentials must also be set in the master config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
s3.keyid: GKTADJGHEIQSXMKKRBJ08H
s3.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternatively, if on EC2 these credentials can be automatically loaded from
instance metadata.
.sp
This fileserver supports two modes of operation for the buckets:
.INDENT 0.0
.IP 1. 3
\fBA single bucket per environment\fP
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
s3.buckets:
  production:
    \- bucket1
    \- bucket2
  staging:
    \- bucket3
    \- bucket4
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
\fBMultiple environments per bucket\fP
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
s3.buckets:
  \- bucket1
  \- bucket2
  \- bucket3
  \- bucket4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Note that bucket names must be all lowercase both in the AWS console and in
Salt, otherwise you may encounter \fBSignatureDoesNotMatch\fP errors.
.sp
A multiple\-environment bucket must adhere to the following root directory
structure:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
s3://<bucket name>/<environment>/<files>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This fileserver back\-end requires the use of the MD5 hashing algorithm.
MD5 may not be compliant with all security policies.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This fileserver back\-end is only compatible with MD5 ETag hashes in
the S3 metadata. This means that you must use SSE\-S3 or plaintext for
bucket encryption, and that you must not use multipart upload when
uploading to your bucket. More information here:
\fI\%https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonResponseHeaders.html\fP
.sp
Objects without an MD5 ETag will be fetched on every fileserver update.
.sp
If you deal with objects greater than 8MB, then you should use the
following AWS CLI config to avoid mutipart upload:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
s3 =
  multipart_threshold = 1024MB
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
More info here:
\fI\%https://docs.aws.amazon.com/cli/latest/topic/s3\-config.html\fP
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This fileserver back\-end will by default sync all buckets on every
fileserver update.
.sp
If you want files to be only populated in the cache when requested, you can
disable this in the master config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
s3.s3_sync_on_update: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.fileserver.svnfs
.sp
Subversion Fileserver Backend
.sp
After enabling this backend, branches and tags in a remote subversion
repository are exposed to salt as different environments. To enable this
backend, add \fBsvnfs\fP to the \fI\%fileserver_backend\fP option in the
Master config file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fileserver_backend:
  \- svnfs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBsvn\fP also works here. Prior to the 2018.3.0 release, \fIonly\fP \fBsvn\fP
would work.
.UNINDENT
.UNINDENT
.sp
This backend assumes a standard svn layout with directories for \fBbranches\fP,
\fBtags\fP, and \fBtrunk\fP, at the repository root.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
subversion
.IP \(bu 2
pysvn
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.7.0: The paths to the trunk, branches, and tags have been made configurable, via
the config options \fI\%svnfs_trunk\fP,
\fI\%svnfs_branches\fP, and \fI\%svnfs_tags\fP\&.
\fI\%svnfs_mountpoint\fP was also added. Finally, support for
per\-remote configuration parameters was added. See the
\fI\%documentation\fP for more information.

.SS grains modules
.TS
center;
|l|l|.
_
T{
\fI\%chronos\fP
T}	T{
Generate chronos proxy minion grains.
T}
_
T{
\fI\%cimc\fP
T}	T{
Generate baseline proxy minion grains for cimc hosts.
T}
_
T{
\fI\%core\fP
T}	T{
The static grains, these are the core, or built in grains.
T}
_
T{
\fI\%disks\fP
T}	T{
Detect disks
T}
_
T{
\fI\%esxi\fP
T}	T{
Generate baseline proxy minion grains for ESXi hosts.
T}
_
T{
\fI\%extra\fP
T}	T{
T}
_
T{
\fI\%fibre_channel\fP
T}	T{
Grains for Fibre Channel WWN\(aqs.
T}
_
T{
\fI\%fx2\fP
T}	T{
Generate baseline proxy minion grains for Dell FX2 chassis.
T}
_
T{
\fI\%iscsi\fP
T}	T{
Grains for iSCSI Qualified Names (IQN).
T}
_
T{
\fI\%junos\fP
T}	T{
Grains for junos.
T}
_
T{
\fI\%lvm\fP
T}	T{
Detect LVM Volumes
T}
_
T{
\fI\%marathon\fP
T}	T{
Generate marathon proxy minion grains.
T}
_
T{
\fI\%mdadm\fP
T}	T{
Detect MDADM RAIDs
T}
_
T{
\fI\%mdata\fP
T}	T{
SmartOS Metadata grain provider
T}
_
T{
\fI\%metadata\fP
T}	T{
Grains from cloud metadata servers at 169.254.169.254
T}
_
T{
\fI\%metadata_gce\fP
T}	T{
Grains from cloud metadata servers at 169.254.169.254 in google compute engine
T}
_
T{
\fI\%minion_process\fP
T}	T{
Set grains describing the minion process.
T}
_
T{
\fI\%napalm\fP
T}	T{
NAPALM Grains
T}
_
T{
\fI\%nvme\fP
T}	T{
Grains for NVMe Qualified Names (NQN).
T}
_
T{
\fI\%nxos\fP
T}	T{
Grains for Cisco NX\-OS minions
T}
_
T{
\fI\%opts\fP
T}	T{
Simple grain to merge the opts into the grains directly if the grain_opts configuration value is set.
T}
_
T{
\fI\%package\fP
T}	T{
Grains for detecting what type of package Salt is using
T}
_
T{
\fI\%panos\fP
T}	T{
Generate baseline proxy minion grains for panos hosts.
T}
_
T{
\fI\%pending_reboot\fP
T}	T{
Grain that indicates the system is pending a reboot See functions in salt.utils.win_system to see what conditions would indicate a reboot is pending
T}
_
T{
\fI\%philips_hue\fP
T}	T{
Static grains for the Philips HUE lamps
T}
_
T{
\fI\%rest_sample\fP
T}	T{
Generate baseline proxy minion grains
T}
_
T{
\fI\%smartos\fP
T}	T{
SmartOS grain provider
T}
_
T{
\fI\%ssh_sample\fP
T}	T{
Generate baseline proxy minion grains
T}
_
T{
\fI\%zfs\fP
T}	T{
ZFS grain provider
T}
_
.TE
.SS salt.grains.chronos
.sp
Generate chronos proxy minion grains.
.sp
New in version 2015.8.2.

.INDENT 0.0
.TP
.B salt.grains.chronos.kernel()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.chronos.os()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.chronos.os_data()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.chronos.os_family()
.UNINDENT
.SS salt.grains.cimc
.sp
Generate baseline proxy minion grains for cimc hosts.
.INDENT 0.0
.TP
.B salt.grains.cimc.cimc(proxy=None)
.UNINDENT
.SS salt.grains.core
.sp
The static grains, these are the core, or built in grains.
.sp
When grains are loaded they are not loaded in the same way that modules are
loaded, grain functions are detected and executed, the functions MUST
return a dict which will be applied to the main grains dict. This module
will always be executed first, so that any grains loaded here in the core
module can be overwritten just by returning dict keys with the same value
as those returned here
.INDENT 0.0
.TP
.B salt.grains.core.append_domain()
Return append_domain if set
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.cwd()
Current working directory
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.default_gateway()
Populates grains which describe whether a server has a default gateway
configured or not. Uses \fIip \-4 route show\fP and \fIip \-6 route show\fP and greps
for a \fIdefault\fP at the beginning of any line. Assuming the standard
\fIdefault via <ip>\fP format for default gateways, it will also parse out the
ip address of the default gateway, and put it in ip4_gw or ip6_gw.
.sp
If the \fIip\fP command is unavailable, no grains will be populated.
.sp
Currently does not support multiple default gateways. The grains will be
set to the first default gateway found.
.sp
List of grains:
.INDENT 7.0
.INDENT 3.5
ip4_gw: True  # ip/True/False if default ipv4 gateway
ip6_gw: True  # ip/True/False if default ipv6 gateway
ip_gw: True   # True if either of the above is True, False otherwise
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.dns()
Parse the resolver configuration file
.INDENT 7.0
.INDENT 3.5
New in version 2016.3.0.

.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.fqdns()
Return all known FQDNs for the system by enumerating all interfaces and
then trying to reverse resolve them (excluding \(aqlo\(aq interface).
To disable the fqdns grain, set enable_fqdns_grains: False in the minion configuration file.
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.get_machine_id()
Provide the machine\-id for machine/virtualization combination
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.get_master()
Provides the minion with the name of its master.
This is useful in states to target other services running on the master.
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.get_server_id()
Provides an integer based on the FQDN of a machine.
Useful as server\-id in MySQL replication or anywhere else you\(aqll need an ID
like this.
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.hostname()
Return fqdn, hostname, domainname
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On Windows the \fBdomain\fP grain may refer to the dns entry for the host
instead of the Windows domain to which the host is joined. It may also
be empty if not a part of any domain. Refer to the \fBwindowsdomain\fP
grain instead
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.hwaddr_interfaces()
Provide a dict of the connected interfaces and their
hw addresses (Mac Address)
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.id_()
Return the id
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.ip4_interfaces()
Provide a dict of the connected interfaces and their ip4 addresses
The addresses will be passed as a list for each interface
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.ip6_interfaces()
Provide a dict of the connected interfaces and their ip6 addresses
The addresses will be passed as a list for each interface
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.ip_fqdn()
Return ip address and FQDN grains
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.ip_interfaces()
Provide a dict of the connected interfaces and their ip addresses
The addresses will be passed as a list for each interface
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.kernelparams()
Return the kernel boot parameters
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.locale_info()
.INDENT 7.0
.TP
.B Provides
defaultlanguage
defaultencoding
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.os_data()
Return grains pertaining to the operating system
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.path()
Return the path
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.pythonexecutable()
Return the python executable in use
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.pythonpath()
Return the Python path
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.pythonversion()
Return the Python version
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.saltpath()
Return the path of the salt module
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.saltversion()
Return the version of salt
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.saltversioninfo()
Return the version_info of salt
.INDENT 7.0
.INDENT 3.5
New in version 0.17.0.

.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.core.zmqversion()
Return the zeromq version
.UNINDENT
.SS salt.grains.disks
.sp
Detect disks
.INDENT 0.0
.TP
.B salt.grains.disks.disks()
Return list of disk devices
.UNINDENT
.SS salt.grains.esxi
.sp
Generate baseline proxy minion grains for ESXi hosts.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be deprecated in a future release of Salt. VMware strongly
recommends using the
\fI\%VMware Salt extensions\fP
instead of the ESXi module. Because the Salt extensions are newer and
actively supported by VMware, they are more compatible with current versions
of ESXi and they work well with the latest features in the VMware product
line.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.esxi.esxi()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.esxi.kernel()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.esxi.os()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.esxi.os_family()
.UNINDENT
.SS salt.grains.extra
.INDENT 0.0
.TP
.B salt.grains.extra.config()
Return the grains set in the grains file
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.extra.shell()
Return the default shell to use on this system
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.extra.transactional()
Determine if the system is transactional.
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.extra.uefi()
Populate UEFI grains.
.UNINDENT
.SS salt.grains.fibre_channel
.sp
Grains for Fibre Channel WWN\(aqs. On Windows this runs a PowerShell command that
queries WMI to get the Fibre Channel WWN\(aqs available.
.sp
New in version 2018.3.0.

.sp
To enable these grains set \fBfibre_channel_grains: True\fP in the minion config.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fibre_channel_grains: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.fibre_channel.fibre_channel_wwns()
Return list of fiber channel HBA WWNs
.UNINDENT
.SS salt.grains.fx2
.sp
Generate baseline proxy minion grains for Dell FX2 chassis.
The challenge is that most of Salt isn\(aqt bootstrapped yet,
so we need to repeat a bunch of things that would normally happen
in proxy/fx2.py\-\-just enough to get data from the chassis to include
in grains.
.INDENT 0.0
.TP
.B salt.grains.fx2.fx2()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.fx2.kernel()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.fx2.location()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.fx2.os_data()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.fx2.os_family()
.UNINDENT
.SS salt.grains.iscsi
.sp
Grains for iSCSI Qualified Names (IQN).
.sp
New in version 2018.3.0.

.sp
To enable these grains set \fIiscsi_grains: True\fP in the minion config.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
iscsi_grains: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.iscsi.iscsi_iqn()
Return iSCSI IQN
.UNINDENT
.SS salt.grains.junos
.sp
Grains for junos.
NOTE this is a little complicated\-\-junos can only be accessed
via salt\-proxy\-minion. Thus, some grains make sense to get them
from the minion (PYTHONPATH), but others don\(aqt (ip_interfaces)
.INDENT 0.0
.TP
.B salt.grains.junos.defaults()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.junos.facts(proxy=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.junos.os_family()
.UNINDENT
.SS salt.grains.lvm
.sp
Detect LVM Volumes
.INDENT 0.0
.TP
.B salt.grains.lvm.lvm()
Return list of LVM devices
.UNINDENT
.SS salt.grains.marathon
.sp
Generate marathon proxy minion grains.
.sp
New in version 2015.8.2.

.INDENT 0.0
.TP
.B salt.grains.marathon.kernel()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.marathon.marathon()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.marathon.os()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.marathon.os_data()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.marathon.os_family()
.UNINDENT
.SS salt.grains.mdadm
.sp
Detect MDADM RAIDs
.INDENT 0.0
.TP
.B salt.grains.mdadm.mdadm()
Return list of mdadm devices
.UNINDENT
.SS salt.grains.mdata
.sp
SmartOS Metadata grain provider
.INDENT 0.0
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B depends
salt.utils, salt.module.cmdmod
.TP
.B platform
SmartOS
.UNINDENT
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.grains.mdata.mdata()
Provide grains from the SmartOS metadata
.UNINDENT
.SS salt.grains.metadata
.sp
Grains from cloud metadata servers at 169.254.169.254
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B depends
requests
.UNINDENT
.sp
To enable these grains that pull from the \fI\%http://169.254.169.254/latest\fP
metadata server set \fImetadata_server_grains: True\fP in the minion config.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
metadata_server_grains: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.metadata.metadata()
.UNINDENT
.SS salt.grains.metadata_gce
.sp
Grains from cloud metadata servers at 169.254.169.254 in
google compute engine
.sp
New in version 3005.

.INDENT 0.0
.TP
.B depends
requests
.UNINDENT
.sp
To enable these grains that pull from the \fI\%http://169.254.169.254/computeMetadata/v1/\fP
metadata server set \fImetadata_server_grains: True\fP in the minion config.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
metadata_server_grains: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.metadata_gce.metadata()
Takes no arguments, returns a dictionary of metadata values from Google.
.UNINDENT
.SS salt.grains.minion_process
.sp
Set grains describing the minion process.
.INDENT 0.0
.TP
.B salt.grains.minion_process.grains()
Return the grains dictionary
.UNINDENT
.SS salt.grains.napalm
.SS NAPALM Grains
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP>
.TP
.B maturity
new
.TP
.B depends
napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
\fBNAPALM proxy module\fP
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.grains.napalm.getos(proxy=None)
Returns the Operating System name running on the network device.
.sp
Example: junos, iosxr, eos, ios etc.
.sp
CLI Example \- select all network devices running JunOS:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos:junos\(aq test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.napalm.host(proxy=None)
This grain is set by the NAPALM grain module
only when running in a proxy minion.
When Salt is installed directly on the network device,
thus running a regular minion, the \fBhost\fP grain
provides the physical hostname of the network device,
as it would be on an ordinary minion server.
When running in a proxy minion, \fBhost\fP points to the
value configured in the pillar: \fI\%NAPALM proxy module\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The diference between \fBhost\fP and \fBhostname\fP is that
\fBhost\fP provides the physical location \- either domain name or IP address,
while \fBhostname\fP provides the hostname as configured on the device.
They are not necessarily the same.
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice*\(aq grains.get host
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
device1:
    ip\-172\-31\-13\-136.us\-east\-2.compute.internal
device2:
    ip\-172\-31\-11\-193.us\-east\-2.compute.internal
device3:
    ip\-172\-31\-2\-181.us\-east\-2.compute.internal
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.napalm.host_dns(proxy=None)
Return the DNS information of the host.
This grain is a dictionary having two keys:
.INDENT 7.0
.IP \(bu 2
\fBA\fP
.IP \(bu 2
\fBAAAA\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This grain is disabled by default, as the proxy startup may be slower
when the lookup fails.
The user can enable it using the \fBnapalm_host_dns_grain\fP option (in
the pillar or proxy configuration file):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
napalm_host_dns_grain: true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice*\(aq grains.get host_dns
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
device1:
    A:
        \- 172.31.9.153
    AAAA:
        \- fd52:188c:c068::1
device2:
    A:
        \- 172.31.46.249
    AAAA:
        \- fdca:3b17:31ab::17
device3:
    A:
        \- 172.31.8.167
    AAAA:
        \- fd0f:9fd6:5fab::1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.napalm.hostname(proxy=None)
Return the hostname as configured on the network device.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqdevice*\(aq grains.get hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
device1:
    edge01.yyz01
device2:
    edge01.bjm01
device3:
    edge01.flw01
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.napalm.interfaces(proxy=None)
Returns the complete interfaces list of the network device.
.sp
Example: [\(aqlc\-0/0/0\(aq, \(aqpfe\-0/0/0\(aq, \(aqxe\-1/3/0\(aq, \(aqlo0\(aq, \(aqirb\(aq, \(aqdemux0\(aq, \(aqfxp0\(aq]
.sp
CLI Example \- select all devices that have a certain interface, e.g.: xe\-1/1/1:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqinterfaces:xe\-1/1/1\(aq test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
edge01.yyz01:
    True
edge01.maa01:
    True
edge01.syd01:
    True
edge01.del01:
    True
edge01.dus01:
    True
edge01.kix01:
    True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.napalm.model(proxy=None)
Returns the network device chassis model.
.sp
Example: MX480, ASR\-9904\-AC etc.
.sp
CLI Example \- select all Juniper MX480 routers and execute traceroute to 8.8.8.8:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqmodel:MX480\(aq net.traceroute 8.8.8.8
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.napalm.optional_args(proxy=None)
Return the connection optional args.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Sensible data will not be returned.
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.sp
CLI Example \- select all devices connecting via port 1234:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqoptional_args:port:1234\(aq test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
device1:
    True
device2:
    True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.napalm.serial(proxy=None)
Returns the chassis serial number.
.sp
Example: FOX1234W00F
.sp
CLI Example \- select all devices whose serial number begins with \fIFOX\fP and display the serial number value:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqserial:FOX*\(aq grains.get serial
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
edge01.icn01:
    FOXW00F001
edge01.del01:
    FOXW00F002
edge01.yyz01:
    FOXW00F003
edge01.mrs01:
    FOXW00F004
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.napalm.uptime(proxy=None)
Returns the uptime in seconds.
.sp
CLI Example \- select all devices started/restarted within the last hour:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aquptime<3600\(aq test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.napalm.username(proxy=None)
Return the username.
.sp
New in version 2017.7.0.

.sp
CLI Example \- select all devices using \fIfoobar\fP as username for connection:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqusername:foobar\(aq test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
device1:
    True
device2:
    True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.napalm.vendor(proxy=None)
Returns the network device vendor.
.sp
Example: juniper, cisco, arista etc.
.sp
CLI Example \- select all devices produced by Cisco and shutdown:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqvendor:cisco\(aq net.cli \(dqshut\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.napalm.version(proxy=None)
Returns the OS version.
.sp
Example: 13.3R6.5, 6.0.2 etc.
.sp
CLI Example \- select all network devices running JunOS 13.3R6.5 and return the model:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos:junos and version:13.3R6.5\(aq grains.get model
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
edge01.bjm01:
    MX2000
edge01.sjc01:
    MX960
edge01.mrs01:
    MX480
edge01.muc01:
    MX240
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.grains.nvme
.sp
Grains for NVMe Qualified Names (NQN).
.sp
New in version 3000.

.sp
To enable these grains set \fInvme_grains: True\fP in the minion config.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nvme_grains: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.nvme.nvme_nqn()
Return NVMe NQN
.UNINDENT
.SS salt.grains.nxos
.sp
Grains for Cisco NX\-OS minions
.sp
New in version 2016.11.0.

.sp
For documentation on setting up the nxos proxy minion look in the documentation
for \fI\%salt.proxy.nxos\fP\&.
.INDENT 0.0
.TP
.B salt.grains.nxos.system_information(proxy=None)
.UNINDENT
.SS salt.grains.opts
.sp
Simple grain to merge the opts into the grains directly if the grain_opts
configuration value is set.
.INDENT 0.0
.TP
.B salt.grains.opts.opts()
Return the minion configuration settings
.UNINDENT
.SS salt.grains.package
.sp
Grains for detecting what type of package Salt is using
.sp
New in version 3007.0.

.INDENT 0.0
.TP
.B salt.grains.package.package()
Function to determine if the user is currently using
onedir, pip or system level package of Salt.
.UNINDENT
.SS salt.grains.panos
.sp
Generate baseline proxy minion grains for panos hosts.
.INDENT 0.0
.TP
.B salt.grains.panos.panos(proxy=None)
.UNINDENT
.SS salt.grains.pending_reboot
.sp
Grain that indicates the system is pending a reboot
See functions in salt.utils.win_system to see what conditions would indicate
a reboot is pending
.INDENT 0.0
.TP
.B salt.grains.pending_reboot.pending_reboot()
A grain that indicates that a Windows system is pending a reboot.
.UNINDENT
.SS salt.grains.philips_hue
.sp
Static grains for the Philips HUE lamps
.sp
New in version 2015.8.3.

.INDENT 0.0
.TP
.B salt.grains.philips_hue.kernel()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.philips_hue.os()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.philips_hue.os_family()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.philips_hue.product()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.philips_hue.vendor()
.UNINDENT
.SS salt.grains.rest_sample
.sp
Generate baseline proxy minion grains
.INDENT 0.0
.TP
.B salt.grains.rest_sample.kernel()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.rest_sample.location()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.rest_sample.os()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.rest_sample.os_data()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.rest_sample.os_family()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.rest_sample.proxy_functions(proxy)
The loader will execute functions with one argument and pass
a reference to the proxymodules LazyLoader object.  However,
grains sometimes get called before the LazyLoader object is setup
so \fIproxy\fP might be None.
.UNINDENT
.SS salt.grains.smartos
.sp
SmartOS grain provider
.INDENT 0.0
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B depends
salt.utils, salt.module.cmdmod
.TP
.B platform
SmartOS
.UNINDENT
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.grains.smartos.smartos()
Provide grains for SmartOS
.UNINDENT
.SS salt.grains.ssh_sample
.sp
Generate baseline proxy minion grains
.INDENT 0.0
.TP
.B salt.grains.ssh_sample.kernel()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.ssh_sample.location()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.ssh_sample.os_data()
.UNINDENT
.INDENT 0.0
.TP
.B salt.grains.ssh_sample.proxy_functions(proxy)
The loader will execute functions with one argument and pass
a reference to the proxymodules LazyLoader object.  However,
grains sometimes get called before the LazyLoader object is setup
so \fIproxy\fP might be None.
.UNINDENT
.SS salt.grains.zfs
.sp
ZFS grain provider
.INDENT 0.0
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B depends
salt.module.cmdmod
.TP
.B platform
illumos,freebsd,linux
.UNINDENT
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B salt.grains.zfs.zfs()
Provide grains for zfs/zpool
.UNINDENT
.SS netapi modules
.TS
center;
|l|l|.
_
T{
\fI\%rest_cherrypy\fP
T}	T{
A script to start the CherryPy WSGI server
T}
_
T{
\fI\%rest_tornado\fP
T}	T{
T}
_
T{
\fI\%rest_wsgi\fP
T}	T{
A minimalist REST API for Salt
T}
_
.TE
.SS rest_cherrypy
.INDENT 0.0
.IP \(bu 2
\fI\%A REST API for Salt\fP
.INDENT 2.0
.IP \(bu 2
\fI\%Authentication\fP
.IP \(bu 2
\fI\%Usage\fP
.IP \(bu 2
\fI\%Content negotiation\fP
.UNINDENT
.IP \(bu 2
\fI\%Performance Expectations and Recommended Usage\fP
.INDENT 2.0
.IP \(bu 2
\fI\%Long\-Running HTTP Connections\fP
.IP \(bu 2
\fI\%Timeouts\fP
.IP \(bu 2
\fI\%Best Practices\fP
.IP \(bu 2
\fI\%Performance Tuning\fP
.IP \(bu 2
\fI\%Future Plans\fP
.UNINDENT
.IP \(bu 2
\fI\%Deployment\fP
.INDENT 2.0
.IP \(bu 2
\fI\%salt\-api using the CherryPy server\fP
.IP \(bu 2
\fI\%Using a WSGI\-compliant web server\fP
.UNINDENT
.UNINDENT
.sp
A script to start the CherryPy WSGI server
.sp
This is run by \fBsalt\-api\fP and started in a multiprocess.
.SS A REST API for Salt
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This module is Experimental on Windows platforms and supports limited
configurations:
.INDENT 0.0
.IP \(bu 2
doesn\(aqt support PAM authentication (i.e. external_auth: auto)
.IP \(bu 2
doesn\(aqt support SSL (i.e. disable_ssl: True)
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
CherryPy Python module.
.sp
Note: there is a \fI\%known SSL traceback for CherryPy versions 3.2.5 through
3.7.x\fP\&. Please use
version 3.2.3 or the latest 10.x version instead.
.UNINDENT
.TP
.B optdepends
.INDENT 7.0
.IP \(bu 2
ws4py Python module for websockets support.
.UNINDENT
.TP
.B client_libraries
.INDENT 7.0
.IP \(bu 2
Java: \fI\%https://github.com/SUSE/salt\-netapi\-client\fP
.IP \(bu 2
Python: \fI\%https://github.com/saltstack/pepper\fP
.UNINDENT
.TP
.B setup
All steps below are performed on the machine running the Salt Master
daemon. Configuration goes into the Master configuration file.
.INDENT 7.0
.IP 1. 3
Install \fBsalt\-api\fP\&. (This step varies between OS and Linux distros.
Some package systems have a split package, others include salt\-api in
the main Salt package. Ensure the \fBsalt\-api \-\-version\fP output matches
the \fBsalt \-\-version\fP output.)
.IP 2. 3
Install CherryPy. (Read the version caveat in the section above.)
.IP 3. 3
Optional: generate self\-signed SSL certificates.
.sp
Using a secure HTTPS connection is strongly recommended since Salt
eauth authentication credentials will be sent over the wire.
.INDENT 3.0
.IP 1. 3
Install the PyOpenSSL package.
.IP 2. 3
Generate a self\-signed certificate using the
\fI\%create_self_signed_cert()\fP execution
function.
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local tls.create_self_signed_cert
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.IP 4. 3
Edit the master config to create at least one external auth user or
group following the \fI\%full external auth instructions\fP\&.
.IP 5. 3
Edit the master config with the following production\-ready example to
enable the \fBrest_cherrypy\fP module. (Adjust cert paths as needed, or
disable SSL (not recommended!).)
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
rest_cherrypy:
  port: 8000
  ssl_crt: /etc/pki/tls/certs/localhost.crt
  ssl_key: /etc/pki/tls/certs/localhost.key
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 6. 3
Restart the \fBsalt\-master\fP daemon.
.IP 7. 3
Start the \fBsalt\-api\fP daemon.
.UNINDENT
.TP
.B configuration
All available configuration options are detailed below. These settings
configure the CherryPy HTTP server and do not apply when using an external
server such as Apache or Nginx.
.INDENT 7.0
.TP
.B port
\fBRequired\fP
.sp
The port for the webserver to listen on.
.TP
.B host
\fB0.0.0.0\fP
The socket interface for the HTTP server to listen on.
.TP
.B debug
\fBFalse\fP
Starts the web server in development mode. It will reload itself when
the underlying code is changed and will output more debugging info.
.TP
.B log_access_file
Path to a file to write HTTP access logs.
.sp
New in version 2016.11.0.

.TP
.B log_error_file
Path to a file to write HTTP error logs.
.sp
New in version 2016.11.0.

.TP
.B ssl_crt
The path to a SSL certificate. (See below)
.TP
.B ssl_key
The path to the private key for your SSL certificate. (See below)
.TP
.B ssl_chain
(Optional when using PyOpenSSL) the certificate chain to pass to
\fBContext.load_verify_locations\fP\&.
.TP
.B disable_ssl
A flag to disable SSL. Warning: your Salt authentication credentials
will be sent in the clear!
.TP
.B webhook_disable_auth
False
The \fI\%Webhook\fP URL requires authentication by default but
external services cannot always be configured to send authentication.
See the Webhook documentation for suggestions on securing this
interface.
.TP
.B webhook_url
/hook
Configure the URL endpoint for the \fI\%Webhook\fP entry point.
.TP
.B thread_pool
\fB100\fP
The number of worker threads to start up in the pool.
.TP
.B socket_queue_size
\fB30\fP
Specify the maximum number of HTTP connections to queue.
.TP
.B expire_responses
True
Whether to check for and kill HTTP responses that have exceeded the
default timeout.
.sp
Deprecated since version 2016.11.9,2017.7.3,2018.3.0: The \(dqexpire_responses\(dq configuration setting, which corresponds
to the \fBtimeout_monitor\fP setting in CherryPy, is no longer
supported in CherryPy versions >= 12.0.0.

.TP
.B max_request_body_size
\fB1048576\fP
Maximum size for the HTTP request body.
.TP
.B collect_stats
False
Collect and report statistics about the CherryPy server
.sp
Reports are available via the \fI\%Stats\fP URL.
.TP
.B stats_disable_auth
False
Do not require authentication to access the \fB/stats\fP endpoint.
.sp
New in version 2018.3.0.

.TP
.B static
A filesystem path to static HTML/JavaScript/CSS/image assets.
.TP
.B static_path
\fB/static\fP
The URL prefix to use when serving static assets out of the directory
specified in the \fBstatic\fP setting.
.TP
.B enable_sessions
\fBTrue\fP
Enable or disable all endpoints that rely on session cookies. This can
be useful to enforce only header\-based authentication.
.sp
New in version 2017.7.0.

.TP
.B app
\fBindex.html\fP
A filesystem path to an HTML file that will be served as a static file.
This is useful for bootstrapping a single\-page JavaScript app.
.sp
Warning! If you set this option to a custom web application, anything
that uses cookie\-based authentication is vulnerable to XSRF attacks.
Send the custom \fBX\-Auth\-Token\fP header instead and consider disabling
the \fBenable_sessions\fP setting.
.sp
Changed in version 2017.7.0: Add a proof\-of\-concept JavaScript single\-page app.

.TP
.B app_path
\fB/app\fP
The URL prefix to use for serving the HTML file specified in the \fBapp\fP
setting. This should be a simple name containing no slashes.
.sp
Any path information after the specified path is ignored; this is
useful for apps that utilize the HTML5 history API.
.TP
.B root_prefix
\fB/\fP
A URL path to the main entry point for the application. This is useful
for serving multiple applications from the same URL.
.UNINDENT
.UNINDENT
.SS Authentication
.sp
Authentication is performed by passing a session token with each request.
Tokens are generated via the \fI\%Login\fP URL.
.sp
The token may be sent in one of two ways: as a custom header or as a session
cookie. The latter is far more convenient for clients that support cookies.
.INDENT 0.0
.IP \(bu 2
Include a custom header named \fIX\-Auth\-Token\fP\&.
.sp
For example, using curl:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sSk https://localhost:8000/login \e
    \-H \(aqAccept: application/x\-yaml\(aq \e
    \-d username=saltdev \e
    \-d password=saltdev \e
    \-d eauth=pam
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Copy the \fBtoken\fP value from the output and include it in subsequent requests:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sSk https://localhost:8000 \e
    \-H \(aqAccept: application/x\-yaml\(aq \e
    \-H \(aqX\-Auth\-Token: 697adbdc8fe971d09ae4c2a3add7248859c87079\(aq\e
    \-d client=local \e
    \-d tgt=\(aq*\(aq \e
    \-d fun=test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
Sent via a cookie. This option is a convenience for HTTP clients that
automatically handle cookie support (such as browsers).
.sp
For example, using curl:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
# Write the cookie file:
curl \-sSk https://localhost:8000/login \e
      \-c ~/cookies.txt \e
      \-H \(aqAccept: application/x\-yaml\(aq \e
      \-d username=saltdev \e
      \-d password=saltdev \e
      \-d eauth=auto

# Read the cookie file:
curl \-sSk https://localhost:8000 \e
      \-b ~/cookies.txt \e
      \-H \(aqAccept: application/x\-yaml\(aq \e
      \-d client=local \e
      \-d tgt=\(aq*\(aq \e
      \-d fun=test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Another example using the \fBrequests\fP library in Python:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
>>> import requests
>>> session = requests.Session()
>>> session.post(\(aqhttp://localhost:8000/login\(aq, json={
    \(aqusername\(aq: \(aqsaltdev\(aq,
    \(aqpassword\(aq: \(aqsaltdev\(aq,
    \(aqeauth\(aq: \(aqauto\(aq,
})
<Response [200]>
>>> resp = session.post(\(aqhttp://localhost:8000\(aq, json=[{
    \(aqclient\(aq: \(aqlocal\(aq,
    \(aqtgt\(aq: \(aq*\(aq,
    \(aqfun\(aq: \(aqtest.arg\(aq,
    \(aqarg\(aq: [\(aqfoo\(aq, \(aqbar\(aq],
    \(aqkwarg\(aq: {\(aqbaz\(aq: \(aqBaz!\(aq},
}])
>>> resp.json()
{u\(aqreturn\(aq: [{
    ...snip...
}]}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
You can bypass the session handling via the \fI\%Run\fP URL.
.UNINDENT
.UNINDENT
.SS Usage
.sp
This interface directly exposes Salt\(aqs \fI\%Python API\fP\&.
Everything possible at the CLI is possible through the Python API. Commands are
executed on the Salt Master.
.sp
The root URL (\fB/\fP) is RPC\-like in that it accepts instructions in the request
body for what Salt functions to execute, and the response contains the result
of those function calls.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
% curl \-sSi https://localhost:8000         \-H \(aqContent\-type: application/json\(aq         \-d \(aq[{
        \(dqclient\(dq: \(dqlocal\(dq,
        \(dqtgt\(dq: \(dq*\(dq,
        \(dqfun\(dq: \(dqtest.ping\(dq
    }]\(aq
HTTP/1.1 200 OK
Content\-Type: application/json
[...snip...]

{\(dqreturn\(dq: [{\(dqjerry\(dq: true}]}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The request body must be an array of commands. Use this workflow to build a
command:
.INDENT 0.0
.IP 1. 3
Choose a client interface.
.IP 2. 3
Choose a function.
.IP 3. 3
Fill out the remaining parameters needed for the chosen client.
.UNINDENT
.sp
The \fBclient\fP field is a reference to the main Python classes used in Salt\(aqs
Python API. Read the full \fI\%Client APIs\fP documentation, but
in short:
.INDENT 0.0
.IP \(bu 2
\(dqlocal\(dq uses \fI\%LocalClient\fP which sends
commands to Minions. Equivalent to the \fBsalt\fP CLI command.
.IP \(bu 2
\(dqrunner\(dq uses \fI\%RunnerClient\fP which
invokes runner modules on the Master. Equivalent to the \fBsalt\-run\fP CLI
command.
.IP \(bu 2
\(dqwheel\(dq uses \fI\%WheelClient\fP which invokes
wheel modules on the Master. Wheel modules do not have a direct CLI
equivalent but they typically manage Master\-side resources such as state
files, pillar files, the Salt config files, and the \fI\%key wheel module\fP exposes similar functionality as the \fBsalt\-key\fP CLI
command.
.UNINDENT
.sp
Most clients have variants like synchronous or asynchronous execution as well as
others like batch execution. See the \fI\%full list of client interfaces\fP\&.
.sp
Each client requires different arguments and sometimes has different syntax.
For example, \fBLocalClient\fP requires the \fBtgt\fP argument because it forwards
the command to Minions and the other client interfaces do not. \fBLocalClient\fP
also takes \fBarg\fP (array) and \fBkwarg\fP (dictionary) arguments because these
values are sent to the Minions and used to execute the requested function
there. \fBRunnerClient\fP and \fBWheelClient\fP are executed directly on the Master
and thus do not need or accept those arguments.
.sp
Read the method signatures in the client documentation linked above, but
hopefully an example will help illustrate the concept. This example causes Salt
to execute two functions \-\- the \fI\%test.arg execution function\fP using \fBLocalClient\fP and the \fI\%test.arg
runner function\fP using \fBRunnerClient\fP; note the
different structure for each command. The results for both are combined and
returned as one response.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
% curl \-b ~/cookies.txt \-sSi localhost:8000         \-H \(aqContent\-type: application/json\(aq         \-d \(aq
[
    {
        \(dqclient\(dq: \(dqlocal\(dq,
        \(dqtgt\(dq: \(dq*\(dq,
        \(dqfun\(dq: \(dqtest.arg\(dq,
        \(dqarg\(dq: [\(dqpositional arg one\(dq, \(dqpositional arg two\(dq],
        \(dqkwarg\(dq: {
            \(dqkeyword arg one\(dq: \(dqHello from a minion\(dq,
            \(dqkeyword arg two\(dq: \(dqHello again from a minion\(dq
        }
    },
    {
        \(dqclient\(dq: \(dqrunner\(dq,
        \(dqfun\(dq: \(dqtest.arg\(dq,
        \(dqkeyword arg one\(dq: \(dqHello from a master\(dq,
        \(dqkeyword arg two\(dq: \(dqRunners do not support positional args\(dq
    }
]
\(aq
HTTP/1.1 200 OK
[...snip...]
{
  \(dqreturn\(dq: [
    {
      \(dqjerry\(dq: {
        \(dqargs\(dq: [
          \(dqpositional arg one\(dq,
          \(dqpositional arg two\(dq
        ],
        \(dqkwargs\(dq: {
          \(dqkeyword arg one\(dq: \(dqHello from a minion\(dq,
          \(dqkeyword arg two\(dq: \(dqHello again from a minion\(dq,
          [...snip...]
        }
      },
      [...snip; other minion returns here...]
    },
    {
      \(dqargs\(dq: [],
      \(dqkwargs\(dq: {
        \(dqkeyword arg two\(dq: \(dqRunners do not support positional args\(dq,
        \(dqkeyword arg one\(dq: \(dqHello from a master\(dq
      }
    }
  ]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
One more example, this time with more commonly used functions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-b /tmp/cookies.txt \-sSi localhost:8000         \-H \(aqContent\-type: application/json\(aq         \-d \(aq
[
    {
        \(dqclient\(dq: \(dqlocal\(dq,
        \(dqtgt\(dq: \(dq*\(dq,
        \(dqfun\(dq: \(dqstate.sls\(dq,
        \(dqkwarg\(dq: {
            \(dqmods\(dq: \(dqapache\(dq,
            \(dqpillar\(dq: {
                \(dqlookup\(dq: {
                    \(dqwwwdir\(dq: \(dq/srv/httpd/htdocs\(dq
                }
            }
        }
    },
    {
        \(dqclient\(dq: \(dqrunner\(dq,
        \(dqfun\(dq: \(dqcloud.create\(dq,
        \(dqprovider\(dq: \(dqmy\-ec2\-provider\(dq,
        \(dqinstances\(dq: \(dqmy\-centos\-6\(dq,
        \(dqimage\(dq: \(dqami\-1624987f\(dq,
        \(dqdelvol_on_destroy\(dq, true
    }
]
\(aq
HTTP/1.1 200 OK
[...snip...]
{
  \(dqreturn\(dq: [
    {
      \(dqjerry\(dq: {
        \(dqpkg_|\-install_apache_|\-httpd_|\-installed\(dq: {
            [...snip full state return here...]
        }
      }
      [...snip other minion returns here...]
    },
    {
        [...snip full salt\-cloud output here...]
    }
  ]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Content negotiation
.sp
This REST interface is flexible in what data formats it will accept as well
as what formats it will return (e.g., JSON, YAML, urlencoded).
.INDENT 0.0
.IP \(bu 2
Specify the format of data in the request body by including the
\fIContent\-Type\fP header.
.IP \(bu 2
Specify the desired data format for the response body with the
\fIAccept\fP header.
.UNINDENT
.sp
We recommend the JSON format for most HTTP requests. urlencoded data is simple
and cannot express complex data structures \-\- and that is often required for
some Salt commands, such as starting a state run that uses Pillar data. Salt\(aqs
CLI tool can reformat strings passed in at the CLI into complex data
structures, and that behavior also works via salt\-api, but that can be brittle
and since salt\-api can accept JSON it is best just to send JSON.
.sp
Here is an example of sending urlencoded data:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sSik https://localhost:8000 \e
    \-b ~/cookies.txt \e
    \-d client=runner \e
    \-d fun=\(aqjobs.lookup_jid\(aq \e
    \-d jid=\(aq20150129182456704682\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.IP "urlencoded data caveats"
.INDENT 0.0
.IP \(bu 2
Only a single command may be sent per HTTP request.
.IP \(bu 2
Repeating the \fBarg\fP parameter multiple times will cause those
parameters to be combined into a single list.
.sp
Note, some popular frameworks and languages (notably jQuery, PHP, and
Ruby on Rails) will automatically append empty brackets onto repeated
query string parameters. E.g., \fB?foo[]=fooone&foo[]=footwo\fP\&. This is
\fBnot\fP supported; send \fB?foo=fooone&foo=footwo\fP instead, or send JSON
or YAML.
.UNINDENT
.sp
A note about \fBcurl\fP
.sp
The \fB\-d\fP flag to curl does \fInot\fP automatically urlencode data which can
affect passwords and other data that contains characters that must be
encoded. Use the \fB\-\-data\-urlencode\fP flag instead. E.g.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-ksi http://localhost:8000/login \e
\-H \(dqAccept: application/json\(dq \e
\-d username=\(aqmyapiuser\(aq \e
\-\-data\-urlencode password=\(aq1234+\(aq \e
\-d eauth=\(aqpam\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Performance Expectations and Recommended Usage
.sp
This module provides a thin wrapper around \fI\%Salt\(aqs Python API\fP\&. Executing a Salt command via rest_cherrypy is directly analogous
to executing a Salt command via Salt\(aqs CLI (which also uses the Python API) \-\-
they share the same semantics, performance characteristics, and 98% of the same
code. As a rule\-of\-thumb: if you wouldn\(aqt do it at the CLI don\(aqt do it via this
API.
.SS Long\-Running HTTP Connections
.sp
The CherryPy server is a production\-ready, threading HTTP server written in
Python. Because it makes use of a thread pool to process HTTP requests it is
not ideally suited to maintaining large numbers of concurrent, synchronous
connections. On moderate hardware with default settings it should top\-out at
around 30 to 50 concurrent connections.
.sp
That number of long\-running, synchronous Salt processes is also not ideal. Like
at the CLI, each Salt command run will start a process that instantiates its
own \fBLocalClient\fP, which instantiates its own listener to the Salt event bus,
and sends out its own periodic \fBsaltutil.find_job\fP queries to determine if a
Minion is still running the command. Not exactly a lightweight operation.
.SS Timeouts
.sp
In addition to the above resource overhead for long\-running connections, there
are the usual HTTP timeout semantics for the CherryPy server, any HTTP client
being used, as well as any hardware in between such as proxies, gateways, or
load balancers. rest_cherrypy can be configured not to time\-out long responses
via the \fBexpire_responses\fP setting, and both \fI\%LocalClient\fP and \fI\%RunnerClient\fP have their own timeout parameters that may be
passed as top\-level keywords:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-b /tmp/cookies.txt \-sSi localhost:8000         \-H \(aqContent\-type: application/json\(aq         \-d \(aq
[
    {
        \(dqclient\(dq: \(dqlocal\(dq,
        \(dqtgt\(dq: \(dq*\(dq,
        \(dqfun\(dq: \(dqtest.sleep\(dq,
        \(dqkwarg\(dq: {\(dqlength\(dq: 30},
        \(dqtimeout\(dq: 60
    },
    {
        \(dqclient\(dq: \(dqrunner\(dq,
        \(dqfun\(dq: \(dqtest.sleep\(dq,
        \(dqkwarg\(dq: {\(dqs_time\(dq: 30},
        \(dqtimeout\(dq: 60
    }
]
\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Best Practices
.sp
Given the performance overhead and HTTP timeouts for long\-running operations
described above, the most effective and most scalable way to use both Salt and
salt\-api is to run commands asynchronously using the \fBlocal_async\fP,
\fBrunner_async\fP, and \fBwheel_async\fP clients.
.sp
Running asynchronous jobs results in being able to process 3x more commands per second
for \fBLocalClient\fP and 17x more commands per second for \fBRunnerClient\fP, in
addition to much less network traffic and memory requirements. Job returns can
be fetched from Salt\(aqs job cache via the \fB/jobs/<jid>\fP endpoint, or they can
be collected into a data store using Salt\(aqs \fI\%Returner system\fP\&.
.sp
The \fB/events\fP endpoint is specifically designed to handle long\-running HTTP
connections and it exposes Salt\(aqs event bus which includes job returns.
Watching this endpoint first, then executing asynchronous Salt commands second,
is the most lightweight and scalable way to use \fBrest_cherrypy\fP while still
receiving job returns in real\-time. But this requires clients that can properly
handle the inherent asynchronicity of that workflow.
.SS Performance Tuning
.sp
The \fBthread_pool\fP and \fBsocket_queue_size\fP settings can be used to increase
the capacity of rest_cherrypy to handle incoming requests. Keep an eye on RAM
usage as well as available file handles while testing changes to these
settings. As salt\-api is a thin wrapper around Salt\(aqs Python API, also keep an
eye on the performance of Salt when testing.
.SS Future Plans
.sp
Now that Salt uses the Tornado concurrency library internally, we plan to
improve performance in the API by taking advantage of existing processes and
event listeners and to use lightweight coroutines to facilitate more
simultaneous HTTP connections and better support for synchronous operations.
That effort can be tracked in \fI\%issue 26505\fP, but until that issue is closed
rest_cherrypy will remain the officially recommended REST API.
.SS Deployment
.sp
The \fBrest_cherrypy\fP netapi module is a standard Python WSGI app. It can be
deployed one of two ways.
.SS \fBsalt\-api\fP using the CherryPy server
.sp
The default configuration is to run this module using \fBsalt\-api\fP to
start the Python\-based CherryPy server. This server is lightweight,
multi\-threaded, encrypted with SSL, and should be considered production\-ready.
See the section above for performance expectations.
.SS Using a WSGI\-compliant web server
.sp
This module may be deployed on any WSGI\-compliant server such as Apache with
mod_wsgi or Nginx with FastCGI, to name just two (there are many).
.sp
Note, external WSGI servers handle URLs, paths, and SSL certs directly. The
\fBrest_cherrypy\fP configuration options are ignored and the \fBsalt\-api\fP daemon
does not need to be running at all. Remember Salt authentication credentials
are sent in the clear unless SSL is being enforced!
.sp
An example Apache virtual host configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<VirtualHost *:80>
    ServerName example.com
    ServerAlias *.example.com

    ServerAdmin webmaster@example.com

    LogLevel warn
    ErrorLog /var/www/example.com/logs/error.log
    CustomLog /var/www/example.com/logs/access.log combined

    DocumentRoot /var/www/example.com/htdocs

    WSGIScriptAlias / /path/to/salt/netapi/rest_cherrypy/wsgi.py
</VirtualHost>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS REST URI Reference
.SS \fB/\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_cherrypy.app.LowDataAdapter
The primary entry point to Salt\(aqs REST API
.INDENT 7.0
.TP
.B GET()
An explanation of the API with links of where to go next
.INDENT 7.0
.TP
.B GET /
.INDENT 7.0
.TP
.B Request Headers
.INDENT 7.0
.IP \(bu 2
\fI\%Accept\fP \-\- the desired response format.
.UNINDENT
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-i localhost:8000
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
GET / HTTP/1.1
Host: localhost:8000
Accept: application/json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Type: application/json
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B POST(**kwargs)
Send one or more Salt commands in the request body
.INDENT 7.0
.TP
.B POST /
.INDENT 7.0
.TP
.B Request Headers
.INDENT 7.0
.IP \(bu 2
\fIX\-Auth\-Token\fP \-\- a session token from \fI\%Login\fP\&.
.IP \(bu 2
\fI\%Accept\fP \-\- the desired response format.
.IP \(bu 2
\fI\%Content\-Type\fP \-\- the format of the request body.
.UNINDENT
.TP
.B Response Headers
.INDENT 7.0
.IP \(bu 2
\fI\%Content\-Type\fP \-\- the format of the response body; depends on the
\fIAccept\fP request header.
.UNINDENT
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%400 Bad Request\fP \-\- bad or malformed request
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.sp
\fI\%lowstate\fP data describing Salt commands must be sent in the
request body.
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sSik https://localhost:8000 \e
    \-b ~/cookies.txt \e
    \-H \(dqAccept: application/x\-yaml\(dq \e
    \-H \(dqContent\-type: application/json\(dq \e
    \-d \(aq[{\(dqclient\(dq: \(dqlocal\(dq, \(dqtgt\(dq: \(dq*\(dq, \(dqfun\(dq: \(dqtest.ping\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
POST / HTTP/1.1
Host: localhost:8000
Accept: application/x\-yaml
X\-Auth\-Token: d40d1e1e
Content\-Type: application/json

[{\(dqclient\(dq: \(dqlocal\(dq, \(dqtgt\(dq: \(dq*\(dq, \(dqfun\(dq: \(dqtest.ping\(dq}]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Length: 200
Allow: GET, HEAD, POST
Content\-Type: application/x\-yaml

return:
\- ms\-0: true
  ms\-1: true
  ms\-2: true
  ms\-3: true
  ms\-4: true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fB/login\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_cherrypy.app.Login(*args, **kwargs)
Log in to receive a session token
.sp
\fI\%Authentication information\fP\&.
.INDENT 7.0
.TP
.B GET()
Present the login interface
.INDENT 7.0
.TP
.B GET /login
An explanation of how to log in.
.INDENT 7.0
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-i localhost:8000/login
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
GET /login HTTP/1.1
Host: localhost:8000
Accept: text/html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Type: text/html
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B POST(**kwargs)
\fI\%Authenticate\fP against Salt\(aqs eauth system
.INDENT 7.0
.TP
.B POST /login
.INDENT 7.0
.TP
.B Request Headers
.INDENT 7.0
.IP \(bu 2
\fIX\-Auth\-Token\fP \-\- a session token from \fI\%Login\fP\&.
.IP \(bu 2
\fI\%Accept\fP \-\- the desired response format.
.IP \(bu 2
\fI\%Content\-Type\fP \-\- the format of the request body.
.UNINDENT
.TP
.B Form Parameters
.INDENT 7.0
.IP \(bu 2
\fBeauth\fP \-\- the eauth backend configured for the user
.IP \(bu 2
\fBusername\fP \-\- username
.IP \(bu 2
\fBpassword\fP \-\- password
.UNINDENT
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-si localhost:8000/login \e
    \-c ~/cookies.txt \e
    \-H \(dqAccept: application/json\(dq \e
    \-H \(dqContent\-type: application/json\(dq \e
    \-d \(aq{
        \(dqusername\(dq: \(dqsaltuser\(dq,
        \(dqpassword\(dq: \(dqsaltuser\(dq,
        \(dqeauth\(dq: \(dqauto\(dq
    }\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
POST / HTTP/1.1
Host: localhost:8000
Content\-Length: 42
Content\-Type: application/json
Accept: application/json

{\(dqusername\(dq: \(dqsaltuser\(dq, \(dqpassword\(dq: \(dqsaltuser\(dq, \(dqeauth\(dq: \(dqauto\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Type: application/json
Content\-Length: 206
X\-Auth\-Token: 6d1b722e
Set\-Cookie: session_id=6d1b722e; expires=Sat, 17 Nov 2012 03:23:52 GMT; Path=/

{\(dqreturn\(dq: {
    \(dqtoken\(dq: \(dq6d1b722e\(dq,
    \(dqstart\(dq: 1363805943.776223,
    \(dqexpire\(dq: 1363849143.776224,
    \(dquser\(dq: \(dqsaltuser\(dq,
    \(dqeauth\(dq: \(dqpam\(dq,
    \(dqperms\(dq: [
        \(dqgrains.*\(dq,
        \(dqstatus.*\(dq,
        \(dqsys.*\(dq,
        \(dqtest.*\(dq
    ]
}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fB/logout\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_cherrypy.app.Logout
Class to remove or invalidate sessions
.INDENT 7.0
.TP
.B POST()
Destroy the currently active session and expire the session cookie
.UNINDENT
.UNINDENT
.SS \fB/minions\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_cherrypy.app.Minions
Convenience URLs for working with minions
.INDENT 7.0
.TP
.B GET(mid=None)
A convenience URL for getting lists of minions or getting minion
details
.INDENT 7.0
.TP
.B GET /minions/(mid)
.INDENT 7.0
.TP
.B Request Headers
.INDENT 7.0
.IP \(bu 2
\fIX\-Auth\-Token\fP \-\- a session token from \fI\%Login\fP\&.
.IP \(bu 2
\fI\%Accept\fP \-\- the desired response format.
.UNINDENT
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-i localhost:8000/minions/ms\-3
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
GET /minions/ms\-3 HTTP/1.1
Host: localhost:8000
Accept: application/x\-yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Length: 129005
Content\-Type: application/x\-yaml

return:
\- ms\-3:
    grains.items:
        ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B POST(**kwargs)
Start an execution command and immediately return the job id
.INDENT 7.0
.TP
.B POST /minions
.INDENT 7.0
.TP
.B Request Headers
.INDENT 7.0
.IP \(bu 2
\fIX\-Auth\-Token\fP \-\- a session token from \fI\%Login\fP\&.
.IP \(bu 2
\fI\%Accept\fP \-\- the desired response format.
.IP \(bu 2
\fI\%Content\-Type\fP \-\- the format of the request body.
.UNINDENT
.TP
.B Response Headers
.INDENT 7.0
.IP \(bu 2
\fI\%Content\-Type\fP \-\- the format of the response body; depends on the
\fIAccept\fP request header.
.UNINDENT
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%400 Bad Request\fP \-\- bad or malformed request
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.sp
Lowstate data describing Salt commands must be sent in the request
body. The \fBclient\fP option will be set to
\fBlocal_async()\fP\&.
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sSi localhost:8000/minions \e
    \-b ~/cookies.txt \e
    \-H \(dqAccept: application/x\-yaml\(dq \e
    \-d \(aq[{\(dqtgt\(dq: \(dq*\(dq, \(dqfun\(dq: \(dqstatus.diskusage\(dq}]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
POST /minions HTTP/1.1
Host: localhost:8000
Accept: application/x\-yaml
Content\-Type: application/x\-www\-form\-urlencoded

tgt=*&fun=status.diskusage
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 202 Accepted
Content\-Length: 86
Content\-Type: application/x\-yaml

return:
\- jid: \(aq20130603122505459265\(aq
  minions: [ms\-4, ms\-3, ms\-2, ms\-1, ms\-0]
_links:
  jobs:
    \- href: /jobs/20130603122505459265
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fB/jobs\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_cherrypy.app.Jobs
.INDENT 7.0
.TP
.B GET(jid=None, timeout=\(aq\(aq)
A convenience URL for getting lists of previously run jobs or getting
the return from a single job
.INDENT 7.0
.TP
.B GET /jobs/(jid)
List jobs or show a single job from the job cache.
.INDENT 7.0
.TP
.B Request Headers
.INDENT 7.0
.IP \(bu 2
\fIX\-Auth\-Token\fP \-\- a session token from \fI\%Login\fP\&.
.IP \(bu 2
\fI\%Accept\fP \-\- the desired response format.
.UNINDENT
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-i localhost:8000/jobs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
GET /jobs HTTP/1.1
Host: localhost:8000
Accept: application/x\-yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Length: 165
Content\-Type: application/x\-yaml

return:
\- \(aq20121130104633606931\(aq:
    Arguments:
    \- \(aq3\(aq
    Function: test.fib
    Start Time: 2012, Nov 30 10:46:33.606931
    Target: jerry
    Target\-type: glob
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-i localhost:8000/jobs/20121130104633606931
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
GET /jobs/20121130104633606931 HTTP/1.1
Host: localhost:8000
Accept: application/x\-yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Length: 73
Content\-Type: application/x\-yaml

info:
\- Arguments:
    \- \(aq3\(aq
    Function: test.fib
    Minions:
    \- jerry
    Start Time: 2012, Nov 30 10:46:33.606931
    Target: \(aq*\(aq
    Target\-type: glob
    User: saltdev
    jid: \(aq20121130104633606931\(aq
return:
\- jerry:
    \- \- 0
    \- 1
    \- 1
    \- 2
    \- 6.9141387939453125e\-06
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fB/run\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_cherrypy.app.Run
Run commands bypassing the \fI\%normal session handling\fP\&.
.sp
salt\-api does not enforce authorization, Salt\(aqs eauth system does that.
Local/Runner/WheelClient all accept \fBusername\fP/\fBpassword\fP/\fBeauth\fP
\fBor\fP \fBtoken\fP kwargs that are then checked by the eauth system. The
session mechanism in \fBrest_cherrypy\fP simply pairs a session with a Salt
eauth token and then passes the \fBtoken\fP kwarg in automatically.
.sp
If you already have a Salt eauth token, perhaps generated by the
\fI\%mk_token\fP function in the Auth
Runner module, then there is no reason to use sessions.
.sp
This endpoint accepts either a \fBusername\fP, \fBpassword\fP, \fBeauth\fP trio,
\fBor\fP a \fBtoken\fP kwarg and does not make use of sessions at all.
.INDENT 7.0
.TP
.B POST(**kwargs)
Run commands bypassing the \fI\%normal session handling\fP\&.  Otherwise, this URL is identical to the
\fI\%root URL (/)\fP\&.
.INDENT 7.0
.TP
.B POST /run
An array of lowstate data describing Salt commands must be sent in
the request body.
.INDENT 7.0
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%400 Bad Request\fP \-\- bad or malformed request
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sS localhost:8000/run \e
    \-H \(aqAccept: application/x\-yaml\(aq \e
    \-H \(aqContent\-type: application/json\(aq \e
    \-d \(aq[{
        \(dqclient\(dq: \(dqlocal\(dq,
        \(dqtgt\(dq: \(dq*\(dq,
        \(dqfun\(dq: \(dqtest.ping\(dq,
        \(dqusername\(dq: \(dqsaltdev\(dq,
        \(dqpassword\(dq: \(dqsaltdev\(dq,
        \(dqeauth\(dq: \(dqauto\(dq
    }]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBOr\fP using a Salt Eauth token:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sS localhost:8000/run \e
    \-H \(aqAccept: application/x\-yaml\(aq \e
    \-H \(aqContent\-type: application/json\(aq \e
    \-d \(aq[{
        \(dqclient\(dq: \(dqlocal\(dq,
        \(dqtgt\(dq: \(dq*\(dq,
        \(dqfun\(dq: \(dqtest.ping\(dq,
        \(dqtoken\(dq: \(dq<salt eauth token here>\(dq
    }]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
POST /run HTTP/1.1
Host: localhost:8000
Accept: application/x\-yaml
Content\-Length: 75
Content\-Type: application/json

[{\(dqclient\(dq: \(dqlocal\(dq, \(dqtgt\(dq: \(dq*\(dq, \(dqfun\(dq: \(dqtest.ping\(dq, \(dqusername\(dq: \(dqsaltdev\(dq, \(dqpassword\(dq: \(dqsaltdev\(dq, \(dqeauth\(dq: \(dqauto\(dq}]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Length: 73
Content\-Type: application/x\-yaml

return:
\- ms\-0: true
  ms\-1: true
  ms\-2: true
  ms\-3: true
  ms\-4: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The /run endpoint can also be used to issue commands using the salt\-ssh
subsystem.  When using salt\-ssh, eauth credentials must also be
supplied, and are subject to \fI\%eauth access\-control lists\fP\&.
.sp
All SSH client requests are synchronous.
.sp
\fBExample SSH client request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sS localhost:8000/run \e
    \-H \(aqAccept: application/x\-yaml\(aq \e
    \-d client=\(aqssh\(aq \e
    \-d tgt=\(aq*\(aq \e
    \-d username=\(aqsaltdev\(aq \e
    \-d password=\(aqsaltdev\(aq \e
    \-d eauth=\(aqauto\(aq \e
    \-d fun=\(aqtest.ping\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
POST /run HTTP/1.1
Host: localhost:8000
Accept: application/x\-yaml
Content\-Length: 75
Content\-Type: application/x\-www\-form\-urlencoded
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample SSH response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
return:
\- silver:
    _stamp: \(aq2020\-09\-08T23:04:28.912609\(aq
    fun: test.ping
    fun_args: []
    id: silver
    jid: \(aq20200908230427905565\(aq
    retcode: 0
    return: true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fB/events\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_cherrypy.app.Events
Expose the Salt event bus
.sp
The event bus on the Salt master exposes a large variety of things, notably
when executions are started on the master and also when minions ultimately
return their results. This URL provides a real\-time window into a running
Salt infrastructure.
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
\fI\%Events & Reactor\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B GET(token=None, salt_token=None)
An HTTP stream of the Salt master event bus
.sp
This stream is formatted per the Server Sent Events (SSE) spec. Each
event is formatted as JSON.
.INDENT 7.0
.TP
.B GET /events
.INDENT 7.0
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.TP
.B Query Parameters
.INDENT 7.0
.IP \(bu 2
\fBtoken\fP \-\- \fBoptional\fP parameter containing the token
ordinarily supplied via the X\-Auth\-Token header in order to
allow cross\-domain requests in browsers that do not include
CORS support in the EventSource API. E.g.,
\fBcurl \-NsS localhost:8000/events?token=308650d\fP
.IP \(bu 2
\fBsalt_token\fP \-\- \fBoptional\fP parameter containing a raw Salt
\fIeauth token\fP (not to be confused with the token returned from
the /login URL). E.g.,
\fBcurl \-NsS localhost:8000/events?salt_token=30742765\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-NsS localhost:8000/events
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
GET /events HTTP/1.1
Host: localhost:8000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.sp
Note, the \fBtag\fP field is not part of the spec. SSE compliant clients
should ignore unknown fields. This addition allows non\-compliant
clients to only watch for certain tags without having to deserialze the
JSON object each time.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Connection: keep\-alive
Cache\-Control: no\-cache
Content\-Type: text/event\-stream;charset=utf\-8

retry: 400

tag: salt/job/20130802115730568475/new
data: {\(aqtag\(aq: \(aqsalt/job/20130802115730568475/new\(aq, \(aqdata\(aq: {\(aqminions\(aq: [\(aqms\-4\(aq, \(aqms\-3\(aq, \(aqms\-2\(aq, \(aqms\-1\(aq, \(aqms\-0\(aq]}}

tag: salt/job/20130802115730568475/ret/jerry
data: {\(aqtag\(aq: \(aqsalt/job/20130802115730568475/ret/jerry\(aq, \(aqdata\(aq: {\(aqjid\(aq: \(aq20130802115730568475\(aq, \(aqreturn\(aq: True, \(aqretcode\(aq: 0, \(aqsuccess\(aq: True, \(aqcmd\(aq: \(aq_return\(aq, \(aqfun\(aq: \(aqtest.ping\(aq, \(aqid\(aq: \(aqms\-1\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The event stream can be easily consumed via JavaScript:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
var source = new EventSource(\(aq/events\(aq);
source.onopen = function() { console.info(\(aqListening ...\(aq) };
source.onerror = function(err) { console.error(err) };
source.onmessage = function(message) {
    var saltEvent = JSON.parse(message.data);
    console.log(saltEvent.tag, saltEvent.data);
};
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note, the SSE stream is fast and completely asynchronous and Salt is
very fast. If a job is created using a regular POST request, it is
possible that the job return will be available on the SSE stream before
the response for the POST request arrives. It is important to take that
asynchronicity into account when designing an application. Below are
some general guidelines.
.INDENT 7.0
.IP \(bu 2
Subscribe to the SSE stream _before_ creating any events.
.IP \(bu 2
Process SSE events directly as they arrive and don\(aqt wait for any
other process to \(dqcomplete\(dq first (like an ajax request).
.IP \(bu 2
Keep a buffer of events if the event stream must be used for
synchronous lookups.
.IP \(bu 2
Be cautious in writing Salt\(aqs event stream directly to the DOM. It is
very busy and can quickly overwhelm the memory allocated to a
browser tab.
.UNINDENT
.sp
A full, working proof\-of\-concept JavaScript application is available
\fI\%adjacent to this file\fP\&.
It can be viewed by pointing a browser at the \fB/app\fP endpoint in a
running \fBrest_cherrypy\fP instance.
.sp
Or using CORS:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
var source = new EventSource(\(aq/events?token=ecd589e4e01912cf3c4035afad73426dbb8dba75\(aq, {withCredentials: true});
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is also possible to consume the stream via the shell.
.sp
Records are separated by blank lines; the \fBdata:\fP and \fBtag:\fP
prefixes will need to be removed manually before attempting to
unserialize the JSON.
.sp
curl\(aqs \fB\-N\fP flag turns off input buffering which is required to
process the stream incrementally.
.sp
Here is a basic example of printing each event as it comes in:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-NsS localhost:8000/events |\e
        while IFS= read \-r line ; do
            echo $line
        done
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here is an example of using awk to filter events based on tag:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-NsS localhost:8000/events |\e
        awk \(aq
            BEGIN { RS=\(dq\(dq; FS=\(dq\e\en\(dq }
            $1 ~ /^tag: salt\e/job\e/[0\-9]+\e/new$/ { print $0 }
        \(aq
tag: salt/job/20140112010149808995/new
data: {\(dqtag\(dq: \(dqsalt/job/20140112010149808995/new\(dq, \(dqdata\(dq: {\(dqtgt_type\(dq: \(dqglob\(dq, \(dqjid\(dq: \(dq20140112010149808995\(dq, \(dqtgt\(dq: \(dqjerry\(dq, \(dq_stamp\(dq: \(dq2014\-01\-12_01:01:49.809617\(dq, \(dquser\(dq: \(dqshouse\(dq, \(dqarg\(dq: [], \(dqfun\(dq: \(dqtest.ping\(dq, \(dqminions\(dq: [\(dqjerry\(dq]}}
tag: 20140112010149808995
data: {\(dqtag\(dq: \(dq20140112010149808995\(dq, \(dqdata\(dq: {\(dqfun_args\(dq: [], \(dqjid\(dq: \(dq20140112010149808995\(dq, \(dqreturn\(dq: true, \(dqretcode\(dq: 0, \(dqsuccess\(dq: true, \(dqcmd\(dq: \(dq_return\(dq, \(dq_stamp\(dq: \(dq2014\-01\-12_01:01:49.819316\(dq, \(dqfun\(dq: \(dqtest.ping\(dq, \(dqid\(dq: \(dqjerry\(dq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fB/hook\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_cherrypy.app.Webhook
A generic web hook entry point that fires an event on Salt\(aqs event bus
.sp
External services can POST data to this URL to trigger an event in Salt.
For example, Amazon SNS, Jenkins\-CI or Travis\-CI, or GitHub web hooks.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Be mindful of security
.sp
Salt\(aqs Reactor can run any code. A Reactor SLS that responds to a hook
event is responsible for validating that the event came from a trusted
source and contains valid data.
.sp
\fBThis is a generic interface and securing it is up to you!\fP
.sp
This URL requires authentication however not all external services can
be configured to authenticate. For this reason authentication can be
selectively disabled for this URL. Follow best practices \-\- always use
SSL, pass a secret key, configure the firewall to only allow traffic
from a known source, etc.
.UNINDENT
.UNINDENT
.sp
The event data is taken from the request body. The
\fIContent\-Type\fP header is respected for the payload.
.sp
The event tag is prefixed with \fBsalt/netapi/hook\fP and the URL path is
appended to the end. For example, a \fBPOST\fP request sent to
\fB/hook/mycompany/myapp/mydata\fP will produce a Salt event with the tag
\fBsalt/netapi/hook/mycompany/myapp/mydata\fP\&.
.sp
The following is an example \fB\&.travis.yml\fP file to send notifications to
Salt of successful test runs:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
language: python
script: python \-m unittest tests
after_success:
    \- |
        curl \-sSk https://saltapi\-url.example.com:8000/hook/travis/build/success                         \-d branch=\(dq${TRAVIS_BRANCH}\(dq                         \-d commit=\(dq${TRAVIS_COMMIT}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
\fI\%Events & Reactor\fP, \fI\%reactor\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B POST(*args, **kwargs)
Fire an event in Salt with a custom event tag and data
.INDENT 7.0
.TP
.B POST /hook
.INDENT 7.0
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.IP \(bu 2
\fI\%413 Request Entity Too Large\fP \-\- request body is too large
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sS localhost:8000/hook \e
    \-H \(aqContent\-type: application/json\(aq \e
    \-d \(aq{\(dqfoo\(dq: \(dqFoo!\(dq, \(dqbar\(dq: \(dqBar!\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
POST /hook HTTP/1.1
Host: localhost:8000
Content\-Length: 16
Content\-Type: application/json

{\(dqfoo\(dq: \(dqFoo!\(dq, \(dqbar\(dq: \(dqBar!\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Length: 14
Content\-Type: application/json

{\(dqsuccess\(dq: true}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As a practical example, an internal continuous\-integration build
server could send an HTTP POST request to the URL
\fBhttps://localhost:8000/hook/mycompany/build/success\fP which contains
the result of a build and the SHA of the version that was built as
JSON. That would then produce the following event in Salt that could be
used to kick off a deployment via Salt\(aqs Reactor:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Event fired at Fri Feb 14 17:40:11 2014
*************************
Tag: salt/netapi/hook/mycompany/build/success
Data:
{\(aq_stamp\(aq: \(aq2014\-02\-14_17:40:11.440996\(aq,
    \(aqheaders\(aq: {
        \(aqX\-My\-Secret\-Key\(aq: \(aqF0fAgoQjIT@W\(aq,
        \(aqContent\-Length\(aq: \(aq37\(aq,
        \(aqContent\-Type\(aq: \(aqapplication/json\(aq,
        \(aqHost\(aq: \(aqlocalhost:8000\(aq,
        \(aqRemote\-Addr\(aq: \(aq127.0.0.1\(aq},
    \(aqpost\(aq: {\(aqrevision\(aq: \(aqaa22a3c4b2e7\(aq, \(aqresult\(aq: True}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt\(aqs Reactor could listen for the event:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
reactor:
  \- \(aqsalt/netapi/hook/mycompany/build/*\(aq:
    \- /srv/reactor/react_ci_builds.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And finally deploy the new build:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set secret_key = data.get(\(aqheaders\(aq, {}).get(\(aqX\-My\-Secret\-Key\(aq) %}
{% set build = data.get(\(aqpost\(aq, {}) %}

{% if secret_key == \(aqF0fAgoQjIT@W\(aq and build.result == True %}
deploy_my_app:
  cmd.state.sls:
    \- tgt: \(aqapplication*\(aq
    \- arg:
      \- myapp.deploy
    \- kwarg:
        pillar:
          revision: {{ revision }}
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fB/keys\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_cherrypy.app.Keys
Convenience URLs for working with minion keys
.sp
New in version 2014.7.0.

.sp
These URLs wrap the functionality provided by the \fI\%key wheel
module\fP functions.
.INDENT 7.0
.TP
.B GET(mid=None)
Show the list of minion keys or detail on a specific key
.sp
New in version 2014.7.0.

.INDENT 7.0
.TP
.B GET /keys/(mid)
List all keys or show a specific key
.INDENT 7.0
.TP
.B Request Headers
.INDENT 7.0
.IP \(bu 2
\fIX\-Auth\-Token\fP \-\- a session token from \fI\%Login\fP\&.
.IP \(bu 2
\fI\%Accept\fP \-\- the desired response format.
.UNINDENT
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-i localhost:8000/keys
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
GET /keys HTTP/1.1
Host: localhost:8000
Accept: application/x\-yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Length: 165
Content\-Type: application/x\-yaml

return:
  local:
  \- master.pem
  \- master.pub
  minions:
  \- jerry
  minions_pre: []
  minions_rejected: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-i localhost:8000/keys/jerry
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
GET /keys/jerry HTTP/1.1
Host: localhost:8000
Accept: application/x\-yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Length: 73
Content\-Type: application/x\-yaml

return:
  minions:
    jerry: 51:93:b3:d0:9f:3a:6d:e5:28:67:c2:4b:27:d6:cd:2b
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B POST(**kwargs)
Easily generate keys for a minion and auto\-accept the new key
.sp
Accepts all the same parameters as the \fI\%key.gen_accept\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A note about \fBcurl\fP
Avoid using the \fB\-i\fP flag or HTTP headers will be written and
produce an invalid tar file.
.UNINDENT
.UNINDENT
.sp
Example partial kickstart script to bootstrap a new minion:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
%post
mkdir \-p /etc/salt/pki/minion
curl \-sSk https://localhost:8000/keys \e
        \-d mid=jerry \e
        \-d username=kickstart \e
        \-d password=kickstart \e
        \-d eauth=pam \e
    | tar \-C /etc/salt/pki/minion \-xf \-

mkdir \-p /etc/salt/minion.d
printf \(aqmaster: 10.0.0.5\enid: jerry\(aq > /etc/salt/minion.d/id.conf
%end
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B POST /keys
Generate a public and private key and return both as a tarball
.sp
Authentication credentials must be passed in the request.
.INDENT 7.0
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sSk https://localhost:8000/keys \e
        \-d mid=jerry \e
        \-d username=kickstart \e
        \-d password=kickstart \e
        \-d eauth=pam \e
        \-o jerry\-salt\-keys.tar
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
POST /keys HTTP/1.1
Host: localhost:8000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Length: 10240
Content\-Disposition: attachment; filename=\(dqsaltkeys\-jerry.tar\(dq
Content\-Type: application/x\-tar

jerry.pub0000644000000000000000000000070300000000000010730 0ustar  00000000000000
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fB/ws\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_cherrypy.app.WebsocketEndpoint
Open a WebSocket connection to Salt\(aqs event bus
.sp
The event bus on the Salt master exposes a large variety of things, notably
when executions are started on the master and also when minions ultimately
return their results. This URL provides a real\-time window into a running
Salt infrastructure. Uses websocket as the transport mechanism.
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
\fI\%Events & Reactor\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B GET(token=None, **kwargs)
Return a websocket connection of Salt\(aqs event stream
.INDENT 7.0
.TP
.B GET /ws/(token)
.UNINDENT
.INDENT 7.0
.TP
.B Query format_events
The event stream will undergo server\-side
formatting if the \fBformat_events\fP URL parameter is included
in the request. This can be useful to avoid formatting on the
client\-side:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-NsS <...snip...> localhost:8000/ws?format_events
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B Reqheader X\-Auth\-Token
an authentication token from
\fI\%Login\fP\&.
.TP
.B Status 101
switching to the websockets protocol
.TP
.B Status 401
authentication required
.TP
.B Status 406
requested Content\-Type not available
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-NsSk \e
    \-H \(aqX\-Auth\-Token: ffedf49d\(aq \e
    \-H \(aqHost: localhost:8000\(aq \e
    \-H \(aqConnection: Upgrade\(aq \e
    \-H \(aqUpgrade: websocket\(aq \e
    \-H \(aqOrigin: https://localhost:8000\(aq \e
    \-H \(aqSec\-WebSocket\-Version: 13\(aq \e
    \-H \(aqSec\-WebSocket\-Key: \(aq\(dq$(echo \-n $RANDOM | base64)\(dq \e
    localhost:8000/ws
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
GET /ws HTTP/1.1
Connection: Upgrade
Upgrade: websocket
Host: localhost:8000
Origin: https://localhost:8000
Sec\-WebSocket\-Version: 13
Sec\-WebSocket\-Key: s65VsgHigh7v/Jcf4nXHnA==
X\-Auth\-Token: ffedf49d
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: Upgrade
Sec\-WebSocket\-Accept: mWZjBV9FCglzn1rIKJAxrTFlnJE=
Sec\-WebSocket\-Version: 13
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
An authentication token \fBmay optionally\fP be passed as part of the URL
for browsers that cannot be configured to send the authentication
header or cookie:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-NsS <...snip...> localhost:8000/ws/ffedf49d
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The event stream can be easily consumed via JavaScript:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
// Note, you must be authenticated!
var source = new Websocket(\(aqws://localhost:8000/ws/d0ce6c1a\(aq);
source.onerror = function(e) { console.debug(\(aqerror!\(aq, e); };
source.onmessage = function(e) { console.debug(e.data); };

source.send(\(aqwebsocket client ready\(aq)

source.close();
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or via Python, using the Python module \fI\%websocket\-client\fP for example.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Note, you must be authenticated!

from websocket import create_connection

ws = create_connection(\(aqws://localhost:8000/ws/d0ce6c1a\(aq)
ws.send(\(aqwebsocket client ready\(aq)

# Look at https://pypi.python.org/pypi/websocket\-client/ for more
# examples.
while listening_to_events:
    print ws.recv()

ws.close()
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Above examples show how to establish a websocket connection to Salt and
activating real time updates from Salt\(aqs event stream by signaling
\fBwebsocket client ready\fP\&.
.UNINDENT
.UNINDENT
.SS \fB/stats\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_cherrypy.app.Stats
Expose statistics on the running CherryPy server
.INDENT 7.0
.TP
.B GET()
Return a dump of statistics collected from the CherryPy server
.INDENT 7.0
.TP
.B GET /stats
.INDENT 7.0
.TP
.B Request Headers
.INDENT 7.0
.IP \(bu 2
\fIX\-Auth\-Token\fP \-\- a session token from \fI\%Login\fP\&.
.IP \(bu 2
\fI\%Accept\fP \-\- the desired response format.
.UNINDENT
.TP
.B Response Headers
.INDENT 7.0
.IP \(bu 2
\fI\%Content\-Type\fP \-\- the format of the response body; depends on the
\fIAccept\fP request header.
.UNINDENT
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS rest_tornado
.SS A non\-blocking REST API for Salt
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
tornado Python module
.UNINDENT
.TP
.B configuration
All authentication is done through Salt\(aqs \fI\%external auth\fP system which requires additional configuration not described
here.
.UNINDENT
.sp
In order to run rest_tornado with the salt\-master
add the following to the Salt master config file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rest_tornado:
    # can be any port
    port: 8000
    # address to bind to (defaults to 0.0.0.0)
    address: 0.0.0.0
    # socket backlog
    backlog: 128
    ssl_crt: /etc/pki/api/certs/server.crt
    # no need to specify ssl_key if cert and key
    # are in one single file
    ssl_key: /etc/pki/api/certs/server.key
    debug: False
    disable_ssl: False
    webhook_disable_auth: False
    cors_origin: null
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Authentication
.sp
Authentication is performed by passing a session token with each request.
Tokens are generated via the \fI\%SaltAuthHandler\fP URL.
.sp
The token may be sent in one of two ways:
.INDENT 0.0
.IP \(bu 2
Include a custom header named \fIX\-Auth\-Token\fP\&.
.IP \(bu 2
Sent via a cookie. This option is a convenience for HTTP clients that
automatically handle cookie support (such as browsers).
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
You can bypass the session handling via the \fI\%RunSaltAPIHandler\fP URL.
.UNINDENT
.UNINDENT
.SS CORS
.sp
rest_tornado supports Cross\-site HTTP requests out of the box. It is by default
deactivated and controlled by the \fIcors_origin\fP config key.
.sp
You can allow all origins by settings \fIcors_origin\fP to \fI*\fP\&.
.sp
You can allow only one origin with this configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rest_tornado:
    cors_origin: http://salt.yourcompany.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also be more specific and select only a few allowed origins by using
a list. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rest_tornado:
    cors_origin:
        \- http://salt.yourcompany.com
        \- http://salt\-preprod.yourcampany.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The format for origin are full URL, with both scheme and port if not standard.
.sp
In this case, rest_tornado will check if the Origin header is in the allowed
list if it\(aqs the case allow the origin. Else it will returns nothing,
effectively preventing the origin to make request.
.sp
For reference, CORS is a mechanism used by browser to allow (or disallow)
requests made from browser from a different origin than salt\-api. It\(aqs
complementary to Authentication and mandatory only if you plan to use
a salt client developed as a Javascript browser application.
.SS Usage
.sp
Commands are sent to a running Salt master via this module by sending HTTP
requests to the URLs detailed below.
.INDENT 0.0
.INDENT 3.5
.IP "Content negotiation"
.sp
This REST interface is flexible in what data formats it will accept as well
as what formats it will return (e.g., JSON, YAML, x\-www\-form\-urlencoded).
.INDENT 0.0
.IP \(bu 2
Specify the format of data in the request body by including the
\fIContent\-Type\fP header.
.IP \(bu 2
Specify the desired data format for the response body with the
\fIAccept\fP header.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Data sent in \fI\%POST\fP and \fI\%PUT\fP requests  must be in
the format of a list of lowstate dictionaries. This allows multiple commands to
be executed in a single HTTP request.
.INDENT 0.0
.TP
.B lowstate
A dictionary containing various keys that instruct Salt which command
to run, where that command lives, any parameters for that command, any
authentication credentials, what returner to use, etc.
.sp
Salt uses the lowstate data format internally in many places to pass
command data between functions. Salt also uses lowstate for the
\fI\%LocalClient()\fP Python API interface.
.UNINDENT
.sp
The following example (in JSON format) causes Salt to execute two commands:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[{
    \(dqclient\(dq: \(dqlocal\(dq,
    \(dqtgt\(dq: \(dq*\(dq,
    \(dqfun\(dq: \(dqtest.fib\(dq,
    \(dqarg\(dq: [\(dq10\(dq]
},
{
    \(dqclient\(dq: \(dqrunner\(dq,
    \(dqfun\(dq: \(dqjobs.lookup_jid\(dq,
    \(dqjid\(dq: \(dq20130603122505459265\(dq
}]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple commands in a Salt API request will be executed in serial and makes
no guarantees that all commands will run. Meaning that if test.fib (from the
example above) had an exception, the API would still execute \(dqjobs.lookup_jid\(dq.
.sp
Responses to these lowstates are an in\-order list of dicts containing the
return data, a yaml response could look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- ms\-1: true
  ms\-2: true
\- ms\-1: foo
  ms\-2: bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the event of an exception while executing a command the return for that lowstate
will be a string, for example if no minions matched the first lowstate we would get
a return like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- No minions matched the target. No command was sent, no jid was assigned.
\- ms\-1: true
  ms\-2: true
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.IP "x\-www\-form\-urlencoded"
.sp
Sending JSON or YAML in the request body is simple and most flexible,
however sending data in urlencoded format is also supported with the
caveats below. It is the default format for HTML forms, many JavaScript
libraries, and the \fBcurl\fP command.
.sp
For example, the equivalent to running \fBsalt \(aq*\(aq test.ping\fP is sending
\fBfun=test.ping&arg&client=local&tgt=*\fP in the HTTP request body.
.sp
Caveats:
.INDENT 0.0
.IP \(bu 2
Only a single command may be sent per HTTP request.
.IP \(bu 2
Repeating the \fBarg\fP parameter multiple times will cause those
parameters to be combined into a single list.
.sp
Note, some popular frameworks and languages (notably jQuery, PHP, and
Ruby on Rails) will automatically append empty brackets onto repeated
parameters. E.g., \fBarg=one\fP, \fBarg=two\fP will be sent as \fBarg[]=one\fP,
\fBarg[]=two\fP\&. This is not supported; send JSON or YAML instead.
.UNINDENT
.UNINDENT
.UNINDENT
.SS A Websockets add\-on to saltnado
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
tornado Python module
.UNINDENT
.UNINDENT
.sp
In order to enable saltnado_websockets you must add websockets: True to your
saltnado config block.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rest_tornado:
    # can be any port
    port: 8000
    ssl_crt: /etc/pki/api/certs/server.crt
    # no need to specify ssl_key if cert and key
    # are in one single file
    ssl_key: /etc/pki/api/certs/server.key
    debug: False
    disable_ssl: False
    websockets: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS All Events
.sp
Exposes \fBall\fP \(dqreal\-time\(dq events from Salt\(aqs event bus on a websocket connection.
It should be noted that \(dqReal\-time\(dq here means these events are made available
to the server as soon as any salt related action (changes to minions, new jobs etc) happens.
Clients are however assumed to be able to tolerate any network transport related latencies.
Functionality provided by this endpoint is similar to the \fB/events\fP end point.
.sp
The event bus on the Salt master exposes a large variety of things, notably
when executions are started on the master and also when minions ultimately
return their results. This URL provides a real\-time window into a running
Salt infrastructure. Uses websocket as the transport mechanism.
.sp
Exposes GET method to return websocket connections.
All requests should include an auth token.
A way to obtain obtain authentication tokens is shown below.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
% curl \-si localhost:8000/login \e
    \-H \(dqAccept: application/json\(dq \e
    \-d username=\(aqsalt\(aq \e
    \-d password=\(aqsalt\(aq \e
    \-d eauth=\(aqpam\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Which results in the response
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqreturn\(dq: [{
        \(dqperms\(dq: [\(dq.*\(dq, \(dq@runner\(dq, \(dq@wheel\(dq],
        \(dqstart\(dq: 1400556492.277421,
        \(dqtoken\(dq: \(dqd0ce6c1a37e99dcc0374392f272fe19c0090cca7\(dq,
        \(dqexpire\(dq: 1400599692.277422,
        \(dquser\(dq: \(dqsalt\(dq,
        \(dqeauth\(dq: \(dqpam\(dq
    }]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example the \fBtoken\fP returned is \fBd0ce6c1a37e99dcc0374392f272fe19c0090cca7\fP and can be included
in subsequent websocket requests (as part of the URL).
.sp
The event stream can be easily consumed via JavaScript:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
// Note, you must be authenticated!

// Get the Websocket connection to Salt
var source = new Websocket(\(aqwss://localhost:8000/all_events/d0ce6c1a37e99dcc0374392f272fe19c0090cca7\(aq);

// Get Salt\(aqs \(dqreal time\(dq event stream.
source.onopen = function() { source.send(\(aqwebsocket client ready\(aq); };

// Other handlers
source.onerror = function(e) { console.debug(\(aqerror!\(aq, e); };

// e.data represents Salt\(aqs \(dqreal time\(dq event data as serialized JSON.
source.onmessage = function(e) { console.debug(e.data); };

// Terminates websocket connection and Salt\(aqs \(dqreal time\(dq event stream on the server.
source.close();
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or via Python, using the Python module
\fI\%websocket\-client\fP for example.
Or the tornado
\fI\%client\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note, you must be authenticated!

from websocket import create_connection

# Get the Websocket connection to Salt
ws = create_connection(\(aqwss://localhost:8000/all_events/d0ce6c1a37e99dcc0374392f272fe19c0090cca7\(aq)

# Get Salt\(aqs \(dqreal time\(dq event stream.
ws.send(\(aqwebsocket client ready\(aq)


# Simple listener to print results of Salt\(aqs \(dqreal time\(dq event stream.
# Look at https://pypi.python.org/pypi/websocket\-client/ for more examples.
while listening_to_events:
    print ws.recv()       #  Salt\(aqs \(dqreal time\(dq event data as serialized JSON.

# Terminates websocket connection and Salt\(aqs \(dqreal time\(dq event stream on the server.
ws.close()

# Please refer to https://github.com/liris/websocket\-client/issues/81 when using a self signed cert
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Above examples show how to establish a websocket connection to Salt and activating
real time updates from Salt\(aqs event stream by signaling \fBwebsocket client ready\fP\&.
.SS Formatted Events
.sp
Exposes \fBformatted\fP \(dqreal\-time\(dq events from Salt\(aqs event bus on a websocket connection.
It should be noted that \(dqReal\-time\(dq here means these events are made available
to the server as soon as any salt related action (changes to minions, new jobs etc) happens.
Clients are however assumed to be able to tolerate any network transport related latencies.
Functionality provided by this endpoint is similar to the \fB/events\fP end point.
.sp
The event bus on the Salt master exposes a large variety of things, notably
when executions are started on the master and also when minions ultimately
return their results. This URL provides a real\-time window into a running
Salt infrastructure. Uses websocket as the transport mechanism.
.sp
Formatted events parses the raw \(dqreal time\(dq event stream and maintains
a current view of the following:
.INDENT 0.0
.IP \(bu 2
minions
.IP \(bu 2
jobs
.UNINDENT
.sp
A change to the minions (such as addition, removal of keys or connection drops)
or jobs is processed and clients are updated.
Since we use salt\(aqs presence events to track minions,
please enable \fBpresence_events\fP
and set a small value for the \fBloop_interval\fP
in the salt master config file.
.sp
Exposes GET method to return websocket connections.
All requests should include an auth token.
A way to obtain obtain authentication tokens is shown below.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
% curl \-si localhost:8000/login \e
    \-H \(dqAccept: application/json\(dq \e
    \-d username=\(aqsalt\(aq \e
    \-d password=\(aqsalt\(aq \e
    \-d eauth=\(aqpam\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Which results in the response
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqreturn\(dq: [{
        \(dqperms\(dq: [\(dq.*\(dq, \(dq@runner\(dq, \(dq@wheel\(dq],
        \(dqstart\(dq: 1400556492.277421,
        \(dqtoken\(dq: \(dqd0ce6c1a37e99dcc0374392f272fe19c0090cca7\(dq,
        \(dqexpire\(dq: 1400599692.277422,
        \(dquser\(dq: \(dqsalt\(dq,
        \(dqeauth\(dq: \(dqpam\(dq
    }]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example the \fBtoken\fP returned is \fBd0ce6c1a37e99dcc0374392f272fe19c0090cca7\fP and can be included
in subsequent websocket requests (as part of the URL).
.sp
The event stream can be easily consumed via JavaScript:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
// Note, you must be authenticated!

// Get the Websocket connection to Salt
var source = new Websocket(\(aqwss://localhost:8000/formatted_events/d0ce6c1a37e99dcc0374392f272fe19c0090cca7\(aq);

// Get Salt\(aqs \(dqreal time\(dq event stream.
source.onopen = function() { source.send(\(aqwebsocket client ready\(aq); };

// Other handlers
source.onerror = function(e) { console.debug(\(aqerror!\(aq, e); };

// e.data represents Salt\(aqs \(dqreal time\(dq event data as serialized JSON.
source.onmessage = function(e) { console.debug(e.data); };

// Terminates websocket connection and Salt\(aqs \(dqreal time\(dq event stream on the server.
source.close();
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or via Python, using the Python module
\fI\%websocket\-client\fP for example.
Or the tornado
\fI\%client\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Note, you must be authenticated!

from websocket import create_connection

# Get the Websocket connection to Salt
ws = create_connection(\(aqwss://localhost:8000/formatted_events/d0ce6c1a37e99dcc0374392f272fe19c0090cca7\(aq)

# Get Salt\(aqs \(dqreal time\(dq event stream.
ws.send(\(aqwebsocket client ready\(aq)


# Simple listener to print results of Salt\(aqs \(dqreal time\(dq event stream.
# Look at https://pypi.python.org/pypi/websocket\-client/ for more examples.
while listening_to_events:
    print ws.recv()       #  Salt\(aqs \(dqreal time\(dq event data as serialized JSON.

# Terminates websocket connection and Salt\(aqs \(dqreal time\(dq event stream on the server.
ws.close()

# Please refer to https://github.com/liris/websocket\-client/issues/81 when using a self signed cert
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Above examples show how to establish a websocket connection to Salt and activating
real time updates from Salt\(aqs event stream by signaling \fBwebsocket client ready\fP\&.
.SS Example responses
.sp
\fBMinion information\fP is a dictionary keyed by each connected minion\(aqs \fBid\fP (\fBmid\fP),
grains information for each minion is also included.
.sp
Minion information is sent in response to the following minion events:
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B connection drops
.INDENT 7.0
.IP \(bu 2
requires running \fBmanage.present\fP periodically every \fBloop_interval\fP seconds
.UNINDENT
.UNINDENT
.IP \(bu 2
minion addition
.IP \(bu 2
minion removal
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Not all grains are shown
data: {
    \(dqminions\(dq: {
        \(dqminion1\(dq: {
            \(dqid\(dq: \(dqminion1\(dq,
            \(dqgrains\(dq: {
                \(dqkernel\(dq: \(dqDarwin\(dq,
                \(dqdomain\(dq: \(dqlocal\(dq,
                \(dqzmqversion\(dq: \(dq4.0.3\(dq,
                \(dqkernelrelease\(dq: \(dq13.2.0\(dq
            }
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBJob information\fP is also tracked and delivered.
.sp
Job information is also a dictionary
in which each job\(aqs information is keyed by salt\(aqs \fBjid\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
data: {
    \(dqjobs\(dq: {
        \(dq20140609153646699137\(dq: {
            \(dqtgt_type\(dq: \(dqglob\(dq,
            \(dqjid\(dq: \(dq20140609153646699137\(dq,
            \(dqtgt\(dq: \(dq*\(dq,
            \(dqstart_time\(dq: \(dq2014\-06\-09T15:36:46.700315\(dq,
            \(dqstate\(dq: \(dqcomplete\(dq,
            \(dqfun\(dq: \(dqtest.ping\(dq,
            \(dqminions\(dq: {
                \(dqminion1\(dq: {
                    \(dqreturn\(dq: true,
                    \(dqretcode\(dq: 0,
                    \(dqsuccess\(dq: true
                }
            }
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Setup
.SS REST URI Reference
.INDENT 0.0
.IP \(bu 2
\fI\%/\fP
.IP \(bu 2
\fI\%/login\fP
.IP \(bu 2
\fI\%/minions\fP
.IP \(bu 2
\fI\%/jobs\fP
.IP \(bu 2
\fI\%/run\fP
.IP \(bu 2
\fI\%/events\fP
.IP \(bu 2
\fI\%/hook\fP
.UNINDENT
.SS \fB/\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_tornado.saltnado.SaltAPIHandler(*args, **kwargs)
Main API handler for base \(dq/\(dq
.INDENT 7.0
.TP
.B disbatch()
Disbatch all lowstates to the appropriate clients
.UNINDENT
.INDENT 7.0
.TP
.B get()
An endpoint to determine salt\-api capabilities
.INDENT 7.0
.TP
.B GET /
.INDENT 7.0
.TP
.B Request Headers
.INDENT 7.0
.IP \(bu 2
\fI\%Accept\fP \-\- the desired response format.
.UNINDENT
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-i localhost:8000
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
GET / HTTP/1.1
Host: localhost:8000
Accept: application/json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Type: application/json
Content\-Legnth: 83

{\(dqclients\(dq: [\(dqlocal\(dq, \(dqlocal_async\(dq, \(dqrunner\(dq, \(dqrunner_async\(dq], \(dqreturn\(dq: \(dqWelcome\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B post()
Send one or more Salt commands (lowstates) in the request body
.INDENT 7.0
.TP
.B POST /
.INDENT 7.0
.TP
.B Request Headers
.INDENT 7.0
.IP \(bu 2
\fIX\-Auth\-Token\fP \-\- a session token from \fI\%SaltAuthHandler\fP\&.
.IP \(bu 2
\fI\%Accept\fP \-\- the desired response format.
.IP \(bu 2
\fI\%Content\-Type\fP \-\- the format of the request body.
.UNINDENT
.TP
.B Response Headers
.INDENT 7.0
.IP \(bu 2
\fI\%Content\-Type\fP \-\- the format of the response body; depends on the
\fIAccept\fP request header.
.UNINDENT
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.sp
\fI\%lowstate\fP data describing Salt commands must be sent in the
request body.
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-si https://localhost:8000 \e
        \-H \(dqAccept: application/x\-yaml\(dq \e
        \-H \(dqX\-Auth\-Token: d40d1e1e\(dq \e
        \-d client=local \e
        \-d tgt=\(aq*\(aq \e
        \-d fun=\(aqtest.ping\(aq \e
        \-d arg
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
POST / HTTP/1.1
Host: localhost:8000
Accept: application/x\-yaml
X\-Auth\-Token: d40d1e1e
Content\-Length: 36
Content\-Type: application/x\-www\-form\-urlencoded

fun=test.ping&arg&client=local&tgt=*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.sp
Responses are an in\-order list of the lowstate\(aqs return data. In the
event of an exception running a command the return will be a string
instead of a mapping.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Length: 200
Allow: GET, HEAD, POST
Content\-Type: application/x\-yaml

return:
\- ms\-0: true
    ms\-1: true
    ms\-2: true
    ms\-3: true
    ms\-4: true
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "multiple commands"
.sp
Note that if multiple \fI\%lowstate\fP structures are sent, the Salt
API will execute them in serial, and will not stop execution upon failure
of a previous job. If you need to have commands executed in order and
stop on failure please use compound\-command\-execution.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fB/login\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_tornado.saltnado.SaltAuthHandler(*args, **kwargs)
Handler for login requests
.INDENT 7.0
.TP
.B get()
All logins are done over post, this is a parked endpoint
.INDENT 7.0
.TP
.B GET /login
.INDENT 7.0
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-i localhost:8000/login
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
GET /login HTTP/1.1
Host: localhost:8000
Accept: application/json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 401 Unauthorized
Content\-Type: application/json
Content\-Length: 58

{\(dqstatus\(dq: \(dq401 Unauthorized\(dq, \(dqreturn\(dq: \(dqPlease log in\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B post()
\fI\%Authenticate\fP against Salt\(aqs eauth system
.INDENT 7.0
.TP
.B POST /login
.INDENT 7.0
.TP
.B Request Headers
.INDENT 7.0
.IP \(bu 2
\fIX\-Auth\-Token\fP \-\- a session token from \fI\%SaltAuthHandler\fP\&.
.IP \(bu 2
\fI\%Accept\fP \-\- the desired response format.
.IP \(bu 2
\fI\%Content\-Type\fP \-\- the format of the request body.
.UNINDENT
.TP
.B Form Parameters
.INDENT 7.0
.IP \(bu 2
\fBeauth\fP \-\- the eauth backend configured for the user
.IP \(bu 2
\fBusername\fP \-\- username
.IP \(bu 2
\fBpassword\fP \-\- password
.UNINDENT
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%400 Bad Request\fP \-\- bad request
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.IP \(bu 2
\fI\%500 Internal Server Error\fP \-\- internal server error
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-si localhost:8000/login \e
        \-H \(dqAccept: application/json\(dq \e
        \-d username=\(aqsaltuser\(aq \e
        \-d password=\(aqsaltpass\(aq \e
        \-d eauth=\(aqpam\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
POST / HTTP/1.1
Host: localhost:8000
Content\-Length: 42
Content\-Type: application/x\-www\-form\-urlencoded
Accept: application/json

username=saltuser&password=saltpass&eauth=pam
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Type: application/json
Content\-Length: 206
X\-Auth\-Token: 6d1b722e
Set\-Cookie: session_id=6d1b722e; expires=Sat, 17 Nov 2012 03:23:52 GMT; Path=/

{\(dqreturn\(dq: {
    \(dqtoken\(dq: \(dq6d1b722e\(dq,
    \(dqstart\(dq: 1363805943.776223,
    \(dqexpire\(dq: 1363849143.776224,
    \(dquser\(dq: \(dqsaltuser\(dq,
    \(dqeauth\(dq: \(dqpam\(dq,
    \(dqperms\(dq: [
        \(dqgrains.*\(dq,
        \(dqstatus.*\(dq,
        \(dqsys.*\(dq,
        \(dqtest.*\(dq
    ]
}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fB/minions\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_tornado.saltnado.MinionSaltAPIHandler(*args, **kwargs)
A convenience endpoint for minion related functions
.INDENT 7.0
.TP
.B get(mid=None)
A convenience URL for getting lists of minions or getting minion
details
.INDENT 7.0
.TP
.B GET /minions/(mid)
.INDENT 7.0
.TP
.B Request Headers
.INDENT 7.0
.IP \(bu 2
\fIX\-Auth\-Token\fP \-\- a session token from \fI\%SaltAuthHandler\fP\&.
.IP \(bu 2
\fI\%Accept\fP \-\- the desired response format.
.UNINDENT
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-i localhost:8000/minions/ms\-3
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
GET /minions/ms\-3 HTTP/1.1
Host: localhost:8000
Accept: application/x\-yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Length: 129005
Content\-Type: application/x\-yaml

return:
\- ms\-3:
    grains.items:
        ...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B post()
Start an execution command and immediately return the job id
.INDENT 7.0
.TP
.B POST /minions
.INDENT 7.0
.TP
.B Request Headers
.INDENT 7.0
.IP \(bu 2
\fIX\-Auth\-Token\fP \-\- a session token from \fI\%SaltAuthHandler\fP\&.
.IP \(bu 2
\fI\%Accept\fP \-\- the desired response format.
.IP \(bu 2
\fI\%Content\-Type\fP \-\- the format of the request body.
.UNINDENT
.TP
.B Response Headers
.INDENT 7.0
.IP \(bu 2
\fI\%Content\-Type\fP \-\- the format of the response body; depends on the
\fIAccept\fP request header.
.UNINDENT
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.sp
\fI\%lowstate\fP data describing Salt commands must be sent in the
request body. The \fBclient\fP option will be set to
\fBlocal_async()\fP\&.
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sSi localhost:8000/minions \e
    \-H \(dqAccept: application/x\-yaml\(dq \e
    \-d tgt=\(aq*\(aq \e
    \-d fun=\(aqstatus.diskusage\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
POST /minions HTTP/1.1
Host: localhost:8000
Accept: application/x\-yaml
Content\-Length: 26
Content\-Type: application/x\-www\-form\-urlencoded

tgt=*&fun=status.diskusage
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 202 Accepted
Content\-Length: 86
Content\-Type: application/x\-yaml

return:
\- jid: \(aq20130603122505459265\(aq
  minions: [ms\-4, ms\-3, ms\-2, ms\-1, ms\-0]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fB/jobs\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_tornado.saltnado.JobsSaltAPIHandler(*args, **kwargs)
A convenience endpoint for job cache data
.INDENT 7.0
.TP
.B get(jid=None)
A convenience URL for getting lists of previously run jobs or getting
the return from a single job
.INDENT 7.0
.TP
.B GET /jobs/(jid)
List jobs or show a single job from the job cache.
.INDENT 7.0
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-i localhost:8000/jobs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
GET /jobs HTTP/1.1
Host: localhost:8000
Accept: application/x\-yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Length: 165
Content\-Type: application/x\-yaml

return:
\- \(aq20121130104633606931\(aq:
    Arguments:
    \- \(aq3\(aq
    Function: test.fib
    Start Time: 2012, Nov 30 10:46:33.606931
    Target: jerry
    Target\-type: glob
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-i localhost:8000/jobs/20121130104633606931
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
GET /jobs/20121130104633606931 HTTP/1.1
Host: localhost:8000
Accept: application/x\-yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Length: 73
Content\-Type: application/x\-yaml

info:
\- Arguments:
    \- \(aq3\(aq
    Function: test.fib
    Minions:
    \- jerry
    Start Time: 2012, Nov 30 10:46:33.606931
    Target: \(aq*\(aq
    Target\-type: glob
    User: saltdev
    jid: \(aq20121130104633606931\(aq
return:
\- jerry:
    \- \- 0
    \- 1
    \- 1
    \- 2
    \- 6.9141387939453125e\-06
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fB/run\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_tornado.saltnado.RunSaltAPIHandler(*args, **kwargs)
Endpoint to run commands without normal session handling
.INDENT 7.0
.TP
.B post()
Run commands bypassing the \fI\%normal session handling\fP
.INDENT 7.0
.TP
.B POST /run
This entry point is primarily for \(dqone\-off\(dq commands. Each request
must pass full Salt authentication credentials. Otherwise this URL
is identical to the \fBroot URL (/)\fP\&.
.sp
\fI\%lowstate\fP data describing Salt commands must be sent in the
request body.
.INDENT 7.0
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sS localhost:8000/run \e
    \-H \(aqAccept: application/x\-yaml\(aq \e
    \-d client=\(aqlocal\(aq \e
    \-d tgt=\(aq*\(aq \e
    \-d fun=\(aqtest.ping\(aq \e
    \-d username=\(aqsaltdev\(aq \e
    \-d password=\(aqsaltdev\(aq \e
    \-d eauth=\(aqpam\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
POST /run HTTP/1.1
Host: localhost:8000
Accept: application/x\-yaml
Content\-Length: 75
Content\-Type: application/x\-www\-form\-urlencoded

client=local&tgt=*&fun=test.ping&username=saltdev&password=saltdev&eauth=pam
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Length: 73
Content\-Type: application/x\-yaml

return:
\- ms\-0: true
    ms\-1: true
    ms\-2: true
    ms\-3: true
    ms\-4: true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fB/events\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_tornado.saltnado.EventsSaltAPIHandler(*args, **kwargs)
Expose the Salt event bus
.sp
The event bus on the Salt master exposes a large variety of things, notably
when executions are started on the master and also when minions ultimately
return their results. This URL provides a real\-time window into a running
Salt infrastructure.
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
\fI\%Events & Reactor\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B get()
An HTTP stream of the Salt master event bus
.sp
This stream is formatted per the Server Sent Events (SSE) spec. Each
event is formatted as JSON.
.INDENT 7.0
.TP
.B GET /events
.INDENT 7.0
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-NsS localhost:8000/events
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
GET /events HTTP/1.1
Host: localhost:8000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Connection: keep\-alive
Cache\-Control: no\-cache
Content\-Type: text/event\-stream;charset=utf\-8

retry: 400
data: {\(aqtag\(aq: \(aq\(aq, \(aqdata\(aq: {\(aqminions\(aq: [\(aqms\-4\(aq, \(aqms\-3\(aq, \(aqms\-2\(aq, \(aqms\-1\(aq, \(aqms\-0\(aq]}}

data: {\(aqtag\(aq: \(aq20130802115730568475\(aq, \(aqdata\(aq: {\(aqjid\(aq: \(aq20130802115730568475\(aq, \(aqreturn\(aq: True, \(aqretcode\(aq: 0, \(aqsuccess\(aq: True, \(aqcmd\(aq: \(aq_return\(aq, \(aqfun\(aq: \(aqtest.ping\(aq, \(aqid\(aq: \(aqms\-1\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The event stream can be easily consumed via JavaScript:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
<!\-\- Note, you must be authenticated! \-\->
var source = new EventSource(\(aq/events\(aq);
source.onopen = function() { console.debug(\(aqopening\(aq) };
source.onerror = function(e) { console.debug(\(aqerror!\(aq, e) };
source.onmessage = function(e) { console.debug(e.data) };
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or using CORS:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
var source = new EventSource(\(aq/events\(aq, {withCredentials: true});
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Some browser clients lack CORS support for the \fBEventSource()\fP API. Such
clients may instead pass the \fIX\-Auth\-Token\fP value as an URL
parameter:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-NsS localhost:8000/events/6d1b722e
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is also possible to consume the stream via the shell.
.sp
Records are separated by blank lines; the \fBdata:\fP and \fBtag:\fP
prefixes will need to be removed manually before attempting to
unserialize the JSON.
.sp
curl\(aqs \fB\-N\fP flag turns off input buffering which is required to
process the stream incrementally.
.sp
Here is a basic example of printing each event as it comes in:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-NsS localhost:8000/events |\e
        while IFS= read \-r line ; do
            echo $line
        done
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here is an example of using awk to filter events based on tag:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-NsS localhost:8000/events |\e
        awk \(aq
            BEGIN { RS=\(dq\(dq; FS=\(dq\e\en\(dq }
            $1 ~ /^tag: salt\e/job\e/[0\-9]+\e/new$/ { print $0 }
        \(aq
tag: salt/job/20140112010149808995/new
data: {\(dqtag\(dq: \(dqsalt/job/20140112010149808995/new\(dq, \(dqdata\(dq: {\(dqtgt_type\(dq: \(dqglob\(dq, \(dqjid\(dq: \(dq20140112010149808995\(dq, \(dqtgt\(dq: \(dqjerry\(dq, \(dq_stamp\(dq: \(dq2014\-01\-12_01:01:49.809617\(dq, \(dquser\(dq: \(dqshouse\(dq, \(dqarg\(dq: [], \(dqfun\(dq: \(dqtest.ping\(dq, \(dqminions\(dq: [\(dqjerry\(dq]}}
tag: 20140112010149808995
data: {\(dqtag\(dq: \(dq20140112010149808995\(dq, \(dqdata\(dq: {\(dqfun_args\(dq: [], \(dqjid\(dq: \(dq20140112010149808995\(dq, \(dqreturn\(dq: true, \(dqretcode\(dq: 0, \(dqsuccess\(dq: true, \(dqcmd\(dq: \(dq_return\(dq, \(dq_stamp\(dq: \(dq2014\-01\-12_01:01:49.819316\(dq, \(dqfun\(dq: \(dqtest.ping\(dq, \(dqid\(dq: \(dqjerry\(dq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS \fB/hook\fP
.INDENT 0.0
.TP
.B class  salt.netapi.rest_tornado.saltnado.WebhookSaltAPIHandler(*args, **kwargs)
A generic web hook entry point that fires an event on Salt\(aqs event bus
.sp
External services can POST data to this URL to trigger an event in Salt.
For example, Amazon SNS, Jenkins\-CI or Travis\-CI, or GitHub web hooks.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Be mindful of security
.sp
Salt\(aqs Reactor can run any code. A Reactor SLS that responds to a hook
event is responsible for validating that the event came from a trusted
source and contains valid data.
.sp
\fBThis is a generic interface and securing it is up to you!\fP
.sp
This URL requires authentication however not all external services can
be configured to authenticate. For this reason authentication can be
selectively disabled for this URL. Follow best practices \-\- always use
SSL, pass a secret key, configure the firewall to only allow traffic
from a known source, etc.
.UNINDENT
.UNINDENT
.sp
The event data is taken from the request body. The
\fIContent\-Type\fP header is respected for the payload.
.sp
The event tag is prefixed with \fBsalt/netapi/hook\fP and the URL path is
appended to the end. For example, a \fBPOST\fP request sent to
\fB/hook/mycompany/myapp/mydata\fP will produce a Salt event with the tag
\fBsalt/netapi/hook/mycompany/myapp/mydata\fP\&.
.sp
The following is an example \fB\&.travis.yml\fP file to send notifications to
Salt of successful test runs:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
language: python
script: python \-m unittest tests
after_success:
    \- \(aqcurl \-sS http://saltapi\-url.example.com:8000/hook/travis/build/success \-d branch=\(dq${TRAVIS_BRANCH}\(dq \-d commit=\(dq${TRAVIS_COMMIT}\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
\fI\%Events\fP, \fI\%Reactor\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B post(tag_suffix=None)
Fire an event in Salt with a custom event tag and data
.INDENT 7.0
.TP
.B POST /hook
.INDENT 7.0
.TP
.B Status Codes
.INDENT 7.0
.IP \(bu 2
\fI\%200 OK\fP \-\- success
.IP \(bu 2
\fI\%401 Unauthorized\fP \-\- authentication required
.IP \(bu 2
\fI\%406 Not Acceptable\fP \-\- requested Content\-Type not available
.IP \(bu 2
\fI\%413 Request Entity Too Large\fP \-\- request body is too large
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBExample request:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sS localhost:8000/hook \-d foo=\(aqFoo!\(aq \-d bar=\(aqBar!\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
POST /hook HTTP/1.1
Host: localhost:8000
Content\-Length: 16
Content\-Type: application/x\-www\-form\-urlencoded

foo=Foo&bar=Bar!
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.1 200 OK
Content\-Length: 14
Content\-Type: application/json

{\(dqsuccess\(dq: true}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As a practical example, an internal continuous\-integration build
server could send an HTTP POST request to the URL
\fBhttp://localhost:8000/hook/mycompany/build/success\fP which contains
the result of a build and the SHA of the version that was built as
JSON. That would then produce the following event in Salt that could be
used to kick off a deployment via Salt\(aqs Reactor:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Event fired at Fri Feb 14 17:40:11 2014
*************************
Tag: salt/netapi/hook/mycompany/build/success
Data:
{\(aq_stamp\(aq: \(aq2014\-02\-14_17:40:11.440996\(aq,
    \(aqheaders\(aq: {
        \(aqX\-My\-Secret\-Key\(aq: \(aqF0fAgoQjIT@W\(aq,
        \(aqContent\-Length\(aq: \(aq37\(aq,
        \(aqContent\-Type\(aq: \(aqapplication/json\(aq,
        \(aqHost\(aq: \(aqlocalhost:8000\(aq,
        \(aqRemote\-Addr\(aq: \(aq127.0.0.1\(aq},
    \(aqpost\(aq: {\(aqrevision\(aq: \(aqaa22a3c4b2e7\(aq, \(aqresult\(aq: True}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt\(aqs Reactor could listen for the event:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
reactor:
  \- \(aqsalt/netapi/hook/mycompany/build/*\(aq:
    \- /srv/reactor/react_ci_builds.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And finally deploy the new build:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set secret_key = data.get(\(aqheaders\(aq, {}).get(\(aqX\-My\-Secret\-Key\(aq) %}
{% set build = data.get(\(aqpost\(aq, {}) %}

{% if secret_key == \(aqF0fAgoQjIT@W\(aq and build.result == True %}
deploy_my_app:
  cmd.state.sls:
    \- tgt: \(aqapplication*\(aq
    \- arg:
      \- myapp.deploy
    \- kwarg:
        pillar:
          revision: {{ revision }}
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS rest_wsgi
.SS A minimalist REST API for Salt
.sp
This \fBrest_wsgi\fP module provides a no\-frills REST interface for sending
commands to the Salt master. There are no dependencies.
.sp
Extra care must be taken when deploying this module into production. Please
read this documentation in entirety.
.sp
All authentication is done through Salt\(aqs \fI\%external auth\fP
system.
.SS Usage
.INDENT 0.0
.IP \(bu 2
All requests must be sent to the root URL (\fB/\fP).
.IP \(bu 2
All requests must be sent as a POST request with JSON content in the request
body.
.IP \(bu 2
All responses are in JSON.
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%rest_cherrypy\fP
.sp
The \fI\%rest_cherrypy\fP module is
more full\-featured, production\-ready, and has builtin security features.
.UNINDENT
.UNINDENT
.SS Deployment
.sp
The \fBrest_wsgi\fP netapi module is a standard Python WSGI app. It can be
deployed one of two ways.
.SS Using a WSGI\-compliant web server
.sp
This module may be run via any WSGI\-compliant production server such as Apache
with mod_wsgi or Nginx with FastCGI.
.sp
It is strongly recommended that this app be used with a server that supports
HTTPS encryption since raw Salt authentication credentials must be sent with
every request. Any apps that access Salt through this interface will need to
manually manage authentication credentials (either username and password or a
Salt token). Tread carefully.
.SS \fBsalt\-api\fP using a development\-only server
.sp
If run directly via the salt\-api daemon it uses the \fI\%wsgiref.simple_server()\fP
that ships in the Python standard library. This is a single\-threaded server
that is intended for testing and development. \fBThis server does not use
encryption\fP; please note that raw Salt authentication credentials must be sent
with every HTTP request.
.sp
\fBRunning this module via salt\-api is not recommended!\fP
.sp
In order to start this module via the \fBsalt\-api\fP daemon the following must be
put into the Salt master config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rest_wsgi:
    port: 8001
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Usage examples
.INDENT 0.0
.TP
.B POST /
\fBExample request\fP for a basic \fBtest.ping\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
% curl \-sS \-i \e
        \-H \(aqContent\-Type: application/json\(aq \e
        \-d \(aq[{\(dqeauth\(dq:\(dqpam\(dq,\(dqusername\(dq:\(dqsaltdev\(dq,\(dqpassword\(dq:\(dqsaltdev\(dq,\(dqclient\(dq:\(dqlocal\(dq,\(dqtgt\(dq:\(dq*\(dq,\(dqfun\(dq:\(dqtest.ping\(dq}]\(aq localhost:8001
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.0 200 OK
Content\-Length: 89
Content\-Type: application/json

{\(dqreturn\(dq: [{\(dqms\-\-4\(dq: true, \(dqms\-\-3\(dq: true, \(dqms\-\-2\(dq: true, \(dqms\-\-1\(dq: true, \(dqms\-\-0\(dq: true}]}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample request\fP for an asynchronous \fBtest.ping\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
% curl \-sS \-i \e
        \-H \(aqContent\-Type: application/json\(aq \e
        \-d \(aq[{\(dqeauth\(dq:\(dqpam\(dq,\(dqusername\(dq:\(dqsaltdev\(dq,\(dqpassword\(dq:\(dqsaltdev\(dq,\(dqclient\(dq:\(dqlocal_async\(dq,\(dqtgt\(dq:\(dq*\(dq,\(dqfun\(dq:\(dqtest.ping\(dq}]\(aq localhost:8001
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.0 200 OK
Content\-Length: 103
Content\-Type: application/json

{\(dqreturn\(dq: [{\(dqjid\(dq: \(dq20130412192112593739\(dq, \(dqminions\(dq: [\(dqms\-\-4\(dq, \(dqms\-\-3\(dq, \(dqms\-\-2\(dq, \(dqms\-\-1\(dq, \(dqms\-\-0\(dq]}]}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample request\fP for looking up a job ID:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
% curl \-sS \-i \e
        \-H \(aqContent\-Type: application/json\(aq \e
        \-d \(aq[{\(dqeauth\(dq:\(dqpam\(dq,\(dqusername\(dq:\(dqsaltdev\(dq,\(dqpassword\(dq:\(dqsaltdev\(dq,\(dqclient\(dq:\(dqrunner\(dq,\(dqfun\(dq:\(dqjobs.lookup_jid\(dq,\(dqjid\(dq:\(dq20130412192112593739\(dq}]\(aq localhost:8001
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample response\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HTTP/1.0 200 OK
Content\-Length: 89
Content\-Type: application/json

{\(dqreturn\(dq: [{\(dqms\-\-4\(dq: true, \(dqms\-\-3\(dq: true, \(dqms\-\-2\(dq: true, \(dqms\-\-1\(dq: true, \(dqms\-\-0\(dq: true}]}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B form lowstate
A list of lowstate data appropriate for the
\fI\%client\fP interface you are calling.
.TP
.B status 200
success
.TP
.B status 401
authentication required
.UNINDENT
.SS output modules
.sp
Follow one of the below links for further information and examples
.TS
center;
|l|l|.
_
T{
\fI\%dson\fP
T}	T{
Display return data in DSON format
T}
_
T{
\fI\%highstate\fP
T}	T{
Outputter for displaying results of state runs
T}
_
T{
\fI\%json_out\fP
T}	T{
Display return data in JSON format
T}
_
T{
\fI\%key\fP
T}	T{
Display salt\-key output
T}
_
T{
\fI\%nested\fP
T}	T{
Recursively display nested data
T}
_
T{
\fI\%newline_values_only\fP
T}	T{
Display values only, separated by newlines
T}
_
T{
\fI\%no_out_quiet\fP
T}	T{
Display no output
T}
_
T{
\fI\%no_return\fP
T}	T{
Display output for minions that did not return
T}
_
T{
\fI\%overstatestage\fP
T}	T{
Display clean output of an overstate stage
T}
_
T{
\fI\%pony\fP
T}	T{
Display Pony output data structure
T}
_
T{
\fI\%pprint_out\fP
T}	T{
Python pretty\-print (pprint)
T}
_
T{
\fI\%profile\fP
T}	T{
Display profiling data in a table format
T}
_
T{
\fI\%progress\fP
T}	T{
Display return data as a progress bar
T}
_
T{
\fI\%raw\fP
T}	T{
Display raw output data structure
T}
_
T{
\fI\%table_out\fP
T}	T{
Display output in a table format
T}
_
T{
\fI\%txt\fP
T}	T{
Simple text outputter
T}
_
T{
\fI\%virt_query\fP
T}	T{
virt.query outputter
T}
_
T{
\fI\%yaml_out\fP
T}	T{
Display return data in YAML format
T}
_
.TE
.SS salt.output.dson
.SS Display return data in DSON format
.sp
This outputter is intended for demonstration purposes. Information on the DSON
spec can be found \fI\%here\fP\&.
.sp
This outputter requires \fI\%Dogeon\fP (installable via pip)
.INDENT 0.0
.TP
.B salt.output.dson.output(data, **kwargs)
Print the output data in JSON
.UNINDENT
.SS salt.output.highstate
.SS Outputter for displaying results of state runs
.sp
The return data from the Highstate command is a standard data structure
which is parsed by the highstate outputter to deliver a clean and readable
set of information about the HighState run on minions.
.sp
Two configurations can be set to modify the highstate outputter. These values
can be set in the master config to change the output of the \fBsalt\fP command or
set in the minion config to change the output of the \fBsalt\-call\fP command.
.INDENT 0.0
.TP
.B state_verbose:
By default \fIstate_verbose\fP is set to \fITrue\fP, setting this to \fIFalse\fP will
instruct the highstate outputter to omit displaying anything in green, this
means that nothing with a result of True and no changes will not be printed
.TP
.B state_output:
The highstate outputter has six output modes,
\fBfull\fP, \fBterse\fP, \fBmixed\fP, \fBchanges\fP and \fBfilter\fP
.INDENT 7.0
.IP \(bu 2
The default is set to \fBfull\fP, which will display many lines of detailed
information for each executed chunk.
.IP \(bu 2
If \fBterse\fP is used, then the output is greatly simplified and shown in
only one line.
.IP \(bu 2
If \fBmixed\fP is used, then terse output will be used unless a state
failed, in which case full output will be used.
.IP \(bu 2
If \fBchanges\fP is used, then terse output will be used if there was no
error and no changes, otherwise full output will be used.
.IP \(bu 2
If \fBfilter\fP is used, then either or both of two different filters can be
used: \fBexclude\fP or \fBterse\fP\&.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
for \fBexclude\fP, state.highstate expects a list of states to be excluded (or \fBNone\fP)
followed by \fBTrue\fP for terse output or \fBFalse\fP for regular output.
Because of parsing nuances, if only one of these is used, it must still
contain a comma. For instance: \fIexclude=True,\fP\&.
.IP \(bu 2
for \fBterse\fP, state.highstate expects simply \fBTrue\fP or \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
These can be set as such from the command line, or in the Salt config as
\fIstate_output_exclude\fP or \fIstate_output_terse\fP, respectively.
.UNINDENT
.sp
The output modes have one modifier:
.sp
\fBfull_id\fP, \fBterse_id\fP, \fBmixed_id\fP, \fBchanges_id\fP and \fBfilter_id\fP
If \fB_id\fP is used, then the corresponding form will be used, but the value for \fBname\fP
will be drawn from the state ID. This is useful for cases where the name
value might be very long and hard to read.
.TP
.B state_tabular:
If \fIstate_output\fP uses the terse output, set this to \fITrue\fP for an aligned
output format.  If you wish to use a custom format, this can be set to a
string.
.TP
.B state_output_pct:
Set \fIstate_output_pct\fP to \fITrue\fP in order to add \(dqSuccess %\(dq and \(dqFailure %\(dq
to the \(dqSummary\(dq section at the end of the highstate output.
.TP
.B state_compress_ids:
Set \fIstate_compress_ids\fP to \fITrue\fP to aggregate information about states
which have multiple \(dqnames\(dq under the same state ID in the highstate output.
This is useful in combination with the \fIterse_id\fP value set in the
\fIstate_output\fP option when states are using the \fInames\fP state parameter.
.UNINDENT
.sp
Example usage:
.sp
If \fBstate_output: filter\fP is set in the configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.highstate exclude=None,True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
means to exclude no states from the highstate and turn on terse output.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt twd state.highstate exclude=problemstate1,problemstate2,False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
means to exclude states \fBproblemstate1\fP and \fBproblemstate2\fP
from the highstate, and use regular output.
.sp
Example output for the above highstate call when \fBtop.sls\fP defines only
one other state to apply to minion \fBtwd\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
twd:

Summary for twd
\-\-\-\-\-\-\-\-\-\-\-\-
Succeeded: 1 (changed=1)
Failed:    0
\-\-\-\-\-\-\-\-\-\-\-\-
Total states run:     1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output with no special settings in configuration files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myminion:
\-\-\-\-\-\-\-\-\-\-
          ID: test.ping
    Function: module.run
      Result: True
     Comment: Module function test.ping executed
     Changes:
              \-\-\-\-\-\-\-\-\-\-
              ret:
                  True

Summary for myminion
\-\-\-\-\-\-\-\-\-\-\-\-
Succeeded: 1
Failed:    0
\-\-\-\-\-\-\-\-\-\-\-\-
Total:     0
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.output.highstate.output(data, **kwargs)
The HighState Outputter is only meant to be used with the state.highstate
function, or a function that returns highstate return data.
.UNINDENT
.SS salt.output.json_out
.SS Display return data in JSON format
.INDENT 0.0
.TP
.B configuration
The output format can be configured in two ways:
Using the \fB\-\-out\-indent\fP CLI flag and specifying a positive integer or a
negative integer to group JSON from each minion to a single line.
.sp
Or setting the \fBoutput_indent\fP setting in the Master or Minion
configuration file with one of the following values:
.INDENT 7.0
.IP \(bu 2
\fBNull\fP: put each minion return on a single line.
.IP \(bu 2
\fBpretty\fP: use four\-space indents and sort the keys.
.IP \(bu 2
An integer: specify the indentation level.
.UNINDENT
.UNINDENT
.sp
Salt\(aqs outputters operate on a per\-minion basis. Each minion return will be
output as a single JSON object once it comes in to the master.
.sp
Some JSON parsers can guess when an object ends and a new one begins but many
can not. A good way to differentiate between each minion return is to use the
single\-line output format and to parse each line individually. Example output
(truncated):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqdave\(dq: {\(dqen0\(dq: {\(dqhwaddr\(dq: \(dq02:b0:26:32:4c:69\(dq, ...}}}
{\(dqjerry\(dq: {\(dqen0\(dq: {\(dqhwaddr\(dq: \(dq02:26:ab:0d:b9:0d\(dq, ...}}}
{\(dqkevin\(dq: {\(dqen0\(dq: {\(dqhwaddr\(dq: \(dq02:6d:7f:ce:9f:ee\(dq, ...}}}
{\(dqmike\(dq: {\(dqen0\(dq: {\(dqhwaddr\(dq: \(dq02:48:a2:4b:70:a0\(dq, ...}}}
{\(dqphill\(dq: {\(dqen0\(dq: {\(dqhwaddr\(dq: \(dq02:1d:cc:a2:33:55\(dq, ...}}}
{\(dqstuart\(dq: {\(dqen0\(dq: {\(dqhwaddr\(dq: \(dq02:9a:e0:ea:9e:3c\(dq, ...}}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq foo.bar \-\-out=json
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.output.json_out.output(data, **kwargs)
Print the output data in JSON
.UNINDENT
.SS salt.output.key
.SS Display salt\-key output
.sp
The \fBsalt\-key\fP command makes use of this outputter to format its output.
.INDENT 0.0
.TP
.B salt.output.key.output(data, **kwargs)
Read in the dict structure generated by the salt key API methods and
print the structure.
.UNINDENT
.SS salt.output.nested
.SS Recursively display nested data
.sp
This is the default outputter for most execution functions.
.sp
Example output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myminion:
    \-\-\-\-\-\-\-\-\-\-
    foo:
        \-\-\-\-\-\-\-\-\-\-
        bar:
            baz
        dictionary:
            \-\-\-\-\-\-\-\-\-\-
            abc:
                123
            def:
                456
        list:
            \- Hello
            \- World
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.output.nested.NestDisplay(retcode=0)
Manage the nested display contents
.INDENT 7.0
.TP
.B display(ret, indent, prefix, out)
Recursively iterate down through data structures to determine output
.UNINDENT
.INDENT 7.0
.TP
.B ustring(indent, color, msg, prefix=\(aq\(aq, suffix=\(aq\(aq, endc=None)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.output.nested.output(ret, **kwargs)
Display ret data
.UNINDENT
.SS salt.output.newline_values_only
.SS Display values only, separated by newlines
.sp
New in version 2015.5.0.

.sp
This outputter is designed for Salt CLI return data. It will do the following
to the return dict:
.INDENT 0.0
.IP 1. 3
Get just the values (ignoring the minion IDs).
.IP 2. 3
Each value, if it is iterable, is split a separate line.
.IP 3. 3
Each minion\(aqs values are separated by newlines.
.UNINDENT
.sp
This results in a single string of return data containing all the values from
the various minions.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
As noted above, this outputter will discard the minion ID. If the minion ID
is important, then an outputter that returns the full return dictionary in
a parsable format (such as \fBjson\fP, \fBpprint,\fP, or \fByaml\fP) may be more
suitable.
.UNINDENT
.UNINDENT
.SS Example 1
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq foo.bar \-\-out=newline_values_only
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Input
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqmyminion\(aq: [\(aq127.0.0.1\(aq, \(aq10.0.0.1\(aq],
    \(aqsecond\-minion\(aq: [\(aq127.0.0.1\(aq, \(aq10.0.0.2\(aq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Output
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
127.0.0.1
10.0.0.1
127.0.0.1
10.0.0.2
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Example 2
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq foo.bar \-\-out=newline_values_only
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Input
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqmyminion\(aq: 8,
    \(aqsecond\-minion\(aq: 10
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Output
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
8
10
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.output.newline_values_only.output(data, **kwargs)
Display modified ret data
.UNINDENT
.SS salt.output.no_out_quiet
.SS Display no output
.sp
No output is produced when this outputter is selected
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq foo.bar \-\-out=quiet
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.output.no_out_quiet.output(ret, **kwargs)
Don\(aqt display data. Used when you only are interested in the
return.
.UNINDENT
.SS salt.output.no_return
.SS Display output for minions that did not return
.sp
This outputter is used to display notices about which minions failed to return
when a salt function is run with \fB\-v\fP or \fB\-\-verbose\fP\&. It should not be
called directly from the CLI.
.sp
Example output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
virtucentos:
    Minion did not return
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.output.no_return.NestDisplay
Create generator for nested output
.INDENT 7.0
.TP
.B display(ret, indent, prefix, out)
Recursively iterate down through data structures to determine output
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.output.no_return.output(ret, **kwargs)
Display ret data
.UNINDENT
.SS salt.output.overstatestage
.SS Display clean output of an overstate stage
.sp
This outputter is used to display \fI\%Orchestrate Runner\fP stages, and should not be called directly.
.INDENT 0.0
.TP
.B salt.output.overstatestage.output(data, **kwargs)
Format the data for printing stage information from the overstate system
.UNINDENT
.SS salt.output.pony
.SS Display Pony output data structure
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
ponysay CLI program
.UNINDENT
.UNINDENT
.sp
Display output from a pony. Ponies are better than cows
because everybody wants a pony.
.sp
Example output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
< {\(aqlocal\(aq: True} >
 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
 \e
  \e
   \e
    ▄▄▄▄▄▄▄
    ▀▄▄████▄▄
  ▄▄▄█████▄█▄█▄█▄▄▄
 ██████▄▄▄█▄▄█████▄▄
 ▀▄▀ █████▄▄█▄▄█████
     ▄▄▄███████████▄▄▄
     ████▄▄▄▄▄▄███▄▄██           ▄▄▄▄▄▄▄
     ████▄████▄██▄▄███       ▄▄▄▄██▄▄▄▄▄▄
    █▄███▄▄█▄███▄▄██▄▀     ▄▄███████▄▄███▄▄
    ▀▄██████████████▄▄    ▄▄█▄▀▀▀▄▄█████▄▄██
       ▀▀▀▀▀█████▄█▄█▄▄▄▄▄▄▄█     ▀▄████▄████
            ████▄███▄▄▄▄▄▄▄▄▄     ▄▄█████▄███
            ▀▄█▄█▄▄▄██▄▄▄▄▄██    ▄▄██▄██████
             ▀▄████████████▄▀  ▄▄█▄██████▄▀
              ██▄██▄▄▄▄█▄███▄ ███▄▄▄▄▄██▄▀
              ██████  ▀▄▄█████ ▀████████
             ▄▄▄▄███   ███████ ██████▄█▄▄
             ███████   ████████▀▄▀███▄▄█▄▄
           ▄██▄▄████   ████████   ▀▄██▀▄▄▀
           █▄▄██████   █▄▄██████
             █▄▄▄▄█       █▄▄▄▄█
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq foo.bar \-\-out=pony
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.output.pony.output(data, **kwargs)
Mane function
.UNINDENT
.SS salt.output.pprint_out
.SS Python pretty\-print (pprint)
.sp
The python pretty\-print system was once the default outputter. It simply
passes the return data through to \fBpprint.pformat\fP and prints the results.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq foo.bar \-\-out=pprint
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqsaltmine\(aq: {\(aqfoo\(aq: {\(aqbar\(aq: \(aqbaz\(aq,
                      \(aqdictionary\(aq: {\(aqabc\(aq: 123, \(aqdef\(aq: 456},
                      \(aqlist\(aq: [\(aqHello\(aq, \(aqWorld\(aq]}}}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.output.pprint_out.output(data, **kwargs)
Print out via pretty print
.UNINDENT
.SS salt.output.profile
.SS Display profiling data in a table format
.sp
Show profile data for returners that would normally show a highstate output.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.apply something \-\-out=profile
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Attempt to output the returns of state.sls and state.highstate as a table of
names, modules and durations that looks somewhat like the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name                mod.fun                duration (ms)
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
I\-fail\-unless\-stmt  other.function               \-1.0000
old\-minion\-config   grains.list_present           1.1200
salt\-data           group.present                48.3800
/etc/salt/minion    file.managed                 63.1450
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To get the above appearance, use settings something like these:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
out.table.separate_rows: False
out.table.justify: left
out.table.delim: \(aq  \(aq
out.table.prefix: \(aq\(aq
out.table.suffix: \(aq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.output.profile.output(data, **kwargs)
Display the profiling data in a table format.
.UNINDENT
.SS salt.output.progress
.sp
Display return data as a progress bar
.INDENT 0.0
.TP
.B salt.output.progress.output(ret, bar, **kwargs)
Update the progress bar
.UNINDENT
.INDENT 0.0
.TP
.B salt.output.progress.progress_iter(progress)
Initialize and return a progress bar iter
.UNINDENT
.SS salt.output.raw
.SS Display raw output data structure
.sp
This outputter simply displays the output as a python data structure, by
printing a string representation of it. It is similar to the \fBpprint\fP outputter, only the data is not nicely
formatted/indented.
.sp
This was the original outputter used by Salt before the outputter system was
developed.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq foo.bar \-\-out=raw
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq foo.bar \-\-out=raw
{\(aqmyminion\(aq: {\(aqfoo\(aq: {\(aqlist\(aq: [\(aqHello\(aq, \(aqWorld\(aq], \(aqbar\(aq: \(aqbaz\(aq, \(aqdictionary\(aq: {\(aqabc\(aq: 123, \(aqdef\(aq: 456}}}}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.output.raw.output(data, **kwargs)
Rather basic....
.UNINDENT
.SS salt.output.table_out
.SS Display output in a table format
.sp
New in version 2017.7.0.

.sp
The \fBtable\fP outputter displays a sequence of rows as table.
.sp
Example output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
edge01.bjm01:
\-\-\-\-\-\-\-\-\-\-
    comment:
    \-\-\-\-\-\-\-\-\-\-
    out:
    \-\-\-\-\-\-\-\-\-\-
        ______________________________________________________________________________
        | Active | Interface | Last Move |        Mac        | Moves | Static | Vlan |
        ______________________________________________________________________________
        |  True  |  ae1.900  |    0.0    | 40:A6:77:5A:50:01 |   0   | False  | 111  |
        ______________________________________________________________________________
        |  True  |  ae1.111  |    0.0    | 64:16:8D:32:26:58 |   0   | False  | 111  |
        ______________________________________________________________________________
        |  True  |  ae1.111  |    0.0    | 8C:60:4F:73:2D:57 |   0   | False  | 111  |
        ______________________________________________________________________________
        |  True  |  ae1.111  |    0.0    | 8C:60:4F:73:2D:7C |   0   | False  | 111  |
        ______________________________________________________________________________
        |  True  |  ae1.222  |    0.0    | 8C:60:4F:73:2D:57 |   0   | False  | 222  |
        ______________________________________________________________________________
        |  True  |  ae1.222  |    0.0    | F4:0F:1B:76:9D:97 |   0   | False  | 222  |
        ______________________________________________________________________________
    result:
    \-\-\-\-\-\-\-\-\-\-
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq foo.bar \-\-out=table
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.output.table_out.TableDisplay(has_header=True, row_delimiter=\(aq\-\(aq, delim=\(aq | \(aq, justify=\(aqcenter\(aq, separate_rows=True, prefix=\(aq| \(aq, suffix=\(aq |\(aq, width=50, wrapfunc=None)
Manage the table display content.
.INDENT 7.0
.TP
.B display(ret, indent, out, rows_key=None, labels_key=None)
Display table(s).
.UNINDENT
.INDENT 7.0
.TP
.B display_rows(rows, labels, indent)
Prepares row content and displays.
.UNINDENT
.INDENT 7.0
.TP
.B prepare_rows(rows, indent, has_header)
Prepare rows content to be displayed.
.UNINDENT
.INDENT 7.0
.TP
.B ustring(indent, color, msg, prefix=\(aq\(aq, suffix=\(aq\(aq, endc=None)
Build the unicode string to be displayed.
.UNINDENT
.INDENT 7.0
.TP
.B wrap_onspace(text)
When the text inside the column is longer then the width, will split by space and continue on the next line.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.output.table_out.output(ret, **kwargs)
Display the output as table.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnested_indent\fP (\fI*\fP) \-\- integer, specify the left alignment.
.IP \(bu 2
\fBhas_header\fP (\fI*\fP) \-\- boolean specifying if header should be displayed. Default: True.
.IP \(bu 2
\fBrow_delimiter\fP (\fI*\fP) \-\- character to separate rows. Default: \fB_\fP\&.
.IP \(bu 2
\fBdelim\fP (\fI*\fP) \-\- character to separate columns. Default: \fB\(dq | \(dq\fP\&.
.IP \(bu 2
\fBjustify\fP (\fI*\fP) \-\- text alignment. Default: \fBcenter\fP\&.
.IP \(bu 2
\fBseparate_rows\fP (\fI*\fP) \-\- boolean specifying if row separator will be displayed between consecutive rows. Default: True.
.IP \(bu 2
\fBprefix\fP (\fI*\fP) \-\- character at the beginning of the row. Default: \fB\(dq| \(dq\fP\&.
.IP \(bu 2
\fBsuffix\fP (\fI*\fP) \-\- character at the end of the row. Default: \fB\(dq |\(dq\fP\&.
.IP \(bu 2
\fBwidth\fP (\fI*\fP) \-\- column max width. Default: \fB50\fP\&.
.IP \(bu 2
\fBrows_key\fP (\fI*\fP) \-\- display the rows under a specific key.
.IP \(bu 2
\fBlabels_key\fP (\fI*\fP) \-\- use the labels under a certain key. Otherwise will try to use the dictionary keys (if any).
.IP \(bu 2
\fBtitle\fP (\fI*\fP) \-\- display title when only one table is selected (using the \fBrows_key\fP argument).
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.output.txt
.SS Simple text outputter
.sp
The \fBtxt\fP outputter has been developed to make the output from shell commands
on minions appear as they do when the command is executed on the minion.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq foo.bar \-\-out=txt
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.output.txt.output(data, **kwargs)
Output the data in lines, very nice for running commands
.UNINDENT
.SS salt.output.virt_query
.SS virt.query outputter
.sp
Used to display the output from the \fI\%virt.query\fP
runner.
.INDENT 0.0
.TP
.B salt.output.virt_query.output(data, **kwargs)
Display output for the salt\-run virt.query function
.UNINDENT
.SS salt.output.yaml_out
.SS Display return data in YAML format
.sp
This outputter defaults to printing in YAML block mode for better readability.
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq foo.bar \-\-out=yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
saltmine:
  foo:
    bar: baz
    dictionary:
      abc: 123
      def: 456
    list:
      \- Hello
      \- World
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.output.yaml_out.output(data, **kwargs)
Print out YAML using the block mode
.UNINDENT
.SS pillar modules
.TS
center;
|l|l|.
_
T{
\fI\%cmd_json\fP
T}	T{
Execute a command and read the output as JSON.
T}
_
T{
\fI\%cmd_yaml\fP
T}	T{
Execute a command and read the output as YAML.
T}
_
T{
\fI\%cmd_yamlex\fP
T}	T{
Execute a command and read the output as YAMLEX.
T}
_
T{
\fI\%cobbler\fP
T}	T{
A module to pull data from Cobbler via its API into the Pillar dictionary
T}
_
T{
\fI\%confidant\fP
T}	T{
An external pillar module for getting credentials from confidant.
T}
_
T{
\fI\%consul_pillar\fP
T}	T{
Use Consul K/V as a Pillar source with values parsed as YAML
T}
_
T{
\fI\%csvpillar\fP
T}	T{
Store key/value pairs in a CSV file
T}
_
T{
\fI\%digicert\fP
T}	T{
Digicert Pillar Certificates
T}
_
T{
\fI\%django_orm\fP
T}	T{
Generate Pillar data from Django models through the Django ORM
T}
_
T{
\fI\%ec2_pillar\fP
T}	T{
Retrieve EC2 instance data for minions for ec2_tags and ec2_tags_list
T}
_
T{
\fI\%etcd_pillar\fP
T}	T{
Use etcd data as a Pillar source
T}
_
T{
\fI\%extra_minion_data_in_pillar\fP
T}	T{
Add all extra minion data to the pillar.
T}
_
T{
\fI\%file_tree\fP
T}	T{
The \fBfile_tree\fP external pillar allows values from all files in a directory tree to be imported as Pillar data.
T}
_
T{
\fI\%foreman\fP
T}	T{
A module to pull data from Foreman via its API into the Pillar dictionary
T}
_
T{
\fI\%git_pillar\fP
T}	T{
Use a git repository as a Pillar source
T}
_
T{
\fI\%gpg\fP
T}	T{
Decrypt pillar data through the builtin GPG renderer
T}
_
T{
\fI\%hg_pillar\fP
T}	T{
Use remote Mercurial repository as a Pillar source.
T}
_
T{
\fI\%hiera\fP
T}	T{
Use hiera data as a Pillar source
T}
_
T{
\fI\%http_json\fP
T}	T{
A module that adds data to the Pillar structure retrieved by an http request
T}
_
T{
\fI\%http_yaml\fP
T}	T{
A module that adds data to the Pillar structure retrieved by an http request
T}
_
T{
\fI\%libvirt\fP
T}	T{
Load up the libvirt keys into Pillar for a given minion if said keys have been generated using the libvirt key runner
T}
_
T{
\fI\%makostack\fP
T}	T{
Simple and flexible YAML ext_pillar which can read pillar from within pillar.
T}
_
T{
\fI\%mongo\fP
T}	T{
Read Pillar data from a mongodb collection
T}
_
T{
\fI\%mysql\fP
T}	T{
Retrieve Pillar data by doing a MySQL query
T}
_
T{
\fI\%nacl\fP
T}	T{
Decrypt pillar data through the builtin NACL renderer
T}
_
T{
\fI\%netbox\fP
T}	T{
A module that adds data to the Pillar structure from a NetBox API.
T}
_
T{
\fI\%neutron\fP
T}	T{
Use Openstack Neutron data as a Pillar source.
T}
_
T{
\fI\%nodegroups\fP
T}	T{
Nodegroups Pillar
T}
_
T{
\fI\%pepa\fP
T}	T{
Pepa
T}
_
T{
\fI\%pillar_ldap\fP
T}	T{
Use LDAP data as a Pillar source
T}
_
T{
\fI\%postgres\fP
T}	T{
Retrieve Pillar data by doing a postgres query
T}
_
T{
\fI\%puppet\fP
T}	T{
Execute an unmodified puppet_node_classifier and read the output as YAML.
T}
_
T{
\fI\%reclass_adapter\fP
T}	T{
Use the \(dqreclass\(dq database as a Pillar source
T}
_
T{
\fI\%redismod\fP
T}	T{
Read pillar data from a Redis backend
T}
_
T{
\fI\%rethinkdb_pillar\fP
T}	T{
Provide external pillar data from RethinkDB
T}
_
T{
\fI\%s3\fP
T}	T{
Copy pillar data from a bucket in Amazon S3
T}
_
T{
\fI\%saltclass\fP
T}	T{
SaltClass Pillar Module
T}
_
T{
\fI\%sql_base\fP
T}	T{
Retrieve Pillar data by doing a SQL query
T}
_
T{
\fI\%sqlcipher\fP
T}	T{
Retrieve Pillar data by running a SQLCipher query
T}
_
T{
\fI\%sqlite3\fP
T}	T{
Retrieve Pillar data by doing a SQLite3 query
T}
_
T{
\fI\%stack\fP
T}	T{
Simple and flexible YAML ext_pillar which can read pillar from within pillar.
T}
_
T{
\fI\%svn_pillar\fP
T}	T{
Clone a remote SVN repository and use the filesystem as a Pillar source
T}
_
T{
\fI\%varstack_pillar\fP
T}	T{
Use \fI\%Varstack\fP data as a Pillar source
T}
_
T{
\fI\%vault\fP
T}	T{
Vault Pillar Module
T}
_
T{
\fI\%venafi\fP
T}	T{
Venafi Pillar Certificates
T}
_
T{
\fI\%virtkey\fP
T}	T{
Accept a key from a hypervisor if the virt runner has already submitted an authorization request
T}
_
T{
\fI\%vmware_pillar\fP
T}	T{
Pillar data from vCenter or an ESXi host
T}
_
.TE
.SS salt.pillar.cmd_json
.sp
Execute a command and read the output as JSON. The JSON data is then directly overlaid onto the minion\(aqs Pillar data.
.SS Configuring the CMD_JSON ext_pillar
.sp
Set the following Salt config to setup cmd json result as external pillar source:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- cmd_json: \(aqecho {\(dqarg\(dq:\(dqvalue\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will run the command \fBecho {arg: value}\fP on the master.
.SS Module Documentation
.INDENT 0.0
.TP
.B salt.pillar.cmd_json.ext_pillar(minion_id, pillar, command)
Execute a command and read the output as JSON
.UNINDENT
.SS salt.pillar.cmd_yaml
.sp
Execute a command and read the output as YAML. The YAML data is then directly overlaid onto the minion\(aqs Pillar data
.INDENT 0.0
.TP
.B salt.pillar.cmd_yaml.ext_pillar(minion_id, pillar, command)
Execute a command and read the output as YAML
.UNINDENT
.SS salt.pillar.cmd_yamlex
.sp
Execute a command and read the output as YAMLEX.
.sp
The YAMLEX data is then directly overlaid onto the minion\(aqs Pillar data
.INDENT 0.0
.TP
.B salt.pillar.cmd_yamlex.ext_pillar(minion_id, pillar, command)
Execute a command and read the output as YAMLEX
.UNINDENT
.SS salt.pillar.cobbler
.sp
A module to pull data from Cobbler via its API into the Pillar dictionary
.SS Configuring the Cobbler ext_pillar
.sp
The same cobbler.* parameters are used for both the Cobbler tops and Cobbler pillar
modules.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
\- cobbler:
    key: cobbler # Nest results within this key. By default, values are not nested.
    only: [parameters] # Add only these keys to pillar.

cobbler.url: https://example.com/cobbler_api #default is http://localhost/cobbler_api
cobbler.user: username # default is no username
cobbler.password: password # default is no password
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Module Documentation
.INDENT 0.0
.TP
.B salt.pillar.cobbler.ext_pillar(minion_id, pillar, key=None, only=())
Read pillar data from Cobbler via its API.
.UNINDENT
.SS salt.pillar.confidant
.sp
An external pillar module for getting credentials from confidant.
.SS Configuring the Confidant module
.sp
The module can be configured via ext_pillar in the minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B ext_pillar:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B confidant:
.INDENT 7.0
.TP
.B profile:
# The URL of the confidant web service
url: \(aq\fI\%https://confidant\-production.example.com\fP\(aq
# The context to use for KMS authentication
auth_context:
from: example\-production\-iad
to: confidant\-production\-iad
user_type: service
# The KMS master key to use for authentication
auth_key: \(dqalias/authnz\(dq
# Cache file for KMS auth token
token_cache_file: /run/confidant/confidant_token
# The duration of the validity of a token, in minutes
token_duration: 60
# key, keyid and region can be defined in the profile, but it\(aqs
# generally best to use IAM roles or environment variables for AWS
# auth.
keyid: 98nh9h9h908h09kjjk
key: jhf908gyeghehe0he0g8h9u0j0n0n09hj09h0
region: us\-east\-1
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
confidant\-common, confidant\-client
.UNINDENT
.SS Module Documentation
.INDENT 0.0
.TP
.B salt.pillar.confidant.ext_pillar(minion_id, pillar, profile=None)
Read pillar data from Confidant via its API.
.UNINDENT
.SS salt.pillar.consul_pillar
.sp
Use Consul K/V as a Pillar source with values parsed as YAML
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
python\-consul
.UNINDENT
.UNINDENT
.sp
In order to use an consul server, a profile must be created in the master
configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_consul_config:
  consul.host: 127.0.0.1
  consul.port: 8500
  consul.token: b6376760\-a8bb\-edd5\-fcda\-33bc13bfc556
  consul.scheme: http
  consul.consistency: default
  consul.dc: dev
  consul.verify: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
All parameters are optional.
.sp
The \fBconsul.token\fP requires python\-consul >= 0.4.7.
.sp
If you have a multi\-datacenter Consul cluster you can map your \fBpillarenv\fP
entries to your data centers by providing a dictionary of mappings in
\fBconsul.dc\fP field:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_consul_config:
  consul.dc:
    dev: us\-east\-1
    prod: us\-west\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the example above we specifying static mapping between Pillar environments
and data centers: the data for \fBdev\fP and \fBprod\fP Pillar environments will
be fetched from \fBus\-east\-1\fP and \fBus\-west\-1\fP datacenter respectively.
.sp
In fact when \fBconsul.dc\fP is set to dictionary keys are processed as regular
expressions (that can capture named parameters) and values are processed as
string templates as per PEP 3101.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_consul_config:
  consul.dc:
    ^dev\-.*$: dev\-datacenter
    ^(?P<region>.*)\-prod$: prod\-datacenter\-{region}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example maps all Pillar environments starting with \fBdev\-\fP to
\fBdev\-datacenter\fP whereas Pillar environment like \fBeu\-prod\fP will be
mapped to \fBprod\-datacenter\-eu\fP\&.
.sp
Before evaluation patterns are sorted by length in descending order.
.sp
If Pillar environment names correspond to data center names a single pattern
can be used:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_consul_config:
  consul.dc:
    ^(?P<env>.*)$: \(aq{env}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
After the profile is created, configure the external pillar system to use it.
Optionally, a root may be specified.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- consul: my_consul_config

ext_pillar:
  \- consul: my_consul_config root=salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using these configuration profiles, multiple consul sources may also be used:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- consul: my_consul_config
  \- consul: my_other_consul_config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Either the \fBminion_id\fP, or the \fBrole\fP, or the \fBenvironment\fP grain  may be used in the \fBroot\fP
path to expose minion\-specific information stored in consul.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- consul: my_consul_config root=salt/%(minion_id)s
  \- consul: my_consul_config root=salt/%(role)s
  \- consul: my_consul_config root=salt/%(environment)s
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minion\-specific values may override shared values when the minion\-specific root
appears after the shared root:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- consul: my_consul_config root=salt\-shared
  \- consul: my_other_consul_config root=salt\-private/%(minion_id)s
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If using the \fBrole\fP or \fBenvironment\fP grain in the consul key path, be sure to define it using
\fI/etc/salt/grains\fP, or similar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
role: my\-minion\-role
environment: dev
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs possible to lock down where the pillar values are shared through minion
targeting. Note that double quotes \fB\(dq\fP are required around the target value
and cannot be used inside the matching statement. See the section on Compound
Matchers for more examples.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- consul: my_consul_config root=salt target=\(dqL@salt.example.com and G@osarch:x86_64\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The data from Consul can be merged into a nested key in Pillar.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- consul: my_consul_config pillar_root=consul_data
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default, keys containing YAML data will be deserialized before being merged into Pillar.
This behavior can be disabled by setting \fBexpand_keys\fP to \fBfalse\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- consul: my_consul_config expand_keys=false
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.consul_pillar.consul_fetch(client, path)
Query consul for all keys/values within base path
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.consul_pillar.ext_pillar(minion_id, pillar, conf)
Check consul for all data
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.consul_pillar.fetch_tree(client, path, expand_keys)
Grab data from consul, trim base path and remove any keys which
are folders. Take the remaining data and send it to be formatted
in such a way as to be used as pillar data.
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.consul_pillar.get_conn(opts, profile)
Return a client object for accessing consul
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.consul_pillar.pillar_format(ret, keys, value, expand_keys)
Perform data formatting to be used as pillar data and
merge it with the current pillar data
.UNINDENT
.SS salt.pillar.csvpillar
.sp
Store key/value pairs in a CSV file
.sp
New in version 2016.11.0.

.sp
Example configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- csv: /path/to/file.csv

# or

ext_pillar:
  \- csv:
      path: /path/to/file.csv
      namespace: \(aqsubkey\(aq
      fieldnames:
      \- col1
      \- col2
      \- col2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The first column must be minion IDs and the first row must be dictionary keys.
E.g.:
.TS
center;
|l|l|l|.
_
T{
id
T}	T{
role
T}	T{
env
T}
_
T{
jerry
T}	T{
web
T}	T{
prod
T}
_
T{
stuart
T}	T{
web
T}	T{
stage
T}
_
T{
dave
T}	T{
web
T}	T{
qa
T}
_
T{
phil
T}	T{
db
T}	T{
prod
T}
_
T{
kevin
T}	T{
db
T}	T{
stage
T}
_
T{
mike
T}	T{
db
T}	T{
qa
T}
_
.TE
.sp
Will produce the following Pillar values for a minion named \(dqjerry\(dq:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqrole\(aq: \(aqweb\(aq,
    \(aqenv\(aq: \(aqprod\(aq,
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.csvpillar.ext_pillar(mid, pillar, path, idkey=\(aqid\(aq, namespace=None, fieldnames=None, restkey=None, restval=None, dialect=\(aqexcel\(aq)
Read a CSV into Pillar
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fI\%str\fP) \-\- Absolute path to a CSV file.
.IP \(bu 2
\fBidkey\fP (\fI\%str\fP) \-\- (Optional) The column name of minion IDs.
.IP \(bu 2
\fBnamespace\fP (\fI\%str\fP) \-\- (Optional) A pillar key to namespace the values under.
.IP \(bu 2
\fBfieldnames\fP (\fI\%list\fP) \-\- (Optional) if the first row of the CSV is not
column names they may be specified here instead.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.pillar.digicert
.sp
Digicert Pillar Certificates
.sp
This module will only return pillar data if the \fBdigicert\fP runner module has
already been used to create certificates.
.sp
To configure this module, set \fBdigicert\fP to \fBTrue\fP in the \fBext_pillar\fP
section of your \fBmaster\fP configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- digicert: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.digicert.ext_pillar(minion_id, pillar, conf)
Return an existing set of certificates
.UNINDENT
.SS salt.pillar.django_orm
.sp
Generate Pillar data from Django models through the Django ORM
.INDENT 0.0
.TP
.B maintainer
Micah Hausler <\fI\%micah.hausler@gmail.com\fP>
.TP
.B maturity
new
.UNINDENT
.SS Configuring the django_orm ext_pillar
.sp
To use this module, your Django project must be on the salt master server with
database access. This assumes you are using virtualenv with all the project\(aqs
requirements installed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- django_orm:
      pillar_name: my_application
      project_path: /path/to/project/
      settings_module: my_application.settings
      env_file: /path/to/env/file.sh
      # Optional: If your project is not using the system python,
      # add your virtualenv path below.
      env: /path/to/virtualenv/

      django_app:

        # Required: the app that is included in INSTALLED_APPS
        my_application.clients:

          # Required: the model name
          Client:

            # Required: model field to use as the key in the rendered
            # Pillar. Must be unique; must also be included in the
            # \(ga\(gafields\(ga\(ga list below.
            name: shortname

            # Optional:
            # See Django\(aqs QuerySet documentation for how to use .filter()
            filter:  {\(aqkw\(aq: \(aqargs\(aq}

            # Required: a list of field names
            # List items will be used as arguments to the .values() method.
            # See Django\(aqs QuerySet documentation for how to use .values()
            fields:
              \- field_1
              \- field_2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This would return pillar data that would look like
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_application:
  my_application.clients:
    Client:
      client_1:
        field_1: data_from_field_1
        field_2: data_from_field_2
      client_2:
        field_1: data_from_field_1
        field_2: data_from_field_2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As another example, data from multiple database tables can be fetched using
Django\(aqs regular lookup syntax. Note, using ManyToManyFields will not currently
work since the return from values() changes if a ManyToMany is present.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- django_orm:
      pillar_name: djangotutorial
      project_path: /path/to/mysite
      settings_module: mysite.settings

      django_app:
        mysite.polls:
          Choices:
            name: poll__question
            fields:
              \- poll__question
              \- poll__id
              \- choice_text
              \- votes
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Module Documentation
.INDENT 0.0
.TP
.B salt.pillar.django_orm.ext_pillar(minion_id, pillar, pillar_name, project_path, settings_module, django_app, env=None, env_file=None, *args, **kwargs)
Connect to a Django database through the ORM and retrieve model fields
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpillar_name\fP (\fI\%str\fP) \-\- The name of the pillar to be returned
.IP \(bu 2
\fBproject_path\fP (\fI\%str\fP) \-\- The full path to your Django project (the directory
manage.py is in)
.IP \(bu 2
\fBsettings_module\fP (\fI\%str\fP) \-\- The settings module for your project. This can be
found in your manage.py file
.IP \(bu 2
\fBdjango_app\fP (\fI\%str\fP) \-\- A dictionary containing your apps, models, and fields
.IP \(bu 2
\fBenv\fP (\fI\%str\fP) \-\- The full path to the virtualenv for your Django project
.IP \(bu 2
\fBenv_file\fP (\fI\%str\fP) \-\- An optional bash file that sets up your environment. The
file is run in a subprocess and the changed variables are then added
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.pillar.ec2_pillar
.sp
Retrieve EC2 instance data for minions for ec2_tags and ec2_tags_list
.sp
The minion id must be the AWS instance\-id or value in \fBtag_match_key\fP\&.  For
example set \fBtag_match_key\fP to \fBName\fP to have the minion\-id matched against
the tag \(aqName\(aq. The tag contents must be unique. The value of
\fBtag_match_value\fP can be \(aquqdn\(aq or \(aqasis\(aq. if \(aquqdn\(aq, then the domain will be
stripped before comparison.
.sp
Additionally, the \fBuse_grain\fP option can be set to \fBTrue\fP\&. This allows the
use of an instance\-id grain instead of the minion\-id. Since this is a potential
security risk, the configuration can be further expanded to include a list of
minions that are trusted to only allow the alternate id of the instances to
specific hosts. There is no glob matching at this time.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you are using \fBuse_grain: True\fP in the configuration for this external
pillar module, the minion must have \fI\%metadata_server_grains\fP
enabled in the minion config file (see also \fI\%here\fP).
.sp
It is important to also note that enabling the \fBuse_grain\fP option allows
the minion to manipulate the pillar data returned, as described above.
.UNINDENT
.UNINDENT
.sp
The optional \fBtag_list_key\fP indicates which keys should be added to
\fBec2_tags_list\fP and be split by \fBtag_list_sep\fP (by default \fB;\fP). If a tag
key is included in \fBtag_list_key\fP it is removed from ec2_tags. If a tag does
not exist it is still included as an empty list.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
As with any master configuration change, restart the salt\-master daemon for
changes to take effect.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- ec2_pillar:
      tag_match_key: \(aqName\(aq
      tag_match_value: \(aqasis\(aq
      tag_list_key:
        \- Role
      tag_list_sep: \(aq;\(aq
      use_grain: True
      minion_ids:
        \- trusted\-minion\-1
        \- trusted\-minion\-2
        \- trusted\-minion\-3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is a very simple pillar configuration that simply retrieves the instance
data from AWS. Currently the only portion implemented are EC2 tags, which
returns a list of key/value pairs for all of the EC2 tags assigned to the
instance.
.INDENT 0.0
.TP
.B salt.pillar.ec2_pillar.ext_pillar(minion_id, pillar, use_grain=False, minion_ids=None, tag_match_key=None, tag_match_value=\(aqasis\(aq, tag_list_key=None, tag_list_sep=\(aq;\(aq)
Execute a command and read the output as YAML
.UNINDENT
.SS salt.pillar.etcd_pillar
.sp
Use etcd data as a Pillar source
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
python\-etcd or etcd3\-py
.UNINDENT
.UNINDENT
.sp
In order to use an etcd server, a profile must be created in the master
configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_etcd_config:
  etcd.host: 127.0.0.1
  etcd.port: 4001
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In order to choose whether to use etcd API v2 or v3, you can put the following
configuration option in the same place as your etcd configuration.  This option
defaults to true, meaning you will use v2 unless you specify otherwise.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.require_v2: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When using API v3, there are some specific options available to be configured
within your etcd profile.  They are defaulted to the following...
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.encode_keys: False
etcd.encode_values: True
etcd.raw_keys: False
etcd.raw_values: False
etcd.unicode_errors: \(dqsurrogateescape\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBetcd.encode_keys\fP indicates whether you want to pre\-encode keys using msgpack before
adding them to etcd.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you set \fBetcd.encode_keys\fP to \fBTrue\fP, all recursive functionality will no longer work.
This includes \fBtree\fP and \fBls\fP and all other methods if you set \fBrecurse\fP/\fBrecursive\fP to \fBTrue\fP\&.
This is due to the fact that when encoding with msgpack, keys like \fB/salt\fP and \fB/salt/stack\fP will have
differing byte prefixes, and etcd v3 searches recursively using prefixes.
.UNINDENT
.UNINDENT
.sp
\fBetcd.encode_values\fP indicates whether you want to pre\-encode values using msgpack before
adding them to etcd.  This defaults to \fBTrue\fP to avoid data loss on non\-string values wherever possible.
.sp
\fBetcd.raw_keys\fP determines whether you want the raw key or a string returned.
.sp
\fBetcd.raw_values\fP determines whether you want the raw value or a string returned.
.sp
\fBetcd.unicode_errors\fP determines what you policy to follow when there are encoding/decoding errors.
.sp
After the profile is created, configure the external pillar system to use it.
Optionally, a root may be specified.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- etcd: my_etcd_config

ext_pillar:
  \- etcd: my_etcd_config root=/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using these configuration profiles, multiple etcd sources may also be used:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- etcd: my_etcd_config
  \- etcd: my_other_etcd_config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBminion_id\fP may be used in the \fBroot\fP path to expose minion\-specific
information stored in etcd.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- etcd: my_etcd_config root=/salt/%(minion_id)s
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minion\-specific values may override shared values when the minion\-specific root
appears after the shared root:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- etcd: my_etcd_config root=/salt\-shared
  \- etcd: my_other_etcd_config root=/salt\-private/%(minion_id)s
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using the configuration above, the following commands could be used to share a
key with all minions but override its value for a specific minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcdctl set /salt\-shared/mykey my_value
etcdctl set /salt\-private/special_minion_id/mykey my_other_value
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.etcd_pillar.ext_pillar(minion_id, pillar, conf)
Check etcd for all data
.UNINDENT
.SS salt.pillar.extra_minion_data_in_pillar
.sp
Add all extra minion data to the pillar.
.INDENT 0.0
.TP
.B codeauthor
\fI\%Alexandru.Bleotu@morganstanley.ms.com\fP
.UNINDENT
.sp
One can filter on the keys to include in the pillar by using the \fBinclude\fP
parameter. For subkeys the \(aq:\(aq notation is supported (i.e. \(aqkey:subkey\(aq)
The keyword \fB<all>\fP includes all keys.
.SS Complete example in etc/salt/master
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- extra_minion_data_in_pillar:
      include: *

ext_pillar:
  \- extra_minion_data_in_pillar:
      include:
          \- key1
          \- key2:subkey2

ext_pillar:
  \- extra_minion_data_in_pillar:
      include: <all>
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.extra_minion_data_in_pillar.ext_pillar(minion_id, pillar, include, extra_minion_data=None)
.UNINDENT
.SS salt.pillar.file_tree
.sp
The \fBfile_tree\fP external pillar allows values from all files in a directory
tree to be imported as Pillar data.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is an external pillar and is subject to the \fI\%rules and
constraints\fP governing external pillars.
.UNINDENT
.UNINDENT
.sp
New in version 2015.5.0.

.sp
In this pillar, data is organized by either Minion ID or Nodegroup name.  To
setup pillar data for a specific Minion, place it in
\fB<root_dir>/hosts/<minion_id>\fP\&.  To setup pillar data for an entire
Nodegroup, place it in \fB<root_dir>/nodegroups/<node_group>\fP where
\fB<node_group>\fP is the Nodegroup\(aqs name.
.SS Example \fBfile_tree\fP Pillar
.SS Master Configuration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- file_tree:
      root_dir: /srv/ext_pillar
      follow_dir_links: False
      keep_newline: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBroot_dir\fP parameter is required and points to the directory where files
for each host are stored. The \fBfollow_dir_links\fP parameter is optional and
defaults to False. If \fBfollow_dir_links\fP is set to True, this external pillar
will follow symbolic links to other directories.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Be careful when using \fBfollow_dir_links\fP, as a recursive symlink chain
will result in unexpected results.
.UNINDENT
.UNINDENT
.sp
Changed in version 2018.3.0: If \fBroot_dir\fP is a relative path, it will be treated as relative to the
\fI\%pillar_roots\fP of the environment specified by
\fI\%pillarenv\fP\&. If an environment specifies multiple
roots, this module will search for files relative to all of them, in order,
merging the results.

.sp
If \fBkeep_newline\fP is set to \fBTrue\fP, then the pillar values for files ending
in newlines will keep that newline. The default behavior is to remove the
end\-of\-file newline. \fBkeep_newline\fP should be turned on if the pillar data is
intended to be used to deploy a file using \fBcontents_pillar\fP with a
\fI\%file.managed\fP state.
.sp
Changed in version 2015.8.4: The \fBraw_data\fP parameter has been renamed to \fBkeep_newline\fP\&. In earlier
releases, \fBraw_data\fP must be used. Also, this parameter can now be a list
of globs, allowing for more granular control over which pillar values keep
their end\-of\-file newline. The globs match paths relative to the
directories named for minion IDs and nodegroups underneath the \fBroot_dir\fP
(see the layout examples in the below sections).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- file_tree:
      root_dir: /path/to/root/directory
      keep_newline:
        \- files/testdir/*
.ft P
.fi
.UNINDENT
.UNINDENT

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In earlier releases, this documentation incorrectly stated that binary
files would not affected by the \fBkeep_newline\fP configuration.  However,
this module does not actually distinguish between binary and text files.
.UNINDENT
.UNINDENT
.sp
Changed in version 2017.7.0: Templating/rendering has been added. You can now specify a default render
pipeline and a black\- and whitelist of (dis)allowed renderers.
.sp
\fBtemplate\fP must be set to \fBTrue\fP for templating to happen.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- file_tree:
    root_dir: /path/to/root/directory
    render_default: jinja|yaml
    renderer_blacklist:
      \- gpg
    renderer_whitelist:
      \- jinja
      \- yaml
    template: True
.ft P
.fi
.UNINDENT
.UNINDENT

.SS Assigning Pillar Data to Individual Hosts
.sp
To configure pillar data for each host, this external pillar will recursively
iterate over \fBroot_dir\fP/hosts/\fBid\fP (where \fBid\fP is a minion ID), and
compile pillar data with each subdirectory as a dictionary key and each file
as a value.
.sp
For example, the following \fBroot_dir\fP tree:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\&./hosts/
\&./hosts/test\-host/
\&./hosts/test\-host/files/
\&./hosts/test\-host/files/testdir/
\&./hosts/test\-host/files/testdir/file1.txt
\&./hosts/test\-host/files/testdir/file2.txt
\&./hosts/test\-host/files/another\-testdir/
\&./hosts/test\-host/files/another\-testdir/symlink\-to\-file1.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will result in the following pillar tree for minion with ID \fBtest\-host\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
test\-host:
    \-\-\-\-\-\-\-\-\-\-
    apache:
        \-\-\-\-\-\-\-\-\-\-
        config.d:
            \-\-\-\-\-\-\-\-\-\-
            00_important.conf:
                <important_config important_setting=\(dqyes\(dq />
            20_bob_extra.conf:
                <bob_specific_cfg has_freeze_ray=\(dqyes\(dq />
    corporate_app:
        \-\-\-\-\-\-\-\-\-\-
        settings:
            \-\-\-\-\-\-\-\-\-\-
            common_settings:
                // This is the main settings file for the corporate
                // internal web app
                main_setting: probably
            bob_settings:
                role: bob
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The leaf data in the example shown is the contents of the pillar files.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.file_tree.ext_pillar(minion_id, pillar, root_dir=None, follow_dir_links=False, debug=False, keep_newline=False, render_default=None, renderer_blacklist=None, renderer_whitelist=None, template=False)
Compile pillar data from the given \fBroot_dir\fP specific to Nodegroup names
and Minion IDs.
.sp
If a Minion\(aqs ID is not found at \fB<root_dir>/host/<minion_id>\fP or if it
is not included in any Nodegroups named at
\fB<root_dir>/nodegroups/<node_group>\fP, no pillar data provided by this
pillar module will be available for that Minion.
.sp
Changed in version 2017.7.0: Templating/rendering has been added. You can now specify a default
render pipeline and a black\- and whitelist of (dis)allowed renderers.
.sp
\fBtemplate\fP must be set to \fBTrue\fP for templating to happen.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- file_tree:
    root_dir: /path/to/root/directory
    render_default: jinja|yaml
    renderer_blacklist:
      \- gpg
    renderer_whitelist:
      \- jinja
      \- yaml
    template: True
.ft P
.fi
.UNINDENT
.UNINDENT

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBminion_id\fP \-\- The ID of the Minion whose pillar data is to be collected
.IP \(bu 2
\fBpillar\fP \-\- Unused by the \fBfile_tree\fP pillar module
.IP \(bu 2
\fBroot_dir\fP \-\-
.sp
Filesystem directory used as the root for pillar data (e.g.
\fB/srv/ext_pillar\fP)
.sp
Changed in version 2018.3.0: If \fBroot_dir\fP is a relative path, it will be treated as relative to the
\fI\%pillar_roots\fP of the environment specified by
\fI\%pillarenv\fP\&. If an environment specifies multiple
roots, this module will search for files relative to all of them, in order,
merging the results.


.IP \(bu 2
\fBfollow_dir_links\fP \-\-
.sp
Follow symbolic links to directories while collecting pillar files.
Defaults to \fBFalse\fP\&.
.sp
\fBWARNING:\fP
.INDENT 2.0
.INDENT 3.5
Care should be exercised when enabling this option as it will
follow links that point outside of \fBroot_dir\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 2.0
.INDENT 3.5
Symbolic links that lead to infinite recursion are not filtered.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBdebug\fP \-\- Enable debug information at log level \fBdebug\fP\&.  Defaults to
\fBFalse\fP\&.  This option may be useful to help debug errors when setting
up the \fBfile_tree\fP pillar module.
.IP \(bu 2
\fBkeep_newline\fP \-\-
.sp
Preserve the end\-of\-file newline in files.  Defaults to \fBFalse\fP\&.
This option may either be a boolean or a list of file globs (as defined
by the \fI\%Python fnmatch package\fP) for which end\-of\-file
newlines are to be kept.
.sp
\fBkeep_newline\fP should be turned on if the pillar data is intended to
be used to deploy a file using \fBcontents_pillar\fP with a
\fI\%file.managed\fP state.
.sp
Changed in version 2015.8.4: The \fBraw_data\fP parameter has been renamed to \fBkeep_newline\fP\&. In
earlier releases, \fBraw_data\fP must be used. Also, this parameter
can now be a list of globs, allowing for more granular control over
which pillar values keep their end\-of\-file newline. The globs match
paths relative to the directories named for Minion IDs and
Nodegroup namess underneath the \fBroot_dir\fP\&.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- file_tree:
      root_dir: /srv/ext_pillar
      keep_newline:
        \- apache/config.d/*
        \- corporate_app/settings/*
.ft P
.fi
.UNINDENT
.UNINDENT

.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
In earlier releases, this documentation incorrectly stated that
binary files would not affected by the \fBkeep_newline\fP\&.  However,
this module does not actually distinguish between binary and text
files.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBrender_default\fP \-\-
.sp
Override Salt\(aqs \fI\%default global renderer\fP for
the \fBfile_tree\fP pillar.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
render_default: jinja
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBrenderer_blacklist\fP \-\-
.sp
Disallow renderers for pillar files.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
renderer_blacklist:
  \- json
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBrenderer_whitelist\fP \-\-
.sp
Allow renderers for pillar files.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
renderer_whitelist:
  \- yaml
  \- jinja
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBtemplate\fP \-\- Enable templating of pillar files.  Defaults to \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.pillar.foreman
.sp
A module to pull data from Foreman via its API into the Pillar dictionary
.SS Configuring the Foreman ext_pillar
.sp
Set the following Salt config to setup Foreman as external pillar source:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- foreman:
      key: foreman # Nest results within this key
      only: [\(aqhostgroup_name\(aq, \(aqparameters\(aq] # Add only these keys to pillar

foreman.url: https://example.com/foreman_api
foreman.user: username # default is admin
foreman.password: password # default is changeme
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following options are optional:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foreman.api: apiversion # default is 2 (1 is not supported yet)
foreman.verifyssl: False # default is True
foreman.certfile: /etc/ssl/certs/mycert.pem # default is None
foreman.keyfile: /etc/ssl/private/mykey.pem # default is None
foreman.cafile: /etc/ssl/certs/mycert.ca.pem # default is None
foreman.lookup_parameters: True # default is True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
An alternative would be to use the Foreman modules integrating Salt features
in the Smart Proxy and the webinterface.
.sp
Further information can be found on \fI\%GitHub\fP\&.
.SS Module Documentation
.INDENT 0.0
.TP
.B salt.pillar.foreman.ext_pillar(minion_id, pillar, key=None, only=())
Read pillar data from Foreman via its API.
.UNINDENT
.SS salt.pillar.git_pillar
.SS Use a git repository as a Pillar source
.sp
This external pillar allows for a Pillar top file and Pillar SLS files to be
sourced from a git repository.
.sp
However, since git_pillar does not have an equivalent to the
\fI\%pillar_roots\fP parameter, configuration is slightly different. A
Pillar top file is required to be in the git repository and must still contain
the relevant environment, like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The branch/tag which maps to that environment must then be specified along with
the repo\(aqs URL. Configuration details can be found below.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
Each branch/tag used for git_pillar must have its own top file. This is
different from how the top file works when configuring \fI\%States\fP\&. The reason for this is that each git_pillar branch/tag
is processed separately from the rest. Therefore, if the \fBqa\fP branch is
to be used for git_pillar, it would need to have its own top file, with the
\fBqa\fP environment defined within it, like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
qa:
  \(aqdev\-*\(aq:
    \- bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Additionally, while git_pillar allows for the branch/tag to be overridden
(see \fI\%here\fP), keep in
mind that the top file must reference the actual environment name. It is
common practice to make the environment in a git_pillar top file match the
branch/tag name, but when remapping, the environment of course no longer
matches the branch/tag, and the top file needs to be adjusted accordingly.
When expected Pillar values configured in git_pillar are missing, this is a
common misconfiguration that may be to blame, and is a good first step in
troubleshooting.
.UNINDENT
.UNINDENT
.SS Configuring git_pillar for Salt
.sp
Beginning with Salt version 2015.8.0, \fI\%pygit2\fP is now supported in addition to
\fI\%GitPython\fP\&. The requirements for \fI\%GitPython\fP and \fI\%pygit2\fP are the same as for
GitFS, as described \fI\%here\fP\&.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
git_pillar has its own set of global configuration parameters. While it may
seem intuitive to use the global gitfs configuration parameters
(\fI\%gitfs_base\fP, etc.) to manage git_pillar, this will not work.
The main difference for this is the fact that the different components
which use Salt\(aqs git backend code do not all function identically. For
instance, in git_pillar it is necessary to specify which branch/tag to be
used for git_pillar remotes. This is the reverse behavior from gitfs, where
branches/tags make up your environments.
.sp
See \fI\%here\fP for documentation on the
git_pillar configuration options and their usage.
.UNINDENT
.UNINDENT
.sp
Here is an example git_pillar configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- git:
    # Use \(aqprod\(aq instead of the branch name \(aqproduction\(aq as the environment
    \- production https://gitserver/git\-pillar.git:
      \- env: prod
    # Use \(aqdev\(aq instead of the branch name \(aqdevelop\(aq as the environment
    \- develop https://gitserver/git\-pillar.git:
      \- env: dev
    # No per\-remote config parameters (and no trailing colon), \(aqqa\(aq will
    # be used as the environment
    \- qa https://gitserver/git\-pillar.git
    # SSH key authentication
    \- master git@other\-git\-server:pillardata\-ssh.git:
      # Pillar SLS files will be read from the \(aqpillar\(aq subdirectory in
      # this repository
      \- root: pillar
      \- privkey: /path/to/key
      \- pubkey: /path/to/key.pub
      \- passphrase: CorrectHorseBatteryStaple
    # HTTPS authentication
    \- master https://other\-git\-server/pillardata\-https.git:
      \- user: git
      \- password: CorrectHorseBatteryStaple
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The main difference between this and the old way of configuring git_pillar is
that multiple remotes can be configured under one \fBgit\fP section under
\fI\%ext_pillar\fP\&. More than one \fBgit\fP section can be used, but it is
not necessary. Remotes will be evaluated sequentially.
.sp
Per\-remote configuration parameters are supported (similar to \fI\%gitfs\fP), and global versions of the git_pillar
configuration parameters can also be set.
.sp
To remap a specific branch to a specific Pillar environment, use the \fBenv\fP
per\-remote parameter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- git:
    \- production https://gitserver/git\-pillar.git:
      \- env: prod
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If \fB__env__\fP is specified as the branch name, then git_pillar will decide
which branch to use based on the following criteria:
.INDENT 0.0
.IP \(bu 2
If the minion has a \fI\%pillarenv\fP configured, it will use that
pillar environment. (2016.11.2 and later)
.IP \(bu 2
Otherwise, if the minion has an \fBenvironment\fP configured, it will use that
environment.
.IP \(bu 2
Otherwise, the master\(aqs \fI\%git_pillar_base\fP will be used.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The use of \fI\%environment\fP to choose the pillar environment
dates from a time before the \fI\%pillarenv\fP parameter was added.
In a future release, it will be ignored and either the minion\(aqs
\fI\%pillarenv\fP or the master\(aqs \fI\%git_pillar_base\fP
will be used.
.UNINDENT
.UNINDENT
.sp
Here\(aqs an example of using \fB__env__\fP as the git_pillar environment:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- git:
    \- __env__ https://gitserver/git\-pillar.git:
      \- root: pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The corresponding Pillar top file would look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(dq{{saltenv}}\(dq:
  \(aq*\(aq:
    \- bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With the addition of \fI\%pygit2\fP support, git_pillar can now interact with
authenticated remotes. Authentication works just like in gitfs (as outlined in
the \fI\%Git Fileserver Backend Walkthrough\fP), only
with the global authentication parameter names prefixed with \fBgit_pillar\fP
instead of \fBgitfs\fP (e.g. \fI\%git_pillar_pubkey\fP,
\fI\%git_pillar_privkey\fP, \fI\%git_pillar_passphrase\fP, etc.).
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBname\fP parameter can be used to further differentiate between two
remotes with the same URL and branch. When using two remotes with the same
URL, the \fBname\fP option is required.
.UNINDENT
.UNINDENT
.SS How Multiple Remotes Are Handled
.sp
As noted above, multiple remotes can be included in the same \fBgit\fP ext_pillar
configuration. Consider the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_etcd_config:
  etcd.host: 127.0.0.1
  etcd.port: 4001

ext_pillar:
  \- etcd: my_etcd_config
  \- git:
    \- master https://mydomain.tld/foo.git:
      \- root: pillar
    \- master https://mydomain.tld/bar.git
    \- master https://mydomain.tld/baz.git
    \- dev https://mydomain.tld/qux.git
  \- git:
    \- master https://mydomain.tld/abc.git
    \- dev https://mydomain.tld/123.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To understand how pillar data from these repos will be compiled, it\(aqs important
to know how Salt will process them. The following points should be kept in
mind:
.INDENT 0.0
.IP 1. 3
Each ext_pillar is called separately from the others. So, in the above
example, the \fBetcd\fP ext_pillar will be evaluated
first, with the first group of git_pillar remotes evaluated next (and merged
into the etcd pillar data). Lastly, the second group of git_pillar remotes
will be evaluated, and then merged into the ext_pillar data evaluated before
it.
.IP 2. 3
Within a single group of git_pillar remotes, each remote will be evaluated in
order, with results merged together as each remote is evaluated.
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
Prior to the 2017.7.0 release, remotes would be evaluated in a
non\-deterministic order.
.UNINDENT
.UNINDENT
.IP 3. 3
By default, when a repo is evaluated, other remotes\(aq which share its pillar
environment will have their files made available to the remote being
processed.
.UNINDENT
.sp
The first point should be straightforward enough, but the second and third
could use some additional clarification.
.sp
First, point #2. In the first group of git_pillar remotes, the top file and
pillar SLS files in the \fBfoo\fP remote will be evaluated first. The \fBbar\fP
remote will be evaluated next, and its results will be merged into the pillar
data compiled when the \fBfoo\fP remote was evaluated. As the subsequent remotes
are evaluated, their data will be merged in the same fashion.
.sp
But wait, don\(aqt these repositories belong to more than one pillar environments?
Well, yes. The default method of generating pillar data compiles pillar data
from all environments. This behavior can be overridden using a \fBpillarenv\fP\&.
Setting a \fI\%pillarenv\fP in the minion config file will make that
minion tell the master to ignore any pillar data from environments which don\(aqt
match that pillarenv. A pillarenv can also be specified for a given minion or
set of minions when \fI\%running states\fP, by using the
\fBpillarenv\fP argument. The CLI pillarenv will override one set in the minion
config file. So, assuming that a pillarenv of \fBbase\fP was set for a minion, it
would not get any of the pillar variables configured in the \fBqux\fP remote,
since that remote is assigned to the \fBdev\fP environment. The only way to get
its pillar data would be to specify a pillarenv of \fBdev\fP, which would mean
that it would then ignore any items from the \fBbase\fP pillarenv. A more
detailed explanation of pillar environments can be found \fI\%here\fP\&.
.sp
Moving on to point #3, and looking at the example ext_pillar configuration, as
the \fBfoo\fP remote is evaluated, it will also have access to the files from the
\fBbar\fP and \fBbaz\fP remotes, since all three are assigned to the \fBbase\fP
pillar environment. So, if an SLS file referenced by the \fBfoo\fP remotes\(aqs top
file does not exist in the \fBfoo\fP remote, it will be searched for in the
\fBbar\fP remote, followed by the \fBbaz\fP remote. When it comes time to evaluate
the \fBbar\fP remote, SLS files referenced by the \fBbar\fP remote\(aqs top file will
first be looked for in the \fBbar\fP remote, followed by \fBfoo\fP, and \fBbaz\fP,
and when the \fBbaz\fP remote is processed, SLS files will be looked for in
\fBbaz\fP, followed by \fBfoo\fP and \fBbar\fP\&. This \(dqfailover\(dq logic is called a
\fI\%directory overlay\fP, and it is also used by
\fI\%file_roots\fP and :conf_minion\(gapillar_roots\(ga. The ordering of which
remote is checked for SLS files is determined by the order they are listed.
First the remote being processed is checked, then the others that share the
same environment are checked. However, before the 2017.7.0 release, since
evaluation was unordered, the remote being processed would be checked, followed
in no specific order by the other repos which share the same environment.
.sp
Beginning with the 2017.7.0 release, this behavior of git_pillar remotes having
access to files in other repos which share the same environment can be disabled
by setting \fI\%git_pillar_includes\fP to \fBFalse\fP\&. If this is done,
then all git_pillar remotes will only have access to their own SLS files.
Another way of ensuring that a git_pillar remote will not have access to SLS
files from other git_pillar remotes which share the same pillar environment is
to put them in a separate \fBgit\fP section under \fBext_pillar\fP\&. Look again at
the example configuration above. In the second group of git_pillar remotes, the
\fBabc\fP remote would not have access to the SLS files from the \fBfoo\fP,
\fBbar\fP, and \fBbaz\fP remotes, and vice\-versa.
.SS Mountpoints
.sp
New in version 2017.7.0.

.sp
Assume the following pillar top file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqweb*\(aq:
    \- common
    \- web.server.nginx
    \- web.server.appdata
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now, assume that you would like to configure the \fBweb.server.nginx\fP and
\fBweb.server.appdata\fP SLS files in separate repos. This could be done using
the following ext_pillar configuration (assuming that
\fI\%git_pillar_includes\fP has not been set to \fBFalse\fP):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- git:
    \- master https://mydomain.tld/pillar\-common.git
    \- master https://mydomain.tld/pillar\-nginx.git
    \- master https://mydomain.tld/pillar\-appdata.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, in order to get the files in the second and third git_pillar remotes
to work, you would need to first create the directory structure underneath it
(i.e. place them underneath \fBweb/server/\fP in the repository). This also makes
it tedious to reorganize the configuration, as changing \fBweb.server.nginx\fP to
\fBweb.nginx\fP in the top file would require you to also move the SLS files in
the \fBpillar\-nginx\fP up a directory level.
.sp
For these reasons, much like gitfs, git_pillar now supports a \(dqmountpoint\(dq
feature. Using the following ext_pillar configuration, the SLS files in the
second and third git_pillar remotes can be placed in the root of the git
repository:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- git:
    \- master https://mydomain.tld/pillar\-common.git
    \- master https://mydomain.tld/pillar\-nginx.git:
      \- mountpoint: web/server/
    \- master https://mydomain.tld/pillar\-appdata.git:
      \- mountpoint: web/server/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now, if the top file changed the SLS target from \fBweb.server.nginx\fP, instead
of reorganizing the git repository, you would just need to adjust the
mountpoint to \fBweb/\fP (and restart the \fBsalt\-master\fP daemon).
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Leading and trailing slashes on the mountpoints are optional.
.IP \(bu 2
Use of the \fBmountpoint\fP feature requires that
\fI\%git_pillar_includes\fP is not disabled.
.IP \(bu 2
Content from mounted git_pillar repos can only be referenced by a top
file in the same pillar environment.
.IP \(bu 2
Salt versions prior to 2018.3.4 ignore the \fBroot\fP parameter when
\fBmountpoint\fP is set.
.UNINDENT
.UNINDENT
.UNINDENT
.SS all_saltenvs
.sp
New in version 2018.3.4.

.sp
When \fB__env__\fP is specified as the branch name, \fBall_saltenvs\fP per\-remote configuration parameter overrides the logic Salt uses to map branches/tags to pillar environments (i.e. pillarenvs). This allows a single branch/tag to appear in all saltenvs. Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- git:
    \- __env__ https://mydomain.tld/top.git
      \- all_saltenvs: master
    \- __env__ https://mydomain.tld/pillar\-nginx.git:
      \- mountpoint: web/server/
    \- __env__ https://mydomain.tld/pillar\-appdata.git:
      \- mountpoint: web/server/
.ft P
.fi
.UNINDENT
.UNINDENT
.SS git_pillar_update_interval
.sp
New in version 3000.

.sp
This option defines the default update interval (in seconds) for git_pillar
remotes. The update is handled within the global loop, hence
\fBgit_pillar_update_interval\fP should be a multiple of \fBloop_interval\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git_pillar_update_interval: 120
.ft P
.fi
.UNINDENT
.UNINDENT
.SS fallback
.sp
New in version 3001.

.sp
Setting \fBfallback\fP per\-remote or global configuration parameter will map non\-existing environments to a default branch. Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- git:
    \- __env__ https://mydomain.tld/top.git
      \- all_saltenvs: master
    \- __env__ https://mydomain.tld/pillar\-nginx.git:
      \- mountpoint: web/server/
      \- fallback: master
    \- __env__ https://mydomain.tld/pillar\-appdata.git:
      \- mountpoint: web/server/
      \- fallback: master
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.git_pillar.ext_pillar(minion_id, pillar, *repos)
Checkout the ext_pillar sources and compile the resulting pillar SLS
.UNINDENT
.SS salt.pillar.gpg
.sp
Decrypt pillar data through the builtin GPG renderer
.sp
In most cases, you\(aqll want to make this the last external pillar used. For
example, to pair with the builtin stack pillar you could do something like
this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- stack: /path/to/stack.cfg
  \- gpg: {}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Set \fBgpg_keydir\fP in your config to adjust the homedir the renderer uses.
.INDENT 0.0
.TP
.B salt.pillar.gpg.ext_pillar(minion_id, pillar, *args, **kwargs)
.UNINDENT
.SS salt.pillar.hg_pillar
.sp
Use remote Mercurial repository as a Pillar source.
.sp
New in version 2015.8.0.

.sp
The module depends on the \fBhglib\fP python module being available.
This is the same requirement as for hgfs_ so should not pose any extra
hurdles.
.sp
This external Pillar source can be configured in the master config file as such:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- hg: ssh://hg@example.co/user/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.pillar.hg_pillar.Repo(repo_uri)
Deal with remote hg (mercurial) repository for Pillar
.INDENT 7.0
.TP
.B close()
Cleanup mercurial command server
.UNINDENT
.INDENT 7.0
.TP
.B pull()
.UNINDENT
.INDENT 7.0
.TP
.B update(branch=\(aqdefault\(aq)
Ensure we are using the latest revision in the hg repository
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.hg_pillar.ext_pillar(minion_id, pillar, repo, branch=\(aqdefault\(aq, root=None)
Extract pillar from an hg repository
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.hg_pillar.update(repo_uri)
Execute an hg pull on all the repos
.UNINDENT
.SS salt.pillar.hiera
.sp
Use hiera data as a Pillar source
.INDENT 0.0
.TP
.B salt.pillar.hiera.ext_pillar(minion_id, pillar, conf)
Execute hiera and return the data
.UNINDENT
.SS salt.pillar.http_json
.sp
A module that adds data to the Pillar structure retrieved by an http request
.SS Configuring the HTTP_JSON ext_pillar
.sp
Set the following Salt config to setup http json result as external pillar source:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- http_json:
      url: http://example.com/api/minion_id
      namespace: \(aqsubkey\(aq
      username: username
      password: password
      header_dict: None
      auth: None
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can pass additional parameters, they will be added to the http.query call
\fI\%utils.http.query function\fP:
.sp
Changed in version 3006.0: If namespace is defined, the data will be added under the specified subkeys in the Pillar structure.

.sp
If the with_grains parameter is set, grain keys wrapped in can be provided (wrapped
in <> brackets) in the url in order to populate pillar data based on the grain value.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- http_json:
      url: http://example.com/api/<nodename>
      with_grains: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2018.3.0: If %s is present in the url, it will be automatically replaced by the minion_id:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- http_json:
      url: http://example.com/api/%s
.ft P
.fi
.UNINDENT
.UNINDENT

.SS Module Documentation
.INDENT 0.0
.TP
.B salt.pillar.http_json.ext_pillar(minion_id, pillar, url, with_grains=False, header_dict=None, auth=None, username=None, password=None, namespace=None)
Read pillar data from HTTP response.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fI\%str\fP) \-\- Url to request.
.IP \(bu 2
\fBwith_grains\fP (\fI\%bool\fP) \-\- Whether to substitute strings in the url with their grain values.
.IP \(bu 2
\fBheader_dict\fP (\fI\%dict\fP) \-\- Extra headers to send
.IP \(bu 2
\fBauth\fP \-\- special auth if needed
.IP \(bu 2
\fBusername\fP (\fI\%str\fP) \-\- username for auth
.IP \(bu 2
\fBpasword\fP (\fI\%str\fP) \-\- password for auth
.IP \(bu 2
\fBnamespace\fP (\fI\%str\fP) \-\- (Optional) A pillar key to namespace the values under.
\&.. versionadded:: 3006.0
.UNINDENT
.TP
.B Returns
A dictionary of the pillar data to add.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.UNINDENT
.SS salt.pillar.http_yaml
.sp
A module that adds data to the Pillar structure retrieved by an http request
.SS Configuring the HTTP_YAML ext_pillar
.sp
Set the following Salt config to setup an http endpoint as the external pillar source:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- http_yaml:
      url: http://example.com/api/minion_id
      username: username
      password: password
      header_dict: None
      auth: None
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can pass additional parameters, they will be added to the http.query call
\fI\%utils.http.query function\fP:
.sp
If the with_grains parameter is set, grain keys wrapped in can be provided (wrapped
in <> brackets) in the url in order to populate pillar data based on the grain value.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- http_yaml:
      url: http://example.com/api/<nodename>
      with_grains: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2018.3.0: If %s is present in the url, it will be automatically replaced by the minion_id:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- http_json:
      url: http://example.com/api/%s
.ft P
.fi
.UNINDENT
.UNINDENT

.SS Module Documentation
.INDENT 0.0
.TP
.B salt.pillar.http_yaml.ext_pillar(minion_id, pillar, url, with_grains=False, header_dict=None, auth=None, username=None, password=None)
Read pillar data from HTTP response.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fI\%str\fP) \-\- Url to request.
.IP \(bu 2
\fBwith_grains\fP (\fI\%bool\fP) \-\- Whether to substitute strings in the url with their grain values.
.IP \(bu 2
\fBheader_dict\fP (\fI\%dict\fP) \-\- Extra headers to send
.IP \(bu 2
\fBusername\fP (\fI\%str\fP) \-\- username for auth
.IP \(bu 2
\fBpasword\fP (\fI\%str\fP) \-\- password for auth
.IP \(bu 2
\fBauth\fP \-\- special auth if needed
.UNINDENT
.TP
.B Returns
A dictionary of the pillar data to add.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.UNINDENT
.SS salt.pillar.libvirt
.sp
Load up the libvirt keys into Pillar for a given minion if said keys have been
generated using the libvirt key runner
.INDENT 0.0
.TP
.B depends
certtool
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.libvirt.ext_pillar(minion_id, pillar, command)
Read in the generated libvirt keys
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.libvirt.gen_hyper_keys(minion_id, country=\(aqUS\(aq, state=\(aqUtah\(aq, locality=\(aqSalt Lake City\(aq, organization=\(aqSalted\(aq, expiration_days=\(aq365\(aq)
Generate the keys to be used by libvirt hypervisors, this routine gens
the keys and applies them to the pillar for the hypervisor minions
.UNINDENT
.SS salt.pillar.makostack
.sp
Simple and flexible YAML ext_pillar which can read pillar from within pillar.
.sp
New in version 2016.3.0.

.sp
This custom saltstack \fBext_pillar\fP is a direct ripoff of the \(aqstack\(aq
ext_pillar, simply ported to use mako instead of jinja2 for templating.
.sp
It supports the following features:
.INDENT 0.0
.IP \(bu 2
multiple config files that are mako templates with support for \fBpillar\fP,
\fB__grains__\fP, \fB__salt__\fP, \fB__opts__\fP objects.
.IP \(bu 2
a config file renders as an ordered list of files. Unless absolute, the paths
of these files are relative to the current config file \- if absolute, they
will be treated literally.
.IP \(bu 2
this list of files are read in order as mako templates with support for
\fBstack\fP, \fBpillar\fP, \fB__grains__\fP, \fB__salt__\fP, \fB__opts__\fP objects.
.IP \(bu 2
all these rendered files are then parsed as \fByaml\fP\&.
.IP \(bu 2
then all yaml dicts are merged in order, with support for the following.
merging strategies: \fBmerge\-first\fP, \fBmerge\-last\fP, \fBremove\fP, and
\fBoverwrite\fP\&.
.IP \(bu 2
stack config files can be matched based on \fBpillar\fP, \fBgrains\fP, or
\fBopts\fP values, which make it possible to support kind of self\-contained
environments.
.UNINDENT
.SS Configuration in Salt
.sp
Like any other external pillar, its configuration takes place through the
\fBext_pillar\fP key in the master config file.
.sp
However, you can configure MakoStack in 3 different ways:
.SS Single config file
.sp
This is the simplest option, you just need to set the path to your single
MakoStack config file like below:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- makostack: /path/to/stack.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.SS List of config files
.sp
You can also provide a list of config files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- makostack:
      \- /path/to/stack1.cfg
      \- /path/to/stack2.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Select config files through grains|pillar|opts matching
.sp
You can also opt for a much more flexible configuration: MakoStack allows one to
select the config files for the current minion based on matching values from
either grains, or pillar, or opts objects.
.sp
Here is an example of such a configuration, which should speak by itself:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- makostack:
      pillar:environment:
        dev: /path/to/dev/stack.cfg
        prod: /path/to/prod/stack.cfg
      grains:custom:grain:
        value:
          \- /path/to/stack1.cfg
          \- /path/to/stack2.cfg
      opts:custom:opt:
        value: /path/to/stack0.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Grafting data from files to arbitrary namespaces
.sp
An extended syntax for config files permits defining \(dqgraft points\(dq on a
per\-config\-file basis.  As an example, if the file foo.cfg would produce
the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  \- bar
  \- baz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
and you specified the cfg file as /path/to/foo.cfg:yummy:fur, the following
would actually end up in pillar after all merging was complete:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
yummy:
  fur:
    foo:
      \- bar
      \- baz
.ft P
.fi
.UNINDENT
.UNINDENT
.SS MakoStack configuration files
.sp
The config files that are referenced in the above \fBext_pillar\fP configuration
are mako templates which must render as a simple ordered list of \fByaml\fP
files that will then be merged to build pillar data.
.sp
Unless an absolute path name is specified, the path of these \fByaml\fP files is
assumed to be relative to the directory containing the MakoStack config file.
If a path begins with \(aq/\(aq, however, it will be treated literally and can be
anywhere on the filesystem.
.sp
The following variables are available in mako templating of makostack
configuration files:
.INDENT 0.0
.IP \(bu 2
\fBpillar\fP: the pillar data (as passed by Salt to our \fBext_pillar\fP
function)
.IP \(bu 2
\fBminion_id\fP: the minion id ;\-)
.IP \(bu 2
\fB__opts__\fP: a dictionary of mostly Salt configuration options
.IP \(bu 2
\fB__grains__\fP: a dictionary of the grains of the minion making this pillar
call
.IP \(bu 2
\fB__salt__\fP: a dictionary of Salt module functions, useful so you don\(aqt have
to duplicate functions that already exist (note: runs on the master)
.UNINDENT
.sp
So you can use all the power of mako to build your list of \fByaml\fP files
that will be merged in pillar data.
.sp
For example, you could have a MakoStack config file which looks like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ cat /path/to/stack/config.cfg
core.yml
osarchs/%{ __grains__[\(aqosarch\(aq] }}.yml
oscodenames/%{ __grains__[\(aqoscodename\(aq] }.yml
% for role in pillar.get(\(aqroles\(aq, []):
roles/%{ role }.yml
% endfor
minions/%{ minion_id }.yml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And the whole directory structure could look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ tree /path/to/stack/
/path/to/stack/
├── config.cfg
├── core.yml
├── osarchs/
│\ \  ├── amd64.yml
│\ \  └── armhf.yml
├── oscodenames/
│\ \  ├── wheezy.yml
│\ \  └── jessie.yml
├── roles/
│\ \  ├── web.yml
│\ \  └── db.yml
└── minions/
    ├── test\-1\-dev.yml
    └── test\-2\-dev.yml
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Overall process
.sp
In the above MakoStack configuration, given that test\-1\-dev minion is an
amd64 platform running Debian Jessie, and which pillar \fBroles\fP is \fB[\(dqdb\(dq]\fP,
the following \fByaml\fP files would be merged in order:
.INDENT 0.0
.IP \(bu 2
\fBcore.yml\fP
.IP \(bu 2
\fBosarchs/amd64.yml\fP
.IP \(bu 2
\fBoscodenames/jessie.yml\fP
.IP \(bu 2
\fBroles/db.yml\fP
.IP \(bu 2
\fBminions/test\-1\-dev.yml\fP
.UNINDENT
.sp
Before merging, every files above will be preprocessed as mako templates.
The following variables are available in mako templating of \fByaml\fP files:
.INDENT 0.0
.IP \(bu 2
\fBstack\fP: the MakoStack pillar data object that has currently been merged
(data from previous \fByaml\fP files in MakoStack configuration)
.IP \(bu 2
\fBpillar\fP: the pillar data (as passed by Salt to our \fBext_pillar\fP
function)
.IP \(bu 2
\fBminion_id\fP: the minion id ;\-)
.IP \(bu 2
\fB__opts__\fP: a dictionary of mostly Salt configuration options
.IP \(bu 2
\fB__grains__\fP: a dictionary of the grains of the minion making this pillar
call
.IP \(bu 2
\fB__salt__\fP: a dictionary of Salt module functions, useful so you don\(aqt have
to duplicate functions that already exist (note: runs on the master)
.UNINDENT
.sp
So you can use all the power of mako to build your pillar data, and even use
other pillar values that has already been merged by MakoStack (from previous
\fByaml\fP files in MakoStack configuration) through the \fBstack\fP variable.
.sp
Once a \fByaml\fP file has been preprocessed by mako, we obtain a Python dict \-
let\(aqs call it \fByml_data\fP \- then, MakoStack will merge this \fByml_data\fP
dict in the main \fBstack\fP dict (which contains already merged MakoStack
pillar data).
By default, MakoStack will deeply merge \fByml_data\fP in \fBstack\fP (similarly
to the \fBrecurse\fP salt \fBpillar_source_merging_strategy\fP), but 3 merging
strategies are currently available for you to choose (see next section).
.sp
Once every \fByaml\fP files have been processed, the \fBstack\fP dict will contain
your whole own pillar data, merged in order by MakoStack.
So MakoStack \fBext_pillar\fP returns the \fBstack\fP dict, the contents of which
Salt takes care to merge in with all of the other pillars and finally return
the whole pillar to the minion.
.SS Merging strategies
.sp
The way the data from a new \fByaml_data\fP dict is merged with the existing
\fBstack\fP data can be controlled by specifying a merging strategy. Right now
this strategy can either be \fBmerge\-last\fP (the default), \fBmerge\-first\fP,
\fBremove\fP, or \fBoverwrite\fP\&.
.sp
Note that scalar values like strings, integers, booleans, etc. are always
evaluated using the \fBoverwrite\fP strategy (other strategies don\(aqt make sense
in that case).
.sp
The merging strategy can be set by including a dict in the form of:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__: <merging strategy>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
as the first item of the dict or list.
This allows fine grained control over the merging process.
.SS \fBmerge\-last\fP (default) strategy
.sp
If the \fBmerge\-last\fP strategy is selected (the default), then content of dict
or list variables is merged recursively with previous definitions of this
variable (similarly to the \fBrecurse\fP salt
\fBpillar_source_merging_strategy\fP).
This allows for extending previously defined data.
.SS \fBmerge\-first\fP strategy
.sp
If the \fBmerge\-first\fP strategy is selected, then the content of dict or list
variables are swapped between the \fByaml_data\fP and \fBstack\fP objects before
being merged recursively with the \fBmerge\-last\fP previous strategy.
.SS \fBremove\fP strategy
.sp
If the \fBremove\fP strategy is selected, then content of dict or list variables
in \fBstack\fP are removed only if the corresponding item is present in the
\fByaml_data\fP dict.
This allows for removing items from previously defined data.
.SS \fBoverwrite\fP strategy
.sp
If the \fBoverwrite\fP strategy is selected, then the content of dict or list
variables in \fBstack\fP is overwritten by the content of \fByaml_data\fP dict.
So this allows one to overwrite variables from previous definitions.
.SS Merging examples
.sp
Let\(aqs go through small examples that should clarify what\(aqs going on when a
\fByaml_data\fP dict is merged in the \fBstack\fP dict.
.sp
When you don\(aqt specify any strategy, the default \fBmerge\-last\fP strategy is
selected:
.TS
center;
|l|l|l|.
_
T{
\fBstack\fP
T}	T{
\fByaml_data\fP
T}	T{
\fBstack\fP (after merge)
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 500
    roles:
      \- sysadmin
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 1000
    roles:
      \- developer
  mat:
    uid: 1001
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 1000
    roles:
      \- sysadmin
      \- developer
  mat:
    uid: 1001
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
.TE
.sp
Then you can select a custom merging strategy using the \fB__\fP key in a dict:
.TS
center;
|l|l|l|.
_
T{
\fBstack\fP
T}	T{
\fByaml_data\fP
T}	T{
\fBstack\fP (after merge)
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 500
    roles:
      \- sysadmin
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  __: merge\-last
  tom:
    uid: 1000
    roles:
      \- developer
  mat:
    uid: 1001
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 1000
    roles:
      \- sysadmin
      \- developer
  mat:
    uid: 1001
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 500
    roles:
      \- sysadmin
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  __: merge\-first
  tom:
    uid: 1000
    roles:
      \- developer
  mat:
    uid: 1001
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 500
    roles:
      \- developer
      \- sysadmin
  mat:
    uid: 1001
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 500
    roles:
      \- sysadmin
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  __: remove
  tom:
  mat:
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 500
    roles:
      \- sysadmin
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  __: overwrite
  tom:
    uid: 1000
    roles:
      \- developer
  mat:
    uid: 1001
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 1000
    roles:
      \- developer
  mat:
    uid: 1001
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
.TE
.sp
You can also select a custom merging strategy using a \fB__\fP object in a list:
.TS
center;
|l|l|l|.
_
T{
\fBstack\fP
T}	T{
\fByaml_data\fP
T}	T{
\fBstack\fP (after merge)
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- tom
  \- root
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- __: merge\-last
  \- mat
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- tom
  \- root
  \- mat
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- tom
  \- root
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- __: merge\-first
  \- mat
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- mat
  \- tom
  \- root
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- tom
  \- root
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- __: remove
  \- mat
  \- tom
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- root
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- tom
  \- root
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- __: overwrite
  \- mat
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- mat
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
.TE
.INDENT 0.0
.TP
.B salt.pillar.makostack.ext_pillar(minion_id, pillar, *args, **kwargs)
.UNINDENT
.SS salt.pillar.mongo
.sp
Read Pillar data from a mongodb collection
.INDENT 0.0
.TP
.B depends
pymongo (for salt\-master)
.UNINDENT
.sp
This module will load a node\-specific pillar dictionary from a mongo
collection. It uses the node\(aqs id for lookups and can load either the whole
document, or just a specific field from that
document as the pillar dictionary.
.SS Salt Master Mongo Configuration
.sp
The module shares the same base mongo connection variables as
\fI\%salt.returners.mongo_future_return\fP\&. These variables go in your master
config file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mongo.db: <database name>
mongo.host: <server ip address>
mongo.user: <MongoDB username>
mongo.password: <MongoDB user password>
mongo.port: 27017
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or single URI:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mongo.uri: URI
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
where uri is in the format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mongodb://db1.example.net:27017/mydatabase
mongodb://db1.example.net:27017,db2.example.net:2500/?replicaSet=test
mongodb://db1.example.net:27017,db2.example.net:2500/?replicaSet=test&connectTimeoutMS=300000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
More information on URI format can be found in
\fI\%https://docs.mongodb.com/manual/reference/connection\-string/\fP
.SS Configuring the Mongo ext_pillar
.sp
The Mongo ext_pillar takes advantage of the fact that the Salt Master
configuration file is yaml. It uses a sub\-dictionary of values to adjust
specific features of the pillar. This is the explicit single\-line dictionary
notation for yaml. One may be able to get the easier\-to\-read multi\-line dict to
work correctly with some experimentation.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- mongo: {collection: vm, id_field: name, re_pattern: \e.example\e.com, fields: [customer_id, software, apache_vhosts]}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the example above, we\(aqve decided to use the \fBvm\fP collection in the
database to store the data. Minion ids are stored in the \fBname\fP field on
documents in that collection. And, since minion ids are FQDNs in most cases,
we\(aqll need to trim the domain name in order to find the minion by hostname in
the collection. When we find a minion, return only the \fBcustomer_id\fP,
\fBsoftware\fP, and \fBapache_vhosts\fP fields, as that will contain the data we
want for a given node. They will be available directly inside the \fBpillar\fP
dict in your SLS templates.
.SS Module Documentation
.INDENT 0.0
.TP
.B salt.pillar.mongo.ext_pillar(minion_id, pillar, collection=\(aqpillar\(aq, id_field=\(aq_id\(aq, re_pattern=None, re_replace=\(aq\(aq, fields=None)
Connect to a mongo database and read per\-node pillar information.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcollection\fP (\fI*\fP) \-\- The mongodb collection to read data from. Defaults to
\fB\(aqpillar\(aq\fP\&.
.IP \(bu 2
\fBid_field\fP (\fI*\fP) \-\- The field in the collection that represents an individual
minion id. Defaults to \fB\(aq_id\(aq\fP\&.
.IP \(bu 2
\fBre_pattern\fP (\fI*\fP) \-\- If your naming convention in the collection is shorter
than the minion id, you can use this to trim the name.
\fIre_pattern\fP will be used to match the name, and \fIre_replace\fP will
be used to replace it. Backrefs are supported as they are in the
Python standard library. If \fBNone\fP, no mangling of the name will
be performed \- the collection will be searched with the entire
minion id. Defaults to \fBNone\fP\&.
.IP \(bu 2
\fBre_replace\fP (\fI*\fP) \-\- Use as the replacement value in node ids matched with
\fIre_pattern\fP\&. Defaults to \(aq\(aq. Feel free to use backreferences here.
.IP \(bu 2
\fBfields\fP (\fI*\fP) \-\- The specific fields in the document to use for the pillar
data. If \fBNone\fP, will use the entire document. If using the
entire document, the \fB_id\fP field will be converted to string. Be
careful with other fields in the document as they must be string
serializable. Defaults to \fBNone\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.pillar.mysql
.sp
Retrieve Pillar data by doing a MySQL query
.sp
MariaDB provides Python support through the MySQL Python package.
Therefore, you may use this module with both MySQL or MariaDB.
.sp
This module is a concrete implementation of the sql_base ext_pillar for MySQL.
.INDENT 0.0
.TP
.B maturity
new
.TP
.B depends
python\-mysqldb
.TP
.B platform
all
.UNINDENT
.SS Configuring the mysql ext_pillar
.sp
Use the \(aqmysql\(aq key under ext_pillar for configuration of queries.
.sp
MySQL configuration of the MySQL returner is being used (mysql.db, mysql.user,
mysql.pass, mysql.port, mysql.host) for database connection info.
.sp
Required python modules: MySQLdb
.SS Complete example
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql:
  user: \(aqsalt\(aq
  pass: \(aqsuper_secret_password\(aq
  db: \(aqsalt_db\(aq
  port: 3306
  ssl:
    cert: /etc/mysql/client\-cert.pem
    key: /etc/mysql/client\-key.pem

ext_pillar:
  \- mysql:
      fromdb:
        query: \(aqSELECT col1,col2,col3,col4,col5,col6,col7
                  FROM some_random_table
                 WHERE minion_pattern LIKE %s\(aq
        depth: 5
        as_list: True
        with_lists: [1,3]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.pillar.mysql.MySQLExtPillar
This class receives and processes the database rows from MySQL.
.INDENT 7.0
.TP
.B extract_queries(args, kwargs)
This function normalizes the config block into a set of queries we
can use.  The return is a list of consistently laid out dicts.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.mysql.ext_pillar(minion_id, pillar, *args, **kwargs)
Execute queries against MySQL, merge and return as a dict
.UNINDENT
.SS salt.pillar.nacl
.sp
Decrypt pillar data through the builtin NACL renderer
.sp
In most cases, you\(aqll want to make this the last external pillar used. For
example, to pair with the builtin stack pillar you could do something like
this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nacl.config:
    keyfile: /root/.nacl

ext_pillar:
  \- stack: /path/to/stack.cfg
  \- nacl: {}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Set \fBnacl.config\fP in your config.
.INDENT 0.0
.TP
.B salt.pillar.nacl.ext_pillar(minion_id, pillar, *args, **kwargs)
.UNINDENT
.SS salt.pillar.netbox
.sp
A module that adds data to the Pillar structure from a NetBox API.
.sp
New in version 2019.2.0.

.SS Configuring the NetBox ext_pillar
.sp
To use this pillar, you must first create a token in your NetBox instance at
\fI\%http://netbox.example.com/user/api\-tokens/\fP (substituting the hostname of your
NetBox instance)
.sp
The NetBox api_url and api_token must be set in the master
config.
.sp
For example \fB/etc/salt/master.d/netbox.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- netbox:
      api_url: http://netbox.example.com/api/
      api_token: 123abc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following options are optional, and determine whether or not
the module will attempt to configure the \fBproxy\fP pillar data for
use with the napalm proxy\-minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy_return: True
proxy_username: admin
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default, this module will query the NetBox API for the platform
associated with the device, and use the \(aqNAPALM driver\(aq field to
set the napalm proxy\-minion driver. (Currently only \(aqnapalm\(aq is supported
for drivertype.)
.sp
This module currently only supports the napalm proxy minion and assumes
you will use SSH keys to authenticate to the network device.  If password
authentication is desired, it is recommended to create another \fBproxy\fP
key in pillar_roots (or git_pillar) with just the \fBpasswd\fP key and use
\fI\%salt.renderers.gpg\fP to encrypt the value.
.sp
If you use more than one username for your devices, leave proxy_username unset,
and set the \fBusername\fP key in your pillar as well. If any additional options
for the proxy setup are needed, they should also be configured in pillar_roots.
.sp
Other available configuration options:
.INDENT 0.0
.TP
.B site_details: \fBTrue\fP
Whether should retrieve details of the site the device belongs to.
.TP
.B site_prefixes: \fBTrue\fP
Whether should retrieve the prefixes of the site the device belongs to.
.TP
.B devices: \fBTrue\fP
New in version 3004.

.sp
Whether should retrieve physical devices.
.TP
.B virtual_machines: \fBFalse\fP
New in version 3004.

.sp
Whether should retrieve virtual machines.
.TP
.B interfaces: \fBFalse\fP
New in version 3004.

.sp
Whether should retrieve the interfaces of the device.
.TP
.B interface_ips: \fBFalse\fP
New in version 3004.

.sp
Whether should retrieve the IP addresses for interfaces of the device.
(interfaces must be set to True as well)
.TP
.B api_query_result_limit: \fBUse NetBox default\fP
New in version 3004.

.sp
An integer specifying how many results should be returned for each query
to the NetBox API. Leaving this unset will use NetBox\(aqs default value.
.TP
.B connected_devices: \fBFalse\fP
New in version 3006.0.

.sp
Whether connected_devices key should be populated with device objects.
If set to True it will force \fIinterfaces\fP to also be true as a dependency
.UNINDENT
.sp
Note that each option you enable can have a detrimental impact on pillar
performance, so use them with caution.
.sp
After configuring the pillar, you must restart the Salt master for the changes
to take effect.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
systemctl restart salt\-master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To query perform a quick test of the pillar, you should refresh the pillar on
the minion with the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion1 saltutil.refresh_pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And then query the pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion1 pillar.items \(aqnetbox\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minion1:
    netbox:
        \-\-\-\-\-\-\-\-\-\-
        id:
            511
        url:
            https://netbox.example.com/api/dcim/devices/511/
        name:
            minion1
        node_type:
            device
        display_name:
            minion1
        device_type:
            \-\-\-\-\-\-\-\-\-\-
            id:
                4
            url:
                https://netbox.example.com/api/dcim/device\-types/4/
            manufacturer:
                \-\-\-\-\-\-\-\-\-\-
                id:
                    1
                url:
                    https://netbox.example.com/api/dcim/manufacturers/1/
                name:
                    Cisco
                slug:
                    cisco
            model:
                ISR2901
            slug:
                isr2901
            display_name:
                Cisco ISR2901
        device_role:
            \-\-\-\-\-\-\-\-\-\-
            id:
                45
            url:
                https://netbox.example.com/api/dcim/device\-roles/45/
            name:
                Network
            slug:
                network
        interfaces:
            |_
              \-\-\-\-\-\-\-\-\-\-
              id:
                  8158
              ip_addresses:
                  |_
                    \-\-\-\-\-\-\-\-\-\-
                    id:
                        1146
                    url:
                        https://netbox.example.com/api/ipam/ip\-addresses/1146/
                    family:
                        \-\-\-\-\-\-\-\-\-\-
                        value:
                            4
                        label:
                            IPv4
                    address:
                        192.0.2.1/24
                    vrf:
                        None
                    tenant:
                        None
                    status:
                        \-\-\-\-\-\-\-\-\-\-
                        value:
                            active
                         label:
                            Active
                    role:
                        None
                    nat_inside:
                        None
                    nat_outside:
                        None
                    dns_name:
                    description:
                    tags:
                    custom_fields:
                    created:
                        2021\-02\-19
                    last_updated:
                        2021\-02\-19T06:12:04.153386Z
              url:
                  https://netbox.example.com/api/dcim/interfaces/8158/
              name:
                  GigabitEthernet0/0
              label:
              type:
                  \-\-\-\-\-\-\-\-\-\-
                  value:
                      1000base\-t
                  label:
                      1000BASE\-T (1GE)
              enabled:
                  True
              lag:
                  None
              mtu:
                  None
              mac_address:
                  None
              mgmt_only:
                  False
              description:
              mode:
                  None
              untagged_vlan:
                  None
              tagged_vlans:
              cable:
                  None
              cable_peer:
                  None
              cable_peer_type:
                  None
              connected_endpoint:
                  None
              connected_endpoint_type:
                  None
              connected_endpoint_reachable:
                  None
              tags:
              count_ipaddresses:
                  1
            |_
              \-\-\-\-\-\-\-\-\-\-
              id:
                  8159
              ip_addresses:
                  |_
                    \-\-\-\-\-\-\-\-\-\-
                    id:
                        1147
                    url:
                        https://netbox.example.com/api/ipam/ip\-addresses/1147/
                    family:
                        \-\-\-\-\-\-\-\-\-\-
                        value:
                            4
                        label:
                            IPv4
                    address:
                        198.51.100.1/24
                    vrf:
                        None
                    tenant:
                        None
                    status:
                        \-\-\-\-\-\-\-\-\-\-
                        value:
                            active
                        label:
                            Active
                    role:
                        None
                    nat_inside:
                        None
                    nat_outside:
                        None
                    dns_name:
                    description:
                    tags:
                    custom_fields:
                    created:
                        2021\-02\-19
                    last_updated:
                        2021\-02\-19T06:12:40.508154Z
                    url:
                        https://netbox.example.com/api/dcim/interfaces/8159/
                    name:
                        GigabitEthernet0/1
                    label:
                    type:
                        \-\-\-\-\-\-\-\-\-\-
                        value:
                            1000base\-t
                        label:
                            1000BASE\-T (1GE)
                    enabled:
                        True
                    lag:
                        None
                    mtu:
                        None
                    mac_address:
                        None
                    mgmt_only:
                        False
                    description:
                    mode:
                        None
                    untagged_vlan:
                        None
                    tagged_vlans:
                    cable:
                        None
                    cable_peer:
                        None
                    cable_peer_type:
                        None
                    connected_endpoint:
                        None
                    connected_endpoint_type:
                        None
                    connected_endpoint_reachable:
                        None
                    tags:
                    count_ipaddresses:
                        1
        tenant:
            None
        platform:
            \-\-\-\-\-\-\-\-\-\-
            id:
                1
            url:
                https://netbox.example.com/api/dcim/platforms/1/
            name:
                Cisco IOS
            slug:
                ios
        serial:
        asset_tag:
            None
        site:
            \-\-\-\-\-\-\-\-\-\-
            id:
                18
            url:
                https://netbox.example.com/api/dcim/sites/18/
            name:
                Site 1
            slug:
                site1
            status:
                \-\-\-\-\-\-\-\-\-\-
                value:
                    active
                label:
                    Active
            region:
                None
            tenant:
                None
            facility:
            asn:
                None
            time_zone:
                None
            description:
            physical_address:
            shipping_address:
            latitude:
                None
            longitude:
                None
            contact_name:
            contact_phone:
            contact_email:
            comments:
            tags:
            custom_fields:
            created:
                2021\-02\-25
            last_updated:
                2021\-02\-25T14:21:07.898957Z
            circuit_count:
                0
            device_count:
                1
            prefix_count:
                2
            rack_count:
                0
            virtualmachine_count:
                1
            vlan_count:
                0
            prefixes:
                |_
                  \-\-\-\-\-\-\-\-\-\-
                  id:
                      284
                  url:
                      https://netbox.example.com/api/ipam/prefixes/284/
                  family:
                      \-\-\-\-\-\-\-\-\-\-
                      value:
                          4
                      label:
                          IPv4
                  prefix:
                      192.0.2.0/24
                  vrf:
                      None
                  tenant:
                      None
                  vlan:
                      None
                        \-\-\-\-\-\-\-\-\-\-
                      value:
                          active
                      label:
                          Active
                  role:
                      None
                  is_pool:
                      False
                  description:
                  tags:
                  custom_fields:
                  created:
                      2021\-02\-25
                  last_updated:
                      2021\-02\-25T15:08:27.136305Z
                |_
                  \-\-\-\-\-\-\-\-\-\-
                  id:
                      285
                  url:
                      https://netbox.example.com/api/ipam/prefixes/285/
                  family:
                      \-\-\-\-\-\-\-\-\-\-
                      value:
                          4
                      label:
                          IPv4
                  prefix:
                      198.51.100.0/24
                  vrf:
                      None
                  tenant:
                      None
                  vlan:
                      None
                  status:
                      \-\-\-\-\-\-\-\-\-\-
                      value:
                          active
                      label:
                          Active
                  role:
                      None
                  is_pool:
                      False
                  description:
                  tags:
                  custom_fields:
                  created:
                      2021\-02\-25
                  last_updated:
                      2021\-02\-25T15:08:59.880440Z
        rack:
            None
        position:
            None
        face:
            None
        parent_device:
            None
        status:
            \-\-\-\-\-\-\-\-\-\-
            value:
                active
            label:
                Active
        primary_ip:
            \-\-\-\-\-\-\-\-\-\-
            id:
                1146
            url:
                https://netbox.example.com/api/ipam/ip\-addresses/1146/
            family:
                4
            address:
                192.0.2.1/24
        primary_ip4:
            \-\-\-\-\-\-\-\-\-\-
            id:
                1146
            url:
                https://netbox.example.com/api/ipam/ip\-addresses/1146/
            family:
                4
            address:
                192.0.2.1/24
        primary_ip6:
            None
        cluster:
            None
        virtual_chassis:
            None
        vc_position:
            None
        vc_priority:
            None
        comments:
        local_context_data:
            None
        tags:
        custom_fields:
        config_context:
        connected_devices:
      \-\-\-\-\-\-\-\-\-\-
      512:
          \-\-\-\-\-\-\-\-\-\-
          airflow:
              None
          asset_tag:
              001
          cluster:
              None
          comments:
          config_context:
          created:
              2022\-03\-10T00:00:00Z
          custom_fields:
          device_role:
              \-\-\-\-\-\-\-\-\-\-
              display:
                  Network switch
              id:
                  512
              name:
                  Network switch
              slug:
                  network_switch
              url:
                  https://netbox.example.com/api/dcim/device\-roles/5/
          device_type:
              \-\-\-\-\-\-\-\-\-\-
              display:
                  Nexus 3048
              id:
                  40
              manufacturer:
                  \-\-\-\-\-\-\-\-\-\-
                  display:
                      Cisco
                  id:
                      1
                  name:
                      Cisco
                  slug:
                      cisco
                  url:
                      https://netbox.example.com/api/dcim/manufacturers/1/
              model:
                  Nexus 3048
              slug:
                  n3k\-c3048tp\-1ge
              url:
                  https://netbox.example.com/api/dcim/device\-types/40/
          display:
              another device (001)
          face:
              \-\-\-\-\-\-\-\-\-\-
              label:
                  Front
              value:
                  front
          id:
              1533
          last_updated:
              2022\-08\-22T13:50:15.923868Z
          local_context_data:
              None
          location:
              \-\-\-\-\-\-\-\-\-\-
              _depth:
                  2
              display:
                  Location Name
              id:
                  2
              name:
                  Location Name
              slug:
                  location\-name
              url:
                  https://netbox.example.com/api/dcim/locations/2
          name:
              another device
          parent_device:
              None
          platform:
              None
          position:
              18.0
          primary_ip:
              \-\-\-\-\-\-\-\-\-\-
              address:
                  192.168.1.1/24
              display:
                  192.168.1.1/24
              family:
                  4
              id:
                  1234
              url:
                  https://netbox.example.com/api/ipam/ip\-addresses/1234/
          primary_ip4:
              \-\-\-\-\-\-\-\-\-\-
              address:
                  192.168.1.1/24
              display:
                  192.168.1.1/24
              family:
                  4
              id:
                  1234
              url:
                  https://netbox.example.com/api/ipam/ip\-addresses/1234/
          primary_ip6:
              None
          rack:
              \-\-\-\-\-\-\-\-\-\-
              display:
                  RackName
              id:
                  139
              name:
                  RackName
              url:
                  https://netbox.example.com/api/dcim/racks/139/
          serial:
              ABCD12345
          site:
              \-\-\-\-\-\-\-\-\-\-
              display:
                  SiteName
              id:
                  2
              name:
                  SiteName
              slug:
                  sitename
              url:
                  https://netbox.example.com/api/dcim/sites/2/
          status:
              \-\-\-\-\-\-\-\-\-\-
              label:
                  Active
              value:
                  active
          tags:
          tenant:
              None
          url:
              https://netbox.example.com/api/dcim/devices/1533/
          vc_position:
              None
          vc_priority:
              None
          virtual_chassis:
              None
        created:
            2021\-02\-19
        last_updated:
            2021\-02\-19T06:12:04.171105Z
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.netbox.ext_pillar(minion_id, pillar, *args, **kwargs)
Query NetBox API for minion data
.UNINDENT
.SS salt.pillar.neutron
.sp
Use Openstack Neutron data as a Pillar source. Will list all networks listed
inside of Neutron, to all minions.
.sp
New in version 2015.5.1.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
python\-neutronclient
.UNINDENT
.UNINDENT
.sp
A keystone profile must be used for the pillar to work (no generic keystone
configuration here). For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my openstack_config:
  keystone.user: \(aqadmin\(aq
  keystone.password: \(aqpassword\(aq
  keystone.tenant: \(aqadmin\(aq
  keystone.auth_url: \(aqhttp://127.0.0.1:5000/v2.0/\(aq
  keystone.region_name: \(aqRegionOne\(aq
  keystone.service_type: \(aqnetwork\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
After the profile is created, configure the external pillar system to use it.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- neutron: my_openstack_config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using these configuration profiles, multiple neutron sources may also be used:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- neutron: my_openstack_config
  \- neutron: my_other_openstack_config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default, these networks will be returned as a pillar item called
\fBnetworks\fP\&. In order to have them returned under a different name, add the
name after the Keystone profile name:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B ext_pillar:
.INDENT 7.0
.IP \(bu 2
neutron: my_openstack_config neutron_networks
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.neutron.ext_pillar(minion_id, pillar, conf)
Check neutron for all data
.UNINDENT
.SS salt.pillar.nodegroups
.SS Nodegroups Pillar
.sp
Introspection: to which nodegroups does my minion belong?
Provides a pillar with the default name of \fInodegroups\fP
which contains a list of nodegroups which match for a given minion.
.sp
New in version 2016.11.0.

.SS Command Line
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call pillar.get nodegroups
local:
    \- class_infra
    \- colo_sj
    \- state_active
    \- country_US
    \- type_saltmaster
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configuring Nodegroups Pillar
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
extension_modules: /srv/salt/ext
ext_pillar:
  \- nodegroups:
      pillar_name: \(aqnodegroups\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.nodegroups.ext_pillar(minion_id, pillar, pillar_name=None)
A salt external pillar which provides the list of nodegroups of which the minion is a member.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBminion_id\fP \-\- used for compound matching nodegroups
.IP \(bu 2
\fBpillar\fP \-\- provided by salt, but not used by nodegroups ext_pillar
.IP \(bu 2
\fBpillar_name\fP \-\- optional name to use for the pillar, defaults to \(aqnodegroups\(aq
.UNINDENT
.TP
.B Returns
a dictionary which is included by the salt master in the pillars returned to the minion
.UNINDENT
.UNINDENT
.SS salt.pillar.pepa
.SS Pepa
.sp
Configuration templating for SaltStack using Hierarchical substitution and Jinja.
.SS Configuring Pepa
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
extension_modules: /srv/salt/ext

ext_pillar:
  \- pepa:
      resource: host                # Name of resource directory and sub\-key in pillars
      sequence:                     # Sequence used for hierarchical substitution
        \- hostname:                 # Name of key
            name: input             # Alias used for template directory
            base_only: True         # Only use templates from Base environment, i.e. no staging
        \- default:
        \- environment:
        \- location..region:
            name: region
        \- location..country:
            name: country
        \- location..datacenter:
            name: datacenter
        \- roles:
        \- osfinger:
            name: os
        \- hostname:
            name: override
            base_only: True
      subkey: True                  # Create a sub\-key in pillars, named after the resource in this case [host]
      subkey_only: True             # Only create a sub\-key, and leave the top level untouched

pepa_roots:                         # Base directory for each environment
  base: /srv/pepa/base              # Path for base environment
  dev: /srv/pepa/base               # Associate dev with base
  qa: /srv/pepa/qa
  prod: /srv/pepa/prod

# Use a different delimiter for nested dictionaries, defaults to \(aq..\(aq since some keys may use \(aq.\(aq in the name
#pepa_delimiter: ..

# Supply Grains for Pepa, this should **ONLY** be used for testing or validation
#pepa_grains:
#  environment: dev

# Supply Pillar for Pepa, this should **ONLY** be used for testing or validation
#pepa_pillars:
#  saltversion: 0.17.4

# Enable debug for Pepa, and keep Salt on warning
#log_level: debug

#log_granular_levels:
#  salt: warning
#  salt.loaded.ext.pillar.pepa: debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pepa can also be used in Master\-less SaltStack setup.
.SS Command line
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: pepa.py [\-h] [\-c CONFIG] [\-d] [\-g GRAINS] [\-p PILLAR] [\-n] [\-v]
               hostname

positional arguments:
  hostname              Hostname

optional arguments:
  \-h, \-\-help            show this help message and exit
  \-c CONFIG, \-\-config CONFIG
                        Configuration file
  \-d, \-\-debug           Print debug info
  \-g GRAINS, \-\-grains GRAINS
                        Input Grains as YAML
  \-p PILLAR, \-\-pillar PILLAR
                        Input Pillar as YAML
  \-n, \-\-no\-color        No color output
  \-v, \-\-validate        Validate output
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Templates
.sp
Templates is configuration for a host or software, that can use information from Grains or Pillars. These can then be used for hierarchically substitution.
.sp
\fBExample File:\fP host/input/test_example_com.yaml
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
location..region: emea
location..country: nl
location..datacenter: foobar
environment: dev
roles:
  \- salt.master
network..gateway: 10.0.0.254
network..interfaces..eth0..hwaddr: 00:20:26:a1:12:12
network..interfaces..eth0..dhcp: False
network..interfaces..eth0..ipv4: 10.0.0.3
network..interfaces..eth0..netmask: 255.255.255.0
network..interfaces..eth0..fqdn: {{ hostname }}
cobbler..profile: fedora\-19\-x86_64
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As you see in this example you can use Jinja directly inside the template.
.sp
\fBExample File:\fP host/region/amer.yaml
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
network..dns..servers:
  \- 10.0.0.1
  \- 10.0.0.2
time..ntp..servers:
  \- ntp1.amer.example.com
  \- ntp2.amer.example.com
  \- ntp3.amer.example.com
time..timezone: America/Chihuahua
yum..mirror: yum.amer.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Each template is named after the value of the key using lowercase and all extended characters are replaced with underscore.
.sp
\fBExample:\fP
.sp
osfinger: Fedora\-19
.sp
\fBWould become:\fP
.sp
fedora_19.yaml
.SS Nested dictionaries
.sp
In order to create nested dictionaries as output you can use double dot \fB\(dq..\(dq\fP as a delimiter. You can change this using \(dqpepa_delimiter\(dq we choose double dot since single dot is already used by key names in some modules, and using \(dq:\(dq requires quoting in the YAML.
.sp
\fBExample:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
network..dns..servers:
  \- 10.0.0.1
  \- 10.0.0.2
network..dns..options:
  \- timeout:2
  \- attempts:1
  \- ndots:1
network..dns..search:
  \- example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWould become:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
network:
  dns:
    servers:
      \- 10.0.0.1
      \- 10.0.0.2
    options:
      \- timeout:2
      \- attempts:1
      \- ndots:1
    search:
      \- example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Operators
.sp
Operators can be used to merge/unset a list/hash or set the key as immutable, so it can\(aqt be changed.
.TS
center;
|l|l|.
_
T{
Operator
T}	T{
Description
T}
_
T{
merge()
T}	T{
Merge list or hash
T}
_
T{
unset()
T}	T{
Unset key
T}
_
T{
immutable()
T}	T{
Set the key as immutable, so it can\(aqt be changed
T}
_
T{
imerge()
T}	T{
Set immutable and merge
T}
_
T{
iunset()
T}	T{
Set immutable and unset
T}
_
.TE
.sp
\fBExample:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
network..dns..search..merge():
  \- foobar.com
  \- dummy.nl
owner..immutable(): Operations
host..printers..unset():
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Validation
.sp
Since it\(aqs very hard to test Jinja as is, the best approach is to run all the permutations of input and validate the output, i.e. Unit Testing.
.sp
To facilitate this in Pepa we use YAML, Jinja and Cerberus <\fI\%https://github.com/nicolaiarocci/cerberus\fP>.
.SS Schema
.sp
So this is a validation schema for network configuration, as you see it can be customized with Jinja just as Pepa templates.
.sp
This was designed to be run as a build job in Jenkins or similar tool. You can provide Grains/Pillar input using either the config file or command line arguments.
.sp
\fBFile Example: host/validation/network.yaml\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
network..dns..search:
  type: list
  allowed:
    \- example.com

network..dns..options:
  type: list
  allowed: [\(aqtimeout:2\(aq, \(aqattempts:1\(aq, \(aqndots:1\(aq]

network..dns..servers:
  type: list
  schema:
    regex: ^([0\-9]{1,3}\e.){3}[0\-9]{1,3}$

network..gateway:
  type: string
  regex: ^([0\-9]{1,3}\e.){3}[0\-9]{1,3}$

{% if network.interfaces is defined %}
{% for interface in network.interfaces %}

network..interfaces..{{ interface }}..dhcp:
  type: boolean

network..interfaces..{{ interface }}..fqdn:
  type: string
  regex: ^([a\-z0\-9]([a\-z0\-9\-]{0,61}[a\-z0\-9])?\e.)+[a\-zA\-Z]{2,6}$

network..interfaces..{{ interface }}..hwaddr:
  type: string
  regex: ^([0\-9a\-f]{1,2}\e:){5}[0\-9a\-f]{1,2}$

network..interfaces..{{ interface }}..ipv4:
  type: string
  regex: ^([0\-9]{1,3}\e.){3}[0\-9]{1,3}$

network..interfaces..{{ interface }}..netmask:
  type: string
  regex: ^([0\-9]{1,3}\e.){3}[0\-9]{1,3}$

{% endfor %}
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Links
.sp
For more examples and information see <\fI\%https://github.com/mickep76/pepa\fP>.
.INDENT 0.0
.TP
.B salt.pillar.pepa.ext_pillar(minion_id, pillar, resource, sequence, subkey=False, subkey_only=False)
Evaluate Pepa templates
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.pepa.key_value_to_tree(data)
Convert key/value to tree
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.pepa.validate(output, resource)
Validate Pepa templates
.UNINDENT
.SS salt.pillar.pillar_ldap
.sp
Use LDAP data as a Pillar source
.sp
This pillar module executes a series of LDAP searches.
Data returned by these searches are aggregated, whereby data returned by later
searches override data by previous searches with the same key.
.sp
The final result is merged with existing pillar data.
.sp
The configuration of this external pillar module is done via an external
file which provides the actual configuration for the LDAP searches.
.SS Configuring the LDAP ext_pillar
.sp
The basic configuration is part of the \fI\%master configuration\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- pillar_ldap: /etc/salt/master.d/pillar_ldap.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When placing the file in the \fBmaster.d\fP directory, make sure its name
doesn\(aqt end in \fB\&.conf\fP, otherwise the salt\-master process will attempt
to parse its content.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Make sure this file has very restrictive permissions, as it will contain
possibly sensitive LDAP credentials!
.UNINDENT
.UNINDENT
.sp
The only required key in the master configuration is \fBpillar_ldap\fP pointing
to a file containing the actual configuration.
.SS Configuring the LDAP searches
.sp
The file is processed using \fISalt\(aqs Renderers <renderers>\fP which makes it
possible to reference grains within the configuration.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
When using Jinja in this file, make sure to do it in a way which prevents
leaking sensitive information. A rogue minion could send arbitrary grains
to trick the master into returning secret data.
Use only the \(aqid\(aq grain which is verified through the minion\(aqs key/cert.
.UNINDENT
.UNINDENT
.SS Map Mode
.sp
The \fBit\-admins\fP configuration below returns the Pillar \fBit\-admins\fP by:
.INDENT 0.0
.IP \(bu 2
filtering for:
\- members of the group \fBit\-admins\fP
\- objects with \fBobjectclass=user\fP
.IP \(bu 2
returning the data of users, where each user is a dictionary containing the
configured string or list attributes.
.UNINDENT
.SS Configuration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-users:
  server:    ldap.company.tld
  port:      389
  tls:       true
  dn:        \(aqdc=company,dc=tld\(aq
  binddn:    \(aqcn=salt\-pillars,ou=users,dc=company,dc=tld\(aq
  bindpw:    bi7ieBai5Ano
  referrals: false
  anonymous: false
  mode:      map
  dn:        \(aqou=users,dc=company,dc=tld\(aq
  filter:    \(aq(&(memberof=cn=it\-admins,ou=groups,dc=company,dc=tld)(objectclass=user))\(aq
  attrs:
    \- cn
    \- displayName
    \- givenName
    \- sn
  lists:
    \- memberOf

search_order:
  \- salt\-users
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Result
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqsalt\-users\(aq: [
        {
            \(aqcn\(aq: \(aqcn=johndoe,ou=users,dc=company,dc=tld\(aq,
            \(aqdisplayName\(aq: \(aqJohn Doe\(aq
            \(aqgivenName\(aq: \(aqJohn\(aq
            \(aqsn\(aq: \(aqDoe\(aq
            \(aqmemberOf\(aq: [
              \(aqcn=it\-admins,ou=groups,dc=company,dc=tld\(aq,
              \(aqcn=team01,ou=groups,dc=company\(aq
            ]
        },
        {
            \(aqcn\(aq: \(aqcn=janedoe,ou=users,dc=company,dc=tld\(aq,
            \(aqdisplayName\(aq: \(aqJane Doe\(aq,
            \(aqgivenName\(aq: \(aqJane\(aq,
            \(aqsn\(aq: \(aqDoe\(aq,
            \(aqmemberOf\(aq: [
              \(aqcn=it\-admins,ou=groups,dc=company,dc=tld\(aq,
              \(aqcn=team02,ou=groups,dc=company\(aq
            ]
        }
    ]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.pillar_ldap.ext_pillar(minion_id, pillar, config_file)
Execute LDAP searches and return the aggregated data
.UNINDENT
.SS salt.pillar.postgres
.sp
Retrieve Pillar data by doing a postgres query
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B maturity
new
.TP
.B depends
psycopg2
.TP
.B platform
all
.UNINDENT
.SS Complete Example
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
postgres:
  user: \(aqsalt\(aq
  pass: \(aqsuper_secret_password\(aq
  db: \(aqsalt_db\(aq

ext_pillar:
  \- postgres:
      fromdb:
        query: \(aqSELECT col1,col2,col3,col4,col5,col6,col7
                  FROM some_random_table
                 WHERE minion_pattern LIKE %s\(aq
        depth: 5
        as_list: True
        with_lists: [1,3]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.pillar.postgres.POSTGRESExtPillar
This class receives and processes the database rows from POSTGRES.
.INDENT 7.0
.TP
.B extract_queries(args, kwargs)
This function normalizes the config block into a set of queries we
can use.  The return is a list of consistently laid out dicts.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.postgres.ext_pillar(minion_id, pillar, *args, **kwargs)
Execute queries against POSTGRES, merge and return as a dict
.UNINDENT
.SS salt.pillar.puppet
.sp
Execute an unmodified puppet_node_classifier and read the output as YAML. The YAML data is then directly overlaid onto the minion\(aqs Pillar data.
.INDENT 0.0
.TP
.B salt.pillar.puppet.ext_pillar(minion_id, pillar, command)
Execute an unmodified puppet_node_classifier and read the output as YAML
.UNINDENT
.SS salt.pillar.reclass_adapter
.sp
Use the \(dqreclass\(dq database as a Pillar source
.sp
This \fBext_pillar\fP plugin provides access to the \fBreclass\fP database, such
that Pillar data for a specific minion are fetched using \fBreclass\fP\&.
.sp
You can find more information about \fBreclass\fP at
\fI\%http://reclass.pantsfullofunix.net\fP\&.
.sp
To use the plugin, add it to the \fBext_pillar\fP list in the Salt master config
and tell \fBreclass\fP by way of a few options how and where to find the
inventory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
    \- reclass:
        storage_type: yaml_fs
        inventory_base_uri: /srv/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This would cause \fBreclass\fP to read the inventory from YAML files in
\fB/srv/salt/nodes\fP and \fB/srv/salt/classes\fP\&.
.sp
If you are also using \fBreclass\fP as \fBmaster_tops\fP plugin, and you want to
avoid having to specify the same information for both, use YAML anchors (take
note of the differing data types for \fBext_pillar\fP and \fBmaster_tops\fP):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reclass: &reclass
    storage_type: yaml_fs
    inventory_base_uri: /srv/salt
    reclass_source_path: ~/code/reclass

ext_pillar:
    \- reclass: *reclass

master_tops:
    reclass: *reclass
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you want to run reclass from source, rather than installing it, you can
either let the master know via the \fBPYTHONPATH\fP environment variable, or by
setting the configuration option, like in the example above.
.INDENT 0.0
.TP
.B salt.pillar.reclass_adapter.ext_pillar(minion_id, pillar, **kwargs)
Obtain the Pillar data from \fBreclass\fP for the given \fBminion_id\fP\&.
.UNINDENT
.SS salt.pillar.redismod
.SS Read pillar data from a Redis backend
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
redis Python module (on master)
.UNINDENT
.UNINDENT
.SS Salt Master Redis Configuration
.sp
The module shares the same base Redis connection variables as
\fI\%salt.returners.redis_return\fP\&. These variables go in your master
config file.
.INDENT 0.0
.IP \(bu 2
\fBredis.db\fP \- The Redis database to use. Defaults to \fB0\fP\&.
.IP \(bu 2
\fBredis.host\fP \- The Redis host to connect to. Defaults to \fB\(aqsalt\(aq\fP\&.
.IP \(bu 2
\fBredis.port\fP \- The port that the Redis database is listening on. Defaults
to \fB6379\fP\&.
.IP \(bu 2
\fBredis.password\fP \- The password for authenticating with Redis. Only
required if you are using master auth. Defaults to \fBNone\fP\&.
.UNINDENT
.SS Configuring the Redis ext_pillar
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- redis: {function: key_value}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.redismod.ext_pillar(minion_id, pillar, function, **kwargs)
Grabs external pillar data based on configured function
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.redismod.key_json(minion_id, pillar, pillar_key=None)
Pulls a string from redis and deserializes it from json. Deserialized
dictionary data loaded directly into top level if pillar_key is not set.
.INDENT 7.0
.TP
.B pillar_key
Pillar key to return data into
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.redismod.key_value(minion_id, pillar, pillar_key=\(aqredis_pillar\(aq)
Looks for key in redis matching minion_id, returns a structure based on the
data type of the redis key. String for string type, dict for hash type and
lists for lists, sets and sorted sets.
.INDENT 7.0
.TP
.B pillar_key
Pillar key to return data into
.UNINDENT
.UNINDENT
.SS salt.pillar.rethinkdb_pillar
.sp
Provide external pillar data from RethinkDB
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
rethinkdb (on the salt\-master)
.UNINDENT
.SS salt master rethinkdb configuration
.INDENT 0.0
.TP
.B These variables must be configured in your master configuration file.
.INDENT 7.0
.IP \(bu 2
\fBrethinkdb.host\fP \- The RethinkDB server. Defaults to \fB\(aqsalt\(aq\fP
.IP \(bu 2
\fBrethinkdb.port\fP \- The port the RethinkDB server listens on.
Defaults to \fB\(aq28015\(aq\fP
.IP \(bu 2
\fBrethinkdb.database\fP \- The database to connect to.
Defaults to \fB\(aqsalt\(aq\fP
.IP \(bu 2
\fBrethinkdb.username\fP \- The username for connecting to RethinkDB.
Defaults to \fB\(aq\(aq\fP
.IP \(bu 2
\fBrethinkdb.password\fP \- The password for connecting to RethinkDB.
Defaults to \fB\(aq\(aq\fP
.UNINDENT
.UNINDENT
.SS salt\-master ext_pillar configuration
.sp
The ext_pillar function arguments are given in single line dictionary notation.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- rethinkdb: {table: ext_pillar, id_field: minion_id, field: pillar_root, pillar_key: external_pillar}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B In the example above the following happens.
.INDENT 7.0
.IP \(bu 2
The salt\-master will look for external pillars in the \(aqext_pillar\(aq table
on the RethinkDB host
.IP \(bu 2
The minion id will be matched against the \(aqminion_id\(aq field
.IP \(bu 2
Pillars will be retrieved from the nested field \(aqpillar_root\(aq
.IP \(bu 2
Found pillars will be merged inside a key called \(aqexternal_pillar\(aq
.UNINDENT
.UNINDENT
.SS Module Documentation
.INDENT 0.0
.TP
.B salt.pillar.rethinkdb_pillar.ext_pillar(minion_id, pillar, table=\(aqpillar\(aq, id_field=None, field=None, pillar_key=None)
Collect minion external pillars from a RethinkDB database
.sp
Arguments:
.INDENT 7.0
.IP \(bu 2
\fItable\fP: The RethinkDB table containing external pillar information.
Defaults to \fB\(aqpillar\(aq\fP
.IP \(bu 2
\fIid_field\fP: Field in document containing the minion id.
If blank then we assume the table index matches minion ids
.IP \(bu 2
\fIfield\fP: Specific field in the document used for pillar data, if blank
then the entire document will be used
.IP \(bu 2
\fIpillar_key\fP: The salt\-master will nest found external pillars under
this key before merging into the minion pillars. If blank, external
pillars will be merged at top level
.UNINDENT
.UNINDENT
.SS salt.pillar.s3
.sp
Copy pillar data from a bucket in Amazon S3
.sp
The S3 pillar can be configured in the master config file with the following
options
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- s3:
      bucket: my.fancy.pillar.bucket
      keyid: KASKFJWAKJASJKDAJKSD
      key: ksladfDLKDALSFKSD93q032sdDasdfasdflsadkf
      multiple_env: False
      environment: base
      prefix: somewhere/overthere
      verify_ssl: True
      service_url: s3.amazonaws.com
      kms_keyid: 01234567\-89ab\-cdef\-0123\-4567890abcde
      s3_cache_expire: 30
      s3_sync_on_update: True
      path_style: False
      https_enable: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBbucket\fP parameter specifies the target S3 bucket. It is required.
.sp
The \fBkeyid\fP parameter specifies the key id to use when access the S3 bucket.
If it is not provided, an attempt to fetch it from EC2 instance meta\-data will
be made.
.sp
The \fBkey\fP parameter specifies the key to use when access the S3 bucket. If it
is not provided, an attempt to fetch it from EC2 instance meta\-data will be made.
.sp
The \fBmultiple_env\fP defaults to False. It specifies whether the pillar should
interpret top level folders as pillar environments (see mode section below).
.sp
The \fBenvironment\fP defaults to \(aqbase\(aq. It specifies which environment the
bucket represents when in single environments mode (see mode section below). It
is ignored if multiple_env is True.
.sp
The \fBprefix\fP defaults to \(aq\(aq. It specifies a key prefix to use when searching
for data in the bucket for the pillar. It works when multiple_env is True or False.
Essentially it tells ext_pillar to look for your pillar data in a \(aqsubdirectory\(aq
of your S3 bucket
.sp
The \fBverify_ssl\fP parameter defaults to True. It specifies whether to check for
valid S3 SSL certificates. \fINOTE\fP If you use bucket names with periods, this
must be set to False else an invalid certificate error will be thrown (issue
#12200).
.sp
The \fBservice_url\fP parameter defaults to \(aqs3.amazonaws.com\(aq. It specifies the
base url to use for accessing S3.
.sp
The \fBkms_keyid\fP parameter is optional. It specifies the ID of the Key
Management Service (KMS) master key that was used to encrypt the object.
.sp
The \fBs3_cache_expire\fP parameter defaults to 30s. It specifies expiration
time of S3 metadata cache file.
.sp
The \fBs3_sync_on_update\fP parameter defaults to True. It specifies if cache
is synced on update rather than jit.
.sp
The \fBpath_style\fP parameter defaults to False. It specifies whether to use
path style requests or dns style requests
.sp
The \fBhttps_enable\fP parameter defaults to True. It specifies whether to use
https protocol or http protocol
.sp
This pillar can operate in two modes, single environment per bucket or multiple
environments per bucket.
.sp
Single environment mode must have this bucket structure:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
s3://<bucket name>/<prefix>/<files>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple environment mode must have this bucket structure:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
s3://<bucket name>/<prefix>/<environment>/<files>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you wish to define your pillar data entirely within S3 it\(aqs recommended
that you use the \fIprefix=\fP parameter and specify one entry in ext_pillar
for each environment rather than specifying multiple_env. This is due
to issue #22471 (\fI\%https://github.com/saltstack/salt/issues/22471\fP)
.INDENT 0.0
.TP
.B class  salt.pillar.s3.S3Credentials(key, keyid, bucket, service_url, verify_ssl=True, kms_keyid=None, location=None, path_style=False, https_enable=True)
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.s3.ext_pillar(minion_id, pillar, bucket, key=None, keyid=None, verify_ssl=True, location=None, multiple_env=False, environment=\(aqbase\(aq, prefix=\(aq\(aq, service_url=None, kms_keyid=None, s3_cache_expire=30, s3_sync_on_update=True, path_style=False, https_enable=True)
Execute a command and read the output as YAML
.UNINDENT
.SS salt.pillar.saltclass
.SS SaltClass Pillar Module
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- saltclass:
    \- path: /srv/saltclass
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For additional configuration instructions, see the \fI\%saltclass\fP module
.INDENT 0.0
.TP
.B salt.pillar.saltclass.ext_pillar(minion_id, pillar, *args, **kwargs)
Compile pillar data
.UNINDENT
.SS salt.pillar.sql_base
.sp
Retrieve Pillar data by doing a SQL query
.sp
This module is not meant to be used directly as an ext_pillar.
It is a place to put code common to PEP 249 compliant SQL database adapters.
It exposes a python ABC that can be subclassed for new database providers.
.INDENT 0.0
.TP
.B maturity
new
.TP
.B platform
all
.UNINDENT
.SS Theory of sql_base ext_pillar
.sp
Ok, here\(aqs the theory for how this works...
.INDENT 0.0
.IP \(bu 2
First, any non\-keyword args are processed in order.
.IP \(bu 2
Then, remaining keywords are processed.
.UNINDENT
.sp
We do this so that it\(aqs backward compatible with older configs.
Keyword arguments are sorted before being appended, so that they\(aqre predictable,
but they will always be applied last so overall it\(aqs moot.
.sp
For each of those items we process, it depends on the object type:
.INDENT 0.0
.IP \(bu 2
Strings are executed as is and the pillar depth is determined by the number
of fields returned.
.IP \(bu 2
A list has the first entry used as the query, the second as the pillar depth.
.IP \(bu 2
A mapping uses the keys \(dqquery\(dq and \(dqdepth\(dq as the tuple
.UNINDENT
.sp
You can retrieve as many fields as you like, how they get used depends on the
exact settings.
.SS Configuring a sql_base ext_pillar
.sp
The sql_base ext_pillar cannot be used directly, but shares query configuration
with its implementations. These examples use a fake \(aqsql_base\(aq adapter, which
should be replaced with the name of the adapter you are using.
.sp
A list of queries can be passed in
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- sql_base:
      \- \(dqSELECT pillar,value FROM pillars WHERE minion_id = %s\(dq
      \- \(dqSELECT pillar,value FROM more_pillars WHERE minion_id = %s\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or you can pass in a mapping
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- sql_base:
      main: \(dqSELECT pillar,value FROM pillars WHERE minion_id = %s\(dq
      extras: \(dqSELECT pillar,value FROM more_pillars WHERE minion_id = %s\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The query can be provided as a string as we have just shown, but they can be
provided as lists
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- sql_base:
      \- \(dqSELECT pillar,value FROM pillars WHERE minion_id = %s\(dq
        2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or as a mapping
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- sql_base:
      \- query: \(dqSELECT pillar,value FROM pillars WHERE minion_id = %s\(dq
        depth: 2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The depth defines how the dicts are constructed.
Essentially if you query for fields a,b,c,d for each row you\(aqll get:
.INDENT 0.0
.IP \(bu 2
With depth 1: {a: {\(dqb\(dq: b, \(dqc\(dq: c, \(dqd\(dq: d}}
.IP \(bu 2
With depth 2: {a: {b: {\(dqc\(dq: c, \(dqd\(dq: d}}}
.IP \(bu 2
With depth 3: {a: {b: {c: d}}}
.UNINDENT
.sp
Depth greater than 3 wouldn\(aqt be different from 3 itself.
Depth of 0 translates to the largest depth needed, so 3 in this case.
(max depth == key count \- 1)
.sp
Then they are merged in a similar way to plain pillar data, in the order
returned by the SQL database.
.sp
Thus subsequent results overwrite previous ones when they collide.
.sp
The ignore_null option can be used to change the overwrite behavior so that
only non\-NULL values in subsequent results will overwrite.  This can be used
to selectively overwrite default values.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- sql_base:
      \- query: \(dqSELECT pillar,value FROM pillars WHERE minion_id = \(aqdefault\(aq and minion_id != %s\(dq
        depth: 2
      \- query: \(dqSELECT pillar,value FROM pillars WHERE minion_id = %s\(dq
        depth: 2
        ignore_null: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you specify \fIas_list: True\fP in the mapping expression it will convert
collisions to lists.
.sp
If you specify \fIwith_lists: \(aq...\(aq\fP in the mapping expression it will
convert the specified depths to list.  The string provided is a sequence
numbers that are comma separated.  The string \(aq1,3\(aq will result in:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
a,b,c,d,e,1  # field 1 same, field 3 differs
a,b,c,f,g,2  # ^^^^
a,z,h,y,j,3  # field 1 same, field 3 same
a,z,h,y,k,4  # ^^^^
  ^   ^
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
These columns define list grouping
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{a: [
      {c: [
          {e: 1},
          {g: 2}
          ]
      },
      {h: [
          {j: 3, k: 4 }
          ]
      }
]}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The range for with_lists is 1 to number_of_fields, inclusive.
Numbers outside this range are ignored.
.sp
If you specify \fIas_json: True\fP in the mapping expression and query only for
single value, returned data are considered in JSON format and will be merged
directly.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- sql_base:
      \- query: \(dqSELECT json_pillar FROM pillars WHERE minion_id = %s\(dq
        as_json: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The processed JSON entries are recursively merged in a single dictionary.
Additionnaly if \fIas_list\fP is set to \fITrue\fP the lists will be merged in case of collision.
.sp
For instance the following rows:
.INDENT 0.0
.INDENT 3.5
{\(dqa\(dq: {\(dqb\(dq: [1, 2]}, \(dqc\(dq: 3}
{\(dqa\(dq: {\(dqb\(dq: [1, 3]}, \(dqd\(dq: 4}
.UNINDENT
.UNINDENT
.sp
will result in the following pillar with \fIas_list=False\fP
.INDENT 0.0
.INDENT 3.5
{\(dqa\(dq: {\(dqb\(dq: [1, 3], \(dqc\(dq: 3, \(dqd\(dq: 4}
.UNINDENT
.UNINDENT
.sp
and in with \fIas_list=True\fP
.INDENT 0.0
.INDENT 3.5
{\(dqa\(dq: {\(dqb\(dq: [1, 2, 3], \(dqc\(dq: 3, \(dqd\(dq: 4}
.UNINDENT
.UNINDENT
.sp
Finally, if you pass the queries in via a mapping, the key will be the
first level name where as passing them in as a list will place them in the
root.  This isolates the query results into their own subtrees.
This may be a help or hindrance to your aims and can be used as such.
.sp
You can basically use any SELECT query that gets you the information, you
could even do joins or subqueries in case your minion_id is stored elsewhere.
It is capable of handling single rows or multiple rows per minion.
.sp
Configuration of the connection depends on the adapter in use.
.sp
New in version 3005: The \fIas_json\fP parameter.

.SS More complete example for MySQL (to also show configuration)
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql:
  user: \(aqsalt\(aq
  pass: \(aqsuper_secret_password\(aq
  db: \(aqsalt_db\(aq

ext_pillar:
  \- mysql:
      fromdb:
        query: \(aqSELECT col1,col2,col3,col4,col5,col6,col7
                  FROM some_random_table
                 WHERE minion_pattern LIKE %s\(aq
        depth: 5
        as_list: True
        with_lists: [1,3]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.pillar.sql_base.SqlBaseExtPillar
This class receives and processes the database rows in a database
agnostic way.
.INDENT 7.0
.TP
.B as_json  =  False
.UNINDENT
.INDENT 7.0
.TP
.B as_list  =  False
.UNINDENT
.INDENT 7.0
.TP
.B depth  =  0
.UNINDENT
.INDENT 7.0
.TP
.B enter_root(root)
Set self.focus for kwarg queries
.UNINDENT
.INDENT 7.0
.TP
.B extract_queries(args, kwargs)
This function normalizes the config block into a set of queries we
can use.  The return is a list of consistently laid out dicts.
.UNINDENT
.INDENT 7.0
.TP
.B fetch(minion_id, pillar, *args, **kwargs)
Execute queries, merge and return as a dict.
.UNINDENT
.INDENT 7.0
.TP
.B field_names  =  None
.UNINDENT
.INDENT 7.0
.TP
.B focus  =  None
.UNINDENT
.INDENT 7.0
.TP
.B ignore_null  =  False
.UNINDENT
.INDENT 7.0
.TP
.B num_fields  =  0
.UNINDENT
.INDENT 7.0
.TP
.B process_fields(field_names, depth)
The primary purpose of this function is to store the sql field list
and the depth to which we process.
.UNINDENT
.INDENT 7.0
.TP
.B process_results(rows)
This function takes a list of database results and iterates over,
merging them into a dict form.
.UNINDENT
.INDENT 7.0
.TP
.B result  =  None
.UNINDENT
.INDENT 7.0
.TP
.B with_lists  =  None
.UNINDENT
.UNINDENT
.SS salt.pillar.sqlcipher
.sp
Retrieve Pillar data by running a SQLCipher query
.sp
New in version 2016.3.0.

.sp
Python SQLCipher support is provided by the pysqlcipher
Python package. You need this module installed to query
Pillar data from a SQLCipher database.
.sp
This module is a concrete implementation of the sql_base
ext_pillar for SQLCipher.
.INDENT 0.0
.TP
.B maturity
new
.TP
.B depends
pysqlcipher (for py2) or pysqlcipher3 (for py3)
.TP
.B platform
all
.UNINDENT
.SS Configuring the sqlcipher ext_pillar
.sp
Use the \(aqsqlcipher\(aq key under ext_pillar for configuration of queries.
.sp
SQLCipher database connection configuration requires the following values
configured in the master config:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBsqlcipher.database\fP \- The SQLCipher database to connect to.
Defaults to \fB\(aq/var/lib/salt/pillar\-sqlcipher.db\(aq\fP\&.
.IP \(bu 2
\fBsqlcipher.pass\fP \- The SQLCipher database decryption password.
.IP \(bu 2
\fBsqlcipher.timeout\fP \- The connection timeout in seconds.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Example configuration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sqlcipher:
  database: /var/lib/salt/pillar\-sqlcipher.db
  pass: strong_pass_phrase
  timeout: 5.0
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Complete Example
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sqlcipher:
  database: \(aq/var/lib/salt/pillar\-sqlcipher.db\(aq
  pass: strong_pass_phrase
  timeout: 5.0

ext_pillar:
  \- sqlcipher:
      fromdb:
        query: \(aqSELECT col1,col2,col3,col4,col5,col6,col7
                  FROM some_random_table
                 WHERE minion_pattern LIKE ?\(aq
        depth: 5
        as_list: True
        with_lists: [1,3]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.pillar.sqlcipher.SQLCipherExtPillar
This class receives and processes the database rows from SQLCipher.
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.sqlcipher.ext_pillar(minion_id, pillar, *args, **kwargs)
Execute queries against SQLCipher, merge and return as a dict
.UNINDENT
.SS salt.pillar.sqlite3
.sp
Retrieve Pillar data by doing a SQLite3 query
.sp
New in version 2015.8.0.

.sp
\fBsqlite3\fP is included in the stdlib since Python 2.5.
.sp
This module is a concrete implementation of the sql_base ext_pillar for
SQLite3.
.INDENT 0.0
.TP
.B platform
all
.UNINDENT
.SS Configuring the sqlite3 ext_pillar
.sp
Use the \(aqsqlite3\(aq key under ext_pillar for configuration of queries.
.sp
SQLite3 database connection configuration requires the following values
configured in the master config:
.sp
Note, timeout is in seconds.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sqlite3.database: /var/lib/salt/pillar.db
sqlite3.timeout: 5.0
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Complete Example
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sqlite3:
  database: \(aq/var/lib/salt/pillar.db\(aq
  timeout: 5.0

ext_pillar:
  \- sqlite3:
      fromdb:
        query: \(aqSELECT col1,col2,col3,col4,col5,col6,col7
                  FROM some_random_table
                 WHERE minion_pattern LIKE ?\(aq
        depth: 5
        as_list: True
        with_lists: [1,3]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.pillar.sqlite3.SQLite3ExtPillar
This class receives and processes the database rows from SQLite3.
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.sqlite3.ext_pillar(minion_id, pillar, *args, **kwargs)
Execute queries against SQLite3, merge and return as a dict
.UNINDENT
.SS salt.pillar.stack
.sp
Simple and flexible YAML ext_pillar which can read pillar from within pillar.
.sp
New in version 2016.3.0.

.sp
\fI\%PillarStack\fP is a custom saltstack
\fBext_pillar\fP which was inspired by \fI\%varstack\fP but is heavily based on Jinja2 for
maximum flexibility.
.sp
It supports the following features:
.INDENT 0.0
.IP \(bu 2
multiple config files that are jinja2 templates with support for \fBpillar\fP,
\fB__grains__\fP, \fB__salt__\fP, \fB__opts__\fP objects and \fBpillarenv\fP
.IP \(bu 2
a config file renders as an ordered list of files (paths of these files are
relative to the current config file)
.IP \(bu 2
this list of files are read in ordered as jinja2 templates with support for
\fBstack\fP, \fBpillar\fP, \fB__grains__\fP, \fB__salt__\fP, \fB__opts__\fP objects and
\fBpillarenv\fP
.IP \(bu 2
all these rendered files are then parsed as \fByaml\fP
.IP \(bu 2
then all yaml dicts are merged in order with support for the following
merging strategies: \fBmerge\-first\fP, \fBmerge\-last\fP, \fBremove\fP, and
\fBoverwrite\fP
.IP \(bu 2
stack config files can be matched based on \fBpillar\fP, \fBgrains\fP, or
\fBopts\fP values, which make it possible to support kind of self\-contained
environments
.UNINDENT
.SS Installation
.sp
PillarStack is already bundled with Salt since 2016.3.0 version so there is
nothing to install from version 2016.3.0.
.sp
If you use an older Salt version or you want to override PillarStack with a
more recent one, follow the installation procedure below.
.sp
Installing the PillarStack \fBext_pillar\fP is as simple as dropping the
\fBstack.py\fP file in the \fB<extension_modules>/pillar\fP directory (no external
python module required), given that \fBextension_modules\fP is set in your
salt\-master configuration, see:
\fI\%https://docs.saltproject.io/en/latest/ref/configuration/master.html#extension\-modules\fP
.SS Configuration in Salt
.sp
Like any other external pillar, its configuration takes place through the
\fBext_pillar\fP key in the master config file.
.sp
However, you can configure PillarStack in 3 different ways:
.SS Single config file
.sp
This is the simplest option, you just need to set the path to your single
PillarStack config file like below:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- stack: /path/to/stack.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.SS List of config files
.sp
You can also provide a list of config files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- stack:
      \- /path/to/stack1.cfg
      \- /path/to/stack2.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Select config files through grains|pillar|opts matching
.sp
You can also opt for a much more flexible configuration: PillarStack allows one
to select the config files for the current minion based on matching values from
either grains, or pillar, or opts objects.
.sp
Here is an example of such a configuration, which should speak by itself:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- stack:
      pillar:something:
        bar: /path/to/bar/stack.cfg
        foo: /path/to/foo/stack.cfg
      grains:custom:grain:
        value:
          \- /path/to/stack1.cfg
          \- /path/to/stack2.cfg
      opts:custom:opt:
        value: /path/to/stack0.cfg
      opts:saltenv:
        dev: /path/to/dev/stack.cfg
        __env__: /path/to/__env__/stack.cfg
.ft P
.fi
.UNINDENT
.UNINDENT
.SS PillarStack configuration files
.sp
The config files that are referenced in the above \fBext_pillar\fP configuration
are jinja2 templates which must render as a simple ordered list of \fByaml\fP
files that will then be merged to build pillar data.
.sp
The path of these \fByaml\fP files must be relative to the directory of the
PillarStack config file. These paths support unix style pathname pattern
expansion through the
\fIPython glob module <https://docs.python.org/2/library/glob.html>\fP\&.
.sp
The following variables are available in jinja2 templating of PillarStack
configuration files:
.INDENT 0.0
.IP \(bu 2
\fBpillar\fP: the pillar data (as passed by Salt to our \fBext_pillar\fP
function)
.IP \(bu 2
\fBminion_id\fP: the minion id ;\-)
.IP \(bu 2
\fB__opts__\fP: a dictionary of mostly Salt configuration options
.IP \(bu 2
\fB__grains__\fP: a dictionary of the grains of the minion making this pillar
call
.IP \(bu 2
\fB__salt__\fP: a dictionary of Salt module functions, useful so you don\(aqt have
to duplicate functions that already exist (note: runs on the master)
.UNINDENT
.sp
So you can use all the power of jinja2 to build your list of \fByaml\fP files
that will be merged in pillar data.
.sp
For example, you could have a PillarStack config file which looks like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ cat /path/to/stack/config.cfg
core.yml
common/*.yml
osarchs/{{ __grains__[\(aqosarch\(aq] }}.yml
oscodenames/{{ __grains__[\(aqoscodename\(aq] }}.yml
{%\- for role in pillar.get(\(aqroles\(aq, []) %}
roles/{{ role }}.yml
{%\- endfor %}
minions/{{ minion_id }}.yml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And the whole directory structure could look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ tree /path/to/stack/
/path/to/stack/
├── config.cfg
├── core.yml
├── common/
│\ \  ├── xxx.yml
│\ \  └── yyy.yml
├── osarchs/
│\ \  ├── amd64.yml
│\ \  └── armhf.yml
├── oscodenames/
│\ \  ├── wheezy.yml
│\ \  └── jessie.yml
├── roles/
│\ \  ├── web.yml
│\ \  └── db.yml
└── minions/
    ├── test\-1\-dev.yml
    └── test\-2\-dev.yml
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Overall process
.sp
In the above PillarStack configuration, given that test\-1\-dev minion is an
amd64 platform running Debian Jessie, and which pillar \fBroles\fP is \fB[\(dqdb\(dq]\fP,
the following \fByaml\fP files would be merged in order:
.INDENT 0.0
.IP \(bu 2
\fBcore.yml\fP
.IP \(bu 2
\fBcommon/xxx.yml\fP
.IP \(bu 2
\fBcommon/yyy.yml\fP
.IP \(bu 2
\fBosarchs/amd64.yml\fP
.IP \(bu 2
\fBoscodenames/jessie.yml\fP
.IP \(bu 2
\fBroles/db.yml\fP
.IP \(bu 2
\fBminions/test\-1\-dev.yml\fP
.UNINDENT
.sp
Before merging, every files above will be preprocessed as Jinja2 templates.
The following variables are available in Jinja2 templating of \fByaml\fP files:
.INDENT 0.0
.IP \(bu 2
\fBstack\fP: the PillarStack pillar data object that has currently been merged
(data from previous \fByaml\fP files in PillarStack configuration)
.IP \(bu 2
\fBpillar\fP: the pillar data (as passed by Salt to our \fBext_pillar\fP
function)
.IP \(bu 2
\fBminion_id\fP: the minion id ;\-)
.IP \(bu 2
\fB__opts__\fP: a dictionary of mostly Salt configuration options
.IP \(bu 2
\fB__grains__\fP: a dictionary of the grains of the minion making this pillar
call
.IP \(bu 2
\fB__salt__\fP: a dictionary of Salt module functions, useful so you don\(aqt have
to duplicate functions that already exist (note: runs on the master)
.UNINDENT
.sp
So you can use all the power of jinja2 to build your pillar data, and even use
other pillar values that has already been merged by PillarStack (from previous
\fByaml\fP files in PillarStack configuration) through the \fBstack\fP variable.
.sp
Once a \fByaml\fP file has been preprocessed by Jinja2, we obtain a Python dict \-
let\(aqs call it \fByml_data\fP \- then, PillarStack will merge this \fByml_data\fP
dict in the main \fBstack\fP dict (which contains already merged PillarStack
pillar data).
By default, PillarStack will deeply merge \fByml_data\fP in \fBstack\fP (similarly
to the \fBrecurse\fP salt \fBpillar_source_merging_strategy\fP), but 3 merging
strategies are currently available for you to choose (see next section).
.sp
Once every \fByaml\fP files have been processed, the \fBstack\fP dict will contain
your whole own pillar data, merged in order by PillarStack.
So PillarStack \fBext_pillar\fP returns the \fBstack\fP dict, the contents of which
Salt takes care to merge in with all of the other pillars and finally return
the whole pillar to the minion.
.SS Merging strategies
.sp
The way the data from a new \fByaml_data\fP dict is merged with the existing
\fBstack\fP data can be controlled by specifying a merging strategy. Right now
this strategy can either be \fBmerge\-last\fP (the default), \fBmerge\-first\fP,
\fBremove\fP, or \fBoverwrite\fP\&.
.sp
Note that scalar values like strings, integers, booleans, etc. are always
evaluated using the \fBoverwrite\fP strategy (other strategies don\(aqt make sense
in that case).
.sp
The merging strategy can be set by including a dict in the form of:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__: <merging strategy>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
as the first item of the dict or list.
This allows fine grained control over the merging process.
.SS \fBmerge\-last\fP (default) strategy
.sp
If the \fBmerge\-last\fP strategy is selected (the default), then content of dict
or list variables is merged recursively with previous definitions of this
variable (similarly to the \fBrecurse\fP salt
\fBpillar_source_merging_strategy\fP).
This allows for extending previously defined data.
.SS \fBmerge\-first\fP strategy
.sp
If the \fBmerge\-first\fP strategy is selected, then the content of dict or list
variables are swapped between the \fByaml_data\fP and \fBstack\fP objects before
being merged recursively with the \fBmerge\-last\fP previous strategy.
.SS \fBremove\fP strategy
.sp
If the \fBremove\fP strategy is selected, then content of dict or list variables
in \fBstack\fP are removed only if the corresponding item is present in the
\fByaml_data\fP dict.
This allows for removing items from previously defined data.
.SS \fBoverwrite\fP strategy
.sp
If the \fBoverwrite\fP strategy is selected, then the content of dict or list
variables in \fBstack\fP is overwritten by the content of \fByaml_data\fP dict.
So this allows one to overwrite variables from previous definitions.
.SS Merging examples
.sp
Let\(aqs go through small examples that should clarify what\(aqs going on when a
\fByaml_data\fP dict is merged in the \fBstack\fP dict.
.sp
When you don\(aqt specify any strategy, the default \fBmerge\-last\fP strategy is
selected:
.TS
center;
|l|l|l|.
_
T{
\fBstack\fP
T}	T{
\fByaml_data\fP
T}	T{
\fBstack\fP (after merge)
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 500
    roles:
      \- sysadmin
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 1000
    roles:
      \- developer
  mat:
    uid: 1001
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 1000
    roles:
      \- sysadmin
      \- developer
  mat:
    uid: 1001
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
.TE
.sp
Then you can select a custom merging strategy using the \fB__\fP key in a dict:
.TS
center;
|l|l|l|.
_
T{
\fBstack\fP
T}	T{
\fByaml_data\fP
T}	T{
\fBstack\fP (after merge)
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 500
    roles:
      \- sysadmin
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  __: merge\-last
  tom:
    uid: 1000
    roles:
      \- developer
  mat:
    uid: 1001
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 1000
    roles:
      \- sysadmin
      \- developer
  mat:
    uid: 1001
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 500
    roles:
      \- sysadmin
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  __: merge\-first
  tom:
    uid: 1000
    roles:
      \- developer
  mat:
    uid: 1001
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 500
    roles:
      \- developer
      \- sysadmin
  mat:
    uid: 1001
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 500
    roles:
      \- sysadmin
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  __: remove
  tom:
  mat:
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 500
    roles:
      \- sysadmin
  root:
    uid: 0
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  __: overwrite
  tom:
    uid: 1000
    roles:
      \- developer
  mat:
    uid: 1001
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  tom:
    uid: 1000
    roles:
      \- developer
  mat:
    uid: 1001
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
.TE
.sp
You can also select a custom merging strategy using a \fB__\fP object in a list:
.TS
center;
|l|l|l|.
_
T{
\fBstack\fP
T}	T{
\fByaml_data\fP
T}	T{
\fBstack\fP (after merge)
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- tom
  \- root
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- __: merge\-last
  \- mat
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- tom
  \- root
  \- mat
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- tom
  \- root
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- __: merge\-first
  \- mat
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- mat
  \- tom
  \- root
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- tom
  \- root
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- __: remove
  \- mat
  \- tom
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- root
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- tom
  \- root
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- __: overwrite
  \- mat
.ft P
.fi
.UNINDENT
.UNINDENT
T}	T{
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  \- mat
.ft P
.fi
.UNINDENT
.UNINDENT
T}
_
.TE
.INDENT 0.0
.TP
.B salt.pillar.stack.ext_pillar(minion_id, pillar, *args, **kwargs)
Builds stacked pillar from yaml files listed in file(s).
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBminion_id\fP (\fI\%str\fP) \-\- Minion ID
.IP \(bu 2
\fBpillar\fP (\fI\%dict\fP) \-\- pillar
.IP \(bu 2
\fBargs\fP (\fI\%list\fP) \-\- (Optional) file(s) that list yaml files
.IP \(bu 2
\fBkwargs\fP (\fI\%dict\fP) \-\- (Optional) conditional file(s) that list yaml files
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.pillar.svn_pillar
.sp
Clone a remote SVN repository and use the filesystem as a Pillar source
.sp
This external Pillar source can be configured in the master config file like
so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- svn: trunk svn://svnserver/repo root=subdirectory
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fIroot=\fP parameter is optional and used to set the subdirectory from where
to look for Pillar files (such as \fBtop.sls\fP).
.sp
Changed in version 2014.7.0: The optional \fBroot\fP parameter will be added.

.sp
Note that this is not the same thing as configuring pillar data using the
\fI\%pillar_roots\fP parameter. The branch referenced in the
\fI\%ext_pillar\fP entry above (\fBmaster\fP), would evaluate to the
\fBbase\fP environment, so this branch needs to contain a \fBtop.sls\fP with a
\fBbase\fP section in it, like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use other environments from the same SVN repo as svn_pillar sources, just
add additional lines, like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- svn: trunk svn://svnserver/repo
  \- svn: dev svn://svnserver/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this case, the \fBdev\fP branch would need its own \fBtop.sls\fP with a \fBdev\fP
section in it, like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
dev:
  \(aq*\(aq:
    \- bar
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.pillar.svn_pillar.SvnPillar(branch, repo_location, root, opts)
Deal with the remote SVN repository for Pillar
.INDENT 7.0
.TP
.B pillar_dir()
Returns the directory of the pillars (repo cache + branch + root)
.UNINDENT
.INDENT 7.0
.TP
.B update()
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.svn_pillar.ext_pillar(minion_id, pillar, repo_string)
Execute a command and read the output as YAML
.UNINDENT
.SS salt.pillar.varstack_pillar
.sp
Use \fI\%Varstack\fP data as a Pillar source
.SS Configuring Varstack
.sp
Using varstack in Salt is fairly simple. Just put the following into the
config file of your master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- varstack: /etc/varstack.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Varstack will then use /etc/varstack.yaml to determine which configuration
data to return as pillar information. From there you can take a look at the
\fI\%README\fP of
varstack on how this file is evaluated.
.INDENT 0.0
.TP
.B salt.pillar.varstack_pillar.ext_pillar(minion_id, pillar, conf)
Parse varstack data and return the result
.UNINDENT
.SS salt.pillar.vault
.sp
Vault Pillar Module
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
New
.TP
.B platform
all
.UNINDENT
.sp
New in version 2016.11.0.

.sp
This module allows pillar data to be stored in Hashicorp Vault.
.sp
Base configuration instructions are documented in the \fI\%execution module docs\fP\&.
Below are noted extra configuration required for the pillar module, but the base
configuration must also be completed.
.sp
After the base Vault configuration is created, add the configuration below to
the ext_pillar section in the Salt master configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- vault: path=secret/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Each key needs to have all the key\-value pairs with the names you
require. Avoid naming every key \(aqpassword\(aq as they will collide.
.sp
If you want to nest results under a nesting_key name use the following format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- vault:
      conf: path=secret/salt
      nesting_key: vault_key_name
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ vault write secret/salt auth=my_password master=127.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above will result in two pillars being available, \fBauth\fP and \fBmaster\fP\&.
.sp
You can then use normal pillar requests to get each key pair directly from
pillar root. Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-ssh \(aq*\(aq pillar.get auth
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple Vault sources may also be used:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- vault: path=secret/salt
  \- vault: path=secret/root
  \- vault: path=secret/minions/{minion}/pass
  \- vault: path=secret/roles/{pillar[roles]}/pass
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also use nesting here as well. Identical nesting keys will get merged.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- vault:
       conf: path=secret/salt
       nesting_key: keyname1
  \- vault:
       conf: path=secret/root
       nesting_key: keyname1
  \- vault:
       conf: path=secret/minions/{minion}/pass
       nesting_key: keyname2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The difference between the return with and without the nesting key is shown below.
This example takes the key value pairs returned from vault as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
path=secret/salt

Key             Value
\-\-\-             \-\-\-\-\-
salt\-passwd     badpasswd1

path=secret/root

Key             Value
\-\-\-             \-\-\-\-\-
root\-passwd     rootbadpasswd1

path=secret/minions/{minion}/pass

Key             Value
\-\-\-             \-\-\-\-\-
minion\-passwd   minionbadpasswd1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#Nesting Key not defined

local:
    \-\-\-\-\-\-\-\-\-\-
    salt\-passwd:
        badpasswd1
    root\-passwd:
        rootbadpasswd1
    minion\-passwd:
        minionbadpasswd1

#Nesting Key defined

local:
    \-\-\-\-\-\-\-\-\-\-
    keyname1:
        \-\-\-\-\-\-\-\-\-\-
            salt\-passwd:
                badpasswd1
            root\-passwd:
                rootbadpasswd1
    keyname2:
        \-\-\-\-\-\-\-\-\-\-
            minion\-passwd:
                minionbadpasswd1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3006.0: Pillar values from previously rendered pillars can be used to template
vault ext_pillar paths.

.sp
Using pillar values to template vault pillar paths requires them to be defined
before the vault ext_pillar is called. Especially consider the significancy
of \fI\%ext_pillar_first\fP master config setting.
You cannot use pillar values sourced from Vault in pillar\-templated policies.
.sp
If a pillar pattern matches multiple paths, the results are merged according to
the master configuration values \fI\%pillar_source_merging_strategy\fP
and \fI\%pillar_merge_lists\fP by default.
.sp
If the optional nesting_key was defined, the merged result will be nested below.
There is currently no way to nest multiple results under different keys.
.sp
You can override the merging behavior per defined ext_pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- vault:
       conf: path=secret/roles/{pillar[roles]}
       merge_strategy: smart
       merge_lists: false
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.vault.ext_pillar(minion_id, pillar, conf, nesting_key=None, merge_strategy=None, merge_lists=None, extra_minion_data=None)
Get pillar data from Vault for the configuration \fBconf\fP\&.
.UNINDENT
.SS salt.pillar.venafi
.sp
Venafi Pillar Certificates
.sp
This module will only return pillar data if the \fBvenafi\fP runner module has
already been used to create certificates.
.sp
To configure this module, set \fBvenafi\fP to \fBTrue\fP in the \fBext_pillar\fP
section of your \fBmaster\fP configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- venafi: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.venafi.ext_pillar(minion_id, pillar, conf)
Return an existing set of certificates
.UNINDENT
.SS salt.pillar.virtkey
.sp
Accept a key from a hypervisor if the virt runner has already submitted an authorization request
.INDENT 0.0
.TP
.B salt.pillar.virtkey.ext_pillar(hyper_id, pillar, name, key)
Accept the key for the VM on the hyper, if authorized.
.UNINDENT
.SS salt.pillar.vmware_pillar
.sp
Pillar data from vCenter or an ESXi host
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
pyVmomi
.UNINDENT
.UNINDENT
.sp
This external pillar can pull attributes from objects in vCenter or an ESXi host and provide those attributes
as pillar data to minions.  This can allow for pillar based targeting of minions on ESXi host, Datastore, VM
configuration, etc.  This setup requires only the salt master have access to the vCenter server/ESXi hosts.
.sp
The pillar will return an empty dict if the \(aqos\(aq or \(aqvirtual\(aq grain are not \(aqVMWare\(aq, \(aqESXi\(aq, or \(aqVMWare ESXi\(aq.
.SS Defaults
.INDENT 0.0
.IP \(bu 2
The external pillar will search for Virtual Machines with the VM name matching the minion id.
.IP \(bu 2
Data will be returned into the \(aqvmware\(aq pillar key.
.IP \(bu 2
The external pillar has a default set of properties to return for both VirtualMachine and HostSystem types.
.UNINDENT
.SS Configuring the VMWare pillar
.sp
The required minimal configuration in the salt master ext_pillar setup:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
    \- vmware:
        host: <vcenter/esx host>
        username: <user to connect with>
        password: <password>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Optionally, the following keyword arguments can be passed to the ext_pillar for customized configuration:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B pillar_key
Optionally set the pillar key to return the data into.  Default is \fBvmware\fP\&.
.TP
.B protocol
Optionally set to alternate protocol if the vCenter server or ESX/ESXi host is not
using the default protocol. Default protocol is \fBhttps\fP\&.
.TP
.B port
Optionally set to alternate port if the vCenter server or ESX/ESXi host is not
using the default port. Default port is \fB443\fP\&.
.TP
.B property_name
Property name to match the minion id against.  Defaults to \fBname\fP\&.
.TP
.B property_types
Optionally specify a list of pyVmomi vim types to search for the minion id in \(aqproperty_name\(aq.
Default is \fB[\(aqVirtualMachine\(aq]\fP\&.
.sp
For example, to search both vim.VirtualMachine and vim.HostSystem object types:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
    \- vmware:
        host: myesx
        username: root
        password: complex_password
        property_types:
          \- VirtualMachine
          \- HostSystem
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Additionally, the list of property types can be dicts, the item of the dict being a list specifying
the attribute to return for that vim object type.
.sp
The pillar will attempt to recurse the attribute and return all child attributes.
.sp
To explicitly specify deeper attributes without attempting to recurse an attribute, convert the list
item to a dict with the item of the dict being the child attributes to return.  Follow this pattern
to return attributes as deep within the object as necessary.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Be careful when specifying custom attributes!  Many attributes have objects as attributes which
have the parent object as an attribute and which will cause the pillar to fail due to the attempt
to convert all sub\-objects recursively (i.e. infinite attribute loops).  Specifying only the
sub\-attributes you would like returned will keep the infinite recursion from occurring.
.sp
A maximum recursion exception will occur in this case and the pillar will not return as desired.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
    \- vmware:
        host: myvcenter
        username: my_user
        password: my_pass
        replace_default_attributes: True
        property_types:
          \- VirtualMachine:
              \- config:
                 \- bootOptions:
                     \- bootDelay
                     \- bootRetryDelay
          \- HostSystem:
              \- datastore:
                 \- name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above ext_pillar example would return a pillar like the following for a VirtualMachine object that\(aqs
name matched the minion id:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
vmware:
  config:
    bootOptions:
      bootDelay: 1000
      bootRetryDelay: 1000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you were to retrieve these virtual machine attributes via pyVmomi directly, this would be the same as
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
vmObject.config.bootOptions.bootDelay
vmObject.config.bootOptionis.bootRetryDelay
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above ext_pillar example would return a pillar like the following for a HostySystem object that\(aqs name
matched the minion id:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
vmware:
  datastore:
     \- name: Datastore1
     \- name: Datastore2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \(aqdatastore\(aq property of a HostSystem object is a list of datastores, thus a list is returned.
.TP
.B replace_default_attributes
If custom attributes are specified by the property_types parameter, replace_default_attributes determines
if those will be added to default attributes (False) or replace the default attributes completely (True).
The default setting is \(aqFalse\(aq.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
vCenter \(dqCustom Attributes\(dq (i.e. Annotations) will always be returned if it exists on the object as
part of the pillar regardless of this setting.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.pillar.vmware_pillar.ext_pillar(minion_id, pillar, **kwargs)
Check vmware/vcenter for all data
.UNINDENT
.SS proxy modules
.TS
center;
|l|l|.
_
T{
\fI\%arista_pyeapi\fP
T}	T{
Arista pyeapi
T}
_
T{
\fI\%chronos\fP
T}	T{
Chronos
T}
_
T{
\fI\%cimc\fP
T}	T{
Proxy Minion interface module for managing Cisco Integrated Management Controller devices
T}
_
T{
\fI\%cisconso\fP
T}	T{
Proxy Minion interface module for managing (practically) any network device with Cisco Network Services Orchestrator (Cisco NSO).
T}
_
T{
\fI\%deltaproxy\fP
T}	T{
This is the \(dqmaster\(dq deltaproxy minion, known better as the \fIcontrol proxy\fP because it controls all the deltaproxies underneath it.
T}
_
T{
\fI\%docker\fP
T}	T{
T}
_
T{
\fI\%dummy\fP
T}	T{
This is the a dummy proxy\-minion designed for testing the proxy minion subsystem.
T}
_
T{
\fI\%esxcluster\fP
T}	T{
Proxy Minion interface module for managing VMWare ESXi clusters.
T}
_
T{
\fI\%esxdatacenter\fP
T}	T{
Proxy Minion interface module for managing VMWare ESXi clusters.
T}
_
T{
\fI\%esxi\fP
T}	T{
Proxy Minion interface module for managing VMware ESXi hosts.
T}
_
T{
\fI\%esxvm\fP
T}	T{
Proxy Minion interface module for managing VMWare ESXi virtual machines.
T}
_
T{
\fI\%fx2\fP
T}	T{
Dell FX2 chassis
T}
_
T{
\fI\%junos\fP
T}	T{
Interface with a Junos device via proxy\-minion.
T}
_
T{
\fI\%marathon\fP
T}	T{
Marathon
T}
_
T{
\fI\%napalm\fP
T}	T{
NAPALM: Network Automation and Programmability Abstraction Layer with Multivendor support
T}
_
T{
\fI\%netmiko_px\fP
T}	T{
Netmiko
T}
_
T{
\fI\%nxos\fP
T}	T{
Proxy Minion for Cisco NX\-OS Switches
T}
_
T{
\fI\%nxos_api\fP
T}	T{
Proxy Minion to manage Cisco Nexus Switches (NX\-OS) over the NX\-API
T}
_
T{
\fI\%panos\fP
T}	T{
Proxy Minion interface module for managing Palo Alto firewall devices
T}
_
T{
\fI\%philips_hue\fP
T}	T{
Philips HUE lamps module for proxy.
T}
_
T{
\fI\%rest_sample\fP
T}	T{
This is a simple proxy\-minion designed to connect to and communicate with the bottle\-based web service contained in \fI\%https://github.com/saltstack/salt\-contrib/tree/master/proxyminion_rest_example\fP
T}
_
T{
\fI\%restconf\fP
T}	T{
Proxy Minion to manage RESTCONF Devices
T}
_
T{
\fI\%ssh_sample\fP
T}	T{
This is a simple proxy\-minion designed to connect to and communicate with a server that exposes functionality via SSH.
T}
_
T{
\fI\%vcenter\fP
T}	T{
Proxy Minion interface module for managing VMWare vCenters.
T}
_
.TE
.SS salt.proxy.arista_pyeapi
.SS Arista pyeapi
.sp
New in version 2019.2.0.

.sp
Proxy module for managing Arista switches via the eAPI using the
\fI\%pyeapi\fP library.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP>
.TP
.B maturity
new
.TP
.B depends
pyeapi
.TP
.B platform
unix
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To understand how to correctly enable the eAPI on your switch, please check
\fI\%https://eos.arista.com/arista\-eapi\-101/\fP\&.
.UNINDENT
.UNINDENT
.SS Dependencies
.sp
The \fBpyeapi\fP Proxy module requires pyeapi to be installed:
\fBpip install pyeapi\fP\&.
.SS Pillar
.sp
The \fBpyeapi\fP proxy configuration requires the following parameters in order
to connect to the network device:
.INDENT 0.0
.TP
.B transport: \fBhttps\fP
Specifies the type of connection transport to use. Valid values for the
connection are \fBsocket\fP, \fBhttp_local\fP, \fBhttp\fP, and  \fBhttps\fP\&.
.TP
.B host: \fBlocalhost\fP
The IP address or DNS host name of the connection device.
.TP
.B username: \fBadmin\fP
The username to pass to the device to authenticate the eAPI connection.
.TP
.B password
The password to pass to the device to authenticate the eAPI connection.
.TP
.B port
The TCP port of the endpoint for the eAPI connection. If this keyword is
not specified, the default value is automatically determined by the
transport type (\fB80\fP for \fBhttp\fP, or \fB443\fP for \fBhttps\fP).
.TP
.B enablepwd
The enable mode password if required by the destination node.
.UNINDENT
.sp
All the arguments may be optional, depending on your setup.
.SS Proxy Pillar Example
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: pyeapi
  host: router1.example.com
  username: example
  password: example
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.arista_pyeapi.call(method, *args, **kwargs)
Calls an arbitrary pyeapi method.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.arista_pyeapi.conn()
Return the connection object.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.arista_pyeapi.init(opts)
Open the connection to the Arista switch over the eAPI.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.arista_pyeapi.initialized()
Connection finished initializing?
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.arista_pyeapi.ping()
Connection open successfully?
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.arista_pyeapi.shutdown(opts)
Closes connection with the device.
.UNINDENT
.SS salt.proxy.chronos
.SS Chronos
.sp
Proxy minion for managing a Chronos cluster.
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
\fI\%chronos execution module (salt.modules.chronos)\fP
.UNINDENT
.SS Pillar
.sp
The chronos proxy configuration requires a \(aqbase_url\(aq property that points to
the chronos endpoint:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: chronos
  base_url: http://my\-chronos\-master.mydomain.com:4400
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.2.

.INDENT 0.0
.TP
.B salt.proxy.chronos.init(opts)
Perform any needed setup.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.chronos.ping()
Is the chronos api responding?
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.chronos.shutdown(opts)
For this proxy shutdown is a no\-op
.UNINDENT
.SS salt.proxy.cimc
.SS Proxy Minion interface module for managing Cisco Integrated Management Controller devices
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B codeauthor
\fBSpencer Ervin <spencer_ervin@hotmail.com>\fP
.TP
.B maturity
new
.TP
.B depends
none
.TP
.B platform
unix
.UNINDENT
.sp
This proxy minion enables Cisco Integrated Management Controller devices (hereafter referred to
as simply \(aqcimc\(aq devices to be treated individually like a Salt Minion.
.sp
The cimc proxy leverages the XML API functionality on the Cisco Integrated Management Controller.
The Salt proxy must have access to the cimc on HTTPS (tcp/443).
.sp
More in\-depth conceptual reading on Proxy Minions can be found in the
\fI\%Proxy Minion\fP section of Salt\(aqs
documentation.
.SS Configuration
.sp
To use this integration proxy module, please configure the following:
.SS Pillar
.sp
Proxy minions get their configuration from Salt\(aqs Pillar. Every proxy must
have a stanza in Pillar and a reference in the Pillar top\-file that matches
the ID.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: cimc
  host: <ip or dns name of cimc host>
  username: <cimc username>
  password: <cimc password>
  verify_ssl: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS proxytype
.sp
The \fBproxytype\fP key and value pair is critical, as it tells Salt which
interface to load from the \fBproxy\fP directory in Salt\(aqs install hierarchy,
or from \fB/srv/salt/_proxy\fP on the Salt Master (if you have created your
own proxy module, for example). To use this cimc Proxy Module, set this to
\fBcimc\fP\&.
.SS host
.sp
The location, or ip/dns, of the cimc host. Required.
.SS username
.sp
The username used to login to the cimc host. Required.
.SS password
.sp
The password used to login to the cimc host. Required.
.INDENT 0.0
.TP
.B salt.proxy.cimc.get_config_resolver_class(cid=None, hierarchical=False)
The configResolveClass method returns requested managed object in a given class.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cimc.grains()
Get the grains from the proxied device
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cimc.grains_refresh()
Refresh the grains from the proxied device
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cimc.init(opts)
This function gets called when the proxy starts up.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cimc.initialized()
Since grains are loaded in many different places and some of those
places occur before the proxy can be initialized, return whether
our init() function has been called
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cimc.logon()
Logs into the cimc device and returns the session cookie.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cimc.logout(cookie=None)
Closes the session with the device.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cimc.ping()
Returns true if the device is reachable, else false.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cimc.prepare_return(x)
Converts the etree to dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cimc.set_config_modify(dn=None, inconfig=None, hierarchical=False)
The configConfMo method configures the specified managed object in a single subtree (for example, DN).
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cimc.shutdown()
Shutdown the connection to the proxy device. For this proxy,
shutdown is a no\-op.
.UNINDENT
.SS salt.proxy.cisconso
.sp
Proxy Minion interface module for managing (practically) any network device with
Cisco Network Services Orchestrator (Cisco NSO). Cisco NSO uses a series of
remote polling
agents, APIs and SSH commands to fetch network configuration and represent
it in a data model.
PyNSO, the Python module used by this proxy minion does the task of converting
native Python dictionaries
into NETCONF/YANG syntax that the REST API for Cisco NSO can then use to set
the configuration of the target
network device.
.INDENT 0.0
.TP
.B Supported devices:
.INDENT 7.0
.IP \(bu 2
A10 AX Series
.IP \(bu 2
Arista 7150 Series
.IP \(bu 2
Ciena 3000, 5000, ESM
.IP \(bu 2
H3c S5800 Series
.IP \(bu 2
Overture 1400, 2200, 5000, 5100, 6000
.IP \(bu 2
Accedian MetroNID
.IP \(bu 2
Avaya ERS 4000, SR8000, VSP 9000
.IP \(bu 2
.INDENT 2.0
.TP
.B Cisco: APIC\-DC, ASA, IOS, IOS XE, IOS XR, er, ME\-4600, NX OS,
Prime Network Registrar, Quantum, StarOS, UCS ManagWSA
.UNINDENT
.IP \(bu 2
Huawei: NE40E, quidway series, Enterprise Network Simulation Framework
.IP \(bu 2
PaloAlto PA\-2000, PA\-3000, Virtualized Firewalls
.IP \(bu 2
Adtran 900 Series
.IP \(bu 2
Brocade ADX, MLX, Netiron, Vyatta
.IP \(bu 2
Dell Force 10 Networking S\-Series
.IP \(bu 2
Infinera DTN\-X Multi\-Terabit Packet Optical Network Platform
.IP \(bu 2
Pulsecom SuperG
.IP \(bu 2
Adva 150CC Series
.IP \(bu 2
CableLabs Converged Cable Access Platform
.IP \(bu 2
Ericsson EFN324 Series, SE family
.IP \(bu 2
Juniper: Contrail, EX, M, MX, QFX, SRX, Virtual SRX
.IP \(bu 2
Quagga Routing Software
.IP \(bu 2
Affirmed Networks
.IP \(bu 2
Citrix Netscaler
.IP \(bu 2
F5 BIG\-IP
.IP \(bu 2
NEC iPasolink
.IP \(bu 2
Riverbed Steelhead Series
.IP \(bu 2
Alcatel\-Lucent 7XXX, SAM
.IP \(bu 2
Clavister
.IP \(bu 2
Fortinet
.IP \(bu 2
Nominum DCS
.IP \(bu 2
Sonus SBC 5000 Series
.IP \(bu 2
Allied Telesys
.IP \(bu 2
Open vSwitch
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B codeauthor
\fIAnthony Shaw <anthony.shaw@dimensiondata.com>\fP
.UNINDENT
.sp
This proxy minion enables a consistent interface to fetch, control and maintain
the configuration of network devices via a NETCONF\-compliant control plane.
Cisco Network Services Orchestrator.
.sp
More in\-depth conceptual reading on Proxy Minions can be found in the
\fI\%Proxy Minion\fP section of Salt\(aqs
documentation.
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
pynso Python module
.UNINDENT
.SS PyNSO
.sp
PyNSO can be installed via pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pynso
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configuration
.sp
To use this integration proxy module, please configure the following:
.SS Pillar
.sp
Proxy minions get their configuration from Salt\(aqs Pillar. Every proxy must
have a stanza in Pillar and a reference in the Pillar top\-file that matches
the ID. At a minimum for communication with the NSO host, the pillar should
look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: cisconso
  host: <ip or dns name of host>
  port: 8080
  use_ssl: false
  username: <username>
  password: password
.ft P
.fi
.UNINDENT
.UNINDENT
.SS proxytype
.sp
The \fBproxytype\fP key and value pair is critical, as it tells Salt which
interface to load from the \fBproxy\fP directory in Salt\(aqs install hierarchy,
or from \fB/srv/salt/_proxy\fP on the Salt Master (if you have created your
own proxy module, for example). To use this Cisco NSO Proxy Module, set this to
\fBcisconso\fP\&.
.SS host
.sp
The location, or IP/dns, of the Cisco NSO API host. Required.
.SS username
.sp
The username used to login to the Cisco NSO host, such as \fBadmin\fP\&. Required.
.SS passwords
.sp
The password for the given user. Required.
.SS use_ssl
.sp
Whether to use HTTPS messaging to speak to the API.
.SS port
.sp
The port that the Cisco NSO API is running on, 8080 by default
.SS Salt Proxy
.sp
After your pillar is in place, you can test the proxy. The proxy can run on
any machine that has network connectivity to your Salt Master and to the
Cisco NSO host in question. SaltStack recommends that the machine running the
salt\-proxy process also run a regular minion, though it is not strictly
necessary.
.sp
On the machine that will run the proxy, make sure
there is an \fB/etc/salt/proxy\fP
file with at least the following in it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: <ip or hostname of salt\-master>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can then start the salt\-proxy process with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid <id you want to give the host>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You may want to add \fB\-l debug\fP to run the above in the foreground in
debug mode just to make sure everything is OK.
.sp
Next, accept the key for the proxy on your salt\-master, just like you
would for a regular minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-a <id you gave the cisconso host>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can confirm that the pillar data is in place for the proxy:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt <id> pillar.items
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And now you should be able to ping the Cisco NSO host to make sure it is
responding:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt <id> test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cisconso.apply_rollback(datastore, name)
Apply a system rollback
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdatastore\fP (\fBDatastoreType\fP (\fBstr\fP enum).) \-\- The datastore, e.g. running, operational.
One of the NETCONF store IETF types
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- an ID of the rollback to restore
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cisconso.get_data(datastore, path)
Get the configuration of the device tree at the given path
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdatastore\fP (\fBDatastoreType\fP (\fBstr\fP enum).) \-\- The datastore, e.g. running, operational.
One of the NETCONF store IETF types
.IP \(bu 2
\fBpath\fP (\fBlist\fP of \fBstr\fP OR \fBtuple\fP) \-\- The device path, a list of element names in order,
comma separated
.UNINDENT
.TP
.B Returns
The network configuration at that tree
.TP
.B Return type
\fBdict\fP
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt cisco\-nso cisconso.get_data devices
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cisconso.get_rollback(name)
Get the backup of stored a configuration rollback
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fBstr\fP) \-\- Typically an ID of the backup
.TP
.B Return type
\fBstr\fP
.TP
.B Returns
the contents of the rollback snapshot
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cisconso.get_rollbacks()
Get a list of stored configuration rollbacks
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cisconso.grains()
Get the grains from the proxy device.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cisconso.init(opts)
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cisconso.ping()
Check to see if the host is responding. Returns False if the host didn\(aqt
respond, True otherwise.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt cisco\-nso test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cisconso.set_data_value(datastore, path, data)
Get a data entry in a datastore
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdatastore\fP (\fBDatastoreType\fP (\fBstr\fP enum).) \-\- The datastore, e.g. running, operational.
One of the NETCONF store IETF types
.IP \(bu 2
\fBpath\fP (\fBlist\fP of \fBstr\fP OR \fBtuple\fP) \-\- The device path to set the value at,
a list of element names in order, comma separated
.IP \(bu 2
\fBdata\fP (\fBdict\fP) \-\- The new value at the given path
.UNINDENT
.TP
.B Return type
\fBbool\fP
.TP
.B Returns
\fBTrue\fP if successful, otherwise error.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.cisconso.shutdown()
Shutdown the connection to the proxy device. For this proxy,
shutdown is a no\-op.
.UNINDENT
.SS salt.proxy.deltaproxy
.sp
This is the \(dqmaster\(dq deltaproxy minion, known better as the \fIcontrol proxy\fP because
it controls all the deltaproxies underneath it.
.INDENT 0.0
.TP
.B salt.proxy.deltaproxy.grains()
Make up some grains
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.deltaproxy.grains_refresh()
Refresh the grains
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.deltaproxy.init(opts)
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.deltaproxy.initialized()
Since grains are loaded in many different places and some of those ws
places occur before the proxy can be initialized, return whether
our init() function has been called
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.deltaproxy.ping()
Degenerate ping
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.deltaproxy.shutdown(opts)
For this proxy shutdown is a no\-op
.UNINDENT
.SS salt.proxy.docker
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%docker Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Docker Proxy Minion
.sp
New in version 2019.2.0.

.INDENT 0.0
.TP
.B depends
docker
.UNINDENT
.sp
This proxy minion is just a shim to the docker executor, which will use the
\fI\%docker.call\fP for everything except
state runs.
.sp
To configure the proxy minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: docker
  name: festive_leakey
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is also possible to just name the proxy minion the same name as the
container, and use grains to configure the proxy minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
    proxytype: docker
    name: {{grains[\(aqid\(aq]}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
name
.INDENT 0.0
.INDENT 3.5
Name of the docker container
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.docker.init(opts)
Always initialize
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.docker.initialized()
This should always be initialized
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.docker.module_executors()
List of module executors to use for this Proxy Minion
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.docker.shutdown(opts)
Nothing needs to be done to shutdown
.UNINDENT
.SS salt.proxy.dummy
.sp
This is the a dummy proxy\-minion designed for testing the proxy minion subsystem.
.INDENT 0.0
.TP
.B salt.proxy.dummy.fns()
Method called by grains module.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.grains()
Make up some grains
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.grains_refresh()
Refresh the grains
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.init(opts)
Required.
Can be used to initialize the server connection.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.initialized()
Since grains are loaded in many different places and some of those
places occur before the proxy can be initialized, return whether
our init() function has been called
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.package_install(name, **kwargs)
Install a \(dqpackage\(dq on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.package_list()
List \(dqpackages\(dq installed on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.package_remove(name)
Remove a \(dqpackage\(dq on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.package_status(name)
Check the installation status of a package on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.ping()
Degenerate ping
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.service_list()
List \(dqservices\(dq on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.service_restart(name)
Restart a \(dqservice\(dq on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.service_start(name)
Start a \(dqservice\(dq on the dummy server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.service_status(name)
Check if a service is running on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.service_stop(name)
Stop a \(dqservice\(dq on the dummy server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.shutdown(opts)
For this proxy shutdown is a no\-op
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.test_from_state()
Test function so we have something to call from a state
:return:
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.upgrade()
\(dqUpgrade\(dq packages
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.dummy.uptodate()
Call the REST endpoint to see if the packages on the \(dqserver\(dq are up to date.
.UNINDENT
.SS salt.proxy.esxcluster
.sp
Proxy Minion interface module for managing VMWare ESXi clusters.
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
pyVmomi
.IP \(bu 2
jsonschema
.UNINDENT
.SS Configuration
.sp
To use this integration proxy module, please configure the following:
.SS Pillar
.sp
Proxy minions get their configuration from Salt\(aqs Pillar. This can now happen
from the proxy\(aqs configuration file.
.sp
Example pillars:
.sp
\fBuserpass\fP mechanism:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: esxcluster
  cluster: <cluster name>
  datacenter: <datacenter name>
  vcenter: <ip or dns name of parent vcenter>
  mechanism: userpass
  username: <vCenter username>
  passwords: (required if userpass is used)
    \- first_password
    \- second_password
    \- third_password
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBsspi\fP mechanism:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: esxcluster
  cluster: <cluster name>
  datacenter: <datacenter name>
  vcenter: <ip or dns name of parent vcenter>
  mechanism: sspi
  domain: <user domain>
  principal: <host kerberos principal>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS proxytype
.sp
To use this Proxy Module, set this to \fBesxdatacenter\fP\&.
.SS cluster
.sp
Name of the managed cluster. Required.
.SS datacenter
.sp
Name of the datacenter the managed cluster is in. Required.
.SS vcenter
.sp
The location of the VMware vCenter server (host of ip) where the datacenter
should be managed. Required.
.SS mechanism
.sp
The mechanism used to connect to the vCenter server. Supported values are
\fBuserpass\fP and \fBsspi\fP\&. Required.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Connections are attempted using all (\fBusername\fP, \fBpassword\fP)
combinations on proxy startup.
.UNINDENT
.UNINDENT
.SS username
.sp
The username used to login to the host, such as \fBroot\fP\&. Required if mechanism
is \fBuserpass\fP\&.
.SS passwords
.sp
A list of passwords to be used to try and login to the vCenter server. At least
one password in this list is required if mechanism is \fBuserpass\fP\&.  When the
proxy comes up, it will try the passwords listed in order.
.SS domain
.sp
User domain. Required if mechanism is \fBsspi\fP\&.
.SS principal
.sp
Kerberos principal. Rquired if mechanism is \fBsspi\fP\&.
.SS protocol
.sp
If the ESXi host is not using the default protocol, set this value to an
alternate protocol. Default is \fBhttps\fP\&.
.SS port
.sp
If the ESXi host is not using the default port, set this value to an
alternate port. Default is \fB443\fP\&.
.SS Salt Proxy
.sp
After your pillar is in place, you can test the proxy. The proxy can run on
any machine that has network connectivity to your Salt Master and to the
vCenter server in the pillar. SaltStack recommends that the machine running the
salt\-proxy process also run a regular minion, though it is not strictly
necessary.
.sp
To start a proxy minion one needs to establish its identity <id>:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid <proxy_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
On the machine that will run the proxy, make sure there is a configuration file
present. By default this is \fB/etc/salt/proxy\fP\&. If in a different location, the
\fB<configuration_folder>\fP has to be specified when running the proxy:
file with at least the following in it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid <proxy_id> \-c <configuration_folder>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Commands
.sp
Once the proxy is running it will connect back to the specified master and
individual commands can be runs against it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Master \- minion communication
salt <cluster_name> test.ping

# Test vcenter connection
salt <cluster_name> vsphere.test_vcenter_connection
.ft P
.fi
.UNINDENT
.UNINDENT
.SS States
.sp
Associated states are documented in
\fBsalt.states.esxcluster\fP\&.
Look there to find an example structure for Pillar as well as an example
\fB\&.sls\fP file for configuring an ESX cluster from scratch.
.INDENT 0.0
.TP
.B salt.proxy.esxcluster.find_credentials()
Cycle through all the possible credentials and return the first one that
works.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxcluster.get_details()
Function that returns the cached details
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxcluster.init(opts)
This function gets called when the proxy starts up. For
login
the protocol and port are cached.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxcluster.ping()
Returns True.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt esx\-cluster test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxcluster.shutdown()
Shutdown the connection to the proxy device. For this proxy,
shutdown is a no\-op.
.UNINDENT
.SS salt.proxy.esxdatacenter
.sp
Proxy Minion interface module for managing VMWare ESXi clusters.
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
pyVmomi
.IP \(bu 2
jsonschema
.UNINDENT
.SS Configuration
.sp
To use this integration proxy module, please configure the following:
.SS Pillar
.sp
Proxy minions get their configuration from Salt\(aqs Pillar. This can now happen
from the proxy\(aqs configuration file.
.sp
Example pillars:
.sp
\fBuserpass\fP mechanism:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: esxdatacenter
  datacenter: <datacenter name>
  vcenter: <ip or dns name of parent vcenter>
  mechanism: userpass
  username: <vCenter username>
  passwords: (required if userpass is used)
    \- first_password
    \- second_password
    \- third_password
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBsspi\fP mechanism:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: esxdatacenter
  datacenter: <datacenter name>
  vcenter: <ip or dns name of parent vcenter>
  mechanism: sspi
  domain: <user domain>
  principal: <host kerberos principal>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS proxytype
.sp
To use this Proxy Module, set this to \fBesxdatacenter\fP\&.
.SS datacenter
.sp
Name of the managed datacenter. Required.
.SS vcenter
.sp
The location of the VMware vCenter server (host of ip) where the datacenter
should be managed. Required.
.SS mechanism
.sp
The mechanism used to connect to the vCenter server. Supported values are
\fBuserpass\fP and \fBsspi\fP\&. Required.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Connections are attempted using all (\fBusername\fP, \fBpassword\fP)
combinations on proxy startup.
.UNINDENT
.UNINDENT
.SS username
.sp
The username used to login to the host, such as \fBroot\fP\&. Required if mechanism
is \fBuserpass\fP\&.
.SS passwords
.sp
A list of passwords to be used to try and login to the vCenter server. At least
one password in this list is required if mechanism is \fBuserpass\fP\&.  When the
proxy comes up, it will try the passwords listed in order.
.SS domain
.sp
User domain. Required if mechanism is \fBsspi\fP\&.
.SS principal
.sp
Kerberos principal. Rquired if mechanism is \fBsspi\fP\&.
.SS protocol
.sp
If the ESXi host is not using the default protocol, set this value to an
alternate protocol. Default is \fBhttps\fP\&.
.SS port
.sp
If the ESXi host is not using the default port, set this value to an
alternate port. Default is \fB443\fP\&.
.SS Salt Proxy
.sp
After your pillar is in place, you can test the proxy. The proxy can run on
any machine that has network connectivity to your Salt Master and to the
vCenter server in the pillar. SaltStack recommends that the machine running the
salt\-proxy process also run a regular minion, though it is not strictly
necessary.
.sp
To start a proxy minion one needs to establish its identity <id>:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid <proxy_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
On the machine that will run the proxy, make sure there is a configuration file
present. By default this is \fB/etc/salt/proxy\fP\&. If in a different location, the
\fB<configuration_folder>\fP has to be specified when running the proxy:
file with at least the following in it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid <proxy_id> \-c <configuration_folder>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Commands
.sp
Once the proxy is running it will connect back to the specified master and
individual commands can be runs against it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Master \- minion communication
salt <datacenter_name> test.ping

# Test vcenter connection
salt <datacenter_name> vsphere.test_vcenter_connection
.ft P
.fi
.UNINDENT
.UNINDENT
.SS States
.sp
Associated states are documented in
\fBsalt.states.esxdatacenter\fP\&.
Look there to find an example structure for Pillar as well as an example
\fB\&.sls\fP file for configuring an ESX datacenter from scratch.
.INDENT 0.0
.TP
.B salt.proxy.esxdatacenter.find_credentials()
Cycle through all the possible credentials and return the first one that
works.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxdatacenter.get_details()
Function that returns the cached details
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxdatacenter.init(opts)
This function gets called when the proxy starts up.
All login details are cached.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxdatacenter.ping()
Returns True.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt dc_id test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxdatacenter.shutdown()
Shutdown the connection to the proxy device. For this proxy,
shutdown is a no\-op.
.UNINDENT
.SS salt.proxy.esxi
.sp
Proxy Minion interface module for managing VMware ESXi hosts.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be deprecated in a future release of Salt. VMware strongly
recommends using the
\fI\%VMware Salt extensions\fP
instead of the ESXi module. Because the Salt extensions are newer and
actively supported by VMware, they are more compatible with current versions
of ESXi and they work well with the latest features in the VMware product
line.
.UNINDENT
.UNINDENT
.sp
\fBSpecial Note: SaltStack thanks\fP \fI\%Adobe Corporation\fP
\fBfor their support in creating this Proxy Minion integration.\fP
.sp
This proxy minion enables VMware ESXi (hereafter referred to as simply \(aqESXi\(aq)
hosts to be treated individually like a Salt Minion.
.sp
Since the ESXi host may not necessarily run on an OS capable of hosting a
Python stack, the ESXi host can\(aqt run a Salt Minion directly. Salt\(aqs
\(dqProxy Minion\(dq functionality enables you to designate another machine to host
a minion process that \(dqproxies\(dq communication from the Salt Master. The master
does not know nor care that the target is not a \(dqreal\(dq Salt Minion.
.sp
More in\-depth conceptual reading on Proxy Minions can be found in the
\fI\%Proxy Minion\fP section of Salt\(aqs
documentation.
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
pyVmomi Python Module
.IP \(bu 2
ESXCLI
.UNINDENT
.SS pyVmomi
.sp
PyVmomi can be installed via pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Version 6.0 of pyVmomi has some problems with SSL error handling on certain
versions of Python. If using version 6.0 of pyVmomi, Python 2.6,
Python 2.7.9, or newer must be present. This is due to an upstream dependency
in pyVmomi 6.0 that is not supported in Python versions 2.7 to 2.7.8. If the
version of Python is not in the supported range, you will need to install an
earlier version of pyVmomi. See \fI\%Issue #29537\fP for more information.
.UNINDENT
.UNINDENT
.sp
Based on the note above, to install an earlier version of pyVmomi than the
version currently listed in PyPi, run the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi==5.5.0.2014.1.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The 5.5.0.2014.1.1 is a known stable version that this original ESXi State
Module was developed against.
.SS ESXCLI
.sp
Currently, about a third of the functions used in the vSphere Execution Module require
the ESXCLI package be installed on the machine running the Proxy Minion process.
.sp
The ESXCLI package is also referred to as the VMware vSphere CLI, or vCLI. VMware
provides vCLI package installation instructions for \fI\%vSphere 5.5\fP and
\fI\%vSphere 6.0\fP\&.
.sp
Once all of the required dependencies are in place and the vCLI package is
installed, you can check to see if you can connect to your ESXi host or vCenter
server by running the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
esxcli \-s <host\-location> \-u <username> \-p <password> system syslog config get
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the connection was successful, ESXCLI was successfully installed on your system.
You should see output related to the ESXi host\(aqs syslog configuration.
.SS Configuration
.sp
To use this integration proxy module, please configure the following:
.SS Pillar
.sp
Proxy minions get their configuration from Salt\(aqs Pillar. Every proxy must
have a stanza in Pillar and a reference in the Pillar top\-file that matches
the ID. At a minimum for communication with the ESXi host, the pillar should
look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: esxi
  host: <ip or dns name of esxi host>
  username: <ESXi username>
  passwords:
    \- first_password
    \- second_password
    \- third_password
  credstore: <path to credential store>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS proxytype
.sp
The \fBproxytype\fP key and value pair is critical, as it tells Salt which
interface to load from the \fBproxy\fP directory in Salt\(aqs install hierarchy,
or from \fB/srv/salt/_proxy\fP on the Salt Master (if you have created your
own proxy module, for example). To use this ESXi Proxy Module, set this to
\fBesxi\fP\&.
.SS host
.sp
The location, or ip/dns, of the ESXi host. Required.
.SS username
.sp
The username used to login to the ESXi host, such as \fBroot\fP\&. Required.
.SS passwords
.sp
A list of passwords to be used to try and login to the ESXi host. At least
one password in this list is required.
.sp
The proxy integration will try the passwords listed in order. It is
configured this way so you can have a regular password and the password you
may be updating for an ESXi host either via the
\fI\%vsphere.update_host_password\fP
execution module function or via the
\fI\%esxi.password_present\fP state
function. This way, after the password is changed, you should not need to
restart the proxy minion\-\-it should just pick up the new password
provided in the list. You can then change pillar at will to move that
password to the front and retire the unused ones.
.sp
This also allows you to use any number of potential fallback passwords.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When a password is changed on the host to one in the list of possible
passwords, the further down on the list the password is, the longer
individual commands will take to return. This is due to the nature of
pyVmomi\(aqs login system. We have to wait for the first attempt to fail
before trying the next password on the list.
.sp
This scenario is especially true, and even slower, when the proxy
minion first starts. If the correct password is not the first password
on the list, it may take up to a minute for \fBtest.ping\fP to respond
with a \fBTrue\fP result. Once the initial authorization is complete, the
responses for commands will be a little faster.
.sp
To avoid these longer waiting periods, SaltStack recommends moving the
correct password to the top of the list and restarting the proxy minion
at your earliest convenience.
.UNINDENT
.UNINDENT
.SS protocol
.sp
If the ESXi host is not using the default protocol, set this value to an
alternate protocol. Default is \fBhttps\fP\&.
.SS port
.sp
If the ESXi host is not using the default port, set this value to an
alternate port. Default is \fB443\fP\&.
.SS credstore
.sp
If the ESXi host is using an untrusted SSL certificate, set this value to
the file path where the credential store is located. This file is passed to
\fBesxcli\fP\&. Default is \fB<HOME>/.vmware/credstore/vicredentials.xml\fP on Linux
and \fB<APPDATA>/VMware/credstore/vicredentials.xml\fP on Windows.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBHOME\fP variable is sometimes not set for processes running as system
services. If you want to rely on the default credential store location,
make sure \fBHOME\fP is set for the proxy process.
.UNINDENT
.UNINDENT
.SS Salt Proxy
.sp
After your pillar is in place, you can test the proxy. The proxy can run on
any machine that has network connectivity to your Salt Master and to the
ESXi host in question. SaltStack recommends that the machine running the
salt\-proxy process also run a regular minion, though it is not strictly
necessary.
.sp
On the machine that will run the proxy, make sure there is an \fB/etc/salt/proxy\fP
file with at least the following in it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: <ip or hostname of salt\-master>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can then start the salt\-proxy process with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid <id you want to give the host>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You may want to add \fB\-l debug\fP to run the above in the foreground in
debug mode just to make sure everything is OK.
.sp
Next, accept the key for the proxy on your salt\-master, just like you
would for a regular minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-a <id you gave the esxi host>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can confirm that the pillar data is in place for the proxy:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt <id> pillar.items
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And now you should be able to ping the ESXi host to make sure it is
responding:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt <id> test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
At this point you can execute one\-off commands against the host. For
example, you can get the ESXi host\(aqs system information:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt <id> esxi.cmd system_info
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that you don\(aqt need to provide credentials or an ip/hostname. Salt
knows to use the credentials you stored in Pillar.
.sp
It\(aqs important to understand how this particular proxy works.
\fI\%Salt.modules.vsphere\fP is a
standard Salt execution module. If you pull up the docs for it you\(aqll see
that almost every function in the module takes credentials and a target
host. When credentials and a host aren\(aqt passed, Salt runs commands
through \fBpyVmomi\fP against the local machine. If you wanted, you could run
functions from this module on any host where an appropriate version of
\fBpyVmomi\fP is installed, and that host would reach out over the network
and communicate with the ESXi host.
.sp
\fBesxi.cmd\fP acts as a \(dqshim\(dq between the execution module and the proxy. Its
first parameter is always the function from salt.modules.vsphere. If the
function takes more positional or keyword arguments you can append them to the
call. It\(aqs this shim that speaks to the ESXi host through the proxy, arranging
for the credentials and hostname to be pulled from the Pillar section for this
Proxy Minion.
.sp
Because of the presence of the shim, to lookup documentation for what
functions you can use to interface with the ESXi host, you\(aqll want to
look in \fI\%salt.modules.vsphere\fP
instead of \fI\%salt.modules.esxi\fP\&.
.SS States
.sp
Associated states are thoroughly documented in
\fI\%salt.states.esxi\fP\&. Look there
to find an example structure for Pillar as well as an example \fB\&.sls\fP file
for standing up an ESXi host from scratch.
.INDENT 0.0
.TP
.B salt.proxy.esxi.ch_config(cmd, *args, **kwargs)
This function is called by the
\fI\%salt.modules.esxi.cmd\fP shim.
It then calls whatever is passed in \fBcmd\fP inside the
\fI\%salt.modules.vsphere\fP module.
Passes the return through from the vsphere module.
.INDENT 7.0
.TP
.B cmd
The command to call inside salt.modules.vsphere
.TP
.B args
Arguments that need to be passed to that command.
.TP
.B kwargs
Keyword arguments that need to be passed to that command.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxi.find_credentials(host)
Cycle through all the possible credentials and return the first one that
works.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxi.get_details()
Return the proxy details
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxi.grains()
Get the grains from the proxy device.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxi.grains_refresh()
Refresh the grains from the proxy device.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxi.init(opts)
This function gets called when the proxy starts up. For
ESXi devices, the host, login credentials, and, if configured,
the protocol and port are cached.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxi.is_connected_via_vcenter()
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxi.ping()
Returns True if connection is to be done via a vCenter (no connection is attempted).
Check to see if the host is responding when connecting directly via an ESXi
host.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt esxi\-host test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxi.shutdown()
Shutdown the connection to the proxy device. For this proxy,
shutdown is a no\-op.
.UNINDENT
.SS salt.proxy.esxvm
.sp
Proxy Minion interface module for managing VMWare ESXi virtual machines.
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
pyVmomi
.IP \(bu 2
jsonschema
.UNINDENT
.SS Configuration
.sp
To use this integration proxy module, please configure the following:
.SS Pillar
.sp
Proxy minions get their configuration from Salt\(aqs Pillar. This can now happen
from the proxy\(aqs configuration file.
.sp
Example pillars:
.sp
\fBuserpass\fP mechanism:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: esxvm
  datacenter: <datacenter name>
  vcenter: <ip or dns name of parent vcenter>
  mechanism: userpass
  username: <vCenter username>
  passwords: (required if userpass is used)
    \- first_password
    \- second_password
    \- third_password
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBsspi\fP mechanism:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: esxvm
  datacenter: <datacenter name>
  vcenter: <ip or dns name of parent vcenter>
  mechanism: sspi
  domain: <user domain>
  principal: <host kerberos principal>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS proxytype
.sp
To use this Proxy Module, set this to \fBesxvm\fP\&.
.SS datacenter
.sp
Name of the datacenter where the virtual machine should be deployed. Required.
.SS vcenter
.sp
The location of the VMware vCenter server (host of ip) where the virtual
machine should be managed. Required.
.SS mechanism
.sp
The mechanism used to connect to the vCenter server. Supported values are
\fBuserpass\fP and \fBsspi\fP\&. Required.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Connections are attempted using all (\fBusername\fP, \fBpassword\fP)
combinations on proxy startup.
.UNINDENT
.UNINDENT
.SS username
.sp
The username used to login to the host, such as \fBroot\fP\&. Required if mechanism
is \fBuserpass\fP\&.
.SS passwords
.sp
A list of passwords to be used to try and login to the vCenter server. At least
one password in this list is required if mechanism is \fBuserpass\fP\&.  When the
proxy comes up, it will try the passwords listed in order.
.SS domain
.sp
User realm domain. Required if mechanism is \fBsspi\fP\&.
.SS principal
.sp
Kerberos principal. Rquired if mechanism is \fBsspi\fP\&.
.SS protocol
.sp
If the ESXi host is not using the default protocol, set this value to an
alternate protocol. Default is \fBhttps\fP\&.
.SS port
.sp
If the ESXi host is not using the default port, set this value to an
alternate port. Default is \fB443\fP\&.
.SS Salt Proxy
.sp
After your pillar is in place, you can test the proxy. The proxy can run on
any machine that has network connectivity to your Salt Master and to the
vCenter server in the pillar. SaltStack recommends that the machine running the
salt\-proxy process also run a regular minion, though it is not strictly
necessary.
.sp
To start a proxy minion one needs to establish its identity <id>:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid <proxy_id>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
On the machine that will run the proxy, make sure there is a configuration file
present. By default this is \fB/etc/salt/proxy\fP\&. If in a different location, the
\fB<configuration_folder>\fP has to be specified when running the proxy:
file with at least the following in it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid <proxy_id> \-c <configuration_folder>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Commands
.sp
Once the proxy is running it will connect back to the specified master and
individual commands can be runs against it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Master \- minion communication
salt <proxy_id> test.ping

# Test vcenter connection
salt <proxy_id> vsphere.test_vcenter_connection
.ft P
.fi
.UNINDENT
.UNINDENT
.SS States
.sp
Associated states are documented in
\fBsalt.states.esxvm\fP\&.
Look there to find an example structure for Pillar as well as an example
\fB\&.sls\fP file for configuring an ESX virtual machine from scratch.
.INDENT 0.0
.TP
.B salt.proxy.esxvm.find_credentials()
Cycle through all the possible credentials and return the first one that
works.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxvm.get_details()
Function that returns the cached details
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxvm.init(opts)
This function gets called when the proxy starts up. For
login the protocol and port are cached.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxvm.ping()
Returns True.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt esx\-vm test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.esxvm.shutdown()
Shutdown the connection to the proxy device. For this proxy,
shutdown is a no\-op.
.UNINDENT
.SS salt.proxy.fx2
.SS Dell FX2 chassis
.sp
New in version 2015.8.2.

.sp
Proxy minion interface module for managing Dell FX2 chassis (Dell
Chassis Management Controller version 1.2 and above, iDRAC8 version 2.00
and above)
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
\fI\%iDRAC Remote execution module (salt.modules.dracr)\fP
.IP \(bu 2
\fI\%Chassis command shim (salt.modules.chassis)\fP
.IP \(bu 2
\fI\%Dell Chassis States (salt.states.dellchassis)\fP
.IP \(bu 2
Dell\(aqs \fBracadm\fP command line interface to CMC and iDRAC devices.
.UNINDENT
.sp
\fBSpecial Note: SaltStack thanks\fP \fI\%Adobe Corporation\fP
\fBfor their support in creating this proxy minion integration.\fP
.sp
This proxy minion enables Dell FX2 and FX2s (hereafter referred to as
simply \(dqchassis\(dq, \(dqCMC\(dq, or \(dqFX2\(dq) chassis to be treated individually
like a salt\-minion.
.sp
Since the CMC embedded in the chassis does not run an OS capable of hosting a
Python stack, the chassis can\(aqt run a minion directly.  Salt\(aqs \(dqProxy Minion\(dq
functionality enables you to designate another machine to host a minion
process that \(dqproxies\(dq communication from the salt\-master.  The master does not
know nor care that the target is not a real minion.
.sp
More in\-depth conceptual reading on Proxy Minions can be found
\fI\%in the Proxy Minion section\fP of
Salt\(aqs documentation.
.sp
To configure this integration, follow these steps:
.SS Pillar
.sp
Proxy minions get their configuration from Salt\(aqs Pillar.  Every proxy must
have a stanza in Pillar, and a reference in the Pillar topfile that matches
the ID.  At a minimum for communication with the chassis the pillar should
look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  host: <ip or dns name of chassis controller>
  admin_username: <iDRAC username for the CMC, usually \(aqroot\(aq>
  fallback_admin_username: <username to try if the first fails>
  passwords:
    \- first_password
    \- second_password
    \- third\-password
  proxytype: fx2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBproxytype\fP line above is critical, it tells Salt which interface to load
from the \fBproxy\fP directory in Salt\(aqs install hierarchy, or from \fB/srv/salt/_proxy\fP
on the salt\-master (if you have created your own proxy module, for example).
.sp
The proxy integration will try the passwords listed in order.  It is
configured this way so you can have a regular password, a potential
fallback password, and the third password can be the one you intend
to change the chassis to use.  This way, after it is changed, you
should not need to restart the proxy minion\-\-it should just pick up the
third password in the list.  You can then change pillar at will to
move that password to the front and retire the unused ones.
.sp
Beware, many Dell CMC and iDRAC units are configured to lockout
IP addresses or users after too many failed password attempts.  This can
generate user panic in the form of \(dqI no longer know what the password is!!!\(dq.
To mitigate panic try the web interface from a different IP, or setup a
emergency administrator user in the CMC before doing a wholesale
password rotation.
.sp
The automatic lockout can be disabled via Salt with the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt <cmc> chassis.cmd set_general cfgRacTuning cfgRacTuneIpBlkEnable 0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
and then verified with
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt <cmc> chassis.cmd get_general cfgRacTuning cfgRacTuneIpBlkEnable
.ft P
.fi
.UNINDENT
.UNINDENT
.SS salt\-proxy
.sp
After your pillar is in place, you can test the proxy.  The proxy can run on
any machine that has network connectivity to your salt\-master and to the chassis in question.
SaltStack recommends that this machine also run a regular minion, though
it is not strictly necessary.
.sp
On the machine that will run the proxy, make sure there is an \fB/etc/salt/proxy\fP
file with at least the following in it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: <ip or hostname of salt\-master>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can start the proxy with
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid <id you want to give the chassis>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You may want to add \fB\-l debug\fP to run the above in the foreground in debug
mode just to make sure everything is OK.
.sp
Next, accept the key for the proxy on your salt\-master, just like you would
for a regular minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-a <id you want to give the chassis>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can confirm that the pillar data is in place for the proxy:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt <id> pillar.items
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And now you should be able to ping the chassis to make sure it is responding:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt <id> test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
At this point you can execute one\-off commands against the chassis.  For
example, you can get the chassis inventory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt <id> chassis.cmd inventory
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that you don\(aqt need to provide credentials or an ip/hostname.  Salt knows
to use the credentials you stored in Pillar.
.sp
It\(aqs important to understand how this particular proxy works.
\fI\%Salt.modules.dracr\fP is a standard Salt execution
module.  If you pull up the docs for it you\(aqll see that almost every function
in the module takes credentials and a target host.  When credentials and a host
aren\(aqt passed, Salt runs \fBracadm\fP against the local machine.  If you wanted
you could run functions from this module on any host where an appropriate
version of \fBracadm\fP is installed, and that host would reach out over the network
and communicate with the chassis.
.sp
\fBChassis.cmd\fP acts as a \(dqshim\(dq between the execution module and the proxy.  Its
first parameter is always the function from salt.modules.dracr to execute.  If the
function takes more positional or keyword arguments you can append them to the call.
It\(aqs this shim that speaks to the chassis through the proxy, arranging for the
credentials and hostname to be pulled from the pillar section for this proxy minion.
.sp
Because of the presence of the shim, to lookup documentation for what
functions you can use to interface with the chassis, you\(aqll want to
look in \fI\%salt.modules.dracr\fP instead
of \fI\%salt.modules.chassis\fP\&.
.SS States
.sp
Associated states are thoroughly documented in \fI\%salt.states.dellchassis\fP\&.
Look there to find an example structure for pillar as well as an example
\fB\&.sls\fP file for standing up a Dell Chassis from scratch.
.INDENT 0.0
.TP
.B salt.proxy.fx2.admin_password()
Return the admin_password in the DETAILS dictionary, or \(aqcalvin\(aq
(the Dell default) if there is none present
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.fx2.admin_username()
Return the admin_username in the DETAILS dictionary, or root if there
is none present
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.fx2.chconfig(cmd, *args, **kwargs)
This function is called by the \fI\%salt.modules.chassis.cmd\fP
shim.  It then calls whatever is passed in \fBcmd\fP
inside the \fI\%salt.modules.dracr\fP
module.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcmd\fP \-\- The command to call inside salt.modules.dracr
.IP \(bu 2
\fBargs\fP \-\- Arguments that need to be passed to that command
.IP \(bu 2
\fBkwargs\fP \-\- Keyword arguments that need to be passed to that command
.UNINDENT
.TP
.B Returns
Passthrough the return from the dracr module.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.fx2.find_credentials()
Cycle through all the possible credentials and return the first one that
works
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.fx2.grains()
Get the grains from the proxied device
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.fx2.grains_refresh()
Refresh the grains from the proxied device
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.fx2.host()
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.fx2.init(opts)
This function gets called when the proxy starts up.
We check opts to see if a fallback user and password are supplied.
If they are present, and the primary credentials don\(aqt work, then
we try the backup before failing.
.sp
Whichever set of credentials works is placed in the persistent
DETAILS dictionary and will be used for further communication with the
chassis.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.fx2.ping()
Is the chassis responding?
.INDENT 7.0
.TP
.B Returns
Returns False if the chassis didn\(aqt respond, True otherwise.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.fx2.shutdown(opts)
Shutdown the connection to the proxied device.
For this proxy shutdown is a no\-op.
.UNINDENT
.SS salt.proxy.junos
.sp
Interface with a Junos device via proxy\-minion. To connect to a junos device via junos proxy, specify the host information in the pillar in \(aq/srv/pillar/details.sls\(aq
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: junos
  host: <ip or dns name of host>
  username: <username>
  port: 830
  password: <secret>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In \(aq/srv/pillar/top.sls\(aq map the device details with the proxy name.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqvmx\(aq:
    \- details
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
After storing the device information in the pillar, configure the proxy in \(aq/etc/salt/proxy\(aq
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: <ip or hostname of salt\-master>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Run the salt proxy via the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid=vmx
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.proxy.junos.RebootActive(**kwargs)
Class to get static variable, to indicate when a reboot/shutdown
is being processed and the keep_alive should not probe the
connection since it interferes with the shutdown process.
.INDENT 7.0
.TP
.B reboot_shutdown  =  False
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.junos.alive(opts)
Validate and return the connection status with the remote device.
.sp
New in version 2018.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.junos.conn()
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.junos.get_reboot_active()
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.junos.get_serialized_facts()
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.junos.init(opts)
Open the connection to the Junos device, login, and bind to the
Resource class
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.junos.initialized()
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.junos.ping()
Ping?  Pong!
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.junos.proxytype()
Returns the name of this proxy
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.junos.reboot_active()
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.junos.reboot_clear()
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.junos.shutdown(opts)
This is called when the proxy\-minion is exiting to make sure the
connection to the device is closed cleanly.
.UNINDENT
.SS salt.proxy.marathon
.SS Marathon
.sp
Proxy minion for managing a Marathon cluster.
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
\fI\%marathon execution module (salt.modules.marathon)\fP
.UNINDENT
.SS Pillar
.sp
The marathon proxy configuration requires a \(aqbase_url\(aq property that points to
the marathon endpoint:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: marathon
  base_url: http://my\-marathon\-master.mydomain.com:8080
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.2.

.INDENT 0.0
.TP
.B salt.proxy.marathon.init(opts)
Perform any needed setup.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.marathon.ping()
Is the marathon api responding?
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.marathon.shutdown(opts)
For this proxy shutdown is a no\-op
.UNINDENT
.SS salt.proxy.napalm
.SS NAPALM: Network Automation and Programmability Abstraction Layer with Multivendor support
.sp
New in version 2016.11.0.

.sp
Proxy minion for managing network devices via \fI\%NAPALM\fP library.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP> & Jerome Fleury <\fI\%jf@cloudflare.com\fP>
.TP
.B maturity
new
.TP
.B depends
napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.sp
The \fBnapalm\fP proxy module requires \fI\%NAPALM\fP library to be installed:  \fBpip install napalm\fP
Please check \fI\%Installation\fP for complete details.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Beginning with Salt release 2017.7.3, it is recommended to use
\fBnapalm\fP >= \fB2.0.0\fP\&. The library has been unified into a monolithic
package, as in opposite to separate packages per driver. For more details
you can check \fI\%this document\fP\&.
While it will still work with the old packages, bear in mind that the NAPALM
core team will maintain only the main \fBnapalm\fP package.
.sp
Moreover, for additional capabilities, the users can always define a
library that extends NAPALM\(aqs base capabilities and configure the
\fBprovider\fP option (see below).
.UNINDENT
.UNINDENT
.SS Pillar
.sp
The napalm proxy configuration requires the following parameters in order to connect to the network device:
.INDENT 0.0
.TP
.B driver
Specifies the network device operating system.
For a complete list of the supported operating systems please refer to the
\fI\%NAPALM Read the Docs page\fP\&.
.TP
.B host
The IP Address or FQDN to use when connecting to the device. Alternatively,
the following field names can be used instead: \fBhostname\fP, \fBfqdn\fP, \fBip\fP\&.
.TP
.B username
The username to be used when connecting to the device.
.TP
.B passwd
The password needed to establish the connection.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This field may not be mandatory when working with SSH\-based drivers, and
the username has a SSH key properly configured on the device targeted to
be managed.
.UNINDENT
.UNINDENT
.TP
.B optional_args
Dictionary with the optional arguments.
Check the complete list of supported \fI\%optional arguments\fP\&.
.TP
.B always_alive: \fBTrue\fP
In certain less dynamic environments, maintaining the remote connection permanently
open with the network device is not always beneficial. In that case, the user can
select to initialize the connection only when needed, by specifying this field to \fBfalse\fP\&.
Default: \fBtrue\fP (maintains the connection with the remote network device).
.sp
New in version 2017.7.0.

.TP
.B provider: \fBnapalm_base\fP
The library that provides the \fBget_network_device\fP function.
This option is useful when the user has more specific needs and requires
to extend the NAPALM capabilities using a private library implementation.
The only constraint is that the alternative library needs to have the
\fBget_network_device\fP function available.
.sp
New in version 2017.7.1.

.TP
.B multiprocessing: \fBFalse\fP
Overrides the \fI\%multiprocessing\fP option, per proxy minion.
The \fBmultiprocessing\fP option must be turned off for SSH\-based proxies.
However, some NAPALM drivers (e.g. Arista, NX\-OS) are not SSH\-based.
As multiple proxy minions may share the same configuration file,
this option permits the configuration of the \fBmultiprocessing\fP option
more specifically, for some proxy minions.
.sp
New in version 2017.7.2.

.UNINDENT
.sp
Proxy pillar file example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: napalm
  driver: junos
  host: core05.nrt02
  username: my_username
  passwd: my_password
  optional_args:
    port: 12201
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example using a user\-specific library, extending NAPALM\(aqs capabilities, e.g. \fBcustom_napalm_base\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: napalm
  driver: ios
  fqdn: cr1.th2.par.as1234.net
  username: salt
  password: \(aq\(aq
  provider: custom_napalm_base
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fI\%NAPALM grains: select network devices based on their characteristics\fP
.IP \(bu 2
\fI\%NET module: network basic features\fP
.IP \(bu 2
\fI\%Network config state: Manage the configuration using arbitrary templates\fP
.IP \(bu 2
\fBNAPALM YANG state: Manage the configuration according to the YANG models (OpenConfig/IETF)\fP
.IP \(bu 2
\fBNetwork ACL module: Generate and load ACL (firewall) configuration\fP
.IP \(bu 2
\fI\%Network ACL state: Manage the firewall configuration\fP
.IP \(bu 2
\fI\%NTP operational and configuration management module\fP
.IP \(bu 2
\fI\%BGP operational and configuration management module\fP
.IP \(bu 2
\fI\%Routes details\fP
.IP \(bu 2
\fI\%SNMP configuration module\fP
.IP \(bu 2
\fI\%Users configuration management\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Beginning with release codename 2019.2.0, any NAPALM command executed when
running under a NAPALM Proxy Minion supports the \fBforce_reconnect\fP
magic argument.
.sp
Proxy Minions generally establish a connection with the remote network
device at the time of the Minion startup and that connection is going to be
used forever.
.sp
If one would need execute a command on the device but connecting using
different parameters (due to various causes, e.g., unable to authenticate
the user specified in the Pillar as the authentication system \- say
TACACS+ is not available, or the DNS resolver is currently down and would
like to temporarily use the IP address instead, etc.), it implies updating
the Pillar data and restarting the Proxy Minion process restart.
In particular cases like that, you can pass the \fBforce_reconnect=True\fP
keyword argument, together with the alternative connection details, to
enforce the command to be executed over a separate connection.
.sp
For example, if the usual command is \fBsalt \(aq*\(aq net.arp\fP, you can use the
following to connect using a different username instead:
\fBsalt \(aq*\(aq net.arp username=my\-alt\-usr force_reconnect=True\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.napalm.alive(opts)
Return the connection status with the remote device.
.sp
New in version 2017.7.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.napalm.call(method, *args, **kwargs)
Calls a specific method from the network driver instance.
Please check the \fI\%readthedocs\fP page for the updated list of getters.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmethod\fP \-\- specifies the name of the method to be called
.IP \(bu 2
\fBparams\fP \-\- contains the mapping between the name and the values of the parameters needed to call the method
.UNINDENT
.TP
.B Returns
A dictionary with three keys:
.UNINDENT
.INDENT 7.0
.IP \(bu 2
result (True/False): if the operation succeeded
.IP \(bu 2
out (object): returns the object as\-is from the call
.IP \(bu 2
comment (string): provides more details in case the call failed
.IP \(bu 2
traceback (string): complete traceback in case of exception. Please
submit an issue including this traceback on the \fI\%correct driver repo\fP
and make sure to read the \fI\%FAQ\fP
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
__proxy__[\(aqnapalm.call\(aq](\(aqcli\(aq
                         **{
                            \(aqcommands\(aq: [
                                \(aqshow version\(aq,
                                \(aqshow chassis fan\(aq
                            ]
                         })
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.napalm.fns()
Method called by NAPALM grains module.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.napalm.get_device()
Returns the network device object.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.napalm.get_grains()
Retrieve facts from the network device.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.napalm.grains_refresh()
Refresh the grains.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.napalm.init(opts)
Opens the connection with the network device.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.napalm.initialized()
Connection finished initializing?
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.napalm.ping()
Connection open successfully?
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.napalm.shutdown(opts)
Closes connection with the device.
.UNINDENT
.SS salt.proxy.netmiko_px
.SS Netmiko
.sp
New in version 2019.2.0.

.sp
Proxy module for managing network devices via
\fI\%Netmiko\fP\&.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP> & Kirk Byers <\fI\%ktbyers@twb\-tech.com\fP>
.TP
.B maturity
new
.TP
.B depends
netmiko
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.sp
The \fBnetmiko\fP proxy modules requires Netmiko to be installed: \fBpip install netmiko\fP\&.
.SS Pillar
.sp
The \fBnetmiko\fP proxy configuration requires the following parameters in order
to connect to the network device:
.INDENT 0.0
.IP \(bu 2
\fBdevice_type\fP \- Class selection based on device type. Supported options:
.INDENT 2.0
.IP \(bu 2
\fBa10\fP: A10 Networks
.IP \(bu 2
\fBaccedian\fP: Accedian Networks
.IP \(bu 2
\fBalcatel_aos\fP: Alcatel AOS
.IP \(bu 2
\fBalcatel_sros\fP: Alcatel SROS
.IP \(bu 2
\fBapresia_aeos\fP: Apresia AEOS
.IP \(bu 2
\fBarista_eos\fP: Arista EOS
.IP \(bu 2
\fBaruba_os\fP: Aruba
.IP \(bu 2
\fBavaya_ers\fP: Avaya ERS
.IP \(bu 2
\fBavaya_vsp\fP: Avaya VSP
.IP \(bu 2
\fBbrocade_fastiron\fP: Brocade Fastiron
.IP \(bu 2
\fBbrocade_netiron\fP: Brocade Netiron
.IP \(bu 2
\fBbrocade_nos\fP: Brocade NOS
.IP \(bu 2
\fBbrocade_vdx\fP: Brocade NOS
.IP \(bu 2
\fBbrocade_vyos\fP: VyOS
.IP \(bu 2
\fBcheckpoint_gaia\fP: Check Point GAiA
.IP \(bu 2
\fBcalix_b6\fP: Calix B6
.IP \(bu 2
\fBciena_saos\fP: Ciena SAOS
.IP \(bu 2
\fBcisco_asa\fP: Cisco SA
.IP \(bu 2
\fBcisco_ios\fP: Cisco IOS
.IP \(bu 2
\fBcisco_nxos\fP: Cisco NX\-oS
.IP \(bu 2
\fBcisco_s300\fP: Cisco S300
.IP \(bu 2
\fBcisco_tp\fP: Cisco TpTcCe
.IP \(bu 2
\fBcisco_wlc\fP: Cisco WLC
.IP \(bu 2
\fBcisco_xe\fP: Cisco IOS
.IP \(bu 2
\fBcisco_xr\fP: Cisco XR
.IP \(bu 2
\fBcoriant\fP: Coriant
.IP \(bu 2
\fBdell_force10\fP: Dell Force10
.IP \(bu 2
\fBdell_os10\fP: Dell OS10
.IP \(bu 2
\fBdell_powerconnect\fP: Dell PowerConnect
.IP \(bu 2
\fBeltex\fP: Eltex
.IP \(bu 2
\fBenterasys\fP: Enterasys
.IP \(bu 2
\fBextreme\fP: Extreme
.IP \(bu 2
\fBextreme_wing\fP: Extreme Wing
.IP \(bu 2
\fBf5_ltm\fP: F5 LTM
.IP \(bu 2
\fBfortinet\fP: Fortinet
.IP \(bu 2
\fBgeneric_termserver\fP: TerminalServer
.IP \(bu 2
\fBhp_comware\fP: HP Comware
.IP \(bu 2
\fBhp_procurve\fP: HP Procurve
.IP \(bu 2
\fBhuawei\fP: Huawei
.IP \(bu 2
\fBhuawei_vrpv8\fP: Huawei VRPV8
.IP \(bu 2
\fBjuniper\fP: Juniper Junos
.IP \(bu 2
\fBjuniper_junos\fP: Juniper Junos
.IP \(bu 2
\fBlinux\fP: Linux
.IP \(bu 2
\fBmellanox\fP: Mellanox
.IP \(bu 2
\fBmrv_optiswitch\fP: MrvOptiswitch
.IP \(bu 2
\fBnetapp_cdot\fP: NetAppcDot
.IP \(bu 2
\fBnetscaler\fP: Netscaler
.IP \(bu 2
\fBovs_linux\fP: OvsLinux
.IP \(bu 2
\fBpaloalto_panos\fP: PaloAlto Panos
.IP \(bu 2
\fBpluribus\fP: Pluribus
.IP \(bu 2
\fBquanta_mesh\fP: Quanta Mesh
.IP \(bu 2
\fBruckus_fastiron\fP: Ruckus Fastiron
.IP \(bu 2
\fBubiquiti_edge\fP: Ubiquiti Edge
.IP \(bu 2
\fBubiquiti_edgeswitch\fP: Ubiquiti Edge
.IP \(bu 2
\fBvyatta_vyos\fP: VyOS
.IP \(bu 2
\fBvyos\fP: VyOS
.IP \(bu 2
\fBbrocade_fastiron_telnet\fP: Brocade Fastiron over Telnet
.IP \(bu 2
\fBbrocade_netiron_telnet\fP: Brocade Netiron over Telnet
.IP \(bu 2
\fBcisco_ios_telnet\fP: Cisco IOS over Telnet
.IP \(bu 2
\fBapresia_aeos_telnet\fP: Apresia AEOS over Telnet
.IP \(bu 2
\fBarista_eos_telnet\fP: Arista EOS over Telnet
.IP \(bu 2
\fBhp_procurve_telnet\fP: HP Procurve over Telnet
.IP \(bu 2
\fBhp_comware_telnet\fP: HP Comware over Telnet
.IP \(bu 2
\fBjuniper_junos_telnet\fP: Juniper Junos over Telnet
.IP \(bu 2
\fBcalix_b6_telnet\fP: Calix B6 over Telnet
.IP \(bu 2
\fBdell_powerconnect_telnet\fP: Dell PowerConnect over Telnet
.IP \(bu 2
\fBgeneric_termserver_telnet\fP: TerminalServer over Telnet
.IP \(bu 2
\fBextreme_telnet\fP: Extreme Networks over Telnet
.IP \(bu 2
\fBruckus_fastiron_telnet\fP: Ruckus Fastiron over Telnet
.IP \(bu 2
\fBcisco_ios_serial\fP: Cisco IOS over serial port
.UNINDENT
.IP \(bu 2
\fBip\fP \- IP address of target device (not required if \fBhost\fP is provided)
.IP \(bu 2
\fBhost\fP \- Hostname of target device (not required if \fBip\fP is provided)
.IP \(bu 2
\fBusername\fP \- Username to authenticate against target device, if required
.IP \(bu 2
\fBpassword\fP \- Password to authenticate against target device, if required
.IP \(bu 2
\fBsecret\fP \- The enable password if target device requires one
.IP \(bu 2
\fBport\fP \- The destination port used to connect to the target device
.IP \(bu 2
\fBglobal_delay_factor\fP \- Multiplication factor affecting Netmiko delays
(default: \fB1\fP)
.IP \(bu 2
\fBuse_keys\fP \- Connect to target device using SSH keys (default: \fBFalse\fP)
.IP \(bu 2
\fBkey_file\fP \- Filename path of the SSH key file to use
.IP \(bu 2
\fBallow_agent\fP \- Enable use of SSH key\-agent
.IP \(bu 2
\fBssh_strict\fP \- Automatically reject unknown SSH host keys (default:
\fBFalse\fP, which means unknown SSH host keys will be accepted)
.IP \(bu 2
\fBsystem_host_keys\fP \- Load host keys from the user\(aqs \(dqknown_hosts\(dq file
(default: \fBFalse\fP)
.IP \(bu 2
\fBalt_host_keys\fP \- If \fBTrue\fP,  host keys will be loaded from the file
specified in \fBalt_key_file\fP (default: \fBFalse\fP)
.IP \(bu 2
\fBalt_key_file\fP \- SSH host key file to use (if \fBalt_host_keys=True\fP)
.IP \(bu 2
\fBssh_config_file\fP \- File name of OpenSSH configuration file
.IP \(bu 2
\fBtimeout\fP \- Connection timeout, in seconds (default: \fB90\fP)
.IP \(bu 2
\fBsession_timeout\fP \- Set a timeout for parallel requests, in seconds
(default: \fB60\fP)
.IP \(bu 2
\fBkeepalive\fP \- Send SSH keepalive packets at a specific interval, in
seconds. Currently defaults to \fB0\fP, for backwards compatibility (it will
not attempt to keep the connection alive using the KEEPALIVE packets).
.IP \(bu 2
\fBdefault_enter\fP \- Character(s) to send to correspond to enter key (default:
\fB\en\fP)
.IP \(bu 2
\fBresponse_return\fP \- Character(s) to use in normalized return data to
represent enter key (default: \fB\en\fP)
.IP \(bu 2
\fBalways_alive\fP \- In certain less dynamic environments, maintaining the
remote connection permanently open with the network device is not always
beneficial. In that case, the user can select to initialize the connection
only when needed, by setting this option to \fBFalse\fP\&. By default this option
is set to \fBTrue\fP (maintains the connection with the remote network device)
.IP \(bu 2
\fBmultiprocessing\fP \- Overrides the \fI\%multiprocessing\fP option,
per proxy minion, as the Netmiko communication channel is mainly SSH
(default: \fBFalse\fP)
.IP \(bu 2
\fBconnection_timeout\fP \- The number of seconds to attempt to connect to
the device in seconds.
(default: \fB300\fP)
.UNINDENT
.SS Proxy Pillar Example
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: netmiko
  device_type: juniper_junos
  host: router1.example.com
  username: example
  password: example
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: netmiko
  device_type: cisco_ios
  ip: 1.2.3.4
  username: test
  use_keys: true
  secret: w3@k
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.netmiko_px.alive(opts)
Return the connection status with the network device.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.netmiko_px.args()
Return the Netmiko device args.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.netmiko_px.call(method, *args, **kwargs)
Calls an arbitrary netmiko method.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.netmiko_px.conn()
Return the connection object.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.netmiko_px.connection(connection_timeout=300)
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.netmiko_px.init(opts)
Open the connection to the network device
managed through netmiko.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.netmiko_px.initialized()
Connection finished initializing?
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.netmiko_px.make_con(connection_timeout=300)
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.netmiko_px.ping()
Connection open successfully?
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.netmiko_px.shutdown(opts)
Closes connection with the device.
.UNINDENT
.SS salt.proxy.nxos
.sp
Proxy Minion for Cisco NX\-OS Switches
.sp
New in version 2016.11.0.

.sp
The Cisco NX\-OS Proxy Minion is supported on NX\-OS devices for the following connection types:
1) Connection Type SSH
2) Connection Type NX\-API (If Supported By The Device and Image Version).
.INDENT 0.0
.TP
.B maturity
new
.TP
.B platform
nxos
.UNINDENT
.sp
SSH uses the built in SSHConnection module in \fBsalt.utils.vt_helper\fP
.sp
To configure the proxy minion for ssh:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: nxos
  connection: ssh
  host: 192.168.187.100
  username: admin
  password: admin
  prompt_name: nxos\-switch
  ssh_args: \(aq\-o PubkeyAuthentication=no\(aq
  key_accept: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To configure the proxy minion for nxapi:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: nxos
  connection: nxapi
  host: 192.168.187.100
  username: admin
  password: admin
  transport: http
  port: 80
  verify: False
  save_config: False
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B proxytype:
(REQUIRED) Use this proxy minion \fInxos\fP
.TP
.B connection:
(REQUIRED) connection transport type.
Choices: \fIssh, nxapi\fP
Default: \fIssh\fP
.TP
.B host:
(REQUIRED) login ip address or dns hostname.
.TP
.B username:
(REQUIRED) login username.
.TP
.B password:
(REQUIRED) login password.
.TP
.B save_config:
If True, \(aqcopy running\-config starting\-config\(aq is issues for every
configuration command.
If False, Running config is not saved to startup config
Default: True
.sp
The recommended approach is to use the \fIsave_running_config\fP function
instead of this option to improve performance.  The default behavior
controlled by this option is preserved for backwards compatibility.
.UNINDENT
.sp
Connection SSH Args:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B prompt_name:
(REQUIRED when \fIconnection\fP is \fIssh\fP)
(REQUIRED, this or \fIprompt_regex\fP below, but not both)
The name in the prompt on the switch.  Recommended to use your
device\(aqs hostname.
.TP
.B prompt_regex:
(REQUIRED when \fIconnection\fP is \fIssh\fP)
(REQUIRED, this or \fIprompt_name\fP above, but not both)
A regular expression that matches the prompt on the switch
and any other possible prompt at which you need the proxy minion
to continue sending input.  This feature was specifically developed
for situations where the switch may ask for confirmation.  \fIprompt_name\fP
above would not match these, and so the session would timeout.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
nxos\-switch#.*|\e(y\e/n\e)\e?.*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This should match
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
nxos\-switch#
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Flash complete.  Reboot this switch (y/n)? [n]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If neither \fIprompt_name\fP nor \fIprompt_regex\fP is specified the prompt will be
defaulted to
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\&.+#$
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
which should match any number of characters followed by a \fI#\fP at the end
of the line.  This may be far too liberal for most installations.
.TP
.B ssh_args:
Extra optional arguments used for connecting to switch.
.TP
.B key_accept:
Whether or not to accept the host key of the switch on initial login.
Default: \fIFalse\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Connection NXAPI Args:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B transport:
(REQUIRED) when \fIconnection\fP is \fInxapi\fP\&.
Choices: \fIhttp, https\fP
Default: \fIhttps\fP
.TP
.B port:
(REQUIRED) when \fIconnection\fP is \fInxapi\fP\&.
Default: \fI80\fP
.TP
.B verify:
(REQUIRED) when \fIconnection\fP is \fInxapi\fP\&.
Either a boolean, in which case it controls whether we verify the NX\-API
TLS certificate, or a string, in which case it must be a path to a CA bundle
to use.
Default: \fITrue\fP
.sp
When there is no certificate configuration on the device and this option is
set as \fBTrue\fP (default), the commands will fail with the following error:
\fBSSLError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed (_ssl.c:581)\fP\&.
In this case, you either need to configure a proper certificate on the
device (\fIrecommended\fP), or bypass the checks setting this argument as \fBFalse\fP
with all the security risks considered.
.sp
Check \fI\%https://www.cisco.com/c/en/us/td/docs/switches/datacenter/nexus3000/sw/programmability/6_x/b_Cisco_Nexus_3000_Series_NX\-OS_Programmability_Guide/b_Cisco_Nexus_3000_Series_NX\-OS_Programmability_Guide_chapter_01.html\fP
to see how to properly configure the certificate.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The functions from the proxy minion can be run from the salt commandline using
the \fI\%salt.modules.nxos\fP execution module.
.INDENT 0.0
.TP
.B salt.proxy.nxos.grains()
Helper function for nxos execution module functions that need to
retrieve nxos grains using the proxy minion.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.nxos.grains_refresh()
Helper function for nxos execution module functions that need to
refresh nxos grains using the proxy minion.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.nxos.init(opts=None)
Required.
Initialize device connection using ssh or nxapi connection type.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.nxos.initialized()
Since grains are loaded in many different places and some of those
places occur before the proxy can be initialized, return whether the
init() function has been called.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.nxos.ping()
Helper function for nxos execution module functions that need to
ping the nxos device using the proxy minion.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.nxos.proxy_config(commands, save_config=None)
Helper function for nxos execution module functions that need to
configure an nxos device using the proxy minion.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.nxos.sendline(commands, method=\(aqcli_show_ascii\(aq, **kwargs)
Helper function for nxos execution module functions that need to
send commands to an nxos device using the proxy minion.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.nxos.shutdown()
Not supported.  Only used as a place holder to satisfy shutdown function
requirement.
.UNINDENT
.SS salt.proxy.nxos_api
.sp
Proxy Minion to manage Cisco Nexus Switches (NX\-OS) over the NX\-API
.sp
New in version 2019.2.0.

.sp
Proxy module for managing Cisco Nexus switches via the NX\-API.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP>
.TP
.B maturity
new
.TP
.B platform
any
.UNINDENT
.SS Usage
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To be able to use this module you need to enable to NX\-API on your switch,
by executing \fBfeature nxapi\fP in configuration mode.
.sp
Configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
switch# conf t
switch(config)# feature nxapi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To check that NX\-API is properly enabled, execute \fBshow nxapi\fP\&.
.sp
Output example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
switch# show nxapi
nxapi enabled
HTTPS Listen on port 443
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
NX\-API requires modern NXOS distributions, typically at least 7.0 depending
on the hardware. Due to reliability reasons it is recommended to run the
most recent version.
.sp
Check \fI\%https://www.cisco.com/c/en/us/td/docs/switches/datacenter/nexus7000/sw/programmability/guide/b_Cisco_Nexus_7000_Series_NX\-OS_Programmability_Guide/b_Cisco_Nexus_7000_Series_NX\-OS_Programmability_Guide_chapter_0101.html\fP
for more details.
.UNINDENT
.UNINDENT
.SS Pillar
.sp
The \fBnxos_api\fP proxy configuration requires the following parameters in order
to connect to the network switch:
.INDENT 0.0
.TP
.B transport: \fBhttps\fP
Specifies the type of connection transport to use. Valid values for the
connection are \fBhttp\fP, and  \fBhttps\fP\&.
.TP
.B host: \fBlocalhost\fP
The IP address or DNS host name of the connection device.
.TP
.B username: \fBadmin\fP
The username to pass to the device to authenticate the NX\-API connection.
.TP
.B password
The password to pass to the device to authenticate the NX\-API connection.
.TP
.B port
The TCP port of the endpoint for the NX\-API connection. If this keyword is
not specified, the default value is automatically determined by the
transport type (\fB80\fP for \fBhttp\fP, or \fB443\fP for \fBhttps\fP).
.TP
.B timeout: \fB60\fP
Time in seconds to wait for the device to respond. Default: 60 seconds.
.TP
.B verify: \fBTrue\fP
Either a boolean, in which case it controls whether we verify the NX\-API
TLS certificate, or a string, in which case it must be a path to a CA bundle
to use. Defaults to \fBTrue\fP\&.
.sp
When there is no certificate configuration on the device and this option is
set as \fBTrue\fP (default), the commands will fail with the following error:
\fBSSLError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed (_ssl.c:581)\fP\&.
In this case, you either need to configure a proper certificate on the
device (\fIrecommended\fP), or bypass the checks setting this argument as \fBFalse\fP
with all the security risks considered.
.sp
Check \fI\%https://www.cisco.com/c/en/us/td/docs/switches/datacenter/nexus3000/sw/programmability/6_x/b_Cisco_Nexus_3000_Series_NX\-OS_Programmability_Guide/b_Cisco_Nexus_3000_Series_NX\-OS_Programmability_Guide_chapter_01.html\fP
to see how to properly configure the certificate.
.UNINDENT
.sp
All the arguments may be optional, depending on your setup.
.SS Proxy Pillar Example
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: nxos_api
  host: switch1.example.com
  username: example
  password: example
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.nxos_api.get_conn_args()
Returns the connection arguments of the Proxy Minion.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.nxos_api.init(opts)
Open the connection to the Nexsu switch over the NX\-API.
.sp
As the communication is HTTP based, there is no connection to maintain,
however, in order to test the connectivity and make sure we are able to
bring up this Minion, we are executing a very simple command (\fBshow clock\fP)
which doesn\(aqt come with much overhead and it\(aqs sufficient to confirm we are
indeed able to connect to the NX\-API endpoint as configured.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.nxos_api.initialized()
Connection finished initializing?
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.nxos_api.ping()
Connection open successfully?
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.nxos_api.rpc(commands, method=\(aqcli\(aq, **kwargs)
Executes an RPC request over the NX\-API.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.nxos_api.shutdown(opts)
Closes connection with the device.
.UNINDENT
.SS salt.proxy.panos
.SS Proxy Minion interface module for managing Palo Alto firewall devices
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B codeauthor
\fBSpencer Ervin <spencer_ervin@hotmail.com>\fP
.TP
.B maturity
new
.TP
.B depends
none
.TP
.B platform
unix
.UNINDENT
.sp
This proxy minion enables Palo Alto firewalls (hereafter referred to
as simply \(aqpanos\(aq) to be treated individually like a Salt Minion.
.sp
The panos proxy leverages the XML API functionality on the Palo Alto
firewall. The Salt proxy must have access to the Palo Alto firewall on
HTTPS (tcp/443).
.sp
More in\-depth conceptual reading on Proxy Minions can be found in the
\fI\%Proxy Minion\fP section of Salt\(aqs
documentation.
.SS Configuration
.sp
To use this integration proxy module, please configure the following:
.SS Pillar
.sp
Proxy minions get their configuration from Salt\(aqs Pillar. Every proxy must
have a stanza in Pillar and a reference in the Pillar top\-file that matches
the ID. There are four connection options available for the panos proxy module.
.INDENT 0.0
.IP \(bu 2
Direct Device (Password)
.IP \(bu 2
Direct Device (API Key)
.IP \(bu 2
Panorama Pass\-Through (Password)
.IP \(bu 2
Panorama Pass\-Through (API Key)
.UNINDENT
.SS Direct Device (Password)
.sp
The direct device configuration configures the proxy to connect directly to
the device with username and password.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: panos
  host: <ip or dns name of panos host>
  username: <panos username>
  password: <panos password>
  verify_ssl: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS proxytype
.sp
The \fBproxytype\fP key and value pair is critical, as it tells Salt which
interface to load from the \fBproxy\fP directory in Salt\(aqs install hierarchy,
or from \fB/srv/salt/_proxy\fP on the Salt Master (if you have created your
own proxy module, for example). To use this panos Proxy Module, set this to
\fBpanos\fP\&.
.SS host
.sp
The location, or ip/dns, of the panos host. Required.
.SS username
.sp
The username used to login to the panos host. Required.
.SS password
.sp
The password used to login to the panos host. Required.
.SS Direct Device (API Key)
.sp
Palo Alto devices allow for access to the XML API with a generated \(aqAPI key\(aq_
instead of username and password.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: panos
  host: <ip or dns name of panos host>
  apikey: <panos generated api key>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS proxytype
.sp
The \fBproxytype\fP key and value pair is critical, as it tells Salt which
interface to load from the \fBproxy\fP directory in Salt\(aqs install hierarchy,
or from \fB/srv/salt/_proxy\fP on the Salt Master (if you have created your
own proxy module, for example). To use this panos Proxy Module, set this to
\fBpanos\fP\&.
.SS host
.sp
The location, or ip/dns, of the panos host. Required.
.SS apikey
.sp
The generated XML API key for the panos host. Required.
.SS Panorama Pass\-Through (Password)
.sp
The Panorama pass\-through method sends all connections through the Panorama
management system. It passes the connections to the appropriate device using
the serial number of the Palo Alto firewall.
.sp
This option will reduce the number of connections that must be present for the
proxy server. It will only require a connection to the Panorama server.
.sp
The username and password will be for authentication to the Panorama server,
not the panos device.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: panos
  serial: <serial number of panos host>
  host: <ip or dns name of the panorama server>
  username: <panorama server username>
  password: <panorama server password>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS proxytype
.sp
The \fBproxytype\fP key and value pair is critical, as it tells Salt which
interface to load from the \fBproxy\fP directory in Salt\(aqs install hierarchy,
or from \fB/srv/salt/_proxy\fP on the Salt Master (if you have created your
own proxy module, for example). To use this panos Proxy Module, set this to
\fBpanos\fP\&.
.SS serial
.sp
The serial number of the panos host. Required.
.SS host
.sp
The location, or ip/dns, of the Panorama server. Required.
.SS username
.sp
The username used to login to the Panorama server. Required.
.SS password
.sp
The password used to login to the Panorama server. Required.
.SS Panorama Pass\-Through (API Key)
.sp
The Panorama server can also utilize a generated \(aqAPI key\(aq_ for authentication.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: panos
  serial: <serial number of panos host>
  host: <ip or dns name of the panorama server>
  apikey: <panos generated api key>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS proxytype
.sp
The \fBproxytype\fP key and value pair is critical, as it tells Salt which
interface to load from the \fBproxy\fP directory in Salt\(aqs install hierarchy,
or from \fB/srv/salt/_proxy\fP on the Salt Master (if you have created your
own proxy module, for example). To use this panos Proxy Module, set this to
\fBpanos\fP\&.
.SS serial
.sp
The serial number of the panos host. Required.
.SS host
.sp
The location, or ip/dns, of the Panorama server. Required.
.SS apikey
.sp
The generated XML API key for the Panorama server. Required.
.INDENT 0.0
.TP
.B salt.proxy.panos.call(payload=None)
This function captures the query string and sends it to the Palo Alto device.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.panos.grains()
Get the grains from the proxied device
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.panos.grains_refresh()
Refresh the grains from the proxied device
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.panos.init(opts)
This function gets called when the proxy starts up. For
panos devices, a determination is made on the connection type
and the appropriate connection details that must be cached.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.panos.initialized()
Since grains are loaded in many different places and some of those
places occur before the proxy can be initialized, return whether
our init() function has been called
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.panos.is_required_version(required_version=\(aq0.0.0\(aq)
Because different versions of Palo Alto support different command sets, this function
will return true if the current version of Palo Alto supports the required command.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.panos.ping()
Returns true if the device is reachable, else false.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.panos.shutdown()
Shutdown the connection to the proxy device. For this proxy,
shutdown is a no\-op.
.UNINDENT
.SS salt.proxy.philips_hue
.sp
Philips HUE lamps module for proxy.
.sp
New in version 2015.8.3.

.sp
First create a new user on the Hue bridge by following the
\fI\%Meet hue\fP instructions.
.sp
To configure the proxy minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: philips_hue
  host: [hostname or ip]
  user: [username]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.proxy.philips_hue.Const
Constants for the lamp operations.
.INDENT 7.0
.TP
.B COLOR_BLUE  =  {\(aqhue\(aq: 46920, \(aqsat\(aq: 254}
.UNINDENT
.INDENT 7.0
.TP
.B COLOR_DAYLIGHT  =  {\(aqxy\(aq: [0.3806, 0.3576]}
.UNINDENT
.INDENT 7.0
.TP
.B COLOR_GREEN  =  {\(aqhue\(aq: 25500, \(aqsat\(aq: 254}
.UNINDENT
.INDENT 7.0
.TP
.B COLOR_ORANGE  =  {\(aqhue\(aq: 12000, \(aqsat\(aq: 254}
.UNINDENT
.INDENT 7.0
.TP
.B COLOR_PINK  =  {\(aqxy\(aq: [0.3688, 0.2095]}
.UNINDENT
.INDENT 7.0
.TP
.B COLOR_PURPLE  =  {\(aqxy\(aq: [0.3787, 0.1724]}
.UNINDENT
.INDENT 7.0
.TP
.B COLOR_RED  =  {\(aqhue\(aq: 0, \(aqsat\(aq: 254}
.UNINDENT
.INDENT 7.0
.TP
.B COLOR_WHITE  =  {\(aqxy\(aq: [0.3227, 0.329]}
.UNINDENT
.INDENT 7.0
.TP
.B COLOR_YELLOW  =  {\(aqxy\(aq: [0.4432, 0.5154]}
.UNINDENT
.INDENT 7.0
.TP
.B LAMP_OFF  =  {\(aqon\(aq: False, \(aqtransitiontime\(aq: 0}
.UNINDENT
.INDENT 7.0
.TP
.B LAMP_ON  =  {\(aqon\(aq: True, \(aqtransitiontime\(aq: 0}
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.philips_hue.call_alert(*args, **kwargs)
Lamp alert
.sp
Options:
.INDENT 7.0
.IP \(bu 2
\fBid\fP: Specifies a device ID. Can be a comma\-separated values. All, if omitted.
.IP \(bu 2
\fBon\fP: Turns on or off an alert. Default is True.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hue.alert
salt \(aq*\(aq hue.alert id=1
salt \(aq*\(aq hue.alert id=1,2,3 on=false
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.philips_hue.call_blink(*args, **kwargs)
Blink a lamp. If lamp is ON, then blink ON\-OFF\-ON, otherwise OFF\-ON\-OFF.
.sp
Options:
.INDENT 7.0
.IP \(bu 2
\fBid\fP: Specifies a device ID. Can be a comma\-separated values. All, if omitted.
.IP \(bu 2
\fBpause\fP: Time in seconds. Can be less than 1, i.e. 0.7, 0.5 sec.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hue.blink id=1
salt \(aq*\(aq hue.blink id=1,2,3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.philips_hue.call_brightness(*args, **kwargs)
Set an effect to the lamp.
.sp
Arguments:
.INDENT 7.0
.IP \(bu 2
\fBvalue\fP: 0~255 brightness of the lamp.
.UNINDENT
.sp
Options:
.INDENT 7.0
.IP \(bu 2
\fBid\fP: Specifies a device ID. Can be a comma\-separated values. All, if omitted.
.IP \(bu 2
\fBtransition\fP: Transition 0~200. Default 0.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hue.brightness value=100
salt \(aq*\(aq hue.brightness id=1 value=150
salt \(aq*\(aq hue.brightness id=1,2,3 value=255
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.philips_hue.call_color(*args, **kwargs)
Set a color to the lamp.
.sp
Options:
.INDENT 7.0
.IP \(bu 2
\fBid\fP: Specifies a device ID. Can be a comma\-separated values. All, if omitted.
.IP \(bu 2
.INDENT 2.0
.TP
\fBcolor\fP: Fixed color. Values are: red, green, blue, orange, pink, white,
yellow, daylight, purple. Default white.
.UNINDENT
.IP \(bu 2
\fBtransition\fP: Transition 0~200.
.UNINDENT
.sp
Advanced:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBgamut\fP: XY coordinates. Use gamut according to the Philips HUE devices documentation.
More: \fI\%http://www.developers.meethue.com/documentation/hue\-xy\-values\fP
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hue.color
salt \(aq*\(aq hue.color id=1
salt \(aq*\(aq hue.color id=1,2,3 oolor=red transition=30
salt \(aq*\(aq hue.color id=1 gamut=0.3,0.5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.philips_hue.call_effect(*args, **kwargs)
Set an effect to the lamp.
.sp
Options:
.INDENT 7.0
.IP \(bu 2
\fBid\fP: Specifies a device ID. Can be a comma\-separated values. All, if omitted.
.IP \(bu 2
\fBtype\fP: Type of the effect. Possible values are \(dqnone\(dq or \(dqcolorloop\(dq. Default \(dqnone\(dq.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hue.effect
salt \(aq*\(aq hue.effect id=1
salt \(aq*\(aq hue.effect id=1,2,3 type=colorloop
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.philips_hue.call_lights(*args, **kwargs)
Get info about all available lamps.
.sp
Options:
.INDENT 7.0
.IP \(bu 2
\fBid\fP: Specifies a device ID. Can be a comma\-separated values. All, if omitted.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hue.lights
salt \(aq*\(aq hue.lights id=1
salt \(aq*\(aq hue.lights id=1,2,3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.philips_hue.call_ping(*args, **kwargs)
Ping the lamps by issuing a short inversion blink to all available devices.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hue.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.philips_hue.call_rename(*args, **kwargs)
Rename a device.
.sp
Options:
.INDENT 7.0
.IP \(bu 2
\fBid\fP: Specifies a device ID. Only one device at a time.
.IP \(bu 2
\fBtitle\fP: Title of the device.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hue.rename id=1 title=\(aqWC for cats\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.philips_hue.call_status(*args, **kwargs)
Return the status of the lamps.
.sp
Options:
.INDENT 7.0
.IP \(bu 2
\fBid\fP: Specifies a device ID. Can be a comma\-separated values. All, if omitted.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hue.status
salt \(aq*\(aq hue.status id=1
salt \(aq*\(aq hue.status id=1,2,3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.philips_hue.call_switch(*args, **kwargs)
Switch lamp ON/OFF.
.sp
If no particular state is passed,
then lamp will be switched to the opposite state.
.sp
Options:
.INDENT 7.0
.IP \(bu 2
\fBid\fP: Specifies a device ID. Can be a comma\-separated values. All, if omitted.
.IP \(bu 2
\fBon\fP: True or False. Inverted current, if omitted
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hue.switch
salt \(aq*\(aq hue.switch id=1
salt \(aq*\(aq hue.switch id=1,2,3 on=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.philips_hue.call_temperature(*args, **kwargs)
Set the mired color temperature. More: \fI\%http://en.wikipedia.org/wiki/Mired\fP
.sp
Arguments:
.INDENT 7.0
.IP \(bu 2
\fBvalue\fP: 150~500.
.UNINDENT
.sp
Options:
.INDENT 7.0
.IP \(bu 2
\fBid\fP: Specifies a device ID. Can be a comma\-separated values. All, if omitted.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq hue.temperature value=150
salt \(aq*\(aq hue.temperature value=150 id=1
salt \(aq*\(aq hue.temperature value=150 id=1,2,3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.philips_hue.init(cnf)
Initialize the module.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.philips_hue.ping(*args, **kw)
Ping the lamps.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.philips_hue.shutdown(opts, *args, **kw)
Shuts down the service.
.UNINDENT
.SS salt.proxy.rest_sample
.sp
This is a simple proxy\-minion designed to connect to and communicate with
the bottle\-based web service contained in \fI\%https://github.com/saltstack/salt\-contrib/tree/master/proxyminion_rest_example\fP
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.alive(opts)
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.fix_outage()
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.fns()
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.grains()
Get the grains from the proxied device
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.grains_refresh()
Refresh the grains from the proxied device
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.id(opts)
Return a unique ID for this proxy minion.  This ID MUST NOT CHANGE.
If it changes while the proxy is running the salt\-master will get
really confused and may stop talking to this minion
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.init(opts)
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.initialized()
Since grains are loaded in many different places and some of those
places occur before the proxy can be initialized, return whether
our init() function has been called
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.package_install(name, **kwargs)
Install a \(dqpackage\(dq on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.package_list()
List \(dqpackages\(dq installed on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.package_remove(name)
Remove a \(dqpackage\(dq on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.package_status(name)
Check the installation status of a package on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.ping()
Is the REST server up?
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.service_list()
List \(dqservices\(dq on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.service_restart(name)
Restart a \(dqservice\(dq on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.service_start(name)
Start a \(dqservice\(dq on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.service_status(name)
Check if a service is running on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.service_stop(name)
Stop a \(dqservice\(dq on the REST server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.shutdown(opts)
For this proxy shutdown is a no\-op
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.test_from_state()
Test function so we have something to call from a state
:return:
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.rest_sample.uptodate(name)
Call the REST endpoint to see if the packages on the \(dqserver\(dq are up to date.
.UNINDENT
.SS salt.proxy.restconf
.sp
Proxy Minion to manage RESTCONF Devices
.INDENT 0.0
.TP
.B codeauthor
Jamie (Bear) Murphy <\fI\%jamiemurphyit@gmail.com\fP>
.TP
.B maturity
new
.TP
.B platform
any
.UNINDENT
.SS Usage
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To be able to use this module you need to enable RESTCONF on your device
and have https enabled.
.sp
Cisco Configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
switch# conf t
switch(config)# restconf
switch(config)# ip http secure\-server
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
RESTCONF requires modern OS distributions.
This plugin has been written specifically to use JSON RESTCONF endpoints
.UNINDENT
.UNINDENT
.SS Pillar
.sp
The \fBrestconf\fP proxy configuration requires the following parameters in order
to connect to the network switch:
.INDENT 0.0
.TP
.B transport: \fBhttps\fP (str)
Specifies the type of connection transport to use. Valid values for the
connection are \fBhttps\fP, and  \fBhttp\fP\&.
The RESTCONF standard explicitly requires https, but http is included as an option
as some manufacturers have ignored this requirement.
.TP
.B hostname: (str)
The IP address or DNS host name of the RESTCONF device.
.TP
.B username: (str)
The username for the device to authenticate the RESTCONF requests.
.TP
.B password: (str)
The password for the device to authenticate the RESTCONF requests.
.TP
.B verify: \fBTrue\fP or \fBFalse\fP (str, optional, default:true)
Verify the RESTCONF SSL certificate?
.sp
When there is no certificate configuration on the device and this option is
set as \fBTrue\fP (default), the commands will fail with the following error:
\fBSSLError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed\fP\&.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
In this case, you either need to configure a proper certificate on the
device (\fIrecommended\fP), or bypass the checks setting this argument as \fBFalse\fP
with all the security risks considered as you may be MITM\(aqd.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Proxy Pillar Example
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: restconf
  host: switch1.example.com
  username: example
  password: example
  verify: false
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.restconf.connection_test()
Runs a connection test via http/https. Returns an array.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.restconf.init(opts)
Required.
Initialize device config and test an initial connection
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.restconf.initialized()
Connection finished initializing?
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.restconf.ping()
Triggers connection test.
Returns True or False
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.restconf.request(path, method=\(aqGET\(aq, dict_payload=None)
Trigger http request to device
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.restconf.shutdown(opts)
Closes connection with the device.
.UNINDENT
.SS salt.proxy.ssh_sample
.sp
This is a simple proxy\-minion designed to connect to and communicate with
a server that exposes functionality via SSH.
This can be used as an option when the device does not provide
an api over HTTP and doesn\(aqt have the python stack to run a minion.
.INDENT 0.0
.TP
.B salt.proxy.ssh_sample.fns()
Method called by grains module.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.ssh_sample.grains()
Get the grains from the proxied device
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.ssh_sample.grains_refresh()
Refresh the grains from the proxied device
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.ssh_sample.init(opts)
Required.
Can be used to initialize the server connection.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.ssh_sample.initialized()
Since grains are loaded in many different places and some of those
places occur before the proxy can be initialized, return whether
our init() function has been called
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.ssh_sample.package_install(name, **kwargs)
Install a \(dqpackage\(dq on the ssh server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.ssh_sample.package_list()
List \(dqpackages\(dq by executing a command via ssh
This function is called in response to the salt command
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt target_minion pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.ssh_sample.package_remove(name)
Remove a \(dqpackage\(dq on the ssh server
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.ssh_sample.parse(out)
Extract json from out.
.INDENT 7.0
.TP
.B Parameter
out: Type string. The data returned by the
ssh command.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.ssh_sample.ping()
Required.
Ping the device on the other end of the connection
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.ssh_sample.service_list()
Start a \(dqservice\(dq on the ssh server
.sp
New in version 2015.8.2.

.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.ssh_sample.service_restart(name)
Restart a \(dqservice\(dq on the ssh server
.sp
New in version 2015.8.2.

.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.ssh_sample.service_start(name)
Start a \(dqservice\(dq on the ssh server
.sp
New in version 2015.8.2.

.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.ssh_sample.service_stop(name)
Stop a \(dqservice\(dq on the ssh server
.sp
New in version 2015.8.2.

.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.ssh_sample.shutdown(opts)
Disconnect
.UNINDENT
.SS salt.proxy.vcenter
.sp
Proxy Minion interface module for managing VMWare vCenters.
.INDENT 0.0
.TP
.B codeauthor
\fIRod McKenzie (roderick.mckenzie@morganstanley.com)\fP
.TP
.B codeauthor
\fIAlexandru Bleotu (alexandru.bleotu@morganstanley.com)\fP
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
pyVmomi Python Module
.UNINDENT
.SS pyVmomi
.sp
PyVmomi can be installed via pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Version 6.0 of pyVmomi has some problems with SSL error handling on certain
versions of Python. If using version 6.0 of pyVmomi, Python 2.6,
Python 2.7.9, or newer must be present. This is due to an upstream dependency
in pyVmomi 6.0 that is not supported in Python versions 2.7 to 2.7.8. If the
version of Python is not in the supported range, you will need to install an
earlier version of pyVmomi. See \fI\%Issue #29537\fP for more information.
.UNINDENT
.UNINDENT
.sp
Based on the note above, to install an earlier version of pyVmomi than the
version currently listed in PyPi, run the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi==5.5.0.2014.1.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The 5.5.0.2014.1.1 is a known stable version that this original ESXi State
Module was developed against.
.SS Configuration
.sp
To use this proxy module, please use on of the following configurations:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: vcenter
  vcenter: <ip or dns name of parent vcenter>
  username: <vCenter username>
  mechanism: userpass
  passwords:
    \- first_password
    \- second_password
    \- third_password

proxy:
  proxytype: vcenter
  vcenter: <ip or dns name of parent vcenter>
  username: <vCenter username>
  domain: <user domain>
  mechanism: sspi
  principal: <host kerberos principal>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS proxytype
.sp
The \fBproxytype\fP key and value pair is critical, as it tells Salt which
interface to load from the \fBproxy\fP directory in Salt\(aqs install hierarchy,
or from \fB/srv/salt/_proxy\fP on the Salt Master (if you have created your
own proxy module, for example). To use this Proxy Module, set this to
\fBvcenter\fP\&.
.SS vcenter
.sp
The location of the VMware vCenter server (host of ip). Required
.SS username
.sp
The username used to login to the vcenter, such as \fBroot\fP\&.
Required only for userpass.
.SS mechanism
.sp
The mechanism used to connect to the vCenter server. Supported values are
\fBuserpass\fP and \fBsspi\fP\&. Required.
.SS passwords
.sp
A list of passwords to be used to try and login to the vCenter server. At least
one password in this list is required if mechanism is \fBuserpass\fP
.sp
The proxy integration will try the passwords listed in order.
.SS domain
.sp
User domain. Required if mechanism is \fBsspi\fP
.SS principal
.sp
Kerberos principal. Rquired if mechanism is \fBsspi\fP
.SS protocol
.sp
If the vCenter is not using the default protocol, set this value to an
alternate protocol. Default is \fBhttps\fP\&.
.SS port
.sp
If the ESXi host is not using the default port, set this value to an
alternate port. Default is \fB443\fP\&.
.SS Salt Proxy
.sp
After your pillar is in place, you can test the proxy. The proxy can run on
any machine that has network connectivity to your Salt Master and to the
vCenter server in the pillar. SaltStack recommends that the machine running the
salt\-proxy process also run a regular minion, though it is not strictly
necessary.
.sp
On the machine that will run the proxy, make sure there is an \fB/etc/salt/proxy\fP
file with at least the following in it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: <ip or hostname of salt\-master>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can then start the salt\-proxy process with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy \-\-proxyid <id of the cluster>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You may want to add \fB\-l debug\fP to run the above in the foreground in
debug mode just to make sure everything is OK.
.sp
Next, accept the key for the proxy on your salt\-master, just like you
would for a regular minion:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-a <id you gave the vcenter host>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can confirm that the pillar data is in place for the proxy:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt <id> pillar.items
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And now you should be able to ping the ESXi host to make sure it is
responding:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt <id> test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
At this point you can execute one\-off commands against the vcenter. For
example, you can get if the proxy can actually connect to the vCenter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt <id> vsphere.test_vcenter_connection
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that you don\(aqt need to provide credentials or an ip/hostname. Salt
knows to use the credentials you stored in Pillar.
.sp
It\(aqs important to understand how this particular proxy works.
\fBSalt.modules.vsphere\fP is a
standard Salt execution module.
.sp
If you pull up the docs for it you\(aqll see that almost every function in the
module takes credentials and a targets either a vcenter or a host. When
credentials and a host aren\(aqt passed, Salt runs commands through \fBpyVmomi\fP
against the local machine. If you wanted, you could run functions from this
module on any host where an appropriate version of \fBpyVmomi\fP is installed,
and that host would reach out over the network and communicate with the ESXi
host.
.INDENT 0.0
.TP
.B salt.proxy.vcenter.find_credentials()
Cycle through all the possible credentials and return the first one that
works.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.vcenter.get_details()
Function that returns the cached details
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.vcenter.init(opts)
This function gets called when the proxy starts up.
For login the protocol and port are cached.
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.vcenter.ping()
Returns True.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt vcenter test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.proxy.vcenter.shutdown()
Shutdown the connection to the proxy device. For this proxy,
shutdown is a no\-op.
.UNINDENT
.SS queue modules
.TS
center;
|l|l|.
_
T{
\fI\%pgjsonb_queue\fP
T}	T{
New in version 2016.3.0.
T}
_
T{
\fI\%sqlite_queue\fP
T}	T{
New in version 2014.7.0.
T}
_
.TE
.SS salt.queues.pgjsonb_queue
.sp
New in version 2016.3.0.

.sp
This is a queue with postgres as the backend.  It uses the jsonb store to
store information for queues.
.INDENT 0.0
.TP
.B depends
python\-psycopg2
.UNINDENT
.sp
To enable this queue, the following needs to be configured in your master
config. These are the defaults:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
queue.pgjsonb.host: \(aqsalt\(aq
queue.pgjsonb.user: \(aqsalt\(aq
queue.pgjsonb.password: \(aqsalt\(aq
queue.pgjsonb.dbname: \(aqsalt\(aq
queue.pgjsonb.port: 5432
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Use the following Pg database schema:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
CREATE DATABASE  salt WITH ENCODING \(aqutf\-8\(aq;

\-\-
\-\- Table structure for table \(gasalt\(ga
\-\-
DROP TABLE IF EXISTS salt;
CREATE OR REPLACE TABLE salt(
   id SERIAL PRIMARY KEY,
   data jsonb NOT NULL
);
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run queue.insert test \(aq{\(dqname\(dq: \(dqredis\(dq, \(dqhost\(dq: \(dq172.16.0.8\(dq, \(dqport\(dq: 6379}\(aq backend=pgjsonb
salt\-run queue.process_queue test all backend=pgjsonb
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.queues.pgjsonb_queue.delete(queue, items)
Delete an item or items from a queue
.UNINDENT
.INDENT 0.0
.TP
.B salt.queues.pgjsonb_queue.handle_queue_creation(queue)
.UNINDENT
.INDENT 0.0
.TP
.B salt.queues.pgjsonb_queue.insert(queue, items)
Add an item or items to a queue
.UNINDENT
.INDENT 0.0
.TP
.B salt.queues.pgjsonb_queue.list_items(queue)
List contents of a queue
.UNINDENT
.INDENT 0.0
.TP
.B salt.queues.pgjsonb_queue.list_length(queue)
Provide the number of items in a queue
.UNINDENT
.INDENT 0.0
.TP
.B salt.queues.pgjsonb_queue.list_queues()
Return a list of Salt Queues on the Salt Master
.UNINDENT
.INDENT 0.0
.TP
.B salt.queues.pgjsonb_queue.pop(queue, quantity=1, is_runner=False)
Pop one or more or all items from the queue return them.
.UNINDENT
.SS salt.queues.sqlite_queue
.sp
New in version 2014.7.0.

.sp
This is the default local master event queue built on sqlite.  By default, an
sqlite3 database file is created in the \fIsqlite_queue_dir\fP which is found at:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/var/cache/salt/master/queues
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs possible to store the sqlite3 database files by setting \fIsqlite_queue_dir\fP
to another location:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sqlite_queue_dir: /home/myuser/salt/master/queues
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.queues.sqlite_queue.delete(queue, items)
Delete an item or items from a queue
.UNINDENT
.INDENT 0.0
.TP
.B salt.queues.sqlite_queue.insert(queue, items)
Add an item or items to a queue
.UNINDENT
.INDENT 0.0
.TP
.B salt.queues.sqlite_queue.list_items(queue)
List contents of a queue
.UNINDENT
.INDENT 0.0
.TP
.B salt.queues.sqlite_queue.list_length(queue)
Provide the number of items in a queue
.UNINDENT
.INDENT 0.0
.TP
.B salt.queues.sqlite_queue.list_queues()
Return a list of Salt Queues on the Salt Master
.UNINDENT
.INDENT 0.0
.TP
.B salt.queues.sqlite_queue.pop(queue, quantity=1, is_runner=False)
Pop one or more or all items from the queue return them.
.UNINDENT
.SS roster modules
.TS
center;
|l|l|.
_
T{
\fI\%ansible\fP
T}	T{
Read in an Ansible inventory file or script.
T}
_
T{
\fI\%cache\fP
T}	T{
The \fBcache\fP roster provides a flexible interface to the Salt Masters\(aq minion cache to access regular minions over \fBsalt\-ssh\fP\&.
T}
_
T{
\fI\%cloud\fP
T}	T{
Use the cloud cache on the master to derive IPv4 addresses based on minion ID.
T}
_
T{
\fI\%clustershell\fP
T}	T{
This roster resolves hostname in a pdsh/clustershell style.
T}
_
T{
\fI\%dir\fP
T}	T{
Create a salt roster out of a flat directory of files.
T}
_
T{
\fI\%flat\fP
T}	T{
Read in the roster from a flat file using the renderer system
T}
_
T{
\fI\%range\fP
T}	T{
This roster resolves targets from a range server.
T}
_
T{
\fI\%scan\fP
T}	T{
Scan a netmask or ipaddr for open ssh ports
T}
_
T{
\fI\%sshconfig\fP
T}	T{
Parses roster entries out of Host directives from SSH config
T}
_
T{
\fI\%sshknownhosts\fP
T}	T{
Parses roster entries out of Host directives from SSH known_hosts
T}
_
T{
\fI\%terraform\fP
T}	T{
Dynamic roster from terraform current state
T}
_
.TE
.SS salt.roster.ansible
.sp
Read in an Ansible inventory file or script.
.sp
Flat inventory files should be in the regular ansible inventory format.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /tmp/example_roster
[servers]
salt.gtmanfred.com ansible_ssh_user=gtmanfred ansible_ssh_host=127.0.0.1 ansible_ssh_port=22 ansible_ssh_pass=\(aqpassword\(aq ansible_sudo_pass=\(aqpassword\(aq

[desktop]
home ansible_ssh_user=gtmanfred ansible_ssh_host=12.34.56.78 ansible_ssh_port=23 ansible_ssh_pass=\(aqpassword\(aq ansible_sudo_pass=\(aqpassword\(aq

[computers:children]
desktop
servers

[computers:vars]
http_port=80
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
then salt\-ssh can be used to hit any of them
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[~]# salt\-ssh \-\-roster=ansible \-\-roster\-file=/tmp/example_roster \-N all test.ping
salt.gtmanfred.com:
    True
home:
    True
[~]# salt\-ssh \-\-roster=ansible \-\-roster\-file=/tmp/example_roster \-N desktop test.ping
home:
    True
[~]# salt\-ssh \-\-roster=ansible \-\-roster\-file=/tmp/example_roster \-N computers test.ping
salt.gtmanfred.com:
    True
home:
    True
[~]# salt\-ssh \-\-roster=ansible \-\-roster\-file=/tmp/example_roster salt.gtmanfred.com test.ping
salt.gtmanfred.com:
    True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There is also the option of specifying a dynamic inventory, and generating it on the fly
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!/bin/bash
# filename: /etc/salt/hosts
echo \(aq{
    \(dqservers\(dq: [
        \(dqsalt.gtmanfred.com\(dq
    ],
    \(dqdesktop\(dq: [
        \(dqhome\(dq
    ],
    \(dqcomputers\(dq: {
        \(dqhosts\(dq: [],
        \(dqchildren\(dq: [
            \(dqdesktop\(dq,
            \(dqservers\(dq
        ],
        \(dqvars\(dq: {
            \(dqhttp_port\(dq: 80
        }
    },
    \(dq_meta\(dq: {
        \(dqhostvars\(dq: {
            \(dqsalt.gtmanfred.com\(dq: {
                \(dqansible_ssh_user\(dq: \(dqgtmanfred\(dq,
                \(dqansible_ssh_host\(dq: \(dq127.0.0.1\(dq,
                \(dqansible_sudo_pass\(dq: \(dqpassword\(dq,
                \(dqansible_ssh_pass\(dq: \(dqpassword\(dq,
                \(dqansible_ssh_port\(dq: 22
            },
            \(dqhome\(dq: {
                \(dqansible_ssh_user\(dq: \(dqgtmanfred\(dq,
                \(dqansible_ssh_host\(dq: \(dq12.34.56.78\(dq,
                \(dqansible_sudo_pass\(dq: \(dqpassword\(dq,
                \(dqansible_ssh_pass\(dq: \(dqpassword\(dq,
                \(dqansible_ssh_port\(dq: 23
            }
        }
    }
}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is the format that an inventory script needs to output to work with ansible, and thus here.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[~]# salt\-ssh \-\-roster=ansible \-\-roster\-file /etc/salt/hosts salt.gtmanfred.com test.ping
salt.gtmanfred.com:
        True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
A dynamic inventory script must have the executable bit set. In the above
example, \fBchmod +x /etc/salt/hosts\fP\&.
.UNINDENT
.UNINDENT
.sp
Any of the [groups] or direct hostnames will return.  The \(aqall\(aq is special, and returns everything.
.INDENT 0.0
.TP
.B salt.roster.ansible.targets(tgt, tgt_type=\(aqglob\(aq, **kwargs)
Return the targets from the ansible inventory_file
Default: /etc/salt/roster
.UNINDENT
.SS salt.roster.cache
.sp
The \fBcache\fP roster provides a flexible interface to the Salt Masters\(aq minion cache
to access regular minions over \fBsalt\-ssh\fP\&.
.sp
New in version 2017.7.0:
.INDENT 0.0
.IP \(bu 2
grains, pillar, mine data matching
.IP \(bu 2
SDB URLs
.IP \(bu 2
IPv6 support
.IP \(bu 2
roster_order per config key
.IP \(bu 2
default order changed to industry\-wide best practices
.IP \(bu 2
CIDR range selection
.UNINDENT

.SS Targeting
.sp
This roster supports all matching and targeting of the Salt Master.
The matching will be done using only the Salt Master\(aqs cache.
.SS The Roster Order
.sp
The roster\(aqs composition can be configured using \fBroster_order\fP\&.
In the \fBroster_order\fP you can define \fIany\fP roster key and fill it with a parameter
overriding the one in \fBroster_defaults\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
roster_order:
    host: id          # use the minion id as hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can define lists of parameters as well, the first result from the list will become the value.
.SS Selecting a host
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# default
roster_order:
    host:
      \- ipv6\-private  # IPv6 addresses in private ranges
      \- ipv6\-global   # IPv6 addresses in global ranges
      \- ipv4\-private  # IPv4 addresses in private ranges
      \- ipv4\-public   # IPv4 addresses in public ranges
      \- ipv4\-local    # loopback addresses
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is the default \fBroster_order\fP\&.
It prefers IPv6 over IPv4 addresses and private addresses over public ones.
The relevant data will be fetched from the cache in\-order, and the first match will fill the \fBhost\fP key.
.sp
Other address selection parameters are also possible:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
roster_order:
  host:
    \- global|public|private|local    # Both IPv6 and IPv4 addresses in that range
    \- 2000::/3                       # CIDR networks, both IPv4 and IPv6 are supported
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Using cached data
.sp
Several cached libraries can be selected using the \fBlibrary: \(ga\(ga prefix, followed by the library key.
This can be referenced using the same \(ga\(ga:\fP syntax as e.g. \fI\%pillar.get\fP\&.
Lists of references are also supported during the lookup, as are Salt SDB URLs.
.sp
This should be especially useful for the other roster keys:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
roster_order:
  host:
    \- grain: fqdn_ip4                # Lookup this grain
    \- mine: network.ip_addrs         # Mine data lookup works the same

  password: sdb://vault/ssh_pass     # Salt SDB URLs are also supported

  user:
    \- pillar: ssh:auth:user          # Lookup this pillar key
    \- sdb://osenv/USER               # Lookup this env var through sdb

  priv:
    \- pillar:                        # Lists are also supported
        \- salt:ssh:private_key
        \- ssh:auth:private_key
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.roster.cache.targets(tgt, tgt_type=\(aqglob\(aq, **kwargs)
Return the targets from the Salt Masters\(aq minion cache.
All targets and matchers are supported.
.sp
The resulting roster can be configured using \fBroster_order\fP and \fBroster_default\fP\&.
.UNINDENT
.SS salt.roster.cloud
.sp
Use the cloud cache on the master to derive IPv4 addresses based on minion ID.
.sp
This roster requires that the minion in question was created using at least the
2015.5.0 version of Salt Cloud. Starting with the 2015.5.0 release, Salt Cloud
maintains an index of minions that it creates and deletes. This index tracks the
provider and profile configuration used to provision the minion, including
authentication information. So long as this configuration remains current, it can
be used by Salt SSH to log into any minion in the index.
.sp
To connect as a user other than root, modify the cloud configuration file
usually located at /etc/salt/cloud. For example, add the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_username: my_user
sudo: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.roster.cloud.extract_ipv4(roster_order, ipv4)
Extract the preferred IP address from the ipv4 grain
.UNINDENT
.INDENT 0.0
.TP
.B salt.roster.cloud.targets(tgt, tgt_type=\(aqglob\(aq, **kwargs)
Return the targets from the flat yaml file, checks opts for location but
defaults to /etc/salt/roster
.UNINDENT
.SS salt.roster.clustershell
.sp
This roster resolves hostname in a pdsh/clustershell style.
.INDENT 0.0
.TP
.B depends
clustershell, \fI\%https://github.com/cea\-hpc/clustershell\fP
.UNINDENT
.sp
When you want to use host globs for target matching, use \fB\-\-roster clustershell\fP\&. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-ssh \-\-roster clustershell \(aqserver_[1\-10,21\-30],test_server[5,7,9]\(aq test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.roster.clustershell.targets(tgt, tgt_type=\(aqglob\(aq, **kwargs)
Return the targets
.UNINDENT
.SS salt.roster.dir
.sp
Create a salt roster out of a flat directory of files.
.sp
Each filename in the directory is a minion id.
The contents of each file is rendered using the salt renderer system.
.sp
Consider the following configuration for example:
.sp
config/master:
.INDENT 0.0
.INDENT 3.5
\&...
roster: dir
roster_dir: config/roster.d
\&...
.UNINDENT
.UNINDENT
.sp
Where the directory config/roster.d contains two files:
.sp
config/roster.d/minion\-x:
.INDENT 0.0
.INDENT 3.5
host: minion\-x.example.com
port: 22
sudo: true
user: ubuntu
.UNINDENT
.UNINDENT
.sp
config/roster.d/minion\-y:
.INDENT 0.0
.INDENT 3.5
host: minion\-y.example.com
port: 22
sudo: true
user: gentoo
.UNINDENT
.UNINDENT
.sp
The roster would find two minions: minion\-x and minion\-y, with the given host, port, sudo and user settings.
.sp
The directory roster also extends the concept of roster defaults by supporting a roster_domain value in config:
.INDENT 0.0
.INDENT 3.5
\&...
roster_domain: example.org
\&...
.UNINDENT
.UNINDENT
.sp
If that option is set, then any roster without a \(aqhost\(aq setting will have an implicit host of
its minion id + \(aq.\(aq + the roster_domain. (The default roster_domain is the empty string,
so you can also name the files the fully qualified name of each host. However, if you do that,
then the fully qualified name of each host is also the minion id.)
.sp
This makes it possible to avoid having to specify the hostnames when you always want them to match
their minion id plus some domain.
.INDENT 0.0
.TP
.B salt.roster.dir.targets(tgt, tgt_type=\(aqglob\(aq, **kwargs)
Return the targets from the directory of flat yaml files,
checks opts for location.
.UNINDENT
.SS salt.roster.flat
.sp
Read in the roster from a flat file using the renderer system
.INDENT 0.0
.TP
.B salt.roster.flat.targets(tgt, tgt_type=\(aqglob\(aq, **kwargs)
Return the targets from the flat yaml file, checks opts for location but
defaults to /etc/salt/roster
.UNINDENT
.SS salt.roster.range
.sp
This roster resolves targets from a range server.
.INDENT 0.0
.TP
.B depends
seco.range, \fI\%https://github.com/ytoolshed/range\fP
.UNINDENT
.sp
When you want to use a range query for target matching, use \fB\-\-roster range\fP\&. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-ssh \-\-roster range \(aq%%%example.range.cluster\(aq test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.roster.range.target_glob(tgt, hosts)
.UNINDENT
.INDENT 0.0
.TP
.B salt.roster.range.target_range(tgt, hosts)
.UNINDENT
.INDENT 0.0
.TP
.B salt.roster.range.targets(tgt, tgt_type=\(aqrange\(aq, **kwargs)
Return the targets from a range query
.UNINDENT
.SS salt.roster.scan
.sp
Scan a netmask or ipaddr for open ssh ports
.INDENT 0.0
.TP
.B class  salt.roster.scan.RosterMatcher(tgt, tgt_type)
Matcher for the roster data structure
.INDENT 7.0
.TP
.B targets()
Return ip addrs based on netmask, sitting in the \(dqglob\(dq spot because
it is the default
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.roster.scan.targets(tgt, tgt_type=\(aqglob\(aq, **kwargs)
Return the targets from the flat yaml file, checks opts for location but
defaults to /etc/salt/roster
.UNINDENT
.SS salt.roster.sshconfig
.sp
Parses roster entries out of Host directives from SSH config
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-ssh \-\-roster sshconfig \(aq*\(aq \-r \(dqecho hi\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.roster.sshconfig.RosterMatcher(raw, tgt, tgt_type)
Matcher for the roster data structure
.INDENT 7.0
.TP
.B get_data(minion)
Return the configured ip
.UNINDENT
.INDENT 7.0
.TP
.B ret_glob_minions()
Return minions that match via glob
.UNINDENT
.INDENT 7.0
.TP
.B targets()
Execute the correct tgt_type routine and return
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.roster.sshconfig.parse_ssh_config(lines)
Parses lines from the SSH config to create roster targets.
.INDENT 7.0
.TP
.B Parameters
\fBlines\fP \-\- Individual lines from the ssh config file
.TP
.B Returns
Dictionary of targets in similar style to the flat roster
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.roster.sshconfig.targets(tgt, tgt_type=\(aqglob\(aq, **kwargs)
Return the targets from the flat yaml file, checks opts for location but
defaults to /etc/salt/roster
.UNINDENT
.SS salt.roster.sshknownhosts
.sp
Parses roster entries out of Host directives from SSH known_hosts
.sp
New in version 3006.0.

.sp
Sample configuration:
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBknown_hosts\fP file only contains hostname/IP. To pass other parameters,
use \fBroster_defaults\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_known_hosts_file: /Users/user1/.ssh/known_hosts
roster_defaults:
  user: user1
  sudo: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now you can use the module
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-ssh \-\-roster sshknownhosts \(aq*\(aq \-r \(dqecho hi\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or with a Saltfile
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-ssh:
  ssh_known_hosts_file: /Users/user1/.ssh/known_hosts
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-ssh \-\-roster sshknownhosts \(aq*\(aq \-r \(dqecho hi\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.roster.sshknownhosts.targets(tgt, tgt_type=\(aqglob\(aq)
Return the targets from a known_hosts file
.UNINDENT
.SS salt.roster.terraform
.SS Dynamic roster from terraform current state
.sp
This roster module allows you dynamically generate the roster from the terraform
resources defined with the \fI\%Terraform Salt\fP provider.
.sp
It exposes all salt_host resources with the same attributes to the salt\-ssh
roster, making it completely independent of the type of terraform resource, and
providing the integration using terraform constructs with interpolation.
.SS Basic Example
.sp
Given a simple salt\-ssh tree with a Saltfile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-ssh:
  config_dir: etc/salt
  max_procs: 30
  wipe_ssh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
and \fBetc/salt/master\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
root_dir: .
  file_roots:
    base:
      \- srv/salt
  pillar_roots:
    base:
      \- srv/pillar
  roster: terraform
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the same folder as your \fBSaltfile\fP, create terraform file with resources
like cloud instances, virtual machines, etc. For every single one of those that
you want to manage with Salt, create a \fBsalt_host\fP resource:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
resource \(dqsalt_host\(dq \(dqdbminion\(dq {
  salt_id = \(dqdbserver\(dq
  host = \(dq${libvirt_domain.vm\-db.network_interface.0.addresses.0}\(dq
  user = \(dqroot\(dq
  passwd = \(dqlinux\(dq
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can use the count attribute to create multiple roster entries with a single
definition. Please refer to the \fI\%Terraform Salt\fP provider for more detailed
examples.
.INDENT 0.0
.TP
.B salt.roster.terraform.targets(tgt, tgt_type=\(aqglob\(aq, **kwargs)
Returns the roster from the terraform state file, checks opts for location, but defaults to terraform.tfstate
.UNINDENT
.SS runner modules
.TS
center;
|l|l|.
_
T{
\fI\%asam\fP
T}	T{
Novell ASAM Runner
T}
_
T{
\fI\%auth\fP
T}	T{
Authentication runner for creating, deleting, and managing eauth tokens.
T}
_
T{
\fI\%bgp\fP
T}	T{
BGP Finder
T}
_
T{
\fI\%cache\fP
T}	T{
Return cached data from minions
T}
_
T{
\fI\%cloud\fP
T}	T{
The Salt Cloud Runner
T}
_
T{
\fI\%config\fP
T}	T{
This runner is designed to mirror the execution module config.py, but for master settings
T}
_
T{
\fI\%ddns\fP
T}	T{
Dynamic DNS Runner
T}
_
T{
\fI\%digicertapi\fP
T}	T{
Support for Digicert.
T}
_
T{
\fI\%doc\fP
T}	T{
A runner module to collect and display the inline documentation from the various module types
T}
_
T{
\fI\%drac\fP
T}	T{
Manage Dell DRAC from the Master
T}
_
T{
\fI\%error\fP
T}	T{
Error generator to enable integration testing of salt runner error handling
T}
_
T{
\fI\%event\fP
T}	T{
Module for sending events using the runner system.
T}
_
T{
\fI\%f5\fP
T}	T{
Runner to provide F5 Load Balancer functionality
T}
_
T{
\fI\%fileserver\fP
T}	T{
Directly manage the Salt fileserver plugins
T}
_
T{
\fI\%git_pillar\fP
T}	T{
Runner module to directly manage the git external pillar
T}
_
T{
\fI\%http\fP
T}	T{
Module for making various web calls.
T}
_
T{
\fI\%jobs\fP
T}	T{
A convenience system to manage jobs, both active and already run
T}
_
T{
\fI\%launchd\fP
T}	T{
Manage launchd plist files
T}
_
T{
\fI\%lxc\fP
T}	T{
Control Linux Containers via Salt
T}
_
T{
\fI\%manage\fP
T}	T{
General management functions for salt, tools like seeing what hosts are up and what hosts are down
T}
_
T{
\fI\%match\fP
T}	T{
Run matchers from the master context.
T}
_
T{
\fI\%mattermost\fP
T}	T{
Module for sending messages to Mattermost
T}
_
T{
\fI\%mine\fP
T}	T{
A runner to access data from the salt mine
T}
_
T{
\fI\%nacl\fP
T}	T{
This module helps include encrypted passwords in pillars, grains and salt state files.
T}
_
T{
\fI\%net\fP
T}	T{
NET Finder
T}
_
T{
\fI\%network\fP
T}	T{
Network tools to run from the Master
T}
_
T{
\fI\%pagerduty\fP
T}	T{
Runner Module for Firing Events via PagerDuty
T}
_
T{
\fI\%pillar\fP
T}	T{
Functions to interact with the pillar compiler on the master
T}
_
T{
\fI\%pkg\fP
T}	T{
Package helper functions using \fBsalt.modules.pkg\fP
T}
_
T{
\fI\%queue\fP
T}	T{
General management and processing of queues.
T}
_
T{
\fI\%reactor\fP
T}	T{
A convenience system to manage reactors
T}
_
T{
\fI\%salt\fP
T}	T{
This runner makes Salt\(aqs execution modules available on the salt master.
T}
_
T{
\fI\%saltutil\fP
T}	T{
The Saltutil runner is used to sync custom types to the Master.
T}
_
T{
\fI\%sdb\fP
T}	T{
Runner for setting and querying data via the sdb API on the master
T}
_
T{
\fI\%smartos_vmadm\fP
T}	T{
Runner for SmartOS minions control vmadm
T}
_
T{
\fI\%spacewalk\fP
T}	T{
Spacewalk Runner
T}
_
T{
\fI\%ssh\fP
T}	T{
A Runner module interface on top of the salt\-ssh Python API.
T}
_
T{
\fI\%state\fP
T}	T{
Execute orchestration functions
T}
_
T{
\fI\%survey\fP
T}	T{
A general map/reduce style salt runner for aggregating results returned by several different minions.
T}
_
T{
\fI\%test\fP
T}	T{
This runner is used only for test purposes and serves no production purpose
T}
_
T{
\fI\%thin\fP
T}	T{
The thin runner is used to manage the salt thin systems.
T}
_
T{
\fI\%vault\fP
T}	T{
T}
_
T{
\fI\%venafiapi\fP
T}	T{
Support for Venafi
T}
_
T{
\fI\%virt\fP
T}	T{
Control virtual machines via Salt
T}
_
T{
\fI\%vistara\fP
T}	T{
Vistara Runner
T}
_
T{
\fI\%winrepo\fP
T}	T{
Runner to manage Windows software repo
T}
_
.TE
.SS salt.runners.asam
.SS Novell ASAM Runner
.sp
New in version 2015.8.0.

.sp
Runner to interact with Novell ASAM Fan\-Out Driver
.INDENT 0.0
.TP
.B codeauthor
Nitin Madhok <\fI\%nmadhok@g.clemson.edu\fP>
.UNINDENT
.sp
To use this runner, set up the Novell Fan\-Out Driver URL, username and password in the
master configuration at \fB/etc/salt/master\fP or \fB/etc/salt/master.d/asam.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
asam:
  prov1.domain.com
    username: \(dqtestuser\(dq
    password: \(dqverybadpass\(dq
    verify_ssl: true
  prov2.domain.com
    username: \(dqtestuser\(dq
    password: \(dqverybadpass\(dq
    verify_ssl: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Optionally, \fBprotocol\fP and \fBport\fP can be specified if the Fan\-Out Driver server
is not using the defaults. Default is \fBprotocol: https\fP and \fBport: 3451\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.runners.asam.ASAMHTMLParser
.INDENT 7.0
.TP
.B handle_starttag(tag, attrs)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.asam.add_platform(name, platform_set, server_url)
To add an ASAM platform using the specified ASAM platform set on the Novell
Fan\-Out Driver
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run asam.add_platform my\-test\-vm test\-platform\-set prov1.domain.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.asam.list_platform_sets(server_url)
To list all ASAM platform sets present on the Novell Fan\-Out Driver
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run asam.list_platform_sets prov1.domain.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.asam.list_platforms(server_url)
To list all ASAM platforms present on the Novell Fan\-Out Driver
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run asam.list_platforms prov1.domain.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.asam.remove_platform(name, server_url)
To remove specified ASAM platform from the Novell Fan\-Out Driver
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run asam.remove_platform my\-test\-vm prov1.domain.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.auth
.sp
Authentication runner for creating, deleting, and managing eauth tokens.
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.runners.auth.del_token(token)
Delete an eauth token by name
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run auth.del_token 6556760736e4077daa601baec2b67c24
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.auth.mk_token(**load)
Create an eauth token using provided credentials
.sp
Non\-root users may specify an expiration date \-\- if allowed via the
\fI\%token_expire_user_override\fP setting \-\- by passing an
additional \fBtoken_expire\fP param. This overrides the
\fI\%token_expire\fP setting of the same name in the Master config
and is how long a token should live in seconds.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run auth.mk_token username=saltdev password=saltdev eauth=auto

# Create a token valid for three years.
salt\-run auth.mk_token username=saltdev password=saltdev eauth=auto \e
    token_expire=94670856

# Calculate the number of seconds using expr.
salt\-run auth.mk_token username=saltdev password=saltdev eauth=auto \e
    token_expire=$(expr \e( 365 \e* 24 \e* 60 \e* 60 \e) \e* 3)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.bgp
.SS BGP Finder
.sp
New in version 2017.7.0.

.sp
Runner to search BGP neighbors details.
.SS Configuration
.INDENT 0.0
.IP \(bu 2
Minion (proxy) config
.INDENT 2.0
.INDENT 3.5
The \fBbgp.neighbors\fP function must be appened in the list of \fBmine_functions\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_functions:
  bgp.neighbors: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Which instructs Salt to cache the data returned by the \fBneighbors\fP function
from the \fI\%NAPALM BGP module\fP\&.
.sp
How often the mines are refreshed, can be specified using:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_interval: <X minutes>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
Master config
.INDENT 2.0
.INDENT 3.5
By default the following options can be configured on the master.
They are not mandatory, but available in case the user has different requirements.
.INDENT 0.0
.TP
.B tgt: \fB*\fP
From what minions will collect the mine data.
Default: \fB*\fP (collect mine data from all minions)
.TP
.B tgt_type: \fBglob\fP
Minion matching expression form. Default: \fBglob\fP\&.
.TP
.B return_fields
What fields to return in the output.
It can display all the fields from the \fBneighbors\fP function
from the \fI\%NAPALM BGP module\fP\&.
.sp
Some fields cannot be removed:
.INDENT 7.0
.IP \(bu 2
\fBas_number\fP: the AS number of the neighbor
.IP \(bu 2
\fBdevice\fP: the minion ID
.IP \(bu 2
\fBneighbor_address\fP: the neighbor remote IP address
.UNINDENT
.sp
By default, the following extra fields are returned (displayed):
.INDENT 7.0
.IP \(bu 2
\fBconnection_stats\fP: connection stats, as described below
.IP \(bu 2
\fBimport_policy\fP: the name of the import policy
.IP \(bu 2
\fBexport_policy\fP: the name of the export policy
.UNINDENT
.sp
Special fields:
.INDENT 7.0
.IP \(bu 2
\fBvrf\fP: return the name of the VRF.
.IP \(bu 2
\fBconnection_stats\fP: returning an output of the form \fB<State>
<Active>/<Received>/<Accepted>/<Damped>\fP, e.g.  \fBEstablished
398/399/399/0\fP similar to the usual output from network devices.
.IP \(bu 2
\fBinterface_description\fP: matches the neighbor details with the
corresponding interface and returns its description. This will reuse
functionality from the \fI\%net runner\fP, so the user needs to enable the mines
as specified in the documentation.
.IP \(bu 2
\fBinterface_name\fP: matches the neighbor details with the
corresponding interface and returns the name.  Similar to
\fBinterface_description\fP, this will reuse functionality from the
\fI\%net runner\fP, so the user needs to
enable the mines as specified in the documentation.
.UNINDENT
.TP
.B display: \fBTrue\fP
Display on the screen or return structured object? Default: \fBTrue\fP (return on the CLI).
.TP
.B outputter: \fBtable\fP
Specify the outputter name when displaying on the CLI. Default: \fI\%table\fP\&.
.UNINDENT
.sp
Configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
runners:
  bgp:
    tgt: \(aqedge*\(aq
    tgt_type: \(aqglob\(aq
    return_fields:
      \- up
      \- connection_state
      \- previous_connection_state
      \- suppress_4byte_as
      \- holdtime
      \- flap_count
    outputter: yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.bgp.neighbors(*asns, **kwargs)
Search for BGP neighbors details in the mines of the \fBbgp.neighbors\fP function.
.sp
Arguments:
.INDENT 7.0
.TP
.B asns
A list of AS numbers to search for.
The runner will return only the neighbors of these AS numbers.
.TP
.B device
Filter by device name (minion ID).
.TP
.B ip
Search BGP neighbor using the IP address.
In multi\-VRF environments, the same IP address could be used by
more than one neighbors, in different routing tables.
.TP
.B network
Search neighbors within a certain IP network.
.TP
.B title
Custom title.
.TP
.B display: \fBTrue\fP
Display on the screen or return structured object? Default: \fBTrue\fP (return on the CLI).
.TP
.B outputter: \fBtable\fP
Specify the outputter name when displaying on the CLI. Default: \fI\%table\fP\&.
.UNINDENT
.sp
In addition, any field from the output of the \fBneighbors\fP function
from the \fI\%NAPALM BGP module\fP can be used as a filter.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run bgp.neighbors 13335 15169
salt\-run bgp.neighbors 13335 ip=172.17.19.1
salt\-run bgp.neighbors multipath=True
salt\-run bgp.neighbors up=False export_policy=my\-export\-policy multihop=False
salt\-run bgp.neighbors network=192.168.0.0/16
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
BGP Neighbors for 13335, 15169
________________________________________________________________________________________________________________________________________________________________
|    Device    | AS Number |         Neighbor Address        | State|#Active/Received/Accepted/Damped |         Policy IN         |         Policy OUT         |
________________________________________________________________________________________________________________________________________________________________
| edge01.bjm01 |   13335   |          172.17.109.11          |        Established 0/398/398/0         |       import\-policy       |        export\-policy       |
________________________________________________________________________________________________________________________________________________________________
| edge01.bjm01 |   13335   |          172.17.109.12          |       Established 397/398/398/0        |       import\-policy       |        export\-policy       |
________________________________________________________________________________________________________________________________________________________________
| edge01.flw01 |   13335   |          192.168.172.11         |        Established 1/398/398/0         |       import\-policy       |        export\-policy       |
________________________________________________________________________________________________________________________________________________________________
| edge01.oua01 |   13335   |          172.17.109.17          |          Established 0/0/0/0           |       import\-policy       |        export\-policy       |
________________________________________________________________________________________________________________________________________________________________
| edge01.bjm01 |   15169   |             2001::1             |       Established 102/102/102/0        |       import\-policy       |        export\-policy       |
________________________________________________________________________________________________________________________________________________________________
| edge01.bjm01 |   15169   |             2001::2             |       Established 102/102/102/0        |       import\-policy       |        export\-policy       |
________________________________________________________________________________________________________________________________________________________________
| edge01.tbg01 |   13335   |          192.168.172.17         |          Established 0/1/1/0           |       import\-policy       |        export\-policy       |
________________________________________________________________________________________________________________________________________________________________
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.cache
.sp
Return cached data from minions
.INDENT 0.0
.TP
.B salt.runners.cache.clear_all(tgt=None, tgt_type=\(aqglob\(aq)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Clear the cached pillar, grains, and mine data of the targeted minions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cache.clear_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cache.clear_git_lock(role, remote=None, **kwargs)
New in version 2015.8.2.

.sp
Remove the update locks for Salt components (gitfs, git_pillar, winrepo)
which use gitfs backend code from salt.utils.gitfs.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Running \fI\%cache.clear_all\fP will
not include this function as it does for pillar, grains, and mine.
.sp
Additionally, executing this function with a \fBrole\fP of \fBgitfs\fP is
equivalent to running \fBsalt\-run fileserver.clear_lock backend=git\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B role
Which type of lock to remove (\fBgitfs\fP, \fBgit_pillar\fP, or
\fBwinrepo\fP)
.TP
.B remote
If specified, then any remotes which contain the passed string will
have their lock cleared. For example, a \fBremote\fP value of \fBgithub\fP
will remove the lock from all github.com remotes.
.TP
.B type
update,checkout,mountpoint
The types of lock to clear. Can be one or more of \fBupdate\fP,
\fBcheckout\fP, and \fBmountpoint\fP, and can be passed either as a
comma\-separated or Python list.
.sp
New in version 2015.8.8.

.sp
Changed in version 2018.3.0: \fBmountpoint\fP lock type added

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cache.clear_git_lock gitfs
salt\-run cache.clear_git_lock git_pillar
salt\-run cache.clear_git_lock git_pillar type=update
salt\-run cache.clear_git_lock git_pillar type=update,checkout
salt\-run cache.clear_git_lock git_pillar type=\(aq[\(dqupdate\(dq, \(dqmountpoint\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cache.clear_grains(tgt=None, tgt_type=\(aqglob\(aq)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Clear the cached grains data of the targeted minions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cache.clear_grains
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cache.clear_mine(tgt=None, tgt_type=\(aqglob\(aq)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Clear the cached mine data of the targeted minions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cache.clear_mine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cache.clear_mine_func(tgt=None, tgt_type=\(aqglob\(aq, clear_mine_func_flag=None)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Clear the cached mine function data of the targeted minions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cache.clear_mine_func tgt=\(aq*\(aq clear_mine_func_flag=\(aqnetwork.interfaces\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cache.clear_pillar(tgt=None, tgt_type=\(aqglob\(aq)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Clear the cached pillar data of the targeted minions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cache.clear_pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cache.cloud(tgt, provider=None)
Return cloud cache data for target.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Only works with glob matching
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B tgt
Glob Target to match minion ids
.TP
.B provider
Cloud Provider
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cache.cloud \(aqsalt*\(aq
salt\-run cache.cloud glance.example.org provider=openstack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cache.fetch(bank, key, cachedir=None)
Fetch data from a salt.cache bank.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cache.fetch cloud/active/ec2/myec2 myminion cachedir=/var/cache/salt/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cache.flush(bank, key=None, cachedir=None)
Remove the key from the cache bank with all the key content. If no key is
specified remove the entire bank with all keys and sub\-banks inside.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cache.flush cloud/active/ec2/myec2 cachedir=/var/cache/salt/
salt\-run cache.flush cloud/active/ec2/myec2 myminion cachedir=/var/cache/salt/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cache.grains(tgt, tgt_type=\(aqglob\(aq, **kwargs)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Return cached grains of the targeted minions.
.INDENT 7.0
.TP
.B tgt
Target to match minion ids.
.sp
Changed in version 2017.7.5,2018.3.0: The \fBtgt\fP argument is now required to display cached grains. If
not used, the function will not return grains. This optional
argument will become mandatory in the Salt \fB3001\fP release.

.TP
.B tgt_type
The type of targeting to use for matching, such as \fBglob\fP, \fBlist\fP,
etc.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cache.grains \(aq*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cache.list_(bank, cachedir=None)
Lists entries stored in the specified bank.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cache.list cloud/active/ec2/myec2 cachedir=/var/cache/salt/
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cache.mine(tgt=None, tgt_type=\(aqglob\(aq, **kwargs)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Return cached mine data of the targeted minions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cache.mine
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cache.pillar(tgt=None, tgt_type=\(aqglob\(aq, **kwargs)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Return cached pillars of the targeted minions if tgt is set.
If tgt is not set will return cached pillars for all minions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cache.pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cache.store(bank, key, data, cachedir=None)
Lists entries stored in the specified bank.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cache.store mycache mykey \(aqThe time has come the walrus said\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.cloud
.SS The Salt Cloud Runner
.sp
This runner wraps the functionality of salt cloud making salt cloud routines
available to all internal apis via the runner system
.INDENT 0.0
.TP
.B salt.runners.cloud.action(func=None, cloudmap=None, instances=None, provider=None, instance=None, opts=None, **kwargs)
Execute a single action on the given map/provider/instance
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cloud.action start my\-salt\-vm
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cloud.create(provider, instances, opts=None, **kwargs)
Create an instance using Salt Cloud
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cloud.create my\-ec2\-config myinstance \e
    image=ami\-1624987f size=\(aqt1.micro\(aq ssh_username=ec2\-user \e
    securitygroup=default delvol_on_destroy=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cloud.destroy(instances, opts=None)
Destroy the named vm(s)
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cloud.full_query(query_type=\(aqlist_nodes_full\(aq)
List all available cloud provider data
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cloud.list_images(provider=\(aqall\(aq)
List cloud provider images for the given providers
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cloud.list_locations(provider=\(aqall\(aq)
List cloud provider sizes for the given providers
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cloud.list_sizes(provider=\(aqall\(aq)
List cloud provider sizes for the given providers
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cloud.map_run(path=None, opts=None, **kwargs)
Execute a salt cloud map file
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cloud.profile(prof=None, instances=None, opts=None, **kwargs)
Create a cloud vm with the given profile and instances, instances can be a
list or comma\-delimited string
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run cloud.profile prof=my\-ec2 instances=node1,node2,node3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cloud.query(query_type=\(aqlist_nodes\(aq)
List cloud provider data for all providers
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.cloud.select_query(query_type=\(aqlist_nodes_select\(aq)
List selected nodes
.UNINDENT
.SS salt.runners.config
.sp
This runner is designed to mirror the execution module config.py, but for
master settings
.INDENT 0.0
.TP
.B salt.runners.config.get(key, default=\(aq\(aq, delimiter=\(aq:\(aq)
Retrieve master config options, with optional nesting via the delimiter
argument.
.sp
\fBArguments\fP
.sp
default
.INDENT 7.0
.INDENT 3.5
If the key is not found, the default will be returned instead
.UNINDENT
.UNINDENT
.sp
delimiter
.INDENT 7.0
.INDENT 3.5
Override the delimiter used to separate nested levels of a data
structure.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run config.get gitfs_remotes
salt\-run config.get file_roots:base
salt\-run config.get file_roots,base delimiter=\(aq,\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.ddns
.SS Dynamic DNS Runner
.sp
New in version 2015.8.0.

.sp
Runner to interact with DNS server and create/delete/update DNS records
.INDENT 0.0
.TP
.B codeauthor
Nitin Madhok <\fI\%nmadhok@g.clemson.edu\fP>
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.ddns.add_host(zone, name, ttl, ip, keyname, keyfile, nameserver, timeout, port=53, keyalgorithm=\(aqhmac\-md5\(aq)
Create both A and PTR (reverse) records for a host.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run ddns.add_host domain.com my\-test\-vm 3600 10.20.30.40 my\-tsig\-key /etc/salt/tsig.keyring 10.0.0.1 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.ddns.create(zone, name, ttl, rdtype, data, keyname, keyfile, nameserver, timeout, port=53, keyalgorithm=\(aqhmac\-md5\(aq)
Create a DNS record. The nameserver must be an IP address and the master running
this runner must have create privileges on that server.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run ddns.create domain.com my\-test\-vm 3600 A 10.20.30.40 my\-tsig\-key /etc/salt/tsig.keyring 10.0.0.1 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.ddns.delete(zone, name, keyname, keyfile, nameserver, timeout, rdtype=None, data=None, port=53, keyalgorithm=\(aqhmac\-md5\(aq)
Delete a DNS record.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run ddns.delete domain.com my\-test\-vm my\-tsig\-key /etc/salt/tsig.keyring 10.0.0.1 5 A
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.ddns.delete_host(zone, name, keyname, keyfile, nameserver, timeout, port=53, keyalgorithm=\(aqhmac\-md5\(aq)
Delete both forward (A) and reverse (PTR) records for a host only if the
forward (A) record exists.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run ddns.delete_host domain.com my\-test\-vm my\-tsig\-key /etc/salt/tsig.keyring 10.0.0.1 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.ddns.update(zone, name, ttl, rdtype, data, keyname, keyfile, nameserver, timeout, replace=False, port=53, keyalgorithm=\(aqhmac\-md5\(aq)
Replace, or update a DNS record. The nameserver must be an IP address and the master running
this runner must have update privileges on that server.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If \fBreplace\fP is set to True, all records for this name and type will first be deleted and
then recreated. Default is \fBreplace=False\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run ddns.update domain.com my\-test\-vm 3600 A 10.20.30.40 my\-tsig\-key /etc/salt/tsig.keyring 10.0.0.1 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.digicertapi
.sp
Support for Digicert.  Heavily based on the Venafi runner by Joseph Hall (\fI\%jphall@saltstack.com\fP).
.sp
Before using this module you need to register an account with Digicert\(aqs CertCentral.
.sp
Login to CertCentral, ensure you have a payment method configured and/or there are adequate
funds attached to your account.  Click the \fBAccount\fP item in the left sidebar, and select
\fBAccount Access\fP\&.  The right hand pane should show \(dqAccount Access\(dq and a link to create
an API key.  Create a new API key and assign it to the user that should be attached to requests
coming from Salt.
.sp
NOTE CertCentral will not show the API key again after revealing it the first time.  Make sure
you copy it right away or you will have to revoke it and generate a new one.
.sp
Now open \fB/etc/salt/master\fP and add the API key as shown below.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
digicert:
  api_key: ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZABC
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Restart your Salt Master.
.sp
You can also include default values of the following variables to help with creating CSRs:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
digicert:
  api_key: ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZABC
  shatype: sha256
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This API currently only supports RSA key types.  Support for other key types will be added
if interest warrants.
.INDENT 0.0
.TP
.B salt.runners.digicertapi.del_cached_domain(domains)
Delete cached domains from the master
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run digicert.del_cached_domain domain1.example.com,domain2.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.digicertapi.gen_csr(minion_id, dns_name, organization_id, ou_name=None, key_len=2048, shatype=\(aqsha256\(aq, password=None)
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run digicert.gen_csr <minion_id> <dns_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.digicertapi.gen_key(minion_id, dns_name=None, password=None, key_len=2048)
Generate and return a private_key. If a \fBdns_name\fP is passed in, the
private_key will be cached under that name.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run digicert.gen_key <minion_id> [dns_name] [password]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.digicertapi.get_certificate(order_id=None, certificate_id=None, minion_id=None, cert_format=\(aqpem_all\(aq, filename=None)
Retrieve a certificate by order_id or certificate_id and write it to stdout or a filename.
.INDENT 7.0
.TP
.B A list of permissible cert_formats is here:
\fI\%https://www.digicert.com/services/v2/documentation/appendix\-certificate\-formats\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run digicert.get_certificate order_id=48929454 cert_format=apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Including a \(aqfilename\(aq will write the certificate to the desired file.
Note that some cert formats are zipped files, and some are binary.
.sp
If the certificate has not been issued, this function will return the order details
inside of which will be a status (one of pending, rejected, processing, issued,
revoked, canceled, needs_csr, and needs_approval)
.sp
If for some reason you want to pipe the output of this command to a file or other
command you will want to leave off the \fBfilename\fP argument and make sure to include
\fB\-\-no\-color\fP so there will be no terminal ANSI escape sequences.
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.digicertapi.get_org_details(organization_id)
Return the details for an organization
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run digicert.get_org_details 34
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns a dictionary with the org details, or with \(aqerror\(aq and \(aqstatus\(aq keys.
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.digicertapi.list_domain_cache()
List domains that have been cached
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run digicert.list_domain_cache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.digicertapi.list_domains(container_id=None)
List domains that CertCentral knows about. You can filter by
container_id (also known as \(dqDivision\(dq) by passing a container_id.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run digicert.list_domains
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.digicertapi.list_orders(status=None)
List certificate orders made to CertCentral.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run digicert.list_orders
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.digicertapi.list_organizations(container_id=None, include_validation=True)
List organizations that CertCentral knows about. You can filter by
container_id (also known as \(dqDivision\(dq) by passing a container_id.
This function returns validation information by default; pass
\fBinclude_validation=False\fP to turn it off.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run digicert.list_organizations
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.digicertapi.list_requests(status=None)
List certificate requests made to CertCentral. You can filter by
status: \fBpending\fP, \fBapproved\fP, \fBrejected\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run digicert.list_requests pending
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.digicertapi.order_certificate(minion_id, common_name, organization_id, validity_years, cert_key_passphrase=None, signature_hash=None, key_len=2048, dns_names=None, organization_units=None, server_platform=None, custom_expiration_date=None, comments=None, disable_renewal_notifications=False, product_type_hint=None, renewal_of_order_id=None)
Order a certificate.  Requires that an Organization has been created inside Digicert\(aqs CertCentral.
.sp
See here for API documentation:
\fI\%https://www.digicert.com/services/v2/documentation/order/order\-ssl\-determinator\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run digicert.order_certificate my_minionid my.domain.com 10             3 signature_hash=sha256             dns_names=[\(aqthis.domain.com\(aq, \(aqthat.domain.com\(aq]             organization_units=\(aqMy Domain Org Unit\(aq             comments=\(aqComment goes here for the approver\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This runner can also be used to renew a certificate by passing \fIrenewal_of_order_id\fP\&.
Previous order details can be retrieved with digicertapi.list_orders.
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.digicertapi.show_csrs()
Show certificate requests for this API key
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run digicert.show_csrs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.digicertapi.show_organization(domain)
Show organization information, especially the company id
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run digicert.show_company example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.digicertapi.show_rsa(minion_id, dns_name)
Show a private RSA key
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run digicert.show_rsa myminion domain.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.doc
.sp
A runner module to collect and display the inline documentation from the
various module types
.INDENT 0.0
.TP
.B salt.runners.doc.execution()
Collect all the sys.doc output from each minion and return the aggregate
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run doc.execution
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.doc.runner()
Return all inline documentation for runner modules
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run doc.runner
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.doc.wheel()
Return all inline documentation for wheel modules
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run doc.wheel
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.drac
.sp
Manage Dell DRAC from the Master
.sp
The login credentials need to be configured in the Salt master
configuration file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
drac:
  username: admin
  password: secret
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.drac.poweroff(hostname, timeout=20, username=None, password=None)
Power server off
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run drac.poweroff example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.drac.poweron(hostname, timeout=20, username=None, password=None)
Power server on
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run drac.poweron example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.drac.pxe(hostname, timeout=20, username=None, password=None)
Connect to the Dell DRAC and have the boot order set to PXE
and power cycle the system to PXE boot
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run drac.pxe example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.drac.reboot(hostname, timeout=20, username=None, password=None)
Reboot a server using the Dell DRAC
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run drac.reboot example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.drac.version(hostname, timeout=20, username=None, password=None)
Display the version of DRAC
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run drac.version example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.error
.sp
Error generator to enable integration testing of salt runner error handling
.INDENT 0.0
.TP
.B salt.runners.error.error(name=None, message=\(aq\(aq)
If name is None Then return empty dict
.sp
Otherwise raise an exception with __name__ from name, message from message
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run error
salt\-run error.error name=\(dqException\(dq message=\(dqThis is an error.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.event
.sp
Module for sending events using the runner system.
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.runners.event.send(tag, data=None)
Send an event with the given tag and data.
.sp
This is useful for sending events directly to the master from the shell
with salt\-run. It is also quite useful for sending events in orchestration
states where the \fBfire_event\fP requisite isn\(aqt sufficient because it does
not support sending custom data with the event.
.sp
Note that event tags will \fInot\fP be namespaced like events sent with the
\fBfire_event\fP requisite! Whereas events produced from \fBfire_event\fP are
prefixed with \fBsalt/state_result/<jid>/<minion_id>/<name>\fP, events sent
using this runner module will have no such prefix. Make sure your reactors
don\(aqt expect a prefix!
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtag\fP \-\- the tag to send with the event
.IP \(bu 2
\fBdata\fP \-\- an optional dictionary of data to send with the event
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run event.send my/custom/event \(aq{\(dqfoo\(dq: \(dqbar\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Orchestration Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# orch/command.sls

run_a_command:
  salt.function:
    \- name: cmd.run
    \- tgt: my_minion
    \- arg:
      \- exit {{ pillar[\(aqexit_code\(aq] }}

send_success_event:
  salt.runner:
    \- name: event.send
    \- tag: my_event/success
    \- data:
        foo: bar
    \- require:
      \- salt: run_a_command

send_failure_event:
  salt.runner:
    \- name: event.send
    \- tag: my_event/failure
    \- data:
        baz: qux
    \- onfail:
      \- salt: run_a_command
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate orch.command pillar=\(aq{\(dqexit_code\(dq: 0}\(aq
salt\-run state.orchestrate orch.command pillar=\(aq{\(dqexit_code\(dq: 1}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.f5
.sp
Runner to provide F5 Load Balancer functionality
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
pycontrol Python module
.UNINDENT
.TP
.B configuration
In order to connect to a F5 Load Balancer, you must specify
in the Salt master configuration the currently available load balancers
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
load_balancers:
  bigip1.example.com:
    username: admin
    password: secret
  bigip2.example.com:
    username: admin
    password: secret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.runners.f5.F5Mgmt(lb, username, password)
.INDENT 7.0
.TP
.B add_pool_member(name, port, pool_name)
Add a node to a pool
.UNINDENT
.INDENT 7.0
.TP
.B check_member_pool(member, pool_name)
Check a pool member exists in a specific pool
.UNINDENT
.INDENT 7.0
.TP
.B check_pool(name)
Check to see if a pool exists
.UNINDENT
.INDENT 7.0
.TP
.B check_virtualserver(name)
Check to see if a virtual server exists
.UNINDENT
.INDENT 7.0
.TP
.B create_pool(name, method=\(aqROUND_ROBIN\(aq)
Create a pool on the F5 load balancer
.UNINDENT
.INDENT 7.0
.TP
.B create_vs(name, ip, port, protocol, profile, pool_name)
Create a virtual server
.UNINDENT
.INDENT 7.0
.TP
.B lbmethods()
List all the load balancer methods
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.f5.add_pool_member(lb, name, port, pool_name)
Add a node to a pool
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run f5.add_pool_member load_balancer 10.0.0.1 80 my_pool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.f5.check_member_pool(lb, member, pool_name)
Check a pool member exists in a specific pool
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run f5.check_member_pool load_balancer 10.0.0.1 my_pool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.f5.check_pool(lb, name)
Check to see if a pool exists
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run f5.check_pool load_balancer pool_name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.f5.check_virtualserver(lb, name)
Check to see if a virtual server exists
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run f5.check_virtualserver load_balancer virtual_server
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.f5.create_pool(lb, name, method=\(aqROUND_ROBIN\(aq)
Create a pool on the F5 load balancer
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run f5.create_pool load_balancer pool_name loadbalance_method
salt\-run f5.create_pool load_balancer my_pool ROUND_ROBIN
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.f5.create_vs(lb, name, ip, port, protocol, profile, pool_name)
Create a virtual server
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run f5.create_vs lbalancer vs_name 10.0.0.1 80 tcp http poolname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.fileserver
.sp
Directly manage the Salt fileserver plugins
.INDENT 0.0
.TP
.B salt.runners.fileserver.clear_cache(backend=None)
New in version 2015.5.0.

.sp
Clear the fileserver cache from VCS fileserver backends (\fI\%git\fP, \fI\%hg\fP, \fI\%svn\fP). Executing this runner with no arguments will
clear the cache for all enabled VCS fileserver backends, but this
can be narrowed using the \fBbackend\fP argument.
.INDENT 7.0
.TP
.B backend
Only clear the update lock for the specified backend(s). If all passed
backends start with a minus sign (\fB\-\fP), then these backends will be
excluded from the enabled backends. However, if there is a mix of
backends with and without a minus sign (ex: \fBbackend=\-roots,git\fP)
then the ones starting with a minus sign will be disregarded.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run fileserver.clear_cache
salt\-run fileserver.clear_cache backend=git,hg
salt\-run fileserver.clear_cache hg
salt\-run fileserver.clear_cache \-roots
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.fileserver.clear_file_list_cache(saltenv=None, backend=None)
New in version 2016.11.0.

.sp
The Salt fileserver caches the files/directories/symlinks for each
fileserver backend and environment as they are requested. This is done to
help the fileserver scale better. Without this caching, when
hundreds/thousands of minions simultaneously ask the master what files are
available, this would cause the master\(aqs CPU load to spike as it obtains
the same information separately for each minion.
.INDENT 7.0
.TP
.B saltenv
By default, this runner will clear the file list caches for all
environments. This argument allows for a list of environments to be
passed, to clear more selectively. This list can be passed either as a
comma\-separated string, or a Python list.
.TP
.B backend
Similar to the \fBsaltenv\fP parameter, this argument will restrict the
cache clearing to specific fileserver backends (the default behavior is
to clear from all enabled fileserver backends). This list can be passed
either as a comma\-separated string, or a Python list.
.UNINDENT
.sp
Since the ability to clear these caches is often required by users writing
custom runners which add/remove files, this runner can easily be called
from within a custom runner using any of the following examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Clear all file list caches
__salt__[\(aqfileserver.clear_file_list_cache\(aq]()
# Clear just the \(aqbase\(aq saltenv file list caches
__salt__[\(aqfileserver.clear_file_list_cache\(aq](saltenv=\(aqbase\(aq)
# Clear just the \(aqbase\(aq saltenv file list caches from just the \(aqroots\(aq
# fileserver backend
__salt__[\(aqfileserver.clear_file_list_cache\(aq](saltenv=\(aqbase\(aq, backend=\(aqroots\(aq)
# Clear all file list caches from the \(aqroots\(aq fileserver backend
__salt__[\(aqfileserver.clear_file_list_cache\(aq](backend=\(aqroots\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
In runners, the \fB__salt__\fP dictionary will likely be renamed to
\fB__runner__\fP in a future Salt release to distinguish runner functions
from remote execution functions. See \fI\%this GitHub issue\fP for
discussion/updates on this.
.UNINDENT
.UNINDENT
.sp
If using Salt\(aqs Python API (not a runner), the following examples are
equivalent to the ones above:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.config
import salt.runner

opts = salt.config.master_config(\(aq/etc/salt/master\(aq)
opts[\(aqfun\(aq] = \(aqfileserver.clear_file_list_cache\(aq

# Clear all file list_caches
opts[\(aqarg\(aq] = []  # No arguments
runner = salt.runner.Runner(opts)
cleared = runner.run()

# Clear just the \(aqbase\(aq saltenv file list caches
opts[\(aqarg\(aq] = [\(aqbase\(aq, None]
runner = salt.runner.Runner(opts)
cleared = runner.run()

# Clear just the \(aqbase\(aq saltenv file list caches from just the \(aqroots\(aq
# fileserver backend
opts[\(aqarg\(aq] = [\(aqbase\(aq, \(aqroots\(aq]
runner = salt.runner.Runner(opts)
cleared = runner.run()

# Clear all file list caches from the \(aqroots\(aq fileserver backend
opts[\(aqarg\(aq] = [None, \(aqroots\(aq]
runner = salt.runner.Runner(opts)
cleared = runner.run()
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This function will return a dictionary showing a list of environments which
were cleared for each backend. An empty return dictionary means that no
changes were made.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Clear all file list caches
salt\-run fileserver.clear_file_list_cache
# Clear just the \(aqbase\(aq saltenv file list caches
salt\-run fileserver.clear_file_list_cache saltenv=base
# Clear just the \(aqbase\(aq saltenv file list caches from just the \(aqroots\(aq
# fileserver backend
salt\-run fileserver.clear_file_list_cache saltenv=base backend=roots
# Clear all file list caches from the \(aqroots\(aq fileserver backend
salt\-run fileserver.clear_file_list_cache backend=roots
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.fileserver.clear_lock(backend=None, remote=None)
New in version 2015.5.0.

.sp
Clear the fileserver update lock from VCS fileserver backends (\fI\%git\fP, \fI\%hg\fP, \fI\%svn\fP). This should only need to be done if a fileserver
update was interrupted and a remote is not updating (generating a warning
in the Master\(aqs log file). Executing this runner with no arguments will
remove all update locks from all enabled VCS fileserver backends, but this
can be narrowed by using the following arguments:
.INDENT 7.0
.TP
.B backend
Only clear the update lock for the specified backend(s).
.TP
.B remote
If specified, then any remotes which contain the passed string will
have their lock cleared. For example, a \fBremote\fP value of \fBgithub\fP
will remove the lock from all github.com remotes.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run fileserver.clear_lock
salt\-run fileserver.clear_lock backend=git,hg
salt\-run fileserver.clear_lock backend=git remote=github
salt\-run fileserver.clear_lock remote=bitbucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.fileserver.dir_list(saltenv=\(aqbase\(aq, backend=None)
Return a list of directories in the given environment
.INDENT 7.0
.TP
.B saltenv
base
The salt fileserver environment to be listed
.TP
.B backend
Narrow fileserver backends to a subset of the enabled ones. If all
passed backends start with a minus sign (\fB\-\fP), then these backends
will be excluded from the enabled backends. However, if there is a mix
of backends with and without a minus sign (ex:
\fBbackend=\-roots,git\fP) then the ones starting with a minus sign will
be disregarded.
.sp
New in version 2015.5.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run fileserver.dir_list
salt\-run fileserver.dir_list saltenv=prod
salt\-run fileserver.dir_list saltenv=dev backend=git
salt\-run fileserver.dir_list base hg,roots
salt\-run fileserver.dir_list \-git
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.fileserver.empty_dir_list(saltenv=\(aqbase\(aq, backend=None)
New in version 2015.5.0.

.sp
Return a list of empty directories in the given environment
.INDENT 7.0
.TP
.B saltenv
base
The salt fileserver environment to be listed
.TP
.B backend
Narrow fileserver backends to a subset of the enabled ones. If all
passed backends start with a minus sign (\fB\-\fP), then these backends
will be excluded from the enabled backends. However, if there is a mix
of backends with and without a minus sign (ex:
\fBbackend=\-roots,git\fP) then the ones starting with a minus sign will
be disregarded.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Some backends (such as \fI\%git\fP and
\fI\%hg\fP) do not support empty directories.
So, passing \fBbackend=git\fP or \fBbackend=hg\fP will result in an
empty list being returned.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run fileserver.empty_dir_list
salt\-run fileserver.empty_dir_list saltenv=prod
salt\-run fileserver.empty_dir_list backend=roots
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.fileserver.envs(backend=None, sources=False)
Return the available fileserver environments. If no backend is provided,
then the environments for all configured backends will be returned.
.INDENT 7.0
.TP
.B backend
Narrow fileserver backends to a subset of the enabled ones.
.sp
Changed in version 2015.5.0: If all passed backends start with a minus sign (\fB\-\fP), then these
backends will be excluded from the enabled backends. However, if
there is a mix of backends with and without a minus sign (ex:
\fBbackend=\-roots,git\fP) then the ones starting with a minus
sign will be disregarded.
.sp
Additionally, fileserver backends can now be passed as a
comma\-separated list. In earlier versions, they needed to be passed
as a python list (ex: \fBbackend=\(dq[\(aqroots\(aq, \(aqgit\(aq]\(dq\fP)

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run fileserver.envs
salt\-run fileserver.envs backend=roots,git
salt\-run fileserver.envs git
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.fileserver.file_list(saltenv=\(aqbase\(aq, backend=None)
Return a list of files from the salt fileserver
.INDENT 7.0
.TP
.B saltenv
base
The salt fileserver environment to be listed
.TP
.B backend
Narrow fileserver backends to a subset of the enabled ones. If all
passed backends start with a minus sign (\fB\-\fP), then these backends
will be excluded from the enabled backends. However, if there is a mix
of backends with and without a minus sign (ex:
\fBbackend=\-roots,git\fP) then the ones starting with a minus sign will
be disregarded.
.sp
New in version 2015.5.0.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run fileserver.file_list
salt\-run fileserver.file_list saltenv=prod
salt\-run fileserver.file_list saltenv=dev backend=git
salt\-run fileserver.file_list base hg,roots
salt\-run fileserver.file_list \-git
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.fileserver.lock(backend=None, remote=None)
New in version 2015.5.0.

.sp
Set a fileserver update lock for VCS fileserver backends (\fI\%git\fP, \fI\%hg\fP, \fI\%svn\fP).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This will only operate on enabled backends (those configured in
\fI\%fileserver_backend\fP).
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B backend
Only set the update lock for the specified backend(s).
.TP
.B remote
If not None, then any remotes which contain the passed string will have
their lock cleared. For example, a \fBremote\fP value of \fB*github.com*\fP
will remove the lock from all github.com remotes.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run fileserver.lock
salt\-run fileserver.lock backend=git,hg
salt\-run fileserver.lock backend=git remote=\(aq*github.com*\(aq
salt\-run fileserver.lock remote=bitbucket
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.fileserver.symlink_list(saltenv=\(aqbase\(aq, backend=None)
Return a list of symlinked files and dirs
.INDENT 7.0
.TP
.B saltenv
base
The salt fileserver environment to be listed
.TP
.B backend
Narrow fileserver backends to a subset of the enabled ones. If all
passed backends start with a minus sign (\fB\-\fP), then these backends
will be excluded from the enabled backends. However, if there is a mix
of backends with and without a minus sign (ex:
\fBbackend=\-roots,git\fP) then the ones starting with a minus sign will
be disregarded.
.sp
New in version 2015.5.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run fileserver.symlink_list
salt\-run fileserver.symlink_list saltenv=prod
salt\-run fileserver.symlink_list saltenv=dev backend=git
salt\-run fileserver.symlink_list base hg,roots
salt\-run fileserver.symlink_list \-git
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.fileserver.update(backend=None, **kwargs)
Update the fileserver cache. If no backend is provided, then the cache for
all configured backends will be updated.
.INDENT 7.0
.TP
.B backend
Narrow fileserver backends to a subset of the enabled ones.
.sp
Changed in version 2015.5.0: If all passed backends start with a minus sign (\fB\-\fP), then these
backends will be excluded from the enabled backends. However, if
there is a mix of backends with and without a minus sign (ex:
\fBbackend=\-roots,git\fP) then the ones starting with a minus
sign will be disregarded.
.sp
Additionally, fileserver backends can now be passed as a
comma\-separated list. In earlier versions, they needed to be passed
as a python list (ex: \fBbackend=\(dq[\(aqroots\(aq, \(aqgit\(aq]\(dq\fP)

.TP
.B kwargs
Pass additional arguments to backend. See example below
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run fileserver.update
salt\-run fileserver.update backend=roots,git
salt\-run fileserver.update backend=git remotes=myrepo,yourrepo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.git_pillar
.sp
Runner module to directly manage the git external pillar
.INDENT 0.0
.TP
.B salt.runners.git_pillar.update(branch=None, repo=None)
New in version 2014.1.0.

.sp
Changed in version 2015.8.4: This runner function now supports the \fI\%git_pillar
configuration schema\fP introduced in
2015.8.0. Additionally, the branch and repo can now be omitted to
update all git_pillar remotes. The return data has also changed to
a dictionary. The values will be \fBTrue\fP only if new commits were
fetched, and \fBFalse\fP if there were errors or no new commits were
fetched.

.sp
Changed in version 2018.3.0: The return for a given git_pillar remote will now be \fBNone\fP when no
changes were fetched. \fBFalse\fP now is reserved only for instances in
which there were errors.

.sp
Changed in version 3001: The repo parameter also matches against the repo name.

.sp
Fetch one or all configured git_pillar remotes.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This will \fInot\fP fast\-forward the git_pillar cachedir on the master. All
it does is perform a \fBgit fetch\fP\&. If this runner is executed with
\fB\-l debug\fP, you may see a log message that says that the repo is
up\-to\-date. Keep in mind that Salt automatically fetches git_pillar
repos roughly every 60 seconds (or whatever
\fI\%loop_interval\fP is set to). So, it is possible that the
repo was fetched automatically in the time between when changes were
pushed to the repo, and when this runner was executed. When in doubt,
simply refresh pillar data using \fI\%saltutil.refresh_pillar\fP and then use
\fI\%pillar.item\fP to check if the
pillar data has changed as expected.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Update specific branch and repo
salt\-run git_pillar.update branch=\(aqbranch\(aq repo=\(aqhttps://foo.com/bar.git\(aq
# Update specific repo, by name
salt\-run git_pillar.update repo=myrepo
# Update all repos
salt\-run git_pillar.update
# Run with debug logging
salt\-run git_pillar.update \-l debug
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.http
.sp
Module for making various web calls. Primarily designed for webhooks and the
like, but also useful for basic http testing.
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B salt.runners.http.query(url, output=True, **kwargs)
Query a resource, and decode the return data
.sp
Passes through all the parameters described in the
\fI\%utils.http.query function\fP:
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run http.query http://somelink.com/
salt\-run http.query http://somelink.com/ method=POST             params=\(aqkey1=val1&key2=val2\(aq
salt\-run http.query http://somelink.com/ method=POST             data=\(aq<xml>somecontent</xml>\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.http.update_ca_bundle(target=None, source=None, merge_files=None)
Update the local CA bundle file from a URL
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run http.update_ca_bundle
salt\-run http.update_ca_bundle target=/path/to/cacerts.pem
salt\-run http.update_ca_bundle source=https://example.com/cacerts.pem
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the \fBtarget\fP is not specified, it will be pulled from the \fBca_cert\fP
configuration variable available to the master. If it cannot be found there,
it will be placed at \fB<<FILE_ROOTS>>/cacerts.pem\fP\&.
.sp
If the \fBsource\fP is not specified, it will be pulled from the
\fBca_cert_url\fP configuration variable available to the master. If it cannot
be found, it will be downloaded from the cURL website, using an http (not
https) URL. USING THE DEFAULT URL SHOULD BE AVOIDED!
.sp
\fBmerge_files\fP may also be specified, which includes a string or list of
strings representing a file or files to be appended to the end of the CA
bundle, once it is downloaded.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run http.update_ca_bundle merge_files=/path/to/mycert.pem
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.jobs
.sp
A convenience system to manage jobs, both active and already run
.INDENT 0.0
.TP
.B salt.runners.jobs.active(display_progress=False)
Return a report on all actively running jobs from a job id centric
perspective
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run jobs.active
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.jobs.exit_success(jid, ext_source=None)
Check if a job has been executed and exit successfully
.INDENT 7.0
.TP
.B jid
The jid to look up.
.TP
.B ext_source
The external job cache to use. Default: \fINone\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run jobs.exit_success 20160520145827701627
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.jobs.last_run(ext_source=None, outputter=None, metadata=None, function=None, target=None, display_progress=False)
New in version 2015.8.0.

.sp
List all detectable jobs and associated functions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run jobs.last_run
salt\-run jobs.last_run target=nodename
salt\-run jobs.last_run function=\(aqcmd.run\(aq
salt\-run jobs.last_run metadata=\(dq{\(aqfoo\(aq: \(aqbar\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.jobs.list_job(jid, ext_source=None, display_progress=False)
List a specific job given by its jid
.INDENT 7.0
.TP
.B ext_source
If provided, specifies which external job cache to use.
.TP
.B display_progress
False
If \fBTrue\fP, fire progress events.
.sp
New in version 2015.8.8.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run jobs.list_job 20130916125524463507
salt\-run jobs.list_job 20130916125524463507 \-\-out=pprint
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.jobs.list_jobs(ext_source=None, outputter=None, search_metadata=None, search_function=None, search_target=None, start_time=None, end_time=None, display_progress=False)
List all detectable jobs and associated functions
.INDENT 7.0
.TP
.B ext_source
If provided, specifies which external job cache to use.
.UNINDENT
.sp
\fBFILTER OPTIONS\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If more than one of the below options are used, only jobs which match
\fIall\fP of the filters will be returned.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B search_metadata
Specify a dictionary to match to the job\(aqs metadata. If any of the
key\-value pairs in this dictionary match, the job will be returned.
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run jobs.list_jobs search_metadata=\(aq{\(dqfoo\(dq: \(dqbar\(dq, \(dqbaz\(dq: \(dqqux\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B search_function
Can be passed as a string or a list. Returns jobs which match the
specified function. Globbing is allowed. Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run jobs.list_jobs search_function=\(aqtest.*\(aq
salt\-run jobs.list_jobs search_function=\(aq[\(dqtest.*\(dq, \(dqpkg.install\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.8: Multiple targets can now also be passed as a comma\-separated list.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run jobs.list_jobs search_function=\(aqtest.*,pkg.install\(aq
.ft P
.fi
.UNINDENT
.UNINDENT

.TP
.B search_target
Can be passed as a string or a list. Returns jobs which match the
specified minion name. Globbing is allowed. Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run jobs.list_jobs search_target=\(aq*.mydomain.tld\(aq
salt\-run jobs.list_jobs search_target=\(aq[\(dqdb*\(dq, \(dqmyminion\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.8: Multiple targets can now also be passed as a comma\-separated list.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run jobs.list_jobs search_target=\(aqdb*,myminion\(aq
.ft P
.fi
.UNINDENT
.UNINDENT

.TP
.B start_time
Accepts any timestamp supported by the \fI\%dateutil\fP Python module (if this
module is not installed, this argument will be ignored). Returns jobs
which started after this timestamp.
.TP
.B end_time
Accepts any timestamp supported by the \fI\%dateutil\fP Python module (if this
module is not installed, this argument will be ignored). Returns jobs
which started before this timestamp.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run jobs.list_jobs
salt\-run jobs.list_jobs search_function=\(aqtest.*\(aq search_target=\(aqlocalhost\(aq search_metadata=\(aq{\(dqbar\(dq: \(dqfoo\(dq}\(aq
salt\-run jobs.list_jobs start_time=\(aq2015, Mar 16 19:00\(aq end_time=\(aq2015, Mar 18 22:00\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.jobs.list_jobs_filter(count, filter_find_job=True, ext_source=None, outputter=None, display_progress=False)
List all detectable jobs and associated functions
.INDENT 7.0
.TP
.B ext_source
The external job cache to use. Default: \fINone\fP\&.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run jobs.list_jobs_filter 50
salt\-run jobs.list_jobs_filter 100 filter_find_job=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.jobs.lookup_jid(jid, ext_source=None, returned=True, missing=False, display_progress=False)
Return the printout from a previously executed job
.INDENT 7.0
.TP
.B jid
The jid to look up.
.TP
.B ext_source
The external job cache to use. Default: \fINone\fP\&.
.TP
.B returned
True
If \fBTrue\fP, include the minions that did return from the command.
.sp
New in version 2015.8.0.

.TP
.B missing
False
If \fBTrue\fP, include the minions that did \fInot\fP return from the
command.
.TP
.B display_progress
False
If \fBTrue\fP, fire progress events.
.sp
New in version 2015.5.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run jobs.lookup_jid 20130916125524463507
salt\-run jobs.lookup_jid 20130916125524463507 \-\-out=highstate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.jobs.master()
Return the actively executing runners for the master
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run jobs.master
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.jobs.print_job(jid, ext_source=None)
Print a specific job\(aqs detail given by its jid, including the return data.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run jobs.print_job 20130916125524463507
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.launchd
.sp
Manage launchd plist files
.INDENT 0.0
.TP
.B salt.runners.launchd.write_launchd_plist(program)
Write a launchd plist for managing salt\-master or salt\-minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run launchd.write_launchd_plist salt\-master
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.lxc
.sp
Control Linux Containers via Salt
.INDENT 0.0
.TP
.B depends
lxc execution module
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.lxc.cloud_init(names, host=None, quiet=False, **kwargs)
Wrapper for using lxc.init in saltcloud compatibility mode
.INDENT 7.0
.TP
.B names
Name of the containers, supports a single name or a comma delimited
list of names.
.TP
.B host
Minion to start the container on. Required.
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.TP
.B saltcloud_mode
init the container with the saltcloud opts format instead
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.lxc.find_guest(name, quiet=False, path=None)
Returns the host for a container.
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run lxc.find_guest name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.lxc.find_guests(names, path=None)
Return a dict of hosts and named guests
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.lxc.freeze(name, quiet=False, path=None)
Freeze the named container
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run lxc.freeze name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.lxc.info(name, quiet=False, path=None)
Returns information about a container.
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run lxc.info name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.lxc.init(names, host=None, saltcloud_mode=False, quiet=False, **kwargs)
Initialize a new container
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run lxc.init name host=minion_id [cpuset=cgroups_cpuset] \e
        [cpushare=cgroups_cpushare] [memory=cgroups_memory] \e
        [template=lxc_template_name] [clone=original name] \e
        [profile=lxc_profile] [network_proflile=network_profile] \e
        [nic=network_profile] [nic_opts=nic_opts] \e
        [start=(true|false)] [seed=(true|false)] \e
        [install=(true|false)] [config=minion_config] \e
        [snapshot=(true|false)]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B names
Name of the containers, supports a single name or a comma delimited
list of names.
.TP
.B host
Minion on which to initialize the container \fB(required)\fP
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.TP
.B saltcloud_mode
init the container with the saltcloud opts format instead
See lxc.init_interface module documentation
.TP
.B cpuset
cgroups cpuset.
.TP
.B cpushare
cgroups cpu shares.
.TP
.B memory
cgroups memory limit, in MB
.sp
Changed in version 2015.5.0: If no value is passed, no limit is set. In earlier Salt versions,
not passing this value causes a 1024MB memory limit to be set, and
it was necessary to pass \fBmemory=0\fP to set no limit.

.TP
.B template
Name of LXC template on which to base this container
.TP
.B clone
Clone this container from an existing container
.TP
.B profile
A LXC profile (defined in config or pillar).
.TP
.B network_profile
Network profile to use for the container
.sp
New in version 2015.5.2.

.TP
.B nic
Deprecated since version 2015.5.0: Use \fBnetwork_profile\fP instead

.TP
.B nic_opts
Extra options for network interfaces. E.g.:
.sp
\fB{\(dqeth0\(dq: {\(dqmac\(dq: \(dqaa:bb:cc:dd:ee:ff\(dq, \(dqipv4\(dq: \(dq10.1.1.1\(dq, \(dqipv6\(dq: \(dq2001:db8::ff00:42:8329\(dq}}\fP
.TP
.B start
Start the newly created container.
.TP
.B seed
Seed the container with the minion config and autosign its key.
Default: true
.TP
.B install
If salt\-minion is not already installed, install it. Default: true
.TP
.B config
Optional config parameters. By default, the id is set to
the name of the container.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.lxc.list_(host=None, quiet=False, path=None)
List defined containers (running, stopped, and frozen) for the named
(or all) host(s).
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run lxc.list [host=minion_id]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.lxc.purge(name, delete_key=True, quiet=False, path=None)
Purge the named container and delete its minion key if present.
WARNING: Destroys all data associated with the container.
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run lxc.purge name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.lxc.start(name, quiet=False, path=None)
Start the named container.
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run lxc.start name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.lxc.stop(name, quiet=False, path=None)
Stop the named container.
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run lxc.stop name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.lxc.unfreeze(name, quiet=False, path=None)
Unfreeze the named container
.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run lxc.unfreeze name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.manage
.sp
General management functions for salt, tools like seeing what hosts are up
and what hosts are down
.INDENT 0.0
.TP
.B salt.runners.manage.alived(subset=None, show_ip=False)
New in version 2015.8.0.

.sp
Changed in version 2019.2.0.

.sp
Print a list of all minions that are up according to Salt\(aqs presence
detection (no commands will be sent to minions)
.INDENT 7.0
.TP
.B subset
None
Pass in a list of minion ids.
.TP
.B show_ip
False
Also show the IP address each minion is connecting from.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.alived
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.allowed(subset=None, show_ip=False)
New in version 2015.8.0.

.sp
Changed in version 2019.2.0.

.sp
Print a list of all minions that are up according to Salt\(aqs presence
detection (no commands will be sent to minions)
.INDENT 7.0
.TP
.B subset
None
Pass in a list of minion ids.
.TP
.B show_ip
False
Also show the IP address each minion is connecting from.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.allowed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.bootstrap(version=\(aqdevelop\(aq, script=\(aqhttps://bootstrap.saltproject.io\(aq, hosts=\(aq\(aq, script_args=\(aq\(aq, roster=\(aqflat\(aq, ssh_user=None, ssh_password=None, ssh_priv_key=None, tmp_dir=\(aq/tmp/.bootstrap\(aq, http_backend=\(aqtornado\(aq)
Bootstrap minions with salt\-bootstrap
.INDENT 7.0
.TP
.B version
develop
Git tag of version to install
.TP
.B script
\fI\%https://bootstrap.saltproject.io/\fP
URL containing the script to execute
.TP
.B hosts
Comma\-separated hosts [example: hosts=\(aqhost1.local,host2.local\(aq]. These
hosts need to exist in the specified roster.
.TP
.B script_args
Any additional arguments that you want to pass to the script.
.sp
New in version 2016.11.0.

.TP
.B roster
flat
The roster to use for Salt SSH. More information about roster files can
be found in \fI\%Salt\(aqs Roster Documentation\fP\&.
.sp
A full list of roster types, see the \fI\%builtin roster modules\fP
documentation.
.sp
New in version 2016.11.0.

.TP
.B ssh_user
If \fBuser\fP isn\(aqt found in the \fBroster\fP, a default SSH user can be set here.
Keep in mind that \fBssh_user\fP will not override the roster \fBuser\fP value if
it is already defined.
.sp
New in version 2016.11.0.

.TP
.B ssh_password
If \fBpasswd\fP isn\(aqt found in the \fBroster\fP, a default SSH password can be set
here. Keep in mind that \fBssh_password\fP will not override the roster \fBpasswd\fP
value if it is already defined.
.sp
New in version 2016.11.0.

.TP
.B ssh_privkey
If \fBpriv\fP isn\(aqt found in the \fBroster\fP, a default SSH private key can be set
here. Keep in mind that \fBssh_password\fP will not override the roster \fBpasswd\fP
value if it is already defined.
.sp
New in version 2016.11.0.

.TP
.B tmp_dir
/tmp/.bootstrap
The temporary directory to download the bootstrap script in. This
directory will have \fB\-<uuid4>\fP appended to it. For example:
\fB/tmp/.bootstrap\-a19a728e\-d40a\-4801\-aba9\-d00655c143a7/\fP
.sp
New in version 2016.11.0.

.TP
.B http_backend
tornado
The backend library to use to download the script. If you need to use
a \fBfile:///\fP URL, then you should set this to \fBurllib2\fP\&.
.sp
New in version 2016.11.0.

.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.bootstrap hosts=\(aqhost1,host2\(aq
salt\-run manage.bootstrap hosts=\(aqhost1,host2\(aq version=\(aqv3004.2\(aq
salt\-run manage.bootstrap hosts=\(aqhost1,host2\(aq version=\(aqv3004.2\(aq script=\(aqhttps://bootstrap.saltproject.io/develop\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.bootstrap_psexec(hosts=\(aq\(aq, master=None, version=None, arch=\(aqwin32\(aq, installer_url=None, username=None, password=None)
Bootstrap Windows minions via PsExec.
.INDENT 7.0
.TP
.B hosts
Comma separated list of hosts to deploy the Windows Salt minion.
.TP
.B master
Address of the Salt master passed as an argument to the installer.
.TP
.B version
Point release of installer to download. Defaults to the most recent.
.TP
.B arch
Architecture of installer to download. Defaults to win32.
.TP
.B installer_url
URL of minion installer executable. Defaults to the latest version from
\fI\%https://repo.saltproject.io/windows/\fP
.TP
.B username
Optional user name for login on remote computer.
.TP
.B password
Password for optional username. If omitted, PsExec will prompt for one
to be entered for each host.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.bootstrap_psexec hosts=\(aqhost1,host2\(aq
salt\-run manage.bootstrap_psexec hosts=\(aqhost1,host2\(aq version=\(aq0.17\(aq username=\(aqDOMAIN\eAdministrator\(aq
salt\-run manage.bootstrap_psexec hosts=\(aqhost1,host2\(aq installer_url=\(aqhttp://exampledomain/salt\-installer.exe\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.down(removekeys=False, tgt=\(aq*\(aq, tgt_type=\(aqglob\(aq, timeout=None, gather_job_timeout=None)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Print a list of all the down or unresponsive salt minions
Optionally remove keys of down minions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.down
salt\-run manage.down removekeys=True
salt\-run manage.down tgt=\(dqwebservers\(dq tgt_type=\(dqnodegroup\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.joined(subset=None, show_ip=False)
New in version 2015.8.0.

.sp
Changed in version 2019.2.0.

.sp
Print a list of all minions that are up according to Salt\(aqs presence
detection (no commands will be sent to minions)
.INDENT 7.0
.TP
.B subset
None
Pass in a list of minion ids.
.TP
.B show_ip
False
Also show the IP address each minion is connecting from.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.joined
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.key_regen()
This routine is used to regenerate all keys in an environment. This is
invasive! ALL KEYS IN THE SALT ENVIRONMENT WILL BE REGENERATED!!
.sp
The key_regen routine sends a command out to minions to revoke the master
key and remove all minion keys, it then removes all keys from the master
and prompts the user to restart the master. The minions will all reconnect
and keys will be placed in pending.
.sp
After the master is restarted and minion keys are in the pending directory
execute a salt\-key \-A command to accept the regenerated minion keys.
.sp
The master \fImust\fP be restarted within 60 seconds of running this command or
the minions will think there is something wrong with the keys and abort.
.sp
Only Execute this runner after upgrading minions and master to 0.15.1 or
higher!
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.key_regen
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.list_not_state(subset=None, show_ip=False)
New in version 2015.8.0.

.sp
Changed in version 2019.2.0.

.sp
Print a list of all minions that are NOT up according to Salt\(aqs presence
detection (no commands will be sent to minions)
.INDENT 7.0
.TP
.B subset
None
Pass in a list of minion ids.
.TP
.B show_ip
False
Also show the IP address each minion is connecting from.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.list_not_state
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.list_state(subset=None, show_ip=False)
New in version 2015.8.0.

.sp
Changed in version 2019.2.0.

.sp
Print a list of all minions that are up according to Salt\(aqs presence
detection (no commands will be sent to minions)
.INDENT 7.0
.TP
.B subset
None
Pass in a list of minion ids.
.TP
.B show_ip
False
Also show the IP address each minion is connecting from.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.list_state
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.not_alived(subset=None, show_ip=False)
New in version 2015.8.0.

.sp
Changed in version 2019.2.0.

.sp
Print a list of all minions that are NOT up according to Salt\(aqs presence
detection (no commands will be sent)
.INDENT 7.0
.TP
.B subset
None
Pass in a list of minion ids.
.TP
.B show_ip
False
Also show the IP address each minion is connecting from.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.not_alived
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.not_allowed(subset=None, show_ip=False)
New in version 2015.8.0.

.sp
Changed in version 2019.2.0.

.sp
Print a list of all minions that are NOT up according to Salt\(aqs presence
detection (no commands will be sent)
.INDENT 7.0
.TP
.B subset
None
Pass in a list of minion ids.
.TP
.B show_ip
False
Also show the IP address each minion is connecting from.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.not_allowed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.not_joined(subset=None, show_ip=False)
New in version 2015.8.0.

.sp
Changed in version 2019.2.0.

.sp
Print a list of all minions that are NOT up according to Salt\(aqs presence
detection (no commands will be sent)
.INDENT 7.0
.TP
.B subset
None
Pass in a list of minion ids.
.TP
.B show_ip
False
Also show the IP address each minion is connecting from.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.not_joined
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.not_present(subset=None, show_ip=False)
New in version 2015.5.0.

.sp
Changed in version 2019.2.0.

.sp
Print a list of all minions that are NOT up according to Salt\(aqs presence
detection (no commands will be sent)
.INDENT 7.0
.TP
.B subset
None
Pass in a list of minion ids.
.TP
.B show_ip
False
Also show the IP address each minion is connecting from.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.not_present
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.not_reaped(subset=None, show_ip=False)
New in version 2015.8.0.

.sp
Changed in version 2019.2.0.

.sp
Print a list of all minions that are NOT up according to Salt\(aqs presence
detection (no commands will be sent)
.INDENT 7.0
.TP
.B subset
None
Pass in a list of minion ids.
.TP
.B show_ip
False
Also show the IP address each minion is connecting from.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.not_reaped
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.present(subset=None, show_ip=False)
Changed in version 2019.2.0.

.sp
Print a list of all minions that are up according to Salt\(aqs presence
detection (no commands will be sent to minions)
.INDENT 7.0
.TP
.B subset
None
Pass in a list of minion ids.
.TP
.B show_ip
False
Also show the IP address each minion is connecting from.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.present
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.reaped(subset=None, show_ip=False)
New in version 2015.8.0.

.sp
Changed in version 2019.2.0.

.sp
Print a list of all minions that are up according to Salt\(aqs presence
detection (no commands will be sent to minions)
.INDENT 7.0
.TP
.B subset
None
Pass in a list of minion ids.
.TP
.B show_ip
False
Also show the IP address each minion is connecting from.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.reaped
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.safe_accept(target, tgt_type=\(aqglob\(aq)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Accept a minion\(aqs public key after checking the fingerprint over salt\-ssh
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.safe_accept my_minion
salt\-run manage.safe_accept minion1,minion2 tgt_type=list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.status(output=True, tgt=\(aq*\(aq, tgt_type=\(aqglob\(aq, timeout=None, gather_job_timeout=None)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Print the status of all known salt minions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.status
salt\-run manage.status tgt=\(dqwebservers\(dq tgt_type=\(dqnodegroup\(dq
salt\-run manage.status timeout=5 gather_job_timeout=10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.up(tgt=\(aq*\(aq, tgt_type=\(aqglob\(aq, timeout=None, gather_job_timeout=None)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Print a list of all of the minions that are up
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.up
salt\-run manage.up tgt=\(dqwebservers\(dq tgt_type=\(dqnodegroup\(dq
salt\-run manage.up timeout=5 gather_job_timeout=10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.manage.versions()
Check the version of active minions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run manage.versions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.match
.sp
Run matchers from the master context.
.sp
New in version 3007.0.

.INDENT 0.0
.TP
.B salt.runners.match.compound_matches(expr, minion_id)
Check whether a minion is matched by a given compound match expression.
On success, this function will return the minion ID, otherwise False.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Pillar values will be matched literally only since this function is intended
for remote calling. This also applies to node groups defined on the master.
Custom matchers are not respected.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If a module calls this runner from a minion, you will need to explicitly
allow the remote call. See \fI\%peer_run\fP\&.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run match.compound_matches \(aqI@foo:bar and G@os:Deb* and not db*\(aq myminion
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B expr
The \fI\%Compound Matcher\fP expression to validate against.
.TP
.B minion_id
The minion ID of the minion to check the match for.
.UNINDENT
.UNINDENT
.SS salt.runners.mattermost
.sp
\fBNote for 2017.7 releases!\fP
.sp
Due to the \fI\%salt.runners.config\fP module not being available in this release series, importing the \fI\%salt.runners.config\fP module from the master branch is required to make this module work.
.sp
Ref: \fI\%Mattermost runner failing to retrieve config values due to unavailable config runner #43479\fP
.sp
Module for sending messages to Mattermost
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B configuration
This module can be used by either passing an api_url and hook
directly or by specifying both in a configuration profile in the salt
master/minion config. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mattermost:
  hook: peWcBiMOS9HrZG15peWcBiMOS9HrZG15
  api_url: https://example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.mattermost.post_event(event, channel=None, username=None, api_url=None, hook=None)
Send an event to a Mattermost channel.
:param channel:     The channel name, either will work.
:param username:    The username of the poster.
:param event:       The event to send to the Mattermost channel.
:param api_url:     The Mattermost api url, if not specified in the configuration.
:param hook:        The Mattermost hook, if not specified in the configuration.
:return:            Boolean if message was sent successfully.
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.mattermost.post_message(message, channel=None, username=None, api_url=None, hook=None)
Send a message to a Mattermost channel.
:param channel:     The channel name, either will work.
:param username:    The username of the poster.
:param message:     The message to send to the Mattermost channel.
:param api_url:     The Mattermost api url, if not specified in the configuration.
:param hook:        The Mattermost hook, if not specified in the configuration.
:return:            Boolean if message was sent successfully.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run mattermost.post_message message=\(aqBuild is done\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.mine
.sp
A runner to access data from the salt mine
.INDENT 0.0
.TP
.B salt.runners.mine.get(tgt, fun, tgt_type=\(aqglob\(aq)
Gathers the data from the specified minions\(aq mine, pass in the target,
function to look up and the target type
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run mine.get \(aq*\(aq network.interfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.mine.update(tgt, tgt_type=\(aqglob\(aq, clear=False, mine_functions=None)
New in version 2017.7.0.

.sp
Update the mine data on a certain group of minions.
.INDENT 7.0
.TP
.B tgt
Which minions to target for the execution.
.TP
.B tgt_type: \fBglob\fP
The type of \fBtgt\fP\&.
.TP
.B clear: \fBFalse\fP
Boolean flag specifying whether updating will clear the existing
mines, or will update. Default: \fBFalse\fP (update).
.TP
.B mine_functions
Update the mine data on certain functions only.
This feature can be used when updating the mine for functions
that require refresh at different intervals than the rest of
the functions specified under \fBmine_functions\fP in the
minion/master config or pillar.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run mine.update \(aq*\(aq
salt\-run mine.update \(aqjuniper\-edges\(aq tgt_type=\(aqnodegroup\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.nacl
.sp
This module helps include encrypted passwords in pillars, grains and salt state files.
.INDENT 0.0
.TP
.B depends
PyNaCl, \fI\%https://github.com/pyca/pynacl\fP
.UNINDENT
.sp
This is often useful if you wish to store your pillars in source control or
share your pillar data with others that you trust. I don\(aqt advise making your pillars public
regardless if they are encrypted or not.
.INDENT 0.0
.TP
.B configuration
The following configuration defaults can be
define (pillar or config files) Avoid storing private keys in pillars! Ensure master does not have \fIpillar_opts=True\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# cat /etc/salt/master.d/nacl.conf
nacl.config:
    # NOTE: \(gakey\(ga and \(gakey_file\(ga have been renamed to \(gask\(ga, \(gask_file\(ga
    # also \(gabox_type\(ga default changed from secretbox to sealedbox.
    box_type: sealedbox                     (default)
    sk_file: /etc/salt/pki/master/nacl      (default)
    pk_file: /etc/salt/pki/master/nacl.pub  (default)
    sk: None
    pk: None
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Usage can override the config defaults:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.enc sk_file=/etc/salt/pki/master/nacl pk_file=/etc/salt/pki/master/nacl.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The nacl lib uses 32byte keys, these keys are base64 encoded to make your life more simple.
To generate your \fIsk_file\fP and \fIpk_file\fP use:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.keygen sk_file=/etc/salt/pki/master/nacl
# or if you want to work without files.
salt\-run nacl.keygen
local:
    \-\-\-\-\-\-\-\-\-\-
    pk:
        /kfGX7PbWeu099702PBbKWLpG/9p06IQRswkdWHCDk0=
    sk:
        SVWut5SqNpuPeNzb1b9y6b2eXg2PLIog43GBzp48Sow=
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now with your keypair, you can encrypt data:
.sp
You have two option, \fIsealedbox\fP or \fIsecretbox\fP\&.
.sp
SecretBox is data encrypted using private key \fIpk\fP\&. Sealedbox is encrypted using public key \fIpk\fP\&.
.sp
Recommend using Sealedbox because the one way encryption permits developers to encrypt data for source control but not decrypt.
Sealedbox only has one key that is for both encryption and decryption.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.enc asecretpass pk=/kfGX7PbWeu099702PBbKWLpG/9p06IQRswkdWHCDk0=
tqXzeIJnTAM9Xf0mdLcpEdklMbfBGPj2oTKmlgrm3S1DTVVHNnh9h8mU1GKllGq/+cYsk6m5WhGdk58=
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To decrypt the data:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.dec data=\(aqtqXzeIJnTAM9Xf0mdLcpEdklMbfBGPj2oTKmlgrm3S1DTVVHNnh9h8mU1GKllGq/+cYsk6m5WhGdk58=\(aq         sk=\(aqSVWut5SqNpuPeNzb1b9y6b2eXg2PLIog43GBzp48Sow=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When the keys are defined in the master config you can use them from the nacl runner
without extra parameters:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# cat /etc/salt/master.d/nacl.conf
nacl.config:
    sk_file: /etc/salt/pki/master/nacl
    pk: \(aqcTIqXwnUiD1ulg4kXsbeCE7/NoeKEzd4nLeYcCFpd9k=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.enc \(aqasecretpass\(aq
salt\-run nacl.dec data=\(aqtqXzeIJnTAM9Xf0mdLcpEdklMbfBGPj2oTKmlgrm3S1DTVVHNnh9h8mU1GKllGq/+cYsk6m5WhGdk58=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# a salt developers minion could have pillar data that includes a nacl public key
nacl.config:
    pk: \(aq/kfGX7PbWeu099702PBbKWLpG/9p06IQRswkdWHCDk0=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The developer can then use a less\-secure system to encrypt data.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.enc apassword
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pillar files can include protected data that the salt master decrypts:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillarexample:
    user: root
    password1: {{salt.nacl.dec(\(aqDRB7Q6/X5gGSRCTpZyxS6hlbWj0llUA+uaVyvou3vJ4=\(aq)|json}}
    cert_key: {{salt.nacl.dec_file(\(aq/srv/salt/certs/example.com/key.nacl\(aq)|json}}
    cert_key2: {{salt.nacl.dec_file(\(aqsalt:///certs/example.com/key.nacl\(aq)|json}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Larger files like certificates can be encrypted with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.enc_file /tmp/cert.crt out=/tmp/cert.nacl
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.nacl.dec(data, **kwargs)
Alias to \fI{box_type}_decrypt\fP
.sp
box_type: secretbox, sealedbox(default)
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.nacl.dec_file(name, out=None, **kwargs)
This is a helper function to decrypt a file and return its contents.
.sp
You can provide an optional output file using \fIout\fP
.sp
\fIname\fP can be a local file or when not using \fIsalt\-run\fP can be a url like \fIsalt://\fP, \fIhttps://\fP etc.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.dec_file name=/tmp/id_rsa.nacl
salt\-run nacl.dec_file name=/tmp/id_rsa.nacl box_type=secretbox             sk_file=/etc/salt/pki/master/nacl.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.nacl.enc(data, **kwargs)
Alias to \fI{box_type}_encrypt\fP
.sp
box_type: secretbox, sealedbox(default)
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.nacl.enc_file(name, out=None, **kwargs)
This is a helper function to encrypt a file and return its contents.
.sp
You can provide an optional output file using \fIout\fP
.sp
\fIname\fP can be a local file or when not using \fIsalt\-run\fP can be a url like \fIsalt://\fP, \fIhttps://\fP etc.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.enc_file name=/tmp/id_rsa
salt\-run nacl.enc_file name=/tmp/id_rsa box_type=secretbox             sk_file=/etc/salt/pki/master/nacl.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.nacl.keygen(sk_file=None, pk_file=None, **kwargs)
Use PyNaCL to generate a keypair.
.sp
If no \fIsk_file\fP is defined return a keypair.
.sp
If only the \fIsk_file\fP is defined \fIpk_file\fP will use the same name with a postfix \fI\&.pub\fP\&.
.sp
When the \fIsk_file\fP is already existing, but \fIpk_file\fP is not. The \fIpk_file\fP will be generated
using the \fIsk_file\fP\&.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.keygen
salt\-run nacl.keygen sk_file=/etc/salt/pki/master/nacl
salt\-run nacl.keygen sk_file=/etc/salt/pki/master/nacl pk_file=/etc/salt/pki/master/nacl.pub
salt\-run nacl.keygen
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.nacl.sealedbox_decrypt(data, **kwargs)
Decrypt data using a secret key that was encrypted using a public key with \fInacl.sealedbox_encrypt\fP\&.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.sealedbox_decrypt pEXHQM6cuaF7A=
salt\-run nacl.sealedbox_decrypt data=\(aqpEXHQM6cuaF7A=\(aq sk_file=/etc/salt/pki/master/nacl
salt\-run nacl.sealedbox_decrypt data=\(aqpEXHQM6cuaF7A=\(aq sk=\(aqYmFkcGFzcwo=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.nacl.sealedbox_encrypt(data, **kwargs)
Encrypt data using a public key generated from \fInacl.keygen\fP\&.
The encryptd data can be decrypted using \fInacl.sealedbox_decrypt\fP only with the secret key.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.sealedbox_encrypt datatoenc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.nacl.secretbox_decrypt(data, **kwargs)
Decrypt data that was encrypted using \fInacl.secretbox_encrypt\fP using the secret key
that was generated from \fInacl.keygen\fP\&.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.secretbox_decrypt pEXHQM6cuaF7A=
salt\-run nacl.secretbox_decrypt data=\(aqpEXHQM6cuaF7A=\(aq sk_file=/etc/salt/pki/master/nacl
salt\-run nacl.secretbox_decrypt data=\(aqpEXHQM6cuaF7A=\(aq sk=\(aqYmFkcGFzcwo=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.nacl.secretbox_encrypt(data, **kwargs)
Encrypt data using a secret key generated from \fInacl.keygen\fP\&.
The same secret key can be used to decrypt the data using \fInacl.secretbox_decrypt\fP\&.
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run nacl.secretbox_encrypt datatoenc
salt\-run nacl.secretbox_encrypt datatoenc sk_file=/etc/salt/pki/master/nacl
salt\-run nacl.secretbox_encrypt datatoenc sk=\(aqYmFkcGFzcwo=\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.net
.SS NET Finder
.sp
New in version 2017.7.0.

.sp
A runner to find network details easily and fast.
It\(aqs smart enough to know what you are looking for.
.SS Configuration
.INDENT 0.0
.IP \(bu 2
Minion (proxy) config
.INDENT 2.0
.INDENT 3.5
To have the complete features, one needs to add the following mine configuration in the minion (proxy) config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_functions:
  net.ipaddrs: []
  net.lldp: []
  net.mac: []
  net.arp: []
  net.interfaces: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Which instructs Salt to cache the data returned by the NAPALM\-functions.
While they are not mandatory, the less functions configured, the less details will be found by the runner.
.sp
How often the mines are refreshed, can be specified using:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_interval: <X minutes>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
Master config
.INDENT 2.0
.INDENT 3.5
By default the following options can be configured on the master.
They are not necessary, but available in case the user has different requirements.
.INDENT 0.0
.TP
.B target: \fB*\fP
From what minions will collect the mine data. Default: \fB*\fP (collect from all minions).
.TP
.B expr_form: \fBglob\fP
Minion matching expression form. Default: \fBglob\fP\&.
.TP
.B ignore_interfaces
A list of interfaces name to ignore. By default will consider all interfaces.
.TP
.B display: \fBTrue\fP
Display on the screen or return structured object? Default: \fBTrue\fP (return on the CLI).
.TP
.B outputter: \fBtable\fP
Specify the outputter name when displaying on the CLI. Default: \fBtable\fP\&.
.UNINDENT
.sp
Configuration example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
runners:
  net.find:
    target: \(aqedge*\(aq
    expr_form: \(aqglob\(aq
    ignore_interfaces:
      \- lo0
      \- em1
      \- jsrv
      \- fxp0
    outputter: yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.net.find(addr, best=True, display=True)
Search in all possible entities (Interfaces, MAC tables, ARP tables, LLDP neighbors),
using the following mine functions:
.INDENT 7.0
.IP \(bu 2
net.mac
.IP \(bu 2
net.arp
.IP \(bu 2
net.lldp
.IP \(bu 2
net.ipaddrs
.IP \(bu 2
net.interfaces
.UNINDENT
.sp
This function has the advantage that it knows where to look, but the output might
become quite long as returns all possible matches.
.sp
Optional arguments:
.INDENT 7.0
.TP
.B best: \fBTrue\fP
Return only the best match with the interfaces IP networks
when the saerching pattern is a valid IP Address or Network.
.TP
.B display: \fBTrue\fP
Display on the screen or return structured object? Default: \fBTrue\fP (return on the CLI).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt\-run net.find 10.10.10.7
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Details for all interfaces that include network 10.10.10.7/32 \- only best match returned
________________________________________________________________________________________________________________________
|    Device    | Interface | Interface Description |  UP  | Enabled | Speed [Mbps] |    MAC Address    |  IP Addresses |
________________________________________________________________________________________________________________________
| edge01.flw01 |    irb    |                       | True |   True  |      \-1      | 5C:5E:AB:AC:52:B4 | 10.10.10.1/22 |
________________________________________________________________________________________________________________________

ARP Entries for IP 10.10.10.7
_____________________________________________________________________________
|    Device    |     Interface     |        MAC        |     IP     |  Age  |
_____________________________________________________________________________
| edge01.flw01 | irb.349 [ae0.349] | 2C:60:0C:2A:4C:0A | 10.10.10.7 | 832.0 |
_____________________________________________________________________________
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.net.findarp(device=None, interface=None, mac=None, ip=None, display=True)
Search for entries in the ARP tables using the following mine functions:
.INDENT 7.0
.IP \(bu 2
net.arp
.UNINDENT
.sp
Optional arguments:
.INDENT 7.0
.TP
.B device
Return interface data from a certain device only.
.TP
.B interface
Return data selecting by interface name.
.TP
.B mac
Search using a specific MAC Address.
.TP
.B ip
Search using a specific IP Address.
.TP
.B display: \fBTrue\fP
Display on the screen or return structured object? Default: \fBTrue\fP, will return on the CLI.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt\-run net.findarp mac=8C:60:0F:78:EC:41
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ARP Entries for MAC 8C:60:0F:78:EC:41
________________________________________________________________________________
|    Device    |     Interface     |        MAC        |       IP      |  Age  |
________________________________________________________________________________
| edge01.bjm01 | irb.171 [ae0.171] | 8C:60:0F:78:EC:41 | 172.172.17.19 | 956.0 |
________________________________________________________________________________
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.net.findmac(device=None, mac=None, interface=None, vlan=None, display=True)
Search in the MAC Address tables, using the following mine functions:
.INDENT 7.0
.IP \(bu 2
net.mac
.UNINDENT
.sp
Optional arguments:
.INDENT 7.0
.TP
.B device
Return interface data from a certain device only.
.TP
.B interface
Return data selecting by interface name.
.TP
.B mac
Search using a specific MAC Address.
.TP
.B vlan
Search using a VLAN ID.
.TP
.B display: \fBTrue\fP
Display on the screen or return structured object? Default: \fBTrue\fP, will return on the CLI.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt\-run net.findmac mac=8C:60:0F:78:EC:41
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
MAC Address(es)
_____________________________________________________________________________________________
|    Device    | Interface |        MAC        | VLAN | Static | Active | Moves | Last move |
_____________________________________________________________________________________________
| edge01.bjm01 |  ae0.171  | 8C:60:0F:78:EC:41 | 171  | False  |  True  |   0   |    0.0    |
_____________________________________________________________________________________________
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.net.interfaces(device=None, interface=None, title=None, pattern=None, ipnet=None, best=True, display=True)
Search for interfaces details in the following mine functions:
.INDENT 7.0
.IP \(bu 2
net.interfaces
.IP \(bu 2
net.ipaddrs
.UNINDENT
.sp
Optional arguments:
.INDENT 7.0
.TP
.B device
Return interface data from a certain device only.
.TP
.B interface
Return data selecting by interface name.
.TP
.B pattern
Return interfaces that contain a certain pattern in their description.
.TP
.B ipnet
Return interfaces whose IP networks associated include this IP network.
.TP
.B best: \fBTrue\fP
When \fBipnet\fP is specified, this argument says if the runner should return only the best match
(the output will contain at most one row). Default: \fBTrue\fP (return only the best match).
.TP
.B display: True
Display on the screen or return structured object? Default: \fBTrue\fP (return on the CLI).
.TP
.B title
Display a custom title for the table.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt\-run net.interfaces interface=vt\-0/0/10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Details for interface xe\-0/0/0
_________________________________________________________________________________________________________________
|    Device    | Interface | Interface Description |  UP  | Enabled | Speed [Mbps] | MAC Address | IP Addresses |
_________________________________________________________________________________________________________________
| edge01.bjm01 | vt\-0/0/10 |                       | True |   True  |     1000     |             |              |
_________________________________________________________________________________________________________________
| edge01.flw01 | vt\-0/0/10 |                       | True |   True  |     1000     |             |              |
_________________________________________________________________________________________________________________
| edge01.pos01 | vt\-0/0/10 |                       | True |   True  |     1000     |             |              |
_________________________________________________________________________________________________________________
| edge01.oua01 | vt\-0/0/10 |                       | True |   True  |     1000     |             |              |
_________________________________________________________________________________________________________________
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.net.lldp(device=None, interface=None, title=None, pattern=None, chassis=None, display=True)
Search in the LLDP neighbors, using the following mine functions:
.INDENT 7.0
.IP \(bu 2
net.lldp
.UNINDENT
.sp
Optional arguments:
.INDENT 7.0
.TP
.B device
Return interface data from a certain device only.
.TP
.B interface
Return data selecting by interface name.
.TP
.B pattern
Return LLDP neighbors that have contain this pattern in one of the following fields:
.INDENT 7.0
.IP \(bu 2
Remote Port ID
.IP \(bu 2
Remote Port Description
.IP \(bu 2
Remote System Name
.IP \(bu 2
Remote System Description
.UNINDENT
.TP
.B chassis
Search using a specific Chassis ID.
.TP
.B display: \fBTrue\fP
Display on the screen or return structured object? Default: \fBTrue\fP (return on the CLI).
.TP
.B display: \fBTrue\fP
Display on the screen or return structured object? Default: \fBTrue\fP (return on the CLI).
.TP
.B title
Display a custom title for the table.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt\-run net.lldp pattern=Ethernet1/48
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Pattern \(dqEthernet1/48\(dq found in one of the following LLDP details
_________________________________________________________________________________________________________________________________________________________________________________________
|    Device    | Interface | Parent Interface | Remote Chassis ID | Remote Port ID | Remote Port Description |   Remote System Name   |            Remote System Description            |
_________________________________________________________________________________________________________________________________________________________________________________________
| edge01.bjm01 |  xe\-2/3/4 |       ae0        | 8C:60:4F:3B:52:19 |                |       Ethernet1/48      | edge05.bjm01.dummy.net |   Cisco NX\-OS(tm) n6000, Software (n6000\-uk9),  |
|              |           |                  |                   |                |                         |                        | Version 7.3(0)N7(5), RELEASE SOFTWARE Copyright |
|              |           |                  |                   |                |                         |                        |  (c) 2002\-2012 by Cisco Systems, Inc. Compiled  |
|              |           |                  |                   |                |                         |                        |                2/17/2016 22:00:00               |
_________________________________________________________________________________________________________________________________________________________________________________________
| edge01.flw01 |  xe\-1/2/3 |       ae0        | 8C:60:4F:1A:B4:22 |                |       Ethernet1/48      | edge05.flw01.dummy.net |   Cisco NX\-OS(tm) n6000, Software (n6000\-uk9),  |
|              |           |                  |                   |                |                         |                        | Version 7.3(0)N7(5), RELEASE SOFTWARE Copyright |
|              |           |                  |                   |                |                         |                        |  (c) 2002\-2012 by Cisco Systems, Inc. Compiled  |
|              |           |                  |                   |                |                         |                        |                2/17/2016 22:00:00               |
_________________________________________________________________________________________________________________________________________________________________________________________
| edge01.oua01 |  xe\-0/1/2 |       ae1        | 8C:60:4F:51:A4:22 |                |       Ethernet1/48      | edge05.oua01.dummy.net |   Cisco NX\-OS(tm) n6000, Software (n6000\-uk9),  |
|              |           |                  |                   |                |                         |                        | Version 7.3(0)N7(5), RELEASE SOFTWARE Copyright |
|              |           |                  |                   |                |                         |                        |  (c) 2002\-2012 by Cisco Systems, Inc. Compiled  |
|              |           |                  |                   |                |                         |                        |                2/17/2016 22:00:00               |
_________________________________________________________________________________________________________________________________________________________________________________________
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.net.multi_find(*patterns, **kwargs)
Execute multiple search tasks.
This function is based on the \fIfind\fP function.
Depending on the search items, some information might overlap.
.sp
Optional arguments:
.INDENT 7.0
.TP
.B best: \fBTrue\fP
Return only the best match with the interfaces IP networks
when the saerching pattern is a valid IP Address or Network.
.TP
.B display: \fBTrue\fP
Display on the screen or return structured object? Default: \fITrue\fP (return on the CLI).
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt\-run net.multi_find Ethernet1/49 xe\-0/1/2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Pattern \(dqEthernet1/49\(dq found in one of the following LLDP details

    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
    |    Device    | Interface | Parent Interface | Remote Chassis ID | Remote Port Description | Remote Port ID |          Remote System Description          |   Remote System Name   |
    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
    | edge01.oua04 |  xe\-0/1/2 |       ae1        | DE:AD:BE:EF:DE:AD |       Ethernet1/49      |                | Cisco NX\-OS(tm) n6000, Software (n6000\-uk9) | edge07.oua04.dummy.net |
    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-

Details for interface xe\-0/1/2

    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
    |    Device    | Interface | Interface Description | IP Addresses | Enabled |  UP  |    MAC Address    | Speed [Mbps] |
    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
    | edge01.oua04 |  xe\-0/1/2 |     ae1 sw01.oua04    |              |   True  | True | BE:EF:DE:AD:BE:EF |    10000     |
    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-

LLDP Neighbors for interface xe\-0/1/2

    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
    |    Device    | Interface | Parent Interface | Remote Chassis ID | Remote Port Description | Remote Port ID |          Remote System Description          |   Remote System Name   |
    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
    | edge01.oua04 |  xe\-0/1/2 |       ae1        | DE:AD:BE:EF:DE:AD |       Ethernet1/49      |                | Cisco NX\-OS(tm) n6000, Software (n6000\-uk9) | edge07.oua04.dummy.net |
    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.network
.sp
Network tools to run from the Master
.INDENT 0.0
.TP
.B salt.runners.network.wol(mac, bcast=\(aq255.255.255.255\(aq, destport=9)
Send a \(dqMagic Packet\(dq to wake up a Minion
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run network.wol 08\-00\-27\-13\-69\-77
salt\-run network.wol 080027136977 255.255.255.255 7
salt\-run network.wol 08:00:27:13:69:77 255.255.255.255 7
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.network.wollist(maclist, bcast=\(aq255.255.255.255\(aq, destport=9)
Send a \(dqMagic Packet\(dq to wake up a list of Minions.
This list must contain one MAC hardware address per line
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run network.wollist \(aq/path/to/maclist\(aq
salt\-run network.wollist \(aq/path/to/maclist\(aq 255.255.255.255 7
salt\-run network.wollist \(aq/path/to/maclist\(aq 255.255.255.255 7
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.network.wolmatch(tgt, tgt_type=\(aqglob\(aq, bcast=\(aq255.255.255.255\(aq, destport=9)
Send a \(dqMagic Packet\(dq to wake up Minions that are matched in the grains cache
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run network.wolmatch minion_id
salt\-run network.wolmatch 192.168.0.0/16 tgt_type=\(aqipcidr\(aq bcast=255.255.255.255 destport=7
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.pagerduty
.sp
Runner Module for Firing Events via PagerDuty
.sp
New in version 2014.1.0.

.INDENT 0.0
.TP
.B configuration
This module can be used by specifying the name of a
configuration profile in the master config.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my\-pagerduty\-account:
    pagerduty.api_key: F3Rbyjbve43rfFWf2214
    pagerduty.subdomain: mysubdomain
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.pagerduty.create_event(service_key=None, description=None, details=None, incident_key=None, profile=None)
Create an event in PagerDuty. Designed for use in states.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run pagerduty.create_event <service_key> <description> <details>         profile=my\-pagerduty\-account
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B service_key
This key can be found by using pagerduty.list_services.
.TP
.B description
This is a short description of the event.
.TP
.B details
This can be a more detailed description of the event.
.TP
.B profile
This refers to the configuration profile to use to connect to the
PagerDuty service.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.pagerduty.list_escalation_policies(profile=None, api_key=None)
This function is an alias of \fBlist_policies\fP\&.
.INDENT 7.0
.INDENT 3.5
List escalation policies belonging to this account
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
salt\-run pagerduty.list_policies my\-pagerduty\-account
salt\-run pagerduty.list_escalation_policies my\-pagerduty\-account
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.pagerduty.list_incidents(profile=None, api_key=None)
List incidents belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
salt\-run pagerduty.list_incidents my\-pagerduty\-account
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.pagerduty.list_maintenance_windows(profile=None, api_key=None)
This function is an alias of \fBlist_windows\fP\&.
.INDENT 7.0
.INDENT 3.5
List maintenance windows belonging to this account
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
salt\-run pagerduty.list_windows my\-pagerduty\-account
salt\-run pagerduty.list_maintenance_windows my\-pagerduty\-account
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.pagerduty.list_policies(profile=None, api_key=None)
List escalation policies belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
salt\-run pagerduty.list_policies my\-pagerduty\-account
salt\-run pagerduty.list_escalation_policies my\-pagerduty\-account
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.pagerduty.list_schedules(profile=None, api_key=None)
List schedules belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
salt\-run pagerduty.list_schedules my\-pagerduty\-account
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.pagerduty.list_services(profile=None, api_key=None)
List services belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
salt\-run pagerduty.list_services my\-pagerduty\-account
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.pagerduty.list_users(profile=None, api_key=None)
List users belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
salt\-run pagerduty.list_users my\-pagerduty\-account
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.pagerduty.list_windows(profile=None, api_key=None)
List maintenance windows belonging to this account
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
salt\-run pagerduty.list_windows my\-pagerduty\-account
salt\-run pagerduty.list_maintenance_windows my\-pagerduty\-account
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.pillar
.sp
Functions to interact with the pillar compiler on the master
.INDENT 0.0
.TP
.B salt.runners.pillar.clear_pillar_cache(minion=\(aq*\(aq, **kwargs)
Clears the cached values when using pillar_cache
.sp
New in version 3003.

.sp
CLI Example:
.sp
Clears the pillar cache for a specific minion:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run pillar.clear_pillar_cache \(aqminion\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.pillar.show_pillar(minion=\(aq*\(aq, **kwargs)
Returns the compiled pillar either of a specific minion
or just the global available pillars. This function assumes
that no minion has the id \fB*\fP\&.
Function also accepts pillarenv as attribute in order to limit to a specific pillar branch of git
.sp
CLI Example:
.sp
shows minion specific pillar:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run pillar.show_pillar \(aqwww.example.com\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
shows global pillar:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run pillar.show_pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
shows global pillar for \(aqdev\(aq pillar environment:
(note that not specifying pillarenv will merge all pillar environments
using the master config option pillar_source_merging_strategy.)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run pillar.show_pillar \(aqpillarenv=dev\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
shows global pillar for \(aqdev\(aq pillar environment and specific pillarenv = dev:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run pillar.show_pillar \(aqsaltenv=dev\(aq \(aqpillarenv=dev\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
API Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.config
import salt.runner
opts = salt.config.master_config(\(aq/etc/salt/master\(aq)
runner = salt.runner.RunnerClient(opts)
pillar = runner.cmd(\(aqpillar.show_pillar\(aq, [])
print(pillar)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.pillar.show_pillar_cache(minion=\(aq*\(aq, **kwargs)
Shows the cached values in pillar_cache
.sp
New in version 3003.

.sp
CLI Example:
.sp
Shows the pillar cache for a specific minion:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run pillar.show_pillar_cache \(aqminion\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.pillar.show_top(minion=None, saltenv=\(aqbase\(aq)
Returns the compiled top data for pillar for a specific minion.  If no
minion is specified, we use the first minion we find.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run pillar.show_top
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.pkg
.sp
Package helper functions using \fBsalt.modules.pkg\fP
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B salt.runners.pkg.list_upgrades(jid, style=\(aqgroup\(aq, outputter=\(aqnested\(aq, ext_source=None)
Show list of available pkg upgrades using a specified format style
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run pkg.list_upgrades jid=20141120114114417719 style=group
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.queue
.SS General management and processing of queues.
.sp
This runner facilitates interacting with various queue backends such as the
included sqlite3 queue or the planned AWS SQS and Redis queues
.sp
The queue functions such as \fIinsert\fP, \fIdelete\fP, and \fIpop\fP can be used for
typical management of the queue.
.sp
The \fIprocess_queue\fP function pops the requested number of items from the queue
and creates a Salt Event that can then be processed by a Reactor. The
\fIprocess_queue\fP function can be called manually, or can be configured to run on
a schedule with the Salt Scheduler or regular system cron. It is also possible
to use the peer system to allow a minion to call the runner.
.sp
This runner, as well as the Queues system, is not api stable at this time.
.sp
There are many things that could potentially be done with queues within Salt.
For the time being the focus will be on queueing infrastructure actions on
specific minions. The queues generally will be populated with minion IDs.  When
the \fIprocess_queue\fP runner function is called events are created on the Salt
Event bus that indicate the queue and a list of one or more minion IDs. The
reactor is set up to match on event tags for a specific queue and then take
infrastructure actions on those minion IDs. These actions might be to delete
the minion\(aqs key from the master, use salt\-cloud to destroy the vm, or some
other custom action.
.SS Queued runners
.sp
Using the Salt Queues, references to the commandline arguments of other runners
can be saved to be processed later.  The queue runners require a queue backend
that can store json data (default: \fI\%pgjsonb\fP).
.sp
Once the queue is setup, the \fIrunner_queue\fP will need to be configured.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
runner_queue:
  queue: runners
  backend: pgjsonb
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
only the queue is required, this defaults to using pgjsonb
.UNINDENT
.UNINDENT
.sp
Once this is set, then the following can be added to the scheduler on the
master and it will run the specified amount of commands per time period.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  runner queue:
    schedule:
      function: queue.process_runner
      minutes: 1
      kwargs:
        quantity: 2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above configuration will pop 2 runner jobs off the runner queue, and then
run them.  And it will do this every minute, unless there are any jobs that are
still running from the last time the process_runner task was executed.
.INDENT 0.0
.TP
.B salt.runners.queue.delete(queue, items, backend=\(aqsqlite\(aq)
Delete an item or items from a queue
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run queue.delete myqueue myitem
salt\-run queue.delete myqueue myitem backend=sqlite
salt\-run queue.delete myqueue \(dq[\(aqitem1\(aq, \(aqitem2\(aq, \(aqitem3\(aq]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.queue.insert(queue, items, backend=\(aqsqlite\(aq)
Add an item or items to a queue
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run queue.insert myqueue myitem
salt\-run queue.insert myqueue \(dq[\(aqitem1\(aq, \(aqitem2\(aq, \(aqitem3\(aq]\(dq
salt\-run queue.insert myqueue myitem backend=sqlite
salt\-run queue.insert myqueue \(dq[\(aqitem1\(aq, \(aqitem2\(aq, \(aqitem3\(aq]\(dq backend=sqlite
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.queue.insert_runner(fun, args=None, kwargs=None, queue=None, backend=None)
Insert a reference to a runner into the queue so that it can be run later.
.INDENT 7.0
.TP
.B fun
The runner function that is going to be run
.TP
.B args
list or comma\-separated string of args to send to fun
.TP
.B kwargs
dictionary of keyword arguments to send to fun
.TP
.B queue
queue to insert the runner reference into
.TP
.B backend
backend that to use for the queue
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run queue.insert_runner test.stdout_print
salt\-run queue.insert_runner event.send test_insert_runner kwargs=\(aq{\(dqdata\(dq: {\(dqfoo\(dq: \(dqbar\(dq}}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.queue.list_items(queue, backend=\(aqsqlite\(aq)
List contents of a queue
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run queue.list_items myqueue
salt\-run queue.list_items myqueue backend=sqlite
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.queue.list_length(queue, backend=\(aqsqlite\(aq)
Provide the number of items in a queue
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run queue.list_length myqueue
salt\-run queue.list_length myqueue backend=sqlite
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.queue.list_queues(backend=\(aqsqlite\(aq)
Return a list of Salt Queues on the backend
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run queue.list_queues
salt\-run queue.list_queues backend=sqlite
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.queue.pop(queue, quantity=1, backend=\(aqsqlite\(aq, is_runner=False)
Pop one or more or all items from a queue
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run queue.pop myqueue
salt\-run queue.pop myqueue 6
salt\-run queue.pop myqueue all
salt\-run queue.pop myqueue 6 backend=sqlite
salt\-run queue.pop myqueue all backend=sqlite
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.queue.process_queue(queue, quantity=1, backend=\(aqsqlite\(aq, is_runner=False)
Pop items off a queue and create an event on the Salt event bus to be
processed by a Reactor.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run queue.process_queue myqueue
salt\-run queue.process_queue myqueue 6
salt\-run queue.process_queue myqueue all backend=sqlite
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.queue.process_runner(quantity=1, queue=None, backend=None)
Process queued runners
.INDENT 7.0
.TP
.B quantity
number of runners to process
.TP
.B queue
queue to insert the runner reference into
.TP
.B backend
backend that to use for the queue
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run queue.process_runner
salt\-run queue.process_runner 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.reactor
.sp
A convenience system to manage reactors
.sp
Beginning in the 2017.7 release, the reactor runner requires that the reactor
system is running.  This is accomplished one of two ways, either
by having reactors configured or by including \fBreactor\fP in the
engine configuration for the Salt master.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B engines:
.INDENT 7.0
.IP \(bu 2
reactor
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.reactor.add(event, reactors, saltenv=\(aqbase\(aq, test=None)
Add a new reactor
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run reactor.add \(aqsalt/cloud/*/destroyed\(aq reactors=\(aq/srv/reactor/destroy/*.sls\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.reactor.delete(event, saltenv=\(aqbase\(aq, test=None)
Delete a reactor
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run reactor.delete \(aqsalt/cloud/*/destroyed\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.reactor.is_leader()
Return whether the running reactor is acting as a leader (responding to events).
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run reactor.is_leader
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.reactor.list_(saltenv=\(aqbase\(aq, test=None)
List currently configured reactors
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run reactor.list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.reactor.set_leader(value=True)
Set the current reactor to act as a leader (responding to events). Defaults to True
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run reactor.set_leader True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.salt
.sp
This runner makes Salt\(aqs
execution modules available
on the salt master.
.sp
New in version 2016.11.0.

.sp
Salt\(aqs execution modules are normally available
on the salt minion. Use this runner to call
execution modules on the salt master.
Salt \fI\%execution modules\fP
are the functions called by the \fBsalt\fP command.
.sp
Execution modules can be called with \fBsalt\-run\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run salt.cmd test.ping
# call functions with arguments and keyword arguments
salt\-run salt.cmd test.arg 1 2 3 key=value a=1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Execution modules are also available to salt runners:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__salt__[\(aqsalt.cmd\(aq](fun=fun, args=args, kwargs=kwargs)
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.salt.cmd(fun, *args, **kwargs)
Changed in version 2018.3.0: Added \fBwith_pillar\fP argument

.sp
Execute \fBfun\fP with the given \fBargs\fP and \fBkwargs\fP\&.  Parameter \fBfun\fP
should be the string \fI\%name\fP of the execution module
to call.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Execution modules will be loaded \fIevery time\fP this function is called.
Additionally, keep in mind that since runners execute on the master,
custom execution modules will need to be synced to the master using
\fI\%salt\-run saltutil.sync_modules\fP, otherwise they will not be
available.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B with_pillar
False
If \fBTrue\fP, pillar data will be compiled for the master
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To target the master in the pillar top file, keep in mind that the
default \fBid\fP for the master is \fB<hostname>_master\fP\&. This can be
overridden by setting an \fBid\fP configuration parameter in the
master config file.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run salt.cmd test.ping
# call functions with arguments and keyword arguments
salt\-run salt.cmd test.arg 1 2 3 a=1
salt\-run salt.cmd mymod.myfunc with_pillar=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.salt.execute(tgt, fun, arg=(), timeout=None, tgt_type=\(aqglob\(aq, ret=\(aq\(aq, jid=\(aq\(aq, kwarg=None, **kwargs)
New in version 2017.7.0.

.sp
Execute \fBfun\fP on all minions matched by \fBtgt\fP and \fBtgt_type\fP\&.
Parameter \fBfun\fP is the name of execution module function to call.
.sp
This function should mainly be used as a helper for runner modules,
in order to avoid redundant code.
For example, when inside a runner one needs to execute a certain function
on arbitrary groups of minions, only has to:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ret1 = __salt__[\(aqsalt.execute\(aq](\(aq*\(aq, \(aqmod.fun\(aq)
ret2 = __salt__[\(aqsalt.execute\(aq](\(aqmy_nodegroup\(aq, \(aqmod2.fun2\(aq, tgt_type=\(aqnodegroup\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It can also be used to schedule jobs directly on the master, for example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
    collect_bgp_stats:
        function: salt.execute
        args:
            \- edge\-routers
            \- bgp.neighbors
        kwargs:
            tgt_type: nodegroup
        days: 1
        returner: redis
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.saltutil
.sp
The Saltutil runner is used to sync custom types to the Master. See the
\fI\%saltutil module\fP for documentation on
managing updates to minions.
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_all(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
Sync all custom types
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
dictionary of modules to sync based on type
.TP
.B extmod_blacklist
None
dictionary of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_all
salt\-run saltutil.sync_all extmod_whitelist={\(aqrunners\(aq: [\(aqcustom_runner\(aq], \(aqgrains\(aq: []}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_cache(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
New in version 2017.7.0.

.sp
Sync cache modules from \fBsalt://_cache\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_cache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_clouds(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
New in version 2017.7.0.

.sp
Sync cloud modules from \fBsalt://_clouds\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_clouds
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_eauth_tokens(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
New in version 2018.3.0.

.sp
Sync eauth token modules from \fBsalt://_tokens\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_eauth_tokens
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_engines(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
Sync engines from \fBsalt://_engines\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_engines
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_executors(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
New in version 3000.

.sp
Sync executor modules from \fBsalt://_executors\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-seperated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-seperated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_executors
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_fileserver(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
New in version 2018.3.0.

.sp
Sync fileserver modules from \fBsalt://_fileserver\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_fileserver
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_grains(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
Sync grains modules from \fBsalt://_grains\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_grains
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_modules(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
Sync execution modules from \fBsalt://_modules\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_modules
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_output(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
Sync output modules from \fBsalt://_output\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_output
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_pillar(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
Sync pillar modules from \fBsalt://_pillar\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_proxymodules(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
Sync proxy modules from \fBsalt://_proxy\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_proxymodules
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_queues(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
Sync queue modules from \fBsalt://_queues\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_queues
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_renderers(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
Sync renderer modules from from \fBsalt://_renderers\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_renderers
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_returners(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
Sync returner modules from \fBsalt://_returners\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_returners
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_roster(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
New in version 2017.7.0.

.sp
Sync roster modules from \fBsalt://_roster\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_roster
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_runners(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
Sync runners from \fBsalt://_runners\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_runners
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_sdb(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
New in version 2017.7.0.

.sp
Sync sdb modules from \fBsalt://_sdb\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_sdb
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_serializers(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
New in version 2019.2.0.

.sp
Sync serializer modules from \fBsalt://_serializers\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-seperated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-seperated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_utils
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_states(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
Sync state modules from \fBsalt://_states\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_states
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_thorium(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
New in version 2018.3.0.

.sp
Sync Thorium from \fBsalt://_thorium\fP to the master
.INDENT 7.0
.TP
.B saltenv: \fBbase\fP
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_thorium
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_tops(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
New in version 2016.3.7,2016.11.4,2017.7.0.

.sp
Sync master_tops modules from \fBsalt://_tops\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_tops
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_utils(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
New in version 2016.11.0.

.sp
Sync utils modules from \fBsalt://_utils\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_utils
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_wheel(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
Sync wheel modules from \fBsalt://_wheel\fP to the master
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-separated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-separated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_wheel
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.saltutil.sync_wrapper(saltenv=\(aqbase\(aq, extmod_whitelist=None, extmod_blacklist=None)
New in version 3007.0.

.sp
Sync salt\-ssh wrapper modules from \fBsalt://_wrapper\fP to the master.
.INDENT 7.0
.TP
.B saltenv
base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma\-separated list.
.TP
.B extmod_whitelist
None
comma\-seperated list of modules to sync
.TP
.B extmod_blacklist
None
comma\-seperated list of modules to blacklist based on type
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run saltutil.sync_wrapper
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.sdb
.sp
Runner for setting and querying data via the sdb API on the master
.INDENT 0.0
.TP
.B salt.runners.sdb.delete(uri)
Delete a value from a db, using a uri in the form of \fBsdb://<profile>/<key>\fP\&.
If the uri provided does not start with \fBsdb://\fP or the value is not
successfully deleted, return \fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run sdb.delete sdb://mymemcached/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.sdb.get(uri)
Get a value from a db, using a uri in the form of sdb://<profile>/<key>. If
the uri provided does not start with sdb://, then it will be returned as\-is.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run sdb.get sdb://mymemcached/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.sdb.get_or_set_hash(uri, length=8, chars=\(aqabcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(\-_=+)\(aq)
Perform a one\-time generation of a hash and write it to sdb.
If that value has already been set return the value instead.
.sp
This is useful for generating passwords or keys that are specific to
multiple minions that need to be stored somewhere centrally.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run sdb.get_or_set_hash \(aqSECRET_KEY\(aq 50
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This function could return strings which may contain characters which are reserved
as directives by the YAML parser, such as strings beginning with \fB%\fP\&. To avoid
issues when using the output of this function in an SLS file containing YAML+Jinja,
surround the call with single quotes.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.sdb.set_(uri, value)
Set a value in a db, using a uri in the form of \fBsdb://<profile>/<key>\fP\&.
If the uri provided does not start with \fBsdb://\fP or the value is not
successfully set, return \fBFalse\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run sdb.set sdb://mymemcached/foo bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.smartos_vmadm
.sp
Runner for SmartOS minions control vmadm
.INDENT 0.0
.TP
.B salt.runners.smartos_vmadm.get(search, one=True)
Return information for vms
.INDENT 7.0
.TP
.B search
string
filter vms, see the execution module.
.TP
.B one
boolean
return only one vm
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the search parameter does not contain an equal (=) symbol it will be
assumed it will be tried as uuid, hostname, and alias.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vmadm.get 91244bba\-1146\-e4ec\-c07e\-e825e0223aa9
salt\-run vmadm.get search=\(aqalias=saskia\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.smartos_vmadm.is_running(search)
Return true if vm is running
.INDENT 7.0
.TP
.B search
string
filter vms, see the execution module.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the search parameter does not contain an equal (=) symbol it will be
assumed it will be tried as uuid, hostname, and alias.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If multiple vms are matched, the result will be true of ALL vms are running
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vmadm.is_running 91244bba\-1146\-e4ec\-c07e\-e825e0223aa9
salt\-run vmadm.is_running search=\(aqalias=julia\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.smartos_vmadm.list_vms(search=None, verbose=False)
List all vms
.INDENT 7.0
.TP
.B search
string
filter vms, see the execution module
.TP
.B verbose
boolean
print additional information about the vm
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vmadm.list
salt\-run vmadm.list search=\(aqtype=KVM\(aq
salt\-run vmadm.list verbose=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.smartos_vmadm.nodes(verbose=False)
List all compute nodes
.INDENT 7.0
.TP
.B verbose
boolean
print additional information about the node
e.g. platform version, hvm capable, ...
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vmadm.nodes
salt\-run vmadm.nodes verbose=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.smartos_vmadm.reboot(search, one=True, force=False)
Reboot one or more vms
.INDENT 7.0
.TP
.B search
string
filter vms, see the execution module.
.TP
.B one
boolean
reboot only one vm
.TP
.B force
boolean
force reboot, faster but no graceful shutdown
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the search parameter does not contain an equal (=) symbol it will be
assumed it will be tried as uuid, hostname, and alias.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vmadm.reboot 91244bba\-1146\-e4ec\-c07e\-e825e0223aa9
salt\-run vmadm.reboot search=\(aqalias=marije\(aq
salt\-run vmadm.reboot search=\(aqtype=KVM\(aq one=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.smartos_vmadm.start(search, one=True)
Start one or more vms
.INDENT 7.0
.TP
.B search
string
filter vms, see the execution module.
.TP
.B one
boolean
start only one vm
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the search parameter does not contain an equal (=) symbol it will be
assumed it will be tried as uuid, hostname, and alias.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vmadm.start 91244bba\-1146\-e4ec\-c07e\-e825e0223aa9
salt\-run vmadm.start search=\(aqalias=jiska\(aq
salt\-run vmadm.start search=\(aqtype=KVM\(aq one=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.smartos_vmadm.stop(search, one=True)
Stop one or more vms
.INDENT 7.0
.TP
.B search
string
filter vms, see the execution module.
.TP
.B one
boolean
stop only one vm
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the search parameter does not contain an equal (=) symbol it will be
assumed it will be tried as uuid, hostname, and alias.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vmadm.stop 91244bba\-1146\-e4ec\-c07e\-e825e0223aa9
salt\-run vmadm.stop search=\(aqalias=jody\(aq
salt\-run vmadm.stop search=\(aqtype=KVM\(aq one=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.spacewalk
.SS Spacewalk Runner
.sp
New in version 2016.3.0.

.sp
Runner to interact with Spacewalk using Spacewalk API
.INDENT 0.0
.TP
.B codeauthor
Nitin Madhok <\fI\%nmadhok@g.clemson.edu\fP>, Joachim Werner <\fI\%joe@suse.com\fP>, Benedikt Werner <\fI\%1benediktwerner@gmail.com\fP>
.TP
.B maintainer
Benedikt Werner <\fI\%1benediktwerner@gmail.com\fP>
.UNINDENT
.sp
To use this runner, set up the Spacewalk URL, username and password in the
master configuration at \fB/etc/salt/master\fP or \fB/etc/salt/master.d/spacewalk.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
spacewalk:
  spacewalk01.domain.com:
    username: \(aqtestuser\(aq
    password: \(aqverybadpass\(aq
  spacewalk02.domain.com:
    username: \(aqtestuser\(aq
    password: \(aqverybadpass\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Optionally, \fBprotocol\fP can be specified if the spacewalk server is
not using the defaults. Default is \fBprotocol: https\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.spacewalk.addGroupsToKey(server, activation_key, groups)
Add server groups to a activation key
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run spacewalk.addGroupsToKey spacewalk01.domain.com 1\-my\-key \(aq[group1, group2]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.spacewalk.api(server, command, *args, **kwargs)
Call the Spacewalk xmlrpc api.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run spacewalk.api spacewalk01.domain.com systemgroup.create MyGroup Description
salt\-run spacewalk.api spacewalk01.domain.com systemgroup.create arguments=\(aq[\(dqMyGroup\(dq, \(dqDescription\(dq]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
State Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
create_group:
  salt.runner:
    \- name: spacewalk.api
    \- server: spacewalk01.domain.com
    \- command: systemgroup.create
    \- arguments:
      \- MyGroup
      \- Description
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.spacewalk.deleteAllActivationKeys(server)
Delete all activation keys from Spacewalk
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run spacewalk.deleteAllActivationKeys spacewalk01.domain.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.spacewalk.deleteAllGroups(server)
Delete all server groups from Spacewalk
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.spacewalk.deleteAllSystems(server)
Delete all systems from Spacewalk
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run spacewalk.deleteAllSystems spacewalk01.domain.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.spacewalk.unregister(name, server_url)
Unregister specified server from Spacewalk
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run spacewalk.unregister my\-test\-vm spacewalk01.domain.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.ssh
.sp
A Runner module interface on top of the salt\-ssh Python API.
.sp
This allows for programmatic use from salt\-api, the Reactor, Orchestrate, etc.
.INDENT 0.0
.TP
.B salt.runners.ssh.cmd(tgt, fun, arg=(), timeout=None, tgt_type=\(aqglob\(aq, kwarg=None)
New in version 2015.5.0.

.sp
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Execute a single command via the salt\-ssh subsystem and return all
routines at once
.sp
A wrapper around the \fI\%SSHClient.cmd\fP method.
.UNINDENT
.SS salt.runners.state
.sp
Execute orchestration functions
.INDENT 0.0
.TP
.B salt.runners.state.event(tagmatch=\(aq*\(aq, count=\-1, quiet=False, sock_dir=None, pretty=False, node=\(aqmaster\(aq)
Watch Salt\(aqs event bus and block until the given tag is matched
.sp
New in version 2014.7.0.

.sp
Changed in version 2019.2.0: \fBtagmatch\fP can now be either a glob or regular expression.

.sp
This is useful for utilizing Salt\(aqs event bus from shell scripts or for
taking simple actions directly from the CLI.
.sp
Enable debug logging to see ignored events.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtagmatch\fP \-\- the event is written to stdout for each tag that matches
this glob or regular expression.
.IP \(bu 2
\fBcount\fP \-\- this number is decremented for each event that matches the
\fBtagmatch\fP parameter; pass \fB\-1\fP to listen forever.
.IP \(bu 2
\fBquiet\fP \-\- do not print to stdout; just block
.IP \(bu 2
\fBsock_dir\fP \-\- path to the Salt master\(aqs event socket file.
.IP \(bu 2
\fBpretty\fP \-\- Output the JSON all on a single line if \fBFalse\fP (useful
for shell tools); pretty\-print the JSON output if \fBTrue\fP\&.
.IP \(bu 2
\fBnode\fP \-\- Watch the minion\-side or master\-side event bus.
\&.. versionadded:: 2016.3.0
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Reboot a minion and run highstate when it comes back online
salt \(aqjerry\(aq system.reboot && \e\e
    salt\-run state.event \(aqsalt/minion/jerry/start\(aq count=1 quiet=True && \e\e
    salt \(aqjerry\(aq state.highstate

# Reboot multiple minions and run highstate when all are back online
salt \-L \(aqkevin,stewart,dave\(aq system.reboot && \e\e
    salt\-run state.event \(aqsalt/minion/*/start\(aq count=3 quiet=True && \e\e
    salt \-L \(aqkevin,stewart,dave\(aq state.highstate

# Watch the event bus forever in a shell while\-loop.
salt\-run state.event | while read \-r tag data; do
    echo $tag
    echo $data | jq \-\-color\-output .
done
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
See \fI\%tests/eventlisten.sh\fP for an example of usage within a shell
script.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.state.orch(mods, saltenv=\(aqbase\(aq, test=None, exclude=None, pillar=None, pillarenv=None, pillar_enc=None, orchestration_jid=None)
This function is an alias of \fBorchestrate\fP\&.
.INDENT 7.0
.INDENT 3.5
New in version 0.17.0.

.sp
Execute a state run from the master, used as a powerful orchestration
system.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
More Orchestrate documentation
.INDENT 0.0
.IP \(bu 2
\fI\%Full Orchestrate Tutorial\fP
.IP \(bu 2
\fI\%Docs for the master\-side state module\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate webserver
salt\-run state.orchestrate webserver saltenv=dev test=True
salt\-run state.orchestrate webserver saltenv=dev pillarenv=aws
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.1.1: Runner renamed from \fBstate.sls\fP to \fBstate.orchestrate\fP

.sp
Changed in version 2014.7.0: Runner uses the pillar variable

.sp
Changed in version 2017.5.0: Runner uses the pillar_enc variable that allows renderers to render the pillar.
This is usable when supplying the contents of a file as pillar, and the file contains
gpg\-encrypted entries.

.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
GPG renderer documentation
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate webserver pillar_enc=gpg pillar=\(dq$(cat somefile.json)\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.state.orch_show_sls(mods, saltenv=\(aqbase\(aq, test=None, queue=False, pillar=None, pillarenv=None, pillar_enc=None)
This function is an alias of \fBorchestrate_show_sls\fP\&.
.INDENT 7.0
.INDENT 3.5
Display the state data from a specific sls, or list of sls files, after
being render using the master minion.
.sp
Note, the master minion adds a \(dq_master\(dq suffix to its minion id.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
The state.show_sls module function
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orch_show_sls my\-orch\-formula.my\-orch\-state \(aqpillar={ nodegroup: ng1 }\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.state.orchestrate(mods, saltenv=\(aqbase\(aq, test=None, exclude=None, pillar=None, pillarenv=None, pillar_enc=None, orchestration_jid=None)
New in version 0.17.0.

.sp
Execute a state run from the master, used as a powerful orchestration
system.
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
More Orchestrate documentation
.INDENT 0.0
.IP \(bu 2
\fI\%Full Orchestrate Tutorial\fP
.IP \(bu 2
\fI\%Docs for the master\-side state module\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate webserver
salt\-run state.orchestrate webserver saltenv=dev test=True
salt\-run state.orchestrate webserver saltenv=dev pillarenv=aws
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.1.1: Runner renamed from \fBstate.sls\fP to \fBstate.orchestrate\fP

.sp
Changed in version 2014.7.0: Runner uses the pillar variable

.sp
Changed in version 2017.5.0: Runner uses the pillar_enc variable that allows renderers to render the pillar.
This is usable when supplying the contents of a file as pillar, and the file contains
gpg\-encrypted entries.

.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
GPG renderer documentation
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate webserver pillar_enc=gpg pillar=\(dq$(cat somefile.json)\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.state.orchestrate_high(data, test=None, queue=False, pillar=None, **kwargs)
Execute a single state orchestration routine
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate_high \(aq{
    stage_one:
        {salt.state: [{tgt: \(dqdb*\(dq}, {sls: postgres_setup}]},
    stage_two:
        {salt.state: [{tgt: \(dqweb*\(dq}, {sls: apache_setup}, {
            require: [{salt: stage_one}],
        }]},
    }\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.state.orchestrate_show_sls(mods, saltenv=\(aqbase\(aq, test=None, queue=False, pillar=None, pillarenv=None, pillar_enc=None)
Display the state data from a specific sls, or list of sls files, after
being render using the master minion.
.sp
Note, the master minion adds a \(dq_master\(dq suffix to its minion id.
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
The state.show_sls module function
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orch_show_sls my\-orch\-formula.my\-orch\-state \(aqpillar={ nodegroup: ng1 }\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.state.orchestrate_single(fun, name, test=None, queue=False, pillar=None, **kwargs)
Execute a single state orchestration routine
.sp
New in version 2015.5.0.

.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate_single fun=salt.wheel name=key.list_all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.state.pause(jid, state_id=None, duration=None)
Set up a state id pause, this instructs a running state to pause at a given
state id. This needs to pass in the jid of the running state and can
optionally pass in a duration in seconds.
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.state.resume(jid, state_id=None)
Remove a pause from a jid, allowing it to continue
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.state.rm_pause(jid, state_id=None)
This function is an alias of \fBresume\fP\&.
.INDENT 7.0
.INDENT 3.5
Remove a pause from a jid, allowing it to continue
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.state.set_pause(jid, state_id=None, duration=None)
This function is an alias of \fBpause\fP\&.
.INDENT 7.0
.INDENT 3.5
Set up a state id pause, this instructs a running state to pause at a given
state id. This needs to pass in the jid of the running state and can
optionally pass in a duration in seconds.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.state.sls(mods, saltenv=\(aqbase\(aq, test=None, exclude=None, pillar=None, pillarenv=None, pillar_enc=None, orchestration_jid=None)
This function is an alias of \fBorchestrate\fP\&.
.INDENT 7.0
.INDENT 3.5
New in version 0.17.0.

.sp
Execute a state run from the master, used as a powerful orchestration
system.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
More Orchestrate documentation
.INDENT 0.0
.IP \(bu 2
\fI\%Full Orchestrate Tutorial\fP
.IP \(bu 2
\fI\%Docs for the master\-side state module\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate webserver
salt\-run state.orchestrate webserver saltenv=dev test=True
salt\-run state.orchestrate webserver saltenv=dev pillarenv=aws
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2014.1.1: Runner renamed from \fBstate.sls\fP to \fBstate.orchestrate\fP

.sp
Changed in version 2014.7.0: Runner uses the pillar variable

.sp
Changed in version 2017.5.0: Runner uses the pillar_enc variable that allows renderers to render the pillar.
This is usable when supplying the contents of a file as pillar, and the file contains
gpg\-encrypted entries.

.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
GPG renderer documentation
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run state.orchestrate webserver pillar_enc=gpg pillar=\(dq$(cat somefile.json)\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.state.soft_kill(jid, state_id=None)
Set up a state run to die before executing the given state id,
this instructs a running state to safely exit at a given
state id. This needs to pass in the jid of the running state.
If a state_id is not passed then the jid referenced will be safely exited
at the beginning of the next state run.
.UNINDENT
.SS salt.runners.survey
.sp
A general map/reduce style salt runner for aggregating results
returned by several different minions.
.sp
New in version 2014.7.0.

.sp
Aggregated results are sorted by the size of the minion pools which returned
matching results.
.sp
Useful for playing the game: \fI\(dqsome of these things are not like the others...\(dq\fP
when identifying discrepancies in a large infrastructure managed by salt.
.INDENT 0.0
.TP
.B salt.runners.survey.diff(*args, **kwargs)
Return the DIFFERENCE of the result sets returned by each matching minion
pool
.sp
New in version 2014.7.0.

.sp
These pools are determined from the aggregated and sorted results of
a salt command.
.sp
This command displays the \(dqdiffs\(dq as a series of 2\-way differences \-\-
namely the difference between the FIRST displayed minion pool
(according to sort order) and EACH SUBSEQUENT minion pool result set.
.sp
Differences are displayed according to the Python \fBdifflib.unified_diff()\fP
as in the case of the salt execution module \fBfile.get_diff\fP\&.
.sp
This command is submitted via a salt runner using the general form:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run survey.diff [survey_sort=up/down] <target>
             <salt\-execution\-module> <salt\-execution\-module parameters>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Optionally accept a \fBsurvey_sort=\fP parameter. Default:
\fBsurvey_sort=down\fP
.sp
CLI Example #1: (Example to display the \(dqdifferences of files\(dq)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run survey.diff survey_sort=up \(dq*\(dq cp.get_file_str file:///etc/hosts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.survey.hash(*args, **kwargs)
Return the MATCHING minion pools from the aggregated and sorted results of
a salt command
.sp
New in version 2014.7.0.

.sp
This command is submitted via a salt runner using the
general form:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run survey.hash [survey_sort=up/down] <target>
          <salt\-execution\-module> <salt\-execution\-module parameters>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Optionally accept a \fBsurvey_sort=\fP parameter. Default: \fBsurvey_sort=down\fP
.sp
CLI Example #1: (functionally equivalent to \fBsalt\-run manage.up\fP)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run survey.hash \(dq*\(dq test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example #2: (find an \(dqoutlier\(dq minion config file)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run survey.hash \(dq*\(dq file.get_hash /etc/salt/minion survey_sort=up
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.test
.sp
This runner is used only for test purposes and serves no production purpose
.INDENT 0.0
.TP
.B salt.runners.test.arg(*args, **kwargs)
Output the given args and kwargs
.sp
Kwargs will be filtered for \(aqprivate\(aq keynames.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run test.arg foo bar=baz
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.test.get_opts()
New in version 2018.3.0.

.sp
Return the configuration options of the master.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run test.get_opts
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.test.metasyntactic(locality=\(aqus\(aq)
Return common metasyntactic variables for the given locality
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run test.metasyntactic locality=uk
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.test.raw_arg(*args, **kwargs)
Output the given args and kwargs
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run test.arg foo __bar=baz
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.test.sleep(s_time=10)
Sleep t seconds, then return True
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run test.sleep s_time=5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.test.stdout_print()
Print \(aqfoo\(aq and return \(aqbar\(aq
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run test.stdout_print
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.test.stream()
Fire a stream of 100 test events, then return True
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run test.stream
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.thin
.sp
The thin runner is used to manage the salt thin systems.
.sp
Salt Thin is a transport\-less version of Salt that can be used to run routines
in a standalone way. This runner has tools which generate the standalone salt
system for easy consumption.
.INDENT 0.0
.TP
.B salt.runners.thin.generate(extra_mods=\(aq\(aq, overwrite=False, so_mods=\(aq\(aq, absonly=True, compress=\(aqgzip\(aq)
Generate the salt\-thin tarball and print the location of the tarball
Optional additional mods to include (e.g. mako) can be supplied as a comma
delimited string.  Permits forcing an overwrite of the output file as well.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run thin.generate
salt\-run thin.generate mako
salt\-run thin.generate mako,wempy 1
salt\-run thin.generate overwrite=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.thin.generate_min(extra_mods=\(aq\(aq, overwrite=False, so_mods=\(aq\(aq)
Generate the salt\-thin tarball and print the location of the tarball
Optional additional mods to include (e.g. mako) can be supplied as a comma
delimited string.  Permits forcing an overwrite of the output file as well.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run thin.generate_min
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.vault
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%vault Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Runner functions supporting the Vault modules. Configuration instructions are
documented in the \fI\%execution module docs\fP\&.
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
new
.TP
.B platform
all
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.runners.vault.LazyPillar(opts, grains, minion_id, extra_minion_data=None)
Simulates a pillar dictionary. Only compiles the pillar
once an item is requested.
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vault.cleanup_auth()
New in version 3007.0.

.sp
Removes AppRoles and entities associated with unknown minion IDs.
Can only clean up entities if the AppRole still exists.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Make absolutely sure that the configured minion approle issue mount is
exclusively dedicated to the Salt master, otherwise you might lose data
by using this function! (config: \fBvault:issue:approle:mount\fP)
.sp
This detects unknown existing AppRoles by listing all roles on the
configured minion AppRole mount and deducting known minions from the
returned list.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vault.cleanup_auth
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vault.clear_cache(master=True, minions=True)
New in version 3007.0.

.sp
Clears master cache of Vault\-specific data. This can include:
\- AppRole metadata
\- rendered policies
\- cached authentication credentials for impersonated minions
\- cached KV metadata for impersonated minions
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vault.clear_cache
salt\-run vault.clear_cache minions=false
salt\-run vault.clear_cache master=false minions=\(aq[minion1, minion2]\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B master
Clear cached data for the master context.
Includes cached master authentication data and KV metadata.
Defaults to true.
.TP
.B minions
Clear cached data for minions on the master.
Can include cached authentication credentials and KV metadata
for pillar compilation as well as AppRole metadata and
rendered policies for credential issuance.
Defaults to true. Set this to a list of minion IDs to only clear
cached data pertaining to thse minions.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vault.generate_new_token(minion_id, signature, impersonated_by_master=False, issue_params=None)
New in version 3007.0.

.sp
Generate a Vault token for minion <minion_id>.
.INDENT 7.0
.TP
.B minion_id
The ID of the minion that requests a token.
.TP
.B signature
Cryptographic signature which validates that the request is indeed sent
by the minion (or the master, see impersonated_by_master).
.TP
.B impersonated_by_master
If the master needs to create a token on behalf of the minion, this is
True. This happens when the master generates minion pillars.
.TP
.B issue_params
Dictionary of parameters for the generated tokens.
See master configuration \fBvault:issue:token:params\fP for possible values.
Requires \fBvault:issue:allow_minion_override_params\fP master configuration
setting to be effective.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vault.generate_secret_id(minion_id, signature, impersonated_by_master=False, issue_params=None)
New in version 3007.0.

.sp
Generate a Vault secret ID for minion <minion_id>. Requires the master to be configured
to generate AppRoles for minions (configuration: \fBvault:issue:type\fP).
.INDENT 7.0
.TP
.B minion_id
The ID of the minion that requests a secret ID.
.TP
.B signature
Cryptographic signature which validates that the request is indeed sent
by the minion (or the master, see impersonated_by_master).
.TP
.B impersonated_by_master
If the master needs to create a token on behalf of the minion, this is
True. This happens when the master generates minion pillars.
.TP
.B issue_params
Dictionary of configuration values for the generated AppRole.
See master configuration vault:issue:approle:params for possible values.
Requires \fBvault:issue:allow_minion_override_params\fP master configuration
setting to be effective.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vault.generate_token(minion_id, signature, impersonated_by_master=False, ttl=None, uses=None, upgrade_request=False)
Deprecated since version 3007.0.

.sp
Generate a Vault token for minion <minion_id>.
.INDENT 7.0
.TP
.B minion_id
The ID of the minion that requests a token.
.TP
.B signature
Cryptographic signature which validates that the request is indeed sent
by the minion (or the master, see impersonated_by_master).
.TP
.B impersonated_by_master
If the master needs to create a token on behalf of the minion, this is
True. This happens when the master generates minion pillars.
.TP
.B ttl
Ticket time to live in seconds, 1m minutes, or 2h hrs
.TP
.B uses
Number of times a token can be used
.TP
.B upgrade_request
In case the new runner endpoints have not been whitelisted for peer running,
this endpoint serves as a gateway to \fBvault.get_config\fP\&.
Defaults to False.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vault.get_config(minion_id, signature, impersonated_by_master=False, issue_params=None, config_only=False)
New in version 3007.0.

.sp
Return Vault configuration for minion <minion_id>.
.INDENT 7.0
.TP
.B minion_id
The ID of the minion that requests the configuration.
.TP
.B signature
Cryptographic signature which validates that the request is indeed sent
by the minion (or the master, see impersonated_by_master).
.TP
.B impersonated_by_master
If the master needs to contact the Vault server on behalf of the minion, this is
True. This happens when the master generates minion pillars.
.TP
.B issue_params
Parameters for credential issuance.
Requires \fBvault:issue:allow_minion_override_params\fP master configuration
setting to be effective.
.TP
.B config_only
In case the master is configured to issue tokens, do not include a new
token in the response. This is used for configuration update checks.
Defaults to false.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vault.get_role_id(minion_id, signature, impersonated_by_master=False, issue_params=None)
New in version 3007.0.

.sp
Return the Vault role\-id for minion <minion_id>. Requires the master to be configured
to generate AppRoles for minions (configuration: \fBvault:issue:type\fP).
.INDENT 7.0
.TP
.B minion_id
The ID of the minion that requests a role\-id.
.TP
.B signature
Cryptographic signature which validates that the request is indeed sent
by the minion (or the master, see impersonated_by_master).
.TP
.B impersonated_by_master
If the master needs to create a token on behalf of the minion, this is
True. This happens when the master generates minion pillars.
.TP
.B issue_params
Dictionary of configuration values for the generated AppRole.
See master configuration vault:issue:approle:params for possible values.
Requires \fBvault:issue:allow_minion_override_params\fP master configuration
setting to be effective.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vault.list_approles()
New in version 3007.0.

.sp
List all AppRoles that have been created by the Salt master.
They are named after the minions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vault.list_approles
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required policy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
path \(dqauth/<mount>/role\(dq {
    capabilities = [\(dqlist\(dq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vault.list_entities()
New in version 3007.0.

.sp
List all entities that have been created by the Salt master.
They are named \fIsalt_minion_{minion_id}\fP\&.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vault.list_entities
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Required policy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
path \(dqidentity/entity/name\(dq {
    capabilities = [\(dqlist\(dq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vault.show_approle(minion_id)
New in version 3007.0.

.sp
Show AppRole configuration for <minion_id>.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vault.show_approle db1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vault.show_entity(minion_id)
New in version 3007.0.

.sp
Show entity metadata for <minion_id>.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vault.show_entity db1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vault.show_policies(minion_id, refresh_pillar=<Constant.NOT_SET>, expire=None)
Show the Vault policies that are applied to tokens for the given minion.
.INDENT 7.0
.TP
.B minion_id
The ID of the minion to show policies for.
.TP
.B refresh_pillar
Whether to refresh the pillar data when rendering templated policies.
None will only refresh when the cached data is unavailable, boolean values
force one behavior always.
Defaults to config value \fBvault:policies:refresh_pillar\fP or None.
.TP
.B expire
Policy computation can be heavy in case pillar data is used in templated policies and
it has not been cached. Therefore, a short\-lived cache specifically for rendered policies
is used. This specifies the expiration timeout in seconds.
Defaults to config value \fBvault:policies:cache_time\fP or 60.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When issuing AppRoles to minions, the shown policies are read from Vault
configuration for the minion\(aqs AppRole and thus refresh_pillar/expire
will not be honored.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vault.show_policies myminion
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vault.sync_approles(minions=None, up=False, down=False)
New in version 3007.0.

.sp
Sync minion AppRole parameters with current settings, including associated
token policies.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Only updates existing AppRoles. They are issued during the first request
for one by the minion.
Running this will reset minion overrides, which are reapplied automatically
during the next request for authentication details.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Unlike when issuing tokens, AppRole\-associated policies are not regularly
refreshed automatically. It is advised to schedule regular runs of this function.
.UNINDENT
.UNINDENT
.sp
If no parameter is specified, will try to sync AppRoles for all known minions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vault.sync_approles
salt\-run vault.sync_approles ecorp
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B minions
(List of) ID(s) of the minion(s) to update the AppRole for.
Defaults to None.
.TP
.B up
Find all minions that are up and update their AppRoles.
Defaults to False.
.TP
.B down
Find all minions that are down and update their AppRoles.
Defaults to False.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vault.sync_entities(minions=None, up=False, down=False)
New in version 3007.0.

.sp
Sync minion entities with current settings. Only updates entities for minions
with existing AppRoles.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This updates associated metadata only. Entities are created only
when issuing AppRoles to minions (\fBvault:issue:type\fP == \fBapprole\fP).
.UNINDENT
.UNINDENT
.sp
If no parameter is specified, will try to sync entities for all known minions.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vault.sync_entities
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B minions
(List of) ID(s) of the minion(s) to update the entity for.
Defaults to None.
.TP
.B up
Find all minions that are up and update their associated entities.
Defaults to False.
.TP
.B down
Find all minions that are down and update their associated entities.
Defaults to False.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vault.unseal()
Unseal Vault server
.sp
This function uses the \(aqkeys\(aq from the \(aqvault\(aq configuration to unseal vault server
.INDENT 7.0
.TP
.B vault:
.INDENT 7.0
.TP
.B keys:
.INDENT 7.0
.IP \(bu 2
n63/TbrQuL3xaIW7ZZpuXj/tIfnK1/MbVxO4vT3wYD2A
.IP \(bu 2
S9OwCvMRhErEA4NVVELYBs6w/Me6+urgUr24xGK44Uy3
.IP \(bu 2
F1j4b7JKq850NS6Kboiy5laJ0xY8dWJvB3fcwA+SraYl
.IP \(bu 2
1cYtvjKJNDVam9c7HNqJUfINk4PYyAXIpjkpN/sIuzPv
.IP \(bu 2
3pPK5X6vGtwLhNOFv1U2elahECz3HpRUfNXJFYLw6lid
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vault.unseal
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.venafiapi
.sp
Support for Venafi
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
vcert Python module
.UNINDENT
.TP
.B configuration
In order to connect to Venafi services you need to specify it in
Salt master configuration.
Example for Venafi Cloud (using env variables):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B venafi:
api_key: \(dqsdb://osenv/CLOUDAPIKEY\(dq
.UNINDENT
.sp
Example for Venafi Platform (using env variables):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B venafi:
base_url: \(dq\fI\%https://tpp.example.com/\fP\(dq
tpp_user: admin
tpp_password: \(dqsdb://osenv/TPP_PASSWORD\(dq
trust_bundle: \(dq/opt/venafi/bundle.pem\(dq
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.venafiapi.del_cached_domain(domains)
Delete cached domains from the master
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run venafi.del_cached_domain domain1.example.com,domain2.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.venafiapi.list_domain_cache()
List domains that have been cached
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run venafi.list_domain_cache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.venafiapi.renew(minion_id, dns_name=None, zone=None, country=None, state=None, loc=None, org=None, org_unit=None, key_password=None, csr_path=None, pkey_path=None)
Request a new certificate
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run venafi.request <minion_id> <dns_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.venafiapi.request(minion_id, dns_name=None, zone=None, country=None, state=None, loc=None, org=None, org_unit=None, key_password=None, csr_path=None, pkey_path=None)
Request a new certificate
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run venafi.request <minion_id> <dns_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.venafiapi.show_cert(dns_name)
Show issued certificate for domain
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run venafi.show_cert example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.virt
.sp
Control virtual machines via Salt
.INDENT 0.0
.TP
.B salt.runners.virt.force_off(name)
Force power down the named virtual machine
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.virt.host_info(host=None)
Return information about the host connected to this master
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.virt.init(name, cpu, mem, image, hypervisor=\(aqkvm\(aq, host=None, seed=True, nic=\(aqdefault\(aq, install=True, start=True, disk=\(aqdefault\(aq, saltenv=\(aqbase\(aq, enable_vnc=False, seed_cmd=\(aqseed.apply\(aq, enable_qcow=False, serial_type=\(aqNone\(aq)
This routine is used to create a new virtual machine. This routines takes
a number of options to determine what the newly created virtual machine
will look like.
.INDENT 7.0
.TP
.B name
The mandatory name of the new virtual machine. The name option is
also the minion id, all minions must have an id.
.TP
.B cpu
The number of cpus to allocate to this new virtual machine.
.TP
.B mem
The amount of memory to allocate to this virtual machine. The number
is interpreted in megabytes.
.TP
.B image
The network location of the virtual machine image, commonly a location
on the salt fileserver, but http, https and ftp can also be used.
.TP
.B hypervisor
The hypervisor to use for the new virtual machine. Default is \fIkvm\fP\&.
.TP
.B host
The host to use for the new virtual machine, if this is omitted
Salt will automatically detect what host to use.
.TP
.B seed
Set to \fIFalse\fP to prevent Salt from seeding the new virtual machine.
.TP
.B nic
The nic profile to use, defaults to the \(dqdefault\(dq nic profile which
assumes a single network interface per VM associated with the \(dqbr0\(dq
bridge on the master.
.TP
.B install
Set to False to prevent Salt from installing a minion on the new VM
before it spins up.
.TP
.B disk
The disk profile to use
.TP
.B saltenv
The Salt environment to use
.TP
.B enable_vnc
Whether a VNC screen is attached to resulting VM. Default is \fIFalse\fP\&.
.TP
.B seed_cmd
If seed is \fITrue\fP, use this execution module function to seed new VM.
Default is \fIseed.apply\fP\&.
.TP
.B enable_qcow
Clone disk image as a copy\-on\-write qcow2 image, using downloaded
\fIimage\fP as backing file.
.TP
.B serial_type
Enable serial console. Set to \(aqpty\(aq for serial console or \(aqtcp\(aq for
telnet.
Default is \(aqNone\(aq
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.virt.list(host=None, quiet=False, hyper=None)
List the virtual machines on each host, this is a simplified query,
showing only the virtual machine names belonging to each host.
A single host can be passed in to specify an individual host
to list.
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.virt.migrate(name, target=\(aq\(aq)
Migrate a VM from one host to another. This routine will just start
the migration and display information on how to look up the progress.
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.virt.next_host()
Return the host to use for the next autodeployed VM. This queries
the available host and executes some math the determine the most
\(dqavailable\(dq next host.
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.virt.pause(name)
Pause the named VM
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.virt.purge(name, delete_key=True)
Destroy the named VM
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.virt.query(host=None, quiet=False)
Query the virtual machines. When called without options all hosts
are detected and a full query is returned. A single host can be
passed in to specify an individual host to query.
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.virt.reset(name)
Force power down and restart an existing VM
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.virt.resume(name)
Resume a paused VM
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.virt.start(name)
Start a named virtual machine
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.virt.vm_info(name, quiet=False)
Return the information on the named VM
.UNINDENT
.SS salt.runners.vistara
.sp
Vistara Runner
.sp
Runner to interact with the Vistara (\fI\%http://www.vistarait.com/\fP) REST API
.INDENT 0.0
.TP
.B codeauthor
Brad Thurber <\fI\%brad.thurber@gmail.com\fP>
.UNINDENT
.sp
To use this runner, the Vistara client_id and Vistara oauth2 client_key
and client_secret must be set in the master config.
.sp
For example \fB/etc/salt/master.d/_vistara.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vistara:
  client_id: client_012345
  client_key: N0tReallyaR3alKeyButShouldB12345
  client_secret: ThisI5AreallyLongsecretKeyIwonderwhyTheyMakethemSoBigTheseDays00
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.vistara.delete_device(name, safety_on=True)
Deletes a device from Vistara based on DNS name or partial name. By default,
delete_device will only perform the delete if a single host is returned. Set
safety_on=False to delete all matches (up to default API search page size)
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run vistara.delete_device \(aqhostname\-101.mycompany.com\(aq
salt\-run vistara.delete_device \(aqhostname\-101\(aq
salt\-run vistara.delete_device \(aqhostname\-1\(aq safety_on=False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.runners.winrepo
.sp
Runner to manage Windows software repo
.INDENT 0.0
.TP
.B salt.runners.winrepo.genrepo(opts=None, fire_event=True)
Generate winrepo_cachefile based on sls files in the winrepo_dir
.INDENT 7.0
.TP
.B opts
Specify an alternate opts dict. Should not be used unless this function
is imported into an execution module.
.TP
.B fire_event
True
Fire an event on failure. Only supported on the master.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run winrepo.genrepo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.winrepo.update_git_repos(opts=None, clean=False, masterless=False)
Checkout git repos containing Windows Software Package Definitions
.INDENT 7.0
.TP
.B opts
Specify an alternate opts dict. Should not be used unless this function
is imported into an execution module.
.TP
.B clean
False
Clean repo cachedirs which are not configured under
\fI\%winrepo_remotes\fP\&.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This argument should not be set to \fBTrue\fP if a mix of git and
non\-git repo definitions are being used, as it will result in the
non\-git repo definitions being removed.
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run winrepo.update_git_repos
salt\-run winrepo.update_git_repos clean=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS sdb modules
.TS
center;
|l|l|.
_
T{
\fI\%cache\fP
T}	T{
cache Module
T}
_
T{
\fI\%confidant\fP
T}	T{
An SDB module for getting credentials from confidant.
T}
_
T{
\fI\%consul\fP
T}	T{
Consul sdb Module
T}
_
T{
\fI\%couchdb\fP
T}	T{
CouchDB sdb Module
T}
_
T{
\fI\%env\fP
T}	T{
Environment sdb Module
T}
_
T{
\fI\%etcd_db\fP
T}	T{
etcd Database Module
T}
_
T{
\fI\%keyring_db\fP
T}	T{
Keyring Database Module
T}
_
T{
\fI\%memcached\fP
T}	T{
Memcached sdb Module
T}
_
T{
\fI\%redis_sdb\fP
T}	T{
Redis SDB module
T}
_
T{
\fI\%rest\fP
T}	T{
Generic REST API SDB Module
T}
_
T{
\fI\%sqlite3\fP
T}	T{
SQLite sdb Module
T}
_
T{
\fI\%tism\fP
T}	T{
tISM \- the Immutable Secrets Manager SDB Module
T}
_
T{
\fI\%vault\fP
T}	T{
Vault SDB Module
T}
_
T{
\fI\%yaml\fP
T}	T{
Pull sdb values from a YAML file
T}
_
.TE
.SS salt.sdb.cache
.sp
cache Module
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
New
.TP
.B platform
all
.UNINDENT
.sp
New in version 2017.7.0.

.sp
This module provides access to Salt\(aqs cache subsystem.
.sp
Like all sdb modules, the cache module requires a configuration profile to
be configured in either the minion or master configuration file. This profile
requires very little. In the example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mastercloudcache:
  driver: cache
  bank: cloud/active/ec2/my\-ec2\-conf/saltmaster
  cachedir: /var/cache/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBdriver\fP refers to the cache module, \fBbank\fP refers to the cache bank
that contains the data and \fBcachedir\fP (optional), if used, points to an
alternate directory for cache data storage.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_ip: sdb://mastercloudcache/public_ips
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is also possible to override both the \fBbank\fP and \fBcachedir\fP options
inside the SDB URI:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_ip: sdb://mastercloudcache/public_ips?cachedir=/var/cache/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For this reason, both the \fBbank\fP and the \fBcachedir\fP options can be
omitted from the SDB profile. However, if the \fBbank\fP option is omitted,
it must be specified in the URI:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_ip: sdb://mastercloudcache/public_ips?bank=cloud/active/ec2/my\-ec2\-conf/saltmaster
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.cache.delete(key, service=None, profile=None)
Get a value from the cache service
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.cache.get(key, service=None, profile=None)
Get a value from the cache service
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.cache.set_(key, value, service=None, profile=None)
Set a key/value pair in the cache service
.UNINDENT
.SS salt.sdb.confidant
.sp
An SDB module for getting credentials from confidant.
.SS Configuring the Confidant module
.sp
The module can be configured via sdb in the minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
confidant:
  driver: confidant
  # The URL of the confidant web service
  url: \(aqhttps://confidant\-production.example.com\(aq
  # The context to use for KMS authentication
  auth_context:
    from: example\-production\-iad
    to: confidant\-production\-iad
    user_type: service
  # The KMS master key to use for authentication
  auth_key: \(dqalias/authnz\(dq
  # Cache file for KMS auth token
  token_cache_file: /run/confidant/confidant_token
  # The duration of the validity of a token, in minutes
  token_duration: 60
  # key, keyid and region can be defined in the profile, but it\(aqs generally
  # best to use IAM roles or environment variables for AWS auth.
  keyid: 98nh9h9h908h09kjjk
  key: jhf908gyeghehe0he0g8h9u0j0n0n09hj09h0
  region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
confidant\-common, confidant\-client
.UNINDENT
.SS Module Documentation
.INDENT 0.0
.TP
.B salt.sdb.confidant.get(key, profile=None)
Read pillar data from Confidant via its API.
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion sdb.get \(aqsdb://confidant/credentials\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Valid keys are: credentials, credentials_metadata, result. credentials
returns a dict of joined credential_pairs, credentials_metadata returns a
dict of metadata relevant to the credentials mapped to the confidant
service, and result returns a bool that can be used to determine if the sdb
call succeeded or failed to fetch credentials from confidant (or from local
cache). If result is false, the data in credentials or credentials_metadata
can\(aqt be trusted.
.UNINDENT
.SS salt.sdb.consul
.sp
Consul sdb Module
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
New
.TP
.B platform
all
.UNINDENT
.sp
This module allows access to Consul using an \fBsdb://\fP URI
.sp
Like all sdb modules, the Consul module requires a configuration profile to
be configured in either the minion or master configuration file. This profile
requires very little. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myconsul:
  driver: consul
  host: 127.0.0.1
  port: 8500
  token: b6376760\-a8bb\-edd5\-fcda\-33bc13bfc556
  scheme: http
  consistency: default
  dc: dev
  verify: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBdriver\fP refers to the Consul module, all other options are optional.
For option details see: \fI\%https://python\-consul.readthedocs.io/en/latest/#consul\fP
.INDENT 0.0
.TP
.B salt.sdb.consul.get(key, profile=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.consul.get_conn(profile)
Return a client object for accessing consul
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.consul.set_(key, value, profile=None)
.UNINDENT
.SS salt.sdb.couchdb
.sp
CouchDB sdb Module
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
New
.TP
.B depends
python2\-couchdb
.TP
.B platform
all
.UNINDENT
.sp
This allow interaction between Salt and a CouchDB [couchdb.apache.org]
database. It uses salt\(aqs \fIsdb\fP system to allow for inserts and retrevals
using the \fIsdb://\fP prefix in salt configuration files.
.sp
To use the couchbase sdb module, it must first be configured in the salt
master or minion config. The following arguments are required:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
couchdb_sdb:
  driver: couchdb
  host: localhost
  port: 5984
  database: salt_sdb
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
One could then query the CouchDB instance via an \fIsdb://\fP URI such as the
following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
password: sdb://couchdb_sdb/mykey
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use this interface, you must track IDs on your own or have another source
to do the map\-reduce logic necessary to calculate the ID you wish to fetch.
.sp
Additional contributions to build true map\-reduce functionality into this module
would be welcome.
.INDENT 0.0
.TP
.B salt.sdb.couchdb.get(key, profile=None)
Get a value from couchdb by id
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.couchdb.set_(key, value, profile=None)
Set a key/value pair in couchdb
.UNINDENT
.SS salt.sdb.env
.sp
Environment sdb Module
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
New
.TP
.B depends
None
.TP
.B platform
all
.UNINDENT
.sp
This module allows access to environment variables using an \fBsdb://\fP URI.
.sp
Example configuration for this module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
osenv:
  driver: env
.ft P
.fi
.UNINDENT
.UNINDENT
.SS WARNING:
.sp
OS environment variables will be available
to read via SDB.
Please make sure you don\(aqt have any sensitive data
in your environment variables!!
.sp
Example usage of sdb env module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set some env var:
  cmd.run:
    \- name: echo {{ salt[\(aqsdb.set\(aq](\(aqsdb://osenv/foo\(aq, \(aqbar\(aq) }}
    \- order: 1

{% if salt[\(aqsdb.get\(aq](\(aqsdb://osenv/foo\(aq) == \(aqbar\(aq %}
always\-changes\-and\-succeeds:
  test.succeed_with_changes:
    \- name: foo
{% else %}
always\-changes\-and\-fails:
  test.fail_with_changes:
    \- name: foo
{% endif  %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above example will return success.
.sp
The \fBenv\fP sdb module can also be used with salt cloud.
Assuming you have exported the environment variable named
\fBcompute\fP (and have \fBosenv\fP defined).
The example below will look for the salt cloud config key \fBcompute_name\fP
in the environment:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-openstack\-config:
  compute_name: sdb://osenv/compute
  ..snip
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.env.get(key, profile=None)
Get a value
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.env.set_(key, value, profile=None)
Set a key/value pair
.UNINDENT
.SS salt.sdb.etcd_db
.sp
etcd Database Module
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
New
.TP
.B depends
python\-etcd or etcd3\-py
.TP
.B platform
all
.UNINDENT
.sp
New in version 2015.5.0.

.sp
This module allows access to the etcd database using an \fBsdb://\fP URI. This
package is located at \fBhttps://pypi.python.org/pypi/python\-etcd\fP\&.
.sp
Like all sdb modules, the etcd module requires a configuration profile to
be configured in either the minion or master configuration file. This profile
requires very little. In the example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myetcd:
  driver: etcd
  etcd.host: 127.0.0.1
  etcd.port: 2379
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBdriver\fP refers to the etcd module, \fBetcd.host\fP refers to the host that
is hosting the etcd database and \fBetcd.port\fP refers to the port on that host.
.sp
In order to choose whether to use etcd API v2 or v3, you can put the following
configuration option in the same place as your etcd configuration.  This option
defaults to true, meaning you will use v2 unless you specify otherwise.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.require_v2: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
password: sdb://myetcd/mypassword
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.etcd_db.delete(key, service=None, profile=None)
Get a value from the etcd service
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.etcd_db.get(key, service=None, profile=None)
Get a value from the etcd service
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.etcd_db.set_(key, value, service=None, profile=None)
Set a key/value pair in the etcd service
.UNINDENT
.SS salt.sdb.keyring_db
.sp
Keyring Database Module
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
New
.TP
.B depends
keyring
.TP
.B platform
all
.UNINDENT
.sp
This module allows access to the keyring package using an \fBsdb://\fP URI. This
package is located at \fBhttps://pypi.python.org/pypi/keyring\fP\&.
.sp
Care must be taken when using keyring. Not all keyend backends are supported on
all operating systems. Also, many backends require an agent to be running in
order to work. For instance, the \(dqSecret Service\(dq backend requires a compatible
agent such as \fBgnome\-keyring\-daemon\fP or \fBkwallet\fP to be running. The
keyczar backend does not seem to enjoy the benefits of an agent, and so using
it will require either that the password is typed in manually (which is
unreasonable for the salt\-minion and salt\-master daemons, especially in
production) or an agent is written for it.
.sp
Like all sdb modules, the keyring module requires a configuration profile to
be configured in either the minion or master configuration file. This profile
requires very little. In the example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mykeyring:
  driver: keyring
  service: system
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBdriver\fP refers to the keyring module, \fBservice\fP refers to the service
that will be used inside of keyring (which may be likened unto a database
table) and \fBmykeyring\fP refers to the name that will appear in the URI:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
password: sdb://mykeyring/mypassword
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The underlying backend configuration must be configured via keyring itself. For
examples and documentation, see keyring:
.sp
\fI\%https://pypi.python.org/pypi/keyring\fP
.sp
New in version 2014.1.4.

.INDENT 0.0
.TP
.B salt.sdb.keyring_db.get(key, service=None, profile=None)
Get a value from a keyring service
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.keyring_db.set_(key, value, service=None, profile=None)
Set a key/value pair in a keyring service
.UNINDENT
.SS salt.sdb.memcached
.sp
Memcached sdb Module
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
New
.TP
.B depends
python\-memcached
.TP
.B platform
all
.UNINDENT
.sp
This module allows access to memcached using an \fBsdb://\fP URI. This
package is located at \fBhttps://pypi.python.org/pypi/python\-memcached\fP\&.
.sp
Like all sdb modules, the memcached module requires a configuration profile to
be configured in either the minion or master configuration file. This profile
requires very little. In the example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mymemcache:
  driver: memcached
  memcached.host: localhost
  memcached.port: 11211
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBdriver\fP refers to the memcached module, \fBhost\fP and \fBport\fP the
memcached server to connect to (defaults to \fBlocalhost\fP and \fB11211\fP,
and \fBmymemcached\fP refers to the name that will appear in the URI:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
password: sdb://mymemcached/mykey
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.memcached.get(key, profile=None)
Get a value from memcached
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.memcached.set_(key, value, profile=None)
Set a key/value pair in memcached
.UNINDENT
.SS salt.sdb.redis_sdb
.SS Redis SDB module
.INDENT 0.0
.INDENT 3.5
New in version 2019.2.0.

.UNINDENT
.UNINDENT
.sp
This module allows access to Redis  using an \fBsdb://\fP URI.
.sp
Like all SDB modules, the Redis module requires a configuration profile to
be configured in either the minion or master configuration file. This profile
requires very little. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sdb_redis:
  driver: redis
  host: 127.0.0.1
  port: 6379
  password: pass
  db: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBdriver\fP refers to the Redis module, all other options are optional.
For option details see: \fI\%https://redis\-py.readthedocs.io/en/latest/\fP\&.
.INDENT 0.0
.TP
.B salt.sdb.redis_sdb.delete(key, profile=None)
Delete a key from the Redis SDB.
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.redis_sdb.get(key, profile=None)
Get a value from the Redis SDB.
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.redis_sdb.set_(key, value, profile=None)
Set a value into the Redis SDB.
.UNINDENT
.SS salt.sdb.rest
.sp
Generic REST API SDB Module
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
New
.TP
.B platform
all
.UNINDENT
.sp
New in version 2015.8.0.

.sp
This module allows access to a REST interface using an \fBsdb://\fP URI.
.sp
Like all REST modules, the REST module requires a configuration profile to
be configured in either the minion or master configuration file. This profile
requires very little. In the example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-rest\-api:
  driver: rest
  urls:
    url: https://api.github.com/
  keys:
    url: https://api.github.com/users/{{user}}/keys
    backend: requests
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBdriver\fP refers to the REST module, and must be set to \fBrest\fP in order
to use this driver. Each of the other items inside this block refers to a
separate set of HTTP items, including a URL and any options associated with it.
The options used here should match the options available in
\fBsalt.utils.http.query()\fP\&.
.sp
In order to call the \fBurls\fP item in the example, the following reference can
be made inside a configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
github_urls: sdb://my\-rest\-api/urls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Key/Value pairs may also be used with this driver, and merged into the URL using
the configured renderer (\fBjinja\fP, by default). For instance, in order to use
the \fBkeys\fP item in the example, the following reference can be made:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
github_urls: sdb://my\-rest\-api/keys?user=myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will cause the following URL to actually be called:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
https://api.github.com/users/myuser/keys
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Key/Value pairs will NOT be passed through as GET data. If GET data needs to be
sent to the URL, then it should be configured in the SDB configuration block.
For instance:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
another\-rest\-api:
  driver: rest
  user_data:
    url: https://api.example.com/users/
    params:
      user: myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.rest.get(key, service=None, profile=None)
Get a value from the REST interface
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.rest.query(key, value=None, service=None, profile=None)
Get a value from the REST interface
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.rest.set_(key, value, service=None, profile=None)
Set a key/value pair in the REST interface
.UNINDENT
.SS salt.sdb.sqlite3
.sp
SQLite sdb Module
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
New
.TP
.B platform
all
.UNINDENT
.sp
This module allows access to sqlite3 using an \fBsdb://\fP URI
.sp
Like all sdb modules, the sqlite3 module requires a configuration profile to
be configured in either the minion or master configuration file. This profile
requires very little. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysqlite:
  driver: sqlite3
  database: /tmp/sdb.sqlite
  table: sdb
  create_table: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBdriver\fP refers to the sqlite3 module, \fBdatabase\fP refers to the sqlite3
database file. \fBtable\fP is the table within the db that will hold keys and
values (defaults to \fBsdb\fP). The database and table will be created if they
do not exist.
.SS Advanced Usage:
.sp
Instead of a table name, it is possible to provide custom SQL statements to
create the table(s) and get and set values.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myadvanced
  driver: sqlite3
  database: /tmp/sdb\-advanced.sqlite
create_statements:
  \- \(dqCREATE TABLE advanced (a text, b text, c blob, d blob)\(dq
  \- \(dqCREATE INDEX myidx ON advanced (a)\(dq
get_query: \(dqSELECT d FROM advanced WHERE a=:key\(dq
set_query: \(dqINSERT OR REPLACE INTO advanced (a, d) VALUES (:key, :value)\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.sqlite3.get(key, profile=None)
Get a value from sqlite3
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.sqlite3.set_(key, value, profile=None)
Set a key/value pair in sqlite3
.UNINDENT
.SS salt.sdb.tism
.sp
tISM \- the Immutable Secrets Manager SDB Module
.INDENT 0.0
.TP
.B maintainer
tISM
.TP
.B maturity
New
.TP
.B platform
all
.UNINDENT
.sp
New in version 2017.7.0.

.sp
This module will decrypt PGP encrypted secrets against a tISM server.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sdb://<profile>/<encrypted secret>

sdb://tism/hQEMAzJ+GfdAB3KqAQf9E3cyvrPEWR1sf1tMvH0nrJ0bZa9kDFLPxvtwAOqlRiNp0F7IpiiVRF+h+sW5Mb4ffB1TElMzQ+/G5ptd6CjmgBfBsuGeajWmvLEi4lC6/9v1rYGjjLeOCCcN4Dl5AHlxUUaSrxB8akTDvSAnPvGhtRTZqDlltl5UEHsyYXM8RaeCrBw5Or1yvC9Ctx2saVp3xmALQvyhzkUv5pTb1mH0I9Z7E0ian07ZUOD+pVacDAf1oQcPpqkeNVTQQ15EP0fDuvnW+a0vxeLhkbFLfnwqhqEsvFxVFLHVLcs2ffE5cceeOMtVo7DS9fCtkdZr5hR7a+86n4hdKfwDMFXiBwSIPMkmY980N/H30L/r50+CBkuI/u4M2pXDcMYsvvt4ajCbJn91qaQ7BDI=
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A profile must be setup in the minion configuration or pillar. If you want to
use sdb in a runner or pillar you must also place a profile in the master
configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tism:
  driver: tism
  url: https://my.tismd:8080/decrypt
  token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhZG1pbiI6MSwiZXhwIjoxNTg1MTExNDYwLCJqdGkiOiI3NnA5cWNiMWdtdmw4Iiwia2V5cyI6WyJBTEwiXX0.RtAhG6Uorf5xnSf4Ya_GwJnoHkCsql4r1_hiOeDSLzo
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.tism.get(key, service=None, profile=None)
Get a decrypted secret from the tISMd API
.UNINDENT
.SS salt.sdb.vault
.sp
Vault SDB Module
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
New
.TP
.B platform
all
.UNINDENT
.sp
New in version 2016.11.0.

.sp
This module allows access to Hashicorp Vault using an \fBsdb://\fP URI.
.sp
Base configuration instructions are documented in the \fI\%execution module docs\fP\&.
Below are noted extra configuration required for the sdb module, but the base
configuration must also be completed.
.sp
Like all sdb modules, the vault module requires a configuration profile to
be configured in either the minion configuration file or a pillar. This profile
requires only setting the \fBdriver\fP parameter to \fBvault\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myvault:
  driver: vault
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once configured you can access data using a URL such as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
password: sdb://myvault/secret/passwords/mypassword
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this URL, \fBmyvault\fP refers to the configuration profile,
\fBsecret/passwords\fP is the path where the data resides, and \fBmypassword\fP is
the key of the data to return.
.sp
The above URI is analogous to running the following vault command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ vault read \-field=mypassword secret/passwords
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Further configuration
.sp
The following options can be set in the profile:
.INDENT 0.0
.TP
.B patch
When writing data, partially update the secret instead of overwriting it completely.
This is usually the expected behavior, since without this option,
each secret path can only contain a single mapping key safely.
Defaults to \fBFalse\fP for backwards\-compatibility reasons.
.sp
New in version 3007.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.vault.get(key, profile=None)
Get a value from the vault service
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.vault.set_(key, value, profile=None)
Set a key/value pair in the vault service
.UNINDENT
.SS salt.sdb.yaml
.sp
Pull sdb values from a YAML file
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
New
.TP
.B platform
all
.UNINDENT
.sp
New in version 2017.7.0.

.sp
Configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-yaml\-file:
  driver: yaml
  files:
    \- /path/to/foo.yaml
    \- /path/to/bar.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The files are merged together and the result is searched using the same
mechanism Salt uses for searching Grains and Pillar data structures.
.sp
Optional configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-yaml\-file:
  driver: yaml
  files:
    \- /path/to/foo.yaml
    \- /path/to/bar.yaml
  merge:
    strategy: smart
    merge_list: false
  gpg: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.sp
Setting the \fBgpg\fP option to \fBtrue\fP (default is \fBfalse\fP) will decrypt
embedded GPG\-encrypted data using the \fI\%GPG renderer\fP\&.
.INDENT 0.0
.TP
.B salt.sdb.yaml.get(key, profile=None)
Get a value from the dictionary
.UNINDENT
.INDENT 0.0
.TP
.B salt.sdb.yaml.set_(*args, **kwargs)
Setting a value is not supported; edit the YAML files directly
.UNINDENT
.SS serializer modules
.SS salt.serializers
.sp
This module implements all the serializers needed by salt.
Each serializer offers the same functions and attributes:
.INDENT 0.0
.TP
.B deserialize
function for deserializing string or stream
.TP
.B serialize
function for serializing a Python object
.TP
.B available
flag that tells if the serializer is available
(all dependencies are met etc.)
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.DeserializationError(message, line_num=None, buf=\(aq\(aq, marker=\(aq    <======================\(aq, trace=None)
Raised when stream of string failed to be deserialized
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.SerializationError(message=\(aq\(aq)
Raised when stream of string failed to be serialized
.UNINDENT
.TS
center;
|l|l|.
_
T{
\fI\%configparser\fP
T}	T{
salt.serializers.configparser
T}
_
T{
\fI\%json\fP
T}	T{
salt.serializers.json
T}
_
T{
\fI\%keyvalue\fP
T}	T{
salt.serializers.keyvalue

New in version 3006.0.
T}
_
T{
\fI\%msgpack\fP
T}	T{
salt.serializers.msgpack
T}
_
T{
\fI\%plist\fP
T}	T{
salt.serializers.plist

New in version 3001.
T}
_
T{
\fI\%python\fP
T}	T{
salt.serializers.python
T}
_
T{
\fI\%tomlmod\fP
T}	T{
salt.serializers.tomlmod
T}
_
T{
\fByaml\fP
T}	T{
salt.serializers.yaml
T}
_
T{
\fByamlex\fP
T}	T{
salt.serializers.yamlex
T}
_
.TE
.SS salt.serializers.configparser
.SS salt.serializers.configparser
.sp
New in version 2016.3.0.

.sp
Implements a configparser serializer.
.INDENT 0.0
.TP
.B exception  salt.serializers.configparser.DeserializationError(message, line_num=None, buf=\(aq\(aq, marker=\(aq    <======================\(aq, trace=None)
Raised when stream of string failed to be deserialized
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.configparser.SerializationError(message=\(aq\(aq)
Raised when stream of string failed to be serialized
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.configparser.deserialize(stream_or_string, **options)
Deserialize any string or stream like object into a Python data structure.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstream_or_string\fP \-\- stream or string to deserialize.
.IP \(bu 2
\fBoptions\fP \-\- options given to lower configparser module.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.configparser.serialize(obj, **options)
Serialize Python data to a configparser formatted string or file.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBobj\fP \-\- the data structure to serialize
.IP \(bu 2
\fBoptions\fP \-\- options given to lower configparser module.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.serializers.json
.SS salt.serializers.json
.sp
Implements JSON serializer.
.sp
It\(aqs just a wrapper around json (or simplejson if available).
.INDENT 0.0
.TP
.B exception  salt.serializers.json.DeserializationError(message, line_num=None, buf=\(aq\(aq, marker=\(aq    <======================\(aq, trace=None)
Raised when stream of string failed to be deserialized
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.json.SerializationError(message=\(aq\(aq)
Raised when stream of string failed to be serialized
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.json.deserialize(stream_or_string, **options)
Deserialize any string or stream like object into a Python data structure.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstream_or_string\fP \-\- stream or string to deserialize.
.IP \(bu 2
\fBoptions\fP \-\- options given to lower json/simplejson module.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.json.serialize(obj, **options)
Serialize Python data to JSON.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBobj\fP \-\- the data structure to serialize
.IP \(bu 2
\fBoptions\fP \-\- options given to lower json/simplejson module.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.serializers.keyvalue
.SS salt.serializers.keyvalue
.sp
New in version 3006.0.

.sp
Implements keyvalue serializer which can be used for serializing or
deserializing any file which defines keys and values separated by a common
set of characters, such environment files, which are in \(dqKEY=value\(dq format.
.sp
Options:
.INDENT 0.0
.TP
.B param line_ending
String representation of LF or CRLF to be used for serialization to a
file. Defaults to \fB\er\en\fP on Windows and \fB\en\fP on other operating
systems.
.TP
.B param quoting
Boolean flag to determine if values should be quoted (\fBTrue\fP) during
serialization or dequoted (\fBFalse\fP) during deserialization. Defaults
to \fBNone\fP (no action).
.TP
.B param separator
String representing the character(s) used when concatenating or reading
key/value pairs. Defaults to \fB=\fP\&.
.UNINDENT
.sp
A dataset such as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo: bar
wang: chung
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- [foo, bar]
\- [wang, chung]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
can be represented as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo=bar
wang=chung
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.keyvalue.DeserializationError(message, line_num=None, buf=\(aq\(aq, marker=\(aq    <======================\(aq, trace=None)
Raised when stream of string failed to be deserialized
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.keyvalue.SerializationError(message=\(aq\(aq)
Raised when stream of string failed to be serialized
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.keyvalue.dequote(value)
Remove extra quotes around a string.
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.keyvalue.deserialize(stream_or_string, **options)
Deserialize any string or stream like object into a Python data structure.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstream_or_string\fP \-\- stream or string to deserialize.
.IP \(bu 2
\fBoptions\fP \-\- options given to the function
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.keyvalue.quote(txt)
Wraps a text around quotes.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set my_text = \(aqmy_text\(aq %}
{{ my_text | quote }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will be rendered as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\(aqmy_text\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.keyvalue.serialize(obj, **options)
Serialize Python data to environment file.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBobj\fP \-\- the data structure to serialize
.IP \(bu 2
\fBoptions\fP \-\- options given to the function
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.serializers.msgpack
.SS salt.serializers.msgpack
.sp
Implements MsgPack serializer.
.INDENT 0.0
.TP
.B exception  salt.serializers.msgpack.DeserializationError(message, line_num=None, buf=\(aq\(aq, marker=\(aq    <======================\(aq, trace=None)
Raised when stream of string failed to be deserialized
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.msgpack.SerializationError(message=\(aq\(aq)
Raised when stream of string failed to be serialized
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.msgpack.deserialize(stream_or_string, **options)
Deserialize any string of stream like object into a Python data structure.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstream_or_string\fP \-\- stream or string to deserialize.
.IP \(bu 2
\fBoptions\fP \-\- options given to lower msgpack module.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.msgpack.serialize(obj, **options)
Serialize Python data to MsgPack.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBobj\fP \-\- the data structure to serialize
.IP \(bu 2
\fBoptions\fP \-\- options given to lower msgpack module.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.serializers.plist
.SS salt.serializers.plist
.sp
New in version 3001.

.sp
Implements plist serializer.
.sp
Wrapper around plistlib.
.INDENT 0.0
.TP
.B exception  salt.serializers.plist.DeserializationError(message, line_num=None, buf=\(aq\(aq, marker=\(aq    <======================\(aq, trace=None)
Raised when stream of string failed to be deserialized
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.plist.SerializationError(message=\(aq\(aq)
Raised when stream of string failed to be serialized
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.plist.deserialize(stream_or_string, **options)
Deserialize any string or stream like object into a Python data structure.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstream_or_string\fP \-\- stream or string to deserialize.
.IP \(bu 2
\fBoptions\fP \-\- options given to lower plist module.
.UNINDENT
.TP
.B Returns
Deserialized data structure.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.plist.serialize(value, **options)
Serialize Python data to plist. To create a binary plist pass
\fBfmt: FMT_BINARY\fP as an option.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBobj\fP \-\- the data structure to serialize
.IP \(bu 2
\fBoptions\fP \-\- options given to lower plist module.
.UNINDENT
.TP
.B Returns
bytes of serialized plist.
.UNINDENT
.UNINDENT
.SS salt.serializers.python
.SS salt.serializers.python
.sp
New in version 2016.3.0.

.sp
Implements a Python serializer (via pprint.format)
.INDENT 0.0
.TP
.B salt.serializers.python.serialize(obj, **options)
Serialize Python data to a Python string representation (via pprint.format)
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBobj\fP \-\- the data structure to serialize
.IP \(bu 2
\fBoptions\fP \-\- options given to pprint.format
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.serializers.toml
.SS salt.serializers.tomlmod
.sp
Implements TOML serializer.
.sp
It\(aqs just a wrapper around the python toml module.
.INDENT 0.0
.TP
.B exception  salt.serializers.tomlmod.DeserializationError(message, line_num=None, buf=\(aq\(aq, marker=\(aq    <======================\(aq, trace=None)
Raised when stream of string failed to be deserialized
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.tomlmod.SerializationError(message=\(aq\(aq)
Raised when stream of string failed to be serialized
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.tomlmod.deserialize(stream_or_string, **options)
Deserialize from TOML into Python data structure.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstream_or_string\fP \-\- toml stream or string to deserialize.
.IP \(bu 2
\fBoptions\fP \-\- options given to the python toml module.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.tomlmod.serialize(obj, **options)
Serialize Python data to TOML.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBobj\fP \-\- the data structure to serialize.
.IP \(bu 2
\fBoptions\fP \-\- options given to the python toml module.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.serializers.yaml
.SS salt.serializers.yaml
.sp
Implements YAML serializer.
.sp
Underneath, it is based on pyyaml and use the safe dumper and loader.
It also use C bindings if they are available.
.INDENT 0.0
.TP
.B salt.serializers.yaml.BaseDumper
alias of \fBCSafeDumper\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.yaml.BaseLoader
alias of \fBCSafeLoader\fP
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.yaml.ConstructorError(context=None, context_mark=None, problem=None, problem_mark=None, note=None)
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.yaml.DeserializationError(message, line_num=None, buf=\(aq\(aq, marker=\(aq    <======================\(aq, trace=None)
Raised when stream of string failed to be deserialized
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.serializers.yaml.Dumper(stream, default_style=None, default_flow_style=False, canonical=None, indent=None, width=None, allow_unicode=None, line_break=None, encoding=None, explicit_start=None, explicit_end=None, version=None, tags=None, sort_keys=True)
Overwrites Dumper as not for pollute legacy Dumper
.INDENT 7.0
.TP
.B yaml_multi_representers  =  {<class \(aqsalt.serializers.yaml.EncryptedString\(aq>: <function EncryptedString.yaml_dumper>, <class \(aqNoneType\(aq>: <function SafeRepresenter.represent_none>, <class \(aqstr\(aq>: <function SafeRepresenter.represent_str>, <class \(aqbool\(aq>: <function SafeRepresenter.represent_bool>, <class \(aqint\(aq>: <function SafeRepresenter.represent_int>, <class \(aqfloat\(aq>: <function SafeRepresenter.represent_float>, <class \(aqlist\(aq>: <function SafeRepresenter.represent_list>, <class \(aqtuple\(aq>: <function SafeRepresenter.represent_list>, <class \(aqdict\(aq>: <function SafeRepresenter.represent_dict>, <class \(aqset\(aq>: <function SafeRepresenter.represent_set>, <class \(aqdatetime.date\(aq>: <function SafeRepresenter.represent_date>, <class \(aqdatetime.datetime\(aq>: <function SafeRepresenter.represent_datetime>, None: <function SafeRepresenter.represent_undefined>, <class \(aqcollections.OrderedDict\(aq>: <function SafeRepresenter.represent_dict>}
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.serializers.yaml.EncryptedString
.INDENT 7.0
.TP
.B static  yaml_constructor(loader, tag, node)
.UNINDENT
.INDENT 7.0
.TP
.B static  yaml_dumper(dumper, data)
.UNINDENT
.INDENT 7.0
.TP
.B yaml_tag  =  \(aq!encrypted\(aq
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.serializers.yaml.Loader(stream)
Overwrites Loader as not for pollute legacy Loader
.INDENT 7.0
.TP
.B yaml_multi_constructors  =  {\(aq!encrypted\(aq: <function EncryptedString.yaml_constructor>, \(aqtag:yaml.org,2002:binary\(aq: <function SafeConstructor.construct_yaml_binary>, \(aqtag:yaml.org,2002:bool\(aq: <function SafeConstructor.construct_yaml_bool>, \(aqtag:yaml.org,2002:float\(aq: <function SafeConstructor.construct_yaml_float>, \(aqtag:yaml.org,2002:int\(aq: <function SafeConstructor.construct_yaml_int>, \(aqtag:yaml.org,2002:map\(aq: <function SafeConstructor.construct_yaml_map>, \(aqtag:yaml.org,2002:null\(aq: <function SafeConstructor.construct_yaml_null>, \(aqtag:yaml.org,2002:omap\(aq: <function SafeConstructor.construct_yaml_omap>, \(aqtag:yaml.org,2002:pairs\(aq: <function SafeConstructor.construct_yaml_pairs>, \(aqtag:yaml.org,2002:seq\(aq: <function SafeConstructor.construct_yaml_seq>, \(aqtag:yaml.org,2002:set\(aq: <function SafeConstructor.construct_yaml_set>, \(aqtag:yaml.org,2002:str\(aq: <function SafeConstructor.construct_yaml_str>, \(aqtag:yaml.org,2002:timestamp\(aq: <function SafeConstructor.construct_yaml_timestamp>}
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.serializers.yaml.OrderedDict
Dictionary that remembers insertion order
.INDENT 7.0
.TP
.B clear() -> None.  Remove all items from od.
.UNINDENT
.INDENT 7.0
.TP
.B copy() -> a shallow copy of od
.UNINDENT
.INDENT 7.0
.TP
.B fromkeys(value=None)
Create a new ordered dictionary with keys from iterable and values set to value.
.UNINDENT
.INDENT 7.0
.TP
.B items() -> a set\-like object providing a view on D\(aqs items
.UNINDENT
.INDENT 7.0
.TP
.B keys() -> a set\-like object providing a view on D\(aqs keys
.UNINDENT
.INDENT 7.0
.TP
.B move_to_end(key, last=True)
Move an existing element to the end (or beginning if last is false).
.sp
Raise KeyError if the element does not exist.
.UNINDENT
.INDENT 7.0
.TP
.B pop(key[, default]) -> v, remove specified key and return the corresponding value.
If the key is not found, return the default if given; otherwise,
raise a KeyError.
.UNINDENT
.INDENT 7.0
.TP
.B popitem(last=True)
Remove and return a (key, value) pair from the dictionary.
.sp
Pairs are returned in LIFO order if last is true or FIFO order if false.
.UNINDENT
.INDENT 7.0
.TP
.B setdefault(key, default=None)
Insert key with a value of default if key is not in the dictionary.
.sp
Return the value for key if key is in the dictionary, else default.
.UNINDENT
.INDENT 7.0
.TP
.B update([E], **F) -> None.  Update D from dict/iterable E and F.
If E is present and has a .keys() method, then does:  for k in E: D[k] = E[k]
If E is present and lacks a .keys() method, then does:  for k, v in E: D[k] = v
In either case, this is followed by: for k in F:  D[k] = F[k]
.UNINDENT
.INDENT 7.0
.TP
.B values() -> an object providing a view on D\(aqs values
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.yaml.ScannerError(context=None, context_mark=None, problem=None, problem_mark=None, note=None)
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.yaml.SerializationError(message=\(aq\(aq)
Raised when stream of string failed to be serialized
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.yaml.deserialize(stream_or_string, **options)
Deserialize any string of stream like object into a Python data structure.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstream_or_string\fP \-\- stream or string to deserialize.
.IP \(bu 2
\fBoptions\fP \-\- options given to lower yaml module.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.yaml.serialize(obj, **options)
Serialize Python data to YAML.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBobj\fP \-\- the data structure to serialize
.IP \(bu 2
\fBoptions\fP \-\- options given to lower yaml module.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.serializers.yamlex
.SS salt.serializers.yamlex
.sp
YAMLEX is a format that allows for things like sls files to be
more intuitive.
.sp
It\(aqs an extension of YAML that implements all the salt magic:
\- it implies omap for any dict like.
\- it implies that string like data are str, not unicode
\- ...
.sp
For example, the file \fIstates.sls\fP has this contents:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  bar: 42
  baz: [1, 2, 3]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The file can be parsed into Python like this
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from salt.serializers import yamlex

with open(\(aqstate.sls\(aq, \(aqr\(aq) as stream:
    obj = yamlex.deserialize(stream)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Check that \fBobj\fP is an OrderedDict
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from salt.utils.odict import OrderedDict

assert isinstance(obj, dict)
assert isinstance(obj, OrderedDict)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
yamlex \fI__repr__\fP and \fI__str__\fP objects\(aq methods render YAML understandable
string. It means that they are template friendly.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
print \(aq{0}\(aq.format(obj)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
returns:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{foo: {bar: 42, baz: [1, 2, 3]}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
and they are still valid YAML:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from salt.serializers import yaml
yml_obj = yaml.deserialize(str(obj))
assert yml_obj == obj
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
yamlex implements also custom tags:
.sp
!aggregate
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
this tag allows structures aggregation.
.UNINDENT
.UNINDENT
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
placeholder: !aggregate foo
placeholder: !aggregate bar
placeholder: !aggregate baz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
is rendered as
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
placeholder: [foo, bar, baz]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
!reset
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
this tag flushes the computing value.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
placeholder: {!aggregate foo: {foo: 42}}
placeholder: {!aggregate foo: {bar: null}}
!reset placeholder: {!aggregate foo: {baz: inga}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
is roughly equivalent to
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
placeholder: {!aggregate foo: {baz: inga}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Document is defacto an aggregate mapping.
.INDENT 0.0
.TP
.B class  salt.serializers.yamlex.AggregatedMap
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.serializers.yamlex.AggregatedSequence(iterable=(), /)
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.yamlex.BaseDumper
alias of \fBSafeDumper\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.yamlex.BaseLoader
alias of \fBCSafeLoader\fP
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.yamlex.ConstructorError(context=None, context_mark=None, problem=None, problem_mark=None, note=None)
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.yamlex.DeserializationError(message, line_num=None, buf=\(aq\(aq, marker=\(aq    <======================\(aq, trace=None)
Raised when stream of string failed to be deserialized
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.serializers.yamlex.Dumper(stream, default_style=None, default_flow_style=False, canonical=None, indent=None, width=None, allow_unicode=None, line_break=None, encoding=None, explicit_start=None, explicit_end=None, version=None, tags=None, sort_keys=True)
sls dumper.
.INDENT 7.0
.TP
.B represent_odict(data)
.UNINDENT
.INDENT 7.0
.TP
.B yaml_multi_representers  =  {<class \(aqNoneType\(aq>: <function SafeRepresenter.represent_none>, <class \(aqbytes\(aq>: <function SafeRepresenter.represent_binary>, <class \(aqstr\(aq>: <function SafeRepresenter.represent_str>, <class \(aqbool\(aq>: <function SafeRepresenter.represent_bool>, <class \(aqint\(aq>: <function SafeRepresenter.represent_int>, <class \(aqfloat\(aq>: <function SafeRepresenter.represent_float>, <class \(aqlist\(aq>: <function SafeRepresenter.represent_list>, <class \(aqtuple\(aq>: <function SafeRepresenter.represent_list>, <class \(aqdict\(aq>: <function Dumper.represent_odict>, <class \(aqset\(aq>: <function SafeRepresenter.represent_set>, <class \(aqdatetime.date\(aq>: <function SafeRepresenter.represent_date>, <class \(aqdatetime.datetime\(aq>: <function SafeRepresenter.represent_datetime>, None: <function SafeRepresenter.represent_undefined>}
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.serializers.yamlex.Loader(stream)
Create a custom YAML loader that uses the custom constructor. This allows
for the YAML loading defaults to be manipulated based on needs within salt
to make things like sls file more intuitive.
.INDENT 7.0
.TP
.B DEFAULT_MAPPING_TAG  =  \(aqtag:yaml.org,2002:omap\(aq
.UNINDENT
.INDENT 7.0
.TP
.B DEFAULT_SCALAR_TAG  =  \(aqtag:yaml.org,2002:str\(aq
.UNINDENT
.INDENT 7.0
.TP
.B DEFAULT_SEQUENCE_TAG  =  \(aqtag:yaml.org,2002:seq\(aq
.UNINDENT
.INDENT 7.0
.TP
.B compose_document()
.UNINDENT
.INDENT 7.0
.TP
.B construct_sls_aggregate(node)
.UNINDENT
.INDENT 7.0
.TP
.B construct_sls_int(node)
Verify integers and pass them in correctly is they are declared
as octal
.UNINDENT
.INDENT 7.0
.TP
.B construct_sls_reset(node)
.UNINDENT
.INDENT 7.0
.TP
.B construct_sls_str(node)
Build the SLSString.
.UNINDENT
.INDENT 7.0
.TP
.B construct_yaml_omap(node)
Build the SLSMap
.UNINDENT
.INDENT 7.0
.TP
.B resolve_sls_tag(node)
.UNINDENT
.INDENT 7.0
.TP
.B yaml_constructors  =  {\(aqtag:yaml.org,2002:null\(aq: <function SafeConstructor.construct_yaml_null>, \(aqtag:yaml.org,2002:bool\(aq: <function SafeConstructor.construct_yaml_bool>, \(aqtag:yaml.org,2002:int\(aq: <function Loader.construct_sls_int>, \(aqtag:yaml.org,2002:float\(aq: <function SafeConstructor.construct_yaml_float>, \(aqtag:yaml.org,2002:binary\(aq: <function SafeConstructor.construct_yaml_binary>, \(aqtag:yaml.org,2002:timestamp\(aq: <function SafeConstructor.construct_yaml_timestamp>, \(aqtag:yaml.org,2002:omap\(aq: <function Loader.construct_yaml_omap>, \(aqtag:yaml.org,2002:pairs\(aq: <function SafeConstructor.construct_yaml_pairs>, \(aqtag:yaml.org,2002:set\(aq: <function SafeConstructor.construct_yaml_set>, \(aqtag:yaml.org,2002:str\(aq: <function Loader.construct_sls_str>, \(aqtag:yaml.org,2002:seq\(aq: <function SafeConstructor.construct_yaml_seq>, \(aqtag:yaml.org,2002:map\(aq: <function SafeConstructor.construct_yaml_map>, None: <function SafeConstructor.construct_undefined>, \(aq!aggregate\(aq: <function Loader.construct_sls_aggregate>, \(aq!reset\(aq: <function Loader.construct_sls_reset>}
.UNINDENT
.INDENT 7.0
.TP
.B yaml_multi_constructors  =  {\(aqtag:yaml.org,2002:binary\(aq: <function SafeConstructor.construct_yaml_binary>, \(aqtag:yaml.org,2002:bool\(aq: <function SafeConstructor.construct_yaml_bool>, \(aqtag:yaml.org,2002:float\(aq: <function SafeConstructor.construct_yaml_float>, \(aqtag:yaml.org,2002:map\(aq: <function SafeConstructor.construct_yaml_map>, \(aqtag:yaml.org,2002:null\(aq: <function SafeConstructor.construct_yaml_null>, \(aqtag:yaml.org,2002:pairs\(aq: <function SafeConstructor.construct_yaml_pairs>, \(aqtag:yaml.org,2002:seq\(aq: <function SafeConstructor.construct_yaml_seq>, \(aqtag:yaml.org,2002:set\(aq: <function SafeConstructor.construct_yaml_set>, \(aqtag:yaml.org,2002:timestamp\(aq: <function SafeConstructor.construct_yaml_timestamp>}
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.serializers.yamlex.Map
Map aggregation.
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.serializers.yamlex.MappingNode(tag, value, start_mark=None, end_mark=None, flow_style=None)
.INDENT 7.0
.TP
.B id  =  \(aqmapping\(aq
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.serializers.yamlex.OrderedDict
Dictionary that remembers insertion order
.INDENT 7.0
.TP
.B clear() -> None.  Remove all items from od.
.UNINDENT
.INDENT 7.0
.TP
.B copy() -> a shallow copy of od
.UNINDENT
.INDENT 7.0
.TP
.B fromkeys(value=None)
Create a new ordered dictionary with keys from iterable and values set to value.
.UNINDENT
.INDENT 7.0
.TP
.B items() -> a set\-like object providing a view on D\(aqs items
.UNINDENT
.INDENT 7.0
.TP
.B keys() -> a set\-like object providing a view on D\(aqs keys
.UNINDENT
.INDENT 7.0
.TP
.B move_to_end(key, last=True)
Move an existing element to the end (or beginning if last is false).
.sp
Raise KeyError if the element does not exist.
.UNINDENT
.INDENT 7.0
.TP
.B pop(key[, default]) -> v, remove specified key and return the corresponding value.
If the key is not found, return the default if given; otherwise,
raise a KeyError.
.UNINDENT
.INDENT 7.0
.TP
.B popitem(last=True)
Remove and return a (key, value) pair from the dictionary.
.sp
Pairs are returned in LIFO order if last is true or FIFO order if false.
.UNINDENT
.INDENT 7.0
.TP
.B setdefault(key, default=None)
Insert key with a value of default if key is not in the dictionary.
.sp
Return the value for key if key is in the dictionary, else default.
.UNINDENT
.INDENT 7.0
.TP
.B update([E], **F) -> None.  Update D from dict/iterable E and F.
If E is present and has a .keys() method, then does:  for k in E: D[k] = E[k]
If E is present and lacks a .keys() method, then does:  for k, v in E: D[k] = v
In either case, this is followed by: for k in F:  D[k] = F[k]
.UNINDENT
.INDENT 7.0
.TP
.B values() -> an object providing a view on D\(aqs values
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.serializers.yamlex.SLSMap
Ensures that dict str() and repr() are YAML friendly.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> mapping = OrderedDict([(\(aqa\(aq, \(aqb\(aq), (\(aqc\(aq, None)])
>>> print mapping
OrderedDict([(\(aqa\(aq, \(aqb\(aq), (\(aqc\(aq, None)])

>>> sls_map = SLSMap(mapping)
>>> print sls_map.__str__()
{a: b, c: null}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.serializers.yamlex.SLSString
Ensures that str str() and repr() are YAML friendly.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> scalar = str(\(aqfoo\(aq)
>>> print \(aqfoo\(aq
foo

>>> sls_scalar = SLSString(scalar)
>>> print sls_scalar
\(dqfoo\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.yamlex.ScannerError(context=None, context_mark=None, problem=None, problem_mark=None, note=None)
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.serializers.yamlex.Sequence(iterable=(), /)
Sequence aggregation.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.serializers.yamlex.SerializationError(message=\(aq\(aq)
Raised when stream of string failed to be serialized
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.yamlex.aggregate(obj_a, obj_b, level=False, map_class=<class \(aqsalt.utils.aggregation.Map\(aq>, sequence_class=<class \(aqsalt.utils.aggregation.Sequence\(aq>)
Merge obj_b into obj_a.
.sp
.nf
.ft C
>>> aggregate(\(aqfirst\(aq, \(aqsecond\(aq, True) == [\(aqfirst\(aq, \(aqsecond\(aq]
True
.ft P
.fi
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.yamlex.deserialize(stream_or_string, **options)
Deserialize any string of stream like object into a Python data structure.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstream_or_string\fP \-\- stream or string to deserialize.
.IP \(bu 2
\fBoptions\fP \-\- options given to lower yaml module.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.yamlex.merge_recursive(obj_a, obj_b, level=False)
Merge obj_b into obj_a.
.UNINDENT
.INDENT 0.0
.TP
.B salt.serializers.yamlex.serialize(obj, **options)
Serialize Python data to YAML.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBobj\fP \-\- the data structure to serialize
.IP \(bu 2
\fBoptions\fP \-\- options given to lower yaml module.
.UNINDENT
.UNINDENT
.UNINDENT
.SS state modules
.TS
center;
|l|l|.
_
T{
\fI\%acme\fP
T}	T{
ACME / Let\(aqs Encrypt certificate management state
T}
_
T{
\fI\%alias\fP
T}	T{
Configuration of email aliases
T}
_
T{
\fI\%alternatives\fP
T}	T{
Configuration of the alternatives system
T}
_
T{
\fI\%ansiblegate\fP
T}	T{
Execution of Ansible modules from within states
T}
_
T{
\fI\%apache\fP
T}	T{
T}
_
T{
\fI\%apache_conf\fP
T}	T{
T}
_
T{
\fI\%apache_module\fP
T}	T{
T}
_
T{
\fI\%apache_site\fP
T}	T{
T}
_
T{
\fI\%aptpkg\fP
T}	T{
Package management operations specific to APT\- and DEB\-based systems
T}
_
T{
\fI\%archive\fP
T}	T{
Extract an archive
T}
_
T{
\fI\%artifactory\fP
T}	T{
This state downloads artifacts from artifactory.
T}
_
T{
\fI\%at\fP
T}	T{
Configuration disposable regularly scheduled tasks for at.
T}
_
T{
\fI\%augeas\fP
T}	T{
Configuration management using Augeas
T}
_
T{
\fI\%aws_sqs\fP
T}	T{
Manage SQS Queues
T}
_
T{
\fI\%beacon\fP
T}	T{
Management of the Salt beacons
T}
_
T{
\fI\%bigip\fP
T}	T{
A state module designed to enforce load\-balancing configurations for F5 Big\-IP entities.
T}
_
T{
\fI\%blockdev\fP
T}	T{
Management of Block Devices
T}
_
T{
\fI\%boto3_elasticache\fP
T}	T{
Manage Elasticache with boto3
T}
_
T{
\fI\%boto3_elasticsearch\fP
T}	T{
Manage Elasticsearch Service
T}
_
T{
\fI\%boto3_route53\fP
T}	T{
Manage Route53 records with Boto 3
T}
_
T{
\fI\%boto3_sns\fP
T}	T{
Manage SNS Topics
T}
_
T{
\fI\%boto_apigateway\fP
T}	T{
Manage Apigateway Rest APIs
T}
_
T{
\fI\%boto_asg\fP
T}	T{
Manage Autoscale Groups
T}
_
T{
\fI\%boto_cfn\fP
T}	T{
Connection module for Amazon Cloud Formation
T}
_
T{
\fI\%boto_cloudfront\fP
T}	T{
Manage CloudFront distributions
T}
_
T{
\fI\%boto_cloudtrail\fP
T}	T{
Manage CloudTrail Objects
T}
_
T{
\fI\%boto_cloudwatch_alarm\fP
T}	T{
Manage Cloudwatch alarms
T}
_
T{
\fI\%boto_cloudwatch_event\fP
T}	T{
Manage CloudTrail Objects
T}
_
T{
\fI\%boto_cognitoidentity\fP
T}	T{
Manage CognitoIdentity Functions
T}
_
T{
\fI\%boto_datapipeline\fP
T}	T{
Manage Data Pipelines
T}
_
T{
\fI\%boto_dynamodb\fP
T}	T{
Manage DynamoDB Tables
T}
_
T{
\fI\%boto_ec2\fP
T}	T{
Manage EC2
T}
_
T{
\fI\%boto_elasticache\fP
T}	T{
Manage Elasticache
T}
_
T{
\fI\%boto_elasticsearch_domain\fP
T}	T{
Manage Elasticsearch Domains
T}
_
T{
\fI\%boto_elb\fP
T}	T{
Manage ELBs
T}
_
T{
\fI\%boto_elbv2\fP
T}	T{
Manage AWS Application Load Balancer
T}
_
T{
\fI\%boto_iam\fP
T}	T{
Manage IAM objects
T}
_
T{
\fI\%boto_iam_role\fP
T}	T{
Manage IAM roles
T}
_
T{
\fI\%boto_iot\fP
T}	T{
Manage IoT Objects
T}
_
T{
\fI\%boto_kinesis\fP
T}	T{
Manage Kinesis Streams
T}
_
T{
\fI\%boto_kms\fP
T}	T{
Manage KMS keys, key policies and grants.
T}
_
T{
\fI\%boto_lambda\fP
T}	T{
Manage Lambda Functions
T}
_
T{
\fI\%boto_lc\fP
T}	T{
Manage Launch Configurations
T}
_
T{
\fI\%boto_rds\fP
T}	T{
Manage RDSs
T}
_
T{
\fI\%boto_route53\fP
T}	T{
Manage Route53 records
T}
_
T{
\fI\%boto_s3\fP
T}	T{
Manage S3 Resources
T}
_
T{
\fI\%boto_s3_bucket\fP
T}	T{
Manage S3 Buckets
T}
_
T{
\fI\%boto_secgroup\fP
T}	T{
Manage Security Groups
T}
_
T{
\fI\%boto_sns\fP
T}	T{
Manage SNS Topics
T}
_
T{
\fI\%boto_sqs\fP
T}	T{
Manage SQS Queues
T}
_
T{
\fI\%boto_vpc\fP
T}	T{
Manage VPCs
T}
_
T{
\fI\%bower\fP
T}	T{
Installation of Bower Packages
T}
_
T{
\fI\%btrfs\fP
T}	T{
Manage BTRFS file systems.
T}
_
T{
\fI\%cabal\fP
T}	T{
Installation of Cabal Packages
T}
_
T{
\fI\%ceph\fP
T}	T{
Manage ceph with salt.
T}
_
T{
\fI\%chef\fP
T}	T{
Execute Chef client runs
T}
_
T{
\fI\%chocolatey\fP
T}	T{
Manage Windows Packages using Chocolatey .
T}
_
T{
\fI\%chronos_job\fP
T}	T{
Configure Chronos jobs via a salt proxy.
T}
_
T{
\fI\%cimc\fP
T}	T{
A state module to manage Cisco UCS chassis devices.
T}
_
T{
\fI\%cisconso\fP
T}	T{
State module for Cisco NSO Proxy minions
T}
_
T{
\fI\%cloud\fP
T}	T{
Using states instead of maps to deploy clouds
T}
_
T{
\fI\%cmd\fP
T}	T{
Execution of arbitrary commands
T}
_
T{
\fI\%composer\fP
T}	T{
Installation of Composer Packages
T}
_
T{
\fI\%consul\fP
T}	T{
Consul Management
T}
_
T{
\fI\%cron\fP
T}	T{
Management of cron, the Unix command scheduler
T}
_
T{
\fI\%cryptdev\fP
T}	T{
Opening of Encrypted Devices
T}
_
T{
\fI\%csf\fP
T}	T{
CSF Ip tables management
T}
_
T{
\fI\%cyg\fP
T}	T{
Installation of Cygwin packages.
T}
_
T{
\fI\%ddns\fP
T}	T{
Dynamic DNS updates
T}
_
T{
\fI\%debconfmod\fP
T}	T{
Management of debconf selections
T}
_
T{
\fI\%dellchassis\fP
T}	T{
Manage chassis via Salt Proxies.
T}
_
T{
\fI\%disk\fP
T}	T{
Disk monitoring state
T}
_
T{
\fI\%docker_container\fP
T}	T{
T}
_
T{
\fI\%docker_image\fP
T}	T{
T}
_
T{
\fI\%docker_network\fP
T}	T{
T}
_
T{
\fI\%docker_volume\fP
T}	T{
T}
_
T{
\fI\%drac\fP
T}	T{
Management of Dell DRAC
T}
_
T{
\fI\%dvs\fP
T}	T{
Manage VMware distributed virtual switches (DVSs) and their distributed virtual portgroups (DVportgroups).
T}
_
T{
\fI\%elasticsearch\fP
T}	T{
State module to manage Elasticsearch.
T}
_
T{
\fI\%elasticsearch_index\fP
T}	T{
State module to manage Elasticsearch indices
T}
_
T{
\fI\%elasticsearch_index_template\fP
T}	T{
State module to manage Elasticsearch index templates
T}
_
T{
\fI\%environ\fP
T}	T{
Support for getting and setting the environment variables of the current salt process.
T}
_
T{
\fI\%eselect\fP
T}	T{
Management of Gentoo configuration using eselect
T}
_
T{
\fI\%esxcluster\fP
T}	T{
Manage VMware ESXi Clusters.
T}
_
T{
\fI\%esxdatacenter\fP
T}	T{
Salt states to create and manage VMware vSphere datacenters (datacenters).
T}
_
T{
\fI\%esxi\fP
T}	T{
Manage VMware ESXi Hosts.
T}
_
T{
\fI\%esxvm\fP
T}	T{
Salt state to create, update VMware ESXi Virtual Machines.
T}
_
T{
\fI\%etcd_mod\fP
T}	T{
Manage etcd Keys
T}
_
T{
\fI\%ethtool\fP
T}	T{
Configuration of network device
T}
_
T{
\fI\%event\fP
T}	T{
Send events through Salt\(aqs event system during state runs
T}
_
T{
\fI\%file\fP
T}	T{
Operations on regular files, special files, directories, and symlinks
T}
_
T{
\fI\%firewall\fP
T}	T{
State to check firewall configurations
T}
_
T{
\fI\%firewalld\fP
T}	T{
Management of firewalld
T}
_
T{
\fI\%gem\fP
T}	T{
Installation of Ruby modules packaged as gems
T}
_
T{
\fI\%git\fP
T}	T{
States to manage git repositories and git configuration
T}
_
T{
\fI\%github\fP
T}	T{
Github User State Module
T}
_
T{
\fI\%glance_image\fP
T}	T{
Management of OpenStack Glance Images
T}
_
T{
\fI\%glassfish\fP
T}	T{
Manage Glassfish/Payara server .
T}
_
T{
\fI\%glusterfs\fP
T}	T{
Manage GlusterFS pool.
T}
_
T{
\fI\%gnomedesktop\fP
T}	T{
Configuration of the GNOME desktop
T}
_
T{
\fI\%gpg\fP
T}	T{
Manage GPG keychains
T}
_
T{
\fI\%grafana\fP
T}	T{
Manage Grafana Dashboards
T}
_
T{
\fI\%grafana4_dashboard\fP
T}	T{
Manage Grafana v4.0 Dashboards
T}
_
T{
\fI\%grafana4_datasource\fP
T}	T{
Manage Grafana v4.0 data sources
T}
_
T{
\fI\%grafana4_org\fP
T}	T{
Manage Grafana v4.0 orgs
T}
_
T{
\fI\%grafana4_user\fP
T}	T{
Manage Grafana v4.0 users
T}
_
T{
\fI\%grafana_dashboard\fP
T}	T{
Manage Grafana v2.0 Dashboards
T}
_
T{
\fI\%grafana_datasource\fP
T}	T{
Manage Grafana v2.0 data sources
T}
_
T{
\fI\%grains\fP
T}	T{
Manage grains on the minion
T}
_
T{
\fI\%group\fP
T}	T{
Management of user groups
T}
_
T{
\fI\%heat\fP
T}	T{
Management of Heat
T}
_
T{
\fI\%helm\fP
T}	T{
T}
_
T{
\fI\%hg\fP
T}	T{
Interaction with Mercurial repositories
T}
_
T{
\fI\%highstate_doc\fP
T}	T{
To be used with processors in module \fIhighstate_doc\fP\&.
T}
_
T{
\fI\%host\fP
T}	T{
Management of addresses and names in hosts file
T}
_
T{
\fI\%http\fP
T}	T{
HTTP monitoring states
T}
_
T{
\fI\%icinga2\fP
T}	T{
Icinga2 state
T}
_
T{
\fI\%idem\fP
T}	T{
Idem Support
T}
_
T{
\fI\%ifttt\fP
T}	T{
Trigger an event in IFTTT
T}
_
T{
\fI\%incron\fP
T}	T{
Management of incron, the inotify cron
T}
_
T{
\fI\%influxdb08_database\fP
T}	T{
Management of Influxdb 0.8 databases
T}
_
T{
\fI\%influxdb08_user\fP
T}	T{
Management of InfluxDB 0.8 users
T}
_
T{
\fI\%influxdb_continuous_query\fP
T}	T{
Management of Influxdb continuous queries
T}
_
T{
\fI\%influxdb_database\fP
T}	T{
Management of Influxdb databases
T}
_
T{
\fI\%influxdb_retention_policy\fP
T}	T{
Management of Influxdb retention policies
T}
_
T{
\fI\%influxdb_user\fP
T}	T{
Management of InfluxDB users
T}
_
T{
\fI\%infoblox_a\fP
T}	T{
Infoblox A record management.
T}
_
T{
\fI\%infoblox_cname\fP
T}	T{
Infoblox CNAME management.
T}
_
T{
\fI\%infoblox_host_record\fP
T}	T{
Infoblox host record management.
T}
_
T{
\fI\%infoblox_range\fP
T}	T{
Infoblox host record management.
T}
_
T{
\fI\%ini_manage\fP
T}	T{
Manage ini files
T}
_
T{
\fI\%ipmi\fP
T}	T{
Manage IPMI devices over LAN
T}
_
T{
\fI\%ipset\fP
T}	T{
Management of ipsets
T}
_
T{
\fI\%iptables\fP
T}	T{
Management of iptables
T}
_
T{
\fI\%jboss7\fP
T}	T{
Manage JBoss 7 Application Server via CLI interface
T}
_
T{
\fI\%jenkins\fP
T}	T{
Management of Jenkins
T}
_
T{
\fI\%junos\fP
T}	T{
State modules to interact with Junos devices.
T}
_
T{
\fI\%kapacitor\fP
T}	T{
Kapacitor state module.
T}
_
T{
\fI\%kernelpkg\fP
T}	T{
Manage kernel packages and active kernel version
T}
_
T{
\fI\%keyboard\fP
T}	T{
Management of keyboard layouts
T}
_
T{
\fI\%keystone\fP
T}	T{
Management of Keystone users
T}
_
T{
\fI\%keystone_domain\fP
T}	T{
Management of OpenStack Keystone Domains
T}
_
T{
\fI\%keystone_endpoint\fP
T}	T{
Management of OpenStack Keystone Endpoints
T}
_
T{
\fI\%keystone_group\fP
T}	T{
Management of OpenStack Keystone Groups
T}
_
T{
\fI\%keystone_project\fP
T}	T{
Management of OpenStack Keystone Projects
T}
_
T{
\fI\%keystone_role\fP
T}	T{
Management of OpenStack Keystone Roles
T}
_
T{
\fI\%keystone_role_grant\fP
T}	T{
Management of OpenStack Keystone Role Grants
T}
_
T{
\fI\%keystone_service\fP
T}	T{
Management of OpenStack Keystone Services
T}
_
T{
\fI\%keystone_user\fP
T}	T{
Management of OpenStack Keystone Users
T}
_
T{
\fI\%keystore\fP
T}	T{
State management of a java keystore
T}
_
T{
\fI\%kmod\fP
T}	T{
Loading and unloading of kernel modules
T}
_
T{
\fI\%kubernetes\fP
T}	T{
T}
_
T{
\fI\%layman\fP
T}	T{
Management of Gentoo Overlays using layman
T}
_
T{
\fI\%ldap\fP
T}	T{
Manage entries in an LDAP database
T}
_
T{
\fI\%libcloud_dns\fP
T}	T{
Manage DNS records and zones using libcloud
T}
_
T{
\fI\%libcloud_loadbalancer\fP
T}	T{
Apache Libcloud Load Balancer State
T}
_
T{
\fI\%libcloud_storage\fP
T}	T{
Apache Libcloud Storage State
T}
_
T{
\fI\%linux_acl\fP
T}	T{
Linux File Access Control Lists
T}
_
T{
\fI\%locale\fP
T}	T{
Management of languages/locales
T}
_
T{
\fI\%logadm\fP
T}	T{
Management of logs using Solaris logadm.
T}
_
T{
\fI\%logrotate\fP
T}	T{
Module for managing logrotate.
T}
_
T{
\fI\%loop\fP
T}	T{
Loop state
T}
_
T{
\fI\%lvm\fP
T}	T{
Management of Linux logical volumes
T}
_
T{
\fI\%lvs_server\fP
T}	T{
Management of LVS (Linux Virtual Server) Real Server
T}
_
T{
\fI\%lvs_service\fP
T}	T{
Management of LVS (Linux Virtual Server) Service
T}
_
T{
\fI\%lxc\fP
T}	T{
Manage Linux Containers
T}
_
T{
\fI\%lxd\fP
T}	T{
Manage LXD profiles.
T}
_
T{
\fI\%lxd_container\fP
T}	T{
Manage LXD containers.
T}
_
T{
\fI\%lxd_image\fP
T}	T{
Manage LXD images.
T}
_
T{
\fI\%lxd_profile\fP
T}	T{
Manage LXD profiles.
T}
_
T{
\fI\%mac_assistive\fP
T}	T{
Allows you to manage assistive access on macOS minions with 10.9+
T}
_
T{
\fI\%mac_keychain\fP
T}	T{
Installing of certificates to the keychain
T}
_
T{
\fI\%mac_xattr\fP
T}	T{
Allows you to manage extended attributes on files or directories
T}
_
T{
\fI\%macdefaults\fP
T}	T{
Writing/reading defaults from a macOS minion
T}
_
T{
\fI\%macpackage\fP
T}	T{
Installing of mac pkg files
T}
_
T{
\fI\%makeconf\fP
T}	T{
Management of Gentoo make.conf
T}
_
T{
\fI\%marathon_app\fP
T}	T{
Configure Marathon apps via a salt proxy.
T}
_
T{
\fI\%mdadm_raid\fP
T}	T{
Managing software RAID with mdadm
T}
_
T{
\fI\%memcached\fP
T}	T{
States for Management of Memcached Keys
T}
_
T{
\fI\%modjk\fP
T}	T{
State to control Apache modjk
T}
_
T{
\fI\%modjk_worker\fP
T}	T{
Manage modjk workers
T}
_
T{
\fI\%module\fP
T}	T{
Execution of Salt modules from within states
T}
_
T{
\fI\%mongodb_database\fP
T}	T{
Management of MongoDB Databases
T}
_
T{
\fI\%mongodb_user\fP
T}	T{
Management of MongoDB Users
T}
_
T{
\fI\%monit\fP
T}	T{
Monit state
T}
_
T{
\fI\%mount\fP
T}	T{
Mounting of filesystems
T}
_
T{
\fI\%mssql_database\fP
T}	T{
Management of Microsoft SQLServer Databases
T}
_
T{
\fI\%mssql_login\fP
T}	T{
Management of Microsoft SQLServer Logins
T}
_
T{
\fI\%mssql_role\fP
T}	T{
Management of Microsoft SQLServer Databases
T}
_
T{
\fI\%mssql_user\fP
T}	T{
Management of Microsoft SQLServer Users
T}
_
T{
\fI\%msteams\fP
T}	T{
Send a message card to Microsoft Teams
T}
_
T{
\fI\%mysql_database\fP
T}	T{
Management of MySQL databases (schemas)
T}
_
T{
\fI\%mysql_grants\fP
T}	T{
Management of MySQL grants (user permissions)
T}
_
T{
\fI\%mysql_query\fP
T}	T{
Execution of MySQL queries
T}
_
T{
\fI\%mysql_user\fP
T}	T{
Management of MySQL users
T}
_
T{
\fI\%net_napalm_yang\fP
T}	T{
NAPALM YANG state
T}
_
T{
\fI\%netacl\fP
T}	T{
Network ACL
T}
_
T{
\fI\%netconfig\fP
T}	T{
Network Config
T}
_
T{
\fI\%netntp\fP
T}	T{
Network NTP
T}
_
T{
\fI\%netsnmp\fP
T}	T{
Network SNMP
T}
_
T{
\fI\%netusers\fP
T}	T{
Network Users
T}
_
T{
\fI\%network\fP
T}	T{
Configuration of network interfaces
T}
_
T{
\fI\%neutron_network\fP
T}	T{
Management of OpenStack Neutron Networks
T}
_
T{
\fI\%neutron_secgroup\fP
T}	T{
Management of OpenStack Neutron Security Groups
T}
_
T{
\fI\%neutron_secgroup_rule\fP
T}	T{
Management of OpenStack Neutron Security Group Rules
T}
_
T{
\fI\%neutron_subnet\fP
T}	T{
Management of OpenStack Neutron Subnets
T}
_
T{
\fI\%nexus\fP
T}	T{
This state downloads artifacts from Nexus 3.x.
T}
_
T{
\fI\%nfs_export\fP
T}	T{
Management of NFS exports
T}
_
T{
\fI\%nftables\fP
T}	T{
Management of nftables
T}
_
T{
\fI\%npm\fP
T}	T{
Installation of NPM Packages
T}
_
T{
\fI\%ntp\fP
T}	T{
Management of NTP servers
T}
_
T{
\fI\%nxos\fP
T}	T{
State module for Cisco NX\-OS Switch Proxy and Native minions
T}
_
T{
\fI\%nxos_upgrade\fP
T}	T{
Manage NX\-OS System Image Upgrades.
T}
_
T{
\fI\%openstack_config\fP
T}	T{
Manage OpenStack configuration file settings.
T}
_
T{
\fI\%openvswitch_bridge\fP
T}	T{
Management of Open vSwitch bridges.
T}
_
T{
\fI\%openvswitch_db\fP
T}	T{
Management of Open vSwitch database records.
T}
_
T{
\fI\%openvswitch_port\fP
T}	T{
Management of Open vSwitch ports.
T}
_
T{
\fI\%opsgenie\fP
T}	T{
Create/Close an alert in OpsGenie
T}
_
T{
\fI\%pagerduty\fP
T}	T{
Create an Event in PagerDuty
T}
_
T{
\fI\%pagerduty_escalation_policy\fP
T}	T{
Manage PagerDuty escalation policies.
T}
_
T{
\fI\%pagerduty_schedule\fP
T}	T{
Manage PagerDuty schedules.
T}
_
T{
\fI\%pagerduty_service\fP
T}	T{
Manage PagerDuty services
T}
_
T{
\fI\%pagerduty_user\fP
T}	T{
Manage PagerDuty users.
T}
_
T{
\fI\%panos\fP
T}	T{
A state module to manage Palo Alto network devices.
T}
_
T{
\fI\%pbm\fP
T}	T{
Manages VMware storage policies (called pbm because the vCenter endpoint is /pbm)
T}
_
T{
\fI\%pcs\fP
T}	T{
Management of Pacemaker/Corosync clusters with PCS
T}
_
T{
\fI\%pdbedit\fP
T}	T{
Manage accounts in Samba\(aqs passdb using pdbedit
T}
_
T{
\fI\%pecl\fP
T}	T{
Installation of PHP Extensions Using pecl
T}
_
T{
\fI\%pip_state\fP
T}	T{
Installation of Python Packages Using pip
T}
_
T{
\fI\%pkg\fP
T}	T{
Installation of packages using OS package managers such as yum or apt\-get
T}
_
T{
\fI\%pkgbuild\fP
T}	T{
The pkgbuild state is the front of Salt package building backend.
T}
_
T{
\fI\%pkgng\fP
T}	T{
Manage package remote repo using FreeBSD pkgng
T}
_
T{
\fI\%pkgrepo\fP
T}	T{
Management of APT/DNF/YUM/Zypper package repos
T}
_
T{
\fI\%portage_config\fP
T}	T{
Management of Portage package configuration on Gentoo
T}
_
T{
\fI\%ports\fP
T}	T{
Manage software from FreeBSD ports
T}
_
T{
\fI\%postgres_cluster\fP
T}	T{
Management of PostgreSQL clusters
T}
_
T{
\fI\%postgres_database\fP
T}	T{
Management of PostgreSQL databases
T}
_
T{
\fI\%postgres_extension\fP
T}	T{
Management of PostgreSQL extensions
T}
_
T{
\fI\%postgres_group\fP
T}	T{
Management of PostgreSQL groups (roles)
T}
_
T{
\fI\%postgres_initdb\fP
T}	T{
Initialization of PostgreSQL data directory
T}
_
T{
\fI\%postgres_language\fP
T}	T{
Management of PostgreSQL languages
T}
_
T{
\fI\%postgres_privileges\fP
T}	T{
Management of PostgreSQL Privileges
T}
_
T{
\fI\%postgres_schema\fP
T}	T{
Management of PostgreSQL schemas
T}
_
T{
\fI\%postgres_tablespace\fP
T}	T{
Management of PostgreSQL tablespace
T}
_
T{
\fI\%postgres_user\fP
T}	T{
Management of PostgreSQL users (roles)
T}
_
T{
\fI\%powerpath\fP
T}	T{
Powerpath configuration support
T}
_
T{
\fI\%probes\fP
T}	T{
Network Probes
T}
_
T{
\fI\%process\fP
T}	T{
Process Management
T}
_
T{
\fI\%proxy\fP
T}	T{
Allows you to manage proxy settings on minions
T}
_
T{
\fI\%pushover\fP
T}	T{
T}
_
T{
\fI\%pyenv\fP
T}	T{
Managing python installations with pyenv
T}
_
T{
\fI\%pyrax_queues\fP
T}	T{
Manage Rackspace Queues
T}
_
T{
\fI\%quota\fP
T}	T{
Management of POSIX Quotas
T}
_
T{
\fI\%rabbitmq_cluster\fP
T}	T{
Manage RabbitMQ Clusters
T}
_
T{
\fI\%rabbitmq_plugin\fP
T}	T{
Manage RabbitMQ Plugins
T}
_
T{
\fI\%rabbitmq_policy\fP
T}	T{
Manage RabbitMQ Policies
T}
_
T{
\fI\%rabbitmq_upstream\fP
T}	T{
Manage RabbitMQ Upstreams
T}
_
T{
\fI\%rabbitmq_user\fP
T}	T{
Manage RabbitMQ Users
T}
_
T{
\fI\%rabbitmq_vhost\fP
T}	T{
Manage RabbitMQ Virtual Hosts
T}
_
T{
\fI\%rbac_solaris\fP
T}	T{
Management of Solaris RBAC
T}
_
T{
\fI\%rbenv\fP
T}	T{
Managing Ruby installations with rbenv
T}
_
T{
\fI\%rdp\fP
T}	T{
Manage RDP Service on Windows servers
T}
_
T{
\fI\%redismod\fP
T}	T{
Management of Redis server
T}
_
T{
\fI\%reg\fP
T}	T{
Manage the Windows registry
T}
_
T{
\fI\%restconf\fP
T}	T{
RESTCONF State module for  Proxy minions
T}
_
T{
\fI\%rsync\fP
T}	T{
State to synchronize files and directories with rsync.
T}
_
T{
\fI\%rvm\fP
T}	T{
Managing Ruby installations and gemsets with Ruby Version Manager (RVM)
T}
_
T{
\fI\%salt_proxy\fP
T}	T{
Salt proxy state
T}
_
T{
\fI\%saltmod\fP
T}	T{
Control the Salt command interface
T}
_
T{
\fI\%saltutil\fP
T}	T{
Saltutil State
T}
_
T{
\fI\%schedule\fP
T}	T{
Management of the Salt scheduler
T}
_
T{
\fI\%selinux\fP
T}	T{
Management of SELinux rules
T}
_
T{
\fI\%serverdensity_device\fP
T}	T{
Monitor Server with Server Density
T}
_
T{
\fI\%service\fP
T}	T{
Starting or restarting of services and daemons
T}
_
T{
\fI\%slack\fP
T}	T{
Send a message to Slack
T}
_
T{
\fI\%smartos\fP
T}	T{
Management of SmartOS Standalone Compute Nodes
T}
_
T{
\fI\%smtp\fP
T}	T{
Sending Messages via SMTP
T}
_
T{
\fI\%snapper\fP
T}	T{
Managing implicit state and baselines using snapshots
T}
_
T{
\fI\%solrcloud\fP
T}	T{
States for solrcloud alias and collection configuration
T}
_
T{
\fI\%splunk\fP
T}	T{
Splunk User State Module
T}
_
T{
\fI\%splunk_search\fP
T}	T{
Splunk Search State Module
T}
_
T{
\fI\%sqlite3\fP
T}	T{
Management of SQLite3 databases
T}
_
T{
\fI\%ssh_auth\fP
T}	T{
Control of entries in SSH authorized_key files
T}
_
T{
\fI\%ssh_known_hosts\fP
T}	T{
Control of SSH known_hosts entries
T}
_
T{
\fI\%stateconf\fP
T}	T{
Stateconf System
T}
_
T{
\fI\%status\fP
T}	T{
Minion status monitoring
T}
_
T{
\fI\%statuspage\fP
T}	T{
StatusPage
T}
_
T{
\fI\%supervisord\fP
T}	T{
Interaction with the Supervisor daemon
T}
_
T{
\fI\%svn\fP
T}	T{
Manage SVN repositories
T}
_
T{
\fI\%sysctl\fP
T}	T{
Configuration of the kernel using sysctl
T}
_
T{
\fI\%sysfs\fP
T}	T{
Configuration of the kernel using sysfs
T}
_
T{
\fI\%syslog_ng\fP
T}	T{
State module for syslog_ng
T}
_
T{
\fI\%sysrc\fP
T}	T{
State to work with sysrc
T}
_
T{
\fI\%telemetry_alert\fP
T}	T{
Manage Telemetry alert configurations
T}
_
T{
\fI\%test\fP
T}	T{
Test States
T}
_
T{
\fI\%testinframod\fP
T}	T{
T}
_
T{
\fI\%timezone\fP
T}	T{
Management of timezones
T}
_
T{
\fI\%tls\fP
T}	T{
Enforce state for SSL/TLS
T}
_
T{
\fI\%tomcat\fP
T}	T{
Manage Apache Tomcat web applications
T}
_
T{
\fI\%trafficserver\fP
T}	T{
Control Apache Traffic Server
T}
_
T{
\fI\%tuned\fP
T}	T{
Interface to Red Hat tuned\-adm module
T}
_
T{
\fI\%uptime\fP
T}	T{
Monitor Web Server with Uptime
T}
_
T{
\fI\%user\fP
T}	T{
Management of user accounts.
T}
_
T{
\fI\%vagrant\fP
T}	T{
Manage Vagrant VMs
T}
_
T{
\fI\%vault\fP
T}	T{
T}
_
T{
\fI\%vbox_guest\fP
T}	T{
VirtualBox Guest Additions installer state
T}
_
T{
\fI\%victorops\fP
T}	T{
Create an Event in VictorOps
T}
_
T{
\fI\%virt\fP
T}	T{
Manage virt
T}
_
T{
\fI\%virtualenv_mod\fP
T}	T{
Setup of Python virtualenv sandboxes.
T}
_
T{
\fI\%webutil\fP
T}	T{
Support for htpasswd module.
T}
_
T{
\fI\%win_appx\fP
T}	T{
Manage Microsoft Store apps on Windows.
T}
_
T{
\fI\%win_certutil\fP
T}	T{
Installing of certificates to the Windows Certificate Manager
T}
_
T{
\fI\%win_dacl\fP
T}	T{
Windows Object Access Control Lists
T}
_
T{
\fI\%win_dism\fP
T}	T{
Installing of Windows features using DISM
T}
_
T{
\fI\%win_dns_client\fP
T}	T{
Module for configuring DNS Client on Windows systems
T}
_
T{
\fI\%win_firewall\fP
T}	T{
State for configuring Windows Firewall
T}
_
T{
\fI\%win_iis\fP
T}	T{
Microsoft IIS site management
T}
_
T{
\fI\%win_lgpo\fP
T}	T{
Manage Windows Local Group Policy
T}
_
T{
\fI\%win_lgpo_reg\fP
T}	T{
LGPO \- Registry.pol
T}
_
T{
\fI\%win_license\fP
T}	T{
Installation and activation of windows licenses
T}
_
T{
\fI\%win_network\fP
T}	T{
Configuration of network interfaces on Windows hosts
T}
_
T{
\fI\%win_path\fP
T}	T{
Manage the Windows System PATH
T}
_
T{
\fI\%win_pki\fP
T}	T{
Microsoft certificate management via the Pki PowerShell module.
T}
_
T{
\fI\%win_powercfg\fP
T}	T{
This module allows you to control the power settings of a windows minion via powercfg.
T}
_
T{
\fI\%win_servermanager\fP
T}	T{
Manage Windows features via the ServerManager powershell module.
T}
_
T{
\fI\%win_shortcut\fP
T}	T{
State module for creating shortcuts on Windows.
T}
_
T{
\fI\%win_smtp_server\fP
T}	T{
Module for managing IIS SMTP server configuration on Windows servers.
T}
_
T{
\fI\%win_snmp\fP
T}	T{
Module for managing SNMP service settings on Windows servers.
T}
_
T{
\fI\%win_system\fP
T}	T{
Management of Windows system information
T}
_
T{
\fI\%win_task\fP
T}	T{
State module for adding and removing scheduled tasks using the Windows Task Scheduler.
T}
_
T{
\fI\%win_wua\fP
T}	T{
Installation of Windows Updates using the Windows Update Agent
T}
_
T{
\fI\%win_wusa\fP
T}	T{
Microsoft Updates (KB) Management
T}
_
T{
\fI\%winrepo\fP
T}	T{
Manage Windows Package Repository
T}
_
T{
\fI\%wordpress\fP
T}	T{
This state module is used to manage Wordpress installations
T}
_
T{
\fI\%x509\fP
T}	T{
Manage X509 Certificates
T}
_
T{
\fI\%x509_v2\fP
T}	T{
Manage X.509 certificates
T}
_
T{
\fI\%xml\fP
T}	T{
XML Manager
T}
_
T{
\fI\%xmpp\fP
T}	T{
Sending Messages over XMPP
T}
_
T{
\fI\%zabbix_action\fP
T}	T{
T}
_
T{
\fI\%zabbix_host\fP
T}	T{
T}
_
T{
\fI\%zabbix_hostgroup\fP
T}	T{
T}
_
T{
\fI\%zabbix_mediatype\fP
T}	T{
T}
_
T{
\fI\%zabbix_template\fP
T}	T{
T}
_
T{
\fI\%zabbix_user\fP
T}	T{
T}
_
T{
\fI\%zabbix_usergroup\fP
T}	T{
T}
_
T{
\fI\%zabbix_usermacro\fP
T}	T{
T}
_
T{
\fI\%zabbix_valuemap\fP
T}	T{
T}
_
T{
\fI\%zcbuildout\fP
T}	T{
Management of zc.buildout
T}
_
T{
\fI\%zenoss\fP
T}	T{
State to manage monitoring in Zenoss.
T}
_
T{
\fI\%zfs\fP
T}	T{
States for managing zfs datasets
T}
_
T{
\fI\%zk_concurrency\fP
T}	T{
Control concurrency of steps within state execution using zookeeper
T}
_
T{
\fI\%zone\fP
T}	T{
Management of Solaris Zones
T}
_
T{
\fI\%zookeeper\fP
T}	T{
Zookeeper State
T}
_
T{
\fI\%zpool\fP
T}	T{
States for managing zpools
T}
_
.TE
.SS salt.states.acme
.SS ACME / Let\(aqs Encrypt certificate management state
.sp
New in version 2016.3.0.

.sp
See also the module documentation
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reload\-gitlab:
  cmd.run:
    \- name: gitlab\-ctl hup

dev.example.com:
  acme.cert:
    \- aliases:
      \- gitlab.example.com
    \- email: acmemaster@example.com
    \- webroot: /opt/gitlab/embedded/service/gitlab\-rails/public
    \- renew: 14
    \- fire_event: acme/dev.example.com
    \- onchanges_in:
      \- cmd: reload\-gitlab
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.acme.cert(name, aliases=None, email=None, webroot=None, test_cert=False, renew=None, keysize=None, server=None, owner=\(aqroot\(aq, group=\(aqroot\(aq, mode=\(aq0640\(aq, certname=None, preferred_challenges=None, tls_sni_01_port=None, tls_sni_01_address=None, http_01_port=None, http_01_address=None, dns_plugin=None, dns_plugin_credentials=None, manual_auth_hook=None, manual_cleanup_hook=None)
Obtain/renew a certificate from an ACME CA, probably Let\(aqs Encrypt.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Common Name of the certificate (DNS name of certificate)
.IP \(bu 2
\fBaliases\fP \-\- subjectAltNames (Additional DNS names on certificate)
.IP \(bu 2
\fBemail\fP \-\- e\-mail address for interaction with ACME provider
.IP \(bu 2
\fBwebroot\fP \-\- True or a full path to webroot. Otherwise use standalone mode
.IP \(bu 2
\fBtest_cert\fP \-\- Request a certificate from the Happy Hacker Fake CA (mutually exclusive with \(aqserver\(aq)
.IP \(bu 2
\fBrenew\fP \-\- True/\(aqforce\(aq to force a renewal, or a window of renewal before expiry in days
.IP \(bu 2
\fBkeysize\fP \-\- RSA key bits
.IP \(bu 2
\fBserver\fP \-\- API endpoint to talk to
.IP \(bu 2
\fBowner\fP \-\- owner of the private key file
.IP \(bu 2
\fBgroup\fP \-\- group of the private key file
.IP \(bu 2
\fBmode\fP \-\- mode of the private key file
.IP \(bu 2
\fBcertname\fP \-\- Name of the certificate to save
.IP \(bu 2
\fBpreferred_challenges\fP \-\- A sorted, comma delimited list of the preferred
challenge to use during authorization with the
most preferred challenge listed first.
.IP \(bu 2
\fBtls_sni_01_port\fP \-\- Port used during tls\-sni\-01 challenge. This only affects
the port Certbot listens on. A conforming ACME server
will still attempt to connect on port 443.
.IP \(bu 2
\fBtls_sni_01_address\fP \-\- The address the server listens to during tls\-sni\-01
challenge.
.IP \(bu 2
\fBhttp_01_port\fP \-\- Port used in the http\-01 challenge. This only affects
the port Certbot listens on. A conforming ACME server
will still attempt to connect on port 80.
.IP \(bu 2
\fBhttps_01_address\fP \-\- The address the server listens to during http\-01 challenge.
.IP \(bu 2
\fBdns_plugin\fP \-\- Name of a DNS plugin to use (currently only \(aqcloudflare\(aq)
.IP \(bu 2
\fBdns_plugin_credentials\fP \-\- Path to the credentials file if required by the specified DNS plugin
.IP \(bu 2
\fBmanual_auth_hook\fP \-\- Path to the authentication hook script.
.IP \(bu 2
\fBmanual_cleanup_hook\fP \-\- Path to the cleanup or post\-authentication hook script.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.alias
.sp
Configuration of email aliases
.sp
The mail aliases file can be managed to contain definitions for specific email
aliases:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
username:
  alias.present:
    \- target: user@example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
thomas:
  alias.present:
    \- target: thomas@example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The default alias file is set to \fB/etc/aliases\fP, as defined in Salt\(aqs
\fI\%config execution module\fP\&. To change the alias
file from the default location, set the following in your minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
aliases.file: /my/alias/file
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.alias.absent(name)
Ensure that the named alias is absent
.INDENT 7.0
.TP
.B name
The alias to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.alias.present(name, target)
Ensures that the named alias is present with the given target or list of
targets. If the alias exists but the target differs from the previous
entry, the target(s) will be overwritten. If the alias does not exist, the
alias will be created.
.INDENT 7.0
.TP
.B name
The local user/address to assign an alias to
.TP
.B target
The forwarding address
.UNINDENT
.UNINDENT
.SS salt.states.alternatives
.sp
Configuration of the alternatives system
.sp
Control the alternatives system
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set my_hadoop_conf = \(aq/opt/hadoop/conf\(aq %}

{{ my_hadoop_conf }}:
  file.directory

hadoop\-0.20\-conf:
  alternatives.install:
    \- name: hadoop\-0.20\-conf
    \- link: /etc/hadoop\-0.20/conf
    \- path: {{ my_hadoop_conf }}
    \- priority: 30
    \- require:
      \- file: {{ my_hadoop_conf }}

hadoop\-0.20\-conf:
  alternatives.remove:
    \- name: hadoop\-0.20\-conf
    \- path: {{ my_hadoop_conf }}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.alternatives.auto(name)
New in version 0.17.0.

.sp
Instruct alternatives to use the highest priority
path for <name>
.INDENT 7.0
.TP
.B name
is the master name for this link group
(e.g. pager)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.alternatives.install(name, link, path, priority)
Install new alternative for defined <name>
.INDENT 7.0
.TP
.B name
is the master name for this link group
(e.g. pager)
.TP
.B link
is the symlink pointing to /etc/alternatives/<name>.
(e.g. /usr/bin/pager)
.TP
.B path
is the location of the new alternative target.
NB: This file / directory must already exist.
(e.g. /usr/bin/less)
.TP
.B priority
is an integer; options with higher numbers have higher priority in
automatic mode.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.alternatives.remove(name, path)
Removes installed alternative for defined <name> and <path>
or fallback to default alternative, if some defined before.
.INDENT 7.0
.TP
.B name
is the master name for this link group
(e.g. pager)
.TP
.B path
is the location of one of the alternative target files.
(e.g. /usr/bin/less)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.alternatives.set_(name, path)
New in version 0.17.0.

.sp
Sets alternative for <name> to <path>, if <path> is defined
as an alternative for <name>.
.INDENT 7.0
.TP
.B name
is the master name for this link group
(e.g. pager)
.TP
.B path
is the location of one of the alternative target files.
(e.g. /usr/bin/less)
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  alternatives.set:
    \- path: /usr/bin/foo\-2.0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.ansiblegate
.SS Execution of Ansible modules from within states
.sp
With \fIansible.call\fP these states allow individual Ansible module calls to be
made via states. To call an Ansible module function use a \fBmodule.run\fP
state:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
some_set_of_tasks:
  ansible:
    \- system.ping
    \- packaging.os.zypper
      \- name: emacs
      \- state: installed
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.states.ansiblegate.AnsibleState
Ansible state caller.
.INDENT 7.0
.TP
.B get_args(argset)
Get args and kwargs from the argset.
.INDENT 7.0
.TP
.B Parameters
\fBargset\fP \-\-
.TP
.B Returns

.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ansiblegate.playbooks(name, rundir=None, git_repo=None, git_kwargs=None, ansible_kwargs=None)
Run Ansible Playbooks
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- path to playbook. This can be relative to rundir or the git repo
.IP \(bu 2
\fBrundir\fP \-\- location to run ansible\-playbook from.
.IP \(bu 2
\fBgit_repo\fP \-\- git repository to clone for ansible playbooks.  This is cloned
using the \fIgit.latest\fP state, and is cloned to the \fIrundir\fP
if specified, otherwise it is clone to the \fIcache_dir\fP
.IP \(bu 2
\fBgit_kwargs\fP \-\- extra kwargs to pass to \fIgit.latest\fP state module besides
the \fIname\fP and \fItarget\fP
.IP \(bu 2
\fBansible_kwargs\fP \-\- extra kwargs to pass to \fIansible.playbooks\fP execution
module besides the \fIname\fP and \fItarget\fP
.UNINDENT
.TP
.B Returns
Ansible playbook output.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
run nginx install:
  ansible.playbooks:
    \- name: install.yml
    \- git_repo: git://github.com/gituser/playbook.git
    \- git_kwargs:
        rev: master
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.apache
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%apache Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Apache state
.sp
New in version 2014.7.0.

.sp
Allows for inputting a yaml dictionary into a file for apache configuration
files.
.sp
The variable \fBthis\fP is special and signifies what should be included with
the above word between angle brackets (<>).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/httpd/conf.d/website.com.conf:
  apache.configfile:
    \- config:
      \- VirtualHost:
          this: \(aq*:80\(aq
          ServerName:
            \- website.com
          ServerAlias:
            \- www.website.com
            \- dev.website.com
          ErrorLog: logs/website.com\-error_log
          CustomLog: logs/website.com\-access_log combined
          DocumentRoot: /var/www/vhosts/website.com
          Directory:
            this: /var/www/vhosts/website.com
            Order: Deny,Allow
            Deny from: all
            Allow from:
              \- 127.0.0.1
              \- 192.168.100.0/24
            Options:
              \- Indexes
              \- FollowSymlinks
            AllowOverride: All
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2018.3.0.

.sp
Allows having the same section container multiple times (e.g. <Directory /path/to/dir>).
.sp
YAML structure stays the same only replace dictionary with a list.
.sp
When a section container does not have mandatory attribute, such as <Else>,
it still needs keyword \fBthis\fP with empty string (or \(dq\(dq if nicer output is required \- without space).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/httpd/conf.d/website.com.conf:
  apache.configfile:
    \- config:
      \- VirtualHost:
          \- this: \(aq*:80\(aq
          \- ServerName:
            \- website.com
          \- DocumentRoot: /var/www/vhosts/website.com
          \- Directory:
              this: /var/www/vhosts/website.com
              Order: Deny,Allow
              Deny from: all
              Allow from:
                \- 127.0.0.1
                \- 192.168.100.0/24
              Options:
                \- Indexes
                \- FollowSymlinks
              AllowOverride: All
          \- Directory:
            \- this: /var/www/vhosts/website.com/private
            \- Order: Deny,Allow
            \- Deny from: all
            \- Allow from:
              \- 127.0.0.1
              \- 192.168.100.0/24
            \- If:
                this: some condition
                do: something
            \- Else:
                this:
                do: something else
            \- Else:
                this: \(dq\(dq
                do: another thing
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.apache.configfile(name, config)
.UNINDENT
.SS salt.states.apache_conf
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%apache Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Manage Apache Confs
.sp
New in version 2016.3.0.

.sp
Enable and disable apache confs.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Enable security conf:
  apache_conf.enabled:
    \- name: security

Disable security conf:
  apache_conf.disabled:
    \- name: security
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.apache_conf.disabled(name)
Ensure an Apache conf is disabled.
.INDENT 7.0
.TP
.B name
Name of the Apache conf
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.apache_conf.enabled(name)
Ensure an Apache conf is enabled.
.INDENT 7.0
.TP
.B name
Name of the Apache conf
.UNINDENT
.UNINDENT
.SS salt.states.apache_module
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%apache Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Manage Apache Modules
.sp
New in version 2014.7.0.

.sp
Enable and disable apache modules.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Enable cgi module:
  apache_module.enabled:
    \- name: cgi

Disable cgi module:
  apache_module.disabled:
    \- name: cgi
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.apache_module.disabled(name)
Ensure an Apache module is disabled.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
Name of the Apache module
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.apache_module.enabled(name)
Ensure an Apache module is enabled.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
Name of the Apache module
.UNINDENT
.UNINDENT
.SS salt.states.apache_site
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%apache Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Manage Apache Sites
.sp
New in version 2016.3.0.

.sp
Enable and disable apache sites.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Enable default site:
  apache_site.enabled:
    \- name: default

Disable default site:
  apache_site.disabled:
    \- name: default
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.apache_site.disabled(name)
Ensure an Apache site is disabled.
.INDENT 7.0
.TP
.B name
Name of the Apache site
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.apache_site.enabled(name)
Ensure an Apache site is enabled.
.INDENT 7.0
.TP
.B name
Name of the Apache site
.UNINDENT
.UNINDENT
.SS salt.states.aptpkg
.SS Package management operations specific to APT\- and DEB\-based systems
.INDENT 0.0
.TP
.B salt.states.aptpkg.held(name)
Set package in \(aqhold\(aq state, meaning it will not be upgraded.
.INDENT 7.0
.TP
.B name
The name of the package, e.g., \(aqtmux\(aq
.UNINDENT
.UNINDENT
.SS salt.states.archive
.sp
Extract an archive
.sp
New in version 2014.1.0.

.INDENT 0.0
.TP
.B salt.states.archive.extracted(name, source, source_hash=None, source_hash_name=None, source_hash_update=False, skip_files_list_verify=False, skip_verify=False, password=None, options=None, list_options=None, force=False, overwrite=False, clean=False, clean_parent=False, user=None, group=None, if_missing=None, trim_output=False, use_cmd_unzip=None, extract_perms=True, enforce_toplevel=True, enforce_ownership_on=None, archive_format=None, use_etag=False, signature=None, source_hash_sig=None, signed_by_any=None, signed_by_all=None, keyring=None, gnupghome=None, **kwargs)
New in version 2014.1.0.

.sp
Changed in version 2016.11.0,3005: This state has been rewritten. Some arguments are new to this release
and will not be available in the 2016.3 release cycle (and earlier).
Additionally, the \fBZIP Archive Handling\fP section below applies
specifically to the 2016.11.0 release (and newer).

.sp
Ensure that an archive is extracted to a specific directory.
.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
\fBChanges for 2016.11.0\fP
.sp
In earlier releases, this state would rely on the \fBif_missing\fP
argument to determine whether or not the archive needed to be
extracted. When this argument was not passed, then the state would just
assume \fBif_missing\fP is the same as the \fBname\fP argument (i.e. the
parent directory into which the archive would be extracted).
.sp
This caused a number of annoyances. One such annoyance was the need to
know beforehand a path that would result from the extraction of the
archive, and setting \fBif_missing\fP to that directory, like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
extract_myapp:
  archive.extracted:
    \- name: /var/www
    \- source: salt://apps/src/myapp\-16.2.4.tar.gz
    \- user: www
    \- group: www
    \- if_missing: /var/www/myapp\-16.2.4
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If \fB/var/www\fP already existed, this would effectively make
\fBif_missing\fP a required argument, just to get Salt to extract the
archive.
.sp
Some users worked around this by adding the top\-level directory of the
archive to the end of the \fBname\fP argument, and then used \fB\-\-strip\fP
or \fB\-\-strip\-components\fP to remove that top\-level dir when extracting:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
extract_myapp:
  archive.extracted:
    \- name: /var/www/myapp\-16.2.4
    \- source: salt://apps/src/myapp\-16.2.4.tar.gz
    \- user: www
    \- group: www
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With the rewrite for 2016.11.0, these workarounds are no longer
necessary. \fBif_missing\fP is still a supported argument, but it is no
longer required. The equivalent SLS in 2016.11.0 would be:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
extract_myapp:
  archive.extracted:
    \- name: /var/www
    \- source: salt://apps/src/myapp\-16.2.4.tar.gz
    \- user: www
    \- group: www
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt now uses a function called \fBarchive.list\fP to get a list of files/directories in the
archive. Using this information, the state can now check the minion to
see if any paths are missing, and know whether or not the archive needs
to be extracted. This makes the \fBif_missing\fP argument unnecessary in
most use cases.
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
\fBZIP Archive Handling\fP
.sp
\fINote: this information applies to 2016.11.0 and later.\fP
.sp
Salt has two different functions for extracting ZIP archives:
.INDENT 0.0
.IP 1. 3
\fI\%archive.unzip\fP, which uses
Python\(aqs \fI\%zipfile\fP module to extract ZIP files.
.IP 2. 3
\fI\%archive.cmd_unzip\fP, which
uses the \fBunzip\fP CLI command to extract ZIP files.
.UNINDENT
.sp
Salt will prefer the use of \fI\%archive.cmd_unzip\fP when CLI options are specified (via
the \fBoptions\fP argument), and will otherwise prefer the
\fI\%archive.unzip\fP function. Use
of \fI\%archive.cmd_unzip\fP can be
forced however by setting the \fBuse_cmd_unzip\fP argument to \fBTrue\fP\&.
By contrast, setting this argument to \fBFalse\fP will force usage of
\fI\%archive.unzip\fP\&. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/var/www:
  archive.extracted:
    \- source: salt://foo/bar/myapp.zip
    \- use_cmd_unzip: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When \fBuse_cmd_unzip\fP is omitted, Salt will choose which extraction
function to use based on the source archive and the arguments passed to
the state. When in doubt, simply do not set this argument; it is
provided as a means of overriding the logic Salt uses to decide which
function to use.
.sp
There are differences in the features available in both extraction
functions. These are detailed below.
.INDENT 0.0
.IP \(bu 2
\fICommand\-line options\fP (only supported by \fI\%archive.cmd_unzip\fP) \- When the \fBoptions\fP argument is
used, \fI\%archive.cmd_unzip\fP
is the only function that can be used to extract the archive.
Therefore, if \fBuse_cmd_unzip\fP is specified and set to \fBFalse\fP,
and \fBoptions\fP is also set, the state will not proceed.
.IP \(bu 2
\fIPermissions\fP \- Due to an \fI\%upstream bug in Python\fP, permissions are
not preserved when the \fI\%zipfile\fP module is used to extract an archive.
As of the 2016.11.0 release, \fI\%archive.unzip\fP (as well as this state) has an
\fBextract_perms\fP argument which, when set to \fBTrue\fP (the default),
will attempt to match the permissions of the extracted
files/directories to those defined within the archive. To disable
this functionality and have the state not attempt to preserve the
permissions from the ZIP archive, set \fBextract_perms\fP to \fBFalse\fP:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
/var/www:
  archive.extracted:
    \- source: salt://foo/bar/myapp.zip
    \- extract_perms: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Directory into which the archive should be extracted
.TP
.B source
Archive to be extracted
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument uses the same syntax as its counterpart in the
\fI\%file.managed\fP state.
.UNINDENT
.UNINDENT
.TP
.B source_hash
Hash of source file, or file with list of hash\-to\-file mappings
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument uses the same syntax as its counterpart in the
\fI\%file.managed\fP state.
.UNINDENT
.UNINDENT
.sp
Changed in version 2016.11.0: If this argument specifies the hash itself, instead of a URI to a
file containing hashes, the hash type can now be omitted and Salt
will determine the hash type based on the length of the hash. For
example, both of the below states are now valid, while before only
the second one would be:

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo_app:
  archive.extracted:
    \- name: /var/www
    \- source: https://mydomain.tld/foo.tar.gz
    \- source_hash: 3360db35e682f1c5f9c58aa307de16d41361618c

bar_app:
  archive.extracted:
    \- name: /var/www
    \- source: https://mydomain.tld/bar.tar.gz
    \- source_hash: sha1=5edb7d584b82ddcbf76e311601f5d4442974aaa5
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B source_hash_name
When \fBsource_hash\fP refers to a hash file, Salt will try to find the
correct hash by matching the filename part of the \fBsource\fP URI. When
managing a file with a \fBsource\fP of \fBsalt://files/foo.tar.gz\fP, then
the following line in a hash file would match:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
acbd18db4cc2f85cedef654fccc4a4d8    foo.tar.gz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This line would also match:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
acbd18db4cc2f85cedef654fccc4a4d8    ./dir1/foo.tar.gz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, sometimes a hash file will include multiple similar paths:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
37b51d194a7513e45b56f6524f2d51f2    ./dir1/foo.txt
acbd18db4cc2f85cedef654fccc4a4d8    ./dir2/foo.txt
73feffa4b7f6bb68e44cf984c85f6e88    ./dir3/foo.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In cases like this, Salt may match the incorrect hash. This argument
can be used to tell Salt which filename to match, to ensure that the
correct hash is identified. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/var/www:
  archive.extracted:
    \- source: https://mydomain.tld/dir2/foo.tar.gz
    \- source_hash: https://mydomain.tld/hashes
    \- source_hash_name: ./dir2/foo.tar.gz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument must contain the full filename entry from the
checksum file, as this argument is meant to disambiguate matches
for multiple files that have the same basename. So, in the
example above, simply using \fBfoo.txt\fP would not match.
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.TP
.B source_hash_update
False
Set this to \fBTrue\fP if archive should be extracted if source_hash has
changed and there is a difference between the archive and the local files.
This would extract regardless of the \fBif_missing\fP parameter.
.sp
Note that this is only checked if the \fBsource\fP value has not changed.
If it has (e.g. to increment a version number in the path) then the
archive will not be extracted even if the hash has changed.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Setting this to \fBTrue\fP along with \fBkeep_source\fP set to \fBFalse\fP
will result the \fBsource\fP re\-download to do a archive file list check.
If it\(aqs not desirable please consider the \fBskip_files_list_verify\fP
argument.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.TP
.B skip_files_list_verify
False
Set this to \fBTrue\fP if archive should be extracted if \fBsource_hash\fP has
changed but only checksums of the archive will be checked to determine if
the extraction is required.
.sp
It will try to find a local cache of the \fBsource\fP and check its hash against
the \fBsource_hash\fP\&. If there is no local cache available, for example if you
set the \fBkeep_source\fP to \fBFalse\fP,  it will try to find a cached source hash
file in the Minion archives cache directory.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The current limitation of this logic is that you have to set
minions \fBhash_type\fP config option to the same one that you\(aqre going
to pass via \fBsource_hash\fP argument.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
With this argument set to \fBTrue\fP Salt will only check for the \fBsource_hash\fP
against the local hash of the \fBsourse\fP\&. So if you, for example, remove extracted
files without clearing the Salt Minion cache next time you execute the state Salt
will not notice that extraction is required if the hashes are still match.
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.TP
.B skip_verify
False
If \fBTrue\fP, hash verification of remote file sources (\fBhttp://\fP,
\fBhttps://\fP, \fBftp://\fP) will be skipped, and the \fBsource_hash\fP
argument will be ignored.
.sp
New in version 2016.3.4.

.TP
.B keep_source
True
For \fBsource\fP archives not local to the minion (i.e. from the Salt
fileserver or a remote source such as \fBhttp(s)\fP or \fBftp\fP), Salt
will need to download the archive to the minion cache before they can
be extracted. To remove the downloaded archive after extraction, set
this argument to \fBFalse\fP\&.
.sp
New in version 2017.7.3.

.TP
.B keep
True
Same as \fBkeep_source\fP, kept for backward\-compatibility.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If both \fBkeep_source\fP and \fBkeep\fP are used, \fBkeep\fP will be
ignored.
.UNINDENT
.UNINDENT
.TP
.B password
\fBFor ZIP archives only.\fP Password used for extraction.
.sp
New in version 2016.3.0.

.sp
Changed in version 2016.11.0: The newly\-added \fI\%archive.is_encrypted\fP function will be used to
determine if the archive is password\-protected. If it is, then the
\fBpassword\fP argument will be required for the state to proceed.

.TP
.B options
\fBFor tar and zip archives only.\fP  This option can be used to specify
a string of additional arguments to pass to the tar/zip command.
.sp
If this argument is not used, then the minion will attempt to use
Python\(aqs native \fI\%tarfile\fP/\fI\%zipfile\fP support to extract it. For zip
archives, this argument is mostly used to overwrite existing files with
\fBo\fP\&.
.sp
Using this argument means that the \fBtar\fP or \fBunzip\fP command will be
used, which is less platform\-independent, so keep this in mind when
using this option; the CLI options must be valid options for the
\fBtar\fP/\fBunzip\fP implementation on the minion\(aqs OS.
.sp
New in version 2016.11.0.

.sp
Changed in version 2015.8.11,2016.3.2: XZ\-compressed tar archives no longer require \fBJ\fP to manually be
set in the \fBoptions\fP, they are now detected automatically and
decompressed using the \fI\%xz\fP CLI command and extracted using \fBtar
xvf\fP\&. This is a more platform\-independent solution, as not all tar
implementations support the \fBJ\fP argument for extracting archives.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For tar archives, main operators like \fB\-x\fP, \fB\-\-extract\fP,
\fB\-\-get\fP, \fB\-c\fP and \fB\-f\fP/\fB\-\-file\fP should \fInot\fP be used here.
.UNINDENT
.UNINDENT
.TP
.B list_options
\fBFor tar archives only.\fP This state uses \fI\%archive.list\fP to discover the contents of the source
archive so that it knows which file paths should exist on the minion if
the archive has already been extracted. For the vast majority of tar
archives, \fI\%archive.list\fP \(dqjust
works\(dq. Archives compressed using gzip, bzip2, and xz/lzma (with the
help of the \fI\%xz\fP CLI command) are supported automatically. However, for
archives compressed using other compression types, CLI options must be
passed to \fI\%archive.list\fP\&.
.sp
This argument will be passed through to \fI\%archive.list\fP as its \fBoptions\fP argument, to allow it
to successfully list the archive\(aqs contents. For the vast majority of
archives, this argument should not need to be used, it should only be
needed in cases where the state fails with an error stating that the
archive\(aqs contents could not be listed.
.sp
New in version 2016.11.0.

.TP
.B force
False
If a path that should be occupied by a file in the extracted result is
instead a directory (or vice\-versa), the state will fail. Set this
argument to \fBTrue\fP to force these paths to be removed in order to
allow the archive to be extracted.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Use this option \fIvery\fP carefully.
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.TP
.B overwrite
False
Set this to \fBTrue\fP to force the archive to be extracted. This is
useful for cases where the filenames/directories have not changed, but
the content of the files have.
.sp
New in version 2016.11.1.

.TP
.B clean
False
Set this to \fBTrue\fP to remove any top\-level files and recursively
remove any top\-level directory paths before extracting.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Files will only be cleaned first if extracting the archive is
deemed necessary, either by paths missing on the minion, or if
\fBoverwrite\fP is set to \fBTrue\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.1.

.TP
.B clean_parent
False
If \fBTrue\fP, and the archive is extracted, delete the parent
directory (i.e. the directory into which the archive is extracted), and
then re\-create that directory before extracting. Note that \fBclean\fP
and \fBclean_parent\fP are mutually exclusive.
.sp
New in version 3000.

.TP
.B user
The user to own each extracted file. Not available on Windows.
.sp
New in version 2015.8.0.

.sp
Changed in version 2016.3.0: When used in combination with \fBif_missing\fP, ownership will only
be enforced if \fBif_missing\fP is a directory.

.sp
Changed in version 2016.11.0: Ownership will be enforced only on the file/directory paths found
by running \fI\%archive.list\fP on
the source archive. An alternative root directory on which to
enforce ownership can be specified using the
\fBenforce_ownership_on\fP argument.

.TP
.B group
The group to own each extracted file. Not available on Windows.
.sp
New in version 2015.8.0.

.sp
Changed in version 2016.3.0: When used in combination with \fBif_missing\fP, ownership will only
be enforced if \fBif_missing\fP is a directory.

.sp
Changed in version 2016.11.0: Ownership will be enforced only on the file/directory paths found
by running \fI\%archive.list\fP on
the source archive. An alternative root directory on which to
enforce ownership can be specified using the
\fBenforce_ownership_on\fP argument.

.TP
.B if_missing
If specified, this path will be checked, and if it exists then the
archive will not be extracted. This path can be either a directory or a
file, so this option can also be used to check for a semaphore file and
conditionally skip extraction.
.sp
Changed in version 2016.3.0: When used in combination with either \fBuser\fP or \fBgroup\fP,
ownership will only be enforced when \fBif_missing\fP is a directory.

.sp
Changed in version 2016.11.0: Ownership enforcement is no longer tied to this argument, it is
simply checked for existence and extraction will be skipped if
if is present.

.TP
.B trim_output
False
Useful for archives with many files in them. This can either be set to
\fBTrue\fP (in which case only the first 100 files extracted will be
in the state results), or it can be set to an integer for more exact
control over the max number of files to include in the state results.
.sp
New in version 2016.3.0.

.TP
.B use_cmd_unzip
False
Set to \fBTrue\fP for zip files to force usage of the
\fI\%archive.cmd_unzip\fP function
to extract.
.sp
New in version 2016.11.0.

.TP
.B extract_perms
True
\fBFor ZIP archives only.\fP When using \fI\%archive.unzip\fP to extract ZIP archives, Salt works
around an \fI\%upstream bug in Python\fP to set the permissions on extracted
files/directories to match those encoded into the ZIP archive. Set this
argument to \fBFalse\fP to skip this workaround.
.sp
New in version 2016.11.0.

.TP
.B enforce_toplevel
True
This option will enforce a single directory at the top level of the
source archive, to prevent extracting a \(aqtar\-bomb\(aq. Set this argument
to \fBFalse\fP to allow archives with files (or multiple directories) at
the top level to be extracted.
.sp
New in version 2016.11.0.

.TP
.B enforce_ownership_on
When \fBuser\fP or \fBgroup\fP is specified, Salt will default to enforcing
permissions on the file/directory paths detected by running
\fI\%archive.list\fP on the source
archive. Use this argument to specify an alternate directory on which
ownership should be enforced.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This path must be within the path specified by the \fBname\fP
argument.
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.TP
.B archive_format
One of \fBtar\fP, \fBzip\fP, or \fBrar\fP\&.
.sp
Changed in version 2016.11.0: If omitted, the archive format will be guessed based on the value
of the \fBsource\fP argument. If the minion is running a release
older than 2016.11.0, this option is required.

.UNINDENT
.INDENT 7.0
.TP
.B use_etag
If \fBTrue\fP, remote http/https file sources will attempt to use the
ETag header to determine if the remote file needs to be downloaded.
This provides a lightweight mechanism for promptly refreshing files
changed on a web server without requiring a full hash comparison via
the \fBsource_hash\fP parameter.
.sp
New in version 3005.

.TP
.B signature
Ensure a valid GPG signature exists on the selected \fBsource\fP file.
This needs to be a file URI retrievable by
\fI:py:func:\(gacp.cache_file <salt.modules.cp.cache_file>\fP which
identifies a detached signature.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A signature is only enforced directly after caching the file,
before it is extracted to its final destination. Existing files
at the target will never be modified.
.sp
It will be enforced regardless of source type.
.UNINDENT
.UNINDENT
.sp
New in version 3007.0.

.TP
.B source_hash_sig
When \fBsource\fP is a remote file source, \fBsource_hash\fP is a file,
\fBskip_verify\fP is not true and \fBuse_etag\fP is not true, ensure a
valid GPG signature exists on the source hash file.
Set this to \fBtrue\fP for an inline (clearsigned) signature, or to a
file URI retrievable by \fI:py:func:\(gacp.cache_file <salt.modules.cp.cache_file>\fP
for a detached one.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A signature on the \fBsource_hash\fP file is enforced regardless of
changes since its contents are used to check if an existing file
is in the correct state \- but only for remote sources!
As for \fBsignature\fP, existing target files will not be modified,
only the cached source_hash and source_hash_sig files will be removed.
.UNINDENT
.UNINDENT
.sp
New in version 3007.0.

.TP
.B signed_by_any
When verifying signatures either on the managed file or its source hash file,
require at least one valid signature from one of a list of key fingerprints.
This is passed to \fI\%gpg.verify\fP\&.
.sp
New in version 3007.0.

.TP
.B signed_by_all
When verifying signatures either on the managed file or its source hash file,
require a valid signature from each of the key fingerprints in this list.
This is passed to \fI\%gpg.verify\fP\&.
.sp
New in version 3007.0.

.TP
.B keyring
When verifying signatures, use this keyring.
.sp
New in version 3007.0.

.TP
.B gnupghome
When verifying signatures, use this GnuPG home.
.sp
New in version 3007.0.

.UNINDENT
.sp
\fBExamples\fP
.INDENT 7.0
.IP 1. 3
tar with lmza (i.e. xz) compression:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
graylog2\-server:
  archive.extracted:
    \- name: /opt/
    \- source: https://github.com/downloads/Graylog2/graylog2\-server/graylog2\-server\-0.9.6p1.tar.lzma
    \- source_hash: md5=499ae16dcae71eeb7c3a30c75ea7a1a6
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
tar archive with flag for verbose output, and enforcement of user/group
ownership:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
graylog2\-server:
  archive.extracted:
    \- name: /opt/
    \- source: https://github.com/downloads/Graylog2/graylog2\-server/graylog2\-server\-0.9.6p1.tar.gz
    \- source_hash: md5=499ae16dcae71eeb7c3a30c75ea7a1a6
    \- options: v
    \- user: foo
    \- group: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
tar archive, with \fBsource_hash_update\fP set to \fBTrue\fP to prevent
state from attempting extraction unless the \fBsource_hash\fP differs
from the previous time the archive was extracted:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
graylog2\-server:
  archive.extracted:
    \- name: /opt/
    \- source: https://github.com/downloads/Graylog2/graylog2\-server/graylog2\-server\-0.9.6p1.tar.lzma
    \- source_hash: md5=499ae16dcae71eeb7c3a30c75ea7a1a6
    \- source_hash_update: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.artifactory
.sp
This state downloads artifacts from artifactory.
.INDENT 0.0
.TP
.B salt.states.artifactory.downloaded(name, artifact, target_dir=\(aq/tmp\(aq, target_file=None, use_literal_group_id=False)
Ensures that the artifact from artifactory exists at given location. If it doesn\(aqt exist, then
it will be downloaded. If it already exists then the checksum of existing file is checked against checksum
in artifactory. If it is different then the step will fail.
.INDENT 7.0
.TP
.B artifact
Details of the artifact to be downloaded from artifactory. Various options are:
.INDENT 7.0
.IP \(bu 2
artifactory_url: URL of the artifactory instance
.IP \(bu 2
repository: Repository in artifactory
.IP \(bu 2
artifact_id: Artifact ID
.IP \(bu 2
group_id: Group ID
.IP \(bu 2
packaging: Packaging
.IP \(bu 2
classifier: Classifier
\&.. versionadded:: 2015.8.0
.IP \(bu 2
.INDENT 2.0
.TP
.B version: Version
One of the following:
\- Version to download
\- \fBlatest\fP \- Download the latest release of this artifact
\- \fBlatest_snapshot\fP \- Download the latest snapshot for this artifact
.UNINDENT
.IP \(bu 2
username: Artifactory username
\&.. versionadded:: 2015.8.0
.IP \(bu 2
password: Artifactory password
\&.. versionadded:: 2015.8.0
.UNINDENT
.TP
.B target_dir
Directory where the artifact should be downloaded. By default it is downloaded to /tmp directory.
.TP
.B target_file
Target file to download artifact to. By default file name is resolved by artifactory.
.UNINDENT
.sp
An example to download an artifact to a specific file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
jboss_module_downloaded:
  artifactory.downloaded:
   \- artifact:
       artifactory_url: http://artifactory.intranet.example.com/artifactory
       repository: \(aqlibs\-release\-local\(aq
       artifact_id: \(aqmodule\(aq
       group_id: \(aqcom.company.module\(aq
       packaging: \(aqjar\(aq
       classifier: \(aqsources\(aq
       version: \(aq1.0\(aq
   \- target_file: /opt/jboss7/modules/com/company/lib/module.jar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Download artifact to the folder (automatically resolves file name):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
jboss_module_downloaded:
  artifactory.downloaded:
   \- artifact:
        artifactory_url: http://artifactory.intranet.example.com/artifactory
        repository: \(aqlibs\-release\-local\(aq
        artifact_id: \(aqmodule\(aq
        group_id: \(aqcom.company.module\(aq
        packaging: \(aqjar\(aq
        classifier: \(aqsources\(aq
        version: \(aq1.0\(aq
   \- target_dir: /opt/jboss7/modules/com/company/lib
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.at
.SS Configuration disposable regularly scheduled tasks for at.
.sp
The at state can be add disposable regularly scheduled tasks for your system.
.INDENT 0.0
.TP
.B salt.states.at.absent(name, jobid=None, **kwargs)
Changed in version 2017.7.0.

.sp
Remove a job from queue
.INDENT 7.0
.TP
.B jobid: string|int
Specific jobid to remove
.TP
.B tag
string
Job\(aqs tag
.TP
.B runas
string
Runs user\-specified jobs
.TP
.B kwargs
Addition kwargs can be provided to filter jobs.
See output of \fIat.jobcheck\fP for more.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
example1:
  at.absent:
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
this will remove all jobs!
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
example2:
  at.absent:
    \- year: 13
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
example3:
  at.absent:
    \- tag: rose
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
example4:
  at.absent:
    \- tag: rose
    \- day: 13
    \- hour: 16
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
example5:
  at.absent:
    \- jobid: 4
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.at.mod_watch(name, **kwargs)
The at watcher, called to invoke the watch command.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state exists to support special handling of the \fBwatch\fP
\fI\%requisite\fP\&. It should not be called directly.
.sp
Parameters for this function should be set by the state being triggered.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the atjob
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.at.present(name, timespec, tag=None, user=None, job=None, unique_tag=False)
Changed in version 2017.7.0.

.sp
Add a job to queue.
.INDENT 7.0
.TP
.B job
string
Command to run.
.TP
.B timespec
string
The \(aqtimespec\(aq follows the format documented in the at(1) manpage.
.TP
.B tag
string
Make a tag for the job.
.TP
.B user
string
The user to run the at job
\&.. versionadded:: 2014.1.4
.TP
.B unique_tag
boolean
If set to True job will not be added if a job with the tag exists.
\&.. versionadded:: 2017.7.0
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
rose:
  at.present:
    \- job: \(aqecho \(dqI love saltstack\(dq > love\(aq
    \- timespec: \(aq9:09 11/09/13\(aq
    \- tag: love
    \- user: jam
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.at.watch(name, timespec, tag=None, user=None, job=None, unique_tag=False)
New in version 2017.7.0.

.sp
Add an at job if trigger by watch
.INDENT 7.0
.TP
.B job
string
Command to run.
.TP
.B timespec
string
The \(aqtimespec\(aq follows the format documented in the at(1) manpage.
.TP
.B tag
string
Make a tag for the job.
.TP
.B user
string
The user to run the at job
\&.. versionadded:: 2014.1.4
.TP
.B unique_tag
boolean
If set to True job will not be added if a job with the tag exists.
\&.. versionadded:: 2017.7.0
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
minion_restart:
  at.watch:
    \- job: \(aqsalt\-call \-\-local service.restart salt\-minion\(aq
    \- timespec: \(aqnow +1 min\(aq
    \- tag: minion_restart
    \- unique_tag: trye
    \- watch:
        \- file: /etc/salt/minion
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.augeas
.sp
Configuration management using Augeas
.sp
New in version 0.17.0.

.sp
This state requires the \fBaugeas\fP Python module.
.sp
\fI\%Augeas\fP can be used to manage configuration files.
.INDENT 0.0
.TP
.B salt.states.augeas.change(name, context=None, changes=None, lens=None, load_path=None, **kwargs)
New in version 2014.7.0.

.sp
This state replaces \fBsetvalue()\fP\&.
.sp
Issue changes to Augeas, optionally for a specific context, with a
specific lens.
.INDENT 7.0
.TP
.B name
State name
.TP
.B context
A file path, prefixed by \fB/files\fP\&. Should resolve to an actual file
(not an arbitrary augeas path). This is used to avoid duplicating the
file name for each item in the changes list (for example, \fBset bind 0.0.0.0\fP
in the example below operates on the file specified by \fBcontext\fP). If
\fBcontext\fP is not specified, a file path prefixed by \fB/files\fP should be
included with the \fBset\fP command.
.sp
The file path is examined to determine if the
specified changes are already present.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
redis\-conf:
  augeas.change:
    \- context: /files/etc/redis/redis.conf
    \- changes:
      \- set bind 0.0.0.0
      \- set maxmemory 1G
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B changes
List of changes that are issued to Augeas. Available commands are
\fBset\fP, \fBsetm\fP, \fBmv\fP/\fBmove\fP, \fBins\fP/\fBinsert\fP, and
\fBrm\fP/\fBremove\fP\&.
.TP
.B lens
The lens to use, needs to be suffixed with \fI\&.lns\fP, e.g.: \fINginx.lns\fP\&.
See the \fI\%list of stock lenses\fP
shipped with Augeas.
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B load_path
A list of directories that modules should be searched in. This is in
addition to the standard load path and the directories in
AUGEAS_LENS_LIB.
.UNINDENT
.sp
Usage examples:
.sp
Set the \fBbind\fP parameter in \fB/etc/redis/redis.conf\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
redis\-conf:
  augeas.change:
    \- changes:
      \- set /files/etc/redis/redis.conf/bind 0.0.0.0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Use the \fBcontext\fP parameter to specify the file you want to
manipulate. This way you don\(aqt have to include this in the changes
every time:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
redis\-conf:
  augeas.change:
    \- context: /files/etc/redis/redis.conf
    \- changes:
      \- set bind 0.0.0.0
      \- set databases 4
      \- set maxmemory 1G
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Augeas is aware of a lot of common configuration files and their syntax.
It knows the difference between for example ini and yaml files, but also
files with very specific syntax, like the hosts file. This is done with
\fIlenses\fP, which provide mappings between the Augeas tree and the file.
.sp
There are many \fI\%preconfigured lenses\fP that come with Augeas by default,
and they specify the common locations for configuration files. So most
of the time Augeas will know how to manipulate a file. In the event that
you need to manipulate a file that Augeas doesn\(aqt know about, you can
specify the lens to use like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
redis\-conf:
  augeas.change:
    \- lens: redis.lns
    \- context: /files/etc/redis/redis.conf
    \- changes:
      \- set bind 0.0.0.0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Even though Augeas knows that \fB/etc/redis/redis.conf\fP is a Redis
configuration file and knows how to parse it, it is recommended to
specify the lens anyway. This is because by default, Augeas loads all
known lenses and their associated file paths. All these files are
parsed when Augeas is loaded, which can take some time. When specifying
a lens, Augeas is loaded with only that lens, which speeds things up
quite a bit.
.UNINDENT
.UNINDENT
.sp
A more complex example, this adds an entry to the services file for Zabbix,
and removes an obsolete service:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zabbix\-service:
  augeas.change:
    \- lens: services.lns
    \- context: /files/etc/services
    \- changes:
      \- ins service\-name after service\-name[last()]
      \- set service\-name[last()] \(dqzabbix\-agent\(dq
      \- set \(dqservice\-name[. = \(aqzabbix\-agent\(aq]/port\(dq 10050
      \- set \(dqservice\-name[. = \(aqzabbix\-agent\(aq]/protocol\(dq tcp
      \- set \(dqservice\-name[. = \(aqzabbix\-agent\(aq]/#comment\(dq \(dqZabbix Agent service\(dq
      \- rm \(dqservice\-name[. = \(aqim\-obsolete\(aq]\(dq
    \- unless: grep \(aq^zabbix\-agent\es\(aq /etc/services
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Don\(aqt forget the \fBunless\fP here, otherwise it will fail on next runs
because the service is already defined. Additionally you have to quote
lines containing \fBservice\-name[. = \(aqzabbix\-agent\(aq]\fP otherwise
\fI\%augeas_cfg\fP execute will fail because
it will receive more parameters than expected.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Order is important when defining a service with Augeas, in this case
it\(aqs \fBport\fP, \fBprotocol\fP and \fB#comment\fP\&. For more info about
the lens check \fI\%services lens documentation\fP\&.
.UNINDENT
.UNINDENT
.sp
\fI\%http://augeas.net/docs/references/lenses/files/services\-aug.html#Services.record\fP
.UNINDENT
.SS salt.states.aws_sqs
.sp
Manage SQS Queues
.sp
Create and destroy SQS queues. Be aware that this interacts with Amazon\(aqs
services, and so may incur charges.
.sp
This module uses the awscli tool provided by Amazon. This can be downloaded
from pip. Also check the documentation for awscli for configuration
information.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myqueue:
    aws_sqs.exists:
        \- region: eu\-west\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.aws_sqs.absent(name, region, user=None, opts=False)
Remove the named SQS queue if it exists.
.INDENT 7.0
.TP
.B name
Name of the SQS queue.
.TP
.B region
Region to remove the queue from
.TP
.B user
Name of the user performing the SQS operations
.TP
.B opts
Include additional arguments and options to the aws command line
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.aws_sqs.exists(name, region, user=None, opts=False)
Ensure the SQS queue exists.
.INDENT 7.0
.TP
.B name
Name of the SQS queue.
.TP
.B region
Region to create the queue
.TP
.B user
Name of the user performing the SQS operations
.TP
.B opts
Include additional arguments and options to the aws command line
.UNINDENT
.UNINDENT
.SS salt.states.beacon
.SS Management of the Salt beacons
.sp
New in version 2015.8.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ps:
  beacon.present:
    \- save: True
    \- enable: False
    \- services:
        salt\-master: running
        apache2: stopped

sh:
  beacon.present: []

load:
  beacon.present:
    \- averages:
        1m:
          \- 0.0
          \- 2.0
        5m:
          \- 0.0
          \- 1.5
        15m:
          \- 0.1
          \- 1.0

\&.. versionadded:: 3000

Beginning in the 3000 release, multiple copies of a beacon can be configured
using the \(ga\(gabeacon_module\(ga\(ga parameter.

inotify_infs:
  beacon.present:
    \- save: True
    \- enable: True
    \- files:
       /etc/infs.conf:
         mask:
           \- create
           \- delete
           \- modify
         recurse: True
         auto_add: True
    \- interval: 10
    \- beacon_module: inotify
    \- disable_during_state_run: True

inotify_ntp:
  beacon.present:
    \- save: True
    \- enable: True
    \- files:
       /etc/ntp.conf:
         mask:
           \- create
           \- delete
           \- modify
         recurse: True
         auto_add: True
    \- interval: 10
    \- beacon_module: inotify
    \- disable_during_state_run: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.beacon.absent(name, save=False, **kwargs)
Ensure beacon is absent.
.INDENT 7.0
.TP
.B name
The name of the beacon that is ensured absent.
.TP
.B save
True/False, if True the beacons.conf file be updated too. Default is False.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
remove_beacon:
  beacon.absent:
    \- name: ps
    \- save: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.beacon.disabled(name, **kwargs)
Disable a beacon.
.INDENT 7.0
.TP
.B name
The name of the beacon to disable.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
disable_beacon:
  beacon.disabled:
    \- name: psp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.beacon.enabled(name, **kwargs)
Enable a beacon.
.INDENT 7.0
.TP
.B name
The name of the beacon to enable.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
enable_beacon:
  beacon.enabled:
    \- name: ps
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.beacon.present(name, save=False, **kwargs)
Ensure beacon is configured with the included beacon data.
.INDENT 7.0
.TP
.B name
The name of the beacon to ensure is configured.
.TP
.B save
True/False, if True the beacons.conf file be updated too. Default is False.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ps_beacon:
  beacon.present:
    \- name: ps
    \- save: True
    \- enable: False
    \- services:
        salt\-master: running
        apache2: stopped
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.bigip
.INDENT 0.0
.TP
.B A state module designed to enforce load\-balancing configurations for F5 Big\-IP entities.
.INDENT 7.0
.TP
.B maturity
develop
.TP
.B platform
f5_bigip_11.6
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.add_pool_member(hostname, username, password, name, member)
A function to connect to a bigip device and add a new member to an existing pool.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool to modify
.TP
.B member
The member to add to the pool
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.create_monitor(hostname, username, password, monitor_type, name, **kwargs)
A function to connect to a bigip device and create a monitor.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B monitor_type
The type of monitor to create
.TP
.B name
The name of the monitor to create
.TP
.B kwargs
[ arg=val ] ...
.sp
Consult F5 BIGIP user guide for specific options for each monitor type.
Typically, tmsh arg names are used.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.create_node(hostname, username, password, name, address)
Create a new node if it does not already exist.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the node to create
.TP
.B address
The address of the node
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.create_pool(hostname, username, password, name, members=None, allow_nat=None, allow_snat=None, description=None, gateway_failsafe_device=None, ignore_persisted_weight=None, ip_tos_to_client=None, ip_tos_to_server=None, link_qos_to_client=None, link_qos_to_server=None, load_balancing_mode=None, min_active_members=None, min_up_members=None, min_up_members_action=None, min_up_members_checking=None, monitor=None, profiles=None, queue_depth_limit=None, queue_on_connection_limit=None, queue_time_limit=None, reselect_tries=None, service_down_action=None, slow_ramp_time=None)
Create a new node if it does not already exist.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool to create
.TP
.B members
List of members to be added to the pool
.TP
.B allow_nat
[yes | no]
.TP
.B allow_snat
[yes | no]
.TP
.B description
[string]
.TP
.B gateway_failsafe_device
[string]
.TP
.B ignore_persisted_weight
[enabled | disabled]
.TP
.B ip_tos_to_client
[pass\-through | [integer]]
.TP
.B ip_tos_to_server
[pass\-through | [integer]]
.TP
.B link_qos_to_client
[pass\-through | [integer]]
.TP
.B link_qos_to_server
[pass\-through | [integer]]
.TP
.B load_balancing_mode
[dynamic\-ratio\-member | dynamic\-ratio\-node |
fastest\-app\-response | fastest\-node |
least\-connections\-members |
least\-connections\-node |
least\-sessions |
observed\-member | observed\-node |
predictive\-member | predictive\-node |
ratio\-least\-connections\-member |
ratio\-least\-connections\-node |
ratio\-member | ratio\-node | ratio\-session |
round\-robin | weighted\-least\-connections\-member |
weighted\-least\-connections\-node]
.TP
.B min_active_members
[integer]
.TP
.B min_up_members
[integer]
.TP
.B min_up_members_action
[failover | reboot | restart\-all]
.TP
.B min_up_members_checking
[enabled | disabled]
.TP
.B monitor
[name]
.TP
.B profiles
[none | profile_name]
.TP
.B queue_depth_limit
[integer]
.TP
.B queue_on_connection_limit
[enabled | disabled]
.TP
.B queue_time_limit
[integer]
.TP
.B reselect_tries
[integer]
.TP
.B service_down_action
[drop | none | reselect | reset]
.TP
.B slow_ramp_time
[integer]
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.create_profile(hostname, username, password, profile_type, name, **kwargs)
A function to connect to a bigip device and create a profile.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B profile_type
The type of profile to create
.TP
.B name
The name of the profile to create
.TP
.B kwargs
[ arg=val ] ...
.sp
Consult F5 BIGIP user guide for specific options for each profile type.
Typically, tmsh arg names are used.
.UNINDENT
.sp
Special Characters \fB|\fP, \fB,\fP and \fB:\fP must be escaped using \fB\e\fP when
used within strings.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.create_virtual(hostname, username, password, name, destination, pool=None, address_status=None, auto_lasthop=None, bwc_policy=None, cmp_enabled=None, connection_limit=None, dhcp_relay=None, description=None, fallback_persistence=None, flow_eviction_policy=None, gtm_score=None, ip_forward=None, ip_protocol=None, internal=None, twelve_forward=None, last_hop_pool=None, mask=None, mirror=None, nat64=None, persist=None, profiles=None, policies=None, rate_class=None, rate_limit=None, rate_limit_mode=None, rate_limit_dst=None, rate_limit_src=None, rules=None, related_rules=None, reject=None, source=None, source_address_translation=None, source_port=None, virtual_state=None, traffic_classes=None, translate_address=None, translate_port=None, vlans=None)
A function to connect to a bigip device and create a virtual server if it does not already exists.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the virtual to create
.TP
.B destination
[ [virtual_address_name:port] | [ipv4:port] | [ipv6.port] ]
.TP
.B pool
[ [pool_name] | none]
.TP
.B address_status
[yes | no]
.TP
.B auto_lasthop
[default | enabled | disabled ]
.TP
.B bwc_policy
[none] | string]
.TP
.B cmp_enabled
[yes | no]
.TP
.B dhcp_relay
[yes | no}
.TP
.B connection_limit
[integer]
.TP
.B description
[string]
.TP
.B state
[disabled | enabled]
.TP
.B fallback_persistence
[none | [profile name] ]
.TP
.B flow_eviction_policy
[none | [eviction policy name] ]
.TP
.B gtm_score
[integer]
.TP
.B ip_forward
[yes | no]
.TP
.B ip_protocol
[any | protocol]
.TP
.B internal
[yes | no]
.TP
.B twelve_forward(12\-forward)
[yes | no]
.TP
.B last_hop\-pool
[ [pool_name] | none]
.TP
.B mask
{ [ipv4] | [ipv6] }
.TP
.B mirror
{ [disabled | enabled | none] }
.TP
.B nat64
[enabled | disabled]
.TP
.B persist
[list]
.TP
.B profiles
[none | default | list ]
.TP
.B policies
[none | default | list ]
.TP
.B rate_class
[name]
.TP
.B rate_limit
[integer]
.TP
.B rate_limit\-mode
[destination | object | object\-destination |
object\-source | object\-source\-destination |
source | source\-destination]
.TP
.B rate_limit\-dst
[integer]
.TP
.B rate_limit\-src
[integer]
.TP
.B rules
[none | list ]
.TP
.B related_rules
[none | list ]
.TP
.B reject
[yes | no]
.TP
.B source
{ [ipv4[/prefixlen]] | [ipv6[/prefixlen]] }
.TP
.B source_address_translation
[none | snat:pool_name | lsn | automap | dictionary ]
.TP
.B source_port
[change | preserve | preserve\-strict]
.TP
.B state
[enabled | disabled]
.TP
.B traffic_classes
[none | default | list ]
.TP
.B translate_address
[enabled | disabled]
.TP
.B translate_port
[enabled | disabled]
.TP
.B vlans
[none | default | dictionary]
.INDENT 7.0
.TP
.B vlan_ids
[ list]
.TP
.B enabled
[ true | false ]
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.delete_monitor(hostname, username, password, monitor_type, name)
Modify an existing monitor.  If it does exists, only
the parameters specified will be enforced.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B monitor_type
The type of monitor to create
.TP
.B name
The name of the monitor to create
.TP
.B kwargs
[ arg=val ] ...
.sp
Consult F5 BIGIP user guide for specific options for each monitor type.
Typically, tmsh arg names are used.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.delete_node(hostname, username, password, name)
Delete an existing node.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the node which will be deleted.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.delete_pool(hostname, username, password, name)
Delete an existing pool.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool which will be deleted
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.delete_pool_member(hostname, username, password, name, member)
Delete an existing pool member.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool to be modified
.TP
.B member
The name of the member to delete from the pool
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.delete_profile(hostname, username, password, profile_type, name)
Modify an existing profile.  If it does exists, only
the parameters specified will be enforced.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B profile_type
The type of profile to create
.TP
.B name
The name of the profile to create
.TP
.B kwargs
[ arg=val ] ...
.sp
Consult F5 BIGIP user guide for specific options for each profile type.
Typically, tmsh arg names are used.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.delete_virtual(hostname, username, password, name)
Delete an existing virtual.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the virtual which will be deleted
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.list_monitor(hostname, username, password, monitor_type, name)
A function to list an existing monitor.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B monitor_type
The type of monitor to list
.TP
.B name
The name of the monitor to list
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.list_node(hostname, username, password, name)
A function to connect to a bigip device and list a specific node.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the node to list.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.list_pool(hostname, username, password, name)
A function to connect to a bigip device and list a specific pool.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool to list.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.list_profile(hostname, username, password, profile_type, name)
A function to list an existing profile.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B profile_type
The type of profile to list
.TP
.B name
The name of the profile to list
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.list_virtual(hostname, username, password, name)
A function to list a specific virtual.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the virtual to list
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.manage_monitor(hostname, username, password, monitor_type, name, **kwargs)
Create a new monitor if a monitor of this type and name does not already exists.  If it does exists, only
the parameters specified will be enforced.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B monitor_type
The type of monitor to create
.TP
.B name
The name of the monitor to create
.TP
.B kwargs
[ arg=val ] ...
.sp
Consult F5 BIGIP user guide for specific options for each monitor type.
Typically, tmsh arg names are used.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.manage_node(hostname, username, password, name, address, connection_limit=None, description=None, dynamic_ratio=None, logging=None, monitor=None, rate_limit=None, ratio=None, session=None, node_state=None)
Manages a node of a given bigip device.  If the node does not exist it will be created, otherwise,
only the properties which are different than the existing will be updated.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the node to manage.
.TP
.B address
The address of the node
.TP
.B connection_limit
[integer]
.TP
.B description
[string]
.TP
.B dynam
c_ratio:        [integer]
.TP
.B logging
[enabled | disabled]
.TP
.B monitor
[[name] | none | default]
.TP
.B rate_limit
[integer]
.TP
.B ratio
[integer]
.TP
.B session
[user\-enabled | user\-disabled]
.TP
.B node_state (state)
[user\-down | user\-up ]
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.manage_pool(hostname, username, password, name, allow_nat=None, allow_snat=None, description=None, gateway_failsafe_device=None, ignore_persisted_weight=None, ip_tos_to_client=None, ip_tos_to_server=None, link_qos_to_client=None, link_qos_to_server=None, load_balancing_mode=None, min_active_members=None, min_up_members=None, min_up_members_action=None, min_up_members_checking=None, monitor=None, profiles=None, queue_depth_limit=None, queue_on_connection_limit=None, queue_time_limit=None, reselect_tries=None, service_down_action=None, slow_ramp_time=None)
Create a new pool if it does not already exist. Pool members are managed separately. Only the
parameters specified are enforced.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool to create
.TP
.B allow_nat
[yes | no]
.TP
.B allow_snat
[yes | no]
.TP
.B description
[string]
.TP
.B gateway_failsafe_device
[string]
.TP
.B ignore_persisted_weight
[enabled | disabled]
.TP
.B ip_tos_to_client
[pass\-through | [integer]]
.TP
.B ip_tos_to_server
[pass\-through | [integer]]
.TP
.B link_qos_to_client
[pass\-through | [integer]]
.TP
.B link_qos_to_server
[pass\-through | [integer]]
.TP
.B load_balancing_mode
[dynamic\-ratio\-member | dynamic\-ratio\-node |
fastest\-app\-response | fastest\-node |
least\-connections\-members |
least\-connections\-node |
least\-sessions |
observed\-member | observed\-node |
predictive\-member | predictive\-node |
ratio\-least\-connections\-member |
ratio\-least\-connections\-node |
ratio\-member | ratio\-node | ratio\-session |
round\-robin | weighted\-least\-connections\-member |
weighted\-least\-connections\-node]
.TP
.B min_active_members
[integer]
.TP
.B min_up_members
[integer]
.TP
.B min_up_members_action
[failover | reboot | restart\-all]
.TP
.B min_up_members_checking
[enabled | disabled]
.TP
.B monitor
[name]
.TP
.B profiles
[none | profile_name]
.TP
.B queue_depth_limit
[integer]
.TP
.B queue_on_connection_limit
[enabled | disabled]
.TP
.B queue_time_limit
[integer]
.TP
.B reselect_tries
[integer]
.TP
.B service_down_action
[drop | none | reselect | reset]
.TP
.B slow_ramp_time
[integer]
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.manage_pool_members(hostname, username, password, name, members)
Manage the members of an existing pool.  This function replaces all current pool members.
Only the parameters specified are enforced.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool to modify
.TP
.B members
list of pool members to manage.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.manage_profile(hostname, username, password, profile_type, name, **kwargs)
Create a new profile if a monitor of this type and name does not already exists.  If it does exists, only
the parameters specified will be enforced.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B profile_type
The type of profile to create
.TP
.B name
The name of the profile to create
.TP
.B kwargs
[ arg=val ] ...
.sp
Consult F5 BIGIP user guide for specific options for each profile type.
Typically, tmsh arg names are used.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.manage_virtual(hostname, username, password, name, destination, pool=None, address_status=None, auto_lasthop=None, bwc_policy=None, cmp_enabled=None, connection_limit=None, dhcp_relay=None, description=None, fallback_persistence=None, flow_eviction_policy=None, gtm_score=None, ip_forward=None, ip_protocol=None, internal=None, twelve_forward=None, last_hop_pool=None, mask=None, mirror=None, nat64=None, persist=None, profiles=None, policies=None, rate_class=None, rate_limit=None, rate_limit_mode=None, rate_limit_dst=None, rate_limit_src=None, rules=None, related_rules=None, reject=None, source=None, source_address_translation=None, source_port=None, virtual_state=None, traffic_classes=None, translate_address=None, translate_port=None, vlans=None)
Manage a virtual server.  If a virtual does not exists it will be created, otherwise only the
parameters specified will be enforced.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the virtual to create
.TP
.B destination
[ [virtual_address_name:port] | [ipv4:port] | [ipv6.port] ]
.TP
.B pool
[ [pool_name] | none]
.TP
.B address_status
[yes | no]
.TP
.B auto_lasthop
[default | enabled | disabled ]
.TP
.B bwc_policy
[none] | string]
.TP
.B cmp_enabled
[yes | no]
.TP
.B dhcp_relay
[yes | no}
.TP
.B connection_limit
[integer]
.TP
.B description
[string]
.TP
.B state
[disabled | enabled]
.TP
.B fallback_persistence
[none | [profile name] ]
.TP
.B flow_eviction_policy
[none | [eviction policy name] ]
.TP
.B gtm_score
[integer]
.TP
.B ip_forward
[yes | no]
.TP
.B ip_protocol
[any | protocol]
.TP
.B internal
[yes | no]
.TP
.B twelve_forward(12\-forward)
[yes | no]
.TP
.B last_hop\-pool
[ [pool_name] | none]
.TP
.B mask
{ [ipv4] | [ipv6] }
.TP
.B mirror
{ [disabled | enabled | none] }
.TP
.B nat64
[enabled | disabled]
.TP
.B persist
[list]
.TP
.B profiles
[none | default | list ]
.TP
.B policies
[none | default | list ]
.TP
.B rate_class
[name]
.TP
.B rate_limit
[integer]
.TP
.B rate_limit\-mode
[destination | object | object\-destination |
object\-source | object\-source\-destination |
source | source\-destination]
.TP
.B rate_limit\-dst
[integer]
.TP
.B rate_limit\-src
[integer]
.TP
.B rules
[none | list ]
.TP
.B related_rules
[none | list ]
.TP
.B reject
[yes | no]
.TP
.B source
{ [ipv4[/prefixlen]] | [ipv6[/prefixlen]] }
.TP
.B source_address_translation
[none | snat:pool_name | lsn | automap | dictionary ]
.TP
.B source_port
[change | preserve | preserve\-strict]
.TP
.B state
[enabled | disabled]
.TP
.B traffic_classes
[none | default | list ]
.TP
.B translate_address
[enabled | disabled]
.TP
.B translate_port
[enabled | disabled]
.TP
.B vlans
[none | default | dictionary]
.INDENT 7.0
.TP
.B vlan_ids
[ list]
.TP
.B enabled
[ true | false ]
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.modify_monitor(hostname, username, password, monitor_type, name, **kwargs)
Modify an existing monitor.  If it does exists, only
the parameters specified will be enforced.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B monitor_type
The type of monitor to create
.TP
.B name
The name of the monitor to create
.TP
.B kwargs
[ arg=val ] ...
.sp
Consult F5 BIGIP user guide for specific options for each monitor type.
Typically, tmsh arg names are used.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.modify_node(hostname, username, password, name, connection_limit=None, description=None, dynamic_ratio=None, logging=None, monitor=None, rate_limit=None, ratio=None, session=None, node_state=None)
Modify an existing node. Only a node which already exists will be modified and
only the parameters specified will be enforced.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the node to modify
.TP
.B connection_limit
[integer]
.TP
.B description
[string]
.TP
.B dynamic_ratio
[integer]
.TP
.B logging
[enabled | disabled]
.TP
.B monitor
[[name] | none | default]
.TP
.B rate_limit
[integer]
.TP
.B ratio
[integer]
.TP
.B session
[user\-enabled | user\-disabled]
.TP
.B node_state (state)
[user\-down | user\-up ]
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.modify_pool(hostname, username, password, name, allow_nat=None, allow_snat=None, description=None, gateway_failsafe_device=None, ignore_persisted_weight=None, ip_tos_to_client=None, ip_tos_to_server=None, link_qos_to_client=None, link_qos_to_server=None, load_balancing_mode=None, min_active_members=None, min_up_members=None, min_up_members_action=None, min_up_members_checking=None, monitor=None, profiles=None, queue_depth_limit=None, queue_on_connection_limit=None, queue_time_limit=None, reselect_tries=None, service_down_action=None, slow_ramp_time=None)
Modify an existing pool. Pool members are managed separately. Only the
parameters specified are enforced.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool to create
.TP
.B allow_nat
[yes | no]
.TP
.B allow_snat
[yes | no]
.TP
.B description
[string]
.TP
.B gateway_failsafe_device
[string]
.TP
.B ignore_persisted_weight
[enabled | disabled]
.TP
.B ip_tos_to_client
[pass\-through | [integer]]
.TP
.B ip_tos_to_server
[pass\-through | [integer]]
.TP
.B link_qos_to_client
[pass\-through | [integer]]
.TP
.B link_qos_to_server
[pass\-through | [integer]]
.TP
.B load_balancing_mode
[dynamic\-ratio\-member | dynamic\-ratio\-node |
fastest\-app\-response | fastest\-node |
least\-connections\-members |
least\-connections\-node |
least\-sessions |
observed\-member | observed\-node |
predictive\-member | predictive\-node |
ratio\-least\-connections\-member |
ratio\-least\-connections\-node |
ratio\-member | ratio\-node | ratio\-session |
round\-robin | weighted\-least\-connections\-member |
weighted\-least\-connections\-node]
.TP
.B min_active_members
[integer]
.TP
.B min_up_members
[integer]
.TP
.B min_up_members_action
[failover | reboot | restart\-all]
.TP
.B min_up_members_checking
[enabled | disabled]
.TP
.B monitor
[name]
.TP
.B profiles
[none | profile_name]
.TP
.B queue_depth_limit
[integer]
.TP
.B queue_on_connection_limit
[enabled | disabled]
.TP
.B queue_time_limit
[integer]
.TP
.B reselect_tries
[integer]
.TP
.B service_down_action
[drop | none | reselect | reset]
.TP
.B slow_ramp_time
[integer]
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.modify_pool_member(hostname, username, password, name, member, connection_limit=None, description=None, dynamic_ratio=None, inherit_profile=None, logging=None, monitor=None, priority_group=None, profiles=None, rate_limit=None, ratio=None, session=None, member_state=None)
A function to connect to a bigip device and modify a member of an existing pool.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the pool to modify
.TP
.B member
The member modify
.TP
.B connection_limit
[integer]
.TP
.B description
[string]
.TP
.B dynamic_ratio
[integer]
.TP
.B inherit_profile
[enabled | disabled]
.TP
.B logging
[enabled | disabled]
.TP
.B monitor
[name]
.TP
.B priority_group
[integer]
.TP
.B profiles
[none | profile_name]
.TP
.B rate_limit
[integer]
.TP
.B ratio
[integer]
.TP
.B session
[user\-enabled | user\-disabled]
.TP
.B member_state (state)
[ user\-up | user\-down ]
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.modify_profile(hostname, username, password, profile_type, name, **kwargs)
Modify an existing profile.  If it does exists, only
the parameters specified will be enforced.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B profile_type
The type of profile to create
.TP
.B name
The name of the profile to create
.TP
.B kwargs
[ arg=val ] ...
.sp
Consult F5 BIGIP user guide for specific options for each monitor type.
Typically, tmsh arg names are used.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bigip.modify_virtual(hostname, username, password, name, destination, pool=None, address_status=None, auto_lasthop=None, bwc_policy=None, cmp_enabled=None, connection_limit=None, dhcp_relay=None, description=None, fallback_persistence=None, flow_eviction_policy=None, gtm_score=None, ip_forward=None, ip_protocol=None, internal=None, twelve_forward=None, last_hop_pool=None, mask=None, mirror=None, nat64=None, persist=None, profiles=None, policies=None, rate_class=None, rate_limit=None, rate_limit_mode=None, rate_limit_dst=None, rate_limit_src=None, rules=None, related_rules=None, reject=None, source=None, source_address_translation=None, source_port=None, virtual_state=None, traffic_classes=None, translate_address=None, translate_port=None, vlans=None)
Modify an virtual server.  modify an existing virtual.  Only parameters specified will be enforced.
.INDENT 7.0
.TP
.B hostname
The host/address of the bigip device
.TP
.B username
The iControl REST username
.TP
.B password
The iControl REST password
.TP
.B name
The name of the virtual to create
.TP
.B destination
[ [virtual_address_name:port] | [ipv4:port] | [ipv6.port] ]
.TP
.B pool
[ [pool_name] | none]
.TP
.B address_status
[yes | no]
.TP
.B auto_lasthop
[default | enabled | disabled ]
.TP
.B bwc_policy
[none] | string]
.TP
.B cmp_enabled
[yes | no]
.TP
.B dhcp_relay
[yes | no}
.TP
.B connection_limit
[integer]
.TP
.B description
[string]
.TP
.B state
[disabled | enabled]
.TP
.B fallback_persistence
[none | [profile name] ]
.TP
.B flow_eviction_policy
[none | [eviction policy name] ]
.TP
.B gtm_score
[integer]
.TP
.B ip_forward
[yes | no]
.TP
.B ip_protocol
[any | protocol]
.TP
.B internal
[yes | no]
.TP
.B twelve_forward(12\-forward)
[yes | no]
.TP
.B last_hop\-pool
[ [pool_name] | none]
.TP
.B mask
{ [ipv4] | [ipv6] }
.TP
.B mirror
{ [disabled | enabled | none] }
.TP
.B nat64
[enabled | disabled]
.TP
.B persist
[list]
.TP
.B profiles
[none | default | list ]
.TP
.B policies
[none | default | list ]
.TP
.B rate_class
[name]
.TP
.B rate_limit
[integer]
.TP
.B rate_limit\-mode
[destination | object | object\-destination |
object\-source | object\-source\-destination |
source | source\-destination]
.TP
.B rate_limit_dst
[integer]
.TP
.B rate_limit_src
[integer]
.TP
.B rules
[none | list ]
.TP
.B related_rules
[none | list ]
.TP
.B reject
[yes | no]
.TP
.B source
{ [ipv4[/prefixlen]] | [ipv6[/prefixlen]] }
.TP
.B source_address_translation
[none | snat:pool_name | lsn | automap | dictionary ]
.TP
.B source_port
[change | preserve | preserve\-strict]
.TP
.B state
[enabled | disabled]
.TP
.B traffic_classes
[none | default | list ]
.TP
.B translate_address
[enabled | disabled]
.TP
.B translate_port
[enabled | disabled]
.TP
.B vlans
[none | default | dictionary ]
.INDENT 7.0
.TP
.B vlan_ids
[ list]
.TP
.B enabled
[ true | false ]
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.blockdev
.sp
Management of Block Devices
.sp
A state module to manage blockdevices
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/dev/sda:
  blockdev.tuned:
    \- read\-only: True

master\-data:
  blockdev.tuned:
    \- name: /dev/vg/master\-data
    \- read\-only: True
    \- read\-ahead: 1024
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B salt.states.blockdev.formatted(name, fs_type=\(aqext4\(aq, force=False, **kwargs)
Manage filesystems of partitions.
.INDENT 7.0
.TP
.B name
The name of the block device
.TP
.B fs_type
The filesystem it should be formatted as
.TP
.B force
Force mke2fs to create a filesystem, even if the specified device is
not a partition on a block special device. This option is only enabled
for ext and xfs filesystems
.sp
This option is dangerous, use it with caution.
.sp
New in version 2016.11.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.blockdev.tuned(name, **kwargs)
Manage options of block device
.INDENT 7.0
.TP
.B name
The name of the block device
.TP
.B opts:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B read\-ahead
Read\-ahead buffer size
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B filesystem\-read\-ahead
Filesystem Read\-ahead buffer size
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B read\-only
Set Read\-Only
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B read\-write
Set Read\-Write
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.boto3_elasticache
.SS Manage Elasticache with boto3
.sp
New in version 2017.7.0.

.sp
Create, destroy and update Elasticache clusters. Be aware that this interacts
with Amazon\(aqs services, and so may incur charges.
.sp
This module uses boto3 behind the scenes \- as a result it inherits any limitations
it boto3\(aqs implementation of the AWS API.  It is also designed to as directly as
possible leverage boto3\(aqs parameter naming and semantics.  This allows one to use
\fI\%http://boto3.readthedocs.io/en/latest/reference/services/elasticache.html\fP as an
excellent source for details too involved to reiterate here.
.sp
Note:  This module is designed to be transparent (\(dqintentionally ignorant\(dq is the
phrase I used to describe it to my boss) to new AWS / boto options \- since all
AWS API params are passed directly through both the state and executions modules,
any new args to existing functions which become available after this documentation
is written should work immediately.
.sp
Brand new API calls, of course, would still require new functions to be added :)
.sp
This module accepts explicit elasticache credentials but can also utilize IAM
roles assigned to the instance through Instance Profiles. Dynamic credentials are
then automatically obtained from AWS API and no further configuration is necessary.
More information is available
\fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
elasticache.keyid: GKTADJGHEIQSXMKKRBJ08H
elasticache.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile, either
passed in as a dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure myelasticache exists:
  boto3_elasticache.present:
    \- name: myelasticache
    \- engine: redis
    \- cache_node_type: cache.t1.micro
    \- num_cache_nodes: 1
    \- notification_topic_arn: arn:aws:sns:us\-east\-1:879879:my\-sns\-topic
    \- region: us\-east\-1
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Using a profile from pillars
Ensure myelasticache exists:
  boto3_elasticache.present:
    \- name: myelasticache
    \- engine: redis
    \- cache_node_type: cache.t1.micro
    \- num_cache_nodes: 1
    \- notification_topic_arn: arn:aws:sns:us\-east\-1:879879:my\-sns\-topic
    \- region: us\-east\-1
    \- profile: myprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Passing in a profile
Ensure myelasticache exists:
  boto3_elasticache.present:
    \- name: myelasticache
    \- engine: redis
    \- cache_node_type: cache.t1.micro
    \- num_cache_nodes: 1
    \- notification_topic_arn: arn:aws:sns:us\-east\-1:879879:my\-sns\-topic
    \- region: us\-east\-1
    \- profile:
        keyid: GKTADJGHEIQSXMKKRBJ08H
        key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_elasticache.cache_cluster_absent(name, wait=600, region=None, key=None, keyid=None, profile=None, **args)
Ensure a given cache cluster is deleted.
.INDENT 7.0
.TP
.B name
Name of the cache cluster.
.TP
.B wait
Integer describing how long, in seconds, to wait for confirmation from AWS that the
resource is in the desired state.  Zero meaning to return success or failure immediately
of course.  Note that waiting for the cluster to become available is generally the
better course, as failure to do so will often lead to subsequent failures when managing
dependent resources.
.TP
.B CacheClusterId
The node group (shard) identifier.
Note:  In general this parameter is not needed, as \(aqname\(aq is used if it\(aqs not provided.
.TP
.B FinalSnapshotIdentifier
The user\-supplied name of a final cache cluster snapshot.  This is the unique name
that identifies the snapshot.  ElastiCache creates the snapshot, and then deletes the
cache cluster immediately afterward.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_elasticache.cache_cluster_present(name, wait=900, security_groups=None, region=None, key=None, keyid=None, profile=None, **args)
Ensure a given cache cluster exists.
.INDENT 7.0
.TP
.B name
Name of the cache cluster (cache cluster id).
.TP
.B wait
Integer describing how long, in seconds, to wait for confirmation from AWS that the
resource is in the desired state.  Zero meaning to return success or failure immediately
of course.  Note that waiting for the cluster to become available is generally the
better course, as failure to do so will often lead to subsequent failures when managing
dependent resources.
.TP
.B security_groups
One or more VPC security groups (names and/or IDs) associated with the cache cluster.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is additive with any sec groups provided via the
SecurityGroupIds parameter below.  Use this parameter ONLY when you
are creating a cluster in a VPC.
.UNINDENT
.UNINDENT
.TP
.B CacheClusterId
The node group (shard) identifier. This parameter is stored as a lowercase string.
.sp
Constraints:
.INDENT 7.0
.IP \(bu 2
A name must contain from 1 to 20 alphanumeric characters or hyphens.
.IP \(bu 2
The first character must be a letter.
.IP \(bu 2
A name cannot end with a hyphen or contain two consecutive hyphens.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
In general this parameter is not needed, as \(aqname\(aq is used if it\(aqs
not provided.
.UNINDENT
.UNINDENT
.TP
.B ReplicationGroupId
The ID of the replication group to which this cache cluster should belong. If this
parameter is specified, the cache cluster is added to the specified replication
group as a read replica; otherwise, the cache cluster is a standalone primary that
is not part of any replication group.  If the specified replication group is
Multi\-AZ enabled and the Availability Zone is not specified, the cache cluster is
created in Availability Zones that provide the best spread of read replicas across
Availability Zones.
.TP
.B AZMode
Specifies whether the nodes in this Memcached cluster are created in a single
Availability Zone or created across multiple Availability Zones in the cluster\(aqs
region. If the AZMode and PreferredAvailabilityZones are not specified,
ElastiCache assumes single\-az mode.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This parameter is ONLY supported for Memcached cache clusters.
.UNINDENT
.UNINDENT
.TP
.B PreferredAvailabilityZone
The EC2 Availability Zone in which the cache cluster is created.  All nodes
belonging to this Memcached cache cluster are placed in the preferred Availability
Zone. If you want to create your nodes across multiple Availability Zones, use
PreferredAvailabilityZones.
.sp
Default:  System chosen Availability Zone.
.TP
.B PreferredAvailabilityZones
A list of the Availability Zones in which cache nodes are created. The order of
the zones in the list is not important.  The number of Availability Zones listed
must equal the value of NumCacheNodes.  If you want all the nodes in the same
Availability Zone, use PreferredAvailabilityZone instead, or repeat the
Availability Zone multiple times in the list.
.sp
Default:  System chosen Availability Zones.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option is ONLY supported on Memcached.
.sp
If you are creating your cache cluster in an Amazon VPC
(recommended) you can only locate nodes in Availability Zones that
are associated with the subnets in the selected subnet group.
.UNINDENT
.UNINDENT
.TP
.B NumCacheNodes
The initial (integer) number of cache nodes that the cache cluster has.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For clusters running Redis, this value must be 1.
.sp
For clusters running Memcached, this value must be between 1 and 20.
.UNINDENT
.UNINDENT
.TP
.B CacheNodeType
The compute and memory capacity of the nodes in the node group (shard).
Valid node types (and pricing for them) are exhaustively described at
\fI\%https://aws.amazon.com/elasticache/pricing/\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
All T2 instances must be created in a VPC
.UNINDENT
.UNINDENT
.sp
Redis backup/restore is not supported for Redis (cluster mode
disabled) T1 and T2 instances. Backup/restore is supported on Redis
(cluster mode enabled) T2 instances.
.sp
Redis Append\-only files (AOF) functionality is not supported for T1
or T2 instances.
.UNINDENT
.UNINDENT
.TP
.B Engine
The name of the cache engine to be used for this cache cluster.  Valid values for
this parameter are:  memcached | redis
.TP
.B EngineVersion
The version number of the cache engine to be used for this cache cluster. To view
the supported cache engine versions, use the DescribeCacheEngineVersions operation.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
You can upgrade to a newer engine version but you cannot downgrade
to an earlier engine version. If you want to use an earlier engine
version, you must delete the existing cache cluster or replication
group and create it anew with the earlier engine version.
.UNINDENT
.UNINDENT
.TP
.B CacheParameterGroupName
The name of the parameter group to associate with this cache cluster. If this
argument is omitted, the default parameter group for the specified engine is used.
You cannot use any parameter group which has cluster\-enabled=\(aqyes\(aq when creating
a cluster.
.TP
.B CacheSubnetGroupName
The name of the Cache Subnet Group to be used for the cache cluster.  Use this
parameter ONLY when you are creating a cache cluster within a VPC.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If you\(aqre going to launch your cluster in an Amazon VPC, you need
to create a subnet group before you start creating a cluster.
.UNINDENT
.UNINDENT
.TP
.B CacheSecurityGroupNames
A list of Cache Security Group names to associate with this cache cluster.  Use
this parameter ONLY when you are creating a cache cluster outside of a VPC.
.TP
.B SecurityGroupIds
One or more VPC security groups associated with the cache cluster.  Use this
parameter ONLY when you are creating a cache cluster within a VPC.
.TP
.B Tags
A list of tags to be added to this resource.  Note that due to shortcomings in the
AWS API for Elasticache, these can only be set during resource creation \- later
modification is not (currently) supported.
.TP
.B SnapshotArns
A single\-element string list containing an Amazon Resource Name (ARN) that
uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot
file is used to populate the node group (shard). The Amazon S3 object name in
the ARN cannot contain any commas.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This parameter is ONLY valid if the Engine parameter is redis.
.UNINDENT
.UNINDENT
.TP
.B SnapshotName
The name of a Redis snapshot from which to restore data into the new node group
(shard). The snapshot status changes to restoring while the new node group (shard)
is being created.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This parameter is ONLY valid if the Engine parameter is redis.
.UNINDENT
.UNINDENT
.TP
.B PreferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cache cluster is
permitted.  It is specified as a range in the format ddd:hh24:mi\-ddd:hh24:mi
(24H Clock UTC).  The minimum maintenance window is a 60 minute period.
Valid values for ddd are:  sun, mon, tue, wed, thu, fri, sat
.sp
Example:  sun:23:00\-mon:01:30
.TP
.B Port
The port number on which each of the cache nodes accepts connections.
.sp
Default:  6379
.TP
.B NotificationTopicArn
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS)
topic to which notifications are sent.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The Amazon SNS topic owner must be the same as the cache cluster
owner.
.UNINDENT
.UNINDENT
.TP
.B AutoMinorVersionUpgrade
This (boolean) parameter is currently disabled.
.TP
.B SnapshotRetentionLimit
The number of days for which ElastiCache retains automatic snapshots before
deleting them.
.sp
Default:  0 (i.e., automatic backups are disabled for this cache cluster).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This parameter is ONLY valid if the Engine parameter is redis.
.UNINDENT
.UNINDENT
.TP
.B SnapshotWindow
The daily time range (in UTC) during which ElastiCache begins taking a daily
snapshot of your node group (shard).  If you do not specify this parameter,
ElastiCache automatically chooses an appropriate time range.
.sp
Example:  05:00\-09:00
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This parameter is ONLY valid if the Engine parameter is redis.
.UNINDENT
.UNINDENT
.TP
.B AuthToken
The password used to access a password protected server.
.sp
Password constraints:
.INDENT 7.0
.IP \(bu 2
Must be only printable ASCII characters.
.IP \(bu 2
Must be at least 16 characters and no more than 128 characters in length.
.IP \(bu 2
Cannot contain any of the following characters: \(aq/\(aq, \(aq\(dq\(aq, or \(dq@\(dq.
.UNINDENT
.TP
.B CacheNodeIdsToRemove
A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002,
etc.).  This parameter is only valid when NumCacheNodes is less than the existing number of
cache nodes.  The number of cache node IDs supplied in this parameter must match the
difference between the existing number of cache nodes in the cluster or pending cache nodes,
whichever is greater, and the value of NumCacheNodes in the request.
.TP
.B NewAvailabilityZones
The list of Availability Zones where the new Memcached cache nodes are created.
This parameter is only valid when NumCacheNodes in the request is greater than the sum of
the number of active cache nodes and the number of cache nodes pending creation (which may
be zero).  The number of Availability Zones supplied in this list must match the cache nodes
being added in this request.
Note:  This option is only supported on Memcached clusters.
.TP
.B NotificationTopicStatus
The status of the SNS notification topic.  Notifications are sent only if the status is active.
.sp
Valid values:  active | inactive
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_elasticache.cache_subnet_group_absent(name, region=None, key=None, keyid=None, profile=None, **args)
Ensure a given cache subnet group is deleted.
.INDENT 7.0
.TP
.B name
Name of the cache subnet group.
.TP
.B CacheSubnetGroupName
A name for the cache subnet group.
Note:  In general this parameter is not needed, as \(aqname\(aq is used if it\(aqs not provided.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_elasticache.cache_subnet_group_present(name, subnets=None, region=None, key=None, keyid=None, profile=None, **args)
Ensure cache subnet group exists.
.INDENT 7.0
.TP
.B name
A name for the cache subnet group. This value is stored as a lowercase string.
Constraints:  Must contain no more than 255 alphanumeric characters or hyphens.
.TP
.B subnets
A list of VPC subnets (IDs, Names, or a mix) for the cache subnet group.
.TP
.B CacheSubnetGroupName
A name for the cache subnet group. This value is stored as a lowercase string.
Constraints:  Must contain no more than 255 alphanumeric characters or hyphens.
Note:  In general this parameter is not needed, as \(aqname\(aq is used if it\(aqs not provided.
.TP
.B CacheSubnetGroupDescription
A description for the cache subnet group.
.TP
.B SubnetIds
A list of VPC subnet IDs for the cache subnet group.  This is ADDITIVE with \(aqsubnets\(aq above.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_elasticache.replication_group_absent(name, wait=600, region=None, key=None, keyid=None, profile=None, **args)
Ensure a given replication group is deleted.
.INDENT 7.0
.TP
.B name
Name of the replication group.
.TP
.B wait
Integer describing how long, in seconds, to wait for confirmation from AWS that the
resource is in the desired state.  Zero meaning to return success or failure immediately
of course.  Note that waiting for the cluster to become available is generally the
better course, as failure to do so will often lead to subsequent failures when managing
dependent resources.
.TP
.B ReplicationGroupId
The replication group identifier.
Note:  In general this parameter is not needed, as \(aqname\(aq is used if it\(aqs not provided.
.TP
.B RetainPrimaryCluster
If set to true, all of the read replicas are deleted, but the primary node is retained.
.TP
.B FinalSnapshotIdentifier
The name of a final node group (shard) snapshot.  ElastiCache creates the snapshot from
the primary node in the cluster, rather than one of the replicas; this is to ensure that
it captures the freshest data.  After the final snapshot is taken, the replication group is
immediately deleted.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_elasticache.replication_group_present(name, wait=900, security_groups=None, region=None, key=None, keyid=None, profile=None, **args)
Ensure a replication group exists and is in the given state.
.INDENT 7.0
.TP
.B name
Name of replication group
.TP
.B wait
Integer describing how long, in seconds, to wait for confirmation from AWS that the
resource is in the desired state.  Zero meaning to return success or failure immediately
of course.  Note that waiting for the cluster to become available is generally the
better course, as failure to do so will often lead to subsequent failures when managing
dependent resources.
.TP
.B security_groups
One or more VPC security groups (names and/or IDs) associated with the cache cluster.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is additive with any sec groups provided via the
SecurityGroupIds parameter below.  Use this parameter ONLY when you
are creating a cluster in a VPC.
.UNINDENT
.UNINDENT
.TP
.B ReplicationGroupId
The replication group identifier. This parameter is stored as a lowercase string.
.sp
Constraints:
.INDENT 7.0
.IP \(bu 2
A name must contain from 1 to 20 alphanumeric characters or hyphens.
.IP \(bu 2
The first character must be a letter.
.IP \(bu 2
A name cannot end with a hyphen or contain two consecutive hyphens.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
In general this parameter is not needed, as \(aqname\(aq is used if it\(aqs
not provided.
.UNINDENT
.UNINDENT
.TP
.B ReplicationGroupDescription
A user\-created description for the replication group.
.TP
.B PrimaryClusterId
The identifier of the cache cluster that serves as the primary for this replication group.
This cache cluster must already exist and have a status of available.  This parameter is
not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.
.TP
.B AutomaticFailoverEnabled
Specifies whether a read\-only replica is automatically promoted to read/write primary if
the existing primary fails.  If true, Multi\-AZ is enabled for this replication group. If
false, Multi\-AZ is disabled for this replication group.
.sp
Default:  False
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
AutomaticFailoverEnabled must be enabled for Redis (cluster mode
enabled) replication groups.
.sp
ElastiCache Multi\-AZ replication groups is not supported on:
.INDENT 0.0
.IP \(bu 2
Redis versions earlier than 2.8.6.
.IP \(bu 2
Redis (cluster mode disabled): T1 and T2 node types.
.IP \(bu 2
Redis (cluster mode enabled): T2 node types.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B NumCacheClusters
The number of clusters this replication group initially has.  This parameter is not used
if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.
If Multi\-AZ is enabled , the value of this parameter must be at least 2.  The maximum
permitted value for NumCacheClusters is 6 (primary plus 5 replicas).
.TP
.B PreferredCacheClusterAZs
A list of EC2 Availability Zones in which the replication group\(aqs cache clusters are
created. The order of the Availability Zones in the list is the order in which clusters
are allocated. The primary cluster is created in the first AZ in the list.  This parameter
is not used if there is more than one node group (shard).  You should use
NodeGroupConfiguration instead.  The number of Availability Zones listed must equal the
value of NumCacheClusters.
.sp
Default:  System chosen Availability Zones.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If you are creating your replication group in an Amazon VPC
(recommended), you can only locate cache clusters in Availability
Zones associated with the subnets in the selected subnet group.
.UNINDENT
.UNINDENT
.TP
.B NumNodeGroups
An optional parameter that specifies the number of node groups (shards)
for this Redis (cluster mode enabled) replication group. For Redis
(cluster mode disabled) either omit this parameter or set it to 1.
.sp
Default:  1
.TP
.B ReplicasPerNodeGroup
An optional parameter that specifies the number of replica nodes in
each node group (shard). Valid values are:  0 to 5
.TP
.B NodeGroupConfiguration
A list of node group (shard) configuration options. Each node group (shard) configuration
has the following:  Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
If you\(aqre creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled)
replication group, you can use this parameter to configure one node group (shard) or you
can omit this parameter.  For fiddly details of the expected data layout of this param, see
\fI\%http://boto3.readthedocs.io/en/latest/reference/services/elasticache.html\fP?#ElastiCache.Client.create_replication_group
.TP
.B CacheNodeType
The compute and memory capacity of the nodes in the node group (shard).
See \fI\%https://aws.amazon.com/elasticache/pricing/\fP for current sizing, prices, and constraints.
.TP
.B Engine
The name of the cache engine to be used for the cache clusters in this replication group.
.TP
.B EngineVersion
The version number of the cache engine to be used for the cache clusters in this replication
group. To view the supported cache engine versions, use the DescribeCacheEngineVersions
operation.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
You can upgrade to a newer engine version but you cannot downgrade
to an earlier engine version. If you want to use an earlier engine
version, you must delete the existing cache cluster or replication
group and create it anew with the earlier engine version.
.UNINDENT
.UNINDENT
.TP
.B CacheParameterGroupName
The name of the parameter group to associate with this replication group. If this argument
is omitted, the default cache parameter group for the specified engine is used.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If you are running Redis version 3.2.4 or later, only one node
group (shard), and want to use a default parameter group, we
recommend that you specify the parameter group by name.
.sp
To create a Redis (cluster mode disabled) replication group, use
CacheParameterGroupName=default.redis3.2
.sp
To create a Redis (cluster mode enabled) replication group, use
CacheParameterGroupName=default.redis3.2.cluster.on
.UNINDENT
.UNINDENT
.TP
.B CacheSubnetGroupName
The name of the cache subnet group to be used for the replication group.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If you\(aqre going to launch your cluster in an Amazon VPC, you need
to create a s group before you start creating a cluster. For more
information, see Subnets and Subnet Groups.
.UNINDENT
.UNINDENT
.TP
.B CacheSecurityGroupNames
A list of cache security group names to associate with this replication group.
.TP
.B SecurityGroupIds
One or more Amazon VPC security groups associated with this replication group.  Use this
parameter only when you are creating a replication group in an VPC.
.TP
.B Tags
A list of tags to be added to this resource.  Note that due to shortcomings in the
AWS API for Elasticache, these can only be set during resource creation \- later
modification is not (currently) supported.
.TP
.B SnapshotArns
A list of ARNs that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
These snapshot files are used to populate the replication group.  The Amazon S3 object name
in the ARN cannot contain any commas. The list must match the number of node groups (shards)
in the replication group, which means you cannot repartition.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This parameter is only valid if the Engine parameter is redis.
.UNINDENT
.UNINDENT
.TP
.B SnapshotName
The name of a snapshot from which to restore data into the new replication group.  The
snapshot status changes to restoring while the new replication group is being created.
Note:  This parameter is only valid if the Engine parameter is redis.
.TP
.B PreferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cluster is performed. It is
specified as a range in the format ddd:hh24:mi\-ddd:hh24:mi (24H Clock UTC). The minimum
maintenance window is a 60 minute period.
Valid values for ddd are:  sun, mon, tue, wed, thu, fri, sat
.sp
Example:  sun:23:00\-mon:01:30
.TP
.B Port
The port number on which each member of the replication group accepts connections.
.TP
.B NotificationTopicArn
The ARN of an SNS topic to which notifications are sent.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The SNS topic owner must be the same as the cache cluster owner.
.UNINDENT
.UNINDENT
.TP
.B AutoMinorVersionUpgrade
This parameter is currently disabled.
.TP
.B SnapshotRetentionLimit
The number of days for which ElastiCache will retain automatic snapshots before deleting
them.
.sp
Default:  0 (that is, automatic backups are disabled for this cache cluster).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This parameter is only valid if the Engine parameter is redis.
.UNINDENT
.UNINDENT
.TP
.B SnapshotWindow
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of
your node group (shard).  If you do not specify this parameter, ElastiCache automatically
chooses an appropriate time range.
.sp
Example:  05:00\-09:00
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This parameter is only valid if the Engine parameter is redis.
.UNINDENT
.UNINDENT
.TP
.B AuthToken
The password used to access a password protected server.
Password constraints:
.INDENT 7.0
.IP \(bu 2
Must be only printable ASCII characters.
.IP \(bu 2
Must be at least 16 characters and no more than 128 characters in length.
.IP \(bu 2
Cannot contain any of the following characters: \(aq/\(aq, \(aq\(dq\(aq, or \(dq@\(dq.
.UNINDENT
.TP
.B SnapshottingClusterId
The cache cluster ID that is used as the daily snapshot source for the replication group.
.TP
.B NotificationTopicStatus
The status of the SNS notification topic.  Notifications are sent only if the status is active.
Valid values:  active | inactive
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto3_elasticsearch
.SS Manage Elasticsearch Service
.sp
New in version 3001.

.INDENT 0.0
.TP
.B configuration
This module accepts explicit AWS credentials but can also
utilize IAM roles assigned to the instance trough Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available at:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
es.keyid: GKTADJGHEIQSXMKKRBJ08H
es.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A region may also be specified in the configuration:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
es.region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a region is not specified, the default is us\-east\-1.
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B codeauthor
Herbert Buurman <\fI\%herbert.buurman@ogd.nl\fP>
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_elasticsearch.absent(name, blocking=True, region=None, keyid=None, key=None, profile=None)
Ensure the Elasticsearch Domain specified does not exist.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the Elasticsearch domain to be made absent.
.IP \(bu 2
\fBblocking\fP (\fI\%bool\fP) \-\- Whether or not the state should wait for the deletion
to be completed. Default: \fBTrue\fP
.UNINDENT
.UNINDENT
.sp
New in version 3001.

.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Remove Elasticsearch Domain:
  boto3_elasticsearch.absent:
  \- name: my_domain
  \- region: eu\-west\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_elasticsearch.latest(name, minor_only=True, region=None, keyid=None, key=None, profile=None)
Ensures the Elasticsearch domain specifies runs on the latest compatible
version of elasticsearch, upgrading it if it is not.
.sp
Note that this operation is blocking until the upgrade is complete.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the Elasticsearch domain to upgrade.
.IP \(bu 2
\fBminor_only\fP (\fI\%bool\fP) \-\- Only upgrade to the latest minor version.
.UNINDENT
.UNINDENT
.sp
New in version 3001.

.sp
Example:
.sp
The following example will ensure the elasticsearch domain \fBmy_domain\fP is
upgraded to the latest minor version. So if it is currently 5.1 it will be
upgraded to 5.6.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Upgrade Elasticsearch Domain:
  boto3_elasticsearch.latest:
  \- name: my_domain
  \- minor_only: True
  \- region: eu\-west\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_elasticsearch.present(name, elasticsearch_version=None, elasticsearch_cluster_config=None, ebs_options=None, access_policies=None, snapshot_options=None, vpc_options=None, cognito_options=None, encryption_at_rest_options=None, node_to_node_encryption_options=None, advanced_options=None, log_publishing_options=None, blocking=True, tags=None, region=None, keyid=None, key=None, profile=None)
Ensure an Elasticsearch Domain exists.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the Elasticsearch domain that you are creating.
Domain names are unique across the domains owned by an account within an
AWS region. Domain names must start with a letter or number and can contain
the following characters: a\-z (lowercase), 0\-9, and \- (hyphen).
.IP \(bu 2
\fBelasticsearch_version\fP (\fI\%str\fP) \-\- String of format X.Y to specify version for
the Elasticsearch domain eg. \(dq1.5\(dq or \(dq2.3\(dq.
.IP \(bu 2
\fBelasticsearch_cluster_config\fP (\fI\%dict\fP) \-\-
.sp
Dict specifying the configuration
options for an Elasticsearch domain.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
InstanceType (str): The instance type for an Elasticsearch cluster.
.IP \(bu 2
InstanceCount (int): The instance type for an Elasticsearch cluster.
.IP \(bu 2
DedicatedMasterEnabled (bool): Indicate whether a dedicated master
node is enabled.
.IP \(bu 2
ZoneAwarenessEnabled (bool): Indicate whether zone awareness is enabled.
.IP \(bu 2
ZoneAwarenessConfig (dict): Specifies the zone awareness configuration
for a domain when zone awareness is enabled.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
AvailabilityZoneCount (int): An integer value to indicate the
number of availability zones for a domain when zone awareness is
enabled. This should be equal to number of subnets if VPC endpoints
is enabled.
.UNINDENT
.IP \(bu 2
DedicatedMasterType (str): The instance type for a dedicated master node.
.IP \(bu 2
DedicatedMasterCount (int): Total number of dedicated master nodes,
active and on standby, for the cluster.
.UNINDENT

.IP \(bu 2
\fBebs_options\fP (\fI\%dict\fP) \-\-
.sp
Dict specifying the options to enable or disable and
specifying the type and size of EBS storage volumes.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
EBSEnabled (bool): Specifies whether EBS\-based storage is enabled.
.IP \(bu 2
VolumeType (str): Specifies the volume type for EBS\-based storage.
.IP \(bu 2
VolumeSize (int): Integer to specify the size of an EBS volume.
.IP \(bu 2
Iops (int): Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
.UNINDENT

.IP \(bu 2
\fBaccess_policies\fP (\fI\%str\fP\fI or \fP\fI\%dict\fP) \-\- Dict or JSON string with the IAM access policy.
.IP \(bu 2
\fBsnapshot_options\fP (\fI\%dict\fP) \-\-
.sp
Dict specifying the snapshot options.
Keys (case senstive) in here are:
.INDENT 2.0
.IP \(bu 2
AutomatedSnapshotStartHour (int): Specifies the time, in UTC format,
when the service takes a daily automated snapshot of the specified
Elasticsearch domain. Default value is 0 hours.
.UNINDENT

.IP \(bu 2
\fBvpc_options\fP (\fI\%dict\fP) \-\-
.sp
Dict with the options to specify the subnets and security
groups for the VPC endpoint.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
SubnetIds (list): The list of subnets for the VPC endpoint.
.IP \(bu 2
SecurityGroupIds (list): The list of security groups for the VPC endpoint.
.UNINDENT

.IP \(bu 2
\fBcognito_options\fP (\fI\%dict\fP) \-\-
.sp
Dict with options to specify the cognito user and
identity pools for Kibana authentication.
Keys (case senstive) in here are:
.INDENT 2.0
.IP \(bu 2
Enabled (bool): Specifies the option to enable Cognito for Kibana authentication.
.IP \(bu 2
UserPoolId (str): Specifies the Cognito user pool ID for Kibana authentication.
.IP \(bu 2
IdentityPoolId (str): Specifies the Cognito identity pool ID for Kibana authentication.
.IP \(bu 2
RoleArn (str): Specifies the role ARN that provides Elasticsearch permissions
for accessing Cognito resources.
.UNINDENT

.IP \(bu 2
\fBencryption_at_rest_options\fP (\fI\%dict\fP) \-\-
.sp
Dict specifying the encryption at rest
options. This option can only be used for the creation of a new Elasticsearch
domain.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
Enabled (bool): Specifies the option to enable Encryption At Rest.
.IP \(bu 2
KmsKeyId (str): Specifies the KMS Key ID for Encryption At Rest options.
.UNINDENT

.IP \(bu 2
\fBnode_to_node_encryption_options\fP (\fI\%dict\fP) \-\-
.sp
Dict specifying the node to node
encryption options. This option can only be used for the creation of
a new Elasticsearch domain.
Keys (case sensitive) in here are:
.INDENT 2.0
.IP \(bu 2
Enabled (bool): Specify True to enable node\-to\-node encryption.
.UNINDENT

.IP \(bu 2
\fBadvanced_options\fP (\fI\%dict\fP) \-\- Dict with option to allow references to indices
in an HTTP request body. Must be False when configuring access to individual
sub\-resources. By default, the value is True.
See \fI\%http://docs.aws.amazon.com/elasticsearch\-service/latest/developerguide\fP        /es\-createupdatedomains.html#es\-createdomain\-configure\-advanced\-options
for more information.
.IP \(bu 2
\fBlog_publishing_options\fP (\fI\%dict\fP) \-\-
.sp
Dict with options for various type of logs.
The keys denote the type of log file and can be one of the following:
.INDENT 2.0
.IP \(bu 2
INDEX_SLOW_LOGS
.IP \(bu 2
SEARCH_SLOW_LOGS
.IP \(bu 2
ES_APPLICATION_LOGS
.UNINDENT
.sp
The value assigned to each key is a dict with the following case sensitive keys:
.INDENT 2.0
.IP \(bu 2
CloudWatchLogsLogGroupArn (str): The ARN of the Cloudwatch log
group to which the log needs to be published.
.IP \(bu 2
Enabled (bool): Specifies whether given log publishing option is enabled or not.
.UNINDENT

.IP \(bu 2
\fBblocking\fP (\fI\%bool\fP) \-\- Whether or not the state should wait for all operations
(create/update/upgrade) to be completed. Default: \fBTrue\fP
.IP \(bu 2
\fBtags\fP (\fI\%dict\fP) \-\- Dict of tags to ensure are present on the Elasticsearch domain.
.UNINDENT
.UNINDENT
.sp
New in version 3001.

.sp
Example:
.sp
This will create an elasticsearch domain consisting of a single t2.small instance
in the eu\-west\-1 region (Ireland) and will wait until the instance is available
before returning from the state.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Create new domain:
  boto3_elasticsearch.present:
  \- name: my_domain
  \- elasticsearch_version: \(aq5.1\(aq
  \- elasticsearch_cluster_config:
      InstanceType: t2.small.elasticsearch
      InstanceCount: 1
      DedicatedMasterEnabled: False
      ZoneAwarenessEnabled: False
  \- ebs_options:
      EBSEnabled: True
      VolumeType: gp2
      VolumeSize: 10
  \- snapshot_options:
      AutomatedSnapshotStartHour: 3
  \- vpc_options:
      SubnetIds:
      \- subnet\-12345678
      SecurityGroupIds:
      \- sg\-12345678
  \- node_to_node_encryption_options:
      Enabled: False
  \- region: eu\-west\-1
  \- tags:
      foo: bar
      baz: qux
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_elasticsearch.tagged(name, tags=None, replace=False, region=None, keyid=None, key=None, profile=None)
Ensures the Elasticsearch domain has the tags provided.
Adds tags to the domain unless \fBreplace\fP is set to \fBTrue\fP, in which
case all existing tags will be replaced with the tags provided in \fBtags\fP\&.
(This will remove all tags if \fBreplace\fP is \fBTrue\fP and \fBtags\fP is empty).
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The Elasticsearch domain to work with.
.IP \(bu 2
\fBtags\fP (\fI\%dict\fP) \-\- The tags to add to/replace on the Elasticsearch domain.
.IP \(bu 2
\fBreplace\fP (\fI\%bool\fP) \-\- Whether or not to replace (\fBTrue\fP) all existing tags
on the Elasticsearch domain, or add (\fBFalse\fP) tags to the ES domain.
.UNINDENT
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_elasticsearch.upgraded(name, elasticsearch_version, blocking=True, region=None, keyid=None, key=None, profile=None)
Ensures the Elasticsearch domain specified runs on the specified version of
elasticsearch. Only upgrades are possible as downgrades require a manual snapshot
and an S3 bucket to store them in.
.sp
Note that this operation is blocking until the upgrade is complete.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the Elasticsearch domain to upgrade.
.IP \(bu 2
\fBelasticsearch_version\fP (\fI\%str\fP) \-\- String of format X.Y to specify version for
the Elasticsearch domain eg. \(dq1.5\(dq or \(dq2.3\(dq.
.UNINDENT
.UNINDENT
.sp
New in version 3001.

.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Upgrade Elasticsearch Domain:
  boto3_elasticsearch.upgraded:
  \- name: my_domain
  \- elasticsearch_version: \(aq7.2\(aq
  \- region: eu\-west\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.boto3_route53
.sp
Manage Route53 records with Boto 3
.sp
New in version 2017.7.0.

.sp
Create and delete Route53 records. Be aware that this interacts with Amazon\(aqs
services, and so may incur charges.
.sp
This module uses \fBboto3\fP, which can be installed via package, or pip.
.sp
This module accepts explicit route53 credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
route53.keyid: GKTADJGHEIQSXMKKRBJ08H
route53.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile, either
passed in as a dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
  region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
An exciting new AWS Route 53 Hosted Zone:
  boto_route53.hosted_zone_present:
    \- Name: example.com.
    \- PrivateZone: true
    \- VPCs:
      \- VPCName: MyLittleVPC
        VPCRegion: us\-east\-1
      \- VPCId: vpc\-12345678
    \- region: us\-east\-1
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

mycnamerecord:
  boto_route53.rr_present:
    \- Name: test.example.com.
    \- ResourceRecords:
      \- my\-elb.us\-east\-1.elb.amazonaws.com.
    \- DomainName: example.com.
    \- TTL: 60
    \- Type: CNAME
    \- region: us\-east\-1
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_route53.hosted_zone_absent(name, Name=None, PrivateZone=False, region=None, key=None, keyid=None, profile=None)
Ensure the Route53 Hostes Zone described is absent
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B Name
The name of the domain. This should be a fully\-specified domain, and should terminate with a
period.  If not provided, the value of name will be used.
.TP
.B PrivateZone
Set True if deleting a private hosted zone.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_route53.hosted_zone_present(name, Name=None, PrivateZone=False, CallerReference=None, Comment=None, VPCs=None, region=None, key=None, keyid=None, profile=None)
Ensure a hosted zone exists with the given attributes.
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B Name
The name of the domain. This should be a fully\-specified domain, and should terminate with a
period. This is the name you have registered with your DNS registrar. It is also the name
you will delegate from your registrar to the Amazon Route 53 delegation servers returned in
response to this request.  If not provided, the value of name will be used.
.TP
.B PrivateZone
Set True if creating a private hosted zone.  If true, then \(aqVPCs\(aq is also required.
.TP
.B Comment
Any comments you want to include about the hosted zone.
.TP
.B CallerReference
A unique string that identifies the request and that allows create_hosted_zone() calls to be
retried without the risk of executing the operation twice.  This helps ensure idempotency
across state calls, but can cause issues if a zone is deleted and then an attempt is made
to recreate it with the same CallerReference.  If not provided, a unique UUID will be
generated at each state run, which can potentially lead to duplicate zones being created if
the state is run again while the previous zone creation is still in PENDING status (which
can occasionally take several minutes to clear).  Maximum length of 128.
.TP
.B VPCs
A list of dicts, each dict composed of a VPCRegion, and either a VPCId or a VPCName.
Note that this param is ONLY used if PrivateZone == True
.INDENT 7.0
.TP
.B VPCId
When creating a private hosted zone, either the VPC ID or VPC Name to associate with is
required.  Exclusive with VPCName.
.TP
.B VPCName
When creating a private hosted zone, either the VPC ID or VPC Name to associate with is
required.  Exclusive with VPCId.
.TP
.B VPCRegion
When creating a private hosted zone, the region of the associated VPC is required.  If
not provided, an effort will be made to determine it from VPCId or VPCName, if
possible.  This will fail if a given VPCName exists in multiple regions visible to the
bound account, in which case you\(aqll need to provide an explicit value for VPCRegion.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_route53.rr_absent(name, HostedZoneId=None, DomainName=None, PrivateZone=False, Name=None, Type=None, SetIdentifier=None, region=None, key=None, keyid=None, profile=None)
Ensure the Route53 record is deleted.
.INDENT 7.0
.TP
.B name
The name of the state definition.  This will be used for Name if the latter is
not provided.
.TP
.B HostedZoneId
The ID of the zone to delete the record from.  Exclusive with DomainName.
.TP
.B DomainName
The domain name of the zone to delete the record from.  Exclusive with HostedZoneId.
.TP
.B PrivateZone
Set to True if the RR to be removed is in a private zone, False if public.
.TP
.B Name
Name of the resource record.
.TP
.B Type
The record type (A, NS, MX, TXT, etc.)
.TP
.B SetIdentifier
Valid for Weighted, Latency, Geolocation, and Failover resource record sets only.
An identifier that differentiates among multiple resource record sets that have the same
combination of DNS name and type.  The value of SetIdentifier must be unique for each
resource record set that has the same combination of DNS name and type. Omit SetIdentifier
for any other types of record sets.
.TP
.B region
The region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
Dict, or pillar key pointing to a dict, containing AWS region/key/keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_route53.rr_present(name, HostedZoneId=None, DomainName=None, PrivateZone=False, Name=None, Type=None, SetIdentifier=None, Weight=None, Region=None, GeoLocation=None, Failover=None, TTL=None, ResourceRecords=None, AliasTarget=None, HealthCheckId=None, TrafficPolicyInstanceId=None, region=None, key=None, keyid=None, profile=None)
Ensure the Route53 record is present.
.INDENT 7.0
.TP
.B name
The name of the state definition.  This will be used for Name if the latter is
not provided.
.TP
.B HostedZoneId
The ID of a zone to create the record in.  Exclusive with DomainName.
.TP
.B DomainName
The domain name of a zone to create the record in.  Exclusive with HostedZoneId.
.TP
.B PrivateZone
Set to True if the resource record should be in a private zone, False if public.
.TP
.B Name
Name of the Route 53 resource record being managed.
.TP
.B Type
The record type (A, NS, MX, TXT, etc.)
.TP
.B SetIdentifier
Valid for Weighted, Latency, Geolocation, and Failover resource record sets only.
An identifier that differentiates among multiple resource record sets that have the same
combination of DNS name and type.  The value of SetIdentifier must be unique for each
resource record set that has the same combination of DNS name and type. Omit SetIdentifier
for any other types of record sets.
.TP
.B Weight
Valid for Weighted resource record sets only.  Among resource record sets that have the
same combination of DNS name and type, a value that determines the proportion of DNS
queries that Amazon Route 53 responds to using the current resource record set. Amazon Route
53 calculates the sum of the weights for the resource record sets that have the same
combination of DNS name and type. Amazon Route 53 then responds to queries based on the
ratio of a resource\(aqs weight to the total.
.sp
Note the following:
.INDENT 7.0
.IP \(bu 2
You must specify a value for the Weight element for every weighted resource record set.
.IP \(bu 2
You can only specify one ResourceRecord per weighted resource record set.
.IP \(bu 2
You can\(aqt create latency, failover, or geolocation resource record sets that have the
same values for the Name and Type elements as weighted resource record sets.
.IP \(bu 2
You can create a maximum of 100 weighted resource record sets that have the same values
for the Name and Type elements.
.IP \(bu 2
For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a
resource record set, Amazon Route 53 never responds to queries with the applicable value
for that resource record set.  However, if you set Weight to 0 for all resource record
sets that have the same combination of DNS name and type, traffic is routed to all
resources with equal probability.  The effect of setting Weight to 0 is different when
you associate health checks with weighted resource record sets. For more information,
see \fI\%Options for Configuring Amazon Route 53 Active\-Active and Active\-Passive Failover\fP
in the Amazon Route 53 Developer Guide.
.UNINDENT
.TP
.B Region
Valid for Latency\-based resource record sets only.  The Amazon EC2 Region where the resource
that is specified in this resource record set resides. The resource typically is an AWS
resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP
address or a DNS domain name, depending on the record type.
.TP
.B GeoLocation
Geo location resource record sets only.  A dict that lets you control how Route 53 responds
to DNS queries based on the geographic origin of the query.  For example, if you want all
queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a
resource record set with a Type of A and a ContinentCode of AF.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ContinentCode
    The two\-letter code for the continent.
    Valid values: AF | AN | AS | EU | OC | NA | SA
    Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode
                returns an InvalidInput error.
CountryCode
    The two\-letter code for the country.
SubdivisionCode
    The code for the subdivision, for example, a state in the United States or a
    province in Canada.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Notes
.INDENT 7.0
.IP \(bu 2
Creating geolocation and geolocation alias resource record sets in private hosted zones
is not supported.
.IP \(bu 2
If you create separate resource record sets for overlapping geographic regions (for
example, one resource record set for a continent and one for a country on the same
continent), priority goes to the smallest geographic region. This allows you to route
most queries for a continent to one resource and to route queries for a country on that
continent to a different resource.
.IP \(bu 2
You can\(aqt create two geolocation resource record sets that specify the same geographic
location.
.IP \(bu 2
The value \fB*\fP in the CountryCode element matches all geographic locations that aren\(aqt
specified in other geolocation resource record sets that have the same values for the
Name and Type elements.
.IP \(bu 2
Geolocation works by mapping IP addresses to locations.  However, some IP addresses
aren\(aqt mapped to geographic locations, so even if you create geolocation resource
record sets that cover all seven continents, Amazon Route 53 will receive some DNS
queries from locations that it can\(aqt identify.  We recommend that you
create a resource record set for which the value of CountryCode is
\fB*\fP, which handles both queries that come from locations for which you
haven\(aqt created geolocation resource record sets and queries from IP
addresses that aren\(aqt mapped to a location.  If you don\(aqt create a \fB*\fP
resource record set, Amazon Route 53 returns a \(dqno answer\(dq response
for queries from those locations.
.IP \(bu 2
You can\(aqt create non\-geolocation resource record sets that have the same values for the
Name and Type elements as geolocation resource record sets.
.UNINDENT
.TP
.B TTL
The resource record cache time to live (TTL), in seconds.
Note the following:
.INDENT 7.0
.IP \(bu 2
If you\(aqre creating an alias resource record set, omit TTL. Amazon Route 53 uses the
value of TTL for the alias target.
.IP \(bu 2
If you\(aqre associating this resource record set with a health check (if you\(aqre adding
a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so
clients respond quickly to changes in health status.
.IP \(bu 2
All of the resource record sets in a group of weighted, latency, geolocation, or
failover resource record sets must have the same value for TTL.
.IP \(bu 2
If a group of weighted resource record sets includes one or more weighted alias
resource record sets for which the alias target is an ELB load balancer, we recommend
that you specify a TTL of 60 seconds for all of the non\-alias weighted resource record
sets that have the same name and type. Values other than 60 seconds (the TTL for load
balancers) will change the effect of the values that you specify for Weight.
.UNINDENT
.TP
.B ResourceRecords
A list, containing one or more values for the resource record.  No single value can exceed
4,000 characters.  For details on how to format values for different record types, see
\fI\%Supported DNS Resource Record Types\fP in the Amazon Route 53 Developer Guide.
.sp
Note:  You can specify more than one value for all record types except CNAME and SOA.
.sp
It is also possible to pass \(dqmagic\(dq strings as resource record values.  This functionality
can easily be extended, but for the moment supports the following:
.INDENT 7.0
.INDENT 3.5
\(aqmagic:ec2_instance_tag:some_tag_name:some_string:some_instance_attr\(aq
.UNINDENT
.UNINDENT
.sp
This tells salt to lookup an EC2 instance with a tag \(aqsome_tag_name\(aq which has the value
\(aqsome_string\(aq and substitute the \(aqsome_instance_attr\(aq attribute of that instance as the
resource record value being evaluated.
.sp
This should work generally for any EC2 instance tags, as long as the instance attribute
being fetched is available to getattr(instance, \(aqattribute\(aq) as seen in the code below.
Anything else will most likely require this function to be extended to handle it.
.sp
The canonical use\-case for this (at least at our site) is to query the Name tag (which
we always populate with the host\(aqs FQDN) to lookup the public or private IPs bound to the
instance, so we can then automgically create Route 53 records for them.
.TP
.B AliasTarget
The rules governing how to define an AliasTarget for the various supported use\-cases are
obtuse beyond reason and attempting to paraphrase them (or even worse, cut\-and\-paste them
in their entirety) would be silly and counterproductive.  If you need this feature, then
Read The Fine Materials at the \fI\%Boto 3 Route 53 page\fP and/or the \fI\%AWS Route 53 docs\fP
and suss them for yourself \- I sure won\(aqt claim to understand them partcularly well.
.TP
.B region
The region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
Dict, or pillar key pointing to a dict, containing AWS region/key/keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto3_sns
.SS Manage SNS Topics
.sp
Create and destroy SNS topics. Be aware that this interacts with Amazon\(aqs
services, and so may incur charges.
.sp
This module uses \fBboto\fP, which can be installed via package, or pip.
.sp
This module accepts explicit AWS credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sns.keyid: GKTADJGHEIQSXMKKRBJ08H
sns.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile, either
passed in as a dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mytopic:
    boto3_sns.topic_present:
        \- region: us\-east\-1
        \- keyid: GKTADJGHEIQSXMKKRBJ08H
        \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Using a profile from pillars
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mytopic:
    boto3_sns.topic_present:
        \- region: us\-east\-1
        \- profile: mysnsprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Passing in a profile
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mytopic:
    boto3_sns.topic_present:
        \- region: us\-east\-1
        \- profile:
            keyid: GKTADJGHEIQSXMKKRBJ08H
            key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_sns.topic_absent(name, unsubscribe=False, region=None, key=None, keyid=None, profile=None)
Ensure the named sns topic is deleted.
.INDENT 7.0
.TP
.B name
Name of the SNS topic.
.TP
.B unsubscribe
If True, unsubscribe all subcriptions to the SNS topic before
deleting the SNS topic
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto3_sns.topic_present(name, subscriptions=None, attributes=None, region=None, key=None, keyid=None, profile=None)
Ensure the SNS topic exists.
.INDENT 7.0
.TP
.B name
Name of the SNS topic.
.TP
.B subscriptions
List of SNS subscriptions.
.sp
Each subscription is a dictionary with a protocol and endpoint key:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
subscriptions:
\- Protocol: https
  Endpoint: https://www.example.com/sns\-endpoint
\- Protocol: sqs
  Endpoint: arn:aws:sqs:us\-west\-2:123456789012:MyQueue
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B attributes
Dictionary of attributes to set on the SNS topic
Valid attribute keys are:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Policy:  the JSON serialization of the topic\(aqs access control policy
.IP \(bu 2
.INDENT 2.0
.TP
.B DisplayName:  the human\-readable name used in the \(dqFrom\(dq field for notifications
to email and email\-json endpoints
.UNINDENT
.IP \(bu 2
DeliveryPolicy:  the JSON serialization of the topic\(aqs delivery policy
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_apigateway
.SS Manage Apigateway Rest APIs
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
boto >= 2.8.0
.IP \(bu 2
boto3 >= 1.2.1
.IP \(bu 2
botocore >= 1.4.49
.UNINDENT
.UNINDENT
.sp
Create and destroy rest apis depending on a swagger version 2 definition file.
Be aware that this interacts with Amazon\(aqs services, and so may incur charges.
.sp
This module uses \fBboto3\fP, which can be installed via package, or pip.
.sp
This module accepts explicit vpc credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vpc.keyid: GKTADJGHEIQSXMKKRBJ08H
vpc.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile,
either passed in as a dict, or as a string to pull from pillars or minion
config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
  region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure Apigateway API exists:
  boto_apigateway.present:
    \- name: myfunction
    \- region: us\-east\-1
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_apigateway.absent(name, api_name, stage_name, nuke_api=False, region=None, key=None, keyid=None, profile=None)
Ensure the stage_name associated with the given api_name deployed by boto_apigateway\(aqs
present state is removed.  If the currently associated deployment to the given stage_name has
no other stages associated with it, the deployment will also be removed.
.INDENT 7.0
.TP
.B name
Name of the swagger file in YAML format
.TP
.B api_name
Name of the rest api on AWS ApiGateway to ensure is absent.
.TP
.B stage_name
Name of the stage to be removed irrespective of the swagger file content.
If the current deployment associated with the stage_name has no other stages associated
with it, the deployment will also be removed.
.TP
.B nuke_api
If True, removes the API itself only if there are no other stages associated with any other
deployments once the given stage_name is removed.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_apigateway.present(name, api_name, swagger_file, stage_name, api_key_required, lambda_integration_role, lambda_region=None, stage_variables=None, region=None, key=None, keyid=None, profile=None, lambda_funcname_format=\(aq{stage}_{api}_{resource}_{method}\(aq, authorization_type=\(aqNONE\(aq, error_response_template=None, response_template=None)
Ensure the spcified api_name with the corresponding swaggerfile is deployed to the
given stage_name in AWS ApiGateway.
.sp
this state currently only supports ApiGateway integration with AWS Lambda, and CORS support is
handled through a Mock integration.
.sp
There may be multiple deployments for the API object, each deployment is tagged with a description
(i.e. unique label) in pretty printed json format consisting of the following key/values.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqapi_name\(dq: api_name,
    \(dqswagger_file\(dq: basename_of_swagger_file
    \(dqswagger_file_md5sum\(dq: md5sum_of_swagger_file,
    \(dqswagger_info_object\(dq: info_object_content_in_swagger_file
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Please note that the name of the lambda function to be integrated will be derived
via the provided lambda_funcname_format parameters:
.INDENT 7.0
.IP \(bu 2
the default lambda_funcname_format is a string with the following
substitutable keys: \(dq{stage}_{api}_{resource}_{method}\(dq.  The user can
choose to reorder the known keys.
.IP \(bu 2
the stage key corresponds to the stage_name passed in.
.IP \(bu 2
the api key corresponds to the api_name passed in.
.IP \(bu 2
the resource corresponds to the resource path defined in the passed swagger file.
.IP \(bu 2
the method corresponds to the method for a resource path defined in the passed swagger file.
.UNINDENT
.sp
For the default lambda_funcname_format, given the following input:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
api_name = \(aq  Test    Service\(aq
stage_name = \(aqalpha\(aq
basePath = \(aq/api\(aq
path = \(aq/a/{b}/c\(aq
method = \(aqPOST\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
We will end up with the following Lambda Function Name that will be looked
up: \(aqtest_service_alpha_a_b_c_post\(aq
.sp
The canconicalization of these input parameters is done in the following order:
.INDENT 7.0
.IP 1. 3
lambda_funcname_format is formatted with the input parameters as passed,
.IP 2. 3
resulting string is stripped for leading/trailing spaces,
.IP 3. 3
path parameter\(aqs curly braces are removed from the resource path,
.IP 4. 3
consecutive spaces and forward slashes in the paths are replaced with \(aq_\(aq
.IP 5. 3
consecutive \(aq_\(aq are replaced with \(aq_\(aq
.UNINDENT
.sp
Please note that for error response handling, the swagger file must have an error response model
with the following schema.  The lambda functions should throw exceptions for any non successful responses.
An optional pattern field can be specified in errorMessage field to aid the response mapping from Lambda
to the proper error return status codes.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Error:
  type: object
  properties:
    stackTrace:
      type: array
      items:
        type: array
        items:
          type: string
      description: call stack
  errorType:
    type: string
    description: error type
  errorMessage:
    type: string
    description: |
      Error message, will be matched based on pattern.
      If no pattern is specified, the default pattern used for response mapping will be +*.
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the state definition
.TP
.B api_name
The name of the rest api that we want to ensure exists in AWS API Gateway
.TP
.B swagger_file
Name of the location of the swagger rest api definition file in YAML format.
.TP
.B stage_name
Name of the stage we want to be associated with the given api_name and swagger_file
definition
.TP
.B api_key_required
True or False \- whether the API Key is required to call API methods
.TP
.B lambda_integration_role
The name or ARN of the IAM role that the AWS ApiGateway assumes when it
executes your lambda function to handle incoming requests
.TP
.B lambda_region
The region where we expect to find the lambda functions.  This is used to
determine the region where we should look for the Lambda Function for
integration purposes.  The region determination is based on the following
priority:
.INDENT 7.0
.IP 1. 3
lambda_region as passed in (is not None)
.IP 2. 3
if lambda_region is None, use the region as if a boto_lambda
function were executed without explicitly specifying lambda region.
.IP 3. 3
if region determined in (2) is different than the region used by
boto_apigateway functions, a final lookup will be attempted using
the boto_apigateway region.
.UNINDENT
.TP
.B stage_variables
A dict with variables and their values, or a pillar key (string) that
contains a dict with variables and their values.
key and values in the dict must be strings.  {\(aqstring\(aq: \(aqstring\(aq}
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.TP
.B lambda_funcname_format
Please review the earlier example for the usage.  The only substituable keys in the funcname
format are {stage}, {api}, {resource}, {method}.
Any other keys or positional substitution parameters will be flagged as an invalid input.
.TP
.B authorization_type
This field can be either \(aqNONE\(aq, or \(aqAWS_IAM\(aq.  This will be applied to all methods in the given
swagger spec file.  Default is set to \(aqNONE\(aq
.TP
.B error_response_template
String value that defines the response template mapping that should be applied in cases error occurs.
Refer to AWS documentation for details: \fI\%http://docs.aws.amazon.com/apigateway/latest/developerguide/api\-gateway\-mapping\-template\-reference.html\fP
.sp
If set to None, the following default value is used:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\(aq#set($inputRoot = $input.path(\(aq$\(aq))\en\(aq
\(aq{\en\(aq
\(aq  \(dqerrorMessage\(dq : \(dq$inputRoot.errorMessage\(dq,\en\(aq
\(aq  \(dqerrorType\(dq : \(dq$inputRoot.errorType\(dq,\en\(aq
\(aq  \(dqstackTrace\(dq : [\en\(aq
\(aq#foreach($stackTrace in $inputRoot.stackTrace)\en\(aq
\(aq    [\en\(aq
\(aq#foreach($elem in $stackTrace)\en\(aq
\(aq      \(dq$elem\(dq\en\(aq
\(aq#if($foreach.hasNext),#end\en\(aq
\(aq#end\en\(aq
\(aq    ]\en\(aq
\(aq#if($foreach.hasNext),#end\en\(aq
\(aq#end\en\(aq
\(aq  ]\en\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.TP
.B response_template
String value that defines the response template mapping applied in case
of success (including OPTIONS method) If set to None, empty ({})
template is assumed, which will transfer response from the lambda
function as is.
.sp
New in version 2017.7.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_apigateway.usage_plan_absent(name, plan_name, region=None, key=None, keyid=None, profile=None)
Ensures usage plan identified by name is no longer present
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B name
name of the state
.TP
.B plan_name
name of the plan to remove
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
usage plan absent:
  boto_apigateway.usage_plan_absent:
    \- plan_name: my_usage_plan
    \- profile: my_profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_apigateway.usage_plan_association_absent(name, plan_name, api_stages, region=None, key=None, keyid=None, profile=None)
Ensures usage plan identified by name is removed from provided api_stages
If a plan is associated to stages not listed in api_stages parameter,
those associations remain intact.
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B name
name of the state
.TP
.B plan_name
name of the plan to use
.TP
.B api_stages
list of dictionaries, where each dictionary consists of the following keys:
.INDENT 7.0
.TP
.B apiId
apiId of the api to detach usage plan from
.TP
.B stage
stage name of the api to detach usage plan from
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
UsagePlanAssociationAbsent:
  boto_apigateway.usage_plan_association_absent:
    \- plan_name: my_plan
    \- api_stages:
      \- apiId: 9kb0404ec0
        stage: my_stage
      \- apiId: l9v7o2aj90
        stage: my_stage
    \- profile: my_profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_apigateway.usage_plan_association_present(name, plan_name, api_stages, region=None, key=None, keyid=None, profile=None)
Ensures usage plan identified by name is added to provided api_stages
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B name
name of the state
.TP
.B plan_name
name of the plan to use
.TP
.B api_stages
list of dictionaries, where each dictionary consists of the following keys:
.INDENT 7.0
.TP
.B apiId
apiId of the api to attach usage plan to
.TP
.B stage
stage name of the api to attach usage plan to
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
UsagePlanAssociationPresent:
  boto_apigateway.usage_plan_association_present:
    \- plan_name: my_plan
    \- api_stages:
      \- apiId: 9kb0404ec0
        stage: my_stage
      \- apiId: l9v7o2aj90
        stage: my_stage
    \- profile: my_profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_apigateway.usage_plan_present(name, plan_name, description=None, throttle=None, quota=None, region=None, key=None, keyid=None, profile=None)
Ensure the spcifieda usage plan with the corresponding metrics is deployed
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B name
name of the state
.TP
.B plan_name
[Required] name of the usage plan
.TP
.B throttle
[Optional] throttling parameters expressed as a dictionary.
If provided, at least one of the throttling parameters must be present
.INDENT 7.0
.TP
.B rateLimit
rate per second at which capacity bucket is populated
.TP
.B burstLimit
maximum rate allowed
.UNINDENT
.TP
.B quota
[Optional] quota on the number of api calls permitted by the plan.
If provided, limit and period must be present
.INDENT 7.0
.TP
.B limit
[Required] number of calls permitted per quota period
.TP
.B offset
[Optional] number of calls to be subtracted from the limit at the beginning of the period
.TP
.B period
[Required] period to which quota applies. Must be DAY, WEEK or MONTH
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
UsagePlanPresent:
  boto_apigateway.usage_plan_present:
    \- plan_name: my_usage_plan
    \- throttle:
        rateLimit: 70
        burstLimit: 100
    \- quota:
        limit: 1000
        offset: 0
        period: DAY
    \- profile: my_profile
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.boto_asg
.SS Manage Autoscale Groups
.sp
New in version 2014.7.0.

.sp
Create and destroy autoscale groups. Be aware that this interacts with Amazon\(aqs
services, and so may incur charges.
.sp
This module uses boto, which can be installed via package, or pip.
.sp
This module accepts explicit autoscale credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
asg.keyid: GKTADJGHEIQSXMKKRBJ08H
asg.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure myasg exists:
  boto_asg.present:
    \- name: myasg
    \- launch_config_name: mylc
    \- availability_zones:
      \- us\-east\-1a
      \- us\-east\-1b
    \- min_size: 1
    \- max_size: 1
    \- desired_capacity: 1
    \- load_balancers:
      \- myelb
    \- suspended_processes:
        \- AddToLoadBalancer
        \- AlarmNotification
    \- scaling_policies
        \- adjustment_type: ChangeInCapacity
        \- as_name: api\-production\-iad
        \- cooldown: 1800
        \- min_adjustment_step: None
        \- name: ScaleDown
        \- scaling_adjustment: \-1
    \- region: us\-east\-1
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

# Using a profile from pillars.
Ensure myasg exists:
  boto_asg.present:
    \- name: myasg
    \- launch_config_name: mylc
    \- availability_zones:
      \- us\-east\-1a
      \- us\-east\-1b
    \- min_size: 1
    \- max_size: 1
    \- desired_capacity: 1
    \- load_balancers:
      \- myelb
    \- profile: myprofile

# Passing in a profile.
Ensure myasg exists:
  boto_asg.present:
    \- name: myasg
    \- launch_config_name: mylc
    \- availability_zones:
      \- us\-east\-1a
      \- us\-east\-1b
    \- min_size: 1
    \- max_size: 1
    \- desired_capacity: 1
    \- load_balancers:
      \- myelb
    \- profile:
        keyid: GKTADJGHEIQSXMKKRBJ08H
        key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        region: us\-east\-1

# Deleting an autoscale group with running instances.
Ensure myasg is deleted:
  boto_asg.absent:
    \- name: myasg
    # If instances exist, we must force the deletion of the asg.
    \- force: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs possible to specify cloudwatch alarms that will be setup along with the
ASG. Note the alarm name will be the name attribute defined, plus the ASG
resource name.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure myasg exists:
  boto_asg.present:
    \- name: myasg
    \- launch_config_name: mylc
    \- availability_zones:
      \- us\-east\-1a
      \- us\-east\-1b
    \- min_size: 1
    \- max_size: 1
    \- desired_capacity: 1
    \- load_balancers:
      \- myelb
    \- profile: myprofile
    \- alarms:
        CPU:
          name: \(aqASG CPU **MANAGED BY SALT**\(aq
          attributes:
            metric: CPUUtilization
            namespace: AWS/EC2
            statistic: Average
            comparison: \(aq>=\(aq
            threshold: 65.0
            period: 60
            evaluation_periods: 30
            unit: null
            description: \(aqASG CPU\(aq
            alarm_actions: [ \(aqarn:aws:sns:us\-east\-1:12345:myalarm\(aq ]
            insufficient_data_actions: []
            ok_actions: [ \(aqarn:aws:sns:us\-east\-1:12345:myalarm\(aq ]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also use alarms from pillars, and override values from the pillar
alarms by setting overrides on the resource. Note that \(aqboto_asg_alarms\(aq
will be used as a default value for all resources, if defined and can be
used to ensure alarms are always set for an ASG resource.
.sp
Setting the alarms in a pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_asg_alarm:
  CPU:
    name: \(aqASG CPU **MANAGED BY SALT**\(aq
    attributes:
      metric: CPUUtilization
      namespace: AWS/EC2
      statistic: Average
      comparison: \(aq>=\(aq
      threshold: 65.0
      period: 60
      evaluation_periods: 30
      unit: null
      description: \(aqASG CPU\(aq
      alarm_actions: [ \(aqarn:aws:sns:us\-east\-1:12345:myalarm\(aq ]
      insufficient_data_actions: []
      ok_actions: [ \(aqarn:aws:sns:us\-east\-1:12345:myalarm\(aq ]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Overriding the alarm values on the resource:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure myasg exists:
  boto_asg.present:
    \- name: myasg
    \- launch_config_name: mylc
    \- availability_zones:
      \- us\-east\-1a
      \- us\-east\-1b
    \- min_size: 1
    \- max_size: 1
    \- desired_capacity: 1
    \- load_balancers:
      \- myelb
    \- profile: myprofile
    \- alarms_from_pillar: my_asg_alarm
    # override CPU:attributes:threshold
    \- alarms:
        CPU:
          attributes:
            threshold: 50.0
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_asg.absent(name, force=False, region=None, key=None, keyid=None, profile=None, remove_lc=False)
Ensure the named autoscale group is deleted.
.INDENT 7.0
.TP
.B name
Name of the autoscale group.
.TP
.B force
Force deletion of autoscale group.
.TP
.B remove_lc
Delete the launch config as well.
.TP
.B region
The region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_asg.present(name, launch_config_name, availability_zones, min_size, max_size, launch_config=None, desired_capacity=None, load_balancers=None, default_cooldown=None, health_check_type=None, health_check_period=None, placement_group=None, vpc_zone_identifier=None, subnet_names=None, tags=None, termination_policies=None, termination_policies_from_pillar=\(aqboto_asg_termination_policies\(aq, suspended_processes=None, scaling_policies=None, scaling_policies_from_pillar=\(aqboto_asg_scaling_policies\(aq, scheduled_actions=None, scheduled_actions_from_pillar=\(aqboto_asg_scheduled_actions\(aq, alarms=None, alarms_from_pillar=\(aqboto_asg_alarms\(aq, region=None, key=None, keyid=None, profile=None, notification_arn=None, notification_arn_from_pillar=\(aqboto_asg_notification_arn\(aq, notification_types=None, notification_types_from_pillar=\(aqboto_asg_notification_types\(aq)
Ensure the autoscale group exists.
.INDENT 7.0
.TP
.B name
Name of the autoscale group.
.TP
.B launch_config_name
Name of the launch config to use for the group.  Or, if
\fBlaunch_config\fP is specified, this will be the launch config
name\(aqs prefix.  (see below)
.TP
.B launch_config
A dictionary of launch config attributes.  If specified, a
launch config will be used or created, matching this set
of attributes, and the autoscale group will be set to use
that launch config.  The launch config name will be the
\fBlaunch_config_name\fP followed by a hyphen followed by a hash
of the \fBlaunch_config\fP dict contents.
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my_asg:
  boto_asg.present:
  \- launch_config:
    \- ebs_optimized: false
    \- instance_profile_name: my_iam_profile
    \- kernel_id: \(aq\(aq
    \- ramdisk_id: \(aq\(aq
    \- key_name: my_ssh_key
    \- image_name: aws2015091\-hvm
    \- instance_type: c3.xlarge
    \- instance_monitoring: false
    \- security_groups:
      \- my_sec_group_01
      \- my_sec_group_02
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B availability_zones
List of availability zones for the group.
.TP
.B min_size
Minimum size of the group.
.TP
.B max_size
Maximum size of the group.
.TP
.B desired_capacity
The desired capacity of the group.
.TP
.B load_balancers
List of load balancers for the group. Once set this can not be
updated (Amazon restriction).
.TP
.B default_cooldown
Number of seconds after a Scaling Activity completes before any further
scaling activities can start.
.TP
.B health_check_type
The service you want the health status from, Amazon EC2 or Elastic Load
Balancer (EC2 or ELB).
.TP
.B health_check_period
Length of time in seconds after a new EC2 instance comes into service
that Auto Scaling starts checking its health.
.TP
.B placement_group
Physical location of your cluster placement group created in Amazon
EC2. Once set this can not be updated (Amazon restriction).
.TP
.B vpc_zone_identifier
A list of the subnet identifiers of the Virtual Private Cloud.
.TP
.B subnet_names
For VPC, a list of subnet names (NOT subnet IDs) to deploy into.
Exclusive with vpc_zone_identifier.
.TP
.B tags
A list of tags. Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- key: \(aqkey\(aq
  value: \(aqvalue\(aq
  propagate_at_launch: true
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B termination_policies
A list of termination policies. Valid values are:
.INDENT 7.0
.IP \(bu 2
\fBOldestInstance\fP
.IP \(bu 2
\fBNewestInstance\fP
.IP \(bu 2
\fBOldestLaunchConfiguration\fP
.IP \(bu 2
\fBClosestToNextInstanceHour\fP
.IP \(bu 2
\fBDefault\fP
.UNINDENT
.sp
If no value is specified, the \fBDefault\fP value is used.
.TP
.B termination_policies_from_pillar:
name of pillar dict that contains termination policy settings.   Termination policies
defined for this specific state will override those from pillar.
.TP
.B suspended_processes
List of processes to be suspended. see
\fI\%http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html\fP
.TP
.B scaling_policies
List of scaling policies.  Each policy is a dict of key\-values described by
\fI\%https://boto.readthedocs.io/en/latest/ref/autoscale.html#boto.ec2.autoscale.policy.ScalingPolicy\fP
.TP
.B scaling_policies_from_pillar:
name of pillar dict that contains scaling policy settings.   Scaling policies defined for
this specific state will override those from pillar.
.TP
.B scheduled_actions:
a dictionary of scheduled actions. Each key is the name of scheduled action and each value
is dictionary of options. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- scheduled_actions:
    scale_up_at_10:
        desired_capacity: 4
        min_size: 3
        max_size: 5
        recurrence: \(dq0 9 * * 1\-5\(dq
    scale_down_at_7:
        desired_capacity: 1
        min_size: 1
        max_size: 1
        recurrence: \(dq0 19 * * 1\-5\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B scheduled_actions_from_pillar:
name of pillar dict that contains scheduled_actions settings. Scheduled actions
for this specific state will override those from pillar.
.TP
.B alarms:
a dictionary of name\->boto_cloudwatch_alarm sections to be associated with this ASG.
All attributes should be specified except for dimension which will be
automatically set to this ASG.
.sp
See the \fI\%salt.states.boto_cloudwatch_alarm\fP state for information
about these attributes.
.sp
If any alarm actions include  \(dq:self:\(dq this will be replaced with the asg name.
For example, alarm_actions reading \(dq[\(aqscaling_policy:self:ScaleUp\(aq]\(dq will
map to the arn for this asg\(aqs scaling policy named \(dqScaleUp\(dq.
In addition, any alarms that have only scaling_policy as actions will be ignored if
min_size is equal to max_size for this ASG.
.TP
.B alarms_from_pillar:
name of pillar dict that contains alarm settings.   Alarms defined for this specific
state will override those from pillar.
.TP
.B region
The region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.TP
.B notification_arn
The AWS arn that notifications will be sent to
.TP
.B notification_arn_from_pillar
name of the pillar dict that contains \fBnotifcation_arn\fP settings.  A
\fBnotification_arn\fP defined for this specific state will override the
one from pillar.
.TP
.B notification_types
A list of event names that will trigger a notification.  The list of valid
notification types is:
.INDENT 7.0
.IP \(bu 2
\fBautoscaling:EC2_INSTANCE_LAUNCH\fP
.IP \(bu 2
\fBautoscaling:EC2_INSTANCE_LAUNCH_ERROR\fP
.IP \(bu 2
\fBautoscaling:EC2_INSTANCE_TERMINATE\fP
.IP \(bu 2
\fBautoscaling:EC2_INSTANCE_TERMINATE_ERROR\fP
.IP \(bu 2
\fBautoscaling:TEST_NOTIFICATION\fP
.UNINDENT
.TP
.B notification_types_from_pillar
name of the pillar dict that contains \fBnotifcation_types\fP settings.
\fBnotification_types\fP defined for this specific state will override those
from the pillar.
.UNINDENT
.UNINDENT
.SS salt.states.boto_cfn
.sp
Connection module for Amazon Cloud Formation
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B depends
boto
.TP
.B configuration
This module accepts explicit AWS credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at
\fI\%http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html\fP
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
keyid: GKTADJGHEIQSXMKKRBJ08H
key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
stack\-present:
  boto_cfn.present:
    \- name: mystack
    \- template_body: salt://base/mytemplate.json
    \- disable_rollback: true
    \- region: eu\-west\-1
    \- keyid: \(aqAKIAJHTMIQ2ASDFLASDF\(aq
    \- key: \(aqfdkjsafkljsASSADFalkfjasdf\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
stack\-absent:
  boto_cfn.absent:
    \- name: mystack
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_cfn.absent(name, region=None, key=None, keyid=None, profile=None)
Ensure cloud formation stack is absent.
.sp
name (string) – The name of the stack to delete.
.sp
region (string) \- Region to connect to.
.sp
key (string) \- Secret key to be used.
.sp
keyid (string) \- Access key to be used.
.sp
profile (dict) \- A dict with region, key and keyid, or a pillar key (string) that contains a dict with region, key
and keyid.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_cfn.present(name, template_body=None, template_url=None, parameters=None, notification_arns=None, disable_rollback=None, timeout_in_minutes=None, capabilities=None, tags=None, on_failure=None, stack_policy_body=None, stack_policy_url=None, use_previous_template=None, stack_policy_during_update_body=None, stack_policy_during_update_url=None, region=None, key=None, keyid=None, profile=None)
Ensure cloud formation stack is present.
.sp
name (string) \- Name of the stack.
.sp
template_body (string) – Structure containing the template body. Can also be loaded from a file by using salt://.
.sp
template_url (string) – Location of file containing the template body. The URL must point to a template located in
an S3 bucket in the same region as the stack.
.sp
parameters (list) – A list of key/value tuples that specify input parameters for the stack. A 3\-tuple (key, value,
bool) may be used to specify the UsePreviousValue option.
.sp
notification_arns (list) – The Simple Notification Service (SNS) topic ARNs to publish stack related events.
You can find your SNS topic ARNs using the \fI\%SNS_console\fP or your Command Line Interface (CLI).
.sp
disable_rollback (bool) – Indicates whether or not to rollback on failure.
.sp
timeout_in_minutes (integer) – The amount of time that can pass before the stack status becomes CREATE_FAILED; if
DisableRollback is not set or is set to False, the stack will be rolled back.
.sp
capabilities (list) – The list of capabilities you want to allow in the stack. Currently, the only valid capability
is ‘CAPABILITY_IAM’.
.sp
tags (dict) – A set of user\-defined Tags to associate with this stack, represented by key/value pairs. Tags defined
for the stack are propagated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can
be specified.
.sp
on_failure (string) – Determines what action will be taken if stack creation fails. This must be one of:
DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.
.sp
stack_policy_body (string) – Structure containing the stack policy body. Can also be loaded from a file by using
salt://.
.sp
stack_policy_url (string) – Location of a file containing the stack policy. The URL must point to a policy
(max size: 16KB) located in an S3 bucket in the same region as the stack.If you pass StackPolicyBody and
StackPolicyURL, only StackPolicyBody is used.
.sp
use_previous_template (boolean) – Used only when templates are not the same. Set to True to use the previous
template instead of uploading a new one via TemplateBody or TemplateURL.
.sp
stack_policy_during_update_body (string) – Used only when templates are not the same. Structure containing the
temporary overriding stack policy body. If you pass StackPolicyDuringUpdateBody and StackPolicyDuringUpdateURL,
only StackPolicyDuringUpdateBody is used. Can also be loaded from a file by using salt://.
.sp
stack_policy_during_update_url (string) – Used only when templates are not the same. Location of a file containing
the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in
the same region as the stack. If you pass StackPolicyDuringUpdateBody and StackPolicyDuringUpdateURL, only
StackPolicyDuringUpdateBody is used.
.sp
region (string) \- Region to connect to.
.sp
key (string) \- Secret key to be used.
.sp
keyid (string) \- Access key to be used.
.sp
profile (dict) \- A dict with region, key and keyid, or a pillar key (string) that contains a dict with region, key
and keyid.
.UNINDENT
.SS salt.states.boto_cloudfront
.sp
Manage CloudFront distributions
.sp
New in version 2018.3.0.

.sp
Create, update and destroy CloudFront distributions.
.sp
This module accepts explicit AWS credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API
and no further configuration is necessary.
More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them,
either in a pillar file or in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cloudfront.keyid: GKTADJGHEIQSXMKKRBJ08H
cloudfront.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP, and \fBregion\fP via a profile,
either passed in as a dict, or a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
aws:
    region:
        us\-east\-1:
            profile:
                keyid: GKTADJGHEIQSXMKKRBJ08H
                key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
                region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_cloudfront.present(name, config, tags, region=None, key=None, keyid=None, profile=None)
Ensure the CloudFront distribution is present.
.INDENT 7.0
.TP
.B name (string)
Name of the CloudFront distribution
.TP
.B config (dict)
Configuration for the distribution
.TP
.B tags (dict)
Tags to associate with the distribution
.TP
.B region (string)
Region to connect to
.TP
.B key (string)
Secret key to use
.TP
.B keyid (string)
Access key to use
.TP
.B profile (dict or string)
A dict with region, key, and keyid,
or a pillar key (string) that contains such a dict.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Manage my_distribution CloudFront distribution:
    boto_cloudfront.present:
      \- name: my_distribution
      \- config:
          Comment: \(aqpartial config shown, most parameters elided\(aq
          Enabled: True
      \- tags:
          testing_key: testing_value
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.boto_cloudtrail
.SS Manage CloudTrail Objects
.sp
New in version 2016.3.0.

.sp
Create and destroy CloudTrail objects. Be aware that this interacts with Amazon\(aqs services,
and so may incur charges.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
boto
.IP \(bu 2
boto3
.UNINDENT
.UNINDENT
.sp
The dependencies listed above can be installed via package or pip.
.sp
This module accepts explicit vpc credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vpc.keyid: GKTADJGHEIQSXMKKRBJ08H
vpc.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile,
either passed in as a dict, or as a string to pull from pillars or minion
config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure trail exists:
    boto_cloudtrail.present:
        \- Name: mytrail
        \- S3BucketName: mybucket
        \- S3KeyPrefix: prefix
        \- region: us\-east\-1
        \- keyid: GKTADJGHEIQSXMKKRBJ08H
        \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_cloudtrail.absent(name, Name, region=None, key=None, keyid=None, profile=None)
Ensure trail with passed properties is absent.
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B Name
Name of the trail.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_cloudtrail.present(name, Name, S3BucketName, S3KeyPrefix=None, SnsTopicName=None, IncludeGlobalServiceEvents=True, IsMultiRegionTrail=None, EnableLogFileValidation=False, CloudWatchLogsLogGroupArn=None, CloudWatchLogsRoleArn=None, KmsKeyId=None, LoggingEnabled=True, Tags=None, region=None, key=None, keyid=None, profile=None)
Ensure trail exists.
.INDENT 7.0
.TP
.B name
The name of the state definition
.TP
.B Name
Name of the trail.
.TP
.B S3BucketName
Specifies the name of the Amazon S3 bucket designated for publishing log
files.
.TP
.B S3KeyPrefix
Specifies the Amazon S3 key prefix that comes after the name of the
bucket you have designated for log file delivery.
.TP
.B SnsTopicName
Specifies the name of the Amazon SNS topic defined for notification of
log file delivery. The maximum length is 256 characters.
.TP
.B IncludeGlobalServiceEvents
Specifies whether the trail is publishing events from global services
such as IAM to the log files.
.TP
.B EnableLogFileValidation
Specifies whether log file integrity validation is enabled. The default
is false.
.TP
.B CloudWatchLogsLogGroupArn
Specifies a log group name using an Amazon Resource Name (ARN), a unique
identifier that represents the log group to which CloudTrail logs will
be delivered. Not required unless you specify CloudWatchLogsRoleArn.
.TP
.B CloudWatchLogsRoleArn
Specifies the role for the CloudWatch Logs endpoint to assume to write
to a user\(aqs log group.
.TP
.B KmsKeyId
Specifies the KMS key ID to use to encrypt the logs delivered by
CloudTrail. The value can be a an alias name prefixed by \(dqalias/\(dq, a
fully specified ARN to an alias, a fully specified ARN to a key, or a
globally unique identifier.
.TP
.B LoggingEnabled
Whether logging should be enabled for the trail
.TP
.B Tags
A dictionary of tags that should be set on the trail
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_cloudwatch_alarm
.sp
Manage Cloudwatch alarms
.sp
New in version 2014.7.0.

.sp
Create and destroy cloudwatch alarms. Be aware that this interacts with
Amazon\(aqs services, and so may incur charges.
.sp
This module uses boto, which can be installed via package, or pip.
.sp
This module accepts explicit credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at:
.sp
\fI\%http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam\-roles\-for\-amazon\-ec2.html\fP
.sp
If IAM roles are not used you need to specify them either in a pillar or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cloudwatch.keyid: GKTADJGHEIQSXMKKRBJ08H
cloudwatch.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
  region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my test alarm:
  boto_cloudwatch_alarm.present:
    \- name: my test alarm
    \- attributes:
        metric: ApproximateNumberOfMessagesVisible
        namespace: AWS/SQS
        statistic: Average
        comparison: \(dq>=\(dq
        threshold: 20000.0
        period: 60
        evaluation_periods: 1
        description: test alarm via salt
        dimensions:
          QueueName:
            \- the\-sqs\-queue\-name
        alarm_actions:
          \- arn:aws:sns:us\-east\-1:1111111:myalerting\-action
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_cloudwatch_alarm.absent(name, region=None, key=None, keyid=None, profile=None)
Ensure the named cloudwatch alarm is deleted.
.INDENT 7.0
.TP
.B name
Name of the alarm.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_cloudwatch_alarm.present(name, attributes, region=None, key=None, keyid=None, profile=None)
Ensure the cloudwatch alarm exists.
.INDENT 7.0
.TP
.B name
Name of the alarm
.TP
.B attributes
A dict of key/value cloudwatch alarm attributes.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_cloudwatch_event
.SS Manage CloudTrail Objects
.sp
New in version 2016.11.0.

.sp
Create and destroy CloudWatch event rules. Be aware that this interacts with Amazon\(aqs services,
and so may incur charges.
.sp
This module uses \fBboto3\fP, which can be installed via package, or pip.
.sp
This module accepts explicit vpc credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cloudwatch_event.keyid: GKTADJGHEIQSXMKKRBJ08H
cloudwatch_event.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile,
either passed in as a dict, or as a string to pull from pillars or minion
config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure event rule exists:
    boto_cloudwatch_event.present:
        \- Name: mytrail
        \- ScheduleExpression: \(aqrate(120 minutes)\(aq
        \- State: \(aqDISABLED\(aq
        \- Targets:
          \- Id: \(dqtarget1\(dq
            Arn: \(dqarn:aws:lambda:us\-west\-1:124456715622:function:my_function\(dq
            Input: \(aq{\(dqarbitrary\(dq: \(dqjson\(dq}\(aq
        \- region: us\-east\-1
        \- keyid: GKTADJGHEIQSXMKKRBJ08H
        \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_cloudwatch_event.absent(name, Name=None, region=None, key=None, keyid=None, profile=None)
Ensure CloudWatch event rule with passed properties is absent.
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B Name
Name of the event rule.  Defaults to the value of the \(aqname\(aq param if
not provided.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_cloudwatch_event.present(name, Name=None, ScheduleExpression=None, EventPattern=None, Description=None, RoleArn=None, State=None, Targets=None, region=None, key=None, keyid=None, profile=None)
Ensure trail exists.
.INDENT 7.0
.TP
.B name
The name of the state definition
.TP
.B Name
Name of the event rule.  Defaults to the value of the \(aqname\(aq param if
not provided.
.TP
.B ScheduleExpression
The scheduling expression. For example, \fBcron(0 20 * * ? *)\fP,
\(dqrate(5 minutes)\(dq
.TP
.B EventPattern
The event pattern.
.TP
.B Description
A description of the rule
.TP
.B State
Indicates whether the rule is ENABLED or DISABLED.
.TP
.B RoleArn
The Amazon Resource Name (ARN) of the IAM role associated with the
rule.
.TP
.B Targets
A list of rresources to be invoked when the rule is triggered.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_cognitoidentity
.SS Manage CognitoIdentity Functions
.sp
New in version 2016.11.0.

.sp
Create and destroy CognitoIdentity identity pools. Be aware that this interacts with
Amazon\(aqs services, and so may incur charges.
.sp
This module uses \fBboto3\fP, which can be installed via package, or pip.
.sp
This module accepts explicit vpc credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vpc.keyid: GKTADJGHEIQSXMKKRBJ08H
vpc.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile,
either passed in as a dict, or as a string to pull from pillars or minion
config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure function exists:
    boto_cognitoidentity.pool_present:
        \- PoolName: my_identity_pool
        \- region: us\-east\-1
        \- keyid: GKTADJGHEIQSXMKKRBJ08H
        \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_cognitoidentity.pool_absent(name, IdentityPoolName, RemoveAllMatched=False, region=None, key=None, keyid=None, profile=None)
Ensure cognito identity pool with passed properties is absent.
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B IdentityPoolName
Name of the Cognito Identity Pool.  Please note that this may
match multiple pools with the same given name, in which case,
all will be removed.
.TP
.B RemoveAllMatched
If True, all identity pools with the matching IdentityPoolName
will be removed.  If False and there are more than one identity pool
with the matching IdentityPoolName, no action will be taken.  If False
and there is only one identity pool with the matching IdentityPoolName,
the identity pool will be removed.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_cognitoidentity.pool_present(name, IdentityPoolName, AuthenticatedRole, AllowUnauthenticatedIdentities=False, UnauthenticatedRole=None, SupportedLoginProviders=None, DeveloperProviderName=None, OpenIdConnectProviderARNs=None, region=None, key=None, keyid=None, profile=None)
Ensure Cognito Identity Pool exists.
.INDENT 7.0
.TP
.B name
The name of the state definition
.TP
.B IdentityPoolName
Name of the Cognito Identity Pool
.TP
.B AuthenticatedRole
An IAM role name or ARN that will be associated with temporary AWS
credentials for an authenticated cognito identity.
.TP
.B AllowUnauthenticatedIdentities
Whether to allow anonymous user identities
.TP
.B UnauthenticatedRole
An IAM role name or ARN that will be associated with anonymous
user identities
.TP
.B SupportedLoginProviders
A dictionary or pillar that contains key:value pairs mapping provider
names to provider app IDs.
.TP
.B DeveloperProviderName
A string which is the domain by which Cognito will refer to your users.
This name acts as a placeholder that allows your backend and the Cognito
service to communicate about the developer provider.  Once you have set a
developer provider name, you cannot change it.  Please take care in setting
this parameter.
.TP
.B OpenIdConnectProviderARNs
A list or pillar name that contains a list of OpenID Connect provider ARNs.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_datapipeline
.sp
Manage Data Pipelines
.sp
New in version 2016.3.0.

.sp
Be aware that this interacts with Amazon\(aqs services, and so may incur charges.
.sp
This module uses \fBboto3\fP, which can be installed via package, or pip.
.sp
This module accepts explicit AWS credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
datapipeline.keyid: GKTADJGHEIQSXMKKRBJ08H
datapipeline.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile,
either passed in as a dict, or as a string to pull from pillars or minion
config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
  region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure daily data pipeline exists:
  boto_datapipeline.present:
    \- name: my\-datapipeline
    \- pipeline_objects:
        DefaultSchedule:
          name: Every 1 day
          fields:
            period: 1 Day
            type: Schedule
            startAt: FIRST_ACTIVATION_DATE_TIME
    \- parameter_values:
        myDDBTableName: my\-dynamo\-table
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_datapipeline.absent(name, region=None, key=None, keyid=None, profile=None)
Ensure a pipeline with the service_name does not exist
.INDENT 7.0
.TP
.B name
Name of the service to ensure a data pipeline does not exist for.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_datapipeline.present(name, pipeline_objects=None, pipeline_objects_from_pillars=\(aqboto_datapipeline_pipeline_objects\(aq, parameter_objects=None, parameter_objects_from_pillars=\(aqboto_datapipeline_parameter_objects\(aq, parameter_values=None, parameter_values_from_pillars=\(aqboto_datapipeline_parameter_values\(aq, region=None, key=None, keyid=None, profile=None)
Ensure the data pipeline exists with matching definition.
.INDENT 7.0
.TP
.B name
Name of the service to ensure a data pipeline exists for.
.TP
.B pipeline_objects
Pipeline objects to use. Will override objects read from pillars.
.TP
.B pipeline_objects_from_pillars
The pillar key to use for lookup.
.TP
.B parameter_objects
Parameter objects to use. Will override objects read from pillars.
.TP
.B parameter_objects_from_pillars
The pillar key to use for lookup.
.TP
.B parameter_values
Parameter values to use. Will override values read from pillars.
.TP
.B parameter_values_from_pillars
The pillar key to use for lookup.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_dynamodb
.SS Manage DynamoDB Tables
.sp
New in version 2015.5.0.

.sp
Create and destroy DynamoDB tables. Be aware that this interacts with Amazon\(aqs
services, and so may incur charges.
.sp
This module uses \fBboto\fP, which can be installed via package, or pip.
.sp
This module accepts explicit DynamoDB credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
keyid: GKTADJGHEIQSXMKKRBJ08H
key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a
profile, either passed in as a dict, or as a string to pull from
pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure DynamoDB table does not exist:
  boto_dynamodb.absent:
    \- table_name: new_table
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    \- region: us\-east\-1

Ensure DynamoDB table exists:
  boto_dynamodb.present:
    \- table_name: new_table
    \- read_capacity_units: 1
    \- write_capacity_units: 2
    \- hash_key: primary_id
    \- hash_key_data_type: N
    \- range_key: start_timestamp
    \- range_key_data_type: N
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    \- region: us\-east\-1
    \- local_indexes:
        \- index:
            \- name: \(dqprimary_id_end_timestamp_index\(dq
            \- hash_key: primary_id
            \- hash_key_data_type: N
            \- range_key: end_timestamp
            \- range_key_data_type: N
    \- global_indexes:
        \- index:
            \- name: \(dqname_end_timestamp_index\(dq
            \- hash_key: name
            \- hash_key_data_type: S
            \- range_key: end_timestamp
            \- range_key_data_type: N
            \- read_capacity_units: 3
            \- write_capacity_units: 4
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs possible to specify cloudwatch alarms that will be setup along with the
DynamoDB table. Note the alarm name will be defined by the name attribute
provided, plus the DynamoDB resource name.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure DynamoDB table exists:
  boto_dynamodb.present:
    \- name: new_table
    \- read_capacity_units: 1
    \- write_capacity_units: 2
    \- hash_key: primary_id
    \- hash_key_data_type: N
    \- range_key: start_timestamp
    \- range_key_data_type: N
    \- alarms:
         ConsumedWriteCapacityUnits:
            name: \(aqDynamoDB ConsumedWriteCapacityUnits **MANAGED BY SALT**\(aq
            attributes:
              metric: ConsumedWriteCapacityUnits
              namespace: AWS/DynamoDB
              statistic: Sum
              comparison: \(aq>=\(aq
              # threshold_percent is used to calculate the actual threshold
              # based on the provisioned capacity for the table.
              threshold_percent: 0.75
              period: 300
              evaluation_periods: 2
              unit: Count
              description: \(aqDynamoDB ConsumedWriteCapacityUnits\(aq
              alarm_actions: [ \(aqarn:aws:sns:us\-east\-1:1234:my\-alarm\(aq ]
              insufficient_data_actions: []
              ok_actions: [ \(aqarn:aws:sns:us\-east\-1:1234:my\-alarm\(aq ]
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    \- region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also use alarms from pillars, and override values from the pillar
alarms by setting overrides on the resource. Note that \(aqboto_dynamodb_alarms\(aq
will be used as a default value for all resources, if defined and can be
used to ensure alarms are always set for a resource.
.sp
Setting the alarms in a pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
boto_dynamodb_alarms:
  ConsumedWriteCapacityUnits:
    name: \(aqDynamoDB ConsumedWriteCapacityUnits **MANAGED BY SALT**\(aq
    attributes:
      metric: ConsumedWriteCapacityUnits
      namespace: AWS/DynamoDB
      statistic: Sum
      comparison: \(aq>=\(aq
      # threshold_percent is used to calculate the actual threshold
      # based on the provisioned capacity for the table.
      threshold_percent: 0.75
      period: 300
      evaluation_periods: 2
      unit: Count
      description: \(aqDynamoDB ConsumedWriteCapacityUnits\(aq
      alarm_actions: [ \(aqarn:aws:sns:us\-east\-1:1234:my\-alarm\(aq ]
      insufficient_data_actions: []
      ok_actions: [ \(aqarn:aws:sns:us\-east\-1:1234:my\-alarm\(aq ]

Ensure DynamoDB table exists:
  boto_dynamodb.present:
    \- name: new_table
    \- read_capacity_units: 1
    \- write_capacity_units: 2
    \- hash_key: primary_id
    \- hash_key_data_type: N
    \- range_key: start_timestamp
    \- range_key_data_type: N
    \- alarms:
         ConsumedWriteCapacityUnits:
            attributes:
              threshold_percent: 0.90
              period: 900
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.states.boto_dynamodb.GsiNotUpdatableError
Raised when a global secondary index cannot be updated.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_dynamodb.absent(name, region=None, key=None, keyid=None, profile=None)
Ensure the DynamoDB table does not exist.
.INDENT 7.0
.TP
.B name
Name of the DynamoDB table.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_dynamodb.present(name=None, table_name=None, region=None, key=None, keyid=None, profile=None, read_capacity_units=None, write_capacity_units=None, alarms=None, alarms_from_pillar=\(aqboto_dynamodb_alarms\(aq, hash_key=None, hash_key_data_type=None, range_key=None, range_key_data_type=None, local_indexes=None, global_indexes=None, backup_configs_from_pillars=\(aqboto_dynamodb_backup_configs\(aq)
Ensure the DynamoDB table exists. Table throughput can be updated after
table creation.
.sp
Global secondary indexes (GSIs) are managed with some exceptions:
.INDENT 7.0
.IP \(bu 2
If a GSI deletion is detected, a failure will occur (deletes should be
done manually in the AWS console).
.IP \(bu 2
If multiple GSIs are added in a single Salt call, a failure will occur
(boto supports one creation at a time). Note that this only applies after
table creation; multiple GSIs can be created during table creation.
.IP \(bu 2
Updates to existing GSIs are limited to read/write capacity only
(DynamoDB limitation).
.UNINDENT
.INDENT 7.0
.TP
.B name
Name of the DynamoDB table
.TP
.B table_name
Name of the DynamoDB table (deprecated)
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.TP
.B read_capacity_units
The read throughput for this table
.TP
.B write_capacity_units
The write throughput for this table
.TP
.B hash_key
The name of the attribute that will be used as the hash key
for this table
.TP
.B hash_key_data_type
The DynamoDB datatype of the hash key
.TP
.B range_key
The name of the attribute that will be used as the range key
for this table
.TP
.B range_key_data_type
The DynamoDB datatype of the range key
.TP
.B local_indexes
The local indexes you would like to create
.TP
.B global_indexes
The global indexes you would like to create
.TP
.B backup_configs_from_pillars
Pillars to use to configure DataPipeline backups
.UNINDENT
.UNINDENT
.SS salt.states.boto_ec2
.sp
Manage EC2
.sp
New in version 2015.8.0.

.sp
This module provides an interface to the Elastic Compute Cloud (EC2) service
from AWS.
.sp
The below code creates a key pair:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create\-key\-pair:
  boto_ec2.key_present:
    \- name: mykeypair
    \- save_private: /root/
    \- region: eu\-west\-1
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import\-key\-pair:
   boto_ec2.key_present:
    \- name: mykeypair
    \- upload_public: \(aqssh\-rsa AAAA\(aq
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also use salt:// in order to define the public key.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import\-key\-pair:
   boto_ec2.key_present:
    \- name: mykeypair
    \- upload_public: salt://mybase/public_key.pub
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The below code deletes a key pair:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
delete\-key\-pair:
  boto_ec2.key_absent:
    \- name: mykeypair
    \- region: eu\-west\-1
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_ec2.eni_absent(name, release_eip=False, region=None, key=None, keyid=None, profile=None)
Ensure the EC2 ENI is absent.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
Name tag associated with the ENI.
.TP
.B release_eip
True/False \- release any EIP associated with the ENI
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_ec2.eni_present(name, subnet_id=None, subnet_name=None, private_ip_address=None, description=None, groups=None, source_dest_check=True, allocate_eip=None, arecords=None, region=None, key=None, keyid=None, profile=None)
Ensure the EC2 ENI exists.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
Name tag associated with the ENI.
.TP
.B subnet_id
The VPC subnet ID the ENI will exist within.
.TP
.B subnet_name
The VPC subnet name the ENI will exist within.
.TP
.B private_ip_address
The private ip address to use for this ENI. If this is not specified
AWS will automatically assign a private IP address to the ENI. Must be
specified at creation time; will be ignored afterward.
.TP
.B description
Description of the key.
.TP
.B groups
A list of security groups to apply to the ENI.
.TP
.B source_dest_check
Boolean specifying whether source/destination checking is enabled on
the ENI.
.TP
.B allocate_eip
allocate and associate an EIP to the ENI. Could be \(aqstandard\(aq to
allocate Elastic IP to EC2 region or \(aqvpc\(aq to get it for a
particular VPC
.sp
Changed in version 2016.11.0.

.TP
.B arecords
A list of arecord dicts with attributes needed for the DNS add_record state.
By default the boto_route53.add_record state will be used, which requires: name, zone, ttl, and identifier.
See the boto_route53 state for information about these attributes.
Other DNS modules can be called by specifying the provider keyword.
By default, the private ENI IP address will be used, set \(aqpublic: True\(aq in the arecord dict to use the ENI\(aqs public IP address
.sp
New in version 2016.3.0.

.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_ec2.instance_absent(name, instance_name=None, instance_id=None, release_eip=False, region=None, key=None, keyid=None, profile=None, filters=None)
Ensure an EC2 instance does not exist (is stopped and removed).
.sp
Changed in version 2016.11.0.

.INDENT 7.0
.TP
.B name
(string) \- The name of the state definition.
.TP
.B instance_name
(string) \- The name of the instance.
.TP
.B instance_id
(string) \- The ID of the instance.
.TP
.B release_eip
(bool)   \- Release any associated EIPs during termination.
.TP
.B region
(string) \- Region to connect to.
.TP
.B key
(string) \- Secret key to be used.
.TP
.B keyid
(string) \- Access key to be used.
.TP
.B profile
(variable) \- A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.TP
.B filters
(dict) \- A dict of additional filters to use in matching the instance to
delete.
.UNINDENT
.sp
YAML example fragment:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- filters:
    vpc\-id: vpc\-abcdef12
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_ec2.instance_present(name, instance_name=None, instance_id=None, image_id=None, image_name=None, tags=None, key_name=None, security_groups=None, user_data=None, instance_type=None, placement=None, kernel_id=None, ramdisk_id=None, vpc_id=None, vpc_name=None, monitoring_enabled=None, subnet_id=None, subnet_name=None, private_ip_address=None, block_device_map=None, disable_api_termination=None, instance_initiated_shutdown_behavior=None, placement_group=None, client_token=None, security_group_ids=None, security_group_names=None, additional_info=None, tenancy=None, instance_profile_arn=None, instance_profile_name=None, ebs_optimized=None, network_interfaces=None, network_interface_name=None, network_interface_id=None, attributes=None, target_state=None, public_ip=None, allocation_id=None, allocate_eip=False, region=None, key=None, keyid=None, profile=None)
Ensure an EC2 instance is running with the given attributes and state.
.INDENT 7.0
.TP
.B name
(string) \- The name of the state definition.  Recommended that this
match the instance_name attribute (generally the FQDN of the instance).
.TP
.B instance_name
(string) \- The name of the instance, generally its FQDN.  Exclusive with
\(aqinstance_id\(aq.
.TP
.B instance_id
(string) \- The ID of the instance (if known).  Exclusive with
\(aqinstance_name\(aq.
.TP
.B image_id
(string) – The ID of the AMI image to run.
.TP
.B image_name
(string) – The name of the AMI image to run.
.TP
.B tags
(dict) \- Tags to apply to the instance.
.TP
.B key_name
(string) – The name of the key pair with which to launch instances.
.TP
.B security_groups
(list of strings) – The names of the EC2 classic security groups with
which to associate instances
.TP
.B user_data
(string) – The Base64\-encoded MIME user data to be made available to the
instance(s) in this reservation.
.TP
.B instance_type
(string) – The EC2 instance size/type.  Note that only certain types are
compatible with HVM based AMIs.
.TP
.B placement
(string) – The Availability Zone to launch the instance into.
.TP
.B kernel_id
(string) – The ID of the kernel with which to launch the instances.
.TP
.B ramdisk_id
(string) – The ID of the RAM disk with which to launch the instances.
.TP
.B vpc_id
(string) \- The ID of a VPC to attach the instance to.
.TP
.B vpc_name
(string) \- The name of a VPC to attach the instance to.
.TP
.B monitoring_enabled
(bool) – Enable detailed CloudWatch monitoring on the instance.
.TP
.B subnet_id
(string) – The ID of the subnet within which to launch the instances for
VPC.
.TP
.B subnet_name
(string) – The name of the subnet within which to launch the instances
for VPC.
.TP
.B private_ip_address
(string) – If you’re using VPC, you can optionally use this parameter to
assign the instance a specific available IP address from the subnet
(e.g., 10.0.0.25).
.TP
.B block_device_map
(boto.ec2.blockdevicemapping.BlockDeviceMapping) – A BlockDeviceMapping
data structure describing the EBS volumes associated with the Image.
.TP
.B disable_api_termination
(bool) – If True, the instances will be locked and will not be able to
be terminated via the API.
.TP
.B instance_initiated_shutdown_behavior
(string) – Specifies whether the instance stops or terminates on
instance\-initiated shutdown. Valid values are:
.INDENT 7.0
.IP \(bu 2
\(aqstop\(aq
.IP \(bu 2
\(aqterminate\(aq
.UNINDENT
.TP
.B placement_group
(string) – If specified, this is the name of the placement group in
which the instance(s) will be launched.
.TP
.B client_token
(string) – Unique, case\-sensitive identifier you provide to ensure
idempotency of the request. Maximum 64 ASCII characters.
.TP
.B security_group_ids
(list of strings) – The IDs of the VPC security groups with which to
associate instances.
.TP
.B security_group_names
(list of strings) – The names of the VPC security groups with which to
associate instances.
.TP
.B additional_info
(string) – Specifies additional information to make available to the
instance(s).
.TP
.B tenancy
(string) – The tenancy of the instance you want to launch. An instance
with a tenancy of ‘dedicated’ runs on single\-tenant hardware and can
only be launched into a VPC. Valid values are:”default” or “dedicated”.
NOTE: To use dedicated tenancy you MUST specify a VPC subnet\-ID as well.
.TP
.B instance_profile_arn
(string) – The Amazon resource name (ARN) of the IAM Instance Profile
(IIP) to associate with the instances.
.TP
.B instance_profile_name
(string) – The name of the IAM Instance Profile (IIP) to associate with
the instances.
.TP
.B ebs_optimized
(bool) – Whether the instance is optimized for EBS I/O. This
optimization provides dedicated throughput to Amazon EBS and a tuned
configuration stack to provide optimal EBS I/O performance. This
optimization isn’t available with all instance types.
.TP
.B network_interfaces
(boto.ec2.networkinterface.NetworkInterfaceCollection) – A
NetworkInterfaceCollection data structure containing the ENI
specifications for the instance.
.TP
.B network_interface_name
.INDENT 7.0
.INDENT 3.5
(string) \- The name of Elastic Network Interface to attach
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.TP
.B network_interface_id
.INDENT 7.0
.INDENT 3.5
(string) \- The id of Elastic Network Interface to attach
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.TP
.B attributes
(dict) \- Instance attributes and value to be applied to the instance.
Available options are:
.INDENT 7.0
.IP \(bu 2
instanceType \- A valid instance type (m1.small)
.IP \(bu 2
kernel \- Kernel ID (None)
.IP \(bu 2
ramdisk \- Ramdisk ID (None)
.IP \(bu 2
userData \- Base64 encoded String (None)
.IP \(bu 2
disableApiTermination \- Boolean (true)
.IP \(bu 2
instanceInitiatedShutdownBehavior \- stop|terminate
.IP \(bu 2
blockDeviceMapping \- List of strings \- ie: [‘/dev/sda=false’]
.IP \(bu 2
sourceDestCheck \- Boolean (true)
.IP \(bu 2
groupSet \- Set of Security Groups or IDs
.IP \(bu 2
ebsOptimized \- Boolean (false)
.IP \(bu 2
sriovNetSupport \- String \- ie: ‘simple’
.UNINDENT
.TP
.B target_state
(string) \- The desired target state of the instance.  Available options
are:
.INDENT 7.0
.IP \(bu 2
running
.IP \(bu 2
stopped
.UNINDENT
.sp
Note that this option is currently UNIMPLEMENTED.
.TP
.B public_ip:
(string) \- The IP of a previously allocated EIP address, which will be
attached to the instance.  EC2 Classic instances ONLY \- for VCP pass in
an allocation_id instead.
.TP
.B allocation_id:
(string) \- The ID of a previously allocated EIP address, which will be
attached to the instance.  VPC instances ONLY \- for Classic pass in
a public_ip instead.
.TP
.B allocate_eip:
(bool) \- Allocate and attach an EIP on\-the\-fly for this instance.  Note
you\(aqll want to release this address when terminating the instance,
either manually or via the \(aqrelease_eip\(aq flag to \(aqinstance_absent\(aq.
.TP
.B region
(string) \- Region to connect to.
.TP
.B key
(string) \- Secret key to be used.
.TP
.B keyid
(string) \- Access key to be used.
.TP
.B profile
(variable) \- A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_ec2.key_absent(name, region=None, key=None, keyid=None, profile=None)
Deletes a key pair
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_ec2.key_present(name, save_private=None, upload_public=None, region=None, key=None, keyid=None, profile=None)
Ensure key pair is present.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_ec2.private_ips_absent(name, network_interface_name=None, network_interface_id=None, private_ip_addresses=None, region=None, key=None, keyid=None, profile=None)
Ensure an ENI does not have secondary private ip addresses associated with it
.INDENT 7.0
.TP
.B name
(String) \- State definition name
.TP
.B network_interface_id
(String) \- The EC2 network interface id, example eni\-123456789
.TP
.B private_ip_addresses
(List or String) \- The secondary private ip address(es) that should be absent on the ENI.
.TP
.B region
(string) \- Region to connect to.
.TP
.B key
(string) \- Secret key to be used.
.TP
.B keyid
(string) \- Access key to be used.
.TP
.B profile
(variable) \- A dict with region, key and keyid, or a pillar key (string) that contains a
dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_ec2.private_ips_present(name, network_interface_name=None, network_interface_id=None, private_ip_addresses=None, allow_reassignment=False, region=None, key=None, keyid=None, profile=None)
Ensure an ENI has secondary private ip addresses associated with it
.INDENT 7.0
.TP
.B name
(String) \- State definition name
.TP
.B network_interface_id
(String) \- The EC2 network interface id, example eni\-123456789
.TP
.B private_ip_addresses
(List or String) \- The secondary private ip address(es) that should be present on the ENI.
.TP
.B allow_reassignment
(Boolean) \- If true, will reassign a secondary private ip address associated with another
ENI. If false, state will fail if the secondary private ip address is associated with
another ENI.
.TP
.B region
(string) \- Region to connect to.
.TP
.B key
(string) \- Secret key to be used.
.TP
.B keyid
(string) \- Access key to be used.
.TP
.B profile
(variable) \- A dict with region, key and keyid, or a pillar key (string) that contains a
dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_ec2.snapshot_created(name, ami_name, instance_name, wait_until_available=True, wait_timeout_seconds=300, **kwargs)
Create a snapshot from the given instance
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_ec2.volume_absent(name, volume_name=None, volume_id=None, instance_name=None, instance_id=None, device=None, region=None, key=None, keyid=None, profile=None)
Ensure the EC2 volume is detached and absent.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B name
State definition name.
.TP
.B volume_name
Name tag associated with the volume.  For safety, if this matches more than
one volume, the state will refuse to apply.
.TP
.B volume_id
Resource ID of the volume.
.TP
.B instance_name
Only remove volume if it is attached to instance with this Name tag.
Exclusive with \(aqinstance_id\(aq.  Requires \(aqdevice\(aq.
.TP
.B instance_id
Only remove volume if it is attached to this instance.
Exclusive with \(aqinstance_name\(aq.  Requires \(aqdevice\(aq.
.TP
.B device
Match by device rather than ID.  Requires one of \(aqinstance_name\(aq or
\(aqinstance_id\(aq.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_ec2.volume_present(name, volume_name=None, volume_id=None, instance_name=None, instance_id=None, device=None, size=None, snapshot_id=None, volume_type=None, iops=None, encrypted=False, kms_key_id=None, region=None, key=None, keyid=None, profile=None)
Ensure the EC2 volume is present and attached.
.INDENT 7.0
.TP
.B name
State definition name.
.TP
.B volume_name
The Name tag value for the volume. If no volume with that matching name tag is found,
a new volume will be created. If multiple volumes are matched, the state will fail.
.TP
.B volume_id
Resource ID of the volume. Exclusive with \(aqvolume_name\(aq.
.TP
.B instance_name
Attach volume to instance with this Name tag.
Exclusive with \(aqinstance_id\(aq.
.TP
.B instance_id
Attach volume to instance with this ID.
Exclusive with \(aqinstance_name\(aq.
.TP
.B device
The device on the instance through which the volume is exposed (e.g. /dev/sdh)
.TP
.B size
The size of the new volume, in GiB. If you\(aqre creating the volume from a snapshot
and don\(aqt specify a volume size, the default is the snapshot size. Optionally specified
at volume creation time; will be ignored afterward. Requires \(aqvolume_name\(aq.
.TP
.B snapshot_id
The snapshot ID from which the new Volume will be created. Optionally specified
at volume creation time; will be ignored afterward. Requires \(aqvolume_name\(aq.
.TP
.B volume_type
The type of the volume. Optionally specified at volume creation time; will be ignored afterward.
Requires \(aqvolume_name\(aq.
Valid volume types for AWS can be found here:
\fI\%http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html\fP
.TP
.B iops
The provisioned IOPS you want to associate with this volume. Optionally specified
at volume creation time; will be ignored afterward. Requires \(aqvolume_name\(aq.
.TP
.B encrypted
Specifies whether the volume should be encrypted. Optionally specified
at volume creation time; will be ignored afterward. Requires \(aqvolume_name\(aq.
.TP
.B kms_key_id
If encrypted is True, this KMS Key ID may be specified to encrypt volume with this key.
Optionally specified at volume creation time; will be ignored afterward.
Requires \(aqvolume_name\(aq.
e.g.: arn:aws:kms:us\-east\-1:012345678910:key/abcd1234\-a123\-456a\-a12b\-a123b4cd56ef
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_ec2.volumes_tagged(name, tag_maps, authoritative=False, region=None, key=None, keyid=None, profile=None)
Ensure EC2 volume(s) matching the given filters have the defined tags.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B name
State definition name.
.TP
.B tag_maps
List of dicts of filters and tags, where \(aqfilters\(aq is a dict suitable for passing
to the \(aqfilters\(aq argument of boto_ec2.get_all_volumes(), and \(aqtags\(aq is a dict of
tags to be set on volumes as matched by the given filters.  The filter syntax is
extended to permit passing either a list of volume_ids or an instance_name (with
instance_name being the Name tag of the instance to which the desired volumes are
mapped).  Each mapping in the list is applied separately, so multiple sets of
volumes can be all tagged differently with one call to this function.
.UNINDENT
.sp
YAML example fragment:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- filters:
    attachment.instance_id: i\-abcdef12
  tags:
    Name: dev\-int\-abcdef12.aws\-foo.com
\- filters:
    attachment.device: /dev/sdf
  tags:
    ManagedSnapshots: true
    BillingGroup: bubba.hotep@aws\-foo.com
\- filters:
    instance_name: prd\-foo\-01.aws\-foo.com
  tags:
    Name: prd\-foo\-01.aws\-foo.com
    BillingGroup: infra\-team@aws\-foo.com
\- filters:
    volume_ids: [ vol\-12345689, vol\-abcdef12 ]
  tags:
    BillingGroup: infra\-team@aws\-foo.com
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B authoritative
Should un\-declared tags currently set on matched volumes be deleted?  Boolean.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_elasticache
.SS Manage Elasticache
.sp
New in version 2014.7.0.

.sp
Create, destroy and update Elasticache clusters. Be aware that this interacts
with Amazon\(aqs services, and so may incur charges.
.sp
Note: This module currently only supports creation and deletion of
elasticache resources and will not modify clusters when their configuration
changes in your state files.
.sp
This module uses \fBboto\fP, which can be installed via package, or pip.
.sp
This module accepts explicit elasticache credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
elasticache.keyid: GKTADJGHEIQSXMKKRBJ08H
elasticache.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile, either
passed in as a dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure myelasticache exists:
  boto_elasticache.present:
    \- name: myelasticache
    \- engine: redis
    \- cache_node_type: cache.t1.micro
    \- num_cache_nodes: 1
    \- notification_topic_arn: arn:aws:sns:us\-east\-1:879879:my\-sns\-topic
    \- region: us\-east\-1
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

# Using a profile from pillars
Ensure myelasticache exists:
  boto_elasticache.present:
    \- name: myelasticache
    \- engine: redis
    \- cache_node_type: cache.t1.micro
    \- num_cache_nodes: 1
    \- notification_topic_arn: arn:aws:sns:us\-east\-1:879879:my\-sns\-topic
    \- region: us\-east\-1
    \- profile: myprofile

# Passing in a profile
Ensure myelasticache exists:
  boto_elasticache.present:
    \- name: myelasticache
    \- engine: redis
    \- cache_node_type: cache.t1.micro
    \- num_cache_nodes: 1
    \- notification_topic_arn: arn:aws:sns:us\-east\-1:879879:my\-sns\-topic
    \- region: us\-east\-1
    \- profile:
        keyid: GKTADJGHEIQSXMKKRBJ08H
        key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elasticache.absent(name, wait=True, region=None, key=None, keyid=None, profile=None)
Ensure the named elasticache cluster is deleted.
.INDENT 7.0
.TP
.B name
Name of the cache cluster.
.TP
.B wait
Boolean. Wait for confirmation from boto that the cluster is in the
deleting state.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elasticache.cache_cluster_absent(*args, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elasticache.cache_cluster_present(*args, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elasticache.creategroup(name, primary_cluster_id, replication_group_description, wait=None, region=None, key=None, keyid=None, profile=None)
Ensure the a replication group is create.
.INDENT 7.0
.TP
.B name
Name of replication group
.TP
.B wait
Waits for the group to be available
.TP
.B primary_cluster_id
Name of the master cache node
.TP
.B replication_group_description
Description for the group
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elasticache.present(name, engine=None, cache_node_type=None, num_cache_nodes=None, preferred_availability_zone=None, port=None, cache_parameter_group_name=None, cache_security_group_names=None, replication_group_id=None, auto_minor_version_upgrade=True, security_group_ids=None, cache_subnet_group_name=None, engine_version=None, notification_topic_arn=None, preferred_maintenance_window=None, wait=None, region=None, key=None, keyid=None, profile=None)
Ensure the cache cluster exists.
.INDENT 7.0
.TP
.B name
Name of the cache cluster (cache cluster id).
.TP
.B engine
The name of the cache engine to be used for this cache cluster. Valid
values are memcached or redis.
.TP
.B cache_node_type
The compute and memory capacity of the nodes in the cache cluster.
cache.t1.micro, cache.m1.small, etc. See: \fI\%https://boto.readthedocs.io/en/latest/ref/elasticache.html#boto.elasticache.layer1.ElastiCacheConnection.create_cache_cluster\fP
.TP
.B num_cache_nodes
The number of cache nodes that the cache cluster will have.
.TP
.B preferred_availability_zone
The EC2 Availability Zone in which the cache cluster will be created.
All cache nodes belonging to a cache cluster are placed in the
preferred availability zone.
.TP
.B port
The port number on which each of the cache nodes will accept
connections.
.TP
.B cache_parameter_group_name
The name of the cache parameter group to associate with this cache
cluster. If this argument is omitted, the default cache parameter group
for the specified engine will be used.
.TP
.B cache_security_group_names
A list of cache security group names to associate with this cache
cluster. Use this parameter only when you are creating a cluster
outside of a VPC.
.TP
.B replication_group_id
The replication group to which this cache cluster should belong. If
this parameter is specified, the cache cluster will be added to the
specified replication group as a read replica; otherwise, the cache
cluster will be a standalone primary that is not part of any
replication group.
.TP
.B auto_minor_version_upgrade
Determines whether minor engine upgrades will be applied automatically
to the cache cluster during the maintenance window. A value of True
allows these upgrades to occur; False disables automatic upgrades.
.TP
.B security_group_ids
One or more VPC security groups associated with the cache cluster. Use
this parameter only when you are creating a cluster in a VPC.
.TP
.B cache_subnet_group_name
The name of the cache subnet group to be used for the cache cluster.
Use this parameter only when you are creating a cluster in a VPC.
.TP
.B engine_version
The version number of the cache engine to be used for this cluster.
.TP
.B notification_topic_arn
The Amazon Resource Name (ARN) of the Amazon Simple Notification
Service (SNS) topic to which notifications will be sent. The Amazon SNS
topic owner must be the same as the cache cluster owner.
.TP
.B preferred_maintenance_window
The weekly time range (in UTC) during which system maintenance can
occur. Example: sun:05:00\-sun:09:00
.TP
.B wait
Boolean. Wait for confirmation from boto that the cluster is in the
available state.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elasticache.replication_group_absent(name, tags=None, region=None, key=None, keyid=None, profile=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elasticache.replication_group_present(*args, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elasticache.subnet_group_absent(name, tags=None, region=None, key=None, keyid=None, profile=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elasticache.subnet_group_present(name, subnet_ids=None, subnet_names=None, description=None, tags=None, region=None, key=None, keyid=None, profile=None)
Ensure ElastiCache subnet group exists.
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B name
The name for the ElastiCache subnet group. This value is stored as a lowercase string.
.TP
.B subnet_ids
A list of VPC subnet IDs for the cache subnet group.  Exclusive with subnet_names.
.TP
.B subnet_names
A list of VPC subnet names for the cache subnet group.  Exclusive with subnet_ids.
.TP
.B description
Subnet group description.
.TP
.B tags
A list of tags.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_elasticsearch_domain
.SS Manage Elasticsearch Domains
.sp
New in version 2016.11.0.

.sp
Create and destroy Elasticsearch domains. Be aware that this interacts with Amazon\(aqs services,
and so may incur charges.
.sp
This module uses \fBboto3\fP, which can be installed via package, or pip.
.sp
This module accepts explicit vpc credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vpc.keyid: GKTADJGHEIQSXMKKRBJ08H
vpc.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile,
either passed in as a dict, or as a string to pull from pillars or minion
config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
  region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure domain exists:
    boto_elasticsearch_domain.present:
        \- DomainName: mydomain
        \- profile=\(aquser\-credentials\(aq
        \- ElasticsearchVersion: \(dq2.3\(dq
        \- ElasticsearchClusterConfig:
            InstanceType\(dq: \(dqt2.micro.elasticsearch\(dq
            InstanceCount: 1
            DedicatedMasterEnabled: False
            ZoneAwarenessEnabled: False
        \- EBSOptions:
            EBSEnabled: True
            VolumeType: \(dqgp2\(dq
            VolumeSize: 10
            Iops: 0
        \- AccessPolicies:
            Version: \(dq2012\-10\-17\(dq
            Statement:
              \- Effect: \(dqAllow\(dq
              \- Principal:
                  AWS: \(dq*\(dq
              \- Action:
                \- \(dqes:*\(dq
              \- Resource: \(dqarn:aws:es:*:111111111111:domain/mydomain/*\(dq
              \- Condition:
                  IpAddress:
                    \(dqaws:SourceIp\(dq:
                      \- \(dq127.0.0.1\(dq
                      \- \(dq127.0.0.2\(dq
        \- SnapshotOptions:
            AutomatedSnapshotStartHour: 0
        \- AdvancedOptions:
            rest.action.multi.allow_explicit_index\(dq: \(dqtrue\(dq
        \- Tags:
            a: \(dqb\(dq
        \- region: us\-east\-1
        \- keyid: GKTADJGHEIQSXMKKRBJ08H
        \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elasticsearch_domain.absent(name, DomainName, region=None, key=None, keyid=None, profile=None)
Ensure domain with passed properties is absent.
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B DomainName
Name of the domain.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elasticsearch_domain.present(name, DomainName, ElasticsearchClusterConfig=None, EBSOptions=None, AccessPolicies=None, SnapshotOptions=None, AdvancedOptions=None, Tags=None, region=None, key=None, keyid=None, profile=None, ElasticsearchVersion=\(aq1.5\(aq)
Ensure domain exists.
.INDENT 7.0
.TP
.B name
The name of the state definition
.TP
.B DomainName
Name of the domain.
.TP
.B ElasticsearchClusterConfig
Configuration options for an Elasticsearch domain. Specifies the
instance type and number of instances in the domain cluster.
.sp
InstanceType (string) \-\-
The instance type for an Elasticsearch cluster.
.sp
InstanceCount (integer) \-\-
The number of instances in the specified domain cluster.
.sp
DedicatedMasterEnabled (boolean) \-\-
A boolean value to indicate whether a dedicated master node is enabled.
See About Dedicated Master Nodes for more information.
.sp
ZoneAwarenessEnabled (boolean) \-\-
A boolean value to indicate whether zone awareness is enabled. See About
Zone Awareness for more information.
.sp
DedicatedMasterType (string) \-\-
The instance type for a dedicated master node.
.sp
DedicatedMasterCount (integer) \-\-
Total number of dedicated master nodes, active and on standby, for the
cluster.
.TP
.B EBSOptions
Options to enable, disable and specify the type and size of EBS storage
volumes.
.sp
EBSEnabled (boolean) \-\-
Specifies whether EBS\-based storage is enabled.
.sp
VolumeType (string) \-\-
Specifies the volume type for EBS\-based storage.
.sp
VolumeSize (integer) \-\-
Integer to specify the size of an EBS volume.
.sp
Iops (integer) \-\-
Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
.TP
.B AccessPolicies
IAM access policy
.TP
.B SnapshotOptions
Option to set time, in UTC format, of the daily automated snapshot.
Default value is 0 hours.
.sp
AutomatedSnapshotStartHour (integer) \-\-
Specifies the time, in UTC format, when the service takes a daily
automated snapshot of the specified Elasticsearch domain. Default value
is 0 hours.
.TP
.B AdvancedOptions
Option to allow references to indices in an HTTP request body. Must be
false when configuring access to individual sub\-resources. By default,
the value is true .
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.TP
.B ElasticsearchVersion
String of format X.Y to specify version for the Elasticsearch domain eg.
\(dq1.5\(dq or \(dq2.3\(dq.
.UNINDENT
.UNINDENT
.SS salt.states.boto_elb
.sp
Manage ELBs
.sp
New in version 2014.7.0.

.sp
Create and destroy ELBs. Be aware that this interacts with Amazon\(aqs
services, and so may incur charges.
.sp
This module uses \fBboto\fP, which can be installed via package, or pip.
.sp
This module accepts explicit elb credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
elb.keyid: GKTADJGHEIQSXMKKRBJ08H
elb.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile, either
passed in as a dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure myelb ELB exists:
    boto_elb.present:
        \- name: myelb
        \- region: us\-east\-1
        \- availability_zones:
            \- us\-east\-1a
            \- us\-east\-1c
            \- us\-east\-1d
        \- keyid: GKTADJGHEIQSXMKKRBJ08H
        \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        \- listeners:
            \- elb_port: 443
              instance_port: 80
              elb_protocol: HTTPS
              instance_protocol: HTTP
              certificate: \(aqarn:aws:iam::1111111:server\-certificate/mycert\(aq
              policies:
                  \- my\-ssl\-policy
                  \- cookie\-policy
            \- elb_port: 8210
              instance_port: 8210
              elb_protocol: TCP
        \- backends:
            \- instance_port: 80
              policies:
                  \- enable\-proxy\-protocol
        \- health_check:
            target: \(aqHTTP:80/\(aq
        \- attributes:
            cross_zone_load_balancing:
              enabled: true
            access_log:
              enabled: true
              s3_bucket_name: \(aqmybucket\(aq
              s3_bucket_prefix: \(aqmy\-logs\(aq
              emit_interval: 5
            connecting_settings:
              idle_timeout: 60
        \- cnames:
            \- name: mycname.example.com.
              zone: example.com.
              ttl: 60
            \- name: myothercname.example.com.
              zone: example.com.
        \- security_groups:
            \- my\-security\-group
        \- policies:
            \- policy_name: my\-ssl\-policy
              policy_type: SSLNegotiationPolicyType
              policy:
                Protocol\-TLSv1.2: true
                Protocol\-SSLv3: false
                Server\-Defined\-Cipher\-Order: true
                ECDHE\-ECDSA\-AES128\-GCM\-SHA256: true
            \- policy_name: cookie\-policy
              policy_type: LBCookieStickinessPolicyType
              policy: {}  # no policy means this is a session cookie
            \- policy_name: enable\-proxy\-protocol
              policy_type: ProxyProtocolPolicyType
              policy:
                ProxyProtocol: true

# Using a profile from pillars
Ensure myelb ELB exists:
    boto_elb.present:
        \- name: myelb
        \- region: us\-east\-1
        \- profile: myelbprofile

# Passing in a profile
Ensure myelb ELB exists:
    boto_elb.present:
        \- name: myelb
        \- region: us\-east\-1
        \- profile:
            keyid: GKTADJGHEIQSXMKKRBJ08H
            key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs possible to specify attributes from pillars by specifying a pillar. You
can override the values defined in the pillard by setting the attributes on the
resource. The module will use the default pillar key \(aqboto_elb_attributes\(aq,
which allows you to set default attributes for all ELB resources.
.sp
Setting the attributes pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_elb_attributes:
  cross_zone_load_balancing:
    enabled: true
  connection_draining:
    enabled: true
    timeout: 20
  access_log:
    enabled: true
    s3_bucket_name: \(aqmybucket\(aq
    s3_bucket_prefix: \(aqmy\-logs\(aq
    emit_interval: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Overriding the attribute values on the resource:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure myelb ELB exists:
    boto_elb.present:
        \- name: myelb
        \- region: us\-east\-1
        \- attributes_from_pillar: my_elb_attributes
        # override cross_zone_load_balancing:enabled
        \- attributes:
            cross_zone_load_balancing:
              enabled: false
        \- profile: myelbprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs possible to specify cloudwatch alarms that will be setup along with the
ELB. Note the alarm name will be defined by the name attribute provided, plus
the ELB resource name.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure myelb ELB exists:
    boto_elb.present:
        \- name: myelb
        \- region: us\-east\-1
        \- profile: myelbprofile
        \- alarms:
            UnHealthyHostCount:
              name: \(aqELB UnHealthyHostCount **MANAGED BY SALT**\(aq
              attributes:
                metric: UnHealthyHostCount
                namespace: AWS/ELB
                statistic: Average
                comparison: \(aq>=\(aq
                threshold: 1.0
                period: 600
                evaluation_periods: 6
                unit: null
                description: ELB UnHealthyHostCount
                alarm_actions: [\(aqarn:aws:sns:us\-east\-1:12345:myalarm\(aq]
                insufficient_data_actions: []
                ok_actions: [\(aqarn:aws:sns:us\-east\-1:12345:myalarm\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also use alarms from pillars, and override values from the pillar
alarms by setting overrides on the resource. Note that \(aqboto_elb_alarms\(aq
will be used as a default value for all resources, if defined and can be
used to ensure alarms are always set for a resource.
.sp
Setting the alarms in a pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_elb_alarm:
  UnHealthyHostCount:
    name: \(aqELB UnHealthyHostCount **MANAGED BY SALT**\(aq
    attributes:
      metric: UnHealthyHostCount
      namespace: AWS/ELB
      statistic: Average
      comparison: \(aq>=\(aq
      threshold: 1.0
      period: 600
      evaluation_periods: 6
      unit: null
      description: ELB UnHealthyHostCount
      alarm_actions: [\(aqarn:aws:sns:us\-east\-1:12345:myalarm\(aq]
      insufficient_data_actions: []
      ok_actions: [\(aqarn:aws:sns:us\-east\-1:12345:myalarm\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Overriding the alarm values on the resource:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure myelb ELB exists:
    boto_elb.present:
        \- name: myelb
        \- region: us\-east\-1
        \- profile: myelbprofile
        \- alarms_from_pillar: my_elb_alarm
        # override UnHealthyHostCount:attributes:threshold
        \- alarms:
            UnHealthyHostCount:
              attributes:
                threshold: 2.0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Tags can also be set:
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure myelb ELB exists:
    boto_elb.present:
        \- name: myelb
        \- region: us\-east\-1
        \- profile: myelbprofile
        \- tags:
            MyTag: \(aqMy Tag Value\(aq
            OtherTag: \(aqMy Other Value\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elb.absent(name, region=None, key=None, keyid=None, profile=None)
Ensure an ELB does not exist
.INDENT 7.0
.TP
.B name
name of the ELB
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elb.present(name, listeners, availability_zones=None, subnets=None, subnet_names=None, security_groups=None, scheme=\(aqinternet\-facing\(aq, health_check=None, attributes=None, attributes_from_pillar=\(aqboto_elb_attributes\(aq, cnames=None, alarms=None, alarms_from_pillar=\(aqboto_elb_alarms\(aq, policies=None, policies_from_pillar=\(aqboto_elb_policies\(aq, backends=None, region=None, key=None, keyid=None, profile=None, wait_for_sync=True, tags=None, instance_ids=None, instance_names=None)
Ensure the ELB exists.
.INDENT 7.0
.TP
.B name
Name of the ELB.
.TP
.B availability_zones
A list of availability zones for this ELB.
.TP
.B listeners
A list of listener lists; example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
    [\(aq443\(aq, \(aqHTTPS\(aq, \(aqarn:aws:iam::1111111:server\-certificate/mycert\(aq],
    [\(aq8443\(aq, \(aq80\(aq, \(aqHTTPS\(aq, \(aqHTTP\(aq, \(aqarn:aws:iam::1111111:server\-certificate/mycert\(aq]
]
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B subnets
A list of subnet IDs in your VPC to attach to your LoadBalancer.
.TP
.B subnet_names
A list of subnet names in your VPC to attach to your LoadBalancer.
.TP
.B security_groups
The security groups assigned to your LoadBalancer within your VPC. Must
be passed either as a list or a comma\-separated string.
.sp
For example, a list:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- security_groups:
  \- secgroup\-one
  \- secgroup\-two
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or as a comma\-separated string:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- security_groups: secgroup\-one,secgroup\-two
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B scheme
The type of a LoadBalancer, \fBinternet\-facing\fP or \fBinternal\fP\&. Once
set, can not be modified.
.TP
.B health_check
A dict defining the health check for this ELB.
.TP
.B attributes
A dict defining the attributes to set on this ELB.
Unknown keys will be silently ignored.
.sp
See the \fI\%salt.modules.boto_elb.set_attributes\fP function for
recognized attributes.
.TP
.B attributes_from_pillar
name of pillar dict that contains attributes.   Attributes defined for this specific
state will override those from pillar.
.TP
.B cnames
A list of cname dicts with attributes needed for the DNS add_record state.
By default the boto_route53.add_record state will be used, which requires: name, zone, ttl, and identifier.
See the boto_route53 state for information about these attributes.
Other DNS modules can be called by specifying the provider keyword.
the cnames dict will be passed to the state as kwargs.
.sp
See the \fI\%salt.states.boto_route53\fP state for information about
these attributes.
.TP
.B alarms:
a dictionary of name\->boto_cloudwatch_alarm sections to be associated with this ELB.
All attributes should be specified except for dimension which will be
automatically set to this ELB.
.sp
See the \fI\%salt.states.boto_cloudwatch_alarm\fP state for information
about these attributes.
.TP
.B alarms_from_pillar:
name of pillar dict that contains alarm settings.   Alarms defined for this specific
state will override those from pillar.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.TP
.B wait_for_sync
Wait for an INSYNC change status from Route53.
.TP
.B tags
dict of tags
.TP
.B instance_ids
list of instance ids.  The state will ensure that these, and ONLY these, instances
are registered with the ELB.  This is additive with instance_names.
.TP
.B instance_names
list of instance names.  The state will ensure that these, and ONLY these, instances
are registered with the ELB.  This is additive with instance_ids.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elb.register_instances(name, instances, region=None, key=None, keyid=None, profile=None)
Add EC2 instance(s) to an Elastic Load Balancer. Removing an instance from
the \fBinstances\fP list does not remove it from the ELB.
.INDENT 7.0
.TP
.B name
The name of the Elastic Load Balancer to add EC2 instances to.
.TP
.B instances
A list of EC2 instance IDs that this Elastic Load Balancer should
distribute traffic to. This state will only ever append new instances
to the ELB. EC2 instances already associated with this ELB will not be
removed if they are not in the \fBinstances\fP list.
.UNINDENT
.sp
New in version 2015.8.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
add\-instances:
  boto_elb.register_instances:
    \- name: myloadbalancer
    \- instances:
      \- instance\-id1
      \- instance\-id2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.boto_elbv2
.sp
Manage AWS Application Load Balancer
.sp
New in version 2017.7.0.

.sp
Add and remove targets from an ALB target group.
.sp
This module uses \fBboto3\fP, which can be installed via package, or pip.
.sp
This module accepts explicit alb credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
elbv2.keyid: GKTADJGHEIQSXMKKRBJ08H
elbv2.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
elbv2.region: us\-west\-2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile, either
passed in as a dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elbv2.create_target_group(name, protocol, port, vpc_id, region=None, key=None, keyid=None, profile=None, health_check_protocol=\(aqHTTP\(aq, health_check_port=\(aqtraffic\-port\(aq, health_check_path=\(aq/\(aq, health_check_interval_seconds=30, health_check_timeout_seconds=5, healthy_threshold_count=5, unhealthy_threshold_count=2, **kwargs)
New in version 2017.11.0.

.sp
Create target group if not present.
.INDENT 7.0
.TP
.B name
(string) \- The name of the target group.
.TP
.B protocol
(string) \- The protocol to use for routing traffic to the targets
.TP
.B port
(int) \- The port on which the targets receive traffic. This port is used unless
you specify a port override when registering the traffic.
.TP
.B vpc_id
(string) \- The identifier of the virtual private cloud (VPC).
.TP
.B health_check_protocol
(string) \- The protocol the load balancer uses when performing health check on
targets. The default is the HTTP protocol.
.TP
.B health_check_port
(string) \- The port the load balancer uses when performing health checks on
targets. The default is \(aqtraffic\-port\(aq, which indicates the port on which each
target receives traffic from the load balancer.
.TP
.B health_check_path
(string) \- The ping path that is the destination on the targets for health
checks. The default is /.
.TP
.B health_check_interval_seconds
(integer) \- The approximate amount of time, in seconds, between health checks
of an individual target. The default is 30 seconds.
.TP
.B health_check_timeout_seconds
(integer) \- The amount of time, in seconds, during which no response from a
target means a failed health check. The default is 5 seconds.
.TP
.B healthy_threshold_count
(integer) \- The number of consecutive health checks successes required before
considering an unhealthy target healthy. The default is 5.
.TP
.B unhealthy_threshold_count
(integer) \- The number of consecutive health check failures required before
considering a target unhealthy. The default is 2.
.TP
.B returns
(bool) \- True on success, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
create\-target:
  boto_elb2.create_targets_group:
    \- name: myALB
    \- protocol: https
    \- port: 443
    \- vpc_id: myVPC
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elbv2.delete_target_group(name, region=None, key=None, keyid=None, profile=None)
Delete target group.
.INDENT 7.0
.TP
.B name
(string) \- The Amazon Resource Name (ARN) of the resource.
.TP
.B returns
(bool) \- True on success, False on failure.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
check\-target:
  boto_elb2.delete_targets_group:
    \- name: myALB
    \- protocol: https
    \- port: 443
    \- vpc_id: myVPC
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elbv2.targets_deregistered(name, targets, region=None, key=None, keyid=None, profile=None, **kwargs)
Remove targets to an Application Load Balancer target group.
.INDENT 7.0
.TP
.B name
The ARN of the Application Load Balancer Target Group to remove targets from.
.TP
.B targets
A list of target IDs or a string of a single target registered to the target group to be removed
.UNINDENT
.sp
New in version 2017.7.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
remove\-targets:
  boto_elb.targets_deregistered:
    \- name: arn:myloadbalancer
    \- targets:
      \- instance\-id1
      \- instance\-id2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_elbv2.targets_registered(name, targets, region=None, key=None, keyid=None, profile=None, **kwargs)
New in version 2017.7.0.

.sp
Add targets to an Application Load Balancer target group. This state will not remove targets.
.INDENT 7.0
.TP
.B name
The ARN of the Application Load Balancer Target Group to add targets to.
.TP
.B targets
A list of target IDs or a string of a single target that this target group should
distribute traffic to.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
add\-targets:
  boto_elb.targets_registered:
    \- name: arn:myloadbalancer
    \- targets:
      \- instance\-id1
      \- instance\-id2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.boto_iam
.SS Manage IAM objects
.sp
New in version 2015.8.0.

.sp
This module uses \fBboto\fP, which can be installed via package, or pip.
.sp
This module accepts explicit IAM credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile, either
passed in as a dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
delete\-user:
  boto_iam.user_absent:
    \- name: myuser
    \- delete_keys: true
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
delete\-keys:
  boto_iam.keys_absent:
    \- access_keys:
      \- \(aqAKIAJHTMIQ2ASDFLASDF\(aq
      \- \(aqPQIAJHTMIQ2ASRTLASFR\(aq
    \- user_name: myuser
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create\-user:
  boto_iam.user_present:
    \- name: myuser
    \- policies:
        mypolicy: |
            {
                \(dqVersion\(dq: \(dq2012\-10\-17\(dq,
                \(dqStatement\(dq: [{
                \(dqEffect\(dq: \(dqAllow\(dq,
                \(dqAction\(dq: \(dq*\(dq,
                \(dqResource\(dq: \(dq*\(dq}]
            }
    \- password: NewPassword$$1
    \- region: eu\-west\-1
    \- keyid: \(aqAKIAJHTMIQ2ASDFLASDF\(aq
    \- key: \(aqfdkjsafkljsASSADFalkfjasdf\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create\-group:
  boto_iam.group_present:
    \- name: mygroup
    \- users:
      \- myuser
      \- myuser1
    \- policies:
        mypolicy: |
            {
                \(dqVersion\(dq: \(dq2012\-10\-17\(dq,
                \(dqStatement\(dq: [{
                \(dqEffect\(dq: \(dqAllow\(dq,
                \(dqAction\(dq: \(dq*\(dq,
                \(dqResource\(dq: \(dq*\(dq}]
            }
    \- region: eu\-west\-1
    \- keyid: \(aqAKIAJHTMIQ2ASDFLASDF\(aq
    \- key: \(aqsafsdfsal;fdkjsafkljsASSADFalkfj\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
change\-policy:
  boto_iam.account_policy:
    \- change_password: True
    \- region: eu\-west\-1
    \- keyid: \(aqAKIAJHTMIQ2ASDFLASDF\(aq
    \- key: \(aqsafsdfsal;fdkjsafkljsASSADFalkfj\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create server certificate:
  boto_iam.server_cert_present:
    \- name: mycert
    \- public_key: salt://base/mycert.crt
    \- private_key: salt://base/mycert.key
    \- cert_chain: salt://base/mycert_chain.crt
    \- region: eu\-west\-1
    \- keyid: \(aqAKIAJHTMIQ2ASDFLASDF\(aq
    \- key: \(aqfdkjsafkljsASSADFalkfjasdf\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
delete server certificate:
  boto_iam.server_cert_absent:
    \- name: mycert
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create keys for user:
  boto_iam.keys_present:
    \- name: myusername
    \- number: 2
    \- save_dir: /root
    \- region: eu\-west\-1
    \- keyid: \(aqAKIAJHTMIQ2ASDFLASDF\(aq
    \- key: \(aqfdkjsafkljsASSADFalkfjasdf\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create policy:
  boto_iam.policy_present:
    \- name: myname
    \- policy_document: \(aq{\(dqMyPolicy\(dq: \(dqStatement\(dq: [{\(dqAction\(dq: [\(dqsqs:*\(dq], \(dqEffect\(dq: \(dqAllow\(dq, \(dqResource\(dq: [\(dqarn:aws:sqs:*:*:*\(dq], \(dqSid\(dq: \(dqMyPolicySqs1\(dq}]}\(aq
    \- region: eu\-west\-1
    \- keyid: \(aqAKIAJHTMIQ2ASDFLASDF\(aq
    \- key: \(aqfdkjsafkljsASSADFalkfjasdf\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
add\-saml\-provider:
  boto_iam.saml_provider_present:
    \- name: my_saml_provider
    \- saml_metadata_document: salt://base/files/provider.xml
    \- keyid: \(aqAKIAJHTMIQ2ASDFLASDF\(aq
    \- key: \(aqsafsdfsal;fdkjsafkljsASSADFalkfj\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iam.account_policy(name=None, allow_users_to_change_password=None, hard_expiry=None, max_password_age=None, minimum_password_length=None, password_reuse_prevention=None, require_lowercase_characters=None, require_numbers=None, require_symbols=None, require_uppercase_characters=None, region=None, key=None, keyid=None, profile=None)
Change account policy.
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B name (string)
The name of the account policy
.TP
.B allow_users_to_change_password (bool)
Allows all IAM users in your account to
use the AWS Management Console to change their own passwords.
.TP
.B hard_expiry (bool)
Prevents IAM users from setting a new password after their
password has expired.
.TP
.B max_password_age (int)
The number of days that an IAM user password is valid.
.TP
.B minimum_password_length (int)
The minimum number of characters allowed in an IAM user password.
.TP
.B password_reuse_prevention (int)
Specifies the number of previous passwords
that IAM users are prevented from reusing.
.TP
.B require_lowercase_characters (bool)
Specifies whether IAM user passwords
must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).
.TP
.B require_numbers (bool)
Specifies whether IAM user passwords must contain at
least one numeric character (0 to 9).
.TP
.B require_symbols (bool)
Specifies whether IAM user passwords must contain at
least one of the following non\-alphanumeric characters: ! @ # $ % ^ & * ( ) _ + \- = [ ] { } | \(aq
.TP
.B require_uppercase_characters (bool)
Specifies whether IAM user passwords must
contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).
.TP
.B region (string)
Region to connect to.
.TP
.B key (string)
Secret key to be used.
.TP
.B keyid (string)
Access key to be used.
.TP
.B profile (dict)
A dict with region, key and keyid, or a pillar key (string)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iam.group_absent(name, region=None, key=None, keyid=None, profile=None)
New in version 2015.8.0.

.sp
Ensure the IAM group is absent.
.INDENT 7.0
.TP
.B name (string)
The name of the group.
.TP
.B region (string)
Region to connect to.
.TP
.B key (string)
Secret key to be used.
.TP
.B keyid (string)
Access key to be used.
.TP
.B profile (dict)
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iam.group_present(name, policies=None, policies_from_pillars=None, managed_policies=None, users=None, path=\(aq/\(aq, region=None, key=None, keyid=None, profile=None, delete_policies=True)
New in version 2015.8.0.

.sp
Ensure the IAM group is present
.INDENT 7.0
.TP
.B name (string)
The name of the new group.
.TP
.B path (string)
The path for the group, defaults to \(aq/\(aq
.TP
.B policies (dict)
A dict of IAM group policy documents.
.TP
.B policies_from_pillars (list)
A list of pillars that contain role policy dicts. Policies in the
pillars will be merged in the order defined in the list and key
conflicts will be handled by later defined keys overriding earlier
defined keys. The policies defined here will be merged with the
policies defined in the policies argument. If keys conflict, the keys
in the policies argument will override the keys defined in
policies_from_pillars.
.TP
.B managed_policies (list)
A list of policy names or ARNs that should be attached to this group.
.TP
.B users (list)
A list of users to be added to the group.
.TP
.B region (string)
Region to connect to.
.TP
.B key (string)
Secret key to be used.
.TP
.B keyid (string)
Access key to be used.
.TP
.B profile (dict)
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.TP
.B delete_policies (boolean)
Delete or detach existing policies that are not in the given list of policies.
Default value is \fBTrue\fP\&. If \fBFalse\fP is specified, existing policies
will not be deleted or detached allowing manual modifications on the IAM group
to be persistent.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iam.keys_absent(access_keys, user_name, region=None, key=None, keyid=None, profile=None)
New in version 2015.8.0.

.sp
Ensure the IAM user access_key_id is absent.
.INDENT 7.0
.TP
.B access_key_id (list)
A list of access key ids
.TP
.B user_name (string)
The username of the user
.TP
.B region (string)
Region to connect to.
.TP
.B key (string)
Secret key to be used.
.TP
.B keyid (string)
Access key to be used.
.TP
.B profile (dict)
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iam.keys_present(name, number, save_dir, region=None, key=None, keyid=None, profile=None, save_format=\(aq{2}\en{0}\en{3}\en{1}\en\(aq)
New in version 2015.8.0.

.sp
Ensure the IAM access keys are present.
.INDENT 7.0
.TP
.B name (string)
The name of the new user.
.TP
.B number (int)
Number of keys that user should have.
.TP
.B save_dir (string)
The directory that the key/keys will be saved. Keys are saved to a file named according
to the username privided.
.TP
.B region (string)
Region to connect to.
.TP
.B key (string)
Secret key to be used.
.TP
.B keyid (string)
Access key to be used.
.TP
.B profile (dict)
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.TP
.B save_format (dict)
Save format is repeated for each key. Default format is
\(dq{2}n{0}n{3}n{1}n\(dq, where {0} and {1} are placeholders for new
key_id and key respectively, whereas {2} and {3} are \(dqkey_id\-{number}\(dq
and \(aqkey\-{number}\(aq strings kept for compatibility.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iam.policy_absent(name, region=None, key=None, keyid=None, profile=None)
New in version 2015.8.0.

.sp
Ensure the IAM managed policy with the specified name is absent
.INDENT 7.0
.TP
.B name (string)
The name of the new policy.
.TP
.B region (string)
Region to connect to.
.TP
.B key (string)
Secret key to be used.
.TP
.B keyid (string)
Access key to be used.
.TP
.B profile (dict)
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iam.policy_present(name, policy_document, path=None, description=None, region=None, key=None, keyid=None, profile=None)
New in version 2015.8.0.

.sp
Ensure the IAM managed policy is present
.INDENT 7.0
.TP
.B name (string)
The name of the new policy.
.TP
.B policy_document (dict)
The document of the new policy
.TP
.B path (string)
The path in which the policy will be created. Default is \(aq/\(aq.
.TP
.B description (string)
Description
.TP
.B region (string)
Region to connect to.
.TP
.B key (string)
Secret key to be used.
.TP
.B keyid (string)
Access key to be used.
.TP
.B profile (dict)
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iam.saml_provider_absent(name, region=None, key=None, keyid=None, profile=None)
New in version 2016.11.0.

.sp
Ensure the SAML provider with the specified name is absent.
.INDENT 7.0
.TP
.B name (string)
The name of the SAML provider.
.TP
.B saml_metadata_document (string)
The xml document of the SAML provider.
.TP
.B region (string)
Region to connect to.
.TP
.B key (string)
Secret key to be used.
.TP
.B keyid (string)
Access key to be used.
.TP
.B profile (dict)
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iam.saml_provider_present(name, saml_metadata_document, region=None, key=None, keyid=None, profile=None)
New in version 2016.11.0.

.sp
Ensure the SAML provider with the specified name is present.
.INDENT 7.0
.TP
.B name (string)
The name of the SAML provider.
.TP
.B saml_metadata_document (string)
The xml document of the SAML provider.
.TP
.B region (string)
Region to connect to.
.TP
.B key (string)
Secret key to be used.
.TP
.B keyid (string)
Access key to be used.
.TP
.B profile (dict)
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iam.server_cert_absent(name, region=None, key=None, keyid=None, profile=None)
Deletes a server certificate.
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B name (string)
The name for the server certificate. Do not include the path in this value.
.TP
.B region (string)
The name of the region to connect to.
.TP
.B key (string)
The key to be used in order to connect
.TP
.B keyid (string)
The keyid to be used in order to connect
.TP
.B profile (string)
The profile that contains a dict of region, key, keyid
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iam.server_cert_present(name, public_key, private_key, cert_chain=None, path=None, region=None, key=None, keyid=None, profile=None)
Crete server certificate.
.sp
New in version 2015.8.0.

.INDENT 7.0
.TP
.B name (string)
The name for the server certificate. Do not include the path in this value.
.TP
.B public_key (string)
The contents of the public key certificate in PEM\-encoded format.
.TP
.B private_key (string)
The contents of the private key in PEM\-encoded format.
.TP
.B cert_chain (string)
The contents of the certificate chain. This is typically a
concatenation of the PEM\-encoded public key certificates of the chain.
.TP
.B path (string)
The path for the server certificate.
.TP
.B region (string)
The name of the region to connect to.
.TP
.B key (string)
The key to be used in order to connect
.TP
.B keyid (string)
The keyid to be used in order to connect
.TP
.B profile (string)
The profile that contains a dict of region, key, keyid
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iam.user_absent(name, delete_keys=True, delete_mfa_devices=True, delete_profile=True, region=None, key=None, keyid=None, profile=None)
New in version 2015.8.0.

.sp
Ensure the IAM user is absent. User cannot be deleted if it has keys.
.INDENT 7.0
.TP
.B name (string)
The name of the new user.
.TP
.B delete_keys (bool)
Delete all keys from user.
.TP
.B delete_mfa_devices (bool)
Delete all mfa devices from user.
.sp
New in version 2016.3.0.

.TP
.B delete_profile (bool)
Delete profile from user.
.sp
New in version 2016.3.0.

.TP
.B region (string)
Region to connect to.
.TP
.B key (string)
Secret key to be used.
.TP
.B keyid (string)
Access key to be used.
.TP
.B profile (dict)
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iam.user_present(name, policies=None, policies_from_pillars=None, managed_policies=None, password=None, path=None, region=None, key=None, keyid=None, profile=None)
New in version 2015.8.0.

.sp
Ensure the IAM user is present
.INDENT 7.0
.TP
.B name (string)
The name of the new user.
.TP
.B policies (dict)
A dict of IAM group policy documents.
.TP
.B policies_from_pillars (list)
A list of pillars that contain role policy dicts. Policies in the
pillars will be merged in the order defined in the list and key
conflicts will be handled by later defined keys overriding earlier
defined keys. The policies defined here will be merged with the
policies defined in the policies argument. If keys conflict, the keys
in the policies argument will override the keys defined in
policies_from_pillars.
.TP
.B managed_policies (list)
A list of managed policy names or ARNs that should be attached to this
user.
.TP
.B password (string)
The password for the new user. Must comply with account policy.
.TP
.B path (string)
The path of the user. Default is \(aq/\(aq.
.sp
New in version 2015.8.2.

.TP
.B region (string)
Region to connect to.
.TP
.B key (string)
Secret key to be used.
.TP
.B keyid (string)
Access key to be used.
.TP
.B profile (dict)
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_iam_role
.SS Manage IAM roles
.sp
New in version 2014.7.0.

.sp
This module uses \fBboto\fP, which can be installed via package, or pip.
.sp
This module accepts explicit IAM credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
iam.keyid: GKTADJGHEIQSXMKKRBJ08H
iam.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile, either
passed in as a dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Creating a role will automatically create an instance profile and associate it
with the role. This is the default behavior of the AWS console.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myrole:
    boto_iam_role.present:
        \- region: us\-east\-1
        \- key: GKTADJGHEIQSXMKKRBJ08H
        \- keyid: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        \- policies_from_pillars:
            \- shared_iam_bootstrap_policy
        \- policies:
            MySQSPolicy:
                Statement:
                  \- Action:
                        \- sqs:*
                    Effect: Allow
                    Resource:
                        \- arn:aws:sqs:*:*:*
                    Sid: MyPolicySQS1
            MyS3Policy:
                Statement:
                  \- Action:
                        \- s3:GetObject
                    Effect: Allow
                    Resource:
                        \- arn:aws:s3:*:*:mybucket/*

# Using a credentials profile from pillars
myrole:
    boto_iam_role.present:
        \- profile: myiamprofile

# Passing in a credentials profile
myrole:
    boto_iam_role.present:
        \- profile:
            key: GKTADJGHEIQSXMKKRBJ08H
            keyid: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
            region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If \fBdelete_policies: False\fP is specified, existing policies that are not in
the given list of policies will not be deleted. This allows manual modifications
on the IAM role to be persistent. This functionality was added in 2015.8.0.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When using the \fBprofile\fP parameter and \fBregion\fP is set outside of
the profile group, region is ignored and a default region will be used.
.sp
If \fBregion\fP is missing from the \fBprofile\fP data set, \fBus\-east\-1\fP
will be used as the default region.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iam_role.absent(name, region=None, key=None, keyid=None, profile=None)
Ensure the IAM role is deleted.
.INDENT 7.0
.TP
.B name
Name of the IAM role.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iam_role.present(name, policy_document=None, policy_document_from_pillars=None, path=None, policies=None, policies_from_pillars=None, managed_policies=None, create_instance_profile=True, region=None, key=None, keyid=None, profile=None, delete_policies=True)
Ensure the IAM role exists.
.INDENT 7.0
.TP
.B name
Name of the IAM role.
.TP
.B policy_document
The policy that grants an entity permission to assume the role.
(See \fI\%https://boto.readthedocs.io/en/latest/ref/iam.html#boto.iam.connection.IAMConnection.create_role\fP)
.TP
.B policy_document_from_pillars
A pillar key that contains a role policy document. The statements
defined here will be appended with the policy document statements
defined in the policy_document argument.
.sp
New in version 2017.7.0.

.TP
.B path
The path to the role/instance profile.
(See \fI\%https://boto.readthedocs.io/en/latest/ref/iam.html#boto.iam.connection.IAMConnection.create_role\fP)
.TP
.B policies
A dict of IAM role policies.
.TP
.B policies_from_pillars
A list of pillars that contain role policy dicts. Policies in the
pillars will be merged in the order defined in the list and key
conflicts will be handled by later defined keys overriding earlier
defined keys. The policies defined here will be merged with the
policies defined in the policies argument. If keys conflict, the keys
in the policies argument will override the keys defined in
policies_from_pillars.
.TP
.B managed_policies
A list of (AWS or Customer) managed policies to be attached to the role.
.TP
.B create_instance_profile
A boolean of whether or not to create an instance profile and associate
it with this role.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.TP
.B delete_policies
Deletes existing policies that are not in the given list of policies. Default
value is \fBTrue\fP\&. If \fBFalse\fP is specified, existing policies will not be deleted
allowing manual modifications on the IAM role to be persistent.
.sp
New in version 2015.8.0.

.UNINDENT
.UNINDENT
.SS salt.states.boto_iot
.SS Manage IoT Objects
.sp
New in version 2016.3.0.

.sp
Create and destroy IoT objects. Be aware that this interacts with Amazon\(aqs services,
and so may incur charges.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
boto
.IP \(bu 2
boto3
.UNINDENT
.UNINDENT
.sp
The dependencies listed above can be installed via package or pip.
.sp
This module accepts explicit vpc credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vpc.keyid: GKTADJGHEIQSXMKKRBJ08H
vpc.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile,
either passed in as a dict, or as a string to pull from pillars or minion
config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure policy exists:
    boto_iot.policy_present:
        \- policyName: mypolicy
        \- policyDocument:
            Version: \(dq2012\-10\-17\(dq
            Statement:
              Action:
                \- iot:Publish
              Resource:
                \- \(dq*\(dq
              Effect: \(dqAllow\(dq
        \- region: us\-east\-1
        \- keyid: GKTADJGHEIQSXMKKRBJ08H
        \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

Ensure topic rule exists:
    boto_iot.topic_rule_present:
        \- ruleName: myrule
        \- sql: \(dqSELECT * FROM \(aqiot/test\(aq\(dq
        \- description: \(aqtest rule\(aq
        \- ruleDisabled: false
        \- actions:
          \- lambda:
              functionArn: \(dqarn:aws:us\-east\-1:1234:function/functionname\(dq
        \- region: us\-east\-1
        \- keyid: GKTADJGHEIQSXMKKRBJ08H
        \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iot.policy_absent(name, policyName, region=None, key=None, keyid=None, profile=None)
Ensure policy with passed properties is absent.
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B policyName
Name of the policy.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iot.policy_attached(name, policyName, principal, region=None, key=None, keyid=None, profile=None)
Ensure policy is attached to the given principal.
.INDENT 7.0
.TP
.B name
The name of the state definition
.TP
.B policyName
Name of the policy.
.TP
.B principal
The principal which can be a certificate ARN or a Cognito ID.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iot.policy_detached(name, policyName, principal, region=None, key=None, keyid=None, profile=None)
Ensure policy is attached to the given principal.
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B policyName
Name of the policy.
.TP
.B principal
The principal which can be a certificate ARN or a Cognito ID.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iot.policy_present(name, policyName, policyDocument, region=None, key=None, keyid=None, profile=None)
Ensure policy exists.
.INDENT 7.0
.TP
.B name
The name of the state definition
.TP
.B policyName
Name of the policy.
.TP
.B policyDocument
The JSON document that describes the policy. The length of the
policyDocument must be a minimum length of 1, with a maximum length of
2048, excluding whitespace.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iot.thing_type_absent(name, thingTypeName, region=None, key=None, keyid=None, profile=None)
Ensure thing type with passed properties is absent.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B thingTypeName
Name of the thing type.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iot.thing_type_present(name, thingTypeName, thingTypeDescription, searchableAttributesList, region=None, key=None, keyid=None, profile=None)
Ensure thing type exists.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B name
The name of the state definition
.TP
.B thingTypeName
Name of the thing type
.TP
.B thingTypeDescription
Description of the thing type
.TP
.B searchableAttributesList
List of string attributes that are searchable for
the thing type
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used
.TP
.B profile
A dict with region, key, keyid, or a pillar key (string) that
contains a dict with region, key, and keyid
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iot.topic_rule_absent(name, ruleName, region=None, key=None, keyid=None, profile=None)
Ensure topic rule with passed properties is absent.
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B ruleName
Name of the policy.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_iot.topic_rule_present(name, ruleName, sql, actions, description=\(aq\(aq, ruleDisabled=False, region=None, key=None, keyid=None, profile=None)
Ensure topic rule exists.
.INDENT 7.0
.TP
.B name
The name of the state definition
.TP
.B ruleName
Name of the rule.
.TP
.B sql
The SQL statement used to query the topic.
.TP
.B actions
The actions associated with the rule.
.TP
.B description
The description of the rule.
.TP
.B ruleDisable
Specifies whether the rule is disabled.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_kinesis
.SS Manage Kinesis Streams
.sp
New in version 2017.7.0.

.sp
Create and destroy Kinesis streams. Be aware that this interacts with Amazon\(aqs
services, and so may incur charges.
.sp
This module uses \fBboto3\fP, which can be installed via package, or pip.
.sp
This module accepts explicit Kinesis credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
keyid: GKTADJGHEIQSXMKKRBJ08H
key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a
profile, either passed in as a dict, or as a string to pull from
pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure Kinesis stream does not exist:
  boto_kinesis.absent:
    \- name: new_stream
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    \- region: us\-east\-1

Ensure Kinesis stream exists:
  boto_kinesis.present:
    \- name: new_stream
    \- retention_hours: 168
    \- enhanced_monitoring: [\(aqALL\(aq]
    \- num_shards: 2
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    \- region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_kinesis.absent(name, region=None, key=None, keyid=None, profile=None)
Delete the kinesis stream, if it exists.
.INDENT 7.0
.TP
.B name (string)
Stream name
.TP
.B region (string)
Region to connect to.
.TP
.B key (string)
Secret key to be used.
.TP
.B keyid (string)
Access key to be used.
.TP
.B profile (dict)
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_kinesis.present(name, retention_hours=None, enhanced_monitoring=None, num_shards=None, do_reshard=True, region=None, key=None, keyid=None, profile=None)
Ensure the kinesis stream is properly configured and scaled.
.INDENT 7.0
.TP
.B name (string)
Stream name
.TP
.B retention_hours (int)
Retain data for this many hours.
AWS allows minimum 24 hours, maximum 168 hours.
.TP
.B enhanced_monitoring (list of string)
Turn on enhanced monitoring for the specified shard\-level metrics.
Pass in [\(aqALL\(aq] or True for all metrics, [] or False for no metrics.
Turn on individual metrics by passing in a list: [\(aqIncomingBytes\(aq, \(aqOutgoingBytes\(aq]
Note that if only some metrics are supplied, the remaining metrics will be turned off.
.TP
.B num_shards (int)
Reshard stream (if necessary) to this number of shards
!!!!! Resharding is expensive! Each split or merge can take up to 30 seconds,
and the reshard method balances the partition space evenly.
Resharding from N to N+1 can require 2N operations.
Resharding is much faster with powers of 2 (e.g. 2^N to 2^N+1) !!!!!
.TP
.B do_reshard (boolean)
If set to False, this script will NEVER reshard the stream,
regardless of other input. Useful for testing.
.TP
.B region (string)
Region to connect to.
.TP
.B key (string)
Secret key to be used.
.TP
.B keyid (string)
Access key to be used.
.TP
.B profile (dict)
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_kms
.sp
Manage KMS keys, key policies and grants.
.sp
New in version 2015.8.0.

.sp
Be aware that this interacts with Amazon\(aqs services, and so may incur charges.
.sp
This module uses \fBboto\fP, which can be installed via package, or pip.
.sp
This module accepts explicit kms credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
elb.keyid: GKTADJGHEIQSXMKKRBJ08H
elb.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile,
either passed in as a dict, or as a string to pull from pillars or minion
config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure mykey key exists:
  boto_kms.key_present:
    \- name: mykey
    \- region: us\-east\-1

# Using a profile from pillars
Ensure mykey key exists:
  boto_kms.key_present:
    \- name: mykey
    \- region: us\-east\-1
    \- profile: myprofile

# Passing in a profile
Ensure mykey key exists:
  boto_key.key_present:
    \- name: mykey
    \- region: us\-east\-1
    \- profile:
        keyid: GKTADJGHEIQSXMKKRBJ08H
        key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_kms.key_present(name, policy, description=None, key_usage=None, grants=None, manage_grants=False, key_rotation=False, enabled=True, region=None, key=None, keyid=None, profile=None)
Ensure the KMS key exists. KMS keys can not be deleted, so this function
must be used to ensure the key is enabled or disabled.
.INDENT 7.0
.TP
.B name
Name of the key.
.TP
.B policy
Key usage policy.
.TP
.B description
Description of the key.
.TP
.B key_usage
Specifies the intended use of the key. Can only be set on creation,
defaults to ENCRYPT_DECRYPT, which is also the only supported option.
.TP
.B grants
A list of grants to apply to the key. Not currently implemented.
.TP
.B manage_grants
Whether or not to manage grants. False by default, which will not
manage any grants.
.TP
.B key_rotation
Whether or not key rotation is enabled for the key. False by default.
.TP
.B enabled
Whether or not the key is enabled. True by default.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_lambda
.SS Manage Lambda Functions
.sp
New in version 2016.3.0.

.sp
Create and destroy Lambda Functions. Be aware that this interacts with Amazon\(aqs services,
and so may incur charges.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
boto
.IP \(bu 2
boto3
.UNINDENT
.UNINDENT
.sp
The dependencies listed above can be installed via package or pip.
.sp
This module accepts explicit vpc credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vpc.keyid: GKTADJGHEIQSXMKKRBJ08H
vpc.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile,
either passed in as a dict, or as a string to pull from pillars or minion
config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure function exists:
    boto_lambda.function_present:
        \- FunctionName: myfunction
        \- Runtime: python2.7
        \- Role: iam_role_name
        \- Handler: entry_function
        \- ZipFile: code.zip
        \- S3Bucket: bucketname
        \- S3Key: keyname
        \- S3ObjectVersion: version
        \- Description: \(dqMy Lambda Function\(dq
        \- Timeout: 3
        \- MemorySize: 128
        \- region: us\-east\-1
        \- keyid: GKTADJGHEIQSXMKKRBJ08H
        \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_lambda.alias_absent(name, FunctionName, Name, region=None, key=None, keyid=None, profile=None)
Ensure alias with passed properties is absent.
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B FunctionName
Name of the function.
.TP
.B Name
Name of the alias.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_lambda.alias_present(name, FunctionName, Name, FunctionVersion, Description=\(aq\(aq, region=None, key=None, keyid=None, profile=None)
Ensure alias exists.
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B FunctionName
Name of the function for which you want to create an alias.
.TP
.B Name
The name of the alias to be created.
.TP
.B FunctionVersion
Function version for which you are creating the alias.
.TP
.B Description
A short, user\-defined function description. Lambda does not use this value. Assign a meaningful
description as you see fit.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_lambda.event_source_mapping_absent(name, EventSourceArn, FunctionName, region=None, key=None, keyid=None, profile=None)
Ensure event source mapping with passed properties is absent.
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B EventSourceArn
ARN of the event source.
.TP
.B FunctionName
Name of the lambda function.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_lambda.event_source_mapping_present(name, EventSourceArn, FunctionName, StartingPosition, Enabled=True, BatchSize=100, region=None, key=None, keyid=None, profile=None)
Ensure event source mapping exists.
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B EventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon
DynamoDB stream that is the event source.
.TP
.B FunctionName
The Lambda function to invoke when AWS Lambda detects an event on the
stream.
.sp
You can specify an unqualified function name (for example, \(dqThumbnail\(dq)
or you can specify Amazon Resource Name (ARN) of the function (for
example, \(dqarn:aws:lambda:us\-west\-2:account\-id:function:ThumbNail\(dq). AWS
Lambda also allows you to specify only the account ID qualifier (for
example, \(dqaccount\-id:Thumbnail\(dq). Note that the length constraint
applies only to the ARN. If you specify only the function name, it is
limited to 64 character in length.
.TP
.B StartingPosition
The position in the stream where AWS Lambda should start reading.
(TRIM_HORIZON | LATEST)
.TP
.B Enabled
Indicates whether AWS Lambda should begin polling the event source. By
default, Enabled is true.
.TP
.B BatchSize
The largest number of records that AWS Lambda will retrieve from your
event source at the time of invoking your function. Your function
receives an event with all the retrieved records. The default is 100
records.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_lambda.function_absent(name, FunctionName, region=None, key=None, keyid=None, profile=None)
Ensure function with passed properties is absent.
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B FunctionName
Name of the function.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_lambda.function_present(name, FunctionName, Runtime, Role, Handler, ZipFile=None, S3Bucket=None, S3Key=None, S3ObjectVersion=None, Description=\(aq\(aq, Timeout=3, MemorySize=128, Permissions=None, RoleRetries=5, region=None, key=None, keyid=None, profile=None, VpcConfig=None, Environment=None)
Ensure function exists.
.INDENT 7.0
.TP
.B name
The name of the state definition
.TP
.B FunctionName
Name of the Function.
.TP
.B Runtime
The Runtime environment for the function. One of
\(aqnodejs\(aq, \(aqjava8\(aq, or \(aqpython2.7\(aq
.TP
.B Role
The name or ARN of the IAM role that the function assumes when it executes your
function to access any other AWS resources.
.TP
.B Handler
The function within your code that Lambda calls to begin execution. For Node.js it is the
module\-name.*export* value in your function. For Java, it can be package.classname::handler or
package.class\-name.
.TP
.B ZipFile
A path to a .zip file containing your deployment package. If this is
specified, S3Bucket and S3Key must not be specified.
.TP
.B S3Bucket
Amazon S3 bucket name where the .zip file containing your package is
stored. If this is specified, S3Key must be specified and ZipFile must
NOT be specified.
.TP
.B S3Key
The Amazon S3 object (the deployment package) key name you want to
upload. If this is specified, S3Key must be specified and ZipFile must
NOT be specified.
.TP
.B S3ObjectVersion
The version of S3 object to use. Optional, should only be specified if
S3Bucket and S3Key are specified.
.TP
.B Description
A short, user\-defined function description. Lambda does not use this value. Assign a meaningful
description as you see fit.
.TP
.B Timeout
The function execution time at which Lambda should terminate this function. Because the execution
time has cost implications, we recommend you set this value based on your expected execution time.
The default is 3 seconds.
.TP
.B MemorySize
The amount of memory, in MB, your function is given. Lambda uses this memory size to infer
the amount of CPU and memory allocated to your function. Your function use\-case determines your
CPU and memory requirements. For example, a database operation might need less memory compared
to an image processing function. The default value is 128 MB. The value must be a multiple of
64 MB.
.TP
.B VpcConfig
If your Lambda function accesses resources in a VPC, you must provide this parameter
identifying the list of security group IDs/Names and subnet IDs/Name.  These must all belong
to the same VPC.  This is a dict of the form:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
VpcConfig:
  SecurityGroupNames:
    \- mysecgroup1
    \- mysecgroup2
  SecurityGroupIds:
    \- sg\-abcdef1234
  SubnetNames:
    \- mysubnet1
  SubnetIds:
    \- subnet\-1234abcd
    \- subnet\-abcd1234
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If VpcConfig is provided at all, you MUST pass at least one security group and one subnet.
.TP
.B Permissions
A list of permission definitions to be added to the function\(aqs policy
.TP
.B RoleRetries
IAM Roles may take some time to propagate to all regions once created.
During that time function creation may fail; this state will
atuomatically retry this number of times. The default is 5.
.TP
.B Environment
The parent object that contains your environment\(aqs configuration
settings.  This is a dictionary of the form:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqVariables\(aq: {
        \(aqVariableName\(aq: \(aqVariableValue\(aq
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_lc
.sp
Manage Launch Configurations
.sp
New in version 2014.7.0.

.sp
Create and destroy Launch Configurations. Be aware that this interacts with
Amazon\(aqs services, and so may incur charges.
.sp
A limitation of this module is that you can not modify launch configurations
once they have been created. If a launch configuration with the specified name
exists, this module will always report success, even if the specified
configuration doesn\(aqt match. This is due to a limitation in Amazon\(aqs launch
configuration API, as it only allows launch configurations to be created and
deleted.
.sp
Also note that a launch configuration that\(aqs in use by an autoscale group can
not be deleted until the autoscale group is no longer using it. This may affect
the way in which you want to order your states.
.sp
This module uses \fBboto\fP, which can be installed via package, or pip.
.sp
This module accepts explicit autoscale credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
asg.keyid: GKTADJGHEIQSXMKKRBJ08H
asg.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile, either
passed in as a dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Credential information is shared with autoscale groups as launch configurations
and autoscale groups are completely dependent on each other.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure mylc exists:
  boto_lc.present:
    \- name: mylc
    \- image_id: ami\-0b9c9f62
    \- key_name: mykey
    \- security_groups:
        \- mygroup
    \- instance_type: m1.small
    \- instance_monitoring: true
    \- block_device_mappings:
        \- \(aq/dev/sda1\(aq:
            size: 20
            volume_type: \(aqio1\(aq
            iops: 220
            delete_on_termination: true
    \- cloud_init:
        boothooks:
          \(aqdisable\-master.sh\(aq: |
            #!/bin/bash
            echo \(dqmanual\(dq > /etc/init/salt\-master.override
        scripts:
          \(aqrun_salt.sh\(aq: |
            #!/bin/bash

            add\-apt\-repository \-y ppa:saltstack/salt
            apt\-get update
            apt\-get install \-y salt\-minion
            salt\-call state.highstate
    \- region: us\-east\-1
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

# Using a profile from pillars.
Ensure mylc exists:
  boto_lc.present:
    \- name: mylc
    \- image_id: ami\-0b9c9f62
    \- profile: myprofile

# Passing in a profile.
Ensure mylc exists:
  boto_lc.present:
    \- name: mylc
    \- image_id: ami\-0b9c9f62
    \- profile:
        keyid: GKTADJGHEIQSXMKKRBJ08H
        key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_lc.absent(name, region=None, key=None, keyid=None, profile=None)
Ensure the named launch configuration is deleted.
.INDENT 7.0
.TP
.B name
Name of the launch configuration.
.TP
.B region
The region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_lc.present(name, image_id, key_name=None, vpc_id=None, vpc_name=None, security_groups=None, user_data=None, cloud_init=None, instance_type=\(aqm1.small\(aq, kernel_id=None, ramdisk_id=None, block_device_mappings=None, delete_on_termination=None, instance_monitoring=False, spot_price=None, instance_profile_name=None, ebs_optimized=False, associate_public_ip_address=None, region=None, key=None, keyid=None, profile=None)
Ensure the launch configuration exists.
.INDENT 7.0
.TP
.B name
Name of the launch configuration.
.TP
.B image_id
AMI to use for instances. AMI must exist or creation of the launch
configuration will fail.
.TP
.B key_name
Name of the EC2 key pair to use for instances. Key must exist or
creation of the launch configuration will fail.
.TP
.B vpc_id
The VPC id where the security groups are defined. Only necessary when
using named security groups that exist outside of the default VPC.
Mutually exclusive with vpc_name.
.TP
.B vpc_name
Name of the VPC where the security groups are defined. Only Necessary
when using named security groups that exist outside of the default VPC.
Mutually exclusive with vpc_id.
.TP
.B security_groups
List of Names or security group id’s of the security groups with which
to associate the EC2 instances or VPC instances, respectively. Security
groups must exist, or creation of the launch configuration will fail.
.TP
.B user_data
The user data available to launched EC2 instances.
.TP
.B cloud_init
A dict of cloud_init configuration. Currently supported keys:
boothooks, scripts and cloud\-config.
Mutually exclusive with user_data.
.TP
.B instance_type
The instance type. ex: m1.small.
.TP
.B kernel_id
The kernel id for the instance.
.TP
.B ramdisk_id
The RAM disk ID for the instance.
.TP
.B block_device_mappings
A dict of block device mappings that contains a dict
with volume_type, delete_on_termination, iops, size, encrypted,
snapshot_id.
.INDENT 7.0
.TP
.B volume_type
Indicates what volume type to use. Valid values are standard, io1, gp2.
Default is standard.
.TP
.B delete_on_termination
Whether the volume should be explicitly marked for deletion when its instance is
terminated (True), or left around (False).  If not provided, or None is explicitly passed,
the default AWS behaviour is used, which is True for ROOT volumes of instances, and
False for all others.
.TP
.B iops
For Provisioned IOPS (SSD) volumes only. The number of I/O operations per
second (IOPS) to provision for the volume.
.TP
.B size
Desired volume size (in GiB).
.TP
.B encrypted
Indicates whether the volume should be encrypted. Encrypted EBS volumes must
be attached to instances that support Amazon EBS encryption. Volumes that are
created from encrypted snapshots are automatically encrypted. There is no way
to create an encrypted volume from an unencrypted snapshot or an unencrypted
volume from an encrypted snapshot.
.UNINDENT
.TP
.B instance_monitoring
Whether instances in group are launched with detailed monitoring.
.TP
.B spot_price
The spot price you are bidding. Only applies if you are building an
autoscaling group with spot instances.
.TP
.B instance_profile_name
The name or the Amazon Resource Name (ARN) of the instance profile
associated with the IAM role for the instance. Instance profile must
exist or the creation of the launch configuration will fail.
.TP
.B ebs_optimized
Specifies whether the instance is optimized for EBS I/O (true) or not
(false).
.TP
.B associate_public_ip_address
Used for Auto Scaling groups that launch instances into an Amazon
Virtual Private Cloud. Specifies whether to assign a public IP address
to each instance launched in a Amazon VPC.
.TP
.B region
The region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_rds
.SS Manage RDSs
.sp
New in version 2015.8.0.

.sp
Create and destroy RDS instances. Be aware that this interacts with Amazon\(aqs
services, and so may incur charges.
.sp
This module uses \fBboto\fP, which can be installed via package, or pip.
.sp
This module accepts explicit rds credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rds.keyid: GKTADJGHEIQSXMKKRBJ08H
rds.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile,
either passed in as a dict, or as a string to pull from pillars or minion
config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure myrds RDS exists:
  boto_rds.present:
    \- name: myrds
    \- allocated_storage: 5
    \- storage_type: standard
    \- db_instance_class: db.t2.micro
    \- engine: MySQL
    \- master_username: myuser
    \- master_user_password: mypass
    \- region: us\-east\-1
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    \- tags:
        key: value
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure parameter group exists:
    create\-parameter\-group:
      boto_rds.parameter_present:
        \- name: myparametergroup
        \- db_parameter_group_family: mysql5.6
        \- description: \(dqparameter group family\(dq
        \- parameters:
          \- binlog_cache_size: 32768
          \- binlog_checksum: CRC32
        \- region: eu\-west\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_rds.absent(name, skip_final_snapshot=None, final_db_snapshot_identifier=None, tags=None, wait_for_deletion=True, timeout=180, region=None, key=None, keyid=None, profile=None)
Ensure RDS instance is absent.
.INDENT 7.0
.TP
.B name
Name of the RDS instance.
.TP
.B skip_final_snapshot
Whether a final db snapshot is created before the instance is deleted.
If True, no snapshot is created.
If False, a snapshot is created before deleting the instance.
.TP
.B final_db_snapshot_identifier
If a final snapshot is requested, this is the identifier used for that
snapshot.
.TP
.B tags
A dict of tags.
.TP
.B wait_for_deletion (bool)
Wait for the RDS instance to be deleted completely before finishing
the state.
.TP
.B timeout (in seconds)
The amount of time that can pass before raising an Exception.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_rds.parameter_present(name, db_parameter_group_family, description, parameters=None, apply_method=\(aqpending\-reboot\(aq, tags=None, region=None, key=None, keyid=None, profile=None)
Ensure DB parameter group exists and update parameters.
.INDENT 7.0
.TP
.B name
The name for the parameter group.
.TP
.B db_parameter_group_family
The DB parameter group family name. A
DB parameter group can be associated with one and only one DB
parameter group family, and can be applied only to a DB instance
running a database engine and engine version compatible with that
DB parameter group family.
.TP
.B description
Parameter group description.
.TP
.B parameters
The DB parameters that need to be changed of type dictionary.
.TP
.B apply_method
The \fIapply\-immediate\fP method can be used only for dynamic
parameters; the \fIpending\-reboot\fP method can be used with MySQL
and Oracle DB instances for either dynamic or static
parameters. For Microsoft SQL Server DB instances, the
\fIpending\-reboot\fP method can be used only for static
parameters.
.TP
.B tags
A dict of tags.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_rds.present(name, allocated_storage, db_instance_class, engine, master_username, master_user_password, db_name=None, storage_type=None, db_security_groups=None, vpc_security_group_ids=None, vpc_security_groups=None, availability_zone=None, db_subnet_group_name=None, preferred_maintenance_window=None, db_parameter_group_name=None, db_cluster_identifier=None, tde_credential_arn=None, tde_credential_password=None, storage_encrypted=None, kms_keyid=None, backup_retention_period=None, preferred_backup_window=None, port=None, multi_az=None, engine_version=None, auto_minor_version_upgrade=None, license_model=None, iops=None, option_group_name=None, character_set_name=None, publicly_accessible=None, wait_status=None, tags=None, copy_tags_to_snapshot=None, region=None, domain=None, key=None, keyid=None, monitoring_interval=None, monitoring_role_arn=None, domain_iam_role_name=None, promotion_tier=None, profile=None)
Ensure RDS instance exists.
.INDENT 7.0
.TP
.B name
Name of the RDS state definition.
.TP
.B allocated_storage
The amount of storage (in gigabytes) to be initially allocated for the
database instance.
.TP
.B db_instance_class
The compute and memory capacity of the Amazon RDS DB instance.
.TP
.B engine
The name of the database engine to be used for this instance. Supported
engine types are: MySQL, mariadb, oracle\-se1, oracle\-se, oracle\-ee, sqlserver\-ee,
sqlserver\-se, sqlserver\-ex, sqlserver\-web, postgres and aurora. For more
information, please see the \fBengine\fP argument in the Boto3 RDS
\fI\%create_db_instance\fP documentation.
.TP
.B master_username
The name of master user for the client DB instance.
.TP
.B master_user_password
The password for the master database user. Can be any printable ASCII
character except \(dq/\(dq, \(aq\(dq\(aq, or \(dq@\(dq.
.TP
.B db_name
The meaning of this parameter differs according to the database engine you use.
See the Boto3 RDS documentation to determine the appropriate value for your configuration.
\fI\%https://boto3.readthedocs.io/en/latest/reference/services/rds.html#RDS.Client.create_db_instance\fP
.TP
.B storage_type
Specifies the storage type to be associated with the DB instance.
Options are standard, gp2 and io1. If you specify io1, you must also include
a value for the Iops parameter.
.TP
.B db_security_groups
A list of DB security groups to associate with this DB instance.
.TP
.B vpc_security_group_ids
A list of EC2 VPC security group IDs to associate with this DB instance.
.TP
.B vpc_security_groups
A list of EC2 VPC security groups (IDs or Name tags) to associate with this DB instance.
.TP
.B availability_zone
The EC2 Availability Zone that the database instance will be created
in.
.TP
.B db_subnet_group_name
A DB subnet group to associate with this DB instance.
.TP
.B preferred_maintenance_window
The weekly time range (in UTC) during which system maintenance can
occur.
.TP
.B db_parameter_group_name
A DB parameter group to associate with this DB instance.
.TP
.B db_cluster_identifier
If the DB instance is a member of a DB cluster, contains the name of
the DB cluster that the DB instance is a member of.
.TP
.B tde_credential_arn
The ARN from the Key Store with which the instance is associated for
TDE encryption.
.TP
.B tde_credential_password
The password to use for TDE encryption if an encryption key is not used.
.TP
.B storage_encrypted
Specifies whether the DB instance is encrypted.
.TP
.B kms_keyid
If storage_encrypted is true, the KMS key identifier for the encrypted
DB instance.
.TP
.B backup_retention_period
The number of days for which automated backups are retained.
.TP
.B preferred_backup_window
The daily time range during which automated backups are created if
automated backups are enabled.
.TP
.B port
The port number on which the database accepts connections.
.TP
.B multi_az
Specifies if the DB instance is a Multi\-AZ deployment. You cannot set
the AvailabilityZone parameter if the MultiAZ parameter is set to true.
.TP
.B engine_version
The version number of the database engine to use.
.TP
.B auto_minor_version_upgrade
Indicates that minor engine upgrades will be applied automatically to
the DB instance during the maintenance window.
.TP
.B license_model
License model information for this DB instance.
.TP
.B iops
The amount of Provisioned IOPS (input/output operations per second) to
be initially allocated for the DB instance.
.TP
.B option_group_name
Indicates that the DB instance should be associated with the specified
option group.
.TP
.B character_set_name
For supported engines, indicates that the DB instance should be
associated with the specified CharacterSet.
.TP
.B publicly_accessible
Specifies the accessibility options for the DB instance. A value of
true specifies an Internet\-facing instance with a publicly resolvable
DNS name, which resolves to a public IP address. A value of false
specifies an internal instance with a DNS name that resolves to a
private IP address.
.TP
.B wait_status
Wait for the RDS instance to reach a desired status before finishing
the state. Available states: available, modifying, backing\-up
.TP
.B tags
A dict of tags.
.TP
.B copy_tags_to_snapshot
Specifies whether tags are copied from the DB instance to snapshots of
the DB instance.
.TP
.B region
Region to connect to.
.TP
.B domain
The identifier of the Active Directory Domain.
.TP
.B key
AWS secret key to be used.
.TP
.B keyid
AWS access key to be used.
.TP
.B monitoring_interval
The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance.
.TP
.B monitoring_role_arn
The ARN for the IAM role that permits RDS to send Enhanced Monitoring
metrics to CloudWatch Logs.
.TP
.B domain_iam_role_name
Specify the name of the IAM role to be used when making API calls to
the Directory Service.
.TP
.B promotion_tier
A value that specifies the order in which an Aurora Replica is
promoted to the primary instance after a failure of the existing
primary instance. For more information, see Fault Tolerance for an
Aurora DB Cluster .
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_rds.replica_present(name, source, db_instance_class=None, availability_zone=None, port=None, auto_minor_version_upgrade=None, iops=None, option_group_name=None, publicly_accessible=None, tags=None, region=None, key=None, keyid=None, profile=None, db_parameter_group_name=None)
Ensure RDS replica exists.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure myrds replica RDS exists:
  boto_rds.create_replica:
    \- name: myreplica
    \- source: mydb
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_rds.subnet_group_absent(name, tags=None, region=None, key=None, keyid=None, profile=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_rds.subnet_group_present(name, description, subnet_ids=None, subnet_names=None, tags=None, region=None, key=None, keyid=None, profile=None)
Ensure DB subnet group exists.
.INDENT 7.0
.TP
.B name
The name for the DB subnet group. This value is stored as a lowercase string.
.TP
.B subnet_ids
A list of the EC2 Subnet IDs for the DB subnet group.
Either subnet_ids or subnet_names must be provided.
.TP
.B subnet_names
A list of The EC2 Subnet names for the DB subnet group.
Either subnet_ids or subnet_names must be provided.
.TP
.B description
Subnet group description.
.TP
.B tags
A dict of tags.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_route53
.sp
Manage Route53 records
.sp
New in version 2014.7.0.

.sp
Create and delete Route53 records. Be aware that this interacts with Amazon\(aqs
services, and so may incur charges.
.sp
This module uses \fBboto\fP, which can be installed via package, or pip.
.sp
This module accepts explicit route53 credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
route53.keyid: GKTADJGHEIQSXMKKRBJ08H
route53.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile, either
passed in as a dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
  region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mycnamerecord:
  boto_route53.present:
    \- name: test.example.com.
    \- value: my\-elb.us\-east\-1.elb.amazonaws.com.
    \- zone: example.com.
    \- ttl: 60
    \- record_type: CNAME
    \- region: us\-east\-1
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

# Using a profile from pillars
myarecord:
  boto_route53.present:
    \- name: test.example.com.
    \- value: 1.1.1.1
    \- zone: example.com.
    \- ttl: 60
    \- record_type: A
    \- region: us\-east\-1
    \- profile: myprofile

# Passing in a profile
myarecord:
  boto_route53.present:
    \- name: test.example.com.
    \- value: 1.1.1.1
    \- zone: example.com.
    \- ttl: 60
    \- record_type: A
    \- region: us\-east\-1
    \- profile:
        keyid: GKTADJGHEIQSXMKKRBJ08H
        key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_route53.absent(name, zone, record_type, identifier=None, region=None, key=None, keyid=None, profile=None, wait_for_sync=True, split_dns=False, private_zone=False)
Ensure the Route53 record is deleted.
.INDENT 7.0
.TP
.B name
Name of the record.
.TP
.B zone
The zone to delete the record from.
.TP
.B record_type
The record type (A, NS, MX, TXT, etc.)
.TP
.B identifier
An identifier to match for deletion.
.TP
.B region
The region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.TP
.B wait_for_sync
Wait for an INSYNC change status from Route53.
.TP
.B split_dns
Route53 supports a public and private DNS zone with the same
names.
.TP
.B private_zone
If using split_dns, specify if this is the private zone.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_route53.hosted_zone_absent(name, domain_name=None, region=None, key=None, keyid=None, profile=None)
Ensure the Route53 Hostes Zone described is absent
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B domain_name
The FQDN (including final period) of the zone you wish absent.  If not
provided, the value of name will be used.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_route53.hosted_zone_present(name, domain_name=None, private_zone=False, caller_ref=None, comment=\(aq\(aq, vpc_id=None, vpc_name=None, vpc_region=None, region=None, key=None, keyid=None, profile=None)
Ensure a hosted zone exists with the given attributes. Note that most
things cannot be modified once a zone is created \- it must be deleted and
re\-spun to update these attributes:
.INDENT 7.0
.IP \(bu 2
private_zone (AWS API limitation).
.IP \(bu 2
comment (the appropriate call exists in the AWS API and in boto3, but has
not, as of this writing, been added to boto2).
.IP \(bu 2
vpc_id (same story \- we really need to rewrite this module with boto3)
.IP \(bu 2
vpc_name (really just a pointer to vpc_id anyway).
.IP \(bu 2
vpc_region (again, supported in boto3 but not boto2).
.UNINDENT
.sp
If you need the ability to update these attributes, please use the newer
boto3_route53 module instead.
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B domain_name
The name of the domain. This must be fully\-qualified, terminating with a period.  This is
the name you have registered with your domain registrar.  It is also the name you will
delegate from your registrar to the Amazon Route 53 delegation servers returned in response
to this request.  Defaults to the value of name if not provided.
.TP
.B private_zone
Set True if creating a private hosted zone.
.TP
.B caller_ref
A unique string that identifies the request and that allows create_hosted_zone() calls to be
retried without the risk of executing the operation twice.  This helps ensure idempotency
across state calls, but can cause issues if a zone is deleted and then an attempt is made
to recreate it with the same caller_ref.  If not provided, a unique UUID will be generated
at each state run, which avoids the risk of the above (transient) error.  This option is
generally not needed.  Maximum length of 128.
.TP
.B comment
Any comments you want to include about the hosted zone.
.TP
.B vpc_id
When creating a private hosted zone, either the VPC ID or VPC Name to associate with is
required.  Exclusive with vpe_name.  Ignored when creating a non\-private zone.
.TP
.B vpc_name
When creating a private hosted zone, either the VPC ID or VPC Name to associate with is
required.  Exclusive with vpe_id.  Ignored when creating a non\-private zone.
.TP
.B vpc_region
When creating a private hosted zone, the region of the associated VPC is required.  If not
provided, an effort will be made to determine it from vpc_id or vpc_name, where possible.
If this fails, you\(aqll need to provide an explicit value for this option.  Ignored when
creating a non\-private zone.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_route53.present(name, value, zone, record_type, ttl=None, identifier=None, region=None, key=None, keyid=None, profile=None, wait_for_sync=True, split_dns=False, private_zone=False)
Ensure the Route53 record is present.
.INDENT 7.0
.TP
.B name
Name of the record.
.TP
.B value
.INDENT 7.0
.TP
.B Value of the record.  As a special case, you can pass in:
\fIprivate:<Name tag>\fP to have the function autodetermine the private IP
\fIpublic:<Name tag>\fP to have the function autodetermine the public IP
.UNINDENT
.TP
.B zone
The zone to create the record in.
.TP
.B record_type
The record type (A, NS, MX, TXT, etc.)
.TP
.B ttl
The time to live for the record.
.TP
.B identifier
The unique identifier to use for this record.
.TP
.B region
The region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that contains a dict
with region, key and keyid.
.TP
.B wait_for_sync
Wait for an INSYNC change status from Route53 before returning success.
.TP
.B split_dns
Route53 supports parallel public and private DNS zones with the same name.
.TP
.B private_zone
If using split_dns, specify if this is the private zone.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_route53.rr_absent(*args, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_route53.rr_present(*args, **kwargs)
.UNINDENT
.SS salt.states.boto_s3
.SS Manage S3 Resources
.sp
New in version 2018.3.0.

.sp
Manage S3 resources. Be aware that this interacts with Amazon\(aqs services,
and so may incur charges.
.sp
This module uses \fBboto3\fP, which can be installed via package, or pip.
.sp
This module accepts explicit AWS credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
s3.keyid: GKTADJGHEIQSXMKKRBJ08H
s3.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile,
either passed in as a dict, or as a string to pull from pillars or minion
config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure s3 object exists:
    boto_s3.object_present:
        \- name: s3\-bucket/s3\-key
        \- source: /path/to/local/file
        \- region: us\-east\-1
        \- keyid: GKTADJGHEIQSXMKKRBJ08H
        \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        \- profile: my\-profile
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
boto3
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_s3.object_present(name, source=None, hash_type=None, extra_args=None, extra_args_from_pillar=\(aqboto_s3_object_extra_args\(aq, region=None, key=None, keyid=None, profile=None)
Ensure object exists in S3.
.INDENT 7.0
.TP
.B name
The name of the state definition.
This will be used to determine the location of the object in S3,
by splitting on the first slash and using the first part
as the bucket name and the remainder as the S3 key.
.TP
.B source
The source file to upload to S3,
currently this only supports files hosted on the minion\(aqs local
file system (starting with /).
.TP
.B hash_type
Hash algorithm to use to check that the object contents are correct.
Defaults to the value of the \fIhash_type\fP config option.
.TP
.B extra_args
A dictionary of extra arguments to use when uploading the file.
Note that these are only enforced if new objects are uploaded,
and not modified on existing objects.
The supported args are those in the ALLOWED_UPLOAD_ARGS list at
\fI\%http://boto3.readthedocs.io/en/latest/reference/customizations/s3.html\fP\&.
However, Note that the \(aqACL\(aq, \(aqGrantFullControl\(aq, \(aqGrantRead\(aq,
\(aqGrantReadACP\(aq,  and \(aqGrantWriteACL\(aq keys are currently not supported.
.TP
.B extra_args_from_pillar
Name of pillar dict that contains extra arguments.
Extra arguments defined for this specific state will be
merged over those from the pillar.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_s3_bucket
.SS Manage S3 Buckets
.sp
New in version 2016.3.0.

.sp
Create and destroy S3 buckets. Be aware that this interacts with Amazon\(aqs services,
and so may incur charges.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
boto
.IP \(bu 2
boto3
.UNINDENT
.UNINDENT
.sp
The dependencies listed above can be installed via package or pip.
.sp
This module accepts explicit vpc credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vpc.keyid: GKTADJGHEIQSXMKKRBJ08H
vpc.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile,
either passed in as a dict, or as a string to pull from pillars or minion
config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure bucket exists:
    boto_s3_bucket.present:
        \- Bucket: mybucket
        \- LocationConstraint: EU
        \- ACL:
          \- GrantRead: \(dquri=http://acs.amazonaws.com/groups/global/AllUsers\(dq
        \- CORSRules:
          \- AllowedHeaders: []
            AllowedMethods: [\(dqGET\(dq]
            AllowedOrigins: [\(dq*\(dq]
            ExposeHeaders: []
            MaxAgeSeconds: 123
        \- LifecycleConfiguration:
          \- Expiration:
              Days: 123
            ID: \(dqidstring\(dq
            Prefix: \(dqprefixstring\(dq
            Status: \(dqenabled\(dq,
            ID: \(dqlc1\(dq
            Transitions:
              \- Days: 123
                StorageClass: \(dqGLACIER\(dq
            NoncurrentVersionTransitions:
              \- NoncurrentDays: 123
                StorageClass: \(dqGLACIER\(dq
            NoncurrentVersionExpiration:
              NoncurrentDays: 123
        \- Logging:
            TargetBucket: log_bucket
            TargetPrefix: prefix
            TargetGrants:
              \- Grantee:
                  DisplayName: \(dqstring\(dq
                  EmailAddress: \(dqstring\(dq
                  ID: \(dqstring\(dq
                  Type: \(dqAmazonCustomerByEmail\(dq
                  URI: \(dqstring\(dq
                Permission: \(dqREAD\(dq
        \- NotificationConfiguration:
            LambdaFunctionConfiguration:
              \- Id: \(dqstring\(dq
                LambdaFunctionArn: \(dqstring\(dq
                Events:
                  \- \(dqs3:ObjectCreated:*\(dq
                Filter:
                  Key:
                    FilterRules:
                      \- Name: \(dqprefix\(dq
                        Value: \(dqstring\(dq
        \- Policy:
            Version: \(dq2012\-10\-17\(dq
            Statement:
              \- Sid: \(dqString\(dq
                Effect: \(dqAllow\(dq
                Principal:
                  AWS: \(dqarn:aws:iam::133434421342:root\(dq
                Action: \(dqs3:PutObject\(dq
                Resource: \(dqarn:aws:s3:::my\-bucket/*\(dq
        \- Replication:
            Role: myrole
            Rules:
              \- ID: \(dqstring\(dq
                Prefix: \(dqstring\(dq
                Status: \(dqEnabled\(dq
                Destination:
                  Bucket: \(dqarn:aws:s3:::my\-bucket\(dq
        \- RequestPayment:
            Payer: Requester
        \- Tagging:
            tag_name: tag_value
            tag_name_2: tag_value
        \- Versioning:
            Status: \(dqEnabled\(dq
        \- Website:
            ErrorDocument:
              Key: \(dqerror.html\(dq
            IndexDocument:
              Suffix: \(dqindex.html\(dq
            RedirectAllRequestsTo:
              Hostname: \(dqstring\(dq
              Protocol: \(dqhttp\(dq
            RoutingRules:
              \- Condition:
                  HttpErrorCodeReturnedEquals: \(dqstring\(dq
                  KeyPrefixEquals: \(dqstring\(dq
                Redirect:
                  HostName: \(dqstring\(dq
                  HttpRedirectCode: \(dqstring\(dq
                  Protocol: \(dqhttp\(dq
                  ReplaceKeyPrefixWith: \(dqstring\(dq
                  ReplaceKeyWith: \(dqstring\(dq
        \- region: us\-east\-1
        \- keyid: GKTADJGHEIQSXMKKRBJ08H
        \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_s3_bucket.absent(name, Bucket, Force=False, region=None, key=None, keyid=None, profile=None)
Ensure bucket with passed properties is absent.
.INDENT 7.0
.TP
.B name
The name of the state definition.
.TP
.B Bucket
Name of the bucket.
.TP
.B Force
Empty the bucket first if necessary \- Boolean.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_s3_bucket.present(name, Bucket, LocationConstraint=None, ACL=None, CORSRules=None, LifecycleConfiguration=None, Logging=None, NotificationConfiguration=None, Policy=None, Replication=None, RequestPayment=None, Tagging=None, Versioning=None, Website=None, region=None, key=None, keyid=None, profile=None)
Ensure bucket exists.
.INDENT 7.0
.TP
.B name
The name of the state definition
.TP
.B Bucket
Name of the bucket.
.TP
.B LocationConstraint
\(aqEU\(aq|\(aqeu\-west\-1\(aq|\(aqus\-west\-1\(aq|\(aqus\-west\-2\(aq|\(aqap\-southeast\-1\(aq|\(aqap\-southeast\-2\(aq|\(aqap\-northeast\-1\(aq|\(aqsa\-east\-1\(aq|\(aqcn\-north\-1\(aq|\(aqeu\-central\-1\(aq
.TP
.B ACL
The permissions on a bucket using access control lists (ACL).
.TP
.B CORSRules
The cors configuration for a bucket.
.TP
.B LifecycleConfiguration
Lifecycle configuration for your bucket
.TP
.B Logging
The logging parameters for a bucket and to specify permissions for who
can view and modify the logging parameters.
.TP
.B NotificationConfiguration
notifications of specified events for a bucket
.TP
.B Policy
Policy on the bucket
.TP
.B Replication
Replication rules. You can add as many as 1,000 rules.
Total replication configuration size can be up to 2 MB
.TP
.B RequestPayment
The request payment configuration for a bucket. By default, the bucket
owner pays for downloads from the bucket. This configuration parameter
enables the bucket owner (only) to specify that the person requesting
the download will be charged for the download
.TP
.B Tagging
A dictionary of tags that should be set on the bucket
.TP
.B Versioning
The versioning state of the bucket
.TP
.B Website
The website configuration of the bucket
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_secgroup
.SS Manage Security Groups
.sp
New in version 2014.7.0.

.sp
Create and destroy Security Groups. Be aware that this interacts with Amazon\(aqs
services, and so may incur charges.
.sp
This module uses \fBboto\fP, which can be installed via package, or pip.
.sp
This module accepts explicit EC2 credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
secgroup.keyid: GKTADJGHEIQSXMKKRBJ08H
secgroup.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile, either
passed in as a dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure mysecgroup exists:
    boto_secgroup.present:
        \- name: mysecgroup
        \- description: My security group
        \- vpc_name: myvpc
        \- rules:
            \- ip_protocol: tcp
              from_port: 80
              to_port: 80
              cidr_ip:
                \- 10.0.0.0/8
                \- 192.168.0.0/16
            \- ip_protocol: tcp
              from_port: 8080
              to_port: 8090
              cidr_ip:
                \- 10.0.0.0/8
                \- 192.168.0.0/16
            \- ip_protocol: icmp
              from_port: \-1
              to_port: \-1
              source_group_name: mysecgroup
            \- ip_protocol: tcp
              from_port: 8080
              to_port: 8080
              source_group_name: MyOtherSecGroup
              source_group_name_vpc: MyPeeredVPC
        \- rules_egress:
            \- ip_protocol: all
              from_port: \-1
              to_port: \-1
              cidr_ip:
                \- 10.0.0.0/8
                \- 192.168.0.0/16
        \- tags:
            SomeTag: \(aqMy Tag Value\(aq
            SomeOtherTag: \(aqOther Tag Value\(aq
        \- region: us\-east\-1
        \- keyid: GKTADJGHEIQSXMKKRBJ08H
        \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

# Using a profile from pillars
Ensure mysecgroup exists:
    boto_secgroup.present:
        \- name: mysecgroup
        \- description: My security group
        \- profile: myprofile

# Passing in a profile
Ensure mysecgroup exists:
    boto_secgroup.present:
        \- name: mysecgroup
        \- description: My security group
        \- profile:
            keyid: GKTADJGHEIQSXMKKRBJ08H
            key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
            region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When using the \fBprofile\fP parameter and \fBregion\fP is set outside of
the profile group, region is ignored and a default region will be used.
.sp
If \fBregion\fP is missing from the \fBprofile\fP data set, \fBus\-east\-1\fP
will be used as the default region.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_secgroup.absent(name, vpc_id=None, vpc_name=None, region=None, key=None, keyid=None, profile=None)
Ensure a security group with the specified name does not exist.
.INDENT 7.0
.TP
.B name
Name of the security group.
.TP
.B vpc_id
The ID of the VPC to remove the security group from, if any. Exclusive with vpc_name.
.TP
.B vpc_name
The name of the VPC to remove the security group from, if any. Exclusive with vpc_name.
.sp
New in version 2016.3.0.

.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.sp
New in version 2016.3.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_secgroup.present(name, description, vpc_id=None, vpc_name=None, rules=None, rules_egress=None, delete_ingress_rules=True, delete_egress_rules=True, region=None, key=None, keyid=None, profile=None, tags=None)
Ensure the security group exists with the specified rules.
.INDENT 7.0
.TP
.B name
Name of the security group.
.TP
.B description
A description of this security group.
.TP
.B vpc_id
The ID of the VPC to create the security group in, if any. Exclusive with vpc_name.
.TP
.B vpc_name
The name of the VPC to create the security group in, if any. Exclusive with vpc_id.
.sp
New in version 2016.3.0.

.sp
New in version 2015.8.2.

.TP
.B rules
A list of ingress rule dicts. If not specified, \fBrules=None\fP,
the ingress rules will be unmanaged. If set to an empty list, \fB[]\fP,
then all ingress rules will be removed.
.TP
.B rules_egress
A list of egress rule dicts. If not specified, \fBrules_egress=None\fP,
the egress rules will be unmanaged. If set to an empty list, \fB[]\fP,
then all egress rules will be removed.
.TP
.B delete_ingress_rules
Some tools (EMR comes to mind) insist on adding rules on\-the\-fly, which
salt will happily remove on the next run.  Set this param to False to
avoid deleting rules which were added outside of salt.
.TP
.B delete_egress_rules
Some tools (EMR comes to mind) insist on adding rules on\-the\-fly, which
salt will happily remove on the next run.  Set this param to False to
avoid deleting rules which were added outside of salt.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key, and keyid.
.TP
.B tags
List of key:value pairs of tags to set on the security group
.sp
New in version 2016.3.0.

.UNINDENT
.UNINDENT
.SS salt.states.boto_sns
.sp
Manage SNS Topics
.sp
Create and destroy SNS topics. Be aware that this interacts with Amazon\(aqs
services, and so may incur charges.
.sp
This module uses \fBboto\fP, which can be installed via package, or pip.
.sp
This module accepts explicit AWS credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sns.keyid: GKTADJGHEIQSXMKKRBJ08H
sns.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile, either
passed in as a dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mytopic:
    boto_sns.present:
        \- region: us\-east\-1
        \- keyid: GKTADJGHEIQSXMKKRBJ08H
        \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

# Using a profile from pillars
mytopic:
    boto_sns.present:
        \- region: us\-east\-1
        \- profile: mysnsprofile

# Passing in a profile
mytopic:
    boto_sns.present:
        \- region: us\-east\-1
        \- profile:
            keyid: GKTADJGHEIQSXMKKRBJ08H
            key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_sns.absent(name, region=None, key=None, keyid=None, profile=None, unsubscribe=False)
Ensure the named sns topic is deleted.
.INDENT 7.0
.TP
.B name
Name of the SNS topic.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.TP
.B unsubscribe
If True, unsubscribe all subcriptions to the SNS topic before
deleting the SNS topic
.sp
New in version 2016.11.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_sns.present(name, subscriptions=None, region=None, key=None, keyid=None, profile=None)
Ensure the SNS topic exists.
.INDENT 7.0
.TP
.B name
Name of the SNS topic.
.TP
.B subscriptions
List of SNS subscriptions.
.sp
Each subscription is a dictionary with a protocol and endpoint key:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[
{\(aqprotocol\(aq: \(aqhttps\(aq, \(aqendpoint\(aq: \(aqhttps://www.example.com/sns\-endpoint\(aq},
{\(aqprotocol\(aq: \(aqsqs\(aq, \(aqendpoint\(aq: \(aqarn:aws:sqs:us\-west\-2:123456789012:MyQueue\(aq}
]
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_sqs
.sp
Manage SQS Queues
.sp
New in version 2014.7.0.

.sp
Create and destroy SQS queues. Be aware that this interacts with Amazon\(aqs
services, and so may incur charges.
.sp
This module uses \fBboto\fP, which can be installed via package, or pip.
.sp
This module accepts explicit SQS credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sqs.keyid: GKTADJGHEIQSXMKKRBJ08H
sqs.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile, either
passed in as a dict, or as a string to pull from pillars or minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myqueue:
    boto_sqs.present:
        \- region: us\-east\-1
        \- keyid: GKTADJGHEIQSXMKKRBJ08H
        \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        \- attributes:
            ReceiveMessageWaitTimeSeconds: 20

# Using a profile from pillars
myqueue:
    boto_sqs.present:
        \- region: us\-east\-1
        \- profile: mysqsprofile

# Passing in a profile
myqueue:
    boto_sqs.present:
        \- region: us\-east\-1
        \- profile:
            keyid: GKTADJGHEIQSXMKKRBJ08H
            key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_sqs.absent(name, region=None, key=None, keyid=None, profile=None)
Ensure the named sqs queue is deleted.
.INDENT 7.0
.TP
.B name
Name of the SQS queue.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_sqs.present(name, attributes=None, region=None, key=None, keyid=None, profile=None)
Ensure the SQS queue exists.
.INDENT 7.0
.TP
.B name
Name of the SQS queue.
.TP
.B attributes
A dict of key/value SQS attributes.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.SS salt.states.boto_vpc
.SS Manage VPCs
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B depends
.UNINDENT
.INDENT 0.0
.IP \(bu 2
boto >= 2.8.0
.IP \(bu 2
boto3 >= 1.2.6
.UNINDENT
.sp
Create and destroy VPCs. Be aware that this interacts with Amazon\(aqs services,
and so may incur charges.
.sp
This module accepts explicit vpc credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available \fI\%here\fP\&.
.sp
If IAM roles are not used you need to specify them either in a pillar file or
in the minion\(aqs config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vpc.keyid: GKTADJGHEIQSXMKKRBJ08H
vpc.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to specify \fBkey\fP, \fBkeyid\fP and \fBregion\fP via a profile,
either passed in as a dict, or as a string to pull from pillars or minion
config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
  region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
aws:
  region:
    us\-east\-1:
      profile:
        keyid: GKTADJGHEIQSXMKKRBJ08H
        key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        region: us\-east\-1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure VPC exists:
  boto_vpc.present:
    \- name: myvpc
    \- cidr_block: 10.10.11.0/24
    \- dns_hostnames: True
    \- region: us\-east\-1
    \- keyid: GKTADJGHEIQSXMKKRBJ08H
    \- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

Ensure subnet exists:
  boto_vpc.subnet_present:
    \- name: mysubnet
    \- vpc_id: vpc\-123456
    \- cidr_block: 10.0.0.0/16
    \- region: us\-east\-1
    \- profile: myprofile

{% set profile = salt[\(aqpillar.get\(aq](\(aqaws:region:us\-east\-1:profile\(aq ) %}
Ensure internet gateway exists:
  boto_vpc.internet_gateway_present:
    \- name: myigw
    \- vpc_name: myvpc
    \- profile: {{ profile }}

Ensure route table exists:
  boto_vpc.route_table_present:
    \- name: my_route_table
    \- vpc_id: vpc\-123456
    \- routes:
      \- destination_cidr_block: 0.0.0.0/0
        instance_id: i\-123456
      \- subnet_names:
        \- subnet1
        \- subnet2
      \- region: us\-east\-1
      \- profile:
        keyid: GKTADJGHEIQSXMKKRBJ08H
        key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.sp
Request, accept and delete VPC peering connections.
VPC peering connections can be named allowing the name
to be used throughout the state file. Following
example shows how to request and accept a VPC
peering connection.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
accept the vpc peering connection:
  boto_vpc.accept_vpc_peering_connection:
    \- conn_name: salt_vpc_peering
    \- region: us\-west\-2
    \- require:
      \- boto_vpc: request a vpc peering connection

request a vpc peering connection:
  boto_vpc.request_vpc_peering_connection:
    \- requester_vpc_id: vpc\-4a3d522e
    \- peer_vpc_id: vpc\-ae81e9ca
    \- region: us\-west\-2
    \- conn_name: salt_vpc_peering
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
VPC peering connections need not be named. In this case
the VPC peering connection ID should be used in the state
file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
accept the vpc peering connection:
  boto_vpc.accept_vpc_peering_connection:
    \- conn_id: pcx\-1873c371
    \- region: us\-west\-2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
VPC peering connections can be deleted, as shown below.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
delete a named vpc peering connection:
  boto_vpc.delete_vpc_peering_connection:
    \- conn_name: salt_vpc_peering
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Delete also accepts a VPC peering connection id.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
delete a vpc peering connection by id:
  boto_vpc.delete_vpc_peering_connection:
    \- conn_id: pcx\-1873c371
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.absent(name, tags=None, region=None, key=None, keyid=None, profile=None)
Ensure VPC with passed properties is absent.
.INDENT 7.0
.TP
.B name
Name of the VPC.
.TP
.B tags
A list of tags. All tags must match.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.accept_vpc_peering_connection(name=None, conn_id=None, conn_name=None, region=None, key=None, keyid=None, profile=None)
Accept a VPC pending requested peering connection between two VPCs.
.INDENT 7.0
.TP
.B name
Name of this state
.TP
.B conn_id
The connection ID to accept. Exclusive with conn_name. String type.
.TP
.B conn_name
The name of the VPC peering connection to accept. Exclusive with conn_id. String type.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.sp
New in version 2016.11.0.

.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
boto_vpc.accept_vpc_peering_connection:
  \- conn_name: salt_peering_connection

# usage with vpc peering connection id and region
boto_vpc.accept_vpc_peering_connection:
  \- conn_id: pbx\-1873d472
  \- region: us\-west\-2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.delete_vpc_peering_connection(name, conn_id=None, conn_name=None, region=None, key=None, keyid=None, profile=None)
.INDENT 7.0
.TP
.B name
Name of the state
.TP
.B conn_id
ID of the peering connection to delete.  Exclusive with conn_name.
.TP
.B conn_name
The name of the peering connection to delete.  Exclusive with conn_id.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.sp
New in version 2016.11.0.

.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
delete a vpc peering connection:
  boto_vpc.delete_vpc_peering_connection:
    \- region: us\-west\-2
    \- conn_id: pcx\-4613b12e
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Connection name can be specified (instead of ID).
Specifying both conn_name and conn_id will result in an
error.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
delete a vpc peering connection:
  boto_vpc.delete_vpc_peering_connection:
    \- conn_name: salt_vpc_peering
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.dhcp_options_absent(name=None, dhcp_options_id=None, region=None, key=None, keyid=None, profile=None)
Ensure a set of DHCP options with the given settings exist.
.INDENT 7.0
.TP
.B name
(string)
Name of the DHCP options set.
.TP
.B dhcp_options_id
(string)
Id of the DHCP options set.
.TP
.B region
(string)
Region to connect to.
.TP
.B key
(string)
Secret key to be used.
.TP
.B keyid
(string)
Access key to be used.
.TP
.B profile
(various)
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.dhcp_options_present(name, dhcp_options_id=None, vpc_name=None, vpc_id=None, domain_name=None, domain_name_servers=None, ntp_servers=None, netbios_name_servers=None, netbios_node_type=None, tags=None, region=None, key=None, keyid=None, profile=None)
Ensure a set of DHCP options with the given settings exist.
Note that the current implementation only SETS values during option set
creation.  It is unable to update option sets in place, and thus merely
verifies the set exists via the given name and/or dhcp_options_id param.
.INDENT 7.0
.TP
.B name
(string)
Name of the DHCP options.
.TP
.B vpc_name
(string)
Name of a VPC to which the options should be associated.  Either
vpc_name or vpc_id must be provided.
.TP
.B vpc_id
(string)
Id of a VPC to which the options should be associated.  Either
vpc_name or vpc_id must be provided.
.TP
.B domain_name
(string)
Domain name to be assiciated with this option set.
.TP
.B domain_name_servers
(list of strings)
The IP address(es) of up to four domain name servers.
.TP
.B ntp_servers
(list of strings)
The IP address(es) of up to four desired NTP servers.
.TP
.B netbios_name_servers
(list of strings)
The IP address(es) of up to four NetBIOS name servers.
.TP
.B netbios_node_type
(string)
The NetBIOS node type (1, 2, 4, or 8).  For more information about
the allowed values, see RFC 2132.  The recommended is 2 at this
time (broadcast and multicast are currently not supported).
.TP
.B tags
(dict of key:value pairs)
A set of tags to be added.
.TP
.B region
(string)
Region to connect to.
.TP
.B key
(string)
Secret key to be used.
.TP
.B keyid
(string)
Access key to be used.
.TP
.B profile
(various)
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.internet_gateway_absent(name, detach=False, region=None, key=None, keyid=None, profile=None)
Ensure the named internet gateway is absent.
.INDENT 7.0
.TP
.B name
Name of the internet gateway.
.TP
.B detach
First detach the internet gateway from a VPC, if attached.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.internet_gateway_present(name, vpc_name=None, vpc_id=None, tags=None, region=None, key=None, keyid=None, profile=None)
Ensure an internet gateway exists.
.INDENT 7.0
.TP
.B name
Name of the internet gateway.
.TP
.B vpc_name
Name of the VPC to which the internet gateway should be attached.
.TP
.B vpc_id
Id of the VPC to which the internet_gateway should be attached.
Only one of vpc_name or vpc_id may be provided.
.TP
.B tags
A list of tags.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.nat_gateway_absent(name=None, subnet_name=None, subnet_id=None, region=None, key=None, keyid=None, profile=None, wait_for_delete_retries=0)
Ensure the nat gateway in the named subnet is absent.
.sp
This function requires boto3.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B name
Name of the state.
.TP
.B subnet_name
Name of the subnet within which the nat gateway should exist
.TP
.B subnet_id
Id of the subnet within which the nat gateway should exist.
Either subnet_name or subnet_id must be provided.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.TP
.B wait_for_delete_retries
NAT gateway may take some time to be go into deleted or failed state.
During the deletion process, subsequent release of elastic IPs may fail;
this state will automatically retry this number of times to ensure
the NAT gateway is in deleted or failed state before proceeding.
Default is set to 0 for backward compatibility.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.nat_gateway_present(name, subnet_name=None, subnet_id=None, region=None, key=None, keyid=None, profile=None, allocation_id=None)
Ensure a nat gateway exists within the specified subnet
.sp
This function requires boto3.
.sp
New in version 2016.11.0.

.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
boto_vpc.nat_gateway_present:
  \- subnet_name: my\-subnet
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Name of the state
.TP
.B subnet_name
Name of the subnet within which the nat gateway should exist
.TP
.B subnet_id
Id of the subnet within which the nat gateway should exist.
Either subnet_name or subnet_id must be provided.
.TP
.B allocation_id
If specified, the elastic IP address referenced by the ID is
associated with the gateway. Otherwise, a new allocation_id is created and used.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.present(name, cidr_block, instance_tenancy=None, dns_support=None, dns_hostnames=None, tags=None, region=None, key=None, keyid=None, profile=None)
Ensure VPC exists.
.INDENT 7.0
.TP
.B name
Name of the VPC.
.TP
.B cidr_block
The range of IPs in CIDR format, for example: 10.0.0.0/24. Block
size must be between /16 and /28 netmask.
.TP
.B instance_tenancy
Instances launched in this VPC will be ingle\-tenant or dedicated
hardware.
.TP
.B dns_support
Indicates whether the DNS resolution is supported for the VPC.
.TP
.B dns_hostnames
Indicates whether the instances launched in the VPC get DNS hostnames.
.TP
.B tags
A list of tags.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.request_vpc_peering_connection(name, requester_vpc_id=None, requester_vpc_name=None, peer_vpc_id=None, peer_vpc_name=None, conn_name=None, peer_owner_id=None, peer_region=None, region=None, key=None, keyid=None, profile=None)
.INDENT 7.0
.TP
.B name
Name of the state
.TP
.B requester_vpc_id
ID of the requesting VPC. Exclusive with requester_vpc_name. String type.
.TP
.B requester_vpc_name
Name tag of the requesting VPC.  Exclusive with requester_vpc_id.  String type.
.TP
.B peer_vpc_id
ID of the VPC tp crete VPC peering connection with.  This can be a VPC in another account. Exclusive with peer_vpc_name. String type.
.TP
.B peer_vpc_name
Name tag of the VPC tp crete VPC peering connection with.  This can only be a VPC the same account and region. Exclusive with peer_vpc_id.  String type.
.TP
.B conn_name
The (optional) name to use for this VPC peering connection. String type.
.TP
.B peer_owner_id
ID of the owner of the peer VPC. String type. If this isn\(aqt supplied AWS uses your account ID.  Required if peering to a different account.
.TP
.B peer_region
Region of peer VPC. For inter\-region vpc peering connections. Not required for intra\-region peering connections.
.sp
New in version 3005.

.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.sp
New in version 2016.11.0.

.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
request a vpc peering connection:
  boto_vpc.request_vpc_peering_connection:
    \- requester_vpc_id: vpc\-4b3522e
    \- peer_vpc_id: vpc\-ae83f9ca
    \- conn_name: salt_peering_connection
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.route_table_absent(name, region=None, key=None, keyid=None, profile=None)
Ensure the named route table is absent.
.INDENT 7.0
.TP
.B name
Name of the route table.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.route_table_present(name, vpc_name=None, vpc_id=None, routes=None, subnet_ids=None, subnet_names=None, tags=None, region=None, key=None, keyid=None, profile=None)
Ensure route table with routes exists and is associated to a VPC.
.sp
This function requires boto3 to be installed if nat gatewyas are specified.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
boto_vpc.route_table_present:
  \- name: my_route_table
  \- vpc_id: vpc\-123456
  \- routes:
    \- destination_cidr_block: 0.0.0.0/0
      internet_gateway_name: InternetGateway
    \- destination_cidr_block: 10.10.11.0/24
      instance_id: i\-123456
    \- destination_cidr_block: 10.10.12.0/24
      interface_id: eni\-123456
    \- destination_cidr_block: 10.10.13.0/24
      instance_name: mygatewayserver
  \- subnet_names:
    \- subnet1
    \- subnet2
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Name of the route table.
.TP
.B vpc_name
Name of the VPC with which the route table should be associated.
.TP
.B vpc_id
Id of the VPC with which the route table should be associated.
Either vpc_name or vpc_id must be provided.
.TP
.B routes
A list of routes.  Each route has a cidr and a target.
.TP
.B subnet_ids
A list of subnet ids to associate
.TP
.B subnet_names
A list of subnet names to associate
.TP
.B tags
A list of tags.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.subnet_absent(name=None, subnet_id=None, region=None, key=None, keyid=None, profile=None)
Ensure subnet with passed properties is absent.
.INDENT 7.0
.TP
.B name
Name of the subnet.
.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.subnet_present(name, cidr_block, vpc_name=None, vpc_id=None, availability_zone=None, tags=None, region=None, key=None, keyid=None, profile=None, route_table_id=None, route_table_name=None, auto_assign_public_ipv4=False)
Ensure a subnet exists.
.INDENT 7.0
.TP
.B name
Name of the subnet.
.TP
.B cidr_block
The range if IPs for the subnet, in CIDR format. For example:
10.0.0.0/24. Block size must be between /16 and /28 netmask.
.TP
.B vpc_name
Name of the VPC in which the subnet should be placed. Either
vpc_name or vpc_id must be provided.
.TP
.B vpc_id
Id of the VPC in which the subnet should be placed. Either vpc_name
or vpc_id must be provided.
.TP
.B availability_zone
AZ in which the subnet should be placed.
.TP
.B tags
A list of tags.
.TP
.B route_table_id
A route table ID to explicitly associate the subnet with.  If both route_table_id
and route_table_name are specified, route_table_id will take precedence.
.sp
New in version 2016.11.0.

.TP
.B route_table_name
A route table name to explicitly associate the subnet with.  If both route_table_id
and route_table_name are specified, route_table_id will take precedence.
.sp
New in version 2016.11.0.

.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.vpc_peering_connection_absent(name, conn_id=None, conn_name=None, region=None, key=None, keyid=None, profile=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.boto_vpc.vpc_peering_connection_present(name, requester_vpc_id=None, requester_vpc_name=None, peer_vpc_id=None, peer_vpc_name=None, conn_name=None, peer_owner_id=None, peer_region=None, region=None, key=None, keyid=None, profile=None)
.INDENT 7.0
.TP
.B name
Name of the state
.TP
.B requester_vpc_id
ID of the requesting VPC. Exclusive with requester_vpc_name.
.TP
.B requester_vpc_name
Name tag of the requesting VPC.  Exclusive with requester_vpc_id.
.TP
.B peer_vpc_id
ID of the VPC tp crete VPC peering connection with. This can be a VPC in
another account. Exclusive with peer_vpc_name.
.TP
.B peer_vpc_name
Name tag of the VPC tp crete VPC peering connection with. This can only
be a VPC in the same account, else resolving it into a vpc ID will fail.
Exclusive with peer_vpc_id.
.TP
.B conn_name
The name to use for this VPC peering connection.
.TP
.B peer_owner_id
ID of the owner of the peer VPC. Defaults to your account ID, so a value
is required if peering with a VPC in a different account.
.TP
.B peer_region
Region of peer VPC. For inter\-region vpc peering connections. Not required
for intra\-region peering connections.
.sp
New in version 3005.

.TP
.B region
Region to connect to.
.TP
.B key
Secret key to be used.
.TP
.B keyid
Access key to be used.
.TP
.B profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
.UNINDENT
.sp
New in version 2016.11.0.

.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ensure peering twixt local vpc and the other guys:
  boto_vpc.vpc_peering_connection_present:
    \- requester_vpc_name: my_local_vpc
    \- peer_vpc_name: some_other_guys_vpc
    \- conn_name: peering_from_here_to_there
    \- peer_owner_id: 012345654321
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.bower
.SS Installation of Bower Packages
.sp
These states manage the installed packages using Bower.
Note that npm, git and bower must be installed for these states to be
available, so bower states should include requisites to pkg.installed states
for the packages which provide npm and git (simply \fBnpm\fP and \fBgit\fP in most
cases), and npm.installed state for the package which provides bower.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
npm:
  pkg.installed
git:
  pkg.installed
bower:
  npm.installed
  require:
    \- pkg: npm
    \- pkg: git

underscore:
  bower.installed:
    \- dir: /path/to/project
    \- require:
      \- npm: bower
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bower.bootstrap(name, user=None)
Bootstraps a frontend distribution.
.sp
Will execute \(aqbower install\(aq on the specified directory.
.INDENT 7.0
.TP
.B user
The user to run Bower with
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bower.installed(name, dir, pkgs=None, user=None, env=None)
Verify that the given package is installed and is at the correct version
(if specified).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
underscore:
  bower.installed:
    \- dir: /path/to/project
    \- user: someuser

jquery#2.0:
  bower.installed:
    \- dir: /path/to/project
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The package to install
.TP
.B dir
The target directory in which to install the package
.TP
.B pkgs
A list of packages to install with a single Bower invocation;
specifying this argument will ignore the \fBname\fP argument
.TP
.B user
The user to run Bower with
.TP
.B env
A list of environment variables to be set prior to execution. The
format is the same as the \fI\%cmd.run\fP\&.
state function.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bower.pruned(name, user=None, env=None)
New in version 2017.7.0.

.sp
Cleans up local bower_components directory.
.sp
Will execute \(aqbower prune\(aq on the specified directory (param: name)
.INDENT 7.0
.TP
.B user
The user to run Bower with
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.bower.removed(name, dir, user=None)
Verify that the given package is not installed.
.INDENT 7.0
.TP
.B dir
The target directory in which to install the package
.TP
.B user
The user to run Bower with
.UNINDENT
.UNINDENT
.SS salt.states.btrfs
.sp
Manage BTRFS file systems.
.INDENT 0.0
.TP
.B maintainer
Alberto Planas <\fI\%aplanas@suse.com\fP>
.TP
.B maturity
new
.TP
.B depends
None
.TP
.B platform
Linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.btrfs.properties(name, device, use_default=False, __dest=None, **properties)
Makes sure that a list of properties are set in a subvolume, file
or device.
.INDENT 7.0
.TP
.B name
Name of the object to change
.TP
.B device
Device where the object lives, if None, the device will be in
name
.TP
.B use_default
If True, this subvolume will be resolved to the default
subvolume assigned during the create operation
.TP
.B properties
Dictionary of properties
.UNINDENT
.sp
Valid properties are \(aqro\(aq, \(aqlabel\(aq or \(aqcompression\(aq. Check the
documentation to see where those properties are valid for each
object.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.btrfs.subvolume_created(name, device, qgroupids=None, set_default=False, copy_on_write=True, force_set_default=True, __dest=None)
Makes sure that a btrfs subvolume is present.
.INDENT 7.0
.TP
.B name
Name of the subvolume to add
.TP
.B device
Device where to create the subvolume
.TP
.B qgroupids
Add the newly created subcolume to a qgroup. This parameter
is a list
.TP
.B set_default
If True, this new subvolume will be set as default when
mounted, unless subvol option in mount is used
.TP
.B copy_on_write
If false, set the subvolume with chattr +C
.TP
.B force_set_default
If false and the subvolume is already present, it will not
force it as default if \fBset_default\fP is True
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.btrfs.subvolume_deleted(name, device, commit=False, __dest=None)
Makes sure that a btrfs subvolume is removed.
.INDENT 7.0
.TP
.B name
Name of the subvolume to remove
.TP
.B device
Device where to remove the subvolume
.TP
.B commit
Wait until the transaction is over
.UNINDENT
.UNINDENT
.SS salt.states.cabal
.SS Installation of Cabal Packages
.sp
New in version 2015.8.0.

.sp
These states manage the installed packages for Haskell using
cabal. Note that cabal\-install must be installed for these states to
be available, so cabal states should include a requisite to a
pkg.installed state for the package which provides cabal
(\fBcabal\-install\fP in case of Debian based distributions). Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\&.. code\-block:: yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B cabal\-install:
pkg.installed
.TP
.B ShellCheck:
.INDENT 7.0
.TP
.B cabal.installed:
.INDENT 7.0
.IP \(bu 2
require:
\- pkg: cabal\-install
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cabal.installed(name, pkgs=None, user=None, install_global=False, env=None)
Verify that the given package is installed and is at the correct version
(if specified).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ShellCheck\-0.3.5:
  cabal:
    \- installed:
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The package to install
.TP
.B user
The user to run cabal install with
.TP
.B install_global
Install package globally instead of locally
.TP
.B env
A list of environment variables to be set prior to execution. The
format is the same as the \fI\%cmd.run\fP\&.
state function.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cabal.removed(name, user=None, env=None)
Verify that given package is not installed.
.UNINDENT
.SS salt.states.ceph
.sp
Manage ceph with salt.
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.states.ceph.quorum(name, **kwargs)
Quorum state
.sp
This state checks the mon daemons are in quorum. It does not alter the
cluster but can be used in formula as a dependency for many cluster
operations.
.sp
Example usage in sls file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
quorum:
  sesceph.quorum:
    \- require:
      \- sesceph: mon_running
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.chef
.SS Execute Chef client runs
.sp
Run chef\-client or chef\-solo
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-chef\-run:
  chef.client:
    \- override\-runlist: \(aqdemo1,demo2\(aq
    \- server: \(aqhttps://chef.domain.com\(aq

default\-chef\-run:
  chef.client: []

my\-solo\-run:
  chef.solo:
    \- environment: dev
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.chef.client(name, **kwargs)
.INDENT 7.0
.TP
.B name
Unique identifier for the state. Does not affect the Chef run.
.TP
.B server
The chef server URL
.TP
.B client_key
Set the client key file location
.TP
.B config
The configuration file to use
.TP
.B config\-file\-jail
Directory under which config files are allowed to be loaded
(no client.rb or knife.rb outside this path will be loaded).
.TP
.B environment
Set the Chef Environment on the node
.TP
.B group
Group to set privilege to
.TP
.B json\-attributes
Load attributes from a JSON file or URL
.TP
.B localmode
Point chef\-client at local repository if True
.TP
.B log_level
Set the log level (debug, info, warn, error, fatal)
.TP
.B logfile
Set the log file location
.TP
.B node\-name
The node name for this client
.TP
.B override\-runlist
Replace current run list with specified items for a single run
.TP
.B pid
Set the PID file location, defaults to /tmp/chef\-client.pid
.TP
.B run\-lock\-timeout
Set maximum duration to wait for another client run to finish,
default is indefinitely.
.TP
.B runlist
Permanently replace current run list with specified items
.TP
.B user
User to set privilege to
.TP
.B validation_key
Set the validation key file location, used for registering new clients
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.chef.solo(name, **kwargs)
.INDENT 7.0
.TP
.B name
Unique identifier for the state. Does not affect the Chef run.
.TP
.B config
The configuration file to use
.TP
.B environment
Set the Chef Environment on the node
.TP
.B group
Group to set privilege to
.TP
.B json\-attributes
Load attributes from a JSON file or URL
.TP
.B log_level
Set the log level (debug, info, warn, error, fatal)
.TP
.B logfile
Set the log file location
.TP
.B node\-name
The node name for this client
.TP
.B override\-runlist
Replace current run list with specified items for a single run
.TP
.B recipe\-url
Pull down a remote gzipped tarball of recipes and untar it to
the cookbook cache
.TP
.B run\-lock\-timeout
Set maximum duration to wait for another client run to finish,
default is indefinitely.
.TP
.B user
User to set privilege to
.UNINDENT
.UNINDENT
.SS salt.states.chocolatey
.sp
Manage Windows Packages using Chocolatey
\&.. versionadded:: 2016.3.0
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Chocolatey pulls data from the Chocolatey internet database to determine
current versions, find available versions, etc. This is normally a slow
operation and may be optimized by specifying a local, smaller chocolatey
repo.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.chocolatey.bootstrapped(name, force=False, source=None, version=None)
New in version 3007.1.

.sp
Ensure chocolatey is installed on the system.
.sp
You can\(aqt upgrade an existing installation with this state. You must use
chocolatey to upgrade chocolatey.
.sp
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
choco upgrade chocolatey \-\-version 2.2.0
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the state that installs chocolatey. Required for all
states. This is ignored.
.IP \(bu 2
\fBforce\fP (\fI\%bool\fP) \-\-
.sp
Run the bootstrap process even if Chocolatey is found in the path.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
If chocolatey is already installed this will just re\-run the
install script over the existing version. The \fBversion\fP
parameter is ignored.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\-
.sp
The location of the \fB\&.nupkg\fP file or \fB\&.ps1\fP file to run from an
alternate location. This can be one of the following types of URLs:
.INDENT 2.0
.IP \(bu 2
salt://
.IP \(bu 2
http(s)://
.IP \(bu 2
\fI\%ftp://\fP
.IP \(bu 2
\fI\%file://\fP \- A local file on the system
.UNINDENT

.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\- The version of chocolatey to install. The latest version is
installed if this value is \fBNone\fP\&. Default is \fBNone\fP
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Bootstrap the latest version of chocolatey
bootstrap_chocolatey:
  chocolatey.bootstrapped

# Bootstrap the latest version of chocolatey
# If chocolatey is already present, re\-run the install script
bootstrap_chocolatey:
  chocolatey.bootstrapped:
    \- force: True

# Bootstrap Chocolatey version 1.4.0
bootstrap_chocolatey:
  chocolatey.bootstrapped:
    \- version: 1.4.0

# Bootstrap Chocolatey from a local file
bootstrap_chocolatey:
  chocolatey.bootstrapped:
    \- source: C:\eTemp\echocolatey.nupkg

# Bootstrap Chocolatey from a file on the salt master
bootstrap_chocolatey:
  chocolatey.bootstrapped:
    \- source: salt://Temp/chocolatey.nupkg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.chocolatey.installed(name, version=None, source=None, force=False, pre_versions=False, install_args=None, override_args=False, force_x86=False, package_args=None, allow_multiple=False, execution_timeout=None)
Installs a package if not already installed
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to be installed. Required.
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\- Install a specific version of the package. Defaults to the latest
version. If the version is different to the one installed, then the
specified version will be installed. Default is \fBNone\fP\&.
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- Chocolatey repository (directory, share or remote URL, feed).
\fBNone\fP defaults to the official Chocolatey feed. Default is
\fBNone\fP\&.
.IP \(bu 2
\fBforce\fP (\fI\%bool\fP) \-\- Reinstall the current version of an existing package. Do not use
with \fBallow_multiple\fP\&. Default is \fBFalse\fP\&.
.IP \(bu 2
\fBpre_versions\fP (\fI\%bool\fP) \-\- Include pre\-release packages. Default is \fBFalse\fP\&.
.IP \(bu 2
\fBinstall_args\fP (\fI\%str\fP) \-\- Install arguments you want to pass to the installation process, i.e.
product key or feature list. Default is \fBNone\fP\&.
.IP \(bu 2
\fBoverride_args\fP (\fI\%bool\fP) \-\- Set to \fBTrue\fP to override the original install arguments (for the
native installer) in the package and use your own. When this is set
to \fBFalse\fP, install_args will be appended to the end of the
default arguments. Default is \fBFalse\fP\&.
.IP \(bu 2
\fBforce_x86\fP (\fI\%bool\fP) \-\- Force x86 (32bit) installation on 64bit systems. Default is
\fBFalse\fP\&.
.IP \(bu 2
\fBpackage_args\fP (\fI\%str\fP) \-\- Arguments you want to pass to the package. Default is \fBNone\fP\&.
.IP \(bu 2
\fBallow_multiple\fP (\fI\%bool\fP) \-\-
.sp
Allow multiple versions of the package to be installed. Do not use
with \fBforce\fP\&. Does not work with all packages. Default is
\fBFalse\fP\&.
.sp
New in version 2017.7.0.


.IP \(bu 2
\fBexecution_timeout\fP (\fI\%str\fP) \-\- Chocolatey execution timeout value you want to pass to the
installation process. Default is \fBNone\fP\&.
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
install_some_package:
  chocolatey.installed:
    \- name: packagename
    \- version: \(aq12.04\(aq
    \- source: \(aqmychocolatey/source\(aq
    \- force: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.chocolatey.source_present(name, source_location, username=None, password=None, force=False, priority=None)
Adds a Chocolatey source if not already present.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the source to be added as a chocolatey repository.
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- Location of the source you want to work with.
.IP \(bu 2
\fBusername\fP (\fI\%str\fP) \-\- The username for a chocolatey source that needs authentication
credentials.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- The password for a chocolatey source that needx authentication
credentials.
.IP \(bu 2
\fBforce\fP (\fI\%bool\fP) \-\- Salt will not modify an existing repository with the same name. Set
this option to \fBTrue\fP to update an existing repository.
.IP \(bu 2
\fBpriority\fP (\fI\%int\fP) \-\- The priority order of this source as compared to other sources.
Lower is better. Defaults to 0 (no priority). All priorities
above 0 will be evaluated first, then zero\-based values will be
evaluated in config file order.
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
add_some_source:
  chocolatey.source_present:
    \- name: reponame
    \- source: https://repo.exemple.com
    \- username: myuser
    \- password: mypassword
    \- priority: 100
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.chocolatey.unbootstrapped(name)
New in version 3007.1.

.sp
Ensure chocolatey is removed from the system.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the state that uninstalls chocolatey. Required for all
states. This is ignored.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Uninstall chocolatey
uninstall_chocolatey:
  chocolatey.unbootstrapped
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.chocolatey.uninstalled(name, version=None, uninstall_args=None, override_args=False)
Uninstalls a chocolatey package
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to be uninstalled. Required.
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\- Uninstalls a specific version of the package. Defaults to the latest
version installed.
.IP \(bu 2
\fBuninstall_args\fP (\fI\%str\fP) \-\- A list of uninstall arguments you want to pass to the uninstallation
process, i.e. product key or feature list
.IP \(bu 2
\fBoverride_args\fP (\fI\%str\fP) \-\- Set to \fBTrue\fP if you want to override the original uninstall
arguments (for the native uninstaller) in the package and use your
own. When this is set to \fBFalse\fP, uninstall_args will be appended
to the end of the default arguments
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
remove_my_package:
  chocolatey.uninstalled:
    \- name: mypackage
    \- version: \(aq21.5\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.chocolatey.upgraded(name, version=None, source=None, force=False, pre_versions=False, install_args=None, override_args=False, force_x86=False, package_args=None)
Upgrades a chocolatey package. Will install the package if not installed.
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to be installed. Required.
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\- Install a specific version of the package. Defaults to latest
version. If the version is greater than the one installed then the
specified version will be installed. Default is \fBNone\fP\&.
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- Chocolatey repository (directory, share or remote URL, feed).
Defaults to the official Chocolatey feed. Default is \fBNone\fP\&.
.IP \(bu 2
\fBforce\fP (\fI\%bool\fP) \-\- \fBTrue\fP will reinstall an existing package with the same version.
Default is \fBFalse\fP\&.
.IP \(bu 2
\fBpre_versions\fP (\fI\%bool\fP) \-\- \fBTrue\fP will include pre\-release packages. Default is \fBFalse\fP\&.
.IP \(bu 2
\fBinstall_args\fP (\fI\%str\fP) \-\- Install arguments you want to pass to the installation process, i.e
product key or feature list. Default is \fBNone\fP\&.
.IP \(bu 2
\fBoverride_args\fP (\fI\%bool\fP) \-\- \fBTrue\fP will override the original install arguments (for the
native installer) in the package and use those specified in
\fBinstall_args\fP\&. \fBFalse\fP will append install_args to the end of
the default arguments. Default is \fBFalse\fP\&.
.IP \(bu 2
\fBforce_x86\fP (\fI\%bool\fP) \-\- \fBTrue\fP forces 32bit installation on 64bit systems. Default is
\fBFalse\fP\&.
.IP \(bu 2
\fBpackage_args\fP (\fI\%str\fP) \-\- Arguments you want to pass to the package. Default is \fBNone\fP\&.
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
upgrade_some_package:
  chocolatey.upgraded:
    \- name: packagename
    \- version: \(aq12.04\(aq
    \- source: \(aqmychocolatey/source\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.chronos_job
.sp
Configure Chronos jobs via a salt proxy.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_job:
  chronos_job.config:
    \- config:
        schedule: \(dqR//PT2S\(dq
        command: \(dqecho \(aqhi\(aq\(dq
        owner: \(dqme@example.com\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.2.

.INDENT 0.0
.TP
.B salt.states.chronos_job.absent(name)
Ensure that the chronos job with the given name is not present.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- The app name
.TP
.B Returns
A standard Salt changes dictionary
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.chronos_job.config(name, config)
Ensure that the chronos job with the given name is present and is configured
to match the given config values.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The job name
.IP \(bu 2
\fBconfig\fP \-\- The configuration to apply (dict)
.UNINDENT
.TP
.B Returns
A standard Salt changes dictionary
.UNINDENT
.UNINDENT
.SS salt.states.cimc
.sp
A state module to manage Cisco UCS chassis devices.
.INDENT 0.0
.TP
.B codeauthor
\fBSpencer Ervin <spencer_ervin@hotmail.com>\fP
.TP
.B maturity
new
.TP
.B depends
none
.TP
.B platform
unix
.UNINDENT
.SS About
.sp
This state module was designed to handle connections to a Cisco Unified Computing System (UCS) chassis. This module
relies on the CIMC proxy module to interface with the device.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%CIMC Proxy Module\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cimc.hostname(name, hostname=None)
Ensures that the hostname is set to the specified value.
.sp
New in version 2019.2.0.

.sp
name: The name of the module function to execute.
.sp
hostname(str): The hostname of the server.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
set_name:
  cimc.hostname:
    \- hostname: foobar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cimc.logging_levels(name, remote=None, local=None)
Ensures that the logging levels are set on the device. The logging levels
must match the following options: emergency, alert, critical, error, warning,
notice, informational, debug.
.sp
New in version 2019.2.0.

.sp
name: The name of the module function to execute.
.sp
remote(str): The logging level for SYSLOG logs.
.sp
local(str): The logging level for the local device.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
logging_levels:
  cimc.logging_levels:
    \- remote: informational
    \- local: notice
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cimc.ntp(name, servers)
Ensures that the NTP servers are configured. Servers are provided as an individual string or list format. Only four
NTP servers will be reviewed. Any entries past four will be ignored.
.sp
name: The name of the module function to execute.
.sp
servers(str, list): The IP address or FQDN of the NTP servers.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ntp_configuration_list:
  cimc.ntp:
    \- servers:
      \- foo.bar.com
      \- 10.10.10.10

ntp_configuration_str:
  cimc.ntp:
    \- servers: foo.bar.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cimc.power_configuration(name, policy=None, delayType=None, delayValue=None)
Ensures that the power configuration is configured on the system. This is
only available on some C\-Series servers.
.sp
New in version 2019.2.0.

.sp
name: The name of the module function to execute.
.sp
policy(str): The action to be taken when chassis power is restored after
an unexpected power loss. This can be one of the following:
.INDENT 7.0
.INDENT 3.5
reset: The server is allowed to boot up normally when power is
restored. The server can restart immediately or, optionally, after a
fixed or random delay.
.sp
stay\-off: The server remains off until it is manually restarted.
.sp
last\-state: The server restarts and the system attempts to restore
any processes that were running before power was lost.
.UNINDENT
.UNINDENT
.sp
delayType(str): If the selected policy is reset, the restart can be
delayed with this option. This can be one of the following:
.INDENT 7.0
.INDENT 3.5
fixed: The server restarts after a fixed delay.
.sp
random: The server restarts after a random delay.
.UNINDENT
.UNINDENT
.sp
delayValue(int): If a fixed delay is selected, once chassis power is
restored and the Cisco IMC has finished rebooting, the system waits for
the specified number of seconds before restarting the server. Enter an
integer between 0 and 240.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
reset_power:
  cimc.power_configuration:
    \- policy: reset
    \- delayType: fixed
    \- delayValue: 0

power_off:
  cimc.power_configuration:
    \- policy: stay\-off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cimc.syslog(name, primary=None, secondary=None)
Ensures that the syslog servers are set to the specified values. A value of None will be ignored.
.sp
name: The name of the module function to execute.
.sp
primary(str): The IP address or FQDN of the primary syslog server.
.sp
secondary(str): The IP address or FQDN of the secondary syslog server.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
syslog_configuration:
  cimc.syslog:
    \- primary: 10.10.10.10
    \- secondary: foo.bar.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cimc.user(name, id=\(aq\(aq, user=\(aq\(aq, priv=\(aq\(aq, password=\(aq\(aq, status=\(aqactive\(aq)
Ensures that a user is configured on the device. Due to being unable to
verify the user password. This is a forced operation.
.sp
New in version 2019.2.0.

.sp
name: The name of the module function to execute.
.sp
id(int): The user ID slot on the device.
.sp
user(str): The username of the user.
.sp
priv(str): The privilege level of the user.
.sp
password(str): The password of the user.
.sp
status(str): The status of the user. Can be either active or inactive.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
user_configuration:
  cimc.user:
    \- id: 11
    \- user: foo
    \- priv: admin
    \- password: mypassword
    \- status: active
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.cisconso
.sp
State module for Cisco NSO Proxy minions
.sp
New in version 2016.11.0.

.sp
For documentation on setting up the cisconso proxy minion look in the documentation
for \fI\%salt.proxy.cisconso\fP\&.
.INDENT 0.0
.TP
.B salt.states.cisconso.value_present(name, datastore, path, config)
Ensure a specific value exists at a given path
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- The name for this rule
.IP \(bu 2
\fBdatastore\fP (\fBDatastoreType\fP (\fBstr\fP enum).) \-\- The datastore, e.g. running, operational.
One of the NETCONF store IETF types
.IP \(bu 2
\fBpath\fP (\fBlist\fP, \fBstr\fP OR \fBtuple\fP) \-\- The device path to set the value at,
a list of element names in order, / separated
.IP \(bu 2
\fBconfig\fP (\fBdict\fP) \-\- The new value at the given path
.UNINDENT
.UNINDENT
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
enable pap auth:
  cisconso.config_present:
    \- name: enable_pap_auth
    \- datastore: running
    \- path: devices/device/ex0/config/sys/interfaces/serial/ppp0/authentication
    \- config:
        authentication:
            method: pap
            \(dqlist\-name\(dq: foobar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.cloud
.SS Using states instead of maps to deploy clouds
.sp
New in version 2014.1.0.

.sp
Use this minion to spin up a cloud instance:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-instance:
  cloud.profile:
    my\-ec2\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cloud.absent(name, onlyif=None, unless=None)
Ensure that no instances with the specified names exist.
.sp
CAUTION: This is a destructive state, which will search all
configured cloud providers for the named instance,
and destroy it.
.INDENT 7.0
.TP
.B name
The name of the instance to destroy
.TP
.B onlyif
Do run the state only if is unless succeed
.TP
.B unless
Do not run the state at least unless succeed
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cloud.present(name, cloud_provider, onlyif=None, unless=None, opts=None, **kwargs)
Spin up a single instance on a cloud provider, using salt\-cloud. This state
does not take a profile argument; rather, it takes the arguments that would
normally be configured as part of the state.
.sp
Note that while this function does take any configuration argument that
would normally be used to create an instance, it will not verify the state
of any of those arguments on an existing instance. Stateful properties of
an instance should be configured using their own individual state (i.e.,
cloud.tagged, cloud.untagged, etc).
.INDENT 7.0
.TP
.B name
The name of the instance to create
.TP
.B cloud_provider
The name of the cloud provider to use
.TP
.B onlyif
Do run the state only if is unless succeed
.TP
.B unless
Do not run the state at least unless succeed
.TP
.B opts
Any extra opts that need to be used
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cloud.profile(name, profile, onlyif=None, unless=None, opts=None, **kwargs)
Create a single instance on a cloud provider, using a salt\-cloud profile.
.sp
Note that while profiles used this function do take any configuration
argument that would normally be used to create an instance using a profile,
this state will not verify the state of any of those arguments on an
existing instance. Stateful properties of an instance should be configured
using their own individual state (i.e., cloud.tagged, cloud.untagged, etc).
.INDENT 7.0
.TP
.B name
The name of the instance to create
.TP
.B profile
The name of the cloud profile to use
.TP
.B onlyif
Do run the state only if is unless succeed
.TP
.B unless
Do not run the state at least unless succeed
.TP
.B kwargs
Any profile override or addition
.TP
.B opts
Any extra opts that need to be used
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cloud.volume_absent(name, provider=None, **kwargs)
Check that a block volume exists.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cloud.volume_attached(name, server_name, provider=None, **kwargs)
Check if a block volume is attached.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cloud.volume_detached(name, server_name=None, provider=None, **kwargs)
Check if a block volume is attached.
.sp
Returns True if server or Volume do not exist.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cloud.volume_present(name, provider=None, **kwargs)
Check that a block volume exists.
.UNINDENT
.SS salt.states.cmd
.SS Execution of arbitrary commands
.sp
The cmd state module manages the enforcement of executed commands, this
state can tell a command to run under certain circumstances.
.sp
A simple example to execute a command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Store the current date in a file
\(aqdate > /tmp/salt\-run\(aq:
  cmd.run
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Only run if another execution failed, in this case truncate syslog if there is
no disk space:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(aq> /var/log/messages/\(aq:
  cmd.run:
    \- unless: echo \(aqfoo\(aq > /tmp/.test && rm \-f /tmp/.test
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Only run if the file specified by \fBcreates\fP does not exist, in this case
touch /tmp/foo if it does not exist:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
touch /tmp/foo:
  cmd.run:
    \- creates: /tmp/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBcreates\fP also accepts a list of files, in which case this state will
run if \fBany\fP of the files do not exist:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(dqecho \(aqfoo\(aq | tee /tmp/bar > /tmp/baz\(dq:
  cmd.run:
    \- creates:
      \- /tmp/bar
      \- /tmp/baz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBcreates\fP option was added to the cmd state in version 2014.7.0,
and made a global requisite in 3001.
.UNINDENT
.UNINDENT
.sp
Sometimes when running a command that starts up a daemon, the init script
doesn\(aqt return properly which causes Salt to wait indefinitely for a response.
In situations like this try the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
run_installer:
  cmd.run:
    \- name: /tmp/installer.bin > /dev/null 2>&1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt determines whether the \fBcmd\fP state is successfully enforced based on the exit
code returned by the command. If the command returns a zero exit code, then salt
determines that the state was successfully enforced. If the script returns a non\-zero
exit code, then salt determines that it failed to successfully enforce the state.
If a command returns a non\-zero exit code but you wish to treat this as a success,
then you must place the command in a script and explicitly set the exit code of
the script to zero.
.sp
Please note that the success or failure of the state is not affected by whether a state
change occurred nor the stateful argument.
.sp
When executing a command or script, the state (i.e., changed or not)
of the command is unknown to Salt\(aqs state system. Therefore, by default, the
\fBcmd\fP state assumes that any command execution results in a changed state.
.sp
This means that if a \fBcmd\fP state is watched by another state then the
state that\(aqs watching will always be executed due to the \fIchanged\fP state in
the \fBcmd\fP state.
.SS Using the \(dqStateful\(dq Argument
.sp
Many state functions in this module now also accept a \fBstateful\fP argument.
If \fBstateful\fP is specified to be true then it is assumed that the command
or script will determine its own state and communicate it back by following
a simple protocol described below:
.INDENT 0.0
.IP 1. 3
\fBIf there\(aqs nothing in the stdout of the command, then assume no
changes.\fP Otherwise, the stdout must be either in JSON or its \fIlast\fP
non\-empty line must be a string of key=value pairs delimited by spaces (no
spaces on either side of \fB=\fP).
.IP 2. 3
\fBIf it\(aqs JSON then it must be a JSON object (e.g., {}).\fP If it\(aqs
key=value pairs then quoting may be used to include spaces.  (Python\(aqs shlex
module is used to parse the key=value string)
.sp
Two special keys or attributes are recognized in the output:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
changed: bool (i.e., \(aqyes\(aq, \(aqno\(aq, \(aqtrue\(aq, \(aqfalse\(aq, case\-insensitive)
comment: str  (i.e., any string)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
So, only if \fBchanged\fP is \fBTrue\fP then assume the command execution has
changed the state, and any other key values or attributes in the output will
be set as part of the changes.
.IP 3. 3
\fBIf there\(aqs a comment then it will be used as the comment of the
state.\fP
.sp
Here\(aqs an example of how one might write a shell script for use with a
stateful command:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
#!/bin/bash
#
echo \(dqWorking hard...\(dq

# writing the state line
echo  # an empty line here so the next line will be the last.
echo \(dqchanged=yes comment=\(aqsomething has changed\(aq whatever=123\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And an example SLS file using this module:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
Run myscript:
  cmd.run:
    \- name: /path/to/myscript
    \- cwd: /
    \- stateful: True

Run only if myscript changed something:
  cmd.run:
    \- name: echo hello
    \- cwd: /
    \- onchanges:
        \- cmd: Run myscript
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that if the second \fBcmd.run\fP state also specifies \fBstateful: True\fP it can
then be watched by some other states as well.
.IP 4. 3
\fBThe stateful argument can optionally include a test_name parameter.\fP
.sp
This is used to specify a command to run in test mode.  This command should
return stateful data for changes that would be made by the command in the
name parameter.
.sp
New in version 2015.2.0.

.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
Run myscript:
  cmd.run:
    \- name: /path/to/myscript
    \- cwd: /
    \- stateful:
      \- test_name: /path/to/myscript test

Run masterscript:
  cmd.script:
    \- name: masterscript
    \- source: salt://path/to/masterscript
    \- cwd: /
    \- stateful:
      \- test_name: masterscript test
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Should I use \fI\%cmd.run\fP or \fI\%cmd.wait\fP?
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Use \fI\%cmd.run\fP together with \fI\%onchanges\fP
instead of \fI\%cmd.wait\fP\&.
.UNINDENT
.UNINDENT
.sp
These two states are often confused. The important thing to remember about them
is that \fI\%cmd.run\fP states are run each time the SLS
file that contains them is applied. If it is more desirable to have a command
that only runs after some other state changes, then \fI\%cmd.wait\fP does just that. \fI\%cmd.wait\fP
is designed to \fI\%watch\fP other states, and is
executed when the state it is watching changes. Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/usr/local/bin/postinstall.sh:
  cmd.wait:
    \- watch:
      \- pkg: mycustompkg
  file.managed:
    \- source: salt://utils/scripts/postinstall.sh

mycustompkg:
  pkg.installed:
    \- require:
      \- file: /usr/local/bin/postinstall.sh
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBcmd.wait\fP itself do not do anything; all functionality is inside its \fBmod_watch\fP
function, which is called by \fBwatch\fP on changes.
.sp
The preferred format is using the \fI\%onchanges Requisite\fP, which
works on \fBcmd.run\fP as well as on any other state. The example would then look as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/usr/local/bin/postinstall.sh:
  cmd.run:
    \- onchanges:
      \- pkg: mycustompkg
  file.managed:
    \- source: salt://utils/scripts/postinstall.sh

mycustompkg:
  pkg.installed:
    \- require:
      \- file: /usr/local/bin/postinstall.sh
.ft P
.fi
.UNINDENT
.UNINDENT
.SS How do I create an environment from a pillar map?
.sp
The map that comes from a pillar can be directly consumed by the env option!
To use it, one may pass it like this. Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
printenv:
  cmd.run:
    \- env: {{ salt[\(aqpillar.get\(aq](\(aqexample:key\(aq, {}) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cmd.call(name, func, args=(), kws=None, output_loglevel=\(aqdebug\(aq, hide_output=False, use_vt=False, **kwargs)
Invoke a pre\-defined Python function with arguments specified in the state
declaration. This function is mainly used by the
\fI\%salt.renderers.pydsl\fP renderer.
.sp
In addition, the \fBstateful\fP argument has no effects here.
.sp
The return value of the invoked function will be interpreted as follows.
.sp
If it\(aqs a dictionary then it will be passed through to the state system,
which expects it to have the usual structure returned by any salt state
function.
.sp
Otherwise, the return value (denoted as \fBresult\fP in the code below) is
expected to be a JSON serializable object, and this dictionary is returned:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqname\(aq: name
    \(aqchanges\(aq: {\(aqretval\(aq: result},
    \(aqresult\(aq: True if result is None else bool(result),
    \(aqcomment\(aq: result if isinstance(result, str) else \(aq\(aq
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cmd.mod_watch(name, **kwargs)
Execute a cmd function based on a watch call
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state exists to support special handling of the \fBwatch\fP
\fI\%requisite\fP\&. It should not be called directly.
.sp
Parameters for this function should be set by the state being triggered.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cmd.run(name, cwd=None, root=None, runas=None, shell=None, env=None, prepend_path=None, stateful=False, output_loglevel=\(aqdebug\(aq, hide_output=False, timeout=None, ignore_timeout=False, use_vt=False, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
Run a command if certain circumstances are met.  Use \fBcmd.wait\fP if you
want to use the \fBwatch\fP requisite.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fB**kwargs\fP of \fBcmd.run\fP are passed down to one of the following
exec modules:
.INDENT 0.0
.IP \(bu 2
\fBcmdmod.run_all\fP: If used with default \fBrunas\fP
.IP \(bu 2
\fBcmdmod.run_chroot\fP: If used with non\-\fBroot\fP value for \fBrunas\fP
.UNINDENT
.sp
For more information on what args are available for either of these,
refer to the \fI\%cmdmod documentation\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The command to execute, remember that the command will execute with the
path and permissions of the salt\-minion.
.TP
.B cwd
The current working directory to execute the command in, defaults to
/root
.TP
.B root
Path to the root of the jail to use. If this parameter is set, the command
will run inside a chroot
.TP
.B runas
The user name (or uid) to run the command as
.TP
.B shell
The shell to use for execution, defaults to the shell grain
.TP
.B env
A list of environment variables to be set prior to execution.
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
script\-foo:
  cmd.run:
    \- env:
      \- BATCH: \(aqyes\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The above illustrates a common PyYAML pitfall, that \fByes\fP,
\fBno\fP, \fBon\fP, \fBoff\fP, \fBtrue\fP, and \fBfalse\fP are all loaded as
boolean \fBTrue\fP and \fBFalse\fP values, and must be enclosed in
quotes to be used as strings. More info on this (and other) PyYAML
idiosyncrasies can be found \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
Variables as values are not evaluated. So $PATH in the following
example is a literal \(aq$PATH\(aq:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
script\-bar:
  cmd.run:
    \- env: \(dqPATH=/some/path:$PATH\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
One can still use the existing $PATH by using a bit of Jinja:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set current_path = salt[\(aqenviron.get\(aq](\(aqPATH\(aq, \(aq/bin:/usr/bin\(aq) %}

mycommand:
  cmd.run:
    \- name: ls \-l /
    \- env:
      \- PATH: {{ [current_path, \(aq/my/special/bin\(aq]|join(\(aq:\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using environment variables on Windows, case\-sensitivity
matters, i.e. Windows uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT
.TP
.B prepend_path
$PATH segment to prepend (trailing \(aq:\(aq not necessary) to $PATH. This is
an easier alternative to the Jinja workaround.
.sp
New in version 2018.3.0.

.TP
.B stateful
The command being executed is expected to return data about executing
a state. For more information, see the \fI\%Using the \(dqStateful\(dq Argument\fP section.
.TP
.B output_loglevel
debug
Control the loglevel at which the output from the command is logged to
the minion log.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT
.TP
.B hide_output
False
Suppress stdout and stderr in the state\(aqs results.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is separate from \fBoutput_loglevel\fP, which only handles how
Salt logs to the minion log.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.TP
.B timeout
If the command has not terminated after timeout seconds, send the
subprocess sigterm, and if sigterm is ignored, follow up with sigkill
.TP
.B ignore_timeout
Ignore the timeout of commands, which is useful for running nohup
processes.
.sp
New in version 2015.8.0.

.TP
.B creates
Only run if the file specified by \fBcreates\fP do not exist. If you
specify a list of files then this state will only run if \fBany\fP of
the files do not exist.
.sp
New in version 2014.7.0.

.TP
.B use_vt
False
Use VT utils (saltstack) to stream the command output more
interactively to the console and the logs.
This is experimental.
.TP
.B bg
False
If \fBTrue\fP, run command in background and do not await or deliver its
results.
.sp
New in version 2016.3.6.

.TP
.B success_retcodes
.INDENT 7.0
.INDENT 3.5
This parameter allows you to specify a list of non\-zero return codes
that should be considered as successful. If the return code from the
command matches any in the list, the state will have a \fBTrue\fP result
instead of \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B success_stdout: This parameter will allow a list of
.INDENT 7.0
.INDENT 3.5
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.UNINDENT
.sp
New in version 3004.

.TP
.B success_stderr: This parameter will allow a list of
.INDENT 7.0
.INDENT 3.5
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.UNINDENT
.sp
New in version 3004.

.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
cmd.run supports the usage of \fBreload_modules\fP\&. This functionality
allows you to force Salt to reload all modules. You should only use
\fBreload_modules\fP if your cmd.run does some sort of installation
(such as \fBpip\fP), if you do not reload the modules future items in
your state which rely on the software being installed will fail.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
getpip:
  cmd.run:
    \- name: /usr/bin/python /usr/local/sbin/get\-pip.py
    \- unless: which pip
    \- require:
      \- pkg: python
      \- file: /usr/local/sbin/get\-pip.py
    \- reload_modules: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cmd.script(name, source=None, template=None, cwd=None, runas=None, password=None, shell=None, env=None, stateful=False, timeout=None, use_vt=False, output_loglevel=\(aqdebug\(aq, hide_output=False, defaults=None, context=None, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
Download a script and execute it with specified arguments.
.INDENT 7.0
.TP
.B source
The location of the script to download. If the file is located on the
master in the directory named spam, and is called eggs, the source
string is salt://spam/eggs
.TP
.B template
If this setting is applied then the named templating engine will be
used to render the downloaded file. Currently jinja, mako, and wempy
are supported
.TP
.B name
Either \(dqcmd arg1 arg2 arg3...\(dq (cmd is not used) or a source
\(dqsalt://...\(dq.
.TP
.B cwd
The current working directory to execute the command in, defaults to
/root
.TP
.B runas
Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the \fBpassword\fP argument, and
the target user account must be in the Administrators group.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For Windows users, specifically Server users, it may be necessary
to specify your runas user using the User Logon Name instead of the
legacy logon name. Traditionally, logons would be in the following
format.
.INDENT 0.0
.INDENT 3.5
\fBDomain/user\fP
.UNINDENT
.UNINDENT
.sp
In the event this causes issues when executing scripts, use the UPN
format which looks like the following.
.INDENT 0.0
.INDENT 3.5
\fBuser@domain.local\fP
.UNINDENT
.UNINDENT
.sp
More information <\fI\%https://github.com/saltstack/salt/issues/55080\fP>
.UNINDENT
.UNINDENT
.UNINDENT
.sp
password
.sp
New in version 3000: Windows only. Required when specifying \fBrunas\fP\&. This
parameter will be ignored on non\-Windows platforms.

.INDENT 7.0
.TP
.B shell
The shell to use for execution. The default is set in grains[\(aqshell\(aq]
.TP
.B env
A list of environment variables to be set prior to execution.
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt://scripts/foo.sh:
  cmd.script:
    \- env:
      \- BATCH: \(aqyes\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The above illustrates a common PyYAML pitfall, that \fByes\fP,
\fBno\fP, \fBon\fP, \fBoff\fP, \fBtrue\fP, and \fBfalse\fP are all loaded as
boolean \fBTrue\fP and \fBFalse\fP values, and must be enclosed in
quotes to be used as strings. More info on this (and other) PyYAML
idiosyncrasies can be found \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
Variables as values are not evaluated. So $PATH in the following
example is a literal \(aq$PATH\(aq:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt://scripts/bar.sh:
  cmd.script:
    \- env: \(dqPATH=/some/path:$PATH\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
One can still use the existing $PATH by using a bit of Jinja:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set current_path = salt[\(aqenviron.get\(aq](\(aqPATH\(aq, \(aq/bin:/usr/bin\(aq) %}

mycommand:
  cmd.run:
    \- name: ls \-l /
    \- env:
      \- PATH: {{ [current_path, \(aq/my/special/bin\(aq]|join(\(aq:\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using environment variables on Windows, case\-sensitivity
matters, i.e. Windows uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT
.TP
.B saltenv
\fBbase\fP
The Salt environment to use
.TP
.B stateful
The command being executed is expected to return data about executing
a state. For more information, see the \fI\%Using the \(dqStateful\(dq Argument\fP section.
.TP
.B timeout
If the command has not terminated after timeout seconds, send the
subprocess sigterm, and if sigterm is ignored, follow up with sigkill
.TP
.B args
String of command line args to pass to the script.  Only used if no
args are specified as part of the \fIname\fP argument. To pass a string
containing spaces in YAML, you will need to doubly\-quote it:  \(dqarg1
\(aqarg two\(aq arg3\(dq
.TP
.B creates
Only run if the file specified by \fBcreates\fP do not exist. If you
specify a list of files then this state will only run if \fBany\fP of
the files do not exist.
.sp
New in version 2014.7.0.

.TP
.B use_vt
Use VT utils (saltstack) to stream the command output more
interactively to the console and the logs.
This is experimental.
.TP
.B context
New in version 2016.3.0.

.sp
Overrides default context variables passed to the template.
.TP
.B defaults
New in version 2016.3.0.

.sp
Default context passed to the template.
.TP
.B output_loglevel
debug
Control the loglevel at which the output from the command is logged to
the minion log.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT
.TP
.B hide_output
False
Suppress stdout and stderr in the state\(aqs results.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is separate from \fBoutput_loglevel\fP, which only handles how
Salt logs to the minion log.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.TP
.B success_retcodes
.INDENT 7.0
.INDENT 3.5
This parameter allows you to specify a list of non\-zero return codes
that should be considered as successful. If the return code from the
command matches any in the list, the state will have a \fBTrue\fP result
instead of \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B success_stdout: This parameter will allow a list of
.INDENT 7.0
.INDENT 3.5
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.UNINDENT
.sp
New in version 3004.

.TP
.B success_stderr: This parameter will allow a list of
.INDENT 7.0
.INDENT 3.5
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.UNINDENT
.sp
New in version 3004.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cmd.wait(name, cwd=None, root=None, runas=None, shell=None, env=(), stateful=False, output_loglevel=\(aqdebug\(aq, hide_output=False, use_vt=False, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
Run the given command only if the watch statement calls it.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Use \fI\%cmd.run\fP together with \fBonchanges\fP
instead of \fI\%cmd.wait\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The command to execute, remember that the command will execute with the
path and permissions of the salt\-minion.
.TP
.B cwd
The current working directory to execute the command in, defaults to
/root
.TP
.B root
Path to the root of the jail to use. If this parameter is set, the command
will run inside a chroot
.TP
.B runas
The user name to run the command as
.TP
.B shell
The shell to use for execution, defaults to /bin/sh
.TP
.B env
A list of environment variables to be set prior to execution.
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
script\-foo:
  cmd.wait:
    \- env:
      \- BATCH: \(aqyes\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The above illustrates a common PyYAML pitfall, that \fByes\fP,
\fBno\fP, \fBon\fP, \fBoff\fP, \fBtrue\fP, and \fBfalse\fP are all loaded as
boolean \fBTrue\fP and \fBFalse\fP values, and must be enclosed in
quotes to be used as strings. More info on this (and other) PyYAML
idiosyncrasies can be found \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
Variables as values are not evaluated. So $PATH in the following
example is a literal \(aq$PATH\(aq:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
script\-bar:
  cmd.wait:
    \- env: \(dqPATH=/some/path:$PATH\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
One can still use the existing $PATH by using a bit of Jinja:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set current_path = salt[\(aqenviron.get\(aq](\(aqPATH\(aq, \(aq/bin:/usr/bin\(aq) %}

mycommand:
  cmd.run:
    \- name: ls \-l /
    \- env:
      \- PATH: {{ [current_path, \(aq/my/special/bin\(aq]|join(\(aq:\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using environment variables on Windows, case\-sensitivity
matters, i.e. Windows uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT
.TP
.B stateful
The command being executed is expected to return data about executing
a state. For more information, see the \fI\%Using the \(dqStateful\(dq Argument\fP section.
.TP
.B creates
Only run if the file specified by \fBcreates\fP do not exist. If you
specify a list of files then this state will only run if \fBany\fP of
the files do not exist.
.sp
New in version 2014.7.0.

.TP
.B output_loglevel
debug
Control the loglevel at which the output from the command is logged to
the minion log.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT
.TP
.B hide_output
False
Suppress stdout and stderr in the state\(aqs results.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is separate from \fBoutput_loglevel\fP, which only handles how
Salt logs to the minion log.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.TP
.B use_vt
Use VT utils (saltstack) to stream the command output more
interactively to the console and the logs.
This is experimental.
.TP
.B success_retcodes
.INDENT 7.0
.INDENT 3.5
This parameter allows you to specify a list of non\-zero return codes
that should be considered as successful. If the return code from the
command matches any in the list, the state will have a \fBTrue\fP result
instead of \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B success_stdout: This parameter will allow a list of
.INDENT 7.0
.INDENT 3.5
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.UNINDENT
.sp
New in version 3004.

.TP
.B success_stderr: This parameter will allow a list of
.INDENT 7.0
.INDENT 3.5
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.UNINDENT
.sp
New in version 3004.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cmd.wait_call(name, func, args=(), kws=None, stateful=False, use_vt=False, output_loglevel=\(aqdebug\(aq, hide_output=False, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cmd.wait_script(name, source=None, template=None, cwd=None, runas=None, shell=None, env=None, stateful=False, use_vt=False, output_loglevel=\(aqdebug\(aq, hide_output=False, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
Download a script from a remote source and execute it only if a watch
statement calls it.
.INDENT 7.0
.TP
.B source
The source script being downloaded to the minion, this source script is
hosted on the salt master server.  If the file is located on the master
in the directory named spam, and is called eggs, the source string is
salt://spam/eggs
.TP
.B template
If this setting is applied then the named templating engine will be
used to render the downloaded file, currently jinja, mako, and wempy
are supported
.TP
.B name
The command to execute, remember that the command will execute with the
path and permissions of the salt\-minion.
.TP
.B cwd
The current working directory to execute the command in, defaults to
/root
.TP
.B runas
The user name to run the command as
.TP
.B shell
The shell to use for execution, defaults to the shell grain
.TP
.B env
A list of environment variables to be set prior to execution.
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt://scripts/foo.sh:
  cmd.wait_script:
    \- env:
      \- BATCH: \(aqyes\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The above illustrates a common PyYAML pitfall, that \fByes\fP,
\fBno\fP, \fBon\fP, \fBoff\fP, \fBtrue\fP, and \fBfalse\fP are all loaded as
boolean \fBTrue\fP and \fBFalse\fP values, and must be enclosed in
quotes to be used as strings. More info on this (and other) PyYAML
idiosyncrasies can be found \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
Variables as values are not evaluated. So $PATH in the following
example is a literal \(aq$PATH\(aq:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt://scripts/bar.sh:
  cmd.wait_script:
    \- env: \(dqPATH=/some/path:$PATH\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
One can still use the existing $PATH by using a bit of Jinja:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set current_path = salt[\(aqenviron.get\(aq](\(aqPATH\(aq, \(aq/bin:/usr/bin\(aq) %}

mycommand:
  cmd.run:
    \- name: ls \-l /
    \- env:
      \- PATH: {{ [current_path, \(aq/my/special/bin\(aq]|join(\(aq:\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using environment variables on Windows, case\-sensitivity
matters, i.e. Windows uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT
.TP
.B stateful
The command being executed is expected to return data about executing
a state. For more information, see the \fI\%Using the \(dqStateful\(dq Argument\fP section.
.TP
.B use_vt
Use VT utils (saltstack) to stream the command output more
interactively to the console and the logs.
This is experimental.
.TP
.B output_loglevel
debug
Control the loglevel at which the output from the command is logged to
the minion log.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT
.TP
.B hide_output
False
Suppress stdout and stderr in the state\(aqs results.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is separate from \fBoutput_loglevel\fP, which only handles how
Salt logs to the minion log.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.TP
.B success_retcodes
.INDENT 7.0
.INDENT 3.5
This parameter allows you to specify a list of non\-zero return codes
that should be considered as successful. If the return code from the
command matches any in the list, the state will have a \fBTrue\fP result
instead of \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B success_stdout: This parameter will allow a list of
.INDENT 7.0
.INDENT 3.5
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.UNINDENT
.sp
New in version 3004.

.TP
.B success_stderr: This parameter will allow a list of
.INDENT 7.0
.INDENT 3.5
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.UNINDENT
.sp
New in version 3004.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cmd.watch(name, cwd=None, root=None, runas=None, shell=None, env=(), stateful=False, output_loglevel=\(aqdebug\(aq, hide_output=False, use_vt=False, success_retcodes=None, success_stdout=None, success_stderr=None, **kwargs)
This function is an alias of \fBwait\fP\&.
.INDENT 7.0
.INDENT 3.5
Run the given command only if the watch statement calls it.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Use \fI\%cmd.run\fP together with \fBonchanges\fP
instead of \fI\%cmd.wait\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B name
The command to execute, remember that the command will execute with the
path and permissions of the salt\-minion.
.TP
.B cwd
The current working directory to execute the command in, defaults to
/root
.TP
.B root
Path to the root of the jail to use. If this parameter is set, the command
will run inside a chroot
.TP
.B runas
The user name to run the command as
.TP
.B shell
The shell to use for execution, defaults to /bin/sh
.TP
.B env
A list of environment variables to be set prior to execution.
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
script\-foo:
  cmd.wait:
    \- env:
      \- BATCH: \(aqyes\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The above illustrates a common PyYAML pitfall, that \fByes\fP,
\fBno\fP, \fBon\fP, \fBoff\fP, \fBtrue\fP, and \fBfalse\fP are all loaded as
boolean \fBTrue\fP and \fBFalse\fP values, and must be enclosed in
quotes to be used as strings. More info on this (and other) PyYAML
idiosyncrasies can be found \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.sp
Variables as values are not evaluated. So $PATH in the following
example is a literal \(aq$PATH\(aq:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
script\-bar:
  cmd.wait:
    \- env: \(dqPATH=/some/path:$PATH\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
One can still use the existing $PATH by using a bit of Jinja:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set current_path = salt[\(aqenviron.get\(aq](\(aqPATH\(aq, \(aq/bin:/usr/bin\(aq) %}

mycommand:
  cmd.run:
    \- name: ls \-l /
    \- env:
      \- PATH: {{ [current_path, \(aq/my/special/bin\(aq]|join(\(aq:\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using environment variables on Windows, case\-sensitivity
matters, i.e. Windows uses \fIPath\fP as opposed to \fIPATH\fP for other
systems.
.UNINDENT
.UNINDENT
.TP
.B stateful
The command being executed is expected to return data about executing
a state. For more information, see the \fI\%Using the \(dqStateful\(dq Argument\fP section.
.TP
.B creates
Only run if the file specified by \fBcreates\fP do not exist. If you
specify a list of files then this state will only run if \fBany\fP of
the files do not exist.
.sp
New in version 2014.7.0.

.TP
.B output_loglevel
debug
Control the loglevel at which the output from the command is logged to
the minion log.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The command being run will still be logged at the \fBdebug\fP
loglevel regardless, unless \fBquiet\fP is used for this value.
.UNINDENT
.UNINDENT
.TP
.B hide_output
False
Suppress stdout and stderr in the state\(aqs results.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is separate from \fBoutput_loglevel\fP, which only handles how
Salt logs to the minion log.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.TP
.B use_vt
Use VT utils (saltstack) to stream the command output more
interactively to the console and the logs.
This is experimental.
.TP
.B success_retcodes
.INDENT 7.0
.INDENT 3.5
This parameter allows you to specify a list of non\-zero return codes
that should be considered as successful. If the return code from the
command matches any in the list, the state will have a \fBTrue\fP result
instead of \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B success_stdout: This parameter will allow a list of
.INDENT 7.0
.INDENT 3.5
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.UNINDENT
.sp
New in version 3004.

.TP
.B success_stderr: This parameter will allow a list of
.INDENT 7.0
.INDENT 3.5
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.UNINDENT
.UNINDENT
.sp
New in version 3004.

.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.composer
.SS Installation of Composer Packages
.sp
These states manage the installed packages for composer for PHP. Note that
either composer is installed and accessible via a bin directory or you can pass
the location of composer in the state.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
get\-composer:
  cmd.run:
    \- name: \(aqCURL=\(gawhich curl\(ga; $CURL \-sS https://getcomposer.org/installer | php\(aq
    \- unless: test \-f /usr/local/bin/composer
    \- cwd: /root/

install\-composer:
  cmd.wait:
    \- name: mv /root/composer.phar /usr/local/bin/composer
    \- cwd: /root/
    \- watch:
      \- cmd: get\-composer

/path/to/project:
  composer.installed:
    \- no_dev: true
    \- require:
      \- cmd: install\-composer


# Without composer installed in your PATH
# Note: composer.phar must be executable for state to work properly
/path/to/project:
  composer.installed:
    \- composer: /path/to/composer.phar
    \- php: /usr/local/bin/php
    \- no_dev: true
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.composer.installed(name, composer=None, php=None, user=None, prefer_source=None, prefer_dist=None, no_scripts=None, no_plugins=None, optimize=None, no_dev=None, quiet=False, composer_home=\(aq/root\(aq, always_check=True, env=None)
Verify that the correct versions of composer dependencies are present.
.INDENT 7.0
.TP
.B name
Directory location of the \fBcomposer.json\fP file.
.TP
.B composer
Location of the \fBcomposer.phar\fP file. If not set composer will
just execute \fBcomposer\fP as if it is installed globally.
(i.e. \fB/path/to/composer.phar\fP)
.TP
.B php
Location of the php executable to use with composer.
(i.e. \fB/usr/bin/php\fP)
.TP
.B user
Which system user to run composer as.
.sp
New in version 2014.1.4.

.TP
.B prefer_source
\fB\-\-prefer\-source\fP option of composer.
.TP
.B prefer_dist
\fB\-\-prefer\-dist\fP option of composer.
.TP
.B no_scripts
\fB\-\-no\-scripts\fP option of composer.
.TP
.B no_plugins
\fB\-\-no\-plugins\fP option of composer.
.TP
.B optimize
\fB\-\-optimize\-autoloader\fP option of composer. Recommended for production.
.TP
.B no_dev
\fB\-\-no\-dev\fP option for composer. Recommended for production.
.TP
.B quiet
\fB\-\-quiet\fP option for composer. Whether or not to return output from composer.
.TP
.B composer_home
\fB$COMPOSER_HOME\fP environment variable
.TP
.B always_check
If \fBTrue\fP, \fIalways\fP run \fBcomposer install\fP in the directory.  This is the
default behavior.  If \fBFalse\fP, only run \fBcomposer install\fP if there is no
vendor directory present.
.TP
.B env
A list of environment variables to be set prior to execution.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.composer.update(name, composer=None, php=None, user=None, prefer_source=None, prefer_dist=None, no_scripts=None, no_plugins=None, optimize=None, no_dev=None, quiet=False, composer_home=\(aq/root\(aq, env=None)
Composer update the directory to ensure we have the latest versions
of all project dependencies.
.INDENT 7.0
.TP
.B name
Directory location of the \fBcomposer.json\fP file.
.TP
.B composer
Location of the \fBcomposer.phar\fP file. If not set composer will
just execute \fBcomposer\fP as if it is installed globally.
(i.e. /path/to/composer.phar)
.TP
.B php
Location of the php executable to use with composer.
(i.e. \fB/usr/bin/php\fP)
.TP
.B user
Which system user to run composer as.
.sp
New in version 2014.1.4.

.TP
.B prefer_source
\fB\-\-prefer\-source\fP option of composer.
.TP
.B prefer_dist
\fB\-\-prefer\-dist\fP option of composer.
.TP
.B no_scripts
\fB\-\-no\-scripts\fP option of composer.
.TP
.B no_plugins
\fB\-\-no\-plugins\fP option of composer.
.TP
.B optimize
\fB\-\-optimize\-autoloader\fP option of composer. Recommended for production.
.TP
.B no_dev
\fB\-\-no\-dev\fP option for composer. Recommended for production.
.TP
.B quiet
\fB\-\-quiet\fP option for composer. Whether or not to return output from composer.
.TP
.B composer_home
\fB$COMPOSER_HOME\fP environment variable
.TP
.B env
A list of environment variables to be set prior to execution.
.UNINDENT
.UNINDENT
.SS salt.states.consul
.SS Consul Management
.sp
New in version 3005.

.sp
The consul module is used to create and manage Consul ACLs
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
acl_present:
  consul.acl_present:
    \- id: 38AC8470\-4A83\-4140\-8DFD\-F924CD32917F
    \- name: acl_name
    \- rules: node \(dq\(dq {policy = \(dqwrite\(dq} service \(dq\(dq {policy = \(dqread\(dq} key \(dq_rexec\(dq {policy = \(dqwrite\(dq}
    \- type: client
    \- consul_url: http://localhost:8500

acl_delete:
   consul.acl_absent:
     \- id: 38AC8470\-4A83\-4140\-8DFD\-F924CD32917F
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.consul.acl_absent(name, id=None, token=None, consul_url=\(aqhttp://localhost:8500\(aq)
Ensure the ACL is absent
.INDENT 7.0
.TP
.B name
Specifies a human\-friendly name for the ACL token.
.TP
.B id
Specifies the ID of the ACL.
.TP
.B token
token to authenticate you Consul query
.TP
.B consul_url
\fI\%http://locahost:8500\fP
consul URL to query
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For more information \fI\%https://www.consul.io/api/acl.html#delete\-acl\-token\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.consul.acl_present(name, id=None, token=None, type=\(aqclient\(aq, rules=\(aq\(aq, consul_url=\(aqhttp://localhost:8500\(aq)
Ensure the ACL is present
.INDENT 7.0
.TP
.B name
Specifies a human\-friendly name for the ACL token.
.TP
.B id
Specifies the ID of the ACL.
.TP
.B type: client
Specifies the type of ACL token. Valid values are: client and management.
.TP
.B rules
Specifies rules for this ACL token.
.TP
.B consul_url
\fI\%http://locahost:8500\fP
consul URL to query
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For more information \fI\%https://www.consul.io/api/acl.html#create\-acl\-token\fP, \fI\%https://www.consul.io/api/acl.html#update\-acl\-token\fP
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.cron
.SS Management of cron, the Unix command scheduler
.sp
Cron declarations require a number of parameters. The following are the
parameters used by Salt to define the various timing values for a cron job:
.INDENT 0.0
.IP \(bu 2
\fBminute\fP
.IP \(bu 2
\fBhour\fP
.IP \(bu 2
\fBdaymonth\fP
.IP \(bu 2
\fBmonth\fP
.IP \(bu 2
\fBdayweek\fP (0 to 6 are Sunday through Saturday, 7 can also be used for
Sunday)
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Any timing arguments not specified take a value of \fB*\fP\&. This means that
setting \fBhour\fP to \fB5\fP, while not defining the \fBminute\fP param, will
result in Salt adding a job that will execute every minute between 5 and 6
A.M.!
.sp
Additionally, the default user for these states is \fBroot\fP\&. Therefore, if
the cron job is for another user, it is necessary to specify that user with
the \fBuser\fP parameter.
.UNINDENT
.UNINDENT
.sp
A long time ago (before 2014.2), when making changes to an existing cron job,
the name declaration is the parameter used to uniquely identify the job,
so if an existing cron that looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
date > /tmp/crontest:
  cron.present:
    \- user: root
    \- minute: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Is changed to this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
date > /tmp/crontest:
  cron.present:
    \- user: root
    \- minute: 7
    \- hour: 2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then the existing cron will be updated, but if the cron command is changed,
then a new cron job will be added to the user\(aqs crontab.
.sp
The current behavior is still relying on that mechanism, but you can also
specify an identifier to identify your crontabs:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
date > /tmp/crontest:
  cron.present:
    \- identifier: SUPERCRON
    \- user: root
    \- minute: 7
    \- hour: 2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2014.1.2.

.sp
And, some months later, you modify it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
superscript > /tmp/crontest:
  cron.present:
    \- identifier: SUPERCRON
    \- user: root
    \- minute: 3
    \- hour: 4
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2014.1.2.

.sp
The old \fBdate > /tmp/crontest\fP will be replaced by
\fBsuperscript > /tmp/crontest\fP\&.
.sp
Additionally, Salt also supports running a cron every \fBx minutes\fP very similarly to the Unix
convention of using \fB*/5\fP to have a job run every five minutes. In Salt, this
looks like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
date > /tmp/crontest:
  cron.present:
    \- user: root
    \- minute: \(aq*/5\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The job will now run every 5 minutes.
.sp
Additionally, the temporal parameters (minute, hour, etc.) can be randomized by
using \fBrandom\fP instead of using a specific value. For example, by using the
\fBrandom\fP keyword in the \fBminute\fP parameter of a cron state, the same cron
job can be pushed to hundreds or thousands of hosts, and they would each use a
randomly\-generated minute. This can be helpful when the cron job accesses a
network resource, and it is not desirable for all hosts to run the job
concurrently.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/path/to/cron/script:
  cron.present:
    \- user: root
    \- minute: random
    \- hour: 2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 0.16.0.

.sp
Since Salt assumes a value of \fB*\fP for unspecified temporal parameters, adding
a parameter to the state and setting it to \fBrandom\fP will change that value
from \fB*\fP to a randomized numeric value. However, if that field in the cron
entry on the minion already contains a numeric value, then using the \fBrandom\fP
keyword will not modify it.
.sp
Added the opportunity to set a job with a special keyword like \fI\%\(aq@reboot\fP\(aq or
\fI\%\(aq@hourly\fP\(aq. Quotes must be used, otherwise PyYAML will strip the \(aq@\(aq sign.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/path/to/cron/script:
  cron.present:
    \- user: root
    \- special: \(aq@hourly\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The script will be executed every reboot if cron daemon support this option.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/path/to/cron/otherscript:
  cron.absent:
    \- user: root
    \- special: \(aq@daily\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This counter part definition will ensure than a job with a special keyword
is not set.
.INDENT 0.0
.TP
.B salt.states.cron.absent(name, user=\(aqroot\(aq, identifier=False, special=None, **kwargs)
Verifies that the specified cron job is absent for the specified user.
.sp
If an \fBidentifier\fP is not passed then the \fBname\fP is used to identify
the cron job for removal.
.INDENT 7.0
.TP
.B name
The command that should be absent in the user crontab.
.TP
.B user
The name of the user whose crontab needs to be modified, defaults to
the root user
.TP
.B identifier
Custom\-defined identifier for tracking the cron line for future crontab
edits. This defaults to the state name
.TP
.B special
The special keyword used in the job (eg. @reboot, @hourly...).
Quotes must be used, otherwise PyYAML will strip the \(aq@\(aq sign.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cron.env_absent(name, user=\(aqroot\(aq)
Verifies that the specified environment variable is absent from the crontab
for the specified user
.INDENT 7.0
.TP
.B name
The name of the environment variable to remove from the user crontab
.TP
.B user
The name of the user whose crontab needs to be modified, defaults to
the root user
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cron.env_present(name, value=None, user=\(aqroot\(aq)
Verifies that the specified environment variable is present in the crontab
for the specified user.
.INDENT 7.0
.TP
.B name
The name of the environment variable to set in the user crontab
.TP
.B user
The name of the user whose crontab needs to be modified, defaults to
the root user
.TP
.B value
The value to set for the given environment variable
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cron.file(name, source_hash=\(aq\(aq, source_hash_name=None, user=\(aqroot\(aq, template=None, context=None, replace=True, defaults=None, backup=\(aq\(aq, **kwargs)
Provides file.managed\-like functionality (templating, etc.) for a pre\-made
crontab file, to be assigned to a given user.
.INDENT 7.0
.TP
.B name
The source file to be used as the crontab. This source file can be
hosted on either the salt master server, or on an HTTP or FTP server.
For files hosted on the salt file server, if the file is located on
the master in the directory named spam, and is called eggs, the source
string is \fBsalt://spam/eggs\fP
.sp
If the file is hosted on a HTTP or FTP server then the source_hash
argument is also required
.TP
.B source_hash
This can be either a file which contains a source hash string for
the source, or a source hash string. The source hash string is the
hash algorithm followed by the hash of the file:
\fBmd5=e138491e9d5b97023cea823fe17bac22\fP
.TP
.B source_hash_name
When \fBsource_hash\fP refers to a hash file, Salt will try to find the
correct hash by matching the filename/URI associated with that hash. By
default, Salt will look for the filename being managed. When managing a
file at path \fB/tmp/foo.txt\fP, then the following line in a hash file
would match:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
acbd18db4cc2f85cedef654fccc4a4d8    foo.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, sometimes a hash file will include multiple similar paths:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
37b51d194a7513e45b56f6524f2d51f2    ./dir1/foo.txt
acbd18db4cc2f85cedef654fccc4a4d8    ./dir2/foo.txt
73feffa4b7f6bb68e44cf984c85f6e88    ./dir3/foo.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In cases like this, Salt may match the incorrect hash. This argument
can be used to tell Salt which filename to match, to ensure that the
correct hash is identified. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo_crontab:
  cron.file:
    \- name: https://mydomain.tld/dir2/foo.txt
    \- source_hash: https://mydomain.tld/hashes
    \- source_hash_name: ./dir2/foo.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument must contain the full filename entry from the
checksum file, as this argument is meant to disambiguate matches
for multiple files that have the same basename. So, in the
example above, simply using \fBfoo.txt\fP would not match.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.5.

.TP
.B user
The user to whom the crontab should be assigned. This defaults to
root.
.TP
.B template
If this setting is applied then the named templating engine will be
used to render the downloaded file. Currently, jinja and mako are
supported.
.TP
.B context
Overrides default context variables passed to the template.
.TP
.B replace
If the crontab should be replaced, if False then this command will
be ignored if a crontab exists for the specified user. Default is True.
.TP
.B defaults
Default context passed to the template.
.TP
.B backup
Overrides the default backup mode for the user\(aqs crontab.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cron.present(name, user=\(aqroot\(aq, minute=\(aq*\(aq, hour=\(aq*\(aq, daymonth=\(aq*\(aq, month=\(aq*\(aq, dayweek=\(aq*\(aq, comment=None, commented=False, identifier=False, special=None)
Verifies that the specified cron job is present for the specified user.
It is recommended to use \fIidentifier\fP\&. Otherwise the cron job is installed
twice if you change the name.
For more advanced information about what exactly can be set in the cron
timing parameters, check your cron system\(aqs documentation. Most Unix\-like
systems\(aq cron documentation can be found via the crontab man page:
\fBman 5 crontab\fP\&.
.INDENT 7.0
.TP
.B name
The command that should be executed by the cron job.
.TP
.B user
The name of the user whose crontab needs to be modified, defaults to
the root user
.TP
.B minute
The information to be set into the minute section, this can be any
string supported by your cron system\(aqs the minute field. Default is
\fB*\fP
.TP
.B hour
The information to be set in the hour section. Default is \fB*\fP
.TP
.B daymonth
The information to be set in the day of month section. Default is \fB*\fP
.TP
.B month
The information to be set in the month section. Default is \fB*\fP
.TP
.B dayweek
The information to be set in the day of week section. Default is \fB*\fP
.TP
.B comment
User comment to be added on line previous the cron job
.TP
.B commented
The cron job is set commented (prefixed with \fB#DISABLED#\fP).
Defaults to False.
.sp
New in version 2016.3.0.

.TP
.B identifier
Custom\-defined identifier for tracking the cron line for future crontab
edits. This defaults to the state name
.TP
.B special
A special keyword to specify periodicity (eg. @reboot, @hourly...).
Quotes must be used, otherwise PyYAML will strip the \(aq@\(aq sign.
.sp
New in version 2016.3.0.

.UNINDENT
.UNINDENT
.SS salt.states.cryptdev
.SS Opening of Encrypted Devices
.sp
Ensure that an encrypted device is mapped with the \fImapped\fP function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mappedname:
  cryptdev.mapped:
    \- device: /dev/sdb1
    \- keyfile: /etc/keyfile.key
    \- opts:
      \- size=256

swap:
  cryptdev.mapped:
    \- device: /dev/sdx4
    \- keyfile: /dev/urandom
    \- opts: swap,cipher=aes\-cbc\-essiv:sha256,size=256

mappedbyuuid:
  cryptdev.mapped:
    \- device: UUID=066e0200\-2867\-4ebe\-b9e6\-f30026ca2314
    \- keyfile: /etc/keyfile.key
    \- config: /etc/alternate\-crypttab
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B salt.states.cryptdev.mapped(name, device, keyfile=None, opts=None, config=\(aq/etc/crypttab\(aq, persist=True, immediate=False, match_on=\(aqname\(aq)
Verify that a device is mapped
.INDENT 7.0
.TP
.B name
The name under which the device is to be mapped
.TP
.B device
The device name, typically the device node, such as \fB/dev/sdb1\fP
or \fBUUID=066e0200\-2867\-4ebe\-b9e6\-f30026ca2314\fP\&.
.TP
.B keyfile
Either \fBNone\fP if the password is to be entered manually on boot, or
an absolute path to a keyfile. If the password is to be asked
interactively, the mapping cannot be performed with \fBimmediate=True\fP\&.
.TP
.B opts
A list object of options or a comma delimited list
.TP
.B config
Set an alternative location for the crypttab, if the map is persistent,
Default is \fB/etc/crypttab\fP
.TP
.B persist
Set if the map should be saved in the crypttab, Default is \fBTrue\fP
.TP
.B immediate
Set if the device mapping should be executed immediately. Requires that
the keyfile not be \fBNone\fP, because the password cannot be asked
interactively. Note that options are not passed through on the initial
mapping.  Default is \fBFalse\fP\&.
.TP
.B match_on
A name or list of crypttab properties on which this state should be applied.
Default is \fBname\fP, meaning that the line is matched only by the name
parameter. If the desired configuration requires two devices mapped to
the same name, supply a list of parameters to match on.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cryptdev.unmapped(name, config=\(aq/etc/crypttab\(aq, persist=True, immediate=False)
Ensure that a device is unmapped
.INDENT 7.0
.TP
.B name
The name to ensure is not mapped
.TP
.B config
Set an alternative location for the crypttab, if the map is persistent,
Default is \fB/etc/crypttab\fP
.TP
.B persist
Set if the map should be removed from the crypttab. Default is \fBTrue\fP
.TP
.B immediate
Set if the device should be unmapped immediately. Default is \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.SS salt.states.csf
.SS CSF Ip tables management
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
csf utility
.UNINDENT
.TP
.B configuration
See \fI\%http://download.configserver.com/csf/install.txt\fP
for setup instructions.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Simply allow/deny rules:
  csf.rule_present:
    ip: 1.2.3.4
    method: allow
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.csf.nics_skip(name, nics, ipv6)
Alias for \fI\%csf.nics_skipped\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.csf.nics_skipped(name, nics, ipv6=False)
.INDENT 7.0
.TP
.B name
Meaningless arg, but required for state.
.TP
.B nics
A list of nics to skip.
.TP
.B ipv6
Boolean. Set to true if you want to skip
the ipv6 interface. Default false (ipv4).
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.csf.option_present(name, value, reload=False)
Ensure the state of a particular option/setting in csf.
.INDENT 7.0
.TP
.B name
The option name in csf.conf
.TP
.B value
The value it should be set to.
.TP
.B reload
Boolean. If set to true, csf will be reloaded after.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.csf.ports_open(name, ports, proto=\(aqtcp\(aq, direction=\(aqin\(aq)
Ensure ports are open for a protocol, in a direction.
e.g. \- proto=\(aqtcp\(aq, direction=\(aqin\(aq would set the values
for TCP_IN in the csf.conf file.
.INDENT 7.0
.TP
.B ports
A list of ports that should be open.
.TP
.B proto
The protocol. May be one of \(aqtcp\(aq, \(aqudp\(aq,
\(aqtcp6\(aq, or \(aqudp6\(aq.
.TP
.B direction
Choose \(aqin\(aq, \(aqout\(aq, or both to indicate the port
should be opened for inbound traffic, outbound
traffic, or both.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.csf.rule_absent(name, method, port=None, proto=\(aqtcp\(aq, direction=\(aqin\(aq, port_origin=\(aqd\(aq, ip_origin=\(aqs\(aq, ttl=None, reload=False)
Ensure iptable is not present.
.INDENT 7.0
.TP
.B name
The ip address or CIDR for the rule.
.TP
.B method
The type of rule.  Either \(aqallow\(aq or \(aqdeny\(aq.
.TP
.B port
Optional port to be open or closed for the
iptables rule.
.TP
.B proto
The protocol. Either \(aqtcp\(aq, \(aqudp\(aq.
Only applicable if port is specified.
.TP
.B direction
The diretion of traffic to apply the rule to.
Either \(aqin\(aq, or \(aqout\(aq. Only applicable if
port is specified.
.TP
.B port_origin
Specifies either the source or destination
port is relevant for this rule. Only applicable
if port is specified.  Either \(aqs\(aq, or \(aqd\(aq.
.TP
.B ip_origin
Specifies whether the ip in this rule refers to
the source or destination ip. Either \(aqs\(aq, or
\(aqd\(aq. Only applicable if port is specified.
.TP
.B ttl
How long the rule should exist. If supplied,
\fIcsf.tempallow()\fP or csf.tempdeny()\(ga are used.
.TP
.B reload
Reload the csf service after applying this rule.
Default false.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.csf.rule_present(name, method, port=None, proto=\(aqtcp\(aq, direction=\(aqin\(aq, port_origin=\(aqd\(aq, ip_origin=\(aqs\(aq, ttl=None, comment=\(aq\(aq, reload=False)
Ensure iptable rule exists.
.INDENT 7.0
.TP
.B name
The ip address or CIDR for the rule.
.TP
.B method
The type of rule.  Either \(aqallow\(aq or \(aqdeny\(aq.
.TP
.B port
Optional port to be open or closed for the
iptables rule.
.TP
.B proto
The protocol. Either \(aqtcp\(aq, or \(aqudp\(aq.
Only applicable if port is specified.
.TP
.B direction
The diretion of traffic to apply the rule to.
Either \(aqin\(aq, or \(aqout\(aq. Only applicable if
port is specified.
.TP
.B port_origin
Specifies either the source or destination
port is relevant for this rule. Only applicable
if port is specified.  Either \(aqs\(aq, or \(aqd\(aq.
.TP
.B ip_origin
Specifies whether the ip in this rule refers to
the source or destination ip. Either \(aqs\(aq, or
\(aqd\(aq. Only applicable if port is specified.
.TP
.B ttl
How long the rule should exist. If supplied,
\fIcsf.tempallow()\fP or csf.tempdeny()\(ga are used.
.TP
.B comment
An optional comment to appear after the rule
as a #comment .
.TP
.B reload
Reload the csf service after applying this rule.
Default false.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.csf.testing_off(name, reload=False)
Ensure testing mode is enabled in csf.
.INDENT 7.0
.TP
.B reload
Reload CSF after changing the testing status.
Default false.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.csf.testing_on(name, reload=False)
Ensure testing mode is enabled in csf.
.INDENT 7.0
.TP
.B reload
Reload CSF after changing the testing status.
Default false.
.UNINDENT
.UNINDENT
.SS salt.states.cyg
.sp
Installation of Cygwin packages.
.sp
A state module to manage cygwin packages. Packages can be installed
or removed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
dos2unix:
  cyg.installed
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.states.cyg.DictDiffer(current_dict, past_dict)
Calculate the difference between two dictionaries.
.INDENT 7.0
.IP 1. 3
items added
.IP 2. 3
items removed
.IP 3. 3
keys same in both but changed values
.IP 4. 3
keys same in both and unchanged values
.UNINDENT
.INDENT 7.0
.TP
.B added()
Return a set of additions to past_dict.
.UNINDENT
.INDENT 7.0
.TP
.B changed()
Return a set of the keys with changed values.
.UNINDENT
.INDENT 7.0
.TP
.B removed()
Return a set of things removed from past_dict.
.UNINDENT
.INDENT 7.0
.TP
.B same()
True if the two dicts are the same.
.UNINDENT
.INDENT 7.0
.TP
.B unchanged()
Return a set of the keys with unchanged values.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cyg.installed(name, cyg_arch=\(aqx86_64\(aq, mirrors=None)
Make sure that a package is installed.
.INDENT 7.0
.TP
.B name
The name of the package to install
.TP
.B cyg_arch
x86_64
The cygwin architecture to install the package into.
Current options are x86 and x86_64
.TP
.B mirrors
None
List of mirrors to check.
None will use a default mirror (kernel.org)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
rsync:
  cyg.installed:
    \- mirrors:
      \- http://mirror/without/public/key: \(dq\(dq
      \- http://mirror/with/public/key: http://url/of/public/key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cyg.removed(name, cyg_arch=\(aqx86_64\(aq, mirrors=None)
Make sure that a package is not installed.
.INDENT 7.0
.TP
.B name
The name of the package to uninstall
.TP
.B cyg_arch
x86_64
The cygwin architecture to remove the package from.
Current options are x86 and x86_64
.TP
.B mirrors
None
List of mirrors to check.
None will use a default mirror (kernel.org)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
rsync:
  cyg.removed:
    \- mirrors:
      \- http://mirror/without/public/key: \(dq\(dq
      \- http://mirror/with/public/key: http://url/of/public/key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.cyg.updated(name=None, cyg_arch=\(aqx86_64\(aq, mirrors=None)
Make sure all packages are up to date.
.INDENT 7.0
.TP
.B name
None
No affect, salt fails poorly without the arg available
.TP
.B cyg_arch
x86_64
The cygwin architecture to update.
Current options are x86 and x86_64
.TP
.B mirrors
None
List of mirrors to check.
None will use a default mirror (kernel.org)
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
rsync:
  cyg.updated:
    \- mirrors:
      \- http://mirror/without/public/key: \(dq\(dq
      \- http://mirror/with/public/key: http://url/of/public/key
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.ddns
.SS Dynamic DNS updates
.sp
Ensure a DNS record is present or absent utilizing RFC 2136
type dynamic updates.
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
\fI\%dnspython\fP
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBdnspython\fP module is required when managing DDNS using a TSIG key.
If you are not using a TSIG key, DDNS is allowed by ACLs based on IP
address and the \fBdnspython\fP module is not required.
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
webserver:
  ddns.present:
    \- zone: example.com
    \- ttl: 60
    \- data: 111.222.333.444
    \- nameserver: 123.234.345.456
    \- keyfile: /srv/salt/dnspy_tsig_key.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ddns.absent(name, zone, data=None, rdtype=None, **kwargs)
Ensures that the named DNS record is absent.
.INDENT 7.0
.TP
.B name
The host portion of the DNS record, e.g., \(aqwebserver\(aq. Name and zone
are concatenated when the entry is created unless name includes a
trailing dot, so make sure that information is not duplicated in these
two arguments.
.TP
.B zone
The zone to check
.TP
.B data
Data for the DNS record. E.g., the IP address for an A record. If omitted,
all records matching name (and rdtype, if provided) will be purged.
.TP
.B rdtype
DNS resource type. If omitted, all types will be purged.
.TP
.B \fB**kwargs\fP
Additional arguments the ddns.update function may need (e.g.
nameserver, keyfile, keyname).  Note that the nsupdate key file can’t
be reused by this function, the keyfile and other arguments must
follow the \fI\%dnspython\fP spec.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ddns.present(name, zone, ttl, data, rdtype=\(aqA\(aq, **kwargs)
Ensures that the named DNS record is present with the given ttl.
.INDENT 7.0
.TP
.B name
The host portion of the DNS record, e.g., \(aqwebserver\(aq. Name and zone
are concatenated when the entry is created unless name includes a
trailing dot, so make sure that information is not duplicated in these
two arguments.
.TP
.B zone
The zone to check/update
.TP
.B ttl
TTL for the record
.TP
.B data
Data for the DNS record. E.g., the IP address for an A record.
.TP
.B rdtype
DNS resource type. Default \(aqA\(aq.
.TP
.B \fB**kwargs\fP
Additional arguments the ddns.update function may need (e.g.
nameserver, keyfile, keyname).  Note that the nsupdate key file can’t
be reused by this function, the keyfile and other arguments must
follow the \fI\%dnspython\fP spec.
.UNINDENT
.UNINDENT
.SS salt.states.debconfmod
.SS Management of debconf selections
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
debconf\-utils package
.UNINDENT
.UNINDENT
.sp
The debconfmod state module manages the enforcement of debconf selections,
this state can set those selections prior to package installation.
.SS Available Functions
.sp
The debconfmod state has two functions, the \fBset\fP and \fBset_file\fP functions
.INDENT 0.0
.TP
.B set
Set debconf selections from the state itself
.TP
.B set_file
Set debconf selections from a file
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nullmailer\-debconf:
  debconf.set:
    \- name: nullmailer
    \- data:
        \(aqshared/mailname\(aq: {\(aqtype\(aq: \(aqstring\(aq, \(aqvalue\(aq: \(aqserver.domain.tld\(aq}
        \(aqnullmailer/relayhost\(aq: {\(aqtype\(aq: \(aqstring\(aq, \(aqvalue\(aq: \(aqmail.domain.tld\(aq}

ferm\-debconf:
  debconf.set:
    \- name: ferm
    \- data:
        \(aqferm/enable\(aq: {\(aqtype\(aq: \(aqboolean\(aq, \(aqvalue\(aq: True}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Due to how PyYAML imports nested dicts (see \fI\%here\fP),
the values in the \fBdata\fP dict must be indented four spaces instead of two.
.UNINDENT
.UNINDENT
.sp
If you\(aqre setting debconf values that requires \fIdpkg\-reconfigure\fP, you can use
the \fBonchanges\fP requisite to reconfigure your package:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set\-default\-shell:
  debconf.set:
    \- name: dash
    \- data:
        \(aqdash/sh\(aq: {\(aqtype\(aq: \(aqboolean\(aq, \(aqvalue\(aq: false}

reconfigure\-dash:
  cmd.run:
    \- name: dpkg\-reconfigure \-f noninteractive dash
    \- onchanges:
      \- debconf: set\-default\-shell
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Every time the \fBset\-default\-shell\fP state changes, the \fBreconfigure\-dash\fP
state will also run.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For boolean types, the value should be \fBtrue\fP or \fBfalse\fP, not
\fB\(aqtrue\(aq\fP or \fB\(aqfalse\(aq\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.debconfmod.set(name, data, **kwargs)
Set debconf selections
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
<state_id>:
  debconf.set:
    \- name: <name>
    \- data:
        <question>: {\(aqtype\(aq: <type>, \(aqvalue\(aq: <value>}
        <question>: {\(aqtype\(aq: <type>, \(aqvalue\(aq: <value>}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name:
The package name to set answers for.
.TP
.B data:
A set of questions/answers for debconf. Note that everything under
this must be indented twice.
.TP
.B question:
The question the is being pre\-answered
.TP
.B type:
The type of question that is being asked (string, boolean, select, etc.)
.TP
.B value:
The answer to the question
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.debconfmod.set_file(name, source, template=None, context=None, defaults=None, **kwargs)
Set debconf selections from a file or a template
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
<state_id>:
  debconf.set_file:
    \- source: salt://pathto/pkg.selections

<state_id>:
  debconf.set_file:
    \- source: salt://pathto/pkg.selections?saltenv=myenvironment

<state_id>:
  debconf.set_file:
    \- source: salt://pathto/pkg.selections.jinja2
    \- template: jinja
    \- context:
        some_value: \(dqfalse\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B source:
The location of the file containing the package selections
.TP
.B template
If this setting is applied then the named templating engine will be
used to render the package selections file, currently jinja, mako, and
wempy are supported
.TP
.B context
Overrides default context variables passed to the template.
.TP
.B defaults
Default context passed to the template.
.UNINDENT
.UNINDENT
.SS salt.states.dellchassis
.sp
Manage chassis via Salt Proxies.
.sp
New in version 2015.8.2.

.sp
Below is an example state that sets basic parameters:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-dell\-chassis:
  dellchassis.chassis:
    \- chassis_name: my\-dell\-chassis
    \- datacenter: dc\-1\-us
    \- location: my\-location
    \- mode: 2
    \- idrac_launch: 1
    \- slot_names:
      \- server\-1: my\-slot\-name
      \- server\-2: my\-other\-slot\-name
    \- blade_power_states:
      \- server\-1: on
      \- server\-2: off
      \- server\-3: powercycle
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, it is possible to place the entire set of chassis configuration
data in pillar. Here\(aqs an example pillar structure:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  host: 10.27.20.18
  admin_username: root
  fallback_admin_username: root
  passwords:
    \- super\-secret
    \- old\-secret
  proxytype: fx2

  chassis:
    name: fx2\-1
    username: root
    password: saltstack1
    datacenter: london
    location: rack\-1\-shelf\-3
    management_mode: 2
    idrac_launch: 0
    slot_names:
      \- \(aqserver\-1\(aq: blade1
      \- \(aqserver\-2\(aq: blade2

    servers:
      server\-1:
        idrac_password: saltstack1
        ipmi_over_lan: True
        ip: 172.17.17.132
        netmask: 255.255.0.0
        gateway: 172.17.17.1
      server\-2:
        idrac_password: saltstack1
        ipmi_over_lan: True
        ip: 172.17.17.2
        netmask: 255.255.0.0
        gateway: 172.17.17.1
      server\-3:
        idrac_password: saltstack1
        ipmi_over_lan: True
        ip: 172.17.17.20
        netmask: 255.255.0.0
        gateway: 172.17.17.1
      server\-4:
        idrac_password: saltstack1
        ipmi_over_lan: True
        ip: 172.17.17.2
        netmask: 255.255.0.0
        gateway: 172.17.17.1

    switches:
      switch\-1:
        ip: 192.168.1.2
        netmask: 255.255.255.0
        gateway: 192.168.1.1
        snmp: nonpublic
        password: saltstack1
      switch\-2:
        ip: 192.168.1.3
        netmask: 255.255.255.0
        gateway: 192.168.1.1
        snmp: nonpublic
        password: saltstack1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And to go with it, here\(aqs an example state that pulls the data from the
pillar stated above:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set details = pillar.get(\(aqproxy:chassis\(aq, {}) %}
standup\-step1:
  dellchassis.chassis:
    \- name: {{ details[\(aqname\(aq] }}
    \- location: {{ details[\(aqlocation\(aq] }}
    \- mode: {{ details[\(aqmanagement_mode\(aq] }}
    \- idrac_launch: {{ details[\(aqidrac_launch\(aq] }}
    \- slot_names:
      {% for entry details[\(aqslot_names\(aq] %}
        \- {{ next(iter(entry)) }}: {{ entry[next(iter(entry))]  }}
      {% endfor %}

blade_powercycle:
  dellchassis.chassis:
    \- blade_power_states:
      \- server\-1: powercycle
      \- server\-2: powercycle
      \- server\-3: powercycle
      \- server\-4: powercycle

# Set idrac_passwords for blades.  racadm needs them to be called \(aqserver\-x\(aq
{% for k, v in details[\(aqservers\(aq].iteritems() %}
{{ k }}:
  dellchassis.blade_idrac:
    \- idrac_password: {{ v[\(aqidrac_password\(aq] }}
{% endfor %}

# Set management ip addresses, passwords, and snmp strings for switches
{% for k, v in details[\(aqswitches\(aq].iteritems() %}
{{ k }}\-switch\-setup:
  dellchassis.switch:
    \- name: {{ k }}
    \- ip: {{ v[\(aqip\(aq] }}
    \- netmask: {{ v[\(aqnetmask\(aq] }}
    \- gateway: {{ v[\(aqgateway\(aq] }}
    \- password: {{ v[\(aqpassword\(aq] }}
    \- snmp: {{ v[\(aqsnmp\(aq] }}
{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This state module relies on the dracr.py execution module, which runs racadm commands on
the chassis, blades, etc. The racadm command runs very slowly and, depending on your state,
the proxy minion return might timeout before the racadm commands have completed. If you
are repeatedly seeing minions timeout after state calls, please use the \fB\-t\fP CLI argument
to increase the timeout variable.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.sls my\-dell\-chasis\-state\-name \-t 60
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The Dell CMC units perform adequately but many iDRACs are \fBexcruciatingly\fP
slow.  Some functions can take minutes to execute.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.dellchassis.blade_idrac(name, idrac_password=None, idrac_ipmi=None, idrac_ip=None, idrac_netmask=None, idrac_gateway=None, idrac_dnsname=None, idrac_dhcp=None)
Set parameters for iDRAC in a blade.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBidrac_password\fP \-\- Password to use to connect to the iDRACs directly
(idrac_ipmi and idrac_dnsname must be set directly on the iDRAC.  They
can\(aqt be set through the CMC.  If this password is present, use it
instead of the CMC password)
.IP \(bu 2
\fBidrac_ipmi\fP \-\- Enable/Disable IPMI over LAN
.IP \(bu 2
\fBidrac_ip\fP \-\- Set IP address for iDRAC
.IP \(bu 2
\fBidrac_netmask\fP \-\- Set netmask for iDRAC
.IP \(bu 2
\fBidrac_gateway\fP \-\- Set gateway for iDRAC
.IP \(bu 2
\fBidrac_dhcp\fP \-\- Turn on DHCP for iDRAC (True turns on, False does
nothing becaause setting a static IP will disable DHCP).
.UNINDENT
.TP
.B Returns
A standard Salt changes dictionary
.UNINDENT
.sp
NOTE: If any of the IP address settings is configured, all of ip, netmask,
and gateway must be present
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.dellchassis.chassis(name, chassis_name=None, password=None, datacenter=None, location=None, mode=None, idrac_launch=None, slot_names=None, blade_power_states=None)
Manage a Dell Chassis.
.INDENT 7.0
.TP
.B chassis_name
The name of the chassis.
.TP
.B datacenter
The datacenter in which the chassis is located
.TP
.B location
The location of the chassis.
.TP
.B password
Password for the chassis. Note: If this password is set for the chassis,
the current implementation of this state will set this password both on
the chassis and the iDrac passwords on any configured blades. If the
password for the blades should be distinct, they should be set separately
with the blade_idrac function.
.TP
.B mode
The management mode of the chassis. Viable options are:
.INDENT 7.0
.IP \(bu 2
0: None
.IP \(bu 2
1: Monitor
.IP \(bu 2
2: Manage and Monitor
.UNINDENT
.TP
.B idrac_launch
The iDRAC launch method of the chassis. Viable options are:
.INDENT 7.0
.IP \(bu 2
0: Disabled (launch iDRAC using IP address)
.IP \(bu 2
1: Enabled (launch iDRAC using DNS name)
.UNINDENT
.TP
.B slot_names
The names of the slots, provided as a list identified by
their slot numbers.
.TP
.B blade_power_states
The power states of a blade server, provided as a list and
identified by their server numbers. Viable options are:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
on: Ensure the blade server is powered on.
.IP \(bu 2
off: Ensure the blade server is powered off.
.IP \(bu 2
powercycle: Power cycle the blade server.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my\-dell\-chassis:
  dellchassis.chassis:
    \- chassis_name: my\-dell\-chassis
    \- location: my\-location
    \- datacenter: london
    \- mode: 2
    \- idrac_launch: 1
    \- slot_names:
      \- 1: my\-slot\-name
      \- 2: my\-other\-slot\-name
    \- blade_power_states:
      \- server\-1: on
      \- server\-2: off
      \- server\-3: powercycle
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.dellchassis.firmware_update(hosts=None, directory=\(aq\(aq)
.INDENT 7.0
.INDENT 3.5
State to update the firmware on host
using the \fBracadm\fP command
.INDENT 0.0
.TP
.B firmwarefile
filename (string) starting with \fBsalt://\fP
.TP
.B host
string representing the hostname
supplied to the \fBracadm\fP command
.TP
.B directory
Directory name where firmwarefile
will be downloaded
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
dell\-chassis\-firmware\-update:
  dellchassis.firmware_update:
    hosts:
      cmc:
        salt://firmware_cmc.exe
      server\-1:
        salt://firmware.exe
    directory: /opt/firmwares
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.dellchassis.switch(name, ip=None, netmask=None, gateway=None, dhcp=None, password=None, snmp=None)
Manage switches in a Dell Chassis.
.INDENT 7.0
.TP
.B name
The switch designation (e.g. switch\-1, switch\-2)
.TP
.B ip
The Static IP Address of the switch
.TP
.B netmask
The netmask for the static IP
.TP
.B gateway
The gateway for the static IP
.TP
.B dhcp
True: Enable DHCP
False: Do not change DHCP setup
(disabling DHCP is automatic when a static IP is set)
.TP
.B password
The access (root) password for the switch
.TP
.B snmp
The SNMP community string for the switch
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my\-dell\-chassis:
  dellchassis.switch:
    \- switch: switch\-1
    \- ip: 192.168.1.1
    \- netmask: 255.255.255.0
    \- gateway: 192.168.1.254
    \- dhcp: True
    \- password: secret
    \- snmp: public
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.disk
.sp
Disk monitoring state
.sp
Monitor the state of disk resources.
.sp
The \fBdisk.status\fP function can be used to report that the used space of a
filesystem is within the specified limits.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
used_space:
  disk.status:
    \- name: /dev/xda1
    \- maximum: 79%
    \- minimum: 11%
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It can be used with an \fBonfail\fP requisite, for example, to take additional
action in response to or in preparation for other states.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
storage_threshold:
  disk.status:
    \- name: /dev/xda1
    \- maximum: 97%

clear_cache:
  cmd.run:
    \- name: rm \-r /var/cache/app
    \- onfail:
      \- disk: storage_threshold
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use kilobytes (KB) for \fBminimum\fP and \fBmaximum\fP rather than percents,
specify the \fBabsolute\fP flag:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
used_space:
  disk.status:
    \- name: /dev/xda1
    \- minimum: 1024 KB
    \- maximum: 1048576 KB
    \- absolute: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.disk.status(name, maximum=None, minimum=None, absolute=False, free=False)
Return the current disk usage stats for the named mount point
.INDENT 7.0
.TP
.B name
Disk mount or directory for which to check used space
.TP
.B maximum
The maximum disk utilization
.TP
.B minimum
The minimum disk utilization
.TP
.B absolute
By default, the utilization is measured in percentage. Set
the \fIabsolute\fP flag to use kilobytes.
.sp
New in version 2016.11.0.

.TP
.B free
By default, \fIminimum\fP & \fImaximum\fP refer to the amount of used space.
Set to \fITrue\fP to evaluate the free space instead.
.UNINDENT
.UNINDENT
.SS salt.states.docker_container
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%docker Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Management of Docker containers
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B depends
\fI\%docker\fP Python module
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Older releases of the Python bindings for Docker were called \fI\%docker\-py\fP in
PyPI. All releases of \fI\%docker\fP, and releases of \fI\%docker\-py\fP >= 1.6.0 are
supported. These python bindings can easily be installed using
\fI\%pip.install\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pip.install docker
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To upgrade from \fI\%docker\-py\fP to \fI\%docker\fP, you must first uninstall \fI\%docker\-py\fP,
and then install \fI\%docker\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pip.uninstall docker\-py
salt myminion pip.install docker
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
These states were moved from the \fBdocker\fP state
module (formerly called \fBdockerng\fP) in the 2017.7.0 release. When running the
\fI\%docker_container.running\fP
state for the first time after upgrading to 2017.7.0, your container(s) may be
replaced. The changes may show diffs for certain parameters which say that the
old value was an empty string, and the new value is \fBNone\fP\&. This is due to
the fact that in prior releases Salt was passing empty strings for these values
when creating the container if they were undefined in the SLS file, where now
Salt simply does not pass any arguments not explicitly defined in the SLS file.
Subsequent runs of the state should not replace the container if the
configuration remains unchanged.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To pull from a Docker registry, authentication must be configured. See
\fI\%here\fP for more information on how to
configure access to docker registries in \fI\%Pillar\fP data.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.docker_container.absent(name, force=False)
Ensure that a container is absent
.INDENT 7.0
.TP
.B name
Name of the container
.TP
.B force
False
Set to \fBTrue\fP to remove the container even if it is running
.UNINDENT
.sp
Usage Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mycontainer:
  docker_container.absent

multiple_containers:
  docker_container.absent:
    \- names:
      \- foo
      \- bar
      \- baz
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.docker_container.mod_watch(name, sfun=None, **kwargs)
The docker_container watcher, called to invoke the watch command.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state exists to support special handling of the \fBwatch\fP
\fI\%requisite\fP\&. It should not be called directly.
.sp
Parameters for this function should be set by the state being triggered.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.docker_container.run(name, image=None, bg=False, failhard=True, replace=False, force=False, skip_translate=None, ignore_collisions=False, validate_ip_addrs=True, client_timeout=60, **kwargs)
New in version 2018.3.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If no tag is specified in the image name, and nothing matching the
specified image is pulled on the minion, the \fBdocker pull\fP that
retrieves the image will pull \fIall tags\fP for the image. A tag of
\fBlatest\fP is not implicit for the pull. For this reason, it is
recommended to specify the image in \fBrepo:tag\fP notation.
.UNINDENT
.UNINDENT
.sp
Like the \fI\%cmd.run\fP state, only for Docker.
Does the equivalent of a \fBdocker run\fP and returns information about the
container that was created, as well as its output.
.sp
This state accepts the same arguments as \fI\%docker_container.running\fP, with the exception of
\fBwatch_action\fP, \fBstart\fP, and \fBshutdown_timeout\fP (though the \fBforce\fP
argument has a different meaning in this state).
.sp
In addition, this state accepts the arguments from \fI\%docker.logs\fP, with the exception of \fBfollow\fP, to
control how logs are returned.
.sp
Additionally, the following arguments are supported:
.INDENT 7.0
.TP
.B creates
A path or list of paths. Only run if one or more of the specified paths
do not exist on the minion.
.TP
.B bg
False
If \fBTrue\fP, run container in background and do not await or deliver
its results.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This may not be useful in cases where other states depend on the
results of this state. Also, the logs will be inaccessible once the
container exits if \fBauto_remove\fP is set to \fBTrue\fP, so keep this
in mind.
.UNINDENT
.UNINDENT
.TP
.B failhard
True
If \fBTrue\fP, the state will return a \fBFalse\fP result if the exit code
of the container is non\-zero. When this argument is set to \fBFalse\fP,
the state will return a \fBTrue\fP result regardless of the container\(aqs
exit code.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This has no effect if \fBbg\fP is set to \fBTrue\fP\&.
.UNINDENT
.UNINDENT
.TP
.B replace
False
If \fBTrue\fP, and if the named container already exists, this will
remove the existing container. The default behavior is to return a
\fBFalse\fP result when the container already exists.
.TP
.B force
False
If \fBTrue\fP, and the named container already exists, \fIand\fP \fBreplace\fP
is also set to \fBTrue\fP, then the container will be forcibly removed.
Otherwise, the state will not proceed and will return a \fBFalse\fP
result.
.UNINDENT
.sp
CLI Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.run_container myuser/myimage command=/usr/local/bin/myscript.sh
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBUSAGE EXAMPLE\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set pkg_version = salt.pillar.get(\(aqpkg_version\(aq, \(aq1.0\-1\(aq) %}
build_package:
  docker_container.run:
    \- image: myuser/builder:latest
    \- binds: /home/myuser/builds:/build_dir
    \- command: /scripts/build.sh {{ pkg_version }}
    \- creates: /home/myuser/builds/myapp\-{{ pkg_version }}.noarch.rpm
    \- replace: True
    \- networks:
      \- mynet
    \- require:
      \- docker_network: mynet
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.docker_container.running(name, image=None, skip_translate=None, ignore_collisions=False, validate_ip_addrs=True, force=False, watch_action=\(aqforce\(aq, start=True, shutdown_timeout=None, client_timeout=60, networks=None, **kwargs)
Ensure that a container with a specific configuration is present and
running
.INDENT 7.0
.TP
.B name
Name of the container
.TP
.B image
Image to use for the container
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state will pull the image if it is not present. However, if
the image needs to be built from a Dockerfile or loaded from a
saved image, or if you would like to use requisites to trigger a
replacement of the container when the image is updated, then the
\fBdocker_image.present\fP state should be used to
manage the image.
.UNINDENT
.UNINDENT
.sp
Changed in version 2018.3.0: If no tag is specified in the image name, and nothing matching the
specified image is pulled on the minion, the \fBdocker pull\fP that
retrieves the image will pull \fIall tags\fP for the image. A tag of
\fBlatest\fP is no longer implicit for the pull. For this reason, it
is recommended to specify the image in \fBrepo:tag\fP notation.

.UNINDENT
.INDENT 7.0
.TP
.B skip_translate
This function translates Salt CLI or SLS input into the format which
\fI\%docker\-py\fP expects. However, in the event that Salt\(aqs translation logic
fails (due to potential changes in the Docker Remote API, or to bugs in
the translation code), this argument can be used to exert granular
control over which arguments are translated and which are not.
.sp
Pass this argument as a comma\-separated list (or Python list) of
arguments, and translation for each passed argument name will be
skipped. Alternatively, pass \fBTrue\fP and \fIall\fP translation will be
skipped.
.sp
Skipping tranlsation allows for arguments to be formatted directly in
the format which \fI\%docker\-py\fP expects. This allows for API changes and
other issues to be more easily worked around. An example of using this
option to skip translation would be:
.sp
For example, imagine that there is an issue with processing the
\fBport_bindings\fP argument, and the following configuration no longer
works as expected:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mycontainer:
  docker_container.running:
    \- image: 7.3.1611
    \- port_bindings:
      \- 10.2.9.10:8080:80
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By using \fBskip_translate\fP, you can forego the input translation and
configure the port binding in the format \fI\%docker\-py\fP needs:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mycontainer:
  docker_container.running:
    \- image: 7.3.1611
    \- skip_translate: port_bindings
    \- port_bindings: {8080: [(\(aq10.2.9.10\(aq, 80)], \(aq4193/udp\(aq: 9314}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See the following links for more information:
.INDENT 7.0
.IP \(bu 2
\fI\%docker\-py Low\-level API\fP
.IP \(bu 2
\fI\%Docker Engine API\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B ignore_collisions
False
Since many of \fI\%docker\-py\fP\(aqs arguments differ in name from their CLI
counterparts (with which most Docker users are more familiar), Salt
detects usage of these and aliases them to the \fI\%docker\-py\fP version of
that argument so that both CLI and API versions of a given argument are
supported. However, if both the alias and the \fI\%docker\-py\fP version of the
same argument (e.g. \fBenv\fP and \fBenvironment\fP) are used, an error
will be raised. Set this argument to \fBTrue\fP to suppress these errors
and keep the \fI\%docker\-py\fP version of the argument.
.TP
.B validate_ip_addrs
True
For parameters which accept IP addresses as input, IP address
validation will be performed. To disable, set this to \fBFalse\fP
.TP
.B force
False
Set this parameter to \fBTrue\fP to force Salt to re\-create the container
irrespective of whether or not it is configured as desired.
.TP
.B watch_action
force
Control what type of action is taken when this state \fI\%watches\fP another state that has changes. The default action
is \fBforce\fP, which runs the state with \fBforce\fP set to \fBTrue\fP,
triggering a rebuild of the container.
.sp
If any other value is passed, it will be assumed to be a kill signal.
If the container matches the specified configuration, and is running,
then the action will be to send that signal to the container. Kill
signals can be either strings or numbers, and are defined in the
\fBStandard Signals\fP section of the \fBsignal(7)\fP manpage. Run \fBman 7
signal\fP on a Linux host to browse this manpage. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mycontainer:
  docker_container.running:
    \- image: busybox
    \- watch_action: SIGHUP
    \- watch:
      \- file: some_file
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the container differs from the specified configuration, or is
not running, then instead of sending a signal to the container, the
container will be re\-created/started and no signal will be sent.
.UNINDENT
.UNINDENT
.TP
.B start
True
Set to \fBFalse\fP to suppress starting of the container if it exists,
matches the desired configuration, but is not running. This is useful
for data\-only containers, or for non\-daemonized container processes,
such as the Django \fBmigrate\fP and \fBcollectstatic\fP commands. In
instances such as this, the container only needs to be started the
first time.
.TP
.B shutdown_timeout
If the container needs to be replaced, the container will be stopped
using \fI\%docker.stop\fP\&. If a
\fBshutdown_timout\fP is not set, and the container was created using
\fBstop_timeout\fP, that timeout will be used. If neither of these values
were set, then a timeout of 10 seconds will be used.
.sp
Changed in version 2017.7.0: This option was renamed from \fBstop_timeout\fP to
\fBshutdown_timeout\fP to accommodate the \fBstop_timeout\fP container
configuration setting.

.TP
.B client_timeout
60
Timeout in seconds for the Docker client. This is not a timeout for
this function, but for receiving a response from the API.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only used if Salt needs to pull the requested image.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNETWORK MANAGEMENT\fP
.sp
New in version 2018.3.0.

.sp
Changed in version 2019.2.0: If the \fBnetworks\fP option is used, any networks (including the default
\fBbridge\fP network) which are not specified will be disconnected.

.sp
The \fBnetworks\fP argument can be used to ensure that a container is
attached to one or more networks. Optionally, arguments can be passed to
the networks. In the example below, \fBnet1\fP is being configured with
arguments, while \fBnet2\fP and \fBbridge\fP are being configured \fIwithout\fP
arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: myuser/myimage:foo
    \- networks:
      \- net1:
        \- aliases:
          \- bar
          \- baz
        \- ipv4_address: 10.0.20.50
      \- net2
      \- bridge
    \- require:
      \- docker_network: net1
      \- docker_network: net2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The supported arguments are the ones from the docker\-py\(aqs
\fI\%connect_container_to_network\fP function (other than \fBcontainer\fP and
\fBnet_id\fP).
.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
Unlike with the arguments described in the \fBCONTAINER CONFIGURATION
PARAMETERS\fP section below, these network configuration parameters are
not translated at all.  Consult the \fI\%connect_container_to_network\fP
documentation for the correct type/format of data to pass.
.UNINDENT
.UNINDENT
.sp
To start a container with no network connectivity (only possible in
2019.2.0 and later) pass this option as an empty list. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: myuser/myimage:foo
    \- networks: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBCONTAINER CONFIGURATION PARAMETERS\fP
.INDENT 7.0
.TP
.B auto_remove (or \fIrm\fP)
False
Enable auto\-removal of the container on daemon side when the
container’s process exits (analogous to running a docker container with
\fB\-\-rm\fP on the CLI).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- auto_remove: True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B binds
Files/directories to bind mount. Each bind mount should be passed in
one of the following formats:
.INDENT 7.0
.IP \(bu 2
\fB<host_path>:<container_path>\fP \- \fBhost_path\fP is mounted within
the container as \fBcontainer_path\fP with read\-write access.
.IP \(bu 2
\fB<host_path>:<container_path>:<selinux_context>\fP \- \fBhost_path\fP is
mounted within the container as \fBcontainer_path\fP with read\-write
access. Additionally, the specified selinux context will be set
within the container.
.IP \(bu 2
\fB<host_path>:<container_path>:<read_only>\fP \- \fBhost_path\fP is
mounted within the container as \fBcontainer_path\fP, with the
read\-only or read\-write setting explicitly defined.
.IP \(bu 2
\fB<host_path>:<container_path>:<read_only>,<selinux_context>\fP \-
\fBhost_path\fP is mounted within the container as \fBcontainer_path\fP,
with the read\-only or read\-write setting explicitly defined.
Additionally, the specified selinux context will be set within the
container.
.UNINDENT
.sp
\fB<read_only>\fP can be either \fBrw\fP for read\-write access, or \fBro\fP
for read\-only access. When omitted, it is assumed to be read\-write.
.sp
\fB<selinux_context>\fP can be \fBz\fP if the volume is shared between
multiple containers, or \fBZ\fP if the volume should be private.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When both \fB<read_only>\fP and \fB<selinux_context>\fP are specified,
there must be a comma before \fB<selinux_context>\fP\&.
.UNINDENT
.UNINDENT
.sp
Binds can be expressed as a comma\-separated list or a YAML list. The
below two examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- binds: /srv/www:/var/www:ro,/etc/foo.conf:/usr/local/etc/foo.conf:rw
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- binds:
      \- /srv/www:/var/www:ro
      \- /home/myuser/conf/foo.conf:/etc/foo.conf:rw
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, in cases where both ro/rw and an selinux context are combined,
the only option is to use a YAML list, like so:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- binds:
      \- /srv/www:/var/www:ro,Z
      \- /home/myuser/conf/foo.conf:/etc/foo.conf:rw,Z
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Since the second bind in the previous example is mounted read\-write,
the \fBrw\fP and comma can be dropped. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- binds:
      \- /srv/www:/var/www:ro,Z
      \- /home/myuser/conf/foo.conf:/etc/foo.conf:Z
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B blkio_weight
Block IO weight (relative weight), accepts a weight value between 10
and 1000.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- blkio_weight: 100
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B blkio_weight_device
Block IO weight (relative device weight), specified as a list of
expressions in the format \fBPATH:RATE\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- blkio_weight_device: /dev/sda:100
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B cap_add
List of capabilities to add within the container. Can be expressed as a
comma\-separated list or a Python list. The below two examples are
equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- cap_add: SYS_ADMIN,MKNOD
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- cap_add:
      \- SYS_ADMIN
      \- MKNOD
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option requires Docker 1.2.0 or newer.
.UNINDENT
.UNINDENT
.TP
.B cap_drop
List of capabilities to drop within the container. Can be expressed as
a comma\-separated list or a Python list. The below two examples are
equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- cap_drop: SYS_ADMIN,MKNOD
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- cap_drop:
      \- SYS_ADMIN
      \- MKNOD
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option requires Docker 1.2.0 or newer.
.UNINDENT
.UNINDENT
.TP
.B command (or \fIcmd\fP)
Command to run in the container
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- command: bash
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B cpuset_cpus (or \fIcpuset\fP)
CPUs on which which to allow execution, specified as a string
containing a range (e.g. \fB0\-3\fP) or a comma\-separated list of CPUs
(e.g. \fB0,1\fP).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- cpuset_cpus: \(dq0,1\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B cpuset_mems
Memory nodes on which which to allow execution, specified as a string
containing a range (e.g. \fB0\-3\fP) or a comma\-separated list of MEMs
(e.g. \fB0,1\fP). Only effective on NUMA systems.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- cpuset_mems: \(dq0,1\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B cpu_group
The length of a CPU period in microseconds
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- cpu_group: 100000
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B cpu_period
Microseconds of CPU time that the container can get in a CPU period
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- cpu_period: 50000
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B cpu_shares
CPU shares (relative weight), specified as an integer between 2 and 1024.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- cpu_shares: 512
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B detach
False
If \fBTrue\fP, run the container\(aqs command in the background (daemon
mode)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- detach: True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B devices
List of host devices to expose within the container. Can be expressed
as a comma\-separated list or a YAML list. The below two examples are
equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- devices: /dev/net/tun,/dev/xvda1:/dev/xvda1,/dev/xvdb1:/dev/xvdb1:r
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- devices:
      \- /dev/net/tun
      \- /dev/xvda1:/dev/xvda1
      \- /dev/xvdb1:/dev/xvdb1:r
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B device_read_bps
Limit read rate (bytes per second) from a device, specified as a list
of expressions in the format \fBPATH:RATE\fP, where \fBRATE\fP is either an
integer number of bytes, or a string ending in \fBkb\fP, \fBmb\fP, or
\fBgb\fP\&. Can be expressed as a comma\-separated list or a YAML list. The
below two examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- devices_read_bps: /dev/sda:1mb,/dev/sdb:5mb
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- devices_read_bps:
      \- /dev/sda:1mb
      \- /dev/sdb:5mb
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B device_read_iops
Limit read rate (I/O per second) from a device, specified as a list
of expressions in the format \fBPATH:RATE\fP, where \fBRATE\fP is a number
of I/O operations. Can be expressed as a comma\-separated list or a YAML
list. The below two examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- devices_read_iops: /dev/sda:1000,/dev/sdb:500
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- devices_read_iops:
      \- /dev/sda:1000
      \- /dev/sdb:500
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B device_write_bps
Limit write rate (bytes per second) from a device, specified as a list
of expressions in the format \fBPATH:RATE\fP, where \fBRATE\fP is either an
integer number of bytes, or a string ending in \fBkb\fP, \fBmb\fP, or
\fBgb\fP\&. Can be expressed as a comma\-separated list or a YAML list. The
below two examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- devices_write_bps: /dev/sda:1mb,/dev/sdb:5mb
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- devices_write_bps:
      \- /dev/sda:1mb
      \- /dev/sdb:5mb
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B device_write_iops
Limit write rate (I/O per second) from a device, specified as a list
of expressions in the format \fBPATH:RATE\fP, where \fBRATE\fP is a number
of I/O operations. Can be expressed as a comma\-separated list or a
YAML list. The below two examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- devices_write_iops: /dev/sda:1000,/dev/sdb:500
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- devices_write_iops:
      \- /dev/sda:1000
      \- /dev/sdb:500
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B dns
List of DNS nameservers. Can be expressed as a comma\-separated list or
a YAML list. The below two examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- dns: 8.8.8.8,8.8.4.4
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- dns:
      \- 8.8.8.8
      \- 8.8.4.4
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To skip IP address validation, use \fBvalidate_ip_addrs=False\fP
.UNINDENT
.UNINDENT
.TP
.B dns_opt
Additional options to be added to the container’s \fBresolv.conf\fP file.
Can be expressed as a comma\-separated list or a YAML list. The below
two examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- dns_opt: ndots:9
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- dns_opt:
      \- ndots:9
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B dns_search
List of DNS search domains. Can be expressed as a comma\-separated list
or a YAML list. The below two examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- dns_search: foo1.domain.tld,foo2.domain.tld
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- dns_search:
      \- foo1.domain.tld
      \- foo2.domain.tld
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B domainname
The domain name to use for the container
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- dommainname: domain.tld
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B entrypoint
Entrypoint for the container
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- entrypoint: \(dqmycmd \-\-arg1 \-\-arg2\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This argument can also be specified as a list:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- entrypoint:
      \- mycmd
      \- \-\-arg1
      \- \-\-arg2
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B environment
Either a list of variable/value mappings, or a list of strings in the
format \fBVARNAME=value\fP\&. The below three examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- environment:
      \- VAR1: value
      \- VAR2: value
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- environment: \(aqVAR1=value,VAR2=value\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- environment:
      \- VAR1=value
      \- VAR2=value
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B extra_hosts
Additional hosts to add to the container\(aqs /etc/hosts file. Can be
expressed as a comma\-separated list or a Python list. The below two
examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- extra_hosts: web1:10.9.8.7,web2:10.9.8.8
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- extra_hosts:
      \- web1:10.9.8.7
      \- web2:10.9.8.8
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To skip IP address validation, use \fBvalidate_ip_addrs=False\fP
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option requires Docker 1.3.0 or newer.
.UNINDENT
.UNINDENT
.TP
.B group_add
List of additional group names and/or IDs that the container process
will run as. Can be expressed as a comma\-separated list or a YAML list.
The below two examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- group_add: web,network
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- group_add:
      \- web
      \- network
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B hostname
Hostname of the container. If not provided, the value passed as the
container\(aqs\(ga\(ganame\(ga\(ga will be used for the hostname.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- hostname: web1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
\fBhostname\fP cannot be set if \fBnetwork_mode\fP is set to \fBhost\fP\&.
The below example will result in an error:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- hostname: web1
    \- network_mode: host
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B interactive (or \fIstdin_open\fP)
False
Leave stdin open, even if not attached
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- interactive: True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B ipc_mode (or \fIipc\fP)
Set the IPC mode for the container. The default behavior is to create a
private IPC namespace for the container, but this option can be
used to change that behavior:
.INDENT 7.0
.IP \(bu 2
\fBcontainer:<container_name_or_id>\fP reuses another container shared
memory, semaphores and message queues
.IP \(bu 2
\fBhost\fP: use the host\(aqs shared memory, semaphores and message queues
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- ipc_mode: container:foo
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- ipc_mode: host
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Using \fBhost\fP gives the container full access to local shared
memory and is therefore considered insecure.
.UNINDENT
.UNINDENT
.TP
.B isolation
Specifies the type of isolation technology used by containers
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- isolation: hyperv
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The default value on Windows server is \fBprocess\fP, while the
default value on Windows client is \fBhyperv\fP\&. On Linux, only
\fBdefault\fP is supported.
.UNINDENT
.UNINDENT
.TP
.B labels
Add metadata to the container. Labels can be set both with and without
values, and labels with values can be passed either as \fBkey=value\fP or
\fBkey: value\fP pairs. For example, while the below would be very
confusing to read, it is technically valid, and demonstrates the
different ways in which labels can be passed:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- labels:
      \- foo
      \- bar=baz
      \- hello: world
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The labels can also simply be passed as a YAML dictionary, though this
can be error\-prone due to some \fI\%idiosyncrasies\fP with how PyYAML loads nested data structures:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_network.present:
    \- labels:
        foo: \(aq\(aq
        bar: baz
        hello: world
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2018.3.0: Methods for specifying labels can now be mixed. Earlier releases
required either labels with or without values.

.TP
.B links
Link this container to another. Links can be specified as a list of
mappings or a comma\-separated or Python list of expressions in the
format \fB<container_name_or_id>:<link_alias>\fP\&. The below three
examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- links:
      \- web1: link1
      \- web2: link2
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- links: web1:link1,web2:link2
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- links:
      \- web1:link1
      \- web2:link2
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B log_driver and log_opt
Set container\(aqs logging driver and options to configure that driver.
Requires Docker 1.6 or newer.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- log_driver: syslog
    \- log_opt:
      \- syslog\-address: tcp://192.168.0.42
      \- syslog\-facility: daemon
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBlog_opt\fP can also be expressed as a comma\-separated or YAML list
of \fBkey=value\fP pairs. The below two examples are equivalent to the
above one:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- log_driver: syslog
    \- log_opt: \(dqsyslog\-address=tcp://192.168.0.42,syslog\-facility=daemon\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- log_driver: syslog
    \- log_opt:
      \- syslog\-address=tcp://192.168.0.42
      \- syslog\-facility=daemon
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The logging driver feature was improved in Docker 1.13 introducing
option name changes. Please see Docker\(aqs
\fI\%Configure logging drivers\fP documentation for more information.
.UNINDENT
.UNINDENT
.TP
.B lxc_conf
Additional LXC configuration parameters to set before starting the
container. Either a list of variable/value mappings, or a list of
strings in the format \fBVARNAME=value\fP\&. The below three examples are
equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- lxc_conf:
      \- lxc.utsname: docker
      \- lxc.arch: x86_64
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- lxc_conf: lxc.utsname=docker,lxc.arch=x86_64
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- lxc_conf:
      \- lxc.utsname=docker
      \- lxc.arch=x86_64
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
These LXC configuration parameters will only have the desired
effect if the container is using the LXC execution driver, which
has been deprecated for some time.
.UNINDENT
.UNINDENT
.TP
.B mac_address
MAC address to use for the container. If not specified, a random MAC
address will be used.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- mac_address: 01:23:45:67:89:0a
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B mem_limit (or \fImemory\fP)
0
Memory limit. Can be specified in bytes or using single\-letter units
(i.e. \fB512M\fP, \fB2G\fP, etc.). A value of \fB0\fP (the default) means no
memory limit.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- mem_limit: 512M
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B mem_swappiness
Tune a container\(aqs memory swappiness behavior. Accepts an integer
between 0 and 100.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- mem_swappiness: 60
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B memswap_limit (or \fImemory_swap\fP)
\-1
Total memory limit (memory plus swap). Set to \fB\-1\fP to disable swap. A
value of \fB0\fP means no swap limit.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- memswap_limit: 1G
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B network_disabled
False
If \fBTrue\fP, networking will be disabled within the container
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- network_disabled: True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B network_mode
bridge
One of the following:
.INDENT 7.0
.IP \(bu 2
\fBbridge\fP \- Creates a new network stack for the container on the
docker bridge
.IP \(bu 2
\fBnone\fP \- No networking (equivalent of the Docker CLI argument
\fB\-\-net=none\fP). Not to be confused with Python\(aqs \fBNone\fP\&.
.IP \(bu 2
\fBcontainer:<name_or_id>\fP \- Reuses another container\(aqs network stack
.IP \(bu 2
\fBhost\fP \- Use the host\(aqs network stack inside the container
.sp
\fBWARNING:\fP
.INDENT 2.0
.INDENT 3.5
Using \fBhost\fP mode gives the container full access to the
hosts system\(aqs services (such as D\-bus), and is therefore
considered insecure.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- network_mode: \(dqnone\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- network_mode: container:web1
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B oom_kill_disable
Whether to disable OOM killer
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- oom_kill_disable: False
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B oom_score_adj
An integer value containing the score given to the container in order
to tune OOM killer preferences
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- oom_score_adj: 500
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B pid_mode
Set to \fBhost\fP to use the host container\(aqs PID namespace within the
container. Requires Docker 1.5.0 or newer.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- pid_mode: host
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option requires Docker 1.5.0 or newer.
.UNINDENT
.UNINDENT
.TP
.B pids_limit
Set the container\(aqs PID limit. Set to \fB\-1\fP for unlimited.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- pids_limit: 2000
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B port_bindings (or \fIpublish\fP)
Bind exposed ports. Port bindings should be passed in the same way as
the \fB\-\-publish\fP argument to the \fBdocker run\fP CLI command:
.INDENT 7.0
.IP \(bu 2
\fBip:hostPort:containerPort\fP \- Bind a specific IP and port on the
host to a specific port within the container.
.IP \(bu 2
\fBip::containerPort\fP \- Bind a specific IP and an ephemeral port to a
specific port within the container.
.IP \(bu 2
\fBhostPort:containerPort\fP \- Bind a specific port on all of the
host\(aqs interfaces to a specific port within the container.
.IP \(bu 2
\fBcontainerPort\fP \- Bind an ephemeral port on all of the host\(aqs
interfaces to a specific port within the container.
.UNINDENT
.sp
Multiple bindings can be separated by commas, or expressed as a YAML
list, and port ranges can be defined using dashes. The below two
examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- port_bindings: \(dq4505\-4506:14505\-14506,2123:2123/udp,8080\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- port_bindings:
      \- 4505\-4506:14505\-14506
      \- 2123:2123/udp
      \- 8080
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When specifying a protocol, it must be passed in the
\fBcontainerPort\fP value, as seen in the examples above.
.UNINDENT
.UNINDENT
.TP
.B ports
A list of ports to expose on the container. Can either be a
comma\-separated list or a YAML list. If the protocol is omitted, the
port will be assumed to be a TCP port. The below two examples are
equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- ports: 1111,2222/udp
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- ports:
      \- 1111
      \- 2222/udp
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B privileged
False
If \fBTrue\fP, runs the exec process with extended privileges
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- privileged: True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B publish_all_ports (or \fIpublish_all\fP)
False
Publish all ports to the host
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- ports: 8080
    \- publish_all_ports: True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B read_only
False
If \fBTrue\fP, mount the container’s root filesystem as read only
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- read_only: True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B restart_policy (or \fIrestart\fP)
Set a restart policy for the container. Must be passed as a string in
the format \fBpolicy[:retry_count]\fP where \fBpolicy\fP is one of
\fBalways\fP, \fBunless\-stopped\fP, or \fBon\-failure\fP, and \fBretry_count\fP
is an optional limit to the number of retries. The retry count is ignored
when using the \fBalways\fP or \fBunless\-stopped\fP restart policy.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- restart_policy: on\-failure:5

bar:
  docker_container.running:
    \- image: bar/baz:latest
    \- restart_policy: always
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B security_opt (or \fIsecurity_opts\fP):
Security configuration for MLS systems such as SELinux and AppArmor.
Can be expressed as a comma\-separated list or a YAML list. The below
two examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- security_opt: apparmor:unconfined
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- security_opt:
      \- apparmor:unconfined
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
Some security options can contain commas. In these cases, this
argument \fImust\fP be passed as a Python list, as splitting by comma
will result in an invalid configuration.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
See the documentation for security_opt at
\fI\%https://docs.docker.com/engine/reference/run/#security\-configuration\fP
.UNINDENT
.UNINDENT
.TP
.B shm_size
Size of /dev/shm
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- shm_size: 128M
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B stop_signal
Specify the signal docker will send to the container when stopping.
Useful when running systemd as PID 1 inside the container.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- stop_signal: SIGRTMIN+3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option requires Docker 1.9.0 or newer and docker\-py 1.7.0 or
newer.
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.TP
.B stop_timeout
Timeout to stop the container, in seconds
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- stop_timeout: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
In releases prior to 2017.7.0, this option was not set in the
container configuration, but rather this timeout was enforced only
when shutting down an existing container to replace it. To remove
the ambiguity, and to allow for the container to have a stop
timeout set for it, the old \fBstop_timeout\fP argument has been
renamed to \fBshutdown_timeout\fP, while \fBstop_timeout\fP now refer\(aqs
to the container\(aqs configured stop timeout.
.UNINDENT
.UNINDENT
.TP
.B storage_opt
Storage driver options for the container. Can be either a list of
strings in the format \fBoption=value\fP, or a list of mappings between
option and value. The below three examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- storage_opt:
      \- dm.basesize: 40G
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- storage_opt: dm.basesize=40G
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- storage_opt:
      \- dm.basesize=40G
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B sysctls (or \fIsysctl\fP)
Set sysctl options for the container. Can be either a list of strings
in the format \fBoption=value\fP, or a list of mappings between option
and value. The below three examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- sysctls:
      \- fs.nr_open: 1048576
      \- kernel.pid_max: 32768
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- sysctls: fs.nr_open=1048576,kernel.pid_max=32768
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- sysctls:
      \- fs.nr_open=1048576
      \- kernel.pid_max=32768
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B tmpfs
A map of container directories which should be replaced by tmpfs mounts
and their corresponding mount options.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- tmpfs:
      \- /run: rw,noexec,nosuid,size=65536k
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B tty
False
Attach TTYs
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- tty: True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B ulimits
List of ulimits. These limits should be passed in the format
\fB<ulimit_name>:<soft_limit>:<hard_limit>\fP, with the hard limit being
optional. Can be expressed as a comma\-separated list or a YAML list.
The below two examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- ulimits: nofile=1024:1024,nproc=60
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- ulimits:
      \- nofile=1024:1024
      \- nproc=60
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run exec process
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- user: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B userns_mode (or \fIuser_ns_mode\fP)
Sets the user namsepace mode, when the user namespace remapping option
is enabled
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- userns_mode: host
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B volumes (or \fIvolume\fP)
List of directories to expose as volumes. Can be expressed as a
comma\-separated list or a YAML list. The below two examples are
equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- volumes: /mnt/vol1,/mnt/vol2
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- volumes:
      \- /mnt/vol1
      \- /mnt/vol2
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B volumes_from
Container names or IDs from which the container will get volumes. Can
be expressed as a comma\-separated list or a YAML list. The below two
examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- volumes_from: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- volumes_from:
      \- foo
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B volume_driver
sets the container\(aqs volume driver
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- volume_driver: foobar
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B working_dir (or \fIworkdir\fP)
Working directory inside the container
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_container.running:
    \- image: bar/baz:latest
    \- working_dir: /var/log/nginx
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.docker_container.stopped(name=None, containers=None, shutdown_timeout=None, unpause=False, error_on_absent=True, **kwargs)
Ensure that a container (or containers) is stopped
.INDENT 7.0
.TP
.B name
Name or ID of the container
.TP
.B containers
Run this state on more than one container at a time. The following two
examples accomplish the same thing:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
stopped_containers:
  docker_container.stopped:
    \- names:
      \- foo
      \- bar
      \- baz
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
stopped_containers:
  docker_container.stopped:
    \- containers:
      \- foo
      \- bar
      \- baz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, the second example will be a bit quicker since Salt will stop
all specified containers in a single run, rather than executing the
state separately on each image (as it would in the first example).
.TP
.B shutdown_timeout
Timeout for graceful shutdown of the container. If this timeout is
exceeded, the container will be killed. If this value is not passed,
then the container\(aqs configured \fBstop_timeout\fP will be observed. If
\fBstop_timeout\fP was also unset on the container, then a timeout of 10
seconds will be used.
.TP
.B unpause
False
Set to \fBTrue\fP to unpause any paused containers before stopping. If
unset, then an error will be raised for any container that was paused.
.TP
.B error_on_absent
True
By default, this state will return an error if any of the specified
containers are absent. Set this to \fBFalse\fP to suppress that error.
.UNINDENT
.UNINDENT
.SS salt.states.docker_image
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%docker Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Management of Docker images
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B depends
\fI\%docker\fP Python module
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Older releases of the Python bindings for Docker were called \fI\%docker\-py\fP in
PyPI. All releases of \fI\%docker\fP, and releases of \fI\%docker\-py\fP >= 1.6.0 are
supported. These python bindings can easily be installed using
\fI\%pip.install\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pip.install docker
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To upgrade from \fI\%docker\-py\fP to \fI\%docker\fP, you must first uninstall \fI\%docker\-py\fP,
and then install \fI\%docker\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pip.uninstall docker\-py
salt myminion pip.install docker
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
These states were moved from the \fBdocker\fP state
module (formerly called \fBdockerng\fP) in the 2017.7.0 release.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To pull from a Docker registry, authentication must be configured. See
\fI\%here\fP for more information on how to
configure access to docker registries in \fI\%Pillar\fP data.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.docker_image.absent(name=None, images=None, force=False)
Ensure that an image is absent from the Minion. Image names can be
specified either using \fBrepo:tag\fP notation, or just the repo name (in
which case a tag of \fBlatest\fP is assumed).
.INDENT 7.0
.TP
.B name
The name of the docker image.
.TP
.B images
Run this state on more than one image at a time. The following two
examples accomplish the same thing:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
remove_images:
  docker_image.absent:
    \- names:
      \- busybox
      \- centos:6
      \- nginx
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
remove_images:
  docker_image.absent:
    \- images:
      \- busybox
      \- centos:6
      \- nginx
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, the second example will be a bit quicker since Salt will do
all the deletions in a single run, rather than executing the state
separately on each image (as it would in the first example).
.TP
.B force
Salt will fail to remove any images currently in use by a container.
Set this option to true to remove the image even if it is already
present.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option can also be overridden by Pillar data. If the Minion
has a pillar variable named \fBdocker.running.force\fP which is
set to \fBTrue\fP, it will turn on this option. This pillar variable
can even be set at runtime. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion state.sls docker_stuff pillar=\(dq{docker.force: True}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If this pillar variable is present and set to \fBFalse\fP, then it
will turn off this option.
.sp
For more granular control, setting a pillar variable named
\fBdocker.force.image_name\fP will affect only the named image.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.docker_image.mod_watch(name, sfun=None, **kwargs)
The docker_image  watcher, called to invoke the watch command.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state exists to support special handling of the \fBwatch\fP
\fI\%requisite\fP\&. It should not be called directly.
.sp
Parameters for this function should be set by the state being triggered.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.docker_image.present(name, tag=None, build=None, load=None, force=False, insecure_registry=False, client_timeout=60, dockerfile=None, sls=None, base=\(aqopensuse/python\(aq, saltenv=\(aqbase\(aq, pillarenv=None, pillar=None, **kwargs)
Changed in version 2018.3.0: The \fBtag\fP argument has been added. It is now required unless pulling
from a registry.

.sp
Ensure that an image is present. The image can either be pulled from a
Docker registry, built from a Dockerfile, loaded from a saved image, or
built by running SLS files against a base image.
.sp
If none of the \fBbuild\fP, \fBload\fP, or \fBsls\fP arguments are used, then Salt
will pull from the \fI\%configured registries\fP\&. If
the specified image already exists, it will not be pulled unless \fBforce\fP
is set to \fBTrue\fP\&. Here is an example of a state that will pull an image
from the Docker Hub:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myuser/myimage:
  docker_image.present:
    \- tag: mytag
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the docker image.
.TP
.B tag
Tag name for the image. Required when using \fBbuild\fP, \fBload\fP, or
\fBsls\fP to create the image, but optional if pulling from a repository.
.sp
New in version 2018.3.0.

.TP
.B build
Path to directory on the Minion containing a Dockerfile
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myuser/myimage:
  docker_image.present:
    \- build: /home/myuser/docker/myimage
    \- tag: mytag

myuser/myimage:
  docker_image.present:
    \- build: /home/myuser/docker/myimage
    \- tag: mytag
    \- dockerfile: Dockerfile.alternative
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The image will be built using \fI\%docker.build\fP and the specified image name and tag
will be applied to it.
.sp
New in version 2016.11.0.

.sp
Changed in version 2018.3.0: The \fBtag\fP must be manually specified using the \fBtag\fP argument.

.TP
.B load
Loads a tar archive created with \fI\%docker.save\fP (or the \fBdocker save\fP Docker CLI
command), and assigns it the specified repo and tag.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myuser/myimage:
  docker_image.present:
    \- load: salt://path/to/image.tar
    \- tag: mytag
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2018.3.0: The \fBtag\fP must be manually specified using the \fBtag\fP argument.

.TP
.B force
Set this parameter to \fBTrue\fP to force Salt to pull/build/load the
image even if it is already present.
.TP
.B insecure_registry
If \fBTrue\fP, the Docker client will permit the use of insecure
(non\-HTTPS) registries.
.TP
.B client_timeout
Timeout in seconds for the Docker client. This is not a timeout for
the state, but for receiving a response from the API.
.TP
.B dockerfile
Allows for an alternative Dockerfile to be specified.  Path to alternative
Dockefile is relative to the build path for the Docker container.
.sp
New in version 2016.11.0.

.TP
.B sls
Allow for building of image with \fI\%docker.sls_build\fP by specifying the SLS files with
which to build. This can be a list or comma\-separated string.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myuser/myimage:
  docker_image.present:
    \- tag: latest
    \- sls:
        \- webapp1
        \- webapp2
    \- base: centos
    \- saltenv: base
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.sp
Changed in version 2018.3.0: The \fBtag\fP must be manually specified using the \fBtag\fP argument.

.TP
.B base
Base image with which to start \fI\%docker.sls_build\fP
.sp
New in version 2017.7.0.

.TP
.B saltenv
Specify the environment from which to retrieve the SLS indicated by the
\fImods\fP parameter.
.sp
New in version 2017.7.0.

.sp
Changed in version 2018.3.0: Now uses the effective saltenv if not explicitly passed. In earlier
versions, \fBbase\fP was assumed as a default.

.TP
.B pillarenv
Specify a Pillar environment to be used when applying states. This
can also be set in the minion config file using the
\fI\%pillarenv\fP option. When neither the
\fI\%pillarenv\fP minion config option nor this CLI argument is
used, all Pillar environments will be merged together.
.sp
New in version 2018.3.0.

.TP
.B pillar
Custom Pillar values, passed as a dictionary of key\-value pairs
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Values passed this way will override Pillar values set via
\fBpillar_roots\fP or an external Pillar source.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.TP
.B kwargs
Additional keyword arguments to pass to
\fI\%docker.build\fP
.UNINDENT
.UNINDENT
.SS salt.states.docker_network
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%docker Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Management of Docker networks
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B depends
\fI\%docker\fP Python module
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Older releases of the Python bindings for Docker were called \fI\%docker\-py\fP in
PyPI. All releases of \fI\%docker\fP, and releases of \fI\%docker\-py\fP >= 1.6.0 are
supported. These python bindings can easily be installed using
\fI\%pip.install\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pip.install docker
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To upgrade from \fI\%docker\-py\fP to \fI\%docker\fP, you must first uninstall \fI\%docker\-py\fP,
and then install \fI\%docker\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pip.uninstall docker\-py
salt myminion pip.install docker
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
These states were moved from the \fBdocker\fP state
module (formerly called \fBdockerng\fP) in the 2017.7.0 release.
.INDENT 0.0
.TP
.B salt.states.docker_network.absent(name)
Ensure that a network is absent.
.INDENT 7.0
.TP
.B name
Name of the network
.UNINDENT
.sp
Usage Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
network_foo:
  docker_network.absent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.docker_network.present(name, skip_translate=None, ignore_collisions=False, validate_ip_addrs=True, containers=None, reconnect=True, **kwargs)
Changed in version 2018.3.0: Support added for network configuration options other than \fBdriver\fP
and \fBdriver_opts\fP, as well as IPAM configuration.

.sp
Ensure that a network is present
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state supports all arguments for network and IPAM pool
configuration which are available for the release of docker\-py
installed on the minion. For that reason, the arguments described below
in the \fI\%NETWORK CONFIGURATION\fP and \fI\%IP ADDRESS
MANAGEMENT (IPAM)\fP sections
may not accurately reflect what is available on the minion. The
\fI\%docker.get_client_args\fP function can be used to check
the available arguments for the installed version of docker\-py (they
are found in the \fBnetwork_config\fP and \fBipam_config\fP sections of the
return data), but Salt will not prevent a user from attempting to use
an argument which is unsupported in the release of Docker which is
installed. In those cases, network creation be attempted but will fail.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Network name
.TP
.B skip_translate
This function translates Salt SLS input into the format which
docker\-py expects. However, in the event that Salt\(aqs translation logic
fails (due to potential changes in the Docker Remote API, or to bugs in
the translation code), this argument can be used to exert granular
control over which arguments are translated and which are not.
.sp
Pass this argument as a comma\-separated list (or Python list) of
arguments, and translation for each passed argument name will be
skipped. Alternatively, pass \fBTrue\fP and \fIall\fP translation will be
skipped.
.sp
Skipping tranlsation allows for arguments to be formatted directly in
the format which docker\-py expects. This allows for API changes and
other issues to be more easily worked around. See the following links
for more information:
.INDENT 7.0
.IP \(bu 2
\fI\%docker\-py Low\-level API\fP
.IP \(bu 2
\fI\%Docker Engine API\fP
.UNINDENT
.sp
New in version 2018.3.0.

.UNINDENT
.INDENT 7.0
.TP
.B ignore_collisions
False
Since many of docker\-py\(aqs arguments differ in name from their CLI
counterparts (with which most Docker users are more familiar), Salt
detects usage of these and aliases them to the docker\-py version of
that argument. However, if both the alias and the docker\-py version of
the same argument (e.g. \fBoptions\fP and \fBdriver_opts\fP) are used, an error
will be raised. Set this argument to \fBTrue\fP to suppress these errors
and keep the docker\-py version of the argument.
.sp
New in version 2018.3.0.

.TP
.B validate_ip_addrs
True
For parameters which accept IP addresses/subnets as input, validation
will be performed. To disable, set this to \fBFalse\fP\&.
.sp
New in version 2018.3.0.

.TP
.B containers
A list of containers which should be connected to this network.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
As of the 2018.3.0 release, this is not the recommended way of
managing a container\(aqs membership in a network, for a couple
reasons:
.INDENT 0.0
.IP 1. 3
It does not support setting static IPs, aliases, or links in the
container\(aqs IP configuration.
.IP 2. 3
If a \fI\%docker_container.running\fP state replaces a
container, it will not be reconnected to the network until the
\fBdocker_network.present\fP state is run again. Since containers
often have \fBrequire\fP requisites to ensure that the network
is present, this means that the \fBdocker_network.present\fP state
ends up being run \fIbefore\fP the \fI\%docker_container.running\fP, leaving the container
unattached at the end of the Salt run.
.UNINDENT
.sp
For these reasons, it is recommended to use
\fI\%docker_container.running\(aqs network management support\fP\&.
.UNINDENT
.UNINDENT
.TP
.B reconnect
True
If \fBcontainers\fP is not used, and the network is replaced, then Salt
will keep track of the containers which were connected to the network
and reconnect them to the network after it is replaced. Salt will first
attempt to reconnect using the same IP the container had before the
network was replaced. If that fails (for instance, if the network was
replaced because the subnet was modified), then the container will be
reconnected without an explicit IP address, and its IP will be assigned
by Docker.
.sp
Set this option to \fBFalse\fP to keep Salt from trying to reconnect
containers. This can be useful in some cases when \fI\%managing static
IPs in docker_container.running\fP\&. For instance, if a
network\(aqs subnet is modified, it is likely that the static IP will need
to be updated in the \fBdocker_container.running\fP state as well. When
the network is replaced, the initial reconnect attempt would fail, and
the container would be reconnected with an automatically\-assigned IP
address. Then, when the \fBdocker_container.running\fP state executes, it
would disconnect the network \fIagain\fP and reconnect using the new static
IP. Disabling the reconnect behavior in these cases would prevent the
unnecessary extra reconnection.
.sp
New in version 2018.3.0.

.UNINDENT
.sp
\fBNETWORK CONFIGURATION ARGUMENTS\fP
.INDENT 7.0
.TP
.B driver
Network driver
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- driver: macvlan
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B driver_opts (or \fIdriver_opt\fP, or \fIoptions\fP)
Options for the network driver. Either a dictionary of option names and
values or a Python list of strings in the format \fBvarname=value\fP\&. The
below three examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- driver: macvlan
    \- driver_opts: macvlan_mode=bridge,parent=eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- driver: macvlan
    \- driver_opts:
      \- macvlan_mode=bridge
      \- parent=eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- driver: macvlan
    \- driver_opts:
      \- macvlan_mode: bridge
      \- parent: eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The options can also simply be passed as a dictionary, though this can
be error\-prone due to some \fI\%idiosyncrasies\fP
with how PyYAML loads nested data structures:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- driver: macvlan
    \- driver_opts:
        macvlan_mode: bridge
        parent: eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B check_duplicate
True
If \fBTrue\fP, checks for networks with duplicate names. Since networks
are primarily keyed based on a random ID and not on the name, and
network name is strictly a user\-friendly alias to the network which is
uniquely identified using ID, there is no guaranteed way to check for
duplicates. This option providess a best effort, checking for any
networks which have the same name, but it is not guaranteed to catch
all name collisions.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- check_duplicate: False
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B internal
False
If \fBTrue\fP, restricts external access to the network
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- internal: True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B labels
Add metadata to the network. Labels can be set both with and without
values, and labels with values can be passed either as \fBkey=value\fP or
\fBkey: value\fP pairs. For example, while the below would be very
confusing to read, it is technically valid, and demonstrates the
different ways in which labels can be passed:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- labels:
      \- foo
      \- bar=baz
      \- hello: world
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The labels can also simply be passed as a YAML dictionary, though this
can be error\-prone due to some \fI\%idiosyncrasies\fP with how PyYAML loads nested data structures:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  docker_network.present:
    \- labels:
        foo: \(aq\(aq
        bar: baz
        hello: world
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2018.3.0: Methods for specifying labels can now be mixed. Earlier releases
required either labels with or without values.

.TP
.B enable_ipv6 (or \fIipv6\fP)
False
Enable IPv6 on the network
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- enable_ipv6: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
While it should go without saying, this argument must be set to
\fBTrue\fP to \fI\%configure an IPv6 subnet\fP\&. Also, if this option is
turned on without an IPv6 subnet explicitly configured, you will
get an error unless you have set up a fixed IPv6 subnet. Consult
the \fI\%Docker IPv6 docs\fP for information on how to do this.
.UNINDENT
.UNINDENT
.TP
.B attachable
False
If \fBTrue\fP, and the network is in the global scope, non\-service
containers on worker nodes will be able to connect to the network.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- attachable: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option cannot be reliably managed on CentOS 7. This is because
while support for this option was added in API version 1.24, its
value was not added to the inpsect results until API version 1.26.
The version of Docker which is available for CentOS 7 runs API
version 1.24, meaning that while Salt can pass this argument to the
API, it has no way of knowing the value of this config option in an
existing Docker network.
.UNINDENT
.UNINDENT
.TP
.B scope
Specify the network\(aqs scope (\fBlocal\fP, \fBglobal\fP or \fBswarm\fP)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- scope: local
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B ingress
False
If \fBTrue\fP, create an ingress network which provides the routing\-mesh in
swarm mode
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- ingress: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBIP ADDRESS MANAGEMENT (IPAM)\fP
.sp
This state supports networks with either IPv4, or both IPv4 and IPv6. If
configuring IPv4, then you can pass the \fI\%IPAM pool arguments\fP below as
individual arguments. However, if configuring IPv4 and IPv6, the arguments
must be passed as a list of dictionaries, in the \fBipam_pools\fP argument
(click \fI\%here\fP for
some examples). \fI\%These docs\fP also have more information on these
arguments.
.sp
\fIIPAM ARGUMENTS\fP
.INDENT 7.0
.TP
.B ipam_driver
IPAM driver to use, if different from the default one
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- ipam_driver: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B ipam_opts
Options for the IPAM driver. Either a dictionary of option names and
values or a Python list of strings in the format \fBvarname=value\fP\&. The
below three examples are equivalent:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- ipam_driver: foo
    \- ipam_opts: foo=bar,baz=qux
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- ipam_driver: foo
    \- ipam_opts:
      \- foo=bar
      \- baz=qux
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- ipam_driver: foo
    \- ipam_opts:
      \- foo: bar
      \- baz: qux
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The options can also simply be passed as a dictionary, though this can
be error\-prone due to some \fI\%idiosyncrasies\fP
with how PyYAML loads nested data structures:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- ipam_driver: macvlan
    \- ipam_opts:
        foo: bar
        baz: qux
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fIIPAM POOL ARGUMENTS\fP
.INDENT 7.0
.TP
.B subnet
Subnet in CIDR format that represents a network segment
.TP
.B iprange (or \fIip_range\fP)
Allocate container IP from a sub\-range within the subnet
.sp
Subnet in CIDR format that represents a network segment
.TP
.B gateway
IPv4 or IPv6 gateway for the master subnet
.TP
.B aux_addresses (or \fIaux_address\fP)
A dictionary of mapping container names to IP addresses which should be
allocated for them should they connect to the network. Either a
dictionary of option names and values or a Python list of strings in
the format \fBhost=ipaddr\fP\&.
.UNINDENT
.sp
\fIIPAM CONFIGURATION EXAMPLES\fP
.sp
Below is an example of an IPv4\-only network (keep in mind that \fBsubnet\fP
is the only required argument).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- subnet: 10.0.20.0/24
    \- iprange: 10.0.20.128/25
    \- gateway: 10.0.20.254
    \- aux_addresses:
      \- foo.bar.tld: 10.0.20.50
      \- hello.world.tld: 10.0.20.51
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fBaux_addresses\fP can be passed differently, in the same way that
\fBdriver_opts\fP and \fBipam_opts\fP can.
.UNINDENT
.UNINDENT
.sp
This same network could also be configured this way:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- ipam_pools:
      \- subnet: 10.0.20.0/24
        iprange: 10.0.20.128/25
        gateway: 10.0.20.254
        aux_addresses:
          foo.bar.tld: 10.0.20.50
          hello.world.tld: 10.0.20.51
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here is an example of a mixed IPv4/IPv6 subnet.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mynet:
  docker_network.present:
    \- ipam_pools:
      \- subnet: 10.0.20.0/24
        gateway: 10.0.20.1
      \- subnet: fe3f:2180:26:1::/123
        gateway: fe3f:2180:26:1::1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.docker_volume
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%docker Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Management of Docker volumes
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B depends
\fI\%docker\fP Python module
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Older releases of the Python bindings for Docker were called \fI\%docker\-py\fP in
PyPI. All releases of \fI\%docker\fP, and releases of \fI\%docker\-py\fP >= 1.6.0 are
supported. These python bindings can easily be installed using
\fI\%pip.install\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pip.install docker
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To upgrade from \fI\%docker\-py\fP to \fI\%docker\fP, you must first uninstall \fI\%docker\-py\fP,
and then install \fI\%docker\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion pip.uninstall docker\-py
salt myminion pip.install docker
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
These states were moved from the \fBdocker\fP state
module (formerly called \fBdockerng\fP) in the 2017.7.0 release.
.INDENT 0.0
.TP
.B salt.states.docker_volume.absent(name, driver=None)
Ensure that a volume is absent.
.sp
New in version 2015.8.4.

.sp
Changed in version 2017.7.0: This state was renamed from \fBdocker.volume_absent\fP to \fBdocker_volume.absent\fP

.INDENT 7.0
.TP
.B name
Name of the volume
.UNINDENT
.sp
Usage Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
volume_foo:
  docker_volume.absent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.docker_volume.present(name, driver=None, driver_opts=None, force=False)
Ensure that a volume is present.
.sp
New in version 2015.8.4.

.sp
Changed in version 2015.8.6: This state no longer deletes and re\-creates a volume if the existing
volume\(aqs driver does not match the \fBdriver\fP parameter (unless the
\fBforce\fP parameter is set to \fBTrue\fP).

.sp
Changed in version 2017.7.0: This state was renamed from \fBdocker.volume_present\fP to \fBdocker_volume.present\fP

.INDENT 7.0
.TP
.B name
Name of the volume
.TP
.B driver
Type of driver for that volume.  If \fBNone\fP and the volume
does not yet exist, the volume will be created using Docker\(aqs
default driver.  If \fBNone\fP and the volume does exist, this
function does nothing, even if the existing volume\(aqs driver is
not the Docker default driver.  (To ensure that an existing
volume\(aqs driver matches the Docker default, you must
explicitly name Docker\(aqs default driver here.)
.TP
.B driver_opts
Options for the volume driver
.TP
.B force
False
If the volume already exists but the existing volume\(aqs driver
does not match the driver specified by the \fBdriver\fP
parameter, this parameter controls whether the function errors
out (if \fBFalse\fP) or deletes and re\-creates the volume (if
\fBTrue\fP).
.sp
New in version 2015.8.6.

.UNINDENT
.sp
Usage Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
volume_foo:
  docker_volume.present
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
volume_bar:
  docker_volume.present
    \- name: bar
    \- driver: local
    \- driver_opts:
        foo: bar
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
volume_bar:
  docker_volume.present
    \- name: bar
    \- driver: local
    \- driver_opts:
        \- foo: bar
        \- option: value
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.drac
.sp
Management of Dell DRAC
.sp
The DRAC module is used to create and manage DRAC cards on Dell servers
.sp
Ensure the user damian is present
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
damian:
  drac.present:
    \- name: damian
    \- password: secret
    \- permission: login,test_alerts,clear_logs
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Ensure the user damian does not exist
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
damian:
  drac.absent:
    \- name: damian
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Ensure DRAC network is in a consistent state
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_network:
  drac.network:
    \- ip: 10.225.108.29
    \- netmask: 255.255.255.224
    \- gateway: 10.225.108.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.drac.absent(name)
Ensure a user does not exist on the Dell DRAC
.INDENT 7.0
.TP
.B name:
The users username
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.drac.network(ip, netmask, gateway)
Ensure the DRAC network settings are consistent
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.drac.present(name, password, permission)
Ensure the user exists on the Dell DRAC
.INDENT 7.0
.TP
.B name:
The users username
.TP
.B password
The password used to authenticate
.TP
.B permission
The permissions that should be assigned to a user
.UNINDENT
.UNINDENT
.SS salt.states.dvs
.sp
Manage VMware distributed virtual switches (DVSs) and their distributed virtual
portgroups (DVportgroups).
.INDENT 0.0
.TP
.B codeauthor
\fIAlexandru Bleotu <alexandru.bleotu@morganstaley.com>\fP
.UNINDENT
.sp
Examples
.sp
Several settings can be changed for DVSs and DVporgroups. Here are two examples
covering all of the settings. Fewer settings can be used
.SS DVS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(aqname\(aq: \(aqdvs1\(aq,
\(aqmax_mtu\(aq: 1000,
\(aquplink_names\(aq: [
    \(aqdvUplink1\(aq,
    \(aqdvUplink2\(aq,
    \(aqdvUplink3\(aq
],
\(aqcapability\(aq: {
    \(aqportgroup_operation_supported\(aq: false,
    \(aqoperation_supported\(aq: true,
    \(aqport_operation_supported\(aq: false
},
\(aqlacp_api_version\(aq: \(aqmultipleLag\(aq,
\(aqcontact_email\(aq: \(aqfoo@email.com\(aq,
\(aqproduct_info\(aq: {
    \(aqversion\(aq:
    \(aq6.0.0\(aq,
    \(aqvendor\(aq:
    \(aqVMware,
    Inc.\(aq,
    \(aqname\(aq:
    \(aqDVS\(aq
},
\(aqnetwork_resource_management_enabled\(aq: true,
\(aqcontact_name\(aq: \(aqme@email.com\(aq,
\(aqinfrastructure_traffic_resource_pools\(aq: [
    {
        \(aqreservation\(aq: 0,
        \(aqlimit\(aq: 1000,
        \(aqshare_level\(aq: \(aqhigh\(aq,
        \(aqkey\(aq: \(aqmanagement\(aq,
        \(aqnum_shares\(aq: 100
    },
    {
        \(aqreservation\(aq: 0,
        \(aqlimit\(aq: \-1,
        \(aqshare_level\(aq: \(aqnormal\(aq,
        \(aqkey\(aq: \(aqfaultTolerance\(aq,
        \(aqnum_shares\(aq: 50
    },
    {
        \(aqreservation\(aq: 0,
        \(aqlimit\(aq: 32000,
        \(aqshare_level\(aq: \(aqnormal\(aq,
        \(aqkey\(aq: \(aqvmotion\(aq,
        \(aqnum_shares\(aq: 50
    },
    {
        \(aqreservation\(aq: 10000,
        \(aqlimit\(aq: \-1,
        \(aqshare_level\(aq: \(aqnormal\(aq,
        \(aqkey\(aq: \(aqvirtualMachine\(aq,
        \(aqnum_shares\(aq: 50
    },
    {
        \(aqreservation\(aq: 0,
        \(aqlimit\(aq: \-1,
        \(aqshare_level\(aq: \(aqcustom\(aq,
        \(aqkey\(aq: \(aqiSCSI\(aq,
        \(aqnum_shares\(aq: 75
    },
    {
        \(aqreservation\(aq: 0,
        \(aqlimit\(aq: \-1,
        \(aqshare_level\(aq: \(aqnormal\(aq,
        \(aqkey\(aq: \(aqnfs\(aq,
        \(aqnum_shares\(aq: 50
    },
    {
        \(aqreservation\(aq: 0,
        \(aqlimit\(aq: \-1,
        \(aqshare_level\(aq: \(aqnormal\(aq,
        \(aqkey\(aq: \(aqhbr\(aq,
        \(aqnum_shares\(aq: 50
    },
    {
        \(aqreservation\(aq: 8750,
        \(aqlimit\(aq: 15000,
        \(aqshare_level\(aq: \(aqhigh\(aq,
        \(aqkey\(aq: \(aqvsan\(aq,
        \(aqnum_shares\(aq: 100
    },
    {
        \(aqreservation\(aq: 0,
        \(aqlimit\(aq: \-1,
        \(aqshare_level\(aq: \(aqnormal\(aq,
        \(aqkey\(aq: \(aqvdp\(aq,
        \(aqnum_shares\(aq: 50
    }
],
\(aqlink_discovery_protocol\(aq: {
    \(aqoperation\(aq:
    \(aqlisten\(aq,
    \(aqprotocol\(aq:
    \(aqcdp\(aq
},
\(aqnetwork_resource_control_version\(aq: \(aqversion3\(aq,
\(aqdescription\(aq: \(aqManaged by Salt. Random settings.\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note: The mandatory attribute is: \fBname\fP\&.
.SS Portgroup
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(aqsecurity_policy\(aq: {
    \(aqallow_promiscuous\(aq: true,
    \(aqmac_changes\(aq: false,
    \(aqforged_transmits\(aq: true
},
\(aqname\(aq: \(aqvmotion\-v702\(aq,
\(aqout_shaping\(aq: {
    \(aqenabled\(aq: true,
    \(aqaverage_bandwidth\(aq: 1500,
    \(aqburst_size\(aq: 4096,
    \(aqpeak_bandwidth\(aq: 1500
},
\(aqnum_ports\(aq: 128,
\(aqteaming\(aq: {
    \(aqport_order\(aq: {
        \(aqactive\(aq: [
            \(aqdvUplink2\(aq
        ],
        \(aqstandby\(aq: [
            \(aqdvUplink1\(aq
        ]
    },
    \(aqnotify_switches\(aq: false,
    \(aqreverse_policy\(aq: true,
    \(aqrolling_order\(aq: false,
    \(aqpolicy\(aq: \(aqfailover_explicit\(aq,
    \(aqfailure_criteria\(aq: {
        \(aqcheck_error_percent\(aq: true,
        \(aqfull_duplex\(aq: false,
        \(aqcheck_duplex\(aq: false,
        \(aqpercentage\(aq: 50,
        \(aqcheck_speed\(aq: \(aqminimum\(aq,
        \(aqspeed\(aq: 20,
        \(aqcheck_beacon\(aq: true
    }
},
\(aqtype\(aq: \(aqearlyBinding\(aq,
\(aqvlan_id\(aq: 100,
\(aqdescription\(aq: \(aqManaged by Salt. Random settings.\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note: The mandatory attributes are: \fBname\fP, \fBtype\fP\&.
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
pyVmomi Python Module
.UNINDENT
.SS pyVmomi
.sp
PyVmomi can be installed via pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Version 6.0 of pyVmomi has some problems with SSL error handling on certain
versions of Python. If using version 6.0 of pyVmomi, Python 2.7.9,
or newer must be present. This is due to an upstream dependency
in pyVmomi 6.0 that is not supported in Python versions 2.7 to 2.7.8. If the
version of Python is not in the supported range, you will need to install an
earlier version of pyVmomi. See \fI\%Issue #29537\fP for more information.
.UNINDENT
.UNINDENT
.sp
Based on the note above, to install an earlier version of pyVmomi than the
version currently listed in PyPi, run the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi==5.5.0.2014.1.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The 5.5.0.2014.1.1 is a known stable version that this original ESXi State
Module was developed against.
.INDENT 0.0
.TP
.B salt.states.dvs.dvs_configured(name, dvs)
Configures a DVS.
.sp
Creates a new DVS, if it doesn\(aqt exist in the provided datacenter or
reconfigures it if configured differently.
.INDENT 7.0
.TP
.B dvs
DVS dict representations (see module sysdocs)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.dvs.portgroups_configured(name, dvs, portgroups)
Configures portgroups on a DVS.
.sp
Creates/updates/removes portgroups in a provided DVS
.INDENT 7.0
.TP
.B dvs
Name of the DVS
.TP
.B portgroups
Portgroup dict representations (see module sysdocs)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.dvs.uplink_portgroup_configured(name, dvs, uplink_portgroup)
Configures the uplink portgroup on a DVS. The state assumes there is only
one uplink portgroup.
.INDENT 7.0
.TP
.B dvs
Name of the DVS
.TP
.B upling_portgroup
Uplink portgroup dict representations (see module sysdocs)
.UNINDENT
.UNINDENT
.SS salt.states.elasticsearch
.sp
State module to manage Elasticsearch.
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.states.elasticsearch.alias_absent(name, index)
Ensure that the index alias is absent.
.INDENT 7.0
.TP
.B name
Name of the index alias to remove
.TP
.B index
Name of the index for the alias
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.elasticsearch.alias_present(name, index, definition=None)
Ensure that the named index alias is present.
.INDENT 7.0
.TP
.B name
Name of the alias
.TP
.B index
Name of the index
.TP
.B definition
Optional dict for filters as per \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/indices\-aliases.html\fP
.UNINDENT
.sp
\fBExample:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mytestalias:
  elasticsearch.alias_present:
    \- index: testindex
    \- definition:
        filter:
          term:
            user: kimchy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.elasticsearch.index_absent(name)
Ensure that the named index is absent.
.INDENT 7.0
.TP
.B name
Name of the index to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.elasticsearch.index_present(name, definition=None)
Ensure that the named index is present.
.INDENT 7.0
.TP
.B name
Name of the index to add
.TP
.B definition
Optional dict for creation parameters as per \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/indices\-create\-index.html\fP
.UNINDENT
.sp
\fBExample:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Default settings
mytestindex:
  elasticsearch_index.present

# Extra settings
mytestindex2:
  elasticsearch_index.present:
    \- definition:
        settings:
          index:
            number_of_shards: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.elasticsearch.index_template_absent(name)
Ensure that the named index template is absent.
.INDENT 7.0
.TP
.B name
Name of the index to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.elasticsearch.index_template_present(name, definition, check_definition=False)
Ensure that the named index template is present.
.INDENT 7.0
.TP
.B name
Name of the index to add
.TP
.B definition
Required dict for creation parameters as per \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/indices\-templates.html\fP
.TP
.B check_definition
If the template already exists and the definition is up to date
.UNINDENT
.sp
\fBExample:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mytestindex2_template:
  elasticsearch.index_template_present:
    \- definition:
        template: logstash\-*
        order: 1
        settings:
          number_of_shards: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.elasticsearch.pipeline_absent(name)
Ensure that the named pipeline is absent
.INDENT 7.0
.TP
.B name
Name of the pipeline to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.elasticsearch.pipeline_present(name, definition)
Ensure that the named pipeline is present.
.INDENT 7.0
.TP
.B name
Name of the index to add
.TP
.B definition
Required dict for creation parameters as per \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/master/pipeline.html\fP
.UNINDENT
.sp
\fBExample:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
test_pipeline:
  elasticsearch.pipeline_present:
    \- definition:
        description: example pipeline
        processors:
          \- set:
              field: collector_timestamp_millis
              value: \(aq{{ \(aq{{\(aq }}_ingest.timestamp{{ \(aq}}\(aq }}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.elasticsearch.search_template_absent(name)
Ensure that the search template is absent
.INDENT 7.0
.TP
.B name
Name of the search template to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.elasticsearch.search_template_present(name, definition)
Ensure that the named search template is present.
.INDENT 7.0
.TP
.B name
Name of the search template to add
.TP
.B definition
Required dict for creation parameters as per \fI\%http://www.elastic.co/guide/en/elasticsearch/reference/current/search\-template.html\fP
.UNINDENT
.sp
\fBExample:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
test_pipeline:
  elasticsearch.search_template_present:
    \- definition:
        inline:
          size: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.elasticsearch_index
.sp
State module to manage Elasticsearch indices
.sp
New in version 2015.8.0.

.sp
Deprecated since version 2017.7.0: Use elasticsearch state instead

.INDENT 0.0
.TP
.B salt.states.elasticsearch_index.absent(name)
Ensure that the named index is absent.
.INDENT 7.0
.TP
.B name
Name of the index to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.elasticsearch_index.present(name, definition=None)
New in version 2015.8.0.

.sp
Changed in version 2017.3.0: Marked \fBdefinition\fP as optional.

.sp
Ensure that the named index is present.
.INDENT 7.0
.TP
.B name
Name of the index to add
.TP
.B definition
Optional dict for creation parameters as per \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/indices\-create\-index.html\fP
.UNINDENT
.sp
\fBExample:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Default settings
mytestindex:
  elasticsearch_index.present

# Extra settings
mytestindex2:
  elasticsearch_index.present:
    \- definition:
        settings:
          index:
            number_of_shards: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.elasticsearch_index_template
.sp
State module to manage Elasticsearch index templates
.sp
New in version 2015.8.0.

.sp
Deprecated since version 2017.7.0: Use elasticsearch state instead

.INDENT 0.0
.TP
.B salt.states.elasticsearch_index_template.absent(name)
Ensure that the named index template is absent.
.INDENT 7.0
.TP
.B name
Name of the index to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.elasticsearch_index_template.present(name, definition)
New in version 2015.8.0.

.sp
Changed in version 2017.3.0: Marked \fBdefinition\fP as required.

.sp
Ensure that the named index templat eis present.
.INDENT 7.0
.TP
.B name
Name of the index to add
.TP
.B definition
Required dict for creation parameters as per \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/indices\-templates.html\fP
.UNINDENT
.sp
\fBExample:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mytestindex2_template:
  elasticsearch_index_template.present:
    \- definition:
        template: logstash\-*
        order: 1
        settings:
          number_of_shards: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.environ
.sp
Support for getting and setting the environment variables
of the current salt process.
.INDENT 0.0
.TP
.B salt.states.environ.setenv(name, value, false_unsets=False, clear_all=False, update_minion=False, permanent=False)
Set the salt process environment variables.
.INDENT 7.0
.TP
.B name
The environment key to set. Must be a string.
.TP
.B value
Either a string or dict. When string, it will be the value
set for the environment key of \(aqname\(aq above.
When a dict, each key/value pair represents an environment
variable to set.
.TP
.B false_unsets
If a key\(aqs value is False and false_unsets is True, then the
key will be removed from the salt processes environment dict
entirely. If a key\(aqs value is False and false_unsets is not
True, then the key\(aqs value will be set to an empty string.
Default: False
.TP
.B clear_all
USE WITH CAUTION! This option can unset environment variables
needed for salt to function properly.
If clear_all is True, then any environment variables not
defined in the environ dict will be deleted.
Default: False
.TP
.B update_minion
If True, apply these environ changes to the main salt\-minion
process. If False, the environ changes will only affect the
current salt subprocess.
Default: False
.TP
.B permanent
On Windows minions this will set the environment variable in the
registry so that it is always added as a environment variable when
applications open. If you want to set the variable to HKLM instead of
HKCU just pass in \(dqHKLM\(dq for this parameter. On all other minion types
this will be ignored. Note: This will only take affect on applications
opened after this has been set.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
a_string_env:
   environ.setenv:
     \- name: foo
     \- value: bar
     \- update_minion: True

a_dict_env:
   environ.setenv:
     \- name: does_not_matter
     \- value:
         foo: bar
         baz: quux
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.eselect
.SS Management of Gentoo configuration using eselect
.sp
A state module to manage Gentoo configuration via eselect
.INDENT 0.0
.TP
.B salt.states.eselect.set_(name, target, module_parameter=None, action_parameter=None)
Verify that the given module is set to the given target
.INDENT 7.0
.TP
.B name
The name of the module
.TP
.B target
The target to be set for this module
.TP
.B module_parameter
additional params passed to the defined module
.TP
.B action_parameter
additional params passed to the defined action
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
profile:
  eselect.set:
    \- target: hardened/linux/amd64
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.esxcluster
.sp
Manage VMware ESXi Clusters.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be deprecated in a future release of Salt. VMware strongly
recommends using the
\fI\%VMware Salt extensions\fP
instead of the ESX cluster module. Because the Salt extensions are newer and
actively supported by VMware, they are more compatible with current versions
of ESXi and they work well with the latest features in the VMware product
line.
.UNINDENT
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
pyVmomi Python Module
.UNINDENT
.SS pyVmomi
.sp
PyVmomi can be installed via pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Version 6.0 of pyVmomi has some problems with SSL error handling on certain
versions of Python. If using version 6.0 of pyVmomi, Python 2.7.9,
or newer must be present. This is due to an upstream dependency
in pyVmomi 6.0 that is not supported in Python versions 2.7 to 2.7.8. If the
version of Python is not in the supported range, you will need to install an
earlier version of pyVmomi. See \fI\%Issue #29537\fP for more information.
.UNINDENT
.UNINDENT
.sp
Based on the note above, to install an earlier version of pyVmomi than the
version currently listed in PyPi, run the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi==5.5.0.2014.1.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The 5.5.0.2014.1.1 is a known stable version that this original ESXi State
Module was developed against.
.INDENT 0.0
.TP
.B salt.states.esxcluster.cluster_configured(name, cluster_config)
Configures a cluster. Creates a new cluster, if it doesn\(aqt exist on the
vCenter or reconfigures it if configured differently
.sp
Supported proxies: esxdatacenter, esxcluster
.INDENT 7.0
.TP
.B name
Name of the state. If the state is run in by an \fBesxdatacenter\fP
proxy, it will be the name of the cluster.
.TP
.B cluster_config
Configuration applied to the cluster.
Complex datastructure following the ESXClusterConfigSchema.
Valid example is:
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
drs:
    default_vm_behavior: fullyAutomated
    enabled: true
    vmotion_rate: 3
ha:
    admission_control
    _enabled: false
    default_vm_settings:
        isolation_response: powerOff
        restart_priority: medium
    enabled: true
    hb_ds_candidate_policy: userSelectedDs
    host_monitoring: enabled
    options:
        \- key: das.ignoreinsufficienthbdatastore
          value: \(aqtrue\(aq
    vm_monitoring: vmMonitoringDisabled
vm_swap_placement: vmDirectory
vsan:
    auto_claim_storage: false
    compression_enabled: true
    dedup_enabled: true
    enabled: true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.esxcluster.licenses_configured(name, licenses=None)
Configures licenses on the cluster entity
.INDENT 7.0
.TP
.B Checks if each license exists on the server:
.INDENT 7.0
.IP \(bu 2
if it doesn\(aqt, it creates it
.UNINDENT
.TP
.B Check if license is assigned to the cluster:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B if it\(aqs not assigned to the cluster:
.INDENT 7.0
.IP \(bu 2
assign it to the cluster if there is space
.IP \(bu 2
error if there\(aqs no space
.UNINDENT
.UNINDENT
.IP \(bu 2
if it\(aqs assigned to the cluster nothing needs to be done
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.esxcluster.vsan_datastore_configured(name, datastore_name)
Configures the cluster\(aqs VSAN datastore
.sp
WARNING: The VSAN datastore is created automatically after the first
ESXi host is added to the cluster; the state assumes that the datastore
exists and errors if it doesn\(aqt.
.UNINDENT
.SS salt.states.esxdatacenter
.sp
Salt states to create and manage VMware vSphere datacenters (datacenters).
.INDENT 0.0
.TP
.B codeauthor
\fIAlexandru Bleotu <alexandru.bleotu@morganstaley.com>\fP
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be deprecated in a future release of Salt. VMware strongly
recommends using the
\fI\%VMware Salt extensions\fP
instead of the ESX data center module. Because the Salt extensions are newer
and actively supported by VMware, they are more compatible with current
versions of ESXi and they work well with the latest features in the VMware
product line.
.UNINDENT
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
pyVmomi Python Module
.UNINDENT
.SS States
.SS datacenter_configured
.sp
Makes sure a datacenter exists and is correctly configured.
.sp
If the state is run by an \fBesxdatacenter\fP minion, the name of the datacenter
is retrieved from the proxy details, otherwise the datacenter has the same name
as the state.
.sp
Supported proxies: esxdatacenter
.sp
Example:
.sp
1. Make sure that a datacenter named \fBtarget_dc\fP exists on the vCenter, using a
\fBesxdatacenter\fP proxy:
.sp
Proxy minion configuration (connects passthrough to the vCenter):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: esxdatacenter
  datacenter: target_dc
  vcenter: vcenter.fake.com
  mechanism: sspi
  domain: fake.com
  principal: host
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
State configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
datacenter_state:
  esxdatacenter.datacenter_configured
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.esxdatacenter.datacenter_configured(name)
Makes sure a datacenter exists.
.sp
If the state is run by an \fBesxdatacenter\fP minion, the name of the
datacenter is retrieved from the proxy details, otherwise the datacenter
has the same name as the state.
.sp
Supported proxies: esxdatacenter
.INDENT 7.0
.TP
.B name:
Datacenter name. Ignored if the proxytype is \fBesxdatacenter\fP\&.
.UNINDENT
.UNINDENT
.SS salt.states.esxi
.sp
Manage VMware ESXi Hosts.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be deprecated in a future release of Salt. VMware strongly
recommends using the
\fI\%VMware Salt extensions\fP
instead of the ESXi module. Because the Salt extensions are newer and
actively supported by VMware, they are more compatible with current versions
of ESXi and they work well with the latest features in the VMware product
line.
.UNINDENT
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
pyVmomi Python Module
.IP \(bu 2
ESXCLI
.UNINDENT
.SS pyVmomi
.sp
PyVmomi can be installed via pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Version 6.0 of pyVmomi has some problems with SSL error handling on certain
versions of Python. If using version 6.0 of pyVmomi, Python 2.6,
Python 2.7.9, or newer must be present. This is due to an upstream dependency
in pyVmomi 6.0 that is not supported in Python versions 2.7 to 2.7.8. If the
version of Python is not in the supported range, you will need to install an
earlier version of pyVmomi. See \fI\%Issue #29537\fP for more information.
.UNINDENT
.UNINDENT
.sp
Based on the note above, to install an earlier version of pyVmomi than the
version currently listed in PyPi, run the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi==5.5.0.2014.1.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The 5.5.0.2014.1.1 is a known stable version that this original ESXi State
Module was developed against.
.SS ESXCLI
.sp
Currently, about a third of the functions used in the vSphere Execution Module require
the ESXCLI package be installed on the machine running the Proxy Minion process.
.sp
The ESXCLI package is also referred to as the VMware vSphere CLI, or vCLI. VMware
provides vCLI package installation instructions for \fI\%vSphere 5.5\fP and
\fI\%vSphere 6.0\fP\&.
.sp
Once all of the required dependencies are in place and the vCLI package is
installed, you can check to see if you can connect to your ESXi host or vCenter
server by running the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
esxcli \-s <host\-location> \-u <username> \-p <password> system syslog config get
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the connection was successful, ESXCLI was successfully installed on your system.
You should see output related to the ESXi host\(aqs syslog configuration.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Be aware that some functionality in this state module may depend on the
type of license attached to the ESXi host.
.sp
For example, certain services are only available to manipulate service state
or policies with a VMware vSphere Enterprise or Enterprise Plus license, while
others are available with a Standard license. The \fBntpd\fP service is restricted
to an Enterprise Plus license, while \fBssh\fP is available via the Standard
license.
.sp
Please see the \fI\%vSphere Comparison\fP page for more information.
.UNINDENT
.UNINDENT
.SS About
.sp
This state module was written to be used in conjunction with Salt\(aqs
\fI\%ESXi Proxy Minion\fP\&. For a tutorial on how to use Salt\(aqs
ESXi Proxy Minion, please refer to the
\fI\%ESXi Proxy Minion Tutorial\fP for
configuration examples, dependency installation instructions, how to run remote
execution functions against ESXi hosts via a Salt Proxy Minion, and a larger state
example.
.INDENT 0.0
.TP
.B salt.states.esxi.coredump_configured(name, enabled, dump_ip, host_vnic=\(aqvmk0\(aq, dump_port=6500)
Ensures a host\(aqs core dump configuration.
.INDENT 7.0
.TP
.B name
Name of the state.
.TP
.B enabled
Sets whether or not ESXi core dump collection should be enabled.
This is a boolean value set to \fBTrue\fP or \fBFalse\fP to enable
or disable core dumps.
.sp
Note that ESXi requires that the core dump must be enabled before
any other parameters may be set. This also affects the \fBchanges\fP
results in the state return dictionary. If \fBenabled\fP is \fBFalse\fP,
we can\(aqt obtain any previous settings to compare other state variables,
resulting in many \fBold\fP references returning \fBNone\fP\&.
.sp
Once \fBenabled\fP is \fBTrue\fP the \fBchanges\fP dictionary comparisons
will be more accurate. This is due to the way the system coredemp
network configuration command returns data.
.TP
.B dump_ip
The IP address of host that will accept the dump.
.TP
.B host_vnic
Host VNic port through which to communicate. Defaults to \fBvmk0\fP\&.
.TP
.B dump_port
TCP port to use for the dump. Defaults to \fB6500\fP\&.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
configure\-host\-coredump:
  esxi.coredump_configured:
    \- enabled: True
    \- dump_ip: \(aqmy\-coredump\-ip.example.com\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.esxi.diskgroups_configured(name, diskgroups, erase_disks=False)
Configures the disk groups to use for vsan.
.sp
This function will do the following:
.INDENT 7.0
.IP 1. 3
Check whether or not all disks in the diskgroup spec exist, and raises
and errors if they do not.
.IP 2. 3
Create diskgroups with the correct disk configurations if diskgroup
(identified by the cache disk canonical name) doesn\(aqt exist
.IP 3. 3
Adds extra capacity disks to the existing diskgroup
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqcache_scsi_addr\(aq: \(aqvmhba1:C0:T0:L0\(aq,
    \(aqcapacity_scsi_addrs\(aq: [
        \(aqvmhba2:C0:T0:L0\(aq,
        \(aqvmhba3:C0:T0:L0\(aq,
        \(aqvmhba4:C0:T0:L0\(aq,
    ]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Mandatory state name
.TP
.B diskgroups
Disk group representation containing scsi disk addresses.
Scsi addresses are expected for disks in the diskgroup:
.TP
.B erase_disks
Specifies whether to erase all partitions on all disks member of the
disk group before the disk group is created. Default value is False.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.esxi.host_cache_configured(name, enabled, datastore, swap_size=\(aq100%\(aq, dedicated_backing_disk=False, erase_backing_disk=False)
Configures the host cache used for swapping.
.sp
It will do the following:
.INDENT 7.0
.IP 1. 3
Checks if backing disk exists
.IP 2. 3
Creates the VMFS datastore if doesn\(aqt exist (datastore partition will be
created and use the entire disk)
.IP 3. 3
Raises an error if \fBdedicated_backing_disk\fP is \fBTrue\fP and partitions
already exist on the backing disk
.IP 4. 3
Configures host_cache to use a portion of the datastore for caching
(either a specific size or a percentage of the datastore)
.UNINDENT
.sp
Examples
.sp
Percentage swap size (can\(aqt be 100%)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqenabled\(aq: true,
    \(aqdatastore\(aq: {
        \(aqbacking_disk_scsi_addr\(aq: \(aqvmhba0:C0:T0:L0\(aq,
        \(aqvmfs_version\(aq: 5,
        \(aqname\(aq: \(aqhostcache\(aq
        }
    \(aqdedicated_backing_disk\(aq: false
    \(aqswap_size\(aq: \(aq98%\(aq,
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Fixed sized swap size
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqenabled\(aq: true,
    \(aqdatastore\(aq: {
        \(aqbacking_disk_scsi_addr\(aq: \(aqvmhba0:C0:T0:L0\(aq,
        \(aqvmfs_version\(aq: 5,
        \(aqname\(aq: \(aqhostcache\(aq
        }
    \(aqdedicated_backing_disk\(aq: true
    \(aqswap_size\(aq: \(aq10GiB\(aq,
}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Mandatory state name.
.TP
.B enabled
Specifies whether the host cache is enabled.
.TP
.B datastore
Specifies the host cache datastore.
.TP
.B swap_size
Specifies the size of the host cache swap. Can be a percentage or a
value in GiB. Default value is \fB100%\fP\&.
.TP
.B dedicated_backing_disk
Specifies whether the backing disk is dedicated to the host cache which
means it must have no other partitions. Default is False
.TP
.B erase_backing_disk
Specifies whether to erase all partitions on the backing disk before
the datastore is created. Default value is False.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.esxi.ntp_configured(name, service_running, ntp_servers=None, service_policy=None, service_restart=False, update_datetime=False)
Ensures a host\(aqs NTP server configuration such as setting NTP servers, ensuring the
NTP daemon is running or stopped, or restarting the NTP daemon for the ESXi host.
.INDENT 7.0
.TP
.B name
Name of the state.
.TP
.B service_running
Ensures the running state of the ntp daemon for the host. Boolean value where
\fBTrue\fP indicates that ntpd should be running and \fBFalse\fP indicates that it
should be stopped.
.TP
.B ntp_servers
A list of servers that should be added to the ESXi host\(aqs NTP configuration.
.TP
.B service_policy
The policy to set for the NTP service.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When setting the service policy to \fBoff\fP or \fBon\fP, you \fImust\fP quote the
setting. If you don\(aqt, the yaml parser will set the string to a boolean,
which will cause trouble checking for stateful changes and will error when
trying to set the policy on the ESXi host.
.UNINDENT
.UNINDENT
.TP
.B service_restart
If set to \fBTrue\fP, the ntp daemon will be restarted, regardless of its previous
running state. Default is \fBFalse\fP\&.
.TP
.B update_datetime
If set to \fBTrue\fP, the date/time on the given host will be updated to UTC.
Default setting is \fBFalse\fP\&. This option should be used with caution since
network delays and execution delays can result in time skews.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
configure\-host\-ntp:
  esxi.ntp_configured:
    \- service_running: True
    \- ntp_servers:
      \- 192.174.1.100
      \- 192.174.1.200
    \- service_policy: \(aqon\(aq
    \- service_restart: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.esxi.password_present(name, password)
Ensures the given password is set on the ESXi host. Passwords cannot be obtained from
host, so if a password is set in this state, the \fBvsphere.update_host_password\fP
function will always run (except when using test=True functionality) and the state\(aqs
changes dictionary will always be populated.
.sp
The username for which the password will change is the same username that is used to
authenticate against the ESXi host via the Proxy Minion. For example, if the pillar
definition for the proxy username is defined as \fBroot\fP, then the username that the
password will be updated for via this state is \fBroot\fP\&.
.INDENT 7.0
.TP
.B name
Name of the state.
.TP
.B password
The new password to change on the host.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
configure\-host\-password:
  esxi.password_present:
    \- password: \(aqnew\-bad\-password\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.esxi.ssh_configured(name, service_running, ssh_key=None, ssh_key_file=None, service_policy=None, service_restart=False, certificate_verify=None)
Manage the SSH configuration for a host including whether or not SSH is running or
the presence of a given SSH key. Note: Only one ssh key can be uploaded for root.
Uploading a second key will replace any existing key.
.INDENT 7.0
.TP
.B name
Name of the state.
.TP
.B service_running
Ensures whether or not the SSH service should be running on a host. Represented
as a boolean value where \fBTrue\fP indicates that SSH should be running and
\fBFalse\fP indicates that SSH should stopped.
.sp
In order to update SSH keys, the SSH service must be running.
.TP
.B ssh_key
Public SSH key to added to the authorized_keys file on the ESXi host. You can
use \fBssh_key\fP or \fBssh_key_file\fP, but not both.
.TP
.B ssh_key_file
File containing the public SSH key to be added to the authorized_keys file on
the ESXi host. You can use \fBssh_key_file\fP or \fBssh_key\fP, but not both.
.TP
.B service_policy
The policy to set for the NTP service.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When setting the service policy to \fBoff\fP or \fBon\fP, you \fImust\fP quote the
setting. If you don\(aqt, the yaml parser will set the string to a boolean,
which will cause trouble checking for stateful changes and will error when
trying to set the policy on the ESXi host.
.UNINDENT
.UNINDENT
.TP
.B service_restart
If set to \fBTrue\fP, the SSH service will be restarted, regardless of its
previous running state. Default is \fBFalse\fP\&.
.TP
.B certificate_verify
If set to \fBTrue\fP, the SSL connection must present a valid certificate.
Default is \fBTrue\fP\&.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
configure\-host\-ssh:
  esxi.ssh_configured:
    \- service_running: True
    \- ssh_key_file: /etc/salt/ssh_keys/my_key.pub
    \- service_policy: \(aqon\(aq
    \- service_restart: True
    \- certificate_verify: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.esxi.syslog_configured(name, syslog_configs, firewall=True, reset_service=True, reset_syslog_config=False, reset_configs=None)
Ensures the specified syslog configuration parameters. By default,
this state will reset the syslog service after any new or changed
parameters are set successfully.
.INDENT 7.0
.TP
.B name
Name of the state.
.TP
.B syslog_configs
Name of parameter to set (corresponds to the command line switch for
esxcli without the double dashes (\-\-))
.sp
Valid syslog_config values are \fBlogdir\fP, \fBloghost\fP, \fBlogdir\-unique\fP,
\fBdefault\-rotate\fP, \fBdefault\-size\fP, and \fBdefault\-timeout\fP\&.
.sp
Each syslog_config option also needs a configuration value to set.
For example, \fBloghost\fP requires URLs or IP addresses to use for
logging. Multiple log servers can be specified by listing them,
comma\-separated, but without spaces before or after commas
.sp
(reference: \fI\%https://blogs.vmware.com/vsphere/2012/04/configuring\-multiple\-syslog\-servers\-for\-esxi\-5.html\fP)
.TP
.B firewall
Enable the firewall rule set for syslog. Defaults to \fBTrue\fP\&.
.TP
.B reset_service
After a successful parameter set, reset the service. Defaults to \fBTrue\fP\&.
.TP
.B reset_syslog_config
Resets the syslog service to its default settings. Defaults to \fBFalse\fP\&.
If set to \fBTrue\fP, default settings defined by the list of syslog configs
in \fBreset_configs\fP will be reset before running any other syslog settings.
.TP
.B reset_configs
A comma\-delimited list of parameters to reset. Only runs if
\fBreset_syslog_config\fP is set to \fBTrue\fP\&. If \fBreset_syslog_config\fP is set
to \fBTrue\fP, but no syslog configs are listed in \fBreset_configs\fP, then
\fBreset_configs\fP will be set to \fBall\fP by default.
.sp
See \fBsyslog_configs\fP parameter above for a list of valid options.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
configure\-host\-syslog:
  esxi.syslog_configured:
    \- syslog_configs:
        loghost: ssl://localhost:5432,tcp://10.1.0.1:1514
        default\-timeout: 120
    \- firewall: True
    \- reset_service: True
    \- reset_syslog_config: True
    \- reset_configs: loghost,default\-timeout
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.esxi.vmotion_configured(name, enabled, device=\(aqvmk0\(aq)
Configures a host\(aqs VMotion properties such as enabling VMotion and setting
the device VirtualNic that VMotion will use.
.INDENT 7.0
.TP
.B name
Name of the state.
.TP
.B enabled
Ensures whether or not VMotion should be enabled on a host as a boolean
value where \fBTrue\fP indicates that VMotion should be enabled and \fBFalse\fP
indicates that VMotion should be disabled.
.TP
.B device
The device that uniquely identifies the VirtualNic that will be used for
VMotion for the host. Defaults to \fBvmk0\fP\&.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
configure\-vmotion:
  esxi.vmotion_configured:
    \- enabled: True
    \- device: sample\-device
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.esxi.vsan_configured(name, enabled, add_disks_to_vsan=False)
Configures a host\(aqs VSAN properties such as enabling or disabling VSAN, or
adding VSAN\-eligible disks to the VSAN system for the host.
.INDENT 7.0
.TP
.B name
Name of the state.
.TP
.B enabled
Ensures whether or not VSAN should be enabled on a host as a boolean
value where \fBTrue\fP indicates that VSAN should be enabled and \fBFalse\fP
indicates that VSAN should be disabled.
.TP
.B add_disks_to_vsan
If set to \fBTrue\fP, any VSAN\-eligible disks for the given host will be added
to the host\(aqs VSAN system. Default is \fBFalse\fP\&.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
configure\-host\-vsan:
  esxi.vsan_configured:
    \- enabled: True
    \- add_disks_to_vsan: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.esxvm
.sp
Salt state to create, update VMware ESXi Virtual Machines.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be deprecated in a future release of Salt. VMware strongly
recommends using the
\fI\%VMware Salt extensions\fP
instead of the ESX VSM module. Because the Salt extensions are newer and
actively supported by VMware, they are more compatible with current versions
of ESXi and they work well with the latest features in the VMware product
line.
.UNINDENT
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
pyVmomi
.IP \(bu 2
jsonschema
.UNINDENT
.SS States
.SS vm_configured
.sp
Enforces correct virtual machine configuration. Creates, updates and registers
a virtual machine.
.sp
This state identifies the action which should be taken for the virtual machine
and applies that action via the create, update, register state functions.
.sp
Supported proxies: esxvm
.sp
Example:
.INDENT 0.0
.IP 1. 3
Get the virtual machine \fBmy_vm\fP status with an \fBesxvm\fP proxy:
.UNINDENT
.sp
Proxy minion configuration for \fBesxvm\fP proxy:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: esxvm
  datacenter: my_dc
  vcenter: vcenter.fake.com
  mechanism: sspi
  domain: fake.com
  principal: host
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
State configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myvm_state:
  esxvm.vm_configured:
  \- vm_name: my_vm
  \- cpu: {{ {\(aqcount\(aq: 4, \(aqcores_per_socket\(aq: 2} }}
  \- memory: {{ {\(aqsize\(aq: 16384, \(aqunit\(aq: \(aqMB\(aq} }}
  \- image: rhel7_64Guest
  \- version: vmx\-12
  \- interfaces: {{ [{
                     \(aqadapter\(aq: \(aqNetwork adapter 1\(aq,
                     \(aqname\(aq: \(aqmy_pg1\(aq,
                     \(aqswitch_type\(aq: \(aqdistributed\(aq,
                     \(aqadapter_type\(aq: \(aqvmxnet3\(aq,
                     \(aqmac\(aq: \(aq00:50:56:00:01:02,
                     \(aqconnectable\(aq: { \(aqstart_connected\(aq: true,
                                      \(aqallow_guest_control\(aq: true,
                                      \(aqconnected\(aq: true}},
                     {
                     \(aqadapter\(aq: \(aqNetwork adapter 2\(aq,
                     \(aqname\(aq: \(aqmy_pg2\(aq,
                     \(aqswitch_type\(aq: \(aqdistributed\(aq,
                     \(aqadapter_type\(aq: \(aqvmxnet3\(aq,
                     \(aqmac\(aq: \(aq00:50:56:00:01:03\(aq,
                     \(aqconnectable\(aq: { \(aqstart_connected\(aq: true,
                                      \(aqallow_guest_control\(aq: true,
                                      \(aqconnected\(aq: true}}
                ] }}
  \- disks: {{ [{
                \(aqadapter\(aq: \(aqHard disk 1\(aq,
                \(aqunit\(aq: \(aqMB\(aq,
                \(aqsize\(aq: 51200,
                \(aqfilename\(aq: \(aqmy_vm/sda.vmdk\(aq,
                \(aqdatastore\(aq: \(aqmy_datastore\(aq,
                \(aqaddress\(aq: \(aq0:0\(aq,
                \(aqthin_provision\(aq: true,
                \(aqeagerly_scrub\(aq: false,
                \(aqcontroller\(aq: \(aqSCSI controller 0\(aq},
                {
                \(aqadapter\(aq: \(aqHard disk 2\(aq,
                \(aqunit\(aq: \(aqMB\(aq,
                \(aqsize\(aq: 10240,
                \(aqfilename\(aq: \(aqmy_vm/sdb.vmdk\(aq,
                \(aqdatastore\(aq: \(aqmy_datastore\(aq,
                \(aqaddress\(aq: \(aq0:1\(aq,
                \(aqthin_provision\(aq: true,
                \(aqeagerly_scrub\(aq: false,
                \(aqcontroller\(aq: \(aqSCSI controller 0\(aq}
          ] }}
  \- scsi_devices: {{ [{
                       \(aqadapter\(aq: \(aqSCSI controller 0\(aq,
                       \(aqtype\(aq: \(aqparavirtual\(aq,
                       \(aqbus_sharing\(aq: \(aqno_sharing\(aq,
                       \(aqbus_number\(aq: 0}
                      ] }}
  \- serial_ports: {{ [{
                       \(aqadapter\(aq: \(aqSerial port 1\(aq,
                       \(aqtype\(aq: \(aqnetwork\(aq,
                       \(aqyield\(aq: false,
                       \(aqbacking\(aq: {
                                   \(aquri\(aq: \(aqmy_uri\(aq,
                                   \(aqdirection\(aq: \(aqserver\(aq,
                                   \(aqfilename\(aq: \(aqmy_file\(aq},
                        \(aqconnectable\(aq: {
                                        \(aqstart_connected\(aq: true,
                                        \(aqallow_guest_control\(aq: true,
                                        \(aqconnected\(aq: true}}
                       ] }}
  \- datacenter: {{ \(aqmy_dc\(aq }}
  \- datastore: \(aqmy_datastore\(aq
  \- placement: {{ {\(aqcluster\(aq: \(aqmy_cluster\(aq} }}
  \- cd_dvd_drives: {{ [] }}
  \- advanced_configs: {{ {\(aqmy_param\(aq: \(aq1\(aq} }}
  \- template: false
  \- tools: false
  \- power_on: false
  \- deploy: false
.ft P
.fi
.UNINDENT
.UNINDENT
.SS vm_updated
.sp
Updates a virtual machine to a given configuration.
.SS vm_created
.sp
Creates a virtual machine with a given configuration.
.SS vm_registered
.sp
Registers a virtual machine with its configuration file path.
.SS Dependencies
.SS pyVmomi
.sp
PyVmomi can be installed via pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Version 6.0 of pyVmomi has some problems with SSL error handling on
certain versions of Python. If using version 6.0 of pyVmomi, Python 2.6,
Python 2.7.9, or newer must be present. This is due to an upstream
dependency in pyVmomi 6.0 that is not supported in Python versions
2.7 to 2.7.8. If the version of Python is not in the supported range,
you will need to install an earlier version of pyVmomi.
See \fI\%Issue #29537\fP for more information.
.UNINDENT
.UNINDENT
.sp
Based on the note above, to install an earlier version of pyVmomi than the
version currently listed in PyPi, run the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi==6.0.0.2016.4
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The 5.5.0.2014.1.1 is a known stable version that this original ESXi State
Module was developed against. To be able to connect through SSPI you must
use pyvmomi 6.0.0.2016.4 or above. The ESXVM State Module was tested with
this version.
.SS About
.sp
This state module was written to be used in conjunction with Salt\(aqs
\fI\%ESXi Proxy Minion\fP For a tutorial on how to use Salt\(aqs
ESXi Proxy Minion, please refer to the
\fI\%ESXi Proxy Minion Tutorial\fP for
configuration examples, dependency installation instructions, how to run remote
execution functions against ESXi hosts via a Salt Proxy Minion, and a larger state
example.
.INDENT 0.0
.TP
.B salt.states.esxvm.vm_cloned(name)
Clones a virtual machine from a template virtual machine if it doesn\(aqt
exist and a template is defined.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.esxvm.vm_configured(name, vm_name, cpu, memory, image, version, interfaces, disks, scsi_devices, serial_ports, datacenter, datastore, placement, cd_dvd_drives=None, sata_controllers=None, advanced_configs=None, template=None, tools=True, power_on=False, deploy=False)
Selects the correct operation to be executed on a virtual machine, non
existing machines will be created, existing ones will be updated if the
config differs.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.esxvm.vm_created(name, vm_name, cpu, memory, image, version, interfaces, disks, scsi_devices, serial_ports, datacenter, datastore, placement, ide_controllers=None, sata_controllers=None, cd_dvd_drives=None, advanced_configs=None, power_on=False)
Creates a virtual machine with the given properties if it doesn\(aqt exist.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.esxvm.vm_registered(vm_name, datacenter, placement, vm_file, power_on=False)
Registers a virtual machine if the machine files are available on
the main datastore.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.esxvm.vm_updated(name, vm_name, cpu, memory, image, version, interfaces, disks, scsi_devices, serial_ports, datacenter, datastore, cd_dvd_drives=None, sata_controllers=None, advanced_configs=None, power_on=False)
Updates a virtual machine configuration if there is a difference between
the given and deployed configuration.
.UNINDENT
.SS salt.states.etcd_mod
.SS Manage etcd Keys
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
python\-etcd or etcd3\-py
.UNINDENT
.UNINDENT
.sp
This state module supports setting and removing keys from etcd.
.SS Configuration
.sp
To work with an etcd server you must configure an etcd profile. The etcd config
can be set in either the Salt Minion configuration file or in pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_etd_config:
  etcd.host: 127.0.0.1
  etcd.port: 4001
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is technically possible to configure etcd without using a profile, but this
is not considered to be a best practice, especially when multiple etcd servers
or clusters are available.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.host: 127.0.0.1
etcd.port: 4001
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In order to choose whether to use etcd API v2 or v3, you can put the following
configuration option in the same place as your etcd configuration.  This option
defaults to true, meaning you will use v2 unless you specify otherwise.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.require_v2: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When using API v3, there are some specific options available to be configured
within your etcd profile.  They are defaulted to the following...
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
etcd.encode_keys: False
etcd.encode_values: True
etcd.raw_keys: False
etcd.raw_values: False
etcd.unicode_errors: \(dqsurrogateescape\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBetcd.encode_keys\fP indicates whether you want to pre\-encode keys using msgpack before
adding them to etcd.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you set \fBetcd.encode_keys\fP to \fBTrue\fP, all recursive functionality will no longer work.
This includes \fBtree\fP and \fBls\fP and all other methods if you set \fBrecurse\fP/\fBrecursive\fP to \fBTrue\fP\&.
This is due to the fact that when encoding with msgpack, keys like \fB/salt\fP and \fB/salt/stack\fP will have
differing byte prefixes, and etcd v3 searches recursively using prefixes.
.UNINDENT
.UNINDENT
.sp
\fBetcd.encode_values\fP indicates whether you want to pre\-encode values using msgpack before
adding them to etcd.  This defaults to \fBTrue\fP to avoid data loss on non\-string values wherever possible.
.sp
\fBetcd.raw_keys\fP determines whether you want the raw key or a string returned.
.sp
\fBetcd.raw_values\fP determines whether you want the raw value or a string returned.
.sp
\fBetcd.unicode_errors\fP determines what you policy to follow when there are encoding/decoding errors.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The etcd configuration can also be set in the Salt Master config file,
but in order to use any etcd configurations defined in the Salt Master
config, the \fI\%pillar_opts\fP must be set to \fBTrue\fP\&.
.sp
Be aware that setting \fBpillar_opts\fP to \fBTrue\fP has security implications
as this makes all master configuration settings available in all minion\(aqs
pillars.
.UNINDENT
.UNINDENT
.sp
Etcd profile configuration can be overridden using following arguments: \fBhost\fP,
\fBport\fP, \fBusername\fP, \fBpassword\fP, \fBca\fP, \fBclient_key\fP and \fBclient_cert\fP\&.
The v3 specific arguments can also be used for overriding if you are using v3.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-value:
  etcd.set:
    \- name: /path/to/key
    \- value: value
    \- host: 127.0.0.1
    \- port: 2379
    \- username: user
    \- password: pass
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Available Functions
.INDENT 0.0
.IP \(bu 2
\fBset\fP
.sp
This will set a value to a key in etcd. Changes will be returned if the key
has been created or the value of the key has been updated. This
means you can watch these states for changes.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
/foo/bar/baz:
  etcd.set:
    \- value: foo
    \- profile: my_etcd_config
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBwait_set\fP
.sp
Performs the same functionality as \fBset\fP but only if a watch requisite is \fBTrue\fP\&.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
/some/file.txt:
  file.managed:
    \- source: salt://file.txt

/foo/bar/baz:
  etcd.wait_set:
    \- value: foo
    \- profile: my_etcd_config
    \- watch:
      \- file: /some/file.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBrm\fP
.sp
This will delete a key from etcd. If the key exists then changes will be
returned and thus you can watch for changes on the state, if the key does
not exist then no changes will occur.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
/foo/bar/baz:
  etcd.rm:
    \- profile: my_etcd_config
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBwait_rm\fP
.sp
Performs the same functionality as \fBrm\fP but only if a watch requisite is \fBTrue\fP\&.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
/some/file.txt:
  file.managed:
    \- source: salt://file.txt

/foo/bar/baz:
  etcd.wait_rm:
    \- profile: my_etcd_config
    \- watch:
      \- file: /some/file.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.etcd_mod.directory(name, profile=None, **kwargs)
Create a directory in etcd.
.INDENT 7.0
.TP
.B name
The etcd directory name, for example: \fB/foo/bar/baz\fP\&.
.TP
.B profile
Optional, defaults to \fBNone\fP\&. Sets the etcd profile to use which has
been defined in the Salt Master config.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my_etd_config:
  etcd.host: 127.0.0.1
  etcd.port: 4001
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.etcd_mod.mod_watch(name, **kwargs)
The etcd watcher, called to invoke the watch command.
When called, execute a etcd function based on a watch call requisite.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state exists to support special handling of the \fBwatch\fP
\fI\%requisite\fP\&. It should not be called directly.
.sp
Parameters for this function should be set by the state being triggered.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.etcd_mod.rm(name, recurse=False, profile=None, **kwargs)
Deletes a key from etcd
.INDENT 7.0
.TP
.B name
The etcd key name to remove, for example \fB/foo/bar/baz\fP\&.
.TP
.B recurse
Optional, defaults to \fBFalse\fP\&. If \fBTrue\fP performs a recursive delete.
.TP
.B profile
Optional, defaults to \fBNone\fP\&. Sets the etcd profile to use which has
been defined in the Salt Master config.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my_etd_config:
  etcd.host: 127.0.0.1
  etcd.port: 4001
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.etcd_mod.set_(name, value, profile=None, **kwargs)
Set a key in etcd
.INDENT 7.0
.TP
.B name
The etcd key name, for example: \fB/foo/bar/baz\fP\&.
.TP
.B value
The value the key should contain.
.TP
.B profile
Optional, defaults to \fBNone\fP\&. Sets the etcd profile to use which has
been defined in the Salt Master config.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my_etd_config:
  etcd.host: 127.0.0.1
  etcd.port: 4001
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.etcd_mod.wait_rm(name, recurse=False, profile=None, **kwargs)
Deletes a key from etcd only if the watch statement calls it.
This function is also aliased as \fBwait_rm\fP\&.
.INDENT 7.0
.TP
.B name
The etcd key name to remove, for example \fB/foo/bar/baz\fP\&.
.TP
.B recurse
Optional, defaults to \fBFalse\fP\&. If \fBTrue\fP performs a recursive
delete, see: \fI\%https://python\-etcd.readthedocs.io/en/latest/#delete\-a\-key\fP\&.
.TP
.B profile
Optional, defaults to \fBNone\fP\&. Sets the etcd profile to use which has
been defined in the Salt Master config.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my_etd_config:
  etcd.host: 127.0.0.1
  etcd.port: 4001
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.etcd_mod.wait_set(name, value, profile=None, **kwargs)
Set a key in etcd only if the watch statement calls it. This function is
also aliased as \fBwait_set\fP\&.
.INDENT 7.0
.TP
.B name
The etcd key name, for example: \fB/foo/bar/baz\fP\&.
.TP
.B value
The value the key should contain.
.TP
.B profile
The etcd profile to use that has been configured on the Salt Master,
this is optional and defaults to \fBNone\fP\&.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my_etd_config:
  etcd.host: 127.0.0.1
  etcd.port: 4001
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.ethtool
.sp
Configuration of network device
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B codeauthor
Krzysztof Pawlowski <\fI\%msciciel@msciciel.eu\fP>
.TP
.B maturity
new
.TP
.B depends
python\-ethtool
.TP
.B platform
linux
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
eth0:
  ethtool.coalesce:
    \- name: eth0
    \- rx_usecs: 24
    \- tx_usecs: 48

eth0:
  ethtool.ring:
    \- name: eth0
    \- rx: 1024
    \- tx: 1024

eth0:
  ethtool.offload:
    \- name: eth0
    \- tcp_segmentation_offload: on
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ethtool.coalesce(name, **kwargs)
Manage coalescing settings of network device
.INDENT 7.0
.TP
.B name
Interface name to apply coalescing settings
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
eth0:
  ethtool.coalesce:
    \- name: eth0
    \- adaptive_rx: on
    \- adaptive_tx: on
    \- rx_usecs: 24
    \- rx_frame: 0
    \- rx_usecs_irq: 0
    \- rx_frames_irq: 0
    \- tx_usecs: 48
    \- tx_frames: 0
    \- tx_usecs_irq: 0
    \- tx_frames_irq: 0
    \- stats_block_usecs: 0
    \- pkt_rate_low: 0
    \- rx_usecs_low: 0
    \- rx_frames_low: 0
    \- tx_usecs_low: 0
    \- tx_frames_low: 0
    \- pkt_rate_high: 0
    \- rx_usecs_high: 0
    \- rx_frames_high: 0
    \- tx_usecs_high: 0
    \- tx_frames_high: 0
    \- sample_interval: 0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ethtool.offload(name, **kwargs)
Manage protocol offload and other features of network device
.INDENT 7.0
.TP
.B name
Interface name to apply coalescing settings
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
eth0:
  ethtool.offload:
    \- name: eth0
    \- tcp_segmentation_offload: on
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ethtool.pause(name, **kwargs)
New in version 3006.0.

.sp
Manage pause parameters of network device
.INDENT 7.0
.TP
.B name
Interface name to apply pause parameters
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
eth0:
  ethtool.pause:
    \- name: eth0
    \- autoneg: off
    \- rx: off
    \- tx: off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ethtool.ring(name, **kwargs)
Manage rx/tx ring parameters of network device
.sp
Use \(aqmax\(aq word to set with factory maximum
.INDENT 7.0
.TP
.B name
Interface name to apply ring parameters
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
eth0:
  ethtool.ring:
    \- name: eth0
    \- rx: 1024
    \- rx_mini: 0
    \- rx_jumbo: 0
    \- tx: max
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.event
.sp
Send events through Salt\(aqs event system during state runs
.INDENT 0.0
.TP
.B salt.states.event.fire_master(name, data=None, preload=None, with_env=False, with_grains=False, with_pillar=False, show_changed=True, **kwargs)
This function is an alias of \fBsend\fP\&.
.INDENT 7.0
.INDENT 3.5
Send an event to the Salt Master
.sp
New in version 2014.7.0.

.sp
Accepts the same arguments as the \fI\%event.send\fP execution module of the same name,
with the additional argument:
.INDENT 0.0
.TP
.B param show_changed
If \fBTrue\fP, state will show as changed with the data
argument as the change value. If \fBFalse\fP, shows as unchanged.
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# ...snip bunch of states above

mycompany/mystaterun/status/update:
  event.send:
    \- data:
        status: \(dqHalf\-way through the state run!\(dq

# ...snip bunch of states below
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.event.mod_watch(name, data=None, preload=None, with_env=False, with_grains=False, with_pillar=False, show_changed=True, **kwargs)
This function is an alias of \fBsend\fP\&.
.INDENT 7.0
.INDENT 3.5
Send an event to the Salt Master
.sp
New in version 2014.7.0.

.sp
Accepts the same arguments as the \fI\%event.send\fP execution module of the same name,
with the additional argument:
.INDENT 0.0
.TP
.B param show_changed
If \fBTrue\fP, state will show as changed with the data
argument as the change value. If \fBFalse\fP, shows as unchanged.
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# ...snip bunch of states above

mycompany/mystaterun/status/update:
  event.send:
    \- data:
        status: \(dqHalf\-way through the state run!\(dq

# ...snip bunch of states below
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.event.send(name, data=None, preload=None, with_env=False, with_grains=False, with_pillar=False, show_changed=True, **kwargs)
Send an event to the Salt Master
.sp
New in version 2014.7.0.

.sp
Accepts the same arguments as the \fI\%event.send\fP execution module of the same name,
with the additional argument:
.INDENT 7.0
.TP
.B Parameters
\fBshow_changed\fP \-\- If \fBTrue\fP, state will show as changed with the data
argument as the change value. If \fBFalse\fP, shows as unchanged.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# ...snip bunch of states above

mycompany/mystaterun/status/update:
  event.send:
    \- data:
        status: \(dqHalf\-way through the state run!\(dq

# ...snip bunch of states below
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.event.wait(name, sfun=None, data=None)
Fire an event on the Salt master event bus if called from a watch statement
.sp
New in version 2014.7.0.

.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Stand up a new web server.
apache:
  pkg:
    \- installed
    \- name: httpd
  service:
    \- running
    \- enable: True
    \- name: httpd

# Notify the load balancer to update the pool once Apache is running.
refresh_pool:
  event:
    \- wait
    \- name: mycompany/loadbalancer/pool/update
    \- data:
        new_web_server_ip: {{ grains[\(aqipv4\(aq] | first() }}
    \- watch:
      \- pkg: apache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.file
.SS Operations on regular files, special files, directories, and symlinks
.sp
Salt States can aggressively manipulate files on a system. There are a number
of ways in which files can be managed.
.sp
Regular files can be enforced with the \fI\%file.managed\fP state. This state downloads files from the salt
master and places them on the target system. Managed files can be rendered as a
jinja, mako, or wempy template, adding a dynamic component to file management.
An example of \fI\%file.managed\fP which makes use of
the jinja templating system would look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/http/conf/http.conf:
  file.managed:
    \- source: salt://apache/http.conf
    \- user: root
    \- group: root
    \- mode: 644
    \- attrs: ai
    \- template: jinja
    \- defaults:
        custom_var: \(dqdefault value\(dq
        other_var: 123
{% if grains[\(aqos\(aq] == \(aqUbuntu\(aq %}
    \- context:
        custom_var: \(dqoverride\(dq
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is also possible to use the \fI\%py renderer\fP as a
templating option. The template would be a Python script which would need to
contain a function called \fBrun()\fP, which returns a string. All arguments
to the state will be made available to the Python script as globals. The
returned string will be the contents of the managed file. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def run():
    lines = [\(aqfoo\(aq, \(aqbar\(aq, \(aqbaz\(aq]
    lines.extend([source, name, user, context])  # Arguments as globals
    return \(aq\en\en\(aq.join(lines)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBdefaults\fP and \fBcontext\fP arguments require extra indentation (four
spaces instead of the normal two) in order to create a nested dictionary.
\fI\%More information\fP\&.
.UNINDENT
.UNINDENT
.sp
If using a template, any user\-defined template variables in the file defined in
\fBsource\fP must be passed in using the \fBdefaults\fP and/or \fBcontext\fP
arguments. The general best practice is to place default values in
\fBdefaults\fP, with conditional overrides going into \fBcontext\fP, as seen above.
.sp
The template will receive a variable \fBcustom_var\fP, which would be accessed in
the template using \fB{{ custom_var }}\fP\&. If the operating system is Ubuntu, the
value of the variable \fBcustom_var\fP would be \fIoverride\fP, otherwise it is the
default \fIdefault value\fP
.sp
The \fBsource\fP parameter can be specified as a list. If this is done, then the
first file to be matched will be the one that is used. This allows you to have
a default file on which to fall back if the desired file does not exist on the
salt fileserver. Here\(aqs an example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.managed:
    \- source:
      \- salt://foo.conf.{{ grains[\(aqfqdn\(aq] }}
      \- salt://foo.conf.fallback
    \- user: foo
    \- group: users
    \- mode: 644
    \- attrs: i
    \- backup: minion
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Salt supports backing up managed files via the backup option. For more
details on this functionality please review the
\fI\%backup_mode documentation\fP\&.
.UNINDENT
.UNINDENT
.sp
The \fBsource\fP parameter can also specify a file in another Salt environment.
In this example \fBfoo.conf\fP in the \fBdev\fP environment will be used instead.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.managed:
    \- source:
      \- \(aqsalt://foo.conf?saltenv=dev\(aq
    \- user: foo
    \- group: users
    \- mode: \(aq0644\(aq
    \- attrs: i
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
When using a mode that includes a leading zero you must wrap the
value in single quotes. If the value is not wrapped in quotes it
will be read by YAML as an integer and evaluated as an octal.
.UNINDENT
.UNINDENT
.sp
The \fBnames\fP parameter, which is part of the state compiler, can be used to
expand the contents of a single state declaration into multiple, single state
declarations. Each item in the \fBnames\fP list receives its own individual state
\fBname\fP and is converted into its own low\-data structure. This is a convenient
way to manage several files with similar attributes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt_master_conf:
  file.managed:
    \- user: root
    \- group: root
    \- mode: \(aq0644\(aq
    \- names:
      \- /etc/salt/master.d/master.conf:
        \- source: salt://saltmaster/master.conf
      \- /etc/salt/minion.d/minion\-99.conf:
        \- source: salt://saltmaster/minion.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
There is more documentation about this feature in the \fI\%Names declaration\fP section of the \fI\%Highstate docs\fP\&.
.UNINDENT
.UNINDENT
.sp
Special files can be managed via the \fBmknod\fP function. This function will
create and enforce the permissions on a special file. The function supports the
creation of character devices, block devices, and FIFO pipes. The function will
create the directory structure up to the special file if it is needed on the
minion. The function will not overwrite or operate on (change major/minor
numbers) existing special files with the exception of user, group, and
permissions. In most cases the creation of some special files require root
permissions on the minion. This would require that the minion to be run as the
root user. Here is an example of a character device:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/var/named/chroot/dev/random:
  file.mknod:
    \- ntype: c
    \- major: 1
    \- minor: 8
    \- user: named
    \- group: named
    \- mode: 660
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here is an example of a block device:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/var/named/chroot/dev/loop0:
  file.mknod:
    \- ntype: b
    \- major: 7
    \- minor: 0
    \- user: named
    \- group: named
    \- mode: 660
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here is an example of a fifo pipe:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/var/named/chroot/var/log/logfifo:
  file.mknod:
    \- ntype: p
    \- user: named
    \- group: named
    \- mode: 660
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Directories can be managed via the \fBdirectory\fP function. This function can
create and enforce the permissions on a directory. A directory statement will
look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/srv/stuff/substuf:
  file.directory:
    \- user: fred
    \- group: users
    \- mode: 755
    \- makedirs: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you need to enforce user and/or group ownership or permissions recursively
on the directory\(aqs contents, you can do so by adding a \fBrecurse\fP directive:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/srv/stuff/substuf:
  file.directory:
    \- user: fred
    \- group: users
    \- mode: 755
    \- makedirs: True
    \- recurse:
      \- user
      \- group
      \- mode
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As a default, \fBmode\fP will resolve to \fBdir_mode\fP and \fBfile_mode\fP, to
specify both directory and file permissions, use this form:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/srv/stuff/substuf:
  file.directory:
    \- user: fred
    \- group: users
    \- file_mode: 744
    \- dir_mode: 755
    \- makedirs: True
    \- recurse:
      \- user
      \- group
      \- mode
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Symlinks can be easily created; the symlink function is very simple and only
takes a few arguments:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/grub.conf:
  file.symlink:
    \- target: /boot/grub/grub.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Recursive directory management can also be set via the \fBrecurse\fP
function. Recursive directory management allows for a directory on the salt
master to be recursively copied down to the minion. This is a great tool for
deploying large code and configuration systems. A state using \fBrecurse\fP
would look something like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/opt/code/flask:
  file.recurse:
    \- source: salt://code/flask
    \- include_empty: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A more complex \fBrecurse\fP example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set site_user = \(aqtestuser\(aq %}
{% set site_name = \(aqtest_site\(aq %}
{% set project_name = \(aqtest_proj\(aq %}
{% set sites_dir = \(aqtest_dir\(aq %}

django\-project:
  file.recurse:
    \- name: {{ sites_dir }}/{{ site_name }}/{{ project_name }}
    \- user: {{ site_user }}
    \- dir_mode: 2775
    \- file_mode: \(aq0644\(aq
    \- template: jinja
    \- source: salt://project/templates_dir
    \- include_empty: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Retention scheduling can be applied to manage contents of backup directories.
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/var/backups/example_directory:
  file.retention_schedule:
    \- strptime_format: example_name_%Y%m%dT%H%M%S.tar.bz2
    \- retain:
        most_recent: 5
        first_of_hour: 4
        first_of_day: 14
        first_of_week: 6
        first_of_month: 6
        first_of_year: all
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.absent(name, **kwargs)
Make sure that the named file or directory is absent. If it exists, it will
be deleted. This will work to reverse any of the functions in the file
state module. If a directory is supplied, it will be recursively deleted.
.sp
If only the contents of the directory need to be deleted but not the directory
itself, use \fI\%file.directory\fP with \fBclean=True\fP
.INDENT 7.0
.TP
.B name
The path which should be deleted
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.accumulated(name, filename, text, **kwargs)
Prepare accumulator which can be used in template in file.managed state.
Accumulator dictionary becomes available in template. It can also be used
in file.blockreplace.
.INDENT 7.0
.TP
.B name
Accumulator name
.TP
.B filename
Filename which would receive this accumulator (see file.managed state
documentation about \fBname\fP)
.TP
.B text
String or list for adding in accumulator
.TP
.B require_in / watch_in
One of them required for sure we fill up accumulator before we manage
the file. Probably the same as filename
.UNINDENT
.sp
Example:
.sp
Given the following:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
animals_doing_things:
  file.accumulated:
    \- filename: /tmp/animal_file.txt
    \- text: \(aq jumps over the lazy dog.\(aq
    \- require_in:
      \- file: animal_file

animal_file:
  file.managed:
    \- name: /tmp/animal_file.txt
    \- source: salt://animal_file.txt
    \- template: jinja
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
One might write a template for \fBanimal_file.txt\fP like the following:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
The quick brown fox{% for animal in accumulator[\(aqanimals_doing_things\(aq] %}{{ animal }}{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Collectively, the above states and template file will produce:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
The quick brown fox jumps over the lazy dog.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple accumulators can be \(dqchained\(dq together.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \(aqaccumulator\(aq data structure is a Python dictionary.
Do not expect any loop over the keys in a deterministic order!
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.append(name, text=None, makedirs=False, source=None, source_hash=None, template=\(aqjinja\(aq, sources=None, source_hashes=None, defaults=None, context=None, ignore_whitespace=True)
Ensure that some text appears at the end of a file.
.sp
The text will not be appended if it already exists in the file.
A single string of text or a list of strings may be appended.
.INDENT 7.0
.TP
.B name
The location of the file to append to.
.TP
.B text
The text to be appended, which can be a single string or a list
of strings.
.TP
.B makedirs
If the file is located in a path without a parent directory,
then the state will fail. If makedirs is set to True, then
the parent directories will be created to facilitate the
creation of the named file. Defaults to False.
.TP
.B source
A single source file to append. This source file can be hosted on either
the salt master server, or on an HTTP or FTP server. Both HTTPS and
HTTP are supported as well as downloading directly from Amazon S3
compatible URLs with both pre\-configured and automatic IAM credentials
(see s3.get state documentation). File retrieval from Openstack Swift
object storage is supported via swift://container/object_path URLs
(see swift.get documentation).
.sp
For files hosted on the salt file server, if the file is located on
the master in the directory named spam, and is called eggs, the source
string is salt://spam/eggs.
.sp
If the file is hosted on an HTTP or FTP server, the source_hash argument
is also required.
.TP
.B source_hash
.INDENT 7.0
.TP
.B This can be one of the following:
.INDENT 7.0
.IP 1. 3
a source hash string
.IP 2. 3
the URI of a file that contains source hash strings
.UNINDENT
.UNINDENT
.sp
The function accepts the first encountered long unbroken alphanumeric
string of correct length as a valid hash, in order from most secure to
least secure:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Type    Length
======  ======
sha512     128
sha384      96
sha256      64
sha224      56
sha1        40
md5         32
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See the \fBsource_hash\fP parameter description for \fI\%file.managed\fP function for more details and examples.
.TP
.B template
The named templating engine will be used to render the appended\-to file.
Defaults to \fBjinja\fP\&. The following templates are supported:
.INDENT 7.0
.IP \(bu 2
\fI\%cheetah\fP
.IP \(bu 2
\fI\%genshi\fP
.IP \(bu 2
\fI\%jinja\fP
.IP \(bu 2
\fI\%mako\fP
.IP \(bu 2
\fI\%py\fP
.IP \(bu 2
\fI\%wempy\fP
.UNINDENT
.TP
.B sources
A list of source files to append. If the files are hosted on an HTTP or
FTP server, the source_hashes argument is also required.
.TP
.B source_hashes
A list of source_hashes corresponding to the sources list specified in
the sources argument.
.TP
.B defaults
Default context passed to the template.
.TP
.B context
Overrides default context variables passed to the template.
.TP
.B ignore_whitespace
New in version 2015.8.4.

.sp
Spaces and Tabs in text are ignored by default, when searching for the
appending content, one space or multiple tabs are the same for salt.
Set this option to \fBFalse\fP if you want to change this behavior.
.UNINDENT
.sp
Multi\-line example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/motd:
  file.append:
    \- text: |
        Thou hadst better eat salt with the Philosophers of Greece,
        than sugar with the Courtiers of Italy.
        \- Benjamin Franklin
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple lines of text:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/motd:
  file.append:
    \- text:
      \- Trust no one unless you have eaten much salt with him.
      \- \(dqSalt is born of the purest of parents: the sun and the sea.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Gather text from multiple template files:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/motd:
  file:
    \- append
    \- template: jinja
    \- sources:
      \- salt://motd/devops\-messages.tmpl
      \- salt://motd/hr\-messages.tmpl
      \- salt://motd/general\-messages.tmpl
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 0.9.5.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.blockreplace(name, marker_start=\(aq#\-\- start managed zone \-\-\(aq, marker_end=\(aq#\-\- end managed zone \-\-\(aq, source=None, source_hash=None, template=\(aqjinja\(aq, sources=None, source_hashes=None, defaults=None, context=None, content=\(aq\(aq, append_if_not_found=False, prepend_if_not_found=False, backup=\(aq.bak\(aq, show_changes=True, append_newline=None, insert_before_match=None, insert_after_match=None)
Maintain an edit in a file in a zone delimited by two line markers
.sp
New in version 2014.1.0.

.sp
Changed in version 2017.7.5,2018.3.1: \fBappend_newline\fP argument added. Additionally, to improve
idempotence, if the string represented by \fBmarker_end\fP is found in
the middle of the line, the content preceding the marker will be
removed when the block is replaced. This allows one to remove
\fBappend_newline: False\fP from the SLS and have the block properly
replaced if the end of the content block is immediately followed by the
\fBmarker_end\fP (i.e. no newline before the marker).

.sp
A block of content delimited by comments can help you manage several lines
entries without worrying about old entries removal. This can help you
maintaining an un\-managed file containing manual edits.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function will store two copies of the file in\-memory (the original
version and the edited version) in order to detect changes and only
edit the targeted file if necessary.
.sp
Additionally, you can use \fI\%file.accumulated\fP and target this state. All accumulated
data dictionaries\(aq content will be added in the content block.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Filesystem path to the file to be edited
.TP
.B marker_start
The line content identifying a line as the start of the content block.
Note that the whole line containing this marker will be considered, so
whitespace or extra content before or after the marker is included in
final output
.TP
.B marker_end
The line content identifying the end of the content block. As of
versions 2017.7.5 and 2018.3.1, everything up to the text matching the
marker will be replaced, so it\(aqs important to ensure that your marker
includes the beginning of the text you wish to replace.
.TP
.B content
The content to be used between the two lines identified by
\fBmarker_start\fP and \fBmarker_end\fP
.TP
.B source
The source file to download to the minion, this source file can be
hosted on either the salt master server, or on an HTTP or FTP server.
Both HTTPS and HTTP are supported as well as downloading directly
from Amazon S3 compatible URLs with both pre\-configured and automatic
IAM credentials. (see s3.get state documentation)
File retrieval from Openstack Swift object storage is supported via
swift://container/object_path URLs, see swift.get documentation.
For files hosted on the salt file server, if the file is located on
the master in the directory named spam, and is called eggs, the source
string is salt://spam/eggs. If source is left blank or None
(use ~ in YAML), the file will be created as an empty file and
the content will not be managed. This is also the case when a file
already exists and the source is undefined; the contents of the file
will not be changed or managed.
.sp
If the file is hosted on a HTTP or FTP server then the source_hash
argument is also required.
.sp
A list of sources can also be passed in to provide a default source and
a set of fallbacks. The first source in the list that is found to exist
will be used and subsequent entries in the list will be ignored.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
file_override_example:
  file.blockreplace:
    \- name: /etc/example.conf
    \- source:
      \- salt://file_that_does_not_exist
      \- salt://file_that_exists
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B source_hash
.INDENT 7.0
.TP
.B This can be one of the following:
.INDENT 7.0
.IP 1. 3
a source hash string
.IP 2. 3
the URI of a file that contains source hash strings
.UNINDENT
.UNINDENT
.sp
The function accepts the first encountered long unbroken alphanumeric
string of correct length as a valid hash, in order from most secure to
least secure:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Type    Length
======  ======
sha512     128
sha384      96
sha256      64
sha224      56
sha1        40
md5         32
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See the \fBsource_hash\fP parameter description for \fI\%file.managed\fP function for more details and examples.
.TP
.B template
Templating engine to be used to render the downloaded file. The
following engines are supported:
.INDENT 7.0
.IP \(bu 2
\fI\%cheetah\fP
.IP \(bu 2
\fI\%genshi\fP
.IP \(bu 2
\fI\%jinja\fP
.IP \(bu 2
\fI\%mako\fP
.IP \(bu 2
\fI\%py\fP
.IP \(bu 2
\fI\%wempy\fP
.UNINDENT
.TP
.B context
Overrides default context variables passed to the template
.TP
.B defaults
Default context passed to the template
.TP
.B append_if_not_found
If markers are not found and this option is set to \fBTrue\fP, the
content block will be appended to the file.
.TP
.B prepend_if_not_found
If markers are not found and this option is set to \fBTrue\fP, the
content block will be prepended to the file.
.TP
.B insert_before_match
If markers are not found, this parameter can be set to a regex which will
insert the block before the first found occurrence in the file.
.sp
New in version 3001.

.TP
.B insert_after_match
If markers are not found, this parameter can be set to a regex which will
insert the block after the first found occurrence in the file.
.sp
New in version 3001.

.TP
.B backup
The file extension to use for a backup of the file if any edit is made.
Set this to \fBFalse\fP to skip making a backup.
.TP
.B show_changes
Controls how changes are presented. If \fBTrue\fP, the \fBChanges\fP
section of the state return will contain a unified diff of the changes
made. If False, then it will contain a boolean (\fBTrue\fP if any changes
were made, otherwise \fBFalse\fP).
.TP
.B append_newline
Controls whether or not a newline is appended to the content block. If
the value of this argument is \fBTrue\fP then a newline will be added to
the content block. If it is \fBFalse\fP, then a newline will \fInot\fP be
added to the content block. If it is unspecified, then a newline will
only be added to the content block if it does not already end in a
newline.
.sp
New in version 2017.7.5,2018.3.1.

.UNINDENT
.sp
Example of usage with an accumulator and with a variable:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set myvar = 42 %}
hosts\-config\-block\-{{ myvar }}:
  file.blockreplace:
    \- name: /etc/hosts
    \- marker_start: \(dq# START managed zone {{ myvar }} \-DO\-NOT\-EDIT\-\(dq
    \- marker_end: \(dq# END managed zone {{ myvar }} \-\-\(dq
    \- content: \(aqFirst line of content\(aq
    \- append_if_not_found: True
    \- backup: \(aq.bak\(aq
    \- show_changes: True

hosts\-config\-block\-{{ myvar }}\-accumulated1:
  file.accumulated:
    \- filename: /etc/hosts
    \- name: my\-accumulator\-{{ myvar }}
    \- text: \(dqtext 2\(dq
    \- require_in:
      \- file: hosts\-config\-block\-{{ myvar }}

hosts\-config\-block\-{{ myvar }}\-accumulated2:
  file.accumulated:
    \- filename: /etc/hosts
    \- name: my\-accumulator\-{{ myvar }}
    \- text: |
         text 3
         text 4
    \- require_in:
      \- file: hosts\-config\-block\-{{ myvar }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will generate and maintain a block of content in \fB/etc/hosts\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# START managed zone 42 \-DO\-NOT\-EDIT\-
First line of content
text 2
text 3
text 4
# END managed zone 42 \-\-
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.cached(name, source_hash=\(aq\(aq, source_hash_name=None, skip_verify=False, saltenv=\(aqbase\(aq, use_etag=False, source_hash_sig=None, signed_by_any=None, signed_by_all=None, keyring=None, gnupghome=None)
New in version 2017.7.3.

.sp
Changed in version 3005.

.sp
Ensures that a file is saved to the minion\(aqs cache. This state is primarily
invoked by other states to ensure that we do not re\-download a source file
if we do not need to.
.INDENT 7.0
.TP
.B name
The URL of the file to be cached. To cache a file from an environment
other than \fBbase\fP, either use the \fBsaltenv\fP argument or include the
saltenv in the URL (e.g. \fBsalt://path/to/file.conf?saltenv=dev\fP).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A list of URLs is not supported, this must be a single URL. If a
local file is passed here, then the state will obviously not try to
download anything, but it will compare a hash if one is specified.
.UNINDENT
.UNINDENT
.TP
.B source_hash
See the documentation for this same argument in the
\fI\%file.managed\fP state.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For remote files not originating from the \fBsalt://\fP fileserver,
such as http(s) or ftp servers, this state will not re\-download the
file if the locally\-cached copy matches this hash. This is done to
prevent unnecessary downloading on repeated runs of this state. To
update the cached copy of a file, it is necessary to update this
hash.
.UNINDENT
.UNINDENT
.TP
.B source_hash_name
See the documentation for this same argument in the
\fI\%file.managed\fP state.
.TP
.B skip_verify
See the documentation for this same argument in the
\fI\%file.managed\fP state.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Setting this to \fBTrue\fP will result in a copy of the file being
downloaded from a remote (http(s), ftp, etc.) source each time the
state is run.
.UNINDENT
.UNINDENT
.TP
.B saltenv
Used to specify the environment from which to download a file from the
Salt fileserver (i.e. those with \fBsalt://\fP URL).
.TP
.B use_etag
If \fBTrue\fP, remote http/https file sources will attempt to use the
ETag header to determine if the remote file needs to be downloaded.
This provides a lightweight mechanism for promptly refreshing files
changed on a web server without requiring a full hash comparison via
the \fBsource_hash\fP parameter.
.sp
New in version 3005.

.TP
.B source_hash_sig
When \fBname\fP is a remote file source, \fBsource_hash\fP is a file,
\fBskip_verify\fP is not true and \fBuse_etag\fP is not true, ensure a
valid GPG signature exists on the source hash file.
Set this to \fBtrue\fP for an inline (clearsigned) signature, or to a
file URI retrievable by \fI:py:func:\(gacp.cache_file <salt.modules.cp.cache_file>\fP
for a detached one.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A signature on the \fBsource_hash\fP file is enforced regardless of
changes since its contents are used to check if an existing file
is in the correct state \- but only for remote sources!
.UNINDENT
.UNINDENT
.sp
New in version 3007.0.

.TP
.B signed_by_any
When verifying \fBsource_hash_sig\fP, require at least one valid signature
from one of a list of key fingerprints. This is passed to
\fI\%gpg.verify\fP\&.
.sp
New in version 3007.0.

.TP
.B signed_by_all
When verifying \fBsource_hash_sig\fP, require a valid signature from each
of the key fingerprints in this list. This is passed to
\fI\%gpg.verify\fP\&.
.sp
New in version 3007.0.

.TP
.B keyring
When verifying signatures, use this keyring.
.sp
New in version 3007.0.

.TP
.B gnupghome
When verifying signatures, use this GnuPG home.
.sp
New in version 3007.0.

.UNINDENT
.sp
This state will in most cases not be useful in SLS files, but it is useful
when writing a state or remote\-execution module that needs to make sure
that a file at a given URL has been downloaded to the cachedir. One example
of this is in the \fBarchive.extracted\fP
state:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
result = __states__[\(aqfile.cached\(aq](source_match,
                                   source_hash=source_hash,
                                   source_hash_name=source_hash_name,
                                   skip_verify=skip_verify,
                                   saltenv=__env__)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will return a dictionary containing the state\(aqs return data, including
a \fBresult\fP key which will state whether or not the state was successful.
Note that this will not catch exceptions, so it is best used within a
try/except.
.sp
Once this state has been run from within another state or remote\-execution
module, the actual location of the cached file can be obtained using
\fI\%cp.is_cached\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cached = __salt__[\(aqcp.is_cached\(aq](source_match, saltenv=__env__)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This function will return the cached path of the file, or an empty string
if the file is not present in the minion cache.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.comment(name, regex, char=\(aq#\(aq, backup=\(aq.bak\(aq, ignore_missing=False)
New in version 0.9.5.

.sp
Changed in version 3005.

.sp
Comment out specified lines in a file.
.INDENT 7.0
.TP
.B name
The full path to the file to be edited
.TP
.B regex
A regular expression used to find the lines that are to be commented;
this pattern will be wrapped in parenthesis and will move any
preceding/trailing \fB^\fP or \fB$\fP characters outside the parenthesis
(e.g., the pattern \fB^foo$\fP will be rewritten as \fB^(foo)$\fP)
Note that you _need_ the leading ^, otherwise each time you run
highstate, another comment char will be inserted.
.TP
.B char
The character to be inserted at the beginning of a line in order to
comment it out
.TP
.B backup
The file will be backed up before edit with this file extension
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This backup will be overwritten each time \fBsed\fP / \fBcomment\fP /
\fBuncomment\fP is called. Meaning the backup will only be useful
after the first invocation.
.UNINDENT
.UNINDENT
.sp
Set to False/None to not keep a backup.
.TP
.B ignore_missing
Ignore a failure to find the regex in the file. This is useful for
scenarios where a line must only be commented if it is found in the
file.
.sp
New in version 3005.

.UNINDENT
.sp
Usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/fstab:
  file.comment:
    \- regex: ^bind 127.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.copy_(name, source, force=False, makedirs=False, preserve=False, user=None, group=None, mode=None, dir_mode=None, subdir=False, **kwargs)
If the file defined by the \fBsource\fP option exists on the minion, copy it
to the named path. The file will not be overwritten if it already exists,
unless the \fBforce\fP option is set to \fBTrue\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state only copies files from one location on a minion to another
location on the same minion. For copying files from the master, use a
\fI\%file.managed\fP state.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The location of the file to copy to
.TP
.B source
The location of the file to copy to the location specified with name
.TP
.B force
If the target location is present then the file will not be moved,
specify \(dqforce: True\(dq to overwrite the target file
.TP
.B makedirs
If the target subdirectories don\(aqt exist create them
.TP
.B preserve
New in version 2015.5.0.

.sp
Set \fBpreserve: True\fP to preserve user/group ownership and mode
after copying. Default is \fBFalse\fP\&. If \fBpreserve\fP is set to \fBTrue\fP,
then user/group/mode attributes will be ignored.
.TP
.B user
New in version 2015.5.0.

.sp
The user to own the copied file, this defaults to the user salt is
running as on the minion. If \fBpreserve\fP is set to \fBTrue\fP, then
this will be ignored
.TP
.B group
New in version 2015.5.0.

.sp
The group to own the copied file, this defaults to the group salt is
running as on the minion. If \fBpreserve\fP is set to \fBTrue\fP or on
Windows this will be ignored
.TP
.B mode
New in version 2015.5.0.

.sp
The permissions to set on the copied file, aka 644, \(aq0775\(aq, \(aq4664\(aq.
If \fBpreserve\fP is set to \fBTrue\fP, then this will be ignored.
Not supported on Windows.
.sp
The default mode for new files and directories corresponds umask of salt
process. For existing files and directories it\(aqs not enforced.
.TP
.B dir_mode
New in version 3006.0.

.sp
If directories are to be created, passing this option specifies the
permissions for those directories. If this is not set, directories
will be assigned permissions by adding the execute bit to the mode of
the files.
.sp
The default mode for new files and directories corresponds to the umask
of the salt process. Not enforced for existing files and directories.
.TP
.B subdir
New in version 2015.5.0.

.sp
If the name is a directory then place the file inside the named
directory
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The copy function accepts paths that are local to the Salt minion.
This function does not support salt://, http://, or the other
additional file paths that are supported by \fI\%states.file.managed\fP and \fI\%states.file.recurse\fP\&.
.UNINDENT
.UNINDENT
.sp
Usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Use \(aqcopy\(aq, not \(aqcopy_\(aq
/etc/example.conf:
  file.copy:
    \- source: /tmp/example.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.decode(name, encoded_data=None, contents_pillar=None, encoding_type=\(aqbase64\(aq, checksum=\(aqmd5\(aq)
Decode an encoded file and write it to disk
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
Path of the file to be written.
.TP
.B encoded_data
The encoded file. Either this option or \fBcontents_pillar\fP must be
specified.
.TP
.B contents_pillar
A Pillar path to the encoded file. Uses the same path syntax as
\fI\%pillar.get\fP\&. The
\fI\%hashutil.base64_encodefile\fP function can load encoded
content into Pillar. Either this option or \fBencoded_data\fP must be
specified.
.TP
.B encoding_type
The type of encoding.
.TP
.B checksum
The hashing algorithm to use to generate checksums. Wraps the
\fI\%hashutil.digest\fP execution
function.
.UNINDENT
.sp
Usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
write_base64_encoded_string_to_a_file:
  file.decode:
    \- name: /tmp/new_file
    \- encoding_type: base64
    \- contents_pillar: mypillar:thefile

# or

write_base64_encoded_string_to_a_file:
  file.decode:
    \- name: /tmp/new_file
    \- encoding_type: base64
    \- encoded_data: |
        Z2V0IHNhbHRlZAo=
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Be careful with multi\-line strings that the YAML indentation is correct.
E.g.,
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
write_base64_encoded_string_to_a_file:
  file.decode:
    \- name: /tmp/new_file
    \- encoding_type: base64
    \- encoded_data: |
        {{ salt.pillar.get(\(aqpath:to:data\(aq) | indent(8) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.directory(name, user=None, group=None, recurse=None, max_depth=None, dir_mode=None, file_mode=None, makedirs=False, clean=False, require=None, exclude_pat=None, follow_symlinks=False, force=False, backupname=None, allow_symlink=True, children_only=False, win_owner=None, win_perms=None, win_deny_perms=None, win_inheritance=True, win_perms_reset=False, **kwargs)
Ensure that a named directory is present and has the right perms
.INDENT 7.0
.TP
.B name
The location to create or manage a directory, as an absolute path
.TP
.B user
The user to own the directory; this defaults to the user salt is
running as on the minion
.TP
.B group
The group ownership set for the directory; this defaults to the group
salt is running as on the minion. On Windows, this is ignored
.TP
.B recurse
Enforce user/group ownership and mode of directory recursively. Accepts
a list of strings representing what you would like to recurse.  If
\fBmode\fP is defined, will recurse on both \fBfile_mode\fP and \fBdir_mode\fP if
they are defined.  If \fBignore_files\fP or \fBignore_dirs\fP is included, files or
directories will be left unchanged respectively.
directories will be left unchanged respectively. If \fBsilent\fP is defined,
individual file/directory change notifications will be suppressed.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/var/log/httpd:
  file.directory:
    \- user: root
    \- group: root
    \- dir_mode: 755
    \- file_mode: 644
    \- recurse:
      \- user
      \- group
      \- mode
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Leave files or directories unchanged:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/var/log/httpd:
  file.directory:
    \- user: root
    \- group: root
    \- dir_mode: 755
    \- file_mode: 644
    \- recurse:
      \- user
      \- group
      \- mode
      \- ignore_dirs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.5.0.

.TP
.B max_depth
Limit the recursion depth. The default is no limit=None.
\(aqmax_depth\(aq and \(aqclean\(aq are mutually exclusive.
.sp
New in version 2016.11.0.

.TP
.B dir_mode / mode
The permissions mode to set any directories created. Not supported on
Windows.
.sp
The default mode for new files and directories corresponds umask of salt
process. For existing files and directories it\(aqs not enforced.
.TP
.B file_mode
The permissions mode to set any files created if \(aqmode\(aq is run in
\(aqrecurse\(aq. This defaults to dir_mode. Not supported on Windows.
.sp
The default mode for new files and directories corresponds umask of salt
process. For existing files and directories it\(aqs not enforced.
.TP
.B makedirs
If the directory is located in a path without a parent directory, then
the state will fail. If makedirs is set to True, then the parent
directories will be created to facilitate the creation of the named
file.
.TP
.B clean
Remove any files that are not referenced by a required \fBfile\fP state.
See examples below for more info. If this option is set then everything
in this directory will be deleted unless it is required. \(aqclean\(aq and
\(aqmax_depth\(aq are mutually exclusive.
.TP
.B require
Require other resources such as packages or files.
.TP
.B exclude_pat
When \(aqclean\(aq is set to True, exclude this pattern from removal list
and preserve in the destination.
.TP
.B follow_symlinks
If the desired path is a symlink (or \fBrecurse\fP is defined and a
symlink is encountered while recursing), follow it and check the
permissions of the directory/file to which the symlink points.
.sp
New in version 2014.1.4.

.sp
Changed in version 3001.1: If set to False symlinks permissions are ignored on Linux systems
because it does not support permissions modification. Symlinks
permissions are always 0o777 on Linux.

.TP
.B force
If the name of the directory exists and is not a directory and
force is set to False, the state will fail. If force is set to
True, the file in the way of the directory will be deleted to
make room for the directory, unless backupname is set,
then it will be renamed.
.sp
New in version 2014.7.0.

.TP
.B backupname
If the name of the directory exists and is not a directory, it will be
renamed to the backupname. If the backupname already
exists and force is False, the state will fail. Otherwise, the
backupname will be removed first.
.sp
New in version 2014.7.0.

.TP
.B allow_symlink
If allow_symlink is True and the specified path is a symlink, it will be
allowed to remain if it points to a directory. If allow_symlink is False
then the state will fail, unless force is also set to True, in which case
it will be removed or renamed, depending on the value of the backupname
argument.
.sp
New in version 2014.7.0.

.TP
.B children_only
If children_only is True the base of a path is excluded when performing
a recursive operation. In case of /path/to/base, base will be ignored
while all of /path/to/base/* are still operated on.
.TP
.B win_owner
The owner of the directory. If this is not passed, user will be used. If
user is not passed, the account under which Salt is running will be
used.
.sp
New in version 2017.7.0.

.TP
.B win_perms
A dictionary containing permissions to grant and their propagation. For
example: \fB{\(aqAdministrators\(aq: {\(aqperms\(aq: \(aqfull_control\(aq, \(aqapplies_to\(aq:
\(aqthis_folder_only\(aq}}\fP Can be a single basic perm or a list of advanced
perms. \fBperms\fP must be specified. \fBapplies_to\fP is optional and
defaults to \fBthis_folder_subfolder_files\fP\&.
.sp
New in version 2017.7.0.

.TP
.B win_deny_perms
A dictionary containing permissions to deny and their propagation. For
example: \fB{\(aqAdministrators\(aq: {\(aqperms\(aq: \(aqfull_control\(aq, \(aqapplies_to\(aq:
\(aqthis_folder_only\(aq}}\fP Can be a single basic perm or a list of advanced
perms.
.sp
New in version 2017.7.0.

.TP
.B win_inheritance
True to inherit permissions from the parent directory, False not to
inherit permission.
.sp
New in version 2017.7.0.

.TP
.B win_perms_reset
If \fBTrue\fP the existing DACL will be cleared and replaced with the
settings defined in this function. If \fBFalse\fP, new entries will be
appended to the existing DACL. Default is \fBFalse\fP\&.
.sp
New in version 2018.3.0.

.UNINDENT
.sp
Here\(aqs an example using the above \fBwin_*\fP parameters:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
create_config_dir:
  file.directory:
    \- name: \(aqC:\econfig\e\(aq
    \- win_owner: Administrators
    \- win_perms:
        # Basic Permissions
        dev_ops:
          perms: full_control
        # List of advanced permissions
        appuser:
          perms:
            \- read_attributes
            \- read_ea
            \- create_folders
            \- read_permissions
          applies_to: this_folder_only
        joe_snuffy:
          perms: read
          applies_to: this_folder_files
    \- win_deny_perms:
        fred_snuffy:
          perms: full_control
    \- win_inheritance: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For \fBclean: True\fP there is no mechanism that allows all states and
modules to enumerate the files that they manage, so for file.directory to
know what files are managed by Salt, a \fBfile\fP state targeting managed
files is required. To use a contrived example, the following states will
always have changes, despite the file named \fBokay\fP being created by a
Salt state:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
silly_way_of_creating_a_file:
  cmd.run:
     \- name: mkdir \-p /tmp/dont/do/this && echo \(dqseriously\(dq > /tmp/dont/do/this/okay
     \- unless: grep seriously /tmp/dont/do/this/okay

will_always_clean:
  file.directory:
    \- name: /tmp/dont/do/this
    \- clean: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Because \fBcmd.run\fP has no way of communicating that it\(aqs creating a file,
\fBwill_always_clean\fP will remove the newly created file. Of course, every
time the states run the same thing will happen \- the
\fBsilly_way_of_creating_a_file\fP will crete the file and
\fBwill_always_clean\fP will always remove it. Over and over again, no matter
how many times you run it.
.sp
To make this example work correctly, we need to add a \fBfile\fP state that
targets the file, and a \fBrequire\fP between the file states.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
silly_way_of_creating_a_file:
  cmd.run:
     \- name: mkdir \-p /tmp/dont/do/this && echo \(dqseriously\(dq > /tmp/dont/do/this/okay
     \- unless: grep seriously /tmp/dont/do/this/okay
  file.managed:
     \- name: /tmp/dont/do/this/okay
     \- create: False
     \- replace: False
     \- require_in:
       \- file: will_always_clean
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now there is a \fBfile\fP state that \fBclean\fP can check, so running those
states will work as expected. The file will be created with the specific
contents, and \fBclean\fP will ignore the file because it is being managed by
a salt \fBfile\fP state. Note that if \fBrequire_in\fP was placed under
\fBcmd.run\fP, it would \fBnot\fP work, because the requisite is for the cmd,
not the file.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
silly_way_of_creating_a_file:
  cmd.run:
     \- name: mkdir \-p /tmp/dont/do/this && echo \(dqseriously\(dq > /tmp/dont/do/this/okay
     \- unless: grep seriously /tmp/dont/do/this/okay
     # This part should be under file.managed
     \- require_in:
       \- file: will_always_clean
  file.managed:
     \- name: /tmp/dont/do/this/okay
     \- create: False
     \- replace: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Any other state that creates a file as a result, for example \fBpkgrepo\fP,
must have the resulting files referenced in a file state in order for
\fBclean: True\fP to ignore them.  Also note that the requisite
(\fBrequire_in\fP vs \fBrequire\fP) works in both directions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
clean_dir:
  file.directory:
    \- name: /tmp/a/better/way
    \- require:
      \- file: a_better_way

a_better_way:
  file.managed:
    \- name: /tmp/a/better/way/truely
    \- makedirs: True
    \- contents: a much better way
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Works the same as this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
clean_dir:
  file.directory:
    \- name: /tmp/a/better/way
    \- clean: True

a_better_way:
  file.managed:
    \- name: /tmp/a/better/way/truely
    \- makedirs: True
    \- contents: a much better way
    \- require_in:
      \- file: clean_dir
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A common mistake here is to forget the state name and id are both required for requisites:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Correct:
/path/to/some/file:
  file.managed:
    \- contents: Cool
    \- require_in:
      \- file: clean_dir

# Incorrect
/path/to/some/file:
  file.managed:
    \- contents: Cool
    \- require_in:
      # should be \(ga\- file: clean_dir\(ga
      \- clean_dir

# Also incorrect
/path/to/some/file:
  file.managed:
    \- contents: Cool
    \- require_in:
      # should be \(ga\- file: clean_dir\(ga
      \- file
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.exists(name, **kwargs)
Verify that the named file or directory is present or exists.
Ensures pre\-requisites outside of Salt\(aqs purview
(e.g., keytabs, private keys, etc.) have been previously satisfied before
deployment.
.sp
This function does not create the file if it doesn\(aqt exist, it will return
an error.
.INDENT 7.0
.TP
.B name
Absolute path which must exist
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.hardlink(name, target, force=False, makedirs=False, user=None, group=None, dir_mode=None, **kwargs)
Create a hard link
If the file already exists and is a hard link pointing to any location other
than the specified target, the hard link will be replaced. If the hard link
is a regular file or directory then the state will return False. If the
regular file is desired to be replaced with a hard link pass force: True
.INDENT 7.0
.TP
.B name
The location of the hard link to create
.TP
.B target
The location that the hard link points to
.TP
.B force
If the name of the hard link exists and force is set to False, the
state will fail. If force is set to True, the file or directory in the
way of the hard link file will be deleted to make room for the hard
link, unless backupname is set, when it will be renamed
.TP
.B makedirs
If the location of the hard link does not already have a parent directory
then the state will fail, setting makedirs to True will allow Salt to
create the parent directory
.TP
.B user
The user to own any directories made if makedirs is set to true. This
defaults to the user salt is running as on the minion
.TP
.B group
The group ownership set on any directories made if makedirs is set to
true. This defaults to the group salt is running as on the minion. On
Windows, this is ignored
.TP
.B dir_mode
If directories are to be created, passing this option specifies the
permissions for those directories.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.keyvalue(name, key=None, value=None, key_values=None, separator=\(aq=\(aq, append_if_not_found=False, prepend_if_not_found=False, search_only=False, show_changes=True, ignore_if_missing=False, count=1, uncomment=None, key_ignore_case=False, value_ignore_case=False, create_if_missing=False)
Key/Value based editing of a file.
.sp
New in version 3001.

.sp
This function differs from \fBfile.replace\fP in that it is able to search for
keys, followed by a customizable separator, and replace the value with the
given value. Should the value be the same as the one already in the file, no
changes will be made.
.sp
Either supply both \fBkey\fP and \fBvalue\fP parameters, or supply a dictionary
with key / value pairs. It is an error to supply both.
.INDENT 7.0
.TP
.B name
Name of the file to search/replace in.
.TP
.B key
Key to search for when ensuring a value. Use in combination with a
\fBvalue\fP parameter.
.TP
.B value
Value to set for a given key. Use in combination with a \fBkey\fP
parameter.
.TP
.B key_values
Dictionary of key / value pairs to search for and ensure values for.
Used to specify multiple key / values at once.
.TP
.B separator
Separator which separates key from value.
.TP
.B append_if_not_found
Append the key/value to the end of the file if not found. Note that this
takes precedence over \fBprepend_if_not_found\fP\&.
.TP
.B prepend_if_not_found
Prepend the key/value to the beginning of the file if not found. Note
that \fBappend_if_not_found\fP takes precedence.
.TP
.B show_changes
Show a diff of the resulting removals and inserts.
.TP
.B ignore_if_missing
Return with success even if the file is not found (or not readable).
.TP
.B count
Number of occurrences to allow (and correct), default is 1. Set to \-1 to
replace all, or set to 0 to remove all lines with this key regardsless
of its value.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Any additional occurrences after \fBcount\fP are removed.
A count of \-1 will only replace all occurrences that are currently
uncommented already. Lines commented out will be left alone.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B uncomment
Disregard and remove supplied leading characters when finding keys. When
set to None, lines that are commented out are left for what they are.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The argument to \fBuncomment\fP is not a prefix string. Rather; it is a
set of characters, each of which are stripped.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B key_ignore_case
Keys are matched case insensitively. When a value is changed the matched
key is kept as\-is.
.TP
.B value_ignore_case
Values are checked case insensitively, trying to set e.g. \(aqYes\(aq while
the current value is \(aqyes\(aq, will not result in changes when
\fBvalue_ignore_case\fP is set to True.
.TP
.B create_if_missing
Create the file if the destination file is not found.
.sp
New in version 3007.0.

.UNINDENT
.sp
An example of using \fBfile.keyvalue\fP to ensure sshd does not allow
for root to login with a password and at the same time setting the
login\-gracetime to 1 minute and disabling all forwarding:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sshd_config_harden:
    file.keyvalue:
      \- name: /etc/ssh/sshd_config
      \- key_values:
          permitrootlogin: \(aqwithout\-password\(aq
          LoginGraceTime: \(aq1m\(aq
          DisableForwarding: \(aqyes\(aq
      \- separator: \(aq \(aq
      \- uncomment: \(aq# \(aq
      \- key_ignore_case: True
      \- append_if_not_found: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The same example, except for only ensuring PermitRootLogin is set correctly.
Thus being able to use the shorthand \fBkey\fP and \fBvalue\fP parameters
instead of \fBkey_values\fP\&.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sshd_config_harden:
    file.keyvalue:
      \- name: /etc/ssh/sshd_config
      \- key: PermitRootLogin
      \- value: without\-password
      \- separator: \(aq \(aq
      \- uncomment: \(aq# \(aq
      \- key_ignore_case: True
      \- append_if_not_found: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Notice how the key is not matched case\-sensitively, this way it will
correctly identify both \(aqPermitRootLogin\(aq as well as \(aqpermitrootlogin\(aq.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.line(name, content=None, match=None, mode=None, location=None, before=None, after=None, show_changes=True, backup=False, quiet=False, indent=True, create=False, user=None, group=None, file_mode=None)
Line\-focused editing of a file.
.sp
New in version 2015.8.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBfile.line\fP exists for historic reasons, and is not
generally recommended. It has a lot of quirks.  You may find
\fBfile.replace\fP to be more suitable.
.UNINDENT
.UNINDENT
.sp
\fBfile.line\fP is most useful if you have single lines in a file,
potentially a config file, that you would like to manage. It can
remove, add, and replace lines.
.INDENT 7.0
.TP
.B name
Filesystem path to the file to be edited.
.TP
.B content
Content of the line. Allowed to be empty if mode=delete.
.TP
.B match
Match the target line for an action by
a fragment of a string or regular expression.
.sp
If neither \fBbefore\fP nor \fBafter\fP are provided, and \fBmatch\fP
is also \fBNone\fP, match falls back to the \fBcontent\fP value.
.TP
.B mode
Defines how to edit a line. One of the following options is
required:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B ensure
If line does not exist, it will be added. If \fBbefore\fP
and \fBafter\fP are specified either zero lines, or lines
that contain the \fBcontent\fP line are allowed to be in between
\fBbefore\fP and \fBafter\fP\&. If there are lines, and none of
them match then it will produce an error.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B replace
If line already exists, it will be replaced.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B delete
Delete the line, if found.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B insert
Nearly identical to \fBensure\fP\&. If a line does not exist,
it will be added.
.sp
The differences are that multiple (and non\-matching) lines are
alloweed between \fBbefore\fP and \fBafter\fP, if they are
specified. The line will always be inserted right before
\fBbefore\fP\&. \fBinsert\fP also allows the use of \fBlocation\fP to
specify that the line should be added at the beginning or end of
the file.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If \fBmode=insert\fP is used, at least one of the following
options must also be defined: \fBlocation\fP, \fBbefore\fP, or
\fBafter\fP\&. If \fBlocation\fP is used, it takes precedence
over the other two options.
.UNINDENT
.UNINDENT
.TP
.B location
In \fBmode=insert\fP only, whether to place the \fBcontent\fP at the
beginning or end of a the file. If \fBlocation\fP is provided,
\fBbefore\fP and \fBafter\fP are ignored. Valid locations:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B start
Place the content at the beginning of the file.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B end
Place the content at the end of the file.
.UNINDENT
.UNINDENT
.TP
.B before
Regular expression or an exact case\-sensitive fragment of the string.
Will be tried as \fBboth\fP a regex \fBand\fP a part of the line.  Must
match \fBexactly\fP one line in the file.  This value is only used in
\fBensure\fP and \fBinsert\fP modes. The \fBcontent\fP will be inserted just
before this line, matching its \fBindent\fP unless \fBindent=False\fP\&.
.TP
.B after
Regular expression or an exact case\-sensitive fragment of the string.
Will be tried as \fBboth\fP a regex \fBand\fP a part of the line.  Must
match \fBexactly\fP one line in the file.  This value is only used in
\fBensure\fP and \fBinsert\fP modes. The \fBcontent\fP will be inserted
directly after this line, unless \fBbefore\fP is also provided. If
\fBbefore\fP is not matched, indentation will match this line, unless
\fBindent=False\fP\&.
.TP
.B show_changes
Output a unified diff of the old file and the new file.
If \fBFalse\fP return a boolean if any changes were made.
Default is \fBTrue\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Using this option will store two copies of the file in\-memory
(the original version and the edited version) in order to generate the diff.
.UNINDENT
.UNINDENT
.TP
.B backup
Create a backup of the original file with the extension:
\(dqYear\-Month\-Day\-Hour\-Minutes\-Seconds\(dq.
.TP
.B quiet
Do not raise any exceptions. E.g. ignore the fact that the file that is
tried to be edited does not exist and nothing really happened.
.TP
.B indent
Keep indentation with the previous line. This option is not considered when
the \fBdelete\fP mode is specified. Default is \fBTrue\fP\&.
.TP
.B create
Create an empty file if doesn\(aqt exist.
.sp
New in version 2016.11.0.

.TP
.B user
The user to own the file, this defaults to the user salt is running as
on the minion.
.sp
New in version 2016.11.0.

.TP
.B group
The group ownership set for the file, this defaults to the group salt
is running as on the minion On Windows, this is ignored.
.sp
New in version 2016.11.0.

.TP
.B file_mode
The permissions to set on this file, aka 644, 0775, 4664. Not supported
on Windows.
.sp
New in version 2016.11.0.

.UNINDENT
.sp
If an equal sign (\fB=\fP) appears in an argument to a Salt command, it is
interpreted as a keyword argument in the format of \fBkey=val\fP\&. That
processing can be bypassed in order to pass an equal sign through to the
remote shell command by manually specifying the kwarg:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
update_config:
  file.line:
    \- name: /etc/myconfig.conf
    \- mode: ensure
    \- content: my key = my value
    \- before: somekey.*?
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExamples:\fP
.sp
Here\(aqs a simple config file.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[some_config]
# Some config file
# this line will go away

here=False
away=True
goodybe=away
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And an sls file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
remove_lines:
  file.line:
    \- name: /some/file.conf
    \- mode: delete
    \- match: away
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will produce:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[some_config]
# Some config file

here=False
away=True
goodbye=away
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If that state is executed 2 more times, this will be the result:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[some_config]
# Some config file

here=False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Given that original file with this state:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
replace_things:
  file.line:
    \- name: /some/file.conf
    \- mode: replace
    \- match: away
    \- content: here
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Three passes will this state will result in this file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[some_config]
# Some config file
here

here=False
here
here
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Each pass replacing the first line found.
.sp
Given this file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
insert after me
something
insert before me
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following state:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
insert_a_line:
  file.line:
    \- name: /some/file.txt
    \- mode: insert
    \- after: insert after me
    \- before: insert before me
    \- content: thrice
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If this state is executed 3 times, the result will be:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
insert after me
something
thrice
thrice
thrice
insert before me
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the mode is ensure instead, it will fail each time. To succeed, we need
to remove the incorrect line between before and after:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
insert after me
insert before me
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With an ensure mode, this will insert \fBthrice\fP the first time and
make no changes for subsequent calls. For something simple this is
fine, but if you have instead blocks like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Begin SomeBlock
    foo = bar
End

Begin AnotherBlock
    another = value
End
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And given this state:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ensure_someblock:
  file.line:
    \- name: /some/file.conf
    \- mode: ensure
    \- after: Begin SomeBlock
    \- content: this = should be my content
    \- before: End
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will fail because there are multiple \fBEnd\fP lines. Without that
problem, it still would fail because there is a non\-matching line,
\fBfoo = bar\fP\&. Ensure \fBonly\fP allows either zero, or the matching
line present to be present in between \fBbefore\fP and \fBafter\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.managed(name, source=None, source_hash=\(aq\(aq, source_hash_name=None, keep_source=True, user=None, group=None, mode=None, attrs=None, template=None, makedirs=False, dir_mode=None, context=None, replace=True, defaults=None, backup=\(aq\(aq, show_changes=True, create=True, contents=None, tmp_dir=\(aq\(aq, tmp_ext=\(aq\(aq, contents_pillar=None, contents_grains=None, contents_newline=True, contents_delimiter=\(aq:\(aq, encoding=None, encoding_errors=\(aqstrict\(aq, allow_empty=True, follow_symlinks=True, check_cmd=None, skip_verify=False, selinux=None, win_owner=None, win_perms=None, win_deny_perms=None, win_inheritance=True, win_perms_reset=False, verify_ssl=True, use_etag=False, signature=None, source_hash_sig=None, signed_by_any=None, signed_by_all=None, keyring=None, gnupghome=None, **kwargs)
Manage a given file, this function allows for a file to be downloaded from
the salt master and potentially run through a templating system.
.INDENT 7.0
.TP
.B name
The location of the file to manage, as an absolute path.
.TP
.B source
The source file to download to the minion, this source file can be
hosted on either the salt master server (\fBsalt://\fP), the salt minion
local file system (\fB/\fP), or on an HTTP or FTP server (\fBhttp(s)://\fP,
\fBftp://\fP).
.sp
Both HTTPS and HTTP are supported as well as downloading directly
from Amazon S3 compatible URLs with both pre\-configured and automatic
IAM credentials. (see s3.get state documentation)
File retrieval from Openstack Swift object storage is supported via
swift://container/object_path URLs, see swift.get documentation.
For files hosted on the salt file server, if the file is located on
the master in the directory named spam, and is called eggs, the source
string is salt://spam/eggs. If source is left blank or None
(use ~ in YAML), the file will be created as an empty file and
the content will not be managed. This is also the case when a file
already exists and the source is undefined; the contents of the file
will not be changed or managed. If source is left blank or None, please
also set replaced to False to make your intention explicit.
.sp
If the file is hosted on a HTTP or FTP server then the source_hash
argument is also required.
.sp
A list of sources can also be passed in to provide a default source and
a set of fallbacks. The first source in the list that is found to exist
will be used and subsequent entries in the list will be ignored. Source
list functionality only supports local files and remote files hosted on
the salt master server or retrievable via HTTP, HTTPS, or FTP.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
file_override_example:
  file.managed:
    \- source:
      \- salt://file_that_does_not_exist
      \- salt://file_that_exists
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B source_hash
.INDENT 7.0
.TP
.B This can be one of the following:
.INDENT 7.0
.IP 1. 3
a source hash string
.IP 2. 3
the URI of a file that contains source hash strings
.UNINDENT
.UNINDENT
.sp
The function accepts the first encountered long unbroken alphanumeric
string of correct length as a valid hash, in order from most secure to
least secure:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Type    Length
======  ======
sha512     128
sha384      96
sha256      64
sha224      56
sha1        40
md5         32
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
\fBUsing a Source Hash File\fP
The file can contain several checksums for several files. Each line
must contain both the file name and the hash.  If no file name is
matched, the first hash encountered will be used, otherwise the most
secure hash with the correct source file name will be used.
.sp
When using a source hash file the source_hash argument needs to be a
url, the standard download urls are supported, ftp, http, salt etc:
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
tomdroid\-src\-0.7.3.tar.gz:
  file.managed:
    \- name: /tmp/tomdroid\-src\-0.7.3.tar.gz
    \- source: https://launchpad.net/tomdroid/beta/0.7.3/+download/tomdroid\-src\-0.7.3.tar.gz
    \- source_hash: https://launchpad.net/tomdroid/beta/0.7.3/+download/tomdroid\-src\-0.7.3.hash
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following lines are all supported formats:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/rc.conf ef6e82e4006dee563d98ada2a2a80a27
sha254c8525aee419eb649f0233be91c151178b30f0dff8ebbdcc8de71b1d5c8bcc06a  /etc/resolv.conf
ead48423703509d37c4a90e6a0d53e143b6fc268
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Debian file type \fB*.dsc\fP files are also supported.
.UNINDENT
.sp
\fBInserting the Source Hash in the SLS Data\fP
.sp
The source_hash can be specified as a simple checksum, like so:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
tomdroid\-src\-0.7.3.tar.gz:
  file.managed:
    \- name: /tmp/tomdroid\-src\-0.7.3.tar.gz
    \- source: https://launchpad.net/tomdroid/beta/0.7.3/+download/tomdroid\-src\-0.7.3.tar.gz
    \- source_hash: 79eef25f9b0b2c642c62b7f737d4f53f
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Releases prior to 2016.11.0 must also include the hash type, like
in the below example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tomdroid\-src\-0.7.3.tar.gz:
  file.managed:
    \- name: /tmp/tomdroid\-src\-0.7.3.tar.gz
    \- source: https://launchpad.net/tomdroid/beta/0.7.3/+download/tomdroid\-src\-0.7.3.tar.gz
    \- source_hash: md5=79eef25f9b0b2c642c62b7f737d4f53f
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
source_hash is ignored if the file hosted is not on a HTTP, HTTPS or FTP server.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Known issues:
If the remote server URL has the hash file as an apparent
sub\-directory of the source file, the module will discover that it
has already cached a directory where a file should be cached. For
example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
tomdroid\-src\-0.7.3.tar.gz:
  file.managed:
    \- name: /tmp/tomdroid\-src\-0.7.3.tar.gz
    \- source: https://launchpad.net/tomdroid/beta/0.7.3/+download/tomdroid\-src\-0.7.3.tar.gz
    \- source_hash: https://launchpad.net/tomdroid/beta/0.7.3/+download/tomdroid\-src\-0.7.3.tar.gz/+md5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B source_hash_name
When \fBsource_hash\fP refers to a hash file, Salt will try to find the
correct hash by matching the filename/URI associated with that hash. By
default, Salt will look for the filename being managed. When managing a
file at path \fB/tmp/foo.txt\fP, then the following line in a hash file
would match:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
acbd18db4cc2f85cedef654fccc4a4d8    foo.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, sometimes a hash file will include multiple similar paths:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
37b51d194a7513e45b56f6524f2d51f2    ./dir1/foo.txt
acbd18db4cc2f85cedef654fccc4a4d8    ./dir2/foo.txt
73feffa4b7f6bb68e44cf984c85f6e88    ./dir3/foo.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In cases like this, Salt may match the incorrect hash. This argument
can be used to tell Salt which filename to match, to ensure that the
correct hash is identified. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/tmp/foo.txt:
  file.managed:
    \- source: https://mydomain.tld/dir2/foo.txt
    \- source_hash: https://mydomain.tld/hashes
    \- source_hash_name: ./dir2/foo.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument must contain the full filename entry from the
checksum file, as this argument is meant to disambiguate matches
for multiple files that have the same basename. So, in the
example above, simply using \fBfoo.txt\fP would not match.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.5.

.TP
.B keep_source
Set to \fBFalse\fP to discard the cached copy of the source file once the
state completes. This can be useful for larger files to keep them from
taking up space in minion cache. However, keep in mind that discarding
the source file might result in the state needing to re\-download the
source file if the state is run again. If the source is not a local or
\fBsalt://\fP one, the source hash is known, \fBskip_verify\fP is not true
and the managed file exists with the correct hash and is not templated,
this is not the case (i.e. remote downloads are avoided if the local hash
matches the expected one).
.sp
New in version 2017.7.3.

.TP
.B user
The user to own the file, this defaults to the user salt is running as
on the minion
.TP
.B group
The group ownership set for the file, this defaults to the group salt
is running as on the minion. On Windows, this is ignored
.TP
.B mode
The permissions to set on this file, e.g. \fB644\fP, \fB0775\fP, or
\fB4664\fP\&.
.sp
The default mode for new files and directories corresponds to the
umask of the salt process. The mode of existing files and directories
will only be changed if \fBmode\fP is specified.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option is \fBnot\fP supported on Windows.
.UNINDENT
.UNINDENT
.sp
Changed in version 2016.11.0: This option can be set to \fBkeep\fP, and Salt will keep the mode
from the Salt fileserver. This is only supported when the
\fBsource\fP URL begins with \fBsalt://\fP, or for files local to the
minion. Because the \fBsource\fP option cannot be used with any of
the \fBcontents\fP options, setting the \fBmode\fP to \fBkeep\fP is also
incompatible with the \fBcontents\fP options.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
keep does not work with salt\-ssh.
.sp
As a consequence of how the files are transferred to the minion, and
the inability to connect back to the master with salt\-ssh, salt is
unable to stat the file as it exists on the fileserver and thus
cannot mirror the mode on the salt\-ssh minion
.UNINDENT
.UNINDENT
.TP
.B attrs
The attributes to have on this file, e.g. \fBa\fP, \fBi\fP\&. The attributes
can be any or a combination of the following characters:
\fBaAcCdDeijPsStTu\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option is \fBnot\fP supported on Windows.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.0.

.TP
.B template
If this setting is applied, the named templating engine will be used to
render the downloaded file. The following templates are supported:
.INDENT 7.0
.IP \(bu 2
\fI\%cheetah\fP
.IP \(bu 2
\fI\%genshi\fP
.IP \(bu 2
\fI\%jinja\fP
.IP \(bu 2
\fI\%mako\fP
.IP \(bu 2
\fI\%py\fP
.IP \(bu 2
\fI\%wempy\fP
.UNINDENT
.TP
.B makedirs
If set to \fBTrue\fP, then the parent directories will be created to
facilitate the creation of the named file. If \fBFalse\fP, and the parent
directory of the destination file doesn\(aqt exist, the state will fail.
.TP
.B dir_mode
If directories are to be created, passing this option specifies the
permissions for those directories. If this is not set, directories
will be assigned permissions by adding the execute bit to the mode of
the files.
.sp
The default mode for new files and directories corresponds umask of salt
process. For existing files and directories it\(aqs not enforced.
.TP
.B replace
If set to \fBFalse\fP and the file already exists, the file will not be
modified even if changes would otherwise be made. Permissions and
ownership will still be enforced, however.
.TP
.B context
Overrides default context variables passed to the template.
.TP
.B defaults
Default context passed to the template.
.TP
.B backup
Overrides the default backup mode for this specific file. See
\fI\%backup_mode documentation\fP for more details.
.TP
.B show_changes
Output a unified diff of the old file and the new file. If \fBFalse\fP
return a boolean if any changes were made.
.TP
.B create
If set to \fBFalse\fP, then the file will only be managed if the file
already exists on the system.
.TP
.B contents
Specify the contents of the file. Cannot be used in combination with
\fBsource\fP\&. Ignores hashes and does not use a templating engine.
.sp
This value can be either a single string, a multiline YAML string or a
list of strings.  If a list of strings, then the strings will be joined
together with newlines in the resulting file. For example, the below
two example states would result in identical file contents:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/path/to/file1:
  file.managed:
    \- contents:
      \- This is line 1
      \- This is line 2

/path/to/file2:
  file.managed:
    \- contents: |
        This is line 1
        This is line 2
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B contents_pillar
New in version 0.17.0.

.sp
Changed in version 2016.11.0: contents_pillar can also be a list, and the pillars will be
concatenated together to form one file.

.sp
Operates like \fBcontents\fP, but draws from a value stored in pillar,
using the pillar path syntax used in \fI\%pillar.get\fP\&. This is useful when the pillar value
contains newlines, as referencing a pillar variable using a jinja/mako
template can result in YAML formatting issues due to the newlines
causing indentation mismatches.
.sp
For example, the following could be used to deploy an SSH private key:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/home/deployer/.ssh/id_rsa:
  file.managed:
    \- user: deployer
    \- group: deployer
    \- mode: 600
    \- attrs: a
    \- contents_pillar: userdata:deployer:id_rsa
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This would populate \fB/home/deployer/.ssh/id_rsa\fP with the contents of
\fBpillar[\(aquserdata\(aq][\(aqdeployer\(aq][\(aqid_rsa\(aq]\fP\&. An example of this pillar
setup would be like so:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
userdata:
  deployer:
    id_rsa: |
        \-\-\-\-\-BEGIN RSA PRIVATE KEY\-\-\-\-\-
        MIIEowIBAAKCAQEAoQiwO3JhBquPAalQF9qP1lLZNXVjYMIswrMe2HcWUVBgh+vY
        U7sCwx/dH6+VvNwmCoqmNnP+8gTPKGl1vgAObJAnMT623dMXjVKwnEagZPRJIxDy
        B/HaAre9euNiY3LvIzBTWRSeMfT+rWvIKVBpvwlgGrfgz70m0pqxu+UyFbAGLin+
        GpxzZAMaFpZw4sSbIlRuissXZj/sHpQb8p9M5IeO4Z3rjkCP1cxI
        \-\-\-\-\-END RSA PRIVATE KEY\-\-\-\-\-
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The private key above is shortened to keep the example brief, but
shows how to do multiline string in YAML. The key is followed by a
pipe character, and the multiline string is indented two more
spaces.
.sp
To avoid the hassle of creating an indented multiline YAML string,
the \fI\%file_tree external pillar\fP can
be used instead. However, this will not work for binary files in
Salt releases before 2015.8.4.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For information on using Salt Slots and how to incorporate
execution module returns into file content or data, refer to the
\fI\%Salt Slots documentation\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B contents_grains
New in version 2014.7.0.

.sp
Operates like \fBcontents\fP, but draws from a value stored in grains,
using the grains path syntax used in \fI\%grains.get\fP\&. This functionality works similarly to
\fBcontents_pillar\fP, but with grains.
.sp
For example, the following could be used to deploy a \(dqmessage of the day\(dq
file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
write_motd:
  file.managed:
    \- name: /etc/motd
    \- contents_grains: motd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This would populate \fB/etc/motd\fP file with the contents of the \fBmotd\fP
grain. The \fBmotd\fP grain is not a default grain, and would need to be
set prior to running the state:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq grains.set motd \(aqWelcome! This system is managed by Salt.\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B contents_newline
New in version 2014.7.0.

.sp
Changed in version 2015.8.4: This option is now ignored if the contents being deployed contain
binary data.

.sp
If \fBTrue\fP, files managed using \fBcontents\fP, \fBcontents_pillar\fP, or
\fBcontents_grains\fP will have a newline added to the end of the file if
one is not present. Setting this option to \fBFalse\fP will ensure the
final line, or entry, does not contain a new line. If the last line, or
entry in the file does contain a new line already, this option will not
remove it.
.TP
.B contents_delimiter
New in version 2015.8.4.

.sp
Can be used to specify an alternate delimiter for \fBcontents_pillar\fP
or \fBcontents_grains\fP\&. This delimiter will be passed through to
\fI\%pillar.get\fP or \fI\%grains.get\fP when retrieving the contents.
.TP
.B encoding
If specified, then the specified encoding will be used. Otherwise, the
file will be encoded using the system locale (usually UTF\-8). See
\fI\%https://docs.python.org/3/library/codecs.html#standard\-encodings\fP for
the list of available encodings.
.sp
New in version 2017.7.0.

.TP
.B encoding_errors
Error encoding scheme. Default is \fB\(ga\(aqstrict\(aq\(ga\fP\&.
See \fI\%https://docs.python.org/2/library/codecs.html#codec\-base\-classes\fP
for the list of available schemes.
.sp
New in version 2017.7.0.

.TP
.B allow_empty
New in version 2015.8.4.

.sp
If set to \fBFalse\fP, then the state will fail if the contents specified
by \fBcontents_pillar\fP or \fBcontents_grains\fP are empty.
.TP
.B follow_symlinks
New in version 2014.7.0.

.sp
If the desired path is a symlink follow it and make changes to the
file to which the symlink points.
.TP
.B check_cmd
New in version 2014.7.0.

.sp
The specified command will be run with an appended argument of a
\fItemporary\fP file containing the new managed contents.  If the command
exits with a zero status the new managed contents will be written to
the managed destination. If the command exits with a nonzero exit
code, the state will fail and no changes will be made to the file.
.sp
For example, the following could be used to verify sudoers before making
changes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/sudoers:
  file.managed:
    \- user: root
    \- group: root
    \- mode: 0440
    \- attrs: i
    \- source: salt://sudoers/files/sudoers.jinja
    \- template: jinja
    \- check_cmd: /usr/sbin/visudo \-c \-f
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE\fP: This \fBcheck_cmd\fP functions differently than the requisite
\fBcheck_cmd\fP\&.
.TP
.B tmp_dir
Directory for temp file created by \fBcheck_cmd\fP\&. Useful for checkers
dependent on config file location (e.g. daemons restricted to their
own config directories by an apparmor profile).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/dhcp/dhcpd.conf:
  file.managed:
    \- user: root
    \- group: root
    \- mode: 0755
    \- tmp_dir: \(aq/etc/dhcp\(aq
    \- contents: \(dq# Managed by Salt\(dq
    \- check_cmd: dhcpd \-t \-cf
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B tmp_ext
Suffix for temp file created by \fBcheck_cmd\fP\&. Useful for checkers
dependent on config file extension (e.g. the init\-checkconf upstart
config checker).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/init/test.conf:
  file.managed:
    \- user: root
    \- group: root
    \- mode: 0440
    \- tmp_ext: \(aq.conf\(aq
    \- contents:
      \- \(aqdescription \(dqSalt Minion\(dq\(aq
      \- \(aqstart on started mountall\(aq
      \- \(aqstop on shutdown\(aq
      \- \(aqrespawn\(aq
      \- \(aqexec salt\-minion\(aq
    \- check_cmd: init\-checkconf \-f
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B skip_verify
If \fBTrue\fP, hash verification of remote file sources (\fBhttp://\fP,
\fBhttps://\fP, \fBftp://\fP) will be skipped, and the \fBsource_hash\fP
argument will be ignored.
.sp
New in version 2016.3.0.

.TP
.B selinux
Allows setting the selinux user, role, type, and range of a managed file
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/tmp/selinux.test
  file.managed:
    \- user: root
    \- selinux:
        seuser: system_u
        serole: object_r
        setype: system_conf_t
        serange: s0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.TP
.B win_owner
The owner of the directory. If this is not passed, user will be used. If
user is not passed, the account under which Salt is running will be
used.
.sp
New in version 2017.7.0.

.TP
.B win_perms
A dictionary containing permissions to grant and their propagation. For
example: \fB{\(aqAdministrators\(aq: {\(aqperms\(aq: \(aqfull_control\(aq}}\fP Can be a
single basic perm or a list of advanced perms. \fBperms\fP must be
specified. \fBapplies_to\fP does not apply to file objects.
.sp
New in version 2017.7.0.

.TP
.B win_deny_perms
A dictionary containing permissions to deny and their propagation. For
example: \fB{\(aqAdministrators\(aq: {\(aqperms\(aq: \(aqfull_control\(aq}}\fP Can be a
single basic perm or a list of advanced perms. \fBperms\fP must be
specified. \fBapplies_to\fP does not apply to file objects.
.sp
New in version 2017.7.0.

.TP
.B win_inheritance
True to inherit permissions from the parent directory, False not to
inherit permission.
.sp
New in version 2017.7.0.

.TP
.B win_perms_reset
If \fBTrue\fP the existing DACL will be cleared and replaced with the
settings defined in this function. If \fBFalse\fP, new entries will be
appended to the existing DACL. Default is \fBFalse\fP\&.
.sp
New in version 2018.3.0.

.UNINDENT
.sp
Here\(aqs an example using the above \fBwin_*\fP parameters:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
create_config_file:
  file.managed:
    \- name: C:\econfig\esettings.cfg
    \- source: salt://settings.cfg
    \- win_owner: Administrators
    \- win_perms:
        # Basic Permissions
        dev_ops:
          perms: full_control
        # List of advanced permissions
        appuser:
          perms:
            \- read_attributes
            \- read_ea
            \- create_folders
            \- read_permissions
        joe_snuffy:
          perms: read
    \- win_deny_perms:
        fred_snuffy:
          perms: full_control
    \- win_inheritance: False
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B verify_ssl
If \fBFalse\fP, remote https file sources (\fBhttps://\fP) and source_hash
will not attempt to validate the servers certificate. Default is True.
.sp
New in version 3002.

.TP
.B use_etag
If \fBTrue\fP, remote http/https file sources will attempt to use the
ETag header to determine if the remote file needs to be downloaded.
This provides a lightweight mechanism for promptly refreshing files
changed on a web server without requiring a full hash comparison via
the \fBsource_hash\fP parameter.
.sp
New in version 3005.

.TP
.B signature
Ensure a valid GPG signature exists on the selected \fBsource\fP file.
Set this to true for inline signatures, or to a file URI retrievable
by \fI:py:func:\(gacp.cache_file <salt.modules.cp.cache_file>\fP
for a detached one.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A signature is only enforced directly after caching the file,
before it is moved to its final destination. Existing target files
(with the correct checksum) will neither be checked nor deleted.
.sp
It will be enforced regardless of source type and will be
required on the final output, therefore this does not lend itself
well when templates are rendered.
The file will not be modified, meaning inline signatures are not
removed.
.UNINDENT
.UNINDENT
.sp
New in version 3007.0.

.TP
.B source_hash_sig
When \fBsource\fP is a remote file source, \fBsource_hash\fP is a file,
\fBskip_verify\fP is not true and \fBuse_etag\fP is not true, ensure a
valid GPG signature exists on the source hash file.
Set this to \fBtrue\fP for an inline (clearsigned) signature, or to a
file URI retrievable by \fI:py:func:\(gacp.cache_file <salt.modules.cp.cache_file>\fP
for a detached one.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A signature on the \fBsource_hash\fP file is enforced regardless of
changes since its contents are used to check if an existing file
is in the correct state \- but only for remote sources!
As for \fBsignature\fP, existing target files will not be modified,
only the cached source_hash and source_hash_sig files will be removed.
.UNINDENT
.UNINDENT
.sp
New in version 3007.0.

.TP
.B signed_by_any
When verifying signatures either on the managed file or its source hash file,
require at least one valid signature from one of a list of key fingerprints.
This is passed to \fI\%gpg.verify\fP\&.
.sp
New in version 3007.0.

.TP
.B signed_by_all
When verifying signatures either on the managed file or its source hash file,
require a valid signature from each of the key fingerprints in this list.
This is passed to \fI\%gpg.verify\fP\&.
.sp
New in version 3007.0.

.TP
.B keyring
When verifying signatures, use this keyring.
.sp
New in version 3007.0.

.TP
.B gnupghome
When verifying signatures, use this GnuPG home.
.sp
New in version 3007.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.missing(name, **kwargs)
Verify that the named file or directory is missing, this returns True only
if the named file is missing but does not remove the file if it is present.
.INDENT 7.0
.TP
.B name
Absolute path which must NOT exist
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.mknod(name, ntype, major=0, minor=0, user=None, group=None, mode=\(aq0600\(aq)
Create a special file similar to the \(aqnix mknod command. The supported
device types are \fBp\fP (fifo pipe), \fBc\fP (character device), and \fBb\fP
(block device). Provide the major and minor numbers when specifying a
character device or block device. A fifo pipe does not require this
information. The command will create the necessary dirs if needed. If a
file of the same name not of the same type/major/minor exists, it will not
be overwritten or unlinked (deleted). This is logically in place as a
safety measure because you can really shoot yourself in the foot here and
it is the behavior of \(aqnix \fBmknod\fP\&. It is also important to note that not
just anyone can create special devices. Usually this is only done as root.
If the state is executed as none other than root on a minion, you may
receive a permission error.
.INDENT 7.0
.TP
.B name
name of the file
.TP
.B ntype
node type \(aqp\(aq (fifo pipe), \(aqc\(aq (character device), or \(aqb\(aq
(block device)
.TP
.B major
major number of the device
does not apply to a fifo pipe
.TP
.B minor
minor number of the device
does not apply to a fifo pipe
.TP
.B user
owning user of the device/pipe
.TP
.B group
owning group of the device/pipe
.TP
.B mode
permissions on the device/pipe
.UNINDENT
.sp
Usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/dev/chr:
  file.mknod:
    \- ntype: c
    \- major: 180
    \- minor: 31
    \- user: root
    \- group: root
    \- mode: 660

/dev/blk:
  file.mknod:
    \- ntype: b
    \- major: 8
    \- minor: 999
    \- user: root
    \- group: root
    \- mode: 660

/dev/fifo:
  file.mknod:
    \- ntype: p
    \- user: root
    \- group: root
    \- mode: 660
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 0.17.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.mod_beacon(name, **kwargs)
Create a beacon to monitor a file based on a beacon state argument.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state exists to support special handling of the \fBbeacon\fP
state argument for supported state functions. It should not be called directly.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.mod_run_check_cmd(cmd, filename, **check_cmd_opts)
Execute the check_cmd logic.
.sp
Return True if \fBcheck_cmd\fP succeeds (check_cmd == 0)
otherwise return a result dict
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.not_cached(name, saltenv=\(aqbase\(aq)
New in version 2017.7.3.

.sp
Ensures that a file is not present in the minion\(aqs cache, deleting it
if found. This state is primarily invoked by other states to ensure
that a fresh copy is fetched.
.INDENT 7.0
.TP
.B name
The URL of the file to be removed from cache. To remove a file from
cache in an environment other than \fBbase\fP, either use the \fBsaltenv\fP
argument or include the saltenv in the URL (e.g.
\fBsalt://path/to/file.conf?saltenv=dev\fP).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A list of URLs is not supported, this must be a single URL. If a
local file is passed here, the state will take no action.
.UNINDENT
.UNINDENT
.TP
.B saltenv
Used to specify the environment from which to download a file from the
Salt fileserver (i.e. those with \fBsalt://\fP URL).
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.patch(name, source=None, source_hash=None, source_hash_name=None, skip_verify=False, template=None, context=None, defaults=None, options=\(aq\(aq, reject_file=None, strip=None, saltenv=None, **kwargs)
Ensure that a patch has been applied to the specified file or directory
.sp
Changed in version 2019.2.0: The \fBhash\fP and \fBdry_run_first\fP options are now ignored, as the
logic which determines whether or not the patch has already been
applied no longer requires them. Additionally, this state now supports
patch files that modify more than one file. To use these sort of
patches, specify a directory (and, if necessary, the \fBstrip\fP option)
instead of a file.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A suitable \fBpatch\fP executable must be available on the minion. Also,
keep in mind that the pre\-check this state does to determine whether or
not changes need to be made will create a temp file and send all patch
output to that file. This means that, in the event that the patch would
not have applied cleanly, the comment included in the state results will
reference a temp file that will no longer exist once the state finishes
running.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The file or directory to which the patch should be applied
.TP
.B source
The patch file to apply
.sp
Changed in version 2019.2.0: The source can now be from any file source supported by Salt
(\fBsalt://\fP, \fBhttp://\fP, \fBhttps://\fP, \fBftp://\fP, etc.).
Templating is also now supported.

.TP
.B source_hash
Works the same way as in \fI\%file.managed\fP\&.
.sp
New in version 2019.2.0.

.TP
.B source_hash_name
Works the same way as in \fI\%file.managed\fP
.sp
New in version 2019.2.0.

.TP
.B skip_verify
Works the same way as in \fI\%file.managed\fP
.sp
New in version 2019.2.0.

.TP
.B template
Works the same way as in \fI\%file.managed\fP
.sp
New in version 2019.2.0.

.TP
.B context
Works the same way as in \fI\%file.managed\fP
.sp
New in version 2019.2.0.

.TP
.B defaults
Works the same way as in \fI\%file.managed\fP
.sp
New in version 2019.2.0.

.TP
.B options
Extra options to pass to patch. This should not be necessary in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For best results, short opts should be separate from one another.
The \fB\-N\fP and \fB\-r\fP, and \fB\-o\fP options are used internally by
this state and cannot be used here. Additionally, instead of using
\fB\-pN\fP or \fB\-\-strip=N\fP, use the \fBstrip\fP option documented
below.
.UNINDENT
.UNINDENT
.TP
.B reject_file
If specified, any rejected hunks will be written to this file. If not
specified, then they will be written to a temp file which will be
deleted when the state finishes running.
.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
The parent directory must exist. Also, this will overwrite the file
if it is already present.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B strip
Number of directories to strip from paths in the patch file. For
example, using the below SLS would instruct Salt to use \fB\-p1\fP when
applying the patch:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/myfile.conf:
  file.patch:
    \- source: salt://myfile.patch
    \- strip: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0: In previous versions, \fB\-p1\fP would need to be passed as part of
the \fBoptions\fP value.

.TP
.B saltenv
Specify the environment from which to retrieve the patch file indicated
by the \fBsource\fP parameter. If not provided, this defaults to the
environment from which the state is being executed.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Ignored when the patch file is from a non\-\fBsalt://\fP source.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBUsage:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Equivalent to \(ga\(gapatch \-\-forward /opt/myfile.txt myfile.patch\(ga\(ga
/opt/myfile.txt:
  file.patch:
    \- source: salt://myfile.patch
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.prepend(name, text=None, makedirs=False, source=None, source_hash=None, template=\(aqjinja\(aq, sources=None, source_hashes=None, defaults=None, context=None, header=None)
Ensure that some text appears at the beginning of a file
.sp
The text will not be prepended again if it already exists in the file. You
may specify a single line of text or a list of lines to append.
.INDENT 7.0
.TP
.B name
The location of the file to prepend to.
.TP
.B text
The text to be prepended, which can be a single string or a list
of strings.
.TP
.B makedirs
If the file is located in a path without a parent directory,
then the state will fail. If makedirs is set to True, then
the parent directories will be created to facilitate the
creation of the named file. Defaults to False.
.TP
.B source
A single source file to prepend. This source file can be hosted on either
the salt master server, or on an HTTP or FTP server. Both HTTPS and
HTTP are supported as well as downloading directly from Amazon S3
compatible URLs with both pre\-configured and automatic IAM credentials
(see s3.get state documentation). File retrieval from Openstack Swift
object storage is supported via swift://container/object_path URLs
(see swift.get documentation).
.sp
For files hosted on the salt file server, if the file is located on
the master in the directory named spam, and is called eggs, the source
string is salt://spam/eggs.
.sp
If the file is hosted on an HTTP or FTP server, the source_hash argument
is also required.
.TP
.B source_hash
.INDENT 7.0
.TP
.B This can be one of the following:
.INDENT 7.0
.IP 1. 3
a source hash string
.IP 2. 3
the URI of a file that contains source hash strings
.UNINDENT
.UNINDENT
.sp
The function accepts the first encountered long unbroken alphanumeric
string of correct length as a valid hash, in order from most secure to
least secure:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Type    Length
======  ======
sha512     128
sha384      96
sha256      64
sha224      56
sha1        40
md5         32
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See the \fBsource_hash\fP parameter description for \fI\%file.managed\fP function for more details and examples.
.TP
.B template
The named templating engine will be used to render the source file(s).
Defaults to \fBjinja\fP\&. The following templates are supported:
.INDENT 7.0
.IP \(bu 2
\fI\%cheetah\fP
.IP \(bu 2
\fI\%genshi\fP
.IP \(bu 2
\fI\%jinja\fP
.IP \(bu 2
\fI\%mako\fP
.IP \(bu 2
\fI\%py\fP
.IP \(bu 2
\fI\%wempy\fP
.UNINDENT
.TP
.B sources
A list of source files to prepend. If the files are hosted on an HTTP or
FTP server, the source_hashes argument is also required.
.TP
.B source_hashes
A list of source_hashes corresponding to the sources list specified in
the sources argument.
.TP
.B defaults
Default context passed to the template.
.TP
.B context
Overrides default context variables passed to the template.
.TP
.B ignore_whitespace
New in version 2015.8.4.

.sp
Spaces and Tabs in text are ignored by default, when searching for the
appending content, one space or multiple tabs are the same for salt.
Set this option to \fBFalse\fP if you want to change this behavior.
.TP
.B header
Forces the text to be prepended. If it exists in the file but not at
the beginning, then it prepends a duplicate.
.UNINDENT
.sp
Multi\-line example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/motd:
  file.prepend:
    \- text: |
        Thou hadst better eat salt with the Philosophers of Greece,
        than sugar with the Courtiers of Italy.
        \- Benjamin Franklin
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple lines of text:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/motd:
  file.prepend:
    \- text:
      \- Trust no one unless you have eaten much salt with him.
      \- \(dqSalt is born of the purest of parents: the sun and the sea.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Optionally, require the text to appear exactly as specified
(order and position). Combine with multi\-line or multiple lines of input.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/motd:
  file.prepend:
    \- header: True
    \- text:
      \- This will be the very first line in the file.
      \- The 2nd line, regardless of duplicates elsewhere in the file.
      \- These will be written anew if they do not appear verbatim.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Gather text from multiple template files:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/motd:
  file:
    \- prepend
    \- template: jinja
    \- sources:
      \- salt://motd/devops\-messages.tmpl
      \- salt://motd/hr\-messages.tmpl
      \- salt://motd/general\-messages.tmpl
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2014.7.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.pruned(name, recurse=False, ignore_errors=False, older_than=None)
New in version 3006.0.

.sp
Ensure that the named directory is absent. If it exists and is empty, it
will be deleted. An entire directory tree can be pruned of empty
directories as well, by using the \fBrecurse\fP option.
.INDENT 7.0
.TP
.B name
The directory which should be deleted if empty.
.TP
.B recurse
If set to \fBTrue\fP, this option will recursive deletion of empty
directories. This is useful if nested paths are all empty, and would
be the only items preventing removal of the named root directory.
.TP
.B ignore_errors
If set to \fBTrue\fP, any errors encountered while attempting to delete a
directory are ignored. This \fBAUTOMATICALLY ENABLES\fP the \fBrecurse\fP
option since it\(aqs not terribly useful to ignore errors on the removal of
a single directory. Useful for pruning only the empty directories in a
tree which contains non\-empty directories as well.
.TP
.B older_than
When \fBolder_than\fP is set to a number, it is used to determine the
\fBnumber of days\fP which must have passed since the last modification
timestamp before a directory will be allowed to be removed. Setting
the value to 0 is equivalent to leaving it at the default of \fBNone\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.recurse(name, source, keep_source=True, clean=False, require=None, user=None, group=None, dir_mode=None, file_mode=None, sym_mode=None, template=None, context=None, replace=True, defaults=None, include_empty=False, backup=\(aq\(aq, include_pat=None, exclude_pat=None, maxdepth=None, keep_symlinks=False, force_symlinks=False, win_owner=None, win_perms=None, win_deny_perms=None, win_inheritance=True, **kwargs)
Recurse through a subdirectory on the master and copy said subdirectory
over to the specified path.
.INDENT 7.0
.TP
.B name
The directory to set the recursion in
.TP
.B source
The source directory, this directory is located on the salt master file
server and is specified with the salt:// protocol. If the directory is
located on the master in the directory named spam, and is called eggs,
the source string is salt://spam/eggs
.TP
.B keep_source
Set to \fBFalse\fP to discard the cached copy of the source file once the
state completes. This can be useful for larger files to keep them from
taking up space in minion cache. However, keep in mind that discarding
the source file will result in the state needing to re\-download the
source file if the state is run again.
.sp
New in version 2017.7.3.

.TP
.B clean
Make sure that only files that are set up by salt and required by this
function are kept. If this option is set then everything in this
directory will be deleted unless it is required.
.TP
.B require
Require other resources such as packages or files
.TP
.B user
The user to own the directory. This defaults to the user salt is
running as on the minion
.TP
.B group
The group ownership set for the directory. This defaults to the group
salt is running as on the minion. On Windows, this is ignored
.TP
.B dir_mode
The permissions mode to set on any directories created.
.sp
The default mode for new files and directories corresponds umask of salt
process. For existing files and directories it\(aqs not enforced.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option is \fBnot\fP supported on Windows.
.UNINDENT
.UNINDENT
.TP
.B file_mode
The permissions mode to set on any files created.
.sp
The default mode for new files and directories corresponds umask of salt
process. For existing files and directories it\(aqs not enforced.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option is \fBnot\fP supported on Windows.
.UNINDENT
.UNINDENT
.sp
Changed in version 2016.11.0: This option can be set to \fBkeep\fP, and Salt will keep the mode
from the Salt fileserver. This is only supported when the
\fBsource\fP URL begins with \fBsalt://\fP, or for files local to the
minion. Because the \fBsource\fP option cannot be used with any of
the \fBcontents\fP options, setting the \fBmode\fP to \fBkeep\fP is also
incompatible with the \fBcontents\fP options.

.TP
.B sym_mode
The permissions mode to set on any symlink created.
.sp
The default mode for new files and directories corresponds umask of salt
process. For existing files and directories it\(aqs not enforced.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option is \fBnot\fP supported on Windows.
.UNINDENT
.UNINDENT
.TP
.B template
If this setting is applied, the named templating engine will be used to
render the downloaded file. The following templates are supported:
.INDENT 7.0
.IP \(bu 2
\fI\%cheetah\fP
.IP \(bu 2
\fI\%genshi\fP
.IP \(bu 2
\fI\%jinja\fP
.IP \(bu 2
\fI\%mako\fP
.IP \(bu 2
\fI\%py\fP
.IP \(bu 2
\fI\%wempy\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The template option is required when recursively applying templates.
.UNINDENT
.UNINDENT
.TP
.B replace
If set to \fBFalse\fP and the file already exists, the file will not be
modified even if changes would otherwise be made. Permissions and
ownership will still be enforced, however.
.TP
.B context
Overrides default context variables passed to the template.
.TP
.B defaults
Default context passed to the template.
.TP
.B include_empty
Set this to True if empty directories should also be created
(default is False)
.TP
.B backup
Overrides the default backup mode for all replaced files. See
\fI\%backup_mode documentation\fP for more details.
.TP
.B include_pat
When copying, include only this pattern, or list of patterns, from the
source. Default is glob match; if prefixed with \(aqE@\(aq, then regexp match.
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- include_pat: hello*       :: glob matches \(aqhello01\(aq, \(aqhello02\(aq
                               ... but not \(aqotherhello\(aq
\- include_pat: E@hello      :: regexp matches \(aqotherhello\(aq,
                               \(aqhello01\(aq ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3001: List patterns are now supported

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- include_pat:
    \- hello01
    \- hello02
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B exclude_pat
Exclude this pattern, or list of patterns, from the source when copying.
If both \fIinclude_pat\fP and \fIexclude_pat\fP are supplied, then it will apply
conditions cumulatively. i.e. first select based on include_pat, and
then within that result apply exclude_pat.
.sp
Also, when \(aqclean=True\(aq, exclude this pattern from the removal
list and preserve in the destination.
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- exclude_pat: APPDATA*               :: glob matches APPDATA.01,
                                         APPDATA.02,.. for exclusion
\- exclude_pat: E@(APPDATA)|(TEMPDATA) :: regexp matches APPDATA
                                         or TEMPDATA for exclusion
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3001: List patterns are now supported

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- exclude_pat:
    \- APPDATA.01
    \- APPDATA.02
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B maxdepth
When copying, only copy paths which are of depth \fImaxdepth\fP from the
source path.
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- maxdepth: 0      :: Only include files located in the source
                      directory
\- maxdepth: 1      :: Only include files located in the source
                      or immediate subdirectories
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B keep_symlinks
Keep symlinks when copying from the source. This option will cause
the copy operation to terminate at the symlink. If desire behavior
similar to rsync, then set this to True. This option is not taken
in account if \fBfileserver_followsymlinks\fP is set to False.
.TP
.B force_symlinks
Force symlink creation. This option will force the symlink creation.
If a file or directory is obstructing symlink creation it will be
recursively removed so that symlink creation can proceed. This
option is usually not needed except in special circumstances. This
option is not taken in account if \fBfileserver_followsymlinks\fP is
set to False.
.TP
.B win_owner
The owner of the symlink and directories if \fBmakedirs\fP is True. If
this is not passed, \fBuser\fP will be used. If \fBuser\fP is not passed,
the account under which Salt is running will be used.
.sp
New in version 2017.7.7.

.TP
.B win_perms
A dictionary containing permissions to grant
.sp
New in version 2017.7.7.

.TP
.B win_deny_perms
A dictionary containing permissions to deny
.sp
New in version 2017.7.7.

.TP
.B win_inheritance
True to inherit permissions from parent, otherwise False
.sp
New in version 2017.7.7.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.rename(name, source, force=False, makedirs=False, **kwargs)
If the source file exists on the system, rename it to the named file. The
named file will not be overwritten if it already exists unless the force
option is set to True.
.INDENT 7.0
.TP
.B name
The location of the file to rename to
.TP
.B source
The location of the file to move to the location specified with name
.TP
.B force
If the target location is present then the file will not be moved,
specify \(dqforce: True\(dq to overwrite the target file
.TP
.B makedirs
If the target subdirectories don\(aqt exist create them
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.replace(name, pattern, repl, count=0, flags=8, bufsize=1, append_if_not_found=False, prepend_if_not_found=False, not_found_content=None, backup=\(aq.bak\(aq, show_changes=True, ignore_if_missing=False, backslash_literal=False)
Maintain an edit in a file.
.sp
New in version 0.17.0.

.INDENT 7.0
.TP
.B name
Filesystem path to the file to be edited. If a symlink is specified, it
will be resolved to its target.
.TP
.B pattern
A regular expression, to be matched using Python\(aqs
\fI\%re.search()\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If you need to match a literal string that contains regex special
characters, you may want to use salt\(aqs custom Jinja filter,
\fBregex_escape\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ \(aqhttp://example.com?foo=bar%20baz\(aq | regex_escape }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B repl
The replacement text
.TP
.B count
Maximum number of pattern occurrences to be replaced.  Defaults to 0.
If count is a positive integer n, no more than n occurrences will be
replaced, otherwise all occurrences will be replaced.
.TP
.B flags
A list of flags defined in the \fBre\fP module documentation from the
Python standard library. Each list item should be a string that will
correlate to the human\-friendly flag name. E.g., \fB[\(aqIGNORECASE\(aq,
\(aqMULTILINE\(aq]\fP\&.  Optionally, \fBflags\fP may be an int, with a value
corresponding to the XOR (\fB|\fP) of all the desired flags. Defaults to
\fB8\fP (which equates to \fB[\(aqMULTILINE\(aq]\fP).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBfile.replace\fP reads the entire file as a string to support
multiline regex patterns. Therefore, when using anchors such as
\fB^\fP or \fB$\fP in the pattern, those anchors may be relative to
the line OR relative to the file. The default for \fBfile.replace\fP
is to treat anchors as relative to the line, which is implemented
by setting the default value of \fBflags\fP to \fB[\(aqMULTILINE\(aq]\fP\&.
When overriding the default value for \fBflags\fP, if
\fB\(aqMULTILINE\(aq\fP is not present then anchors will be relative to
the file. If the desired behavior is for anchors to be relative to
the line, then simply add \fB\(aqMULTILINE\(aq\fP to the list of flags.
.UNINDENT
.UNINDENT
.TP
.B bufsize
How much of the file to buffer into memory at once. The default value
\fB1\fP processes one line at a time. The special value \fBfile\fP may be
specified which will read the entire file into memory before
processing.
.TP
.B append_if_not_found
If set to \fBTrue\fP, and pattern is not found, then the content will be
appended to the file.
.sp
New in version 2014.7.0.

.TP
.B prepend_if_not_found
If set to \fBTrue\fP and pattern is not found, then the content will be
prepended to the file.
.sp
New in version 2014.7.0.

.TP
.B not_found_content
Content to use for append/prepend if not found. If \fBNone\fP (default),
uses \fBrepl\fP\&. Useful when \fBrepl\fP uses references to group in
pattern.
.sp
New in version 2014.7.0.

.TP
.B backup
The file extension to use for a backup of the file before editing. Set
to \fBFalse\fP to skip making a backup.
.TP
.B show_changes
Output a unified diff of the old file and the new file. If \fBFalse\fP
return a boolean if any changes were made. Returns a boolean or a
string.
.TP
.B ignore_if_missing
New in version 2016.3.4.

.sp
Controls what to do if the file is missing. If set to \fBFalse\fP, the
state will display an error raised by the execution module. If set to
\fBTrue\fP, the state will simply report no changes.
.TP
.B backslash_literal
New in version 2016.11.7.

.sp
Interpret backslashes as literal backslashes for the repl and not
escape characters.  This will help when using append/prepend so that
the backslashes are not interpreted for the repl on the second run of
the state.
.UNINDENT
.sp
For complex regex patterns, it can be useful to avoid the need for complex
quoting and escape sequences by making use of YAML\(aqs multiline string
syntax.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
complex_search_and_replace:
  file.replace:
    # <...snip...>
    \- pattern: |
        CentOS \e(2.6.32[^\e\en]+\e\en\es+root[^\e\en]+\e\en\e)+
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using YAML multiline string syntax in \fBpattern:\fP, make sure to
also use that syntax in the \fBrepl:\fP part, or you might loose line
feeds.
.UNINDENT
.UNINDENT
.sp
When regex capture groups are used in \fBpattern:\fP, their captured value is
available for reuse in the \fBrepl:\fP part as a backreference (ex. \fB\e1\fP).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
add_login_group_to_winbind_ssh_access_list:
  file.replace:
    \- name: \(aq/etc/security/pam_winbind.conf\(aq
    \- pattern: \(aq^(require_membership_of = )(.*)$\(aq
    \- repl: \(aq\e1\e2,append\-new\-group\-to\-line\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fBfile.replace\fP state uses Python\(aqs \fBre\fP module.
For more advanced options, see \fI\%https://docs.python.org/2/library/re.html\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.retention_schedule(name, retain, strptime_format=None, timezone=None)
Apply retention scheduling to backup storage directory.
.sp
New in version 2016.11.0.

.sp
Changed in version 3006.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The filesystem path to the directory containing backups to be managed.
.IP \(bu 2
\fBretain\fP \-\-
.sp
Delete the backups, except for the ones we want to keep.
The N below should be an integer but may also be the special value of \fBall\fP,
which keeps all files matching the criteria.
All of the retain options default to None,
which means to not keep files based on this criteria.
.INDENT 2.0
.TP
.B most_recent N
Keep the most recent N files.
.TP
.B first_of_hour N
For the last N hours from now, keep the first file after the hour.
.TP
.B first_of_day N
For the last N days from now, keep the first file after midnight.
See also \fBtimezone\fP\&.
.TP
.B first_of_week N
For the last N weeks from now, keep the first file after Sunday midnight.
.TP
.B first_of_month N
For the last N months from now, keep the first file after the start of the month.
.TP
.B first_of_year N
For the last N years from now, keep the first file after the start of the year.
.UNINDENT

.IP \(bu 2
\fBstrptime_format\fP \-\- A python strptime format string used to first match the filenames of backups
and then parse the filename to determine the datetime of the file.
\fI\%https://docs.python.org/2/library/datetime.html#datetime.datetime.strptime\fP
Defaults to None, which considers all files in the directory to be backups eligible for deletion
and uses \fBos.path.getmtime()\fP to determine the datetime.
.IP \(bu 2
\fBtimezone\fP \-\- The timezone to use when determining midnight.
This is only used when datetime is pulled from \fBos.path.getmtime()\fP\&.
Defaults to \fBNone\fP which uses the timezone from the locale.
.UNINDENT
.UNINDENT
.sp
Usage example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/var/backups/example_directory:
  file.retention_schedule:
    \- retain:
        most_recent: 5
        first_of_hour: 4
        first_of_day: 7
        first_of_week: 6    # NotImplemented yet.
        first_of_month: 6
        first_of_year: all
    \- strptime_format: example_name_%Y%m%dT%H%M%S.tar.bz2
    \- timezone: None
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.serialize(name, dataset=None, dataset_pillar=None, user=None, group=None, mode=None, backup=\(aq\(aq, makedirs=False, show_changes=True, create=True, merge_if_exists=False, encoding=None, encoding_errors=\(aqstrict\(aq, serializer=None, serializer_opts=None, deserializer_opts=None, check_cmd=None, tmp_dir=\(aq\(aq, tmp_ext=\(aq\(aq, **kwargs)
Serializes dataset and store it into managed file. Useful for sharing
simple configuration files.
.INDENT 7.0
.TP
.B name
The location of the file to create
.TP
.B dataset
The dataset that will be serialized
.TP
.B dataset_pillar
Operates like \fBdataset\fP, but draws from a value stored in pillar,
using the pillar path syntax used in \fI\%pillar.get\fP\&. This is useful when the pillar value
contains newlines, as referencing a pillar variable using a jinja/mako
template can result in YAML formatting issues due to the newlines
causing indentation mismatches.
.sp
New in version 2015.8.0.

.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For information on using Salt Slots and how to incorporate
execution module returns into file content or data, refer to the
\fI\%Salt Slots documentation\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B serializer (or formatter)
Write the data as this format. See the list of
\fI\%serializer modules\fP for supported output formats.
.sp
Changed in version 3002: \fBserializer\fP argument added as an alternative to \fBformatter\fP\&.
Both are accepted, but using both will result in an error.

.TP
.B encoding
If specified, then the specified encoding will be used. Otherwise, the
file will be encoded using the system locale (usually UTF\-8). See
\fI\%https://docs.python.org/3/library/codecs.html#standard\-encodings\fP for
the list of available encodings.
.sp
New in version 2017.7.0.

.TP
.B encoding_errors
Error encoding scheme. Default is \fB\(ga\(aqstrict\(aq\(ga\fP\&.
See \fI\%https://docs.python.org/2/library/codecs.html#codec\-base\-classes\fP
for the list of available schemes.
.sp
New in version 2017.7.0.

.TP
.B user
The user to own the directory, this defaults to the user salt is
running as on the minion
.TP
.B group
The group ownership set for the directory, this defaults to the group
salt is running as on the minion
.TP
.B mode
The permissions to set on this file, e.g. \fB644\fP, \fB0775\fP, or
\fB4664\fP\&.
.sp
The default mode for new files and directories corresponds umask of salt
process. For existing files and directories it\(aqs not enforced.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option is \fBnot\fP supported on Windows.
.UNINDENT
.UNINDENT
.TP
.B backup
Overrides the default backup mode for this specific file.
.TP
.B makedirs
Create parent directories for destination file.
.sp
New in version 2014.1.3.

.TP
.B show_changes
Output a unified diff of the old file and the new file. If \fBFalse\fP
return a boolean if any changes were made.
.TP
.B create
Default is True, if create is set to False then the file will only be
managed if the file already exists on the system.
.TP
.B merge_if_exists
Default is False, if merge_if_exists is True then the existing file will
be parsed and the dataset passed in will be merged with the existing
content
.sp
New in version 2014.7.0.

.TP
.B serializer_opts
Pass through options to serializer. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/dummy/package.yaml
  file.serialize:
    \- serializer: yaml
    \- serializer_opts:
      \- explicit_start: True
      \- default_flow_style: True
      \- indent: 4
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The valid opts are the additional opts (i.e. not the data being
serialized) for the function used to serialize the data. Documentation
for the these functions can be found in the list below:
.INDENT 7.0
.IP \(bu 2
For \fByaml\fP: \fI\%yaml.dump()\fP
.IP \(bu 2
For \fBjson\fP: \fI\%json.dumps()\fP
.IP \(bu 2
For \fBpython\fP: \fI\%pprint.pformat()\fP
.IP \(bu 2
For \fBmsgpack\fP: Run \fBpython \-c \(aqimport msgpack; help(msgpack.Packer)\(aq\fP
to see the available options (\fBencoding\fP, \fBunicode_errors\fP, etc.)
.UNINDENT
.TP
.B deserializer_opts
Like \fBserializer_opts\fP above, but only used when merging with an
existing file (i.e. when \fBmerge_if_exists\fP is set to \fBTrue\fP).
.sp
The options specified here will be passed to the deserializer to load
the existing data, before merging with the specified data and
re\-serializing.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/dummy/package.yaml
  file.serialize:
    \- serializer: yaml
    \- serializer_opts:
      \- explicit_start: True
      \- default_flow_style: True
      \- indent: 4
    \- deserializer_opts:
      \- encoding: latin\-1
    \- merge_if_exists: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The valid opts are the additional opts (i.e. not the data being
deserialized) for the function used to deserialize the data.
Documentation for the these functions can be found in the list below:
.INDENT 7.0
.IP \(bu 2
For \fByaml\fP: \fI\%yaml.load()\fP
.IP \(bu 2
For \fBjson\fP: \fI\%json.loads()\fP
.UNINDENT
.sp
However, note that not all arguments are supported. For example, when
deserializing JSON, arguments like \fBparse_float\fP and \fBparse_int\fP
which accept a callable object cannot be handled in an SLS file.
.sp
New in version 2019.2.0.

.TP
.B check_cmd
The specified command will be run with an appended argument of a
\fItemporary\fP file containing the new file contents.  If the command
exits with a zero status the new file contents will be written to
the state output destination. If the command exits with a nonzero exit
code, the state will fail and no changes will be made to the file.
.sp
For example, the following could be used to verify sudoers before making
changes:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/consul.d/my_config.json:
  file.serialize:
    \- dataset:
        datacenter: \(dqeast\-aws\(dq
        data_dir: \(dq/opt/consul\(dq
        log_level: \(dqINFO\(dq
        node_name: \(dqfoobar\(dq
        server: true
        watches:
          \- type: checks
            handler: \(dq/usr/bin/health\-check\-handler.sh\(dq
        telemetry:
          statsite_address: \(dq127.0.0.1:2180\(dq
    \- serializer: json
    \- check_cmd: consul validate
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE\fP: This \fBcheck_cmd\fP functions differently than the requisite
\fBcheck_cmd\fP\&.
.sp
New in version 3007.0.

.TP
.B tmp_dir
Directory for temp file created by \fBcheck_cmd\fP\&. Useful for checkers
dependent on config file location (e.g. daemons restricted to their
own config directories by an apparmor profile).
.sp
New in version 3007.0.

.TP
.B tmp_ext
Suffix for temp file created by \fBcheck_cmd\fP\&. Useful for checkers
dependent on config file extension.
.sp
New in version 3007.0.

.UNINDENT
.sp
For example, this state:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/dummy/package.json:
  file.serialize:
    \- dataset:
        name: naive
        description: A package using naive versioning
        author: A confused individual <iam@confused.com>
        dependencies:
          express: \(aq>= 1.2.0\(aq
          optimist: \(aq>= 0.1.0\(aq
        engine: node 0.4.1
    \- serializer: json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will manage the file \fB/etc/dummy/package.json\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
  \(dqauthor\(dq: \(dqA confused individual <iam@confused.com>\(dq,
  \(dqdependencies\(dq: {
    \(dqexpress\(dq: \(dq>= 1.2.0\(dq,
    \(dqoptimist\(dq: \(dq>= 0.1.0\(dq
  },
  \(dqdescription\(dq: \(dqA package using naive versioning\(dq,
  \(dqengine\(dq: \(dqnode 0.4.1\(dq,
  \(dqname\(dq: \(dqnaive\(dq
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.shortcut(name, target, arguments=None, working_dir=None, description=None, icon_location=None, force=False, backupname=None, makedirs=False, user=None, **kwargs)
Create a Windows shortcut
.sp
If the file already exists and is a shortcut pointing to any location other
than the specified target, the shortcut will be replaced. If it is
a regular file or directory then the state will return False. If the
regular file or directory is desired to be replaced with a shortcut pass
force: True, if it is to be renamed, pass a backupname.
.INDENT 7.0
.TP
.B name
The location of the shortcut to create. Must end with either
\(dq.lnk\(dq or \(dq.url\(dq
.TP
.B target
The location that the shortcut points to
.TP
.B arguments
Any arguments to pass in the shortcut
.TP
.B working_dir
Working directory in which to execute target
.TP
.B description
Description to set on shortcut
.TP
.B icon_location
Location of shortcut\(aqs icon
.TP
.B force
If the name of the shortcut exists and is not a file and
force is set to False, the state will fail. If force is set to
True, the link or directory in the way of the shortcut file
will be deleted to make room for the shortcut, unless
backupname is set, when it will be renamed
.TP
.B backupname
If the name of the shortcut exists and is not a file, it will be
renamed to the backupname. If the backupname already
exists and force is False, the state will fail. Otherwise, the
backupname will be removed first.
.TP
.B makedirs
If the location of the shortcut does not already have a parent
directory then the state will fail, setting makedirs to True will
allow Salt to create the parent directory. Setting this to True will
also create the parent for backupname if necessary.
.TP
.B user
The user to own the file, this defaults to the user salt is running as
on the minion
.sp
The default mode for new files and directories corresponds umask of salt
process. For existing files and directories it\(aqs not enforced.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.symlink(name, target, force=False, backupname=None, makedirs=False, user=None, group=None, mode=None, win_owner=None, win_perms=None, win_deny_perms=None, win_inheritance=None, atomic=False, disallow_copy_and_unlink=False, inherit_user_and_group=False, follow_symlinks=True, **kwargs)
Create a symbolic link (symlink, soft link)
.sp
If the file already exists and is a symlink pointing to any location other
than the specified target, the symlink will be replaced. If an entry with
the same name exists then the state will return False. If the existing
entry is desired to be replaced with a symlink pass force: True, if it is
to be renamed, pass a backupname.
.INDENT 7.0
.TP
.B name
The location of the symlink to create
.TP
.B target
The location that the symlink points to
.TP
.B force
If the name of the symlink exists and is not a symlink and
force is set to False, the state will fail. If force is set to
True, the existing entry in the way of the symlink file
will be deleted to make room for the symlink, unless
backupname is set, when it will be renamed
.sp
Changed in version 3000: Force will now remove all types of existing file system entries,
not just files, directories and symlinks.

.TP
.B backupname
If the name of the symlink exists and is not a symlink, it will be
renamed to the backupname. If the backupname already
exists and force is False, the state will fail. Otherwise, the
backupname will be removed first.
An absolute path OR a basename file/directory name must be provided.
The latter will be placed relative to the symlink destination\(aqs parent
directory.
.TP
.B makedirs
If the location of the symlink does not already have a parent directory
then the state will fail, setting makedirs to True will allow Salt to
create the parent directory
.TP
.B user
The user to own the file, this defaults to the user salt is running as
on the minion unless the link already exists and
\fBinherit_user_and_group\fP is set
.TP
.B group
The group ownership set for the file, this defaults to the group salt
is running as on the minion unless the link already exists and
\fBinherit_user_and_group\fP is set. On Windows, this is ignored
.TP
.B mode
The permissions to set on this file, aka 644, 0775, 4664. Not supported
on Windows.
.sp
The default mode for new files and directories corresponds umask of salt
process. For existing files and directories it\(aqs not enforced.
.TP
.B win_owner
The owner of the symlink and directories if \fBmakedirs\fP is True. If
this is not passed, \fBuser\fP will be used. If \fBuser\fP is not passed,
the account under which Salt is running will be used.
.sp
New in version 2017.7.7.

.TP
.B win_perms
A dictionary containing permissions to grant
.sp
New in version 2017.7.7.

.TP
.B win_deny_perms
A dictionary containing permissions to deny
.sp
New in version 2017.7.7.

.TP
.B win_inheritance
True to inherit permissions from parent, otherwise False
.sp
New in version 2017.7.7.

.TP
.B atomic
Use atomic file operation to create the symlink.
.sp
New in version 3006.0.

.TP
.B disallow_copy_and_unlink
Only used if \fBbackupname\fP is used and the name of the symlink exists
and is not a symlink. If set to \fBTrue\fP, the operation is offloaded to
the \fBfile.rename\fP execution module function. This will use
\fBos.rename\fP underneath, which will fail in the event that \fBsrc\fP and
\fBdst\fP are on different filesystems. If \fBFalse\fP (the default),
\fBshutil.move\fP will be used in order to fall back on a \(dqcopy then
unlink\(dq approach, which is required for moving across filesystems.
.sp
New in version 3006.0.

.TP
.B inherit_user_and_group
If set to \fBTrue\fP, the link already exists, and either \fBuser\fP or
\fBgroup\fP are not set, this parameter will inform Salt to pull the user
and group information from the existing link and use it where \fBuser\fP
or \fBgroup\fP is not set. The \fBuser\fP and \fBgroup\fP parameters will
override this behavior.
.sp
New in version 3006.0.

.TP
.B follow_symlinks (bool):
If set to \fBFalse\fP, the underlying \fBfile.symlink\fP execution module
and any checks in this state will use \fBos.path.lexists()\fP for
existence checks instead of \fBos.path.exists()\fP\&.
.sp
New in version 3007.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.tidied(name, age=0, matches=None, rmdirs=False, size=0, exclude=None, full_path_match=False, followlinks=False, time_comparison=\(aqatime\(aq, age_size_logical_operator=\(aqOR\(aq, age_size_only=None, rmlinks=True, **kwargs)
Changed in version 3005,3006.0.

.sp
Remove unwanted files based on specific criteria.
.sp
The default operation uses an OR operation to evaluate age and size, so a
file that is too large but is not old enough will still get tidied. If
neither age nor size is given all files which match a pattern in matches
will be removed.
.sp
NOTE: The regex patterns in this function are used in \fBre.match()\fP, so
there is an implicit \(dqbeginning of string\(dq anchor (\fB^\fP) in the regex and
it is unanchored at the other end unless explicitly entered (\fB$\fP).
.INDENT 7.0
.TP
.B name
The directory tree that should be tidied
.TP
.B age
Maximum age in days after which files are considered for removal
.TP
.B matches
List of regular expressions to restrict what gets removed.  Default: [\(aq.*\(aq]
.TP
.B rmdirs
Whether or not it\(aqs allowed to remove directories
.TP
.B size
Maximum allowed file size. Files greater or equal to this size are
removed. Doesn\(aqt apply to directories or symbolic links
.TP
.B exclude
List of regular expressions to filter the \fBmatches\fP parameter and better
control what gets removed.
.sp
New in version 3005.

.TP
.B full_path_match
Match the \fBmatches\fP and \fBexclude\fP regex patterns against the entire
file path instead of just the file or directory name. Default: \fBFalse\fP
.sp
New in version 3005.

.TP
.B followlinks
This module will not descend into subdirectories which are pointed to by
symbolic links. If you wish to force it to do so, you may give this
option the value \fBTrue\fP\&. Default: \fBFalse\fP
.sp
New in version 3005.

.TP
.B time_comparison
Default: \fBatime\fP\&. Options: \fBatime\fP/\fBmtime\fP/\fBctime\fP\&. This value
is used to set the type of time comparison made using \fBage\fP\&. The
default is to compare access times (atime) or the last time the file was
read. A comparison by modification time (mtime) uses the last time the
contents of the file was changed. The ctime parameter is the last time
the contents, owner,  or permissions of the file were changed.
.sp
New in version 3005.

.TP
.B age_size_logical_operator
This parameter can change the default operation (OR) to an AND operation
to evaluate age and size. In that scenario, a file that is too large but
is not old enough will NOT get tidied. A file will need to fulfill BOTH
conditions in order to be tidied. Accepts \fBOR\fP or \fBAND\fP\&.
.sp
New in version 3006.0.

.TP
.B age_size_only
This parameter can trigger the reduction of age and size conditions
which need to be satisfied down to ONLY age or ONLY size. By default,
this parameter is \fBNone\fP and both conditions will be evaluated using
the logical operator defined in \fBage_size_logical_operator\fP\&. The
parameter can be set to \fBage\fP or \fBsize\fP in order to restrict
evaluation down to that specific condition. Path matching and
exclusions still apply.
.sp
New in version 3006.0.

.TP
.B rmlinks
Whether or not it\(aqs allowed to remove symbolic links
.sp
New in version 3006.0.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cleanup:
  file.tidied:
    \- name: /tmp/salt_test
    \- rmdirs: True
    \- matches:
      \- foo
      \- b.*r
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.touch(name, atime=None, mtime=None, makedirs=False)
Replicate the \(aqnix \(dqtouch\(dq command to create a new empty
file or update the atime and mtime of an existing file.
.sp
Note that if you just want to create a file and don\(aqt care about atime or
mtime, you should use \fBfile.managed\fP instead, as it is more
feature\-complete.  (Just leave out the \fBsource\fP/\fBtemplate\fP/\fBcontents\fP
arguments, and it will just create the file and/or check its permissions,
without messing with contents)
.INDENT 7.0
.TP
.B name
name of the file
.TP
.B atime
atime of the file
.TP
.B mtime
mtime of the file
.TP
.B makedirs
whether we should create the parent directory/directories in order to
touch the file
.UNINDENT
.sp
Usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/var/log/httpd/logrotate.empty:
  file.touch
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 0.9.5.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.file.uncomment(name, regex, char=\(aq#\(aq, backup=\(aq.bak\(aq)
Uncomment specified commented lines in a file
.INDENT 7.0
.TP
.B name
The full path to the file to be edited
.TP
.B regex
A regular expression used to find the lines that are to be uncommented.
This regex should not include the comment character. A leading \fB^\fP
character will be stripped for convenience (for easily switching
between comment() and uncomment()).  The regex will be searched for
from the beginning of the line, ignoring leading spaces (we prepend
\(aq^[ t]*\(aq)
.TP
.B char
The character to remove in order to uncomment a line
.TP
.B backup
The file will be backed up before edit with this file extension;
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This backup will be overwritten each time \fBsed\fP / \fBcomment\fP /
\fBuncomment\fP is called. Meaning the backup will only be useful
after the first invocation.
.UNINDENT
.UNINDENT
.sp
Set to False/None to not keep a backup.
.UNINDENT
.sp
Usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/adduser.conf:
  file.uncomment:
    \- regex: EXTRA_GROUPS
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 0.9.5.

.UNINDENT
.SS salt.states.firewall
.sp
State to check firewall configurations
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.states.firewall.check(name, port=None, **kwargs)
Checks if there is an open connection from the minion to the defined
host on a specific port.
.INDENT 7.0
.TP
.B name
host name or ip address to test connection to
.TP
.B port
The port to test the connection on
.TP
.B kwargs
.INDENT 7.0
.TP
.B Additional parameters, parameters allowed are:
proto (tcp or udp)
family (ipv4 or ipv6)
timeout
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
testgoogle:
  firewall.check:
    \- name: \(aqgoogle.com\(aq
    \- port: 80
    \- proto: \(aqtcp\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.firewalld
.sp
Management of firewalld
.sp
New in version 2015.8.0.

.sp
The following example applies changes to the public zone, blocks echo\-reply
and echo\-request packets, does not set the zone to be the default, enables
masquerading, and allows ports 22/tcp and 25/tcp.
It will be applied permanently and directly before restart/reload.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
public:
  firewalld.present:
    \- name: public
    \- block_icmp:
      \- echo\-reply
      \- echo\-request
    \- default: False
    \- masquerade: True
    \- ports:
      \- 22/tcp
      \- 25/tcp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following example applies changes to the public zone, enables
masquerading and configures port forwarding TCP traffic from port 22
to 2222, and forwards TCP traffic from port 80 to 443 at 192.168.0.1.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_zone:
  firewalld.present:
    \- name: public
    \- masquerade: True
    \- port_fwd:
      \- 22:2222:tcp
      \- 80:443:tcp:192.168.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following example binds the public zone to interface eth0 and to all
packets coming from the 192.168.1.0/24 subnet. It also removes the zone
from all other interfaces or sources.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
public:
  firewalld.present:
    \- name: public
    \- interfaces:
      \- eth0
    \- sources:
      \- 192.168.1.0/24
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here, we define a new service that encompasses TCP ports 4505 4506:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
saltmaster:
  firewalld.service:
    \- name: saltmaster
    \- ports:
      \- 4505/tcp
      \- 4506/tcp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To make this new service available in a zone, the following can be used, which
would allow access to the salt master from the 10.0.0.0/8 subnet:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
saltzone:
  firewalld.present:
    \- name: saltzone
    \- services:
      \- saltmaster
    \- sources:
      \- 10.0.0.0/8
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Another way of implementing the same rule above using rich rules is demonstrated
here:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
saltzone:
  firewalld.present:
    \- name: saltzone
    \- rich_rules:
      \- rule service name=\(dqsaltmaster\(dq accept
    \- sources:
      \- 10.0.0.0/8
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The format of rich rules is the same as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
firewall\-cmd \-\-list\-rich\-rules
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
with an example output of:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rule protocol value=\(dqicmp\(dq accept
rule protocol value=\(dqipv6\-icmp\(dq accept
rule service name=\(dqsnmp\(dq accept
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.states.firewalld.ForwardingMapping(srcport, destport, protocol, destaddr)
Represents a port forwarding statement mapping a local port to a remote
port for a specific protocol (TCP or UDP)
.INDENT 7.0
.TP
.B todict()
Returns a pretty dictionary meant for command line output.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.firewalld.present(name, block_icmp=None, prune_block_icmp=False, default=None, masquerade=None, ports=None, prune_ports=False, port_fwd=None, prune_port_fwd=False, services=None, prune_services=False, interfaces=None, prune_interfaces=False, sources=None, prune_sources=False, rich_rules=None, prune_rich_rules=False)
Ensure a zone has specific attributes.
.INDENT 7.0
.TP
.B name
The zone to modify.
.TP
.B default
None
Set this zone as the default zone if \fBTrue\fP\&.
.TP
.B masquerade
None
Enable or disable masquerade for a zone. By default it will not change it.
.TP
.B block_icmp
None
List of ICMP types to block in the zone.
.TP
.B prune_block_icmp
False
If \fBTrue\fP, remove all but the specified block_icmp from the zone.
.TP
.B ports
None
List of ports to add to the zone.
.TP
.B prune_ports
False
If \fBTrue\fP, remove all but the specified ports from the zone.
.TP
.B port_fwd
None
List of port forwards to add to the zone.
.TP
.B prune_port_fwd
False
If \fBTrue\fP, remove all but the specified port_fwd from the zone.
.TP
.B services
None
List of services to add to the zone.
.TP
.B prune_services
False
If \fBTrue\fP, remove all but the specified services from the zone.
\&.. note:: Currently defaults to True for compatibility, but will be changed to False in a future release.
.TP
.B interfaces
None
List of interfaces to add to the zone.
.TP
.B prune_interfaces
False
If \fBTrue\fP, remove all but the specified interfaces from the zone.
.TP
.B sources
None
List of sources to add to the zone.
.TP
.B prune_sources
False
If \fBTrue\fP, remove all but the specified sources from the zone.
.TP
.B rich_rules
None
List of rich rules to add to the zone.
.TP
.B prune_rich_rules
False
If \fBTrue\fP, remove all but the specified rich rules from the zone.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.firewalld.service(name, ports=None, protocols=None)
Ensure the service exists and encompasses the specified ports and
protocols.
.sp
New in version 2016.11.0.

.UNINDENT
.SS salt.states.gem
.SS Installation of Ruby modules packaged as gems
.sp
A state module to manage rubygems. Gems can be set up to be installed
or removed. This module will use RVM or rbenv if they are installed. In that case,
you can specify what ruby version and gemset to target.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
addressable:
  gem.installed:
    \- user: rvm
    \- ruby: jruby@jgemset
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.gem.installed(name, ruby=None, gem_bin=None, user=None, version=None, rdoc=False, ri=False, pre_releases=False, proxy=None, source=None)
Make sure that a gem is installed.
.INDENT 7.0
.TP
.B name
The name of the gem to install
.TP
.B ruby: None
Only for RVM or rbenv installations: the ruby version and gemset to
target.
.TP
.B gem_bin: None
Custom \fBgem\fP command to run instead of the default.
Use this to install gems to a non\-default ruby install. If you are
using rvm or rbenv use the ruby argument instead.
.TP
.B user: None
The user under which to run the \fBgem\fP command
.sp
New in version 0.17.0.

.TP
.B version
None
Specify the version to install for the gem.
Doesn\(aqt play nice with multiple gems at once
.TP
.B rdoc
False
Generate RDoc documentation for the gem(s).
.TP
.B ri
False
Generate RI documentation for the gem(s).
.TP
.B pre_releases
False
Install pre\-release version of gem(s) if available.
.TP
.B proxy
None
Use the specified HTTP proxy server for all outgoing traffic.
Format: \fI\%http://hostname[:port\fP]
.TP
.B source
None
Use the specified HTTP gem source server to download gem.
Format: \fI\%http://hostname[:port\fP]
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.gem.removed(name, ruby=None, user=None, gem_bin=None)
Make sure that a gem is not installed.
.INDENT 7.0
.TP
.B name
The name of the gem to uninstall
.TP
.B gem_bin
None
Full path to \fBgem\fP binary to use.
.TP
.B ruby
None
If RVM or rbenv are installed, the ruby version and gemset to use.
Ignored if \fBgem_bin\fP is specified.
.TP
.B user: None
The user under which to run the \fBgem\fP command
.sp
New in version 0.17.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.gem.sources_add(name, ruby=None, user=None)
Make sure that a gem source is added.
.INDENT 7.0
.TP
.B name
The URL of the gem source to be added
.TP
.B ruby: None
For RVM or rbenv installations: the ruby version and gemset to target.
.TP
.B user: None
The user under which to run the \fBgem\fP command
.sp
New in version 0.17.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.gem.sources_remove(name, ruby=None, user=None)
Make sure that a gem source is removed.
.INDENT 7.0
.TP
.B name
The URL of the gem source to be removed
.TP
.B ruby: None
For RVM or rbenv installations: the ruby version and gemset to target.
.TP
.B user: None
The user under which to run the \fBgem\fP command
.sp
New in version 0.17.0.

.UNINDENT
.UNINDENT
.SS salt.states.git
.sp
States to manage git repositories and git configuration
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
Before using git over ssh, make sure your remote host fingerprint exists in
your \fB~/.ssh/known_hosts\fP file.
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.8: This state module now requires git 1.6.5 (released 10 October 2009) or
newer.

.INDENT 0.0
.TP
.B salt.states.git.cloned(name, target, branch=None, user=None, password=None, identity=None, https_user=None, https_pass=None, output_encoding=None)
New in version 2018.3.3,2019.2.0.

.sp
Ensure that a repository has been cloned to the specified target directory.
If not, clone that repository. No fetches will be performed once cloned.
.INDENT 7.0
.TP
.B name
Address of the remote repository
.TP
.B target
Name of the target directory where repository should be cloned
.TP
.B branch
Remote branch to check out. If unspecified, the default branch (i.e.
the one to the remote HEAD points) will be checked out.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The local branch name will match the remote branch name. If the
branch name is changed, then that branch will be checked out
locally, but keep in mind that remote repository will not be
fetched. If your use case requires that you keep the clone up to
date with the remote repository, then consider using
\fI\%git.latest\fP\&.
.UNINDENT
.UNINDENT
.TP
.B user
User under which to run git commands. By default, commands are run by
the user under which the minion is running.
.TP
.B password
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.TP
.B identity
Path to a private key to use for ssh URLs. Works the same way as in
\fI\%git.latest\fP, see that state\(aqs
documentation for more information.
.TP
.B https_user
HTTP Basic Auth username for HTTPS (only) clones
.TP
.B https_pass
HTTP Basic Auth password for HTTPS (only) clones
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.git.config_set(name, value=None, multivar=None, repo=None, user=None, password=None, output_encoding=None, **kwargs)
New in version 2014.7.0.

.sp
Changed in version 2015.8.0: Renamed from \fBgit.config\fP to \fBgit.config_set\fP\&. For earlier
versions, use \fBgit.config\fP\&.

.sp
Ensure that a config value is set to the desired value(s)
.INDENT 7.0
.TP
.B name
Name of the git config value to set
.TP
.B value
Set a single value for the config item
.TP
.B multivar
Set multiple values for the config item
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The order matters here, if the same parameters are set but in a
different order, they will be removed and replaced in the order
specified.
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.TP
.B repo
Location of the git repository for which the config value should be
set. Required unless \fBglobal\fP is set to \fBTrue\fP\&.
.TP
.B user
User under which to run git commands. By default, the commands are run
by the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B global
False
If \fBTrue\fP, this will set a global git config option
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
\fBLocal Config Example:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Single value
mylocalrepo:
  git.config_set:
    \- name: user.email
    \- value: foo@bar.net
    \- repo: /path/to/repo

# Multiple values
mylocalrepo:
  git.config_set:
    \- name: mysection.myattribute
    \- multivar:
      \- foo
      \- bar
      \- baz
    \- repo: /path/to/repo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBGlobal Config Example (User \(ga\(gafoo\(ga\(ga):\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mylocalrepo:
  git.config_set:
    \- name: user.name
    \- value: Foo Bar
    \- user: foo
    \- global: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.git.config_unset(name, value_regex=None, repo=None, user=None, password=None, output_encoding=None, **kwargs)
New in version 2015.8.0.

.sp
Ensure that the named config key is not present
.INDENT 7.0
.TP
.B name
The name of the configuration key to unset. This value can be a regex,
but the regex must match the entire key name. For example, \fBfoo\e.\fP
would not match all keys in the \fBfoo\fP section, it would be necessary
to use \fBfoo\e..+\fP to do so.
.TP
.B value_regex
Regex indicating the values to unset for the matching key(s)
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option behaves differently depending on whether or not \fBall\fP
is set to \fBTrue\fP\&. If it is, then all values matching the regex
will be deleted (this is the only way to delete multiple values
from a multivar). If \fBall\fP is set to \fBFalse\fP, then this state
will fail if the regex matches more than one value in a multivar.
.UNINDENT
.UNINDENT
.TP
.B all
False
If \fBTrue\fP, unset all matches
.TP
.B repo
Location of the git repository for which the config value should be
set. Required unless \fBglobal\fP is set to \fBTrue\fP\&.
.TP
.B user
User under which to run git commands. By default, commands are run by
the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B global
False
If \fBTrue\fP, this will set a global git config option
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
\fBExamples:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Value matching \(aqbaz\(aq
mylocalrepo:
  git.config_unset:
    \- name: foo.bar
    \- value_regex: \(aqbaz\(aq
    \- repo: /path/to/repo

# Ensure entire multivar is unset
mylocalrepo:
  git.config_unset:
    \- name: foo.bar
    \- all: True

# Ensure all variables in \(aqfoo\(aq section are unset, including multivars
mylocalrepo:
  git.config_unset:
    \- name: \(aqfoo\e..+\(aq
    \- all: True

# Ensure that global config value is unset
mylocalrepo:
  git.config_unset:
    \- name: foo.bar
    \- global: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.git.detached(name, rev, target, remote=\(aqorigin\(aq, user=None, password=None, force_clone=False, force_checkout=False, fetch_remote=True, hard_reset=False, submodules=False, identity=None, https_user=None, https_pass=None, output_encoding=None, **kwargs)
New in version 2016.3.0.

.sp
Make sure a repository is cloned to the given target directory and is
a detached HEAD checkout of the commit ID resolved from \fBrev\fP\&.
.INDENT 7.0
.TP
.B name
Address of the remote repository.
.TP
.B rev
The branch, tag, or commit ID to checkout after clone.
If a branch or tag is specified it will be resolved to a commit ID
and checked out.
.TP
.B target
Name of the target directory where repository is about to be cloned.
.TP
.B remote
origin
Git remote to use. If this state needs to clone the repo, it will clone
it using this value as the initial remote name. If the repository
already exists, and a remote by this name is not present, one will be
added.
.TP
.B user
User under which to run git commands. By default, commands are run by
the user under which the minion is running.
.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B force_clone
False
If the \fBtarget\fP directory exists and is not a git repository, then
this state will fail. Set this argument to \fBTrue\fP to remove the
contents of the target directory and clone the repo into it.
.TP
.B force_checkout
False
When checking out the revision ID, the state will fail if there are
unwritten changes. Set this argument to \fBTrue\fP to discard unwritten
changes when checking out.
.TP
.B fetch_remote
True
If \fBFalse\fP a fetch will not be performed and only local refs
will be reachable.
.TP
.B hard_reset
False
If \fBTrue\fP a hard reset will be performed before the checkout and any
uncommitted modifications to the working directory will be discarded.
Untracked files will remain in place.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Changes resulting from a hard reset will not trigger requisites.
.UNINDENT
.UNINDENT
.TP
.B submodules
False
Update submodules
.TP
.B identity
A path on the minion (or a SaltStack fileserver URL, e.g.
\fBsalt://path/to/identity_file\fP) to a private key to use for SSH
authentication.
.TP
.B https_user
HTTP Basic Auth username for HTTPS (only) clones
.TP
.B https_pass
HTTP Basic Auth password for HTTPS (only) clones
.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.git.latest(name, target, rev=\(aqHEAD\(aq, branch=None, user=None, password=None, update_head=True, force_checkout=False, force_clone=False, force_fetch=False, force_reset=False, submodules=False, bare=False, mirror=False, remote=\(aqorigin\(aq, fetch_tags=True, sync_tags=True, depth=None, identity=None, https_user=None, https_pass=None, refspec_branch=\(aq*\(aq, refspec_tag=\(aq*\(aq, output_encoding=None, **kwargs)
Make sure the repository is cloned to the given directory and is
up\-to\-date.
.INDENT 7.0
.TP
.B name
Address of the remote repository, as passed to \fBgit clone\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
From the \fI\%Git documentation\fP, there are two URL formats
supported for SSH authentication. The below two examples are
equivalent:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# ssh:// URL
ssh://user@server/project.git

# SCP\-like syntax
user@server:project.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A common mistake is to use an \fBssh://\fP URL, but with a colon
after the domain instead of a slash. This is invalid syntax in
Git, and will therefore not work in Salt. When in doubt, confirm
that a \fBgit clone\fP works for the URL before using it in Salt.
.sp
It has been reported by some users that SCP\-like syntax is
incompatible with git repos hosted on \fI\%Atlassian Stash/BitBucket
Server\fP\&. In these cases, it may be necessary to use \fBssh://\fP
URLs for SSH authentication.
.UNINDENT
.UNINDENT
.TP
.B rev
HEAD
The remote branch, tag, or revision ID to checkout after clone / before
update. If specified, then Salt will also ensure that the tracking
branch is set to \fB<remote>/<rev>\fP, unless \fBrev\fP refers to a tag or
SHA1, in which case Salt will ensure that the tracking branch is unset.
.sp
If \fBrev\fP is not specified, it will be assumed to be \fBHEAD\fP, and
Salt will not manage the tracking branch at all.
.sp
Changed in version 2015.8.0: If not specified, \fBrev\fP now defaults to the remote repository\(aqs
HEAD.

.TP
.B target
Name of the target directory where repository is about to be cloned
.TP
.B branch
Name of the local branch into which to checkout the specified rev. If
not specified, then Salt will not care what branch is being used
locally and will just use whatever branch is currently there.
.sp
New in version 2015.8.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If this argument is not specified, this means that Salt will not
change the local branch if the repository is reset to another
branch/tag/SHA1. For example, assume that the following state was
run initially:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo_app:
  git.latest:
    \- name: https://mydomain.tld/apps/foo.git
    \- target: /var/www/foo
    \- user: www
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This would have cloned the HEAD of that repo (since a \fBrev\fP
wasn\(aqt specified), and because \fBbranch\fP is not specified, the
branch in the local clone at \fB/var/www/foo\fP would be whatever the
default branch is on the remote repository (usually \fBmaster\fP, but
not always). Now, assume that it becomes necessary to switch this
checkout to the \fBdev\fP branch. This would require \fBrev\fP to be
set, and probably would also require \fBforce_reset\fP to be enabled:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo_app:
  git.latest:
    \- name: https://mydomain.tld/apps/foo.git
    \- target: /var/www/foo
    \- user: www
    \- rev: dev
    \- force_reset: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The result of this state would be to perform a hard\-reset to
\fBorigin/dev\fP\&. Since \fBbranch\fP was not specified though, while
\fB/var/www/foo\fP would reflect the contents of the remote repo\(aqs
\fBdev\fP branch, the local branch would still remain whatever it was
when it was cloned. To make the local branch match the remote one,
set \fBbranch\fP as well, like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo_app:
  git.latest:
    \- name: https://mydomain.tld/apps/foo.git
    \- target: /var/www/foo
    \- user: www
    \- rev: dev
    \- branch: dev
    \- force_reset: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This may seem redundant, but Salt tries to support a wide variety
of use cases, and doing it this way allows for the use case where
the local branch doesn\(aqt need to be strictly managed.
.UNINDENT
.UNINDENT
.TP
.B user
Local system user under which to run git commands. By default, commands
are run by the user under which the minion is running.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is not to be confused with the username for http(s)/SSH
authentication.
.UNINDENT
.UNINDENT
.sp
New in version 0.17.0.

.TP
.B password
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.sp
New in version 2016.3.4.

.TP
.B update_head
True
If set to \fBFalse\fP, then the remote repository will be fetched (if
necessary) to ensure that the commit to which \fBrev\fP points exists in
the local checkout, but no changes will be made to the local HEAD.
.sp
New in version 2015.8.3.

.TP
.B force_checkout
False
When checking out the local branch, the state will fail if there are
unwritten changes. Set this argument to \fBTrue\fP to discard unwritten
changes when checking out.
.TP
.B force_clone
False
If the \fBtarget\fP directory exists and is not a git repository, then
this state will fail. Set this argument to \fBTrue\fP to remove the
contents of the target directory and clone the repo into it.
.TP
.B force_fetch
False
If a fetch needs to be performed, non\-fast\-forward fetches will cause
this state to fail. Set this argument to \fBTrue\fP to force the fetch
even if it is a non\-fast\-forward update.
.sp
New in version 2015.8.0.

.TP
.B force_reset
False
If the update is not a fast\-forward, this state will fail. Set this
argument to \fBTrue\fP to force a hard\-reset to the remote revision in
these cases.
.sp
Changed in version 2019.2.0: This option can now be set to \fBremote\-changes\fP, which will
instruct Salt not to discard local changes if the repo is
up\-to\-date with the remote repository.

.TP
.B submodules
False
Update submodules on clone or branch change
.TP
.B bare
False
Set to \fBTrue\fP if the repository is to be a bare clone of the remote
repository.
.TP
.B mirror
Set to \fBTrue\fP if the repository is to be a mirror of the remote
repository. This implies that \fBbare\fP set to \fBTrue\fP, and thus is
incompatible with \fBrev\fP\&.
.TP
.B remote
origin
Git remote to use. If this state needs to clone the repo, it will clone
it using this value as the initial remote name. If the repository
already exists, and a remote by this name is not present, one will be
added.
.TP
.B fetch_tags
True
If \fBTrue\fP, then when a fetch is performed all tags will be fetched,
even those which are not reachable by any branch on the remote.
.TP
.B sync_tags
True
If \fBTrue\fP, then Salt will delete tags which exist in the local clone
but are not found on the remote repository.
.sp
New in version 2018.3.4.

.TP
.B depth
Defines depth in history when git a clone is needed in order to ensure
latest. E.g. \fBdepth: 1\fP is useful when deploying from a repository
with a long history. Use rev to specify branch or tag. This is not
compatible with revision IDs.
.sp
Changed in version 2019.2.0: This option now supports tags as well as branches, on Git 1.8.0 and
newer.

.TP
.B identity
Path to a private key to use for ssh URLs. This can be either a single
string, or a list of strings. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Single key
git@github.com:user/repo.git:
  git.latest:
    \- user: deployer
    \- identity: /home/deployer/.ssh/id_rsa

# Two keys
git@github.com:user/repo.git:
  git.latest:
    \- user: deployer
    \- identity:
      \- /home/deployer/.ssh/id_rsa
      \- /home/deployer/.ssh/id_rsa_alternate
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If multiple keys are specified, they will be tried one\-by\-one in order
for each git command which needs to authenticate.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Unless Salt is invoked from the minion using \fBsalt\-call\fP, the
key(s) must be passphraseless. For greater security with
passphraseless private keys, see the \fI\%sshd(8)\fP manpage for
information on securing the keypair from the remote side in the
\fBauthorized_keys\fP file.
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.8.7: Salt will no longer attempt to use passphrase\-protected keys unless
invoked from the minion using \fBsalt\-call\fP, to prevent blocking
waiting for user input.

.sp
Changed in version 2016.3.0: Key can now be specified as a SaltStack fileserver URL (e.g.
\fBsalt://path/to/identity_file\fP).

.TP
.B https_user
HTTP Basic Auth username for HTTPS (only) clones
.sp
New in version 2015.5.0.

.TP
.B https_pass
HTTP Basic Auth password for HTTPS (only) clones
.sp
New in version 2015.5.0.

.TP
.B refspec_branch
*
A glob expression defining which branches to retrieve when fetching.
See \fI\%git\-fetch(1)\fP for more information on how refspecs work.
.sp
New in version 2017.7.0.

.TP
.B refspec_tag
*
A glob expression defining which tags to retrieve when fetching. See
\fI\%git\-fetch(1)\fP for more information on how refspecs work.
.sp
New in version 2017.7.0.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Clashing ID declarations can be avoided when including different
branches from the same git repository in the same SLS file by using the
\fBname\fP argument. The example below checks out the \fBgh\-pages\fP and
\fBgh\-pages\-prod\fP branches from the same repository into separate
directories. The example also sets up the \fBssh_known_hosts\fP ssh key
required to perform the git checkout.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gitlab.example.com:
  ssh_known_hosts:
    \- present
    \- user: root
    \- enc: ecdsa
    \- fingerprint: 4e:94:b0:54:c1:5b:29:a2:70:0e:e1:a3:51:ee:ee:e3

git\-website\-staging:
  git.latest:
    \- name: git@gitlab.example.com:user/website.git
    \- rev: gh\-pages
    \- target: /usr/share/nginx/staging
    \- identity: /root/.ssh/website_id_rsa
    \- require:
      \- pkg: git
      \- ssh_known_hosts: gitlab.example.com

git\-website\-staging:
  git.latest:
    \- name: git@gitlab.example.com:user/website.git
    \- rev: gh\-pages
    \- target: /usr/share/nginx/staging
    \- identity: salt://website/id_rsa
    \- require:
      \- pkg: git
      \- ssh_known_hosts: gitlab.example.com

git\-website\-prod:
  git.latest:
    \- name: git@gitlab.example.com:user/website.git
    \- rev: gh\-pages\-prod
    \- target: /usr/share/nginx/prod
    \- identity: /root/.ssh/website_id_rsa
    \- require:
      \- pkg: git
      \- ssh_known_hosts: gitlab.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.git.present(name, force=False, bare=True, template=None, separate_git_dir=None, shared=None, user=None, password=None, output_encoding=None)
Ensure that a repository exists in the given directory
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
If the minion has Git 2.5 or later installed, \fBname\fP points to a
\fI\%worktree\fP, and \fBforce\fP is set to \fBTrue\fP, then the worktree will be
deleted. This has been corrected in Salt 2015.8.0.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Path to the directory
.sp
Changed in version 2015.8.0: This path must now be absolute

.TP
.B force
False
If \fBTrue\fP, and if \fBname\fP points to an existing directory which does
not contain a git repository, then the contents of that directory will
be recursively removed and a new repository will be initialized in its
place.
.TP
.B bare
True
If \fBTrue\fP, and a repository must be initialized, then the repository
will be a bare repository.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This differs from the default behavior of \fI\%git.init\fP, make sure to set this value to \fBFalse\fP
if a bare repo is not desired.
.UNINDENT
.UNINDENT
.TP
.B template
If a new repository is initialized, this argument will specify an
alternate template directory.
.sp
New in version 2015.8.0.

.TP
.B separate_git_dir
If a new repository is initialized, this argument will specify an
alternate \fB$GIT_DIR\fP
.sp
New in version 2015.8.0.

.TP
.B shared
Set sharing permissions on git repo. See \fI\%git\-init(1)\fP for more
details.
.sp
New in version 2015.5.0.

.TP
.B user
User under which to run git commands. By default, commands are run by
the user under which the minion is running.
.sp
New in version 0.17.0.

.TP
.B password
.INDENT 7.0
.INDENT 3.5
Windows only. Required when specifying \fBuser\fP\&. This parameter will be
ignored on non\-Windows platforms.
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.4.

.TP
.B output_encoding
Use this option to specify which encoding to use to decode the output
from any git commands which are run. This should not be needed in most
cases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This should only be needed if the files in the repository were
created with filenames using an encoding other than UTF\-8 to handle
Unicode characters.
.UNINDENT
.UNINDENT
.sp
New in version 2018.3.1.

.UNINDENT
.UNINDENT
.SS salt.states.github
.sp
Github User State Module
.sp
New in version 2016.3.0.

.sp
This state is used to ensure presence of users in the Organization.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ensure user test is present in github:
    github.present:
        \- name: \(aqExample TestUser1\(aq
        \- email: example@domain.com
        \- username: \(aqgitexample\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.github.absent(name, profile=\(aqgithub\(aq, **kwargs)
Ensure a github user is absent
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ensure user test is absent in github:
    github.absent:
        \- name: \(aqExample TestUser1\(aq
        \- email: example@domain.com
        \- username: \(aqgitexample\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B name
Github handle of the user in organization
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.github.present(name, profile=\(aqgithub\(aq, **kwargs)
Ensure a user is present
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ensure user test is present in github:
    github.present:
        \- name: \(aqgitexample\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B name
This is the github handle of the user in the organization
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.github.repo_absent(name, profile=\(aqgithub\(aq, **kwargs)
Ensure a repo is absent.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ensure repo test is absent in github:
    github.repo_absent:
        \- name: \(aqtest\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B name
This is the name of the repository in the organization.
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.github.repo_present(name, description=None, homepage=None, private=None, has_issues=None, has_wiki=None, has_downloads=None, auto_init=False, gitignore_template=None, license_template=None, teams=None, profile=\(aqgithub\(aq, **kwargs)
Ensure a repository is present
.INDENT 7.0
.TP
.B name
This is the name of the repository.
.TP
.B description
The description of the repository.
.TP
.B homepage
The URL with more information about the repository.
.TP
.B private
The visiblity of the repository. Note that private repositories require
a paid GitHub account.
.TP
.B has_issues
Whether to enable issues for this repository.
.TP
.B has_wiki
Whether to enable the wiki for this repository.
.TP
.B has_downloads
Whether to enable downloads for this repository.
.TP
.B auto_init
Whether to create an initial commit with an empty README.
.TP
.B gitignore_template
The desired language or platform for a .gitignore, e.g \(dqHaskell\(dq.
.TP
.B license_template
The desired LICENSE template to apply, e.g \(dqmit\(dq or \(dqmozilla\(dq.
.TP
.B teams
The teams for which this repo should belong to, specified as a dict of
team name to permission (\(aqpull\(aq, \(aqpush\(aq or \(aqadmin\(aq).
.sp
New in version 2017.7.0.

.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure repo my\-repo is present in github:
    github.repo_present:
        \- name: \(aqmy\-repo\(aq
        \- description: \(aqMy very important repository\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.github.team_absent(name, profile=\(aqgithub\(aq, **kwargs)
Ensure a team is absent.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ensure team test is present in github:
    github.team_absent:
        \- name: \(aqtest\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B name
This is the name of the team in the organization.
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.github.team_present(name, description=None, repo_names=None, privacy=\(aqsecret\(aq, permission=\(aqpull\(aq, members=None, enforce_mfa=False, no_mfa_grace_seconds=0, profile=\(aqgithub\(aq, **kwargs)
Ensure a team is present
.INDENT 7.0
.TP
.B name
This is the name of the team in the organization.
.TP
.B description
The description of the team.
.TP
.B repo_names
The names of repositories to add the team to.
.TP
.B privacy
The level of privacy for the team, can be \(aqsecret\(aq or \(aqclosed\(aq. Defaults
to secret.
.TP
.B permission
The default permission for new repositories added to the team, can be
\(aqpull\(aq, \(aqpush\(aq or \(aqadmin\(aq. Defaults to pull.
.TP
.B members
The members belonging to the team, specified as a dict of member name to
optional configuration. Options include \(aqenforce_mfa_from\(aq and \(aqmfa_exempt\(aq.
.TP
.B enforce_mfa
Whether to enforce MFA requirements on members of the team. If True then
all members without \fImfa_exempt: True\fP configured will be removed from
the team. Note that \fIno_mfa_grace_seconds\fP may be set to allow members
a grace period.
.TP
.B no_mfa_grace_seconds
The number of seconds of grace time that a member will have to enable MFA
before being removed from the team. The grace period will begin from
\fIenforce_mfa_from\fP on the member configuration, which defaults to
1970/01/01.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure team test is present in github:
    github.team_present:
        \- name: \(aqtest\(aq
        \- members:
            user1: {}
            user2: {}

Ensure team test_mfa is present in github:
    github.team_present:
        \- name: \(aqtest_mfa\(aq
        \- members:
            user1:
                enforce_mfa_from: 2016/06/15
        \- enforce_mfa: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.SS salt.states.glance_image
.SS Management of OpenStack Glance Images
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
shade
.TP
.B configuration
see \fI\%salt.modules.glanceng\fP for setup instructions
.UNINDENT
.sp
Example States
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create image:
  glance_image.present:
    \- name: cirros
    \- filename: cirros.raw
    \- image_format: raw

delete image:
  glance_image.absent:
    \- name: cirros
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.glance_image.absent(name, auth=None)
Ensure image does not exist
.INDENT 7.0
.TP
.B name
Name of the image
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.glance_image.present(name, auth=None, **kwargs)
Ensure image exists and is up\-to\-date
.INDENT 7.0
.TP
.B name
Name of the image
.TP
.B enabled
Boolean to control if image is enabled
.TP
.B description
An arbitrary description of the image
.UNINDENT
.UNINDENT
.SS salt.states.glassfish
.sp
Manage Glassfish/Payara server
\&.. versionadded:: 2016.11.0
.sp
Management of glassfish using its RESTful API
You can setup connection parameters like this
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- server:
  \- ssl: true
  \- url: localhost
  \- port: 4848
  \- user: admin
  \- password: changeit
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.glassfish.connection_factory_absent(name, both=True, server=None)
Ensures the transaction factory is absent.
.INDENT 7.0
.TP
.B name
Name of the connection factory
.TP
.B both
Delete both the pool and the resource, defaults to \fBtrue\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.glassfish.connection_factory_present(name, restype=\(aqconnection_factory\(aq, description=\(aq\(aq, enabled=True, min_size=1, max_size=250, resize_quantity=2, idle_timeout=300, wait_timeout=60, reconnect_on_failure=False, transaction_support=\(aq\(aq, connection_validation=False, server=None)
Ensures that the Connection Factory is present
.INDENT 7.0
.TP
.B name
Name of the connection factory
.TP
.B restype
Type of the connection factory, can be either \fBconnection_factory\fP,
\fBqueue_connection_factory\(ga or \(ga\(gatopic_connection_factory\fP,
defaults to \fBconnection_factory\fP
.TP
.B description
Description of the connection factory
.TP
.B enabled
Is the connection factory enabled? defaults to \fBtrue\fP
.TP
.B min_size
Minimum and initial number of connections in the pool, defaults to \fB1\fP
.TP
.B max_size
Maximum number of connections that can be created in the pool, defaults to \fB250\fP
.TP
.B resize_quantity
Number of connections to be removed when idle_timeout expires, defaults to \fB2\fP
.TP
.B idle_timeout
Maximum time a connection can remain idle in the pool, in seconds, defaults to \fB300\fP
.TP
.B wait_timeout
Maximum time a caller can wait before timeout, in seconds, defaults to \fB60\fP
.TP
.B reconnect_on_failure
Close all connections and reconnect on failure (or reconnect only when used), defaults to \fBfalse\fP
.TP
.B transaction_support
Level of transaction support, can be either \fBXATransaction\fP, \fBLocalTransaction\fP or \fBNoTransaction\fP
.TP
.B connection_validation
Connection validation is required, defaults to \fBfalse\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.glassfish.destination_absent(name, server=None)
Ensures that the JMS Destination doesn\(aqt exists
.INDENT 7.0
.TP
.B name
Name of the JMS Destination
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.glassfish.destination_present(name, physical, restype=\(aqqueue\(aq, description=\(aq\(aq, enabled=True, server=None)
Ensures that the JMS Destination Resource (queue or topic) is present
.INDENT 7.0
.TP
.B name
The JMS Queue/Topic name
.TP
.B physical
The Physical destination name
.TP
.B restype
The JMS Destination resource type, either \fBqueue\fP or \fBtopic\fP, defaults is \fBqueue\fP
.TP
.B description
A description of the resource
.TP
.B enabled
Defaults to \fBTrue\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.glassfish.jdbc_datasource_absent(name, both=True, server=None)
Ensures the JDBC Datasource doesn\(aqt exists
.INDENT 7.0
.TP
.B name
Name of the datasource
.TP
.B both
Delete both the pool and the resource, defaults to \fBtrue\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.glassfish.jdbc_datasource_present(name, description=\(aq\(aq, enabled=True, restype=\(aqdatasource\(aq, vendor=\(aqmysql\(aq, sql_url=\(aq\(aq, sql_user=\(aq\(aq, sql_password=\(aq\(aq, min_size=8, max_size=32, resize_quantity=2, idle_timeout=300, wait_timeout=60, non_transactional=False, transaction_isolation=\(aq\(aq, isolation_guaranteed=True, server=None)
Ensures that the JDBC Datasource exists
.INDENT 7.0
.TP
.B name
Name of the datasource
.TP
.B description
Description of the datasource
.TP
.B enabled
Is the datasource enabled? defaults to \fBtrue\fP
.TP
.B restype
Resource type, can be \fBdatasource\fP, \fBxa_datasource\fP,
\fBconnection_pool_datasource\fP or \fBdriver\fP, defaults to \fBdatasource\fP
.TP
.B vendor
SQL Server type, currently supports \fBmysql\fP,
\fBpostgresql\fP and \fBmssql\fP, defaults to \fBmysql\fP
.TP
.B sql_url
URL of the server in jdbc form
.TP
.B sql_user
Username for the server
.TP
.B sql_password
Password for that username
.TP
.B min_size
Minimum and initial number of connections in the pool, defaults to \fB8\fP
.TP
.B max_size
Maximum number of connections that can be created in the pool, defaults to \fB32\fP
.TP
.B resize_quantity
Number of connections to be removed when idle_timeout expires, defaults to \fB2\fP
.TP
.B idle_timeout
Maximum time a connection can remain idle in the pool, in seconds, defaults to \fB300\fP
.TP
.B wait_timeout
Maximum time a caller can wait before timeout, in seconds, defaults to \fB60\fP
.TP
.B non_transactional
Return non\-transactional connections
.TP
.B transaction_isolation
Defaults to the JDBC driver default
.TP
.B isolation_guaranteed
All connections use the same isolation level
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.glassfish.system_properties_absent(name, server=None)
Ensures that the system property doesn\(aqt exists
.INDENT 7.0
.TP
.B name
Name of the system property
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.glassfish.system_properties_present(server=None, **kwargs)
Ensures that the system properties are present
.INDENT 7.0
.TP
.B properties
The system properties
.UNINDENT
.UNINDENT
.SS salt.states.glusterfs
.sp
Manage GlusterFS pool.
.INDENT 0.0
.TP
.B salt.states.glusterfs.add_volume_bricks(name, bricks)
Add brick(s) to an existing volume
.INDENT 7.0
.TP
.B name
Volume name
.TP
.B bricks
List of bricks to add to the volume
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myvolume:
  glusterfs.add_volume_bricks:
    \- bricks:
        \- host1:/srv/gluster/drive1
        \- host2:/srv/gluster/drive2

Replicated Volume:
  glusterfs.add_volume_bricks:
    \- name: volume2
    \- bricks:
      \- host1:/srv/gluster/drive2
      \- host2:/srv/gluster/drive3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.glusterfs.max_op_version(name)
New in version 2019.2.0.

.sp
Add brick(s) to an existing volume
.INDENT 7.0
.TP
.B name
Volume name
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myvolume:
  glusterfs.max_op_version:
    \- name: volume1
    \- version: 30707
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.glusterfs.op_version(name, version)
New in version 2019.2.0.

.sp
Add brick(s) to an existing volume
.INDENT 7.0
.TP
.B name
Volume name
.TP
.B version
Version to which the cluster.op\-version should be set
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myvolume:
  glusterfs.op_version:
    \- name: volume1
    \- version: 30707
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.glusterfs.peered(name)
Check if node is peered.
.INDENT 7.0
.TP
.B name
The remote host with which to peer.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
peer\-cluster:
  glusterfs.peered:
    \- name: two

peer\-clusters:
  glusterfs.peered:
    \- names:
      \- one
      \- two
      \- three
      \- four
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.glusterfs.started(name)
Check if volume has been started
.INDENT 7.0
.TP
.B name
name of the volume
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mycluster:
  glusterfs.started: []
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.glusterfs.volume_present(name, bricks, stripe=False, replica=False, device_vg=False, transport=\(aqtcp\(aq, start=False, force=False, arbiter=False)
Ensure that the volume exists
.INDENT 7.0
.TP
.B name
name of the volume
.TP
.B bricks
list of brick paths
.TP
.B replica
replica count for volume
.TP
.B arbiter
use every third brick as arbiter (metadata only)
.sp
New in version 2019.2.0.

.TP
.B start
ensure that the volume is also started
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myvolume:
  glusterfs.volume_present:
    \- bricks:
        \- host1:/srv/gluster/drive1
        \- host2:/srv/gluster/drive2

Replicated Volume:
  glusterfs.volume_present:
    \- name: volume2
    \- bricks:
      \- host1:/srv/gluster/drive2
      \- host2:/srv/gluster/drive3
    \- replica: 2
    \- start: True

Replicated Volume with arbiter brick:
  glusterfs.volume_present:
    \- name: volume3
    \- bricks:
      \- host1:/srv/gluster/drive2
      \- host2:/srv/gluster/drive3
      \- host3:/srv/gluster/drive4
    \- replica: 3
    \- arbiter: True
    \- start: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.gnomedesktop
.SS Configuration of the GNOME desktop
.sp
Control the GNOME settings
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
localdesktop_wm_prefs:
    gnomedesktop.wm_preferences:
        \- user: username
        \- audible_bell: false
        \- action_double_click_titlebar: \(aqtoggle\-maximize\(aq
        \- visual_bell: true
        \- num_workspaces: 6
localdesktop_lockdown:
    gnomedesktop.desktop_lockdown:
        \- user: username
        \- disable_user_switching: true
localdesktop_interface:
    gnomedesktop.desktop_interface:
        \- user: username
        \- clock_show_date: true
        \- clock_format: 12h
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.gnomedesktop.desktop_interface(name, user=None, automatic_mnemonics=None, buttons_have_icons=None, can_change_accels=None, clock_format=None, clock_show_date=None, clock_show_seconds=None, cursor_blink=None, cursor_blink_time=None, cursor_blink_timeout=None, cursor_size=None, cursor_theme=None, document_font_name=None, enable_animations=None, font_name=None, gtk_color_palette=None, gtk_color_scheme=None, gtk_im_module=None, gtk_im_preedit_style=None, gtk_im_status_style=None, gtk_key_theme=None, gtk_theme=None, gtk_timeout_initial=None, gtk_timeout_repeat=None, icon_theme=None, menubar_accel=None, menubar_detachable=None, menus_have_icons=None, menus_have_tearoff=None, monospace_font_name=None, show_input_method_menu=None, show_unicode_menu=None, text_scaling_factor=None, toolbar_detachable=None, toolbar_icons_size=None, toolbar_style=None, toolkit_accessibility=None, **kwargs)
desktop_interface: sets values in the org.gnome.desktop.interface schema
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.gnomedesktop.desktop_lockdown(name, user=None, disable_application_handlers=None, disable_command_line=None, disable_lock_screen=None, disable_log_out=None, disable_print_setup=None, disable_printing=None, disable_save_to_disk=None, disable_user_switching=None, user_administration_disabled=None, **kwargs)
desktop_lockdown: sets values in the org.gnome.desktop.lockdown schema
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.gnomedesktop.wm_preferences(name, user=None, action_double_click_titlebar=None, action_middle_click_titlebar=None, action_right_click_titlebar=None, application_based=None, audible_bell=None, auto_raise=None, auto_raise_delay=None, button_layout=None, disable_workarounds=None, focus_mode=None, focus_new_windows=None, mouse_button_modifier=None, num_workspaces=None, raise_on_click=None, resize_with_right_button=None, theme=None, titlebar_font=None, titlebar_uses_system_font=None, visual_bell=None, visual_bell_type=None, workspace_names=None, **kwargs)
wm_preferences: sets values in the org.gnome.desktop.wm.preferences schema
.UNINDENT
.SS salt.states.gpg
.SS Manage GPG keychains
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.states.gpg.absent(name, keys=None, user=None, gnupghome=None, keyring=None, keyring_absent_if_empty=False, **kwargs)
Ensure a GPG public key is absent from the keychain.
.INDENT 7.0
.TP
.B name
The key ID of the GPG public key.
.TP
.B keys
The key ID or key IDs to remove from the GPG keychain.
.TP
.B user
Remove GPG keys from the specified user\(aqs keychain.
.TP
.B gnupghome
Override GnuPG home directory.
.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.TP
.B keyring_absent_if_empty
Make sure to not leave behind an empty keyring file
if \fBkeyring\fP was specified. Defaults to false.
.sp
New in version 3007.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.gpg.present(name, keys=None, user=None, keyserver=None, gnupghome=None, trust=None, keyring=None, **kwargs)
Ensure a GPG public key is present in the GPG keychain.
.INDENT 7.0
.TP
.B name
The key ID of the GPG public key.
.TP
.B keys
The key ID or key IDs to add to the GPG keychain.
.TP
.B user
Add GPG keys to the specified user\(aqs keychain.
.TP
.B keyserver
The keyserver to retrieve the keys from.
.TP
.B gnupghome
Override GnuPG home directory.
.TP
.B trust
Trust level for the key in the keychain,
ignored by default. Valid trust levels:
expired, unknown, not_trusted, marginally,
fully, ultimately
.TP
.B keyring
Limit the operation to this specific keyring, specified as
a local filesystem path.
.sp
New in version 3007.0.

.UNINDENT
.UNINDENT
.SS salt.states.grafana
.sp
Manage Grafana Dashboards
.sp
This module uses \fBelasticsearch\fP, which can be installed via package, or pip.
.sp
You can specify elasticsearch hosts directly to the module, or you can use an
elasticsearch profile via pillars:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mygrafanaprofile:
  hosts:
    \- es1.example.com:9200
    \- es2.example.com:9200
  index: grafana\-dash
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Basic usage (uses default pillar profile key \(aqgrafana\(aq)
Ensure myservice dashboard is managed:
  grafana.dashboard_present:
    \- name: myservice
    \- dashboard_from_pillar: default
    \- rows_from_pillar:
        \- systemhealth
        \- requests

# Passing hosts in
Ensure myservice dashboard is managed:
  grafana.dashboard_present:
    \- name: myservice
    \- dashboard_from_pillar: default
    \- rows:
        \- collapse: false
          editable: true
          height: 150px
          title: System Health
          panels:
            \- aliasColors: {}
              id: 200000
              annotate:
                enable: false
              bars: false
              datasource: null
              editable: true
              error: false
              fill: 7
              grid:
                leftMax: 100
                leftMin: null
                rightMax: null
                rightMin: null
                threshold1: 60
                threshold1Color: rgb(216, 27, 27)
                threshold2: null
                threshold2Color: rgba(234, 112, 112, 0.22)
              leftYAxisLabel: \(aq\(aq
              legend:
                avg: false
                current: false
                max: false
                min: false
                show: false
                total: false
                values: false
              lines: true
              linewidth: 1
              nullPointMode: connected
              percentage: false
              pointradius: 5
              points: false
              renderer: flot
              resolution: 100
              scale: 1
              seriesOverrides: []
              span: 4
              stack: false
              steppedLine: false
              targets:
                \- target: cloudwatch.aws.ec2.mysrv.cpuutilization.average
              title: CPU (asg average)
              tooltip:
                query_as_alias: true
                shared: false
                value_type: cumulative
              type: graph
              x\-axis: true
              y\-axis: true
              y_formats:
                \- short
                \- short
              zerofill: true
    \- rows_from_pillar:
      \- systemhealth
      \- requests
    \- profile:
        hosts:
          \- es1.example.com:9200
          \- es2.example.com:9200
        index: grafana\-dash

# Using a profile from pillars
Ensure myservice dashboard is managed:
  grafana.dashboard_present:
    \- name: myservice
    \- dashboard:
        annotations:
          enable: true
          list: []
        editable: true
        hideAllLegends: false
        hideControls: false
        nav:
          \- collapse: false
            enable: true
            notice: false
            now: true
            refresh_intervals:
              \- 10s
              \- 30s
              \- 1m
              \- 5m
              \- 15m
              \- 30m
              \- 1h
              \- 2h
              \- 1d
            status: Stable
            time_options:
              \- 5m
              \- 15m
              \- 1h
              \- 2h
              \- 3h
              \- 4h
              \- 6h
              \- 12h
              \- 1d
              \- 2d
              \- 4d
              \- 7d
              \- 16d
              \- 30d
            type: timepicker
        originalTitle: dockerregistry
        refresh: 1m
        rows: []
        sharedCrosshair: false
        style: dark
        tags: []
        templating:
          enable: true
          list: []
        time:
          from: now\-2h
          to: now
        timezone: browser
    \- rows_from_pillars:
      \- systemhealth
      \- requests
    \- profile: mygrafanaprofile
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The behavior of this module is to create dashboards if they do not exist, to
add rows if they do not exist in existing dashboards, and to update rows if
they exist in dashboards. The module will not manage rows that are not defined,
allowing users to manage their own custom rows.
.INDENT 0.0
.TP
.B salt.states.grafana.dashboard_absent(name, hosts=None, profile=\(aqgrafana\(aq)
Ensure the named grafana dashboard is deleted.
.INDENT 7.0
.TP
.B name
Name of the grafana dashboard.
.TP
.B profile
A pillar key or dict that contains a list of hosts and an
elasticsearch index to use.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grafana.dashboard_present(name, dashboard=None, dashboard_from_pillar=None, rows=None, rows_from_pillar=None, profile=\(aqgrafana\(aq)
Ensure the grafana dashboard exists and is managed.
.INDENT 7.0
.TP
.B name
Name of the grafana dashboard.
.TP
.B dashboard
A dict that defines a dashboard that should be managed.
.TP
.B dashboard_from_pillar
A pillar key that contains a grafana dashboard dict. Mutually exclusive
with dashboard.
.TP
.B rows
A list of grafana rows.
.TP
.B rows_from_pillar
A list of pillar keys that contain lists of grafana dashboard rows.
Rows defined in the pillars will be appended to the rows defined in the
state.
.TP
.B profile
A pillar key or dict that contains a list of hosts and an
elasticsearch index to use.
.UNINDENT
.UNINDENT
.SS salt.states.grafana4_dashboard
.sp
Manage Grafana v4.0 Dashboards
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B configuration
This state requires a configuration profile to be configured
in the minion config, minion pillar, or master config. The module will use
the \(aqgrafana\(aq key by default, if defined.
.sp
Example configuration using basic authentication:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
grafana:
  grafana_url: http://grafana.localhost
  grafana_user: admin
  grafana_password: admin
  grafana_timeout: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example configuration using token based authentication:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
grafana:
  grafana_url: http://grafana.localhost
  grafana_token: token
  grafana_timeout: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The behavior of this module is to create dashboards if they do not exist, to
add rows if they do not exist in existing dashboards, and to update rows if
they exist in dashboards. The module will not manage rows that are not defined,
allowing users to manage their own custom rows.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure minimum dashboard is managed:
  grafana4_dashboard.present:
    \- name: insightful\-dashboard
    \- base_dashboards_from_pillar:
      \- default_dashboard
    \- base_rows_from_pillar:
      \- default_row
    \- base_panels_from_pillar:
      \- default_panel
    \- dashboard:
        rows:
          \- title: Usage
            panels:
              \- targets:
                  \- target: alias(constantLine(50), \(aqmax\(aq)
                title: Imaginary
                type: graph
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grafana4_dashboard.absent(name, orgname=None, profile=\(aqgrafana\(aq)
Ensure the named grafana dashboard is absent.
.INDENT 7.0
.TP
.B name
Name of the grafana dashboard.
.TP
.B orgname
Name of the organization in which the dashboard should be present.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grafana4_dashboard.present(name, base_dashboards_from_pillar=None, base_panels_from_pillar=None, base_rows_from_pillar=None, dashboard=None, orgname=None, profile=\(aqgrafana\(aq)
Ensure the grafana dashboard exists and is managed.
.INDENT 7.0
.TP
.B name
Name of the grafana dashboard.
.TP
.B base_dashboards_from_pillar
A pillar key that contains a list of dashboards to inherit from
.TP
.B base_panels_from_pillar
A pillar key that contains a list of panels to inherit from
.TP
.B base_rows_from_pillar
A pillar key that contains a list of rows to inherit from
.TP
.B dashboard
A dict that defines a dashboard that should be managed.
.TP
.B orgname
Name of the organization in which the dashboard should be present.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.UNINDENT
.SS salt.states.grafana4_datasource
.sp
Manage Grafana v4.0 data sources
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B configuration
This state requires a configuration profile to be configured
in the minion config, minion pillar, or master config. The module will use
the \(aqgrafana\(aq key by default, if defined.
.sp
Example configuration using basic authentication:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
grafana:
  grafana_url: http://grafana.localhost
  grafana_user: admin
  grafana_password: admin
  grafana_timeout: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example configuration using token based authentication:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
grafana:
  grafana_url: http://grafana.localhost
  grafana_token: token
  grafana_timeout: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The behavior of this module is to create data sources if the do not exists, and
to update data sources if the already exists.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure influxdb data source is present:
  grafana4_datasource.present:
    \- name: influxdb
    \- type: influxdb
    \- url: http://localhost:8086
    \- access: proxy
    \- basic_auth: true
    \- basic_auth_user: myuser
    \- basic_auth_password: mypass
    \- is_default: true
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grafana4_datasource.absent(name, orgname=None, profile=\(aqgrafana\(aq)
Ensure that a data source is present.
.INDENT 7.0
.TP
.B name
Name of the data source to remove.
.TP
.B orgname
Name of the organization from which the data source should be absent.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grafana4_datasource.present(name, type, url, access=None, user=None, password=None, database=None, basic_auth=None, basic_auth_user=None, basic_auth_password=None, tls_auth=None, json_data=None, is_default=None, with_credentials=None, type_logo_url=None, orgname=None, profile=\(aqgrafana\(aq)
Ensure that a data source is present.
.INDENT 7.0
.TP
.B name
Name of the data source.
.TP
.B type
Type of the datasource (\(aqgraphite\(aq, \(aqinfluxdb\(aq etc.).
.TP
.B access
Use proxy or direct. Default: proxy
.TP
.B url
The URL to the data source API.
.TP
.B user
Optional \- user to authenticate with the data source.
.TP
.B password
Optional \- password to authenticate with the data source.
.TP
.B database
Optional \- database to use with the data source.
.TP
.B basic_auth
Optional \- set to True to use HTTP basic auth to authenticate with the
data source.
.TP
.B basic_auth_user
Optional \- HTTP basic auth username.
.TP
.B basic_auth_password
Optional \- HTTP basic auth password.
.TP
.B json_data
Optional \- additional json data to post (eg. \(dqtimeInterval\(dq).
.TP
.B is_default
Optional \- set data source as default.
.TP
.B with_credentials
Optional \- Whether credentials such as cookies or auth headers should
be sent with cross\-site requests.
.TP
.B type_logo_url
Optional \- Logo to use for this datasource.
.TP
.B orgname
Name of the organization in which the data source should be present.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.UNINDENT
.SS salt.states.grafana4_org
.sp
Manage Grafana v4.0 orgs
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B configuration
This state requires a configuration profile to be configured
in the minion config, minion pillar, or master config. The module will use
the \(aqgrafana\(aq key by default, if defined.
.sp
Example configuration using basic authentication:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
grafana:
  grafana_url: http://grafana.localhost
  grafana_user: admin
  grafana_password: admin
  grafana_timeout: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example configuration using token based authentication:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
grafana:
  grafana_url: http://grafana.localhost
  grafana_token: token
  grafana_timeout: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure foobar org is present:
  grafana4_org.present:
    \- name: foobar
    \- theme:  \(dq\(dq
    \- home_dashboard_id: 0
    \- timezone: \(dqutc\(dq
    \- address1: \(dq\(dq
    \- address2: \(dq\(dq
    \- city: \(dq\(dq
    \- zip_code: \(dq\(dq
    \- state: \(dq\(dq
    \- country: \(dq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grafana4_org.absent(name, profile=\(aqgrafana\(aq)
Ensure that a org is present.
.INDENT 7.0
.TP
.B name
Name of the org to remove.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grafana4_org.present(name, users=None, theme=None, home_dashboard_id=None, timezone=None, address1=None, address2=None, city=None, zip_code=None, address_state=None, country=None, profile=\(aqgrafana\(aq)
Ensure that an organization is present.
.INDENT 7.0
.TP
.B name
Name of the org.
.TP
.B users
Optional \- Dict of user/role associated with the org. Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  foo: Viewer
  bar: Editor
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B theme
Optional \- Selected theme for the org.
.TP
.B home_dashboard_id
Optional \- Home dashboard for the org.
.TP
.B timezone
Optional \- Timezone for the org (one of: \(dqbrowser\(dq, \(dqutc\(dq, or \(dq\(dq).
.TP
.B address1
Optional \- address1 of the org.
.TP
.B address2
Optional \- address2 of the org.
.TP
.B city
Optional \- city of the org.
.TP
.B zip_code
Optional \- zip_code of the org.
.TP
.B address_state
Optional \- state of the org.
.TP
.B country
Optional \- country of the org.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.UNINDENT
.SS salt.states.grafana4_user
.sp
Manage Grafana v4.0 users
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B configuration
This state requires a configuration profile to be configured
in the minion config, minion pillar, or master config. The module will use
the \(aqgrafana\(aq key by default, if defined.
.sp
Example configuration using basic authentication:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
grafana:
  grafana_url: http://grafana.localhost
  grafana_user: admin
  grafana_password: admin
  grafana_timeout: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example configuration using token based authentication:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
grafana:
  grafana_url: http://grafana.localhost
  grafana_token: token
  grafana_timeout: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure foobar user is present:
  grafana4_user.present:
    \- name: foobar
    \- password: mypass
    \- email: \(dqfoobar@localhost\(dq
    \- fullname: Foo Bar
    \- is_admin: true
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grafana4_user.absent(name, profile=\(aqgrafana\(aq)
Ensure that a user is present.
.INDENT 7.0
.TP
.B name
Name of the user to remove.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grafana4_user.present(name, password, email, is_admin=False, fullname=None, theme=None, profile=\(aqgrafana\(aq)
Ensure that a user is present.
.INDENT 7.0
.TP
.B name
Name of the user.
.TP
.B password
Password of the user.
.TP
.B email
Email of the user.
.TP
.B is_admin
Optional \- Set user as admin user. Default: False
.TP
.B fullname
Optional \- Full name of the user.
.TP
.B theme
Optional \- Selected theme of the user.
.TP
.B profile
Configuration profile used to connect to the Grafana instance.
Default is \(aqgrafana\(aq.
.UNINDENT
.UNINDENT
.SS salt.states.grafana_dashboard
.sp
Manage Grafana v2.0 Dashboards
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grafana:
  grafana_timeout: 3
  grafana_token: qwertyuiop
  grafana_url: \(aqhttps://url.com\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure minimum dashboard is managed:
  grafana_dashboard.present:
    \- name: insightful\-dashboard
    \- base_dashboards_from_pillar:
      \- default_dashboard
    \- base_rows_from_pillar:
      \- default_row
    \- base_panels_from_pillar:
      \- default_panel
    \- dashboard:
        rows:
          \- title: Usage
            panels:
              \- targets:
                  \- target: alias(constantLine(50), \(aqmax\(aq)
                title: Imaginary
                type: graph
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The behavior of this module is to create dashboards if they do not exist, to
add rows if they do not exist in existing dashboards, and to update rows if
they exist in dashboards. The module will not manage rows that are not defined,
allowing users to manage their own custom rows.
.INDENT 0.0
.TP
.B salt.states.grafana_dashboard.absent(name, profile=\(aqgrafana\(aq)
Ensure the named grafana dashboard is absent.
.INDENT 7.0
.TP
.B name
Name of the grafana dashboard.
.TP
.B profile
A pillar key or dict that contains grafana information
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grafana_dashboard.present(name, base_dashboards_from_pillar=None, base_panels_from_pillar=None, base_rows_from_pillar=None, dashboard=None, profile=\(aqgrafana\(aq)
Ensure the grafana dashboard exists and is managed.
.INDENT 7.0
.TP
.B name
Name of the grafana dashboard.
.TP
.B base_dashboards_from_pillar
A pillar key that contains a list of dashboards to inherit from
.TP
.B base_panels_from_pillar
A pillar key that contains a list of panels to inherit from
.TP
.B base_rows_from_pillar
A pillar key that contains a list of rows to inherit from
.TP
.B dashboard
A dict that defines a dashboard that should be managed.
.TP
.B profile
A pillar key or dict that contains grafana information
.UNINDENT
.UNINDENT
.SS salt.states.grafana_datasource
.sp
Manage Grafana v2.0 data sources
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grafana:
  grafana_timeout: 3
  grafana_token: qwertyuiop
  grafana_url: \(aqhttps://url.com\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure influxdb data source is present:
  grafana_datasource.present:
    \- name: influxdb
    \- type: influxdb
    \- url: http://localhost:8086
    \- access: proxy
    \- basic_auth: true
    \- basic_auth_user: myuser
    \- basic_auth_password: mypass
    \- is_default: true
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grafana_datasource.absent(name, profile=\(aqgrafana\(aq)
Ensure that a data source is present.
.INDENT 7.0
.TP
.B name
Name of the data source to remove.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grafana_datasource.present(name, type, url, access=\(aqproxy\(aq, user=\(aq\(aq, password=\(aq\(aq, database=\(aq\(aq, basic_auth=False, basic_auth_user=\(aq\(aq, basic_auth_password=\(aq\(aq, is_default=False, json_data=None, profile=\(aqgrafana\(aq)
Ensure that a data source is present.
.INDENT 7.0
.TP
.B name
Name of the data source.
.TP
.B type
Which type of data source it is (\(aqgraphite\(aq, \(aqinfluxdb\(aq etc.).
.TP
.B url
The URL to the data source API.
.TP
.B user
Optional \- user to authenticate with the data source
.TP
.B password
Optional \- password to authenticate with the data source
.TP
.B basic_auth
Optional \- set to True to use HTTP basic auth to authenticate with the
data source.
.TP
.B basic_auth_user
Optional \- HTTP basic auth username.
.TP
.B basic_auth_password
Optional \- HTTP basic auth password.
.TP
.B is_default
Default: False
.UNINDENT
.UNINDENT
.SS salt.states.grains
.SS Manage grains on the minion
.sp
This state allows for grains to be set.
.sp
Grains set or altered with this module are stored in the \(aqgrains\(aq
file on the minions, By default, this file is located at: \fB/etc/salt/grains\fP
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This does \fBNOT\fP override any grains set in the minion config file.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grains.absent(name, destructive=False, delimiter=\(aq:\(aq, force=False)
New in version 2014.7.0.

.sp
Delete a grain from the grains config file
.INDENT 7.0
.TP
.B name
The grain name
.TP
.B destructive
If destructive is True, delete the entire grain. If
destructive is False, set the grain\(aqs value to None. Defaults to False.
.TP
.B force
If force is True, the existing grain will be overwritten
regardless of its existing or provided value type. Defaults to False
.sp
New in version 2015.8.2.

.TP
.B delimiter
A delimiter different from the default can be provided.
.sp
New in version 2015.8.2.

.UNINDENT
.sp
Changed in version 2015.8.2.

.sp
This state now support nested grains and complex values. It is also more
conservative: if a grain has a value that is a list or a dict, it will
not be removed unless the \fIforce\fP parameter is True.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
grain_name:
  grains.absent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grains.append(name, value, convert=False, delimiter=\(aq:\(aq)
New in version 2014.7.0.

.sp
Append a value to a list in the grains config file. The grain that is being
appended to (name) must exist before the new value can be added.
.INDENT 7.0
.TP
.B name
The grain name
.TP
.B value
The value to append
.TP
.B convert
If convert is True, convert non\-list contents into a list.
If convert is False and the grain contains non\-list contents, an error
is given. Defaults to False.
.TP
.B delimiter
A delimiter different from the default can be provided.
.sp
New in version 2015.8.2.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
grain_name:
  grains.append:
    \- value: to_be_appended
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grains.exists(name, delimiter=\(aq:\(aq)
Ensure that a grain is set
.INDENT 7.0
.TP
.B name
The grain name
.TP
.B delimiter
A delimiter different from the default can be provided.
.UNINDENT
.sp
Check whether a grain exists. Does not attempt to check or set the value.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grains.list_absent(name, value, delimiter=\(aq:\(aq)
Delete a value from a grain formed as a list.
.sp
New in version 2014.1.0.

.INDENT 7.0
.TP
.B name
The grain name.
.TP
.B value
The value to delete from the grain list.
.TP
.B delimiter
A delimiter different from the default \fB:\fP can be provided.
.sp
New in version 2015.8.2.

.UNINDENT
.sp
The grain should be \fI\%list type\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
roles:
  grains.list_absent:
    \- value: db
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For multiple grains, the syntax looks like:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
roles:
  grains.list_absent:
    \- value:
      \- web
      \- dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grains.list_present(name, value, delimiter=\(aq:\(aq)
New in version 2014.1.0.

.sp
Ensure the value is present in the list\-type grain. Note: If the grain that is
provided in \fBname\fP is not present on the system, this new grain will be created
with the corresponding provided value.
.INDENT 7.0
.TP
.B name
The grain name.
.TP
.B value
The value is present in the list type grain.
.TP
.B delimiter
A delimiter different from the default \fB:\fP can be provided.
.sp
New in version 2015.8.2.

.UNINDENT
.sp
The grain should be \fI\%list type\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
roles:
  grains.list_present:
    \- value: web
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For multiple grains, the syntax looks like:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
roles:
  grains.list_present:
    \- value:
      \- web
      \- dev
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grains.make_hashable(list_grain, result=None)
Ensure that a list grain is hashable.
.INDENT 7.0
.TP
.B list_grain
The list grain that should be hashable
.TP
.B result
This function is recursive, so it must be possible to use a
sublist as parameter to the function. Should not be used by a caller
outside of the function.
.UNINDENT
.sp
Make it possible to compare two list grains to each other if the list
contains complex objects.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.grains.present(name, value, delimiter=\(aq:\(aq, force=False)
Ensure that a grain is set
.sp
Changed in version 2015.8.2.

.INDENT 7.0
.TP
.B name
The grain name
.TP
.B value
The value to set on the grain
.TP
.B force
If force is True, the existing grain will be overwritten
regardless of its existing or provided value type. Defaults to False
.sp
New in version 2015.8.2.

.TP
.B delimiter
A delimiter different from the default can be provided.
.sp
New in version 2015.8.2.

.UNINDENT
.sp
It is now capable to set a grain to a complex value (ie. lists and dicts)
and supports nested grains as well.
.sp
If the grain does not yet exist, a new grain is set to the given value. For
a nested grain, the necessary keys are created if they don\(aqt exist. If
a given key is an existing value, it will be converted, but an existing value
different from the given key will fail the state.
.sp
If the grain with the given name exists, its value is updated to the new
value unless its existing or provided value is complex (list or dict). Use
\fIforce: True\fP to overwrite.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cheese:
  grains.present:
    \- value: edam

nested_grain_with_complex_value:
  grains.present:
    \- name: icinga:Apache SSL
    \- value:
      \- command: check_https
      \- params: \-H localhost \-p 443 \-S

with,a,custom,delimiter:
  grains.present:
    \- value: yay
    \- delimiter: \(aq,\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.group
.SS Management of user groups
.sp
The group module is used to create and manage group settings, groups can be
either present or absent. User/Group names can be passed to the \fBadduser\fP,
\fBdeluser\fP, and \fBmembers\fP parameters. \fBadduser\fP and \fBdeluser\fP can be used
together but not with \fBmembers\fP\&.
.sp
In Windows, if no domain is specified in the user or group name (i.e.
\fBDOMAIN\eusername\fP) the module will assume a local user or group.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cheese:
  group.present:
    \- gid: 7648
    \- system: True
    \- addusers:
      \- user1
      \- users2
    \- delusers:
      \- foo

cheese:
  group.present:
    \- gid: 7648
    \- system: True
    \- members:
      \- foo
      \- bar
      \- user1
      \- user2
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.group.absent(name, local=False)
Ensure that the named group is absent
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the group to remove
.IP \(bu 2
\fBlocal\fP (\fIOnly on systems with lgroupdel available\fP) \-\-
.sp
Ensure the group account is removed locally ignoring global
account management (default is False).
.sp
New in version 3007.0.


.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Removes the local group \(gadb_admin\(ga
db_admin:
  group.absent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.group.present(name, gid=None, system=False, addusers=None, delusers=None, members=None, non_unique=False, local=False)
Changed in version 3006.0.

.sp
Ensure that a group is present
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the group to manage
.IP \(bu 2
\fBgid\fP (\fI\%str\fP) \-\- The group id to assign to the named group; if left empty, then the
next available group id will be assigned. Ignored on Windows
.IP \(bu 2
\fBsystem\fP (\fI\%bool\fP) \-\- Whether or not the named group is a system group.  This is essentially
the \(aq\-r\(aq option of \(aqgroupadd\(aq. Ignored on Windows
.IP \(bu 2
\fBaddusers\fP (\fI\%list\fP) \-\- List of additional users to be added as a group members. Cannot
conflict with names in delusers. Cannot be used in conjunction with
members.
.IP \(bu 2
\fBdelusers\fP (\fI\%list\fP) \-\- Ensure these user are removed from the group membership. Cannot
conflict with names in addusers. Cannot be used in conjunction with
members.
.IP \(bu 2
\fBmembers\fP (\fI\%list\fP) \-\- Replace existing group members with a list of new members. Cannot be
used in conjunction with addusers or delusers.
.IP \(bu 2
\fBnon_unique\fP (\fI\%bool\fP) \-\-
.sp
Allow creating groups with duplicate (non\-unique) GIDs
.sp
New in version 3006.0.


.IP \(bu 2
\fBlocal\fP (\fIOnly on systems with lgroupadd available\fP) \-\-
.sp
Create the group account locally ignoring global account management
(default is False).
.sp
New in version 3007.0.


.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Adds DOMAIN\edb_admins and Administrators to the local db_admin group
# Removes Users
db_admin:
  group.present:
    \- addusers:
      \- DOMAIN\edb_admins
      \- Administrators
    \- delusers:
      \- Users

# Ensures only DOMAIN\edomain_admins and the local Administrator are
# members of the local Administrators group. All other users are
# removed
Administrators:
  group.present:
    \- members:
      \- DOMAIN\edomain_admins
      \- Administrator
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.heat
.SS Management of Heat
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
heat Python module
.UNINDENT
.TP
.B configuration
See \fI\%salt.modules.heat\fP for setup instructions.
.UNINDENT
.sp
The heat module is used to create, show, list and delete Heat staks.
Stack can be set as either absent or deploy.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
heat.deployed:
  \- name:
  \- template: #Required
  \- environment:
  \- params: {}
  \- poll: 5
  \- rollback: False
  \- timeout: 60

heat.absent:
  \- name:
  \- poll: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B mysql:
.INDENT 7.0
.TP
.B heat.deployed:
.INDENT 7.0
.IP \(bu 2
template: salt://templates/mysql.heat.yaml
.IP \(bu 2
params:
image: Debian 7
.IP \(bu 2
rollback: True
.UNINDENT
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.5,2018.3.1: The spelling mistake in parameter \fIenviroment\fP was corrected to \fIenvironment\fP\&.
The \fIenviroment\fP spelling mistake has been removed in Salt 3000.

.INDENT 0.0
.TP
.B salt.states.heat.absent(name, poll=5, timeout=60, profile=None)
Ensure that the named stack is absent
.INDENT 7.0
.TP
.B name
The name of the stack to remove
.TP
.B poll
Poll(in sec.) and report events until stack complete
.TP
.B timeout
Stack creation timeout in minutes
.TP
.B profile
Profile to use
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.heat.deployed(name, template=None, environment=None, params=None, poll=5, rollback=False, timeout=60, update=False, profile=None, **connection_args)
Deploy stack with the specified properties
.INDENT 7.0
.TP
.B name
The name of the stack
.TP
.B template
File of template
.TP
.B environment
File of environment
.TP
.B params
Parameter dict used to create the stack
.TP
.B poll
Poll (in sec.) and report events until stack complete
.TP
.B rollback
Enable rollback on create failure
.TP
.B timeout
Stack creation timeout in minutes
.TP
.B profile
Profile to use
.UNINDENT
.sp
New in version 2017.7.5,2018.3.1: The spelling mistake in parameter \fIenviroment\fP was corrected to \fIenvironment\fP\&.
The \fIenviroment\fP spelling mistake has been removed in Salt 3000.

.UNINDENT
.SS salt.states.helm
.INDENT 0.0
.TP
.B salt.states.helm.release_absent(name, namespace=None, flags=None, kvflags=None)
Make sure the release name is absent.
.INDENT 7.0
.TP
.B name
(string) The release name to uninstall.
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
helm_release_is_absent:
  helm.release_absent:
    \- name: release_name

# In dry\-run mode.
helm_release_is_absent_dry\-run:
  helm.release_absent:
    \- name: release_name
    \- flags:
      \- dry\-run
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.helm.release_present(name, chart, values=None, version=None, namespace=None, set=None, flags=None, kvflags=None)
Make sure the release name is present.
.INDENT 7.0
.TP
.B name
(string) The release name to install.
.TP
.B chart
(string) The chart to install.
.TP
.B values
(string) Absolute path to the values.yaml file.
.TP
.B version
(string) The exact chart version to install. If this is not specified, the latest version is installed.
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B set
(string or list) Set a values on the command line.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
helm_release_is_present:
  helm.release_present:
    \- name: release_name
    \- chart: repo/chart

# In dry\-run mode.
helm_release_is_present_dry\-run:
  helm.release_present:
    \- name: release_name
    \- chart: repo/chart
    \- flags:
      \- dry\-run

# With values.yaml file.
helm_release_is_present_values:
  helm.release_present:
    \- name: release_name
    \- chart: repo/chart
    \- kvflags:
        values: /path/to/values.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.helm.repo_managed(name, present=None, absent=None, prune=False, repo_update=False, namespace=None, flags=None, kvflags=None)
Make sure the repository is updated.
.INDENT 7.0
.TP
.B name
(string) Not used.
.TP
.B present
(list) List of repository to be present. It\(aqs a list of dict: [{\(aqname\(aq: \(aqlocal_name\(aq, \(aqurl\(aq: \(aqrepository_url\(aq}]
.TP
.B absent
(list) List of local name repository to be absent.
.TP
.B prune
(boolean \- default: False) If True, all repository already present but not in the present list would be removed.
.TP
.B repo_update
(boolean \- default: False) If True, the Helm repository is updated after a repository add or remove.
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
helm_repository_is_managed:
  helm.repo_managed:
    \- present:
      \- name: local_name_1
        url: repository_url
    \- absent:
      \- local_name_2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.helm.repo_updated(name, namespace=None, flags=None, kvflags=None)
Make sure the repository is updated.
To execute after a repository changes.
.INDENT 7.0
.TP
.B name
(string) Not used.
.TP
.B namespace
(string) The namespace scope for this request.
.TP
.B flags
(list) Flags in argument of the command without values. ex: [\(aqhelp\(aq, \(aq\-\-help\(aq]
.TP
.B kvflags
(dict) Flags in argument of the command with values. ex: {\(aqv\(aq: 2, \(aq\-\-v\(aq: 4}
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
helm_repository_is_updated:
  helm.repo_updated
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.hg
.SS Interaction with Mercurial repositories
.sp
Before using hg over ssh, make sure the remote host fingerprint already exists
in ~/.ssh/known_hosts, and the remote host has this host\(aqs public key.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
https://bitbucket.org/example_user/example_repo:
    hg.latest:
      \- rev: tip
      \- target: /tmp/example_repo
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.hg.latest(name, rev=None, target=None, clean=False, user=None, identity=None, force=False, opts=False, update_head=True)
Make sure the repository is cloned to the given directory and is up to date
.INDENT 7.0
.TP
.B name
Address of the remote repository as passed to \(dqhg clone\(dq
.TP
.B rev
The remote branch, tag, or revision hash to clone/pull
.TP
.B target
Target destination directory path on minion to clone into
.TP
.B clean
Force a clean update with \-C (Default: False)
.TP
.B user
Name of the user performing repository management operations
.sp
New in version 0.17.0.

.TP
.B identity
Private SSH key on the minion server for authentication (\fI\%ssh://\fP)
.sp
New in version 2015.5.0.

.TP
.B force
Force hg to clone into pre\-existing directories (deletes contents)
.TP
.B opts
Include additional arguments and options to the hg command line
.TP
.B update_head
Should we update the head if new changes are found? Defaults to True
.sp
New in version 2017.7.0.

.UNINDENT
.UNINDENT
.SS salt.states.highstate_doc
.sp
To be used with processors in module \fIhighstate_doc\fP\&.
.INDENT 0.0
.TP
.B salt.states.highstate_doc.note(name, source=None, contents=None, **kwargs)
Add content to a document generated using \fIhighstate_doc.render\fP\&.
.sp
This state does not preform any tasks on the host. It only is used in highstate_doc lowstate processors
to include extra documents.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{{sls}} example note:
    highstate_doc.note:
        \- name: example note
        \- require_in:
            \- pkg: somepackage
        \- contents: |
            example \(gahighstate_doc.note\(ga
            \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
            This state does not do anything to the system! It is only used by a \(gaprocessor\(ga
            you can use \(garequisites\(ga and \(gaorder\(ga to move your docs around the rendered file.
            .. this message appare above the \(gapkg: somepackage\(ga state.
        \- source: salt://{{tpldir}}/also_include_a_file.md

{{sls}} extra help:
    highstate_doc.note:
        \- name: example
        \- order: 0
        \- source: salt://{{tpldir}}/HELP.md
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.host
.SS Management of addresses and names in hosts file
.sp
The \fB/etc/hosts\fP file can be managed to contain definitions for specific hosts:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-master:
  host.present:
    \- ip: 192.168.0.42
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or using the \fBnames\fP directive, you can put several names for the same IP.
(Do not try one name with space\-separated values).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
server1:
  host.present:
    \- ip: 192.168.0.42
    \- names:
      \- server1
      \- florida
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Changing the \fBnames\fP in \fBhost.present\fP does not cause an
update to remove the old entry.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
server1:
  host.present:
    \- ip:
      \- 192.168.0.42
      \- 192.168.0.43
      \- 192.168.0.44
    \- names:
      \- server1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can replace all existing names for a particular IP address:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
127.0.1.1:
  host.only:
    \- hostnames:
      \- foo.example.com
      \- foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or delete all existing names for an address:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
203.0.113.25:
    host.only:
      \- hostnames: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also include comments:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
server1:
  host.present:
    \- ip: 192.168.0.42
    \- names:
      \- server1
      \- florida
    \- comment: A very important comment
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.host.absent(name, ip)
Ensure that the named host is absent
.INDENT 7.0
.TP
.B name
The host to remove
.TP
.B ip
The ip addr(s) of the host to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.host.only(name, hostnames)
Ensure that only the given hostnames are associated with the
given IP address.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
The IP address to associate with the given hostnames.
.TP
.B hostnames
Either a single hostname or a list of hostnames to associate
with the given IP address in the given order.  Any other
hostname associated with the IP address is removed.  If no
hostnames are specified, all hostnames associated with the
given IP address are removed.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.host.present(name, ip, comment=\(aq\(aq, clean=False)
Ensures that the named host is present with the given ip
.INDENT 7.0
.TP
.B name
The host to assign an ip to
.TP
.B ip
The ip addr(s) to apply to the host. Can be a single IP or a list of IP
addresses.
.TP
.B comment
A comment to include for the host entry
.sp
New in version 3001.

.TP
.B clean
Remove any entries which don\(aqt match those configured in the \fBip\fP
option. Default is \fBFalse\fP\&.
.sp
New in version 2018.3.4.

.UNINDENT
.UNINDENT
.SS salt.states.http
.sp
HTTP monitoring states
.sp
Perform an HTTP query and statefully return the result
.sp
New in version 2015.5.0.

.INDENT 0.0
.TP
.B salt.states.http.query(name, match=None, match_type=\(aqstring\(aq, status=None, status_type=\(aqstring\(aq, wait_for=None, **kwargs)
Perform an HTTP query and statefully return the result
.sp
Passes through all the parameters described in the
\fI\%utils.http.query function\fP:
.INDENT 7.0
.TP
.B name
The name of the query.
.TP
.B match
Specifies a pattern to look for in the return text. By default, this will
perform a string comparison of looking for the value of match in the return
text.
.TP
.B match_type
Specifies the type of pattern matching to use on match. Default is \fBstring\fP, but
can also be set to \fBpcre\fP to use regular expression matching if a more
complex pattern matching is required.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Despite the name of \fBmatch_type\fP for this argument, this setting
actually uses Python\(aqs \fBre.search()\fP function rather than Python\(aqs
\fBre.match()\fP function.
.UNINDENT
.UNINDENT
.TP
.B status
The status code for a URL for which to be checked. Can be used instead of
or in addition to the \fBmatch\fP setting. This can be passed as an individual status code
or a list of status codes.
.TP
.B status_type
Specifies the type of pattern matching to use for status. Default is \fBstring\fP, but
can also be set to \fBpcre\fP to use regular expression matching if a more
complex pattern matching is required. Additionally, if a list of strings representing
statuses is given, the type \fBlist\fP can be used.
.sp
New in version 3000.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Despite the name of \fBmatch_type\fP for this argument, this setting
actually uses Python\(aqs \fBre.search()\fP function rather than Python\(aqs
\fBre.match()\fP function.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
If both \fBmatch\fP and \fBstatus\fP options are set, both settings will be checked.
However, note that if only one option is \fBTrue\fP and the other is \fBFalse\fP,
then \fBFalse\fP will be returned. If this case is reached, the comments in the
return data will contain troubleshooting information.
.sp
For more information about the \fBhttp.query\fP state, refer to the
\fI\%HTTP Tutorial\fP\&.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
query_example:
  http.query:
    \- name: \(aqhttp://example.com/\(aq
    \- status: 200

query_example2:
  http.query:
    \- name: \(aqhttp://example.com/\(aq
    \- status:
        \- 200
        \- 201
    \- status_type: list
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.http.wait_for_successful_query(name, wait_for=300, **kwargs)
Like query but, repeat and wait until match/match_type or status is fulfilled. State returns result from last
query state in case of success or if no successful query was made within wait_for timeout.
.INDENT 7.0
.TP
.B name
The name of the query.
.TP
.B wait_for
Total time to wait for requests that succeed.
.TP
.B request_interval
Optional interval to delay requests by N seconds to reduce the number of requests sent.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
All other arguments are passed to the http.query state.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.icinga2
.SS Icinga2 state
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
Icinga2 Python module
.UNINDENT
.TP
.B configuration
See \fI\%salt.modules.icinga2\fP for setup instructions.
.UNINDENT
.sp
The icinga2 module is used to execute commands.
Its output may be stored in a file or in a grain.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
command_id:
  icinga2.generate_ticket:
    \- name: domain.tld
    \- output:  \(dq/tmp/query_id.txt\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.icinga2.generate_cert(name)
Generate an icinga2 certificate and key on the client.
.INDENT 7.0
.TP
.B name
The domain name for which this certificate and key will be generated
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.icinga2.generate_ticket(name, output=None, grain=None, key=None, overwrite=True)
Generate an icinga2 ticket on the master.
.INDENT 7.0
.TP
.B name
The domain name for which this ticket will be generated
.TP
.B output
grain: output in a grain
other: the file to store results
None:  output to the result comment (default)
.TP
.B grain:
grain to store the output (need output=grain)
.TP
.B key:
the specified grain will be treated as a dictionary, the result
of this state will be stored under the specified key.
.TP
.B overwrite:
The file or grain will be overwritten if it already exists (default)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.icinga2.node_setup(name, master, ticket)
Setup the icinga2 node.
.INDENT 7.0
.TP
.B name
The domain name for which this certificate will be saved
.TP
.B master
Icinga2 master node for which this certificate will be saved
.TP
.B ticket
Authentication ticket generated on icinga2 master
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.icinga2.request_cert(name, master, ticket, port=\(aq5665\(aq)
Request CA certificate from master icinga2 node.
.INDENT 7.0
.TP
.B name
The domain name for which this certificate will be saved
.TP
.B master
Icinga2 master node for which this certificate will be saved
.TP
.B ticket
Authentication ticket generated on icinga2 master
.TP
.B port
Icinga2 port, defaults to 5665
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.icinga2.save_cert(name, master)
Save the certificate on master icinga2 node.
.INDENT 7.0
.TP
.B name
The domain name for which this certificate will be saved
.TP
.B master
Icinga2 master node for which this certificate will be saved
.UNINDENT
.UNINDENT
.SS salt.states.idem
.SS Idem Support
.sp
This state provides access to idem states
.sp
New in version 3002.

.INDENT 0.0
.TP
.B salt.states.idem.state(name, sls, acct_file=None, acct_key=None, acct_profile=None, cache_dir=None, render=None, runtime=None, source_dir=None, test=False)
Execute an idem sls file through a salt state
.INDENT 7.0
.TP
.B sls
A list of idem sls files or sources
.TP
.B acct_file
Path to the acct file used in generating idem ctx parameters.
Defaults to the value in the ACCT_FILE environment variable.
.TP
.B acct_key
Key used to decrypt the acct file.
Defaults to the value in the ACCT_KEY environment variable.
.TP
.B acct_profile
Name of the profile to add to idem\(aqs ctx.acct parameter
Defaults to the value in the ACCT_PROFILE environment variable.
.TP
.B cache_dir
The location to use for the cache directory
.TP
.B render
The render pipe to use, this allows for the language to be specified (jinja|yaml)
.TP
.B runtime
Select which execution runtime to use (serial|parallel)
.TP
.B source_dir
The directory containing sls files
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cheese:
    idem.state:
        \- runtime: parallel
        \- sls:
            \- idem_state.sls
            \- sls_source
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Maturity
new
.TP
.B Depends
acct, pop, pop\-config, idem
.TP
.B Platform
all
.UNINDENT
.UNINDENT
.SS salt.states.ifttt
.SS Trigger an event in IFTTT
.sp
This state is useful for trigging events in IFTTT.
.sp
New in version 2015.8.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ifttt\-event:
  ifttt.trigger_event:
    \- event: TestEvent
    \- value1: \(aqThis state was executed successfully.\(aq
    \- value2: \(aqAnother value we can send.\(aq
    \- value3: \(aqA third value we can send.\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The api key can be specified in the master or minion configuration like below:
\&.. code\-block:: yaml
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B ifttt:
secret_key: bzMRb\-KKIAaNOwKEEw792J7Eb\-B3z7muhdhYblJn4V6
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ifttt.trigger_event(name, event, value1=None, value2=None, value3=None)
Trigger an event in IFTTT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ifttt\-event:
  ifttt.trigger_event:
    \- event: TestEvent
    \- value1: \(aqA value that we want to send.\(aq
    \- value2: \(aqA second value that we want to send.\(aq
    \- value3: \(aqA third value that we want to send.\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B name
The unique name for this event.
.TP
.B event
The name of the event to trigger in IFTTT.
.UNINDENT
.sp
The following parameters are optional:
.INDENT 7.0
.TP
.B value1
One of the values that we can send to IFTT.
.TP
.B value2
One of the values that we can send to IFTT.
.TP
.B value3
One of the values that we can send to IFTT.
.UNINDENT
.UNINDENT
.SS salt.states.incron
.SS Management of incron, the inotify cron
.sp
The incron state module allows for user incrontabs to be cleanly managed.
.sp
Incron declarations require a number of parameters. The parameters needed
to be declared: \fBpath\fP, \fBmask\fP, and \fBcmd\fP\&. The \fBuser\fP whose incrontab is to be edited
also needs to be defined.
.sp
When making changes to an existing incron job, the \fBpath\fP declaration is the unique
factor, so if an existing cron that looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Watch for modifications in /home/user:
    incron.present:
        \- user: root
        \- path: /home/user
        \- mask:
            \- IN_MODIFY
        \- cmd: \(aqecho \(dq$$ $@\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Is changed to this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Watch for modifications and access in /home/user:
    incron.present:
        \- user: root
        \- path: /home/user
        \- mask:
            \- IN_MODIFY
            \- IN_ACCESS
        \- cmd: \(aqecho \(dq$$ $@\(dq\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then the existing cron will be updated, but if the cron command is changed,
then a new cron job will be added to the user\(aqs crontab.
.sp
New in version 0.17.0.

.INDENT 0.0
.TP
.B salt.states.incron.absent(name, path, mask, cmd, user=\(aqroot\(aq)
Verifies that the specified incron job is absent for the specified user; only
the name is matched when removing a incron job.
.INDENT 7.0
.TP
.B name
Unique comment describing the entry
.TP
.B path
The path that should be watched
.TP
.B user
The name of the user who\(aqs crontab needs to be modified, defaults to
the root user
.TP
.B mask
The mask of events that should be monitored for
.TP
.B cmd
The cmd that should be executed
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.incron.present(name, path, mask, cmd, user=\(aqroot\(aq)
Verifies that the specified incron job is present for the specified user.
For more advanced information about what exactly can be set in the cron
timing parameters, check your incron system\(aqs documentation. Most Unix\-like
systems\(aq incron documentation can be found via the incrontab man page:
\fBman 5 incrontab\fP\&.
.INDENT 7.0
.TP
.B name
Unique comment describing the entry
.TP
.B path
The path that should be watched
.TP
.B user
The name of the user who\(aqs crontab needs to be modified, defaults to
the root user
.TP
.B mask
The mask of events that should be monitored for
.TP
.B cmd
The cmd that should be executed
.UNINDENT
.UNINDENT
.SS salt.states.influxdb08_database
.SS Management of Influxdb 0.8 databases
.sp
(compatible with InfluxDB version 0.5\-0.8)
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B salt.states.influxdb08_database.absent(name, user=None, password=None, host=None, port=None)
Ensure that the named database is absent
.INDENT 7.0
.TP
.B name
The name of the database to remove
.TP
.B user
The user to connect as (must be able to remove the database)
.TP
.B password
The password of the user
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.influxdb08_database.present(name, user=None, password=None, host=None, port=None)
Ensure that the named database is present
.INDENT 7.0
.TP
.B name
The name of the database to create
.TP
.B user
The user to connect as (must be able to remove the database)
.TP
.B password
The password of the user
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.UNINDENT
.UNINDENT
.SS salt.states.influxdb08_user
.SS Management of InfluxDB 0.8 users
.sp
(compatible with InfluxDB version 0.5\-0.8)
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B salt.states.influxdb08_user.absent(name, database=None, user=None, password=None, host=None, port=None)
Ensure that the named cluster admin or database user is absent.
.INDENT 7.0
.TP
.B name
The name of the user to remove
.TP
.B database
The database to remove the user from
.TP
.B user
The user to connect as (must be able to remove the user)
.TP
.B password
The password of the user
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.influxdb08_user.present(name, passwd, database=None, user=None, password=None, host=None, port=None)
Ensure that the cluster admin or database user is present.
.INDENT 7.0
.TP
.B name
The name of the user to manage
.TP
.B passwd
The password of the user
.TP
.B database
The database to create the user in
.TP
.B user
The user to connect as (must be able to create the user)
.TP
.B password
The password of the user
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.UNINDENT
.UNINDENT
.SS salt.states.influxdb_continuous_query
.SS Management of Influxdb continuous queries
.sp
New in version 2017.7.0.

.sp
(compatible with InfluxDB version 0.9+)
.INDENT 0.0
.TP
.B salt.states.influxdb_continuous_query.absent(name, database, **client_args)
Ensure that given continuous query is absent.
.INDENT 7.0
.TP
.B name
Name of the continuous query to remove.
.TP
.B database
Name of the database that the continuous query was defined on.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.influxdb_continuous_query.present(name, database, query, resample_time=None, coverage_period=None, **client_args)
Ensure that given continuous query is present.
.INDENT 7.0
.TP
.B name
Name of the continuous query to create.
.TP
.B database
Database to create continuous query on.
.TP
.B query
The query content
.TP
.B resample_time
None
Duration between continuous query resampling.
.TP
.B coverage_period
None
Duration specifying time period per sample.
.UNINDENT
.UNINDENT
.SS salt.states.influxdb_database
.SS Management of Influxdb databases
.sp
(compatible with InfluxDB version 0.9+)
.INDENT 0.0
.TP
.B salt.states.influxdb_database.absent(name, **client_args)
Ensure that given database is absent.
.INDENT 7.0
.TP
.B name
Name of the database to remove.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.influxdb_database.present(name, **client_args)
Ensure that given database is present.
.INDENT 7.0
.TP
.B name
Name of the database to create.
.UNINDENT
.UNINDENT
.SS salt.states.influxdb_retention_policy
.SS Management of Influxdb retention policies
.sp
New in version 2017.7.0.

.sp
(compatible with InfluxDB version 0.9+)
.INDENT 0.0
.TP
.B salt.states.influxdb_retention_policy.absent(name, database, **client_args)
Ensure that given retention policy is absent.
.INDENT 7.0
.TP
.B name
Name of the retention policy to remove.
.TP
.B database
Name of the database that the retention policy was defined on.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.influxdb_retention_policy.convert_duration(duration)
Convert the a duration string into XXhYYmZZs format
.INDENT 7.0
.TP
.B duration
Duration to convert
.TP
.B Returns: duration_string
String representation of duration in XXhYYmZZs format
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.influxdb_retention_policy.present(name, database, duration=\(aq7d\(aq, replication=1, default=False, **client_args)
Ensure that given retention policy is present.
.INDENT 7.0
.TP
.B name
Name of the retention policy to create.
.TP
.B database
Database to create retention policy on.
.UNINDENT
.UNINDENT
.SS salt.states.influxdb_user
.SS Management of InfluxDB users
.sp
(compatible with InfluxDB version 0.9+)
.INDENT 0.0
.TP
.B salt.states.influxdb_user.absent(name, **client_args)
Ensure that given user is absent.
.INDENT 7.0
.TP
.B name
The name of the user to manage
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.influxdb_user.present(name, passwd, admin=False, grants=None, **client_args)
Ensure that given user is present.
.INDENT 7.0
.TP
.B name
Name of the user to manage
.TP
.B passwd
Password of the user
.TP
.B admin
False
Whether the user should have cluster administration
privileges or not.
.TP
.B grants
Optional \- Dict of database:privilege items associated with
the user. Example:
.INDENT 7.0
.TP
.B grants:
foo_db: read
bar_db: all
.UNINDENT
.UNINDENT
.sp
\fBExample:\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
example user present in influxdb:
  influxdb_user.present:
    \- name: example
    \- passwd: somepassword
    \- admin: False
    \- grants:
        foo_db: read
        bar_db: all
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.infoblox_a
.sp
Infoblox A record management.
.sp
functions accept api_opts:
.INDENT 0.0
.INDENT 3.5
api_verifyssl: verify SSL [default to True or pillar value]
api_url: server to connect to [default to pillar value]
api_username:  [default to pillar value]
api_password:  [default to pillar value]
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.infoblox_a.absent(name=None, ipv4addr=None, **api_opts)
Ensure infoblox A record is removed.
.sp
State example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
infoblox_a.absent:
    \- name: example\-ha\-0.domain.com

infoblox_a.absent:
    \- name:
    \- ipv4addr: 127.0.23.23
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.infoblox_a.present(name=None, ipv4addr=None, data=None, ensure_data=True, **api_opts)
Ensure infoblox A record.
.sp
When you wish to update a hostname ensure \fIname\fP is set to the hostname
of the current record. You can give a new name in the \fIdata.name\fP\&.
.sp
State example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
infoblox_a.present:
    \- name: example\-ha\-0.domain.com
    \- data:
        name: example\-ha\-0.domain.com
        ipv4addr: 123.0.31.2
        view: Internal
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.infoblox_cname
.sp
Infoblox CNAME management.
.sp
functions accept api_opts:
.INDENT 0.0
.INDENT 3.5
api_verifyssl: verify SSL [default to True or pillar value]
api_url: server to connect to [default to pillar value]
api_username:  [default to pillar value]
api_password:  [default to pillar value]
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.infoblox_cname.absent(name=None, canonical=None, **api_opts)
Ensure the CNAME with the given name or canonical name is removed
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.infoblox_cname.present(name=None, data=None, ensure_data=True, **api_opts)
Ensure the CNAME with the given data is present.
.INDENT 7.0
.TP
.B name
CNAME of record
.TP
.B data
raw CNAME api data see: \fI\%https://INFOBLOX/wapidoc\fP
.UNINDENT
.sp
State example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
infoblox_cname.present:
    \- name: example\-ha\-0.domain.com
    \- data:
        name: example\-ha\-0.domain.com
        canonical: example.domain.com
        zone: example.com
        view: Internal
        comment: Example comment

infoblox_cname.present:
    \- name: example\-ha\-0.domain.com
    \- data:
        name: example\-ha\-0.domain.com
        canonical: example.domain.com
        zone: example.com
        view: Internal
        comment: Example comment
    \- api_url: https://INFOBLOX/wapi/v1.2.1
    \- api_username: username
    \- api_password: passwd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.infoblox_host_record
.sp
Infoblox host record management.
.sp
functions accept api_opts:
.INDENT 0.0
.INDENT 3.5
api_verifyssl: verify SSL [default to True or pillar value]
api_url: server to connect to [default to pillar value]
api_username:  [default to pillar value]
api_password:  [default to pillar value]
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.infoblox_host_record.absent(name=None, ipv4addr=None, mac=None, **api_opts)
Ensure the host with the given Name ipv4addr or mac is removed.
.sp
State example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
infoblox_host_record.absent:
    \- name: hostname.of.record.to.remove

infoblox_host_record.absent:
    \- name:
    \- ipv4addr: 192.168.0.1

infoblox_host_record.absent:
    \- name:
    \- mac: 12:02:12:31:23:43
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.infoblox_host_record.present(name=None, data=None, ensure_data=True, **api_opts)
This will ensure that a host with the provided name exists.
This will try to ensure that the state of the host matches the given data
If the host is not found then one will be created.
.sp
When trying to update a hostname ensure \fIname\fP is set to the hostname
of the current record. You can give a new name in the \fIdata.name\fP\&.
.INDENT 7.0
.TP
.B Avoid race conditions, use func:nextavailableip:
.INDENT 7.0
.IP \(bu 2
func:nextavailableip:network/ZG54dfgsrDFEFfsfsLzA:10.0.0.0/8/default
.IP \(bu 2
func:nextavailableip:10.0.0.0/8
.IP \(bu 2
func:nextavailableip:10.0.0.0/8,externalconfigure_for_dns
.IP \(bu 2
func:nextavailableip:10.0.0.3\-10.0.0.10
.UNINDENT
.UNINDENT
.sp
State Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# this would update \(gaoriginal_hostname.example.ca\(ga to changed \(gadata\(ga.
infoblox_host_record.present:
    \- name: original_hostname.example.ca
    \- data: {\(aqnamhostname.example.cae\(aq: \(aqhostname.example.ca\(aq,
        \(aqaliases\(aq: [\(aqhostname.math.example.ca\(aq],
        \(aqextattrs\(aq: [{\(aqBusiness Contact\(aq: {\(aqvalue\(aq: \(aqEXAMPLE@example.ca\(aq}}],
        \(aqipv4addrs\(aq: [{\(aqconfigure_for_dhcp\(aq: True,
            \(aqipv4addr\(aq: \(aqfunc:nextavailableip:129.97.139.0/24\(aq,
            \(aqmac\(aq: \(aq00:50:56:84:6e:ae\(aq}],
        \(aqipv6addrs\(aq: [], }
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.infoblox_range
.sp
Infoblox host record management.
.sp
functions accept api_opts:
.INDENT 0.0
.INDENT 3.5
api_verifyssl: verify SSL [default to True or pillar value]
api_url: server to connect to [default to pillar value]
api_username:  [default to pillar value]
api_password:  [default to pillar value]
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.infoblox_range.absent(name=None, start_addr=None, end_addr=None, data=None, **api_opts)
Ensure the range is removed
.sp
Supplying the end of the range is optional.
.sp
State example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
infoblox_range.absent:
    \- name: \(aqvlan10\(aq

infoblox_range.absent:
    \- name:
    \- start_addr: 127.0.1.20
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.infoblox_range.present(name=None, start_addr=None, end_addr=None, data=None, **api_opts)
Ensure range record is present.
.INDENT 7.0
.TP
.B infoblox_range.present:
start_addr: \(aq129.97.150.160\(aq,
end_addr: \(aq129.97.150.170\(aq,
.UNINDENT
.sp
Verbose state example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
infoblox_range.present:
    data: {
        \(aqalways_update_dns\(aq: False,
        \(aqauthority\(aq: False,
        \(aqcomment\(aq: \(aqrange of IP addresses used for salt.. was used for ghost images deployment\(aq,
        \(aqddns_generate_hostname\(aq: True,
        \(aqdeny_all_clients\(aq: False,
        \(aqdeny_bootp\(aq: False,
        \(aqdisable\(aq: False,
        \(aqemail_list\(aq: [],
        \(aqenable_ddns\(aq: False,
        \(aqenable_dhcp_thresholds\(aq: False,
        \(aqenable_email_warnings\(aq: False,
        \(aqenable_ifmap_publishing\(aq: False,
        \(aqenable_snmp_warnings\(aq: False,
        \(aqend_addr\(aq: \(aq129.97.150.169\(aq,
        \(aqexclude\(aq: [],
        \(aqextattrs\(aq: {},
        \(aqfingerprint_filter_rules\(aq: [],
        \(aqhigh_water_mark\(aq: 95,
        \(aqhigh_water_mark_reset\(aq: 85,
        \(aqignore_dhcp_option_list_request\(aq: False,
        \(aqlease_scavenge_time\(aq: \-1,
        \(aqlogic_filter_rules\(aq: [],
        \(aqlow_water_mark\(aq: 0,
        \(aqlow_water_mark_reset\(aq: 10,
        \(aqmac_filter_rules\(aq: [],
        \(aqmember\(aq: {\(aq_struct\(aq: \(aqdhcpmember\(aq,
                \(aqipv4addr\(aq: \(aq129.97.128.9\(aq,
                \(aqname\(aq: \(aqcn\-dhcp\-mc.example.ca\(aq},
        \(aqms_options\(aq: [],
        \(aqnac_filter_rules\(aq: [],
        \(aqname\(aq: \(aqghost\-range\(aq,
        \(aqnetwork\(aq: \(aq129.97.150.0/24\(aq,
        \(aqnetwork_view\(aq: \(aqdefault\(aq,
        \(aqoption_filter_rules\(aq: [],
        \(aqoptions\(aq: [{\(aqname\(aq: \(aqdhcp\-lease\-time\(aq,
                    \(aqnum\(aq: 51,
                    \(aquse_option\(aq: False,
                    \(aqvalue\(aq: \(aq43200\(aq,
                    \(aqvendor_class\(aq: \(aqDHCP\(aq}],
        \(aqrecycle_leases\(aq: True,
        \(aqrelay_agent_filter_rules\(aq: [],
        \(aqserver_association_type\(aq: \(aqMEMBER\(aq,
        \(aqstart_addr\(aq: \(aq129.97.150.160\(aq,
        \(aqupdate_dns_on_lease_renewal\(aq: False,
        \(aquse_authority\(aq: False,
        \(aquse_bootfile\(aq: False,
        \(aquse_bootserver\(aq: False,
        \(aquse_ddns_domainname\(aq: False,
        \(aquse_ddns_generate_hostname\(aq: True,
        \(aquse_deny_bootp\(aq: False,
        \(aquse_email_list\(aq: False,
        \(aquse_enable_ddns\(aq: False,
        \(aquse_enable_dhcp_thresholds\(aq: False,
        \(aquse_enable_ifmap_publishing\(aq: False,
        \(aquse_ignore_dhcp_option_list_request\(aq: False,
        \(aquse_known_clients\(aq: False,
        \(aquse_lease_scavenge_time\(aq: False,
        \(aquse_nextserver\(aq: False,
        \(aquse_options\(aq: False,
        \(aquse_recycle_leases\(aq: False,
        \(aquse_unknown_clients\(aq: False,
        \(aquse_update_dns_on_lease_renewal\(aq: False
    }
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.ini_manage
.SS Manage ini files
.INDENT 0.0
.TP
.B maintainer
<\fI\%akilesh1597@gmail.com\fP>
.TP
.B maturity
new
.TP
.B depends
re
.TP
.B platform
all
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ini_manage.options_absent(name, sections=None, separator=\(aq=\(aq)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/home/saltminion/api\-paste.ini:
  ini.options_absent:
    \- separator: \(aq=\(aq
    \- sections:
        test:
          \- testkey
          \- secondoption
        test1:
          \- testkey1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
options present in file and not specified in sections
dict will be untouched
.sp
changes dict will contain the list of changes made
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ini_manage.options_present(name, sections=None, separator=\(aq=\(aq, strict=False)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/home/saltminion/api\-paste.ini:
  ini.options_present:
    \- separator: \(aq=\(aq
    \- strict: True
    \- sections:
        test:
          testkey: \(aqtestval\(aq
          secondoption: \(aqsecondvalue\(aq
        test1:
          testkey1: \(aqtestval121\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
options present in file and not specified in sections
dict will be untouched, unless \fIstrict: True\fP flag is
used
.sp
changes dict will contain the list of changes made
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ini_manage.sections_absent(name, sections=None, separator=\(aq=\(aq)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/home/saltminion/api\-paste.ini:
  ini.sections_absent:
    \- separator: \(aq=\(aq
    \- sections:
        \- test
        \- test1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
options present in file and not specified in sections will be deleted
changes dict will contain the sections that changed
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ini_manage.sections_present(name, sections=None, separator=\(aq=\(aq)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/home/saltminion/api\-paste.ini:
  ini.sections_present:
    \- separator: \(aq=\(aq
    \- sections:
        \- section_one
        \- section_two
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will only create empty sections. To also create options, use
options_present state
.sp
options present in file and not specified in sections will be deleted
changes dict will contain the sections that changed
.UNINDENT
.SS salt.states.ipmi
.SS Manage IPMI devices over LAN
.sp
The following configuration defaults can be defined in the
minion, master config or pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ipmi.config:
    api_host: 127.0.0.1
    api_user: admin
    api_pass: apassword
    api_port: 623
    api_kg: None
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Every call can override the config defaults:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ensure myipmi system is set to network boot:
    ipmi.boot_device:
        \- name: network
        \- api_host: myipmi.hostname.com
        \- api_user: root
        \- api_pass: apassword
        \- api_kg: None

ensure myipmi system is powered on:
    ipmi.power:
        \- name: boot
        \- api_host: myipmi.hostname.com
        \- api_user: root
        \- api_pass: apassword
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ipmi.boot_device(name=\(aqdefault\(aq, **kwargs)
Request power state change
.INDENT 7.0
.TP
.B name = \fBdefault\fP
.INDENT 7.0
.IP \(bu 2
network \-\- Request network boot
.IP \(bu 2
hd \-\- Boot from hard drive
.IP \(bu 2
safe \-\- Boot from hard drive, requesting \(aqsafe mode\(aq
.IP \(bu 2
optical \-\- boot from CD/DVD/BD drive
.IP \(bu 2
setup \-\- Boot into setup utility
.IP \(bu 2
default \-\- remove any IPMI directed boot device request
.UNINDENT
.TP
.B kwargs
.INDENT 7.0
.IP \(bu 2
api_host=localhost
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ipmi.power(name=\(aqpower_on\(aq, wait=300, **kwargs)
Request power state change
.INDENT 7.0
.TP
.B name
.INDENT 7.0
.TP
.B Ensure power state one of:
.INDENT 7.0
.IP \(bu 2
power_on \-\- system turn on
.IP \(bu 2
power_off \-\- system turn off (without waiting for OS)
.IP \(bu 2
shutdown \-\- request OS proper shutdown
.IP \(bu 2
reset \-\- reset (without waiting for OS)
.IP \(bu 2
boot \-\- If system is off, then \(aqon\(aq, else \(aqreset\(aq
.UNINDENT
.UNINDENT
.TP
.B wait
wait X seconds for the job to complete before forcing.
(defaults to 300 seconds)
.TP
.B kwargs
.INDENT 7.0
.IP \(bu 2
api_host=localhost
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ipmi.user_absent(name, channel=14, **kwargs)
Remove user
Delete all user (uid) records having the matching name.
.INDENT 7.0
.TP
.B name
string name of user to delete
.TP
.B channel
channel to remove user access from defaults to 14 for auto.
.TP
.B kwargs
.INDENT 7.0
.IP \(bu 2
api_host=localhost
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ipmi.user_present(name, uid, password, channel=14, callback=False, link_auth=True, ipmi_msg=True, privilege_level=\(aqadministrator\(aq, **kwargs)
Ensure IPMI user and user privileges.
.INDENT 7.0
.TP
.B name
name of user (limit 16 bytes)
.TP
.B uid
user id number (1 to 7)
.TP
.B password
user password (limit 16 bytes)
.TP
.B channel
ipmi channel defaults to 14 for auto
.TP
.B callback
User Restricted to Callback
.INDENT 7.0
.TP
.B False = User Privilege Limit is determined by the User Privilege Limit
parameter privilege_level, for both callback and non\-callback connections.
.TP
.B True  = User Privilege Limit is determined by the privilege_level
parameter for callback connections, but is restricted to Callback
level for non\-callback connections. Thus, a user can only initiate
a Callback when they \(aqcall in\(aq to the BMC, but once the callback
connection has been made, the user could potentially establish a
session as an Operator.
.UNINDENT
.TP
.B link_auth
User Link authentication
True/False
user name and password information will be used for link
authentication, e.g. PPP CHAP) for the given channel. Link
authentication itself is a global setting for the channel and is
enabled/disabled via the serial/modem configuration parameters.
.TP
.B ipmi_msg
User IPMI Messaging
True/False
user name and password information will be used for IPMI
Messaging. In this case, \(aqIPMI Messaging\(aq refers to the ability to
execute generic IPMI commands that are not associated with a
particular payload type. For example, if IPMI Messaging is disabled for
a user, but that user is enabled for activating the SOL
payload type, then IPMI commands associated with SOL and session
management, such as Get SOL Configuration Parameters and Close Session
are available, but generic IPMI commands such as Get SEL Time are
unavailable.)
ipmi_msg
.TP
.B privilege_level
.INDENT 7.0
.IP \(bu 2
callback
.IP \(bu 2
user
.IP \(bu 2
operator
.IP \(bu 2
administrator
.IP \(bu 2
proprietary
.IP \(bu 2
no_access
.UNINDENT
.TP
.B kwargs
.INDENT 7.0
.IP \(bu 2
api_host=localhost
.IP \(bu 2
api_user=admin
.IP \(bu 2
api_pass=
.IP \(bu 2
api_port=623
.IP \(bu 2
api_kg=None
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.ipset
.SS Management of ipsets
.sp
This is an ipset\-specific module designed to manage IPSets for use
in IPTables Firewalls.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
setname:
  ipset.set_present:
    \- set_type: bitmap:ip
    \- range: 192.168.0.0/16
    \- comment: True

setname:
  ipset.set_absent:
    \- set_type: bitmap:ip
    \- range: 192.168.0.0/16
    \- comment: True

setname_entries:
  ipset.present:
    \- set_name: setname
    \- entry: 192.168.0.3
    \- comment: Hello
    \- require:
        \- ipset: baz

setname_entries:
  ipset.present:
    \- set_name: setname
    \- entry:
        \- 192.168.0.3
        \- 192.168.1.3
    \- comment: Hello
    \- require:
        \- ipset: baz

setname_entries:
  ipset.absent:
    \- set_name: setname
    \- entry:
        \- 192.168.0.3
        \- 192.168.1.3
    \- comment: Hello
    \- require:
        \- ipset: baz

setname:
  ipset.flush:
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ipset.absent(name, entry=None, entries=None, family=\(aqipv4\(aq, **kwargs)
New in version 2014.7.0.

.sp
Remove a entry or entries from a chain
.INDENT 7.0
.TP
.B name
A user\-defined name to call this entry by in another part of a state or
formula. This should not be an actual entry.
.TP
.B family
Network family, ipv4 or ipv6.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ipset.flush(name, family=\(aqipv4\(aq, **kwargs)
New in version 2014.7.0.

.sp
Flush current ipset set
.INDENT 7.0
.TP
.B family
Networking family, either ipv4 or ipv6
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ipset.present(name, entry=None, family=\(aqipv4\(aq, **kwargs)
New in version 2014.7.0.

.sp
Append a entry to a set
.INDENT 7.0
.TP
.B name
A user\-defined name to call this entry by in another part of a state or
formula. This should not be an actual entry.
.TP
.B entry
A single entry to add to a set or a list of entries to add to a set
.TP
.B family
Network family, ipv4 or ipv6.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ipset.set_absent(name, family=\(aqipv4\(aq, **kwargs)
New in version 2014.7.0.

.sp
Verify the set is absent.
.INDENT 7.0
.TP
.B family
Networking family, either ipv4 or ipv6
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ipset.set_present(name, set_type, family=\(aqipv4\(aq, **kwargs)
New in version 2014.7.0.

.sp
Verify the set exists.
.INDENT 7.0
.TP
.B name
A user\-defined set name.
.TP
.B set_type
The type for the set.
.TP
.B family
Networking family, either ipv4 or ipv6
.UNINDENT
.UNINDENT
.SS salt.states.iptables
.SS Management of iptables
.sp
This is an iptables\-specific module designed to manage Linux firewalls. It is
expected that this state module, and other system\-specific firewall states, may
at some point be deprecated in favor of a more generic \fBfirewall\fP state.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  iptables.append:
    \- table: filter
    \- chain: INPUT
    \- jump: ACCEPT
    \- match: state
    \- connstate: NEW
    \- dport: 80
    \- protocol: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  iptables.append:
    \- table: filter
    \- chain: INPUT
    \- jump: ACCEPT
    \- match:
        \- state
        \- comment
    \- comment: \(dqAllow HTTP\(dq
    \- connstate: NEW
    \- dport: 80
    \- protocol: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  iptables.append:
    \- table: filter
    \- chain: INPUT
    \- jump: ACCEPT
    \- match:
        \- state
        \- comment
    \- comment: \(dqAllow HTTP\(dq
    \- connstate: NEW
    \- source: \(aq127.0.0.1\(aq
    \- dport: 80
    \- protocol: tcp
    \- sport: 1025:65535
    \- save: True

\&.. Invert Rule
httpd:
  iptables.append:
    \- table: filter
    \- chain: INPUT
    \- jump: ACCEPT
    \- match:
        \- state
        \- comment
    \- comment: \(dqAllow HTTP\(dq
    \- connstate: NEW
    \- source: \(aq! 127.0.0.1\(aq
    \- dport: 80
    \- protocol: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  iptables.append:
    \- table: filter
    \- chain: INPUT
    \- jump: ACCEPT
    \- match:
        \- state
        \- comment
    \- comment: \(dqAllow HTTP\(dq
    \- connstate: NEW
    \- source: \(aqnot 127.0.0.1\(aq
    \- dport: 80
    \- protocol: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  iptables.append:
    \- table: filter
    \- family: ipv6
    \- chain: INPUT
    \- jump: ACCEPT
    \- match: state
    \- connstate: NEW
    \- dport: 80
    \- protocol: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  iptables.append:
    \- table: filter
    \- family: ipv4
    \- chain: INPUT
    \- jump: ACCEPT
    \- match: state
    \- connstate: NEW
    \- dports:
        \- 80
        \- 443
    \- protocol: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  iptables.insert:
    \- position: 1
    \- table: filter
    \- chain: INPUT
    \- jump: ACCEPT
    \- match: state
    \- connstate: NEW
    \- dport: 80
    \- protocol: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  iptables.insert:
    \- position: 1
    \- table: filter
    \- family: ipv6
    \- chain: INPUT
    \- jump: ACCEPT
    \- match: state
    \- connstate: NEW
    \- dport: 80
    \- protocol: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  iptables.delete:
    \- table: filter
    \- chain: INPUT
    \- jump: ACCEPT
    \- match: state
    \- connstate: NEW
    \- dport: 80
    \- protocol: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  iptables.delete:
    \- position: 1
    \- table: filter
    \- chain: INPUT
    \- jump: ACCEPT
    \- match: state
    \- connstate: NEW
    \- dport: 80
    \- protocol: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  iptables.delete:
    \- table: filter
    \- family: ipv6
    \- chain: INPUT
    \- jump: ACCEPT
    \- match: state
    \- connstate: NEW
    \- dport: 80
    \- protocol: tcp
    \- sport: 1025:65535
    \- save: True

default to accept:
  iptables.set_policy:
    \- chain: INPUT
    \- policy: ACCEPT
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Whereas iptables will accept \fB\-p\fP, \fB\-\-proto[c[o[l]]]\fP as synonyms of
\fB\-\-protocol\fP, if \fB\-\-proto\fP appears in an iptables command after the
appearance of \fB\-m policy\fP, it is interpreted as the \fB\-\-proto\fP option of
the policy extension (see the iptables\-extensions(8) man page).
.UNINDENT
.UNINDENT
.sp
Example rules for IPSec policy:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
accept_esp_in:
  iptables.append:
    \- table: filter
    \- chain: INPUT
    \- jump: ACCEPT
    \- source: 10.20.0.0/24
    \- destination: 10.10.0.0/24
    \- in\-interface: eth0
    \- match: policy
    \- dir: in
    \- pol: ipsec
    \- reqid: 1
    \- proto: esp
accept_esp_forward_in:
  iptables.append:
    \- use:
      \- iptables: accept_esp_in
    \- chain: FORWARD

accept_esp_out:
  iptables.append:
    \- table: filter
    \- chain: OUTPUT
    \- jump: ACCEPT
    \- source: 10.10.0.0/24
    \- destination: 10.20.0.0/24
    \- out\-interface: eth0
    \- match: policy
    \- dir: out
    \- pol: ipsec
    \- reqid: 1
    \- proto: esp
accept_esp_forward_out:
  iptables.append:
    \- use:
      \- iptables: accept_esp_out
    \- chain: FORWARD
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBname\fP is reserved for the Salt state name. To pass \fB\-\-name EXAMPLE\fP to
iptables, provide it with \fB\- name_: EXAMPLE\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Various functions of the \fBiptables\fP module use the \fB\-\-check\fP option. If
the version of \fBiptables\fP on the target system does not include this
option, an alternate version of this check will be performed using the
output of iptables\-save. This may have unintended consequences on legacy
releases of \fBiptables\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.iptables.append(name, table=\(aqfilter\(aq, family=\(aqipv4\(aq, **kwargs)
New in version 0.17.0.

.sp
Add a rule to the end of the specified chain.
If the rule is already present anywhere in the chain, its position is
not changed.
.INDENT 7.0
.TP
.B name
A user\-defined name to call this rule by in another part of a state or
formula. This should not be an actual rule.
.TP
.B table
The table that owns the chain which should be modified
.TP
.B family
Network family, ipv4 or ipv6.
.TP
.B save
If set to a true value, the new iptables rules for the given family
will be saved to a file.
.sp
If the value is True, rules are saved to an OS\-dependent file
that will be loaded during system startup, resulting in the
firewall rule remaining active across reboots if possible.
.sp
Note that loading the iptables rules during system startup
may require non\-default packages to be installed.
On Debian\-derived systems, the iptables\-persistent
package is required.
.sp
If the value is a string, it is taken to be a filename to which
the rules will be saved. Arranging for the rules to be loaded
during system startup must be done separately.
.UNINDENT
.sp
All other arguments are passed in with the same name as the long option
that would normally be used for iptables, with one exception: \fB\-\-state\fP is
specified as \fIconnstate\fP instead of \fIstate\fP (not to be confused with
\fIctstate\fP).
.sp
Jump options that doesn\(aqt take arguments should be passed in with an empty
string.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.iptables.chain_absent(name, table=\(aqfilter\(aq, family=\(aqipv4\(aq)
New in version 2014.1.0.

.sp
Verify the chain is absent.
.INDENT 7.0
.TP
.B table
The table to remove the chain from
.TP
.B family
Networking family, either ipv4 or ipv6
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.iptables.chain_present(name, table=\(aqfilter\(aq, family=\(aqipv4\(aq)
New in version 2014.1.0.

.sp
Verify the chain is exist.
.INDENT 7.0
.TP
.B name
A user\-defined chain name.
.TP
.B table
The table to own the chain.
.TP
.B family
Networking family, either ipv4 or ipv6
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.iptables.delete(name, table=\(aqfilter\(aq, family=\(aqipv4\(aq, **kwargs)
New in version 2014.1.0.

.sp
Delete a rule from a chain if present. If the rule is already absent,
this is not an error and nothing is changed.
.INDENT 7.0
.TP
.B name
A user\-defined name to call this rule by in another part of a state or
formula. This should not be an actual rule.
.TP
.B table
The table that owns the chain that should be modified
.TP
.B family
Networking family, either ipv4 or ipv6
.TP
.B save
If set to a true value, the new iptables rules for the given family
will be saved to a file. See the \fBappend\fP state for more details.
.UNINDENT
.sp
All other arguments are passed in with the same name as the long option
that would normally be used for iptables, with one exception: \fB\-\-state\fP is
specified as \fIconnstate\fP instead of \fIstate\fP (not to be confused with
\fIctstate\fP).
.sp
Jump options that doesn\(aqt take arguments should be passed in with an empty
string.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.iptables.flush(name, table=\(aqfilter\(aq, family=\(aqipv4\(aq, **kwargs)
New in version 2014.1.0.

.sp
Flush current iptables state
.INDENT 7.0
.TP
.B table
The table that owns the chain that should be modified
.TP
.B family
Networking family, either ipv4 or ipv6
.TP
.B chain
The chain to be flushed. All the chains in the table if none is given.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.iptables.insert(name, table=\(aqfilter\(aq, family=\(aqipv4\(aq, **kwargs)
New in version 2014.1.0.

.sp
Insert a rule into a chain. If the rule is already present anywhere
in the chain, its position is not changed.
.INDENT 7.0
.TP
.B name
A user\-defined name to call this rule by in another part of a state or
formula. This should not be an actual rule.
.TP
.B table
The table that owns the chain that should be modified
.TP
.B family
Networking family, either ipv4 or ipv6
.TP
.B position
The numerical representation of where the rule should be inserted into
the chain. Note that \fB\-1\fP is not a supported position value.
.TP
.B save
If set to a true value, the new iptables rules for the given family
will be saved to a file. See the \fBappend\fP state for more details.
.UNINDENT
.sp
All other arguments are passed in with the same name as the long option
that would normally be used for iptables, with one exception: \fB\-\-state\fP is
specified as \fIconnstate\fP instead of \fIstate\fP (not to be confused with
\fIctstate\fP).
.sp
Jump options that doesn\(aqt take arguments should be passed in with an empty
string.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.iptables.mod_aggregate(low, chunks, running)
The mod_aggregate function which looks up all rules in the available
low chunks and merges them into a single rules ref in the present low data
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.iptables.set_policy(name, table=\(aqfilter\(aq, family=\(aqipv4\(aq, **kwargs)
New in version 2014.1.0.

.sp
Sets the default policy for iptables firewall tables
.INDENT 7.0
.TP
.B table
The table that owns the chain that should be modified
.TP
.B family
Networking family, either ipv4 or ipv6
.TP
.B policy
The requested table policy
.TP
.B save
If set to a true value, the new iptables rules for the given family
will be saved to a file. See the \fBappend\fP state for more details.
.UNINDENT
.UNINDENT
.SS salt.states.jboss7
.sp
Manage JBoss 7 Application Server via CLI interface
.sp
New in version 2015.5.0.

.sp
This state uses the jboss\-cli.sh script from a JBoss or Wildfly installation and parses its output to determine the execution result.
.sp
In order to run each state, a jboss_config dictionary with the following properties must be passed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jboss:
   cli_path: \(aq/opt/jboss/jboss\-7.0/bin/jboss\-cli.sh\(aq
   controller: 10.11.12.13:9999
   cli_user: \(aqjbossadm\(aq
   cli_password: \(aqjbossadm\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the controller doesn\(aqt require a password, then the cli_user and cli_password parameters are optional.
.sp
Since same dictionary with configuration will be used in all the states, it may be more convenient to move JBoss configuration and other properties
to the pillar.
.sp
Example of application deployment from local filesystem:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
application_deployed:
  jboss7.deployed:
    \- salt_source:
        target_file: \(aq/tmp/webapp.war\(aq
    \- jboss_config: {{ pillar[\(aqjboss\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For the sake of brevity, examples for each state assume that jboss_config is contained in the pillar.
.INDENT 0.0
.TP
.B salt.states.jboss7.bindings_exist(name, jboss_config, bindings, profile=None)
Ensures that given JNDI binding are present on the server.
If a binding doesn\(aqt exist on the server it will be created.
If it already exists its value will be changed.
.INDENT 7.0
.TP
.B jboss_config:
Dict with connection properties (see state description)
.TP
.B bindings:
Dict with bindings to set.
.TP
.B profile:
The profile name (domain mode only)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
jndi_entries_created:
  jboss7.bindings_exist:
   \- bindings:
      \(aqjava:global/sampleapp/environment\(aq: \(aqDEV\(aq
      \(aqjava:global/sampleapp/configurationFile\(aq: \(aq/var/opt/sampleapp/config.properties\(aq
   \- jboss_config: {{ pillar[\(aqjboss\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.jboss7.datasource_exists(name, jboss_config, datasource_properties, recreate=False, profile=None)
Ensures that a datasource with given properties exist on the jboss instance.
If datasource doesn\(aqt exist, it is created, otherwise only the properties that are different will be updated.
.INDENT 7.0
.TP
.B name
Datasource property name
.TP
.B jboss_config
Dict with connection properties (see state description)
.TP
.B datasource_properties
Dict with datasource properties
.TP
.B recreate
False
If set to True and datasource exists it will be removed and created again. However, if there are deployments that depend on the datasource, it will not me possible to remove it.
.TP
.B profile
None
The profile name for this datasource (domain mode only)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sampleDS:
  jboss7.datasource_exists:
   \- recreate: False
   \- datasource_properties:
       driver\-name: mysql
       connection\-url: \(aqjdbc:mysql://localhost:3306/sampleDatabase\(aq
       jndi\-name: \(aqjava:jboss/datasources/sampleDS\(aq
       user\-name: sampleuser
       password: secret
       min\-pool\-size: 3
       use\-java\-context: True
   \- jboss_config: {{ pillar[\(aqjboss\(aq] }}
   \- profile: full\-ha
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.jboss7.deployed(name, jboss_config, salt_source=None)
Ensures that the given application is deployed on server.
.INDENT 7.0
.TP
.B jboss_config:
Dict with connection properties (see state description)
.TP
.B salt_source:
.INDENT 7.0
.TP
.B How to find the artifact to be deployed.
.INDENT 7.0
.TP
.B target_file:
Where to look in the minion\(aqs file system for the artifact to be deployed (e.g. \(aq/tmp/application\-web\-0.39.war\(aq).  When source is specified,  also specifies where to save the retrieved file.
.TP
.B source:
(optional) File on salt master (e.g. salt://application\-web\-0.39.war).  If absent, no files will be retrieved and the artifact in target_file will be used for the deployment.
.TP
.B undeploy:
(optional) Regular expression to match against existing deployments.  When present, if there is a deployment that matches the regular expression, it will be undeployed before the new artifact is deployed.
.TP
.B undeploy_force:
(optional) If True, the artifact will be undeployed although it has not changed.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Examples:
.sp
Deployment of a file from minion\(aqs local file system:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
application_deployed:
  jboss7.deployed:
    \- salt_source:
        target_file: \(aq/tmp/webapp.war\(aq
    \- jboss_config: {{ pillar[\(aqjboss\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is assumed that /tmp/webapp.war was made available by some
other means.  No applications will be undeployed; if an existing
deployment that shares that name exists, then it will be replaced
with the updated version.
.sp
Deployment of a file from the Salt master\(aqs file system:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
application_deployed:
  jboss7.deployed:
   \- salt_source:
        source: salt://application\-web\-0.39.war
        target_file: \(aq/tmp/application\-web\-0.39.war\(aq
        undeploy: \(aqapplication\-web\-.*\(aq
   \- jboss_config: {{ pillar[\(aqjboss\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here, application\-web\-0.39.war file is downloaded from Salt file system to /tmp/application\-web\-0.39.war file on minion.
Existing deployments are checked if any of them matches \(aqapplication\-web\-.*\(aq regular expression, and if so then it
is undeployed before deploying the application. This is useful to automate deployment of new application versions.
.sp
If the source parameter of salt_source is specified, it can use
any protocol that the file states use.  This includes not only
downloading from the master but also HTTP, HTTPS, FTP,
Amazon S3, and OpenStack Swift.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.jboss7.reloaded(name, jboss_config, timeout=60, interval=5)
Reloads configuration of jboss server.
.INDENT 7.0
.TP
.B jboss_config:
Dict with connection properties (see state description)
.TP
.B timeout:
Time to wait until jboss is back in running state. Default timeout is 60s.
.TP
.B interval:
Interval between state checks. Default interval is 5s. Decreasing the interval may slightly decrease waiting time
but be aware that every status check is a call to jboss\-cli which is a java process. If interval is smaller than
process cleanup time it may easily lead to excessive resource consumption.
.UNINDENT
.sp
This step performs the following operations:
.INDENT 7.0
.IP \(bu 2
Ensures that server is in running or reload\-required state (by reading server\-state attribute)
.IP \(bu 2
Reloads configuration
.IP \(bu 2
Waits for server to reload and be in running state
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
configuration_reloaded:
   jboss7.reloaded:
    \- jboss_config: {{ pillar[\(aqjboss\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.jenkins
.SS Management of Jenkins
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.states.jenkins.absent(name, **kwargs)
Ensure the job is absent from the Jenkins configured jobs
.INDENT 7.0
.TP
.B name
The name of the Jenkins job to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.jenkins.present(name, config=None, **kwargs)
Ensure the job is present in the Jenkins configured jobs
.INDENT 7.0
.TP
.B name
The unique name for the Jenkins job
.TP
.B config
The Salt URL for the file to use for configuring the job
.UNINDENT
.UNINDENT
.SS salt.states.junos
.SS State modules to interact with Junos devices.
.INDENT 0.0
.TP
.B maturity
new
.TP
.B dependencies
junos\-eznc, jxmlease
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Those who wish to use junos\-eznc (PyEZ) version >= 2.1.0, must
use the latest salt code from github until the next release.
.UNINDENT
.UNINDENT
.sp
Refer to \fI\%junos\fP for information on connecting to junos proxy.
.INDENT 0.0
.TP
.B salt.states.junos.cli(name, **kwargs)
Executes the CLI commands and reuturns the text output.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
show version:
  junos.cli:
    \- format: xml

get software version of device:
  junos.cli:
    \- name: show version
    \- format: text
    \- dest: /home/user/show_version.log
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBRequired\fP \-\- .INDENT 2.0
.IP \(bu 2
name:
The command that need to be executed on Junos CLI. (default = None)
.UNINDENT

.IP \(bu 2
\fBOptional\fP \-\- .INDENT 2.0
.IP \(bu 2
.INDENT 2.0
.TP
.B kwargs: Keyworded arguments which can be provided like\-
.INDENT 7.0
.IP \(bu 2
format:
Format in which to get the CLI output. (text or xml,                 default = \(aqtext\(aq)
.IP \(bu 2
timeout:
Set NETCONF RPC timeout. Can be used for commands which
take a while to execute. (default = 30 seconds)
.IP \(bu 2
dest:
The destination file where the CLI output can be stored.               (default = None)
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.commit(name, **kwargs)
Commits the changes loaded into the candidate configuration.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
commit the changes:
  junos.commit:
    \- confirm: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBOptional\fP \-\- .INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B kwargs: Keyworded arguments which can be provided like\-
.INDENT 7.0
.IP \(bu 2
timeout:
Set NETCONF RPC timeout. Can be used for commands which take a               while to execute. (default = 30 seconds)
.IP \(bu 2
comment:
Provide a comment to the commit. (default = None)
.IP \(bu 2
confirm:
Provide time in minutes for commit confirmation. If this option               is specified, the commit will be rollbacked in the given time               unless the commit is confirmed.
.IP \(bu 2
sync:
On dual control plane systems, requests that the candidate              configuration on one control plane be copied to the other               control plane,checked for correct syntax, and committed on               both Routing Engines. (default = False)
.IP \(bu 2
force_sync:
On dual control plane systems, force the candidate configuration
on one control plane to be copied to the other control plane.
.IP \(bu 2
full:
When set to True requires all the daemons to check and evaluate               the new configuration.
.IP \(bu 2
detail:
When true return commit detail.
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.commit_check(name)
Perform a commit check on the configuration.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
perform commit check:
  junos.commit_check
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.diff(name, d_id=0, **kwargs)
Changed in version 3001.

.sp
Gets the difference between the candidate and the current configuration.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
get the diff:
  junos.diff:
    \- d_id: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBOptional\fP \-\- .INDENT 7.0
.IP \(bu 2
d_id:
The rollback diff id (d_id) value [0\-49]. (default = 0)
.UNINDENT

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.file_copy(name, dest=None, **kwargs)
Copies the file from the local device to the junos device.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/home/m2/info.txt:
  junos.file_copy:
    \- dest: info_copy.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBRequired\fP \-\- .INDENT 7.0
.IP \(bu 2
name:
The sorce path where the file is kept.
.IP \(bu 2
dest:
The destination path where the file will be copied.
.UNINDENT

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.get_table(name, table, table_file, **kwargs)
New in version 3001.

.sp
Retrieve data from a Junos device using Tables/Views
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
get route details:
  junos.get_table:
    \- table: RouteTable
    \- table_file: routes.yml

get interface details:
  junos.get_table:
    \- table: EthPortTable
    \- table_file: ethport.yml
    \- table_args:
        interface_name: ge\-0/0/0
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name (required)
task definition
.TP
.B table (required)
Name of PyEZ Table
.TP
.B file
YAML file that has the table specified in table parameter
.TP
.B path:
Path of location of the YAML file.
defaults to op directory in jnpr.junos.op
.TP
.B target:
if command need to run on FPC, can specify fpc target
.TP
.B key:
To overwrite key provided in YAML
.TP
.B key_items:
To select only given key items
.TP
.B filters:
To select only filter for the dictionary from columns
.TP
.B template_args:
key/value pair which should render Jinja template command
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.install_config(name, **kwargs)
Loads and commits the configuration provided.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Install the mentioned config:
  junos.install_config:
    \- name: salt://configs/interface.set
    \- timeout: 100
    \- diffs_file: \(aq/var/log/diff\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Install the mentioned config:
  junos.install_config:
    \- path: salt://configs/interface.set
    \- timeout: 100
    \- template_vars:
        interface_name: lo0
        description: Creating interface via SaltStack.
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Path where the configuration/template file is present. If the file has
a \fB*.conf\fP extension, the content is treated as text format. If the
file has a \fB*.xml\fP extension, the content is treated as XML format. If
the file has a \fB*.set\fP extension, the content is treated as Junos OS
\fBset\fP commands
.TP
.B template_vars
The dictionary of data for the jinja variables present in the jinja
template
.TP
.B timeout
30
Set NETCONF RPC timeout. Can be used for commands which take a while to
execute.
.TP
.B overwrite
False
Set to \fBTrue\fP if you want this file is to completely replace the
configuration file. Sets action to override
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option cannot be used if \fBformat\fP is \(dqset\(dq.
.UNINDENT
.UNINDENT
.TP
.B merge
False
If set to \fBTrue\fP will set the load\-config action to merge.
the default load\-config action is \(aqreplace\(aq for xml/json/text config
.TP
.B comment
Provide a comment to the commit. (default = None)
.TP
.B confirm
Provide time in minutes for commit confirmation. If this option is
specified, the commit will be rolled back in the given time unless the
commit is confirmed.
.TP
.B diffs_file
Path to the file where the diff (difference in old configuration and the
committed configuration) will be stored.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The file will be stored on the proxy minion. To push the files to the
master use \fI\%cp.push\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.install_os(name, **kwargs)
Installs the given image on the device. After the installation is complete
the device is rebooted, if reboot=True is given as a keyworded argument.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt://images/junos_image.tgz:
  junos.install_os:
    \- timeout: 100
    \- reboot: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBRequired\fP \-\- .INDENT 2.0
.IP \(bu 2
name:
Path where the image file is present on the pro          xy minion.
.UNINDENT

.IP \(bu 2
\fBOptional\fP \-\- .INDENT 2.0
.IP \(bu 2
.INDENT 2.0
.TP
.B kwargs: keyworded arguments to be given such as timeout, reboot etc
.INDENT 7.0
.IP \(bu 2
timeout:
Set NETCONF RPC timeout. Can be used to RPCs which
take a while to execute. (default = 30 seconds)
.IP \(bu 2
reboot:
Whether to reboot after installation (default = False)
.IP \(bu 2
no_copy:
When True the software package will not be SCP’d to the device.               (default = False)
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.load(name, **kwargs)
Loads the configuration provided onto the junos device.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Install the mentioned config:
  junos.load:
    \- name: salt://configs/interface.set
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Install the mentioned config:
  junos.load:
    \- name: salt://configs/interface.set
    \- template_vars:
        interface_name: lo0
        description: Creating interface via SaltStack.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Sample template:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
set interfaces {{ interface_name }} unit 0
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Path where the configuration/template file is present. If the file has
a \fB*.conf\fP extension, the content is treated as text format. If the
file has a \fB*.xml\fP extension, the content is treated as XML format. If
the file has a \fB*.set\fP extension, the content is treated as Junos OS
\fBset\fP commands.
.TP
.B overwrite
False
Set to \fBTrue\fP if you want this file is to completely replace the
configuration file.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option cannot be used if \fBformat\fP is \(dqset\(dq.
.UNINDENT
.UNINDENT
.TP
.B merge
False
If set to \fBTrue\fP will set the load\-config action to merge.
the default load\-config action is \(aqreplace\(aq for xml/json/text config
.TP
.B update
False
Compare a complete loaded configuration against the candidate
configuration. For each hierarchy level or configuration object that is
different in the two configurations, the version in the loaded
configuration replaces the version in the candidate configuration. When
the configuration is later committed, only system processes that are
affected by the changed configuration elements parse the new
configuration. This action is supported from PyEZ 2.1 (default = False)
.TP
.B template_vars
Variables to be passed into the template processing engine in addition
to those present in __pillar__, __opts__, __grains__, etc.
You may reference these variables in your template like so:
{{ template_vars[\(dqvar_name\(dq] }}
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.lock(name)
Attempts an exclusive lock on the candidate configuration. This
is a non\-blocking call.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Any user who wishes to use lock, must necessarily unlock the
configuration too. Ensure \fI\%unlock\fP
is called in the same orchestration run in which the lock is called.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
lock the config:
  junos.lock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.resultdecorator(function)
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.rollback(name, d_id, **kwargs)
Rollbacks the committed changes.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
rollback the changes:
  junos.rollback:
    \- id: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBOptional\fP \-\- .INDENT 7.0
.IP \(bu 2
id:
.IP \(bu 2
d_id:
The rollback id value [0\-49]. (default = 0)
(this variable cannot be named \fIid\fP, it conflicts
with the state compiler\(aqs internal id)
.IP \(bu 2
.INDENT 2.0
.TP
.B kwargs: Keyworded arguments which can be provided like\-
.INDENT 7.0
.IP \(bu 2
timeout:
Set NETCONF RPC timeout. Can be used for commands which
take a while to execute. (default = 30 seconds)
.IP \(bu 2
comment:
Provide a comment to the commit. (default = None)
.IP \(bu 2
confirm:
Provide time in minutes for commit confirmation. If this option               is specified, the commit will be rollbacked in the given time               unless the commit is confirmed.
.IP \(bu 2
diffs_file:
Path to the file where any diffs will be written. (default = None)
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.rpc(name, dest=None, format=\(aqxml\(aq, args=None, **kwargs)
Executes the given rpc. The returned data can be stored in a file
by specifying the destination path with dest as an argument
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
get\-interface\-information:
    junos.rpc:
      \- dest: /home/user/rpc.log
      \- interface_name: lo0

fetch interface information with terse:
    junos.rpc:
        \- name: get\-interface\-information
        \- terse: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBRequired\fP \-\- .INDENT 2.0
.IP \(bu 2
name:
The rpc to be executed. (default = None)
.UNINDENT

.IP \(bu 2
\fBOptional\fP \-\- .INDENT 2.0
.IP \(bu 2
dest:
Destination file where the rpc output is stored. (default = None)
Note that the file will be stored on the proxy minion. To push the
files to the master use the salt\(aqs following execution module:             \fI\%cp.push\fP
.IP \(bu 2
format:
The format in which the rpc reply must be stored in file specified in the dest
(used only when dest is specified) (default = xml)
.IP \(bu 2
.INDENT 2.0
.TP
.B kwargs: keyworded arguments taken by rpc call like\-
.INDENT 7.0
.IP \(bu 2
timeout: 30
Set NETCONF RPC timeout. Can be used for commands which
take a while to execute. (default= 30 seconds)
.IP \(bu 2
filter:
Only to be used with \(aqget\-config\(aq rpc to get specific configuration.
.IP \(bu 2
terse:
Amount of information you want.
.IP \(bu 2
interface_name:
Name of the interface whose information you want.
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.set_hostname(name, **kwargs)
Changes the hostname of the device.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
device_name:
  junos.set_hostname:
    \- comment: \(dqHost\-name set via saltstack.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBRequired\fP \-\- .INDENT 2.0
.IP \(bu 2
name: The name to be set. (default = None)
.UNINDENT

.IP \(bu 2
\fBOptional\fP \-\- .INDENT 2.0
.IP \(bu 2
.INDENT 2.0
.TP
.B kwargs: Keyworded arguments which can be provided like\-
.INDENT 7.0
.IP \(bu 2
timeout:
Set NETCONF RPC timeout. Can be used for commands
which take a while to execute. (default = 30 seconds)
.IP \(bu 2
comment:
Provide a comment to the commit. (default = None)
.IP \(bu 2
confirm:
Provide time in minutes for commit confirmation.               If this option is specified, the commit will be rollbacked in               the given time unless the commit is confirmed.
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.shutdown(name, **kwargs)
Shuts down the device.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
shut the device:
  junos.shutdown:
    \- in_min: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBOptional\fP \-\- .INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B kwargs:
.INDENT 7.0
.IP \(bu 2
reboot:
Whether to reboot instead of shutdown. (default=False)
.IP \(bu 2
at:
Specify time for reboot. (To be used only if reboot=yes)
.IP \(bu 2
in_min:
Specify delay in minutes for shutdown
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.unlock(name)
Unlocks the candidate configuration.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
unlock the config:
  junos.unlock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.junos.zeroize(name)
Resets the device to default factory settings.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
reset my device:
  junos.zeroize
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
name: can be anything
.UNINDENT
.SS salt.states.kapacitor
.sp
Kapacitor state module.
.INDENT 0.0
.TP
.B configuration
This module accepts connection configuration details either as
parameters or as configuration settings in /etc/salt/minion on the relevant
minions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
kapacitor.unsafe_ssl: \(aqfalse\(aq
kapacitor.protocol: \(aqhttp\(aq
kapacitor.host: \(aqlocalhost\(aq
kapacitor.port: 9092
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This data can also be passed into pillar. Options passed into opts will
overwrite options passed into pillar.
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.states.kapacitor.task_absent(name)
Ensure that a task is absent from Kapacitor.
.INDENT 7.0
.TP
.B name
Name of the task.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kapacitor.task_present(name, tick_script, task_type=\(aqstream\(aq, database=None, retention_policy=\(aqdefault\(aq, enable=True, dbrps=None)
Ensure that a task is present and up\-to\-date in Kapacitor.
.INDENT 7.0
.TP
.B name
Name of the task.
.TP
.B tick_script
Path to the TICK script for the task. Can be a salt:// source.
.TP
.B task_type
Task type. Defaults to \(aqstream\(aq
.TP
.B dbrps
A list of databases and retention policies in \(dqdbname\(dq.\(dqrpname\(dq format
to fetch data from. For backward compatibility, the value of
\(aqdatabase\(aq and \(aqretention_policy\(aq will be merged as part of dbrps.
.sp
New in version 2019.2.0.

.TP
.B database
Which database to fetch data from. Defaults to None, which will use the
default database in InfluxDB.
.TP
.B retention_policy
Which retention policy to fetch data from. Defaults to \(aqdefault\(aq.
.TP
.B enable
Whether to enable the task or not. Defaults to True.
.UNINDENT
.UNINDENT
.SS salt.states.kernelpkg
.SS Manage kernel packages and active kernel version
.sp
Example state to install the latest kernel from package repositories:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
install\-latest\-kernel:
  kernelpkg.latest_installed: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example state to boot the system if a new kernel has been installed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
boot\-latest\-kernel:
  kernelpkg.latest_active:
    \- at_time: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example state chaining the install and reboot operations:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
install\-latest\-kernel:
  kernelpkg.latest_installed: []

boot\-latest\-kernel:
  kernelpkg.latest_active:
    \- at_time: 1
    \- onchanges:
      \- kernelpkg: install\-latest\-kernel
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Chaining can also be achieved using wait/listen requisites:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
install\-latest\-kernel:
  kernelpkg.latest_installed: []

boot\-latest\-kernel:
  kernelpkg.latest_wait:
    \- at_time: 1
    \- listen:
      \- kernelpkg: install\-latest\-kernel
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kernelpkg.latest_active(name, at_time=None, **kwargs)
Initiate a reboot if the running kernel is not the latest one installed.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state does not install any patches. It only compares the running
kernel version number to other kernel versions also installed in the
system. If the running version is not the latest one installed, this
state will reboot the system.
.sp
See \fI\%kernelpkg.upgrade\fP and
\fI\%latest_installed()\fP
for ways to install new kernel packages.
.sp
This module does not attempt to understand or manage boot loader configurations
it is possible to have a new kernel installed, but a boot loader configuration
that will never activate it. For this reason, it would not be advisable to
schedule this state to run automatically.
.sp
Because this state function may cause the system to reboot, it may be preferable
to move it to the very end of the state run.
See \fI\%latest_wait()\fP
for a waitable state that can be called with the \fIlisten\fP requesite.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Arbitrary name for the state. Does not affect behavior.
.TP
.B at_time
The wait time in minutes before the system will be rebooted.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kernelpkg.latest_installed(name, **kwargs)
Ensure that the latest version of the kernel available in the
repositories is installed.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state only installs the kernel, but does not activate it.
The new kernel should become active at the next reboot.
See \fI\%kernelpkg.needs_reboot\fP for details on
how to detect this condition, and \fI\%latest_active()\fP
to initiale a reboot when needed.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Arbitrary name for the state. Does not affect behavior.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kernelpkg.latest_wait(name, at_time=None, **kwargs)
Initiate a reboot if the running kernel is not the latest one installed. This is the
waitable version of \fI\%latest_active()\fP and
will not take any action unless triggered by a watch or listen requesite.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Because this state function may cause the system to reboot, it may be preferable
to move it to the very end of the state run using \fIlisten\fP or \fIlisten_in\fP requisites.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
system\-up\-to\-date:
  pkg.uptodate:
    \- refresh: true

boot\-latest\-kernel:
  kernelpkg.latest_wait:
    \- at_time: 1
    \- listen:
      \- pkg: system\-up\-to\-date
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
Arbitrary name for the state. Does not affect behavior.
.TP
.B at_time
The wait time in minutes before the system will be rebooted.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kernelpkg.mod_watch(name, sfun, **kwargs)
Execute a kernelpkg state based on a watch or listen call
.UNINDENT
.SS salt.states.keyboard
.SS Management of keyboard layouts
.sp
The keyboard layout can be managed for the system:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
us:
  keyboard.system
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or it can be managed for XOrg:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
us:
  keyboard.xorg
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keyboard.system(name)
Set the keyboard layout for the system
.INDENT 7.0
.TP
.B name
The keyboard layout to use
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keyboard.xorg(name)
Set the keyboard layout for XOrg
.INDENT 7.0
.TP
.B layout
The keyboard layout to use
.UNINDENT
.UNINDENT
.SS salt.states.keystone
.SS Management of Keystone users
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
keystoneclient Python module
.UNINDENT
.TP
.B configuration
See \fI\%salt.modules.keystone\fP for setup instructions.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Keystone tenants:
  keystone.tenant_present:
    \- names:
      \- admin
      \- demo
      \- service

Keystone roles:
  keystone.role_present:
    \- names:
      \- admin
      \- Member

admin:
  keystone.user_present:
    \- password: R00T_4CC3SS
    \- email: admin@domain.com
    \- roles:
        admin:   # tenants
          \- admin  # roles
        service:
          \- admin
          \- Member
    \- require:
      \- keystone: Keystone tenants
      \- keystone: Keystone roles

nova:
  keystone.user_present:
    \- password: \(aq$up3rn0v4\(aq
    \- email: nova@domain.com
    \- tenant: service
    \- roles:
        service:
          \- admin
    \- require:
      \- keystone: Keystone tenants
      \- keystone: Keystone roles

demo:
  keystone.user_present:
    \- password: \(aqd3m0n$trati0n\(aq
    \- email: demo@domain.com
    \- tenant: demo
    \- roles:
        demo:
          \- Member
    \- require:
      \- keystone: Keystone tenants
      \- keystone: Keystone roles

nova service:
  keystone.service_present:
    \- name: nova
    \- service_type: compute
    \- description: OpenStack Compute Service
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone.endpoint_absent(name, region=None, profile=None, interface=None, **connection_args)
Ensure that the endpoint for a service doesn\(aqt exist in Keystone catalog
.INDENT 7.0
.TP
.B name
The name of the service whose endpoints should not exist
.TP
.B region (optional)
The region of the endpoint.  Defaults to \fBRegionOne\fP\&.
.TP
.B interface
The interface type, which describes the visibility
of the endpoint. (for V3 API)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone.endpoint_present(name, publicurl=None, internalurl=None, adminurl=None, region=None, profile=None, url=None, interface=None, **connection_args)
Ensure the specified endpoints exists for service
.INDENT 7.0
.TP
.B name
The Service name
.TP
.B publicurl
The public url of service endpoint (for V2 API)
.TP
.B internalurl
The internal url of service endpoint (for V2 API)
.TP
.B adminurl
The admin url of the service endpoint (for V2 API)
.TP
.B region
The region of the endpoint
.TP
.B url
The endpoint URL (for V3 API)
.TP
.B interface
The interface type, which describes the visibility
of the endpoint. (for V3 API)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone.project_absent(name, profile=None, **connection_args)
Ensure that the keystone project is absent.
Alias for tenant_absent from V2 API to fulfill
V3 API naming convention.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B name
The name of the project that should not exist
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
delete_nova:
    keystone.project_absent:
        \- name: nova
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone.project_present(name, description=None, enabled=True, profile=None, **connection_args)
Ensures that the keystone project exists
Alias for tenant_present from V2 API to fulfill
V3 API naming convention.
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B name
The name of the project to manage
.TP
.B description
The description to use for this project
.TP
.B enabled
Availability state for this project
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
nova:
    keystone.project_present:
        \- enabled: True
        \- description: \(aqNova Compute Service\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone.role_absent(name, profile=None, **connection_args)
Ensure that the keystone role is absent.
.INDENT 7.0
.TP
.B name
The name of the role that should not exist
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone.role_present(name, profile=None, **connection_args)
\(aq
Ensures that the keystone role exists
.INDENT 7.0
.TP
.B name
The name of the role that should be present
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone.service_absent(name, profile=None, **connection_args)
Ensure that the service doesn\(aqt exist in Keystone catalog
.INDENT 7.0
.TP
.B name
The name of the service that should not exist
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone.service_present(name, service_type, description=None, profile=None, **connection_args)
Ensure service present in Keystone catalog
.INDENT 7.0
.TP
.B name
The name of the service
.TP
.B service_type
The type of Openstack Service
.TP
.B description (optional)
Description of the service
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone.tenant_absent(name, profile=None, **connection_args)
Ensure that the keystone tenant is absent.
.INDENT 7.0
.TP
.B name
The name of the tenant that should not exist
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone.tenant_present(name, description=None, enabled=True, profile=None, **connection_args)
Ensures that the keystone tenant exists
.INDENT 7.0
.TP
.B name
The name of the tenant to manage
.TP
.B description
The description to use for this tenant
.TP
.B enabled
Availability state for this tenant
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone.user_absent(name, profile=None, **connection_args)
Ensure that the keystone user is absent.
.INDENT 7.0
.TP
.B name
The name of the user that should not exist
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone.user_present(name, password, email, tenant=None, enabled=True, roles=None, profile=None, password_reset=True, project=None, **connection_args)
Ensure that the keystone user is present with the specified properties.
.INDENT 7.0
.TP
.B name
The name of the user to manage
.TP
.B password
The password to use for this user.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the user already exists and a different password was set for
the user than the one specified here, the password for the user
will be updated. Please set the \fBpassword_reset\fP option to
\fBFalse\fP if this is not the desired behavior.
.UNINDENT
.UNINDENT
.TP
.B password_reset
Whether or not to reset password after initial set. Defaults to
\fBTrue\fP\&.
.TP
.B email
The email address for this user
.TP
.B tenant
The tenant (name) for this user
.TP
.B project
The project (name) for this user (overrides tenant in api v3)
.TP
.B enabled
Availability state for this user
.TP
.B roles
The roles the user should have under given tenants.
Passed as a dictionary mapping tenant names to a list
of roles in this tenant, i.e.:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
roles:
    admin:   # tenant
      \- admin  # role
    service:
      \- admin
      \- Member
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.keystone_domain
.SS Management of OpenStack Keystone Domains
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
shade
.TP
.B configuration
see \fI\%salt.modules.keystoneng\fP for setup instructions
.UNINDENT
.sp
Example States
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create domain:
  keystone_domain.present:
    \- name: domain1

create domain with optional params:
  keystone_domain.present:
    \- name: domain1
    \- enabled: False
    \- description: \(aqmy domain\(aq

delete domain:
  keystone_domain.absent:
    \- name: domain1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_domain.absent(name, auth=None)
Ensure domain does not exist
.INDENT 7.0
.TP
.B name
Name of the domain
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_domain.present(name, auth=None, **kwargs)
Ensure domain exists and is up\-to\-date
.INDENT 7.0
.TP
.B name
Name of the domain
.TP
.B enabled
Boolean to control if domain is enabled
.TP
.B description
An arbitrary description of the domain
.UNINDENT
.UNINDENT
.SS salt.states.keystone_endpoint
.SS Management of OpenStack Keystone Endpoints
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
shade
.TP
.B configuration
see \fI\%salt.modules.keystoneng\fP for setup instructions
.UNINDENT
.sp
Example States
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create endpoint:
  keystone_endpoint.present:
    \- name: public
    \- url: https://example.org:9292
    \- region: RegionOne
    \- service_name: glance

destroy endpoint:
  keystone_endpoint.absent:
    \- name: public
    \- url: https://example.org:9292
    \- region: RegionOne
    \- service_name: glance

create multiple endpoints:
  keystone_endpoint.absent:
    \- names:
        \- public
        \- admin
        \- internal
    \- url: https://example.org:9292
    \- region: RegionOne
    \- service_name: glance
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_endpoint.absent(name, service_name, auth=None, **kwargs)
Ensure an endpoint does not exists
.INDENT 7.0
.TP
.B name
Interface name
.TP
.B url
URL of the endpoint
.TP
.B service_name
Service name or ID
.TP
.B region
The region name to assign the endpoint
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_endpoint.present(name, service_name, auth=None, **kwargs)
Ensure an endpoint exists and is up\-to\-date
.INDENT 7.0
.TP
.B name
Interface name
.TP
.B url
URL of the endpoint
.TP
.B service_name
Service name or ID
.TP
.B region
The region name to assign the endpoint
.TP
.B enabled
Boolean to control if endpoint is enabled
.UNINDENT
.UNINDENT
.SS salt.states.keystone_group
.SS Management of OpenStack Keystone Groups
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
shade
.TP
.B configuration
see \fI\%salt.modules.keystoneng\fP for setup instructions
.UNINDENT
.sp
Example States
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create group:
  keystone_group.present:
    \- name: group1

delete group:
  keystone_group.absent:
    \- name: group1

create group with optional params:
  keystone_group.present:
    \- name: group1
    \- domain: domain1
    \- description: \(aqmy group\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_group.absent(name, auth=None, **kwargs)
Ensure group does not exist
.INDENT 7.0
.TP
.B name
Name of the group
.TP
.B domain
The name or id of the domain
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_group.present(name, auth=None, **kwargs)
Ensure an group exists and is up\-to\-date
.INDENT 7.0
.TP
.B name
Name of the group
.TP
.B domain
The name or id of the domain
.TP
.B description
An arbitrary description of the group
.UNINDENT
.UNINDENT
.SS salt.states.keystone_project
.SS Management of OpenStack Keystone Projects
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
shade
.TP
.B configuration
see \fI\%salt.modules.keystoneng\fP for setup instructions
.UNINDENT
.sp
Example States
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create project:
  keystone_project.present:
    \- name: project1

delete project:
  keystone_project.absent:
    \- name: project1

create project with optional params:
  keystone_project.present:
    \- name: project1
    \- domain: domain1
    \- enabled: False
    \- description: \(aqmy project\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_project.absent(name, auth=None, **kwargs)
Ensure a project does not exists
.INDENT 7.0
.TP
.B name
Name of the project
.TP
.B domain
The name or id of the domain
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_project.present(name, auth=None, **kwargs)
Ensure a project exists and is up\-to\-date
.INDENT 7.0
.TP
.B name
Name of the project
.TP
.B domain
The name or id of the domain
.TP
.B description
An arbitrary description of the project
.UNINDENT
.UNINDENT
.SS salt.states.keystone_role
.SS Management of OpenStack Keystone Roles
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
shade
.TP
.B configuration
see \fI\%salt.modules.keystoneng\fP for setup instructions
.UNINDENT
.sp
Example States
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create role:
  keystone_role.present:
    \- name: role1

delete role:
  keystone_role.absent:
    \- name: role1

create role with optional params:
  keystone_role.present:
    \- name: role1
    \- description: \(aqmy group\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_role.absent(name, auth=None, **kwargs)
Ensure role does not exist
.INDENT 7.0
.TP
.B name
Name of the role
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_role.present(name, auth=None, **kwargs)
Ensure an role exists
.INDENT 7.0
.TP
.B name
Name of the role
.TP
.B description
An arbitrary description of the role
.UNINDENT
.UNINDENT
.SS salt.states.keystone_role_grant
.SS Management of OpenStack Keystone Role Grants
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
shade
.TP
.B configuration
see \fI\%salt.modules.keystoneng\fP for setup instructions
.UNINDENT
.sp
Example States
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create group:
  keystone_group.present:
    \- name: group1

delete group:
  keystone_group.absent:
    \- name: group1

create group with optional params:
  keystone_group.present:
    \- name: group1
    \- domain: domain1
    \- description: \(aqmy group\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_role_grant.absent(name, auth=None, **kwargs)
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_role_grant.present(name, auth=None, **kwargs)
.UNINDENT
.SS salt.states.keystone_service
.SS Management of OpenStack Keystone Services
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
shade
.TP
.B configuration
see \fI\%salt.modules.keystoneng\fP for setup instructions
.UNINDENT
.sp
Example States
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create service:
  keystone_service.present:
    \- name: glance
    \- type: image

delete service:
  keystone_service.absent:
    \- name: glance

create service with optional params:
  keystone_service.present:
    \- name: glance
    \- type: image
    \- enabled: False
    \- description: \(aqOpenStack Image\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_service.absent(name, auth=None)
Ensure service does not exist
.INDENT 7.0
.TP
.B name
Name of the service
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_service.present(name, auth=None, **kwargs)
Ensure an service exists and is up\-to\-date
.INDENT 7.0
.TP
.B name
Name of the group
.TP
.B type
Service type
.TP
.B enabled
Boolean to control if service is enabled
.TP
.B description
An arbitrary description of the service
.UNINDENT
.UNINDENT
.SS salt.states.keystone_user
.SS Management of OpenStack Keystone Users
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
shade
.TP
.B configuration
see \fI\%salt.modules.keystoneng\fP for setup instructions
.UNINDENT
.sp
Example States
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create user:
  keystone_user.present:
    \- name: user1

delete user:
  keystone_user.absent:
    \- name: user1

create user with optional params:
  keystone_user.present:
    \- name: user1
    \- domain: domain1
    \- enabled: False
    \- password: password123
    \- email: \(dquser1@example.org\(dq
    \- description: \(aqmy user\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_user.absent(name, auth=None, **kwargs)
Ensure user does not exists
.INDENT 7.0
.TP
.B name
Name of the user
.TP
.B domain
The name or id of the domain
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.keystone_user.present(name, auth=None, **kwargs)
Ensure domain exists and is up\-to\-date
.INDENT 7.0
.TP
.B name
Name of the domain
.TP
.B domain
The name or id of the domain
.TP
.B enabled
Boolean to control if domain is enabled
.TP
.B description
An arbitrary description of the domain
.TP
.B password
The user password
.TP
.B email
The users email address
.UNINDENT
.UNINDENT
.SS salt.states.keystore
.sp
State management of a java keystore
.INDENT 0.0
.TP
.B salt.states.keystore.managed(name, passphrase, entries, force_remove=False)
Create or manage a java keystore.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The path to the keystore file
.IP \(bu 2
\fBpassphrase\fP \-\- The password to the keystore
.IP \(bu 2
\fBentries\fP \-\-
.sp
A list containing an alias, certificate, and optional private_key.
The certificate and private_key can be a file or a string
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- entries:
  \- alias: hostname2
    certificate: /path/to/cert.crt
    private_key: /path/to/key.key
  \- alias: stringhost
    certificate: |
      \-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-
      MIICEjCCAXsCAg36MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG
      2VguKv4SWjRFoRkIfIlHX0qVviMhSlNy2ioFLy7JcPZb+v3ftDGywUqcBiVDoea0
      \-\-\-\-\-END CERTIFICATE\-\-\-\-\-
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBforce_remove\fP \-\-
.sp
If True will cause the state to remove any entries found in the keystore
which are not defined in the state. The default is False.  Example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
define_keystore:
  keystore.managed:
    \- name: /path/to/keystore
    \- passphrase: changeit
    \- force_remove: True
    \- entries:
      \- alias: hostname1
        certificate: /path/to/cert.crt
      \- alias: remotehost
        certificate: /path/to/cert2.crt
        private_key: /path/to/key2.key
      \- alias: pillarhost
        certificate: {{ salt.pillar.get(\(aqpath:to:cert\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.kmod
.SS Loading and unloading of kernel modules
.sp
The Kernel modules on a system can be managed cleanly with the kmod state
module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
add_kvm:
  kmod.present:
    \- name: kvm_amd
remove_beep:
  kmod.absent:
    \- name: pcspkr
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple modules can be specified for both kmod.present and kmod.absent.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
add_sound:
  kmod.present:
    \- mods:
      \- snd_hda_codec_hdmi
      \- snd_hda_codec
      \- snd_hwdep
      \- snd_hda_core
      \- snd_pcm
      \- snd_timer
      \- snd
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kmod.absent(name, persist=False, comment=True, mods=None)
Verify that the named kernel module is not loaded
.INDENT 7.0
.TP
.B name
The name of the kernel module to verify is not loaded
.TP
.B persist
Remove module from \fB/etc/modules\fP (or
\fB/etc/modules\-load.d/salt_managed.conf\fP if the \fBsystemd\fP key is
present in Grains.
.TP
.B comment
Comment out module in \fB/etc/modules\fP rather than remove it
.TP
.B mods
A list of modules to verify are unloaded.  If this argument is used,
the \fBname\fP argument, although still required, is not used, and
becomes a placeholder
.sp
New in version 2016.3.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kmod.present(name, persist=False, mods=None)
Ensure that the specified kernel module is loaded
.INDENT 7.0
.TP
.B name
The name of the kernel module to verify is loaded
.TP
.B persist
Also add module to \fB/etc/modules\fP (or
\fB/etc/modules\-load.d/salt_managed.conf\fP if the \fBsystemd\fP key is
present in Grains.
.TP
.B mods
A list of modules to verify are loaded.  If this argument is used, the
\fBname\fP argument, although still required, is not used, and becomes a
placeholder
.sp
New in version 2016.3.0.

.UNINDENT
.UNINDENT
.SS salt.states.kubernetes
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%kubernetes Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.SS Manage kubernetes resources as salt states
.sp
NOTE: This module requires the proper pillar values set. See
salt.modules.kubernetesmod for more information.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Configuration options will change in 2019.2.0.
.UNINDENT
.UNINDENT
.sp
The kubernetes module is used to manage different kubernetes resources.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-nginx:
  kubernetes.deployment_present:
    \- namespace: default
      metadata:
        app: frontend
      spec:
        replicas: 1
        template:
          metadata:
            labels:
              run: my\-nginx
          spec:
            containers:
            \- name: my\-nginx
              image: nginx
              ports:
              \- containerPort: 80

my\-mariadb:
  kubernetes.deployment_absent:
    \- namespace: default

# kubernetes deployment as specified inside of
# a file containing the definition of the the
# deployment using the official kubernetes format
redis\-master\-deployment:
  kubernetes.deployment_present:
    \- name: redis\-master
    \- source: salt://k8s/redis\-master\-deployment.yml
  require:
    \- pip: kubernetes\-python\-module

# kubernetes service as specified inside of
# a file containing the definition of the the
# service using the official kubernetes format
redis\-master\-service:
  kubernetes.service_present:
    \- name: redis\-master
    \- source: salt://k8s/redis\-master\-service.yml
  require:
    \- kubernetes.deployment_present: redis\-master

# kubernetes deployment as specified inside of
# a file containing the definition of the the
# deployment using the official kubernetes format
# plus some jinja directives
 nginx\-source\-template:
  kubernetes.deployment_present:
    \- source: salt://k8s/nginx.yml.jinja
    \- template: jinja
  require:
    \- pip: kubernetes\-python\-module


# Kubernetes secret
k8s\-secret:
  kubernetes.secret_present:
    \- name: top\-secret
      data:
        key1: value1
        key2: value2
        key3: value3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.states.kubernetes.configmap_absent(name, namespace=\(aqdefault\(aq, **kwargs)
Ensures that the named configmap is absent from the given namespace.
.INDENT 7.0
.TP
.B name
The name of the configmap
.TP
.B namespace
The namespace holding the configmap. The \(aqdefault\(aq one is going to be
used unless a different one is specified.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kubernetes.configmap_present(name, namespace=\(aqdefault\(aq, data=None, source=None, template=None, **kwargs)
Ensures that the named configmap is present inside of the specified namespace
with the given data.
If the configmap exists it will be replaced.
.INDENT 7.0
.TP
.B name
The name of the configmap.
.TP
.B namespace
The namespace holding the configmap. The \(aqdefault\(aq one is going to be
used unless a different one is specified.
.TP
.B data
The dictionary holding the configmaps.
.TP
.B source
A file containing the data of the configmap in plain format.
.TP
.B template
Template engine to be used to render the source file.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kubernetes.deployment_absent(name, namespace=\(aqdefault\(aq, **kwargs)
Ensures that the named deployment is absent from the given namespace.
.INDENT 7.0
.TP
.B name
The name of the deployment
.TP
.B namespace
The name of the namespace
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kubernetes.deployment_present(name, namespace=\(aqdefault\(aq, metadata=None, spec=None, source=\(aq\(aq, template=\(aq\(aq, **kwargs)
Ensures that the named deployment is present inside of the specified
namespace with the given metadata and spec.
If the deployment exists it will be replaced.
.INDENT 7.0
.TP
.B name
The name of the deployment.
.TP
.B namespace
The namespace holding the deployment. The \(aqdefault\(aq one is going to be
used unless a different one is specified.
.TP
.B metadata
The metadata of the deployment object.
.TP
.B spec
The spec of the deployment object.
.TP
.B source
A file containing the definition of the deployment (metadata and
spec) in the official kubernetes format.
.TP
.B template
Template engine to be used to render the source file.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kubernetes.namespace_absent(name, **kwargs)
Ensures that the named namespace is absent.
.INDENT 7.0
.TP
.B name
The name of the namespace
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kubernetes.namespace_present(name, **kwargs)
Ensures that the named namespace is present.
.INDENT 7.0
.TP
.B name
The name of the namespace.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kubernetes.node_label_absent(name, node, **kwargs)
Ensures that the named label is absent from the node.
.INDENT 7.0
.TP
.B name
The name of the label
.TP
.B node
The name of the node
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kubernetes.node_label_folder_absent(name, node, **kwargs)
Ensures the label folder doesn\(aqt exist on the specified node.
.INDENT 7.0
.TP
.B name
The name of label folder
.TP
.B node
The name of the node
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kubernetes.node_label_present(name, node, value, **kwargs)
Ensures that the named label is set on the named node
with the given value.
If the label exists it will be replaced.
.INDENT 7.0
.TP
.B name
The name of the label.
.TP
.B value
Value of the label.
.TP
.B node
Node to change.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kubernetes.pod_absent(name, namespace=\(aqdefault\(aq, **kwargs)
Ensures that the named pod is absent from the given namespace.
.INDENT 7.0
.TP
.B name
The name of the pod
.TP
.B namespace
The name of the namespace
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kubernetes.pod_present(name, namespace=\(aqdefault\(aq, metadata=None, spec=None, source=\(aq\(aq, template=\(aq\(aq, **kwargs)
Ensures that the named pod is present inside of the specified
namespace with the given metadata and spec.
If the pod exists it will be replaced.
.INDENT 7.0
.TP
.B name
The name of the pod.
.TP
.B namespace
The namespace holding the pod. The \(aqdefault\(aq one is going to be
used unless a different one is specified.
.TP
.B metadata
The metadata of the pod object.
.TP
.B spec
The spec of the pod object.
.TP
.B source
A file containing the definition of the pod (metadata and
spec) in the official kubernetes format.
.TP
.B template
Template engine to be used to render the source file.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kubernetes.secret_absent(name, namespace=\(aqdefault\(aq, **kwargs)
Ensures that the named secret is absent from the given namespace.
.INDENT 7.0
.TP
.B name
The name of the secret
.TP
.B namespace
The name of the namespace
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kubernetes.secret_present(name, namespace=\(aqdefault\(aq, data=None, source=None, template=None, **kwargs)
Ensures that the named secret is present inside of the specified namespace
with the given data.
If the secret exists it will be replaced.
.INDENT 7.0
.TP
.B name
The name of the secret.
.TP
.B namespace
The namespace holding the secret. The \(aqdefault\(aq one is going to be
used unless a different one is specified.
.TP
.B data
The dictionary holding the secrets.
.TP
.B source
A file containing the data of the secret in plain format.
.TP
.B template
Template engine to be used to render the source file.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kubernetes.service_absent(name, namespace=\(aqdefault\(aq, **kwargs)
Ensures that the named service is absent from the given namespace.
.INDENT 7.0
.TP
.B name
The name of the service
.TP
.B namespace
The name of the namespace
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.kubernetes.service_present(name, namespace=\(aqdefault\(aq, metadata=None, spec=None, source=\(aq\(aq, template=\(aq\(aq, **kwargs)
Ensures that the named service is present inside of the specified namespace
with the given metadata and spec.
If the deployment exists it will be replaced.
.INDENT 7.0
.TP
.B name
The name of the service.
.TP
.B namespace
The namespace holding the service. The \(aqdefault\(aq one is going to be
used unless a different one is specified.
.TP
.B metadata
The metadata of the service object.
.TP
.B spec
The spec of the service object.
.TP
.B source
A file containing the definition of the service (metadata and
spec) in the official kubernetes format.
.TP
.B template
Template engine to be used to render the source file.
.UNINDENT
.UNINDENT
.SS salt.states.layman
.SS Management of Gentoo Overlays using layman
.sp
A state module to manage Gentoo package overlays via layman
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sunrise:
    layman.present
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.layman.absent(name)
Verify that the overlay is absent
.INDENT 7.0
.TP
.B name
The name of the overlay to delete
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.layman.present(name)
Verify that the overlay is present
.INDENT 7.0
.TP
.B name
The name of the overlay to add
.UNINDENT
.UNINDENT
.SS salt.states.ldap
.SS Manage entries in an LDAP database
.sp
New in version 2016.3.0.

.sp
The \fBstates.ldap\fP state module allows you to manage LDAP entries and
their attributes.
.INDENT 0.0
.TP
.B salt.states.ldap.managed(name, entries, connect_spec=None)
Ensure the existence (or not) of LDAP entries and their attributes
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ldapi:///:
  ldap.managed:
    \- connect_spec:
        bind:
          method: sasl

    \- entries:

      # make sure the entry doesn\(aqt exist
      \- cn=foo,ou=users,dc=example,dc=com:
        \- delete_others: True

      # make sure the entry exists with only the specified
      # attribute values
      \- cn=admin,dc=example,dc=com:
        \- delete_others: True
        \- replace:
            cn:
              \- admin
            description:
              \- LDAP administrator
            objectClass:
              \- simpleSecurityObject
              \- organizationalRole
            userPassword:
              \- {{pillar.ldap_admin_password}}

      # make sure the entry exists, its olcRootDN attribute
      # has only the specified value, the olcRootDN attribute
      # doesn\(aqt exist, and all other attributes are ignored
      \- \(aqolcDatabase={1}hdb,cn=config\(aq:
        \- replace:
            olcRootDN:
              \- cn=admin,dc=example,dc=com
            # the admin entry has its own password attribute
            olcRootPW: []

      # note the use of \(aqdefault\(aq.  also note how you don\(aqt
      # have to use list syntax if there is only one attribute
      # value
      \- cn=foo,ou=users,dc=example,dc=com:
        \- delete_others: True
        \- default:
            userPassword: changeme
            shadowLastChange: 0
            # keep sshPublicKey if present, but don\(aqt create
            # the attribute if it is missing
            sshPublicKey: []
        \- replace:
            cn: foo
            uid: foo
            uidNumber: 1000
            gidNumber: 1000
            gecos: Foo Bar
            givenName: Foo
            sn: Bar
            homeDirectory: /home/foo
            loginShell: /bin/bash
            objectClass:
              \- inetOrgPerson
              \- posixAccount
              \- top
              \- ldapPublicKey
              \- shadowAccount
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The URL of the LDAP server.  This is ignored if
\fBconnect_spec\fP is either a connection object or a dict with
a \fB\(aqurl\(aq\fP entry.
.IP \(bu 2
\fBentries\fP \-\-
.sp
A description of the desired state of zero or more LDAP
entries.
.sp
\fBentries\fP is an iterable of dicts.  Each of these dict\(aqs
keys are the distinguished names (DNs) of LDAP entries to
manage.  Each of these dicts is processed in order.  A later
dict can reference an LDAP entry that was already mentioned in
an earlier dict, which makes it possible for later dicts to
enhance or alter the desired state of an LDAP entry.
.sp
The DNs are mapped to a description of the LDAP entry\(aqs
desired state.  These LDAP entry descriptions are themselves
iterables of dicts.  Each dict in the iterable is processed in
order.  They contain directives controlling the entry\(aqs state.
The key names the directive type and the value is state
information for the directive.  The specific structure of the
state information depends on the directive type.
.sp
The structure of \fBentries\fP looks like this:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
[{dn1: [{directive1: directive1_state,
         directive2: directive2_state},
        {directive3: directive3_state}],
  dn2: [{directive4: directive4_state,
         directive5: directive5_state}]},
 {dn3: [{directive6: directive6_state}]}]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
These are the directives:
.INDENT 2.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqdelete_others\(aq\fP
Boolean indicating whether to delete attributes not
mentioned in this dict or any of the other directive
dicts for this DN.  Defaults to \fBFalse\fP\&.
.sp
If you don\(aqt want to delete an attribute if present, but
you also don\(aqt want to add it if it is missing or modify
it if it is present, you can use either the \fB\(aqdefault\(aq\fP
directive or the \fB\(aqadd\(aq\fP directive with an empty value
list.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqdefault\(aq\fP
A dict mapping an attribute name to an iterable of default
values for that attribute.  If the attribute already
exists, it is left alone.  If not, it is created using the
given list of values.
.sp
An empty value list is useful when you don\(aqt want to
create an attribute if it is missing but you do want to
preserve it if the \fB\(aqdelete_others\(aq\fP key is \fBTrue\fP\&.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqadd\(aq\fP
Attribute values to add to the entry.  This is a dict
mapping an attribute name to an iterable of values to add.
.sp
An empty value list is useful when you don\(aqt want to
create an attribute if it is missing but you do want to
preserve it if the \fB\(aqdelete_others\(aq\fP key is \fBTrue\fP\&.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqdelete\(aq\fP
Attribute values to remove from the entry.  This is a dict
mapping an attribute name to an iterable of values to
delete from the attribute.  If the iterable is empty, all
of the attribute\(aqs values are deleted.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqreplace\(aq\fP
Attributes to replace.  This is a dict mapping an
attribute name to an iterable of values.  Any existing
values for the attribute are deleted, then the given
values are added.  The iterable may be empty.
.UNINDENT
.UNINDENT
.sp
In the above directives, the iterables of attribute values may
instead be \fBNone\fP, in which case an empty list is used, or a
scalar such as a string or number, in which case a new list
containing the scalar is used.
.sp
Note that if all attribute values are removed from an entry,
the entire entry is deleted.

.IP \(bu 2
\fBconnect_spec\fP \-\- See the description of the \fBconnect_spec\fP parameter of the
\fI\%ldap3.connect\fP function
in the \fI\%ldap3\fP execution module.
If this is a dict and the \fB\(aqurl\(aq\fP entry is not specified,
the \fB\(aqurl\(aq\fP entry is set to the value of the \fBname\fP
parameter.
.UNINDENT
.TP
.B Returns
A dict with the following keys:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqname\(aq\fP
This is the same object passed to the \fBname\fP parameter.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqchanges\(aq\fP
This is a dict describing the changes made (or, in test
mode, the changes that would have been attempted).  If no
changes were made (or no changes would have been
attempted), then this dict is empty.  Only successful
changes are included.
.sp
Each key is a DN of an entry that was changed (or would
have been changed).  Entries that were not changed (or
would not have been changed) are not included.  The value
is a dict with two keys:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqold\(aq\fP
The state of the entry before modification.  If the
entry did not previously exist, this key maps to
\fBNone\fP\&.  Otherwise, the value is a dict mapping each
of the old entry\(aqs attributes to a list of its values
before any modifications were made.  Unchanged
attributes are excluded from this dict.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqnew\(aq\fP
The state of the entry after modification.  If the
entry was deleted, this key maps to \fBNone\fP\&.
Otherwise, the value is a dict mapping each of the
entry\(aqs attributes to a list of its values after the
modifications were made.  Unchanged attributes are
excluded from this dict.
.UNINDENT
.UNINDENT
.sp
Example \fB\(aqchanges\(aq\fP dict where a new entry was created
with a single attribute containing two values:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqdn1\(aq: {\(aqold\(aq: None,
         \(aqnew\(aq: {\(aqattr1\(aq: [\(aqval1\(aq, \(aqval2\(aq]}}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example \fB\(aqchanges\(aq\fP dict where a new attribute was added
to an existing entry:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqdn1\(aq: {\(aqold\(aq: {},
         \(aqnew\(aq: {\(aqattr2\(aq: [\(aqval3\(aq]}}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B \fB\(aqresult\(aq\fP
One of the following values:
.INDENT 7.0
.IP \(bu 2
\fBTrue\fP if no changes were necessary or if all changes
were applied successfully.
.IP \(bu 2
\fBFalse\fP if at least one change was unable to be applied.
.IP \(bu 2
\fBNone\fP if changes would be applied but it is in test
mode.
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.SS salt.states.libcloud_dns
.sp
Manage DNS records and zones using libcloud
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B codeauthor
Anthony Shaw <\fI\%anthonyshaw@apache.org\fP>
.UNINDENT
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.sp
Create and delete DNS records or zones through Libcloud. Libcloud\(aqs DNS system supports over 20 DNS
providers including Amazon, Google, GoDaddy, Softlayer
.sp
This module uses \fBlibcloud\fP, which can be installed via package, or pip.
.INDENT 0.0
.TP
.B configuration
This module uses a configuration profile for one or multiple DNS providers
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
libcloud_dns:
  profile1:
    driver: godaddy
    key: 2orgk34kgk34g
  profile2:
    driver: route53
    key: blah
    secret: blah
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-zone:
  libcloud_dns.zone_present:
    \- name: mywebsite.com
    \- profile: profile1
my\-website:
  libcloud_dns.record_present:
    \- name: www
    \- zone: mywebsite.com
    \- type: A
    \- data: 12.34.32.3
    \- profile: profile1
    \- require:
      \- libcloud_dns: my\-zone
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
apache\-libcloud
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_dns.record_absent(name, zone, type, data, profile)
Ensures a record is absent.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Record name without the domain name (e.g. www).
Note: If you want to create a record for a base domain
name, you should specify empty string (\(aq\(aq) for this
argument.
.IP \(bu 2
\fBzone\fP (\fBstr\fP) \-\- Zone where the requested record is created, the domain name
.IP \(bu 2
\fBtype\fP (\fBstr\fP) \-\- DNS record type (A, AAAA, ...).
.IP \(bu 2
\fBdata\fP (\fBstr\fP) \-\- Data for the record (depends on the record type).
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_dns.record_present(name, zone, type, data, profile)
Ensures a record is present.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Record name without the domain name (e.g. www).
Note: If you want to create a record for a base domain
name, you should specify empty string (\(aq\(aq) for this
argument.
.IP \(bu 2
\fBzone\fP (\fBstr\fP) \-\- Zone where the requested record is created, the domain name
.IP \(bu 2
\fBtype\fP (\fBstr\fP) \-\- DNS record type (A, AAAA, ...).
.IP \(bu 2
\fBdata\fP (\fBstr\fP) \-\- Data for the record (depends on the record type).
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_dns.state_result(result, message, name, changes=None)
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_dns.zone_absent(domain, profile)
Ensures a record is absent.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdomain\fP (\fBstr\fP) \-\- Zone name, i.e. the domain name
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_dns.zone_present(domain, type, profile)
Ensures a record is present.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdomain\fP (\fBstr\fP) \-\- Zone name, i.e. the domain name
.IP \(bu 2
\fBtype\fP (\fBstr\fP) \-\- Zone type (master / slave), defaults to master
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.libcloud_loadbalancer
.SS Apache Libcloud Load Balancer State
.sp
Manage load balancers using libcloud
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B codeauthor
\fBAnthony Shaw <anthonyshaw@apache.org>\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Apache Libcloud load balancer management for a full list
of supported clouds, see \fI\%http://libcloud.readthedocs.io/en/latest/loadbalancer/supported_providers.html\fP
.sp
Clouds include Amazon ELB, ALB, Google, Aliyun, CloudStack, Softlayer
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B configuration
This module uses a configuration profile for one or multiple Cloud providers
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
libcloud_loadbalancer:
    profile_test1:
      driver: gce
      key: GOOG0123456789ABCXYZ
      secret: mysecret
    profile_test2:
      driver: alb
      key: 12345
      secret: mysecret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Example:
.sp
Using States to deploy a load balancer with extended arguments to specify region
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lb_test:
    libcloud_loadbalancer.balancer_present:
        \- name: example
        \- port: 80
        \- protocol: http
        \- profile: google
        \- ex_region: us\-east1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
apache\-libcloud
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_loadbalancer.balancer_absent(name, profile, **libcloud_kwargs)
Ensures a load balancer is absent.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Load Balancer name
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_loadbalancer.balancer_present(name, port, protocol, profile, algorithm=None, members=None, **libcloud_kwargs)
Ensures a load balancer is present.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Load Balancer name
.IP \(bu 2
\fBport\fP (\fBstr\fP) \-\- Port the load balancer should listen on, defaults to 80
.IP \(bu 2
\fBprotocol\fP (\fBstr\fP) \-\- Loadbalancer protocol, defaults to http.
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBalgorithm\fP (\fBstr\fP) \-\- Load balancing algorithm, defaults to ROUND_ROBIN. See Algorithm type
in Libcloud documentation for a full listing.
.IP \(bu 2
\fBmembers\fP (\fBlist\fP of \fBdict\fP (ip, port)) \-\- An optional list of members to create on deployment
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_loadbalancer.member_absent(ip, port, balancer_id, profile, **libcloud_kwargs)
Ensure a load balancer member is absent, based on IP and Port
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBip\fP (\fBstr\fP) \-\- IP address for the member
.IP \(bu 2
\fBport\fP (\fBint\fP) \-\- Port for the member
.IP \(bu 2
\fBbalancer_id\fP (\fBstr\fP) \-\- id of a load balancer you want to detach the member from
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_loadbalancer.member_present(ip, port, balancer_id, profile, **libcloud_kwargs)
Ensure a load balancer member is present
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBip\fP (\fBstr\fP) \-\- IP address for the new member
.IP \(bu 2
\fBport\fP (\fBint\fP) \-\- Port for the new member
.IP \(bu 2
\fBbalancer_id\fP (\fBstr\fP) \-\- id of a load balancer you want to attach the member to
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_loadbalancer.state_result(result, message, name, changes=None)
.UNINDENT
.SS salt.states.libcloud_storage
.SS Apache Libcloud Storage State
.sp
Manage cloud storage using libcloud
.INDENT 0.0
.TP
.B codeauthor
\fBAnthony Shaw <anthonyshaw@apache.org>\fP
.UNINDENT
.sp
Apache Libcloud Storage (object/blob) management for a full list
of supported clouds, see \fI\%http://libcloud.readthedocs.io/en/latest/storage/supported_providers.html\fP
.sp
Clouds include Amazon S3, Google Storage, Aliyun, Azure Blobs, Ceph, OpenStack swift
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B configuration
This module uses a configuration profile for one or multiple Storage providers
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
libcloud_storage:
    profile_test1:
      driver: google_storage
      key: GOOG0123456789ABCXYZ
      secret: mysecret
    profile_test2:
      driver: s3
      key: 12345
      secret: mysecret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Examples
.SS Creating a container and uploading a file
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
web_things:
  libcloud_storage.container_present:
    name: my_container_name
    profile: profile1
  libcloud_storage.object_present:
    name: my_file.jpg
    container: my_container_name
    path: /path/to/local/file.jpg
    profile: profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Downloading a file
.sp
This example will download the file from the remote cloud and keep it locally
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
web_things:
  libcloud_storage.file_present:
    name: my_file.jpg
    container: my_container_name
    path: /path/to/local/file.jpg
    profile: profile1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
apache\-libcloud
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_storage.container_absent(name, profile)
Ensures a container is absent.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Container name
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_storage.container_present(name, profile)
Ensures a container is present.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Container name
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_storage.file_present(container, name, path, profile, overwrite_existing=False)
Ensures a object is downloaded locally.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontainer\fP (\fBstr\fP) \-\- Container name
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Object name in cloud
.IP \(bu 2
\fBpath\fP (\fBstr\fP) \-\- Local path to file
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.IP \(bu 2
\fBoverwrite_existing\fP (\fBbool\fP) \-\- Replace if already exists
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_storage.object_absent(container, name, profile)
Ensures a object is absent.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontainer\fP (\fBstr\fP) \-\- Container name
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Object name in cloud
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_storage.object_present(container, name, path, profile)
Ensures a object is presnt.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontainer\fP (\fBstr\fP) \-\- Container name
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Object name in cloud
.IP \(bu 2
\fBpath\fP (\fBstr\fP) \-\- Local path to file
.IP \(bu 2
\fBprofile\fP (\fBstr\fP) \-\- The profile key
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.libcloud_storage.state_result(result, message, name, changes)
.UNINDENT
.SS salt.states.linux_acl
.sp
Linux File Access Control Lists
.sp
The Linux ACL state module requires the \fIgetfacl\fP and \fIsetfacl\fP binaries.
.sp
Ensure a Linux ACL is present
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
root:
  acl.present:
    \- name: /root
    \- acl_type: user
    \- acl_name: damian
    \- perms: rwx
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Ensure a Linux ACL is present as a default for all new objects
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
root:
  acl.present:
    \- name: /root
    \- acl_type: \(dqdefault:user\(dq
    \- acl_name: damian
    \- perms: rwx
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Ensure a Linux ACL does not exist
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
root:
  acl.absent:
    \- name: /root
    \- acl_type: user
    \- acl_name: damian
    \- perms: rwx
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Ensure a Linux ACL list is present
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
root:
  acl.list_present:
    \- name: /root
    \- acl_type: user
    \- acl_names:
      \- damian
      \- homer
    \- perms: rwx
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Ensure a Linux ACL list does not exist
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
root:
  acl.list_absent:
    \- name: /root
    \- acl_type: user
    \- acl_names:
      \- damian
      \- homer
    \- perms: rwx
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
The effective permissions of Linux file access control lists (ACLs) are
governed by the \(dqeffective rights mask\(dq (the \fImask\fP line in the output of
the \fIgetfacl\fP command) combined with the \fIperms\fP set by this module: any
permission bits (for example, r=read) present in an ACL but not in the mask
are ignored.  The mask is automatically recomputed when setting an ACL, so
normally this isn\(aqt important.  However, if the file permissions are
changed (with \fIchmod\fP or \fIfile.managed\fP, for example), the mask will
generally be set based on just the group bits of the file permissions.
.sp
As a result, when using \fIfile.managed\fP or similar to control file
permissions as well as this module, you should set your group permissions
to be at least as broad as any permissions in your ACL. Otherwise, the two
state declarations will each register changes each run, and if the \fIfile\fP
declaration runs later, your ACL will be ineffective.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.linux_acl.absent(name, acl_type, acl_name=\(aq\(aq, perms=\(aq\(aq, recurse=False)
Ensure a Linux ACL does not exist
.INDENT 7.0
.TP
.B name
The acl path
.TP
.B acl_type
The type of the acl is used for, it can be \(aquser\(aq or \(aqgroup\(aq
.TP
.B acl_name
The user or group
.TP
.B perms
Remove the permissions eg.: rwx
.TP
.B recurse
Set the permissions recursive in the path
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.linux_acl.list_absent(name, acl_type, acl_names=None, recurse=False)
Ensure a Linux ACL list does not exist
.sp
Takes a list of acl names and remove them from the given path
.INDENT 7.0
.TP
.B name
The acl path
.TP
.B acl_type
The type of the acl is used for, it can be \(aquser\(aq or \(aqgroup\(aq
.TP
.B acl_names
The list of users or groups
.TP
.B perms
Remove the permissions eg.: rwx
.TP
.B recurse
Set the permissions recursive in the path
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.linux_acl.list_present(name, acl_type, acl_names=None, perms=\(aq\(aq, recurse=False, force=False)
Ensure a Linux ACL list is present
.sp
Takes a list of acl names and add them to the given path
.INDENT 7.0
.TP
.B name
The acl path
.TP
.B acl_type
The type of the acl is used for it can be \(aquser\(aq or \(aqgroup\(aq
.TP
.B acl_names
The list of users or groups
.TP
.B perms
Set the permissions eg.: rwx
.TP
.B recurse
Set the permissions recursive in the path
.TP
.B force
Wipe out old permissions and ensure only the new permissions are set
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.linux_acl.present(name, acl_type, acl_name=\(aq\(aq, perms=\(aq\(aq, recurse=False, force=False)
Ensure a Linux ACL is present
.INDENT 7.0
.TP
.B name
The acl path
.TP
.B acl_type
The type of the acl is used for it can be \(aquser\(aq or \(aqgroup\(aq
.TP
.B acl_name
The  user or group
.TP
.B perms
Set the permissions eg.: rwx
.TP
.B recurse
Set the permissions recursive in the path
.TP
.B force
Wipe out old permissions and ensure only the new permissions are set
.UNINDENT
.UNINDENT
.SS salt.states.locale
.SS Management of languages/locales
.sp
Manage the available locales and the system default:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
us_locale:
  locale.present:
    \- name: en_US.UTF\-8

default_locale:
  locale.system:
    \- name: en_US.UTF\-8
    \- require:
      \- locale: us_locale
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.locale.present(name)
Generate a locale if it is not present
.sp
New in version 2014.7.0.

.INDENT 7.0
.TP
.B name
The name of the locale to be present. Some distributions require the
charmap to be specified as part of the locale at this point.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.locale.system(name)
Set the locale for the system
.INDENT 7.0
.TP
.B name
The name of the locale to use
.UNINDENT
.UNINDENT
.SS salt.states.logadm
.sp
Management of logs using Solaris logadm.
.INDENT 0.0
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B depends
salt.modulus.logadm
.TP
.B platform
Oracle Solaris, Sun Solaris, illumos
.UNINDENT
.sp
New in version 2017.7.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\&.. note::
    TODO
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.logadm.remove(name, log_file=None)
Remove a log from the logadm configuration
.INDENT 7.0
.TP
.B name
string
entryname
.TP
.B log_file
string
(optional) log file path
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If log_file is specified it will be used instead of the entry name.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.logadm.rotate(name, **kwargs)
Add a log to the logadm configuration
.INDENT 7.0
.TP
.B name
string
alias for entryname
.TP
.B kwargs
boolean|string|int
optional additional flags and parameters
.UNINDENT
.UNINDENT
.SS salt.states.logrotate
.sp
Module for managing logrotate.
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.states.logrotate.set_(name, key, value, setting=None, conf_file=\(aq/etc/logrotate.conf\(aq)
Set a new value for a specific configuration line.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The command or block to configure.
.IP \(bu 2
\fBvalue\fP (\fI\%str\fP) \-\- The command value or command of the block specified by the key parameter.
.IP \(bu 2
\fBsetting\fP (\fI\%str\fP) \-\- The command value for the command specified by the value parameter.
.IP \(bu 2
\fBconf_file\fP (\fI\%str\fP) \-\- The logrotate configuration file.
.UNINDENT
.UNINDENT
.sp
Example of usage with only the required arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
logrotate\-rotate:
  logrotate.set:
    \- key: rotate
    \- value: 2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage specifying all available arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
logrotate\-wtmp\-rotate:
  logrotate.set:
    \- key: /var/log/wtmp
    \- value: rotate
    \- setting: 2
    \- conf_file: /etc/logrotate.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.loop
.sp
Loop state
.sp
Allows for looping over execution modules.
.sp
New in version 2017.7.0.

.sp
In both examples below, the execution module function \fBboto_elb.get_instance_health\fP
returns a list of dicts. The condition checks the \fBstate\fP\-key of the first dict
in the returned list and compares its value to the string \fIInService\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
wait_for_service_to_be_healthy:
  loop.until:
    \- name: boto_elb.get_instance_health
    \- condition: m_ret[0][\(aqstate\(aq] == \(aqInService\(aq
    \- period: 5
    \- timeout: 20
    \- m_args:
      \- {{ elb }}
    \- m_kwargs:
        keyid: {{ access_key }}
        key: {{ secret_key }}
        instances: \(dq{{ instance }}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This state allows arbitrary python code to be executed through the condition
parameter which is literally evaluated within the state. Please use caution.
.UNINDENT
.UNINDENT
.sp
Changed in version 3000.

.sp
A version that does not use eval is now available. It uses either the python \fBoperator\fP
to compare the result of the function called in \fBname\fP, which can be one of the
following: lt, le, eq (default), ne, ge, gt.
Alternatively, \fIcompare_operator\fP can be filled with a function from an execution
module in \fB__salt__\fP or \fB__utils__\fP like the example below.
The function \fBdata.subdict_match\fP checks if the
\fBexpected\fP expression matches the data returned by calling the \fBname\fP function
(with passed \fBargs\fP and \fBkwargs\fP).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Wait for service to be healthy:
  loop.until_no_eval:
    \- name: boto_elb.get_instance_health
    \- expected: \(aq0:state:InService\(aq
    \- compare_operator: data.subdict_match
    \- period: 5
    \- timeout: 20
    \- args:
      \- {{ elb }}
    \- kwargs:
        keyid: {{ access_key }}
        key: {{ secret_key }}
        instances: \(dq{{ instance }}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.loop.until(name, m_args=None, m_kwargs=None, condition=None, period=1, timeout=60)
Loop over an execution module until a condition is met.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the execution module
.IP \(bu 2
\fBm_args\fP (\fI\%list\fP) \-\- The execution module\(aqs positional arguments
.IP \(bu 2
\fBm_kwargs\fP (\fI\%dict\fP) \-\- The execution module\(aqs keyword arguments
.IP \(bu 2
\fBcondition\fP (\fI\%str\fP) \-\- The condition which must be met for the loop to break.
This should contain \fBm_ret\fP which is the return from the execution module.
.IP \(bu 2
\fBperiod\fP (\fI\%int\fP\fI or \fP\fI\%float\fP) \-\- The number of seconds to wait between executions
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP\fI or \fP\fI\%float\fP) \-\- The timeout in seconds
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.loop.until_no_eval(name, expected, compare_operator=\(aqeq\(aq, timeout=60, period=1, init_wait=0, args=None, kwargs=None)
Generic waiter state that waits for a specific salt function to produce an
expected result.
The state fails if the function does not exist or raises an exception,
or does not produce the expected result within the allotted retries.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name of the module.function to call
.IP \(bu 2
\fBexpected\fP \-\- Expected return value. This can be almost anything.
.IP \(bu 2
\fBcompare_operator\fP (\fI\%str\fP) \-\- Operator to use to compare the result of the
module.function call with the expected value. This can be anything present
in __salt__ or __utils__. Will be called with 2 args: result, expected.
.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP\fI or \fP\fI\%float\fP) \-\- Abort after this amount of seconds (excluding init_wait).
.IP \(bu 2
\fBperiod\fP (\fI\%int\fP\fI or \fP\fI\%float\fP) \-\- Time (in seconds) to wait between attempts.
.IP \(bu 2
\fBinit_wait\fP (\fI\%int\fP\fI or \fP\fI\%float\fP) \-\- Time (in seconds) to wait before trying anything.
.IP \(bu 2
\fBargs\fP (\fI\%list\fP) \-\- args to pass to the salt module.function.
.IP \(bu 2
\fBkwargs\fP (\fI\%dict\fP) \-\- kwargs to pass to the salt module.function.
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.UNINDENT
.SS salt.states.lvm
.SS Management of Linux logical volumes
.sp
A state module to manage LVMs
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/dev/sda:
  lvm.pv_present

my_vg:
  lvm.vg_present:
    \- devices: /dev/sda

lvroot:
  lvm.lv_present:
    \- vgname: my_vg
    \- size: 10G
    \- stripes: 5
    \- stripesize: 8K
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lvm.lv_absent(name, vgname=None)
Remove a given existing Logical Volume from a named existing volume group
.INDENT 7.0
.TP
.B name
The Logical Volume to remove
.TP
.B vgname
The name of the Volume Group on which the Logical Volume resides
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lvm.lv_present(name, vgname=None, size=None, extents=None, snapshot=None, pv=\(aq\(aq, thinvolume=False, thinpool=False, force=False, resizefs=False, **kwargs)
Ensure that a Logical Volume is present, creating it if absent.
.INDENT 7.0
.TP
.B name
The name of the Logical Volume
.TP
.B vgname
The name of the Volume Group on which the Logical Volume resides
.TP
.B size
The size of the Logical Volume in megabytes, or use a suffix
such as S, M, G, T, P for 512 byte sectors, megabytes, gigabytes
or terabytes respectively. The suffix is case insensitive.
.TP
.B extents
The number of logical extents allocated to the Logical Volume
It can be a percentage allowed by lvcreate\(aqs syntax, in this case
it will set the Logical Volume initial size and won\(aqt be resized.
.TP
.B snapshot
The name of the snapshot
.TP
.B pv
The Physical Volume to use
.TP
.B kwargs
Any supported options to lvcreate. See
\fI\%linux_lvm\fP for more details.
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 7.0
.TP
.B thinvolume
Logical Volume is thinly provisioned
.TP
.B thinpool
Logical Volume is a thin pool
.UNINDENT
.sp
New in version 2018.3.0.

.INDENT 7.0
.TP
.B force
Assume yes to all prompts
.UNINDENT
.sp
New in version 3002.

.INDENT 7.0
.TP
.B resizefs
Use fsadm to resize the logical volume filesystem if needed
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lvm.pv_absent(name)
Ensure that a Physical Device is not being used by lvm
.INDENT 7.0
.TP
.B name
The device name to initialize.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lvm.pv_present(name, **kwargs)
Set a Physical Device to be used as an LVM Physical Volume
.INDENT 7.0
.TP
.B name
The device name to initialize.
.TP
.B kwargs
Any supported options to pvcreate. See
\fI\%linux_lvm\fP for more details.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lvm.vg_absent(name)
Remove an LVM volume group
.INDENT 7.0
.TP
.B name
The volume group to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lvm.vg_present(name, devices=None, **kwargs)
Create an LVM Volume Group
.INDENT 7.0
.TP
.B name
The Volume Group name to create
.TP
.B devices
A list of devices that will be added to the Volume Group
.TP
.B kwargs
Any supported options to vgcreate. See
\fI\%linux_lvm\fP for more details.
.UNINDENT
.UNINDENT
.SS salt.states.lvs_server
.SS Management of LVS (Linux Virtual Server) Real Server
.INDENT 0.0
.TP
.B salt.states.lvs_server.absent(name, protocol=None, service_address=None, server_address=None)
Ensure the LVS Real Server in specified service is absent.
.INDENT 7.0
.TP
.B name
The name of the LVS server.
.TP
.B protocol
The service protocol(only support \fBtcp\fP, \fBudp\fP and \fBfwmark\fP service).
.TP
.B service_address
The LVS service address.
.TP
.B server_address
The LVS real server address.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lvs_server.present(name, protocol=None, service_address=None, server_address=None, packet_forward_method=\(aqdr\(aq, weight=1)
Ensure that the named service is present.
.INDENT 7.0
.TP
.B name
The LVS server name
.TP
.B protocol
The service protocol
.TP
.B service_address
The LVS service address
.TP
.B server_address
The real server address.
.TP
.B packet_forward_method
The LVS packet forwarding method(\fBdr\fP for direct routing, \fBtunnel\fP for tunneling, \fBnat\fP for network access translation).
.TP
.B weight
The capacity  of a server relative to the others in the pool.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
lvsrs:
  lvs_server.present:
    \- protocol: tcp
    \- service_address: 1.1.1.1:80
    \- server_address: 192.168.0.11:8080
    \- packet_forward_method: dr
    \- weight: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.lvs_service
.SS Management of LVS (Linux Virtual Server) Service
.INDENT 0.0
.TP
.B salt.states.lvs_service.absent(name, protocol=None, service_address=None)
Ensure the LVS service is absent.
.INDENT 7.0
.TP
.B name
The name of the LVS service
.TP
.B protocol
The service protocol
.TP
.B service_address
The LVS service address
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lvs_service.present(name, protocol=None, service_address=None, scheduler=\(aqwlc\(aq)
Ensure that the named service is present.
.INDENT 7.0
.TP
.B name
The LVS service name
.TP
.B protocol
The service protocol
.TP
.B service_address
The LVS service address
.TP
.B scheduler
Algorithm for allocating TCP connections and UDP datagrams to real servers.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
lvstest:
  lvs_service.present:
    \- service_address: 1.1.1.1:80
    \- protocol: tcp
    \- scheduler: rr
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.lxc
.SS Manage Linux Containers
.INDENT 0.0
.TP
.B salt.states.lxc.absent(name, stop=False, path=None)
Ensure a container is not present, destroying it if present
.INDENT 7.0
.TP
.B name
Name of the container to destroy
.TP
.B stop
stop before destroying
default: false
.sp
New in version 2015.5.2.

.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
web01:
  lxc.absent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxc.edited_conf(name, lxc_conf=None, lxc_conf_unset=None)
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This state is unsuitable for setting parameters that appear more than
once in an LXC config file, or parameters which must appear in a
certain order (such as when configuring more than one network
interface).
.sp
\fI\%Issue #35523\fP was opened to track the addition of a suitable replacement
or fix.
.UNINDENT
.UNINDENT
.sp
Edit LXC configuration options
.sp
Deprecated since version 2015.5.0.

.INDENT 7.0
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
setconf:
  lxc.edited_conf:
    \- name: ubuntu
    \- lxc_conf:
        \- network.ipv4.ip: 10.0.3.6
    \- lxc_conf_unset:
        \- lxc.utsname
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxc.frozen(name, start=True, path=None)
New in version 2015.5.0.

.sp
Ensure that a container is frozen
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state does not enforce the existence of the named container, it
just freezes the container if it is running. To ensure that the named
container exists, use \fI\%lxc.present\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the container
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.TP
.B start
True
Start container first, if necessary. If \fBFalse\fP, then this state will
fail if the container is not running.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
web01:
  lxc.frozen

web02:
  lxc.frozen:
    \- start: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxc.present(name, running=None, clone_from=None, snapshot=False, profile=None, network_profile=None, template=None, options=None, image=None, config=None, fstype=None, size=None, backing=None, vgname=None, lvname=None, thinpool=None, path=None)
Changed in version 2015.8.0: The \fBlxc.created\fP state has been renamed
to \fBlxc.present\fP, and the \fBlxc.cloned\fP
state has been merged into this state.

.sp
Create the named container if it does not exist
.INDENT 7.0
.TP
.B name
The name of the container to be created
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.TP
.B running
False.INDENT 7.0
.IP \(bu 2
If \fBTrue\fP, ensure that the container is running
.IP \(bu 2
If \fBFalse\fP, ensure that the container is stopped
.IP \(bu 2
If \fBNone\fP, do nothing with regards to the running state of the
container
.UNINDENT
.sp
New in version 2015.8.0.

.TP
.B clone_from
Create named container as a clone of the specified container
.TP
.B snapshot
False
Use Copy On Write snapshots (LVM). Only supported with \fBclone_from\fP\&.
.TP
.B profile
Profile to use in container creation (see the \fI\%LXC Tutorial\fP for more information). Values in a
profile will be overridden by the parameters listed below.
.TP
.B network_profile
Network Profile to use in container creation
(see the \fI\%LXC Tutorial\fP
for more information). Values in a profile will be overridden by
the parameters listed below.
.sp
New in version 2015.5.2.

.UNINDENT
.sp
\fBContainer Creation Arguments\fP
.INDENT 7.0
.TP
.B template
The template to use. For example, \fBubuntu\fP or \fBfedora\fP\&.
For a full list of available templates, check out
the \fI\%lxc.templates\fP function.
.sp
Conflicts with the \fBimage\fP argument.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fBdownload\fP template requires the following three parameters
to be defined in \fBoptions\fP:
.INDENT 0.0
.IP \(bu 2
\fBdist\fP \- The name of the distribution
.IP \(bu 2
\fBrelease\fP \- Release name/version
.IP \(bu 2
\fBarch\fP \- Architecture of the container
.UNINDENT
.sp
The available images can be listed using the \fI\%lxc.images\fP function.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
options
.INDENT 7.0
.INDENT 3.5
New in version 2015.5.0.

.sp
Template\-specific options to pass to the lxc\-create command. These
correspond to the long options (ones beginning with two dashes) that
the template script accepts. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
web01:
  lxc.present:
    \- template: download
    \- options:
        dist: centos
        release: 6
        arch: amd64
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Remember to double\-indent the options, due to \fI\%how PyYAML works\fP\&.
.sp
For available template options, refer to the lxc template scripts
which are usually located under \fB/usr/share/lxc/templates\fP,
or run \fBlxc\-create \-t <template> \-h\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B image
A tar archive to use as the rootfs for the container. Conflicts with
the \fBtemplate\fP argument.
.TP
.B backing
The type of storage to use. Set to \fBlvm\fP to use an LVM group.
Defaults to filesystem within /var/lib/lxc.
.TP
.B fstype
Filesystem type to use on LVM logical volume
.TP
.B size
Size of the volume to create. Only applicable if \fBbacking\fP is set to
\fBlvm\fP\&.
.TP
.B vgname
lxc
Name of the LVM volume group in which to create the volume for this
container. Only applicable if \fBbacking\fP is set to \fBlvm\fP\&.
.TP
.B lvname
Name of the LVM logical volume in which to create the volume for this
container. Only applicable if \fBbacking\fP is set to \fBlvm\fP\&.
.TP
.B thinpool
Name of a pool volume that will be used for thin\-provisioning this
container. Only applicable if \fBbacking\fP is set to \fBlvm\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxc.running(name, restart=False, path=None)
Changed in version 2015.5.0: The \fBlxc.started\fP state has been renamed
to \fBlxc.running\fP

.sp
Ensure that a container is running
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state does not enforce the existence of the named container, it
just starts the container if it is not running. To ensure that the
named container exists, use \fI\%lxc.present\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the container
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.TP
.B restart
False
Restart container if it is already running
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
web01:
  lxc.running

web02:
  lxc.running:
    \- restart: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxc.set_pass(name, **kwargs)
Deprecated since version 2015.5.0.

.sp
This state function has been disabled, as it did not conform to design
guidelines. Specifically, due to the fact that \fI\%lxc.set_password\fP uses \fBchpasswd(8)\fP to set the password,
there was no method to make this action idempotent (in other words, the
password would be changed every time). This makes this state redundant,
since the following state will do the same thing:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
setpass:
  module.run:
    \- name: set_pass
    \- m_name: root
    \- password: secret
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxc.stopped(name, kill=False, path=None)
Ensure that a container is stopped
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state does not enforce the existence of the named container, it
just stops the container if it running or frozen. To ensure that the
named container exists, use \fI\%lxc.present\fP, or use the \fI\%lxc.absent\fP state to ensure that the container does not
exist.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the container
.TP
.B path
path to the container parent
default: /var/lib/lxc (system default)
.sp
New in version 2015.8.0.

.TP
.B kill
False
Do not wait for the container to stop, kill all tasks in the container.
Older LXC versions will stop containers like this irrespective of this
argument.
.sp
New in version 2015.5.0.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
web01:
  lxc.stopped
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.lxd
.sp
Manage LXD profiles.
.sp
New in version 2019.2.0.

.INDENT 0.0
.TP
.B maintainer
René Jochum <\fI\%rene@jochums.at\fP>
.TP
.B maturity
new
.TP
.B depends
python\-pylxd
.TP
.B platform
Linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxd.authenticate(name, remote_addr, password, cert, key, verify_cert=True)
Authenticate with a remote peer.
.INDENT 7.0
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if you
provide remote_addr!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B password :
The PaSsW0rD
.TP
.B cert :
PEM Formatted SSL Zertifikate.
.INDENT 7.0
.TP
.B Examples:
/root/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
/root/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.TP
.B name:
Ignore this. This is just here for salt.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxd.config_managed(name, value, force_password=False)
Manage a LXD Server config setting.
.INDENT 7.0
.TP
.B name :
The name of the config key.
.TP
.B value :
Its value.
.TP
.B force_password
False
Set this to True if you want to set the password on every run.
.sp
As we can\(aqt retrieve the password from LXD we can\(aqt check
if the current one is the same as the given one.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxd.init(name, storage_backend=\(aqdir\(aq, trust_password=None, network_address=None, network_port=None, storage_create_device=None, storage_create_loop=None, storage_pool=None, done_file=\(aq%SALT_CONFIG_DIR%/lxd_initialized\(aq)
Initializes the LXD Daemon, as LXD doesn\(aqt tell if its initialized
we touch the done_file and check if it exist.
.sp
This can only be called once per host unless you remove the done_file.
.INDENT 7.0
.TP
.B name :
Ignore this. This is just here for salt.
.TP
.B storage_backend :
Storage backend to use (zfs or dir, default: dir)
.TP
.B trust_password :
Password required to add new clients
.TP
.B network_address
None
Address to bind LXD to (default: none)
.TP
.B network_port
None
Port to bind LXD to (Default: 8443)
.TP
.B storage_create_device
None
Setup device based storage using this DEVICE
.TP
.B storage_create_loop
None
Setup loop based storage with this SIZE in GB
.TP
.B storage_pool
None
Storage pool to use or create
.TP
.B done_file :
Path where we check that this method has been called,
as it can run only once and there\(aqs currently no way
to ask LXD if init has been called.
.UNINDENT
.UNINDENT
.SS salt.states.lxd_container
.sp
Manage LXD containers.
.sp
New in version 2019.2.0.

.INDENT 0.0
.TP
.B maintainer
René Jochum <\fI\%rene@jochums.at\fP>
.TP
.B maturity
new
.TP
.B depends
python\-pylxd
.TP
.B platform
Linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxd_container.absent(name, stop=False, remote_addr=None, cert=None, key=None, verify_cert=True)
Ensure a LXD container is not present, destroying it if present
.INDENT 7.0
.TP
.B name :
The name of the container to destroy
.TP
.B stop :
stop before destroying
default: false
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if you
provide remote_addr!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Zertifikate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxd_container.frozen(name, start=True, remote_addr=None, cert=None, key=None, verify_cert=True)
Ensure a LXD container is frozen, start and freeze it if start is true
.INDENT 7.0
.TP
.B name :
The name of the container to freeze
.TP
.B start :
start and freeze it
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if you
provide remote_addr!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Zertifikate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxd_container.migrated(name, remote_addr, cert, key, verify_cert, src_remote_addr, stop_and_start=False, src_cert=None, src_key=None, src_verify_cert=None)
Ensure a container is migrated to another host
.sp
If the container is running, it either must be shut down
first (use stop_and_start=True) or criu must be installed
on the source and destination machines.
.sp
For this operation both certs need to be authenticated,
use \fBlxd.authenticate <salt.states.lxd.authenticate\fP
to authenticate your cert(s).
.INDENT 7.0
.TP
.B name :
The container to migrate
.TP
.B remote_addr :
An URL to the destination remote Server
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Zertifikate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.TP
.B src_remote_addr :
An URL to the source remote Server
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B stop_and_start:
Stop before migrating and start after
.TP
.B src_cert :
PEM Formatted SSL Zertifikate, if None we copy \(dqcert\(dq
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B src_key :
PEM Formatted SSL Key, if None we copy \(dqkey\(dq
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B src_verify_cert :
Wherever to verify the cert, if None we copy \(dqverify_cert\(dq
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxd_container.present(name, running=None, source=None, profiles=None, config=None, devices=None, architecture=\(aqx86_64\(aq, ephemeral=False, restart_on_change=False, remote_addr=None, cert=None, key=None, verify_cert=True)
Create the named container if it does not exist
.INDENT 7.0
.TP
.B name
The name of the container to be created
.TP
.B running
None.INDENT 7.0
.IP \(bu 2
If \fBTrue\fP, ensure that the container is running
.IP \(bu 2
If \fBFalse\fP, ensure that the container is stopped
.IP \(bu 2
If \fBNone\fP, do nothing with regards to the running state of the
container
.UNINDENT
.TP
.B source
None
Can be either a string containing an image alias:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\(dqxenial/amd64\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or an dict with type \(dqimage\(dq with alias:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqtype\(dq: \(dqimage\(dq,
 \(dqalias\(dq: \(dqxenial/amd64\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or image with \(dqfingerprint\(dq:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqtype\(dq: \(dqimage\(dq,
 \(dqfingerprint\(dq: \(dqSHA\-256\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or image with \(dqproperties\(dq:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqtype\(dq: \(dqimage\(dq,
 \(dqproperties\(dq: {
    \(dqos\(dq: \(dqubuntu\(dq,
    \(dqrelease\(dq: \(dq14.04\(dq,
    \(dqarchitecture\(dq: \(dqx86_64\(dq
 }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or none:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqtype\(dq: \(dqnone\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or copy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqtype\(dq: \(dqcopy\(dq,
 \(dqsource\(dq: \(dqmy\-old\-container\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B profiles
[\(aqdefault\(aq]
List of profiles to apply on this container
.TP
.B config :
A config dict or None (None = unset).
.sp
Can also be a list:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[{\(aqkey\(aq: \(aqboot.autostart\(aq, \(aqvalue\(aq: 1},
 {\(aqkey\(aq: \(aqsecurity.privileged\(aq, \(aqvalue\(aq: \(aq1\(aq}]
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B devices :
A device dict or None (None = unset).
.TP
.B architecture
\(aqx86_64\(aq
Can be one of the following:
.INDENT 7.0
.IP \(bu 2
unknown
.IP \(bu 2
i686
.IP \(bu 2
x86_64
.IP \(bu 2
armv7l
.IP \(bu 2
aarch64
.IP \(bu 2
ppc
.IP \(bu 2
ppc64
.IP \(bu 2
ppc64le
.IP \(bu 2
s390x
.UNINDENT
.TP
.B ephemeral
False
Destroy this container after stop?
.TP
.B restart_on_change
False
Restart the container when we detect changes on the config or
its devices?
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if you
provide remote_addr!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Zertifikate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxd_container.running(name, restart=False, remote_addr=None, cert=None, key=None, verify_cert=True)
Ensure a LXD container is running and restart it if restart is True
.INDENT 7.0
.TP
.B name :
The name of the container to start/restart.
.TP
.B restart :
restart the container if it is already started.
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if you
provide remote_addr!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Zertifikate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxd_container.stopped(name, kill=False, remote_addr=None, cert=None, key=None, verify_cert=True)
Ensure a LXD container is stopped, kill it if kill is true else stop it
.INDENT 7.0
.TP
.B name :
The name of the container to stop
.TP
.B kill :
kill if true
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if you
provide remote_addr!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Zertifikate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.SS salt.states.lxd_image
.sp
Manage LXD images.
.sp
New in version 2019.2.0.

.INDENT 0.0
.TP
.B maintainer
René Jochum <\fI\%rene@jochums.at\fP>
.TP
.B maturity
new
.TP
.B depends
python\-pylxd
.TP
.B platform
Linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxd_image.absent(name, remote_addr=None, cert=None, key=None, verify_cert=True)
.INDENT 7.0
.TP
.B name :
An alias or fingerprint of the image to check and delete.
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if you
provide remote_addr!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Zertifikate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxd_image.present(name, source, aliases=None, public=None, auto_update=None, remote_addr=None, cert=None, key=None, verify_cert=True)
Ensure an image exists, copy it else from source
.INDENT 7.0
.TP
.B name :
An alias of the image, this is used to check if the image exists and
it will be added as alias to the image on copy/create.
.TP
.B source :
Source dict.
.sp
For an LXD to LXD copy:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
source:
    type: lxd
    name: ubuntu/xenial/amd64  # This can also be a fingerprint.
    remote_addr: https://images.linuxcontainers.org:8443
    cert: ~/.config/lxd/client.crt
    key: ~/.config/lxd/client.key
    verify_cert: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
From file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
source:
    type: file
    filename: salt://lxd/files/busybox.tar.xz
    saltenv: base
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
From simplestreams:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
source:
    type: simplestreams
    server: https://cloud\-images.ubuntu.com/releases
    name: xenial/amd64
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
From an URL:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
source:
    type: url
    url: https://dl.stgraber.org/lxd
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B aliases :
List of aliases to append, can be empty.
.TP
.B public :
.INDENT 7.0
.TP
.B Make this image public available on this instance?
None on source_type LXD means copy source
None on source_type file means False
.UNINDENT
.TP
.B auto_update :
.INDENT 7.0
.TP
.B Try to auto\-update from the original source?
None on source_type LXD means copy source
source_type file does not have auto\-update.
.UNINDENT
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if you
provide remote_addr!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Zertifikate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.UNINDENT
.SS salt.states.lxd_profile
.sp
Manage LXD profiles.
.sp
New in version 2019.2.0.

.INDENT 0.0
.TP
.B maintainer
René Jochum <\fI\%rene@jochums.at\fP>
.TP
.B maturity
new
.TP
.B depends
python\-pylxd
.TP
.B platform
Linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxd_profile.absent(name, remote_addr=None, cert=None, key=None, verify_cert=True)
Ensure a LXD profile is not present, removing it if present.
.INDENT 7.0
.TP
.B name :
The name of the profile to remove.
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if you
provide remote_addr!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Zertifikate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
See the \fIrequests\-docs\fP for the SSL stuff.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.lxd_profile.present(name, description=None, config=None, devices=None, remote_addr=None, cert=None, key=None, verify_cert=True)
Creates or updates LXD profiles
.INDENT 7.0
.TP
.B name :
The name of the profile to create/update
.TP
.B description :
A description string
.TP
.B config :
A config dict or None (None = unset).
.INDENT 7.0
.TP
.B Can also be a list:
.INDENT 7.0
.TP
.B [{\(aqkey\(aq: \(aqboot.autostart\(aq, \(aqvalue\(aq: 1},
{\(aqkey\(aq: \(aqsecurity.privileged\(aq, \(aqvalue\(aq: \(aq1\(aq}]
.UNINDENT
.UNINDENT
.TP
.B devices :
A device dict or None (None = unset).
.TP
.B remote_addr :
An URL to a remote Server, you also have to give cert and key if you
provide remote_addr!
.INDENT 7.0
.TP
.B Examples:
\fI\%https://myserver.lan:8443\fP
/var/lib/mysocket.sock
.UNINDENT
.TP
.B cert :
PEM Formatted SSL Zertifikate.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.crt
.UNINDENT
.TP
.B key :
PEM Formatted SSL Key.
.INDENT 7.0
.TP
.B Examples:
~/.config/lxc/client.key
.UNINDENT
.TP
.B verify_cert
True
Wherever to verify the cert, this is by default True
but in the most cases you want to set it off as LXD
normally uses self\-signed certificates.
.UNINDENT
.sp
See the \fI\%lxd\-docs\fP for the details about the config and devices dicts.
See the \fIrequests\-docs\fP for the SSL stuff.
.UNINDENT
.SS salt.states.mac_assistive
.SS Allows you to manage assistive access on macOS minions with 10.9+
.sp
Install, enable and disable assistive access on macOS minions
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/usr/bin/osacript:
  assistive.installed:
    \- enabled: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mac_assistive.installed(name, enabled=True)
Make sure that we have the given bundle ID or path to command
installed in the assistive access panel.
.INDENT 7.0
.TP
.B name
The bundle ID or path to command
.TP
.B enable
Should assistive access be enabled on this application?
.UNINDENT
.UNINDENT
.SS salt.states.mac_keychain
.SS Installing of certificates to the keychain
.sp
Install certificats to the macOS keychain
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/mnt/test.p12:
  keychain.installed:
    \- password: test123
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mac_keychain.default_keychain(name, domain=\(aquser\(aq, user=None)
Set the default keychain to use
.INDENT 7.0
.TP
.B name
The chain in which to use as the default
.TP
.B domain
The domain to use valid values are user|system|common|dynamic, the default is user
.TP
.B user
The user to run as
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mac_keychain.installed(name, password, keychain=\(aq/Library/Keychains/System.keychain\(aq, **kwargs)
Install a p12 certificate file into the macOS keychain
.INDENT 7.0
.TP
.B name
The certificate to install
.TP
.B password
The password for the certificate being installed formatted in the way
described for openssl command in the PASS PHRASE ARGUMENTS section
.TP
.B keychain
The keychain to install the certificate to, this defaults to
/Library/Keychains/System.keychain
.TP
.B allow_any
Allow any application to access the imported certificate without warning
.TP
.B keychain_password
If your keychain is likely to be locked pass the password and it will be unlocked
before running the import
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mac_keychain.uninstalled(name, password, keychain=\(aq/Library/Keychains/System.keychain\(aq, keychain_password=None)
Uninstall a p12 certificate file from the macOS keychain
.INDENT 7.0
.TP
.B name
The certificate to uninstall, this can be a path for a .p12 or the friendly
name
.TP
.B password
The password for the certificate being installed formatted in the way
described for openssl command in the PASS PHRASE ARGUMENTS section
.TP
.B cert_name
The friendly name of the certificate, this can be used instead of giving a
certificate
.TP
.B keychain
The keychain to remove the certificate from, this defaults to
/Library/Keychains/System.keychain
.TP
.B keychain_password
If your keychain is likely to be locked pass the password and it will be unlocked
before running the import
.UNINDENT
.UNINDENT
.SS salt.states.mac_xattr
.SS Allows you to manage extended attributes on files or directories
.sp
Install, enable and disable assistive access on macOS minions
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/path/to/file:
  xattr.exists:
    \- attributes:
        \- com.file.attr=test
        \- com.apple.quarantine=0x00001111
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mac_xattr.delete(name, attributes)
Make sure the given attributes are deleted from the file/directory
.INDENT 7.0
.TP
.B name
The path to the file/directory
.TP
.B attributes
The attributes that should be removed from the file/directory, this is accepted as
an array.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mac_xattr.exists(name, attributes)
Make sure the given attributes exist on the file/directory
.INDENT 7.0
.TP
.B name
The path to the file/directory
.TP
.B attributes
The attributes that should exist on the file/directory, this is accepted as
an array, with key and value split with an equals sign, if you want to specify
a hex value then add 0x to the beginning of the value.
.UNINDENT
.UNINDENT
.SS salt.states.macdefaults
.SS Writing/reading defaults from a macOS minion
.INDENT 0.0
.TP
.B salt.states.macdefaults.absent(name, domain, user=None)
Make sure the defaults value is absent
.INDENT 7.0
.TP
.B name
The key of the given domain to remove
.TP
.B domain
The name of the domain to remove from
.TP
.B user
The user to write the defaults to
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.macdefaults.write(name, domain, value, vtype=\(aqstring\(aq, user=None)
Write a default to the system
.INDENT 7.0
.TP
.B name
The key of the given domain to write to
.TP
.B domain
The name of the domain to write to
.TP
.B value
The value to write to the given key
.TP
.B vtype
The type of value to be written, valid types are string, data, int[eger],
float, bool[ean], date, array, array\-add, dict, dict\-add
.TP
.B user
The user to write the defaults to
.UNINDENT
.UNINDENT
.SS salt.states.macpackage
.SS Installing of mac pkg files
.sp
Install any kind of pkg, dmg or app file on macOS:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/mnt/test.pkg:
  macpackage.installed:
    \- store: True

/mnt/test.dmg:
  macpackage.installed:
    \- dmg: True

/mnt/xcode.dmg:
  macpackage.installed:
    \- dmg: True
    \- app: True
    \- target: /Applications/Xcode.app
    \- version_check: xcodebuild \-version=Xcode 7.1\en.*7B91b
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.macpackage.installed(name, target=\(aqLocalSystem\(aq, dmg=False, store=False, app=False, mpkg=False, force=False, allow_untrusted=False, version_check=None)
Install a Mac OS Package from a pkg or dmg file, if given a dmg file it
will first be mounted in a temporary location
.INDENT 7.0
.TP
.B name
The pkg or dmg file to install
.TP
.B target
The location in which to install the package. This can be a path or LocalSystem
.TP
.B dmg
Is the given file a dmg file?
.TP
.B store
Should the pkg be installed as if it was from the Mac OS Store?
.TP
.B app
Is the file a .app? If so then we\(aqll just copy that to /Applications/ or the given
target
.TP
.B mpkg
Is the file a .mpkg? If so then we\(aqll check all of the .pkg files found are installed
.TP
.B force
Force the package to be installed even if its already been found installed
.TP
.B allow_untrusted
Allow the installation of untrusted packages
.TP
.B version_check
The command and version that we want to check against, the version number can use regex.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
version_check: python \-\-version_check=2.7.[0\-9]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.makeconf
.SS Management of Gentoo make.conf
.sp
A state module to manage Gentoo\(aqs \fBmake.conf\fP file
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
makeopts:
  makeconf.present:
    \- value: \(aq\-j3\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.makeconf.absent(name)
Verify that the variable is not in the \fBmake.conf\fP\&.
.INDENT 7.0
.TP
.B name
The variable name. This will automatically be converted to upper
case since variables in \fBmake.conf\fP are in upper case
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.makeconf.present(name, value=None, contains=None, excludes=None)
Verify that the variable is in the \fBmake.conf\fP and has the provided
settings. If value is set, contains and excludes will be ignored.
.INDENT 7.0
.TP
.B name
The variable name. This will automatically be converted to upper
case since variables in \fBmake.conf\fP are in upper case
.TP
.B value
Enforce that the value of the variable is set to the provided value
.TP
.B contains
Enforce that the value of the variable contains the provided value
.TP
.B excludes
Enforce that the value of the variable does not contain the provided
value.
.UNINDENT
.UNINDENT
.SS salt.states.marathon_app
.sp
Configure Marathon apps via a salt proxy.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_app:
  marathon_app.config:
    \- config:
        cmd: \(dqwhile [ true ] ; do echo \(aqHello Marathon\(aq ; sleep 5 ; done\(dq
        cpus: 0.1
        mem: 10
        instances: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.2.

.INDENT 0.0
.TP
.B salt.states.marathon_app.absent(name)
Ensure that the marathon app with the given id is not present.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- The app name/id
.TP
.B Returns
A standard Salt changes dictionary
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.marathon_app.config(name, config)
Ensure that the marathon app with the given id is present and is configured
to match the given config values.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The app name/id
.IP \(bu 2
\fBconfig\fP \-\- The configuration to apply (dict)
.UNINDENT
.TP
.B Returns
A standard Salt changes dictionary
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.marathon_app.running(name, restart=False, force=True)
Ensure that the marathon app with the given id is present and restart if set.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The app name/id
.IP \(bu 2
\fBrestart\fP \-\- Restart the app
.IP \(bu 2
\fBforce\fP \-\- Override the current deployment
.UNINDENT
.TP
.B Returns
A standard Salt changes dictionary
.UNINDENT
.UNINDENT
.SS salt.states.mdadm_raid
.SS Managing software RAID with mdadm
.INDENT 0.0
.TP
.B depends
mdadm
.UNINDENT
.sp
A state module for creating or destroying software RAID devices.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/dev/md0:
  raid.present:
    \- level: 5
    \- devices:
      \- /dev/xvdd
      \- /dev/xvde
      \- /dev/xvdf
    \- chunk: 256
    \- run: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mdadm_raid.absent(name)
Verify that the raid is absent
.INDENT 7.0
.TP
.B name
The name of raid device to be destroyed
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/dev/md0:
  raid:
    \- absent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mdadm_raid.present(name, level, devices, **kwargs)
Verify that the raid is present
.sp
Changed in version 2014.7.0.

.INDENT 7.0
.TP
.B name
The name of raid device to be created
.TP
.B level
The RAID level to use when creating the raid.
.TP
.B devices
A list of devices used to build the array.
.TP
.B kwargs
Optional arguments to be passed to mdadm.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/dev/md0:
  raid.present:
    \- level: 5
    \- devices:
      \- /dev/xvdd
      \- /dev/xvde
      \- /dev/xvdf
    \- chunk: 256
    \- run: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.memcached
.SS States for Management of Memcached Keys
.sp
New in version 2014.1.0.

.INDENT 0.0
.TP
.B salt.states.memcached.absent(name, value=None, host=\(aq127.0.0.1\(aq, port=11211, time=0)
Ensure that a memcached key is not present.
.INDENT 7.0
.TP
.B name
The key
.TP
.B value
None
If specified, only ensure that the key is absent if it matches the
specified value.
.TP
.B host
The memcached server IP address
.TP
.B port
The memcached server port
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  memcached.absent

bar:
  memcached.absent:
    \- host: 10.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.memcached.managed(name, value=None, host=\(aq127.0.0.1\(aq, port=11211, time=0, min_compress_len=0)
Manage a memcached key.
.INDENT 7.0
.TP
.B name
The key to manage
.TP
.B value
The value to set for that key
.TP
.B host
The memcached server IP address
.TP
.B port
The memcached server port
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  memcached.managed:
    \- value: bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.modjk
.sp
State to control Apache modjk
.INDENT 0.0
.TP
.B salt.states.modjk.worker_activated(name, workers=None, profile=\(aqdefault\(aq)
Activate all the workers in the modjk load balancer
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
loadbalancer:
  modjk.worker_activated:
    \- workers:
      \- app1
      \- app2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.modjk.worker_disabled(name, workers=None, profile=\(aqdefault\(aq)
Disable all the workers in the modjk load balancer
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
loadbalancer:
  modjk.worker_disabled:
    \- workers:
      \- app1
      \- app2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.modjk.worker_recover(name, workers=None, profile=\(aqdefault\(aq)
Recover all the workers in the modjk load balancer
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
loadbalancer:
  modjk.worker_recover:
    \- workers:
      \- app1
      \- app2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.modjk.worker_stopped(name, workers=None, profile=\(aqdefault\(aq)
Stop all the workers in the modjk load balancer
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
loadbalancer:
  modjk.worker_stopped:
    \- workers:
      \- app1
      \- app2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.modjk_worker
.SS Manage modjk workers
.sp
Send commands to a \fBmodjk\fP load balancer via the peer system.
.sp
This module can be used with the \fI\%prereq\fP
requisite to remove/add the worker from the load balancer before
deploying/restarting service.
.sp
Mandatory Settings:
.INDENT 0.0
.IP \(bu 2
The minion needs to have permission to publish the \fBmodjk.*\fP
functions (see \fI\%here\fP for information on configuring
peer publishing permissions)
.IP \(bu 2
The modjk load balancer must be configured as stated in the \fBmodjk\fP
execution module \fI\%documentation\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.modjk_worker.activate(name, lbn, target, profile=\(aqdefault\(aq, tgt_type=\(aqglob\(aq)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Activate the named worker from the lbn load balancers at the targeted
minions
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
disable\-before\-deploy:
  modjk_worker.activate:
    \- name: {{ grains[\(aqid\(aq] }}
    \- lbn: application
    \- target: \(aqroles:balancer\(aq
    \- tgt_type: grain
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.modjk_worker.disable(name, lbn, target, profile=\(aqdefault\(aq, tgt_type=\(aqglob\(aq)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Disable the named worker from the lbn load balancers at the targeted
minions. The worker will get traffic only for current sessions and won\(aqt
get new ones.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
disable\-before\-deploy:
  modjk_worker.disable:
    \- name: {{ grains[\(aqid\(aq] }}
    \- lbn: application
    \- target: \(aqroles:balancer\(aq
    \- tgt_type: grain
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.modjk_worker.stop(name, lbn, target, profile=\(aqdefault\(aq, tgt_type=\(aqglob\(aq)
Changed in version 2017.7.0: The \fBexpr_form\fP argument has been renamed to \fBtgt_type\fP, earlier
releases must use \fBexpr_form\fP\&.

.sp
Stop the named worker from the lbn load balancers at the targeted minions
The worker won\(aqt get any traffic from the lbn
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
disable\-before\-deploy:
  modjk_worker.stop:
    \- name: {{ grains[\(aqid\(aq] }}
    \- lbn: application
    \- target: \(aqroles:balancer\(aq
    \- tgt_type: grain
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.module
.SS Execution of Salt modules from within states
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
As of the 3005 release, you no longer need to opt\-in to the new style of
calling \fBmodule.run\fP\&. The following config can be removed from \fB/etc/salt/minion\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
use_superseded:
  \- module.run
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Both \(aqnew\(aq and \(aqlegacy\(aq styles of calling \fBmodule.run\fP are supported.
.UNINDENT
.UNINDENT
.sp
With \fImodule.run\fP these states allow individual execution module calls to be
made via states. Here\(aqs a contrived example, to show you how it\(aqs done:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# New Style
test.random_hash:
  module.run:
    \- test.random_hash:
      \- size: 42
      \- hash_type: sha256

# Legacy Style
test.random_hash:
  module.run:
    \- size: 42
    \- hash_type: sha256
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the new style, the state ID (\fBtest.random_hash\fP, in this case) is
irrelevant when using \fBmodule.run\fP\&. It could have very well been written:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Generate a random hash:
  module.run:
    \- test.random_hash:
      \- size: 42
      \- hash_type: sha256
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For a simple state like that it\(aqs not a big deal, but if the module you\(aqre
using has certain parameters, things can get cluttered, fast. Using the
contrived custom module (stuck in \fB/srv/salt/_modules/foo.py\fP, or your
configured \fI\%file_roots\fP):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def bar(name, names, fun, state, saltenv):
    return \(dqName: {name} Names: {names} Fun: {fun} State: {state} Saltenv: {saltenv}\(dq.format(**locals())
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Your legacy state has to look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Legacy style
Unfortunate example:
  module.run:
  \- name: foo.bar
  \- m_name: Some name
  \- m_names:
    \- Such names
    \- very wow
  \- m_state: Arkansas
  \- m_fun: Such fun
  \- m_saltenv: Salty
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With the new style it\(aqs much cleaner:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# New style
Better:
  module.run:
  \- foo.bar:
    \- name: Some name
    \- names:
      \- Such names
      \- very wow
    \- state: Arkansas
    \- fun: Such fun
    \- saltenv: Salty
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The new style also allows multiple modules in one state. For instance, you can
do this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Do many things:
  module.run:
    \- test.random_hash:
      \- size: 10
      \- hash_type: md5
    # Note the \(ga:\(ga at the end
    \- test.true:
    \- test.arg:
      \- this
      \- has
      \- args
      \- and: kwargs
      \- isn\(aqt: that neat?
    # Note the \(ga:\(ga at the end, too
    \- test.version:
    \- test.fib:
      \- 4
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Where in the legacy style you would have had to split your states like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
test.random_hash:
  module.run:
    \- size: 10
    \- hash_type: md5

test.nop:
  module.run

test.arg:
  module.run:
    \- args:
      \- this
      \- has
      \- args
    \- kwargs:
        and: kwargs
        isn\(aqt: that neat?

test.version:
  module.run
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Another difference is that in the legacy style, unconsumed arguments to the
\fBmodule\fP state were simply passed into the module function being executed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
show off module.run with args:
  module.run:
    \- name: test.random_hash
    \- size: 42
    \- hash_type: sha256
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The new style is much more explicit, with the arguments and keyword arguments
being nested under the name of the function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
show off module.run with args:
  module.run:
    # Note the lack of \(ganame: \(ga, and trailing \(ga:\(ga
    \- test.random_hash:
      \- size: 42
      \- hash_type: sha256
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the function takes \fB*args\fP, they can be passed in as well:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
args and kwargs:
  module.run:
    \- test.arg:
      \- isn\(aqt
      \- this
      \- fun
      \- this: that
      \- salt: stack
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Modern Examples
.sp
Here are some other examples using the modern \fBmodule.run\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fetch_out_of_band:
  module.run:
    \- git.fetch:
      \- cwd: /path/to/my/repo
      \- user: myuser
      \- opts: \(aq\-\-all\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A more complex example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
eventsviewer:
  module.run:
    \- task.create_task:
      \- name: events\-viewer
      \- user_name: System
      \- action_type: Execute
      \- cmd: \(aqc:\enetops\escripts\eevents_viewer.bat\(aq
      \- trigger_type: \(aqDaily\(aq
      \- start_date: \(aq2017\-1\-20\(aq
      \- start_time: \(aq11:59PM\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is sometimes desirable to trigger a function call after a state is executed,
for this the \fI\%module.wait\fP state can be used:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
add example to hosts:
  file.append:
    \- name: /etc/hosts
    \- text: 203.0.113.13     example.com

# New Style
mine.send:
  module.wait:
    # Again, note the trailing \(ga:\(ga
    \- hosts.list_hosts:
    \- watch:
      \- file: add example to hosts
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Legacy (Default) Examples
.sp
If you\(aqre using the legacy \fBmodule.run\fP, due to how the state system works,
if a module function accepts an argument called, \fBname\fP, then \fBm_name\fP must
be used to specify that argument, to avoid a collision with the \fBname\fP
argument.
.sp
Here is a list of keywords hidden by the state system, which must be prefixed
with \fBm_\fP:
.INDENT 0.0
.IP \(bu 2
fun
.IP \(bu 2
name
.IP \(bu 2
names
.IP \(bu 2
state
.IP \(bu 2
saltenv
.UNINDENT
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
disable_nfs:
  module.run:
    \- name: service.disable
    \- m_name: nfs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that some modules read all or some of the arguments from a list of keyword
arguments. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine.send:
  module.run:
    \- func: network.ip_addrs
    \- kwargs:
        interface: eth0
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cloud.create:
  module.run:
    \- func: cloud.create
    \- provider: test\-provider
    \- m_names:
      \- test\-vlad
    \- kwargs: {
          ssh_username: \(aqubuntu\(aq,
          image: \(aqami\-8d6d9daa\(aq,
          securitygroup: \(aqdefault\(aq,
          size: \(aqc3.large\(aq,
          location: \(aqap\-northeast\-1\(aq,
          delvol_on_destroy: \(aqTrue\(aq
      }
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Other modules take the keyword arguments using this style:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mac_enable_ssh:
  module.run:
    \- name: system.set_remote_login
    \- enable: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Another example that creates a recurring task that runs a batch file on a
Windows system:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
eventsviewer:
  module.run:
    \- name: task.create_task
    \- m_name: \(aqevents\-viewer\(aq
    \- user_name: System
    \- kwargs: {
          action_type: \(aqExecute\(aq,
          cmd: \(aqc:\enetops\escripts\eevents_viewer.bat\(aq,
          trigger_type: \(aqDaily\(aq,
          start_date: \(aq2017\-1\-20\(aq,
          start_time: \(aq11:59PM\(aq
    }
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.module.mod_watch(**kwargs)
This function is an alias of \fBrun\fP\&.
.INDENT 7.0
.INDENT 3.5
Run a single module function or a range of module functions in a batch.
Supersedes \fBmodule.run\fP function, which requires \fBm_\fP prefix to
function\-specific parameters.
.INDENT 0.0
.TP
.B param returner
Specify a common returner for the whole batch to send the return data
.TP
.B param kwargs
Pass any arguments needed to execute the function(s)
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
some_id_of_state:
  module.run:
    \- network.ip_addrs:
      \- interface: eth0
    \- cloud.create:
      \- names:
        \- test\-isbm\-1
        \- test\-isbm\-2
      \- ssh_username: sles
      \- image: sles12sp2
      \- securitygroup: default
      \- size: \(aqc3.large\(aq
      \- location: ap\-northeast\-1
      \- delvol_on_destroy: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B return
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.module.run(**kwargs)
Run a single module function or a range of module functions in a batch.
Supersedes \fBmodule.run\fP function, which requires \fBm_\fP prefix to
function\-specific parameters.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBreturner\fP \-\- Specify a common returner for the whole batch to send the return data
.IP \(bu 2
\fBkwargs\fP \-\- Pass any arguments needed to execute the function(s)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
some_id_of_state:
  module.run:
    \- network.ip_addrs:
      \- interface: eth0
    \- cloud.create:
      \- names:
        \- test\-isbm\-1
        \- test\-isbm\-2
      \- ssh_username: sles
      \- image: sles12sp2
      \- securitygroup: default
      \- size: \(aqc3.large\(aq
      \- location: ap\-northeast\-1
      \- delvol_on_destroy: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.module.wait(name, **kwargs)
Run a single module function only if the watch statement calls it
.INDENT 7.0
.TP
.B \fBname\fP
The module function to execute
.TP
.B \fB**kwargs\fP
Pass any arguments needed to execute the function
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Like the \fI\%cmd.run\fP state, this state will
return \fBTrue\fP but not actually execute, unless one of the following
two things happens:
.INDENT 0.0
.IP 1. 3
The state has a \fI\%watch requisite\fP, and
the state which it is watching changes.
.IP 2. 3
Another state has a \fI\%watch_in requisite\fP which references this state, and the state
wth the \fBwatch_in\fP changes.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.module.watch(name, **kwargs)
This function is an alias of \fBwait\fP\&.
.INDENT 7.0
.INDENT 3.5
Run a single module function only if the watch statement calls it
.INDENT 0.0
.TP
.B \fBname\fP
The module function to execute
.TP
.B \fB**kwargs\fP
Pass any arguments needed to execute the function
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Like the \fI\%cmd.run\fP state, this state will
return \fBTrue\fP but not actually execute, unless one of the following
two things happens:
.INDENT 0.0
.IP 1. 3
The state has a \fI\%watch requisite\fP, and
the state which it is watching changes.
.IP 2. 3
Another state has a \fI\%watch_in requisite\fP which references this state, and the state
wth the \fBwatch_in\fP changes.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.mongodb_database
.SS Management of MongoDB Databases
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
pymongo Python module
.UNINDENT
.UNINDENT
.sp
Only deletion is supported, creation doesn\(aqt make sense and can be done using
\fI\%mongodb_user.present\fP\&.
.INDENT 0.0
.TP
.B salt.states.mongodb_database.absent(name, user=None, password=None, host=None, port=None, authdb=None)
Ensure that the named database is absent. Note that creation doesn\(aqt make
sense in MongoDB.
.INDENT 7.0
.TP
.B name
The name of the database to remove
.TP
.B user
The user to connect as (must be able to create the user)
.TP
.B password
The password of the user
.TP
.B host
The host to connect to
.TP
.B port
The port to connect to
.TP
.B authdb
The database in which to authenticate
.UNINDENT
.UNINDENT
.SS salt.states.mongodb_user
.SS Management of MongoDB Users
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
pymongo Python module
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mongodb_user.absent(name, user=None, password=None, host=None, port=None, database=\(aqadmin\(aq, authdb=None)
Ensure that the named user is absent
.INDENT 7.0
.TP
.B name
The name of the user to remove
.TP
.B user
MongoDB user with sufficient privilege to create the user
.TP
.B password
Password for the admin user specified by the \fBuser\fP parameter
.TP
.B host
The hostname/IP address of the MongoDB server
.TP
.B port
The port on which MongoDB is listening
.TP
.B database
The database from which to remove the user specified by the \fBname\fP
parameter
.TP
.B authdb
The database in which to authenticate
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mongodb_user.present(name, passwd, database=\(aqadmin\(aq, user=None, password=None, host=\(aqlocalhost\(aq, port=27017, authdb=None, roles=None)
Ensure that the user is present with the specified properties
.INDENT 7.0
.TP
.B name
The name of the user to manage
.TP
.B passwd
The password of the user to manage
.TP
.B user
MongoDB user with sufficient privilege to create the user
.TP
.B password
Password for the admin user specified with the \fBuser\fP parameter
.TP
.B host
The hostname/IP address of the MongoDB server
.TP
.B port
The port on which MongoDB is listening
.TP
.B database
The database in which to create the user
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the database doesn\(aqt exist, it will be created.
.UNINDENT
.UNINDENT
.TP
.B authdb
The database in which to authenticate
.TP
.B roles
The roles assigned to user specified with the \fBname\fP parameter
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mongouser\-myapp:
  mongodb_user.present:
  \- name: myapp
  \- passwd: password\-of\-myapp
  \- database: admin
  # Connect as admin:sekrit
  \- user: admin
  \- password: sekrit
  \- roles:
      \- readWrite
      \- userAdmin
      \- dbOwner
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.monit
.SS Monit state
.sp
Manage monit states
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
monit_enable_service_monitoring:
  monit.monitor:
    \- name: service

monit_disable_service_monitoring:
  monit.unmonitor:
    \- name: service
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Use of these states require that the \fI\%monit\fP
execution module is available.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.monit.monitor(name)
Get the summary from module monit and try to see if service is
being monitored. If not then monitor the service.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.monit.unmonitor(name)
Get the summary from module monit and try to see if service is
being monitored. If it is then stop monitoring the service.
.UNINDENT
.SS salt.states.mount
.SS Mounting of filesystems
.sp
Mount any type of mountable filesystem with the mounted function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/mnt/sdb:
  mount.mounted:
    \- device: /dev/sdb1
    \- fstype: ext4
    \- mkmnt: True
    \- opts:
      \- defaults

/srv/bigdata:
  mount.mounted:
    \- device: UUID=066e0200\-2867\-4ebe\-b9e6\-f30026ca2314
    \- fstype: xfs
    \- opts: nobootwait,noatime,nodiratime,nobarrier,logbufs=8
    \- dump: 0
    \- pass_num: 2
    \- persist: True
    \- mkmnt: True

/var/lib/bigdata:
  mount.mounted:
    \- device: /srv/bigdata
    \- fstype: none
    \- opts: bind
    \- dump: 0
    \- pass_num: 0
    \- persist: True
    \- mkmnt: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mount.fstab_absent(name, fs_file, mount_by=None, config=\(aq/etc/fstab\(aq)
Makes sure that a fstab mount point is absent.
.INDENT 7.0
.TP
.B name
The name of block device. Can be any valid fs_spec value.
.TP
.B fs_file
Mount point (target) for the filesystem.
.TP
.B mount_by
Select the final value for fs_spec. Can be [\fBNone\fP,
\fBdevice\fP, \fBlabel\fP, \fBuuid\fP, \fBpartlabel\fP,
\fBpartuuid\fP]. If \fBNone\fP, the value for fs_spect will be the
parameter \fBname\fP, in other case will search the correct
value based on the device name. For example, for \fBuuid\fP, the
value for fs_spec will be of type \(aqUUID=xxx\(aq instead of the
device name set in \fBname\fP\&.
.TP
.B config
Place where the fstab file lives
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mount.fstab_present(name, fs_file, fs_vfstype, fs_mntops=\(aqdefaults\(aq, fs_freq=0, fs_passno=0, mount_by=None, config=\(aq/etc/fstab\(aq, mount=True, match_on=\(aqauto\(aq, not_change=False, fs_mount=True)
Makes sure that a fstab mount point is present.
.INDENT 7.0
.TP
.B name
The name of block device. Can be any valid fs_spec value.
.TP
.B fs_file
Mount point (target) for the filesystem.
.TP
.B fs_vfstype
The type of the filesystem (e.g. ext4, xfs, btrfs, ...)
.TP
.B fs_mntops
The mount options associated with the filesystem. Default is
\fBdefaults\fP\&.
.TP
.B fs_freq
Field is used by dump to determine which fs need to be
dumped. Default is \fB0\fP
.TP
.B fs_passno
Field is used by fsck to determine the order in which
filesystem checks are done at boot time. Default is \fB0\fP
.TP
.B fs_mount
Field is used only in AIX systems to determine if the
filesystem will be mounted by \fBmount all\fP
.TP
.B mount_by
Select the final value for fs_spec. Can be [\fBNone\fP,
\fBdevice\fP, \fBlabel\fP, \fBuuid\fP, \fBpartlabel\fP,
\fBpartuuid\fP]. If \fBNone\fP, the value for fs_spect will be the
parameter \fBname\fP, in other case will search the correct
value based on the device name. For example, for \fBuuid\fP, the
value for fs_spec will be of type \(aqUUID=xxx\(aq instead of the
device name set in \fBname\fP\&.
.TP
.B config
Place where the fstab file lives. Default is \fB/etc/fstab\fP
.TP
.B mount
Set if the mount should be mounted immediately. Default is
\fBTrue\fP
.TP
.B match_on
A name or list of fstab properties on which this state should
be applied.  Default is \fBauto\fP, a special value indicating
to guess based on fstype.  In general, \fBauto\fP matches on
name for recognized special devices and device otherwise.
.TP
.B not_change
By default, if the entry is found in the fstab file but is
different from the expected content (like different options),
the entry will be replaced with the correct content. If this
parameter is set to \fBTrue\fP and the line is found, the
original content will be preserved.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mount.mod_watch(name, user=None, **kwargs)
The mounted watcher, called to invoke the watch command.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state exists to support special handling of the \fBwatch\fP
\fI\%requisite\fP\&. It should not be called directly.
.sp
Parameters for this function should be set by the state being triggered.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the mount point
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mount.mounted(name, device, fstype, mkmnt=False, opts=\(aqdefaults\(aq, dump=0, pass_num=0, config=\(aq/etc/fstab\(aq, persist=True, mount=True, user=None, match_on=\(aqauto\(aq, device_name_regex=None, extra_mount_invisible_options=None, extra_mount_invisible_keys=None, extra_mount_ignore_fs_keys=None, extra_mount_translate_options=None, hidden_opts=None, bind_mount_copy_active_opts=True, **kwargs)
Verify that a device is mounted
.INDENT 7.0
.TP
.B name
The path to the location where the device is to be mounted
.TP
.B device
The device name, typically the device node, such as \fB/dev/sdb1\fP
or \fBUUID=066e0200\-2867\-4ebe\-b9e6\-f30026ca2314\fP or \fBLABEL=DATA\fP
.TP
.B fstype
The filesystem type, this will be \fBxfs\fP, \fBext2/3/4\fP in the case of classic
filesystems, \fBfuse\fP in the case of fuse mounts, and \fBnfs\fP in the case of nfs mounts
.TP
.B mkmnt
If the mount point is not present then the state will fail, set \fBmkmnt: True\fP
to create the mount point if it is otherwise not present
.TP
.B opts
A list object of options or a comma delimited list
.TP
.B dump
The dump value to be passed into the fstab, Default is \fB0\fP
.TP
.B pass_num
The pass value to be passed into the fstab, Default is \fB0\fP
.TP
.B config
Set an alternative location for the fstab, Default is \fB/etc/fstab\fP
.TP
.B persist
Set if the mount should be saved in the fstab, Default is \fBTrue\fP
.TP
.B mount
Set if the mount should be mounted immediately, Default is \fBTrue\fP
.TP
.B user
The account used to execute the mount; this defaults to the user salt is
running as on the minion
.TP
.B match_on
A name or list of fstab properties on which this state should be applied.
Default is \fBauto\fP, a special value indicating to guess based on fstype.
In general, \fBauto\fP matches on name for recognized special devices and
device otherwise.
.TP
.B device_name_regex
A list of device exact names or regular expressions which should
not force a remount. For example, glusterfs may be mounted with a
comma\-separated list of servers in fstab, but the /proc/self/mountinfo
will show only the first available server.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{% set glusterfs_ip_list = [\(aq10.0.0.1\(aq, \(aq10.0.0.2\(aq, \(aq10.0.0.3\(aq] %}

mount glusterfs volume:
  mount.mounted:
    \- name: /mnt/glusterfs_mount_point
    \- device: {{ glusterfs_ip_list|join(\(aq,\(aq) }}:/volume_name
    \- fstype: glusterfs
    \- opts: _netdev,rw,defaults,direct\-io\-mode=disable
    \- mkmnt: True
    \- persist: True
    \- dump: 0
    \- pass_num: 0
    \- device_name_regex:
      \- ({{ glusterfs_ip_list|join(\(aq|\(aq) }}):/volume_name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.TP
.B extra_mount_invisible_options
A list of extra options that are not visible through the
\fB/proc/self/mountinfo\fP interface.
.sp
If a option is not visible through this interface it will always remount
the device. This option extends the builtin \fBmount_invisible_options\fP
list.
.TP
.B extra_mount_invisible_keys
A list of extra key options that are not visible through the
\fB/proc/self/mountinfo\fP interface.
.sp
If a key option is not visible through this interface it will always
remount the device. This option extends the builtin
\fBmount_invisible_keys\fP list.
.sp
A good example for a key option is the password option:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
password=badsecret
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B extra_mount_ignore_fs_keys
A dict of filesystem options which should not force a remount. This will update
the internal dictionary. The dict should look like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqramfs\(aq: [\(aqsize\(aq]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B extra_mount_translate_options
A dict of mount options that gets translated when mounted. To prevent a remount
add additional options to the default dictionary. This will update the internal
dictionary. The dictionary should look like this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqtcp\(aq: \(aqproto=tcp\(aq,
    \(aqudp\(aq: \(aqproto=udp\(aq
}
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B hidden_opts
A list of mount options that will be ignored when considering a remount
as part of the state application
.sp
New in version 2015.8.2.

.TP
.B bind_mount_copy_active_opts
If set to \fBFalse\fP, this option disables the default behavior of
copying the options from the bind mount if it was found to be active.
.sp
New in version 3006.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mount.swap(name, persist=True, config=\(aq/etc/fstab\(aq)
Activates a swap device
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/root/swapfile:
  mount.swap
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBswap\fP does not currently support LABEL
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mount.unmounted(name, device=None, config=\(aq/etc/fstab\(aq, persist=False, user=None, **kwargs)
New in version 0.17.0.

.sp
Verify that a device is not mounted
.INDENT 7.0
.TP
.B name
The path to the location where the device is to be unmounted from
.TP
.B device
The device to be unmounted.  This is optional because the device could
be mounted in multiple places.
.sp
New in version 2015.5.0.

.TP
.B config
Set an alternative location for the fstab, Default is \fB/etc/fstab\fP
.TP
.B persist
Set if the mount should be purged from the fstab, Default is \fBFalse\fP
.TP
.B user
The user to own the mount; this defaults to the user salt is
running as on the minion
.UNINDENT
.UNINDENT
.SS salt.states.mssql_database
.SS Management of Microsoft SQLServer Databases
.sp
The mssql_database module is used to create
and manage SQL Server Databases
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
yolo:
  mssql_database.present
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mssql_database.absent(name, **kwargs)
Ensure that the named database is absent
.INDENT 7.0
.TP
.B name
The name of the database to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mssql_database.present(name, containment=\(aqNONE\(aq, options=None, **kwargs)
Ensure that the named database is present with the specified options
.INDENT 7.0
.TP
.B name
The name of the database to manage
.TP
.B containment
Defaults to NONE
.TP
.B options
Can be a list of strings, a dictionary, or a list of dictionaries
.UNINDENT
.UNINDENT
.SS salt.states.mssql_login
.SS Management of Microsoft SQLServer Logins
.sp
The mssql_login module is used to create
and manage SQL Server Logins
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
frank:
  mssql_login.present
    \- domain: mydomain
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mssql_login.absent(name, **kwargs)
Ensure that the named login is absent
.INDENT 7.0
.TP
.B name
The name of the login to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mssql_login.present(name, password=None, domain=None, server_roles=None, options=None, **kwargs)
Checks existence of the named login.
If not present, creates the login with the specified roles and options.
.INDENT 7.0
.TP
.B name
The name of the login to manage
.TP
.B password
Creates a SQL Server authentication login
Since hashed passwords are varbinary values, if the
new_login_password is \(aqlong\(aq, it will be considered
to be HASHED.
.TP
.B domain
Creates a Windows authentication login.
Needs to be NetBIOS domain or hostname
.TP
.B server_roles
Add this login to all the server roles in the list
.TP
.B options
Can be a list of strings, a dictionary, or a list of dictionaries
.UNINDENT
.UNINDENT
.SS salt.states.mssql_role
.SS Management of Microsoft SQLServer Databases
.sp
The mssql_role module is used to create
and manage SQL Server Roles
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
yolo:
  mssql_role.present
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mssql_role.absent(name, **kwargs)
Ensure that the named database is absent
.INDENT 7.0
.TP
.B name
The name of the database to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mssql_role.present(name, owner=None, grants=None, **kwargs)
Ensure that the named database is present with the specified options
.INDENT 7.0
.TP
.B name
The name of the database to manage
.TP
.B owner
Adds owner using AUTHORIZATION option
.TP
.B Grants
Can only be a list of strings
.UNINDENT
.UNINDENT
.SS salt.states.mssql_user
.SS Management of Microsoft SQLServer Users
.sp
The mssql_user module is used to create
and manage SQL Server Users
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
frank:
  mssql_user.present:
    \- database: yolo
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mssql_user.absent(name, **kwargs)
Ensure that the named user is absent
.INDENT 7.0
.TP
.B name
The username of the user to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mssql_user.present(name, login=None, domain=None, database=None, roles=None, options=None, **kwargs)
Checks existence of the named user.
If not present, creates the user with the specified roles and options.
.INDENT 7.0
.TP
.B name
The name of the user to manage
.TP
.B login
If not specified, will be created WITHOUT LOGIN
.TP
.B domain
Creates a Windows authentication user.
Needs to be NetBIOS domain or hostname
.TP
.B database
The database of the user (not the login)
.TP
.B roles
Add this user to all the roles in the list
.TP
.B options
Can be a list of strings, a dictionary, or a list of dictionaries
.UNINDENT
.UNINDENT
.SS salt.states.msteams
.SS Send a message card to Microsoft Teams
.sp
This state is useful for sending messages to Teams during state runs.
.sp
New in version 2017.7.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
teams\-message:
  msteams.post_card:
    \- message: \(aqThis state was executed successfully.\(aq
    \- hook_url:  https://outlook.office.com/webhook/837
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The hook_url can be specified in the master or minion configuration like below:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
msteams:
  hook_url: https://outlook.office.com/webhook/837
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.msteams.post_card(name, message, hook_url=None, title=None, theme_color=None)
Send a message to a Microsft Teams channel
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
send\-msteams\-message:
  msteams.post_card:
    \- message: \(aqThis state was executed successfully.\(aq
    \- hook_url: https://outlook.office.com/webhook/837
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B message
The message that is to be sent to the MS Teams channel.
.UNINDENT
.sp
The following parameters are optional:
.INDENT 7.0
.TP
.B hook_url
The webhook URL given configured in Teams interface,
if not specified in the configuration options of master or minion.
.TP
.B title
The title for the card posted to the channel
.TP
.B theme_color
A hex code for the desired highlight color
.UNINDENT
.UNINDENT
.SS salt.states.mysql_database
.SS Management of MySQL databases (schemas)
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
MySQLdb Python module
.UNINDENT
.TP
.B configuration
See \fI\%salt.modules.mysql\fP for setup instructions.
.UNINDENT
.sp
The mysql_database module is used to create and manage MySQL databases.
Databases can be set as either absent or present.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
frank:
  mysql_database.present
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mysql_database.absent(name, **connection_args)
Ensure that the named database is absent
.INDENT 7.0
.TP
.B name
The name of the database to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mysql_database.present(name, character_set=None, collate=None, **connection_args)
Ensure that the named database is present with the specified properties
.INDENT 7.0
.TP
.B name
The name of the database to manage
.UNINDENT
.UNINDENT
.SS salt.states.mysql_grants
.SS Management of MySQL grants (user permissions)
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
MySQLdb Python module
.UNINDENT
.TP
.B configuration
See \fI\%salt.modules.mysql\fP for setup instructions.
.UNINDENT
.sp
The mysql_grants module is used to grant and revoke MySQL permissions.
.sp
The \fBname\fP you pass in purely symbolic and does not have anything to do
with the grant itself.
.sp
The \fBdatabase\fP parameter needs to specify a \(aqpriv_level\(aq in the same
specification as defined in the MySQL documentation:
.INDENT 0.0
.IP \(bu 2
*
.IP \(bu 2
*.*
.IP \(bu 2
db_name.*
.IP \(bu 2
db_name.tbl_name
.IP \(bu 2
etc...
.UNINDENT
.sp
This state is not able to set password for the permission from the
specified host. See \fI\%salt.states.mysql_user\fP for further
instructions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
frank_exampledb:
   mysql_grants.present:
    \- grant: select,insert,update
    \- database: exampledb.*
    \- user: frank
    \- host: localhost

frank_otherdb:
  mysql_grants.present:
    \- grant: all privileges
    \- database: otherdb.*
    \- user: frank

restricted_singletable:
  mysql_grants.present:
    \- grant: select
    \- database: somedb.sometable
    \- user: joe
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mysql_grants.absent(name, grant=None, database=None, user=None, host=\(aqlocalhost\(aq, grant_option=False, escape=True, **connection_args)
Ensure that the grant is absent
.INDENT 7.0
.TP
.B name
The name (key) of the grant to add
.TP
.B grant
The grant priv_type (i.e. select,insert,update OR all privileges)
.TP
.B database
The database priv_level (i.e. db.tbl OR db.*)
.TP
.B user
The user to apply the grant to
.TP
.B host
The network/host that the grant should apply to
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mysql_grants.present(name, grant=None, database=None, user=None, host=\(aqlocalhost\(aq, grant_option=False, escape=True, revoke_first=False, ssl_option=False, **connection_args)
Ensure that the grant is present with the specified properties
.INDENT 7.0
.TP
.B name
The name (key) of the grant to add
.TP
.B grant
The grant priv_type (i.e. select,insert,update OR all privileges)
.TP
.B database
The database priv_level (i.e. db.tbl OR db.*)
.TP
.B user
The user to apply the grant to
.TP
.B host
The network/host that the grant should apply to
.TP
.B grant_option
Adds the WITH GRANT OPTION to the defined grant. Default is \fBFalse\fP
.TP
.B escape
Defines if the database value gets escaped or not. Default is \fBTrue\fP
.TP
.B revoke_first
By default, MySQL will not do anything if you issue a command to grant
privileges that are more restrictive than what\(aqs already in place. This
effectively means that you cannot downgrade permissions without first
revoking permissions applied to a db.table/user pair first.
.sp
To have Salt forcibly revoke perms before applying a new grant, enable
the \(aqrevoke_first options.
.sp
WARNING: This will \fIremove\fP permissions for a database before attempting
to apply new permissions. There is no guarantee that new permissions
will be applied correctly which can leave your database security in an
unknown and potentially dangerous state.
Use with caution!
.sp
Default is \fBFalse\fP
.TP
.B ssl_option
Adds the specified ssl options for the connecting user as requirements for
this grant. Value is a list of single\-element dicts corresponding to the
list of ssl options to use.
.sp
Possible key/value pairings for the dicts in the value:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- SSL: True
\- X509: True
\- SUBJECT: <subject>
\- ISSUER: <issuer>
\- CIPHER: <cipher>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The non\-boolean ssl options take a string as their values, which should
be an appropriate value as specified by the MySQL documentation for these
options.
.sp
Default is \fBFalse\fP (no ssl options will be used)
.UNINDENT
.UNINDENT
.SS salt.states.mysql_query
.SS Execution of MySQL queries
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
MySQLdb Python module
.UNINDENT
.TP
.B configuration
See \fI\%salt.modules.mysql\fP for setup instructions.
.UNINDENT
.sp
The mysql_query module is used to execute queries on MySQL databases.
Its output may be stored in a file or in a grain.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
query_id:
  mysql_query.run
    \- database: my_database
    \- query:    \(dqSELECT * FROM table;\(dq
    \- output:   \(dq/tmp/query_id.txt\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mysql_query.run(name, database, query, output=None, grain=None, key=None, overwrite=True, check_db_exists=True, client_flags=None, **connection_args)
Execute an arbitrary query on the specified database
.INDENT 7.0
.TP
.B name
Used only as an ID
.TP
.B database
The name of the database to execute the query on
.TP
.B query
The query to execute
.TP
.B output
grain: output in a grain
other: the file to store results
None:  output to the result comment (default)
.TP
.B grain:
grain to store the output (need output=grain)
.TP
.B key:
the specified grain will be treated as a dictionary, the result
of this state will be stored under the specified key.
.TP
.B overwrite:
The file or grain will be overwritten if it already exists (default)
.TP
.B check_db_exists:
The state run will check that the specified database exists (default=True)
before running any queries
.TP
.B client_flags:
A list of client flags to pass to the MySQL connection.
\fI\%https://dev.mysql.com/doc/internals/en/capability\-flags.html\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mysql_query.run_file(name, database, query_file=None, output=None, grain=None, key=None, overwrite=True, saltenv=None, check_db_exists=True, client_flags=None, **connection_args)
Execute an arbitrary query on the specified database
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B name
Used only as an ID
.TP
.B database
The name of the database to execute the query_file on
.TP
.B query_file
The file of mysql commands to run
.TP
.B output
grain: output in a grain
other: the file to store results
None:  output to the result comment (default)
.TP
.B grain:
grain to store the output (need output=grain)
.TP
.B key:
the specified grain will be treated as a dictionary, the result
of this state will be stored under the specified key.
.TP
.B overwrite:
The file or grain will be overwritten if it already exists (default)
.TP
.B saltenv:
The saltenv to pull the query_file from
.TP
.B check_db_exists:
The state run will check that the specified database exists (default=True)
before running any queries
.TP
.B client_flags:
A list of client flags to pass to the MySQL connection.
\fI\%https://dev.mysql.com/doc/internals/en/capability\-flags.html\fP
.UNINDENT
.UNINDENT
.SS salt.states.mysql_user
.SS Management of MySQL users
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
MySQLdb Python module
.UNINDENT
.TP
.B configuration
See \fI\%salt.modules.mysql\fP for setup instructions.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
frank:
  mysql_user.present:
    \- host: localhost
    \- password: bobcat
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 0.16.2: Authentication overrides have been added.

.sp
The MySQL authentication information specified in the minion config file can be
overridden in states using the following arguments: \fBconnection_host\fP,
\fBconnection_port\fP, \fBconnection_user\fP, \fBconnection_pass\fP,
\fBconnection_db\fP, \fBconnection_unix_socket\fP, \fBconnection_default_file\fP and
\fBconnection_charset\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
frank:
  mysql_user.present:
    \- host: localhost
    \- password: \(dqbob@cat\(dq
    \- connection_user: someuser
    \- connection_pass: somepass
    \- connection_charset: utf8
    \- saltenv:
      \- LC_ALL: \(dqen_US.utf8\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This state is not able to grant permissions for the user. See
\fI\%salt.states.mysql_grants\fP for further instructions.
.INDENT 0.0
.TP
.B salt.states.mysql_user.absent(name, host=\(aqlocalhost\(aq, **connection_args)
Ensure that the named user is absent
.INDENT 7.0
.TP
.B name
The name of the user to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.mysql_user.present(name, host=\(aqlocalhost\(aq, password=None, password_hash=None, allow_passwordless=False, unix_socket=False, password_column=None, auth_plugin=\(aqmysql_native_password\(aq, **connection_args)
Ensure that the named user is present with the specified properties. A
passwordless user can be configured by omitting \fBpassword\fP and
\fBpassword_hash\fP, and setting \fBallow_passwordless\fP to \fBTrue\fP\&.
.INDENT 7.0
.TP
.B name
The name of the user to manage
.TP
.B host
Host for which this user/password combo applies
.TP
.B password
The password to use for this user. Will take precedence over the
\fBpassword_hash\fP option if both are specified.
.TP
.B password_hash
The password in hashed form. Be sure to quote the password because YAML
doesn\(aqt like the \fB*\fP\&. A password hash can be obtained from the mysql
command\-line client like so:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mysql> SELECT PASSWORD(\(aqmypass\(aq);
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
| PASSWORD(\(aqmypass\(aq)                        |
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
| *6C8989366EAF75BB670AD8EA7A7FC1176A95CEF4 |
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
1 row in set (0.00 sec)
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B allow_passwordless
If \fBTrue\fP, then \fBpassword\fP and \fBpassword_hash\fP can be omitted to
permit a passwordless login.
.sp
New in version 0.16.2.

.TP
.B unix_socket
If \fBTrue\fP and allow_passwordless is \fBTrue\fP, the unix_socket auth
plugin will be used.
.UNINDENT
.UNINDENT
.SS salt.states.net_napalm_yang
.SS NAPALM YANG state
.sp
Manage the configuration of network devices according to
the YANG models (OpenConfig/IETF).
.sp
New in version 2017.7.0.

.SS Dependencies
.INDENT 0.0
.IP \(bu 2
napalm\-yang
.IP \(bu 2
pyangbing > 0.5.11
.UNINDENT
.sp
To be able to load configuration on network devices,
it requires \fI\%NAPALM\fP library to be installed:  \fBpip install napalm\fP\&.
Please check \fI\%Installation\fP for complete details.
.INDENT 0.0
.TP
.B salt.states.net_napalm_yang.configured(name, data, **kwargs)
Configure the network device, given the input data strucuted
according to the YANG models.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The main difference between this function and \fBmanaged\fP
is that the later generates and loads the configuration
only when there are differences between the existing
configuration on the device and the expected
configuration. Depending on the platform and hardware
capabilities, one could be more optimal than the other.
Additionally, the output of the \fBmanaged\fP is different,
in such a way that the \fBpchange\fP field in the output
contains structured data, rather than text.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B data
YANG structured data.
.TP
.B models
A list of models to be used when generating the config.
.TP
.B profiles: \fBNone\fP
Use certain profiles to generate the config.
If not specified, will use the platform default profile(s).
.TP
.B test: \fBFalse\fP
Dry run? If set as \fBTrue\fP, will apply the config, discard
and return the changes. Default: \fBFalse\fP and will commit
the changes on the device.
.TP
.B commit: \fBTrue\fP
Commit? Default: \fBTrue\fP\&.
.TP
.B debug: \fBFalse\fP
Debug mode. Will insert a new key under the output dictionary,
as \fBloaded_config\fP containing the raw configuration loaded on the device.
.TP
.B replace: \fBFalse\fP
Should replace the config with the new generate one?
.UNINDENT
.sp
State SLS example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set expected_config =  pillar.get(\(aqopenconfig_interfaces_cfg\(aq) \-%}
interfaces_config:
  napalm_yang.configured:
    \- data: {{ expected_config | json }}
    \- models:
      \- models.openconfig_interfaces
    \- debug: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pillar example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
openconfig_interfaces_cfg:
  _kwargs:
    filter: true
  interfaces:
    interface:
      Et1:
        config:
          mtu: 9000
      Et2:
        config:
          description: \(dqdescription example\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.net_napalm_yang.managed(name, data, **kwargs)
Manage the device configuration given the input data structured
according to the YANG models.
.INDENT 7.0
.TP
.B data
YANG structured data.
.TP
.B models
A list of models to be used when generating the config.
.TP
.B profiles: \fBNone\fP
Use certain profiles to generate the config.
If not specified, will use the platform default profile(s).
.TP
.B compliance_report: \fBFalse\fP
Return the compliance report in the comment.
.sp
New in version 2017.7.3.

.TP
.B test: \fBFalse\fP
Dry run? If set as \fBTrue\fP, will apply the config, discard
and return the changes. Default: \fBFalse\fP and will commit
the changes on the device.
.TP
.B commit: \fBTrue\fP
Commit? Default: \fBTrue\fP\&.
.TP
.B debug: \fBFalse\fP
Debug mode. Will insert a new key under the output dictionary,
as \fBloaded_config\fP containing the raw configuration loaded on the device.
.TP
.B replace: \fBFalse\fP
Should replace the config with the new generate one?
.UNINDENT
.sp
State SLS example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set expected_config =  pillar.get(\(aqopenconfig_interfaces_cfg\(aq) \-%}
interfaces_config:
  napalm_yang.managed:
    \- data: {{ expected_config | json }}
    \- models:
      \- models.openconfig_interfaces
    \- debug: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pillar example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
openconfig_interfaces_cfg:
  _kwargs:
    filter: true
  interfaces:
    interface:
      Et1:
        config:
          mtu: 9000
      Et2:
        config:
          description: \(dqdescription example\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.netacl
.SS Network ACL
.sp
Manage the firewall configuration on the network device managed through NAPALM.
The firewall configuration is generated by \fI\%Capirca\fP\&.
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP>
.TP
.B maturity
new
.TP
.B depends
capirca, napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.SS Capirca
.sp
To install Capirca, execute: \fBpip install capirca\fP\&.
.SS NAPALM
.sp
To be able to load configuration on network devices,
it requires \fI\%NAPALM\fP library to be installed:  \fBpip install napalm\fP\&.
Please check \fI\%Installation\fP for complete details.
.INDENT 0.0
.TP
.B salt.states.netacl.filter(name, filter_name, filter_options=None, terms=None, prepend=True, pillar_key=\(aqacl\(aq, pillarenv=None, saltenv=None, merge_pillar=False, only_lower_merge=False, revision_id=None, revision_no=None, revision_date=True, revision_date_format=\(aq%Y/%m/%d\(aq, test=False, commit=True, debug=False)
Generate and load the configuration of a policy filter.
.INDENT 7.0
.TP
.B filter_name
The name of the policy filter.
.TP
.B filter_options
Additional filter options. These options are platform\-specific.
See the complete list of \fI\%options\fP\&.
.TP
.B terms
Dictionary of terms for this policy filter.
If not specified or empty, will try to load the configuration from the pillar,
unless \fBmerge_pillar\fP is set as \fBFalse\fP\&.
.TP
.B prepend: \fBTrue\fP
When \fBmerge_pillar\fP is set as \fBTrue\fP, the final list of terms generated by merging
the terms from \fBterms\fP with those defined in the pillar (if any): new terms are prepended
at the beginning, while existing ones will preserve the position. To add the new terms
at the end of the list, set this argument to \fBFalse\fP\&.
.TP
.B pillar_key: \fBacl\fP
The key in the pillar containing the default attributes values. Default: \fBacl\fP\&.
.TP
.B pillarenv
Query the master to generate fresh pillar data on the fly,
specifically from the requested pillar environment.
.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.TP
.B merge_pillar: \fBFalse\fP
Merge \fBterms\fP with the corresponding value from the pillar. Default: \fBFalse\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
By default this state does not merge, to avoid any unexpected behaviours.
.sp
The merge logic depends on the \fBprepend\fP argument.
.sp
The terms specified through the \fBterms\fP argument have higher priority
than the pillar.
.UNINDENT
.UNINDENT
.TP
.B only_lower_merge: \fBFalse\fP
Specify if it should merge only the terms fields. Otherwise it will try
to merge also filters fields. Default: \fBFalse\fP\&.
This option requires \fBmerge_pillar\fP, otherwise it is ignored.
.TP
.B revision_id
Add a comment in the filter config having the description for the changes applied.
.TP
.B revision_no
The revision count.
.TP
.B revision_date: \fBTrue\fP
Boolean flag: display the date when the filter configuration was generated. Default: \fBTrue\fP\&.
.TP
.B revision_date_format: \fB%Y/%m/%d\fP
The date format to be used when generating the perforce data. Default: \fB%Y/%m/%d\fP (<year>/<month>/<day>).
.TP
.B test: \fBFalse\fP
Dry run? If set as \fBTrue\fP, will apply the config, discard and return the changes.
Default: \fBFalse\fP and will commit the changes on the device.
.TP
.B commit: \fBTrue\fP
Commit? Default: \fBTrue\fP\&.
.TP
.B debug: \fBFalse\fP
Debug mode. Will insert a new key under the output dictionary,
as \fBloaded_config\fP containing the raw configuration loaded on the device.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqedge01.flw01\(aq state.sls router.acl test=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
edge01.flw01:
\-\-\-\-\-\-\-\-\-\-
          ID: my\-filter
    Function: netacl.filter
      Result: None
     Comment: Testing mode: Configuration discarded.
     Started: 12:24:40.598232
    Duration: 2437.139 ms
     Changes:
              \-\-\-\-\-\-\-\-\-\-
              diff:
                  \-\-\-
                  +++
                  @@ \-1228,9 +1228,24 @@
                  !
                  +ipv4 access\-list my\-filter
                  + 10 remark $Id: my\-filter_state $
                  + 20 remark $Revision: 5 $
                  + 30 remark my\-other\-term
                  + 40 permit tcp any range 5678 5680 any
                  +!
                  +!
              loaded:
                  ! $Id: my\-filter_state $
                  ! $Revision: 5 $
                  no ipv6 access\-list my\-filter
                  ipv6 access\-list my\-filter
                   remark $Id: my\-filter_state $
                   remark $Revision: 5 $
                   remark my\-other\-term
                   permit tcp any range 5678 5680 any
                  exit

Summary for edge01.flw01
\-\-\-\-\-\-\-\-\-\-\-\-
Succeeded: 1 (unchanged=1, changed=1)
Failed:    0
\-\-\-\-\-\-\-\-\-\-\-\-
Total states run:     1
Total run time:   2.437 s
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pillar example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
acl:
  \- my\-filter:
      options:
        \- inet6
      terms:
        \- my\-term:
            source_port: [1234, 1235]
            protocol:
              \- tcp
              \- udp
            source_address: 1.2.3.4
            action: reject
        \- my\-other\-term:
            source_port:
              \- [5678, 5680]
            protocol: tcp
            action: accept
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
State SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set filter_name = \(aqmy\-filter\(aq \-%}
{%\- set my_filter_cfg = salt.netacl.get_filter_pillar(filter_name, pillar_key=\(aqfirewall\(aq) \-%}
my_first_filter_state:
  netacl.filter:
    \- filter_name: {{ filter_name }}
    \- options: {{ my_filter_cfg[\(aqoptions\(aq] | json }}
    \- terms: {{ my_filter_cfg[\(aqterms\(aq] | json }}
    \- revision_date: false
    \- revision_no: 5
    \- debug: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my_first_filter_state:
  netacl.filter:
    \- filter_name: my\-filter
    \- merge_pillar: true
    \- pillar_key: firewall
    \- revision_date: false
    \- revision_no: 5
    \- debug: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the example above, as \fBinet6\fP has been specified in the \fBfilter_options\fP,
the configuration chunk referring to \fBmy\-term\fP has been ignored as it referred to
IPv4 only (from \fBsource_address\fP field).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The first method allows the user to eventually apply complex manipulation
and / or retrieve the data from external services before passing the
data to the state. The second one is more straightforward, for less
complex cases when loading the data directly from the pillar is sufficient.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When passing retrieved pillar data into the state file, it is strongly
recommended to use the json serializer explicitly (\(ga\(ga | json\(ga\(ga),
instead of relying on the default Python serializer.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.netacl.managed(name, filters=None, prepend=True, pillar_key=\(aqacl\(aq, pillarenv=None, saltenv=None, merge_pillar=False, only_lower_merge=False, revision_id=None, revision_no=None, revision_date=True, revision_date_format=\(aq%Y/%m/%d\(aq, test=False, commit=True, debug=False)
Manage the whole firewall configuration.
.INDENT 7.0
.TP
.B filters
Dictionary of filters for this policy.
If not specified or empty, will try to load the configuration from the pillar,
unless \fBmerge_pillar\fP is set as \fBFalse\fP\&.
.TP
.B prepend: \fBTrue\fP
When \fBmerge_pillar\fP is set as \fBTrue\fP, the final list of filters generated by merging
the filters from \fBfilters\fP with those defined in the pillar (if any): new filters are prepended
at the beginning, while existing ones will preserve the position. To add the new filters
at the end of the list, set this argument to \fBFalse\fP\&.
.TP
.B pillar_key: \fBacl\fP
The key in the pillar containing the default attributes values. Default: \fBacl\fP\&.
.TP
.B pillarenv
Query the master to generate fresh pillar data on the fly,
specifically from the requested pillar environment.
.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.TP
.B merge_pillar: \fBFalse\fP
Merge the \fBfilters\fP will the corresponding values from the pillar. Default: \fBFalse\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
By default this state does not merge, to avoid any unexpected behaviours.
.sp
The merge logic depends on the \fBprepend\fP argument.
.sp
The filters specified through the \fBfilters\fP argument have higher priority
than the pillar.
.UNINDENT
.UNINDENT
.TP
.B only_lower_merge: \fBFalse\fP
Specify if it should merge only the filters and terms fields. Otherwise it will try
to merge everything at the policy level. Default: \fBFalse\fP\&.
This option requires \fBmerge_pillar\fP, otherwise it is ignored.
.TP
.B test: \fBFalse\fP
Dry run? If set as \fBTrue\fP, will apply the config, discard and return the changes.
Default: \fBFalse\fP and will commit the changes on the device.
.TP
.B revision_id
Add a comment in the policy config having the description for the changes applied.
.TP
.B revision_no
The revision count.
.TP
.B revision_date: \fBTrue\fP
Boolean flag: display the date when the policy configuration was generated. Default: \fBTrue\fP\&.
.TP
.B revision_date_format: \fB%Y/%m/%d\fP
The date format to be used when generating the perforce data. Default: \fB%Y/%m/%d\fP (<year>/<month>/<day>).
.TP
.B commit: \fBTrue\fP
Commit? Default: \fBTrue\fP\&.
.TP
.B debug: \fBFalse\fP
Debug mode. Will insert a new key under the output dictionary,
as \fBloaded_config\fP containing the raw configuration loaded on the device.
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqedge01.bjm01\(aq state.sls router.acl test=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
edge01.bjm01:
\-\-\-\-\-\-\-\-\-\-\-\-\-
              ID: netacl_example
        Function: netacl.managed
          Result: None
         Comment: Testing mode: Configuration discarded.
         Started: 12:03:24.807023
        Duration: 5569.453 ms
         Changes:
                  \-\-\-\-\-\-\-\-\-\-
                  diff:
                      [edit firewall]
                      +    family inet {
                      +        /*
                      +         ** $Id: netacl_example $
                      +         ** $Date: 2017/07/03 $
                      +         ** $Revision: 2 $
                      +         **
                      +         */
                      +        filter my\-filter {
                      +            interface\-specific;
                      +            term my\-term {
                      +                from {
                      +                    source\-address {
                      +                        1.2.3.4/32;
                      +                    }
                      +                    protocol [ tcp udp ];
                      +                    source\-port [ 1234 1235 ];
                      +                }
                      +                then {
                      +                    reject;
                      +                }
                      +            }
                      +            term my\-other\-term {
                      +                from {
                      +                    protocol tcp;
                      +                    source\-port 5678\-5680;
                      +                }
                      +                then accept;
                      +            }
                      +        }
                      +        /*
                      +         ** $Id: netacl_example $
                      +         ** $Date: 2017/07/03 $
                      +         ** $Revision: 2 $
                      +         **
                      +         */
                      +        filter block\-icmp {
                      +            interface\-specific;
                      +            term first\-term {
                      +                from {
                      +                    protocol icmp;
                      +                }
                      +                then {
                      +                    reject;
                      +                }
                      +            }
                      +        }
                      +    }
                  loaded:
                      firewall {
                          family inet {
                              replace:
                              /*
                              ** $Id: netacl_example $
                              ** $Date: 2017/07/03 $
                              ** $Revision: 2 $
                              **
                              */
                              filter my\-filter {
                                  interface\-specific;
                                  term my\-term {
                                      from {
                                          source\-address {
                                              1.2.3.4/32;
                                          }
                                          protocol [ tcp udp ];
                                          source\-port [ 1234 1235 ];
                                      }
                                      then {
                                          reject;
                                      }
                                  }
                                  term my\-other\-term {
                                      from {
                                          protocol tcp;
                                          source\-port 5678\-5680;
                                      }
                                      then accept;
                                  }
                              }
                          }
                      }
                      firewall {
                          family inet {
                              replace:
                              /*
                              ** $Id: netacl_example $
                              ** $Date: 2017/07/03 $
                              ** $Revision: 2 $
                              **
                              */
                              filter block\-icmp {
                                  interface\-specific;
                                  term first\-term {
                                      from {
                                          protocol icmp;
                                      }
                                      then {
                                          reject;
                                      }
                                  }
                              }
                          }
                      }

    Summary for edge01.bjm01
    \-\-\-\-\-\-\-\-\-\-\-\-
    Succeeded: 1 (unchanged=1, changed=1)
    Failed:    0
    \-\-\-\-\-\-\-\-\-\-\-\-
    Total states run:     1
    Total run time:   5.569 s
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The policy configuration has been loaded from the pillar, having the following structure:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
firewall:
  \- my\-filter:
      terms:
        \- my\-term:
            source_port: [1234, 1235]
            protocol:
              \- tcp
              \- udp
            source_address: 1.2.3.4
            action: reject
        \- my\-other\-term:
            source_port:
              \- [5678, 5680]
            protocol: tcp
            action: accept
  \- block\-icmp:
      terms:
        \- first\-term:
            protocol:
              \- icmp
            action: reject
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example SLS file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set fw_filters = pillar.get(\(aqfirewall\(aq, {}) \-%}
netacl_example:
  netacl.managed:
    \- filters: {{ fw_filters | json }}
    \- revision_no: 2
    \- debug: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
netacl_example:
  netacl.managed:
    \- pillar_key: firewall
    \- merge_pillar: true
    \- revision_no: 2
    \- debug: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The first method allows the user to eventually apply complex manipulation
and / or retrieve the data from external services before passing the
data to the state. The second one is more straightforward, for less
complex cases when loading the data directly from the pillar is sufficient.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When passing retrieved pillar data into the state file, it is strongly
recommended to use the json serializer explicitly (\(ga\(ga | json\(ga\(ga),
instead of relying on the default Python serializer.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.netacl.term(name, filter_name, term_name, filter_options=None, pillar_key=\(aqacl\(aq, pillarenv=None, saltenv=None, merge_pillar=False, revision_id=None, revision_no=None, revision_date=True, revision_date_format=\(aq%Y/%m/%d\(aq, test=False, commit=True, debug=False, source_service=None, destination_service=None, **term_fields)
Manage the configuration of a specific policy term.
.INDENT 7.0
.TP
.B filter_name
The name of the policy filter.
.TP
.B term_name
The name of the term.
.TP
.B filter_options
Additional filter options. These options are platform\-specific.
See the complete list of \fI\%options\fP\&.
.TP
.B pillar_key: \fBacl\fP
The key in the pillar containing the default attributes values. Default: \fBacl\fP\&.
.TP
.B pillarenv
Query the master to generate fresh pillar data on the fly,
specifically from the requested pillar environment.
.TP
.B saltenv
Included only for compatibility with
\fI\%pillarenv_from_saltenv\fP, and is otherwise ignored.
.TP
.B merge_pillar: \fBFalse\fP
Merge the CLI variables with the pillar. Default: \fBFalse\fP\&.
.sp
The properties specified through the state arguments have higher priority than the pillar.
.TP
.B revision_id
Add a comment in the term config having the description for the changes applied.
.TP
.B revision_no
The revision count.
.TP
.B revision_date: \fBTrue\fP
Boolean flag: display the date when the term configuration was generated. Default: \fBTrue\fP\&.
.TP
.B revision_date_format: \fB%Y/%m/%d\fP
The date format to be used when generating the perforce data. Default: \fB%Y/%m/%d\fP (<year>/<month>/<day>).
.TP
.B test: \fBFalse\fP
Dry run? If set as \fBTrue\fP, will apply the config, discard and return the changes.
Default: \fBFalse\fP and will commit the changes on the device.
.TP
.B commit: \fBTrue\fP
Commit? Default: \fBTrue\fP\&.
.TP
.B debug: \fBFalse\fP
Debug mode. Will insert a new key under the output dictionary,
as \fBloaded_config\fP containing the raw configuration loaded on the device.
.TP
.B source_service
A special service to choose from. This is a helper so the user is able to
select a source just using the name, instead of specifying a source_port and protocol.
.sp
As this module is available on Unix platforms only,
it reads the \fI\%IANA\fP port assignment from /etc/services.
.sp
If the user requires additional shortcuts to be referenced, they can add entries under /etc/services,
which can be managed using the \fI\%file state\fP\&.
.TP
.B destination_service
A special service to choose from. This is a helper so the user is able to
select a source just using the name, instead of specifying a destination_port and protocol.
Allows the same options as \fBsource_service\fP\&.
.TP
.B term_fields
Term attributes. To see what fields are supported, please consult the
list of supported \fI\%keywords\fP\&. Some platforms have few other \fI\%optional\fP
keywords.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The following fields are accepted:
.INDENT 0.0
.IP \(bu 2
action
.IP \(bu 2
address
.IP \(bu 2
address_exclude
.IP \(bu 2
comment
.IP \(bu 2
counter
.IP \(bu 2
expiration
.IP \(bu 2
destination_address
.IP \(bu 2
destination_address_exclude
.IP \(bu 2
destination_port
.IP \(bu 2
destination_prefix
.IP \(bu 2
forwarding_class
.IP \(bu 2
forwarding_class_except
.IP \(bu 2
logging
.IP \(bu 2
log_name
.IP \(bu 2
loss_priority
.IP \(bu 2
option
.IP \(bu 2
policer
.IP \(bu 2
port
.IP \(bu 2
precedence
.IP \(bu 2
principals
.IP \(bu 2
protocol
.IP \(bu 2
protocol_except
.IP \(bu 2
qos
.IP \(bu 2
pan_application
.IP \(bu 2
routing_instance
.IP \(bu 2
source_address
.IP \(bu 2
source_address_exclude
.IP \(bu 2
source_port
.IP \(bu 2
source_prefix
.IP \(bu 2
verbatim
.IP \(bu 2
packet_length
.IP \(bu 2
fragment_offset
.IP \(bu 2
hop_limit
.IP \(bu 2
icmp_type
.IP \(bu 2
ether_type
.IP \(bu 2
traffic_class_count
.IP \(bu 2
traffic_type
.IP \(bu 2
translated
.IP \(bu 2
dscp_set
.IP \(bu 2
dscp_match
.IP \(bu 2
dscp_except
.IP \(bu 2
next_ip
.IP \(bu 2
flexible_match_range
.IP \(bu 2
source_prefix_except
.IP \(bu 2
destination_prefix_except
.IP \(bu 2
vpn
.IP \(bu 2
source_tag
.IP \(bu 2
destination_tag
.IP \(bu 2
source_interface
.IP \(bu 2
destination_interface
.IP \(bu 2
flattened
.IP \(bu 2
flattened_addr
.IP \(bu 2
flattened_saddr
.IP \(bu 2
flattened_daddr
.IP \(bu 2
priority
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The following fields can be also a single value and a list of values:
.INDENT 0.0
.IP \(bu 2
action
.IP \(bu 2
address
.IP \(bu 2
address_exclude
.IP \(bu 2
comment
.IP \(bu 2
destination_address
.IP \(bu 2
destination_address_exclude
.IP \(bu 2
destination_port
.IP \(bu 2
destination_prefix
.IP \(bu 2
forwarding_class
.IP \(bu 2
forwarding_class_except
.IP \(bu 2
logging
.IP \(bu 2
option
.IP \(bu 2
port
.IP \(bu 2
precedence
.IP \(bu 2
principals
.IP \(bu 2
protocol
.IP \(bu 2
protocol_except
.IP \(bu 2
pan_application
.IP \(bu 2
source_address
.IP \(bu 2
source_address_exclude
.IP \(bu 2
source_port
.IP \(bu 2
source_prefix
.IP \(bu 2
verbatim
.IP \(bu 2
icmp_type
.IP \(bu 2
ether_type
.IP \(bu 2
traffic_type
.IP \(bu 2
dscp_match
.IP \(bu 2
dscp_except
.IP \(bu 2
flexible_match_range
.IP \(bu 2
source_prefix_except
.IP \(bu 2
destination_prefix_except
.IP \(bu 2
source_tag
.IP \(bu 2
destination_tag
.IP \(bu 2
source_service
.IP \(bu 2
destination_service
.UNINDENT
.sp
Example: \fBdestination_address\fP can be either defined as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
destination_address: 172.17.17.1/24
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or as a list of destination IP addresses:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
destination_address:
    \- 172.17.17.1/24
    \- 172.17.19.1/24
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or a list of services to be matched:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
source_service:
    \- ntp
    \- snmp
    \- ldap
    \- bgpd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The port fields \fBsource_port\fP and \fBdestination_port\fP can be used as
above to select either a single value, either a list of values, but
also they can select port ranges. Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
source_port:
    \- [1000, 2000]
    \- [3000, 4000]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With the configuration above, the user is able to select the 1000\-2000 and 3000\-4000 source port ranges.
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqedge01.bjm01\(aq state.sls router.acl
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
edge01.bjm01:
\-\-\-\-\-\-\-\-\-\-
          ID: update_icmp_first_term
    Function: netacl.term
      Result: None
     Comment: Testing mode: Configuration discarded.
     Started: 12:49:09.174179
    Duration: 5751.882 ms
     Changes:
              \-\-\-\-\-\-\-\-\-\-
              diff:
                  [edit firewall]
                  +    family inet {
                  +        /*
                  +         ** $Id: update_icmp_first_term $
                  +         ** $Date: 2017/02/30 $
                  +         **
                  +         */
                  +        filter block\-icmp {
                  +            term first\-term {
                  +                from {
                  +                    protocol icmp;
                  +                }
                  +                then {
                  +                    reject;
                  +                }
                  +            }
                  +        }
                  +    }

Summary for edge01.bjm01
\-\-\-\-\-\-\-\-\-\-\-\-
Succeeded: 1 (unchanged=1, changed=1)
Failed:    0
\-\-\-\-\-\-\-\-\-\-\-\-
Total states run:     1
Total run time:   5.752 s
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Pillar example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
firewall:
  \- block\-icmp:
      terms:
        \- first\-term:
            protocol:
              \- icmp
            action: reject
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
State SLS example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set filter_name = \(aqblock\-icmp\(aq \-%}
{%\- set term_name = \(aqfirst\-term\(aq \-%}
{%\- set my_term_cfg = salt.netacl.get_term_pillar(filter_name, term_name) \-%}

update_icmp_first_term:
  netacl.term:
    \- filter_name: {{ filter_name }}
    \- filter_options:
        \- not\-interface\-specific
    \- term_name: {{ term_name }}
    \- {{ my_term_cfg | json }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or directly referencing the pillar keys:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
update_icmp_first_term:
  netacl.term:
    \- filter_name: block\-icmp
    \- filter_options:
        \- not\-interface\-specific
    \- term_name: first\-term
    \- merge_pillar: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The first method allows the user to eventually apply complex manipulation
and / or retrieve the data from external services before passing the
data to the state. The second one is more straightforward, for less
complex cases when loading the data directly from the pillar is sufficient.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When passing retrieved pillar data into the state file, it is strongly
recommended to use the json serializer explicitly (\(ga\(ga | json\(ga\(ga),
instead of relying on the default Python serializer.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.netconfig
.SS Network Config
.sp
Manage the configuration on a network device given a specific static config or template.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP> & Jerome Fleury <\fI\%jf@cloudflare.com\fP>
.TP
.B maturity
new
.TP
.B depends
napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
\fI\%NAPALM proxy minion\fP
.IP \(bu 2
\fI\%Network\-related basic features execution module\fP
.UNINDENT
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.states.netconfig.commit_cancelled(name)
New in version 2019.2.0.

.sp
Cancel a commit scheduled to be executed via the \fBcommit_in\fP and
\fBcommit_at\fP arguments from the
\fI\%net.load_template\fP or
\fI\%net.load_config\fP
execution functions. The commit ID is displayed when the commit is scheduled
via the functions named above.
.sp
State SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\(aq20180726083540640360\(aq:
  netconfig.commit_cancelled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.netconfig.commit_confirmed(name)
New in version 2019.2.0.

.sp
Confirm a commit scheduled to be reverted via the \fBrevert_in\fP and
\fBrevert_at\fP arguments from the
\fI\%net.load_template\fP or
\fI\%net.load_config\fP
execution functions. The commit ID is displayed when the commit confirmed
is scheduled via the functions named above.
.sp
State SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\(aq20180726083540640360\(aq:
  netconfig.commit_confirmed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.netconfig.managed(name, template_name=None, template_source=None, template_hash=None, template_hash_name=None, saltenv=\(aqbase\(aq, template_engine=\(aqjinja\(aq, skip_verify=False, context=None, defaults=None, test=False, commit=True, debug=False, replace=False, commit_in=None, commit_at=None, revert_in=None, revert_at=None, **template_vars)
Manages the configuration on network devices.
.sp
By default this state will commit the changes on the device. If there are no changes required, it does not commit
and the field \fBalready_configured\fP from the output dictionary will be set as \fBTrue\fP to notify that.
.sp
To avoid committing the configuration, set the argument \fBtest\fP to \fBTrue\fP (or via the CLI argument \fBtest=True\fP)
and will discard (dry run).
.sp
To preserve the changes, set \fBcommit\fP to \fBFalse\fP (either as CLI argument, either as state parameter).
However, this is recommended to be used only in exceptional cases when there are applied few consecutive states
and/or configuration changes. Otherwise the user might forget that the config DB is locked and the candidate config
buffer is not cleared/merged in the running config.
.sp
To replace the config, set \fBreplace\fP to \fBTrue\fP\&. This option is recommended to be used with caution!
.INDENT 7.0
.TP
.B template_name
Identifies path to the template source. The template can be either stored on the local machine,
either remotely.
The recommended location is under the \fBfile_roots\fP as specified in the master config file.
For example, let\(aqs suppose the \fBfile_roots\fP is configured as:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
     \- /etc/salt/states
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Placing the template under \fB/etc/salt/states/templates/example.jinja\fP, it can be used as
\fBsalt://templates/example.jinja\fP\&.
Alternatively, for local files, the user can specify the absolute path.
If remotely, the source can be retrieved via \fBhttp\fP, \fBhttps\fP or \fBftp\fP\&.
.sp
Examples:
.INDENT 7.0
.IP \(bu 2
\fBsalt://my_template.jinja\fP
.IP \(bu 2
\fB/absolute/path/to/my_template.jinja\fP
.IP \(bu 2
\fBhttp://example.com/template.cheetah\fP
.IP \(bu 2
\fBhttps:/example.com/template.mako\fP
.IP \(bu 2
\fBftp://example.com/template.py\fP
.UNINDENT
.sp
Changed in version 2019.2.0: This argument can now support a list of templates to be rendered.
The resulting configuration text is loaded at once, as a single
configuration chunk.

.TP
.B template_source: None
Inline config template to be rendered and loaded on the device.
.TP
.B template_hash: None
Hash of the template file. Format: \fB{hash_type: \(aqmd5\(aq, \(aqhsum\(aq: <md5sum>}\fP
.TP
.B template_hash_name: None
When \fBtemplate_hash\fP refers to a remote file, this specifies the filename to look for in that file.
.TP
.B saltenv: base
Specifies the template environment. This will influence the relative imports inside the templates.
.TP
.B template_engine: jinja
The following templates engines are supported:
.INDENT 7.0
.IP \(bu 2
\fI\%cheetah\fP
.IP \(bu 2
\fI\%genshi\fP
.IP \(bu 2
\fI\%jinja\fP
.IP \(bu 2
\fI\%mako\fP
.IP \(bu 2
\fI\%py\fP
.IP \(bu 2
\fI\%wempy\fP
.UNINDENT
.TP
.B skip_verify: False
If \fBTrue\fP, hash verification of remote file sources (\fBhttp://\fP, \fBhttps://\fP, \fBftp://\fP) will be skipped,
and the \fBsource_hash\fP argument will be ignored.
.sp
Changed in version 2017.7.1.

.TP
.B test: False
Dry run? If set to \fBTrue\fP, will apply the config, discard and return the changes. Default: \fBFalse\fP
(will commit the changes on the device).
.TP
.B commit: True
Commit? Default: \fBTrue\fP\&.
.TP
.B debug: False
Debug mode. Will insert a new key under the output dictionary, as \fBloaded_config\fP containing the raw
result after the template was rendered.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This argument cannot be used directly on the command line. Instead,
it can be passed through the \fBpillar\fP variable when executing
either of the \fI\%state.sls\fP or
\fBstate.apply\fP (see below for an
example).
.UNINDENT
.UNINDENT
.TP
.B commit_in: \fBNone\fP
Commit the changes in a specific number of minutes / hours. Example of
accepted formats: \fB5\fP (commit in 5 minutes), \fB2m\fP (commit in 2
minutes), \fB1h\fP (commit the changes in 1 hour)\(ga, \fB5h30m\fP (commit
the changes in 5 hours and 30 minutes).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This feature works on any platforms, as it does not rely on the
native features of the network operating system.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
After the command is executed and the \fBdiff\fP is not satisfactory,
or for any other reasons you have to discard the commit, you are
able to do so using the
\fI\%net.cancel_commit\fP
execution function, using the commit ID returned by this function.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Using this feature, Salt will load the exact configuration you
expect, however the diff may change in time (i.e., if an user
applies a manual configuration change, or a different process or
command changes the configuration in the meanwhile).
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B commit_at: \fBNone\fP
Commit the changes at a specific time. Example of accepted formats:
\fB1am\fP (will commit the changes at the next 1AM), \fB13:20\fP (will
commit at 13:20), \fB1:20am\fP, etc.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This feature works on any platforms, as it does not rely on the
native features of the network operating system.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
After the command is executed and the \fBdiff\fP is not satisfactory,
or for any other reasons you have to discard the commit, you are
able to do so using the
\fI\%net.cancel_commit\fP
execution function, using the commit ID returned by this function.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Using this feature, Salt will load the exact configuration you
expect, however the diff may change in time (i.e., if an user
applies a manual configuration change, or a different process or
command changes the configuration in the meanwhile).
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B revert_in: \fBNone\fP
Commit and revert the changes in a specific number of minutes / hours.
Example of accepted formats: \fB5\fP (revert in 5 minutes), \fB2m\fP (revert
in 2 minutes), \fB1h\fP (revert the changes in 1 hour)\(ga, \fB5h30m\fP (revert
the changes in 5 hours and 30 minutes).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To confirm the commit, and prevent reverting the changes, you will
have to execute the
\fI\%net.confirm_commit\fP
function, using the commit ID returned by this function.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This works on any platform, regardless if they have or don\(aqt have
native capabilities to confirming a commit. However, please be
\fIvery\fP cautious when using this feature: on Junos (as it is the only
NAPALM core platform supporting this natively) it executes a commit
confirmed as you would do from the command line.
All the other platforms don\(aqt have this capability natively,
therefore the revert is done via Salt. That means, your device needs
to be reachable at the moment when Salt will attempt to revert your
changes. Be cautious when pushing configuration changes that would
prevent you reach the device.
.sp
Similarly, if an user or a different process apply other
configuration changes in the meanwhile (between the moment you
commit and till the changes are reverted), these changes would be
equally reverted, as Salt cannot be aware of them.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B revert_at: \fBNone\fP
Commit and revert the changes at a specific time. Example of accepted
formats: \fB1am\fP (will commit and revert the changes at the next 1AM),
\fB13:20\fP (will commit and revert at 13:20), \fB1:20am\fP, etc.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To confirm the commit, and prevent reverting the changes, you will
have to execute the
\fI\%net.confirm_commit\fP
function, using the commit ID returned by this function.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This works on any platform, regardless if they have or don\(aqt have
native capabilities to confirming a commit. However, please be
\fIvery\fP cautious when using this feature: on Junos (as it is the only
NAPALM core platform supporting this natively) it executes a commit
confirmed as you would do from the command line.
All the other platforms don\(aqt have this capability natively,
therefore the revert is done via Salt. That means, your device needs
to be reachable at the moment when Salt will attempt to revert your
changes. Be cautious when pushing configuration changes that would
prevent you reach the device.
.sp
Similarly, if an user or a different process apply other
configuration changes in the meanwhile (between the moment you
commit and till the changes are reverted), these changes would be
equally reverted, as Salt cannot be aware of them.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B replace: False
Load and replace the configuration. Default: \fBFalse\fP (will apply load merge).
.TP
.B context: None
Overrides default context variables passed to the template.
.sp
New in version 2019.2.0.

.TP
.B defaults: None
Default variables/context passed to the template.
.TP
.B template_vars
Dictionary with the arguments/context to be used when the template is rendered. Do not explicitly specify this
argument. This represents any other variable that will be sent to the template rendering system. Please
see an example below! In both \fBntp_peers_example_using_pillar\fP and \fBntp_peers_example\fP, \fBpeers\fP is sent as
template variable.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
It is more recommended to use the \fBcontext\fP argument instead, to
avoid any conflicts with other arguments.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
SLS Example (e.g.: under salt://router/config.sls) :
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
whole_config_example:
    netconfig.managed:
        \- template_name: salt://path/to/complete_config.jinja
        \- debug: True
        \- replace: True
bgp_config_example:
    netconfig.managed:
        \- template_name: /absolute/path/to/bgp_neighbors.mako
        \- template_engine: mako
prefix_lists_example:
    netconfig.managed:
        \- template_name: prefix_lists.cheetah
        \- debug: True
        \- template_engine: cheetah
ntp_peers_example:
    netconfig.managed:
        \- template_name: http://bit.ly/2gKOj20
        \- skip_verify: False
        \- debug: True
        \- peers:
            \- 192.168.0.1
            \- 192.168.0.1
ntp_peers_example_using_pillar:
    netconfig.managed:
        \- template_name: http://bit.ly/2gKOj20
        \- peers: {{ pillar.get(\(aqntp.peers\(aq, []) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multi template example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
hostname_and_ntp:
  netconfig.managed:
    \- template_name:
        \- https://bit.ly/2OhSgqP
        \- https://bit.ly/2M6C4Lx
        \- https://bit.ly/2OIWVTs
    \- debug: true
    \- context:
        hostname: {{ opts.id }}
        servers:
          \- 172.17.17.1
          \- 172.17.17.2
        peers:
          \- 192.168.0.1
          \- 192.168.0.2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Usage examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \(aqjuniper.device\(aq state.sls router.config test=True

$ sudo salt \-N all\-routers state.sls router.config pillar=\(dq{\(aqdebug\(aq: True}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBrouter.config\fP depends on the location of the SLS file (see above). Running this command, will be executed all
five steps from above. These examples above are not meant to be used in a production environment, their sole purpose
is to provide usage examples.
.sp
Output example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \(aqjuniper.device\(aq state.sls router.config test=True
juniper.device:
\-\-\-\-\-\-\-\-\-\-
          ID: ntp_peers_example_using_pillar
    Function: netconfig.managed
      Result: None
     Comment: Testing mode: Configuration discarded.
     Started: 12:01:40.744535
    Duration: 8755.788 ms
     Changes:
              \-\-\-\-\-\-\-\-\-\-
              diff:
                  [edit system ntp]
                       peer 192.168.0.1 { ... }
                  +    peer 172.17.17.1;
                  +    peer 172.17.17.3;

Summary for juniper.device
\-\-\-\-\-\-\-\-\-\-\-\-
Succeeded: 1 (unchanged=1, changed=1)
Failed:    0
\-\-\-\-\-\-\-\-\-\-\-\-
Total states run:     1
Total run time:   8.756 s
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Raw output example (useful when the output is reused in other states/execution modules):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt \-\-out=pprint \(aqjuniper.device\(aq state.sls router.config test=True debug=True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqjuniper.device\(aq: {
        \(aqnetconfig_|\-ntp_peers_example_using_pillar_|\-ntp_peers_example_using_pillar_|\-managed\(aq: {
            \(aq__id__\(aq: \(aqntp_peers_example_using_pillar\(aq,
            \(aq__run_num__\(aq: 0,
            \(aqalready_configured\(aq: False,
            \(aqchanges\(aq: {
                \(aqdiff\(aq: \(aq[edit system ntp]   peer 192.168.0.1 { ... }+   peer 172.17.17.1;+   peer 172.17.17.3;\(aq
            },
            \(aqcomment\(aq: \(aqTesting mode: Configuration discarded.\(aq,
            \(aqduration\(aq: 7400.759,
            \(aqloaded_config\(aq: \(aqsystem {  ntp {  peer 172.17.17.1;  peer 172.17.17.3; } }\(aq,
            \(aqname\(aq: \(aqntp_peers_example_using_pillar\(aq,
            \(aqresult\(aq: None,
            \(aqstart_time\(aq: \(aq12:09:09.811445\(aq
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.netconfig.replace_pattern(name, pattern, repl, count=0, flags=8, bufsize=1, append_if_not_found=False, prepend_if_not_found=False, not_found_content=None, search_only=False, show_changes=True, backslash_literal=False, source=\(aqrunning\(aq, path=None, test=False, replace=True, debug=False, commit=True)
New in version 2019.2.0.

.sp
Replace occurrences of a pattern in the configuration source. If
\fBshow_changes\fP is \fBTrue\fP, then a diff of what changed will be returned,
otherwise a \fBTrue\fP will be returned when changes are made, and \fBFalse\fP
when no changes are made.
This is a pure Python implementation that wraps Python\(aqs \fI\%sub()\fP\&.
.INDENT 7.0
.TP
.B pattern
A regular expression, to be matched using Python\(aqs
\fI\%search()\fP\&.
.TP
.B repl
The replacement text.
.TP
.B count: \fB0\fP
Maximum number of pattern occurrences to be replaced. If count is a
positive integer \fBn\fP, only \fBn\fP occurrences will be replaced,
otherwise all occurrences will be replaced.
.TP
.B flags (list or int): \fB8\fP
A list of flags defined in the \fBre\fP module documentation from the
Python standard library. Each list item should be a string that will
correlate to the human\-friendly flag name. E.g., \fB[\(aqIGNORECASE\(aq,
\(aqMULTILINE\(aq]\fP\&. Optionally, \fBflags\fP may be an int, with a value
corresponding to the XOR (\fB|\fP) of all the desired flags. Defaults to
8 (which supports \(aqMULTILINE\(aq).
.TP
.B bufsize (int or str): \fB1\fP
How much of the configuration to buffer into memory at once. The
default value \fB1\fP processes one line at a time. The special value
\fBfile\fP may be specified which will read the entire file into memory
before processing.
.TP
.B append_if_not_found: \fBFalse\fP
If set to \fBTrue\fP, and pattern is not found, then the content will be
appended to the file.
.TP
.B prepend_if_not_found: \fBFalse\fP
If set to \fBTrue\fP and pattern is not found, then the content will be
prepended to the file.
.TP
.B not_found_content
Content to use for append/prepend if not found. If None (default), uses
\fBrepl\fP\&. Useful when \fBrepl\fP uses references to group in pattern.
.TP
.B search_only: \fBFalse\fP
If set to true, this no changes will be performed on the file, and this
function will simply return \fBTrue\fP if the pattern was matched, and
\fBFalse\fP if not.
.TP
.B show_changes: \fBTrue\fP
If \fBTrue\fP, return a diff of changes made. Otherwise, return \fBTrue\fP
if changes were made, and \fBFalse\fP if not.
.TP
.B backslash_literal: \fBFalse\fP
Interpret backslashes as literal backslashes for the repl and not
escape characters.  This will help when using append/prepend so that
the backslashes are not interpreted for the repl on the second run of
the state.
.TP
.B source: \fBrunning\fP
The configuration source. Choose from: \fBrunning\fP, \fBcandidate\fP, or
\fBstartup\fP\&. Default: \fBrunning\fP\&.
.TP
.B path
Save the temporary configuration to a specific path, then read from
there.
.TP
.B test: \fBFalse\fP
Dry run? If set as \fBTrue\fP, will apply the config, discard and return
the changes. Default: \fBFalse\fP and will commit the changes on the
device.
.TP
.B commit: \fBTrue\fP
Commit the configuration changes? Default: \fBTrue\fP\&.
.TP
.B debug: \fBFalse\fP
Debug mode. Will insert a new key in the output dictionary, as
\fBloaded_config\fP containing the raw configuration loaded on the device.
.TP
.B replace: \fBTrue\fP
Load and replace the configuration. Default: \fBTrue\fP\&.
.UNINDENT
.sp
If an equal sign (\fB=\fP) appears in an argument to a Salt command it is
interpreted as a keyword argument in the format \fBkey=val\fP\&. That
processing can be bypassed in order to pass an equal sign through to the
remote shell command by manually specifying the kwarg:
.sp
State SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
update_policy_name:
  netconfig.replace_pattern:
    \- pattern: OLD\-POLICY\-NAME
    \- repl: new\-policy\-name
    \- debug: true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.netconfig.saved(name, source=\(aqrunning\(aq, user=None, group=None, mode=None, attrs=None, makedirs=False, dir_mode=None, replace=True, backup=\(aq\(aq, show_changes=True, create=True, tmp_dir=\(aq\(aq, tmp_ext=\(aq\(aq, encoding=None, encoding_errors=\(aqstrict\(aq, allow_empty=False, follow_symlinks=True, check_cmd=None, win_owner=None, win_perms=None, win_deny_perms=None, win_inheritance=True, win_perms_reset=False, **kwargs)
New in version 2019.2.0.

.sp
Save the configuration to a file on the local file system.
.INDENT 7.0
.TP
.B name
Absolute path to file where to save the configuration.
To push the files to the Master, use
\fI\%cp.push\fP Execution function.
.TP
.B source: \fBrunning\fP
The configuration source. Choose from: \fBrunning\fP, \fBcandidate\fP,
\fBstartup\fP\&. Default: \fBrunning\fP\&.
.TP
.B user
The user to own the file, this defaults to the user salt is running as
on the minion
.TP
.B group
The group ownership set for the file, this defaults to the group salt
is running as on the minion. On Windows, this is ignored
.TP
.B mode
The permissions to set on this file, e.g. \fB644\fP, \fB0775\fP, or
\fB4664\fP\&.
The default mode for new files and directories corresponds to the
umask of the salt process. The mode of existing files and directories
will only be changed if \fBmode\fP is specified.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option is \fBnot\fP supported on Windows.
.UNINDENT
.UNINDENT
.TP
.B attrs
The attributes to have on this file, e.g. \fBa\fP, \fBi\fP\&. The attributes
can be any or a combination of the following characters:
\fBaAcCdDeijPsStTu\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option is \fBnot\fP supported on Windows.
.UNINDENT
.UNINDENT
.TP
.B makedirs: \fBFalse\fP
If set to \fBTrue\fP, then the parent directories will be created to
facilitate the creation of the named file. If \fBFalse\fP, and the parent
directory of the destination file doesn\(aqt exist, the state will fail.
.TP
.B dir_mode
If directories are to be created, passing this option specifies the
permissions for those directories. If this is not set, directories
will be assigned permissions by adding the execute bit to the mode of
the files.
.sp
The default mode for new files and directories corresponds umask of salt
process. For existing files and directories it\(aqs not enforced.
.TP
.B replace: \fBTrue\fP
If set to \fBFalse\fP and the file already exists, the file will not be
modified even if changes would otherwise be made. Permissions and
ownership will still be enforced, however.
.TP
.B backup
Overrides the default backup mode for this specific file. See
\fI\%backup_mode documentation\fP for more details.
.TP
.B show_changes: \fBTrue\fP
Output a unified diff of the old file and the new file. If \fBFalse\fP
return a boolean if any changes were made.
.TP
.B create: \fBTrue\fP
If set to \fBFalse\fP, then the file will only be managed if the file
already exists on the system.
.TP
.B encoding
If specified, then the specified encoding will be used. Otherwise, the
file will be encoded using the system locale (usually UTF\-8). See
\fI\%https://docs.python.org/3/library/codecs.html#standard\-encodings\fP for
the list of available encodings.
.TP
.B encoding_errors: \fB\(aqstrict\(aq\fP
Error encoding scheme. Default is \fB\(ga\(aqstrict\(aq\(ga\fP\&.
See \fI\%https://docs.python.org/2/library/codecs.html#codec\-base\-classes\fP
for the list of available schemes.
.TP
.B allow_empty: \fBTrue\fP
If set to \fBFalse\fP, then the state will fail if the contents specified
by \fBcontents_pillar\fP or \fBcontents_grains\fP are empty.
.TP
.B follow_symlinks: \fBTrue\fP
If the desired path is a symlink follow it and make changes to the
file to which the symlink points.
.TP
.B check_cmd
The specified command will be run with an appended argument of a
\fItemporary\fP file containing the new managed contents.  If the command
exits with a zero status the new managed contents will be written to
the managed destination. If the command exits with a nonzero exit
code, the state will fail and no changes will be made to the file.
.TP
.B tmp_dir
Directory for temp file created by \fBcheck_cmd\fP\&. Useful for checkers
dependent on config file location (e.g. daemons restricted to their
own config directories by an apparmor profile).
.TP
.B tmp_ext
Suffix for temp file created by \fBcheck_cmd\fP\&. Useful for checkers
dependent on config file extension (e.g. the init\-checkconf upstart
config checker).
.TP
.B win_owner: \fBNone\fP
The owner of the directory. If this is not passed, user will be used. If
user is not passed, the account under which Salt is running will be
used.
.TP
.B win_perms: \fBNone\fP
A dictionary containing permissions to grant and their propagation. For
example: \fB{\(aqAdministrators\(aq: {\(aqperms\(aq: \(aqfull_control\(aq}}\fP Can be a
single basic perm or a list of advanced perms. \fBperms\fP must be
specified. \fBapplies_to\fP does not apply to file objects.
.TP
.B win_deny_perms: \fBNone\fP
A dictionary containing permissions to deny and their propagation. For
example: \fB{\(aqAdministrators\(aq: {\(aqperms\(aq: \(aqfull_control\(aq}}\fP Can be a
single basic perm or a list of advanced perms. \fBperms\fP must be
specified. \fBapplies_to\fP does not apply to file objects.
.TP
.B win_inheritance: \fBTrue\fP
True to inherit permissions from the parent directory, False not to
inherit permission.
.TP
.B win_perms_reset: \fBFalse\fP
If \fBTrue\fP the existing DACL will be cleared and replaced with the
settings defined in this function. If \fBFalse\fP, new entries will be
appended to the existing DACL. Default is \fBFalse\fP\&.
.UNINDENT
.sp
State SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/var/backups/{{ opts.id }}/{{ salt.status.time(\(aq%s\(aq) }}.cfg:
  netconfig.saved:
    \- source: running
    \- makedirs: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The state SLS  above would create a backup config grouping the files by the
Minion ID, in chronological files. For example, if the state is executed at
on the 3rd of August 2018, at 5:15PM, on the Minion \fBcore1.lon01\fP, the
configuration would saved in the file:
\fB/var/backups/core01.lon01/1533316558.cfg\fP
.UNINDENT
.SS salt.states.netntp
.SS Network NTP
.sp
New in version 2016.11.0.

.sp
Manage the configuration of NTP peers and servers on the network devices through the NAPALM proxy.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP> & Jerome Fleury <\fI\%jf@cloudflare.com\fP>
.TP
.B maturity
new
.TP
.B depends
napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
Requires \fI\%netaddr\fP to be installed: \fIpip install netaddr\fP to check if IP
Addresses are correctly specified
.IP \(bu 2
Requires \fI\%dnspython\fP to be installed: \fIpip install dnspython\fP to resolve the
nameserver entities (in case the user does not configure the peers/servers
using their IP addresses)
.IP \(bu 2
\fI\%NAPALM proxy minion\fP
.IP \(bu 2
\fI\%NTP operational and configuration management module\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.netntp.managed(name, peers=None, servers=None)
Manages the configuration of NTP peers and servers on the device, as specified in the state SLS file.
NTP entities not specified in these lists will be removed whilst entities not configured on the device will be set.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
netntp_example:
    netntp.managed:
         \- peers:
            \- 192.168.0.1
            \- 172.17.17.1
         \- servers:
            \- 24.124.0.251
            \- 138.236.128.36
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqedge01.nrt04\(aq: {
        \(aqnetntp_|\-netntp_example_|\-netntp_example_|\-managed\(aq: {
            \(aqcomment\(aq: \(aqNTP servers already configured as needed.\(aq,
            \(aqname\(aq: \(aqnetntp_example\(aq,
            \(aqstart_time\(aq: \(aq12:45:24.056659\(aq,
            \(aqduration\(aq: 2938.857,
            \(aqchanges\(aq: {
                \(aqpeers\(aq: {
                    \(aqremoved\(aq: [
                        \(aq192.168.0.2\(aq,
                        \(aq192.168.0.3\(aq
                    ],
                    \(aqadded\(aq: [
                        \(aq192.168.0.1\(aq,
                        \(aq172.17.17.1\(aq
                    ]
                }
            },
            \(aqresult\(aq: None
        }
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.netsnmp
.SS Network SNMP
.sp
Manage the SNMP configuration on network devices.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP>
.TP
.B maturity
new
.TP
.B depends
napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
\fI\%napalm snmp management module (salt.modules.napalm_snmp)\fP
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.states.netsnmp.managed(name, config=None, defaults=None)
Configures the SNMP on the device as specified in the SLS file.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
snmp_example:
    netsnmp.managed:
         \- config:
            location: Honolulu, HI, US
         \- defaults:
            contact: noc@cloudflare.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output example (for the SLS above, e.g. called snmp.sls under /router/):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo salt edge01.hnl01 state.sls router.snmp test=True
edge01.hnl01:
\-\-\-\-\-\-\-\-\-\-
          ID: snmp_example
    Function: snmp.managed
      Result: None
     Comment: Testing mode: configuration was not changed!
     Started: 13:29:06.872363
    Duration: 920.466 ms
     Changes:
              \-\-\-\-\-\-\-\-\-\-
              added:
                  \-\-\-\-\-\-\-\-\-\-
                  chassis_id:
                      None
                  contact:
                      noc@cloudflare.com
                  location:
                      Honolulu, HI, US

Summary for edge01.hnl01
\-\-\-\-\-\-\-\-\-\-\-\-
Succeeded: 1 (unchanged=1, changed=1)
Failed:    0
\-\-\-\-\-\-\-\-\-\-\-\-
Total states run:     1
Total run time: 920.466 ms
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.netusers
.SS Network Users
.sp
Manage the users configuration on network devices via the NAPALM proxy.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP>
.TP
.B maturity
new
.TP
.B depends
napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
\fI\%NAPALM proxy minion\fP
.IP \(bu 2
\fI\%Users configuration management module\fP
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.states.netusers.managed(name, users=None, defaults=None)
Manages the configuration of the users on the device, as specified in the state SLS file. Users not defined in that
file will be removed whilst users not configured on the device, will be added.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
netusers_example:
    netusers.managed:
         \- users:
            admin:
                level: 15
                password: $1$knmhgPPv$g8745biu4rb.Zf.IT.F/U1
                sshkeys: []
            restricted:
                level: 1
                password: $1$j34j5k4b$4d5SVjTiz1l.Zf.IT.F/K7
            martin:
                level: 15
                password: \(aq\(aq
                sshkeys:
                    \- ssh\-dss AAAAB3NzaC1kc3MAAACBAK9dP3KariMlM/JmFW9rTSm5cXs4nR0+o6fTHP9o+bOLXMBTP8R4vwWHh0w
                        JPjQmJYafAqZTnlgi0srGjyifFwPtODppDWLCgLe2M4LXnu3OMqknr54w344zPHP3iFwWxHrBrZKtCjO8LhbWCa+
                        X528+i87t6r5e4ersdfxgchvjbknlio87t6r5drcfhgjhbknio8976tycv7t86ftyiu87Oz1nKsKuNzm2csoUQlJ
                        trmRfpjsOPNookmOz5wG0YxhwDmKeo6fWK+ATk1OiP+QT39fn4G77j8o+e4WAwxM570s35Of/vV0zoOccj753sXn
                        pvJenvwpM2H6o3a9ALvehAJKWodAgZT7X8+iu786r5drtycghvjbiu78t+wAAAIBURwSPZVElXe+9a43sF6M4ysT
                        7Xv+6wTsa8q86E3+RYyu8O2ObI2kwNLC3/HTgFniE/YqRG+WJac81/VHWQNP822gns8RVrWKjqBktmQoEm7z5yy0
                        bkjui78675dytcghvjkoi9y7t867ftcuvhbuu9t78gy/v+zvMmv8KvQgHg
            jonathan:
                level: 15
                password: \(aq\(aq
                sshkeys:
                    \- ssh\-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDcgxE6HZF/xjFtIt0thEDKPjFJxW9BpZtTVstYbDgGR9zPkHG
                        ZJT/j345jk345jk453jk43545j35nl3kln34n5kl4ghv3/JzWt/0Js5KZp/51KRNCs9O4t07qaoqwpLB15GwLfEX
                        Bx9dW26zc4O+hi6754trxcfghvjbo98765drt/LYIEg0KSQPWyJEK1g31gacbxN7Ab006xeHh7rv7HtXF6zH3WId
                        Uhq9rtdUag6kYnv6qvjG7sbCyHGYu5vZB7GytnNuVNbZuI+RdFvmHSnErV9HCu9xZBq6DBb+sESMS4s7nFcsruMo
                        edb+BAc3aww0naeWpogjSt+We7y2N
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqedge01.kix01\(aq state.sls router.users
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Output example (raw python \- can be reused in other modules):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqnetusers_|\-netusers_example_|\-netusers_example_|\-managed\(aq: {
        \(aqcomment\(aq: \(aqConfiguration updated!\(aq,
        \(aqname\(aq: \(aqnetusers_example\(aq,
        \(aqstart_time\(aq: \(aq10:57:08.678811\(aq,
        \(aq__id__\(aq: \(aqnetusers_example\(aq,
        \(aqduration\(aq: 1620.982,
        \(aq__run_num__\(aq: 0,
        \(aqchanges\(aq: {
            \(aqupdated\(aq: {
                \(aqadmin\(aq: {
                    \(aqlevel\(aq: 15
                },
                \(aqrestricted\(aq: {
                    \(aqlevel\(aq: 1
                },
                \(aqmartin\(aq: {
                    \(aqsshkeys\(aq: [
                        \(aqssh\-dss AAAAB3NzaC1kc3MAAACBAK9dP3KariMlM/JmFW9rTSm5cXs4nR0+o6fTHP9o+bOLXMBTP8R4vwWHh0w
                        JPjQmJYafAqZTnlgi0srGjyifFwPtODppDWLCgLe2M4LXnu3OMqknr54w344zPHP3iFwWxHrBrZKtCjO8LhbWCa+
                        X528+i87t6r5e4ersdfxgchvjbknlio87t6r5drcfhgjhbknio8976tycv7t86ftyiu87Oz1nKsKuNzm2csoUQlJ
                        trmRfpjsOPNookmOz5wG0YxhwDmKeo6fWK+ATk1OiP+QT39fn4G77j8o+e4WAwxM570s35Of/vV0zoOccj753sXn
                        pvJenvwpM2H6o3a9ALvehAJKWodAgZT7X8+iu786r5drtycghvjbiu78t+wAAAIBURwSPZVElXe+9a43sF6M4ysT
                        7Xv+6wTsa8q86E3+RYyu8O2ObI2kwNLC3/HTgFniE/YqRG+WJac81/VHWQNP822gns8RVrWKjqBktmQoEm7z5yy0
                        bkjui78675dytcghvjkoi9y7t867ftcuvhbuu9t78gy/v+zvMmv8KvQgHg\(aq
                    ]
                }
            },
            \(aqadded\(aq: {
                \(aqjonathan\(aq: {
                    \(aqpassword\(aq: \(aq\(aq,
                    \(aqsshkeys\(aq: [
                        \(aqssh\-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDcgxE6HZF/xjFtIt0thEDKPjFJxW9BpZtTVstYbDgGR9zPkHG
                        ZJT/j345jk345jk453jk43545j35nl3kln34n5kl4ghv3/JzWt/0Js5KZp/51KRNCs9O4t07qaoqwpLB15GwLfEX
                        Bx9dW26zc4O+hi6754trxcfghvjbo98765drt/LYIEg0KSQPWyJEK1g31gacbxN7Ab006xeHh7rv7HtXF6zH3WId
                        Uhq9rtdUag6kYnv6qvjG7sbCyHGYu5vZB7GytnNuVNbZuI+RdFvmHSnErV9HCu9xZBq6DBb+sESMS4s7nFcsruMo
                        edb+BAc3aww0naeWpogjSt+We7y2N\(aq
                    ],
                    \(aqlevel\(aq: 15
                }
            },
            \(aqremoved\(aq: {
            }
        },
        \(aqresult\(aq: True
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CLI Output:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
edge01.kix01:
    \-\-\-\-\-\-\-\-\-\-
              ID: netusers_example
        Function: netusers.managed
          Result: True
         Comment: Configuration updated!
         Started: 11:03:31.957725
        Duration: 1220.435 ms
         Changes:
                  \-\-\-\-\-\-\-\-\-\-
                  added:
                      \-\-\-\-\-\-\-\-\-\-
                      jonathan:
                          \-\-\-\-\-\-\-\-\-\-
                          level:
                              15
                          password:
                          sshkeys:
                              \- ssh\-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDcgxE6HZF/xjFtIt0thEDKPjFJxW9BpZtTVstYbDgG
                              R9zPkHGZJT/j345jk345jk453jk43545j35nl3kln34n5kl4ghv3/JzWt/0Js5KZp/51KRNCs9O4t07qao
                              qwpLB15GwLfEXBx9dW26zc4O+hi6754trxcfghvjbo98765drt/LYIEg0KSQPWyJEK1g31gacbxN7Ab006
                              xeHh7rv7HtXF6zH3WIdUhq9rtdUag6kYnv6qvjG7sbCyHGYu5vZB7GytnNuVNbZuI+RdFvmHSnErV9HCu9
                              xZBq6DBb+sESMS4s7nFcsruMoedb+BAc3aww0naeWpogjSt+We7y2N
                  removed:
                      \-\-\-\-\-\-\-\-\-\-
                  updated:
                      \-\-\-\-\-\-\-\-\-\-
                      martin:
                          \-\-\-\-\-\-\-\-\-\-
                          sshkeys:
                              \- ssh\-dss AAAAB3NzaC1kc3MAAACBAK9dP3KariMlM/JmFW9rTSm5cXs4nR0+o6fTHP9o+bOLXMBTP8R4
                              vwWHh0wJPjQmJYafAqZTnlgi0srGjyifFwPtODppDWLCgLe2M4LXnu3OMqknr54w344zPHP3iFwWxHrBrZ
                              KtCjO8LhbWCa+X528+i87t6r5e4ersdfxgchvjbknlio87t6r5drcfhgjhbknio8976tycv7t86ftyiu87
                              Oz1nKsKuNzm2csoUQlJtrmRfpjsOPNookmOz5wG0YxhwDmKeo6fWK+ATk1OiP+QT39fn4G77j8o+e4WAwx
                              M570s35Of/vV0zoOccj753sXnpvJenvwpM2H6o3a9ALvehAJKWodAgZT7X8+iu786r5drtycghvjbiu78t
                              +wAAAIBURwSPZVElXe+9a43sF6M4ysT7Xv+6wTsa8q86E3+RYyu8O2ObI2kwNLC3/HTgFniE/YqRG+WJac
                              81/VHWQNP822gns8RVrWKjqBktmQoEm7z5yy0bkjui78675dytcghvjkoi9y7t867ftcuvhbuu9t78gy/v
                              +zvMmv8KvQgHg
                      admin:
                          \-\-\-\-\-\-\-\-\-\-
                          level:
                              15
                      restricted:
                          \-\-\-\-\-\-\-\-\-\-
                          level:
                              1
    Summary for edge01.kix01
    \-\-\-\-\-\-\-\-\-\-\-\-
    Succeeded: 1 (changed=1)
    Failed:    0
    \-\-\-\-\-\-\-\-\-\-\-\-
    Total states run:     1
    Total run time:   1.220 s
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.network
.SS Configuration of network interfaces
.sp
The network module is used to create and manage network settings,
interfaces can be set as either managed or ignored. By default
all interfaces are ignored unless specified.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
RedHat\-based systems (RHEL, CentOS, Scientific, etc.)
have been supported since version 2014.1.0.
.sp
Debian\-based systems (Debian, Ubuntu, etc.) have been
supported since version 2017.7.0. The following options
are not supported: ipaddr_start, and ipaddr_end.
.sp
Other platforms are not yet supported.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
On Debian\-based systems, networking configuration can be specified
in \fI/etc/network/interfaces\fP or via included files such as (by default)
\fI/etc/network/interfaces.d/*\fP\&. This can be problematic for configuration
management. It is recommended to use either \fIfile.managed\fP \fIor\fP
\fInetwork.managed\fP\&.
.sp
If using \fBnetwork.managed\fP, it can be useful to ensure \fBinterfaces.d/\fP
is empty. This can be done using the following state
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/network/interfaces.d:
  file.directory:
    \- clean: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Configuring Global Network Settings
.sp
Use the \fI\%network.system\fP state to set
global network settings:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
system:
  network.system:
    \- enabled: True
    \- hostname: server1.example.com
    \- gateway: 192.168.0.1
    \- gatewaydev: eth0
    \- nozeroconf: True
    \- nisdomain: example.com
    \- require_reboot: True
    \- apply_hostname: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The use of \fBapply_hostname\fP above will apply changes to the hostname
immediately.
.UNINDENT
.UNINDENT
.sp
Changed in version 2015.5.0: \fBapply_hostname\fP added

.SS retain_settings
.sp
New in version 2016.11.0.

.sp
Use \fIretain_settings\fP to retain current network settings that are not otherwise
specified in the state. Particularly useful if only setting the hostname.
Default behavior is to delete unspecified network settings.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
system:
  network.system:
    \- hostname: server2.example.com
    \- apply_hostname: True
    \- retain_settings: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configuring Network Routes
.sp
Use the \fI\%network.routes\fP state to set
network routes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
routes:
  network.routes:
    \- name: eth0
    \- routes:
      \- name: secure_network
        ipaddr: 10.2.0.0
        netmask: 255.255.255.0
        gateway: 10.1.0.3
      \- name: HQ_network
        ipaddr: 10.100.0.0
        netmask: 255.255.0.0
        gateway: 10.1.0.10
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Managing Network Interfaces
.sp
The \fI\%network.managed\fP state is used to
configure network interfaces. Here are several examples:
.SS Ethernet Interface
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
eth0:
  network.managed:
    \- enabled: True
    \- type: eth
    \- proto: static
    \- ipaddr: 10.1.0.7
    \- netmask: 255.255.255.0
    \- gateway: 10.1.0.1
    \- enable_ipv6: true
    \- ipv6proto: static
    \- ipv6addrs:
      \- 2001:db8:dead:beef::3/64
      \- 2001:db8:dead:beef::7/64
    \- ipv6gateway: 2001:db8:dead:beef::1
    \- ipv6netmask: 64
    \- dns:
      \- 8.8.8.8
      \- 8.8.4.4
    \- channels:
        rx: 4
        tx: 4
        other: 4
        combined: 4
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Ranged Interfaces (RHEL/CentOS Only)
.sp
New in version 2015.8.0.

.sp
Ranged interfaces can be created by including the word \fBrange\fP in the
interface name.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
The interface type must be \fBeth\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
eth0\-range0:
  network.managed:
    \- type: eth
    \- ipaddr_start: 192.168.1.1
    \- ipaddr_end: 192.168.1.10
    \- clonenum_start: 10
    \- mtu: 9000

bond0\-range0:
  network.managed:
    \- type: eth
    \- ipaddr_start: 192.168.1.1
    \- ipaddr_end: 192.168.1.10
    \- clonenum_start: 10
    \- mtu: 9000

eth1.0\-range0:
  network.managed:
    \- type: eth
    \- ipaddr_start: 192.168.1.1
    \- ipaddr_end: 192.168.1.10
    \- clonenum_start: 10
    \- vlan: True
    \- mtu: 9000

bond0.1\-range0:
  network.managed:
    \- type: eth
    \- ipaddr_start: 192.168.1.1
    \- ipaddr_end: 192.168.1.10
    \- clonenum_start: 10
    \- vlan: True
    \- mtu: 9000
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Bond Interfaces
.sp
To configure a bond, you must do the following:
.INDENT 0.0
.IP \(bu 2
Configure the bond slaves with a \fBtype\fP of \fBslave\fP, and a \fBmaster\fP
option set to the name of the bond interface.
.IP \(bu 2
Configure the bond interface with a \fBtype\fP of \fBbond\fP, and a \fBslaves\fP
option defining the bond slaves for the bond interface.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
eth2:
  network.managed:
    \- enabled: True
    \- type: slave
    \- master: bond0

eth3:
  network.managed:
    \- enabled: True
    \- type: slave
    \- master: bond0

bond0:
  network.managed:
    \- type: bond
    \- ipaddr: 10.1.0.1
    \- netmask: 255.255.255.0
    \- mode: gre
    \- proto: static
    \- dns:
      \- 8.8.8.8
      \- 8.8.4.4
    \- enabled: False
    \- slaves: eth2 eth3
    \- require:
      \- network: eth2
      \- network: eth3
    \- miimon: 100
    \- arp_interval: 250
    \- downdelay: 200
    \- lacp_rate: fast
    \- max_bonds: 1
    \- updelay: 0
    \- use_carrier: on
    \- hashing\-algorithm: layer2
    \- mtu: 9000
    \- autoneg: on
    \- speed: 1000
    \- duplex: full
    \- rx: on
    \- tx: off
    \- sg: on
    \- tso: off
    \- ufo: off
    \- gso: off
    \- gro: off
    \- lro: off
.ft P
.fi
.UNINDENT
.UNINDENT
.SS VLANs
.sp
Set \fBtype\fP to \fBvlan\fP to configure a VLANs. These VLANs are configured on
the bond interface defined above.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
bond0.2:
  network.managed:
    \- type: vlan
    \- ipaddr: 10.1.0.2
    \- use:
      \- network: bond0
    \- require:
      \- network: bond0

bond0.3:
  network.managed:
    \- type: vlan
    \- ipaddr: 10.1.0.3
    \- use:
      \- network: bond0
    \- require:
      \- network: bond0

bond0.10:
  network.managed:
    \- type: vlan
    \- ipaddr: 10.1.0.4
    \- use:
      \- network: bond0
    \- require:
      \- network: bond0

bond0.12:
  network.managed:
    \- type: vlan
    \- ipaddr: 10.1.0.5
    \- use:
      \- network: bond0
    \- require:
      \- network: bond0
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Bridge Interfaces
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
eth4:
  network.managed:
    \- enabled: True
    \- type: eth
    \- proto: dhcp
    \- bridge: br0

br0:
  network.managed:
    \- enabled: True
    \- type: bridge
    \- proto: dhcp
    \- bridge: br0
    \- delay: 0
    \- ports: eth4
    \- bypassfirewall: True
    \- use:
      \- network: eth4
    \- require:
      \- network: eth4
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When managing bridged interfaces on a Debian/Ubuntu based system, the
\fBports\fP argument is required. RedHat\-based systems will ignore the
argument.
.UNINDENT
.UNINDENT
.SS Network Teaming (RHEL/CentOS 7 and later)
.sp
New in version 3002.

.INDENT 0.0
.IP \(bu 2
Configure the members of the team interface with a \fBtype\fP of \fBteamport\fP,
and a \fBteam_master\fP option set to the name of the bond interface.
.INDENT 2.0
.IP \(bu 2
\fBmaster\fP also works, but will be ignored if both \fBteam_master\fP and
\fBmaster\fP are present.
.IP \(bu 2
If applicable, include a \fBteam_port_config\fP option. This should be
formatted as a dictionary. Keep in mind that due to a quirk of PyYAML,
dictionaries nested under a list item must be double\-indented (see example
below for interface \fBeth5\fP).
.UNINDENT
.IP \(bu 2
Configure the team interface with a \fBtype\fP of \fBteam\fP\&. The team
configuration should be passed via the \fBteam_config\fP option. As with
\fBteam_port_config\fP, the dictionary should be double\-indented.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
eth5:
  network.managed:
    \- type: teamport
    \- team_master: team0
    \- team_port_config:
        prio: 100

eth6:
  network.managed:
    \- type: teamport
    \- team_master: team0

team0:
  network.managed:
    \- type: team
    \- ipaddr: 172.24.90.42
    \- netmask: 255.255.255.128
    \- enable_ipv6: True
    \- ipv6addr: \(aqfee1:dead:beef:af43::\(aq
    \- team_config:
        runner:
          hwaddr_policy: by_active
          name: activebackup
          link_watch:
            name: ethtool
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
While \fBteamd\fP must be installed to manage a team interface, it is not
required to configure a separate \fI\%pkg.installed\fP state for it, as it will be silently installed
if needed.
.UNINDENT
.UNINDENT
.SS Configuring the Loopback Interface
.sp
Use \fI\%network.managed\fP with a \fBtype\fP of
\fBeth\fP and a \fBproto\fP of \fBloopback\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lo:
  network.managed:
    \- name: lo
    \- type: eth
    \- proto: loopback
    \- onboot: yes
    \- userctl: no
    \- ipv6_autoconf: no
    \- enable_ipv6: true
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Other Useful Options
.SS noifupdown
.sp
The \fBnoifupdown\fP option, if set to \fBTrue\fP, will keep Salt from restart the
interface if changes are made, requiring them to be restarted manually. Here
are a couple examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
eth7:
  network.managed:
    \- enabled: True
    \- type: eth
    # Automatic IP/DNS
    \- proto: dhcp
    \- noifupdown: True

eth8:
  network.managed:
    \- type: eth
    \- noifupdown: True

    # IPv4
    \- proto: static
    \- ipaddr: 192.168.4.9
    \- netmask: 255.255.255.0
    \- gateway: 192.168.4.1
    \- enable_ipv6: True

    # IPv6
    \- ipv6proto: static
    \- ipv6addr: 2001:db8:dead:c0::3
    \- ipv6netmask: 64
    \- ipv6gateway: 2001:db8:dead:c0::1
    # override shared; makes those options v4\-only
    \- ipv6ttl: 15

    # Shared
    \- mtu: 1480
    \- ttl: 18
    \- dns:
      \- 8.8.8.8
      \- 8.8.4.4
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.network.managed(name, enabled=True, **kwargs)
Ensure that the named interface is configured properly.
.INDENT 7.0
.TP
.B name
The name of the interface to manage
.TP
.B type
eth
Type of interface and configuration
.sp
Changed in version 3002.

.TP
.B enabled
Designates the state of this interface.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.network.routes(name, **kwargs)
Manage network interface static routes.
.INDENT 7.0
.TP
.B name
Interface name to apply the route to.
.TP
.B kwargs
Named routes
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.network.system(name, **kwargs)
Ensure that global network settings are configured properly.
.INDENT 7.0
.TP
.B name
Custom name to represent this configuration change.
.TP
.B kwargs
The global parameters for the system.
.UNINDENT
.UNINDENT
.SS salt.states.neutron_network
.SS Management of OpenStack Neutron Networks
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
shade
.TP
.B configuration
see \fI\%salt.modules.neutronng\fP for setup instructions
.UNINDENT
.sp
Example States
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create network:
  neutron_network.present:
    \- name: network1

delete network:
  neutron_network.absent:
    \- name: network1

create network with optional params:
  neutron_network.present:
    \- name: network1
    \- vlan: 200
    \- shared: False
    \- external: False
    \- project: project1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.neutron_network.absent(name, auth=None, **kwargs)
Ensure a network does not exists
.INDENT 7.0
.TP
.B name
Name of the network
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.neutron_network.present(name, auth=None, **kwargs)
Ensure a network exists and is up\-to\-date
.INDENT 7.0
.TP
.B name
Name of the network
.TP
.B provider
A dict of network provider options.
.TP
.B shared
Set the network as shared.
.TP
.B external
Whether this network is externally accessible.
.TP
.B admin_state_up
Set the network administrative state to up.
.TP
.B vlan
Vlan ID. Alias for provider
.INDENT 7.0
.IP \(bu 2
physical_network: provider
.IP \(bu 2
network_type: vlan
.IP \(bu 2
segmentation_id: (vlan id)
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.neutron_secgroup
.SS Management of OpenStack Neutron Security Groups
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
shade
.TP
.B configuration
see \fI\%salt.modules.neutronng\fP for setup instructions
.UNINDENT
.sp
Example States
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create security group;
  neutron_secgroup.present:
    \- name: security_group1
    \- description: \(dqVery Secure Security Group\(dq

delete security group:
  neutron_secgroup.absent:
    \- name_or_id: security_group1
    \- project_name: Project1

create security group with optional params:
  neutron_secgroup.present:
    \- name: security_group1
    \- description: \(dqVery Secure Security Group\(dq
    \- project_id: 1dcac318a83b4610b7a7f7ba01465548

create security group with optional params:
  neutron_secgroup.present:
    \- name: security_group1
    \- description: \(dqVery Secure Security Group\(dq
    \- project_name: Project1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.neutron_secgroup.absent(name, auth=None, **kwargs)
Ensure a security group does not exist
.INDENT 7.0
.TP
.B name
Name of the security group
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.neutron_secgroup.present(name, auth=None, **kwargs)
Ensure a security group exists.
.sp
You can supply either project_name or project_id.
.sp
Creating a default security group will not show up as a change;
it gets created through the lookup process.
.INDENT 7.0
.TP
.B name
Name of the security group
.TP
.B description
Description of the security group
.TP
.B project_name
Name of Project
.TP
.B project_id
ID of Project
.UNINDENT
.UNINDENT
.SS salt.states.neutron_secgroup_rule
.SS Management of OpenStack Neutron Security Group Rules
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
shade
.TP
.B configuration
see \fI\%salt.modules.neutronng\fP for setup instructions
.UNINDENT
.sp
Example States
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create security group rule:
  neutron_secgroup_rule.present:
    \- name: security_group1
    \- project_name: Project1
    \- protocol: icmp

delete security group:
  neutron_secgroup_rule.absent:
    \- name_or_id: security_group1

create security group with optional params:
  neutron_secgroup_rule.present:
    \- name: security_group1
    \- description: \(dqVery Secure Security Group\(dq
    \- project_id: 1dcac318a83b4610b7a7f7ba01465548
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.neutron_secgroup_rule.absent(name, auth=None, **kwargs)
Ensure a security group rule does not exist
.INDENT 7.0
.TP
.B name
name or id of the security group rule to delete
.TP
.B rule_id
uuid of the rule to delete
.TP
.B project_id
id of project to delete rule from
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.neutron_secgroup_rule.present(name, auth=None, **kwargs)
Ensure a security group rule exists
.INDENT 7.0
.TP
.B defaults: port_range_min=None, port_range_max=None, protocol=None,
remote_ip_prefix=None, remote_group_id=None, direction=\(aqingress\(aq,
ethertype=\(aqIPv4\(aq, project_id=None
.TP
.B name
Name of the security group to associate with this rule
.TP
.B project_name
Name of the project associated with the security group
.TP
.B protocol
The protocol that is matched by the security group rule.
Valid values are None, tcp, udp, and icmp.
.UNINDENT
.UNINDENT
.SS salt.states.neutron_subnet
.SS Management of OpenStack Neutron Subnets
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B depends
shade
.TP
.B configuration
see \fI\%salt.modules.neutronng\fP for setup instructions
.UNINDENT
.sp
Example States
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create subnet:
  neutron_subnet.present:
    \- name: subnet1
    \- network_name_or_id: network1
    \- cidr: 192.168.199.0/24


delete subnet:
  neutron_subnet.absent:
    \- name: subnet2

create subnet with optional params:
  neutron_subnet.present:
    \- name: subnet1
    \- network_name_or_id: network1
    \- enable_dhcp: True
    \- cidr: 192.168.199.0/24
    \- allocation_pools:
      \- start: 192.168.199.5
        end: 192.168.199.250
    \- host_routes:
      \- destination: 192.168..0.0/24
        nexthop: 192.168.0.1
    \- gateway_ip: 192.168.199.1
    \- dns_nameservers:
      \- 8.8.8.8
      \- 8.8.8.7

create ipv6 subnet:
  neutron_subnet.present:
    \- name: v6subnet1
    \- network_name_or_id: network1
    \- ip_version: 6
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.neutron_subnet.absent(name, auth=None)
Ensure a subnet does not exists
.INDENT 7.0
.TP
.B name
Name of the subnet
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.neutron_subnet.present(name, auth=None, **kwargs)
Ensure a subnet exists and is up\-to\-date
.INDENT 7.0
.TP
.B name
Name of the subnet
.TP
.B network_name_or_id
The unique name or ID of the attached network.
If a non\-unique name is supplied, an exception is raised.
.TP
.B allocation_pools
A list of dictionaries of the start and end addresses
for the allocation pools
.TP
.B gateway_ip
The gateway IP address.
.TP
.B dns_nameservers
A list of DNS name servers for the subnet.
.TP
.B host_routes
A list of host route dictionaries for the subnet.
.TP
.B ipv6_ra_mode
IPv6 Router Advertisement mode.
Valid values are: ‘dhcpv6\-stateful’, ‘dhcpv6\-stateless’, or ‘slaac’.
.TP
.B ipv6_address_mode
IPv6 address mode.
Valid values are: ‘dhcpv6\-stateful’, ‘dhcpv6\-stateless’, or ‘slaac’.
.UNINDENT
.UNINDENT
.SS salt.states.nexus
.sp
This state downloads artifacts from Nexus 3.x.
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B salt.states.nexus.downloaded(name, artifact, target_dir=\(aq/tmp\(aq, target_file=None)
Ensures that the artifact from nexus exists at given location. If it doesn\(aqt exist, then
it will be downloaded. If it already exists then the checksum of existing file is checked
against checksum in nexus. If it is different then the step will fail.
.INDENT 7.0
.TP
.B artifact
Details of the artifact to be downloaded from nexus. Various options are:
.INDENT 7.0
.IP \(bu 2
nexus_url: URL of the nexus instance
.IP \(bu 2
repository: Repository in nexus
.IP \(bu 2
artifact_id: Artifact ID
.IP \(bu 2
group_id: Group ID
.IP \(bu 2
packaging: Packaging
.IP \(bu 2
classifier: Classifier
.IP \(bu 2
.INDENT 2.0
.TP
.B version: Version
One of the following:
\- Version to download
\- \fBlatest\fP \- Download the latest release of this artifact
\- \fBlatest_snapshot\fP \- Download the latest snapshot for this artifact
.UNINDENT
.IP \(bu 2
username: nexus username
.IP \(bu 2
password: nexus password
.UNINDENT
.TP
.B target_dir
Directory where the artifact should be downloaded. By default it is downloaded to /tmp directory.
.TP
.B target_file
Target file to download artifact to. By default file name is resolved by nexus.
.UNINDENT
.sp
An example to download an artifact to a specific file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
jboss_module_downloaded:
  nexus.downloaded:
   \- artifact:
       nexus_url: http://nexus.intranet.example.com/repository
       repository: \(aqlibs\-release\-local\(aq
       artifact_id: \(aqmodule\(aq
       group_id: \(aqcom.company.module\(aq
       packaging: \(aqjar\(aq
       classifier: \(aqsources\(aq
       version: \(aq1.0\(aq
   \- target_file: /opt/jboss7/modules/com/company/lib/module.jar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Download artifact to the folder (automatically resolves file name):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
maven_artifact_downloaded:
  nexus.downloaded:
   \- artifact:
        nexus_url: http://nexus.intranet.example.com/repository
        repository: \(aqmaven\-releases\(aq
        artifact_id: \(aqmodule\(aq
        group_id: \(aqcom.company.module\(aq
        packaging: \(aqzip\(aq
        classifier: \(aqdist\(aq
        version: \(aq1.0\(aq
   \- target_dir: /opt/maven/modules/com/company/release
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.nfs_export
.SS Management of NFS exports
.sp
New in version 2018.3.0.

.sp
To ensure an NFS export exists:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
add_simple_export:
  nfs_export.present:
    \- name:     \(aq/srv/nfs\(aq
    \- hosts:    \(aq10.0.2.0/24\(aq
    \- options:
      \- \(aqrw\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This creates the following in /etc/exports:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/srv/nfs 10.0.2.0/24(rw)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For more complex exports with multiple groups of hosts, use \(aqclients\(aq:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
add_complex_export:
  nfs_export.present:
    \- name: \(aq/srv/nfs\(aq
    \- clients:
      # First export, same as simple one above
      \- hosts: \(aq10.0.2.0/24\(aq
        options:
          \- \(aqrw\(aq
      # Second export
      \- hosts: \(aq*.example.com\(aq
        options:
          \- \(aqro\(aq
          \- \(aqsubtree_check\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This creates the following in /etc/exports:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/srv/nfs 10.0.2.0/24(rw) 192.168.0.0/24,172.19.0.0/16(ro,subtree_check)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Any export of the given path will be modified to match the one specified.
.sp
To ensure an NFS export is absent:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
delete_export:
  nfs_export.absent:
    \- name: \(aq/srv/nfs\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.nfs_export.absent(name, exports=\(aq/etc/exports\(aq)
Ensure that the named path is not exported
.INDENT 7.0
.TP
.B name
The export path to remove
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.nfs_export.present(name, clients=None, hosts=None, options=None, exports=\(aq/etc/exports\(aq)
Ensure that the named export is present with the given options
.INDENT 7.0
.TP
.B name
The export path to configure
.TP
.B clients
A list of hosts and the options applied to them.
This option may not be used in combination with
the \(aqhosts\(aq or \(aqoptions\(aq shortcuts.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- clients:
  # First export
  \- hosts: \(aq10.0.2.0/24\(aq
    options:
      \- \(aqrw\(aq
  # Second export
  \- hosts: \(aq*.example.com\(aq
    options:
      \- \(aqro\(aq
      \- \(aqsubtree_check\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B hosts
A string matching a number of hosts, for example:
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
hosts: \(aq10.0.2.123\(aq

hosts: \(aq10.0.2.0/24\(aq

hosts: \(aqminion1.example.com\(aq

hosts: \(aq*.example.com\(aq

hosts: \(aq*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B options
A list of NFS options, for example:
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
options:
  \- \(aqrw\(aq
  \- \(aqsubtree_check\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.nftables
.SS Management of nftables
.sp
This is an nftables\-specific module designed to manage Linux firewalls. It is
expected that this state module, and other system\-specific firewall states, may
at some point be deprecated in favor of a more generic \fIfirewall\fP state.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  nftables.append:
    \- table: filter
    \- chain: input
    \- jump: accept
    \- match: state
    \- connstate: new
    \- dport: 80
    \- proto: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  nftables.append:
    \- table: filter
    \- family: ipv6
    \- chain: INPUT
    \- jump: ACCEPT
    \- match: state
    \- connstate: NEW
    \- dport: 80
    \- proto: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  nftables.insert:
    \- position: 1
    \- table: filter
    \- chain: INPUT
    \- jump: ACCEPT
    \- match: state
    \- connstate: NEW
    \- dport: 80
    \- proto: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  nftables.insert:
    \- position: 1
    \- table: filter
    \- family: ipv6
    \- chain: INPUT
    \- jump: ACCEPT
    \- match: state
    \- connstate: NEW
    \- dport: 80
    \- proto: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  nftables.delete:
    \- table: filter
    \- chain: INPUT
    \- jump: ACCEPT
    \- match: state
    \- connstate: NEW
    \- dport: 80
    \- proto: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  nftables.delete:
    \- position: 1
    \- table: filter
    \- chain: INPUT
    \- jump: ACCEPT
    \- match: state
    \- connstate: NEW
    \- dport: 80
    \- proto: tcp
    \- sport: 1025:65535
    \- save: True

httpd:
  nftables.delete:
    \- table: filter
    \- family: ipv6
    \- chain: INPUT
    \- jump: ACCEPT
    \- match: state
    \- connstate: NEW
    \- dport: 80
    \- proto: tcp
    \- sport: 1025:65535
    \- save: True

output:
  nftables.chain_present:
    \- family: ip
    \- table: filter

output:
  nftables.chain_absent:
    \- family: ip
    \- table: filter
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.nftables.append(name, family=\(aqipv4\(aq, **kwargs)
New in version 0.17.0.

.sp
Append a rule to a chain
.INDENT 7.0
.TP
.B name
A user\-defined name to call this rule by in another part of a state or
formula. This should not be an actual rule.
.TP
.B family
Network family, ipv4 or ipv6.
.UNINDENT
.sp
All other arguments are passed in with the same name as the long option
that would normally be used for nftables, with one exception: \fI\-\-state\fP is
specified as \fIconnstate\fP instead of \fIstate\fP (not to be confused with
\fIctstate\fP).
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.nftables.chain_absent(name, table=\(aqfilter\(aq, family=\(aqipv4\(aq)
New in version 2014.7.0.

.sp
Verify the chain is absent.
.INDENT 7.0
.TP
.B family
Networking family, either ipv4 or ipv6
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.nftables.chain_present(name, table=\(aqfilter\(aq, table_type=None, hook=None, priority=None, family=\(aqipv4\(aq)
New in version 2014.7.0.

.sp
Changed in version 3002.

.sp
Verify a chain exists in a table.
.INDENT 7.0
.TP
.B name
A user\-defined chain name.
.TP
.B table
The table to own the chain.
.TP
.B family
Networking family, either ipv4 or ipv6
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.nftables.delete(name, family=\(aqipv4\(aq, **kwargs)
New in version 2014.7.0.

.sp
Delete a rule to a chain
.INDENT 7.0
.TP
.B name
A user\-defined name to call this rule by in another part of a state or
formula. This should not be an actual rule.
.TP
.B family
Networking family, either ipv4 or ipv6
.UNINDENT
.sp
All other arguments are passed in with the same name as the long option
that would normally be used for nftables, with one exception: \fI\-\-state\fP is
specified as \fIconnstate\fP instead of \fIstate\fP (not to be confused with
\fIctstate\fP).
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.nftables.flush(name, family=\(aqipv4\(aq, ignore_absence=False, **kwargs)
New in version 2014.7.0.

.sp
Changed in version 3002.

.sp
Flush current nftables state
.INDENT 7.0
.TP
.B family
Networking family, either ipv4 or ipv6
.TP
.B ignore_absence
If set to True, attempts to flush a non\-existent table will not
result in a failed state.
.sp
New in version 3002.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.nftables.insert(name, family=\(aqipv4\(aq, **kwargs)
New in version 2014.7.0.

.sp
Insert a rule into a chain
.INDENT 7.0
.TP
.B name
A user\-defined name to call this rule by in another part of a state or
formula. This should not be an actual rule.
.TP
.B family
Networking family, either ipv4 or ipv6
.UNINDENT
.sp
All other arguments are passed in with the same name as the long option
that would normally be used for nftables, with one exception: \fI\-\-state\fP is
specified as \fIconnstate\fP instead of \fIstate\fP (not to be confused with
\fIctstate\fP).
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.nftables.set_policy(name, table=\(aqfilter\(aq, family=\(aqipv4\(aq, **kwargs)
New in version 3002.

.sp
Sets the default policy for nftables chains
.INDENT 7.0
.TP
.B table
The table that owns the chain that should be modified
.TP
.B family
Networking family, either ipv4 or ipv6
.TP
.B policy
The requested table policy (accept or drop)
.TP
.B save
Boolean to save the in\-memory nftables settings to a file.
.TP
.B save_filename
The filename to save the nftables settings (default: /etc/nftables
or /etc/nftables/salt\-all\-in\-one.nft if the former is a directory)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.nftables.table_absent(name, family=\(aqipv4\(aq, **kwargs)
New in version 3002.

.sp
Ensure an nftables table is absent
.INDENT 7.0
.TP
.B name
Name of the table to ensure is absent
.TP
.B family
Networking family, either ipv4 or ipv6
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.nftables.table_present(name, family=\(aqipv4\(aq, **kwargs)
New in version 3002.

.sp
Ensure an nftables table is present
.INDENT 7.0
.TP
.B name
A user\-defined table name.
.TP
.B family
Networking family, either ipv4 or ipv6
.UNINDENT
.UNINDENT
.SS salt.states.npm
.SS Installation of NPM Packages
.sp
These states manage the installed packages for node.js using the Node Package
Manager (npm). Note that npm must be installed for these states to be
available, so npm states should include a requisite to a pkg.installed state
for the package which provides npm (simply \fBnpm\fP in most cases). Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
npm:
  pkg.installed

yaml:
  npm.installed:
    \- require:
      \- pkg: npm
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.npm.bootstrap(name, user=None, silent=True)
Bootstraps a node.js application.
.sp
Will execute \(aqnpm install \-\-json\(aq on the specified directory.
.INDENT 7.0
.TP
.B user
The user to run NPM with
.sp
New in version 0.17.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.npm.cache_cleaned(name=None, user=None, force=False)
Ensure that the given package is not cached.
.sp
If no package is specified, this ensures the entire cache is cleared.
.INDENT 7.0
.TP
.B name
The name of the package to remove from the cache, or None for all packages
.TP
.B user
The user to run NPM with
.TP
.B force
Force cleaning of cache.  Required for npm@5 and greater
.sp
New in version 2016.11.6.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.npm.installed(name, pkgs=None, dir=None, user=None, force_reinstall=False, registry=None, env=None)
Verify that the given package is installed and is at the correct version
(if specified).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
coffee\-script:
  npm.installed:
    \- user: someuser

coffee\-script@1.0.1:
  npm.installed: []
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The package to install
.sp
Changed in version 2014.7.2: This parameter is no longer lowercased by salt so that
case\-sensitive NPM package names will work.

.TP
.B pkgs
A list of packages to install with a single npm invocation; specifying
this argument will ignore the \fBname\fP argument
.sp
New in version 2014.7.0.

.TP
.B dir
The target directory in which to install the package, or None for
global installation
.TP
.B user
The user to run NPM with
.sp
New in version 0.17.0.

.TP
.B registry
The NPM registry from which to install the package
.sp
New in version 2014.7.0.

.TP
.B env
A list of environment variables to be set prior to execution. The
format is the same as the \fI\%cmd.run\fP\&.
state function.
.sp
New in version 2014.7.0.

.TP
.B force_reinstall
Install the package even if it is already installed
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.npm.removed(name, dir=None, user=None)
Verify that the given package is not installed.
.INDENT 7.0
.TP
.B dir
The target directory in which to install the package, or None for
global installation
.TP
.B user
The user to run NPM with
.sp
New in version 0.17.0.

.UNINDENT
.UNINDENT
.SS salt.states.ntp
.SS Management of NTP servers
.sp
New in version 2014.1.0.

.sp
This state is used to manage NTP servers. Currently only Windows is supported.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
win_ntp:
  ntp.managed:
    \- servers:
      \- pool.ntp.org
      \- us.pool.ntp.org
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ntp.managed(name, servers=None)
Manage NTP servers
.INDENT 7.0
.TP
.B servers
A list of NTP servers
.UNINDENT
.UNINDENT
.SS salt.states.nxos
.sp
State module for Cisco NX\-OS Switch Proxy and Native minions
.sp
New in version 2016.11.0.

.sp
For documentation on setting up the nxos proxy minion look in the documentation
for \fI\%salt.proxy.nxos\fP\&.
.INDENT 0.0
.TP
.B salt.states.nxos.config_absent(name)
Ensure a specific configuration line does not exist in the running config
.INDENT 7.0
.TP
.B name
config line to remove
.UNINDENT
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
add snmp group:
  nxos.config_absent:
    \- names:
      \- snmp\-server community randoSNMPstringHERE group network\-operator
      \- snmp\-server community AnotherRandomSNMPSTring group network\-admin
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For certain cases extra lines could be removed based on dependencies.
In this example, included after the example for config_present, the
ACLs would be removed because they depend on the existence of the
group.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.nxos.config_present(name)
Ensure a specific configuration line exists in the running config
.INDENT 7.0
.TP
.B name
config line to set
.UNINDENT
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
add snmp group:
  nxos.config_present:
    \- names:
      \- snmp\-server community randoSNMPstringHERE group network\-operator
      \- snmp\-server community AnotherRandomSNMPSTring group network\-admin

add snmp acl:
  nxos.config_present:
    \- names:
      \- snmp\-server community randoSNMPstringHERE use\-acl snmp\-acl\-ro
      \- snmp\-server community AnotherRandomSNMPSTring use\-acl snmp\-acl\-rw
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.nxos.replace(name, repl, full_match=False)
Replace all instances of a string or full line in the running config
.INDENT 7.0
.TP
.B name
String to replace
.TP
.B repl
The replacement text
.TP
.B full_match
Whether \fIname\fP will match the full line or only a subset of the line.
Defaults to False. When False, .* is added around \fIname\fP for matching
in the \fIshow run\fP config.
.UNINDENT
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
replace snmp string:
  nxos.replace:
    \- name: randoSNMPstringHERE
    \- repl: NEWrandoSNMPstringHERE

replace full snmp string:
  nxos.replace:
    \- name: ^snmp\-server community randoSNMPstringHERE group network\-operator$
    \- repl: snmp\-server community NEWrandoSNMPstringHERE group network\-operator
    \- full_match: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The first example will replace the SNMP string on both the group and
the ACL, so you will not lose the ACL setting.  Because the second is
an exact match of the line, when the group is removed, the ACL is
removed, but not readded, because it was not matched.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.nxos.user_absent(name)
Ensure a user is not present
.INDENT 7.0
.TP
.B name
username to remove if it exists
.UNINDENT
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
delete:
  nxos.user_absent:
    \- name: daniel
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.nxos.user_present(name, password=None, roles=None, encrypted=False, crypt_salt=None, algorithm=\(aqsha256\(aq)
Ensure a user is present with the specified groups
.INDENT 7.0
.TP
.B name
Name of user
.TP
.B password
Encrypted or Plain Text password for user
.TP
.B roles
List of roles the user should be assigned.  Any roles not in this list will be removed
.TP
.B encrypted
Whether the password is encrypted already or not.  Defaults to False
.TP
.B crypt_salt
Salt to use when encrypting the password.  Default is None (salt is
randomly generated for unhashed passwords)
.TP
.B algorithm
Algorithm to use for hashing password.  Defaults to sha256.
Accepts md5, blowfish, sha256, sha512
.UNINDENT
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
create:
  nxos.user_present:
    \- name: daniel
    \- roles:
      \- vdc\-admin

set_password:
  nxos.user_present:
    \- name: daniel
    \- password: admin
    \- roles:
      \- network\-admin

update:
  nxos.user_present:
    \- name: daniel
    \- password: AiN9jaoP
    \- roles:
      \- network\-admin
      \- vdc\-admin
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.nxos_upgrade
.sp
Manage NX\-OS System Image Upgrades.
.sp
New in version 3001.

.INDENT 0.0
.TP
.B maturity
new
.TP
.B platform
nxos
.TP
.B codeauthor
Michael G Wiebe
.UNINDENT
.sp
For documentation on setting up the nxos proxy minion look in the documentation
for \fI\%salt.proxy.nxos\fP\&.
.INDENT 0.0
.TP
.B salt.states.nxos_upgrade.image_running(name, system_image, kickstart_image=None, issu=True, **kwargs)
Ensure the NX\-OS system image is running on the device.
.INDENT 7.0
.TP
.B name
Name of the salt state task
.TP
.B system_image
Name of the system image file on bootflash:
.TP
.B kickstart_image
Name of the kickstart image file on bootflash:
This is not needed if the system_image is a combined system and
kickstart image
Default: None
.TP
.B issu
Ensure the correct system is running on the device using an in service
software upgrade, or force a disruptive upgrade by setting the option
to False.
Default: False
.TP
.B timeout
Timeout in seconds for long running \(aqinstall all\(aq upgrade command.
Default: 900
.UNINDENT
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
upgrade_software_image_n9k:
  nxos.image_running:
    \- name: Ensure nxos.7.0.3.I7.5a.bin is running
    \- system_image: nxos.7.0.3.I7.5a.bin
    \- issu: True

upgrade_software_image_n7k:
  nxos.image_running:
    \- name: Ensure n7000\-s2\-kickstart.8.0.1.bin is running
    \- kickstart_image: n7000\-s2\-kickstart.8.0.1.bin
    \- system_image: n7000\-s2\-dk9.8.0.1.bin
    \- issu: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.openstack_config
.sp
Manage OpenStack configuration file settings.
.INDENT 0.0
.TP
.B maintainer
Jeffrey C. Ollie <\fI\%jeff@ocjtech.us\fP>
.TP
.B maturity
new
.TP
.B depends
.TP
.B platform
linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.openstack_config.absent(name, filename, section, parameter=None)
Ensure a value is not set in an OpenStack configuration file.
.INDENT 7.0
.TP
.B filename
The full path to the configuration file
.TP
.B section
The section in which the parameter will be set
.TP
.B parameter (optional)
The parameter to change.  If the parameter is not supplied, the name will be used as the parameter.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.openstack_config.present(name, filename, section, value, parameter=None)
Ensure a value is set in an OpenStack configuration file.
.INDENT 7.0
.TP
.B filename
The full path to the configuration file
.TP
.B section
The section in which the parameter will be set
.TP
.B parameter (optional)
The parameter to change.  If the parameter is not supplied, the name will be used as the parameter.
.TP
.B value
The value to set
.UNINDENT
.UNINDENT
.SS salt.states.openvswitch_bridge
.sp
Management of Open vSwitch bridges.
.INDENT 0.0
.TP
.B salt.states.openvswitch_bridge.absent(name)
Ensures that the named bridge does not exist, eventually deletes it.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- The name of the bridge.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.openvswitch_bridge.present(name, parent=None, vlan=None)
Ensures that the named bridge exists, eventually creates it.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- string
name of the bridge
.IP \(bu 2
\fBparent\fP \-\- string
name of the parent bridge (if the bridge shall be created as a fake
bridge). If specified, vlan must also be specified.
.IP \(bu 2
\fBversionadded:\fP (\fI\&..\fP) \-\- 3006.0:
.IP \(bu 2
\fBvlan\fP \-\- int
VLAN ID of the bridge (if the bridge shall be created as a fake
bridge). If specified, parent must also be specified.
.IP \(bu 2
\fBversionadded:\fP \-\- 3006.0:
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.openvswitch_db module
.sp
Management of Open vSwitch database records.
.sp
New in version 3006.0.

.INDENT 0.0
.TP
.B salt.states.openvswitch_db.managed(name, table, data, record=None)
Ensures that the specified columns of the named record have the specified
values.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- string
name of the record
.IP \(bu 2
\fBtable\fP \-\- string
name of the table to which the record belongs.
.IP \(bu 2
\fBdata\fP \-\- dict
dictionary containing a mapping from column names to the desired
values. Columns that exist, but are not specified in this
dictionary are not touched.
.IP \(bu 2
\fBrecord\fP \-\- string
name of the record (optional). Replaces name if specified.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.openvswitch_port
.sp
Management of Open vSwitch ports.
.INDENT 0.0
.TP
.B salt.states.openvswitch_port.absent(name, bridge=None)
Ensures that the named port exists on bridge, eventually deletes it.
If bridge is not set, port is removed from  whatever bridge contains it.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The name of the port.
.IP \(bu 2
\fBbridge\fP \-\- The name of the bridge.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.openvswitch_port.present(name, bridge, tunnel_type=None, id=None, remote=None, dst_port=None, internal=False)
Ensures that the named port exists on bridge, eventually creates it.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The name of the port.
.IP \(bu 2
\fBbridge\fP \-\- The name of the bridge.
.IP \(bu 2
\fBtunnel_type\fP \-\- Optional type of interface to create, currently supports: vlan, vxlan and gre.
.IP \(bu 2
\fBid\fP \-\- Optional tunnel\(aqs key.
.IP \(bu 2
\fBremote\fP \-\- Remote endpoint\(aqs IP address.
.IP \(bu 2
\fBdst_port\fP \-\- Port to use when creating tunnelport in the switch.
.IP \(bu 2
\fBinternal\fP \-\- Create an internal port if one does not exist
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.opsgenie
.SS Create/Close an alert in OpsGenie
.sp
New in version 2018.3.0.

.sp
This state is useful for creating or closing alerts in OpsGenie
during state runs.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
used_space:
  disk.status:
    \- name: /
    \- maximum: 79%
    \- minimum: 20%

opsgenie_create_action_sender:
  opsgenie.create_alert:
    \- api_key: XXXXXXXX\-XXXX\-XXXX\-XXXX\-XXXXXXXXXXXX
    \- reason: \(aqDisk capacity is out of designated range.\(aq
    \- name: disk.status
    \- onfail:
      \- disk: used_space

opsgenie_close_action_sender:
  opsgenie.close_alert:
    \- api_key: XXXXXXXX\-XXXX\-XXXX\-XXXX\-XXXXXXXXXXXX
    \- name: disk.status
    \- require:
      \- disk: used_space
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.opsgenie.close_alert(name=None, api_key=None, reason=\(aqConditions are met.\(aq, action_type=\(aqClose\(aq)
Close an alert in OpsGenie. It\(aqs a wrapper function for create_alert.
Example usage with Salt\(aqs requisites and other global state arguments
could be found above.
.sp
Required Parameters:
.INDENT 7.0
.TP
.B name
It will be used as alert\(aqs alias. If you want to use the close
functionality you must provide name field for both states like
in above case.
.UNINDENT
.sp
Optional Parameters:
.INDENT 7.0
.TP
.B api_key
It\(aqs the API Key you\(aqve copied while adding integration in OpsGenie.
.TP
.B reason
It will be used as alert\(aqs default message in OpsGenie.
.TP
.B action_type
OpsGenie supports the default values Create/Close for action_type.
You can customize this field with OpsGenie\(aqs custom actions for
other purposes like adding notes or acknowledging alerts.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.opsgenie.create_alert(name=None, api_key=None, reason=None, action_type=\(aqCreate\(aq)
Create an alert in OpsGenie. Example usage with Salt\(aqs requisites and other
global state arguments could be found above.
.sp
Required Parameters:
.INDENT 7.0
.TP
.B api_key
It\(aqs the API Key you\(aqve copied while adding integration in OpsGenie.
.TP
.B reason
It will be used as alert\(aqs default message in OpsGenie.
.UNINDENT
.sp
Optional Parameters:
.INDENT 7.0
.TP
.B name
It will be used as alert\(aqs alias. If you want to use the close
functionality you must provide name field for both states like
in above case.
.TP
.B action_type
OpsGenie supports the default values Create/Close for action_type.
You can customize this field with OpsGenie\(aqs custom actions for
other purposes like adding notes or acknowledging alerts.
.UNINDENT
.UNINDENT
.SS salt.states.pagerduty
.SS Create an Event in PagerDuty
.sp
New in version 2014.1.0.

.sp
This state is useful for creating events on the PagerDuty service during state
runs.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
server\-warning\-message:
  pagerduty.create_event:
    \- name: \(aqThis is a server warning message\(aq
    \- details: \(aqThis is a much more detailed message\(aq
    \- service_key: 9abcd123456789efabcde362783cdbaf
    \- profile: my\-pagerduty\-account
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pagerduty.create_event(name, details, service_key, profile)
Create an event on the PagerDuty service
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
server\-warning\-message:
  pagerduty.create_event:
    \- name: \(aqThis is a server warning message\(aq
    \- details: \(aqThis is a much more detailed message\(aq
    \- service_key: 9abcd123456789efabcde362783cdbaf
    \- profile: my\-pagerduty\-account
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B name
This is a short description of the event.
.TP
.B details
This can be a more detailed description of the event.
.TP
.B service_key
This key can be found by using pagerduty.list_services.
.TP
.B profile
This refers to the configuration profile to use to connect to the
PagerDuty service.
.UNINDENT
.UNINDENT
.SS salt.states.pagerduty_escalation_policy
.sp
Manage PagerDuty escalation policies.
.sp
Schedules and users can be referenced by pagerduty ID, or by name, or by email address.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ensure test escalation policy:
    pagerduty_escalation_policy.present:
        \- name: bruce test escalation policy
        \- escalation_rules:
            \- targets:
                \- type: schedule
                  id: \(aqbruce test schedule level1\(aq
                \- type: user
                  id: \(aqBruce Sherrod\(aq
              escalation_delay_in_minutes: 15
            \- targets:
                \- type: schedule
                  id: \(aqbruce test schedule level2\(aq
              escalation_delay_in_minutes: 15
            \- targets:
                \- type: user
                  id: \(aqBruce TestUser1\(aq
                \- type: user
                  id: \(aqBruce TestUser2\(aq
                \- type: user
                  id: \(aqBruce TestUser3\(aq
                \- type: user
                  id:  \(aqbruce+test4@lyft.com\(aq
              escalation_delay_in_minutes: 15
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pagerduty_escalation_policy.absent(profile=\(aqpagerduty\(aq, subdomain=None, api_key=None, **kwargs)
Ensure that a PagerDuty escalation policy does not exist.
Accepts all the arguments that pagerduty_escalation_policy.present accepts;
but ignores all arguments except the name.
.sp
Name can be the escalation policy id or the escalation policy name.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pagerduty_escalation_policy.present(profile=\(aqpagerduty\(aq, subdomain=None, api_key=None, **kwargs)
Ensure that a pagerduty escalation policy exists.  Will create or update as needed.
.sp
This method accepts as args everything defined in
\fI\%https://developer.pagerduty.com/documentation/rest/escalation_policies/create\fP\&.
In addition, user and schedule id\(aqs will be translated from name (or email address)
into PagerDuty unique ids.  For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B pagerduty_escalation_policy.present:
.INDENT 7.0
.IP \(bu 2
name: bruce test escalation policy
.IP \(bu 2
.INDENT 2.0
.TP
.B escalation_rules:
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
.B targets:
.INDENT 7.0
.IP \(bu 2
type: schedule
id: \(aqbruce test schedule level1\(aq
.IP \(bu 2
type: user
id: \(aqBruce Sherrod\(aq
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
In this example, \(aqBruce Sherrod\(aq will be looked up and replaced with the
PagerDuty id (usually a 7 digit all\-caps string, e.g. PX6GQL7)
.UNINDENT
.SS salt.states.pagerduty_schedule
.sp
Manage PagerDuty schedules.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ensure test schedule:
    pagerduty_schedule.present:
        \- name: \(aqbruce test schedule level1\(aq
        \- schedule:
            name: \(aqbruce test schedule level1\(aq
            time_zone: \(aqPacific Time (US & Canada)\(aq
            schedule_layers:
                \- name: \(aqSchedule Layer 1\(aq
                  start: \(aq2015\-01\-01T00:00:00\(aq
                  users:
                    \- user:
                        \(aqid\(aq: \(aqBruce TestUser1\(aq
                      member_order: 1
                    \- user:
                        \(aqid\(aq: \(aqBruce TestUser2\(aq
                      member_order: 2
                    \- user:
                        \(aqid\(aq: \(aqbruce+test3@lyft.com\(aq
                      member_order: 3
                    \- user:
                        \(aqid\(aq: \(aqbruce+test4@lyft.com\(aq
                      member_order: 4
                  rotation_virtual_start: \(aq2015\-01\-01T00:00:00\(aq
                  priority: 1
                  rotation_turn_length_seconds: 604800
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pagerduty_schedule.absent(profile=\(aqpagerduty\(aq, subdomain=None, api_key=None, **kwargs)
Ensure that a pagerduty schedule does not exist.
Name can be pagerduty schedule id or pagerduty schedule name.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pagerduty_schedule.present(profile=\(aqpagerduty\(aq, subdomain=None, api_key=None, **kwargs)
Ensure that a pagerduty schedule exists.
This method accepts as args everything defined in
\fI\%https://developer.pagerduty.com/documentation/rest/schedules/create\fP\&.
This means that most arguments are in a dict called \(dqschedule.\(dq
.sp
User id\(aqs can be pagerduty id, or name, or email address.
.UNINDENT
.SS salt.states.pagerduty_service
.sp
Manage PagerDuty services
.sp
Escalation policies can be referenced by pagerduty ID or by namea.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ensure test service
    pagerduty_service.present:
        \- name: \(aqmy service\(aq
        \- escalation_policy_id: \(aqmy escalation policy\(aq
        \- type: nagios
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pagerduty_service.absent(profile=\(aqpagerduty\(aq, subdomain=None, api_key=None, **kwargs)
Ensure a pagerduty service does not exist.
Name can be the service name or pagerduty service id.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pagerduty_service.present(profile=\(aqpagerduty\(aq, subdomain=None, api_key=None, **kwargs)
Ensure pagerduty service exists.
This method accepts as arguments everything defined in
\fI\%https://developer.pagerduty.com/documentation/rest/services/create\fP
.sp
Note that many arguments are mutually exclusive, depending on the \(dqtype\(dq argument.
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# create a PagerDuty email service at test\-email@DOMAIN.pagerduty.com
ensure generic email service exists:
    pagerduty_service.present:
        \- name: my email service
        \- service:
            description: \(dqemail service controlled by salt\(dq
            escalation_policy_id: \(dqmy escalation policy\(dq
            type: \(dqgeneric_email\(dq
            service_key: \(dqtest\-email\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# create a pagerduty service using cloudwatch integration
ensure my cloudwatch service exists:
    pagerduty_service.present:
        \- name: my cloudwatch service
        \- service:
            escalation_policy_id: \(dqmy escalation policy\(dq
            type: aws_cloudwatch
            description: \(dqmy cloudwatch service controlled by salt\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.pagerduty_user
.sp
Manage PagerDuty users.
.sp
Example
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B ensure bruce test user 1:
.INDENT 7.0
.TP
.B pagerduty.user_present:
.INDENT 7.0
.IP \(bu 2
name: \(aqBruce TestUser1\(aq
.IP \(bu 2
email: \fI\%bruce+test1@lyft.com\fP
.IP \(bu 2
requester_id: P1GV5NT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pagerduty_user.absent(profile=\(aqpagerduty\(aq, subdomain=None, api_key=None, **kwargs)
Ensure pagerduty user does not exist.
Name can be pagerduty id, email address, or user name.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pagerduty_user.present(profile=\(aqpagerduty\(aq, subdomain=None, api_key=None, **kwargs)
Ensure pagerduty user exists.
Arguments match those supported by
\fI\%https://developer.pagerduty.com/documentation/rest/users/create\fP\&.
.UNINDENT
.SS salt.states.panos
.sp
A state module to manage Palo Alto network devices.
.INDENT 0.0
.TP
.B codeauthor
\fBSpencer Ervin <spencer_ervin@hotmail.com>\fP
.TP
.B maturity
new
.TP
.B depends
none
.TP
.B platform
unix
.UNINDENT
.SS About
.sp
This state module was designed to handle connections to a Palo Alto based
firewall. This module relies on the Palo Alto proxy module to interface with the devices.
.sp
This state module is designed to give extreme flexibility in the control over XPATH values on the PANOS device. It
exposes the core XML API commands and allows state modules to chain complex XPATH commands.
.sp
Below is an example of how to construct a security rule and move to the top of the policy. This will take a config
lock to prevent execution during the operation, then remove the lock. After the XPATH has been deployed, it will
commit to the device.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
panos/takelock:
    panos.add_config_lock
panos/service_tcp_22:
    panos.set_config:
        \- xpath: /config/devices/entry[@name=\(aqlocalhost.localdomain\(aq]/vsys/entry[@name=\(aqvsys1\(aq]/service
        \- value: <entry name=\(aqtcp\-22\(aq><protocol><tcp><port>22</port></tcp></protocol></entry>
        \- commit: False
panos/create_rule1:
    panos.set_config:
        \- xpath: /config/devices/entry[@name=\(aqlocalhost.localdomain\(aq]/vsys/entry[@name=\(aqvsys1\(aq]/rulebase/security/rules
        \- value: \(aq
          <entry name=\(dqrule1\(dq>
            <from><member>trust</member></from>
            <to><member>untrust</member></to>
            <source><member>10.0.0.1</member></source>
            <destination><member>10.0.1.1</member></destination>
            <service><member>tcp\-22</member></service>
            <application><member>any</member></application>
            <action>allow</action>
            <disabled>no</disabled>
          </entry>\(aq
        \- commit: False
panos/moveruletop:
    panos.move_config:
        \- xpath: /config/devices/entry[@name=\(aqlocalhost.localdomain\(aq]/vsys/entry[@name=\(aqvsys1\(aq]/rulebase/security/rules/entry[@name=\(aqrule1\(aq]
        \- where: top
        \- commit: False
panos/removelock:
    panos.remove_config_lock
panos/commit:
    panos.commit_config
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Version Specific Configurations
.sp
Palo Alto devices running different versions will have different supported features and different command structures. In
order to account for this, the proxy module can be leveraged to check if the panos device is at a specific revision
level.
.sp
The proxy[\(aqpanos.is_required_version\(aq] method will check if a panos device is currently running a version equal or
greater than the passed version. For example, proxy[\(aqpanos.is_required_version\(aq](\(aq7.0.0\(aq) would match both 7.1.0 and
8.0.0.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% if proxy[\(aqpanos.is_required_version\(aq](\(aq8.0.0\(aq) %}
panos/deviceconfig/system/motd\-and\-banner:
  panos.set_config:
    \- xpath: /config/devices/entry[@name=\(aqlocalhost.localdomain\(aq]/deviceconfig/system/motd\-and\-banner
    \- value: |
      <banner\-header>BANNER TEXT</banner\-header>
      <banner\-header\-color>color2</banner\-header\-color>
      <banner\-header\-text\-color>color18</banner\-header\-text\-color>
      <banner\-header\-footer\-match>yes</banner\-header\-footer\-match>
    \- commit: False
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Palo Alto Proxy Module\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.panos.add_config_lock(name)
Prevent other users from changing configuration until the lock is released.
.sp
name: The name of the module function to execute.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
panos/takelock:
    panos.add_config_lock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.panos.address_exists(name, addressname=None, vsys=1, ipnetmask=None, iprange=None, fqdn=None, description=None, commit=False)
Ensures that an address object exists in the configured state. If it does not exist or is not configured with the
specified attributes, it will be adjusted to match the specified values.
.sp
This module will only process a single address type (ip\-netmask, ip\-range, or fqdn). It will process the specified
value if the following order: ip\-netmask, ip\-range, fqdn. For proper execution, only specify a single address
type.
.sp
name: The name of the module function to execute.
.sp
addressname(str): The name of the address object.  The name is case\-sensitive and can have up to 31 characters,
which an be letters, numbers, spaces, hyphens, and underscores. The name must be unique on a firewall and, on
Panorama, unique within its device group and any ancestor or descendant device groups.
.sp
vsys(str): The string representation of the VSYS ID. Defaults to VSYS 1.
.sp
ipnetmask(str): The IPv4 or IPv6 address or IP address range using the format ip_address/mask or ip_address where
the mask is the number of significant binary digits used for the network portion of the address. Ideally, for IPv6,
you specify only the network portion, not the host portion.
.sp
iprange(str): A range of addresses using the format ip_address–ip_address where both addresses can be  IPv4 or both
can be IPv6.
.sp
fqdn(str): A fully qualified domain name format. The FQDN initially resolves at commit time. Entries are
subsequently refreshed when the firewall performs a check every 30 minutes; all changes in the IP address for the
entries are picked up at the refresh cycle.
.sp
description(str): A description for the policy (up to 255 characters).
.sp
commit(bool): If true the firewall will commit the changes, if false do not commit changes.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
panos/address/h\-10.10.10.10:
    panos.address_exists:
      \- addressname: h\-10.10.10.10
      \- vsys: 1
      \- ipnetmask: 10.10.10.10
      \- commit: False

panos/address/10.0.0.1\-10.0.0.50:
    panos.address_exists:
      \- addressname: r\-10.0.0.1\-10.0.0.50
      \- vsys: 1
      \- iprange: 10.0.0.1\-10.0.0.50
      \- commit: False

panos/address/foo.bar.com:
    panos.address_exists:
      \- addressname: foo.bar.com
      \- vsys: 1
      \- fqdn: foo.bar.com
      \- description: My fqdn object
      \- commit: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.panos.address_group_exists(name, groupname=None, vsys=1, members=None, description=None, commit=False)
Ensures that an address group object exists in the configured state. If it does not exist or is not configured with
the specified attributes, it will be adjusted to match the specified values.
.sp
This module will enforce group membership. If a group exists and contains members this state does not include,
those members will be removed and replaced with the specified members in the state.
.sp
name: The name of the module function to execute.
.sp
groupname(str): The name of the address group object.  The name is case\-sensitive and can have up to 31 characters,
which an be letters, numbers, spaces, hyphens, and underscores. The name must be unique on a firewall and, on
Panorama, unique within its device group and any ancestor or descendant device groups.
.sp
vsys(str): The string representation of the VSYS ID. Defaults to VSYS 1.
.sp
members(str, list): The members of the address group. These must be valid address objects or address groups on the
system that already exist prior to the execution of this state.
.sp
description(str): A description for the policy (up to 255 characters).
.sp
commit(bool): If true the firewall will commit the changes, if false do not commit changes.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
panos/address\-group/my\-group:
    panos.address_group_exists:
      \- groupname: my\-group
      \- vsys: 1
      \- members:
        \- my\-address\-object
        \- my\-other\-address\-group
      \- description: A group that needs to exist
      \- commit: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.panos.clone_config(name, xpath=None, newname=None, commit=False)
Clone a specific XPATH and set it to a new name.
.sp
name: The name of the module function to execute.
.sp
xpath(str): The XPATH of the configuration API tree to clone.
.sp
newname(str): The new name of the XPATH clone.
.sp
commit(bool): If true the firewall will commit the changes, if false do not commit changes.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
panos/clonerule:
    panos.clone_config:
      \- xpath: /config/devices/entry/vsys/entry[@name=\(aqvsys1\(aq]/rulebase/security/rules&from=/config/devices/
      entry/vsys/entry[@name=\(aqvsys1\(aq]/rulebase/security/rules/entry[@name=\(aqrule1\(aq]
      \- value: rule2
      \- commit: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.panos.commit_config(name)
Commits the candidate configuration to the running configuration.
.sp
name: The name of the module function to execute.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
panos/commit:
    panos.commit_config
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.panos.delete_config(name, xpath=None, commit=False)
Deletes a Palo Alto XPATH to a specific value.
.sp
Use the xpath parameter to specify the location of the object to be deleted.
.sp
name: The name of the module function to execute.
.sp
xpath(str): The XPATH of the configuration API tree to control.
.sp
commit(bool): If true the firewall will commit the changes, if false do not commit changes.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
panos/deletegroup:
    panos.delete_config:
      \- xpath: /config/devices/entry/vsys/entry[@name=\(aqvsys1\(aq]/address\-group/entry[@name=\(aqtest\(aq]
      \- commit: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.panos.download_software(name, version=None, synch=False, check=False)
Ensures that a software version is downloaded.
.sp
name: The name of the module function to execute.
.sp
version(str): The software version to check. If this version is not already downloaded, it will attempt to download
the file from Palo Alto.
.sp
synch(bool): If true, after downloading the file it will be synched to its peer.
.sp
check(bool): If true, the PANOS device will first attempt to pull the most recent software inventory list from Palo
Alto.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
panos/version8.0.0:
    panos.download_software:
      \- version: 8.0.0
      \- synch: False
      \- check: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.panos.edit_config(name, xpath=None, value=None, commit=False)
Edits a Palo Alto XPATH to a specific value. This will always overwrite the existing value, even if it is not
changed.
.sp
You can replace an existing object hierarchy at a specified location in the configuration with a new value. Use
the xpath parameter to specify the location of the object, including the node to be replaced.
.sp
This is the recommended state to enforce configurations on a xpath.
.sp
name: The name of the module function to execute.
.sp
xpath(str): The XPATH of the configuration API tree to control.
.sp
value(str): The XML value to edit. This must be a child to the XPATH.
.sp
commit(bool): If true the firewall will commit the changes, if false do not commit changes.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
panos/addressgroup:
    panos.edit_config:
      \- xpath: /config/devices/entry/vsys/entry[@name=\(aqvsys1\(aq]/address\-group/entry[@name=\(aqtest\(aq]
      \- value: <static><entry name=\(aqtest\(aq><member>abc</member><member>xyz</member></entry></static>
      \- commit: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.panos.move_config(name, xpath=None, where=None, dst=None, commit=False)
Moves a XPATH value to a new location.
.sp
Use the xpath parameter to specify the location of the object to be moved, the where parameter to
specify type of move, and dst parameter to specify the destination path.
.sp
name: The name of the module function to execute.
.sp
xpath(str): The XPATH of the configuration API tree to move.
.sp
where(str): The type of move to execute. Valid options are after, before, top, bottom. The after and before
options will require the dst option to specify the destination of the action. The top action will move the
XPATH to the top of its structure. The botoom action will move the XPATH to the bottom of its structure.
.sp
dst(str): Optional. Specifies the destination to utilize for a move action. This is ignored for the top
or bottom action.
.sp
commit(bool): If true the firewall will commit the changes, if false do not commit changes. If the operation is
not successful, it will not commit.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
panos/moveruletop:
    panos.move_config:
      \- xpath: /config/devices/entry/vsys/entry[@name=\(aqvsys1\(aq]/rulebase/security/rules/entry[@name=\(aqrule1\(aq]
      \- where: top
      \- commit: True

panos/moveruleafter:
    panos.move_config:
      \- xpath: /config/devices/entry/vsys/entry[@name=\(aqvsys1\(aq]/rulebase/security/rules/entry[@name=\(aqrule1\(aq]
      \- where: after
      \- dst: rule2
      \- commit: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.panos.remove_config_lock(name)
Release config lock previously held.
.sp
name: The name of the module function to execute.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
panos/takelock:
    panos.remove_config_lock
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.panos.rename_config(name, xpath=None, newname=None, commit=False)
Rename a Palo Alto XPATH to a specific value. This will always rename the value even if a change is not needed.
.sp
name: The name of the module function to execute.
.sp
xpath(str): The XPATH of the configuration API tree to control.
.sp
newname(str): The new name of the XPATH value.
.sp
commit(bool): If true the firewall will commit the changes, if false do not commit changes.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
panos/renamegroup:
    panos.rename_config:
      \- xpath: /config/devices/entry/vsys/entry[@name=\(aqvsys1\(aq]/address/entry[@name=\(aqold_address\(aq]
      \- value: new_address
      \- commit: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.panos.security_rule_exists(name, rulename=None, vsys=\(aq1\(aq, action=None, disabled=None, sourcezone=None, destinationzone=None, source=None, destination=None, application=None, service=None, description=None, logsetting=None, logstart=None, logend=None, negatesource=None, negatedestination=None, profilegroup=None, datafilter=None, fileblock=None, spyware=None, urlfilter=None, virus=None, vulnerability=None, wildfire=None, move=None, movetarget=None, commit=False)
Ensures that a security rule exists on the device. Also, ensure that all configurations are set appropriately.
.sp
This method will create the rule if it does not exist. If the rule does exist, it will ensure that the
configurations are set appropriately.
.sp
If the rule does not exist and is created, any value that is not provided will be provided as the default.
The action, to, from, source, destination, application, and service fields are mandatory and must be provided.
.sp
This will enforce the exact match of the rule. For example, if the rule is currently configured with the log\-end
option, but this option is not specified in the state method, it will be removed and reset to the system default.
.sp
It is strongly recommended to specify all options to ensure proper operation.
.sp
When defining the profile group settings, the device can only support either a profile group or individual settings.
If both are specified, the profile group will be preferred and the individual settings are ignored. If neither are
specified, the value will be set to system default of none.
.sp
name: The name of the module function to execute.
.sp
rulename(str): The name of the security rule.  The name is case\-sensitive and can have up to 31 characters, which
can be letters, numbers, spaces, hyphens, and underscores. The name must be unique on a firewall and, on Panorama,
unique within its device group and any ancestor or descendant device groups.
.sp
vsys(str): The string representation of the VSYS ID. Defaults to VSYS 1.
.sp
action(str): The action that the security rule will enforce. Valid options are: allow, deny, drop, reset\-client,
reset\-server, reset\-both.
.sp
disabled(bool): Controls if the rule is disabled. Set \(aqTrue\(aq to disable and \(aqFalse\(aq to enable.
.sp
sourcezone(str, list): The source zone(s). The value \(aqany\(aq will match all zones.
.sp
destinationzone(str, list): The destination zone(s). The value \(aqany\(aq will match all zones.
.sp
source(str, list): The source address(es). The value \(aqany\(aq will match all addresses.
.sp
destination(str, list): The destination address(es). The value \(aqany\(aq will match all addresses.
.sp
application(str, list): The application(s) matched. The value \(aqany\(aq will match all applications.
.sp
service(str, list): The service(s) matched. The value \(aqany\(aq will match all services. The value
\(aqapplication\-default\(aq will match based upon the application defined ports.
.sp
description(str): A description for the policy (up to 255 characters).
.sp
logsetting(str): The name of a valid log forwarding profile.
.sp
logstart(bool): Generates a traffic log entry for the start of a session (disabled by default).
.sp
logend(bool): Generates a traffic log entry for the end of a session (enabled by default).
.sp
negatesource(bool): Match all but the specified source addresses.
.sp
negatedestination(bool): Match all but the specified destination addresses.
.sp
profilegroup(str): A valid profile group name.
.sp
datafilter(str): A valid data filter profile name. Ignored with the profilegroup option set.
.sp
fileblock(str): A valid file blocking profile name. Ignored with the profilegroup option set.
.sp
spyware(str): A valid spyware profile name. Ignored with the profilegroup option set.
.sp
urlfilter(str): A valid URL filtering profile name. Ignored with the profilegroup option set.
.sp
virus(str): A valid virus profile name. Ignored with the profilegroup option set.
.sp
vulnerability(str): A valid vulnerability profile name. Ignored with the profilegroup option set.
.sp
wildfire(str): A valid vulnerability profile name. Ignored with the profilegroup option set.
.sp
move(str): An optional argument that ensure the rule is moved to a specific location. Valid options are \(aqtop\(aq,
\(aqbottom\(aq, \(aqbefore\(aq, or \(aqafter\(aq. The \(aqbefore\(aq and \(aqafter\(aq options require the use of the \(aqmovetarget\(aq argument
to define the location of the move request.
.sp
movetarget(str): An optional argument that defines the target of the move operation if the move argument is
set to \(aqbefore\(aq or \(aqafter\(aq.
.sp
commit(bool): If true the firewall will commit the changes, if false do not commit changes.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
panos/rulebase/security/rule01:
    panos.security_rule_exists:
      \- rulename: rule01
      \- vsys: 1
      \- action: allow
      \- disabled: False
      \- sourcezone: untrust
      \- destinationzone: trust
      \- source:
        \- 10.10.10.0/24
        \- 1.1.1.1
      \- destination:
        \- 2.2.2.2\-2.2.2.4
      \- application:
        \- any
      \- service:
        \- tcp\-25
      \- description: My test security rule
      \- logsetting: logprofile
      \- logstart: False
      \- logend: True
      \- negatesource: False
      \- negatedestination: False
      \- profilegroup: myprofilegroup
      \- move: top
      \- commit: False

panos/rulebase/security/rule01:
    panos.security_rule_exists:
      \- rulename: rule01
      \- vsys: 1
      \- action: allow
      \- disabled: False
      \- sourcezone: untrust
      \- destinationzone: trust
      \- source:
        \- 10.10.10.0/24
        \- 1.1.1.1
      \- destination:
        \- 2.2.2.2\-2.2.2.4
      \- application:
        \- any
      \- service:
        \- tcp\-25
      \- description: My test security rule
      \- logsetting: logprofile
      \- logstart: False
      \- logend: False
      \- datafilter: foobar
      \- fileblock: foobar
      \- spyware: foobar
      \- urlfilter: foobar
      \- virus: foobar
      \- vulnerability: foobar
      \- wildfire: foobar
      \- move: after
      \- movetarget: rule02
      \- commit: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.panos.service_exists(name, servicename=None, vsys=1, protocol=None, port=None, description=None, commit=False)
Ensures that a service object exists in the configured state. If it does not exist or is not configured with the
specified attributes, it will be adjusted to match the specified values.
.sp
name: The name of the module function to execute.
.sp
servicename(str): The name of the security object.  The name is case\-sensitive and can have up to 31 characters,
which an be letters, numbers, spaces, hyphens, and underscores. The name must be unique on a firewall and, on
Panorama, unique within its device group and any ancestor or descendant device groups.
.sp
vsys(str): The string representation of the VSYS ID. Defaults to VSYS 1.
.sp
protocol(str): The protocol that is used by the service object. The only valid options are tcp and udp.
.sp
port(str): The port number that is used by the service object. This can be specified as a single integer or a
valid range of ports.
.sp
description(str): A description for the policy (up to 255 characters).
.sp
commit(bool): If true the firewall will commit the changes, if false do not commit changes.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
panos/service/tcp\-80:
    panos.service_exists:
      \- servicename: tcp\-80
      \- vsys: 1
      \- protocol: tcp
      \- port: 80
      \- description: Hypertext Transfer Protocol
      \- commit: False

panos/service/udp\-500\-550:
    panos.service_exists:
      \- servicename: udp\-500\-550
      \- vsys: 3
      \- protocol: udp
      \- port: 500\-550
      \- commit: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.panos.service_group_exists(name, groupname=None, vsys=1, members=None, description=None, commit=False)
Ensures that a service group object exists in the configured state. If it does not exist or is not configured with
the specified attributes, it will be adjusted to match the specified values.
.sp
This module will enforce group membership. If a group exists and contains members this state does not include,
those members will be removed and replaced with the specified members in the state.
.sp
name: The name of the module function to execute.
.sp
groupname(str): The name of the service group object.  The name is case\-sensitive and can have up to 31 characters,
which an be letters, numbers, spaces, hyphens, and underscores. The name must be unique on a firewall and, on
Panorama, unique within its device group and any ancestor or descendant device groups.
.sp
vsys(str): The string representation of the VSYS ID. Defaults to VSYS 1.
.sp
members(str, list): The members of the service group. These must be valid service objects or service groups on the
system that already exist prior to the execution of this state.
.sp
description(str): A description for the policy (up to 255 characters).
.sp
commit(bool): If true the firewall will commit the changes, if false do not commit changes.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
panos/service\-group/my\-group:
    panos.service_group_exists:
      \- groupname: my\-group
      \- vsys: 1
      \- members:
        \- tcp\-80
        \- custom\-port\-group
      \- description: A group that needs to exist
      \- commit: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.panos.set_config(name, xpath=None, value=None, commit=False)
Sets a Palo Alto XPATH to a specific value. This will always overwrite the existing value, even if it is not
changed.
.sp
You can add or create a new object at a specified location in the configuration hierarchy. Use the xpath parameter
to specify the location of the object in the configuration
.sp
name: The name of the module function to execute.
.sp
xpath(str): The XPATH of the configuration API tree to control.
.sp
value(str): The XML value to set. This must be a child to the XPATH.
.sp
commit(bool): If true the firewall will commit the changes, if false do not commit changes.
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
panos/hostname:
    panos.set_config:
      \- xpath: /config/devices/entry[@name=\(aqlocalhost.localdomain\(aq]/deviceconfig/system
      \- value: <hostname>foobar</hostname>
      \- commit: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.pbm
.sp
Manages VMware storage policies
(called pbm because the vCenter endpoint is /pbm)
.sp
Examples
.SS Storage policy
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqname\(dq: \(dqsalt_storage_policy\(dq
    \(dqdescription\(dq: \(dqManaged by Salt. Random capability values.\(dq,
    \(dqresource_type\(dq: \(dqSTORAGE\(dq,
    \(dqsubprofiles\(dq: [
        {
            \(dqcapabilities\(dq: [
                {
                    \(dqsetting\(dq: {
                        \(dqtype\(dq: \(dqscalar\(dq,
                        \(dqvalue\(dq: 2
                    },
                    \(dqnamespace\(dq: \(dqVSAN\(dq,
                    \(dqid\(dq: \(dqhostFailuresToTolerate\(dq
                },
                {
                    \(dqsetting\(dq: {
                        \(dqtype\(dq: \(dqscalar\(dq,
                        \(dqvalue\(dq: 2
                    },
                    \(dqnamespace\(dq: \(dqVSAN\(dq,
                    \(dqid\(dq: \(dqstripeWidth\(dq
                },
                {
                    \(dqsetting\(dq: {
                        \(dqtype\(dq: \(dqscalar\(dq,
                        \(dqvalue\(dq: true
                    },
                    \(dqnamespace\(dq: \(dqVSAN\(dq,
                    \(dqid\(dq: \(dqforceProvisioning\(dq
                },
                {
                    \(dqsetting\(dq: {
                        \(dqtype\(dq: \(dqscalar\(dq,
                        \(dqvalue\(dq: 50
                    },
                    \(dqnamespace\(dq: \(dqVSAN\(dq,
                    \(dqid\(dq: \(dqproportionalCapacity\(dq
                },
                {
                    \(dqsetting\(dq: {
                        \(dqtype\(dq: \(dqscalar\(dq,
                        \(dqvalue\(dq: 0
                    },
                    \(dqnamespace\(dq: \(dqVSAN\(dq,
                    \(dqid\(dq: \(dqcacheReservation\(dq
                }
            ],
            \(dqname\(dq: \(dqRule\-Set 1: VSAN\(dq,
            \(dqforce_provision\(dq: null
        }
    ],
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
pyVmomi Python Module
.UNINDENT
.SS pyVmomi
.sp
PyVmomi can be installed via pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyVmomi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Version 6.0 of pyVmomi has some problems with SSL error handling on certain
versions of Python. If using version 6.0 of pyVmomi, Python 2.6,
Python 2.7.9, or newer must be present. This is due to an upstream dependency
in pyVmomi 6.0 that is not supported in Python versions 2.7 to 2.7.8. If the
version of Python is not in the supported range, you will need to install an
earlier version of pyVmomi. See
\fIIssue #29537 <https://github.com/saltstack/salt/issues/29537>\fP for more
information.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pbm.default_storage_policy_assigned(name, policy, datastore)
Assigns a default storage policy to a datastore
.INDENT 7.0
.TP
.B policy
Name of storage policy
.TP
.B datastore
Name of datastore
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pbm.default_vsan_policy_configured(name, policy)
Configures the default VSAN policy on a vCenter.
The state assumes there is only one default VSAN policy on a vCenter.
.INDENT 7.0
.TP
.B policy
Dict representation of a policy
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pbm.storage_policies_configured(name, policies)
Configures storage policies on a vCenter.
.INDENT 7.0
.TP
.B policies
List of dict representation of the required storage policies
.UNINDENT
.UNINDENT
.SS salt.states.pcs
.SS Management of Pacemaker/Corosync clusters with PCS
.sp
A state module to manage Pacemaker/Corosync clusters
with the Pacemaker/Corosync configuration system (PCS)
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B depends
pcs
.UNINDENT
.sp
Walkthrough of a complete PCS cluster setup:
\fI\%http://clusterlabs.org/doc/en\-US/Pacemaker/1.1/html/Clusters_from_Scratch/\fP
.INDENT 0.0
.TP
.B Requirements:
PCS is installed, pcs service is started and
the password for the hacluster user is set and known.
.TP
.B Remark on the cibname variable used in the examples:
The use of the cibname variable is optional.
Use it only if you want to deploy your changes into a cibfile first and then push it.
This makes only sense if you want to deploy multiple changes (which require each other) at once to the cluster.
.UNINDENT
.sp
At first the cibfile must be created:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql_pcs__cib_present_cib_for_galera:
    pcs.cib_present:
        \- cibname: cib_for_galera
        \- scope: None
        \- extra_args: None
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then the cibfile can be modified by creating resources (creating only 1 resource for demonstration, see also 7.):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql_pcs__resource_present_galera:
    pcs.resource_present:
        \- resource_id: galera
        \- resource_type: \(dqocf:heartbeat:galera\(dq
        \- resource_options:
            \- \(aqwsrep_cluster_address=gcomm://node1.example.org,node2.example.org,node3.example.org\(aq
            \- \(aq\-\-master\(aq
        \- cibname: cib_for_galera
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
After modifying the cibfile, it can be pushed to the live CIB in the cluster:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql_pcs__cib_pushed_cib_for_galera:
    pcs.cib_pushed:
        \- cibname: cib_for_galera
        \- scope: None
        \- extra_args: None
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Create a cluster from scratch:
.INDENT 0.0
.IP 1. 3
.INDENT 3.0
.TP
.B This authorizes nodes to each other. It probably won\(aqt work with Ubuntu as
it rolls out a default cluster that needs to be destroyed before the
new cluster can be created. This is a little complicated so it\(aqs best
to just run the cluster_setup below in most cases.:
.UNINDENT
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
pcs_auth__auth:
    pcs.auth:
        \- nodes:
            \- node1.example.com
            \- node2.example.com
        \- pcsuser: hacluster
        \- pcspasswd: hoonetorg
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
Do the initial cluster setup:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
pcs_setup__setup:
    pcs.cluster_setup:
        \- nodes:
            \- node1.example.com
            \- node2.example.com
        \- pcsclustername: pcscluster
        \- extra_args:
            \- \(aq\-\-start\(aq
            \- \(aq\-\-enable\(aq
        \- pcsuser: hacluster
        \- pcspasswd: hoonetorg
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
Optional: Set cluster properties:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
pcs_properties__prop_has_value_no\-quorum\-policy:
    pcs.prop_has_value:
        \- prop: no\-quorum\-policy
        \- value: ignore
        \- cibname: cib_for_cluster_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 4. 3
Optional: Set resource defaults:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
pcs_properties__resource_defaults_to_resource\-stickiness:
    pcs.resource_defaults_to:
        \- default: resource\-stickiness
        \- value: 100
        \- cibname: cib_for_cluster_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 5. 3
Optional: Set resource op defaults:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
pcs_properties__resource_op_defaults_to_monitor\-interval:
    pcs.resource_op_defaults_to:
        \- op_default: monitor\-interval
        \- value: 60s
        \- cibname: cib_for_cluster_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 6. 3
Configure Fencing (!is often not optional on production ready cluster!):
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
pcs_stonith__created_eps_fence:
    pcs.stonith_present:
        \- stonith_id: eps_fence
        \- stonith_device_type: fence_eps
        \- stonith_device_options:
            \- \(aqpcmk_host_map=node1.example.org:01;node2.example.org:02\(aq
            \- \(aqipaddr=myepsdevice.example.org\(aq
            \- \(aqpower_wait=5\(aq
            \- \(aqverbose=1\(aq
            \- \(aqdebug=/var/log/pcsd/eps_fence.log\(aq
            \- \(aqlogin=hidden\(aq
            \- \(aqpasswd=hoonetorg\(aq
        \- cibname: cib_for_stonith
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 7. 3
Add resources to your cluster:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
mysql_pcs__resource_present_galera:
    pcs.resource_present:
        \- resource_id: galera
        \- resource_type: \(dqocf:heartbeat:galera\(dq
        \- resource_options:
            \- \(aqwsrep_cluster_address=gcomm://node1.example.org,node2.example.org,node3.example.org\(aq
             \- \(aq\-\-master\(aq
         \- cibname: cib_for_galera
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 8. 3
Optional: Add constraints (locations, colocations, orders):
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
haproxy_pcs__constraint_present_colocation\-vip_galera\-haproxy\-clone\-INFINITY:
    pcs.constraint_present:
        \- constraint_id: colocation\-vip_galera\-haproxy\-clone\-INFINITY
        \- constraint_type: colocation
        \- constraint_options:
            \- \(aqadd\(aq
            \- \(aqvip_galera\(aq
            \- \(aqwith\(aq
            \- \(aqhaproxy\-clone\(aq
        \- cibname: cib_for_haproxy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.states.pcs.auth(name, nodes, pcsuser=\(aqhacluster\(aq, pcspasswd=\(aqhacluster\(aq, extra_args=None)
Ensure all nodes are authorized to the cluster
.INDENT 7.0
.TP
.B name
Irrelevant, not used (recommended: pcs_auth__auth)
.TP
.B nodes
a list of nodes which should be authorized to the cluster
.TP
.B pcsuser
user for communication with pcs (default: hacluster)
.TP
.B pcspasswd
password for pcsuser (default: hacluster)
.TP
.B extra_args
list of extra args for the \(aqpcs cluster auth\(aq command, there are none so it\(aqs here for compatibility.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pcs_auth__auth:
    pcs.auth:
        \- nodes:
            \- node1.example.com
            \- node2.example.com
        \- pcsuser: hacluster
        \- pcspasswd: hoonetorg
        \- extra_args: []
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pcs.cib_present(name, cibname, scope=None, extra_args=None)
Ensure that a CIB\-file with the content of the current live CIB is created
.sp
Should be run on one cluster node only
(there may be races)
.INDENT 7.0
.TP
.B name
Irrelevant, not used (recommended: {{formulaname}}__cib_present_{{cibname}})
.TP
.B cibname
name/path of the file containing the CIB
.TP
.B scope
specific section of the CIB (default: None)
.TP
.B extra_args
additional options for creating the CIB\-file
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mysql_pcs__cib_present_cib_for_galera:
    pcs.cib_present:
        \- cibname: cib_for_galera
        \- scope: None
        \- extra_args: None
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pcs.cib_pushed(name, cibname, scope=None, extra_args=None)
Ensure that a CIB\-file is pushed if it is changed since the creation of it with pcs.cib_present
.sp
Should be run on one cluster node only
(there may be races)
.INDENT 7.0
.TP
.B name
Irrelevant, not used (recommended: {{formulaname}}__cib_pushed_{{cibname}})
.TP
.B cibname
name/path of the file containing the CIB
.TP
.B scope
specific section of the CIB
.TP
.B extra_args
additional options for creating the CIB\-file
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mysql_pcs__cib_pushed_cib_for_galera:
    pcs.cib_pushed:
        \- cibname: cib_for_galera
        \- scope: None
        \- extra_args: None
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pcs.cluster_node_present(name, node, extra_args=None)
Add a node to the Pacemaker cluster via PCS
Should be run on one cluster node only
(there may be races)
Can only be run on a already setup/added node
.INDENT 7.0
.TP
.B name
Irrelevant, not used (recommended: pcs_setup__node_add_{{node}})
.TP
.B node
node that should be added
.TP
.B extra_args
list of extra args for the \(aqpcs cluster node add\(aq command
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pcs_setup__node_add_node1.example.com:
    pcs.cluster_node_present:
        \- node: node1.example.com
        \- extra_args:
            \- \(aq\-\-start\(aq
            \- \(aq\-\-enable\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pcs.cluster_setup(name, nodes, pcsclustername=\(aqpcscluster\(aq, extra_args=None, pcsuser=\(aqhacluster\(aq, pcspasswd=\(aqhacluster\(aq, pcs_auth_extra_args=None, wipe_default=False)
Setup Pacemaker cluster on nodes.
Should be run on one cluster node only to avoid race conditions.
This performs auth as well as setup so can be run in place of the auth state.
It is recommended not to run auth on Debian/Ubuntu for a new cluster and just
to run this because of the initial cluster config that is installed on
Ubuntu/Debian by default.
.INDENT 7.0
.TP
.B name
Irrelevant, not used (recommended: pcs_setup__setup)
.TP
.B nodes
a list of nodes which should be set up
.TP
.B pcsclustername
Name of the Pacemaker cluster
.TP
.B extra_args
list of extra args for the \(aqpcs cluster setup\(aq command
.TP
.B pcsuser
The username for authenticating the cluster (default: hacluster)
.TP
.B pcspasswd
The password for authenticating the cluster (default: hacluster)
.TP
.B pcs_auth_extra_args
Extra args to be passed to the auth function in case of reauth.
.TP
.B wipe_default
This removes the files that are installed with Debian based operating systems.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pcs_setup__setup:
    pcs.cluster_setup:
        \- nodes:
            \- node1.example.com
            \- node2.example.com
        \- pcsclustername: pcscluster
        \- extra_args:
            \- \(aq\-\-start\(aq
            \- \(aq\-\-enable\(aq
        \- pcsuser: hacluster
        \- pcspasswd: hoonetorg
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pcs.constraint_present(name, constraint_id, constraint_type, constraint_options=None, cibname=None)
Ensure that a constraint is created
.sp
Should be run on one cluster node only
(there may be races)
Can only be run on a node with a functional pacemaker/corosync
.INDENT 7.0
.TP
.B name
Irrelevant, not used (recommended: {{formulaname}}__constraint_present_{{constraint_id}})
.TP
.B constraint_id
name for the constraint (try first to create manually to find out the autocreated name)
.TP
.B constraint_type
constraint type (location, colocation, order)
.TP
.B constraint_options
options for creating the constraint
.TP
.B cibname
use a cached CIB\-file named like cibname instead of the live CIB
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
haproxy_pcs__constraint_present_colocation\-vip_galera\-haproxy\-clone\-INFINITY:
    pcs.constraint_present:
        \- constraint_id: colocation\-vip_galera\-haproxy\-clone\-INFINITY
        \- constraint_type: colocation
        \- constraint_options:
            \- \(aqadd\(aq
            \- \(aqvip_galera\(aq
            \- \(aqwith\(aq
            \- \(aqhaproxy\-clone\(aq
        \- cibname: cib_for_haproxy
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pcs.prop_has_value(name, prop, value, extra_args=None, cibname=None)
Ensure that a property in the cluster is set to a given value
.sp
Should be run on one cluster node only
(there may be races)
.INDENT 7.0
.TP
.B name
Irrelevant, not used (recommended: pcs_properties__prop_has_value_{{prop}})
.TP
.B prop
name of the property
.TP
.B value
value of the property
.TP
.B extra_args
additional options for the pcs property command
.TP
.B cibname
use a cached CIB\-file named like cibname instead of the live CIB
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pcs_properties__prop_has_value_no\-quorum\-policy:
    pcs.prop_has_value:
        \- prop: no\-quorum\-policy
        \- value: ignore
        \- cibname: cib_for_cluster_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pcs.resource_defaults_to(name, default, value, extra_args=None, cibname=None)
Ensure a resource default in the cluster is set to a given value
.sp
Should be run on one cluster node only
(there may be races)
Can only be run on a node with a functional pacemaker/corosync
.INDENT 7.0
.TP
.B name
Irrelevant, not used (recommended: pcs_properties__resource_defaults_to_{{default}})
.TP
.B default
name of the default resource property
.TP
.B value
value of the default resource property
.TP
.B extra_args
additional options for the pcs command
.TP
.B cibname
use a cached CIB\-file named like cibname instead of the live CIB
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pcs_properties__resource_defaults_to_resource\-stickiness:
    pcs.resource_defaults_to:
        \- default: resource\-stickiness
        \- value: 100
        \- cibname: cib_for_cluster_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pcs.resource_op_defaults_to(name, op_default, value, extra_args=None, cibname=None)
Ensure a resource operation default in the cluster is set to a given value
.sp
Should be run on one cluster node only
(there may be races)
Can only be run on a node with a functional pacemaker/corosync
.INDENT 7.0
.TP
.B name
Irrelevant, not used (recommended: pcs_properties__resource_op_defaults_to_{{op_default}})
.TP
.B op_default
name of the operation default resource property
.TP
.B value
value of the operation default resource property
.TP
.B extra_args
additional options for the pcs command
.TP
.B cibname
use a cached CIB\-file named like cibname instead of the live CIB
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pcs_properties__resource_op_defaults_to_monitor\-interval:
    pcs.resource_op_defaults_to:
        \- op_default: monitor\-interval
        \- value: 60s
        \- cibname: cib_for_cluster_settings
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pcs.resource_present(name, resource_id, resource_type, resource_options=None, cibname=None)
Ensure that a resource is created
.sp
Should be run on one cluster node only
(there may be races)
Can only be run on a node with a functional pacemaker/corosync
.INDENT 7.0
.TP
.B name
Irrelevant, not used (recommended: {{formulaname}}__resource_present_{{resource_id}})
.TP
.B resource_id
name for the resource
.TP
.B resource_type
resource type (f.e. ocf:heartbeat:IPaddr2 or VirtualIP)
.TP
.B resource_options
additional options for creating the resource
.TP
.B cibname
use a cached CIB\-file named like cibname instead of the live CIB
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mysql_pcs__resource_present_galera:
    pcs.resource_present:
        \- resource_id: galera
        \- resource_type: \(dqocf:heartbeat:galera\(dq
        \- resource_options:
            \- \(aqwsrep_cluster_address=gcomm://node1.example.org,node2.example.org,node3.example.org\(aq
            \- \(aq\-\-master\(aq
        \- cibname: cib_for_galera
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pcs.stonith_present(name, stonith_id, stonith_device_type, stonith_device_options=None, cibname=None)
Ensure that a fencing resource is created
.sp
Should be run on one cluster node only
(there may be races)
Can only be run on a node with a functional pacemaker/corosync
.INDENT 7.0
.TP
.B name
Irrelevant, not used (recommended: pcs_stonith__created_{{stonith_id}})
.TP
.B stonith_id
name for the stonith resource
.TP
.B stonith_device_type
name of the stonith agent fence_eps, fence_xvm f.e.
.TP
.B stonith_device_options
additional options for creating the stonith resource
.TP
.B cibname
use a cached CIB\-file named like cibname instead of the live CIB
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pcs_stonith__created_eps_fence:
    pcs.stonith_present:
        \- stonith_id: eps_fence
        \- stonith_device_type: fence_eps
        \- stonith_device_options:
            \- \(aqpcmk_host_map=node1.example.org:01;node2.example.org:02\(aq
            \- \(aqipaddr=myepsdevice.example.org\(aq
            \- \(aqpower_wait=5\(aq
            \- \(aqverbose=1\(aq
            \- \(aqdebug=/var/log/pcsd/eps_fence.log\(aq
            \- \(aqlogin=hidden\(aq
            \- \(aqpasswd=hoonetorg\(aq
        \- cibname: cib_for_stonith
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.pdbedit
.sp
Manage accounts in Samba\(aqs passdb using pdbedit
.INDENT 0.0
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B depends
pdbedit
.TP
.B platform
posix
.UNINDENT
.sp
New in version 2017.7.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
wash:
  pdbedit.absent

kaylee:
  pdbedit.managed:
    \- password: A70C708517B5DD0EDB67714FE25336EB
    \- password_hashed: True
    \- drive: \(aqX:\(aq
    \- homedir: \(aq\e\eserenity\emechanic\eprofile\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pdbedit.absent(name)
Ensure user account is absent
.INDENT 7.0
.TP
.B name
string
username
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pdbedit.managed(name, **kwargs)
Manage user account
.INDENT 7.0
.TP
.B login
string
login name
.TP
.B password
string
password
.TP
.B password_hashed
boolean
set if password is a nt hash instead of plain text
.TP
.B domain
string
users domain
.TP
.B profile
string
profile path
.TP
.B script
string
logon script
.TP
.B drive
string
home drive
.TP
.B homedir
string
home directory
.TP
.B fullname
string
full name
.TP
.B account_desc
string
account description
.TP
.B machine_sid
string
specify the machines new primary group SID or rid
.TP
.B user_sid
string
specify the users new primary group SID or rid
.TP
.B account_control
string
specify user account control properties
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Only the following can be set:
\- N: No password required
\- D: Account disabled
\- H: Home directory required
\- L: Automatic Locking
\- X: Password does not expire
.UNINDENT
.UNINDENT
.TP
.B reset_login_hours
boolean
reset the users allowed logon hours
.TP
.B reset_bad_password_count
boolean
reset the stored bad login counter
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pdbedit.present(name, **kwargs)
Alias for pdbedit.managed
.UNINDENT
.SS salt.states.pecl
.SS Installation of PHP Extensions Using pecl
.sp
These states manage the installed pecl extensions. Note that php\-pear must be
installed for these states to be available, so pecl states should include a
requisite to a pkg.installed state for the package which provides pecl
(\fBphp\-pear\fP in most cases). Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
php\-pear:
  pkg.installed

mongo:
  pecl.installed:
    \- require:
      \- pkg: php\-pear
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pecl.installed(name, version=None, defaults=False, force=False, preferred_state=\(aqstable\(aq)
New in version 0.17.0.

.sp
Make sure that a pecl extension is installed.
.INDENT 7.0
.TP
.B name
The pecl extension name to install
.TP
.B version
The pecl extension version to install. This option may be
ignored to install the latest stable version.
.TP
.B defaults
Use default answers for extensions such as pecl_http which ask
questions before installation. Without this option, the pecl.installed
state will hang indefinitely when trying to install these extensions.
.TP
.B force
Whether to force the installed version or not
.TP
.B preferred_state
The pecl extension state to install
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pecl.removed(name)
Make sure that a pecl extension is not installed.
.INDENT 7.0
.TP
.B name
The pecl extension name to uninstall
.UNINDENT
.UNINDENT
.SS salt.states.pip_state
.SS Installation of Python Packages Using pip
.sp
These states manage system installed python packages. Note that pip must be
installed for these states to be available, so pip states should include a
requisite to a pkg.installed state for the package which provides pip
(\fBpython\-pip\fP in most cases). Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python\-pip:
  pkg.installed

virtualenvwrapper:
  pip.installed:
    \- require:
      \- pkg: python\-pip
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pip_state.installed(name, pkgs=None, pip_bin=None, requirements=None, bin_env=None, use_wheel=False, no_use_wheel=False, log=None, proxy=None, timeout=None, repo=None, editable=None, find_links=None, index_url=None, extra_index_url=None, no_index=False, mirrors=None, build=None, target=None, download=None, download_cache=None, source=None, upgrade=False, force_reinstall=False, ignore_installed=False, exists_action=None, no_deps=False, no_install=False, no_download=False, install_options=None, global_options=None, user=None, cwd=None, pre_releases=False, cert=None, allow_all_external=False, allow_external=None, allow_unverified=None, process_dependency_links=False, env_vars=None, use_vt=False, trusted_host=None, no_cache_dir=False, cache_dir=None, no_binary=None, extra_args=None, **kwargs)
Make sure the package is installed
.INDENT 7.0
.TP
.B name
The name of the python package to install. You can also specify version
numbers here using the standard operators \fB==, >=, <=\fP\&. If
\fBrequirements\fP or \fBpkgs\fP is given, this parameter will be ignored.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
django:
  pip.installed:
    \- name: django >= 1.6, <= 1.7
    \- require:
      \- pkg: python\-pip
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Installs the latest Django version greater than 1.6 but less
than 1.7.
.TP
.B pkgs
A list of python packages to install. This let you install multiple
packages at the same time.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
django\-and\-psycopg2:
  pip.installed:
    \- pkgs:
      \- django >= 1.6, <= 1.7
      \- psycopg2 >= 2.8.4
    \- require:
      \- pkg: python\-pip
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Installs the latest Django version greater than 1.6 but less than 1.7
and the latest psycopg2 greater than 2.8.4 at the same time.
.TP
.B requirements
Path to a pip requirements file. If the path begins with salt://
the file will be transferred from the master file server.
.TP
.B user
The user under which to run pip
.TP
.B use_wheel
False
Prefer wheel archives (requires pip>=1.4)
.TP
.B no_use_wheel
False
Force to not use wheel archives (requires pip>=1.4)
.TP
.B no_binary
Force to not use binary packages (requires pip >= 7.0.0)
Accepts either :all: to disable all binary packages, :none: to empty the set,
or a list of one or more packages
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
django:
  pip.installed:
    \- no_binary: \(aq:all:\(aq

flask:
  pip.installed:
    \- no_binary:
      \- itsdangerous
      \- click
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B log
Log file where a complete (maximum verbosity) record will be kept
.TP
.B proxy
Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy.  If you provide
user@proxy.server:port then you will be prompted for a
password.
.TP
.B timeout
Set the socket timeout (default 15 seconds)
.TP
.B editable
install something editable (i.e.
git+https://github.com/worldcompany/djangoembed.git#egg=djangoembed)
.TP
.B find_links
URL to look for packages at
.TP
.B index_url
Base URL of Python Package Index
.TP
.B extra_index_url
Extra URLs of package indexes to use in addition to \fBindex_url\fP
.TP
.B no_index
Ignore package index
.TP
.B mirrors
Specific mirror URL(s) to query (automatically adds \-\-use\-mirrors)
.TP
.B build
Unpack packages into \fBbuild\fP dir
.TP
.B target
Install packages into \fBtarget\fP dir
.TP
.B download
Download packages into \fBdownload\fP instead of installing them
.TP
.B download_cache
Cache downloaded packages in \fBdownload_cache\fP dir
.TP
.B source
Check out \fBeditable\fP packages into \fBsource\fP dir
.TP
.B upgrade
Upgrade all packages to the newest available version
.TP
.B force_reinstall
When upgrading, reinstall all packages even if they are already
up\-to\-date.
.TP
.B ignore_installed
Ignore the installed packages (reinstalling instead)
.TP
.B exists_action
Default action when a path already exists: (s)witch, (i)gnore, (w)ipe,
(b)ackup
.TP
.B no_deps
Ignore package dependencies
.TP
.B no_install
Download and unpack all packages, but don\(aqt actually install them
.TP
.B no_cache_dir:
Disable the cache.
.TP
.B cwd
Current working directory to run pip from
.TP
.B pre_releases
Include pre\-releases in the available versions
.TP
.B cert
Provide a path to an alternate CA bundle
.TP
.B allow_all_external
Allow the installation of all externally hosted files
.TP
.B allow_external
Allow the installation of externally hosted files (comma separated list)
.TP
.B allow_unverified
Allow the installation of insecure and unverifiable files (comma separated list)
.TP
.B process_dependency_links
Enable the processing of dependency links
.TP
.B env_vars
Add or modify environment variables. Useful for tweaking build steps,
such as specifying INCLUDE or LIBRARY paths in Makefiles, build scripts or
compiler calls.  This must be in the form of a dictionary or a mapping.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
django:
  pip.installed:
    \- name: django_app
    \- env_vars:
        CUSTOM_PATH: /opt/django_app
        VERBOSE: True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B use_vt
Use VT terminal emulation (see output while installing)
.TP
.B trusted_host
Mark this host as trusted, even though it does not have valid or any
HTTPS.
.TP
.B bin_env
None
Absolute path to a virtual environment directory or absolute path to
a pip executable. The example below assumes a virtual environment
has been created at \fB/foo/.virtualenvs/bar\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
django:
pip.installed:
    \- name: django >= 1.6, <= 1.7
    \- bin_env: /foo/.virtualenvs/bar
    \- require:
    \- pkg: python\-pip
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
django:
pip.installed:
    \- name: django >= 1.6, <= 1.7
    \- bin_env: /foo/.virtualenvs/bar/bin/pip
    \- require:
    \- pkg: python\-pip
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Attention"
.sp
The following arguments are deprecated, do not use.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B pip_bin
None
Deprecated, use \fBbin_env\fP
.UNINDENT
.sp
Changed in version 0.17.0: \fBuse_wheel\fP option added.

.sp
install_options
.INDENT 7.0
.INDENT 3.5
Extra arguments to be supplied to the setup.py install command.
If you are using an option with a directory path, be sure to use
absolute path.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
django:
  pip.installed:
    \- name: django
    \- install_options:
      \- \-\-prefix=/blah
    \- require:
      \- pkg: python\-pip
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B global_options
Extra global options to be supplied to the setup.py call before the
install command.
.sp
New in version 2014.1.3.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Attention"
.sp
As of Salt 0.17.0 the pip state \fBneeds\fP an importable pip module.
This usually means having the system\(aqs pip package installed or running
Salt from an active \fI\%virtualenv\fP\&.
.sp
The reason for this requirement is because \fBpip\fP already does a
pretty good job parsing its own requirements. It makes no sense for
Salt to do \fBpip\fP requirements parsing and validation before passing
them to the \fBpip\fP library. It\(aqs functionality duplication and it\(aqs
more error prone.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Attention"
.sp
Please set \fBreload_modules: True\fP to have the salt minion
import this module after installation.
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pyopenssl:
    pip.installed:
        \- name: pyOpenSSL
        \- reload_modules: True
        \- exists_action: i
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B extra_args
pip keyword and positional arguments not yet implemented in salt
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pandas:
  pip.installed:
    \- name: pandas
    \- extra_args:
      \- \-\-latest\-pip\-kwarg: param
      \- \-\-latest\-pip\-arg
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
If unsupported options are passed here that are not supported in a
minion\(aqs version of pip, a \fINo such option error\fP will be thrown.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
If you are using onedir packages and you need to install python packages into
the system python environment, you must provide the pip_bin or
bin_env to the pip state module.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
lib\-foo:
  pip.installed:
    \- pip_bin: /usr/bin/pip3
lib\-bar:
  pip.installed:
    \- bin_env: /usr/bin/python3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pip_state.pip_has_exceptions_mod(ver)
True when the pip version has the \fIpip.exceptions\fP module
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pip_state.pip_has_internal_exceptions_mod(ver)
True when the pip version has the \fIpip._internal.exceptions\fP module
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pip_state.purge_pip()
Purge pip and its sub\-modules
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pip_state.removed(name, requirements=None, bin_env=None, log=None, proxy=None, timeout=None, user=None, cwd=None, use_vt=False)
Make sure that a package is not installed.
.INDENT 7.0
.TP
.B name
The name of the package to uninstall
.TP
.B user
The user under which to run pip
.TP
.B bin_env
None
the pip executable or virtualenenv to use
.TP
.B use_vt
Use VT terminal emulation (see output while installing)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pip_state.uptodate(name, bin_env=None, user=None, cwd=None, use_vt=False)
New in version 2015.5.0.

.sp
Verify that the system is completely up to date.
.INDENT 7.0
.TP
.B name
The name has no functional value and is only used as a tracking
reference
.TP
.B user
The user under which to run pip
.TP
.B bin_env
the pip executable or virtualenenv to use
.TP
.B use_vt
Use VT terminal emulation (see output while installing)
.UNINDENT
.UNINDENT
.SS salt.states.pkg
.SS Installation of packages using OS package managers such as yum or apt\-get
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
On minions running systemd>=205, as of version 2015.8.12, 2016.3.3, and
2016.11.0, \fI\%systemd\-run(1)\fP is now used to isolate commands which modify
installed packages from the \fBsalt\-minion\fP daemon\(aqs control group. This is
done to keep systemd from killing the package manager commands spawned by
Salt, when Salt updates itself (see \fBKillMode\fP in the \fI\%systemd.kill(5)\fP
manpage for more information). If desired, usage of \fI\%systemd\-run(1)\fP can
be suppressed by setting a \fI\%config option\fP
called \fBsystemd.scope\fP, with a value of \fBFalse\fP (no quotes).
.UNINDENT
.UNINDENT
.sp
Salt can manage software packages via the pkg state module, packages can be
set up to be installed, latest, removed and purged. Package management
declarations are typically rather simple:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg.installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A more involved example involves pulling from a custom repository.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  pkgrepo.managed:
    \- name: ppa:wolfnet/logstash
    \- dist: precise
    \- file: /etc/apt/sources.list.d/logstash.list
    \- keyid: 28B04E4A
    \- keyserver: keyserver.ubuntu.com

logstash:
  pkg.installed:
    \- fromrepo: ppa:wolfnet/logstash
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple packages can also be installed with the use of the pkgs
state module
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
dotdeb.repo:
  pkgrepo.managed:
    \- name: deb http://packages.dotdeb.org wheezy\-php55 all
    \- dist: wheezy\-php55
    \- file: /etc/apt/sources.list.d/dotbeb.list
    \- keyid: 89DF5277
    \- keyserver: keys.gnupg.net
    \- refresh_db: true

php.packages:
  pkg.installed:
    \- fromrepo: wheezy\-php55
    \- pkgs:
      \- php5\-fpm
      \- php5\-cli
      \- php5\-curl
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Make sure the package name has the correct case for package managers which are
case\-sensitive (such as \fI\%pkgng\fP).
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkg.downloaded(name, version=None, pkgs=None, fromrepo=None, ignore_epoch=None, **kwargs)
New in version 2017.7.0.

.sp
Ensure that the package is downloaded, and that it is the correct version
(if specified).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Any argument which is either a) not explicitly defined for this state,
or b) not a global state argument like \fBsaltenv\fP, or
\fBreload_modules\fP, will be passed through to the call to
\fBpkg.install\fP to download the package(s). For example, you can include
a \fBdisablerepo\fP argument on platforms that use yum/dnf to disable
that repo:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mypkg:
  pkg.downloaded:
    \- disablerepo: base,updates
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To see what is supported, check \fI\%this page\fP to find
the documentation for your platform\(aqs \fBpkg\fP module, then look at the
documentation for the \fBinstall\fP function.
.sp
Any argument that is passed through to the \fBinstall\fP function, which
is not defined for that function, will be silently ignored.
.UNINDENT
.UNINDENT
.sp
Currently supported for the following pkg providers:
\fI\%yum\fP, \fI\%zypper\fP and \fI\%apt\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to be downloaded. This parameter is ignored if
either \(dqpkgs\(dq is used. Additionally, please note that this option can
only be used to download packages from a software repository.
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\-
.sp
Download a specific version of a package.
.sp
\fBIMPORTANT:\fP
.INDENT 2.0
.INDENT 3.5
As of version 2015.8.7, for distros which use yum/dnf, packages
which have a version with a nonzero epoch (that is, versions which
start with a number followed by a colon must have the epoch included
when specifying the version number. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim\-enhanced:
  pkg.downloaded:
    \- version: 2:7.4.160\-1.el7
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
An \fBignore_epoch\fP argument has been added to which causes the
epoch to be disregarded when the state checks to see if the desired
version was installed.
.sp
You can install a specific version when using the \fBpkgs\fP argument by
including the version after the package:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
common_packages:
  pkg.downloaded:
    \- pkgs:
      \- unzip
      \- dos2unix
      \- salt\-minion: 2015.8.5\-1.el6
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBresolve_capabilities\fP (\fI\%bool\fP) \-\-
.sp
Turn on resolving capabilities. This allow one to name \(dqprovides\(dq or alias names for packages.
.sp
New in version 2018.3.0.


.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zsh:
  pkg.downloaded:
    \- version: 5.0.5\-4.63
    \- fromrepo: \(dqmyrepository\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkg.group_installed(name, skip=None, include=None, **kwargs)
New in version 2015.8.0.

.sp
Changed in version 2016.11.0: Added support in \fBpacman\fP

.sp
Changed in version 3006.2: For RPM\-based systems, support for \fBfromrepo\fP, \fBenablerepo\fP, and
\fBdisablerepo\fP (as used in \fI\%pkg.install\fP) has been added. This allows one to, for
example, use \fBenablerepo\fP to perform a group install from a repo that
is otherwise disabled.

.sp
Ensure that an entire package group is installed. This state is currently
only supported for the \fI\%yum\fP and \fBpacman\fP package managers.
.INDENT 7.0
.TP
.B skip
Packages that would normally be installed by the package group
(\(dqdefault\(dq packages), which should not be installed.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Load Balancer:
  pkg.group_installed:
    \- skip:
      \- piranha
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B include
Packages which are included in a group, which would not normally be
installed by a \fByum groupinstall\fP (\(dqoptional\(dq packages). Note that
this will not enforce group membership; if you include packages which
are not members of the specified groups, they will still be installed.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Load Balancer:
  pkg.group_installed:
    \- include:
      \- haproxy
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 2016.3.0: This option can no longer be passed as a comma\-separated list, it
must now be passed as a list (as shown in the above example).

.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The below options are only supported on RPM\-based systems
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B fromrepo
Restrict \fByum groupinfo\fP to the specified repo(s).
(e.g., \fByum \-\-disablerepo=\(aq*\(aq \-\-enablerepo=\(aqsomerepo\(aq\fP)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
MyGroup:
  pkg.group_installed:
    \- fromrepo: base,updates
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3006.2.

.TP
.B enablerepo (ignored if \fBfromrepo\fP is specified)
Specify a disabled package repository (or repositories) to enable.
(e.g., \fByum \-\-enablerepo=\(aqsomerepo\(aq\fP)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
MyGroup:
  pkg.group_installed:
    \- enablerepo: myrepo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3006.2.

.TP
.B disablerepo (ignored if \fBfromrepo\fP is specified)
Specify an enabled package repository (or repositories) to disable.
(e.g., \fByum \-\-disablerepo=\(aqsomerepo\(aq\fP)
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
MyGroup:
  pkg.group_installed:
    \- disablerepo: epel
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3006.2.

.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Because this is essentially a wrapper around \fI\%pkg.install\fP, any argument which can be passed to
pkg.install may also be included here, and it will be passed on to the
call to \fI\%pkg.install\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkg.held(name, version=None, pkgs=None, replace=False, **kwargs)
New in version 3005.

.sp
Set package in \(aqhold\(aq state, meaning it will not be changed.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to be held. This parameter is ignored
if \fBpkgs\fP is used.
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\-
.sp
Hold a specific version of a package.
Full description of this parameter is in \fIinstalled\fP function.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This parameter make sense for Zypper\-based systems.
Ignored for YUM/DNF and APT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBpkgs\fP (\fI\%list\fP) \-\-
.sp
A list of packages to be held. All packages listed under \fBpkgs\fP
will be held.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
mypkgs:
  pkg.held:
    \- pkgs:
      \- foo
      \- bar: 1.2.3\-4
      \- baz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
For Zypper\-based systems the package could be held for
the version specified. YUM/DNF and APT ingore it.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBreplace\fP (\fI\%bool\fP) \-\- Force replacement of existings holds with specified.
By default, this parameter is set to \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkg.installed(name, version=None, refresh=None, fromrepo=None, skip_verify=False, skip_suggestions=False, pkgs=None, sources=None, allow_updates=False, pkg_verify=False, normalize=True, ignore_epoch=None, reinstall=False, update_holds=False, **kwargs)
Changed in version 3007.0.

.sp
Ensure that the package is installed, and that it is the correct version
(if specified).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Any argument which is either a) not explicitly defined for this state,
or b) not a global state argument like \fBsaltenv\fP, or
\fBreload_modules\fP, will be passed through to the call to
\fBpkg.install\fP to install the package(s). For example, you can include
a \fBdisablerepo\fP argument on platforms that use yum/dnf to disable
that repo:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mypkg:
  pkg.installed:
    \- disablerepo: base,updates
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To see what is supported, check \fI\%this page\fP to find
the documentation for your platform\(aqs \fBpkg\fP module, then look at the
documentation for the \fBinstall\fP function.
.sp
Any argument that is passed through to the \fBinstall\fP function, which
is not defined for that function, will be silently ignored.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
In Windows, some packages are installed using the task manager. The Salt
minion installer does this. In that case, there is no way to know if the
package installs correctly. All that can be reported is that the task
that launches the installer started successfully.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to be installed. This parameter is ignored if
either \(dqpkgs\(dq or \(dqsources\(dq is used. Additionally, please note that this
option can only be used to install packages from a software repository.
To install a package file manually, use the \(dqsources\(dq option detailed
below.
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\-
.sp
Install a specific version of a package. This option is ignored if
\(dqsources\(dq is used. Currently, this option is supported
for the following pkg providers: \fI\%apt\fP,
\fBebuild\fP,
\fBpacman\fP,
\fI\%pkgin\fP,
\fI\%win_pkg\fP,
\fI\%yum\fP, and
\fI\%zypper\fP\&. The version number includes the
release designation where applicable, to allow Salt to target a
specific release of a given version. When in doubt, using the
\fBpkg.latest_version\fP function for an uninstalled package will tell
you the version available.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
# salt myminion pkg.latest_version vim\-enhanced
myminion:
    2:7.4.160\-1.el7
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 2.0
.INDENT 3.5
As of version 2015.8.7, for distros which use yum/dnf, packages
which have a version with a nonzero epoch (that is, versions which
start with a number followed by a colon like in the
\fBpkg.latest_version\fP output above) must have the epoch included
when specifying the version number. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim\-enhanced:
  pkg.installed:
    \- version: 2:7.4.160\-1.el7
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In version 2015.8.9, an \fBignore_epoch\fP argument has been added to
\fI\%pkg.installed\fP,
\fI\%pkg.removed\fP, and
\fI\%pkg.purged\fP states, which
causes the epoch to be disregarded when the state checks to see if
the desired version was installed.
.UNINDENT
.UNINDENT
.sp
Also, while this function is not yet implemented for all pkg frontends,
\fI\%pkg.list_repo_pkgs\fP will
show all versions available in the various repositories for a given
package, irrespective of whether or not it is installed.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
# salt myminion pkg.list_repo_pkgs bash
myminion:
\-\-\-\-\-\-\-\-\-\-
    bash:
        \- 4.2.46\-21.el7_3
        \- 4.2.46\-20.el7_2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This function was first added for \fI\%pkg.list_repo_pkgs\fP in 2014.1.0, and was expanded to
\fI\%Debian/Ubuntu\fP and
\fBArch Linux\fP\-based
distros in the 2017.7.0 release.
.sp
The version strings returned by either of these functions can be used
as version specifiers in pkg states.
.sp
You can install a specific version when using the \fBpkgs\fP argument by
including the version after the package:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
common_packages:
  pkg.installed:
    \- pkgs:
      \- unzip
      \- dos2unix
      \- salt\-minion: 2015.8.5\-1.el6
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the version given is the string \fBlatest\fP, the latest available
package version will be installed à la \fBpkg.latest\fP\&.
.sp
\fBWILDCARD VERSIONS\fP
.sp
As of the 2017.7.0 release, this state now supports wildcards in
package versions for SUSE SLES/Leap/Tumbleweed, Debian/Ubuntu,
RHEL/CentOS, Arch Linux, and their derivatives. Using wildcards can be
useful for packages where the release name is built into the version in
some way, such as for RHEL/CentOS which typically has version numbers
like \fB1.2.34\-5.el7\fP\&. An example of the usage for this would be:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
mypkg:
  pkg.installed:
    \- version: \(aq1.2.34*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Keep in mind that using wildcard versions will result in a slower state
run since Salt must gather the available versions of the specified
packages and figure out which of them match the specified wildcard
expression.

.IP \(bu 2
\fBrefresh\fP (\fI\%bool\fP) \-\-
.sp
This parameter controls whether or not the package repo database is
updated prior to installing the requested package(s).
.sp
If \fBTrue\fP, the package database will be refreshed (\fBapt\-get
update\fP or equivalent, depending on platform) before installing.
.sp
If \fBFalse\fP, the package database will \fInot\fP be refreshed before
installing.
.sp
If unset, then Salt treats package database refreshes differently
depending on whether or not a \fBpkg\fP state has been executed already
during the current Salt run. Once a refresh has been performed in a
\fBpkg\fP state, for the remainder of that Salt run no other refreshes
will be performed for \fBpkg\fP states which do not explicitly set
\fBrefresh\fP to \fBTrue\fP\&. This prevents needless additional refreshes
from slowing down the Salt run.

.IP \(bu 2
\fBcache_valid_time\fP (\fI\%str\fP) \-\-
.sp
New in version 2016.11.0.

.sp
This parameter sets the value in seconds after which the cache is
marked as invalid, and a cache update is necessary. This overwrites
the \fBrefresh\fP parameter\(aqs default behavior.
.sp
Example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg.installed:
    \- fromrepo: mycustomrepo
    \- skip_verify: True
    \- skip_suggestions: True
    \- version: 2.0.6~ubuntu3
    \- refresh: True
    \- cache_valid_time: 300
    \- allow_updates: True
    \- hold: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this case, a refresh will not take place for 5 minutes since the last
\fBapt\-get update\fP was executed on the system.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This parameter is available only on Debian based distributions and
has no effect on the rest.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBfromrepo\fP (\fI\%str\fP) \-\-
.sp
Specify a repository from which to install
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
Distros which use APT (Debian, Ubuntu, etc.) do not have a concept
of repositories, in the same way as YUM\-based distros do. When a
source is added, it is assigned to a given release. Consider the
following source configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
deb http://ppa.launchpad.net/saltstack/salt/ubuntu precise main
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The packages provided by this source would be made available via
the \fBprecise\fP release, therefore \fBfromrepo\fP would need to be
set to \fBprecise\fP for Salt to install the package from this
source.
.sp
Having multiple sources in the same release may result in the
default install candidate being newer than what is desired. If this
is the case, the desired version must be specified using the
\fBversion\fP parameter.
.sp
If the \fBpkgs\fP parameter is being used to install multiple
packages in the same state, then instead of using \fBversion\fP,
use the method of version specification described in the \fBMultiple
Package Installation Options\fP section below.
.sp
Running the shell command \fBapt\-cache policy pkgname\fP on a minion
can help elucidate the APT configuration and aid in properly
configuring states:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
root@saltmaster:~# salt ubuntu01 cmd.run \(aqapt\-cache policy ffmpeg\(aq
ubuntu01:
    ffmpeg:
    Installed: (none)
    Candidate: 7:0.10.11\-1~precise1
    Version table:
        7:0.10.11\-1~precise1 0
            500 http://ppa.launchpad.net/jon\-severinsson/ffmpeg/ubuntu/ precise/main amd64 Packages
        4:0.8.10\-0ubuntu0.12.04.1 0
            500 http://us.archive.ubuntu.com/ubuntu/ precise\-updates/main amd64 Packages
            500 http://security.ubuntu.com/ubuntu/ precise\-security/main amd64 Packages
        4:0.8.1\-0ubuntu1 0
            500 http://us.archive.ubuntu.com/ubuntu/ precise/main amd64 Packages
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The release is located directly after the source\(aqs URL. The actual
release name is the part before the slash, so to install version
\fB4:0.8.10\-0ubuntu0.12.04.1\fP either \fBprecise\-updates\fP or
\fBprecise\-security\fP could be used for the \fBfromrepo\fP value.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBskip_verify\fP (\fI\%bool\fP) \-\- Skip the GPG verification check for the package to be installed
.IP \(bu 2
\fBskip_suggestions\fP (\fI\%bool\fP) \-\-
.sp
Force strict package naming. Disables lookup of package alternatives.
.sp
New in version 2014.1.1.


.IP \(bu 2
\fBresolve_capabilities\fP (\fI\%bool\fP) \-\-
.sp
Turn on resolving capabilities. This allow one to name \(dqprovides\(dq or alias names for packages.
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBallow_updates\fP (\fI\%bool\fP) \-\-
.sp
Allow the package to be updated outside Salt\(aqs control (e.g. auto
updates on Windows). This means a package on the Minion can have a
newer version than the latest available in the repository without
enforcing a re\-installation of the package.
.sp
New in version 2014.7.0.

.sp
Example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg.installed:
    \- fromrepo: mycustomrepo
    \- skip_verify: True
    \- skip_suggestions: True
    \- version: 2.0.6~ubuntu3
    \- refresh: True
    \- allow_updates: True
    \- hold: False
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBpkg_verify\fP (\fI\%bool\fP) \-\-
.sp
New in version 2014.7.0.

.sp
Use pkg.verify to check if already installed packages require
reinstallion. Requested packages that are already installed and not
targeted for up\- or downgrade are verified with pkg.verify to determine
if any file installed by the package have been modified or if package
dependencies are not fulfilled. \fBignore_types\fP and \fBverify_options\fP
can be passed to pkg.verify. See examples below. Currently, this option
is supported for the following pkg providers:
\fI\%yum\fP,
\fI\%zypperpkg\fP\&.
.sp
Examples:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg.installed:
    \- version: 2.2.15\-30.el6.centos
    \- pkg_verify: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
mypkgs:
  pkg.installed:
    \- pkgs:
      \- foo
      \- bar: 1.2.3\-4
      \- baz
    \- pkg_verify:
      \- ignore_types:
        \- config
        \- doc
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
mypkgs:
  pkg.installed:
    \- pkgs:
      \- foo
      \- bar: 1.2.3\-4
      \- baz
    \- pkg_verify:
      \- ignore_types:
        \- config
        \- doc
      \- verify_options:
        \- nodeps
        \- nofiledigest
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBignore_types\fP (\fI\%list\fP) \-\-
.sp
List of types to ignore when verifying the package
.sp
New in version 2014.7.0.


.IP \(bu 2
\fBverify_options\fP (\fI\%list\fP) \-\-
.sp
List of additional options to pass when verifying the package. These
options will be added to the \fBrpm \-V\fP command, prepended with \fB\-\-\fP
(for example, when \fBnodeps\fP is passed in this option, \fBrpm \-V\fP will
be run with \fB\-\-nodeps\fP).
.sp
New in version 2016.11.0.


.IP \(bu 2
\fBnormalize\fP (\fI\%bool\fP) \-\-
.sp
Normalize the package name by removing the architecture, if the
architecture of the package is different from the architecture of the
operating system. The ability to disable this behavior is useful for
poorly\-created packages which include the architecture as an actual
part of the name, such as kernel modules which match a specific kernel
version.
.sp
New in version 2014.7.0.

.sp
Example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
gpfs.gplbin\-2.6.32\-279.31.1.el6.x86_64:
  pkg.installed:
    \- normalize: False
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBignore_epoch\fP (\fI\%bool\fP) \-\-
.sp
If this option is not explicitly set, and there is no epoch in the
desired package version, the epoch will be implicitly ignored. Set this
argument to \fBTrue\fP to explicitly ignore the epoch, and \fBFalse\fP to
strictly enforce it.
.sp
New in version 2015.8.9.

.sp
Changed in version 3001: In prior releases, the default behavior was to strictly enforce
epochs unless this argument was set to \fBTrue\fP\&.


.UNINDENT
.UNINDENT
.nf

.fi
.sp
.sp
\fBMULTIPLE PACKAGE INSTALLATION OPTIONS:\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpkgs\fP (\fI\%list\fP) \-\-
.sp
A list of packages to install from a software repository. All packages
listed under \fBpkgs\fP will be installed via a single command.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
mypkgs:
  pkg.installed:
    \- pkgs:
      \- foo
      \- bar
      \- baz
    \- hold: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP For \fI\%apt\fP,
\fBebuild\fP,
\fBpacman\fP,
\fI\%winrepo\fP,
\fI\%yum\fP, and
\fI\%zypper\fP,
version numbers can be specified
in the \fBpkgs\fP argument. For example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
mypkgs:
  pkg.installed:
    \- pkgs:
      \- foo
      \- bar: 1.2.3\-4
      \- baz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Additionally, \fBebuild\fP, \fBpacman\fP, \fI\%zypper\fP,
\fI\%yum/dnf\fP, and \fI\%apt\fP support the \fB<\fP, \fB<=\fP, \fB>=\fP, and \fB>\fP
operators for more control over what versions will be installed. For
example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
mypkgs:
  pkg.installed:
    \- pkgs:
      \- foo
      \- bar: \(aq>=1.2.3\-4\(aq
      \- baz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP When using comparison operators, the expression must be enclosed
in quotes to avoid a YAML render error.
.sp
With \fBebuild\fP is also possible to specify a
use flag list and/or if the given packages should be in
package.accept_keywords file and/or the overlay from which you want the
package to be installed. For example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
mypkgs:
  pkg.installed:
    \- pkgs:
      \- foo: \(aq~\(aq
      \- bar: \(aq~>=1.2:slot::overlay[use,\-otheruse]\(aq
      \- baz
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBsources\fP (\fI\%list\fP) \-\-
.sp
A list of packages to install, along with the source URI or local path
from which to install each package. In the example below, \fBfoo\fP,
\fBbar\fP, \fBbaz\fP, etc. refer to the name of the package, as it would
appear in the output of the \fBpkg.version\fP or \fBpkg.list_pkgs\fP salt
CLI commands.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
mypkgs:
  pkg.installed:
    \- sources:
      \- foo: salt://rpms/foo.rpm
      \- bar: http://somesite.org/bar.rpm
      \- baz: ftp://someothersite.org/baz.rpm
      \- qux: /minion/path/to/qux.rpm
.ft P
.fi
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
\fBPLATFORM\-SPECIFIC ARGUMENTS\fP
.sp
These are specific to each OS. If it does not apply to the execution
module for your OS, it is ignored.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhold\fP (\fI\%bool\fP) \-\-
.sp
Force the package to be held at the current installed version.
.sp
Supported on YUM/DNF & APT based systems.
.sp
New in version 2014.7.0.

.sp
Supported on Zypper\-based systems.
.sp
New in version 3003.


.IP \(bu 2
\fBupdate_holds\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP, and this function would update the package version, any
packages which are being held will be temporarily unheld so that they
can be updated. Otherwise, if this function attempts to update a held
package, the held package(s) will be skipped and the state will fail.
By default, this parameter is set to \fBFalse\fP\&.
.sp
Supported on YUM/DNF & APT based systems.
.sp
New in version 2016.11.0.

.sp
Supported on Zypper\-based systems.
.sp
New in version 3003.


.IP \(bu 2
\fBnames\fP (\fI\%list\fP) \-\-
.sp
A list of packages to install from a software repository. Each package
will be installed individually by the package manager.
.sp
\fBWARNING:\fP
.INDENT 2.0
.INDENT 3.5
Unlike \fBpkgs\fP, the \fBnames\fP parameter cannot specify a version.
In addition, it makes a separate call to the package management
frontend to install each package, whereas \fBpkgs\fP makes just a
single call. It is therefore recommended to use \fBpkgs\fP instead of
\fBnames\fP to install multiple packages, both for the additional
features and the performance improvement that it brings.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBinstall_recommends\fP (\fI\%bool\fP) \-\-
.sp
Whether to install the packages marked as recommended. Default is
\fBTrue\fP\&. Currently only works with APT\-based systems.
.sp
New in version 2015.5.0.

.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg.installed:
    \- install_recommends: False
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBonly_upgrade\fP (\fI\%bool\fP) \-\-
.sp
Only upgrade the packages, if they are already installed. Default is
\fBFalse\fP\&. Currently only works with APT\-based systems.
.sp
New in version 2015.5.0.

.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg.installed:
    \- only_upgrade: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
If this parameter is set to True and the package is not already
installed, the state will fail.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBreport_reboot_exit_codes\fP (\fI\%bool\fP) \-\-
.sp
If the installer exits with a recognized exit code indicating that
a reboot is required, the module function
.INDENT 2.0
.INDENT 3.5
\fIwin_system.set_reboot_required_witnessed\fP
.UNINDENT
.UNINDENT
.sp
will be called, preserving the knowledge of this event
for the remainder of the current boot session. For the time being,
\fB3010\fP is the only recognized exit code,
but this is subject to future refinement.
The value of this param
defaults to \fBTrue\fP\&. This parameter has no effect
on non\-Windows systems.
.sp
New in version 2016.11.0.

.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
ms vcpp installed:
  pkg.installed:
    \- name: ms\-vcpp
    \- version: 10.0.40219
    \- report_reboot_exit_codes: False
.ft P
.fi
.UNINDENT
.UNINDENT

.UNINDENT
.TP
.B Returns
A dictionary containing the state of the software installation
.TP
.B Rtype dict
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fBpkg.installed\fP state supports the usage of \fBreload_modules\fP\&.
This functionality allows you to force Salt to reload all modules. In
many cases, Salt is clever enough to transparently reload the modules.
For example, if you install a package, Salt reloads modules because some
other module or state might require the package which was installed.
However, there are some edge cases where this may not be the case, which
is what \fBreload_modules\fP is meant to resolve.
.sp
You should only use \fBreload_modules\fP if your \fBpkg.installed\fP does some
sort of installation where if you do not reload the modules future items
in your state which rely on the software being installed will fail. Please
see the \fI\%Reloading Modules\fP documentation for more
information.
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
unless and onlyif
.sp
If running pkg commands together with \fI\%aggregate\fP
isn\(aqt an option, you can use the \fI\%creates\fP,
\fI\%unless\fP, or \fI\%onlyif\fP
syntax to skip a full package run. This can be helpful in large environments
with multiple states that include requisites for packages to be installed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Using creates for a simple single\-factor check
install_nginx:
  pkg.installed:
    \- name: nginx
    \- creates:
      \- /etc/nginx/nginx.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Using file.file_exists for a single\-factor check
install_nginx:
  pkg.installed:
    \- name: nginx
    \- unless:
      \- fun: file.file_exists
        args:
          \- /etc/nginx/nginx.conf

# Using unless with a shell test
install_nginx:
  pkg.installed:
    \- name: nginx
    \- unless: test \-f /etc/nginx/nginx.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Using file.search for a two\-factor check
install_nginx:
  pkg.installed:
    \- name: nginx
    \- unless:
      \- fun: file.search
        args:
          \- /etc/nginx/nginx.conf
          \- \(aquser www\-data;\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above examples use different methods to reasonably ensure
that a package has already been installed. First, with checking for a
file that would be created with the package. Second, by checking for
specific text within a file that would be created or managed by salt.
With these requisists satisfied, creates/unless will return \fBTrue\fP and the
\fBpkg.installed\fP state will be skipped.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Example of state run without unless used
salt \(aqsaltdev\(aq state.apply nginx
saltdev:
\-\-\-\-\-\-\-\-\-\-
          ID: install_nginx
          Function: pkg.installed
          Name: nginx
          Result: True
          Comment: All specified packages are already installed
          Started: 20:11:56.388331
          Duration: 4290.0 ms
          Changes:

# Example of state run using unless requisite
salt \(aqsaltdev\(aq state.apply nginx
saltdev:
\-\-\-\-\-\-\-\-\-\-
          ID: install_nginx
          Function: pkg.installed
          Name: nginx
          Result: True
          Comment: unless condition is true
          Started: 20:10:50.659215
          Duration: 1530.0 ms
          Changes:
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The result is a reduction of almost 3 seconds. In larger environments,
small reductions in waiting time can add up.
.sp
\fI\%Unless Requisite\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkg.latest(name, refresh=None, fromrepo=None, skip_verify=False, pkgs=None, watch_flags=True, **kwargs)
Changed in version 3007.0.

.sp
Ensure that the named package is installed and the latest available
package. If the package can be updated, this state function will update
the package. Generally it is better for the
\fI\%installed\fP function to be
used, as \fI\%latest\fP will update the package
whenever a new package is available.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Any argument which is either a) not explicitly defined for this state,
or b) not a global state argument like \fBsaltenv\fP, or
\fBreload_modules\fP, will be passed through to the call to
\fBpkg.install\fP to install the package(s). For example, you can include
a \fBdisablerepo\fP argument on platforms that use yum/dnf to disable
that repo:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mypkg:
  pkg.latest:
    \- disablerepo: base,updates
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To see what is supported, check \fI\%this page\fP to find
the documentation for your platform\(aqs \fBpkg\fP module, then look at the
documentation for the \fBinstall\fP function.
.sp
Any argument that is passed through to the \fBinstall\fP function, which
is not defined for that function, will be silently ignored.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the package to maintain at the latest available version.
This parameter is ignored if \(dqpkgs\(dq is used.
.TP
.B fromrepo
Specify a repository from which to install
.TP
.B skip_verify
Skip the GPG verification check for the package to be installed
.TP
.B refresh
This parameter controls whether or not the package repo database is
updated prior to checking for the latest available version of the
requested packages.
.sp
If \fBTrue\fP, the package database will be refreshed (\fBapt\-get update\fP
or equivalent, depending on platform) before checking for the latest
available version of the requested packages.
.sp
If \fBFalse\fP, the package database will \fInot\fP be refreshed before
checking.
.sp
If unset, then Salt treats package database refreshes differently
depending on whether or not a \fBpkg\fP state has been executed already
during the current Salt run. Once a refresh has been performed in a
\fBpkg\fP state, for the remainder of that Salt run no other refreshes
will be performed for \fBpkg\fP states which do not explicitly set
\fBrefresh\fP to \fBTrue\fP\&. This prevents needless additional refreshes
from slowing down the Salt run.
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcache_valid_time\fP (\fI\%str\fP) \-\-
.sp
New in version 2016.11.0.

.sp
This parameter sets the value in seconds after which the cache is
marked as invalid, and a cache update is necessary. This overwrites
the \fBrefresh\fP parameter\(aqs default behavior.
.sp
Example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg.latest:
    \- refresh: True
    \- cache_valid_time: 300
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this case, a refresh will not take place for 5 minutes since the last
\fBapt\-get update\fP was executed on the system.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This parameter is available only on Debian based distributions and
has no effect on the rest.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBresolve_capabilities\fP (\fI\%bool\fP) \-\-
.sp
Turn on resolving capabilities. This allow one to name \(dqprovides\(dq or alias names for packages.
.sp
New in version 2018.3.0.


.UNINDENT
.UNINDENT
.sp
Multiple Package Installation Options:
.sp
(Not yet supported for: FreeBSD, OpenBSD, MacOS, and Solaris pkgutil)
.INDENT 7.0
.TP
.B pkgs
A list of packages to maintain at the latest available version.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mypkgs:
  pkg.latest:
    \- pkgs:
      \- foo
      \- bar
      \- baz
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B install_recommends
Whether to install the packages marked as recommended. Default is
\fBTrue\fP\&. Currently only works with APT\-based systems.
.sp
New in version 2015.5.0.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg.latest:
    \- install_recommends: False
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B only_upgrade
Only upgrade the packages, if they are already installed. Default is
\fBFalse\fP\&. Currently only works with APT\-based systems.
.sp
New in version 2015.5.0.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  pkg.latest:
    \- only_upgrade: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If this parameter is set to True and the package is not already
installed, the state will fail.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B report_reboot_exit_codes
If the installer exits with a recognized exit code indicating that
a reboot is required, the module function
.INDENT 7.0
.INDENT 3.5
\fIwin_system.set_reboot_required_witnessed\fP
.UNINDENT
.UNINDENT
.sp
will be called, preserving the knowledge of this event
for the remainder of the current boot session. For the time being,
\fB3010\fP is the only recognized exit code, but this
is subject to future refinement. The value of this param
defaults to \fBTrue\fP\&. This parameter has no effect on
non\-Windows systems.
.sp
New in version 2016.11.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ms vcpp installed:
  pkg.latest:
    \- name: ms\-vcpp
    \- report_reboot_exit_codes: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkg.mod_aggregate(low, chunks, running)
The mod_aggregate function which looks up all packages in the available
low chunks and merges them into a single pkgs ref in the present low data
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkg.mod_beacon(name, **kwargs)
Create a beacon to monitor a package or packages
based on a beacon state argument.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state exists to support special handling of the \fBbeacon\fP
state argument for supported state functions. It should not be called directly.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkg.mod_watch(name, **kwargs)
Install/reinstall a package based on a watch requisite
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state exists to support special handling of the \fBwatch\fP
\fI\%requisite\fP\&. It should not be called directly.
.sp
Parameters for this function should be set by the state being triggered.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkg.patch_downloaded(name, advisory_ids=None, **kwargs)
New in version 2017.7.0.

.sp
Ensure that packages related to certain advisory ids are downloaded.
.sp
Currently supported for the following pkg providers:
\fI\%yum\fP and \fI\%zypper\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
preparing\-to\-fix\-issues:
  pkg.patch_downloaded:
    \- advisory_ids:
      \- SUSE\-SLE\-SERVER\-12\-SP2\-2017\-185
      \- SUSE\-SLE\-SERVER\-12\-SP2\-2017\-150
      \- SUSE\-SLE\-SERVER\-12\-SP2\-2017\-120
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkg.patch_installed(name, advisory_ids=None, downloadonly=None, **kwargs)
New in version 2017.7.0.

.sp
Ensure that packages related to certain advisory ids are installed.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Any argument which is either a) not explicitly defined for this state,
or b) not a global state argument like \fBsaltenv\fP, or
\fBreload_modules\fP, will be passed through to the call to
\fBpkg.install\fP to install the patch(es).
.sp
To see what is supported, check \fI\%this page\fP to find
the documentation for your platform\(aqs \fBpkg\fP module, then look at the
documentation for the \fBinstall\fP function.
.sp
Any argument that is passed through to the \fBinstall\fP function, which
is not defined for that function, will be silently ignored.
.UNINDENT
.UNINDENT
.sp
Currently supported for the following pkg providers:
\fI\%yum\fP and \fI\%zypper\fP
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
issue\-foo\-fixed:
  pkg.patch_installed:
    \- advisory_ids:
      \- SUSE\-SLE\-SERVER\-12\-SP2\-2017\-185
      \- SUSE\-SLE\-SERVER\-12\-SP2\-2017\-150
      \- SUSE\-SLE\-SERVER\-12\-SP2\-2017\-120
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkg.purged(name, version=None, pkgs=None, normalize=True, ignore_epoch=None, **kwargs)
Verify that a package is not installed, calling \fBpkg.purge\fP if necessary
to purge the package. All configuration files are also removed.
.INDENT 7.0
.TP
.B name
The name of the package to be purged.
.TP
.B version
The version of the package that should be removed. Don\(aqt do anything if
the package is installed with an unmatching version.
.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
As of version 2015.8.7, for distros which use yum/dnf, packages
which have a version with a nonzero epoch (that is, versions which
start with a number followed by a colon like in the example above)
must have the epoch included when specifying the version number.
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim\-enhanced:
  pkg.purged:
    \- version: 2:7.4.160\-1.el7
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In version 2015.8.9, an \fBignore_epoch\fP argument has been added to
\fI\%pkg.installed\fP,
\fI\%pkg.removed\fP, and
\fI\%pkg.purged\fP states, which
causes the epoch to be disregarded when the state checks to see if
the desired version was installed. If \fBignore_epoch\fP was not set
to \fBTrue\fP, and instead of \fB2:7.4.160\-1.el7\fP a version of
\fB7.4.160\-1.el7\fP were used, this state would report success since
the actual installed version includes the epoch, and the specified
version would not match.
.UNINDENT
.UNINDENT
.TP
.B normalize
True
Normalize the package name by removing the architecture, if the
architecture of the package is different from the architecture of the
operating system. The ability to disable this behavior is useful for
poorly\-created packages which include the architecture as an actual
part of the name, such as kernel modules which match a specific kernel
version.
.sp
New in version 2015.8.0.

.TP
.B ignore_epoch
None
If this option is not explicitly set, and there is no epoch in the
desired package version, the epoch will be implicitly ignored. Set this
argument to \fBTrue\fP to explicitly ignore the epoch, and \fBFalse\fP to
strictly enforce it.
.sp
New in version 2015.8.9.

.sp
Changed in version 3001: In prior releases, the default behavior was to strictly enforce
epochs unless this argument was set to \fBTrue\fP\&.

.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to purge. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed. It accepts
version numbers as well.
.sp
New in version 0.16.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkg.removed(name, version=None, pkgs=None, normalize=True, ignore_epoch=None, **kwargs)
Verify that a package is not installed, calling \fBpkg.remove\fP if necessary
to remove the package.
.INDENT 7.0
.TP
.B name
The name of the package to be removed.
.TP
.B version
The version of the package that should be removed. Don\(aqt do anything if
the package is installed with an unmatching version.
.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
As of version 2015.8.7, for distros which use yum/dnf, packages
which have a version with a nonzero epoch (that is, versions which
start with a number followed by a colon like in the example above)
must have the epoch included when specifying the version number.
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim\-enhanced:
  pkg.removed:
    \- version: 2:7.4.160\-1.el7
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In version 2015.8.9, an \fBignore_epoch\fP argument has been added to
\fI\%pkg.installed\fP,
\fI\%pkg.removed\fP, and
\fI\%pkg.purged\fP states, which
causes the epoch to be disregarded when the state checks to see if
the desired version was installed. If \fBignore_epoch\fP was not set
to \fBTrue\fP, and instead of \fB2:7.4.160\-1.el7\fP a version of
\fB7.4.160\-1.el7\fP were used, this state would report success since
the actual installed version includes the epoch, and the specified
version would not match.
.UNINDENT
.UNINDENT
.TP
.B normalize
True
Normalize the package name by removing the architecture, if the
architecture of the package is different from the architecture of the
operating system. The ability to disable this behavior is useful for
poorly\-created packages which include the architecture as an actual
part of the name, such as kernel modules which match a specific kernel
version.
.sp
New in version 2015.8.0.

.TP
.B ignore_epoch
None
If this option is not explicitly set, and there is no epoch in the
desired package version, the epoch will be implicitly ignored. Set this
argument to \fBTrue\fP to explicitly ignore the epoch, and \fBFalse\fP to
strictly enforce it.
.sp
New in version 2015.8.9.

.sp
Changed in version 3001: In prior releases, the default behavior was to strictly enforce
epochs unless this argument was set to \fBTrue\fP\&.

.UNINDENT
.sp
Multiple Package Options:
.INDENT 7.0
.TP
.B pkgs
A list of packages to remove. Must be passed as a python list. The
\fBname\fP parameter will be ignored if this option is passed. It accepts
version numbers as well.
.sp
New in version 0.16.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkg.unheld(name, version=None, pkgs=None, all=False, **kwargs)
New in version 3005.

.sp
Unset package from \(aqhold\(aq state, to allow operations with the package.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the package to be unheld. This parameter is ignored
if \fBpkgs\fP is used.
.IP \(bu 2
\fBversion\fP (\fI\%str\fP) \-\-
.sp
Unhold a specific version of a package.
Full description of this parameter is in \fIinstalled\fP function.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
This parameter make sense for Zypper\-based systems.
Ignored for YUM/DNF and APT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBpkgs\fP (\fI\%list\fP) \-\-
.sp
A list of packages to be unheld. All packages listed under \fBpkgs\fP
will be unheld.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
mypkgs:
  pkg.unheld:
    \- pkgs:
      \- foo
      \- bar: 1.2.3\-4
      \- baz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
For Zypper\-based systems the package could be held for
the version specified. YUM/DNF and APT ingore it.
For \fBunheld\fP there is no need to specify the exact version
to be unheld.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBall\fP (\fI\%bool\fP) \-\- Force removing of all existings locks.
By default, this parameter is set to \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkg.uptodate(name, refresh=False, pkgs=None, **kwargs)
New in version 2014.7.0.

.sp
Changed in version 2018.3.0: Added support for the \fBpkgin\fP provider.

.sp
Verify that the system is completely up to date.
.INDENT 7.0
.TP
.B :param str name
The name has no functional value and is only used as a tracking
reference
.TP
.B :param bool refresh
refresh the package database before checking for new upgrades
.TP
.B :param list pkgs
list of packages to upgrade
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
\fBresolve_capabilities\fP (\fI\%bool\fP) \-\-
.sp
Turn on resolving capabilities. This allow one to name \(dqprovides\(dq or alias names for packages.
.sp
New in version 2018.3.0.


.UNINDENT
.INDENT 7.0
.TP
.B :param kwargs
Any keyword arguments to pass through to the \fBpkg\fP module.
.sp
For example, for apt systems: \fIdist_upgrade\fP, \fIcache_valid_time\fP, \fIforce_conf_new\fP
.sp
New in version 2015.5.0.

.UNINDENT
.UNINDENT
.SS salt.states.pkgbuild
.sp
The pkgbuild state is the front of Salt package building backend. It
automatically builds DEB and RPM packages from specified sources
.sp
New in version 2015.8.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt_2015.5.2:
  pkgbuild.built:
    \- runas: thatch
    \- results:
      \- salt\-2015.5.2\-2.el7.centos.noarch.rpm
      \- salt\-api\-2015.5.2\-2.el7.centos.noarch.rpm
      \- salt\-cloud\-2015.5.2\-2.el7.centos.noarch.rpm
      \- salt\-master\-2015.5.2\-2.el7.centos.noarch.rpm
      \- salt\-minion\-2015.5.2\-2.el7.centos.noarch.rpm
      \- salt\-ssh\-2015.5.2\-2.el7.centos.noarch.rpm
      \- salt\-syndic\-2015.5.2\-2.el7.centos.noarch.rpm
    \- dest_dir: /tmp/pkg
    \- spec: salt://pkg/salt/spec/salt.spec
    \- template: jinja
    \- deps:
      \- salt://pkg/salt/sources/required_dependency.rpm
    \- tgt: epel\-7\-x86_64
    \- sources:
      \- salt://pkg/salt/sources/logrotate.salt
      \- salt://pkg/salt/sources/README.fedora
      \- salt://pkg/salt/sources/salt\-2015.5.2.tar.gz
      \- salt://pkg/salt/sources/salt\-2015.5.2\-tests.patch
      \- salt://pkg/salt/sources/salt\-api
      \- salt://pkg/salt/sources/salt\-api.service
      \- salt://pkg/salt/sources/salt\-master
      \- salt://pkg/salt/sources/salt\-master.service
      \- salt://pkg/salt/sources/salt\-minion
      \- salt://pkg/salt/sources/salt\-minion.service
      \- salt://pkg/salt/sources/saltpkg.sls
      \- salt://pkg/salt/sources/salt\-syndic
      \- salt://pkg/salt/sources/salt\-syndic.service
      \- salt://pkg/salt/sources/SaltTesting\-2015.5.8.tar.gz
/tmp/pkg:
  pkgbuild.repo
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkgbuild.built(name, runas, dest_dir, spec, sources, tgt, template=None, deps=None, env=None, results=None, force=False, saltenv=\(aqbase\(aq, log_dir=\(aq/var/log/salt/pkgbuild\(aq)
Ensure that the named package is built and exists in the named directory
.INDENT 7.0
.TP
.B name
The name to track the build, the name value is otherwise unused
.TP
.B runas
The user to run the build process as
.TP
.B dest_dir
The directory on the minion to place the built package(s)
.TP
.B spec
The location of the spec file (used for rpms)
.TP
.B sources
The list of package sources
.TP
.B tgt
The target platform to run the build on
.TP
.B template
Run the spec file through a templating engine
.sp
Changed in version 2015.8.2: This argument is now optional, allowing for no templating engine to
be used if none is desired.

.TP
.B deps
Packages required to ensure that the named package is built
can be hosted on either the salt master server or on an HTTP
or FTP server.  Both HTTPS and HTTP are supported as well as
downloading directly from Amazon S3 compatible URLs with both
pre\-configured and automatic IAM credentials
.TP
.B env
A dictionary of environment variables to be set prior to execution.
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- env:
    DEB_BUILD_OPTIONS: \(aqnocheck\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The above illustrates a common PyYAML pitfall, that \fByes\fP,
\fBno\fP, \fBon\fP, \fBoff\fP, \fBtrue\fP, and \fBfalse\fP are all loaded as
boolean \fBTrue\fP and \fBFalse\fP values, and must be enclosed in
quotes to be used as strings. More info on this (and other) PyYAML
idiosyncrasies can be found \fI\%here\fP\&.
.UNINDENT
.UNINDENT
.TP
.B results
The names of the expected rpms that will be built
.TP
.B force
False
If \fBTrue\fP, packages will be built even if they already exist in the
\fBdest_dir\fP\&. This is useful when building a package for continuous or
nightly package builds.
.sp
New in version 2015.8.2.

.TP
.B saltenv
The saltenv to use for files downloaded from the salt filesever
.TP
.B log_dir
/var/log/salt/rpmbuild
Root directory for log files created from the build. Logs will be
organized by package name, version, OS release, and CPU architecture
under this directory.
.sp
New in version 2015.8.2.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkgbuild.repo(name, keyid=None, env=None, use_passphrase=False, gnupghome=\(aq/etc/salt/gpgkeys\(aq, runas=\(aqbuilder\(aq, timeout=15.0)
Make a package repository and optionally sign it and packages present
.sp
The name is directory to turn into a repo. This state is best used
with onchanges linked to your package building states.
.INDENT 7.0
.TP
.B name
The directory to find packages that will be in the repository
.TP
.B keyid
Changed in version 2016.3.0.

.sp
Optional Key ID to use in signing packages and repository.
Utilizes Public and Private keys associated with keyid which have
been loaded into the minion\(aqs Pillar data.
.sp
For example, contents from a Pillar data file with named Public
and Private keys as follows:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
gpg_pkg_priv_key: |
  \-\-\-\-\-BEGIN PGP PRIVATE KEY BLOCK\-\-\-\-\-
  Version: GnuPG v1

  lQO+BFciIfQBCADAPCtzx7I5Rl32escCMZsPzaEKWe7bIX1em4KCKkBoX47IG54b
  w82PCE8Y1jF/9Uk2m3RKVWp3YcLlc7Ap3gj6VO4ysvVz28UbnhPxsIkOlf2cq8qc
  .
  .
  Ebe+8JCQTwqSXPRTzXmy/b5WXDeM79CkLWvuGpXFor76D+ECMRPv/rawukEcNptn
  R5OmgHqvydEnO4pWbn8JzQO9YX/Us0SMHBVzLC8eIi5ZIopzalvX
  =JvW8
  \-\-\-\-\-END PGP PRIVATE KEY BLOCK\-\-\-\-\-

gpg_pkg_priv_keyname: gpg_pkg_key.pem

gpg_pkg_pub_key: |
  \-\-\-\-\-BEGIN PGP PUBLIC KEY BLOCK\-\-\-\-\-
  Version: GnuPG v1

  mQENBFciIfQBCADAPCtzx7I5Rl32escCMZsPzaEKWe7bIX1em4KCKkBoX47IG54b
  w82PCE8Y1jF/9Uk2m3RKVWp3YcLlc7Ap3gj6VO4ysvVz28UbnhPxsIkOlf2cq8qc
  .
  .
  bYP7t5iwJmQzRMyFInYRt77wkJBPCpJc9FPNebL9vlZcN4zv0KQta+4alcWivvoP
  4QIxE+/+trC6QRw2m2dHk6aAeq/J0Sc7ilZufwnNA71hf9SzRIwcFXMsLx4iLlki
  inNqW9c=
  =s1CX
  \-\-\-\-\-END PGP PUBLIC KEY BLOCK\-\-\-\-\-

gpg_pkg_pub_keyname: gpg_pkg_key.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B env
Changed in version 2016.3.0.

.sp
A dictionary of environment variables to be utilized in creating the
repository. Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- env:
    OPTIONS: \(aqask\-passphrase\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The above illustrates a common \fBPyYAML\fP pitfall, that \fByes\fP,
\fBno\fP, \fBon\fP, \fBoff\fP, \fBtrue\fP, and \fBfalse\fP are all loaded as
boolean \fBTrue\fP and \fBFalse\fP values, and must be enclosed in
quotes to be used as strings. More info on this (and other)
\fBPyYAML\fP idiosyncrasies can be found \fI\%here\fP\&.
.sp
Use of \fBOPTIONS\fP on some platforms, for example:
\fBask\-passphrase\fP, will require \fBgpg\-agent\fP or similar to cache
passphrases.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This parameter is not used for making \fByum\fP repositories.
.UNINDENT
.UNINDENT
.TP
.B use_passphrase
False
New in version 2016.3.0.

.sp
Use a passphrase with the signing key presented in \fBkeyid\fP\&.
Passphrase is received from Pillar data which could be passed on the
command line with \fBpillar\fP parameter. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pillar=\(aq{ \(dqgpg_passphrase\(dq : \(dqmy_passphrase\(dq }\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B gnupghome
/etc/salt/gpgkeys
New in version 2016.3.0.

.sp
Location where GPG related files are stored, used with \(aqkeyid\(aq
.TP
.B runas
builder
New in version 2016.3.0.

.sp
User to create the repository as, and optionally sign packages.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Ensure the user has correct permissions to any files and
directories which are to be utilized.
.UNINDENT
.UNINDENT
.TP
.B timeout
15.0
New in version 2016.3.4.

.sp
Timeout in seconds to wait for the prompt for inputting the passphrase.
.UNINDENT
.UNINDENT
.SS salt.states.pkgng
.SS Manage package remote repo using FreeBSD pkgng
.sp
Salt can manage the URL pkgng pulls packages from.
ATM the state and module are small so use cases are
typically rather simple:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pkgng_clients:
  pkgng.update_packaging_site:
    \- name: \(dqhttp://192.168.0.2\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkgng.update_packaging_site(name)
.UNINDENT
.SS salt.states.pkgrepo
.SS Management of APT/DNF/YUM/Zypper package repos
.sp
States for managing software package repositories on Linux distros. Supported
package managers are APT, DNF, YUM and Zypper. Here is some example SLS:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  pkgrepo.managed:
    \- humanname: CentOS\-$releasever \- Base
    \- mirrorlist: http://mirrorlist.centos.org/?release=$releasever&arch=$basearch&repo=os
    \- comments:
        \- \(aqhttp://mirror.centos.org/centos/$releasever/os/$basearch/\(aq
    \- gpgcheck: 1
    \- gpgkey: file:///etc/pki/rpm\-gpg/RPM\-GPG\-KEY\-CentOS\-6
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  pkgrepo.managed:
    \- humanname: Logstash PPA
    \- name: deb http://ppa.launchpad.net/wolfnet/logstash/ubuntu precise main
    \- dist: precise
    \- file: /etc/apt/sources.list.d/logstash.list
    \- keyid: 28B04E4A
    \- keyserver: keyserver.ubuntu.com
    \- require_in:
      \- pkg: logstash

  pkg.latest:
    \- name: logstash
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  pkgrepo.managed:
    \- humanname: deb\-multimedia
    \- name: deb http://www.deb\-multimedia.org stable main
    \- file: /etc/apt/sources.list.d/deb\-multimedia.list
    \- key_url: salt://deb\-multimedia/files/marillat.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  pkgrepo.managed:
    \- humanname: Google Chrome
    \- name: deb http://dl.google.com/linux/chrome/deb/ stable main
    \- dist: stable
    \- file: /etc/apt/sources.list.d/chrome\-browser.list
    \- require_in:
      \- pkg: google\-chrome\-stable
    \- gpgcheck: 1
    \- key_url: https://dl\-ssl.google.com/linux/linux_signing_key.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  pkgrepo.managed:
    \- ppa: wolfnet/logstash
  pkg.latest:
    \- name: logstash
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
On Ubuntu systems, the \fBpython\-software\-properties\fP package should be
installed for better support of PPA repositories. To check if this package
is installed, run \fBdpkg \-l python\-software\-properties\fP\&.
.sp
On Ubuntu & Debian systems, the \fBpython\-apt\fP package is required to be
installed. To check if this package is installed, run \fBdpkg \-l python\-apt\fP\&.
\fBpython\-apt\fP will need to be manually installed if it is not present.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hello\-copr:
    pkgrepo.managed:
        \- copr: mymindstorm/hello
    pkg.installed:
        \- name: hello
.ft P
.fi
.UNINDENT
.UNINDENT
.SS apt\-key deprecated
.sp
\fBapt\-key\fP is deprecated and will be last available in Debian 11 and
Ubuntu 22.04. The recommended way to manage repo keys going forward
is to download the keys into /etc/apt/keyrings and use \fBsigned\-by\fP
in your repo file pointing to the key. This module was updated
in version 3005 to implement the recommended approach. You need to add
\fB\- aptkey: False\fP to your state and set \fBsigned\-by\fP in your repo
name, to use this recommended approach.  If the cli command \fBapt\-key\fP
is not available it will automatically set \fBaptkey\fP to False.
.sp
Using \fBaptkey: False\fP with \fBkey_url\fP example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
deb [signed\-by=/etc/apt/keyrings/salt\-archive\-keyring.gpg arch=amd64] https://repo.saltproject.io/py3/ubuntu/18.04/amd64/latest bionic main:
  pkgrepo.managed:
    \- file: /etc/apt/sources.list.d/salt.list
    \- key_url: https://repo.saltproject.io/py3/ubuntu/18.04/amd64/latest/salt\-archive\-keyring.gpg
    \- aptkey: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using \fBaptkey: False\fP with \fBkeyserver\fP and \fBkeyid\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
deb [signed\-by=/etc/apt/keyrings/salt\-archive\-keyring.gpg arch=amd64] https://repo.saltproject.io/py3/ubuntu/18.04/amd64/latest bionic main:
  pkgrepo.managed:
    \- file: /etc/apt/sources.list.d/salt.list
    \- keyserver: keyserver.ubuntu.com
    \- keyid: 0E08A149DE57BFBE
    \- aptkey: False
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkgrepo.absent(name, **kwargs)
This function deletes the specified repo on the system, if it exists. It
is essentially a wrapper around \fBpkg.del_repo\fP\&.
.INDENT 7.0
.TP
.B name
The name of the package repo, as it would be referred to when running
the regular package manager commands.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
On apt\-based systems this must be the complete source entry. For
example, if you include \fB[arch=amd64]\fP, and a repo matching the
specified URI, dist, etc. exists _without_ an architecture, then no
changes will be made and the state will report a \fBTrue\fP result.
.UNINDENT
.UNINDENT
.sp
\fBFEDORA/REDHAT\-SPECIFIC OPTIONS\fP
.INDENT 7.0
.TP
.B copr
Use community packages outside of the main package repository.
.sp
New in version 3002.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
hello\-copr:
    pkgrepo.absent:
      \- copr: mymindstorm/hello
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBUBUNTU\-SPECIFIC OPTIONS\fP
.INDENT 7.0
.TP
.B ppa
On Ubuntu, you can take advantage of Personal Package Archives on
Launchpad simply by specifying the user and archive name.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
logstash\-ppa:
  pkgrepo.absent:
    \- ppa: wolfnet/logstash
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B ppa_auth
For Ubuntu PPAs there can be private PPAs that require authentication
to access. For these PPAs the username/password can be specified.  This
is required for matching if the name format uses the \fBppa:\fP specifier
and is private (requires username/password to access, which is encoded
in the URI).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
logstash\-ppa:
  pkgrepo.absent:
    \- ppa: wolfnet/logstash
    \- ppa_auth: username:password
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B keyid
If passed, then the GPG key corresponding to the passed KeyID will also
be removed.
.TP
.B keyid_ppa
False
If set to \fBTrue\fP, the GPG key\(aqs ID will be looked up from
ppa.launchpad.net and removed, and the \fBkeyid\fP argument will be
ignored.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option will be disregarded unless the \fBppa\fP argument is
present.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pkgrepo.managed(name, ppa=None, copr=None, aptkey=True, **kwargs)
This state manages software package repositories. Currently, \fI\%yum\fP, \fI\%apt\fP, and \fI\%zypper\fP repositories are supported.
.sp
\fBYUM/DNF/ZYPPER\-BASED SYSTEMS\fP
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
One of \fBbaseurl\fP or \fBmirrorlist\fP below is required. Additionally,
note that this state is not presently capable of managing more than one
repo in a single repo file, so each instance of this state will manage
a single repo file containing the configuration for a single repo.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
This value will be used in two ways: Firstly, it will be the repo ID,
as seen in the entry in square brackets (e.g. \fB[foo]\fP) for a given
repo. Secondly, it will be the name of the file as stored in
/etc/yum.repos.d (e.g. \fB/etc/yum.repos.d/foo.conf\fP).
.TP
.B enabled
True
Whether the repo is enabled or not. Can be specified as \fBTrue\fP/\fBFalse\fP or
\fB1\fP/\fB0\fP\&.
.TP
.B disabled
False
Included to reduce confusion due to APT\(aqs use of the \fBdisabled\fP
argument. If this is passed for a YUM/DNF/Zypper\-based distro, then the
reverse will be passed as \fBenabled\fP\&. For example passing
\fBdisabled=True\fP will assume \fBenabled=False\fP\&.
.TP
.B copr
Fedora and RedHat based distributions only. Use community packages
outside of the main package repository.
.sp
New in version 3002.

.TP
.B humanname
This is used as the \fBname\fP value in the repo file in
\fB/etc/yum.repos.d/\fP (or \fB/etc/zypp/repos.d\fP for SUSE distros).
.TP
.B baseurl
The URL to a yum repository
.TP
.B mirrorlist
A URL which points to a file containing a collection of baseurls
.TP
.B comments
Sometimes you want to supply additional information, but not as
enabled configuration. Anything supplied for this list will be saved
in the repo configuration with a comment marker (#) in front.
.TP
.B gpgautoimport
Only valid for Zypper package manager. If set to \fBTrue\fP, automatically
trust and import the new repository signing key. The key should be
specified with \fBgpgkey\fP parameter. See details below.
.UNINDENT
.sp
Additional configuration values seen in YUM/DNF/Zypper repo files, such as
\fBgpgkey\fP or \fBgpgcheck\fP, will be used directly as key\-value pairs.
For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  pkgrepo.managed:
    \- humanname: Personal repo for foo
    \- baseurl: https://mydomain.tld/repo/foo/$releasever/$basearch
    \- gpgkey: file:///etc/pki/rpm\-gpg/foo\-signing\-key
    \- gpgcheck: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBAPT\-BASED SYSTEMS\fP
.INDENT 7.0
.TP
.B ppa
On Ubuntu, you can take advantage of Personal Package Archives on
Launchpad simply by specifying the user and archive name. The keyid
will be queried from launchpad and everything else is set
automatically. You can override any of the below settings by simply
setting them as you would normally. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
logstash\-ppa:
  pkgrepo.managed:
    \- ppa: wolfnet/logstash
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B ppa_auth
For Ubuntu PPAs there can be private PPAs that require authentication
to access. For these PPAs the username/password can be passed as an
HTTP Basic style username/password combination.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
logstash\-ppa:
  pkgrepo.managed:
    \- ppa: wolfnet/logstash
    \- ppa_auth: username:password
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B name
On apt\-based systems this must be the complete entry as it would be
seen in the \fBsources.list\fP file. This can have a limited subset of
components (e.g. \fBmain\fP) which can be added/modified with the
\fBcomps\fP option.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
precise\-repo:
  pkgrepo.managed:
    \- name: deb http://us.archive.ubuntu.com/ubuntu precise main
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The above example is intended as a more readable way of configuring
the SLS, it is equivalent to the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(aqdeb http://us.archive.ubuntu.com/ubuntu precise main\(aq:
  pkgrepo.managed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B disabled
False
Toggles whether or not the repo is used for resolving dependencies
and/or installing packages.
.TP
.B enabled
True
Included to reduce confusion due to YUM/DNF/Zypper\(aqs use of the
\fBenabled\fP argument. If this is passed for an APT\-based distro, then
the reverse will be passed as \fBdisabled\fP\&. For example, passing
\fBenabled=False\fP will assume \fBdisabled=False\fP\&.
.TP
.B architectures
On apt\-based systems, \fBarchitectures\fP can restrict the available
architectures that the repository provides (e.g. only \fBamd64\fP).
\fBarchitectures\fP should be a comma\-separated list.
.TP
.B comps
On apt\-based systems, comps dictate the types of packages to be
installed from the repository (e.g. \fBmain\fP, \fBnonfree\fP, ...).  For
purposes of this, \fBcomps\fP should be a comma\-separated list.
.TP
.B file
The filename for the \fB*.list\fP that the repository is configured in.
It is important to include the full\-path AND make sure it is in
a directory that APT will look in when handling packages
.TP
.B dist
This dictates the release of the distro the packages should be built
for.  (e.g. \fBunstable\fP). This option is rarely needed.
.TP
.B keyid
The KeyID or a list of KeyIDs of the GPG key to install.
This option also requires the \fBkeyserver\fP option to be set.
.TP
.B keyserver
This is the name of the keyserver to retrieve GPG keys from. The
\fBkeyid\fP option must also be set for this option to work.
.TP
.B key_url
URL to retrieve a GPG key from. Allows the usage of
\fBhttps://\fP as well as \fBsalt://\fP\&.  If \fBallow_insecure_key\fP is True,
this also allows \fBhttp://\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Use either \fBkeyid\fP/\fBkeyserver\fP or \fBkey_url\fP, but not both.
.UNINDENT
.UNINDENT
.TP
.B key_text
The string representation of the GPG key to install.
.sp
New in version 2018.3.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Use either \fBkeyid\fP/\fBkeyserver\fP, \fBkey_url\fP, or \fBkey_text\fP but
not more than one method.
.UNINDENT
.UNINDENT
.TP
.B consolidate
False
If set to \fBTrue\fP, this will consolidate all sources definitions to the
\fBsources.list\fP file, cleanup the now unused files, consolidate components
(e.g. \fBmain\fP) for the same URI, type, and architecture to a single line,
and finally remove comments from the \fBsources.list\fP file.  The consolidation
will run every time the state is processed. The option only needs to be
set on one repo managed by Salt to take effect.
.TP
.B clean_file
False
If set to \fBTrue\fP, empty the file before configuring the defined repository
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Use with care. This can be dangerous if multiple sources are
configured in the same file.
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.TP
.B refresh
True
If set to \fBFalse\fP this will skip refreshing the apt package database
on Debian based systems.
.TP
.B refresh_db
True
Deprecated since version 2018.3.0: Use \fBrefresh\fP instead.

.TP
.B require_in
Set this to a list of \fI\%pkg.installed\fP or
\fI\%pkg.latest\fP to trigger the
running of \fBapt\-get update\fP prior to attempting to install these
packages. Setting a require in the pkg state will not work for this.
.TP
.B aptkey:
Use the binary apt\-key. If the command \fBapt\-key\fP is not found
in the path, aptkey will be False, regardless of what is passed into
this argument.
.TP
.B allow_insecure_key
True
Whether to allow an insecure (e.g. http vs. https) key_url.
.sp
New in version 3006.0.

.UNINDENT
.UNINDENT
.SS salt.states.portage_config
.SS Management of Portage package configuration on Gentoo
.sp
A state module to manage Portage configuration on Gentoo
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt:
    portage_config.flags:
        \- use:
            \- openssl
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.portage_config.flags(name, use=None, accept_keywords=None, env=None, license=None, properties=None, unmask=False, mask=False)
Enforce the given flags on the given package or \fBDEPEND\fP atom.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
In most cases, the affected package(s) need to be rebuilt in
order to apply the changes.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the package or its DEPEND atom
.TP
.B use
A list of \fBUSE\fP flags
.TP
.B accept_keywords
A list of keywords to accept. \fB~ARCH\fP means current host arch, and will
be translated into a line without keywords
.TP
.B env
A list of environment files
.TP
.B license
A list of accepted licenses
.TP
.B properties
A list of additional properties
.TP
.B unmask
A boolean to unmask the package
.TP
.B mask
A boolean to mask the package
.UNINDENT
.UNINDENT
.SS salt.states.ports
.sp
Manage software from FreeBSD ports
.sp
New in version 2014.1.0.

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
It may be helpful to use a higher timeout when running a
\fI\%ports.installed\fP state, since compiling the port
may exceed Salt\(aqs timeout.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-t 1200 \(aq*\(aq state.highstate
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ports.installed(name, options=None)
Verify that the desired port is installed, and that it was compiled with
the desired options.
.INDENT 7.0
.TP
.B options
Make sure that the desired non\-default options are set
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Any build options not passed here assume the default values for the
port, and are not just differences from the existing cached options
from a previous \fBmake config\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Example usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
security/nmap:
  ports.installed:
    \- options:
      \- IPV6: off
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.postgres_cluster
.SS Management of PostgreSQL clusters
.sp
The postgres_cluster state module is used to manage PostgreSQL clusters.
Clusters can be set as either absent or present
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
create cluster 9.3 main:
  postgres_cluster.present:
      \- name: \(aqmain\(aq
      \- version: \(aq9.3\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_cluster.absent(version, name)
Ensure that the named cluster is absent
.INDENT 7.0
.TP
.B version
Version of the postgresql server of the cluster to remove
.TP
.B name
The name of the cluster to remove
.sp
New in version 2016.3.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_cluster.present(version, name, port=None, encoding=None, locale=None, datadir=None, allow_group_access=None, data_checksums=None, wal_segsize=None)
Ensure that the named cluster is present with the specified properties.
For more information about all of these options see man pg_createcluster(1)
.INDENT 7.0
.TP
.B version
Version of the postgresql cluster
.TP
.B name
The name of the cluster
.TP
.B port
Cluster port
.TP
.B encoding
The character encoding scheme to be used in this database
.TP
.B locale
Locale with which to create cluster
.TP
.B datadir
Where the cluster is stored
.TP
.B allow_group_access
Allows users in the same group as the cluster owner to read all cluster files created by initdb
.TP
.B data_checksums
Use checksums on data pages
.TP
.B wal_segsize
Set the WAL segment size, in megabytes
.sp
New in version 2016.3.0.

.UNINDENT
.UNINDENT
.SS salt.states.postgres_database
.SS Management of PostgreSQL databases
.sp
The postgres_database module is used to create and manage Postgres databases.
Databases can be set as either absent or present
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
frank:
  postgres_database.present
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_database.absent(name, user=None, maintenance_db=None, db_password=None, db_host=None, db_port=None, db_user=None)
Ensure that the named database is absent
.INDENT 7.0
.TP
.B name
The name of the database to remove
.TP
.B db_user
database username if different from config or default
.TP
.B db_password
user password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.TP
.B user
System user all operations should be performed on behalf of
.sp
New in version 0.17.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_database.present(name, tablespace=None, encoding=None, lc_collate=None, lc_ctype=None, owner=None, owner_recurse=False, template=None, user=None, maintenance_db=None, db_password=None, db_host=None, db_port=None, db_user=None)
Ensure that the named database is present with the specified properties.
For more information about all of these options see man createdb(1)
.INDENT 7.0
.TP
.B name
The name of the database to manage
.TP
.B tablespace
Default tablespace for the database
.TP
.B encoding
The character encoding scheme to be used in this database. The encoding
has to be defined in the following format (without hyphen).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- encoding: UTF8
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B lc_collate
The LC_COLLATE setting to be used in this database
.TP
.B lc_ctype
The LC_CTYPE setting to be used in this database
.TP
.B owner
The username of the database owner
.TP
.B owner_recurse
Recurse owner change to all relations in the database
.TP
.B template
The template database from which to build this database
.TP
.B user
System user all operations should be performed on behalf of
.TP
.B db_user
database username if different from config or default
.TP
.B db_password
user password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.sp
New in version 0.17.0.

.UNINDENT
.UNINDENT
.SS salt.states.postgres_extension
.SS Management of PostgreSQL extensions
.sp
A module used to install and manage PostgreSQL extensions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
adminpack:
  postgres_extension.present
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B salt.states.postgres_extension.absent(name, if_exists=None, restrict=None, cascade=None, user=None, maintenance_db=None, db_user=None, db_password=None, db_host=None, db_port=None)
Ensure that the named extension is absent.
.INDENT 7.0
.TP
.B name
Extension name of the extension to remove
.TP
.B if_exists
Add if exist slug
.TP
.B restrict
Add restrict slug
.TP
.B cascade
Drop on cascade
.TP
.B user
System user all operations should be performed on behalf of
.TP
.B maintenance_db
Database to act on
.TP
.B db_user
Database username if different from config or default
.TP
.B db_password
User password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_extension.present(name, if_not_exists=None, schema=None, ext_version=None, from_version=None, user=None, maintenance_db=None, db_user=None, db_password=None, db_host=None, db_port=None)
Ensure that the named extension is present.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Before you can use the state to load an extension into a database, the
extension\(aqs supporting files must be already installed.
.UNINDENT
.UNINDENT
.sp
For more information about all of these options see \fBCREATE EXTENSION\fP SQL
command reference in the PostgreSQL documentation.
.INDENT 7.0
.TP
.B name
The name of the extension to be installed
.TP
.B if_not_exists
Add an \fBIF NOT EXISTS\fP parameter to the DDL statement
.TP
.B schema
Schema to install the extension into
.TP
.B ext_version
Version to install
.TP
.B from_version
Old extension version if already installed
.TP
.B user
System user all operations should be performed on behalf of
.TP
.B maintenance_db
Database to act on
.TP
.B db_user
Database username if different from config or default
.TP
.B db_password
User password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.SS salt.states.postgres_group
.SS Management of PostgreSQL groups (roles)
.sp
The postgres_group module is used to create and manage Postgres groups.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
frank:
  postgres_group.present
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_group.absent(name, user=None, maintenance_db=None, db_password=None, db_host=None, db_port=None, db_user=None)
Ensure that the named group is absent
.INDENT 7.0
.TP
.B name
The groupname of the group to remove
.TP
.B user
System user all operations should be performed on behalf of
.sp
New in version 0.17.0.

.TP
.B db_user
database username if different from config or default
.TP
.B db_password
user password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_group.present(name, createdb=None, createroles=None, encrypted=None, superuser=None, inherit=None, login=None, replication=None, password=None, refresh_password=None, groups=None, user=None, maintenance_db=None, db_password=None, db_host=None, db_port=None, db_user=None)
Ensure that the named group is present with the specified privileges
Please note that the user/group notion in postgresql is just abstract, we
have roles, where users can be seen as roles with the \fBLOGIN\fP privilege
and groups the others.
.INDENT 7.0
.TP
.B name
The name of the group to manage
.TP
.B createdb
Is the group allowed to create databases?
.TP
.B createroles
Is the group allowed to create other roles/users
.TP
.B encrypted
How the password should be stored.
.sp
If encrypted is \fBNone\fP, \fBTrue\fP, or \fBmd5\fP, it will use
PostgreSQL\(aqs MD5 algorithm.
.sp
If encrypted is \fBFalse\fP, it will be stored in plaintext.
.sp
If encrypted is \fBscram\-sha\-256\fP, it will use the algorithm described
in RFC 7677.
.sp
Changed in version 3003: Prior versions only supported \fBTrue\fP and \fBFalse\fP

.TP
.B login
Should the group have login perm
.TP
.B inherit
Should the group inherit permissions
.TP
.B superuser
Should the new group be a \(dqsuperuser\(dq
.TP
.B replication
Should the new group be allowed to initiate streaming replication
.TP
.B password
The group\(aqs password.
It can be either a plain string or a pre\-hashed password:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\(aqmd5{MD5OF({password}{role}}\(aq
\(aqSCRAM\-SHA\-256${iterations}:{salt}${stored_key}:{server_key}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If encrypted is not \fBFalse\fP, then the password will be converted
to the appropriate format above, if not already. As a consequence,
passwords that start with \(dqmd5\(dq or \(dqSCRAM\-SHA\-256\(dq cannot be used.
.TP
.B refresh_password
Password refresh flag
.sp
Boolean attribute to specify whether to password comparison check
should be performed.
.sp
If refresh_password is \fBTrue\fP, the password will be automatically
updated without extra password change check.
.sp
This behaviour makes it possible to execute in environments without
superuser access available, e.g. Amazon RDS for PostgreSQL
.TP
.B groups
A string of comma separated groups the group should be in
.TP
.B user
System user all operations should be performed on behalf of
.sp
New in version 0.17.0.

.TP
.B db_user
database username if different from config or default
.TP
.B db_password
user password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.SS salt.states.postgres_initdb
.SS Initialization of PostgreSQL data directory
.sp
The postgres_initdb module is used to initialize the postgresql
data directory.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pgsql\-data\-dir:
  postgres_initdb.present:
    \- name: /var/lib/pgsql/data
    \- auth: password
    \- user: postgres
    \- password: strong_password
    \- encoding: UTF8
    \- locale: C
    \- runas: postgres
    \- checksums: True
    \- waldir: /var/postgresql/wal
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_initdb.present(name, user=None, password=None, auth=\(aqpassword\(aq, encoding=\(aqUTF8\(aq, locale=None, runas=None, waldir=None, checksums=False)
Initialize the PostgreSQL data directory
.INDENT 7.0
.TP
.B name
The name of the directory to initialize
.TP
.B user
The database superuser name
.TP
.B password
The password to set for the postgres user
.TP
.B auth
The default authentication method for local connections
.TP
.B encoding
The default encoding for new databases
.TP
.B locale
The default locale for new databases
.TP
.B waldir
The transaction log (WAL) directory (default is to keep WAL
inside the data directory)
.sp
New in version 2019.2.0.

.TP
.B checksums
If True, the cluster will be created with data page checksums.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Data page checksums are supported since PostgreSQL 9.3.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.

.TP
.B runas
The system user the operation should be performed on behalf of
.UNINDENT
.UNINDENT
.SS salt.states.postgres_language
.SS Management of PostgreSQL languages
.sp
The postgres_language module is used to create and manage Postgres languages.
Languages can be set as either absent or present
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
plpgsql:
  postgres_language.present:
    \- maintenance_db: testdb
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
plpgsql:
  postgres_language.absent:
    \- maintenance_db: testdb
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_language.absent(name, maintenance_db, user=None, db_password=None, db_host=None, db_port=None, db_user=None)
Ensure that a named language is absent in the specified
database.
.INDENT 7.0
.TP
.B name
The name of the language to remove
.TP
.B maintenance_db
The name of the database in which the language is to be installed
.TP
.B user
System user all operations should be performed on behalf of
.TP
.B db_user
database username if different from config or default
.TP
.B db_password
user password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_language.present(name, maintenance_db, user=None, db_password=None, db_host=None, db_port=None, db_user=None)
Ensure that a named language is present in the specified
database.
.INDENT 7.0
.TP
.B name
The name of the language to install
.TP
.B maintenance_db
The name of the database in which the language is to be installed
.TP
.B user
System user all operations should be performed on behalf of
.TP
.B db_user
database username if different from config or default
.TP
.B db_password
user password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.SS salt.states.postgres_privileges
.SS Management of PostgreSQL Privileges
.sp
The postgres_privileges module is used to manage Postgres privileges.
Privileges can be set as either absent or present.
.sp
Privileges can be set on the following database object types:
.INDENT 0.0
.IP \(bu 2
database
.IP \(bu 2
schema
.IP \(bu 2
tablespace
.IP \(bu 2
table
.IP \(bu 2
sequence
.IP \(bu 2
language
.IP \(bu 2
group
.UNINDENT
.sp
Setting the grant option is supported as well.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
baruwa:
  postgres_privileges.present:
    \- object_name: awl
    \- object_type: table
    \- privileges:
      \- SELECT
      \- INSERT
      \- DELETE
    \- grant_option: False
    \- prepend: public
    \- maintenance_db: testdb
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
andrew:
  postgres_privileges.present:
    \- object_name: admins
    \- object_type: group
    \- grant_option: False
    \- maintenance_db: testdb
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
baruwa:
  postgres_privileges.absent:
    \- object_name: awl
    \- object_type: table
    \- privileges:
      \- SELECT
      \- INSERT
      \- DELETE
    \- prepend: public
    \- maintenance_db: testdb
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
andrew:
  postgres_privileges.absent:
    \- object_name: admins
    \- object_type: group
    \- maintenance_db: testdb
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_privileges.absent(name, object_name, object_type, privileges=None, prepend=\(aqpublic\(aq, maintenance_db=None, user=None, db_password=None, db_host=None, db_port=None, db_user=None)
Revoke the requested privilege(s) on the specificed object(s)
.INDENT 7.0
.TP
.B name
Name of the role whose privileges should be revoked
.TP
.B object_name
Name of the object on which the revoke is to be performed
.TP
.B object_type
The object type, which can be one of the following:
.INDENT 7.0
.IP \(bu 2
table
.IP \(bu 2
sequence
.IP \(bu 2
schema
.IP \(bu 2
tablespace
.IP \(bu 2
language
.IP \(bu 2
database
.IP \(bu 2
group
.IP \(bu 2
function
.UNINDENT
.sp
View permissions should specify \fIobject_type: table\fP\&.
.TP
.B privileges
Comma separated list of privileges to revoke, from the list below:
.INDENT 7.0
.IP \(bu 2
INSERT
.IP \(bu 2
CREATE
.IP \(bu 2
TRUNCATE
.IP \(bu 2
CONNECT
.IP \(bu 2
TRIGGER
.IP \(bu 2
SELECT
.IP \(bu 2
USAGE
.IP \(bu 2
TEMPORARY
.IP \(bu 2
UPDATE
.IP \(bu 2
EXECUTE
.IP \(bu 2
REFERENCES
.IP \(bu 2
DELETE
.IP \(bu 2
ALL
.UNINDENT
.INDENT 7.0
.TP
.B note
privileges should not be set when revoking group membership
.UNINDENT
.TP
.B prepend
Table and Sequence object types live under a schema so this should be
provided if the object is not under the default \fIpublic\fP schema
.TP
.B maintenance_db
The name of the database in which the language is to be installed
.TP
.B user
System user all operations should be performed on behalf of
.TP
.B db_user
database username if different from config or default
.TP
.B db_password
user password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_privileges.present(name, object_name, object_type, privileges=None, grant_option=None, prepend=\(aqpublic\(aq, maintenance_db=None, user=None, db_password=None, db_host=None, db_port=None, db_user=None)
Grant the requested privilege(s) on the specified object to a role
.INDENT 7.0
.TP
.B name
Name of the role to which privileges should be granted
.TP
.B object_name
Name of the object on which the grant is to be performed.
\(aqALL\(aq may be used for objects of type \(aqtable\(aq or \(aqsequence\(aq.
.TP
.B object_type
The object type, which can be one of the following:
.INDENT 7.0
.IP \(bu 2
table
.IP \(bu 2
sequence
.IP \(bu 2
schema
.IP \(bu 2
tablespace
.IP \(bu 2
language
.IP \(bu 2
database
.IP \(bu 2
group
.IP \(bu 2
function
.UNINDENT
.sp
View permissions should specify \fIobject_type: table\fP\&.
.TP
.B privileges
List of privileges to grant, from the list below:
.INDENT 7.0
.IP \(bu 2
INSERT
.IP \(bu 2
CREATE
.IP \(bu 2
TRUNCATE
.IP \(bu 2
CONNECT
.IP \(bu 2
TRIGGER
.IP \(bu 2
SELECT
.IP \(bu 2
USAGE
.IP \(bu 2
TEMPORARY
.IP \(bu 2
UPDATE
.IP \(bu 2
EXECUTE
.IP \(bu 2
REFERENCES
.IP \(bu 2
DELETE
.IP \(bu 2
ALL
.UNINDENT
.INDENT 7.0
.TP
.B note
privileges should not be set when granting group membership
.UNINDENT
.TP
.B grant_option
If grant_option is set to True, the recipient of the privilege can
in turn grant it to others
.TP
.B prepend
Table and Sequence object types live under a schema so this should be
provided if the object is not under the default \fIpublic\fP schema
.TP
.B maintenance_db
The name of the database in which the language is to be installed
.TP
.B user
System user all operations should be performed on behalf of
.TP
.B db_user
database username if different from config or default
.TP
.B db_password
user password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.SS salt.states.postgres_schema
.SS Management of PostgreSQL schemas
.sp
The postgres_schemas module is used to create and manage Postgres schemas.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
public:
  postgres_schema.present \(aqdbname\(aq \(aqname\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_schema.absent(dbname, name, user=None, db_user=None, db_password=None, db_host=None, db_port=None)
Ensure that the named schema is absent.
.INDENT 7.0
.TP
.B dbname
The database\(aqs name will work on
.TP
.B name
The name of the schema to remove
.TP
.B user
system user all operations should be performed on behalf of
.TP
.B db_user
database username if different from config or default
.TP
.B db_password
user password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_schema.present(dbname, name, owner=None, user=None, db_user=None, db_password=None, db_host=None, db_port=None)
Ensure that the named schema is present in the database.
.INDENT 7.0
.TP
.B dbname
The database\(aqs name will work on
.TP
.B name
The name of the schema to manage
.TP
.B user
system user all operations should be performed on behalf of
.TP
.B db_user
database username if different from config or default
.TP
.B db_password
user password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.SS salt.states.postgres_tablespace
.SS Management of PostgreSQL tablespace
.sp
A module used to create and manage PostgreSQL tablespaces.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssd\-tablespace:
  postgres_tablespace.present:
    \- name: indexes
    \- directory: /mnt/ssd\-data
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B salt.states.postgres_tablespace.absent(name, user=None, maintenance_db=None, db_user=None, db_password=None, db_host=None, db_port=None)
Ensure that the named tablespace is absent.
.INDENT 7.0
.TP
.B name
The name of the tablespace to remove
.TP
.B user
System user all operations should be performed on behalf of
.TP
.B maintenance_db
Database to act on
.TP
.B db_user
Database username if different from config or default
.TP
.B db_password
User password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_tablespace.present(name, directory, options=None, owner=None, user=None, maintenance_db=None, db_password=None, db_host=None, db_port=None, db_user=None)
Ensure that the named tablespace is present with the specified properties.
For more information about all of these options run \fBman 7
create_tablespace\fP\&.
.INDENT 7.0
.TP
.B name
The name of the tablespace to create/manage.
.TP
.B directory
The directory where the tablespace will be located, must already exist
.TP
.B options
A dictionary of options to specify for the tablespace.
Currently, the only tablespace options supported are \fBseq_page_cost\fP
and \fBrandom_page_cost\fP\&. Default values are shown in the example below:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my_space:
  postgres_tablespace.present:
    \- directory: /srv/my_tablespace
    \- options:
        seq_page_cost: 1.0
        random_page_cost: 4.0
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B owner
The database user that will be the owner of the tablespace.
Defaults to the user executing the command (i.e. the \fIuser\fP option)
.TP
.B user
System user all operations should be performed on behalf of
.TP
.B maintenance_db
Database to act on
.TP
.B db_user
Database username if different from config or default
.TP
.B db_password
User password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.SS salt.states.postgres_user
.SS Management of PostgreSQL users (roles)
.sp
The postgres_users module is used to create and manage Postgres users.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
frank:
  postgres_user.present
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_user.absent(name, user=None, maintenance_db=None, db_password=None, db_host=None, db_port=None, db_user=None)
Ensure that the named user is absent
.INDENT 7.0
.TP
.B name
The username of the user to remove
.TP
.B user
System user all operations should be performed on behalf of
.sp
New in version 0.17.0.

.TP
.B db_user
database username if different from config or default
.TP
.B db_password
user password if any password for a specified user
.TP
.B db_host
Database host if different from config or default
.TP
.B db_port
Database port if different from config or default
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.postgres_user.present(name, createdb=None, createroles=None, encrypted=None, superuser=None, replication=None, inherit=None, login=None, password=None, default_password=None, refresh_password=None, valid_until=None, groups=None, user=None, maintenance_db=None, db_password=None, db_host=None, db_port=None, db_user=None)
Ensure that the named user is present with the specified privileges
Please note that the user/group notion in postgresql is just abstract, we
have roles, where users can be seen as roles with the LOGIN privilege
and groups the others.
.INDENT 7.0
.TP
.B name
The name of the system user to manage.
.TP
.B createdb
Is the user allowed to create databases?
.TP
.B createroles
Is the user allowed to create other users?
.TP
.B encrypted
How the password should be stored.
.sp
If encrypted is \fBNone\fP, \fBTrue\fP, or \fBmd5\fP, it will use
PostgreSQL\(aqs MD5 algorithm.
.sp
If encrypted is \fBFalse\fP, it will be stored in plaintext.
.sp
If encrypted is \fBscram\-sha\-256\fP, it will use the algorithm described
in RFC 7677.
.sp
Changed in version 3003: Prior versions only supported \fBTrue\fP and \fBFalse\fP

.TP
.B login
Should the group have login perm
.TP
.B inherit
Should the group inherit permissions
.TP
.B superuser
Should the new user be a \(dqsuperuser\(dq
.TP
.B replication
Should the new user be allowed to initiate streaming replication
.TP
.B password
The user\(aqs password.
It can be either a plain string or a pre\-hashed password:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\(aqmd5{MD5OF({password}{role}}\(aq
\(aqSCRAM\-SHA\-256${iterations}:{salt}${stored_key}:{server_key}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If encrypted is not \fBFalse\fP, then the password will be converted
to the appropriate format above, if not already. As a consequence,
passwords that start with \(dqmd5\(dq or \(dqSCRAM\-SHA\-256\(dq cannot be used.
.TP
.B default_password
The password used only when creating the user, unless password is set.
.sp
New in version 2016.3.0.

.TP
.B refresh_password
Password refresh flag
.sp
Boolean attribute to specify whether to password comparison check
should be performed.
.sp
If refresh_password is \fBTrue\fP, the password will be automatically
updated without extra password change check.
.sp
This behaviour makes it possible to execute in environments without
superuser access available, e.g. Amazon RDS for PostgreSQL
.TP
.B valid_until
A date and time after which the role\(aqs password is no longer valid.
.TP
.B groups
A string of comma separated groups the user should be in
.TP
.B user
System user all operations should be performed on behalf of
.sp
New in version 0.17.0.

.TP
.B db_user
Postgres database username, if different from config or default.
.TP
.B db_password
Postgres user\(aqs password, if any password, for a specified db_user.
.TP
.B db_host
Postgres database host, if different from config or default.
.TP
.B db_port
Postgres database port, if different from config or default.
.UNINDENT
.UNINDENT
.SS salt.states.powerpath
.SS Powerpath configuration support
.sp
Allows configuration of EMC Powerpath.  Currently
only addition/deletion of licenses is supported.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
key:
  powerpath.license_present: []
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.powerpath.license_absent(name)
Ensures that the specified PowerPath license key is absent
on the host.
.INDENT 7.0
.TP
.B name
The license key to ensure is absent
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.powerpath.license_present(name)
Ensures that the specified PowerPath license key is present
on the host.
.INDENT 7.0
.TP
.B name
The license key to ensure is present
.UNINDENT
.UNINDENT
.SS salt.states.probes
.SS Network Probes
.sp
Configure RPM (JunOS)/SLA (Cisco) probes on the device via NAPALM proxy.
.INDENT 0.0
.TP
.B codeauthor
Mircea Ulinic <\fI\%ping@mirceaulinic.net\fP> & Jerome Fleury <\fI\%jf@cloudflare.com\fP>
.TP
.B maturity
new
.TP
.B depends
napalm
.TP
.B platform
unix
.UNINDENT
.SS Dependencies
.INDENT 0.0
.IP \(bu 2
\fI\%napalm probes management module\fP
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.states.probes.managed(name, probes, defaults=None)
Ensure the networks device is configured as specified in the state SLS file.
Probes not specified will be removed, while probes not confiured as expected will trigger config updates.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprobes\fP \-\- Defines the probes as expected to be configured on the
device.  In order to ease the configuration and avoid repeating the
same parameters for each probe, the next parameter (defaults) can be
used, providing common characteristics.
.IP \(bu 2
\fBdefaults\fP \-\- Specifies common parameters for the probes.
.UNINDENT
.UNINDENT
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
rpmprobes:
    probes.managed:
        \- probes:
            probe_name1:
                probe1_test1:
                    source: 192.168.0.2
                    target: 192.168.0.1
                probe1_test2:
                    target: 172.17.17.1
                probe1_test3:
                    target: 8.8.8.8
                    probe_type: http\-ping
            probe_name2:
                probe2_test1:
                    test_interval: 100
        \- defaults:
            target: 10.10.10.10
            probe_count: 15
            test_interval: 3
            probe_type: icmp\-ping
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the probes configuration, the only mandatory attribute is \fItarget\fP
(specified either in probes configuration, either in the defaults
dictionary).  All the other parameters will use the operating system
defaults, if not provided:
.INDENT 7.0
.IP \(bu 2
\fBsource\fP \- Specifies the source IP Address to be used during the tests.  If
not specified will use the IP Address of the logical interface loopback0.
.IP \(bu 2
\fBtarget\fP \- Destination IP Address.
.IP \(bu 2
\fBprobe_count\fP \- Total number of probes per test (1..15). System
defaults: 1 on both JunOS & Cisco.
.IP \(bu 2
\fBprobe_interval\fP \- Delay between tests (0..86400 seconds). System
defaults: 3 on JunOS, 5 on Cisco.
.IP \(bu 2
\fBprobe_type\fP \- Probe request type. Available options:
.INDENT 2.0
.IP \(bu 2
icmp\-ping
.IP \(bu 2
tcp\-ping
.IP \(bu 2
udp\-ping
.UNINDENT
.UNINDENT
.sp
Using the example configuration above, after running the state, on the device will be configured 4 probes,
with the following properties:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
probe_name1:
    probe1_test1:
        source: 192.168.0.2
        target: 192.168.0.1
        probe_count: 15
        test_interval: 3
        probe_type: icmp\-ping
    probe1_test2:
        target: 172.17.17.1
        probe_count: 15
        test_interval: 3
        probe_type: icmp\-ping
    probe1_test3:
        target: 8.8.8.8
        probe_count: 15
        test_interval: 3
        probe_type: http\-ping
probe_name2:
    probe2_test1:
        target: 10.10.10.10
        probe_count: 15
        test_interval: 3
        probe_type: icmp\-ping
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.process
.SS Process Management
.sp
Ensure a process matching a given pattern is absent.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
httpd\-absent:
  process.absent:
    \- name: apache2
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.process.absent(name, user=None, signal=None)
Ensures that the named command is not running.
.INDENT 7.0
.TP
.B name
The pattern to match.
.TP
.B user
The user to which the process belongs
.TP
.B signal
Signal to send to the process(es).
.UNINDENT
.UNINDENT
.SS salt.states.proxy
.SS Allows you to manage proxy settings on minions
.sp
Setup proxy settings on minions
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
192.168.1.4:
  proxy.managed:
    \- port: 3128
    \- bypass_domains:
        \- localhost
        \- 127.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.proxy.managed(name, port, services=None, user=None, password=None, bypass_domains=None, network_service=\(aqEthernet\(aq)
Manages proxy settings for this mininon
.INDENT 7.0
.TP
.B name
The proxy server to use
.TP
.B port
The port used by the proxy server
.TP
.B services
A list of the services that should use the given proxy settings, valid services include http, https and ftp.
If no service is given all of the valid services will be used.
.TP
.B user
The username to use for the proxy server if required
.TP
.B password
The password to use for the proxy server if required
.TP
.B bypass_domains
An array of the domains that should bypass the proxy
.TP
.B network_service
The network service to apply the changes to, this only necessary on
macOS
.UNINDENT
.UNINDENT
.SS salt.states.pushover
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%pushover Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.SS Send a message to PushOver
.sp
This state is useful for sending messages to PushOver during state runs.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pushover\-message:
  pushover.post_message:
    \- user: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    \- token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    \- title: Salt Returner
    \- device: phone
    \- priority: \-1
    \- expire: 3600
    \- retry: 5
    \- message: \(aqThis state was executed successfully.\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The api key can be specified in the master or minion configuration like below:
\&.. code\-block:: yaml
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B pushover:
token: peWcBiMOS9HrZG15peWcBiMOS9HrZG15
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pushover.post_message(name, user=None, device=None, message=None, title=None, priority=None, expire=None, retry=None, sound=None, api_version=1, token=None)
Send a message to a PushOver channel.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pushover\-message:
  pushover.post_message:
    \- user: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    \- token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    \- title: Salt Returner
    \- device: phone
    \- priority: \-1
    \- expire: 3600
    \- retry: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B name
The unique name for this event.
.TP
.B user
The user or group of users to send the message to. Must be ID of user, not name
or email address.
.TP
.B message
The message that is to be sent to the PushOver channel.
.UNINDENT
.sp
The following parameters are optional:
.INDENT 7.0
.TP
.B title
The title to use for the message.
.TP
.B device
The device for the user to send the message to.
.TP
.B priority
The priority for the message.
.TP
.B expire
The message should expire after specified amount of seconds.
.TP
.B retry
The message should be resent this many times.
.TP
.B token
The token for PushOver to use for authentication,
if not specified in the configuration options of master or minion.
.UNINDENT
.UNINDENT
.SS salt.states.pyenv
.SS Managing python installations with pyenv
.sp
This module is used to install and manage python installations with pyenv.
Different versions of python can be installed, and uninstalled. pyenv will
be installed automatically the first time it is needed and can be updated
later. This module will \fInot\fP automatically install packages which pyenv
will need to compile the versions of python.
.sp
If pyenv is run as the root user then it will be installed to /usr/local/pyenv,
otherwise it will be installed to the users ~/.pyenv directory. To make
pyenv available in the shell you may need to add the pyenv/shims and pyenv/bin
directories to the users PATH. If you are installing as root and want other
users to be able to access pyenv then you will need to add pyenv_ROOT to
their environment.
.sp
This is how a state configuration could look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pyenv\-deps:
  pkg.installed:
    \- pkgs:
      \- make
      \- build\-essential
      \- libssl\-dev
      \- zlib1g\-dev
      \- libbz2\-dev
      \- libreadline\-dev
      \- libsqlite3\-dev
      \- wget
      \- curl
      \- llvm
python\-2.6:
  pyenv.absent:
    \- require:
      \- pkg: pyenv\-deps

python\-2.7.6:
  pyenv.installed:
    \- default: True
    \- require:
      \- pkg: pyenv\-deps
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Git needs to be installed and available via PATH if pyenv is to be
installed automatically by the module.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pyenv.absent(name, user=None)
Verify that the specified python is not installed with pyenv. pyenv
is installed if necessary.
.INDENT 7.0
.TP
.B name
The version of python to uninstall
.TP
.B user: None
The user to run pyenv as.
.sp
New in version 0.17.0.

.UNINDENT
.sp
New in version 0.16.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pyenv.install_pyenv(name, user=None)
Install pyenv if not installed. Allows you to require pyenv be installed
prior to installing the plugins. Useful if you want to install pyenv
plugins via the git or file modules and need them installed before
installing any rubies.
.sp
Use the pyenv.root configuration option to set the path for pyenv if you
want a system wide install that is not in a user home dir.
.INDENT 7.0
.TP
.B user: None
The user to run pyenv as.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pyenv.installed(name, default=False, user=None)
Verify that the specified python is installed with pyenv. pyenv is
installed if necessary.
.INDENT 7.0
.TP
.B name
The version of python to install
.TP
.B default
False
Whether to make this python the default.
.TP
.B user: None
The user to run pyenv as.
.sp
New in version 0.17.0.

.UNINDENT
.sp
New in version 0.16.0.

.UNINDENT
.SS salt.states.pyrax_queues
.SS Manage Rackspace Queues
.sp
New in version 2015.5.0.

.sp
Create and destroy Rackspace queues. Be aware that this interacts with
Rackspace\(aqs services, and so may incur charges.
.sp
This module uses \fBpyrax\fP, which can be installed via package, or pip.
This module is greatly inspired by boto_* modules from SaltStack code source.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myqueue:
    pyrax_queues.present:
        \- provider: my\-pyrax

myqueue:
    pyrax_queues.absent:
        \- provider: my\-pyrax
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pyrax_queues.absent(name, provider)
Ensure the named Rackspace queue is deleted.
.INDENT 7.0
.TP
.B name
Name of the Rackspace queue.
.TP
.B provider
Salt Cloud provider
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.pyrax_queues.present(name, provider)
Ensure the RackSpace queue exists.
.INDENT 7.0
.TP
.B name
Name of the Rackspace queue.
.TP
.B provider
Salt Cloud Provider
.UNINDENT
.UNINDENT
.SS salt.states.quota
.SS Management of POSIX Quotas
.sp
The quota can be managed for the system:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/:
  quota.mode:
    mode: off
    quotatype: user
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.quota.mode(name, mode, quotatype)
Set the quota for the system
.INDENT 7.0
.TP
.B name
The filesystem to set the quota mode on
.TP
.B mode
Whether the quota system is on or off
.TP
.B quotatype
Must be \fBuser\fP or \fBgroup\fP
.UNINDENT
.UNINDENT
.SS salt.states.rabbitmq_cluster
.SS Manage RabbitMQ Clusters
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rabbit@rabbit.example.com:
  rabbitmq_cluster.join:
    \- user: rabbit
    \- host: rabbit.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rabbitmq_cluster.join(name, host, user=\(aqrabbit\(aq, ram_node=None, runas=\(aqroot\(aq)
This function is an alias of \fBjoined\fP\&.
.INDENT 7.0
.INDENT 3.5
Ensure the current node joined to a cluster with node \fI\%user@host\fP
.INDENT 0.0
.TP
.B name
Irrelevant, not used (recommended: \fI\%user@host\fP)
.TP
.B user
The user of node to join to (default: rabbit)
.TP
.B host
The host of node to join to
.TP
.B ram_node
Join node as a RAM node
.TP
.B runas
The user to run the rabbitmq command as
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rabbitmq_cluster.joined(name, host, user=\(aqrabbit\(aq, ram_node=None, runas=\(aqroot\(aq)
Ensure the current node joined to a cluster with node \fI\%user@host\fP
.INDENT 7.0
.TP
.B name
Irrelevant, not used (recommended: \fI\%user@host\fP)
.TP
.B user
The user of node to join to (default: rabbit)
.TP
.B host
The host of node to join to
.TP
.B ram_node
Join node as a RAM node
.TP
.B runas
The user to run the rabbitmq command as
.UNINDENT
.UNINDENT
.SS salt.states.rabbitmq_plugin
.SS Manage RabbitMQ Plugins
.sp
New in version 2014.1.0.

.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
some_plugin:
  rabbitmq_plugin.enabled: []
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rabbitmq_plugin.disabled(name, runas=None)
Ensure the RabbitMQ plugin is disabled.
.INDENT 7.0
.TP
.B name
The name of the plugin
.TP
.B runas
The user to run the rabbitmq\-plugin command as
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rabbitmq_plugin.enabled(name, runas=None)
Ensure the RabbitMQ plugin is enabled.
.INDENT 7.0
.TP
.B name
The name of the plugin
.TP
.B runas
The user to run the rabbitmq\-plugin command as
.UNINDENT
.UNINDENT
.SS salt.states.rabbitmq_policy
.SS Manage RabbitMQ Policies
.INDENT 0.0
.TP
.B maintainer
Benn Eichhorn <\fI\%benn@getlocalmeasure.com\fP>
.TP
.B maturity
new
.TP
.B platform
all
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rabbit_policy:
  rabbitmq_policy.present:
    \- name: HA
    \- pattern: \(aq.*\(aq
    \- definition: \(aq{\(dqha\-mode\(dq: \(dqall\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rabbitmq_policy.absent(name, vhost=\(aq/\(aq, runas=None)
Ensure the named policy is absent
.sp
Reference: \fI\%http://www.rabbitmq.com/ha.html\fP
.INDENT 7.0
.TP
.B name
The name of the policy to remove
.TP
.B runas
Name of the user to run the command as
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rabbitmq_policy.present(name, pattern, definition, priority=0, vhost=\(aq/\(aq, runas=None, apply_to=None)
Ensure the RabbitMQ policy exists.
.sp
Reference: \fI\%https://rabbitmq.com/parameters.html#policies\fP
.INDENT 7.0
.TP
.B name
Policy name
.TP
.B pattern
A regex of queues to apply the policy to
.TP
.B definition
A json dict describing the policy
.TP
.B priority
Priority (defaults to 0)
.TP
.B vhost
Virtual host to apply to (defaults to \(aq/\(aq)
.TP
.B runas
Name of the user to run the command as
.TP
.B apply_to
Apply policy to \(aqqueues\(aq, \(aqexchanges\(aq or \(aqall\(aq (default to \(aqall\(aq)
.UNINDENT
.UNINDENT
.SS salt.states.rabbitmq_upstream
.SS Manage RabbitMQ Upstreams
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rabbit_upstream:
  rabbitmq_upstream.present:
  \- name: upstream_1
  \- uri: amqp://my_user:my_password@rabbitmq_host
  \- trust_user_id: True
  \- ack_mode: on\-confirm
  \- max_hops: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.INDENT 0.0
.TP
.B salt.states.rabbitmq_upstream.absent(name, runas=None)
Ensure the named upstream is absent.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the upstream to remove
.IP \(bu 2
\fBrunas\fP (\fI\%str\fP) \-\- User to run the command
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rabbitmq_upstream.present(name, uri, prefetch_count=None, reconnect_delay=None, ack_mode=None, trust_user_id=None, exchange=None, max_hops=None, expires=None, message_ttl=None, ha_policy=None, queue=None, runas=None)
Ensure the RabbitMQ upstream exists.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the upstream connection
.IP \(bu 2
\fBuri\fP (\fI\%str\fP) \-\- The URI to connect to. If upstream is a cluster and can have
several URIs, you can enter them here separated by spaces.
Examples:
\- amqp://user:password@server_name
\- amqp://user:password@server_name/vhost
When connecting with SSL, several URI\-parameters need also be specified:
\- cacertfile = /path/to/cacert.pem
\- certfile = /path/to/cert.pem
\- keyfile = /part/to/key.pem
\- verity = verify_peer
\- fail_if_no_peer_cert = true | false
\- auth_mechanism = external
Example:
\- amqp://user:password@server_name?cacertfile=/path/to/cacert.pem&            certfile=/path/to/cert.pem&keyfile=/path/to/key.pem&verify=verify_peer
\- amqp://server\-name?cacertfile=/path/to/cacert.pem&certfile=/path/to/cert.pem&            keyfile=/path/to/key.pem&verify=verify_peer&fail_if_no_peer_cert=true&auth_mechanism=external
.IP \(bu 2
\fBprefetch_count\fP (\fI\%int\fP) \-\- Maximum number of unacknowledged messages that may
be in flight over a federation link at one time. Default: 1000
.IP \(bu 2
\fBreconnect_delay\fP (\fI\%int\fP) \-\- Time in seconds to wait after a network link
goes down before attempting reconnection. Default: 5
.IP \(bu 2
\fBack_mode\fP (\fI\%str\fP) \-\- The following values are allowed:
on\-confirm: Messages are acknowledged to the upstream broker after they
have been confirmed downstream. Handles network errors and broker failures
without losing messages. The slowest option, and the default.
on\-publish: Messages are acknowledged to the upstream broker after they
have been published downstream. Handles network errors without losing
messages, but may lose messages in the event of broker failures.
no\-ack: Message acknowledgements are not used. The fastest option, but
you may lose messages in the event of network or broker failures.
.IP \(bu 2
\fBtrust_user_id\fP (\fI\%bool\fP) \-\- Set \fBTrue\fP to preserve the \(dquser\-id\(dq field across
a federation link, even if the user\-id does not match that used to republish
the message. Set to \fBFalse\fP to clear the \(dquser\-id\(dq field when messages
are federated. Only set this to \fBTrue\fP if you trust the upstream broker
not to forge user\-ids.
.IP \(bu 2
\fBexchange\fP (\fI\%str\fP) \-\- The name of the upstream exchange. Default is to use the
same name as the federated exchange.
.IP \(bu 2
\fBmax_hops\fP (\fI\%int\fP) \-\- Maximum number of federation links that messages can
traverse before being dropped. Defaults to 1 if not set.
.IP \(bu 2
\fBexpires\fP (\fI\%int\fP) \-\- Time in milliseconds that the upstream should remember
about this node for. After this time all upstream state will be removed.
Set to \fBNone\fP (Default) to mean \(dqforever\(dq.
.IP \(bu 2
\fBmessage_ttl\fP (\fI\%int\fP) \-\- Time in milliseconds that undelivered messages should
be held upstream when there is a network outage or backlog.
Set to \fBNone\fP (default) to mean \(dqforever\(dq.
.IP \(bu 2
\fBha_policy\fP (\fI\%str\fP) \-\- Determines the \(dqx\-ha\-policy\(dq\-argument for the upstream
queue for a federated exchange. Default is \(dqnone\(dq meaning the queue is
not HA.
.IP \(bu 2
\fBqueue\fP (\fI\%str\fP) \-\- The name of the upstream queue. Default is to use the same
name as the federated queue.
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.UNINDENT
.SS salt.states.rabbitmq_user
.SS Manage RabbitMQ Users
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rabbit_user:
  rabbitmq_user.present:
    \- password: password
    \- force: True
    \- tags:
      \- monitoring
      \- user
    \- perms:
      \- \(aq/\(aq:
        \- \(aq.*\(aq
        \- \(aq.*\(aq
        \- \(aq.*\(aq
    \- runas: rabbitmq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rabbitmq_user.absent(name, runas=None)
Ensure the named user is absent
.INDENT 7.0
.TP
.B name
The name of the user to remove
.TP
.B runas
User to run the command
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rabbitmq_user.present(name, password=None, force=False, tags=None, perms=(), runas=None)
Ensure the RabbitMQ user exists.
.INDENT 7.0
.TP
.B name
User name
.TP
.B password
The user\(aqs password
.TP
.B force
If force is \fBTrue\fP, the password will be automatically updated without extra password change check.
.TP
.B tags
Optional list of tags for the user
.TP
.B perms
A list of dicts with vhost keys and 3\-tuple values
.TP
.B runas
Name of the user to run the command
.UNINDENT
.UNINDENT
.SS salt.states.rabbitmq_vhost
.SS Manage RabbitMQ Virtual Hosts
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
virtual_host:
  rabbitmq_vhost.present:
    \- user: rabbit_user
    \- conf: .*
    \- write: .*
    \- read: .*
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rabbitmq_vhost.absent(name)
Ensure the RabbitMQ Virtual Host is absent
.INDENT 7.0
.TP
.B name
Name of the Virtual Host to remove
.TP
.B runas
User to run the command
.sp
Deprecated since version 2015.8.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rabbitmq_vhost.present(name)
Ensure the RabbitMQ VHost exists.
.INDENT 7.0
.TP
.B name
VHost name
.TP
.B user
Initial user permission to set on the VHost, if present
.sp
Deprecated since version 2015.8.0.

.TP
.B owner
Initial owner permission to set on the VHost, if present
.sp
Deprecated since version 2015.8.0.

.TP
.B conf
Initial conf string to apply to the VHost and user. Defaults to .*
.sp
Deprecated since version 2015.8.0.

.TP
.B write
Initial write permissions to apply to the VHost and user.
Defaults to .*
.sp
Deprecated since version 2015.8.0.

.TP
.B read
Initial read permissions to apply to the VHost and user.
Defaults to .*
.sp
Deprecated since version 2015.8.0.

.TP
.B runas
Name of the user to run the command
.sp
Deprecated since version 2015.8.0.

.UNINDENT
.UNINDENT
.SS salt.states.rbac_solaris
.sp
Management of Solaris RBAC
.INDENT 0.0
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B depends
rbac_solaris,solaris_user
.TP
.B platform
solaris,illumos
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sjorge:
  rbac.managed:
    \- roles:
        \- netcfg
    \- profiles:
        \- System Power
    \- authorizations:
        \- solaris.audit.*
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rbac_solaris.managed(name, roles=None, profiles=None, authorizations=None)
Manage RBAC properties for user
.INDENT 7.0
.TP
.B name
string
username
.TP
.B roles
list
list of roles for user
.TP
.B profiles
list
list of profiles for user
.TP
.B authorizations
list
list of authorizations for user
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
All existing roles, profiles and authorizations will be replaced!
An empty list will remove everything.
.sp
Set the property to \fINone\fP to not manage it.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.rbenv
.SS Managing Ruby installations with rbenv
.sp
This module is used to install and manage ruby installations with rbenv and the
ruby\-build plugin. Different versions of ruby can be installed, and uninstalled.
Rbenv will be installed automatically the first time it is needed and can be
updated later. This module will \fInot\fP automatically install packages which rbenv
will need to compile the versions of ruby. If your version of ruby fails to
install, refer to the ruby\-build documentation to verify you are not missing any
dependencies: \fI\%https://github.com/rbenv/ruby\-build/wiki\fP
.sp
If rbenv is run as the root user then it will be installed to /usr/local/rbenv,
otherwise it will be installed to the users ~/.rbenv directory. To make
rbenv available in the shell you may need to add the rbenv/shims and rbenv/bin
directories to the users PATH. If you are installing as root and want other
users to be able to access rbenv then you will need to add RBENV_ROOT to
their environment.
.sp
The following state configuration demonstrates how to install Ruby 1.9.x
and 2.x using rbenv on Ubuntu/Debian:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rbenv\-deps:
  pkg.installed:
    \- names:
      \- bash
      \- git
      \- openssl
      \- libssl\-dev
      \- make
      \- curl
      \- autoconf
      \- bison
      \- build\-essential
      \- libffi\-dev
      \- libyaml\-dev
      \- libreadline6\-dev
      \- zlib1g\-dev
      \- libncurses5\-dev

ruby\-1.9.3\-p429:
  rbenv.absent:
    \- require:
      \- pkg: rbenv\-deps

ruby\-2.0.0\-p598:
  rbenv.installed:
    \- default: True
    \- require:
      \- pkg: rbenv\-deps
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rbenv.absent(name, user=None)
Verify that the specified ruby is not installed with rbenv. Rbenv
is installed if necessary.
.INDENT 7.0
.TP
.B name
The version of ruby to uninstall
.TP
.B user: None
The user to run rbenv as.
.sp
New in version 0.17.0.

.UNINDENT
.sp
New in version 0.16.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rbenv.install_rbenv(name, user=None)
Install rbenv if not installed. Allows you to require rbenv be installed
prior to installing the plugins. Useful if you want to install rbenv
plugins via the git or file modules and need them installed before
installing any rubies.
.sp
Use the rbenv.root configuration option to set the path for rbenv if you
want a system wide install that is not in a user home dir.
.INDENT 7.0
.TP
.B user: None
The user to run rbenv as.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rbenv.installed(name, default=False, user=None)
Verify that the specified ruby is installed with rbenv. Rbenv is
installed if necessary.
.INDENT 7.0
.TP
.B name
The version of ruby to install
.TP
.B default
False
Whether to make this ruby the default.
.TP
.B user: None
The user to run rbenv as.
.sp
New in version 0.17.0.

.UNINDENT
.sp
New in version 0.16.0.

.UNINDENT
.SS salt.states.rdp
.sp
Manage RDP Service on Windows servers
.INDENT 0.0
.TP
.B salt.states.rdp.disabled(name)
Disable the RDP service
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rdp.enabled(name)
Enable the RDP service and make sure access to the RDP
port is allowed in the firewall configuration
.UNINDENT
.SS salt.states.redismod
.SS Management of Redis server
.sp
New in version 2014.7.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
redis Python module
.UNINDENT
.TP
.B configuration
See \fBsalt.modules.redis\fP for setup instructions.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
key_in_redis:
  redis.string:
    \- value: string data
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The redis server information specified in the minion config file can be
overridden in states using the following arguments: \fBhost\fP, \fBpost\fP, \fBdb\fP,
\fBpassword\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
key_in_redis:
  redis.string:
    \- value: string data
    \- host: localhost
    \- port: 6379
    \- db: 0
    \- password: somuchkittycat
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.redismod.absent(name, keys=None, **connection_args)
Ensure key absent from redis
.INDENT 7.0
.TP
.B name
Key to ensure absent from redis
.TP
.B keys
list of keys to ensure absent, name will be ignored if this is used
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.redismod.slaveof(name, sentinel_host=None, sentinel_port=None, sentinel_password=None, **connection_args)
Set this redis instance as a slave.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B name
Master to make this a slave of
.TP
.B sentinel_host
Ip of the sentinel to check for the master
.TP
.B sentinel_port
Port of the sentinel to check for the master
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.redismod.string(name, value, expire=None, expireat=None, **connection_args)
Ensure that the key exists in redis with the value specified
.INDENT 7.0
.TP
.B name
Redis key to manage
.TP
.B value
Data to persist in key
.TP
.B expire
Sets time to live for key in seconds
.TP
.B expireat
Sets expiration time for key via UNIX timestamp, overrides \fIexpire\fP
.UNINDENT
.UNINDENT
.SS salt.states.reg
.SS Manage the Windows registry
.sp
Many python developers think of registry keys as if they were python keys in a
dictionary which is not the case. The windows registry is broken down into the
following components:
.SS Hives
.sp
This is the top level of the registry. They all begin with HKEY.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
HKEY_CLASSES_ROOT (HKCR)
.IP \(bu 2
HKEY_CURRENT_USER (HKCU)
.IP \(bu 2
HKEY_LOCAL MACHINE (HKLM)
.IP \(bu 2
HKEY_USER (HKU)
.IP \(bu 2
HKEY_CURRENT_CONFIG
.UNINDENT
.UNINDENT
.UNINDENT
.SS Keys
.sp
Hives contain keys. These are basically the folders beneath the hives. They can
contain any number of subkeys.
.sp
When passing the hivekey values they must be quoted correctly depending on the
backslashes being used (\fB\e\fP vs \fB\e\e\fP). The way backslashes are handled in
the state file is different from the way they are handled when working on the
CLI. The following are valid methods of passing the hivekey:
.INDENT 0.0
.TP
.B Using single backslashes:
HKLMSOFTWAREPython
\(aqHKLMSOFTWAREPython\(aq
.TP
.B Using double backslashes:
\(dqHKLM\eSOFTWARE\ePython\(dq
.UNINDENT
.SS Values or Entries
.sp
Values or Entries are the name/data pairs beneath the keys and subkeys. All keys
have a default name/data pair. The name is \fB(Default)\fP with a displayed value
of \fB(value not set)\fP\&. The actual value is Null.
.sp
Example
.sp
The following example is taken from the windows startup portion of the registry:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[HKEY_LOCAL_MACHINE\eSOFTWARE\eMicrosoft\eWindows\eCurrentVersion\eRun]
\(dqRTHDVCPL\(dq=\(dq\e\(dqC:\e\eProgram Files\e\eRealtek\e\eAudio\e\eHDA\e\eRtkNGUI64.exe\e\(dq \-s\(dq
\(dqNvBackend\(dq=\(dq\e\(dqC:\e\eProgram Files (x86)\e\eNVIDIA Corporation\e\eUpdate Core\e\eNvBackend.exe\e\(dq\(dq
\(dqBTMTrayAgent\(dq=\(dqrundll32.exe \e\(dqC:\e\eProgram Files (x86)\e\eIntel\e\eBluetooth\e\ebtmshellex.dll\e\(dq,TrayApp\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example these are the values for each:
.INDENT 0.0
.TP
.B Hive:
\fBHKEY_LOCAL_MACHINE\fP
.TP
.B Key and subkeys:
\fBSOFTWARE\e\eMicrosoft\e\eWindows\e\eCurrentVersion\e\eRun\fP
.UNINDENT
.sp
Value:
.INDENT 0.0
.IP \(bu 2
There are 3 value names: \fBRTHDVCPL\fP, \fBNvBackend\fP, and \fBBTMTrayAgent\fP
.IP \(bu 2
Each value name has a corresponding value
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.reg.absent(name, vname=None, use_32bit_registry=False)
Ensure a registry value is removed. To remove a key use key_absent.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\-
.sp
A string value representing the full path of the key to include the
HIVE, Key, and all Subkeys. For example:
.sp
\fBHKEY_LOCAL_MACHINE\eSOFTWARE\eSalt\fP
.sp
Valid hive values include:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
HKEY_CURRENT_USER or HKCU
.IP \(bu 2
HKEY_LOCAL_MACHINE or HKLM
.IP \(bu 2
HKEY_USERS or HKU
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBvname\fP (\fI\%str\fP) \-\- The name of the value you\(aqd like to create beneath the Key. If this
parameter is not passed it will assume you want to set the
\fB(Default)\fP value
.IP \(bu 2
\fBuse_32bit_registry\fP (\fI\%bool\fP) \-\- Use the 32bit portion of the registry. Applies only to 64bit
windows. 32bit Windows will ignore this parameter. Default is False.
.UNINDENT
.TP
.B Returns
A dictionary showing the results of the registry operation.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(aqHKEY_CURRENT_USER\eSOFTWARE\eSalt\(aq:
  reg.absent
    \- vname: version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above example the value named \fBversion\fP will be removed from
the SOFTWARE\eSalt key in the HKEY_CURRENT_USER hive. If \fBvname\fP was
not passed, the \fB(Default)\fP value would be deleted.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.reg.key_absent(name, use_32bit_registry=False)
New in version 2015.5.4.

.sp
Ensure a registry key is removed. This will remove the key, subkeys, and all
value entries.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\-
.sp
A string representing the full path to the key to be removed to
include the hive and the keypath. The hive can be any of the
following:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
HKEY_LOCAL_MACHINE or HKLM
.IP \(bu 2
HKEY_CURRENT_USER or HKCU
.IP \(bu 2
HKEY_USER or HKU
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBuse_32bit_registry\fP (\fI\%bool\fP) \-\- Use the 32bit portion of the registry. Applies only to 64bit
windows. 32bit Windows will ignore this parameter. Default is False.
.UNINDENT
.TP
.B Returns
A dictionary showing the results of the registry operation.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
The following example will delete the \fBSOFTWARE\eDeleteMe\fP key in the
\fBHKEY_LOCAL_MACHINE\fP hive including all its subkeys and value pairs.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
remove_key_demo:
  reg.key_absent:
    \- name: HKEY_CURRENT_USER\eSOFTWARE\eDeleteMe
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above example the path is interpreted as follows:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBHKEY_CURRENT_USER\fP is the hive
.IP \(bu 2
\fBSOFTWARE\eDeleteMe\fP is the key
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.reg.present(name, vname=None, vdata=None, vtype=\(aqREG_SZ\(aq, use_32bit_registry=False, win_owner=None, win_perms=None, win_deny_perms=None, win_inheritance=True, win_perms_reset=False)
Ensure a registry key or value is present.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\-
.sp
A string value representing the full path of the key to include the
HIVE, Key, and all Subkeys. For example:
.sp
\fBHKEY_LOCAL_MACHINE\eSOFTWARE\eSalt\fP
.sp
Valid hive values include:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
HKEY_CURRENT_USER or HKCU
.IP \(bu 2
HKEY_LOCAL_MACHINE or HKLM
.IP \(bu 2
HKEY_USERS or HKU
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBvname\fP (\fI\%str\fP) \-\- The name of the value you\(aqd like to create beneath the Key. If this
parameter is not passed it will assume you want to set the
\fB(Default)\fP value
.IP \(bu 2
\fBvdata\fP (\fI\%str\fP\fI, \fP\fI\%int\fP\fI, \fP\fI\%list\fP\fI, \fP\fI\%bytes\fP) \-\-
.sp
The value you\(aqd like to set. If a value name (\fBvname\fP) is passed,
this will be the data for that value name. If not, this will be the
\fB(Default)\fP value for the key.
.sp
The type of data this parameter expects is determined by the value
type specified in \fBvtype\fP\&. The correspondence is as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
REG_BINARY: Binary data (str in Py2, bytes in Py3)
.IP \(bu 2
REG_DWORD: int
.IP \(bu 2
REG_EXPAND_SZ: str
.IP \(bu 2
REG_MULTI_SZ: list of str
.IP \(bu 2
REG_QWORD: int
.IP \(bu 2
REG_SZ: str
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When setting REG_BINARY, string data will be converted to
binary automatically. To pass binary data, use the built\-in
yaml tag \fB!!binary\fP to denote the actual binary
characters. For example, the following lines will both set
the same data in the registry:
.INDENT 0.0
.IP \(bu 2
\fBvdata: Salty Test\fP
.IP \(bu 2
\fBvdata: !!binary U2FsdHkgVGVzdA==\en\fP
.UNINDENT
.sp
For more information about the \fB!!binary\fP tag see
\fI\%here\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The type for the \fB(Default)\fP value is always REG_SZ and cannot
be changed. This parameter is optional. If not passed, the Key
will be created with no associated item/value pairs.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBvtype\fP (\fI\%str\fP) \-\-
.sp
The value type for the data you wish to store in the registry. Valid
values are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
REG_BINARY
.IP \(bu 2
REG_DWORD
.IP \(bu 2
REG_EXPAND_SZ
.IP \(bu 2
REG_MULTI_SZ
.IP \(bu 2
REG_QWORD
.IP \(bu 2
REG_SZ (Default)
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBuse_32bit_registry\fP (\fI\%bool\fP) \-\- Use the 32bit portion of the registry. Applies only to 64bit
windows. 32bit Windows will ignore this parameter. Default is False.
.IP \(bu 2
\fBwin_owner\fP (\fI\%str\fP) \-\-
.sp
The owner of the registry key. If this is not passed, the account
under which Salt is running will be used.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
Owner is set for the key that contains the value/data pair. You
cannot set ownership on value/data pairs themselves.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBwin_perms\fP (\fI\%dict\fP) \-\-
.sp
A dictionary containing permissions to grant and their propagation.
If not passed the \(aqGrant\(ga permissions will not be modified.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
Permissions are set for the key that contains the value/data
pair. You cannot set permissions on value/data pairs themselves.
.UNINDENT
.UNINDENT
.sp
For each user specify the account name, with a sub dict for the
permissions to grant and the \(aqApplies to\(aq setting. For example:
\fB{\(aqAdministrators\(aq: {\(aqperms\(aq: \(aqfull_control\(aq, \(aqapplies_to\(aq:
\(aqthis_key_subkeys\(aq}}\fP\&. \fBperms\fP must be specified.
.sp
Registry permissions are specified using the \fBperms\fP key. You can
specify a single basic permission or a list of advanced perms. The
following are valid perms:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B Basic (passed as a string):
.INDENT 7.0
.IP \(bu 2
full_control
.IP \(bu 2
read
.IP \(bu 2
write
.UNINDENT
.TP
.B Advanced (passed as a list):
.INDENT 7.0
.IP \(bu 2
delete
.IP \(bu 2
query_value
.IP \(bu 2
set_value
.IP \(bu 2
create_subkey
.IP \(bu 2
enum_subkeys
.IP \(bu 2
notify
.IP \(bu 2
create_link
.IP \(bu 2
read_control
.IP \(bu 2
write_dac
.IP \(bu 2
write_owner
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The \(aqApplies to\(aq setting is optional. It is specified using the
\fBapplies_to\fP key. If not specified \fBthis_key_subkeys\fP is used.
Valid options are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B Applies to settings:
.INDENT 7.0
.IP \(bu 2
this_key_only
.IP \(bu 2
this_key_subkeys
.IP \(bu 2
subkeys_only
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBwin_deny_perms\fP (\fI\%dict\fP) \-\-
.sp
A dictionary containing permissions to deny and their propagation.
If not passed the \fIDeny\fP permissions will not be modified.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
Permissions are set for the key that contains the value/data
pair. You cannot set permissions on value/data pairs themselves.
.UNINDENT
.UNINDENT
.sp
Valid options are the same as those specified in \fBwin_perms\fP
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \(aqDeny\(aq permissions always take precedence over \(aqgrant\(aq
permissions.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBwin_inheritance\fP (\fI\%bool\fP) \-\-
.sp
\fBTrue\fP to inherit permissions from the parent key. \fBFalse\fP to
disable inheritance. Default is \fBTrue\fP\&.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
Inheritance is set for the key that contains the value/data
pair. You cannot set inheritance on value/data pairs themselves.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBwin_perms_reset\fP (\fI\%bool\fP) \-\-
.sp
If \fBTrue\fP the existing DACL will be cleared and replaced with the
settings defined in this function. If \fBFalse\fP, new entries will be
appended to the existing DACL. Default is \fBFalse\fP
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
Perms are reset for the key that contains the value/data pair.
You cannot set permissions on value/data pairs themselves.
.UNINDENT
.UNINDENT
.sp
New in version 2019.2.0.


.UNINDENT
.TP
.B Returns
A dictionary showing the results of the registry operation.
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
Example:
.sp
The following example will set the \fB(Default)\fP value for the
\fBSOFTWARE\eSalt\fP key in the \fBHKEY_CURRENT_USER\fP hive to
\fB2016.3.1\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HKEY_CURRENT_USER\eSOFTWARE\eSalt:
  reg.present:
    \- vdata: 2016.3.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example:
.sp
The following example will set the value for the \fBversion\fP entry under
the \fBSOFTWARE\eSalt\fP key in the \fBHKEY_CURRENT_USER\fP hive to
\fB2016.3.1\fP\&. The value will be reflected in \fBWow6432Node\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HKEY_CURRENT_USER\eSOFTWARE\eSalt:
  reg.present:
    \- vname: version
    \- vdata: 2016.3.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above example the path is interpreted as follows:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBHKEY_CURRENT_USER\fP is the hive
.IP \(bu 2
\fBSOFTWARE\eSalt\fP is the key
.IP \(bu 2
\fBvname\fP is the value name (\(aqversion\(aq) that will be created under the key
.IP \(bu 2
\fBvdata\fP is the data that will be assigned to \(aqversion\(aq
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Example:
.sp
Binary data can be set in two ways. The following two examples will set
a binary value of \fBSalty Test\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
no_conversion:
  reg.present:
    \- name: HKLM\eSOFTWARE\eSaltTesting
    \- vname: test_reg_binary_state
    \- vdata: Salty Test
    \- vtype: REG_BINARY

conversion:
  reg.present:
    \- name: HKLM\eSOFTWARE\eSaltTesting
    \- vname: test_reg_binary_state_with_tag
    \- vdata: !!binary U2FsdHkgVGVzdA==\en
    \- vtype: REG_BINARY
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example:
.sp
To set a \fBREG_MULTI_SZ\fP value:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
reg_multi_sz:
  reg.present:
    \- name: HKLM\eSOFTWARE\eSalt
    \- vname: reg_multi_sz
    \- vdata:
      \- list item 1
      \- list item 2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example:
.sp
To ensure a key is present and has permissions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
set_key_permissions:
  reg.present:
    \- name: HKLM\eSOFTWARE\eSalt
    \- vname: version
    \- vdata: 2016.3.1
    \- win_owner: Administrators
    \- win_perms:
        jsnuffy:
          perms: full_control
        sjones:
          perms:
            \- read_control
            \- enum_subkeys
            \- query_value
          applies_to:
            \- this_key_only
    \- win_deny_perms:
        bsimpson:
          perms: full_control
          applies_to: this_key_subkeys
    \- win_inheritance: True
    \- win_perms_reset: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.restconf
.sp
RESTCONF
State module for  Proxy minions
.INDENT 0.0
.TP
.B codeauthor
Jamie (Bear) Murphy <\fI\%jamiemurphyit@gmail.com\fP>
.TP
.B maturity
new
.TP
.B platform
any
.UNINDENT
.SS About
.sp
This state module was designed to manage RESTCONF states.
This module relies on the RESTCONF proxy module to interface with the devices.
.INDENT 0.0
.TP
.B salt.states.restconf.config_manage(name, path, method, config, init_path=None, init_method=\(aqPATCH\(aq, init_config=None)
Ensure a specific value exists at a given path
.INDENT 7.0
.TP
.B name:
(str) The name for this rule
.TP
.B path:
(str) The RESTCONF path to set / get config
.TP
.B method:
(str) rest method to use eg GET, PUT, POST, PATCH, DELETE
.TP
.B config:
(dict) The new value at the given path
.TP
.B init_path: (optional)
(str) Alternative path incase the path doesnt exist on first pass
.TP
.B init_method: (optional)
(str) Method to use on alternative path when setting config, default: PATCH
.TP
.B init_config: (optional)
(dict) The new value at the given init path.
This is only needed if you need to supply a different style of data to an init path.
.UNINDENT
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
do_configure_restconf_endpoint:
  restconf.config_manage:
    \- name: random_name_here
    \- path: restconf/data/Cisco\-IOS\-XE\-native:native/interface/GigabitEthernet=1%2F0%2F3
    \- config:
        Cisco\-IOS\-XE\-native:GigabitEthernet:
          description: interfaceDescription
          name: \(dq1/0/3\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.rsync
.sp
State to synchronize files and directories with rsync.
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/opt/user\-backups:
  rsync.synchronized:
    \- source: /home
    \- force: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rsync.synchronized(name, source, delete=False, force=False, update=False, passwordfile=None, exclude=None, excludefrom=None, prepare=False, dryrun=False, additional_opts=None)
Guarantees that the source directory is always copied to the target.
.INDENT 7.0
.TP
.B name
Name of the target directory.
.TP
.B source
Source directory.
.TP
.B prepare
Create destination directory if it does not exists.
.TP
.B delete
Delete extraneous files from the destination dirs (True or False)
.TP
.B force
Force deletion of dirs even if not empty
.TP
.B update
Skip files that are newer on the receiver (True or False)
.TP
.B passwordfile
Read daemon\-access password from the file (path)
.TP
.B exclude
Exclude files, that matches pattern.
.TP
.B excludefrom
Read exclude patterns from the file (path)
.TP
.B dryrun
Perform a trial run with no changes made. Is the same as
doing test=True
.sp
New in version 2016.3.1.

.TP
.B additional_opts
Pass additional options to rsync, should be included as a list.
.sp
New in version 2018.3.0.

.UNINDENT
.UNINDENT
.SS salt.states.rvm
.SS Managing Ruby installations and gemsets with Ruby Version Manager (RVM)
.sp
This module is used to install and manage ruby installations and
gemsets with RVM, the Ruby Version Manager. Different versions of ruby
can be installed and gemsets created. RVM itself will be installed
automatically if it\(aqs not present. This module will not automatically
install packages that RVM depends on or ones that are needed to build
ruby. If you want to run RVM as an unprivileged user (recommended) you
will have to create this user yourself. This is how a state
configuration could look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rvm:
  group.present: []
  user.present:
    \- gid: rvm
    \- home: /home/rvm
    \- require:
      \- group: rvm

rvm\-deps:
  pkg.installed:
    \- pkgs:
      \- bash
      \- coreutils
      \- gzip
      \- bzip2
      \- gawk
      \- sed
      \- curl
      \- git\-core
      \- subversion

mri\-deps:
  pkg.installed:
    \- pkgs:
      \- build\-essential
      \- openssl
      \- libreadline6
      \- libreadline6\-dev
      \- curl
      \- git\-core
      \- zlib1g
      \- zlib1g\-dev
      \- libssl\-dev
      \- libyaml\-dev
      \- libsqlite3\-0
      \- libsqlite3\-dev
      \- sqlite3
      \- libxml2\-dev
      \- libxslt1\-dev
      \- autoconf
      \- libc6\-dev
      \- libncurses5\-dev
      \- automake
      \- libtool
      \- bison
      \- subversion
      \- ruby

jruby\-deps:
  pkg.installed:
    \- pkgs:
      \- curl
      \- g++
      \- openjdk\-6\-jre\-headless

ruby\-1.9.2:
  rvm.installed:
    \- default: True
    \- user: rvm
    \- require:
      \- pkg: rvm\-deps
      \- pkg: mri\-deps
      \- user: rvm

jruby:
  rvm.installed:
    \- user: rvm
    \- require:
      \- pkg: rvm\-deps
      \- pkg: jruby\-deps
      \- user: rvm

jgemset:
  rvm.gemset_present:
    \- ruby: jruby
    \- user: rvm
    \- require:
      \- rvm: jruby

mygemset:
  rvm.gemset_present:
    \- ruby: ruby\-1.9.2
    \- user: rvm
    \- require:
      \- rvm: ruby\-1.9.2
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rvm.gemset_present(name, ruby=\(aqdefault\(aq, user=None)
Verify that the gemset is present.
.INDENT 7.0
.TP
.B name
The name of the gemset.
.TP
.B ruby: default
The ruby version this gemset belongs to.
.TP
.B user: None
The user to run rvm as.
.sp
New in version 0.17.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.rvm.installed(name, default=False, user=None, opts=None, env=None)
Verify that the specified ruby is installed with RVM. RVM is
installed when necessary.
.INDENT 7.0
.TP
.B name
The version of ruby to install
.TP
.B default
False
Whether to make this ruby the default.
.TP
.B user: None
The user to run rvm as.
.TP
.B env: None
A list of environment variables to set (ie, RUBY_CONFIGURE_OPTS)
.TP
.B opts: None
A list of option flags to pass to RVM (ie \-C, \-\-patch)
.sp
New in version 0.17.0.

.UNINDENT
.UNINDENT
.SS salt.states.salt_proxy
.sp
Salt proxy state
.sp
New in version 2015.8.2.

.sp
State to deploy and run salt\-proxy processes
on a minion.
.sp
Set up pillar data for your proxies per the documentation.
.sp
Run the state as below
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy\-configure:
    salt_proxy.configure_proxy:
        \- proxyname: p8000
        \- start: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This state will configure the salt proxy settings
within /etc/salt/proxy (if /etc/salt/proxy doesn\(aqt exists)
and start the salt\-proxy process (default true),
if it isn\(aqt already running.
.INDENT 0.0
.TP
.B salt.states.salt_proxy.configure_proxy(name, proxyname=\(aqp8000\(aq, start=True)
Create the salt proxy file and start the proxy process
if required
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- The name of this state
.IP \(bu 2
\fBproxyname\fP \-\- Name to be used for this proxy (should match entries in pillar)
.IP \(bu 2
\fBstart\fP \-\- Boolean indicating if the process should be started
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-proxy\-configure:
    salt_proxy.configure_proxy:
        \- proxyname: p8000
        \- start: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.saltmod
.SS Control the Salt command interface
.sp
This state is intended for use from the Salt Master. It provides access to
sending commands down to minions as well as access to executing master\-side
modules. These state functions wrap Salt\(aqs \fI\%Python API\fP\&.
.INDENT 0.0
.INDENT 3.5
New in version 2016.11.0.

.sp
Support for masterless minions was added to the \fBsalt.state\fP function,
so they can run orchestration sls files. This is particularly useful when
the rendering of a state is dependent on the execution of another state.
Orchestration will render and execute each orchestration block
independently, while honoring requisites to ensure the states are applied
in the correct order.
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
More Orchestrate documentation
.INDENT 0.0
.IP \(bu 2
\fI\%Full Orchestrate Tutorial\fP
.IP \(bu 2
\fI\%The Orchestrate runner\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltmod.function(name, tgt, ssh=False, tgt_type=\(aqglob\(aq, ret=\(aq\(aq, ret_config=None, ret_kwargs=None, expect_minions=False, fail_minions=None, fail_function=None, arg=None, kwarg=None, timeout=None, batch=None, subset=None, failhard=None, **kwargs)
Execute a single module function on a remote minion via salt or salt\-ssh
.INDENT 7.0
.TP
.B name
The name of the function to run, aka cmd.run or pkg.install
.TP
.B tgt
The target specification, aka \(aq*\(aq for all minions
.TP
.B tgt_type
The target type, defaults to \fBglob\fP
.TP
.B arg
The list of arguments to pass into the function
.TP
.B kwarg
The dict (not a list) of keyword arguments to pass into the function
.TP
.B ret
Optionally set a single or a list of returners to use
.TP
.B ret_config
Use an alternative returner configuration
.TP
.B ret_kwargs
Override individual returner configuration items
.TP
.B expect_minions
An optional boolean for failing if some minions do not respond
.TP
.B fail_minions
An optional list of targeted minions where failure is an option
.TP
.B fail_function
An optional string that points to a salt module that returns True or False
based on the returned data dict for individual minions
.TP
.B ssh
Set to \fITrue\fP to use the ssh client instead of the standard salt client
.TP
.B roster
In the event of using salt\-ssh, a roster system can be set
.sp
New in version 3005.

.TP
.B batch
Execute the command \fI\%in batches\fP\&. E.g.: \fB10%\fP\&.
.TP
.B subset
Number of minions from the targeted set to randomly use
.sp
New in version 2017.7.0.

.TP
.B failhard
pass failhard down to the executing state
.sp
New in version 2019.2.2.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltmod.parallel_runners(name, runners, **kwargs)
Executes multiple runner modules on the master in parallel.
.sp
New in version 2018.3.0.

.sp
A separate thread is spawned for each runner. This state is intended to be
used with the orchestrate runner in place of the \fBsaltmod.runner\fP state
when different tasks should be run in parallel. In general, Salt states are
not safe when used concurrently, so ensure that they are used in a safe way
(e.g. by only targeting separate minions in parallel tasks).
.INDENT 7.0
.TP
.B name:
name identifying this state. The name is provided as part of the
output, but not used for anything else.
.TP
.B runners:
list of runners that should be run in parallel. Each element of the
list has to be a dictionary. This dictionary\(aqs name entry stores the
name of the runner function that shall be invoked. The optional kwarg
entry stores a dictionary of named arguments that are passed to the
runner function.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parallel\-state:
   salt.parallel_runners:
     \- runners:
         my_runner_1:
           \- name: state.orchestrate
           \- kwarg:
               mods: orchestrate_state_1
         my_runner_2:
           \- name: state.orchestrate
           \- kwarg:
               mods: orchestrate_state_2
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltmod.runner(name, **kwargs)
Execute a runner module on the master
.sp
New in version 2014.7.0.

.INDENT 7.0
.TP
.B name
The name of the function to run
.TP
.B kwargs
Any keyword arguments to pass to the runner function
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
run\-manage\-up:
 salt.runner:
   \- name: manage.up
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltmod.state(name, tgt, ssh=False, tgt_type=\(aqglob\(aq, ret=\(aq\(aq, ret_config=None, ret_kwargs=None, highstate=None, sls=None, top=None, saltenv=None, test=None, pillar=None, pillarenv=None, expect_minions=True, exclude=None, fail_minions=None, allow_fail=0, concurrent=False, timeout=None, batch=None, queue=False, subset=None, orchestration_jid=None, failhard=None, **kwargs)
Invoke a state run on a given target
.INDENT 7.0
.TP
.B name
An arbitrary name used to track the state execution
.TP
.B tgt
The target specification for the state run.
.sp
New in version 2016.11.0.

.sp
Masterless support: When running on a masterless minion, the \fBtgt\fP
is ignored and will always be the local minion.
.TP
.B tgt_type
The target type to resolve, defaults to \fBglob\fP
.TP
.B ret
Optionally set a single or a list of returners to use
.TP
.B ret_config
Use an alternative returner configuration
.TP
.B ret_kwargs
Override individual returner configuration items
.TP
.B highstate
Defaults to None, if set to True the target systems will ignore any
sls references specified in the sls option and call state.highstate
on the targeted minions
.TP
.B top
Should be the name of a top file. If set state.top is called with this
top file instead of state.sls.
.TP
.B sls
A group of sls files to execute. This can be defined as a single string
containing a single sls file, or a list of sls files
.TP
.B test
Pass \fBtest=true\fP or \fBtest=false\fP through to the state function. This
can be used to override a test mode set in the minion\(aqs config file. If
left as the default of None and the \(aqtest\(aq mode is supplied on the
command line, that value is passed instead.
.TP
.B pillar
Pass the \fBpillar\fP kwarg through to the state function
.TP
.B pillarenv
The pillar environment to grab pillars from
.sp
New in version 2017.7.0.

.TP
.B saltenv
The default salt environment to pull sls files from
.TP
.B ssh
Set to \fITrue\fP to use the ssh client instead of the standard salt client
.TP
.B roster
In the event of using salt\-ssh, a roster system can be set
.TP
.B expect_minions
An optional boolean for failing if some minions do not respond
.TP
.B fail_minions
An optional list of targeted minions where failure is an option
.TP
.B allow_fail
Pass in the number of minions to allow for failure before setting
the result of the execution to False
.TP
.B exclude
Pass exclude kwarg to state
.TP
.B concurrent
Allow multiple state runs to occur at once.
.sp
WARNING: This flag is potentially dangerous. It is designed
for use when multiple state runs can safely be run at the same
Do not use this flag for performance optimization.
.TP
.B queue
Pass \fBqueue=true\fP through to the state function
.TP
.B batch
Execute the command \fI\%in batches\fP\&. E.g.: \fB10%\fP\&.
.sp
New in version 2016.3.0.

.TP
.B subset
Number of minions from the targeted set to randomly use
.sp
New in version 2017.7.0.

.TP
.B failhard
pass failhard down to the executing state
.sp
New in version 2019.2.2.

.UNINDENT
.sp
Examples:
.sp
Run a list of sls files via \fBstate.sls\fP on target
minions:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
webservers:
  salt.state:
    \- tgt: \(aqweb*\(aq
    \- sls:
      \- apache
      \- django
      \- core
    \- saltenv: prod
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Run sls file via \fBstate.sls\fP on target
minions with exclude:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
docker:
  salt.state:
    \- tgt: \(aqdocker*\(aq
    \- sls: docker
    \- exclude: docker.swarm
    \- saltenv: prod
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Run a full \fBstate.highstate\fP on target
mininons.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
databases:
  salt.state:
    \- tgt: role:database
    \- tgt_type: grain
    \- highstate: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltmod.wait_for_event(name, id_list, event_id=\(aqid\(aq, timeout=300, node=\(aqmaster\(aq)
Watch Salt\(aqs event bus and block until a condition is met
.sp
New in version 2014.7.0.

.INDENT 7.0
.TP
.B name
An event tag to watch for; supports Reactor\-style globbing.
.TP
.B id_list
A list of event identifiers to watch for \-\- usually the minion ID. Each
time an event tag is matched the event data is inspected for
\fBevent_id\fP, if found it is removed from \fBid_list\fP\&. When \fBid_list\fP
is empty this function returns success.
.TP
.B event_id
id
The name of a key in the event data. Default is \fBid\fP for the minion
ID, another common value is \fBname\fP for use with orchestrating
salt\-cloud events.
.TP
.B timeout
300
The maximum time in seconds to wait before failing.
.UNINDENT
.sp
The following example blocks until all the listed minions complete a
restart and reconnect to the Salt master:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
reboot_all_minions:
  salt.function:
    \- name: system.reboot
    \- tgt: \(aq*\(aq

wait_for_reboots:
  salt.wait_for_event:
    \- name: salt/minion/*/start
    \- id_list:
      \- jerry
      \- stuart
      \- dave
      \- phil
      \- kevin
      \- mike
    \- require:
      \- salt: reboot_all_minions
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltmod.wheel(name, **kwargs)
Execute a wheel module on the master
.sp
New in version 2014.7.0.

.INDENT 7.0
.TP
.B name
The name of the function to run
.TP
.B kwargs
Any keyword arguments to pass to the wheel function
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
accept_minion_key:
  salt.wheel:
    \- name: key.accept
    \- match: frank
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.saltutil
.SS Saltutil State
.sp
This state wraps the saltutil execution modules to make them easier to run
from a states. Rather than needing to to use \fBmodule.run\fP this state allows for
improved change detection.
.INDENT 0.0
.INDENT 3.5
New in version 3000.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_all(name, **kwargs)
Performs the same task as saltutil.sync_all module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_all:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_beacons(name, **kwargs)
Performs the same task as saltutil.sync_beacons module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_beacons:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_clouds(name, **kwargs)
Performs the same task as saltutil.sync_clouds module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_clouds:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_engines(name, **kwargs)
Performs the same task as saltutil.sync_engines module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_engines:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_executors(name, **kwargs)
Performs the same task as saltutil.sync_executors module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_executors:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_grains(name, **kwargs)
Performs the same task as saltutil.sync_grains module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_grains:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_log_handlers(name, **kwargs)
Performs the same task as saltutil.sync_log_handlers module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_log_handlers:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_matchers(name, **kwargs)
Performs the same task as saltutil.sync_matchers module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_matchers:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_modules(name, **kwargs)
Performs the same task as saltutil.sync_modules module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_modules:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_output(name, **kwargs)
Performs the same task as saltutil.sync_output module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_output:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_outputters(name, **kwargs)
Performs the same task as saltutil.sync_outputters module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_outputters:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_pillar(name, **kwargs)
Performs the same task as saltutil.sync_pillar module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_pillar:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_proxymodules(name, **kwargs)
Performs the same task as saltutil.sync_proxymodules module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_proxymodules:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_renderers(name, **kwargs)
Performs the same task as saltutil.sync_renderers module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_renderers:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_returners(name, **kwargs)
Performs the same task as saltutil.sync_returners module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_returners:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_sdb(name, **kwargs)
Performs the same task as saltutil.sync_sdb module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_sdb:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_serializers(name, **kwargs)
Performs the same task as saltutil.sync_serializers module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_serializers:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_states(name, **kwargs)
Performs the same task as saltutil.sync_states module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_states:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_thorium(name, **kwargs)
Performs the same task as saltutil.sync_thorium module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_thorium:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_tops(name, **kwargs)
Performs the same task as saltutil.sync_tops module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_tops:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_utils(name, **kwargs)
Performs the same task as saltutil.sync_utils module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_utils:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.saltutil.sync_wrapper(name, **kwargs)
New in version 3007.0.

.sp
Performs the same task as saltutil.sync_wrapper module
See \fI\%saltutil module for full list of options\fP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
sync_everything:
  saltutil.sync_wrapper:
    \- refresh: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.schedule
.SS Management of the Salt scheduler
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job3:
  schedule.present:
    \- function: test.ping
    \- seconds: 3600
    \- splay: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will schedule the command: test.ping every 3600 seconds
(every hour) splaying the time between 0 and 10 seconds
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job2:
  schedule.present:
    \- function: test.ping
    \- seconds: 15
    \- splay:
        start: 10
        end: 20
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will schedule the command: test.ping every 15 seconds
splaying the time between 10 and 20 seconds
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job1:
  schedule.present:
    \- function: state.sls
    \- job_args:
      \- httpd
    \- job_kwargs:
        test: True
    \- when:
        \- Monday 5:00pm
        \- Tuesday 3:00pm
        \- Wednesday 5:00pm
        \- Thursday 3:00pm
        \- Friday 5:00pm
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will schedule the command: state.sls httpd test=True at 5pm on Monday,
Wednesday and Friday, and 3pm on Tuesday and Thursday.  Requires that
python\-dateutil is installed on the minion.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job1:
  schedule.present:
    \- function: state.sls
    \- job_args:
      \- httpd
    \- job_kwargs:
        test: True
    \- cron: \(aq*/5 * * * *\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Scheduled jobs can also be specified using the format used by cron.  This will
schedule the command: state.sls httpd test=True to run every 5 minutes.  Requires
that python\-croniter is installed on the minion.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job1:
  schedule.present:
    \- function: state.sls
    \- job_args:
      \- httpd
    \- job_kwargs:
        test: True
    \- when:
        \- Monday 5:00pm
        \- Tuesday 3:00pm
        \- Wednesday 5:00pm
        \- Thursday 3:00pm
        \- Friday 5:00pm
    \- returner: xmpp
    \- return_config: xmpp_state_run
    \- return_kwargs:
        recipient: user@domain.com
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will schedule the command: state.sls httpd test=True at 5pm on Monday,
Wednesday and Friday, and 3pm on Tuesday and Thursday.  Using the xmpp returner
to return the results of the scheduled job, with the alternative configuration
options found in the xmpp_state_run section.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job1:
  schedule.present:
    \- function: state.sls
    \- job_args:
      \- httpd
    \- job_kwargs:
        test: True
    \- hours: 1
    \- skip_during_range:
        \- start: 2pm
        \- end: 3pm
    \- run_after_skip_range: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will schedule the command: state.sls httpd test=True at 5pm on Monday,
Wednesday and Friday, and 3pm on Tuesday and Thursday.  Requires that
python\-dateutil is installed on the minion.
.INDENT 0.0
.TP
.B salt.states.schedule.absent(name, **kwargs)
Ensure a job is absent from the schedule
.INDENT 7.0
.TP
.B name
The unique name that is given to the scheduled job.
.TP
.B persist
Whether changes to the scheduled job should be saved, defaults to True.
.sp
When used with absent this will decide whether the scheduled job will be removed
from the saved scheduled jobs and not be available when the Salt minion is
restarted.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.schedule.disabled(name, **kwargs)
Ensure a job is disabled in the schedule
.INDENT 7.0
.TP
.B name
The unique name that is given to the scheduled job.
.TP
.B persist
Whether changes to the scheduled job should be saved, defaults to True.
.TP
.B offline
Delete the scheduled job to the Salt minion when the Salt minion is not running.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.schedule.enabled(name, **kwargs)
Ensure a job is enabled in the schedule
.INDENT 7.0
.TP
.B name
The unique name that is given to the scheduled job.
.TP
.B persist
Whether changes to the scheduled job should be saved, defaults to True.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.schedule.present(name, **kwargs)
Ensure a job is present in the schedule
.INDENT 7.0
.TP
.B name
The unique name that is given to the scheduled job.
.TP
.B seconds
The scheduled job will be executed after the specified
number of seconds have passed.
.TP
.B minutes
The scheduled job will be executed after the specified
number of minutes have passed.
.TP
.B hours
The scheduled job will be executed after the specified
number of hours have passed.
.TP
.B days
The scheduled job will be executed after the specified
number of days have passed.
.TP
.B when
This will schedule the job at the specified time(s).
The when parameter must be a single value or a dictionary
with the date string(s) using the dateutil format.
Requires python\-dateutil.
.TP
.B cron
This will schedule the job at the specified time(s)
using the crontab format.
Requires python\-croniter.
.TP
.B run_on_start
Whether the scheduled job will run when Salt minion starts, or the job will be
skipped \fBonce\fP and run at the next scheduled run.  Value should be a
boolean.
.TP
.B function
The function that should be executed by the scheduled job.
.TP
.B job_args
The arguments that will be used by the scheduled job.
.TP
.B job_kwargs
The keyword arguments that will be used by the scheduled job.
.TP
.B maxrunning
Ensure that there are no more than N copies of a particular job running.
.TP
.B jid_include
Include the job into the job cache.
.TP
.B splay
The amount of time in seconds to splay a scheduled job.
Can be specified as a single value in seconds or as a dictionary
range with \(aqstart\(aq and \(aqend\(aq values.
.TP
.B range
This will schedule the command within the range specified.
The range parameter must be a dictionary with the date strings
using the dateutil format. Requires python\-dateutil.
.TP
.B once
This will schedule a job to run once on the specified date.
.TP
.B once_fmt
The default date format is ISO 8601 but can be overridden by
also specifying the \fBonce_fmt\fP option.
.TP
.B enabled
Whether the scheduled job should be enabled or disabled.  Value should be a boolean.
.TP
.B return_job
Whether to return information to the Salt master upon job completion.
.TP
.B metadata
Using the metadata parameter special values can be associated with
a scheduled job.  These values are not used in the execution of the job,
but can be used to search for specific jobs later if combined with the
return_job parameter.  The metadata parameter must be specified as a
dictionary, othewise it will be ignored.
.TP
.B returner
The returner to use to return the results of the scheduled job.
.TP
.B return_config
The alternative configuration to use for returner configuration options.
.TP
.B return_kwargs
Any individual returner configuration items to override.  Should be passed
as a dictionary.
.TP
.B persist
Whether changes to the scheduled job should be saved, defaults to True.
.TP
.B skip_during_range
This will ensure that the scheduled command does not run within the
range specified.  The range parameter must be a dictionary with the
date strings using the dateutil format. Requires python\-dateutil.
.TP
.B run_after_skip_range
Whether the scheduled job should run immediately after the skip_during_range time
period ends.
.TP
.B offline
Add the scheduled job to the Salt minion when the Salt minion is not running.
.sp
New in version 3006.3.

.UNINDENT
.UNINDENT
.SS salt.states.selinux
.SS Management of SELinux rules
.sp
If SELinux is available for the running system, the mode can be managed and
booleans can be set.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
enforcing:
    selinux.mode

samba_create_home_dirs:
    selinux.boolean:
      \- value: True
      \- persist: True

nginx:
    selinux.module:
      \- enabled: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Use of these states require that the \fI\%selinux\fP
execution module is available.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.selinux.boolean(name, value, persist=False)
Set up an SELinux boolean
.INDENT 7.0
.TP
.B name
The name of the boolean to set
.TP
.B value
The value to set on the boolean
.TP
.B persist
Defaults to False, set persist to true to make the boolean apply on a
reboot
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.selinux.fcontext_policy_absent(name, filetype=\(aqa\(aq, sel_type=None, sel_user=None, sel_level=None)
New in version 2017.7.0.

.sp
Makes sure an SELinux file context policy for a given filespec
(name), filetype and SELinux context type is absent.
.INDENT 7.0
.TP
.B name
filespec of the file or directory. Regex syntax is allowed.
.TP
.B filetype
The SELinux filetype specification. Use one of [a, f, d, c, b,
s, l, p]. See also \fIman semanage\-fcontext\fP\&. Defaults to \(aqa\(aq
(all files).
.TP
.B sel_type
The SELinux context type. There are many.
.TP
.B sel_user
The SELinux user.
.TP
.B sel_level
The SELinux MLS range.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.selinux.fcontext_policy_applied(name, recursive=False)
New in version 2017.7.0.

.sp
Checks and makes sure the SELinux policies for a given filespec are
applied.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.selinux.fcontext_policy_present(name, sel_type, filetype=\(aqa\(aq, sel_user=None, sel_level=None)
New in version 2017.7.0.

.sp
Makes sure a SELinux policy for a given filespec (name), filetype
and SELinux context type is present.
.INDENT 7.0
.TP
.B name
filespec of the file or directory. Regex syntax is allowed.
.TP
.B sel_type
SELinux context type. There are many.
.TP
.B filetype
The SELinux filetype specification. Use one of [a, f, d, c, b,
s, l, p]. See also \fIman semanage\-fcontext\fP\&. Defaults to \(aqa\(aq
(all files).
.TP
.B sel_user
The SELinux user.
.TP
.B sel_level
The SELinux MLS range.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.selinux.mode(name)
Verifies the mode SELinux is running in, can be set to enforcing,
permissive, or disabled
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A change to or from disabled mode requires a system reboot. You will
need to perform this yourself.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The mode to run SELinux in, permissive, enforcing, or disabled.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.selinux.module(name, module_state=\(aqEnabled\(aq, version=\(aqany\(aq, **opts)
Enable/Disable and optionally force a specific version for an SELinux module
.INDENT 7.0
.TP
.B name
The name of the module to control
.TP
.B module_state
Should the module be enabled or disabled?
.TP
.B version
Defaults to no preference, set to a specified value if required.
Currently can only alert if the version is incorrect.
.TP
.B install
Setting to True installs module
.TP
.B source
Points to module source file, used only when install is True
.TP
.B remove
Setting to True removes module
.UNINDENT
.sp
New in version 2016.3.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.selinux.module_install(name)
Installs custom SELinux module from given file
.INDENT 7.0
.TP
.B name
Path to file with module to install
.UNINDENT
.sp
New in version 2016.11.6.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.selinux.module_remove(name)
Removes SELinux module
.INDENT 7.0
.TP
.B name
The name of the module to remove
.UNINDENT
.sp
New in version 2016.11.6.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.selinux.port_policy_absent(name, sel_type=None, protocol=None, port=None)
New in version 2019.2.0.

.sp
Makes sure an SELinux port policy for a given port, protocol and SELinux context type is absent.
.INDENT 7.0
.TP
.B name
The protocol and port spec. Can be formatted as \fB(tcp|udp)/(port|port\-range)\fP\&.
.TP
.B sel_type
The SELinux Type. Optional; can be used in determining if policy is present,
ignored by \fBsemanage port \-\-delete\fP\&.
.TP
.B protocol
The protocol for the port, \fBtcp\fP or \fBudp\fP\&. Required if name is not formatted.
.TP
.B port
The port or port range. Required if name is not formatted.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.selinux.port_policy_present(name, sel_type, protocol=None, port=None, sel_range=None)
New in version 2019.2.0.

.sp
Makes sure an SELinux port policy for a given port, protocol and SELinux context type is present.
.INDENT 7.0
.TP
.B name
The protocol and port spec. Can be formatted as \fB(tcp|udp)/(port|port\-range)\fP\&.
.TP
.B sel_type
The SELinux Type.
.TP
.B protocol
The protocol for the port, \fBtcp\fP or \fBudp\fP\&. Required if name is not formatted.
.TP
.B port
The port or port range. Required if name is not formatted.
.TP
.B sel_range
The SELinux MLS/MCS Security Range.
.UNINDENT
.UNINDENT
.SS salt.states.serverdensity_device
.SS Monitor Server with Server Density
.sp
New in version 2014.7.0.

.sp
\fI\%Server Density\fP
Is a hosted monitoring service.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This state module is beta. It might be changed later to include more or
less automation.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This state module requires a pillar for authentication with Server Density
To install a v1 agent:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
serverdensity:
  api_token: \(dqb97da80a41c4f61bff05975ee51eb1aa\(dq
  account_url: \(dqhttps://your\-account.serverdensity.io\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To install a v2 agent:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
serverdensity:
  api_token: \(dqb97da80a41c4f61bff05975ee51eb1aa\(dq
  account_name: \(dqyour\-account\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Although Server Density allows duplicate device names in its database, this
module will raise an exception if you try monitoring devices with the same
name.
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\(aqserver_name\(aq:
  serverdensity_device.monitored
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.serverdensity_device.monitored(name, group=None, salt_name=True, salt_params=True, agent_version=1, **params)
Device is monitored with Server Density.
.INDENT 7.0
.TP
.B name
Device name in Server Density.
.TP
.B salt_name
If \fBTrue\fP (default), takes the name from the \fBid\fP grain. If
\fBFalse\fP, the provided name is used.
.TP
.B group
Group name under with device will appear in Server Density dashboard.
Default \- \fINone\fP\&.
.TP
.B agent_version
The agent version you want to use. Valid values are 1 or 2.
Default \- 1.
.TP
.B salt_params
If \fBTrue\fP (default), needed config parameters will be sourced from
grains and from \fI\%status.all_status\fP\&.
.TP
.B params
Add parameters that you want to appear in the Server Density dashboard.
Will overwrite the \fIsalt_params\fP parameters. For more info, see the
\fI\%API docs\fP\&.
.UNINDENT
.sp
Usage example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\(aqserver_name\(aq:
  serverdensity_device.monitored
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\(aqserver_name\(aq:
  serverdensity_device.monitored:
    \- group: web\-servers
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\(aqmy_special_server\(aq:
  serverdensity_device.monitored:
    \- salt_name: False
    \- group: web\-servers
    \- cpuCores: 2
    \- os: \(aq{\(dqcode\(dq: \(dqlinux\(dq, \(dqname\(dq: \(dqLinux\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.service
.SS Starting or restarting of services and daemons
.sp
Services are defined as system daemons and are typically launched using system
init or rc scripts. This service state uses whichever service module is loaded
on the minion with the virtualname of \fBservice\fP\&. Services can be defined as
either running or dead.
.sp
If you need to know if your init system is supported, see the list of supported
\fBservice modules\fP for your desired init system
(systemd, sysvinit, launchctl, etc.).
.sp
Note that Salt\(aqs service execution module, and therefore this service state,
uses OS grains to ascertain which service module should be loaded and used to
execute service functions. As existing distributions change init systems or
new distributions are created, OS detection can sometimes be incomplete.
If your service states are running into trouble with init system detection,
please see the \fI\%Overriding Virtual Module Providers\fP
section of Salt\(aqs module documentation to work around possible errors.
.sp
For services managed by systemd, the systemd_service module includes a built\-in
feature to reload the daemon when unit files are changed or extended. This
feature is used automatically by the service state and the systemd_service
module when running on a systemd minion, so there is no need to set up your own
methods of reloading the daemon. If you need to manually reload the daemon for
some reason, you can use the \fI\%systemd_service.systemctl_reload\fP function provided by Salt.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The current status of a service is determined by the return code of the init/rc
script status command. A status return code of 0 it is considered running.  Any
other return code is considered dead.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
httpd:
  service.running: []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The service can also be set to start at runtime via the enable option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
openvpn:
  service.running:
    \- enable: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default if a service is triggered to refresh due to a watch statement the
service is restarted. If the desired behavior is to reload the service, then
set the reload value to True:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
redis:
  service.running:
    \- enable: True
    \- reload: True
    \- watch:
      \- pkg: redis
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
More details regarding \fBwatch\fP can be found in the
\fI\%Requisites\fP documentation.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.service.dead(name, enable=None, sig=None, init_delay=None, **kwargs)
Ensure that the named service is dead by stopping the service if it is running
.INDENT 7.0
.TP
.B name
The name of the init or rc script used to manage the service
.TP
.B enable
Set the service to be enabled at boot time, \fBTrue\fP sets the service
to be enabled, \fBFalse\fP sets the named service to be disabled. The
default is \fBNone\fP, which does not enable or disable anything.
.TP
.B sig
The string to search for when looking for the service process with ps
.TP
.B init_delay
Add a sleep command (in seconds) before the check to make sure service
is killed.
.sp
New in version 2017.7.0.

.TP
.B no_block
False
\fBFor systemd minions only.\fP Stops the service using \fB\-\-no\-block\fP\&.
.sp
New in version 2017.7.0.

.TP
.B timeout
\fBFor Windows minions only.\fP
.sp
The time in seconds to wait for the service to stop before returning.
Default is the default for \fI\%win_service.stop\fP\&.
.sp
New in version 2017.7.9,2018.3.4.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.service.disabled(name, **kwargs)
Ensure that the service is disabled on boot, only use this state if you
don\(aqt want to manage the running process, remember that if you want to
disable a service to use the enable: False option for the running or dead
function.
.INDENT 7.0
.TP
.B name
The name of the init or rc script used to manage the service
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.service.enabled(name, **kwargs)
Ensure that the service is enabled on boot, only use this state if you
don\(aqt want to manage the running process, remember that if you want to
enable a running service to use the enable: True option for the running
or dead function.
.INDENT 7.0
.TP
.B name
The name of the init or rc script used to manage the service
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.service.masked(name, runtime=False)
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state is only available on minions which use \fI\%systemd\fP\&.
.UNINDENT
.UNINDENT
.sp
Ensures that the named service is masked (i.e. prevented from being
started).
.INDENT 7.0
.TP
.B name
Name of the service to mask
.TP
.B runtime
False
By default, this state will manage an indefinite mask for the named
service. Set this argument to \fBTrue\fP to runtime mask the service.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
It is possible for a service to have both indefinite and runtime masks
set for it. Therefore, this state will manage a runtime or indefinite
mask independently of each other. This means that if the service is
already indefinitely masked, running this state with \fBruntime\fP set to
\fBTrue\fP will _not_ remove the indefinite mask before setting a runtime
mask. In these cases, if it is desirable to ensure that the service is
runtime masked and not indefinitely masked, pair this state with a
\fI\%service.unmasked\fP state, like
so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mask_runtime_foo:
  service.masked:
    \- name: foo
    \- runtime: True

unmask_indefinite_foo:
  service.unmasked:
    \- name: foo
    \- runtime: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.service.mod_beacon(name, **kwargs)
Create a beacon to monitor a service based on a beacon state argument.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state exists to support special handling of the \fBbeacon\fP
state argument for supported state functions. It should not be called directly.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.service.mod_watch(name, sfun=None, sig=None, reload=False, full_restart=False, init_delay=None, force=False, **kwargs)
The service watcher, called to invoke the watch command.
When called, it will restart or reload the named service.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state exists to support special handling of the \fBwatch\fP
\fI\%requisite\fP\&. It should not be called directly.
.sp
Parameters for this function should be set by the watching service
(e.g. \fBservice.running\fP).
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The name of the service to control.
.TP
.B sfun
The original function which triggered the mod_watch call
(\fIservice.running\fP, for example).
.TP
.B sig
The string to search for when looking for the service process with ps.
.TP
.B reload
When set, reload the service instead of restarting it
(e.g. \fBservice nginx reload\fP).
.TP
.B full_restart
Perform a full stop/start of a service by passing \fB\-\-full\-restart\fP\&.
This option is ignored if \fBreload\fP is set and is supported by only a few
\fI\%service modules\fP\&.
.TP
.B force
Use service.force_reload instead of reload (needs reload to be set to True).
.TP
.B init_delay
Add a sleep command (in seconds) before the service is restarted/reloaded.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.service.running(name, enable=None, sig=None, init_delay=None, **kwargs)
Ensure that the service is running
.INDENT 7.0
.TP
.B name
The name of the init or rc script used to manage the service
.TP
.B enable
Set the service to be enabled at boot time, \fBTrue\fP sets the service
to be enabled, \fBFalse\fP sets the named service to be disabled. The
default is \fBNone\fP, which does not enable or disable anything.
.TP
.B sig
The string to search for when looking for the service process with ps
.TP
.B init_delay
Some services may not be truly available for a short period after their
startup script indicates to the system that they are. Provide an
\(aqinit_delay\(aq to specify that this state should wait an additional given
number of seconds after a service has started before returning. Useful
for requisite states wherein a dependent state might assume a service
has started but is not yet fully initialized.
.TP
.B no_block
False
\fBFor systemd minions only.\fP Starts the service using \fB\-\-no\-block\fP\&.
.sp
New in version 2017.7.0.

.TP
.B timeout
\fBFor Windows minions only.\fP
.sp
The time in seconds to wait for the service to start before returning.
Default is the default for \fI\%win_service.start\fP\&.
.sp
New in version 2017.7.9,2018.3.4.

.TP
.B unmask
False
\fBFor systemd minions only.\fP Set to \fBTrue\fP to remove an indefinite
mask before attempting to start the service.
.sp
New in version 2017.7.0: In previous releases, Salt would simply unmask a service before
making any changes. This behavior is no longer the default.

.TP
.B unmask_runtime
False
\fBFor systemd minions only.\fP Set to \fBTrue\fP to remove a runtime mask
before attempting to start the service.
.sp
New in version 2017.7.0: In previous releases, Salt would simply unmask a service before
making any changes. This behavior is no longer the default.

.TP
.B wait
3
\fBFor systemd minions only.\fP Passed through when using
\fI\%service.status\fP to
determine whether the service is running or not.
.sp
New in version 2019.2.3.

.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \fBwatch\fP can be used with service.running to restart a service when
another state changes ( example: a file.managed state that creates the
service\(aqs config file ). More details regarding \fBwatch\fP can be found
in the \fI\%Requisites\fP documentation.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.service.unmasked(name, runtime=False)
New in version 2017.7.0.

.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state is only available on minions which use \fI\%systemd\fP\&.
.UNINDENT
.UNINDENT
.sp
Ensures that the named service is unmasked
.INDENT 7.0
.TP
.B name
Name of the service to unmask
.TP
.B runtime
False
By default, this state will manage an indefinite mask for the named
service. Set this argument to \fBTrue\fP to ensure that the service is
runtime masked.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
It is possible for a service to have both indefinite and runtime masks
set for it. Therefore, this state will manage a runtime or indefinite
mask independently of each other. This means that if the service is
indefinitely masked, running this state with \fBruntime\fP set to
\fBTrue\fP will _not_ remove the indefinite mask.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.slack
.SS Send a message to Slack
.sp
This state is useful for sending messages to Slack during state runs.
.sp
New in version 2015.5.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
slack\-message:
  slack.post_message:
    \- channel: \(aq#general\(aq
    \- from_name: SuperAdmin
    \- message: \(aqThis state was executed successfully.\(aq
    \- api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The api key can be specified in the master or minion configuration like below:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
slack:
  api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.slack.post_message(name, **kwargs)
Send a message to a Slack channel.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
slack\-message:
  slack.post_message:
    \- channel: \(aq#general\(aq
    \- from_name: SuperAdmin
    \- message: \(aqThis state was executed successfully.\(aq
    \- api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B api_key parameters:
.INDENT 7.0
.TP
.B name
The unique name for this event.
.TP
.B channel
The channel to send the message to. Can either be the ID or the name.
.TP
.B from_name
The name of that is to be shown in the \(dqfrom\(dq field.
.TP
.B message
The message that is to be sent to the Slack channel.
.UNINDENT
.sp
The following parameters are optional:
.INDENT 7.0
.TP
.B api_key
The api key for Slack to use for authentication,
if not specified in the configuration options of master or minion.
.TP
.B icon
URL to an image to use as the icon for this message
.UNINDENT
.TP
.B webhook parameters:
.INDENT 7.0
.TP
.B name
The unique name for this event.
.TP
.B message
The message that is to be sent to the Slack channel.
.TP
.B color
The color of border of left side
.TP
.B short
An optional flag indicating whether the value is short
enough to be displayed side\-by\-side with other values.
.TP
.B webhook
The identifier of WebHook (URL or token).
.TP
.B channel
The channel to use instead of the WebHook default.
.TP
.B username
Username to use instead of WebHook default.
.TP
.B icon_emoji
Icon to use instead of WebHook default.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.smartos
.sp
Management of SmartOS Standalone Compute Nodes
.INDENT 0.0
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B depends
vmadm, imgadm
.TP
.B platform
smartos
.UNINDENT
.sp
New in version 2016.3.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vmtest.example.org:
  smartos.vm_present:
    \- config:
        reprovision: true
    \- vmconfig:
        image_uuid: c02a2044\-c1bd\-11e4\-bd8c\-dfc1db8b0182
        brand: joyent
        alias: vmtest
        quota: 5
        max_physical_memory: 512
        tags:
          label: \(aqtest vm\(aq
          owner: \(aqsjorge\(aq
        nics:
          \(dq82:1b:8e:49:e9:12\(dq:
            nic_tag: trunk
            mtu: 1500
            ips:
              \- 172.16.1.123/16
              \- 192.168.2.123/24
            vlan_id: 10
          \(dq82:1b:8e:49:e9:13\(dq:
            nic_tag: trunk
            mtu: 1500
            ips:
              \- dhcp
            vlan_id: 30
        filesystems:
          \(dq/bigdata\(dq:
            source: \(dq/bulk/data\(dq
            type: lofs
            options:
              \- ro
              \- nodevices

kvmtest.example.org:
  smartos.vm_present:
    \- vmconfig:
        brand: kvm
        alias: kvmtest
        cpu_type: host
        ram: 512
        vnc_port: 9
        tags:
          label: \(aqtest kvm\(aq
          owner: \(aqsjorge\(aq
        disks:
          disk0:
            size: 2048
            model: virtio
            compression: lz4
            boot: true
        nics:
          \(dq82:1b:8e:49:e9:15\(dq:
            nic_tag: trunk
            mtu: 1500
            ips:
              \- dhcp
            vlan_id: 30

docker.example.org:
  smartos.vm_present:
    \- config:
        auto_import: true
        reprovision: true
    \- vmconfig:
        image_uuid: emby/embyserver:latest
        brand: lx
        alias: mydockervm
        quota: 5
        max_physical_memory: 1024
        tags:
          label: \(aqmy emby docker\(aq
          owner: \(aqsjorge\(aq
        resolvers:
          \- 172.16.1.1
        nics:
          \(dq82:1b:8e:49:e9:18\(dq:
            nic_tag: trunk
            mtu: 1500
            ips:
              \- 172.16.1.118/24
            vlan_id: 10
        filesystems:
          \(dq/config:
            source: \(dq/vmdata/emby_config\(dq
            type: lofs
            options:
              \- nodevices

cleanup_images:
  smartos.image_vacuum
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Keep in mind that when removing properties from vmconfig they will not get
removed from the vm\(aqs current configuration, except for nics, disk, tags, ...
they get removed via add_*, set_*, update_*, and remove_*. Properties must
be manually reset to their default value.
The same behavior as when using \(aqvmadm update\(aq.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
For HVM (bhyve and KVM) brands the \fIimage_uuid\fP field should go on the boot disks,
this disk should NOT have a size specified. (See man vmadm)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.smartos.config_absent(name)
Ensure configuration property is absent in /usbkey/config
.INDENT 7.0
.TP
.B name
string
name of property
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.smartos.config_present(name, value)
Ensure configuration property is set to value in /usbkey/config
.INDENT 7.0
.TP
.B name
string
name of property
.TP
.B value
string
value of property
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.smartos.image_absent(name)
Ensure image is absent on the computenode
.INDENT 7.0
.TP
.B name
string
uuid of image
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
computenode.image_absent will only remove the image if it is not used
by a vm.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.smartos.image_present(name)
Ensure image is present on the computenode
.INDENT 7.0
.TP
.B name
string
uuid of image
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.smartos.image_vacuum(name)
Delete images not in use or installed via image_present
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Only image_present states that are included via the
top file will be detected.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.smartos.source_absent(name)
Ensure an image source is absent on the computenode
.INDENT 7.0
.TP
.B name
string
source url
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.smartos.source_present(name, source_type=\(aqimgapi\(aq)
Ensure an image source is present on the computenode
.INDENT 7.0
.TP
.B name
string
source url
.TP
.B source_type
string
source type (imgapi or docker)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.smartos.vm_absent(name, archive=False)
Ensure vm is absent on the computenode
.INDENT 7.0
.TP
.B name
string
hostname of vm
.TP
.B archive
boolean
toggle archiving of vm on removal
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
State ID is used as hostname. Hostnames must be unique.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.smartos.vm_present(name, vmconfig, config=None)
Ensure vm is present on the computenode
.INDENT 7.0
.TP
.B name
string
hostname of vm
.TP
.B vmconfig
dict
options to set for the vm
.TP
.B config
dict
fine grain control over vm_present
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B The following configuration properties can be toggled in the config parameter.
.INDENT 7.0
.IP \(bu 2
kvm_reboot (true)                \- reboots of kvm zones if needed for a config update
.IP \(bu 2
auto_import (false)              \- automatic importing of missing images
.IP \(bu 2
auto_lx_vars (true)              \- copy kernel_version and docker:* variables from image
.IP \(bu 2
reprovision (false)              \- reprovision on image_uuid changes
.IP \(bu 2
enforce_tags (true)              \- false = add tags only, true =  add, update, and remove tags
.IP \(bu 2
enforce_routes (true)            \- false = add tags only, true =  add, update, and remove routes
.IP \(bu 2
enforce_internal_metadata (true) \- false = add metadata only, true =  add, update, and remove metadata
.IP \(bu 2
enforce_customer_metadata (true) \- false = add metadata only, true =  add, update, and remove metadata
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
State ID is used as hostname. Hostnames must be unique.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If hostname is provided in vmconfig this will take president over the State ID.
This allows multiple states to be applied to the same vm.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B The following instances should have a unique ID.
.INDENT 7.0
.IP \(bu 2
nic : mac
.IP \(bu 2
filesystem: target
.IP \(bu 2
disk : path or diskN for zvols
.UNINDENT
.UNINDENT
.sp
e.g. disk0 will be the first disk added, disk1 the 2nd,...
.UNINDENT
.UNINDENT
.sp
Changed in version 2019.2.0: Added support for docker image uuids, added auto_lx_vars configuration, documented some missing configuration options.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.smartos.vm_running(name)
Ensure vm is in the running state on the computenode
.INDENT 7.0
.TP
.B name
string
hostname of vm
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
State ID is used as hostname. Hostnames must be unique.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.smartos.vm_stopped(name)
Ensure vm is in the stopped state on the computenode
.INDENT 7.0
.TP
.B name
string
hostname of vm
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
State ID is used as hostname. Hostnames must be unique.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.smtp
.SS Sending Messages via SMTP
.sp
New in version 2014.7.0.

.sp
This state is useful for firing messages during state runs, using the SMTP
protocol
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
server\-warning\-message:
  smtp.send_msg:
    \- name: \(aqThis is a server warning message\(aq
    \- profile: my\-smtp\-account
    \- recipient: admins@example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.smtp.send_msg(name, recipient, subject, sender=None, profile=None, use_ssl=\(aqTrue\(aq, attachments=None)
Send a message via SMTP
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
server\-warning\-message:
  smtp.send_msg:
    \- name: \(aqThis is a server warning message\(aq
    \- profile: my\-smtp\-account
    \- subject: \(aqMessage from Salt\(aq
    \- recipient: admin@example.com
    \- sender: admin@example.com
    \- use_ssl: True
    \- attachments:
        \- /var/log/syslog
        \- /var/log/messages
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The message to send via SMTP
.UNINDENT
.UNINDENT
.SS salt.states.snapper
.SS Managing implicit state and baselines using snapshots
.sp
New in version 2016.11.0.

.sp
Salt can manage state against explicitly defined state, for example
if your minion state is defined by:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/config_file:
  file.managed:
    \- source: salt://configs/myconfig
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If someone modifies this file, the next application of the highstate will
allow the admin to correct this deviation and the file will be corrected.
.sp
Now, what happens if somebody creates a file \fB/etc/new_config_file\fP and
deletes \fB/etc/important_config_file\fP? Unless you have a explicit rule, this
change will go unnoticed.
.sp
The snapper state module allows you to manage state implicitly, in addition
to explicit rules, in order to define a baseline and iterate with explicit
rules as they show that they work in production.
.sp
The workflow is: once you have a working and audited system, you would create
your baseline snapshot (eg. with \fBsalt tgt snapper.create_snapshot\fP) and
define in your state this baseline using the identifier of the snapshot
(in this case: 20):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_baseline:
  snapper.baseline_snapshot:
    \- number: 20
    \- include_diff: False
    \- ignore:
      \- /var/log
      \- /var/cache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Baseline snapshots can be also referenced by tag. Most recent baseline snapshot
is used in case of multiple snapshots with the same tag:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B my_baseline_external_storage:
.INDENT 7.0
.TP
.B snapper.baseline_snapshot:
.INDENT 7.0
.IP \(bu 2
tag: my_custom_baseline_tag
.IP \(bu 2
config: external
.IP \(bu 2
ignore:
\- /mnt/tmp_files/
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
If you have this state, and you haven\(aqt done changes to the system since the
snapshot, and you add a user, the state will show you the changes (including
full diffs) to \fB/etc/passwd\fP, \fB/etc/shadow\fP, etc if you call it
with \fBtest=True\fP and will undo all changes if you call it without.
.sp
This allows you to add more explicit state knowing that you are starting from a
very well defined state, and that you can audit any change that is not part
of your explicit configuration.
.sp
So after you made this your state, you decided to introduce a change in your
configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_baseline:
  snapper.baseline_snapshot:
    \- number: 20
    \- ignore:
      \- /var/log
      \- /var/cache

hosts_entry:
  file.blockreplace:
    \- name: /etc/hosts
    \- content: \(aqFirst line of content\(aq
    \- append_if_not_found: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The change in \fB/etc/hosts\fP will be done after any other change that deviates
from the specified snapshot are reverted. This could be for example,
modifications to the \fB/etc/passwd\fP file or changes in the \fB/etc/hosts\fP
that could render your the \fBhosts_entry\fP rule void or dangerous.
.sp
Once you take a new snapshot and you update the baseline snapshot number to
include the change in \fB/etc/hosts\fP the \fBhosts_entry\fP rule will basically
do nothing. You are free to leave it there for documentation, to ensure that
the change is made in case the snapshot is wrong, but if you remove anything
that comes after the \fBsnapper.baseline_snapshot\fP as it will have no effect;
by the moment the state is evaluated, the baseline state was already applied
and include this change.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Make sure you specify the baseline state before other rules, otherwise
the baseline state will revert all changes if they are not present in
the snapshot.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Do not specify more than one baseline rule as only the last one will
affect the result.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B codeauthor
Duncan Mac\-Vicar P. <\fI\%dmacvicar@suse.de\fP>
.TP
.B codeauthor
Pablo Suárez Hernández <\fI\%psuarezhernandez@suse.de\fP>
.TP
.B maturity
new
.TP
.B platform
Linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.snapper.baseline_snapshot(name, number=None, tag=None, include_diff=True, config=\(aqroot\(aq, ignore=None)
Enforces that no file is modified comparing against a previously
defined snapshot identified by number.
.INDENT 7.0
.TP
.B number
Number of selected baseline snapshot.
.TP
.B tag
Tag of the selected baseline snapshot. Most recent baseline baseline
snapshot is used in case of multiple snapshots with the same tag.
(\fItag\fP and \fInumber\fP cannot be used at the same time)
.TP
.B include_diff
Include a diff in the response (Default: True)
.TP
.B config
Snapper config name (Default: root)
.TP
.B ignore
List of files to ignore. (Default: None)
.UNINDENT
.UNINDENT
.SS salt.states.solrcloud
.sp
States for solrcloud alias and collection configuration
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.states.solrcloud.alias(name, collections, **kwargs)
Create alias and enforce collection list.
.sp
Use the solrcloud module to get alias members and set them.
.sp
You can pass additional arguments that will be forwarded to http.query
.INDENT 7.0
.TP
.B name
The collection name
.TP
.B collections
list of collections to include in the alias
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.solrcloud.collection(name, options=None, **kwargs)
Create collection and enforce options.
.sp
Use the solrcloud module to get collection parameters.
.sp
You can pass additional arguments that will be forwarded to http.query
.INDENT 7.0
.TP
.B name
The collection name
.TP
.B options
{}
options to ensure
.UNINDENT
.UNINDENT
.SS salt.states.splunk
.sp
Splunk User State Module
.sp
New in version 2016.3.0.

.sp
This state is used to ensure presence of users in splunk.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ensure example test user 1:
    splunk.present:
        \- name: \(aqExample TestUser1\(aq
        \- email: example@domain.com
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.splunk.absent(email, profile=\(aqsplunk\(aq, **kwargs)
Ensure a splunk user is absent
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ensure example test user 1:
    splunk.absent:
        \- email: \(aqexample@domain.com\(aq
        \- name: \(aqexampleuser\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B email
This is the email of the user in splunk
.TP
.B name
This is the splunk username used to identify the user.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.splunk.present(email, profile=\(aqsplunk\(aq, **kwargs)
Ensure a user is present
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ensure example test user 1:
    splunk.user_present:
        \- realname: \(aqExample TestUser1\(aq
        \- name: \(aqexampleuser\(aq
        \- email: \(aqexample@domain.com\(aq
        \- roles: [\(aquser\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B email
This is the email of the user in splunk
.UNINDENT
.UNINDENT
.SS salt.states.splunk_search
.sp
Splunk Search State Module
.sp
New in version 2015.5.0.

.sp
This state is used to ensure presence of splunk searches.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
server\-warning\-message:
  splunk_search.present:
    \- name: This is the splunk search name
    \- search: index=main sourcetype=
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.splunk_search.absent(name, profile=\(aqsplunk\(aq)
Ensure a search is absent
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
API Error Search:
  splunk_search.absent
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B name
This is the name of the search in splunk
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.splunk_search.present(name, profile=\(aqsplunk\(aq, **kwargs)
Ensure a search is present
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
API Error Search:
  splunk_search.present:
    search: index=main sourcetype=blah
    template: alert_5min
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B name
This is the name of the search in splunk
.UNINDENT
.UNINDENT
.SS salt.states.sqlite3
.SS Management of SQLite3 databases
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
SQLite3 Python Module
.UNINDENT
.TP
.B configuration
See \fI\%salt.modules.sqlite3\fP for setup instructions
.UNINDENT
.sp
The sqlite3 module is used to create and manage sqlite3 databases
and execute queries
.sp
Here is an example of creating a table using sql statements:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  sqlite3.table_present:
    \- db: /var/www/data/app.sqlite
    \- schema: CREATE TABLE \(gausers\(ga (\(gausername\(ga TEXT COLLATE NOCASE UNIQUE NOT NULL, \(gapassword\(ga BLOB NOT NULL, \(gasalt\(ga BLOB NOT NULL, \(galast_login\(ga INT)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here is an example of creating a table using yaml/jinja instead of sql:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
users:
  sqlite3.table_present:
    \- db: /var/www/app.sqlite
    \- schema:
      \- email TEXT COLLATE NOCASE UNIQUE NOT NULL
      \- firstname TEXT NOT NULL
      \- lastname TEXT NOT NULL
      \- company TEXT NOT NULL
      \- password BLOB NOT NULL
      \- salt BLOB NOT NULL
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here is an example of making sure a table is absent:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
badservers:
  sqlite3.table_absent:
    \- db: /var/www/data/users.sqlite
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Sometimes you would to have specific data in tables to be used by other services
Here is an example of making sure rows with specific data exist:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
user_john_doe_xyz:
  sqlite3.row_present:
    \- db: /var/www/app.sqlite
    \- table: users
    \- where_sql: email=\(aqjohn.doe@companyxyz.com\(aq
    \- data:
        email: john.doe@companyxyz.com
        lastname: doe
        firstname: john
        company: companyxyz.com
        password: abcdef012934125
        salt: abcdef012934125
    \- require:
      \- sqlite3: users
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here is an example of removing a row from a table:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
user_john_doe_abc:
  sqlite3.row_absent:
    \- db: /var/www/app.sqlite
    \- table: users
    \- where_sql: email=\(dqjohn.doe@companyabc.com\(dq
    \- require:
      \- sqlite3: users
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that there is no explicit state to perform random queries, however, this
can be approximated with sqlite3\(aqs module functions and module.run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
zone\-delete:
  module.run:
    \- name: sqlite3.modify
    \- db: {{ db }}
    \- sql: \(dqDELETE FROM records WHERE id > {{ count[0] }} AND domain_id = {{ domain_id }}\(dq
    \- watch:
      \- sqlite3: zone\-insert\-12
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.sqlite3.row_absent(name, db, table, where_sql, where_args=None)
Makes sure the specified row is absent in db.  If multiple rows
match where_sql, then the state will fail.
.INDENT 7.0
.TP
.B name
Only used as the unique ID
.TP
.B db
The database file name
.TP
.B table
The table name to check
.TP
.B where_sql
The sql to select the row to check
.TP
.B where_args
The list parameters to substitute in where_sql
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.sqlite3.row_present(name, db, table, data, where_sql, where_args=None, update=False)
Checks to make sure the given row exists. If row exists and update is True
then row will be updated with data. Otherwise it will leave existing
row unmodified and check it against data. If the existing data
doesn\(aqt match data_check the state will fail.  If the row doesn\(aqt
exist then it will insert data into the table. If more than one
row matches, then the state will fail.
.INDENT 7.0
.TP
.B name
Only used as the unique ID
.TP
.B db
The database file name
.TP
.B table
The table name to check the data
.TP
.B data
The dictionary of key/value pairs to check against if
row exists, insert into the table if it doesn\(aqt
.TP
.B where_sql
The sql to select the row to check
.TP
.B where_args
The list parameters to substitute in where_sql
.TP
.B update
True will replace the existing row with data
When False and the row exists and data does not equal
the row data then the state will fail
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.sqlite3.table_absent(name, db)
Make sure the specified table does not exist
.INDENT 7.0
.TP
.B name
The name of the table
.TP
.B db
The name of the database file
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.sqlite3.table_present(name, db, schema, force=False)
Make sure the specified table exists with the specified schema
.INDENT 7.0
.TP
.B name
The name of the table
.TP
.B db
The name of the database file
.TP
.B schema
The dictionary containing the schema information
.TP
.B force
If the name of the table exists and force is set to False,
the state will fail.  If force is set to True, the existing
table will be replaced with the new table
.UNINDENT
.UNINDENT
.SS salt.states.ssh_auth
.SS Control of entries in SSH authorized_key files
.sp
The information stored in a user\(aqs SSH authorized key file can be easily
controlled via the ssh_auth state. Defaults can be set by the enc, options,
and comment keys. These defaults can be overridden by including them in the
name.
.sp
Since the YAML specification limits the length of simple keys to 1024
characters, and since SSH keys are often longer than that, you may have
to use a YAML \(aqexplicit key\(aq, as demonstrated in the second example below.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
AAAAB3NzaC1kc3MAAACBAL0sQ9fJ5bYTEyY==:
  ssh_auth.present:
    \- user: root
    \- enc: ssh\-dss

? AAAAB3NzaC1kc3MAAACBAL0sQ9fJ5bYTEyY==...
:
  ssh_auth.present:
    \- user: root
    \- enc: ssh\-dss

thatch:
  ssh_auth.present:
    \- user: root
    \- source: salt://ssh_keys/thatch.id_rsa.pub
    \- config: \(aq%h/.ssh/authorized_keys\(aq

sshkeys:
  ssh_auth.present:
    \- user: root
    \- enc: ssh\-rsa
    \- options:
      \- option1=\(dqvalue1\(dq
      \- option2=\(dqvalue2 flag2\(dq
    \- comment: myuser
    \- names:
      \- AAAAB3NzaC1kc3MAAACBAL0sQ9fJ5bYTEyY==
      \- ssh\-dss AAAAB3NzaCL0sQ9fJ5bYTEyY== user@domain
      \- option3=\(dqvalue3\(dq ssh\-dss AAAAB3NzaC1kcQ9J5bYTEyY== other@testdomain
      \- AAAAB3NzaC1kcQ9fJFF435bYTEyY== newcomment

sshkeys:
  ssh_auth.manage:
    \- user: root
    \- enc: ssh\-rsa
    \- options:
      \- option1=\(dqvalue1\(dq
      \- option2=\(dqvalue2 flag2\(dq
    \- comment: myuser
    \- ssh_keys:
      \- AAAAB3NzaC1kc3MAAACBAL0sQ9fJ5bYTEyY==
      \- ssh\-dss AAAAB3NzaCL0sQ9fJ5bYTEyY== user@domain
      \- option3=\(dqvalue3\(dq ssh\-dss AAAAB3NzaC1kcQ9J5bYTEyY== other@testdomain
      \- AAAAB3NzaC1kcQ9fJFF435bYTEyY== newcomment
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ssh_auth.absent(name, user, enc=\(aqssh\-rsa\(aq, comment=\(aq\(aq, source=\(aq\(aq, options=None, config=\(aq.ssh/authorized_keys\(aq, fingerprint_hash_type=None)
Verifies that the specified SSH key is absent
.INDENT 7.0
.TP
.B name
The SSH key to manage
.TP
.B user
The user who owns the SSH authorized keys file to modify
.TP
.B enc
Defines what type of key is being used, can be ed25519, ecdsa,
ssh\-rsa, ssh\-dss or any other type as of openssh server version 8.7.
.TP
.B comment
The comment to be placed with the SSH public key
.TP
.B options
The options passed to the key, pass a list object
.TP
.B source
The source file for the key(s). Can contain any number of public keys,
in standard \(dqauthorized_keys\(dq format. If this is set, comment, enc and
options will be ignored.
.sp
New in version 2015.8.0.

.TP
.B config
The location of the authorized keys file relative to the user\(aqs home
directory, defaults to \(dq.ssh/authorized_keys\(dq. Token expansion %u and
%h for username and home path supported.
.TP
.B fingerprint_hash_type
The public key fingerprint hash type that the public key fingerprint
was originally hashed with. This defaults to \fBsha256\fP if not specified.
.sp
New in version 2016.11.7.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ssh_auth.manage(name, ssh_keys, user, enc=\(aqssh\-rsa\(aq, comment=\(aq\(aq, source=\(aq\(aq, options=None, config=\(aq.ssh/authorized_keys\(aq, fingerprint_hash_type=None, **kwargs)
New in version 3000.

.sp
Ensures that only the specified ssh_keys are present for the specified user
.INDENT 7.0
.TP
.B ssh_keys
The SSH key to manage
.TP
.B user
The user who owns the SSH authorized keys file to modify
.TP
.B enc
Defines what type of key is being used, can be ed25519, ecdsa,
ssh\-rsa, ssh\-dss or any other type as of openssh server version 8.7.
.TP
.B comment
The comment to be placed with the SSH public key
.TP
.B source
The source file for the key(s). Can contain any number of public keys,
in standard \(dqauthorized_keys\(dq format. If this is set, comment and enc
will be ignored.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The source file must contain keys in the format \fB<enc> <key>
<comment>\fP\&. If you have generated a keypair using PuTTYgen, then you
will need to do the following to retrieve an OpenSSH\-compatible public
key.
.INDENT 0.0
.IP 1. 3
In PuTTYgen, click \fBLoad\fP, and select the \fIprivate\fP key file (not
the public key), and click \fBOpen\fP\&.
.IP 2. 3
Copy the public key from the box labeled \fBPublic key for pasting
into OpenSSH authorized_keys file\fP\&.
.IP 3. 3
Paste it into a new file.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B options
The options passed to the keys, pass a list object
.TP
.B config
The location of the authorized keys file relative to the user\(aqs home
directory, defaults to \(dq.ssh/authorized_keys\(dq. Token expansion %u and
%h for username and home path supported.
.TP
.B fingerprint_hash_type
The public key fingerprint hash type that the public key fingerprint
was originally hashed with. This defaults to \fBsha256\fP if not specified.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ssh_auth.present(name, user, enc=\(aqssh\-rsa\(aq, comment=\(aq\(aq, source=\(aq\(aq, options=None, config=\(aq.ssh/authorized_keys\(aq, fingerprint_hash_type=None, **kwargs)
Verifies that the specified SSH key is present for the specified user
.INDENT 7.0
.TP
.B name
The SSH key to manage
.TP
.B user
The user who owns the SSH authorized keys file to modify
.TP
.B enc
Defines what type of key is being used, can be ed25519, ecdsa,
ssh\-rsa, ssh\-dss or any other type as of openssh server version 8.7.
.TP
.B comment
The comment to be placed with the SSH public key
.TP
.B source
The source file for the key(s). Can contain any number of public keys,
in standard \(dqauthorized_keys\(dq format. If this is set, comment and enc
will be ignored.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The source file must contain keys in the format \fB<enc> <key>
<comment>\fP\&. If you have generated a keypair using PuTTYgen, then you
will need to do the following to retrieve an OpenSSH\-compatible public
key.
.INDENT 0.0
.IP 1. 3
In PuTTYgen, click \fBLoad\fP, and select the \fIprivate\fP key file (not
the public key), and click \fBOpen\fP\&.
.IP 2. 3
Copy the public key from the box labeled \fBPublic key for pasting
into OpenSSH authorized_keys file\fP\&.
.IP 3. 3
Paste it into a new file.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B options
The options passed to the key, pass a list object
.TP
.B config
The location of the authorized keys file relative to the user\(aqs home
directory, defaults to \(dq.ssh/authorized_keys\(dq. Token expansion %u and
%h for username and home path supported.
.TP
.B fingerprint_hash_type
The public key fingerprint hash type that the public key fingerprint
was originally hashed with. This defaults to \fBsha256\fP if not specified.
.UNINDENT
.UNINDENT
.SS salt.states.ssh_known_hosts
.SS Control of SSH known_hosts entries
.sp
Manage the information stored in the known_hosts files.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
github.com:
  ssh_known_hosts:
    \- present
    \- user: root
    \- fingerprint: 16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48
    \- fingerprint_hash_type: md5

example.com:
  ssh_known_hosts:
    \- absent
    \- user: root
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ssh_known_hosts.absent(name, user=None, config=None)
Verifies that the specified host is not known by the given user
.INDENT 7.0
.TP
.B name
The host name
Note that only single host names are supported.  If foo.example.com
and bar.example.com are the same machine and you need to exclude both,
you will need one Salt state for each.
.TP
.B user
The user who owns the ssh authorized keys file to modify
.TP
.B config
The location of the authorized keys file relative to the user\(aqs home
directory, defaults to \(dq.ssh/known_hosts\(dq. If no user is specified,
defaults to \(dq/etc/ssh/ssh_known_hosts\(dq. If present, must be an
absolute path when a user is not specified.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.ssh_known_hosts.present(name, user=None, fingerprint=None, key=None, port=None, enc=None, config=None, hash_known_hosts=True, timeout=5, fingerprint_hash_type=None)
Verifies that the specified host is known by the specified user
.sp
On many systems, specifically those running with openssh 4 or older, the
\fBenc\fP option must be set, only openssh 5 and above can detect the key
type.
.INDENT 7.0
.TP
.B name
The name of the remote host (e.g. \(dqgithub.com\(dq)
Note that only a single hostname is supported, if foo.example.com and
bar.example.com have the same host you will need two separate Salt
States to represent them.
.TP
.B user
The user who owns the ssh authorized keys file to modify
.TP
.B fingerprint
The fingerprint of the key which must be present in the known_hosts
file (optional if key specified)
.TP
.B key
The public key which must be present in the known_hosts file
(optional if fingerprint specified)
.TP
.B port
optional parameter, port which will be used to when requesting the
public key from the remote host, defaults to port 22.
.TP
.B enc
Defines what type of key is being used, can be ed25519, ecdsa,
ssh\-rsa, ssh\-dss or any other type as of openssh server version 8.7.
.TP
.B config
The location of the authorized keys file relative to the user\(aqs home
directory, defaults to \(dq.ssh/known_hosts\(dq. If no user is specified,
defaults to \(dq/etc/ssh/ssh_known_hosts\(dq. If present, must be an
absolute path when a user is not specified.
.TP
.B hash_known_hosts
True
Hash all hostnames and addresses in the known hosts file.
.TP
.B timeout
int
Set the timeout for connection attempts.  If \fBtimeout\fP seconds have
elapsed since a connection was initiated to a host or since the last
time anything was read from that host, then the connection is closed
and the host in question considered unavailable.  Default is 5 seconds.
.sp
New in version 2016.3.0.

.TP
.B fingerprint_hash_type
The public key fingerprint hash type that the public key fingerprint
was originally hashed with. This defaults to \fBsha256\fP if not specified.
.sp
New in version 2016.11.4.

.sp
Changed in version 2017.7.0: default changed from \fBmd5\fP to \fBsha256\fP

.UNINDENT
.UNINDENT
.SS salt.states.stateconf
.SS Stateconf System
.sp
The stateconf system is intended for use only with the stateconf renderer. This
State module presents the set function. This function does not execute any
functionality, but is used to interact with the stateconf renderer.
.INDENT 0.0
.TP
.B salt.states.stateconf.context(name, **kwargs)
No\-op state to support state config via the stateconf renderer.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.stateconf.set(name, **kwargs)
No\-op state to support state config via the stateconf renderer.
.UNINDENT
.SS salt.states.status
.sp
Minion status monitoring
.sp
Maps to the \fIstatus\fP execution module.
.INDENT 0.0
.TP
.B salt.states.status.loadavg(name, maximum=None, minimum=None)
Return the current load average for the specified minion. Available values
for name are \fI1\-min\fP, \fI5\-min\fP and \fI15\-min\fP\&. \fIminimum\fP and \fImaximum\fP values
should be passed in as strings.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.status.process(name)
Return whether the specified signature is found in the process tree. This
differs slightly from the services states, in that it may refer to a
process that is not managed via the init system.
.UNINDENT
.SS salt.states.statuspage
.SS StatusPage
.sp
Manage the \fI\%StatusPage\fP configuration.
.sp
In the minion configuration file, the following block is required:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
statuspage:
  api_key: <API_KEY>
  page_id: <PAGE_ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.states.statuspage.create(name, endpoint=\(aqincidents\(aq, api_url=None, page_id=None, api_key=None, api_version=None, **kwargs)
Insert a new entry under a specific endpoint.
.INDENT 7.0
.TP
.B endpoint: incidents
Insert under this specific endpoint.
.TP
.B page_id
Page ID. Can also be specified in the config file.
.TP
.B api_key
API key. Can also be specified in the config file.
.TP
.B api_version: 1
API version. Can also be specified in the config file.
.TP
.B api_url
Custom API URL in case the user has a StatusPage service running in a custom environment.
.TP
.B kwargs
Other params.
.UNINDENT
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
create\-my\-component:
    statuspage.create:
        \- endpoint: components
        \- name: my component
        \- group_id: 993vgplshj12
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.statuspage.delete(name, endpoint=\(aqincidents\(aq, id=None, api_url=None, page_id=None, api_key=None, api_version=None)
Remove an entry from an endpoint.
.INDENT 7.0
.TP
.B endpoint: incidents
Request a specific endpoint.
.TP
.B page_id
Page ID. Can also be specified in the config file.
.TP
.B api_key
API key. Can also be specified in the config file.
.TP
.B api_version: 1
API version. Can also be specified in the config file.
.TP
.B api_url
Custom API URL in case the user has a StatusPage service running in a custom environment.
.UNINDENT
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
delete\-my\-component:
    statuspage.delete:
        \- endpoint: components
        \- id: ftgks51sfs2d
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.statuspage.managed(name, config, api_url=None, page_id=None, api_key=None, api_version=None, pace=1, allow_empty=False)
Manage the StatusPage configuration.
.INDENT 7.0
.TP
.B config
Dictionary with the expected configuration of the StatusPage.
The main level keys of this dictionary represent the endpoint name.
If a certain endpoint does not exist in this structure, it will be ignored / not configured.
.TP
.B page_id
Page ID. Can also be specified in the config file.
.TP
.B api_key
API key. Can also be specified in the config file.
.TP
.B api_version: 1
API version. Can also be specified in the config file.
.TP
.B api_url
Custom API URL in case the user has a StatusPage service running in a custom environment.
.TP
.B pace: 1
Max requests per second allowed by the API.
.TP
.B allow_empty: False
Allow empty config.
.UNINDENT
.sp
SLS example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
my\-statuspage\-config:
    statuspage.managed:
        \- config:
            components:
                \- name: component1
                  group_id: uy4g37rf
                \- name: component2
                  group_id: 3n4uyu4gf
            incidents:
                \- name: incident1
                  status: resolved
                  impact: major
                  backfilled: false
                \- name: incident2
                  status: investigating
                  impact: minor
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.statuspage.update(name, endpoint=\(aqincidents\(aq, id=None, api_url=None, page_id=None, api_key=None, api_version=None, **kwargs)
Update attribute(s) of a specific endpoint.
.INDENT 7.0
.TP
.B id
The unique ID of the endpoint entry.
.TP
.B endpoint: incidents
Endpoint name.
.TP
.B page_id
Page ID. Can also be specified in the config file.
.TP
.B api_key
API key. Can also be specified in the config file.
.TP
.B api_version: 1
API version. Can also be specified in the config file.
.TP
.B api_url
Custom API URL in case the user has a StatusPage service running in a custom environment.
.UNINDENT
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
update\-my\-incident:
    statuspage.update:
        \- id: dz959yz2nd4l
        \- status: resolved
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.supervisord
.SS Interaction with the Supervisor daemon
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
wsgi_server:
  supervisord.running:
    \- require:
      \- pkg: supervisor
    \- watch:
      \- file: /etc/nginx/sites\-enabled/wsgi_server.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.supervisord.dead(name, user=None, conf_file=None, bin_env=None, **kwargs)
Ensure the named service is dead (not running).
.INDENT 7.0
.TP
.B name
Service name as defined in the supervisor configuration file
.TP
.B user
Name of the user to run the supervisorctl command
.sp
New in version 0.17.0.

.TP
.B conf_file
path to supervisorctl config file
.TP
.B bin_env
path to supervisorctl bin or path to virtualenv with supervisor
installed
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.supervisord.mod_watch(name, restart=True, update=False, user=None, conf_file=None, bin_env=None, **kwargs)
The supervisord watcher, called to invoke the watch command.
Always restart on watch
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state exists to support special handling of the \fBwatch\fP
\fI\%requisite\fP\&. It should not be called directly.
.sp
Parameters for this function should be set by the state being triggered.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.supervisord.running(name, restart=False, update=False, user=None, conf_file=None, bin_env=None, **kwargs)
Ensure the named service is running.
.INDENT 7.0
.TP
.B name
Service name as defined in the supervisor configuration file
.TP
.B restart
Whether to force a restart
.TP
.B update
Whether to update the supervisor configuration.
.TP
.B user
Name of the user to run the supervisorctl command
.sp
New in version 0.17.0.

.TP
.B conf_file
path to supervisorctl config file
.TP
.B bin_env
path to supervisorctl bin or path to virtualenv with supervisor
installed
.UNINDENT
.UNINDENT
.SS salt.states.svn
.SS Manage SVN repositories
.sp
Manage repository checkouts via the svn vcs system. Note that subversion must
be installed for these states to be available, so svn states should include a
requisite to a pkg.installed state for the package which provides subversion
(\fBsubversion\fP in most cases). Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
subversion:
  pkg.installed

http://unladen\-swallow.googlecode.com/svn/trunk/:
  svn.latest:
    \- target: /tmp/swallow
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.svn.dirty(name, target, user=None, username=None, password=None, ignore_unversioned=False)
Determine if the working directory has been changed.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.svn.export(name, target=None, rev=None, user=None, username=None, password=None, force=False, overwrite=False, externals=True, trust=False, trust_failures=None)
Export a file or directory from an SVN repository
.INDENT 7.0
.TP
.B name
Address and path to the file or directory to be exported.
.TP
.B target
Name of the target directory where the checkout will put the working
directory
.TP
.B rev
None
The name revision number to checkout. Enable \(dqforce\(dq if the directory
already exists.
.TP
.B user
None
Name of the user performing repository management operations
.TP
.B username
None
The user to access the name repository with. The svn default is the
current user
.TP
.B password
Connect to the Subversion server with this password
.sp
New in version 0.17.0.

.TP
.B force
False
Continue if conflicts are encountered
.TP
.B overwrite
False
Overwrite existing target
.TP
.B externals
True
Change to False to not checkout or update externals
.TP
.B trust
False
Automatically trust the remote server. SVN\(aqs \-\-trust\-server\-cert
.TP
.B trust_failures
None
Comma\-separated list of certificate trust failures, that shall be
ignored. This can be used if trust=True is not sufficient. The
specified string is passed to SVN\(aqs \-\-trust\-server\-cert\-failures
option as\-is.
.sp
New in version 2019.2.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.svn.latest(name, target=None, rev=None, user=None, username=None, password=None, force=False, externals=True, trust=False, trust_failures=None)
Checkout or update the working directory to the latest revision from the
remote repository.
.INDENT 7.0
.TP
.B name
Address of the name repository as passed to \(dqsvn checkout\(dq
.TP
.B target
Name of the target directory where the checkout will put the working
directory
.TP
.B rev
None
The name revision number to checkout. Enable \(dqforce\(dq if the directory
already exists.
.TP
.B user
None
Name of the user performing repository management operations
.TP
.B username
None
The user to access the name repository with. The svn default is the
current user
.TP
.B password
Connect to the Subversion server with this password
.sp
New in version 0.17.0.

.TP
.B force
False
Continue if conflicts are encountered
.TP
.B externals
True
Change to False to not checkout or update externals
.TP
.B trust
False
Automatically trust the remote server. SVN\(aqs \-\-trust\-server\-cert
.TP
.B trust_failures
None
Comma\-separated list of certificate trust failures, that shall be
ignored. This can be used if trust=True is not sufficient. The
specified string is passed to SVN\(aqs \-\-trust\-server\-cert\-failures
option as\-is.
.sp
New in version 2019.2.0.

.UNINDENT
.UNINDENT
.SS salt.states.sysctl
.SS Configuration of the kernel using sysctl
.sp
Control the kernel sysctl system.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vm.swappiness:
  sysctl.present:
    \- value: 20
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.sysctl.present(name, value, config=None)
Ensure that the named sysctl value is set in memory and persisted to the
named configuration file. The default sysctl configuration file is
/etc/sysctl.conf
.INDENT 7.0
.TP
.B name
The name of the sysctl value to edit
.TP
.B value
The sysctl value to apply. Make sure to set the value to the correct expected
output for systctl or reading the respective /proc/sys file. For example, instead
of adding the value \fI1,2,3\fP you might need to write \fI1\-3\fP\&. If you do not set
the correct value, Salt will continue to return with changes.
.TP
.B config
The location of the sysctl configuration file. If not specified, the
proper location will be detected based on platform.
.UNINDENT
.UNINDENT
.SS salt.states.sysfs
.SS Configuration of the kernel using sysfs
.sp
Control the kernel object attributes exported by sysfs
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
kernel/mm/transparent_hugepage/enabled
  sysfs.present:
    \- value: never
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3006.0.

.INDENT 0.0
.TP
.B salt.states.sysfs.present(name, value, config=None)
Ensure that the named sysfs attribute is set with the defined value
.INDENT 7.0
.TP
.B name
The name of the sysfs attribute to edit
.TP
.B value
The sysfs value to apply
.UNINDENT
.UNINDENT
.SS salt.states.syslog_ng
.SS State module for syslog_ng
.INDENT 0.0
.TP
.B maintainer
Tibor Benke <\fI\%btibi@sch.bme.hu\fP>
.TP
.B maturity
new
.TP
.B depends
cmd, ps, syslog_ng
.TP
.B platform
all
.UNINDENT
.INDENT 0.0
.TP
.B Users can generate syslog\-ng configuration files from YAML format or use
plain ones and reload, start, or stop their syslog\-ng by using this module.
.UNINDENT
.SS Details
.sp
The service module is not available on all system, so this module includes
\fI\%syslog_ng.reloaded\fP,
\fI\%syslog_ng.stopped\fP,
and \fI\%syslog_ng.started\fP functions.
If the service module is available on the computers, users should use that.
.sp
Users can generate syslog\-ng configuration with
\fI\%syslog_ng.config\fP function.
For more information see \fI\%syslog\-ng state usage\fP\&.
.SS Syslog\-ng configuration file format
.sp
The syntax of a configuration snippet in syslog\-ng.conf:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
object_type object_id {<options>};
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
These constructions are also called statements. There are options inside of them:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
option(parameter1, parameter2); option2(parameter1, parameter2);
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
You can find more information about syslog\-ng\(aqs configuration syntax in the
Syslog\-ng Admin guide:
\fI\%http://www.balabit.com/sites/default/files/documents/syslog\-ng\-ose\-3.5\-guides/en/syslog\-ng\-ose\-v3.5\-guide\-admin/html\-single/index.html#syslog\-ng.conf.5\fP
.INDENT 0.0
.TP
.B salt.states.syslog_ng.config(name, config, write=True)
Builds syslog\-ng configuration.
.sp
name : the id of the Salt document
config : the parsed YAML code
write : if True, it writes  the config into the configuration file,
otherwise just returns it
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.syslog_ng.reloaded(name)
Reloads syslog\-ng.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.syslog_ng.started(name=None, user=None, group=None, chroot=None, caps=None, no_caps=False, pidfile=None, enable_core=False, fd_limit=None, verbose=False, debug=False, trace=False, yydebug=False, persist_file=None, control=None, worker_threads=None, *args, **kwargs)
Ensures, that syslog\-ng is started via the given parameters.
.sp
Users shouldn\(aqt use this function, if the service module is available on
their system.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.syslog_ng.stopped(name=None)
Kills syslog\-ng.
.UNINDENT
.SS salt.states.sysrc
.sp
State to work with sysrc
.INDENT 0.0
.TP
.B salt.states.sysrc.absent(name, **kwargs)
Ensure a sysrc variable is absent.
.INDENT 7.0
.TP
.B name
The variable name to set
.TP
.B file
(optional) The rc file to add the variable to.
.TP
.B jail
(option) the name or JID of the jail to set the value in.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.sysrc.managed(name, value, **kwargs)
Ensure a sysrc variable is set to a specific value.
.INDENT 7.0
.TP
.B name
The variable name to set
.TP
.B value
Value to set the variable to
.TP
.B file
(optional) The rc file to add the variable to.
.TP
.B jail
(option) the name or JID of the jail to set the value in.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
syslogd:
  sysrc.managed:
    \- name: syslogd_flags
    \- value: \-ss
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.telemetry_alert
.SS Manage Telemetry alert configurations
.sp
New in version 2016.3.0.

.sp
Create, Update and destroy Mongo Telemetry alert configurations.
.sp
This module uses requests, which can be installed via package, or pip.
.sp
This module accepts explicit credential (telemetry api key)
or can also read api key credentials from a pillar.
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ensure telemetry alert X is defined on deployment Y:
    telemetry_alert.present:
        \- deployment_id: \(dqrs\-XXXXXX\(dq
        \- metric_name: \(dqtestMetric\(dq
        \- alert_config:
           max: 1
           filter:  SERVER_ROLE_MONGOD_PRIMARY
           escalate_to: \(dqexample@pagerduty.com\(dq
        \- name: \(dq**MANAGED BY ORCA DO NOT EDIT BY HAND** manages alarm on testMetric\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.telemetry_alert.absent(name, deployment_id, metric_name, api_key=None, profile=\(aqtelemetry\(aq)
Ensure the telemetry alert config is deleted
.INDENT 7.0
.TP
.B name
An optional description of the alarms (not currently supported by telemetry API)
.TP
.B deployment_id
Specifies the ID of the root deployment resource
(replica set cluster or sharded cluster) to which this alert definition is attached
.TP
.B metric_name
Specifies the unique ID of the metric to whose values these thresholds will be applied
.TP
.B api_key
Telemetry api key for the user
.TP
.B profile
A dict with telemetry config data. If present, will be used instead of
api_key.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.telemetry_alert.present(name, deployment_id, metric_name, alert_config, api_key=None, profile=\(aqtelemetry\(aq)
Ensure the telemetry alert exists.
.INDENT 7.0
.TP
.B name
An optional description of the alarm (not currently supported by telemetry API)
.TP
.B deployment_id
Specifies the ID of the root deployment resource
(replica set cluster or sharded cluster) to which this alert definition is attached
.TP
.B metric_name
Specifies the unique ID of the metric to whose values these thresholds will be applied
.TP
.B alert_config: Is a list of dictionaries where each dict contains the following fields:
.INDENT 7.0
.TP
.B filter
By default the alert will apply to the deployment and all its constituent resources.
If the alert only applies to a subset of those resources, a filter may be specified to narrow this scope.
.TP
.B min
the smallest \(dqok\(dq value the metric may take on; if missing or null, no minimum is enforced.
.TP
.B max
the largest \(dqok\(dq value the metric may take on; if missing or null, no maximum is enforced.
.TP
.B notify_all
Used to indicate if you want to alert both onCallEngineer and apiNotifications
.UNINDENT
.TP
.B api_key
Telemetry api key for the user
.TP
.B profile
A dict of telemetry config information.  If present, will be used instead of
api_key.
.UNINDENT
.UNINDENT
.SS salt.states.test
.SS Test States
.sp
Provide test case states that enable easy testing of things to do with state
calls, e.g. running, calling, logging, output filtering etc.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
always\-passes\-with\-any\-kwarg:
  test.nop:
    \- name: foo
    \- something: else
    \- foo: bar

always\-passes:
  test.succeed_without_changes:
    \- name: foo

always\-fails:
  test.fail_without_changes:
    \- name: foo

always\-changes\-and\-succeeds:
  test.succeed_with_changes:
    \- name: foo

always\-changes\-and\-fails:
  test.fail_with_changes:
    \- name: foo

my\-custom\-combo:
  test.configurable_test_state:
    \- name: foo
    \- changes: True
    \- result: False
    \- comment: bar.baz
    \- warnings: A warning

is\-pillar\-foo\-present\-and\-bar\-is\-int:
  test.check_pillar:
    \- present:
        \- foo
    \- integer:
        \- bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You may also use these states for controlled failure in state definitions, for example if certain conditions in
pillar or grains do not apply. The following state definition will fail with a message \(dqOS not supported!\(dq when
\fIgrains[\(aqos\(aq]\fP is neither Ubuntu nor CentOS:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% if grains[\(aqos\(aq] in [\(aqUbuntu\(aq, \(aqCentOS\(aq] %}

# Your state definitions go here

{% else %}
failure:
  test.fail_without_changes:
    \- name: \(dqOS not supported!\(dq
    \- failhard: True
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.test.check_pillar(name, present=None, boolean=None, integer=None, string=None, listing=None, dictionary=None, verbose=False)
Checks the presence and, optionally, the type of given keys in Pillar
.sp
Supported kwargs for types are:
\- boolean (bool)
\- integer (int)
\- string (str)
\- listing (list)
\- dictionary (dict)
.sp
Checking for None type pillars is not implemented yet.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
is\-pillar\-foo\-present\-and\-bar\-is\-int:
  test.check_pillar:
    \- present:
        \- foo
    \- integer:
        \- bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.test.configurable_test_state(name, changes=True, result=True, comment=\(aq\(aq, warnings=None, allow_test_mode_failure=False)
New in version 2014.7.0.

.sp
A configurable test state which allows for more control over the return
data
.INDENT 7.0
.TP
.B name
A unique string to serve as the state\(aqs ID
.TP
.B changes
True
Controls whether or not the state reports that there were changes.
There are three supported values for this argument:
.INDENT 7.0
.IP \(bu 2
If \fBTrue\fP, the state will report changes
.IP \(bu 2
If \fBFalse\fP, the state will report no changes
.IP \(bu 2
If \fB\(dqRandom\(dq\fP, the state will randomly report either changes or no
changes.
.UNINDENT
.TP
.B result
True
Controls the result for for the state. Like \fBchanges\fP, there are
three supported values for this argument:
.INDENT 7.0
.IP \(bu 2
If \fBTrue\fP, the state will report a \fBTrue\fP result
.IP \(bu 2
If \fBFalse\fP, the state will report a \fBFalse\fP result
.IP \(bu 2
If \fB\(dqRandom\(dq\fP, the state will randomly report either \fBTrue\fP
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The result will be reported as \fBNone\fP if \fIall\fP of the following
are true:
.sp
1. The state is being run in test mode (i.e. \fBtest=True\fP on the
CLI)
.INDENT 0.0
.IP 2. 3
\fBresult\fP is \fBTrue\fP (either explicitly, or via being set to
\fB\(dqRandom\(dq\fP)
.IP 3. 3
\fBchanges\fP is \fBTrue\fP (either explicitly, or via being set to
\fB\(dqRandom\(dq\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B comment
\(dq\(dq
Comment field field for the state. By default, this is an empty string.
.TP
.B warnings
A string (or a list of strings) to fill the warnings field with.
Default is None
.sp
New in version 3000.

.TP
.B allow_test_mode_failure
When False, running this state in test mode can only return a True
or None result. When set to True and result is set to False, the
test mode result will be False. Default is False
.sp
New in version 3007.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.test.fail_with_changes(name, **kwargs)
New in version 2014.7.0.

.sp
Returns \fBFalse\fP with an non\-empty \fBchanges\fP dictionary. Useful for
testing requisites.
.INDENT 7.0
.TP
.B name
A unique string to serve as the state\(aqs ID
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.test.fail_without_changes(name, **kwargs)
New in version 2014.7.0.

.sp
Returns failure
.INDENT 7.0
.TP
.B name
A unique string to serve as the state\(aqs ID
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.test.mod_watch(name, sfun=None, **kwargs)
Call this function via a watch statement
.sp
New in version 2014.7.0.

.sp
Any parameters in the state return dictionary can be customized by adding
the keywords \fBresult\fP, \fBcomment\fP, and \fBchanges\fP\&.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
this_state_will_return_changes:
  test.succeed_with_changes

this_state_will_NOT_return_changes:
  test.succeed_without_changes

this_state_is_watching_another_state:
  test.succeed_without_changes:
    \- comment: \(aqThis is a custom comment\(aq
    \- watch:
      \- test: this_state_will_return_changes
      \- test: this_state_will_NOT_return_changes

this_state_is_also_watching_another_state:
  test.succeed_without_changes:
    \- watch:
      \- test: this_state_will_NOT_return_changes
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.test.nop(name, **kwargs)
New in version 2015.8.1.

.sp
A no\-op state that does nothing. Useful in conjunction with the \fBuse\fP
requisite, or in templates which could otherwise be empty due to jinja
rendering.
.INDENT 7.0
.TP
.B name
A unique string to serve as the state\(aqs ID
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.test.show_notification(name, text=None, **kwargs)
New in version 2015.8.0.

.sp
Simple notification using text argument.
.INDENT 7.0
.TP
.B name
A unique string to serve as the state\(aqs ID
.TP
.B text
Text to return in the comment field
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.test.succeed_with_changes(name, **kwargs)
New in version 2014.7.0.

.sp
Returns \fBTrue\fP with an non\-empty \fBchanges\fP dictionary. Useful for
testing requisites.
.INDENT 7.0
.TP
.B name
A unique string to serve as the state\(aqs ID
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.test.succeed_without_changes(name, **kwargs)
New in version 2014.7.0.

.sp
Returns successful
.INDENT 7.0
.TP
.B name
A unique string to serve as the state\(aqs ID
.UNINDENT
.UNINDENT
.SS salt.states.testinframod
.INDENT 0.0
.TP
.B salt.states.testinframod.camel_to_snake_case(camel_input)
Converts camelCase (or CamelCase) to snake_case.
From \fI\%https://codereview.stackexchange.com/questions/185966/functions\-to\-convert\-camelcase\-strings\-to\-snake\-case\fP
.INDENT 7.0
.TP
.B Parameters
\fBcamel_input\fP (\fI\%str\fP) \-\- The camelcase or CamelCase string to convert to snake_case
.UNINDENT
.sp
:return str
.UNINDENT
.SS salt.states.timezone
.SS Management of timezones
.sp
The timezone can be managed for the system:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
America/Denver:
  timezone.system
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The system and the hardware clock are not necessarily set to the same time.
By default, the hardware clock is set to localtime, meaning it is set to the
same time as the system clock. If \fIutc\fP is set to True, then the hardware clock
will be set to UTC, and the system clock will be an offset of that.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
America/Denver:
  timezone.system:
    \- utc: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The Ubuntu community documentation contains an explanation of this setting, as
it applies to systems that dual\-boot with Windows. This is explained in greater
detail \fI\%here\fP\&.
.INDENT 0.0
.TP
.B salt.states.timezone.system(name, utc=True)
Set the timezone for the system.
.INDENT 7.0
.TP
.B name
The name of the timezone to use (e.g.: America/Denver)
.TP
.B utc
Whether or not to set the hardware clock to UTC (default is True)
.UNINDENT
.UNINDENT
.SS salt.states.tls
.SS Enforce state for SSL/TLS
.INDENT 0.0
.TP
.B salt.states.tls.valid_certificate(name, weeks=0, days=0, hours=0, minutes=0, seconds=0)
Verify that a TLS certificate is valid now and (optionally) will be valid
for the time specified through weeks, days, hours, minutes, and seconds.
.UNINDENT
.SS salt.states.tomcat
.SS Manage Apache Tomcat web applications
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This state requires the Tomcat Manager webapp to be installed and running.
.UNINDENT
.UNINDENT
.sp
The following grains/pillars must be set for communication with Tomcat Manager
to work:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tomcat\-manager:
    user: \(aqtomcat\-manager\(aq
    passwd: \(aqPassw0rd\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configuring Tomcat Manager
.sp
To manage webapps via the Tomcat Manager, you\(aqll need to configure
a valid user in the file \fBconf/tomcat\-users.xml\fP\&.
.sp
conf/tomcat\-users.xml
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
 <?xml version=\(aq1.0\(aq encoding=\(aqutf\-8\(aq?>
 <tomcat\-users>
     <role rolename=\(dqmanager\-script\(dq/>
     <user username=\(dqtomcat\-manager\(dq password=\(dqPassw0rd\(dq roles=\(dqmanager\-script\(dq/>
 </tomcat\-users>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Notes
.INDENT 0.0
.IP \(bu 2
Using multiple versions (aka. parallel deployments) on the same context
path is not supported.
.IP \(bu 2
More information about the Tomcat Manager:
\fI\%http://tomcat.apache.org/tomcat\-7.0\-doc/manager\-howto.html\fP
.IP \(bu 2
If you use only this module for deployments you might want to restrict
access to the manager so it\(aqs only accessible via localhost.
For more info: \fI\%http://tomcat.apache.org/tomcat\-7.0\-doc/manager\-howto.html#Configuring_Manager_Application_Access\fP
.IP \(bu 2
.INDENT 2.0
.TP
.B Last tested on:
.INDENT 7.0
.TP
.B Tomcat Version:
Apache Tomcat/7.0.54
.TP
.B JVM Vendor:
Oracle Corporation
.TP
.B JVM Version:
1.8.0_101\-b13
.TP
.B OS Architecture:
amd64
.TP
.B OS Name:
Linux
.TP
.B OS Version:
3.10.0\-327.22.2.el7.x86_64
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.tomcat.mod_watch(name, url=\(aqhttp://localhost:8080/manager\(aq, timeout=180)
The tomcat watcher, called to invoke the watch command.
When called, it will reload the webapp in question
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state exists to support special handling of the \fBwatch\fP
\fI\%requisite\fP\&. It should not be called directly.
.sp
Parameters for this function should be set by the state being triggered.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.tomcat.undeployed(name, url=\(aqhttp://localhost:8080/manager\(aq, timeout=180)
Enforce that the WAR will be undeployed from the server
.INDENT 7.0
.TP
.B name
The context path to undeploy.
.TP
.B url
\fI\%http://localhost:8080/manager\fP
The URL of the server with the Tomcat Manager webapp.
.TP
.B timeout
180
Timeout for HTTP request to the Tomcat Manager.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins:
  tomcat.undeployed:
    \- name: /ran
    \- require:
      \- service: application\-service
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.tomcat.wait(name, url=\(aqhttp://localhost:8080/manager\(aq, timeout=180)
Wait for the Tomcat Manager to load.
.sp
Notice that if tomcat is not running we won\(aqt wait for it start and the
state will fail. This state can be required in the tomcat.war_deployed
state to make sure tomcat is running and that the manager is running as
well and ready for deployment.
.INDENT 7.0
.TP
.B url
\fI\%http://localhost:8080/manager\fP
The URL of the server with the Tomcat Manager webapp.
.TP
.B timeout
180
Timeout for HTTP request to the Tomcat Manager.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
tomcat\-service:
  service.running:
    \- name: tomcat
    \- enable: True

wait\-for\-tomcatmanager:
  tomcat.wait:
    \- timeout: 300
    \- require:
      \- service: tomcat\-service

jenkins:
  tomcat.war_deployed:
    \- name: /ran
    \- war: salt://jenkins\-1.2.4.war
    \- require:
      \- tomcat: wait\-for\-tomcatmanager
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.tomcat.war_deployed(name, war, force=False, url=\(aqhttp://localhost:8080/manager\(aq, timeout=180, temp_war_location=None, version=True)
Enforce that the WAR will be deployed and started in the context path,
while making use of WAR versions in the filename.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For more info about Tomcats file paths and context naming, please see
\fI\%http://tomcat.apache.org/tomcat\-7.0\-doc/config/context.html#Naming\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The context path to deploy (incl. forward slash) the WAR to.
.TP
.B war
Absolute path to WAR file (should be accessible by the user running
Tomcat) or a path supported by the \fBsalt.modules.cp.get_url\fP function.
.TP
.B force
False
Force deployment even if the version strings are the same.
Disabled by default.
.TP
.B url
\fI\%http://localhost:8080/manager\fP
The URL of the Tomcat Web Application Manager.
.TP
.B timeout
180
Timeout for HTTP requests to the Tomcat Manager.
.TP
.B temp_war_location
None
Use another location to temporarily copy the WAR file to.
By default the system\(aqs temp directory is used.
.TP
.B version
\(aq\(aq
Specify the WAR version.  If this argument is provided, it overrides
the version encoded in the WAR file name, if one is present.
.sp
New in version 2015.8.6.

.sp
Use \fBFalse\fP or blank value to prevent guessing the version and keeping it blank.
.sp
New in version 2016.11.0.

.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins:
  tomcat.war_deployed:
    \- name: /salt\-powered\-jenkins
    \- war: salt://jenkins\-1.2.4.war
    \- require:
      \- service: application\-service
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Be aware that in the above example the WAR \fBjenkins\-1.2.4.war\fP will
be deployed to the context path \fBsalt\-powered\-jenkins##1.2.4\fP\&. To avoid this
either specify a version yourself, or set version to \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.trafficserver
.SS Control Apache Traffic Server
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B salt.states.trafficserver.bounce_cluster(name)
Bounce all Traffic Server nodes in the cluster. Bouncing Traffic Server
shuts down and immediately restarts Traffic Server, node\-by\-node.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
bounce_ats_cluster:
  trafficserver.bounce_cluster
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.trafficserver.bounce_local(name, drain=False)
Bounce Traffic Server on the local node. Bouncing Traffic Server shuts down
and immediately restarts the Traffic Server node.
.sp
This option modifies the behavior of traffic_line \-b and traffic_line \-L
such that traffic_server is not shut down until the number of active client
connections drops to the number given by the
proxy.config.restart.active_client_threshold configuration variable.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
bounce_ats_local:
  trafficserver.bounce_local

bounce_ats_local:
  trafficserver.bounce_local
    \- drain: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.trafficserver.clear_cluster(name)
Clears accumulated statistics on all nodes in the cluster.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
clear_ats_cluster:
  trafficserver.clear_cluster
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.trafficserver.clear_node(name)
Clears accumulated statistics on the local node.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
clear_ats_node:
  trafficserver.clear_node
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.trafficserver.config(name, value)
Set Traffic Server configuration variable values.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
proxy.config.proxy_name:
  trafficserver.config:
    \- value: cdn.site.domain.tld

OR

traffic_server_setting:
  trafficserver.config:
    \- name: proxy.config.proxy_name
    \- value: cdn.site.domain.tld
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.trafficserver.offline(name, path)
Mark a cache storage device as offline. The storage is identified by a path
which must match exactly a path specified in storage.config. This removes
the storage from the cache and redirects requests that would have used this
storage to other storage. This has exactly the same effect as a disk
failure for that storage. This does not persist across restarts of the
traffic_server process.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
offline_ats_path:
  trafficserver.offline:
    \- path: /path/to/cache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.trafficserver.refresh(name)
Initiate a Traffic Server configuration file reread. Use this command to
update the running configuration after any configuration file modification.
.sp
The timestamp of the last reconfiguration event (in seconds since epoch) is
published in the proxy.node.config.reconfigure_time metric.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
refresh_ats:
  trafficserver.refresh
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.trafficserver.restart_cluster(name)
Restart the traffic_manager process and the traffic_server process on all
the nodes in a cluster.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
restart_ats_cluster:
  trafficserver.restart_cluster
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.trafficserver.restart_local(name, drain=False)
Restart the traffic_manager and traffic_server processes on the local node.
.sp
This option modifies the behavior of traffic_line \-b and traffic_line \-L
such that traffic_server is not shut down until the number of active client
connections drops to the number given by the
proxy.config.restart.active_client_threshold configuration variable.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
restart_ats_local:
  trafficserver.restart_local

restart_ats_local_drain:
  trafficserver.restart_local
    \- drain: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.trafficserver.shutdown(name)
Shut down Traffic Server on the local node.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
shutdown_ats:
  trafficserver.shutdown
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.trafficserver.startup(name)
Start Traffic Server on the local node.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
startup_ats:
  trafficserver.startup
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.trafficserver.zero_cluster(name)
Reset performance statistics to zero across the cluster.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zero_ats_cluster:
  trafficserver.zero_cluster
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.trafficserver.zero_node(name)
Reset performance statistics to zero on the local node.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zero_ats_node:
  trafficserver.zero_node
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.tuned
.sp
Interface to Red Hat tuned\-adm module
.INDENT 0.0
.TP
.B maintainer
Syed Ali <\fI\%alicsyed@gmail.com\fP>
.TP
.B maturity
new
.TP
.B depends
cmd.run
.TP
.B platform
Linux
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.tuned.off(name=None)
Turns \(aqtuned\(aq off.
Example tuned.sls file for turning tuned off:
.INDENT 7.0
.TP
.B tuned:
tuned.off: []
.TP
.B To see a valid list of states call execution module:
\fI\%tuned.list\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.tuned.profile(name)
This state module allows you to modify system tuned parameters
.sp
Example tuned.sls file to set profile to virtual\-guest
.INDENT 7.0
.TP
.B tuned:
.INDENT 7.0
.TP
.B tuned.profile
.INDENT 7.0
.IP \(bu 2
name: virtual\-guest
.UNINDENT
.UNINDENT
.TP
.B name
tuned profile name to set the system to
.TP
.B To see a valid list of states call execution module:
\fI\%tuned.list\fP
.UNINDENT
.UNINDENT
.SS salt.states.uptime
.SS Monitor Web Server with Uptime
.sp
\fI\%Uptime\fP is an open source
remote monitoring application using Node.js, MongoDB, and Twitter
Bootstrap.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This state module is beta. It might be changed later to include
more or less automation.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This state module requires a pillar to specify the location of
your uptime install
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
uptime:
  application_url: \(dqhttp://uptime\-url.example.org\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
url:
  uptime.monitored
url/sitemap.xml:
  uptime.monitored:
     \- polling: 600 # every hour
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.uptime.monitored(name, **params)
Makes sure an URL is monitored by uptime. Checks if URL is already
monitored, and if not, adds it.
.UNINDENT
.SS salt.states.user
.SS Management of user accounts.
.sp
The user module is used to create and manage user settings, users can be set
as either absent or present
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fred:
  user.present:
    \- fullname: Fred Jones
    \- shell: /bin/zsh
    \- home: /home/fred
    \- uid: 4000
    \- gid: 4000
    \- groups:
      \- wheel
      \- storage
      \- games

testuser:
  user.absent
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.user.absent(name, purge=False, force=False, local=False)
Ensure that the named user is absent
.INDENT 7.0
.TP
.B name
The name of the user to remove
.TP
.B purge
Set purge to True to delete all of the user\(aqs files as well as the user,
Default is \fBFalse\fP\&.
.TP
.B force
If the user is logged in, the absent state will fail. Set the force
option to True to remove the user even if they are logged in. Not
supported in FreeBSD and Solaris, Default is \fBFalse\fP\&.
.TP
.B local (Only on systems with luserdel available):
Ensure the user account is removed locally ignoring global account management
(default is False).
.sp
New in version 3007.0.

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.user.present(name, uid=None, gid=None, usergroup=None, groups=None, optional_groups=None, remove_groups=True, home=None, createhome=True, password=None, hash_password=False, enforce_password=True, empty_password=False, shell=None, unique=True, system=False, fullname=None, roomnumber=None, workphone=None, homephone=None, other=None, loginclass=None, date=None, mindays=None, maxdays=None, inactdays=None, warndays=None, expire=None, win_homedrive=None, win_profile=None, win_logonscript=None, win_description=None, nologinit=False, allow_uid_change=False, allow_gid_change=False, password_lock=None, local=False)
Ensure that the named user is present with the specified properties
.INDENT 7.0
.TP
.B name
The name of the user to manage
.TP
.B uid
The user id to assign. If not specified, and the user does not exist,
then the next available uid will be assigned.
.TP
.B gid
The id of the default group to assign to the user. Either a group name
or gid can be used. If not specified, and the user does not exist, then
the next available gid will be assigned.
.TP
.B allow_uid_change
False
Set to \fBTrue\fP to allow the state to update the uid.
.sp
New in version 2018.3.1.

.TP
.B allow_gid_change
False
Set to \fBTrue\fP to allow the state to update the gid.
.sp
New in version 2018.3.1.

.TP
.B usergroup
If True, a group with the same name as the user will be created. If
False, a group with the same name as the user will not be created. The
default is distribution\-specific. See the USERGROUPS_ENAB section of
the login.defs(5) man page.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Only supported on GNU/Linux distributions
.UNINDENT
.UNINDENT
.sp
New in version 3001.

.TP
.B groups
A list of groups to assign the user to, pass a list object. If a group
specified here does not exist on the minion, the state will fail.
If set to the empty list, the user will be removed from all groups
except the default group. If unset, salt will assume current groups
are still wanted, and will make no changes to them.
.TP
.B optional_groups
A list of groups to assign the user to, pass a list object. If a group
specified here does not exist on the minion, the state will silently
ignore it.
.UNINDENT
.sp
NOTE: If the same group is specified in both \(dqgroups\(dq and
\(dqoptional_groups\(dq, then it will be assumed to be required and not optional.
.INDENT 7.0
.TP
.B remove_groups
Remove groups that the user is a member of that weren\(aqt specified in
the state, Default is \fBTrue\fP\&.
.TP
.B home
The custom login directory of user. Uses default value of underlying
system if not set. Notice that this directory does not have to exist.
This also the location of the home directory to create if createhome is
set to True.
.TP
.B createhome
True
If set to \fBFalse\fP, the home directory will not be created if it
doesn\(aqt already exist.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Not supported on Windows or Mac OS.
.sp
Additionally, parent directories will \fInot\fP be created. The parent
directory for \fBhome\fP must already exist.
.UNINDENT
.UNINDENT
.TP
.B nologinit
False
If set to \fBTrue\fP, it will not add the user to lastlog and faillog
databases.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Not supported on Windows.
.UNINDENT
.UNINDENT
.TP
.B password
A password hash to set for the user. This field is only supported on
Linux, FreeBSD, NetBSD, OpenBSD, and Solaris. If the \fBempty_password\fP
argument is set to \fBTrue\fP then \fBpassword\fP is ignored.
For Windows this is the plain text password.
For Linux, the hash can be generated with \fBmkpasswd \-m sha\-256\fP\&.
.UNINDENT
.sp
Changed in version 0.16.0: BSD support added.

.INDENT 7.0
.TP
.B hash_password
Set to True to hash the clear text password. Default is \fBFalse\fP\&.
.TP
.B enforce_password
Set to False to keep the password from being changed if it has already
been set and the password hash differs from what is specified in the
\(dqpassword\(dq field. This option will be ignored if \(dqpassword\(dq is not
specified, Default is \fBTrue\fP\&.
.TP
.B empty_password
Set to True to enable password\-less login for user, Default is \fBFalse\fP\&.
.TP
.B password_lock
Set to \fBFalse\fP to unlock a user\(aqs password (or Windows account). On
non\-Windows systems ONLY, this parameter can be set to \fBTrue\fP to lock
a user\(aqs password. Default is \fBNone\fP, which does not take action on
the password (or Windows account).
.sp
New in version 3006.0.

.TP
.B shell
The login shell, defaults to the system default shell
.TP
.B unique
Require a unique UID, Default is \fBTrue\fP\&.
.TP
.B system
Choose UID in the range of FIRST_SYSTEM_UID and LAST_SYSTEM_UID, Default is
\fBFalse\fP\&.
.TP
.B loginclass
The login class, defaults to empty
(BSD only)
.UNINDENT
.sp
User comment field (GECOS) support (currently Linux, BSD, and MacOS
only):
.sp
The below values should be specified as strings to avoid ambiguities when
the values are loaded. (Especially the phone and room number fields which
are likely to contain numeric data)
.INDENT 7.0
.TP
.B fullname
The user\(aqs full name
.TP
.B roomnumber
The user\(aqs room number (not supported in MacOS)
.TP
.B workphone
The user\(aqs work phone number (not supported in MacOS)
.TP
.B homephone
The user\(aqs home phone number (not supported in MacOS)
.TP
.B other
The user\(aqs other attribute (not supported in MacOS)
If GECOS field contains more than 4 commas, this field will have the rest of \(aqem
.UNINDENT
.sp
Changed in version 2014.7.0: Shadow attribute support added.

.sp
Shadow attributes support (currently Linux only):
.sp
The below values should be specified as integers.
.INDENT 7.0
.TP
.B date
Date of last change of password, represented in days since epoch
(January 1, 1970).
.TP
.B mindays
The minimum number of days between password changes.
.TP
.B maxdays
The maximum number of days between password changes.
.TP
.B inactdays
The number of days after a password expires before an account is
locked.
.TP
.B warndays
Number of days prior to maxdays to warn users.
.TP
.B expire
Date that account expires, represented in days since epoch (January 1,
1970).
.TP
.B local (Only on systems with luseradd available):
Create the user account locally ignoring global account management
(default is False).
.sp
New in version 3007.0.

.UNINDENT
.sp
The below parameters apply to windows only:
.INDENT 7.0
.TP
.B win_homedrive (Windows Only)
The drive letter to use for the home directory. If not specified the
home directory will be a unc path. Otherwise the home directory will be
mapped to the specified drive. Must be a letter followed by a colon.
Because of the colon, the value must be surrounded by single quotes. ie:
\fB\- win_homedrive: \(aqU:\(aq\fP
.sp
Changed in version 2015.8.0.

.TP
.B win_profile (Windows Only)
The custom profile directory of the user. Uses default value of
underlying system if not set.
.sp
Changed in version 2015.8.0.

.TP
.B win_logonscript (Windows Only)
The full path to the logon script to run when the user logs in.
.sp
Changed in version 2015.8.0.

.TP
.B win_description (Windows Only)
A brief description of the purpose of the users account.
.sp
Changed in version 2015.8.0.

.UNINDENT
.UNINDENT
.SS salt.states.vagrant
.SS Manage Vagrant VMs
.sp
Manange execution of Vagrant virtual machines on Salt minions.
.sp
\fI\%Vagrant\fP is a tool for building and managing virtual machine environments.
It can use various providers, such as \fI\%VirtualBox\fP, \fI\%Docker\fP, or \fI\%VMware\fP, to run its VMs.
Vagrant provides some of the functionality of a light\-weight hypervisor.
The combination of Salt modules, Vagrant running on the host, and a
virtual machine provider, gives hypervisor\-like functionality for
developers who use Vagrant to quickly define their virtual environments.
.INDENT 0.0
.INDENT 3.5
New in version 2018.3.0.

.UNINDENT
.UNINDENT
.sp
The configuration of each virtual machine is defined in a file named
\fBVagrantfile\fP which must exist on the VM host machine.
The essential parameters which must be defined to start a Vagrant VM
are the directory where the \fBVagrantfile\fP is located (argument \fBcwd:\fP),
and the username which will own the \fBVagrant box\fP created for the VM (
argument \fBvagrant_runas:\fP).
.sp
A single \fBVagrantfile\fP may define one or more virtual machines.
Use the \fBmachine\fP argument to chose among them. The default (blank)
value will select the \fBprimary\fP (or only) machine in the Vagrantfile.
.sp
[NOTE:] Each virtual machine host must have the following:
.INDENT 0.0
.IP \(bu 2
a working salt\-minion
.IP \(bu 2
a Salt sdb database configured for \fBvagrant_sdb_data\fP\&.
.IP \(bu 2
Vagrant installed and the \fBvagrant\fP command working
.IP \(bu 2
a suitable VM provider
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# EXAMPLE:
# file /etc/salt/minion.d/vagrant_sdb.conf on the host computer
#  \-\- this sdb database is required by the Vagrant module \-\-
vagrant_sdb_data:  # The sdb database must have this name.
  driver: sqlite3  # Let\(aqs use SQLite to store the data ...
  database: /var/cache/salt/vagrant.sqlite  # ... in this file ...
  table: sdb  # ... using this table name.
  create_table: True  # if not present
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.vagrant.destroyed(name)
Stops a VM (or VMs) and removes all references to it (them). (Runs \fBvagrant destroy\fP\&.)
.sp
Subsequent re\-use of the same machine will requere another operation of \fBvagrant.running\fP
or a call to the \fBvagrant.init\fP execution module.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- May be a Salt_id node or a POSIX\-style wildcard string.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
node_name:
  vagrant.destroyed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.vagrant.initialized(name, **kwargs)
Defines a new VM with specified arguments, but does not start it.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- the Salt_id node name you wish your VM to have.
.UNINDENT
.sp
Each machine must be initialized individually using this function
or the \(dqvagrant.running\(dq function, or the vagrant.init execution module call.
.sp
This command will not change the state of a running or paused machine.
.sp
Possible keyword arguments:
.INDENT 7.0
.IP \(bu 2
cwd: The directory (path) containing the Vagrantfile
.IP \(bu 2
machine: (\(aq\(aq) the name of the machine (in the Vagrantfile) if not default
.IP \(bu 2
vagrant_runas: (\(aqroot\(aq) the username who owns the vagrantbox file
.IP \(bu 2
vagrant_provider: the provider to run the VM (usually \(aqvirtualbox\(aq)
.IP \(bu 2
vm: ({}) a dictionary containing these or other keyword arguments
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
node_name1:
  vagrant.initialized
    \- cwd: /projects/my_project
    \- vagrant_runas: my_username
    \- machine: machine1

node_name2:
  vagrant.initialized
    \- cwd: /projects/my_project
    \- vagrant_runas: my_username
    \- machine: machine2

start_nodes:
  vagrant.start:
    \- name: node_name?
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.vagrant.paused(name)
Stores the state of a VM (or VMs) for fast restart. (Runs \fBvagrant suspend\fP\&.)
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- May be a Salt_id node or a POSIX\-style wildcard string.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
node_name:
  vagrant.paused
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.vagrant.powered_off(name)
Stops a VM (or VMs) by power off.  (Runs \fBvagrant halt\fP\&.)
.sp
This method is provided for compatibility with other VM\-control
state modules. For Vagrant, the action is identical with \fBstopped\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- May be a Salt_id node or a POSIX\-style wildcard string.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
node_name:
  vagrant.unpowered
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.vagrant.rebooted(name)
Reboots a running, paused, or stopped VM (or VMs). (Runs \fBvagrant reload\fP\&.)
.sp
The  will re\-run the provisioning
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- May be a Salt_id node or a POSIX\-style wildcard string.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
node_name:
  vagrant.reloaded
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.vagrant.running(name, **kwargs)
Defines and starts a new VM with specified arguments, or restart a
VM (or group of VMs). (Runs \fBvagrant up\fP\&.)
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- the Salt_id node name you wish your VM to have.
.UNINDENT
.sp
If \fBname\fP contains a \(dq?\(dq or \(dq*\(dq  then it will re\-start a group of VMs
which have been paused or stopped.
.sp
Each machine must be initially started individually using this function
or the vagrant.init execution module call.
.sp
[NOTE:] Keyword arguments are silently ignored when re\-starting an existing VM.
.sp
Possible keyword arguments:
.INDENT 7.0
.IP \(bu 2
cwd: The directory (path) containing the Vagrantfile
.IP \(bu 2
machine: (\(aq\(aq) the name of the machine (in the Vagrantfile) if not default
.IP \(bu 2
vagrant_runas: (\(aqroot\(aq) the username who owns the vagrantbox file
.IP \(bu 2
vagrant_provider: the provider to run the VM (usually \(aqvirtualbox\(aq)
.IP \(bu 2
vm: ({}) a dictionary containing these or other keyword arguments
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
node_name:
  vagrant.running
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
node_name:
  vagrant.running:
    \- cwd: /projects/my_project
    \- vagrant_runas: my_username
    \- machine: machine1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.vagrant.stopped(name)
Stops a VM (or VMs) by shutting it (them) down nicely. (Runs \fBvagrant halt\fP)
.INDENT 7.0
.TP
.B Parameters
\fBname\fP \-\- May be a Salt_id node, or a POSIX\-style wildcard string.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
node_name:
  vagrant.stopped
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.vault
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%vault Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
States for managing Hashicorp Vault.
Currently handles policies.
Configuration instructions are documented in the \fI\%execution module docs\fP\&.
.INDENT 0.0
.TP
.B maintainer
SaltStack
.TP
.B maturity
new
.TP
.B platform
all
.UNINDENT
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B salt.states.vault.policy_absent(name)
Ensure a Vault policy with the given name and rules is absent.
.INDENT 7.0
.TP
.B name
The name of the policy
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.vault.policy_present(name, rules)
Ensure a Vault policy with the given name and rules is present.
.INDENT 7.0
.TP
.B name
The name of the policy
.TP
.B rules
Rules formatted as in\-line HCL
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
demo\-policy:
  vault.policy_present:
    \- name: foo/bar
    \- rules: |
        path \(dqsecret/top\-secret/*\(dq {
          policy = \(dqdeny\(dq
        }
        path \(dqsecret/not\-very\-secret/*\(dq {
          policy = \(dqwrite\(dq
        }
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.vbox_guest
.sp
VirtualBox Guest Additions installer state
.INDENT 0.0
.TP
.B salt.states.vbox_guest.additions_installed(name, reboot=False, upgrade_os=False)
Ensure that the VirtualBox Guest Additions are installed. Uses the CD,
connected by VirtualBox.
.INDENT 7.0
.TP
.B name
The name has no functional value and is only used as a tracking
reference.
.TP
.B reboot
False
Restart OS to complete installation.
.TP
.B upgrade_os
False
Upgrade OS (to ensure the latests version of kernel and developer tools
installed).
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.vbox_guest.additions_removed(name, force=False)
Ensure that the VirtualBox Guest Additions are removed. Uses the CD,
connected by VirtualBox.
.sp
To connect VirtualBox Guest Additions via VirtualBox graphical interface
press \(aqHost+D\(aq (\(aqHost\(aq is usually \(aqRight Ctrl\(aq).
.INDENT 7.0
.TP
.B name
The name has no functional value and is only used as a tracking
reference.
.TP
.B force
Force VirtualBox Guest Additions removing.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.vbox_guest.grant_access_to_shared_folders_to(name, users=None)
Grant access to auto\-mounted shared folders to the users.
.sp
User is specified by its name. To grant access for several users use
argument \fIusers\fP\&.
.INDENT 7.0
.TP
.B name
Name of the user to grant access to auto\-mounted shared folders to.
.TP
.B users
List of names of users to grant access to auto\-mounted shared folders to.
If specified, \fIname\fP will not be taken into account.
.UNINDENT
.UNINDENT
.SS salt.states.victorops
.SS Create an Event in VictorOps
.sp
New in version 2015.8.0.

.sp
This state is useful for creating events on the
VictorOps service during state runs.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
webserver\-warning\-message:
  victorops.create_event:
    \- message_type: \(aqCRITICAL\(aq
    \- entity_id: \(aqwebserver/diskspace\(aq
    \- state_message: \(aqWebserver diskspace is low.\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.victorops.create_event(name, message_type, routing_key=\(aqeveryone\(aq, **kwargs)
Create an event on the VictorOps service
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
webserver\-warning\-message:
  victorops.create_event:
    \- message_type: \(aqCRITICAL\(aq
    \- entity_id: \(aqwebserver/diskspace\(aq
    \- state_message: \(aqWebserver diskspace is low.\(aq

database\-server\-warning\-message:
  victorops.create_event:
    \- message_type: \(aqWARNING\(aq
    \- entity_id: \(aqdb_server/load\(aq
    \- state_message: \(aqDatabase Server load is high.\(aq
    \- entity_is_host: True
    \- entity_display_name: \(aqdbdserver.example.com\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following parameters are required:
.INDENT 7.0
.TP
.B name
This is a short description of the event.
.TP
.B message_type
One of the following values: INFO, WARNING, ACKNOWLEDGEMENT, CRITICAL, RECOVERY.
.UNINDENT
.sp
The following parameters are optional:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B routing_key
The key for where messages should be routed. By default, sent to \(aqeveryone\(aq route.
.TP
.B entity_id
The name of alerting entity. If not provided, a random name will be assigned.
.TP
.B timestamp
Timestamp of the alert in seconds since epoch. Defaults to the time the alert is received at VictorOps.
.TP
.B timestamp_fmt
The date format for the timestamp parameter.  Defaults to \(aq\(aq%Y\-%m\-%dT%H:%M:%S\(aq.
.TP
.B state_start_time
The time this entity entered its current state (seconds since epoch). Defaults to the time alert is received.
.TP
.B state_start_time_fmt
The date format for the timestamp parameter. Defaults to \(aq%Y\-%m\-%dT%H:%M:%S\(aq.
.TP
.B state_message
Any additional status information from the alert item.
.TP
.B entity_is_host
Used within VictorOps to select the appropriate display format for the incident.
.TP
.B entity_display_name
Used within VictorOps to display a human\-readable name for the entity.
.TP
.B ack_message
A user entered comment for the acknowledgment.
.TP
.B ack_author
The user that acknowledged the incident.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.virt
.SS Manage virt
.sp
For the key certificate this state uses the external pillar in the master to call
for the generation and signing of certificates for systems running libvirt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
libvirt_keys:
  virt.keys
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.defined(name, cpu=None, mem=None, vm_type=None, disk_profile=None, disks=None, nic_profile=None, interfaces=None, graphics=None, seed=True, install=True, pub_key=None, priv_key=None, connection=None, username=None, password=None, os_type=None, arch=None, boot=None, numatune=None, boot_dev=None, hypervisor_features=None, clock=None, serials=None, consoles=None, stop_on_reboot=False, live=True, host_devices=None, autostart=False)
Starts an existing guest, or defines and starts a new VM with specified arguments.
.sp
New in version 3001.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name of the virtual machine to run
.IP \(bu 2
\fBcpu\fP \-\-
.sp
Number of virtual CPUs to assign to the virtual machine or a dictionary with detailed information to configure
cpu model and topology, numa node tuning, cpu tuning and iothreads allocation. The structure of the dictionary is
documented in \fI\%cpu parameters definition\fP\&.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
cpu:
  placement: static
  cpuset: 0\-11
  current: 5
  maximum: 12
  vcpus:
    0:
      enabled: \(aqyes\(aq
      hotpluggable: \(aqno\(aq
      order: 1
    1:
      enabled: \(aqno\(aq
      hotpluggable: \(aqyes\(aq
  match: minimum
  mode: custom
  check: full
  vendor: Intel
  model:
    name: core2duo
    fallback: allow
    vendor_id: GenuineIntel
  topology:
    sockets: 1
    cores: 12
    threads: 1
  cache:
    level: 3
    mode: emulate
  feature:
    policy: optional
    name: lahf_lm
  numa:
    0:
       cpus: 0\-3
       memory: 1g
       discard: \(aqyes\(aq
       distances:
         0: 10     # sibling id : value
         1: 21
         2: 31
         3: 41
    1:
       cpus: 4\-6
       memory: 1g
       memAccess: shared
       distances:
         0: 21
         1: 10
         2: 21
         3: 31
  tuning:
       vcpupin:
         0: 1\-4,^2  # vcpuid : cpuset
         1: 0,1
         2: 2,3
         3: 0,4
       emulatorpin: 1\-3
       iothreadpin:
         1: 5,6    # iothread id: cpuset
         2: 7,8
       shares: 2048
       period: 1000000
       quota: \-1
       global_period: 1000000
       global_quota: \-1
       emulator_period: 1000000
       emulator_quota: \-1
       iothread_period: 1000000
       iothread_quota: \-1
       vcpusched:
         \- scheduler: fifo
           priority: 1
         \- scheduler: fifo
           priority: 2
           vcpus: 1\-3
         \- scheduler: rr
           priority: 3
           vcpus: 4
       iothreadsched:
         \- scheduler: batch
           iothreads: 2
       emulatorsched:
         scheduler: idle
       cachetune:
         0\-3:      # vcpus set
           0:      # cache id
             level: 3
             type: both
             size: 4
           1:
             level: 3
             type: both
             size: 6
           monitor:
             1: 3
             0\-3: 3
         4\-5:
           monitor:
             4: 3  # vcpus: level
             5: 3
       memorytune:
         0\-3:      # vcpus set
           0: 60   # node id: bandwidth
         4\-5:
           0: 60
  iothreads: 4
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBmem\fP \-\-
.sp
Amount of memory to allocate to the virtual machine in MiB. Since 3002, a dictionary can be used to
contain detailed configuration which support memory allocation or tuning. Supported parameters are \fBboot\fP,
\fBcurrent\fP, \fBmax\fP, \fBslots\fP, \fBhard_limit\fP, \fBsoft_limit\fP, \fBswap_hard_limit\fP, \fBmin_guarantee\fP,
\fBhugepages\fP ,  \fBnosharepages\fP, \fBlocked\fP, \fBsource\fP, \fBaccess\fP, \fBallocation\fP and \fBdiscard\fP\&. The structure
of the dictionary is documented in  \fI\%Memory parameter definition\fP\&. Both decimal and binary base are supported. Detail unit
specification is documented  in \fI\%Units specification\fP\&. Please note that the value for \fBslots\fP must be an integer.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
boot: 1g
current: 1g
max: 1g
slots: 10
hard_limit: 1024
soft_limit: 512m
swap_hard_limit: 1g
min_guarantee: 512mib
hugepages:
  \- size: 2m
  \- nodeset: 0\-2
    size: 1g
  \- nodeset: 3
    size: 2g
nosharepages: True
locked: True
source: file
access: shared
allocation: immediate
discard: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3002.


.IP \(bu 2
\fBvm_type\fP \-\- force virtual machine type for the new VM. The default value is taken from
the host capabilities. This could be useful for example to use \fB\(aqqemu\(aq\fP type instead
of the \fB\(aqkvm\(aq\fP one.
.IP \(bu 2
\fBdisk_profile\fP \-\- Name of the disk profile to use for the new virtual machine
.IP \(bu 2
\fBdisks\fP \-\- List of disk to create for the new virtual machine.
See \fI\%Disks Definitions\fP for more details on the items on this list.
.IP \(bu 2
\fBnic_profile\fP \-\- Name of the network interfaces profile to use for the new virtual machine
.IP \(bu 2
\fBinterfaces\fP \-\- List of network interfaces to create for the new virtual machine.
See \fI\%Network Interfaces Definitions\fP for more details on the items on this list.
.IP \(bu 2
\fBgraphics\fP \-\- Graphics device to create for the new virtual machine.
See \fI\%Graphics Definition\fP for more details on this dictionary
.IP \(bu 2
\fBsaltenv\fP \-\- Fileserver environment (Default: \fB\(aqbase\(aq\fP).
See \fI\%cp module for more details\fP
.IP \(bu 2
\fBseed\fP \-\- \fBTrue\fP to seed the disk image. Only used when the \fBimage\fP parameter is provided.
(Default: \fBTrue\fP)
.IP \(bu 2
\fBinstall\fP \-\- install salt minion if absent (Default: \fBTrue\fP)
.IP \(bu 2
\fBpub_key\fP \-\- public key to seed with (Default: \fBNone\fP)
.IP \(bu 2
\fBpriv_key\fP \-\- public key to seed with (Default: \fBNone\fP)
.IP \(bu 2
\fBseed_cmd\fP \-\- Salt command to execute to seed the image. (Default: \fB\(aqseed.apply\(aq\fP)
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.IP \(bu 2
\fBos_type\fP \-\- type of virtualization as found in the \fB//os/type\fP element of the libvirt definition.
The default value is taken from the host capabilities, with a preference for \fBhvm\fP\&.
Only used when creating a new virtual machine.
.IP \(bu 2
\fBarch\fP \-\- architecture of the virtual machine. The default value is taken from the host capabilities,
but \fBx86_64\fP is prefed over \fBi686\fP\&. Only used when creating a new virtual machine.
.IP \(bu 2
\fBboot\fP \-\-
.sp
Specifies kernel, initial ramdisk and kernel command line parameters for the virtual machine.
This is an optional parameter, all of the keys are optional within the dictionary.
.sp
Refer to \fI\%Boot parameters definition\fP for the complete boot parameters description.
.sp
To update any boot parameters, specify the new path for each. To remove any boot parameters,
pass a None object, for instance: \(aqkernel\(aq: \fBNone\fP\&.
.sp
New in version 3000.


.IP \(bu 2
\fBboot_dev\fP \-\-
.sp
Space separated list of devices to boot from sorted by decreasing priority.
Values can be \fBhd\fP, \fBfd\fP, \fBcdrom\fP or \fBnetwork\fP\&.
.sp
By default, the value will \fB\(dqhd\(dq\fP\&.
.sp
New in version 3002.


.IP \(bu 2
\fBnumatune\fP \-\-
.sp
The optional numatune element provides details of how to tune the performance of a NUMA host via controlling NUMA
policy for domain process. The optional \fBmemory\fP element specifies how to allocate memory for the domain process
on a NUMA host. \fBmemnode\fP elements can specify memory allocation policies per each guest NUMA node. The definition
used in the dictionary can be found at \fI\%cpu parameters definition\fP\&.
.sp
New in version 3003.

.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(aqmemory\(aq: {\(aqmode\(aq: \(aqstrict\(aq, \(aqnodeset\(aq: \(aq0\-11\(aq},
    \(aqmemnodes\(aq: {0: {\(aqmode\(aq: \(aqstrict\(aq, \(aqnodeset\(aq: 1}, 1: {\(aqmode\(aq: \(aqpreferred\(aq, \(aqnodeset\(aq: 2}}
}
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBhypervisor_features\fP \-\-
.sp
Enable or disable hypervisor\-specific features on the virtual machine.
.sp
New in version 3003.

.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
hypervisor_features:
  kvm\-hint\-dedicated: True
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBclock\fP \-\-
.sp
Configure the guest clock.
The value is a dictionary with the following keys:
.INDENT 2.0
.TP
.B adjustment
time adjustment in seconds or \fBreset\fP
.TP
.B utc
set to \fBFalse\fP to use the host local time as the guest clock. Defaults to \fBTrue\fP\&.
.TP
.B timezone
synchronize the guest to the correspding timezone
.TP
.B timers
a dictionary associating the timer name with its configuration.
This configuration is a dictionary with the properties \fBtrack\fP, \fBtickpolicy\fP,
\fBcatchup\fP, \fBfrequency\fP, \fBmode\fP, \fBpresent\fP, \fBslew\fP, \fBthreshold\fP and \fBlimit\fP\&.
See \fI\%libvirt time keeping documentation\fP for the possible values.
.UNINDENT
.sp
New in version 3003.

.sp
Set the clock to local time using an offset in seconds
\&.. code\-block:: yaml
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B clock:
adjustment: 3600
utc: False
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Set the clock to a specific time zone:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
clock:
  timezone: CEST
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBserials\fP \-\-
.sp
Dictionary providing details on the serials connection to create. (Default: \fBNone\fP)
See \fI\%Serials and Consoles Definitions\fP for more details on the possible values.
.sp
New in version 3003.


.IP \(bu 2
\fBconsoles\fP \-\-
.sp
Dictionary providing details on the consoles device to create. (Default: \fBNone\fP)
See \fI\%Serials and Consoles Definitions\fP for more details on the possible values.
.sp
New in version 3003.


.IP \(bu 2
\fBstop_on_reboot\fP \-\-
.sp
If set to \fBTrue\fP the guest will stop instead of rebooting.
This is specially useful when creating a virtual machine with an installation cdrom or
an autoinstallation needing a special first boot configuration.
Defaults to \fBFalse\fP
.sp
New in version 3003.


.IP \(bu 2
\fBlive\fP \-\-
.sp
If set to \fBFalse\fP the changes will not be applied live to the running instance, but will
only apply at the next start. Note that reboot will not take those changes.
.sp
New in version 3003.


.IP \(bu 2
\fBhost_devices\fP \-\-
.sp
List of host devices to passthrough to the guest.
The value is a list of device names as provided by the \fI\%node_devices()\fP function.
(Default: \fBNone\fP)
.sp
New in version 3003.


.IP \(bu 2
\fBautostart\fP \-\- If set to \fBTrue\fP the host will start the guest after boot.
(Default: \fBFalse\fP)
.UNINDENT
.UNINDENT
.sp
Example States
.sp
Make sure a virtual machine called \fBdomain_name\fP is defined:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
domain_name:
  virt.defined:
    \- cpu: 2
    \- mem: 2048
    \- boot_dev: network hd
    \- disk_profile: prod
    \- disks:
      \- name: system
        size: 8192
        overlay_image: True
        pool: default
        image: /path/to/image.qcow2
      \- name: data
        size: 16834
    \- nic_profile: prod
    \- interfaces:
      \- name: eth0
        mac: 01:23:45:67:89:AB
      \- name: eth1
        type: network
        source: admin
    \- graphics:
        type: spice
        listen:
            type: address
            address: 192.168.0.125
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.keys(name, basepath=\(aq/etc/pki\(aq, **kwargs)
Manage libvirt keys.
.INDENT 7.0
.TP
.B name
The name variable used to track the execution
.TP
.B basepath
Defaults to \fB/etc/pki\fP, this is the root location used for libvirt
keys on the hypervisor
.UNINDENT
.sp
The following parameters are optional:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B country
The country that the certificate should use.  Defaults to US.
.UNINDENT
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B state
The state that the certificate should use.  Defaults to Utah.
.UNINDENT
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B locality
The locality that the certificate should use.
Defaults to Salt Lake City.
.UNINDENT
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B organization
The organization that the certificate should use.
Defaults to Salted.
.UNINDENT
.sp
New in version 2018.3.0.

.INDENT 0.0
.TP
.B expiration_days
The number of days that the certificate should be valid for.
Defaults to 365 days (1 year)
.UNINDENT
.sp
New in version 2018.3.0.

.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.network_defined(name, bridge, forward, vport=None, tag=None, ipv4_config=None, ipv6_config=None, autostart=True, connection=None, username=None, password=None, mtu=None, domain=None, nat=None, interfaces=None, addresses=None, physical_function=None, dns=None)
Defines a new network with specified arguments.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Network name
.IP \(bu 2
\fBbridge\fP \-\- Bridge name
.IP \(bu 2
\fBforward\fP \-\-
.sp
Forward mode(bridge, router, nat)
.sp
Changed in version 3003: a \fBNone\fP value creates an isolated network with no forwarding at all


.IP \(bu 2
\fBvport\fP \-\-
.sp
Virtualport type (Default: \fB\(aqNone\(aq\fP)
The value can also be a dictionary with \fBtype\fP and \fBparameters\fP keys.
The \fBparameters\fP value is a dictionary of virtual port parameters.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- vport:
    type: openvswitch
    parameters:
      interfaceid: 09b11c53\-8b5c\-4eeb\-8f00\-d84eaa0aaa4f
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3003: possible dictionary value


.IP \(bu 2
\fBtag\fP \-\-
.sp
Vlan tag (Default: \fB\(aqNone\(aq\fP)
The value can also be a dictionary with the \fBtags\fP and optional \fBtrunk\fP keys.
\fBtrunk\fP is a boolean value indicating whether to use VLAN trunking.
\fBtags\fP is a list of dictionaries with keys \fBid\fP and \fBnativeMode\fP\&.
The \fBnativeMode\fP value can be one of \fBtagged\fP or \fBuntagged\fP\&.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- tag:
    trunk: True
    tags:
      \- id: 42
        nativeMode: untagged
      \- id: 47
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3003: possible dictionary value


.IP \(bu 2
\fBipv4_config\fP \-\- IPv4 network configuration. See the
\fI\%virt.network_define\fP
function corresponding parameter documentation
for more details on this dictionary.
(Default: None).
.IP \(bu 2
\fBipv6_config\fP \-\- IPv6 network configuration. See the \fI\%virt.network_define\fP function corresponding parameter documentation
for more details on this dictionary.
(Default: None).
.IP \(bu 2
\fBautostart\fP \-\- Network autostart (default \fB\(aqTrue\(aq\fP)
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.IP \(bu 2
\fBmtu\fP \-\-
.sp
size of the Maximum Transmission Unit (MTU) of the network.
(default \fBNone\fP)
.sp
New in version 3003.


.IP \(bu 2
\fBdomain\fP \-\-
.sp
DNS domain name of the DHCP server.
The value is a dictionary with a mandatory \fBname\fP property and an optional \fBlocalOnly\fP boolean one.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- domain:
    name: lab.acme.org
    localOnly: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBnat\fP \-\-
.sp
addresses and ports to route in NAT forward mode.
The value is a dictionary with optional keys \fBaddress\fP and \fBport\fP\&.
Both values are a dictionary with \fBstart\fP and \fBend\fP values.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: nat
\- nat:
    address:
      start: 1.2.3.4
      end: 1.2.3.10
    port:
      start: 500
      end: 1000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBinterfaces\fP \-\-
.sp
whitespace separated list of network interfaces devices that can be used for this network.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: passthrough
\- interfaces: \(dqeth10 eth11 eth12\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBaddresses\fP \-\-
.sp
whitespace separated list of addresses of PCI devices that can be used for this network in \fIhostdev\fP forward mode.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: hostdev
\- interfaces: \(dq0000:04:00.1 0000:e3:01.2\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBphysical_function\fP \-\-
.sp
device name of the physical interface to use in \fBhostdev\fP forward mode.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: hostdev
\- physical_function: \(dqeth0\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBdns\fP \-\-
.sp
virtual network DNS configuration
The value is a dictionary described in \fI\%DNS configuration definition\fP\&.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- dns:
    forwarders:
      \- domain: example.com
        addr: 192.168.1.1
      \- addr: 8.8.8.8
      \- domain: www.example.com
    txt:
      example.com: \(dqv=spf1 a \-all\(dq
      _http.tcp.example.com: \(dqname=value,paper=A4\(dq
    hosts:
      192.168.1.2:
        \- mirror.acme.lab
        \- test.acme.lab
    srvs:
      \- name: ldap
        protocol: tcp
        domain: ldapserver.example.com
        target: .
        port: 389
        priority: 1
        weight: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.UNINDENT
.UNINDENT
.sp
New in version 3001.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
network_name:
  virt.network_defined
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
network_name:
  virt.network_defined:
    \- bridge: main
    \- forward: bridge
    \- vport: openvswitch
    \- tag: 180
    \- autostart: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
network_name:
  virt.network_defined:
    \- bridge: natted
    \- forward: nat
    \- ipv4_config:
        cidr: 192.168.42.0/24
        dhcp_ranges:
          \- start: 192.168.42.10
            end: 192.168.42.25
          \- start: 192.168.42.100
            end: 192.168.42.150
    \- autostart: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.network_running(name, bridge, forward, vport=None, tag=None, ipv4_config=None, ipv6_config=None, autostart=True, connection=None, username=None, password=None, mtu=None, domain=None, nat=None, interfaces=None, addresses=None, physical_function=None, dns=None)
Defines and starts a new network with specified arguments.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Network name
.IP \(bu 2
\fBbridge\fP \-\- Bridge name
.IP \(bu 2
\fBforward\fP \-\-
.sp
Forward mode(bridge, router, nat)
.sp
Changed in version 3003: a \fBNone\fP value creates an isolated network with no forwarding at all


.IP \(bu 2
\fBvport\fP \-\-
.sp
Virtualport type (Default: \fB\(aqNone\(aq\fP)
The value can also be a dictionary with \fBtype\fP and \fBparameters\fP keys.
The \fBparameters\fP value is a dictionary of virtual port parameters.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- vport:
    type: openvswitch
    parameters:
      interfaceid: 09b11c53\-8b5c\-4eeb\-8f00\-d84eaa0aaa4f
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3003: possible dictionary value


.IP \(bu 2
\fBtag\fP \-\-
.sp
Vlan tag (Default: \fB\(aqNone\(aq\fP)
The value can also be a dictionary with the \fBtags\fP and optional \fBtrunk\fP keys.
\fBtrunk\fP is a boolean value indicating whether to use VLAN trunking.
\fBtags\fP is a list of dictionaries with keys \fBid\fP and \fBnativeMode\fP\&.
The \fBnativeMode\fP value can be one of \fBtagged\fP or \fBuntagged\fP\&.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- tag:
    trunk: True
    tags:
      \- id: 42
        nativeMode: untagged
      \- id: 47
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3003: possible dictionary value


.IP \(bu 2
\fBipv4_config\fP \-\-
.sp
IPv4 network configuration. See the :py:func\(gavirt.network_define
<salt.modules.virt.network_define>\(ga function corresponding parameter documentation
for more details on this dictionary.
(Default: None).
.sp
New in version 3000.


.IP \(bu 2
\fBipv6_config\fP \-\-
.sp
IPv6 network configuration. See the :py:func\(gavirt.network_define
<salt.modules.virt.network_define>\(ga function corresponding parameter documentation
for more details on this dictionary.
(Default: None).
.sp
New in version 3000.


.IP \(bu 2
\fBautostart\fP \-\- Network autostart (default \fB\(aqTrue\(aq\fP)
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBmtu\fP \-\-
.sp
size of the Maximum Transmission Unit (MTU) of the network.
(default \fBNone\fP)
.sp
New in version 3003.


.IP \(bu 2
\fBdomain\fP \-\-
.sp
DNS domain name of the DHCP server.
The value is a dictionary with a mandatory \fBname\fP property and an optional \fBlocalOnly\fP boolean one.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- domain:
    name: lab.acme.org
    localOnly: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBnat\fP \-\-
.sp
addresses and ports to route in NAT forward mode.
The value is a dictionary with optional keys \fBaddress\fP and \fBport\fP\&.
Both values are a dictionary with \fBstart\fP and \fBend\fP values.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: nat
\- nat:
    address:
      start: 1.2.3.4
      end: 1.2.3.10
    port:
      start: 500
      end: 1000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBinterfaces\fP \-\-
.sp
whitespace separated list of network interfaces devices that can be used for this network.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: passthrough
\- interfaces: \(dqeth10 eth11 eth12\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBaddresses\fP \-\-
.sp
whitespace separated list of addresses of PCI devices that can be used for this network in \fIhostdev\fP forward mode.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: hostdev
\- interfaces: \(dq0000:04:00.1 0000:e3:01.2\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBphysical_function\fP \-\-
.sp
device name of the physical interface to use in \fBhostdev\fP forward mode.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- forward: hostdev
\- physical_function: \(dqeth0\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.IP \(bu 2
\fBdns\fP \-\-
.sp
virtual network DNS configuration
The value is a dictionary described in \fI\%DNS configuration definition\fP\&.
(default \fBNone\fP)
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- dns:
    forwarders:
      \- domain: example.com
        addr: 192.168.1.1
      \- addr: 8.8.8.8
      \- domain: www.example.com
    txt:
      host.widgets.com.: \(dqprinter=lpr5\(dq
      example.com.: \(dqThis domain name is reserved for use in documentation\(dq
    hosts:
      192.168.1.2:
        \- mirror.acme.lab
        \- test.acme.lab
    srvs:
      \- name: ldap
        protocol: tcp
        domain: ldapserver.example.com
        target: .
        port: 389
        priority: 1
        weight: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3003.


.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
network_name:
  virt.network_running
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
network_name:
  virt.network_running:
    \- bridge: main
    \- forward: bridge
    \- vport: openvswitch
    \- tag: 180
    \- autostart: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
network_name:
  virt.network_running:
    \- bridge: natted
    \- forward: nat
    \- ipv4_config:
        cidr: 192.168.42.0/24
        dhcp_ranges:
          \- start: 192.168.42.10
            end: 192.168.42.25
          \- start: 192.168.42.100
            end: 192.168.42.150
    \- autostart: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.pool_defined(name, ptype=None, target=None, permissions=None, source=None, transient=False, autostart=True, connection=None, username=None, password=None)
Defines a new pool with specified arguments.
.sp
New in version 3001.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBptype\fP \-\- libvirt pool type
.IP \(bu 2
\fBtarget\fP \-\- full path to the target device or folder. (Default: \fBNone\fP)
.IP \(bu 2
\fBpermissions\fP \-\- target permissions. See \fI\%Permissions definition\fP for more details on this structure.
.IP \(bu 2
\fBsource\fP \-\- dictionary containing keys matching the \fBsource_*\fP parameters in function
\fI\%salt.modules.virt.pool_define()\fP\&.
.IP \(bu 2
\fBtransient\fP \-\- when set to \fBTrue\fP, the pool will be automatically undefined after being stopped. (Default: \fBFalse\fP)
.IP \(bu 2
\fBautostart\fP \-\- Whether to start the pool when booting the host. (Default: \fBTrue\fP)
.IP \(bu 2
\fBstart\fP \-\- When \fBTrue\fP, define and start the pool, otherwise the pool will be left stopped.
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pool_name:
  virt.pool_defined:
    \- ptype: netfs
    \- target: /mnt/cifs
    \- permissions:
        \- mode: 0770
        \- owner: 1000
        \- group: 100
    \- source:
        dir: samba_share
        hosts:
          \- one.example.com
          \- two.example.com
        format: cifs
    \- autostart: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.pool_deleted(name, purge=False, connection=None, username=None, password=None)
Deletes a virtual storage pool.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- the name of the pool to delete.
.IP \(bu 2
\fBpurge\fP \-\- if \fBTrue\fP, the volumes contained in the pool will be deleted as well as the pool itself.
Note that these will be lost for ever. If \fBFalse\fP the pool will simply be undefined.
(Default: \fBFalse\fP)
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
In order to be purged a storage pool needs to be running to get the list of volumes to delete.
.sp
Some libvirt storage drivers may not implement deleting, those actions are implemented on a
best effort idea. In any case check the result\(aqs comment property to see if any of the action
was unsupported.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pool_name:
  uyuni_virt.pool_deleted:
    \- purge: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3000.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.pool_running(name, ptype=None, target=None, permissions=None, source=None, transient=False, autostart=True, connection=None, username=None, password=None)
Defines and starts a new pool with specified arguments.
.sp
New in version 2019.2.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBptype\fP \-\- libvirt pool type
.IP \(bu 2
\fBtarget\fP \-\- full path to the target device or folder. (Default: \fBNone\fP)
.IP \(bu 2
\fBpermissions\fP \-\- target permissions. See \fI\%Permissions definition\fP for more details on this structure.
.IP \(bu 2
\fBsource\fP \-\- dictionary containing keys matching the \fBsource_*\fP parameters in function
\fI\%salt.modules.virt.pool_define()\fP\&.
.IP \(bu 2
\fBtransient\fP \-\- when set to \fBTrue\fP, the pool will be automatically undefined after being stopped. (Default: \fBFalse\fP)
.IP \(bu 2
\fBautostart\fP \-\- Whether to start the pool when booting the host. (Default: \fBTrue\fP)
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pool_name:
  virt.pool_running
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
pool_name:
  virt.pool_running:
    \- ptype: netfs
    \- target: /mnt/cifs
    \- permissions:
        \- mode: 0770
        \- owner: 1000
        \- group: 100
    \- source:
        dir: samba_share
        hosts:
          \- one.example.com
          \- two.example.com
        format: cifs
    \- autostart: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.powered_off(name, connection=None, username=None, password=None)
Stops a VM by power off.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
domain_name:
  virt.stopped
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.rebooted(name, connection=None, username=None, password=None)
Reboots VMs
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\-
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.reverted(name, snapshot=None, cleanup=False)
Deprecated since version 2016.3.0.

.sp
Reverts to the particular snapshot.
.sp
New in version 2016.3.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
domain_name:
  virt.reverted:
    \- cleanup: True

domain_name_1:
  virt.reverted:
    \- snapshot: snapshot_name
    \- cleanup: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.running(name, cpu=None, mem=None, vm_type=None, disk_profile=None, disks=None, nic_profile=None, interfaces=None, graphics=None, seed=True, install=True, pub_key=None, priv_key=None, connection=None, username=None, password=None, os_type=None, arch=None, boot=None, boot_dev=None, numatune=None, hypervisor_features=None, clock=None, serials=None, consoles=None, stop_on_reboot=False, host_devices=None, autostart=False)
Starts an existing guest, or defines and starts a new VM with specified arguments.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name of the virtual machine to run
.IP \(bu 2
\fBcpu\fP \-\-
.sp
Number of virtual CPUs to assign to the virtual machine or a dictionary with detailed information to configure
cpu model and topology, numa node tuning, cpu tuning and iothreads allocation. The structure of the dictionary is
documented in \fI\%cpu parameters definition\fP\&.
.sp
To update any cpu parameters specify the new values to the corresponding tag. To remove any element or attribute,
specify \fBNone\fP object. Please note that \fBNone\fP object is mapped to \fBnull\fP in yaml, use \fBnull\fP in sls file
instead.

.IP \(bu 2
\fBmem\fP \-\-
.sp
Amount of memory to allocate to the virtual machine in MiB. Since 3002, a dictionary can be used to
contain detailed configuration which support memory allocation or tuning. Supported parameters are \fBboot\fP,
\fBcurrent\fP, \fBmax\fP, \fBslots\fP, \fBhard_limit\fP, \fBsoft_limit\fP, \fBswap_hard_limit\fP, \fBmin_guarantee\fP,
\fBhugepages\fP ,  \fBnosharepages\fP, \fBlocked\fP, \fBsource\fP, \fBaccess\fP, \fBallocation\fP and \fBdiscard\fP\&. The structure
of the dictionary is documented in  \fI\%Memory parameter definition\fP\&. Both decimal and binary base are supported. Detail unit
specification is documented  in \fI\%Units specification\fP\&. Please note that the value for \fBslots\fP must be an integer.
.sp
To remove any parameters, pass a None object, for instance: \(aqsoft_limit\(aq: \fBNone\fP\&. Please note  that \fBNone\fP
is mapped to \fBnull\fP in sls file, pass \fBnull\fP in sls file instead.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\- mem:
    hard_limit: null
    soft_limit: null
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Changed in version 3002.


.IP \(bu 2
\fBvm_type\fP \-\-
.sp
force virtual machine type for the new VM. The default value is taken from
the host capabilities. This could be useful for example to use \fB\(aqqemu\(aq\fP type instead
of the \fB\(aqkvm\(aq\fP one.
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBdisk_profile\fP \-\-
.sp
Name of the disk profile to use for the new virtual machine
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBdisks\fP \-\-
.sp
List of disk to create for the new virtual machine.
See \fI\%Disks Definitions\fP for more details on the items on this list.
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBnic_profile\fP \-\-
.sp
Name of the network interfaces profile to use for the new virtual machine
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBinterfaces\fP \-\-
.sp
List of network interfaces to create for the new virtual machine.
See \fI\%Network Interfaces Definitions\fP for more details on the items on this list.
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBgraphics\fP \-\-
.sp
Graphics device to create for the new virtual machine.
See \fI\%Graphics Definition\fP for more details on this dictionary
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBsaltenv\fP \-\-
.sp
Fileserver environment (Default: \fB\(aqbase\(aq\fP).
See \fI\%cp module for more details\fP
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBseed\fP \-\- .INDENT 2.0
.TP
.B \fBTrue\fP to seed the disk image. Only used when the \fBimage\fP parameter is provided.
(Default: \fBTrue\fP)
.UNINDENT
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBinstall\fP \-\-
.sp
install salt minion if absent (Default: \fBTrue\fP)
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpub_key\fP \-\-
.sp
public key to seed with (Default: \fBNone\fP)
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpriv_key\fP \-\-
.sp
public key to seed with (Default: \fBNone\fP)
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBseed_cmd\fP \-\-
.sp
Salt command to execute to seed the image. (Default: \fB\(aqseed.apply\(aq\fP)
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBos_type\fP \-\-
.sp
type of virtualization as found in the \fB//os/type\fP element of the libvirt definition.
The default value is taken from the host capabilities, with a preference for \fBhvm\fP\&.
Only used when creating a new virtual machine.
.sp
New in version 3000.


.IP \(bu 2
\fBarch\fP \-\-
.sp
architecture of the virtual machine. The default value is taken from the host capabilities,
but \fBx86_64\fP is prefed over \fBi686\fP\&. Only used when creating a new virtual machine.
.sp
New in version 3000.


.IP \(bu 2
\fBboot\fP \-\-
.sp
Specifies kernel, initial ramdisk and kernel command line parameters for the virtual machine.
This is an optional parameter, all of the keys are optional within the dictionary.
.sp
Refer to \fI\%Boot parameters definition\fP for the complete boot parameters description.
.sp
To update any boot parameters, specify the new path for each. To remove any boot parameters,
pass a None object, for instance: \(aqkernel\(aq: \fBNone\fP\&.
.sp
New in version 3000.


.IP \(bu 2
\fBserials\fP \-\-
.sp
Dictionary providing details on the serials connection to create. (Default: \fBNone\fP)
See \fI\%Serials and Consoles Definitions\fP for more details on the possible values.
.sp
New in version 3003.


.IP \(bu 2
\fBconsoles\fP \-\-
.sp
Dictionary providing details on the consoles device to create. (Default: \fBNone\fP)
See \fI\%Serials and Consoles Definitions\fP for more details on the possible values.
.sp
New in version 3003.


.IP \(bu 2
\fBboot_dev\fP \-\-
.sp
Space separated list of devices to boot from sorted by decreasing priority.
Values can be \fBhd\fP, \fBfd\fP, \fBcdrom\fP or \fBnetwork\fP\&.
.sp
By default, the value will \fB\(dqhd\(dq\fP\&.
.sp
New in version 3002.


.IP \(bu 2
\fBnumatune\fP \-\-
.sp
The optional numatune element provides details of how to tune the performance of a NUMA host via controlling NUMA
policy for domain process. The optional \fBmemory\fP element specifies how to allocate memory for the domain process
on a NUMA host. \fBmemnode\fP elements can specify memory allocation policies per each guest NUMA node. The definition
used in the dictionary can be found at \fI\%cpu parameters definition\fP\&.
.sp
To update any numatune parameters, specify the new value. To remove any \fBnumatune\fP parameters, pass a None object,
for instance: \(aqnumatune\(aq: \fBNone\fP\&. Please note that \fBNone\fP is mapped to \fBnull\fP in sls file, pass \fBnull\fP in
sls file instead.
.sp
New in version 3003.


.IP \(bu 2
\fBstop_on_reboot\fP \-\-
.sp
If set to \fBTrue\fP the guest will stop instead of rebooting.
This is specially useful when creating a virtual machine with an installation cdrom or
an autoinstallation needing a special first boot configuration.
Defaults to \fBFalse\fP
.sp
New in version 3003.


.IP \(bu 2
\fBhypervisor_features\fP \-\-
.sp
Enable or disable hypervisor\-specific features on the virtual machine.
.sp
New in version 3003.

.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
hypervisor_features:
  kvm\-hint\-dedicated: True
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBclock\fP \-\-
.sp
Configure the guest clock.
The value is a dictionary with the following keys:
.INDENT 2.0
.TP
.B adjustment
time adjustment in seconds or \fBreset\fP
.TP
.B utc
set to \fBFalse\fP to use the host local time as the guest clock. Defaults to \fBTrue\fP\&.
.TP
.B timezone
synchronize the guest to the correspding timezone
.TP
.B timers
a dictionary associating the timer name with its configuration.
This configuration is a dictionary with the properties \fBtrack\fP, \fBtickpolicy\fP,
\fBcatchup\fP, \fBfrequency\fP, \fBmode\fP, \fBpresent\fP, \fBslew\fP, \fBthreshold\fP and \fBlimit\fP\&.
See \fI\%libvirt time keeping documentation\fP for the possible values.
.UNINDENT
.sp
New in version 3003.

.sp
Set the clock to local time using an offset in seconds
\&.. code\-block:: yaml
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B clock:
adjustment: 3600
utc: False
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Set the clock to a specific time zone:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
clock:
  timezone: CEST
.ft P
.fi
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBhost_devices\fP \-\-
.sp
List of host devices to passthrough to the guest.
The value is a list of device names as provided by the \fI\%node_devices()\fP function.
(Default: \fBNone\fP)
.sp
New in version 3003.


.IP \(bu 2
\fBautostart\fP \-\- If set to \fBTrue\fP the host will start the guest after boot.
(Default: \fBFalse\fP)
.UNINDENT
.UNINDENT
.sp
Example States
.sp
Make sure an already\-defined virtual machine called \fBdomain_name\fP is running:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
domain_name:
  virt.running
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Do the same, but define the virtual machine if needed:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
domain_name:
  virt.running:
    \- cpu: 2
    \- mem: 2048
    \- disk_profile: prod
    \- boot_dev: network hd
    \- disks:
      \- name: system
        size: 8192
        overlay_image: True
        pool: default
        image: /path/to/image.qcow2
      \- name: data
        size: 16834
    \- nic_profile: prod
    \- interfaces:
      \- name: eth0
        mac: 01:23:45:67:89:AB
      \- name: eth1
        type: network
        source: admin
    \- graphics:
        type: spice
        listen:
            type: address
            address: 192.168.0.125
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.saved(name, suffix=None)
Deprecated since version 2016.3.0: Use \fI\%snapshot()\fP instead.

.sp
Takes a snapshot of a particular VM or by a UNIX\-style wildcard.
.sp
New in version 2016.3.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
domain_name:
  virt.saved:
    \- suffix: periodic

domain*:
  virt.saved:
    \- suffix: periodic
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.snapshot(name, suffix=None, connection=None, username=None, password=None)
Takes a snapshot of a particular VM or by a UNIX\-style wildcard.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
domain_name:
  virt.snapshot:
    \- suffix: periodic

domain*:
  virt.snapshot:
    \- suffix: periodic
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.stopped(name, connection=None, username=None, password=None)
Stops a VM by shutting it down nicely.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconnection\fP \-\-
.sp
libvirt connection URI, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBusername\fP \-\-
.sp
username to connect with, overriding defaults
.sp
New in version 2019.2.0.


.IP \(bu 2
\fBpassword\fP \-\-
.sp
password to connect with, overriding defaults
.sp
New in version 2019.2.0.


.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
domain_name:
  virt.stopped
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.unpowered(name)
Deprecated since version 2016.3.0: Use \fBpowered_off()\fP instead.

.sp
Stops a VM by power off.
.sp
New in version 2016.3.0.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
domain_name:
  virt.stopped
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virt.volume_defined(pool, name, size, allocation=0, format=None, type=None, permissions=None, backing_store=None, nocow=False, connection=None, username=None, password=None)
Ensure a disk volume is existing.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpool\fP \-\- name of the pool containing the volume
.IP \(bu 2
\fBname\fP \-\- name of the volume
.IP \(bu 2
\fBsize\fP \-\- capacity of the volume to define in MiB
.IP \(bu 2
\fBallocation\fP \-\- allocated size of the volume in MiB. Defaults to 0.
.IP \(bu 2
\fBformat\fP \-\- volume format. The allowed values are depending on the pool type.
Check the virt.pool_capabilities output for the possible values and the default.
.IP \(bu 2
\fBtype\fP \-\- type of the volume. One of file, block, dir, network, netdiri, ploop or None.
By default, the type is guessed by libvirt from the pool type.
.IP \(bu 2
\fBpermissions\fP \-\- Permissions to set on the target folder. This is mostly used for filesystem\-based
pool types. See \fI\%Permissions definition\fP for more details on this structure.
.IP \(bu 2
\fBbacking_store\fP \-\-
.sp
dictionary describing a backing file for the volume. It must contain a \fBpath\fP
property pointing to the base volume and a \fBformat\fP property defining the format
of the base volume.
.sp
The base volume format will not be guessed for security reasons and is thus mandatory.

.IP \(bu 2
\fBnocow\fP \-\- disable COW for the volume.
.IP \(bu 2
\fBconnection\fP \-\- libvirt connection URI, overriding defaults
.IP \(bu 2
\fBusername\fP \-\- username to connect with, overriding defaults
.IP \(bu 2
\fBpassword\fP \-\- password to connect with, overriding defaults
.UNINDENT
.UNINDENT
.sp
CLI Example:
.sp
Volume on ESX:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
esx_volume:
  virt.volume_defined:
    \- pool: \(dq[local\-storage]\(dq
    \- name: myvm/myvm.vmdk
    \- size: 8192
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
QCow2 volume with backing file:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
myvolume:
  virt.volume_defined:
    \- pool: default
    \- name: myvm.qcow2
    \- format: qcow2
    \- size: 8192
    \- permissions:
        mode: \(aq0775\(aq
        owner: \(aq123\(aq
        group: \(aq345\(aq
    \- backing_store:
        path: /path/to/base.img
        format: raw
    \- nocow: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 3001.

.UNINDENT
.SS salt.states.virtualenv
.sp
Setup of Python virtualenv sandboxes.
.sp
New in version 0.17.0.

.INDENT 0.0
.TP
.B salt.states.virtualenv_mod.manage(name, venv_bin=None, requirements=None, system_site_packages=False, distribute=False, use_wheel=False, clear=False, python=None, extra_search_dir=None, never_download=None, prompt=None, user=None, cwd=None, index_url=None, extra_index_url=None, pre_releases=False, no_deps=False, pip_download=None, pip_download_cache=None, pip_exists_action=None, pip_ignore_installed=False, proxy=None, use_vt=False, env_vars=None, no_use_wheel=False, pip_upgrade=False, pip_pkgs=None, pip_no_cache_dir=False, pip_cache_dir=None, process_dependency_links=False, no_binary=None, **kwargs)
This function is an alias of \fBmanaged\fP\&.
.INDENT 7.0
.INDENT 3.5
Create a virtualenv and optionally manage it with pip
.INDENT 0.0
.TP
.B name
Path to the virtualenv.
.TP
.B venv_bin: virtualenv
The name (and optionally path) of the virtualenv command. This can also
be set globally in the minion config file as \fBvirtualenv.venv_bin\fP\&.
.TP
.B requirements: None
Path to a pip requirements file. If the path begins with \fBsalt://\fP
the file will be transferred from the master file server.
.TP
.B use_wheel: False
Prefer wheel archives (requires pip >= 1.4).
.TP
.B python: None
Python executable used to build the virtualenv
.TP
.B user: None
The user under which to run virtualenv and pip.
.TP
.B cwd: None
Path to the working directory where \fIpip install\fP is executed.
.TP
.B no_deps: False
Pass \fI\-\-no\-deps\fP to \fIpip install\fP\&.
.TP
.B pip_exists_action: None
Default action of pip when a path already exists: (s)witch, (i)gnore,
(w)ipe, (b)ackup.
.TP
.B proxy: None
Proxy address which is passed to \fIpip install\fP\&.
.TP
.B env_vars: None
Set environment variables that some builds will depend on. For example,
a Python C\-module may have a Makefile that needs INCLUDE_PATH set to
pick up a header file while compiling.
.TP
.B no_use_wheel: False
Force to not use wheel archives (requires pip>=1.4)
.TP
.B no_binary
Force to not use binary packages (requires pip >= 7.0.0)
Accepts either :all: to disable all binary packages, :none: to empty the set,
or a list of one or more packages
.TP
.B pip_upgrade: False
Pass \fI\-\-upgrade\fP to \fIpip install\fP\&.
.TP
.B pip_pkgs: None
As an alternative to \fIrequirements\fP, pass a list of pip packages that
should be installed.
.TP
.B process_dependency_links: False
Run pip install with the \-\-process_dependency_links flag.
.sp
New in version 2017.7.0.

.UNINDENT
.sp
Also accepts any kwargs that the virtualenv module will. However, some
kwargs, such as the \fBpip\fP option, require \fB\- distribute: True\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/var/www/myvirtualenv.com:
  virtualenv.managed:
    \- system_site_packages: False
    \- requirements: salt://REQUIREMENTS.txt
    \- env_vars:
        PATH_VAR: \(aq/usr/local/bin/\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.virtualenv_mod.managed(name, venv_bin=None, requirements=None, system_site_packages=False, distribute=False, use_wheel=False, clear=False, python=None, extra_search_dir=None, never_download=None, prompt=None, user=None, cwd=None, index_url=None, extra_index_url=None, pre_releases=False, no_deps=False, pip_download=None, pip_download_cache=None, pip_exists_action=None, pip_ignore_installed=False, proxy=None, use_vt=False, env_vars=None, no_use_wheel=False, pip_upgrade=False, pip_pkgs=None, pip_no_cache_dir=False, pip_cache_dir=None, process_dependency_links=False, no_binary=None, **kwargs)
Create a virtualenv and optionally manage it with pip
.INDENT 7.0
.TP
.B name
Path to the virtualenv.
.TP
.B venv_bin: virtualenv
The name (and optionally path) of the virtualenv command. This can also
be set globally in the minion config file as \fBvirtualenv.venv_bin\fP\&.
.TP
.B requirements: None
Path to a pip requirements file. If the path begins with \fBsalt://\fP
the file will be transferred from the master file server.
.TP
.B use_wheel: False
Prefer wheel archives (requires pip >= 1.4).
.TP
.B python: None
Python executable used to build the virtualenv
.TP
.B user: None
The user under which to run virtualenv and pip.
.TP
.B cwd: None
Path to the working directory where \fIpip install\fP is executed.
.TP
.B no_deps: False
Pass \fI\-\-no\-deps\fP to \fIpip install\fP\&.
.TP
.B pip_exists_action: None
Default action of pip when a path already exists: (s)witch, (i)gnore,
(w)ipe, (b)ackup.
.TP
.B proxy: None
Proxy address which is passed to \fIpip install\fP\&.
.TP
.B env_vars: None
Set environment variables that some builds will depend on. For example,
a Python C\-module may have a Makefile that needs INCLUDE_PATH set to
pick up a header file while compiling.
.TP
.B no_use_wheel: False
Force to not use wheel archives (requires pip>=1.4)
.TP
.B no_binary
Force to not use binary packages (requires pip >= 7.0.0)
Accepts either :all: to disable all binary packages, :none: to empty the set,
or a list of one or more packages
.TP
.B pip_upgrade: False
Pass \fI\-\-upgrade\fP to \fIpip install\fP\&.
.TP
.B pip_pkgs: None
As an alternative to \fIrequirements\fP, pass a list of pip packages that
should be installed.
.TP
.B process_dependency_links: False
Run pip install with the \-\-process_dependency_links flag.
.sp
New in version 2017.7.0.

.UNINDENT
.sp
Also accepts any kwargs that the virtualenv module will. However, some
kwargs, such as the \fBpip\fP option, require \fB\- distribute: True\fP\&.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/var/www/myvirtualenv.com:
  virtualenv.managed:
    \- system_site_packages: False
    \- requirements: salt://REQUIREMENTS.txt
    \- env_vars:
        PATH_VAR: \(aq/usr/local/bin/\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.webutil
.sp
Support for htpasswd module. Requires the apache2\-utils package for Debian\-based distros.
.sp
New in version 2014.7.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
username:
  webutil.user_exists:
    \- password: secr3t
    \- htpasswd_file: /etc/nginx/htpasswd
    \- options: d
    \- force: true
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.webutil.user_absent(name, htpasswd_file=None, runas=None)
Make sure the user is not in the specified htpasswd file
.INDENT 7.0
.TP
.B name
User name
.TP
.B htpasswd_file
Path to the htpasswd file
.TP
.B runas
The system user to run htpasswd command with
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.webutil.user_exists(name, password=None, htpasswd_file=None, options=\(aq\(aq, force=False, runas=None, update=False)
Make sure the user is inside the specified htpasswd file
.INDENT 7.0
.TP
.B name
User name
.TP
.B password
User password
.TP
.B htpasswd_file
Path to the htpasswd file
.TP
.B options
See \fBsalt.modules.htpasswd.useradd\fP
.TP
.B force
Touch the file even if user already created
.TP
.B runas
The system user to run htpasswd command with
.TP
.B update
Update an existing user\(aqs password if it\(aqs different from what\(aqs in
the htpasswd file (unlike force, which updates regardless)
.UNINDENT
.UNINDENT
.SS salt.states.win_appx
.sp
Manage Microsoft Store apps on Windows. Removing an app with this modules will
deprovision the app from the online Windows image.
.sp
New in version 3007.0.

.INDENT 0.0
.TP
.B salt.states.win_appx.absent(name, query, include_store=False, frameworks=False, deprovision_only=False)
Removes Microsoft Store packages from the system. If the package is part of
a bundle, the entire bundle will be removed.
.sp
This function removes the package for all users on the system. It also
deprovisions the package so that it isn\(aqt re\-installed by later system
updates. To only deprovision a package and not remove it for all users, set
\fBdeprovision_only=True\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBquery\fP (\fI\%str\fP) \-\-
.sp
The query string to use to select the packages to be removed. If the
string matches multiple packages, they will all be removed. Here are
some example strings:
.nf
string          | description |
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- | \-\-\-\-\-\-\-\-\-\-\- |
\fB*teams*\fP     | Remove Microsoft Teams |
\fB*zune*\fP      | Remove Windows Media Player and Zune Video |
\fB*zuneMusic*\fP | Only remove Windows Media Player |
\fB*xbox*\fP      | Remove all xBox packages, there are 5 by default
\fB*\fP           | Remove everything but the Microsoft Store, unless \fBinclude_store=True\fP |
.fi
.sp
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
Use the \fBappx.list\fP function to make sure your query is
returning what you expect. Then use the same query to remove
those packages
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBinclude_store\fP (\fI\%bool\fP) \-\- Include the Microsoft Store in the results of the query to be
removed. Use this with caution. It is difficult to reinstall the
Microsoft Store once it has been removed with this function. Default
is \fBFalse\fP
.IP \(bu 2
\fBframeworks\fP (\fI\%bool\fP) \-\- Include frameworks in the results of the query to be removed.
Default is \fBFalse\fP
.IP \(bu 2
\fBdeprovision_only\fP (\fI\%bool\fP) \-\- Only deprovision the package. The package will be removed from the
current user and added to the list of deprovisioned packages. The
package will not be re\-installed in future system updates. New users
of the system will not have the package installed. However, the
package will still be installed for existing users. Default is
\fBFalse\fP
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, \fBNone\fP if no packages found
.TP
.B Return type
\fI\%bool\fP
.TP
.B Raises
\fI\%CommandExecutionError\fP \-\- On errors encountered removing the package
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
remove_candy_crush:
  appx.absent:
    \- query: \(dq*candy*\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_certutil
.SS Installing of certificates to the Windows Certificate Manager
.sp
Install certificates to the Windows Certificate Manager
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt://certs/cert.cer:
  certutil.add_store:
    \- store: TrustedPublisher
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_certutil.add_store(name, store, saltenv=\(aqbase\(aq)
Store a certificate to the given certificate store
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The path to the certificate to add to the store. This is either the
path to a local file or a file from the file server in the form of
\fBsalt://path/to/file\fP
.IP \(bu 2
\fBstore\fP (\fI\%str\fP) \-\- The certificate store to add the certificate to
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- The salt environment to use. This is ignored if the path is local
.UNINDENT
.TP
.B Returns
A dictionary containing the results
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
add_certificate:
  certutil.add_store:
    name: salt://web_cert.cer
    store: TrustedPublisher
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_certutil.del_store(name, store, saltenv=\(aqbase\(aq)
Remove a certificate from the given certificate store
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The path to the certificate to remove from the store. This is either
the path to a local file or a file from the file server in the form
of \fBsalt://path/to/file\fP
.IP \(bu 2
\fBstore\fP (\fI\%str\fP) \-\- The certificate store to remove the certificate from
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- The salt environment to use. This is ignored if the path is local
.UNINDENT
.TP
.B Returns
A dictionary containing the results
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
remove_certificate:
  certutil.del_store:
    name: salt://web_cert.cer
    store: TrustedPublisher
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_dacl
.sp
Windows Object Access Control Lists
.INDENT 0.0
.TP
.B Ensure an ACL is present
.INDENT 7.0
.TP
.B parameters:
name \- the path of the object
objectType \- Registry/File/Directory
user \- user account or SID for the ace
permission \- permission for the ace (see module win_acl for available permissions for each objectType)
acetype \-  Allow/Deny
propagation \- how the ACL should apply to child objects (see module win_acl for available propagation types)
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
addAcl:
  win_dacl.present:
    \- name: HKEY_LOCAL_MACHINE\eSOFTWARE\emykey
    \- objectType: Registry
    \- user: FakeUser
    \- permission: FullControl
    \- acetype: ALLOW
    \- propagation: KEY&SUBKEYS
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B Ensure an ACL does not exist
.INDENT 7.0
.TP
.B parameters:
name \- the path of the object
objectType \- Registry/File/Directory
user \- user account or SID for the ace
permission \- permission for the ace (see module win_acl for available permissions for each objectType)
acetype \-  Allow/Deny
propagation \- how the ACL should apply to child objects (see module win_acl for available propagation types)
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
removeAcl:
  win_dacl.absent:
    \- name: HKEY_LOCAL_MACHINE\eSOFTWARE\emykey
    \- objectType: Registry
    \- user: FakeUser
    \- permission: FulLControl
    \- acetype: ALLOW
    \- propagation: KEY&SUBKEYS
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B Ensure an object is inheriting permissions
.INDENT 7.0
.TP
.B parameters:
name \- the path of the object
objectType \- Registry/File/Directory
clear_existing_acl \- True/False \- when inheritance is enabled, should the existing ACL be kept or cleared out
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
eInherit:
  win_dacl.enableinheritance:
    \- name: HKEY_LOCAL_MACHINE\eSOFTWARE\emykey
    \- objectType: Registry
    \- clear_existing_acl: True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B Ensure an object is not inheriting permissions
.INDENT 7.0
.TP
.B parameters:
name \- the path of the object
objectType \- Registry/File/Directory
copy_inherited_acl \- True/False \- if inheritance is enabled, should the inherited permissions be copied to the ACL when inheritance is disabled
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
dInherit:
  win_dacl.disableinheritance:
    \- name: HKEY_LOCAL_MACHINE\eSOFTWARE\emykey
    \- objectType: Registry
    \- copy_inherited_acl: False
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_dacl.absent(name, objectType, user, permission, acetype, propagation)
Ensure an ACL does not exist
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_dacl.disinherit(name, objectType, copy_inherited_acl=True)
Ensure an object is not inheriting ACLs from its parent
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_dacl.inherit(name, objectType, clear_existing_acl=False)
Ensure an object is inheriting ACLs from its parent
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_dacl.present(name, objectType, user, permission, acetype, propagation)
Ensure an ACE is present
.UNINDENT
.SS salt.states.win_dism
.SS Installing of Windows features using DISM
.sp
Install Windows features, capabilities, and packages with DISM
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Language.Basic~~~en\-US~0.0.1.0:
  dism.capability_installed

NetFx3:
  dism.feature_installed
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_dism.capability_installed(name, source=None, limit_access=False, image=None, restart=False)
Install a DISM capability
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The capability to install
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- The optional source of the capability
.IP \(bu 2
\fBlimit_access\fP (\fI\%bool\fP) \-\- Prevent DISM from contacting Windows Update for online images
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline Windows image. If
\fBNone\fP is passed, the running operating system is targeted.
Default is \fBNone\fP
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the install
.UNINDENT
.UNINDENT
.sp
Example
.sp
Run \fBdism.available_capabilities\fP to get a list of available
capabilities. This will help you get the proper name to use
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
install_dotnet35:
  dism.capability_installed:
    \- name: NetFX3~~~~
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_dism.capability_removed(name, image=None, restart=False)
Uninstall a DISM capability
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The capability to uninstall
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline Windows image. If
\fBNone\fP is passed, the running operating system is targeted.
Default is \fBNone\fP
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the uninstall
.UNINDENT
.UNINDENT
.sp
Example
.sp
Run \fBdism.installed_capabilities\fP to get a list of installed
capabilities. This will help you get the proper name to use
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
remove_dotnet35:
  dism.capability_removed:
    \- name: NetFX3~~~~
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_dism.feature_installed(name, package=None, source=None, limit_access=False, enable_parent=False, image=None, restart=False)
Install a DISM feature
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The feature in which to install
.IP \(bu 2
\fBpackage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The parent package for the feature. You do not have to specify the
package if it is the Windows Foundation Package. Otherwise, use
package to specify the parent package of the feature
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- The optional source of the feature
.IP \(bu 2
\fBlimit_access\fP (\fI\%bool\fP) \-\- Prevent DISM from contacting Windows Update for online images
.IP \(bu 2
\fBenable_parent\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- \fBTrue\fP will enable all parent features of the specified feature
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline Windows image. If
\fBNone\fP is passed, the running operating system is targeted.
Default is \fBNone\fP
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the install
.UNINDENT
.UNINDENT
.sp
Example
.sp
Run \fBdism.available_features\fP to get a list of available features.
This will help you get the proper name to use
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
install_telnet_client:
  dism.feature_installed:
    \- name: TelnetClient
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_dism.feature_removed(name, remove_payload=False, image=None, restart=False)
Disables a feature.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The feature to disable
.IP \(bu 2
\fBremove_payload\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Remove the feature\(aqs payload. Must supply source when enabling in
the future.
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline Windows image. If
\fBNone\fP is passed, the running operating system is targeted.
Default is \fBNone\fP
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the uninstall
.UNINDENT
.UNINDENT
.sp
Example
.sp
Run \fBdism.installed_features\fP to get a list of installed features.
This will help you get the proper name to use
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
remove_telnet_client:
  dism.feature_removed:
    \- name: TelnetClient
    \- remove_payload: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_dism.kb_removed(name, image=None, restart=False)
Uninstall a KB package
.sp
New in version 3006.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the KB. Can be with or without the KB at the beginning
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline Windows image. If
\fBNone\fP is passed, the running operating system is targeted.
Default is \fBNone\fP
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the uninstall
.UNINDENT
.UNINDENT
.sp
Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Example using full KB name
remove_KB1231231:
  dism.package_installed:
    \- name: KB1231231

# Example using just he KB number
remove_KB1231231:
  dism.package_installed:
    \- name: 1231231
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_dism.package_installed(name, ignore_check=False, prevent_pending=False, image=None, restart=False)
Install a package.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The package to install. Can be a .cab file, a .msu file, or a folder
.IP \(bu 2
\fBignore_check\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Skip installation of the package if the applicability checks fail
.IP \(bu 2
\fBprevent_pending\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Skip the installation of the package if there are pending online
actions
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline Windows image. If
\fBNone\fP is passed, the running operating system is targeted.
Default is \fBNone\fP
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the install
.UNINDENT
.UNINDENT
.sp
Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
install_KB123123123:
  dism.package_installed:
    \- name: C:\ePackages\eKB123123123.cab
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_dism.package_removed(name, image=None, restart=False)
Uninstall a package
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The full path to the package. Can be either a .cab file or a folder.
Should point to the original source of the package, not to where the
file is installed. This can also be the name of a package as listed
in \fBdism.installed_packages\fP
.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline Windows image. If
\fBNone\fP is passed, the running operating system is targeted.
Default is \fBNone\fP
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the uninstall
.UNINDENT
.UNINDENT
.sp
Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Example using source
remove_KB1231231:
  dism.package_installed:
    \- name: C:\ePackages\eKB1231231.cab

# Example using name from \(ga\(gadism.installed_packages\(ga\(ga
remove_KB1231231:
  dism.package_installed:
    \- name: Package_for_KB1231231~31bf3856ad364e35~amd64~~10.0.1.3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_dism.provisioned_package_installed(name, image=None, restart=False)
Provision a package on a Windows image.
.sp
New in version 3007.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\-
.sp
The package to install. Can be one of the following:
.INDENT 2.0
.IP \(bu 2
\fB\&.appx\fP or \fB\&.appxbundle\fP
.IP \(bu 2
\fB\&.msix\fP or \fB\&.msixbundle\fP
.IP \(bu 2
\fB\&.ppkg\fP
.UNINDENT
.sp
The name of the file before the file extension must match the name
of the package after it is installed. This name can be found by
running \fBdism.provisioned_packages\fP

.IP \(bu 2
\fBimage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The path to the root directory of an offline Windows image. If
\fBNone\fP is passed, the running operating system is targeted.
Default is \fBNone\fP
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the installation. Default is
\fBFalse\fP
.UNINDENT
.UNINDENT
.sp
Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
install_windows_media_player:
  dism.provisioned_package_installed:
    \- name: C:\ePackages\eMicrosoft.ZuneVideo_2019.22091.10036.0_neutral_~_8wekyb3d8bbwe.Msixbundle
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_dns_client
.sp
Module for configuring DNS Client on Windows systems
.INDENT 0.0
.TP
.B salt.states.win_dns_client.dns_dhcp(name, interface=\(aqLocal Area Connection\(aq)
Configure the DNS server list from DHCP Server
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_dns_client.dns_exists(name, servers=None, interface=\(aqLocal Area Connection\(aq, replace=False)
Configure the DNS server list in the specified interface
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
config_dns_servers:
  win_dns_client.dns_exists:
    \- replace: True #remove any servers not in the \(dqservers\(dq list, default is False
    \- servers:
      \- 8.8.8.8
      \- 8.8.8.9
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_dns_client.primary_suffix(name, suffix=None, updates=False)
New in version 2014.7.0.

.sp
Configure the global primary DNS suffix of a DHCP client.
.INDENT 7.0
.TP
.B suffix
None
The suffix which is advertised for this client when acquiring a DHCP lease
When none is set, the explicitly configured DNS suffix will be removed.
.TP
.B updates
False
Allow syncing the DNS suffix with the AD domain when the client\(aqs AD domain membership changes
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
primary_dns_suffix:
    win_dns_client.primary_suffix:
        \- suffix: sub.domain.tld
        \- updates: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_firewall
.sp
State for configuring Windows Firewall
.INDENT 0.0
.TP
.B salt.states.win_firewall.add_rule(name, localport, protocol=\(aqtcp\(aq, action=\(aqallow\(aq, dir=\(aqin\(aq, remoteip=\(aqany\(aq)
Add a new inbound or outbound rule to the firewall policy
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the rule. Must be unique and cannot be \(dqall\(dq.
Required.
.IP \(bu 2
\fBlocalport\fP (\fI\%int\fP) \-\- The port the rule applies to. Must be a number between
0 and 65535. Can be a range. Can specify multiple ports separated by
commas. Required.
.IP \(bu 2
\fBprotocol\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\-
.sp
The protocol. Can be any of the following:
.INDENT 2.0
.IP \(bu 2
A number between 0 and 255
.IP \(bu 2
icmpv4
.IP \(bu 2
icmpv6
.IP \(bu 2
tcp
.IP \(bu 2
udp
.IP \(bu 2
any
.UNINDENT

.IP \(bu 2
\fBaction\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\-
.sp
The action the rule performs. Can be any of the
following:
.INDENT 2.0
.IP \(bu 2
allow
.IP \(bu 2
block
.IP \(bu 2
bypass
.UNINDENT

.IP \(bu 2
\fBdir\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The direction. Can be \fBin\fP or \fBout\fP\&.
.IP \(bu 2
\fBremoteip\fP (\fIOptional\fP\fI [\fP\fI\%str\fP\fI]\fP) \-\-
.sp
The remote IP. Can be any of the following:
.INDENT 2.0
.IP \(bu 2
any
.IP \(bu 2
localsubnet
.IP \(bu 2
dns
.IP \(bu 2
dhcp
.IP \(bu 2
wins
.IP \(bu 2
defaultgateway
.IP \(bu 2
Any valid IPv4 address (192.168.0.12)
.IP \(bu 2
Any valid IPv6 address (2002:9b3b:1a31:4:208:74ff:fe39:6c43)
.IP \(bu 2
Any valid subnet (192.168.1.0/24)
.IP \(bu 2
Any valid range of IP addresses (192.168.0.1\-192.168.0.12)
.IP \(bu 2
A list of valid IP addresses
.UNINDENT
.sp
Can be combinations of the above separated by commas.
.sp
New in version 2016.11.6.


.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
open_smb_port:
  win_firewall.add_rule:
    \- name: SMB (445)
    \- localport: 445
    \- protocol: tcp
    \- action: allow
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_firewall.disabled(name=\(aqallprofiles\(aq)
Disable all the firewall profiles (Windows only)
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\-
.sp
The name of the profile to disable. Default is
\fBallprofiles\fP\&. Valid options are:
.INDENT 7.0
.IP \(bu 2
allprofiles
.IP \(bu 2
domainprofile
.IP \(bu 2
privateprofile
.IP \(bu 2
publicprofile
.UNINDENT

.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# To disable the domain profile
disable_domain:
  win_firewall.disabled:
    \- name: domainprofile

# To disable all profiles
disable_all:
  win_firewall.disabled:
    \- name: allprofiles
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_firewall.enabled(name=\(aqallprofiles\(aq)
Enable all the firewall profiles (Windows only)
.INDENT 7.0
.TP
.B Parameters
\fBprofile\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\-
.sp
The name of the profile to enable. Default is
\fBallprofiles\fP\&. Valid options are:
.INDENT 7.0
.IP \(bu 2
allprofiles
.IP \(bu 2
domainprofile
.IP \(bu 2
privateprofile
.IP \(bu 2
publicprofile
.UNINDENT

.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# To enable the domain profile
enable_domain:
  win_firewall.enabled:
    \- name: domainprofile

# To enable all profiles
enable_all:
  win_firewall.enabled:
    \- name: allprofiles
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_iis
.sp
Microsoft IIS site management
.sp
This module provides the ability to add/remove websites and application pools
from Microsoft IIS.
.sp
New in version 2016.3.0.

.INDENT 0.0
.TP
.B salt.states.win_iis.container_setting(name, container, settings=None)
Set the value of the setting for an IIS container.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the IIS container.
.IP \(bu 2
\fBcontainer\fP (\fI\%str\fP) \-\- The type of IIS container. The container types are:
AppPools, Sites, SslBindings
.IP \(bu 2
\fBsettings\fP (\fI\%str\fP) \-\- A dictionary of the setting names and their values.
Example of usage for the \fBAppPools\fP container:
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-apppool\-setting:
    win_iis.container_setting:
        \- name: site0
        \- container: AppPools
        \- settings:
            managedPipelineMode: Integrated
            processModel.maxProcesses: 1
            processModel.userName: TestUser
            processModel.password: TestPassword
            processModel.identityType: SpecificUser
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage for the \fBSites\fP container:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-site\-setting:
    win_iis.container_setting:
        \- name: site0
        \- container: Sites
        \- settings:
            logFile.logFormat: W3C
            logFile.period: Daily
            limits.maxUrlSegments: 32
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_iis.create_app(name, site, sourcepath, apppool=None)
Create an IIS application.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The IIS application.
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBsourcepath\fP (\fI\%str\fP) \-\- The physical path.
.IP \(bu 2
\fBapppool\fP (\fI\%str\fP) \-\- The name of the IIS application pool.
.UNINDENT
.UNINDENT
.sp
Example of usage with only the required arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-v1\-app:
    win_iis.create_app:
        \- name: v1
        \- site: site0
        \- sourcepath: C:\einetpub\esite0\ev1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage specifying all available arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-v1\-app:
    win_iis.create_app:
        \- name: v1
        \- site: site0
        \- sourcepath: C:\einetpub\esite0\ev1
        \- apppool: site0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_iis.create_apppool(name)
Create an IIS application pool.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the IIS application pool.
.UNINDENT
.sp
Usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-apppool:
    win_iis.create_apppool:
        \- name: site0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_iis.create_binding(name, site, hostheader=\(aq\(aq, ipaddress=\(aq*\(aq, port=80, protocol=\(aqhttp\(aq, sslflags=0)
Create an IIS binding.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBhostheader\fP (\fI\%str\fP) \-\- The host header of the binding.
.IP \(bu 2
\fBipaddress\fP (\fI\%str\fP) \-\- The IP address of the binding.
.IP \(bu 2
\fBport\fP (\fI\%str\fP) \-\- The TCP port of the binding.
.IP \(bu 2
\fBprotocol\fP (\fI\%str\fP) \-\- The application protocol of the binding.
.IP \(bu 2
\fBsslflags\fP (\fI\%str\fP) \-\- The flags representing certificate type and storage of the binding.
.UNINDENT
.UNINDENT
.sp
Example of usage with only the required arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-https\-binding:
    win_iis.create_binding:
        \- site: site0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage specifying all available arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-https\-binding:
    win_iis.create_binding:
        \- site: site0
        \- hostheader: site0.local
        \- ipaddress: \(aq*\(aq
        \- port: 443
        \- protocol: https
        \- sslflags: 0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_iis.create_cert_binding(name, site, hostheader=\(aq\(aq, ipaddress=\(aq*\(aq, port=443, sslflags=0)
Assign a certificate to an IIS binding.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The thumbprint of the certificate.
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBhostheader\fP (\fI\%str\fP) \-\- The host header of the binding.
.IP \(bu 2
\fBipaddress\fP (\fI\%str\fP) \-\- The IP address of the binding.
.IP \(bu 2
\fBport\fP (\fI\%str\fP) \-\- The TCP port of the binding.
.IP \(bu 2
\fBsslflags\fP (\fI\%str\fP) \-\- Flags representing certificate type and certificate storage of the binding.
.UNINDENT
.UNINDENT
.sp
Example of usage with only the required arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-cert\-binding:
    win_iis.create_cert_binding:
        \- name: 9988776655443322111000AAABBBCCCDDDEEEFFF
        \- site: site0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage specifying all available arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-cert\-binding:
    win_iis.create_cert_binding:
        \- name: 9988776655443322111000AAABBBCCCDDDEEEFFF
        \- site: site0
        \- hostheader: site0.local
        \- ipaddress: 192.168.1.199
        \- port: 443
        \- sslflags: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_iis.create_vdir(name, site, sourcepath, app=\(aq/\(aq)
Create an IIS virtual directory.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The virtual directory name.
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBsourcepath\fP (\fI\%str\fP) \-\- The physical path.
.IP \(bu 2
\fBapp\fP (\fI\%str\fP) \-\- The IIS application.
.UNINDENT
.UNINDENT
.sp
Example of usage with only the required arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-foo\-vdir:
    win_iis.create_vdir:
        \- name: foo
        \- site: site0
        \- sourcepath: C:\einetpub\evdirs\efoo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage specifying all available arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-foo\-vdir:
    win_iis.create_vdir:
        \- name: foo
        \- site: site0
        \- sourcepath: C:\einetpub\evdirs\efoo
        \- app: v1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_iis.deployed(name, sourcepath, apppool=\(aq\(aq, hostheader=\(aq\(aq, ipaddress=\(aq*\(aq, port=80, protocol=\(aqhttp\(aq)
Ensure the website has been deployed.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBsourcepath\fP (\fI\%str\fP) \-\- The physical path of the IIS site.
.IP \(bu 2
\fBapppool\fP (\fI\%str\fP) \-\- The name of the IIS application pool.
.IP \(bu 2
\fBhostheader\fP (\fI\%str\fP) \-\- The host header of the binding.
.IP \(bu 2
\fBipaddress\fP (\fI\%str\fP) \-\- The IP address of the binding.
.IP \(bu 2
\fBport\fP (\fI\%str\fP) \-\- The TCP port of the binding.
.IP \(bu 2
\fBprotocol\fP (\fI\%str\fP) \-\- The application protocol of the binding.
.UNINDENT
.UNINDENT
.sp
Example of usage with only the required arguments. This will default to using the default application pool
assigned by IIS:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-deployed:
    win_iis.deployed:
        \- name: site0
        \- sourcepath: C:\einetpub\esite0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage specifying all available arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-deployed:
    win_iis.deployed:
        \- name: site0
        \- sourcepath: C:\einetpub\esite0
        \- apppool: site0
        \- hostheader: site0.local
        \- ipaddress: \(aq*\(aq
        \- port: 443
        \- protocol: https
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_iis.remove_app(name, site)
Remove an IIS application.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The application name.
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.UNINDENT
.UNINDENT
.sp
Usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-v1\-app\-remove:
    win_iis.remove_app:
        \- name: v1
        \- site: site0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_iis.remove_apppool(name)
Remove an IIS application pool.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The name of the IIS application pool.
.UNINDENT
.sp
Usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
defaultapppool\-remove:
    win_iis.remove_apppool:
        \- name: DefaultAppPool
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_iis.remove_binding(name, site, hostheader=\(aq\(aq, ipaddress=\(aq*\(aq, port=80)
Remove an IIS binding.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBhostheader\fP (\fI\%str\fP) \-\- The host header of the binding.
.IP \(bu 2
\fBipaddress\fP (\fI\%str\fP) \-\- The IP address of the binding.
.IP \(bu 2
\fBport\fP (\fI\%str\fP) \-\- The TCP port of the binding.
.UNINDENT
.UNINDENT
.sp
Example of usage with only the required arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-https\-binding\-remove:
    win_iis.remove_binding:
        \- site: site0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage specifying all available arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-https\-binding\-remove:
    win_iis.remove_binding:
        \- site: site0
        \- hostheader: site0.local
        \- ipaddress: \(aq*\(aq
        \- port: 443
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_iis.remove_cert_binding(name, site, hostheader=\(aq\(aq, ipaddress=\(aq*\(aq, port=443)
Remove a certificate from an IIS binding.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The thumbprint of the certificate.
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBhostheader\fP (\fI\%str\fP) \-\- The host header of the binding.
.IP \(bu 2
\fBipaddress\fP (\fI\%str\fP) \-\- The IP address of the binding.
.IP \(bu 2
\fBport\fP (\fI\%str\fP) \-\- The TCP port of the binding.
.UNINDENT
.UNINDENT
.sp
Example of usage with only the required arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-cert\-binding\-remove:
    win_iis.remove_cert_binding:
        \- name: 9988776655443322111000AAABBBCCCDDDEEEFFF
        \- site: site0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage specifying all available arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-cert\-binding\-remove:
    win_iis.remove_cert_binding:
        \- name: 9988776655443322111000AAABBBCCCDDDEEEFFF
        \- site: site0
        \- hostheader: site0.local
        \- ipaddress: 192.168.1.199
        \- port: 443
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New in version 2016.11.0.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_iis.remove_site(name)
Delete a website from IIS.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The IIS site name.
.UNINDENT
.sp
Usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
defaultwebsite\-remove:
    win_iis.remove_site:
        \- name: Default Web Site
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_iis.remove_vdir(name, site, app=\(aq/\(aq)
Remove an IIS virtual directory.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The virtual directory name.
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBapp\fP (\fI\%str\fP) \-\- The IIS application.
.UNINDENT
.UNINDENT
.sp
Example of usage with only the required arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-foo\-vdir\-remove:
    win_iis.remove_vdir:
        \- name: foo
        \- site: site0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage specifying all available arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-foo\-vdir\-remove:
    win_iis.remove_vdir:
        \- name: foo
        \- site: site0
        \- app: v1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_iis.set_app(name, site, settings=None)
New in version 2017.7.0.

.sp
Set the value of the setting for an IIS web application.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This function only configures existing app. Params are case sensitive.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The IIS application.
.IP \(bu 2
\fBsite\fP (\fI\%str\fP) \-\- The IIS site name.
.IP \(bu 2
\fBsettings\fP (\fI\%str\fP) \-\- A dictionary of the setting names and their values.
.UNINDENT
.UNINDENT
.sp
Available settings:
.INDENT 7.0
.IP \(bu 2
\fBphysicalPath\fP \- The physical path of the webapp
.IP \(bu 2
\fBapplicationPool\fP \- The application pool for the webapp
.IP \(bu 2
\fBuserName\fP \(dqconnectAs\(dq user
.IP \(bu 2
\fBpassword\fP \(dqconnectAs\(dq password for user
.UNINDENT
.INDENT 7.0
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
Example of usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-webapp\-setting:
    win_iis.set_app:
        \- name: app0
        \- site: Default Web Site
        \- settings:
            userName: domain\e\euser
            password: pass
            physicalPath: c:\einetpub\ewwwroot
            applicationPool: appPool0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_iis.webconfiguration_settings(name, settings=None)
Set the value of webconfiguration settings.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the IIS PSPath containing the settings.
Possible PSPaths are :
MACHINE, MACHINE/WEBROOT, IIS:, IIS:Sitessitename, ...
.IP \(bu 2
\fBsettings\fP (\fI\%dict\fP) \-\- Dictionaries of dictionaries.
You can match a specific item in a collection with this syntax inside a key:
\(aqCollection[{name: site0}].logFile.directory\(aq
.UNINDENT
.UNINDENT
.sp
Example of usage for the \fBMACHINE/WEBROOT\fP PSPath:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
MACHINE\-WEBROOT\-level\-security:
  win_iis.webconfiguration_settings:
    \- name: \(aqMACHINE/WEBROOT\(aq
    \- settings:
        system.web/authentication/forms:
          requireSSL: True
          protection: \(dqAll\(dq
          credentials.passwordFormat: \(dqSHA1\(dq
        system.web/httpCookies:
          httpOnlyCookies: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage for the \fBIIS:\eSites\esite0\fP PSPath:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-IIS\-Sites\-level\-security:
  win_iis.webconfiguration_settings:
    \- name: \(aqIIS:\eSites\esite0\(aq
    \- settings:
        system.webServer/httpErrors:
          errorMode: \(dqDetailedLocalOnly\(dq
        system.webServer/security/requestFiltering:
          allowDoubleEscaping: False
          verbs.Collection:
            \- verb: TRACE
              allowed: False
          fileExtensions.allowUnlisted: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage for the \fBIIS:\e\fP PSPath with a collection matching:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-IIS\-level\-security:
  win_iis.webconfiguration_settings:
    \- name: \(aqIIS:\e\(aq
    \- settings:
        system.applicationHost/sites:
          \(aqCollection[{name: site0}].logFile.directory\(aq: \(aqC:\elogs\eiis\esite0\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_lgpo
.SS Manage Windows Local Group Policy
.sp
New in version 2016.11.0.

.sp
This state module allows you to configure local Group Policy on Windows. You
can ensure the setting of a single policy or multiple policies in one pass.
.sp
Single policies must specify the policy name, the setting, and the policy class
(Machine/User/Both). Here are some examples for setting a single policy setting.
.sp
Example single policy configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Ensure Account Lockout Duration:
  lgpo.set:
    \- name: Account lockout duration
    \- setting: 90
    \- policy_class: Machine
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example using abbreviated form:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Account lockout duration:
  lgpo.set:
    \- setting: 120
    \- policy_class: Machine
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is also possible to set multiple policies in a single state. This is done by
setting the settings under either \fIcomputer_policy\fP or \fIuser_policy\fP\&. Here are
some examples for setting multiple policy settings in a single state.
.sp
Multiple policy configuration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Company Local Group Policy:
    lgpo.set:
        \- computer_policy:
            Deny log on locally:
              \- Guest
            Account lockout duration: 120
            Account lockout threshold: 10
            Reset account lockout counter after: 120
            Enforce password history: 24
            Maximum password age: 60
            Minimum password age: 1
            Minimum password length: 14
            Password must meet complexity requirements: Enabled
            Store passwords using reversible encryption: Disabled
            Configure Automatic Updates:
                Configure automatic updating: 4 \- Auto download and schedule the intsall
                Scheduled install day: 7 \- Every Saturday
                Scheduled install time: 17:00
            Specify intranet Microsoft update service location:
                Set the intranet update service for detecting updates: http://mywsus
                Set the intranet statistics server: http://mywsus
        \- user_policy:
            Do not process the legacy run list: Enabled
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
server_policy:
  lgpo.set:
    \- computer_policy:
        Maximum password age: 60
        Minimum password age: 1
        Minimum password length: 14
        Account lockout duration: 120
        Account lockout threshold: 10
        Reset account lockout counter after: 120
        Manage auditing and security log:
          \- \(dqBUILTIN\e\eAdministrators\(dq
        Replace a process level token:
          \- \(dqNT AUTHORITY\e\eNETWORK SERVICE\(dq
          \- \(dqNT AUTHORITY\e\eLOCAL SERVICE\(dq
        \(dqAccounts: Guest account status\(dq: Disabled
        \(dqAccounts: Rename guest account\(dq: Not_4_U
        \(dqAudit: Audit the use of Backup and Restore privilege\(dq: Enabled
        \(dqInteractive logon: Do not display last user name\(dq: Enabled
        \(dqNetwork\e\eDNS Client\e\eDynamic update\(dq: Disabled
        \(dqSystem\e\eLogon\e\eDo not display the Getting Started welcome screen at logon\(dq: Enabled
        \(dqWindows Components\e\eRemote Desktop Services\e\eRemote Desktop Session Host\e\eConnections\e\eSelect RDP transport protocols\(dq:
            \(dqSelect Transport Type\(dq: \(dqUse both UDP and TCP\(dq
        \(dqWindows Components\e\eWindows Update\e\eAllow Automatic Updates immediate installation\(dq: Enabled
        \(dqWindows Components\e\eWindows Update\e\eAllow non\-administrators to receive update notifications\(dq: Disabled
        \(dqWindows Components\e\eWindows Update\e\eAlways automatically restart at the scheduled time\(dq:
            \(dqThe restart timer will give users this much time to save their work (minutes)\(dq: 15
        \(dqWindows Components\e\eWindows Update\e\eAutomatic Updates detection frequency\(dq:
            \(dqCheck for updates at the following interval (hours)\(dq: 1
        \(dqWindows Components\e\eWindows Update\e\eConfigure Automatic Updates\(dq:
            \(dqConfigure automatic updating\(dq: 4 \- Auto download and schedule the install
            \(dqInstall during automatic maintenance\(dq: False
            \(dqScheduled install day\(dq: 7 \- Every Saturday
            \(dqScheduled install time\(dq: \(dq17:00\(dq
        \(dqWindows Components\e\eWindows Update\e\eDelay Restart for scheduled installations\(dq:
            \(dqWait the following period before proceeding with a scheduled restart (minutes)\(dq: 1
        \(dqWindows Components\e\eWindows Update\e\eNo auto\-restart with logged on users for scheduled automatic updates installations\(dq: Disabled
        \(dqWindows Components\e\eWindows Update\e\eRe\-prompt for restart with scheduled installations\(dq:
            \(dqWait the following period before prompting again with a scheduled restart (minutes)\(dq: 30
        \(dqWindows Components\e\eWindows Update\e\eReschedule Automatic Updates scheduled installations\(dq: Disabled
        \(dqWindows Components\e\eWindows Update\e\eSpecify intranet Microsoft update service location\(dq:
            \(dqSet the intranet update service for detecting updates\(dq: http://mywsus
            \(dqSet the intranet statistics server\(dq: http://mywsus
    \- cumulative_rights_assignments: True

Some policy settings can\(aqt be set on their own an require that other policy
settings are set at the same time. It can be difficult to figure out what
additional settings need to be applied. The easiest way to do this is to
modify the setting manually using the Group Policy Editor (\(gagpedit.msc\(ga) on
the machine. Then \(gaget\(ga the policy settings configured on that machine. Use
the following command:

\&.. code\-block:: bash

    salt\-call \-\-local lgpo.get machine

For example, if I want to set the Windows Update settings for a Windows
Server 2016 machine I would go into the Group Policy Editor (\(gagpedit.msc\(ga)
and configure the group policy. That policy can be found at: Computer
Configuration \-> Administrative Templates \-> Windows Components \-> Windows
Update \-> Configure Automatic Updates. You have the option to \(dqEnable\(dq the
policy and set some configuration options. In this example, just click
\(dqEnable\(dq and accept the default configuration options. Click \(dqOK\(dq to apply
the setting.

Now run the \(gaget\(ga command as shown above. You will find the following in
the minion return:

\&.. code\-block:: bash

    Windows Components\eWindows Update\eConfigure Automatic Updates:
        \-\-\-\-\-\-\-\-\-\-
        Configure automatic updating:
            3 \- Auto download and notify for install
        Install during automatic maintenance:
            False
        Install updates for other Microsoft products:
            False
        Scheduled install day:
            0 \- Every day
        Scheduled install time:
            03:00

This shows you that to enable the \(dqConfigure Automatic Updates\(dq policy you
also have to configure the following settings:

\- Configure automatic updating
\- Install during automatic maintenance
\- Install updates for other Microsoft products
\- Scheduled install day
\- Scheduled install time

So, if you were writing a state for the above policy, it would look like
this:

\&.. code\-block:: bash

    configure_windows_update_settings:
      lgpo.set:
        \- computer_policy:
            Configure Automatic Updates:
              Configure automatic updating: 3 \- Auto download and notify for install
              Install during automatic maintenance: False
              Install updates for other Microsoft products: False
              Scheduled install day: 0 \- Every day
              Scheduled install time: 03:00

\&.. note::

    It is important that you put names of policies and settings exactly as
    they are displayed in the return. That includes capitalization and
    punctuation such as periods, dashes, etc. This rule applies to both
    the setting name and the setting value.

\&.. warning::

    From time to time Microsoft updates the Administrative templates on the
    machine. This can cause the policy name to change or the list of
    settings that must be applied at the same time. These settings often
    change between versions of Windows as well. For example, Windows Server
    2019 allows you to also specify a specific week of the month to apply
    the update.

Another thing note is the long policy name returned by the \(gaget\(ga function:

\&.. code\-block:: bash

    Windows Components\eWindows Update\eConfigure Automatic Updates:

When we wrote the state for this policy we only used the final portion of
the policy name, \(gaConfigure Automatic Updates\(ga. This usually works fine, but
if you are having problems, you may try the long policy name.

When writing the long name in a state file either wrap the name in single
quotes to make yaml see it as raw data, or escape the back slashes.

\&.. code\-block:: bash

    \(aqWindows Components\eWindows Update\eConfigure Automatic Updates:\(aq

    or

    Windows Components\e\eWindows Update\e\eConfigure Automatic Updates:
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_lgpo.set_(name, setting=None, policy_class=None, computer_policy=None, user_policy=None, cumulative_rights_assignments=True, adml_language=\(aqen\-US\(aq, refresh_cache=False)
Ensure the specified policy is set.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The \fBsetting\fP argument cannot be used in conjunction with the
\fBcomputer_policy\fP or \fBuser_policy\fP arguments
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of a single policy to configure
.IP \(bu 2
\fBsetting\fP (\fI\%str\fP\fI, \fP\fI\%dict\fP\fI, \fP\fI\%list\fP) \-\- The configuration setting for the single named policy. If this
argument is used the \fBcomputer_policy\fP / \fBuser_policy\fP arguments
will be ignored
.IP \(bu 2
\fBpolicy_class\fP (\fI\%str\fP) \-\- The policy class of the single named policy to configure. This can
\fBmachine\fP, \fBuser\fP, or \fBboth\fP
.IP \(bu 2
\fBcomputer_policy\fP (\fI\%dict\fP) \-\- A dictionary of containing the policy name and key/value pairs of a
set of computer policies to configure. If this argument is used, the
\fBname\fP / \fBpolicy_class\fP arguments will be ignored
.IP \(bu 2
\fBuser_policy\fP (\fI\%dict\fP) \-\- A dictionary of containing the policy name and key/value pairs of a
set of user policies to configure. If this argument is used, the
\fBname\fP / \fBpolicy_class\fP arguments will be ignored
.IP \(bu 2
\fBcumulative_rights_assignments\fP (\fI\%bool\fP) \-\- If user rights assignments are being configured, determines if any
user right assignment policies specified will be cumulative or
explicit
.IP \(bu 2
\fBadml_language\fP (\fI\%str\fP) \-\- The adml language to use for AMDX policy data/display conversions.
Default is \fBen\-US\fP
.IP \(bu 2
\fBrefresh_cache\fP (\fI\%bool\fP) \-\-
.sp
Clear the cached policy definitions before applying the state. This
is useful when the underlying policy files (ADMX/ADML) have been
added/modified in the same state. This will allow those new policies
to be picked up. This adds time to the state run when applied to
multiple states within the same run. Therefore, it is best to only
apply this to the first policy that is applied. For individual runs
this will have no effect. Default is \fBFalse\fP
.sp
New in version 3006.8.

.sp
New in version 3007.1.


.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_lgpo_reg
.SS LGPO \- Registry.pol
.sp
New in version 3006.0.

.sp
A state module for working with registry based policies in Windows Local Group
Policy (LGPO). This module contains functions for working with the
\fBRegistry.pol\fP file. The \fBRegistry.pol\fP file is the source of truth for
registry settings and LGPO.
.sp
Group Policy is refreshed every 90 seconds by default. During that refresh the
contents of the \fBRegistry.pol\fP file are applied to the Registry. If the
setting is changed outside of Group Policy to something other than what is
contained in the \fBRegistry.pol\fP file, it will be changed back during the next
refresh.
.sp
In the Group Policy Editor (\fBgpedit.msc\fP) these policies can be set to three
states:
.INDENT 0.0
.IP \(bu 2
Not Configured
.IP \(bu 2
Enabled
.IP \(bu 2
Disabled
.UNINDENT
.sp
A policy that is \(dqNot Configured\(dq does not have an entry in the \fBRegistry.pol\fP
file. A Group Policy refresh will not make any changes to key/value pairs in the
registry that are not specified in the \fBRegistry.pol\fP file.
.sp
An \(dqEnabled\(dq policy will have an entry in the \fBRegistry.pol\fP files that
contains its key path, value name, value type, value size, and value data. When
Group Policy is refreshed, existing values will be overwritten with those
contained in the \fBRegistry.pol\fP file.
.sp
A \(dqDisabled\(dq policy will have an entry in the \fBRegistry.pol\fP file with the key
path and the value name, but the value name will be prepended with \fB**del.\fP\&.
When Group Policy is refreshed the key/value will be deleted from the registry.
If the key contains no values, it will also be deleted.
.SS Working with LGPO Reg
.sp
The easiest way to figure out the values needed for this module is to set the
policy using the Group Policy Editor (\fBgpedit.msc\fP) and then run the
\fBlgpo_reg.read_reg_pol\fP function. This function will display a dictionary of
all registry\-based policies in the \fBRegistry.pol\fP file. From its return you
can get the \fBkey\fP, \fBv_name\fP, \fBv_type\fP, and \fBv_data\fP required to
configure that policy.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Not all policies in the Group Policy Editor (\fBgpedit.msc\fP) that write to
the registry make that change in the \fBRegistry.pol\fP file. Those policies
could still be enforced via the \fBRegistry.pol\fP file... theoretically. But
you will have to find the values needed to set them with this module using a
different method.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_lgpo_reg.value_absent(name, key, policy_class=\(aqMachine\(aq)
Ensure a registry setting is not present in the Registry.pol file.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The registry key path
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The registry value name within the key
.IP \(bu 2
\fBpolicy_class\fP (\fI\%str\fP) \-\-
.sp
The registry class to write to. Can be one of the
following:
.INDENT 2.0
.IP \(bu 2
Computer
.IP \(bu 2
Machine
.IP \(bu 2
User
.UNINDENT
.sp
Default is \fBMachine\fP

.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Using the name parameter in the definition
set_reg_pol_value:
  lgpo_reg.value_absent:
    \- key: SOFTWARE\eMyKey
    \- name: MyValue
    \- policy_class: Machine


# Using the name as the parameter and modifying the User policy
MyValue:
  lgpo_reg.value_absent:
    \- key: SOFTWARE\eMyKey
    \- policy_class: User
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_lgpo_reg.value_disabled(name, key, policy_class=\(aqMachine\(aq)
Ensure a registry setting is disabled in the Registry.pol file.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The registry key path
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The registry value name within the key
.IP \(bu 2
\fBpolicy_class\fP (\fI\%str\fP) \-\-
.sp
The registry class to write to. Can be one of the
following:
.INDENT 2.0
.IP \(bu 2
Computer
.IP \(bu 2
Machine
.IP \(bu 2
User
.UNINDENT
.sp
Default is \fBMachine\fP

.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Using the name parameter in the definition
set_reg_pol_value:
  lgpo_reg.value_disabled:
    \- key: SOFTWARE\eMyKey
    \- name: MyValue
    \- policy_class: Machine


# Using the name as the parameter and modifying the User policy
MyValue:
  lgpo_reg.value_disabled:
    \- key: SOFTWARE\eMyKey
    \- policy_class: User
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_lgpo_reg.value_present(name, key, v_data, v_type=\(aqREG_DWORD\(aq, policy_class=\(aqMachine\(aq)
Ensure a registry setting is present in the Registry.pol file.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The registry value name within the key
.IP \(bu 2
\fBkey\fP (\fI\%str\fP) \-\- The registry key path
.IP \(bu 2
\fBv_data\fP (\fI\%str\fP) \-\- The registry value
.IP \(bu 2
\fBv_type\fP (\fI\%str\fP) \-\-
.sp
The registry value type. Must be one of the following:
.INDENT 2.0
.IP \(bu 2
REG_BINARY
.IP \(bu 2
REG_DWORD
.IP \(bu 2
REG_EXPAND_SZ
.IP \(bu 2
REG_MULTI_SZ
.IP \(bu 2
REG_QWORD
.IP \(bu 2
REG_SZ
.UNINDENT
.sp
Default is REG_DWORD

.IP \(bu 2
\fBpolicy_class\fP (\fI\%str\fP) \-\-
.sp
The registry class to write to. Can be one of the
following:
.INDENT 2.0
.IP \(bu 2
Computer
.IP \(bu 2
Machine
.IP \(bu 2
User
.UNINDENT
.sp
Default is \fBMachine\fP

.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Using the name parameter in the definition
set_reg_pol_value:
  lgpo_reg.value_present:
    \- key: SOFTWARE\eMyKey
    \- name: MyValue
    \- v_type: REG_SZ
    \- v_data: \(dqsome string data\(dq
    \- policy_class: Machine


# Using the name as the parameter and modifying the User policy
MyValue:
  lgpo_reg.value_present:
    \- key: SOFTWARE\eMyKey
    \- v_type: REG_SZ
    \- v_data: \(dqsome string data\(dq
    \- policy_class: User
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_license
.SS Installation and activation of windows licenses
.sp
Install and activate windows licenses
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
XXXXX\-XXXXX\-XXXXX\-XXXXX\-XXXXX:
  license.activate
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_license.activate(name)
Install and activate the given product key
.INDENT 7.0
.TP
.B name
The 5x5 product key given to you by Microsoft
.UNINDENT
.UNINDENT
.SS salt.states.win_network
.SS Configuration of network interfaces on Windows hosts
.sp
New in version 2014.1.0.

.sp
This module provides the \fBnetwork\fP state(s) on Windows hosts. DNS servers, IP
addresses and default gateways can currently be managed.
.sp
Below is an example of the configuration for an interface that uses DHCP for
both DNS servers and IP addresses:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Local Area Connection #2:
  network.managed:
    \- dns_proto: dhcp
    \- ip_proto: dhcp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Both the \fBdns_proto\fP and \fBip_proto\fP arguments are required.
.UNINDENT
.UNINDENT
.sp
Static DNS and IP addresses can be configured like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Local Area Connection #2:
  network.managed:
    \- dns_proto: static
    \- dns_servers:
      \- 8.8.8.8
      \- 8.8.4.4
    \- ip_proto: static
    \- ip_addrs:
      \- 10.2.3.4/24
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
IP addresses are specified using the format
\fB<ip\-address>/<subnet\-length>\fP\&. Salt provides a convenience function
called \fI\%ip.get_subnet_length\fP
to calculate the subnet length from a netmask.
.UNINDENT
.UNINDENT
.sp
Optionally, if you are setting a static IP address, you can also specify the
default gateway using the \fBgateway\fP parameter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Local Area Connection #2:
  network.managed:
    \- dns_proto: static
    \- dns_servers:
      \- 8.8.8.8
      \- 8.8.4.4
    \- ip_proto: static
    \- ip_addrs:
      \- 10.2.3.4/24
    \- gateway: 10.2.3.1
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_network.managed(name, dns_proto=None, dns_servers=None, ip_proto=None, ip_addrs=None, gateway=None, enabled=True, **kwargs)
Ensure that the named interface is configured properly.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the interface to manage
.IP \(bu 2
\fBdns_proto\fP (\fI\%str\fP) \-\- None
Set to \fBstatic\fP and use the \fBdns_servers\fP parameter to provide a
list of DNS nameservers. set to \fBdhcp\fP to use DHCP to get the DNS
servers.
.IP \(bu 2
\fBdns_servers\fP (\fI\%list\fP) \-\- None
A list of static DNS servers. To clear the list of DNS servers pass
an empty list (\fB[]\fP). \fBNone\fP will make no changes.
.IP \(bu 2
\fBip_proto\fP (\fI\%str\fP) \-\- None
Set to \fBstatic\fP and use the \fBip_addrs\fP and (optionally)
\fBgateway\fP parameters to provide a list of static IP addresses and
the default gateway. Set to \fBdhcp\fP to use DHCP.
.IP \(bu 2
\fBip_addrs\fP (\fI\%list\fP) \-\- None
A list of static IP addresses with netmask flag, ie: 192.168.0.11/24
.IP \(bu 2
\fBgateway\fP (\fI\%str\fP) \-\- None
The gateway to set for the interface
.IP \(bu 2
\fBenabled\fP (\fI\%bool\fP) \-\- True
Set to \fBFalse\fP to ensure that this interface is disabled.
.UNINDENT
.TP
.B Returns
A dictionary of old and new settings
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Ethernet1:
  network.managed:
    \- dns_proto: static
    \- dns_servers:
      \- 8.8.8.8
      \- 8.8.8.4
    \- ip_proto: static
    \- ip_addrs:
      \- 192.168.0.100/24
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Clear DNS entries example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Ethernet1:
  network.managed:
    \- dns_proto: static
    \- dns_servers: []
    \- ip_proto: dhcp
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_path
.sp
Manage the Windows System PATH
.INDENT 0.0
.TP
.B salt.states.win_path.absent(name)
Remove the directory from the SYSTEM path
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\(aqC:\esysinternals\(aq:
  win_path.absent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_path.exists(name, index=None)
Add the directory to the system PATH at index location
.INDENT 7.0
.TP
.B index
Position where the directory should be placed in the PATH. This is
0\-indexed, so 0 means to prepend at the very start of the PATH.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the index is not specified, and the directory needs to be added
to the PATH, then the directory will be appended to the PATH, and
this state will not enforce its location within the PATH.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\(aqC:\epython27\(aq:
  win_path.exists

\(aqC:\esysinternals\(aq:
  win_path.exists:
    \- index: 0

\(aqC:\emystuff\(aq:
  win_path.exists:
    \- index: \-1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_pki
.sp
Microsoft certificate management via the Pki PowerShell module.
.INDENT 0.0
.TP
.B platform
Windows
.UNINDENT
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.states.win_pki.import_cert(name, cert_format=\(aqcer\(aq, context=\(aqLocalMachine\(aq, store=\(aqMy\(aq, exportable=True, password=\(aq\(aq, saltenv=\(aqbase\(aq)
Import the certificate file into the given certificate store.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The path of the certificate file to import.
.IP \(bu 2
\fBcert_format\fP (\fI\%str\fP) \-\- The certificate format. Specify \(aqcer\(aq for X.509, or \(aqpfx\(aq for PKCS #12.
.IP \(bu 2
\fBcontext\fP (\fI\%str\fP) \-\- The name of the certificate store location context.
.IP \(bu 2
\fBstore\fP (\fI\%str\fP) \-\- The name of the certificate store.
.IP \(bu 2
\fBexportable\fP (\fI\%bool\fP) \-\- Mark the certificate as exportable. Only applicable to pfx format.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- The password of the certificate. Only applicable to pfx format.
.IP \(bu 2
\fBsaltenv\fP (\fI\%str\fP) \-\- The environment the file resides in.
.UNINDENT
.UNINDENT
.sp
Example of usage with only the required arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-cert\-imported:
    win_pki.import_cert:
        \- name: salt://win/webserver/certs/site0.cer
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage specifying all available arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-cert\-imported:
    win_pki.import_cert:
        \- name: salt://win/webserver/certs/site0.pfx
        \- cert_format: pfx
        \- context: LocalMachine
        \- store: My
        \- exportable: True
        \- password: TestPassword
        \- saltenv: base
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_pki.remove_cert(name, thumbprint, context=\(aqLocalMachine\(aq, store=\(aqMy\(aq)
Remove the certificate from the given certificate store.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBthumbprint\fP (\fI\%str\fP) \-\- The thumbprint value of the target certificate.
.IP \(bu 2
\fBcontext\fP (\fI\%str\fP) \-\- The name of the certificate store location context.
.IP \(bu 2
\fBstore\fP (\fI\%str\fP) \-\- The name of the certificate store.
.UNINDENT
.UNINDENT
.sp
Example of usage with only the required arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-cert\-removed:
    win_pki.remove_cert:
        \- thumbprint: 9988776655443322111000AAABBBCCCDDDEEEFFF
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage specifying all available arguments:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
site0\-cert\-removed:
    win_pki.remove_cert:
        \- thumbprint: 9988776655443322111000AAABBBCCCDDDEEEFFF
        \- context: LocalMachine
        \- store: My
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_powercfg
.sp
This module allows you to control the power settings of a windows minion via
powercfg.
.sp
New in version 2015.8.0.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Set timeout to 30 minutes on battery power
monitor:
    powercfg.set_timeout:
        \- value: 30
        \- power: dc
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_powercfg.set_timeout(name, value, power=\(aqac\(aq, scheme=None)
Set the sleep timeouts of specific items such as disk, monitor, etc.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\-
.sp
The setting to change, can be one of the following:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBmonitor\fP
.IP \(bu 2
\fBdisk\fP
.IP \(bu 2
\fBstandby\fP
.IP \(bu 2
\fBhibernate\fP
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBvalue\fP (\fI\%int\fP) \-\- The amount of time in minutes before the item will timeout
.IP \(bu 2
\fBpower\fP (\fI\%str\fP) \-\-
.sp
Set the value for AC or DC power. Default is \fBac\fP\&. Valid options
are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBac\fP (AC Power)
.IP \(bu 2
\fBdc\fP (Battery)
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBscheme\fP (\fI\%str\fP) \-\-
.sp
The scheme to use, leave as \fBNone\fP to use the current. Default is
\fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known
Aliases are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBSCHEME_BALANCED\fP \- Balanced
.IP \(bu 2
\fBSCHEME_MAX\fP \- Power saver
.IP \(bu 2
\fBSCHEME_MIN\fP \- High performance
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Set monitor timeout to 30 minutes on Battery
monitor:
  powercfg.set_timeout:
    \- value: 30
    \- power: dc

# Set disk timeout to 10 minutes on AC Power
disk:
  powercfg.set_timeout:
    \- value: 10
    \- power: ac
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_servermanager
.sp
Manage Windows features via the ServerManager powershell module. Can install and
remove roles/features.
.INDENT 0.0
.TP
.B maintainer
Shane Lee <\fI\%slee@saltstack.com\fP>
.TP
.B platform
Windows Server 2008R2 or greater
.TP
.B depends
win_servermanager.install
.TP
.B depends
win_servermanager.remove
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_servermanager.installed(name, features=None, recurse=False, restart=False, source=None, exclude=None, **kwargs)
Install the windows feature. To install a single feature, use the \fBname\fP
parameter. To install multiple features, use the \fBfeatures\fP parameter.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Some features require reboot after un/installation. If so, until the
server is restarted other features can not be installed!
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\-
.sp
Short name of the feature (the right column in
win_servermanager.list_available). This can be a single feature or a
string of features in a comma delimited list (no spaces)
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
A list is not allowed in the name parameter of any state. Use
the \fBfeatures\fP parameter if you want to pass the features as a
list
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBfeatures\fP (\fIOptional\fP\fI[\fP\fI\%list\fP\fI]\fP) \-\-
.sp
A list of features to install. If this is passed it will be used
instead of the \fBname\fP parameter.
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBrecurse\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Install all sub\-features as well. If the feature is installed but
one of its sub\-features are not installed set this will install
additional sub\-features. This argument was previously renamed from
\fBforce\fP\&. To ensure backwards compatibility \fBforce\fP will
continue to work but please update your states to use the preferred
\fBrecurse\fP arg.
.IP \(bu 2
\fBsource\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- Path to the source files if missing from the target system. None
means that the system will use windows update services to find the
required files. Default is None
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Restarts the computer when installation is complete, if required by
the role/feature installed. Default is False
.IP \(bu 2
\fBexclude\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\-
.sp
The name of the feature to exclude when installing the named
feature. This can be a single feature, a string of features in a
comma\-delimited list (no spaces), or a list of features.
.sp
\fBWARNING:\fP
.INDENT 2.0
.INDENT 3.5
As there is no exclude option for the \fBAdd\-WindowsFeature\fP
or \fBInstall\-WindowsFeature\fP PowerShell commands the features
named in \fBexclude\fP will be installed with other sub\-features
and will then be removed. \fBIf the feature named in \(ga\(gaexclude\(ga\(ga
is not a sub\-feature of one of the installed items it will still
be removed.\fP
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example
.sp
Do not use the role or feature names mentioned in the PKGMGR
documentation. To get a list of available roles and features run the
following command:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <minion_name> win_servermanager.list_available
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Use the name in the right column of the results.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Installs the IIS Web Server Role (Web\-Server)
IIS\-WebServerRole:
  win_servermanager.installed:
    \- recurse: True
    \- name: Web\-Server

# Install multiple features, exclude the Web\-Service
install_multiple_features:
  win_servermanager.installed:
    \- recurse: True
    \- features:
      \- RemoteAccess
      \- XPS\-Viewer
      \- SNMP\-Service
    \- exclude:
      \- Web\-Server
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_servermanager.removed(name, features=None, remove_payload=False, restart=False)
Remove the windows feature To remove a single feature, use the \fBname\fP
parameter. To remove multiple features, use the \fBfeatures\fP parameter.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\-
.sp
Short name of the feature (the right column in
win_servermanager.list_available). This can be a single feature or a
string of features in a comma\-delimited list (no spaces)
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
A list is not allowed in the name parameter of any state. Use
the \fBfeatures\fP parameter if you want to pass the features as a
list
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBfeatures\fP (\fIOptional\fP\fI[\fP\fI\%list\fP\fI]\fP) \-\-
.sp
A list of features to remove. If this is passed it will be used
instead of the \fBname\fP parameter.
.sp
New in version 2018.3.0.


.IP \(bu 2
\fBremove_payload\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- True will cause the feature to be removed from the side\-by\-side
store. To install the feature in the future you will need to
specify the \fBsource\fP
.IP \(bu 2
\fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Restarts the computer when uninstall is complete if required by the
role/feature uninstall. Default is False
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Some features require a reboot after uninstall. If so the feature will
not be completely uninstalled until the server is restarted.
.UNINDENT
.UNINDENT
.sp
Example
.sp
Do not use the role or feature names mentioned in the PKGMGR
documentation. To get a list of available roles and features run the
following command:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt <minion_name> win_servermanager.list_available
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Use the name in the right column of the results.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Uninstall the IIS Web Server Rol (Web\-Server)
IIS\-WebserverRole:
  win_servermanager.removed:
    \- name: Web\-Server

# Uninstall multiple features, reboot if required
uninstall_multiple_features:
  win_servermanager.removed:
    \- features:
      \- RemoteAccess
      \- XPX\-Viewer
      \- SNMP\-Service
    \- restart: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_shortcut
.sp
State module for creating shortcuts on Windows. Handles file shortcuts (\fI\&.lnk\fP)
and url shortcuts (\fI\&.url\fP). Allows for the configuration of icons and hot keys
on file shortcuts. Changing the icon and hot keys are unsupported for url
shortcuts.
.sp
New in version 3005.

.INDENT 0.0
.TP
.B salt.states.win_shortcut.present(name, arguments=\(aq\(aq, description=\(aq\(aq, hot_key=\(aq\(aq, icon_location=\(aq\(aq, icon_index=0, target=\(aq\(aq, window_style=\(aqNormal\(aq, working_dir=\(aq\(aq, backup=False, force=False, make_dirs=False, user=None)
Create a new shortcut. This can be a file shortcut (\fB\&.lnk\fP) or a url
shortcut (\fB\&.url\fP).
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The full path to the shortcut
.IP \(bu 2
\fBtarget\fP (\fI\%str\fP) \-\- The full path to the target
.IP \(bu 2
\fBarguments\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- Any arguments to be passed to the target
.IP \(bu 2
\fBdescription\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The description for the shortcut. This is
shown in the \fBComment\fP field of the dialog box. Default is an
empty string
.IP \(bu 2
\fBhot_key\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\-
.sp
A combination of hot Keys to trigger this
shortcut. This is something like \fBCtrl+Alt+D\fP\&. This is shown in
the \fBShortcut key\fP field in the dialog box. Default is an empty
string. Available options are:
.INDENT 2.0
.IP \(bu 2
Ctrl
.IP \(bu 2
Alt
.IP \(bu 2
Shift
.IP \(bu 2
Ext
.UNINDENT

.IP \(bu 2
\fBicon_index\fP (\fI\%int\fP\fI, \fP\fIoptional\fP) \-\- The index for the icon to use in files that
contain multiple icons. Default is 0
.IP \(bu 2
\fBicon_location\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The full path to a file containing icons.
This is shown in the \fBChange Icon\fP dialog box by clicking the
\fBChange Icon\fP button. If no file is specified and a binary is
passed as the target, Windows will attempt to get the icon from the
binary file. Default is an empty string
.IP \(bu 2
\fBwindow_style\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\-
.sp
The window style the program should start
in. This is shown in the \fBRun\fP field of the dialog box. Default is
\fBNormal\fP\&. Valid options are:
.INDENT 2.0
.IP \(bu 2
Normal
.IP \(bu 2
Minimized
.IP \(bu 2
Maximized
.UNINDENT

.IP \(bu 2
\fBworking_dir\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The full path to the working directory for
the program to run in. This is shown in the \fBStart in\fP field of
the dialog box.
.IP \(bu 2
\fBbackup\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- If there is already a shortcut with the same
name, set this value to \fBTrue\fP to backup the existing shortcut and
continue creating the new shortcut. Default is \fBFalse\fP
.IP \(bu 2
\fBforce\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- If there is already a shortcut with the same
name and you aren\(aqt backing up the shortcut, set this value to
\fBTrue\fP to remove the existing shortcut and create a new with these
settings. Default is \fBFalse\fP
.IP \(bu 2
\fBmake_dirs\fP (\fI\%bool\fP\fI, \fP\fIoptional\fP) \-\- If the parent directory structure does not
exist for the new shortcut, create it. Default is \fBFalse\fP
.IP \(bu 2
\fBuser\fP (\fI\%str\fP\fI, \fP\fIoptional\fP) \-\- The user to be the owner of any directories
created by setting \fBmake_dirs\fP to \fBTrue\fP\&. If no value is passed
Salt will use the user account that it is running under. Default is
an empty string.
.UNINDENT
.TP
.B Returns
.INDENT 7.0
.TP
.B A dictionary containing the changes, comments, and result of the
state
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
KB123456:
  wusa.installed:
    \- source: salt://kb123456.msu

# Create a shortcut and set the \(ga\(gaShortcut key\(ga\(ga (\(ga\(gahot_key\(ga\(ga)
new_shortcut:
  shortcut.present:
    \- name: C:\epath\eto\eshortcut.lnk
    \- target: C:\eWindows\enotepad.exe
    \- hot_key: Ctrl+Alt+N

# Create a shortcut and change the icon to the 3rd one in the icon file
new_shortcut:
  shortcut.present:
    \- name: C:\epath\eto\eshortcut.lnk
    \- target: C:\eWindows\enotepad.exe
    \- icon_location: C:\epath\eto\eicon.ico
    \- icon_index: 2

# Create a shortcut and change the startup mode to full screen
new_shortcut:
  shortcut.present:
    \- name: C:\epath\eto\eshortcut.lnk
    \- target: C:\eWindows\enotepad.exe
    \- window_style: Maximized

# Create a shortcut and change the icon
new_shortcut:
  shortcut.present:
    \- name: C:\epath\eto\eshortcut.lnk
    \- target: C:\eWindows\enotepad.exe
    \- icon_location: C:\epath\eto\eicon.ico

# Create a shortcut and force it to overwrite an existing shortcut
new_shortcut:
  shortcut.present:
    \- name: C:\epath\eto\eshortcut.lnk
    \- target: C:\eWindows\enotepad.exe
    \- force: True

# Create a shortcut and create any parent directories if they are missing
new_shortcut:
  shortcut.present:
    \- name: C:\epath\eto\eshortcut.lnk
    \- target: C:\eWindows\enotepad.exe
    \- make_dirs: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_smtp_server
.sp
Module for managing IIS SMTP server configuration on Windows servers.
.INDENT 0.0
.TP
.B salt.states.win_smtp_server.active_log_format(name, log_format, server=\(aqSmtpSvc/1\(aq)
Manage the active log format for the SMTP server.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBlog_format\fP (\fI\%str\fP) \-\- The log format name.
.IP \(bu 2
\fBserver\fP (\fI\%str\fP) \-\- The SMTP server name.
.UNINDENT
.UNINDENT
.sp
Example of usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
smtp\-log\-format:
    win_smtp_server.active_log_format:
        \- log_format: Microsoft IIS Log File Format
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_smtp_server.connection_ip_list(name, addresses=None, grant_by_default=False, server=\(aqSmtpSvc/1\(aq)
Manage IP list for SMTP connections.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBaddresses\fP (\fI\%str\fP) \-\- A dictionary of IP + subnet pairs.
.IP \(bu 2
\fBgrant_by_default\fP (\fI\%bool\fP) \-\- Whether the addresses should be a blacklist or whitelist.
.IP \(bu 2
\fBserver\fP (\fI\%str\fP) \-\- The SMTP server name.
.UNINDENT
.UNINDENT
.sp
Example of usage for creating a whitelist:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
smtp\-connection\-whitelist:
    win_smtp_server.connection_ip_list:
        \- addresses:
            127.0.0.1: 255.255.255.255
            172.16.1.98: 255.255.255.255
            172.16.1.99: 255.255.255.255
        \- grant_by_default: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage for creating a blacklist:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
smtp\-connection\-blacklist:
    win_smtp_server.connection_ip_list:
        \- addresses:
            172.16.1.100: 255.255.255.255
            172.16.1.101: 255.255.255.255
        \- grant_by_default: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage for allowing any source to connect:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
smtp\-connection\-blacklist:
    win_smtp_server.connection_ip_list:
        \- addresses: {}
        \- grant_by_default: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_smtp_server.relay_ip_list(name, addresses=None, server=\(aqSmtpSvc/1\(aq)
Manage IP list for SMTP relay connections.
.sp
Due to the unusual way that Windows stores the relay IPs, it is advisable to retrieve
the existing list you wish to set from a pre\-configured server.
.sp
For example, setting \(aq127.0.0.1\(aq as an allowed relay IP through the GUI would generate
an actual relay IP list similar to the following:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[\(aq24.0.0.128\(aq, \(aq32.0.0.128\(aq, \(aq60.0.0.128\(aq, \(aq68.0.0.128\(aq, \(aq1.0.0.0\(aq, \(aq76.0.0.0\(aq,
  \(aq0.0.0.0\(aq, \(aq0.0.0.0\(aq, \(aq1.0.0.0\(aq, \(aq1.0.0.0\(aq, \(aq2.0.0.0\(aq, \(aq2.0.0.0\(aq, \(aq4.0.0.0\(aq,
  \(aq0.0.0.0\(aq, \(aq76.0.0.128\(aq, \(aq0.0.0.0\(aq, \(aq0.0.0.0\(aq, \(aq0.0.0.0\(aq, \(aq0.0.0.0\(aq,
  \(aq255.255.255.255\(aq, \(aq127.0.0.1\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Setting the list to None corresponds to the restrictive \(aqOnly the list below\(aq GUI parameter
with an empty access list configured, and setting an empty list/tuple corresponds to the
more permissive \(aqAll except the list below\(aq GUI parameter.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBaddresses\fP (\fI\%str\fP) \-\- A list of the relay IPs. The order of the list is important.
.IP \(bu 2
\fBserver\fP (\fI\%str\fP) \-\- The SMTP server name.
.UNINDENT
.UNINDENT
.sp
Example of usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
smtp\-relay\-list:
  win_smtp_server.relay_ip_list:
    \- addresses:
        \- 24.0.0.128
        \- 32.0.0.128
        \- 60.0.0.128
        \- 1.0.0.0
        \- 76.0.0.0
        \- 0.0.0.0
        \- 0.0.0.0
        \- 1.0.0.0
        \- 1.0.0.0
        \- 2.0.0.0
        \- 2.0.0.0
        \- 4.0.0.0
        \- 0.0.0.0
        \- 76.0.0.128
        \- 0.0.0.0
        \- 0.0.0.0
        \- 0.0.0.0
        \- 0.0.0.0
        \- 255.255.255.255
        \- 127.0.0.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage for disabling relaying:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
smtp\-relay\-list:
    win_smtp_server.relay_ip_list:
        \- addresses: None
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example of usage for allowing relaying from any source:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
smtp\-relay\-list:
    win_smtp_server.relay_ip_list:
        \- addresses: []
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_smtp_server.server_setting(name, settings=None, server=\(aqSmtpSvc/1\(aq)
Ensure the value is set for the specified setting.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The setting names are case\-sensitive.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsettings\fP (\fI\%str\fP) \-\- A dictionary of the setting names and their values.
.IP \(bu 2
\fBserver\fP (\fI\%str\fP) \-\- The SMTP server name.
.UNINDENT
.UNINDENT
.sp
Example of usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
smtp\-settings:
    win_smtp_server.server_setting:
        \- settings:
            LogType: 1
            LogFilePeriod: 1
            MaxMessageSize: 16777216
            MaxRecipients: 10000
            MaxSessionSize: 16777216
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_snmp
.sp
Module for managing SNMP service settings on Windows servers.
.INDENT 0.0
.TP
.B salt.states.win_snmp.agent_settings(name, contact, location, services=None)
Manage the SNMP sysContact, sysLocation, and sysServices settings.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontact\fP (\fI\%str\fP) \-\- The SNMP contact.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- The SNMP location.
.IP \(bu 2
\fBservices\fP (\fI\%str\fP) \-\- A list of selected services.
.UNINDENT
.UNINDENT
.sp
Example of usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
snmp\-agent\-settings:
    win_snmp.agent_settings:
        \- contact: Test Contact
        \- location: Test Location
        \- services:
            \- Physical
            \- Internet
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_snmp.auth_traps_enabled(name, status=True)
Manage the sending of authentication traps.
.INDENT 7.0
.TP
.B Parameters
\fBstatus\fP (\fI\%bool\fP) \-\- The enabled status.
.UNINDENT
.sp
Example of usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
snmp\-auth\-traps:
    win_snmp.auth_traps_enabled:
        \- status: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_snmp.community_names(name, communities=None)
Manage the SNMP accepted community names and their permissions.
.INDENT 7.0
.TP
.B Parameters
\fBcommunities\fP (\fI\%str\fP) \-\- A dictionary of SNMP communities and permissions.
.UNINDENT
.sp
Example of usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
snmp\-community\-names:
    win_snmp.community_names:
        \- communities:
            TestCommunity: Read Only
            OtherCommunity: Read Write
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_system
.SS Management of Windows system information
.sp
New in version 2014.1.0.

.sp
This state is used to manage system information such as the computer name and
description.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ERIK\-WORKSTATION:
  system.computer_name: []

This is Erik\(aqs computer, don\(aqt touch!:
  system.computer_desc: []
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_system.computer_desc(name)
Manage the computer\(aqs description field
.INDENT 7.0
.TP
.B name
The desired computer description
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_system.computer_description(name)
This function is an alias of \fBcomputer_desc\fP\&.
.INDENT 7.0
.INDENT 3.5
Manage the computer\(aqs description field
.INDENT 0.0
.TP
.B name
The desired computer description
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_system.computer_name(name)
Manage the computer\(aqs name
.INDENT 7.0
.TP
.B name
The desired computer name
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_system.hostname(name)
New in version 2016.3.0.

.sp
Manage the hostname of the computer
.INDENT 7.0
.TP
.B name
The hostname to set
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_system.join_domain(name, username=None, password=None, account_ou=None, account_exists=False, restart=False)
Checks if a computer is joined to the Domain. If the computer is not in the
Domain, it will be joined.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the Domain.
.IP \(bu 2
\fBusername\fP (\fI\%str\fP) \-\- Username of an account which is authorized to join computers to the
specified domain. Need to be either fully qualified like
\fI\%user@domain.tld\fP or simply user.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- Password of the account to add the computer to the Domain.
.IP \(bu 2
\fBaccount_ou\fP (\fI\%str\fP) \-\- The DN of the OU below which the account for this computer should be
created when joining the domain,
e.g. ou=computers,ou=departm_432,dc=my\-company,dc=com.
.IP \(bu 2
\fBaccount_exists\fP (\fI\%bool\fP) \-\- Needs to be set to \fBTrue\fP to allow re\-using an existing computer
account.
.IP \(bu 2
\fBrestart\fP (\fI\%bool\fP) \-\- Needs to be set to \fBTrue\fP to restart the computer after a
successful join.
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
join_to_domain:
  system.join_domain:
    \- name: mydomain.local.com
    \- username: myaccount@mydomain.local.com
    \- password: mysecretpassword
    \- restart: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_system.reboot(name, message=None, timeout=5, force_close=True, in_seconds=False, only_on_pending_reboot=True)
Reboot the computer
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmessage\fP (\fI\%str\fP) \-\-
.sp
An optional message to display to users. It will also be used as a
comment in the event log entry.
.sp
The default value is None.

.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\-
.sp
The number of minutes or seconds before a reboot will occur. Whether
this number represents minutes or seconds depends on the value of
\fBin_seconds\fP\&.
.sp
The default value is 5.

.IP \(bu 2
\fBin_seconds\fP (\fI\%bool\fP) \-\-
.sp
If this is True, the value of \fBtimeout\fP will be treated as a number
of seconds. If this is False, the value of \fBtimeout\fP will be treated
as a number of minutes.
.sp
The default value is False.

.IP \(bu 2
\fBforce_close\fP (\fI\%bool\fP) \-\-
.sp
If this is True, running applications will be forced to close without
warning. If this is False, running applications will not get the
opportunity to prompt users about unsaved data.
.sp
The default value is True.

.IP \(bu 2
\fBonly_on_pending_reboot\fP (\fI\%bool\fP) \-\-
.sp
If this is True, the reboot will only occur if the system reports a
pending reboot. If this is False, the reboot will always occur.
.sp
The default value is True.

.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_system.shutdown(name, message=None, timeout=5, force_close=True, reboot=False, in_seconds=False, only_on_pending_reboot=False)
Shutdown the computer
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmessage\fP (\fI\%str\fP) \-\-
.sp
An optional message to display to users. It will also be used as a
comment in the event log entry.
.sp
The default value is None.

.IP \(bu 2
\fBtimeout\fP (\fI\%int\fP) \-\-
.sp
The number of minutes or seconds before a shutdown will occur. Whether
this number represents minutes or seconds depends on the value of
\fBin_seconds\fP\&.
.sp
The default value is 5.

.IP \(bu 2
\fBin_seconds\fP (\fI\%bool\fP) \-\-
.sp
If this is True, the value of \fBtimeout\fP will be treated as a number
of seconds. If this is False, the value of \fBtimeout\fP will be treated
as a number of minutes.
.sp
The default value is False.

.IP \(bu 2
\fBforce_close\fP (\fI\%bool\fP) \-\-
.sp
If this is True, running applications will be forced to close without
warning. If this is False, running applications will not get the
opportunity to prompt users about unsaved data.
.sp
The default value is True.

.IP \(bu 2
\fBreboot\fP (\fI\%bool\fP) \-\-
.sp
If this is True, the computer will restart immediately after shutting
down. If False the system flushes all caches to disk and safely powers
down the system.
.sp
The default value is False.

.IP \(bu 2
\fBonly_on_pending_reboot\fP (\fI\%bool\fP) \-\-
.sp
If this is True, the shutdown will only occur if the system reports a
pending reboot. If this is False, the shutdown will always occur.
.sp
The default value is False.

.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_system.workgroup(name)
New in version 3001.

.sp
Manage the workgroup of the computer
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- The workgroup to set
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
set workgroup:
  system.workgroup:
    \- name: local
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_task
.sp
State module for adding and removing scheduled tasks using the Windows Task
Scheduler.
.INDENT 0.0
.TP
.B salt.states.win_task.absent(name, location=\(aq\e\e\(aq)
Delete a task from the task scheduler.
.sp
New in version 3007.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task to delete.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location of the task.
Default is \(dq\e\(dq which is the root for the task scheduler
(C:WindowsSystem32tasks).
.UNINDENT
.TP
.B Returns
\fBTrue\fP if successful, otherwise \fBFalse\fP
.TP
.B Return type
\fI\%bool\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
test_win_task_absent:
  task.absent:
    \- name: salt
    \- location: \(dq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_task.present(name, location=\(aq\e\e\(aq, user_name=\(aqSystem\(aq, password=None, force=False, **kwargs)
Create a new task in the designated location. This function has many keyword
arguments that are not listed here. For additional arguments see:
.sp
New in version 3007.0.

.INDENT 7.0
.IP \(bu 2
\fBedit_task()\fP
.IP \(bu 2
\fBadd_action()\fP
.IP \(bu 2
\fBadd_trigger()\fP
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the task. This will be displayed in the task
scheduler.
.IP \(bu 2
\fBlocation\fP (\fI\%str\fP) \-\- A string value representing the location in which to
create the task. Default is \(dq\e\(dq which is the root for the task
scheduler (C:WindowsSystem32tasks).
.IP \(bu 2
\fBuser_name\fP (\fI\%str\fP) \-\- The user account under which to run the task. To
specify the \(dqSystem\(dq account, use \(dqSystem\(dq. The password will be
ignored.
.IP \(bu 2
\fBpassword\fP (\fI\%str\fP) \-\- The password to use for authentication. This should set
the task to run whether the user is logged in or not, but is
currently not working.
.IP \(bu 2
\fBforce\fP (\fI\%bool\fP) \-\- Overwrite the existing task.
.UNINDENT
.TP
.B Returns
A dictionary containing the results of the state
.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
test_win_task_present:
  task.present:
    \- name: salt
    \- location: \(dq\(dq
    \- force: True
    \- action_type: Execute
    \- cmd: \(dqdel /Q /S C:\e\eTemp\(dq
    \- trigger_type: Once
    \- start_date: 12\-1\-16
    \- start_time: 01:00
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_wua
.sp
Installation of Windows Updates using the Windows Update Agent
.sp
New in version 2017.7.0.

.sp
Salt can manage Windows updates via the \(dqwua\(dq state module. Updates can be
installed and removed. Update management declarations are as follows:
.sp
For installation:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Install a single update using the KB
KB3194343:
  wua.installed

# Install a single update using the name parameter
install_update:
  wua.installed:
    \- name: KB3194343

# Install multiple updates using the updates parameter and a combination of
# KB number and GUID
install_updates:
  wua.installed:
   \- updates:
     \- KB3194343
     \- bb1dbb26\-3fb6\-45fd\-bb05\-e3c8e379195c
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For removal:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Remove a single update using the KB
KB3194343:
  wua.removed

# Remove a single update using the name parameter
remove_update:
  wua.removed:
    \- name: KB3194343

# Remove multiple updates using the updates parameter and a combination of
# KB number and GUID
remove_updates:
  wua.removed:
   \- updates:
     \- KB3194343
     \- bb1dbb26\-3fb6\-45fd\-bb05\-e3c8e379195c
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_wua.installed(name, updates=None)
Ensure Microsoft Updates are installed. Updates will be downloaded if
needed.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The identifier of a single update to install.
.IP \(bu 2
\fBupdates\fP (\fI\%list\fP) \-\- A list of identifiers for updates to be installed. Overrides
\fBname\fP\&. Default is None.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Identifiers can be the GUID, the KB number, or any part of the
Title of the Microsoft update. GUIDs and KBs are the preferred method
to ensure you\(aqre installing the correct update.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Using a partial KB number or a partial Title could result in
more than one update being installed.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
.INDENT 7.0
.TP
.B A dictionary containing the results of the update. There are three
keys under changes. \fIinstalled\fP is a list of updates that were
successfully installed. \fIfailed\fP is a list of updates that failed
to install. \fIsuperseded\fP is a list of updates that were not
installed because they were superseded by another update.
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# using a GUID
install_update:
  wua.installed:
    \- name: 28cf1b09\-2b1a\-458c\-9bd1\-971d1b26b211

# using a KB
install_update:
  wua.installed:
    \- name: KB3194343

# using the full Title
install_update:
  wua.installed:
    \- name: Security Update for Adobe Flash Player for Windows 10 Version 1607 (for x64\-based Systems) (KB3194343)

# Install multiple updates
install_updates:
  wua.installed:
    \- updates:
      \- KB3194343
      \- 28cf1b09\-2b1a\-458c\-9bd1\-971d1b26b211
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_wua.removed(name, updates=None)
Ensure Microsoft Updates are uninstalled.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The identifier of a single update to uninstall.
.IP \(bu 2
\fBupdates\fP (\fI\%list\fP) \-\- A list of identifiers for updates to be removed. Overrides \fBname\fP\&.
Default is None.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Identifiers can be the GUID, the KB number, or any part of the
Title of the Microsoft update. GUIDs and KBs are the preferred method
to ensure you\(aqre uninstalling the correct update.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Using a partial KB number or a partial Title could result in
more than one update being removed.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Returns
.INDENT 7.0
.TP
.B A dictionary containing the results of the removal. There are
three keys under changes. \fIremoved\fP is a list of updates that
were successfully removed. \fIfailed\fP is a list of updates that
failed to be removed.
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# using a GUID
uninstall_update:
  wua.removed:
    \- name: 28cf1b09\-2b1a\-458c\-9bd1\-971d1b26b211

# using a KB
uninstall_update:
  wua.removed:
    \- name: KB3194343

# using the full Title
uninstall_update:
  wua.removed:
    \- name: Security Update for Adobe Flash Player for Windows 10 Version 1607 (for x64\-based Systems) (KB3194343)

# Install multiple updates
uninstall_updates:
  wua.removed:
    \- updates:
      \- KB3194343
      \- 28cf1b09\-2b1a\-458c\-9bd1\-971d1b26b211
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_wua.uptodate(name, software=True, drivers=False, skip_hidden=False, skip_mandatory=False, skip_reboot=True, categories=None, severities=None)
Ensure Microsoft Updates that match the passed criteria are installed.
Updates will be downloaded if needed.
.sp
This state allows you to update a system without specifying a specific
update to apply. All matching updates will be installed.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name has no functional value and is only used as a tracking
reference
.IP \(bu 2
\fBsoftware\fP (\fI\%bool\fP) \-\- Include software updates in the results (default is True)
.IP \(bu 2
\fBdrivers\fP (\fI\%bool\fP) \-\- Include driver updates in the results (default is False)
.IP \(bu 2
\fBskip_hidden\fP (\fI\%bool\fP) \-\- Skip updates that have been hidden. Default is False.
.IP \(bu 2
\fBskip_mandatory\fP (\fI\%bool\fP) \-\- Skip mandatory updates. Default is False.
.IP \(bu 2
\fBskip_reboot\fP (\fI\%bool\fP) \-\- Skip updates that require a reboot. Default is True.
.IP \(bu 2
\fBcategories\fP (\fI\%list\fP) \-\-
.sp
Specify the categories to list. Must be passed as a list. All
categories returned by default.
.sp
Categories include the following:
.INDENT 2.0
.IP \(bu 2
Critical Updates
.IP \(bu 2
Definition Updates
.IP \(bu 2
Drivers (make sure you set drivers=True)
.IP \(bu 2
Feature Packs
.IP \(bu 2
Security Updates
.IP \(bu 2
Update Rollups
.IP \(bu 2
Updates
.IP \(bu 2
Update Rollups
.IP \(bu 2
Windows 7
.IP \(bu 2
Windows 8.1
.IP \(bu 2
Windows 8.1 drivers
.IP \(bu 2
Windows 8.1 and later drivers
.IP \(bu 2
Windows Defender
.UNINDENT

.IP \(bu 2
\fBseverities\fP (\fI\%list\fP) \-\-
.sp
Specify the severities to include. Must be passed as a list. All
severities returned by default.
.sp
Severities include the following:
.INDENT 2.0
.IP \(bu 2
Critical
.IP \(bu 2
Important
.UNINDENT

.UNINDENT
.TP
.B Returns
.INDENT 7.0
.TP
.B A dictionary containing the results of the update. There are three
keys under changes. \fIinstalled\fP is a list of updates that were
successfully installed. \fIfailed\fP is a list of updates that failed
to install. \fIsuperseded\fP is a list of updates that were not
installed because they were superseded by another update.
.UNINDENT

.TP
.B Return type
\fI\%dict\fP
.UNINDENT
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Update the system using the state defaults
update_system:
  wua.uptodate

# Update the drivers
update_drivers:
  wua.uptodate:
    \- software: False
    \- drivers: True
    \- skip_reboot: False

# Apply all critical updates
update_critical:
  wua.uptodate:
    \- severities:
      \- Critical
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.win_wusa
.sp
Microsoft Updates (KB) Management
.sp
This module provides the ability to enforce KB installations from files (.msu),
without WSUS or Windows Update
.sp
New in version 2018.3.4.

.INDENT 0.0
.TP
.B salt.states.win_wusa.installed(name, source)
Ensure an update is installed on the minion
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- Name of the Windows KB (\(dqKB123456\(dq)
.IP \(bu 2
\fBsource\fP (\fI\%str\fP) \-\- Source of .msu file corresponding to the KB
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
KB123456:
  wusa.installed:
    \- source: salt://kb123456.msu
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.win_wusa.uninstalled(name)
Ensure an update is uninstalled from the minion
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fI\%str\fP) \-\- Name of the Windows KB (\(dqKB123456\(dq)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
KB123456:
  wusa.uninstalled
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.winrepo
.sp
Manage Windows Package Repository
.INDENT 0.0
.TP
.B salt.states.winrepo.genrepo(name, force=False, allow_empty=False)
Refresh the winrepo.p file of the repository (salt\-run winrepo.genrepo)
.sp
If \fBforce\fP is \fBTrue\fP no checks will be made and the repository will be
generated if \fBallow_empty\fP is \fBTrue\fP then the state will not return an
error if there are 0 packages,
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This state only loads on minions that have the \fBroles: salt\-master\fP
grain set.
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo:
  winrepo.genrepo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.wordpress
.sp
This state module is used to manage Wordpress installations
.INDENT 0.0
.TP
.B depends
wp binary from \fI\%http://wp\-cli.org/\fP
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.wordpress.activated(name, path, user)
Activate wordpress plugins
.INDENT 7.0
.TP
.B name
name of plugin to activate
.TP
.B path
path to wordpress installation
.TP
.B user
user who should own the files in the wordpress installation
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HyperDB:
  wordpress.activated:
    \- path: /var/www/html
    \- user: apache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.wordpress.deactivated(name, path, user)
Deactivate wordpress plugins
.INDENT 7.0
.TP
.B name
name of plugin to deactivate
.TP
.B path
path to wordpress installation
.TP
.B user
user who should own the files in the wordpress installation
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
HyperDB:
  wordpress.deactivated:
    \- path: /var/www/html
    \- user: apache
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.wordpress.installed(name, user, admin_user, admin_password, admin_email, title, url)
Run the initial setup of wordpress
.INDENT 7.0
.TP
.B name
path to the wordpress installation
.TP
.B user
user that owns the files for the wordpress installation
.TP
.B admin_user
username for wordpress website administrator user
.TP
.B admin_password
password for wordpress website administrator user
.TP
.B admin_email
email for wordpress website administrator user
.TP
.B title
title for the wordpress website
.TP
.B url
url for the wordpress website
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/var/www/html:
  wordpress.installed:
    \- title: Daniel\(aqs Awesome Blog
    \- user: apache
    \- admin_user: dwallace
    \- admin_email: dwallace@example.com
    \- admin_password: password123
    \- url: https://blog.dwallace.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.x509
.sp
Manage X509 Certificates
.sp
New in version 2015.8.0.

.INDENT 0.0
.TP
.B depends
M2Crypto
.UNINDENT
.sp
Deprecated since version 3006.0.

.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module has been deprecated and will be removed
in Salt 3009 (Potassium). Please migrate to the replacement
modules. For breaking changes between both versions,
you can refer to the \fI\%x509_v2 execution module docs\fP\&.
.sp
They will become the default \fBx509\fP modules in Salt 3008 (Argon).
You can explicitly switch to the new modules before that release
by setting \fBfeatures: {x509_v2: true}\fP in your minion configuration.
.UNINDENT
.UNINDENT
.sp
This module can enable managing a complete PKI infrastructure including creating private keys, CAs,
certificates and CRLs. It includes the ability to generate a private key on a server, and have the
corresponding public key sent to a remote CA to create a CA signed certificate. This can be done in
a secure manner, where private keys are always generated locally and never moved across the network.
.sp
Here is a simple example scenario. In this example \fBca\fP is the ca server,
and \fBwww\fP is a web server that needs a certificate signed by \fBca\fP\&.
.sp
For remote signing, peers must be permitted to remotely call the
\fI\%sign_remote_certificate\fP function.
.sp
/etc/salt/master.d/peer.conf
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
peer:
  .*:
    \- x509.sign_remote_certificate
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
/srv/salt/top.sls
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- cert
  \(aqca\(aq:
    \- ca
  \(aqwww\(aq:
    \- www
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This state creates the CA key, certificate and signing policy. It also publishes the certificate to
the mine where it can be easily retrieved by other minions.
.sp
/srv/salt/ca.sls
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/salt/minion.d/x509.conf:
  file.managed:
    \- source: salt://x509.conf

restart\-salt\-minion:
  cmd.run:
    \- name: \(aqsalt\-call service.restart salt\-minion\(aq
    \- bg: True
    \- onchanges:
      \- file: /etc/salt/minion.d/x509.conf

/etc/pki:
  file.directory

/etc/pki/issued_certs:
  file.directory

/etc/pki/ca.key:
  x509.private_key_managed:
    \- bits: 4096
    \- backup: True

/etc/pki/ca.crt:
  x509.certificate_managed:
    \- signing_private_key: /etc/pki/ca.key
    \- CN: ca.example.com
    \- C: US
    \- ST: Utah
    \- L: Salt Lake City
    \- basicConstraints: \(dqcritical CA:true\(dq
    \- keyUsage: \(dqcritical cRLSign, keyCertSign\(dq
    \- subjectKeyIdentifier: hash
    \- authorityKeyIdentifier: keyid,issuer:always
    \- days_valid: 3650
    \- days_remaining: 0
    \- backup: True
    \- require:
      \- file: /etc/pki
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The signing policy defines properties that override any property requested or included in a CRL. It also
can define a restricted list of minions which are allowed to remotely invoke this signing policy.
.sp
/srv/salt/x509.conf
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mine_functions:
  x509.get_pem_entries: [/etc/pki/ca.crt]

x509_signing_policies:
  www:
    \- minions: \(aqwww\(aq
    \- signing_private_key: /etc/pki/ca.key
    \- signing_cert: /etc/pki/ca.crt
    \- C: US
    \- ST: Utah
    \- L: Salt Lake City
    \- basicConstraints: \(dqcritical CA:false\(dq
    \- keyUsage: \(dqcritical keyEncipherment\(dq
    \- subjectKeyIdentifier: hash
    \- authorityKeyIdentifier: keyid,issuer:always
    \- days_valid: 90
    \- copypath: /etc/pki/issued_certs/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This state will instruct all minions to trust certificates signed by our new CA.
Using Jinja to strip newlines from the text avoids dealing with newlines in the rendered YAML,
and the  \fBsign_remote_certificate\fP state will
handle properly formatting the text before writing the output.
.sp
/srv/salt/cert.sls
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/usr/local/share/ca\-certificates:
  file.directory

/usr/local/share/ca\-certificates/intca.crt:
  x509.pem_managed:
    \- text: {{ salt[\(aqmine.get\(aq](\(aqca\(aq, \(aqx509.get_pem_entries\(aq)[\(aqca\(aq][\(aq/etc/pki/ca.crt\(aq]|replace(\(aq\en\(aq, \(aq\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This state creates a private key then requests a certificate signed by ca according to the www policy.
.sp
/srv/salt/www.sls
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/pki/www.crt:
  x509.private_key_managed:
    \- name: /etc/pki/www.key
    \- bits: 4096
    \- backup: True

/etc/pki/www.crt:
  x509.certificate_managed:
    \- ca_server: ca
    \- signing_policy: www
    \- public_key: /etc/pki/www.key
    \- CN: www.example.com
    \- days_remaining: 30
    \- backup: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This other state creates a private key then requests a certificate signed by ca
according to the www policy but adds a strict date range for the certificate to
be considered valid.
.sp
/srv/salt/www\-time\-limited.sls
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/pki/www\-time\-limited.crt:
  x509.certificate_managed:
    \- ca_server: ca
    \- signing_policy: www
    \- public_key: /etc/pki/www\-time\-limited.key
    \- CN: www.example.com
    \- not_before: 2019\-05\-05 00:00:00
    \- not_after: 2020\-05\-05 14:30:00
    \- backup: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.x509.certificate_managed(name, days_remaining=90, append_certs=None, **kwargs)
Manage a Certificate
.INDENT 7.0
.TP
.B name
Path to the certificate
.TP
.B days_remaining
90
Recreate the certificate if the number of days remaining on it
are less than this number. The value should be less than
\fBdays_valid\fP, otherwise the certificate will be recreated
every time the state is run. A value of 0 disables automatic
renewal.
.TP
.B append_certs:
A list of certificates to be appended to the managed file.
They must be valid PEM files, otherwise an error will be thrown.
.TP
.B kwargs:
Any arguments supported by \fI\%x509.create_certificate\fP or \fI\%file.managed\fP are supported.
.TP
.B not_before:
Initial validity date for the certificate. This date must be specified
in the format \(aq%Y\-%m\-%d %H:%M:%S\(aq.
.sp
New in version 3001.

.TP
.B not_after:
Final validity date for the certificate. This date must be specified in
the format \(aq%Y\-%m\-%d %H:%M:%S\(aq.
.sp
New in version 3001.

.UNINDENT
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/pki/ca.crt:
  x509.certificate_managed:
    \- signing_private_key: /etc/pki/ca.key
    \- CN: ca.example.com
    \- C: US
    \- ST: Utah
    \- L: Salt Lake City
    \- basicConstraints: \(dqcritical CA:true\(dq
    \- keyUsage: \(dqcritical cRLSign, keyCertSign\(dq
    \- subjectKeyIdentifier: hash
    \- authorityKeyIdentifier: keyid,issuer:always
    \- days_valid: 3650
    \- days_remaining: 0
    \- backup: True
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/ssl/www.crt:
  x509.certificate_managed:
    \- ca_server: pki
    \- signing_policy: www
    \- public_key: /etc/ssl/www.key
    \- CN: www.example.com
    \- days_valid: 90
    \- days_remaining: 30
    \- backup: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.x509.crl_managed(name, signing_private_key, signing_private_key_passphrase=None, signing_cert=None, revoked=None, days_valid=100, digest=\(aq\(aq, days_remaining=30, include_expired=False, **kwargs)
Manage a Certificate Revocation List
.INDENT 7.0
.TP
.B name
Path to the certificate
.TP
.B signing_private_key
The private key that will be used to sign the CRL. This is
usually your CA\(aqs private key.
.TP
.B signing_private_key_passphrase
Passphrase to decrypt the private key.
.TP
.B signing_cert
The certificate of the authority that will be used to sign the CRL.
This is usually your CA\(aqs certificate.
.TP
.B revoked
A list of certificates to revoke. Must include either a serial number or a
the certificate itself. Can optionally include the revocation date and
notAfter date from the certificate. See example below for details.
.TP
.B days_valid
100
The number of days the certificate should be valid for.
.TP
.B digest
The digest to use for signing the CRL. This has no effect on versions
of pyOpenSSL less than 0.14.
.TP
.B days_remaining
30
The CRL should be automatically recreated if there are less than
\fBdays_remaining\fP days until the CRL expires. Set to 0 to disable
automatic renewal.
.TP
.B include_expired
False
If \fBTrue\fP, include expired certificates in the CRL.
.TP
.B kwargs
Any arguments supported by \fI\%file.managed\fP are supported.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/pki/ca.crl:
  x509.crl_managed:
    \- signing_private_key: /etc/pki/myca.key
    \- signing_cert: /etc/pki/myca.crt
    \- revoked:
      \- compromized_Web_key:
        \- certificate: /etc/pki/certs/badweb.crt
        \- revocation_date: 2015\-03\-01 00:00:00
        \- reason: keyCompromise
      \- terminated_vpn_user:
        \- serial_number: D6:D2:DC:D8:4D:5C:C0:F4
        \- not_after: 2016\-01\-01 00:00:00
        \- revocation_date: 2015\-02\-25 00:00:00
        \- reason: cessationOfOperation
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.x509.csr_managed(name, **kwargs)
Manage a Certificate Signing Request
.INDENT 7.0
.TP
.B name:
Path to the CSR
.TP
.B properties:
The properties to be added to the certificate request, including items like subject, extensions
and public key. See above for valid properties.
.TP
.B kwargs:
Any arguments supported by \fI\%file.managed\fP are supported.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/pki/mycert.csr:
  x509.csr_managed:
     \- private_key: /etc/pki/mycert.key
     \- CN: www.example.com
     \- C: US
     \- ST: Utah
     \- L: Salt Lake City
     \- keyUsage: \(aqcritical dataEncipherment\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.x509.pem_managed(name, text, backup=False, **kwargs)
Manage the contents of a PEM file directly with the content in text, ensuring correct formatting.
.INDENT 7.0
.TP
.B name:
The path to the file to manage
.TP
.B text:
The PEM formatted text to write.
.TP
.B kwargs:
Any arguments supported by \fI\%file.managed\fP are supported.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.x509.private_key_managed(name, bits=2048, passphrase=None, cipher=\(aqaes_128_cbc\(aq, new=False, overwrite=False, verbose=True, **kwargs)
Manage a private key\(aqs existence.
.INDENT 7.0
.TP
.B name:
Path to the private key
.TP
.B bits:
Key length in bits. Default 2048.
.TP
.B passphrase:
Passphrase for encrypting the private key.
.TP
.B cipher:
Cipher for encrypting the private key.
.TP
.B new:
Always create a new key. Defaults to \fBFalse\fP\&.
Combining new with \fBprereq\fP
can allow key rotation whenever a new certificate is generated.
.TP
.B overwrite:
Overwrite an existing private key if the provided passphrase cannot decrypt it.
.TP
.B verbose:
Provide visual feedback on stdout, dots while key is generated.
Default is True.
.sp
New in version 2016.11.0.

.TP
.B kwargs:
Any kwargs supported by file.managed are supported.
.UNINDENT
.sp
Example:
.sp
The JINJA templating in this example ensures a private key is generated if the file doesn\(aqt exist
and that a new private key is generated whenever the certificate that uses it is to be renewed.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/pki/www.key:
  x509.private_key_managed:
    \- bits: 4096
    \- new: True
    {% if salt[\(aqfile.file_exists\(aq](\(aq/etc/pki/www.key\(aq) \-%}
    \- prereq:
      \- x509: /etc/pki/www.crt
    {%\- endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.x509_v2
.SS Manage X.509 certificates
.sp
New in version 3006.0: This module represents a complete rewrite of the original \fBx509\fP modules
and is named \fBx509_v2\fP since it introduces breaking changes.

.INDENT 0.0
.TP
.B depends
cryptography
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
All parameters that take a public key, private key, certificate,
CSR or CRL can be specified either as a PEM/hex/base64 string or
a path to a local file encoded in all supported formats for the type.
.UNINDENT
.UNINDENT
.sp
Configuration instructions and general remarks are documented
in the \fI\%execution module docs\fP\&.
.sp
For the list of breaking changes versus the previous \fBx509\fP modules,
please also refer to the \fI\%execution module docs\fP\&.
.SS About
.sp
This module can enable managing a complete PKI infrastructure, including creating
private keys, CAs, certificates and CRLs. It includes the ability to generate a
private key on a server, and have the corresponding public key sent to a remote
CA to create a CA signed certificate. This can be done in a secure manner, where
private keys are always generated locally and never moved across the network.
.sp
Example
.sp
Here is a simple example scenario. In this example \fBca\fP is the ca server,
and \fBwww\fP is a web server that needs a certificate signed by \fBca\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Remote signing requires the setup of \fI\%Peer Communication\fP and signing
policies. Please see the \fI\%execution module docs\fP\&.
.UNINDENT
.UNINDENT
.sp
/srv/salt/top.sls
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- cert
  \(aqca\(aq:
    \- ca
  \(aqwww\(aq:
    \- www
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This state creates the CA key, certificate and signing policy. It also publishes
the certificate to the mine, where it can be easily retrieved by other minions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/salt/ca.sls

Configure the x509 module:
  file.managed:
    \- name: /etc/salt/minion.d/x509.conf
    \- source: salt://x509.conf

Restart Salt minion:
  cmd.run:
    \- name: \(aqsalt\-call service.restart salt\-minion\(aq
    \- bg: true
    \- onchanges:
      \- file: /etc/salt/minion.d/x509.conf

Ensure PKI directories exist:
  file.directory:
    \- name: /etc/pki/issued_certs
    \- makedirs: true

Create CA private key:
  x509.private_key_managed:
    \- name: /etc/pki/ca.key
    \- keysize: 4096
    \- backup: true
    \- require:
      \- file: /etc/pki/issued_certs

Create self\-signed CA certificate:
  x509.certificate_managed:
    \- name: /etc/pki/ca.crt
    \- signing_private_key: /etc/pki/ca.key
    \- CN: ca.example.com
    \- C: US
    \- ST: Utah
    \- L: Salt Lake City
    \- basicConstraints: \(dqcritical, CA:true\(dq
    \- keyUsage: \(dqcritical, cRLSign, keyCertSign\(dq
    \- subjectKeyIdentifier: hash
    \- authorityKeyIdentifier: keyid:always,issuer
    \- days_valid: 3650
    \- days_remaining: 0
    \- backup: true
    \- require:
      \- x509: /etc/pki/ca.key
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/salt/x509.conf

# enable x509_v2
features:
  x509_v2: true

# publish the CA certificate to the mine
mine_functions:
  x509.get_pem_entries: [/etc/pki/ca.crt]

# define at least one signing policy for remote signing
x509_signing_policies:
  www:
    \- minions: \(aqwww\(aq
    \- signing_private_key: /etc/pki/ca.key
    \- signing_cert: /etc/pki/ca.crt
    \- C: US
    \- ST: Utah
    \- L: Salt Lake City
    \- basicConstraints: \(dqcritical CA:false\(dq
    \- keyUsage: \(dqcritical keyEncipherment\(dq
    \- subjectKeyIdentifier: hash
    \- authorityKeyIdentifier: keyid:always,issuer
    \- days_valid: 30
    \- copypath: /etc/pki/issued_certs/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example state will instruct all minions to trust certificates signed by
our new CA. Mind that this example works for Debian\-based OS only.
Also note the Jinja call to encode the string to JSON, which will avoid
YAML issues with newline characters.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/salt/cert.sls

Ensure the CA trust bundle exists:
  file.directory:
    \- name: /usr/local/share/ca\-certificates

Ensure our self\-signed CA certificate is included:
  x509.pem_managed:
    \- name: /usr/local/share/ca\-certificates/myca.crt
    \- text: {{ salt[\(dqmine.get\(dq](\(dqca\(dq, \(dqx509.get_pem_entries\(dq)[\(dqca\(dq][\(dq/etc/pki/ca.crt\(dq] | json }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This state creates a private key, then requests a certificate signed by our CA
according to the www policy.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /srv/salt/www.sls

Ensure PKI directory exists:
  file.directory:
    \- name: /etc/pki

Create private key for the certificate:
  x509.private_key_managed:
    \- name: /etc/pki/www.key
    \- keysize: 4096
    \- backup: true
    \- require:
      \- file: /etc/pki

Request certificate:
  x509.certificate_managed:
    \- name: /etc/pki/www.crt
    \- ca_server: ca
    \- signing_policy: www
    \- private_key: /etc/pki/www.key
    \- CN: www.example.com
    \- days_remaining: 7
    \- backup: true
    \- require:
      \- x509: /etc/pki/www.key
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.x509_v2.certificate_managed(name, days_remaining=None, ca_server=None, signing_policy=None, encoding=\(aqpem\(aq, append_certs=None, copypath=None, prepend_cn=False, digest=\(aqsha256\(aq, signing_private_key=None, signing_private_key_passphrase=None, signing_cert=None, public_key=None, private_key=None, private_key_passphrase=None, csr=None, subject=None, serial_number=None, not_before=None, not_after=None, days_valid=None, pkcs12_passphrase=None, pkcs12_encryption_compat=False, pkcs12_friendlyname=None, **kwargs)
Ensure an X.509 certificate is present as specified.
.sp
This function accepts the same arguments as \fI\%x509.create_certificate\fP,
as well as most ones for \fI:py:func:\(gafile.managed <salt.states.file.managed>\fP\&.
.INDENT 7.0
.TP
.B name
The path the certificate should be present at.
.TP
.B days_remaining
The certificate will be recreated once the remaining certificate validity
period is less than this number of days.
Defaults to \fB90\fP (until v3009) or \fB7\fP (from v3009 onwards).
.TP
.B ca_server
Request a remotely signed certificate from ca_server. For this to
work, a \fBsigning_policy\fP must be specified, and that same policy
must be configured on the ca_server.  Also, the Salt master must
permit peers to call the \fBx509.sign_remote_certificate\fP function.
See the \fI\%execution module docs\fP for details.
.TP
.B signing_policy
The name of a configured signing policy. Parameters specified in there
are hardcoded and cannot be overridden. This is required for remote signing,
otherwise optional.
.TP
.B encoding
Specify the encoding of the resulting certificate. It can be serialized
as a \fBpem\fP (or \fBpkcs7_pem\fP) text file or in several binary formats
(\fBder\fP, \fBpkcs7_der\fP, \fBpkcs12\fP). Defaults to \fBpem\fP\&.
.TP
.B append_certs
A list of additional certificates to append to the new one, e.g. to create a CA chain.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Mind that when \fBder\fP encoding is in use, appending certificatees is prohibited.
.UNINDENT
.UNINDENT
.TP
.B copypath
Create a copy of the issued certificate in PEM format in this directory.
The file will be named \fB<serial_number>.crt\fP if prepend_cn is false.
.TP
.B prepend_cn
When \fBcopypath\fP is set, prepend the common name of the certificate to
the file name like so: \fB<CN>\-<serial_number>.crt\fP\&. Defaults to false.
.TP
.B digest
The hashing algorithm to use for the signature. Valid values are:
sha1, sha224, sha256, sha384, sha512, sha512_224, sha512_256, sha3_224,
sha3_256, sha3_384, sha3_512. Defaults to \fBsha256\fP\&.
This will be ignored for \fBed25519\fP and \fBed448\fP key types.
.TP
.B signing_private_key
The private key corresponding to the public key in \fBsigning_cert\fP\&. Required.
.TP
.B signing_private_key_passphrase
If \fBsigning_private_key\fP is encrypted, the passphrase to decrypt it.
.TP
.B signing_cert
The CA certificate to be used for signing the issued certificate.
.TP
.B public_key
The public key the certificate should be issued for. Other ways of passing
the required information are \fBprivate_key\fP and \fBcsr\fP\&. If neither are set,
the public key of the \fBsigning_private_key\fP will be included, i.e.
a self\-signed certificate is generated.
.TP
.B private_key
The private key corresponding to the public key the certificate should
be issued for. This is one way of specifying the public key that will
be included in the certificate, the other ones being \fBpublic_key\fP and \fBcsr\fP\&.
.TP
.B private_key_passphrase
If \fBprivate_key\fP is specified and encrypted, the passphrase to decrypt it.
.TP
.B csr
A certificate signing request to use as a base for generating the certificate.
The following information will be respected, depending on configuration:
.INDENT 7.0
.IP \(bu 2
public key
.IP \(bu 2
extensions, if not otherwise specified (arguments, signing_policy)
.UNINDENT
.TP
.B subject
The subject\(aqs distinguished name embedded in the certificate. This is one way of
passing this information (see \fBkwargs\fP below for the other).
This argument will be preferred and allows to control the order of RDNs in the DN
as well as to embed RDNs with multiple attributes.
This can be specified as a RFC4514\-encoded string (\fBCN=example.com,O=Example Inc,C=US\fP,
mind that the rendered order is reversed from what is embedded), a list
of RDNs encoded as in RFC4514 (\fB[\(dqC=US\(dq, \(dqO=Example Inc\(dq, \(dqCN=example.com\(dq]\fP)
or a dictionary (\fB{\(dqCN\(dq: \(dqexample.com\(dq, \(dqC\(dq: \(dqUS\(dq, \(dqO\(dq: \(dqExample Inc\(dq}\fP,
default ordering).
Multiple name attributes per RDN are concatenated with a \fB+\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Parsing of RFC4514 strings requires at least cryptography release 37.
.UNINDENT
.UNINDENT
.TP
.B serial_number
A serial number to be embedded in the certificate. If unspecified, will
autogenerate one. This should be an integer, either in decimal or
hexadecimal notation.
.TP
.B not_before
Set a specific date the certificate should not be valid before.
The format should follow \fB%Y\-%m\-%d %H:%M:%S\fP and will be interpreted as GMT/UTC.
Defaults to the time of issuance.
.TP
.B not_after
Set a specific date the certificate should not be valid after.
The format should follow \fB%Y\-%m\-%d %H:%M:%S\fP and will be interpreted as GMT/UTC.
If unspecified, defaults to the current time plus \fBdays_valid\fP days.
.TP
.B days_valid
If \fBnot_after\fP is unspecified, the number of days from the time of issuance
the certificate should be valid for.
Defaults to \fB365\fP (until v3009) or \fB30\fP (from v3009 onwards).
.TP
.B pkcs12_passphrase
When encoding a certificate as \fBpkcs12\fP, encrypt it with this passphrase.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
PKCS12 encryption is very weak and \fI\%should not be relied on for security\fP\&.
.UNINDENT
.UNINDENT
.TP
.B pkcs12_encryption_compat
OpenSSL 3 and cryptography v37 switched to a much more secure default
encryption for PKCS12, which might be incompatible with some systems.
This forces the legacy encryption. Defaults to False.
.TP
.B pkcs12_friendlyname
When encoding a certificate as \fBpkcs12\fP, a name for the certificate can be included.
.TP
.B kwargs
Embedded X.509v3 extensions and the subject\(aqs distinguished name can be
controlled via supplemental keyword arguments. See
\fI\%x509.create_certificate\fP
for an overview.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.x509_v2.crl_managed(name, signing_private_key, revoked, days_remaining=None, signing_cert=None, signing_private_key_passphrase=None, include_expired=False, days_valid=None, digest=\(aqsha256\(aq, encoding=\(aqpem\(aq, extensions=None, **kwargs)
Ensure a certificate revocation list is present as specified.
.sp
This function accepts the same arguments as \fI\%x509.create_crl\fP,
as well as most ones for \fI:py:func:\(gafile.managed <salt.states.file.managed>\fP\&.
.INDENT 7.0
.TP
.B name
The path the certificate revocation list should be present at.
.TP
.B signing_private_key
Your certificate authority\(aqs private key. It will be used to sign
the CRL. Required.
.TP
.B revoked
A list of dicts containing all the certificates to revoke. Each dict
represents one certificate. A dict must contain either the key
\fBserial_number\fP with the value of the serial number to revoke, or
\fBcertificate\fP with some reference to the certificate to revoke.
.sp
The dict can optionally contain the \fBrevocation_date\fP key. If this
key is omitted, the revocation date will be set to now. It should be a
string in the format \fB%Y\-%m\-%d %H:%M:%S\fP\&.
.sp
The dict can also optionally contain the \fBnot_after\fP key. This is
redundant if the \fBcertificate\fP key is included. If the
\fBcertificate\fP key is not included, this can be used for the logic
behind the \fBinclude_expired\fP parameter. It should be a string in
the format \fB%Y\-%m\-%d %H:%M:%S\fP\&.
.sp
The dict can also optionally contain the \fBextensions\fP key, which
allows to set CRL entry\-specific extensions. The following extensions
are supported:
.INDENT 7.0
.TP
.B certificateIssuer
Identifies the certificate issuer associated with an entry in an
indirect CRL. The format is the same as for subjectAltName.
.TP
.B CRLReason
Identifies the reason for certificate revocation.
Available choices are \fBunspecified\fP, \fBkeyCompromise\fP, \fBCACompromise\fP,
\fBaffiliationChanged\fP, \fBsuperseded\fP, \fBcessationOfOperation\fP,
\fBcertificateHold\fP, \fBprivilegeWithdrawn\fP, \fBaACompromise\fP and
\fBremoveFromCRL\fP\&.
.TP
.B invalidityDate
Provides the date on which the certificate became invalid.
The value should be a string in the same format as \fBrevocation_date\fP\&.
.UNINDENT
.TP
.B days_remaining
The certificate revocation list will be recreated once the remaining
CRL validity period is less than this number of days.
Defaults to \fB30\fP (until v3009) or \fB3\fP (from v3009 onwards).
Set to 0 to disable automatic renewal without anything changing.
.TP
.B signing_cert
The CA certificate to be used for signing the issued certificate.
.TP
.B signing_private_key_passphrase
If \fBsigning_private_key\fP is encrypted, the passphrase to decrypt it.
.TP
.B include_expired
Also include already expired certificates in the CRL. Defaults to false.
.TP
.B days_valid
The number of days that the CRL should be valid for. This sets the \fBNext Update\fP
field in the CRL. Defaults to \fB100\fP (until v3009) or \fB7\fP (from v3009 onwards).
.TP
.B digest
The hashing algorithm to use for the signature. Valid values are:
sha1, sha224, sha256, sha384, sha512, sha512_224, sha512_256, sha3_224,
sha3_256, sha3_384, sha3_512. Defaults to \fBsha256\fP\&.
This will be ignored for \fBed25519\fP and \fBed448\fP key types.
.TP
.B encoding
Specify the encoding of the resulting certificate revocation list.
It can be serialized as a \fBpem\fP text or binary \fBder\fP file.
Defaults to \fBpem\fP\&.
.TP
.B extensions
Add CRL extensions. See \fI\%x509.create_crl\fP
for details.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For \fBcRLNumber\fP, in addition the value \fBauto\fP is supported, which
automatically increases the counter every time a new CRL is issued.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Manage CRL:
  x509.crl_managed:
    \- name: /etc/pki/ca.crl
    \- signing_private_key: /etc/pki/myca.key
    \- signing_cert: /etc/pki/myca.crt
    \- revoked:
      \- certificate: /etc/pki/certs/badweb.crt
        revocation_date: 2022\-11\-01 00:00:00
        extensions:
          CRLReason: keyCompromise
      \- serial_number: D6:D2:DC:D8:4D:5C:C0:F4
        not_after: 2023\-03\-14 00:00:00
        revocation_date: 2022\-10\-25 00:00:00
        extensions:
          CRLReason: cessationOfOperation
    \- extensions:
        cRLNumber: auto
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.x509_v2.csr_managed(name, private_key, private_key_passphrase=None, digest=\(aqsha256\(aq, encoding=\(aqpem\(aq, subject=None, **kwargs)
Ensure a certificate signing request is present as specified.
.sp
This function accepts the same arguments as \fI\%x509.create_csr\fP,
as well as most ones for \fI\%file.managed\fP\&.
.INDENT 7.0
.TP
.B name
The path the certificate signing request should be present at.
.TP
.B private_key
The private key corresponding to the public key the certificate should
be issued for. The CSR will be signed by it. Required.
.TP
.B private_key_passphrase
If \fBprivate_key\fP is encrypted, the passphrase to decrypt it.
.TP
.B digest
The hashing algorithm to use for the signature. Valid values are:
sha1, sha224, sha256, sha384, sha512, sha512_224, sha512_256, sha3_224,
sha3_256, sha3_384, sha3_512. Defaults to \fBsha256\fP\&.
This will be ignored for \fBed25519\fP and \fBed448\fP key types.
.TP
.B encoding
Specify the encoding of the resulting certificate revocation list.
It can be serialized as a \fBpem\fP text or binary \fBder\fP file.
Defaults to \fBpem\fP\&.
.TP
.B kwargs
Embedded X.509v3 extensions and the subject\(aqs distinguished name can be
controlled via supplemental keyword arguments.
See \fI\%x509.create_certificate\fP
for an overview. Mind that some extensions are not available for CSR
(\fBauthorityInfoAccess\fP, \fBauthorityKeyIdentifier\fP,
\fBissuerAltName\fP, \fBcrlDistributionPoints\fP).
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.x509_v2.pem_managed(name, text, **kwargs)
Manage the contents of a PEM file directly with the content in text,
ensuring correct formatting.
.INDENT 7.0
.TP
.B name
The path to the file to manage.
.TP
.B text
The PEM\-formatted text to write.
.TP
.B kwargs
Most arguments supported by \fI\%file.managed\fP are passed through.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.x509_v2.private_key_managed(name, algo=\(aqrsa\(aq, keysize=None, passphrase=None, encoding=\(aqpem\(aq, new=False, overwrite=False, pkcs12_encryption_compat=False, **kwargs)
Ensure a private key is present as specified.
.sp
This function accepts the same arguments as \fI\%x509.create_private_key\fP,
as well as most ones for \fI\%file.managed\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If \fBmode\fP is unspecified, it will default to \fB0400\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The path the private key should be present at.
.TP
.B algo
The digital signature scheme the private key should be based on.
Available: \fBrsa\fP, \fBec\fP, \fBed25519\fP, \fBed448\fP\&. Defaults to \fBrsa\fP\&.
.TP
.B keysize
For \fBrsa\fP, specifies the bitlength of the private key (2048, 3072, 4096).
For \fBec\fP, specifies the NIST curve to use (256, 384, 521).
Irrelevant for Edwards\-curve schemes (\fBed25519\fP, \fBed448\fP).
Defaults to 2048 for RSA and 256 for EC.
.TP
.B passphrase
If this is specified, the private key will be encrypted using this
passphrase. The encryption algorithm cannot be selected, it will be
determined automatically as the best available one.
.TP
.B encoding
Specify the encoding of the resulting private key. It can be serialized
as a \fBpem\fP text, binary \fBder\fP or \fBpkcs12\fP file.
Defaults to \fBpem\fP\&.
.TP
.B new
Always create a new key. Defaults to false.
Combining new with \fBprereq\fP
can allow key rotation whenever a new certificate is generated.
.TP
.B overwrite
Overwrite an existing private key if the provided passphrase cannot decrypt it.
Defaults to false.
.TP
.B pkcs12_encryption_compat
Some operating systems are incompatible with the encryption defaults
for PKCS12 used since OpenSSL v3. This switch triggers a fallback to
\fBPBESv1SHA1And3KeyTripleDESCBC\fP\&.
Please consider the \fI\%notes on PKCS12 encryption\fP\&.
.UNINDENT
.sp
Example:
.sp
The Jinja templating in this example ensures a new private key is generated
if the file does not exist and whenever the associated certificate
is to be renewed.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
Manage www private key:
  x509.private_key_managed:
    \- name: /etc/pki/www.key
    \- keysize: 4096
    \- new: true
{%\- if salt[\(dqfile.file_exists\(dq](\(dq/etc/pki/www.key\(dq) %}
    \- prereq:
      \- x509: /etc/pki/www.crt
{%\- endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.xml
.SS XML Manager
.sp
State management of XML files
.INDENT 0.0
.TP
.B salt.states.xml.value_present(name, xpath, value, **kwargs)
New in version 3000.

.sp
Manages a given XML file
.INDENT 7.0
.TP
.B name
string
The location of the XML file to manage, as an absolute path.
.TP
.B xpath
string
xpath location to manage
.TP
.B value
string
value to ensure present
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ensure_value_true:
  xml.value_present:
    \- name: /tmp/test.xml
    \- xpath: .//playwright[@id=\(aq1\(aq]
    \- value: William Shakespeare
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.xmpp
.SS Sending Messages over XMPP
.sp
New in version 2014.1.0.

.sp
This state is useful for firing messages during state runs, using the XMPP
protocol
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
server\-warning\-message:
  xmpp.send_msg:
    \- name: \(aqThis is a server warning message\(aq
    \- profile: my\-xmpp\-account
    \- recipient: admins@xmpp.example.com/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.xmpp.send_msg(name, recipient, profile)
Send a message to an XMPP user
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
server\-warning\-message:
  xmpp.send_msg:
    \- name: \(aqThis is a server warning message\(aq
    \- profile: my\-xmpp\-account
    \- recipient: admins@xmpp.example.com/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The message to send to the XMPP user
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.xmpp.send_msg_multi(name, profile, recipients=None, rooms=None)
Send a message to an list of recipients or rooms
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
server\-warning\-message:
  xmpp.send_msg:
    \- name: \(aqThis is a server warning message\(aq
    \- profile: my\-xmpp\-account
    \- recipients:
      \- admins@xmpp.example.com/salt
    \- rooms:
      \- qa@conference.xmpp.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B name
The message to send to the XMPP user
.UNINDENT
.UNINDENT
.SS salt.states.zabbix_action
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%zabbix Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Management of Zabbix Action object over Zabbix API.
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B codeauthor
Jakub Sliva <\fI\%jakub.sliva@ultimum.io\fP>
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_action.absent(name, **kwargs)
Makes the Zabbix Action to be absent (either does not exist or delete it).
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Zabbix Action name
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zabbix\-action\-absent:
    zabbix_action.absent:
        \- name: Action name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_action.present(name, params, **kwargs)
Creates Zabbix Action object or if differs update it according defined parameters
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Zabbix Action name
.IP \(bu 2
\fBparams\fP \-\- Definition of the Zabbix Action
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.sp
If there is a need to get a value from current zabbix online (e.g. id of a hostgroup you want to put a discovered
system into), put a dictionary with two keys \(dqquery_object\(dq and \(dqquery_name\(dq instead of the value.
In this example we want to get object id of hostgroup named \(dqVirtual machines\(dq and \(dqDatabases\(dq.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zabbix\-action\-present:
    zabbix_action.present:
        \- name: VMs
        \- params:
            eventsource: 2
            status: 0
            filter:
                evaltype: 2
                conditions:
                    \- conditiontype: 24
                      operator: 2
                      value: \(aqvirtual\(aq
                    \- conditiontype: 24
                      operator: 2
                      value: \(aqkvm\(aq
            operations:
                \- operationtype: 2
                \- operationtype: 4
                  opgroup:
                      \- groupid:
                          query_object: hostgroup
                          query_name: Virtual machines
                      \- groupid:
                          query_object: hostgroup
                          query_name: Databases
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.zabbix_host
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%zabbix Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Management of Zabbix hosts.
.INDENT 0.0
.TP
.B codeauthor
Jiri Kotlin <\fI\%jiri.kotlin@ultimum.io\fP>
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_host.absent(name, **kwargs)
Ensures that the host does not exists, eventually deletes host.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Param
name: technical name of the host
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
TestHostWithInterfaces:
    zabbix_host.absent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_host.assign_templates(host, templates, **kwargs)
Ensures that templates are assigned to the host.
.sp
New in version 2017.7.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhost\fP \-\- technical name of the host
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
add_zabbix_templates_to_host:
    zabbix_host.assign_templates:
        \- host: TestHost
        \- templates:
            \- \(dqTemplate OS Linux\(dq
            \- \(dqTemplate App MySQL\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_host.present(host, groups, interfaces, **kwargs)
Ensures that the host exists, eventually creates new host.
NOTE: please use argument visible_name instead of name to not mess with name from salt sls. This function accepts
all standard host properties: keyword argument names differ depending on your zabbix version, see:
\fI\%https://www.zabbix.com/documentation/2.4/manual/api/reference/host/object#host\fP
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhost\fP \-\- technical name of the host
.IP \(bu 2
\fBgroups\fP \-\- groupids of host groups to add the host to
.IP \(bu 2
\fBinterfaces\fP \-\- interfaces to be created for the host
.IP \(bu 2
\fBproxy_host\fP \-\- Optional proxy name or proxyid to monitor host
.IP \(bu 2
\fBinventory\fP \-\- Optional list or dictionary of inventory names and values
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.IP \(bu 2
\fBvisible_name\fP \-\- Optional \- string with visible name of the host, use \(aqvisible_name\(aq instead of \(aqname\(aq
parameter to not mess with value supplied from Salt sls file.
.IP \(bu 2
\fBinventory_clean\fP \-\- Optional \- Boolean value that selects if the current inventory will be cleaned and
overwritten by the declared inventory list (True); or if the inventory will be kept and only updated with
inventory list contents (False). Defaults to True
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
create_test_host:
    zabbix_host.present:
        \- host: TestHostWithInterfaces
        \- proxy_host: 12345
        \- groups:
            \- 5
            \- 6
            \- 7
        \- interfaces:
            \- test1.example.com:
                \- ip: \(aq192.168.1.8\(aq
                \- type: \(aqAgent\(aq
                \- port: 92
            \- testing2_create:
                \- ip: \(aq192.168.1.9\(aq
                \- dns: \(aqtest2.example.com\(aq
                \- type: \(aqagent\(aq
                \- main: false
            \- testovaci1_ipmi:
                \- ip: \(aq192.168.100.111\(aq
                \- type: \(aqipmi\(aq
        \- inventory:
            \- alias: some alias
            \- asset_tag: jlm3937
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.zabbix_hostgroup
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%zabbix Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Management of Zabbix host groups.
.INDENT 0.0
.TP
.B codeauthor
Jiri Kotlin <\fI\%jiri.kotlin@ultimum.io\fP>
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_hostgroup.absent(name, **kwargs)
Ensures that the host group does not exist, eventually delete host group.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name of the host group
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
delete_testing_host_group:
    zabbix_hostgroup.absent:
        \- name: \(aqMy hostgroup name\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_hostgroup.present(name, **kwargs)
Ensures that the host group exists, eventually creates new host group.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name of the host group
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
create_testing_host_group:
    zabbix_hostgroup.present:
        \- name: \(aqMy hostgroup name\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.zabbix_mediatype
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%zabbix Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Management of Zabbix mediatypes.
.INDENT 0.0
.TP
.B codeauthor
Raymond Kuiper <\fI\%qix@the\-wired.net\fP>
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_mediatype.absent(name, **kwargs)
Ensures that the mediatype does not exist, eventually deletes the mediatype.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name of the mediatype
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
delete_mediatype:
    zabbix_mediatype.absent:
        \- name: \(aqEmail\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_mediatype.present(name, mediatype, **kwargs)
Creates new mediatype.
NOTE: This function accepts all standard mediatype properties: keyword argument names differ depending on your
zabbix version, see:
\fI\%https://www.zabbix.com/documentation/3.0/manual/api/reference/host/object#host_inventory\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name of the mediatype
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
make_new_mediatype:
    zabbix_mediatype.present:
        \- name: \(aqEmail\(aq
        \- mediatype: 0
        \- smtp_server: smtp.example.com
        \- smtp_hello: zabbix.example.com
        \- smtp_email: zabbix@example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.zabbix_template
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%zabbix Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
New in version 2017.7.0.

.sp
Management of Zabbix Template object over Zabbix API.
.INDENT 0.0
.TP
.B codeauthor
Jakub Sliva <\fI\%jakub.sliva@ultimum.io\fP>
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_template.absent(name, **kwargs)
Makes the Zabbix Template to be absent (either does not exist or delete it).
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Zabbix Template name
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zabbix\-template\-absent:
    zabbix_template.absent:
        \- name: Ceph OSD
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_template.is_present(name, **kwargs)
Check if Zabbix Template already exists.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Zabbix Template name
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
does_zabbix\-template\-exist:
    zabbix_template.is_present:
        \- name: Template OS Linux
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_template.present(name, params, static_host_list=True, **kwargs)
Creates Zabbix Template object or if differs update it according defined parameters. See Zabbix API documentation.
.sp
Zabbix API version: >3.0
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Zabbix Template name
.IP \(bu 2
\fBparams\fP \-\- Additional parameters according to Zabbix API documentation
.IP \(bu 2
\fBstatic_host_list\fP \-\- If hosts assigned to the template are controlled
only by this state or can be also assigned externally
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If there is a need to get a value from current zabbix online (e.g. ids of host groups you want the template
to be associated with), put a dictionary with two keys \(dqquery_object\(dq and \(dqquery_name\(dq instead of the value.
In this example we want to create template named \(dqTesting Template\(dq, assign it to hostgroup Templates,
link it to two ceph nodes and create a macro.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
IMPORTANT NOTE:
Objects (except for template name) are identified by name (or by other key in some exceptional cases)
so changing name of object means deleting old one and creating new one with new ID !!!
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B NOT SUPPORTED FEATURES:
.INDENT 7.0
.IP \(bu 2
linked templates
.IP \(bu 2
trigger dependencies
.IP \(bu 2
groups and group prototypes for host prototypes
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
SLS Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zabbix\-template\-present:
    zabbix_template.present:
        \- name: Testing Template
        # Do not touch existing assigned hosts
        # True will detach all other hosts than defined here
        \- static_host_list: False
        \- params:
            description: Template for Ceph nodes
            groups:
                # groups must already exist
                # template must be at least in one hostgroup
                \- groupid:
                    query_object: hostgroup
                    query_name: Templates
            macros:
                \- macro: \(dq{$CEPH_CLUSTER_NAME}\(dq
                  value: ceph
            hosts:
                # hosts must already exist
                \- hostid:
                    query_object: host
                    query_name: ceph\-osd\-01
                \- hostid:
                    query_object: host
                    query_name: ceph\-osd\-02
            # templates:
            # Linked templates \- not supported by state module but can be linked manually (will not be touched)

            applications:
                \- name: Ceph OSD
            items:
                \- name: Ceph OSD avg fill item
                  key_: ceph.osd_avg_fill
                  type: 2
                  value_type: 0
                  delay: 60
                  units: \(aq%\(aq
                  description: \(aqAverage fill of OSD\(aq
                  applications:
                      \- applicationid:
                          query_object: application
                          query_name: Ceph OSD
            triggers:
                \- description: \(dqCeph OSD filled more that 90%\(dq
                  expression: \(dq{{\(aq{\(aq}}Testing Template:ceph.osd_avg_fill.last(){{\(aq}\(aq}}>90\(dq
                  priority: 4
            discoveries:
                \- name: Mounted filesystem discovery
                  key_: vfs.fs.discovery
                  type: 0
                  delay: 60
                  itemprototypes:
                      \- name: Free disk space on {{\(aq{#\(aq}}FSNAME}
                        key_: vfs.fs.size[{{\(aq{#\(aq}}FSNAME},free]
                        type: 0
                        value_type: 3
                        delay: 60
                        applications:
                            \- applicationid:
                                query_object: application
                                query_name: Ceph OSD
                  triggerprototypes:
                      \- description: \(dqFree disk space is less than 20% on volume {{\(aq{#\(aq}}FSNAME{{\(aq}\(aq}}\(dq
                        expression: \(dq{{\(aq{\(aq}}Testing Template:vfs.fs.size[{{\(aq{#\(aq}}FSNAME},free].last(){{\(aq}\(aq}}<20\(dq
            graphs:
                \- name: Ceph OSD avg fill graph
                  width: 900
                  height: 200
                  graphtype: 0
                  gitems:
                      \- color: F63100
                        itemid:
                          query_object: item
                          query_name: Ceph OSD avg fill item
            screens:
                \- name: Ceph
                  hsize: 1
                  vsize: 1
                  screenitems:
                      \- x: 0
                        y: 0
                        resourcetype: 0
                        resourceid:
                            query_object: graph
                            query_name: Ceph OSD avg fill graph
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.zabbix_user
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%zabbix Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Management of Zabbix users.
.INDENT 0.0
.TP
.B codeauthor
Jiri Kotlin <\fI\%jiri.kotlin@ultimum.io\fP>
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_user.absent(name, **kwargs)
Ensures that the user does not exist, eventually delete user.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- user alias
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
George:
    zabbix_user.absent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_user.admin_password_present(name, password=None, **kwargs)
.INDENT 7.0
.TP
.B Initial change of Zabbix Admin password to password taken from one of the sources (only the most prioritized one):
.INDENT 7.0
.IP 1. 3
\(aqpassword\(aq parameter
.IP 2. 3
\(aq_connection_password\(aq parameter
.IP 3. 3
pillar \(aqzabbix.password\(aq setting
.UNINDENT
.UNINDENT
.INDENT 7.0
.IP 1. 3
Tries to log in as Admin with password found in state password parameter or _connection_password
or pillar or default zabbix password in this precise order, if any of them is present.
.IP 2. 3
If one of above passwords matches, it tries to change the password to the most prioritized one.
.IP 3. 3
If not able to connect with any password then it fails.
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Just a name of state
.IP \(bu 2
\fBpassword\fP \-\- Optional \- desired password for Admin to be set
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- Ignored in this state (always assumed \(aqAdmin\(aq)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# password taken from pillar or _connection_password
zabbix\-admin\-password:
    zabbix_user.admin_password_present

# directly set password
zabbix\-admin\-password:
    zabbix_user.admin_password_present:
        \- password: SECRET_PASS
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_user.present(alias, passwd, usrgrps, medias=None, password_reset=False, **kwargs)
Ensures that the user exists, eventually creates new user.
NOTE: use argument firstname instead of name to not mess values with name from salt sls.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBalias\fP \-\- user alias
.IP \(bu 2
\fBpasswd\fP \-\- user\(aqs password
.IP \(bu 2
\fBusrgrps\fP \-\- user groups to add the user to
.IP \(bu 2
\fBmedias\fP \-\- Optional \- user\(aqs medias to create
.IP \(bu 2
\fBpassword_reset\fP \-\- whether or not to reset password at update
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.IP \(bu 2
\fBfirstname\fP \-\- string with firstname of the user, use \(aqfirstname\(aq instead of \(aqname\(aq parameter to not mess     with value supplied from Salt sls file.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
make_user:
    zabbix_user.present:
        \- alias: George
        \- passwd: donottellanyonE@456x
        \- password_reset: True
        \- usrgrps:
            \- 13
            \- 7
        \- medias:
            \- me@example.com:
                \- mediatype: mail
                \- period: \(aq1\-7,00:00\-24:00\(aq
                \- severity: NIWAHD
            \- make_jabber:
                \- active: true
                \- mediatype: jabber
                \- period: \(aq1\-5,08:00\-19:00\(aq
                \- sendto: jabbera@example.com
            \- text_me_morning_disabled:
                \- active: false
                \- mediatype: sms
                \- period: \(aq1\-5,09:30\-10:00\(aq
                \- severity: D
                \- sendto: \(aq+42032132588568\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.zabbix_usergroup
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%zabbix Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Management of Zabbix user groups.
.INDENT 0.0
.TP
.B codeauthor
Jiri Kotlin <\fI\%jiri.kotlin@ultimum.io\fP>
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_usergroup.absent(name, **kwargs)
Ensures that the user group does not exist, eventually delete user group.
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name of the user group
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
delete_thai_monks_usrgrp:
    zabbix_usergroup.absent:
        \- name: \(aqThai monks\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_usergroup.present(name, **kwargs)
Creates new user group.
NOTE: This function accepts all standard user group properties: keyword argument names differ depending on your
zabbix version, see:
\fI\%https://www.zabbix.com/documentation/2.0/manual/appendix/api/usergroup/definitions#user_group\fP
.sp
New in version 2016.3.0.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name of the user group
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
make_new_thai_monks_usergroup:
    zabbix_usergroup.present:
        \- name: \(aqThai monks\(aq
        \- gui_access: 1
        \- debug_mode: 0
        \- users_status: 0
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.zabbix_usermacro
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%zabbix Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Management of Zabbix usermacros.
:codeauthor: Raymond Kuiper <\fI\%qix@the\-wired.net\fP>
.INDENT 0.0
.TP
.B salt.states.zabbix_usermacro.absent(name, hostid=None, **kwargs)
Ensures that the mediatype does not exist, eventually deletes the mediatype.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name of the usermacro
.IP \(bu 2
\fBhostid\fP \-\- id\(aqs of the hosts to apply the usermacro on, if missing a global usermacro is assumed.
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
delete_usermacro:
    zabbix_usermacro.absent:
        \- name: \(aq{$SNMP_COMMUNITY}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_usermacro.present(name, value, hostid=None, **kwargs)
Creates a new usermacro.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- name of the usermacro
.IP \(bu 2
\fBvalue\fP \-\- value of the usermacro
.IP \(bu 2
\fBhostid\fP \-\- id\(aqs of the hosts to apply the usermacro on, if missing a global usermacro is assumed.
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
override host usermacro:
    zabbix_usermacro.present:
        \- name: \(aq{$SNMP_COMMUNITY}\(aq\(aq
        \- value: \(aqpublic\(aq
        \- hostid: 21
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.zabbix_valuemap
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This module will be removed from Salt in version 3009 in favor of
the \fI\%zabbix Salt Extension\fP\&.
.UNINDENT
.UNINDENT
.sp
Management of Zabbix Valuemap object over Zabbix API.
.sp
New in version 2017.7.0.

.INDENT 0.0
.TP
.B codeauthor
Jakub Sliva <\fI\%jakub.sliva@ultimum.io\fP>
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_valuemap.absent(name, **kwargs)
Makes the Zabbix Value map to be absent (either does not exist or delete it).
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Zabbix Value map name
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zabbix\-valuemap\-absent:
    zabbix_valuemap.absent:
        \- name: Value map name
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zabbix_valuemap.present(name, params, **kwargs)
Creates Zabbix Value map object or if differs update it according defined parameters
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP \-\- Zabbix Value map name
.IP \(bu 2
\fBparams\fP \-\- Definition of the Zabbix Value map
.IP \(bu 2
\fB_connection_user\fP \-\- Optional \- zabbix user (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_password\fP \-\- Optional \- zabbix password (can also be set in opts or pillar, see module\(aqs docstring)
.IP \(bu 2
\fB_connection_url\fP \-\- Optional \- url of zabbix frontend (can also be set in opts, pillar, see module\(aqs docstring)
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
zabbix\-valuemap\-present:
    zabbix_valuemap.present:
        \- name: Number mapping
        \- params:
            mappings:
                \- value: 1
                  newvalue: one
                \- value: 2
                  newvalue: two
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.zcbuildout
.SS Management of zc.buildout
.sp
This module is inspired from minitage\(aqs buildout maker
(\fI\%https://github.com/minitage/minitage/blob/master/src/minitage/core/makers/buildout.py\fP)
.sp
New in version 2016.3.0.

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This state module is beta; the API is subject to change and no promise
as to performance or functionality is yet present
.UNINDENT
.UNINDENT
.SS Available Functions
.INDENT 0.0
.IP \(bu 2
built
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
installed1
  buildout.installed:
    \- name: /path/to/buildout

installed2
  buildout.installed:
    \- name: /path/to/buildout
    \- parts:
      \- a
      \- b
    \- python: /path/to/pythonpath/bin/python
    \- unless: /bin/test_something_installed
    \- onlyif: /bin/test_else_installed
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zcbuildout.installed(name, config=\(aqbuildout.cfg\(aq, quiet=False, parts=None, user=None, env=(), buildout_ver=None, test_release=False, distribute=None, new_st=None, offline=False, newest=False, python=\(aq/opt/actions\-runner/_work/salt/salt/.tools\-venvs/py3.10/docs/bin/python\(aq, debug=False, verbose=False, unless=None, onlyif=None, use_vt=False, loglevel=\(aqdebug\(aq, **kwargs)
Install buildout in a specific directory
.sp
It is a thin wrapper to modules.buildout.buildout
.INDENT 7.0
.TP
.B name
directory to execute in
.UNINDENT
.sp
quiet
.INDENT 7.0
.INDENT 3.5
do not output console & logs
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B config
buildout config to use (default: buildout.cfg)
.TP
.B parts
specific buildout parts to run
.TP
.B user
user used to run buildout as
.sp
New in version 2014.1.4.

.TP
.B env
environment variables to set when running
.TP
.B buildout_ver
force a specific buildout version (1 | 2)
.TP
.B test_release
buildout accept test release
.TP
.B new_st
Forcing use of setuptools >= 0.7
.TP
.B distribute
use distribute over setuptools if possible
.TP
.B offline
does buildout run offline
.TP
.B python
python to use
.TP
.B debug
run buildout with \-D debug flag
.TP
.B onlyif
Only execute cmd if statement on the host return 0
.TP
.B unless
Do not execute cmd if statement on the host return 0
.TP
.B newest
run buildout in newest mode
.TP
.B verbose
run buildout in verbose mode (\-vvvvv)
.TP
.B use_vt
Use the new salt VT to stream output [experimental]
.TP
.B loglevel
loglevel for buildout commands
.UNINDENT
.UNINDENT
.SS salt.states.zenoss
.sp
State to manage monitoring in Zenoss.
.sp
New in version 2016.3.0.

.sp
This state module depends on the \(aqzenoss\(aq Salt execution module.
.sp
Allows for setting a state of minions in Zenoss using the Zenoss API. Currently Zenoss 4.x and 5.x are supported.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
enable_monitoring:
  zenoss.monitored:
    \- name: web01.example.com
    \- device_class: /Servers/Linux
    \- collector: localhost
    \- prod_state: 1000
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zenoss.monitored(name, device_class=None, collector=\(aqlocalhost\(aq, prod_state=None)
Ensure a device is monitored. The \(aqname\(aq given will be used for Zenoss device name and should be resolvable.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
enable_monitoring:
  zenoss.monitored:
    \- name: web01.example.com
    \- device_class: /Servers/Linux
    \- collector: localhost
    \- prod_state: 1000
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.zfs
.sp
States for managing zfs datasets
.INDENT 0.0
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B depends
salt.utils.zfs, salt.modules.zfs
.TP
.B platform
smartos, illumos, solaris, freebsd, linux
.UNINDENT
.sp
New in version 2016.3.0.

.sp
Changed in version 2018.3.1: Big refactor to remove duplicate code, better type conversions and improved
consistency in output.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
test/shares/yuki:
  zfs.filesystem_present:
    \- create_parent: true
    \- properties:
        quota: 16G

test/iscsi/haruhi:
  zfs.volume_present:
    \- create_parent: true
    \- volume_size: 16M
    \- sparse: true
    \- properties:
        readonly: on

test/shares/yuki@frozen:
  zfs.snapshot_present

moka_origin:
  zfs.hold_present:
    \- snapshot: test/shares/yuki@frozen

test/shares/moka:
  zfs.filesystem_present:
    \- cloned_from: test/shares/yuki@frozen

test/shares/moka@tsukune:
  zfs.snapshot_absent
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zfs.bookmark_absent(name, force=False, recursive=False)
ensure bookmark is absent on the system
.INDENT 7.0
.TP
.B name
string
name of snapshot
.TP
.B force
boolean
try harder to destroy the dataset (zfs destroy \-f)
.TP
.B recursive
boolean
also destroy all the child datasets (zfs destroy \-r)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zfs.bookmark_present(name, snapshot)
ensure bookmark exists
.INDENT 7.0
.TP
.B name
string
name of bookmark
.TP
.B snapshot
string
name of snapshot
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zfs.filesystem_absent(name, force=False, recursive=False)
ensure filesystem is absent on the system
.INDENT 7.0
.TP
.B name
string
name of filesystem
.TP
.B force
boolean
try harder to destroy the dataset (zfs destroy \-f)
.TP
.B recursive
boolean
also destroy all the child datasets (zfs destroy \-r)
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
If a volume with \fBname\fP exists, this state will succeed without
destroying the volume specified by \fBname\fP\&. This module is dataset type sensitive.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zfs.filesystem_present(name, create_parent=False, properties=None, cloned_from=None)
ensure filesystem exists and has properties set
.INDENT 7.0
.TP
.B name
string
name of filesystem
.TP
.B create_parent
boolean
creates all the non\-existing parent datasets.
any property specified on the command line using the \-o option is ignored.
.TP
.B cloned_from
string
name of snapshot to clone
.TP
.B properties
dict
additional zfs properties (\-o)
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBcloned_from\fP is only use if the filesystem does not exist yet,
when \fBcloned_from\fP is set after the filesystem exists it will be ignored.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Properties do not get cloned, if you specify the properties in the
state file they will be applied on a subsequent run.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zfs.hold_absent(name, snapshot, recursive=False)
ensure hold is absent on the system
.INDENT 7.0
.TP
.B name
string
name of hold
.TP
.B snapshot
string
name of snapshot
.TP
.B recursive
boolean
recursively releases a hold with the given tag on the snapshots of all descendent file systems.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zfs.hold_present(name, snapshot, recursive=False)
ensure hold is present on the system
.INDENT 7.0
.TP
.B name
string
name of holdt
.TP
.B snapshot
string
name of snapshot
.TP
.B recursive
boolean
recursively add hold with the given tag on the snapshots of all descendent file systems.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zfs.promoted(name)
ensure a dataset is not a clone
.INDENT 7.0
.TP
.B name
string
name of fileset or volume
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
only one dataset can be the origin,
if you promote a clone the original will now point to the promoted dataset
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zfs.scheduled_snapshot(name, prefix, recursive=True, schedule=None)
maintain a set of snapshots based on a schedule
.INDENT 7.0
.TP
.B name
string
name of filesystem or volume
.TP
.B prefix
string
prefix for the snapshots
e.g. \(aqtest\(aq will result in snapshots being named \(aqtest\-yyyymmdd_hhmm\(aq
.TP
.B recursive
boolean
create snapshots for all children also
.TP
.B schedule
dict
dict holding the schedule, the following keys are available (minute, hour,
day, month, and year) by default all are set to 0 the value indicated the
number of snapshots of that type to keep around.
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
snapshots will only be created and pruned every time the state runs.
a schedule must be setup to automatically run the state. this means that if
you run the state daily the hourly snapshot will only be made once per day!
.UNINDENT
.UNINDENT
.sp
Changed in version 2018.3.0: switched to localtime from gmtime so times now take into account timezones.

.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zfs.snapshot_absent(name, force=False, recursive=False)
ensure snapshot is absent on the system
.INDENT 7.0
.TP
.B name
string
name of snapshot
.TP
.B force
boolean
try harder to destroy the dataset (zfs destroy \-f)
.TP
.B recursive
boolean
also destroy all the child datasets (zfs destroy \-r)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zfs.snapshot_present(name, recursive=False, properties=None)
ensure snapshot exists and has properties set
.INDENT 7.0
.TP
.B name
string
name of snapshot
.TP
.B recursive
boolean
recursively create snapshots of all descendent datasets
.TP
.B properties
dict
additional zfs properties (\-o)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zfs.volume_absent(name, force=False, recursive=False)
ensure volume is absent on the system
.INDENT 7.0
.TP
.B name
string
name of volume
.TP
.B force
boolean
try harder to destroy the dataset (zfs destroy \-f)
.TP
.B recursive
boolean
also destroy all the child datasets (zfs destroy \-r)
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
If a filesystem with \fBname\fP exists, this state will succeed without
destroying the filesystem specified by \fBname\fP\&. This module is dataset type sensitive.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zfs.volume_present(name, volume_size, sparse=False, create_parent=False, properties=None, cloned_from=None)
ensure volume exists and has properties set
.INDENT 7.0
.TP
.B name
string
name of volume
.TP
.B volume_size
string
size of volume
.TP
.B sparse
boolean
create sparse volume
.TP
.B create_parent
boolean
creates all the non\-existing parent datasets.
any property specified on the command line using the \-o option is ignored.
.TP
.B cloned_from
string
name of snapshot to clone
.TP
.B properties
dict
additional zfs properties (\-o)
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fBcloned_from\fP is only use if the volume does not exist yet,
when \fBcloned_from\fP is set after the volume exists it will be ignored.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Properties do not get cloned, if you specify the properties in the state file
they will be applied on a subsequent run.
.sp
\fBvolume_size\fP is considered a property, so the volume\(aqs size will be
corrected when the properties get updated if it differs from the
original volume.
.sp
The sparse parameter is ignored when using \fBcloned_from\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.zk_concurrency
.SS Control concurrency of steps within state execution using zookeeper
.INDENT 0.0
.TP
.B depends
kazoo
.TP
.B configuration
See \fI\%salt.modules.zookeeper\fP for setup instructions.
.UNINDENT
.sp
This module allows you to \(dqwrap\(dq a state\(aqs execution with concurrency control.
This is useful to protect against all hosts executing highstate simultaneously
if your services don\(aqt all HUP restart. The common way of protecting against this
is to run in batch mode, but that doesn\(aqt protect from another person running
the same batch command (and thereby having 2x the number of nodes deploying at once).
.sp
This module will bock while acquiring a slot, meaning that however the command gets
called it will coordinate with zookeeper to ensure that no more than max_concurrency
steps are executing with a single path.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
acquire_lock:
  zk_concurrency.lock:
    \- name: /trafficeserver
    \- zk_hosts: \(aqzookeeper:2181\(aq
    \- max_concurrency: 4
    \- prereq:
        \- service: trafficserver

trafficserver:
  service.running:
    \- watch:
      \- file: /etc/trafficserver/records.config

/etc/trafficserver/records.config:
  file.managed:
    \- source: salt://records.config

release_lock:
  zk_concurrency.unlock:
    \- name: /trafficserver
    \- require:
        \- service: trafficserver
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example would allow the file state to change, but would limit the
concurrency of the trafficserver service restart to 4.
.INDENT 0.0
.TP
.B salt.states.zk_concurrency.lock(name, zk_hosts=None, identifier=None, max_concurrency=1, timeout=None, ephemeral_lease=False, profile=None, scheme=None, username=None, password=None, default_acl=None)
Block state execution until you are able to get the lock (or hit the timeout)
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zk_concurrency.min_party(name, zk_hosts, min_nodes, blocking=False, profile=None, scheme=None, username=None, password=None, default_acl=None)
Ensure that there are \fImin_nodes\fP in the party at \fIname\fP, optionally blocking if not available.
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zk_concurrency.unlock(name, zk_hosts=None, identifier=None, max_concurrency=1, ephemeral_lease=False, profile=None, scheme=None, username=None, password=None, default_acl=None)
Remove lease from semaphore.
.UNINDENT
.SS salt.states.zone
.sp
Management of Solaris Zones
.INDENT 0.0
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B depends
salt.modules.zoneadm, salt.modules.zonecfg
.TP
.B platform
solaris
.UNINDENT
.sp
New in version 2017.7.0.

.sp
Below are some examples of how to use this state.
Lets start with creating a zone and installing it.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
omipkg1_configuration:
  zone.present:
    \- name: omipkg1
    \- brand: ipkg
    \- zonepath: /zones/omipkg1
    \- properties:
      \- autoboot: true
      \- ip\-type: exclusive
      \- cpu\-shares: 50
    \- resources:
      \- attr:
        \- name: owner
        \- value: Jorge Schrauwen
        \- type: string
      \- attr:
        \- name: description
        \- value: OmniOS ipkg zone for testing
        \- type: string
      \- capped\-memory:
        \- physical: 64M
omipkg1_installation:
  zone.installed:
    \- name: omipkg1
    \- require:
        \- zone: omipkg1_configuration
omipkg1_running:
  zone.booted:
    \- name: omipkg1
    \- require:
        \- zone: omipkg1_installation
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A zone without network access is not very useful. We could update
the zone.present state in the example above to add a network interface
or we could use a separate state for this.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
omipkg1_network:
  zone.resource_present:
    \- name: omipkg1
    \- resource_type: net
    \- resource_selector_property: mac\-addr
    \- resource_selector_value: \(dq02:08:20:a2:a3:10\(dq
    \- physical: znic1
    \- require:
        \- zone: omipkg1_configuration
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Since this is a single tenant system having the owner attribute is pointless.
Let\(aqs remove that attribute.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The following state run the omipkg1_configuration state will add it again!
If the entire configuration is managed it would be better to add resource_prune
and optionally the resource_selector_property properties to the resource.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
omipkg1_strip_owner:
  zone.resource_present:
    \- name: omipkg1
    \- resource_type: attr
    \- resource_selector_property: name
    \- resource_selector_value: owner
    \- require:
        \- zone: omipkg1_configuration
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Let\(aqs bump the zone\(aqs CPU shares a bit.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The following state run the omipkg1_configuration state will set it to 50 again.
Update the entire zone configuration is managed you should update it there instead.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
omipkg1_more_cpu:
  zone.property_present:
    \- name: omipkg1
    \- property: cpu\-shares
    \- value: 100
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or we can remove the limit altogether!
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The following state run the omipkg1_configuration state will set it to 50 again.
Update the entire zone configuration is managed you should set the
property to None (nothing after the :) instead.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
omipkg1_no_cpu:
  zone.property_absent:
    \- name: omipkg1
    \- property: cpu\-shares
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zone.absent(name, uninstall=False)
Ensure a zone is absent
.INDENT 7.0
.TP
.B name
string
name of the zone
.TP
.B uninstall
boolean
when true, uninstall instead of detaching the zone first.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zone.attached(name, force=False)
Ensure zone is attached
.INDENT 7.0
.TP
.B name
string
name of the zone
.TP
.B force
boolean
force attach the zone
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zone.booted(name, single=False)
Ensure zone is booted
.INDENT 7.0
.TP
.B name
string
name of the zone
.TP
.B single
boolean
boot in single usermode
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zone.detached(name)
Ensure zone is detached
.INDENT 7.0
.TP
.B name
string
name of the zone
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zone.export(name, path, replace=False)
Export a zones configuration
.INDENT 7.0
.TP
.B name
string
name of the zone
.TP
.B path
string
path of file to export too.
.TP
.B replace
boolean
replace the file if it exists
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zone.halted(name, graceful=True)
Ensure zone is halted
.INDENT 7.0
.TP
.B name
string
name of the zone
.TP
.B graceful
boolean
use shutdown instead of halt if true
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zone.import_(name, path, mode=\(aqimport\(aq, nodataset=False, brand_opts=None)
Import a zones configuration
.INDENT 7.0
.TP
.B name
string
name of the zone
.TP
.B path
string
path of the configuration file to import
.TP
.B mode
string
either import, install, or attach
.TP
.B nodataset
boolean
do not create a ZFS file system
.TP
.B brand_opts
boolean
brand specific options to pass
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The mode argument can be set to \fBimport\fP, \fBinstall\fP, or \fBattach\fP\&.
\fBimport\fP: will only import the configuration
\fBinstall\fP: will import and then try to install the zone
\fBattach\fP: will import and then try to attach of the zone
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
omipkg1:
  zone.import:
    \- path: /foo/bar/baz
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zone.installed(name, nodataset=False, brand_opts=None)
Ensure zone is installed
.INDENT 7.0
.TP
.B name
string
name of the zone
.TP
.B nodataset
boolean
do not create a ZFS file system
.TP
.B brand_opts
boolean
brand specific options to pass
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zone.present(name, brand, zonepath, properties=None, resources=None)
Ensure a zone with certain properties and resources
.INDENT 7.0
.TP
.B name
string
name of the zone
.TP
.B brand
string
brand of the zone
.TP
.B zonepath
string
path of the zone
.TP
.B properties
list of key\-value pairs
dict of properties
.TP
.B resources
list of key\-value pairs
dict of resources
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the zone does not exist it will not be installed.
You can use the \fB\(gazone.installed\(ga\fP state for this.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B Default resource selectors:
.INDENT 7.0
.IP \(bu 2
fs: dir
.IP \(bu 2
net: mac\-addr
.IP \(bu 2
device: match
.IP \(bu 2
rctl: name
.IP \(bu 2
attr: name
.IP \(bu 2
dataset: name
.IP \(bu 2
admin: user
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Properties and resource will not be removed when they
are absent from the state!
.sp
For properties, simple set them to \fB\(gaNone\(ga\fP\&.
.sp
For resources, add the \fB\(garesource_prune\(ga\fP property
and set it to \fB\(gaTrue\(ga\fP\&. Also specify the
\fB\(garesource_selector_property\(ga\fP if the default is not
the one you want.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zone.property_absent(name, property)
Ensure property is absent
.INDENT 7.0
.TP
.B name
string
name of the zone
.TP
.B property
string
name of property
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This does a zoneacfg clear call. So the property may be reset to a default value!
Does has the side effect of always having to be called.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zone.property_present(name, property, value)
Ensure property has a certain value
.INDENT 7.0
.TP
.B name
string
name of the zone
.TP
.B property
string
name of property
.TP
.B value
string
value of property
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zone.resource_absent(name, resource_type, resource_selector_property, resource_selector_value)
Ensure resource is absent
.INDENT 7.0
.TP
.B name
string
name of the zone
.TP
.B resource_type
string
type of resource
.TP
.B resource_selector_property
string
unique resource identifier
.TP
.B resource_selector_value
string
value for resource selection
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Both resource_selector_property and resource_selector_value must be provided, some properties
like \fB\(ganame\(ga\fP are already reserved by salt in there states.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
You can set both resource_selector_property and resource_selector_value to None for
resources that do not require them.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zone.resource_present(name, resource_type, resource_selector_property, resource_selector_value, **kwargs)
Ensure resource exists with provided properties
.INDENT 7.0
.TP
.B name
string
name of the zone
.TP
.B resource_type
string
type of resource
.TP
.B resource_selector_property
string
unique resource identifier
.TP
.B resource_selector_value
string
value for resource selection
.TP
.B kwargs
string|int|...
resource properties
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Both resource_selector_property and resource_selector_value must be
provided, some properties like \fBname\fP are already reserved by salt in
states.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
You can set both resource_selector_property and resource_selector_value
to None for resources that do not require them.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zone.uninstalled(name)
Ensure zone is uninstalled
.INDENT 7.0
.TP
.B name
string
name of the zone
.UNINDENT
.UNINDENT
.SS salt.states.zookeeper
.sp
Zookeeper State
.INDENT 0.0
.TP
.B depends
kazoo
.TP
.B configuration
See \fI\%salt.modules.zookeeper\fP for setup instructions.
.UNINDENT
.SS ACLS
.sp
For more information about acls, please checkout the kazoo documentation.
.sp
\fI\%http://kazoo.readthedocs.io/en/latest/api/security.html#kazoo.security.make_digest_acl\fP
.sp
The following options can be included in the acl dictionary:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B param username
Username to use for the ACL.
.TP
.B param password
A plain\-text password to hash.
.TP
.B param write
Write permission.
.TP
.B type write
bool
.TP
.B param create
Create permission.
.TP
.B type create
bool
.TP
.B param delete
Delete permission.
.TP
.B type delete
bool
.TP
.B param admin
Admin permission.
.TP
.B type admin
bool
.TP
.B param all
All permissions.
.TP
.B type all
bool
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zookeeper.absent(name, version=\-1, recursive=False, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None)
Make sure znode is absent
.INDENT 7.0
.TP
.B name
path to znode
.TP
.B version
Specify the version which should be deleted
Default: \-1 (always match)
.TP
.B recursive
Boolean to indicate if children should be recursively deleted
Default: False
.TP
.B profile
Configured Zookeeper profile to authenticate with (Default: None)
.TP
.B hosts
Lists of Zookeeper Hosts (Default: \(aq127.0.0.1:2181)
.TP
.B scheme
Scheme to authenticate with (Default: \(aqdigest\(aq)
.TP
.B username
Username to authenticate (Default: None)
.TP
.B password
Password to authenticate (Default: None)
.TP
.B default_acl
Default acls to assign if a node is created in this connection (Default: None)
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
delete znode:
  zookeeper.absent:
    \- name: /test
    \- recursive: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zookeeper.acls(name, acls, version=\-1, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None)
Update acls on a znode
.INDENT 7.0
.TP
.B name
path to znode
.TP
.B acls
list of acl dictionaries to set on znode
.TP
.B version
Specify the version which should be deleted
Default: \-1 (always match)
.TP
.B profile
Configured Zookeeper profile to authenticate with (Default: None)
.TP
.B hosts
Lists of Zookeeper Hosts (Default: \(aq127.0.0.1:2181)
.TP
.B scheme
Scheme to authenticate with (Default: \(aqdigest\(aq)
.TP
.B username
Username to authenticate (Default: None)
.TP
.B password
Password to authenticate (Default: None)
.TP
.B default_acl
Default acls to assign if a node is created in this connection (Default: None)
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
update acls:
  zookeeper.acls:
    \- name: /test/name
    \- acls:
      \- username: daniel
        password: test
        all: True
      \- username: gtmanfred
        password: test
        all: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zookeeper.present(name, value, acls=None, ephemeral=False, sequence=False, makepath=False, version=\-1, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None)
Make sure znode is present in the correct state with the correct acls
.INDENT 7.0
.TP
.B name
path to znode
.TP
.B value
value znode should be set to
.TP
.B acls
list of acl dictionaries to set on znode (make sure the ones salt is connected with are included)
Default: None
.TP
.B ephemeral
Boolean to indicate if ephemeral znode should be created
Default: False
.TP
.B sequence
Boolean to indicate if znode path is suffixed with a unique index
Default: False
.TP
.B makepath
Boolean to indicate if the parent paths should be created
Default: False
.TP
.B version
For updating, specify the version which should be updated
Default: \-1 (always match)
.TP
.B profile
Configured Zookeeper profile to authenticate with (Default: None)
.TP
.B hosts
Lists of Zookeeper Hosts (Default: \(aq127.0.0.1:2181)
.TP
.B scheme
Scheme to authenticate with (Default: \(aqdigest\(aq)
.TP
.B username
Username to authenticate (Default: None)
.TP
.B password
Password to authenticate (Default: None)
.TP
.B default_acl
Default acls to assign if a node is created in this connection (Default: None)
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
add znode:
  zookeeper.present:
    \- name: /test/name
    \- value: gtmanfred
    \- makepath: True

update znode:
  zookeeper.present:
    \- name: /test/name
    \- value: daniel
    \- acls:
      \- username: daniel
        password: test
        read: true
      \- username: gtmanfred
        password: test
        read: true
        write: true
        create: true
        delete: true
        admin: true
    \- makepath: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.states.zpool
.sp
States for managing zpools
.INDENT 0.0
.TP
.B maintainer
Jorge Schrauwen <\fI\%sjorge@blackdot.be\fP>
.TP
.B maturity
new
.TP
.B depends
salt.utils.zfs, salt.modules.zpool
.TP
.B platform
smartos, illumos, solaris, freebsd, linux
.UNINDENT
.sp
New in version 2016.3.0.

.sp
Changed in version 2018.3.1: Big refactor to remove duplicate code, better type conversions and improved
consistency in output.

.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
oldpool:
  zpool.absent:
    \- export: true

newpool:
  zpool.present:
    \- config:
        import: false
        force: true
    \- properties:
        comment: salty storage pool
    \- layout:
        \- mirror:
          \- /dev/disk0
          \- /dev/disk1
        \- mirror:
          \- /dev/disk2
          \- /dev/disk3

partitionpool:
  zpool.present:
    \- config:
        import: false
        force: true
    \- properties:
        comment: disk partition salty storage pool
        ashift: \(aq12\(aq
        feature@lz4_compress: enabled
    \- filesystem_properties:
        compression: lz4
        atime: on
        relatime: on
    \- layout:
        \- /dev/disk/by\-uuid/3e43ce94\-77af\-4f52\-a91b\-6cdbb0b0f41b

simplepool:
  zpool.present:
    \- config:
        import: false
        force: true
    \- properties:
        comment: another salty storage pool
    \- layout:
        \- /dev/disk0
        \- /dev/disk1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
The layout will never be updated, it will only be used at time of creation.
It\(aqs a whole lot of work to figure out if a devices needs to be detached, removed,
etc. This is best done by the sysadmin on a case per case basis.
.sp
Filesystem properties are also not updated, this should be managed by the zfs state module.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zpool.absent(name, export=False, force=False)
ensure storage pool is absent on the system
.INDENT 7.0
.TP
.B name
string
name of storage pool
.TP
.B export
boolean
export instead of destroy the zpool if present
.TP
.B force
boolean
force destroy or export
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.states.zpool.present(name, properties=None, filesystem_properties=None, layout=None, config=None)
ensure storage pool is present on the system
.INDENT 7.0
.TP
.B name
string
name of storage pool
.TP
.B properties
dict
optional set of properties to set for the storage pool
.TP
.B filesystem_properties
dict
optional set of filesystem properties to set for the storage pool (creation only)
.TP
.B layout: dict
disk layout to use if the pool does not exist (creation only)
.TP
.B config
dict
fine grain control over this state
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B The following configuration properties can be toggled in the config parameter.
.INDENT 7.0
.IP \(bu 2
import (true) \- try to import the pool before creating it if absent
.IP \(bu 2
import_dirs (None) \- specify additional locations to scan for devices on import (comma\-separated)
.IP \(bu 2
device_dir (None, SunOS=/dev/dsk, Linux=/dev) \- specify device directory to prepend for none
absolute device paths
.IP \(bu 2
force (false) \- try to force the import or creation
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
It is no longer needed to give a unique name to each top\-level vdev, the old
layout format is still supported but no longer recommended.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- mirror:
  \- /tmp/vdisk3
  \- /tmp/vdisk2
\- mirror:
  \- /tmp/vdisk0
  \- /tmp/vdisk1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above yaml will always result in the following zpool create:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
zpool create mypool mirror /tmp/vdisk3 /tmp/vdisk2 mirror /tmp/vdisk0 /tmp/vdisk1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The legacy format is also still supported but not recommended,
because ID\(aqs inside the layout dict must be unique they need to have a suffix.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mirror\-0:
  /tmp/vdisk3
  /tmp/vdisk2
mirror\-1:
  /tmp/vdisk0
  /tmp/vdisk1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Pay attention to the order of your dict!
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- mirror:
  \- /tmp/vdisk0
  \- /tmp/vdisk1
\- /tmp/vdisk2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above will result in the following zpool create:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
zpool create mypool mirror /tmp/vdisk0 /tmp/vdisk1 /tmp/vdisk2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Creating a 3\-way mirror! While you probably expect it to be mirror
root vdev with 2 devices + a root vdev of 1 device!
.UNINDENT
.UNINDENT
.UNINDENT
.SS thorium modules
.TS
center;
|l|l|.
_
T{
\fI\%calc\fP
T}	T{
Used to manage the thorium register.
T}
_
T{
\fI\%check\fP
T}	T{
The check Thorium state is used to create gateways to commands, the checks make it easy to make states that watch registers for changes and then just succeed or fail based on the state of the register, this creates the pattern of having a command execution get gated by a check state via a requisite.
T}
_
T{
\fI\%file\fP
T}	T{
Writes matches to disk to verify activity, helpful when testing
T}
_
T{
\fI\%key\fP
T}	T{
The key Thorium State is used to apply changes to the accepted/rejected/pending keys
T}
_
T{
\fI\%local\fP
T}	T{
Run remote execution commands via the local client
T}
_
T{
\fI\%reg\fP
T}	T{
Used to manage the thorium register.
T}
_
T{
\fI\%runner\fP
T}	T{
React by calling asynchronous runners
T}
_
T{
\fI\%status\fP
T}	T{
This thorium state is used to track the status beacon events and keep track of the active status of minions
T}
_
T{
\fI\%timer\fP
T}	T{
Allow for flow based timers.
T}
_
T{
\fI\%wheel\fP
T}	T{
React by calling asynchronous runners
T}
_
.TE
.SS salt.thorium.calc
.sp
Used to manage the thorium register. The thorium register is where compound
values are stored and computed, such as averages etc.
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B depends
statistics PyPi module
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.calc.add(name, num, minimum=0, maximum=0, ref=None)
Adds together the \fBnum\fP most recent values. Requires a list.
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  calc.add:
    \- name: myregentry
    \- num: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.calc.calc(name, num, oper, minimum=0, maximum=0, ref=None)
Perform a calculation on the \fBnum\fP most recent values. Requires a list.
Valid values for \fBoper\fP are:
.INDENT 7.0
.IP \(bu 2
add: Add last \fBnum\fP values together
.IP \(bu 2
mul: Multiple last \fBnum\fP values together
.IP \(bu 2
mean: Calculate mean of last \fBnum\fP values
.IP \(bu 2
median: Calculate median of last \fBnum\fP values
.IP \(bu 2
median_low: Calculate low median of last \fBnum\fP values
.IP \(bu 2
median_high: Calculate high median of last \fBnum\fP values
.IP \(bu 2
median_grouped: Calculate grouped median of last \fBnum\fP values
.IP \(bu 2
mode: Calculate mode of last \fBnum\fP values
.UNINDENT
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  calc.calc:
    \- name: myregentry
    \- num: 5
    \- oper: mean
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.calc.mean(name, num, minimum=0, maximum=0, ref=None)
Calculates the mean of the \fBnum\fP most recent values. Requires a list.
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  calc.mean:
    \- name: myregentry
    \- num: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.calc.median(name, num, minimum=0, maximum=0, ref=None)
Calculates the mean of the \fBnum\fP most recent values. Requires a list.
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  calc.median:
    \- name: myregentry
    \- num: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.calc.median_grouped(name, num, minimum=0, maximum=0, ref=None)
Calculates the grouped mean of the \fBnum\fP most recent values. Requires a
list.
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  calc.median_grouped:
    \- name: myregentry
    \- num: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.calc.median_high(name, num, minimum=0, maximum=0, ref=None)
Calculates the high mean of the \fBnum\fP most recent values. Requires a list.
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  calc.median_high:
    \- name: myregentry
    \- num: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.calc.median_low(name, num, minimum=0, maximum=0, ref=None)
Calculates the low mean of the \fBnum\fP most recent values. Requires a list.
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  calc.median_low:
    \- name: myregentry
    \- num: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.calc.mode(name, num, minimum=0, maximum=0, ref=None)
Calculates the mode of the \fBnum\fP most recent values. Requires a list.
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  calc.mode:
    \- name: myregentry
    \- num: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.calc.mul(name, num, minimum=0, maximum=0, ref=None)
Multiplies together the \fBnum\fP most recent values. Requires a list.
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  calc.mul:
    \- name: myregentry
    \- num: 5
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.thorium.check
.sp
The check Thorium state is used to create gateways to commands, the checks
make it easy to make states that watch registers for changes and then just
succeed or fail based on the state of the register, this creates the pattern
of having a command execution get gated by a check state via a requisite.
.INDENT 0.0
.TP
.B salt.thorium.check.contains(name, value, count_lt=None, count_lte=None, count_eq=None, count_gte=None, count_gt=None, count_ne=None)
Only succeed if the value in the given register location contains
the given value
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  check.contains:
    \- value: itni

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.ping
    \- require:
      \- check: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.check.eq(name, value)
Only succeed if the value in the given register location is equal to
the given value
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  check.eq:
    \- value: 42

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.ping
    \- require:
      \- check: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.check.event(name)
Chekcs for a specific event match and returns result True if the match
happens
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt/foo/*/bar:
  check.event

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.ping
    \- require:
      \- check: salt/foo/*/bar
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.check.gt(name, value)
Only succeed if the value in the given register location is greater than
the given value
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  check.gt:
    \- value: 42

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.ping
    \- require:
      \- check: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.check.gte(name, value)
Only succeed if the value in the given register location is greater or equal
than the given value
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  check.gte:
    \- value: 42

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.ping
    \- require:
      \- check: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.check.len_eq(name, value)
Only succeed if the length of the given register location is equal to
the given value.
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  check.len_eq:
    \- value: 42

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.ping
    \- require:
      \- check: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.check.len_gt(name, value)
Only succeed if length of the given register location is greater than
the given value.
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  check.len_gt:
    \- value: 42

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.ping
    \- require:
      \- check: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.check.len_gte(name, value)
Only succeed if the length of the given register location is greater or equal
than the given value
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  check.len_gte:
    \- value: 42

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.ping
    \- require:
      \- check: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.check.len_lt(name, value)
Only succeed if the length of the given register location is less than
the given value.
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  check.len_lt:
    \- value: 42

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.ping
    \- require:
      \- check: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.check.len_lte(name, value)
Only succeed if the length of the given register location is less than
or equal the given value
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  check.len_lte:
    \- value: 42

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.ping
    \- require:
      \- check: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.check.len_ne(name, value)
Only succeed if the length of the given register location is not equal to
the given value.
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  check.len_ne:
    \- value: 42

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.ping
    \- require:
      \- check: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.check.lt(name, value)
Only succeed if the value in the given register location is less than
the given value
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  check.lt:
    \- value: 42

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.ping
    \- require:
      \- check: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.check.lte(name, value)
Only succeed if the value in the given register location is less than
or equal the given value
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  check.lte:
    \- value: 42

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.ping
    \- require:
      \- check: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.check.ne(name, value)
Only succeed if the value in the given register location is not equal to
the given value
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  check.ne:
    \- value: 42

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.ping
    \- require:
      \- check: foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.thorium.file
.sp
Writes matches to disk to verify activity, helpful when testing
.sp
Normally this is used by giving the name of the file (without a path) that the
data will be saved to. If for instance you use \fBfoo\fP as the name:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  file.save
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then the file will be saved to:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<salt cachedir>/thorium/saves/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You may also provide an absolute path for the file to be saved to:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/tmp/foo.save:
    file.save
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Files will be saved in JSON format. However, JSON does not support \fBset()\(ga\(gas.
If you are saving a register entry that contains a \(ga\(gaset()\fP, then it will fail
to save to JSON format. However, you may pass data through a filter which makes
it JSON compliant:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  file.save:
    filter: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Be warned that if you do this, then the file will be saved, but not in a format
that can be re\-imported into Python.
.INDENT 0.0
.TP
.B salt.thorium.file.save(name, filter=False)
Save the register to <salt cachedir>/thorium/saves/<name>, or to an
absolute path.
.sp
If an absolute path is specified, then the directory will be created
non\-recursively if it doesn\(aqt exist.
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  file.save

/tmp/foo:
  file.save
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.thorium.key
.sp
The key Thorium State is used to apply changes to the accepted/rejected/pending keys
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.thorium.key.timeout(name, delete=0, reject=0)
If any minion\(aqs status is older than the timeout value then apply the
given action to the timed out key. This example will remove keys to
minions that have not checked in for 300 seconds (5 minutes)
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
statreg:
  status.reg

clean_keys:
  key.timeout:
    \- require:
      \- status: statreg
    \- delete: 300
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.thorium.local
.sp
Run remote execution commands via the local client
.INDENT 0.0
.TP
.B salt.thorium.local.cmd(name, tgt, func, arg=(), tgt_type=\(aqglob\(aq, ret=\(aq\(aq, kwarg=None, **kwargs)
Execute a remote execution command
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.ping

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.sleep
    \- arg:
      \- 30

run_remote_ex:
  local.cmd:
    \- tgt: \(aq*\(aq
    \- func: test.sleep
    \- kwarg:
      length: 30
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.thorium.reg
.sp
Used to manage the thorium register. The thorium register is where compound
values are stored and computed, such as averages etc.
.INDENT 0.0
.TP
.B salt.thorium.reg.clear(name)
Clear the namespace from the register
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
clearns:
  reg.clear:
    \- name: myregister
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.reg.delete(name)
Delete the namespace from the register
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
deletens:
  reg.delete:
    \- name: myregister
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.reg.list_(name, add, match, stamp=False, prune=0)
Add the specified values to the named list
.sp
If \fBstamp\fP is True, then the timestamp from the event will also be added
if \fBprune\fP is set to an integer higher than \fB0\fP, then only the last
\fBprune\fP values will be kept in the list.
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  reg.list:
    \- add: bar
    \- match: my/custom/event
    \- stamp: True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.reg.mean(name, add, match)
Accept a numeric value from the matched events and store a running average
of the values in the given register. If the specified value is not numeric
it will be skipped
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  reg.mean:
    \- add: data_field
    \- match: my/custom/event
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.thorium.reg.set_(name, add, match)
Add a value to the named set
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  reg.set:
    \- add: bar
    \- match: my/custom/event
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.thorium.runner
.sp
React by calling asynchronous runners
.INDENT 0.0
.TP
.B salt.thorium.runner.cmd(name, func=None, arg=(), **kwargs)
Execute a runner asynchronous:
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
run_cloud:
  runner.cmd:
    \- func: cloud.create
    \- arg:
        \- my\-ec2\-config
        \- myinstance

run_cloud:
  runner.cmd:
    \- func: cloud.create
    \- kwargs:
        provider: my\-ec2\-config
        instances: myinstance
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.thorium.status
.sp
This thorium state is used to track the status beacon events and keep track of
the active status of minions
.sp
New in version 2016.11.0.

.INDENT 0.0
.TP
.B salt.thorium.status.reg(name)
Activate this register to turn on a minion status tracking register, this
register keeps the current status beacon data and the time that each beacon
was last checked in.
.UNINDENT
.SS salt.thorium.timer
.sp
Allow for flow based timers. These timers allow for a sleep to exist across
multiple runs of the flow
.INDENT 0.0
.TP
.B salt.thorium.timer.hold(name, seconds)
Wait for a given period of time, then fire a result of True, requiring
this state allows for an action to be blocked for evaluation based on
time
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
hold_on_a_moment:
  timer.hold:
    \- seconds: 30
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.thorium.wheel
.sp
React by calling asynchronous runners
.INDENT 0.0
.TP
.B salt.thorium.wheel.cmd(name, fun=None, arg=(), **kwargs)
Execute a runner asynchronous:
.sp
USAGE:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
run_cloud:
  wheel.cmd:
    \- fun: key.delete
    \- match: minion_id
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS token modules
.TS
center;
|l|l|.
_
T{
\fI\%localfs\fP
T}	T{
Stores eauth tokens in the filesystem of the master.
T}
_
T{
\fI\%rediscluster\fP
T}	T{
Provide token storage in Redis cluster.
T}
_
.TE
.SS salt.tokens.localfs
.sp
Stores eauth tokens in the filesystem of the master. Location is configured by the master config option \(aqtoken_dir\(aq
.INDENT 0.0
.TP
.B salt.tokens.localfs.get_token(opts, tok)
Fetch the token data from the store.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBopts\fP \-\- Salt master config options
.IP \(bu 2
\fBtok\fP \-\- Token value to get
.UNINDENT
.TP
.B Returns
Token data if successful. Empty dict if failed.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.tokens.localfs.list_tokens(opts)
List all tokens in the store.
.INDENT 7.0
.TP
.B Parameters
\fBopts\fP \-\- Salt master config options
.TP
.B Returns
List of dicts (tokens)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.tokens.localfs.mk_token(opts, tdata)
Mint a new token using the config option hash_type and store tdata with \(aqtoken\(aq attribute set
to the token.
This module uses the hash of random 512 bytes as a token.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBopts\fP \-\- Salt master config options
.IP \(bu 2
\fBtdata\fP \-\- Token data to be stored with \(aqtoken\(aq attribute of this dict set to the token.
.UNINDENT
.TP
.B Returns
tdata with token if successful. Empty dict if failed.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.tokens.localfs.rm_token(opts, tok)
Remove token from the store.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBopts\fP \-\- Salt master config options
.IP \(bu 2
\fBtok\fP \-\- Token to remove
.UNINDENT
.TP
.B Returns
Empty dict if successful. None if failed.
.UNINDENT
.UNINDENT
.SS salt.tokens.rediscluster
.sp
Provide token storage in Redis cluster.
.sp
To get started simply start a redis cluster and assign all hashslots to the connected nodes.
Add the redis hostname and port to master configs as eauth_redis_host and eauth_redis_port.
Default values for these configs are as follow:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
eauth_redis_host: localhost
eauth_redis_port: 6379
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B depends
.INDENT 7.0
.IP \(bu 2
redis\-py\-cluster Python package
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.tokens.rediscluster.get_token(opts, tok)
Fetch the token data from the store.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBopts\fP \-\- Salt master config options
.IP \(bu 2
\fBtok\fP \-\- Token value to get
.UNINDENT
.TP
.B Returns
Token data if successful. Empty dict if failed.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.tokens.rediscluster.list_tokens(opts)
List all tokens in the store.
.INDENT 7.0
.TP
.B Parameters
\fBopts\fP \-\- Salt master config options
.TP
.B Returns
List of dicts (token_data)
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.tokens.rediscluster.mk_token(opts, tdata)
Mint a new token using the config option hash_type and store tdata with \(aqtoken\(aq attribute set
to the token.
This module uses the hash of random 512 bytes as a token.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBopts\fP \-\- Salt master config options
.IP \(bu 2
\fBtdata\fP \-\- Token data to be stored with \(aqtoken\(aq attribute of this dict set to the token.
.UNINDENT
.TP
.B Returns
tdata with token if successful. Empty dict if failed.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.tokens.rediscluster.rm_token(opts, tok)
Remove token from the store.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBopts\fP \-\- Salt master config options
.IP \(bu 2
\fBtok\fP \-\- Token to remove
.UNINDENT
.TP
.B Returns
Empty dict if successful. None if failed.
.UNINDENT
.UNINDENT
.SS master tops modules
.TS
center;
|l|l|.
_
T{
\fI\%cobbler\fP
T}	T{
Cobbler Tops
T}
_
T{
\fI\%ext_nodes\fP
T}	T{
External Nodes Classifier
T}
_
T{
\fI\%mongo\fP
T}	T{
Read tops data from a mongodb collection
T}
_
T{
\fI\%reclass_adapter\fP
T}	T{
Read tops data from a reclass database
T}
_
T{
\fI\%saltclass\fP
T}	T{
Saltclass Configuration
T}
_
T{
\fI\%varstack_top\fP
T}	T{
Use \fI\%Varstack\fP to provide tops data
T}
_
.TE
.SS salt.tops.cobbler
.SS Cobbler Tops
.sp
Cobbler Tops is a master tops subsystem used to look up mapping information
from Cobbler via its API. The same cobbler.* parameters are used for both
the Cobbler tops and Cobbler pillar modules.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_tops:
  cobbler: {}
cobbler.url: https://example.com/cobbler_api #default is http://localhost/cobbler_api
cobbler.user: username # default is no username
cobbler.password: password # default is no password
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Module Documentation
.INDENT 0.0
.TP
.B salt.tops.cobbler.top(**kwargs)
Look up top data in Cobbler for a minion.
.UNINDENT
.SS salt.tops.ext_nodes
.SS External Nodes Classifier
.sp
The External Nodes Classifier is a master tops subsystem that retrieves mapping
information from major configuration management systems. One of the most common
external nodes classifiers system is provided by Cobbler and is called
\fBcobbler\-ext\-nodes\fP\&.
.sp
The cobbler\-ext\-nodes command can be used with this configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_tops:
  ext_nodes: cobbler\-ext\-nodes
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is noteworthy that the Salt system does not directly ingest the data
sent from the \fBcobbler\-ext\-nodes\fP command, but converts the data into
information that is used by a Salt top file.
.sp
Any command can replace the call to \(aqcobbler\-ext\-nodes\(aq above, but currently the
data must be formatted in the same way that the standard \(aqcobbler\-ext\-nodes\(aq
does.
.sp
See (admittedly degenerate and probably not complete) example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
classes:
  \- basepackages
  \- database
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above essentially is the same as a top.sls containing the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- basepackages
    \- database

base:
  \(aq*\(aq:
    \- basepackages
    \- database
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.tops.ext_nodes.top(**kwargs)
Run the command configured
.UNINDENT
.SS salt.tops.mongo
.sp
Read tops data from a mongodb collection
.sp
This module will load tops data from a mongo collection. It uses the node\(aqs id
for lookups.
.SS Salt Master Mongo Configuration
.sp
The module shares the same base mongo connection variables as
\fI\%salt.returners.mongo_return\fP\&. These variables go in your master
config file.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBmongo.db\fP \- The mongo database to connect to. Defaults to \fB\(aqsalt\(aq\fP\&.
.IP \(bu 2
\fBmongo.host\fP \- The mongo host to connect to. Supports replica sets by
specifying all hosts in the set, comma\-delimited. Defaults to \fB\(aqsalt\(aq\fP\&.
.IP \(bu 2
\fBmongo.port\fP \- The port that the mongo database is running on. Defaults
to \fB27017\fP\&.
.IP \(bu 2
\fBmongo.user\fP \- The username for connecting to mongo. Only required if
you are using mongo authentication. Defaults to \fB\(aq\(aq\fP\&.
.IP \(bu 2
\fBmongo.password\fP \- The password for connecting to mongo. Only required
if you are using mongo authentication. Defaults to \fB\(aq\(aq\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Configuring the Mongo Tops Subsystem
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_tops:
  mongo:
    collection: tops
    id_field: _id
    re_replace: \(dq\(dq
    re_pattern: \e.example\e.com
    states_field: states
    environment_field: environment
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Module Documentation
.INDENT 0.0
.TP
.B salt.tops.mongo.top(**kwargs)
Connect to a mongo database and read per\-node tops data.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcollection\fP (\fI*\fP) \-\- The mongodb collection to read data from. Defaults to
\fB\(aqtops\(aq\fP\&.
.IP \(bu 2
\fBid_field\fP (\fI*\fP) \-\- The field in the collection that represents an individual
minion id. Defaults to \fB\(aq_id\(aq\fP\&.
.IP \(bu 2
\fBre_pattern\fP (\fI*\fP) \-\- If your naming convention in the collection is shorter
than the minion id, you can use this to trim the name.
\fIre_pattern\fP will be used to match the name, and \fIre_replace\fP will
be used to replace it. Backrefs are supported as they are in the
Python standard library. If \fBNone\fP, no mangling of the name will
be performed \- the collection will be searched with the entire
minion id. Defaults to \fBNone\fP\&.
.IP \(bu 2
\fBre_replace\fP (\fI*\fP) \-\- Use as the replacement value in node ids matched with
\fIre_pattern\fP\&. Defaults to \(aq\(aq. Feel free to use backreferences here.
.IP \(bu 2
\fBstates_field\fP (\fI*\fP) \-\- The name of the field providing a list of states.
.IP \(bu 2
\fBenvironment_field\fP (\fI*\fP) \-\- The name of the field providing the environment.
Defaults to \fBenvironment\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.tops.reclass_adapter
.sp
Read tops data from a reclass database
.sp
This \fI\%master_tops\fP plugin provides access to
the \fBreclass\fP database, such that state information (top data) are retrieved
from \fBreclass\fP\&.
.sp
You can find more information about \fBreclass\fP at
\fI\%http://reclass.pantsfullofunix.net\fP\&.
.sp
To use the plugin, add it to the \fBmaster_tops\fP list in the Salt master config
and tell \fBreclass\fP by way of a few options how and where to find the
inventory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_tops:
  reclass:
    storage_type: yaml_fs
    inventory_base_uri: /srv/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This would cause \fBreclass\fP to read the inventory from YAML files in
\fB/srv/salt/nodes\fP and \fB/srv/salt/classes\fP\&.
.sp
If you are also using \fBreclass\fP as \fBext_pillar\fP plugin, and you want to
avoid having to specify the same information for both, use YAML anchors (take
note of the differing data types for \fBext_pillar\fP and \fBmaster_tops\fP):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
reclass: &reclass
  storage_type: yaml_fs
  inventory_base_uri: /srv/salt
  reclass_source_path: ~/code/reclass

ext_pillar:
  \- reclass: *reclass

master_tops:
  reclass: *reclass
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you want to run reclass from source, rather than installing it, you can
either let the master know via the \fBPYTHONPATH\fP environment variable, or by
setting the configuration option, like in the example above.
.INDENT 0.0
.TP
.B salt.tops.reclass_adapter.top(**kwargs)
Query \fBreclass\fP for the top data (states of the minions).
.UNINDENT
.SS salt.tops.saltclass
.SS Saltclass Configuration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_tops:
  saltclass:
    path: /srv/saltclass
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Description
.sp
This module clones the behaviour of reclass (\fI\%http://reclass.pantsfullofunix.net/\fP),
without the need of an external app, and add several features to improve flexibility.
Saltclass lets you define your nodes from simple \fByaml\fP files (\fB\&.yml\fP) through
hierarchical class inheritance with the possibility to override pillars down the tree.
.SS Features
.INDENT 0.0
.IP \(bu 2
Define your nodes through hierarchical class inheritance
.IP \(bu 2
.INDENT 2.0
.TP
.B Reuse your reclass datas with minimal modifications
.INDENT 7.0
.IP \(bu 2
applications => states
.IP \(bu 2
parameters => pillars
.UNINDENT
.UNINDENT
.IP \(bu 2
Use Jinja templating in your yaml definitions
.IP \(bu 2
.INDENT 2.0
.TP
.B Access to the following Salt objects in Jinja
.INDENT 7.0
.IP \(bu 2
\fB__opts__\fP
.IP \(bu 2
\fB__salt__\fP
.IP \(bu 2
\fB__grains__\fP
.IP \(bu 2
\fB__pillars__\fP
.IP \(bu 2
\fBminion_id\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
Chose how to merge or override your lists using ^ character (see examples)
.IP \(bu 2
Expand variables ${} with possibility to escape them if needed ${} (see examples)
.IP \(bu 2
Ignores missing node/class and will simply return empty without breaking the pillar module completely \- will be logged
.UNINDENT
.sp
An example subset of datas is available here: \fI\%http://git.mauras.ch/salt/saltclass/src/master/examples\fP
.TS
center;
|l|l|.
_
T{
Terms usable in yaml files
T}	T{
Description
T}
_
T{
classes
T}	T{
A list of classes that will be processed in order
T}
_
T{
states
T}	T{
A list of states that will be returned by master_tops function
T}
_
T{
pillars
T}	T{
A yaml dictionary that will be returned by the ext_pillar function
T}
_
T{
environment
T}	T{
Node saltenv that will be used by master_tops
T}
_
.TE
.sp
A class consists of:
.INDENT 0.0
.IP \(bu 2
zero or more parent classes
.IP \(bu 2
zero or more states
.IP \(bu 2
any number of pillars
.UNINDENT
.sp
A child class can override pillars from a parent class.
A node definition is a class in itself with an added \fBenvironment\fP parameter for \fBsaltenv\fP definition.
.SS Class names
.sp
Class names mimic salt way of defining states and pillar files.
This means that \fBdefault.users\fP class name will correspond to one of these:
.INDENT 0.0
.IP \(bu 2
\fB<saltclass_path>/classes/default/users.yml\fP
.IP \(bu 2
\fB<saltclass_path>/classes/default/users/init.yml\fP
.UNINDENT
.SS Saltclass file hierarchy
.sp
A saltclass tree would look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<saltclass_path>
├── classes
│   ├── app
│   │   ├── borgbackup.yml
│   │   └── ssh
│   │       └── server.yml
│   ├── default
│   │   ├── init.yml
│   │   ├── motd.yml
│   │   └── users.yml
│   ├── roles
│   │   ├── app.yml
│   │   └── nginx
│   │       ├── init.yml
│   │       └── server.yml
│   └── subsidiaries
│       ├── gnv.yml
│       ├── qls.yml
│       └── zrh.yml
└── nodes
    ├── geneva
    │   └── gnv.node1.yml
    ├── lausanne
    │   ├── qls.node1.yml
    │   └── qls.node2.yml
    ├── node127.yml
    └── zurich
        ├── zrh.node1.yml
        ├── zrh.node2.yml
        └── zrh.node3.yml
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Saltclass Examples
.sp
\fB<saltclass_path>/nodes/lausanne/qls.node1.yml\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
environment: base

classes:
{% for class in [\(aqdefault\(aq] %}
  \- {{ class }}
{% endfor %}
  \- subsidiaries.{{ __grains__[\(aqid\(aq].split(\(aq.\(aq)[0] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB<saltclass_path>/classes/default/init.yml\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
classes:
  \- default.users
  \- default.motd

states:
  \- openssh

pillars:
  default:
    network:
      dns:
        srv1: 192.168.0.1
        srv2: 192.168.0.2
        domain: example.com
    ntp:
      srv1: 192.168.10.10
      srv2: 192.168.10.20
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB<saltclass_path>/classes/subsidiaries/gnv.yml\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillars:
  default:
    network:
      sub: Geneva
      dns:
        srv1: 10.20.0.1
        srv2: 10.20.0.2
        srv3: 192.168.1.1
        domain: gnv.example.com
    users:
      adm1:
        uid: 1210
        gid: 1210
        gecos: \(aqSuper user admin1\(aq
        homedir: /srv/app/adm1
      adm3:
        uid: 1203
        gid: 1203
        gecos: \(aqSuper user adm
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Variable expansions
.sp
Escaped variables are rendered as is: \fB${test}\fP
.sp
Missing variables are rendered as is: \fB${net:dns:srv2}\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillars:
  app:
  config:
    dns:
      srv1: ${default:network:dns:srv1}
      srv2: ${net:dns:srv2}
    uri: https://application.domain/call?\e${test}
    prod_parameters:
      \- p1
      \- p2
      \- p3
  pkg:
    \- app\-core
    \- app\-backend
.ft P
.fi
.UNINDENT
.UNINDENT
.SS List override
.sp
Not using \fB^\fP as the first entry will simply merge the lists
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillars:
  app:
    pkg:
      \- ^
      \- app\-frontend
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBKnown limitation\fP
.sp
Currently you can\(aqt have both a variable and an escaped variable in the same string as the
escaped one will not be correctly rendered \- \(aq${xx}\(aq will stay as is instead of being rendered as \(aq${xx}\(aq
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.tops.saltclass.top(**kwargs)
Compile tops
.UNINDENT
.SS salt.tops.varstack_top
.sp
Use \fI\%Varstack\fP to provide tops data
.sp
This \fI\%master_tops\fP plugin provides access to
the \fBvarstack\fP hierarchical yaml files, so you can user \fBvarstack\fP as a full
\fI\%external node classifier\fP and
store state information (top data) in it.
.SS Configuring Varstack
.sp
To use varstack as a master top external node classifier, install varstack
as documented. Then, add to your master\(aqs configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_tops:
  varstack: /path/to/the/config/file/varstack.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Varstack will then use /path/to/the/config/file/varstack.yaml (usually
/etc/varstack.yaml) to determine which configuration
data to return as adapter information. From there you can take a look at the
\fI\%README\fP of
varstack to learn how this file is evaluated. The ENC part will just return
the \(aqstates\(aq dictionary for the node.
.sp
Ie, if my.fqdn.yaml file contains:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-\-
states:
  \- sudo
  \- openssh
  \- apache
  \- salt.minion
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
these will be returned as {\(aqbase\(aq: [\(aqsudo\(aq, \(aqopenssh\(aq, \(aqapache\(aq, \(aqsalt.minion\(aq]} and
managed by salt as if given from a top.sls file.
.INDENT 0.0
.TP
.B salt.tops.varstack_top.top(**kwargs)
Query \fBvarstack\fP for the top data (states of the minions).
.UNINDENT
.SS wheel modules
.TS
center;
|l|l|.
_
T{
\fI\%config\fP
T}	T{
Manage the master configuration file
T}
_
T{
\fI\%error\fP
T}	T{
Error generator to enable integration testing of salt wheel error handling
T}
_
T{
\fI\%file_roots\fP
T}	T{
Read in files from the file_root and save files to the file root
T}
_
T{
\fI\%key\fP
T}	T{
Wheel system wrapper for the Salt key system to be used in interactions with the Salt Master programmatically.
T}
_
T{
\fI\%minions\fP
T}	T{
Wheel system wrapper for connected minions
T}
_
T{
\fI\%pillar_roots\fP
T}	T{
The \fIpillar_roots\fP wheel module is used to manage files under the pillar roots directories on the master server.
T}
_
.TE
.SS salt.wheel.config
.sp
Manage the master configuration file
.INDENT 0.0
.TP
.B salt.wheel.config.apply(key, value)
Set a single key
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This will strip comments from your config file
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.config.update_config(file_name, yaml_contents)
Update master config with
\fByaml_contents\fP\&.
.sp
Writes \fByaml_contents\fP to a file named
\fBfile_name.conf\fP under the folder
specified by \fBdefault_include\fP\&.
This folder is named \fBmaster.d\fP by
default. Please look at
\fBinclude\-configuration\fP
for more information.
.sp
Example low data:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
data = {
    \(aqusername\(aq: \(aqsalt\(aq,
    \(aqpassword\(aq: \(aqsalt\(aq,
    \(aqfun\(aq: \(aqconfig.update_config\(aq,
    \(aqfile_name\(aq: \(aqgui\(aq,
    \(aqyaml_contents\(aq: {\(aqid\(aq: 1},
    \(aqclient\(aq: \(aqwheel\(aq,
    \(aqeauth\(aq: \(aqpam\(aq,
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.config.values()
Return the raw values of the config file
.UNINDENT
.SS salt.wheel.error
.sp
Error generator to enable integration testing of salt wheel error handling
.INDENT 0.0
.TP
.B salt.wheel.error.error(name=None, message=\(aq\(aq)
If name is None Then return empty dict
.sp
Otherwise raise an exception with __name__ from name, message from message
.sp
CLI Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-wheel error
salt\-wheel error.error name=\(dqException\(dq message=\(dqThis is an error.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.wheel.file_roots
.sp
Read in files from the file_root and save files to the file root
.INDENT 0.0
.TP
.B salt.wheel.file_roots.find(path, saltenv=\(aqbase\(aq)
Return a dict of the files located with the given path and environment
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.file_roots.list_env(saltenv=\(aqbase\(aq)
Return all of the file paths found in an environment
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.file_roots.list_roots()
Return all of the files names in all available environments
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.file_roots.read(path, saltenv=\(aqbase\(aq)
Read the contents of a text file, if the file is binary then ignore it
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.file_roots.write(data, path, saltenv=\(aqbase\(aq, index=0)
Write the named file, by default the first file found is written, but the
index of the file can be specified to write to a lower priority file root
.UNINDENT
.SS salt.wheel.key
.sp
Wheel system wrapper for the Salt key system to be used in interactions with
the Salt Master programmatically.
.sp
The key module for the wheel system is meant to provide an internal interface
for other Salt systems to interact with the Salt Master. The following usage
examples assume that a WheelClient is available:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.config
import salt.wheel
opts = salt.config.master_config(\(aq/etc/salt/master\(aq)
wheel = salt.wheel.WheelClient(opts)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that importing and using the \fBWheelClient\fP must be performed on the same
machine as the Salt Master and as the same user that runs the Salt Master,
unless \fI\%external_auth\fP is configured and the user is authorized
to execute wheel functions.
.sp
The function documentation starts with the \fBwheel\fP reference from the code
sample above and use the \fBWheelClient\fP functions to show how they can
be called from a Python interpreter.
.sp
The wheel key functions can also be called via a \fBsalt\fP command at the CLI
using the \fI\%saltutil execution module\fP\&.
.INDENT 0.0
.TP
.B salt.wheel.key.accept(match, include_rejected=False, include_denied=False)
Accept keys based on a glob match. Returns a dictionary.
.INDENT 7.0
.TP
.B match
The glob match of keys to accept.
.TP
.B include_rejected
To include rejected keys in the match along with pending keys, set this
to \fBTrue\fP\&. Defaults to \fBFalse\fP\&.
.TP
.B include_denied
To include denied keys in the match along with pending keys, set this
to \fBTrue\fP\&. Defaults to \fBFalse\fP\&.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd(\(aqkey.accept\(aq, [\(aqminion1\(aq])
{\(aqminions\(aq: [\(aqminion1\(aq]}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.accept_dict(match, include_rejected=False, include_denied=False)
Accept keys based on a dict of keys. Returns a dictionary.
.INDENT 7.0
.TP
.B match
The dictionary of keys to accept.
.TP
.B include_rejected
To include rejected keys in the match along with pending keys, set this
to \fBTrue\fP\&. Defaults to \fBFalse\fP\&.
.sp
New in version 2016.3.4.

.TP
.B include_denied
To include denied keys in the match along with pending keys, set this
to \fBTrue\fP\&. Defaults to \fBFalse\fP\&.
.sp
New in version 2016.3.4.

.UNINDENT
.sp
Example to move a list of keys from the \fBminions_pre\fP (pending) directory
to the \fBminions\fP (accepted) directory:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd(\(aqkey.accept_dict\(aq,
{
    \(aqminions_pre\(aq: [
        \(aqjerry\(aq,
        \(aqstuart\(aq,
        \(aqbob\(aq,
    ],
})
{\(aqminions\(aq: [\(aqjerry\(aq, \(aqstuart\(aq, \(aqbob\(aq]}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.delete(match)
Delete keys based on a glob match. Returns a dictionary.
.INDENT 7.0
.TP
.B match
The glob match of keys to delete.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd_async({\(aqfun\(aq: \(aqkey.delete\(aq, \(aqmatch\(aq: \(aqminion1\(aq})
{\(aqjid\(aq: \(aq20160826201244808521\(aq, \(aqtag\(aq: \(aqsalt/wheel/20160826201244808521\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.delete_dict(match)
Delete keys based on a dict of keys. Returns a dictionary.
.INDENT 7.0
.TP
.B match
The dictionary of keys to delete.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd_async({\(aqfun\(aq: \(aqkey.delete_dict\(aq,
\(aqmatch\(aq: {
    \(aqminions\(aq: [
        \(aqjerry\(aq,
        \(aqstuart\(aq,
        \(aqbob\(aq,
    ],
}})
{\(aqjid\(aq: \(aq20160826201244808521\(aq, \(aqtag\(aq: \(aqsalt/wheel/20160826201244808521\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.finger(match, hash_type=None)
Return the matching key fingerprints. Returns a dictionary.
.INDENT 7.0
.TP
.B match
The key for with to retrieve the fingerprint.
.TP
.B hash_type
The hash algorithm used to calculate the fingerprint
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd(\(aqkey.finger\(aq, [\(aqminion1\(aq])
{\(aqminions\(aq: {\(aqminion1\(aq: \(aq5d:f6:79:43:5e:d4:42:3f:57:b8:45:a8:7e:a4:6e:ca\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.finger_master(hash_type=None)
Return the fingerprint of the master\(aqs public key
.INDENT 7.0
.TP
.B hash_type
The hash algorithm used to calculate the fingerprint
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd(\(aqkey.finger_master\(aq)
{\(aqlocal\(aq: {\(aqmaster.pub\(aq: \(aq5d:f6:79:43:5e:d4:42:3f:57:b8:45:a8:7e:a4:6e:ca\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.gen(id_=None, keysize=2048)
Generate a key pair. No keys are stored on the master. A key pair is
returned as a dict containing pub and priv keys. Returns a dictionary
containing the \fBpub\fP and \fBpriv\fP keys with their generated values.
.INDENT 7.0
.TP
.B id_
Set a name to generate a key pair for use with salt. If not specified,
a random name will be specified.
.TP
.B keysize
The size of the key pair to generate. The size must be \fB2048\fP, which
is the default, or greater. If set to a value less than \fB2048\fP, the
key size will be rounded up to \fB2048\fP\&.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd(\(aqkey.gen\(aq)
{\(aqpub\(aq: \(aq\-\-\-\-\-BEGIN PUBLIC KEY\-\-\-\-\-\enMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBC
\&...
BBPfamX9gGPQTpN9e8HwcZjXQnmg8OrcUl10WHw09SDWLOlnW+ueTWugEQpPt\eniQIDAQAB\en
\-\-\-\-\-END PUBLIC KEY\-\-\-\-\-\(aq,
\(aqpriv\(aq: \(aq\-\-\-\-\-BEGIN RSA PRIVATE KEY\-\-\-\-\-\enMIIEpAIBAAKCAQEA42Kf+w9XeZWgguzv
\&...
QH3/W74X1+WTBlx4R2KGLYBiH+bCCFEQ/Zvcu4Xp4bIOPtRKozEQ==\en
\-\-\-\-\-END RSA PRIVATE KEY\-\-\-\-\-\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.gen_accept(id_, keysize=2048, force=False)
Generate a key pair then accept the public key. This function returns the
key pair in a dict, only the public key is preserved on the master. Returns
a dictionary.
.INDENT 7.0
.TP
.B id_
The name of the minion for which to generate a key pair.
.TP
.B keysize
The size of the key pair to generate. The size must be \fB2048\fP, which
is the default, or greater. If set to a value less than \fB2048\fP, the
key size will be rounded up to \fB2048\fP\&.
.TP
.B force
If a public key has already been accepted for the given minion on the
master, then the gen_accept function will return an empty dictionary
and not create a new key. This is the default behavior. If \fBforce\fP
is set to \fBTrue\fP, then the minion\(aqs previously accepted key will be
overwritten.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd(\(aqkey.gen_accept\(aq, [\(aqfoo\(aq])
{\(aqpub\(aq: \(aq\-\-\-\-\-BEGIN PUBLIC KEY\-\-\-\-\-\enMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBC
\&...
BBPfamX9gGPQTpN9e8HwcZjXQnmg8OrcUl10WHw09SDWLOlnW+ueTWugEQpPt\eniQIDAQAB\en
\-\-\-\-\-END PUBLIC KEY\-\-\-\-\-\(aq,
\(aqpriv\(aq: \(aq\-\-\-\-\-BEGIN RSA PRIVATE KEY\-\-\-\-\-\enMIIEpAIBAAKCAQEA42Kf+w9XeZWgguzv
\&...
QH3/W74X1+WTBlx4R2KGLYBiH+bCCFEQ/Zvcu4Xp4bIOPtRKozEQ==\en
\-\-\-\-\-END RSA PRIVATE KEY\-\-\-\-\-\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
We can now see that the \fBfoo\fP minion\(aqs key has been accepted by the master:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd(\(aqkey.list\(aq, [\(aqaccepted\(aq])
{\(aqminions\(aq: [\(aqfoo\(aq, \(aqminion1\(aq, \(aqminion2\(aq, \(aqminion3\(aq]}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.gen_keys(keydir=None, keyname=None, keysize=None, user=None)
Generate minion RSA public keypair
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.gen_signature(priv, pub, signature_path, auto_create=False, keysize=None)
Generate master public\-key\-signature
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.key_str(match)
Return information about the key. Returns a dictionary.
.INDENT 7.0
.TP
.B match
The key to return information about.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd(\(aqkey.print\(aq, [\(aqminion1\(aq])
{\(aqminions\(aq: {\(aqminion1\(aq: \(aq\-\-\-\-\-BEGIN PUBLIC KEY\-\-\-\-\-\enMIIBIjANBgkqhkiG9w0B
\&...
TWugEQpPt\eniQIDAQAB\en\-\-\-\-\-END PUBLIC KEY\-\-\-\-\-\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.list_(match)
List all the keys under a named status. Returns a dictionary.
.INDENT 7.0
.TP
.B match
The type of keys to list. The \fBpre\fP, \fBun\fP, and \fBunaccepted\fP
options will list unaccepted/unsigned keys. \fBacc\fP or \fBaccepted\fP will
list accepted/signed keys. \fBrej\fP or \fBrejected\fP will list rejected keys.
Finally, \fBall\fP will list all keys.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd(\(aqkey.list\(aq, [\(aqaccepted\(aq])
{\(aqminions\(aq: [\(aqminion1\(aq, \(aqminion2\(aq, \(aqminion3\(aq]}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.list_all()
List all the keys. Returns a dictionary containing lists of the minions in
each salt\-key category, including \fBminions\fP, \fBminions_rejected\fP,
\fBminions_denied\fP, etc. Returns a dictionary.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd(\(aqkey.list_all\(aq)
{\(aqlocal\(aq: [\(aqmaster.pem\(aq, \(aqmaster.pub\(aq], \(aqminions_rejected\(aq: [],
\(aqminions_denied\(aq: [], \(aqminions_pre\(aq: [],
\(aqminions\(aq: [\(aqminion1\(aq, \(aqminion2\(aq, \(aqminion3\(aq]}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.master_key_str()
Returns master\(aqs public key. Returns a dictionary
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd(\(aqkey.master_key_str\(aq)
{\(aqlocal\(aq: {\(aqmaster.pub\(aq: \(aq\-\-\-\-\-BEGIN PUBLIC KEY\-\-\-\-\-\enMIIBIjANBgkqhkiG9w0B
\&...
TWugEQpPt\eniQIDAQAB\en\-\-\-\-\-END PUBLIC KEY\-\-\-\-\-\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.name_match(match)
List all the keys based on a glob match
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.reject(match, include_accepted=False, include_denied=False)
Reject keys based on a glob match. Returns a dictionary.
.INDENT 7.0
.TP
.B match
The glob match of keys to reject.
.TP
.B include_accepted
To include accepted keys in the match along with pending keys, set this
to \fBTrue\fP\&. Defaults to \fBFalse\fP\&.
.TP
.B include_denied
To include denied keys in the match along with pending keys, set this
to \fBTrue\fP\&. Defaults to \fBFalse\fP\&.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd_async({\(aqfun\(aq: \(aqkey.reject\(aq, \(aqmatch\(aq: \(aqminion1\(aq})
{\(aqjid\(aq: \(aq20160826201244808521\(aq, \(aqtag\(aq: \(aqsalt/wheel/20160826201244808521\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.key.reject_dict(match, include_accepted=False, include_denied=False)
Reject keys based on a dict of keys. Returns a dictionary.
.INDENT 7.0
.TP
.B match
The dictionary of keys to reject.
.TP
.B include_accepted
To include accepted keys in the match along with pending keys, set this
to \fBTrue\fP\&. Defaults to \fBFalse\fP\&.
.sp
New in version 2016.3.4.

.TP
.B include_denied
To include denied keys in the match along with pending keys, set this
to \fBTrue\fP\&. Defaults to \fBFalse\fP\&.
.sp
New in version 2016.3.4.

.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd_async({\(aqfun\(aq: \(aqkey.reject_dict\(aq,
\(aqmatch\(aq: {
    \(aqminions\(aq: [
        \(aqjerry\(aq,
        \(aqstuart\(aq,
        \(aqbob\(aq,
    ],
}})
{\(aqjid\(aq: \(aq20160826201244808521\(aq, \(aqtag\(aq: \(aqsalt/wheel/20160826201244808521\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.wheel.minions
.sp
Wheel system wrapper for connected minions
.INDENT 0.0
.TP
.B salt.wheel.minions.connected()
List all connected minions on a salt\-master
.UNINDENT
.SS salt.wheel.pillar_roots
.sp
The \fIpillar_roots\fP wheel module is used to manage files under the pillar roots
directories on the master server.
.INDENT 0.0
.TP
.B salt.wheel.pillar_roots.find(path, saltenv=\(aqbase\(aq)
Return a dict of the files located with the given path and environment
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.pillar_roots.list_env(saltenv=\(aqbase\(aq)
Return all of the file paths found in an environment
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.pillar_roots.list_roots()
Return all of the files names in all available environments
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.pillar_roots.read(path, saltenv=\(aqbase\(aq)
Read the contents of a text file, if the file is binary then
.UNINDENT
.INDENT 0.0
.TP
.B salt.wheel.pillar_roots.write(data, path, saltenv=\(aqbase\(aq, index=0)
Write the named file, by default the first file found is written, but the
index of the file can be specified to write to a lower priority file root
.UNINDENT
.SH APIS
.SS Python client API
.sp
Salt provides several entry points for interfacing with Python applications.
These entry points are often referred to as \fB*Client()\fP APIs. Each client
accesses different parts of Salt, either from the master or from a minion. Each
client is detailed below.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For Tiamat\-bundled Salt distribution, you need to use the bundled Python runtime
as the system Python won\(aqt be able to access Salt internals.
.sp
To execute scripts via bundled Python runtime, either run the script with
\fB/path/to/salt python script.py\fP or use \fB#!/path/to/salt python\fP \fI\%shebang\fP
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
There are many ways to access Salt programmatically.
.sp
Salt can be used from CLI scripts as well as via a REST interface.
.sp
See Salt\(aqs \fI\%outputter system\fP to retrieve structured
data from Salt as JSON, or as shell\-friendly text, or many other formats.
.sp
See the \fI\%state.event\fP runner to utilize
Salt\(aqs event bus from shell scripts.
.sp
Salt\(aqs \fI\%netapi module\fP provides access to Salt externally via a REST interface.
Review the \fI\%netapi module\fP documentation for more information.
.UNINDENT
.UNINDENT
.SS Salt\(aqs \fBopts\fP dictionary
.sp
Some clients require access to Salt\(aqs \fBopts\fP dictionary. (The dictionary
representation of the \fI\%master\fP or
\fI\%minion\fP config files.)
.sp
A common pattern for fetching the \fBopts\fP dictionary is to defer to
environment variables if they exist or otherwise fetch the config from the
default location.
.INDENT 0.0
.TP
.B salt.config.client_config(path, env_var=\(aqSALT_CLIENT_CONFIG\(aq, defaults=None)
Load Master configuration data
.sp
Usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.config
master_opts = salt.config.client_config(\(aq/etc/salt/master\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns a dictionary of the Salt Master configuration file with necessary
options needed to communicate with a locally\-running Salt Master daemon.
This function searches for client specific configurations and adds them to
the data from the master configuration.
.sp
This is useful for master\-side operations like
\fI\%LocalClient\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B salt.config.minion_config(path, env_var=\(aqSALT_MINION_CONFIG\(aq, defaults=None, cache_minion_id=False, ignore_config_errors=True, minion_id=None, role=\(aqminion\(aq)
Reads in the minion configuration file and sets up special options
.sp
This is useful for Minion\-side operations, such as the
\fI\%Caller\fP class, and manually running the loader
interface.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.config
minion_opts = salt.config.minion_config(\(aq/etc/salt/minion\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Salt\(aqs Loader Interface
.sp
Modules in the Salt ecosystem are loaded into memory using a custom loader
system. This allows modules to have conditional requirements (OS, OS version,
installed libraries, etc) and allows Salt to inject special variables
(\fB__salt__\fP, \fB__opts__\fP, etc).
.sp
Most modules can be manually loaded. This is often useful in third\-party Python
apps or when writing tests. However some modules require and expect a full,
running Salt system underneath. Notably modules that facilitate
master\-to\-minion communication such as the \fI\%mine\fP,
\fI\%publish\fP, and \fBpeer\fP execution
modules. The error \fBKeyError: \(aqmaster_uri\(aq\fP is a likely indicator for this
situation. In those instances use the \fI\%Caller\fP class
to execute those modules instead.
.sp
Each module type has a corresponding loader function.
.INDENT 0.0
.TP
.B salt.loader.minion_mods(opts, context=None, utils=None, whitelist=None, initial_load=False, loaded_base_name=None, notify=False, static_modules=None, proxy=None, file_client=None)
Load execution modules
.sp
Returns a dictionary of execution modules appropriate for the current
system by evaluating the __virtual__() function in each module.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBopts\fP (\fI\%dict\fP) \-\- The Salt options dictionary
.IP \(bu 2
\fBcontext\fP (\fI\%dict\fP) \-\- A Salt context that should be made present inside
generated modules in __context__
.IP \(bu 2
\fButils\fP (\fI\%dict\fP) \-\- Utility functions which should be made available to
Salt modules in __utils__. See \fIutils_dirs\fP in
salt.config for additional information about
configuration.
.IP \(bu 2
\fBwhitelist\fP (\fI\%list\fP) \-\- A list of modules which should be whitelisted.
.IP \(bu 2
\fBinitial_load\fP (\fI\%bool\fP) \-\- Deprecated flag! Unused.
.IP \(bu 2
\fBloaded_base_name\fP (\fI\%str\fP) \-\- The imported modules namespace when imported
by the salt loader.
.IP \(bu 2
\fBnotify\fP (\fI\%bool\fP) \-\- Flag indicating that an event should be fired upon
completion of module loading.
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.config
import salt.loader

__opts__ = salt.config.minion_config(\(aq/etc/salt/minion\(aq)
__grains__ = salt.loader.grains(__opts__)
__opts__[\(aqgrains\(aq] = __grains__
__utils__ = salt.loader.utils(__opts__)
__salt__ = salt.loader.minion_mods(__opts__, utils=__utils__)
__salt__[\(aqtest.ping\(aq]()
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.loader.raw_mod(opts, name, functions, mod=\(aqmodules\(aq, loaded_base_name=None)
Returns a single module loaded raw and bypassing the __virtual__ function
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBopts\fP (\fI\%dict\fP) \-\- The Salt options dictionary
.IP \(bu 2
\fBname\fP (\fI\%str\fP) \-\- The name of the module to load
.IP \(bu 2
\fBfunctions\fP (\fILazyLoader\fP) \-\- A LazyLoader instance returned from \fBminion_mods\fP\&.
.IP \(bu 2
\fBmod\fP (\fI\%str\fP) \-\- The extension type.
.IP \(bu 2
\fBloaded_base_name\fP (\fI\%str\fP) \-\- The imported modules namespace when imported
by the salt loader.
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.config
import salt.loader

__opts__ = salt.config.minion_config(\(aq/etc/salt/minion\(aq)
testmod = salt.loader.raw_mod(__opts__, \(aqtest\(aq, None)
testmod[\(aqtest.ping\(aq]()
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.loader.states(opts, functions, utils, serializers, whitelist=None, proxy=None, context=None, loaded_base_name=None, file_client=None)
Returns the state modules
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBopts\fP (\fI\%dict\fP) \-\- The Salt options dictionary
.IP \(bu 2
\fBfunctions\fP (\fILazyLoader\fP) \-\- A LazyLoader instance returned from \fBminion_mods\fP\&.
.IP \(bu 2
\fBrunners\fP (\fILazyLoader\fP) \-\- A LazyLoader instance returned from \fBrunner\fP\&.
.IP \(bu 2
\fButils\fP (\fILazyLoader\fP) \-\- A LazyLoader instance returned from \fButils\fP\&.
.IP \(bu 2
\fBserializers\fP (\fILazyLoader\fP) \-\- An optional LazyLoader instance returned from \fBserializers\fP\&.
.IP \(bu 2
\fBproxy\fP (\fILazyLoader\fP) \-\- An optional LazyLoader instance returned from \fBproxy\fP\&.
.IP \(bu 2
\fBwhitelist\fP (\fI\%list\fP) \-\- A list of modules which should be whitelisted.
.IP \(bu 2
\fBcontext\fP (\fI\%dict\fP) \-\- A Salt context that should be made present inside
generated modules in __context__
.IP \(bu 2
\fBloaded_base_name\fP (\fI\%str\fP) \-\- The imported modules namespace when imported
by the salt loader.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.config
import salt.loader

__opts__ = salt.config.minion_config(\(aq/etc/salt/minion\(aq)
statemods = salt.loader.states(__opts__, None, None)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.loader.grains(opts, force_refresh=False, proxy=None, context=None, loaded_base_name=None)
Return the functions for the dynamic grains and the values for the static
grains.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBopts\fP (\fI\%dict\fP) \-\- The Salt options dictionary
.IP \(bu 2
\fBforce_refresh\fP (\fI\%bool\fP) \-\- Force the refresh of grains
.IP \(bu 2
\fBcontext\fP (\fI\%dict\fP) \-\- A Salt context that should be made present inside
generated modules in __context__
.IP \(bu 2
\fBproxy\fP (\fILazyLoader\fP) \-\- An optional LazyLoader instance returned from \fBproxy\fP\&.
.IP \(bu 2
\fBloaded_base_name\fP (\fI\%str\fP) \-\- The imported modules namespace when imported
by the salt loader.
.UNINDENT
.UNINDENT
.sp
Since grains are computed early in the startup process, grains functions
do not have __salt__ or __proxy__ available.  At proxy\-minion startup,
this function is called with the proxymodule LazyLoader object so grains
functions can communicate with their controlled device.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.config
import salt.loader

__opts__ = salt.config.minion_config(\(aq/etc/salt/minion\(aq)
__grains__ = salt.loader.grains(__opts__)
print __grains__[\(aqid\(aq]
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.loader.grain_funcs(opts, proxy=None, context=None, loaded_base_name=None)
Returns the grain functions
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBopts\fP (\fI\%dict\fP) \-\- The Salt options dictionary
.IP \(bu 2
\fBcontext\fP (\fI\%dict\fP) \-\- A Salt context that should be made present inside
generated modules in __context__
.IP \(bu 2
\fBproxy\fP (\fILazyLoader\fP) \-\- An optional LazyLoader instance returned from \fBproxy\fP\&.
.IP \(bu 2
\fBloaded_base_name\fP (\fI\%str\fP) \-\- .INDENT 2.0
.TP
.B The imported modules namespace when imported
by the salt loader.
.UNINDENT
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.config
import salt.loader

__opts__ = salt.config.minion_config(\(aq/etc/salt/minion\(aq)
grainfuncs = salt.loader.grain_funcs(__opts__)
.ft P
.fi
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.UNINDENT
.SS Salt\(aqs Client Interfaces
.SS LocalClient
.INDENT 0.0
.TP
.B class  salt.client.LocalClient(c_path=\(aq/etc/salt/master\(aq, mopts=None, skip_perm_errors=False, io_loop=None, keep_loop=False, auto_reconnect=False, listen=False)
The interface used by the \fBsalt\fP CLI tool on the Salt Master
.sp
\fBLocalClient\fP is used to send a command to Salt minions to execute
\fI\%execution modules\fP and return the results to the
Salt Master.
.sp
Importing and using \fBLocalClient\fP must be done on the same machine as the
Salt Master and it must be done using the same user that the Salt Master is
running as. (Unless \fI\%external_auth\fP is configured and
authentication credentials are included in the execution).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The LocalClient uses a Tornado IOLoop, this can create issues when
using the LocalClient inside an existing IOLoop. If creating the
LocalClient in partnership with another IOLoop either create the
IOLoop before creating the LocalClient, or when creating the IOLoop
use ioloop.current() which will return the ioloop created by
LocalClient.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.client

local = salt.client.LocalClient()
local.cmd(\(aq*\(aq, \(aqtest.fib\(aq, [10])
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cmd(tgt, fun, arg=(), timeout=None, tgt_type=\(aqglob\(aq, ret=\(aq\(aq, jid=\(aq\(aq, full_return=False, kwarg=None, **kwargs)
Synchronously execute a command on targeted minions
.sp
The cmd method will execute and wait for the timeout period for all
minions to reply, then it will return all minion data at once.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> import salt.client
>>> local = salt.client.LocalClient()
>>> local.cmd(\(aq*\(aq, \(aqcmd.run\(aq, [\(aqwhoami\(aq])
{\(aqjerry\(aq: \(aqroot\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With extra keyword arguments for the command function to be run:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
local.cmd(\(aq*\(aq, \(aqtest.arg\(aq, [\(aqarg1\(aq, \(aqarg2\(aq], kwarg={\(aqfoo\(aq: \(aqbar\(aq})
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Compound commands can be used for multiple executions in a single
publish. Function names and function arguments are provided in separate
lists but the index values must correlate and an empty list must be
used if no arguments are required.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> local.cmd(\(aq*\(aq, [
        \(aqgrains.items\(aq,
        \(aqsys.doc\(aq,
        \(aqcmd.run\(aq,
    ],
    [
        [],
        [],
        [\(aquptime\(aq],
    ])
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtgt\fP (\fIstring\fP\fI or \fP\fI\%list\fP) \-\- Which minions to target for the execution. Default is shell
glob. Modified by the \fBtgt_type\fP option.
.IP \(bu 2
\fBfun\fP (\fIstring\fP\fI or \fP\fI\%list\fP\fI of \fP\fIstrings\fP) \-\-
.sp
The module and function to call on the specified minions of
the form \fBmodule.function\fP\&. For example \fBtest.ping\fP or
\fBgrains.items\fP\&.
.INDENT 2.0
.TP
.B Compound commands
Multiple functions may be called in a single publish by
passing a list of commands. This can dramatically lower
overhead and speed up the application communicating with Salt.
.sp
This requires that the \fBarg\fP param is a list of lists. The
\fBfun\fP list and the \fBarg\fP list must correlate by index
meaning a function that does not take arguments must still have
a corresponding empty list at the expected index.
.UNINDENT

.IP \(bu 2
\fBarg\fP (\fI\%list\fP\fI or \fP\fIlist\-of\-lists\fP) \-\- A list of arguments to pass to the remote function. If the
function takes no arguments \fBarg\fP may be omitted except when
executing a compound command.
.IP \(bu 2
\fBtimeout\fP \-\- Seconds to wait after the last minion returns but
before all minions return.
.IP \(bu 2
\fBtgt_type\fP \-\-
.sp
The type of \fBtgt\fP\&. Allowed values:
.INDENT 2.0
.IP \(bu 2
\fBglob\fP \- Bash glob completion \- Default
.IP \(bu 2
\fBpcre\fP \- Perl style regular expression
.IP \(bu 2
\fBlist\fP \- Python list of hosts
.IP \(bu 2
\fBgrain\fP \- Match based on a grain comparison
.IP \(bu 2
\fBgrain_pcre\fP \- Grain comparison with a regex
.IP \(bu 2
\fBpillar\fP \- Pillar data comparison
.IP \(bu 2
\fBpillar_pcre\fP \- Pillar data comparison with a regex
.IP \(bu 2
\fBnodegroup\fP \- Match on nodegroup
.IP \(bu 2
\fBrange\fP \- Use a Range server for matching
.IP \(bu 2
\fBcompound\fP \- Pass a compound match string
.IP \(bu 2
\fBipcidr\fP \- Match based on Subnet (CIDR notation) or IPv4 address.
.UNINDENT
.sp
Changed in version 2017.7.0: Renamed from \fBexpr_form\fP to \fBtgt_type\fP


.IP \(bu 2
\fBret\fP \-\- The returner to use. The value passed can be single
returner, or a comma delimited list of returners to call in order
on the minions
.IP \(bu 2
\fBkwarg\fP \-\- A dictionary with keyword arguments for the function.
.IP \(bu 2
\fBfull_return\fP \-\- Output the job return only (default) or the full
return including exit code and other job metadata.
.IP \(bu 2
\fBkwargs\fP \-\-
.sp
Optional keyword arguments.
Authentication credentials may be passed when using
\fI\%external_auth\fP\&.
.sp
For example: \fBlocal.cmd(\(aq*\(aq, \(aqtest.ping\(aq, username=\(aqsaltdev\(aq,
password=\(aqsaltdev\(aq, eauth=\(aqpam\(aq)\fP\&.
Or: \fBlocal.cmd(\(aq*\(aq, \(aqtest.ping\(aq,
token=\(aq5871821ea51754fdcea8153c1c745433\(aq)\fP

.UNINDENT
.TP
.B Returns
A dictionary with the result of the execution, keyed by
minion ID. A compound command will return a sub\-dictionary keyed by
function name.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cmd_async(tgt, fun, arg=(), tgt_type=\(aqglob\(aq, ret=\(aq\(aq, jid=\(aq\(aq, kwarg=None, **kwargs)
Asynchronously send a command to connected minions
.sp
The function signature is the same as \fI\%cmd()\fP with the
following exceptions.
.INDENT 7.0
.TP
.B Returns
A job ID or 0 on failure.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> local.cmd_async(\(aq*\(aq, \(aqtest.sleep\(aq, [300])
\(aq20131219215921857715\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cmd_batch(tgt, fun, arg=(), tgt_type=\(aqglob\(aq, ret=\(aq\(aq, kwarg=None, batch=\(aq10%\(aq, **kwargs)
Iteratively execute a command on subsets of minions at a time
.sp
The function signature is the same as \fI\%cmd()\fP with the
following exceptions.
.INDENT 7.0
.TP
.B Parameters
\fBbatch\fP \-\- The batch identifier of systems to execute on
.TP
.B Returns
A generator of minion returns
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> returns = local.cmd_batch(\(aq*\(aq, \(aqstate.highstate\(aq, batch=\(aq10%\(aq)
>>> for ret in returns:
\&...     print(ret)
{\(aqjerry\(aq: {...}}
{\(aqdave\(aq: {...}}
{\(aqstewart\(aq: {...}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cmd_iter(tgt, fun, arg=(), timeout=None, tgt_type=\(aqglob\(aq, ret=\(aq\(aq, kwarg=None, **kwargs)
Yields the individual minion returns as they come in
.sp
The function signature is the same as \fI\%cmd()\fP with the
following exceptions.
.sp
Normally \fI\%cmd_iter()\fP does not yield results for minions that
are not connected. If you want it to return results for disconnected
minions set \fIexpect_minions=True\fP in \fIkwargs\fP\&.
.INDENT 7.0
.TP
.B Returns
A generator yielding the individual minion returns
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> ret = local.cmd_iter(\(aq*\(aq, \(aqtest.ping\(aq)
>>> for i in ret:
\&...     print(i)
{\(aqjerry\(aq: {\(aqret\(aq: True}}
{\(aqdave\(aq: {\(aqret\(aq: True}}
{\(aqstewart\(aq: {\(aqret\(aq: True}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cmd_iter_no_block(tgt, fun, arg=(), timeout=None, tgt_type=\(aqglob\(aq, ret=\(aq\(aq, kwarg=None, show_jid=False, verbose=False, **kwargs)
.INDENT 7.0
.TP
.B Yields the individual minion returns as they come in, or None
when no returns are available.
.UNINDENT
.sp
The function signature is the same as \fI\%cmd()\fP with the
following exceptions.
.INDENT 7.0
.TP
.B Returns
A generator yielding the individual minion returns, or None
when no returns are available. This allows for actions to be
injected in between minion returns.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> ret = local.cmd_iter_no_block(\(aq*\(aq, \(aqtest.ping\(aq)
>>> for i in ret:
\&...     print(i)
None
{\(aqjerry\(aq: {\(aqret\(aq: True}}
{\(aqdave\(aq: {\(aqret\(aq: True}}
None
{\(aqstewart\(aq: {\(aqret\(aq: True}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cmd_subset(tgt, fun, arg=(), tgt_type=\(aqglob\(aq, ret=\(aq\(aq, kwarg=None, subset=3, cli=False, progress=False, full_return=False, **kwargs)
Execute a command on a random subset of the targeted systems
.sp
The function signature is the same as \fI\%cmd()\fP with the
following exceptions.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsubset\fP \-\- The number of systems to execute on
.IP \(bu 2
\fBcli\fP \-\- When this is set to True, a generator is returned,
otherwise a dictionary of the minion returns is returned
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> SLC.cmd_subset(\(aq*\(aq, \(aqtest.ping\(aq, subset=1)
{\(aqjerry\(aq: True}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B get_cli_returns(jid, minions, timeout=None, tgt=\(aq*\(aq, tgt_type=\(aqglob\(aq, verbose=False, show_jid=False, **kwargs)
Starts a watcher looking at the return data for a specified JID
.INDENT 7.0
.TP
.B Returns
all of the information for the JID
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B get_event_iter_returns(jid, minions, timeout=None)
Gather the return data from the event system, break hard when timeout
is reached.
.UNINDENT
.INDENT 7.0
.TP
.B run_job(tgt, fun, arg=(), tgt_type=\(aqglob\(aq, ret=\(aq\(aq, timeout=None, jid=\(aq\(aq, kwarg=None, listen=False, **kwargs)
Asynchronously send a command to connected minions
.sp
Prep the job directory and publish a command to any targeted minions.
.INDENT 7.0
.TP
.B Returns
A dictionary of (validated) \fBpub_data\fP or an empty
dictionary on failure. The \fBpub_data\fP contains the job ID and a
list of all minions that are expected to return data.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> local.run_job(\(aq*\(aq, \(aqtest.sleep\(aq, [300])
{\(aqjid\(aq: \(aq20131219215650131543\(aq, \(aqminions\(aq: [\(aqjerry\(aq]}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Salt Caller
.INDENT 0.0
.TP
.B class  salt.client.Caller(c_path=\(aq/etc/salt/minion\(aq, mopts=None)
\fBCaller\fP is the same interface used by the \fBsalt\-call\fP
command\-line tool on the Salt Minion.
.sp
Changed in version 2015.8.0: Added the \fBcmd\fP method for consistency with the other Salt clients.
The existing \fBfunction\fP and \fBsminion.functions\fP interfaces still
exist but have been removed from the docs.

.sp
Importing and using \fBCaller\fP must be done on the same machine as a
Salt Minion and it must be done using the same user that the Salt Minion is
running as.
.sp
Usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.client
caller = salt.client.Caller()
caller.cmd(\(aqtest.ping\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note, a running master or minion daemon is not required to use this class.
Running \fBsalt\-call \-\-local\fP simply sets \fI\%file_client\fP to
\fB\(aqlocal\(aq\fP\&. The same can be achieved at the Python level by including that
setting in a minion config file.
.sp
New in version 2014.7.0: Pass the minion config as the \fBmopts\fP dictionary.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.client
import salt.config
__opts__ = salt.config.minion_config(\(aq/etc/salt/minion\(aq)
__opts__[\(aqfile_client\(aq] = \(aqlocal\(aq
caller = salt.client.Caller(mopts=__opts__)
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cmd(fun, *args, **kwargs)
Call an execution module with the given arguments and keyword arguments
.sp
Changed in version 2015.8.0: Added the \fBcmd\fP method for consistency with the other Salt clients.
The existing \fBfunction\fP and \fBsminion.functions\fP interfaces still
exist but have been removed from the docs.

.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
caller.cmd(\(aqtest.arg\(aq, \(aqFoo\(aq, \(aqBar\(aq, baz=\(aqBaz\(aq)

caller.cmd(\(aqevent.send\(aq, \(aqmyco/myevent/something\(aq,
    data={\(aqfoo\(aq: \(aqFoo\(aq}, with_env=[\(aqGIT_COMMIT\(aq], with_grains=True)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Salt Proxy Caller
.INDENT 0.0
.TP
.B class  salt.client.ProxyCaller(c_path=\(aq/etc/salt/proxy\(aq, mopts=None)
\fBProxyCaller\fP is the same interface used by the \fBsalt\-call\fP
with the args \fB\-\-proxyid <proxyid>\fP command\-line tool on the Salt Proxy
Minion.
.sp
Importing and using \fBProxyCaller\fP must be done on the same machine as a
Salt Minion and it must be done using the same user that the Salt Minion is
running as.
.sp
Usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.client
caller = salt.client.ProxyCaller()
caller.cmd(\(aqtest.ping\(aq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note, a running master or minion daemon is not required to use this class.
Running \fBsalt\-call \-\-local\fP simply sets \fI\%file_client\fP to
\fB\(aqlocal\(aq\fP\&. The same can be achieved at the Python level by including that
setting in a minion config file.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.client
import salt.config
__opts__ = salt.config.proxy_config(\(aq/etc/salt/proxy\(aq, minion_id=\(aqquirky_edison\(aq)
__opts__[\(aqfile_client\(aq] = \(aqlocal\(aq
caller = salt.client.ProxyCaller(mopts=__opts__)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
To use this for calling proxies, the \fBis_proxy functions\fP requires that \fB\-\-proxyid\fP be an
argument on the commandline for the script this is used in, or that the
string \fBproxy\fP is in the name of the script.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cmd(fun, *args, **kwargs)
Call an execution module with the given arguments and keyword arguments
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
caller.cmd(\(aqtest.arg\(aq, \(aqFoo\(aq, \(aqBar\(aq, baz=\(aqBaz\(aq)

caller.cmd(\(aqevent.send\(aq, \(aqmyco/myevent/something\(aq,
    data={\(aqfoo\(aq: \(aqFoo\(aq}, with_env=[\(aqGIT_COMMIT\(aq], with_grains=True)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS RunnerClient
.INDENT 0.0
.TP
.B class  salt.runner.RunnerClient(opts, context=None)
The interface used by the \fBsalt\-run\fP CLI tool on the Salt Master
.sp
It executes \fI\%runner modules\fP which run on the Salt
Master.
.sp
Importing and using \fBRunnerClient\fP must be done on the same machine as
the Salt Master and it must be done using the same user that the Salt
Master is running as.
.sp
Salt\(aqs \fI\%external_auth\fP can be used to authenticate calls. The
eauth user must be authorized to execute runner modules: (\fB@runner\fP).
Only the \fBmaster_call()\fP below supports eauth.
.INDENT 7.0
.TP
.B asynchronous(fun, low, user=\(aqUNKNOWN\(aq, pub=None, local=True)
Execute the function in a multiprocess and return the event tag to use
to watch for the return
.UNINDENT
.INDENT 7.0
.TP
.B cmd(fun, arg=None, pub_data=None, kwarg=None, print_event=True, full_return=False)
Execute a function
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> opts = salt.config.master_config(\(aq/etc/salt/master\(aq)
>>> runner = salt.runner.RunnerClient(opts)
>>> runner.cmd(\(aqjobs.list_jobs\(aq, [])
{
    \(aq20131219215650131543\(aq: {
        \(aqArguments\(aq: [300],
        \(aqFunction\(aq: \(aqtest.sleep\(aq,
        \(aqStartTime\(aq: \(aq2013, Dec 19 21:56:50.131543\(aq,
        \(aqTarget\(aq: \(aq*\(aq,
        \(aqTarget\-type\(aq: \(aqglob\(aq,
        \(aqUser\(aq: \(aqsaltdev\(aq
    },
    \(aq20131219215921857715\(aq: {
        \(aqArguments\(aq: [300],
        \(aqFunction\(aq: \(aqtest.sleep\(aq,
        \(aqStartTime\(aq: \(aq2013, Dec 19 21:59:21.857715\(aq,
        \(aqTarget\(aq: \(aq*\(aq,
        \(aqTarget\-type\(aq: \(aqglob\(aq,
        \(aqUser\(aq: \(aqsaltdev\(aq
    },
}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cmd_async(low)
Execute a runner function asynchronously; eauth is respected
.sp
This function requires that \fI\%external_auth\fP is configured
and the user is authorized to execute runner functions: (\fB@runner\fP).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
runner.cmd_async({
    \(aqfun\(aq: \(aqjobs.list_jobs\(aq,
    \(aqusername\(aq: \(aqsaltdev\(aq,
    \(aqpassword\(aq: \(aqsaltdev\(aq,
    \(aqeauth\(aq: \(aqpam\(aq,
})
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cmd_sync(low, timeout=None, full_return=False)
Execute a runner function synchronously; eauth is respected
.sp
This function requires that \fI\%external_auth\fP is configured
and the user is authorized to execute runner functions: (\fB@runner\fP).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
runner.cmd_sync({
    \(aqfun\(aq: \(aqjobs.list_jobs\(aq,
    \(aqusername\(aq: \(aqsaltdev\(aq,
    \(aqpassword\(aq: \(aqsaltdev\(aq,
    \(aqeauth\(aq: \(aqpam\(aq,
})
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS WheelClient
.INDENT 0.0
.TP
.B class  salt.wheel.WheelClient(opts, context=None)
An interface to Salt\(aqs wheel modules
.sp
\fI\%Wheel modules\fP interact with various parts of the
Salt Master.
.sp
Importing and using \fBWheelClient\fP must be done on the same machine as the
Salt Master and it must be done using the same user that the Salt Master is
running as. Unless \fI\%external_auth\fP is configured and the user
is authorized to execute wheel functions: (\fB@wheel\fP).
.sp
Usage:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.config
import salt.wheel
opts = salt.config.master_config(\(aq/etc/salt/master\(aq)
wheel = salt.wheel.WheelClient(opts)
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B asynchronous(fun, low, user=\(aqUNKNOWN\(aq, pub=None, local=True)
Execute the function in a multiprocess and return the event tag to use
to watch for the return
.UNINDENT
.INDENT 7.0
.TP
.B cmd(fun, arg=None, pub_data=None, kwarg=None, print_event=True, full_return=False)
Execute a function
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd(\(aqkey.finger\(aq, [\(aqjerry\(aq])
{\(aqminions\(aq: {\(aqjerry\(aq: \(aq5d:f6:79:43:5e:d4:42:3f:57:b8:45:a8:7e:a4:6e:ca\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cmd_async(low)
Execute a function asynchronously; eauth is respected
.sp
This function requires that \fI\%external_auth\fP is configured
and the user is authorized
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd_async({
    \(aqfun\(aq: \(aqkey.finger\(aq,
    \(aqmatch\(aq: \(aqjerry\(aq,
    \(aqeauth\(aq: \(aqauto\(aq,
    \(aqusername\(aq: \(aqsaltdev\(aq,
    \(aqpassword\(aq: \(aqsaltdev\(aq,
})
{\(aqjid\(aq: \(aq20131219224744416681\(aq, \(aqtag\(aq: \(aqsalt/wheel/20131219224744416681\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B cmd_sync(low, timeout=None, full_return=False)
Execute a wheel function synchronously; eauth is respected
.sp
This function requires that \fI\%external_auth\fP is configured
and the user is authorized to execute runner functions: (\fB@wheel\fP).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> wheel.cmd_sync({
\(aqfun\(aq: \(aqkey.finger\(aq,
\(aqmatch\(aq: \(aqjerry\(aq,
\(aqeauth\(aq: \(aqauto\(aq,
\(aqusername\(aq: \(aqsaltdev\(aq,
\(aqpassword\(aq: \(aqsaltdev\(aq,
})
{\(aqminions\(aq: {\(aqjerry\(aq: \(aq5d:f6:79:43:5e:d4:42:3f:57:b8:45:a8:7e:a4:6e:ca\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS CloudClient
.INDENT 0.0
.TP
.B class  salt.cloud.CloudClient(path=None, opts=None, config_dir=None, pillars=None)
The client class to wrap cloud interactions
.INDENT 7.0
.TP
.B action(fun=None, cloudmap=None, names=None, provider=None, instance=None, kwargs=None)
Execute a single action via the cloud plugin backend
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
client.action(fun=\(aqshow_instance\(aq, names=[\(aqmyinstance\(aq])
client.action(fun=\(aqshow_image\(aq, provider=\(aqmy\-ec2\-config\(aq,
    kwargs={\(aqimage\(aq: \(aqami\-10314d79\(aq}
)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B create(provider, names, **kwargs)
Create the named VMs, without using a profile
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
client.create(provider=\(aqmy\-ec2\-config\(aq, names=[\(aqmyinstance\(aq],
    image=\(aqami\-1624987f\(aq, size=\(aqt1.micro\(aq, ssh_username=\(aqec2\-user\(aq,
    securitygroup=\(aqdefault\(aq, delvol_on_destroy=True)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B destroy(names)
Destroy the named VMs
.UNINDENT
.INDENT 7.0
.TP
.B extra_action(names, provider, action, **kwargs)
Perform actions with block storage devices
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
client.extra_action(names=[\(aqmyblock\(aq], action=\(aqvolume_create\(aq,
    provider=\(aqmy\-nova\(aq, kwargs={\(aqvoltype\(aq: \(aqSSD\(aq, \(aqsize\(aq: 1000}
)
client.extra_action(names=[\(aqsalt\-net\(aq], action=\(aqnetwork_create\(aq,
    provider=\(aqmy\-nova\(aq, kwargs={\(aqcidr\(aq: \(aq192.168.100.0/24\(aq}
)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B full_query(query_type=\(aqlist_nodes_full\(aq)
Query all instance information
.UNINDENT
.INDENT 7.0
.TP
.B list_images(provider=None)
List all available images in configured cloud systems
.UNINDENT
.INDENT 7.0
.TP
.B list_locations(provider=None)
List all available locations in configured cloud systems
.UNINDENT
.INDENT 7.0
.TP
.B list_sizes(provider=None)
List all available sizes in configured cloud systems
.UNINDENT
.INDENT 7.0
.TP
.B low(fun, low)
Pass the cloud function and low data structure to run
.UNINDENT
.INDENT 7.0
.TP
.B map_run(path=None, **kwargs)
To execute a map
.UNINDENT
.INDENT 7.0
.TP
.B min_query(query_type=\(aqlist_nodes_min\(aq)
Query select instance information
.UNINDENT
.INDENT 7.0
.TP
.B profile(profile, names, vm_overrides=None, **kwargs)
Pass in a profile to create, names is a list of vm names to allocate
.INDENT 7.0
.INDENT 3.5
vm_overrides is a special dict that will be per node options
overrides
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
>>> client= salt.cloud.CloudClient(path=\(aq/etc/salt/cloud\(aq)
>>> client.profile(\(aqdo_512_git\(aq, names=[\(aqminion01\(aq,])
{\(aqminion01\(aq: {\(aqbackups_active\(aq: \(aqFalse\(aq,
        \(aqcreated_at\(aq: \(aq2014\-09\-04T18:10:15Z\(aq,
        \(aqdroplet\(aq: {\(aqevent_id\(aq: 31000502,
                     \(aqid\(aq: 2530006,
                     \(aqimage_id\(aq: 5140006,
                     \(aqname\(aq: \(aqminion01\(aq,
                     \(aqsize_id\(aq: 66},
        \(aqid\(aq: \(aq2530006\(aq,
        \(aqimage_id\(aq: \(aq5140006\(aq,
        \(aqip_address\(aq: \(aq107.XXX.XXX.XXX\(aq,
        \(aqlocked\(aq: \(aqTrue\(aq,
        \(aqname\(aq: \(aqminion01\(aq,
        \(aqprivate_ip_address\(aq: None,
        \(aqregion_id\(aq: \(aq4\(aq,
        \(aqsize_id\(aq: \(aq66\(aq,
        \(aqstatus\(aq: \(aqnew\(aq}}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B query(query_type=\(aqlist_nodes\(aq)
Query basic instance information
.UNINDENT
.INDENT 7.0
.TP
.B select_query(query_type=\(aqlist_nodes_select\(aq)
Query select instance information
.UNINDENT
.UNINDENT
.SS SSHClient
.INDENT 0.0
.TP
.B class  salt.client.ssh.client.SSHClient(c_path=\(aq/etc/salt/master\(aq, mopts=None, disable_custom_roster=False)
Create a client object for executing routines via the salt\-ssh backend
.sp
New in version 2015.5.0.

.INDENT 7.0
.TP
.B cmd(tgt, fun, arg=(), timeout=None, tgt_type=\(aqglob\(aq, kwarg=None, **kwargs)
Execute a single command via the salt\-ssh subsystem and return all
routines at once
.sp
New in version 2015.5.0.

.UNINDENT
.INDENT 7.0
.TP
.B cmd_iter(tgt, fun, arg=(), timeout=None, tgt_type=\(aqglob\(aq, ret=\(aq\(aq, kwarg=None, **kwargs)
Execute a single command via the salt\-ssh subsystem and return a
generator
.sp
New in version 2015.5.0.

.UNINDENT
.UNINDENT
.SS \fBnetapi\fP modules
.sp
netapi modules provide API access to Salt functionality over the network.
.sp
The included \fI\%netapi modules\fP support REST (over
HTTP and WSGI) and WebSockets.
.sp
Modules expose functions from the \fI\%NetapiClient\fP
and give access to the same functionality as the Salt commandline tools
(\fBsalt\fP, \fBsalt\-run\fP, etc).
.SS Client interfaces
.sp
Salt\(aqs client interfaces provide the ability to execute functions from
execution, runnner, and wheel modules.
.sp
The client interfaces available via netapi modules are defined in the
\fI\%NetapiClient\fP, which is a
limited version of the \fI\%Python API\fP\&.
.sp
The client interfaces accept a dictionary with values for the function
and its arguments.
.sp
Available interfaces:
.INDENT 0.0
.IP \(bu 2
local \- run execution modules on minions
.IP \(bu 2
local_subset \- run execution modules on a subset of minions
.IP \(bu 2
runner \- run runner modules on master
.IP \(bu 2
ssh \- run salt\-ssh commands
.IP \(bu 2
wheel \- run wheel modules
.UNINDENT
.sp
The local, runner, and wheel clients also have async variants to run
modules asynchronously.
.SS Configuration
.sp
The \fBnetapi_enable_clients\fP list in the master config sets which
client interfaces are available. It is recommended to only enable the client
interfaces required to complete the tasks needed to reduce the amount of Salt
functionality exposed via the netapi. See the
\fI\%netapi_enable clients\fP documentation.
.SS Enabling netapi client interfaces
.sp
From Salt\(aqs 3006.0 release onwards, all netapi client interfaces are disabled by default.
.sp
To enable netapi/\fBsalt\-api\fP functionality, users should follow the process in this
documentation. If the \fBnetapi_enable_clients\fP configuration is not added to the
Salt master configuration, then the netapi/\fBsalt\-api\fP will not function.
.INDENT 0.0
.INDENT 3.5
.IP "Breaking change in Salt 3006.0 and above"
.sp
Users of netapi/\fBsalt\-api\fP upgrading to Salt 3006.0 \fBmust\fP follow the process in
this documentation to enable the required netapi client interfaces. If the
\fBnetapi_enable_clients\fP configuration is not added to the Salt master
configuration netapi/\fBsalt\-api\fP will not function
.UNINDENT
.UNINDENT
.SS Steps to enable netapi client interfaces
.INDENT 0.0
.IP 1. 3
\fI\%Select client interfaces to enable\fP
.IP 2. 3
\fI\%Update Salt master config\fP
.IP 3. 3
\fI\%Restart salt\-master and salt\-api\fP
.IP 4. 3
\fI\%Verify required functionality\fP
.UNINDENT
.SS Select client interfaces to enable
.sp
Salt\(aqs client interfaces provide the ability to execute functions from execution, runner,
wheel modules, and via the salt\-ssh system.
.sp
It is recommended to only enable the client interfaces required to complete the tasks needed
to reduce the amount of Salt functionality exposed via the netapi. For example, if the
salt\-ssh system is not in use, not enabling the ssh client interface will help protect
the Salt master from attacks which look to exploit salt\-ssh.
.sp
The main client interfaces are:
.INDENT 0.0
.IP \(bu 2
local \- run execution modules on minions
.IP \(bu 2
local_subset \- run execution modules on a subset of minions
.IP \(bu 2
runner \- run runner modules on master
.IP \(bu 2
ssh \- run salt\-ssh commands
.IP \(bu 2
wheel \- run wheel modules
.UNINDENT
.sp
The local, runner, and wheel clients also have async variants to run modules asynchronously.
See \fBnetapi_enable_clients\fP for the complete list.
.sp
Most scenarios will require enabling the local client (and potentially its local_subset and
local_async variants). The local client is equivalent to the \fBsalt\fP command line
tool and is required to run execution modules against minions.
.sp
Many deployments may also require the ability to call runner functions on the master (for
example, where orchestrations are used), but the runner client should only be enabled if
this is the case.
.sp
As there is not a standard netapi client application, existing users will need to assess
which client interfaces are in use. Where an application or tool is making a request to
a netapi module, it will usually pass an option indicating which client to use and it
should be possible to inspect the source of any tools to understand which client interfaces
should be enabled.
.sp
For common command line clients, such as \fI\%pepper\fP
they will normally default to using the local client interface unless passed an
option to specify a different client interface.
.SS Update Salt master config
.sp
Once it has been established which client interfaces will be required or are currently
in use, those should be listed in the Salt master config, under the
\fBnetapi_enable_clients\fP key.
.sp
Example configuration to enable only the local client interfaces:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B netapi_enable_clients:
.INDENT 7.0
.IP \(bu 2
local
.IP \(bu 2
local_async
.IP \(bu 2
local_batch
.IP \(bu 2
local_subset
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Example configuration to enable local client functionality and runners:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B netapi_enable_clients:
.INDENT 7.0
.IP \(bu 2
local
.IP \(bu 2
local_async
.IP \(bu 2
local_batch
.IP \(bu 2
local_subset
.IP \(bu 2
runner
.IP \(bu 2
runner_async
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
See \fBnetapi_enable_clients\fP for the full list of available client interfaces.
.SS Restart salt\-master and salt\-api
.sp
Changes to the Salt master configuration require a restart of the \fBsalt\-master\fP
service. The \fBsalt\-api\fP service should also be restarted.
.SS Verify required functionality
.sp
Testing that the required functionality is available can be done using curl.
It is recommended to also check that client interfaces that are not
required are not enabled.
.INDENT 0.0
.INDENT 3.5
.IP "Examples"
.sp
Examples will have to be adjusted to set the correct username, password and
\fI\%external authentication\fP values for the user\(aqs system.
.UNINDENT
.UNINDENT
.sp
Checking that the local client is enabled:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sSKi https://localhost:8000/run \e
    \-H \(aqAccept: application/x\-yaml\(aq \e
    \-d client=\(aqlocal\(aq \e
    \-d tgt=\(aq*\(aq \e
    \-d fun=\(aqtest.ping\(aq \e
    \-d username=\(aqsaltdev\(aq \e
    \-d password=\(aqsaltdev\(aq \e
    \-d eauth=\(aqauto\(aq

HTTP/1.1 200 OK
Content\-Type: application/x\-yaml
Server: CherryPy/18.8.0
Date: Mon, 23 Jan 2023 14:54:58 GMT
Allow: GET, HEAD, POST
Access\-Control\-Allow\-Origin: *
Access\-Control\-Expose\-Headers: GET, POST
Access\-Control\-Allow\-Credentials: true
Vary: Accept\-Encoding
Content\-Length: 25

return:
  \- saltdev1: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Checking that the runner client is \fBnot\fP enabled:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sSKi https://localhost:8000/run \e
    \-H \(aqAccept: application/x\-yaml\(aq \e
    \-d client=\(aqrunner\(aq \e
    \-d fun=\(aqtest.arg\(aq \e
    \-d arg=\(aqtest arg\(aq \e
    \-d username=\(aqsaltdev\(aq \e
    \-d password=\(aqsaltdev\(aq \e
    \-d eauth=\(aqauto\(aq

HTTP/1.1 400 Bad Request
Content\-Type: text/html;charset=utf\-8
Server: CherryPy/18.8.0
Date: Mon, 23 Jan 2023 14:59:33 GMT
Allow: GET, HEAD, POST
Access\-Control\-Allow\-Origin: *
Access\-Control\-Expose\-Headers: GET, POST
Access\-Control\-Allow\-Credentials: true
Content\-Length: 750
Vary: Accept\-Encoding
\&...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Further examples are available in the
\fI\%neatpi modules\fP documentation.
.sp
Individual netapi modules can be enabled by adding the module configuration
section to the master config. The required configuration and dependencies are
documented for each \fI\%module\fP\&.
.sp
The \fBsalt\-api\fP daemon manages netapi modules instances and must be
started to enable the configured netapi modules. It is possible to run
multiple netapi modules and multiple instances of each module.
.INDENT 0.0
.INDENT 3.5
.IP "\fBnetapi_enable_clients\fP"
.sp
Prior to Salt\(aqs 3006.0 release all client interfaces were enabled and it
was not possible to disable clients individually.
.UNINDENT
.UNINDENT
.SS Developing modules
.sp
Developing custom netapi modules for new transports or protocols is documented in
the \fI\%Writing netapi modules\fP and \fI\%NetapiClient\fP
documentation.
.SS Writing netapi modules
.sp
\fBnetapi\fP modules, put simply, bind a port and start a service.
They are purposefully open\-ended and can be used to present a variety of
external interfaces to Salt, and even present multiple interfaces at once.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%The full list of netapi modules\fP
.UNINDENT
.UNINDENT
.SS Configuration
.sp
All \fBnetapi\fP configuration is done in the \fI\%Salt master
config\fP and takes a form similar to the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rest_cherrypy:
  port: 8000
  debug: True
  ssl_crt: /etc/pki/tls/certs/localhost.crt
  ssl_key: /etc/pki/tls/certs/localhost.key
.ft P
.fi
.UNINDENT
.UNINDENT
.SS The \fB__virtual__\fP function
.sp
Like all module types in Salt, \fBnetapi\fP modules go through
Salt\(aqs loader interface to determine if they should be loaded into memory and
then executed.
.sp
The \fB__virtual__\fP function in the module makes this determination and should
return \fBFalse\fP or a string that will serve as the name of the module. If the
module raises an \fBImportError\fP or any other errors, it will not be loaded.
.SS The \fBstart\fP function
.sp
The \fBstart()\fP function will be called for each \fBnetapi\fP
module that is loaded. This function should contain the server loop that
actually starts the service. This is started in a multiprocess.
.SS Multiple instances
.sp
New in version 2016.11.0.

.sp
\fI\%rest_cherrypy\fP and \fI\%rest_tornado\fP
support running multiple instances by copying and renaming entire directory
of those. To start the copied multiple \fBnetapi\fP modules, add
configuration blocks for the copied \fBnetapi\fP modules in the
Salt Master config. The name of each added configuration block must match
with the name of each directory of the copied \fBnetapi\fP module.
.SS Inline documentation
.sp
As with the rest of Salt, it is a best\-practice to include liberal inline
documentation in the form of a module docstring and docstrings on any classes,
methods, and functions in your \fBnetapi\fP module.
.SS Loader “magic” methods
.sp
The loader makes the \fB__opts__\fP data structure available to any function in
a \fBnetapi\fP module.
.SS NetapiClient
.sp
The \fBNetapiClient\fP class provides access to
\fI\%Python API client interfaces\fP when
\fI\%developing netapi modules\fP
.INDENT 0.0
.TP
.B class  salt.netapi.NetapiClient(opts)
Provide a uniform method of accessing the various client interfaces in Salt
in the form of low\-data data structures. For example:
.sp
.nf
.ft C
>>> client = NetapiClient(__opts__)
>>> lowstate = {\(aqclient\(aq: \(aqlocal\(aq, \(aqtgt\(aq: \(aq*\(aq, \(aqfun\(aq: \(aqtest.ping\(aq, \(aqarg\(aq: \(aq\(aq}
>>> client.run(lowstate)
.ft P
.fi
.INDENT 7.0
.TP
.B local(*args, **kwargs)
Run \fI\%execution modules\fP synchronously
.sp
See \fI\%salt.client.LocalClient.cmd()\fP for all available
parameters.
.sp
Sends a command from the master to the targeted minions. This is the
same interface that Salt\(aqs own CLI uses. Note the \fBarg\fP and \fBkwarg\fP
parameters are sent down to the minion(s) and the given function,
\fBfun\fP, is called with those parameters.
.INDENT 7.0
.TP
.B Returns
Returns the result from the execution module
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B local_async(*args, **kwargs)
Run \fI\%execution modules\fP asynchronously
.sp
Wraps \fI\%salt.client.LocalClient.run_job()\fP\&.
.INDENT 7.0
.TP
.B Returns
job ID
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B local_subset(*args, **kwargs)
Run \fI\%execution modules\fP against subsets of minions
.sp
New in version 2016.3.0.

.sp
Wraps \fI\%salt.client.LocalClient.cmd_subset()\fP
.UNINDENT
.INDENT 7.0
.TP
.B run(low)
Execute the specified function in the specified client by passing the
lowstate
.UNINDENT
.INDENT 7.0
.TP
.B runner(fun, timeout=None, full_return=False, **kwargs)
Run \fIrunner modules <all\-salt.runners>\fP synchronously
.sp
Wraps \fI\%salt.runner.RunnerClient.cmd_sync()\fP\&.
.sp
Note that runner functions must be called using keyword arguments.
Positional arguments are not supported.
.INDENT 7.0
.TP
.B Returns
Returns the result from the runner module
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B runner_async(fun, **kwargs)
Run \fIrunner modules <all\-salt.runners>\fP asynchronously
.sp
Wraps \fI\%salt.runner.RunnerClient.cmd_async()\fP\&.
.sp
Note that runner functions must be called using keyword arguments.
Positional arguments are not supported.
.INDENT 7.0
.TP
.B Returns
event data and a job ID for the executed function.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B ssh(*args, **kwargs)
Run salt\-ssh commands synchronously
.sp
Wraps \fBsalt.client.ssh.client.SSHClient.cmd_sync()\fP\&.
.INDENT 7.0
.TP
.B Returns
Returns the result from the salt\-ssh command
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B wheel(fun, **kwargs)
Run \fI\%wheel modules\fP synchronously
.sp
Wraps \fBsalt.wheel.WheelClient.master_call()\fP\&.
.sp
Note that wheel functions must be called using keyword arguments.
Positional arguments are not supported.
.INDENT 7.0
.TP
.B Returns
Returns the result from the wheel module
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B wheel_async(fun, **kwargs)
Run \fI\%wheel modules\fP asynchronously
.sp
Wraps \fBsalt.wheel.WheelClient.master_call()\fP\&.
.sp
Note that wheel functions must be called using keyword arguments.
Positional arguments are not supported.
.INDENT 7.0
.TP
.B Returns
Returns the result from the wheel module
.UNINDENT
.UNINDENT
.UNINDENT
.SH ARCHITECTURE
.sp
If you are used to configuration management tools that require you to plan
down to the last detail before you install anything, you are probably wondering
why this section doesn\(aqt appear before the installation instructions. With
Salt, you can switch to a high availability architecture at any time, and add
additional components to scale your deployment as you go.
.sp
Since a single Salt master can manage thousands of systems, we usually
recommend that you start by deploying a single Salt master, and then modifying
your deployment as needed for redundancy, geographical distribution, and scale.
.SS High Availability Features in Salt
.sp
Salt supports several features for high availability and fault tolerance.
Brief documentation for these features is listed alongside their configuration
parameters in \fI\%Configuration file examples\fP\&.
.SS Master Cluster
.sp
New in version 3007.

.sp
Salt masters can be configured to act as a cluster. All masters in a cluster
are peers. Job workloads are shared accross the cluster. Master clusters
provide a way to scale masters horizontally. They do not require changes to
the minions\(aq configuration to add more resources. Cluster implementations are
expected to use a load balancer, shared filesystem, and run on a reliable
network.
.sp
\fI\%Master Cluster Tutorial\fP
.SS Multimaster
.sp
Salt minions can connect to multiple masters at one time by configuring the
\fImaster\fP configuration parameter as a YAML list of all the available masters.  By
default, all masters are \(dqhot\(dq, meaning that any master can direct commands to
the Salt infrastructure.
.sp
In a multimaster configuration, each master must have the same cryptographic
keys, and minion keys must be accepted on all masters separately.  The contents
of file_roots and pillar_roots need to be kept in sync with processes external
to Salt as well
.sp
A tutorial on setting up multimaster with \(dqhot\(dq masters is here:
.sp
\fI\%Multimaster Tutorial\fP
.SS Multimaster with Failover
.sp
Changing the \fBmaster_type\fP parameter from \fBstr\fP to \fBfailover\fP will cause
minions to connect to the first responding master in the list of masters. Every
\fI\%master_alive_interval\fP seconds the minions will check to make
sure the current master is still responding.  If the master does not respond,
the minion will attempt to connect to the next master in the list.  If the
minion runs out of masters, the list will be recycled in case dead masters have
been restored.  Note that \fI\%master_alive_interval\fP must be present
in the minion configuration, or else the recurring job to check master status
will not get scheduled.
.sp
Failover can be combined with PKI\-style encrypted keys, but PKI is NOT
REQUIRED to use failover.
.sp
Multimaster with PKI and Failover is discussed in
\fI\%this tutorial\fP
.sp
\fBmaster_type: failover\fP can be combined with \fBrandom_master: True\fP
to spread minion connections across all masters (one master per
minion, not each minion connecting to all masters).  Adding Salt Syndics
into the mix makes it possible to create a load\-balanced Salt infrastructure.
If a master fails, minions will notice and select another master from the
available list.
.SS Syndic
.sp
Salt\(aqs Syndic feature is a way to create differing infrastructure
topologies.  It is not strictly an HA feature, but can be treated as such.
.sp
With the syndic, a Salt infrastructure can be partitioned in such a way that
certain masters control certain segments of the infrastructure, and \(dqMaster
of Masters\(dq nodes can control multiple segments underneath them.
.sp
Syndics are covered in depth in \fI\%Salt Syndic\fP\&.
.SS Syndic with Multimaster
.sp
New in version 2015.5.0.

.sp
Syndic with Multimaster lets you connect a syndic to multiple masters to provide
an additional layer of redundancy in a syndic configuration.
.sp
Syndics are covered in depth in \fI\%Salt Syndic\fP\&.
.SS Salt Syndic
.sp
The most basic or typical Salt topology consists of a single Master node
controlling a group of Minion nodes.  An intermediate node type, called Syndic,
when used offers greater structural flexibility and scalability in the
construction of Salt topologies than topologies constructed only out of Master
and Minion node types.
.sp
A Syndic node can be thought of as a special passthrough Minion node.  A Syndic
node consists of a \fBsalt\-syndic\fP daemon and a \fBsalt\-master\fP daemon running
on the same system.  The \fBsalt\-master\fP daemon running on the Syndic node
controls a group of lower level Minion nodes and the \fBsalt\-syndic\fP daemon
connects higher level Master node, sometimes called a Master of Masters.
.sp
The \fBsalt\-syndic\fP daemon relays publications and events between the Master
node and the local \fBsalt\-master\fP daemon.  This gives the Master node control
over the Minion nodes attached to the \fBsalt\-master\fP daemon running on the
Syndic node.
.SS Configuring the Syndic
.sp
To setup a Salt Syndic you need to tell the Syndic node and its Master node
about each other.  If your Master node is located at \fB10.10.0.1\fP, then your
configurations would be:
.sp
On the Syndic node:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/master
syndic_master: 10.10.0.1  # may be either an IP address or a hostname
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/minion

# id is shared by the salt\-syndic daemon and a possible salt\-minion daemon
# on the Syndic node
id: my_syndic
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
On the Master node:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# /etc/salt/master
order_masters: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fI\%syndic_master\fP option tells the Syndic node where to find the
Master node in the same way that the \fI\%master\fP option tells a
Minion node where to find a Master node.
.sp
The \fI\%id\fP option is used by the \fBsalt\-syndic\fP daemon to identify
with the Master node and if unset will default to the hostname or IP address of
the Syndic just as with a Minion.
.sp
The \fI\%order_masters\fP option configures the Master node to send
extra information with its publications that is needed by Syndic nodes
connected directly to it.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
The syndic process must be run as the same user as the syndic master.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Each Syndic must provide its own \fBfile_roots\fP directory. Files will not
be automatically transferred from the Master node.
.UNINDENT
.UNINDENT
.SS Configuring the Syndic with Multimaster
.sp
New in version 2015.5.0.

.sp
Syndic with Multimaster lets you connect a syndic to multiple masters to provide
an additional layer of redundancy in a syndic configuration.
.sp
Higher level masters should first be configured in a multimaster configuration.
See \fI\%Multimaster Tutorial\fP\&.
.sp
On the syndic, the \fI\%syndic_master\fP option is populated with
a list of the higher level masters.
.sp
Since each syndic is connected to each master, jobs sent from any master are
forwarded to minions that are connected to each syndic. If the \fBmaster_id\fP value
is set in the master config on the higher level masters, job results are returned
to the master that originated the request in a best effort fashion. Events/jobs
without a \fBmaster_id\fP are returned to any available master.
.SS Running the Syndic
.sp
The \fBsalt\-syndic\fP daemon is a separate process that needs to be started in
addition to the \fBsalt\-master\fP daemon running on the Syndic node.  Starting
the \fBsalt\-syndic\fP daemon is the same as starting the other Salt daemons.
.sp
The Master node in many ways sees the Syndic as an ordinary Minion node.  In
particular, the Master will need to accept the Syndic\(aqs Minion key as it would
for any other Minion.
.sp
On the Syndic node:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-syndic
or
# service salt\-syndic start
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
On the Master node:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-key \-a my_syndic
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The Master node will now be able to control the Minion nodes connected to the
Syndic.  Only the Syndic key will be listed in the Master node\(aqs key registry
but this also means that key activity between the Syndic\(aqs Minions and the
Syndic does not encumber the Master node.  In this way, the Syndic\(aqs key on the
Master node can be thought of as a placeholder for the keys of all the Minion
and Syndic nodes beneath it, giving the Master node a clear, high level
structural view on the Salt cluster.
.sp
On the Master node:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-key \-L
Accepted Keys:
my_syndic
Denied Keys:
Unaccepted Keys:
Rejected Keys:

# salt \(aq*\(aq test.version
minion_1:
    2018.3.4
minion_2:
    2018.3.4
minion_4:
    2018.3.4
minion_3:
    2018.3.4
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Topology
.sp
A Master node (a node which is itself not a Syndic to another higher level
Master node) must run a \fBsalt\-master\fP daemon and optionally a \fBsalt\-minion\fP
daemon.
.sp
A Syndic node must run \fBsalt\-syndic\fP and \fBsalt\-master\fP daemons and
optionally a \fBsalt\-minion\fP daemon.
.sp
A Minion node must run a \fBsalt\-minion\fP daemon.
.sp
When a \fBsalt\-master\fP daemon issues a command, it will be received by the
Syndic and Minion nodes directly connected to it.  A Minion node will process
the command in the way it ordinarily would.  On a Syndic node, the
\fBsalt\-syndic\fP daemon will relay the command to the \fBsalt\-master\fP daemon
running on the Syndic node, which then propagates the command to the Minions
and Syndics connected to it.
.sp
When events and job return data are generated by \fBsalt\-minion\fP daemons, they
are aggregated by the \fBsalt\-master\fP daemon they are connected to, which
\fBsalt\-master\fP daemon then relays the data back through its \fBsalt\-syndic\fP
daemon until the data reaches the Master or Syndic node that issued the command.
.SS Syndic wait
.sp
\fBsyndic_wait\fP is a master configuration file setting that specifies the number of
seconds the Salt client should wait for additional syndics to check in with their
lists of expected minions before giving up. This value defaults to \fB5\fP seconds.
.sp
The \fBsyndic_wait\fP setting is necessary because the higher\-level master does not
have a way of knowing which minions are below the syndics. The higher\-level master
has its own list of expected minions and the masters below them have their own lists
as well, so the Salt client does not know how long to wait for all returns. The
\fBsyndic_wait\fP option allows time for all minions to return to the Salt client.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To reduce the amount of time the CLI waits for Minions to respond, install
a Minion on the Syndic or tune the value of the \fBsyndic_wait\fP
configuration.
.UNINDENT
.UNINDENT
.sp
While it is possible to run a Syndic without a Minion installed on the same
system, it is recommended, for a faster CLI response time, to do so.  Without a
Minion installed on the Syndic node, the timeout value of \fBsyndic_wait\fP
increases significantly \- about three\-fold. With a Minion installed on the
Syndic, the CLI timeout resides at the value defined in \fBsyndic_wait\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you have a very large infrastructure or many layers of Syndics, you may
find that the CLI doesn\(aqt wait long enough for the Syndics to return their
events.  If you think this is the case, you can set the
\fI\%syndic_wait\fP value in the Master configs on the Master or
Syndic nodes from which commands are executed.  The default value is \fB5\fP,
and should work for the majority of deployments.
.UNINDENT
.UNINDENT
.sp
In order for a Master or Syndic node to return information from Minions that
are below their Syndics, the CLI requires a short wait time in order to allow
the Syndics to gather responses from their Minions. This value is defined in
the \fI\%syndic_wait\fP config option and has a default of five seconds.
.SS Syndic config options
.sp
These are the options that can be used to configure a Syndic node.  Note that
other than \fBid\fP, Syndic config options are placed in the Master config on the
Syndic node.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fI\%id\fP: Syndic id (shared by the \fBsalt\-syndic\fP daemon with a
potential \fBsalt\-minion\fP daemon on the same system)
.IP \(bu 2
\fI\%syndic_master\fP: Master node IP address or hostname
.IP \(bu 2
\fI\%syndic_master_port\fP: Master node ret_port
.IP \(bu 2
\fI\%syndic_log_file\fP: path to the logfile (absolute or not)
.IP \(bu 2
\fI\%syndic_pidfile\fP: path to the pidfile (absolute or not)
.IP \(bu 2
\fI\%syndic_wait\fP: time in seconds to wait on returns from this syndic
.UNINDENT
.UNINDENT
.UNINDENT
.SS Minion Data Cache
.sp
Beginning with Salt 2016.11.0, the \fI\%Pluggable Minion Data Cache\fP
was introduced. The minion data cache contains the Salt Mine data, minion grains, and minion
pillar information cached on the Salt Master. By default, Salt uses the \fBlocalfs\fP cache
module, but other external data stores can be used instead.
.sp
Using a pluggable minion cache modules allows for the data stored on a Salt Master about
Salt Minions to be replicated on other Salt Masters the Minion is connected to. Please see
the \fI\%Minion Data Cache\fP documentation for more information and configuration
examples.
.SH MINION DATA CACHE
.sp
New in version 2016.11.0.

.sp
The Minion data cache contains the Salt Mine data, minion grains and minion
pillar information cached on the Salt Master. By default, Salt uses the \fBlocalfs\fP cache
module to save the data in a \fBmsgpack\fP file on the Salt Master.
.SS Pluggable Data Cache
.sp
While the default Minion data cache is the \fBlocalfs\fP cache, other external
data stores can also be used to store this data such as the \fBconsul\fP module.
To configure a Salt Master to use a different data store, the \fI\%cache\fP
setting needs to be established:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cache: consul
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The pluggable data cache streamlines using various Salt topologies such as a
\fI\%Multi\-Master\fP or \fI\%Salt Syndics\fP configuration
by allowing the data stored on the Salt Master about a Salt Minion to be available to
other Salt Syndics or Salt Masters that a Salt Minion is connected to.
.sp
Additional minion data cache modules can be easily created by modeling the custom data
store after one of the existing cache modules.
.sp
See \fI\%cache modules\fP for a current list.
.SS Configuring the Minion Data Cache
.sp
The default \fBlocalfs\fP Minion data cache module doesn\(aqt require any
configuration.  External data cache modules with external data stores such as
Consul require a configuration setting in the master config.
.sp
Here\(aqs an example config for Consul:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
consul.host: 127.0.0.1
consul.port: 8500
consul.token: None
consul.scheme: http
consul.consistency: default
consul.dc: dc1
consul.verify: True

cache: consul
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SLOTS
.sp
New in version 2018.3.0.

.sp
Changed in version 3000.

.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This functionality is under development and could be changed in the
future releases
.UNINDENT
.UNINDENT
.sp
Many times it is useful to store the results of a command during the course of
an execution. Salt Slots are designed to allow you to store this information and
use it later during the \fI\%highstate\fP or other job
execution.
.sp
Slots extend the state syntax and allows you to do things right before the
state function is executed. So you can make a decision in the last moment right
before a state is executed.
.SS Execution functions
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Using execution modules return data as a state values is a first step
of Slots development. Other functionality is under development.
.UNINDENT
.UNINDENT
.sp
Slots allow you to use the return from a remote\-execution function as an
argument value in states.
.sp
Slot syntax looks close to the simple python function call.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__slot__:salt:<module>.<function>(<args>, ..., <kwargs...>, ...)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For the 3000 release, this syntax has been updated to support parsing functions
which return dictionaries and for appending text to the slot result.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__slot__:salt:<module>.<function>(<args>..., <kwargs...>, ...).dictionary ~ append
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There are some specifics in the syntax coming from the execution functions
nature and a desire to simplify the user experience. First one is that you
don\(aqt need to quote the strings passed to the slots functions. The second one
is that all arguments handled as strings.
.sp
Here is a simple example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
copy\-some\-file:
  file.copy:
    \- name: __slot__:salt:test.echo(text=/tmp/some_file)
    \- source: __slot__:salt:test.echo(/etc/hosts)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will execute the \fI\%test.echo\fP execution
functions right before calling the state. The functions in the example will
return \fI/tmp/some_file\fP and \fI/etc/hosts\fP strings that will be used as a target
and source arguments in the state function \fIfile.copy\fP\&.
.sp
Here is an example of result parsing and appending:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file\-in\-user\-home:
  file.copy:
    \- name: __slot__:salt:user.info(someuser).home ~ /subdirectory
    \- source: salt://somefile
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Example Usage
.sp
In Salt, slots are a powerful feature that allows you to populate information
dynamically within your Salt states. One of the best use cases for slots is when
you need to reference data that is created or modified during the course of a
Salt run.
.sp
Consider the following example, where we aim to add a user named \(aqfoobar\(aq to a
group named \(aqknown_users\(aq with specific user and group IDs. To achieve this, we
utilize slots to retrieve the group ID of \(aqknown_users\(aq as it is created or
modified during the Salt run.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
add_group_known_users:
  group.present:
    \- name: known_users

add_user:
  user.present:
    \- name: foobar
    \- uid: 600
    \- gid: __slot__:salt:group.info(\(dqknown_users\(dq).gid
    \- require:
      \- group: add_group_known_users
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example, the \fBadd_group_known_users\fP state ensures the presence of the
\(aqknown_users\(aq group. Then, within the \fBadd_user\fP state, we use the slot
\fB__slot__:salt:group.info(\(dqknown_users\(dq).gid\fP to dynamically retrieve the
group ID of \(aqknown_users,\(aq which may have been modified during the execution of
the previous state. This approach ensures that our user \(aqfoobar\(aq is associated
with the correct group, even if the group information changes during the Salt
run.
.sp
Slots offer a flexible way to work with changing data and dynamically populate
your Salt states, making your configurations adaptable and robust.
.SS Execution module returns as file contents or data
.sp
The following examples demonstrate how to use execution module returns as file
contents or data in Salt states. These examples show how to incorporate the
output of execution functions into file contents or data in the \fIfile.managed\fP
and \fIfile.serialize\fP states.
.SS Content from execution modules
.sp
You can use the results of execution modules directly as file contents in Salt
states. This can be useful for dynamically generating file content based on the
output of execution functions.
.sp
\fBExample 1: Using \(gatest.echo\(ga Output as File Content\fP
.sp
The following Salt state uses the \fItest.echo\fP execution function to generate the
text \(dqhello world.\(dq This output is then used as the content of the file
\fI/tmp/things.txt\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
content\-from\-slots:
  file.managed:
    \- name: /tmp/things.txt
    \- contents: __slot__:salt:test.echo(\(dqhello world\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExample 2: Using Multiple \(gatest.echo\(ga Outputs as Appended Content\fP
.sp
In this example, two \fItest.echo\fP execution functions are used to generate
\(dqhello\(dq and \(dqworld\(dq strings. These strings are then joined by newline characters
and then used as the content of the file \fI/tmp/things.txt\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
content\-from\-multiple\-slots:
  file.managed:
    \- name: /tmp/things.txt
    \- contents:
      \- __slot__:salt:test.echo(\(dqhello\(dq)
      \- __slot__:salt:test.echo(\(dqworld\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Serializing data from execution modules
.sp
You can also serialize data obtained from execution modules and write it to
files using Salt states. This allows you to capture and store structured data
for later use.
.sp
\fBExample: Serializing \(gagrains.items()\(ga Output to JSON\fP
.sp
In this example, the \fIgrains.items()\fP execution function retrieves system
information. The obtained data is then serialized into JSON format and saved to
the file \fI/tmp/grains.json\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
serialize\-dataset\-from\-slots:
  file.serialize:
    \- name: /tmp/grains.json
    \- serializer: json
    \- dataset: __slot__:salt:grains.items()
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
These examples showcase how to leverage Salt\(aqs flexibility to use execution
module returns as file contents or serialized data in your Salt states, allowing
for dynamic and customized configurations.
.SH WINDOWS
.sp
This section contains details on the Windows Package Manager, and specific information you need
to use Salt on Windows.
.SS Multi\-minion setup on Windows
.sp
There may be a scenario where having a minion running in the context of the
current, logged\-in user would be useful. For example, the normal minion running
under the service account would perform machine\-wide, administrative tasks. The
minion running under the user context could be launched when the user logs in
and would be able to perform configuration tasks as if it were the user itself.
.sp
The steps required to do this are as follows:
.INDENT 0.0
.IP 1. 3
Create new root_dir
.IP 2. 3
Set root_dir permissions
.IP 3. 3
Create directory structure
.IP 4. 3
Write minion config
.IP 5. 3
Start the minion
.IP 6. 3
Register the minion as a service (optional)
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The Salt Project has created a powershell script that will configure an
additional minion on the system for you. It can be found in the root of the
Salt installation. The script is named \fBmulti\-minion.ps1\fP\&. You can get
help on how to use the script by running the following in a PowerShell
prompt:
.sp
\fBGet\-Help .\emulti\-minion.ps1 \-Detailed\fP
.UNINDENT
.UNINDENT
.sp
The following guide explains these steps in more detail.
.SS 1. Create new \fBroot_dir\fP
.sp
The minion requires a root directory to store config, cache, logs, etc. The user
must have full permissions to this directory. The easiest way to do this is to
put the \fBroot_dir\fP in the Local AppData directory (\fB$env:LocalAppData\fP).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
New\-Item \-Path \(dq$env:LocalAppData\eSalt Project\eSalt\(dq \-Type Directory
.ft P
.fi
.UNINDENT
.UNINDENT
.SS 2. Set \fBroot_dir\fP permissions
.sp
The user running Salt requires full access to the \fBroot_dir\fP\&. If you have
placed the root_dir in a location that the user does not have access to, you\(aqll
need to give the user full permissions to that directory. Replace the
<placeholder variables> in this example with your own configuration information.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$RootDir = \(dq<new root_dir location>\(dq
$User    = \(dq<user running salt>\(dq
$acl = Get\-Acl \-Path \(dq$RootDir\(dq
$access_rule = New\-Object System.Security.AccessControl.FileSystemAccessRule($User, \(dqModify\(dq, \(dqAllow\(dq)
$acl.AddAccessRule($access_rule)
Set\-Acl \-Path \(dq$RootDir\(dq \-AclObject $acl
.ft P
.fi
.UNINDENT
.UNINDENT
.SS 3. Create directory structure
.sp
Salt expects a certain directory structure to be present to avoid unnecessary
messages in the logs. This is usually handled by the installer. Since you\(aqre
running your own instance, you need to do it. Make sure the following
directories are present:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
root_dir\econf\eminion.d
.IP \(bu 2
root_dir\econf\epki
.IP \(bu 2
root_dir\evar\elog\esalt
.IP \(bu 2
root_dir\evar\erun
.IP \(bu 2
root_dir\evar\ecache\esalt\eminion\eextmods\egrains
.IP \(bu 2
root_dir\evar\ecache\esalt\eminion\eproc
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$RootDir = \(dq<new root_dir location>\(dq
$cache_dir = \(dq$RootDir\evar\ecache\esalt\eminion\(dq
New\-Item \-Path \(dq$RootDir\econf\(dq \-Type Directory
New\-Item \-Path \(dq$RootDir\econf\eminion.d\(dq \-Type Directory
New\-Item \-Path \(dq$RootDir\econf\epki\(dq \-Type Directory
New\-Item \-Path \(dq$RootDir\evar\elog\esalt\(dq \-Type Directory
New\-Item \-Path \(dq$RootDir\evar\erun\(dq \-Type Directory
New\-Item \-Path \(dq$cache_dir\eextmods\egrains\(dq \-Type Directory
New\-Item \-Path \(dq$cache_dir\eproc\(dq \-Type Directory
.ft P
.fi
.UNINDENT
.UNINDENT
.SS 4. Write minion config
.sp
The minion will need its own config, separate from the system minion config.
This config tells the minion where everything is located in the file structure
and also defines the master and minion id. Create a minion config file named
\fBminion\fP in the conf directory.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
New\-Item \-Path \(dq$env:LocalAppData\eSalt Project\eSalt\econf\eminion\(dq \-Type File
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Make sure the config file has at least the following contents:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master: <ip address, dns name, etc>
id: <minion id>

root_dir: <root_dir>
log_file: <root_dir>\eval\elog\esalt\eminion
utils_dirs:
  \- <root_dir>\evar\ecache\esalt\eminion\eextmods
winrepo_dir: <root_dir>\esrv\esalt\ewin\erepo
winrepo_dir_ng: <root_dir>\esrv\esalt\ewin\erepo\-ng

file_roots:
  base:
    \- <root_dir>\esrv\esalt
    \- <root_dir>\esrv\espm\esalt

pillar_roots:
  base:
    \- <root_dir>\esrv\epillar
    \- <root_dir>\esrv\espm\epillar

thorium_roots:
  base:
    \- <root_dir>\esrv\ethorium
.ft P
.fi
.UNINDENT
.UNINDENT
.SS 5. Run the minion
.sp
Everything is now set up to run the minion. You can start the minion as you
would normally, but you need to specify the full path to the config file you
created above.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-minion.exe \-c <root_dir>\econf
.ft P
.fi
.UNINDENT
.UNINDENT
.SS 6. Register the minion as a service (optional)
.sp
You can also register the minion as a service, but you need to understand the
implications of doing so.
.INDENT 0.0
.IP \(bu 2
You will need to have administrator privileges to register this minion
service.
.IP \(bu 2
You will need the password to the user account that will be running the
minion.
.IP \(bu 2
If the user password changes, you will have to update the service definition
to reflect the new password.
.IP \(bu 2
The minion runs all the time under the user context, whether that user is
logged in or not.
.IP \(bu 2
This requires great trust from the user as the minion will be able to perform
operations under the user\(aqs name without the user knowing, whether they are
logged in or not.
.IP \(bu 2
If you decide to run the new minion under the Local System account, it might
as well just be a normal minion.
.IP \(bu 2
The helper script does not support registering the second minion as a service.
.UNINDENT
.sp
To register the minion as a service, use the \fBssm.exe\fP binary that came with
the Salt installation. Run the following commands, replacing \fB<service\-name>\fP,
\fB<root_dir>\fP, \fB<user_name>\fP, and \fB<password>\fP as necessary:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssm.exe install <service\-name> \(dqsalt\-minion.exe\(dq \(dq\-c \(ga\(dq<root_dir>\econf\(ga\(dq \-l quiet\(dq
ssm.exe set <service\-name> Description \(dqSalt Minion <user_name>\(dq
ssm.exe set <service\-name> Start SERVICE_AUTO_START
ssm.exe set <service\-name> AppStopMethodConsole 24000
ssm.exe set <service\-name> AppStopMethodWindow 2000
ssm.exe set <service\-name> AppRestartDelay 60000
ssm.exe set <service\-name> ObjectName \(dq.\e<user_name>\(dq \(dq<password>\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Windows Package Manager
.SS Introduction
.sp
Salt provides a Windows package management tool for installing, updating,
removing, and managing software packages on remote Windows systems. This tool
provides a software repository and a package manager similar to what is provided
by \fByum\fP and \fBapt\fP on Linux. The repository contains a collection of package
definition files.
.SS What are package definition files?
.sp
A package definition file is a YAML/JINJA2 file with a \fB\&.sls\fP file extension
that contains all the information needed to install software using Salt. It
defines:
.INDENT 0.0
.IP \(bu 2
Full name of the software package
.IP \(bu 2
The version of the software package
.IP \(bu 2
Download location of the software package
.IP \(bu 2
Command\-line switches for silent install and uninstall
.IP \(bu 2
Whether or not to use the Windows task scheduler to install the package
.UNINDENT
.sp
Package definition files can be hosted in one or more Git repositories. The
\fB\&.sls\fP files used to install Windows packages are not distributed by default
with Salt. You have to initialize and clone the default repository
\fI\%salt\-winrepo\-ng\fP
which is hosted on GitHub by SaltStack. The repository contains package
definition files for many common Windows packages and is maintained by SaltStack
and the Salt community. Anyone can submit a pull request to this repo to add
new package definitions.
.sp
You can manage the package definition file through either Salt or Git. You can
download software packages from either a git repository or from HTTP(S) or FTP
URLs. You can store the installer defined in the package definition file
anywhere as long as it is accessible from the host running Salt.
.sp
You can use the Salt Windows package manager like \fByum\fP on Linux. You do not
have to know the underlying command to install the software.
.INDENT 0.0
.IP \(bu 2
Use \fBpkg.install\fP to install a package using a package manager based on
the OS the system runs on.
.IP \(bu 2
Use \fBpkg.installed\fP to check if a particular package is installed in the
minion.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The Salt Windows package manager does not automatically resolve dependencies
while installing, updating, or removing packages. You have to manage the
dependencies between packages manually.
.UNINDENT
.UNINDENT
.SS Quickstart
.sp
This quickstart guides you through using the Windows Salt package manager
(winrepo) to install software packages in four steps:
.INDENT 0.0
.IP 1. 3
(Optional) \fI\%Install libraries\fP
.IP 2. 3
\fI\%Populate the local Git repository\fP
.IP 3. 3
\fI\%Update minion database\fP
.IP 4. 3
\fI\%Install software packages\fP
.UNINDENT
.SS Install libraries
.sp
(Optional) If you are using the Salt Windows package manager with package
definition files hosted on a Salt Git repo, install the libraries \fBGitPython\fP
or \fBpygit2\fP\&.
.SS Populate the local Git repository
.sp
The SLS files used to install Windows packages are not distributed by default
with Salt. Assuming no changes to the default configuration (\fBfile_roots\fP),
initialize and clone \fI\%salt\-winrepo\-ng\fP
repository.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run winrepo.update_git_repos
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
On successful execution of \fI\%winrepo.update_git_repos\fP,
the winrepo repository is cloned on the master in the location specified in
\fBwinrepo_dir_ng\fP and all package definition files are pulled down from the Git
repository.
.sp
On a masterless minion, use \fBsalt\-call\fP to initialize and clone the
\fI\%salt\-winrepo\-ng\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-\-local winrepo.update_git_repos
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
On successful execution of the runner, the winrepo repository is cloned on the
minion in the location specified in \fBwinrepo_dir_ng\fP  and all package
definition files are pulled down from the Git repository.
.SS Update minion database
.sp
Run \fI\%pkg.refresh_db\fP on all Windows
minions to create a database entry for every package definition file and build
the package database.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# From the master
salt \-G \(aqos:windows\(aq pkg.refresh_db

# From the minion in masterless mode
salt\-call \-\-local pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fI\%pkg.refresh_db\fP command parses the
YAML/JINJA package definition files and generates the database. The above
command returns the following summary denoting the number of packages that
succeeded or failed to compile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
local:
    \-\-\-\-\-\-\-\-\-\-
    failed:
        0
    success:
        301
    total:
        301
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This command can take a few minutes to complete as all the package
definition files are copied to the minion and the database is generated.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
You can use \fBpkg.refresh_db\fP when writing new Windows package definitions
to check for errors in the definitions against one or more Windows minions.
.UNINDENT
.UNINDENT
.SS Install software package
.sp
You can now install a software package using
\fI\%pkg.install\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# From the master
salt * pkg.install \(aqfirefox_x64\(aq

# From the minion in masterless mode
salt\-call \-\-local pkg.install \(dqfirefox_x64\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above command installs the latest version of Firefox on the minions.
.SS Configuration
.sp
The Github repository (winrepo) is synced to the \fBfile_roots\fP in a location
specified by the \fBwinrepo_dir_ng\fP setting in the config. The default value of
\fBwinrepo_dir_ng\fP is as follows:
.INDENT 0.0
.IP \(bu 2
Linux master: \fB/srv/salt/win/repo\-ng\fP (\fBsalt://win/repo\-ng\fP)
.IP \(bu 2
Masterless minion: \fBC:\esalt\esrv\esalt\ewin\erepo\-ng\fP (\fBsalt://win/repo\-ng\fP)
.UNINDENT
.SS Master Configuration
.sp
The following settings are available for configuring the winrepo on the
master:
.INDENT 0.0
.IP \(bu 2
\fI\%winrepo_dir\fP
.IP \(bu 2
\fI\%winrepo_dir_ng\fP
.IP \(bu 2
\fI\%winrepo_remotes\fP
.IP \(bu 2
\fI\%winrepo_remotes_ng\fP
.IP \(bu 2
\fI\%winrepo_branch\fP
.IP \(bu 2
\fI\%winrepo_provider\fP
.IP \(bu 2
\fI\%winrepo_ssl_verify\fP
.UNINDENT
.sp
See \fI\%here\fP for detailed information on all
master config options for winrepo.
.SS winrepo_dir
.sp
\fI\%winrepo_dir\fP (str)
.sp
This setting is maintained for backwards compatibility with legacy minions. It
points to the location in the \fBfile_roots\fP where the winrepo files are kept.
The default is: \fB/srv/salt/win/repo\fP
.SS winrepo_dir_ng
.sp
\fI\%winrepo_dir_ng\fP (str)
.sp
The location in the \fBfile_roots\fP where the winrepo files are kept. The default
is \fB/srv/salt/win/repo\-ng\fP\&.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
You can change the location of the winrepo directory. However, it must
always be set to a path that is inside the \fBfile_roots\fP\&.  Otherwise, the
software definition files will be unreachable by the minion.
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
A common mistake is to change the \fBfile_roots\fP setting and fail to update
the \fBwinrepo_dir_ng\fP and \fBwinrepo_dir\fP settings so that they are inside
the \fBfile_roots\fP
.UNINDENT
.UNINDENT
.SS winrepo_remotes
.sp
\fI\%winrepo_remotes\fP (list)
.sp
This setting is maintained for backwards compatibility with legacy minions. It
points to the legacy git repo. The default is a list containing a single URL:
.sp
\fI\%https://github.com/saltstack/salt\-winrepo\fP
.sp
The legacy repo can be disabled by setting it to an empty list in the master
config.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_remotes: []
.ft P
.fi
.UNINDENT
.UNINDENT
.SS winrepo_remotes_ng
.sp
\fI\%winrepo_remotes_ng\fP (list)
.sp
This setting tells the \fBwinrepo.update_git_repos\fP command where the next
generation winrepo is hosted. This a list of URLs to multiple git repos. The
default is a list containing a single URL:
.sp
\fI\%https://github.com/saltstack/salt\-winrepo\-ng\fP
.SS winrepo_refspecs
.sp
\fI\%winrepo_refspecs\fP (list)
.sp
Specify what references to fetch from remote repositories. The default is
\fB[\(aq+refs/heads/*:refs/remotes/origin/*\(aq, \(aq+refs/tags/*:refs/tags/*\(aq]\fP
.SS winrepo_branch
.sp
\fI\%winrepo_branch\fP (str)
.sp
The branch of the git repo to checkout. The default is \fBmaster\fP
.SS winrepo_provider
.sp
\fI\%winrepo_provider\fP (str)
.sp
The provider to be used for winrepo. Default is \fBpygit2\fP\&. Falls back to
\fBgitpython\fP when \fBpygit2\fP is not available
.SS winrepo_ssl_verify
.sp
\fI\%winrepo_ssl_verify\fP (bool)
.sp
Ignore SSL certificate errors when contacting remote repository. Default is
\fBFalse\fP
.SS Master Configuration (pygit2)
.sp
The following configuration options only apply when the
\fI\%winrepo_provider\fP option is set to \fBpygit2\fP\&.
.INDENT 0.0
.IP \(bu 2
\fI\%winrepo_insecure_auth\fP
.IP \(bu 2
\fI\%winrepo_passphrase\fP
.IP \(bu 2
\fI\%winrepo_password\fP
.IP \(bu 2
\fI\%winrepo_privkey\fP
.IP \(bu 2
\fI\%winrepo_pubkey\fP
.IP \(bu 2
\fI\%winrepo_user\fP
.UNINDENT
.SS winrepo_insecure_auth
.sp
\fI\%winrepo_insecure_auth\fP (bool)
.sp
Used only with \fBpygit2\fP provider. Whether or not to allow insecure auth.
Default is \fBFalse\fP
.SS winrepo_passphrase
.sp
\fI\%winrepo_passphrase\fP (str)
.sp
Used only with \fBpygit2\fP provider. Used when the SSH key being used to
authenticate is protected by a passphrase. Default is \fB\(aq\(aq\fP
.SS winrepo_privkey
.sp
\fI\%winrepo_privkey\fP (str)
.sp
Used only with \fBpygit2\fP provider. Used with \fI\%winrepo_pubkey\fP to
authenticate to SSH remotes. Default is \fB\(aq\(aq\fP
.SS winrepo_pubkey
.sp
\fI\%winrepo_pubkey\fP (str)
.sp
Used only with \fBpygit2\fP provider. Used with \fI\%winrepo_privkey\fP to
authenticate to SSH remotes. Default is \fB\(aq\(aq\fP
.SS winrepo_user
.sp
\fI\%winrepo_user\fP (str)
.sp
Used only with \fBpygit2\fP provider. Used with \fI\%winrepo_password\fP to
authenticate to HTTPS remotes. Default is \fB\(aq\(aq\fP
.SS winrepo_password
.sp
\fI\%winrepo_password\fP (str)
.sp
Used only with \fBpygit2\fP provider. Used with \fI\%winrepo_user\fP to
authenticate to HTTPS remotes. Default is \fB\(aq\(aq\fP
.SS Minion Configuration
.sp
Refreshing the package definitions can take some time, these options were
introduced to allow more control of when it occurs. These settings apply to all
minions whether in masterless mode or not.
.INDENT 0.0
.IP \(bu 2
\fI\%winrepo_cache_expire_max\fP
.IP \(bu 2
\fI\%winrepo_cache_expire_min\fP
.IP \(bu 2
\fI\%winrepo_cachefile\fP
.IP \(bu 2
\fI\%winrepo_source_dir\fP
.UNINDENT
.SS winrepo_cache_expire_max
.sp
\fI\%winrepo_cache_expire_max\fP (int)
.sp
Sets the maximum age in seconds of the winrepo metadata file to avoid it
becoming stale. If the metadata file is older than this setting, it will trigger
a \fBpkg.refresh_db\fP on the next run of any \fBpkg\fP module function that
requires the metadata file. Default is 604800 (1 week).
.sp
Software package definitions are automatically refreshed if stale after
\fI\%winrepo_cache_expire_max\fP\&. Running a highstate forces the refresh
of the package definitions and regenerates the metadata, unless the metadata is
younger than \fI\%winrepo_cache_expire_max\fP\&.
.SS winrepo_cache_expire_min
.sp
\fI\%winrepo_cache_expire_min\fP (int)
.sp
Sets the minimum age in seconds of the winrepo metadata file to avoid refreshing
too often. If the metadata file is older than this setting, the metadata will be
refreshed unless you pass \fBrefresh: False\fP in the state. Default is 1800
(30 min).
.SS winrepo_cachefile
.sp
\fI\%winrepo_cachefile\fP (str)
.sp
The file name of the winrepo cache file. The file is placed at the root of
\fBwinrepo_dir_ng\fP\&. Default is \fBwinrepo.p\fP\&.
.SS winrepo_source_dir
.sp
\fI\%winrepo_source_dir\fP (str)
.sp
The location of the .sls files on the Salt file server. Default is
\fBsalt://win/repo\-ng/\fP\&.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
If the default for \fBwinrepo_dir_ng\fP is changed, then this setting will
also need to be changed on each minion. The default setting for
\fBwinrepo_dir_ng\fP is \fB/srv/salt/win/repo\-ng\fP\&. If that were changed to
\fB/srv/salt/new/repo\-ng\fP then the \fBwinrepo_source_dir\fP would need to be
changed to \fBsalt://new/repo\-ng\fP
.UNINDENT
.UNINDENT
.SS Masterless Minion Configuration
.sp
The following settings are available for configuring the winrepo on a masterless
minion:
.INDENT 0.0
.IP \(bu 2
\fI\%winrepo_dir\fP
.IP \(bu 2
\fI\%winrepo_dir_ng\fP
.IP \(bu 2
\fI\%winrepo_remotes\fP
.IP \(bu 2
\fI\%winrepo_remotes_ng\fP
.UNINDENT
.sp
See \fI\%here\fP for detailed information on all
minion config options for winrepo.
.SS winrepo_dir
.sp
\fI\%winrepo_dir\fP (str)
.sp
This setting is maintained for backwards compatibility with legacy minions. It
points to the location in the \fBfile_roots\fP where the winrepo files are kept.
The default is: \fBC:\eProgramData\eSalt Project\eSalt\esrv\esalt\ewin\erepo\fP
.SS winrepo_dir_ng
.sp
\fI\%winrepo_dir_ng\fP (str)
.sp
The location in the \fBfile_roots\fP where the winrepo files are kept. The default
is \fBC:\eProgramData\eSalt Project\eSalt\esrv\esalt\ewin\erepo\-ng\fP\&.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
You can change the location of the winrepo directory. However, it must
always be set to a path that is inside the \fBfile_roots\fP\&.  Otherwise, the
software definition files will be unreachable by the minion.
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
A common mistake is to change the \fBfile_roots\fP setting and fail to update
the \fBwinrepo_dir_ng\fP and \fBwinrepo_dir\fP settings so that they are inside
the \fBfile_roots\fP\&. You might also want to verify \fBwinrepo_source_dir\fP on
the minion as well.
.UNINDENT
.UNINDENT
.SS winrepo_remotes
.sp
\fI\%winrepo_remotes\fP (list)
.sp
This setting is maintained for backwards compatibility with legacy minions. It
points to the legacy git repo. The default is a list containing a single URL:
.sp
\fI\%https://github.com/saltstack/salt\-winrepo\fP
.sp
The legacy repo can be disabled by setting it to an empty list in the minion
config.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_remotes: []
.ft P
.fi
.UNINDENT
.UNINDENT
.SS winrepo_remotes_ng
.sp
\fI\%winrepo_remotes_ng\fP (list)
.sp
This setting tells the \fBwinrepo.update_git_repos\fP command where the next
generation winrepo is hosted. This a list of URLs to multiple git repos. The
default is a list containing a single URL:
.sp
\fI\%https://github.com/saltstack/salt\-winrepo\-ng\fP
.SS Sample Configurations
.SS Masterless
.sp
The configs in this section are for working with winrepo on a Windows minion
using \fBsalt\-call \-\-local\fP\&.
.SS Default Configuration
.sp
This is the default configuration if nothing is configured in the minion config.
The config is shown here for clarity. These are the defaults:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- C:\eProgramData\eSalt Project\eSalt\esrv\esalt
winrepo_source_dir: \(aqsalt://win/repo\-ng\(aq
winrepo_dir_ng: C:\eProgramData\eSalt Project\eSalt\esrv\esalt\ewin\erepo\-ng
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fI\%winrepo.update_git_repos\fP
command will clone the repository to \fBwin\erepo\-ng\fP on the file_roots.
.SS Multiple Salt Environments
.sp
This starts to get a little tricky. The winrepo repository doesn\(aqt
get cloned to each environment when you run
\fI\%winrepo.update_git_repos\fP, so to
make this work, all environments share the same winrepo. Applying states using
the \fBsaltenv\fP option will find the state files in the appropriate environment,
but the package definition files will always be pulled from the same location.
Therefore, you have to put the same winrepo location in each saltenv. Here\(aqs how
this would look:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- C:\eProgramData\eSalt Project\eSalt\esrv\esalt\ebase
    \- C:\eProgramData\eSalt Project\eSalt\esrv\esalt\ewinrepo
  test:
    \- C:\eProgramData\eSalt Project\eSalt\esrv\esalt\etest
    \- C:\eProgramData\eSalt Project\eSalt\esrv\esalt\ewinrepo
winrepo_source_dir: \(aqsalt://salt\-winrepo\-ng\(aq
winrepo_dir_ng: C:\eProgramData\eSalt Project\eSalt\esrv\esalt\ewinrepo
winrepo_dir: C:\eProgramData\eSalt Project\eSalt\esrv\esalt\ewinrepo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When you run
\fI\%winrepo.update_git_repos\fP the
Git repository will be cloned to the location specified in the
\fBwinrepo_dir_ng\fP setting. I specified the \fBwinrepo_dir\fP setting just so
everything gets cloned to the same place. The directory that gets cloned is
named \fBsalt\-winrepo\-ng\fP so you specify that in the \fBwinrepo_source_dir\fP
setting.
.sp
The \fBwinrepo\fP directory should only contain the package definition files. You
wouldn\(aqt want to place any states in the \fBwinrepo\fP directory as they will be
available to both environments.
.SS Master
.sp
When working in a Master/Minion environment you have to split up some of the
config settings between the master and the minion. Here are some sample configs
for winrepo in a Master/Minion environment.
.SS Default Configuration
.sp
This is the default configuration if nothing is configured. The config is shown
here for clarity. These are the defaults on the master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt
winrepo_dir_ng: /srv/salt/win/repo\-ng
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is the default in the minion config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_source_dir: \(aqsalt://win/repo\-ng\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fI\%winrepo.update_git_repos\fP
command will clone the repository to \fBwin\erepo\-ng\fP on the file_roots.
.SS Multiple Salt Environments
.sp
To set up multiple saltenvs using a Master/Minion configuration set the
following in the master config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt/base
    \- /srv/salt/winrepo
  test:
    \- /srv/salt/test
    \- /srv/salt/winrepo
winrepo_dir_ng: /srv/salt/winrepo
winrepo_dir: /srv/salt/winrepo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Use the winrepo runner to set up the winrepo repository on the master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run winrepo.update_git_repos
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The winrepo will be cloned to \fB/srv/salt/winrepo\fP under a directory named
\fBsalt\-winrepo\-ng\fP\&.
.sp
Set the following on the minion config so the minion knows where to find the
package definition files in the file_roots:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_source_dir: \(aqsalt://salt\-winrepo\-ng\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The same stipulations apply in a Master/Minion configuration as they do in a
Masterless configuration
.SS Usage
.sp
After completing the configuration and initialization, you can use the Salt
package manager commands to manage software on Windows minions.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The following example commands can be run from the master using \fBsalt\fP or
on a masterless minion using \fBsalt\-call\fP
.UNINDENT
.UNINDENT
.TS
center;
|l|l|l|.
_
T{
T}	T{
Command
T}	T{
Description
T}
_
T{
1
T}	T{
\fI\%pkg.list_pkgs\fP
T}	T{
Displays a list of all packages installed in the system.
T}
_
T{
2
T}	T{
\fI\%pkg.list_available\fP
T}	T{
Displays the versions available of a particular package to be installed.
T}
_
T{
3
T}	T{
\fI\%pkg.install\fP
T}	T{
Installs a given package.
T}
_
T{
4
T}	T{
\fI\%pkg.remove\fP
T}	T{
Uninstalls a given package.
T}
_
.TE
.SS List installed packages
.sp
Use \fI\%pkg.list_pkgs\fP to display a list of
packages installed on the system.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# From the master
salt \-G \(aqos:windows\(aq pkg.list_pkgs

# From the minion in masterless mode
salt\-call \-\-local pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The command displays the software name and the version for every package
installed on the system irrespective of whether it was installed by the Salt
package manager.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
local:
    \-\-\-\-\-\-\-\-\-\-
    Frhed 1.6.0:
        1.6.0
    GNU Privacy Guard:
        2.2.16
    Gpg4win (3.1.9):
        3.1.9
    git:
        2.17.1.2
    nsis:
        3.03
    python3_x64:
        3.7.4150.0
    salt\-minion\-py3:
        2019.2.3
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The software name indicates whether the software is managed by Salt or not.
.sp
If Salt finds a match in the winrepo database, then the software name is the
short name as defined in the package definition file. It is usually a
single\-word, lower\-case name.
.sp
All other software names are displayed as the full name as shown in
Add/Remove Programs. In the above example, Git (git), Nullsoft Installer (nsis),
Python 3.7 (python3_x64), and Salt (salt\-minion\-py3) have corresponding package
definition files and are managed by Salt, while Frhed 1.6.0, GNU Privacy guard,
and GPG4win are not.
.SS List available versions
.sp
Use \fI\%pkg.list_available\fP to display
a list of versions of a package available for installation. You can pass the
name of the software in the command. You can refer to the software by its
\fBname\fP or its \fBfull_name\fP surrounded by quotes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# From the master
salt winminion pkg.list_available firefox_x64

# From the minion in masterless mode
salt\-call \-\-local pkg.list_available firefox_x64
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The command lists all versions of Firefox available for installation.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winminion:
    \- 69.0
    \- 69.0.1
    \- 69.0.2
    \- 69.0.3
    \- 70.0
    \- 70.0.1
    \- 71.0
    \- 72.0
    \- 72.0.1
    \- 72.0.2
    \- 73.0
    \- 73.0.1
    \- 74.0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For a Linux master, you can surround the file name with single quotes.
However, for the \fBcmd\fP shell on Windows, use double quotes when wrapping
strings that may contain spaces. Powershell accepts either single quotes or
double quotes.
.UNINDENT
.UNINDENT
.SS Install a package
.sp
Use \fI\%pkg.install\fP: to install a package.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# From the master
salt winminion pkg.install \(aqfirefox_x64\(aq

# From the minion in masterless mode
salt\-call \-\-local pkg.install \(dqfirefox_x64\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The command installs the latest version of Firefox.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# From the master
salt winminion pkg.install \(aqfirefox_x64\(aq version=74.0

# From the minion in masterless mode
salt\-call \-\-local pkg.install \(dqfirefox_x64\(dq version=74.0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The command installs version 74.0 of Firefox.
.sp
If a different version of the package is already installed, then the old version
is replaced with the version in the winrepo (only if the package supports live
updating).
.sp
You can also specify the full name of the software while installing:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# From the master
salt winminion pkg.install \(aqMozilla Firefox 17.0.1 (x86 en\-US)\(aq

# From the minion in masterless mode
salt\-call \-\-local pkg.install \(dqMozilla Firefox 17.0.1 (x86 en\-US)\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Remove a package
.sp
Use \fI\%pkg.remove\fP to remove a package.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# From the master
salt winminion pkg.remove firefox_x64

# From the minion in masterless mode
salt\-call \-\-local pkg.remove firefox_x64
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Package definition file directory structure and naming
.sp
All package definition files are stored in the location configured in the
\fBwinrepo_dir_ng\fP setting. All files in this directory with a \fB\&.sls\fP file
extension are considered package definition files. These files are evaluated to
create the metadata file on the minion.
.sp
You can maintain standalone package definition files that point to software on
other servers or on the internet. In this case the file name is the short name
of the software with the \fB\&.sls\fP extension, for example,\(ga\(gafirefox.sls\(ga\(ga.
.sp
You can also store the binaries for your software together with their software
definition files in their own directory. In this scenario, the directory name
is the short name for the software and the package definition file stored that
directory is named \fBinit.sls\fP\&.
.sp
Look at the following example directory structure on a Linux master assuming
default config settings:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
srv/
|\-\-\-salt/
|   |\-\-\-win/
|   |   |\-\-\-repo\-ng/
|   |   |   |\-\-\-custom_defs/
|   |   |   |   |\-\-\-ms_office_2013_x64/
|   |   |   |   |   |\-\-\-access.en\-us/
|   |   |   |   |   |\-\-\-excel.en\-us/
|   |   |   |   |   |\-\-\-outlook.en\-us/
|   |   |   |   |   |\-\-\-powerpoint.en\-us/
|   |   |   |   |   |\-\-\-word.en\-us/
|   |   |   |   |   |\-\-\-init.sls
|   |   |   |   |   |\-\-\-setup.dll
|   |   |   |   |   |\-\-\-setup.exe
|   |   |   |   |\-\-\-openssl.sls
|   |   |   |   |\-\-\-zoom.sls
|   |   |   |\-\-\-salt\-winrepo\-ng/
|   |   |   |   |\-\-\-auditbeat/
|   |   |   |   |   |\-\-\-init.sls
|   |   |   |   |   |\-\-\-install.cmd
|   |   |   |   |   |\-\-\-install.ps1
|   |   |   |   |   |\-\-\-remove.cmd
|   |   |   |   |\-\-\-gpg4win/
|   |   |   |   |   |\-\-\-init.sls
|   |   |   |   |   |\-\-\-silent.ini
|   |   |   |   |\-\-\-7zip.sls
|   |   |   |   |\-\-\-adobereader.sls
|   |   |   |   |\-\-\-audacity.sls
|   |   |   |   |\-\-\-ccleaner.sls
|   |   |   |   |\-\-\-chrome.sls
|   |   |   |   |\-\-\-firefox.sls
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above directory structure:
.INDENT 0.0
.IP \(bu 2
The \fBcustom_defs\fP directory contains the following custom package definition
files.
.INDENT 2.0
.IP \(bu 2
A folder for MS Office 2013 that contains the installer files for all the
MS Office software and a package definition file named \fBinit.sls\fP\&.
.IP \(bu 2
Two additional standalone package definition files \fBopenssl.sls\fP and
\fBzoom.sls\fP to install OpenSSl and Zoom.
.UNINDENT
.IP \(bu 2
The \fBsalt\-winrepo\-ng\fP directory contains the clone of the git repo specified
by the \fBwinrepo_remotes_ng\fP config setting.
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Do not modify the files in the \fBsalt\-winrepo\-ng\fP directory as it breaks
future runs of \fBwinrepo.update_git_repos\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Do not place any custom software definition files in the \fBsalt\-winrepo\-ng\fP
directory as the \fBwinrepo.update_git_repos\fP command wipes out the contents
of the \fBsalt\-winrepo\-ng\fP directory each time it is run and any extra files
stored in the Salt winrepo are lost.
.UNINDENT
.UNINDENT
.SS Writing package definition files
.sp
You can write your own software definition file if you know:
.INDENT 0.0
.IP \(bu 2
The full name of the software as shown in Add/Remove Programs
.IP \(bu 2
The exact version number as shown in Add/Remove Programs
.IP \(bu 2
How to install your software silently from the command line
.UNINDENT
.sp
Here is a YAML software definition file for Firefox:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
firefox_x64:
  \(aq74.0\(aq:
    full_name: Mozilla Firefox 74.0 (x64 en\-US)
    installer: \(aqhttps://download\-installer.cdn.mozilla.net/pub/firefox/releases/74.0/win64/en\-US/Firefox%20Setup%2074.0.exe\(aq
    install_flags: \(aq/S\(aq
    uninstaller: \(aq%ProgramFiles(x86)%/Mozilla Firefox/uninstall/helper.exe\(aq
    uninstall_flags: \(aq/S\(aq
  \(aq73.0.1\(aq:
    full_name: Mozilla Firefox 73.0.1 (x64 en\-US)
    installer: \(aqhttps://download\-installer.cdn.mozilla.net/pub/firefox/releases/73.0.1/win64/en\-US/Firefox%20Setup%2073.0.1.exe\(aq
    install_flags: \(aq/S\(aq
    uninstaller: \(aq%ProgramFiles(x86)%/Mozilla Firefox/uninstall/helper.exe\(aq
    uninstall_flags: \(aq/S\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The package definition file itself is a data structure written in YAML with
three indentation levels:
.INDENT 0.0
.IP \(bu 2
The first level item is a short name that Salt uses to reference the software.
This short name is used to install and remove the software and it must be
unique across all package definition files in the repo. Also, there must be
only one short name in the file.
.IP \(bu 2
The second level item is the version number. There can be multiple version
numbers for a package but they must be unique within the file.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When running \fBpkg.list_pkgs\fP, the short name and version number are
displayed when Salt finds a match in the repo. Otherwise, the full package
name is displayed.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
The third indentation level contains all parameters that Salt needs to install
the software. The parameters are:
.INDENT 2.0
.IP \(bu 2
\fBfull_name\fP : The full name as displayed in Add/Remove Programs
.IP \(bu 2
\fBinstaller\fP : The location of the installer binary
.IP \(bu 2
\fBinstall_flags\fP : The flags required to install silently
.IP \(bu 2
\fBuninstaller\fP : The location of the uninstaller binary
.IP \(bu 2
\fBuninstall_flags\fP : The flags required to uninstall silently
.IP \(bu 2
\fBmsiexec\fP : Use msiexec to install this package
.IP \(bu 2
\fBallusers\fP : If this is an MSI, install to all users
.IP \(bu 2
\fBcache_dir\fP : Cache the entire directory in the installer URL if it starts
with \fBsalt://\fP
.IP \(bu 2
\fBcache_file\fP : Cache a single file in the installer URL if it starts with
\fBsalt://\fP
.IP \(bu 2
\fBuse_scheduler\fP : Launch the installer using the task scheduler
.IP \(bu 2
\fBsource_hash\fP : The hash sum for the installer
.UNINDENT
.UNINDENT
.SS Example package definition files
.sp
This section provides some examples of package definition files for different
use cases such as:
.INDENT 0.0
.IP \(bu 2
Writing a \fI\%simple package definition file\fP
.IP \(bu 2
Writing a \fI\%JINJA templated package definition file\fP
.IP \(bu 2
Writing a package definition file to \fI\%install the latest version of the software\fP
.IP \(bu 2
Writing a package definition file to \fI\%install an MSI patch\fP
.UNINDENT
.sp
These examples enable you to gain a better understanding of the usage of
different file parameters. To understand the examples, you need a basic
\fI\%Understanding Jinja\fP\&.
For an exhaustive dive into Jinja, refer to the official
\fI\%Jinja Template Designer documentation\fP\&.
.SS Example: Simple
.sp
Here is a pure YAML example of a simple package definition file for Firefox:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
firefox_x64:
  \(aq74.0\(aq:
    full_name: Mozilla Firefox 74.0 (x64 en\-US)
    installer: \(aqhttps://download\-installer.cdn.mozilla.net/pub/firefox/releases/74.0/win64/en\-US/Firefox%20Setup%2074.0.exe\(aq
    install_flags: \(aq/S\(aq
    uninstaller: \(aq%ProgramFiles(x86)%/Mozilla Firefox/uninstall/helper.exe\(aq
    uninstall_flags: \(aq/S\(aq
  \(aq73.0.1\(aq:
    full_name: Mozilla Firefox 73.0.1 (x64 en\-US)
    installer: \(aqhttps://download\-installer.cdn.mozilla.net/pub/firefox/releases/73.0.1/win64/en\-US/Firefox%20Setup%2073.0.1.exe\(aq
    install_flags: \(aq/S\(aq
    uninstaller: \(aq%ProgramFiles(x86)%/Mozilla Firefox/uninstall/helper.exe\(aq
    uninstall_flags: \(aq/S\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The first line is the short name of the software which is \fBfirefox_x64\fP\&.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
The short name must be unique across all other short names in the software
repository. The \fBfull_name\fP combined with the version must also be unique.
.UNINDENT
.UNINDENT
.sp
The second line is the \fBsoftware version\fP and is indented two spaces.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
The version number must be enclosed in quotes or the YAML parser removes the
trailing zeros. For example, if the version number \fB74.0\fP is not enclosed
within quotes, then the version number is rendered as \fB74\fP\&.
.UNINDENT
.UNINDENT
.sp
The lines following the \fBversion\fP are indented two more spaces and contain all
the information needed to install the Firefox package.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
You can specify multiple versions of software by specifying multiple version
numbers at the same indentation level as the first with its software
definition below it.
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
The \fBfull_name\fP must match exactly what is shown in Add/Remove Programs
(\fBappwiz.cpl\fP)
.UNINDENT
.UNINDENT
.SS Example: JINJA templated package definition file
.sp
JINJA is the default templating language used in package definition files. You
can use JINJA to add variables and expressions to package definition files that
get replaced with values when the \fB\&.sls\fP go through the Salt renderer.
.sp
When there are tens or hundreds of versions available for a piece of software,
the definition file can become large and cumbersome to maintain. In this
scenario, JINJA can be used to add logic, variables, and expressions to
automatically create the package definition file for software with multiple
versions.
.sp
Here is a an example of a package definition file for Firefox that uses JINJA:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set lang = salt[\(aqconfig.get\(aq](\(aqfirefox:pkg:lang\(aq, \(aqen\-US\(aq) %}

firefox_x64:
  {% for version in [\(aq74.0\(aq,
                     \(aq73.0.1\(aq, \(aq73.0\(aq,
                     \(aq72.0.2\(aq, \(aq72.0.1\(aq, \(aq72.0\(aq,
                     \(aq71.0\(aq, \(aq70.0.1\(aq, \(aq70.0\(aq,
                     \(aq69.0.3\(aq, \(aq69.0.2\(aq, \(aq69.0.1\(aq] %}
  \(aq{{ version }}\(aq:
    full_name: \(aqMozilla Firefox {{ version }} (x64 {{ lang }})\(aq
    installer: \(aqhttps://download\-installer.cdn.mozilla.net/pub/firefox/releases/{{ version }}/win64/{{ lang }}/Firefox%20Setup%20{{ version }}.exe\(aq
    install_flags: \(aq/S\(aq
    uninstaller: \(aq%ProgramFiles%\eMozilla Firefox\euninstall\ehelper.exe\(aq
    uninstall_flags: \(aq/S\(aq
  {% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this example, JINJA is used to generate a package definition file that
defines how to install 12 versions of Firefox. Jinja is used to create a list of
available versions. The list is iterated through a \fBfor loop\fP where each
version is placed in the \fBversion\fP variable. The version is inserted
everywhere there is a \fB{{ version }}\fP marker inside the \fBfor loop\fP\&.
.sp
The single variable (\fBlang\fP) defined at the top of the package definition
identifies the language of the package. You can access the Salt modules using
the \fBsalt\fP keyword. In this case, the \fBconfig.get\fP function is invoked to
retrieve the language setting. If the \fBlang\fP variable is not defined then the
default value is \fBen\-US\fP\&.
.SS Example: Package definition file to install the latest version
.sp
Some software vendors do not provide access to all versions of their software.
Instead, they provide a single URL to what is always the latest version. In some
cases, the software keeps itself up to date. One example of this is the \fI\%Google
Chrome web browser\fP\&.
.sp
To handle situations such as these, set the version to \fIlatest\fP\&. Here\(aqs an
example of a package definition file to install the latest version of Chrome.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
chrome:
  latest:
    full_name: \(aqGoogle Chrome\(aq
    installer: \(aqhttps://dl.google.com/edgedl/chrome/install/GoogleChromeStandaloneEnterprise.msi\(aq
    install_flags: \(aq/qn /norestart\(aq
    uninstaller: \(aqhttps://dl.google.com/edgedl/chrome/install/GoogleChromeStandaloneEnterprise.msi\(aq
    uninstall_flags: \(aq/qn /norestart\(aq
    msiexec: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above example:
.INDENT 0.0
.IP \(bu 2
\fBVersion\fP is set to \fBlatest\fP\&. Salt then installs the latest version of
Chrome at the URL and displays that version.
.IP \(bu 2
\fBmsiexec\fP is set to \fBTrue\fP, hence the software is installed using an MSI.
.UNINDENT
.SS Example: Package definition file to install an MSI patch
.sp
For MSI installers, when the \fBmsiexec\fP parameter is set to true, the \fB/i\fP
option is used for installation, and the \fB/x\fP option is used for
uninstallation. However, when installing an MSI patch, the \fB/i\fP and \fB/x\fP
options cannot be combined.
.sp
Here is an example of a package definition file to install an MSI patch:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
MyApp:
  \(aq1.0\(aq:
    full_name: MyApp
    installer: \(aqsalt://win/repo\-ng/MyApp/MyApp.1.0.msi\(aq
    install_flags: \(aq/qn /norestart\(aq
    uninstaller: \(aq{B5B5868F\-23BA\-297A\-917D\-0DF345TF5764}\(aq
    uninstall_flags: \(aq/qn /norestart\(aq
    msiexec: True
  \(aq1.1\(aq:
    full_name: MyApp
    installer: \(aqsalt://win/repo\-ng/MyApp/MyApp.1.0.msi\(aq
    install_flags: \(aq/qn /norestart /update \(dq%cd%\e\eMyApp.1.1.msp\(dq \(aq
    uninstaller: \(aq{B5B5868F\-23BA\-297A\-917D\-0DF345TF5764}\(aq
    uninstall_flags: \(aq/qn /norestart\(aq
    msiexec: True
    cache_file: salt://win/repo\-ng/MyApp/MyApp.1.1.msp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the above example:
.INDENT 0.0
.IP \(bu 2
Version \fB1.0\fP of the software installs the application using the \fB1.0\fP
MSI defined in the \fBinstaller\fP parameter.
.IP \(bu 2
There is no file to be cached and the \fBinstall_flags\fP parameter does not
include any special values.
.UNINDENT
.sp
Version \fB1.1\fP of the software uses the same installer file as Version
\fB1.0\fP\&. Now, to apply a patch to Version 1.0, make the following changes in
the package definition file:
.INDENT 0.0
.IP \(bu 2
Place the patch file (MSP file) in the same directory as the installer file
(MSI file) on the \fBfile_roots\fP
.IP \(bu 2
In the \fBcache_file\fP parameter, specify the path to the single patch file.
.IP \(bu 2
In the \fBinstall_flags\fP parameter, add the \fB/update\fP flag and include the
path to the MSP file using the \fB%cd%\fP environment variable. \fB%cd%\fP
resolves to the current working directory, which is the location in the minion
cache where the installer file is cached.
.UNINDENT
.sp
For more information, see issue \fI\%#32780\fP\&.
.sp
The same approach could be used for applying MST files for MSIs and answer files
for other types of .exe\-based installers.
.SS Parameters
.sp
This section describes the parameters placed under the \fBversion\fP in the
package definition file. Examples can be found on the \fI\%Salt winrepo repository\fP\&.
.SS full_name (str)
.sp
The full name of the software as shown in \(dqAdd/Remove Programs\(dq. You can also
retrieve the full name of the package by installing the package manually and
then running \fBpkg.list_pkgs\fP\&. Here\(aqs an example of the output from
\fBpkg.list_pkgs\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aqtest\-2008\(aq pkg.list_pkgs
test\-2008
    \-\-\-\-\-\-\-\-\-\-
    7\-Zip 9.20 (x64 edition):
        9.20.00.0
    Mozilla Firefox 74.0 (x64 en\-US)
        74.0
    Mozilla Maintenance Service:
        74.0
    salt\-minion\-py3:
        3001
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Notice the full Name for Firefox: \fBMozilla Firefox 74.0 (x64 en\-US)\fP\&. The
\fBfull_name\fP parameter in the package definition file must match this name.
.sp
The example below shows the \fBpkg.list_pkgs\fP for a machine that has Mozilla
Firefox 74.0 installed with a package definition file for that version of
Firefox.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
test\-2008:
    \-\-\-\-\-\-\-\-\-\-
    7zip:
        9.20.00.0
    Mozilla Maintenance Service:
        74.0
    firefox_x64:
        74.0
    salt\-minion\-py3:
        3001
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
On running \fBpkg.list_pkgs\fP, if any of the software installed on the machine
matches the full name defined in any one of the software definition files in the
repository, then the package name is displayed in the output.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
The version number and \fBfull_name\fP must match the output of
\fBpkg.list_pkgs\fP so that the installation status can be verified by the
state system.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
You can successfully install packages using \fBpkg.install\fP, even if the
\fBfull_name\fP or the version number doesn\(aqt match. The module will complete
successfully, but continue to display the full name in \fBpkg.list_pkgs\fP\&.
If this is happening, verify that the \fBfull_name\fP and the \fBversion\fP
match exactly what is displayed in Add/Remove Programs.
.UNINDENT
.UNINDENT
.sp
\fBTIP:\fP
.INDENT 0.0
.INDENT 3.5
To force Salt to display the full name when there\(aqs already an existing
package definition file on the system, you can pass a bogus \fBsaltenv\fP
parameter to the command like so: \fBpkg.list_pkgs saltenv=NotARealEnv\fP
.UNINDENT
.UNINDENT
.sp
\fBTIP:\fP
.INDENT 0.0
.INDENT 3.5
It\(aqs important use \fI\%pkg.refresh_db\fP
to check for errors and ensure the latest package definition is on any
minion you\(aqre testing new definitions on.
.UNINDENT
.UNINDENT
.SS installer (str)
.sp
The path to the binary (\fB\&.exe\fP, \fB\&.msi\fP) that installs the package.
.sp
This can be a local path or a URL. If it is a URL or a Salt path (\fBsalt://\fP),
then the package is cached locally and then executed. If it is a path to a file
on disk or a file share, then it is executed directly.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When storing software in the same location as the winrepo:
.INDENT 0.0
.IP \(bu 2
Create a sub folder named after the package.
.IP \(bu 2
Store the package definition file named \fBinit.sls\fP and the binary
installer in the same sub folder if you are hosting those files on the
\fBfile_roots\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBpkg.refresh_db\fP command processes all \fB\&.sls\fP files in all sub
directories in the \fBwinrepo_dir_ng\fP directory.
.UNINDENT
.UNINDENT
.SS install_flags (str)
.sp
The flags passed to the installer for silent installation.
.sp
You may be able to find these flags by adding \fB/?\fP or \fB/h\fP when running the
installer from the command line. See \fI\%WPKG project wiki\fP for information on silent install flags.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Always ensure that the installer has the ability to install silently,
otherwise Salt appears to hang while the installer waits for user input.
.UNINDENT
.UNINDENT
.SS uninstaller (str)
.sp
The path to the program to uninstall the software.
.sp
This can be the path to the same \fB\&.exe\fP or \fB\&.msi\fP used to install the
software. If you use a \fB\&.msi\fP to install the software, then you can either
use the GUID of the software or the same \fB\&.msi\fP to uninstall the software.
.sp
You can find the uninstall information in the registry:
.INDENT 0.0
.IP \(bu 2
Software\eMicrosoft\eWindows\eCurrentVersion\eUninstall
.IP \(bu 2
Software\eWOW6432Node\eMicrosoft\eWindows\eCurrentVersion\eUninstall
.UNINDENT
.sp
Here\(aqs an example that uses the GUID to uninstall software:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
7zip:
  \(aq9.20.00.0\(aq:
    full_name: 7\-Zip 9.20 (x64 edition)
    installer: salt://win/repo\-ng/7zip/7z920\-x64.msi
    install_flags: \(aq/qn /norestart\(aq
    uninstaller: \(aq{23170F69\-40C1\-2702\-0920\-000001000000}\(aq
    uninstall_flags: \(aq/qn /norestart\(aq
    msiexec: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here\(aqs an example that uses the MSI installer to uninstall software:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
7zip:
  \(aq9.20.00.0\(aq:
    full_name: 7\-Zip 9.20 (x64 edition)
    installer: salt://win/repo\-ng/7zip/7z920\-x64.msi
    install_flags: \(aq/qn /norestart\(aq
    uninstaller: salt://win/repo\-ng/7zip/7z920\-x64.msi
    uninstall_flags: \(aq/qn /norestart\(aq
    msiexec: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS uninstall_flags (str)
.sp
The flags passed to the uninstaller for silent uninstallation.
.sp
You may be able to find these flags by adding \fB/?\fP or \fB/h\fP when running the
uninstaller from the command\-line. See \fI\%WPKG project wiki\fP for information on silent uninstall flags.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Always ensure that the installer has the ability to uninstall silently,
otherwise Salt appears to hang while the uninstaller waits for user input.
.UNINDENT
.UNINDENT
.SS msiexec (bool, str)
.sp
This setting informs Salt to use \fBmsiexec /i\fP to install the package and \fBmsiexec /x\fP
to uninstall. This setting only applies to \fB\&.msi\fP installations.
.sp
Possible options are:
.INDENT 0.0
.IP \(bu 2
True
.IP \(bu 2
False (default)
.IP \(bu 2
the path to \fBmsiexec.exe\fP on your system
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
7zip:
  \(aq9.20.00.0\(aq:
    full_name: 7\-Zip 9.20 (x64 edition)
    installer: salt://win/repo/7zip/7z920\-x64.msi
    install_flags: \(aq/qn /norestart\(aq
    uninstaller: salt://win/repo/7zip/7z920\-x64.msi
    uninstall_flags: \(aq/qn /norestart\(aq
    msiexec: \(aqC:\eWindows\eSystem32\emsiexec.exe\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS allusers (bool)
.sp
This parameter is specific to \fB\&.msi\fP installations. It tells \fBmsiexec\fP to
install the software for all users. The default is \fBTrue\fP\&.
.SS cache_dir (bool)
.sp
This setting requires the software to be stored on the \fBfile_roots\fP and only
applies to URLs that begin with \fBsalt://\fP\&. If set to \fBTrue\fP, then the
entire directory where the installer resides is recursively cached. This is
useful for installers that depend on other files in the same directory for
installation.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
If set to \fBTrue\fP, then all files and directories in the same location as
the installer file are copied down to the minion. For example, if you place
your package definition file with \fBcache_dir: True\fP in the root of winrepo
(\fB/srv/salt/win/repo\-ng\fP) then the entire contents of winrepo is cached to
the minion. Therefore, it is best practice to place your package definition
file along with its installer files in a subdirectory if they are stored in
winrepo.
.UNINDENT
.UNINDENT
.sp
Here\(aqs an example using cache_dir:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sqlexpress:
  \(aq12.0.2000.8\(aq:
    full_name: Microsoft SQL Server 2014 Setup (English)
    installer: \(aqsalt://win/repo/sqlexpress/setup.exe\(aq
    install_flags: \(aq/ACTION=install /IACCEPTSQLSERVERLICENSETERMS /Q\(aq
    cache_dir: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS cache_file (str)
.sp
This setting requires the file to be stored on the \fBfile_roots\fP and only
applies to URLs that begin with \fBsalt://\fP\&. It indicates that the single file
specified is copied down for use with the installer. It is copied to the same
location as the installer. Use this setting instead of \fBcache_dir\fP when you
only need to cache a single file.
.SS use_scheduler (bool)
.sp
If set to \fBTrue\fP, Windows uses the task scheduler to run the installation. A
one\-time task is created in the task scheduler and launched. The return to the
minion is that the task was launched successfully, not that the software was
installed successfully.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is used in the package definition for Salt itself. The first thing the
Salt installer does is kill the Salt service, which then kills all child
processes. If the Salt installer is launched via Salt, then the installer
is killed with the salt\-minion service, leaving Salt on the machine but not
running. Using the task scheduler allows an external process to launch the
Salt installer so its processes aren\(aqt killed when the Salt service is
stopped.
.UNINDENT
.UNINDENT
.SS source_hash (str)
.sp
This setting informs Salt to compare a hash sum of the installer to the provided
hash sum before execution. The value can be formatted as \fB<hash_algorithm>=<hash_sum>\fP,
or it can be a URI to a file containing the hash sum.
.sp
For a list of supported algorithms, see the \fI\%hashlib documentation\fP\&.
.sp
Here\(aqs an example using \fBsource_hash\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
messageanalyzer:
  \(aq4.0.7551.0\(aq:
    full_name: \(aqMicrosoft Message Analyzer\(aq
    installer: \(aqsalt://win/repo/messageanalyzer/MessageAnalyzer64.msi\(aq
    install_flags: \(aq/quiet /norestart\(aq
    uninstaller: \(aq{1CC02C23\-8FCD\-487E\-860C\-311EC0A0C933}\(aq
    uninstall_flags: \(aq/quiet /norestart\(aq
    msiexec: True
    source_hash: \(aqsha1=62875ff451f13b10a8ff988f2943e76a4735d3d4\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Not Implemented
.sp
The following parameters are often seen in the software definition files hosted
on the Git repo. However, they are not implemented and do not affect the
installation process.
.INDENT 0.0
.TP
.B param bool reboot
Not implemented
.TP
.B param str locale
Not implemented
.UNINDENT
.SS Managing Windows Software on a Standalone Windows Minion
.sp
The Windows Software Repository functions similarly in a standalone environment,
with a few differences in the configuration.
.sp
To replace the winrepo runner used on the Salt master, an \fBexecution module\fP exists to provide the same functionality to standalone
minions. The functions for the module share the same names with functions in the
runner and are used in the same way; the only difference is that \fBsalt\-call\fP
is used instead of \fBsalt\-run\fP to run those functions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call winrepo.update_git_repos
salt\-call pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
After executing the previous commands, the repository on the standalone system
is ready for use.
.SS Troubleshooting
.SS My software installs correctly but \fBpkg.installed\fP says it failed
.sp
If you have a package that seems to install properly but Salt reports a failure
then it is likely you have a \fBversion\fP or \fBfull_name\fP mismatch.
.INDENT 0.0
.IP \(bu 2
Check the \fBfull_name\fP and \fBversion\fP of the package as shown in Add/Remove
Programs (\fBappwiz.cpl\fP).
.IP \(bu 2
Use \fBpkg.list_pkgs\fP to check that the \fBfull_name\fP and \fBversion\fP exactly
match what is installed.
.IP \(bu 2
Verify that the \fBfull_name\fP and \fBversion\fP in the package definition file
match the full name and version in Add/Remove programs.
.IP \(bu 2
Ensure that the \fBversion\fP is wrapped in single quotes in the package
definition file.
.UNINDENT
.SS Changes to package definition files not being picked up
.sp
Make sure you refresh the database on the minion (\fBpkg.refresh_db\fP) after
updating package definition files in the repo.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt winminion pkg.refresh_db
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Winrepo upgrade issues
.sp
To minimize potential issues, it is a good idea to remove any winrepo git
repositories that were checked out by the legacy (pre\-2015.8.0) winrepo code
when upgrading the master to 2015.8.0 or later. Run \fI\%winrepo.update_git_repos\fP to clone them anew after the master is
started.
.SS pygit2 / GitPython Support for Maintaining Git Repos
.sp
pygit2 and GitPython are the supported python interfaces to Git. The runner
\fI\%winrepo.update_git_repos\fP uses the
same underlying code as \fI\%Git Fileserver Backend\fP and
\fI\%Git External Pillar\fP to maintain and update its
local clones of git repositories.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If compatible versions of both pygit2 and GitPython are installed, then
Salt will prefer pygit2. To override this behavior use the
\fI\%winrepo_provider\fP configuration parameter, ie:
\fBwinrepo_provider: gitpython\fP
.UNINDENT
.UNINDENT
.SS Accessing authenticated Git repos (pygit2)
.sp
pygit2 enables you to access authenticated git repositories and set per\-remote
config settings. An example of this is:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_remotes:
  \- https://github.com/saltstack/salt\-winrepo.git
  \- git@github.com:myuser/myrepo.git:
    \- pubkey: /path/to/key.pub
    \- privkey: /path/to/key
    \- passphrase: myaw3s0m3pa$$phr4$3
  \- https://github.com/myuser/privaterepo.git:
    \- user: mygithubuser
    \- password: CorrectHorseBatteryStaple
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The per\-remote configuration settings work in the same manner as they do in
gitfs, with global parameters being overridden by their per\-remote
counterparts. For instance, setting \fI\%winrepo_passphrase\fP
sets a global passphrase for winrepo that applies to all SSH\-based
remotes, unless overridden by a \fBpassphrase\fP per\-remote parameter.
.sp
See \fI\%here\fP for a detailed
explanation of how per\-remote configuration works in gitfs. The same
principles apply to winrepo.
.UNINDENT
.UNINDENT
.SS Maintaining Git repos
.sp
A \fBclean\fP argument is added to the
\fI\%winrepo.update_git_repos\fP
runner to maintain the Git repos. When \fBclean=True\fP the runner removes
directories under the \fI\%winrepo_dir_ng\fP/\fI\%winrepo_dir_ng\fP
that are not explicitly configured. This eliminates the need to manually remove
these directories when a repo is removed from the config file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run winrepo.update_git_repos clean=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a mix of git and non\-git Windows Repo definition files are used, then
do not pass \fBclean=True\fP, as it removes the directories containing non\-git
definitions.
.SS Name collisions between repos
.sp
Salt detects collisions between repository names. The
\fI\%winrepo.update_git_repos\fP
runner does not execute successfully if any collisions between repository names
are detected. Consider the following configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_remotes:
  \- https://foo.com/bar/baz.git
  \- https://mydomain.tld/baz.git
  \- https://github.com/foobar/baz.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With the above configuration, the \fI\%winrepo.update_git_repos\fP
runner fails to execute as all three repos would be checked out to the same
directory. To resolve this conflict, use the per\-remote parameter called
\fBname\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
winrepo_remotes:
  \- https://foo.com/bar/baz.git
  \- https://mydomain.tld/baz.git:
    \- name: baz_junior
  \- https://github.com/foobar/baz.git:
    \- name: baz_the_third
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now on running the \fI\%winrepo.update_git_repos\fP:
.INDENT 0.0
.IP \(bu 2
\fI\%https://foo.com/bar/baz.git\fP repo is initialized and cloned under the \fBwin_repo_dir_ng\fP directory.
.IP \(bu 2
\fI\%https://mydomain.tld/baz.git\fP repo is initialized and cloned under the \fBwin_repo_dir_ng\ebaz_junior\fP directory.
.IP \(bu 2
\fI\%https://github.com/foobar/baz.git\fP repo is initialized and cloned under the \fBwin_repo_dir_ng\ebaz_the_third\fP directory.
.UNINDENT
.SS Windows\-specific Behaviour
.sp
Salt is capable of managing Windows systems, however due to various differences
between the operating systems, there are some things you need to keep in mind.
.sp
This document will contain any quirks that apply across Salt or generally across
multiple module functions. Any Windows\-specific behavior for particular module
functions will be documented in the module function documentation. Therefore
this document should be read in conjunction with the module function
documentation.
.SS Group parameter for files
.sp
Salt was originally written for managing Unix\-based systems, and therefore the
file module functions were designed around that security model. Rather than
trying to shoehorn that model on to Windows, Salt ignores these parameters and
makes non\-applicable module functions unavailable instead.
.sp
One of the commonly ignored parameters is the \fBgroup\fP parameter for managing
files. Under Windows, while files do have a \(aqprimary group\(aq property, this is
rarely used.  It generally has no bearing on permissions unless intentionally
configured and is most commonly used to provide Unix compatibility (e.g.
Services For Unix, NFS services).
.sp
Because of this, any file module functions that typically require a group, do
not under Windows. Attempts to directly use file module functions that operate
on the group (e.g. \fBfile.chgrp\fP) will return a pseudo\-value and cause a log
message to appear. No group parameters will be acted on.
.sp
If you do want to access and change the \(aqprimary group\(aq property and understand
the implications, use the \fBfile.get_pgid\fP or \fBfile.get_pgroup\fP functions or
the \fBpgroup\fP parameter on the \fBfile.chown\fP module function.
.SS Dealing with case\-insensitive but case\-preserving names
.sp
Windows is case\-insensitive, but however preserves the case of names and it is
this preserved form that is returned from system functions. This causes some
issues with Salt because it assumes case\-sensitive names. These issues
generally occur in the state functions and can cause bizarre looking errors.
.sp
To avoid such issues, always pretend Windows is case\-sensitive and use the right
case for names, e.g. specify \fBuser=Administrator\fP instead of
\fBuser=administrator\fP\&.
.sp
Follow \fI\%issue 11801\fP for any changes to this behavior.
.SS Dealing with various username forms
.sp
Salt does not understand the various forms that Windows usernames can come in,
e.g. username, mydomain\eusername, \fI\%username@mydomain.tld\fP can all refer to the
same user. In fact, Salt generally only considers the raw username value, i.e.
the username without the domain or host information.
.sp
Using these alternative forms will likely confuse Salt and cause odd errors to
happen. Use only the raw username value in the correct case to avoid problems.
.sp
Follow \fI\%issue 11801\fP for any changes to this behavior.
.SS Specifying the None group
.sp
Each Windows system has built\-in _None_ group. This is the default \(aqprimary
group\(aq for files for users not on a domain environment.
.sp
Unfortunately, the word _None_ has special meaning in Python \- it is a special
value indicating \(aqnothing\(aq, similar to \fBnull\fP or \fBnil\fP in other languages.
.sp
To specify the None group, it must be specified in quotes, e.g.
\fB\&./salt \(aq*\(aq file.chpgrp C:\epath\eto\efile \(dq\(aqNone\(aq\(dq\fP\&.
.SS Symbolic link loops
.sp
Under Windows, if any symbolic link loops are detected or if there are too many
levels of symlinks (defaults to 64), an error is always raised.
.sp
For some functions, this behavior is different to the behavior on Unix
platforms. In general, avoid symlink loops on either platform.
.SH DEVELOPING SALT
.SS Overview
.sp
In its most typical use, Salt is a software application in which clients,
called \(dqminions\(dq can be commanded and controlled from a central command server
called a \(dqmaster\(dq.
.sp
Commands are normally issued to the minions (via the master) by calling a
client script simply called, \(aqsalt\(aq.
.sp
Salt features a pluggable transport system to issue commands from a master to
minions. The default transport is ZeroMQ.
.SS Salt Client
.SS Overview
.sp
The salt client is run on the same machine as the Salt Master and communicates
with the salt\-master to issue commands and to receive the results and display
them to the user.
.sp
The primary abstraction for the salt client is called \(aqLocalClient\(aq.
.sp
When LocalClient wants to publish a command to minions, it connects to the
master by issuing a request to the master\(aqs ReqServer (TCP: 4506)
.sp
The LocalClient system listens to responses for its requests by listening to
the master event bus publisher (master_event_pub.ipc).
.SS Salt Master
.SS Overview
.sp
The salt\-master daemon runs on the designated Salt master and performs
functions such as authenticating minions, sending, and receiving requests
from connected minions and sending and receiving requests and replies to the
\(aqsalt\(aq CLI.
.SS Moving Pieces
.sp
When a Salt master starts up, a number of processes are started, all of which
are called \(aqsalt\-master\(aq in a process\-list but have various role categories.
.sp
Among those categories are:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Publisher
.IP \(bu 2
EventPublisher
.IP \(bu 2
MWorker
.UNINDENT
.UNINDENT
.UNINDENT
.SS Publisher
.sp
The Publisher process is responsible for sending commands over the designated
transport to connected minions. The Publisher is bound to the following:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
TCP: port 4505
.IP \(bu 2
IPC: publish_pull.ipc
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Each salt minion establishes a connection to the master Publisher.
.SS EventPublisher
.sp
The EventPublisher publishes master events out to any event listeners. It is
bound to the following:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
IPC: master_event_pull.ipc
.IP \(bu 2
IPC: master_event_pub.ipc
.UNINDENT
.UNINDENT
.UNINDENT
.SS MWorker
.sp
Worker processes manage the back\-end operations for the Salt Master.
.sp
The number of workers is equivalent to the number of \(aqworker_threads\(aq
specified in the master configuration and is always at least one.
.sp
Workers are bound to the following:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
IPC: workers.ipc
.UNINDENT
.UNINDENT
.UNINDENT
.SS ReqServer
.sp
The Salt request server takes requests and distributes them to available MWorker
processes for processing. It also receives replies back from minions.
.INDENT 0.0
.TP
.B The ReqServer is bound to the following:
.INDENT 7.0
.IP \(bu 2
TCP: 4506
.IP \(bu 2
IPC: workers.ipc
.UNINDENT
.UNINDENT
.sp
Each salt minion establishes a connection to the master ReqServer.
.SS Job Flow
.sp
The Salt master works by always publishing commands to all connected minions
and the minions decide if the command is meant for them by checking themselves
against the command target.
.sp
The typical lifecycle of a salt job from the perspective of the master
might be as follows:
.INDENT 0.0
.IP 1. 4
A command is issued on the CLI. For example, \(aqsalt my_minion test.version\(aq.
.IP 2. 4
The \(aqsalt\(aq command uses LocalClient to generate a request to the salt master
by connecting to the ReqServer on \fI\%TCP:4506\fP and issuing the job.
.IP 3. 4
The salt\-master ReqServer sees the request and passes it to an available
MWorker over workers.ipc.
.IP 4. 4
A worker picks up the request and handles it. First, it checks to ensure
that the requested user has permissions to issue the command. Then, it sends
the publish command to all connected minions. For the curious, this happens
in ClearFuncs.publish().
.IP 5. 4
The worker announces on the master event bus that it is about to publish a
job to connected minions. This happens by placing the event on the master
event bus (master_event_pull.ipc) where the EventPublisher picks it up and
distributes it to all connected event listeners on master_event_pub.ipc.
.IP 6. 4
The message to the minions is encrypted and sent to the Publisher via IPC on
publish_pull.ipc.
.IP 7. 4
Connected minions have a TCP session established with the Publisher on TCP
port 4505 where they await commands. When the Publisher receives the job
over publish_pull, it sends the jobs across the wire to the minions for
processing.
.IP 8. 4
After the minions receive the request, they decrypt it and perform any
requested work, if they determine that they are targeted to do so.
.IP 9. 4
When the minion is ready to respond, it publishes the result of its job back
to the master by sending the encrypted result back to the master on TCP 4506
where it is again picked up by the ReqServer and forwarded to an available
MWorker for processing. (Again, this happens by passing this message across
workers.ipc to an available worker.)
.IP 10. 4
When the MWorker receives the job it decrypts it and fires an event onto
the master event bus (master_event_pull.ipc). (Again for the curious, this
happens in AESFuncs._return().
.IP 11. 4
The EventPublisher sees this event and re\-publishes it on the bus to all
connected listeners of the master event bus (on master_event_pub.ipc). This
is where the LocalClient has been waiting, listening to the event bus for
minion replies. It gathers the job and stores the result.
.IP 12. 4
When all targeted minions have replied or the timeout has been exceeded,
the salt client displays the results of the job to the user on the CLI.
.UNINDENT
.SS Salt Minion
.SS Overview
.sp
The salt\-minion is a single process that sits on machines to be managed by
Salt. It can either operate as a stand\-alone daemon which accepts commands
locally via \(aqsalt\-call\(aq or it can connect back to a master and receive commands
remotely.
.sp
When starting up, salt minions connect \fIback\fP to a master defined in the minion
config file. They connect to two ports on the master:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B TCP: 4505
This is the connection to the master Publisher. It is on this port that
the minion receives jobs from the master.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B TCP: 4506
This is the connection to the master ReqServer. It is on this port that
the minion sends job results back to the master.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Event System
.sp
Similar to the master, a salt\-minion has its own event system that operates
over IPC by default. The minion event system operates on a push/pull system
with IPC files at minion_event_<unique_id>_pub.ipc and
minion_event_<unique_id>_pull.ipc.
.sp
The astute reader might ask why have an event bus at all with a single\-process
daemon. The answer is that the salt\-minion may fork other processes as required
to do the work without blocking the main salt\-minion process and this
necessitates a mechanism by which those processes can communicate with each
other. Secondarily, this provides a bus by which any user with sufficient
permissions can read or write to the bus as a common interface with the salt
minion.
.SS Minion Job Flow
.sp
When a salt minion starts up, it attempts to connect to the Publisher and the
ReqServer on the salt master. It then attempts to authenticate and once the
minion has successfully authenticated, it simply listens for jobs.
.sp
Jobs normally come either come from the \(aqsalt\-call\(aq script run by a local user
on the salt minion or they can come directly from a master.
.sp
The job flow on a minion, coming from the master via a \(aqsalt\(aq command is as
follows:
.sp
1) A master publishes a job that is received by a minion as outlined by the
master\(aqs job flow above.
2) The minion is polling its receive socket that\(aqs connected to the master
Publisher (TCP 4505 on master). When it detects an incoming message, it picks it
up from the socket and decrypts it.
3) A new minion process or thread is created and provided with the contents of the
decrypted message. The _thread_return() method is provided with the contents of
the received message.
4) The new minion thread is created. The _thread_return() function starts up
and actually calls out to the requested function contained in the job.
5) The requested function runs and returns a result. [Still in thread.]
6) The result of the function that\(aqs run is published on the minion\(aqs local event bus with event
tag \(dq__master_req_channel_payload\(dq [Still in thread.]
7) Thread exits. Because the main thread was only blocked for the time that it
took to initialize the worker thread, many other requests could have been
received and processed during this time.
8) Minion event handler gets the event with tag \(dq__master_req_channel_payload\(dq
and sends the payload to master\(aqs ReqServer (TCP 4506 on master), via the long\-running async request channel
that was opened when minion first started up.
.SS A Note on ClearFuncs vs. AESFuncs
.sp
A common source of confusion is determining when messages are passed in the
clear and when they are passed using encryption. There are two rules governing
this behaviour:
.sp
1) ClearFuncs is used for intra\-master communication and during the initial
authentication handshake between a minion and master during the key exchange.
2) AESFuncs is used everywhere else.
.SS Changelog
.sp
With the addition of \fI\%SEP 01\fP the \fI\%keepachangelog\fP format was introduced into
our CHANGELOG.md file. The Salt project is using the \fI\%towncrier\fP tool to manage
the CHANGELOG.md file. The reason this tool was added to manage the changelog
was because we were previously managing the file manually and it would cause
many merge conflicts. This tool allows us to add changelog entries into separate
files and before a release we simply need to run \fBtowncrier \-\-version=<version>\fP
for it to compile the changelog correctly.
.SS How do I add a changelog entry
.sp
To add a changelog entry you will need to add a file in the \fIchangelog\fP directory.
The file name should follow the syntax \fB<issue #>.<type>.md\fP\&. If it is a security
fix then the following syntax will need to be used \fBcve\-<cve\-number>.security.md\fP\&.
.sp
The types are in alignment with keepachangelog:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B removed:
any features that have been removed
.TP
.B deprecated:
any features that will soon be removed
.TP
.B changed:
any changes in current existing features
.TP
.B fixed:
any bug fixes
.TP
.B added:
any new features added
.TP
.B security:
any fixes for a cve
.UNINDENT
.UNINDENT
.UNINDENT
.sp
For example if you are fixing a bug for issue number #1234 your filename would
look like this: \fIchangelog/1234.fixed.md\fP\&. The contents of the file should contain
a summary of what you are fixing. If there is a legitimate reason to not include
an issue number with a given contribution you can add the PR number as the file
name (\fB<PR #>.<type>.md\fP).
.sp
For a security fix your filename would look like this: \fIchangelog/cve\-2021\-25283.security.md\fP\&.
.sp
If your PR does not align with any of the types, then you do not need to add a
changelog entry.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Requirement Files:
Updates to package requirements files also require a changelog file. This will usually
be associated with \fI\&.fixed\fP if its resolving an issue or \fI\&.security\fP if it\(aqs resolving
a CVE issue in an upstream project. If updates are made to testing requirement files
it does not require a changelog.
.UNINDENT
.UNINDENT
.SS How to generate the changelog
.sp
This step is only used when we need to generate the changelog right before releasing.
You should NOT run towncrier on your PR, unless you are preparing the final PR
to update the changelog before a release.
.sp
You can run the \fItowncrier\fP tool directly or you can use \fItools\fP to help run the command
and ensure towncrier is installed in a virtual environment. The instructions below
will detail both approaches.
.SS Installing \fItools\fP
.sp
If you want to see what output towncrier will produce before generating the change log
you can run towncrier in draft mode:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
towncrier \-\-draft \-\-version=3001
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tools changelog update\-changelog\-md \-\-draft 3000.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Version will need to be set to whichever version we are about to release. Once you are
confident the draft output looks correct you can now generate the changelog by running:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
towncrier \-\-version=3001
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tools changelog update\-changelog\-md 3000.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
After this is run towncrier will automatically remove all the files in the changelog directory.
.sp
If you want to force towncrier to automatically remove all the files in the changelog directory
without asking you to type yes, you can set force to True.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
towncrier \-\-yes \-\-version=3001
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fItools changelog update\-changelog\-md <version>\fP command will automatically add \fI\-\-yes\fP if \fI\-\-draft\fP is not passed.
.SS Contributing
.sp
So you want to contribute to the Salt project? Excellent! You can help
in a number of ways:
.INDENT 0.0
.IP \(bu 2
Use Salt and open well\-written bug reports.
.IP \(bu 2
Join a \fI\%working group\fP\&.
.IP \(bu 2
Answer questions on \fI\%irc\fP,
the \fI\%community Slack\fP,
the \fI\%salt\-users mailing
list\fP,
\fI\%Server Fault\fP,
or \fI\%r/saltstack on Reddit\fP\&.
.IP \(bu 2
Fix bugs.
.IP \(bu 2
\fI\%Improve the documentation\fP\&.
.IP \(bu 2
Provide workarounds, patches, or other code without tests.
.IP \(bu 2
Tell other people about problems you solved using Salt.
.UNINDENT
.sp
If you\(aqd like to update docs or fix an issue, you\(aqre going to need the
Salt repo. The best way to contribute is using
\fI\%Git\fP\&.
.SS Environment setup
.sp
To hack on Salt or the docs you\(aqre going to need to set up your
development environment. If you already have a workflow that you\(aqre
comfortable with, you can use that, but otherwise this is an opinionated
guide for setting up your dev environment. Follow these steps and you\(aqll
end out with a functioning dev environment and be able to submit your
first PR.
.sp
This guide assumes at least a passing familiarity with
\fI\%Git\fP, a common version control tool used
across many open source projects, and is necessary for contributing to
Salt. For an introduction to Git, watch \fI\%Salt Docs Clinic \- Git For the
True
Beginner\fP\&.
Because of its widespread use, there are many resources for learning
more about Git. One popular resource is the free online book \fI\%Learn Git
in a Month of
Lunches\fP\&.
.SS pyenv, Virtual Environments, and you
.sp
We recommend \fI\%pyenv\fP, since it allows
installing multiple different Python versions, which is important for
testing Salt across all the versions of Python that we support.
.SS On Linux
.sp
Install pyenv:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git clone https://github.com/pyenv/pyenv.git ~/.pyenv
export PATH=\(dq$HOME/.pyenv/bin:$PATH\(dq
git clone https://github.com/pyenv/pyenv\-virtualenv.git $(pyenv root)/plugins/pyenv\-virtualenv
.ft P
.fi
.UNINDENT
.UNINDENT
.SS On Mac
.sp
Install pyenv using brew:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
brew update
brew install pyenv
brew install pyenv\-virtualenv
.ft P
.fi
.UNINDENT
.UNINDENT

.sp
.ce
----

.ce 0
.sp
.sp
Now add pyenv to your \fB\&.bashrc\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
echo \(aqexport PATH=\(dq$HOME/.pyenv/bin:$PATH\(dq\(aq >> ~/.bashrc
pyenv init 2>> ~/.bashrc
pyenv virtualenv\-init 2>> ~/.bashrc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For other shells, see \fI\%the pyenv
instructions\fP\&.
.sp
Go ahead and restart your shell. Now you should be able to install a new
version of Python:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pyenv install 3.9.18
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If that fails, don\(aqt panic! You\(aqre probably just missing some build
dependencies. Check out \fI\%pyenv common build
problems\fP\&.
.sp
Now that you\(aqve got your version of Python installed, you can create a
new virtual environment with this command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pyenv virtualenv 3.9.18 salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then activate it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pyenv activate salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Sweet! Now you\(aqre ready to clone Salt so you can start hacking away! If
you get stuck at any point, check out the resources at the beginning of
this guide. IRC and Slack are particularly helpful places to go.
.SS Get the source!
.sp
Salt uses the fork and clone workflow for Git contributions. See \fI\%Using
the Fork\-and\-Branch Git
Workflow\fP
for how to implement it. But if you just want to hurry and get started
you can go ahead and follow these steps:
.sp
Clones are so shallow. Well, this one is anyway:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git clone \-\-depth=1 \-\-origin salt https://github.com/saltstack/salt.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This creates a shallow clone of Salt, which should be fast. Most of the
time that\(aqs all you\(aqll need, and you can start building out other
commits as you go. If you \fIreally\fP want all 108,300+ commits you can
just run \fBgit fetch \-\-unshallow\fP\&. Then go make a sandwich because it\(aqs
gonna be a while.
.sp
You\(aqre also going to want to head over to GitHub and create your own
\fI\%fork of Salt\fP\&. Once you\(aqve
got that set up you can add it as a remote:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git remote add yourname <YOUR SALT REMOTE>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you use your name to refer to your fork, and \fBsalt\fP to refer to the
official Salt repo you\(aqll never get \fBupstream\fP or \fBorigin\fP confused.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Each time you start work on a new issue you should fetch the most recent
changes from \fBsalt/upstream\fP\&.
.UNINDENT
.UNINDENT
.SS Set up \fBpre\-commit\fP and \fBnox\fP
.sp
Here at Salt we use \fI\%pre\-commit\fP and
\fI\%nox\fP to make it easier for
contributors to get quick feedback, for quality control, and to increase
the chance that your merge request will get reviewed and merged. Nox
enables us to run multiple different test configurations, as well as
other common tasks. You can think of it as Make with superpowers.
Pre\-commit does what it sounds like: it configures some Git pre\-commit
hooks to run \fBblack\fP for formatting, \fBisort\fP for keeping our imports
sorted, and \fBpylint\fP to catch issues like unused imports, among
others. You can easily install them in your virtualenv with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m pip install pre\-commit nox
pre\-commit install
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Currently there is an issue with the pip\-tools\-compile pre\-commit hook on Windows.
The details around this issue are included here:
\fI\%https://github.com/saltstack/salt/issues/56642\fP\&.
Please ensure you export \fBSKIP=pip\-tools\-compile\fP to skip pip\-tools\-compile.
.UNINDENT
.UNINDENT
.sp
Now before each commit, it will ensure that your code at least \fIlooks\fP
right before you open a pull request. And with that step, it\(aqs time to
start hacking on Salt!
.SS Set up imagemagick
.sp
One last prerequisite is to have \fBimagemagick\fP installed, as it is required
by Sphinx for generating the HTML documentation.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# On Mac, via homebrew
brew install imagemagick
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Example Linux installation: Debian\-based
sudo apt install imagemagick
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Salt issues
.SS Create your own
.sp
Perhaps you\(aqve come to this guide because you found a problem in Salt,
and you\(aqve diagnosed the cause. Maybe you need some help figuring out
the problem. In any case, creating quality bug reports is a great way to
contribute to Salt even if you lack the skills, time, or inclination to
fix it yourself. If that\(aqs the case, head on over to \fI\%Salt\(aqs issue
tracker on
GitHub\fP\&.
.sp
Creating a \fBgood\fP report can take a little bit of time \- but every
minute you invest in making it easier for others to reproduce and
understand your issue is time well spent. The faster someone can
understand your issue, the faster it will be able to get fixed
correctly.
.sp
The thing that every issue needs goes by many names, but one at least as
good as any other is MCVE \- \fBM\fPinimum \fBC\fPomplete
\fBV\fPerifiable \fBE\fPxample.
.sp
In a nutshell:
.INDENT 0.0
.IP \(bu 2
\fBMinimum\fP: All of the \fBextra\fP information has been removed. Will
2 or 3 lines of master/minion config still exhibit the behavior?
.IP \(bu 2
\fBComplete\fP: Minimum also means complete. If your example is missing
information, then it\(aqs not complete. Salt, Python, and OS versions
are all bits of information that make your example complete. Have you
provided the commands that you ran?
.IP \(bu 2
\fBVerifiable\fP: Can someone take your report and reproduce it?
.UNINDENT
.sp
Slow is smooth, and smooth is fast \- it may feel like you\(aqre taking a
long time to create your issue if you\(aqre creating a proper MCVE, but a
MCVE eliminates back and forth required to reproduce/verify the issue so
someone can actually create a fix.
.SS Pick an issue
.sp
If you don\(aqt already have an issue in mind, you can search for \fI\%help
wanted\fP
issues. If you also search for \fI\%good first
issue\fP
then you should be able to find some issues that are good for getting
started contributing to Salt. \fI\%Documentation
issues\fP
are also good starter issues. When you find an issue that catches your
eye (or one of your own), it\(aqs a good idea to comment on the issue and
mention that you\(aqre working on it. Good communication is key to
collaboration \- so if you don\(aqt have time to complete work on the issue,
just leaving some information about when you expect to pick things up
again is a great idea!
.SS Hacking away
.SS Salt, tests, documentation, and you
.sp
Before approving code contributions, Salt requires:
.INDENT 0.0
.IP \(bu 2
documentation
.IP \(bu 2
meaningful passing tests
.IP \(bu 2
correct code
.UNINDENT
.sp
Documentation fixes just require correct documentation.
.SS What if I don\(aqt write tests or docs?
.sp
If you aren\(aqt into writing documentation or tests, we still welcome your
contributions! But your PR will be labeled \fBNeeds Testcase\fP and
\fBHelp Wanted\fP until someone can get to write the tests/documentation.
Of course, if you have a desire but just lack the skill we are more than
happy to collaborate and help out! There\(aqs the \fI\%documentation working
group\fP
and the \fI\%testing working group\fP\&.
We also regularly stream our test clinic \fI\%live on
Twitch\fP every Tuesday afternoon
and Thursday morning, Central Time. If you\(aqd like specific help with
tests, bring them to the clinic. If no community members need help, you
can also just watch tests written in real time.
.SS Documentation
.sp
Salt uses both docstrings, as well as normal reStructuredText files in
the \fBsalt/doc\fP folder for documentation. Sphinx is used to generate the
documentation, and does require \fBimagemagick\fP\&. See \fI\%Set up imagemagick\fP for
more information.
.sp
Before submitting a documentation PR, it helps to first build the Salt docs
locally on your machine and preview them. Local previews helps you:
.INDENT 0.0
.IP \(bu 2
Debug potential documentation output errors before submitting a PR.
.IP \(bu 2
Saves you time by not needing to use the Salt CI/CD test suite to debug, which takes
more than 30 minutes to run on a PR.
.IP \(bu 2
Ensures the final output looks the way you intended it to look.
.UNINDENT
.sp
To set up your local environment to preview the core Salt and module
documentation:
.INDENT 0.0
.IP 1. 3
Install the documentation dependencies. For example, on Ubuntu:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
sudo apt\-get update

sudo apt\-get install \-y enchant\-2 git gcc imagemagick make zlib1g\-dev libc\-dev libffi\-dev g++ libxml2 libxml2\-dev libxslt\-dev libcurl4\-openssl\-dev libssl\-dev libgnutls28\-dev xz\-utils inkscape
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
Navigate to the folder where you store your Salt repository and remove any
\fI\&.nox\fP directories that might be in that folder:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
rm \-rf .nox
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
Install \fIpyenv\fP for the version of Python needed to run the docs. As of the
time of writing, the Salt docs theme is not compatible with Python 3.10, so
you\(aqll need to run 3.9 or earlier. For example:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
pyenv install 3.9.18
pyenv virtualenv 3.9.18 salt\-docs
echo \(aqsalt\-docs\(aq > .python\-version
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 4. 3
Activate \fIpyenv\fP if it\(aqs not auto\-activated:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
pyenv exec pip install \-U pip setuptools wheel
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 5. 3
Install \fInox\fP into your pyenv environment, which is the utility that will
build the Salt documentation:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
pyenv exec pip install nox
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Since we use \fBnox\fP, you can build your docs and view them in your browser
with this one\-liner:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m nox \-e \(aqdocs\-html(compress=False, clean=False)\(aq; cd doc/_build/html; python \-m webbrowser http://localhost:8000/contents.html; python \-m http.server
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The first time you build the docs, it will take a while because there are a
\fIlot\fP of modules. Maybe you should go grab some dessert if you already finished
that sandwich. But once nox and Sphinx are done building the docs, python should
launch your default browser with the URL
\fI\%http://localhost:8000/contents.html\fP\&. Now you can navigate to your docs
and ensure your changes exist. If you make changes, you can simply run
this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cd \-; python \-m nox \-e \(aqdocs\-html(compress=False, clean=False)\(aq; cd doc/_build/html; python \-m http.server
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And then refresh your browser to get your updated docs. This one should
be quite a bit faster since Sphinx won\(aqt need to rebuild everything.
.sp
Alternatively, you could build the docs on your local machine and then preview
the build output. To build the docs locally:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pyenv exec nox \-e \(aqdocs\-html(compress=False, clean=True)\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The output from this command will put the preview files in: \fBdoc > _build > html\fP\&.
.sp
If your change is a docs\-only change, you can go ahead and commit/push
your code and open a PR. You can indicate that it\(aqs a docs\-only change by
adding \fB[Documentation]\fP to the title of your PR. Otherwise, you\(aqll
want to write some tests and code.
.SS Running development Salt
.sp
Note: If you run into any issues in this section, check the
Troubleshooting section.
.sp
If you\(aqre going to hack on the Salt codebase you\(aqre going to want to be
able to run Salt locally. The first thing you need to do is install Salt
as an editable pip install:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m pip install \-e .
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will let you make changes to Salt without having to re\-install it.
.sp
After all of the dependencies and Salt are installed, it\(aqs time to set
up the config for development. Typically Salt runs as \fBroot\fP, but you
can specify which user to run as. To configure that, just copy the
master and minion configs. We have .gitignore setup to ignore the
\fBlocal/\fP directory, so we can put all of our personal files there.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mkdir \-p local/etc/salt/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Create a master config file as \fBlocal/etc/salt/master\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cat <<EOF >local/etc/salt/master
user: $(whoami)
root_dir: $PWD/local/
publish_port: 55505
ret_port: 55506
EOF
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And a minion config as \fBlocal/etc/salt/minion\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cat <<EOF >local/etc/salt/minion
user: $(whoami)
root_dir: $PWD/local/
master: localhost
id: saltdev
master_port: 55506
EOF
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now you can start your Salt master and minion, specifying the config
dir.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-master \-\-config\-dir=local/etc/salt/ \-\-log\-level=debug \-\-daemon
salt\-minion \-\-config\-dir=local/etc/salt/ \-\-log\-level=debug \-\-daemon
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now you should be able to accept the minion key:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-c local/etc/salt \-Ay
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And check that your master/minion are communicating:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-c local/etc/salt \e* test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Rather than running \fBtest.version\fP from your master, you can run it
from the minion instead:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-call \-c local/etc/salt test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that you\(aqre running \fBsalt\-call\fP instead of \fBsalt\fP, and you\(aqre
not specifying the minion (\fB\e*\fP), but if you\(aqre running the dev
version then you still will need to pass in the config dir. Now that
you\(aqve got Salt running, you can hack away on the Salt codebase!
.sp
If you need to restart Salt for some reason, if you\(aqve made changes and
they don\(aqt appear to be reflected, this is one option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
kill \-INT $(pgrep salt\-master)
kill \-INT $(pgrep salt\-minion)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you\(aqd rather not use \fBkill\fP, you can have a couple of terminals
open with your salt virtualenv activated and omit the \fB\-\-daemon\fP
argument. Salt will run in the foreground, so you can just use ctrl+c to
quit.
.SS Test first? Test last? Test meaningfully!
.sp
You can write tests first or tests last, as long as your tests are
meaningful and complete! \fITypically\fP the best tests for Salt are going
to be unit tests. Testing is \fI\%a whole topic on its
own\fP,
But you may also want to write functional or integration tests. You\(aqll
find those in the \fBtests/\fP directory.
.sp
When you\(aqre thinking about tests to write, the most important thing to
keep in mind is, “What, exactly, am I testing?” When a test fails, you
should know:
.INDENT 0.0
.IP \(bu 2
What, specifically, failed?
.IP \(bu 2
Why did it fail?
.IP \(bu 2
As much as possible, what do I need to do to fix this failure?
.UNINDENT
.sp
If you can\(aqt answer those questions then you might need to refactor your
tests.
.sp
When you\(aqre running tests locally, you should make sure that if you
remove your code changes your tests are failing. If your tests \fIaren\(aqt\fP
failing when you haven\(aqt yet made changes, then it\(aqs possible that
you\(aqre testing the wrong thing.
.sp
But whether you adhere to TDD/BDD, or you write your code first and your
tests last, ensure that your tests are meaningful.
.SS Running tests
.sp
As previously mentioned, we use \fBnox\fP, and that\(aqs how we run our
tests. You should have it installed by this point but if not you can
install it with this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m pip install nox
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now you can run your tests:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m nox \-e \(dqtest\-3(coverage=False)\(dq \-\- tests/unit/cli/test_batch.py
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs a good idea to install
\fI\%espeak\fP or use \fBsay\fP on
Mac if you\(aqre running some long\-running tests. You can do something like
this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m nox \-e \(dqtest\-3(coverage=False)\(dq \-\- tests/unit/cli/test_batch.py; espeak \(dqTests done, woohoo!\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
That way you don\(aqt have to keep monitoring the actual test run.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python \-m nox \-e \(dqtest\-3(coverage=False)\(dq \-\- \-\-core\-tests
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can enable or disable test groups locally by passing their respected flag:
.INDENT 0.0
.IP \(bu 2
\-\-no\-fast\-tests \- Tests that are ~10s or faster. Fast tests make up ~75% of tests and can run in 10 to 20 minutes.
.IP \(bu 2
\-\-slow\-tests \- Tests that are ~10s or slower.
.IP \(bu 2
\-\-core\-tests \- Tests of any speed that test the root parts of salt.
.IP \(bu 2
\-\-flaky\-jail \- Test that need to be temporarily skipped.
.UNINDENT
.sp
In your PR, you can enable or disable test groups by setting a label.
All fast, slow, and core tests specified in the change file will always run.
.INDENT 0.0
.IP \(bu 2
test:no\-fast
.IP \(bu 2
test:core
.IP \(bu 2
test:slow
.IP \(bu 2
test:flaky\-jail
.UNINDENT
.SS Changelog and commit!
.sp
When you write your commit message you should use imperative style. Do
this:
.INDENT 0.0
.INDENT 3.5
Add frobnosticate capability
.UNINDENT
.UNINDENT
.sp
Don\(aqt do this:
.INDENT 0.0
.INDENT 3.5
Added frobnosticate capability
.UNINDENT
.UNINDENT
.sp
But that advice is backwards for the changelog. We follow the
\fI\%keepachangelog\fP approach for
our changelog, and use towncrier to generate it for each release. As a
contributor, all that means is that you need to add a file to the
\fBsalt/changelog\fP directory, using the \fB<issue #>.<type>\fP format. For
instance, if you fixed issue 123, you would do:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
echo \(dqMade sys.doc inform when no minions return\(dq > changelog/123.fixed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And that\(aqs all that would go into your file. When it comes to your
commit message, it\(aqs usually a good idea to add other information, such as
.INDENT 0.0
.IP \(bu 2
What does a reviewer need to know about the change that you made?
.IP \(bu 2
If someone isn\(aqt an expert in this area, what will they need to know?
.UNINDENT
.sp
This will also help you out, because when you go to create the PR it
will automatically insert the body of your commit messages.
.sp
See the \fI\%changelog\fP
docs for more information.
.SS Pull request time!
.sp
Once you\(aqve done all your dev work and tested locally, you should check
out our \fI\%PR
guidelines\fP\&.
After you read that page, it\(aqs time to \fI\%open a new
PR\fP\&. Fill out the PR
template \- you should have updated or created any necessary docs, and
written tests if you\(aqre providing a code change. When you submit your
PR, we have a suite of tests that will run across different platforms to
help ensure that no known bugs were introduced.
.SS Now what?
.sp
You\(aqve made your changes, added documentation, opened your PR, and have
passing tests… now what? When can you expect your code to be merged?
.sp
When you open your PR, a reviewer will get automatically assigned. If
your PR is submitted during the week you should be able to expect some
kind of communication within that business day. If your tests are
passing and we\(aqre not in a code freeze, ideally your code will be merged
that week or month. If you haven\(aqt heard from your assigned reviewer, ping them
on GitHub, \fI\%irc\fP, or Community Slack.
.sp
It\(aqs likely that your reviewer will leave some comments that need
addressing \- it may be a style change, or you forgot a changelog entry,
or need to update the docs. Maybe it\(aqs something more fundamental \-
perhaps you encountered the rare case where your PR has a much larger
scope than initially assumed.
.sp
Whatever the case, simply make the requested changes (or discuss why the
requests are incorrect), and push up your new commits. If your PR is
open for a significant period of time it may be worth rebasing your
changes on the most recent changes to Salt. If you need help, the
previously linked Git resources will be valuable.
.sp
But if, for whatever reason, you\(aqre not interested in driving your PR to
completion then just note that in your PR. Something like, “I\(aqm not
interested in writing docs/tests, I just wanted to provide this fix \-
someone else will need to complete this PR.” If you do that then we\(aqll
add a “Help Wanted” label and someone will be able to pick up the PR,
make the required changes, and it can eventually get merged in.
.sp
In any case, now that you have a PR open, congrats! You\(aqre a Salt
developer! You rock!
.SS Troubleshooting
.SS zmq.core.error.ZMQError
.sp
Once the minion starts, you may see an error like the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
::
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
zmq.core.error.ZMQError: ipc path \(dq/path/to/your/virtualenv/var/run/salt/minion/minion_event_7824dcbcfd7a8f6755939af70b96249f_pub.ipc\(dq is longer than 107 characters (sizeof(sockaddr_un.sun_path)).
.UNINDENT
.UNINDENT
.sp
This means that the path to the socket the minion is using is too long.
This is a system limitation, so the only workaround is to reduce the
length of this path. This can be done in a couple different ways:
.INDENT 0.0
.IP 1. 3
Create your virtualenv in a path that is short enough.
.IP 2. 3
Edit the :conf_minion:\fBsock_dir\fP minion config variable and reduce
its length. Remember that this path is relative to the value you set
in :conf_minion:\fBroot_dir\fP\&.
.UNINDENT
.sp
NOTE: The socket path is limited to 107 characters on Solaris and Linux,
and 103 characters on BSD\-based systems.
.SS No permissions to access ...
.sp
If you forget to pass your config path to any of the \fBsalt*\fP commands,
you might see
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
No permissions to access \(dq/var/log/salt/master\(dq, are you running as the
correct user?
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Just pass \fB\-c local/etc/salt\fP (or whatever you named it)
.SS File descriptor limit
.sp
You might need to raise your file descriptor limit. You can check it
with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ulimit \-n
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the value is less than 3072, you should increase it with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ulimit \-n 3072
# For c\-shell:
limit descriptors 3072
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Pygit2 or other dependency install fails
.sp
You may see some failure messages when installing requirements. You can
directly access your nox environment and possibly install pygit (or
other dependency) that way. When you run nox, you\(aqll see a message like
this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox > Re\-using existing virtual environment at .nox/pytest\-parametrized\-3\-crypto\-none\-transport\-zeromq\-coverage\-false.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For this, you would be able to install with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\&.nox/pytest\-parametrized\-3\-crypto\-none\-transport\-zeromq\-coverage\-false/bin/python \-m pip install pygit2
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Deprecating Code
.sp
Salt should remain backwards compatible, though sometimes, this backwards
compatibility needs to be broken because a specific feature and/or solution is
no longer necessary or required.  At first one might think, let me change this
code, it seems that it\(aqs not used anywhere else so it should be safe to remove.
Then, once there\(aqs a new release, users complain about functionality which was
removed and they where using it, etc. This should, at all costs, be avoided,
and, in these cases, \fIthat\fP specific code should be deprecated.
.sp
In order to give users enough time to migrate from the old code behavior to the
new behavior, the deprecation time frame should be carefully determined based
on the significance and complexity of the changes required by the user.
.sp
Salt feature releases are based on the Periodic Table. Any new features going
into the \fBmaster\fP branch will be named after the next element in the Periodic
Table. For example, Magnesium was the feature release name associated with the
\fBv3002\fP tag. At that point in time, any new features going into the
\fBmaster\fP branch, after \fBv3002\fP was tagged, were part of the Aluminium feature
release.
.sp
A deprecation warning should be in place for at least two major releases before
the deprecated code and its accompanying deprecation warning are removed.  More
time should be given for more complex changes.  For example, if the current
release under development is \fB3001\fP, the deprecated code and associated
warnings should remain in place and warn for at least \fBAluminium\fP\&.
.sp
To help in this deprecation task, salt provides
\fBsalt.utils.versions.warn_until\fP\&. The
idea behind this helper function is to show the deprecation warning to the user
until salt reaches the provided version. Once that provided version is equaled
\fBsalt.utils.versions.warn_until\fP will
raise a \fI\%RuntimeError\fP making salt stop its execution. This stoppage is
unpleasant and will remind the developer that the deprecation limit has been
reached and that the code can then be safely removed.
.sp
Consider the following example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def some_function(bar=False, foo=None):
    if foo is not None:
        salt.utils.versions.warn_until(
            \(dqAluminium\(dq,
            \(dqThe \(aqfoo\(aq argument has been deprecated and its \(dq
            \(dqfunctionality removed, as such, its usage is no longer \(dq
            \(dqrequired.\(dq,
        )
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Development begins on \fBAluminium\fP, or \fBv3003\fP, after the \fBv3002\fP tag is
applied to the \fBmaster\fP branch.  Once this occurs, all uses of the
\fBwarn_until\fP function targeting \fBAluminium\fP, along with the code they are
warning about should be removed from the code.
.SS Silence Deprecation Warnings
.sp
If you set the \fIPYTHONWARNINGS\fP environment variable to \fIignore\fP Salt will
not print the deprecation warnings.
.SS Python 2 Deprecation FAQ
.SS FAQ
.INDENT 0.0
.IP \(bu 2
\fI\%Python 2 Deprecation FAQ\fP
.INDENT 2.0
.IP \(bu 2
\fI\%Why are we deprecating Python 2?\fP
.IP \(bu 2
\fI\%Was this announced/decided before making the change?\fP
.IP \(bu 2
\fI\%Can I contribute Python 2 code?\fP
.IP \(bu 2
\fI\%What if my OS does not include Python 3 packages? Or, how do I upgrade from Salt on Python 2 to Salt on Python 3?\fP
.INDENT 2.0
.IP \(bu 2
\fI\%On Modern Platforms\fP
.IP \(bu 2
\fI\%On Other Platforms\fP
.INDENT 2.0
.IP \(bu 2
\fI\%Build Your Own\fP
.IP \(bu 2
\fI\%pop\-build distributions\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
\fI\%Will you support a Python 3 master with an older Python 2 minion?\fP
.IP \(bu 2
\fI\%Will you support Python 2 master with a new Python 3 minion?\fP
.IP \(bu 2
\fI\%How does this impact Salt\-SSH support?\fP
.IP \(bu 2
\fI\%What is your plan for removing Python 2 code?\fP
.IP \(bu 2
\fI\%Will Salt continue to package for Python 2?\fP
.UNINDENT
.UNINDENT
.SS Why are we deprecating Python 2?
.sp
Python 2.7.18 was the final release of Python2, released in April 2020.
At this point, Python 2 will no longer receive any unpaid support. The
Python core developers are focusing their efforts on improving and
enhancing Python 3. Additionally, many libraries that Salt depends on
have also dropped Python 2 support.
.sp
To take advantage of continued support and improvements, Salt is joining
the ranks of projects that are dropping legacy Python support in favor
of Python 3.
.SS Was this announced/decided before making the change?
.sp
\fI\%SEP
5\fP
was approved in April, 2019.
.SS Can I contribute Python 2 code?
.sp
For several years, Salt has been a Python 2/3 codebase, requiring Python
3 support for all contributions. The only changes contributors can
expect to this process is that we will now accept Python 3\-only code
changes.
.sp
While there \fIis\fP a significant subset of Python that is compatible with
both Python 3 and legacy Python, changes requiring \fBsix\fP or otherwise
removing Python 3\-only code will not be accepted.
.SS What if my OS does not include Python 3 packages? Or, how do I upgrade from Salt on Python 2 to Salt on Python 3?
.sp
There are several options to upgrade to Python 3.
.SS On Modern Platforms
.sp
At this point, most modern Linux distributions have Python 3 packages.
Ubuntu 20.04 LTS has moved to Python 3.8 as it’s default system Python.
.SS On Other Platforms
.SS Build Your Own
.sp
If your current distribution does not have Python 3 it’s \fI\%pretty simple
to use Salt\fP to build
and distribute Python 3 on your own. Installing Python 3 and pip
installing Salt gives you the most control over your distribution.
.SS \fBpop\-build\fP distributions
.sp
Another approach is to use the \fBpop\-build\fP distribution of Salt. With
the Sodium release we will begin releasing packages for Salt using
\fBpop\-build\fP, in tandem with our normal build process. The
\fBpop\-build\fP distribution will contain Salt, Python, and any necessary
dependencies, which will make it trivial to have a completely supported
version of Salt.
.SS Will you support a Python 3 master with an older Python 2 minion?
.sp
Yes! Our policy of keeping newer masters backwards compatible with \fIat
least\fP the most recent minion version is not changing. You should be
able to run modern Salt Masters on Python 3 with slightly older minions
running on legacy Python. Of course, if you want your minions to be able
to take advantage of the newest features in Salt, upgrading to Python 3
will be necessary.
.SS Will you support Python 2 master with a new Python 3 minion?
.sp
In keeping with our existing policy, we make no guarantees about older
masters with newer minions. It \fImay\fP work, but breakages are common and
should be expected.
.SS How does this impact Salt\-SSH support?
.sp
Salt\-SSH will need Python 3 on the target minions. We will be upgrading
Salt\-SSH to provide instructions or recommendations on adding Python3 if
it is not detected.
.SS What is your plan for removing Python 2 code?
.sp
Legacy Python code will be gradually removed from the Salt codebase.
.sp
While we could remove most of it at once, that introduces a high level
of risk. Instead, beginning with the Sodium (v3001) release, Salt will
simply drop support for Python 2. PRs will no longer be required to
support Python 2 before merging.
.sp
Over time, as modules are changed, \fBsix\fP and other legacy Python
syntax will be removed. It may be at some point in the future it becomes
necessary to remove the last vestiges of legacy Python from Salt, but
currently the plan is to take a more measured approach.
.SS Will Salt continue to package for Python 2?
.sp
No.\ Beginning with Sodium (v3001), Salt will no longer release packages
for, or support Python 2.
.SS Installing Salt for development
.sp
Clone the repository using:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git clone https://github.com/saltstack/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
tags
.sp
Just cloning the repository is enough to work with Salt and make
contributions. However, fetching additional tags from git is required to
have Salt report the correct version for itself. To do this, first
add the git repository as an upstream source:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git remote add upstream https://github.com/saltstack/salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Fetching tags is done with the git \(aqfetch\(aq utility:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git fetch \-\-tags upstream
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Create a new \fI\%virtualenv\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
virtualenv /path/to/your/virtualenv
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Avoid making your \fI\%virtualenv path too long\fP\&.
.sp
On Arch Linux, where Python 3 is the default installation of Python, use
the \fBvirtualenv2\fP command instead of \fBvirtualenv\fP\&.
.sp
On Gentoo you must use \fB\-\-system\-site\-packages\fP to enable pkg and portage_config
functionality
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Using system Python modules in the virtualenv
.sp
To use already\-installed python modules in virtualenv (instead of having pip
download and compile new ones), run \fBvirtualenv \-\-system\-site\-packages\fP
Using this method eliminates the requirement to install the salt dependencies
again, although it does assume that the listed modules are all installed in the
system PYTHONPATH at the time of virtualenv creation.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Python development package
.sp
Be sure to install python devel package in order to install required Python
modules. In Debian/Ubuntu run \fBsudo apt\-get install \-y python\-dev\fP\&. In RedHat
based system install \fBpython\-devel\fP
.UNINDENT
.UNINDENT
.sp
Activate the virtualenv:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
source /path/to/your/virtualenv/bin/activate
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Install Salt (and dependencies) into the virtualenv:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install pyzmq PyYAML pycrypto msgpack jinja2 psutil futures tornado
pip install \-e ./salt   # the path to the salt git clone from above
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Installing psutil
.sp
Python header files are required to build this module, otherwise the pip
install will fail. If your distribution separates binaries and headers into
separate packages, make sure that you have the headers installed. In most
Linux distributions which split the headers into their own package, this
can be done by installing the \fBpython\-dev\fP or \fBpython\-devel\fP package.
For other platforms, the package will likely be similarly named.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Installing dependencies on macOS.
.sp
You can install needed dependencies on macOS using homebrew or macports.
See the
\fI\%Salt install guide\fP
for more information.
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Installing on RedHat\-based Distros
.sp
If installing from pip (or from source using \fBsetup.py install\fP), be
advised that the \fByum\-utils\fP package is needed for Salt to manage
packages on RedHat\-based systems.
.UNINDENT
.UNINDENT
.SS Running a self\-contained development version
.sp
During development it is easiest to be able to run the Salt master and minion
that are installed in the virtualenv you created above, and also to have all
the configuration, log, and cache files contained in the virtualenv as well.
.sp
The \fB/path/to/your/virtualenv\fP referenced multiple times below is also
available in the variable \fB$VIRTUAL_ENV\fP once the virtual environment is
activated.
.sp
Copy the master and minion config files into your virtualenv:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mkdir \-p /path/to/your/virtualenv/etc/salt/pki/{master,minion}
cp ./salt/conf/master ./salt/conf/minion /path/to/your/virtualenv/etc/salt/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Edit the master config file:
.INDENT 0.0
.IP 1. 3
Uncomment and change the \fBuser: root\fP value to your own user.
.IP 2. 3
Uncomment and change the \fBroot_dir: /\fP value to point to
\fB/path/to/your/virtualenv\fP\&.
.IP 3. 3
Uncomment and change the \fBpki_dir: /etc/salt/pki/master\fP value to point to
\fB/path/to/your/virtualenv/etc/salt/pki/master\fP
.IP 4. 3
If you are running version 0.11.1 or older, uncomment, and change the
\fBpidfile: /var/run/salt\-master.pid\fP value to point to
\fB/path/to/your/virtualenv/salt\-master.pid\fP\&.
.IP 5. 3
If you are also running a non\-development version of Salt you will have to
change the \fBpublish_port\fP and \fBret_port\fP values as well.
.UNINDENT
.sp
Edit the minion config file:
.INDENT 0.0
.IP 1. 3
Repeat the edits you made in the master config for the \fBuser\fP and
\fBroot_dir\fP values as well as any port changes.
.IP 2. 3
Uncomment and change the \fBpki_dir: /etc/salt/pki/minion\fP value to point to
\fB/path/to/your/virtualenv/etc/salt/pki/minion\fP
.IP 3. 3
If you are running version 0.11.1 or older, uncomment, and change the
\fBpidfile: /var/run/salt\-minion.pid\fP value to point to
\fB/path/to/your/virtualenv/salt\-minion.pid\fP\&.
.IP 4. 3
Uncomment and change the \fBmaster: salt\fP value to point at \fBlocalhost\fP\&.
.IP 5. 3
Uncomment and change the \fBid:\fP value to something descriptive like
\(dqsaltdev\(dq. This isn\(aqt strictly necessary but it will serve as a reminder of
which Salt installation you are working with.
.IP 6. 3
If you changed the \fBret_port\fP value in the master config because you are
also running a non\-development version of Salt, then you will have to
change the \fBmaster_port\fP value in the minion config to match.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Using \fIsalt\-call\fP with a \fI\%Standalone Minion\fP
.sp
If you plan to run \fIsalt\-call\fP with this self\-contained development
environment in a masterless setup, you should invoke \fIsalt\-call\fP with
\fB\-c /path/to/your/virtualenv/etc/salt\fP so that salt can find the minion
config file. Without the \fB\-c\fP option, Salt finds its config files in
\fI/etc/salt\fP\&.
.UNINDENT
.UNINDENT
.sp
Start the master and minion, accept the minion\(aqs key, and verify your local Salt
installation is working:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cd /path/to/your/virtualenv
salt\-master \-c ./etc/salt \-d
salt\-minion \-c ./etc/salt \-d
salt\-key \-c ./etc/salt \-L
salt\-key \-c ./etc/salt \-A
salt \-c ./etc/salt \(aq*\(aq test.version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Running the master and minion in debug mode can be helpful when developing. To
do this, add \fB\-l debug\fP to the calls to \fBsalt\-master\fP and \fBsalt\-minion\fP\&.
If you would like to log to the console instead of to the log file, remove the
\fB\-d\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Too long socket path?
.sp
Once the minion starts, you may see an error like the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
zmq.core.error.ZMQError: ipc path \(dq/path/to/your/virtualenv/
var/run/salt/minion/minion_event_7824dcbcfd7a8f6755939af70b96249f_pub.ipc\(dq
is longer than 107 characters (sizeof(sockaddr_un.sun_path)).
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This means that the path to the socket the minion is using is too long. This is
a system limitation, so the only workaround is to reduce the length of this
path. This can be done in a couple different ways:
.INDENT 0.0
.IP 1. 3
Create your virtualenv in a path that is short enough.
.IP 2. 3
Edit the \fI\%sock_dir\fP minion config variable and reduce its
length. Remember that this path is relative to the value you set in
\fI\%root_dir\fP\&.
.UNINDENT
.sp
\fBNOTE:\fP The socket path is limited to 107 characters on Solaris and Linux,
and 103 characters on BSD\-based systems.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
File descriptor limits
.sp
Ensure that the system open file limit is raised to at least 2047:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# check your current limit
ulimit \-n

# raise the limit. persists only until reboot
# use \(aqlimit descriptors 2047\(aq for c\-shell
ulimit \-n 2047
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To set file descriptors on macOS, see the
\fI\%Salt install guide\fP
instructions for macOS.
.UNINDENT
.UNINDENT
.SS Changing Default Paths
.sp
Instead of updating your configuration files to point to the new root directory
and having to pass the new configuration directory path to all of Salt\(aqs CLI
tools, you can explicitly tweak the default system paths that Salt expects:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
GENERATE_SALT_SYSPATHS=1 pip install \-\-global\-option=\(aq\-\-salt\-root\-dir=/path/to/your/virtualenv/\(aq \e
    \-e ./salt   # the path to the salt git clone from above
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can now call all of Salt\(aqs CLI tools without explicitly passing the configuration directory.
.SS Additional Options
.sp
If you want to distribute your virtualenv, you probably don\(aqt want to include
Salt\(aqs clone \fB\&.git/\fP directory, and, without it, Salt won\(aqt report the
accurate version. You can tell \fBsetup.py\fP to generate the hardcoded version
information which is distributable:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
GENERATE_SALT_SYSPATHS=1 WRITE_SALT_VERSION=1 pip install \-\-global\-option=\(aq\-\-salt\-root\-dir=/path/to/your/virtualenv/\(aq \e
    \-e ./salt   # the path to the salt git clone from above
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Instead of passing those two environmental variables, you can just pass a
single one which will trigger the other two:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
MIMIC_SALT_INSTALL=1 pip install \-\-global\-option=\(aq\-\-salt\-root\-dir=/path/to/your/virtualenv/\(aq \e
    \-e ./salt   # the path to the salt git clone from above
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This last one will grant you an editable salt installation with hardcoded
system paths and version information.
.SS Installing Salt from the Python Package Index
.sp
If you are installing using \fBeasy_install\fP, you will need to define a
\fBUSE_SETUPTOOLS\fP environment variable, otherwise dependencies will not
be installed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
USE_SETUPTOOLS=1 easy_install salt
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Editing and previewing the documentation
.sp
You need \fBsphinx\-build\fP command to build the docs. In Debian/Ubuntu this is
provided in the \fBpython\-sphinx\fP package. Sphinx can also be installed
to a virtualenv using pip:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install Sphinx==1.3.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Change to salt documentation directory, then:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cd doc; make html
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
This will build the HTML docs. Run \fBmake\fP without any arguments to see the
available make targets, which include \fBhtml\fP, \fBman\fP, and
\fBtext\fP\&.
.IP \(bu 2
The docs then are built within the \fBdocs/_build/\fP folder. To update
the docs after making changes, run \fBmake\fP again.
.IP \(bu 2
The docs use \fI\%reStructuredText\fP
for markup.
See a live demo at \fI\%http://rst.ninjs.org/\fP\&.
.IP \(bu 2
The help information on each module or state is culled from the python code
that runs for that piece. Find them in \fBsalt/modules/\fP or \fBsalt/states/\fP\&.
.IP \(bu 2
To build the docs on Arch Linux, the \fBpython2\-sphinx\fP package is
required. Additionally, it is necessary to tell \fBmake\fP where to find
the proper \fBsphinx\-build\fP binary, like so:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
make SPHINXBUILD=sphinx\-build2 html
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
To build the docs on RHEL/CentOS 6, the \fBpython\-sphinx10\fP package
must be installed from EPEL, and the following make command must be used:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
make SPHINXBUILD=sphinx\-build html
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once you\(aqve updated the documentation, you can run the following command to
launch a simple Python HTTP server to see your changes:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cd _build/html; python \-m SimpleHTTPServer
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Running unit and integration tests
.sp
Run the test suite with following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\&./setup.py test
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See \fI\%here\fP for more information regarding the test suite.
.SS Issue and Pull Request Labeling System
.sp
SaltStack uses several labeling schemes to help facilitate code contributions
and bug resolution. See the \fI\%Labels and Milestones\fP documentation for more information.
.SS GitHub Labels and Milestones
.sp
SaltStack uses several label categories, as well as milestones, to triage
incoming issues and pull requests in the GitHub issue tracker.  Labels are used
to sort issues by type, priority, severity, status, functional area, functional
group, and targeted release and pull requests by status, functional area,
functional group, type of change, and test status.  Milestones are used to
indicate whether an issue is fully triaged or is scheduled to be fixed by
SaltStack in an upcoming sprint.
.SS Milestones
.sp
All issues are assigned to a milestone, whereas pull requests are almost never
assigned to a milestone as the mean lifetime of pull requests is short enough
that there is no need to track them temporally.
.sp
SaltStack uses milestones to indicate which issues are blocked on submitter or
upstream actions, are approved, or are scheduled to be fixed or implemented in
an upcoming sprint.  If an issue is not attached to a sprint milestone, you are
welcome to work on it at your own desire and convenience.  If it is attached to
a sprint milestone and you have already begun working on it or have a solution
in mind or have other ideas related to the issue, you are encouraged to
coordinate with the assignee via the GitHub issue tracker to create the best
possible solution or implementation.
.INDENT 0.0
.IP \(bu 2
\fBApproved\fP \- The issue has been validated and has all necessary information.
.IP \(bu 2
\fBBlocked\fP \- The issue is waiting on actions by parties outside of
SaltStack, such as receiving more information from the submitter or
resolution of an upstream issue. This milestone is usually applied in
conjunction with the labels \fBInfo Needed\fP, \fBQuestion\fP,
\fBExpected Behavior\fP, \fBWon\(aqt Fix For Now\fP, or \fBUpstream Bug\fP\&.
.UNINDENT
.SS Labels
.sp
Labels are used to sort and describe issues and pull requests.  Some labels are
usually reserved for one or the other, though most labels may be applied to
both.
.sp
New issues will receive at least one label and a milestone, and new pull
requests will receive at least one label.  Except for the \fI\%functional area\fP and \fI\%functional group\fP
label categories, issues will generally receive only up to one label per
category.
.SS Type
.sp
Issues are categorized into one of several types.  Type labels are almost never
used for pull requests.  GitHub treats pull requests like issues in many ways,
so a pull request could be considered an issue with an implicit \fBPull
Request\fP type label applied.
.INDENT 0.0
.IP \(bu 2
\fBFeature\fP \- The issue is a request for new functionality including changes,
enhancements, refactors, etc.
.IP \(bu 2
\fBBug\fP \- The issue documents broken, incorrect, or confusing behavior.  This
label is always accompanied by a \fI\%severity label\fP\&.
.IP \(bu 2
\fBDuplicate\fP \- The issue is a duplicate of another feature request or bug
report.
.IP \(bu 2
\fBUpstream Bug\fP \- The issue is a result of an upstream issue.
.IP \(bu 2
\fBQuestion\fP \- The issue is more of a question than a request for new
features or a report of broken features, but can sometimes lead to further
discussion or changes of confusing or incongruous behavior or documentation.
.IP \(bu 2
\fBExpected Behavior\fP \- The issue is a bug report of intended functionality.
.UNINDENT
.SS Priority
.sp
An issue\(aqs priority is relative to its \fI\%functional area\fP\&.  If a bug report, for example, about \fBgitfs\fP
indicates that all users of \fBgitfs\fP will encounter this bug, then a \fBP1\fP
label will be applied, even though users who are not using \fBgitfs\fP will not
encounter the bug.  If a feature is requested by many users, it may be given a
high priority.
.INDENT 0.0
.IP \(bu 2
\fBP1\fP \- The issue will be seen by all users.
.IP \(bu 2
\fBP2\fP \- The issue will be seen by most users.
.IP \(bu 2
\fBP3\fP \- The issue will be seen by about half of users.
.IP \(bu 2
\fBP4\fP \- The issue will not be seen by most users.  Usually the issue is a
very specific use case or corner case.
.UNINDENT
.SS Severity
.sp
Severity labels are almost always only applied to issues labeled \fBBug\fP\&.
.INDENT 0.0
.IP \(bu 2
\fBBlocker\fP \- The issue is blocking an impending release.
.IP \(bu 2
\fBCritical\fP \- The issue causes data loss, crashes or hangs salt processes,
makes the system unresponsive, etc.
.IP \(bu 2
\fBHigh Severity\fP \- The issue reports incorrect functionality, bad
functionality, a confusing user experience, etc.
.IP \(bu 2
\fBMedium Severity\fP \- The issue reports cosmetic items, formatting, spelling,
colors, etc.
.UNINDENT
.SS Functional Area
.sp
Many major components of Salt have corresponding GitHub labels.  These labels
are applied to all issues and pull requests as is reasonably appropriate.  They
are useful in organizing issues and pull requests according to the source code
relevant to issues or the source code changed by pull requests.
.INDENT 0.0
.IP \(bu 2
\fBExecution Module\fP
.IP \(bu 2
\fBFile Servers\fP
.IP \(bu 2
\fBGrains\fP
.IP \(bu 2
\fBMulti\-Master\fP
.IP \(bu 2
\fBPackaging\fP  Related to packaging of Salt, not Salt\(aqs support for package management.
.IP \(bu 2
\fBPillar\fP
.IP \(bu 2
\fBRAET\fP
.IP \(bu 2
\fBReturners\fP
.IP \(bu 2
\fBRunners\fP
.IP \(bu 2
\fBSPM\fP
.IP \(bu 2
\fBSalt\-API\fP
.IP \(bu 2
\fBSalt\-Cloud\fP
.IP \(bu 2
\fBSalt\-SSH\fP
.IP \(bu 2
\fBSalt\-Syndic\fP
.IP \(bu 2
\fBState Module\fP
.IP \(bu 2
\fBTests\fP
.IP \(bu 2
\fBTransport\fP
.IP \(bu 2
\fBWindows\fP
.IP \(bu 2
\fBZMQ\fP
.UNINDENT
.SS Functional Group
.sp
These labels sort issues and pull requests according to the internal SaltStack
engineering teams.
.INDENT 0.0
.IP \(bu 2
\fBCore\fP \- The issue or pull request relates to code that is central or
existential to Salt itself.
.IP \(bu 2
\fBPlatform\fP \- The issue or pull request relates to support and integration
with various platforms like traditional operating systems as well as
containers, platform\-based utilities like filesystems, command schedulers,
etc., and system\-based applications like webservers, databases, etc.
.IP \(bu 2
\fBRIoT\fP \- The issue or pull request relates to support and integration with
various abstract systems like cloud providers, hypervisors, API\-based
services, etc.
.IP \(bu 2
\fBConsole\fP \- The issue or pull request relates to the SaltStack enterprise
console.
.IP \(bu 2
\fBDocumentation\fP \- The issue or pull request relates to documentation.
.UNINDENT
.SS Status
.sp
Status labels are used to define and track the state of issues and pull
requests.  Not all potential statuses correspond to a label, but some statuses
are common enough that labels have been created for them.  If an issue has not
been moved beyond the \fBBlocked\fP milestone, it is very likely that it will
only have a status label.
.INDENT 0.0
.IP \(bu 2
\fBCannot Reproduce\fP \- The issue is a bug and has been reviewed by a
SaltStack engineer, but it cannot be replicated with the provided information
and context.  Those involved with the bug will need to work through
additional ideas until the bug can be isolated and verified.
.IP \(bu 2
\fBConfirmed\fP \- The issue is a bug and has been confirmed by a SaltStack
engineer, who often documents a minimal working example that reproduces the
bug.
.IP \(bu 2
\fBFixed Pending Verification\fP \- The issue is a bug and has been fixed by one
or more pull requests, which should link to the issue.  Closure of the issue
is contingent upon confirmation of resolution from the submitter.  If the
submitter reports a negative confirmation, this label is removed.  If no
response is given after a few weeks, then the issue will be assumed fixed and
closed.
.IP \(bu 2
\fBInfo Needed\fP \- The issue needs more information before it can be verified
and resolved.  For a feature request this may include a description of the
use cases.  Almost all bug reports need to include at least the versions of
salt and its dependencies, the system type and version, commands used, debug
logs, error messages, and relevant configs.
.IP \(bu 2
\fBPending Changes\fP \- The pull request needs additional changes before it can
be merged.
.IP \(bu 2
\fBPending Discussion\fP \- The issue or pull request needs more discussion
before it can be closed or merged.  The status of the issue or pull request
is not clear or apparent enough for definite action to be taken, or
additional input from SaltStack, the submitter, or another party has been
requested.
.sp
If the issue is not a pull request, once the discussion has arrived at a
cogent conclusion, this label will be removed and the issue will be accepted.
If it is a pull request, the results of the discussion may require additional
changes and thus, a \fBPending Changes\fP label.
.IP \(bu 2
\fBwon\(aqt\-fix\fP \- The issue is legitimate, but it is not something the
Salt core team is currently able or willing to fix or implement.  Issues
having this label may be revisited in the future, or solved by a Salt
community member.
.UNINDENT
.SS Test Status
.sp
These labels relate to the status of the automated tests that run on pull
requests.
.INDENT 0.0
.IP \(bu 2
\fBhas\-failing\-test\fP \- The PR currently has one or more failing tests that
prevent the PR from being merged.
.IP \(bu 2
\fBNeeds Testcase\fP \- The PR has code changes, but lack any automated tests.
These PRs need automated tests written before they may be merged.
.UNINDENT
.SS Other
.sp
These labels indicate miscellaneous issue types or statuses that are common or
important enough to be tracked and sorted with labels.
.INDENT 0.0
.IP \(bu 2
\fBAwesome\fP \- The pull request implements an especially well crafted
solution, or a very difficult but necessary change.
.IP \(bu 2
\fBHelp Wanted\fP \- The issue appears to have a simple solution.  Issues having
this label should be a good starting place for new contributors to Salt.
.IP \(bu 2
\fBRegression\fP \- The issue is a bug that breaks functionality known to work
in previous releases.
.IP \(bu 2
\fBStory\fP \- The issue is used by a SaltStack engineer to track progress on
multiple related issues in a single place.
.IP \(bu 2
\fBStretch\fP \- The issue is an optional goal for the current sprint but may
not be delivered.
.IP \(bu 2
\fBZD\fP \- The issue is related to a Zendesk customer support ticket.
.IP \(bu 2
\fB<Release>\fP \- The issue is scheduled to be implemented by \fB<Release>\fP\&.
See \fI\%here\fP for a discussion of Salt\(aqs release
codenames.
.UNINDENT
.SS Logging Internals
.sp
TODO
.SS Package Providers
.sp
This page contains guidelines for writing package providers.
.SS Package Functions
.sp
One of the most important features of Salt is package management. There is no
shortage of package managers, so in the interest of providing a consistent
experience in \fI\%pkg\fP states, there are certain functions
that should be present in a package provider. Note that these are subject to
change as new features are added or existing features are enhanced.
.SS list_pkgs
.sp
This function should declare an empty dict, and then add packages to it by
calling \fI\%pkg_resource.add_pkg\fP, like
so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__salt__[\(dqpkg_resource.add_pkg\(dq](ret, name, version)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The last thing that should be done before returning is to execute
\fI\%pkg_resource.sort_pkglist\fP\&. This
function does not presently do anything to the return dict, but will be used in
future versions of Salt.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__salt__[\(dqpkg_resource.sort_pkglist\(dq](ret)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBlist_pkgs\fP returns a dictionary of installed packages, with the keys being
the package names and the values being the version installed. Example return
data:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqfoo\(dq: \(dq1.2.3\-4\(dq, \(dqbar\(dq: \(dq5.6.7\-8\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS latest_version
.sp
Accepts an arbitrary number of arguments. Each argument is a package name. The
return value for a package will be an empty string if the package is not found
or if the package is up\-to\-date. The only case in which a non\-empty string is
returned is if the package is available for new installation (i.e. not already
installed) or if there is an upgrade available.
.sp
If only one argument was passed, this function return a string, otherwise a
dict of name/version pairs is returned.
.sp
This function must also accept \fB**kwargs\fP, in order to receive the
\fBfromrepo\fP and \fBrepo\fP keyword arguments from pkg states. Where supported,
these arguments should be used to find the install/upgrade candidate in the
specified repository. The \fBfromrepo\fP kwarg takes precedence over \fBrepo\fP, so
if both of those kwargs are present, the repository specified in \fBfromrepo\fP
should be used. However, if \fBrepo\fP is used instead of \fBfromrepo\fP, it should
still work, to preserve backwards compatibility with older versions of Salt.
.SS version
.sp
Like \fBlatest_version\fP, accepts an arbitrary number of arguments and
returns a string if a single package name was passed, or a dict of name/value
pairs if more than one was passed. The only difference is that the return
values are the currently\-installed versions of whatever packages are passed. If
the package is not installed, an empty string is returned for that package.
.SS upgrade_available
.sp
Deprecated and destined to be removed. For now, should just do the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def myfunc():
    return __salt__[\(dqpkg.latest_version\(dq](name) != \(dq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS install
.sp
The following arguments are required and should default to \fBNone\fP:
.INDENT 0.0
.IP 1. 3
name (for single\-package pkg states)
.IP 2. 3
pkgs (for multiple\-package pkg states)
.IP 3. 3
sources (for binary package file installation)
.UNINDENT
.sp
The first thing that this function should do is call
\fI\%pkg_resource.parse_targets\fP
(see below). This function will convert the SLS input into a more easily parsed
data structure.
\fI\%pkg_resource.parse_targets\fP may
need to be modified to support your new package provider, as it does things
like parsing package metadata which cannot be done for every package management
system.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pkg_params, pkg_type = __salt__[\(dqpkg_resource.parse_targets\(dq](name, pkgs, sources)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Two values will be returned to the \fBinstall\fP function. The first of
them will be a dictionary. The keys of this dictionary will be package names,
though the values will differ depending on what kind of installation is being
done:
.INDENT 0.0
.IP \(bu 2
If \fBname\fP was provided (and \fBpkgs\fP was not), then there will
be a single key in the dictionary, and its value will be \fBNone\fP\&. Once the
data has been returned, if the \fBversion\fP keyword argument was
provided, then it should replace the \fBNone\fP value in the dictionary.
.IP \(bu 2
If \fBpkgs\fP was provided, then \fBname\fP is ignored, and the
dictionary will contain one entry for each package in the \fBpkgs\fP
list. The values in the dictionary will be \fBNone\fP if a version was not
specified for the package, and the desired version if specified. See the
\fBMultiple Package Installation Options\fP section of the
\fI\%pkg.installed\fP state for more info.
.IP \(bu 2
If \fBsources\fP was provided, then \fBname\fP is ignored, and the
dictionary values will be the path/URI for the package.
.UNINDENT
.sp
The second return value will be a string with two possible values:
\fBrepository\fP or \fBfile\fP\&. The \fBinstall\fP function can use this value
(if necessary) to build the proper command to install the targeted package(s).
.sp
Both before and after the installing the target(s), you should run
\fBlist_pkgs\fP to obtain a list of the installed packages. You should then
return the output of \fBsalt.utils.data.compare_dicts()\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def myfunc():
    return salt.utils.data.compare_dicts(old, new)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS remove
.sp
Removes the passed package and return a list of the packages removed.
.SS Package Repo Functions
.sp
There are some functions provided by \fBpkg\fP which are specific to package
repositories, and not to packages themselves. When writing modules for new
package managers, these functions should be made available as stated below, in
order to provide compatibility with the \fBpkgrepo\fP state.
.sp
All repo functions should accept a basedir option, which defines which
directory repository configuration should be found in. The default for this
is dictated by the repo manager that is being used, and rarely needs to be
changed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
basedir = \(dq/etc/yum.repos.d\(dq
__salt__[\(dqpkg.list_repos\(dq](basedir)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS list_repos
.sp
Lists the repositories that are currently configured on this system.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__salt__[\(dqpkg.list_repos\(dq]()
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Returns a dictionary, in the following format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqreponame\(aq: \(aqconfig_key_1\(aq: \(aqconfig value 1\(aq,
             \(aqconfig_key_2\(aq: \(aqconfig value 2\(aq,
             \(aqconfig_key_3\(aq: [\(aqlist item 1 (when appropriate)\(aq,
                              \(aqlist item 2 (when appropriate)]}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS get_repo
.sp
Displays all local configuration for a specific repository.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__salt__[\(dqpkg.get_repo\(dq](repo=\(dqmyrepo\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The information is formatted in much the same way as list_repos, but is
specific to only one repo.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(aqconfig_key_1\(aq: \(aqconfig value 1\(aq,
 \(aqconfig_key_2\(aq: \(aqconfig value 2\(aq,
 \(aqconfig_key_3\(aq: [\(aqlist item 1 (when appropriate)\(aq,
                  \(aqlist item 2 (when appropriate)]}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS del_repo
.sp
Removes the local configuration for a specific repository. Requires a \fIrepo\fP
argument, which must match the locally configured name. This function returns
a string, which informs the user as to whether or not the operation was a
success.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__salt__[\(dqpkg.del_repo\(dq](repo=\(dqmyrepo\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS mod_repo
.sp
Modify the local configuration for one or more option for a configured repo.
This is also the way to create new repository configuration on the local
system; if a repo is specified which does not yet exist, it will be created.
.sp
The options specified for this function are specific to the system; please
refer to the documentation for your specific repo manager for specifics.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__salt__[\(dqpkg.mod_repo\(dq](repo=\(dqmyrepo\(dq, url=\(dqhttp://myurl.com/repo\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Low\-Package Functions
.sp
In general, the standard package functions as describes above will meet your
needs. These functions use the system\(aqs native repo manager (for instance,
yum or the apt tools). In most cases, the repo manager is actually separate
from the package manager. For instance, yum is usually a front\-end for rpm, and
apt is usually a front\-end for dpkg. When possible, the package functions that
use those package managers directly should do so through the low package
functions.
.sp
It is normal and sane for \fBpkg\fP to make calls to \fBlowpkgs\fP, but \fBlowpkg\fP
must never make calls to \fBpkg\fP\&. This is affects functions which are required
by both \fBpkg\fP and \fBlowpkg\fP, but the technique in \fBpkg\fP is more performant
than what is available to \fBlowpkg\fP\&. When this is the case, the \fBlowpkg\fP
function that requires that technique must still use the \fBlowpkg\fP version.
.SS list_pkgs
.sp
Returns a dict of packages installed, including the package name and version.
Can accept a list of packages; if none are specified, then all installed
packages will be listed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
installed = __salt__[\(dqlowpkg.list_pkgs\(dq](\(dqfoo\(dq, \(dqbar\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{\(dqfoo\(dq: \(dq1.2.3\-4\(dq, \(dqbar\(dq: \(dq5.6.7\-8\(dq}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS verify
.sp
Many (but not all) package management systems provide a way to verify that the
files installed by the package manager have or have not changed. This function
accepts a list of packages; if none are specified, all packages will be
included.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
installed = __salt__[\(dqlowpkg.verify\(dq](\(dqhttpd\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dq/etc/httpd/conf/httpd.conf\(dq: {
        \(dqmismatch\(dq: [\(dqsize\(dq, \(dqmd5sum\(dq, \(dqmtime\(dq],
        \(dqtype\(dq: \(dqconfig\(dq,
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS file_list
.sp
Lists all of the files installed by all packages specified. If not packages are
specified, then all files for all known packages are returned.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
installed = __salt__[\(dqlowpkg.file_list\(dq](\(dqhttpd\(dq, \(dqapache\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This function does not return which files belong to which packages; all files
are returned as one giant list (hence the \fIfile_list\fP function name. However,
This information is still returned inside of a dict, so that it can provide
any errors to the user in a sane manner.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqerrors\(dq: [\(dqpackage apache is not installed\(dq],
    \(dqfiles\(dq: [\(dq/etc/httpd\(dq, \(dq/etc/httpd/conf\(dq, \(dq/etc/httpd/conf.d\(dq, \(dq...SNIP...\(dq],
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS file_dict
.sp
Lists all of the files installed by all packages specified. If not packages are
specified, then all files for all known packages are returned.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
installed = __salt__[\(dqlowpkg.file_dict\(dq](\(dqhttpd\(dq, \(dqapache\(dq, \(dqkernel\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Unlike \fIfile_list\fP, this function will break down which files belong to which
packages. It will also return errors in the same manner as \fIfile_list\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
    \(dqerrors\(dq: [\(dqpackage apache is not installed\(dq],
    \(dqpackages\(dq: {
        \(dqhttpd\(dq: [\(dq/etc/httpd\(dq, \(dq/etc/httpd/conf\(dq, \(dq...SNIP...\(dq],
        \(dqkernel\(dq: [
            \(dq/boot/.vmlinuz\-2.6.32\-279.el6.x86_64.hmac\(dq,
            \(dq/boot/System.map\-2.6.32\-279.el6.x86_64\(dq,
            \(dq...SNIP...\(dq,
        ],
    },
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Pull Requests
.sp
Salt is a large software project with many developers working together. We
encourage all Salt users to contribute new features, bug fixes and
documentation fixes. For those who haven\(aqt contributed to a large software
project before we encourage you to consider the following questions when
preparing a pull request.
.sp
This isn\(aqt an exhaustive list and these aren\(aqt necessarily hard and fast rules,
but these are things we consider when reviewing a pull request.
.INDENT 0.0
.IP \(bu 2
Does this change work on all platforms? In cases where it does not, is an
appropriate and easy\-to\-understand reason presented to the user? Is it
documented as\-such? Have we thought about all the possible ways this code
might be used and accounted as best we can for them?
.IP \(bu 2
Will this code work on versions of all Python we support? Will it work on
future versions?
.IP \(bu 2
Are Python reserved keywords used? Are variables named in a way that will
make it easy for the next person to understand what\(aqs going on?
.IP \(bu 2
Does this code present a security risk in any way? What is the worst possible
thing that an attacker could do with this code? If dangerous cases are
possible, is it appropriate to document them? If so, has this been done?
Would this change pass muster with a professional security audit? Is it
obvious to a person using this code what the risks are?
.IP \(bu 2
Is it readable? Does it conform to our \fI\%style guide\fP? Is the code documented
such that the next person who comes along will be able to read and understand
it? Most especially, are edge\-cases documented to avoid regressions? Will it
be immediately evident to the next person who comes along why this change was
made?
.UNINDENT
.INDENT 0.0
.IP \(bu 2
If appropriate, has the person who wrote the code which is being modified
been notified and included in the process?
.IP \(bu 2
What are the performance implications of this change? Is there a more
efficient way to structure the logic and if so, does making the change
balance itself against readability in a sensible way? Do the performance
characteristics of the code change based on the way it is being invoked
(i.e., through an API or various command\-line tools.) Will it be easy to
profile this change if it might be a problem?
.IP \(bu 2
Are caveats considered and documented in the change?
.IP \(bu 2
Will the code scale? More critically, will it scale in \fIboth\fP directions?
Salt runs in data\-centers and on Raspberry Pi installations in the Sahara. It
needs to work on big servers and tiny devices.
.IP \(bu 2
Is appropriate documentation written both in public\-facing docs and in\-line?
How will the user know how to use this? What will they do if it doesn\(aqt work
as expected? Is this something a new user will understand? Can a user know
all they need to about this functionality by reading the public docs?
.IP \(bu 2
Is this a change in behavior? If so, is it in the appropriate branch? Are
deprecation warnings necessary? Have those changes been fully documented?
Have we fully thought through what implications a change in behavior might
have?
.IP \(bu 2
How has the code been tested? If appropriate are there automated tests which
cover this? Is it likely to regress? If so, how has the potential of that
regression been mitigated? What is the plan for ensuring that this code works
going forward?
.IP \(bu 2
If it\(aqs asynchronous code, what is the potential for a race condition?
.IP \(bu 2
Is this code an original work? If it\(aqs borrowed from another project or found
online are the appropriate licensing/attribution considerations handled?
.IP \(bu 2
Is the reason for the change fully explained in the PR? If not for review,
this is necessary so that somebody in the future can go back and figure out
why it was necessary.
.IP \(bu 2
Is the intended behavior of the change clear? How will that behavior be known
to future contributors and to users?
.IP \(bu 2
Does this code handle errors in a reasonable way? Have we gone back through
the stack as much as possible to make sure that an error cannot be raised
that we do not account for? Are errors tested for as well as proper
functionality?
.IP \(bu 2
If the code relies on external libraries, do we properly handle old versions
of them? Do we require a specific version and if so is this version check
implemented? Is the library available on the same platforms that module in
question claims to support? If the code was written and tested against a
particular library, have we documented that fact?
.IP \(bu 2
Can this code freeze/hang/crash a running daemon? Can it stall a state run?
Are there infinite loops? Are appropriate timeouts implemented?
.IP \(bu 2
Is the function interface well documented? If argument types can not be
inferred by introspection, are they documented?
.IP \(bu 2
Are resources such as file\-handles cleaned\-up after they are used?
.IP \(bu 2
Is it possible that a reference\-cycle exists between objects that will leak
memory?
.IP \(bu 2
Has the code been linted and does it pass all tests?
.IP \(bu 2
Does the change fully address the problem or is it limited to a small surface
area? By this, I mean that it should be clear that the submitter has looked
for other cases in the function or module where the given case might also be
addressed. If additional changes are necessary are they documented in the
code as a FIXME or the PR and in Github as an issue to be tracked?
.IP \(bu 2
Will the code throw errors/warnings/stacktraces to the console during normal
operation?
.IP \(bu 2
Has all the debugging been removed?
.IP \(bu 2
Does the code log any sensitive data? Does it show sensitive data in process
lists? Does it store sensitive data to disk and if so, does it do so in a
secure manner? Are there potential race conditions in between writing the
data to disk and setting the appropriate permissions?
.IP \(bu 2
Is it clear from the solution that the problem is well\-understood? How can
somebody who has never seen the problem feel confident that this proposed
change is the best one?
.IP \(bu 2
What\(aqs hard\-coded that might not need to be? Are we making sensible decisions
for the user and allowing them to tune and change things where appropriate?
.IP \(bu 2
Are utility functions used where appropriate? Does this change re\-implement
something we already have code for?
.IP \(bu 2
Is the right thing being fixed? There are cases where it\(aqs appropriate to fix
a test and cases where it\(aqs appropriate to fix the code that\(aqs under test.
Which is best for the user? Is this change a shortcut or a solution that will
be solid in the months and years to come?
.IP \(bu 2
How will this code react to changes elsewhere in the code base? What is it
coupled to and have we fully thought through how best to present a coherent
interface to consumers of a given function or method?
.IP \(bu 2
Does this PR try to fix too many bugs/problems at once?
.IP \(bu 2
Should this be split into multiple PRs to make them easier to test and reason
about?
.UNINDENT
.SS Pull Request Requirements
.sp
The following outlines what is required before a pull request can be merged into
the salt project. For each of these requirements, an exception can be made
that requires 3 approvals before merge. The exceptions are detailed more below.
.SS All PR requirements
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Approval Required: approval review from core team member OR 1 approval review
from captain of working group
.IP \(bu 2
Cannot merge your own PR until 1 reviewer approves from defined list above that
is not the author.
.IP \(bu 2
All Tests Pass
.UNINDENT
.UNINDENT
.UNINDENT
.SS Bug Fix PR requirements
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Test Coverage: regression test written to cover bug fix. Contributors only need
to write test coverage for their specific changes.
.IP \(bu 2
Point to the issue the PR is resolving. If there is not an issue one will need
to be created.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Feature PR requirements
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Test Coverage: tests written to cover new feature. Contributors only need to write
test coverage for their specific changes.
.IP \(bu 2
Release Notes: Add note in release notes of new feature for relative release.
.IP \(bu 2
Add .. versionadded:: <release> to module\(aqs documentation. If you are not certain
which release your fix will be included in you can include TBD and the PR reviewer
will let you know the correct name of the release you need to update to the versionadded.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Exceptions to all requirements
.sp
As previously stated, all of the above requirements can be bypassed with 3 approvals.
PR\(aqs that do not require tests include:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
documentation
.IP \(bu 2
cosmetic changes (for example changing from log.debug to log.trace)
.IP \(bu 2
fixing tests
.IP \(bu 2
pylint
.IP \(bu 2
changes outside of the salt directory
.UNINDENT
.UNINDENT
.UNINDENT
.SS Pull Request CI/CD test suite
.sp
By default, PRs run a limited subset of the test suite against the following
operating systems:
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
.B Linux:
.INDENT 7.0
.IP \(bu 2
Latest \fBRocky Linux x86_64\fP
.IP \(bu 2
Latest \fBAmazon Linux aarch64\fP
.IP \(bu 2
Latest \fBUbuntu LTS arm64\fP
.IP \(bu 2
Latest \fBArch Linux x86_64\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
Latest \fBWindows Server x86_64\fP
.IP \(bu 2
Latest \fBMacOS arm64\fP
.UNINDENT
.SS Optional OS additions
.sp
There are times where a PR is specifically addressing a target OS, or a core component of
Salt is being updated that needs to be tested against all support operating systems. This
is often required to fix \fBnightly\fP builds, or introduce a new operating system into CI/CD.
.sp
Labels can be applied to a PR, via those who have the appropriate permissions, using the
\fBtest:os:<os\-name><os\-arch>\fP format.
.INDENT 0.0
.IP \(bu 2
Example: \fBtest:os:debian\-11\-arm64\fP would also ensure the Debian 11 arm64 OS is included.
.UNINDENT
.sp
Optionally, \fBtest:os:all\fP can be used as a way to target all operating systems
that nightlies, staging, release target without having to add them all individually.
.SS Optional test additions
.sp
If wanting to also increase the scope of tests themselves, not just the scope of operating
systems, then additional labels can be used such as:
.INDENT 0.0
.IP \(bu 2
\fBtest:pkg\fP: Run all package\-related tests that are otherwise not included by default
on the currently selected operating systems.
.IP \(bu 2
\fBtest:full\fP: Run all tests in the Salt test suite that can be ran on the currently
selected operating systems.
.IP \(bu 2
\fBtest:coverage\fP: Run all tests in the Salt test suite on all operating systems while
collecting code coverage.
.IP \(bu 2
\fBtest:random\-cache\-seed\fP: Randomize the GH Actions cache seed to make sure no caches
are used during the build.
.UNINDENT
.SS Release Notes
.sp
You can edit the release notes to highlight a new feature being added
to a given release. The release notes are templatized with Jinja and
are generated at release time.
.SS How do I edit the release notes
.sp
To edit the release notes you need to look in doc/topics/releases/templates
for your given release and edit the template. Do not edit the release note
files in doc/topics/releases/, as this will be written over with the content
in the template file. For example, if you want to add content to the 3006.0
release notes you would edit the doc/topics/releases/templates/3006.0.md.template
file. Do not edit the changelog portion of the template file, since that is
auto generated with the content generated for the changelog for each release.
.SS How to generate the release notes
.sp
This step is only used when we need to generate the release notes before releasing.
You should NOT need to run these steps as they are ran in the pipeline, but this
is documented so you can test your changes to the release notes template.
.sp
To generate the release notes requires the \fItools\fP command. The instructions below
will detail how to install and use \fItools\fP\&.
.SS Installing \fItools\fP
.sp
To view the output the release notes will produce before generating them
you can run \fItools\fP in draft mode:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tools changelog update\-release\-notes \-\-draft
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To generate the release notes just remove the \fI\-\-draft\fP argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tools changelog update\-release\-notes
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To specify a specific Salt version you add that version as an argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tools changelog update\-release\-notes 3006.0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To only generate the template for a new release
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tools changelog update\-release\-notes \-\-template\-only
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Reporting Bugs
.sp
Salt uses GitHub to track open issues and feature requests.
.sp
To file a bug, please navigate to the \fI\%new issue page for the Salt project\fP\&.
.sp
In an issue report, please include the following information:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The output of \fBsalt \-\-versions\-report\fP from the relevant machines. This
can also be gathered remotely by using \fBsalt <my_tgt>
test.versions_report\fP\&.
.IP \(bu 2
A description of the problem including steps taken to cause the issue to
occur and the expected behaviour.
.IP \(bu 2
Any steps taken to attempt to remediate the problem.
.IP \(bu 2
Any configuration options set in a configuration file that may be relevant.
.IP \(bu 2
A reproducible test case. This may be as simple as an SLS file that
illustrates a problem or it may be a link to a repository that contains a
number of SLS files that can be used together to re\-produce a problem. If
the problem is transitory, any information that can be used to try and
reproduce the problem is helpful.
.IP \(bu 2
[Optional] The output of each salt component (master/minion/CLI) running
with the \fB\-ldebug\fP flag set.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Please be certain to scrub any logs or SLS files for sensitive data!
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Salt Extensions
.sp
Salt modules can be distributed as Salt Extensions.
.sp
The existing Salt modules will be carved up into one of three categories. Each category will be
implemented in the following way:
.sp
## Core Modules
.sp
Core Modules will be kept inside the main Salt codebase, and development will be tied to the
Salt release cycle.
.sp
## Supported Modules
.sp
Supported modules will be moved to their own repositories within the SaltStack Github
organization where they can be maintained separately from the Salt codebase.
.sp
## Community Modules
.sp
Remaining modules will be deprecated from the Salt Core codebase and community members
will be able to continue independent maintainership if they are interested. Some plugins are
almost exclusively maintained by external corporations – if these corporations wish for formal
documentation outlining transfer of ownership it can be handled on a case\-by\-case basis. The
community modules can be hosted either in individual or corporate source control systems,
alternatively they can also be hosted in the community run Salt Extensions Github organization,
that will operate like the the Salt Formulas Github organization.
The criteria to determine which category to place modules in will follow these rules:
.sp
## Core Modules
.INDENT 0.0
.IP 1. 3
Required Salt Functionality
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP a. 3
Modules such as state, sys, peer, grains, pillar, etc.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 2. 3
Modules critical to Salt’s Multi OS support
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP a. 3
Modules that function across multiple operating systems like cmd and file.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
## Supported Modules
.sp
1. Modules to support specific operating systems traditionally maintained by the core team
– such as RedHat, MacOS, Windows, Solaris, etc.
.INDENT 0.0
.IP 2. 3
Modules to support specific but critical applications, such as Apache, MySQL, etc.
.UNINDENT
.sp
3. Modules created and maintained as part of VMware backed support agreements and
contracts.
.sp
## Community Extension Modules
.sp
1. Modules to support specific operating systems traditionally maintained by the OS vendor
– such as SUSE, openBSD, NetBSD, etc.
.INDENT 0.0
.IP 2. 3
Modules to support cloud interfaces, such as AWS, Azure, etc.
.UNINDENT
.sp
3. Modules no longer maintained, or which we suspect are also no longer used or
maintained, such as moosefs, qemu_img, etc.
.SS How do I deprecate a Salt module to a Salt extension
.sp
To indicate that a Salt module is being deprecated in favor of a Salt extension,
for each Salt module include \fB__deprecated__\fP tuple in the module.  The tuple
should include the version of Salt that the module will be removed, the name of the
collection of modules that are being deprecated, and the URL where the source for
the new extension can be found. The version should be 2 major versions from the
next major release. For example, if the next major release of Salt is 3100, the
deprecation version should be set to 3102.
.SS Salt Topology
.sp
Salt is based on a powerful, asynchronous, network topology using ZeroMQ. Many
ZeroMQ systems are in place to enable communication. The central idea is to
have the fastest communication possible.
.SS Servers
.sp
The Salt Master runs 2 network services. First is the ZeroMQ PUB system. This
service by default runs on port \fB4505/tcp\fP and can be configured via the
\fBpublish_port\fP option in the master configuration.
.sp
Second is the ZeroMQ REP system. This is a separate interface used for all
bi\-directional communication with minions. By default this system binds to
port \fB4506/tcp\fP and can be configured via the \fBret_port\fP option in the master.
.SS PUB/SUB
.sp
The commands sent out via the salt client are broadcast out to the minions via
ZeroMQ PUB/SUB. This is done by allowing the minions to maintain a connection
back to the Salt Master and then all connections are informed to download the
command data at once. The command data is kept extremely small (usually less
than 1K) so it is not a burden on the network.
.SS Return
.sp
The PUB/SUB system is a one way communication, so once a publish is sent out
the PUB interface on the master has no further communication with the minion.
The minion, after running the command, then sends the command\(aqs return data
back to the master via the \fBret_port\fP\&.
.SS Developing Salt Tutorial
.sp
This tutorial assumes you have:
.INDENT 0.0
.IP \(bu 2
a web browser
.IP \(bu 2
a GitHub account (\fB<my_account>\fP)
.IP \(bu 2
a command line (CLI)
.IP \(bu 2
git
.IP \(bu 2
a text editor
.UNINDENT
.SS Fork
.sp
In your browser, navigate to the \fBsaltstack/salt\fP \fI\%GitHub repository\fP\&.
.sp
Click on \fBFork\fP (\fI\%https://github.com/saltstack/salt/#fork\-destination\-box\fP).
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you have more than one GitHub presence, for example if you are a member
of a team, GitHub will ask you into which area to clone Salt.  If you don\(aqt
know where, then select your personal GitHub account.
.UNINDENT
.UNINDENT
.SS Clone
.sp
In your CLI, navigate to the directory into which you want clone the Salt
codebase and submit the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ git clone https://github.com/<my_account>/salt.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
where \fB<my_account>\fP is the name of your GitHub account.  After the clone has
completed, add SaltStack as a second remote and fetch any changes from
\fBupstream\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ cd salt
$ git remote add upstream https://github.com/saltstack/salt.git
$ git fetch upstream
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For this tutorial, we will be working off from the \fBmaster\fP branch, which is
the default branch for the SaltStack GitHub project.  This branch needs to
track \fBupstream/master\fP so that we will get all upstream changes when they
happen.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ git checkout master
$ git branch \-\-set\-upstream\-to upstream/master
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Fetch
.sp
Fetch any \fBupstream\fP changes on the \fBmaster\fP branch and sync them to your
local copy of the branch with a single command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ git pull \-\-rebase
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
For an explanation on \fBpull\fP vs \fBpull \-\-rebase\fP and other excellent
points, see \fI\%this article\fP by
Mislav Marohnić.
.UNINDENT
.UNINDENT
.SS Branch
.sp
Now we are ready to get to work.  Consult the \fI\%sprint beginner bug list\fP
and select an execution module whose \fB__virtual__\fP function needs to be
updated.  I\(aqll select the \fBalternatives\fP module.
.sp
Create a new branch off from \fBmaster\fP\&.  Be sure to name it something short
and descriptive.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ git checkout \-b virt_ret
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Edit
.sp
Edit the file you have selected, and verify that the changes are correct.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ vim salt/modules/alternatives.py
$ git diff
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
diff \-\-git a/salt/modules/alternatives.py b/salt/modules/alternatives.py
index 1653e5f..30c0a59 100644
\-\-\- a/salt/modules/alternatives.py
+++ b/salt/modules/alternatives.py
@@ \-30,7 +30,7 @@ def __virtual__():
         \(aq\(aq\(aq
         if os.path.isdir(\(aq/etc/alternatives\(aq):
                 return True
\-        return False
+        return (False, \(aqCannot load alternatives module: /etc/alternatives dir not found\(aq)


 def _get_cmd():
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Commit
.sp
Stage and commit the changes.  Write a descriptive commit summary, but try to
keep it less than 50 characters.  Review your commit.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ git add salt/modules/alternatives.py
$ git commit \-m \(aqmodules.alternatives: __virtual__ return err msg\(aq
$ git show
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you need more room to describe the changes in your commit, run \fBgit
commit\fP (without the \fB\-m\fP, message, option) and you will be presented
with an editor.  The first line is the commit summary and should still be
50 characters or less.  The following paragraphs you create are free form
and will be preserved as part of the commit.
.UNINDENT
.UNINDENT
.SS Push
.sp
Push your branch to your GitHub account.  You will likely need to enter your
GitHub username and password.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ git push origin virt_ret
Username for \(aqhttps://github.com\(aq: <my_account>
Password for \(aqhttps://<my_account>@github.com\(aq:
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If authentication over https does not work, you can alternatively setup
\fI\%ssh keys\fP\&.  Once
you have done this, you may need add the keys to your git repository
configuration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ git config ssh.key ~/.ssh/<key_name>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
where \fB<key_name>\fP is the file name of the private key you created.
.UNINDENT
.UNINDENT
.SS Merge
.sp
In your browser, navigate to the \fI\%new pull request\fP page on the \fBsaltstack/salt\fP
GitHub repository and click on \fBcompare across forks\fP\&.  Select
\fB<my_account>\fP from the list of head forks and the branch you are wanting to
merge into \fBmaster\fP (\fBvirt_ret\fP in this case).
.sp
When you have finished reviewing the changes, click \fBCreate pull request\fP\&.
.sp
If your pull request contains only a single commit, the title and comment will
be taken from that commit\(aqs summary and message, otherwise the branch name is
used for the title.  Edit these fields as necessary  and click \fBCreate pull
request\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Although these instructions seem to be the official pull request procedure
on github\(aqs website, here are two alternative methods that are simpler.
.INDENT 0.0
.IP \(bu 2
If you navigate to your clone of salt,
\fBhttps://github.com/<my_account>/salt\fP, depending on how old your
branch is or how recently you pushed updates on it, you may be presented
with a button to create a pull request with your branch.
.IP \(bu 2
I find it easiest to edit the following URL:
.sp
\fBhttps://github.com/saltstack/salt/compare/master...<my_account>:virt_ret\fP
.UNINDENT
.UNINDENT
.UNINDENT
.SS Resources
.sp
GitHub offers many great tutorials on various aspects of the git\- and
GitHub\-centric development workflow:
.sp
\fI\%https://help.github.com/\fP
.sp
There are many topics covered by the Salt Developer documentation:
.sp
\fI\%https://docs.saltproject.io/en/latest/topics/development/index.html\fP
.sp
The contributing documentation presents more details on specific contributing
topics:
.sp
\fI\%https://docs.saltproject.io/en/latest/topics/development/contributing.html\fP
.SS Modular Systems
.sp
When first working with Salt, it is not always clear where all of the modular
components are and what they do. Salt comes loaded with more modular systems
than many users are aware of, making Salt very easy to extend in many places.
.sp
The most commonly used modular systems are execution modules and states. But
the modular systems extend well beyond the more easily exposed components
and are often added to Salt to make the complete system more flexible.
.SS Developing New Modules
.SS Interactive Debugging
.sp
Sometimes debugging with \fBprint()\fP and extra logs sprinkled everywhere is not
the best strategy.
.sp
IPython is a helpful debug tool that has an interactive python environment
which can be embedded in python programs.
.sp
First the system will require IPython to be installed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Debian
apt\-get install ipython

# Arch Linux
pacman \-Syu ipython2

# RHEL/CentOS (via EPEL)
yum install python\-ipython
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now, in the troubling python module, add the following line at a location where
the debugger should be started:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
test = \(dqtest123\(dq
import IPython

IPython.embed_kernel()
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
After running a Salt command that hits that line, the following will show up in
the log file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[CRITICAL] To connect another client to this kernel, use:
[IPKernelApp] \-\-existing kernel\-31271.json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now on the system that invoked \fBembed_kernel\fP, run the following command from
a shell:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# NOTE: use ipython2 instead of ipython for Arch Linux
ipython console \-\-existing
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This provides a console that has access to all the vars and functions, and even
supports tab\-completion.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
print(test)
test123
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To exit IPython and continue running Salt, press \fBCtrl\-d\fP to logout.
.SS The Salt Loader
.sp
Salt\(aqs loader system is responsible for reading \fI\%Special Module Contents\fP and
providing the context for the special \fI\%Dunder Dictionaries\fP\&. When modules
developed for Salt\(aqs loader are imported directly, the dunder attributes won\(aqt
be populated. You can use the \fI\%Loader Context\fP to work around this.
.SS Loader Context
.sp
Given the following.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# coolmod.py


def utils_func_getter(name):
    return __utils__[name]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You would not be able import \fBcoolmod\fP and run \fButils_func_getter\fP because
\fB__utils__\fP would not be defined. You must run \fBcoolmod.utils_func_getter\fP
in the context of a loader.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import coolmod
import salt.loader

opts = {}
utils = salt.loader.utils(opts)
with salt.loader.context(utils):
    func = coolmod.utils_func_getter(\(dqfoo.bar\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Special Module Contents
.sp
These are things that may be defined by the module to influence various things.
.SS __virtual__
.SS __virtual_aliases__
.SS __virtualname__
.SS __init__
.sp
Called before \fB__virtual__()\fP
.SS __proxyenabled__
.sp
grains and proxy modules
.sp
__proxyenabled__ as a list containing the names of the proxy types that the module supports.
.SS __load__
.SS __func_alias__
.SS __outputter__
.SS Dunder Dictionaries
.sp
Salt provides several special \(dqdunder\(dq dictionaries as a convenience for Salt
development.  These include \fB__opts__\fP, \fB__context__\fP, \fB__salt__\fP, and
others. This document will describe each dictionary and detail where they exist
and what information and/or functionality they provide.
.sp
The following dunder dictionaries are always defined, but may be empty
.INDENT 0.0
.IP \(bu 2
\fB__context__\fP
.IP \(bu 2
\fB__grains__\fP
.IP \(bu 2
\fB__pillar__\fP
.IP \(bu 2
\fB__opts__\fP
.UNINDENT
.SS __opts__
.sp
Changed in version 3006.0: The \fB__opts__\fP dictionary can now be accessed via
\fBcontext\(ga\fP\&.

.sp
Defined in: All modules
.sp
The \fB__opts__\fP dictionary contains all of the options passed in the
configuration file for the master or minion.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In many places in salt, instead of pulling raw data from the __opts__
dict, configuration data should be pulled from the salt \fIget\fP functions
such as config.get
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__salt__[\(dqconfig.get\(dq](\(dqfoo:bar\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fIget\fP functions also allow for dict traversal via the \fI:\fP delimiter.
Consider using get functions whenever using \fB__opts__\fP or \fB__pillar__\fP
and \fB__grains__\fP (when using grains for configuration data)
.UNINDENT
.UNINDENT
.sp
The configuration file data made available in the \fB__opts__\fP dictionary is the
configuration data relative to the running daemon. If the modules are loaded and
executed by the master, then the master configuration data is available, if the
modules are executed by the minion, then the minion configuration is
available. Any additional information passed into the respective configuration
files is made available
.SS __salt__
.sp
Defined in: Auth, Beacons, Engines, Execution, Executors, Outputters, Pillars,
Proxies, Renderers, Returners, Runners, SDB, SSH Wrappers, State, Thorium
.sp
\fB__salt__\fP contains the execution module functions. This allows for all
functions to be called as they have been set up by the salt loader.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__salt__[\(dqcmd.run\(dq](\(dqfdisk \-l\(dq)
__salt__[\(dqnetwork.ip_addrs\(dq]()
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When used in runners or outputters, \fB__salt__\fP references other
runner/outputter modules, and not execution modules.
.UNINDENT
.UNINDENT
.SS __grains__
.sp
Filled in for: Execution, Pillar, Renderer, Returner, SSH Wrapper, State.
.sp
The \fB__grains__\fP dictionary contains the grains data generated by the minion
that is currently being worked with. In execution modules, state modules and
returners this is the grains of the minion running the calls, when generating
the external pillar the \fB__grains__\fP is the grains data from the minion that
the pillar is being generated for.
.sp
While \fB__grains__\fP is defined for every module, it\(aqs only filled in for some.
.SS __pillar__
.sp
Filled in for: Execution, Renderer, Returner, SSH Wrapper, State
.sp
The \fB__pillar__\fP dictionary contains the pillar for the respective minion.
.sp
While \fB__pillar__\fP is defined for every module, it\(aqs only filled in for some.
.SS __ext_pillar__
.sp
Filled in for: Pillar
.sp
The \fB__ext_pillar__\fP dictionary contains the external pillar modules.
.SS __context__
.sp
During a state run the \fB__context__\fP dictionary persists across all states
that are run and then is destroyed when the state ends.
.sp
When running an execution module \fB__context__\fP persists across all module
executions until the modules are refreshed; such as when
\fI\%saltutil.sync_all\fP or
\fI\%state.apply\fP are executed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
if not \(dqcp.fileclient\(dq in __context__:
    __context__[\(dqcp.fileclient\(dq] = salt.fileclient.get_file_client(__opts__)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Because __context__ may or may not have been destroyed, always be
sure to check for the existence of the key in __context__ and
generate the key before using it.
.UNINDENT
.UNINDENT
.SS __utils__
.sp
Defined in: Cloud, Engine, Execution, File Server, Grain, Pillar, Proxy, Roster, Runner, SDB, State
.SS __proxy__
.sp
Defined in: Beacon, Engine, Execution, Executor, Proxy, Renderer, Returner, State, Util
.SS __runner__
.sp
Defined in: Engine, Roster, Thorium
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When used in engines, it should be called __runners__ (plural)
.UNINDENT
.UNINDENT
.SS __executors__
.sp
Defined in: Executor
.SS __ret__
.sp
Defined in: Proxy
.SS __thorium__
.sp
Defined in: Thorium
.SS __states__
.sp
Defined in: Renderers, State
.SS __serializers__
.sp
Defined in: State
.SS __sdb__
.sp
Defined in: SDB
.SS __file_client__
.sp
Changed in version 3006.5.

.sp
The \fB__file_client__\fP dunder was added to states and execution modules. This
enables the use of a file client without haveing to instantiate one in
the module.
.SS Configuration Options
.sp
A number of configuration options can affect the load process. This is a quick
list of them:
.INDENT 0.0
.IP \(bu 2
\fBautoload_dynamic_modules\fP (\fI\%Minion\fP)
.IP \(bu 2
\fBcython_enable\fP (\fI\%Minion\fP, \fI\%Master\fP)
.IP \(bu 2
\fBdisable_modules\fP (\fI\%Minion\fP)
.IP \(bu 2
\fBdisable_returners\fP (\fI\%Minion\fP)
.IP \(bu 2
\fBenable_zip_modules\fP (\fI\%Minion\fP)
.IP \(bu 2
\fBextension_modules\fP (\fI\%Master\fP)
.IP \(bu 2
\fBextmod_whitelist\fP (\fI\%Minion\fP, \fI\%Master\fP)
.IP \(bu 2
\fBextmod_blacklist\fP (\fI\%Minion\fP, \fI\%Master\fP)
.IP \(bu 2
\fBwhitelist_modules\fP (\fI\%Minion\fP)
.IP \(bu 2
\fBgrains_dirs\fP (\fI\%Minion\fP)
.IP \(bu 2
\fBmodule_dirs\fP (\fI\%Minion\fP, \fI\%Master\fP)
.IP \(bu 2
\fBoutputter_dirs\fP (\fI\%Minion\fP, \fI\%Master\fP)
.IP \(bu 2
\fBproviders\fP (\fI\%Minion\fP)
.IP \(bu 2
\fBrender_dirs\fP (\fI\%Minion\fP)
.IP \(bu 2
\fBreturner_dirs\fP (\fI\%Minion\fP)
.IP \(bu 2
\fBrunner_dirs\fP (\fI\%Master\fP)
.IP \(bu 2
\fBstates_dirs\fP (\fI\%Minion\fP)
.IP \(bu 2
\fButils_dirs\fP (\fI\%Minion\fP)
.UNINDENT
.SS Loading Modules
.sp
Modules come primarily from several sources:
.INDENT 0.0
.IP \(bu 2
The Salt package itself
.IP \(bu 2
The Salt File Server
.IP \(bu 2
The extmods directory
.IP \(bu 2
Secondary packages installed
.UNINDENT
.sp
Using one source to override another is not supported.
.SS The Salt Package
.sp
Salt itself ships with a large number of modules. These are part of the Salt
package itself and don\(aqt require the user to do anything to use them. (Although
a number of them have additional dependencies and/or configuration.)
.SS The Salt File Server
.sp
The user may add modules by simply placing them in special directories in their
\fI\%fileserver\fP\&.
.sp
The name of the directory inside of the file server is the directory name
prepended by underscore, such as:
.INDENT 0.0
.IP \(bu 2
\fB_grains\fP
.IP \(bu 2
\fB_modules\fP
.IP \(bu 2
\fB_states\fP
.UNINDENT
.sp
Modules must be synced before they can be used. This can happen a few ways,
discussed below.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Using saltenvs besides \fBbase\fP may not work in all contexts.
.UNINDENT
.UNINDENT
.SS Sync Via States
.sp
The minion configuration contains an option \fBautoload_dynamic_modules\fP
which defaults to \fBTrue\fP\&. This option makes the state system refresh all
dynamic modules when states are run. To disable this behavior set
\fI\%autoload_dynamic_modules\fP to \fBFalse\fP in the minion config.
.sp
When dynamic modules are autoloaded via states, only the modules defined in the
same saltenv as the states currently being run are synced.
.SS Sync Via the saltutil Module
.sp
The saltutil module has a number of functions that can be used to sync all
or specific dynamic modules. The \fBsaltutil.sync_*\fP
\fI\%execution functions\fP and
\fI\%runner functions\fP can be used to sync modules
to minions and the master, respectively.
.sp
If saltenv environments are used (through the \fI\%top file\fP, the \fI\%environment\fP option of the minion configuration file, or as an argument on the command line) modules will be synced from the applied environments.
.SS The extmods Directory
.sp
Any files places in the directory set by \fBextension_modules\fP settings
(\fBminion\fP,
\fI\%master\fP, default
\fB/var/cache/salt/*/extmods\fP) can also be loaded as modules. Note that these
directories are also used by the \fBsaltutil.sync_*\fP functions (mentioned
above) and files may be overwritten.
.SS Secondary Packages
.sp
Third\-party packages may also add modules to Salt if they are installed in the
same system and Python environment as the Salt Minion or Master.
.sp
This is done via setuptools entry points:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
setup(
    # ...
    entry_points={\(dqsalt.loader\(dq: [\(dqmodule_dirs=spirofs.loader:module\(dq]},
    # ...
)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that these are not synced from the Salt Master to the Minions. They must be
installed independently on each Minion.
.SS Module Types
.sp
The specific names used by each loading method above are as follows. See sections below
for a short summary of each of these systems.
.TS
center;
|l|l|l|l|.
_
T{
Module Type
T}	T{
Salt Package Name
T}	T{
FS/Directory Name
T}	T{
Entry Point
T}
_
T{
Auth
T}	T{
\fBsalt.auth\fP (\fI\%index\fP)
T}	T{
\fBauth\fP [1]
T}	T{
\fBauth_dirs\fP
T}
_
T{
Beacon
T}	T{
\fBsalt.beacons\fP (\fI\%index\fP)
T}	T{
\fBbeacons\fP
T}	T{
\fBbeacons_dirs\fP
T}
_
T{
Cache
T}	T{
\fBsalt.cache\fP (\fI\%index\fP)
T}	T{
\fBcache\fP
T}	T{
\fBcache_dirs\fP
T}
_
T{
Cloud
T}	T{
\fBsalt.cloud.clouds\fP (\fI\%index\fP)
T}	T{
\fBclouds\fP
T}	T{
\fBcloud_dirs\fP
T}
_
T{
Engine
T}	T{
\fBsalt.engines\fP (\fI\%index\fP)
T}	T{
\fBengines\fP
T}	T{
\fBengines_dirs\fP
T}
_
T{
Execution
T}	T{
\fBsalt.modules\fP (\fI\%index\fP)
T}	T{
\fBmodules\fP
T}	T{
\fBmodule_dirs\fP
T}
_
T{
Executor
T}	T{
\fBsalt.executors\fP (\fI\%index\fP)
T}	T{
\fBexecutors\fP
T}	T{
\fBexecutor_dirs\fP
T}
_
T{
File Server
T}	T{
\fBsalt.fileserver\fP (\fI\%index\fP)
T}	T{
\fBfileserver\fP
T}	T{
\fBfileserver_dirs\fP
T}
_
T{
Grain
T}	T{
\fBsalt.grains\fP (\fI\%index\fP)
T}	T{
\fBgrains\fP
T}	T{
\fBgrains_dirs\fP
T}
_
T{
Log Handler
T}	T{
\fBsalt.log_handlers\fP (\fI\%index\fP)
T}	T{
\fBlog_handlers\fP
T}	T{
\fBlog_handlers_dirs\fP
T}
_
T{
Matcher
T}	T{
\fBsalt.matchers\fP
T}	T{
\fBmatchers\fP
T}	T{
\fBmatchers_dirs\fP
T}
_
T{
Metaproxy
T}	T{
\fBsalt.metaproxy\fP
T}	T{
\fBmetaproxy\fP [1]
T}	T{
\fBmetaproxy_dirs\fP
T}
_
T{
Net API
T}	T{
\fBsalt.netapi\fP (\fI\%index\fP)
T}	T{
\fBnetapi\fP [1]
T}	T{
\fBnetapi_dirs\fP
T}
_
T{
Outputter
T}	T{
\fBsalt.output\fP (\fI\%index\fP)
T}	T{
\fBoutput\fP
T}	T{
\fBoutputter_dirs\fP
T}
_
T{
Pillar
T}	T{
\fBsalt.pillar\fP (\fI\%index\fP)
T}	T{
\fBpillar\fP
T}	T{
\fBpillar_dirs\fP
T}
_
T{
Proxy
T}	T{
\fBsalt.proxy\fP (\fI\%index\fP)
T}	T{
\fBproxy\fP
T}	T{
\fBproxy_dirs\fP
T}
_
T{
Queue
T}	T{
\fBsalt.queues\fP (\fI\%index\fP)
T}	T{
\fBqueues\fP
T}	T{
\fBqueue_dirs\fP
T}
_
T{
Renderer
T}	T{
\fBsalt.renderers\fP (\fI\%index\fP)
T}	T{
\fBrenderers\fP
T}	T{
\fBrender_dirs\fP
T}
_
T{
Returner
T}	T{
\fBsalt.returners\fP (\fI\%index\fP)
T}	T{
\fBreturners\fP
T}	T{
\fBreturner_dirs\fP
T}
_
T{
Roster
T}	T{
\fBsalt.roster\fP (\fI\%index\fP)
T}	T{
\fBroster\fP
T}	T{
\fBroster_dirs\fP
T}
_
T{
Runner
T}	T{
\fBsalt.runners\fP (\fI\%index\fP)
T}	T{
\fBrunners\fP
T}	T{
\fBrunner_dirs\fP
T}
_
T{
SDB
T}	T{
\fBsalt.sdb\fP (\fI\%index\fP)
T}	T{
\fBsdb\fP
T}	T{
\fBsdb_dirs\fP
T}
_
T{
Serializer
T}	T{
\fBsalt.serializers\fP (\fI\%index\fP)
T}	T{
\fBserializers\fP [1]
T}	T{
\fBserializers_dirs\fP
T}
_
T{
SPM pkgdb
T}	T{
\fBsalt.spm.pkgdb\fP
T}	T{
\fBpkgdb\fP [1]
T}	T{
\fBpkgdb_dirs\fP
T}
_
T{
SPM pkgfiles
T}	T{
\fBsalt.spm.pkgfiles\fP
T}	T{
\fBpkgfiles\fP [1]
T}	T{
\fBpkgfiles_dirs\fP
T}
_
T{
SSH Wrapper
T}	T{
\fBsalt.client.ssh.wrapper\fP
T}	T{
\fBwrapper\fP
T}	T{
\fBwrapper_dirs\fP
T}
_
T{
State
T}	T{
\fBsalt.states\fP (\fI\%index\fP)
T}	T{
\fBstates\fP
T}	T{
\fBstates_dirs\fP
T}
_
T{
Thorium
T}	T{
\fBsalt.thorium\fP (\fI\%index\fP)
T}	T{
\fBthorium\fP
T}	T{
\fBthorium_dirs\fP
T}
_
T{
Tokens
T}	T{
\fBsalt.tokens\fP
T}	T{
\fBtokens\fP
T}	T{
\fBtokens_dirs\fP
T}
_
T{
Top
T}	T{
\fBsalt.tops\fP (\fI\%index\fP)
T}	T{
\fBtops\fP
T}	T{
\fBtop_dirs\fP
T}
_
T{
Util
T}	T{
\fBsalt.utils\fP
T}	T{
\fButils\fP
T}	T{
\fButils_dirs\fP
T}
_
T{
Wheel
T}	T{
\fBsalt.wheels\fP (\fI\%index\fP)
T}	T{
\fBwheel\fP
T}	T{
\fBwheel_dirs\fP
T}
_
.TE
.IP [1] 5
These modules cannot be loaded from the Salt File Server.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
While it is possible to import modules directly with the import statement,
it is strongly recommended that the appropriate
\fI\%dunder dictionary\fP is used to access them
instead. This is because a number of factors affect module names, module
selection, and module overloading.
.UNINDENT
.UNINDENT
.SS Auth
.sp
The auth module system allows for external authentication routines to be easily
added into Salt. The \fIauth\fP function needs to be implemented to satisfy the
requirements of an auth module. Use the \fBpam\fP module as an example.
.sp
See \fI\%External Authentication System\fP for more about
authentication in Salt.
.SS Beacon
.INDENT 0.0
.IP \(bu 2
\fI\%Writing Beacons\fP
.UNINDENT
.sp
Beacons are polled by the Salt event loop to monitor non\-salt processes. See
\fI\%Beacons\fP for more information about the beacon system.
.SS Cache
.sp
The minion cache is used by the master to store various information about
minions. See \fI\%Minion Data Cache\fP for more information.
.SS Cloud
.sp
Cloud modules are backend implementations used by \fI\%Salt Cloud\fP\&.
.SS Engine
.sp
Engines are open\-ended services managed by the Salt daemon (both master and
minion). They may interact with event loop, call other modules, or a variety of
non\-salt tasks. See \fI\%Salt Engines\fP for complete details.
.SS Execution
.sp
Execution modules make up the core of the functionality used by Salt to
interact with client systems. The execution modules create the core system
management library used by all Salt systems, including states, which
interact with minion systems.
.sp
Execution modules are completely open ended in their execution. They can
be used to do anything required on a minion, from installing packages to
detecting information about the system. The only restraint in execution
modules is that the defined functions always return a JSON serializable
object.
.SS Executor
.sp
Executors control how execution modules get called. The default is to just call
them, but this can be customized.
.SS File Server
.sp
The file server module system is used to create file server backends used by the
Salt Master. These modules need to implement the functions used in the
fileserver subsystem. Use the \fBgitfs\fP module as an example.
.sp
See \fI\%File Server Backends\fP for more information.
.SS Grains
.INDENT 0.0
.IP \(bu 2
\fI\%Writing Grains\fP
.UNINDENT
.sp
Grain modules define extra routines to populate grains data. All defined
public functions will be executed and MUST return a Python dict object. The
dict keys will be added to the grains made available to the minion.
.sp
See \fI\%Grains\fP for more.
.SS Log Handler
.sp
Log handlers allows the logs from salt (master or minion) to be sent to log
aggregation systems.
.SS Matcher
.sp
Matcher modules are used to define the \fI\%minion targeting expressions\fP\&.
For now, it is only possible to override the \fI\%existing matchers\fP
(the required CLI plumbing for custom matchers is not implemented yet).
.SS Metaproxy
.sp
Metaproxy is an abstraction layer above the existing proxy minion. It enables
adding different types of proxy minions that can still load existing proxymodules.
.SS Net API
.sp
Net API modules are the actual server implementation used by Salt API.
.SS Output
.sp
The output modules supply the outputter system with routines to display data
in the terminal. These modules are very simple and only require the \fIoutput\fP
function to execute. The default system outputter is the \fBnested\fP module.
.SS Pillar
.SS External Pillars
.sp
Salt provides a mechanism for generating pillar data by calling external
pillar interfaces. This document will describe an outline of an ext_pillar
module.
.SS Location
.sp
Salt expects to find your \fBext_pillar\fP module in the same location where it
looks for other python modules. If the \fBextension_modules\fP option in your
Salt master configuration is set, Salt will look for a \fBpillar\fP directory
under there and load all the modules it finds. Otherwise, it will look in
your Python site\-packages \fBsalt/pillar\fP directory.
.SS Configuration
.sp
The external pillars that are called when a minion refreshes its pillars is
controlled by the \fBext_pillar\fP option in the Salt master configuration. You
can pass a single argument, a list of arguments or a dictionary of arguments
to your pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- example_a: some argument
  \- example_b:
    \- argumentA
    \- argumentB
  \- example_c:
      keyA: valueA
      keyB: valueB
.ft P
.fi
.UNINDENT
.UNINDENT
.SS The Module
.SS Imports and Logging
.sp
Import modules your external pillar module needs. You should first include
generic modules that come with stock Python:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import logging
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And then start logging. This is an idiomatic way of setting up logging in Salt:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log = logging.getLogger(__name__)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Finally, load modules that are specific to what you are doing. You should catch
import errors and set a flag that the \fB__virtual__\fP function can use later.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
try:
    import weird_thing

    EXAMPLE_A_LOADED = True
except ImportError:
    EXAMPLE_A_LOADED = False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Options
.sp
If you define an \fB__opts__\fP dictionary, it will be merged into the
\fB__opts__\fP dictionary handed to the \fBext_pillar\fP function later. This is a
good place to put default configuration items. The convention is to name
things \fBmodulename.option\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__opts__ = {\(dqexample_a.someconfig\(dq: 137}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Initialization
.sp
If you define an \fB__init__\fP function, it will be called with the following
signature:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def __init__(__opts__):
    # Do init work here
    ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNote\fP: The \fB__init__\fP function is ran every time a particular minion causes
the external pillar to be called, so don\(aqt put heavy initialization code here.
The \fB__init__\fP functionality is a side\-effect of the Salt loader, so it may
not be as useful in pillars as it is in other Salt items.
.SS __virtual__
.sp
If you define a \fB__virtual__\fP function, you can control whether or not this
module is visible. If it returns \fBFalse\fP then Salt ignores this module. If
it returns a string, then that string will be how Salt identifies this external
pillar in its \fBext_pillar\fP configuration. If you\(aqre not renaming the module,
simply return \fBTrue\fP in the \fB__virtual__\fP function, which is the same as if
this function did not exist, then, the name Salt\(aqs \fBext_pillar\fP will use to
identify this module is its conventional name in Python.
.sp
This is useful to write modules that can be installed on all Salt masters, but
will only be visible if a particular piece of software your module requires is
installed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# This external pillar will be known as \(gaexample_a\(ga
def __virtual__():
    if EXAMPLE_A_LOADED:
        return True
    return False
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# This external pillar will be known as \(gasomething_else\(ga
__virtualname__ = \(dqsomething_else\(dq


def __virtual__():
    if EXAMPLE_A_LOADED:
        return __virtualname__
    return False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS ext_pillar
.sp
This is where the real work of an external pillar is done. If this module is
active and has a function called \fBext_pillar\fP, whenever a minion updates its
pillar this function is called.
.sp
How it is called depends on how it is configured in the Salt master
configuration. The first argument is always the current pillar dictionary, this
contains pillar items that have already been added, starting with the data from
\fBpillar_roots\fP, and then from any already\-ran external pillars.
.sp
Using our example above:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar(id, pillar, \(dqsome argument\(dq)  # example_a
ext_pillar(id, pillar, \(dqargumentA\(dq, \(dqargumentB\(dq)  # example_b
ext_pillar(id, pillar, keyA=\(dqvalueA\(dq, keyB=\(dqvalueB\(dq)  # example_c
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the \fBexample_a\fP case, \fBpillar\fP will contain the items from the
\fBpillar_roots\fP, in \fBexample_b\fP \fBpillar\fP  will contain that plus the items
added by \fBexample_a\fP, and in \fBexample_c\fP \fBpillar\fP will contain that plus
the items added by \fBexample_b\fP\&. In all three cases, \fBid\fP will contain the
ID of the minion making the pillar request.
.sp
This function should return a dictionary, the contents of which are merged in
with all of the other pillars and returned to the minion. \fBNote\fP: this function
is called once for each minion that fetches its pillar data.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def ext_pillar(minion_id, pillar, *args, **kwargs):

    my_pillar = {\(dqexternal_pillar\(dq: {}}

    my_pillar[\(dqexternal_pillar\(dq] = get_external_pillar_dictionary()

    return my_pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can call pillar with the dictionary\(aqs top name to retrieve its data.
From above example, \(aqexternal_pillar\(aq is the top dictionary name. Therefore:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq pillar.get external_pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You shouldn\(aqt just add items to \fBpillar\fP and return that, since that will
cause Salt to merge data that already exists. Rather, just return the items
you are adding or changing. You could, however, use \fBpillar\fP in your module
to make some decision based on pillar data that already exists.
.sp
This function has access to some useful globals:
.INDENT 0.0
.TP
.B __opts__
A dictionary of mostly Salt configuration options. If you had an
\fB__opts__\fP dictionary defined in your module, those values will be
included.
.TP
.B __salt__
A dictionary of Salt module functions, useful so you don\(aqt have to
duplicate functions that already exist. E.g.
\fB__salt__[\(aqcmd.run\(aq]( \(aqls \-l\(aq )\fP \fBNote\fP, runs on the \fImaster\fP
.TP
.B __grains__
A dictionary of the grains of the minion making this pillar call.
.UNINDENT
.SS Example configuration
.sp
As an example, if you wanted to add external pillar via the \fBcmd_json\fP
external pillar, add something like this to your master config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- cmd_json: \(aqecho {\e\(dqarg\e\(dq:\e\(dqvalue\e\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Reminder
.sp
Just as with traditional pillars, external pillars must be refreshed in order for
minions to see any fresh data:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.refresh_pillar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Used to define optional external pillar systems. The pillar generated via
the filesystem pillar is passed into external pillars. This is commonly used
as a bridge to database data for pillar, but is also the backend to the libvirt
state used to generate and sign libvirt certificates on the fly.
.SS Proxy
.sp
\fI\%Proxy Minions\fP are a way to manage devices that cannot run
a full minion directly.
.SS Renderers
.sp
Renderers are the system used to render sls files into salt highdata for the
state compiler. They can be as simple as the \fBpy\fP renderer and as complex as
\fBstateconf\fP and \fBpydsl\fP\&.
.SS Returners
.sp
Returners are used to send data from minions to external sources, commonly
databases. A full returner will implement all routines to be supported as an
external job cache. Use the \fBredis\fP returner as an example.
.SS Roster
.sp
The \fI\%Roster system\fP is used by Salt SSH to enumerate devices.
.SS Runners
.sp
Runners are purely master\-side execution sequences.
.SS SDB
.INDENT 0.0
.IP \(bu 2
\fI\%Writing SDB Modules\fP
.UNINDENT
.sp
SDB is a way to store data that\(aqs not associated with a minion. See
\fI\%Storing Data in Other Databases\fP\&.
.SS Serializer
.sp
Primarily used with \fI\%file.serialize\fP\&.
.SS State
.sp
State modules are used to define the state interfaces used by Salt States.
These modules are restrictive in that they must follow a number of rules to
function properly.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
State modules define the available routines in sls files. If calling
an execution module directly is desired, take a look at the \fImodule\fP
state.
.UNINDENT
.UNINDENT
.SS SPM pkgdb
.INDENT 0.0
.IP \(bu 2
\fI\%SPM Development Guide: Package Database\fP
.UNINDENT
.sp
pkgdb modules provides storage backends to the package database.
.SS SPM pkgfiles
.INDENT 0.0
.IP \(bu 2
\fI\%SPM Development Guide: Package Database\fP
.UNINDENT
.sp
pkgfiles modules handle the actual installation.
.SS SSH Wrapper
.SS SSH Wrapper
.SS Salt\-SSH Background
.sp
Salt\-SSH works by creating a tar ball of salt, a bunch of python modules, and a generated
short minion config. It then copies this onto the destination host over ssh, then
uses that host\(aqs local python install to run \fBsalt\-client \-\-local\fP with any requested modules.
It does not automatically copy over states or cache files and since it is uses a local file_client,
modules that rely on \fI\%cp.cache*\fP functionality do not work.
.SS SSH Wrapper modules
.sp
To support cp modules or other functionality which might not otherwise work in the remote environment,
a wrapper module can be created. These modules are run from the salt\-master initiating the salt\-ssh
command and can include logic to support the needed functionality. SSH Wrapper modules are located in
/salt/client/ssh/wrapper/ and are named the same as the execution module being extended. Any functions
defined inside of the wrapper module are called from the \fBsalt\-ssh module.function argument\fP
command rather than executing on the minion.
.SS State Module example
.sp
Running salt states on an salt\-ssh minion, obviously requires the state files themselves. To support this,
a state module wrapper script exists at salt/client/ssh/wrapper/state.py, and includes standard state
functions like \fBapply\fP, \fI\%sls\fP,
and \fI\%highstate\fP\&. When executing \fBsalt\-ssh minion state.highstate\fP,
these wrapper functions are used and include the logic to walk the low_state output for that minion to
determine files used, gather needed files, tar them together, transfer the tar file to the minion over
ssh, and run a state on the ssh minion. This state then extracts the tar file, applies the needed states
and data, and cleans up the transferred files.
.SS Wrapper Handling
.sp
From the wrapper script any invocations of \fB__salt__[\(aqsome.module\(aq]()\fP do not run on the master
which is running the wrapper, but instead magically are invoked on the minion over ssh.
Should the function being called exist in the wrapper, the wrapper function will be
used instead.
.sp
One way of supporting this workflow may be to create a wrapper function which performs the needed file
copy operations. Now that files are resident on the ssh minion, the next step is to run the original
execution module function. But since that function name was already overridden by the wrapper, a
function alias can be created in the original execution module, which can then be called from the
wrapper.
.SS Example
.sp
The saltcheck module needs sls and tst files on the minion to function. The invocation of
\fI\%saltcheck.run_state_tests\fP is run from
the wrapper module, and is responsible for performing the needed file copy. The
\fI\%saltcheck\fP execution module includes an alias line of
\fBrun_state_tests_ssh = salt.utils.functools.alias_function(run_state_tests, \(aqrun_state_tests_ssh\(aq)\fP
which creates an alias of \fBrun_state_tests\fP with the name \fBrun_state_tests_ssh\fP\&. At the end of
the \fBrun_state_tests\fP function in the wrapper module, it then calls
\fB__salt__[\(aqsaltcheck.run_state_tests_ssh\(aq]()\fP\&. Since this function does not exist in the wrapper script,
the call is made on the remote minion, which then having the needed files, runs as expected.
.sp
Replacement execution modules for \fI\%Salt SSH\fP\&.
.SS Thorium
.sp
Modules for use in the \fI\%Thorium\fP event reactor.
.SS Tokens
.sp
Token stores for \fI\%External Authentication\fP\&. See the
\fBsalt.tokens\fP docstring for details.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The runner to load tokens modules is
\fI\%saltutil.sync_eauth_tokens\fP\&.
.UNINDENT
.UNINDENT
.SS Tops
.sp
Tops modules are used to convert external data sources into top file data for
the state system.
.SS Util
.sp
Just utility modules to use with other modules via \fB__utils__\fP (see
\fI\%Dunder Dictionaries\fP).
.SS Wheel
.sp
The wheel system is used to manage master side management routines. These
routines are primarily intended for the API to enable master configuration.
.SS Salt Extend
.sp
\fBsalt\-extend\fP is a templating tool for extending SaltStack. If you\(aqre looking to add a module to
SaltStack, then the \fBsalt\-extend\fP utility can guide you through the process.
.sp
You can use Salt Extend to quickly create templated modules for adding new behaviours to some of the module subsystems within Salt.
.sp
Salt Extend takes a template directory and merges it into a SaltStack source code directory.
.SS Command line usage
.sp
\fISee\fP \fI\%salt\-extend\fP
.SS Choosing a template
.sp
The following templates are available:
.SS module
.sp
Creates a new execution module within salt/modules/{{module_name}}.py
.SS module_unit
.sp
Creates a new execution module unit test suite within tests/unit/modules/test_{{module_name}}.py
.SS state
.sp
Creates a new state module within salt/states/{{module_name}}.py
.SS state_unit
.sp
Creates a new state module unit test suite within tests/unit/states/test_{{module_name}}.py
.SS Adding templates
.INDENT 0.0
.IP 1. 3
Create a directory under <src>/templates
.IP 2. 3
Create a file \fBtemplate.yml\fP containing properties for
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBdescription\fP \- a description of the template
.IP \(bu 2
\fBquestions\fP \- a collection of additional questions to ask the user, the name of the item will
be used as the key in the context dictionary within the jinja template.
.INDENT 2.0
.IP \(bu 2
\fBquestion\fP \- The question to ask the user, as a string
.IP \(bu 2
\fBdefault\fP \- (optional) the default value, can contain Jinja2 template syntax and has access to the default context properties
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Example template.yml
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
description: \(dqExecution module\(dq
questions:
    depending_libraries:
        question: \(dqWhat libraries does this module depend upon?\(dq
    virtual_name:
        question: \(dqWhat module virtual name to use?\(dq
        default: \(dq{{module_name}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 3. 3
Create the files within <src>/templates/<your template> to match the target
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
File names can contain Jinja 2 template syntax, e.g. \fI\(aq{{module_name}}.py}}\(aq\fP
.UNINDENT
.UNINDENT
.SS Example file in the template directory
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
print(\(dqHello {{module_name}}\(dq)
__virtual__ = \(dq{{__virtual_name__}}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Default context properties
.sp
The default context provides the following properties
.INDENT 0.0
.IP \(bu 2
\fBdescription\fP \- A description of the template
.IP \(bu 2
\fBshort_description\fP \- A short description of the module as entered by the user
.IP \(bu 2
\fBversion\fP \- The version name of the next release
.IP \(bu 2
\fBmodule_name\fP \- The module name as entered by the user
.IP \(bu 2
\fBrelease_date\fP \- The current date in the format \fIYYYY\-MM\-DD\fP
.IP \(bu 2
\fByear\fP \- The current year in the format \fIYYYY\fP
.UNINDENT
.sp
As well as any additional properties entered from the questions section of \fBtemplate.yml\fP
.SS API
.SS salt.utils.extend module
.SS SaltStack Extend
.sp
A templating tool for extending SaltStack.
.sp
Takes a template directory and merges it into a SaltStack source code
directory. This tool uses Jinja2 for templating.
.sp
This tool is accessed using \fIsalt\-extend\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B codeauthor
Anthony Shaw <\fI\%anthonyshaw@apache.org\fP>
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.utils.extend.apply_template(template_dir, output_dir, context)
Apply the template from the template directory to the output
using the supplied context dict.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsrc\fP (\fBstr\fP) \-\- The source path
.IP \(bu 2
\fBdst\fP (\fBstr\fP) \-\- The destination path
.IP \(bu 2
\fBcontext\fP (\fBdict\fP) \-\- The dictionary to inject into the Jinja template as context
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.utils.extend.run(extension=None, name=None, description=None, salt_dir=None, merge=False, temp_dir=None)
A template factory for extending the salt ecosystem
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBextension\fP (\fBstr\fP) \-\- The extension type, e.g. \(aqmodule\(aq, \(aqstate\(aq, if omitted, user will be prompted
.IP \(bu 2
\fBname\fP (\fBstr\fP) \-\- Python\-friendly name for the module, if omitted, user will be prompted
.IP \(bu 2
\fBdescription\fP (\fBstr\fP) \-\- A description of the extension, if omitted, user will be prompted
.IP \(bu 2
\fBsalt_dir\fP (\fBstr\fP) \-\- The targeted Salt source directory
.IP \(bu 2
\fBmerge\fP (\fBbool\fP) \-\- Merge with salt directory, \fIFalse\fP to keep separate, \fITrue\fP to merge trees.
.IP \(bu 2
\fBtemp_dir\fP (\fBstr\fP) \-\- The directory for generated code, if omitted, system temp will be used
.UNINDENT
.UNINDENT
.UNINDENT
.SS Salt\(aqs Test Suite
.sp
Salt comes with a powerful integration and unit test suite allowing for
the fully automated run of integration and/or unit tests from a single
interface. It uses the combination of pytest and nox to run these tests.
Nox is used to manage all of the test python dependencies.
When you run the test runner with nox, you will be installing the same
python dependencies that we use to run our test suite on PRs and branch tests.
.sp
To learn the basics of how Salt\(aqs test suite works, be sure to check
out the \fI\%Salt\(aqs Test Suite: An Introduction\fP
tutorial.
.SS Nox
.sp
Nox is used to manage all of the python dependencies used in the test suite
and spins up the different nox sessions. You can look at the \fBnoxfile.py\fP
in the salt repo to view all of the current nox configurations. In that file
you will notice various nox sessions. When creating each of these sessions,
nox will create a virtualenv with the specified interpreter. Once the virtualenv
is created it will also install all of the required python dependencies
required for that session and run the tests.
.sp
For example if you want to run all of the tests using the zeromq transport on
python3 you would need to specify the zeromq transport and python3.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-zeromq\-3(coverage=False)\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And because zeromq is the default transport, the following nox session can also be used:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-zeromq\-3(coverage=False)\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To run all the tests but on the tcp transport, you would need to specify the tcp session.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-tcp\-3(coverage=False)\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As a contrast, when using the deprecated \fBruntests.py\fP test runner, the
command would be:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqruntests\-tcp\-3(coverage=False)\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can view all available sessions by running:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-\-list\-sessions
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For the most part you will only need nox to run the test suite, as this tool
will install the exact same python dependencies we use to run on our test runs.
The exception to this is when a system dependency is required, for example \fBmysql\fP\&.
These system dependencies are installed with sls states managed in the \fI\%salt\-ci\-images\fP
repo or you can manually install the dependency yourself.
.SS System Dependencies
.sp
The system dependencies are installed from the \fI\%salt\-ci\-images\fP repo. The
\fBgolden\-images\-provision\fP state is what is run to determine what dependencies
to install on which platform.
We run this state only when we want to update our current VM images with new
dependencies.
.SS Test Directory Structure
.sp
Salt\(aqs test suite is located in the \fBtests/\fP directory in the root of
Salt\(aqs codebase.
.sp
With the migration to PyTest, Salt has created a separate directory for tests
that are written taking advantage of the full potential of PyTest. These are
located under \fBtests/pytests\fP\&.
.sp
As for the old test suite, it is divided into two main groups:
.INDENT 0.0
.IP \(bu 2
\fI\%Integration Tests\fP
.IP \(bu 2
\fI\%Unit Tests\fP
.UNINDENT
.sp
Within each of these groups, the directory structure roughly mirrors the
structure of Salt\(aqs own codebase. Notice that there are directories for
\fBstates\fP, \fBmodules\fP, \fBrunners\fP, \fBoutput\fP, and more in each testing
group.
.sp
The files that are housed in the \fBmodules\fP directory of either the unit
or the integration testing factions contain respective integration or unit
test files for Salt execution modules.
.sp
The PyTest only tests under \fBtests/pytests\fP should, more or less, follow the
same grouping as the old test suite.
.SS Integration Tests
.sp
The Integration section of Salt\(aqs test suite start up a number of Salt
daemons to test functionality in a live environment. These daemons
include two Salt Masters, one Syndic, and two Minions. This allows the
Syndic interface to be tested and Master/Minion communication to be
verified. All of the integration tests are executed as live Salt commands
sent through the started daemons.
.sp
Integration tests are particularly good at testing modules, states, and
shell commands, among other segments of Salt\(aqs ecosystem. By utilizing
the integration test daemons, integration tests are easy to write. They
are also SaltStack\(aqs generally preferred method of adding new tests.
.sp
The discussion in the \fI\%Integration vs. Unit\fP
section of the \fI\%testing tutorial\fP is
beneficial in learning why you might want to write integration tests
vs. unit tests. Both testing arenas add value to Salt\(aqs test suite and
you should consider adding both types of tests if possible and appropriate
when contributing to Salt.
.INDENT 0.0
.IP \(bu 2
\fI\%Integration Test Documentation\fP
.UNINDENT
.SS Unit Tests
.sp
Unit tests do not spin up any Salt daemons, but instead find their value
in testing singular implementations of individual functions. Instead of
testing against specific interactions, unit tests should be used to test
a function\(aqs logic as well as any \fBreturn\fP or \fBraises\fP statements.
Unit tests also rely heavily on mocking external resources.
.sp
The discussion in the \fI\%Integration vs. Unit\fP
section of the \fI\%testing tutorial\fP is useful
in determining when you should consider writing unit tests instead of,
or in addition to, integration tests when contributing to Salt.
.INDENT 0.0
.IP \(bu 2
\fI\%Unit Test Documentation\fP
.UNINDENT
.SS Running The Tests
.sp
There is only one requirement to install, to quickly get started
running salt\(aqs test suite: \fBnox\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install nox
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once this requirement is installed, you can use the \fBnox\fP binary to run
all of the tests included in Salt\(aqs test suite:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-3(coverage=False)\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For more information about options you can pass the test runner, see the
\fB\-\-help\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-3(coverage=False)\(aq \-\- \-\-help
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Running Test Subsections
.sp
Instead of running the entire test suite all at once, which can take a long time,
there are several ways to run only specific groups of tests or individual tests:
.INDENT 0.0
.IP \(bu 2
Run \fI\%unit tests only\fP: \fBnox \-e
\(aqtest\-3(coverage=False)\(aq \-\- tests/unit/\fP\&.
.IP \(bu 2
Run unit and integration tests for states: \fBnox \-e
\(aqtest\-3(coverage=False)\(aq \-\- tests/unit/states/ tests/integration/states/\fP\&.
.IP \(bu 2
Run integration tests for an individual module: \fBnox \-e \(aqtest\-3(coverage=False)\(aq \-\-
tests/pytests/integration/modules/test_virt.py\fP\&.
.IP \(bu 2
Run unit tests for an individual module: \fBnox \-e \(aqtest\-3(coverage=False)\(aq \-\-
tests/unit/modules/test_virt.py\fP\&.
.IP \(bu 2
Run an individual test by using the class and test name (this example is for the
\fBtest_default_kvm_profile\fP test in the \fBtests/pytests/integration/module/test_virt.py\fP):
\fBnox \-e \(aqtest\-3(coverage=False)\(aq \-\-
tests/pytests/integration/modules/test_virt.py::VirtTest::test_default_kvm_profile\fP\&.
.UNINDENT
.sp
For more specific examples of how to run various test subsections or individual
tests, please see the \fI\%pytest\fP documentation on how to run specific tests or
the \fI\%Running Specific Tests\fP
section of the \fI\%Salt\(aqs Test Suite: An Introduction\fP
tutorial.
.SS Running Unit Tests Without Integration Test Daemons
.sp
Since the unit tests do not require a master or minion to execute, it is often useful to be able to
run unit tests individually, or as a whole group, without having to start up the integration testing
daemons. Starting up the master, minion, and syndic daemons takes a lot of time before the tests can
even start running and is unnecessary to run unit tests. To run unit tests without invoking the
integration test daemons, simply add the unit directory as an argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-3(coverage=False)\(aq \-\- tests/unit/
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
All of the other options to run individual tests, entire classes of tests, or
entire test modules still apply.
.SS Running Destructive Integration Tests
.sp
Salt is used to change the settings and behavior of systems. In order to
effectively test Salt\(aqs functionality, some integration tests are written to
make actual changes to the underlying system. These tests are referred to as
\(dqdestructive tests\(dq. Some examples of destructive tests are changes may be
testing the addition of a user or installing packages. By default,
destructive tests are disabled and will be skipped.
.sp
Generally, destructive tests should clean up after themselves by attempting to
restore the system to its original state. For instance, if a new user is created
during a test, the user should be deleted after the related test(s) have
completed. However, no guarantees are made that test clean\-up will complete
successfully. Therefore, running destructive tests should be done with caution.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Running destructive tests will change the underlying system.
Use caution when running destructive tests.
.UNINDENT
.UNINDENT
.sp
To run tests marked as destructive, set the \fB\-\-run\-destructive\fP flag:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-3(coverage=False)\(aq \-\- \-\-run\-destructive
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Running Cloud Provider Tests
.sp
Salt\(aqs testing suite also includes integration tests to assess the successful
creation and deletion of cloud instances using \fI\%Salt\-Cloud\fP for
providers supported by Salt\-Cloud.
.sp
The cloud provider tests are off by default and run on sample configuration files
provided in \fBtests/integration/files/conf/cloud.providers.d/\fP\&. In order to run
the cloud provider tests, valid credentials, which differ per provider, must be
supplied. Each credential item that must be supplied is indicated by an empty
string value and should be edited by the user before running the tests. For
example, DigitalOcean requires a client key and an api key to operate. Therefore,
the default cloud provider configuration file for DigitalOcean looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
digitalocean\-config:
  driver: digitalocean
  client_key: \(aq\(aq
  api_key: \(aq\(aq
  location: New York 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As indicated by the empty string values, the \fBclient_key\fP and the \fBapi_key\fP
must be provided:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
digitalocean\-config:
  driver: digitalocean
  client_key: wFGEwgregeqw3435gDger
  api_key: GDE43t43REGTrkilg43934t34qT43t4dgegerGEgg
  location: New York 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When providing credential information in cloud provider configuration files,
do not include the single quotes.
.UNINDENT
.UNINDENT
.sp
Once all of the valid credentials for the cloud provider have been supplied, the
cloud provider tests can be run like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-cloud\-3(coverage=False)\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Automated Test Runs
.sp
SaltStack maintains a Jenkins server to allow for the execution of tests
across supported platforms. The tests executed from Salt\(aqs Jenkins server
create fresh virtual machines for each test run, then execute destructive
tests on the new, clean virtual machine.
.sp
SaltStack\(aqs Jenkins server continuously runs the entire test suite,
including destructive tests, on an array of various supported operating
systems throughout the day. Each actively supported branch of Salt\(aqs
repository runs the tests located in the respective branch\(aqs code. Each set
of branch tests also includes a pylint run. These branch tests help ensure
the viability of Salt code at any given point in time as pull requests
are merged into branches throughout the day.
.sp
In addition to branch tests, SaltStack\(aqs Jenkins server also runs tests
on pull requests. These pull request tests include a smaller set of
virtual machines that run on the branch tests. The pull request tests,
like the branch tests, include a pylint test as well.
.sp
When a pull request is submitted to Salt\(aqs repository on GitHub, the suite
of pull request tests are started by Jenkins. These tests are used to
gauge the pull request\(aqs viability to merge into Salt\(aqs codebase. If these
initial tests pass, the pull request can then merged into the Salt branch
by one of Salt\(aqs core developers, pending their discretion. If the initial
tests fail, core developers may request changes to the pull request. If the
failure is unrelated to the changes in question, core developers may merge
the pull request despite the initial failure.
.sp
As soon as the pull request is merged, the changes will be added to the
next branch test run on Jenkins.
.sp
For a full list of currently running test environments, go to
\fI\%https://jenkins.saltproject.io\fP\&.
.SS Using Salt\-Cloud on Jenkins
.sp
For testing Salt on Jenkins, SaltStack uses \fI\%Salt\-Cloud\fP to
spin up virtual machines. The script using Salt\-Cloud to accomplish this is
open source and can be found here: \fI\%tests/jenkins.py\fP
.SS Writing Tests
.sp
The salt testing infrastructure is divided into two classes of tests,
integration tests and unit tests. These terms may be defined differently in
other contexts, but for Salt they are defined this way:
.INDENT 0.0
.IP \(bu 2
Unit Test: Tests which validate isolated code blocks and do not require
external interfaces such as \fBsalt\-call\fP or any of the salt daemons.
.IP \(bu 2
Integration Test: Tests which validate externally accessible features.
.UNINDENT
.sp
Salt testing uses unittest2 from the python standard library and MagicMock.
.INDENT 0.0
.IP \(bu 2
\fI\%Writing integration tests\fP
.IP \(bu 2
\fI\%Writing unit tests\fP
.UNINDENT
.SS Naming Conventions
.sp
Any function in either integration test files or unit test files that is doing
the actual testing, such as functions containing assertions, must start with
\fBtest_\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def test_user_present(self): ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When functions in test files are not prepended with \fBtest_\fP, the function
acts as a normal, helper function and is not run as a test by the test suite.
.SS Submitting New Tests
.sp
Which branch of the Salt codebase should new tests be written against? The location
of where new tests should be submitted depends largely on the reason you\(aqre writing
the tests.
.SS Tests for New Features
.sp
If you are adding new functionality to Salt, please write the tests for this new
feature in the same pull request as the new feature. New features should always be
submitted to the \fBmaster\fP branch.
.sp
If you have already submitted the new feature, but did not write tests in the original
pull request that has already been merged, please feel free to submit a new pull
request containing tests. If the feature was recently added to Salt\(aqs \fBmaster\fP
branch, then the tests should be added there as well. However, if the feature was
added to \fBmaster\fP some time ago and is already present in one or more release
branches, please refer to the \fI\%Tests for Entire Files or Functions\fP section below
for more details about where to submit tests for functions or files that do not
already have tests.
.SS Tests to Accompany a Bugfix
.sp
If you are writing tests for code that fixes a bug in Salt, tests will be
required before merging the PR. A great option for most bugfixes is to adopt a
TDD style approach:
.INDENT 0.0
.IP \(bu 2
reproduce the issue
.IP \(bu 2
write a test that exhibits the behavior
.IP \(bu 2
write the bugfix
.UNINDENT
.sp
This helps ensure that known issues are not reintroduced into the codebase.
.SS Tests for Entire Files or Functions
.sp
Sometimes entire files in Salt are completely untested. If you are writing tests for
a file that doesn\(aqt have any tests written for it, write your test against the
earliest supported release branch that contains the file or function you\(aqre testing.
.sp
Once your tests are submitted in a pull request and is merged into the branch in
question, the tests you wrote will be merged\-forward by SaltStack core engineers and
the new tests will propagate to the newer release branches. That way the tests you
wrote will apply to all current and relevant release branches, and not just the \fBmaster\fP
branch, for example. This methodology will help protect against regressions on older
files in Salt\(aqs codebase.
.sp
There may be times when the tests you write against an older branch fail in the
merge\-forward process because functionality has changed in newer release branches.
In these cases, a Salt core developer may reach out to you for advice on the tests in
question if the path forward is unclear.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If tests are written against a file in an older release branch and then merged forward,
there may be new functionality in the file that is present in the new release branch
that is untested.It would be wise to see if new functionality could use additional
testing once the test file has propagated to newer release branches.
.UNINDENT
.UNINDENT
.SS Module/Global Level Variables
.sp
If you need access to module or global level variables, please use a pytest fixture. The
use of module and global variables can introduce mutable global objects and increases
processing time because all globals are evaluated when collecting tests. If there is a use
case where you cannot use a fixture and you are using a type of string, integer, or tuple
you can use global/module level variables. Any mutable types such as lists and dictionaries must
use pytest fixtures. For an example, if all of your tests need access to a string variable:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
FOO = \(dqbar\(dq


def test_foo_bar():
    assert FOO == \(dqbar\(dq


def test_foo_not():
    assert not FOO == \(dqfoo\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
We recommend using a pytest fixture:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import pytest


@pytest.fixture()
def foo():
    return \(dqbar\(dq


def test_foo_bar(foo):
    assert foo == \(dqbar\(dq


def test_foo_not(foo):
    assert not foo == \(dqfoo\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you need a class to mock something, it can be defined at the global scope,
but it should only be initialized on the fixture:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
class Foo:
    def __init__(self):
        self.bar = True


@pytest.fixture
def foo():
    return Foo()
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Test Helpers
.sp
Several Salt\-specific helpers are available. A full list is available by inspecting
functions exported under \fItests/support/*.py\fP\&.
.SS Test Markers
.sp
\fI@pytest.mark.expensive_test\fP \-\- Designates a test which typically requires a
relatively costly external resource, like a cloud virtual machine. This decorator
is not normally used by developers outside of the Salt core team.
.sp
\fI@pytest.mark.destructive_test\fP \-\- Marks a test as potentially destructive. It
will not be run unless the \fB\-\-run\-destructive\fP flag is expressly passed.
.sp
\fI@pytest.mark.requires_network\fP \-\- Requires a network connection for the test to
operate successfully. If a network connection is not detected, the test will not run.
.sp
These are just a small preview of the supported marker. For a full listing, please
run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-3(coverage=False)\(aq \-\- \-\-markers
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Integration Tests
.sp
The Salt integration tests come with a number of classes and methods which
allow for components to be easily tested. These classes are generally inherited
from and provide specific methods for hooking into the running integration test
environment created by the integration tests.
.sp
It is noteworthy that since integration tests validate against a running
environment that they are generally the preferred means to write tests.
.sp
The integration system is all located under \fBtests/integration\fP in the Salt
source tree. Each directory within \fBtests/integration\fP corresponds to a
directory in Salt\(aqs tree structure. For example, the integration tests for the
\fBtest.py\fP Salt module that is located in \fBsalt/modules\fP should also be
named \fBtest.py\fP and reside in \fBtests/integration/modules\fP\&.
.SS Preparing to Write Integration Tests
.sp
This guide assumes that your Salt development environment is already configured
and that you have a basic understanding of contributing to the Salt codebase.
If you\(aqre unfamiliar with either of these topics, please refer to the
\fI\%Installing Salt for Development\fP and the
\fI\%Contributing\fP pages, respectively.
.sp
This documentation also assumes that you have an understanding of how to
\fI\%run Salt\(aqs test suite\fP, including running the
\fI\%test subsections\fP, and running a single
integration test file, class, or individual test.
.SS Best Practices
.sp
Integration tests should be written to the following specifications.
.SS What to Test?
.sp
Since integration tests are used to validate against a running Salt environment,
integration tests should be written with the Salt components, and their various
interactions, in mind.
.INDENT 0.0
.IP \(bu 2
Isolate testing functionality. Don\(aqt rely on the pass or failure of other,
separate tests.
.IP \(bu 2
Individual tests should test against a single behavior.
.IP \(bu 2
Since it occasionally takes some effort to \(dqset up\(dq an individual test, it may
be necessary to call several functions within a single test. However, be sure
that once the work has been done to set up a test, make sure you are clear
about the functionality that is being tested.
.UNINDENT
.SS Naming Conventions
.sp
Test names and docstrings should indicate what functionality is being tested.
Test functions are named \fBtest_<fcn>_<test\-name>\fP where \fB<fcn>\fP is the
function being tested and \fB<test\-name>\fP describes the behavior being tested.
.sp
In order for integration tests to get picked up during a run of the test suite,
each individual test must be prepended with the \fBtest_\fP naming syntax, as
described above.
.sp
If a function does not start with \fBtest_\fP, then the function acts as a \(dqnormal\(dq
function and is not considered a testing function. It will not be included in the
test run or testing output.
.SS The setUp and tearDown Functions
.sp
There are two special functions that can be utilized in the integration side of
Salt\(aqs test suite: \fBsetUp\fP and \fBtearDown\fP\&. While these functions are not
required in all test files, there are many examples in Salt\(aqs integration
test suite illustrating the broad usefulness of each function.
.sp
The \fBsetUp\fP function is used to set up any repetitive or useful tasks that the
tests in a test class need before running. For example, any of the \fBmac_*\fP
integration tests should only run on macOS machines. The \fBsetUp\fP function can
be used to test for the presence of the \fBDarwin\fP kernel. If the \fBDarwin\fP
kernel is not present, then the test should be skipped.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def setUp(self):
    \(dq\(dq\(dq
    Sets up test requirements
    \(dq\(dq\(dq
    os_grain = self.run_function(\(dqgrains.item\(dq, [\(dqkernel\(dq])
    if os_grain[\(dqkernel\(dq] not in \(dqDarwin\(dq:
        self.skipTest(\(dqTest not applicable to \(aq{kernel}\(aq kernel\(dq.format(**os_grain))
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBsetUp\fP function can be used for many things. The above code snippet is
only one example. Another example might be to ensure that a particular setting
is present before running tests that would require the setting.
.sp
The \fBtearDown\fP function is used to clean up after any tests. This function is
useful for restoring any settings that might have been changed during the test
run.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fBsetUp\fP and \fBtearDown\fP functions run before and after each test
in the test class that the \fBsetUp\fP and \fBtearDown\fP functions are defined.
.UNINDENT
.UNINDENT
.sp
Be sure to read the \fI\%Destructive vs Non\-Destructive Tests\fP section when
using any kind of destructive functions that might alter the system running the
test suite in either the \fBsetUp\fP or \fBtearDown\fP function definitions.
.SS Testing Order
.sp
The test functions within a test class do not run in the order they were defined,
but instead run in lexicographical order.
.sp
Note that if any \fBsetUp\fP or \fBtearDown\fP functions are defined in the class,
those functions will run before (for \fBsetUp\fP) or after (for \fBtearDown\fP) each
test case.
.SS Integration Classes
.sp
The integration classes are located in \fBtests/integration/__init__.py\fP and
can be extended therein. There are four classes available to extend:
.INDENT 0.0
.IP \(bu 2
\fI\%ModuleCase\fP
.IP \(bu 2
\fI\%ShellCase\fP
.IP \(bu 2
\fI\%SSHCase\fP
.IP \(bu 2
\fI\%SyndicCase\fP
.UNINDENT
.SS ModuleCase
.sp
Used to define executions run via the master to minions and to call
single modules and states. The available testing functions are:
.SS run_function
.sp
Run a single salt function and condition the return down to match the
behavior of the raw function call. This will run the command and only
return the results from a single minion to verify.
.SS run_state
.sp
Run the state.single command and return the state return structure.
.SS minion_run
.sp
Run a single salt function on the \(aqminion\(aq target and condition the
return down to match the behavior of the raw function call.
.SS ShellCase
.sp
Shell out to the scripts which ship with Salt. The testing functions are:
.SS run_cp
.sp
Execute salt\-cp. Pass in the argument string as it would be
passed on the command line.
.SS run_call
.sp
Execute salt\-call, pass in the argument string as it would be
passed on the command line.
.SS run_cloud
.sp
Execute the salt\-cloud command. Pass in the argument string as
it would be passed on the command line.
.SS run_key
.sp
Execute the salt\-key command. Pass in the argument string as it
would be passed on the command line.
.SS run_run
.sp
Execute the salt\-run command. Pass in the argument string as it
would be passed on the command line.
.SS run_run_plus
.sp
Execute the runner function the and return the return data and output in a dict
.SS run_salt
.sp
Execute the salt command. Pass in the argument string as it would be
passed on the command line.
.SS run_script
.sp
Execute a salt script with the given argument string.
.SS run_ssh
.sp
Execute the salt\-ssh. Pass in the argument string as it would be
passed on the command line.
.SS SSHCase
.sp
Used to execute remote commands via salt\-ssh. The available methods are
as follows:
.SS run_function
.sp
Run a single salt function via salt\-ssh and condition the return down to
match the behavior of the raw function call. This will run the command
and only return the results from a single minion to verify.
.SS SyndicCase
.sp
Used to execute remote commands via a syndic and is only used to verify
the capabilities of the Salt Syndic. The available methods are as follows:
.SS run_function
.sp
Run a single salt function and condition the return down to match the
behavior of the raw function call. This will run the command and only
return the results from a single minion to verify.
.SS Examples
.sp
The following sections define simple integration tests present in Salt\(aqs
integration test suite for each type of testing class.
.SS Module Example via ModuleCase Class
.sp
Import the integration module, this module is already added to the python path
by the test execution. Inherit from the \fBintegration.ModuleCase\fP class.
.sp
Now the workhorse method \fBrun_function\fP can be used to test a module:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import os
from tests.support.case import ModuleCase


class TestModuleTest(ModuleCase):
    \(dq\(dq\(dq
    Validate the test module
    \(dq\(dq\(dq

    def test_ping(self):
        \(dq\(dq\(dq
        test.ping
        \(dq\(dq\(dq
        self.assertTrue(self.run_function(\(dqtest.ping\(dq))

    def test_echo(self):
        \(dq\(dq\(dq
        test.echo
        \(dq\(dq\(dq
        self.assertEqual(self.run_function(\(dqtest.echo\(dq, [\(dqtext\(dq]), \(dqtext\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The fist example illustrates the testing master issuing a \fBtest.ping\fP call
to a testing minion. The test asserts that the minion returned with a \fBTrue\fP
value to the master from the \fBtest.ping\fP call.
.sp
The second example similarly verifies that the minion executed the
\fBtest.echo\fP command with the \fBtext\fP argument. The \fBassertEqual\fP call
maintains that the minion ran the function and returned the data as expected
to the master.
.SS Shell Example via ShellCase
.sp
Validating the shell commands can be done via shell tests:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import sys
import shutil
import tempfile

from tests.support.case import ShellCase


class KeyTest(ShellCase):
    \(dq\(dq\(dq
    Test salt\-key script
    \(dq\(dq\(dq

    _call_binary_ = \(dqsalt\-key\(dq

    def test_list(self):
        \(dq\(dq\(dq
        test salt\-key \-L
        \(dq\(dq\(dq
        data = self.run_key(\(dq\-L\(dq)
        expect = [
            \(dqUnaccepted Keys:\(dq,
            \(dqAccepted Keys:\(dq,
            \(dqminion\(dq,
            \(dqsub_minion\(dq,
            \(dqRejected:\(dq,
            \(dq\(dq,
        ]
        self.assertEqual(data, expect)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example verifies that the \fBsalt\-key\fP command executes and returns as
expected by making use of the \fBrun_key\fP method.
.SS SSH Example via SSHCase
.sp
Testing salt\-ssh functionality can be done using the SSHCase test class:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from tests.support.case import SSHCase


class SSHGrainsTest(SSHCase):
    \(dq\(dq\(dq
    Test salt\-ssh grains functionality
    Depend on proper environment set by integration.SSHCase class
    \(dq\(dq\(dq

    def test_grains_id(self):
        \(dq\(dq\(dq
        Test salt\-ssh grains id work for localhost.
        \(dq\(dq\(dq
        cmd = self.run_function(\(dqgrains.get\(dq, [\(dqid\(dq])
        self.assertEqual(cmd, \(dqlocalhost\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Testing Event System via SaltMinionEventAssertsMixin
.sp
The fundamentially asynchronous nature of Salt makes testing the event system a challenge.
The \fBSaltMinionEventAssertsMixin\fP provides a facility for testing that events were received
on a minion event bus.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.utils.event
from tests.support.mixins import SaltEventAssertsMixin


class TestEvent(SaltEventAssertsMixin):
    \(dq\(dq\(dq
    Example test of firing an event and receiving it
    \(dq\(dq\(dq

    def test_event(self):
        e = salt.utils.event.get_event(
            \(dqminion\(dq, sock_dir=self.minion_opts[\(dqsock_dir\(dq], opts=self.minion_opts
        )

        e.fire_event({\(dqa\(dq: \(dqb\(dq}, \(dq/test_event\(dq)

        self.assertMinionEventReceived({\(dqa\(dq: \(dqb\(dq})
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Syndic Example via SyndicCase
.sp
Testing Salt\(aqs Syndic can be done via the SyndicCase test class:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from tests.support.case import SyndicCase


class TestSyndic(SyndicCase):
    \(dq\(dq\(dq
    Validate the syndic interface by testing the test module
    \(dq\(dq\(dq

    def test_ping(self):
        \(dq\(dq\(dq
        test.ping
        \(dq\(dq\(dq
        self.assertTrue(self.run_function(\(dqtest.ping\(dq))
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example verifies that a \fBtest.ping\fP command is issued from the testing
master, is passed through to the testing syndic, down to the minion, and back
up again by using the \fBrun_function\fP located with in the \fBSyndicCase\fP test
class.
.SS Integration Test Files
.sp
Since using Salt largely involves configuring states, editing files, and changing
system data, the integration test suite contains a directory named \fBfiles\fP to
aid in testing functions that require files. Various Salt integration tests use
these example files to test against instead of altering system files and data.
.sp
Each directory within \fBtests/integration/files\fP contain files that accomplish
different tasks, based on the needs of the integration tests using those files.
For example, \fBtests/integration/files/ssh\fP is used to bootstrap the test runner
for salt\-ssh testing, while \fBtests/integration/files/pillar\fP contains files
storing data needed to test various pillar functions.
.sp
The \fBtests/integration/files\fP directory also includes an integration state tree.
The integration state tree can be found at \fBtests/integration/files/file/base\fP\&.
.sp
The following example demonstrates how integration files can be used with ModuleCase
to test states:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Import python libs
from __future__ import absolute_import
import os
import shutil

# Import Salt Testing libs
from tests.support.case import ModuleCase
from tests.support.paths import FILES, TMP
from tests.support.mixins import SaltReturnAssertsMixin

# Import salt libs
import salt.utils.files

HFILE = os.path.join(TMP, \(dqhosts\(dq)


class HostTest(ModuleCase, SaltReturnAssertsMixin):
    \(dq\(dq\(dq
    Validate the host state
    \(dq\(dq\(dq

    def setUp(self):
        shutil.copyfile(os.path.join(FILES, \(dqhosts\(dq), HFILE)
        super(HostTest, self).setUp()

    def tearDown(self):
        if os.path.exists(HFILE):
            os.remove(HFILE)
        super(HostTest, self).tearDown()

    def test_present(self):
        \(dq\(dq\(dq
        host.present
        \(dq\(dq\(dq
        name = \(dqspam.bacon\(dq
        ip = \(dq10.10.10.10\(dq
        ret = self.run_state(\(dqhost.present\(dq, name=name, ip=ip)
        self.assertSaltTrueReturn(ret)
        with salt.utils.files.fopen(HFILE) as fp_:
            output = fp_.read()
            self.assertIn(\(dq{0}\et\et{1}\(dq.format(ip, name), output)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To access the integration files, a variable named \fBFILES\fP points to the
\fBtests/integration/files\fP directory. This is where the referenced
\fBhost.present\fP sls file resides.
.sp
In addition to the static files in the integration state tree, the location
\fBTMP\fP can also be used to store temporary files that the test system
will clean up when the execution finishes.
.SS Destructive vs Non\-Destructive Tests
.sp
Since Salt is used to change the settings and behavior of systems, one testing
approach is to run tests that make actual changes to the underlying system. This
is where the concept of destructive integration tests comes into play. Tests can
be written to alter the system they are running on. This capability is what fills
in the gap needed to properly test aspects of system management like package
installation.
.sp
Any test that changes the underlying system in any way, such as creating or
deleting users, installing packages, or changing permissions should include the
\fB@destructive\fP decorator to signal system changes and should be written with
care. System changes executed within a destructive test should also be restored
once the related tests have completed. For example, if a new user is created to
test a module, the same user should be removed after the test is completed to
maintain system integrity.
.sp
To write a destructive test, import, and use the destructiveTest decorator for
the test method:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from tests.support.case import ModuleCase
from tests.support.helpers import destructiveTest, skip_if_not_root


class DestructiveExampleModuleTest(ModuleCase):
    \(dq\(dq\(dq
    Demonstrate a destructive test
    \(dq\(dq\(dq

    @destructiveTest
    @skip_if_not_root
    def test_user_not_present(self):
        \(dq\(dq\(dq
        This is a DESTRUCTIVE TEST it creates a new user on the minion.
        And then destroys that user.
        \(dq\(dq\(dq
        ret = self.run_state(\(dquser.present\(dq, name=\(dqsalt_test\(dq)
        self.assertSaltTrueReturn(ret)
        ret = self.run_state(\(dquser.absent\(dq, name=\(dqsalt_test\(dq)
        self.assertSaltTrueReturn(ret)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Cloud Provider Tests
.sp
Cloud provider integration tests are used to assess \fI\%Salt\-Cloud\fP\(aqs
ability to create and destroy cloud instances for various supported cloud providers.
Cloud provider tests inherit from the ShellCase Integration Class.
.sp
Any new cloud provider test files should be added to the \fBtests/integration/cloud/providers/\fP
directory. Each cloud provider test file also requires a sample cloud profile and cloud
provider configuration file in the integration test file directory located at
\fBtests/integration/files/conf/cloud.*.d/\fP\&.
.sp
The following is an example of the default profile configuration file for Digital
Ocean, located at: \fBtests/integration/files/conf/cloud.profiles.d/digitalocean.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
digitalocean\-test:
  provider: digitalocean\-config
  image: Ubuntu 14.04 x64
  size: 512MB
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Each cloud provider requires different configuration credentials. Therefore, sensitive
information such as API keys or passwords should be omitted from the cloud provider
configuration file and replaced with an empty string. The necessary credentials can
be provided by the user by editing the provider configuration file before running the
tests.
.sp
The following is an example of the default provider configuration file for Digital
Ocean, located at: \fBtests/integration/files/conf/cloud.providers.d/digitalocean.conf\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
digitalocean\-config:
  driver: digitalocean
  client_key: \(aq\(aq
  api_key: \(aq\(aq
  location: New York 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In addition to providing the necessary cloud profile and provider files in the integration
test suite file structure, appropriate checks for if the configuration files exist and
contain valid information are also required in the test class\(aqs \fBsetUp\fP function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from tests.support.case import ShellCase
from tests.support.paths import FILES


class LinodeTest(ShellCase):
    \(dq\(dq\(dq
    Integration tests for the Linode cloud provider in Salt\-Cloud
    \(dq\(dq\(dq

    def setUp(self):
        \(dq\(dq\(dq
        Sets up the test requirements
        \(dq\(dq\(dq
        super(LinodeTest, self).setUp()

        # check if appropriate cloud provider and profile files are present
        profile_str = \(dqlinode\-config:\(dq
        provider = \(dqlinode\(dq
        providers = self.run_cloud(\(dq\-\-list\-providers\(dq)
        if profile_str not in providers:
            self.skipTest(
                \(dqConfiguration file for {0} was not found. Check {0}.conf files \(dq
                \(dqin tests/integration/files/conf/cloud.*.d/ to run these tests.\(dq.format(
                    provider
                )
            )

        # check if apikey and password are present
        path = os.path.join(FILES, \(dqconf\(dq, \(dqcloud.providers.d\(dq, provider + \(dq.conf\(dq)
        config = cloud_providers_config(path)
        api = config[\(dqlinode\-config\(dq][\(dqlinode\(dq][\(dqapikey\(dq]
        password = config[\(dqlinode\-config\(dq][\(dqlinode\(dq][\(dqpassword\(dq]
        if api == \(dq\(dq or password == \(dq\(dq:
            self.skipTest(
                \(dqAn api key and password must be provided to run these tests. Check \(dq
                \(dqtests/integration/files/conf/cloud.providers.d/{0}.conf\(dq.format(
                    provider
                )
            )
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Repeatedly creating and destroying instances on cloud providers can be costly.
Therefore, cloud provider tests are off by default and do not run automatically. To
run the cloud provider tests, the \fB\-\-cloud\-provider\-tests\fP flag must be provided:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\&./tests/runtests.py \-\-cloud\-provider\-tests
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Since cloud provider tests do not run automatically, all provider tests must be
preceded with the \fB@expensiveTest\fP decorator. The expensive test decorator is
necessary because it signals to the test suite that the
\fB\-\-cloud\-provider\-tests\fP flag is required to run the cloud provider tests.
.sp
To write a cloud provider test, import, and use the expensiveTest decorator for
the test function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from tests.support.helpers import expensiveTest


@expensiveTest
def test_instance(self):
    \(dq\(dq\(dq
    Test creating an instance on Linode
    \(dq\(dq\(dq
    name = \(dqlinode\-testing\(dq

    # create the instance
    instance = self.run_cloud(\(dq\-p linode\-test {0}\(dq.format(name))
    str = \(dq        {0}\(dq.format(name)

    # check if instance with salt installed returned as expected
    try:
        self.assertIn(str, instance)
    except AssertionError:
        self.run_cloud(\(dq\-d {0} \-\-assume\-yes\(dq.format(name))
        raise

    # delete the instance
    delete = self.run_cloud(\(dq\-d {0} \-\-assume\-yes\(dq.format(name))
    str = \(dq            True\(dq
    try:
        self.assertIn(str, delete)
    except AssertionError:
        raise
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Adding New Directories
.sp
If the corresponding Salt directory does not exist within
\fBtests/integration\fP, the new directory must be created along with the
appropriate test file to maintain Salt\(aqs testing directory structure.
.sp
In order for Salt\(aqs test suite to recognize tests within the newly
created directory, options to run the new integration tests must be added to
\fBtests/runtests.py\fP\&. Examples of the necessary options that must be added
can be found here: \fI\%tests/runtests.py\fP\&. The functions that need to be
edited are \fBsetup_additional_options\fP, \fBvalidate_options\fP, and
\fBrun_integration_tests\fP\&.
.SS Writing Unit Tests
.SS Introduction
.sp
Like many software projects, Salt has two broad\-based testing approaches \-\-
integration testing and unit testing. While integration testing focuses on the
interaction between components in a sandboxed environment, unit testing focuses
on the singular implementation of individual functions.
.sp
Unit tests should be used specifically to test a function\(aqs logic. Unit tests
rely on mocking external resources.
.sp
While unit tests are good for ensuring consistent results, they are most
useful when they do not require more than a few mocks. Effort should be
made to mock as many external resources as possible. This effort is encouraged,
but not required. Sometimes the isolation provided by completely mocking the
external dependencies is not worth the effort of mocking those dependencies.
.sp
In these cases, requiring an external library to be installed on the
system before running the test file is a useful way to strike this balance.
For example, the unit tests for the MySQL execution module require the
presence of the MySQL python bindings on the system running the test file
before proceeding to run the tests.
.sp
Overly detailed mocking can also result in decreased test readability and
brittleness as the tests are more likely to fail when the code or its
dependencies legitimately change. In these cases, it is better to add
dependencies to the test runner dependency state.
.SS Preparing to Write a Unit Test
.sp
This guide assumes that your Salt development environment is already configured
and that you have a basic understanding of contributing to the Salt codebase.
If you\(aqre unfamiliar with either of these topics, please refer to the
\fI\%Installing Salt for Development\fP and the
\fI\%Contributing\fP pages, respectively.
.sp
This documentation also assumes that you have an understanding of how to
\fI\%run Salt\(aqs test suite\fP, including running the
\fI\%unit test subsection\fP, running the unit tests
\fI\%without testing daemons\fP to speed up
development wait times, and running a unit test file, class, or individual test.
.SS Best Practices
.sp
Unit tests should be written to the following specifications.
.SS What to Test?
.sp
Since unit testing focuses on the singular implementation of individual functions,
unit tests should be used specifically to test a function\(aqs logic. The following
guidelines should be followed when writing unit tests for Salt\(aqs test suite:
.INDENT 0.0
.IP \(bu 2
Each \fBraise\fP and \fBreturn\fP statement needs to be independently tested.
.IP \(bu 2
Isolate testing functionality. Don\(aqt rely on the pass or failure of other,
separate tests.
.IP \(bu 2
Test functions should contain only one assertion, at most, multiple
assertions can be made, but against the same outcome.
.IP \(bu 2
Many Salt execution modules are merely wrappers for distribution\-specific
functionality. If there isn\(aqt any logic present in a simple execution module,
consider writing an \fI\%integration test\fP instead of
heavily mocking a call to an external dependency.
.UNINDENT
.SS Mocking Test Data
.sp
A reasonable effort needs to be made to mock external resources used in the
code being tested, such as APIs, function calls, external data either
globally available or passed in through function arguments, file data, etc.
.INDENT 0.0
.IP \(bu 2
Test functions should contain only one assertion and all necessary mock code
and data for that assertion.
.IP \(bu 2
External resources should be mocked in order to \(dqblock all of the exits\(dq. If a
test function fails because something in an external library wasn\(aqt mocked
properly (or at all), this test is not addressing all of the \(dqexits\(dq a function
may experience. We want the Salt code and logic to be tested, specifically.
.IP \(bu 2
Consider the fragility and longevity of a test. If the test is so tightly coupled
to the code being tested, this makes a test unnecessarily fragile.
.IP \(bu 2
Make sure you are not mocking the function to be tested so vigorously that the
test return merely tests the mocked output. The test should always be testing
a function\(aqs logic.
.UNINDENT
.SS Mocking Loader Modules
.sp
Salt loader modules use a series of globally available dunder variables,
\fB__salt__\fP, \fB__opts__\fP, \fB__pillar__\fP, etc. To facilitate testing these
modules \fI\%pytest\-salt\-factories\fP has a plugin which will prepare the module globals
by patching and mocking the dunders prior to running each test, as long as the test module
defines a fixture named \fBconfigure_loader_modules\fP\&. Check out the code for the
\fIpytest\-salt\-factories plugin\fP to know how it\(aqs internals work.
.sp
The reason for the existence of this plugin is because historically one would add these dunder
variables directly on the imported module. This, however, introduces unexpected behavior when
running the full test suite since those attributes would not be removed once we were done testing
the module and would therefore leak to other modules being tested with unpredictable results. This
is the kind of work that should be deferred to mock, and that\(aqs exactly what this plugin provides.
.sp
As an example, if one needs to specify some options which should be available
to the module being tested one should do:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import pytest
import salt.modules.somemodule as somemodule


@pytest.fixture
def configure_loader_modules():
    \(dq\(dq\(dq
    This fixture should return a dictionary which is what\(aqs going to be used to
    patch and mock Salt\(aqs loader
    \(dq\(dq\(dq
    return {somemodule: {\(dq__opts__\(dq: {\(dqtest\(dq: True}}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Consider this more extensive example from \fBtests/pytests/unit/beacons/test_sensehat.py\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import pytest
import salt.beacons.sensehat as sensehat
from tests.support.mock import MagicMock


@pytest.fixture
def configure_loader_modules():
    return {
        sensehat: {
            \(dq__salt__\(dq: {
                \(dqsensehat.get_humidity\(dq: MagicMock(return_value=80),
                \(dqsensehat.get_temperature\(dq: MagicMock(return_value=30),
                \(dqsensehat.get_pressure\(dq: MagicMock(return_value=1500),
            },
        }
    }


def test_non_list_config():
    config = {}

    ret = sensehat.validate(config)

    assert ret == (False, \(dqConfiguration for sensehat beacon must be a list.\(dq)


def test_empty_config():
    config = [{}]

    ret = sensehat.validate(config)

    assert ret == (False, \(dqConfiguration for sensehat beacon requires sensors.\(dq)


def test_sensehat_humidity_match():

    config = [{\(dqsensors\(dq: {\(dqhumidity\(dq: \(dq70%\(dq}}]

    ret = sensehat.validate(config)
    assert ret == (True, \(dqValid beacon configuration\(dq)

    ret = sensehat.beacon(config)
    assert ret == [{\(dqtag\(dq: \(dqsensehat/humidity\(dq, \(dqhumidity\(dq: 80}]


def test_sensehat_temperature_match():

    config = [{\(dqsensors\(dq: {\(dqtemperature\(dq: 20}}]

    ret = sensehat.validate(config)
    assert ret == (True, \(dqValid beacon configuration\(dq)

    ret = sensehat.beacon(config)
    assert ret == [{\(dqtag\(dq: \(dqsensehat/temperature\(dq, \(dqtemperature\(dq: 30}]


def test_sensehat_temperature_match_range():

    config = [{\(dqsensors\(dq: {\(dqtemperature\(dq: [20, 29]}}]

    ret = sensehat.validate(config)
    assert ret == (True, \(dqValid beacon configuration\(dq)

    ret = sensehat.beacon(config)
    assert ret == [{\(dqtag\(dq: \(dqsensehat/temperature\(dq, \(dqtemperature\(dq: 30}]


def test_sensehat_pressure_match():

    config = [{\(dqsensors\(dq: {\(dqpressure\(dq: \(dq1400\(dq}}]

    ret = sensehat.validate(config)
    assert ret == (True, \(dqValid beacon configuration\(dq)

    ret = sensehat.beacon(config)
    assert ret == [{\(dqtag\(dq: \(dqsensehat/pressure\(dq, \(dqpressure\(dq: 1500}]


def test_sensehat_no_match():

    config = [{\(dqsensors\(dq: {\(dqpressure\(dq: \(dq1600\(dq}}]

    ret = sensehat.validate(config)
    assert ret == (True, \(dqValid beacon configuration\(dq)

    ret = sensehat.beacon(config)
    assert ret == []
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
What happens in the above example is we mock several calls of the \fBsensehat\fP
module to return known expected values to assert against.
.SS Mocking Filehandles
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This documentation applies to the 2018.3 release cycle and newer. The
extended functionality for \fBmock_open\fP described below does not exist in
the 2017.7 and older release branches.
.UNINDENT
.UNINDENT
.sp
Opening files in Salt is done using \fBsalt.utils.files.fopen()\fP\&. When testing
code that reads from files, the \fBmock_open\fP helper can be used to mock
filehandles. Note that is not the same \fBmock_open\fP as
\fI\%unittest.mock.mock_open()\fP from the Python standard library, but rather
a separate implementation which has additional functionality.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from tests.support.mock import patch, mock_open

import salt.modules.mymod as mymod


def test_something():
    fopen_mock = mock_open(read_data=\(dqfoo\enbar\enbaz\en\(dq)
    with patch(\(dqsalt.utils.files.fopen\(dq, fopen_mock):
        result = mymod.myfunc()
        assert result is True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will force any filehandle opened to mimic a filehandle which, when read,
produces the specified contents.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
\fBString Types\fP
.sp
When configuring your read_data, make sure that you are using
bytestrings (e.g. \fBb\(dqfoo\enbar\enbaz\en\(dq\fP) when the code you are testing is
opening a file for binary reading, otherwise the tests will fail.  The
mocked filehandles produced by \fBmock_open\fP will raise a
\fI\%TypeError\fP if you attempt to read a bytestring when opening for
non\-binary reading, and similarly will not let you read a string when
opening a file for binary reading. They will also not permit bytestrings to
be \(dqwritten\(dq if the mocked filehandle was opened for non\-binary writing,
and vice\-versa when opened for non\-binary writing. These enhancements force
test writers to write more accurate tests.
.UNINDENT
.UNINDENT
.SS More Complex Scenarios
.SS Multiple File Paths
.sp
What happens when the code being tested reads from more than one file? For
those cases, you can pass \fBread_data\fP as a dictionary:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import textwrap

from tests.support.mock import patch, mock_open

import salt.modules.mymod as mymod


def test_something():
    contents = {
        \(dq/etc/foo.conf\(dq: textwrap.dedent(
            \(dq\(dq\(dq\e
            foo
            bar
            baz
            \(dq\(dq\(dq
        ),
        \(dq/etc/b*.conf\(dq: textwrap.dedent(
            \(dq\(dq\(dq\e
            one
            two
            three
            \(dq\(dq\(dq
        ),
    }
    fopen_mock = mock_open(read_data=contents)
    with patch(\(dqsalt.utils.files.fopen\(dq, fopen_mock):
        result = mymod.myfunc()
        assert result is True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This would make \fBsalt.utils.files.fopen()\fP produce filehandles with different
contents depending on which file was being opened by the code being tested.
\fB/etc/foo.conf\fP and any file matching the pattern \fB/etc/b*.conf\fP would
work, while opening any other path would result in a
\fI\%FileNotFoundError\fP being raised.
.sp
Since file patterns are supported, it is possible to use a pattern of \fB\(aq*\(aq\fP
to define a fallback if no other patterns match the filename being opened. The
below two \fBmock_open\fP calls would produce identical results:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mock_open(read_data=\(dqfoo\en\(dq)
mock_open(read_data={\(dq*\(dq: \(dqfoo\en\(dq})
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Take care when specifying the \fBread_data\fP as a dictionary, in cases where
the patterns overlap (e.g. when both \fB/etc/b*.conf\fP and \fB/etc/bar.conf\fP
are in the \fBread_data\fP). Dictionary iteration order will determine which
pattern is attempted first, second, etc., with the exception of \fB*\fP which
is used when no other pattern matches. If your test case calls for
specifying overlapping patterns, and you are not running Python 3.6 or
newer, then an \fBOrderedDict\fP can be used to ensure matching is handled in
the desired way:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
contents = OrderedDict()
contents[\(dq/etc/bar.conf\(dq] = \(dqfoo\enbar\enbaz\en\(dq
contents[\(dq/etc/b*.conf\(dq] = IOError(errno.EACCES, \(dqPermission denied\(dq)
contents[\(dq*\(dq] = \(aqThis is a fallback for files not beginning with \(dq/etc/b\(dq\en\(aq
fopen_mock = mock_open(read_data=contents)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Raising Exceptions
.sp
Instead of a string, an exception can also be used as the \fBread_data\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import errno

from tests.support.mock import patch, mock_open

import salt.modules.mymod as mymod


def test_something():
    exc = IOError(errno.EACCES, \(dqPermission denied\(dq)
    fopen_mock = mock_open(read_data=exc)
    with patch(\(dqsalt.utils.files.fopen\(dq, fopen_mock):
        mymod.myfunc()
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above example would raise the specified exception when any file is opened.
The expectation would be that \fBmymod.myfunc()\fP would gracefully handle the
IOError, so a failure to do that would result in it being raised and causing
the test to fail.
.SS Multiple File Contents
.sp
For cases in which a file is being read more than once, and it is necessary to
test a function\(aqs behavior based on what the file looks like the second (or
third, etc.) time it is read, just specify the contents for that file as a
list. Each time the file is opened, \fBmock_open\fP will cycle through the list
and produce a mocked filehandle with the specified contents. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import errno
import textwrap

from tests.support.mock import patch, mock_open

import salt.modules.mymod as mymod


def test_something():
    contents = {
        \(dq/etc/foo.conf\(dq: [
            textwrap.dedent(
                \(dq\(dq\(dq\e
                foo
                bar
                \(dq\(dq\(dq
            ),
            textwrap.dedent(
                \(dq\(dq\(dq\e
                foo
                bar
                baz
                \(dq\(dq\(dq
            ),
        ],
        \(dq/etc/b*.conf\(dq: [
            IOError(errno.ENOENT, \(dqNo such file or directory\(dq),
            textwrap.dedent(
                \(dq\(dq\(dq\e
                one
                two
                three
                \(dq\(dq\(dq
            ),
        ],
    }
    fopen_mock = mock_open(read_data=contents)
    with patch(\(dqsalt.utils.files.fopen\(dq, fopen_mock):
        result = mymod.myfunc()
        assert result is True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Using this example, the first time \fB/etc/foo.conf\fP is opened, it will
simulate a file with the first string in the list as its contents, while the
second time it is opened, the simulated file\(aqs contents will be the second
string in the list.
.sp
If no more items remain in the list, then attempting to open the file will
raise a \fI\%RuntimeError\fP\&. In the example above, if \fB/etc/foo.conf\fP were
to be opened a third time, a \fI\%RuntimeError\fP would be raised.
.sp
Note that exceptions can also be mixed in with strings when using this
technique. In the above example, if \fB/etc/bar.conf\fP were to be opened twice,
the first time would simulate the file not existing, while the second time
would simulate a file with string defined in the second element of the list.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Notice that the second path in the \fBcontents\fP dictionary above
(\fB/etc/b*.conf\fP) contains an asterisk. The items in the list are cycled
through for each match of a given pattern (\fInot\fP separately for each
individual file path), so this means that only two files matching that
pattern could be opened before the next one would raise a
\fI\%RuntimeError\fP\&.
.UNINDENT
.UNINDENT
.SS Accessing the Mocked Filehandles in a Test
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The code for the \fBMockOpen\fP, \fBMockCall\fP, and \fBMockFH\fP classes
(referenced below) can be found in \fBtests/support/mock.py\fP\&. There are
extensive unit tests for them located in \fBtests/unit/test_mock.py\fP\&.
.UNINDENT
.UNINDENT
.sp
The above examples simply show how to mock \fBsalt.utils.files.fopen()\fP to
simulate files with the contents you desire, but you can also access the mocked
filehandles (and more), and use them to craft assertions in your tests. To do
so, just add an \fBas\fP clause to the end of the \fBpatch\fP statement:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
fopen_mock = mock_open(read_data=\(dqfoo\enbar\enbaz\en\(dq)
with patch(\(dqsalt.utils.files.fopen\(dq, fopen_mock) as m_open:
    # do testing here
    ...
    ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When doing this, \fBm_open\fP will be a \fBMockOpen\fP instance. It will contain
several useful attributes:
.INDENT 0.0
.IP \(bu 2
\fBread_data\fP \- A dictionary containing the \fBread_data\fP passed when
\fBmock_open\fP was invoked. In the event that \fI\%multiple file paths\fP are not used, then this will be a
dictionary mapping \fB*\fP to the \fBread_data\fP passed to \fBmock_open\fP\&.
.IP \(bu 2
\fBcall_count\fP \- An integer representing how many times
\fBsalt.utils.files.fopen()\fP was called to open a file.
.IP \(bu 2
\fBcalls\fP \- A list of \fBMockCall\fP objects. A \fBMockCall\fP object is a simple
class which stores the arguments passed to it, making the positional
arguments available via its \fBargs\fP attribute, and the keyword arguments
available via its \fBkwargs\fP attribute.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
from tests.support.mock import patch, mock_open, MockCall

import salt.modules.mymod as mymod


def test_something():

    with patch(\(dqsalt.utils.files.fopen\(dq, mock_open(read_data=b\(dqfoo\en\(dq)) as m_open:
        mymod.myfunc()
        # Assert that only two opens attempted
        assert m_open.call_count == 2
        # Assert that only /etc/foo.conf was opened
        assert all(call.args[0] == \(dq/etc/foo.conf\(dq for call in m_open.calls)
        # Asser that the first open was for binary read, and the
        # second was for binary write.
        assert m_open.calls == [
            MockCall(\(dq/etc/foo.conf\(dq, \(dqrb\(dq),
            MockCall(\(dq/etc/foo.conf\(dq, \(dqwb\(dq),
        ]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that \fBMockCall\fP is imported from \fBtests.support.mock\fP in the above
example. Also, the second assert above is redundant since it is covered in
the final assert, but both are included simply as an example.
.IP \(bu 2
\fBfilehandles\fP \- A dictionary mapping the unique file paths opened, to lists
of \fBMockFH\fP objects. Each open creates a unique \fBMockFH\fP object. Each
\fBMockFH\fP object itself has a number of useful attributes:
.INDENT 2.0
.IP \(bu 2
\fBfilename\fP \- The path to the file which was opened using
\fBsalt.utils.files.fopen()\fP
.IP \(bu 2
\fBcall\fP \- A \fBMockCall\fP object representing the arguments passed to
\fBsalt.utils.files.fopen()\fP\&. Note that this \fBMockCall\fP is also available
in the parent \fBMockOpen\fP instance\(aqs \fBcalls\fP list.
.IP \(bu 2
The following methods are mocked using \fI\%unittest.mock.Mock\fP
objects, and Mock\(aqs built\-in asserts (as well as the call data) can be used
as you would with any other Mock object:
.INDENT 2.0
.IP \(bu 2
\fB\&.read()\fP
.IP \(bu 2
\fB\&.readlines()\fP
.IP \(bu 2
\fB\&.readline()\fP
.IP \(bu 2
\fB\&.close()\fP
.IP \(bu 2
\fB\&.write()\fP
.IP \(bu 2
\fB\&.writelines()\fP
.IP \(bu 2
\fB\&.seek()\fP
.UNINDENT
.IP \(bu 2
The read functions (\fB\&.read()\fP, \fB\&.readlines()\fP, \fB\&.readline()\fP) all
work as expected, as does iterating through the file line by line (i.e.
\fBfor line in fh:\fP).
.IP \(bu 2
The \fB\&.tell()\fP method is also implemented in such a way that it updates
after each time the mocked filehandle is read, and will report the correct
position. The one caveat here is that \fB\&.seek()\fP doesn\(aqt actually work
(it\(aqs simply mocked), and will not change the position. Additionally,
neither \fB\&.write()\fP or \fB\&.writelines()\fP will modify the mocked
filehandle\(aqs contents.
.IP \(bu 2
The attributes \fB\&.write_calls\fP and \fB\&.writelines_calls\fP (no parenthesis)
are available as shorthands and correspond to lists containing the contents
passed for all calls to \fB\&.write()\fP and \fB\&.writelines()\fP, respectively.
.UNINDENT
.UNINDENT
.SS Examples
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
with patch(\(dqsalt.utils.files.fopen\(dq, mock_open(read_data=contents)) as m_open:
    # Run the code you are unit testing
    mymod.myfunc()
    # Check that only the expected file was opened, and that it was opened
    # only once.
    assert m_open.call_count == 1
    assert list(m_open.filehandles) == [\(dq/etc/foo.conf\(dq]
    # \(dqopens\(dq will be a list of all the mocked filehandles opened
    opens = m_open.filehandles[\(dq/etc/foo.conf\(dq]
    # Check that we wrote the expected lines (\(dqexpected\(dq here is assumed to
    # be a list of strings)
    assert opens[0].write_calls == expected
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
with patch(\(dqsalt.utils.files.fopen\(dq, mock_open(read_data=contents)) as m_open:
    # Run the code you are unit testing
    mymod.myfunc()
    # Check that .readlines() was called (remember, it\(aqs a Mock)
    m_open.filehandles[\(dq/etc/foo.conf\(dq][0].readlines.assert_called()
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
with patch(\(dqsalt.utils.files.fopen\(dq, mock_open(read_data=contents)) as m_open:
    # Run the code you are unit testing
    mymod.myfunc()
    # Check that we read the file and also wrote to it
    m_open.filehandles[\(dq/etc/foo.conf\(dq][0].read.assert_called_once()
    m_open.filehandles[\(dq/etc/foo.conf\(dq][1].writelines.assert_called_once()
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Naming Conventions
.sp
Test names and docstrings should indicate what functionality is being tested.
Test functions are named \fBtest_<fcn>_<test\-name>\fP where \fB<fcn>\fP is the function
being tested and \fB<test\-name>\fP describes the \fBraise\fP or \fBreturn\fP being tested.
.sp
Unit tests for \fBsalt/.../<module>.py\fP are contained in a file called
\fBtests/pytests/unit/.../test_<module>.py\fP, e.g. the tests for
\fBsalt/modules/alternatives.py\fP
are in \fBtests/pytests/unit/modules/test_alternatives.py\fP\&.
.sp
In order for unit tests to get picked up during a run of the unit test suite, each
unit test file must be prefixed with \fBtest_\fP and each individual test must
also be
prefixed with the \fBtest_\fP naming syntax, as described above.
.sp
If a function does not start with \fBtest_\fP, then the function acts as a \(dqnormal\(dq
function and is not considered a testing function. It will not be included in the
test run or testing output. The same principle applies to unit test files that
do not have the \fBtest_*.py\fP naming syntax. This test file naming convention
is how the test runner recognizes that a test file contains tests.
.SS Imports
.sp
Most commonly, the following imports are necessary to create a unit test:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import pytest
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you need mock support to your tests, please also import:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from tests.support.mock import MagicMock, patch, call
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Evaluating Truth
.sp
A longer discussion on the types of assertions one can make can be found by
reading \fI\%PyTest\(aqs documentation on assertions\fP\&.
.SS Tests Using Mock Objects
.sp
In many cases, the purpose of a Salt module is to interact with some external
system, whether it be to control a database, manipulate files on a filesystem
or something else. In these varied cases, it\(aqs necessary to design a unit test
which can test the function whilst replacing functions which might actually
call out to external systems. One might think of this as \(dqblocking the exits\(dq
for code under tests and redirecting the calls to external systems with our own
code which produces known results during the duration of the test.
.sp
To achieve this behavior, Salt makes heavy use of the \fI\%MagicMock package\fP\&.
.sp
To understand how one might integrate Mock into writing a unit test for Salt,
let\(aqs imagine a scenario in which we\(aqre testing an execution module that\(aqs
designed to operate on a database. Furthermore, let\(aqs imagine two separate
methods, here presented in pseduo\-code in an imaginary execution module called
\(aqdb.py\(aq.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def create_user(username):
    qry = \(dqCREATE USER {0}\(dq.format(username)
    execute_query(qry)


def execute_query(qry):
    # Connect to a database and actually do the query...
    ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Here, let\(aqs imagine that we want to create a unit test for the \fIcreate_user\fP
function. In doing so, we want to avoid any calls out to an external system and
so while we are running our unit tests, we want to replace the actual
interaction with a database with a function that can capture the parameters
sent to it and return pre\-defined values. Therefore, our task is clear \-\- to
write a unit test which tests the functionality of \fIcreate_user\fP while also
replacing \(aqexecute_query\(aq with a mocked function.
.sp
To begin, we set up the skeleton of our test much like we did before, but with
additional imports for MagicMock:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from salt.modules import db
from tests.support.mock import MagicMock, patch, call


def test_create_user():
    \(dq\(dq\(dq
    Test creating a user
    \(dq\(dq\(dq
    # First, we replace \(aqexecute_query\(aq with our own mock function
    with patch.object(db, \(dqexecute_query\(dq, MagicMock()) as db_exq:

        # Now that the exits are blocked, we can run the function under test.
        db.create_user(\(dqtestuser\(dq)

        # We could now query our mock object to see which calls were made
        # to it.
        ## print db_exq.mock_calls

        # Construct a call object that simulates the way we expected
        # execute_query to have been called.
        expected_call = call(\(dqCREATE USER testuser\(dq)

        # Compare the expected call with the list of actual calls.  The
        # test will succeed or fail depending on the output of this
        # assertion.
        db_exq.assert_has_calls(expected_call)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Modifying \fB__salt__\fP In Place
.sp
At times, it becomes necessary to make modifications to a module\(aqs view of
functions in its own \fB__salt__\fP dictionary.  Luckily, this process is quite
easy.
.sp
Below is an example that uses MagicMock\(aqs \fBpatch\fP functionality to insert a
function into \fB__salt__\fP that\(aqs actually a MagicMock instance.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import pytest
import salt.modules.my_module as my_module


@pytest.fixture
def configure_loader_modules():
    \(dq\(dq\(dq
    This fixture should return a dictionary which is what\(aqs going to be used to
    patch and mock Salt\(aqs loader
    \(dq\(dq\(dq
    return {my_module: {}}


def show_patch(self):
    with patch.dict(my_module.__salt__, {\(dqfunction.to_replace\(dq: MagicMock()}):
        # From this scope, carry on with testing, with a modified __salt__!
        ...
.ft P
.fi
.UNINDENT
.UNINDENT
.SS A Simple Example
.sp
Let\(aqs assume that we\(aqre testing a very basic function in an imaginary Salt
execution module. Given a module called \fBfib.py\fP that has a function called
\fBcalculate(num_of_results)\fP, which given a \fBnum_of_results\fP, produces a list of
sequential Fibonacci numbers of that length.
.sp
A unit test to test this function might be commonly placed in a file called
\fBtests/pytests/unit/modules/test_fib.py\fP\&. The convention is to place unit tests for
Salt execution modules in \fBtest/pytests/unit/modules/\fP and to name the tests module
prefixed with \fBtest_*.py\fP\&.
.sp
Tests are grouped around test cases, which are logically grouped sets of tests
against a piece of functionality in the tested software. To return to our example, here\(aqs how
we might write the skeleton for testing \fBfib.py\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.modules.fib as fib


def test_fib():
    \(dq\(dq\(dq
    To create a unit test, we should prefix the name with \(gatest_\(aq so
    that it\(aqs recognized by the test runner.
    \(dq\(dq\(dq
    fib_five = (0, 1, 1, 2, 3)
    assert fib.calculate(5) == fib_five
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
At this point, the test can now be run, either individually or as a part of a
full run of the test runner. To ease development, a single test can be
executed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e \(aqtest\-3(coverage=False)\(aq \-\- \-v tests/pytests/unit/modules/test_fib.py
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will report the status of the test: success, failure, or error.  The
\fB\-v\fP flag increases output verbosity.
.sp
To review the results of a particular run, take a note of the log location
given in the output for each test run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\&...etc... \-\-log\-file=artifacts/logs/runtests\-20210106103414.685791.log ...etc...
.ft P
.fi
.UNINDENT
.UNINDENT
.SS A More Complete Example
.sp
Consider the following function from salt/modules/linux_sysctl.py.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def get(name):
    \(dq\(dq\(dq
    Return a single sysctl parameter for this minion

    CLI Example:

    .. code\-block:: bash

        salt \(aq*\(aq sysctl.get net.ipv4.ip_forward
    \(dq\(dq\(dq
    cmd = \(dqsysctl \-n {}\(dq.format(name)
    out = __salt__[\(dqcmd.run\(dq](cmd, python_shell=False)
    return out
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This function is very simple, comprising only four source lines of code and
having only one return statement, so we know only one test is needed.  There
are also two inputs to the function, the \fBname\fP function argument and the call
to \fB__salt__[\(aqcmd.run\(aq]()\fP, both of which need to be appropriately mocked.
.sp
Mocking a function parameter is straightforward, whereas mocking a function
call will require, in this case, the use of MagicMock.  For added isolation, we
will also redefine the \fB__salt__\fP dictionary such that it only contains
\fB\(aqcmd.run\(aq\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import pytest
import salt.modules.linux_sysictl as linux_sysctl
from tests.support.mock import MagicMock, patch


@pytest.fixture
def configure_loader_modules():
    return {linux_sysctl: {}}


def test_get():
    \(dq\(dq\(dq
    Tests the return of get function
    \(dq\(dq\(dq
    mock_cmd = MagicMock(return_value=1)
    with patch.dict(linux_sysctl.__salt__, {\(dqcmd.run\(dq: mock_cmd}):
        assert linux_sysctl.get(\(dqnet.ipv4.ip_forward\(dq) == 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Since \fBget()\fP has only one raise or return statement and that statement is a
success condition, the test function is simply named \fBtest_get()\fP\&.  As
described, the single function call parameter, \fBname\fP is mocked with
\fBnet.ipv4.ip_forward\fP and \fB__salt__[\(aqcmd.run\(aq]\fP is replaced by a MagicMock
function object.  We are only interested in the return value of
\fB__salt__[\(aqcmd.run\(aq]\fP, which MagicMock allows us by specifying via
\fBreturn_value=1\fP\&.  Finally, the test itself tests for equality between the
return value of \fBget()\fP and the expected return of \fB1\fP\&.  This assertion is
expected to succeed because \fBget()\fP will determine its return value from
\fB__salt__[\(aqcmd.run\(aq]\fP, which we have mocked to return \fB1\fP\&.
.SS A Complex Example
.sp
Now consider the \fBassign()\fP function from the same
salt/modules/linux_sysctl.py source file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def assign(name, value):
    \(dq\(dq\(dq
    Assign a single sysctl parameter for this minion

    CLI Example:

    .. code\-block:: bash

        salt \(aq*\(aq sysctl.assign net.ipv4.ip_forward 1
    \(dq\(dq\(dq
    value = str(value)

    tran_tab = name.translate(\(dq\(dq.maketrans(\(dq./\(dq, \(dq/.\(dq))

    sysctl_file = \(dq/proc/sys/{}\(dq.format(tran_tab)
    if not os.path.exists(sysctl_file):
        raise CommandExecutionError(\(dqsysctl {} does not exist\(dq.format(name))

    ret = {}
    cmd = \(aqsysctl \-w {}=\(dq{}\(dq\(aq.format(name, value)
    data = __salt__[\(dqcmd.run_all\(dq](cmd, python_shell=False)
    out = data[\(dqstdout\(dq]
    err = data[\(dqstderr\(dq]

    # Example:
    #    # sysctl \-w net.ipv4.tcp_rmem=\(dq4096 87380 16777216\(dq
    #    net.ipv4.tcp_rmem = 4096 87380 16777216
    regex = re.compile(r\(dq^{}\es+=\es+{}$\(dq.format(re.escape(name), re.escape(value)))

    if not regex.match(out) or \(dqInvalid argument\(dq in str(err):
        if data[\(dqretcode\(dq] != 0 and err:
            error = err
        else:
            error = out
        raise CommandExecutionError(\(dqsysctl \-w failed: {}\(dq.format(error))
    new_name, new_value = out.split(\(dq = \(dq, 1)
    ret[new_name] = new_value
    return ret
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This function contains two raise statements and one return statement, so we
know that we will need (at least) three tests.  It has two function arguments
and many references to non\-builtin functions.  In the tests below you will see
that MagicMock\(aqs \fBpatch()\fP method may be used as a context manager or as a
decorator. When patching the salt dunders however, please use the context
manager approach.
.sp
There are three test functions, one for each raise and return statement in the
source function.  Each function is self\-contained and contains all and only the
mocks and data needed to test the raise or return statement it is concerned
with.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import pytest
import salt.modules.linux_sysctl as linux_sysctl
from salt.exceptions import CommandExecutionError
from tests.support.mock import MagicMock, patch


@pytest.fixture
def configure_loader_modules():
    return {linux_sysctl: {}}


def test_assign_proc_sys_failed():
    \(dq\(dq\(dq
    Tests if /proc/sys/<kernel\-subsystem> exists or not
    \(dq\(dq\(dq
    with patch(\(dqos.path.exists\(dq, MagicMock(return_value=False)):
        cmd = {
            \(dqpid\(dq: 1337,
            \(dqretcode\(dq: 0,
            \(dqstderr\(dq: \(dq\(dq,
            \(dqstdout\(dq: \(dqnet.ipv4.ip_forward = 1\(dq,
        }
        mock_cmd = MagicMock(return_value=cmd)
        with patch.dict(linux_sysctl.__salt__, {\(dqcmd.run_all\(dq: mock_cmd}):
            with pytest.raises(CommandExecutionError):
                linux_sysctl.assign(\(dqnet.ipv4.ip_forward\(dq, 1)


def test_assign_cmd_failed():
    \(dq\(dq\(dq
    Tests if the assignment was successful or not
    \(dq\(dq\(dq
    with patch(\(dqos.path.exists\(dq, MagicMock(return_value=True)):
        cmd = {
            \(dqpid\(dq: 1337,
            \(dqretcode\(dq: 0,
            \(dqstderr\(dq: \(aqsysctl: setting key \(dqnet.ipv4.ip_forward\(dq: Invalid argument\(aq,
            \(dqstdout\(dq: \(dqnet.ipv4.ip_forward = backward\(dq,
        }
        mock_cmd = MagicMock(return_value=cmd)
        with patch.dict(linux_sysctl.__salt__, {\(dqcmd.run_all\(dq: mock_cmd}):
            with pytest.raises(CommandExecutionError):
                linux_sysctl.assign(\(dqnet.ipv4.ip_forward\(dq, \(dqbackward\(dq)


def test_assign_success():
    \(dq\(dq\(dq
    Tests the return of successful assign function
    \(dq\(dq\(dq
    with patch(\(dqos.path.exists\(dq, MagicMock(return_value=True)):
        cmd = {
            \(dqpid\(dq: 1337,
            \(dqretcode\(dq: 0,
            \(dqstderr\(dq: \(dq\(dq,
            \(dqstdout\(dq: \(dqnet.ipv4.ip_forward = 1\(dq,
        }
        ret = {\(dqnet.ipv4.ip_forward\(dq: \(dq1\(dq}
        mock_cmd = MagicMock(return_value=cmd)
        with patch.dict(linux_sysctl.__salt__, {\(dqcmd.run_all\(dq: mock_cmd}):
            assert linux_sysctl.assign(\(dqnet.ipv4.ip_forward\(dq, 1) == ret
.ft P
.fi
.UNINDENT
.UNINDENT
.SS SaltStack Git Policy
.sp
The SaltStack team follows a git policy to maintain stability and consistency
with the repository.
.sp
The git policy has been developed to encourage contributions and make contributing
to Salt as easy as possible. Code contributors to SaltStack projects DO NOT NEED
TO READ THIS DOCUMENT, because all contributions come into SaltStack via a single
gateway to make it as easy as possible for contributors to give us code.
.sp
The primary rule of git management in SaltStack is to make life easy on
contributors and developers to send in code. Simplicity is always a goal!
.SS New Code Entry
.sp
All new SaltStack code should be submitted against \fBmaster\fP\&.
.SS Release Branching
.sp
SaltStack maintains two types of releases, \fBFeature Releases\fP and
\fBPoint Releases\fP (also commonly referred to as \fBBugfix Releases\fP\&. A
feature release is managed by incrementing the first or second release point
number, so 2015.5.5 \-> 2015.8.0 signifies a feature release
and 2015.8.0 \-> 2015.8.1 signifies a point release.
.SS Feature Release Branching
.sp
Each feature release is maintained in a dedicated git branch derived from the
last applicable release commit on develop. All file changes relevant to the
feature release will be completed in the \fBmaster\fP branch prior to the creation
of the feature release branch. The feature release branch will be named after
the relevant numbers to the feature release, which constitute the first two
numbers. This means that the release branch for the 2015.8.0 series is named
2015.8.
.sp
A feature release branch is created with the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# git checkout \-b 2015.8 # From the master branch
# git push origin 2015.8
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Point Releases
.sp
As documented in \fI\%SEP 14\fP,
point releases should be rare.
.SS Salt Conventions
.SS Writing Salt documentation
.sp
For the latest information about writing Salt documentation, see:
.INDENT 0.0
.IP \(bu 2
\fI\%Salt docs contributing guide\fP
.IP \(bu 2
\fI\%Salt rST guide\fP
.IP \(bu 2
\fI\%Salt style guide\fP
.UNINDENT
.SS Salt Formulas
.sp
Formulas are pre\-written Salt States. They are as open\-ended as Salt States
themselves and can be used for tasks such as installing a package, configuring,
and starting a service, setting up users or permissions, and many other common
tasks.
.sp
All official Salt Formulas are found as separate Git repositories in the
\(dqsaltstack\-formulas\(dq organization on GitHub:
.sp
\fI\%https://github.com/saltstack\-formulas\fP
.sp
As a simple example, to install the popular Apache web server (using the normal
defaults for the underlying distro) simply include the
\fI\%url apache\-formula\fP from a top file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqweb*\(aq:
    \- apache
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Installation
.sp
Each Salt Formula is an individual Git repository designed as a drop\-in
addition to an existing Salt State tree. Formulas can be installed in the
following ways.
.SS Adding a Formula as a GitFS remote
.sp
One design goal of Salt\(aqs GitFS fileserver backend was to facilitate reusable
States. GitFS is a quick and natural way to use Formulas.
.INDENT 0.0
.IP 1. 3
\fI\%Install any necessary dependencies and configure GitFS\fP\&.
.IP 2. 3
Add one or more Formula repository URLs as remotes in the
\fI\%gitfs_remotes\fP list in the Salt Master configuration file:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
gitfs_remotes:
  \- https://github.com/saltstack\-formulas/apache\-formula
  \- https://github.com/saltstack\-formulas/memcached\-formula
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBWe strongly recommend forking a formula repository\fP into your own GitHub
account to avoid unexpected changes to your infrastructure.
.sp
Many Salt Formulas are highly active repositories so pull new changes with
care. Plus any additions you make to your fork can be easily sent back
upstream with a quick pull request!
.IP 3. 3
Restart the Salt master.
.UNINDENT
.sp
Beginning with the 2018.3.0 release, using formulas with GitFS is now much more
convenient for deployments which use many different fileserver environments
(i.e. saltenvs). Using the \fI\%all_saltenvs\fP
parameter, files from a single git branch/tag will appear in all environments.
See \fI\%here\fP for more information on this feature.
.SS Adding a Formula directory manually
.sp
Formulas are simply directories that can be copied onto the local file system
by using Git to clone the repository or by downloading and expanding a tarball
or zip file of the repository. The directory structure is designed to work with
\fI\%file_roots\fP in the Salt master configuration.
.INDENT 0.0
.IP 1. 3
Clone or download the repository into a directory:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
mkdir \-p /srv/formulas
cd /srv/formulas
git clone https://github.com/saltstack\-formulas/apache\-formula.git

# or

mkdir \-p /srv/formulas
cd /srv/formulas
wget \-O apache\-formula\-master.tar.gz https://github.com/saltstack\-formulas/apache\-formula/archive/master.tar.gz
tar xf apache\-formula\-master.tar.gz
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
Add the new directory to \fI\%file_roots\fP:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
file_roots:
  base:
    \- /srv/salt
    \- /srv/formulas/apache\-formula
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
Restart the Salt Master.
.UNINDENT
.SS Usage
.sp
Each Formula is intended to be immediately usable with sane defaults without
any additional configuration. Many formulas are also configurable by including
data in Pillar; see the \fBpillar.example\fP file in each Formula repository
for available options.
.SS Including a Formula in an existing State tree
.sp
Formula may be included in an existing \fBsls\fP file. This is often useful when
a state you are writing needs to \fBrequire\fP or \fBextend\fP a state defined in
the formula.
.sp
Here is an example of a state that uses the \fI\%url epel\-formula\fP in a
\fBrequire\fP declaration which directs Salt to not install the \fBpython26\fP
package until after the EPEL repository has also been installed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- epel

python26:
  pkg.installed:
    \- require:
      \- pkg: epel
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Including a Formula from a Top File
.sp
Some Formula perform completely standalone installations that are not
referenced from other state files. It is usually cleanest to include these
Formula directly from a Top File.
.sp
For example the easiest way to set up an OpenStack deployment on a single
machine is to include the \fI\%url openstack\-standalone\-formula\fP directly from
a \fBtop.sls\fP file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqmyopenstackmaster\(aq:
    \- openstack
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Quickly deploying OpenStack across several dedicated machines could also be
done directly from a Top File and may look something like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aqcontroller\(aq:
    \- openstack.horizon
    \- openstack.keystone
  \(aqhyper\-*\(aq:
    \- openstack.nova
    \- openstack.glance
  \(aqstorage\-*\(aq:
    \- openstack.swift
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configuring Formula using Pillar
.sp
Salt Formulas are designed to work out of the box with no additional
configuration. However, many Formula support additional configuration and
customization through \fI\%Pillar\fP\&. Examples of available options can
be found in a file named \fBpillar.example\fP in the root directory of each
Formula repository.
.SS Using Formula with your own states
.sp
Remember that Formula are regular Salt States and can be used with all Salt\(aqs
normal state mechanisms. Formula can be required from other States with
\fI\%require\fP declarations, they can be modified using \fBextend\fP,
they can made to watch other states with \fI\%The _in version of requisites\fP\&.
.sp
The following example uses the stock \fI\%url apache\-formula\fP alongside a
custom state to create a vhost on a Debian/Ubuntu system and to reload the
Apache service whenever the vhost is changed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Include the stock, upstream apache formula.
include:
  \- apache

# Use the watch_in requisite to cause the apache service state to reload
# apache whenever the my\-example\-com\-vhost state changes.
my\-example\-com\-vhost:
  file:
    \- managed
    \- name: /etc/apache2/sites\-available/my\-example\-com
    \- watch_in:
      \- service: apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Don\(aqt be shy to read through the source for each Formula!
.SS Reporting problems & making additions
.sp
Each Formula is a separate repository on GitHub. If you encounter a bug with a
Formula please file an issue in the respective repository! Send fixes and
additions as a pull request. Add tips and tricks to the repository wiki.
.SS Writing Formulas
.sp
Each Formula is a separate repository in the \fI\%saltstack\-formulas\fP organization
on GitHub.
.SS Get involved creating new Formulas
.sp
The best way to create new Formula repositories for now is to create a
repository in your own account on GitHub and notify a SaltStack employee when
it is ready. We will add you to the Contributors team on the
\fI\%saltstack\-formulas\fP organization and help you transfer the repository over.
Ping a SaltStack employee on IRC (\fI\%#salt\fP on LiberaChat), join the
\fB#formulas\fP channel on the \fI\%salt\-slack\fP (bridged to \fB#saltstack\-formulas\fP
on LiberaChat) or send an email to the \fI\%salt\-users\fP mailing list.  Note that
IRC logs are available at \fI\%http://ngxbot.nginx.org/logs/%23salt/\fP and archives
for FreeNode (up to mid\-June 2021) \fI\%https://logbot\-archive.s3.amazonaws.com/freenode/salt.gz\fP
and \fI\%https://logbot\-archive.s3.amazonaws.com/freenode/saltstack\-formulas.gz\fP\&.
.sp
There are a lot of repositories in that organization! Team members can manage
which repositories they are subscribed to on GitHub\(aqs watching page:
\fI\%https://github.com/watching\fP\&.
.sp
Members of the Contributors team are welcome to participate in reviewing pull
requests across the Organization. Some repositories will have regular
contributors and some repositories will not. As you get involved in a
repository be sure to communicate with any other contributors there on pull
requests that are large or have breaking changes.
.sp
In general it is best to have another Contributor review and merge any pull
requests that you open. Feel free to \fI\%at\-mention\fP other regular contributors
to a repository and request a review. However, there are a lot of formula
repositories so if a repository does not yet have regular contributors or if
your pull request has stayed open for more than a couple days feel free to
\(dqselfie\-merge\(dq your own pull request.
.SS Style
.sp
Maintainability, readability, and reusability are all marks of a good Salt sls
file. This section contains several suggestions and examples.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Deploy the stable master branch unless version overridden by passing
# Pillar at the CLI or via the Reactor.

deploy_myapp:
  git.latest:
    \- name: git@github.com/myco/myapp.git
    \- version: {{ salt.pillar.get(\(aqmyapp:version\(aq, \(aqmaster\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Use a descriptive State ID
.sp
The ID of a state is used as a unique identifier that may be referenced via
other states in \fI\%requisites\fP\&. It must be unique across the
whole state tree (\fI\%it is a key in a dictionary\fP, after
all).
.sp
In addition a state ID should be descriptive and serve as a high\-level hint of
what it will do, or manage, or change. For example, \fBdeploy_webapp\fP, or
\fBapache\fP, or \fBreload_firewall\fP\&.
.SS Use \fBmodule.function\fP notation
.sp
So\-called \(dqshort\-declaration\(dq notation is preferred for referencing state
modules and state functions. It provides a consistent pattern of
\fBmodule.function\fP shared between Salt States, the Reactor, Salt
Mine, the Scheduler, as well as with the CLI.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Do
apache:
  pkg.installed:
    \- name: httpd

# Don\(aqt
apache:
  pkg:
    \- installed
    \- name: httpd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt\(aqs state compiler will transform \(dqshort\-decs\(dq into the longer format
\fI\%when compiling the human\-friendly highstate structure into the
machine\-friendly lowstate structure\fP\&.
.SS Specify the \fBname\fP parameter
.sp
Use a unique and permanent identifier for the state ID and reserve \fBname\fP for
data with variability.
.sp
The \fI\%name declaration\fP is a required parameter for all
state functions. The state ID will implicitly be used as \fBname\fP if it is not
explicitly set in the state.
.sp
In many state functions the \fBname\fP parameter is used for data that varies
such as OS\-specific package names, OS\-specific file system paths, repository
addresses, etc. Any time the ID of a state changes all references to that ID
must also be changed. Use a permanent ID when writing a state the first time to
future\-proof that state and allow for easier refactors down the road.
.SS Comment state files
.sp
YAML allows comments at varying indentation levels. It is a good practice to
comment state files. Use vertical whitespace to visually separate different
concepts or actions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Start with a high\-level description of the current sls file.
# Explain the scope of what it will do or manage.

# Comment individual states as necessary.
update_a_config_file:
  # Provide details on why an unusual choice was made. For example:
  #
  # This template is fetched from a third\-party and does not fit our
  # company norm of using Jinja. This must be processed using Mako.
  file.managed:
    \- name: /path/to/file.cfg
    \- source: salt://path/to/file.cfg.template
    \- template: mako

  # Provide a description or explanation that did not fit within the state
  # ID. For example:
  #
  # Update the application\(aqs last\-deployed timestamp.
  # This is a workaround until Bob configures Jenkins to automate RPM
  # builds of the app.
  cmd.run:
    # FIXME: Joe needs this to run on Windows by next quarter. Switch these
    # from shell commands to Salt\(aqs file.managed and file.replace state
    # modules.
    \- name: |
        touch /path/to/file_last_updated
        sed \-e \(aqs/foo/bar/g\(aq /path/to/file_environment
    \- onchanges:
      \- file: a_config_file
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Be careful to use Jinja comments for commenting Jinja code and YAML comments
for commenting YAML code.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# BAD EXAMPLE
# The Jinja in this YAML comment is still executed!
# {% set apache_is_installed = \(aqapache\(aq in salt.pkg.list_pkgs() %}

# GOOD EXAMPLE
# The Jinja in this Jinja comment will not be executed.
{# {% set apache_is_installed = \(aqapache\(aq in salt.pkg.list_pkgs() %} #}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Easy on the Jinja!
.sp
Jinja templating provides vast flexibility and power when building Salt sls
files. It can also create an unmaintainable tangle of logic and data. Speaking
broadly, Jinja is best used when kept apart from the states (as much as is
possible).
.sp
Below are guidelines and examples of how Jinja can be used effectively.
.SS Know the evaluation and execution order
.sp
High\-level knowledge of how Salt states are compiled and run is useful when
writing states.
.sp
The default \fI\%renderer\fP setting in Salt is Jinja piped to YAML.
Each is a separate step. Each step is not aware of the previous or following
step. Jinja is not YAML aware, YAML is not Jinja aware; they cannot share
variables or interact.
.INDENT 0.0
.IP \(bu 2
Whatever the Jinja step produces must be valid YAML.
.IP \(bu 2
Whatever the YAML step produces must be a valid \fI\%highstate data
structure\fP\&. (This is also true of the final step
for \fI\%any of the alternate renderers\fP in Salt.)
.IP \(bu 2
Highstate can be thought of as a human\-friendly data structure; easy to write
and easy to read.
.IP \(bu 2
Salt\(aqs state compiler validates the \fI\%highstate\fP and
compiles it to low state.
.IP \(bu 2
Low state can be thought of as a machine\-friendly data structure. It is a
list of dictionaries that each map directly to a function call.
.IP \(bu 2
Salt\(aqs state system finally starts and executes on each \(dqchunk\(dq in the low
state. Remember that requisites are evaluated at runtime.
.IP \(bu 2
The return for each function call is added to the \(dqrunning\(dq dictionary which
is the final output at the end of the state run.
.UNINDENT
.sp
The full evaluation and execution order:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Jinja \-> YAML \-> Highstate \-> low state \-> execution
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Avoid changing the underlying system with Jinja
.sp
Avoid calling commands from Jinja that change the underlying system. Commands
run via Jinja do not respect Salt\(aqs dry\-run mode (\fBtest=True\fP)! This is
usually in conflict with the idempotent nature of Salt states unless the
command being run is also idempotent.
.SS Inspect the local system
.sp
A common use for Jinja in Salt states is to gather information about the
underlying system. The \fBgrains\fP dictionary available in the Jinja context is
a great example of common data points that Salt itself has already gathered.
Less common values are often found by running commands. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set is_selinux_enabled = salt.cmd.run(\(aqsestatus\(aq) == \(aq1\(aq %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is usually best done with a variable assignment in order to separate the
data from the state that will make use of the data.
.SS Gather external data
.sp
One of the most common uses for Jinja is to pull external data into the state
file. External data can come from anywhere like API calls or database queries,
but it most commonly comes from flat files on the file system or Pillar data
from the Salt Master. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set some_data = salt.pillar.get(\(aqsome_data\(aq, {\(aqsane default\(aq: True}) %}

{# or #}

{% import_yaml \(aqpath/to/file.yaml\(aq as some_data %}

{# or #}

{% import_json \(aqpath/to/file.json\(aq as some_data %}

{# or #}

{% import_text \(aqpath/to/ssh_key.pub\(aq as ssh_pub_key %}

{# or #}

{% from \(aqpath/to/other_file.jinja\(aq import some_data with context %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is usually best done with a variable assignment in order to separate the
data from the state that will make use of the data.
.SS Light conditionals and looping
.sp
Jinja is extremely powerful for programmatically generating Salt states. It is
also easy to overuse. As a rule of thumb, if it is hard to read it will be hard
to maintain!
.sp
Separate Jinja control\-flow statements from the states as much as is possible
to create readable states. Limit Jinja within states to simple variable
lookups.
.sp
Below is a simple example of a readable loop:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% for user in salt.pillar.get(\(aqlist_of_users\(aq, []) %}

{# Ensure unique state IDs when looping. #}
{{ user.name }}\-{{ loop.index }}:
  user.present:
    \- name: {{ user.name }}
    \- shell: {{ user.shell }}

{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Avoid putting a Jinja conditionals within Salt states where possible.
Readability suffers and the correct YAML indentation is difficult to see in the
surrounding visual noise. Parametrization (discussed below) and variables are
both useful techniques to avoid this. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{# \-\-\-\- Bad example \-\-\-\- #}

apache:
  pkg.installed:
    {% if grains.os_family == \(aqRedHat\(aq %}
    \- name: httpd
    {% elif grains.os_family == \(aqDebian\(aq %}
    \- name: apache2
    {% endif %}

{# \-\-\-\- Better example \-\-\-\- #}

{% if grains.os_family == \(aqRedHat\(aq %}
{% set name = \(aqhttpd\(aq %}
{% elif grains.os_family == \(aqDebian\(aq %}
{% set name = \(aqapache2\(aq %}
{% endif %}

 apache:
  pkg.installed:
    \- name: {{ name }}

{# \-\-\-\- Good example \-\-\-\- #}

{% set name = {
    \(aqRedHat\(aq: \(aqhttpd\(aq,
    \(aqDebian\(aq: \(aqapache2\(aq,
}.get(grains.os_family) %}

 apache:
  pkg.installed:
    \- name: {{ name }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Dictionaries are useful to effectively \(dqnamespace\(dq a collection of variables.
This is useful with parametrization (discussed below). Dictionaries are also
easily combined and merged. And they can be directly serialized into YAML which
is often easier than trying to create valid YAML through templating. For
example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{# \-\-\-\- Bad example \-\-\-\- #}

haproxy_conf:
  file.managed:
    \- name: /etc/haproxy/haproxy.cfg
    \- template: jinja
    {% if \(aqexternal_loadbalancer\(aq in grains.roles %}
    \- source: salt://haproxy/external_haproxy.cfg
    {% elif \(aqinternal_loadbalancer\(aq in grains.roles %}
    \- source: salt://haproxy/internal_haproxy.cfg
    {% endif %}
    \- context:
        {% if \(aqexternal_loadbalancer\(aq in grains.roles %}
        ssl_termination: True
        {% elif \(aqinternal_loadbalancer\(aq in grains.roles %}
        ssl_termination: False
        {% endif %}

{# \-\-\-\- Better example \-\-\-\- #}

{% load_yaml as haproxy_defaults %}
common_settings:
  bind_port: 80

internal_loadbalancer:
  source: salt://haproxy/internal_haproxy.cfg
  settings:
    bind_port: 8080
    ssl_termination: False

external_loadbalancer:
  source: salt://haproxy/external_haproxy.cfg
  settings:
    ssl_termination: True
{% endload %}

{% if \(aqexternal_loadbalancer\(aq in grains.roles %}
{% set haproxy = haproxy_defaults[\(aqexternal_loadbalancer\(aq] %}
{% elif \(aqinternal_loadbalancer\(aq in grains.roles %}
{% set haproxy = haproxy_defaults[\(aqinternal_loadbalancer\(aq] %}
{% endif %}

{% do haproxy.settings.update(haproxy_defaults.common_settings) %}

haproxy_conf:
  file.managed:
    \- name: /etc/haproxy/haproxy.cfg
    \- template: jinja
    \- source: {{ haproxy.source }}
    \- context: {{ haproxy.settings | yaml() }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
There is still room for improvement in the above example. For example,
extracting into an external file or replacing the if\-elif conditional with a
function call to filter the correct data more succinctly. However, the state
itself is simple and legible, the data is separate and also simple and legible.
And those suggested improvements can be made at some future date without
altering the state at all!
.SS Avoid heavy logic and programming
.sp
Jinja is not Python. It was made by Python programmers and shares many
semantics and some syntax but it does not allow for arbitrary Python function
calls or Python imports. Jinja is a fast and efficient templating language but
the syntax can be verbose and visually noisy.
.sp
Once Jinja use within an sls file becomes slightly complicated \-\- long chains
of if\-elif\-elif\-else statements, nested conditionals, complicated dictionary
merges, wanting to use sets \-\- instead consider using a different Salt
renderer, such as the Python renderer. As a rule of thumb, if it is hard to
read it will be hard to maintain \-\- switch to a format that is easier to read.
.sp
Using alternate renderers is very simple to do using Salt\(aqs \(dqshe\-bang\(dq syntax
at the top of the file. The Python renderer must simply return the correct
\fI\%highstate data structure\fP\&. The following
example is a state tree of two sls files, one simple and one complicated.
.sp
\fB/srv/salt/top.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- common_configuration
    \- roles_configuration
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/salt/common_configuration.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
common_users:
  user.present:
    \- names:
      \- larry
      \- curly
      \- moe
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/salt/roles_configuration\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!py
def run():
    list_of_roles = set()

    # This example has the minion id in the form \(aqweb\-03\-dev\(aq.
    # Easily access the grains dictionary:
    try:
        app, instance_number, environment = __grains__[\(dqid\(dq].split(\(dq\-\(dq)
        instance_number = int(instance_number)
    except ValueError:
        app, instance_number, environment = [\(dqUnknown\(dq, 0, \(dqdev\(dq]

    list_of_roles.add(app)

    if app == \(dqweb\(dq and environment == \(dqdev\(dq:
        list_of_roles.add(\(dqprimary\(dq)
        list_of_roles.add(\(dqsecondary\(dq)
    elif app == \(dqweb\(dq and environment == \(dqstaging\(dq:
        if instance_number == 0:
            list_of_roles.add(\(dqprimary\(dq)
        else:
            list_of_roles.add(\(dqsecondary\(dq)

    # Easily cross\-call Salt execution modules:
    if __salt__[\(dqmyutils.query_valid_ec2_instance\(dq]():
        list_of_roles.add(\(dqis_ec2_instance\(dq)

    return {
        \(dqset_roles_grains\(dq: {
            \(dqgrains.present\(dq: [{\(dqname\(dq: \(dqroles\(dq}, {\(dqvalue\(dq: list(list_of_roles)}],
        },
    }
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Jinja Macros
.sp
In Salt sls files Jinja macros are useful for one thing and one thing only:
creating mini templates that can be reused and rendered on demand. Do not fall
into the trap of thinking of macros as functions; Jinja is not Python (see
above).
.sp
Macros are useful for creating reusable, parameterized states. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% macro user_state(state_id, user_name, shell=\(aq/bin/bash\(aq, groups=[]) %}
{{ state_id }}:
  user.present:
    \- name: {{ user_name }}
    \- shell: {{ shell }}
    \- groups: {{ groups | json() }}
{% endmacro %}

{% for user_info in salt.pillar.get(\(aqmy_users\(aq, []) %}
{{ user_state(\(aquser_number_\(aq ~ loop.index, **user_info) }}
{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Macros are also useful for creating one\-off \(dqserializers\(dq that can accept a
data structure and write that out as a domain\-specific configuration file. For
example, the following macro could be used to write a php.ini config file:
.sp
\fB/srv/salt/php.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
php_ini:
  file.managed:
    \- name: /etc/php.ini
    \- source: salt://php.ini.tmpl
    \- template: jinja
    \- context:
        php_ini_settings: {{ salt.pillar.get(\(aqphp_ini\(aq, {}) | json() }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/pillar/php.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
php_ini:
  PHP:
    engine: \(aqOn\(aq
    short_open_tag: \(aqOff\(aq
    error_reporting: \(aqE_ALL & ~E_DEPRECATED & ~E_STRICT\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/salt/php.ini.tmpl\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% macro php_ini_serializer(data) %}
{% for section_name, name_val_pairs in data.items() %}
[{{ section_name }}]
{% for name, val in name_val_pairs.items() \-%}
{{ name }} = \(dq{{ val }}\(dq
{% endfor %}
{% endfor %}
{% endmacro %}

; File managed by Salt at <{{ source }}>.
; Your changes will be overwritten.

{{ php_ini_serializer(php_ini_settings) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Abstracting static defaults into a lookup table
.sp
Separate data that a state uses from the state itself to increases the
flexibility and reusability of a state.
.sp
An obvious and common example of this is platform\-specific package names and
file system paths. Another example is sane defaults for an application, or
common settings within a company or organization. Organizing such data as a
dictionary (aka hash map, lookup table, associative array) often provides a
lightweight namespacing and allows for quick and easy lookups. In addition,
using a dictionary allows for easily merging and overriding static values
within a lookup table with dynamic values fetched from Pillar.
.sp
A strong convention in Salt Formulas is to place platform\-specific data, such
as package names and file system paths, into a file named \fBmap.jinja\fP
that is placed alongside the state files.
.sp
The following is an example from the MySQL Formula.
The \fI\%grains.filter_by\fP function
performs a lookup on that table using the \fBos_family\fP grain (by default).
.sp
The result is that the \fBmysql\fP variable is assigned to a \fIsubset\fP of
the lookup table for the current platform. This allows states to reference, for
example, the name of a package without worrying about the underlying OS. The
syntax for referencing a value is a normal dictionary lookup in Jinja, such as
\fB{{ mysql[\(aqservice\(aq] }}\fP or the shorthand \fB{{ mysql.service }}\fP\&.
.sp
\fBmap.jinja\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set mysql = salt[\(aqgrains.filter_by\(aq]({
    \(aqDebian\(aq: {
        \(aqserver\(aq: \(aqmysql\-server\(aq,
        \(aqclient\(aq: \(aqmysql\-client\(aq,
        \(aqservice\(aq: \(aqmysql\(aq,
        \(aqconfig\(aq: \(aq/etc/mysql/my.cnf\(aq,
        \(aqpython\(aq: \(aqpython\-mysqldb\(aq,
    },
    \(aqRedHat\(aq: {
        \(aqserver\(aq: \(aqmysql\-server\(aq,
        \(aqclient\(aq: \(aqmysql\(aq,
        \(aqservice\(aq: \(aqmysqld\(aq,
        \(aqconfig\(aq: \(aq/etc/my.cnf\(aq,
        \(aqpython\(aq: \(aqMySQL\-python\(aq,
    },
    \(aqGentoo\(aq: {
        \(aqserver\(aq: \(aqdev\-db/mysql\(aq,
        \(aqclient\(aq: \(aqdev\-db/mysql\(aq,
        \(aqservice\(aq: \(aqmysql\(aq,
        \(aqconfig\(aq: \(aq/etc/mysql/my.cnf\(aq,
        \(aqpython\(aq: \(aqdev\-python/mysql\-python\(aq,
    },
}, merge=salt[\(aqpillar.get\(aq](\(aqmysql:lookup\(aq)) %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Values defined in the map file can be fetched for the current platform in any
state file using the following syntax:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% from \(dqmysql/map.jinja\(dq import mysql with context %}

mysql\-server:
  pkg.installed:
    \- name: {{ mysql.server }}
  service.running:
    \- name: {{ mysql.service }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Organizing Pillar data
.sp
It is considered a best practice to make formulas expect \fBall\fP
formula\-related parameters to be placed under second\-level \fBlookup\fP key,
within a main namespace designated for holding data for particular
service/software/etc, managed by the formula:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql:
  lookup:
    version: 5.7.11
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Collecting common values
.sp
Common values can be collected into a \fIbase\fP dictionary.  This
minimizes repetition of identical values in each of the
\fBlookup_dict\fP sub\-dictionaries.  Now only the values that are
different from the base must be specified by the alternates:
.sp
\fBmap.jinja\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set mysql = salt[\(aqgrains.filter_by\(aq]({
    \(aqdefault\(aq: {
        \(aqserver\(aq: \(aqmysql\-server\(aq,
        \(aqclient\(aq: \(aqmysql\-client\(aq,
        \(aqservice\(aq: \(aqmysql\(aq,
        \(aqconfig\(aq: \(aq/etc/mysql/my.cnf\(aq,
        \(aqpython\(aq: \(aqpython\-mysqldb\(aq,
    },
    \(aqDebian\(aq: {
    },
    \(aqRedHat\(aq: {
        \(aqclient\(aq: \(aqmysql\(aq,
        \(aqservice\(aq: \(aqmysqld\(aq,
        \(aqconfig\(aq: \(aq/etc/my.cnf\(aq,
        \(aqpython\(aq: \(aqMySQL\-python\(aq,
    },
    \(aqGentoo\(aq: {
        \(aqserver\(aq: \(aqdev\-db/mysql\(aq,
        \(aqclient\(aq: \(aqdev\-db/mysql\(aq,
        \(aqpython\(aq: \(aqdev\-python/mysql\-python\(aq,
    },
},
merge=salt[\(aqpillar.get\(aq](\(aqmysql:lookup\(aq), base=\(aqdefault\(aq) %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Overriding values in the lookup table
.sp
Allow static values within lookup tables to be overridden. This is a simple
pattern which once again increases flexibility and reusability for state files.
.sp
The \fBmerge\fP argument in \fI\%filter_by\fP
specifies the location of a dictionary in Pillar that can be used to override
values returned from the lookup table. If the value exists in Pillar it will
take precedence.
.sp
This is useful when software or configuration files is installed to
non\-standard locations or on unsupported platforms. For example, the following
Pillar would replace the \fBconfig\fP value from the call above.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql:
  lookup:
    config: /usr/local/etc/mysql/my.cnf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Protecting Expansion of Content with Special Characters
.sp
When templating keep in mind that YAML does have special characters for
quoting, flows, and other special structure and content.  When a Jinja
substitution may have special characters that will be incorrectly parsed by
YAML care must be taken.  It is a good policy to use the \fByaml_encode\fP or
the \fByaml_dquote\fP Jinja filters:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- set foo = 7.7 %}
{%\- set bar = none %}
{%\- set baz = true %}
{%\- set zap = \(aqThe word of the day is \(dqsalty\(dq.\(aq %}
{%\- set zip = \(aq\(dqThe quick brown fox . . .\(dq\(aq %}

foo: {{ foo|yaml_encode }}
bar: {{ bar|yaml_encode }}
baz: {{ baz|yaml_encode }}
zap: {{ zap|yaml_encode }}
zip: {{ zip|yaml_dquote }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above will be rendered as below:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo: 7.7
bar: null
baz: true
zap: \(dqThe word of the day is \e\(dqsalty\e\(dq.\(dq
zip: \(dq\e\(dqThe quick brown fox . . .\e\(dq\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The \fI\%filter_by\fP function performs a
simple dictionary lookup but also allows for fetching data from Pillar and
overriding data stored in the lookup table. That same workflow can be easily
performed without using \fBfilter_by\fP; other dictionaries besides data from
Pillar can also be used.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set lookup_table = {...} %}
{% do lookup_table.update(salt.pillar.get(\(aqmy:custom:data\(aq)) %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS When to use lookup tables
.sp
The \fBmap.jinja\fP file is only a convention within Salt Formulas. This greater
pattern is useful for a wide variety of data in a wide variety of workflows.
This pattern is not limited to pulling data from a single file or data source.
This pattern is useful in States, Pillar and the Reactor, for example.
.sp
Working with a data structure instead of, say, a config file allows the data to
be cobbled together from multiple sources (local files, remote Pillar, database
queries, etc), combined, overridden, and searched.
.sp
Below are a few examples of what lookup tables may be useful for and how they
may be used and represented.
.SS Platform\-specific information
.sp
An obvious pattern and one used heavily in Salt Formulas is extracting
platform\-specific information such as package names and file system paths in
a file named \fBmap.jinja\fP\&. The pattern is explained in detail above.
.SS Sane defaults
.sp
Application settings can be a good fit for this pattern. Store default
settings along with the states themselves and keep overrides and sensitive
settings in Pillar. Combine both into a single dictionary and then write the
application config or settings file.
.sp
The example below stores most of the Apache Tomcat \fBserver.xml\fP file
alongside the Tomcat states and then allows values to be updated or augmented
via Pillar. (This example uses the BadgerFish format for transforming JSON to
XML.)
.sp
\fB/srv/salt/tomcat/defaults.yaml\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Server:
  \(aq@port\(aq: \(aq8005\(aq
  \(aq@shutdown\(aq: SHUTDOWN
  GlobalNamingResources:
    Resource:
      \(aq@auth\(aq: Container
      \(aq@description\(aq: User database that can be updated and saved
      \(aq@factory\(aq: org.apache.catalina.users.MemoryUserDatabaseFactory
      \(aq@name\(aq: UserDatabase
      \(aq@pathname\(aq: conf/tomcat\-users.xml
      \(aq@type\(aq: org.apache.catalina.UserDatabase
  # <...snip...>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/pillar/tomcat.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
appX:
  server_xml_overrides:
    Server:
      Service:
        \(aq@name\(aq: Catalina
        Connector:
          \(aq@port\(aq: \(aq8009\(aq
          \(aq@protocol\(aq: AJP/1.3
          \(aq@redirectPort\(aq: \(aq8443\(aq
          # <...snip...>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/salt/tomcat/server_xml.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% import_yaml \(aqtomcat/defaults.yaml\(aq as server_xml_defaults %}
{% set server_xml_final_values = salt.pillar.get(
    \(aqappX:server_xml_overrides\(aq,
    default=server_xml_defaults,
    merge=True)
%}

appX_server_xml:
  file.serialize:
    \- name: /etc/tomcat/server.xml
    \- dataset: {{ server_xml_final_values | json() }}
    \- formatter: xml_badgerfish
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fI\%file.serialize\fP state can provide a
shorthand for creating some files from data structures. There are also many
examples within Salt Formulas of creating one\-off \(dqserializers\(dq (often as Jinja
macros) that reformat a data structure to a specific config file format. For
example, look at the\(gaNginx vhosts\(ga_ states or the \fI\%php.ini\fP file template.
.SS Environment specific information
.sp
A single state can be reused when it is parameterized as described in the
section below, by separating the data the state will use from the state that
performs the work. This can be the difference between deploying \fIApplication X\fP
and \fIApplication Y\fP, or the difference between production and development. For
example:
.sp
\fB/srv/salt/app/deploy.sls\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{# Load the map file. #}
{% import_yaml \(aqapp/defaults.yaml\(aq as app_defaults %}

{# Extract the relevant subset for the app configured on the current
   machine (configured via a grain in this example). #}
{% app = app_defaults.get(salt.grains.get(\(aqrole\(aq)) %}

{# Allow values from Pillar to (optionally) update values from the lookup
   table. #}
{% do app_defaults.update(salt.pillar.get(\(aqmyapp\(aq, {})) %}

deploy_application:
  git.latest:
    \- name: {{ app.repo_url }}
    \- version: {{ app.version }}
    \- target: {{ app.deploy_dir }}

myco/myapp/deployed:
  event.send:
    \- data:
        version: {{ app.version }}
    \- onchanges:
      \- git: deploy_application
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB/srv/salt/app/defaults.yaml\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
appX:
  repo_url: git@github.com/myco/appX.git
  target: /var/www/appX
  version: master
appY:
  repo_url: git@github.com/myco/appY.git
  target: /var/www/appY
  version: v1.2.3.4
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Single\-purpose SLS files
.sp
Each sls file in a Formula should strive to do a single thing. This increases
the reusability of this file by keeping unrelated tasks from getting coupled
together.
.sp
As an  example, the base Apache formula should only install the Apache httpd
server and start the httpd service. This is the basic, expected behavior when
installing Apache. It should not perform additional changes such as set the
Apache configuration file or create vhosts.
.sp
If a formula is single\-purpose as in the example above, other formulas, and
also other states can \fBinclude\fP and use that formula with \fI\%Requisites and Other Global State Arguments\fP
without also including undesirable or unintended side\-effects.
.sp
The following is a best\-practice example for a reusable Apache formula. (This
skips platform\-specific options for brevity. See the full
\fI\%url apache\-formula\fP for more.)
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# apache/init.sls
apache:
  pkg.installed:
    [...]
  service.running:
    [...]

# apache/mod_wsgi.sls
include:
  \- apache

mod_wsgi:
  pkg.installed:
    [...]
    \- require:
      \- pkg: apache

# apache/conf.sls
include:
  \- apache

apache_conf:
  file.managed:
    [...]
    \- watch_in:
      \- service: apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To illustrate a bad example, say the above Apache formula installed Apache and
also created a default vhost. The mod_wsgi state would not be able to include
the Apache formula to create that dependency tree without also installing the
unneeded default vhost.
.sp
\fI\%Formulas should be reusable\fP\&. Avoid coupling
unrelated actions together.
.SS Parameterization
.sp
\fIParameterization is a key feature of Salt Formulas\fP and also for Salt
States. Parameterization allows a single Formula to be reused across many
operating systems; to be reused across production, development, or staging
environments; and to be reused by many people all with varying goals.
.sp
Writing states, specifying ordering and dependencies is the part that takes the
longest to write and to test. Filling those states out with data such as users
or package names or file locations is the easy part. How many users, what those
users are named, or where the files live are all implementation details that
\fBshould be parameterized\fP\&. This separation between a state and the data that
populates a state creates a reusable formula.
.sp
In the example below the data that populates the state can come from anywhere
\-\- it can be hard\-coded at the top of the state, it can come from an external
file, it can come from Pillar, it can come from an execution function call, or
it can come from a database query. The state itself doesn\(aqt change regardless
of where the data comes from. Production data will vary from development data
will vary from data from one company to another, however the state itself stays
the same.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% set user_list = [
    {\(aqname\(aq: \(aqlarry\(aq, \(aqshell\(aq: \(aqbash\(aq},
    {\(aqname\(aq: \(aqcurly\(aq, \(aqshell\(aq: \(aqbash\(aq},
    {\(aqname\(aq: \(aqmoe\(aq, \(aqshell\(aq: \(aqzsh\(aq},
] %}

{# or #}

{% set user_list = salt[\(aqpillar.get\(aq](\(aquser_list\(aq) %}

{# or #}

{% load_json \(dqdefault_users.json\(dq as user_list %}

{# or #}

{% set user_list = salt[\(aqacme_utils.get_user_list\(aq]() %}

{% for user in list_list %}
{{ user.name }}:
  user.present:
    \- name: {{ user.name }}
    \- shell: {{ user.shell }}
{% endfor %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configuration
.sp
Formulas should strive to use the defaults of the underlying platform, followed
by defaults from the upstream project, followed by sane defaults for the
formula itself.
.sp
As an example, a formula to install Apache \fBshould not\fP change the default
Apache configuration file installed by the OS package. However, the Apache
formula \fBshould\fP include a state to change or override the default
configuration file.
.SS Pillar overrides
.sp
Pillar lookups must use the safe \fI\%get()\fP
and must provide a default value. Create local variables using the Jinja
\fBset\fP construct to increase readability and to avoid potentially hundreds or
thousands of function calls across a large state tree.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% from \(dqapache/map.jinja\(dq import apache with context %}
{% set settings = salt[\(aqpillar.get\(aq](\(aqapache\(aq, {}) %}

mod_status:
  file.managed:
    \- name: {{ apache.conf_dir }}
    \- source: {{ settings.get(\(aqmod_status_conf\(aq, \(aqsalt://apache/mod_status.conf\(aq) }}
    \- template: {{ settings.get(\(aqtemplate_engine\(aq, \(aqjinja\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Any default values used in the Formula must also be documented in the
\fBpillar.example\fP file in the root of the repository. Comments should be
used liberally to explain the intent of each configuration value. In addition,
users should be able copy\-and\-paste the contents of this file into their own
Pillar to make any desired changes.
.SS Scripting
.sp
Remember that both State files and Pillar files can easily call out to Salt
\fI\%execution modules\fP and have access to all the system
grains as well.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% if \(aq/storage\(aq in salt[\(aqmount.active\(aq]() %}
/usr/local/etc/myfile.conf:
  file:
    \- symlink
    \- target: /storage/myfile.conf
{% endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Jinja macros to encapsulate logic or conditionals are discouraged in favor of
\fI\%writing custom execution modules\fP in Python.
.SS Repository structure
.sp
A basic Formula repository should have the following layout:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo\-formula
|\-\- foo/
|   |\-\- map.jinja
|   |\-\- init.sls
|   \(ga\-\- bar.sls
|\-\- CHANGELOG.rst
|\-\- LICENSE
|\-\- pillar.example
|\-\- README.rst
\(ga\-\- VERSION
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%url template\-formula\fP
.sp
The \fI\%url template\-formula\fP repository has a pre\-built layout that
serves as the basic structure for a new formula repository. Just copy the
files from there and edit them.
.UNINDENT
.UNINDENT
.SS \fBREADME.rst\fP
.sp
The README should detail each available \fB\&.sls\fP file by explaining what it
does, whether it has any dependencies on other formulas, whether it has a
target platform, and any other installation or usage instructions or tips.
.sp
A sample skeleton for the \fBREADME.rst\fP file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
===
foo
===

Install and configure the FOO service.

**NOTE**

See the full \(gaSalt Formulas installation and usage instructions
<https://docs.saltproject.io/en/latest/topics/development/conventions/formulas.html>\(ga_.

Available states
================

\&.. contents::
    :local:

\(ga\(gafoo\(ga\(ga
\-\-\-\-\-\-\-

Install the \(ga\(gafoo\(ga\(ga package and enable the service.

\(ga\(gafoo.bar\(ga\(ga
\-\-\-\-\-\-\-\-\-\-\-

Install the \(ga\(gabar\(ga\(ga package.
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBCHANGELOG.rst\fP
.sp
The \fBCHANGELOG.rst\fP file should detail the individual versions, their
release date and a set of bullet points for each version highlighting the
overall changes in a given version of the formula.
.sp
A sample skeleton for the \fICHANGELOG.rst\fP file:
.sp
\fBCHANGELOG.rst\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo formula
===========

0.0.2 (2013\-01\-01)

\- Re\-organized formula file layout
\- Fixed filename used for upstart logger template
\- Allow for pillar message to have default if none specified
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Versioning
.sp
Formula are versioned according to Semantic Versioning, \fI\%https://semver.org/\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Given a version number MAJOR.MINOR.PATCH, increment the:
.INDENT 0.0
.IP 1. 3
MAJOR version when you make incompatible API changes,
.IP 2. 3
MINOR version when you add functionality in a backwards\-compatible manner, and
.IP 3. 3
PATCH version when you make backwards\-compatible bug fixes.
.UNINDENT
.sp
Additional labels for pre\-release and build metadata are available as extensions
to the MAJOR.MINOR.PATCH format.
.UNINDENT
.UNINDENT
.sp
Formula versions are tracked using Git tags as well as the \fBVERSION\fP file
in the formula repository. The \fBVERSION\fP file should contain the currently
released version of the particular formula.
.SS Testing Formulas
.sp
A smoke\-test for invalid Jinja, invalid YAML, or an invalid Salt state
structure can be performed by with the \fI\%state.show_sls\fP function:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.show_sls apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Salt Formulas can then be tested by running each \fB\&.sls\fP file via
\fI\%state.apply\fP and checking the output for
the success or failure of each state in the Formula. This should be done for
each supported platform.
.SS SaltStack Packaging Guide
.sp
Since Salt provides a powerful toolkit for system management and automation,
the package can be spit into a number of sub\-tools. While packaging Salt as
a single package containing all components is perfectly acceptable, the split
packages should follow this convention.
.SS Patching Salt For Distributions
.sp
The occasion may arise where Salt source and default configurations may need
to be patched. It is preferable if Salt is only patched to include platform
specific additions or to fix release time bugs. It is preferable that
configuration settings and operations remain in the default state, as changes
here lowers the user experience for users moving across distributions.
.sp
In the event where a packager finds a need to change the default configuration
it is advised to add the files to the master.d or minion.d directories.
.SS Source Files
.sp
Release packages should always be built from the source tarball distributed via
pypi. Release packages should \fINEVER\fP use a git checkout as the source for
distribution.
.SS Single Package
.sp
Shipping Salt as a single package, where the minion, master, and all tools are
together is perfectly acceptable and practiced by distributions such as
FreeBSD.
.SS Split Package
.sp
Salt Should always be split in a standard way, with standard dependencies, this lowers
cross distribution confusion about what components are going to be shipped with
specific packages. These packages can be defined from the Salt Source as of
Salt 2014.1.0:
.SS Salt Common
.sp
The \fIsalt\-common\fP or \fIsalt\fP package should contain the files provided by the
salt python package, or all files distributed from the \fBsalt/\fP directory in
the source distribution packages. The documentation contained under the
\fBdoc/\fP directory can be a part of this package but splitting out a doc
package is preferred.
Since salt\-call is the entry point to utilize the libs and is useful for all
salt packages it is included in the salt\-common package.
.SS Name
.INDENT 0.0
.IP \(bu 2
\fIsalt\fP OR \fIsalt\-common\fP
.UNINDENT
.SS Files
.INDENT 0.0
.IP \(bu 2
\fIsalt/*\fP
.IP \(bu 2
\fIman/salt.7\fP
.IP \(bu 2
\fIscripts/salt\-call\fP
.IP \(bu 2
\fItests/*\fP
.IP \(bu 2
\fIman/salt\-call.1\fP
.UNINDENT
.SS Depends
.INDENT 0.0
.IP \(bu 2
\fIPython 2.6\-2.7\fP
.IP \(bu 2
\fIPyYAML\fP
.IP \(bu 2
\fIJinja2\fP
.UNINDENT
.SS Salt Master
.sp
The \fIsalt\-master\fP package contains the applicable scripts, related man
pages and init information for the given platform.
.SS Name
.INDENT 0.0
.IP \(bu 2
\fIsalt\-master\fP
.UNINDENT
.SS Files
.INDENT 0.0
.IP \(bu 2
\fIscripts/salt\-master\fP
.IP \(bu 2
\fIscripts/salt\fP
.IP \(bu 2
\fIscripts/salt\-run\fP
.IP \(bu 2
\fIscripts/salt\-key\fP
.IP \(bu 2
\fIscripts/salt\-cp\fP
.IP \(bu 2
\fIpkg/<master init data>\fP
.IP \(bu 2
\fIman/salt.1\fP
.IP \(bu 2
\fIman/salt\-master.1\fP
.IP \(bu 2
\fIman/salt\-run.1\fP
.IP \(bu 2
\fIman/salt\-key.1\fP
.IP \(bu 2
\fIman/salt\-cp.1\fP
.IP \(bu 2
\fIconf/master\fP
.UNINDENT
.SS Depends
.INDENT 0.0
.IP \(bu 2
\fISalt Common\fP
.IP \(bu 2
\fIZeroMQ\fP >= 3.2
.IP \(bu 2
\fIPyZMQ\fP >= 2.10
.IP \(bu 2
\fIPyCrypto\fP
.IP \(bu 2
\fIM2Crypto\fP
.IP \(bu 2
\fIPython MessagePack\fP (Messagepack C lib, or msgpack\-pure)
.UNINDENT
.SS Salt Syndic
.sp
The Salt Syndic package can be rolled completely into the Salt Master package.
Platforms which start services as part of the package deployment need to
maintain a separate \fIsalt\-syndic\fP package (primarily Debian based platforms).
.sp
The Syndic may optionally not depend on the anything more than the Salt Master since
the master will bring in all needed dependencies, but fall back to the platform
specific packaging guidelines.
.SS Name
.INDENT 0.0
.IP \(bu 2
\fIsalt\-syndic\fP
.UNINDENT
.SS Files
.INDENT 0.0
.IP \(bu 2
\fIscripts/salt\-syndic\fP
.IP \(bu 2
\fIpkg/<syndic init data>\fP
.IP \(bu 2
\fIman/salt\-syndic.1\fP
.UNINDENT
.SS Depends
.INDENT 0.0
.IP \(bu 2
\fISalt Common\fP
.IP \(bu 2
\fISalt Master\fP
.IP \(bu 2
\fIZeroMQ\fP >= 3.2
.IP \(bu 2
\fIPyZMQ\fP >= 2.10
.IP \(bu 2
\fIPyCrypto\fP
.IP \(bu 2
\fIM2Crypto\fP
.IP \(bu 2
\fIPython MessagePack\fP (Messagepack C lib, or msgpack\-pure)
.UNINDENT
.SS Salt Minion
.sp
The Minion is a standalone package and should not be split beyond the
\fIsalt\-minion\fP and \fIsalt\-common\fP packages.
.SS Name
.INDENT 0.0
.IP \(bu 2
\fIsalt\-minion\fP
.UNINDENT
.SS Files
.INDENT 0.0
.IP \(bu 2
\fIscripts/salt\-minion\fP
.IP \(bu 2
\fIpkg/<minion init data>\fP
.IP \(bu 2
\fIman/salt\-minion.1\fP
.IP \(bu 2
\fIconf/minion\fP
.UNINDENT
.SS Depends
.INDENT 0.0
.IP \(bu 2
\fISalt Common\fP
.IP \(bu 2
\fIZeroMQ\fP >= 3.2
.IP \(bu 2
\fIPyZMQ\fP >= 2.10
.IP \(bu 2
\fIPyCrypto\fP
.IP \(bu 2
\fIM2Crypto\fP
.IP \(bu 2
\fIPython MessagePack\fP (Messagepack C lib, or msgpack\-pure)
.UNINDENT
.SS Salt SSH
.sp
Since Salt SSH does not require the same dependencies as the minion and master, it
should be split out.
.SS Name
.INDENT 0.0
.IP \(bu 2
\fIsalt\-ssh\fP
.UNINDENT
.SS Files
.INDENT 0.0
.IP \(bu 2
\fIscripts/salt\-ssh\fP
.IP \(bu 2
\fIman/salt\-ssh.1\fP
.IP \(bu 2
\fIconf/cloud*\fP
.UNINDENT
.SS Depends
.INDENT 0.0
.IP \(bu 2
\fISalt Common\fP
.IP \(bu 2
\fIPython MessagePack\fP (Messagepack C lib, or msgpack\-pure)
.UNINDENT
.SS Salt Cloud
.sp
As of Salt 2014.1.0 Salt Cloud is included in the same repo as Salt. This
can be split out into a separate package or it can be included in the
salt\-master package.
.SS Name
.INDENT 0.0
.IP \(bu 2
\fIsalt\-cloud\fP
.UNINDENT
.SS Files
.INDENT 0.0
.IP \(bu 2
\fIscripts/salt\-cloud\fP
.IP \(bu 2
\fIman/salt\-cloud.1\fP
.UNINDENT
.SS Depends
.INDENT 0.0
.IP \(bu 2
\fISalt Common\fP
.IP \(bu 2
\fIapache libcloud\fP >= 0.14.0
.UNINDENT
.SS Salt Doc
.sp
The documentation package is very distribution optional. A completely split
package will split out the documentation, but some platform conventions do not
prefer this.
If the documentation is not split out, it should be included with the
\fISalt Common\fP package.
.SS Name
.INDENT 0.0
.IP \(bu 2
\fIsalt\-doc\fP
.UNINDENT
.SS Files
.INDENT 0.0
.IP \(bu 2
\fIdoc/*\fP
.UNINDENT
.SS Optional Depends
.INDENT 0.0
.IP \(bu 2
\fISalt Common\fP
.IP \(bu 2
\fIPython Sphinx\fP
.IP \(bu 2
\fIMake\fP
.UNINDENT
.SS Salt Release Process
.sp
The goal for Salt projects is to cut a new feature release every three to
four months. This document outlines the process for these releases, and the
subsequent bug fix releases which follow.
.SS Feature Release Process
.sp
When a new release is ready to be cut, the person responsible for cutting the
release will follow the following steps (written using the 3000 release as an
example):
.INDENT 0.0
.IP 1. 4
Create first public draft of release notes with major features.
.IP 2. 4
Remove any deprecations for the upcoming release.
.IP 3. 4
Ensure all required features are merged.
.IP 4. 4
Create issue to start the process of deprecating for the next feature release.
.IP 5. 4
Run through a manual test run based off of the head of the feature branch.
.IP 6. 4
Update all name references to version number in the docs. For example
all neon references in the docs needs to be moved to v3000
.IP 7. 4
Review the release notes with major features.
.IP 8. 4
Generate the new man pages for the release.
.IP 9. 4
Create internal RC tag for testing from the head of the master branch.
.IP 10. 4
Build latest windows, mac, ubuntu, debian and redhat packages.
.IP 11. 4
Run manual and package tests against new RC packages.
.IP 12. 4
Push the internal tag live to salt\(aqs repo.
.IP 13. 4
Publish release archive to pypi based off tag.
.IP 14. 4
Push the RC packages live.
.IP 15. 4
Announce new RC to salt\-users and salt\-announce google groups.
.IP 16. 4
Triage incoming issues based on the new RC release.
.IP 17. 4
Fix RC issues once they are categorized as a release blocker.
.IP 18. 4
Depending on the issues found during the RC process make a decision
on whether to release based off the RC or go through another RC process
.IP 19. 4
If a RC is categorized as stable, build all required packages.
.IP 20. 4
Test all release packages.
.IP 21. 4
Test links from \fI\%repo.saltproject.io\fP\&.
.IP 22. 4
Update installation instructions with new release number at \fI\%repo.saltproject.io\fP\&.
.IP 23. 4
Review and update all impacted \fI\%Installation\fP documentation.
.IP 24. 4
Update and build docs to include new version (3000) as the latest.
.IP 25. 4
Pre\-announce on salt\-users google group that we are about to update our repo.
.IP 26. 4
Publish release (v3000) archive to pypi based off tag.
.IP 27. 4
Publish all packages live to repo.
.IP 28. 4
Publish the docs.
.IP 29. 4
Create release at \fI\%github\fP
.IP 30. 4
Update win\-repo\-ng with new salt versions.
.IP 31. 4
Announce release is live to irc, salt\-users, salt\-announce and release slack
community channel.
.UNINDENT
.SS Bugfix Releases
.sp
Once a feature release branch has been cut from the \fBmaster\fP branch, if
serious bugs or a CVE is found for the most recent release a bugfix release
will need to be cut. A temporary branch will be created based off of the previous
release tag. For example, if it is determined that a 3000.1 release needs to occur
a 3000.1 branch will be created based off of the v3000 tag. The fixes that need
to go into 3000.1 will be added and merged into this branch. Here are the steps
for a bugfix release.
.INDENT 0.0
.IP 1. 4
Ensure all required bug fixes are merged.
.IP 2. 4
Create release branch with the version of the release. (ex. 3000.1)
.IP 3. 4
Run through a manual test run based off of the head of the branch.
.IP 4. 4
Generate the new man pages for the release.
.IP 5. 4
Create internal tag for testing.(ex v3000.1)
.IP 6. 4
Build all release packages.
.IP 7. 4
Run manual and package tests against new packages.
.IP 8. 4
Update installation instructions with new release number at \fI\%repo.saltproject.io\fP\&.
.IP 9. 4
Update and build docs to include new version. (ex. 3000.1)
.IP 10. 4
Pre\-announce on salt\-users google groups that we are about to update our repo.
.IP 11. 4
Push the internal tag live to salt\(aqs repo.
.IP 12. 4
Publish release archive to pypi based off tag.
.IP 13. 4
Push the packages live.
.IP 14. 4
Publish release (v3000) archive to pypi based off tag.
.IP 15. 4
Publish all packages live to repo.
.IP 16. 4
Publish the docs.
.IP 17. 4
Create release at \fI\%github\fP
.IP 18. 4
Update win\-repo\-ng with new salt versions.
.IP 19. 4
Announce release is live to irc, salt\-users, salt\-announce and release slack channel.
.UNINDENT
.SS Salt Coding Style
.sp
To make it easier to contribute and read Salt code, SaltStack has \fI\%adopted
Black\fP as its code formatter. There are a few places where Black is
silent, and this guide should be used in those cases.
.sp
Coding style is NEVER grounds to reject code contributions, and is never
grounds to talk down to another member of the community (There are no grounds
to treat others without respect, especially people working to improve Salt)!
.SS Linting
.sp
Most Salt style conventions are codified in Salt\(aqs \fB\&.pylintrc\fP file.
Salt\(aqs linting has two major dependencies: \fI\%pylint\fP and \fI\%saltpylint\fP, the full lint
requirements can be found under \fBrequirements/static/ci/lint.in\fP and the pinned
requirements at \fBrequirements/static/ci/py3.<minor\-version>/lint.txt\fP, however,
linting should be done using \fI\%nox\fP, which is how
pull requests are checked.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e lint
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
One can target either salt\(aqs source code or the test suite(different pylint rules apply):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nox \-e lint\-salt
nox \-e lint\-tests
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Variables
.sp
Variables should be a minimum of three characters and should provide an
easy\-to\-understand name of the object being represented.
.sp
When keys and values are iterated over, descriptive names should be used
to represent the temporary variables.
.sp
Multi\-word variables should be separated by an underscore.
.sp
Variables which are two\-letter words should have an underscore appended
to them to pad them to three characters.
.SS Formatting Strings
.sp
All strings which require formatting should use the \fI\&.format\fP string method:
.sp
Please do NOT use printf formatting, unless it\(aqs a log message.
.sp
Good:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
data = \(dqsome text\(dq
more = \(dq{} and then some\(dq.format(data)
log.debug(\(dq%s and then some\(dq, data)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Bad:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
data = \(dqsome text\(dq
log.debug(\(dq{} and then some\(dq.format(data))
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Docstring Conventions
.sp
When adding a new function or state, where possible try to use a
\fBversionadded\fP directive to denote when the function, state, or parameter was added.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def new_func(msg=\(dq\(dq):
    \(dq\(dq\(dq
    .. versionadded:: 0.16.0

    Prints what was passed to the function.

    msg : None
        The string to be printed.
    \(dq\(dq\(dq
    print(msg)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you are uncertain what version should be used, either consult a core
developer in IRC or bring this up when opening your \fI\%pull request\fP and a core developer will let you know what
version to add. Typically this will be the next element in the \fI\%periodic table\fP\&.
.sp
Similar to the above, when an existing function or state is modified (for
example, when an argument is added), then under the explanation of that new
argument a \fBversionadded\fP directive should be used to note the version in
which the new argument was added. If an argument\(aqs function changes
significantly, the \fBversionchanged\fP directive can be used to clarify this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def new_func(msg=\(dq\(dq, signature=\(dq\(dq):
    \(dq\(dq\(dq
    .. versionadded:: 0.16.0

    Prints what was passed to the function.

    msg : None
        The string to be printed. Will be prepended with \(aqGreetings! \(aq.

    .. versionchanged:: 0.17.1

    signature : None
        An optional signature.

    .. versionadded:: 0.17.0
    \(dq\(dq\(dq
    print(\(dqGreetings! {0}\en\en{1}\(dq.format(msg, signature))
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Dictionaries
.sp
Dictionaries should be initialized using \fI{}\fP instead of \fIdict()\fP\&.
.sp
See \fI\%here\fP for an in\-depth discussion of this topic.
.SS Imports
.sp
Salt code prefers importing modules and not explicit functions. This is both a
style and functional preference. The functional preference originates around
the fact that the module import system used by pluggable modules will include
callable objects (functions) that exist in the direct module namespace. This
is not only messy, but may unintentionally expose code python libs to the Salt
interface and pose a security problem.
.sp
To say this more directly with an example, this is \fIGOOD\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import os


def minion_path():
    path = os.path.join(self.opts[\(dqcachedir\(dq], \(dqminions\(dq)
    return path
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This on the other hand is \fIDISCOURAGED\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from os.path import join


def minion_path():
    path = join(self.opts[\(dqcachedir\(dq], \(dqminions\(dq)
    return path
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The time when this is changed is for importing exceptions, generally directly
importing exceptions is preferred:
.sp
This is a good way to import exceptions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from salt.exceptions import CommandExecutionError
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Absolute Imports
.sp
Although \fI\%absolute imports\fP seems like an awesome idea, please do not use it.
Extra care would be necessary all over salt\(aqs code in order for absolute
imports to work as supposed. Believe it, it has been tried before and, as a
tried example, by renaming \fBsalt.modules.sysmod\fP to \fBsalt.modules.sys\fP, all
other salt modules which needed to import \fBsys\fP would have to
also import \fBabsolute_import\fP, which should be
avoided.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
An exception to this rule is the \fBabsolute_import\fP from \fB__future__\fP at
the top of each file within the Salt project. This import is necessary for
Py3 compatibility. This particular import looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
from __future__ import absolute_import
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This import is required for all new Salt files and is a good idea to add to
any custom states or modules. However, the practice of avoiding absolute
imports still applies to all other cases as to avoid a name conflict.
.UNINDENT
.UNINDENT
.SS Code Churn
.sp
Many pull requests have been submitted that only churn code in the name of
PEP 8. Code churn is a leading source of bugs and is \fBstrongly discouraged\fP\&.
While style fixes are encouraged they should be isolated to a single file per
commit, and the changes should be legitimate, if there are any questions about
whether a style change is legitimate please reference this document and the
official PEP 8 (\fI\%https://legacy.python.org/dev/peps/pep\-0008/\fP) document before
changing code. Many claims that a change is PEP 8 have been invalid, please
double check before committing fixes.
.SS Salt code and internals
.sp
Reference documentation on Salt\(aqs internal code.
.SS Contents
.SS salt.aggregation
.SS salt.utils.aggregation
.sp
This library makes it possible to introspect dataset and aggregate nodes
when it is instructed.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The following examples with be expressed in YAML for convenience\(aqs sake:
.INDENT 0.0
.IP \(bu 2
!aggr\-scalar will refer to Scalar python function
.IP \(bu 2
!aggr\-map will refer to Map python object
.IP \(bu 2
!aggr\-seq will refer for Sequence python object
.UNINDENT
.UNINDENT
.UNINDENT
.SS How to instructs merging
.sp
This yaml document has duplicate keys:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo: !aggr\-scalar first
foo: !aggr\-scalar second
bar: !aggr\-map {first: foo}
bar: !aggr\-map {second: bar}
baz: !aggr\-scalar 42
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
but tagged values instruct Salt that overlapping values they can be merged
together:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo: !aggr\-seq [first, second]
bar: !aggr\-map {first: foo, second: bar}
baz: !aggr\-seq [42]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Default merge strategy is keep untouched
.sp
For example, this yaml document still has duplicate keys, but does not
instruct aggregation:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo: first
foo: second
bar: {first: foo}
bar: {second: bar}
baz: 42
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
So the late found values prevail:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo: second
bar: {second: bar}
baz: 42
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Limitations
.sp
Aggregation is permitted between tagged objects that share the same type.
If not, the default merge strategy prevails.
.sp
For example, these examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo: {first: value}
foo: !aggr\-map {second: value}

bar: !aggr\-map {first: value}
bar: 42

baz: !aggr\-seq [42]
baz: [fail]

qux: 42
qux: !aggr\-scalar fail
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
are interpreted like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo: !aggr\-map{second: value}

bar: 42

baz: [fail]

qux: !aggr\-seq [fail]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Introspection
.sp
TODO: write this part
.INDENT 0.0
.TP
.B class  salt.utils.aggregation.Aggregate
Aggregation base.
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.utils.aggregation.Map
Map aggregation.
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.utils.aggregation.OrderedDict
Dictionary that remembers insertion order
.INDENT 7.0
.TP
.B clear() -> None.  Remove all items from od.
.UNINDENT
.INDENT 7.0
.TP
.B copy() -> a shallow copy of od
.UNINDENT
.INDENT 7.0
.TP
.B fromkeys(value=None)
Create a new ordered dictionary with keys from iterable and values set to value.
.UNINDENT
.INDENT 7.0
.TP
.B items() -> a set\-like object providing a view on D\(aqs items
.UNINDENT
.INDENT 7.0
.TP
.B keys() -> a set\-like object providing a view on D\(aqs keys
.UNINDENT
.INDENT 7.0
.TP
.B move_to_end(key, last=True)
Move an existing element to the end (or beginning if last is false).
.sp
Raise KeyError if the element does not exist.
.UNINDENT
.INDENT 7.0
.TP
.B pop(key[, default]) -> v, remove specified key and return the corresponding value.
If the key is not found, return the default if given; otherwise,
raise a KeyError.
.UNINDENT
.INDENT 7.0
.TP
.B popitem(last=True)
Remove and return a (key, value) pair from the dictionary.
.sp
Pairs are returned in LIFO order if last is true or FIFO order if false.
.UNINDENT
.INDENT 7.0
.TP
.B setdefault(key, default=None)
Insert key with a value of default if key is not in the dictionary.
.sp
Return the value for key if key is in the dictionary, else default.
.UNINDENT
.INDENT 7.0
.TP
.B update([E], **F) -> None.  Update D from dict/iterable E and F.
If E is present and has a .keys() method, then does:  for k in E: D[k] = E[k]
If E is present and lacks a .keys() method, then does:  for k, v in E: D[k] = v
In either case, this is followed by: for k in F:  D[k] = F[k]
.UNINDENT
.INDENT 7.0
.TP
.B values() -> an object providing a view on D\(aqs values
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.utils.aggregation.Scalar(obj)
Shortcut for Sequence creation
.sp
.nf
.ft C
>>> Scalar(\(aqfoo\(aq) == Sequence([\(aqfoo\(aq])
True
.ft P
.fi
.UNINDENT
.INDENT 0.0
.TP
.B class  salt.utils.aggregation.Sequence(iterable=(), /)
Sequence aggregation.
.UNINDENT
.INDENT 0.0
.TP
.B salt.utils.aggregation.aggregate(obj_a, obj_b, level=False, map_class=<class \(aqsalt.utils.aggregation.Map\(aq>, sequence_class=<class \(aqsalt.utils.aggregation.Sequence\(aq>)
Merge obj_b into obj_a.
.sp
.nf
.ft C
>>> aggregate(\(aqfirst\(aq, \(aqsecond\(aq, True) == [\(aqfirst\(aq, \(aqsecond\(aq]
True
.ft P
.fi
.UNINDENT
.INDENT 0.0
.TP
.B salt.utils.aggregation.levelise(level)
Describe which levels are allowed to do deep merging.
.sp
level can be:
.INDENT 7.0
.TP
.B True
all levels are True
.TP
.B False
all levels are False
.TP
.B an int
only the first levels are True, the others are False
.TP
.B a sequence
it describes which levels are True, it can be:
.INDENT 7.0
.IP \(bu 2
a list of bool and int values
.IP \(bu 2
a string of 0 and 1 characters
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B salt.utils.aggregation.mark(obj, map_class=<class \(aqsalt.utils.aggregation.Map\(aq>, sequence_class=<class \(aqsalt.utils.aggregation.Sequence\(aq>)
Convert obj into an Aggregate instance
.UNINDENT
.SS Exceptions
.sp
Salt\-specific exceptions should be thrown as often as possible so the various
interfaces to Salt (CLI, API, etc) can handle those errors appropriately and
display error messages appropriately.
.TS
center;
|l|l|.
_
T{
\fI\%salt.exceptions\fP
T}	T{
This module is a central location for all salt exceptions
T}
_
.TE
.SS salt.exceptions
.sp
This module is a central location for all salt exceptions
.INDENT 0.0
.TP
.B exception  salt.exceptions.ArgumentValueError(message=\(aq\(aq, info=None)
Used when an invalid argument was passed to a command execution
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.AuthenticationError(message=\(aq\(aq)
If sha256 signature fails during decryption
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.AuthorizationError(message=\(aq\(aq)
Thrown when runner or wheel execution fails due to permissions
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.CheckError(message=\(aq\(aq, info=None)
Used when a check fails
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.CodePageError(message=\(aq\(aq, info=None)
Raised when an error ocurs while getting or setting the windows code page
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.CommandExecutionError(message=\(aq\(aq, info=None)
Used when a module runs a command which returns an error and wants
to show the user the output gracefully instead of dying
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.CommandNotFoundError(message=\(aq\(aq)
Used in modules or grains when a required binary is not available
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.EauthAuthenticationError(message=\(aq\(aq)
Thrown when eauth authentication fails
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.FileLockError(message, time_start=None, *args, **kwargs)
Used when an error occurs obtaining a file lock
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.FileserverConfigError(message=\(aq\(aq)
Used when invalid fileserver settings are detected
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.GitLockError(errno, message, *args, **kwargs)
Raised when an uncaught error occurs in the midst of obtaining an
update/checkout lock in salt.utils.gitfs.
.sp
NOTE: While this uses the errno param similar to an OSError, this exception
class is \fInot\fP as subclass of OSError. This is done intentionally, so that
this exception class can be caught in a try/except without being caught as
an OSError.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.GitRemoteError(message=\(aq\(aq)
Used by GitFS to denote a problem with the existence of the \(dqorigin\(dq remote
or part of its configuration
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.InvalidConfigError(message=\(aq\(aq, info=None)
Used when the config is invalid
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.InvalidEntityError(message=\(aq\(aq, info=None)
Used when an entity fails validation
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.InvalidKeyError(message=\(aq\(aq)
Raised when we encounter an invalid RSA key.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.LoaderError(message=\(aq\(aq)
Problems loading the right renderer
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.LoggingRuntimeError
Raised when we encounter an error while logging
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.MasterExit
Rise when the master exits
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.MinionError(message=\(aq\(aq)
Minion problems reading uris such as salt:// or http://
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.MissingSmb(message=\(aq\(aq)
Raised when no smb library is found.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.NotImplemented(message=\(aq\(aq)
Used when a module runs a command which returns an error and wants
to show the user the output gracefully instead of dying
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.NxosCliError(message=\(aq\(aq)
NX\-OS Cli Error raised when Cli command rejected by the NX\-OS device
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.NxosClientError(message=\(aq\(aq)
NX\-OS Client Error raised for problems connecting to the NX\-OS device
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.NxosError(message=\(aq\(aq)
NX\-OS Base Exception class
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.NxosRequestNotSupported(message=\(aq\(aq)
Raised for unsupported client requests
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.PkgParseError(message=\(aq\(aq)
Used when of the pkg modules cannot correctly parse the output from
the CLI tool (pacman, yum, apt, aptitude, etc)
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.PublishError(message=\(aq\(aq)
Problems encountered when trying to publish a command
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltCacheError(message=\(aq\(aq)
Thrown when a problem was encountered trying to read or write from the salt cache
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltClientError(message=\(aq\(aq)
Problem reading the master root key
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltClientTimeout(message, jid=None, *args, **kwargs)
Thrown when a job sent through one of the Client interfaces times out
.sp
Takes the \fBjid\fP as a parameter
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltCloudConfigError(message=\(aq\(aq)
Raised when a configuration setting is not found and should exist.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltCloudException(message=\(aq\(aq)
Generic Salt Cloud Exception
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltCloudExecutionFailure(message=\(aq\(aq)
Raised when too much failures have occurred while querying/waiting for data.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltCloudExecutionTimeout(message=\(aq\(aq)
Raised when too much time has passed while querying/waiting for data.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltCloudNotFound(message=\(aq\(aq)
Raised when some cloud provider function cannot find what\(aqs being searched.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltCloudPasswordError(message=\(aq\(aq)
Raise when virtual terminal password input failed
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltCloudSystemExit(message, exit_code=1)
This exception is raised when the execution should be stopped.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltConfigurationError(message=\(aq\(aq)
Configuration error
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltDaemonNotRunning(message=\(aq\(aq)
Throw when a running master/minion/syndic is not running but is needed to
perform the requested operation (e.g., eauth).
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltDeserializationError(message=\(aq\(aq)
Thrown when salt cannot deserialize data.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltException(message=\(aq\(aq)
Base exception class; all Salt\-specific exceptions should subclass this
.INDENT 7.0
.TP
.B pack()
Pack this exception into a serializable dictionary that is safe for
transport via msgpack
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltInvocationError(message=\(aq\(aq)
Used when the wrong number of arguments are sent to modules or invalid
arguments are specified on the command line
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltMasterError(message=\(aq\(aq)
Problem reading the master root key
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltMasterUnresolvableError(message=\(aq\(aq)
Problem resolving the name of the Salt master
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltNoMinionsFound(message=\(aq\(aq)
An attempt to retrieve a list of minions failed
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltRenderError(message, line_num=None, buf=\(aq\(aq, marker=\(aq    <======================\(aq, trace=None)
Used when a renderer needs to raise an explicit error. If a line number and
buffer string are passed, get_context will be invoked to get the location
of the error.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltReqTimeoutError(message=\(aq\(aq)
Thrown when a salt master request call fails to return within the timeout
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltRunnerError(message=\(aq\(aq)
Problem in runner
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltSyndicMasterError(message=\(aq\(aq)
Problem while proxying a request in the syndication master
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltSystemExit(code=0, msg=None)
This exception is raised when an unsolvable problem is found. There\(aqs
nothing else to do, salt should just exit.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.SaltWheelError(message=\(aq\(aq)
Problem in wheel
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.TemplateError(message=\(aq\(aq)
Used when a custom error is triggered in a template
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.TimedProcTimeoutError(message=\(aq\(aq)
Thrown when a timed subprocess does not terminate within the timeout,
or if the specified timeout is not an int or a float
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.TimeoutError(message=\(aq\(aq)
Thrown when an opration cannot be completet within a given time limit.
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.TokenAuthenticationError(message=\(aq\(aq)
Thrown when token authentication fails
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.VMwareApiError(message=\(aq\(aq, info=None)
Used when representing a generic VMware API error
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.VMwareConnectionError(message=\(aq\(aq, info=None)
Used when the client fails to connect to a either a VMware vCenter server or
to a ESXi host
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.VMwareFileNotFoundError(message=\(aq\(aq, info=None)
Used when representing a generic VMware error if a file not found
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.VMwareMultipleObjectsError(message=\(aq\(aq, info=None)
Used when multiple objects were retrieved (and one was expected)
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.VMwareNotFoundError(message=\(aq\(aq, info=None)
Used when a VMware object was not found
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.VMwareObjectExistsError(message=\(aq\(aq, info=None)
Used when a VMware object already exists
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.VMwareObjectNotFoundError(message=\(aq\(aq, info=None)
Used when a VMware object was not found
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.VMwareObjectRetrievalError(message=\(aq\(aq, info=None)
Used when a VMware object cannot be retrieved
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.VMwarePowerOnError(message=\(aq\(aq, info=None)
Used when error occurred during power on
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.VMwareRuntimeError(message=\(aq\(aq, info=None)
Used when a runtime error is encountered when communicating with the
vCenter
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.VMwareSaltError(message=\(aq\(aq, info=None)
Used when a VMware object cannot be retrieved
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.VMwareSystemError(message=\(aq\(aq, info=None)
Used when representing a generic VMware system error
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.VMwareVmCreationError(message=\(aq\(aq, info=None)
Used when a configuration parameter is incorrect
.UNINDENT
.INDENT 0.0
.TP
.B exception  salt.exceptions.VMwareVmRegisterError(message=\(aq\(aq, info=None)
Used when a configuration parameter is incorrect
.UNINDENT
.INDENT 0.0
.TP
.B salt.exceptions.get_error_message(error)
Get human readable message from Python Exception
.UNINDENT
.SS The Salt Fileserver and Client
.SS Introduction
.sp
Salt has a modular fileserver, and multiple client classes which are used to
interact with it. This page serves as a developer\(aqs reference, to help explain
how the fileserver and clients both work.
.SS Fileserver
.sp
The fileserver is not a daemon, so the fileserver and client are not a true
server and client in the traditional sense. Instead, the fileserver is simply a
class (\fBsalt.fileserver.Fileserver\fP), located in
\fI\%salt/fileserver/__init__.py\fP\&. This class has access to the configured
fileserver backends via a loader instance, referenced as \fBself.servers\fP\&. When
a request comes in from the fileclient, it will ultimately result in a
\fBFileserver\fP class function being run.
.sp
The functions in this class will run corresponding functions in the configured
fileserver backends to perform the requested action. So, in summary:
.INDENT 0.0
.IP 1. 3
A fileclient class makes a request...
.IP 2. 3
which triggers the fileserver to run a function...
.IP 3. 3
which runs a named function in each of the configured backends.
.UNINDENT
.sp
Not all of the functions will always execute on every configured backend. For
instance, the \fBfind_file\fP function in the fileserver will stop when it finds
a match, so if it finds a match for the desired path in the first configured
backend, it won\(aqt proceed and try to find the file in the next backend in the
list.
.sp
Additionally, not all backends implement all functions in the
\fBsalt.fileserver.Fileserver\fP class. For instance, there is a function called
\fBupdate\fP, which exists to update remote fileservers such as the \fBgit\fP,
\fBhg\fP, and \fBsvn\fP backends. This action has no use however in the \fBroots\fP
backend, so it is simply not implemented there, and thus the \fBroots\fP backend
will be skipped if the \fBupdate\fP function is run on the fileserver.
.sp
Backends for the fileserver are located in \fI\%salt/fileserver/\fP (the files not
named \fB__init__.py\fP).
.SS Fileclient
.sp
There are three fileclient classes:
.SS salt.fileclient.RemoteClient
.sp
This client is used when \fI\%file_client\fP is set to \fBremote\fP\&. This
is how minions request files from the master.
.sp
Functions in this client will craft a payload and send it to the master via the
transport channel. This is the same way that the minion asks the minion to do
other things, such as updating and requesting data from the mine. The payload
will be a dictionary with a key called \fBcmd\fP, and other values as needed.
.sp
Payloads sent via the transport channel are processed my an MWorker instance on
the master, and the MWorker\(aqs \fB_handle_aes()\fP function will execute the
command. The command will be a function attribute of the
\fBsalt.master.AESFuncs\fP class. The AESFuncs class\(aq \fB__setup_fileserver()\fP
function instantiates a \fBsalt.fileserver.Fileserver\fP instance and maps its
member functions to AESFuncs attributes. This is what makes the fileserver
functions available remotely. The result of the function is returned back
through the transport channel to the minion.
.sp
Transporting files is done in chunks, the size of which is decided by the
\fBfile_buffer_size\fP config option. If you look at the \fBserve_file()\fP
function in any of the fileserver backends, you can see how the \fBloc\fP value
in the payload determines the offset so that an intermediate chunk of the file
can be served. The RemoteClient\(aqs \fBget_file()\fP function will loop until the
end of the file is reached, retrieving one chunk at a time.
.SS salt.fileclient.FSClient
.sp
This client is used when \fI\%file_client\fP is set to \fBlocal\fP\&. This
is how masterless minions request files.
.sp
This class inherits from the RemoteClient, but instead of using a transport
channel (zmq, tcp, etc.), it uses a \(dqfake\(dq transport channel
(\fBsalt.fileserver.FSChan\fP), which implements its own \fBsend()\fP function.
Thus, when a function that the FSClient inherits from the RemoteClient runs
\fBself.channel.send()\fP, it\(aqs actually calling
\fBsalt.fileserver.FSChan.send()\fP, which calls corresponding functions in the
\fBsalt.fileserver.Fileserver()\fP class. The result is that local file requests
use the same code as remote file requests, they just bypass sending them
through an actual transport channel and instead call them on the FSChan\(aqs
Fileserver instance.
.SS salt.fileclient.LocalClient
.sp
This client is now used exclusively by Pillar. This used to be used when
\fI\%file_client\fP was set to \fBlocal\fP, but the \fBFSChan\fP class was
written to allow minions with \fBfile_client: local\fP to access the full set of
backends. This class will probably be renamed at some point as it is often
confused with \fBsalt.client.LocalClient\fP\&.
.SS The \fI\%cp\fP Module
.sp
Most of the user\-facing interaction with the fileclient happens via the
\fI\%cp\fP module. The functions in this module instantiate a
fileclient instance (if one is not already saved to the \fB__context__\fP
dunder) and run fileclient functions.
.SS Updating the Fileserver
.sp
The master daemon spawns a process dedicated to routine maintenance tasks upon
startup. This process runs an instance of \fBsalt.master.Maintenance\fP, which
loops forever, running a series of functions and then sleeping for a length of
time determined by the \fI\%loop_interval\fP config option. One of the
maintenance tasks is to update the fileserver, and it essentially runs
\fBsalt.fileserver.Fileserver.update()\fP, which as we know from above will run
all configured backends\(aq \fBupdate()\fP functions, if present. This is now remote
fileservers like \fBgit\fP, \fBhg\fP, and \fBsvn\fP stay up\-to\-date.
.sp
For the local file_client (FSClient), since it does not interact with the
master, upon spawning of its FSChan it will update the fileserver.
.SS Salt opts dictionary
.sp
It is very common in the Salt codebase to see \fIopts\fP referred to in a number of
contexts.
.sp
For example, it can be seen as \fI__opts__\fP in certain cases, or simply as \fIopts\fP
as an argument to a function in others.
.sp
Simply put, this data structure is a dictionary of Salt\(aqs runtime configuration
information that\(aqs passed around in order for functions to know how Salt is configured.
.sp
When writing Python code to use specific parts of Salt, it may become necessary
to initialize a copy of \fIopts\fP from scratch in order to have it available for a
given function.
.sp
To do so, use the utility functions available in \fIsalt.config\fP\&.
.sp
As an example, here is how one might generate and print an options dictionary
for a minion instance:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.config

opts = salt.config.minion_config(\(dq/etc/salt/minion\(dq)
print(opts)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To generate and display \fIopts\fP for a master, the process is similar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.config

opts = salt.config.master_config(\(dq/etc/salt/master\(dq)
print(opts)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Unicode in Salt
.sp
Though Unicode handling in large projects can often be complex, Salt adheres to
several basic rules to help developers handle Unicode correctly.
.sp
(For a basic introduction to this problem, see Ned Batchelder\(aqs
\fIexcellent intoroduction to the topic <http://nedbatchelder.com/text/unipain/unipain.html>\fP\&.
.sp
Salt\(aqs basic workflow for Unicode handling is as follows:
.INDENT 0.0
.IP 1. 3
Salt should convert whatever data is passed on CLI/API to Unicode.
Internally, everything that Salt does should be Unicode unless it is
printing to the screen or writing to storage.
.IP 2. 3
Modules and various Salt pluggable systems use incoming data assuming Unicode.
.INDENT 3.0
.TP
.B 2.1) For Salt modules that query an API; the module should convert the data
received from the API into Unicode.
.TP
.B 2.2) For Salt modules that shell out to get output; the module should
convert data received into Unicode. (This does not apply if using the
\fI\%cmd\fP execution module, which should handle
this for you.
.TP
.B 2.3) For Salt modules which print directly to the console (not via an
outputter) or which write directly to disk, a string should be encoded
when appropriate. To handle this conversion, the global variable
\fB__salt_system_encoding__\fP is available, which declares the locale of
the system that Salt is running on.
.UNINDENT
.IP 3. 3
When a function in a Salt module returns a string, it should return a
\fBunicode\fP type in Python 2.
.IP 4. 3
When Salt delivers the data to an outputter or a returner, it is the job of
the outputter or returner to encode the Unicode before displaying it on the
console or writing it to storage.
.UNINDENT
.SS Salt Community Projects
.sp
This page contains links to Salt\-related projects created by community members.
If you come across a useful project please add it to the list!
.SS Hubblestack
.sp
Hubble is a modular, open\-source security compliance framework built on top of
SaltStack. The project provides on\-demand profile\-based auditing, real\-time
security event notifications, automated remediation, alerting and reporting.
.sp
\fI\%https://hubblestack.io/\fP
.SS alkali
.sp
alkali is a collections of SaltStack states and pillar data that provide just
the basics for provisioning Linux instances that may be built upon. alkali is
a starter kit of sorts, to help new users to SaltStack get up\-and\-running
quickly with the most commonly used, core packages.
.sp
\fI\%https://github.com/zulily/alkali\fP
.SS buoyant
.sp
buoyant leverages docker to provide an alternative to VM\-centric SaltStack
development environments. buoyant containers may be spun up nearly instantly,
once an initial docker image has been built.
.sp
\fI\%https://github.com/zulily/buoyant\fP
.SS Salt Sandbox
.sp
Salt Sandbox is a multi\-VM Vagrant\-based Salt development environment used
for creating and testing new Salt state modules outside of your production
environment. It\(aqs also a great way to learn firsthand about Salt and its
remote execution capabilities.
.sp
\fI\%https://github.com/elasticdog/salt\-sandbox\fP
.SS Salt Vagrant Demo
.sp
A Salt Demo using Vagrant.
.sp
\fI\%https://github.com/UtahDave/salt\-vagrant\-demo\fP
.SH RELEASE NOTES
.sp
This page links to the release notes for Salt, including the current, upcoming,
and past releases.
.INDENT 0.0
.IP \(bu 2
New releases and security updates are announced on the
\fI\%Salt Project blog\fP\&. You can subscribe to an
\fI\%RSS feed\fP for announcements.
.IP \(bu 2
See the \fI\%version numbers\fP page for more information
about the version numbering scheme.
.UNINDENT
.SS Upcoming release
(release\-3007.0)=
.SS Salt 3007.0 release notes
.SS Salt\(aqs \fBsetup.py\fP customizations
.INDENT 0.0
.INDENT 3.5
:warning: \fBDeprecation Notice\fP:
In Salt 3009, the \fBsetup.py\fP file will be stripped of it\(aqs custom additions and migrated to a plain \fBpyproject.toml\fP python package
or whatever is found best during the process of removing the customizations.
\fBIf you\(aqre relying on these customizations please stop as your workflow will break in the future\fP\&.
.UNINDENT
.UNINDENT
.SS Python 3.7 Support Dropped
.sp
Support for python 3.7 has been dropped since it reached end\-of\-line in 27 Jun 2023.
.SS Azure Salt Extension
.sp
Starting from Salt version 3007.0, the Azure functionality previously available in the Salt code base is fully removed. To continue using Salt\(aqs features for interacting with Azure resources, users are required to utilize the Azure Salt extension. For more information, refer to the \fI\%Azure Salt Extension GitHub repository\fP\&.
.SS New Package Grain
.sp
A new \fBpackage\fP grain was added in 3007.0 This detects how Salt was installed using the \fB_pkg.txt\fP in the root of
the directory. If you are building packages of Salt you need to ensure this file is set to the correct package type
that you are building. The options are \fBpip\fP, \fBonedir\fP, or \fBsystem\fP\&. By default this file is already set to \fBpip\fP\&.
.SS Improved Vault integration
.sp
This release features a much deeper integration with HashiCorp Vault, for which
many parts of the implementation core were improved. Among other things, the Salt
daemons now attempt to renew/revoke their access tokens and can manage long\-lived leases,
while the Salt master now distributes authentication secrets using response wrapping.
An important new feature concerns the way Vault policies can be managed.
.sp
In versions before 3006, the Salt master only issued tokens to minions, whose policies
could be templated with the minion ID and (insecure) grain values.
3006 introduced secure templating of those policies with pillar values, as well as
templating of Vault external pillar paths with pillar values. These improvements reduced the
overhead of managing Vault policies securely.
.sp
In addition, the Salt master can now be configured to issue AppRoles
to minions and manage their metadata using a similar templating approach.
Since this metadata can be taken advantage of in templated policies on the Vault side,
the need for many boilerplate policies is reduced even further:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
  path \(dqsalt/data/minions/{{identity.entity.metadata.minion\-id}}\(dq {
      capabilities = [\(dqcreate\(dq, \(dqread\(dq, \(dqwrite\(dq, \(dqdelete\(dq, \(dqpatch\(dq]
  }

  path \(dqsalt/data/roles/{{identity.entity.metadata.role}}\(dq {
      capabilities = [\(dqread\(dq]
  }

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Although existing configurations will keep working without intervention after upgrading
the Salt master, it is strongly recommended to adjust the \fBpeer_run\fP configuration to
include the new issuance endpoints in order to avoid unnecessary overhead:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
peer_run:
  .*:
    \- vault.get_config
    \- vault.generate_new_token

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Please see the \fI\%Vault execution module docs\fP for
details and setup instructions regarding AppRole issuance.
.sp
Note: The Vault modules are being moved to a \fI\%Salt extension\fP,
but this improvement has still been merged into core for a smoother transition.
.SS Changelog
.SS Removed
.INDENT 0.0
.IP \(bu 2
Removed RHEL 5 support since long since end\-of\-lifed \fI\%#62520\fP
.IP \(bu 2
Removing Azure\-Cloud modules from the code base. \fI\%#64322\fP
.IP \(bu 2
Dropped Python 3.7 support since it\(aqs EOL in 27 Jun 2023 \fI\%#64417\fP
.IP \(bu 2
Remove salt.payload.Serial \fI\%#64459\fP
.IP \(bu 2
Remove netmiko_conn and pyeapi_conn from salt.modules.napalm_mod \fI\%#64460\fP
.IP \(bu 2
Removed \(aqtransport\(aq arg from salt.utils.event.get_event \fI\%#64461\fP
.IP \(bu 2
Removed the usage of retired Linode API v3 from Salt Cloud \fI\%#64517\fP
.UNINDENT
.SS Deprecated
.INDENT 0.0
.IP \(bu 2
Deprecate all Proxmox cloud modules \fI\%#64224\fP
.IP \(bu 2
Deprecate all the Vault modules in favor of the Vault Salt Extension \fI\%https://github.com/salt\-extensions/saltext\-vault\fP\&. The Vault modules will be removed in Salt core in 3009.0. \fI\%#64893\fP
.IP \(bu 2
Deprecate all the Docker modules in favor of the Docker Salt Extension \fI\%https://github.com/saltstack/saltext\-docker\fP\&. The Docker modules will be removed in Salt core in 3009.0. \fI\%#64894\fP
.IP \(bu 2
Deprecate all the Zabbix modules in favor of the Zabbix Salt Extension \fI\%https://github.com/salt\-extensions/saltext\-zabbix\fP\&. The Zabbix modules will be removed in Salt core in 3009.0. \fI\%#64896\fP
.IP \(bu 2
Deprecate all the Apache modules in favor of the Apache Salt Extension \fI\%https://github.com/salt\-extensions/saltext\-apache\fP\&. The Apache modules will be removed in Salt core in 3009.0. \fI\%#64909\fP
.IP \(bu 2
Deprecation warning for Salt\(aqs backport of \fBOrderedDict\fP class which will be removed in 3009 \fI\%#65542\fP
.IP \(bu 2
Deprecate Kubernetes modules for move to saltext\-kubernetes in version 3009 \fI\%#65565\fP
.IP \(bu 2
Deprecated all Pushover modules in favor of the Salt Extension at \fI\%https://github.com/salt\-extensions/saltext\-pushover\fP\&. The Pushover modules will be removed from Salt core in 3009.0 \fI\%#65567\fP
.IP \(bu 2
Removed deprecated code:
.INDENT 2.0
.IP \(bu 2
All of \fBsalt/log/\fP which has been on a deprecation path for a long time.
.IP \(bu 2
Some of the logging handlers found in \fBsalt/_logging/handlers\fP have been removed since the standard library provides
them.
.IP \(bu 2
Removed the deprecated \fBsalt/modules/cassandra_mod.py\fP module and any tests for it.
.IP \(bu 2
Removed the deprecated \fBsalt/returners/cassandra_return.py\fP module and any tests for it.
.IP \(bu 2
Removed the deprecated \fBsalt/returners/django_return.py\fP module and any tests for it. \fI\%#65986\fP
.UNINDENT
.UNINDENT
.SS Changed
.INDENT 0.0
.IP \(bu 2
Masquerade property will not default to false turning off masquerade if not specified. \fI\%#53120\fP
.IP \(bu 2
Addressed Python 3.11 deprecations:
.INDENT 2.0
.IP \(bu 2
Switch to \fBFullArgSpec\fP since Py 3.11 no longer has \fBArgSpec\fP, deprecated since Py 3.0
.IP \(bu 2
Stopped using the deprecated \fBcgi\fP module.
.IP \(bu 2
Stopped using the deprecated \fBpipes\fP module
.IP \(bu 2
Stopped using the deprecated \fBimp\fP module \fI\%#64457\fP
.UNINDENT
.IP \(bu 2
changed \(aqgpg_decrypt_must_succeed\(aq default from False to True \fI\%#64462\fP
.UNINDENT
.SS Fixed
.INDENT 0.0
.IP \(bu 2
When an NFS or FUSE mount fails to unmount when mount options have changed, try again with a lazy umount before mounting again. \fI\%#18907\fP
.IP \(bu 2
fix autoaccept gpg keys by supporting it in refresh_db module \fI\%#42039\fP
.IP \(bu 2
Made cmd.script work with files from the fileserver via salt\-ssh \fI\%#48067\fP
.IP \(bu 2
Made slsutil.renderer work with salt\-ssh \fI\%#50196\fP
.IP \(bu 2
Fixed defaults.merge is not available when using salt\-ssh \fI\%#51605\fP
.IP \(bu 2
Fix extfs.mkfs missing parameter handling for \-C, \-d, and \-e \fI\%#51858\fP
.IP \(bu 2
Fixed Salt master does not renew token \fI\%#51986\fP
.IP \(bu 2
Fixed salt\-ssh continues state/pillar rendering with incorrect data when an exception is raised by a module on the target \fI\%#52452\fP
.IP \(bu 2
Fix extfs.tune has \(aqreserved\(aq documented twice and is missing the \(aqreserved_percentage\(aq keyword argument \fI\%#54426\fP
.IP \(bu 2
Fix the ability of the \(aqselinux.port_policy_present\(aq state to modify. \fI\%#55687\fP
.IP \(bu 2
Fixed config.get does not support merge option with salt\-ssh \fI\%#56441\fP
.IP \(bu 2
Removed an unused assignment in file.patch \fI\%#57204\fP
.IP \(bu 2
Fixed vault module fetching more than one secret in one run with single\-use tokens \fI\%#57561\fP
.IP \(bu 2
Use brew path from which in mac_brew_pkg module and rely on _homebrew_bin() everytime \fI\%#57946\fP
.IP \(bu 2
Fixed Vault verify option to work on minions when only specified in master config \fI\%#58174\fP
.IP \(bu 2
Fixed vault command errors configured locally \fI\%#58580\fP
.IP \(bu 2
Fixed issue with basic auth causing invalid header error and 401 Bad Request, by using HTTPBasicAuthHandler instead of header. \fI\%#58936\fP
.IP \(bu 2
Make the LXD module work with pyLXD > 2.10 \fI\%#59514\fP
.IP \(bu 2
Return error if patch file passed to state file.patch is malformed. \fI\%#59806\fP
.IP \(bu 2
Handle failure and error information from tuned module/state \fI\%#60500\fP
.IP \(bu 2
Fixed sdb.get_or_set_hash with Vault single\-use tokens \fI\%#60779\fP
.IP \(bu 2
Fixed state.test does not work with salt\-ssh \fI\%#61100\fP
.IP \(bu 2
Made slsutil.findup work with salt\-ssh \fI\%#61143\fP
.IP \(bu 2
Allow all primitive grain types for autosign_grains \fI\%#61416\fP, \fI\%#63708\fP
.IP \(bu 2
\fBipset.new_set\fP no longer fails when creating a set type that uses the \fBfamily\fP create option \fI\%#61620\fP
.IP \(bu 2
Fixed Vault session storage to allow unlimited use tokens \fI\%#62380\fP
.IP \(bu 2
fix the efi grain on FreeBSD \fI\%#63052\fP
.IP \(bu 2
Fixed gpg.receive_keys returns success on failed import \fI\%#63144\fP
.IP \(bu 2
Fixed GPG state module always reports success without changes \fI\%#63153\fP
.IP \(bu 2
Fixed GPG state module does not respect test mode \fI\%#63156\fP
.IP \(bu 2
Fixed gpg.absent with gnupghome/user, fixed gpg.delete_key with gnupghome \fI\%#63159\fP
.IP \(bu 2
Fixed service module does not handle enable/disable if systemd service is an alias \fI\%#63214\fP
.IP \(bu 2
Made x509_v2 compound match detection use new runner instead of peer publishing \fI\%#63278\fP
.IP \(bu 2
Need to make sure we update \fBpillar\fP during a pillar refresh to ensure that process_beacons has the updated beacons loaded from pillar. \fI\%#63583\fP
.IP \(bu 2
This implements the vpc_uuid parameter when creating a droplet. This parameter selects the correct virtual private cloud (private network interface). \fI\%#63714\fP
.IP \(bu 2
pkg.installed no longer reports failure when installing packages that are installed via the task manager \fI\%#63767\fP
.IP \(bu 2
mac_xattr.list and mac_xattr.read will replace undecode\-able bytes to avoid raising CommandExecutionError. \fI\%#63779\fP \fI\%#63779\fP
.IP \(bu 2
Fix aptpkg.latest_version performance, reducing number of times to \(aqshell out\(aq \fI\%#63982\fP
.IP \(bu 2
Added option to use a fresh connection for mysql cache \fI\%#63991\fP
.IP \(bu 2
[lxd] Fixed a bug in \fBcontainer_create\fP which prevented devices which are not of type \fBdisk\fP to be correctly created and added to the container when passed via the \fBdevices\fP parameter. \fI\%#63996\fP
.IP \(bu 2
Skipped the \fBisfile\fP check to greatly increase speed of reading minion keys for systems with a large number of minions on slow file storage \fI\%#64260\fP
.IP \(bu 2
Fix utf8 handling in \(aqpass\(aq renderer \fI\%#64300\fP
.IP \(bu 2
Upgade tornado to 6.3.2 \fI\%#64305\fP
.IP \(bu 2
Prevent errors due missing \(aqtransactional_update.apply\(aq on SLE Micro and MicroOS. \fI\%#64369\fP
.IP \(bu 2
Fix \(aqunable to unmount\(aq failure to return False result instead of None \fI\%#64420\fP
.IP \(bu 2
Fixed issue uninstalling duplicate packages in \fBwin_appx\fP execution module \fI\%#64450\fP
.IP \(bu 2
Clean up tech debt, IPC now uses tcp transport. \fI\%#64488\fP
.IP \(bu 2
Made salt\-ssh more strict when handling unexpected situations and state.* wrappers treat a remote exception as failure, excluded salt\-ssh error returns from mine \fI\%#64531\fP
.IP \(bu 2
Fix flaky test for LazyLoader with isolated mocking of threading.RLock \fI\%#64567\fP
.IP \(bu 2
Fix possible \fBKeyError\fP exceptions in \fBsalt.utils.user.get_group_dict\fP
while reading improper duplicated GID assigned for the user. \fI\%#64599\fP
.IP \(bu 2
changed vm_config() to deep\-merge vm_overrides of specific VM, instead of simple\-merging the whole vm_overrides \fI\%#64610\fP
.IP \(bu 2
Fix the way Salt tries to get the Homebrew\(aqs prefix
.sp
The first attempt to get the Homebrew\(aqs prefix is to look for
the \fBHOMEBREW_PREFIX\fP environment variable. If it\(aqs not set, then
Salt tries to get the prefix from the \fBbrew\fP command. However, the
\fBbrew\fP command can fail. So a last attempt is made to get the
prefix by guessing the installation path. \fI\%#64924\fP
.IP \(bu 2
Add missing MySQL Grant SERVICE_CONNECTION_ADMIN to mysql module. \fI\%#64934\fP
.IP \(bu 2
Fixed slsutil.update with salt\-ssh during template rendering \fI\%#65067\fP
.IP \(bu 2
Keep track when an included file only includes sls files but is a requisite. \fI\%#65080\fP
.IP \(bu 2
Fixed \fBgpg.present\fP succeeds when the keyserver is unreachable \fI\%#65169\fP
.IP \(bu 2
Fix typo in nftables module to ensure unique nft family values \fI\%#65295\fP
.IP \(bu 2
Dereference symlinks to set proper __cli opt \fI\%#65435\fP
.IP \(bu 2
Made salt\-ssh merge master top returns for the same environment \fI\%#65480\fP
.IP \(bu 2
Account for situation where the metadata grain fails because the AWS environment requires an authentication token to query the metadata URL. \fI\%#65513\fP
.IP \(bu 2
Improve the condition of overriding target for pip with VENV_PIP_TARGET environment variable. \fI\%#65562\fP
.IP \(bu 2
Added SSH wrapper for logmod \fI\%#65630\fP
.IP \(bu 2
Include changes in the results when schedule.present state is run with test=True. \fI\%#65652\fP
.IP \(bu 2
Fix extfs.tune doesn\(aqt pass retcode to module.run \fI\%#65686\fP
.IP \(bu 2
Return an error message when the DNS plugin is not supported \fI\%#65739\fP
.IP \(bu 2
Execution modules have access to regular fileclient durring pillar rendering. \fI\%#66124\fP
.IP \(bu 2
Fixed a issue with server channel where a minion\(aqs public key
would be rejected if it contained a final newline character. \fI\%#66126\fP
.UNINDENT
.SS Added
.INDENT 0.0
.IP \(bu 2
Allowed publishing to regular minions from the SSH wrapper \fI\%#40943\fP
.IP \(bu 2
Added syncing of custom salt\-ssh wrappers \fI\%#45450\fP
.IP \(bu 2
Made salt\-ssh sync custom utils \fI\%#53666\fP
.IP \(bu 2
Add ability to use file.managed style check_cmd in file.serialize \fI\%#53982\fP
.IP \(bu 2
Revised use of deprecated net\-tools and added support for ip neighbour with IPv4 ip_neighs, IPv6 ip_neighs6 \fI\%#57541\fP
.IP \(bu 2
Added password support to Redis returner. \fI\%#58044\fP
.IP \(bu 2
Added a state (win_task) for managing scheduled tasks on Windows \fI\%#59037\fP
.IP \(bu 2
Added keyring param to gpg modules \fI\%#59783\fP
.IP \(bu 2
Added new grain to detect the Salt package type: onedir, pip or system \fI\%#62589\fP
.IP \(bu 2
Added Vault AppRole and identity issuance to minions \fI\%#62823\fP
.IP \(bu 2
Added Vault AppRole auth mount path configuration option \fI\%#62825\fP
.IP \(bu 2
Added distribution of Vault authentication details via response wrapping \fI\%#62828\fP
.IP \(bu 2
Add salt package type information. Either onedir, pip or system. \fI\%#62961\fP
.IP \(bu 2
Added signature verification to file.managed/archive.extracted \fI\%#63143\fP
.IP \(bu 2
Added signed_by_any/signed_by_all parameters to gpg.verify \fI\%#63166\fP
.IP \(bu 2
Added match runner \fI\%#63278\fP
.IP \(bu 2
Added Vault token lifecycle management \fI\%#63406\fP
.IP \(bu 2
adding new call for openscap xccdf eval supporting new parameters \fI\%#63416\fP
.IP \(bu 2
Added Vault lease management utility \fI\%#63440\fP
.IP \(bu 2
implement removal of ptf packages in zypper pkg module \fI\%#63442\fP
.IP \(bu 2
add JUnit output for saltcheck \fI\%#63463\fP
.IP \(bu 2
Add ability for file.keyvalue to create a file if it doesn\(aqt exist \fI\%#63545\fP
.IP \(bu 2
added cleanup of temporary mountpoint dir for macpackage installed state \fI\%#63905\fP
.IP \(bu 2
Add pkg.installed show installable version in test mode \fI\%#63985\fP
.IP \(bu 2
Added patch option to Vault SDB driver \fI\%#64096\fP
.IP \(bu 2
Added flags to create local users and groups \fI\%#64256\fP
.IP \(bu 2
Added inline specification of trusted CA root certificate for Vault \fI\%#64379\fP
.IP \(bu 2
Add ability to return False result in test mode of configurable_test_state \fI\%#64418\fP
.IP \(bu 2
Switched Salt\(aqs onedir Python version to 3.11 \fI\%#64457\fP
.IP \(bu 2
Added support for dnf5 and its new command syntax \fI\%#64532\fP
.IP \(bu 2
Adding a new decorator to indicate when a module is deprecated in favor of a Salt extension. \fI\%#64569\fP
.IP \(bu 2
Add jq\-esque to_entries and from_entries functions \fI\%#64600\fP
.IP \(bu 2
Added ability to use PYTHONWARNINGS=ignore to silence deprecation warnings. \fI\%#64660\fP
.IP \(bu 2
Add follow_symlinks to file.symlink exec module to switch to os.path.lexists when False \fI\%#64665\fP
.IP \(bu 2
Strenghten Salt\(aqs HA capabilities with master clustering. \fI\%#64939\fP
.IP \(bu 2
Added win_appx state and execution modules for managing Microsoft Store apps and deprovisioning them from systems \fI\%#64978\fP
.IP \(bu 2
Add support for show_jid to salt\-run
.sp
Adds support for show_jid master config option to salt\-run, so its behaviour matches the salt cli command. \fI\%#65008\fP
.IP \(bu 2
Add ability to remove packages by wildcard via apt execution module \fI\%#65220\fP
.IP \(bu 2
Added support for master top modules on masterless minions \fI\%#65479\fP
.IP \(bu 2
Allowed accessing the regular mine from the SSH wrapper \fI\%#65645\fP
.IP \(bu 2
Allow enabling backup for Linode in Salt Cloud \fI\%#65697\fP
.IP \(bu 2
Add a backup schedule setter fFunction for Linode VMs \fI\%#65713\fP
.IP \(bu 2
Add acme support for manual plugin hooks \fI\%#65744\fP
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
Upgrade to \fBtornado>=6.3.3\fP due to \fI\%https://github.com/advisories/GHSA\-qppv\-j76h\-2rpx\fP \fI\%#64989\fP
.IP \(bu 2
Update to \fBgitpython>=3.1.35\fP due to \fI\%https://github.com/advisories/GHSA\-wfm5\-v35h\-vwf4\fP and \fI\%https://github.com/advisories/GHSA\-cwvm\-v4w8\-q58c\fP \fI\%#65137\fP
.UNINDENT
(release\-3007.1)=
.SS Salt 3007.1 release notes
.SS Changelog
.SS Removed
.INDENT 0.0
.IP \(bu 2
The \fBsalt.utils.psutil_compat\fP was deprecated and now removed in Salt 3008. Please use the \fBpsutil\fP module directly. \fI\%#66160\fP
.UNINDENT
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fixes multiple issues with the cmd module on Windows. Scripts are called using
the \fB\-File\fP parameter to the \fBpowershell.exe\fP binary. \fBCLIXML\fP data in
stderr is now removed (only applies to encoded commands). Commands can now be
sent to \fBcmd.powershell\fP as a list. Makes sure JSON data returned is valid.
Strips whitespace from the return when using \fBrunas\fP\&. \fI\%#61166\fP
.IP \(bu 2
Fixed the win_lgpo_netsh salt util to handle non\-English systems. This was a
rewrite to use PowerShell instead of netsh to make the changes on the system \fI\%#61534\fP
.IP \(bu 2
Fix typo in nftables module to ensure unique nft family values \fI\%#65295\fP
.IP \(bu 2
Corrected x509_v2 CRL creation \fBlast_update\fP and \fBnext_update\fP values when system timezone is not UTC \fI\%#65837\fP
.IP \(bu 2
Fix for NoneType can\(aqt be used in \(aqawait\(aq expression error. \fI\%#66177\fP
.IP \(bu 2
Log \(dqPublish server binding pub to\(dq messages to debug instead of error level. \fI\%#66179\fP
.IP \(bu 2
Fix syndic startup by making payload handler a coroutine \fI\%#66237\fP
.IP \(bu 2
Fixed \fBaptpkg.remove\fP \(dqunable to locate package\(dq error for non\-existent package \fI\%#66260\fP
.IP \(bu 2
Fixed \fI\%pillar.ls\fP doesn\(aqt accept kwargs \fI\%#66262\fP
.IP \(bu 2
Fix cache directory setting in Master Cluster tutorial \fI\%#66264\fP
.IP \(bu 2
Change log level of successful master cluster key exchange from error to info. \fI\%#66266\fP
.IP \(bu 2
Made \fBfile.managed\fP skip download of a remote source if the managed file already exists with the correct hash \fI\%#66342\fP
.IP \(bu 2
Fixed nftables.build_rule breaks ipv6 rules by using the wrong syntax for source and destination addresses \fI\%#66382\fP
.UNINDENT
.SS Added
.INDENT 0.0
.IP \(bu 2
Added the ability to pass a version of chocolatey to install to the
chocolatey.bootstrap function. Also added states to bootstrap and
unbootstrap chocolatey. \fI\%#64722\fP
.IP \(bu 2
Add Ubuntu 24.04 support \fI\%#66180\fP
.IP \(bu 2
Add Fedora 40 support, replacing Fedora 39 \fI\%#66300\fP
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
Bump to \fBpydantic==2.6.4\fP due to \fI\%https://github.com/advisories/GHSA\-mr82\-8j83\-vxmv\fP \fI\%#66433\fP
.IP \(bu 2
Bump to \fBjinja2==3.1.4\fP due to \fI\%https://github.com/advisories/GHSA\-h75v\-3vvj\-5mfj\fP \fI\%#66488\fP
.UNINDENT
.sp
See \fI\%Install a release candidate\fP
for more information about installing an RC when one is available.
.SS Previous releases
(release\-3006.0)=
.SS Salt 3006.0 release notes
.SS Onedir packaging
.sp
Going forward from the 3006.0 release, the Salt Project will only provide onedir
packages to install or upgrade Salt. The classic, non\-onedir packages will not
be provided for supported operating systems. See \fI\%Upgrade to onedir\fP
in the \fI\%Salt Install Guide\fP for information about upgrading from the classic packages to the onedir
packages.
.SS Linux Packaging Salt Master Salt User and Group
.sp
The linux Salt Master packages will now add a Salt user and group
by default. The packages will add the \fBuser: salt\fP config option
to the Salt Master config. The Salt Master service will run as this
user. If you do not want to run the Salt Master as a different user
you can remove the \fBuser: salt\fP config from /etc/salt/master or change
the user to the desired user to run the Salt Master.
.sp
Since the Salt Master is running as a different user, you will need
to ensure you set the owner and group to \fBsalt\fP for your file_roots
and pillar_roots(commonly \fB/srv/salt\fP and \fB/srv/pillar\fP).
.sp
If you are running a Salt Master, Salt\-Api and a Salt Minion on the same
host using the new \fBsalt\fP user and you install a pip dependency into
the onedir environment using \fBsalt\-pip\fP or the \fBpip\fP module, you
need to to chown the directory \fB/opt/saltstack/salt/lib/<python_version>/site\-packages/\fP
with the \fBsalt\fP user and group.
.SS Caveat of salt\-pip
.sp
Salt ships with a wrapper script around pip called \fBsalt\-pip\fP\&. Users should
use \fBsalt\-pip\fP to install any python packages needed to extend Salt.
\fBsalt\-pip\fP installs python packages into an \fBextras\-3.10\fP directory located
in the root of the ondir directory, by setting the \fB\-\-target\fP argument for
pip. This ensures those packages remain installed when upgrading Salt. There is
a known bug in pip when using \fB\-\-target\fP where scripts and other non\-python
assets may not be cleaned up properly when un\-installing.  The Salt team is
working to resolve this bug in the up\-stream pip project.
.SS Dropping support for Python 3.5 and 3.6
.sp
Python 3.5 and 3.6 will no longer be supported by Salt since they
are end of life. Going forward our policy will be to align with Python\(aqs
supported versions. See \fI\%Salt support for Python versions\fP
for more information.
.SS All salt\-api functionality disabled by default
.sp
All netapi clients, which provide the functionality to \fBsalt\-api\fP, will now
be disabled by default as a security precaution. If you use \fBsalt\-api\fP, you
must add the new \fBnetapi_enable_clients\fP option to your salt master config.
This is a breaking change and the \fBsalt\-api\fP will not function without this
new configuration option. See \fI\%Enabling netapi client interfaces\fP
for more information.
.SS How do I migrate to the onedir packages?
.sp
The migration path from the classic, non\-onedir packages to the onedir packages
will include:
.INDENT 0.0
.IP \(bu 2
Repo File: You need to update your repo file to point to the new repo paths
for your platform. After the repo file is updated, upgrade your Salt packages.
.IP \(bu 2
Pip packages: You need to ensure any 3rd party pip packages are installed in
the correct onedir path. This can be accomplished in two ways:
.INDENT 2.0
.IP \(bu 2
\fBsalt\-pip install <package name>\fP
.IP \(bu 2
Using the \fBpip.installed\fP Salt state.
.UNINDENT
.UNINDENT
.sp
To install python packages into the system python environment, user\(aqs must now
provide the \fBpip_bin\fP or \fBbin_env\fP to the pip state module.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lib\-foo:
  pip.installed:
    \- pip_bin: /usr/bin/pip3
lib\-bar:
  pip.installed:
    \- bin_env: /usr/bin/python3

.ft P
.fi
.UNINDENT
.UNINDENT
.SS Changelog
.SS Removed
.INDENT 0.0
.IP \(bu 2
Remove and deprecate the \fBorchestration\fP key from salt.runner and salt.wheel return data. To get it back, set features.enable_deprecated_orchestration_flag master configuration option to True. The flag will be completely removed in Salt 3008 Argon. \fI\%#59917\fP
.IP \(bu 2
Removed distutils and replaced with setuptools, given distutils is deprecated and removed in Python 3.12 \fI\%#60476\fP
.IP \(bu 2
Removed \fBruntests\fP targets from \fBnoxfile.py\fP \fI\%#62239\fP
.IP \(bu 2
Removed the PyObjC dependency.
.sp
This addresses problems with building a one dir build for macOS.
It became problematic because depending on the macOS version, it pulls different dependencies, and we would either have to build a macos onedir for each macOS supported release, or ship a crippled onedir(because it would be tied to the macOS version where the onedir was built).
Since it\(aqs currently not being used, it\(aqs removed. \fI\%#62432\fP
.IP \(bu 2
Removed \fBSixRedirectImporter\fP from Salt. Salt hasn\(aqt shipped \fBsix\fP since Salt 3004. \fI\%#63874\fP
.UNINDENT
.SS Deprecated
.INDENT 0.0
.IP \(bu 2
renamed \fBkeep_jobs\fP, specifying job cache TTL in hours, to \fBkeep_jobs_seconds\fP, specifying TTL in seconds.
\fBkeep_jobs\fP will be removed in the Argon release \fI\%#55295\fP
.IP \(bu 2
Removing all references to napalm\-base which is no longer supported. \fI\%#61542\fP
.IP \(bu 2
The \(aqip_bracket\(aq function has been moved from salt/utils/zeromq.py in salt/utils/network.py \fI\%#62009\fP
.IP \(bu 2
The \fBexpand_repo_def\fP function in \fBsalt.modules.aptpkg\fP is now deprecated. It\(aqs only used in \fBsalt.states.pkgrepo\fP and it has no use of being exposed to the CLI. \fI\%#62485\fP
.IP \(bu 2
Deprecated defunct Django returner \fI\%#62644\fP
.IP \(bu 2
Deprecate core ESXi and associated states and modules, vcenter and vsphere support in favor of Salt VMware Extensions \fI\%#62754\fP
.IP \(bu 2
Removing manufacture grain which has been deprecated. \fI\%#62914\fP
.IP \(bu 2
Removing deprecated utils/boto3_elasticsearch.py \fI\%#62915\fP
.IP \(bu 2
Removing support for the now deprecated _ext_nodes from salt/master.py. \fI\%#62917\fP
.IP \(bu 2
Deprecating the Salt Slack engine in favor of the Salt Slack Bolt Engine. \fI\%#63095\fP
.IP \(bu 2
\fBsalt.utils.version.StrictVersion\fP is now deprecated and it\(aqs use should be replaced with \fBsalt.utils.version.Version\fP\&. \fI\%#63383\fP
.UNINDENT
.SS Changed
.INDENT 0.0
.IP \(bu 2
More intelligent diffing in changes of file.serialize state. \fI\%#48609\fP
.IP \(bu 2
Move deprecation of the neutron module to Argon. Please migrate to the neutronng module instead. \fI\%#49430\fP
.IP \(bu 2
\fBumask\fP is now a global state argument, instead of only applying to \fBcmd\fP
states. \fI\%#57803\fP
.IP \(bu 2
Update pillar.obfuscate to accept kwargs in addition to args.  This is useful when passing in keyword arguments like saltenv that are then passed along to pillar.items. \fI\%#58971\fP
.IP \(bu 2
Improve support for listing macOS brew casks \fI\%#59439\fP
.IP \(bu 2
Add missing MariaDB Grants to mysql module.
MariaDB has added some grants in 10.4.x and 10.5.x that are not present here, which results in an error when creating.
Also improved exception handling in \fBgrant_add\fP which did not log the original error message and replaced it with a generic error. \fI\%#61409\fP
.IP \(bu 2
Use VENV_PIP_TARGET environment variable as a default target for pip if present. \fI\%#62089\fP
.IP \(bu 2
Disabled FQDNs grains on macOS by default \fI\%#62168\fP
.IP \(bu 2
Replaced pyroute2.IPDB with pyroute2.NDB, as the former is deprecated \fI\%#62218\fP
.IP \(bu 2
Enhance capture of error messages for Zypper calls in zypperpkg module. \fI\%#62346\fP
.IP \(bu 2
Removed GPG_1_3_1 check \fI\%#62895\fP
.IP \(bu 2
Requisite state chunks now all consistently contain \fB__id__\fP, \fB__sls__\fP and \fBname\fP\&. \fI\%#63012\fP
.IP \(bu 2
netapi_enable_clients option to allow enabling/disabling of clients in salt\-api.
By default all clients will now be disabled. Users of salt\-api will need
to update their master config to enable the clients that they use. Not adding
the netapi_enable_clients option with required clients to the master config will
disable salt\-api. \fI\%#63050\fP
.IP \(bu 2
Stop relying on \fBsalt/_version.py\fP to write Salt\(aqs version. Instead use \fBsalt/_version.txt\fP which only contains the version string. \fI\%#63383\fP
.IP \(bu 2
Set enable_fqdns_grains to be False by default. \fI\%#63595\fP
.IP \(bu 2
Changelog snippet files must now have a \fB\&.md\fP file extension to be more explicit on what type of rendering is done when they are included in the main \fBCHANGELOG.md\fP file. \fI\%#63710\fP
.IP \(bu 2
Upgraded to \fBrelenv==0.9.0\fP \fI\%#63883\fP
.UNINDENT
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Add kwargs to handle extra parameters for http.query \fI\%#36138\fP
.IP \(bu 2
Fix mounted bind mounts getting active mount options added \fI\%#39292\fP
.IP \(bu 2
Fix \fBsysctl.present\fP converts spaces to tabs. \fI\%#40054\fP
.IP \(bu 2
Fixes state pkg.purged to purge removed packages on Debian family systems \fI\%#42306\fP
.IP \(bu 2
Fix fun_args missing from syndic returns \fI\%#45823\fP
.IP \(bu 2
Fix mount.mounted with \(aqmount: False\(aq reports unmounted file system as unchanged when running with test=True \fI\%#47201\fP
.IP \(bu 2
Issue #49310: Allow users to touch a file with Unix date of birth \fI\%#49310\fP
.IP \(bu 2
Do not raise an exception in pkg.info_installed on nonzero return code \fI\%#51620\fP
.IP \(bu 2
Passes the value of the force parameter from file.copy to its call to file.remove so that files with the read\-only attribute are handled. \fI\%#51739\fP
.IP \(bu 2
Fixed x509.certificate_managed creates new certificate every run in the new cryptography x509 module. Please migrate to the new cryptography x509 module for this improvement. \fI\%#52167\fP
.IP \(bu 2
Don\(aqt check for cached pillar errors on state.apply \fI\%#52354\fP, \fI\%#57180\fP, \fI\%#59339\fP
.IP \(bu 2
Swapping out args and kwargs for arg and kwarg respectively in the Slack engine when the command passed is a runner. \fI\%#52400\fP
.IP \(bu 2
Ensure when we\(aqre adding chunks to the rules when running aggregation with the iptables state module we use a copy of the chunk otherwise we end up with a recursive mess. \fI\%#53353\fP
.IP \(bu 2
When user_create or user_remove fail, return False instead of returning the error. \fI\%#53377\fP
.IP \(bu 2
Include sync_roster when sync_all is called. \fI\%#53914\fP
.IP \(bu 2
Avoid warning noise in lograte.get \fI\%#53988\fP
.IP \(bu 2
Fixed listing revoked keys with gpg.list_keys \fI\%#54347\fP
.IP \(bu 2
Fix mount.mounted does not handle blanks properly \fI\%#54508\fP
.IP \(bu 2
Fixed grain num_cpus get wrong CPUs count in case of inconsistent CPU numbering. \fI\%#54682\fP
.IP \(bu 2
Fix spelling error for python_shell argument in dpkg_lower module \fI\%#54907\fP
.IP \(bu 2
Cleaned up bytes response data before sending to non\-bytes compatible returners (postgres, mysql) \fI\%#55226\fP
.IP \(bu 2
Fixed malformed state return when testing file.managed with unavailable source file \fI\%#55269\fP
.IP \(bu 2
Included stdout in error message for Zypper calls in zypperpkg module. \fI\%#56016\fP
.IP \(bu 2
Fixed pillar.filter_by with salt\-ssh \fI\%#56093\fP
.IP \(bu 2
Fix boto_route53 issue with (multiple) VPCs. \fI\%#57139\fP
.IP \(bu 2
Remove log from mine runner which was not used. \fI\%#57463\fP
.IP \(bu 2
Fixed x509.read_certificate error when reading a Microsoft CA issued certificate in the new cryptography x509 module. Please migrate to the new cryptography x509 module for this improvement. \fI\%#57535\fP
.IP \(bu 2
Updating Slack engine to use slack_bolt library. \fI\%#57842\fP
.IP \(bu 2
Fixed warning about replace=True with x509.certificate_managed in the new cryptography x509 module. \fI\%#58165\fP
.IP \(bu 2
Fix salt.modules.pip:is_installed doesn\(aqt handle locally installed packages \fI\%#58202\fP
.IP \(bu 2
Add missing MariaDB Grants to mysql module. MariaDB has added some grants in 10.4.x and 10.5.x that are not present here, which results in an error when creating. \fI\%#58297\fP
.IP \(bu 2
linux_shadow: Fix cases where malformed shadow entries cause \fBuser.present\fP
states to fail. \fI\%#58423\fP
.IP \(bu 2
Fixed salt.utils.compat.cmp to work with dictionaries \fI\%#58729\fP
.IP \(bu 2
Fixed formatting for terse output mode \fI\%#58953\fP
.IP \(bu 2
Fixed RecursiveDictDiffer with added nested dicts \fI\%#59017\fP
.IP \(bu 2
Fixed x509.certificate_managed has DoS effect on master in the new cryptography x509 module. Please migrate to the new cryptography x509 module for this improvement. \fI\%#59169\fP
.IP \(bu 2
Fixed saltnado websockets disconnecting immediately \fI\%#59183\fP
.IP \(bu 2
Fixed x509.certificate_managed rolls certificates every now and then in the new cryptography x509 module. Please migrate to the new cryptography x509 module for this improvement. \fI\%#59315\fP
.IP \(bu 2
Fix postgres_privileges.present not idempotent for functions \fI\%#59585\fP
.IP \(bu 2
Fixed influxdb_continuous_query.present state to provide the client args to the underlying module on create. \fI\%#59766\fP
.IP \(bu 2
Warn when using insecure (http:// based) key_urls for apt\-based systems in pkgrepo.managed, and add a kwarg that determines the validity of such a url. \fI\%#59786\fP
.IP \(bu 2
add load balancing policy default option and ensure the module can be executed with arguments from CLI \fI\%#59909\fP
.IP \(bu 2
Fix salt\-ssh when using imports with extra\-filerefs. \fI\%#60003\fP
.IP \(bu 2
Fixed cache directory corruption startup error \fI\%#60170\fP
.IP \(bu 2
Update docs remove dry_run in docstring of file.blockreplace state. \fI\%#60227\fP
.IP \(bu 2
Adds Parrot to OS_Family_Map in grains. \fI\%#60249\fP
.IP \(bu 2
Fixed stdout and stderr being empty sometimes when use_vt=True for the cmd.run[*] functions \fI\%#60365\fP
.IP \(bu 2
Use return code in iptables \-\-check to verify rule exists. \fI\%#60467\fP
.IP \(bu 2
Fix regression pip.installed does not pass env_vars when calling pip.list \fI\%#60557\fP
.IP \(bu 2
Fix xfs module when additional output included in mkfs.xfs command. \fI\%#60853\fP
.IP \(bu 2
Fixed parsing new format of terraform states in roster.terraform \fI\%#60915\fP
.IP \(bu 2
Fixed recognizing installed ARMv7 rpm packages in compatible architectures. \fI\%#60994\fP
.IP \(bu 2
Fixing changes dict in pkg state to be consistent when installing and test=True. \fI\%#60995\fP
.IP \(bu 2
Fix cron.present duplicating entries when changing timespec to special. \fI\%#60997\fP
.IP \(bu 2
Made salt\-ssh respect \-\-wipe again \fI\%#61083\fP
.IP \(bu 2
state.orchestrate_single only passes a pillar if it is set to the state
function. This allows it to be used with state functions that don\(aqt accept a
pillar keyword argument. \fI\%#61092\fP
.IP \(bu 2
Fix ipset state when the comment kwarg is set. \fI\%#61122\fP
.IP \(bu 2
Fix issue with archive.unzip where the password was not being encoded for the extract function \fI\%#61422\fP
.IP \(bu 2
Some Linux distributions (like AlmaLinux, Astra Linux, Debian, Mendel, Linux
Mint, Pop!_OS, Rocky Linux) report different \fBoscodename\fP, \fBosfullname\fP,
\fBosfinger\fP grains if lsb\-release is installed or not. They have been changed to
only derive these OS grains from \fB/etc/os\-release\fP\&. \fI\%#61618\fP
.IP \(bu 2
Pop!_OS uses the full version (\fI\%YY.MM\fP) in the osfinger grain now, not just the year. This allows differentiating for example between 20.04 and 20.10. \fI\%#61619\fP
.IP \(bu 2
Fix ssh config roster to correctly parse the ssh config files that contain spaces. \fI\%#61650\fP
.IP \(bu 2
Fix SoftLayer configuration not raising an exception when a domain is missing \fI\%#61727\fP
.IP \(bu 2
Allow the minion to start or salt\-call to run even if the user doesn\(aqt have permissions to read the root_dir value from the registry \fI\%#61789\fP
.IP \(bu 2
Need to move the creation of the proxy object for the ProxyMinion further down in the initialization for sub proxies to ensure that all modules, especially any custom proxy modules, are available before attempting to run the init function. \fI\%#61805\fP
.IP \(bu 2
Fixed malformed state return when merge\-serializing to an improperly formatted file \fI\%#61814\fP
.IP \(bu 2
Made cmdmod._run[_all]_quiet work during minion startup on MacOS with runas specified (which fixed mac_service) \fI\%#61816\fP
.IP \(bu 2
When deleting the vault cache, also delete from the session cache \fI\%#61821\fP
.IP \(bu 2
Ignore errors on reading license info with dpkg_lowpkg to prevent tracebacks on getting package information. \fI\%#61827\fP
.IP \(bu 2
win_lgpo: Display conflicting policy names when more than one policy is found \fI\%#61859\fP
.IP \(bu 2
win_lgpo: Fixed intermittent KeyError when getting policy setting using lgpo.get_policy \fI\%#61860\fP
.IP \(bu 2
Fixed listing minions on OpenBSD \fI\%#61966\fP
.IP \(bu 2
Make Salt to return an error on \(dqpkg\(dq modules and states when targeting duplicated package names \fI\%#62019\fP
.IP \(bu 2
Fix return of REST\-returned permissions when auth_list is set \fI\%#62022\fP
.IP \(bu 2
Normalize package names once on using pkg.installed/removed with yum to make it possible to install packages with the name containing a part similar to a name of architecture. \fI\%#62029\fP
.IP \(bu 2
Fix inconsitency regarding name and pkgs parameters between zypperpkg.upgrade() and yumpkg.upgrade() \fI\%#62030\fP
.IP \(bu 2
Fix attr=all handling in pkg.list_pkgs() (yum/zypper). \fI\%#62032\fP
.IP \(bu 2
Fixed the humanname being ignored in pkgrepo.managed on openSUSE Leap \fI\%#62053\fP
.IP \(bu 2
Fixed issue with some LGPO policies having whitespace at the beginning or end of the element alias \fI\%#62058\fP
.IP \(bu 2
Fix ordering of args to libcloud_storage.download_object module \fI\%#62074\fP
.IP \(bu 2
Ignore extend declarations in sls files that are excluded. \fI\%#62082\fP
.IP \(bu 2
Remove leftover usage of impacket \fI\%#62101\fP
.IP \(bu 2
Pass executable path from _get_path_exec() is used when calling the program.
The $HOME env is no longer modified globally.
Only trailing newlines are stripped from the fetched secret.
Pass process arguments are handled in a secure way. \fI\%#62120\fP
.IP \(bu 2
Ignore some command return codes in openbsdrcctl_service to prevent spurious errors \fI\%#62131\fP
.IP \(bu 2
Fixed extra period in filename output in tls module. Instead of \(dqserver.crt.\(dq it will now be \(dqserver.crt\(dq. \fI\%#62139\fP
.IP \(bu 2
Make sure lingering PAexec\-*.exe files in the Windows directory are cleaned up \fI\%#62152\fP
.IP \(bu 2
Restored Salt\(aqs DeprecationWarnings \fI\%#62185\fP
.IP \(bu 2
Fixed issue with forward slashes on Windows with file.recurse and clean=True \fI\%#62197\fP
.IP \(bu 2
Recognize OSMC as Debian\-based \fI\%#62198\fP
.IP \(bu 2
Fixed Zypper module failing on RPM lock file being temporarily unavailable. \fI\%#62204\fP
.IP \(bu 2
Improved error handling and diagnostics in the proxmox salt\-cloud driver \fI\%#62211\fP
.IP \(bu 2
Added EndeavourOS to the Arch os_family. \fI\%#62220\fP
.IP \(bu 2
Fix salt\-ssh not detecting \fBplatform\-python\fP as a valid interpreter on EL8 \fI\%#62235\fP
.IP \(bu 2
Fix pkg.version_cmp on openEuler and a few other os flavors. \fI\%#62248\fP
.IP \(bu 2
Fix localhost detection in glusterfs.peers \fI\%#62273\fP
.IP \(bu 2
Fix Salt Package Manager (SPM) exception when calling spm create_repo . \fI\%#62281\fP
.IP \(bu 2
Fix matcher slowness due to loader invocation \fI\%#62283\fP
.IP \(bu 2
Fixes the Puppet module for non\-aio Puppet packages for example running the Puppet module on FreeBSD. \fI\%#62323\fP
.IP \(bu 2
Issue 62334: Displays a debug log message instead of an error log message when the publisher fails to connect \fI\%#62334\fP
.IP \(bu 2
Fix pyobjects renderer access to opts and sls \fI\%#62336\fP
.IP \(bu 2
Fix use of random shuffle and sample functions as Jinja filters \fI\%#62372\fP
.IP \(bu 2
Fix groups with duplicate GIDs are not returned by get_group_list \fI\%#62377\fP
.IP \(bu 2
Fix the \(dqzpool.present\(dq state when enabling zpool features that are already active. \fI\%#62390\fP
.IP \(bu 2
Fix ability to execute remote file client methods in saltcheck \fI\%#62398\fP
.IP \(bu 2
Update all platforms to use pycparser 2.21 or greater for Py 3.9 or higher, fixes fips fault with openssl v3.x \fI\%#62400\fP
.IP \(bu 2
Due to changes in the Netmiko library for the exception paths, need to check the version of Netmiko python library and then import the exceptions from different locations depending on the result. \fI\%#62405\fP
.IP \(bu 2
When using preq on a state, then prereq state will first be run with test=True to determine if there are changes.  When there are changes, the state with the prereq option will be run prior to the prereq state.  If this state fails then the prereq state will not run and the state output uses the test=True run.  However, the proposed changes are included for the prereq state are included from the test=True run.  We should pull those out as there weren\(aqt actually changes since the prereq state did not run. \fI\%#62408\fP
.IP \(bu 2
Added directory mode for file.copy with makedirs \fI\%#62426\fP
.IP \(bu 2
Provide better error handling in the various napalm proxy minion functions when the device is not accessible. \fI\%#62435\fP
.IP \(bu 2
When handling aggregation, change the order to ensure that the requisites are aggregated first and then the state functions are aggregated.  Caching whether aggregate functions are available for particular states so we don\(aqt need to attempt to load them everytime. \fI\%#62439\fP
.IP \(bu 2
The patch allows to boostrap kubernetes clusters in the version above 1.13 via salt module \fI\%#62451\fP
.IP \(bu 2
sysctl.persist now updates the in\-memory value on FreeBSD even if the on\-disk value was already correct. \fI\%#62461\fP
.IP \(bu 2
Fixed parsing CDROM apt sources \fI\%#62474\fP
.IP \(bu 2
Update sanitizing masking for Salt SSH to include additional password like strings. \fI\%#62483\fP
.IP \(bu 2
Fix user/group checking on file state functions in the test mode. \fI\%#62499\fP
.IP \(bu 2
Fix user.present to allow removing groups using optional_groups parameter and enforcing idempotent group membership. \fI\%#62502\fP
.IP \(bu 2
Fix possible tracebacks if there is a package with \(aq\-\-\-\-\-\-\(aq or \(aq======\(aq in the description is installed on the Debian based minion. \fI\%#62519\fP
.IP \(bu 2
Fixed the omitted \(dqpool\(dq parameter when cloning a VM with the proxmox salt\-cloud driver \fI\%#62521\fP
.IP \(bu 2
Fix rendering of pyobjects states in saltcheck \fI\%#62523\fP
.IP \(bu 2
Fixes pillar where a corrupted CacheDisk file forces the pillar to be rebuilt \fI\%#62527\fP
.IP \(bu 2
Use str() method instead of repo_line for when python3\-apt is installed or not in \fI\%aptpkg.py\fP\&. \fI\%#62546\fP
.IP \(bu 2
Remove the connection_timeout from netmiko_connection_args before netmiko_connection_args is added to \fBcontext\fP[\(dqnetmiko_device\(dq][\(dqargs\(dq] which is passed along to the Netmiko library. \fI\%#62547\fP
.IP \(bu 2
Fix order specific mount.mounted options for persist \fI\%#62556\fP
.IP \(bu 2
Fixed salt\-cloud cloning a proxmox VM with a specified new vmid. \fI\%#62558\fP
.IP \(bu 2
Fix runas with cmd module when using the onedir bundled packages \fI\%#62565\fP
.IP \(bu 2
Update setproctitle version for all platforms \fI\%#62576\fP
.IP \(bu 2
Fixed missing parameters when cloning a VM with the proxmox salt\-cloud driver \fI\%#62580\fP
.IP \(bu 2
Handle PermissionError when importing crypt when FIPS is enabled. \fI\%#62587\fP
.IP \(bu 2
Correctly reraise exceptions in states.http \fI\%#62595\fP
.IP \(bu 2
Fixed syndic eauth. Now jobs will be published when a valid eauth user is targeting allowed minions/functions. \fI\%#62618\fP
.IP \(bu 2
updated rest_cherry/app to properly detect arg sent as a string as curl will do when only one arg is supplied. \fI\%#62624\fP
.IP \(bu 2
Prevent possible tracebacks in core grains module by ignoring non utf8 characters in /proc/1/environ, /proc/1/cmdline, /proc/cmdline \fI\%#62633\fP
.IP \(bu 2
Fixed vault ext pillar return data for KV v2 \fI\%#62651\fP
.IP \(bu 2
Fix saltcheck _get_top_states doesn\(aqt pass saltenv to state.show_top \fI\%#62654\fP
.IP \(bu 2
Fix groupadd.* functions hard code relative command name \fI\%#62657\fP
.IP \(bu 2
Fixed pdbedit.create trying to use a bytes\-like hash as string. \fI\%#62670\fP
.IP \(bu 2
Fix depenency on legacy boto module in boto3 modules \fI\%#62672\fP
.IP \(bu 2
Modified \(dq_get_flags\(dq function so that it returns regex flags instead of integers \fI\%#62676\fP
.IP \(bu 2
Change startup ReqServer log messages from error to info level. \fI\%#62728\fP
.IP \(bu 2
Fix kmod.* functions hard code relative command name \fI\%#62772\fP
.IP \(bu 2
Remove mako as a dependency in Windows and macOS. \fI\%#62785\fP
.IP \(bu 2
Fix mac_brew_pkg to work with null taps \fI\%#62793\fP
.IP \(bu 2
Fixing a bug when listing the running schedule if \(dqschedule.enable\(dq and/or \(dqschedule.disable\(dq has been run, where the \(dqenabled\(dq items is being treated as a schedule item. \fI\%#62795\fP
.IP \(bu 2
Prevent annoying RuntimeWarning message about line buffering (buffering=1) not being supported in binary mode \fI\%#62817\fP
.IP \(bu 2
Include UID and GID checks in modules.file.check_perms as well as comparing
ownership by username and group name. \fI\%#62818\fP
.IP \(bu 2
Fix presence events on TCP transport by removing a client\(aqs presence when minion disconnects from publish channel correctly \fI\%#62826\fP
.IP \(bu 2
Remove Azure deprecation messages from functions that always run w/ salt\-cloud \fI\%#62845\fP
.IP \(bu 2
Use select instead of iterating over entrypoints as a dictionary for importlib_metadata>=5.0.0 \fI\%#62854\fP
.IP \(bu 2
Fixed master job scheduler using when \fI\%#62858\fP
.IP \(bu 2
LGPO: Added support for missing domain controller policies: VulnerableChannelAllowList and LdapEnforceChannelBinding \fI\%#62873\fP
.IP \(bu 2
Fix unnecessarily complex gce metadata grains code to use googles metadata service more effectively. \fI\%#62878\fP
.IP \(bu 2
Fixed dockermod version_info function for docker\-py 6.0.0+ \fI\%#62882\fP
.IP \(bu 2
Moving setting the LOAD_BALANCING_POLICY_MAP dictionary into the try except block that determines if the cassandra_cql module should be made available. \fI\%#62886\fP
.IP \(bu 2
Updating various MongoDB module functions to work with latest version of pymongo. \fI\%#62900\fP
.IP \(bu 2
Restored channel for Syndic minions to send job returns to the Salt master. \fI\%#62933\fP
.IP \(bu 2
removed _resolve_deps as it required a library that is not generally avalible. and switched to apt\-get for everything as that can auto resolve dependencies. \fI\%#62934\fP
.IP \(bu 2
Updated pyzmq to version 22.0.3 on Windows builds because the old version was causing salt\-minion/salt\-call to hang \fI\%#62937\fP
.IP \(bu 2
Allow root user to modify crontab lines for non\-root users (except AIX and Solaris). Align crontab line changes with the file ones and also with listing crontab. \fI\%#62940\fP
.IP \(bu 2
Fix systemd_service.* functions hard code relative command name \fI\%#62942\fP
.IP \(bu 2
Fix file.symlink backupname operation can copy remote contents to local disk \fI\%#62953\fP
.IP \(bu 2
Issue #62968: Fix issue where cloud deployments were putting the keys in the wrong location on Windows hosts \fI\%#62968\fP
.IP \(bu 2
Fixed gpg_passphrase issue with gpg decrypt/encrypt functions \fI\%#62977\fP
.IP \(bu 2
Fix file.tidied FileNotFoundError \fI\%#62986\fP
.IP \(bu 2
Fixed bug where module.wait states were detected as running legacy module.run syntax \fI\%#62988\fP
.IP \(bu 2
Fixed issue with win_wua module where it wouldn\(aqt load if the CryptSvc was set to Manual start \fI\%#62993\fP
.IP \(bu 2
The \fB__opts__\fP dunder dictionary is now added to the loader\(aqs \fBpack\fP if not
already present, which makes it accessible via the
\fBsalt.loader.context.NamedLoaderContext\fP class. \fI\%#63013\fP
.IP \(bu 2
Issue #63024: Fix issue where grains and config data were being place in the wrong location on Windows hosts \fI\%#63024\fP
.IP \(bu 2
Fix btrfs.subvolume_snapshot command failing \fI\%#63025\fP
.IP \(bu 2
Fix file.retention_schedule always reports changes \fI\%#63033\fP
.IP \(bu 2
Fix mongo authentication for mongo ext_pillar and mongo returner
.sp
This fix also include the ability to use the mongo connection string for mongo ext_pillar \fI\%#63058\fP
.IP \(bu 2
Fixed x509.create_csr creates invalid CSR by default in the new cryptography x509 module. \fI\%#63103\fP
.IP \(bu 2
TCP transport documentation now contains proper master/minion\-side filtering information \fI\%#63120\fP
.IP \(bu 2
Fixed gpg.verify does not respect gnupghome \fI\%#63145\fP
.IP \(bu 2
User responsible for the runner is now correctly reported in the events on the event bus for the runner. \fI\%#63148\fP
.IP \(bu 2
Made pillar cache pass extra minion data as well \fI\%#63208\fP
.IP \(bu 2
Fix serious performance issues with the file.tidied module \fI\%#63231\fP
.IP \(bu 2
Fix rpm_lowpkg version comparison logic when using rpm\-vercmp and only one version has a release number. \fI\%#63317\fP
.IP \(bu 2
Import StrictVersion and LooseVersion from setuptools.distutils.verison or setuptools._distutils.version, if first not available \fI\%#63350\fP
.IP \(bu 2
\fBservice.status\fP on Windows does no longer throws a CommandExecutionError if
the service is not found on the system. It now returns \(dqNot Found\(dq instead. \fI\%#63577\fP
.IP \(bu 2
When the shell is passed as powershell or pwsh, only wrapper the shell in quotes if cmd.run is running on Windows.  When quoted on Linux hosts, this results in an error when the keyword arguments are appended. \fI\%#63590\fP
.IP \(bu 2
LGPO: Added support for \(dqRelax minimum password length limits\(dq \fI\%#63596\fP
.IP \(bu 2
Fixed the ability to set a scheduled task to auto delete if not scheduled to run again (\fBdelete_after\fP) \fI\%#63650\fP
.IP \(bu 2
When a job is disabled only increase it\(aqs _next_fire_time value if the job would have run at the current time, eg. the current _next_fire_time == now. \fI\%#63699\fP
.IP \(bu 2
have salt.template.compile_template_str cleanup its temp files. \fI\%#63724\fP
.IP \(bu 2
Check file is not empty before attempting to read pillar disk cache file \fI\%#63729\fP
.IP \(bu 2
Fixed an issue with generating fingerprints for public keys with different line endings \fI\%#63742\fP
.IP \(bu 2
Add \fBfileserver_interval\fP and \fBmaintenance_interval\fP master configuration options. These options control how often to restart the FileServerUpdate and Maintenance processes. Some file server and pillar configurations are known to cause memory leaks over time. A notable example of this are configurations that use pygit2. Salt can not guarantee dependency libraries like pygit2 won\(aqt leak memory. Restarting any long running processes that use pygit2 guarantees we can keep the master\(aqs memory usage in check. \fI\%#63747\fP
.IP \(bu 2
mac_xattr.list and mac_xattr.read will replace undecode\-able bytes to avoid raising CommandExecutionError. \fI\%#63779\fP \fI\%#63779\fP
.IP \(bu 2
Change default GPG keyserver from \fI\%pgp.mit.edu\fP to \fI\%keys.openpgp.org\fP\&. \fI\%#63806\fP
.IP \(bu 2
fix cherrypy 400 error output to be less generic. \fI\%#63835\fP
.IP \(bu 2
Ensure kwargs is passed along to _call_apt when passed into install function. \fI\%#63847\fP
.IP \(bu 2
remove eval and update logging to be more informative on bad config \fI\%#63879\fP
.IP \(bu 2
add linux_distribution to util to stop dep warning \fI\%#63904\fP
.IP \(bu 2
Fix valuerror when trying to close fileclient. Remove usage of \fBdel\fP and close the filclient properly. \fI\%#63920\fP
.IP \(bu 2
Handle the situation when a sub proxy minion does not init properly, eg. an exception happens, and the sub proxy object is not available. \fI\%#63923\fP
.IP \(bu 2
Clarifying documentation for extension_modules configuration option. \fI\%#63929\fP
.IP \(bu 2
Windows pkg module now properly handles versions containing strings \fI\%#63935\fP
.IP \(bu 2
Handle the scenario when the check_cmd requisite is used with a state function when the state has a local check_cmd function but that function isn\(aqt used by that function. \fI\%#63948\fP
.IP \(bu 2
Issue #63981: Allow users to pass verify_ssl to pkg.install/pkg.installed on Windows \fI\%#63981\fP
.IP \(bu 2
Hardened permissions on workers.ipc and master_event_pub.ipc. \fI\%#64063\fP
.UNINDENT
.SS Added
.INDENT 0.0
.IP \(bu 2
Introduce a \fBLIB_STATE_DIR\fP syspaths variable which defaults to \fBCONFIG_DIR\fP,
but can be individually customized during installation by specifying
\fB\-\-salt\-lib\-state\-dir\fP during installation. Change the default \fBpki_dir\fP to
\fB<LIB_STATE_DIR>/pki/master\fP (for the master) and \fB<LIB_STATE_DIR>/pki/minion\fP
(for the minion). \fI\%#3396\fP
.IP \(bu 2
Allow users to enable \(aqqueue=True\(aq for all state runs via config file \fI\%#31468\fP
.IP \(bu 2
Added pillar templating to vault policies \fI\%#43287\fP
.IP \(bu 2
Add support for NVMeF as a transport protocol for hosts in a Pure Storage FlashArray \fI\%#51088\fP
.IP \(bu 2
A new salt\-ssh roster that generates a roster by parses a known_hosts file. \fI\%#54679\fP
.IP \(bu 2
Added Windows Event Viewer support \fI\%#54713\fP
.IP \(bu 2
Added the win_lgpo_reg state and execution modules which will allow registry based group policy to be set directly in the Registry.pol file \fI\%#56013\fP
.IP \(bu 2
Added resource tagging functions to boto_dynamodb execution module \fI\%#57500\fP
.IP \(bu 2
Added \fBopenvswitch_db\fP state module and functions \fBbridge_to_parent\fP,
\fBbridge_to_vlan\fP, \fBdb_get\fP, and \fBdb_set\fP to the \fBopenvswitch\fP execution module.
Also added optional \fBparent\fP and \fBvlan\fP parameters to the
\fBopenvswitch_bridge.present\fP state module function and the
\fBopenvswitch.bridge_create\fP execution module function. \fI\%#58986\fP
.IP \(bu 2
State module to manage SysFS attributes \fI\%#60154\fP
.IP \(bu 2
Added ability for \fBsalt.wait_for_event\fP to handle \fBevent_id\fPs that have a list value. \fI\%#60430\fP
.IP \(bu 2
Added suport for Linux ppc64le core grains (cpu_model, virtual, productname, manufacturer, serialnumber) and arm core grains (serialnumber, productname) \fI\%#60518\fP
.IP \(bu 2
Added autostart option to virt.defined and virt.running states, along with virt.update execution modules. \fI\%#60700\fP
.IP \(bu 2
Added .0 back to our versioning scheme for future versions (e.g. 3006.0) \fI\%#60722\fP
.IP \(bu 2
Initial work to allow parallel startup of proxy minions when used as sub proxies with Deltaproxy. \fI\%#61153\fP
.IP \(bu 2
Added node label support for GCE \fI\%#61245\fP
.IP \(bu 2
Support the \-\-priority flag when adding sources to Chocolatey. \fI\%#61319\fP
.IP \(bu 2
Add namespace option to ext_pillar.http_json \fI\%#61335\fP
.IP \(bu 2
Added a filter function to ps module to get a list of processes on a minion according to their state. \fI\%#61420\fP
.IP \(bu 2
Add postgres.timeout option to postgres module for limiting postgres query times \fI\%#61433\fP
.IP \(bu 2
Added new optional vault option, \fBconfig_location\fP\&. This can be either \fBmaster\fP or \fBlocal\fP and defines where vault will look for connection details, either requesting them from the master or using the local config. \fI\%#61857\fP
.IP \(bu 2
Add ipwrap() jinja filter to wrap IPv6 addresses with brackets. \fI\%#61931\fP
.IP \(bu 2
\(aqtcp\(aq transport is now available in ipv6\-only network \fI\%#62009\fP
.IP \(bu 2
Add \fBdiff_attr\fP parameter to pkg.upgrade() (zypper/yum). \fI\%#62031\fP
.IP \(bu 2
Config option pass_variable_prefix allows to distinguish variables that contain paths to pass secrets.
Config option pass_strict_fetch allows to error out when a secret cannot be fetched from pass.
Config option pass_dir allows setting the PASSWORD_STORE_DIR env for pass.
Config option pass_gnupghome allows setting the $GNUPGHOME env for pass. \fI\%#62120\fP
.IP \(bu 2
Add file.pruned state and expanded file.rmdir exec module functionality \fI\%#62178\fP
.IP \(bu 2
Added \(dqdig.PTR\(dq function to resolve PTR records for IPs, as well as tests and documentation \fI\%#62275\fP
.IP \(bu 2
Added the ability to remove a KB using the DISM state/execution modules \fI\%#62366\fP
.IP \(bu 2
Add \(dq python\(dq subcommand to allow execution or arbitrary scripts via bundled Python runtime \fI\%#62381\fP
.IP \(bu 2
Add ability to provide conditions which convert normal state actions to no\-op when true \fI\%#62446\fP
.IP \(bu 2
Added debug log messages displaying the command being run when installing packages on Windows \fI\%#62480\fP
.IP \(bu 2
Add biosvendor grain \fI\%#62496\fP
.IP \(bu 2
Add ifelse Jinja function as found in CFEngine \fI\%#62508\fP
.IP \(bu 2
Implementation of Amazon EC2 instance detection and setting \fBvirtual_subtype\fP grain accordingly including the product if possible to identify. \fI\%#62539\fP
.IP \(bu 2
Adds __env__substitution to ext_pillar.stack; followup of #61531, improved exception handling for stacked template (jinja) template rendering and yaml parsing in ext_pillar.stack \fI\%#62578\fP
.IP \(bu 2
Increase file.tidied flexibility with regard to age and size \fI\%#62678\fP
.IP \(bu 2
Added \(dqconnected_devices\(dq feature to netbox pillar module. It contains extra information about devices connected to the minion \fI\%#62761\fP
.IP \(bu 2
Add atomic file operation for symlink changes \fI\%#62768\fP
.IP \(bu 2
Add password/account locking/unlocking in user.present state on supported operating systems \fI\%#62856\fP
.IP \(bu 2
Added onchange configuration for script engine \fI\%#62867\fP
.IP \(bu 2
Added output and bare functionality to export_key gpg module function \fI\%#62978\fP
.IP \(bu 2
Add keyvalue serializer for environment files \fI\%#62983\fP
.IP \(bu 2
Add ability to ignore symlinks in file.tidied \fI\%#63042\fP
.IP \(bu 2
salt\-cloud support IMDSv2 tokens when using \(aquse\-instance\-role\-credentials\(aq \fI\%#63067\fP
.IP \(bu 2
Fix running fast tests twice and add git labels to suite. \fI\%#63081\fP
.IP \(bu 2
Add ability for file.symlink to not set ownership on existing links \fI\%#63093\fP
.IP \(bu 2
Restore the previous slack engine and deprecate it, rename replace the slack engine to slack_bolt until deprecation \fI\%#63095\fP
.IP \(bu 2
Add functions that will return the underlying block device, mount point, and filesystem type for a given path \fI\%#63098\fP
.IP \(bu 2
Add ethtool execution and state module functions for pause \fI\%#63128\fP
.IP \(bu 2
Add boardname grain \fI\%#63131\fP
.IP \(bu 2
Added management of ECDSA/EdDSA private keys with x509 modules in the new cryptography x509 module. Please migrate to the new cryptography x509 module for this improvement. \fI\%#63248\fP
.IP \(bu 2
Added x509 modules support for different output formats in the new cryptography x509 module. Please migrate to the new cryptography x509 module for this improvement. \fI\%#63249\fP
.IP \(bu 2
Added deprecation_warning test state for ensuring that deprecation warnings are correctly emitted. \fI\%#63315\fP
.IP \(bu 2
Adds a state_events option to state.highstate, state.apply, state.sls, state.sls_id.
This allows users to enable state_events on a per use basis rather than having to
enable them globally for all state runs. \fI\%#63316\fP
.IP \(bu 2
Allow max queue size setting for state runs to prevent performance problems from queue growth \fI\%#63356\fP
.IP \(bu 2
Add support of exposing meta_server_grains for Azure VMs \fI\%#63606\fP
.IP \(bu 2
Include the version of \fBrelenv\fP in the versions report. \fI\%#63827\fP
.IP \(bu 2
Added debug log messages displaying the command being run when removing packages on Windows \fI\%#63866\fP
.IP \(bu 2
Adding the ability to exclude arguments from a state that end up passed to cmd.retcode when requisites such as onlyif or unless are used. \fI\%#63956\fP
.IP \(bu 2
Add \-\-next\-release argument to salt/version.py, which prints the next upcoming release. \fI\%#64023\fP
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
Upgrade Requirements Due to Security Issues.
.INDENT 2.0
.IP \(bu 2
Upgrade to \fBcryptography>=39.0.1\fP due to:
.INDENT 2.0
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-x4qr\-2fvf\-3mr5\fP
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-w7pp\-m8wf\-vj6r\fP
.UNINDENT
.IP \(bu 2
Upgrade to \fBpyopenssl==23.0.0\fP due to the cryptography upgrade.
.IP \(bu 2
Update to \fBmarkdown\-it\-py==2.2.0\fP due to:
.INDENT 2.0
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-jrwr\-5x3p\-hvc3\fP
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-vrjv\-mxr7\-vjf8\fP \fI\%#63882\fP
.UNINDENT
.UNINDENT
.UNINDENT
(release\-3006.1)=
.SS Salt 3006.1 release notes
.SS Changelog
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Check that the return data from the cloud create function is a dictionary before attempting to pull values out. \fI\%#61236\fP
.IP \(bu 2
Ensure NamedLoaderContext\(aqs have their value() used if passing to other modules \fI\%#62477\fP
.IP \(bu 2
add documentation note about reactor state ids. \fI\%#63589\fP
.IP \(bu 2
Added support for \fBtest=True\fP to the \fBfile.cached\fP state module \fI\%#63785\fP
.IP \(bu 2
Updated \fBsource_hash\fP documentation and added a log warning when \fBsource_hash\fP is used with a source other than \fBhttp\fP, \fBhttps\fP and \fBftp\fP\&. \fI\%#63810\fP
.IP \(bu 2
Fixed clear pillar cache on every highstate and added clean_pillar_cache=False to saltutil functions. \fI\%#64081\fP
.IP \(bu 2
Fix dmsetup device names with hyphen being picked up. \fI\%#64082\fP
.IP \(bu 2
Update all the scheduler functions to include a fire_event argument which will determine whether to fire the completion event onto the event bus.
This event is only used when these functions are called via the schedule execution modules.
Update all the calls to the schedule related functions in the deltaproxy proxy minion to include fire_event=False, as the event bus is not available when these functions are called. \fI\%#64102\fP, \fI\%#64103\fP
.IP \(bu 2
Default to a 0 timeout if none is given for the terraform roster to avoid \fB\-o ConnectTimeout=None\fP when using \fBsalt\-ssh\fP \fI\%#64109\fP
.IP \(bu 2
Disable class level caching of the file client on \fBSaltCacheLoader\fP and properly use context managers to take care of initialization and termination of the file client. \fI\%#64111\fP
.IP \(bu 2
Fixed several file client uses which were not properly terminating it by switching to using it as a context manager
whenever possible or making sure \fB\&.destroy()\fP was called when using a context manager was not possible. \fI\%#64113\fP
.IP \(bu 2
Fix running \fI\%setup.py\fP when passing in \-\-salt\-config\-dir and \-\-salt\-cache\-dir arguments. \fI\%#64114\fP
.IP \(bu 2
Moved /etc/salt/proxy and /lib/systemd/system/salt\-proxy@.service to the salt\-minion DEB package \fI\%#64117\fP
.IP \(bu 2
Stop passing \fB**kwargs\fP and be explicit about the keyword arguments to pass, namely, to \fBcp.cache_file\fP call in \fBsalt.states.pkg\fP \fI\%#64118\fP
.IP \(bu 2
lgpo_reg.set_value now returns \fBTrue\fP on success instead of \fBNone\fP \fI\%#64126\fP
.IP \(bu 2
Make salt user\(aqs home /opt/saltstack/salt \fI\%#64141\fP
.IP \(bu 2
Fix cmd.run doesn\(aqt output changes in test mode \fI\%#64150\fP
.IP \(bu 2
Move salt user and group creation to common package \fI\%#64158\fP
.IP \(bu 2
Fixed issue in salt\-cloud so that multiple masters specified in the cloud
are written to the minion config properly \fI\%#64170\fP
.IP \(bu 2
Make sure the \fBsalt\-ssh\fP CLI calls it\(aqs \fBfsclient.destroy()\fP method when done. \fI\%#64184\fP
.IP \(bu 2
Stop using the deprecated \fBsalt.transport.client\fP imports. \fI\%#64186\fP
.IP \(bu 2
Add a \fB\&.pth\fP to the Salt onedir env to ensure packages in extras are importable. Bump relenv to 0.12.3. \fI\%#64192\fP
.IP \(bu 2
Fix \fBlgpo_reg\fP state to work with User policy \fI\%#64200\fP
.IP \(bu 2
Cloud deployment directories are owned by salt user and group \fI\%#64204\fP
.IP \(bu 2
\fBlgpo_reg\fP state now enforces and reports changes to the registry \fI\%#64222\fP
.UNINDENT
(release\-3006.2)=
.SS Salt 3006.2 release notes
.SS Changelog
.SS Fixed
.INDENT 0.0
.IP \(bu 2
In scenarios where PythonNet fails to load, Salt will now fall back to WMI for
gathering grains information \fI\%#64897\fP
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
fix CVE\-2023\-20897 by catching exception instead of letting exception disrupt connection \fI\%#cve\-2023\-20897\fP
.IP \(bu 2
Fixed gitfs cachedir_basename to avoid hash collisions. Added MP Lock to gitfs. These changes should stop race conditions. \fI\%#cve\-2023\-20898\fP
.IP \(bu 2
Upgrade to \fBrequests==2.31.0\fP
.sp
Due to:
.INDENT 2.0
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-j8r2\-6x86\-q33q\fP \fI\%#64336\fP
.UNINDENT
.IP \(bu 2
Upgrade to \fBcryptography==41.0.3\fP(and therefor \fBpyopenssl==23.2.0\fP due to \fI\%https://github.com/advisories/GHSA\-jm77\-qphf\-c4w8\fP)
.sp
This only really impacts pip installs of Salt and the windows onedir since the linux and macos onedir build every package dependency from source, not from pre\-existing wheels.
.sp
Also resolves the following cryptography advisories:
.sp
Due to:
.INDENT 2.0
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-5cpq\-8wj7\-hf2v\fP
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-x4qr\-2fvf\-3mr5\fP
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-w7pp\-m8wf\-vj6r\fP
.UNINDENT
.sp
There is no security upgrade available for Py3.5 \fI\%#64595\fP
.IP \(bu 2
Bump to \fBcertifi==2023.07.22\fP due to \fI\%https://github.com/advisories/GHSA\-xqr8\-7jwr\-rhp7\fP \fI\%#64718\fP
.IP \(bu 2
Upgrade \fBrelenv\fP to \fB0.13.2\fP and Python to \fB3.10.12\fP
.sp
Addresses multiple CVEs in Python\(aqs dependencies: \fI\%https://docs.python.org/release/3.10.12/whatsnew/changelog.html#python\-3\-10\-12\fP \fI\%#64719\fP
.UNINDENT
(release\-3006.3)=
.SS Salt 3006.3 release notes
.SS Changelog
.SS Removed
.INDENT 0.0
.IP \(bu 2
Fedora 36 support was removed because it reached EOL \fI\%#64315\fP
.IP \(bu 2
Handle deprecation warnings:
.INDENT 2.0
.IP \(bu 2
Switch to \fBFullArgSpec\fP since Py 3.11 no longer has \fBArgSpec\fP, deprecated since Py 3.0
.IP \(bu 2
Stop using the deprecated \fBcgi\fP module
.IP \(bu 2
Stop using the deprecated \fBpipes\fP module
.IP \(bu 2
Stop using the deprecated \fBimp\fP module \fI\%#64553\fP
.UNINDENT
.UNINDENT
.SS Changed
.INDENT 0.0
.IP \(bu 2
Replace libnacl with PyNaCl \fI\%#64372\fP
.IP \(bu 2
Don\(aqt hardcode the python version on the Salt Package tests and on the \fBpkg/debian/salt\-cloud.postinst\fP file \fI\%#64553\fP
.IP \(bu 2
Some more deprecated code fixes:
.INDENT 2.0
.IP \(bu 2
Stop using the deprecated \fBlocale.getdefaultlocale()\fP function
.IP \(bu 2
Stop accessing deprecated attributes
.IP \(bu 2
\fBpathlib.Path.__enter__()\fP usage is deprecated and not required, a no\-op \fI\%#64565\fP
.UNINDENT
.IP \(bu 2
Bump to \fBpyyaml==6.0.1\fP due to \fI\%https://github.com/yaml/pyyaml/issues/601\fP and address lint issues \fI\%#64657\fP
.UNINDENT
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fix for assume role when used salt\-cloud to create aws ec2. \fI\%#52501\fP
.IP \(bu 2
fixes aptpkg module by checking for blank comps. \fI\%#58667\fP
.IP \(bu 2
\fBwheel.file_roots.find\fP is now able to find files in subdirectories of the roots. \fI\%#59800\fP
.IP \(bu 2
pkg.latest no longer fails when multiple versions are reported to be installed (e.g. updating the kernel) \fI\%#60931\fP
.IP \(bu 2
Do not update the credentials dictionary in \fButils/aws.py\fP while iterating over it, and use the correct delete functionality \fI\%#61049\fP
.IP \(bu 2
fixed runner not having a proper exit code when runner modules throw an exception. \fI\%#61173\fP
.IP \(bu 2
\fBpip.list_all_versions\fP now works with \fBindex_url\fP and \fBextra_index_url\fP \fI\%#61610\fP
.IP \(bu 2
speed up file.recurse by using prefix with cp.list_master_dir and remove an un\-needed loop. \fI\%#61998\fP
.IP \(bu 2
Preserve test=True condition while running sub states. \fI\%#62590\fP
.IP \(bu 2
Job returns are only sent to originating master \fI\%#62834\fP
.IP \(bu 2
Fixes an issue with failing subsequent state runs with the lgpo state module.
The \fBlgpo.get_polcy\fP function now returns all boolean settings. \fI\%#63296\fP
.IP \(bu 2
Fix SELinux get policy with trailing whitespace \fI\%#63336\fP
.IP \(bu 2
Fixes an issue with boolean settings not being reported after being set. The
\fBlgpo.get_polcy\fP function now returns all boolean settings. \fI\%#63473\fP
.IP \(bu 2
Ensure body is returned when salt.utils.http returns something other than 200 with tornado backend. \fI\%#63557\fP
.IP \(bu 2
Allow long running pillar and file client requests to finish using request_channel_timeout and request_channel_tries minion config. \fI\%#63824\fP
.IP \(bu 2
Fix state_queue type checking to allow int values \fI\%#64122\fP
.IP \(bu 2
Call global logger when catching pip.list exceptions in states.pip.installed
Rename global logger \fBlog\fP to \fBlogger\fP inside pip_state \fI\%#64169\fP
.IP \(bu 2
Fixes permissions created by the Debian and RPM packages for the salt user.
.sp
The salt user created by the Debian and RPM packages to run the salt\-master process, was previously given ownership of various directories in a way which compromised the benefits of running the salt\-master process as a non\-root user.
.sp
This fix sets the salt user to only have write access to those files and
directories required for the salt\-master process to run. \fI\%#64193\fP
.IP \(bu 2
Fix user.present state when groups is unset to ensure the groups are unchanged, as documented. \fI\%#64211\fP
.IP \(bu 2
Fixes issue with MasterMinion class loading configuration from \(ga/etc/salt/minion.d/*.conf.
.sp
The MasterMinion class (used for running orchestraions on master and other functionality) was incorrectly loading configuration from \fB/etc/salt/minion.d/*.conf\fP, when it should only load configuration from \fB/etc/salt/master\fP and \fB/etc/salt/master.d/*.conf\fP\&. \fI\%#64219\fP
.IP \(bu 2
Fixed issue in mac_user.enable_auto_login that caused the user\(aqs keychain to be reset at each boot \fI\%#64226\fP
.IP \(bu 2
Fixed KeyError in logs when running a state that fails. \fI\%#64231\fP
.IP \(bu 2
Fixed x509_v2 \fBcreate_private_key\fP/\fBcreate_crl\fP unknown kwargs: __pub_fun... \fI\%#64232\fP
.IP \(bu 2
remove the hard coded python version in error. \fI\%#64237\fP
.IP \(bu 2
\fBsalt\-pip\fP now properly errors out when being called from a non \fBonedir\fP environment. \fI\%#64249\fP
.IP \(bu 2
Ensure we return an error when adding the key fails in the pkgrepo state for debian hosts. \fI\%#64253\fP
.IP \(bu 2
Fixed file client private attribute reference on \fBSaltMakoTemplateLookup\fP \fI\%#64280\fP
.IP \(bu 2
Fix pkgrepo.absent failures on apt\-based systems when repo either a) contains a
trailing slash, or b) there is an arch mismatch. \fI\%#64286\fP
.IP \(bu 2
Fix detection of Salt codename by \(dqsalt_version\(dq execution module \fI\%#64306\fP
.IP \(bu 2
Ensure selinux values are handled lowercase \fI\%#64318\fP
.IP \(bu 2
Remove the \fBclr.AddReference\fP, it is causing an \fBIllegal characters in path\fP exception \fI\%#64339\fP
.IP \(bu 2
Update \fBpkg.group_installed\fP state to support repo options \fI\%#64348\fP
.IP \(bu 2
Fix salt user login shell path in Debian packages \fI\%#64377\fP
.IP \(bu 2
Allow for multiple user\(aqs keys presented when authenticating, for example: root, salt, etc. \fI\%#64398\fP
.IP \(bu 2
Fixed an issue with \fBlgpo_reg\fP where existing entries for the same key in
\fBRegistry.pol\fP were being overwritten in subsequent runs if the value name in
the subesequent run was contained in the existing value name. For example, a
key named \fBSetUpdateNotificationLevel\fP would be overwritten by a subsequent
run attempting to set \fBUpdateNotificationLevel\fP \fI\%#64401\fP
.IP \(bu 2
Add search for %ProgramData%\eChocolatey\echoco.exe to determine if Chocolatey is installed or not \fI\%#64427\fP
.IP \(bu 2
Fix regression for user.present on handling groups with dupe GIDs \fI\%#64430\fP
.IP \(bu 2
Fix inconsistent use of args in ssh_auth.managed \fI\%#64442\fP
.IP \(bu 2
Ensure we raise an error when the name argument is invalid in pkgrepo.managed state for systems using apt. \fI\%#64451\fP
.IP \(bu 2
Fix file.symlink will not replace/update existing symlink \fI\%#64477\fP
.IP \(bu 2
Fixed salt\-ssh state.* commands returning retcode 0 when state/pillar rendering fails \fI\%#64514\fP
.IP \(bu 2
Fix pkg.install when using a port in the url. \fI\%#64516\fP
.IP \(bu 2
\fBwin_pkg\fP Fixes an issue runing \fBpkg.install\fP with \fBversion=latest\fP where the
new installer would not be cached if there was already an installer present
with the same name. \fI\%#64519\fP
.IP \(bu 2
Added a \fBtest:full\fP label in the salt repository, which, when selected, will force a full test run. \fI\%#64539\fP
.IP \(bu 2
Syndic\(aqs async_req_channel uses the asynchornous version of request channel \fI\%#64552\fP
.IP \(bu 2
Ensure runners properly save information to job cache. \fI\%#64570\fP
.IP \(bu 2
Added salt.ufw to salt\-master install on Debian and Ubuntu \fI\%#64572\fP
.IP \(bu 2
Added support for Chocolatey 2.0.0+ while maintaining support for older versions \fI\%#64622\fP
.IP \(bu 2
Updated semanage fcontext to use \-\-modify if context already exists when adding context \fI\%#64625\fP
.IP \(bu 2
Preserve request client socket between requests. \fI\%#64627\fP
.IP \(bu 2
Show user friendly message when pillars timeout \fI\%#64651\fP
.IP \(bu 2
File client timeouts durring jobs show user friendly errors instead of tracbacks \fI\%#64653\fP
.IP \(bu 2
SaltClientError does not log a traceback on minions, we expect these to happen so a user friendly log is shown. \fI\%#64729\fP
.IP \(bu 2
Look in location salt is running from, this accounts for running from an unpacked onedir file that has not been installed. \fI\%#64877\fP
.IP \(bu 2
Preserve credentials on spawning platforms, minions no longer re\-authenticate
with every job when using \fBmultiprocessing=True\fP\&. \fI\%#64914\fP
.IP \(bu 2
Fixed uninstaller to not remove the \fBsalt\fP directory by default. This allows
the \fBextras\-3.##\fP folder to persist so salt\-pip dependencies are not wiped out
during an upgrade. \fI\%#64957\fP
.IP \(bu 2
fix msteams by adding the missing header that Microsoft is now enforcing. \fI\%#64973\fP
.IP \(bu 2
Fix \fBenv\fP and improve cache cleaning see more info at pull #65017. \fI\%#65002\fP
.IP \(bu 2
Better error message on inconsistent decoded payload \fI\%#65020\fP
.IP \(bu 2
Handle permissions access error when calling \fBlsb_release\fP with the salt user \fI\%#65024\fP
.IP \(bu 2
Allow schedule state module to update schedule when the minion is offline. \fI\%#65033\fP
.IP \(bu 2
Fixed creation of wildcard DNS in SAN in \fBx509_v2\fP \fI\%#65072\fP
.IP \(bu 2
The macOS installer no longer removes the extras directory \fI\%#65073\fP
.UNINDENT
.SS Added
.INDENT 0.0
.IP \(bu 2
Added a script to automate setting up a 2nd minion in a user context on Windows \fI\%#64439\fP
.IP \(bu 2
Several fixes to the CI workflow:
.INDENT 2.0
.IP \(bu 2
Don\(aqt override the \fBon\fP Jinja block on the \fBci.yaml\fP template. This enables reacting to labels getting added/removed
to/from pull requests.
.IP \(bu 2
Switch to using \fBtools\fP and re\-use the event payload available instead of querying the GH API again to get the pull
request labels
.IP \(bu 2
Concentrate test selection by labels to a single place
.IP \(bu 2
Enable code coverage on pull\-requests by setting the \fBtest:coverage\fP label \fI\%#64547\fP
.UNINDENT
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
Upgrade to \fBcryptography==41.0.3\fP(and therefor \fBpyopenssl==23.2.0\fP due to \fI\%https://github.com/advisories/GHSA\-jm77\-qphf\-c4w8\fP)
.sp
This only really impacts pip installs of Salt and the windows onedir since the linux and macos onedir build every package dependency from source, not from pre\-existing wheels.
.sp
Also resolves the following cryptography advisories:
.sp
Due to:
.INDENT 2.0
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-5cpq\-8wj7\-hf2v\fP
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-x4qr\-2fvf\-3mr5\fP
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-w7pp\-m8wf\-vj6r\fP \fI\%#64595\fP
.UNINDENT
.IP \(bu 2
Bump to \fBaiohttp==3.8.5\fP due to \fI\%https://github.com/advisories/GHSA\-45c4\-8wx5\-qw6w\fP \fI\%#64687\fP
.IP \(bu 2
Bump to \fBcertifi==2023.07.22\fP due to \fI\%https://github.com/advisories/GHSA\-xqr8\-7jwr\-rhp7\fP \fI\%#64718\fP
.IP \(bu 2
Upgrade \fBrelenv\fP to \fB0.13.2\fP and Python to \fB3.10.12\fP
.sp
Addresses multiple CVEs in Python\(aqs dependencies: \fI\%https://docs.python.org/release/3.10.12/whatsnew/changelog.html#python\-3\-10\-12\fP \fI\%#64719\fP
.IP \(bu 2
Update to \fBgitpython>=3.1.32\fP due to \fI\%https://github.com/advisories/GHSA\-pr76\-5cm5\-w9cj\fP \fI\%#64988\fP
.UNINDENT
(release\-3006.4)=
.SS Salt 3006.4 release notes
.SS Changelog
.SS Security
.INDENT 0.0
.IP \(bu 2
Fix CVE\-2023\-34049 by ensuring we do not use a predictable name for the script and correctly check returncode of scp command.
This only impacts salt\-ssh users using the pre\-flight option. \fI\%#cve\-2023\-34049\fP
.IP \(bu 2
Update to \fBgitpython>=3.1.35\fP due to \fI\%https://github.com/advisories/GHSA\-wfm5\-v35h\-vwf4\fP and \fI\%https://github.com/advisories/GHSA\-cwvm\-v4w8\-q58c\fP \fI\%#65163\fP
.IP \(bu 2
Bump to \fBcryptography==41.0.4\fP due to \fI\%https://github.com/advisories/GHSA\-v8gr\-m533\-ghj9\fP \fI\%#65268\fP
.IP \(bu 2
Upgrade relenv to 0.13.12 to address CVE\-2023\-4807 \fI\%#65316\fP
.IP \(bu 2
Bump to \fBurllib3==1.26.17\fP or \fBurllib3==2.0.6\fP due to \fI\%https://github.com/advisories/GHSA\-v845\-jxx5\-vc9f\fP \fI\%#65334\fP
.IP \(bu 2
Bump to \fBgitpython==3.1.37\fP due to \fI\%https://github.com/advisories/GHSA\-cwvm\-v4w8\-q58c\fP \fI\%#65383\fP
.UNINDENT
(release\-3006.5)=
.SS Salt 3006.5 release notes
.SS Changelog
.SS Removed
.INDENT 0.0
.IP \(bu 2
Tech Debt \- support for pysss removed due to functionality addition in Python 3.3 \fI\%#65029\fP
.UNINDENT
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Improved error message when state arguments are accidentally passed as a string \fI\%#38098\fP
.IP \(bu 2
Allow \fBpip.install\fP to create a log file that is passed in if the parent directory is writeable \fI\%#44722\fP
.IP \(bu 2
Fixed merging of complex pillar overrides with salt\-ssh states \fI\%#59802\fP
.IP \(bu 2
Fixed gpg pillar rendering with salt\-ssh \fI\%#60002\fP
.IP \(bu 2
Made salt\-ssh states not re\-render pillars unnecessarily \fI\%#62230\fP
.IP \(bu 2
Made Salt maintain options in Debian package repo definitions \fI\%#64130\fP
.IP \(bu 2
Migrated all \fI\%invoke\fP tasks to \fI\%python\-tools\-scripts\fP\&.
.INDENT 2.0
.IP \(bu 2
\fBtasks/docs.py\fP \-> \fBtools/precommit/docs.py\fP
.IP \(bu 2
\fBtasks/docstrings.py\fP \-> \fBtools/precommit/docstrings.py\fP
.IP \(bu 2
\fBtasks/loader.py\fP \-> \fBtools/precommit/loader.py\fP
.IP \(bu 2
\fBtasks/filemap.py\fP \-> \fBtools/precommit/filemap.py\fP \fI\%#64374\fP
.UNINDENT
.IP \(bu 2
Fix salt user login shell path in Debian packages \fI\%#64377\fP
.IP \(bu 2
Fill out lsb_distrib_xxxx (best estimate) grains if problems with retrieving lsb_release data \fI\%#64473\fP
.IP \(bu 2
Fixed an issue in the \fBfile.directory\fP state where the \fBchildren_only\fP keyword
argument was not being respected. \fI\%#64497\fP
.IP \(bu 2
Move salt.ufw to correct location /etc/ufw/applications.d/ \fI\%#64572\fP
.IP \(bu 2
Fixed salt\-ssh stacktrace when retcode is not an integer \fI\%#64575\fP
.IP \(bu 2
Fixed SSH shell seldomly fails to report any exit code \fI\%#64588\fP
.IP \(bu 2
Fixed some issues in x509_v2 execution module private key functions \fI\%#64597\fP
.IP \(bu 2
Fixed grp.getgrall() in utils/user.py causing performance issues \fI\%#64888\fP
.IP \(bu 2
Fix user.list_groups omits remote groups via sssd, etc. \fI\%#64953\fP
.IP \(bu 2
Ensure sync from _grains occurs before attempting pillar compilation in case custom grain used in pillar file \fI\%#65027\fP
.IP \(bu 2
Moved gitfs locks to salt working dir to avoid lock wipes \fI\%#65086\fP
.IP \(bu 2
Only attempt to create a keys directory when \fB\-\-gen\-keys\fP is passed to the \fBsalt\-key\fP CLI \fI\%#65093\fP
.IP \(bu 2
Fix nonce verification, request server replies do not stomp on eachother. \fI\%#65114\fP
.IP \(bu 2
speed up yumpkg list_pkgs by not requiring digest or signature verification on lookup. \fI\%#65152\fP
.IP \(bu 2
Fix pkg.latest failing on windows for winrepo packages where the package is already up to date \fI\%#65165\fP
.IP \(bu 2
Ensure \fBkwarg\fP is preserved when checking for kwargs.  This change affects proxy minions when used with Deltaproxy, which had kwargs popped when targeting multiple minions id. \fI\%#65179\fP
.IP \(bu 2
Fixes traceback when state id is an int in a reactor SLS file. \fI\%#65210\fP
.IP \(bu 2
Install logrotate config as /etc/logrotate.d/salt\-common for Debian packages
Remove broken /etc/logrotate.d/salt directory from 3006.3 if it exists. \fI\%#65231\fP
.IP \(bu 2
Use \fBsha256\fP as the default \fBhash_type\fP\&. It has been the default since Salt v2016.9 \fI\%#65287\fP
.IP \(bu 2
Preserve ownership on log rotation \fI\%#65288\fP
.IP \(bu 2
Ensure that the correct value of jid_inclue is passed if the argument is included in the passed keyword arguments. \fI\%#65302\fP
.IP \(bu 2
Uprade relenv to 0.14.2
.INDENT 2.0
.IP \(bu 2
Update openssl to address CVE\-2023\-5363.
.IP \(bu 2
Fix bug in openssl setup when openssl binary can\(aqt be found.
.IP \(bu 2
Add M1 mac support. \fI\%#65316\fP
.UNINDENT
.IP \(bu 2
Fix regex for filespec adding/deleting fcontext policy in selinux \fI\%#65340\fP
.IP \(bu 2
Ensure CLI options take priority over Saltfile options \fI\%#65358\fP
.IP \(bu 2
Test mode for state function \fBsaltmod.wheel\fP no longer set\(aqs \fBresult\fP to \fB(None,)\fP \fI\%#65372\fP
.IP \(bu 2
Client only process events which tag conforms to an event return. \fI\%#65400\fP
.IP \(bu 2
Fixes an issue setting user or machine policy on Windows when the Group Policy
directory is missing \fI\%#65411\fP
.IP \(bu 2
Fix regression in file module which was not re\-using a file client. \fI\%#65450\fP
.IP \(bu 2
pip.installed state will now properly fail when a specified user does not exists \fI\%#65458\fP
.IP \(bu 2
Publish channel connect callback method properly closes it\(aqs request channel. \fI\%#65464\fP
.IP \(bu 2
Ensured the pillar in SSH wrapper modules is the same as the one used in template rendering when overrides are passed \fI\%#65483\fP
.IP \(bu 2
Fix file.comment ignore_missing not working with multiline char \fI\%#65501\fP
.IP \(bu 2
Warn when an un\-closed transport client is being garbage collected. \fI\%#65554\fP
.IP \(bu 2
Only generate the HMAC\(aqs for \fBlibssl.so.1.1\fP and \fBlibcrypto.so.1.1\fP if those files exist. \fI\%#65581\fP
.IP \(bu 2
Fixed an issue where Salt Cloud would fail if it could not delete lingering
PAexec binaries \fI\%#65584\fP
.UNINDENT
.SS Added
.INDENT 0.0
.IP \(bu 2
Added Salt support for Debian 12 \fI\%#64223\fP
.IP \(bu 2
Added Salt support for Amazon Linux 2023 \fI\%#64455\fP
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
Bump to \fBcryptography==41.0.4\fP due to \fI\%https://github.com/advisories/GHSA\-v8gr\-m533\-ghj9\fP \fI\%#65268\fP
.IP \(bu 2
Bump to \fBcryptography==41.0.7\fP due to \fI\%https://github.com/advisories/GHSA\-jfhm\-5ghh\-2f97\fP \fI\%#65643\fP
.UNINDENT
(release\-3006.6)=
.SS Salt 3006.6 release notes
.SS Changelog
.SS Changed
.INDENT 0.0
.IP \(bu 2
Salt no longer time bombs user installations on code using \fBsalt.utils.versions.warn_until_date\fP \fI\%#665924\fP
.UNINDENT
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fix un\-closed transport in tornado netapi \fI\%#65759\fP
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
CVE\-2024\-22231 Prevent directory traversal when creating syndic cache directory on the master
CVE\-2024\-22232 Prevent directory traversal attacks in the master\(aqs serve_file method.
These vulerablities were discovered and reported by:
Yudi Zhao(Huawei Nebula Security Lab),Chenwei Jiang(Huawei Nebula Security Lab) \fI\%#565\fP
.IP \(bu 2
Update some requirements which had some security issues:
.INDENT 2.0
.IP \(bu 2
Bump to \fBpycryptodome==3.19.1\fP and \fBpycryptodomex==3.19.1\fP due to \fI\%https://github.com/advisories/GHSA\-j225\-cvw7\-qrx7\fP
.IP \(bu 2
Bump to \fBgitpython==3.1.41\fP due to \fI\%https://github.com/advisories/GHSA\-2mqj\-m65w\-jghx\fP
.IP \(bu 2
Bump to \fBjinja2==3.1.3\fP due to \fI\%https://github.com/advisories/GHSA\-h5c8\-rqwp\-cp95\fP \fI\%#65830\fP
.UNINDENT
.UNINDENT
(release\-3006.7)=
.SS Salt 3006.7 release notes
.SS Changelog
.SS Deprecated
.INDENT 0.0
.IP \(bu 2
Deprecate and stop using \fBsalt.features\fP \fI\%#65951\fP
.UNINDENT
.SS Changed
.INDENT 0.0
.IP \(bu 2
Change module search path priority, so Salt extensions can be overridden by syncable modules and module_dirs. You can switch back to the old logic by setting features.enable_deprecated_module_search_path_priority to true, but it will be removed in Salt 3008. \fI\%#65938\fP
.UNINDENT
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fix an issue with mac_shadow that was causing a command execution error when
retrieving values that were not yet set. For example, retrieving last login
before the user had logged in. \fI\%#34658\fP
.IP \(bu 2
Fixed an issue when keys didn\(aqt match because of line endings \fI\%#52289\fP
.IP \(bu 2
Corrected encoding of credentials for use with Artifactory \fI\%#63063\fP
.IP \(bu 2
Use \fBsend_multipart\fP instead of \fBsend\fP when sending multipart message. \fI\%#65018\fP
.IP \(bu 2
Fix an issue where the minion would crash on Windows if some of the grains
failed to resolve \fI\%#65154\fP
.IP \(bu 2
Fix issue with openscap when the error was outside the expected scope. It now
returns failed with the error code and the error \fI\%#65193\fP
.IP \(bu 2
Upgrade relenv to 0.15.0 to fix namespaced packages installed by salt\-pip \fI\%#65433\fP
.IP \(bu 2
Fix regression of fileclient re\-use when rendering sls pillars and states \fI\%#65450\fP
.IP \(bu 2
Fixes the s3fs backend computing the local cache\(aqs files with the wrong hash type \fI\%#65589\fP
.IP \(bu 2
Fixed Salt\-SSH pillar rendering and state rendering with nested SSH calls when called via saltutil.cmd or in an orchestration \fI\%#65670\fP
.IP \(bu 2
Fix boto execution module loading \fI\%#65691\fP
.IP \(bu 2
Removed PR 65185 changes since incomplete solution \fI\%#65692\fP
.IP \(bu 2
catch only ret/ events not all returning events. \fI\%#65727\fP
.IP \(bu 2
Fix nonsensical time in fileclient timeout error. \fI\%#65752\fP
.IP \(bu 2
Fixes an issue when reading/modifying ini files that contain unicode characters \fI\%#65777\fP
.IP \(bu 2
added https proxy to the list of proxies so that requests knows what to do with https based proxies \fI\%#65824\fP
.IP \(bu 2
Ensure minion channels are closed on any master connection error. \fI\%#65932\fP
.IP \(bu 2
Fixed issue where Salt can\(aqt find libcrypto when pip installed from a cloned repo \fI\%#65954\fP
.IP \(bu 2
Fix RPM package systemd scriptlets to make RPM packages more universal \fI\%#65987\fP
.IP \(bu 2
Fixed an issue where fileclient requests during Pillar rendering cause
fileserver backends to be needlessly refreshed. \fI\%#65990\fP
.IP \(bu 2
Fix exceptions being set on futures that are already done in ZeroMQ transport \fI\%#66006\fP
.IP \(bu 2
Use hmac compare_digest method in hashutil module to mitigate potential timing attacks \fI\%#66041\fP
.IP \(bu 2
Fix request channel default timeout regression. In 3006.5 it was changed from
60 to 30 and is now set back to 60 by default. \fI\%#66061\fP
.IP \(bu 2
Upgrade relenv to 0.15.1 to fix debugpy support. \fI\%#66094\fP
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
Bump to \fBcryptography==42.0.0\fP due to \fI\%https://github.com/advisories/GHSA\-3ww4\-gg4f\-jr7f\fP
.sp
In the process, we were also required to update to \fBpyOpenSSL==24.0.0\fP \fI\%#66004\fP
.IP \(bu 2
Bump to \fBcryptography==42.0.3\fP due to \fI\%https://github.com/advisories/GHSA\-3ww4\-gg4f\-jr7f\fP \fI\%#66090\fP
.UNINDENT
(release\-3006.8)=
.SS Salt 3006.8 release notes
.SS Changelog
.SS Removed
.INDENT 0.0
.IP \(bu 2
Removed deprecated code scheduled to be removed on 2024\-01\-01:
.INDENT 2.0
.IP \(bu 2
\fBTemporaryLoggingHandler\fP and \fBQueueHandler\fP in \fBsalt/_logging/handlers.py\fP
.IP \(bu 2
All of the \fBsalt/log\fP package.
.IP \(bu 2
The \fBsalt/modules/cassandra_mod.py\fP module.
.IP \(bu 2
The \fBsalt/returners/cassandra_return.py\fP returner.
.IP \(bu 2
The \fBsalt/returners/django_return.py\fP returner. \fI\%#66147\fP
.UNINDENT
.UNINDENT
.SS Deprecated
.INDENT 0.0
.IP \(bu 2
Drop Fedora 37 and Fedora 38 support \fI\%#65860\fP
.IP \(bu 2
Drop CentOS Stream 8 and 9 from CI/CD \fI\%#66104\fP
.IP \(bu 2
Drop Photon OS 3 support \fI\%#66105\fP
.IP \(bu 2
The \fBsalt.utils.psutil_compat\fP module has been deprecated and will be removed in Salt 3008. Please use the \fBpsutil\fP module directly. \fI\%#66139\fP
.UNINDENT
.SS Fixed
.INDENT 0.0
.IP \(bu 2
\fBuser.add\fP on Windows now allows you to add user names that contain all
numeric characters \fI\%#53363\fP
.IP \(bu 2
Fix an issue with the win_system module detecting established connections on
non\-Windows systems. Uses psutils instead of parsing the return of netstat \fI\%#60508\fP
.IP \(bu 2
pkg.refresh_db on Windows now honors saltenv \fI\%#61807\fP
.IP \(bu 2
Fixed an issue with adding new machine policies and applying those same
policies in the same state by adding a \fBrefresh_cache\fP option to the
\fBlgpo.set\fP state. \fI\%#62734\fP
.IP \(bu 2
file.managed correctly handles file path with \(aq#\(aq \fI\%#63060\fP
.IP \(bu 2
Fix master ip detection when DNS records change \fI\%#63654\fP
.IP \(bu 2
Fix user and group management on Windows to handle the Everyone group \fI\%#63667\fP
.IP \(bu 2
Fixes an issue in pkg.refresh_db on Windows where new package definition
files were not being picked up on the first run \fI\%#63848\fP
.IP \(bu 2
Display a proper error when pki commands fail in the win_pki module \fI\%#64933\fP
.IP \(bu 2
Prevent full system upgrade on single package install for Arch Linux \fI\%#65200\fP
.IP \(bu 2
When using s3fs, if files are deleted from the bucket, they were not deleted in
the master or minion local cache, which could lead to unexpected file copies or
even state applications. This change makes the local cache consistent with the
remote bucket by deleting files locally that are deleted from the bucket.
.sp
\fBNOTE\fP this could lead to \fBbreakage\fP on your affected systems if it was
inadvertently depending on previously deleted files. \fI\%#65611\fP
.IP \(bu 2
Fixed an issue with file.directory state where paths would be modified in test
mode if backupname is used. \fI\%#66049\fP
.IP \(bu 2
Execution modules have access to regular fileclient durring pillar rendering. \fI\%#66124\fP
.IP \(bu 2
Fixed a issue with server channel where a minion\(aqs public key
would be rejected if it contained a final newline character. \fI\%#66126\fP
.IP \(bu 2
Fix content type backwards compatablity with http proxy post requests in the http utils module. \fI\%#66127\fP
.IP \(bu 2
Fix systemctl with \(dqtry\-restart\(dq instead of \(dqretry\-restart\(dq within the RPM spec, properly restarting upgraded services \fI\%#66143\fP
.IP \(bu 2
Auto discovery of ssh, scp and ssh\-keygen binaries. \fI\%#66205\fP
.IP \(bu 2
Add leading slash to salt helper file paths as per dh_links requirement \fI\%#66280\fP
.IP \(bu 2
Fixed x509.certificate_managed \- ca_server did not return a certificate \fI\%#66284\fP
.IP \(bu 2
removed log line that did nothing. \fI\%#66289\fP
.IP \(bu 2
Chocolatey: Make sure the return dictionary from \fBchocolatey.version\fP
contains lowercase keys \fI\%#66290\fP
.IP \(bu 2
fix cacheing inline pillar, by not rendering inline pillar during cache save function. \fI\%#66292\fP
.IP \(bu 2
The file module correctly perserves file permissions on link target. \fI\%#66400\fP
.IP \(bu 2
Upgrade relenv to 0.16.0 and python to 3.10.14 \fI\%#66402\fP
.IP \(bu 2
backport the fix from #66164 to fix #65703. use OrderedDict to fix bad indexing. \fI\%#66705\fP
.UNINDENT
.SS Added
.INDENT 0.0
.IP \(bu 2
Add Fedora 39 support \fI\%#65859\fP
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
Upgrade to \fBcryptography==42.0.5\fP due to a few security issues:
.INDENT 2.0
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-9v9h\-cgj8\-h64p\fP
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-3ww4\-gg4f\-jr7f\fP
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-6vqw\-3v5j\-54x4\fP \fI\%#66141\fP
.UNINDENT
.IP \(bu 2
Bump to \fBidna==3.7\fP due to \fI\%https://github.com/advisories/GHSA\-jjg7\-2v4v\-x38h\fP \fI\%#66377\fP
.IP \(bu 2
Bump to \fBaiohttp==3.9.4\fP due to \fI\%https://github.com/advisories/GHSA\-7gpw\-8wmc\-pm8g\fP \fI\%#66411\fP
.UNINDENT
.SS Salt 3005 release notes \- Codename Phosphorus
.SS Python 3.5 and 3.6 deprecation
.sp
This will be the last release we will support Python versions 3.5 and 3.6.
In Salt release 3006, we will only support Python versions 3.7 and higher.
Going forward, our policy will be to align with Python\(aqs supported versions.
.SS OS support end of life
.sp
Debian and Raspbian 9 are now EOL, therefore we will no longer be building
packages for these platforms.
.SS Raspberry Pi
.sp
We will no longer build the Raspberry Pi packages after the 3005 release but will
provide open sources project links in an updated announcement later. Please see the
announcement for more details:
\fI\%https://saltproject.io/salt\-project\-announces\-the\-open\-sourcing\-of\-several\-saltstack\-native\-minions/\fP
.SS New packages available
.sp
With the release of Salt 3005, we are pleased to announce the new onedir
packages using pyinstaller are now out of beta and ready for production. These
new packages make the installation process easier. Onedir packages install Salt
with one directory that includes all the executables Salt needs to run
effectively, including the version of Python and the required dependencies that
Salt needs. These packages make it easier to use Salt out of the box without
installing Python first.
.sp
Going forward, any new OS platforms supported by the Salt Project from version
3005 can only be installed using onedir packages. For this release, this
includes Redhat 9, Ubuntu 22.04, and Photon OS 3. The Salt Project will phase
out the old (\(dqclassic\(dq) Salt package builds for currently supported operating
systems by 3006. See
\fI\%Upgrade to onedir\fP
for more information.
.sp
On the day of the Phosphorus release, the onedir packages will be available on
\fI\%https://repo.saltproject.io\fP for each platform. The instructions for installing
onedir packages and the classic packages will be available on the new
\fI\%Salt Install Guide\fP\&.
.sp
If you want to test out the packages today, you can install them from
\fI\%https://repo.saltproject.io/salt\-dev/py3/\fP using the correct directory
for your platform. If you find any issues with the packages, please open an
issue on this repo: \fI\%https://gitlab.com/saltstack/open/salt\-pkg\fP
.SS Classic, non\-onedir packaging support
.sp
The classic, non\-onedir packaging system previously used for Salt will also be
provided for platforms supported in previous Salt versions. The classic
packaging will only be available for the 3005 release. The 3006 release and
all releases going forward will only provide the onedir packages.
.SS Platform package support
.TS
center;
|l|l|l|.
_
T{
OS
T}	T{
New onedir packages
T}	T{
Classic, non\-onedir packages
T}
_
T{
RHEL 7
T}	T{
yes
T}	T{
yes
T}
_
T{
RHEL 8
T}	T{
yes
T}	T{
yes
T}
_
T{
RHEL 9
T}	T{
yes
T}	T{
no
T}
_
T{
Ubuntu 18.04
T}	T{
yes
T}	T{
yes
T}
_
T{
Ubuntu 20.04
T}	T{
yes
T}	T{
yes
T}
_
T{
Ubuntu 22.04
T}	T{
yes
T}	T{
no
T}
_
T{
Debian 10
T}	T{
yes
T}	T{
yes
T}
_
T{
Debian 11
T}	T{
yes
T}	T{
yes
T}
_
T{
Raspbian 10
T}	T{
no
T}	T{
yes
T}
_
T{
Raspbian 11
T}	T{
no
T}	T{
yes
T}
_
T{
Fedora 35
T}	T{
yes
T}	T{
yes
T}
_
T{
Fedora 36
T}	T{
yes
T}	T{
yes
T}
_
T{
MacOS
T}	T{
yes
T}	T{
yes
T}
_
T{
Windows
T}	T{
yes
T}	T{
yes
T}
_
.TE
.SS Repo paths
.TS
center;
|l|l|l|.
_
T{
OS
T}	T{
Onedir path
T}	T{
Classic, Non\-onedir path
T}
_
T{
RHEL
T}	T{
\fI\%https://repo.saltproject.io/salt/py3/redhat/\fP
T}	T{
\fI\%https://repo.saltproject.io/py3/redhat/\fP
T}
_
T{
Ubuntu
T}	T{
\fI\%https://repo.saltproject.io/salt/py3/ubuntu/\fP
T}	T{
\fI\%https://repo.saltproject.io/py3/ubuntu/\fP
T}
_
T{
Debian
T}	T{
\fI\%https://repo.saltproject.io/salt/py3/debian/\fP
T}	T{
\fI\%https://repo.saltproject.io/py3/debian/\fP
T}
_
T{
Raspbian
T}	T{
Not available
T}	T{
\fI\%https://repo.saltproject.io/py3/debian/\fP
T}
_
T{
Fedora
T}	T{
Hosted on Fedora Repos
T}	T{
Hosted on Fedora Repos
T}
_
T{
MacOS
T}	T{
\fI\%https://repo.saltproject.io/salt/py3/osx/\fP
T}	T{
\fI\%https://repo.saltproject.io/osx/\fP
T}
_
T{
Windows
T}	T{
\fI\%https://repo.saltproject.io/salt/py3/windows/\fP
T}	T{
\fI\%https://repo.saltproject.io/windows/\fP
T}
_
.TE
.sp
Note that the onedir paths above will not be available until the day of the
Phosphorus release.
.SS How do I migrate to the onedir packages?
.sp
The migration path from the classic, non\-onedir packages to the onedir packages
will include:
.INDENT 0.0
.IP \(bu 2
Repo File: You need to update your repo file to point to the new repo paths
for your platform. After the repo file is updated, upgrade your Salt packages.
.IP \(bu 2
Pip packages: You need to ensure any 3rd party pip packages are installed in
the correct onedir path. This can be accomplished in two ways:
.INDENT 2.0
.IP \(bu 2
\fBsalt\-pip install <package name>\fP
.IP \(bu 2
Using the \fBpip.installed\fP Salt state.
.UNINDENT
.UNINDENT
.sp
To install python packages into the system python environment, users must now
provide the \fBpip_bin\fP or \fBbin_env\fP to the pip state module.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lib\-foo:
  pip.installed:
    \- pip_bin: /usr/bin/pip3
lib\-bar:
  pip.installed:
    \- bin_env: /usr/bin/python3
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Known issues
.INDENT 0.0
.IP \(bu 2
To make use of Salt 3005 or later on a Salt master connected to SaltStack
Config, you must use SaltStack Config version 8.9.0 or later.
.sp
The root cause of the issue is a breaking change to
\fBAsyncClient._proc_function()\(ga\fP in Salt, which is the function that the
raas\-master uses to run \fBsalt\-run\fP commands. As this is a private API, there\(aqs
no expectation that the API should remain backward\-compatible.
.sp
It is recommended to upgrade SaltStack Config before upgrading your Salt
masters. However, if a Salt master is upgraded to version 3005 before
upgrading SaltStack Config, the upgrade can still be completed.
.sp
After upgrading SaltStack Config, including the SSC plugin on each Salt master,
restart the Salt masters.
.IP \(bu 2
Salt does not currently support napalm 4. Users will need to install napalm 3.x to
ensure they do not run into issue #62468
.UNINDENT
.SS Removed
.INDENT 0.0
.IP \(bu 2
Deprecating and removing salt\-unity. (#56055)
.IP \(bu 2
Removed support for macos mojave (#61130)
.IP \(bu 2
Removed \fIsalt.utils.MultiprocessingProcess\fP and \fIsalt.utils.SignalHandlingMultiprocessingProcess\fP\&. Please use \fIsalt.utils.Process\fP and \fIsalt.utils.SignalHandlingProcess\fP instead. (#61573)
.IP \(bu 2
Remove the grains.get_or_set_hash function. Please reference pillar and SDB documentation for secure ways to manage sensitive information. Grains are an insecure way to store secrets. (#61691)
.IP \(bu 2
Removed the \fItelnet_port\fP, \fIserial_type\fP and \fIconsole\fP parameters in salt/modules/virt.py. Use the \fIserials\fP and \fIconsoles\fP parameters instead. Use the \fIserials\fP parameter with a value like \fB{{{{\(aqtype\(aq: \(aqtcp\(aq, \(aqprotocol\(aq: \(aqtelnet\(aq, \(aqport\(aq: {}}}}}\fP instead and a similar \fIconsoles\fP parameter. (#61693)
.IP \(bu 2
Remove remove_lock in zypperpkg.py in favor of unhold.
Remove add_lock in zypperpkg.py in favor of hold. (#61694)
.IP \(bu 2
Removed support for old\-style Windows Group Policy names
Recommended policy names will be displayed in comments (#61696)
.IP \(bu 2
Remove the feature flag feature.enable_slsvars_fixes and enable the fixes for \fIsls_path\fP, \fItpl_file\fP, and \fItpldir\fP by default.
Enabling this behavior by default will fix the following:
\- tpldir: If your directory name and your SLS file name are the same tpldir used to return a ., now it returns the correct directory name.
\- slspath,slsdotpath,slscolonpath,sls_path: If an init.sls file is accessed by its explicit name path.to.init instead of path.to, init shows up as a directory for in various sls context parameters, now it will only show as a file.
\- tplfile: When using tplfile in a SLS file in the root directory of file roots it returns empty. Now it returns the filename. (#61697)
.IP \(bu 2
Remove SaltMessageServer.shutdown in favor of close.
Remove LoadBalancerWorker.stop in favor of close. (#61698)
.IP \(bu 2
Removed the PyObjC dependency.
.sp
This addresses problems with building a one dir build for macOS.
It became problematic because depending on the macOS version, it pulls different dependencies, and we would either have to build a macos onedir for each macOS supported release, or ship a crippled onedir(because it would be tied to the macOS version where the onedir was built).
Since it\(aqs currently not being used, it\(aqs removed. (#62432)
.UNINDENT
.SS Deprecated
.INDENT 0.0
.IP \(bu 2
In etcd_util, the recursive kwarg in the read and delete methods has been deprecated in favor of recurse for both client versions.
In etcd_util, the index kwarg in the watch method has been deprecated in favor of start_revision for both client versions.
In etcd_util, the waitIndex kwarg in the read method has been deprecated in favor of start_revision for both client versions.
The etcd API v2 implementation has been deprecated in favor of etcd API v3. (#60325)
.IP \(bu 2
Deprecated transport kwarg inside salt.utils.event.get_event (#61275)
.IP \(bu 2
Deprecated netmiko_conn and pyeapi_conn in napalm_mod.py as these function should not be called from the CLI (#61566)
.IP \(bu 2
Deprecate all Azure cloud modules (#62183)
.IP \(bu 2
Deprecated \fBdefaults\fP and \fBpreserve_context\fP for \fBsalt.utils.functools.namespaced_function\fP\&.
Additionally, the behavior when \fBpreserve_namespace=True\fP was passed is now the default in order not to require duplicating imports on the modules that are namespacing functions. (#62272)
.IP \(bu 2
Added a pyinstaller hook that traverses the python used on the tiamat package to add all possible modules as hidden imports. (#62362)
.IP \(bu 2
Fix use of random shuffle and sample functions as Jinja filters (#62372)
.IP \(bu 2
All of the requirements provided in the requirements files are now included. The job of evaluating platform markers is not Salt\(aqs it\(aqs pip\(aqs. (#62392)
.IP \(bu 2
Update all platforms to use pycparser 2.21 or greater for Py 3.9 or higher, fixes fips fault with openssl v3.x (#62400)
.IP \(bu 2
Due to changes in the Netmiko library for the exception paths, need to check the version of Netmiko python library and then import the exceptions from different locations depending on the result. (#62405)
.IP \(bu 2
Deprecated the cassandra module in favor of the cassandra_cql module/returner. (#62327)
.UNINDENT
.SS Changed
.INDENT 0.0
.IP \(bu 2
alternatives: Do not access /var/lib/dpkg/alternatives directly (#58745)
.IP \(bu 2
Enhance logging when there are errors at loading beacons (#60402)
.IP \(bu 2
Updated mysql cache module to also store updated timestamp, making it consistent with default cache module. Users of mysql cache should ensure database size before updating, as ALTER TABLE will add the timestamp column. (#61081)
.IP \(bu 2
Changed linux_shadow to test success of commands using cmd.retcode instead of cmd.run (#61932)
.IP \(bu 2
\fIzabbix.user_get\fP returns full user info with groups and medias
\fIzabbix.user_addmedia\fP returns error for Zabbix 4.0+ due to \fIuser.addmedia\fP method removal
\fIzabbix.user_deletemedia\fP returns error for Zabbix 4.0+ due to \fIuser.deletemedia\fP method removal (#62012)
.IP \(bu 2
\(dqSign before ending the testrun in x509.create_certificate\(dq (#62100)
.UNINDENT
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fix salt\-ssh using sudo with a password (#8882)
.IP \(bu 2
Fix SSH password regex to not search for content after password:. (#25721)
.IP \(bu 2
Addressing a few issues when having keep_symlinks set to True with file.recurse.  Also allow symlinks that are outside the salt fileserver root to be discoverable as symlinks when fileserver_followsymlinks is set to False. (#29562)
.IP \(bu 2
serialize to JSON only non string objects. (#35215)
.IP \(bu 2
Fix archive.extracted doesn\(aqt set user/group ownership correctly (#38605)
.IP \(bu 2
Make sys.argspec work on functions with annotations (#48735)
.IP \(bu 2
Fixed pdbedit.list_users with Samba 4.8 (#49648)
.IP \(bu 2
Fixes a scenario where ipv6 is enabled but the master is configured as an ipv4 IP address. (#49835)
.IP \(bu 2
Ensure that NOTIFY_SOCKET is not passed to child processes created with cmdmod unless it\(aqs set explicitly for such call. (#50851)
.IP \(bu 2
remove escaping of dbname in mysql.alter_db function. (#51559)
.IP \(bu 2
Fix runit module failing to find service if it is not symlinked. (#52759)
.IP \(bu 2
Changed manage.versions to report minions offline if minion call fails. (#53513)
.IP \(bu 2
Fixed events stream from /events endpoint not halting when auth token has expired. (#53742)
.IP \(bu 2
Fixed user.present which was breaking when updating workphone,homephone, fullname and \(dqother\(dq fields in case int was passed instead of string (#53961)
.IP \(bu 2
Fix error in webutil state module when attempting to grep a file that does not exist. (#53977)
.IP \(bu 2
Fixed ability to modify the \(dqAudit: Force audit policy subcategory settings...\(dq policy (#54301)
.IP \(bu 2
Fix timeout handling in netapi/saltnado. (#55394)
.IP \(bu 2
Fixing REST auth so that we actually support using ACLs from the REST server like we said in the documentation. (#55654)
.IP \(bu 2
Salt now correctly handles macOS after Py3.8 where python defaults to spawn instead of fork. (#55847)
.IP \(bu 2
Factor out sum and sorting of permissions into separate functions.
Additionally, the same logic was applied to the rest_cherrypy netapi (#56495)
.IP \(bu 2
Display packages that are marked NoRemove in pkg.list_pkgs for Windows platforms (#56864)
.IP \(bu 2
Attempt to fix 56957 by detecting the broken recusion and stopping it. (#56957)
.IP \(bu 2
Fixed bytes vs. text issue when using sqlite for sdb backend. (#57133)
.IP \(bu 2
Ensure test is added to opts when using the state module with salt\-ssh. (#57144)
.IP \(bu 2
Fixed RuntimeError OrderedDict mutated in network.managed for Debian systems. (#57721)
.IP \(bu 2
Improved the multiprocessing classes to better handle spawning platforms (#57742)
.IP \(bu 2
Config options are enforced according to config type (#57873)
.IP \(bu 2
fixed 57992 fix multi item kv v2 items read. (#57992)
.IP \(bu 2
Fixed thread leak during FQDN lookup when DNS entries had malformed PTR records, or other similar issues. (#58141)
.IP \(bu 2
Remove unnecessary dot in template that cause the bridge interface to fail on debian. Fixes #58195 (#58195)
.IP \(bu 2
update salt.module.schedule to check the job_args and job_kwargs for valid formatting. (#58329)
.IP \(bu 2
Allowe use of \fIroster\fP in salt.function state when using the SSH client. (#58662)
.IP \(bu 2
Detect new and legacy styles of calling module.run and support them both. (#58763)
.IP \(bu 2
Clean repo uri before checking if it\(aqs present, avoiding ghost change. (#58807)
.IP \(bu 2
Fix error \(dq\(aq__opts__\(aq is not defined\(dq when using the boto v2 modules (#58934)
.IP \(bu 2
hgfs: fix bytes vs str issues within hgfs. (#58963)
.IP \(bu 2
Fixes salt\-ssh error when targetting IPs or hostnames directly. (#59033)
.IP \(bu 2
Allow for multiple configuration entries with keyword strict_config=False on yum\-based systems (#59090)
.IP \(bu 2
Fixed error when running legacy code in winrepo.update_git_repos (#59101)
.IP \(bu 2
Clarify the persist argument in the scheduler module. Adding code in the list function to indicate if the schedule job is saved or not. (#59102)
.IP \(bu 2
Swap ret[\(dqretcode\(dq] for ret.get(\(dqretcode\(dq) in the event that there is no retcode, eg. when a function is not passed with a module. (#59331)
.IP \(bu 2
Fix race condition when caching vault tokens (#59361)
.IP \(bu 2
The ssh module now accepts all ssh public key types as of openssh server version 8.7. (#59429)
.IP \(bu 2
Set default transport and port settings for Napalm NXOS, if not set. (#59448)
.IP \(bu 2
Use __salt_system_encoding__ when retrieving keystore certificate SHA1 str (#59503)
.IP \(bu 2
Fix error being thrown on empty flags list given to file.replace (#59554)
.IP \(bu 2
Update url for ez_setup.py script in virtualenv_mod.py (#59604)
.IP \(bu 2
Changed yumpkg module to normalize versions to strings when they were ambiguously floats (example version=3005.0). (#59705)
.IP \(bu 2
Fix pillar_roots.write on subdirectories broken after CVE\-2021\-25282 patch. (#59935)
.IP \(bu 2
Improved performance of zfs.filesystem_present and zfs.volume_present.  When
applying these states, only query specified ZFS properties rather than all
properties. (#59970)
.IP \(bu 2
Fixed highstate outputter not displaying with salt.function in orchestration when module returns a dictionary. (#60029)
.IP \(bu 2
Update docs where python\-dateutil is required for schedule. (#60070)
.IP \(bu 2
Send un\-parsed username to LookupAccountName function (#60076)
.IP \(bu 2
Fix ability to set propagation on a folder to \(dqthis_folder_only\(dq (#60103)
.IP \(bu 2
Fix name attribute access error in spm. (#60106)
.IP \(bu 2
Fix zeromq stream.send exception message (#60228)
.IP \(bu 2
Exit gracefully on ctrl+c. (#60242)
.IP \(bu 2
Corrected import statement for redis_cache in cluster mode. (#60272)
.IP \(bu 2
loader: Fix loading grains with annotations (#60285)
.IP \(bu 2
fix docker_network.present when com.docker.network.bridge.name is being used as the unixes can not have a bridge of the same name (#60316)
.IP \(bu 2
Fix exception in yumpkg.remove for not installed package on calling pkg.remove or pkg.removed (#60356)
.IP \(bu 2
Batch runs now return proper retcodes in a tuple of the form (result, retcode) (#60361)
.IP \(bu 2
Fixed issue with ansible roster __virtual__ when ansible is not installed. (#60370)
.IP \(bu 2
Fixed error being thrown when None was passed as src/defaults or dest to defaults.update and defaults.merge (#60431)
.IP \(bu 2
Allow for additional options for xmit hash policy in mode 4 NIC bonding on Redhat (#60583)
.IP \(bu 2
Properly detect VMware grains on Windows Server 2019+ (#60593)
.IP \(bu 2
Allow for minion failure to respond to job sent in batch mode (#60724)
.IP \(bu 2
The mac assistive execution module no longer shells out to change the database. (#60819)
.IP \(bu 2
Fix regression in win_timezone.get_zone which failed to resolve specific timezones that begin or end with d/s/t/o/f/_ characters (#60829)
.IP \(bu 2
The TCP transport resets it\(aqs unpacker on stream disconnects (#60831)
.IP \(bu 2
Moving the call to the validate function earlier to ensure that beacons are in the right format before we attempt to do anything to the configuration.  Adding a generic validation to ensure the beacon configuration is in the wrong format when a validation function does not exist. (#60838)
.IP \(bu 2
Update the mac installer welcome and conclusion page, add docs for the salt\-config tool (#60858)
.IP \(bu 2
Fixed external node classifier not callable due to wrong parameter (#60872)
.IP \(bu 2
Adjust Debian/Ubuntu package use of name \(aqifenslave\-2.6\(aq to \(aqifenslave\(aq (#60876)
.IP \(bu 2
Clear and update the Pillar Cache when running saltutil.refresh_pillar. This only affects users
that have \fIpillar_cache\fP set to True. If you do not want to clear the cache you can pass the kwarg
\fIclean_cache=False\fP to \fIsaltutil.refresh_pillar\fP\&. (#60897)
.IP \(bu 2
Handle the situation when apt repo lines have or do not have trailing slashes properly. (#60907)
.IP \(bu 2
Fixed Python 2 syntax for Python 3, allow for view objects returned by dictionary keys() function (#60909)
.IP \(bu 2
Fix REST CherryPY append the default permissions every request (#60955)
.IP \(bu 2
Do not consider \(dqskipped\(dq targets as failed for \(dqansible.playbooks\(dq states (#60983)
.IP \(bu 2
Fix behavior for internal \(dq_netlink_tool_remote_on\(dq to filter results based on requested end (#61017)
.IP \(bu 2
schedule.job_status module: Convert datetime objects into formatted strings (#61043)
.IP \(bu 2
virt: don\(aqt crash if console doesn\(aqt have service or type attribute (#61054)
.IP \(bu 2
Fixed conflict between importlib_metada from Salt and importlib.metadata from Python 3.10 (#61062)
.IP \(bu 2
sys.argspec now works with pillar.get, vault.read_secret, and vault.list_secrets (#61084)
.IP \(bu 2
Set virtual grain on FreeBSD EC2 instances (#61094)
.IP \(bu 2
Fixed v3004 windows minion failing to open log file at C:ProgramDataSalt ProjectSaltvarlogsaltminion (#61113)
.IP \(bu 2
Correct returned result to False when an error exception occurs for pip.installed (#61117)
.IP \(bu 2
fixed extend being too strict and wanting the system_type to exist when it is only needed for requisites. (#61121)
.IP \(bu 2
Fixed bug where deserialization in script engine would throw an error after all output was read. (#61124)
.IP \(bu 2
Adding missing import for salt.utils.beacons into beacons that were updated to use it. (#61135)
.IP \(bu 2
added exception catch to salt.utils.vt.terminal.isalive(). (#61160)
.IP \(bu 2
Re\-factor transport to make them more plug\-able (#61161)
.IP \(bu 2
Remove max zeromq pinned version due to issues on FreeBSD (#61163)
.IP \(bu 2
Fixing deltaproxy code to handle the situation where the control proxy is configured to control a proxy minion whose pillar data could not be loaded. (#61172)
.IP \(bu 2
Prevent get_tops from performing a Set operation on a List (#61176)
.IP \(bu 2
Make \(dqstate.highstate\(dq to acts on concurrent flag.
Simplify \(dqtransactional_update\(dq module to not use SSH wrapper and allow more flexible execution (#61188)
.IP \(bu 2
Fix a failure with salt.utils.vault.make_request when namespace is not defined in the connection. (#61191)
.IP \(bu 2
Fix race condition in \fIsalt.utils.verify.verify_env\fP and ignore directories starting with dot (#61192)
.IP \(bu 2
LGPO: Search for policies in a case\-sensitive manner first, then fall back to non case\-sensitive names (#61198)
.IP \(bu 2
Fixed state includes in dynamic environments (#61200)
.IP \(bu 2
Minimize the number of network connections minions to the master (#61247)
.IP \(bu 2
Fix salt\-call event.event with pillar or grains (#61252)
.IP \(bu 2
Fixed failing dcs.compile_config where a successful compile errored with \fIAttributeError: \(aqlist\(aq object has no attribute \(aqget\(aq\fP\&. (#61261)
.IP \(bu 2
Make the salt.utils.win_dacl.get_name() function include the \(dqNT Security\(dq prefix for Virtual Accounts. Virtual Accounts can only be added with the fully qualified name. (#61271)
.IP \(bu 2
Fixed tracebacks and print helpful error message when proxy_return = True but no platform or primary_ip set in NetBox pillar. (#61277)
.IP \(bu 2
Ensure opts is included in pack for minion_mods and config loads opts from the named_context. (#61297)
.IP \(bu 2
Added prefix length info for IPv6 addresses in Windows (#61316)
.IP \(bu 2
Handle MariaDB 10.5+ SLAVE MONITOR grant (#61331)
.IP \(bu 2
Fix secondary ip addresses being added to ip4_interfaces and ip6_interfaces at the same time (#61370)
.IP \(bu 2
Do not block the deltaproxy startup.  Wrap the call to the individual proxy initialization functions in a try...except, catching the exception, logging an error and moving onto the next proxy minion. (#61377)
.IP \(bu 2
show_instance of hetzner cloud provider should enforce an action like the other ones (#61392)
.IP \(bu 2
Fix Hetzner Cloud config loading mechanism (#61399)
.IP \(bu 2
Sets correctly the lvm grain even when lvm\(aqs command execution outputs a WARNING (#61412)
.IP \(bu 2
Use net instead of sc in salt cloud when restarting the salt service (#61413)
.IP \(bu 2
Fix use_etag support in fileclient by removing case sensitivity of expected header (#61440)
.IP \(bu 2
Expand environment variables in the root_dir registry key (#61445)
.IP \(bu 2
Use salt.utils.path.readlink everywhere instead of os.readlink (#61458)
.IP \(bu 2
Fix state_aggregate minion option not respected (#61478)
.IP \(bu 2
Fixed wua.installed and wua.uptodate to return all changes, failures, and supersedences (#61479)
.IP \(bu 2
When running with test=True and there are no changes, don\(aqt show that there are changes. (#61483)
.IP \(bu 2
Fix issue with certutil when there\(aqs a space in the path to the certificate (#61494)
.IP \(bu 2
Fix cmdmod not respecting config for saltenv (#61507)
.IP \(bu 2
Convert Py 2\(aqisms to Python 3, and add tests for set_filesystems on AIX (#61509)
.IP \(bu 2
Fix tracebacks caused by missing block device type and wrong mode used for gzip.open while calling inspector.export (#61530)
.IP \(bu 2
win_wua: Titles no longer limited to 40 characters (#61533)
.IP \(bu 2
Fixed error when using network module on RHEL 8 due to the name of the service changing from \(dqnetwork\(dq to \(dqNetworkManager\(dq. (#61538)
.IP \(bu 2
Allow symlink to be created even if source is missing on Windows (#61544)
.IP \(bu 2
Print jinja error context on \fIUndefinedError\fP\&.  Previously \fIjinja2.exceptions.UndefinedError\fP resulted in a \fISaltRenderError\fP without source file context, unlike all of the other Jinja exceptions handled in \fIsalt/utils/templates.py\fP\&. (#61553)
.IP \(bu 2
Fix uptime on AIX systems when less than 24 hours (#61557)
.IP \(bu 2
Fix issue with state.show_state_usage when a saltenv is not referenced in any topfile (#61614)
.IP \(bu 2
Making the retry state system feature available when parallel is set to True. (#61630)
.IP \(bu 2
modules/aptpkg.SourceEntry: fix parsing lines with arbitrary comments in case HAS_APT=False (#61632)
.IP \(bu 2
Fix file.comment incorrectly reports changes in test mode (#61662)
.IP \(bu 2
Fix improper master caching of file listing in multiple dynamic environments (#61738)
.IP \(bu 2
When configured beacons are empty write an empty beacon configuration file. (#61741)
.IP \(bu 2
Fix file.replace updating mtime with no changes (#61743)
.IP \(bu 2
Fixed etcd_return being out of sync with the underlying etcd_util. (#61756)
.IP \(bu 2
Fixing items, values, and keys functions in the data module. (#61812)
.IP \(bu 2
Ensure that \fIsalt://\fP URIs never contain backslashes, converting them to forward slashes instead.  A specific situation to handle is caching files on Windows minions, where Jinja relative imports introduce a backslash into the path. (#61829)
.IP \(bu 2
Do not raise a UnicodeDecodeError when pillar cache cannot decode binary data. (#61836)
.IP \(bu 2
Don\(aqt rely on \fBimportlib.metadata\fP, even on Py3.10, use \fBimportlib_metadata\fP instead. (#61839)
.IP \(bu 2
Fix the reporting of errors for file.directory in test mode (#61846)
.IP \(bu 2
Update Markup and contextfunction imports for jinja versions >=3.1. (#61848)
.IP \(bu 2
Update states.chef for version 16.x and 17.x Chef Infra Client output. (#61891)
.IP \(bu 2
Fixed some whitespace and \fBpathlib.Path\fP issues when not using the sytem \fBaptsources\fP package. (#61936)
.IP \(bu 2
fixed error when using backslash literal in file.replace (#61944)
.IP \(bu 2
Fix an issue where under spawning platforms, one could exhaust the available multiprocessing semaphores. (#61945)
.IP \(bu 2
Fix salt\-cloud sync_after_install functionality (#61946)
.IP \(bu 2
Ensure that \fIcommon_prefix\fP matching only occurs if a directory name is identified (in the \fIarchive.list\fP execution module function, which affects the \fIarchive.extracted\fP state). (#61968)
.IP \(bu 2
When states are running in parallel, ensure that the total run time produced by the highstate outputter takes that into account. (#61999)
.IP \(bu 2
Temporary logging is now shutdown when logging has been configured. (#62005)
.IP \(bu 2
modules/lxd.FilesManager: fix memory leak through pylxd.modules.container.Container.FilesManager (#62006)
.IP \(bu 2
utils/jinja.SaltCacheLoader: fix leaking SaltCacheLoader through atexit.register (#62007)
.IP \(bu 2
Fixed errors on calling \fIzabbix_user.admin_password_present\fP state, due to changed error message in Zabbix 6.0
Fixed \fIzabbix.host_update\fP not mapping group ids list to list of dicts in format \fI[{\(dqgroupid\(dq: groupid}, ...]\fP
Fixed \fIzabbix.user_update\fP not mapping usergroup id list to list of dicts in format \fI[{\(dqusrgrpid\(dq: usrgrpid}, ...]\fP (#62012)
.IP \(bu 2
utils/yamlloader and yamlloader_old: fix leaking DuplicateKeyWarning through a warnings module (#62021)
.IP \(bu 2
Fix cache checking for Jinja templates (#62042)
.IP \(bu 2
Fixed salt.states.file.managed() for follow_symlinks=True and test=True (#62066)
.IP \(bu 2
Stop trigering the \fI\%GLIBC race condition\fP when parallelizing the resolution of the fqnds. (#62071)
.IP \(bu 2
Fix useradd functions hard\-coded relative command name (#62087)
.IP \(bu 2
Fix #62092: Catch zmq.error.ZMQError to set HWM for zmq >= 3.
.sp
Run \fBgit show 0be0941\fP for more info. (#62092)
.IP \(bu 2
Allow emitatstartup to work when delay option is setup. (#62095)
.IP \(bu 2
Fix broken relative jinja includes in local mode bug introduced in #62043 (#62117)
.IP \(bu 2
Fix broken file.comment functionality introduced in #62045 (#62121)
.IP \(bu 2
Fixed an incompatibility preventing salt\-cloud from deploying VMs on Proxmox VE 7 (#62154)
.IP \(bu 2
Fix sysctl functions hard\-coded relative command name (#62164)
.IP \(bu 2
All of Salt\(aqs loaders now accept \fBloaded_base_name\fP as a keyword argument, allowing different namespacing the loaded modules. (#62186)
.IP \(bu 2
Only functions defined on the modules being loaded will be added to the lazy loader, functions imported from other modules, unless they are properly namespaced, are not included. (#62190)
.IP \(bu 2
Fixes issue in postgresql privileges detection: privileges on views were never retrieved and always recreated. (#57690)
.IP \(bu 2
Fix service.enabled error for unavailable service in test mode (#62258)
.IP \(bu 2
Fix variable reuse causing requisite_in problems (#62264)
.IP \(bu 2
Adding \-G option to pkgdd cmd_prefix list when current_zone_only is True. (#62206)
.IP \(bu 2
Don\(aqt expect \fBlsof\fP to be installed when trying check which minions are connected. (#62303)
.IP \(bu 2
Fixed urlparse typo in rpmbuild_pkgbuild.py (#62442)
.IP \(bu 2
Fixing changes dict in pkg state to be consistent when installing and test=True. (#60995)
.IP \(bu 2
Use fire_event_async when expecting a coroutine (#62453)
.IP \(bu 2
Fixes import error under windows. (#62459)
.IP \(bu 2
account for revision number in formulas to account for difference between bottle and formula (#62466)
.IP \(bu 2
Fixed stacktrace on Windows when running pkg.list_pkgs (#62479)
.IP \(bu 2
Update sanitizing masking for Salt SSH to include additional password like strings. (#62483)
.IP \(bu 2
Fixes an issue where the minion could not connect to a master after 2 failed attempts (#62489)
.UNINDENT
.SS Added
.INDENT 0.0
.IP \(bu 2
Added ability to request VPC peering connections in different AWS regions (boto_vpc). (#50394)
.IP \(bu 2
Added event return capability to Splunk returner (#50815)
.IP \(bu 2
Added allow downgrades support to apt upgrade (#52977)
.IP \(bu 2
added new grain for metadata to handle googles metadata differences (#53223)
.IP \(bu 2
Added win_shortcut execution and state module that does not prepend the current working directory to paths. Use shortcut.create and shortcut.present instead of file.shortcut. (#53706)
.IP \(bu 2
Add __env__ substitution inside file and pillar root paths (#55747)
.IP \(bu 2
Added support cpu hot add/remove, memory hot add, and nested virtualization to VMware salt\-cloud driver. (#56144)
.IP \(bu 2
Add a consul state module with acl_present and acl_absent functions. (#58101)
.IP \(bu 2
Added restconf module/states/proxy code for network device automation (#59006)
.IP \(bu 2
Adds the ability to get version information from a file on Windows systems (#59702)
.IP \(bu 2
Add aptkey=False kwarg option to the aptpkg.py module and pkgrepo state. Apt\-key is on the path to be deprecated. This will allow users to not use apt\-key to manage the repo keys. It will set aptkey=False automatically if it does not detect apt\-key exists on the machine. (#59785)
.IP \(bu 2
Added \(dqInstant Clone\(dq feature in the existing VMware Cloud module (#60004)
.IP \(bu 2
Added support for etcd API v3 (#60325)
.IP \(bu 2
Added \fIpkg.held\fP and \fIpkg.unheld\fP state functions for Zypper, YUM/DNF and APT. Improved \fIzypperpkg.hold\fP and \fIzypperpkg.unhold\fP functions. (#60432)
.IP \(bu 2
Added suse_ip module allowing to manage network interfaces on SUSE based Linux systems (#60702)
.IP \(bu 2
Support querying for JSON data in SQL external pillar (#60905)
.IP \(bu 2
Added support for yum and dnf on AIX (#60912)
.IP \(bu 2
Added percent success/failure of state runs in highstate summary output via new state_output_pct option (#60990)
.IP \(bu 2
Add support for retrieve IP\-address from qemu agent by Salt\-cloud on Proxmox (#61146)
.IP \(bu 2
Added new shortcut execution and state module to better handle UNC shortcuts and to test more thoroughly (#61170)
.IP \(bu 2
added yamllint utils module and yaml execution modules (#61182)
.IP \(bu 2
Add \(dq\-\-no\-return\-event\(dq option to salt\-call to prevent sending return event back to master. (#61188)
.IP \(bu 2
Add Etag support for file.managed web sources (#61270)
.IP \(bu 2
Adding the ability to add, delete, purge, and modify Salt scheduler jobs when the Salt minion is not running. (#61324)
.IP \(bu 2
Added a force option to file.symlink to overwrite an existing symlink with the same name (#61326)
.IP \(bu 2
\fIgpg_decrypt_must_succeed\fP config to prevent gpg renderer from failing silently (#61418)
.IP \(bu 2
Do not load a private copy of \fI__grains__\fP and \fI__salt__\fP for the sentry log handler if it is disabled. (#61484)
.IP \(bu 2
Add Jinja filters for itertools functions, flatten, and a state template workflow (#61502)
.IP \(bu 2
Add feature to allow roll\-up of duplicate IDs with different names in highstate output (#61549)
.IP \(bu 2
Allow cp functions to derive saltenv from config if not explicitly set (#61562)
.IP \(bu 2
Multiprocessing logging no longer uses multiprocessing queues which penalized performance.
.sp
Instead, each new process configures the terminal and file logging, and also any external logging handlers configured. (#61629)
.IP \(bu 2
Add a function to the freezer module for comparison of packages and repos in two frozen states (#61682)
.IP \(bu 2
Add grains_refresh_pre_exec option to allow grains to be refreshed before any operation (#61708)
.IP \(bu 2
Add possibility to pass extra parameters to salt\-ssh pre flight script with \fIssh_pre_flight_args\fP (#61715)
.IP \(bu 2
Add Etag support for archive.extracted web sources (#61763)
.IP \(bu 2
Add regex exclusions, full path matching, symlink following, and mtime/ctime comparison to file.tidied (#61823)
.IP \(bu 2
Add better handling for unit abbreviations and large values to salt.utils.stringutils.human_to_bytes (#61831)
.IP \(bu 2
Provide PyInstaller hooks that provide some runtime adjustments when Salt is running from a onedir (PyInstaller) bundled package. (#61864)
.IP \(bu 2
Add configurable onedir pip pypath location (#61937)
.IP \(bu 2
Add CNAME record support to the dig exec module (#61991)
.IP \(bu 2
Added support for changed user object in Zabbix 5.4+
Added compatibility with Zabbix 4.0+ for \fIzabbix.user_getmedia\fP method
Added support for setting medias in \fIzabbix.user_update\fP for Zabbix 3.4+ (#62012)
.IP \(bu 2
Add ignore_missing parameter to file.comment state (#62044)
.IP \(bu 2
General improvements on the \(dqansiblegate\(dq module:
* Add \(dqansible.targets\(dq method to gather Ansible inventory
* Add \(dqansible.discover_playbooks\(dq method to help collecting playbooks
* Fix crash when running Ansible playbooks if ansible\-playbook CLI output is not the expected JSON.
* Fix issues when processing inventory and there are groups with no members.
* Allow new types of targets for Ansible roster (#60056)
.IP \(bu 2
Add sample and shuffle functions from random (#62225)
.IP \(bu 2
Add \(dq<tiamat> python\(dq subcommand to allow execution or arbitrary scripts via bundled Python runtime (#62381)
.UNINDENT
(_release\-3005\-1)=
.SS Salt 3005.1 Release Notes
.sp
Version 3005.1 is a bug fix release for \fI\%3005\fP\&.
.SS Changelog
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fix arch parsing issue in apt source files (#62247)
.IP \(bu 2
Fixed parsing CDROM apt sources (#62474)
.IP \(bu 2
Use str() method instead of repo_line for when python3\-apt is installed or not in \fI\%aptpkg.py\fP\&. (#62546)
.IP \(bu 2
Remove the connection_timeout from netmiko_connection_args before netmiko_connection_args is added to \fBcontext\fP[\(dqnetmiko_device\(dq][\(dqargs\(dq] which is passed along to the Netmiko library. (#62547)
.IP \(bu 2
fixes #62553 by checking for disabled master_type before starting master connection and skipping it if set. (#62553)
.IP \(bu 2
Fix runas with cmd module when using the onedir bundled packages (#62565)
.IP \(bu 2
Fix the Pyinstaller hooks to preserve the environment if None is passed. (#62567, #62628)
.IP \(bu 2
pkgrepo.managed sets wrong permissions on keys installed to /etc/apt/keyring (#62569)
.IP \(bu 2
pkgrepo.managed creates zero byte gpg files when dearmoring contents to the same filename (#62570)
.IP \(bu 2
Ensure default values for IPC Buffers are correct type (#62591)
.IP \(bu 2
Fix a hang on salt\-ssh when using sudo. (#62603)
.IP \(bu 2
Renderers now have access to the correct set of salt functions. (#62610, #62620)
.IP \(bu 2
Fix including Jinja template from absolute path (#62611)
.IP \(bu 2
include jmespath in package requirements (#62613)
.IP \(bu 2
Fix pkgrepo.managed signed\-by in test=true mode (#62662)
.IP \(bu 2
Ensure the status of the service is captured when the beacon function is called, even when the event is not being emitted. (#62675)
.IP \(bu 2
The sub proxies controlled by Deltaproxy need to have their own req_channel otherwise there are timeout exceptions when the __master_req_channel_payload is fired and reacted on. (#62708)
.UNINDENT
.SS Salt 3005.2 Release Notes
.sp
Version 3005.2 is a CVE security fix release for \fI\%3005\fP\&.
.SS Changed
.INDENT 0.0
.IP \(bu 2
Additional required package upgrades
.INDENT 2.0
.IP \(bu 2
It\(aqs now \fIpyzmq>=20.0.0\fP on all platforms, and \fI<=22.0.3\fP just for windows.
.IP \(bu 2
Upgrade to \fIpyopenssl==23.0.0\fP due to the cryptography upgrade. (#63757)
.UNINDENT
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
fix CVE\-2023\-20897 by catching exception instead of letting exception disrupt connection (cve\-2023\-20897)
.IP \(bu 2
Fixed gitfs cachedir_basename to avoid hash collisions. Added MP Lock to gitfs. These changes should stop race conditions. (cve\-2023\-20898)
.IP \(bu 2
Upgrade to \fIrequests==2.31.0\fP
.INDENT 2.0
.TP
.B Due to:
.INDENT 7.0
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-j8r2\-6x86\-q33q\fP (#64336)
.UNINDENT
.UNINDENT
.IP \(bu 2
Upgrade to \fIcryptography==41.0.3\(ga(and therefor \(gapyopenssl==23.2.0\fP due to \fI\%https://github.com/advisories/GHSA\-jm77\-qphf\-c4w8\fP)
.sp
Also resolves the following cryptography advisories:
.INDENT 2.0
.TP
.B Due to:
.INDENT 7.0
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-5cpq\-8wj7\-hf2v\fP
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-x4qr\-2fvf\-3mr5\fP
.IP \(bu 2
\fI\%https://github.com/advisories/GHSA\-w7pp\-m8wf\-vj6r\fP
.UNINDENT
.UNINDENT
.sp
There is no security upgrade available for Py3.5 (#64595)
.IP \(bu 2
Bump to \fIcertifi==2023.07.22\fP due to \fI\%https://github.com/advisories/GHSA\-xqr8\-7jwr\-rhp7\fP
.sp
Python 3.5 cannot get the updated requirements since certifi no longer supports this python version (#64720)
.UNINDENT
.SS Salt 3005.3 Release Notes
.sp
Version 3005.3 is a Bug fix release for \fI\%3005\fP\&.
.SS Changed
.INDENT 0.0
.IP \(bu 2
Fix __env__ and improve cache cleaning see more info at pull #65017. (#65002)
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
Update to \fIgitpython>=3.1.35\fP due to \fI\%https://github.com/advisories/GHSA\-wfm5\-v35h\-vwf4\fP and \fI\%https://github.com/advisories/GHSA\-cwvm\-v4w8\-q58c\fP (#65167)
.UNINDENT
.SS Salt 3005.4 Release Notes
.sp
Version 3005.4 is a CVE security fix release for \fI\%3005\fP\&.
.SS Security
.INDENT 0.0
.IP \(bu 2
Fix CVE\-2023\-34049 by ensuring we do not use a predictable name for the script and correctly check returncode of scp command.
This only impacts salt\-ssh users using the pre\-flight option. (cve\-2023\-34049)
.IP \(bu 2
Bump to \fIcryptography==41.0.4\fP due to \fI\%https://github.com/advisories/GHSA\-v8gr\-m533\-ghj9\fP (#65267)
.IP \(bu 2
Bump to \fIurllib3==1.26.17\fP or \fIurllib3==2.0.6\fP due to \fI\%https://github.com/advisories/GHSA\-v845\-jxx5\-vc9f\fP (#65334)
.IP \(bu 2
Bump to \fIgitpython==3.1.37\fP due to \fI\%https://github.com/advisories/GHSA\-cwvm\-v4w8\-q58c\fP (#65383)
.UNINDENT
.SS Salt 3005.5 Release Notes
.sp
Version 3005.5 is a CVE security fix release for \fI\%3005\fP\&.
.SS Security
.INDENT 0.0
.IP \(bu 2
Fix CVE\-2024\-22231 by preventing directory traversal when creating syndic cache directory on the master.
.IP \(bu 2
Fix CVE\-2024\-22232 Prevent directory traversal attacks in the master\(aqs serve_file method.
.UNINDENT
.sp
These vulnerablities were discovered and reported by:
Yudi Zhao(Huawei Nebula Security Lab),Chenwei Jiang(Huawei Nebula Security Lab) (#565)
.SS Salt 3004 Release Notes \- Codename Silicon
.SS New Features
.SS Transactional System Support (MicroOS)
.sp
A transactional system, like \fBMicroOS\fP, can present some challenges
when the user decided to manage it via Salt.
.sp
MicroOS provide a read\-only rootfs and a tool,
\fBtransactional\-update\fP, that takes care of the management of the
system (updating, upgrading, installation or reboot, among others) in
an atomic way.
.sp
Atomicity is the main feature of MicroOS, and to guarantee this
property, this model leverages \fBsnapper\fP, \fBzypper\fP, \fBbtrfs\fP and
\fBoverlayfs\fP to create snapshots that will be updated independently
of the currently running system, and that are activated after the
reboot.  This implies, for example, that some changes made on the
system are not visible until the next reboot, as those changes are
living in a different snapshot of the file system.
.sp
Salt 3004 (Silicon) support this type of system via two new modules
(\fBtransactional_update\fP and \fBrebootmgr\fP) and a new executor
(\fBtransactional_update\fP).
.sp
The new modules will provide all the low level API for interacting
with transactional systems, like defining a mantenance window where
the system is free to reboot and activate the new state, or install
new software in a new transaction.  It will also provide hight level
of abstractions that will allows us to execute Salt module functions
or applying states inside new transactions.
.sp
The execution module will help us to treat the transactional system
transparently (like the traditional ones), using a mechanism that will
delegate some Salt modules execution into the new
\fBtransactional_update\fP module.
.SS Removed
.INDENT 0.0
.IP \(bu 2
Removed the deprecated glance state and execution module in favor of the glance_image
state module and the glanceng execution module. (#59079)
.IP \(bu 2
Removed support for Ubuntu 16.04 (#59869)
.IP \(bu 2
Removed the deprecated support for \fBgid_from_name\fP from the \fBuser\fP state module (#60565)
.IP \(bu 2
Removed deprecated virt.migrate_non_shared, virt.migrate_non_shared_inc, ssh from virt.migrate, and python2/python3 args from salt.utils.thin.gen_min and .gen_thin (#60893)
.UNINDENT
.SS Deprecated
.INDENT 0.0
.IP \(bu 2
The _ext_nodes alias to the master_tops function was added back in 3004 to maintain backwards compatibility with older supported versions. This alias will now be removed in 3006. This change will break Master and Minion communication compatibility with Salt minions running versions 3003 and lower. (#60980)
.IP \(bu 2
utils/boto3_elasticsearch is no longer needed (#59882)
.IP \(bu 2
Changed \(dqmanufacture\(dq grain to \(dqmanufacturer\(dq for Solaris on SPARC to unify the name across all platforms. The old \(dqmanufacture\(dq grain is now deprecated and will be removed in Sulfur (#60511)
.IP \(bu 2
Deprecate \fBsalt.payload.Serial\fP (#60953)
.UNINDENT
.SS Changed
.INDENT 0.0
.IP \(bu 2
Changed nginx.version to return version without \fBnginx/\fP prefix. (#57111)
.IP \(bu 2
Updated Slack webhook returner to support event returns on salt\-master (#57182)
.IP \(bu 2
Parsing Epoch out of version during pkg remove, since yum can\(aqt handle that in all of the cases. (#57881)
.IP \(bu 2
Add extra onfail req check in the state engine to allow onfail to be used with onchanges and other reqs in the same state (#59026)
.IP \(bu 2
Changed the default character set used by \fButils.pycrypto.secure_password()\fP to include symbols and implemented arguments to control the used character set. (#59486)
.UNINDENT
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Set default \(aqbootstrap_delay\(aq to 0 (#61005)
.IP \(bu 2
Fixed issue where multiple args to netapi were not preserved (#59182)
.IP \(bu 2
Handle all repo formats in the aptpkg module. (#60971)
.IP \(bu 2
Do not break master_tops for minion with version lower to 3003
This is going to be removed in Salt 3006 (Sulfur) (#60980)
.IP \(bu 2
Reverting changes in PR #60150. Updating installed and removed functions to return changes when test=True. (#60995)
.IP \(bu 2
Handle signals and properly exit, instead of raising exceptions. (#60391, #60963)
.IP \(bu 2
Redirect imports of \fBsalt.ext.six\fP to \fBsix\fP (#60966)
.IP \(bu 2
Surface strerror to user state instead of returning false (#20789)
.IP \(bu 2
Fixing _get_envs() to preserve the order of pillar_roots. _get_envs() returned pillar_roots in a non\-deterministic order. (#24501)
.IP \(bu 2
Fixes salt\-cloud \fBKeyError\fP that occurs when there exists any subnets with no tags when profiles use \fBsubnetname\fP (#44330)
.IP \(bu 2
Fixes postgres_local_cache by removing duplicate unicode encoding. (#46942)
.IP \(bu 2
Fixing the state aggregation system to properly handle requisities.
Fixing pkg state to exclude packages from aggregation if the hold attribute is in the state. (#47628)
.IP \(bu 2
fix issue that allows case sensitive files to be carried through (#47969)
.IP \(bu 2
Allow GCE Salt Cloud to use previously created IP Addresses. (#48947)
.IP \(bu 2
Fixing rabbitmq.list_user_permissions to ensure we are returning a permission list with three elements even when some values are empty. (#49115)
.IP \(bu 2
Periodically restart the fileserver update process to avoid leaks (#50313)
.IP \(bu 2
Fix default value to dictionary for mine_function (#50695)
.IP \(bu 2
Allow user.present to work on Alpine Linux by fixing linux_shadow.info (#50979)
.IP \(bu 2
Ensure that zypper is called with only one \-\-no\-refresh parameter (#51382)
.IP \(bu 2
Fixed fileclient cachedir path switching from master to minion due to incorrect MasterMinion configuration (#52288)
.IP \(bu 2
Fixed the container detection inside virtual machines (#53868)
.IP \(bu 2
Fix invalid dnf command when obsoletes=True in pkg.update function (#54224)
.IP \(bu 2
Jinja renderer resolves wrong relative paths when importing subdirectories (#55159)
.IP \(bu 2
Fixed bug #55262 where \fBsalt.modules.iptables\fP would call \fBcmd.run\fP and receive and interpret interspersed \fBstdout\fP and \fBstderr\fP output from subprocesses. (#55262)
.IP \(bu 2
Updated pcs support to handle auth and setup for new syntax supporting version 0.10 (#56924)
.IP \(bu 2
Reinstate ignore_cidr option in salt\-cloud openstack driver (#57127)
.IP \(bu 2
Fix for network.wolmatch runner displaying \(aqinvalid arguments\(aq error with valid arguments (#57473)
.IP \(bu 2
Fixed bug 57490, which prevented package installation for Open Euler and Issabel PBX. Both Open Euler and Issabel PBX use Yum for package management, added them to yumpkg.py. (#57490)
.IP \(bu 2
Better handling of bad RSA public keys from minions (#57733)
.IP \(bu 2
Fixing various functions in the file state module that use user.info to get group information, certain hosts particularly proxy minions do not have the user.info function available. (#57786)
.IP \(bu 2
Do not monkey patch yaml loaders: Prevent breaking Ansible filter modules (#57995)
.IP \(bu 2
Fix \-\-subset command line option, and support old \(aqsub\(aq parameter name in cmd_subset for backwards compatibility (#58600)
.IP \(bu 2
When calling salt.utils.http.query with a HEAD method to check for the existence of a source ensure that decode_body is False, so the file is not downloaded into memory when we don\(aqt need the contents. (#58881)
.IP \(bu 2
Update the runas user on freebsd for postgres versions >9.5, since freebsd will be removing the package on 2021\-05\-13. (#58915)
.IP \(bu 2
Fix pip module linked requirements file parsing (#58944)
.IP \(bu 2
Fix incorrect hostname quoting in /etc/sysconfig/networking on Red Hat family OS. (#58956)
.IP \(bu 2
Fix Xen DomU virt detection in grains for long running machines. (#59001)
.IP \(bu 2
add encoding when windows encoding is not defaulting to utf8 (#59063)
.IP \(bu 2
Fix \(dqaptpkg.normalize_name\(dq in case the arch is \(dqall\(dq for DEB packages (#59269)
.IP \(bu 2
Astra Linux now considered a Debian family distro (#59332)
.IP \(bu 2
Reworking the mysql module and state so that passwordless does not try to use unix_socket until unix_socket is set to True. (#59337)
.IP \(bu 2
Fixed the zabbix module to read the connection data from pillar. (#59338)
.IP \(bu 2
Fix crash on \(dqyumpkg\(dq execution module when unexpected output at listing patches (#59354)
.IP \(bu 2
Remove return that had left over py2 code from win_path.py (#59396)
.IP \(bu 2
Don\(aqt create spicevmc channel for Xen virtual machines (#59416)
.IP \(bu 2
Fix win_servermanager.install so it will reboot when restart=True is passed (#59424)
.IP \(bu 2
Clear the cached network interface grains during minion init and grains refresh (#59490)
.IP \(bu 2
Normalized grain output for LXC containers (#59573)
.IP \(bu 2
Fix typo in \(aqsalt/states/cmd.py\(aq to use \(dqcomment\(dq instead of \(dqcommnd\(dq. (#59581)
.IP \(bu 2
add aliyun linux support and set alinux as redhat family (#59686)
.IP \(bu 2
Don\(aqt fail updating network without netmask ip attribute (#59692)
.IP \(bu 2
Fixed using reserved keyword \(aqset\(aq as function argument in modules/ipset.py (#59714)
.IP \(bu 2
Return empty changes when nothing has been done in virt.defined and virt.running states (#59739)
.IP \(bu 2
Import salt.utils.azurearm instead of using __utils__ from loader in azure cloud.  This fixes an issue where __utils__ would become unavailable when we are using the ThreadPool in azurearm. (#59744)
.IP \(bu 2
Fix an issue with the LGPO module when the gpt.ini file contains unix style line
endings (/n). This was happening on a Windows Server 2019 instance created in
Google Cloud Platform (GCP). (#59769)
.IP \(bu 2
The \fBansiblegate\fP module now correctly passes keyword arguments to Ansible module calls (#59792)
.IP \(bu 2
Make sure cmdmod._log_cmd handles tuples properly (#59793)
.IP \(bu 2
Updating the add, delete, modify, enable_job, and disable_job functions to return appropriate changes. (#59844)
.IP \(bu 2
Apply pre\-commit changes to entire codebase. (#59847)
.IP \(bu 2
Fix Hetzner cloud driver does not recognize machines when rolling out a map (#59864)
.IP \(bu 2
Update Windows build deps & DLLs, Use Python 3.8, libsodium.dll 1.0.18, OpenSSL dlls to 1.1.1k (#59865)
.IP \(bu 2
Salt api verifies proper log file path when providing \(aq\-\-log\-file\(aq from the cli (#59880)
.IP \(bu 2
Detect Mendel Linux as Debian (#59892)
.IP \(bu 2
Fixed compilation of requisite_ins by also checking state type along with name/id (#59922)
.IP \(bu 2
Fix xen._get_vm() to not break silently when a VM and a template on XenServer have the same name. (#59932)
.IP \(bu 2
Added missing space for nftables.build_rule when using saddr or daddr. (#59958)
.IP \(bu 2
Add back support to load old entrypoints by iterating instead of type checking (#59961)
.IP \(bu 2
Fixed interrupting salt\-call in a pdb session. (#59966)
.IP \(bu 2
Validate we can import map files in states (#60003)
.IP \(bu 2
Update alter_db to return True or False depending on the success of failure of the alter.  Update grant_exists to only use the full list of available privileges when the grant is on the global level, eg. datbase is \(dq\fI\&.\fP\(dq. (#60031)
.IP \(bu 2
Fixed firewalld.list_zones when any \(dqrich rules\(dq is set (#60033)
.IP \(bu 2
IPCMessageSubscriber objects expose their connect method as a corotine so they
can be wrapped by SyncWrapper. (#60049)
.IP \(bu 2
Allow for Napalm dependency netmiko_mod to load correctly when used by Napalm with Cisco IOS (#60061)
.IP \(bu 2
Ensure proper access to the created temporary file when \fBrunas\fP is passed to \fBcmd.exec_code_all\fP (#60072)
.IP \(bu 2
Fixed an IndexError in pkgng.latest_version when querying an unknown package. (#60105)
.IP \(bu 2
Fixed pkgng.latest_version when querying by origin (e.g. \(dqshells/bash\(dq). (#60108)
.IP \(bu 2
Gracefuly handle errors in virt.vm_info (#60132)
.IP \(bu 2
The LGPO Module now uses \(dqSuccess and Failure\(dq for normal audit settings and advanced audit settings (#60142)
.IP \(bu 2
Fixing tests/pytests/unit/utils/scheduler/test_eval.py tests so the sleep happens before the status, so the job is given time before we check it. (#60149)
.IP \(bu 2
Update the external ipaddress to the latest 3.9.5 version which has some security fixes. Updating the compat.p to use the vendored version if the python version is below 3.9.5 and only run the test_ipaddress.py tests if below 3.9.5. (#60168)
.IP \(bu 2
Fixed ValueError exception in state.show_state_usage (#60179)
.IP \(bu 2
Redact the username and password when something goes wrong when using an HTTP source and we raise an exception. (#60203)
.IP \(bu 2
Inject the Ansible functions into Salt\(aqs \fBansiblegate\fP module which was broken on the 3001 release. (#60207)
.IP \(bu 2
Figure out the available Python version inside containers when executing \(dqdockermod.call\(dq function (#60229)
.IP \(bu 2
Handle IPv6 route types such as anycast, multicast, etc when returned from IPv6 route table queries (#60232)
.IP \(bu 2
Move the commonly used code that converts a list to a dictionary into salt.utils.beacons.  Fixing inotify beacon close function to ensure the configuration is converted from the provided list format into a dictionary. (#60241)
.IP \(bu 2
Set name of engine subprocesses (#60259)
.IP \(bu 2
Properly discover block devices path in virt.running (#60296)
.IP \(bu 2
Avoid exceptions when handling some exception cases. (#60330)
.IP \(bu 2
Fixed faulty error message in npm.installed state. (#60339)
.IP \(bu 2
Port option reinstated for Junos Proxy (accidentally removed) (#60340)
.IP \(bu 2
Now hosts.rm_host can remove entries from /etc/hosts when this file have inline comments. (#60351)
.IP \(bu 2
Fixes issue where the full same name is not used when making rights assignments with group policy (#60357)
.IP \(bu 2
Fixed zabbix_host.present to not overwrite inventory_mode to \(dqmanual\(dq every time inventory is updated. (#60382)
.IP \(bu 2
Allowed zabbix_host.present to do partial updates of inventory, also don\(aqt erase everything if inventory is missing in state definition. (#60389)
.IP \(bu 2
Fixing the mysql_cache module to handle binary inserting binary data into the database. Initially adding tests. (#60398)
.IP \(bu 2
Fixed host_inventory_get to not throw an exception if host does not exist (#60418)
.IP \(bu 2
Check for /dev/kvm to detect KVM hypervisor. (#60419)
.IP \(bu 2
Fixing file.accumulated handling of dependencies when the state_id is used instead of {function: state_id} format. (#60426)
.IP \(bu 2
Adding the ability for yumpkg.remove to handle package names with widdcards. (#60461)
.IP \(bu 2
Pass emulator path to get guest capabilities from libvirt (#60491)
.IP \(bu 2
virt.get_disks: properly report qemu\-img errors (#60512)
.IP \(bu 2
Make all platforms have psutils. This prevents a minion from starting if an instance is all ready running. (#60523)
.IP \(bu 2
Ignore configuration for \(aqenable_fqdns_grains\(aq for AIX, Solaris and Juniper, assume False (#60529)
.IP \(bu 2
Remove check for TIAMAT_BUILD enforcing USE_STATIC_REQUIREMENTS, this is now controlled by Tiamat v7.10.1 and above (#60559)
.IP \(bu 2
Have the beacon call run through a try...except, catching any errors, logging and firing an event that includes the error.
Fixing the swapusage beacon to ensure value is a string before we attempt to filter out the %. (#60585)
.IP \(bu 2
Refactor loader into logical sub\-modules (#60594)
.IP \(bu 2
Clean up references to ZMQDefaultLoop (#60617)
.IP \(bu 2
change dep warn from Silicon to Phosphorus for the cmd,show,system_info and add_config functions in the nxos module. (#60669)
.IP \(bu 2
Fix bug 60602 where the hetzner cloud provider isn\(aqt recognized correctly (#60675)
.IP \(bu 2
Fix the \fBpwd.getpwnam\fP caching issue on macOS user module (#60676)
.IP \(bu 2
Fixing beacons that can include a value in their configuration that may or may not included a percentage.  We want to handle the situation where the percentage sign is not included and the value is not handled as a string. (#60684)
.IP \(bu 2
Fix RuntimeError in process manager (#60749)
.IP \(bu 2
Ensure all data that is being passed along to LDAP is in an OrderedSet and contains bytes. (#60760)
.IP \(bu 2
Update the AWS API version so VMs spun up by salt\-cloud where the VPC has it enabled to assign ipv6 addresses by default, actually get ipv6 addresses assigned by default. (#60804)
.IP \(bu 2
Remove un\-needed singletons from tranports (#60851)
.UNINDENT
.SS Added
.INDENT 0.0
.IP \(bu 2
Add windows support for file.patch with patch.exe from git for windows optional packages (#44783)
.IP \(bu 2
Added ability to pass exclude kwarg to salt.state inside orchestrate. (#49130)
.IP \(bu 2
Added \fBsuccess_stdout\fP and \fBsuccess_stderr\fP arguments to \fBcmd.run\fP, to override default return code behavior. (#50597)
.IP \(bu 2
The netbox pillar now been enhanced to add support for querying virtual machines
(in addition to devices), as well as minion interfaces and associated IP
addresses. (#51490)
.IP \(bu 2
Add support for transactional systems, like openSUSE MicroOS (#58519)
.IP \(bu 2
Added namespace headers to allow use of namespace from config to communicate with Vault Enterprise namespaces (#58585)
.IP \(bu 2
boto3mod unit tests (#58713)
.IP \(bu 2
New decorators \fBallow_one_of()\fP and \fBrequire_one_of()\fP (#58742)
.IP \(bu 2
Added \fBnosync\fP switch to disable initial raid synchronization (#59193)
.IP \(bu 2
Expanded the documentation for the netbox pillar. (#59398)
.IP \(bu 2
Rocky Linux has been added to the RedHat os_family. (#59682)
.IP \(bu 2
Add \(dqpoudriere \-i \-j jail_name\(dq option to list jail information for poudriere (#59831)
.IP \(bu 2
Added the grains.uuid on Windows platform (#59888)
.IP \(bu 2
Add a salt.util.platform check to detect the AArch64 64\-bit extension of the ARM architecture. (#59915)
.IP \(bu 2
Adding support for Deltaproxy controlled proxy minions into Salt Open. (#60090)
.IP \(bu 2
Added functions to slsutil execution module to test if files exist in the state tree
Added function to slsutil execution module to search for a file by walking up the state tree (#60159)
.IP \(bu 2
Allow module_refresh to also refresh available beacons, eg. following a Python library being installed and \(dqrefresh_modules\(dq being passed as an argument in a state. (#60541)
.IP \(bu 2
Add the \fBdetect_remote_minions\fP and \fBremote_minions_port\fP options to allow the master to detect remote ports for connected minions. This will allow users to detect Heist\-Salt minions the master is connected to over port 22 by default. (#60612)
.IP \(bu 2
Add the python rpm\-vercmp library in the rpm_lowpkg.py module. (#60814)
.IP \(bu 2
Allow a user to use the aptpkg.py module without installing python\-apt. (#60818)
.UNINDENT
.SS Salt 3004.1 Release Notes
.sp
Version 3004.1 is a CVE security fix release for \fI\%3004\fP\&.
.SS Important notice about upgrading
.sp
Version 3004.1 is a security release. 3004.1 minions are not able to
communicate with masters older than 3004.1. You must upgrade your masters
before upgrading minions.
.SS Minion authentication security
.sp
Authentication between masters and minions rely on public/private key
encryption and message signing. To secure minion authentication before you must
pre\-seed the master\(aqs public key on minions. To pre\-seed the minions\(aq master
key, place a copy of the master\(aqs public key in the minion\(aqs pki directory as
\fBminion_master.pub\fP\&.
.SS Security
.INDENT 0.0
.IP \(bu 2
Sign authentication replies to prevent MiTM (cve\-2022\-22935)
.IP \(bu 2
Prevent job and fileserver replays (cve\-2022\-22936)
.IP \(bu 2
Sign pillar data to prevent MiTM attacks. (cve\-2202\-22934)
.IP \(bu 2
Fixed targeting bug, especially visible when using syndic and user auth. (CVE\-2022\-22941) (#60413)
.IP \(bu 2
Fix denial of service in junos ifconfig output parsing.
.UNINDENT
.SS Salt 3004.2 Release Notes
.sp
Version 3004.2 is a CVE security fix release for \fI\%3004\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Expand environment variables in the root_dir registry key (#61445)
.IP \(bu 2
Update Markup and contextfunction imports for jinja versions >=3.1. (#61848)
.IP \(bu 2
Fix bug in tcp transport (#61865)
.IP \(bu 2
Make sure the correct key is being used when verifying or validating communication, eg. when a Salt syndic is involved use syndic_master.pub and when a Salt minion is involved use minion_master.pub. (#61868)
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
Fixed PAM auth to reject auth attempt if user account is locked. (cve\-2022\-22967)
.UNINDENT
.SS Salt 3003 Release Notes \- Codename Aluminium
.SS New Features
.SS SCRAM\-SHA\-256 support for PostgreSQL passwords
.sp
Support for SCRAM\-SHA\-256 password hashes has been added to the
\fI\%postgres_user.present\fP
and \fI\%postgres_group.present\fP
states. This allows migration away from the insecure and deprecated
previous storage methods.
.SS Added
.INDENT 0.0
.IP \(bu 2
Added \(dqfips_mode\(dq config option to master and minion configs. (#59427)
.IP \(bu 2
Firewall groups support to Vultr Salt Cloud provider
.IP \(bu 2
Adding the ability to clear and show the pillar cache enabled when pillar_cache is True. (#37080)
.IP \(bu 2
SCRAM\-SHA\-256 support for PostgreSQL passwords.
Pass encrypted=scram\-sha\-256 to the postgres_user.present (or postgres_group.present) state. (#51271)
.IP \(bu 2
The yumpkg module has been updated to support VMWare\(aqs Photon OS, which uses tdnf (a C implementation of dnf).  \(dqVMware Photon OS\(dq has been added to the \(dqRedHat\(dq \fIos_family\fP map as part of this change. (#51912)
.IP \(bu 2
The pkgrepo state now supports VMware Photon OS. (#52550)
.IP \(bu 2
Added firewallgroups to Vultr Salt Cloud provider (#53677)
.IP \(bu 2
Added arbitrary kwarg support for tojson filter. (#56012)
.IP \(bu 2
Add salt monitor beacon to execute salt execution module functions. (#56461)
.IP \(bu 2
Allow the nameservers to be populated from systemd\-resolve. (#57618)
.IP \(bu 2
Adding reactor_niceness to the default minion configuration. (#57701)
.IP \(bu 2
CPU model, topology and NUMA node tuning (#57880)
.IP \(bu 2
Added \fBpkg.services_need_restart\fP which lists system services that should be restarted after package management operations. (#58261)
.IP \(bu 2
Allow handling special first boot definition on virtual machine (#58589)
.IP \(bu 2
Added vgcreate custom parameters to module call: addtag, alloc, autobackup, metadatatype, zero (#58747)
.IP \(bu 2
Enhance console and serial support in virt module (#58844)
.IP \(bu 2
Salt\(aqs versions report \fIsalt \-\-versions\-report\fP now includes all installed salt extensions into its versions report. (#58938)
.IP \(bu 2
Support loading entrypoints by passing a module instead of a function. (#58939)
.IP \(bu 2
Added shadow.gen_password for BSD operating systems. (#59140)
.IP \(bu 2
Add more network and PCI/USB host devices passthrough support to virt module and states (#59143)
.IP \(bu 2
Add interface channels management support to rh_ip module. (#59147)
.IP \(bu 2
Add new minion option return_retry_tries for dynamic return retry tries (#59236)
.IP \(bu 2
Added salt\-cloud support for Hetzner Cloud via the \fBhcloud\fP library of the provider. (#59301)
.IP \(bu 2
\(dqAlmaLinux\(dq has been added to the \(dqRedHat\(dq \fIos_family\fP map (#59404)
.IP \(bu 2
Added \fIblocks\fP and \fIattachments\fP params to the \fIslack_notify.post_message\fP function (#59428)
.IP \(bu 2
Added tcp_reconnect_backoff minion config option for specifying reconnection backoff time for TCP transport (#59431)
.IP \(bu 2
Added \fBswapusage\fP beacon to complement the existing \fBmemusage\fP beacon. (#59460)
.IP \(bu 2
The \fIsalt\-run\fP CLI now accepts \fI\-\-jid\fP (#59527)
.IP \(bu 2
Add bytes option for FreeBSD pkg\-stats(8) module. (#59540)
.IP \(bu 2
Adding mod_beacon function to pkg, service, and file state modules. This function will act similar to the mod_watch function. This will allow supported functions in those state modules to automatically add associated beacons to monitor for changes to the respective resources in the state file and fire events to the event bus when changes occur. (#59559)
.IP \(bu 2
Add \-B flag to FreeBSD pkgng.check() to regenerate the library dependency
metadata for a package by extracting library requirement information from the
binary ELF files in the package. (#59569)
.UNINDENT
.SS Changed
.INDENT 0.0
.IP \(bu 2
The \fI\%pkg\fP module now supports \fBtdnf\fP used by
VMWare Photon OS.  As part of this change, \fBVMWare Photon OS\fP\(aqs
\fBos_family\fP grain will now resolve as \fBRedHat\fP\&.  This may require changes
to existing uses of \fI\%grains.filter_by\fP
.IP \(bu 2
The \fBsalt\-run\fP CLI now accepts \fB\-\-jid\fP which allows scripting against it.
.IP \(bu 2
Change \fIbrew cask \-\-list\fP to \fIbrew list \-\-cask\fP (#58381)
.IP \(bu 2
Store git sha in salt/_version.py when installing from a tag so it can be found if needed later. (#59137)
.IP \(bu 2
Changed package manager detection in yumpkg module (#59201)
.IP \(bu 2
Updating the pkg beacon to fire the events when there are upgrades to packages, but also when watched packages are installed or removed. Breaking out the logic for listing pkgs from context into a separate function to aid in testing. Updating tests to ensure context is not used when use_context option to list_pkgs is False. (#59463)
.UNINDENT
.SS Removed
.INDENT 0.0
.IP \(bu 2
Removed the deprecated glance state and execution module in favor of the glance_image
state module and the glanceng execution module. (#59079)
.IP \(bu 2
Removing the _ext_nodes deprecation warning and alias to the master_tops function.  This change will break compatibility with a Salt master running versions 2017.7.8 and older and Salt minions running versions 3003 and newer. (#59804)
.IP \(bu 2
removed the arg \fImanaged_private_key\fP from \(aqsalt.states.x509.certificate_managed\(aq (#59247)
.IP \(bu 2
Drop support for python 3.5 on Windows (#59479)
.IP \(bu 2
Removed support for Ubuntu 16.04 (#59913)
.UNINDENT
.SS Deprecated
.INDENT 0.0
.IP \(bu 2
Added deprecation warning for grains.get_or_set_hash (#59425)
.UNINDENT
.SS Fixed
.INDENT 0.0
.IP \(bu 2
When instantiating the loader grab values of grains and pillars if
they are NamedLoaderContext instances. (#59773)
.IP \(bu 2
Fixed installation on Apple Silicon Macs by checking $HOMEBREW_PREFIX for \fIlibcrypto\fP instead of assuming /usr/local. (#59808)
.IP \(bu 2
The Google Cloud Engine salt\-cloud provider now requires \fIapache\-libcloud>=2.5.0\fP\&. Service account authentication is broken on older versions.
.IP \(bu 2
Fix incorrect documentation for pillar_source_merging_strategy (#26396)
.IP \(bu 2
Don\(aqt iterate through cloud map errors (#34033)
.IP \(bu 2
Suppress noisy warnings when very old pyzmq is used. (#50327)
.IP \(bu 2
Fixed glusterfs version parsing for pre\-4.0 (#50707)
.IP \(bu 2
Prevent traceback when trying to list reactors when none are configured. (#53334)
.IP \(bu 2
Fixed zabbix_host.present to accept all Zabbix host properties (#53838)
.IP \(bu 2
Binaries for the salt installer package for OSX are now signed and the installer
package is notarized (#54513)
.IP \(bu 2
Guard boto3_elasticsearch loading properly (#55848)
.IP \(bu 2
Use a capitalized string version of the value of \fINodeState\fP instead (#56589)
.IP \(bu 2
Adding missing error case to the validation for service beacon. (#56623)
.IP \(bu 2
The GCE cloud driver only works with apache\-libcloud>=2.5.0, prior versions have authentication issues (#56862)
.IP \(bu 2
zypperpkg add_lock and remove_lock examples do not work (#56922)
.IP \(bu 2
Compare bytes to bytes so we don\(aqt overwrite a correct value (#57212)
.IP \(bu 2
Fixing expand_repo_def in aptpkg module to include the architecture in the line attribute when it is passed in. (#57600)
.IP \(bu 2
When passing arguments pass them as keyword arguments so that we can be sure the right value is going where. (#58006, #58579, #59075)
.IP \(bu 2
Improve module whitelist logic for file backends (#58041)
.IP \(bu 2
Fix behavior for \(dqonlyif/unless\(dq state conditionals when multiple declarations (#58085)
.IP \(bu 2
Ensure data is a valid keyword argument for the event.wait function. (#58182)
.IP \(bu 2
Do not raise \(dqStreamClosedError\(dq traceback on the master logs but only log it (#58301)
.IP \(bu 2
Fixed issue with win_timezone when dst is turned off. This was causing the
minion not to start
Use default timezone offset in scheduler when correct timezone cannot be determined (#58379)
.IP \(bu 2
Pop!_OS 20.04 and 20.10 now support using pkg.* / aptpkg.* (#58395)
.IP \(bu 2
Restoring functionality of the textfsm module when using textfsm_path argument (#58499)
.IP \(bu 2
Invalidate file list cache when cache file has a future last modified time (#58529)
.IP \(bu 2
Fix issue with setting permissions in combination with the win_perms_reset
option (#58541)
.IP \(bu 2
Adds support for Powershell 7. It is specified by passing shell=\(dqpwsh\(dq. Only
valid if Powershell 7 is installed on the system. (#58598)
.IP \(bu 2
Fixed the zabbix.host_create call on zabbix_host.present to include the
optional parameter visible_name. Now working as documented. (#58602)
.IP \(bu 2
Fixed some bugs to allow zabbix_host.present to update a host already
existent on Zabbix server:
.INDENT 2.0
.IP \(bu 2
Added checks before \(dqpop\(dq the elements \(dqbulk\(dq and \(dqdetails\(dq from
hostinterfaces_get\(aqs response. Without that, the interface comparison
didn\(aqt works with Zabbix >= 5.0
.IP \(bu 2
Fixed the \(dqinventory\(dq comparison. It failed when both current and new
inventory were missing.
.IP \(bu 2
Rewrite of the update_interfaces routine to really \(dqupdate\(dq the
interfaces and not trying to delete and recreate all interfaces,
which almost always gives errors as interfaces with linked items
can\(aqt be deleted. (#58603)
.UNINDENT
.IP \(bu 2
Added the \(dqdetails\(dq mandatory object with the properly default values
when creating a SNMP hostinterface in Zabbix 5.0 (#58620)
.IP \(bu 2
Fixing an issue preventing running pillar.get against pillar values with integers as pillar keys. (#58714)
.IP \(bu 2
Adding a new option to pass client_flags to MySQL connections, for example passing the option to support multiple statements in queries. (#58718)
.IP \(bu 2
Fixed two performance bugs in the sysctl.present state.  Their impact is
especially great on FreeBSD machines with large amounts of RAM. (#58732)
.IP \(bu 2
Fixed an issue when pillar files are included in the \fItop.sls\fP and then later included in another pillar file. (#58736)
.IP \(bu 2
Left over py2 code was causing windows encoding to misbehave (#58749)
.IP \(bu 2
Return result=None from module.run state to indicate that changes would be made
Return result=False from module.run state when called with no functions (#58752)
.IP \(bu 2
Fix duplicate IP addresses in fqdn_ip4 and fqdn_ip6 grains (#58799)
.IP \(bu 2
Rename \fIsalt.renderers.toml\fP to \fIsalt.renderers.tomlmod\fP which fixes the import error issues as described in #58822
Do note that, the renderer is still called \fItoml\fP\&. (#58822)
.IP \(bu 2
Fixing unhold in yumpkg. Removing unnecessary code and relying on the code that handles dicts later. Adding tests when pkg.installed is called with hold=False. (#58883)
.IP \(bu 2
Converts the given \(dqgrant\(dq to upper case before compare to \(dqALL\(dq.
This fixes a problem granting \(dqall privileges\(dq to a MySQL user. (#58933)
.IP \(bu 2
Strip trailing \(dq/\(dq from repo.uri when comparing repos in \(dqapktpkg.mod_repo\(dq (#58962)
.IP \(bu 2
When we are checking requisites, run reconcile_procs just on those requisite states not all running states. (#58976)
.IP \(bu 2
Allow the gpg module to use export_key, delete_key and create_key without a passphrase in GnuPG >= 2.1 (#58980)
.IP \(bu 2
Updated the documentation, handling and error messages for what size units are allowed by \(dqsize\(dq parameter in lvm.lv_present (#58985)
.IP \(bu 2
Fixing the two failing tests when running on Photon OS. Python 3 installed on Photon OS does not support MD4 hashing, so don\(aqt load pdbedit module and skip the test_generate_nt_hash test. Default unmask for files and directories results in them having only user and group permissions so update the test_directory_max_depth test. (#58991)
.IP \(bu 2
Fixes to netmiko module and proxy module to handle situations where the device is unreachable during the initial connection phase. (#59011)
.IP \(bu 2
Correct comment when updating postrges users and groups.
Errors reported when removing postgres groups.
Partial group membership changes in postgres groups. (#59034)
.IP \(bu 2
Fixed an error when running svn.latest in test mode and using the trust_failures
option. (#59069)
.IP \(bu 2
Fixes to storing schedule items in pillar, when refreshing pillar only update the schedule items if something has changed. (#59104)
.IP \(bu 2
Fixed timezone module to work in Slackware Linux (#59130)
.IP \(bu 2
Enforces pywinrm to be version 0.3.0 or higher and upgrade to latest (#59138)
.IP \(bu 2
Fix a race condition in the ldx module which sometimes caused devices not to be created during container creation. (#59145)
.IP \(bu 2
Fix issue where passed smb port was being passed to the smb connection when
deploying Windows with salt\-cloud (#59153)
.IP \(bu 2
Fixed an error when running on CentOS Stream 8. (#59161)
.IP \(bu 2
Fix event publish retry when using TCP transport (#59162)
.IP \(bu 2
Fix docs for \fIauth_timeout\fP (#59175)
.IP \(bu 2
virt.update doesn\(aqt update the definition if efi=True and a loader is already set (#59188)
.IP \(bu 2
Fixed salt.modules.solaris_shadow failing on bytes\-like object is require, not \(aqstr\(aq. (#59191)
.IP \(bu 2
Added support for io2 volumes in ec2 cloud (#59218)
.IP \(bu 2
When checking if the mode had changed in the file state module, only do so if the passed mode is not None. (#59276)
.IP \(bu 2
Fixing _sanitze_comments to use sqlparse instead of re.sub. (#59336)
.IP \(bu 2
Allow use of query parameters in cmd.script source url (#59362)
.IP \(bu 2
Access user from global group if local group fails to find user. (#59412)
.IP \(bu 2
Detect and fix grub.xen path (#59484)
.IP \(bu 2
Stop raising \fIStopIteration\fP on generators (#59512)
.IP \(bu 2
Fix minion race conditions handling SIGTERM signal when loading modules (#59524)
.IP \(bu 2
Support new output of systemd systemctl list\-unit\-files in the following modules systemd_service.get_enabled, systemd_service.get_disabled and systemd_service.get_static (#59526)
.IP \(bu 2
Fix pkg.upgrade with \-U arg on FreeBSD, \-L flag was deprecated long time. (#59565)
.IP \(bu 2
Fixing the virtual function for the netimiko module to allow it to run outside of a proxy minion. Adding additional tests. (#59635)
.IP \(bu 2
Allow \(dqextra_filerefs\(dq as sanitized kwargs for SSH client.
Fix regression on \(dqcmd.run\(dq when passing tuples as cmd. (#59664)
.UNINDENT
.SS Salt 3003.1 Release Notes
.sp
Version 3003.1 is a bug fix release for \fI\%3003\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fixed race condition in batch logic. Added \fIlisten\fP option to \fILocalClient\fP to prevent event subscriber from purging cached events during batch iteration. (#56273)
.IP \(bu 2
Fixed dependencies for Amazon Linux 2 on \fI\%https://repo.saltproject.io\fP since Amazon Linux 2 now provides some of the python libraries in their repos. (#59982)
.IP \(bu 2
IPCMessageSubscriber objects expose their connect method as a coroutine so they can be wrapped by SyncWrapper. (#60049)
.IP \(bu 2
Import salt.utils.azurearm instead of using __utils__ from loader in azure cloud.  This fixes an issue where __utils__ would become unavailable when we are using the ThreadPool in azurearm. (#59744)
.IP \(bu 2
Use contextvars library from site\-packages if it is intalled. Fixes salt ssh for targets with python <=3.6 (#59942)
.IP \(bu 2
Add back support to load old entrypoints by iterating instead of type checking (#59961)
.IP \(bu 2
Pass the value of the \fB__grains__\fP NamedContext to salt.pillar.get_pillar, instead of the NamedContext object itself. (#59975)
.IP \(bu 2
Fix pillar serialization in jinja templates (#60083)
.UNINDENT
.SS Salt 3003.2 Release Notes
.sp
Version 3003.2 is a bug fix release for \fI\%3003\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Periodically restart the fileserver update process to avoid leaks (#50313)
.IP \(bu 2
Add ssh_timeout to kwargs in deploy_script (#59901)
.IP \(bu 2
Update the external ipaddress to the latest 3.9.5 version which has some security fixes. Updating the compat.p to use the vendored version if the python version is below 3.9.5 and only run the test_ipaddress.py tests if below 3.9.5. (#60168)
.IP \(bu 2
Use the right crypto library for salt.utils.crypt.reinit_crypto (#60215)
.IP \(bu 2
Stop SSH from hanging if connection is lost. Also added args to customize grace period. (#60216)
.IP \(bu 2
Improve reliability of Terminal class (#60504)
.IP \(bu 2
Ignore configuration for \(aqenable_fqdns_grains\(aq for AIX, Solaris and Juniper, assume False (#60529)
.UNINDENT
.SS Salt 3003.3 (2021\-08\-20)
.sp
Version 3003.3 is a CVE security fix release for \fI\%3003\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fix issue introduced in \fI\%https://github.com/saltstack/salt/pull/59648\fP (#60046)
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
Verify the owner of an existing config before trusting it during install. If the owner cannot be verified, back it up and use defaults. (CVE\-2021\-22004)
.IP \(bu 2
Ensure that sourced file is cached using its hash name (cve\-2021\-21996)
.UNINDENT
.SS Salt 3003.4 (2022\-02\-25)
.sp
Version 3003.4 is a CVE security fix release for \fI\%3003\fP\&.
.SS Important notice about upgrading
.sp
Version 3003.4 is a security release. 3003.4 minions are not able to
communicate with masters older than 3003.4. You must upgrade your masters
before upgrading minions.
.SS Minion authentication security
.sp
Authentication between masters and minions rely on public/private key
encryption and message signing. To secure minion authentication before you must
pre\-seed the master\(aqs public key on minions. To pre\-seed the minions\(aq master
key, place a copy of the master\(aqs public key in the minion\(aqs pki directory as
\fBminion_master.pub\fP\&.
.SS Security
.INDENT 0.0
.IP \(bu 2
Sign authentication replies to prevent MiTM (cve\-2022\-22935)
.IP \(bu 2
Prevent job and fileserver replays (cve\-2022\-22936)
.IP \(bu 2
Sign pillar data to prevent MiTM attacks. (cve\-2202\-22934)
.IP \(bu 2
Fixed targeting bug, especially visible when using syndic and user auth. (CVE\-2022\-22941) (#60413)
.IP \(bu 2
Fix denial of service in junos ifconfig output parsing.
.UNINDENT
.SS Salt 3003.5 (2022\-07\-05)
.sp
Version 3003.5 is a CVE security fix release for \fI\%3003\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Update Markup and contextfunction imports for jinja versions >=3.1. (#61848)
.IP \(bu 2
Fix bug in tcp transport (#61865)
.IP \(bu 2
Make sure the correct key is being used when verifying or validating communication, eg. when a Salt syndic is involved use syndic_master.pub and when a Salt minion is involved use minion_master.pub. (#61868)
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
Fixed PAM auth to reject auth attempt if user account is locked. (cve\-2022\-22967)
.UNINDENT
.SS Salt 3002 Release Notes \- Codename Magnesium
.SS New Features
.SS Network Teaming Support Added (RHEL/CentOS)
.sp
Support for two new interface types (\fBteam\fP and \fBteamport\fP) has been added
to the \fI\%network.managed\fP state. See the
documentation for example usage.
.SS Execution Module Changes
.sp
The \fBip.get_bond\fP and
\fBip.build_bond\fP functions have been
removed from the \fBip\fP module for RHEL/CentOS. Configuring bonding opts in
modprobe configurations has not been necessary since RHEL 4, and Salt was in
fact redundantly both creating modprobe configurations \fIand\fP using the
\fBBONDING_OPTS\fP interface configuration parameter.
.SS Removed
.INDENT 0.0
.IP \(bu 2
removed boto_vpc.describe_route_table please use boto_vpc.describe_route_tables (#58636)
.IP \(bu 2
removed show_ipv4 arg from all functions in from salt.runners.manage (#58638)
.IP \(bu 2
removed kwargs from mandrill.send if you use \(dqasync\(dq please use \(dqasynchronous\(dq (#58640)
.IP \(bu 2
removed salt/modules/mac_brew_pkg.__fix_cask_namespace (#58641)
.IP \(bu 2
zfs.mount Passing \(aq\-a\(aq as name is deprecated please just pass \(aqNone\(aq (#58642)
.IP \(bu 2
Remove include_localhost kwarg for connected_ids method in salt/utils/minions.py (#58224)
.IP \(bu 2
deprecated opts default argument of none and removed deprecation warnings (#58635)
.UNINDENT
.SS Deprecated
.INDENT 0.0
.IP \(bu 2
The \fIssh\fP parameter of \fIvirt.migrate\fP has been deprecated. Use a libvirt URI \fItarget\fP value instead. Both \fIvirt.migrate_non_shared\fP and \fIvirt.migrate_non_shared_inc\fP have been deprecated. Use the \fIcopy_storage\fP parameter with \fIvirt.migrate\fP instead. (#57947)
.UNINDENT
.SS Changed
.INDENT 0.0
.IP \(bu 2
Allow specifying a custom port for Proxmox connection (#50620)
.IP \(bu 2
Changed the lvm.lv_present state to accept a resizefs switch. So, when
the logical volume is resized, the filesystem will be resized too. (#55265)
.IP \(bu 2
Change the \fBenable_fqdns_grains\fP setting to default to \fBFalse\fP on proxy minions
as it is generally not needed and just slows down start up time.. (#57676)
.IP \(bu 2
Adds network teaming support to \fBnetwork.managed\fP state for RHEL\-based
distros. Removes \fBip.get_bond\fP and \fBip.build_bond\fP for the same, as is
redundant and not needed for any current RHEL/CentOS/Fedora/etc. release. (#57775)
.IP \(bu 2
The \fBserializer\fP argument has been added to the \fI\%file.serialize\fP state, as an alternative to \fBformatter\fP\&. This
brings it more in line with the \fBserializer_opts\fP and \fBdeserializer_opts\fP
arguments. \fBformatter\fP is still supported, but using both \fBserializer\fP and
\fBformatter\fP will cause the state to fail. (#57858)
.UNINDENT
.SS Fixed
.INDENT 0.0
.IP \(bu 2
\fIfile.read\fP exec module function no longer fails on binary data. (#58033)
.IP \(bu 2
Remove py2 support from winrepo execution module and runner (#58596)
.IP \(bu 2
Create ini file if does not exist when using ini.options_present state module. (#34236)
.IP \(bu 2
Added an bool \(dqstrict\(dq argument to sdb.get module to force module to fail if the sdb uri is not correct. (#39163)
.IP \(bu 2
Fixed issue with postgres.has_privilege breaking on ALL. (#48465)
.IP \(bu 2
check for azurearm username in config before adding username and password to the virtual machine properties (#49063)
.IP \(bu 2
Fixes service.status to return True/False instead of empty strings or PIDs of the service. This brings macOS into parity with the other service modules. (#49237)
.IP \(bu 2
fix frequent rest_tornado non\-fatal tracebacks (#49572)
.IP \(bu 2
Do not use reverse DNS of the target used in salt\-ssh. Use the target the user provides. (#49840)
.IP \(bu 2
Fixes startup issue where it tried to load the kernalparams grain on Windows (#49901)
.IP \(bu 2
Fixed error in nilrt_ip.get_interfaces_details when loading config. (#50416)
.IP \(bu 2
Doesn\(aqt remove underscore when sanitizing hostname in network salt util (#50527)
.IP \(bu 2
.INDENT 2.0
.TP
.B permit the use of int/float type for the version in:
.INDENT 7.0
.IP \(bu 2
the state postgres_cluster.present
.IP \(bu 2
the state postgres_cluster.absent
.IP \(bu 2
the module postgres.cluster_create
.IP \(bu 2
the module postgres.cluster_remove (#50899)
.UNINDENT
.UNINDENT
.IP \(bu 2
Cleaned up a trackback in lvm.pv_present when the disk doesn\(aqt exist. (#52363)
.IP \(bu 2
Fixed UnboundLocalError when using win_network.connect (#53371)
.IP \(bu 2
Add accept_ra 2 option to modules.debian_ip (#54067)
.IP \(bu 2
salt.runner test mode support (#54382)
.IP \(bu 2
Fixed mkpart to allow the creation of a partition without filesystem (#54456)
.IP \(bu 2
Fixes bogus warning message when an empty list is used for an environment in a
topfile. This allows \fI[]\fP to be used as a placeholder in a topfile without
needing to comment everything out as a workaround. (#54882)
.IP \(bu 2
win_certutil state will no longer fail on non\-English systems upon successful additions and deletions of a certificate. (#55024)
.IP \(bu 2
Fixed file.directory state always showing mode change for symlinks. (#55878)
.IP \(bu 2
check for a docker error that the swarm already exists when calling swarm.swarm_init on an existing docker swarm (#55949)
.IP \(bu 2
Fixing stalekey engine so it deletes the keys when they are a list. (#55977)
.IP \(bu 2
An invalid _schedule.conf configuration file is renamed to _schedule.confYAMLError.
This avoids disabling the minion and busy polling the CPU on Windows. (#56216, #58177)
.IP \(bu 2
Proper calculation of tpldir and related context parameters (#56410)
.IP \(bu 2
Make gpg.encrypt examples work (#56646)
.IP \(bu 2
Artifactory encoding of headers fixed for py3 (#56660)
.IP \(bu 2
Fixed handling of extents extended attribute in file.managed state. (#57189)
.IP \(bu 2
Remove buggy start parameter from virt.pool_running docstring (#57275)
.IP \(bu 2
Fixed saltcheck rendering of map.jinja files from saltenv (#57327)
.IP \(bu 2
Fix for \fIvirt.get_profiles\fP resolves an error that appears due to new parameters introduced with \fI_disk_profile()\fP (#57431)
.IP \(bu 2
Accept nested namespaces in spacewalk.api runner function. (#57442)
.IP \(bu 2
virt.init fix the disk target names (#57477)
.IP \(bu 2
Fix volume name for disk\-typed pools in virt.defined (#57497)
.IP \(bu 2
Fixes an issue with filesystems options ordering which kept already
applied NFS fstab entries being updated. (#57520)
.IP \(bu 2
Do not allow python2 to be added to salt\-ssh tar since Salt deprecated Python 2. (#57647)
.IP \(bu 2
Fixed exception on loading custom zipped modules. (#57674)
.IP \(bu 2
corrected support for app_id or local vault configurations (#57705)
.IP \(bu 2
Fix the registration of libvirt pool and nodedev events (#57746)
.IP \(bu 2
Pass cmd.run state arguments to unless and onlyif when they exist (#57760)
.IP \(bu 2
The 2004 release of Windows 10 introduced a bug in the InstallationBehavior COM
object where you can no longer get properties from that object. Calls to this
object are now wrapped in a try/except block with sane defaults when it fails to
read attributes.
.sp
Additionally, some pre\-flight checks have been added to the win_wua module to
make sure Windows Update can actually run. (#57762)
.IP \(bu 2
Changed get_repo in yumpkg.py to use \(dqrepo\(dq as first parameter.
This fixes #57778, a bug were every run of pkgrepo.managed state were
marked as changed because the get_repo did fail to detect a previously
applied run. (#57778)
.IP \(bu 2
Raise SaltClientError in parse_host_port insted of ValueError so it is caught and handled properly when the minion is connecting to the master. (#57789)
.IP \(bu 2
Fixed issue with the return dictionary from the workgroup() function in the
salt.states.win_system module. This resulted in a windows\-based minion logging
an error and could also interfere with a highstate being applied. (#57790)
.IP \(bu 2
Fixes broken block_device_mapping and block_device_mapping_v2 type checks in
the OpenStack cloud driver. Salt was looking for a dict and the shade library
was looking for a list of dicts. This made it impossible to use those params. (#57802)
.IP \(bu 2
Fixed incorrect parsing of \fBSet\-Cookie\fP response headers. (#57829)
.IP \(bu 2
When using yumpkg, report stdout when stderr is redirected to stdout. (#57862)
.IP \(bu 2
Fixes an issue on macOS where if you try and restart the macOS using serivce.restart salt\-minion it would fail because the service names are different on macOS. (#57878)
.IP \(bu 2
Fixes an issue on macOS where salt would take extra time to run on a service.dead call and the service is missing. (#57907)
.IP \(bu 2
Fixes an issue where a disabled macOS and Windows service would fail to start with service.running. (#57908)
.IP \(bu 2
Use \(dquse_bin_type\(dq to differentiate between bytes and str when writing cache
for pillar and grains. (#57918)
.IP \(bu 2
Set the comment to \(dqNo minions responded\(dq if salt.function fails to find any
minions (#57920)
.IP \(bu 2
Fix issue with \fI__utils__\fP usage in the \fI__virtual__\fP functions on a few of the
execution modules. (#57948)
.IP \(bu 2
remove encoding kwarg for both pack(b)/unpack(b) in msgpack for versions >=1.0.0
\fI\%https://github.com/msgpack/msgpack\-python/blob/master/ChangeLog.rst#100\fP (#57965)
.IP \(bu 2
Replace deprecated \fIcgi.escape()\fP with \fIhtml.escape()\fP after it was removed from Python 3.8. (#57983)
.IP \(bu 2
Fix btrfs state decorator, that produces exceptions when creating subvolumes. (#58012)
.IP \(bu 2
Fix kubeadm token_list when the list of tokens is empty (#58116)
.IP \(bu 2
Add a fix for the mac_service modules where it would fail to load in some new services and crash on Big Sur. (#58143)
.IP \(bu 2
Fix blank tplfile context parameter when loading top level sls files (#58249)
.IP \(bu 2
Do not include init directory in sls context parameters if explicitly specified (#58250)
.IP \(bu 2
Fixing pillar caching when pillar environments are involved. (#58274)
.IP \(bu 2
Make proxy_config read in the proxy specific configuration which is typically found in /etc/salt/proxy.d/minionid/. (#58307)
.IP \(bu 2
Add timeout kwarg docs for service.running and service.dead (#58311)
.IP \(bu 2
Return empty dict on win_pdh.get_counters rather than raising exception when no data are available (#58327)
.IP \(bu 2
Leave boot parameters untouched if boot parameter is set to None in virt.update (#58331)
.IP \(bu 2
Convert disks of volume type to file or block disks on Xen (#58333)
.IP \(bu 2
Apparently Apple is using both \(dq10.16\(dq and \(dq11\(dq for versioning Big Sur,
depending on where you look. The mac_softwareupdate module uses a different
regex depending on OS version, and the determination was based on the
osrelease_info grain. This results in a Big Sur machine not using the correct
regex; osrelease_info[1] is 0 for Big Sur.
.sp
This change simply adds an additional clause to the if statement to handle
osmajorrelease > 10. (#58340)
.IP \(bu 2
Fixed zmq salt\-call hang!
.sp
Some objects from the 3rd party module zmq fail to deconstruct if left to the GC when Python exits.
This is because the objects get destroyed out of order.
This only happens on some platforms like ubuntu 20.04 and some versions of FreeBSD.
We fixed this hang by deconstructing all zmq objects in the right order before we exit salt\-call. (#58364)
.IP \(bu 2
Reactor runner functions will now ensure reactor system is available before attempting to run and error out if it is not available. (#58384)
.IP \(bu 2
Fix enpoint typos (#58416)
.IP \(bu 2
Make sure we repopulate \fB__utils__\fP on Windows when a job is run from the scheduler. (#58437)
.IP \(bu 2
Adding a check when a source is an HTTP or FTP URL to do a query to ensure the URL is valid before returning, then we know if we need to move onto to the next source in the list or not. (#58441)
.IP \(bu 2
Improved documentation for the LGPO state module (#58521)
.IP \(bu 2
Remove old documented pending reboot key (#58530)
.IP \(bu 2
On macOS, skip GUI dialog for Developer Command Line Tools when importing gitfs util. (#58575)
.IP \(bu 2
Fixing a use case when multiple inotify beacons are defined but when notifications are fired the configuration from the first beacon are used. (#58655)
.UNINDENT
.SS Added
.INDENT 0.0
.IP \(bu 2
salt\-api will now work on Windows platforms with limited support. You will be
able to configure the \fBrest_cherrypy\fP module, without \fBpam\fP external
authentication and without ssl support.(#49949)
.IP \(bu 2
Added \fIexecution_timeout\fP support to \fIchocolatey.installed\fP state (#50449)
.IP \(bu 2
Add new verify_ssl option to file modules. This allows a user to not validate the server certificate for HTTPS source and source hash\(aqs. (#52663)
.IP \(bu 2
Added list target type support to the \fIscan\fP salt\-ssh roster. (#52675)
.IP \(bu 2
Added pvresize and lvextend to linux_lvm (#56089)
.IP \(bu 2
Added COPR option to states.pkgrepo (#57258)
.IP \(bu 2
Add \(dqget_return\(dq key for onlyif and unless requisites to parse deep module results (#57470)
.IP \(bu 2
Allow setting VM boot devices order in virt.running and virt.defined states (#57544)
.IP \(bu 2
Added grains to show the LVM Volume Groups and their Logical Volumes. (#57629)
.IP \(bu 2
Memory Tuning Support which allows much greater control of memory allocation (#57639)
.IP \(bu 2
Add output filter to saltcheck to only display test failures (#57788)
.IP \(bu 2
Added an execution module for running idem exec modules
.IP \(bu 2
Added a state module for running idem states (#57969)
.IP \(bu 2
Added the ability for states to return \fIsub_state_run\(aqs\fP results from external state engines (#57993)
.IP \(bu 2
Added salt\-cloud support for Linode APIv4 via the \fBapi_version\fP provider configuration parameter. (#58093)
.IP \(bu 2
Added support to manage services in Slackware Linux. (#58206)
.IP \(bu 2
Added list_sources to chocolatey module to have an overview of the repositories present on the minions.
Added source_added to chocolatey state in order to add repositories to chocolatey. (#58588)
.IP \(bu 2
Adding tests for changes to virtual function for netmiko module. Adding tests for netmiko proxy minion module. (#58609)
.IP \(bu 2
Added features config option for feature flags. Added a feature flag
\fIenable_slsvars_fixes\fP to enable fixes to tpldir, tplfile and sls_path.
This flag will be deprecated in the Phosphorus release when this functionality
becomes the default. (#58652)
.UNINDENT
.SS Salt 3002.1 Release Notes
.sp
Version 3002.1 is a CVE fix release for \fI\%3002\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Prevent shell injections in netapi ssh client (cve\-2020\-16846)
.IP \(bu 2
Prevent creating world readable private keys with the tls execution module. (cve\-2020\-17490)
.IP \(bu 2
Properly validate eauth credentials and tokens along with their ACLs.
Prior to this change eauth was not properly validated when calling
Salt ssh via the salt\-api. Any value for \(aqeauth\(aq or \(aqtoken\(aq would allow a user
to bypass authentication and make calls to Salt ssh. (CVE\-2020\-25592)
.UNINDENT
.SS Salt 3002.2 Release Notes
.sp
Version 3002.2 is a bugfix release for \fI\%3002\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Change dict check to isinstance instead of type() for key_values in file.keyvalue. (#57758)
.IP \(bu 2
Fail when func_ret is False when using the new module.run syntax. (#57768)
.IP \(bu 2
Fix comparison of certificate values (#58296)
.IP \(bu 2
When using ssh_pre_flight if there is a failure, fail on retcode not stderr. (#58439)
.IP \(bu 2
Fix use of unauthd cached vmware service instance (#58691)
.IP \(bu 2
Removing use of undefined varilable in utils/slack.py. (#58753)
.IP \(bu 2
Restored the ability to specify the amount of extents for a Logical
Volume as a percentage. (#58759)
.IP \(bu 2
Ensuring that the version check function is run a second time in all the user related functions in case the user being managed is the connection user and the password has been updated. (#58773)
.IP \(bu 2
Allow bytes in gpg renderer (#58794)
.IP \(bu 2
Fix issue where win_wua module fails to load when BITS is set to Manual (#58848)
.IP \(bu 2
Ensure that elasticsearch.index_exists is available before loading the elasticsearch returner. (#58851)
.IP \(bu 2
Log a different object when debugging if we\(aqre using disk cache vs memory cache. The disk cache pillar class has the dict object but the cache pillar object which is used with the memory cache does not include a _dict obeject because it is a dict already. (#58861)
.IP \(bu 2
Do not generate grains for every job run on Windows minions. This makes Windows
conform more to the way posix OSes work today. (#58904)
.IP \(bu 2
Fixes salt\-ssh authentication when using tty (#58922)
.IP \(bu 2
Revert LazyLoader finalizer. Removed the weakref.finalizer code. On some occasions, the finalized would run when trying to load a new module, firing a race condition. (#58947)
.UNINDENT
.SS Salt 3002.3 Release Notes
.sp
Version 3002.3 is a CVE fix release for \fI\%3002\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
CVE\-2020\-28243 \- Fix local privilege escalation in the restartcheck module.
.IP \(bu 2
CVE\-2020\-28972 \- Ensure authentication to vcenter, vsphere, and esxi server
validates the SSL/TLS certificate by default. If you want to skip SSL verification
you can use \fIverify_ssl: False\fP\&.
.IP \(bu 2
CVE\-2020\-35662 \- Ensure the asam runner, qingcloud, splunk returner, panos
proxy, cimc proxy, zenoss module, esxi module, vsphere module, glassfish
module, bigip module, and keystone module validate SSL by default. If you want
to skip SSL verification you can use \fIverify_ssl: False\fP\&.
.IP \(bu 2
CVE\-2021\-3148 \- Fix a command injection in the Salt\-API when using the
Salt\-SSH client.
.IP \(bu 2
CVE\-2021\-3144 \- Fix eauth tokens can be used once after expiration
.IP \(bu 2
CVE\-2021\-25281 \- Fix salt\-api so it honors eauth credentials for the
wheel_async client.
.IP \(bu 2
CVE\-2021\-25282 \- Fix the salt.wheel.pillar_roots.write method so it is not
vulnerable to directory traversal.
.IP \(bu 2
CVE\-2021\-25283 \- Fix the jinja render to protect against server side template
injection attacks.
.IP \(bu 2
CVE\-2021\-25284 \- Fix cmdmod so it will not log credentials to log levels info
and error.
.IP \(bu 2
CVE\-2021\-3197 \- Fix ssh client to remove ProxyCommand from arguments provided
by cli and netapi.
.UNINDENT
.SS Salt 3002.4 Release Notes
.sp
Version 3002.4 is a bug fix release for \fI\%3002\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fix runners that broke when patching for CVE\-2021\-25281
.IP \(bu 2
Fix issue with runners in SSE
.UNINDENT
.SS Known Issue
.sp
When using the Salt\-API with the SSH client some of the SSH options are not working currently and will be fixed in an upcoming bug fix release.
We are currently testing and fixing which options still need to be fixed, but have confirmed the following ones do not work in this release: extra\-filerefs, pre\-flight.
This does not impact normal Salt\-SSH usage on the cli.
.SS Salt 3002.5 Release Notes
.sp
Version 3002.5 is a cve fix release for \fI\%3002\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Tests and fix for CVE\-2021\-25283
.UNINDENT
.SS Known Issue
.sp
When using the Salt\-API with the SSH client some of the SSH options are not working currently and will be fixed in an upcoming bug fix release.
We are currently testing and fixing which options still need to be fixed, but have confirmed the following ones do not work in this release: extra\-filerefs, pre\-flight.
This does not impact normal Salt\-SSH usage on the cli.
.SS Salt 3002.6 Release Notes
.sp
Version 3002.6 is a bug fix release for \fI\%3002\fP\&.
.SS Changed
.INDENT 0.0
.IP \(bu 2
Store git sha in salt/_version.py when installing from a tag so it can be found if needed later. (#59137)
.UNINDENT
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fix argument injection bug in restartcheck.restartcheck. This change hardens
the fix for CVE\-2020\-28243. (#200)
.IP \(bu 2
Allow \(dqextra_filerefs\(dq as sanitized kwargs for SSH client.
Fix regression on \(dqcmd.run\(dq when passing tuples as cmd. (#59664)
.IP \(bu 2
Allow all ssh kwargs as sanitized kwargs for SSH client. (#59748)
.UNINDENT
.SS Salt 3002.7 (2021\-08\-20)
.sp
Version 3002.7 is a CVE security fix release for \fI\%3002\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Verify the owner of an existing config before trusting it during install. If the owner cannot be verified, back it up and use defaults. (CVE\-2021\-22004)
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
Fix the CVE\-2021\-31607 vulnerability
Additionally, an audit and a tool was put in place, \fBbandit\fP, to address similar issues througout the code base, and prevent them. (CVE\-2021\-31607)
.IP \(bu 2
Ensure that sourced file is cached using its hash name (cve\-2021\-21996)
.UNINDENT
.SS Salt 3002.8 (2022\-02\-25)
.sp
Version 3002.8 is a CVE security fix release for \fI\%3002\fP\&.
.SS Important notice about upgrading
.sp
Version 3002.8 is a security release. 3002.8 minions are not able to
communicate with masters older than 3002.8. You must upgrade your masters
before upgrading minions.
.SS Minion authentication security
.sp
Authentication between masters and minions rely on public/private key
encryption and message signing. To secure minion authentication before you must
pre\-seed the master\(aqs public key on minions. To pre\-seed the minions\(aq master
key, place a copy of the master\(aqs public key in the minion\(aqs pki directory as
\fBminion_master.pub\fP\&.
.SS Security
.INDENT 0.0
.IP \(bu 2
Sign authentication replies to prevent MiTM (cve\-2020\-22935)
.IP \(bu 2
Sign pillar data to prevent MiTM attacks. (cve\-2022\-22934)
.IP \(bu 2
Prevent job and fileserver replays (cve\-2022\-22936)
.IP \(bu 2
Fixed targeting bug, especially visible when using syndic and user auth. (CVE\-2022\-22941) (#60413)
.UNINDENT
.SS Salt 3002.9 (2022\-05\-25)
.sp
Version 3002.9 is a CVE security fix release for \fI\%3002\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fixed an error when running on CentOS Stream 8. (#59161)
.IP \(bu 2
Fix bug in tcp transport (#61865)
.IP \(bu 2
Make sure the correct key is being used when verifying or validating communication, eg. when a Salt syndic is involved use syndic_master.pub and when a Salt minion is involved use minion_master.pub. (#61868)
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
Fixed PAM auth to reject auth attempt if user account is locked. (cve\-2022\-22967)
.UNINDENT
.SS Salt 3001 Release Notes \- Codename Sodium
.SS Python 2 Dropped
.sp
Python 2 support has been dropped in Salt 3001. See
\fI\%https://community.saltstack.com/blog/sunsetting\-python\-2\-support/\fP for more
info.
.SS Salt mine updates
.SS Syntax update
.sp
The syntax for defining salt functions in config or pillar files has changed to
also support the syntax used in \fI\%module.run\fP\&.
The old syntax for the mine_function \- as a dict, or as a list with dicts that
contain more than exactly one key \- is still supported but discouraged in favor
of the more uniform syntax of module.run.
.SS State updates
.sp
The \fBcreates\fP state requisite has been migrated from the
\fI\%docker_container\fP and \fI\%cmd\fP
states to become a global option. This acts similar to an equivalent
\fBunless: test \-f filename\fP but can also accept a list of filenames. This allows
all states to take advantage of the enhanced functionality released in Neon, of allowing
salt execution modules for requisite checks.
.sp
When using salt functions \fBonlyif\fP or \fBunless\fP requisites, a \fBget_return\fP key can
now be used to specify a key to evaluate for truthiness. This can be used for execution modules
which return status in a nested key.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
test:
  test.nop:
    \- name: foo
    \- onlyif:
      \- fun: consul.get
        consul_url: http://127.0.0.1:8500
        key:  not\-existing
        get_return: res
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS State Execution Module
.sp
The \fI\%state.test\fP function
can be used to test a state on a minion. This works by executing the
\fBstate.apply\fP function while forcing the \fBtest\fP kwarg
to \fBTrue\fP so that the \fBstate.apply\fP function is not required to be called by the
user directly. This also allows you to add the \fBstate.test\fP function to a minion\(aqs
\fBminion_blackout_whitelist\fP pillar if you wish to be able to test a state while a
minion is in blackout.
.SS New Grains
.SS systempath
.sp
This grain provides the same information as the \fBpath\fP grain, only formatted
as a list of directories.
.SS Salt\-SSH updates
.SS ssh_pre_flight
.sp
A new Salt\-SSH roster option \fBssh_pre_flight\fP has been added. This enables you to run a
script before Salt\-SSH tries to run any commands. You can set this option in the roster
for a specific minion or use the \fBroster_defaults\fP to set it for all minions.
.sp
Example for setting \fBssh_pre_flight\fP for specific host in roster file
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minion1:
  host: localhost
  user: root
  passwd: P@ssword
  ssh_pre_flight: /srv/salt/pre_flight.sh
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example for setting \fBssh_pre_flight\fP using roster_defaults, so all minions
run this script.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
roster_defaults:
  ssh_pre_flight: /srv/salt/pre_flight.sh
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBssh_pre_flight\fP script will only run if the thin dir is not currently on the
minion. If you want to force the script to run you have the following options:
.INDENT 0.0
.IP \(bu 2
Wipe the thin dir on the targeted minion using the \-w arg.
.IP \(bu 2
Set ssh_run_pre_flight to True in the config.
.IP \(bu 2
Run salt\-ssh with the \-\-pre\-flight arg.
.UNINDENT
.SS set_path
.sp
A new salt\-ssh roster option \fIset_path\fP has been added. This allows you to set
the path environment variable used to run the salt\-ssh command on the target minion.
You can set this setting in your roster file like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
minion1:
  host: localhost
  user: root
  passwd: P@ssword
  set_path: \(aq$PATH:/usr/local/bin/\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS auto_detect
.sp
You can now auto detect the dependencies to be packed into the salt thin when using
the \fBssh_ext_alternatives\fP feature.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_ext_alternatives:
    2019.2:                     # Namespace, can be anything.
        py\-version: [2, 7]      # Constraint to specific interpreter version
        path: /opt/2019.2/salt  # Main Salt installation directory.
        auto_detect: True       # Auto detect dependencies
        py_bin: /usr/bin/python2.7 # Python binary path used to auto detect dependencies
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This new \fBauto_detect\fP option needs to be set to True in your \fBssh_ext_alternatives\fP configuration.
Salt\-ssh will attempt to auto detect the file paths required for the default dependencies to include
in the thin. If you have a dependency already set in your configuration, it will not attempt to auto
detect for that dependency.
.sp
You can also set the \fBpy_bin\fP option to set the python binary to be used to auto detect the
dependencies. If \fBpy_bin\fP is not set, it will attempt to use the major Python version set in
\fBpy\-version\fP\&. For example, if you set \fBpy\-version\fP to be \fB[2, 7]\fP it will attempt to find and
use the \fBpython2\fP binary.
.SS State Changes
.INDENT 0.0
.IP \(bu 2
Adding a new option for the State compiler, \fBdisabled_requisites\fP will allow
requisites to be disabled during State runs.
.UNINDENT
.SS Salt Renderer updates
.sp
A new renderer for toml files has been added.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!jinja|toml

{% set myvar = \(dqsometext\(dq %}

[[\(dqsome id\(dq.\(dqtest.nop\(dq]]
name = \(dq{{ myvar }}\(dq
[[\(dqsome id\(dq.\(dqtest.nop\(dq]]
txt = \(dqhello\(dq
[[\(dqsome id\(dq.\(dqtest.nop\(dq]]
\(dqsomekey\(dq = \(dqsomevalue\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Execution Module updates
.SS Vault Module
.sp
The \fI\%vault module\fP has been updated with the ability
to cache generated tokens. By specifying \fBuses\fP and optionally \fBttl\fP, the token generated on
behalf of the minion will be allowed to persist and function for the defined time period
or number of uses. Setting \fBuses: 0\fP creates an unlimited use token, that is only constrained by
the \fBttl\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vault:
  auth:
    uses: 25
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This functionality is configured by default on the master and is thus shared behavior for all minion token generation.
To delegate use count to individual minions, specify \fBallow_minion_override: True\fP in the master config, and define
\fBuses\fP and \fBttl\fP in the minion config as directed above.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vault:
auth:
  method: token
  allow_minion_override: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Additionally, the vault module now supports Vault secrets backend version 2. The approperate secrets backend will be
automatically detected, and cached in the same credentials file as long lived vault tokens mentioned above. For any
configurations that worked around KV v2 handling by adding a manual data key to the end of vault lookups,
\fBsalt[\(aqvault\(aq].read_secret(\(aqsecret/my/secret\(aq)[\(aqdata\(aq]\fP, these are automatically detected and will continue to
function, but will generate a debug log message and can be removed.
.sp
The long lived token and secret metadata cache file can be cleared with the new \fBvault.clear_token_cache\fP
execution function.
.SS Salt 3001.1 Release Notes
.sp
Version 3001.1 is a bugfix release for \fI\%3001\fP\&.
.SS Changed
.INDENT 0.0
.IP \(bu 2
Change the \fBenable_fqdns_grains\fP setting to default to \fBFalse\fP on Windows
to address some issues with slowness. (#56296, #57529)
.IP \(bu 2
Handle the UCRT libraries the same way they are handled in the Python 3
installer (#57594)
.IP \(bu 2
Changes the \(aqSSDs\(aq grain name to \(aqssds\(aq as all grains needs to be
resolved in lowered case. (#57612)
.UNINDENT
.SS Fixed
.INDENT 0.0
.IP \(bu 2
When running scheduled jobs from a proxy minion with multiprocessing turned off (default) a recursive error occurs as __pub_fun_args is repeated over and over again in the kwargs element in the data dictionary.  Now we make a copy of data[\(aqkwargs\(aq] instead of using a reference. (#57941)
.IP \(bu 2
The \fIx509.certificate_managed\fP state no longer triggers a change because of sorting issues if the certificate being evaluated was previously generated under Python 2. (#56556)
.IP \(bu 2
Added support to lo ip alias in network.managed state by checking if lo inet data
from network.interfaces contains label with the name of managed interface.
Return status True if match found. (#56901)
.IP \(bu 2
Redact passwords in the return when setting credentials using
\fBwin_iis.container_setting\fP (#57285)
.IP \(bu 2
Fixes issue with cmd.powershell. Some powershell commands do not return
anything in stdout. This causes the JSON parser to fail because an empty string
is not valid JSON. This changes an empty string to \fI{}\fP which is valid JSON and
will not cause the JSON loader to stacktrace. (#57493)
.IP \(bu 2
Improves performance. Profiling \fItest.ping\fP on Windows shows that 13 of 17
seconds are wasted when the esxi grain loads vsphere before noting that
the OS is not a esxi host. (#57529)
.IP \(bu 2
Fixed permissions issue with certain pip/virtualenv states/modules when configured for non\-root user. (#57550)
.IP \(bu 2
Allow running nox sessions either using our \fI\%nox\-py2 fork\fP or upstream \fI\%nox\fP\&. (#57583)
.IP \(bu 2
Fixes issue with lgpo.get when there are unicode characters in the hostname (#57591)
.IP \(bu 2
Fixes issue with virtual block devices, like loopbacks and LVMs, wrongly
populating the \(dqdisks\(dq or \(dqssds\(dq grains. (#57612)
.IP \(bu 2
Due to some optimization the \fIvirtual\fP grain was never updated on illumos. Move the fallback in prtdiag output parsing outside the loop that now gets skipped due to the command exiting non\-zero. (#57714)
.IP \(bu 2
Grains module delkey and delval methods now support the force option. This is
needed for deleting grains with complex (nested) values. (#57718)
.IP \(bu 2
Moving import salt.modules.vsphere into \fI__virtual__\fP so we have access to test proxytype in opts,
previously this was causing a traceback when run on proxy minion as \fI__opts__\fP does not exist
outside of any functions. Introducing a new utils function, is_proxytype, to check that the
device is a proxy minion and also that the proxy type matches. (#57743)
.IP \(bu 2
Fixed fail_with_changes in the test state to use the comment argument when passed. (#57766)
.IP \(bu 2
Adds a fix so salt can run on the latest macOS version Big Sur. (#57787)
.IP \(bu 2
Fixes UnpackValueError when using GPG cache by using atomic open. (#57798)
.IP \(bu 2
The \fBgid_from_name\fP argument was removed from the \fBuser.present\fP state in
version 3001, with no deprecation path. It has been restored and put on a
proper deprecation path. (#57843)
.IP \(bu 2
Fixes dictionary being changed during iteration. (#57845)
.UNINDENT
.SS Added
.INDENT 0.0
.IP \(bu 2
Added docs demonstrating how to apply an MSI patch with winrepo (#32780)
.UNINDENT
.SS Salt 3001.2 Release Notes
.sp
Version 3001.2 is a CVE fix release for \fI\%3001\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Prevent shell injections in netapi ssh client (cve\-2020\-16846)
.IP \(bu 2
Prevent creating world readable private keys with the tls execution module. (cve\-2020\-17490)
.UNINDENT
.SS Salt 3001.3 Release Notes
.sp
Version 3001.3 is a CVE fix release for \fI\%3001\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Properly validate eauth credentials and tokens along with their ACLs.
Prior to this change eauth was not properly validated when calling
Salt ssh via the salt\-api. Any value for \(aqeauth\(aq or \(aqtoken\(aq would allow a user
to bypass authentication and make calls to Salt ssh. (CVE\-2020\-25592)
.UNINDENT
.SS Salt 3001.4 Release Notes
.sp
Version 3001.4 is a bugfix release for \fI\%3001\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fixes salt\-ssh authentication when using tty (#58922)
.UNINDENT
.SS Salt 3001.5 Release Notes
.sp
Version 3001.5 is a CVE fix release for \fI\%3001\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
CVE\-2020\-28243 \- Fix local privilege escalation in the restartcheck module.
.IP \(bu 2
CVE\-2020\-28972 \- Ensure authentication to vcenter, vsphere, and esxi server
validates the SSL/TLS certificate by default. If you want to skip SSL verification
you can use \fIverify_ssl: False\fP\&.
.IP \(bu 2
CVE\-2020\-35662 \- Ensure the asam runner, qingcloud, splunk returner, panos
proxy, cimc proxy, zenoss module, esxi module, vsphere module, glassfish
module, bigip module, and keystone module validate SSL by default. If you want
to skip SSL verification you can use \fIverify_ssl: False\fP\&.
.IP \(bu 2
CVE\-2021\-3148 \- Fix a command injection in the Salt\-API when using the
Salt\-SSH client.
.IP \(bu 2
CVE\-2021\-3144 \- Fix eauth tokens can be used once after expiration
.IP \(bu 2
CVE\-2021\-25281 \- Fix salt\-api so it honors eauth credentials for the
wheel_async client.
.IP \(bu 2
CVE\-2021\-25282 \- Fix the salt.wheel.pillar_roots.write method so it is not
vulnerable to directory traversal.
.IP \(bu 2
CVE\-2021\-25283 \- Fix the jinja render to protect against server side template
injection attacks.
.IP \(bu 2
CVE\-2021\-25284 \- Fix cmdmod so it will not log credentials to log levels info
and error.
.IP \(bu 2
CVE\-2021\-3197 \- Fix ssh client to remove ProxyCommand from arguments provided
by cli and netapi.
.UNINDENT
.SS Salt 3001.6 Release Notes
.sp
Version 3001.6 is a bug fix release for \fI\%3001\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fix runners that broke when patching for CVE\-2021\-25281
.IP \(bu 2
Fix issue with runners in SSE
.UNINDENT
.SS Known Issue
.sp
When using the Salt\-API with the SSH client some of the SSH options are not working currently and will be fixed in an upcoming bug fix release.
We are currently testing and fixing which options still need to be fixed, but have confirmed the following ones do not work in this release: extra\-filerefs, pre\-flight.
This does not impact normal Salt\-SSH usage on the cli.
.SS Salt 3001.7 Release Notes
.sp
Version 3001.7 is a bug fix release for \fI\%3001\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Allow \(dqextra_filerefs\(dq as sanitized kwargs for SSH client.
Fix regression on \(dqcmd.run\(dq when passing tuples as cmd. (#59664)
.IP \(bu 2
Allow all ssh kwargs as sanitized kwargs for SSH client. (#59748)
.IP \(bu 2
Fix argument injection bug in restartcheck.restartcheck. This change hardens
the fix for CVE\-2020\-28243.
.UNINDENT
.SS Salt 3001.8 (2021\-08\-20)
.sp
Version 3001.8 is a CVE security fix release for \fI\%3001\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Verify the owner of an existing config before trusting it during install. If the owner cannot be verified, back it up and use defaults. (CVE\-2021\-22004)
.UNINDENT
.SS Security
.INDENT 0.0
.IP \(bu 2
Fix the CVE\-2021\-31607 vulnerability
Additionally, an audit and a tool was put in place, \fBbandit\fP, to address similar issues througout the code base, and prevent them. (CVE\-2021\-31607)
.IP \(bu 2
Ensure that sourced file is cached using its hash name (cve\-2021\-21996)
.UNINDENT
.SS Salt 3000 Release Notes \- Codename Neon
.SS Security Advisory
.sp
For historical reasons, Salt requires PyCrypto as a \(dqlowest common
denominator\(dq. However, \fI\%PyCrypto is unmaintained\fP and best practice is to
manually upgrade to use a more maintained library such as \fI\%PyCryptodome\fP\&. See
\fI\%Issue #52674\fP and \fI\%Issue #54115\fP for more info
.SS New Versioning
.sp
The neon release has removed the date versioning. Going forward we will
use a non\-date based version schema beginning at 3000. The version will
be MAJOR.PATCH. For a planned release containing features and/or bug fixes
the MAJOR version will be incremented. Please review the approved
\fI\%SEP\fP
for further details.
.sp
The new versioning scheme is PEP 440 compliant, but distutils.StrictVersion
will result in an error \fBinvalid version number\fP\&. If using StrictVersion to
compare Salt\(aqs versions, please use LooseVersion. There is also the packaging
library you can use to compare versions. Another alternative is using the
\fI\%salt version module\fP
.SS Python 3.8 Not Supported
.sp
Please note that running Salt with Python 3.8 is currently not supported.
It is recommended to not use a version higher than 3.7.
.SS Vendored Tornado Code Base
.sp
The Tornado code base has been included as \fBsalt.ext.tornado\fP\&. This was done
to provide a consistent version of Tornado across all operating systems while
we continue to work on upgrading Tornado to a recent version. New code that
uses Tornado should import the module from \fBsalt.ext.tornado\fP instead of
importing the system version of Tornado.
.SS Msgpack 1.0.0rc1 Incompatibility
.sp
Salt is currently incompatible with msgpack 1.0.0rc1. We recommend using
versions < 1.0.0 . This impacts the Salt Master\(aqs ability to run commands
against minions. Please see \fI\%Issue 56007\fP
for more details and updates.
.SS Pip Installing Salt On Windows
.sp
This release will not install correctly on windows when using pip to install salt.
This issue is addressed in \fI\%PR 56099\fP\&.
The workaround for this issue is:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install \(dqpywin32==224\(dq \(dqWMI==1.4.9\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Those using the Salt Windows Installer are not affected by this issue.
.SS Saltcheck Updates
.sp
Available since 2018.3, the \fI\%saltcheck module\fP
has been enhanced to:
.INDENT 0.0
.IP \(bu 2
Support saltenv environments
.IP \(bu 2
Associate tests with states by naming convention
.IP \(bu 2
Adds report_highstate_tests function
.IP \(bu 2
Adds empty and notempty assertions
.IP \(bu 2
Adds skip keyword
.IP \(bu 2
Adds print_result keyword
.IP \(bu 2
Adds assertion_section keyword
.IP \(bu 2
Use saltcheck.state_apply to run state.apply for test setup or teardown
.IP \(bu 2
Changes output to display test time
.IP \(bu 2
Works with salt\-ssh
.UNINDENT
.sp
Saltcheck provides unittest like functionality requiring only the knowledge of
salt module execution and yaml. Saltcheck uses salt modules to return data, then
runs an assertion against that return. This allows for testing with all the
features included in salt modules.
.sp
In order to run state and highstate saltcheck tests, a sub\-folder in the state directory
must be created and named \fBsaltcheck\-tests\fP\&. Tests for a state should be created in files
ending in \fB*.tst\fP and placed in the \fBsaltcheck\-tests\fP folder. \fBtst\fP files are run
through the salt rendering system, enabling tests to be written in yaml (or renderer of choice),
and include jinja, as well as the usual grain and pillar information. Like states, multiple tests can
be specified in a \fBtst\fP file. Multiple \fBtst\fP files can be created in the \fBsaltcheck\-tests\fP
folder, and should be named the same as the associated state. The \fBid\fP of a test works in the
same manner as in salt state files and should be unique and descriptive.
.SS Usage
.sp
Example file system layout:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/srv/salt/apache/
    init.sls
    config.sls
    saltcheck\-tests/
        init.tst
        config.tst
        deployment_validation.tst
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Tests can be run for each state by name, for all \fBapache/saltcheck/*.tst\fP files,
or for all states assigned to the minion in top.sls. Tests may also be created
with no associated state. These tests will be run through the use of
\fBsaltcheck.run_state_tests\fP, but will not be automatically run by
\fBsaltcheck.run_highstate_tests\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltcheck.run_state_tests apache,apache.config
salt \(aq*\(aq saltcheck.run_state_tests apache check_all=True
salt \(aq*\(aq saltcheck.run_highstate_tests
salt \(aq*\(aq saltcheck.run_state_tests apache.deployment_validation
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Example Tests
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{# will run the common salt state before further testing #}
setup_test_environment:
  module_and_function: saltcheck.state_apply
  args:
    \- common
  pillar\-data:
    data: value

{% for package in [\(dqapache2\(dq, \(dqopenssh\(dq] %}
{# or another example #}
{# for package in salt[\(aqpillar.get\(aq](\(dqpackages\(dq) #}
jinja_test_{{ package }}_latest:
  module_and_function: pkg.upgrade_available
  args:
    \- {{ package }}
  assertion: assertFalse
{% endfor %}

validate_user_present_and_shell:
  module_and_function: user.info
  args:
    \- root
  assertion: assertEqual
  expected\-return: /bin/bash
  assertion_section: shell
  print_result: False

skip_test:
  module_and_function: pkg.upgrade_available
  args:
    \- apache2
  assertion: assertFalse
  skip: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Output Format Changes
.sp
Saltcheck output has been enhanced to display the time taken per test. This results
in a change to the output format.
.sp
Previous Output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
local:
  |_
    \-\-\-\-\-\-\-\-\-\-
    ntp:
        \-\-\-\-\-\-\-\-\-\-
        ntp\-client\-installed:
            Pass
        ntp\-service\-status:
            Pass
  |_
    \-\-\-\-\-\-\-\-\-\-
    TEST RESULTS:
        \-\-\-\-\-\-\-\-\-\-
        Failed:
            0
        Missing Tests:
            0
        Passed:
            2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
local:
  |_
    \-\-\-\-\-\-\-\-\-\-
    ntp:
        \-\-\-\-\-\-\-\-\-\-
        ntp\-client\-installed:
            \-\-\-\-\-\-\-\-\-\-
            duration:
                1.0408
            status:
                Pass
        ntp\-service\-status:
            \-\-\-\-\-\-\-\-\-\-
            duration:
                1.464
            status:
                Pass
  |_
    \-\-\-\-\-\-\-\-\-\-
    TEST RESULTS:
        \-\-\-\-\-\-\-\-\-\-
        Execution Time:
            2.5048
        Failed:
            0
        Missing Tests:
            0
        Passed:
            2
        Skipped:
            0
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Unless and onlyif Enhancements
.sp
The \fBunless\fP and \fBonlyif\fP requisites can now be operated with salt modules.
The dictionary must contain an argument \fBfun\fP which is the module that is
being run, and everything else must be passed in under the args key or will be
passed as individual kwargs to the module function.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Certain states have an \fBunless\fP/\fBonlyif\fP implementation that predates this feature, and may not work as expected:
.INDENT 0.0
.IP \(bu 2
states.git
.IP \(bu 2
states.cmd
.IP \(bu 2
states.macpackage
.IP \(bu 2
states.file
.IP \(bu 2
states.docker_container
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
check external ip address:
  http.query:
    \- name: https://icanhazip.com
    \- status: 200
    \- onlyif:
      \- fun: file.file_exists
        path: /usr/local/bin/whatever
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
is equivalent to
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
check another ip address:
  http.query:
    \- name: https://icanhazip.com
    \- status: 200
    \- onlyif:
      \- test \-f /tmp/fnord.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Another example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set mysql root password:
  debconf.set:
    \- name: mysql\-server\-5.7
    \- data:
        \(aqmysql\-server/root_password\(aq: {\(aqtype\(aq: \(aqpassword\(aq, \(aqvalue\(aq: {{pillar[\(aqmysql.pass\(aq]}} }
    \- unless:
      \- fun: pkg.version
        args:
          \- mysql\-server\-5.7
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Keystore State and Module
.sp
A new \fI\%state\fP and
\fI\%execution module\fP for manaing Java
Keystore files is now included. It allows for adding/removing/listing
as well as managing keystore files.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call keystore.list /path/to/keystore.jks changeit
local:
  |_
    \-\-\-\-\-\-\-\-\-\-
    alias:
        hostname1
    expired:
        True
    sha1:
        CB:5E:DE:50:57:99:51:87:8E:2E:67:13:C5:3B:E9:38:EB:23:7E:40
    type:
        TrustedCertEntry
    valid_start:
        August 22 2012
    valid_until:
        August 21 2017
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
define_keystore:
  keystore.managed:
    \- name: /tmp/statestore.jks
    \- passphrase: changeit
    \- force_remove: True
    \- entries:
      \- alias: hostname1
        certificate: /tmp/testcert.crt
      \- alias: remotehost
        certificate: /tmp/512.cert
        private_key: /tmp/512.key
      \- alias: stringhost
        certificate: |
          \-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-
          MIICEjCCAX
          Hn+GmxZA
          \-\-\-\-\-END CERTIFICATE\-\-\-\-\-
.ft P
.fi
.UNINDENT
.UNINDENT
.SS XML Module
.sp
A new state and execution module for editing XML files is now included. Currently it allows for
editing values from an xpath query, or editing XML IDs.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call xml.set_attribute /tmp/test.xml \(dq.//actor[@id=\(aq3\(aq]\(dq editedby \(dqJane Doe\(dq
local:
    True
# salt\-call xml.get_attribute /tmp/test.xml \(dq.//actor[@id=\(aq3\(aq]\(dq
local:
    \-\-\-\-\-\-\-\-\-\-
    editedby:
        Jane Doe
    id:
        3
# salt\-call xml.get_value /tmp/test.xml \(dq.//actor[@id=\(aq2\(aq]\(dq
local:
    Liam Neeson
# salt\-call xml.set_value /tmp/test.xml \(dq.//actor[@id=\(aq2\(aq]\(dq \(dqPatrick Stewart\(dq
local:
    True
# salt\-call xml.get_value /tmp/test.xml \(dq.//actor[@id=\(aq2\(aq]\(dq
local:
    Patrick Stewart
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ensure_value_true:
  xml.value_present:
    \- name: /tmp/test.xml
    \- xpath: .//actor[@id=\(aq1\(aq]
    \- value: William Shatner
.ft P
.fi
.UNINDENT
.UNINDENT
.SS LGPO Execution Module
.sp
Multiple fixes were made to the \fI\%win_lgpo\fP to
expand support for additional policies and improve performance. Issues with
encoding and unsupported characters (smart\-quotes, em\-dash, etc) found in the
ADML files as well as whitespace in some policies have been addressed.
.sp
Speed enhancements include:
.INDENT 0.0
.IP \(bu 2
Caching the compiled xml from ADMX/ADML files in \fB__context__\fP
.IP \(bu 2
Lowercasing all keys before compiling XML to remove an expensive XPath lookup
.UNINDENT
.sp
Additional functionality:
.INDENT 0.0
.IP \(bu 2
Adds the \fI\%lgpo.get_policy\fP
function that allows you to get the current settings for a single policy.
.IP \(bu 2
Changes some policy names that were overly long
.UNINDENT
.SS LGPO State Module
.sp
Multiple changes were made to the \fI\%win_lgpo\fP
state to improve performance.
.sp
It now uses the \fI\%lgpo.get_policy\fP
function instead of the \fI\%lgpo.get\fP to avoid
reloading all settings on the machine at the beginning and end of each state
run.
.sp
Supports the new shorter policy names but also attempts to resolve the older,
longer policy names.
.SS Win_network Salt Util
.sp
Now uses .NET libraries to obtain Interface information on Windows systems that
support it. Unsupported systems fall back to the more expensive WMI calls. This
is important as this data is gathered for grains and occurs each time a process
is forked.
.SS Jinja enhancements
.SS Troubleshooting Jinja map files
.sp
A new \fI\%execution module\fP for \fBmap.jinja\fP troubleshooting
has been added.
.sp
Assuming the map is loaded in your formula SLS as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% from \(dqmyformula/map.jinja\(dq import myformula with context %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following command can be used to load the map and check the results:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion jinja.load_map myformula/map.jinja myformula
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The module can be also used to test \fBjson\fP and \fByaml\fP maps:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion jinja.import_yaml myformula/defaults.yaml

salt myminion jinja.import_json myformula/defaults.json
.ft P
.fi
.UNINDENT
.UNINDENT
.SS json_query filter
.sp
A port of Ansible \fI\%json_query\fP Jinja filter has been added. It allows
making queries against JSON data using \fI\%JMESPath language\fP\&. Could be used to
filter \fBpillar\fP data, \fByaml\fP maps, and also useful with \fI\%http_query\fP\&.
.sp
Depends on the \fI\%jmespath\fP Python module.
.SS Slot Syntax Updates
.sp
The slot syntax has been updated to support parsing dictionary responses and to append text.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
demo dict parsing and append:
  test.configurable_test_state:
    \- name: slot example
    \- changes: False
    \- comment: __slot__:salt:test.arg(shell=\(dq/bin/bash\(dq).kwargs.shell ~ /appended
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
local:
  \-\-\-\-\-\-\-\-\-\-
        ID: demo dict parsing and append
  Function: test.configurable_test_state
      Name: slot example
    Result: True
   Comment: /bin/bash/appended
   Started: 09:59:58.623575
  Duration: 1.229 ms
   Changes:
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Also, slot parsing is now supported inside of nested state data structures (dicts, lists, unless/onlyif args):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
demo slot parsing for nested elements:
  file.managed:
    \- name: /tmp/slot.txt
    \- source: salt://slot.j2
    \- template: jinja
    \- context:
        # Slot inside of the nested context dictionary
        variable: __slot__:salt:test.echo(a_value)
    \- unless:
      \- fun: file.search
        args:
          # Slot as unless argument
          \- __slot__:salt:test.echo(/tmp/slot.txt)
          \- \(dqDO NOT OVERRIDE\(dq
        ignore_if_missing: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS State Changes
.INDENT 0.0
.IP \(bu 2
The \fI\%file.symlink\fP state was
fixed to remove existing file system entries other than files,
directories and symbolic links properly.
.IP \(bu 2
The \fBonchanges\fP and \fBprereq\fP \fI\%requisites\fP now behave
properly in test mode, due to removing \fBpchanges\fP\&.
.IP \(bu 2
Added new \fI\%ssh_auth.manage\fP state to
ensure only the specified ssh keys are present for the specified user.
.IP \(bu 2
Added new \fI\%saltutil\fP state to use instead of
\fBmodule.run\fP to more easily handle change.
.UNINDENT
.SS Module Changes
.INDENT 0.0
.IP \(bu 2
Added new \fI\%boto_ssm\fP module to set and query
secrets in AWS SSM parameters.
.IP \(bu 2
Added new \fBflatpak\fP module to work with flatpak packages.
.IP \(bu 2
The \fI\%file.remove\fP module was
fixed to remove file system entries other than files, directories
and symbolic links properly.
.IP \(bu 2
The \fI\%debian_ip\fP module used by the
\fI\%network.managed\fP state has been
heavily refactored. The order that options appear in inet/inet6 blocks may
produce cosmetic changes. Many options without an \(aqipvX\(aq prefix will now be
shared between inet and inet6 blocks. The options \fBenable_ipv4\fP and
\fBenabled_ipv6\fP will now fully remove relevant inet/inet6 blocks. Overriding
options by prefixing them with \(aqipvX\(aq will now work with most options (i.e.
\fBdns\fP can be overridden by \fBipv4dns\fP or \fBipv6dns\fP). The \fBproto\fP option
is now required.
.UNINDENT
.SS Enhancements to Engines
.sp
Multiple copies of a particular Salt engine can be configured by including
the \fBengine_module\fP parameter in the engine configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- production_logstash:
      host: production_log.my_network.com
      port: 5959
      proto: tcp
      engine_module: logstash
  \- develop_logstash:
      host: develop_log.my_network.com
      port: 5959
      proto: tcp
      engine_module: logstash
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
A new \fBfluent engine\fP has been
added to export Salt events to fluentd.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
engines:
  \- fluent
      host: localhost
      port: 24224
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
<source>
  @type forward
  port 24224
</source>
<match saltstack.**>
  @type file
  path /var/log/td\-agent/saltstack
</match>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Enhancements to Beacons
.sp
Multiple copies of a particular Salt beacon can be configured by including
the \fBbeacon_module\fP parameter in the beacon configuration.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  watch_importand_file:
    \- files:
        /etc/important_file: {}
    \- beacon_module: inotify
  watch_another_file:
    \- files:
        /etc/another_file: {}
    \- beacon_module: inotify
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Enhancements to chroot
.INDENT 0.0
.IP \(bu 2
New functions added to chroot \fI\%apply\fP,
\fI\%sls\fP, and
\fI\%highstate\fP that allow executing
states in sls files or running apply/highstate inside of a chroot.
.UNINDENT
.SS Minion\-side ACL
.sp
Salt has had master\-side ACL for the salt mine for some time, where the master
configuration contained \fImine_get\fP that specified which minions could request
which functions. However, now you can specify which minions can access a function
in the salt mine function definition itself (or when calling \fI\%mine.send\fP).
This targeting works the same as the generic minion targeting as specified
\fI\%here\fP\&. The parameters used are \fBallow_tgt\fP and \fBallow_tgt_type\fP\&.
See also \fI\%the documentation of the Salt Mine\fP\&. Please
note that if you want to use this new feature both your minion and masters will need
to be on atleast version 3000.
.SS Deprecations
.SS Raet Deprecated
.INDENT 0.0
.IP \(bu 2
The Raet transport has been deprecated. Please use the supported
transport protocols tcp or zeromq.
.UNINDENT
.SS Module Deprecations
.INDENT 0.0
.IP \(bu 2
The hipchat module has been removed due to the service being retired.
\fI\%Google Chat\fP,
\fI\%MS Teams\fP, or
\fI\%Slack\fP may be suitable replacements.
.IP \(bu 2
The \fI\%dockermod\fP module has been
changed as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Support for the \fBtags\fP kwarg has been removed from the
\fI\%dockermod.resolve_tag\fP
function.
.IP \(bu 2
Support for the \fBnetwork_id\fP kwarg has been removed from the
\fI\%dockermod.connect_container_to_network\fP
function. Please use \fBnet_id\fP instead.
.IP \(bu 2
Support for the \fBname\fP kwarg has been removed from the
\fI\%dockermod.sls_build\fP
function. Please use \fBrepository\fP and \fBtag\fP instead.
.IP \(bu 2
Support for the \fBimage\fP kwarg has been removed from the following
functions. In all cases, please use both the \fBrepository\fP and \fBtag\fP
options instead:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fI\%dockermod.build\fP
.IP \(bu 2
\fI\%dockermod.commit\fP
.IP \(bu 2
\fI\%dockermod.import\fP
.IP \(bu 2
\fI\%dockermod.load\fP
.IP \(bu 2
\fI\%dockermod.tag\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
The heat module has removed the \fBenviroment\fP kwarg from the
\fI\%heat.create_stack\fP and
\fI\%heat.update_stack\fP functions due
to a spelling error. Please use \fBenvironment\fP instead.
.IP \(bu 2
The \fI\%ssh\fP execution module has been
changed as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Support for the \fBssh.get_known_host\fP function has been removed. Please use the
\fI\%ssh.get_known_host_entries\fP
function instead.
.IP \(bu 2
Support for the \fBssh.recv_known_host\fP function has been removed. Please use the
\fI\%ssh.recv_known_host_entries\fP
function instead.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
The :py:mod\(gafirewalld <salt.modules.firewalld>\(ga module has been changed as
follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The default setting for the \fBforce_masquerade\fP option in the
\fBfirewalld.add_port <salt.module.firewalld.add_port()\fP function has changed
from \fBTrue\fP to \fBFalse\fP\&.
.IP \(bu 2
Support for the \fBforce_masquerade\fP option in the
\fBfirewalld.add_port_fwd <salt.module.firewalld.add_port_fwd()\fP function has
been changed from \fBTrue\fP to \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS State Deprecations
.INDENT 0.0
.IP \(bu 2
The hipchat state has been removed due to the service being retired.
\fI\%MS Teams\fP or
\fI\%Slack\fP may be suitable replacements.
.IP \(bu 2
The cmd state module has removed the \fBquiet\fP kwarg from the
\fI\%cmd.run\fP function. Please
set \fBoutput_loglevel\fP to \fBquiet\fP instead.
.IP \(bu 2
The heat state module has removed the \fBenviroment\fP kwarg from the
\fI\%heat.deployed\fP function due
to a spelling error. Please use \fBenvironment\fP instead.
.IP \(bu 2
The :py:mod\(gafirewalld <salt.states.firewalld>\(ga state has been changed as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The default setting for the \fBprune_services\fP option in the
\fI\%firewalld.present\fP function has changed
from \fBTrue\fP to \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Fileserver Deprecations
.INDENT 0.0
.IP \(bu 2
The hgfs fileserver had the following config options removed:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The \fBhgfs_env_whitelist\fP config option has been removed in favor of \fBhgfs_saltenv_whitelist\fP\&.
.IP \(bu 2
The \fBhgfs_env_blacklist\fP config option has been removed in favor of \fBhgfs_saltenv_blacklist\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
The svnfs fileserver had the following config options removed:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The \fBsvnfs_env_whitelist\fP config option has been removed in favor of \fBsvnfs_saltenv_whitelist\fP\&.
.IP \(bu 2
The \fBsvnfs_env_blacklist\fP config option has been removed in favor of \fBsvnfs_saltenv_blacklist\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
The gitfs fileserver had the following config options removed:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The \fBgitfs_env_whitelist\fP config option has been removed in favor of \fBgitfs_saltenv_whitelist\fP\&.
.IP \(bu 2
The \fBgitfs_env_blacklist\fP config option has been removed in favor of \fBgitfs_saltenv_blacklist\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Engine Removal
.INDENT 0.0
.IP \(bu 2
The hipchat engine has been removed due to the service being retired. For users migrating
to Slack, the \fI\%slack\fP engine may be a suitable replacement.
.UNINDENT
.SS Returner Removal
.INDENT 0.0
.IP \(bu 2
The hipchat returner has been removed due to the service being retired. For users migrating
to Slack, the \fI\%slack\fP returner may be a suitable
replacement.
.UNINDENT
.SS Grain Deprecations
.sp
For \fBsmartos\fP some grains have been deprecated. These grains have been removed.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The \fBhypervisor_uuid\fP has been replaced with \fBmdata:sdc:server_uuid\fP grain.
.IP \(bu 2
The \fBdatacenter\fP has been replaced with \fBmdata:sdc:datacenter_name\fP grain.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Cloud Deprecations
.INDENT 0.0
.IP \(bu 2
The nova cloud driver has been removed in favor of the openstack cloud driver.
.UNINDENT
.SS Jinja Filter Deprecations
.INDENT 0.0
.IP \(bu 2
The following jinja filters are set to be removed in the 3003 release:
.INDENT 2.0
.IP \(bu 2
\fI\%json_decode_dict\fP in favor of \fI\%tojson\fP
.IP \(bu 2
\fI\%json_decode_list\fP in favor of \fI\%tojson\fP
.UNINDENT
.UNINDENT
.SS Utils Deprecations
.INDENT 0.0
.IP \(bu 2
All of the functions in salt.utils.__init__.py have been removed. These
include:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fIsalt.utils.option\fP
.IP \(bu 2
\fIsalt.utils.required_module_list\fP
.IP \(bu 2
\fIsalt.utils.required_modules_error\fP
.IP \(bu 2
\fIsalt.utils.get_accumulator_dir\fP\&. Please use \fBsalt.state.get_accumulator_dir()\fP instead.
.IP \(bu 2
\fIsalt.utils.fnmatch_multiple\fP\&. Please use \fBsalt.utils.itertools.fnmatch_multiple()\fP instead.
.IP \(bu 2
\fIsalt.utils.appendproctitle\fP\&. Please use \fBsalt.utils.process.appendproctitle()\fP instead.
.IP \(bu 2
\fIsalt.utils.daemonize\fP\&. Please use \fBsalt.utils.process.daemonize()\fP instead.
.IP \(bu 2
\fIsalt.utils.daemonize_if\fP\&. Please use \fBsalt.utils.process.daemonize_if()\fP instead.
.IP \(bu 2
\fIsalt.utils.reinit_crypto\fP\&. Please use \fBsalt.utils.crypt.reinit_crypto()\fP instead.
.IP \(bu 2
\fIsalt.utils.pem_finger\fP\&. Please use \fBsalt.utils.crypt.pem_finger()\fP instead.
.IP \(bu 2
\fIsalt.utils.to_bytes\fP\&. Please use \fBsalt.utils.stringutils.to_bytes()\fP instead.
.IP \(bu 2
\fIsalt.utils.to_str\fP\&. Please use \fBsalt.utils.stringutils.to_str()\fP instead.
.IP \(bu 2
\fIsalt.utils.to_unicode\fP\&. Please use \fBsalt.utils.stringutils.to_unicode()\fP instead.
.IP \(bu 2
\fIsalt.utils.str_to_num\fP\&. Please use \fBsalt.utils.stringutils.to_num()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_quoted\fP\&. Please use \fBsalt.utils.stringutils.is_quoted()\fP instead.
.IP \(bu 2
\fIsalt.utils.dequote\fP\&. Please use \fBsalt.utils.stringutils.dequote()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_hex\fP\&. Please use \fBsalt.utils.stringutils.is_hex()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_bin_str\fP\&. Please use \fBsalt.utils.stringutils.is_binary()\fP instead.
.IP \(bu 2
\fIsalt.utils.rand_string\fP\&. Please use \fBsalt.utils.stringutils.random()\fP instead.
.IP \(bu 2
\fIsalt.utils.contains_whitespace\fP\&. Please use \fBsalt.utils.stringutils.contains_whitespace()\fP instead.
.IP \(bu 2
\fIsalt.utils.build_whitespace_split_regex\fP\&. Please use \fBsalt.utils.stringutils.build_whitespace_split_regex()\fP instead.
.IP \(bu 2
\fIsalt.utils.expr_match\fP\&. Please use \fBsalt.utils.stringutils.expr_match()\fP instead.
.IP \(bu 2
\fIsalt.utils.check_whitelist_blacklist\fP\&. Please use \fBsalt.utils.stringutils.check_whitelist_blacklist()\fP instead.
.IP \(bu 2
\fIsalt.utils.check_include_exclude\fP\&.Please use \fBsalt.utils.stringutils.check_include_exclude()\fP instead.
.IP \(bu 2
\fIsalt.utils.print_cli\fP\&.Please use \fBsalt.utils.stringutils.print_cli()\fP instead.
.IP \(bu 2
\fIsalt.utils.clean_kwargs\fP\&.Please use \fBsalt.utils.args.clean_kwargs()\fP instead.
.IP \(bu 2
\fIsalt.utils.invalid_kwargs\fP\&.Please use \fBsalt.utils.args.invalid_kwargs()\fP instead.
.IP \(bu 2
\fIsalt.utils.shlex_split\fP\&.Please use \fBsalt.utils.args.shlex_split()\fP instead.
.IP \(bu 2
\fIsalt.utils.arg_lookup\fP\&.Please use \fBsalt.utils.args.arg_lookup()\fP instead.
.IP \(bu 2
\fIsalt.utils.argspec_report\fP\&.Please use \fBsalt.utils.args.argspec_report()\fP instead.
.IP \(bu 2
\fIsalt.utils.split_input\fP\&.Please use \fBsalt.utils.args.split_input()\fP instead.
.IP \(bu 2
\fIsalt.utils.test_mode\fP\&.Please use \fBsalt.utils.args.test_mode()\fP instead.
.IP \(bu 2
\fIsalt.utils.format_call\fP\&.Please use \fBsalt.utils.args.format_call()\fP instead.
.IP \(bu 2
\fIsalt.utils.which\fP\&.Please use \fBsalt.utils.path.which()\fP instead.
.IP \(bu 2
\fIsalt.utils.which_bin\fP\&.Please use \fBsalt.utils.path.which_bin()\fP instead.
.IP \(bu 2
\fIsalt.utils.path_join\fP\&.Please use \fBsalt.utils.path.join()\fP instead.
.IP \(bu 2
\fIsalt.utils.check_or_die\fP\&.Please use \fBsalt.utils.path.check_or_die()\fP instead.
.IP \(bu 2
\fIsalt.utils.sanitize_win_path_string\fP\&.Please use \fBsalt.utils.path.sanitize_win_path()\fP instead.
.IP \(bu 2
\fIsalt.utils.rand_str\fP\&.Please use \fBsalt.utils.hashutils.random_hash()\fP instead.
.IP \(bu 2
\fIsalt.utils.get_hash\fP\&.Please use \fBsalt.utils.hashutils.get_hash()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_windows\fP\&.Please use \fBsalt.utils.platform.is_windows()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_proxy\fP\&.Please use \fBsalt.utils.platform.is_proxy()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_linux\fP\&.Please use \fBsalt.utils.platform.is_linux()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_darwin\fP\&.Please use \fBsalt.utils.platform.is_darwin()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_sunos\fP\&.Please use \fBsalt.utils.platform.is_sunos()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_smartos\fP\&.Please use \fBsalt.utils.platform.is_smartos()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_smartos_globalzone\fP\&.Please use \fBsalt.utils.platform.is_smartos_globalzone()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_smartos_zone\fP\&.Please use \fBsalt.utils.platform.is_smartos_zone()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_freebsd\fP\&.Please use \fBsalt.utils.platform.is_freebsd()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_netbsd\fP\&.Please use \fBsalt.utils.platform.is_netbsd()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_openbsd\fP\&.Please use \fBsalt.utils.platform.is_openbsd()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_aix\fP\&.Please use \fBsalt.utils.platform.is_aix()\fP instead.
.IP \(bu 2
\fIsalt.utils.safe_rm\fP\&.Please use \fBsalt.utils.files.safe_rm()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_empty\fP\&.Please use \fBsalt.utils.files.is_empty()\fP instead.
.IP \(bu 2
\fIsalt.utils.fopen\fP\&.Please use \fBsalt.utils.files.fopen()\fP instead.
.IP \(bu 2
\fIsalt.utils.flopen\fP\&.Please use \fBsalt.utils.files.flopen()\fP instead.
.IP \(bu 2
\fIsalt.utils.fpopen\fP\&.Please use \fBsalt.utils.files.fpopen()\fP instead.
.IP \(bu 2
\fIsalt.utils.rm_rf\fP\&.Please use \fBsalt.utils.files.rm_rf()\fP instead.
.IP \(bu 2
\fIsalt.utils.mkstemp\fP\&.Please use \fBsalt.utils.files.mkstemp()\fP instead.
.IP \(bu 2
\fIsalt.utils.istextfile\fP\&.Please use \fBsalt.utils.files.is_text_file()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_bin_file\fP\&.Please use \fBsalt.utils.files.is_binary()\fP instead.
.IP \(bu 2
\fIsalt.utils.list_files\fP\&.Please use \fBsalt.utils.files.list_files()\fP instead.
.IP \(bu 2
\fIsalt.utils.safe_walk\fP\&.Please use \fBsalt.utils.files.safe_walk()\fP instead.
.IP \(bu 2
\fIsalt.utils.st_mode_to_octal\fP\&.Please use \fBsalt.utils.files.st_mode_to_octal()\fP instead.
.IP \(bu 2
\fIsalt.utils.normalize_mode\fP\&.Please use \fBsalt.utils.files.normalize_mode()\fP instead.
.IP \(bu 2
\fIsalt.utils.human_size_to_bytes\fP\&.Please use \fBsalt.utils.files.human_size_to_bytes()\fP instead.
.IP \(bu 2
\fIsalt.utils.backup_minion\fP\&.Please use \fBsalt.utils.files.backup_minion()\fP instead.
.IP \(bu 2
\fIsalt.utils.str_version_to_evr\fP\&.Please use \fBsalt.utils.pkg.rpm.version_to_evr()\fP instead.
.IP \(bu 2
\fIsalt.utils.parse_docstring\fP\&.Please use \fBsalt.utils.doc.parse_docstring()\fP instead.
.IP \(bu 2
\fIsalt.utils.compare_versions\fP\&.Please use \fBsalt.utils.versions.compare()\fP instead.
.IP \(bu 2
\fIsalt.utils.version_cmp\fP\&.Please use \fBsalt.utils.versions.version_cmp()\fP instead.
.IP \(bu 2
\fIsalt.utils.warn_until\fP\&.Please use \fBsalt.utils.versions.warn_until()\fP instead.
.IP \(bu 2
\fIsalt.utils.kwargs_warn_until\fP\&.Please use \fBsalt.utils.versions.kwargs_warn_until()\fP instead.
.IP \(bu 2
\fIsalt.utils.get_color_theme\fP\&.Please use \fBsalt.utils.color.get_color_theme()\fP instead.
.IP \(bu 2
\fIsalt.utils.get_colors\fP\&.Please use \fBsalt.utils.color.get_colors()\fP instead.
.IP \(bu 2
\fIsalt.utils.gen_state_tag\fP\&.Please use \fBsalt.utils.state.gen_tag()\fP instead.
.IP \(bu 2
\fIsalt.utils.search_onfail_requisites\fP\&.Please use \fBsalt.utils.state.search_onfail_requisites()\fP instead.
.IP \(bu 2
\fIsalt.utils.check_onfail_requisites\fP\&.Please use \fBsalt.utils.state.check_onfail_requisites()\fP instead.
.IP \(bu 2
\fIsalt.utils.check_state_result\fP\&.Please use \fBsalt.utils.state.check_result()\fP instead.
.IP \(bu 2
\fIsalt.utils.get_user\fP\&.Please use \fBsalt.utils.user.get_user()\fP instead.
.IP \(bu 2
\fIsalt.utils.get_uid\fP\&.Please use \fBsalt.utils.user.get_uid()\fP instead.
.IP \(bu 2
\fIsalt.utils.get_specific_user\fP\&.Please use \fBsalt.utils.user.get_specific_user()\fP instead.
.IP \(bu 2
\fIsalt.utils.chugid\fP\&.Please use \fBsalt.utils.user.chugid()\fP instead.
.IP \(bu 2
\fIsalt.utils.chugid_and_umask\fP\&.Please use \fBsalt.utils.user.chugid_and_umask()\fP instead.
.IP \(bu 2
\fIsalt.utils.get_default_group\fP\&.Please use \fBsalt.utils.user.get_default_group()\fP instead.
.IP \(bu 2
\fIsalt.utils.get_group_list\fP\&.Please use \fBsalt.utils.user.get_group_list()\fP instead.
.IP \(bu 2
\fIsalt.utils.get_group_dict\fP\&.Please use \fBsalt.utils.user.get_group_dict()\fP instead.
.IP \(bu 2
\fIsalt.utils.get_gid_list\fP\&.Please use \fBsalt.utils.user.get_gid_list()\fP instead.
.IP \(bu 2
\fIsalt.utils.get_gid\fP\&.Please use \fBsalt.utils.user.get_gid()\fP instead.
.IP \(bu 2
\fIsalt.utils.enable_ctrl_logoff_handler\fP\&.Please use \fBsalt.utils.win_functions.enable_ctrl_logoff_handler()\fP instead.
.IP \(bu 2
\fIsalt.utils.traverse_dict\fP\&.Please use \fBsalt.utils.data.traverse_dict()\fP instead.
.IP \(bu 2
\fIsalt.utils.traverse_dict_and_list\fP\&.Please use \fBsalt.utils.data.traverse_dict_and_list()\fP instead.
.IP \(bu 2
\fIsalt.utils.filter_by\fP\&.Please use \fBsalt.utils.data.filter_by()\fP instead.
.IP \(bu 2
\fIsalt.utils.subdict_match\fP\&.Please use \fBsalt.utils.data.subdict_match()\fP instead.
.IP \(bu 2
\fIsalt.utils.substr_in_list\fP\&.Please use \fBsalt.utils.data.substr_in_list()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_dictlist\fP\&.Please use \fBsalt.utils.data.is_dictlist()\fP instead.
.IP \(bu 2
\fIsalt.utils.repack_dictlist\fP\&.Please use \fBsalt.utils.data.repack_dictlist()\fP instead.
.IP \(bu 2
\fIsalt.utils.compare_dicts\fP\&.Please use \fBsalt.utils.data.compare_dicts()\fP instead.
.IP \(bu 2
\fIsalt.utils.compare_lists\fP\&.Please use \fBsalt.utils.data.compare_lists()\fP instead.
.IP \(bu 2
\fIsalt.utils.decode_dict\fP\&.Please use \fBsalt.utils.data.encode_dict()\fP instead.
.IP \(bu 2
\fIsalt.utils.decode_list\fP\&.Please use \fBsalt.utils.data.encode_list()\fP instead.
.IP \(bu 2
\fIsalt.utils.exactly_n\fP\&.Please use \fBsalt.utils.data.exactly_n()\fP instead.
.IP \(bu 2
\fIsalt.utils.exactly_one\fP\&.Please use \fBsalt.utils.data.exactly_one()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_list\fP\&.Please use \fBsalt.utils.data.is_list()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_iter\fP\&.Please use \fBsalt.utils.data.is_iter()\fP instead.
.IP \(bu 2
\fIsalt.utils.isorted\fP\&.Please use \fBsalt.utils.data.sorted_ignorecase()\fP instead.
.IP \(bu 2
\fIsalt.utils.is_true\fP\&.Please use \fBsalt.utils.data.is_true()\fP instead.
.IP \(bu 2
\fIsalt.utils.mysql_to_dict\fP\&.Please use \fBsalt.utils.data.mysql_to_dict()\fP instead.
.IP \(bu 2
\fIsalt.utils.simple_types_filter\fP\&.Please use \fBsalt.utils.data.simple_types_filter()\fP instead.
.IP \(bu 2
\fIsalt.utils.ip_bracket\fP\&.Please use \fBsalt.utils.zeromq.ip_bracket()\fP instead.
.IP \(bu 2
\fIsalt.utils.gen_mac\fP\&.Please use \fBsalt.utils.network.gen_mac()\fP instead.
.IP \(bu 2
\fIsalt.utils.mac_str_to_bytes\fP\&.Please use \fBsalt.utils.network.mac_str_to_bytes()\fP instead.
.IP \(bu 2
\fIsalt.utils.refresh_dns\fP\&.Please use \fBsalt.utils.network.refresh_dns()\fP instead.
.IP \(bu 2
\fIsalt.utils.dns_check\fP\&.Please use \fBsalt.utils.network.dns_check()\fP instead.
.IP \(bu 2
\fIsalt.utils.get_context\fP\&.Please use \fBsalt.utils.stringutils.get_context()\fP instead.
.IP \(bu 2
\fIsalt.utils.get_master_key\fP\&.Please use \fBsalt.utils.master.get_master_key()\fP instead.
.IP \(bu 2
\fIsalt.utils.get_values_of_matching_keys\fP\&.Please use \fBsalt.utils.master.get_values_of_matching_keys()\fP instead.
.IP \(bu 2
\fIsalt.utils.date_cast\fP\&.Please use \fBsalt.utils.dateutils.date_cast()\fP instead.
.IP \(bu 2
\fIsalt.utils.date_format\fP\&.Please use \fBsalt.utils.dateutils.strftime()\fP instead.
.IP \(bu 2
\fIsalt.utils.total_seconds\fP\&.Please use \fBsalt.utils.dateutils.total_seconds()\fP instead.
.IP \(bu 2
\fIsalt.utils.find_json\fP\&.Please use \fBsalt.utils.json.find_json()\fP instead.
.IP \(bu 2
\fIsalt.utils.import_json\fP\&.Please use \fBsalt.utils.json.import_json()\fP instead.
.IP \(bu 2
\fIsalt.utils.namespaced_function\fP\&.Please use \fBsalt.utils.functools.namespaced_function()\fP instead.
.IP \(bu 2
\fIsalt.utils.alias_function\fP\&.Please use \fBsalt.utils.functools.alias_function()\fP instead.
.IP \(bu 2
\fIsalt.utils.profile_func\fP\&.Please use \fBsalt.utils.profile.profile_func()\fP instead.
.IP \(bu 2
\fIsalt.utils.activate_profile\fP\&.Please use \fBsalt.utils.profile.activate_profile()\fP instead.
.IP \(bu 2
\fIsalt.utils.output_profile\fP\&.Please use \fBsalt.utils.profile.output_profile()\fP instead.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS salt.auth.Authorize Class Removal
.INDENT 0.0
.IP \(bu 2
The salt.auth.Authorize Class inside of the \fIsalt/auth/__init__.py\fP file has been removed and
the \fIany_auth\fP method inside of the file \fIsalt/utils/minions.py\fP\&. These method and classes were
not being used inside of the salt code base.
.UNINDENT
.SS Salt 3000.1 Release Notes
.sp
Version 3000.1 is a bugfix release for \fI\%3000\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB53\fP
.IP \(bu 2
Total Issue References: \fB15\fP
.IP \(bu 2
Total PR References: \fB54\fP
.IP \(bu 2
Contributors: \fB16\fP (\fI\%Ch3LL\fP, \fI\%UtahDave\fP, \fI\%bryceml\fP, \fI\%cmcmarrow\fP, \fI\%dwoz\fP, \fI\%frogunder\fP,
\fI\%garethgreenaway\fP, \fI\%lorengordon\fP, \fI\%mchugh19\fP, \fI\%oeuftete\fP, \fI\%raddessi\fP, \fI\%s0undt3ch\fP,
\fI\%sjorge\fP, \fI\%terminalmage\fP, \fI\%twangboy\fP, \fI\%waynew\fP)
.UNINDENT
.SS Changelog for v3000..v3000.1
.sp
\fIGenerated at: 2020\-03\-27 16:48:41 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#56455\fP: (\fI\%s0undt3ch\fP) Fix gitpython windows requirement
@ \fI2020\-03\-27 16:31:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
c5a700e01e Merge pull request \fI\%#56455\fP from s0undt3ch/hotfix/gitpython
.IP \(bu 2
d9791c393f Revert and fix windows requirements
.IP \(bu 2
4b573c1c94 Revert \(dqFix win deps\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56446\fP: (\fI\%frogunder\fP) 3000.1 releasenotes updates
@ \fI2020\-03\-24 20:28:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
7ba36325d9 Merge pull request \fI\%#56446\fP from frogunder/releasenotes_3000.1_updates
.IP \(bu 2
6b47f474af 3000.1 releasenotes updates
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56435\fP: (\fI\%twangboy\fP) Update mac build scripts
@ \fI2020\-03\-24 19:47:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
4d2bc7004d Merge pull request \fI\%#56435\fP from twangboy/update_mac_build_scripts
.IP \(bu 2
5d244b0aa6 Merge branch \(aqmaster\(aq into update_mac_build_scripts
.IP \(bu 2
8fdf52a243 Update gitpython to 2.1.15
.IP \(bu 2
afcedc5232 Remove \-\-ignore\-installed
.IP \(bu 2
e6cc2a6192 Separate pyobjc requirements
.IP \(bu 2
262ad2e98a Compile static requirements
.IP \(bu 2
224f72d0f2 Update noxfile and .precommit
.IP \(bu 2
68a36f2e37 Add req_ext.txt
.IP \(bu 2
5851a5c2cd Roll back changes, fix dependencies
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#56433\fP: (\fI\%Ch3LL\fP) integration.states.test_pip_state.PipStateTest.test_pip_installed_specific_env failing on MAC (refs: \fI\%#56436\fP)
.IP \(bu 2
\fBPR\fP \fI\%#56436\fP: (\fI\%Ch3LL\fP) Fix \fI\%#56433\fP \- test_pip_installed_specific_env
@ \fI2020\-03\-24 19:47:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
8a8ae8ebe4 Merge pull request \fI\%#56436\fP from Ch3LL/pip_custom_pypi
.IP \(bu 2
55655ff96c Merge branch \(aqmaster\(aq into pip_custom_pypi
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56423\fP: (\fI\%Ch3LL\fP) Update changelog with package fixes
@ \fI2020\-03\-24 16:42:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a993d73a9 Merge pull request \fI\%#56423\fP from Ch3LL/changelog_again
.IP \(bu 2
963c16e1a7 update pr number for mac build changes in changelog
.IP \(bu 2
83e22b77c7 Update changelog with package fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56417\fP: (\fI\%twangboy\fP) Update mac build scripts
@ \fI2020\-03\-23 18:45:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
d2a5bd8add Merge pull request \fI\%#56417\fP from twangboy/update_mac_build_scripts
.IP \(bu 2
3bda8ddb82 Update noxfile and pre\-commit
.IP \(bu 2
de58c52d66 Merge branch \(aqupdate_mac_build_scripts\(aq of \fI\%https://github.com/twangboy/salt\fP into update_mac_build_scripts
.INDENT 2.0
.IP \(bu 2
e7f08d5349 Update static requirements
.IP \(bu 2
a53977de5b Merge branch \(aqupdate_mac_build_scripts\(aq of github.com:twangboy/salt into update_mac_build_scripts
.IP \(bu 2
04e5cde9dd \fIpkg/osx/req_ext.txt\fP no longer exists
.IP \(bu 2
be4a272d07 Update static requirements
.UNINDENT
.IP \(bu 2
02dfe4119c Add pyobjc in its own requirements file
.IP \(bu 2
6b2ac2be64 Remove pyobjc, enforce pip install location
.IP \(bu 2
30ca5d04ec Remove cryptography, it gets installed by pyopenssl
.IP \(bu 2
fda8abf4a8 Update static requirements
.IP \(bu 2
732ecc83c1 Update pre\-commit config
.IP \(bu 2
1fa9864e3d Don\(aqt set a version for pyopenssl
.IP \(bu 2
461b198978 Update dependencies, remove req_ext.txt
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56418\fP: (\fI\%Ch3LL\fP) Ensure version.py included before we install
@ \fI2020\-03\-23 18:27:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
74575a6993 Merge pull request \fI\%#56418\fP from Ch3LL/egg_version
.IP \(bu 2
85d7c784ef Fix integration setup egg test
.IP \(bu 2
a8a22a4040 Ensure version.py included before we install
.IP \(bu 2
86fe450c82 Fix \fI\%#56433\fP \- test_pip_installed_specific_env
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56403\fP: (\fI\%frogunder\fP) update 3000.1 releasenotes
@ \fI2020\-03\-17 23:50:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
249367b462 Merge pull request \fI\%#56403\fP from frogunder/update_releasenotes_3000.1
.IP \(bu 2
9d972c96e8 update 3000.1 releasenotes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56398\fP: (\fI\%Ch3LL\fP) Add additional PRs to 3000.1 changelog
@ \fI2020\-03\-17 18:08:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
0de5c1e136 Merge pull request \fI\%#56398\fP from Ch3LL/change_3000.1
.IP \(bu 2
79c337b3db Add additional PRs to 3000.1 changelog
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56376\fP: (\fI\%twangboy\fP) Fix win deps
@ \fI2020\-03\-17 17:02:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
5ac09decb9 Merge pull request \fI\%#56376\fP from twangboy/fix_win_deps
.IP \(bu 2
6c83beeb9e Fix win deps
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56378\fP: (\fI\%Ch3LL\fP)  Include _version.py if building wheel
@ \fI2020\-03\-17 17:01:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
e72a8d2cbc Merge pull request \fI\%#56378\fP from Ch3LL/wheel_version
.IP \(bu 2
22cccd2107 Use virtualenv test helper that already exists and fix setup.py
.IP \(bu 2
293b1fddf2 cleanup code
.IP \(bu 2
ddfb065bfb add bdist_wheel test
.IP \(bu 2
fceff0287c ensure name is included in new version
.IP \(bu 2
0cbf6d3246 Ensure SaltStackVersion attributes in _version.py correct
.IP \(bu 2
39cdf5382d Include _version.py if building wheel
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56387\fP: (\fI\%bryceml\fP) update gpg key expiration date
@ \fI2020\-03\-17 16:59:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a9326fb70 Merge pull request \fI\%#56387\fP from bryceml/update_gpg_key
.IP \(bu 2
b74b26ccf3 update gpg key expiration date
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#55822\fP: (\fI\%cmcmarrow\fP) fix_Indefinitely_code
@ \fI2020\-03\-16 17:34:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
fcee692c4a Merge pull request \fI\%#55822\fP from cmcmarrow/win_task_repeat
.IP \(bu 2
e257fb2804 Merge branch \(aqmaster\(aq into win_task_repeat
.IP \(bu 2
07cada0f8f Merge branch \(aqmaster\(aq into win_task_repeat
.IP \(bu 2
4b80301338 Merge branch \(aqmaster\(aq into win_task_repeat
.IP \(bu 2
9df94569c4 Merge branch \(aqmaster\(aq into win_task_repeat
.IP \(bu 2
22a2d0b9ec Merge branch \(aqmaster\(aq into win_task_repeat
.IP \(bu 2
dee9c134e7 Merge branch \(aqmaster\(aq into win_task_repeat
.IP \(bu 2
beaf05d514 Update test_win_task.py
.IP \(bu 2
6e923f75fc Merge branch \(aqmaster\(aq into win_task_repeat
.IP \(bu 2
5839da81ee add test
.IP \(bu 2
2aa6338ed0 fix Indefinitely code
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56373\fP: (\fI\%frogunder\fP) update 3000.1 releasenotes
@ \fI2020\-03\-13 18:58:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
c11ef89200 Merge pull request \fI\%#56373\fP from frogunder/releasenotes_3000.1
.IP \(bu 2
a5ca8b5277 Fix doc test errors
.IP \(bu 2
47e483187e update 3000.1 releasenotes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56365\fP: (\fI\%Ch3LL\fP) Update 3000.1 changelog
@ \fI2020\-03\-13 17:21:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
62857a9f0e Merge pull request \fI\%#56365\fP from Ch3LL/changelog_3000.1
.IP \(bu 2
851d7d8fc7 Update 3000.1 changelog
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56360\fP: (\fI\%Ch3LL\fP) Use virtualenv 20.0.10 for macosx tests
@ \fI2020\-03\-13 16:39:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
a660e96fb2 Merge pull request \fI\%#56360\fP from Ch3LL/mac_virtual
.IP \(bu 2
abda125086 Update static requirements files
.IP \(bu 2
dca3390c0c skip zcbuildout state test when virtualenv 20.0.0
.IP \(bu 2
fdeae1f0e1 Use virtualenv 20.0.10 for macosx tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#56324\fP: (\fI\%kiemlicz\fP) Cannot use Saltcheck module (refs: \fI\%#56327\fP)
.IP \(bu 2
\fBPR\fP \fI\%#56327\fP: (\fI\%mchugh19\fP) keep cache_copied_files variable a list
@ \fI2020\-03\-13 16:39:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
d8fc07274c Merge pull request \fI\%#56327\fP from mchugh19/56324
.IP \(bu 2
e1e2df2b1d Merge branch \(aqmaster\(aq into 56324
.IP \(bu 2
6d7572706d use includes for saltcheck integration test
.IP \(bu 2
5b7073b01d keep cache_copied_files variable a list
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56023\fP: (\fI\%cmcmarrow\fP) add fix for bin_env
@ \fI2020\-03\-13 16:39:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d31d61ab9 Merge pull request \fI\%#56023\fP from cmcmarrow/binary_fix_pip_bin_env
.IP \(bu 2
f780fd013e Merge branch \(aqmaster\(aq into binary_fix_pip_bin_env
.IP \(bu 2
d642c7c270 Merge branch \(aqmaster\(aq into binary_fix_pip_bin_env
.IP \(bu 2
82b39d26f8 Merge branch \(aqbinary_fix_pip_bin_env\(aq of \fI\%https://github.com/cmcmarrow/salt\fP into binary_fix_pip_bin_env
.INDENT 2.0
.IP \(bu 2
a5fa22528a Merge branch \(aqmaster\(aq into binary_fix_pip_bin_env
.UNINDENT
.IP \(bu 2
10ca0fa5d6 fix space
.IP \(bu 2
22fff6c180 fix _pip_bin_env
.IP \(bu 2
d5425e6630 Merge branch \(aqmaster\(aq into binary_fix_pip_bin_env
.IP \(bu 2
ceda3fde00 add full support for when missing kwargs or args
.IP \(bu 2
cf4ab215b5 add fix for bin_env
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56310\fP: (\fI\%twangboy\fP) Only process ADMX files when loading policies
@ \fI2020\-03\-11 23:47:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
19bb6aae0c Merge pull request \fI\%#56310\fP from twangboy/fix_lgpo_admx
.IP \(bu 2
4bc5b05586 Fix some lint
.IP \(bu 2
ce282f9754 Mark destructive test
.IP \(bu 2
8af09c31ca Add test case
.IP \(bu 2
547d35cf4c Only process ADMX files when loading policies
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56272\fP: (\fI\%twangboy\fP) Properly resolve the policy name
@ \fI2020\-03\-11 22:11:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d78931eaf Merge pull request \fI\%#56272\fP from twangboy/fix_lgpo_names
.IP \(bu 2
233ed12472 Add comments to helper function
.IP \(bu 2
a7369e41d7 Remove redundent code... some more
.IP \(bu 2
1db3052b94 Consolidate duplicate code
.IP \(bu 2
b25b56299d Fix failing PY2 tests
.IP \(bu 2
36a24ac28f Only load adml data once
.IP \(bu 2
bc13be6850 Add some tests
.IP \(bu 2
2e9be6e461 Properly resolve the policy name
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56358\fP: (\fI\%s0undt3ch\fP) Fix version instantiation when minor is an empty string
@ \fI2020\-03\-11 22:10:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
c6c6e2e3d9 Merge pull request \fI\%#56358\fP from s0undt3ch/hotfix/version\-parsing
.IP \(bu 2
cb22e78502 Fix version instantiation when minor is an empty string
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56160\fP: (\fI\%twangboy\fP) Fix issue with existing reg_dword entries
@ \fI2020\-03\-11 22:09:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
b33047c574 Merge pull request \fI\%#56160\fP from twangboy/fix_reg_dword
.IP \(bu 2
80650c2a8c Make test more explicit
.IP \(bu 2
67dd1c18c7 Fix issue with existing reg_dword entries
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56337\fP: (\fI\%twangboy\fP) Handle Adapter Type 53 and Undefined Types
@ \fI2020\-03\-11 22:08:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
8f23706871 Merge pull request \fI\%#56337\fP from twangboy/fix_win_network_type
.IP \(bu 2
18a31a0b22 Merge branch \(aqmaster\(aq into fix_win_network_type
.IP \(bu 2
d92914ad91 Merge branch \(aqmaster\(aq into fix_win_network_type
.IP \(bu 2
224629bdeb Handle Adapter Type 53 and Undefined Types
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56060\fP: (\fI\%twangboy\fP) Fix regex string for **Del and **DelVals
@ \fI2020\-03\-11 22:05:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
e551ff6a31 Merge pull request \fI\%#56060\fP from twangboy/fix_lgpo_regex
.IP \(bu 2
ca260ef582 Use byte\-strings in the test
.IP \(bu 2
7c81874a5b Add some tests
.IP \(bu 2
944b022f33 Fix regex string for **Del and **DelVals
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#56131\fP: (\fI\%thusoy\fP) Salt v3000 crashes with unless clause if pip is missing (refs: \fI\%#56215\fP)
.IP \(bu 2
\fBPR\fP \fI\%#56215\fP: (\fI\%dwoz\fP) Fix for unless requisite when pip is not installed
@ \fI2020\-03\-11 22:04:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
c9bc9431c1 Merge pull request \fI\%#56215\fP from dwoz/issue\-56131
.IP \(bu 2
5dd8f8eabe Fix linter
.IP \(bu 2
7492c2f7c7 Remove crufty prints from test
.IP \(bu 2
8ceaa6e6f3 Only remove pip relasted modules
.IP \(bu 2
69b21e5e68 Add regression test for issue 56131
.IP \(bu 2
9d23f55adc Fix for unless requisite when pip is not installed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56339\fP: (\fI\%twangboy\fP) Fix win_dns_client when used with scheduler
@ \fI2020\-03\-11 22:01:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
74b67ea741 Merge pull request \fI\%#56339\fP from twangboy/fix_win_dns_client
.IP \(bu 2
d6a4fbe85d Fix bad test (lint)
.IP \(bu 2
47bd67373f Add some tests
.IP \(bu 2
995975649a Add missing import, improve docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#56288\fP: (\fI\%lorengordon\fP) win_lgpo: \fIlgpo.set\fP with secedit policy always generates \fIKeyError: u\(aqlgpo.secedit_data\(aq\fP (refs: \fI\%#56290\fP)
.IP \(bu 2
\fBPR\fP \fI\%#56290\fP: (\fI\%lorengordon\fP) Ensures popping lgpo.secedit_data does not throw KeyError
@ \fI2020\-03\-11 17:27:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
7701e8762d Merge pull request \fI\%#56290\fP from lorengordon/pop\-secdata
.IP \(bu 2
62453bb6ce Merge branch \(aqmaster\(aq into pop\-secdata
.IP \(bu 2
95d5cea9ff Merge branch \(aqmaster\(aq into pop\-secdata
.IP \(bu 2
2979158a8b Tests the \fIif _secedits:\fP logic path in \fIlgpo.set_\fP
.IP \(bu 2
d1f776178c Ensures popping lgpo.secedit_data does not throw KeyError
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#56119\fP: (\fI\%finalduty\fP) Release notes for v3000 do not mention changes to \fIslspath\fP variable (refs: \fI\%#56341\fP)
.IP \(bu 2
\fBPR\fP \fI\%#56341\fP: (\fI\%dwoz\fP) Revert \(dqDon\(aqt remove one directory level from slspath\(dq
@ \fI2020\-03\-11 17:03:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
84c60708cd Merge pull request \fI\%#56341\fP from dwoz/issue\-56119
.IP \(bu 2
afe6e84c36 Clarify slspath documentation
.IP \(bu 2
6dfc098fd1 Add debug for test asserts
.IP \(bu 2
9fa9dab8b2 Fix linter warts
.IP \(bu 2
fd702bdd44 Add regression test for \fI\%#56119\fP
.IP \(bu 2
3d3b673cec Revert \(dqDon\(aqt remove one directory level from slspath\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56185\fP: (\fI\%terminalmage\fP) Fix regression in service states with reload argument
@ \fI2020\-03\-11 16:45:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
4f9813a49c Merge pull request \fI\%#56185\fP from terminalmage/issue56167
.IP \(bu 2
65b3f4c9a0 Merge branch \(aqmaster\(aq into issue56167
.IP \(bu 2
7b41a00b4f Merge branch \(aqmaster\(aq into issue56167
.IP \(bu 2
8f7034d946 Merge branch \(aqmaster\(aq into issue56167
.IP \(bu 2
e9fbb634e1 Skip on OSX for now
.IP \(bu 2
5996280241 Add __opts__ and __grains__ just in case
.IP \(bu 2
af3e841d08 Fix failing test
.IP \(bu 2
586f21aedc Add functional test
.IP \(bu 2
1afb9c10f0 Fix regression in service states with reload argument
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56068\fP: (\fI\%s0undt3ch\fP) Update the bootstrap script to latest version, v2020.02.24
@ \fI2020\-03\-11 16:44:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
74f8b2a926 Merge pull request \fI\%#56068\fP from s0undt3ch/hotfix/update\-bootstrap
.IP \(bu 2
ce83b190ed Merge branch \(aqmaster\(aq into hotfix/update\-bootstrap
.IP \(bu 2
ccd231d82d Merge branch \(aqmaster\(aq into hotfix/update\-bootstrap
.IP \(bu 2
88a52f88ff Update the bootstrap script to latest version, v2020.02.24
.IP \(bu 2
012fb5bc4b Update the bootstrap script to latest version, v2020.02.04
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56321\fP: (\fI\%oeuftete\fP) Tidy up formatting in boto_secgroup docs
@ \fI2020\-03\-11 08:14:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
154257e2e9 Merge pull request \fI\%#56321\fP from oeuftete/tidy\-boto\-secgroup\-docs
.IP \(bu 2
616f11b33e Merge branch \(aqmaster\(aq into tidy\-boto\-secgroup\-docs
.IP \(bu 2
412bb4d62d Tidy up formatting in boto_secgroup docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56336\fP: (\fI\%Ch3LL\fP) Fix test_issue_2594_non_invalidated_cache test (update zope.interface)
@ \fI2020\-03\-11 00:08:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
11d33e3d90 Merge pull request \fI\%#56336\fP from Ch3LL/fix_56330
.IP \(bu 2
bbf37e090b Fix test_issue_2594_non_invalidated_cache test (update zope.interface)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56346\fP: (\fI\%frogunder\fP) Update man pages to 3000.1
@ \fI2020\-03\-11 00:07:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
a640bd30fc Merge pull request \fI\%#56346\fP from frogunder/man_pages_3000_1
.IP \(bu 2
6d7c1b6482 Update man pages to 3000.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56099\fP: (\fI\%s0undt3ch\fP) Fix Windows and macOS requirements handling in setup.py
@ \fI2020\-03\-11 00:04:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
2f783d247e Merge pull request \fI\%#56099\fP from s0undt3ch/hotfix/requirements
.IP \(bu 2
c19f4a3fae Merge branch \(aqmaster\(aq into hotfix/requirements
.IP \(bu 2
1e7bc8fc8f Also take into account macOS requirements
.IP \(bu 2
7eef14952c Also include req_win.txt
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56218\fP: (\fI\%raddessi\fP) Changed StrictVersion checking of setuptools to LooseVersion
@ \fI2020\-03\-10 23:59:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
7c4d879073 Merge pull request \fI\%#56218\fP from raddessi/master.v3000\-conda
.IP \(bu 2
44556f6d57 Merge branch \(aqmaster\(aq into master.v3000\-conda
.IP \(bu 2
566c03b786 Merge branch \(aqmaster\(aq into master.v3000\-conda
.IP \(bu 2
82773a9799 Removed now\-unused StrictVersion import from setup.py
.IP \(bu 2
31bb0f7cd1 Changed StrictVersion checking of setuptools to LooseVersion
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56128\fP: (\fI\%waynew\fP) Update CHANGELOG with release date and unreleased.
@ \fI2020\-03\-10 23:58:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
acbd3556e5 Merge pull request \fI\%#56128\fP from waynew/master
.IP \(bu 2
e3216db3e5 Update CHANGELOG with release date and unreleased.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#55937\fP: (\fI\%twangboy\fP) Update windows build scripts
@ \fI2020\-03\-10 23:55:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
12140545ab Merge pull request \fI\%#55937\fP from twangboy/update_deps
.IP \(bu 2
f00a504a48 Add back the pylauncher
.IP \(bu 2
30b9c32356 Revert changes to req and req_win
.IP \(bu 2
98dc0e970c Fix some warts in the build_env scripts
.IP \(bu 2
8404141f65 Update dependencies
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#55906\fP: (\fI\%sjorge\fP) smartos.vm_present could not handle nics with vrrp_vrid property
@ \fI2020\-03\-10 23:54:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
485a47cdf1 Merge pull request \fI\%#55906\fP from sjorge/smartos_vrrp
.IP \(bu 2
5bd7dd009a Merge branch \(aqmaster\(aq into smartos_vrrp
.IP \(bu 2
f77719c179 smartos state should handle vrrp config
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#55185\fP: (\fI\%sjorge\fP) salt.modules.pdbedit doesn\(aqt work on samba older than 4.8 (refs: \fI\%#55894\fP)
.IP \(bu 2
\fBPR\fP \fI\%#55894\fP: (\fI\%sjorge\fP) \fI\%#55185\fP pdbedit module should check for version 4.8.x or newer
@ \fI2020\-03\-10 23:54:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
1fa8555360 Merge pull request \fI\%#55894\fP from sjorge/pdbedit_55185
.IP \(bu 2
9dc7b71122 Merge branch \(aqmaster\(aq into pdbedit_55185
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#56195\fP: (\fI\%lorengordon\fP) Windows: Using inline powershell in args with \fIcmd.script\fP and \fIshell: powershell\fP (refs: \fI\%#56197\fP)
.IP \(bu 2
\fBPR\fP \fI\%#56197\fP: (\fI\%lorengordon\fP) Allows use of inline powershell for cmd.script args
@ \fI2020\-03\-10 23:52:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e57d58db2 Merge pull request \fI\%#56197\fP from lorengordon/file\-or\-no\-file
.IP \(bu 2
fcd1699f5e Allows use of inline powershell for cmd.script args
.IP \(bu 2
be2e67c0a0 Tests that powershell processes inline powershell in args
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#53152\fP: (\fI\%jbeaird\fP) daily highstate fails after 2019.2 upgrade (refs: \fI\%#56149\fP)
.IP \(bu 2
\fBPR\fP \fI\%#56149\fP: (\fI\%garethgreenaway\fP) [master] Fix to scheduler for use of when and splay
@ \fI2020\-03\-10 23:52:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
547c73e4cc Merge pull request \fI\%#56149\fP from garethgreenaway/53152_fix_schedule_when_splay
.IP \(bu 2
8f068f6f9b Fix for when using a combination of when and splay.  Previously comparing the wrong value when determining if the job should be run and next_fire_time updated.  This resulted in multiple job runs when \fIwhen\fP and \fIsplay\fP were used together.  Code updated and test updated to ensure only one run at the specific time.  Skip eval tests is dateutil.parser is unavailable.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56345\fP: (\fI\%s0undt3ch\fP) Bump Windows Py3 builds timeout to 10 hours
@ \fI2020\-03\-10 20:43:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
192ce76a95 Merge pull request \fI\%#56345\fP from s0undt3ch/hotfix/win\-py3\-timeouts
.IP \(bu 2
11bdc38ae3 Bump Windows 2019 Py3 builds timeout to 10 hours
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#55888\fP: (\fI\%s0undt3ch\fP) Disable codecov PR comments and status checks
@ \fI2020\-03\-10 15:45:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
a204906c80 Merge pull request \fI\%#55888\fP from s0undt3ch/hotfix/coverage\-reporting
.IP \(bu 2
4b8dc8a586 Disable codecov PR comments and status checks
.IP \(bu 2
cb0f4dff87 Apply the suggestion given by the codecov team
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#56177\fP: (\fI\%jodok\fP) mysql states fail because conv is \(ga\(ga instead of None (refs: \fI\%#56174\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#56170\fP: (\fI\%jeffdyke\fP) mariadb socket access must be enabled before highstate \- salt 3K still tries empty password (refs: \fI\%#56174\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#56124\fP: (\fI\%ymasson\fP) MySQL state and module broken after upgrade to 3000 (refs: \fI\%#56174\fP)
.IP \(bu 2
\fBPR\fP \fI\%#56174\fP: (\fI\%garethgreenaway\fP) [master] MySQL module fixes
@ \fI2020\-03\-10 04:03:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e913631bb Merge pull request \fI\%#56174\fP from garethgreenaway/56124_mysql_module_state_fixes
.IP \(bu 2
fcc061368b Removing quotes from the plugin_status query.  Updating tests to reflect changes.
.IP \(bu 2
3dc66393b2 Adding better error reporting around plugins.  Updating tests.  Only attempt to delete a user if they exist.
.IP \(bu 2
1337da1e4e Ensure _mysql_user_exists is using auth_socket.  Updating mysql and mariadb chpass functions to ensure that the respective plugins are enabled before attempting to use them.
.IP \(bu 2
34995ba4e8 Reworking the unix_socket code to support the differences between MySQL and MariaDB.  Adding some functions to install, remove, and check the status of plugins which we can then use when adding users which will use the unix_socket & auth_socket plugins. Adding additional tests for these new functions as well as test to ensure the correct SQL is being generated when using passwordless and unix_socket options.
.IP \(bu 2
5bfd67c13e Minor tweak to mysql module.  Fixing failing tests.
.IP \(bu 2
e871a3ffd1 Various fixes to the mysql module to break out the handling of user management into different functions based on MySQL variant.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#56063\fP: (\fI\%terminalmage\fP) [master] Traceback in esxi grain module on import (refs: \fI\%#56094\fP)
.IP \(bu 2
\fBPR\fP \fI\%#56094\fP: (\fI\%dwoz\fP) Fix type error in TornadoImporter
@ \fI2020\-03\-10 01:39:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
211c88bfbc Merge pull request \fI\%#56094\fP from dwoz/fix_56063
.IP \(bu 2
7b1632e8e3 Fix type error in TornadoImporter
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56172\fP: (\fI\%Ch3LL\fP) Only change mine data if using new allow_tgt feature
@ \fI2020\-03\-10 01:34:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb5252fc53 Merge pull request \fI\%#56172\fP from Ch3LL/mine_g
.IP \(bu 2
f4c9c2a5cf Fix docs
.IP \(bu 2
6c914caec8 Use different targeting for windows/linux
.IP \(bu 2
f6348127dc Only change mine data if using new allow_tgt feature
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#56121\fP: (\fI\%githubcdr\fP) salt\-minion broken after upgrade to 3000 (refs: \fI\%#56143\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#51854\fP: (\fI\%Oloremo\fP) Fluorine: minion_pillar_cache: True leads to exception (refs: \fI\%#56143\fP, \fI\%#52195\fP)
.IP \(bu 2
\fBPR\fP \fI\%#56143\fP: (\fI\%waynew\fP) Use encoding when caching pillar data
@ \fI2020\-03\-10 01:33:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#52195\fP: (\fI\%waynew\fP) Use encoding when caching pillar data (refs: \fI\%#56143\fP)
.IP \(bu 2
8a8e9c9c5f Merge pull request \fI\%#56143\fP from waynew/51854\-minion\-pillar\-cache\-exception
.IP \(bu 2
58cc9488aa Merge branch \(aqmaster\(aq into 51854\-minion\-pillar\-cache\-exception
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56082\fP: (\fI\%Ch3LL\fP) Fix saltversioninfo grain for new version
@ \fI2020\-03\-10 01:32:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
9f27caa7d0 Merge pull request \fI\%#56082\fP from Ch3LL/ver_grains
.IP \(bu 2
e6abd6d31b ensure full_info/noc_info work with new versioning
.IP \(bu 2
bcc520ccc4 Add saltversioninfo grains test
.IP \(bu 2
510e149b87 Fix saltversioninfo grain for new version
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56285\fP: (\fI\%UtahDave\fP) Add missing colon.
@ \fI2020\-03\-09 22:22:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
602ff3b9f1 Merge pull request \fI\%#56285\fP from UtahDave/fix_f5_doc
.IP \(bu 2
1034013831 Add missing colon.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56333\fP: (\fI\%Ch3LL\fP) add pylint ignore in django returner
@ \fI2020\-03\-09 20:42:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
de5184a206 Merge pull request \fI\%#56333\fP from Ch3LL/lint_fix
.IP \(bu 2
6a213a429a add pylint ignore in django returner
.IP \(bu 2
759290a055 Use encoding when caching pillar data
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#56080\fP: (\fI\%sagetherage\fP) Update release notes, pip download page and install docs on pycrpto (refs: \fI\%#56095\fP)
.IP \(bu 2
\fBPR\fP \fI\%#56095\fP: (\fI\%waynew\fP) Provide security advisory for PyCrypto
@ \fI2020\-02\-10 18:42:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
9adc2214c3 Merge pull request \fI\%#56095\fP from waynew/crypto\-warning
.IP \(bu 2
484bc51f4b Add warnings to a couple of other places
.IP \(bu 2
2711c04ca9 Provide security advisory for PyCrypto
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56092\fP: (\fI\%twangboy\fP) Add LGPO and Network PRs to changelogs
@ \fI2020\-02\-10 18:17:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
1acd492bb9 Merge pull request \fI\%#56092\fP from twangboy/waynew\-update\-changelog
.IP \(bu 2
4e03620d4e Fix a docs issue
.IP \(bu 2
e7b64277e1 Add LGPO and Network PRs to changelogs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#56115\fP: (\fI\%s0undt3ch\fP) Add information about the pip install salt on windows issue.
@ \fI2020\-02\-10 17:33:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
65d59b0ee9 Merge pull request \fI\%#56115\fP from s0undt3ch/hotfix/release\-notes
.IP \(bu 2
aeac9f36cd Add information about the pip install salt on windows issue.
.IP \(bu 2
a5179434e7 Merge branch \(aqmaster\(aq into pdbedit_55185
.IP \(bu 2
95d46d6cc8 \fI\%#55185\fP pdbedit module should check for version 4.8.x or newer
.UNINDENT
.UNINDENT
.SS Salt 3000.2 Release Notes
.sp
Version 3000.2 is a CVE\-fix release for \fI\%3000\fP\&.
.SS Security Fix
.sp
\fBCVE\-2020\-11651\fP
.sp
An issue was discovered in SaltStack Salt before 2019.2.4 and 3000 before 3000.2.
The salt\-master process ClearFuncs class does not properly validate
method calls. This allows a remote user to access some methods without
authentication. These methods can be used to retrieve user tokens from
the salt master and/or run arbitrary commands on salt minions.
.sp
\fBCVE\-2020\-11652\fP
.sp
An issue was discovered in SaltStack Salt before 2019.2.4 and 3000 before 3000.2.
The salt\-master process ClearFuncs class allows access to some methods
that improperly sanitize paths. These methods allow arbitrary
directory access to authenticated users.
.SS Known Issue
.sp
Part of the fix for CVE\-2020\-11651 added better validation of the methods allowed to be called by remote clients.
Both AESFuncs and ClearFuncs now have an explicit list of methods that can be called.
The name of one of these whitlisted methods on AESFuncs had a typo.
The _minion_runner method should be minion_runner (without the underscore prefix).
This typo breaks the publish module’s runner method.
Calling runners, for example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion publish.runner manage.down
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Will not work, and you will receive and empty reply from the salt master.
.sp
This will be addressed in the 3001 release of Salt set for mid\-June 2020.
.SS Salt 3000.3 Release Notes
.sp
Version 3000.3 is a bug\-fix release for \fI\%3000\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB2\fP
.IP \(bu 2
Total Issue References: \fB2\fP
.IP \(bu 2
Total PR References: \fB2\fP
.IP \(bu 2
Contributors: \fB2\fP (\fI\%dwoz\fP, \fI\%frogunder\fP)
.UNINDENT
.SS Changelog for v3000.2..v3000.3
.sp
\fIGenerated at: 2020\-05\-06 02:53:12 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#57097\fP: (\fI\%frogunder\fP) Update man_pages 3000.3
@ \fI2020\-05\-05 22:13:09 UTC\fP
.IP \(bu 2
\fBISSUE\fP \fI\%#57027\fP: (\fI\%ecarson\fP) [BUG] Master running 2019.2.4 or 3000.2 unable to synchronize files using saltutil.sync_all to 2017.7.1 minion due to CVE fix (refs: \fI\%#57100\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#57016\fP: (\fI\%idontwanttosignin\fP) [BUG] Requested method not exposed: minion_runner (refs: \fI\%#57100\fP)
.IP \(bu 2
\fBPR\fP \fI\%#57100\fP: (\fI\%dwoz\fP) Address Issues in CVE Release
@ \fI2020\-05\-05 22:09:25 UTC\fP
.UNINDENT
.SS Salt 3000.4 Release Notes
.sp
Version 3000.4 is a CVE fix release for \fI\%3000\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Prevent shell injections in netapi ssh client (cve\-2020\-16846)
.IP \(bu 2
Prevent creating world readable private keys with the tls execution module. (cve\-2020\-17490)
.UNINDENT
.SS Salt 3000.5 Release Notes
.sp
Version 3000.5 is a CVE fix release for \fI\%3000\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Properly validate eauth credentials and tokens along with their ACLs.
Prior to this change eauth was not properly validated when calling
Salt ssh via the salt\-api. Any value for \(aqeauth\(aq or \(aqtoken\(aq would allow a user
to bypass authentication and make calls to Salt ssh. (CVE\-2020\-25592)
.UNINDENT
.SS Salt 3000.6 Release Notes
.sp
Version 3000.6 is a bugfix release for \fI\%3000\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fixes salt\-ssh authentication when using tty (#58922)
.UNINDENT
.SS Salt 3000.7 Release Notes
.sp
Version 3000.7 is a CVE fix release for \fI\%3000\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
CVE\-2020\-28243 \- Fix local privilege escalation in the restartcheck module.
.IP \(bu 2
CVE\-2020\-28972 \- Ensure authentication to vcenter, vsphere, and esxi server
validates the SSL/TLS certificate by default. If you want to skip SSL verification
you can use \fIverify_ssl: False\fP\&.
.IP \(bu 2
CVE\-2020\-35662 \- Ensure the asam runner, qingcloud, splunk returner, panos
proxy, cimc proxy, zenoss module, esxi module, vsphere module, glassfish
module, bigip module, and keystone module validate SSL by default. If you want
to skip SSL verification you can use \fIverify_ssl: False\fP\&.
.IP \(bu 2
CVE\-2021\-3148 \- Fix a command injection in the Salt\-API when using the
Salt\-SSH client.
.IP \(bu 2
CVE\-2021\-3144 \- Fix eauth tokens can be used once after expiration
.IP \(bu 2
CVE\-2021\-25281 \- Fix salt\-api so it honors eauth credentials for the
wheel_async client.
.IP \(bu 2
CVE\-2021\-25282 \- Fix the salt.wheel.pillar_roots.write method so it is not
vulnerable to directory traversal.
.IP \(bu 2
CVE\-2021\-25283 \- Fix the jinja render to protect against server side template
injection attacks.
.IP \(bu 2
CVE\-2021\-25284 \- Fix cmdmod so it will not log credentials to log levels info
and error.
.IP \(bu 2
CVE\-2021\-3197 \- Fix ssh client to remove ProxyCommand from arguments provided
by cli and netapi.
.UNINDENT
.SS Salt 3000.8 Release Notes
.sp
Version 3000.8 is a bug fix release for \fI\%3000\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fix runners that broke when patching for CVE\-2021\-25281
.IP \(bu 2
Fix issue with runners in SSE
.UNINDENT
.SS Known Issue
.sp
When using the Salt\-API with the SSH client some of the SSH options are not working currently and will be fixed in an upcoming bug fix release.
We are currently testing and fixing which options still need to be fixed, but have confirmed the following ones do not work in this release: extra\-filerefs, pre\-flight.
This does not impact normal Salt\-SSH usage on the cli.
.SS Salt 3000.9 Release Notes
.sp
Version 3000.9 is a bug fix release for \fI\%3000\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Allow \(dqextra_filerefs\(dq as sanitized kwargs for SSH client.
Fix regression on \(dqcmd.run\(dq when passing tuples as cmd. (#59664)
.IP \(bu 2
Allow all ssh kwargs as sanitized kwargs for SSH client. (#59748)
.IP \(bu 2
Fix argument injection bug in restartcheck.restartcheck. This change hardens
the fix for CVE\-2020\-28243.
.UNINDENT
.SS Salt 2019.2.0 Release Notes \- Codename Fluorine
.SS Python 2.7 Deprecation
.sp
In light of Python 2.7 reaching its End of Life (EOL) on Jan 1st 2020,
Python 2 will be deprecated from SaltStack no earlier than the 3001
release, that is either the 3001 release or a later release.
This decision is pending further community discussion.
.SS Known Issues
.sp
The following are known issues for the 2019.2.0 release and will be fixed for 2019.2.1:
.INDENT 0.0
.IP \(bu 2
\fI\%#51699\fP
.UNINDENT
.SS Non\-Backward\-Compatible Change to YAML Renderer
.sp
In earlier releases, this was considered valid usage in Python 2, assuming that
\fBdata\fP was a list or dictionary containing keys/values which are \fBunicode\fP
types:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.managed:
    \- source: salt://foo.conf.jinja
    \- template: jinja
    \- context:
        data: {{ data }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
One common use case for this is when using one of Salt\(aqs \fI\%custom
Jinja filters\fP which return lists or dictionaries, such
as the \fI\%ipv4\fP filter.
.sp
In Python 2, Jinja will render the \fBunicode\fP string types within the
list/dictionary with the \(dqu\(dq prefix (e.g. \fB{u\(aqfoo\(aq: u\(aqbar\(aq}\fP). While not
valid YAML, earlier releases would successfully load these values.
.sp
As of this release, the above SLS would result in an error message. To allow
for a data structure to be dumped directly into your SLS file, use the \fI\%tojson
Jinja filter\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.managed:
    \- source: salt://foo.conf.jinja
    \- template: jinja
    \- context:
        data: {{ data|tojson }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Another example where the new filter needs to be used is the following state example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grafana_packages:
  pkg.installed:
  \- names: {{ server.pkgs }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will fail when pkgs is a list or dictionary. You will need to update the state:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grafana_packages:
  pkg.installed:
  \- names: {{ server.pkgs|tojson }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This test case has also been tested with the \fByaml\fP and \fBjson\fP filters successfully.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This filter was added in Jinja 2.9. However, fear not! The 2018.3.3 release
added a \fBtojson\fP filter which will be used if this filter is not already
present, making it available on platforms like RHEL 7 and Ubuntu 14.04
which provide older versions of Jinja.
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
The \fI\%json_encode_dict\fP and \fI\%json_encode_list\fP filters
do not actually dump the results to JSON. Since \fBtojson\fP accomplishes
what those filters were designed to do, they are now deprecated and will be
removed in the 3000 release. The \fBtojson\fP filter should be used in all
cases where \fI\%json_encode_dict\fP and \fI\%json_encode_list\fP
would have been used.
.UNINDENT
.UNINDENT
.SS Ansible Playbook State and Execution Modules
.sp
Along with the including the \fBansible modules\fP in the Oxygen release, running playbooks has been
added in 2019.2.0 with the \fI\%playbooks function\fP\&.  This also includes an \fI\%ansible
playbooks state module\fP which can be used
on a targeted host to run ansible playbooks, or used in an
orchestration state runner.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
install nginx:
  ansible.playbooks:
    \- name: install.yml
    \- git_repo: git://github.com/gtmanfred/playbook.git
    \- git_kwargs:
        rev: master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The playbooks modules also includes the ability to specify a git repo to clone
and use, or a specific directory can to used when running the playbook.
.SS Network Automation
.sp
Beginning with this release, Salt provides much broader support for a variety
of network operating systems, and features for configuration manipulation or
operational command execution.
.SS NetBox
.sp
Added in the previous release, 2018.3.0, the capabilities of the
\fI\%netbox\fP Execution Module have been extended, with a
much longer list of available features:
.INDENT 0.0
.IP \(bu 2
\fI\%netbox.create_circuit\fP
.IP \(bu 2
\fI\%netbox.create_circuit_provider\fP
.IP \(bu 2
\fI\%netbox.create_circuit_termination\fP
.IP \(bu 2
\fI\%netbox.create_circuit_type\fP
.IP \(bu 2
\fI\%netbox.create_device\fP
.IP \(bu 2
\fI\%netbox.create_device_role\fP
.IP \(bu 2
\fI\%netbox.create_device_type\fP
.IP \(bu 2
\fI\%netbox.create_interface\fP
.IP \(bu 2
\fI\%netbox.create_interface_connection\fP
.IP \(bu 2
\fI\%netbox.create_inventory_item\fP
.IP \(bu 2
\fI\%netbox.create_ipaddress\fP
.IP \(bu 2
\fI\%netbox.create_manufacturer\fP
.IP \(bu 2
\fI\%netbox.create_platform\fP
.IP \(bu 2
\fI\%netbox.create_site\fP
.IP \(bu 2
\fI\%netbox.delete_interface\fP
.IP \(bu 2
\fI\%netbox.delete_inventory_item\fP
.IP \(bu 2
\fI\%netbox.delete_ipaddress\fP
.IP \(bu 2
\fI\%netbox.get_circuit_provider\fP
.IP \(bu 2
\fI\%netbox.get_interfaces\fP
.IP \(bu 2
\fI\%netbox.get_ipaddresses\fP
.IP \(bu 2
\fI\%netbox.make_interface_child\fP
.IP \(bu 2
\fI\%netbox.make_interface_lag\fP
.IP \(bu 2
\fI\%netbox.openconfig_interfaces\fP
.IP \(bu 2
\fI\%netbox.openconfig_lacp\fP
.IP \(bu 2
\fI\%netbox.update_device\fP
.IP \(bu 2
\fI\%netbox.update_interface\fP
.UNINDENT
.sp
Besides this Execution Module, Salt users can load data directly from NetBox
into the device Pillar, via the \fI\%netbox\fP External
Pillar module.
.SS Netmiko
.sp
\fI\%Netmiko\fP, the multi\-vendor library to
simplify Paramiko SSH connections to network devices, is now officially
integrated into Salt. The network community can use it via the
\fI\%netmiko\fP Proxy Module or directly from any Salt
Minions, passing the connection credentials \- see the documentation for the
\fI\%netmiko\fP Execution Module.
.SS Arista
.sp
Arista switches can now be managed running under the \fI\%pyeapi\fP Proxy Module, and execute RPC requests via the
\fI\%pyeapi\fP Execution Module.
.SS Cisco Nexus
.sp
While support for SSH\-based operations has been added in the release codename
Carbon (2016.11), the new \fI\%nxos_api\fP Proxy Module
and \fI\%nxos_api\fP allow management of Cisco Nexus
switches via the NX\-API.
.sp
It is important to note that these modules don\(aqt have third party dependencies,
therefore they can be used straight away from any Salt Minion. This also means
that the user may be able to install the regular Salt Minion on the Nexus
switch directly and manage the network devices like a regular server.
.SS General\-purpose Modules
.sp
The new \fI\%ciscoconfparse\fP Execution Module
can  be used for basic configuration parsing, audit or validation for a variety
of  network platforms having Cisco IOS style configuration (one space
indentation), as well as brace\-delimited configuration style.
.sp
The \fI\%iosconfig\fP can be used for various
configuration manipulation for Cisco IOS style configuration, such as:
\fI\%configuration cleanup\fP,
\fI\%tree representation of the config\fP, etc.
.SS NAPALM
.SS Commit At and Commit Confirmed
.sp
Beginning with this release, NAPALM users are able to execute scheduled commits
(broadly known as \(dqcommit at\(dq) and \(dqcommit confirmed\(dq (revert the configuration
change unless the user confirms by running another command). These features are
available via the \fBcommit_in\fP, \fBcommit_at\fP, \fBrevert_in\fP, or \fBrevert_at\fP
arguments for the
\fI\%net.load_config\fP and
\fI\%net.load_template\fP execution
functions, or \fI\%netconfig.managed\fP\&.
.sp
The counterpart execution functions
\fI\%net.confirm_commit\fP, or
\fI\%net.cancel_commit\fP, as well
as the State functions
\fI\%netconfig.commit_cancelled\fP, or
\fI\%netconfig.commit_confirmed\fP can
be used to confirm or cancel a commit.
.sp
Please note that the commit confirmed and commit cancelled functionalities are
available for any platform whether the network devices supports the features
natively or not. However, be cautious and make sure you read and understand the
caveats before using them in production.
.SS Multiple Templates Rendered Simultaneously
.sp
The \fBtemplate_name\fP argument of the
\fI\%net.load_template\fP Execution
and \fI\%netconfig.managed\fP State function now
supports a list of templates. This is particularly useful when a very large
Jinja template is split into multiple smaller and easier to read templates that
can eventually be reused in other States. For example, the following syntax is
not correct to manage the configuration of NTP and BGP simultaneously, using
two different templates and changing the device configuration through one
single commit:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
manage_bgp_and_ntp:
  netconfig.managed:
    \- template_name:
        \- salt://templates/bgp.jinja
        \- salt://templates/ntp.jinja
    \- context:
        bpg: {{ pillar.bgp }}
        ntp: {{ pillar.ntp }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Connection Re\-establishment on Demand
.sp
Beginning with this release, any NAPALM command executed when
running under a NAPALM Proxy Minion supports the \fBforce_reconnect\fP
magic argument.
.sp
Proxy Minions generally establish a connection with the remote network
device at the time of the Minion startup and that connection is going to be
used forever.
.sp
If one would need to execute a command on the device but is connecting using
different parameters (due to various causes, e.g., unable to authenticate
the user specified in the Pillar as the authentication system \- say
TACACS+ is not available, or the DNS resolver is currently down and would
like to temporarily use the IP address instead, etc.), it implies updating
the Pillar data and restarting the Proxy Minion process restart.
In particular cases like that, you can pass the \fBforce_reconnect=True\fP
keyword argument, together with the alternative connection details, to
enforce the command to be executed over a separate connection.
.sp
For example, if the usual command is \fBsalt \(aq*\(aq net.arp\fP, you can use the
following to connect using a different username instead:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.arp username=my\-alt\-usr force_reconnect=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The same goes with any of the other configuration arguments required for the
NAPALM connection \- see \fI\%NAPALM proxy documentation\fP\&.
.SS Configuration Replace Features
.sp
To replace various configuration chunks, you can use the new
\fI\%net.replace_pattern\fP
execution function, or the
\fI\%netconfig.replace_pattern\fP State
function. For example, if you want to update your configuration and rename
a BGP policy referenced in many places, you can do so by running:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq net.replace_pattern OLD\-POLICY\-CONFIG new\-policy\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Similarly, you can also replace entire configuration blocks using the
\fI\%net.blockreplace\fP function.
.SS Configuration Save Features
.sp
The \fI\%net.save_config\fP function
can be used to save the configuration of the managed device into a file. For
the State subsystem, the \fI\%netconfig.saved\fP
function has been added which provides a complete list of facilities when
managing the target file where the configuration of the network device can be
saved.
.sp
For example, backup the running configuration of each device under its own
directory tree:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/var/backups/{{ opts.id }}/running.cfg:
  netconfig.saved:
    \- source: running
    \- makedirs: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
All the new network automation modules mentioned above are directly exposed to
the NAPALM users, without requiring any architectural changes, just eventually
install some requirements:
.SS Junos
.sp
The features from the existing \fI\%junos\fP Execution
Module are available via the following functions:
.INDENT 0.0
.IP \(bu 2
\fI\%napalm.junos_cli\fP: Execute a CLI
command and return the output as text or Python dictionary.
.IP \(bu 2
\fI\%napalm.junos_rpc\fP: Execute an RPC
request on the remote Junos device, and return the result as a Python
dictionary, easy to digest and manipulate.
.IP \(bu 2
\fI\%napalm.junos_install_os\fP:
Install the given image on the device.
.IP \(bu 2
\fI\%napalm.junos_facts\fP: The complete
list of Junos facts collected by the \fBjunos\-eznc\fP underlying library.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To be able to use these features, you muse ensure that you meet the
requirements for the \fI\%junos\fP module. As
\fBjunos\-eznc\fP is already a dependency of NAPALM, you will only have to
install \fBjxmlease\fP\&.
.UNINDENT
.UNINDENT
.sp
Usage examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.junos_cli \(aqshow arp\(aq format=xml
salt \(aq*\(aq napalm.junos_rpc get\-interface\-information
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Netmiko
.sp
The features from the newly added \fI\%netmiko\fP
Execution Module are available as:
.INDENT 0.0
.IP \(bu 2
\fI\%napalm.netmiko_commands\fP:
Execute one or more commands to be execute on the remote device, via Netmiko,
and return the output as a text.
.IP \(bu 2
\fI\%napalm.netmiko_config\fP: Load
a list of configuration command on the remote device, via Netmiko. The
commands can equally be loaded from a local or remote path, and passed
through Salt\(aqs template rendering pipeline (by default using \fBJinja\fP as the
template rendering engine).
.UNINDENT
.sp
Usage examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.netmiko_commands \(aqshow version\(aq \(aqshow interfaces\(aq
salt \(aq*\(aq napalm.netmiko_config config_file=https://bit.ly/2sgljCB
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Arista pyeapi
.sp
For various operations and various extension modules, the following features
have been added to gate functionality from the
\fI\%pyeapi\fP module:
.INDENT 0.0
.IP \(bu 2
\fI\%napalm.pyeapi_run_commands\fP: Execute a list of commands on
the Arista switch, via the \fBpyeapi\fP library.
.IP \(bu 2
\fI\%napalm.pyeapi_config\fP:
Configure the Arista switch with the specified commands, via the \fBpyeapi\fP
Python library. Similarly to
\fI\%napalm.netmiko_config\fP, you
can use both local and remote files, with or without templating.
.UNINDENT
.sp
Usage examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.pyeapi_run_commands \(aqshow version\(aq \(aqshow interfaces\(aq
salt \(aq*\(aq napalm.pyeapi_config config_file=salt://path/to/template.jinja
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Cisco NX\-API
.sp
In the exact same way as above, the user has absolute control by using the
following primitives to manage Cisco Nexus switches via the NX\-API:
.INDENT 0.0
.IP \(bu 2
\fI\%napalm.nxos_api_show\fP: Execute
one or more show (non\-configuration) commands, and return the output as plain
text or Python dictionary.
.IP \(bu 2
\fI\%napalm.nxos_api_rpc\fP: Execute
arbitrary RPC requests via the Nexus API.
.IP \(bu 2
\fI\%napalm.nxos_api_config\fP:
Configures the Nexus switch with the specified commands, via the NX\-API. The
commands can be loaded from the command line, or a local or remote file,
eventually rendered using the templating engine of choice (default:
\fBjinja\fP).
.UNINDENT
.sp
Usage examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.nxos_api_show \(aqshow bgp sessions\(aq \(aqshow processes\(aq raw_text=False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Ciscoconfparse
.sp
The following list of function may be handy when manipulating Cisco IOS or
Junos style configurations:
.INDENT 0.0
.IP \(bu 2
\fI\%napalm.config_filter_lines\fP: Return a list of detailed
matches, for the configuration blocks (parent\-child relationship) whose
parent and children respect the regular expressions provided.
.IP \(bu 2
\fI\%napalm.config_find_lines\fP:
Return the configuration lines that match the regular expression provided.
.IP \(bu 2
\fI\%napalm.config_lines_w_child\fP:
Return the configuration lines that match a regular expression, having child
lines matching the child regular expression.
.IP \(bu 2
\fI\%napalm.config_lines_wo_child\fP:
Return the configuration lines that match a regular expression, that don\(aqt
have child lines matching the child regular expression.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
These functions require the \fBciscoconfparse\fP Python library to be
installed.
.UNINDENT
.UNINDENT
.sp
Usage example (find interfaces that are administratively shut down):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq napalm.config_lines_w_child \(aqinterface\(aq \(aqshutdown\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS IOSConfig
.sp
For Cisco IOS style configuration, the following features have been added to
the \fI\%napalm\fP Execution Module:
.INDENT 0.0
.IP \(bu 2
\fI\%napalm.config_tree\fP: Transform
Cisco IOS style configuration to structured Python dictionary, using the
configuration of the interrogated network device.
.IP \(bu 2
\fI\%napalm.config_merge_tree\fP:
Return the merge tree of the configuration of the managed network device with
a different configuration to be merged with (without actually loading any
changes on the device).
.IP \(bu 2
\fI\%napalm.config_merge_text\fP:
Return the merge result (as text) of the configuration of the managed network
device with a different configuration to be merged with.
.IP \(bu 2
\fI\%napalm.config_merge_diff\fP:
Return the merge diff after merging the configuration of the managed network
device with a different configuration (without actually loading any changes
on the device).
.UNINDENT
.SS SCP
.sp
Reusing the already available connection credentials provided for NAPALM, the
following features are now available:
.INDENT 0.0
.IP \(bu 2
\fI\%napalm.scp_put\fP: Transfer files and
directories to remote network device.
.IP \(bu 2
\fI\%napalm.scp_get\fP: Transfer files and
directories from remote network device to the localhost of the Minion.
.UNINDENT
.SS PeeringDB
.sp
The \fI\%peeringdb\fP Execution Module is useful to
gather information about other networks you can potentially peer with, and
automatically establish BGP sessions, e.g., given just a specific AS number,
the rest of the data (i.e., IP addresses, locations where the remote network is
available, etc.) is retrieved from PeeringDB, and the session configuration is
automated with minimal to no effort (typing the IP addresses manually can be
both tedious and error prone).
.SS New Docker Proxy Minion
.sp
Docker containers can now be treated as actual minions without installing salt
in the container, using the new \fI\%docker proxy minion\fP\&.
.sp
This proxy minion uses the \fI\%docker executor\fP to
pass commands to the docker container using \fI\%docker.call\fP\&.  Any state module calls are passed through the
corresponding function from the \fI\%docker\fP
module.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
proxy:
  proxytype: docker
  name: keen_proskuriakova
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Terraform Salt\-SSH Roster
.sp
You can now dynamically generate a Salt\-SSH roster from the terraform resources
defined with \fI\%terraform\-provider\-salt\fP\&.
.sp
This allows you to combine both terraform and Salt\-SSH to provision and
configure your hosts. See the \fI\%terraform roster\fP for
an example on how to setup and use.
.SS Grains Dictionary Passed into Custom Grains
.sp
Starting in this release, if a custom grains function accepts a variable named
\fBgrains\fP, the Grains dictionary of the already compiled grains will be passed
in.  Because of the non\-deterministic order that grains are rendered in, the
only grains that can be relied upon to be passed in are \fBcore.py\fP grains,
since those are compiled first.
.SS More Precise \fBvirtual\fP Grain
.sp
This release improves the accuracy of the \fBvirtual\fP grain when running Salt in
a nested virtualization environment (e.g. \fBsystemd\-nspawn\fP container inside a
VM) and having \fBvirt\-what\fP installed.
.sp
Until now, the \fBvirtual\fP grain was determined by matching against all output
lines of \fBvirt\-what\fP instead of individual items which could lead to not quite
precise results (e.g. reporting \fBHyperV\fP inside a \fBsystemd\-nspawn\fP container
running within a Hyper\-V\-based VM.
.SS Configurable Module Environment
.sp
Salt modules (states, execution modules, returners, etc.) now can have custom
environment variables applied when running shell commands. This can be
configured by setting a \fBsystem\-environment\fP key either in Grains or Pillar.
The syntax is as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
system\-environment:
  <type>
    <module>:
      # Namespace for all functions in the module
      _:
        <key>: <value>

      # Namespace only for particular function in the module
      <function>:
        <key>: <value>
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
\fB<type>\fP would be the type of module (i.e. \fBstates\fP, \fBmodules\fP, etc.).
.IP \(bu 2
\fB<module>\fP would be the module\(aqs name.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
The module name can be either the virtual name (e.g. \fBpkg\fP), or the
physical name (e.g. \fByumpkg\fP).
.UNINDENT
.UNINDENT
.IP \(bu 2
\fB<function>\fP would be the function name within that module. To apply
environment variables to \fIall\fP functions in a given module, use an underscore
(i.e. \fB_\fP) as the function name. For example, to set the same environment
variable for all package management functions, the following could be used:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
system\-environment:
  modules:
    pkg:
      _:
        SOMETHING: for_all
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To set an environment variable in \fBpkg.install\fP only:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
system\-environment:
  modules:
    pkg:
      install:
        LC_ALL: en_GB.UTF\-8
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To set the same variable but only for SUSE minions (which use zypper for
package management):
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
system\-environment:
  modules:
    zypper:
      install:
        LC_ALL: en_GB.UTF\-8
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is not supported throughout Salt; the module must explicitly support
this feature (though this may change in the future). As of this release,
the only modules which support this are the following \fBpkg\fP virtual
modules:
.INDENT 0.0
.IP \(bu 2
\fI\%aptpkg\fP
.IP \(bu 2
\fI\%yumpkg\fP
.IP \(bu 2
\fBzypper\fP
.UNINDENT
.UNINDENT
.UNINDENT
.SS \(dqVirtual Package\(dq Support Dropped for APT
.sp
In APT, some packages have an associated list of packages which they provide.
This allows one to do things like run \fBapt\-get install foo\fP when the real
package name is \fBfoo1.0\fP, and get the right package installed.
.sp
Salt has traditionally designated as \(dqvirtual packages\(dq those which are
provided by an installed package, but for which there is no real package by
that name installed. Given the above example, if one were to run a
\fI\%pkg.installed\fP state for a package named
\fBfoo\fP, then \fI\%pkg.list_pkgs\fP would
show a package version of simply \fB1\fP for package \fBfoo\fP, denoting that it is
a virtual package.
.sp
However, while this makes certain aspects of package management convenient,
there are issues with this approach that make relying on \(dqvirtual packages\(dq
problematic. For instance, Ubuntu has four different mutually\-conflicting
packages for \fBnginx\fP:
.INDENT 0.0
.IP \(bu 2
\fI\%nginx\-core\fP
.IP \(bu 2
\fI\%nginx\-full\fP
.IP \(bu 2
\fI\%nginx\-light\fP
.IP \(bu 2
\fI\%nginx\-extras\fP
.UNINDENT
.sp
All four of these provide \fBnginx\fP\&. Yet there is an \fI\%nginx\fP package as well,
which has no actual content and merely has dependencies on any one of the above
four packages. If one used \fBnginx\fP in a \fI\%pkg.installed\fP state, and none of the above four packages were
installed, then the \fI\%nginx\fP metapackage would be installed, which would pull in
\fInginx\-core_\fP\&.  Later, if \fBnginx\fP were used in a \fI\%pkg.removed\fP state, the \fI\%nginx\fP metapackage would be removed,
leaving \fI\%nginx\-core\fP installed. The result would be that, since \fInginx\-core_\fP
provides \fInginx_\fP, Salt would now see \fI\%nginx\fP as an installed virtual package,
and the \fI\%pkg.removed\fP state would fail.
Moreover, \fInginx would not actually have been removed\fP, since \fI\%nginx\-core\fP would
remain installed.
.sp
Starting with this release, Salt will no longer support using \(dqvirtual package\(dq
names in \fBpkg\fP states, and package names will need to be specified using the
proper package name. The \fI\%pkg.list_repo_pkgs\fP function can be used to find matching
package names in the repositories, given a package name (or glob):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt myminion pkg.list_repo_pkgs \(aqnginx*\(aq
myminion:
    \-\-\-\-\-\-\-\-\-\-
    nginx:
        \- 1.10.3\-0ubuntu0.16.04.2
        \- 1.9.15\-0ubuntu1
    nginx\-common:
        \- 1.10.3\-0ubuntu0.16.04.2
        \- 1.9.15\-0ubuntu1
    nginx\-core:
        \- 1.10.3\-0ubuntu0.16.04.2
        \- 1.9.15\-0ubuntu1
    nginx\-core\-dbg:
        \- 1.10.3\-0ubuntu0.16.04.2
        \- 1.9.15\-0ubuntu1
    nginx\-doc:
        \- 1.10.3\-0ubuntu0.16.04.2
        \- 1.9.15\-0ubuntu1
    nginx\-extras:
        \- 1.10.3\-0ubuntu0.16.04.2
        \- 1.9.15\-0ubuntu1
    nginx\-extras\-dbg:
        \- 1.10.3\-0ubuntu0.16.04.2
        \- 1.9.15\-0ubuntu1
    nginx\-full:
        \- 1.10.3\-0ubuntu0.16.04.2
        \- 1.9.15\-0ubuntu1
    nginx\-full\-dbg:
        \- 1.10.3\-0ubuntu0.16.04.2
        \- 1.9.15\-0ubuntu1
    nginx\-light:
        \- 1.10.3\-0ubuntu0.16.04.2
        \- 1.9.15\-0ubuntu1
    nginx\-light\-dbg:
        \- 1.10.3\-0ubuntu0.16.04.2
        \- 1.9.15\-0ubuntu1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternatively, the newly\-added \fI\%pkg.show\fP
function can be used to get more detailed information about a given package and
help determine what package name is correct:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt myminion pkg.show \(aqnginx*\(aq filter=description,provides
myminion:
    \-\-\-\-\-\-\-\-\-\-
    nginx:
        \-\-\-\-\-\-\-\-\-\-
        1.10.3\-0ubuntu0.16.04.2:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                small, powerful, scalable web/proxy server
        1.9.15\-0ubuntu1:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                small, powerful, scalable web/proxy server
    nginx\-common:
        \-\-\-\-\-\-\-\-\-\-
        1.10.3\-0ubuntu0.16.04.2:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                small, powerful, scalable web/proxy server \- common files
        1.9.15\-0ubuntu1:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                small, powerful, scalable web/proxy server \- common files
    nginx\-core:
        \-\-\-\-\-\-\-\-\-\-
        1.10.3\-0ubuntu0.16.04.2:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (core version)
            Provides:
                httpd, httpd\-cgi, nginx
        1.9.15\-0ubuntu1:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (core version)
            Provides:
                httpd, httpd\-cgi, nginx
    nginx\-core\-dbg:
        \-\-\-\-\-\-\-\-\-\-
        1.10.3\-0ubuntu0.16.04.2:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (core version) \- debugging symbols
        1.9.15\-0ubuntu1:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (core version) \- debugging symbols
    nginx\-doc:
        \-\-\-\-\-\-\-\-\-\-
        1.10.3\-0ubuntu0.16.04.2:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                small, powerful, scalable web/proxy server \- documentation
        1.9.15\-0ubuntu1:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                small, powerful, scalable web/proxy server \- documentation
    nginx\-extras:
        \-\-\-\-\-\-\-\-\-\-
        1.10.3\-0ubuntu0.16.04.2:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (extended version)
            Provides:
                httpd, httpd\-cgi, nginx
        1.9.15\-0ubuntu1:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (extended version)
            Provides:
                httpd, httpd\-cgi, nginx
    nginx\-extras\-dbg:
        \-\-\-\-\-\-\-\-\-\-
        1.10.3\-0ubuntu0.16.04.2:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (extended version) \- debugging symbols
        1.9.15\-0ubuntu1:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (extended version) \- debugging symbols
    nginx\-full:
        \-\-\-\-\-\-\-\-\-\-
        1.10.3\-0ubuntu0.16.04.2:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (standard version)
            Provides:
                httpd, httpd\-cgi, nginx
        1.9.15\-0ubuntu1:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (standard version)
            Provides:
                httpd, httpd\-cgi, nginx
    nginx\-full\-dbg:
        \-\-\-\-\-\-\-\-\-\-
        1.10.3\-0ubuntu0.16.04.2:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (standard version) \- debugging symbols
        1.9.15\-0ubuntu1:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (standard version) \- debugging symbols
    nginx\-light:
        \-\-\-\-\-\-\-\-\-\-
        1.10.3\-0ubuntu0.16.04.2:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (basic version)
            Provides:
                httpd, httpd\-cgi, nginx
        1.9.15\-0ubuntu1:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (basic version)
            Provides:
                httpd, httpd\-cgi, nginx
    nginx\-light\-dbg:
        \-\-\-\-\-\-\-\-\-\-
        1.10.3\-0ubuntu0.16.04.2:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (basic version) \- debugging symbols
        1.9.15\-0ubuntu1:
            \-\-\-\-\-\-\-\-\-\-
            Description:
                nginx web/proxy server (basic version) \- debugging symbols
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Minion Startup Events
.sp
When a minion starts up it sends a notification on the event bus with a tag
that looks like this: \fBsalt/minion/<minion_id>/start\fP\&. For historical reasons
the minion also sends a similar event with an event tag like this:
\fBminion_start\fP\&. This duplication can cause a lot of clutter on the event bus
when there are many minions. Set \fBenable_legacy_startup_events: False\fP in the
minion config to ensure only the \fBsalt/minion/<minion_id>/start\fP events are
sent.
.sp
The new \fI\%enable_legacy_startup_events\fP minion config option
defaults to \fBTrue\fP, but will be set to default to \fBFalse\fP beginning with
the 3001 release of Salt.
.sp
The Salt Syndic currently sends an old style \fBsyndic_start\fP event as well. The
syndic respects \fI\%enable_legacy_startup_events\fP as well.
.SS Failhard changes
.sp
It is now possible to override a global failhard setting with a state\-level
failhard setting. This is most useful in case where global failhard is set to
\fBTrue\fP and you want the execution not to stop for a specific state that
could fail, by setting the state level failhard to \fBFalse\fP\&.
This also allows for the use of \fBonfail*\fP\-requisites, which would previously
be ignored when a global failhard was set to \fBTrue\fP\&.
This is a deviation from previous behavior, where the global failhard setting
always resulted in an immediate stop whenever any state failed (regardless
of whether the failing state had a failhard setting of its own, or whether
any \fBonfail*\fP\-requisites were used).
.SS Pass Through Options to \fI\%file.serialize\fP State
.sp
This allows for more granular control over the way in which the dataset is
serialized. See the documentation for the new \fBserializer_opts\fP and
\fBdeserializer_opts\fP options in the \fI\%file.serialize\fP state for more information.
.SS \fBfile.patch\fP State Rewritten
.sp
The \fBfile.patch\fP state has been rewritten with
several new features:
.INDENT 0.0
.IP \(bu 2
Patch sources can now be remote files instead of only \fBsalt://\fP URLs
.IP \(bu 2
Multi\-file patches are now supported
.IP \(bu 2
Patch files can be templated
.UNINDENT
.sp
In addition, it is no longer necessary to specify what the hash of the patched
file should be.
.SS New no_proxy Minion Configuration
.sp
Pass a list of hosts using the \fBno_proxy\fP minion config option to bypass an HTTP
proxy.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This key does nothing unless proxy_host is configured and it does not support
any kind of wildcards.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
no_proxy: [ \(aq127.0.0.1\(aq, \(aqfoo.tld\(aq ]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Changes to \fI\%slack\fP Engine
.sp
The output returned to Slack from functions run using this engine is now
formatted using that function\(aqs proper outputter. Earlier releases would format
the output in YAML for all functions except for when states were run.
.SS Enhancements to \fI\%wtmp\fP Beacon
.sp
A new key, \fBaction\fP, has been added to the events fired by this beacon, which
will contain either the string \fBlogin\fP or \fBlogout\fP\&. This will simplify
reactors which use this beacon\(aqs data, as it will no longer be necessary to
check the integer value of the \fBtype\fP key to know whether the event is a
login or logout.
.sp
Additionally, in the event that your platform has a non\-standard \fButmp.h\fP,
you can now configure which type numbers indicate a login and logout.
.sp
See the \fI\%wtmp beacon documentation\fP for more
information.
.SS Deprecated and Removed Options
.SS API Removed Arguments
.sp
Support for \fI\%LocalClient\fP\(aqs \fBexpr_form\fP argument has
been removed. Please use \fBtgt_type\fP instead. This change was made due to
numerous reports of confusion among community members, since the targeting
method is published to minions as \fBtgt_type\fP, and appears as \fBtgt_type\fP
in the job cache as well.
.sp
Those who are using the \fI\%LocalClient\fP (either directly,
or implicitly via a \fI\%netapi module\fP) need to update
their code to use \fBtgt_type\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
>>> import salt.client
>>> local = salt.client.LocalClient()
>>> local.cmd(\(dq*\(dq, \(dqcmd.run\(dq, [\(dqwhoami\(dq], tgt_type=\(dqglob\(dq)
{\(aqjerry\(aq: \(aqroot\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Minion Configuration Deprecated Option
.sp
The \fI\%master_shuffle\fP configuration option is deprecated as of the
\fB2019.2.0\fP release. Please use the \fI\%random_master\fP option instead.
.SS Module Removed Options
.INDENT 0.0
.IP \(bu 2
The \fI\%napalm_network\fP module has been
changed as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Support for the \fBtemplate_path\fP has been removed from
\fI\%net.load_template\fP
function. This is because support for NAPALM native templates has been
dropped.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
The \fI\%pip\fP module has been changed as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Support for the \fBno_chown\fP option has been removed from
\fI\%pip.install\fP function.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
The \fI\%trafficserver\fP module has been
changed as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The \fBtrafficserver.match_var\fP function was removed. Please use
\fI\%trafficserver.match_metric\fP instead.
.IP \(bu 2
The \fBtrafficserver.read_var\fP function was removed. Please use
\fI\%trafficserver.read_config\fP instead.
.IP \(bu 2
The \fBtrafficserver.set_var\fP function was removed. Please use
\fI\%trafficserver.set_config\fP instead.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
The \fBwin_update\fP module has been removed. It has been replaced by
\fI\%win_wua\fP\&.
.IP \(bu 2
The \fI\%win_wua\fP module has been changed as
follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The \fBwin_wua.download_update\fP and \fBwin_wua.download_updates\fP
functions have been removed. Please use \fI\%win_wua.download\fP instead.
.IP \(bu 2
The \fBwin_wua.install_update\fP and \fBwin_wua.install_updates\fP
functions have been removed. Please use \fI\%win_wua.install\fP instead.
.IP \(bu 2
The \fBwin_wua.list_update\fP function has been removed. Please use
functions have been removed. Please use \fI\%win_wua.get\fP instead.
.IP \(bu 2
The \fBwin_wua.list_updates\fP function has been removed. Please use
functions have been removed. Please use \fBwin_wua.list\fP instead.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Pillar Removed Option
.INDENT 0.0
.IP \(bu 2
The \fI\%vault\fP external pillar has been changed as
follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Support for the \fBprofile\fP argument was removed. Any options passed up
until and following the first \fBpath=\fP are discarded.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Roster Removed Option
.INDENT 0.0
.IP \(bu 2
The \fI\%cache\fP roster has been changed as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Support for \fBroster_order\fP as a list or tuple has been removed. As of
the \fB2019.2.0\fP release, \fBroster_order\fP must be a dictionary.
.IP \(bu 2
The \fBroster_order\fP option now includes IPv6 in addition to IPv4 for the
\fBprivate\fP, \fBpublic\fP, \fBglobal\fP or \fBlocal\fP settings. The syntax for
these settings has changed to \fBipv4\-*\fP or \fBipv6\-*\fP, respectively.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS State Removed Modules and Options
.INDENT 0.0
.IP \(bu 2
The \fBdocker\fP state module has been removed
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
In \fI\%2017.7.0\fP, the states from this module were
split into four separate state modules:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fI\%docker_container\fP
.IP \(bu 2
\fI\%docker_image\fP
.IP \(bu 2
\fI\%docker_volume\fP
.IP \(bu 2
\fI\%docker_network\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
The \fBdocker\fP module remained, for backward\-compatibility, but it has now
been removed. Please update SLS files to use the new state names:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBdocker.running\fP => \fI\%docker_container.running\fP
.IP \(bu 2
\fBdocker.stopped\fP => \fI\%docker_container.stopped\fP
.IP \(bu 2
\fBdocker.absent\fP => \fI\%docker_container.absent\fP
.IP \(bu 2
\fBdocker.network_present\fP => \fI\%docker_network.present\fP
.IP \(bu 2
\fBdocker.network_absent\fP => \fI\%docker_network.absent\fP
.IP \(bu 2
\fBdocker.image_present\fP => \fI\%docker_image.present\fP
.IP \(bu 2
\fBdocker.image_absent\fP => \fI\%docker_image.absent\fP
.IP \(bu 2
\fBdocker.volume_present\fP => \fI\%docker_volume.present\fP
.IP \(bu 2
\fBdocker.volume_absent\fP => \fI\%docker_volume.absent\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
The \fI\%docker_network\fP state module has
been changed as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The \fBdriver\fP option has been removed from
\fI\%docker_network.absent\fP\&.  It
had no functionality, as the state simply deletes the specified network
name if it exists.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
The deprecated \fBref\fP option has been removed from the
\fI\%git.detached\fP state. Please use \fBrev\fP
instead.
.IP \(bu 2
The \fBk8s\fP state module has been removed in favor of the \fI\%kubernetes\fP state mdoule. Please update SLS files as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
In place of \fBk8s.label_present\fP, use
\fI\%kubernetes.node_label_present\fP
.IP \(bu 2
In place of \fBk8s.label_absent\fP, use
\fI\%kubernetes.node_label_absent\fP
.IP \(bu 2
In place of \fBk8s.label_folder_absent\fP, use
\fI\%kubernetes.node_label_folder_absent\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
Support for the \fBtemplate_path\fP option in the \fBnetconfig.managed
<salt.states.netconfig.managed()\fP state has been removed. This is because
support for NAPALM native templates has been dropped.
.IP \(bu 2
Support for the \fBno_chown\fP option in the
\fBpip.insalled\fP state has been removed.
.IP \(bu 2
The \fBtrafficserver.set_var\fP
state has been removed. Please use \fI\%trafficserver.config\fP instead.
.IP \(bu 2
Support for the \fBno_chown\fP option in the
:py:func\(gavirtualenv.managed <salt.states.virtualenv.managed>\(ga function has
been removed.
.IP \(bu 2
The \fBwin_update\fP state module has been removed. It has been replaced by
\fI\%win_wua\fP\&.
.IP \(bu 2
Support for virtual packages has been removed from the
py:mod:\fIpkg state <salt.states.pkg>\fP\&.
.UNINDENT
.SS Utils Removed Options
.sp
The \fBcloud\fP utils module had the following changes:
.INDENT 0.0
.IP \(bu 2
Support for the \fBcache_nodes_ip\fP function in \fBsalt utils module\fP
has been removed. The function was incomplete and non\-functional.
.UNINDENT
.sp
The \fBvault\fP utils module had the following changes:
.INDENT 0.0
.IP \(bu 2
Support for specifying Vault connection data within a \(aqprofile\(aq has been removed.
Please see the \fI\%vault execution module\fP documentation for
details on the new configuration schema.
.UNINDENT
.SS Dependency Deprecations
.sp
Salt\-Cloud has been updated to use the \fBpypsexec\fP Python library instead of the
\fBwinexe\fP executable. Both \fBwinexe\fP and \fBpypsexec\fP run remote commands
against Windows OSes. Since \fBwinexe\fP is not packaged for every system, it has
been deprecated in favor of \fBpypsexec\fP\&.
.sp
Salt\-Cloud has deprecated the use \fBimpacket\fP in favor of \fBsmbprotocol\fP\&.
This changes was made because \fBimpacket\fP is not compatible with Python 3.
.SS SaltSSH Major Updates
.sp
SaltSSH now works across different major Python versions. Python 2.7 ~ Python 3.x
are now supported transparently. Requirement is, however, that the SaltMaster should
have installed Salt, including all related dependencies for Python 2 and Python 3.
Everything needs to be importable from the respective Python environment.
.sp
SaltSSH can bundle up an arbitrary version of Salt. If there would be an old box for
example, running an outdated and unsupported Python 2.6, it is still possible from
a SaltMaster with Python 3.5 or newer to access it. This feature requires an additional
configuration in /etc/salt/master as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ssh_ext_alternatives:
    2016.3:                     # Namespace, can be actually anything.
        py\-version: [2, 6]      # Constraint to specific interpreter version
        path: /opt/2016.3/salt  # Main Salt installation
        dependencies:           # List of dependencies and their installation paths
          jinja2: /opt/jinja2
          yaml: /opt/yaml
          tornado: /opt/tornado
          msgpack: /opt/msgpack
          certifi: /opt/certifi
          singledispatch: /opt/singledispatch.py
          singledispatch_helpers: /opt/singledispatch_helpers.py
          markupsafe: /opt/markupsafe
          backports_abc: /opt/backports_abc.py
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is also possible to use several alternative versions of Salt. You can for
instance generate a minimal tarball using runners and include that. But this is
only possible, when such specific Salt version is also available on the Master
machine, although does not need to be directly installed together with the
older Python interpreter.
.sp
SaltSSH now support private key\(aqs passphrase. You can configure it by:
.INDENT 0.0
.IP \(bu 2
\fI\-\-priv\-passwd\fP for salt\-ssh cli
.IP \(bu 2
\fIsalt_priv_passwd\fP for salt master configure file
.IP \(bu 2
\fIpriv_passwd\fP for salt roster file
.UNINDENT
.SS State Module Changes
.SS \fI\%salt\fP State Module (used in orchestration)
.sp
The \fBtest\fP option now defaults to None. A value of \fBTrue\fP or \fBFalse\fP set
here is passed to the state being run and can be used to override a \fBtest:
True\fP option set in the minion\(aqs config file. In previous releases the
minion\(aqs config option would take precedence and it would be impossible to run
an orchestration on a minion with test mode set to True in the config file.
.sp
If a minion is not in permanent test mode due to the config file and the \(aqtest\(aq
argument here is left as None then a value of \fBtest=True\fP on the command\-line is
passed correctly to the minion to run an orchestration in test mode. At present
it is not possible to pass \fBtest=False\fP on the command\-line to override a
minion in permanent test mode and so the \fBtest: False\fP option must still be set
in the orchestration file.
.SS \fI\%event.send\fP State
.sp
The \fI\%event.send\fP state does not know the
results of the sent event, so returns changed every state run.  It can now be
set to return changed or unchanged.
.SS \fI\%influxdb_user.present\fP Influxdb User Module State
.sp
The \fBpassword\fP parameter has been changed to \fBpasswd\fP to remove the
name collusion with the influxdb client configuration (\fBclient_kwargs\fP)
allowing management of users when authentication is enabled on the influxdb
instance
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
influxdb_user.present:
  \- name: exampleuser
  \- password: exampleuserpassword
  \- user: admin
  \- password: adminpassword
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
influxdb_user.present:
  \- name: exampleuser
  \- passwd: exampleuserpassword
  \- user: admin
  \- password: adminpassword
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fI\%winrepo_cache_expire_min\fP Windows Package Definitions Caching
.sp
The \fI\%winrepo_cache_expire_min\fP has been changed from 0 to 1800 (30 minutes)
For example if you run highstate the package definitions are normally updated,
however now if the package definitions are younger than \fI\%winrepo_cache_expire_min\fP
(30 minutes) the package definitions will not be refreshed, reducing the amount
of time taken to run a 2nd highstate. To get the old behaviour change the value
back to 0 in the minion configuration file. This also effects the behaviour of
other functions which default to refresh.  The \fBpkg.refresh_db\fP will always
refresh the package definitions.
.SS LDAP External Authentication
.SS freeipa \fBgroupattribute\fP support
.sp
Previously, if Salt was using external authentication against a freeipa LDAP
system it could only search for users via the \fBaccountattributename\fP field.
This release add an additional search using the \fBgroupattribute\fP field as
well.  The original \fBaccountattributename\fP search is done first then the
\fBgroupattribute\fP allowing for backward compatibility with previous Salt
releases.
.SS Jinja Include Relative Paths
.sp
When a jinja include template name begins with \fB\&./\fP or
\fB\&../\fP then the import will be relative to the importing file.
.sp
Prior practices required the following construct:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% from tpldir ~ \(aq/foo\(aq import bar %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A more \(dqnatural\(dq construct is now supported:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% from \(aq./foo\(aq import bar %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Comparatively when importing from a parent directory \- prior practice:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% from tpldir ~ \(aq/../foo\(aq import bar %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New style for including from a parent directory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{% from \(aq../foo\(aq import bar %}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS salt\-api
.SS salt\-api Windows support
.sp
Previously, salt\-api was was not supported on the Microsoft Windows platforms. Now it is!
salt\-api provides a RESTful interface to a running Salt system. It allows
for viewing minions, runners, and jobs as well as running execution modules
and runners of a running Salt system through a REST API that returns JSON.
See \fI\%Salt\-API\fP documentation.
\&.. _Salt\-API: \fI\%https://docs.saltproject.io/en/latest/topics/netapi/index.html\fP
.SS Logging Changes
.SS Include Job ID (JID) in Minion and Master Logs
.sp
The Job ID (JID) can now be optionally included in both the minion and master logs
by including \fBjid\fP in either the \fBlog_fmt_console\fP or \fBlog_fmt_logfile\fP
configuration option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_fmt_console: \(dq[%(levelname)\-8s] %(jid)s %(message)s\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The will cause the JID to be included in any log entries that are related to a
particular Salt job.  The JID will be included using the default format,
\fB[JID: %(jid)s]\fP but can be overridden with the \fBlog_fmt_jid\fP configuration item.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log_fmt_jid: \(dq[JID: %(jid)s]\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Security
.SS Windows runas changes
.sp
A password is no longer required with \fBrunas\fP under normal circumstances.
The password option is only needed if the minion process is run under a
restricted (non\-administrator) account. In the aforementioned case, a password
is only required when using the \fBrunas\fP argument to run command as a
different user.
.SS New Modules
.SS Execution Modules
.INDENT 0.0
.IP \(bu 2
\fI\%salt.modules.ciscoconfparse_mod\fP
.IP \(bu 2
\fI\%salt.modules.jira\fP
.IP \(bu 2
\fI\%salt.modules.google_chat\fP
.IP \(bu 2
\fI\%salt.modules.iosconfig\fP
.IP \(bu 2
\fI\%salt.modules.netmiko\fP
.IP \(bu 2
\fI\%salt.modules.nxos_api\fP
.IP \(bu 2
\fI\%salt.modules.peeringdb\fP
.IP \(bu 2
\fI\%salt.modules.purefb\fP
.IP \(bu 2
\fI\%salt.modules.pyeapi\fP
.UNINDENT
.SS Pillar Modules
.INDENT 0.0
.IP \(bu 2
\fI\%netbox\fP
.UNINDENT
.SS Proxy Modules
.INDENT 0.0
.IP \(bu 2
\fI\%salt.proxy.netmiko\fP
.IP \(bu 2
\fI\%salt.proxy.nxos_api\fP
.IP \(bu 2
\fI\%salt.proxy.pyeapi\fP
.UNINDENT
.SS Salt 2019.2.1 Release Notes
.sp
Version 2019.2.1 is a bugfix release for \fI\%2019.2.0\fP\&.
.SS Known Issues
.INDENT 0.0
.IP \(bu 2
\fBISSUE\fP \fI\%#54751\fP: Proxy minion fails to start. Fix planned in 2019.2.2 release.
.IP \(bu 2
\fBISSUE\fP \fI\%#54762\fP: URIs with IPv6 addresses are broken, preventing master\-minion communication in IPv6\-only environments. Fix planned in 2019.2.2 release.
.IP \(bu 2
\fBISSUE\fP \fI\%#54776\fP: Minion fails to start when it contains \fIping_interval\fP in minion configuration file. Fix planned in 2019.2.2 release.
.IP \(bu 2
\fBISSUE\fP \fI\%#54731\fP: Returners (except for default salt master returner) not loading properly in Py3. Fix planned in 2019.2.2 release.
.IP \(bu 2
\fBISSUE\fP \fI\%#54758\fP: salt\-call state.show_states gives  \(dqPassed invalid arguments\(dq error when a sls defined in top.sls file is missing. Fix planned in 2019.2.2 release.
.IP \(bu 2
\fBISSUE\fP \fI\%#54765\fP: Jinja from import is broken. Fix planned in 2019.2.2 release.
.IP \(bu 2
\fBISSUE\fP \fI\%#54771\fP: Affects only Debian 10. pkgrepo.managed does not work if used with proxy (configured at salt\-minion). No fix date available yet.
.IP \(bu 2
\fBISSUE\fP \fI\%#54759\fP: Deprecation warnings for pyzmq. No fix date available yet.
.UNINDENT
.SS Change to YAML Renderer
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.managed:
    \- source: salt://foo.conf.jinja
    \- template: jinja
    \- context:
        data: {{ data }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In 2019.2.0, the above SLS will result in an error message following changes to
the YAML renderer that now require the new Jinja filter \fItojson\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.managed:
    \- source: salt://foo.conf.jinja
    \- template: jinja
    \- context:
        data: {{ data|tojson }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In 2019.2.1, we introduce a new configuration option for both the Salt master and Salt minion
configurations to be able to support the older YAML renderer.  Using the option
\fBuse_yamlloader_old\fP will allow the YAML renderer to function as before.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB541\fP
.IP \(bu 2
Total Issue References: \fB70\fP
.IP \(bu 2
Total PR References: \fB355\fP
.IP \(bu 2
Contributors: \fB49\fP (\fI\%Akm0d\fP, \fI\%Ch3LL\fP, \fI\%DmitryKuzmenko\fP, \fI\%Ethyling\fP, \fI\%FireGrace\fP,
\fI\%KChandrashekhar\fP, \fI\%ScoreUnder\fP, \fI\%amendlik\fP, \fI\%aplanas\fP, \fI\%arsiesys\fP, \fI\%bbinet\fP, \fI\%bryceml\fP,
\fI\%cbosdo\fP, \fI\%cdalvaro\fP, \fI\%chdamianos\fP, \fI\%cmcmarrow\fP, \fI\%cro\fP, \fI\%damianosSemmle\fP, \fI\%dmurphy18\fP,
\fI\%doesitblend\fP, \fI\%dwoz\fP, \fI\%felippeb\fP, \fI\%frogunder\fP, \fI\%garethgreenaway\fP, \fI\%github\-abcde\fP, \fI\%isbm\fP,
\fI\%jfindlay\fP, \fI\%lomeroe\fP, \fI\%mattLLVW\fP, \fI\%mattp\-\fP, \fI\%mirceaulinic\fP, \fI\%nicholasmhughes\fP, \fI\%rbthomp\fP,
\fI\%rombert\fP, \fI\%rsmekala\fP, \fI\%s0undt3ch\fP, \fI\%sathieu\fP, \fI\%sbrennan4\fP, \fI\%sdodsley\fP, \fI\%simonflood\fP,
\fI\%sjorge\fP, \fI\%soer7022\fP, \fI\%stratusjerry\fP, \fI\%tanlingyun2005\fP, \fI\%terminalmage\fP, \fI\%twangboy\fP,
\fI\%waynew\fP, \fI\%weswhet\fP, \fI\%xuhcc\fP)
.UNINDENT
.SS Changelog for v2019.2.0..v2019.2.1
.sp
\fIGenerated at: 2019\-09\-09 19:56:22 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBISSUE\fP \fI\%#54429\fP: (\fI\%frogunder\fP) [2019.2.1] Sudo user error (refs: \fI\%#54433\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54433\fP: (\fI\%dwoz\fP) Re\-gen executors with proper arguments
@ \fI2019\-09\-09 19:14:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
62fc61c Merge pull request \fI\%#54433\fP from dwoz/sudo_minion
.IP \(bu 2
e08eb19 Merge branch \(aq2019.2.1\(aq into sudo_minion
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54434\fP: (\fI\%frogunder\fP) fix_docs
@ \fI2019\-09\-09 18:55:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
76fac57 Merge pull request \fI\%#54434\fP from frogunder/fix_doc
.IP \(bu 2
2d22d73 fix_docs error
.IP \(bu 2
a266a5c fix_docs
.IP \(bu 2
db5464a Fix linter warts
.IP \(bu 2
144a600 Re\-gen executors with proper arguments
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54424\fP: (\fI\%frogunder\fP) remove in progress from release_notes 2019.2.1
@ \fI2019\-09\-05 23:11:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
4071dcb Merge pull request \fI\%#54424\fP from frogunder/releasenotes_201921_new
.IP \(bu 2
b66436f Update 2019.2.1.rst
.IP \(bu 2
bcfef11 remove in progress from release_notes 2019.2.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54416\fP: (\fI\%frogunder\fP) Update man_pages for 2019.2.1
@ \fI2019\-09\-05 22:48:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
c1587cc Merge pull request \fI\%#54416\fP from frogunder/man_pages_201921
.IP \(bu 2
6f7c4ee Update man_pages for 2019.2.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54419\fP: (\fI\%frogunder\fP) releasenotes 2019.2.1
@ \fI2019\-09\-05 22:48:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
3118e2f Merge pull request \fI\%#54419\fP from frogunder/release_notes_201921
.IP \(bu 2
2caee96 Update doc/topics/releases/2019.2.1.rst
.IP \(bu 2
ffabde2 Update 2019.2.1.rst
.IP \(bu 2
dd6426d Update doc/topics/releases/2019.2.1.rst
.IP \(bu 2
9d4239c Update doc/topics/releases/2019.2.1.rst
.IP \(bu 2
8c60ae4 Update doc/topics/releases/2019.2.1.rst
.IP \(bu 2
72cb24c releasenotes 2019.2.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54409\fP: (\fI\%dwoz\fP) Point salt\-call to correct multi\-master configs
@ \fI2019\-09\-04 20:08:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
04e28cf Merge pull request \fI\%#54409\fP from dwoz/mm_log
.IP \(bu 2
e207de6 Point salt\-call to correct multi\-master configs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54396\fP: (\fI\%dwoz\fP) Use different logging port for multimaster tests
@ \fI2019\-09\-03 23:20:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
2c281e0 Merge pull request \fI\%#54396\fP from dwoz/multimaster_logging
.IP \(bu 2
104e0a0 Use different logging port for multimaster tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#54256\fP: (\fI\%sleminov\-tc\fP) Empty salt api token file breaks maintenance process. (refs: \fI\%#54325\fP, \fI\%#54324\fP, \fI\%#54388\fP, \fI\%#54376\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#37945\fP: (\fI\%gstachowiak\fP) Missing exception handling in salt.master.Maintenance. Process never completes. (refs: \fI\%#54325\fP, \fI\%#54324\fP, \fI\%#54388\fP, \fI\%#54376\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54388\fP: (\fI\%dwoz\fP) 54256 re fix empty api token 2019.2.1
@ \fI2019\-09\-03 23:19:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#54325\fP: (\fI\%waynew\fP) Delete bad API token files (refs: \fI\%#54388\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54324\fP: (\fI\%waynew\fP) Delete bad API token files (refs: \fI\%#54325\fP, \fI\%#54388\fP)
.IP \(bu 2
730a007 Merge pull request \fI\%#54388\fP from dwoz/54256\-re\-fix\-empty\-api\-token\-2019.2.1
.IP \(bu 2
80651d3 Fix linter
.IP \(bu 2
982ed3d Delete bad API token files
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#54256\fP: (\fI\%sleminov\-tc\fP) Empty salt api token file breaks maintenance process. (refs: \fI\%#54325\fP, \fI\%#54324\fP, \fI\%#54388\fP, \fI\%#54376\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#37945\fP: (\fI\%gstachowiak\fP) Missing exception handling in salt.master.Maintenance. Process never completes. (refs: \fI\%#54325\fP, \fI\%#54324\fP, \fI\%#54388\fP, \fI\%#54376\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54376\fP: (\fI\%dwoz\fP) Move tokens in place with an atomic operation
@ \fI2019\-09\-03 20:40:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
11016ce Merge pull request \fI\%#54376\fP from dwoz/tmp_token
.IP \(bu 2
0b28c60 Fix linter complaints
.IP \(bu 2
8e33343 Move tokens in place with an atomic operation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54386\fP: (\fI\%twangboy\fP) Fix unit.utils.test_win_dacl (2019.2.1)
@ \fI2019\-09\-03 16:57:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
5161203 Merge pull request \fI\%#54386\fP from twangboy/fix_test_win_dacl_2019.2.1
.IP \(bu 2
b8fa7d3 Sort the perms
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54355\fP: (\fI\%s0undt3ch\fP) [2019.2.1] [GitPillar Tests] Have the started processes log instead of just writing to stdout/stderr
@ \fI2019\-08\-29 23:26:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
b4caaad Merge pull request \fI\%#54355\fP from s0undt3ch/hotfix/test\-daemons\-2019.2.1
.IP \(bu 2
561c0a2 Have the started processes log instead of just writing to stdout/stderr
.IP \(bu 2
c2a3115 Don\(aqt overwritethe stderr logger
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54353\fP: (\fI\%cmcmarrow\fP) adds @skipIf not windows
@ \fI2019\-08\-29 19:33:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce5b109 Merge pull request \fI\%#54353\fP from cmcmarrow/2019_win_system_skip
.IP \(bu 2
8e28074 adds @skipIf not windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54338\fP: (\fI\%dwoz\fP) Log server closes completely during shutdown
@ \fI2019\-08\-29 17:14:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
94c03e5 Merge pull request \fI\%#54338\fP from dwoz/logging_fixup
.IP \(bu 2
a3e227e Log server closes completely during shutdown
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54327\fP: (\fI\%garethgreenaway\fP) [2019.2.1] Catch the AccessDenied exception and continue when running under Py3.
@ \fI2019\-08\-29 16:59:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
490ee69 Merge pull request \fI\%#54327\fP from garethgreenaway/more_test_program_fixes
.IP \(bu 2
97b4d86 Catch the AccessDenied exception and continue when running under Py3.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54316\fP: (\fI\%Akm0d\fP) Azure cleanup
@ \fI2019\-08\-27 16:14:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb911c3 Merge pull request \fI\%#54316\fP from Akm0d/azure\-cleanup
.IP \(bu 2
2072773 pass longer timeout to msazure destroyinstance
.IP \(bu 2
34eb477 Merge branch \(aq2019.2.1\(aq of \fI\%https://github.com/saltstack/salt\fP into azure\-cleanup
.IP \(bu 2
7ae48b1 Allow azure tests enough time to clean up interfaces
.IP \(bu 2
b45ae74 Clean up azure instances properly
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54314\fP: (\fI\%garethgreenaway\fP) [2019.2.1] Do not raise the exception in testprogram.py
@ \fI2019\-08\-26 23:59:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
9334e4e Merge pull request \fI\%#54314\fP from garethgreenaway/testprogram_access_denied_do_not_raise
.IP \(bu 2
a53bacb Do not raise the exception if a process can not be access, just continue
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54305\fP: (\fI\%dwoz\fP) Fix wart in test_process tests on windows
@ \fI2019\-08\-26 17:59:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
71fb051 Merge pull request \fI\%#54305\fP from dwoz/winfix
.IP \(bu 2
4e68860 Fix wart in test_process tests on windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54303\fP: (\fI\%dwoz\fP) Fix wart in periodic callback interval
@ \fI2019\-08\-24 20:04:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
4d80f0a Merge pull request \fI\%#54303\fP from dwoz/periodic_cb
.IP \(bu 2
bf5f7de Fix wart in periodic callback interval
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#54219\fP: (\fI\%KChandrashekhar\fP) integration.shell.test_call.py and tests/integration/shell/test_proxy.py (refs: \fI\%#54259\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#54153\fP: (\fI\%KChandrashekhar\fP) Ubuntu 16.04 Proxy failures  (refs: \fI\%#54259\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54259\fP: (\fI\%dwoz\fP) Call os.fork less to avoid race conditions
@ \fI2019\-08\-24 02:12:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
5838851 Merge pull request \fI\%#54259\fP from dwoz/less_forking
.IP \(bu 2
bf4d0dd Fix process list tests on windows py3
.IP \(bu 2
316ec78 Allow more time for slow test
.IP \(bu 2
9baf86f Do not remove attributes from process class
.IP \(bu 2
e7b6aa8 Clean up cruft
.IP \(bu 2
ed7103a Attempt to fix integration.shell.test_call test
.IP \(bu 2
659c805 Change noise log to debug
.IP \(bu 2
0660b1a Clean up typos
.IP \(bu 2
9f1fe42 Call os.fork less to avoid race conditions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50814\fP: (\fI\%doesitblend\fP) Minion continues trying down master (refs: \fI\%#54239\fP, \fI\%#53417\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#49680\fP: (\fI\%doesitblend\fP) Beacon events handled differently than event.send (refs: \fI\%#53344\fP, \fI\%#54239\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#49663\fP: (\fI\%doesitblend\fP) Beacon only fires to single random master in HA mode (refs: \fI\%#53344\fP, \fI\%#54239\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54247\fP: (\fI\%DmitryKuzmenko\fP) 2019.2.1 with multimaster bb fixes
@ \fI2019\-08\-23 20:19:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#54239\fP: (\fI\%DmitryKuzmenko\fP) Multimaster tests with bb fixes (refs: \fI\%#54247\fP)
.IP \(bu 2
\fBPR\fP \fI\%#53848\fP: (\fI\%DmitryKuzmenko\fP) Features/multimaster tests (refs: \fI\%#54239\fP)
.IP \(bu 2
\fBPR\fP \fI\%#53417\fP: (\fI\%DmitryKuzmenko\fP) Multimaster minion hang on fire_master (refs: \fI\%#54239\fP, \fI\%#53848\fP)
.IP \(bu 2
\fBPR\fP \fI\%#53344\fP: (\fI\%DmitryKuzmenko\fP) Run beacons on the only one minion instance. Return to all masters. (refs: \fI\%#54239\fP, \fI\%#53848\fP)
.IP \(bu 2
531f3aa Merge pull request \fI\%#54247\fP from DSRCorporation/2019.2.1_with_multimaster_bb_fixes
.IP \(bu 2
62cd8cd Merge branch \(aq2019.2.1\(aq into 2019.2.1_with_multimaster_bb_fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54235\fP: (\fI\%github\-abcde\fP) Fix 46034 2019.2.1
@ \fI2019\-08\-22 22:32:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
993c341 Merge pull request \fI\%#54235\fP from ogd\-software/fix_46034\-2019.2.1
.IP \(bu 2
93bd30d Add alternative fix for \(dq!\(dq stomping Apparently (after watching Jenkins tests fail),
what yaml.safe_load returns depends not on the version of salt, but on some other external
dependency. Because of this, fix both possible return values.
.IP \(bu 2
c95dd4d Add test for this specific bugfix
.IP \(bu 2
efc29d8 Prevent yamlify_arg from stomping \(dq!\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54282\fP: (\fI\%Akm0d\fP) clean up renamed instances in the teardown
@ \fI2019\-08\-22 22:13:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
5d1a4d0 Merge pull request \fI\%#54282\fP from Akm0d/clean\-up\-renamed
.IP \(bu 2
11c1117 Removed redundant parenthesis
.IP \(bu 2
802235d don\(aqt delete shutting down ec2 instances
.IP \(bu 2
3602942 reversed the order in which an instance was renamed
.IP \(bu 2
5500ede renamed _alt_name function
.IP \(bu 2
23beab4 clean up renamed instances in the teardown
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54252\fP: (\fI\%s0undt3ch\fP) [2019.2.1] More control on spun test daemons on git pillar tests
@ \fI2019\-08\-22 22:13:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
c181f5a Merge pull request \fI\%#54252\fP from s0undt3ch/hotfix/git\-pillar\-2019.2.1
.IP \(bu 2
4eb85fa Skip tests on RHEL family < 7
.IP \(bu 2
64a1be8 Don\(aqt even go through the transport to get the system grains
.IP \(bu 2
d0f8efa Don\(aqt keep recreating the git repos. Restore from backup.
.IP \(bu 2
6114e9d All prep work is done in \fIsetUpClass\fP\&.
.IP \(bu 2
5b030dd Daemons are now started/stopped on tests, not by salt
.IP \(bu 2
ed60f0d We don\(aqt actually need grains
.IP \(bu 2
911446d Lock \fIuwsgi\fP requirement.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
805f0ac Merge branch \(aq2019.2.1\(aq into 2019.2.1_with_multimaster_bb_fixes
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54214\fP: (\fI\%Ch3LL\fP) Remove unnecessary logging from minion.py
@ \fI2019\-08\-22 18:08:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
b40cdbf Merge pull request \fI\%#54214\fP from Ch3LL/fix_logging
.IP \(bu 2
8fd24cf Remove unnecessary logging from minion.py
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
9d28098 Merge branch \(aq2019.2.1\(aq into 2019.2.1_with_multimaster_bb_fixes
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54277\fP: (\fI\%dwoz\fP) Win runas plus
@ \fI2019\-08\-21 23:59:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
de77762 Merge pull request \fI\%#54277\fP from dwoz/win_runas_plus
.IP \(bu 2
f719591 Update tests
.IP \(bu 2
d8749d9 Do not remove attributes from process class
.IP \(bu 2
ac5a2a4 Only close handle if it got created
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54278\fP: (\fI\%Akm0d\fP) Correctly detect when an ms_azure instance is deleted
@ \fI2019\-08\-21 23:14:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
93cf40a Merge pull request \fI\%#54278\fP from Akm0d/cloud\-test\-logging
.IP \(bu 2
2dc1520 Merge branch \(aq2019.2.1\(aq into cloud\-test\-logging
.IP \(bu 2
3867448 Fixed incorrect arguments
.IP \(bu 2
bdce5f4 Fix detecting msazure deletion with multiple tries
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54263\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Exit test suite if test daemons fail to start
@ \fI2019\-08\-21 22:06:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
94f77a0 Merge pull request \fI\%#54263\fP from s0undt3ch/hotfix/test\-daemons\-2019.2.1
.IP \(bu 2
655efd6 Rearrange logging termination
.IP \(bu 2
28fa5d2 Prevent traceback on python interpreter shutdown
.IP \(bu 2
9035731 Write to stderr a message with the exit code
.IP \(bu 2
566c620 Exit the test suite if one of the test daemons fails to start
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54270\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Speedup testing helpers decorators
@ \fI2019\-08\-21 20:33:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
3b9fd44 Merge pull request \fI\%#54270\fP from s0undt3ch/hotfix/requires\-system\-grains\-2019.2.1
.IP \(bu 2
9f99bff Speedup testing helpers decorators
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#53931\fP: (\fI\%KChandrashekhar\fP) integration.states.test_pip_state.PipStateTest.test_issue_6912_wrong_owner_requirements_file (refs: \fI\%#54274\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54274\fP: (\fI\%felippeb\fP) \fI\%#53931\fP never fail on codecov curls
@ \fI2019\-08\-21 18:12:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
2c4afa0 Merge pull request \fI\%#54274\fP from felippeb/2019.2.1
.IP \(bu 2
9c0b216 \fI\%#53931\fP never fail on codecov curls
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54264\fP: (\fI\%dwoz\fP) Fix unit utils jinja when run on their own
@ \fI2019\-08\-21 17:22:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
b3c70c3 Merge pull request \fI\%#54264\fP from dwoz/jinja_units
.IP \(bu 2
10a6d53 Fix unit utils jinja when run on their own
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54266\fP: (\fI\%Akm0d\fP) Fix incorrect types on failing cloud tests
@ \fI2019\-08\-21 17:14:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
308ba55 Merge pull request \fI\%#54266\fP from Akm0d/cloud_test_ultimate_fix
.IP \(bu 2
ff2125a Invert assertion to test for instance gone
.IP \(bu 2
82136a8 test for ec2 instance shutting down
.IP \(bu 2
283f631 run cloud \-\-query if delete string is not available
.IP \(bu 2
33e6b6d changed deprecated assertEquals
.IP \(bu 2
41e6bc8 Cloud tests run correctly everywhere
.IP \(bu 2
03a8b2c reverted literal_eval
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54251\fP: (\fI\%Akm0d\fP) reduced query calls to salt\-cloud
@ \fI2019\-08\-20 20:10:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
25d0b52 Merge pull request \fI\%#54251\fP from Akm0d/cloud_test_optimization
.IP \(bu 2
5fe6bfc Optimized salt\-cloud queries
.IP \(bu 2
43418a4 Merge pull request \fI\%#7\fP from Ch3LL/cloud_provider_files
.INDENT 2.0
.IP \(bu 2
b93944b Remove joyent config cloud test files
.IP \(bu 2
bd37849 Rename provider azure\-config to azurearm\-config
.UNINDENT
.IP \(bu 2
e7c06cb Added longer delays for ec2 tests
.IP \(bu 2
5ceb47e Correctly check for GCE and EC2 deletion
.IP \(bu 2
52c178c Added pretty yaml formatting to cloud\-test logs
.IP \(bu 2
4fc5e9e re\-fixed simultaneous GCE tests
.IP \(bu 2
326e9f2 Merge pull request \fI\%#6\fP from Ch3LL/cloud_provider_files
.INDENT 2.0
.IP \(bu 2
adb1464 fix pylint
.IP \(bu 2
51ce819 Move provider config setup into Setup/Teardown class
.UNINDENT
.IP \(bu 2
e58b40a Merge pull request \fI\%#5\fP from Ch3LL/cloud_provider_files
.INDENT 2.0
.IP \(bu 2
ab8adcc Only use the provider conf.d file we are testing
.UNINDENT
.IP \(bu 2
76609ad Merge branch \(aq2019.2.1\(aq into cloud_test_optimization
.IP \(bu 2
f764bc0 Clean up expensive queries
.IP \(bu 2
b3d02df reduced query calls to salt\-cloud
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54240\fP: (\fI\%Ch3LL\fP) Fix TypeError python3 in get_image_id ec2 cloud
@ \fI2019\-08\-20 20:10:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
ba81ca3 Merge pull request \fI\%#54240\fP from Ch3LL/get_image_ec2
.IP \(bu 2
a3a39f3 Use ami variable instead in test
.IP \(bu 2
dc1ae52 Fix TypeError python3 in get_image_id
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
d6ad475 Merge branch \(aq2019.2.1\(aq into 2019.2.1_with_multimaster_bb_fixes
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54246\fP: (\fI\%dwoz\fP) Cut down on log noise
@ \fI2019\-08\-19 17:20:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
8404ec2 Merge pull request \fI\%#54246\fP from dwoz/log_noise
.IP \(bu 2
e572711 Cut down on log noise
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54245\fP: (\fI\%dwoz\fP) Fix the sshd pid file
@ \fI2019\-08\-19 17:19:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b3e925 Merge pull request \fI\%#54245\fP from dwoz/sshd_pid_file
.IP \(bu 2
df95347 Fix the sshd pid file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54237\fP: (\fI\%dwoz\fP) Do not dup2 things without fileno
@ \fI2019\-08\-18 17:13:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
268803b Merge pull request \fI\%#54237\fP from dwoz/dup2
.IP \(bu 2
2ebd22b Fix linter
.IP \(bu 2
63c616a Do not dup2 things without fileno
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
0b33498 Workaround for beacons.list_available slowness.
.IP \(bu 2
b7a1058 Minor: Better support of named multimaster tests.
.IP \(bu 2
a5cccdf Minor: remove unneded logging
.IP \(bu 2
314bbb3 Support tcp transport in multimaster tests. Minor beacon update.
.IP \(bu 2
fcb8ff0 Properly set HAS_IPTABLES from __virtual__ return.
.IP \(bu 2
a75db01 Multimaster related fixup: don\(aqt run test engine on minions
.IP \(bu 2
8a88542 Multimaster beacons fix: put list into a dict to fire on the bus
.IP \(bu 2
790fb41 Inotify beacons test logging and cleanup update
.IP \(bu 2
d84c8851 Inotify beacon test fixes and improvements.
.IP \(bu 2
472ffc0 Give minion more time to handle beacon creation.
.IP \(bu 2
17ceee0 Fixed Lint errors
.IP \(bu 2
0bcf53c Fixed the unicode and timing inotify test issues.
.IP \(bu 2
f17bcf3 Improved assertion error diagnostic for master down test.
.IP \(bu 2
db0bae8 Run multimaster as well tests when no specific group is set
.IP \(bu 2
723f363 Ignore the multimaster minion subgroup test in module names test.
.IP \(bu 2
612191c Fixed lint failures
.IP \(bu 2
c1efae6 Multimaster test for events handling on master disconnect
.IP \(bu 2
1654fe8 Multimaster inotify beacons test
.IP \(bu 2
65dc47c Multimaster tests environment and test module test.
.IP \(bu 2
2c178b0 Moved annoying message to trace log level.
.IP \(bu 2
3e497c1 Handle minion events asynchronously.
.IP \(bu 2
909323a Tests fixes
.IP \(bu 2
6dad18f Cleanup event object
.IP \(bu 2
2bf55be Run beacons on the only one minion instance. Return to all masters.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54121\fP: (\fI\%Akm0d\fP) Refactored cloud tests
@ \fI2019\-08\-16 17:24:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
27d89bd Merge pull request \fI\%#54121\fP from Akm0d/gce_cloud_test
.IP \(bu 2
48c57b3 Try multiple times to detect deletion of an instance
.IP \(bu 2
74300eb return a valid set
.IP \(bu 2
2d63b87 Wait for an instance to be fully created if necessary
.IP \(bu 2
83ad8b3 Merge branch \(aq2019.2.1\(aq of github.com:SaltStack/salt into gce_cloud_test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#54174\fP: (\fI\%dwoz\fP) SignalHandlingMultiprocessingProcess bugs (refs: \fI\%#54204\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54204\fP: (\fI\%dwoz\fP) Fix signal handling in subprocesses
@ \fI2019\-08\-16 00:46:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
c5ee91c Merge pull request \fI\%#54204\fP from dwoz/signal_proc
.IP \(bu 2
09e5e49 Merge branch \(aq2019.2.1\(aq into signal_proc
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#7745\fP: (\fI\%mgwilliams\fP) yaml \(aqmodule\(aq has no attribute \(aqDumper\(aq (refs: \fI\%#54223\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54223\fP: (\fI\%dwoz\fP) Test verify logs without a whole minion
@ \fI2019\-08\-16 00:46:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
99a8fc5 Merge pull request \fI\%#54223\fP from dwoz/7754_test_removal
.IP \(bu 2
4be711e Fix up linter warts
.IP \(bu 2
7573826 Remove crufty un\-needed tests
.IP \(bu 2
effa77d Test verify logs without a whole minion
.INDENT 2.0
.IP \(bu 2
b40f41f Revert fallback to default signals change
.IP \(bu 2
1d83b10 Fix signal handling in subprocesses
.INDENT 2.0
.IP \(bu 2
f90fe66 Reverted foo/bar creds per \fI\%#46265\fP
.IP \(bu 2
3f56bad Reduced the amount of informtaion in debuggings tatements
.IP \(bu 2
de53bf0 Merge branch \(aq2019.2.1\(aq of github.com:SaltStack/salt into gce_cloud_test
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54203\fP: (\fI\%dwoz\fP) Run transport test loops in single thread
@ \fI2019\-08\-15 20:10:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
8d440e0 Merge pull request \fI\%#54203\fP from dwoz/transport_tests
.IP \(bu 2
22b9d38 Run transsport test loops in single thread
.INDENT 2.0
.IP \(bu 2
f6180a6 Even better logging of errors
.IP \(bu 2
a15dc4b better formatting and error reporting
.IP \(bu 2
51fbc2a better logging on instance create failure
.IP \(bu 2
1f7dd52 removed hack fixes from gce
.IP \(bu 2
31cdc7c WAR ROOM SKIP GCE TESTS
.IP \(bu 2
7d603be hasattr cannot find parent properties starting with __
.IP \(bu 2
686cab9 Separated assertInstanceDestroy and _destry_instance
.IP \(bu 2
158a38c Revert \(dqRemoved subclass from cloud name\(dq
.IP \(bu 2
b7cf43d Removed subclass from cloud name
.IP \(bu 2
8c5eb18 fixed pylint error on format string
.IP \(bu 2
59e20bc Merge branch \(aq2019.2.1\(aq of \fI\%https://github.com/saltstack/salt\fP into gce_cloud_test
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54191\fP: (\fI\%garethgreenaway\fP) [2019.2.1] Addition logging in testprogram used by integration.shell.test_minion.MinionTest.test_exit_status_correct_usage
@ \fI2019\-08\-13 21:44:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
a05018e Merge pull request \fI\%#54191\fP from garethgreenaway/test_program_test_mininion
.IP \(bu 2
8463f84 Adding some additional logging when the call to \(dqproc_cmdline = proc.cmdline()\(dq reults in a AccessDenied exception, so we can see what the process is and who the process is running as.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54202\fP: (\fI\%waynew\fP) Only run one filter test
@ \fI2019\-08\-13 21:33:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
e5e9299 Merge pull request \fI\%#54202\fP from waynew/shorter\-jinja\-ssh\-tests
.IP \(bu 2
c333ac8 Only run one filter test
.INDENT 2.0
.IP \(bu 2
5912f24 Switched to Azurearm over msazure
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54172\fP: (\fI\%Ch3LL\fP) Migrate from azure to azurearm tests
@ \fI2019\-08\-13 20:07:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
a13cb3e Merge pull request \fI\%#54172\fP from Ch3LL/azurearm_tests
.IP \(bu 2
465523f Migrate from azure to azurearm tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50535\fP: (\fI\%wyardley\fP) salt errors with current azure\-storage because of no version set (refs: \fI\%#50567\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54173\fP: (\fI\%Ch3LL\fP) Cherry Pick \fI\%#50567\fP and \fI\%#53238\fP into 2019.2.1
@ \fI2019\-08\-13 20:07:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#53238\fP: (\fI\%nicholasmhughes\fP) Azure: Fixed ability to pass SSH key to Linux VMs (refs: \fI\%#54173\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50567\fP: (\fI\%rombert\fP) azurefs: gracefully handle AttributeError (refs: \fI\%#54173\fP)
.IP \(bu 2
39d0c59 Merge pull request \fI\%#54173\fP from Ch3LL/azure_fixes
.IP \(bu 2
9052eaf reverting log string handling
.IP \(bu 2
a1a61ee fixed ability to pass ssh key to Linux VMs
.IP \(bu 2
4a141a1 azurefs: gracefully handle AttributeError
.INDENT 2.0
.IP \(bu 2
6fa28de fixed underscore
.INDENT 2.0
.IP \(bu 2
c35379a Moved finding installer into class
.UNINDENT
.IP \(bu 2
95484f8 Moved finding installer into class
.IP \(bu 2
a86ae34 moved installer finder to SetUp method
.IP \(bu 2
933964a removed default user/pass from profitbricks test file
.IP \(bu 2
2a2437d fixed dictionary access
.IP \(bu 2
b9ee411 Fixed broken tests
.IP \(bu 2
80efd26 fixed misspelled provider information
.IP \(bu 2
511779b removed unused imports
.IP \(bu 2
1cd1c13 setUp all cloud tests the same way
.IP \(bu 2
d322408 Got rid of unnecessary delay
.IP \(bu 2
98ba18c fixed pylint error
.IP \(bu 2
c34c17e Merge branch \(aq2019.2.1\(aq of \fI\%https://github.com/saltstack/salt\fP into gce_cloud_test
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54178\fP: (\fI\%dwoz\fP) Fix flaky set_computer_name in mac_system module
@ \fI2019\-08\-12 18:26:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
19f4d5e Merge pull request \fI\%#54178\fP from dwoz/mac_computer_name
.IP \(bu 2
e51100e Fix skip on non macos platforms
.IP \(bu 2
a3a9d92 Fix linter
.IP \(bu 2
c499d44 Revert unwanted flaky from non computer name tests
.IP \(bu 2
941fcc8 Fix flaky set_computer_name in mac_system module
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
90e8350 Merge branch \(aq2019.2.1\(aq of \fI\%https://github.com/saltstack/salt\fP into gce_cloud_test
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54180\fP: (\fI\%dwoz\fP) Point test\-kitchen to my keepalive_maxcount branch
@ \fI2019\-08\-12 18:18:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
6fe6799 Merge pull request \fI\%#54180\fP from dwoz/keepalive_maxcount
.IP \(bu 2
dc9ee21 Add reminder about kitchen version
.IP \(bu 2
19a1f1b Point test\-kitchen to my keepalive_maxcount branch
.INDENT 2.0
.IP \(bu 2
60f8351 Fixed failing Ec2 Tests
.IP \(bu 2
e2f085c removed py3\-only function call
.IP \(bu 2
4406c57 fixed lint errors, more descriptive fails
.IP \(bu 2
6840d5f assert instances exist in unified way
.IP \(bu 2
03da233 skip EOL joyent tests, secure delete instances
.IP \(bu 2
3123bb1 Merge branch \(aq2019.2.1\(aq of \fI\%https://github.com/saltstack/salt\fP into gce_cloud_test
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#53306\fP: (\fI\%doesitblend\fP) Fully Qualify CMD on Windows Minions (refs: \fI\%#53311\fP, \fI\%#54033\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54033\fP: (\fI\%twangboy\fP) Backport \fI\%#53311\fP to 2019.2.1
@ \fI2019\-08\-09 16:46:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#53311\fP: (\fI\%doesitblend\fP) Add fully qualified cmd call (refs: \fI\%#54033\fP)
.IP \(bu 2
9f5302d Merge pull request \fI\%#54033\fP from twangboy/fix_win_service_2019.2.1
.IP \(bu 2
2850fab Merge branch \(aq2019.2.1\(aq into fix_win_service_2019.2.1
.IP \(bu 2
0e2a2b8 Merge branch \(aq2019.2.1\(aq into fix_win_service_2019.2.1
.IP \(bu 2
16c704e Backport \fI\%#53311\fP to 2019.2.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53900\fP: (\fI\%twangboy\fP) Fix inconsistent full names in LGPO
@ \fI2019\-08\-09 09:15:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
c0e49d9 Merge pull request \fI\%#53900\fP from twangboy/fix_lgpo
.IP \(bu 2
e05abdf Merge branch \(aq2019.2.1\(aq into fix_lgpo
.IP \(bu 2
e4e71cd Remove duplicate test
.IP \(bu 2
68c632b Add some tests
.IP \(bu 2
3c34075 Fall back to slower method if new method not available
.IP \(bu 2
0108bcd Avoid using the lowercase method in XPath
.IP \(bu 2
fcc0405 Fix telemetry issue, add some timining logs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52818\fP: (\fI\%twangboy\fP) Add watchdog as a bundled dependency on Windows
@ \fI2019\-08\-09 04:26:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
9eb2938 Merge pull request \fI\%#52818\fP from twangboy/add_watchdog
.IP \(bu 2
2658634 pre\-commit
.IP \(bu 2
35691f2 Add watchdog to Linux and OSX .in files
.IP \(bu 2
5ef5969 Rremove opensuse 42 static files
.IP \(bu 2
ec285d0 Remove watchdog from the rest of the .in files
.IP \(bu 2
86e64ae Remove unused import, remove Windows reference
.IP \(bu 2
b934d53 Remove watchdog from windows.in
.IP \(bu 2
cfaee96 Fix and unify watchdog beacon tests for all OS\(aqs
.IP \(bu 2
cc73204 Put Windows tests in their own class
.IP \(bu 2
6fbf1a3 Remove unused import... lint
.IP \(bu 2
832a1db Fix windowsisms
.IP \(bu 2
4f47d50 Update static requirements
.IP \(bu 2
762fe3b Remove some fluff
.IP \(bu 2
946076c Add watchdog for tests
.IP \(bu 2
02248dc Fix modified test to account for OS variances
.IP \(bu 2
15ee479 Compile static requirements
.IP \(bu 2
78a5723 Add watchdog to Linux and OSX .in files
.IP \(bu 2
9a0f08a Update static requirements
.IP \(bu 2
5cad13b Rremove opensuse 42 static files
.IP \(bu 2
1f05fce Remove watchdog from the rest of the .in files
.IP \(bu 2
121595a Remove unused import, remove Windows reference
.IP \(bu 2
c410a4b Remove watchdog from windows.in
.IP \(bu 2
05a0845 Fix and unify watchdog beacon tests for all OS\(aqs
.IP \(bu 2
200e230 Put Windows tests in their own class
.IP \(bu 2
6cc8d96 Remove unused import... lint
.IP \(bu 2
a4abb72 Fix windowsisms
.IP \(bu 2
005bed9 Update static requirements
.IP \(bu 2
c1bc627 Remove some fluff
.IP \(bu 2
92c8d47 Add watchdog for tests
.IP \(bu 2
9544624 Add watchdog as a bundled dependency on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54143\fP: (\fI\%Akm0d\fP) Don\(aqt call potentially missing shade library (\fI\%#53734\fP)
@ \fI2019\-08\-09 01:05:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#53734\fP: (\fI\%Akm0d\fP) Don\(aqt call potentially missing shade library (refs: \fI\%#54143\fP)
.IP \(bu 2
5bef520 Merge pull request \fI\%#54143\fP from Akm0d/openstack_fix
.IP \(bu 2
3f58885 Merge branch \(aq2019.2.1\(aq into openstack_fix
.IP \(bu 2
71f5f38 Don\(aqt call potentially missing shade library (\fI\%#53734\fP)
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
29ee7ce removed print statements, optimized query
.IP \(bu 2
14b7539 added back print statements for easy debug
.IP \(bu 2
823b3b2 Removed print statements and broken re
.IP \(bu 2
9696ed9 experiment with sublcass names
.IP \(bu 2
2fa6157 more verbose instance names based on test
.IP \(bu 2
2acb2df undercased non\-const variable and added print statements
.IP \(bu 2
c5e875d Merge branch \(aq2019.2.1\(aq of \fI\%https://github.com/saltstack/salt\fP into gce_cloud_test
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54001\fP: (\fI\%garethgreenaway\fP) [2019.2.1] Porting metaproxy changes in \fI\%#50183\fP to 2019.2.1
@ \fI2019\-08\-08 04:24:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50183\fP: (\fI\%cro\fP) Allow proxy minion types to be dynamically loaded (refs: \fI\%#54001\fP)
.IP \(bu 2
584e3f2 Merge pull request \fI\%#54001\fP from garethgreenaway/add_metaproxy_2019_2_1
.IP \(bu 2
8353467 Merge branch \(aqadd_metaproxy_2019_2_1\(aq of github.com:garethgreenaway/salt into add_metaproxy_2019_2_1
.INDENT 2.0
.IP \(bu 2
1892d86 Merge branch \(aq2019.2.1\(aq into add_metaproxy_2019_2_1
.UNINDENT
.IP \(bu 2
ab72e1b Adding unit.test_proxy_minion to ignore list
.IP \(bu 2
09f6fed Removing match tests, functionality does not exist in 2019.2.1
.IP \(bu 2
4af95e4 Adding tests to ensure _metaproxy_call to called when ProxyMinion objects are created.
.IP \(bu 2
d162a88 Adding salt/metaproxy/proxy.py and tests/unit/modules/test_match.py
.IP \(bu 2
51726b1 POrting metaproxy changes in \fI\%#50183\fP to 2019.2.1
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51008\fP: (\fI\%cdalvaro\fP) cwd option not working with cmd.run and runas (refs: \fI\%#52632\fP, \fI\%#54079\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54136\fP: (\fI\%ScoreUnder\fP)  Fix cmd.run on MacOS (rebased)
@ \fI2019\-08\-08 04:20:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#54079\fP: (\fI\%ScoreUnder\fP) Fix cmd.run on MacOS \-\- wrong environment variables (refs: \fI\%#54136\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52632\fP: (\fI\%cdalvaro\fP) Prevent shell injection as root with cmd.run on macOS (refs: \fI\%#54079\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47212\fP: (\fI\%weswhet\fP) fix macOS running as user. (refs: \fI\%#54079\fP)
.IP \(bu 2
bf863d0 Merge pull request \fI\%#54136\fP from ScoreUnder/2019.2.1\-patch\-macos\-cmd.run
.IP \(bu 2
1182eb9 Add integration test justifying strange use of braces after cd in cmd.run
.IP \(bu 2
733d2e7 Fixes to ITs
.IP \(bu 2
da38993 Add integration tests for cwd/runas changes on MacOS
.IP \(bu 2
ab8b39c Fix environment in cmd.run runas on MacOS
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
c9cb18f Don\(aqt call potentially missing shade library (\fI\%#53734\fP)
.IP \(bu 2
5ef8414 Added more verbose logging to cloud tests
.IP \(bu 2
2f3942f better logging and fail messages
.IP \(bu 2
9454f4c Fixed pylint errors and temporary print statements
.IP \(bu 2
fd13ce1 Further refactored cloud test code
.IP \(bu 2
b03cc48 Assume the instance exists and needs to be deleted
.IP \(bu 2
0991ff5 fixed pylint errors and failed tests
.IP \(bu 2
55e502a Merge branch \(aq2019.2.1\(aq of \fI\%https://github.com/saltstack/salt\fP into gce_cloud_test
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53974\fP: (\fI\%Ch3LL\fP) [2019.2.1] Add pygit2 requirement
@ \fI2019\-08\-06 17:32:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
e268b95 Merge pull request \fI\%#53974\fP from Ch3LL/add_pygit2
.IP \(bu 2
11864a0 Merge branch \(aq2019.2.1\(aq into add_pygit2
.IP \(bu 2
d1b1452 Merge branch \(aq2019.2.1\(aq into add_pygit2
.IP \(bu 2
a5698cc Merge branch \(aq2019.2.1\(aq into add_pygit2
.IP \(bu 2
7dd97a6 Merge branch \(aq2019.2.1\(aq into add_pygit2
.IP \(bu 2
358974a Skip Pygit2 tests on windows
.IP \(bu 2
bc64961 Use accurate \fI\%file:///\fP URI on windows for gitfs tests
.IP \(bu 2
894f958 Fix GitFS support for pygit2 >= 0.28.0
.IP \(bu 2
4580030 [2019.2.1] Add pygit2 requirement
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
4009bb5 fixed pylint errors
.IP \(bu 2
459b16d put cloudtest base in separate file so that only one change needs to be made
.IP \(bu 2
8e72335 Merge branch \(aqgce_cloud_test\(aq of github.com:Akm0d/salt into gce_cloud_test
.INDENT 2.0
.IP \(bu 2
0e2621e Merge branch \(aq2019.2.1\(aq into gce_cloud_test
.UNINDENT
.IP \(bu 2
9f98b16 finished merge
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54108\fP: (\fI\%dwoz\fP) More robust azure instance deletion
@ \fI2019\-08\-03 03:58:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
46f5e2e Merge pull request \fI\%#54108\fP from dwoz/azure_test
.IP \(bu 2
754b719 Fix linter
.IP \(bu 2
773235d Fix missing time import
.IP \(bu 2
5a8f2ec More robust azure instance deletion
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54017\fP: (\fI\%dmurphy18\fP) Allow for main thread having terminated pid, before ThreadPoolExecutor threads
@ \fI2019\-08\-02 18:11:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
2cb5a0b Merge pull request \fI\%#54017\fP from dmurphy18/fix_deb9_build90_tests
.IP \(bu 2
2866520 Skip process kill tests on Windows
.IP \(bu 2
5577f14 Clean up lint errors
.IP \(bu 2
4ca709e Merge branch \(aq2019.2.1\(aq into fix_deb9_build90_tests
.IP \(bu 2
264c767 Merge pull request \fI\%#1\fP from dwoz/fix_deb9_build90_tests
.INDENT 2.0
.IP \(bu 2
9bb9466 Add unit tests for weird pid does not exist cases
.IP \(bu 2
64d9752 Add warning messages to help determine why pids do not exist
.UNINDENT
.IP \(bu 2
406d382 Adjusted for review comments
.IP \(bu 2
2d20fbe Adjusted try/except statements on process checking
.IP \(bu 2
e189177 Removed typos
.IP \(bu 2
2e3ca43 Updated for review comments
.IP \(bu 2
68c29af Allow for main thread having terminated pid, before ThreadPoolExecutor threads
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
e3158c8 refactored all cloud tests
.IP \(bu 2
194e0c7 Refactored GCE cloud test
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54080\fP: (\fI\%dmurphy18\fP) Disabling random website tests till allow for quota usage
@ \fI2019\-07\-31 21:16:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
4e2efcd Merge pull request \fI\%#54080\fP from dmurphy18/u1804_py3_random_skip
.IP \(bu 2
0660e6e Disabling random website tests till allow for quota usage
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54063\fP: (\fI\%twangboy\fP) Make the skip apply to any system missing crypt
@ \fI2019\-07\-30 19:22:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
dbbbcc9 Merge pull request \fI\%#54063\fP from twangboy/fix_test_pycrypto_2019.2.1
.IP \(bu 2
6fcf035 Make the skip apply to any system missing crypt
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54050\fP: (\fI\%cmcmarrow\fP) fixs integration terminate error
@ \fI2019\-07\-30 13:38:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
4df6271 Merge pull request \fI\%#54050\fP from cmcmarrow/integration_terminate_fix
.IP \(bu 2
ebb07f4 Merge branch \(aq2019.2.1\(aq into integration_terminate_fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54057\fP: (\fI\%dmurphy18\fP) Added support for is_fedora and skip Minion test test_issue_7754 on Fedora
@ \fI2019\-07\-29 22:41:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d1bd63 Merge pull request \fI\%#54057\fP from dmurphy18/fix_fedora30_test
.IP \(bu 2
30f3bda Added support for is_fedora and skip Minion test test_issue_7754
.IP \(bu 2
b3293a9 Merge branch \(aq2019.2.1\(aq into integration_terminate_fix
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#53948\fP: (\fI\%KChandrashekhar\fP) integration.shell.test_call.CallTest.test_issue_2731_masterless (refs: \fI\%#54040\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#2731\fP: (\fI\%cwood\fP) Masterless Broken in 0.10.5 (refs: \fI\%#54040\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54040\fP: (\fI\%waynew\fP) Remove dead test
@ \fI2019\-07\-29 17:23:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
5d3bcd7 Merge pull request \fI\%#54040\fP from waynew/remove\-dead\-test
.IP \(bu 2
e9a5a57 Remove dead test
.INDENT 2.0
.IP \(bu 2
ba3e867 Merge branch \(aq2019.2.1\(aq into integration_terminate_fix
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54051\fP: (\fI\%twangboy\fP) Skip get time test
@ \fI2019\-07\-29 16:54:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
70ffcec Merge pull request \fI\%#54051\fP from twangboy/fix_test_system
.IP \(bu 2
ceaba05 Skip get time test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54038\fP: (\fI\%Ch3LL\fP) Pyton3 digital ocean test fix: to_str on key
@ \fI2019\-07\-29 16:54:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
4aed833 Merge pull request \fI\%#54038\fP from Ch3LL/do_py3_fix
.IP \(bu 2
f7346db Pyton3 digital ocean test fix: to_str on key
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
05cd93f fixs integration terminate error
.IP \(bu 2
69c3106 fixs integration terminate error
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53735\fP: (\fI\%twangboy\fP) Fix Windows tests in test_system
@ \fI2019\-07\-26 22:38:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
3cedacd Merge pull request \fI\%#53735\fP from twangboy/fix_test_system
.IP \(bu 2
a9e9c97 Add timeouts and account for those in assert
.IP \(bu 2
d3a160e Merge branch \(aq2019.2.1\(aq into fix_test_system
.IP \(bu 2
f95f0e7 Merge branch \(aq2019.2.1\(aq into fix_test_system
.IP \(bu 2
87e02b8 Use setUpClass
.IP \(bu 2
6a685bd Fix some tests in the Windows Class
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53953\fP: (\fI\%Ch3LL\fP) Send SIGTERM to webserver in teardown of gitfs tests
@ \fI2019\-07\-25 21:12:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
cc1cda1 Merge pull request \fI\%#53953\fP from Ch3LL/improve_git_test
.IP \(bu 2
347ea1e Use Sigkill and add time.sleep before check
.IP \(bu 2
637bf95 Merge branch \(aq2019.2.1\(aq into improve_git_test
.IP \(bu 2
c0be147 Send SIGTERM webserver during teardown of gitfs tests
.IP \(bu 2
b776c0c Check if gitfs server fails to setup for tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53999\fP: (\fI\%Ch3LL\fP) Generate new key each time for digital ocean key test
@ \fI2019\-07\-25 21:07:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
2324167 Merge pull request \fI\%#53999\fP from Ch3LL/fix_digital_ocean
.IP \(bu 2
b0b6e3b Generate new key each time for digital ocean key test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53970\fP: (\fI\%garethgreenaway\fP) [2019.2.1] Adding a WAR ROOM Skip for test_directory_clean_require_with_name
@ \fI2019\-07\-25 21:03:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
32fec66 Merge pull request \fI\%#53970\fP from garethgreenaway/osx_skip_test_directory_clean_require_with_name
.IP \(bu 2
362b84a Adding a WAR ROOM Skip for test_directory_clean_require_with_name
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54003\fP: (\fI\%dwoz\fP) War room skip for tcp build
@ \fI2019\-07\-24 22:52:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
213dfff Merge pull request \fI\%#54003\fP from dwoz/skip_test
.IP \(bu 2
6cdb8fa War room skip for tcp build
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53897\fP: (\fI\%cmcmarrow\fP) patches salt grains locale_info decode error
@ \fI2019\-07\-23 13:19:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
048c097 Merge pull request \fI\%#53897\fP from cmcmarrow/timezone_fix
.IP \(bu 2
d9e402d Merge branch \(aq2019.2.1\(aq into timezone_fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53920\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Update CI pipelines. Remove old jenkins cruft.
@ \fI2019\-07\-20 12:33:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
9a846b4 Merge pull request \fI\%#53920\fP from s0undt3ch/hotfix/ci\-pipelines\-2019.2.1
.IP \(bu 2
b09963b Update CI pipelines. Remove old jenkins cruft.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53728\fP: (\fI\%garethgreenaway\fP) [2019.2.1] Disabling test_get_set_computer_name on OS X and Py3
@ \fI2019\-07\-19 17:18:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
15accef Merge pull request \fI\%#53728\fP from garethgreenaway/2019_2_1_mac_system_disable_test_get_set_computer_name
.IP \(bu 2
a6d853c Merge branch \(aq2019.2.1\(aq into 2019_2_1_mac_system_disable_test_get_set_computer_name
.IP \(bu 2
5d537ed Missing six import.  Updating skip message.
.IP \(bu 2
ac6dccd Disabling test_get_set_computer_name on OS X and Py3.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53913\fP: (\fI\%garethgreenaway\fP) [2019.2.1] skip test_issue_2594_non_invalidated_cache on MacOS
@ \fI2019\-07\-19 17:17:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
a54ec89 Merge pull request \fI\%#53913\fP from garethgreenaway/disable_test_issue_2594_non_invalidated_cache_macos
.IP \(bu 2
c65c5d5 Skip the test test_issue_2594_non_invalidated_cache on MacOS where it is flakey.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53902\fP: (\fI\%twangboy\fP) Skip tests that modify date or time
@ \fI2019\-07\-18 17:53:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
b091eb7 Merge pull request \fI\%#53902\fP from twangboy/skip_dt
.IP \(bu 2
76cf936 Skip tests that modify date or time
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53901\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Don\(aqt fail when combining coverage files
@ \fI2019\-07\-18 17:46:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
22b7b1a Merge pull request \fI\%#53901\fP from s0undt3ch/hotfix/wrap\-coverage\-combine
.IP \(bu 2
b459a48 Don\(aqt fail when combining coverage files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53542\fP: (\fI\%dwoz\fP) Fix leak of SaltMessageClient instances when using tcp transport
@ \fI2019\-07\-18 17:44:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
84e798a Merge pull request \fI\%#53542\fP from dwoz/tcp_leak
.IP \(bu 2
3daeb4f Update TCP pipelines
.IP \(bu 2
52f9556 Merge branch \(aq2019.2.1\(aq into tcp_leak
.IP \(bu 2
f5313fd Fix tcp message client test
.IP \(bu 2
3419bf5 Merge branch \(aq2019.2.1\(aq into tcp_leak
.IP \(bu 2
3125cd3 Merge branch \(aq2019.2.1\(aq into tcp_leak
.IP \(bu 2
9a33582 Merge branch \(aq2019.2.1\(aq into tcp_leak
.IP \(bu 2
7eb5d41 Merge branch \(aq2019.2.1\(aq into tcp_leak
.IP \(bu 2
481372b Fix torando loop thread issue
.IP \(bu 2
aff15d4 Fix linter wart
.IP \(bu 2
9606db7 Comment the tcp message client test better
.IP \(bu 2
dcf576f Add unit test for tcp message client close method
.IP \(bu 2
4420556 Download artifacts for tcp jobs
.IP \(bu 2
e6a09dd Merge remote\-tracking branch \(aqorigin/tcp_leak\(aq into tcp_leak
.INDENT 2.0
.IP \(bu 2
f484f3f Merge branch \(aq2019.2.1\(aq into tcp_leak
.UNINDENT
.IP \(bu 2
4a37234 Add tcp suffix to github notifications
.IP \(bu 2
4a2848b Add transport PR tests
.IP \(bu 2
9a4b407 Fix leak of SaltMessageClient instances when using tcp transport
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
592f3fe undo test
.IP \(bu 2
bc550ad wip pytest test david
.IP \(bu 2
75571e4 fixs timezone decode error
.IP \(bu 2
d041660 fixes timezone decode error
.IP \(bu 2
1ddd1a9 fixs timezone decode error
.IP \(bu 2
e75dafa patches timezone grain
.IP \(bu 2
eaca473 patches salt grains locale_info decode error
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53873\fP: (\fI\%bryceml\fP) increase sleep time between kitchen create failures to account for ap...
@ \fI2019\-07\-16 23:46:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
61e9efd Merge pull request \fI\%#53873\fP from bryceml/2019.2.1\-increase\-sleep
.IP \(bu 2
aae0bf6 increase sleep time between kitchen create failures to account for api limits
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53750\fP: (\fI\%twangboy\fP) Fix memory error when the test suite cleans up (2019.2.1)
@ \fI2019\-07\-16 23:00:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
317d9af Merge pull request \fI\%#53750\fP from twangboy/fix_helpers
.IP \(bu 2
fa0e9c3 Merge branch \(aq2019.2.1\(aq into fix_helpers
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53851\fP: (\fI\%dwoz\fP) Master stats revert
@ \fI2019\-07\-16 16:05:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c2b3a5 Merge pull request \fI\%#53851\fP from dwoz/master_stats_revert
.IP \(bu 2
0bc72e4 Revert \(dqMerge pull request \fI\%#53822\fP from dwoz/master_stats_test\(dq
.IP \(bu 2
4553ba7 Revert \(dqMerge pull request \fI\%#53829\fP from saltstack/fix_stats_2019.2.1\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53829\fP: (\fI\%dwoz\fP) Fix stats on windows
@ \fI2019\-07\-12 01:03:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
5064027 Merge pull request \fI\%#53829\fP from saltstack/fix_stats_2019.2.1
.IP \(bu 2
9f2d20d Fix stats on windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53826\fP: (\fI\%dmurphy18\fP) WAR ROOM test skip till rewritten to allow for dnf on RHEL 8 and F30
@ \fI2019\-07\-12 00:39:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
971eda3 Merge pull request \fI\%#53826\fP from dmurphy18/fedora30_fixes
.IP \(bu 2
34b261d WAR ROOM test skip till rewritten to allow for dnf on RHEL 8 and Fedora 30
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53822\fP: (\fI\%dwoz\fP) Enable master stats for tests
@ \fI2019\-07\-11 23:37:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
ba33d76 Merge pull request \fI\%#53822\fP from dwoz/master_stats_test
.IP \(bu 2
d2b8315 Enable master stats for tests
.IP \(bu 2
3471422 Fix memory error when the test suite cleans up
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53591\fP: (\fI\%twangboy\fP) Fix whitelist errors in \fItest_boto_*\fP state tests on Windows
@ \fI2019\-07\-07 05:45:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
1756156 Merge pull request \fI\%#53591\fP from twangboy/fix_boto_tests
.IP \(bu 2
ba8ba26 Merge branch \(aq2019.2.1\(aq into fix_boto_tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#53532\fP: (\fI\%dafyddj\fP) win_lgpo.py: crash caused by empty presentation text element (refs: \fI\%#53662\fP)
.IP \(bu 2
\fBPR\fP \fI\%#53688\fP: (\fI\%twangboy\fP) Merge Forward \fI\%#53662\fP (2019.2.1)
@ \fI2019\-07\-07 05:44:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#53662\fP: (\fI\%lomeroe\fP) Update win_lgpo (refs: \fI\%#53688\fP)
.IP \(bu 2
464464c Merge pull request \fI\%#53688\fP from twangboy/mf_53662
.IP \(bu 2
c19dc97 Merge branch \(aq2019.2.1\(aq into mf_53662
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52391\fP: (\fI\%rsmekala\fP) Port Junos\-related bug fixes from develop to 2019.2 (refs: \fI\%#52401\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52401\fP: (\fI\%rsmekala\fP) Port Junos\-related bug fixes from develop to 2019.2
@ \fI2019\-07\-06 21:50:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51164\fP: (\fI\%rsmekala\fP) Updates to salt\-junos modules (refs: \fI\%#52401\fP)
.IP \(bu 2
1a76e00 Merge pull request \fI\%#52401\fP from rsmekala/2019.2.1
.IP \(bu 2
345938d Merge branch \(aq2019.2.1\(aq into 2019.2.1
.IP \(bu 2
326f9f4 Merge branch \(aq2019.2.1\(aq into 2019.2.1
.IP \(bu 2
c11a004 Merge branch \(aq2019.2.1\(aq into 2019.2.1
.IP \(bu 2
33b45d2 Merge branch \(aq2019.2.1\(aq into 2019.2.1
.IP \(bu 2
af66fac Merge branch \(aq2019.2.1\(aq into 2019.2.1
.IP \(bu 2
211b169 Ported relevant fixes from unit.modules.test_junos from develop to 2019.2
.IP \(bu 2
0c51bc9 Ported relevant fixes from states.junos from develop to 2019.2
.IP \(bu 2
a966ad1 Ported relevant fixes from proxy.junos from develop to 2019.2
.IP \(bu 2
263e9f5 Ported relevant fixes from modules.junos from develop to 2019.2
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
b9033b9 Merge branch \(aq2019.2.1\(aq into mf_53662
.IP \(bu 2
75e740e Merge forward \fI\%#53662\fP
.INDENT 2.0
.IP \(bu 2
8ace391 Merge branch \(aq2019.2.1\(aq into fix_boto_tests
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53585\fP: (\fI\%twangboy\fP) Fix \fItest_winrepo\fP on Windows
@ \fI2019\-07\-06 15:15:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
056f596 Merge pull request \fI\%#53585\fP from twangboy/fix_test_winrepo
.IP \(bu 2
c1f8cba Merge branch \(aq2019.2.1\(aq into fix_test_winrepo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53590\fP: (\fI\%twangboy\fP) Fix \fItest status\fP on Windows
@ \fI2019\-07\-06 15:15:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
db950f2 Merge pull request \fI\%#53590\fP from twangboy/fix_test_status
.IP \(bu 2
67750b7 Merge branch \(aq2019.2.1\(aq into fix_test_status
.IP \(bu 2
b667045 Merge branch \(aq2019.2.1\(aq into fix_test_status
.IP \(bu 2
9b4338a Merge branch \(aq2019.2.1\(aq into fix_test_status
.IP \(bu 2
2735b19 Add __grains__
.IP \(bu 2
bb12da9 Load grains properly
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
91da774 Merge branch \(aq2019.2.1\(aq into fix_test_winrepo
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53556\fP: (\fI\%twangboy\fP) Fixes an issue with line endings in the jinja renderer
@ \fI2019\-07\-05 23:06:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
becaf12 Merge pull request \fI\%#53556\fP from twangboy/fix_test_pillar
.IP \(bu 2
ac405d1 Merge branch \(aq2019.2.1\(aq into fix_test_pillar
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53557\fP: (\fI\%twangboy\fP) Fix test_pydsl on Windows
@ \fI2019\-07\-05 22:36:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
7a5111b Merge pull request \fI\%#53557\fP from twangboy/fix_test_pydsl
.IP \(bu 2
d9df951 Merge branch \(aq2019.2.1\(aq into fix_test_pydsl
.IP \(bu 2
1619c68 Merge branch \(aq2019.2.1\(aq into fix_test_pydsl
.IP \(bu 2
2c3e91d Fix test_pydsl on Windows
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
137f4a4 Merge branch \(aq2019.2.1\(aq into fix_test_pillar
.IP \(bu 2
4a96252 Fixes an issue with line endings in the jinja renderer
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
c8c8bc0 Merge branch \(aq2019.2.1\(aq into fix_test_winrepo
.IP \(bu 2
8373865 Merge branch \(aq2019.2.1\(aq into fix_test_winrepo
.IP \(bu 2
a818396 Split out the tests, patch test=True
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
62041eb Merge branch \(aq2019.2.1\(aq into fix_boto_tests
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53653\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Log which address failed to resolve
@ \fI2019\-07\-05 18:29:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
8f05226 Merge pull request \fI\%#53653\fP from s0undt3ch/hotfix/fix\-nox\-bypass\-2019.2.1
.IP \(bu 2
f44253c Merge branch \(aq2019.2.1\(aq into hotfix/fix\-nox\-bypass\-2019.2.1
.IP \(bu 2
0ead7fe Log which address failed to resolve
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53725\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Archive the kitchen logs
@ \fI2019\-07\-05 18:19:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
f750f44 Merge pull request \fI\%#53725\fP from s0undt3ch/features/f30\-reqs\-2019.2.1
.IP \(bu 2
118fbf7 Improve slack message
.IP \(bu 2
62a2ee8 Archive the kitchen logs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53689\fP: (\fI\%twangboy\fP) Merge Forward \fI\%#52593\fP (2019.2.1)
@ \fI2019\-07\-05 14:58:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#52593\fP: (\fI\%twangboy\fP) Update setup.py (refs: \fI\%#53689\fP)
.IP \(bu 2
0c6009f Merge pull request \fI\%#53689\fP from twangboy/fix_setup_2019.2.1
.IP \(bu 2
c6f3da5 Merge branch \(aq2019.2.1\(aq into fix_setup_2019.2.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53690\fP: (\fI\%twangboy\fP) Merge Forward \fI\%#52065\fP (2019.2.1)
@ \fI2019\-07\-05 14:55:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#52065\fP: (\fI\%twangboy\fP) Use the dism binary that matches system architecture (refs: \fI\%#53690\fP)
.IP \(bu 2
54c4220 Merge pull request \fI\%#53690\fP from twangboy/fix_win_dism_2019.2.1
.IP \(bu 2
fae9f1a Merge branch \(aq2019.2.1\(aq into fix_win_dism_2019.2.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53719\fP: (\fI\%s0undt3ch\fP) [2019.2.1] PR Pipeline Enhancements
@ \fI2019\-07\-04 20:29:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
78c45eb Merge pull request \fI\%#53719\fP from s0undt3ch/features/f30\-reqs\-2019.2.1
.IP \(bu 2
76b99fd Enhance lint report
.IP \(bu 2
45f19af Use milestones to abort previous, still running, builds, on new builds
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53697\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Add Fedora 30 requirements files
@ \fI2019\-07\-04 04:26:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
3db4ddb Merge pull request \fI\%#53697\fP from s0undt3ch/features/f30\-reqs\-2019.2.1
.IP \(bu 2
36198cd Delete Opensuse 42 static requirements
.IP \(bu 2
4413626 Delete Fedora 28 static requirements
.IP \(bu 2
41809e5 Add Fedora 30 requirements files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53680\fP: (\fI\%Ch3LL\fP) Pytest 5.0 contextmanager str: call value on ExceptionInfo objects
@ \fI2019\-07\-04 00:12:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
f5c5da4 Merge pull request \fI\%#53680\fP from Ch3LL/pytest_5_changes
.IP \(bu 2
b5e2b0b Merge branch \(aq2019.2.1\(aq into pytest_5_changes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53682\fP: (\fI\%twangboy\fP) Fix compare issue in lgpo state module
@ \fI2019\-07\-03 04:43:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
727843c Merge pull request \fI\%#53682\fP from twangboy/fix_lock_1740_lgpo
.IP \(bu 2
62450db Merge branch \(aq2019.2.1\(aq into fix_lock_1740_lgpo
.IP \(bu 2
f6276a3 Fix compare issue in lgpo state module
.INDENT 2.0
.IP \(bu 2
110b953 Pytest 5.0 contextmanager str: call value on ExceptionInfo objects
.IP \(bu 2
b71b655 Merge forward \fI\%#52065\fP
.IP \(bu 2
023c47d Fix typo
.IP \(bu 2
43dd7b3 Merge Forward \fI\%#52593\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53678\fP: (\fI\%twangboy\fP) Fix LGPO when string object is None
@ \fI2019\-07\-02 23:47:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
491bfa8 Merge pull request \fI\%#53678\fP from twangboy/fix_lock_1688_lgpo
.IP \(bu 2
7b05bf8 Merge branch \(aq2019.2.1\(aq into fix_lock_1688_lgpo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53220\fP: (\fI\%twangboy\fP) Don\(aqt remove the pythonwin directory (2019.2.1)
@ \fI2019\-07\-02 22:43:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
4a4a91b Merge pull request \fI\%#53220\fP from twangboy/fix_pywin32_2019.2.1
.IP \(bu 2
748bf1c Merge branch \(aq2019.2.1\(aq into fix_pywin32_2019.2.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53614\fP: (\fI\%Ch3LL\fP) Increase flaky attempts on mac tests using systemsetup
@ \fI2019\-07\-02 21:33:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
c2befe2 Merge pull request \fI\%#53614\fP from Ch3LL/mac_flaky
.IP \(bu 2
5460031 Merge branch \(aq2019.2.1\(aq into mac_flaky
.IP \(bu 2
7dcaaf0 Increase flaky attempts on mac tests using systemsetup
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53624\fP: (\fI\%Ch3LL\fP) Allow yaml list notation for nodegroup expansion
@ \fI2019\-07\-02 21:32:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
02461cb Merge pull request \fI\%#53624\fP from Ch3LL/nodegroup_group_list
.IP \(bu 2
475d904 Merge branch \(aq2019.2.1\(aq into nodegroup_group_list
.IP \(bu 2
fbb15cd Add nodegroup list test
.IP \(bu 2
ee59d39 Merge branch \(aq2019.2.1\(aq into nodegroup_group_list
.IP \(bu 2
d236bd4 Allow yaml list notation for nodegroup expansion
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53562\fP: (\fI\%Ch3LL\fP) Move create key call into try/except in Digital Ocean key test
@ \fI2019\-07\-02 16:08:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
8857dbd Merge pull request \fI\%#53562\fP from Ch3LL/do_key_test
.IP \(bu 2
315eb35 Merge branch \(aq2019.2.1\(aq into do_key_test
.IP \(bu 2
75ac708 Merge branch \(aq2019.2.1\(aq into do_key_test
.IP \(bu 2
128ba07 Move create key call into try/except in Digital Ocean key test
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
22d4a3a Merge branch \(aq2019.2.1\(aq into fix_pywin32_2019.2.1
.IP \(bu 2
6bb6df7 Merge branch \(aq2019.2.1\(aq into fix_pywin32_2019.2.1
.IP \(bu 2
534c984 Merge branch \(aq2019.2.1\(aq into fix_pywin32_2019.2.1
.IP \(bu 2
382c637 Merge branch \(aq2019.2.1\(aq into fix_pywin32_2019.2.1
.IP \(bu 2
fb4090d update py3 script
.IP \(bu 2
0ea70ba Don\(aqt remove pythonwin directory
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
ba37276 Use string_types instead of text_types
.IP \(bu 2
f6d0084 Add some unit tests, raise error on non\-string types
.IP \(bu 2
35ed8be Create function for encoding string values
.IP \(bu 2
c4c1082 Return encoded null when string value is None
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53627\fP: (\fI\%dmurphy18\fP) Cherry pick pr 53370 from 2018.3 into 2019.2.1
@ \fI2019\-06\-28 19:54:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
164aaeb Merge pull request \fI\%#53627\fP from dmurphy18/cherry\-pick\-pr\-53370
.IP \(bu 2
450d23d Merge branch \(aq2019.2.1\(aq into cherry\-pick\-pr\-53370
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#53411\fP: (\fI\%cro\fP) Events can grow stale when event_listen_queue is set. (refs: \fI\%#53587\fP, \fI\%#53412\fP)
.IP \(bu 2
\fBPR\fP \fI\%#53587\fP: (\fI\%cro\fP) Forward port from 2018.3 Add event_listen_queue_max_seconds to fix \fI\%#53411\fP
@ \fI2019\-06\-28 16:49:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#53412\fP: (\fI\%cro\fP) Stale events 53411 (refs: \fI\%#53587\fP)
.IP \(bu 2
6559e4c Merge pull request \fI\%#53587\fP from cro/53412\-2019.2.1
.IP \(bu 2
9e69bd4 Merge branch \(aq2019.2.1\(aq into 53412\-2019.2.1
.IP \(bu 2
949a026 Merge branch \(aq2019.2.1\(aq into 53412\-2019.2.1
.IP \(bu 2
f5d81c9 Merge branch \(aq2019.2.1\(aq into 53412\-2019.2.1
.IP \(bu 2
d74c313 Merge branch \(aq2019.2.1\(aq into 53412\-2019.2.1
.IP \(bu 2
b3c3f52 Make doc build test pass.
.IP \(bu 2
8001130 Add event_listen_queue_max_seconds to fix \fI\%#53411\fP
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
34e38d7 Merge branch \(aq2019.2.1\(aq into cherry\-pick\-pr\-53370
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#53283\fP: (\fI\%Ch3LL\fP) integration.states.test_file.FileTest.test_directory_broken_symlink (refs: \fI\%#53295\fP)
.IP \(bu 2
\fBPR\fP \fI\%#53295\fP: (\fI\%DmitryKuzmenko\fP) Recurse kwarg of state.directory state shall be a list or None
@ \fI2019\-06\-27 23:20:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
14efced Merge pull request \fI\%#53295\fP from DSRCorporation/bugs/test_file_recurse_set
.IP \(bu 2
2927b78 Merge branch \(aq2019.2.1\(aq into bugs/test_file_recurse_set
.IP \(bu 2
9c01670 Merge branch \(aq2019.2.1\(aq into bugs/test_file_recurse_set
.IP \(bu 2
571d82a Merge branch \(aq2019.2.1\(aq into bugs/test_file_recurse_set
.IP \(bu 2
ee8f0e3 Merge branch \(aq2019.2.1\(aq into bugs/test_file_recurse_set
.IP \(bu 2
013e04c Recurse kwarg of state.directory state shall be a list of None
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52926\fP: (\fI\%waynew\fP) integration.states.test_beacon.BeaconStateTestCase.test_present_absent \- Beacon \(dqdiskusage\(dq is not available (refs: \fI\%#53493\fP, \fI\%#53466\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#52245\fP: (\fI\%twangboy\fP) integration.states.test_beacon.BeaconStateTestCase.test_present_absent (refs: \fI\%#53493\fP, \fI\%#53466\fP)
.IP \(bu 2
\fBPR\fP \fI\%#53466\fP: (\fI\%dwoz\fP) More robust beacon state test
@ \fI2019\-06\-27 23:17:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
75175bb Merge pull request \fI\%#53466\fP from dwoz/test_pres_abs
.IP \(bu 2
f24bf06 Use new pipeline format
.IP \(bu 2
a74580b Clean up cruft
.IP \(bu 2
68958f5 Do not create duplicate minion ids
.IP \(bu 2
c47eeb4 Add amazon 2 to PR tests
.IP \(bu 2
dc90b47 More robust beacon state test
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
95b1819 Initial working tests for gpg fixes and import keys, signing
.IP \(bu 2
b2c9ae2 Update access to str/bytes with to_unicode/to_bytes for Python 3
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53609\fP: (\fI\%s0undt3ch\fP) CI Pipelines. Timeout after getting a node. Report exit code.
@ \fI2019\-06\-27 16:09:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
582ac5f Merge pull request \fI\%#53609\fP from s0undt3ch/hotfix/fix\-nox\-bypass\-2019.2.1
.IP \(bu 2
024be84 CI Pipelines. Timeout after getting a node. Report exit code.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53574\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Minor fixes/adjustments to the new CI pipelines
@ \fI2019\-06\-25 18:48:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
f568796 Merge pull request \fI\%#53574\fP from s0undt3ch/hotfix/fix\-nox\-bypass\-2019.2.1
.IP \(bu 2
e85e2f4 Minor fixes/adjustments to the new CI pipelines
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53584\fP: (\fI\%dwoz\fP) Add unit tests for recent SaltCacheLoader changes
@ \fI2019\-06\-24 23:40:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#53563\fP: (\fI\%twangboy\fP) SaltCacheLoader does not create multiple FileClients (refs: \fI\%#53584\fP)
.IP \(bu 2
77b7fc4 Merge pull request \fI\%#53584\fP from dwoz/client_cache
.IP \(bu 2
e9b61dc Add unit tests for recent SaltCacheLoader changes
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
5558a0a Add reg to the whitelist
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53563\fP: (\fI\%twangboy\fP) SaltCacheLoader does not create multiple FileClients (refs: \fI\%#53584\fP)
@ \fI2019\-06\-22 23:23:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
6ed6c31 Merge pull request \fI\%#53563\fP from twangboy/py3_windows_hang
.IP \(bu 2
369720e Allow the file_client to be overridden
.IP \(bu 2
f6c592c Don\(aqt instantiate the file_client every time
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53432\fP: (\fI\%garethgreenaway\fP) [2019.2.1] Various fixes for 2019.2.1 to ensure tests pass on Mac OS X
@ \fI2019\-06\-21 13:47:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
c606952 Merge pull request \fI\%#53432\fP from garethgreenaway/2019_2_1_mac_fixes
.IP \(bu 2
1974f11 Disabling a couple more tests in integration.modules.test_cp that hang on OS X and Py2.
.IP \(bu 2
7721151 Fixing lint.
.IP \(bu 2
1d4e228 Updating various skips for tests to only skip if OS is OS X and Python is Python2.
.IP \(bu 2
01dafdc Skipping integration.modules.test_cp.CPModuleTest.test_get_file_str_https on OS X
.IP \(bu 2
c02db20 Disabling integration.modules.test_state.StateModuleTest.test_parallel_state_with_long_tag
.IP \(bu 2
8788877 Skip integration.states.test_file.FileTest.test_issue_11003_immutable_lazy_proxy_sum and integration.states.test_pip_state.PipStateTest.test_22359_pip_installed_unless_does_not_trigger_warnings when running on OS X.
.IP \(bu 2
cf76027 Removing wrong import of skipIf
.IP \(bu 2
b10e1e7 Moving the skipIf for OS X from the beacon state tests to the renderer state tests.
.IP \(bu 2
d2fef9a Disabling beacon state tests on OS X for the time being.
.IP \(bu 2
1741bb0 Adding some timeouts to see if it helps the tests pass on OS X.
.IP \(bu 2
fd0ba0a Ensure the user and group used by @with_system_user_and_group are consistent.
.IP \(bu 2
e03ab81 Using salt.utils.path.which to find false, on OSX it lives under /usr/bin/
.IP \(bu 2
353f9d4 Fixing the beacons.reset function.  Once the reset has taken place in beacons/__init__.py we need to fire an event back to complete the loop and ensure that everything worked as expected.
.IP \(bu 2
ee3cbc7 fix to how the depends decorator works.  Only run the dependency commands for the module we\(aqre checking.
.IP \(bu 2
8440176 Fixing a log issue that pops up after test_gen_thin_compression_fallback_py3 on \(dqOS X, need to ensure that salt.utils.thin.os.close is mocked.
.IP \(bu 2
9767ddd Format for the sqlite3 database used for the assistive information changed in Mojave, additional columns added.
.IP \(bu 2
9c8a7e6 Fixing a bug when the roots fileserver and the location is a symlink to another location.  This fix ensures that when fsroot is referenced we are using the real path and not the symlink path.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53526\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Update pipelines to work on old and new jenkins
@ \fI2019\-06\-20 15:29:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
59e2a1f Merge pull request \fI\%#53526\fP from s0undt3ch/hotfix/fix\-nox\-bypass\-2019.2.1
.IP \(bu 2
24d6d09 Update pipelines to work on old and new jenkins
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53210\fP: (\fI\%Ch3LL\fP) Cherry\-Pick \fI\%#52787\fP into 2019.2.1
@ \fI2019\-06\-20 13:33:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#52787\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to test_pip state sls files (refs: \fI\%#53210\fP)
.IP \(bu 2
f5f80af Merge pull request \fI\%#53210\fP from Ch3LL/cp\-52787
.IP \(bu 2
f27c434 Merge branch \(aq2019.2.1\(aq into cp\-52787
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53467\fP: (\fI\%twangboy\fP) Check valid username first (fixes failing symlink test)
@ \fI2019\-06\-19 17:04:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd6cb35 Merge pull request \fI\%#53467\fP from twangboy/fix_test_win_file
.IP \(bu 2
92950c5 Merge branch \(aq2019.2.1\(aq into fix_test_win_file
.IP \(bu 2
6a21edb Merge branch \(aq2019.2.1\(aq into fix_test_win_file
.IP \(bu 2
31ce1fb Fix some lint, skip some tests
.IP \(bu 2
6de4db6 Monkeypatch in the class instead of globally
.IP \(bu 2
d663a1f Fix the failing BlockReplace test cases on Windows
.IP \(bu 2
299f88f Update test_managed_contents
.IP \(bu 2
81110e5 Fix test_file_copy_make_dirs that was failing on Linux
.IP \(bu 2
8d0529d Fix some lint
.IP \(bu 2
4a9c020 Fix issues with win_runas
.IP \(bu 2
bceffa1 Remove privs message
.IP \(bu 2
54be0a6 Verify username early in win_runas
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53475\fP: (\fI\%Ch3LL\fP) Add pypsexec requirement for cloud tests
@ \fI2019\-06\-19 13:30:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
3230078 Merge pull request \fI\%#53475\fP from Ch3LL/add_pypsexec
.IP \(bu 2
ab59a55 Merge branch \(aq2019.2.1\(aq into add_pypsexec
.IP \(bu 2
f954363 Merge branch \(aq2019.2.1\(aq into add_pypsexec
.IP \(bu 2
8f7cbfc Merge branch \(aq2019.2.1\(aq into add_pypsexec
.IP \(bu 2
fa22b39 Add pypsexec requirement for cloud tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53491\fP: (\fI\%Ch3LL\fP) Update test_gen_hash for macosx
@ \fI2019\-06\-19 13:16:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
bdd7c2c Merge pull request \fI\%#53491\fP from Ch3LL/crypt_test_mac
.IP \(bu 2
85e96bd Merge branch \(aq2019.2.1\(aq into crypt_test_mac
.IP \(bu 2
700338e Merge branch \(aq2019.2.1\(aq into crypt_test_mac
.IP \(bu 2
4ce7fb1 Merge branch \(aq2019.2.1\(aq into crypt_test_mac
.IP \(bu 2
832ded6 Merge branch \(aq2019.2.1\(aq into crypt_test_mac
.IP \(bu 2
775b8c2 Merge branch \(aq2019.2.1\(aq into crypt_test_mac
.IP \(bu 2
0832b49 Update test_gen_hash for macosx
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53494\fP: (\fI\%Ch3LL\fP) Always delete digital ocean key for test_key_management test
@ \fI2019\-06\-19 13:14:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
8c2e952 Merge pull request \fI\%#53494\fP from Ch3LL/do_cloud_test
.IP \(bu 2
5053eab Merge branch \(aq2019.2.1\(aq into do_cloud_test
.IP \(bu 2
64a3e8d Merge branch \(aq2019.2.1\(aq into do_cloud_test
.IP \(bu 2
45c0c43 Merge branch \(aq2019.2.1\(aq into do_cloud_test
.IP \(bu 2
3826c56 Allows delete digital ocean key for test_key_management test
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
6b6dc66 Merge branch \(aq2019.2.1\(aq into cp\-52787
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53434\fP: (\fI\%weswhet\fP) Update documentation for newer mac_service module.
@ \fI2019\-06\-19 01:15:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e3778b Merge pull request \fI\%#53434\fP from weswhet/patch\-2
.IP \(bu 2
89398a9 Update salt.modules.service.rst
.IP \(bu 2
b9c1b1a Update salt.modules.service.rst
.IP \(bu 2
a962a64 Merge branch \(aq2019.2.1\(aq into patch\-2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53498\fP: (\fI\%amendlik\fP) Fix broken documentation links
@ \fI2019\-06\-18 23:44:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
f72ebba Merge pull request \fI\%#53498\fP from amendlik/links
.IP \(bu 2
e360a70 Fix broken documentation links for service virtual module
.IP \(bu 2
56f65ec Fix broken documentation links for pkg virtual module
.INDENT 2.0
.IP \(bu 2
010a2c5 Update documentation for newer mac_service module.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
1bbdc7f Merge branch \(aq2019.2.1\(aq into cp\-52787
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53514\fP: (\fI\%Ch3LL\fP) Revert logging changes from \fI\%#53492\fP
@ \fI2019\-06\-18 20:49:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#53492\fP: (\fI\%dwoz\fP)  Fix syndic connection when using tcp transport (refs: \fI\%#53514\fP)
.IP \(bu 2
0793272 Merge pull request \fI\%#53514\fP from Ch3LL/disable_py3_logging
.IP \(bu 2
8c8f0ac import six runtests log handler
.IP \(bu 2
f442b33 Revert \(dqEnable logging for test runs on py3\(dq
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
b62be16 Merge branch \(aq2019.2.1\(aq into cp\-52787
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53485\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Workaround nox\(aqs install only flag
@ \fI2019\-06\-18 09:35:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
98285f9 Merge pull request \fI\%#53485\fP from s0undt3ch/hotfix/fix\-nox\-bypass\-2019.2.1
.IP \(bu 2
69e1d84 Workaround nox\(aqs install only flag
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
8622bba Merge branch \(aq2019.2.1\(aq into cp\-52787
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53369\fP: (\fI\%Akm0d\fP) Added refs to AIX module documentation
@ \fI2019\-06\-17 20:29:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
ff7370e Merge pull request \fI\%#53369\fP from Akm0d/aix_docs
.IP \(bu 2
2ece253 Merge branch \(aq2019.2.1\(aq into aix_docs
.IP \(bu 2
f2eda45 Merge branch \(aq2019.2.1\(aq into aix_docs
.IP \(bu 2
3e793ac Merge branch \(aq2019.2.1\(aq into aix_docs
.IP \(bu 2
e800641 Merge branch \(aq2019.2.1\(aq into aix_docs
.IP \(bu 2
0ef9892 Merge branch \(aq2019.2.1\(aq into aix_docs
.IP \(bu 2
65cb718 Merge branch \(aq2019.2.1\(aq into aix_docs
.IP \(bu 2
32f4d7e Merge branch \(aq2019.2.1\(aq into aix_docs
.IP \(bu 2
a59f45e Merge branch \(aq2019.2.1\(aq into aix_docs
.IP \(bu 2
29f89a4 Merge branch \(aq2019.2.1\(aq into aix_docs
.IP \(bu 2
e74345c Merge branch \(aq2019.2.1\(aq into aix_docs
.IP \(bu 2
28fbd11 Merge branch \(aq2019.2.1\(aq into aix_docs
.IP \(bu 2
60129f0 Merge branch \(aqaix_docs\(aq of github.com:Akm0d/salt into aix_docs
.INDENT 2.0
.IP \(bu 2
a1c4abc Merge branch \(aq2019.2.1\(aq into aix_docs
.IP \(bu 2
e2c9fcc Merge branch \(aq2019.2.1\(aq into aix_docs
.UNINDENT
.IP \(bu 2
fd197d3 Merge branch \(aq2019.2.1\(aq of \fI\%https://github.com/saltstack/salt\fP into aix_docs
.IP \(bu 2
6d42cf7 Merge branch \(aqaix_docs\(aq of github.com:Akm0d/salt into aix_docs
.INDENT 2.0
.IP \(bu 2
fae6045 Merge branch \(aq2019.2.1\(aq into aix_docs
.UNINDENT
.IP \(bu 2
97145b0 Merge branch \(aq2019.2.1\(aq of \fI\%https://github.com/saltstack/salt\fP into aix_docs
.IP \(bu 2
6d16343 Updated \(aqused for\(aq description of aixpkg
.IP \(bu 2
6092683 Added aixpkg to index
.IP \(bu 2
2867d07 Added refs to AIX module documentation
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
458fe9f Merge branch \(aq2019.2.1\(aq into cp\-52787
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53461\fP: (\fI\%waynew\fP) Update file.chattr
@ \fI2019\-06\-14 21:16:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
8df7684 Merge pull request \fI\%#53461\fP from waynew/fix\-chattr\-problems
.IP \(bu 2
a8d8174 Merge branch \(aq2019.2.1\(aq into fix\-chattr\-problems
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52926\fP: (\fI\%waynew\fP) integration.states.test_beacon.BeaconStateTestCase.test_present_absent \- Beacon \(dqdiskusage\(dq is not available (refs: \fI\%#53493\fP, \fI\%#53466\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#52245\fP: (\fI\%twangboy\fP) integration.states.test_beacon.BeaconStateTestCase.test_present_absent (refs: \fI\%#53493\fP, \fI\%#53466\fP)
.IP \(bu 2
\fBPR\fP \fI\%#53493\fP: (\fI\%dwoz\fP) Cherry\-pick and merge beacon event change
@ \fI2019\-06\-14 20:36:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
cfe866d Merge pull request \fI\%#53493\fP from dwoz/cherry_pick_test_fix
.IP \(bu 2
fb104bb Cherry\-pick and merge beacon event change
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53492\fP: (\fI\%dwoz\fP)  Fix syndic connection when using tcp transport (refs: \fI\%#53514\fP)
@ \fI2019\-06\-14 19:23:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
a1f4136 Merge pull request \fI\%#53492\fP from dwoz/tcp_syndic_fix
.IP \(bu 2
17c983b Fix linter
.IP \(bu 2
9339425 Enable logging for test runs on py3
.IP \(bu 2
f1b65d1 Fix syndic connection when using tcp transport
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53437\fP: (\fI\%twangboy\fP) Fix failing symlink test
@ \fI2019\-06\-12 22:53:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
e852596 Merge pull request \fI\%#53437\fP from twangboy/fix_test_win_file
.IP \(bu 2
8c30dbd Add priv info to error message
.IP \(bu 2
a7d41a8 Make them non\-destructive tests
.IP \(bu 2
d8bede0 Remove duplicate test
.IP \(bu 2
89aaf2e Remove duplicate test
.IP \(bu 2
184ec4a Skip test on linux
.IP \(bu 2
c97ea99 Mark it a destructive test
.IP \(bu 2
9da7090 Fix failing symlink test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53408\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Fix static requirements
@ \fI2019\-06\-12 22:52:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
a92836b Merge pull request \fI\%#53408\fP from s0undt3ch/hotfix/fix\-pkg\-reqs\-2019.2.1
.IP \(bu 2
19629a0 Fix \fIunit.templates.test_jinja.TestCustomExtensions.test_http_query\fP
.IP \(bu 2
5aee99b Take into account the packaging requirements for OSX
.IP \(bu 2
b9618f6 Take into account the packaging requirements for windows
.IP \(bu 2
ff63ae4 Stop compiling static TCP requirements.
.INDENT 2.0
.IP \(bu 2
62e590b Update file.chattr
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53165\fP: (\fI\%Ch3LL\fP) Update ami\(aqs used for windows cloud tests
@ \fI2019\-06\-11 15:54:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab9fe46 Merge pull request \fI\%#53165\fP from Ch3LL/ami_window_cloud
.IP \(bu 2
1d0b0a6 Merge branch \(aq2019.2.1\(aq into ami_window_cloud
.IP \(bu 2
a77a05c Merge branch \(aq2019.2.1\(aq into ami_window_cloud
.IP \(bu 2
a1204dc Merge branch \(aq2019.2.1\(aq into ami_window_cloud
.IP \(bu 2
d15c8f2 Merge branch \(aq2019.2.1\(aq into ami_window_cloud
.IP \(bu 2
941778f Update ami\(aqs used for windows cloud tests
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#53332\fP: (\fI\%s0undt3ch\fP) Non optional full test runs for 2019.2.1 (refs: \fI\%#53431\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53431\fP: (\fI\%dwoz\fP) Revert \(dqNon optional full test runs for 2019.2.1\(dq
@ \fI2019\-06\-10 21:44:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
d806b58 Merge pull request \fI\%#53431\fP from saltstack/revert\-53332\-hotfix/full\-test\-run\-2019.2.1
.IP \(bu 2
701218c Revert \(dqNon optional full test runs for 2019.2.1\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52174\fP: (\fI\%amendlik\fP) file.stat function not working under Python 3 (refs: \fI\%#53430\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#53430\fP: (\fI\%Akm0d\fP) Cherry\-pick \fI\%#52174\fP into 2019.2.1
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
7811971 Merge branch \(aq2019.2.1\(aq into cp\-52787
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53389\fP: (\fI\%bryceml\fP) only keep last 10 builds of every pr on jenkins to reduce disk usage
@ \fI2019\-06\-10 17:18:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b800a2 Merge pull request \fI\%#53389\fP from bryceml/2019.2.1
.IP \(bu 2
05368a1 Merge branch \(aq2019.2.1\(aq into 2019.2.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53332\fP: (\fI\%s0undt3ch\fP) Non optional full test runs for 2019.2.1
@ \fI2019\-06\-10 15:51:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
fe18c40 Merge pull request \fI\%#53332\fP from s0undt3ch/hotfix/full\-test\-run\-2019.2.1
.IP \(bu 2
2372733 Merge branch \(aq2019.2.1\(aq into hotfix/full\-test\-run\-2019.2.1
.IP \(bu 2
f8bd47b Merge branch \(aq2019.2.1\(aq into hotfix/full\-test\-run\-2019.2.1
.IP \(bu 2
45c3c06 Non optional full test runs for 2019.2.1
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
928b05f only fetch pr target branch instead of all branches to save time and disk space
.IP \(bu 2
ccc6106 only keep last 10 builds of every pr on jenkins to reduce disk usage
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
b970bde Merge branch \(aq2019.2.1\(aq into cp\-52787
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53287\fP: (\fI\%twangboy\fP) Fix win system
@ \fI2019\-06\-06 23:35:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0810d7 Merge pull request \fI\%#53287\fP from twangboy/fix_win_system
.IP \(bu 2
0fc88fb Add TypeError
.IP \(bu 2
5b4160d Try NumberOfEnabledCores
.IP \(bu 2
49cbfd4 Add a note about skipping unavailable items
.IP \(bu 2
044b56b Fix get_system_info for older versions of Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52173\fP: (\fI\%amendlik\fP) file.directory fails to check directory permissions correctly (refs: \fI\%#53385\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#53385\fP: (\fI\%Akm0d\fP) Check dir_mode recursively in file.directory
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53386\fP: (\fI\%dwoz\fP) Fix missing import
@ \fI2019\-06\-06 20:45:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
cf98b83 Merge pull request \fI\%#53386\fP from dwoz/missing_import
.IP \(bu 2
a23d6d9 Fix missing import
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49559\fP: (\fI\%zyguy\fP) Salt\-cloud \- proxmox driver \- returns AttributeError: \(aqgenerator\(aq object has no attribute \(aqnext\(aq (refs: \fI\%#53240\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#53240\fP: (\fI\%FireGrace\fP) change .next() to next() py2=>py3 leftover
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#53274\fP: (\fI\%Ch3LL\fP) integration.states.test_pkg failing on amazon 1 py2 (refs: \fI\%#53323\fP)
.IP \(bu 2
\fBPR\fP \fI\%#53323\fP: (\fI\%dmurphy18\fP) Fix for issue \fI\%#53274\fP, test on Amazon Linux 1
@ \fI2019\-06\-06 17:31:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
18991f9 Merge pull request \fI\%#53323\fP from dmurphy18/fix_53274
.IP \(bu 2
6814852 Merge branch \(aq2019.2.1\(aq into fix_53274
.IP \(bu 2
bb6c97a Merge branch \(aq2019.2.1\(aq into fix_53274
.IP \(bu 2
b84833d Merge branch \(aq2019.2.1\(aq into fix_53274
.IP \(bu 2
7085f36 Fixed pylint issue on PR not showing when run pylint locally
.IP \(bu 2
1200031 Updated to use package bash\-doc if Amazon Linux 1 after review comments
.IP \(bu 2
b2a4a5e Fix for issue \fI\%#53274\fP, test on Amazon Linux 1
.IP \(bu 2
\fBPR\fP \fI\%#53356\fP: (\fI\%Akm0d\fP) Updated paramiko to version 2.2.3 for python3.7 support
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#53137\fP: (\fI\%bryceml\fP) update doc pr\(aqs to be built using python3 and sphinx 2.0.1 (refs: \fI\%#53273\fP)
.IP \(bu 2
\fBPR\fP \fI\%#53273\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Switch docs building under Py3
@ \fI2019\-06\-05 10:01:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
1cf57e9 Merge pull request \fI\%#53273\fP from s0undt3ch/hotfix/py3\-nox\-docs\-2019.2.1
.IP \(bu 2
98653c0 Allow docs to be built on Python >= 3.5, not just Python 3.6
.IP \(bu 2
c54f06f Have sphinx turn errors into warnings
.IP \(bu 2
07f4327 Switch docs building under Py3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53361\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Only make a new log record if it\(aqs a dictionary.
@ \fI2019\-06\-05 09:56:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
dfd36a2 Merge pull request \fI\%#53361\fP from s0undt3ch/hotfix/fix\-mp\-logging\-2019.2.1
.IP \(bu 2
d70d61f Fully revert 962b11687
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#53171\fP: (\fI\%twangboy\fP) integration.states.test_network.NetworkTest.test_managed (refs: \fI\%#53351\fP)
.IP \(bu 2
\fBPR\fP \fI\%#53351\fP: (\fI\%waynew\fP) Add checks for Amazon Linux to ip module
@ \fI2019\-06\-04 19:25:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
5efb670 Merge pull request \fI\%#53351\fP from waynew/53171\-fix\-network\-managed
.IP \(bu 2
e801afe Add checks for Amazon Linux to ip module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53242\fP: (\fI\%s0undt3ch\fP) [2019.2.1] newer msgpack ipc fixes
@ \fI2019\-06\-03 23:39:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#52934\fP: (\fI\%twangboy\fP) Update msgpack calls for newer msgpack (refs: \fI\%#53242\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52755\fP: (\fI\%dwoz\fP) Fix non raw msg pack msg decoding (refs: \fI\%#53242\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52488\fP: (\fI\%terminalmage\fP) Fix deprecation warning in msgpack >= 0.5.2 (2018.3) (refs: \fI\%#52755\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52487\fP: (\fI\%terminalmage\fP) Fix deprecation warning in msgpack >= 0.5.2 (develop) (refs: \fI\%#53242\fP)
.IP \(bu 2
ce5d79a Merge pull request \fI\%#53242\fP from s0undt3ch/hotfix/msgpack\-ipc\-2019.2.1
.IP \(bu 2
d27a524 Merge branch \(aq2019.2.1\(aq into hotfix/msgpack\-ipc\-2019.2.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53289\fP: (\fI\%cmcmarrow\fP) stops pylint E1120 from showing
@ \fI2019\-06\-01 04:57:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
df448c2 Merge pull request \fI\%#53289\fP from cmcmarrow/test_kubernetes_lint_failures_silenced
.IP \(bu 2
03eacac Merge branch \(aq2019.2.1\(aq into test_kubernetes_lint_failures_silenced
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53304\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Refactor Jenkins PR pipelines to download artifacts after timeout
@ \fI2019\-05\-31 17:10:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
6fac22b Merge pull request \fI\%#53304\fP from s0undt3ch/hotfix/jenkins\-pipelines\-refactor\-2019.2.1
.IP \(bu 2
6e778ef Refactor Jenkins PR pipelines to download artifacts after timeout
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53297\fP: (\fI\%s0undt3ch\fP) [2019.2.1] The TCP transport needs the exact same requirements as the ZeroMQ one
@ \fI2019\-05\-30 19:42:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
d359513 Merge pull request \fI\%#53297\fP from s0undt3ch/hotfix/tcp\-transport\-tests
.IP \(bu 2
bec7fa5 The TCP transport needs the exact same requirements as the ZeroMQ one
.IP \(bu 2
f93e7d3 stops pylint E1120 from showing
.IP \(bu 2
cbe6423 stops pylint E1120 from showing
.IP \(bu 2
c5a5d43 test_kubernetes_lint_failures_silenced
.IP \(bu 2
b838395 test_kubernetes_lint_failures_silenced
.IP \(bu 2
997d0a8 stops pylint E1120 from showing
.INDENT 2.0
.IP \(bu 2
5542fa8 Add the missing, and required, top pillar file.
.IP \(bu 2
0ae2ef0 Under Py2 we still want raw to be set to True
.IP \(bu 2
714d663 Re\-submit \fI\%#52934\fP fixed after being reverted in \fI\%#52755\fP
.IP \(bu 2
243b512 Update msgpack calls for newer msgpack
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
0f9077b Merge branch \(aq2019.2.1\(aq into cp\-52787
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53264\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Minion blackout tests \- Add the missing, and required, top pillar file
@ \fI2019\-05\-29 07:30:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
50e31ec Merge pull request \fI\%#53264\fP from s0undt3ch/2019.2.1
.IP \(bu 2
acabb70 Merge branch \(aq2019.2.1\(aq into 2019.2.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52966\fP: (\fI\%s0undt3ch\fP) Always run the full test suite on the 2019.2.1 release branch
@ \fI2019\-05\-28 15:43:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
749c626 Merge pull request \fI\%#52966\fP from s0undt3ch/hotfix/full\-test\-run
.IP \(bu 2
247c461 Always run the full test suite on the 2019.2.1 release branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53138\fP: (\fI\%frogunder\fP) vultr cloudtest fix
@ \fI2019\-05\-28 14:34:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
a7afd31 Merge pull request \fI\%#53138\fP from frogunder/fix_vultr_cloudtest
.IP \(bu 2
9f4550c vultr cloudtest fix
.INDENT 2.0
.IP \(bu 2
912b9b3 Add the missing, and required, top pillar file.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
9d21b75 Merge branch \(aq2019.2.1\(aq into cp\-52787
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53258\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Fix multiprocessing logging queue dict changing during iteration errors
@ \fI2019\-05\-27 19:26:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
d011beb Merge pull request \fI\%#53258\fP from s0undt3ch/2019.2.1
.IP \(bu 2
ad01dd2 More robust minion blackout tests
.IP \(bu 2
a0346d1 Try harder to get the minion grains
.IP \(bu 2
36717bd Try and address the test flakyness
.IP \(bu 2
ce07d8c Add more information when the assertion fails
.IP \(bu 2
b99e914 Attempt to fix mine tests
.IP \(bu 2
fca981c One more known to return None
.IP \(bu 2
951df48 One more known to return None
.IP \(bu 2
eb5fd3e Fix \fIintegration.modules.test_mine.MineTest.test_get\fP for sub_minion
.IP \(bu 2
26314f5 Fix multiprocessing logging queue dict changing during iteration errors
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53153\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Add Amazon Linux 2018.3 and 2 static requirements
@ \fI2019\-05\-27 12:02:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
b69e080 Merge pull request \fI\%#53153\fP from s0undt3ch/2019.2.1
.IP \(bu 2
166067c Use \fIcurrentBuild.resultIsBetterOrEqualTo\fP instead
.IP \(bu 2
cefdd90 Stop error messages about missing roster file on syndic master
.IP \(bu 2
6bf8f46 Don\(aqt complain when attempting to close sockets at this stage
.IP \(bu 2
e3f3cc9 Add Amazon Linux 2018.3 and 2 static requirements
.IP \(bu 2
872acc0 Switch the ubuntu\-14.04 exception with amzn\-1
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#52934\fP: (\fI\%twangboy\fP) Update msgpack calls for newer msgpack (refs: \fI\%#53235\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53235\fP: (\fI\%s0undt3ch\fP) Revert \(dqUpdate msgpack calls for newer msgpack\(dq
@ \fI2019\-05\-24 13:35:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
14aeeea Merge pull request \fI\%#53235\fP from saltstack/revert\-52934\-fix_msgpack
.IP \(bu 2
3295aea Revert \(dqUpdate msgpack calls for newer msgpack\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53131\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Update to salt\-bootstrap v2019.05.20
@ \fI2019\-05\-24 07:45:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
6923427 Merge pull request \fI\%#53131\fP from s0undt3ch/hotfix/update\-bootstrap\-2019.2.1
.IP \(bu 2
4cce4f4 Merge branch \(aq2019.2.1\(aq into hotfix/update\-bootstrap\-2019.2.1
.IP \(bu 2
6751ee1 Merge branch \(aq2019.2.1\(aq into hotfix/update\-bootstrap\-2019.2.1
.IP \(bu 2
6988e07 Update to salt\-bootstrap v2019.05.20
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52934\fP: (\fI\%twangboy\fP) Update msgpack calls for newer msgpack (refs: \fI\%#53242\fP)
@ \fI2019\-05\-23 23:18:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
a61db20 Merge pull request \fI\%#52934\fP from twangboy/fix_msgpack
.IP \(bu 2
f02a12e Merge branch \(aq2019.2.1\(aq into fix_msgpack
.IP \(bu 2
7e2cd34 Merge branch \(aq2019.2.1\(aq into fix_msgpack
.IP \(bu 2
bc9ce8e Merge branch \(aq2019.2.1\(aq into fix_msgpack
.IP \(bu 2
0abd1ec Update msgpack calls for newer msgpack
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
3366d59 update pylint exceptoin
.IP \(bu 2
6c452b3 removing unwanted commits from this branch
.IP \(bu 2
e0b0ba8 Handling in flaky when maximum number of attempts raised and the exception should be raised.  Different approaches depending on Py2 vs Py3.
.IP \(bu 2
434dcda Disabling two tests when using Python 3 and OS X
.IP \(bu 2
5784e80 Disabling integration.shell.test_minion.MinionTest.test_issue_7754 test on OS X because it hangs the test suite.
.IP \(bu 2
78aeb61 Dropping the version check for InstallationError down to anything 1.0 or greater.  Removing the test that simulates versions of pip below 1.0.
.IP \(bu 2
4ec90c2 Adding an jinja if statement to only the python parameter if the result from get_python_executable is a valid value.  Maintaining backwards compatibility to run tests without Nox.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53192\fP: (\fI\%twangboy\fP) Skip \fItest_gen_hash\fP test on Windows
@ \fI2019\-05\-23 05:33:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
8a57270 Merge pull request \fI\%#53192\fP from twangboy/skip_test_gen_hash
.IP \(bu 2
758d020 Skip test on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53157\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_win_file.WinFileTestCase.test_issue_52002_check_file_remove_symlink\fP
@ \fI2019\-05\-22 22:32:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
446e70c Merge pull request \fI\%#53157\fP from twangboy/fix_test_win_file_symlink
.IP \(bu 2
5672076 Merge branch \(aq2019.2.1\(aq into fix_test_win_file_symlink
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53141\fP: (\fI\%Ch3LL\fP) Check for all non\-word characters when calling secure_password
@ \fI2019\-05\-22 17:24:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
6fbe9aa Merge pull request \fI\%#53141\fP from Ch3LL/shadow_fed_fix
.IP \(bu 2
a3c4066 Merge branch \(aq2019.2.1\(aq into shadow_fed_fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53161\fP: (\fI\%Ch3LL\fP) Add HAS_REQUIRED_CRYPTO var for m2crypto in joyent
@ \fI2019\-05\-22 13:36:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb29512 Merge pull request \fI\%#53161\fP from Ch3LL/joyent_m2crypto
.IP \(bu 2
08d03e0 Add HAS_REQUIRED_CRYPTO var for m2crypto in joyent
.IP \(bu 2
16ef3d2 Merge branch \(aq2019.2.1\(aq into shadow_fed_fix
.IP \(bu 2
09ff867 Check for all non\-word when calling secure_password
.INDENT 2.0
.IP \(bu 2
334c93b Elevate token before creating symlink
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53073\fP: (\fI\%Ch3LL\fP) salt\-ssh: python binary exists before version check
@ \fI2019\-05\-20 22:36:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
85e9b2f Merge pull request \fI\%#53073\fP from Ch3LL/ssh_py3_log
.IP \(bu 2
383e781 Improve logging in salt\-ssh gen_thin
.IP \(bu 2
4371434 salt\-ssh: python binary exists before version check
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52957\fP: (\fI\%Ch3LL\fP) Set default_flow_style=None in yaml.dump calls
@ \fI2019\-05\-16 19:42:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd02ea6 Merge pull request \fI\%#52957\fP from Ch3LL/yaml_flow_style
.IP \(bu 2
5f6581a Merge branch \(aq2019.2.1\(aq into yaml_flow_style
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53072\fP: (\fI\%Ch3LL\fP) Backport \fI\%#52754\fP into 2019.2.1
@ \fI2019\-05\-16 19:29:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#52754\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to multiprocessing queue when using MacOS (refs: \fI\%#53072\fP)
.IP \(bu 2
f410346 Merge pull request \fI\%#53072\fP from Ch3LL/bp\-52754\-2019.2.1
.IP \(bu 2
13e5e55 The maximum for the multiprocessing queue on MacOS is 32767, so if we running on MacOS then we use that maximum.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52817\fP: (\fI\%waynew\fP) unit.modules.test_telegram.TelegramModuleTest.test_post_message (refs: \fI\%#52972\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52972\fP: (\fI\%garethgreenaway\fP) [2019.2.1] Fix to unit.modules.test_telegram
@ \fI2019\-05\-15 07:50:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
06fa91b Merge pull request \fI\%#52972\fP from garethgreenaway/52817_unit_modules_test_telegram_telegrammoduletest_test_post_message
.IP \(bu 2
cea7131 Removing global declaration.
.IP \(bu 2
5bf9a95 Fixing lint.
.IP \(bu 2
4d3c46d fixing broken unit.modules.test_telegram test.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53025\fP: (\fI\%Ch3LL\fP) Change package name for suse pkg tests
@ \fI2019\-05\-15 07:41:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
d340cbc Merge pull request \fI\%#53025\fP from Ch3LL/suse15_pkg_test
.IP \(bu 2
0a213ee Change package name for suse pkg tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#53020\fP: (\fI\%Ch3LL\fP) Change ssh tops log message to debug
@ \fI2019\-05\-14 16:56:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
c56fbb0 Merge pull request \fI\%#53020\fP from Ch3LL/ssh_tops
.IP \(bu 2
cbbc764 Merge branch \(aq2019.2.1\(aq into ssh_tops
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52973\fP: (\fI\%twangboy\fP) Fix \fIintegration.states.test_pip_state.PipStateTest.test_issue_2028_pip_installed_state\fP on Windows
@ \fI2019\-05\-13 20:56:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce099aa Merge pull request \fI\%#52973\fP from twangboy/fix_test_pip_state
.IP \(bu 2
21838a1 Merge branch \(aq2019.2.1\(aq into fix_test_pip_state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52986\fP: (\fI\%Ch3LL\fP) Revert \(dqMake sure \-\-run\-expensive runtests.py arg works\(dq
@ \fI2019\-05\-13 19:38:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
055d374 Merge pull request \fI\%#52986\fP from Ch3LL/expensive_revert
.IP \(bu 2
368c012 Revert \(dqMake sure \-\-run\-expensive runtests.py arg works\(dq
.IP \(bu 2
cce263e Merge branch \(aq2019.2.1\(aq into fix_test_pip_state
.IP \(bu 2
351d415 Return path to Python instead of None
.INDENT 2.0
.IP \(bu 2
c0538d2 Change ssh tops log message to debug
.IP \(bu 2
e317186 Merge branch \(aq2019.2.1\(aq into yaml_flow_style
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52968\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Salt >= 2018.3.x supports Py3.7
@ \fI2019\-05\-12 21:44:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
ee05da5 Merge pull request \fI\%#52968\fP from s0undt3ch/2019.2.1
.IP \(bu 2
73c3726 Salt >= 2018.3.x supports Py3.7
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50310\fP: (\fI\%xuhcc\fP) acme.cert falsely reports changes (refs: \fI\%#50400\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52796\fP: (\fI\%Ch3LL\fP) Backport \fI\%#50400\fP and \fI\%#50402\fP into 2019.2.1
@ \fI2019\-05\-10 19:30:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50402\fP: (\fI\%xuhcc\fP) Fix typo in salt.modules.acme (refs: \fI\%#52796\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50400\fP: (\fI\%xuhcc\fP) Fix incorrect change reporting in acme.cert (refs: \fI\%#50402\fP, \fI\%#52796\fP)
.IP \(bu 2
cae51c2 Merge pull request \fI\%#52796\fP from Ch3LL/bp\-50400
.IP \(bu 2
0c2e3e7 Merge branch \(aq2019.2.1\(aq into bp\-50400
.IP \(bu 2
1268e3e Merge branch \(aq2019.2.1\(aq into bp\-50400
.IP \(bu 2
09fa9e3 Fix typo
.IP \(bu 2
9be5c0c Fix incorrect change reporting in acme.cert
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
9a27fb3 Merge branch \(aq2019.2.1\(aq into yaml_flow_style
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52770\fP: (\fI\%twangboy\fP) Fix test_file_managed_should_fall_back_to_binary on Windows
@ \fI2019\-05\-09 20:35:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
20cccd8 Merge pull request \fI\%#52770\fP from twangboy/fix_test_file
.IP \(bu 2
ac27e69 Merge branch \(aq2019.2.1\(aq into fix_test_file
.IP \(bu 2
30a5093 Merge branch \(aq2019.2.1\(aq into fix_test_file
.IP \(bu 2
c08b10d Merge branch \(aq2019.2.1\(aq into fix_test_file
.IP \(bu 2
340ee23 Pass encoding to _validate_str_list
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
0d0e354 Fix yamldumper test for both py2/py3
.IP \(bu 2
20bc954 Update docs for yamldumper test
.IP \(bu 2
bf648e5 Update tests/unit/utils/test_yamldumper.py
.IP \(bu 2
70d578a Set default_flow_style=None in yaml.dump calls
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52943\fP: (\fI\%Ch3LL\fP) Fix elasticsearch state module: allow user to define empty aliases
@ \fI2019\-05\-09 15:46:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
4437764 Merge pull request \fI\%#52943\fP from Ch3LL/fix_elastisearch
.IP \(bu 2
451fb7e Merge branch \(aq2019.2.1\(aq into fix_elastisearch
.IP \(bu 2
ebff9b9 Fix elasticsearch state module: allow user to define empty aliases
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52952\fP: (\fI\%s0undt3ch\fP) [2019.2.1] More nox changes and test fixes
@ \fI2019\-05\-09 15:03:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
9b290b6 Merge pull request \fI\%#52952\fP from s0undt3ch/merge\-forward/2018.3\-to\-2019.2.1\-cherry
.IP \(bu 2
a06d7ce We need to call the decorator
.IP \(bu 2
77185af Partial revert since this is a class method
.IP \(bu 2
f5c5771 Lint fixes
.IP \(bu 2
3e43c87 Revert \(dqfix compare_versions method\(dq
.IP \(bu 2
0e139bf Fix \fIGOLDEN_IMAGES_CI_BRANCH\fP value
.IP \(bu 2
12a9408 Add Py3.7 static requirements
.IP \(bu 2
8e505fb Move tests to existing test modules
.IP \(bu 2
4681609 \fItests/unit/config/__init__.py\fP \-> \fItests/unit/config/test_config.py\fP
.IP \(bu 2
b1dc7f6 Pin to \fImoto<=1.3.7\fP because of \fI\%https://github.com/spulec/moto/pull/1952\fP
.IP \(bu 2
0ffe7ca We no longer test againt Ubuntu 14.04 which reached EOL
.IP \(bu 2
33743fc Don\(aqt traceback when trying to close a closed socket
.IP \(bu 2
da2e147 Always cleanup the changed environ
.IP \(bu 2
087c74d No globals in tests, specially dictionaries!
.IP \(bu 2
a814fc0 Fix underscore wart (and linter)
.IP \(bu 2
74b8f5f Fix deprecation warning in msgpack >= 0.5.2
.IP \(bu 2
962b116 Try to address dict changing during iteration
.IP \(bu 2
c58af57 Tweak codeclimate settings for less noise
.IP \(bu 2
5bb7869 fix linter
.IP \(bu 2
0b81841 Cherry\-pick test fix
.IP \(bu 2
99f9e1c fix compare_versions method
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52853\fP: (\fI\%s0undt3ch\fP) [2019.2.1] Bring nox into 2019.2.1
@ \fI2019\-05\-09 09:52:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
a510edf Merge pull request \fI\%#52853\fP from s0undt3ch/merge\-forward/2018.3\-to\-2019.2.1\-cherry
.IP \(bu 2
a8f7b46 Test is not destructive.
.IP \(bu 2
63663cf We no longer test againt Ubuntu 14.04 which reached EOL
.IP \(bu 2
62574ee Typo
.IP \(bu 2
e3e3761 Proper english in requirements comments
.IP \(bu 2
e9f6a12 \fIidentical_signature_wrapper\fP adds \fI__wrapped__\fP to function globals
.IP \(bu 2
10283b4 Upload coverage reports on full test runs
.IP \(bu 2
6e0b61b Less flaky mine tests
.IP \(bu 2
3709ed7 msgpack returns string_types
.IP \(bu 2
a36b15e Add regression test
.IP \(bu 2
ce782ff Fix non raw msg pack msg decoding
.IP \(bu 2
f193f0f Update Issue Template: questions removed
.IP \(bu 2
4417095 Fix underscore wart (and linter)
.IP \(bu 2
e6c2ae4 Fix deprecation warning in msgpack >= 0.5.2
.IP \(bu 2
6375944 Add ubuntu1804 to pr tests
.IP \(bu 2
8fdb04d SIGKILL is not always available use a local variable
.IP \(bu 2
4d6b8da Fix linter
.IP \(bu 2
759bccc Fix test_doc on windows by using grep yay!
.IP \(bu 2
0ce086d Fix remaining failures on ubuntu 1404 and add to PR tests
.IP \(bu 2
fdf80fd Change py3 windows timeout from 6 to 8 hours
.IP \(bu 2
b0aa287 Fix missing class wart
.IP \(bu 2
21ecb74 fix linter
.IP \(bu 2
62c0f9f Skip tests when no libcloud
.IP \(bu 2
1d92290 Fix unused import
.IP \(bu 2
72cdc91 Fix linter
.IP \(bu 2
238fd0f Fix broken pip state
.IP \(bu 2
89533ba Fix \fINOX_ENV_NAME\fP
.IP \(bu 2
7cfc9e8 Fix \fINOX_ENV_NAME\fP
.IP \(bu 2
2087c91 Fix \fINOX_ENV_NAME\fP
.IP \(bu 2
2f1aff5 Rename kitchen\-centos6\-py3 to kitchen\-centos6\-py2
.IP \(bu 2
1eea990 Fix linter
.IP \(bu 2
52ca668 Skip tests when no libcloud
.IP \(bu 2
2cf4b98 Add centos\-6\-py2 and Debian 8,9 py2 and 3 to PR tests
.IP \(bu 2
522599d Don\(aqt fail just because some random process died
.IP \(bu 2
34cef86 Ignore super not called
.IP \(bu 2
b7ace9c Fix linter
.IP \(bu 2
aceb6d3 Skip libcloud unit tests when no libcloud
.IP \(bu 2
f73420b Install mock on Python < 3.6
.IP \(bu 2
28fbde1 Add \fImoto\fP to the windows dependencies
.IP \(bu 2
8cbecc1 Pin kubernetes to <4.0
.IP \(bu 2
2acb0f3 Make sure \-\-run\-expensive runtests.py arg works
.IP \(bu 2
22cae20 Remove ref restriciton from kitche\-salt
.IP \(bu 2
67095df Add \(aqrunFull\(aq build parameter for PR tests
.IP \(bu 2
12d8d35 Stop w32time before and start after testing
.IP \(bu 2
7f1c22c Skip tests that fail on Windows
.IP \(bu 2
f4ae97f Upgrade etcd to > 0.4.2
.IP \(bu 2
381f5fe Limit and reduce the amount of log records sent over the wire
.IP \(bu 2
0c94b5d More entries to ignore
.IP \(bu 2
c3a21f5 As a script, not as a module
.IP \(bu 2
8948b69 Include \fICOVERAGE_FILE\fP as an env variable.
.IP \(bu 2
0af561e Each generated script is now prepared for code coverage
.IP \(bu 2
294d6f4 Use the system\(aqs path separator
.IP \(bu 2
e52ab87 Always combine and generate the XML coverage report
.IP \(bu 2
666ca9f Fix proxy minion startup issue on the test suite
.IP \(bu 2
7838ace \fIimpacket\fP does not support Py3
.IP \(bu 2
ba8d0fe Allow \fI\-\-install\-only\fP to gather the required information
.IP \(bu 2
eed7d68 Create nox lint virtualenvs before running them
.IP \(bu 2
e9e57cf Syndic roster not in 2017.7.9
.IP \(bu 2
111c63a4d Create the roster even when not running ssh
.IP \(bu 2
11c02a0 Fix unit.test_loader.LoaderGlobalsTest.test_states
.IP \(bu 2
8694db1 Fix windows tests
.IP \(bu 2
82e9ac5 Avoid race condition in even assertions
.IP \(bu 2
9443451 Revert part of 927219c since it is not a fix
.IP \(bu 2
5fee762 Fix timeout logic
.IP \(bu 2
517650f check timeout when queue empty
.IP \(bu 2
7c0a9af fix linter
.IP \(bu 2
961dc40 Ignore missing variable in six module
.IP \(bu 2
0f5a7f0 Fix typo
.IP \(bu 2
6c8c418 Do not limit event assert to first event
.IP \(bu 2
3042292 Wait longer for ping reaction
.IP \(bu 2
8c10f5f Fix xml block causing docs to fail
.IP \(bu 2
6e5768a Add a nox session for the Jenkins tornado jobs
.IP \(bu 2
43321e8 Add a cloud nox session for both runtests and pytest
.IP \(bu 2
b6b4e95 Lint cleanup
.IP \(bu 2
0670614 Add tests for wraps
.IP \(bu 2
1670b5d Use functools.wraps with decorators
.IP \(bu 2
5ae263c Update static requirements for 2018.3 branch
.IP \(bu 2
3482c4d Disable code coverage uploads.
.IP \(bu 2
0e5bc67 Lint fixes
.IP \(bu 2
337c737 Update CI jobs to point to 2018.3
.IP \(bu 2
72e8603 Skip test if required cypto libs are not available
.IP \(bu 2
e6bc9f8 Default to Cryptodome, fallback to PyCrypto
.IP \(bu 2
b2b0764 Be aware of the different path separators
.IP \(bu 2
7e79b18 We need to make sure the virtualenv path entry is removed when searching
.IP \(bu 2
ff6d3c6 We don\(aqt need to be root to run these tests
.IP \(bu 2
5965ab4 Disable progress bars on pip installs
.IP \(bu 2
f86a44e Use the real python executable path when running within a virtualenv
.IP \(bu 2
3d407e8 Add a helper to return the path to the real python executable
.IP \(bu 2
ea9d246 We must also provide \fIvenv_bin\fP when running within a virtualenv
.IP \(bu 2
31e91b0 Fix pip tests, in particular under windows
.IP \(bu 2
493f493 Don\(aqt fail if pkg_resources is not importable
.IP \(bu 2
a1eb400 Specify the SHA we need
.IP \(bu 2
0b01f21 Let\(aqs fully unload pip
.IP \(bu 2
0b6f848 Fix docker entries
.IP \(bu 2
870b899 Remove unused argument
.IP \(bu 2
1656cb4 Disable re\-running failed tests for now
.IP \(bu 2
6db4141 Also ignore multiprocessing coverage files
.IP \(bu 2
83dc97d Actually write the lint reports.
.IP \(bu 2
5f97270 Try to make sure some pip internal functions are always present in sys.modules after reloads
.IP \(bu 2
0090c55 Try and address the fact that some python packages are only provided by the distro
.IP \(bu 2
4a072fe These tests aren\(aqt destructive
.IP \(bu 2
5c7a956 Don\(aqt fail the build if the issue was sending a slack notification
.IP \(bu 2
361ef6e Don\(aqt try to change ownership on non existing paths
.IP \(bu 2
7b17352 More insight(context) on failure reports
.IP \(bu 2
93b6b95 Lock supervisor to 3.3.5, last kown working(passing tests) version
.IP \(bu 2
51114aa Watch out for too long shebang\(aqs
.IP \(bu 2
d97fe82 The output is important to know why it failed.
.IP \(bu 2
9fef385 Strings and integers are not comparable under Python 3
.IP \(bu 2
d308dce Be verbose in a CI context
.IP \(bu 2
8b7105e Fix failed tests re\-run logic
.IP \(bu 2
d6d8db1 Blacklist \fIenum34\fP on Py>=3.4. Update requirements.
.IP \(bu 2
1cd00c0 Update PR CI jobs for nox
.IP \(bu 2
19a83d5 Blacklist pycrypto and install pycryptodome instead
.IP \(bu 2
91376b3 Ignore the generated docs archive
.IP \(bu 2
207b83a Update compiled requirements
.IP \(bu 2
535e7a7 Add TCP transport nox sessions
.IP \(bu 2
680b3e5 Compile requirements for the TCP transport
.IP \(bu 2
49a1ebe Throw error when running either on Py<2.7 or Py>=3.7
.IP \(bu 2
10528b9 Don\(aqt repeat filed tests on missing/empty failed test files file
.IP \(bu 2
4886809 We currently only support running lint under Py2.7
.IP \(bu 2
a76981b Remove dead code
.IP \(bu 2
7b2c1ce Don\(aqt require six
.IP \(bu 2
a27ed35 Add nox env to build docs
.IP \(bu 2
e1b3f1d Lock docs python requirements
.IP \(bu 2
c8de644 Fix lint issues under tests
.IP \(bu 2
0372718 Fix lint issues on salt
.IP \(bu 2
9eab9f4 Add nox session/env/target to run lint against Salt and its test suite
.IP \(bu 2
123f771 Lock lint requirements
.IP \(bu 2
8df33ad Back to \fI+apache\-libcloud==1.0.0\fP and skip windows for now
.IP \(bu 2
43e3ae6 Bump apache\-libcloud requirement because 1.0.0 fails to install on windows
.IP \(bu 2
d5f7813 Remove requiremens for platforms which aren\(aqt tested under Py3
.IP \(bu 2
8f02ee9 Recompile requirements
.IP \(bu 2
66626f2 Remove pycryptodome from compiled requirements files
.IP \(bu 2
75693e5 Use pycryptodomex on windows and PyCrypto on the rest
.IP \(bu 2
4a9c19c Update(fix) requirements
.IP \(bu 2
33a3467 We don\(aqt test OSX nor Windows under Py3.4
.IP \(bu 2
fd44fce We want a more verbose pip\-compile output
.IP \(bu 2
c2ae2d5 We now compile requirements for each of the supported minor version
.IP \(bu 2
6ee1260 Static requirements are now placed on \fIpy<major>.<minor>\fP subdirectories
.IP \(bu 2
3504804 The required crypto library is pulled in from zeromq.txt or raet.txt
.IP \(bu 2
3ffe03c PyZMQ is pulled in from zeromq.txt
.IP \(bu 2
7c2fe16 Instead of quoting session parameters, proxy nox sessions
.IP \(bu 2
d3ae77b Add separate crypto sessions
.IP \(bu 2
0399620 Parametrize the transport
.IP \(bu 2
d33fd03 Update/Generate static requirements to new layout
.IP \(bu 2
52ac533 Add pre\-commit config to generate static requirements
.IP \(bu 2
3cfcb13 Be aware of the new static requirements layout
.IP \(bu 2
dc7e16a Don\(aqt lock the docker requirement. It\(aqs not locked on the other platforms
.IP \(bu 2
5476ba2 Kubernetes 3.0.0 does include the requirements files. pip\-compile chokes on that
.IP \(bu 2
79a8261 Previously generated requirements were py2 only
.IP \(bu 2
1e29666 IOFLO is pulled in from the raet requirements
.IP \(bu 2
4945e35 Fix pylint on 2017.7.9
.IP \(bu 2
036bf68 Rerun failed tests
.IP \(bu 2
03a9601 Ignore \fI\&.nox\fP directory
.IP \(bu 2
50cb630 We have long files
.IP \(bu 2
db2392f Update CodeClimate settings
.IP \(bu 2
899c80e Fix integration.client.test_kwarg test timeouts
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52836\fP: (\fI\%Ch3LL\fP) unit.utils.test_args.ArgsTestCase.test_argspec_report failing (refs: \fI\%#52852\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52852\fP: (\fI\%garethgreenaway\fP) [2019.2.1] Fixes to unit.utils.test_args.test_argspec_report
@ \fI2019\-05\-07 19:25:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
77355e2 Merge pull request \fI\%#52852\fP from garethgreenaway/52836_test_argspec_report_failing
.IP \(bu 2
eee5a38 Merge branch \(aq2019.2.1\(aq into 52836_test_argspec_report_failing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52845\fP: (\fI\%Ch3LL\fP) Backport \fI\%#52780\fP into 2019.2.1
@ \fI2019\-05\-07 16:27:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#52780\fP: (\fI\%sbrennan4\fP) Handle ipv6 in _netlink_tool_remote_on (refs: \fI\%#52845\fP)
.IP \(bu 2
dcc5fde Merge pull request \fI\%#52845\fP from Ch3LL/bp\-52780
.IP \(bu 2
dfff09b Merge branch \(aq2019.2.1\(aq into bp\-52780
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52851\fP: (\fI\%Ch3LL\fP)  Reload matcher loader when ext_pillar_first set
@ \fI2019\-05\-07 13:12:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e4f296 Merge pull request \fI\%#52851\fP from Ch3LL/matcher_ext_pillar
.IP \(bu 2
bdcae5d Add docs for new reload kwarg
.IP \(bu 2
fc70884 Reload matcher loader when ext_pillar_first set
.IP \(bu 2
8ac74e2 Merge branch \(aq2019.2.1\(aq into bp\-52780
.IP \(bu 2
226c7ce Merge branch \(aq2019.2.1\(aq into bp\-52780
.IP \(bu 2
c1eae84 Add test
.IP \(bu 2
69fe65b Use rsplit
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
8fdc48c Removing create_autospec and having salt.utils.args.argspec_report run against the _test_spec function directly.  Depending on the python version, create_autospec gives different results and cause the test to fail.  The test is now more accurate at testing the arguments for the function.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52842\fP: (\fI\%s0undt3ch\fP) \fIlibcrypto.OpenSSL_version_num\fP might be a callable
@ \fI2019\-05\-06 17:00:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
cc7a0d1 Merge pull request \fI\%#52842\fP from s0undt3ch/2019.2.1
.IP \(bu 2
a944017 \fIlibcrypto.OpenSSL_version_num\fP might be a callable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52839\fP: (\fI\%twangboy\fP) Add support for EC2
@ \fI2019\-05\-04 17:28:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
b625a6a Merge pull request \fI\%#52839\fP from twangboy/fix_test_grain
.IP \(bu 2
1c9b372 Add support for EC2
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51982\fP: (\fI\%arsiesys\fP) topic (minion_id) need to be encoded before being hash and sent using zeroMQ (refs: \fI\%#51983\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52767\fP: (\fI\%Ch3LL\fP) [2019.2.1] Add tests to PR  \fI\%#51983\fP
@ \fI2019\-05\-03 08:35:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51983\fP: (\fI\%arsiesys\fP) encode topic before using hashlib (refs: \fI\%#52767\fP)
.IP \(bu 2
6002939 Merge pull request \fI\%#52767\fP from Ch3LL/zmq_filter_test
.IP \(bu 2
1ee8f37 Merge branch \(aq2019.2.1\(aq into zmq_filter_test
.IP \(bu 2
d74b6ee Merge branch \(aq2019.2.1\(aq into zmq_filter_test
.IP \(bu 2
3210274 Fix linter warnings
.IP \(bu 2
e7c9d6e increase timeout when gathering results
.IP \(bu 2
784786d Add zmq_filter unit tests
.IP \(bu 2
805c5ee encode topic before using hashlib
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52827\fP: (\fI\%twangboy\fP) Add pymssql dependency for Windows builds
@ \fI2019\-05\-03 08:21:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
5996932 Merge pull request \fI\%#52827\fP from twangboy/add_pymssql
.IP \(bu 2
6f0b8e2 Add pymssql dependency for Windows builds
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52717\fP: (\fI\%Ch3LL\fP) debian9 tests segmentation fault (refs: \fI\%#52797\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52797\fP: (\fI\%garethgreenaway\fP) [2019.2.1] Only run the libcrypto init if less than OpenSSL 1.1.0
@ \fI2019\-05\-03 05:12:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
e3918c5 Merge pull request \fI\%#52797\fP from garethgreenaway/52717_debian_tests_segmentation_fault
.IP \(bu 2
7ab0961 Merge branch \(aq52717_debian_tests_segmentation_fault\(aq of github.com:garethgreenaway/salt into 52717_debian_tests_segmentation_fault
.INDENT 2.0
.IP \(bu 2
f8d816e Merge branch \(aq2019.2.1\(aq into 52717_debian_tests_segmentation_fault
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52771\fP: (\fI\%twangboy\fP) Fix \fItest_gpg\fP tests on Windows
@ \fI2019\-05\-02 13:30:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
b68544f Merge pull request \fI\%#52771\fP from twangboy/fix_test_gpg
.IP \(bu 2
c7f45c2 Pass encoding to stringutils.to_unicode
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52783\fP: (\fI\%Ch3LL\fP) Fix boto_apigateway tests for PyYAML 5.1
@ \fI2019\-05\-02 13:26:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
316d05b Merge pull request \fI\%#52783\fP from Ch3LL/fix_boto_yaml
.IP \(bu 2
cde29cb Fix boto_apigateway tests for PyYAML 5.1
.IP \(bu 2
6ffbca5 Fixing lint.
.IP \(bu 2
e24f2f8 Only run the libcrypto init if less than OpenSSL 1.1.0.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52769\fP: (\fI\%twangboy\fP) Remove domain grain from tests for Windows
@ \fI2019\-04\-30 21:14:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
3509465 Merge pull request \fI\%#52769\fP from twangboy/fix_test_core
.IP \(bu 2
0049f85 Remove domain grain from tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52768\fP: (\fI\%twangboy\fP) Remove pchanges... again...
@ \fI2019\-04\-30 20:24:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
30dc14b Merge pull request \fI\%#52768\fP from twangboy/fix_test_win_dacl
.IP \(bu 2
123b607 Remove pchanges... again...
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52753\fP: (\fI\%twangboy\fP) Skip test_gen_thin_compression_fallback_py3
@ \fI2019\-04\-30 03:36:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e46f51 Merge pull request \fI\%#52753\fP from twangboy/skip_test_gen_thin
.IP \(bu 2
811b381 Skip test_gen_thin_compression_fallback_py3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52721\fP: (\fI\%Ch3LL\fP) unit.cloud.clouds.test_ec2 test failing (refs: \fI\%#52736\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52736\fP: (\fI\%dwoz\fP) Skip password decryption test when no libraries available
@ \fI2019\-04\-29 17:07:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
6bfca94 Merge pull request \fI\%#52736\fP from dwoz/ec2test
.IP \(bu 2
04ad027 Merge branch \(aq2019.2.1\(aq into ec2test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52624\fP: (\fI\%tanlingyun2005\fP) fix TypeError: argument of type int is not iterable
@ \fI2019\-04\-29 13:15:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
9a1ed78 Merge pull request \fI\%#52624\fP from tanlingyun2005/2019.2.1
.IP \(bu 2
2c6867e add test case to tests/unit/cli/test_batch.py
.IP \(bu 2
cb7742e Merge branch \(aq2019.2.1\(aq into 2019.2.1
.IP \(bu 2
c943900 Merge branch \(aq2019.2.1\(aq into 2019.2.1
.IP \(bu 2
d4abddd fix TypeError: argument of type int is not iterable
.IP \(bu 2
ed908b3 Merge branch \(aq2019.2.1\(aq into 2019.2.1
.IP \(bu 2
463b60e Merge branch \(aq2019.2.1\(aq into 2019.2.1
.IP \(bu 2
65ee219 Merge branch \(aq2019.2.1\(aq of \fI\%https://github.com/tanlingyun2005/salt\fP into 2019.2.1
.INDENT 2.0
.IP \(bu 2
f71168d Merge branch \(aq2019.2.1\(aq into 2019.2.1
.UNINDENT
.IP \(bu 2
509c797 bug fix salt/cli/batch.py
.IP \(bu 2
211915c fix salt/cli/batch.py TypeError: argument of type int is not iterable
.IP \(bu 2
070ae84 fix TypeError: argument of type int is not iterable
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
b770f96 Skip test requiring crypto when none available
.IP \(bu 2
e52b390 Warn when password decrypton requested but not possible
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52696\fP: (\fI\%Ch3LL\fP) Backport \fI\%#50087\fP into 2019.2.1
@ \fI2019\-04\-25 20:33:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50087\fP: (\fI\%rbthomp\fP) Fix applying of attributes for returner rawfile_json (refs: \fI\%#52696\fP)
.IP \(bu 2
806307a Merge pull request \fI\%#52696\fP from Ch3LL/bp\-50087
.IP \(bu 2
66e97e7 Fix applying of attributes for returner rawfile_json
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52659\fP: (\fI\%twangboy\fP) Fix issues with the win_file tests
@ \fI2019\-04\-22 23:34:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
174f558 Merge pull request \fI\%#52659\fP from twangboy/fix_test_win_file
.IP \(bu 2
915c780 Fix issues with the win_file tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52655\fP: (\fI\%dwoz\fP) Parse chattr version and fix test case
@ \fI2019\-04\-22 01:46:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
d1a61a6 Merge pull request \fI\%#52655\fP from dwoz/cron_test_fix
.IP \(bu 2
e69fcc5 Fix typo
.IP \(bu 2
859d088 Merge remote\-tracking branch \(aqorigin/cron_test_fix\(aq into cron_test_fix
.INDENT 2.0
.IP \(bu 2
7f7bb90 Merge branch \(aq2019.2.1\(aq into cron_test_fix
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52601\fP: (\fI\%Ch3LL\fP) Cherry\-Pick \fI\%#52415\fP into 2019.2.1
@ \fI2019\-04\-21 19:33:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#52415\fP: (\fI\%Ch3LL\fP) Backport \fI\%#49832\fP into 2018.3 (refs: \fI\%#52601\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49832\fP: (\fI\%terminalmage\fP) Replace pchanges with changes to make onchanges/prereq work in test mode (refs: \fI\%#52415\fP)
.IP \(bu 2
f7d823c Merge pull request \fI\%#52601\fP from Ch3LL/cp\-52415
.IP \(bu 2
ecd6802 Merge branch \(aq2019.2.1\(aq into cp\-52415
.IP \(bu 2
538d5cf Remove pchanges from win_dacl
.IP \(bu 2
81b865f use same newfile message on linux for windows file state
.IP \(bu 2
93bdd08 Update dict correctly in file state
.IP \(bu 2
f3c7f27 remove pchanges for windows file modules
.IP \(bu 2
fb3b75d Fix tests for pchanges backport into 2018.3
.IP \(bu 2
0f296bb Update kernelpkg test to reflect pchanges removal
.IP \(bu 2
885d6ff Update file.touch unit tests to reflect addition of changes in test mode
.IP \(bu 2
4bc5fd0 Add integration tests for test mode onchanges/prereq
.IP \(bu 2
ed214c4 Make it possible to use prereq with test and saltmod state mods
.IP \(bu 2
ceb3f4d Add repack_state_returns to TestCase
.IP \(bu 2
982e693 Add exception logging in flaky decorator
.IP \(bu 2
0ba0ddf Add test mode changes to file.touch state
.IP \(bu 2
6db2beb Replace \(dqpchanges\(dq with \(dqchanges\(dq to fix onchanges/prereq requisites
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
169c2d5 Chattr version py3 fix
.IP \(bu 2
cf88c27 Fix linter issues
.IP \(bu 2
0ea007d Parse chattr version and fix test case
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52508\fP: (\fI\%Ch3LL\fP) integration.modules.test_publish test failures (refs: \fI\%#52645\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52645\fP: (\fI\%dwoz\fP) Fix salt.modules.publish and salt.states.x509 tests
@ \fI2019\-04\-20 08:17:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
af4f204 Merge pull request \fI\%#52645\fP from dwoz/test_fixes
.IP \(bu 2
9b6f9f9 Clean up cruft
.IP \(bu 2
c3971a5 Fix salt.modules.publish and salt.states.x509 tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52629\fP: (\fI\%dwoz\fP) Fix event assertion race condition
@ \fI2019\-04\-19 19:03:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#52540\fP: (\fI\%dwoz\fP) Fix race condition in event assertion (refs: \fI\%#52629\fP)
.IP \(bu 2
0a4d2d9 Merge pull request \fI\%#52629\fP from dwoz/ping_wait_2019.2.1
.IP \(bu 2
c001022 Fix linter
.IP \(bu 2
423f6f9 Fix vent assertion race condition
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52619\fP: (\fI\%dwoz\fP) Remove unused method from pytest engine
@ \fI2019\-04\-18 23:45:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
4859e6c Merge pull request \fI\%#52619\fP from dwoz/pytest_engine_2019.2.1
.IP \(bu 2
105784a Remove unused method from pytest engine
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52614\fP: (\fI\%Ch3LL\fP) [2019.2.1] Update integration.modules.test_network.NetworkTest.test_network_ping…
@ \fI2019\-04\-18 21:54:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
77943e5 Merge pull request \fI\%#52614\fP from Ch3LL/cp\-test_network\-2019.2.1
.IP \(bu 2
27c79d2 Update integration.modules.test_network.NetworkTest.test_network_ping test address
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32245\fP: (\fI\%tkwilliams\fP) git_pillar should permit automatic mapping of environment to branch a\-la gitfs  (refs: \fI\%#50768\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52615\fP: (\fI\%twangboy\fP)  Bring 51661 into 2019.2.1
@ \fI2019\-04\-18 21:53:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51661\fP: (\fI\%sathieu\fP) git_pillar: Fix all_saltenvs on base env (refs: \fI\%#52615\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51597\fP: (\fI\%sathieu\fP) git_pillar: Fix all_saltenvs on base env (refs: \fI\%#51661\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50768\fP: (\fI\%sathieu\fP) git_pillar: Add support for all_saltenvs parameter (refs: \fI\%#51597\fP, \fI\%#51661\fP)
.IP \(bu 2
c6b4986 Merge pull request \fI\%#52615\fP from twangboy/gitfs_2019.2.1
.IP \(bu 2
d952674 Merge branch \(aq2019.2.1\(aq into gitfs_2019.2.1
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52547\fP: (\fI\%cbosdo\fP) virt.purge throws a libvirt exception on Xen hypervisor (refs: \fI\%#52548\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52548\fP: (\fI\%cbosdo\fP) Virt purge fix
@ \fI2019\-04\-18 20:07:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
8ee15a9 Merge pull request \fI\%#52548\fP from cbosdo/virt\-purge\-fix
.IP \(bu 2
6ca8f4b Try/except undefineFlags() as this operation is not supported on bhyve
.INDENT 2.0
.IP \(bu 2
5a0464b Bring 51661 into 2019.2.1
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52591\fP: (\fI\%Ch3LL\fP) [2019.2.1] Update test_schema to mirror the new ValidationErrors in 3.0.0
@ \fI2019\-04\-18 16:34:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
e03aed5 Merge pull request \fI\%#52591\fP from Ch3LL/fix_jsonschema_2019.2
.IP \(bu 2
e09be842 Update test_schema to mirror the new ValidationErrors in 3.0.0
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52525\fP: (\fI\%lomeroe\fP) deserializer_opts are not passed the serializer in file.serialize (refs: \fI\%#52526\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52526\fP: (\fI\%lomeroe\fP) Fix use of deserializer_opts in file.serialize
@ \fI2019\-04\-17 14:08:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
21d6365 Merge pull request \fI\%#52526\fP from lomeroe/deserializer_opts_fix
.IP \(bu 2
ea0520c update test for serialization opts
.IP \(bu 2
84ff03a Correct attempting to use the serializer_name to pull deserializer_opts when deserializer_name is used as the key in the deserializer_options dict.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49147\fP: (\fI\%furgerf\fP) Log filled with \(dqException occurred while Subscriber handling stream: Already reading\(dq (refs: \fI\%#51963\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52570\fP: (\fI\%DmitryKuzmenko\fP) Simplify IPCClient and prevent corrupt messages (Turn 2) 2019.2
@ \fI2019\-04\-17 14:03:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#52564\fP: (\fI\%DmitryKuzmenko\fP) Simplify IPCClient and prevent corrupt messages (Turn 2) (refs: \fI\%#52570\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52445\fP: (\fI\%dwoz\fP) Simplify IPCClient and prevent corrupt messages (refs: \fI\%#52564\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51963\fP: (\fI\%DmitryKuzmenko\fP) Allow multiple instances of IPCMessageSubscriber in one process (refs: \fI\%#52564\fP)
.IP \(bu 2
e522ffe Merge pull request \fI\%#52570\fP from DSRCorporation/bugs/revert_51963_2019.2
.IP \(bu 2
fabbcac A couple of race conditions fixes and a test update.
.IP \(bu 2
9c85734 Drop singleton from IPCClient
.IP \(bu 2
7cf6d54 Revert \(dqSupport parallel work of multiple IPCMEssageSubscribers in one process\(dq
.IP \(bu 2
7f26e76 Revert \(dqUpdate doc conf with the new import \fItornado.queues\fP\(dq
.IP \(bu 2
69e9416 Revert \(dqMinor: Fix typo in docstring\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52449\fP: (\fI\%Ch3LL\fP) integration.cloud.clouds.test_gce.GCETest.test_instance_extra failure (refs: \fI\%#52551\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52551\fP: (\fI\%garethgreenaway\fP) [2019.2] Marking the two tests in test_gce as flaky
@ \fI2019\-04\-17 14:00:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
b173406 Merge pull request \fI\%#52551\fP from garethgreenaway/52449_test_gce_random_failures
.IP \(bu 2
28af717 Marking the two tests in test_gce as flaky.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51842\fP: (\fI\%mattLLVW\fP) salt.auth.django docs use wrong model name (refs: \fI\%#52553\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52553\fP: (\fI\%mattLLVW\fP) fix: \fI\%#51842\fP
@ \fI2019\-04\-17 13:59:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
8352362 Merge pull request \fI\%#52553\fP from mattLLVW/fix_django_auth_docs
.IP \(bu 2
3baeedf fix: \fI\%#51842\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52134\fP: (\fI\%sploenix\fP) Regression: Include list of pillar files under different keys in 2019.2 (refs: \fI\%#52490\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#22063\fP: (\fI\%jeanpralo\fP) Wildcard inside top.sls file for pillar (refs: \fI\%#52490\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52490\fP: (\fI\%dwoz\fP) Fix pillar include regression
@ \fI2019\-04\-17 13:54:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
9faa49c Merge pull request \fI\%#52490\fP from dwoz/issue_52134
.IP \(bu 2
876dd18 Fix merge wart
.IP \(bu 2
2ed650b Merge remote\-tracking branch \(aqsaltstack/2019.2\(aq into issue_52134
.IP \(bu 2
b0af11f Run include tests when pillar source changes
.IP \(bu 2
307cec6 Fix pillar tests
.IP \(bu 2
1a33bde import __future__.absolute_import
.IP \(bu 2
5dc5de9 Use file encoding and add docstring
.IP \(bu 2
e84cd41 Fix pillar include wart
.IP \(bu 2
c79f496 Add pillar include tests
.IP \(bu 2
7745242 Revert \(dqFix \fI\%#22063\fP: pillar wildcard support include\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52552\fP: (\fI\%twangboy\fP) Bring 52170 into 2019.2
@ \fI2019\-04\-17 13:54:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#52170\fP: (\fI\%twangboy\fP) Fix issue when task doesn\(aqt have delay_random defined (refs: \fI\%#52552\fP)
.IP \(bu 2
b0c0237 Merge pull request \fI\%#52552\fP from twangboy/fix_win_task_2019.2
.IP \(bu 2
fd19cca Remove some warts in the docs
.IP \(bu 2
deb0b10 Fix some lint
.IP \(bu 2
a279d45 Final doc fixes
.IP \(bu 2
58f0cd2 Fix docs... attempt 6
.IP \(bu 2
a66716e Fix docs... attempt 5
.IP \(bu 2
f6f3381 Fix docs... attempt 4
.IP \(bu 2
18cfc15 Fix docs... attempt 3
.IP \(bu 2
c691e0d More doc fixes
.IP \(bu 2
e01077b Fix docs issue... maybe...
.IP \(bu 2
b649495 Honor 80 character line limit
.IP \(bu 2
eba4507 Bring 52170 into 2019.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52528\fP: (\fI\%Ch3LL\fP) [2019.2] Merge forward from 2018.3 to 2019.2
@ \fI2019\-04\-17 13:53:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
cc0cd5d Merge pull request \fI\%#52528\fP from Ch3LL/merge\-2019.2
.IP \(bu 2
87cf385 increase timeout on test_state for windows
.IP \(bu 2
3442202 Increase timeout for test_kwarg tests
.IP \(bu 2
2c3ff2f Merge branch \(aq2019.2\(aq into merge\-2019.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52534\fP: (\fI\%twangboy\fP) Add TLS support up to TLS 1.2
@ \fI2019\-04\-13 22:56:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
e91240b Merge pull request \fI\%#52534\fP from twangboy/tls_support_2019.2
.IP \(bu 2
9ec54c4 Add TLS support up to TLS 1.2
.INDENT 2.0
.IP \(bu 2
474efa1 Fix pylint and state test failure
.IP \(bu 2
048a82e Merge branch \(aq2019.2\(aq into merge\-2019.2
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52536\fP: (\fI\%twangboy\fP) Bring \fI\%#52191\fP into 2019.2 branch
@ \fI2019\-04\-12 21:31:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#52191\fP: (\fI\%twangboy\fP) Fix issue where version doesn\(aqt detect when check_remote=True (refs: \fI\%#52536\fP)
.IP \(bu 2
2c42e4d Merge pull request \fI\%#52536\fP from twangboy/fix_choco_2019.2
.IP \(bu 2
b394ad5 Bring \fI\%#52191\fP into 2019.2 branch
.IP \(bu 2
795a7f6 Fix windows tests \- increase timeout
.IP \(bu 2
c70772c Fix linux state tests\- add new comment
.IP \(bu 2
2941567 Merge branch \(aq2018.3\(aq into \(aq2019.2\(aq
.IP \(bu 2
262516c Merge pull request \fI\%#52209\fP from twangboy/fix_choco_retcode
.INDENT 2.0
.IP \(bu 2
7aec2d3 Merge branch \(aq2018.3\(aq into fix_choco_retcode
.IP \(bu 2
bfdc47b Handle new enhanced retcode 2
.UNINDENT
.IP \(bu 2
dd7a4ba Merge pull request \fI\%#52046\fP from twangboy/use_reg_timezone
.INDENT 2.0
.IP \(bu 2
fc8e970 Merge branch \(aq2018.3\(aq into use_reg_timezone
.IP \(bu 2
d0987e6 Merge branch \(aq2018.3\(aq into use_reg_timezone
.IP \(bu 2
1bf0cbc Merge branch \(aq2018.3\(aq into use_reg_timezone
.IP \(bu 2
b466f8a Merge branch \(aq2018.3\(aq into use_reg_timezone
.IP \(bu 2
34bdae5 Merge branch \(aq2018.3\(aq into use_reg_timezone
.IP \(bu 2
9a8afa6 Fix tests, add null byte test
.IP \(bu 2
59b1d4f Revert back to using reg to get timezone
.UNINDENT
.IP \(bu 2
0d09608 Merge pull request \fI\%#52396\fP from dmurphy18/fix_aix_ssh
.INDENT 2.0
.IP \(bu 2
8bfa340 Correct typo
.IP \(bu 2
6d98577 Altered code to support salt\-ssh on AIX
.UNINDENT
.IP \(bu 2
576478e Merge pull request \fI\%#52473\fP from Ch3LL/bp\-49437
.INDENT 2.0
.IP \(bu 2
781385f Merge branch \(aq2018.3\(aq into bp\-49437
.IP \(bu 2
3a3114d Fix merge conflict wart
.IP \(bu 2
bbfd412 Merge branch \(aq2018.3\(aq into bp\-49437
.IP \(bu 2
48ee82d Merge branch \(aq2018.3\(aq into bp\-49437
.IP \(bu 2
f66d474 Add support to avoid calling refresh_db in opkg.del_repo
.UNINDENT
.IP \(bu 2
d830bc6 Merge pull request \fI\%#52493\fP from dwoz/ping_reaction_test
.INDENT 2.0
.IP \(bu 2
8b05e77 Merge branch \(aq2018.3\(aq into ping_reaction_test
.IP \(bu 2
7083d21 Merge branch \(aq2018.3\(aq into ping_reaction_test
.IP \(bu 2
7c963c1 Merge branch \(aq2018.3\(aq into ping_reaction_test
.IP \(bu 2
75ddeb3 fix linter
.IP \(bu 2
e3e1d2e fix reactor ping test
.UNINDENT
.IP \(bu 2
9b7a0d1 Merge pull request \fI\%#52505\fP from bloomberg/2018_zmq_uri
.INDENT 2.0
.IP \(bu 2
b682ec5 transport.zmq: fix bug introduced by b7df7e75cf2
.UNINDENT
.IP \(bu 2
452bbeb Merge pull request \fI\%#52512\fP from dwoz/supervisord_2018.3
.INDENT 2.0
.IP \(bu 2
cd5cd7d The exit code matters.
.UNINDENT
.IP \(bu 2
53228ae Merge pull request \fI\%#52475\fP from Ch3LL/bp\-49464
.INDENT 2.0
.IP \(bu 2
a891fd3 Make opkg.del_repo be compatible with pkrepo state module
.UNINDENT
.IP \(bu 2
6e79e24 Merge pull request \fI\%#52500\fP from terminalmage/invalid\-archive\-source
.INDENT 2.0
.IP \(bu 2
e9d175b Fix traceback when invalid source passed to archive.extracted
.UNINDENT
.IP \(bu 2
2df74ca Merge pull request \fI\%#52476\fP from bloomberg/win_cmd_2018
.INDENT 2.0
.IP \(bu 2
0e0c42e 2018 backport: modules.cmdmod: handle windows environ better
.UNINDENT
.IP \(bu 2
4dfb2f8 Merge pull request \fI\%#52474\fP from Ch3LL/bp\-49984
.INDENT 2.0
.IP \(bu 2
c8d547e Use prune option in Pygit2 provider when fetching
.UNINDENT
.IP \(bu 2
d699485 Merge pull request \fI\%#52393\fP from waynew/52087\-mine\-delete\-test\-enhancements
.INDENT 2.0
.IP \(bu 2
e3f5be3 Use uncommon item in mine delete test
.UNINDENT
.IP \(bu 2
89bd258 Merge pull request \fI\%#52445\fP from dwoz/ipc_fixes_2018.3
.INDENT 2.0
.IP \(bu 2
1bdaf29 Ensure exceptions in service future are handled
.IP \(bu 2
c7ad732 Use six.reraise for py3 compatibility
.IP \(bu 2
29999b0 Close message service on subscriber close
.IP \(bu 2
47203f7 Fix ipc unit tests
.IP \(bu 2
2b35437 Fix linter issues
.IP \(bu 2
503cdd2 Remove IPCClient singleton
.IP \(bu 2
b374034 Re\-raise queued exceptions with traceback
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51879\fP: (\fI\%whytewolf\fP) 2019.2.0 binary pillar unicode error returns. (refs: \fI\%#52334\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52334\fP: (\fI\%waynew\fP) 51879 fix binary pillar return error
@ \fI2019\-04\-12 03:45:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
6eb2bce Merge pull request \fI\%#52334\fP from waynew/51879\-fix\-binary\-pillar\-return\-error
.IP \(bu 2
ead856e Merge branch \(aq2019.2\(aq into 51879\-fix\-binary\-pillar\-return\-error
.IP \(bu 2
2aa971d lint cleanup
.IP \(bu 2
28c2945 keep_pillar not needed
.IP \(bu 2
fb010c0 Add binary pillar to the docs
.IP \(bu 2
f2aebf9 Assume file contents are binary
.IP \(bu 2
2b8c782 Test gpg render with replace newlines
.IP \(bu 2
c4b385b Allow binary pillar data
.IP \(bu 2
604b671 Return binary data from gpg renderer
.IP \(bu 2
32aafab Ignore vscode and fix swap ignore
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52041\fP: (\fI\%arsiesys\fP) 2019.2 influxdb_retention_policy.present broken when used extra arguments (refs: \fI\%#52043\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52043\fP: (\fI\%arsiesys\fP) fix missing client_args in influxdb module
@ \fI2019\-04\-12 03:43:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d59705 Merge pull request \fI\%#52043\fP from arsiesys/fix_influxdb_state_rp
.IP \(bu 2
e617c5b Merge branch \(aq2019.2\(aq into fix_influxdb_state_rp
.IP \(bu 2
7661860 fix missing client_args in influxdb module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52146\fP: (\fI\%twangboy\fP) Add missing symlink test
@ \fI2019\-04\-12 00:51:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
1b969c3 Merge pull request \fI\%#52146\fP from twangboy/fix_test_symlink_2019.2
.IP \(bu 2
8e1c882 Merge branch \(aq2019.2\(aq into fix_test_symlink_2019.2
.IP \(bu 2
a429542 Merge branch \(aq2019.2\(aq into fix_test_symlink_2019.2
.IP \(bu 2
401c253 Merge branch \(aq2019.2\(aq into fix_test_symlink_2019.2
.IP \(bu 2
cce6200 Fixing lint
.IP \(bu 2
c7cb009 Merge branch \(aq2019.2\(aq into fix_test_symlink_2019.2
.IP \(bu 2
3eae05a Merge branch \(aq2019.2\(aq into fix_test_symlink_2019.2
.IP \(bu 2
83bed46 Add missing symlink test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52341\fP: (\fI\%cbosdo\fP) virt.pool_running: fix pool start
@ \fI2019\-04\-12 00:14:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
7a1b8ca Merge pull request \fI\%#52341\fP from cbosdo/virt\-state\-fixes
.IP \(bu 2
89f0bd8 Merge branch \(aq2019.2\(aq into virt\-state\-fixes
.IP \(bu 2
25b9681 virt.pool_running: fix pool start
.IP \(bu 2
30981d2 Remove unneeded kwargs in virt states
.IP \(bu 2
0871c02 virt: allow defining the VM type and arch when creating it
.IP \(bu 2
1c65d25 Updating running domains in virt.running
.IP \(bu 2
13d7819 Add missing virt states unit tests
.IP \(bu 2
0681d86 virt.running support for all virt.init options
.IP \(bu 2
c6a444b Add test case for virt.running
.IP \(bu 2
2db7a98 Let virt running state provide errors
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52350\fP: (\fI\%Ch3LL\fP) Re\-Add Python 2 unicode string literals in YAML renderer  (refs: \fI\%#52427\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52427\fP: (\fI\%garethgreenaway\fP) [2019.2] Support for old yaml render
@ \fI2019\-04\-12 00:06:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
6040282 Merge pull request \fI\%#52427\fP from garethgreenaway/52350_readd_and_gate_unicode_string_literal_support
.IP \(bu 2
82f010a Merge branch \(aq2019.2\(aq into 52350_readd_and_gate_unicode_string_literal_support
.IP \(bu 2
ae81fee Merge branch \(aq2019.2\(aq into 52350_readd_and_gate_unicode_string_literal_support
.IP \(bu 2
b618d44 Merge branch \(aq2019.2\(aq into 52350_readd_and_gate_unicode_string_literal_support
.IP \(bu 2
b191bc0 Merge branch \(aq2019.2\(aq into 52350_readd_and_gate_unicode_string_literal_support
.IP \(bu 2
38a9818 Merge branch \(aq2019.2\(aq into 52350_readd_and_gate_unicode_string_literal_support
.IP \(bu 2
2767984 Removing logging entry
.IP \(bu 2
71cd303 Adding missing yamlloader_old.py
.IP \(bu 2
f848aa4 Adding support back in with, a gated configuration option, for the old YAML Loader.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51865\fP: (\fI\%magenbrot\fP) salt.match.search_by resulting in \(aqNone\(aq since 2019.2 (refs: \fI\%#52234\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52234\fP: (\fI\%garethgreenaway\fP) [2019.2] Fixes to matchers when used in pillar
@ \fI2019\-04\-12 00:05:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
05ba7c5 Merge pull request \fI\%#52234\fP from garethgreenaway/51865_match_search_by_master
.IP \(bu 2
1760245 Merge branch \(aq2019.2\(aq into 51865_match_search_by_master
.IP \(bu 2
d50f011 Merge branch \(aq2019.2\(aq into 51865_match_search_by_master
.IP \(bu 2
b0cbb60 Merge branch \(aq2019.2\(aq into 51865_match_search_by_master
.IP \(bu 2
799a08b Merge branch \(aq2019.2\(aq into 51865_match_search_by_master
.IP \(bu 2
21891d6 Merge branch \(aq2019.2\(aq into 51865_match_search_by_master
.IP \(bu 2
a2173d7 Fixing a typo where attempting to get a list from __opts__ instead of an individual item
.IP \(bu 2
6a5b5b2 swapping out if...else approach for __opts__.get approach.
.IP \(bu 2
aa2c626 With the change/addition of the matcher subsystem in 2019.2, the match.search_by when used in pillar broke when targetting the minion that was also the salt master.  This was caused by the id in __opts__ being used in all cases.  This change updates the glob_match function to use the preserved minion_id of the master if it is available so that targeting works as expected.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52160\fP: (\fI\%cbosdo\fP) Virt whitespace fix
@ \fI2019\-04\-12 00:04:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
80d7aea Merge pull request \fI\%#52160\fP from cbosdo/virt\-whitespace\-fix
.IP \(bu 2
fd1f539 Merge branch \(aq2019.2\(aq into virt\-whitespace\-fix
.IP \(bu 2
b297e7d virt: handle whitespaces in VM names
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51832\fP: (\fI\%nocturo\fP) pillar include stopped working (refs: \fI\%#52008\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52008\fP: (\fI\%waynew\fP) Allow \fI/\fP in pillar includes
@ \fI2019\-04\-12 00:02:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
b551bbd Merge pull request \fI\%#52008\fP from waynew/51832\-re\-allow\-slash\-includes
.IP \(bu 2
ee3115f Allow leading dots and / as pillar separators
.IP \(bu 2
29c676d Ensure _closing exists
.IP \(bu 2
eb517e1 Swap \(aq/\(aq for \(aq.\(aq when matching
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51821\fP: (\fI\%OrangeDog\fP) \(aqcomment\(aq is an invalid keyword argument for \(aqtest.fail_without_changes\(aq (refs: \fI\%#51937\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51937\fP: (\fI\%garethgreenaway\fP) [2019.2] Fix to test state functions to allow arguments that mod_watch uses
@ \fI2019\-04\-11 23:57:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
d3159cb Merge pull request \fI\%#51937\fP from garethgreenaway/51821_ensure_result_comment_changes_valid_arguments
.IP \(bu 2
86c63b5 Merge branch \(aq2019.2\(aq into 51821_ensure_result_comment_changes_valid_arguments
.IP \(bu 2
0966d61 Merge branch \(aq2019.2\(aq into 51821_ensure_result_comment_changes_valid_arguments
.IP \(bu 2
5527dff Ensure the comment, changes, and result are valid arguments for various test state functions as they are valid arguments for mod_watch.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51818\fP: (\fI\%syphernl\fP) salt.nacl.dec: expected str, bytearray, or unicode (refs: \fI\%#51913\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51913\fP: (\fI\%garethgreenaway\fP) [2019.2] Fixes to utils/nacl.py
@ \fI2019\-04\-11 23:56:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
7be0428 Merge pull request \fI\%#51913\fP from garethgreenaway/51818_fix_when_sk_is_empty
.IP \(bu 2
55d7488 Merge branch \(aq2019.2\(aq into 51818_fix_when_sk_is_empty
.IP \(bu 2
b2128e8 Merge branch \(aq2019.2\(aq into 51818_fix_when_sk_is_empty
.IP \(bu 2
cb01a1b Merge branch \(aq2019.2\(aq into 51818_fix_when_sk_is_empty
.IP \(bu 2
1a1e333 Merge branch \(aq51818_fix_when_sk_is_empty\(aq of github.com:garethgreenaway/salt into 51818_fix_when_sk_is_empty
.INDENT 2.0
.IP \(bu 2
102f0a3 Merge branch \(aq2019.2\(aq into 51818_fix_when_sk_is_empty
.IP \(bu 2
7fd04ec Merge branch \(aq2019.2\(aq into 51818_fix_when_sk_is_empty
.UNINDENT
.IP \(bu 2
dd23069 Adding tests for NACL changes.
.IP \(bu 2
c314f51 Correctly handle the situation when with the secret key or public key values are empty.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52116\fP: (\fI\%lordcirth\fP) host.present always returns None when in test=True (refs: \fI\%#52399\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52399\fP: (\fI\%waynew\fP) Bring host.present in line with Salt\(aqs test conventions
@ \fI2019\-04\-11 23:32:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
d6f0971 Merge pull request \fI\%#52399\fP from waynew/52116\-fix\-host\-present\-fail
.IP \(bu 2
8440ae1 Merge branch \(aq2019.2\(aq into 52116\-fix\-host\-present\-fail
.IP \(bu 2
dd002fd Fix linter
.IP \(bu 2
9d1b2a0 Only return None on host.present changes when test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52477\fP: (\fI\%mattp\-\fP) 2019.2 backport \fI\%#52472\fP modules.cmdmod: handle windows environ better
@ \fI2019\-04\-11 23:13:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#52472\fP: (\fI\%mattp\-\fP) modules.cmdmod: handle windows environ better (refs: \fI\%#52476\fP, \fI\%#52477\fP)
.IP \(bu 2
7c709cf Merge pull request \fI\%#52477\fP from bloomberg/win_cmd_2019
.IP \(bu 2
736a437 2019.2 bacpkport: modules.cmdmod: handle windows environ better
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49661\fP: (\fI\%ephreal\fP) Issues starting salt\-master or salt\-minion with openssl\-1.1.1\-1 (refs: \fI\%#51655\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52423\fP: (\fI\%bbinet\fP) Remove unused salt.crypt import
@ \fI2019\-04\-11 21:44:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51655\fP: (\fI\%garethgreenaway\fP) [2017.7] Removing unused salt.crypt imports (refs: \fI\%#52423\fP)
.IP \(bu 2
b0d3c76 Merge pull request \fI\%#52423\fP from bbinet/unused\-salt\-crypt
.IP \(bu 2
dc330e7 Merge branch \(aq2019.2\(aq into unused\-salt\-crypt
.IP \(bu 2
4b26dea Merge branch \(aq2019.2\(aq into unused\-salt\-crypt
.IP \(bu 2
9607c38 Also remove unused salt.crypt import in pillar/__init__.py
.IP \(bu 2
49f2631 Remove unused salt.crypt import
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52506\fP: (\fI\%mattp\-\fP) 2019.2: transport.zmq: fix bug introduced by b7df7e75cf2
@ \fI2019\-04\-11 21:12:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
4bb9185 Merge pull request \fI\%#52506\fP from bloomberg/2019_zmq_uri
.IP \(bu 2
1e9dd7f transport.zmq: fix bug introduced by b7df7e75cf2
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52462\fP: (\fI\%Ch3LL\fP) integration.states.test_supervisord test failing (refs: \fI\%#52513\fP, \fI\%#52512\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52513\fP: (\fI\%dwoz\fP) [2019.2] Fix supervisord
@ \fI2019\-04\-11 21:09:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
1532642 Merge pull request \fI\%#52513\fP from dwoz/supervisord_2019.2
.IP \(bu 2
dc9ace6 The exit code matters.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52496\fP: (\fI\%dwoz\fP) Fix wart in IPC merge forward
@ \fI2019\-04\-11 05:19:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#52482\fP: (\fI\%dwoz\fP) Ipc fixes 2019.2 (refs: \fI\%#52496\fP)
.IP \(bu 2
978084d Merge pull request \fI\%#52496\fP from dwoz/ipc_wart
.IP \(bu 2
9805f38 Fix wart in IPC merge forward
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52482\fP: (\fI\%dwoz\fP) Ipc fixes 2019.2 (refs: \fI\%#52496\fP)
@ \fI2019\-04\-10 19:53:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
791b646 Merge pull request \fI\%#52482\fP from dwoz/ipc_fixes_2019.2
.IP \(bu 2
f45d29b Remove un\-needed test
.IP \(bu 2
0141b7f Fix merge wart
.IP \(bu 2
82150f0 Remove un\-used import
.IP \(bu 2
c9ec8b1 Ensure exceptions in service future are handled
.IP \(bu 2
25f5a90 Use six.reraise for py3 compatibility
.IP \(bu 2
6d80789 Fix ipc unit tests
.IP \(bu 2
c80da32 Fix linter issues
.IP \(bu 2
024b4b6 Remove IPCClient singleton
.IP \(bu 2
f1d0e02 Re\-raise queued exceptions with traceback
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51932\fP: (\fI\%tomlaredo\fP) [REGRESSION] \-\-output\-diff doesn\(aqt display changes anymore with test=True since v2019.2.0 (refs: \fI\%#51992\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51992\fP: (\fI\%garethgreenaway\fP) [2019.2] Swapping pchanges for changes in file state.
@ \fI2019\-04\-09 19:38:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
3173673 Merge pull request \fI\%#51992\fP from garethgreenaway/51932_show_diff_when_test_True
.IP \(bu 2
7c4abd6 changes needs to be a dictionary.
.IP \(bu 2
ac950b3 Merge branch \(aq2019.2\(aq into 51932_show_diff_when_test_True
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52413\fP: (\fI\%Ch3LL\fP) [2019.2] Merge forward from 2018.3 to 2019.2
@ \fI2019\-04\-08 16:19:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd3ad7b Merge pull request \fI\%#52413\fP from Ch3LL/merge\-2019.2
.IP \(bu 2
30783f4 Merge branch \(aq2019.2\(aq into merge\-2019.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52151\fP: (\fI\%simonflood\fP) Fix typo in actual 2019.2.0 release notes
@ \fI2019\-04\-08 13:36:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51861\fP: (\fI\%simonflood\fP) Fix typo in 2019.2.0 release notes (refs: \fI\%#52151\fP)
.IP \(bu 2
a18abf2 Merge pull request \fI\%#52151\fP from simonflood/patch\-2
.IP \(bu 2
a4a5521 Merge branch \(aq2019.2\(aq into patch\-2
.IP \(bu 2
3d31102 Fix typo in actual 2019.2.0 release notes
.INDENT 2.0
.IP \(bu 2
16733da Merge branch \(aq2019.2\(aq into merge\-2019.2
.IP \(bu 2
fe13214 Merge branch \(aq2018.3\(aq into \(aq2019.2\(aq
.INDENT 2.0
.IP \(bu 2
b6028b9 Merge pull request \fI\%#52403\fP from bdrung/fix\-test\-conditions
.INDENT 2.0
.IP \(bu 2
e74f78f Skip ExtendTestCase if templates directory is missing
.IP \(bu 2
0473683 Skip SampleConfTest if sample conf directories are missing
.UNINDENT
.IP \(bu 2
e5a755d Merge pull request \fI\%#52250\fP from twangboy/fix_grains
.INDENT 2.0
.IP \(bu 2
a77ec81 Merge branch \(aq2018.3\(aq into fix_grains
.IP \(bu 2
b405391 Refer to the windowsdomain grain
.IP \(bu 2
e103561 Add some documentation about the domain grain on Windows
.IP \(bu 2
c874831 Don\(aqt set the domain grain to windowsdomain
.IP \(bu 2
65eb461 Add a test for windows grains
.IP \(bu 2
173d1e7 Fix the domain grain on Windows
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
0ce0c04 Merge branch \(aq2019.2\(aq into 51932_show_diff_when_test_True
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51869\fP: (\fI\%eimantaszd\fP) x509.sign_remote_certificate not working after upgrade to 2019.2.0 (refs: \fI\%#52381\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52381\fP: (\fI\%dwoz\fP) Fix issue \fI\%#51869\fP and add cert signing test
@ \fI2019\-04\-05 20:36:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
6bae227 Merge pull request \fI\%#52381\fP from dwoz/issue_51869
.IP \(bu 2
cd78485 Merge branch \(aq2019.2\(aq into issue_51869
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21927\fP: (\fI\%jfindlay\fP) network.traceroute intermittently stacktraces (refs: \fI\%#52370\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52370\fP: (\fI\%jfindlay\fP) Fix network.traceroute exec module function
@ \fI2019\-04\-03 16:39:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
c1063cf Merge pull request \fI\%#52370\fP from jfindlay/traceroute
.IP \(bu 2
2f49231 modules.network: update unit test
.IP \(bu 2
5b64fc0 modules.network: log and skip problematic traceroute lines
.IP \(bu 2
e33f5c1 modules.network: standardize util check
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52397\fP: (\fI\%garethgreenaway\fP) [2019.2] Merge forward from 2018.3 to 2019.2
@ \fI2019\-04\-02 22:12:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
3675f1e Merge pull request \fI\%#52397\fP from garethgreenaway/merge\-2019.2
.IP \(bu 2
28e76b1 Merge branch \(aq2018.3\(aq into merge\-2019.2
.IP \(bu 2
28f947e Merge pull request \fI\%#52213\fP from garethgreenaway/beacon_state_dont_save_test_true
.INDENT 2.0
.IP \(bu 2
7f83b4b Swapping out if state looking for test in opts for a __opts__.get
.IP \(bu 2
e1cf599 Merge branch \(aq2018.3\(aq into beacon_state_dont_save_test_true
.IP \(bu 2
b751122 Merge branch \(aq2018.3\(aq into beacon_state_dont_save_test_true
.IP \(bu 2
a901ec4 Don\(aqt save beacons when test=True
.UNINDENT
.IP \(bu 2
10d041b Merge pull request \fI\%#52344\fP from twangboy/os_release_embedded
.INDENT 2.0
.IP \(bu 2
74ab4d3 Use old way to get osrelease if new way fails
.UNINDENT
.IP \(bu 2
e88d3ba Merge pull request \fI\%#52345\fP from garethgreenaway/52197_incron_cannot_have_comments
.INDENT 2.0
.IP \(bu 2
070837a Merge branch \(aq2018.3\(aq into 52197_incron_cannot_have_comments
.IP \(bu 2
8461608 Updating the incron module, state module and tests to remove use of comments.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
855f31a Remove un\-used file
.IP \(bu 2
affd9b8 Fix setup/teardown methods
.IP \(bu 2
215bf93 Refresh after modifying tmp pillars
.IP \(bu 2
95c3aba Add config for listener
.IP \(bu 2
5d231f4 remove unused import
.IP \(bu 2
8c1b1db Use tmp pillar for signing policies
.IP \(bu 2
a0e2458 fix unused import
.IP \(bu 2
7f5f7dd Fix requisite path
.IP \(bu 2
5630498 Fix signing policies path
.IP \(bu 2
0bd0826 Fix issue \fI\%#51869\fP and add cert signing test
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52347\fP: (\fI\%Ch3LL\fP) [2019.2] Merge forward from 2018.3 to 2019.2
@ \fI2019\-03\-28 16:41:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
27e6cbf Merge pull request \fI\%#52347\fP from Ch3LL/merge\-2019.2
.IP \(bu 2
63962b5 Merge branch \(aq2018.3\(aq into \(aq2019.2\(aq
.IP \(bu 2
bda3ca2 Merge pull request \fI\%#51749\fP from terminal\-labs/salt\-cloud\-map\-alt\-update
.INDENT 2.0
.IP \(bu 2
9ca0f72 Changed where to mention the map files compatibility for minion configuration options. This is a result of @Ch3LL suggestion on the PR itself for this doc change.
.IP \(bu 2
364ef06 Added mention of map file alternative for minion configuration options.
.UNINDENT
.IP \(bu 2
a743fff Merge pull request \fI\%#52113\fP from twangboy/fix_lgpo
.INDENT 2.0
.IP \(bu 2
bb4a704 Merge branch \(aq2018.3\(aq into fix_lgpo
.IP \(bu 2
7186405 Merge branch \(aq2018.3\(aq into fix_lgpo
.IP \(bu 2
7656331 Change default language from 1033 to en_US
.UNINDENT
.IP \(bu 2
7040643 Merge pull request \fI\%#52172\fP from garethgreenaway/51959_fix_acl_present_output
.INDENT 2.0
.IP \(bu 2
8c53890 Merge branch \(aq2018.3\(aq into 51959_fix_acl_present_output
.IP \(bu 2
0bdde94 Merge branch \(aq2018.3\(aq into 51959_fix_acl_present_output
.IP \(bu 2
c5337e1 Merge branch \(aq2018.3\(aq into 51959_fix_acl_present_output
.IP \(bu 2
889660f Fixing lint.
.IP \(bu 2
bfdb669 Updating the reverse octal lookup dictionary.  Updating tests.
.IP \(bu 2
24c907b Adding additional permissions to the lookup.
.IP \(bu 2
4b99afa Fixing the output when there are changes for the ACL state so the permissions are shown and not the octal number.
.UNINDENT
.IP \(bu 2
45d6cad Merge pull request \fI\%#52283\fP from dmurphy18/fix_cpe_name_amzn2
.INDENT 2.0
.IP \(bu 2
cbe5f7d Update to allow for malformed CPE_NAME from some OS\(aqs
.UNINDENT
.IP \(bu 2
14a6b9d Merge pull request \fI\%#52306\fP from terminal\-labs/replace\-ping\-with\-version
.INDENT 2.0
.IP \(bu 2
c04ba6e Changed a text artifact from the ping function to supporting text for the version function.
.IP \(bu 2
0b1eb00 Replaced \fItest.ping\fP with \fItest.version\fP Result of issue \fI\%#52277\fP
.UNINDENT
.IP \(bu 2
7b2b521 Merge pull request \fI\%#51963\fP from DSRCorporation/bugs/49147_ipc_subscriber
.INDENT 2.0
.IP \(bu 2
37aeba3 Minor: Fix typo in docstring
.IP \(bu 2
cc46e9c Merge branch \(aq2018.3\(aq into bugs/49147_ipc_subscriber
.IP \(bu 2
23733bd Regression test for parallel IPCMessageSubscriber support
.IP \(bu 2
2bc2a7d Merge branch \(aq2018.3\(aq into bugs/49147_ipc_subscriber
.IP \(bu 2
684bf58 Update doc conf with the new import \fItornado.queues\fP
.IP \(bu 2
008cf49 Merge branch \(aq2018.3\(aq into bugs/49147_ipc_subscriber
.IP \(bu 2
01e9a3d Merge branch \(aq2018.3\(aq into bugs/49147_ipc_subscriber
.IP \(bu 2
710ab50 Support parallel work of multiple IPCMEssageSubscribers in one process
.UNINDENT
.IP \(bu 2
87bb513 Fix failing symlink test (\fI\%#52145\fP)
.IP \(bu 2
8255901 document \fIregex_replace\fP Jinja filter (\fI\%#52326\fP)
.IP \(bu 2
3211397 Merge pull request \fI\%#52310\fP from garethgreenaway/merge\-2018.3
.INDENT 2.0
.IP \(bu 2
9324b83 Merge branch \(aq2018.3\(aq into merge\-2018.3
.UNINDENT
.IP \(bu 2
71e9b66 Merge pull request \fI\%#52312\fP from terminal\-labs/zone\-clarification
.INDENT 2.0
.IP \(bu 2
ae0e18f Merge branch \(aq2018.3\(aq into zone\-clarification
.IP \(bu 2
e8c8dba Added in an explanation of the \-\-zone flag approved in \fI\%#52251\fP
.INDENT 2.0
.IP \(bu 2
4908ed3 Merge branch \(aq2017.7\(aq into merge\-2018.3
.IP \(bu 2
b6a0161 Merge remote\-tracking branch \(aqupstream/2017.7.9\(aq into 2017.7
.INDENT 2.0
.IP \(bu 2
1f99e28 Let\(aqs not include raet by default
.UNINDENT
.IP \(bu 2
4306779 Merge branch \(aq2017.7.9\(aq into 2017.7
.INDENT 2.0
.IP \(bu 2
36ed50d Lock to unittest\-xml\-reporting 2.2.1
.UNINDENT
.IP \(bu 2
3e6cb79 Merge branch \(aq2017.7.9\(aq into 2017.7
.INDENT 2.0
.IP \(bu 2
57348ca Add static requirements for Arch linux
.IP \(bu 2
cc6fb46 Additionally ignore files in nox virtualenvs and CI artifacts directories
.UNINDENT
.IP \(bu 2
bf9c55e Previously have setuptools\-git installed if ioflo is to be installed
.IP \(bu 2
973e1ca Merge remote\-tracking branch \(aqupstream/2017.7.9\(aq into 2017.7
.INDENT 2.0
.IP \(bu 2
981335a Revert \(dqAvoid a traceback on tornado.testing test classes\(dq
.UNINDENT
.IP \(bu 2
f48ba6a Merge remote\-tracking branch \(aqupstream/2017.7.9\(aq into 2017.7
.INDENT 2.0
.IP \(bu 2
b039cec Windows now has a static requirements file and no longer needs hacks
.IP \(bu 2
a86af2b Merge pull request \fI\%#52226\fP from dwoz/jenkins_build
.INDENT 2.0
.IP \(bu 2
8c0f46b Use windows state to bootstrap windows builds
.UNINDENT
.IP \(bu 2
7263956 Lock coverage and xml\-unittest\-reporting versions
.IP \(bu 2
dce4ffa Avoid a traceback on tornado.testing test classes
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52314\fP: (\fI\%twangboy\fP) Add the ability to pass a timeout to beacons
@ \fI2019\-03\-27 19:11:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
d3f4c9d Merge pull request \fI\%#52314\fP from twangboy/fix_beacon_tests
.IP \(bu 2
a5fa99a Add missing **kwargs
.IP \(bu 2
7e88d04 Add the ability to pass a timeout to beacons
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52311\fP: (\fI\%garethgreenaway\fP) [2019.2] Merge forward from 2018.3 to 2019.2
@ \fI2019\-03\-26 18:31:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
bad4e47 Merge pull request \fI\%#52311\fP from garethgreenaway/merge\-2019.2
.IP \(bu 2
11cd485 Merge branch \(aq2018.3\(aq into merge\-2019.2
.IP \(bu 2
582d306 Merge pull request \fI\%#52307\fP from Akm0d/doc_fix
.INDENT 2.0
.IP \(bu 2
4da0fd6 Fix x509 inconsistent file name in state example
.UNINDENT
.IP \(bu 2
2cdf48e Merge pull request \fI\%#52276\fP from terminal\-labs/replace\-github\-dead\-link
.INDENT 2.0
.IP \(bu 2
a2fbbe0 Merge branch \(aq2018.3\(aq into replace\-github\-dead\-link
.UNINDENT
.IP \(bu 2
8fa0e51 Merge pull request \fI\%#52290\fP from Akm0d/doc_fix
.INDENT 2.0
.IP \(bu 2
ca00e4b Merge branch \(aq2018.3\(aq of github.com:saltstack/salt into doc_fix
.IP \(bu 2
8e1ec15 Add missing master/minion docs for log_rotate*
.INDENT 2.0
.IP \(bu 2
08728cf Merge branch \(aq2018.3\(aq into replace\-github\-dead\-link
.UNINDENT
.UNINDENT
.IP \(bu 2
d2fd84f Merge pull request \fI\%#51724\fP from clinta/docker\-create\-with\-ip
.INDENT 2.0
.IP \(bu 2
c933663 Merge branch \(aq2018.3\(aq into docker\-create\-with\-ip
.UNINDENT
.IP \(bu 2
838a7aa Merge pull request \fI\%#51753\fP from terminal\-labs/docs\-sphinx\-ref\-deadlink\-fix
.INDENT 2.0
.IP \(bu 2
f2b6abd Merge branch \(aq2018.3\(aq into docs\-sphinx\-ref\-deadlink\-fix
.IP \(bu 2
9857f53 Merge branch \(aq2018.3\(aq into docs\-sphinx\-ref\-deadlink\-fix
.IP \(bu 2
8a11d27 Merge branch \(aq2018.3\(aq into docs\-sphinx\-ref\-deadlink\-fix
.IP \(bu 2
842ec84 Merge branch \(aq2018.3\(aq into docs\-sphinx\-ref\-deadlink\-fix
.IP \(bu 2
9275207 Merge branch \(aq2017.7\(aq into docs\-sphinx\-ref\-deadlink\-fix
.IP \(bu 2
2330c2a makefile had an old sphinx\-doc link, updated to new general front page of sphinx docs.
.IP \(bu 2
8d70e3b Replaced all bad sphinx links with ones from the new sphinx doc site.
.IP \(bu 2
ebdffcd replaced two python sphinx deadlinks with sphinx new relevant documentation pages.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
a4e3e34 Merge branch \(aq2018.3\(aq into docker\-create\-with\-ip
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
efb9ec0 Merge pull request \fI\%#52215\fP from garethgreenaway/bp\-52212
.INDENT 2.0
.IP \(bu 2
65857ef Merge branch \(aq2018.3\(aq into bp\-52212
.IP \(bu 2
a96bf24 Back\-port PR \fI\%#52212\fP to 2018.3
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
c6e553c add networking_config to container_create for custom network_mode
.IP \(bu 2
5c99dbd add test to expose ip not added to custom network \fI\%#51723\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
679c4b2 Merge pull request \fI\%#52269\fP from garethgreenaway/merge\-2018.3
.INDENT 2.0
.IP \(bu 2
ee58560 Merge branch \(aq2018.3\(aq into merge\-2018.3
.UNINDENT
.IP \(bu 2
418e543 Merge pull request \fI\%#52261\fP from dwoz/update_kitchen
.INDENT 2.0
.IP \(bu 2
a87c6ea Use windows state to bootstrap windows builds
.IP \(bu 2
1aa1bd8 Merge branch \(aq2017.7\(aq into merge\-2018.3
.IP \(bu 2
2962e94 Lock coverage and xml\-unittest\-reporting versions
.IP \(bu 2
595303b Merge remote\-tracking branch \(aqupstream/2017.7.9\(aq into 2017.7
.INDENT 2.0
.IP \(bu 2
55e150c Proper setup and teardown
.IP \(bu 2
b9b6009 Don\(aqt run distro on windows
.IP \(bu 2
3cb5c82 Merge pull request \fI\%#52208\fP from s0undt3ch/2017.7.9
.UNINDENT
.IP \(bu 2
b14dbc9 Merge branch \(aq2017.7.9\(aq into 2017.7
.INDENT 2.0
.IP \(bu 2
6a789a1 Update static requirements
.IP \(bu 2
cee9480 Lock PyYAML to < 5.1
.IP \(bu 2
a4f241d The kitchen nox verifier already takes care of the sinlge \fI\-v\fP flag.
.IP \(bu 2
0cb641e Fix static requirements search bad logic
.IP \(bu 2
45a3e4a \fIdistro\fP reports Opensuse 15 as Opensuse Leap 15
.IP \(bu 2
de7bb24 Ubuntu 18.04 locked requirements files
.IP \(bu 2
bc08e3c Ubuntu 16.04 locked requirements files
.IP \(bu 2
0d353d2 Ubuntu 14.04 locked requirements files
.IP \(bu 2
1186122 Opensuse 42 locked requirements files
.IP \(bu 2
fa6888b Opensuse 15 locked requirements files
.IP \(bu 2
b6578b8 Fedora 29 locked requirements files
.IP \(bu 2
777dbb0 Fedora 28 locked requirements files
.IP \(bu 2
4388fa9 Debian 9 locked requirements files
.IP \(bu 2
2f9030f Debian 8 locked requirements files
.IP \(bu 2
1b18ec5 CentOS 7 locked requirements files
.IP \(bu 2
6e9f0c0 CentOS 6 locked requirements
.IP \(bu 2
7415846 Start handling static(and platform specific) requirements files
.IP \(bu 2
ea4d370 Allow overriding some requirements based on distro information
.IP \(bu 2
17017a1 Merge pull request \fI\%#51361\fP from olipovch/cloud\-sync\-after\-install
.INDENT 2.0
.IP \(bu 2
8fde3a0 Merge branch \(aq2017.7\(aq into cloud\-sync\-after\-install
.IP \(bu 2
ab00151 Fix salt\-cloud sync_after_install functionality
.UNINDENT
.UNINDENT
.IP \(bu 2
ff54f53 The kitchen nox verifier already takes care of the sinlge \fI\-v\fP flag.
.IP \(bu 2
a2aa708 Fix static requirements search bad logic
.IP \(bu 2
621b047 \fIdistro\fP reports Opensuse 15 as Opensuse Leap 15
.IP \(bu 2
bc00a26 Ubuntu 18.04 locked requirements files
.IP \(bu 2
d5ed9e1 Ubuntu 16.04 locked requirements files
.IP \(bu 2
03879bf Ubuntu 14.04 locked requirements files
.IP \(bu 2
c3d7a18 Opensuse 42 locked requirements files
.IP \(bu 2
b29d986 Opensuse 15 locked requirements files
.IP \(bu 2
73154d0 Fedora 29 locked requirements files
.IP \(bu 2
bf36cd4 Fedora 28 locked requirements files
.IP \(bu 2
52cc5bb Debian 9 locked requirements files
.IP \(bu 2
cb4a823 Debian 8 locked requirements files
.IP \(bu 2
2128a79 CentOS 7 locked requirements files
.IP \(bu 2
4a29e93 CentOS 6 locked requirements
.IP \(bu 2
0d96e64 Start handling static(and platform specific) requirements files
.UNINDENT
.IP \(bu 2
0fc82bd Merge pull request \fI\%#52193\fP from Ch3LL/bp\-47005
.INDENT 2.0
.IP \(bu 2
1a54fd1 Merge branch \(aq2018.3\(aq into bp\-47005
.UNINDENT
.IP \(bu 2
0f3cd2a Merge pull request \fI\%#52194\fP from Ch3LL/bp\-52149
.INDENT 2.0
.IP \(bu 2
bff3f3c Merge branch \(aq2018.3\(aq into bp\-52149
.IP \(bu 2
7e459a1 example names parameter in file.managed state
.INDENT 2.0
.IP \(bu 2
f68caa6 Merge branch \(aq2018.3\(aq into bp\-47005
.UNINDENT
.UNINDENT
.IP \(bu 2
85be178 Merge pull request \fI\%#52201\fP from max\-arnold/rename\-beacon\-validate
.INDENT 2.0
.IP \(bu 2
e1e9a2b Merge branch \(aq2018.3\(aq into rename\-beacon\-validate
.UNINDENT
.IP \(bu 2
0383ac3 Merge pull request \fI\%#52189\fP from Ch3LL/merge\-2018.3
.INDENT 2.0
.IP \(bu 2
9972980 Merge branch \(aq2018.3\(aq into merge\-2018.3
.IP \(bu 2
79962ab Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
fd6068e Allow overriding some requirements based on distro information
.IP \(bu 2
659ec11 Merge remote\-tracking branch \(aqupstream/2017.7.9\(aq into 2017.7
.INDENT 2.0
.IP \(bu 2
18bbbec We need to nest require \fIreq_win.txt\fP
.UNINDENT
.IP \(bu 2
956a84c Merge pull request \fI\%#51995\fP from s0undt3ch/2017.7
.INDENT 2.0
.IP \(bu 2
0bf9d62 Merge remote\-tracking branch \(aqupstream/2017.7.9\(aq into 2017.7
.IP \(bu 2
baf776b Merge pull request \fI\%#51974\fP from s0undt3ch/features/nox\-2017.7
.IP \(bu 2
ee4df3a Lint fixes
.IP \(bu 2
56f841f Windows needs special treatment
.IP \(bu 2
c3cb447 Requirements fixes
.IP \(bu 2
6a67531 We need a fixed winrm\-fs so that dotfiles are also included
.IP \(bu 2
15c6a53 use kitchen\-salt from my fork for now
.UNINDENT
.IP \(bu 2
b745332 Merge pull request \fI\%#51800\fP from dwoz/typo_fix
.INDENT 2.0
.IP \(bu 2
5bbe5e0 Fix up docstring
.IP \(bu 2
9f3c583 Fix typo in docstring
.INDENT 2.0
.IP \(bu 2
75acce1 Rename obsolete beacon validation function
.IP \(bu 2
d1700f3 Merge branch \(aq2018.3\(aq into bp\-47005
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
03f228d Merge pull request \fI\%#52112\fP from Ch3LL/proxy_gs
.INDENT 2.0
.IP \(bu 2
7ad4758 Update device names in proxy getting started docs
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
25ae7c8 remove freebsd\-upstream reference
.IP \(bu 2
b70c45c Remove salt FreeBSD repo which is now 2 years out of date
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
62e5404 github issue tracker link and sends you to the url for listed issues.
.IP \(bu 2
ccf6a06 Replaced a dead link for github issue tracker with another github link for the issue tracker and added a link to show more options for closing issues in commit messages.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52190\fP: (\fI\%Ch3LL\fP) [2019.2] Merge forward from 2018.3 to 2019.2
@ \fI2019\-03\-23 01:09:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ac6dbd Merge pull request \fI\%#52190\fP from Ch3LL/merge\-2019.2
.IP \(bu 2
68c02b9 Merge branch \(aq2019.2\(aq into merge\-2019.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52240\fP: (\fI\%soer7022\fP) Fix Typos \(dqswtich\(dq to \(dqswitch\(dq
@ \fI2019\-03\-23 00:08:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
f5fc807 Merge pull request \fI\%#52240\fP from soer7022/patch\-2
.IP \(bu 2
d130832 Merge branch \(aq2019.2\(aq into patch\-2
.IP \(bu 2
3b6fdf8 Merge branch \(aq2019.2\(aq into patch\-2
.IP \(bu 2
5db7a3f Fix Typos \(dqswtich\(dq to \(dqswitch\(dq
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
34d601e Merge branch \(aq2019.2\(aq into merge\-2019.2
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#52036\fP: (\fI\%ghost\fP) rsync.synchronized: \(dqAn exception occurred in this state: \(aqChanges\(aq should be a dictionary.\(dq (refs: \fI\%#52040\fP)
.IP \(bu 2
\fBPR\fP \fI\%#52040\fP: (\fI\%garethgreenaway\fP) [2019.2] Fix to rsync state
@ \fI2019\-03\-21 19:08:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
a00245e Merge pull request \fI\%#52040\fP from garethgreenaway/52036_rsync_state_no_changes_when_error
.IP \(bu 2
09d1672 Merge branch \(aq2019.2\(aq into 52036_rsync_state_no_changes_when_error
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51962\fP: (\fI\%Ch3LL\fP) Update 2019.2.0 release notes with other tojson example
@ \fI2019\-03\-21 16:37:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
5387821 Merge pull request \fI\%#51962\fP from Ch3LL/rn_update
.IP \(bu 2
f63bae9 Merge branch \(aq2019.2\(aq into rn_update
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52262\fP: (\fI\%dwoz\fP) Use windows state to bootstrap windows builds
@ \fI2019\-03\-20 22:12:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
0fe7f28 Merge pull request \fI\%#52262\fP from dwoz/update_kitcen_2019.2
.IP \(bu 2
49d529d Use windows state to bootstrap windows builds
.IP \(bu 2
e2c3f93 Merge branch \(aq2019.2\(aq into rn_update
.IP \(bu 2
164398f Merge branch \(aq2019.2\(aq into rn_update
.IP \(bu 2
c04b2a0 Merge branch \(aq2019.2\(aq into rn_update
.IP \(bu 2
9ca6e50 Update doc/topics/releases/2019.2.0.rst
.IP \(bu 2
052f193 add additional formatting to 2019.2.0 release notes
.IP \(bu 2
a6ca59a Update 2019.2.0 release notes with other tojson example
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
84cd46c Merge branch \(aq52036_rsync_state_no_changes_when_error\(aq of github.com:garethgreenaway/salt into 52036_rsync_state_no_changes_when_error
.INDENT 2.0
.IP \(bu 2
4a126b3 Merge branch \(aq2019.2\(aq into 52036_rsync_state_no_changes_when_error
.UNINDENT
.IP \(bu 2
d5d3117 Removing debugging statements
.IP \(bu 2
0fb859d Adding a test for the rsync state
.IP \(bu 2
4c678e6 When the retcode is non\-zero, there are no changes so should include the default empty dictionary.
.IP \(bu 2
c6ba2e6 Fix lint for test_win_file
.IP \(bu 2
9ada8d9 Merge branch \(aq2018.3\(aq into \(aq2019.2\(aq
.IP \(bu 2
f8c0266 Allow overriding some requirements based on distro information
.IP \(bu 2
c58c775 Merge pull request \fI\%#52035\fP from Ch3LL/bp\-52012
.INDENT 2.0
.IP \(bu 2
37666bd Merge branch \(aq2018.3\(aq into bp\-52012
.UNINDENT
.IP \(bu 2
54ff3fe Merge pull request \fI\%#51935\fP from Ch3LL/py3_doc
.INDENT 2.0
.IP \(bu 2
b217f94 Merge branch \(aq2018.3\(aq into py3_doc
.IP \(bu 2
605bfaf Update futures dependency for python2 only
.IP \(bu 2
072cd84 Update supported python versions in installation docs
.UNINDENT
.IP \(bu 2
892cdae Merge pull request \fI\%#52038\fP from terminalmage/docs
.INDENT 2.0
.IP \(bu 2
4d82146 Minor documentation tweak for file.replace state
.UNINDENT
.IP \(bu 2
a7a9754 Merge pull request \fI\%#51896\fP from twangboy/win_disks
.INDENT 2.0
.IP \(bu 2
057d415 Merge branch \(aq2018.3\(aq into win_disks
.IP \(bu 2
0d419e3 Fix some lint
.IP \(bu 2
aa61dab Add tests
.IP \(bu 2
9f6ec53 Add all attached drives to the disks grain
.UNINDENT
.IP \(bu 2
48d298c Merge pull request \fI\%#51918\fP from twangboy/fix_compat
.INDENT 2.0
.IP \(bu 2
a791901 Fix compat, add tests
.IP \(bu 2
2837bb9 Fix _compat for py3
.UNINDENT
.IP \(bu 2
02328a6 Merge pull request \fI\%#52030\fP from Ch3LL/bp\-52004
.INDENT 2.0
.IP \(bu 2
b4e3183 Fixed comparison of \fINone\fP with constants
.UNINDENT
.IP \(bu 2
aa82fcc Merge pull request \fI\%#52029\fP from Ch3LL/bp\-52003
.INDENT 2.0
.IP \(bu 2
fcac9f3 Skip Test on Non\-Windows systems
.IP \(bu 2
f42d17d Derive from LoaderModuleMockMixin
.IP \(bu 2
5052017 Define __opts__ dict
.IP \(bu 2
b7b571e Define __opts__ dict
.IP \(bu 2
ee3ad08 Define __opts__ dict
.IP \(bu 2
64d8451 Use default file module
.IP \(bu 2
886ef19 Fix name of makedirs_ method
.IP \(bu 2
4cc5f77 Check for path to be a symlink
.UNINDENT
.IP \(bu 2
5ff1725 Merge pull request \fI\%#52028\fP from Ch3LL/bp\-50384
.INDENT 2.0
.IP \(bu 2
6493eb0 Fix issue \fI\%#50381\fP
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
f2b4ec8 Don\(aqt log debug messages during close
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
7ab1281 Merge pull request \fI\%#51936\fP from gtmanfred/2018.3
.INDENT 2.0
.IP \(bu 2
faa3471 Merge branch \(aq2018.3\(aq into 2018.3
.UNINDENT
.IP \(bu 2
2ebfa22 Merge pull request \fI\%#51967\fP from twangboy/add_compat_tests
.INDENT 2.0
.IP \(bu 2
2056578 Merge branch \(aq2018.3\(aq into add_compat_tests
.IP \(bu 2
e85f004 Merge branch \(aq2018.3\(aq into add_compat_tests
.IP \(bu 2
ea69062 Fix lint
.IP \(bu 2
eb984f5 Add unit tests for _compat.py
.UNINDENT
.IP \(bu 2
c8e2971 Merge pull request \fI\%#51980\fP from Ch3LL/merge\-2018.3
.INDENT 2.0
.IP \(bu 2
9adc19e Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
bfaa6a9 Merge pull request \fI\%#51895\fP from twangboy/win_update_2017.7
.INDENT 2.0
.IP \(bu 2
b2cb1eb Merge branch \(aq2017.7\(aq into win_update_2017.7
.UNINDENT
.IP \(bu 2
7d6280d Merge pull request \fI\%#51875\fP from dwoz/avoid_ssl_race
.INDENT 2.0
.IP \(bu 2
e99654d Merge branch \(aq2017.7\(aq into avoid_ssl_race
.UNINDENT
.IP \(bu 2
c0bb1f7 Merge pull request \fI\%#51850\fP from waynew/cherry\-pick\-ping\-fix
.INDENT 2.0
.IP \(bu 2
6da495f Fix linter
.IP \(bu 2
f78b360 fix reactor ping test
.UNINDENT
.IP \(bu 2
ad7a9ec Merge pull request \fI\%#51893\fP from twangboy/gate_zfs_2017.7
.INDENT 2.0
.IP \(bu 2
e0d58eb Gate zfs module on Windows
.IP \(bu 2
f758a10 Avoid race condition when initializing OpenSSL
.IP \(bu 2
0f125db Add __virtual__ to win_update
.UNINDENT
.IP \(bu 2
864d4be Merge pull request \fI\%#51770\fP from Ch3LL/doc_conf_2017
.INDENT 2.0
.IP \(bu 2
25d9ca2 Update release versions for the 2017.7 branch
.UNINDENT
.IP \(bu 2
3cf3099 Merge pull request \fI\%#51774\fP from terminal\-labs/py3\-server\-docs\-update
.INDENT 2.0
.IP \(bu 2
1f00c89 Added in python 3 server according to the consensus from \fI\%#51748\fP
.IP \(bu 2
bfb9d87 added the python3 command for startign the python http server.
.UNINDENT
.IP \(bu 2
b4153d3 Merge pull request \fI\%#51757\fP from twangboy/fix_case_2017.7
.INDENT 2.0
.IP \(bu 2
6b0b5d2 Fix failing py3 tests
.IP \(bu 2
feb29f3 Make recurse and directory case sensitive
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
2c4dff6 Merge pull request \fI\%#51905\fP from aplanas/fix_mount
.INDENT 2.0
.IP \(bu 2
ac688df mount: fix extra \-t parameter
.UNINDENT
.IP \(bu 2
4b2c8cc Merge pull request \fI\%#51815\fP from garethgreenaway/51673_multiple_file_sections_with_excludes
.INDENT 2.0
.IP \(bu 2
58ef51d Merge branch \(aq2018.3\(aq into 51673_multiple_file_sections_with_excludes
.IP \(bu 2
8c4485d Merge branch \(aq2018.3\(aq into 51673_multiple_file_sections_with_excludes
.IP \(bu 2
b55a894 Fixing some code that was not working correctly with Python 3.
.IP \(bu 2
63da8be Fixing a bug that caused excludes to not work as expected when multiple file options were in place, the excludes of the last file section were being used over any previous ones.  Including a test to ensure excludes work as expected when multiple file sections are in place.
.UNINDENT
.IP \(bu 2
1bf3fc8 Merge pull request \fI\%#51867\fP from Oloremo/mysql\-module\-fix\-for\-python3
.INDENT 2.0
.IP \(bu 2
dfcfebd Merge branch \(aq2018.3\(aq into mysql\-module\-fix\-for\-python3
.IP \(bu 2
b6d217c Merge branch \(aq2018.3\(aq into mysql\-module\-fix\-for\-python3
.IP \(bu 2
9745b0a Fixed typo
.IP \(bu 2
8149e9e Merge branch \(aq2018.3\(aq into mysql\-module\-fix\-for\-python3
.IP \(bu 2
58d8a2e Merge branch \(aq2018.3\(aq into mysql\-module\-fix\-for\-python3
.IP \(bu 2
f964962 Added handling of empty server_version
.IP \(bu 2
58791e9 Decode mysql_version for python3 compatibility
.UNINDENT
.IP \(bu 2
7f05abf Merge pull request \fI\%#51908\fP from garethgreenaway/51862_icinga_fixes
.INDENT 2.0
.IP \(bu 2
233dbaf Adding __salt__ to utils/icinga so cmd.run_all is available.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
1e7490c update kubernetesmod in index.rst
.IP \(bu 2
1f3be1c fix import in test
.IP \(bu 2
8572c17 rename kubernetes module to kubernetesmod
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52032\fP: (\fI\%Ch3LL\fP) Add azure state and execution modules to doc index
@ \fI2019\-03\-11 15:46:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
7d6b53c Merge pull request \fI\%#52032\fP from Ch3LL/fix_azure_docs
.IP \(bu 2
8a8a5fa Add azure module ref pages and fix doc errors
.IP \(bu 2
6a1d06a fix additional azure state module doc errors
.IP \(bu 2
65d8f27 Update doc failures in azure modules
.IP \(bu 2
92dbe2a Merge branch \(aq2019.2\(aq into fix_azure_docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52037\fP: (\fI\%Ch3LL\fP) Backport \fI\%#51201\fP into 2019.2
@ \fI2019\-03\-07 19:45:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51201\fP: (\fI\%terminalmage\fP) Lint: Fix str\-format\-in\-logging, len\-as\-condition, etc. (2) (refs: \fI\%#52037\fP)
.IP \(bu 2
96935c9 Merge pull request \fI\%#52037\fP from Ch3LL/bp\-51201
.IP \(bu 2
1fb0697 Remove develop modules not needed in 2019.2
.IP \(bu 2
e3adc2f Lint: Fix str\-format\-in\-logging, len\-as\-condition, etc. (2)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52034\fP: (\fI\%terminalmage\fP) fileclient: Fix traceback when template file cannot be cached
@ \fI2019\-03\-07 19:41:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
75398e4 Merge pull request \fI\%#52034\fP from terminalmage/fix\-get\-template
.IP \(bu 2
744dfd9 fileclient: Fix traceback when template file cannot be cached
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51984\fP: (\fI\%Ch3LL\fP) [2019.2] Merge forward from 2018.3 to 2019.2
@ \fI2019\-03\-07 17:58:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
7af4f5c Merge pull request \fI\%#51984\fP from Ch3LL/merge\-2019.2
.IP \(bu 2
54ea40a Merge branch \(aq2019.2\(aq into merge\-2019.2
.IP \(bu 2
227ddbb Fix linter
.IP \(bu 2
a168913 Merge branch \(aq2018.3\(aq into \(aq2019.2\(aq
.INDENT 2.0
.IP \(bu 2
c68744a Merge pull request \fI\%#51975\fP from s0undt3ch/features/nox\-2018.3
.INDENT 2.0
.IP \(bu 2
af4ae91 Lint fixes
.IP \(bu 2
33955c9 Windows needs special treatment
.IP \(bu 2
d4f899f Requirements fixes
.IP \(bu 2
e550c60 We need a fixed winrm\-fs so that dotfiles are also included
.IP \(bu 2
ada1ef3 use kitchen\-salt from my fork for now
.UNINDENT
.IP \(bu 2
a689177 Merge pull request \fI\%#51807\fP from Ch3LL/2018.3.5_rn
.INDENT 2.0
.IP \(bu 2
2c0b85c Add 2018.3.5 release notes
.UNINDENT
.IP \(bu 2
6aee2c4 Merge pull request \fI\%#51806\fP from twangboy/fix_beacon
.INDENT 2.0
.IP \(bu 2
2bf6179 Fix some lint
.IP \(bu 2
0f38eea Add lowercase test
.IP \(bu 2
1459985 Make sure drive letter is uppercase for re compare
.IP \(bu 2
7cdc660 Add some tests
.IP \(bu 2
48ae8c6 Fix disk.usage beacon on Windows
.UNINDENT
.IP \(bu 2
da815ba Merge pull request \fI\%#51966\fP from twangboy/use_winapi_com
.INDENT 2.0
.IP \(bu 2
a38300b Use winapi.com instead of coinitialize
.UNINDENT
.IP \(bu 2
7673c69 Merge pull request \fI\%#51920\fP from twangboy/add_zabbix
.INDENT 2.0
.IP \(bu 2
e2d496c Add zabbix to the Windows builds
.UNINDENT
.IP \(bu 2
77c2796 Merge pull request \fI\%#51802\fP from garethgreenaway/merge\-2018.3.4
.INDENT 2.0
.IP \(bu 2
2e20939 Merge branch \(aq2018.3\(aq into merge\-2018.3.4
.IP \(bu 2
769f002 Merge branch \(aq2018.3.4\(aq into merge\-2018.3.4
.INDENT 2.0
.IP \(bu 2
b53a843 Merge pull request \fI\%#51713\fP from dwoz/gemstestagain_2018.3.4
.INDENT 2.0
.IP \(bu 2
f2c6631 Merge branch \(aq2018.3.4\(aq into gemstestagain_2018.3.4
.IP \(bu 2
1c82d24 Fix ruby gems tests, again
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
496525d Merge pull request \fI\%#51930\fP from Ch3LL/release_docs
.INDENT 2.0
.IP \(bu 2
9a68136 Update release documentation
.UNINDENT
.IP \(bu 2
a027c97 Merge pull request \fI\%#51931\fP from Ch3LL/bp_51298
.INDENT 2.0
.IP \(bu 2
873cabd Roll back some changes to _compat.py
.IP \(bu 2
1fcb0ff Fix edge case when minion ID is a 16\-character string
.UNINDENT
.IP \(bu 2
1fa2072 Merge pull request \fI\%#51892\fP from twangboy/gate_zfs
.INDENT 2.0
.IP \(bu 2
fbc2c0c Gate zfs grain on Windows
.UNINDENT
.IP \(bu 2
89b0991 Merge pull request \fI\%#51836\fP from stratusjerry/backport_49039_2018.3
.INDENT 2.0
.IP \(bu 2
35fdc4c Update win_pkg.py
.UNINDENT
.IP \(bu 2
c1ab63d Merge pull request \fI\%#51771\fP from Ch3LL/doc_conf_2018
.INDENT 2.0
.IP \(bu 2
904beb3 [2018.3] change build_type and release in doc/conf.py
.IP \(bu 2
3efcea5 Update release versions for the 2018.3 branch
.UNINDENT
.IP \(bu 2
98f1b03 Merge pull request \fI\%#51775\fP from garethgreenaway/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
92ffe03 fixing lint
.IP \(bu 2
73b601d Merge branch \(aq2017.7\(aq into merge\-2017.7
.IP \(bu 2
e04f735 Merge pull request \fI\%#51502\fP from ogd\-software/51501\-states\-boto3_route53.py\-fails\-to\-validate\-ALIAS\-A\-records
.INDENT 2.0
.IP \(bu 2
e69ce9d Merge branch \(aq2017.7\(aq into 51501\-states\-boto3_route53.py\-fails\-to\-validate\-ALIAS\-A\-records
.IP \(bu 2
5093406 Implement PEP8 E711 styling fix
.IP \(bu 2
7640e90 Ensure boto3_route53 correctly validates existing ALIAS records
.IP \(bu 2
ff633b0 Ensure boto3_route53 survives attempts to validate ALIAS records
.UNINDENT
.IP \(bu 2
9c128aa Merge pull request \fI\%#51732\fP from s0undt3ch/features/nox\-2017.7
.INDENT 2.0
.IP \(bu 2
328989d Add initial nox configuration. Tell \fItox\fP\(aqers to use \fInox\fP\(aq.
.UNINDENT
.IP \(bu 2
99ce48d Merge pull request \fI\%#51712\fP from dwoz/gemstestagain
.INDENT 2.0
.IP \(bu 2
0d3b227 Fix ruby gems tests, again
.UNINDENT
.IP \(bu 2
18452c4 Merge pull request \fI\%#51528\fP from twangboy/backport_51471
.INDENT 2.0
.IP \(bu 2
8c79f02 Merge branch \(aq2017.7\(aq into backport_51471
.IP \(bu 2
20a7ee5 Backport 51471
.UNINDENT
.IP \(bu 2
ee80ce3 Merge pull request \fI\%#51655\fP from garethgreenaway/49661_starting_salt_master_openssl
.INDENT 2.0
.IP \(bu 2
f647b95 Merge branch \(aq2017.7\(aq into 49661_starting_salt_master_openssl
.IP \(bu 2
1831e64 Removing options from libcrypto.OPENSSL_init_crypto so it will simply use the defaults.
.IP \(bu 2
8d0f801 removing salt.crypt from payload.py which is not used and causing salt\-key to break.
.IP \(bu 2
a5a54c4 Removing unused import which is causing salt\-master to not start when using openssl 1.1.1\-1.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
c9c082c Fix azurearm field list doc error
.IP \(bu 2
af0537f Add azure state and execution modules to doc index
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#52004\fP: (\fI\%chdamianos\fP) Fixed comparison of \fINone\fP with constants (refs: \fI\%#52030\fP)
@ \fI2019\-03\-06 17:41:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
01bcff0 Merge pull request \fI\%#52004\fP from chdamianos/fix\-constants\-comparison
.IP \(bu 2
6fd60af Fixed comparison of \fINone\fP with constants
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51981\fP: (\fI\%bryceml\fP) Fix typo in 2019.2.0 release notes
@ \fI2019\-03\-05 23:59:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
8d6bb5d Merge pull request \fI\%#51981\fP from bryceml/2019.2
.IP \(bu 2
ecf0ef0 Fix typo in 2019.2.0 release notes
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
a65e621 Adding an additional note warning that the file will not be changed because test=True, but could be changed by other states.
.IP \(bu 2
6c0dcf2 Swapping pchanges for changes in file state.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51825\fP: (\fI\%OrangeDog\fP) schedule.disable doesn\(aqt work in 2019.2.0 (refs: \fI\%#51855\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51855\fP: (\fI\%garethgreenaway\fP) [2019.2] Global enable/disable was being ignored
@ \fI2019\-03\-05 19:40:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3105df Merge pull request \fI\%#51855\fP from garethgreenaway/51825_scheduled_global_enabled
.IP \(bu 2
301e773 Merge branch \(aq51825_scheduled_global_enabled\(aq of github.com:garethgreenaway/salt into 51825_scheduled_global_enabled
.INDENT 2.0
.IP \(bu 2
ae7ab06 Merge branch \(aq2019.2\(aq into 51825_scheduled_global_enabled
.IP \(bu 2
ff13833 Merge branch \(aq2019.2\(aq into 51825_scheduled_global_enabled
.UNINDENT
.IP \(bu 2
9e7e4ed Fixing broken add_job test.
.IP \(bu 2
72466a5 Global enable/disable was being ignored
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51745\fP: (\fI\%fayak\fP) Systemd update 241 on archlinux breaks systemd.py version() function (refs: \fI\%#51946\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51946\fP: (\fI\%Ethyling\fP) Fix retrieve systemd version using regex
@ \fI2019\-03\-05 19:20:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
be28623 Merge pull request \fI\%#51946\fP from Ethyling/fix\-systemd\-version
.IP \(bu 2
b557707 Add test for systemd version from git describe
.IP \(bu 2
94809d0 Fix retrieve systemd version using regex
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51816\fP: (\fI\%jkrauz\fP) pillar_ldap broken in 2019.2.0 (refs: \fI\%#51964\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51964\fP: (\fI\%dwoz\fP) [2019.2] Make sure ldap attrs are string types on python 2
@ \fI2019\-03\-05 19:18:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
c310022 Merge pull request \fI\%#51964\fP from dwoz/issue_51816
.IP \(bu 2
a879140 Merge branch \(aq2019.2\(aq into issue_51816
.IP \(bu 2
0e61cf3 Fix linter errors/warnings
.IP \(bu 2
171217a Revert debug logging
.IP \(bu 2
8c641c6 make LDAP attr defaults string types on py2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51976\fP: (\fI\%s0undt3ch\fP) [2019.2] Nox fixes
@ \fI2019\-03\-05 18:56:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
cb817f1 Merge pull request \fI\%#51976\fP from s0undt3ch/features/nox\-2019.2
.IP \(bu 2
0b4e68c Lint fixes
.IP \(bu 2
257b3fc Windows needs special treatment
.IP \(bu 2
b298da0 Requirements fixes
.IP \(bu 2
4f45a7e We need a fixed winrm\-fs so that dotfiles are also included
.IP \(bu 2
fa70af2 use kitchen\-salt from my fork for now
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51761\fP: (\fI\%sdodsley\fP) Add new module to release notes for 2019.2.0
@ \fI2019\-03\-05 09:44:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51681\fP: (\fI\%sdodsley\fP) Add new module to release notes for 2019.2.0 (refs: \fI\%#51761\fP)
.IP \(bu 2
f867e6e Merge pull request \fI\%#51761\fP from sdodsley/cheery_pick_fb_releasenotes
.IP \(bu 2
80192c8 Add new module to release notes for 2019.2.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51799\fP: (\fI\%s0undt3ch\fP) Catch attribute error
@ \fI2019\-03\-05 09:38:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
08e3956 Merge pull request \fI\%#51799\fP from s0undt3ch/2019.2
.IP \(bu 2
342244a Merge branch \(aq2019.2\(aq into 2019.2
.IP \(bu 2
3e8a17e Catch attribute error
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51810\fP: (\fI\%Ch3LL\fP) Add 2019.2.1 release notes
@ \fI2019\-03\-05 09:26:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
ff5d7d6 Merge pull request \fI\%#51810\fP from Ch3LL/2019.2.1_rn
.IP \(bu 2
aaee5fa Add 2019.2.1 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51824\fP: (\fI\%OrangeDog\fP) schedule.present state not idempotent in 2019.2.0 (refs: \fI\%#51849\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51849\fP: (\fI\%garethgreenaway\fP) [2019.2] Fix to schedule.list function to filter out attributes that are None
@ \fI2019\-03\-01 19:56:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51647\fP: (\fI\%dwoz\fP) [develop] increase batch test timeout on windows (refs: \fI\%#51849\fP)
.IP \(bu 2
3732004 Merge pull request \fI\%#51849\fP from garethgreenaway/51824_splay_breaking_schedule_present
.IP \(bu 2
a0af441 Merge branch \(aq2019.2\(aq into 51824_splay_breaking_schedule_present
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51878\fP: (\fI\%Ch3LL\fP)  Add new terraform salt\-ssh roster feature to release notes
@ \fI2019\-02\-27 19:18:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
3fdb564 Merge pull request \fI\%#51878\fP from Ch3LL/terraform_rn
.IP \(bu 2
502d197 fix spelling error in release notes
.IP \(bu 2
4d53b41 Add new terraform salt\-ssh roster feature to release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51837\fP: (\fI\%stratusjerry\fP) Update win_pkg.py
@ \fI2019\-02\-26 16:51:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49039\fP: (\fI\%stratusjerry\fP) Update win_pkg.py (refs: \fI\%#51836\fP, \fI\%#51837\fP)
.IP \(bu 2
e63c872 Merge pull request \fI\%#51837\fP from stratusjerry/backport_49039_2019.2
.IP \(bu 2
531b23d Update win_pkg.py
.IP \(bu 2
39b5645 Splay defaulting to None internally, broke schedule.present causing it to always report differences when a state is run.  Updating the schedule.list function to check if an attribute is None and remove it.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51772\fP: (\fI\%Ch3LL\fP) Update release versions for the 2019.2 branch
@ \fI2019\-02\-25 14:16:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
27dd9fb Merge pull request \fI\%#51772\fP from Ch3LL/doc_conf_2019
.IP \(bu 2
f28cc9b [2019.2] change build_type and release in doc/conf.py
.IP \(bu 2
4c670e2 Update release versions for the 2019.2 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51776\fP: (\fI\%garethgreenaway\fP) [2019.2] Merge forward from 2018.3 to 2019.2
@ \fI2019\-02\-24 22:08:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
45425a4 Merge pull request \fI\%#51776\fP from garethgreenaway/merge\-2018.3
.IP \(bu 2
186306a reverting change in release notes, adding change to doc/ref/modules/all/index.rst.
.IP \(bu 2
1ef140a Fixing lint.
.IP \(bu 2
6173578 Fixing lint errors
.IP \(bu 2
38dcab9 fixing lint
.IP \(bu 2
e37fc20 Merge branch \(aq2018.3\(aq into merge\-2018.3
.IP \(bu 2
7e3e71c Merge pull request \fI\%#51756\fP from twangboy/fix_case_sensitive
.INDENT 2.0
.IP \(bu 2
4c55040 Fix failing py3 tests
.IP \(bu 2
64f45f8 Make recurse and directory case sensitive
.UNINDENT
.IP \(bu 2
e75fc1c Merge pull request \fI\%#51747\fP from ymasson/fix_mysql_grants
.INDENT 2.0
.IP \(bu 2
f614dd7 Fix escaping for special characters
.UNINDENT
.IP \(bu 2
b1f7e85 Merge pull request \fI\%#51387\fP from chrillux/make\-binarydata\-output\-possible
.INDENT 2.0
.IP \(bu 2
010393e Make binary data output possible
.UNINDENT
.IP \(bu 2
3475813 Merge pull request \fI\%#51694\fP from assafShapira/2018.3
.INDENT 2.0
.IP \(bu 2
895b97a Merge branch \(aq2018.3\(aq into 2018.3
.IP \(bu 2
bc2d27a fix minion bootstrapping issue \(dq/usr/lib/python2.7/site\-packages/salt/utils/cloud.py\(dq, line 472 Configuration value u\(aqprovider\(aq needs to be set
.UNINDENT
.IP \(bu 2
c7136cb Merge pull request \fI\%#51738\fP from garethgreenaway/nftables_cleanup
.INDENT 2.0
.IP \(bu 2
8201d1e Fixing lint.
.IP \(bu 2
d681064 Merge branch \(aq2018.3\(aq into nftables_cleanup
.IP \(bu 2
e37458e Fixing a couple tests.
.IP \(bu 2
ed1b743 Additional cleanup.  Adding additional documentation for state module.
.IP \(bu 2
dc4afbb More updates to nftables module, state modules, and unit tests.
.IP \(bu 2
3ec96e3 initial work to cleanup the nftables module, state module, and the unit tests.
.UNINDENT
.IP \(bu 2
2121049 Merge pull request \fI\%#51733\fP from s0undt3ch/features/nox\-2018.3
.INDENT 2.0
.IP \(bu 2
97532c2 Add initial nox configuration. Tell \fItox\fP\(aqers to use \fInox\fP\(aq.
.UNINDENT
.IP \(bu 2
f4adf33 Merge pull request \fI\%#51728\fP from gtmanfred/virtualnames
.INDENT 2.0
.IP \(bu 2
61b4390 fix modulenames from virtualnames tests
.UNINDENT
.IP \(bu 2
d681fb9 Merge pull request \fI\%#51721\fP from dwoz/solarisipstests
.INDENT 2.0
.IP \(bu 2
3263d31 Merge remote\-tracking branch \(aqsaltstack/2018.3\(aq into solarisipstests
.UNINDENT
.IP \(bu 2
fb0a538 Merge pull request \fI\%#51676\fP from Ch3LL/merge\-2018.3.4
.INDENT 2.0
.IP \(bu 2
8111479 Merge branch \(aq2018.3\(aq into merge\-2018.3.4
.UNINDENT
.IP \(bu 2
e08f08d Merge pull request \fI\%#50812\fP from gtmanfred/virtualnames
.INDENT 2.0
.IP \(bu 2
d59952f Merge branch \(aq2018.3\(aq into virtualnames
.IP \(bu 2
33bb5bf fix use of virtualname
.INDENT 2.0
.IP \(bu 2
2ca1253 Merge branch \(aqmerge\-2018.3.4\(aq of github.com:Ch3LL/salt into merge\-2018.3.4
.INDENT 2.0
.IP \(bu 2
6d6910a Merge branch \(aq2018.3\(aq into merge\-2018.3.4
.UNINDENT
.IP \(bu 2
b5a6265 Fix ruby gems tests, again
.IP \(bu 2
05f2797 Merge branch \(aq2018.3\(aq into merge\-2018.3.4
.IP \(bu 2
9f0999f Merge branch \(aq2018.3\(aq into merge\-2018.3.4
.IP \(bu 2
139daa8 Merge branch \(aq2018.3.4\(aq into 2018.3
.INDENT 2.0
.IP \(bu 2
9741289 Merge pull request \fI\%#51646\fP from dwoz/batch_exit_2018.3.4
.INDENT 2.0
.IP \(bu 2
a8f25bb increase batch test timeout on windows
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
9caafec Skip solarisips when not on solaris
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
31c6785 Merge pull request \fI\%#51714\fP from dwoz/gemstestagain_2018.3
.INDENT 2.0
.IP \(bu 2
fab74bb Fix ruby gems tests, again
.UNINDENT
.IP \(bu 2
39aadfb Merge pull request \fI\%#51689\fP from gtmanfred/2018.3
.INDENT 2.0
.IP \(bu 2
8c35d51 fix import
.IP \(bu 2
6a55cfdf specify minimum version of shade module
.UNINDENT
.IP \(bu 2
a475b70 Merge pull request \fI\%#51469\fP from s0undt3ch/hotfix/fix\-suse\-locale\-docker
.INDENT 2.0
.IP \(bu 2
14f49b5 Don\(aqt prevent \fIget_locale\fP from working when running under docker
.UNINDENT
.IP \(bu 2
a59585d Merge pull request \fI\%#51671\fP from Ch3LL/merge\-2018.3
.INDENT 2.0
.IP \(bu 2
64322db Fix is_windows utils call
.IP \(bu 2
a5c8df0 Fix pylint
.IP \(bu 2
547889b Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
bcc13db Merge pull request \fI\%#51562\fP from gilbrechbuhler/fix_rabbitmq_policy_change_check
.INDENT 2.0
.IP \(bu 2
ed2b1e1 Fix RabbitMQ policy definition update check
.UNINDENT
.IP \(bu 2
cafaa98 Merge pull request \fI\%#51648\fP from dwoz/increase_wait
.INDENT 2.0
.IP \(bu 2
e2377a9 Merge branch \(aq2017.7\(aq into increase_wait
.UNINDENT
.IP \(bu 2
e3d28d9 Merge pull request \fI\%#51643\fP from dwoz/batch_exit
.INDENT 2.0
.IP \(bu 2
42d1d02 increase batch test timeout on windows
.IP \(bu 2
7c2d7a4 Increase minion wait for slow boxes
.UNINDENT
.IP \(bu 2
b5ae53a Merge pull request \fI\%#51631\fP from Ch3LL/lint\-2017
.INDENT 2.0
.IP \(bu 2
c0aa4dc Fix linter by ignoring async await check.
.IP \(bu 2
396622c Merge branch \(aq2017.7\(aq into lint\-2017
.UNINDENT
.IP \(bu 2
ba8d0ea Merge pull request \fI\%#51547\fP from s0undt3ch/2017.7
.INDENT 2.0
.IP \(bu 2
8e009e0 Allow NOT to install pip dependencies
.UNINDENT
.IP \(bu 2
30ce509 Merge pull request \fI\%#51182\fP from lmf\-mx/darwin\-plist\-update
.INDENT 2.0
.IP \(bu 2
4297c0d Merge branch \(aq2017.7\(aq into darwin\-plist\-update
.UNINDENT
.IP \(bu 2
68ac07f Merge pull request \fI\%#51442\fP from dwoz/multi_master
.INDENT 2.0
.IP \(bu 2
40cb4db Merge branch \(aq2017.7\(aq into multi_master
.IP \(bu 2
2dc5171 Handle multi_master failover when daemonized
.UNINDENT
.IP \(bu 2
8df083c Merge pull request \fI\%#51608\fP from dwoz/wait_minions_2017.7
.INDENT 2.0
.IP \(bu 2
c55359f fix linter
.IP \(bu 2
4702e22 Wait for minions to be pingable before starting tests
.INDENT 2.0
.IP \(bu 2
5afa0a1 Merge branch \(aq2017.7\(aq into darwin\-plist\-update
.IP \(bu 2
f46e8be Fix service name in minion plist
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
1da9cd9 Fix pylint on 2017.7
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
39122ca Merge pull request \fI\%#51589\fP from dwoz/script_fix_2017.7
.INDENT 2.0
.IP \(bu 2
8697ce7 Disable pylint checks, only for 2017.7
.IP \(bu 2
e5972f5 Use the code directory instead of cwd for python path
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
b8764fd Merge pull request \fI\%#51680\fP from Ch3LL/bp\-50336
.INDENT 2.0
.IP \(bu 2
3502dbb states.gpg: fix missing existing keys; modules.gpg: fix set trust level command
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51734\fP: (\fI\%s0undt3ch\fP) [2019.2] Add initial nox configuration. Tell \fItox\fP\(aqers to use \fInox\fP\(aq.
@ \fI2019\-02\-21 17:39:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
1894082 Merge pull request \fI\%#51734\fP from s0undt3ch/features/nox\-2019.2
.IP \(bu 2
01b74c0 Add initial nox configuration. Tell \fItox\fP\(aqers to use \fInox\fP\(aq.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51707\fP: (\fI\%isbm\fP) Bugfix: pillar refresh
@ \fI2019\-02\-21 15:12:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
74db589 Merge pull request \fI\%#51707\fP from isbm/isbm\-pillar\-refresh\-fix
.IP \(bu 2
269ae76 Refresh matchers and beacons on pillar refresh
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51674\fP: (\fI\%Ch3LL\fP) [2019.2] Merge forward from 2018.3 to 2019.2
@ \fI2019\-02\-20 17:35:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
82cbd98 Merge pull request \fI\%#51674\fP from Ch3LL/merge\-2019.2
.IP \(bu 2
4171271 Fix pylint, remove unused import
.IP \(bu 2
3f14619 Remove skipif and change expected return for solarisips test
.IP \(bu 2
d3660d5 Merge branch \(aq2019.2\(aq into merge\-2019.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51715\fP: (\fI\%dwoz\fP) [2019.2] Fix ruby gems tests, again
@ \fI2019\-02\-19 21:44:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
7a82c65 Merge pull request \fI\%#51715\fP from dwoz/gemstestagain_2019.2
.IP \(bu 2
95ce288 Fix ruby gems tests, again
.IP \(bu 2
043efa0 Skip solarisips when not on solaris
.IP \(bu 2
7ed0d7d Fix ruby gems tests, again
.IP \(bu 2
b46eac3 Merge branch \(aq2019.2\(aq into merge\-2019.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51561\fP: (\fI\%isbm\fP) SaltSSH: fix delay when creating thin TAR
@ \fI2019\-02\-19 10:15:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
0bd2d6e Merge pull request \fI\%#51561\fP from isbm/isbm\-saltssh\-thintar\-delay\-fix
.IP \(bu 2
2b02975 Give up on sync for Py3 because of the way tests for py2 are written here
.IP \(bu 2
f79c81a Update UT mocking, adjusting for temporary file
.IP \(bu 2
2f90054 Use temporary filename instead of output directly to the \(dqthin.tgz\(dq
.IP \(bu 2
d841164 Copy over the result, cleanup afterwards
.IP \(bu 2
c6792ee Add a function that reserves temporary filename for further tarball generation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51678\fP: (\fI\%Ch3LL\fP) [2019.2] Merge forward from 2019.2.0.rc1 to 2019.2
@ \fI2019\-02\-17 19:02:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
5f9764a Merge pull request \fI\%#51678\fP from Ch3LL/merge\-2019.2.0.rc
.IP \(bu 2
f8372ca Merge branch \(aq2019.2\(aq into merge\-2019.2.0.rc
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51503\fP: (\fI\%garethhowell\fP) smartos.image_present fails with \(dqdoes not exist\(dq (refs: \fI\%#51383\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#51351\fP: (\fI\%garethhowell\fP) Exception using smartos.vm_present to create docker zone (refs: \fI\%#51383\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51679\fP: (\fI\%Ch3LL\fP) Backport \fI\%#51383\fP into 2019.2
@ \fI2019\-02\-16 00:31:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51383\fP: (\fI\%sjorge\fP) imgadm module should deal with invalid images better (refs: \fI\%#51679\fP)
.IP \(bu 2
2036c8a Merge pull request \fI\%#51679\fP from Ch3LL/bp\-51383
.IP \(bu 2
e4971fc imgadm module should deal with invalid images better
.IP \(bu 2
58f2407 Merge branch \(aq2019.2.0.rc1\(aq into 2019.2
.INDENT 2.0
.IP \(bu 2
6292f86 Revert \(dqRemove custom grains module from 2018.3 branch\(dq
.IP \(bu 2
92bd6b9 Fix salt.utils.is_windows call
.IP \(bu 2
ffa2f5f Merge branch \(aq2018.3\(aq into \(aq2019.2\(aq
.IP \(bu 2
a8898f6 Merge pull request \fI\%#51635\fP from lomeroe/lgpo_boolean_element_fix
.INDENT 2.0
.IP \(bu 2
b97c2b2 Merge branch \(aq2018.3\(aq into lgpo_boolean_element_fix
.IP \(bu 2
5a98fb9 Merge branch \(aq2018.3\(aq into lgpo_boolean_element_fix
.UNINDENT
.IP \(bu 2
abd3760 Merge pull request \fI\%#51610\fP from garethgreenaway/51266_schedule_enable_disable_break_save
.INDENT 2.0
.IP \(bu 2
fbacb35 Merge branch \(aq2018.3\(aq into 51266_schedule_enable_disable_break_save
.UNINDENT
.IP \(bu 2
6765eea Merge pull request \fI\%#51649\fP from dwoz/increase_wait_2018.3
.INDENT 2.0
.IP \(bu 2
9c964ef Merge branch \(aq2018.3\(aq into increase_wait_2018.3
.UNINDENT
.IP \(bu 2
852a6be Merge pull request \fI\%#51644\fP from dwoz/batch_exit_2018.3
.INDENT 2.0
.IP \(bu 2
1087d10 increase batch test timeout on windows
.IP \(bu 2
918030e Increase minion wait for slow boxes
.IP \(bu 2
3d52b26 Merge branch \(aq2018.3\(aq into 51266_schedule_enable_disable_break_save
.UNINDENT
.IP \(bu 2
dadf414 Merge pull request \fI\%#51637\fP from twangboy/backport_50887_2018.3
.INDENT 2.0
.IP \(bu 2
d8d2b86 backport \fI\%#50887\fP
.UNINDENT
.IP \(bu 2
a55e8f6 Merge pull request \fI\%#51626\fP from twangboy/fix_lgpo_2018.3
.INDENT 2.0
.IP \(bu 2
b2c9c3b Use makedirs instead of mkdir
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
2be2f42 Merge branch \(aq2018.3\(aq into 51266_schedule_enable_disable_break_save
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
0f1a411 Merge pull request \fI\%#51187\fP from menglong81/fix\-broken\-thing
.INDENT 2.0
.IP \(bu 2
298ad5c Merge branch \(aq2018.3\(aq into fix\-broken\-thing
.IP \(bu 2
d879d18 fix broken network.py
.IP \(bu 2
76770f3 ss command replace to netstat command
.IP \(bu 2
241707e ss command replace to netstat command
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
deeefc7 Merge branch \(aq2018.3\(aq into 51266_schedule_enable_disable_break_save
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
7ed5189 Merge pull request \fI\%#51613\fP from twangboy/fix_51566
.INDENT 2.0
.IP \(bu 2
1206a94 Merge branch \(aq2018.3\(aq into fix_51566
.UNINDENT
.IP \(bu 2
8b06d06 Merge pull request \fI\%#51630\fP from twangboy/add_tests_51534
.INDENT 2.0
.IP \(bu 2
ddc017c Merge branch \(aq2018.3\(aq into add_tests_51534
.UNINDENT
.IP \(bu 2
c4bbe1a Merge pull request \fI\%#51177\fP from nullify005/51069\-ri\-and\-rdoc\-removed
.INDENT 2.0
.IP \(bu 2
6b1a201 Merge branch \(aq2018.3\(aq into 51069\-ri\-and\-rdoc\-removed
.IP \(bu 2
f339608 Merge branch \(aq2018.3\(aq into 51069\-ri\-and\-rdoc\-removed
.IP \(bu 2
e586370 Merge branch \(aq2018.3\(aq into 51069\-ri\-and\-rdoc\-removed
.IP \(bu 2
13d3288 Fix lint issues
.IP \(bu 2
5de5e64 Update tests
.IP \(bu 2
22eda16 Fix lint violations
.IP \(bu 2
2e6252c Support rubygems 3 cli param changes
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
9e3a01b Use existing file instead of tzutil
.IP \(bu 2
30c1832 Use tempfile to get temp dir
.IP \(bu 2
e3d3c5a Add tests for issue 51309
.IP \(bu 2
1168141 Add test for explicit lists
.IP \(bu 2
84f5d63 Merge branch \(aq2018.3\(aq into fix_51566
.IP \(bu 2
7376cb9 Handle explicit lists properly
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
28fc070 Merge branch \(aq2018.3\(aq into 51266_schedule_enable_disable_break_save
.IP \(bu 2
0760133 adding integration.scheduler.test_helpers to various files to by pass the test_module_name_source_match check.
.IP \(bu 2
1552fba lint cleanup
.IP \(bu 2
086066b Adding a test to ensure _get_schedule which is used by the save functionality works when there is an enabled attribute.
.IP \(bu 2
1c6d4fb When looping through the schedule to remove hidden attributes, we should only do that if the item in question is a dictionary.  It could be the attribute that determines if the entire scheudle is enabled or disable.
.IP \(bu 2
5ed8eb6 Properly create the value for a \(dqTrue\(dq boolean element item
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
f1e29c8 Merge pull request \fI\%#51548\fP from s0undt3ch/2018.3
.INDENT 2.0
.IP \(bu 2
611065e Merge branch \(aq2018.3\(aq into 2018.3
.UNINDENT
.IP \(bu 2
00a6246 Merge pull request \fI\%#51622\fP from brejoc/2018.3\-empty\-job\-workaround
.INDENT 2.0
.IP \(bu 2
d263410 Prevents crash when there is no job entry
.IP \(bu 2
5342305 Allow NOT to install pip dependencies
.UNINDENT
.IP \(bu 2
fdb13a3 Merge pull request \fI\%#51523\fP from lomeroe/solarisips_fixes
.INDENT 2.0
.IP \(bu 2
e8e91e3 Merge branch \(aq2018.3\(aq into solarisips_fixes
.IP \(bu 2
b7bfe17 lint fixes
.IP \(bu 2
cdaccf4 add tests to validate command being sent to cmd.run_all
.IP \(bu 2
eaa229d add unit test
.IP \(bu 2
432428d Don\(aqt assume that each item in \(dqpkgs\(dq is a dict (as packed by pkg.installed state).
.UNINDENT
.IP \(bu 2
e3d5fbe Merge pull request \fI\%#51577\fP from garethgreenaway/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
e060b97 Merge branch \(aq2018.3\(aq into merge\-2017.7
.IP \(bu 2
3eee038 Fixing a couple issues that did not merge properly.
.IP \(bu 2
25b2ca6 Merge branch \(aq2018.3\(aq into merge\-2017.7
.IP \(bu 2
c337fce Merge branch \(aq2018.3\(aq into merge\-2017.7
.IP \(bu 2
f9d6828 Fixing missed merge.
.IP \(bu 2
a041775 Merge branch \(aq2017.7\(aq into merge\-2017.7
.INDENT 2.0
.IP \(bu 2
61889ba Merge pull request \fI\%#51452\fP from terminalmage/bp\-50963
.INDENT 2.0
.IP \(bu 2
54d2e02 Merge branch \(aq2017.7\(aq into bp\-50963
.UNINDENT
.IP \(bu 2
0c989f0 Merge pull request \fI\%#51437\fP from twangboy/fix_raise_2017.7
.INDENT 2.0
.IP \(bu 2
ecd1637 Merge branch \(aq2017.7\(aq into fix_raise_2017.7
.IP \(bu 2
f3c9cd4 Add missing raise statement
.INDENT 2.0
.IP \(bu 2
d06526c Allow for kwargs to be used in object initialization
.IP \(bu 2
0e760b5 pip states: Use case\-insensitive dictionaries for pip.list return
.IP \(bu 2
5ca9f82 Add a CaseInsensitiveDict implementation
.IP \(bu 2
2aaa9f9 pip.installed: Fix traceback when _find_key doesn\(aqt return a match
.UNINDENT
.UNINDENT
.IP \(bu 2
67b7d28 Merge pull request \fI\%#51370\fP from dwoz/setup_py_req_fix
.INDENT 2.0
.IP \(bu 2
e1e06a0 Fix python 3 path for shell test cases
.IP \(bu 2
09cd5fc Merge branch \(aq2017.7\(aq into setup_py_req_fix
.IP \(bu 2
0de189d Handle pipenv like version restrictions
.UNINDENT
.IP \(bu 2
e9b3d94 Merge pull request \fI\%#51367\fP from dwoz/cloud_config_2017
.INDENT 2.0
.IP \(bu 2
3f4c5a3e Merge branch \(aqcloud_config_2017\(aq of github.com:dwoz/salt into cloud_config_2017
.INDENT 2.0
.IP \(bu 2
8b8d41a Merge branch \(aq2017.7\(aq into cloud_config_2017
.UNINDENT
.IP \(bu 2
7bb4ceb Fix python 3 path for shell test cases
.IP \(bu 2
a2bbf4d Fix linter issues
.IP \(bu 2
004d9b8 Cloud provider and profile configs are merged
.UNINDENT
.IP \(bu 2
3a21afa Coverage on windows chokes with the tox env var \fICOVERAGE_PROCESS_START\fP
.IP \(bu 2
1c62e27 Switch required PyTest dependency
.IP \(bu 2
b80320d Merge pull request \fI\%#51402\fP from dwoz/win_test_fix
.INDENT 2.0
.IP \(bu 2
21359e6 Merge branch \(aq2017.7\(aq into win_test_fix
.UNINDENT
.IP \(bu 2
1199530 Merge pull request \fI\%#51397\fP from dwoz/gemstest
.INDENT 2.0
.IP \(bu 2
43ac36e Use gems.github.com no longer exists, use gemcutter.org
.IP \(bu 2
bac652f Add testing path to run_script commands
.UNINDENT
.IP \(bu 2
f511ad2 Merge pull request \fI\%#51227\fP from astronouth7303/doc\-modules\-additional\-globals
.INDENT 2.0
.IP \(bu 2
cbe1e17 Merge branch \(aq2017.7\(aq into doc\-modules\-additional\-globals
.UNINDENT
.IP \(bu 2
2a9bf17 Merge pull request \fI\%#51312\fP from s0undt3ch/features/tox\-runtests
.INDENT 2.0
.IP \(bu 2
3840af8 \(dqTell\(dq coverage to track subprocesses.
.IP \(bu 2
f67a529 Remove unused imports
.IP \(bu 2
15ab061 Show objects on assertion failure
.IP \(bu 2
0281fc5 Don\(aqt fail the test because of order
.IP \(bu 2
9a31be7 Don\(aqt call \fI\&.keys()\fP on dictionaries
.IP \(bu 2
97ced3a Add \fIpytest\-salt\-from\-filenames\fP to pytest requirements
.IP \(bu 2
8d2c4d2 Remove duplicate dependency
.IP \(bu 2
5eec144 Add \fI\&.coveragerc\fP
.IP \(bu 2
aa108d5 Run tests from tox, whether runtests or pytest
.IP \(bu 2
80a3826 Update TODO
.IP \(bu 2
1945c30 Document the client\-defined dunders
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
5bb9b32 Merge pull request \fI\%#51393\fP from garethgreenaway/various_documentation_fixes
.INDENT 2.0
.IP \(bu 2
8bb7535 Merge branch \(aq2018.3\(aq into various_documentation_fixes
.IP \(bu 2
c15406a Merge branch \(aq2018.3\(aq into various_documentation_fixes
.IP \(bu 2
33bb4e4 Merge branch \(aq2018.3\(aq into various_documentation_fixes
.IP \(bu 2
3582f6e Fixing the underline.
.IP \(bu 2
a8f42a0 Various documentation fixes.
.UNINDENT
.IP \(bu 2
884981f Merge pull request \fI\%#51465\fP from ezh/50556
.INDENT 2.0
.IP \(bu 2
a3ee70c fix \fI\%#50556\fP state.orchestrate_show_sls
.UNINDENT
.IP \(bu 2
231d6e2 Merge pull request \fI\%#51541\fP from bdrung/silence\-linux_distribution\-deprecation\-warning
.INDENT 2.0
.IP \(bu 2
c4feea1 Merge branch \(aq2018.3\(aq into silence\-linux_distribution\-deprecation\-warning
.IP \(bu 2
e1dcbb5 Silence linux_distribution deprecation warning
.UNINDENT
.IP \(bu 2
f87d5ec Merge pull request \fI\%#51558\fP from bdrung/test\-zypp\-plugin
.INDENT 2.0
.IP \(bu 2
c34967d Merge branch \(aq2018.3\(aq into test\-zypp\-plugin
.UNINDENT
.IP \(bu 2
edb1093 Merge pull request \fI\%#51609\fP from dwoz/wait_minions_2018.3
.INDENT 2.0
.IP \(bu 2
d794edb fix linter
.IP \(bu 2
d6720d2 Wait for minions to be pingable before starting tests
.UNINDENT
.IP \(bu 2
8d79359 Merge pull request \fI\%#51599\fP from terminalmage/bp\-51510
.INDENT 2.0
.IP \(bu 2
ed194c7 grains: assign os_family Debian to Debian derivative TurnKey Linux
.UNINDENT
.IP \(bu 2
24aa083 Merge pull request \fI\%#51598\fP from terminalmage/add\-grain\-option\-documentation
.INDENT 2.0
.IP \(bu 2
4ee9440 Improve ec2 pillar documentation
.IP \(bu 2
9c02104 Add link to metadata grain module docs
.IP \(bu 2
997ce26 Add documentation for the metadata_server_grains config option
.UNINDENT
.IP \(bu 2
d89c489 Merge pull request \fI\%#51491\fP from terminalmage/issue51268
.INDENT 2.0
.IP \(bu 2
550e9ab Don\(aqt log shell warning if output_loglevel is quiet
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
7678c28 Do not load zyppnotify file on module import
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
c6dfded Merge pull request \fI\%#51588\fP from dwoz/script_fix_2018.3
.INDENT 2.0
.IP \(bu 2
cbac390 Use the code directory instead of cwd for python path
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51658\fP: (\fI\%dwoz\fP) [2019.2] Let memcopy make the null bytes, better py3 support
@ \fI2019\-02\-15 05:42:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51586\fP: (\fI\%garethgreenaway\fP) [2019.2] Merge forward from 2018.3 to 2019.2 (refs: \fI\%#51658\fP)
.IP \(bu 2
1ea6f4b Merge pull request \fI\%#51658\fP from dwoz/pip_test_fix
.IP \(bu 2
c811a70 Let memcopy make the null bytes, better py3 support
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51650\fP: (\fI\%dwoz\fP) [2019.2]  Increase minion wait for slow boxes
@ \fI2019\-02\-14 16:31:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
22a04c1 Merge pull request \fI\%#51650\fP from dwoz/increase_wait_2019.2
.IP \(bu 2
ad294f3 Merge branch \(aq2019.2\(aq into increase_wait_2019.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51645\fP: (\fI\%dwoz\fP) [2019.2] increase batch test timeout on windows
@ \fI2019\-02\-14 16:29:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
a0982f7 Merge pull request \fI\%#51645\fP from dwoz/batch_exit_2019.2
.IP \(bu 2
1a882d7 Merge branch \(aq2019.2\(aq into batch_exit_2019.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51586\fP: (\fI\%garethgreenaway\fP) [2019.2] Merge forward from 2018.3 to 2019.2 (refs: \fI\%#51658\fP)
@ \fI2019\-02\-14 16:25:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
705a62d Merge pull request \fI\%#51586\fP from garethgreenaway/merge\-2018.3
.IP \(bu 2
09fb3e7 Merge branch \(aq2019.2\(aq into merge\-2018.3
.IP \(bu 2
95c505a Merge branch \(aq2019.2\(aq into merge\-2018.3
.IP \(bu 2
4abd9d0 Merge branch \(aq2019.2\(aq into merge\-2018.3
.IP \(bu 2
6c99cb1 Merge branch \(aq2018.3\(aq into merge\-2018.3
.INDENT 2.0
.IP \(bu 2
41e25a6 Merge pull request \fI\%#51580\fP from garethgreenaway/merge\-2018.3.4
.INDENT 2.0
.IP \(bu 2
84e15ce Fixing lint
.IP \(bu 2
e891b3f Merge branch \(aq2018.3.4\(aq into merge\-2018.3.4
.IP \(bu 2
d0cad3e Merge pull request \fI\%#51553\fP from twangboy/update_libsodium
.INDENT 2.0
.IP \(bu 2
4177f64 Update url to libsodium for mac builds
.UNINDENT
.IP \(bu 2
564a65a Merge pull request \fI\%#51544\fP from twangboy/fix_test_ssh_2018.3.4
.INDENT 2.0
.IP \(bu 2
7771632 Fix ssh on Windows
.UNINDENT
.IP \(bu 2
b4299a3 Merge pull request \fI\%#51532\fP from frogunder/new_releasenotes
.INDENT 2.0
.IP \(bu 2
09faf0b Merge branch \(aq2018.3.4\(aq into new_releasenotes
.IP \(bu 2
c6bfe53 2018.3.4 releasenotes
.UNINDENT
.IP \(bu 2
c37bdb7 Merge pull request \fI\%#51534\fP from twangboy/fix_51309
.INDENT 2.0
.IP \(bu 2
3ad95bc Convert data to string using salt util
.UNINDENT
.IP \(bu 2
5b41af3 Merge pull request \fI\%#51530\fP from garethgreenaway/48204_mysql_module_handle_mariadb_versions
.INDENT 2.0
.IP \(bu 2
cdf5298 Later versions of MariaDB still support \(dqALL PRIVILEGES\(dq
.IP \(bu 2
d31c902 Updating the mysql module to handle MariDB versions.
.UNINDENT
.IP \(bu 2
f3f345c Merge pull request \fI\%#51529\fP from frogunder/releasenotes
.INDENT 2.0
.IP \(bu 2
fb678ee fix escaped asterisks
.IP \(bu 2
6a4f0da 2018.3.4 releasenotes
.UNINDENT
.IP \(bu 2
a37fb7d Merge pull request \fI\%#51525\fP from twangboy/backport_51095_2018.3.4
.INDENT 2.0
.IP \(bu 2
b6acc92 Backport 51095
.UNINDENT
.IP \(bu 2
602ddc8 Merge pull request \fI\%#51520\fP from frogunder/man_pages
.INDENT 2.0
.IP \(bu 2
0cbe3f8 Update man pages for 2018.3.4
.UNINDENT
.IP \(bu 2
1f981c6 Merge pull request \fI\%#51429\fP from yosnoop/replace\-noclass\-with\-nocl\-for\-dig
.INDENT 2.0
.IP \(bu 2
5231e73 Merge branch \(aq2018.3.4\(aq into replace\-noclass\-with\-nocl\-for\-dig
.IP \(bu 2
14e6fb7 In case the test machine can\(aqt resolve
.IP \(bu 2
95e8a2f The +nocl is supported much wider than +noclass
.IP \(bu 2
a00d708 Test dig options for salt.utils.dns.lookup
.UNINDENT
.IP \(bu 2
209ef32 Merge pull request \fI\%#51441\fP from Ch3LL/bp\-51366
.INDENT 2.0
.IP \(bu 2
5bc466e Fix python 3 path for shell test cases
.IP \(bu 2
5351e5c Add testing path to run_script commands
.IP \(bu 2
2d8a364 Fix linter issues
.IP \(bu 2
9b8718a Cloud provider and profile configs are merged
.UNINDENT
.IP \(bu 2
90a8682 Merge pull request \fI\%#51458\fP from twangboy/add_py2_warning
.INDENT 2.0
.IP \(bu 2
05522c0 Merge branch \(aq2018.3.4\(aq into add_py2_warning
.UNINDENT
.IP \(bu 2
b492021 Merge pull request \fI\%#51460\fP from twangboy/update_installer_mac_2018.3.4
.INDENT 2.0
.IP \(bu 2
3c92688 Merge branch \(aq2018.3.4\(aq into update_installer_mac_2018.3.4
.UNINDENT
.IP \(bu 2
892d98c Merge pull request \fI\%#51471\fP from twangboy/fix_test_win_dns_client
.INDENT 2.0
.IP \(bu 2
c9f6b01 Merge branch \(aq2018.3.4\(aq into fix_test_win_dns_client
.UNINDENT
.IP \(bu 2
a05305d Merge pull request \fI\%#51462\fP from ShantonRU/fix\-insecure\-sql\-queries\-in\-mysql\-module\-1
.INDENT 2.0
.IP \(bu 2
d3ef2cb Merge branch \(aq2018.3.4\(aq into fix\-insecure\-sql\-queries\-in\-mysql\-module\-1
.IP \(bu 2
f47dda6 Fix improper use of socket authentication in mysql.user_chpass
.IP \(bu 2
ed62a2f Fix insecure SQL queries in mysql.user_chpass
.INDENT 2.0
.IP \(bu 2
33922c9 Fix the failing dns test on Windows
.UNINDENT
.UNINDENT
.IP \(bu 2
48936c2 Merge pull request \fI\%#51445\fP from terminalmage/fix\-custom\-grains\-traceback
.INDENT 2.0
.IP \(bu 2
191235d Remove custom grains module from 2018.3 branch
.IP \(bu 2
72fd1a2 Roll back icon change
.IP \(bu 2
7dd1704 Add welcome_py2.rtf
.IP \(bu 2
c93e9e3 Add Py2 Warning to installer package
.IP \(bu 2
b658900 Add Py2 Warning for Py2 Installer
.UNINDENT
.IP \(bu 2
a880e42 Merge pull request \fI\%#51438\fP from twangboy/fix_raise_2018.3.4
.INDENT 2.0
.IP \(bu 2
5830fad Add missing raise statement
.UNINDENT
.IP \(bu 2
28b898c Merge pull request \fI\%#51432\fP from Ch3LL/bp\-51324
.INDENT 2.0
.IP \(bu 2
bd41ff0 Fixing various bits in x509 module and unit test to ensure tests are passing on python2 & python3
.UNINDENT
.IP \(bu 2
01717d2 Merge pull request \fI\%#51377\fP from twangboy/fix_auditpol_2018.3.4
.INDENT 2.0
.IP \(bu 2
19e5181 Fix issue when directory doesn\(aqt exist
.UNINDENT
.IP \(bu 2
43a9d2f Merge pull request \fI\%#51338\fP from Ch3LL/bp\-51207
.INDENT 2.0
.IP \(bu 2
345ae67 Backport PR# 50771 to 2018.3 branch
.UNINDENT
.IP \(bu 2
3dcd11d Merge pull request \fI\%#51337\fP from Ch3LL/bp\-51170
.INDENT 2.0
.IP \(bu 2
4e85505 Merge branch \(aq2018.3.4\(aq into bp\-51170
.UNINDENT
.IP \(bu 2
7656aa5 Merge pull request \fI\%#51340\fP from Ch3LL/bp\-51252
.INDENT 2.0
.IP \(bu 2
e74a6c6 Fix py3 managed.file test failure
.IP \(bu 2
6f2c7cf Remoe un\-needed log statement
.IP \(bu 2
824950c Fix 50221 regression test on Windows
.IP \(bu 2
1840af9 peserve newlines from pillar data for file.managed
.UNINDENT
.IP \(bu 2
e90ca1d Merge pull request \fI\%#51290\fP from s0undt3ch/hotfix/fix\-network
.INDENT 2.0
.IP \(bu 2
da3aace Merge branch \(aq2018.3.4\(aq into hotfix/fix\-network
.IP \(bu 2
04f16b8 Fix tests. We no longer get \fIipaddress\fP instances back.
.IP \(bu 2
c3fa82a Fix minion start issue
.INDENT 2.0
.IP \(bu 2
c893dc4 Fix saltmod roster test
.IP \(bu 2
b61854f Roster defines the roster system not a file
.IP \(bu 2
484bab4 Fix linter
.IP \(bu 2
5e2db2f Honor roster file for ssh orchestrations
.UNINDENT
.UNINDENT
.IP \(bu 2
c8db7e3 Merge pull request \fI\%#51317\fP from terminalmage/fix\-pr\-50417
.INDENT 2.0
.IP \(bu 2
4be2891 Merge branch \(aq2018.3.4\(aq into fix\-pr\-50417
.UNINDENT
.IP \(bu 2
e246fdb Merge pull request \fI\%#51311\fP from twangboy/fix_test_file.test_managed
.INDENT 2.0
.IP \(bu 2
f4177e0 Remove mode parameter on Windows
.IP \(bu 2
4c4ded3 Fix regression in dynamic pillarenv
.UNINDENT
.IP \(bu 2
40b20126 Merge pull request \fI\%#51292\fP from Ch3LL/bp\-51226
.INDENT 2.0
.IP \(bu 2
aba114e Merge branch \(aq2018.3.4\(aq into bp\-51226
.UNINDENT
.IP \(bu 2
fc0bec5 Merge pull request \fI\%#51295\fP from Ch3LL/bp\-51279
.INDENT 2.0
.IP \(bu 2
5c4a7a4 Merge branch \(aq2018.3.4\(aq into bp\-51279
.UNINDENT
.IP \(bu 2
dacd1ea Merge pull request \fI\%#51293\fP from Ch3LL/bp\-51233\-2
.INDENT 2.0
.IP \(bu 2
a155fd7 Accounting for when permissions are not returned from file.check_perms, eg. windows systems.
.IP \(bu 2
53ba068 When test=True and there are permissions changes, report it.
.IP \(bu 2
d2eba77 Remove network.py patch
.IP \(bu 2
d431c71 Add __context__ support
.INDENT 2.0
.IP \(bu 2
de6c13d Handle spaces in fstab opts, similar fix to \fI\%#39593\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
1abffb2 Merge pull request \fI\%#51278\fP from dwoz/issue51248
.INDENT 2.0
.IP \(bu 2
c614198 Use pillar roots validation method
.IP \(bu 2
0d2b0c6 Fix linter warnings
.IP \(bu 2
5b98895 Fix wart in pillar_roots validation
.UNINDENT
.UNINDENT
.IP \(bu 2
f7d50b1 Merge pull request \fI\%#50784\fP from sathieu/dynamic_file_roots
.INDENT 2.0
.IP \(bu 2
7ca2aa4 Allow dynamic file_roots
.UNINDENT
.IP \(bu 2
5e840a5 Merge pull request \fI\%#51527\fP from garethgreenaway/bp\-51475
.INDENT 2.0
.IP \(bu 2
801abf2 Fix Elasticsearch retuner
.UNINDENT
.IP \(bu 2
1f6da6a Merge pull request \fI\%#50921\fP from terminalmage/issue49894
.INDENT 2.0
.IP \(bu 2
a35c023 Don\(aqt use a decorator that assumes /etc/apt/sources.list.d exists
.IP \(bu 2
6a62e79 Add integration test for architecture support
.IP \(bu 2
67ae5a5 Add support for architectures for APT pkgrepo.managed states
.UNINDENT
.IP \(bu 2
3f17776 Actually, remove python\-ldap. It needs system deps. Have salt\-jenkins do it.
.IP \(bu 2
afcb6bd Fix the \fIldap\fP package name in requirements/tests.txt
.IP \(bu 2
588cb87 Merge pull request \fI\%#51454\fP from terminalmage/fix\-deprecation\-warning
.INDENT 2.0
.IP \(bu 2
529cce0 Fix deprecation warning in nested outputter
.UNINDENT
.IP \(bu 2
13de0b8 Merge pull request \fI\%#50963\fP from terminalmage/issue50942
.INDENT 2.0
.IP \(bu 2
c84be3f Allow for kwargs to be used in object initialization
.IP \(bu 2
2bf93fd pip states: Use case\-insensitive dictionaries for pip.list return
.IP \(bu 2
792f054 Add a CaseInsensitiveDict implementation
.IP \(bu 2
1410164 pip.installed: Fix traceback when _find_key doesn\(aqt return a match
.UNINDENT
.IP \(bu 2
60953b7 Merge pull request \fI\%#51366\fP from dwoz/cloud_config_merge
.INDENT 2.0
.IP \(bu 2
ae351eb Fix python 3 path for shell test cases
.IP \(bu 2
48062c8 Merge branch \(aq2018.3\(aq into cloud_config_merge
.IP \(bu 2
eeea289 Add testing path to run_script commands
.IP \(bu 2
542d857 Fix linter issues
.IP \(bu 2
a8af3ba Cloud provider and profile configs are merged
.UNINDENT
.IP \(bu 2
9ab2ec6 Coverage on windows chokes with the tox env var \fICOVERAGE_PROCESS_START\fP
.IP \(bu 2
4994c38 Switch required PyTest dependency
.IP \(bu 2
89710a7 Merge pull request \fI\%#51401\fP from dwoz/run_script_win
.INDENT 2.0
.IP \(bu 2
77fdf35 Add testing path to run_script commands
.UNINDENT
.IP \(bu 2
1438a62 Merge pull request \fI\%#51389\fP from terminalmage/proxy\-fixes
.INDENT 2.0
.IP \(bu 2
3cec85e Normalize results if test proxy is enabled
.UNINDENT
.IP \(bu 2
8acd9e5 Merge pull request \fI\%#51368\fP from s0undt3ch/hotfix/tests
.INDENT 2.0
.IP \(bu 2
f4e1692 Fix test
.UNINDENT
.IP \(bu 2
ab60782 Merge pull request \fI\%#51319\fP from terminalmage/issue51255
.INDENT 2.0
.IP \(bu 2
04eb66b Merge branch \(aq2018.3\(aq into issue51255
.UNINDENT
.IP \(bu 2
fdf2cf4 Merge pull request \fI\%#51250\fP from yosnoop/fix\-salt\-utils\-dns\-lookup
.INDENT 2.0
.IP \(bu 2
0ddfad1 Merge branch \(aq2018.3\(aq into fix\-salt\-utils\-dns\-lookup
.IP \(bu 2
9fb4abe Merge branch \(aq2018.3\(aq into fix\-salt\-utils\-dns\-lookup
.IP \(bu 2
67e4131 Merge branch \(aq2018.3\(aq into fix\-salt\-utils\-dns\-lookup
.IP \(bu 2
9a34bcd Unit test for lookup with servers option
.IP \(bu 2
9498fdc Fix _lookup_host to make it work when server specified
.IP \(bu 2
af867e1 Remove excessive whitespaces
.IP \(bu 2
0d074a4 Fix a comment
.IP \(bu 2
1363d2b Proper way to specify _server_ to query with _host_
.IP \(bu 2
7b2facc Fix broken lookup in salt/utils/dns.py
.UNINDENT
.IP \(bu 2
73528a5 Merge pull request \fI\%#51339\fP from dwoz/aws_role_backport
.INDENT 2.0
.IP \(bu 2
156f532 Backport aws role support
.UNINDENT
.IP \(bu 2
7908875 Merge pull request \fI\%#51341\fP from Ch3LL/bp\-51299
.INDENT 2.0
.IP \(bu 2
e3080f1 Add sleep before sending stop over UDP
.UNINDENT
.IP \(bu 2
326425c Merge pull request \fI\%#51352\fP from garethgreenaway/fixing_service_beacon_documentation
.INDENT 2.0
.IP \(bu 2
021fe85 Fixing the documentation for the service beacon.  If not options are provided for the service then there needs to be an empty dictionary.
.UNINDENT
.IP \(bu 2
14a84e8 Merge pull request \fI\%#51333\fP from Ch3LL/merge\-2018.3
.INDENT 2.0
.IP \(bu 2
27d7a89 Merge branch \(aq2018.3\(aq into merge\-2018.3
.UNINDENT
.IP \(bu 2
31b921f Merge pull request \fI\%#51304\fP from terminalmage/issue51270
.INDENT 2.0
.IP \(bu 2
36673fb Merge branch \(aq2018.3\(aq into issue51270
.UNINDENT
.IP \(bu 2
2c3aef7 Merge pull request \fI\%#51313\fP from s0undt3ch/features/tox\-runtests\-2018.3
.INDENT 2.0
.IP \(bu 2
2eafc5c \(dqTell\(dq coverage to track subprocesses.
.IP \(bu 2
f6babeb Remove unused imports
.IP \(bu 2
ff6824c Don\(aqt fail the test because of order
.IP \(bu 2
4d12ccb Show objects on assertion failure
.IP \(bu 2
ee2f10a Add \fIpytest\-salt\-from\-filenames\fP to pytest requirements
.IP \(bu 2
4f4d019 Remove duplicate dependency
.IP \(bu 2
1d4b9f5 Add \fI\&.coveragerc\fP
.IP \(bu 2
78c6d68 Run tests from tox, whether runtests or pytest
.IP \(bu 2
c02757d gitfs: Fix use of deprecated pygit2 function
.INDENT 2.0
.IP \(bu 2
ae62ebc Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
9309639 Merge pull request \fI\%#51305\fP from s0undt3ch/2017.7
.INDENT 2.0
.IP \(bu 2
09b20df Add 2017.7 codecov config
.UNINDENT
.IP \(bu 2
4fa2a02 Merge pull request \fI\%#51267\fP from ethframe/fix\-file\-directory
.INDENT 2.0
.IP \(bu 2
c108825 Fix missing file error in file.directory.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
ad17ac5 Fix mocks to reflect changes to git.latest state
.IP \(bu 2
c817213 Don\(aqt try to run git.config_get_regexp from nonexistent cwd
.IP \(bu 2
f8c3e44 git.latest: add auth to merge/reset calls when LFS used with SSH auth
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
4b11d6b increase batch test timeout on windows
.IP \(bu 2
a5af9c5 Increase minion wait for slow boxes
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51549\fP: (\fI\%s0undt3ch\fP) [2019.2] Allow NOT to install pip dependencies
@ \fI2019\-02\-13 18:16:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
e7ee04e Merge pull request \fI\%#51549\fP from s0undt3ch/2019.2
.IP \(bu 2
d2125aa Allow NOT to install pip dependencies
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51595\fP: (\fI\%mirceaulinic\fP) Fix ipaddress imports
@ \fI2019\-02\-13 17:33:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
c96464b Merge pull request \fI\%#51595\fP from mirceaulinic/mircea/port\-824e0e5
.IP \(bu 2
91bcb4f Merge branch \(aq2019.2\(aq into mircea/port\-824e0e5
.IP \(bu 2
84fc76d Fix ipaddress imports
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51517\fP: (\fI\%damianosSemmle\fP) Fixed string format index out of range error
@ \fI2019\-02\-13 08:18:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
e3c9a3e Merge pull request \fI\%#51517\fP from damianosSemmle/fix\-string\-format\-index
.IP \(bu 2
c0959e2 Merge branch \(aq2019.2\(aq into fix\-string\-format\-index
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51581\fP: (\fI\%garethgreenaway\fP) [2019.2] Merge forward from 2019.2.0rc1 to 2019.2
@ \fI2019\-02\-13 04:11:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
82500bb Merge pull request \fI\%#51581\fP from garethgreenaway/merge\-2019.2.0rc1
.IP \(bu 2
b00e7e8 Merge branch \(aq2019.2\(aq into merge\-2019.2.0rc1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51607\fP: (\fI\%dwoz\fP) [2019.2]  Wait for minions to be pingable before starting tests
@ \fI2019\-02\-13 00:48:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
edb5e94 Merge pull request \fI\%#51607\fP from dwoz/wait_minions_2019.2
.IP \(bu 2
ab0a6a3 fix linter
.IP \(bu 2
f2e4a30 Wait for minions to be pingable before starting tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51584\fP: (\fI\%dwoz\fP) [2019.2] Use the code directory instead of cwd for python path
@ \fI2019\-02\-12 18:43:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
1e0275e Merge pull request \fI\%#51584\fP from dwoz/script_fixes
.IP \(bu 2
dbf4356 Use the code directory instead of cwd for python path
.IP \(bu 2
cd24006 Merge branch \(aq2019.2\(aq into merge\-2019.2.0rc1
.IP \(bu 2
6e55164 Merge branch \(aq2019.2.0.rc1\(aq into merge\-2019.2.0rc1
.INDENT 2.0
.IP \(bu 2
ac73745 Merge branch \(aq2019.2\(aq into fix\-string\-format\-index
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51583\fP: (\fI\%dwoz\fP) Add testing path to run_script commands
@ \fI2019\-02\-11 21:38:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
f446c52 Merge pull request \fI\%#51583\fP from dwoz/scriptfix
.IP \(bu 2
e49ba86 Add testing path to run_script commands
.IP \(bu 2
788f7e0 Fixed string format index out of range error
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51405\fP: (\fI\%aplanas\fP) Documentation: fix typo in \(dqequivalent\(dq
@ \fI2019\-02\-01 21:11:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3e27be Merge pull request \fI\%#51405\fP from aplanas/backport_49669
.IP \(bu 2
58279b4 Documentation: fix typo in \(dqequivalent\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51406\fP: (\fI\%aplanas\fP) states_pt3: fix rST link format
@ \fI2019\-02\-01 21:10:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
5c26652 Merge pull request \fI\%#51406\fP from aplanas/backport_49670
.IP \(bu 2
204432d Merge branch \(aq2019.2\(aq into backport_49670
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51426\fP: (\fI\%aplanas\fP) mount: cache blkid information
@ \fI2019\-02\-01 21:09:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb70bd3 Merge pull request \fI\%#51426\fP from aplanas/backport_51135
.IP \(bu 2
ac790a6 Merge branch \(aq2019.2\(aq into backport_51135
.IP \(bu 2
66743d6 mount: cache blkid information
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51425\fP: (\fI\%aplanas\fP) cmdmod: add sysfs into the chroot
@ \fI2019\-02\-01 21:09:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e8bf05 Merge pull request \fI\%#51425\fP from aplanas/backport_51094
.IP \(bu 2
9193106 cmdmod: add sysfs into the chroot
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51419\fP: (\fI\%aplanas\fP) file: update attributes for lsattr and chattr
@ \fI2019\-02\-01 21:04:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
d7a47f0 Merge pull request \fI\%#51419\fP from aplanas/backport_50607
.IP \(bu 2
ab8a8b8 file: update attributes for lsattr and chattr
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51414\fP: (\fI\%aplanas\fP) service: SUSE is not based on sysvinit anymore
@ \fI2019\-02\-01 21:02:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
7e020dd Merge pull request \fI\%#51414\fP from aplanas/backport_50396
.IP \(bu 2
b5cff17 service: SUSE is not based on sysvinit anymore
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51408\fP: (\fI\%aplanas\fP) parted: fix the ordering of list command
@ \fI2019\-02\-01 21:00:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50473\fP: (\fI\%aplanas\fP) parted: support variable length output for print (refs: \fI\%#51408\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49804\fP: (\fI\%aplanas\fP) parted: fix the ordering of list command (refs: \fI\%#51408\fP)
.IP \(bu 2
9f87dda Merge pull request \fI\%#51408\fP from aplanas/backport_49804
.IP \(bu 2
467daf2 parted: support variable length output for print
.IP \(bu 2
da2e632 parted: fix the ordering of list command
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50097\fP: (\fI\%aplanas\fP) lowpkg.diff refers to a package name, but a package file is required (refs: \fI\%#51410\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51410\fP: (\fI\%aplanas\fP) Fix lowpkg.diff documentation and parameter name
@ \fI2019\-02\-01 20:57:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
7e14499 Merge pull request \fI\%#51410\fP from aplanas/backport_50126
.IP \(bu 2
d38622e Fix lowpkg.diff documentation and parameter name
.INDENT 2.0
.IP \(bu 2
e61a077 states_pt3: fix rST link format
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51404\fP: (\fI\%aplanas\fP) blockdev: fix url from comment
@ \fI2019\-01\-30 20:05:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
a16461b Merge pull request \fI\%#51404\fP from aplanas/backport_49668
.IP \(bu 2
da2e30d blockdev: fix url from comment
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51407\fP: (\fI\%aplanas\fP) parted: fix _validate_partition_boundary
@ \fI2019\-01\-30 20:05:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
756c367 Merge pull request \fI\%#51407\fP from aplanas/backport_49803
.IP \(bu 2
b004b33 parted: fix _validate_partition_boundary
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51435\fP: (\fI\%damianosSemmle\fP) Fixed not raised exceptions
@ \fI2019\-01\-30 18:32:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
1d45664 Merge pull request \fI\%#51435\fP from damianosSemmle/fix\-raise\-exception
.IP \(bu 2
7a9ff59 Fixed not raised exceptions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51336\fP: (\fI\%Ch3LL\fP) [2019.2] Merge Forward from 2019.2.0.rc1 to 2019.2
@ \fI2019\-01\-27 23:55:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
d4b9093 Merge pull request \fI\%#51336\fP from Ch3LL/merge\-2019.2.0rc1
.IP \(bu 2
62a20b1 Remove unused import
.IP \(bu 2
2284ea5 Merge branch \(aq2019.2\(aq into merge\-2019.2.0rc1
.IP \(bu 2
18bf236 Merge branch \(aq2019.2.0.rc1\(aq into 2019.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51334\fP: (\fI\%Ch3LL\fP) [2019.2] Merge forward from 2018.3 to 2019.2
@ \fI2019\-01\-27 23:49:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
02b43a0 Merge pull request \fI\%#51334\fP from Ch3LL/merge\-2019.2
.IP \(bu 2
25ec653 Merge branch \(aq2018.3\(aq into \(aq2019.2\(aq
.INDENT 2.0
.IP \(bu 2
f62cc11 Merge pull request \fI\%#51324\fP from garethgreenaway/1257_something_something_bytes_argh_python2
.INDENT 2.0
.IP \(bu 2
bd7072f Merge branch \(aq2018.3\(aq into 1257_something_something_bytes_argh_python2
.UNINDENT
.IP \(bu 2
b44cd84 Merge pull request \fI\%#51323\fP from garethgreenaway/network_dns_check_test
.INDENT 2.0
.IP \(bu 2
055eadc Merge branch \(aq2018.3\(aq into network_dns_check_test
.UNINDENT
.IP \(bu 2
be57a0f Merge pull request \fI\%#51321\fP from terminalmage/issue51256
.INDENT 2.0
.IP \(bu 2
d9c4462 Fix 500 error when using wheel_async
.IP \(bu 2
c847f54 Swap passed addr for string rather than ipaddress object.
.IP \(bu 2
87f3972 removing another debugging log.
.IP \(bu 2
ad64efb Use MagicMock
.IP \(bu 2
172ad2e removing debugging
.IP \(bu 2
5812eae Adding a test to ensure dns_check works as expected.
.IP \(bu 2
0e542c5 Fixing various bits in x509 module and unit test to ensure tests are passing on python2 & python3
.UNINDENT
.IP \(bu 2
85e7ac6 Merge pull request \fI\%#51306\fP from s0undt3ch/2018.3
.INDENT 2.0
.IP \(bu 2
5f0f296 Add 2018.3 codecov config
.UNINDENT
.IP \(bu 2
5a398a3 Merge pull request \fI\%#51207\fP from twangboy/fix_test_pkg
.INDENT 2.0
.IP \(bu 2
d4ab6d8 Merge branch \(aq2018.3\(aq into fix_test_pkg
.UNINDENT
.IP \(bu 2
7a97cb4 Merge pull request \fI\%#51252\fP from dwoz/issue\-50221
.INDENT 2.0
.IP \(bu 2
f96828a Merge branch \(aq2018.3\(aq into issue\-50221
.UNINDENT
.IP \(bu 2
253f5e4 Merge pull request \fI\%#51264\fP from gtmanfred/2018.3
.INDENT 2.0
.IP \(bu 2
f3ebd32 Merge branch \(aq2018.3\(aq into 2018.3
.UNINDENT
.IP \(bu 2
aacc047 Merge pull request \fI\%#51274\fP from twangboy/fix_network
.INDENT 2.0
.IP \(bu 2
344bf65 Fix tests. We no longer get \fIipaddress\fP instances back.
.IP \(bu 2
345aa5b Fix minion start issue
.INDENT 2.0
.IP \(bu 2
f553be7 tuples don\(aqt have pop
.IP \(bu 2
55ea80e don\(aqt shadow builtin
.IP \(bu 2
6148c50 an argument is not always needed to be passed to open a file
.UNINDENT
.UNINDENT
.IP \(bu 2
8a89cb2 Merge pull request \fI\%#51279\fP from twangboy/backport_lgpo
.INDENT 2.0
.IP \(bu 2
06b1545 Remove network.py patch
.IP \(bu 2
2356f25 Add __context__ support
.INDENT 2.0
.IP \(bu 2
a5255f0 Merge remote\-tracking branch \(aqsaltstack/2018.3\(aq into issue\-50221
.UNINDENT
.UNINDENT
.IP \(bu 2
6796e65 Merge pull request \fI\%#51276\fP from garethgreenaway/merge\-2018.3
.INDENT 2.0
.IP \(bu 2
44ddc43 Merge branch \(aq2018.3\(aq into merge\-2018.3
.UNINDENT
.IP \(bu 2
0adde9b Merge pull request \fI\%#51220\fP from sathieu/artifactory\-classifier\-2018.3
.INDENT 2.0
.IP \(bu 2
a85f146 fixes \fI\%#31179\fP by appling the same logic as used in the nexus module
.UNINDENT
.IP \(bu 2
f6a7cad Merge pull request \fI\%#51225\fP from astronouth7303/loader\-docs\-2018.3
.INDENT 2.0
.IP \(bu 2
6e7da95 Add the tokens system.
.IP \(bu 2
7e2838c Add reference to the execution module docs
.IP \(bu 2
f30f9e8 Remove search system
.IP \(bu 2
f0cc183 Fileserver modules can be loaded from the fileserver.
.UNINDENT
.IP \(bu 2
1a2f680 Merge pull request \fI\%#51239\fP from garethgreenaway/51208_file_manage_escaped_double_quotes
.INDENT 2.0
.IP \(bu 2
4251c0c Merge branch \(aq2018.3\(aq into 51208_file_manage_escaped_double_quotes
.IP \(bu 2
6a9daa7 Merge branch \(aq2018.3\(aq into 51208_file_manage_escaped_double_quotes
.IP \(bu 2
0bf468c Fixing lint.  Using a constant instead of looking for the condition in the string.
.IP \(bu 2
a233dbc Ensuring we can handle a string that contains single quote + an escaped double quote.
.UNINDENT
.IP \(bu 2
d614127 Merge pull request \fI\%#51261\fP from OrangeDog/patch\-2
.INDENT 2.0
.IP \(bu 2
d809b9b Avoid double\-counting errors and ignore test runs
.IP \(bu 2
6ca7deb Remove unused host parameter and average/disaster keys
.IP \(bu 2
2d44527 Just let zabbix_sender use the config file
.IP \(bu 2
6404e2c Fix fallback command so it\(aqs actually run
.IP \(bu 2
b79a55a Fix KeyError in Zabbix returner
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
0971035 Merge branch \(aq2018.3\(aq into merge\-2018.3
.IP \(bu 2
243dc06 Merge branch \(aq2017.7\(aq into merge\-2018.3
.INDENT 2.0
.IP \(bu 2
acfb7d8 Update pytest requirements
.IP \(bu 2
c19479b Move all of PyTest requirements to its own requiremnts file
.IP \(bu 2
39e633f Merge pull request \fI\%#51246\fP from garethgreenaway/bp\-50358
.INDENT 2.0
.IP \(bu 2
c33c558 Backport \fI\%#50358\fP to 2017.7
.IP \(bu 2
c1ea10f Fix py3 managed.file test failure
.IP \(bu 2
537114c Remoe un\-needed log statement
.IP \(bu 2
ac978f0 Fix 50221 regression test on Windows
.IP \(bu 2
65f38b5 peserve newlines from pillar data for file.managed
.IP \(bu 2
464d813 Merge branch \(aq2018.3\(aq into fix_test_pkg
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
276d621 Merge pull request \fI\%#51197\fP from Ch3LL/tag_manager
.INDENT 2.0
.IP \(bu 2
b9a0705 Merge branch \(aq2018.3\(aq into tag_manager
.IP \(bu 2
210238b Merge branch \(aq2018.3\(aq into tag_manager
.IP \(bu 2
827d6c3 Merge branch \(aq2018.3\(aq into tag_manager
.IP \(bu 2
fcdfe69 Add Google Tag Manager to Docs
.UNINDENT
.IP \(bu 2
c8e70a9 Merge pull request \fI\%#51206\fP from terminalmage/fix\-reload
.INDENT 2.0
.IP \(bu 2
8e23a6c Add missing import
.IP \(bu 2
31ca7c6 Fix usage of reload for PY3 compatibility
.UNINDENT
.IP \(bu 2
41ae390 Merge pull request \fI\%#51231\fP from terminalmage/issue51056
.INDENT 2.0
.IP \(bu 2
4a61477 Clarify documentation for the the gitfs \(dqall_saltenvs\(dq config param
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
0574476 Merge branch \(aq2018.3\(aq into fix_test_pkg
.IP \(bu 2
b91b2c6 Backport PR# 50771 to 2018.3 branch
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51314\fP: (\fI\%s0undt3ch\fP) [2019.2] Allow running runtests.py using tox
@ \fI2019\-01\-25 18:56:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
95607d1 Merge pull request \fI\%#51314\fP from s0undt3ch/features/tox\-runtests\-2019.2
.IP \(bu 2
39fb981 \(dqTell\(dq coverage to track subprocesses.
.IP \(bu 2
f27589a Remove unused imports
.IP \(bu 2
3000d20 Fix tests. We no longer get \fIipaddress\fP instances back.
.IP \(bu 2
8fcf235 Fix minion start issue
.IP \(bu 2
a26ba7f Don\(aqt fail the test because of order
.IP \(bu 2
138ca2e Show objects on assertion failure
.IP \(bu 2
840b3d2 Add \fIpytest\-salt\-from\-filenames\fP to pytest requirements
.IP \(bu 2
716bda4 Remove duplicate dependency
.IP \(bu 2
6d62156 Add \fI\&.coveragerc\fP
.IP \(bu 2
6bb56ce Run tests from tox, whether runtests or pytest
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51307\fP: (\fI\%s0undt3ch\fP) Add 2019.2 codecov config
@ \fI2019\-01\-24 13:34:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
b348034 Merge pull request \fI\%#51307\fP from s0undt3ch/2019.2
.IP \(bu 2
495aa5c Add 2019.2 codecov config
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51280\fP: (\fI\%garethgreenaway\fP) [2019.2] Merge forward from 2019.2.0rc1 to 2019.2
@ \fI2019\-01\-23 07:08:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
d224096 Merge pull request \fI\%#51280\fP from garethgreenaway/merge\-2019.2\-rc
.IP \(bu 2
e78ede2 Merge branch \(aq2019.2\(aq into merge\-2019.2\-rc
.IP \(bu 2
a425de6 Merge branch \(aq2019.2.0.rc1\(aq into merge\-2019.2\-rc
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51277\fP: (\fI\%garethgreenaway\fP) [2019.2] Merge forward from 2018.3 to 2019.2
@ \fI2019\-01\-23 07:01:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
8596ee4 Merge pull request \fI\%#51277\fP from garethgreenaway/merge\-2019.2
.IP \(bu 2
f05e754 Merge branch \(aq2019.2\(aq into merge\-2019.2
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51273\fP: (\fI\%isbm\fP) How to properly fix API? (refs: \fI\%#51285\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51285\fP: (\fI\%garethgreenaway\fP) [2019.2] Add metadata to accepted keyword arguments
@ \fI2019\-01\-22 23:07:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
8cca51b Merge pull request \fI\%#51285\fP from garethgreenaway/51273_metadata_auth_keyword_argument
.IP \(bu 2
bd82d80 Ensure metadata is an accepted keyword argument for authentication functions.
.IP \(bu 2
d0d5726 Merge branch \(aq2018.3\(aq into merge\-2019.2
.IP \(bu 2
a6a9040 Merge pull request \fI\%#51179\fP from terminalmage/fix\-regex\-chars
.INDENT 2.0
.IP \(bu 2
9951b8d Fix possible oversight in nodegroup modifications
.UNINDENT
.IP \(bu 2
d5acd5b Merge pull request \fI\%#51170\fP from dwoz/issue51158
.INDENT 2.0
.IP \(bu 2
b69c002 Fix saltmod roster test
.IP \(bu 2
2594f24 Roster defines the roster system not a file
.IP \(bu 2
05836b3 Merge branch \(aq2018.3\(aq into issue51158
.IP \(bu 2
bf47f6f Fix linter
.IP \(bu 2
6223596 Honor roster file for ssh orchestrations
.UNINDENT
.IP \(bu 2
5543a53 Update pytest requirements
.IP \(bu 2
f958df5 Move all of PyTest requirements to its own requiremnts file
.IP \(bu 2
8f8ebbc Merge pull request \fI\%#51226\fP from garethgreenaway/51195_handle_spaces_in_fstab_opts
.INDENT 2.0
.IP \(bu 2
1902ce8 Merge branch \(aq2018.3\(aq into 51195_handle_spaces_in_fstab_opts
.UNINDENT
.IP \(bu 2
e3a9e99 Merge pull request \fI\%#51233\fP from Ch3LL/bp\-51105
.INDENT 2.0
.IP \(bu 2
eef49e8 Merge branch \(aq2018.3\(aq into bp\-51105
.UNINDENT
.IP \(bu 2
e53e9b1 Merge pull request \fI\%#51230\fP from Ch3LL/merge\-2018.3
.INDENT 2.0
.IP \(bu 2
0ef7675 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
4a12c5f Merge pull request \fI\%#50852\fP from mirceaulinic/fix\-capirca
.INDENT 2.0
.IP \(bu 2
fa91267 Merge branch \(aq2017.7\(aq into fix\-capirca
.IP \(bu 2
71913ff Merge branch \(aq2017.7\(aq into fix\-capirca
.IP \(bu 2
6fc3484 Lint?
.IP \(bu 2
3d56750 Extra newline for lint
.IP \(bu 2
5176cd8 Improve the Capirca and related modules for ACL config generation
.UNINDENT
.IP \(bu 2
3f4759b Merge pull request \fI\%#50923\fP from astronouth7303/patch\-2
.INDENT 2.0
.IP \(bu 2
4f631a6 Document {% include %}
.UNINDENT
.IP \(bu 2
210e817 Merge pull request \fI\%#51111\fP from s0undt3ch/2017.7
.INDENT 2.0
.IP \(bu 2
08e0ae7 Update to salt\-bootstrap v2019.01.08
.INDENT 2.0
.IP \(bu 2
c3520aa Accounting for when permissions are not returned from file.check_perms, eg. windows systems.
.IP \(bu 2
cd80548 When test=True and there are permissions changes, report it.
.IP \(bu 2
89345eb Handle spaces in fstab opts, similar fix to \fI\%#39593\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50538\fP: (\fI\%sjorge\fP) salt.modules.pdbedit broken on Samba 4.9.x (refs: \fI\%#50540\fP, \fI\%#51221\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51221\fP: (\fI\%Ch3LL\fP) Backport \fI\%#50538\fP into 2019.2
@ \fI2019\-01\-18 22:42:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50540\fP: (\fI\%sjorge\fP) Fix pdbedit module on samba 4.9 (Fixes \fI\%#50538\fP)
.IP \(bu 2
0ccd5c3 Merge pull request \fI\%#51221\fP from Ch3LL/bp\-50540
.IP \(bu 2
223e7c0 Merge branch \(aq2019.2\(aq into bp\-50540
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51232\fP: (\fI\%Ch3LL\fP) [2019.2] Merge forward from 2018.3 to 2019.2
@ \fI2019\-01\-18 20:51:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
3edaf18 Merge pull request \fI\%#51232\fP from Ch3LL/merge\-2019.2
.IP \(bu 2
3b966f3 Merge branch \(aq2019.2\(aq into merge\-2019.2
.IP \(bu 2
ffe23fa Merge branch \(aq2018.3\(aq into \(aq2019.2\(aq
.INDENT 2.0
.IP \(bu 2
26008ef Merge pull request \fI\%#51212\fP from sathieu/file_roots_slash
.INDENT 2.0
.IP \(bu 2
b769f18 Allow slash in file_roots envs
.IP \(bu 2
f9437e2 Test for file_roots envs with slash leads to \(dqNo such file or directory\(dq
.UNINDENT
.IP \(bu 2
5916282 Merge pull request \fI\%#51209\fP from garethgreenaway/bp\-51124
.INDENT 2.0
.IP \(bu 2
82acce4 Handle encoding when opening file for both py2/py3
.UNINDENT
.IP \(bu 2
094bd33 Merge pull request \fI\%#51184\fP from twangboy/fix_auditpol
.INDENT 2.0
.IP \(bu 2
2e68d35 directly call cmd.run_all
.UNINDENT
.IP \(bu 2
ac71922 Merge pull request \fI\%#51191\fP from Ch3LL/bp\-50918
.INDENT 2.0
.IP \(bu 2
7300d84 Skip debian tests on Windows
.IP \(bu 2
4622433 Fix \fItest_debian_ip\fP on Windows
.UNINDENT
.IP \(bu 2
e7f53a3 Merge pull request \fI\%#51144\fP from jgleissner/2018.3\-azurearm\-py3
.INDENT 2.0
.IP \(bu 2
3178f1a msazure.py: remove unused imports
.IP \(bu 2
99a4b9d azurearm: fix list_locations
.IP \(bu 2
aebe34b azurearm: fix show_instance function
.IP \(bu 2
d80669f msazure: fix object_to_dict for python 3
.UNINDENT
.IP \(bu 2
1206f92 Merge pull request \fI\%#51171\fP from twangboy/fix_crypt
.INDENT 2.0
.IP \(bu 2
6caa93b Add random sleep time to avoid overloading Windows
.UNINDENT
.IP \(bu 2
a96deed Merge pull request \fI\%#51174\fP from jpsv/2018.3
.INDENT 2.0
.IP \(bu 2
055823e Update opsgenie.py
.IP \(bu 2
501c8df Merge branch \(aq2018.3\(aq into 2018.3
.IP \(bu 2
220aa8a Update opsgenie.py
.IP \(bu 2
5dc21cc Update to from V1 API to V2
.IP \(bu 2
f93ce7c Update to V2 API
.UNINDENT
.IP \(bu 2
563d487 Merge pull request \fI\%#51010\fP from amendlik/ldap\-groups
.INDENT 2.0
.IP \(bu 2
cd336ed Merge branch \(aq2018.3\(aq into ldap\-groups
.IP \(bu 2
94f8ee4 Update unit tests for auth.ldap
.IP \(bu 2
08e36d0 Allow unauthenticated bind for listing LDAP groups
.UNINDENT
.IP \(bu 2
6dc3752 Merge pull request \fI\%#51112\fP from s0undt3ch/2018.3
.INDENT 2.0
.IP \(bu 2
4f1d846 Update to salt\-bootstrap v2019.01.08
.UNINDENT
.IP \(bu 2
b19c990 Merge pull request \fI\%#51097\fP from terminalmage/fix\-keyerror\-raise
.INDENT 2.0
.IP \(bu 2
a3c0b49 Fix poorly\-written test
.IP \(bu 2
c0ff7b1 Fix more incorrect exception raises
.IP \(bu 2
f11dbcc Fix improper KeyError raise
.UNINDENT
.IP \(bu 2
8920a86 Merge pull request \fI\%#51169\fP from twangboy/fix_git_state
.INDENT 2.0
.IP \(bu 2
f2d1180 More descriptive error when missing GitPython or PyGit2
.UNINDENT
.IP \(bu 2
58eede6 Merge pull request \fI\%#51173\fP from dwoz/issue51160
.INDENT 2.0
.IP \(bu 2
11cc7b3 Remove un\-needed test
.IP \(bu 2
0f87812 Merge develop, Revert exception handling
.IP \(bu 2
7365a1a Pass bytes to idna
.UNINDENT
.IP \(bu 2
83c38c6 Revert \(dqwordsmithing\(dq
.IP \(bu 2
a40739c wordsmithing
.IP \(bu 2
b348ace Make sure blackout tests clean up after themselves. Properly.
.IP \(bu 2
68a12d5 These should not be considered destructive tests
.IP \(bu 2
475404d fix docstring quote style
.IP \(bu 2
71c3574 Revert \(dqbackport test improvements from develop\(dq
.IP \(bu 2
e32d219 backport test improvements from develop Bogus random test failures forklifted from develop at 414bfe61a4fbe6f84be32242924f23c7126c24d6
.IP \(bu 2
42654d8 socket.connect needs a tuple TypeError \fI\%https://docs.python.org/2/library/socket.html\fP RTFD \(dqNote This method has historically accepted a pair of parameters for AF_INET addresses instead of only a tuple. This was never intentional and is no longer available in Python 2.0 and later. \(dq
.IP \(bu 2
27254fc syntax error bad parentheses
.IP \(bu 2
24bb94f Don\(aqt ip_bracket addresses returned by check_dns.
.IP \(bu 2
02b825e expose error in tests
.IP \(bu 2
0a92c46 Need more detail on test failure
.IP \(bu 2
3574698 ip_address does not need str() and parse_host_port handles ipv6 or ipv4
.IP \(bu 2
7a6bc57 avoid TypeError by not constructing an ip_address from an ip_address
.IP \(bu 2
35410dd try to debug error in tests (revert me)
.IP \(bu 2
2f8ca47 wordsmithing
.IP \(bu 2
1dd1f7d parsing logic error
.IP \(bu 2
98041c1 minimize diff
.IP \(bu 2
c92a247 don\(aqt try to handle/log test exception
.IP \(bu 2
eb60586 remove bad extra test assertion inside exception handler
.IP \(bu 2
e1e5d87 checking for truthiness better than len
.IP \(bu 2
a984a43 typo in ipaddress.IPv6Address()
.IP \(bu 2
5fc6c60 clear up lint, disambiguation
.IP \(bu 2
8c6dfea lint pep8 whitespace
.IP \(bu 2
f9594b8 don\(aqt test invalid combination
.IP \(bu 2
de823fd fix good_host_ports iteration
.IP \(bu 2
c5a5b34 test assertion correction
.IP \(bu 2
e169e0d fixup rebase merge goof
.IP \(bu 2
d28bab6 fix test setup
.IP \(bu 2
42c710e lint pep8
.IP \(bu 2
15c6deb fix horrible mistakes
.IP \(bu 2
c092baf fix indentation doh
.IP \(bu 2
9080745 debug ipaddress.ip_address TypeError
.IP \(bu 2
8bd82f4 debug ipaddress.ip_address TypeError
.IP \(bu 2
080ab70 fix parse_host_port() parse error on hostname only arg
.IP \(bu 2
571603c coverage for master host:port ipv4 and ipv6 config value support fix test_parse_host_port bad values lint
.IP \(bu 2
f14ff16 fix minion zmq connecting to master configured as IPv6 address
.IP \(bu 2
9d72f13 pylint E741 triggers error in salt\-pylint E8741 (unhandled)
.IP \(bu 2
2052838 avoid error on (redundant) is_ip check
.IP \(bu 2
0eaeb1e avoid error on (redundant) is_ip check
.IP \(bu 2
f8bd08e fix parse_host_port() is_ip call
.IP \(bu 2
89519fe fix parse_host_port() parse error on hostname only arg
.IP \(bu 2
1417528 fix parse_host_port() bad exception on hostname only arg
.IP \(bu 2
194a024 coverage for master host:port ipv4 and ipv6 config value support fix test_parse_host_port bad values lint
.IP \(bu 2
df73388 fix minion zmq connecting to master configured as IPv6 address
.IP \(bu 2
06854cf Merge pull request \fI\%#51147\fP from Ch3LL/merge\-2018.3
.INDENT 2.0
.IP \(bu 2
d39d8b7 Merge branch \(aq2018.3\(aq into merge\-2018.3
.UNINDENT
.IP \(bu 2
b79c09e Merge pull request \fI\%#51161\fP from amendlik/long\-hostname
.INDENT 2.0
.IP \(bu 2
6fcc4ad Merge branch \(aq2018.3\(aq into long\-hostname
.UNINDENT
.IP \(bu 2
1424734 Merge pull request \fI\%#51159\fP from rkrieger/fix\-issue\-51067
.INDENT 2.0
.IP \(bu 2
1440ccf Prevent crash by testing for \(aqmanufacturer\(aq in osdata on OpenBSD
.IP \(bu 2
1a4e307 Ignore exceptions when generating the minion ID
.UNINDENT
.IP \(bu 2
5e37326 Merge pull request \fI\%#51146\fP from terminalmage/fix\-vsphere\-tuple\-issue
.INDENT 2.0
.IP \(bu 2
5d60022 Fix invalid assignment in vsphere module
.UNINDENT
.IP \(bu 2
fad8621 Merge pull request \fI\%#51154\fP from twangboy/auditpol
.INDENT 2.0
.IP \(bu 2
9064376 Add support for Advanced Audit policies
.UNINDENT
.IP \(bu 2
f7a100c Merge pull request \fI\%#51151\fP from Ch3LL/bp_51061
.INDENT 2.0
.IP \(bu 2
ffdae27 When writing output to stdout we want to ensure that the data is a string not bytes.  Under py2 the salt.utils.data.encode function results in a string but under py3 the result is a bytestring.  Swapping out salt.utils.data.encode for salt.utils.stringutils.to_str.
.UNINDENT
.IP \(bu 2
3a50a57 Merge pull request \fI\%#51150\fP from Ch3LL/bp\-49508
.INDENT 2.0
.IP \(bu 2
7ae53ad Do not silently ignore errors.
.IP \(bu 2
deb0134 Convert to string before sending via \(aqpublish\(aq.
.IP \(bu 2
651c551 Use to_str salt.utils when writing to a file.
.UNINDENT
.IP \(bu 2
8bb589d Merge pull request \fI\%#51152\fP from garethgreenaway/50433_handle_grants_better
.INDENT 2.0
.IP \(bu 2
f7caa4d Fixing lint
.IP \(bu 2
e8c8c0f Adding some tests to ensure \(dqALL PRIVILEGES\(dq is handled correctly in 8.0 and 5.6
.IP \(bu 2
b4bfd9f Add additional grants.  Adding logic to handle when ALL or ALL PRIVILEGES is passed for the grant, including some logic to handle the fact that the grants are split when show grants is run for a particular user.
.INDENT 2.0
.IP \(bu 2
74edfd9 Fix pylint
.IP \(bu 2
81a3d47 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
8a76a19 Merge pull request \fI\%#50858\fP from jasonarewhy/bugfix\-2017.7/ubuntu\-networking\-searchdomain
.INDENT 2.0
.IP \(bu 2
3395a3d Merge branch \(aq2017.7\(aq into bugfix\-2017.7/ubuntu\-networking\-searchdomain
.IP \(bu 2
69d25aa update debian_ip test
.IP \(bu 2
a6b896c get searchdomain in Ubuntu 12+
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
dda1ebb Merge pull request \fI\%#51133\fP from 5uper5hoot/issue\-\fI\%#50849\fP
.INDENT 2.0
.IP \(bu 2
ec14e13 Fixes mysql server version comparison.
.UNINDENT
.IP \(bu 2
9d4321d Merge pull request \fI\%#50878\fP from max\-arnold/output\-docs
.INDENT 2.0
.IP \(bu 2
d7403da Fix profile outputter docs
.UNINDENT
.IP \(bu 2
ce87504 Merge pull request \fI\%#51076\fP from OrangeDog/patch\-1
.INDENT 2.0
.IP \(bu 2
568e4fb Revert add \-> check
.IP \(bu 2
4d7ebe7 Typos in index_template_present documentation
.UNINDENT
.IP \(bu 2
d08abf4 Merge pull request \fI\%#51081\fP from garethgreenaway/merge\-2018.3
.INDENT 2.0
.IP \(bu 2
027804a Merge branch \(aq2018.3\(aq into merge\-2018.3
.UNINDENT
.IP \(bu 2
335088b Merge pull request \fI\%#51080\fP from garethgreenaway/50966_nxos_ensure_kwargs_list
.IP \(bu 2
230a66b Merge branch \(aq2018.3\(aq into 50966_nxos_ensure_kwargs_list
.IP \(bu 2
629dc25 Ensure kwargs is a list before we attempt to loop through.  Similar fix to \fI\%https://github.com/rallytime/salt/commit/430c462f34eb4eedf2384e06fbee8dc19b8026f6\fP in the proxy module.
.IP \(bu 2
a20791b Merge branch \(aq2018.3\(aq into merge\-2018.3
.IP \(bu 2
9386aab Merge branch \(aq2017.7\(aq into merge\-2018.3
.IP \(bu 2
998feca Merge pull request \fI\%#51030\fP from terminalmage/issue38502
.IP \(bu 2
6dbd81f Add unit test to ensure we don\(aqt diff bare repos
.IP \(bu 2
3c4b243 Merge branch \(aq2019.2\(aq into bp\-50540
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51234\fP: (\fI\%KChandrashekhar\fP) Added a note in Release notes about py 2.7 EOL
@ \fI2019\-01\-18 15:53:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
e6ab913 Merge pull request \fI\%#51234\fP from KChandrashekhar/2019.2\-docs
.IP \(bu 2
e4afc81 Addressing Megan\(aqs comment to fix the py2.7 deprecation message in release notes
.IP \(bu 2
8ec0296 Added a note in Release notes about py 2.7 EOL
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51198\fP: (\fI\%Ch3LL\fP) [2019.2] Merge forward from 2019.2.0.rc1 to 2019.2
@ \fI2019\-01\-17 21:23:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
644ef8c Merge pull request \fI\%#51198\fP from Ch3LL/merge\-2019.2\-rc
.IP \(bu 2
810c611 Merge branch \(aq2019.2.0.rc1\(aq into 2019.2
.IP \(bu 2
3f61e77 Fix pdbedit module on samba 4.9 (Fixes \fI\%#50538\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51148\fP: (\fI\%Ch3LL\fP) [2019.2] Merge forward from 2018.3 to 2019.2
@ \fI2019\-01\-14 22:49:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
12901c3 Merge pull request \fI\%#51148\fP from Ch3LL/merge\-2019.2
.IP \(bu 2
1d7329a Fix pylint
.IP \(bu 2
5271636 Fixes mysql server version comparison.
.IP \(bu 2
b53f171 Ensure kwargs is a list before we attempt to loop through.  Similar fix to \fI\%https://github.com/rallytime/salt/commit/430c462f34eb4eedf2384e06fbee8dc19b8026f6\fP in the proxy module.
.IP \(bu 2
d0f2d15 Revert add \-> check
.IP \(bu 2
437d8b5 Typos in index_template_present documentation
.IP \(bu 2
3bf189e Add unit test to ensure we don\(aqt diff bare repos
.IP \(bu 2
2f8e391 Fix profile outputter docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51100\fP: (\fI\%dwoz\fP) Fix typo in method name (2019.2)
@ \fI2019\-01\-08 18:12:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
4c2d76d Merge pull request \fI\%#51100\fP from dwoz/cloud_typo
.IP \(bu 2
60f53d0 Fix typo in method name
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51099\fP: (\fI\%terminalmage\fP) Fix improper exception raises (2019.2)
@ \fI2019\-01\-08 17:55:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
39b28f4 Merge pull request \fI\%#51099\fP from terminalmage/fix\-exception\-raise
.IP \(bu 2
2a25530 Fix improper exception raise
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51084\fP: (\fI\%s0undt3ch\fP) [fluorine] Cleanup the singleton instances map.
@ \fI2019\-01\-07 22:03:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
8827193 Merge pull request \fI\%#51084\fP from s0undt3ch/merge\-singleton\-last\-ref\-close\-fluorine
.IP \(bu 2
979fbac Merge branch \(aq2019.2\(aq into merge\-singleton\-last\-ref\-close\-fluorine
.IP \(bu 2
63f051a Merge branch \(aq2019.2\(aq into merge\-singleton\-last\-ref\-close\-fluorine
.IP \(bu 2
bd6c46d Cleanup the singleton instances map.
.UNINDENT
.UNINDENT
.SS Salt 2019.2.2 Release Notes
.sp
Version 2019.2.2 is a bugfix release for \fI\%2019.2.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB26\fP
.IP \(bu 2
Total Issue References: \fB12\fP
.IP \(bu 2
Total PR References: \fB26\fP
.IP \(bu 2
Contributors: \fB13\fP (\fI\%Akm0d\fP, \fI\%Ch3LL\fP, \fI\%Oloremo\fP, \fI\%OrlandoArcapix\fP, \fI\%bryceml\fP, \fI\%dhiltonp\fP, \fI\%dwoz\fP,
\fI\%frogunder\fP, \fI\%garethgreenaway\fP, \fI\%javierbertoli\fP, \fI\%pizzapanther\fP, \fI\%s0undt3ch\fP, \fI\%twangboy\fP)
.UNINDENT
.SS Changelog for v2019.2.1..v2019.2.2
.sp
\fIGenerated at: 2019\-10\-11 20:54:15 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#54919\fP: (\fI\%twangboy\fP) Add missing docs for win_wusa state and module (2019.2.1)
@ \fI2019\-10\-11 18:28:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
7d253bc Merge pull request \fI\%#54919\fP from twangboy/update_docs
.IP \(bu 2
57ff199 Add docs for win_wusa
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#54941\fP: (\fI\%UtahDave\fP) Pillar data is refreshed for EVERY salt command in 2019.2.1 and 2019.2.2 (refs: \fI\%#54942\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54942\fP: (\fI\%dwoz\fP) Fix for 54941 pillar_refresh regression
@ \fI2019\-10\-11 18:27:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
2f817bc Merge pull request \fI\%#54942\fP from dwoz/fix\-54941
.IP \(bu 2
cb5d326 Add a test for 54941 using test.ping
.IP \(bu 2
348d1c4 Add regression tests for issue 54941
.IP \(bu 2
766f3ca Initial commit of a potential fix for 54941
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54897\fP: (\fI\%bryceml\fP) update version numbers to be correct
@ \fI2019\-10\-05 01:59:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
f783108 Merge pull request \fI\%#54897\fP from bryceml/2019.2.1_fix_docs
.IP \(bu 2
e9a2a70 update version numbers to be correct
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54894\fP: (\fI\%bryceml\fP) 2019.2.1 fix docs
@ \fI2019\-10\-04 22:31:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
3233663 Merge pull request \fI\%#54894\fP from bryceml/2019.2.1_fix_docs
.IP \(bu 2
2456aaa Porting PR \fI\%#52948\fP to 2019.2.1
.IP \(bu 2
94a1e3b Porting PR \fI\%#52752\fP to 2019.2.1
.IP \(bu 2
c7b7474 modifying saltconf ads
.IP \(bu 2
d48057b add new saltconf ads
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54858\fP: (\fI\%frogunder\fP) remove in progress from releasenotes 2019.2.2
@ \fI2019\-10\-02 20:42:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
4b06eca Merge pull request \fI\%#54858\fP from frogunder/releasenotes_remove2019.2.2
.IP \(bu 2
a697abd remove in progress from releasenotes 2019.2.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54854\fP: (\fI\%frogunder\fP) releasenotes 2019.2.2
@ \fI2019\-10\-02 18:58:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
aaf2d1c Merge pull request \fI\%#54854\fP from frogunder/release_notes_2019.2.2
.IP \(bu 2
a41dc59 Update 2019.2.2.rst
.IP \(bu 2
9bea043 releasenotes 2019.2.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54852\fP: (\fI\%frogunder\fP) Update man pages for 2019.2.2
@ \fI2019\-10\-02 18:27:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
10d433f Merge pull request \fI\%#54852\fP from frogunder/man_pages_2019.2.2
.IP \(bu 2
92bc4b2 Update man pages for 2019.2.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54845\fP: (\fI\%s0undt3ch\fP) Remove debug print
@ \fI2019\-10\-02 17:38:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
8ca6b20 Merge pull request \fI\%#54845\fP from s0undt3ch/hotfix/event\-return\-fix\-2019.2.1
.IP \(bu 2
3937890 Remove debug print
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#54755\fP: (\fI\%Reiner030\fP) 2019.2.1/2019.2.0 pip failures even when not using pip (refs: \fI\%#54826\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54826\fP: (\fI\%dwoz\fP) Fix issue 54755 and add regression tests
@ \fI2019\-10\-01 20:07:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
9e3914a Merge pull request \fI\%#54826\fP from dwoz/issue_54755
.IP \(bu 2
0bad9cb Handle locals and globals separately
.IP \(bu 2
bcbe9a2 Only purge pip when needed
.IP \(bu 2
d2f98ca Fix issue 54755 and add regression tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54830\fP: (\fI\%frogunder\fP) Add known issues to 2019.2.1 release notes
@ \fI2019\-10\-01 16:23:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
ba569d0 Merge pull request \fI\%#54830\fP from frogunder/update_relasenotes_2019.2.1
.IP \(bu 2
8cdb27b Update 2019.2.1.rst
.IP \(bu 2
14f955c Add known issues to 2019.2.1 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#54521\fP: (\fI\%Oloremo\fP) [Regression] Failhard, batch and retcodes (refs: \fI\%#54806\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54806\fP: (\fI\%Oloremo\fP) [Regression] Batch with failhard fix
@ \fI2019\-10\-01 14:51:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
433b6fa Merge pull request \fI\%#54806\fP from Oloremo/failhard\-batch\-fix\-2019.2.1
.IP \(bu 2
6684793 Merge branch \(aq2019.2.1\(aq into failhard\-batch\-fix\-2019.2.1
.IP \(bu 2
3e0e928 Added tests for cli and runner
.IP \(bu 2
2416516 Made batch work properly with failhard in cli and runner
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#54820\fP: (\fI\%OrangeDog\fP) schedule.present not idempotent when scheduler disabled (refs: \fI\%#54828\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54828\fP: (\fI\%garethgreenaway\fP) [2019.2.1] Fix global disabling code in scheduler
@ \fI2019\-10\-01 09:27:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
ed94aa5 Merge pull request \fI\%#54828\fP from garethgreenaway/54820_fix_schedule_disabled_job_enabled_bug
.IP \(bu 2
be15a28 Rework code that handles individual jobs being disabled and scheduler being globally being disabled.  Previously disabling the schedule would result in individual jobs being disabled when they were run through eval.  This change does not change schedule items.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54778\fP: (\fI\%Akm0d\fP) fix broken salt\-cloud openstack query
@ \fI2019\-10\-01 09:23:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
435b40c Merge pull request \fI\%#54778\fP from Akm0d/master_openstack_query_fix
.IP \(bu 2
ba4ba2a fixed pylint errors in openstack test
.IP \(bu 2
d9a8517 Added openstack tests for openstack \-\-query fix
.IP \(bu 2
59214ad Fallback to image id if we don\(aqt have an image name
.IP \(bu 2
3a42a4d fixed pylint error
.IP \(bu 2
0074d18 created unit tests for openstack
.IP \(bu 2
4255e3e Merge branch \(aq2019.2.1\(aq of \fI\%https://github.com/saltstack/salt\fP into HEAD
.IP \(bu 2
1c2821b Return a configured provider, not a bool
.IP \(bu 2
c585550 fix broken salt\-cloud openstack query
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#54762\fP: (\fI\%margau\fP) 2019.2.1: Breaks Minion\-Master Communication (refs: \fI\%#54823\fP, \fI\%#54784\fP, \fI\%#54807\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54823\fP: (\fI\%dhiltonp\fP) ip_bracket can now accept ipv6 addresses with brackets
@ \fI2019\-10\-01 01:13:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
93b1c4d Merge pull request \fI\%#54823\fP from dhiltonp/maybe\-bracket
.IP \(bu 2
faa1d98 ip_bracket can now accept ipv6 addresses with brackets
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#54762\fP: (\fI\%margau\fP) 2019.2.1: Breaks Minion\-Master Communication (refs: \fI\%#54823\fP, \fI\%#54784\fP, \fI\%#54807\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54807\fP: (\fI\%dwoz\fP) Fix pip state pip >=10.0 and <=18.0
@ \fI2019\-09\-30 09:20:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#54772\fP: (\fI\%OrlandoArcapix\fP) Fix import of pip modules (refs: \fI\%#54807\fP)
.IP \(bu 2
b61b30d Merge pull request \fI\%#54807\fP from dwoz/patch\-2
.IP \(bu 2
664806b Add unit test for pip state fix
.IP \(bu 2
e637658 Revert change to pip version query
.IP \(bu 2
42810a2 Fix import of pip modules
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#54741\fP: (\fI\%kjkeane\fP) Schedulers Fail to Run (refs: \fI\%#54799\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54799\fP: (\fI\%garethgreenaway\fP) Fix to scheduler when job without a time element is run with schedule.run_job
@ \fI2019\-09\-30 00:19:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ee1ff6 Merge pull request \fI\%#54799\fP from garethgreenaway/54741_run_job_fails_without_time_element
.IP \(bu 2
44caa81 Merge branch \(aq54741_run_job_fails_without_time_element\(aq of github.com:garethgreenaway/salt into 54741_run_job_fails_without_time_element
.INDENT 2.0
.IP \(bu 2
3ae4f75 Merge branch \(aq2019.2.1\(aq into 54741_run_job_fails_without_time_element
.UNINDENT
.IP \(bu 2
8afd2d8 Removing extra, unnecessary code.
.IP \(bu 2
549cfb8 Fixing test_run_job test to ensure the right data is being asserted.  Updating unit/test_module_names.py to include integration.scheduler.test_run_job.
.IP \(bu 2
7d716d6 Fixing lint.
.IP \(bu 2
ec68591 If a scheduled job does not contains a time element parameter then running that job with schedule.run_job fails with a traceback because data[\(aqrun\(aq] does not exist.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54785\fP: (\fI\%Ch3LL\fP) Fix state.show_states when sls file missing in top file
@ \fI2019\-09\-30 00:00:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
b90c3f2 Merge pull request \fI\%#54785\fP from Ch3LL/fix_show_states
.IP \(bu 2
96540be Clean up files after state.show_states test
.IP \(bu 2
ad265ae Fix state.show_states when sls file missing
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#54768\fP: (\fI\%paul\-palmer\fP) 2019.2.1 Some Jinja imports not found (refs: \fI\%#54780\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#54765\fP: (\fI\%awerner\fP) 2019.2.1: Jinja from import broken (refs: \fI\%#54780\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54780\fP: (\fI\%dwoz\fP) Fix masterless jinja imports
@ \fI2019\-09\-29 22:12:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
b9459e6 Merge pull request \fI\%#54780\fP from dwoz/fix\-masterless\-jinja\-imports
.IP \(bu 2
5d873cc Merge branch \(aq2019.2.1\(aq into fix\-masterless\-jinja\-imports
.IP \(bu 2
e901a83 Add regression tests for jinja import bug
.IP \(bu 2
3925bb7 Fix broken jinja imports in masterless salt\-call
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#54776\fP: (\fI\%javierbertoli\fP) Setting \fIping_interval\fP in salt\-minion\(aqs config (version 2019.2.1) prevents it from starting (refs: \fI\%#54777\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54777\fP: (\fI\%javierbertoli\fP) Fix minion\(aqs remove_periodic_callback()
@ \fI2019\-09\-29 21:33:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
4c240e5 Merge pull request \fI\%#54777\fP from netmanagers/2019.2.1
.IP \(bu 2
459c790 Merge branch \(aq2019.2.1\(aq into 2019.2.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54805\fP: (\fI\%bryceml\fP) improve lint job
@ \fI2019\-09\-29 21:24:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
83f8f5c Merge pull request \fI\%#54805\fP from bryceml/2019.2.1_update_lint_salt
.IP \(bu 2
ffa4ed6 improve lint job
.IP \(bu 2
fa1a767 Merge branch \(aq2019.2.1\(aq into 2019.2.1
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#54751\fP: (\fI\%jnmatlock\fP) NXOS_API Proxy Minions Error KeyError: \(aqproxy.post_master_init\(aq after upgrading to 2019.2.1 (refs: \fI\%#54783\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54783\fP: (\fI\%garethgreenaway\fP) Ensure metaproxy directory is included in sdist
@ \fI2019\-09\-29 02:17:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b43fbe Merge pull request \fI\%#54783\fP from garethgreenaway/54751_fixing_missing_metaproxy_directory
.IP \(bu 2
67d9938 Merge branch \(aq2019.2.1\(aq into 54751_fixing_missing_metaproxy_directory
.IP \(bu 2
a35e609 Adding __init__.py to metaproxy directory so that metaproxy is included when running setup.py.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#54762\fP: (\fI\%margau\fP) 2019.2.1: Breaks Minion\-Master Communication (refs: \fI\%#54823\fP, \fI\%#54784\fP, \fI\%#54807\fP)
.IP \(bu 2
\fBPR\fP \fI\%#54784\fP: (\fI\%dhiltonp\fP) fix dns_check to return uri\-compatible ipv6 addresses, add tests
@ \fI2019\-09\-28 08:36:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
7912b67 Merge pull request \fI\%#54784\fP from dhiltonp/ipv46
.IP \(bu 2
042a101 Merge branch \(aq2019.2.1\(aq into ipv46
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54779\fP: (\fI\%frogunder\fP) Add 2019.2.2 release notes
@ \fI2019\-09\-27 17:45:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
2f94b44 Merge pull request \fI\%#54779\fP from frogunder/releasenotes_2019.2.2
.IP \(bu 2
67f564b Add 2019.2.2 release notes
.IP \(bu 2
ac6b54f Merge branch \(aq2019.2.1\(aq into ipv46
.IP \(bu 2
93ebd09 update mock (py2) from 2.0.0 to 3.0.5
.IP \(bu 2
37bcc4c fix dns_check to return uri\-compatible ipv6 addresses, add tests
.INDENT 2.0
.IP \(bu 2
dd86c46 Merge pull request \fI\%#1\fP from waynew/pull/54777\-callback\-typo
.INDENT 2.0
.IP \(bu 2
a57f7d0 Add tests
.UNINDENT
.IP \(bu 2
c19d0b0 Fix minion\(aqs remove_periodic_callback()
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54731\fP: (\fI\%pizzapanther\fP) Fix returners not loading properly
@ \fI2019\-09\-26 17:24:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
46bec3c Merge pull request \fI\%#54731\fP from pizzapanther/not\-so\-__new__\-and\-shiny
.IP \(bu 2
bdf24f4 Make sure we tests salt\-master\(aqs \fIevent_return\fP setting
.IP \(bu 2
5499518 remove unnecessary import
.IP \(bu 2
3f8a382 fix module import
.IP \(bu 2
0746aa7 remove __new__ method since it was removed from parent class
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#54706\fP: (\fI\%bryceml\fP) 2019.2.1 ruby
@ \fI2019\-09\-23 16:00:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
e2b86bf Merge pull request \fI\%#54706\fP from bryceml/2019.2.1_ruby
.IP \(bu 2
168a6c1 switch to ruby 2.6.3
.UNINDENT
.UNINDENT
.SS Salt 2019.2.3 Release Notes
.sp
Version 2019.2.3 is a CVE\-fix release for \fI\%2019.2.0\fP\&.
.SS Security Fix
.sp
\fBCVE\-2019\-17361\fP
.sp
With the Salt NetAPI enabled in addition to having a SSH roster defined,
unauthenticated access is possible when specifying the client as SSH.
Additionally, when the raw_shell option is specified any arbitrary command
may be run on the Salt master when specifying SSH options.
.SS Salt 2019.2.4 Release Notes
.sp
Version 2019.2.4 is a CVE\-fix release for \fI\%2019.2.0\fP\&.
.SS Security Fix
.sp
\fBCVE\-2020\-11651\fP
.sp
An issue was discovered in SaltStack Salt before 2019.2.4 and 3000 before 3000.2.
The salt\-master process ClearFuncs class does not properly validate
method calls. This allows a remote user to access some methods without
authentication. These methods can be used to retrieve user tokens from
the salt master and/or run arbitrary commands on salt minions.
.sp
\fBCVE\-2020\-11652\fP
.sp
An issue was discovered in SaltStack Salt before 2019.2.4 and 3000 before 3000.2.
The salt\-master process ClearFuncs class allows access to some methods
that improperly sanitize paths. These methods allow arbitrary
directory access to authenticated users.
.SS Known Issue
.sp
Part of the fix for CVE\-2020\-11651 added better validation of the methods allowed to be called by remote clients.
Both AESFuncs and ClearFuncs now have an explicit list of methods that can be called.
The name of one of these whitlisted methods on AESFuncs had a typo.
The _minion_runner method should be minion_runner (without the underscore prefix).
This typo breaks the publish module’s runner method.
Calling runners, for example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt minion publish.runner manage.down
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Will not work, and you will receive and empty reply from the salt master.
.sp
This will be addressed in the 3001 release of Salt set for mid\-June 2020.
.SS Salt 2019.2.5 Release Notes
.sp
Version 2019.2.5 is a bug\-fix release for \fI\%2019.2.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB2\fP
.IP \(bu 2
Total Issue References: \fB2\fP
.IP \(bu 2
Total PR References: \fB2\fP
.IP \(bu 2
Contributors: \fB2\fP (\fI\%dwoz\fP, \fI\%frogunder\fP)
.UNINDENT
.SS Changelog for v2019.2.4..v2019.2.5
.sp
\fIGenerated at: 2020\-05\-05 22:43:12 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#57096\fP: (\fI\%frogunder\fP) Update man_pages 2019.2.5
@ \fI2020\-05\-05 22:10:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
6877b7259a Merge pull request \fI\%#57096\fP from frogunder/man_pages_2019.2.5
.IP \(bu 2
58ea351a59 Update man_pages 2019.2.5
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#57027\fP: (\fI\%ecarson\fP) [BUG] Master running 2019.2.4 or 3000.2 unable to synchronize files using saltutil.sync_all to 2017.7.1 minion due to CVE fix (refs: \fI\%#57090\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#57016\fP: (\fI\%idontwanttosignin\fP) [BUG] Requested method not exposed: minion_runner (refs: \fI\%#57090\fP)
.IP \(bu 2
\fBPR\fP \fI\%#57090\fP: (\fI\%dwoz\fP) Address Issues in CVE Release
@ \fI2020\-05\-05 22:09:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
8fe0f66f94 Merge pull request \fI\%#57090\fP from dwoz/bugs_n_stuff
.IP \(bu 2
f3e8590bac Describe SEPs
.IP \(bu 2
aa1a9d340d Update hardening doc to mention 4505/4506
.IP \(bu 2
ca303f7c0c Add link to salt\-announce to documentation
.IP \(bu 2
c63253ef9c Address issues in cve release
.UNINDENT
.UNINDENT
.SS Salt 2019.2.6 Release Notes
.sp
Version 2019.2.6 is a CVE fix release for \fI\%2019.2.0\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Prevent shell injections in netapi ssh client (cve\-2020\-16846)
.IP \(bu 2
Prevent creating world readable private keys with the tls execution module. (cve\-2020\-17490)
.UNINDENT
.SS Salt 2019.2.7 Release Notes
.sp
Version 2019.2.7 is a CVE fix release for \fI\%2019.2.0\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Properly validate eauth credentials and tokens along with their ACLs.
Prior to this change eauth was not properly validated when calling
Salt ssh via the salt\-api. Any value for \(aqeauth\(aq or \(aqtoken\(aq would allow a user
to bypass authentication and make calls to Salt ssh. (CVE\-2020\-25592)
.UNINDENT
.SS Salt 2019.2.8 Release Notes
.sp
Version 2019.2.8 is a bugfix release for \fI\%2019.2.0\fP\&.
.SS Fixed
.INDENT 0.0
.IP \(bu 2
Fixes salt\-ssh authentication when using tty (#58922)
.UNINDENT
.SS Salt 2018.3.0 Release Notes \- Codename Oxygen
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
If you are using Jinja to dump lists or dictionaries in your SLS files,
this will now cause errors in Python 2 since Jinja does not produce
YAML\-compatible output when strings in the data structures contain unicode
types. The dictionary must be passed through a Jinja filter to produce
YAML\-compatible strings.
.sp
The below is an example of invalid SLS:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.mangaged:
    \- source: salt://foo.conf
    \- template: jinja
    \- defaults: {{ mydict }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To make it valid, use either one of Salt\(aqs own \fBjson\fP or \fByaml\fP
filters:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.mangaged:
    \- source: salt://foo.conf
    \- template: jinja
    \- defaults: {{ mydict | json }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Unicode/Python 3 Compatibility Improvements
.sp
This release fixes a number of nagging issues with Unicode strings in Salt
under Python 2 (ex.  \fB\(aqascii\(aq codec can\(aqt decode byte 0xd0\fP). For best
results, use a UTF\-8 locale (such as by setting the \fBLANG\fP environment
variable to one which supports UTF\-8. For example \fBen_US.UTF\-8\fP,
\fBde_DE.UTF\-8\fP, \fBru_RU.UTF\-8\fP, \fBC.UTF\-8\fP).
.sp
Additionally, a number of Python 3 compatibility fixes have been made, many of
them having to do with file I/O and str/bytes mismatches.
.sp
We continue to work toward improving both Unicode and Python 3 compatibility
and welcome any feedback.
.SS Lots of Docker Improvements
.SS Much Improved Support for Docker Networking
.sp
The \fI\%docker_network.present\fP
state has undergone a full rewrite, which includes the following improvements:
.SS Full API Support for Network Management
.sp
The improvements made to input handling in the
\fI\%docker_container.running\fP
state for 2017.7.0 have now been expanded to \fI\%docker_network.present\fP\&. This brings with it full support for all
tunable configuration arguments.
.SS Custom Subnets
.sp
Custom subnets can now be configured. Both IPv4 and mixed IPv4/IPv6 networks
are supported. See \fI\%here\fP for
more information.
.SS Network Configuration in \fI\%docker_container.running\fP States
.sp
A long\-requested feature has finally been added! It is now possible to
configure static IPv4/IPv6 addresses, as well as links and labels. See
\fI\%here\fP for more
information.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
While the \fBcontainers\fP argument to \fI\%docker_network.present\fP will continue to be supported, it
will no longer be the recommended way of ensuring that a container is
attached to a network.
.UNINDENT
.UNINDENT
.SS Improved Handling of Images from Custom Registries
.sp
Rather than attempting to parse the tag from the passed image name, Salt will
now resolve that tag down to an image ID and use that ID instead.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
Due to this change, there are some backward\-incompatible changes to image
management. See below for a full list of these changes.
.UNINDENT
.UNINDENT
.SS Backward\-incompatible Changes to Docker Image Management
.sp
Passing image names to the following functions must now be done using separate
\fBrepository\fP and \fBtag\fP arguments:
.INDENT 0.0
.IP \(bu 2
\fI\%docker.build\fP
.IP \(bu 2
\fI\%docker.commit\fP
.IP \(bu 2
\fI\%docker.import\fP
.IP \(bu 2
\fI\%docker.load\fP
.IP \(bu 2
\fI\%docker.tag\fP
.IP \(bu 2
\fI\%docker.sls_build\fP
.UNINDENT
.sp
Additionally, the \fBtag\fP argument must now be explicitly passed to the
\fI\%docker_image.present\fP state,
unless the image is being pulled from a docker registry.
.SS State and Execution Module Support for \fBdocker run\fP Functionality
.sp
The \fI\%docker_container.running\fP
state is good for containers which run services, but it is not as useful for
cases in which the container only needs to run once. The \fBstart\fP argument to
\fI\%docker_container.running\fP can
be set to \fBFalse\fP to prevent the container from being started again on a
subsequent run, but for many use cases this is not sufficient. Therefore, the
\fI\%docker.run_container\fP
remote\-execution function was added. When used on the Salt CLI, it will return
information about the container, such as its name, ID, exit code, and any
output it produces.
.sp
State support has also been added via the \fI\%docker_container.run\fP state. This state is modeled after the
\fI\%cmd.run\fP state, and includes arguments like
\fBonlyif\fP, \fBunless\fP, and \fBcreates\fP to control whether or not the container
is run.
.SS Full API Support for \fI\%docker.logs\fP
.sp
This function now supports all of the functions that its Docker API counterpart
does, allowing you to do things like include timestamps, and also suppress
stdout/stderr, etc. in the return.
.SS \fIstart\fP Argument Added to \fI\%docker.create\fP Function
.sp
This removes the need to run \fI\%docker.start\fP separately when creating containers on the
Salt CLI.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt myminion docker.create image=foo/bar:baz command=/path/to/command start=True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Use SaltSSH Minions like regular Master\-Minions
.sp
The Master process can now also call SSH minions as if they were connected to
the master using ZeroMQ.  By setting \fBenable_ssh_minions: True\fP in the master
config file, the master will create a Salt SSH client process which connects to
the minion and returns the output for the \fBsalt\fP CLI to use like a regular
minion. This can be used anywhere the LocalClient is used.
.SS Exceptions Raised for Authentication/Authorization Errors
.sp
When sending \fBpublish\fP commands via \fBmaster.py\fP and \fBmasterapi.py\fP and an
authorization or authentication problem is encountered, Salt will now raise the
appropriate exceptions instead of returning an empty string: \fB\(aq\(aq\fP\&.
.sp
The reasoning behind this change is to make it easier to debug various scenarios
surrounding authentication and authorization issues more effectively.
.SS Comparison Operators in Package Installation
.sp
Salt now supports using comparison operators (e.g. \fB>=1.2.3\fP) when installing
packages on minions which use \fI\%yum/dnf\fP or
\fI\%apt\fP\&. This is supported both in the
\fI\%pkg.installed\fP state and in the \fBpkg.install\fP
remote execution function.
.SS \fI\%Master Tops\fP Changes
.sp
When both \fI\%Master Tops\fP and a
\fI\%Top File\fP produce SLS matches for a given minion, the matches
were being merged in an unpredictable manner which did not preserve ordering. This has
been changed. The top file matches now execute in the expected order, followed
by any master tops matches that are not matched via a top file.
.sp
To make master tops matches execute first, followed by top file matches, set
the new \fI\%master_tops_first\fP minion config option to \fBTrue\fP\&.
.SS Several Jinja Filters Renamed
.sp
The following Jinja filters (originally added in 2017.7.0) have been renamed
due to the fact that they were inaccurately named when initially added. The
original names will be supported until the 3000 release of Salt.
.INDENT 0.0
.IP \(bu 2
\fBrand_str\fP renamed to \fI\%random_hash\fP
.IP \(bu 2
\fBjinja_decode_dict\fP renamed to \fBjinja_encode_dict\fP
.IP \(bu 2
\fBjinja_decode_list\fP renamed to \fBjinja_encode_list\fP
.UNINDENT
.SS Return Codes for Runner/Wheel Functions
.sp
When using \fI\%orchestration\fP, runner and wheel
functions used to report a \fBTrue\fP result if the function ran to completion
without raising an exception. It is now possible to set a return code in the
\fB__context__\fP dictionary, allowing runner and wheel functions to report that
they failed. Here\(aqs some example pseudocode:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def myrunner():
    ...
    # do stuff
    ...
    if some_error_condition:
        __context__[\(dqretcode\(dq] = 1
    return result
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Variable Update Intervals for Fileserver Backends
.sp
Prior to this release, fileservers would be updated as part of a dedicated
\(dqmaintenance\(dq process, in which various routine maintenance tasks were
performed. This tied the update interval to the \fI\%loop_interval\fP
config option, and also forced all fileservers to update at the same interval.
.sp
2018.3.0 adds the following configuration options for the various fileserver
backends:
.INDENT 0.0
.IP \(bu 2
\fI\%roots_update_interval\fP
.IP \(bu 2
\fBazurefs_update_interval\fP
.IP \(bu 2
\fI\%gitfs_update_interval\fP
.IP \(bu 2
\fI\%hgfs_update_interval\fP
.IP \(bu 2
\fI\%minionfs_update_interval\fP
.IP \(bu 2
\fI\%s3fs_update_interval\fP
.IP \(bu 2
\fI\%svnfs_update_interval\fP
.UNINDENT
.sp
These allow for update intervals to be set for each individual backend. The
default value for each of these is 60 seconds.
.sp
In addition, for \fI\%GitFS\fP it is also possible to apply
intervals to individual remotes. See \fI\%here\fP for
examples.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
git_pillar does not yet support variable update intervals, this is targeted
for the next feature release (2019.2.0).
.UNINDENT
.UNINDENT
.SS LDAP via External Authentication Changes
.sp
In this release of Salt, if LDAP Bind Credentials are supplied, then
these credentials will be used for all LDAP access except the first
authentication when a job is submitted.  The first authentication will
use the user\(aqs credentials as passed on the CLI.  This behavior is to
accommodate certain two\-factor authentication schemes where the authentication
token can only be used once.
.sp
In previous releases the bind credentials would only be used to determine
the LDAP user\(aqs existence and group membership.  The user\(aqs LDAP credentials
were used from then on.
.SS Stormpath External Authentication Removed
.sp
Per Stormpath\(aqs announcement, their API will be shutting down on 8/17/2017 at
noon PST so the Stormpath external authentication module has been removed.
.sp
\fI\%https://stormpath.com/oktaplusstormpath\fP
.SS New (Proxy) Minion Configuration Options
.sp
To be able to connect the Minion to the Master using a certain source IP address
or port, the following options have been added:
.INDENT 0.0
.IP \(bu 2
\fI\%source_interface_name\fP
.IP \(bu 2
\fI\%source_address\fP
.IP \(bu 2
\fI\%source_ret_port\fP
.IP \(bu 2
\fI\%source_publish_port\fP
.UNINDENT
.SS \fI\%environment\fP config option renamed to \fI\%saltenv\fP
.sp
The \fI\%environment\fP config option predates referring to a salt
fileserver environment as a \fBsaltenv\fP\&. To pin a minion to a single
environment for running states, one would use \fI\%environment\fP, but
overriding that environment would be done with the \fBsaltenv\fP argument. For
consistency, \fI\%environment\fP is now simply referred to as
\fI\%saltenv\fP\&. There are no plans to deprecate or remove
\fI\%environment\fP, if used it will log a warning and its value will be
used as \fI\%saltenv\fP\&.
.SS \fI\%lock_saltenv\fP config option added
.sp
If set to \fBTrue\fP, this option will prevent a minion from allowing the
\fBsaltenv\fP argument to override the value set in \fI\%saltenv\fP when
running states.
.SS Failed Minions for State/Function Orchestration Jobs Added to Changes Dictionary
.sp
For orchestration jobs which run states (or run remote execution functions and
also use a \fI\%fail function\fP to indicate
success or failure), minions which have \fBFalse\fP results were previously
included as a formatted string in the comment field of the return for that
orchestration job. This made the failed returns difficult to \fI\%parse
programatically\fP\&. The
failed returns in these cases are now included in the changes dictionary,
making for much easier parsing.
.SS Grains
.INDENT 0.0
.IP \(bu 2
\fBfc_wwn\fP \- Show all fibre channel world wide port names for a host, must be
enabled with \fIfibre_channel_grains\fP
.IP \(bu 2
\fBiscsi_iqn\fP \- Show the iSCSI IQN name for a host
.IP \(bu 2
\fBswap_total\fP \- Show the configured swap_total for Linux, *BSD, OS X and
Solaris/SunOS
.IP \(bu 2
\fBvirtual\fP:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
identifies reports KVM and VMM hypervisors when running an OpenBSD guest
.IP \(bu 2
for detecting Solaris Logical Domains (LDOMs) running on T\-Series SPARC
hardware. The \fBvirtual_subtype\fP grain is populated as a list of domain
roles.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Salt Minion Auto\-discovery
.sp
Using auto\-discovery, the Salt Minion now no longer needs to be configured
against a specific DNS name or IP address of a Master.
.sp
For this feature Salt Master now requires port 4520 for UDP broadcast packets to be opened
and the Salt Minion be able to send UDP packets to the same port.
.SS Configuration
.sp
By default, automatic discovery is disabled.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Due to the current limitations that will be changing in a future release,
before you turn on auto\-discovery, make sure your network is secured and
trusted.
.UNINDENT
.UNINDENT
.sp
Auto\-discovery is configured on Master and Minion. Both of them are configured via the \fBdiscovery\fP option
as follows:
.sp
\fBMaster configuration\fP
.sp
To use the default configuration, which accepts any minion, simply set \fBdiscovery\fP to True:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
discovery: true
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A sub\-option called \fImapping\fP allows auto\-discovery to help find the proper
Master. The mapping contains an arbitrary set of key/value pairs, which the
Minion configuration can target. By default, no mappings are set.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
discovery:
  mapping:
    description: SES 5.0
    node: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is also possible to change the port used from the default of \fB4520\fP, by
setting a \fBport\fP option under the Master\(aqs \fBdiscovery\fP configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
discovery:
  port: 4567
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When using a port number other than the default, the Minion\(aqs \fBdiscovery\fP
configuration must \fIalso\fP have a port specified, otherwise the Minion will
still attempt to contact the Master on port \fB4520\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBMinion configuration\fP
.sp
In addition to the \fBmapping\fP and \fBport\fP options, the following additional options are available to Minions:
.INDENT 0.0
.IP \(bu 2
\fBattempts\fP \- This option specifies how many broadcast requests should be
sent to the network, waiting for any Master response. Each attempt takes a
couple of seconds, so raising this value may result in a slower Minion
startup. Note that, on a properly\-configured network, autodiscovery should
succeed on the first attempt. By default, this value is set to \fB3\fP\&.
.IP \(bu 2
\fBmatch\fP \- This option can be set to either \fBall\fP or \fBany\fP, and it
determines how the values configured in \fBmapping\fP are matched. If set to
\fBall\fP, then all of the key/value pairs in the Minion\(aqs \fBmapping\fP must
match a given Master. If set to \fBany\fP (the default), then any match to a
key/value mapping will constitute a match.
.IP \(bu 2
\fBpause\fP \- The interval in seconds between attempts (default: 5).
.IP \(bu 2
\fBfibre_channel_grains\fP \- Enables the \fBfc_wwn\fP grain. (Default: False)
.IP \(bu 2
\fBiscsi_grains\fP \- Enables the \fBiscsi_iqn\fP grain. (Default: False)
.UNINDENT
.SS Connection to a type instead of DNS
.sp
By now each Minion was connecting to a Master by DNS or IP address. From now on
it is possible also to connect to a _type_ of a Master. For example, in a
network there are three different Masters, each corresponds for a particular
niche or environment or specific role etc. The Minion is supposed to connect
only to one of those Masters that is described appropriately.
.sp
To achieve such an effect, each \fB/etc/salt/master\fP configuration should have
a \fBdiscovery\fP option, which should have a \fBmapping\fP element with arbitrary
key/value pairs. The same configuration should be on the Minion, so then when
mapping matches, Minion recognises Master as its connection target.
.sp
Example for Master configuration (\fB/etc/salt/master\fP):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
discovery:
  mapping:
    description: SES 5.0
    node: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The example above describes a system that is running a particular product,
where \fBdescription\fP is an arbitrary key and \fBSES 5.0\fP is just a string. In
order to match exactly this Master, the following configuration at Minion
should be present:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
discovery:
  match: all  # Can be \(dqall\(dq or \(dqany\(dq
  mapping:
    description: SES 5.0
    node: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Notice \fBmatch\fP criteria is set to \fBall\fP\&. This would mean that from all
found Masters select only that, which \fBdescription\fP is set to \fBSES 5.0\fP
_and_ \fBnode\fP is set to \fB1\fP\&. All other Masters will be ignored.
.SS Limitations
.sp
This feature has a couple of _temporary_ limitations that are subject to change
in the future:
.INDENT 0.0
.IP \(bu 2
Only one Master on the network is supported. Currently the Minion cannot
select which Master out of few the same to choose. This will change to
choosing the Master that is least loaded.
.IP \(bu 2
Minions will accept _any_ master that matches connection criteria without any
particular security applied (priv/pub key check, signature, fingerprint etc).
That implies that administrator is expected to know his network and make sure
it is clean.
.UNINDENT
.SS New Modules
.INDENT 0.0
.IP \(bu 2
\fI\%salt.modules.purefa\fP
.UNINDENT
.SS New NaCl Renderer
.sp
A new renderer has been added for encrypted data.
.SS New support for Cisco UCS Chassis
.sp
The salt proxy minion now allows for control of Cisco USC chassis. See
the \fBcimc\fP modules for details.
.SS New support for Cassandra v3
.sp
The \fBcassandra_cql\fP module now supports Cassandra v3 which has changed
its internal schema to define keyspaces and columns.
.SS New salt\-ssh roster
.sp
A new roster has been added that allows users to pull in a list of hosts
for salt\-ssh targeting from a \fB~/.ssh\fP configuration. For full details,
please see the \fBsshconfig\fP roster.
.SS New GitFS Features
.sp
Two new features which affect how GitFS maps branches/tags to fileserver
environments (i.e. \fBsaltenvs\fP) have been added:
.INDENT 0.0
.IP 1. 3
It is now possible to completely turn off Salt\(aqs default mapping logic
(aside from the mapping of the \fBbase\fP saltenv). This can be triggered
using the new \fI\%gitfs_disable_saltenv_mapping\fP config option.
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
When this is disabled, only the \fBbase\fP saltenv and any configured
using \fI\%per\-saltenv configuration parameters\fP will be available.
.UNINDENT
.UNINDENT
.IP 2. 3
The types of refs which Salt will use as saltenvs can now be controlled. In
previous releases, branches and tags were both mapped as environments, and
individual commit SHAs could be specified as saltenvs in states (and when
caching files using \fI\%cp.cache_file\fP).
Using the new \fI\%gitfs_ref_types\fP config option, the types of
refs which are used as saltenvs can be restricted. This makes it possible to
ignore all tags and use branches only, and also to keep SHAs from being made
available as saltenvs.
.UNINDENT
.SS Additional output modes
.sp
The \fBstate_output\fP parameter now supports \fBfull_id\fP, \fBchanges_id\fP and
\fBterse_id\fP\&.  Just like \fBmixed_id\fP, these use the state ID as name in the
highstate output.  For more information on these output modes, see the docs for
the \fI\%Highstate Outputter\fP\&.
.SS Windows
.SS Python Version
.sp
Python 2 Windows API was design when Windows did not support Unicode. Windows
now supports Unicode however to keep backwards compatibility Python 2 Windows
API has not been changed.  Python 3 Windows API supports Unicode. Salt Python 3
installer is the recommend choice for users who need characters other than
Non\-ASCII (7bit) characters.
.SS \fI\%pkg\fP Execution module changes
.sp
Significant changes have been made to the \fI\%win_pkg\fP
execution module. Users should test this release against their existing package
sls definition files. These changes are also in 2016.11.9 & 2017.7.3.
.INDENT 0.0
.IP \(bu 2
\fBpkg.list_available\fP no longer defaults to refreshing the winrepo meta
database.
.IP \(bu 2
\fBpkg.install\fP without a \fBversion\fP parameter no longer upgrades software
if the software is already installed. Use \fBpkg.install version=latest\fP or
in a state use \fBpkg.latest\fP to get the old behavior.
.IP \(bu 2
\fBpkg.list_pkgs\fP now returns multiple versions if software installed more
than once.
.IP \(bu 2
\fBpkg.list_pkgs\fP now returns \(aqNot Found\(aq when the version is not found
instead of \(aq(value not set)\(aq which matches the contents of the sls
definitions.
.IP \(bu 2
\fBpkg.remove()\fP will wait up to 3 seconds (normally about a second) to detect
changes in the registry after removing software, improving reporting of
version changes.
.IP \(bu 2
\fBpkg.remove()\fP can remove \fBlatest\fP software, if \fBlatest\fP is defined in
sls definition.
.IP \(bu 2
Documentation was update for the execution module to match the style in new
versions, some corrections as well.
.IP \(bu 2
All install/remove commands are prefix with cmd.exe shell and cmdmod is
called with a command line string instead of a list. Some sls files in
saltstack/salt\-winrepo\-ng expected the commands to be prefixed with cmd.exe
(i.e. the use of \fB&\fP).
.IP \(bu 2
Some execution module functions results, now behavour more like their
Unix/Linux versions.
.UNINDENT
.SS Installer
.SS Changes to config handling
.sp
Behavior with existing configuration has changed. With previous windows
installers the existing config was used and the master and minion id could be
modified via the installer. It was problematic in that it didn\(aqt account for
configuration that may be defined in the \fBminion.d\fP directory. This change
gives you the option via a drop\-down list to use one of the following:
.INDENT 0.0
.IP \(bu 2
Default Config: Use the config that comes with the installer
.IP \(bu 2
Existing Config: Use the current config without changes
.IP \(bu 2
Custom Config: Select a custom config using the file picker
.UNINDENT
.sp
The existing config option will only be available if the installer detects an
existing config. If there is an existing config, and you choose \fBDefault\fP or
\fBCustom\fP, the existing config will be deleted, including the \fBminion.d\fP
directory, and replaced by your selection.
.sp
The \fBDefault Config\fP and \fBCustom Config\fP options will allow you to modify
the Master and the Minion ID. \fBExisting Config\fP will leave the existing
configuration unchanged.
.sp
These settings can be defined on the command line using the following switches:
.INDENT 0.0
.IP \(bu 2
\fB/default\-config\fP
.IP \(bu 2
\fB/custom\-config=C:\ePath\eTo\eCustom\eConfig\eminion\fP
.UNINDENT
.sp
If neither option is passed and there is an existing config, the default is to
use the existing config. If there is no existing config (new install) the
default config will be used.
.SS Multi\-master configuration
.sp
The installer now has the ability to apply a multi\-master configuration either
from the GUI or the command line. The \fBmaster\fP field in the GUI can accept
either a single master or a comma\-separated list of masters. The command\-line
switch (\fB/master=\fP) can accept the same.
.SS Command\-line help
.sp
The Windows installer will now display command\-line help when a help switch
(\fB/?\fP) is passed.
.SS New utils module \fBsalt.utils.pkg.win\fP
.sp
A new utils module has been added, which gathers information about windows
installed software. This is currently not used by any salt execution module or
state at this time. Users are encouraged to run this and report any issues.
Running the command with the \fBdetail\fP option will be useful for anyone
developing windows package definitions.  With salt installed in the default
location the following command will print the help message.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
chcp 65001
c:\esalt\ebin\epython.exe c:\esalt\ebin\elib\esite\-packages\esalt\eutils\epkg\ewin.py
c:\esalt\ebin\epython.exe c:\esalt\ebin\elib\esite\-packages\esalt\eutils\epkg\ewin.py detail system
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Salt Cloud Features
.SS OpenStack Revamp
.sp
The OpenStack Driver has been rewritten mostly from scratch.  Salt is now using
the \fIshade driver <https://docs.openstack.org/shade/latest/>\fP\&.
.sp
With this, the \fBnova\fP driver is being deprecated.
.sp
\fI\%openstack driver\fP
.sp
There have also been several new modules and states added for managing OpenStack
setups using shade as well.
.sp
\fI\%keystone\fP
\fI\%keystone role grant\fP
\fI\%keystone group\fP
\fI\%keystone role\fP
\fI\%keystone service\fP
\fI\%keystone user\fP
\fI\%keystone domain\fP
\fI\%keystone project\fP
\fI\%keystone endpoint\fP
\fI\%glance\fP
\fI\%glance_image\fP
\fI\%neutron\fP
\fI\%neutron subnet\fP
\fI\%neutron secgroup\fP
\fI\%neutron secgroup rule\fP
\fI\%neutron network\fP
.SS Pre\-Flight Commands
.sp
Support has been added for specified \(dqpreflight commands\(dq to run on a VM before
the deploy script is run. These must be defined as a list in a cloud configuration
file. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-cloud\-profile:
  provider: linode\-config
  image: Ubuntu 16.04 LTS
  size: Linode 2048
  preflight_cmds:
    \- whoami
    \- echo \(aqhello world!\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
These commands will run in sequence \fBbefore\fP the bootstrap script is executed.
.SS New salt\-cloud Grains
.sp
When salt\-cloud creates a new minion, it will now add grain information
to the minion configuration file, identifying the resources originally used
to create it.
.sp
The generated grain information will appear similar to:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grains:
  salt\-cloud:
    driver: ec2
    provider: my_ec2:ec2
    profile: ec2\-web
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The generation of salt\-cloud grains can be suppressed by the
option \fBenable_cloud_grains: \(aqFalse\(aq\fP in the cloud configuration file.
.SS Upgraded Saltify Driver
.sp
The salt\-cloud Saltify driver is used to provision machines which
are not controlled by a dedicated cloud supervisor (such as typical hardware
machines) by pushing a salt\-bootstrap command to them and accepting them on
the salt master. Creation of a node has been its only function and no other
salt\-cloud commands were implemented.
.sp
With this upgrade, it can use the salt\-api to provide advanced control,
such as rebooting a machine, querying it along with conventional cloud minions,
and, ultimately, disconnecting it from its master.
.sp
After disconnection from (\(dqdestroying\(dq on) one master, a machine can be
re\-purposed by connecting to (\(dqcreating\(dq on) a subsequent master.
.SS New Vagrant Driver
.sp
The salt\-cloud Vagrant driver brings virtual machines running in a limited
environment, such as a programmer\(aqs workstation, under salt\-cloud control.
This can be useful for experimentation, instruction, or testing salt configurations.
.sp
Using salt\-api on the master, and a salt\-minion running on the host computer,
the Vagrant driver can create (\fBvagrant up\fP), restart (\fBvagrant reload\fP),
and destroy (\fBvagrant destroy\fP) VMs, as controlled by salt\-cloud profiles
which designate a \fBVagrantfile\fP on the host machine.
.sp
The master can be a very limited machine, such as a Raspberry Pi, or a small
VagrantBox VM.
.SS Python PyWinRM Module
.sp
Versions of \fBpywinrm>=0.2.1\fP are finally able to disable validation of self
signed certificates.  \fI\%Here\fP for more information.
.SS DigitalOcean
.sp
The DigitalOcean driver has been renamed to conform to the company name.  The
new driver name is \fBdigitalocean\fP\&.  The old name \fBdigital_ocean\fP and a
short one \fBdo\fP will still be supported through virtual aliases, this is
mostly cosmetic.
.SS Azure Cloud
.sp
The azure sdk used for the \fBazurearm\fP cloud driver now depends on
\fBazure\-cli>=2.0.12\fP
.SS New \fBsaltclass\fP pillar/master_tops modules
.sp
This module clones the behaviour of reclass (\fI\%http://reclass.pantsfullofunix.net/\fP), without the need of an external app, and add several features to improve flexibility.
Saltclass lets you define your nodes from simple \fByaml\fP files (\fB\&.yml\fP) through hierarchical class inheritance with the possibility to override pillars down the tree.
.sp
\fBFeatures\fP
.INDENT 0.0
.IP \(bu 2
Define your nodes through hierarchical class inheritance
.IP \(bu 2
Reuse your reclass data with minimal modifications
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
applications => states
.IP \(bu 2
parameters => pillars
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
Use Jinja templating in your yaml definitions
.IP \(bu 2
Access to the following Salt objects in Jinja
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fB__opts__\fP
.IP \(bu 2
\fB__salt__\fP
.IP \(bu 2
\fB__grains__\fP
.IP \(bu 2
\fB__pillars__\fP
.IP \(bu 2
\fBminion_id\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
Chose how to merge or override your lists using ^ character (see examples)
.IP \(bu 2
Expand variables ${} with possibility to escape them if needed ${} (see
examples)
.IP \(bu 2
Ignores missing node/class and will simply return empty without breaking the
pillar module completely \- will be logged
.UNINDENT
.sp
An example subset of data is available here:
\fI\%https://git.mauras.ch/salt/saltclass/src/branch/master/examples\fP
.TS
center;
|l|l|.
_
T{
Terms usable in yaml files
T}	T{
Description
T}
_
T{
classes
T}	T{
A list of classes that will be processed in order
T}
_
T{
states
T}	T{
A list of states that will be returned by master_tops function
T}
_
T{
pillars
T}	T{
A yaml dictionary that will be returned by the ext_pillar function
T}
_
T{
environment
T}	T{
Node saltenv that will be used by master_tops
T}
_
.TE
.sp
A class consists of:
.INDENT 0.0
.IP \(bu 2
zero or more parent classes
.IP \(bu 2
zero or more states
.IP \(bu 2
any number of pillars
.UNINDENT
.sp
A child class can override pillars from a parent class. A node definition is a
class in itself with an added \fBenvironment\fP parameter for \fBsaltenv\fP
definition.
.sp
\fBClass Names\fP
.sp
Class names mimic salt way of defining states and pillar files.
This means that \fBdefault.users\fP class name will correspond to one of these:
.INDENT 0.0
.IP \(bu 2
\fB<saltclass_path>/classes/default/users.yml\fP
.IP \(bu 2
\fB<saltclass_path>/classes/default/users/init.yml\fP
.UNINDENT
.sp
\fBSaltclass Tree\fP
.sp
A saltclass tree would look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<saltclass_path>
├── classes
│   ├── app
│   │   ├── borgbackup.yml
│   │   └── ssh
│   │       └── server.yml
│   ├── default
│   │   ├── init.yml
│   │   ├── motd.yml
│   │   └── users.yml
│   ├── roles
│   │   ├── app.yml
│   │   └── nginx
│   │       ├── init.yml
│   │       └── server.yml
│   └── subsidiaries
│       ├── gnv.yml
│       ├── qls.yml
│       └── zrh.yml
└── nodes
    ├── geneva
    │   └── gnv.node1.yml
    ├── lausanne
    │   ├── qls.node1.yml
    │   └── qls.node2.yml
    ├── node127.yml
    └── zurich
        ├── zrh.node1.yml
        ├── zrh.node2.yml
        └── zrh.node3.yml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBExamples\fP
.sp
\fB<saltclass_path>/nodes/lausanne/qls.node1.yml\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
environment: base

classes:
{% for class in [\(aqdefault\(aq] %}
  \- {{ class }}
{% endfor %}
  \- subsidiaries.{{ __grains__[\(aqid\(aq].split(\(aq.\(aq)[0] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB<saltclass_path>/classes/default/init.yml\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
classes:
  \- default.users
  \- default.motd

states:
  \- openssh

pillars:
  default:
    network:
      dns:
        srv1: 192.168.0.1
        srv2: 192.168.0.2
        domain: example.com
    ntp:
      srv1: 192.168.10.10
      srv2: 192.168.10.20
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB<saltclass_path>/classes/subsidiaries/gnv.yml\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillars:
  default:
    network:
      sub: Geneva
      dns:
        srv1: 10.20.0.1
        srv2: 10.20.0.2
        srv3: 192.168.1.1
        domain: gnv.example.com
    users:
      adm1:
        uid: 1210
        gid: 1210
        gecos: \(aqSuper user admin1\(aq
        homedir: /srv/app/adm1
      adm3:
        uid: 1203
        gid: 1203
        gecos: \(aqSuper user adm
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Variable expansions:
.sp
Escaped variables are rendered as is \- \fB${test}\fP
.sp
Missing variables are rendered as is \- \fB${net:dns:srv2}\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillars:
  app:
  config:
    dns:
      srv1: ${default:network:dns:srv1}
      srv2: ${net:dns:srv2}
    uri: https://application.domain/call?\e${test}
    prod_parameters:
      \- p1
      \- p2
      \- p3
  pkg:
    \- app\-core
    \- app\-backend
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
List override:
.sp
Not using \fB^\fP as the first entry will simply merge the lists
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pillars:
  app:
    pkg:
      \- ^
      \- app\-frontend
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBKnown limitation\fP
.sp
Currently you can\(aqt have both a variable and an escaped variable in the same
string as the escaped one will not be correctly rendered \- \(aq${xx}\(aq will stay
as is instead of being rendered as \(aq${xx}\(aq
.SS Lists of comments in state returns
.sp
State functions can now return a list of strings for the \fBcomment\fP field, as
opposed to only a single string.  This is meant to ease writing states with
multiple or multi\-part comments.
.SS Beacon configuration changes
.sp
In order to remain consistent and to align with other Salt components such as
states, support for configuring beacons using dictionary based configuration
has been deprecated in favor of list based configuration.  All beacons have a
validation function which will check the configuration for the correct format
and only load if the validation passes.
.SS avahi_announce
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  avahi_announce:
    run_once: True
    servicetype: _demo._tcp
    port: 1234
    txt:
      ProdName: grains.productname
      SerialNo: grains.serialnumber
      Comments: \(aqthis is a test\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  avahi_announce:
    \- run_once: True
    \- servicetype: _demo._tcp
    \- port: 1234
    \- txt:
        ProdName: grains.productname
        SerialNo: grains.serialnumber
        Comments: \(aqthis is a test\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS bonjour_announce
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  bonjour_announce:
    run_once: True
    servicetype: _demo._tcp
    port: 1234
    txt:
      ProdName: grains.productname
      SerialNo: grains.serialnumber
      Comments: \(aqthis is a test\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  bonjour_announce:
    \- run_once: True
    \- servicetype: _demo._tcp
    \- port: 1234
    \- txt:
        ProdName: grains.productname
        SerialNo: grains.serialnumber
        Comments: \(aqthis is a test\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS btmp
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  btmp: {}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  btmp: []
.ft P
.fi
.UNINDENT
.UNINDENT
.SS glxinfo
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  glxinfo:
    user: frank
    screen_event: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  glxinfo:
    \- user: frank
    \- screen_event: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS haproxy
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
    haproxy:
        \- www\-backend:
            threshold: 45
            servers:
                \- web1
                \- web2
        \- interval: 120
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  haproxy:
    \- backends:
        www\-backend:
          threshold: 45
          servers:
            \- web1
            \- web2
    \- interval: 120
.ft P
.fi
.UNINDENT
.UNINDENT
.SS inotify
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  inotify:
    /path/to/file/or/dir:
        mask:
          \- open
          \- create
          \- close_write
        recurse: True
        auto_add: True
        exclude:
          \- /path/to/file/or/dir/exclude1
          \- /path/to/file/or/dir/exclude2
          \- /path/to/file/or/dir/regex[a\-m]*$:
        regex: True
    coalesce: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  inotify:
    \- files:
        /path/to/file/or/dir:
          mask:
            \- open
            \- create
            \- close_write
          recurse: True
          auto_add: True
          exclude:
            \- /path/to/file/or/dir/exclude1
            \- /path/to/file/or/dir/exclude2
            \- /path/to/file/or/dir/regex[a\-m]*$:
          regex: True
    \- coalesce: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS journald
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  journald:
    sshd:
      SYSLOG_IDENTIFIER: sshd
      PRIORITY: 6
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  journald:
    \- services:
        sshd:
          SYSLOG_IDENTIFIER: sshd
          PRIORITY: 6
.ft P
.fi
.UNINDENT
.UNINDENT
.SS load
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  load:
    1m:
      \- 0.0
      \- 2.0
    5m:
      \- 0.0
      \- 1.5
    15m:
      \- 0.1
      \- 1.0
    emitatstartup: True
    onchangeonly: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  load:
    \- averages:
        1m:
          \- 0.0
          \- 2.0
        5m:
          \- 0.0
          \- 1.5
        15m:
          \- 0.1
          \- 1.0
    \- emitatstartup: True
    \- onchangeonly: False
.ft P
.fi
.UNINDENT
.UNINDENT
.SS log
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
    log:
      file: <path>
      <tag>:
        regex: <pattern>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
    log:
      \- file: <path>
      \- tags:
          <tag>:
            regex: <pattern>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS network_info
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  network_info:
    \- eth0:
        type: equal
        bytes_sent: 100000
        bytes_recv: 100000
        packets_sent: 100000
        packets_recv: 100000
        errin: 100
        errout: 100
        dropin: 100
        dropout: 100
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  network_info:
    \- interfaces:
        eth0:
          type: equal
          bytes_sent: 100000
          bytes_recv: 100000
          packets_sent: 100000
          packets_recv: 100000
          errin: 100
          errout: 100
          dropin: 100
          dropout: 100
.ft P
.fi
.UNINDENT
.UNINDENT
.SS network_settings
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  network_settings:
    eth0:
      ipaddr:
      promiscuity:
        onvalue: 1
    eth1:
      linkmode:
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  network_settings:
    \- interfaces:
        \- eth0:
            ipaddr:
            promiscuity:
              onvalue: 1
        \- eth1:
            linkmode:
.ft P
.fi
.UNINDENT
.UNINDENT
.SS proxy_example
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  proxy_example:
    endpoint: beacon
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  proxy_example:
    \- endpoint: beacon
.ft P
.fi
.UNINDENT
.UNINDENT
.SS ps
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  ps:
    \- salt\-master: running
    \- mysql: stopped
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  ps:
    \- processes:
        salt\-master: running
        mysql: stopped
.ft P
.fi
.UNINDENT
.UNINDENT
.SS salt_proxy
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  salt_proxy:
    \- p8000: {}
    \- p8001: {}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  salt_proxy:
    \- proxies:
        p8000: {}
        p8001: {}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS sensehat
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  sensehat:
    humidity: 70%
    temperature: [20, 40]
    temperature_from_pressure: 40
    pressure: 1500
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  sensehat:
    \- sensors:
        humidity: 70%
        temperature: [20, 40]
        temperature_from_pressure: 40
        pressure: 1500
.ft P
.fi
.UNINDENT
.UNINDENT
.SS service
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  service:
    salt\-master:
    mysql:
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  service:
    \- services:
        nginx:
            onchangeonly: True
            delay: 30
            uncleanshutdown: /run/nginx.pid
.ft P
.fi
.UNINDENT
.UNINDENT
.SS sh
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  sh: {}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  sh: []
.ft P
.fi
.UNINDENT
.UNINDENT
.SS status
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  status: {}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  status: []
.ft P
.fi
.UNINDENT
.UNINDENT
.SS telegram_bot_msg
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  telegram_bot_msg:
    token: \(dq<bot access token>\(dq
    accept_from:
      \- \(dq<valid username>\(dq
    interval: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  telegram_bot_msg:
    \- token: \(dq<bot access token>\(dq
    \- accept_from:
      \- \(dq<valid username>\(dq
    \- interval: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.SS twilio_txt_msg
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  twilio_txt_msg:
    account_sid: \(dq<account sid>\(dq
    auth_token: \(dq<auth token>\(dq
    twilio_number: \(dq+15555555555\(dq
    interval: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  twilio_txt_msg:
    \- account_sid: \(dq<account sid>\(dq
    \- auth_token: \(dq<auth token>\(dq
    \- twilio_number: \(dq+15555555555\(dq
    \- interval: 10
.ft P
.fi
.UNINDENT
.UNINDENT
.SS wtmp
.sp
Old behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  wtmp: {}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
beacons:
  wtmp: []
.ft P
.fi
.UNINDENT
.UNINDENT
.SS New requisites available in state compiler
.SS require_any
.sp
The use of \fBrequire_any\fP demands that one of the required states executes
before the dependent state. The state containing the \fBrequire_any\fP requisite
is defined as the dependent state. The states specified in the \fBrequire_any\fP
statement are defined as the required states. If at least one of the required
state\(aqs execution succeeds, the dependent state will then execute. If all of
the executions by the required states fail, the dependent state will not
execute.
.SS watch_any
.sp
The state containing the \fBwatch_any\fP requisite is defined as the watching
state. The states specified in the \fBwatch_any\fP statement are defined as the
watched states. When the watched states execute, they will return a dictionary
containing a key named \(dqchanges\(dq.
.sp
If the \(dqresult\(dq of any of the watched states is \fBTrue\fP, the watching state
\fIwill execute normally\fP, and if all of them are \fBFalse\fP, the watching state
will never run.  This part of \fBwatch\fP mirrors the functionality of the
\fBrequire\fP requisite.
.sp
If the \(dqresult\(dq of any of the watched states is \fBTrue\fP \fIand\fP the \(dqchanges\(dq
key contains a populated dictionary (changes occurred in the watched state),
then the \fBwatch\fP requisite can add additional behavior. This additional
behavior is defined by the \fBmod_watch\fP function within the watching state
module. If the \fBmod_watch\fP function exists in the watching state module, it
will be called \fIin addition to\fP the normal watching state. The return data from
the \fBmod_watch\fP function is what will be returned to the master in this case;
the return data from the main watching function is discarded.
.sp
If the \(dqchanges\(dq key contains an empty dictionary, the \fBwatch\fP requisite acts
exactly like the \fBrequire\fP requisite (the watching state will execute if
\(dqresult\(dq is \fBTrue\fP, and fail if \(dqresult\(dq is \fBFalse\fP in the watched state).
.SS onchanges_any
.sp
The \fBonchanges_any\fP requisite makes a state only apply one of the required
states generates changes, and if one of the watched state\(aqs \(dqresult\(dq is
\fBTrue\fP\&. This can be a useful way to execute a post hook after changing
aspects of a system.
.SS onfail_any
.sp
The \fBonfail_any\fP requisite allows for reactions to happen strictly as a
response to the failure of at least one other state. This can be used in a
number of ways, such as executing a second attempt to set up a service or begin
to execute a separate thread of states because of a failure.
.sp
The \fBonfail_any\fP requisite is applied in the same way as \fBrequire_any\fP and
\fBwatch_any\fP\&.
.SS Basic Slots support in state compiler
.sp
Slots extend the state syntax and allows you to do things right before the
state function is executed. So you can make a decision in the last moment right
before a state is executed.
.sp
Slot syntax looks close to the simple python function call. Here is a simple example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
copy\-some\-file:
  file.copy:
    \- name: __slot__:salt:test.echo(text=/tmp/some_file)
    \- source: __slot__:salt:test.echo(/etc/hosts)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Read more \fI\%here\fP\&.
.SS Cryptographic layer changes
.sp
M2Crypto is coming back. We are making the crypto backend modular but in this
release M2Crypto is enabled if it\(aqs importable by Python. If not Cryptodome or
PyCrypto is used as it was in the previous releases. M2Crypto is used in the
same way as PyCrypto so there would be no compatibility issues, different nodes
could use different backends.
.SS NaCL Module and Runner changes
.sp
In addition to argument changes in both the NaCL module and runner for future
removal in the 3000 release, the default \(dqbox_type\(dq has changed from
\fBsecretbox\fP to \fBsealedbox\fP\&.  SecretBox is data encrypted using private key
\fBsk\fP and Sealedbox is encrypted using public key \fBpk\fP\&.
.SS \fButils\fP functions reorganized into separate modules
.sp
The Salt utility functions from \fBsalt.utils\fP (typically used by those
developing extension modules for Salt) have been moved into different modules,
grouped logically based on their functionality. The old function names will
continue to work until the \fB3000\fP release of Salt (due around Q1 2019).
.sp
The renamed functions are:
.INDENT 0.0
.IP \(bu 2
\fBsalt.utils.appendproctitle\fP: use \fBsalt.utils.process.appendproctitle\fP
instead.
.IP \(bu 2
\fBsalt.utils.daemonize\fP: use \fBsalt.utils.process.daemonize\fP instead.
.IP \(bu 2
\fBsalt.utils.daemonize_if\fP: use \fBsalt.utils.process.daemonize_if\fP instead.
.IP \(bu 2
\fBsalt.utils.reinit_crypto\fP: use \fBsalt.utils.crypt.reinit_crypto\fP instead.
.IP \(bu 2
\fBsalt.utils.pem_finger\fP: use \fBsalt.utils.crypt.pem_finger\fP instead.
.IP \(bu 2
\fBsalt.utils.to_bytes\fP: use \fBsalt.utils.stringutils.to_bytes\fP instead.
.IP \(bu 2
\fBsalt.utils.to_str\fP: use \fBsalt.utils.stringutils.to_str\fP instead.
.IP \(bu 2
\fBsalt.utils.to_unicode\fP: use \fBsalt.utils.stringutils.to_unicode\fP instead.
.IP \(bu 2
\fBsalt.utils.str_to_num\fP: use \fBsalt.utils.stringutils.to_num\fP instead.
.IP \(bu 2
\fBsalt.utils.is_quoted\fP: use \fBsalt.utils.stringutils.is_quoted\fP instead.
.IP \(bu 2
\fBsalt.utils.dequote\fP: use \fBsalt.utils.stringutils.dequote\fP instead.
.IP \(bu 2
\fBsalt.utils.is_hex\fP: use \fBsalt.utils.stringutils.is_hex\fP instead.
.IP \(bu 2
\fBsalt.utils.is_bin_str\fP: use \fBsalt.utils.stringutils.is_bin_str\fP instead.
.IP \(bu 2
\fBsalt.utils.rand_string\fP: use \fBsalt.utils.stringutils.random\fP instead.
.IP \(bu 2
\fBsalt.utils.contains_whitespace\fP: use
\fBsalt.utils.stringutils.contains_whitespace\fP instead.
.IP \(bu 2
\fBsalt.utils.build_whitespace_split_regex\fP: use
\fBsalt.utils.stringutils.build_whitespace_split_regex\fP instead.
.IP \(bu 2
\fBsalt.utils.expr_match\fP: use \fBsalt.utils.stringutils.expr_match\fP instead.
.IP \(bu 2
\fBsalt.utils.check_whitelist_blacklist\fP: use
\fBsalt.utils.stringutils.check_whitelist_blacklist\fP instead.
.IP \(bu 2
\fBsalt.utils.check_include_exclude\fP: use
\fBsalt.utils.stringutils.check_include_exclude\fP instead.
.IP \(bu 2
\fBsalt.utils.print_cli\fP: use \fBsalt.utils.stringutils.print_cli\fP instead.
.IP \(bu 2
\fBsalt.utils.clean_kwargs\fP: use \fBsalt.utils.args.clean_kwargs\fP instead.
.IP \(bu 2
\fBsalt.utils.invalid_kwargs\fP: use \fBsalt.utils.args.invalid_kwargs\fP
instead.
.IP \(bu 2
\fBsalt.utils.shlex_split\fP: use \fBsalt.utils.args.shlex_split\fP instead.
.IP \(bu 2
\fBsalt.utils.arg_lookup\fP: use \fBsalt.utils.args.arg_lookup\fP instead.
.IP \(bu 2
\fBsalt.utils.argspec_report\fP: use \fBsalt.utils.args.argspec_report\fP
instead.
.IP \(bu 2
\fBsalt.utils.split_input\fP: use \fBsalt.utils.args.split_input\fP instead.
.IP \(bu 2
\fBsalt.utils.test_mode\fP: use \fBsalt.utils.args.test_mode\fP instead.
.IP \(bu 2
\fBsalt.utils.format_call\fP: use \fBsalt.utils.args.format_call\fP instead.
.IP \(bu 2
\fBsalt.utils.which\fP: use \fBsalt.utils.path.which\fP instead.
.IP \(bu 2
\fBsalt.utils.which_bin\fP: use \fBsalt.utils.path.which_bin\fP instead.
.IP \(bu 2
\fBsalt.utils.path_join\fP: use \fBsalt.utils.path.join\fP instead.
.IP \(bu 2
\fBsalt.utils.check_or_die\fP: use \fBsalt.utils.path.check_or_die\fP instead.
.IP \(bu 2
\fBsalt.utils.sanitize_win_path_string\fP: use
\fBsalt.utils.path.sanitize_win_path\fP instead.
.IP \(bu 2
\fBsalt.utils.rand_str\fP: use \fBsalt.utils.hashutils.random_hash\fP instead.
.IP \(bu 2
\fBsalt.utils.get_hash\fP: use \fBsalt.utils.hashutils.get_hash\fP instead.
.IP \(bu 2
\fBsalt.utils.is_windows\fP: use \fBsalt.utils.platform.is_windows\fP instead.
.IP \(bu 2
\fBsalt.utils.is_proxy\fP: use \fBsalt.utils.platform.is_proxy\fP instead.
.IP \(bu 2
\fBsalt.utils.is_linux\fP: use \fBsalt.utils.platform.is_linux\fP instead.
.IP \(bu 2
\fBsalt.utils.is_darwin\fP: use \fBsalt.utils.platform.is_darwin\fP instead.
.IP \(bu 2
\fBsalt.utils.is_sunos\fP: use \fBsalt.utils.platform.is_sunos\fP instead.
.IP \(bu 2
\fBsalt.utils.is_smartos\fP: use \fBsalt.utils.platform.is_smartos\fP instead.
.IP \(bu 2
\fBsalt.utils.is_smartos_globalzone\fP: use
\fBsalt.utils.platform.is_smartos_globalzone\fP instead.
.IP \(bu 2
\fBsalt.utils.is_smartos_zone\fP: use \fBsalt.utils.platform.is_smartos_zone\fP
instead.
.IP \(bu 2
\fBsalt.utils.is_freebsd\fP: use \fBsalt.utils.platform.is_freebsd\fP instead.
.IP \(bu 2
\fBsalt.utils.is_netbsd\fP: use \fBsalt.utils.platform.is_netbsd\fP instead.
.IP \(bu 2
\fBsalt.utils.is_openbsd\fP: use \fBsalt.utils.platform.is_openbsd\fP instead.
.IP \(bu 2
\fBsalt.utils.is_aix\fP: use \fBsalt.utils.platform.is_aix\fP instead.
.IP \(bu 2
\fBsalt.utils.safe_rm\fP: use \fBsalt.utils.files.safe_rm\fP instead.
.IP \(bu 2
\fBsalt.utils.is_empty\fP: use \fBsalt.utils.files.is_empty\fP instead.
.IP \(bu 2
\fBsalt.utils.fopen\fP: use \fBsalt.utils.files.fopen\fP instead.
.IP \(bu 2
\fBsalt.utils.flopen\fP: use \fBsalt.utils.files.flopen\fP instead.
.IP \(bu 2
\fBsalt.utils.fpopen\fP: use \fBsalt.utils.files.fpopen\fP instead.
.IP \(bu 2
\fBsalt.utils.rm_rf\fP: use \fBsalt.utils.files.rm_rf\fP instead.
.IP \(bu 2
\fBsalt.utils.mkstemp\fP: use \fBsalt.utils.files.mkstemp\fP instead.
.IP \(bu 2
\fBsalt.utils.istextfile\fP: use \fBsalt.utils.files.is_text_file\fP instead.
.IP \(bu 2
\fBsalt.utils.is_bin_file\fP: use \fBsalt.utils.files.is_binary\fP instead.
.IP \(bu 2
\fBsalt.utils.list_files\fP: use \fBsalt.utils.files.list_files\fP instead.
.IP \(bu 2
\fBsalt.utils.safe_walk\fP: use \fBsalt.utils.files.safe_walk\fP instead.
.IP \(bu 2
\fBsalt.utils.st_mode_to_octal\fP: use \fBsalt.utils.files.st_mode_to_octal\fP
instead.
.IP \(bu 2
\fBsalt.utils.normalize_mode\fP: use \fBsalt.utils.files.normalize_mode\fP
instead.
.IP \(bu 2
\fBsalt.utils.human_size_to_bytes\fP: use
\fBsalt.utils.files.human_size_to_bytes\fP instead.
.IP \(bu 2
\fBsalt.utils.backup_minion\fP: use \fBsalt.utils.files.backup_minion\fP instead.
.IP \(bu 2
\fBsalt.utils.str_version_to_evr\fP: use \fBsalt.utils.pkg.rpm.version_to_evr\fP
instead.
.IP \(bu 2
\fBsalt.utils.parse_docstring\fP: use \fBsalt.utils.doc.parse_docstring\fP
instead.
.IP \(bu 2
\fBsalt.utils.compare_versions\fP: use \fBsalt.utils.versions.compare\fP instead.
.IP \(bu 2
\fBsalt.utils.version_cmp\fP: use \fBsalt.utils.versions.version_cmp\fP instead.
.IP \(bu 2
\fBsalt.utils.warn_until\fP: use \fBsalt.utils.versions.warn_until\fP instead.
.IP \(bu 2
\fBsalt.utils.kwargs_warn_until\fP: use
\fBsalt.utils.versions.kwargs_warn_until\fP instead.
.IP \(bu 2
\fBsalt.utils.get_color_theme\fP: use \fBsalt.utils.color.get_color_theme\fP
instead.
.IP \(bu 2
\fBsalt.utils.get_colors\fP: use \fBsalt.utils.color.get_colors\fP instead.
.IP \(bu 2
\fBsalt.utils.gen_state_tag\fP: use \fBsalt.utils.state.gen_tag\fP instead.
.IP \(bu 2
\fBsalt.utils.search_onfail_requisites\fP: use
\fBsalt.utils.state.search_onfail_requisites\fP instead.
.IP \(bu 2
\fBsalt.utils.check_state_result\fP: use \fBsalt.utils.state.check_result\fP
instead.
.IP \(bu 2
\fBsalt.utils.get_user\fP: use \fBsalt.utils.user.get_user\fP instead.
.IP \(bu 2
\fBsalt.utils.get_uid\fP: use \fBsalt.utils.user.get_uid\fP instead.
.IP \(bu 2
\fBsalt.utils.get_specific_user\fP: use \fBsalt.utils.user.get_specific_user\fP
instead.
.IP \(bu 2
\fBsalt.utils.chugid\fP: use \fBsalt.utils.user.chugid\fP instead.
.IP \(bu 2
\fBsalt.utils.chugid_and_umask\fP: use \fBsalt.utils.user.chugid_and_umask\fP
instead.
.IP \(bu 2
\fBsalt.utils.get_default_group\fP: use \fBsalt.utils.user.get_default_group\fP
instead.
.IP \(bu 2
\fBsalt.utils.get_group_list\fP: use \fBsalt.utils.user.get_group_list\fP
instead.
.IP \(bu 2
\fBsalt.utils.get_group_dict\fP: use \fBsalt.utils.user.get_group_dict\fP
instead.
.IP \(bu 2
\fBsalt.utils.get_gid_list\fP: use \fBsalt.utils.user.get_gid_list\fP instead.
.IP \(bu 2
\fBsalt.utils.get_gid\fP: use \fBsalt.utils.user.get_gid\fP instead.
.IP \(bu 2
\fBsalt.utils.enable_ctrl_logoff_handler\fP: use
\fBsalt.utils.win_functions.enable_ctrl_logoff_handler\fP instead.
.IP \(bu 2
\fBsalt.utils.traverse_dict\fP: use \fBsalt.utils.data.traverse_dict\fP instead.
.IP \(bu 2
\fBsalt.utils.traverse_dict_and_list\fP: use
\fBsalt.utils.data.traverse_dict_and_list\fP instead.
.IP \(bu 2
\fBsalt.utils.filter_by\fP: use \fBsalt.utils.data.filter_by\fP instead.
.IP \(bu 2
\fBsalt.utils.subdict_match\fP: use \fBsalt.utils.data.subdict_match\fP instead.
.IP \(bu 2
\fBsalt.utils.substr_in_list\fP: use \fBsalt.utils.data.substr_in_list\fP instead.
.IP \(bu 2
\fBsalt.utils.is_dictlist\fP: use \fBsalt.utils.data.is_dictlist\fP\&.
.IP \(bu 2
\fBsalt.utils.repack_dictlist\fP: use \fBsalt.utils.data.repack_dictlist\fP
instead.
.IP \(bu 2
\fBsalt.utils.compare_dicts\fP: use \fBsalt.utils.data.compare_dicts\fP instead.
.IP \(bu 2
\fBsalt.utils.compare_lists\fP: use \fBsalt.utils.data.compare_lists\fP instead.
.IP \(bu 2
\fBsalt.utils.decode_dict\fP: use \fBsalt.utils.data.encode_dict\fP instead.
.IP \(bu 2
\fBsalt.utils.decode_list\fP: use \fBsalt.utils.data.encode_list\fP instead.
.IP \(bu 2
\fBsalt.utils.exactly_n\fP: use \fBsalt.utils.data.exactly_n\fP instead.
.IP \(bu 2
\fBsalt.utils.exactly_one\fP: use \fBsalt.utils.data.exactly_one\fP instead.
.IP \(bu 2
\fBsalt.utils.is_list\fP: use \fBsalt.utils.data.is_list\fP instead.
.IP \(bu 2
\fBsalt.utils.is_iter\fP: use \fBsalt.utils.data.is_iter\fP instead.
.IP \(bu 2
\fBsalt.utils.isorted\fP: use \fBsalt.utils.data.sorted_ignorecase\fP instead.
.IP \(bu 2
\fBsalt.utils.is_true\fP: use \fBsalt.utils.data.is_true\fP instead.
.IP \(bu 2
\fBsalt.utils.mysql_to_dict\fP: use \fBsalt.utils.data.mysql_to_dict\fP instead.
.IP \(bu 2
\fBsalt.utils.simple_types_filter\fP: use
\fBsalt.utils.data.simple_types_filter\fP instead.
.IP \(bu 2
\fBsalt.utils.ip_bracket\fP: use \fBsalt.utils.zeromq.ip_bracket\fP instead.
.IP \(bu 2
\fBsalt.utils.gen_mac\fP: use \fBsalt.utils.network.gen_mac\fP instead.
.IP \(bu 2
\fBsalt.utils.mac_str_to_bytes\fP: use \fBsalt.utils.network.mac_str_to_bytes\fP
instead.
.IP \(bu 2
\fBsalt.utils.refresh_dns\fP: use \fBsalt.utils.network.refresh_dns\fP instead.
.IP \(bu 2
\fBsalt.utils.dns_check\fP: use \fBsalt.utils.network.dns_check\fP instead.
.IP \(bu 2
\fBsalt.utils.get_context\fP: use \fBsalt.utils.stringutils.get_context\fP instead.
.IP \(bu 2
\fBsalt.utils.get_master_key\fP: use \fBsalt.utils.master.get_master_key\fP
instead.
.IP \(bu 2
\fBsalt.utils.get_values_of_matching_keys\fP: use
\fBsalt.utils.master.get_values_of_matching_keys\fP instead.
.IP \(bu 2
\fBsalt.utils.date_cast\fP: use \fBsalt.utils.dateutils.date_cast\fP instead.
.IP \(bu 2
\fBsalt.utils.date_format\fP: use \fBsalt.utils.dateutils.strftime\fP instead.
.IP \(bu 2
\fBsalt.utils.total_seconds\fP: use \fBsalt.utils.dateutils.total_seconds\fP
instead.
.IP \(bu 2
\fBsalt.utils.find_json\fP: use \fBsalt.utils.json.find_json\fP instead.
.IP \(bu 2
\fBsalt.utils.import_json\fP: use \fBsalt.utils.json.import_json\fP instead.
.IP \(bu 2
\fBsalt.utils.namespaced_function\fP: use
\fBsalt.utils.functools.namespaced_function\fP instead.
.IP \(bu 2
\fBsalt.utils.alias_function\fP: use \fBsalt.utils.functools.alias_function\fP
instead.
.IP \(bu 2
\fBsalt.utils.profile_func\fP: use \fBsalt.utils.profile.profile_func\fP instead.
.IP \(bu 2
\fBsalt.utils.activate_profile\fP: use \fBsalt.utils.profile.activate_profile\fP
instead.
.IP \(bu 2
\fBsalt.utils.output_profile\fP: use \fBsalt.utils.profile.output_profile\fP
instead.
.UNINDENT
.SS Deprecations
.SS Configuration Option Deprecations
.INDENT 0.0
.IP \(bu 2
The \fBrequests_lib\fP configuration option has been removed. Please use
\fBbackend\fP instead.
.UNINDENT
.SS Profitbricks Cloud Updated Dependency
.sp
The minimum version of the \fBprofitbrick\fP python package for the \fBprofitbricks\fP
cloud driver has changed from 3.0.0 to 3.1.0.
.SS Execution Module Deprecations
.INDENT 0.0
.IP \(bu 2
The \fBblockdev\fP execution module has been removed. Its functions were merged
with the \fI\%disk\fP module.
.IP \(bu 2
The \fI\%lxc\fP execution module has been changed as
follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The \fBdnsservers\fP option to \fI\%lxc.cloud_init_interface\fP no longer defaults to
\fB4.4.4.4\fP and \fB8.8.8.8\fP\&.
.IP \(bu 2
The \fBdns_via_dhcp\fP option to \fI\%lxc.cloud_init_interface\fP now defaults to \fBTrue\fP instead
of \fBFalse\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
The \fI\%win_psget\fP module has been changed as
follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The \fBpsget.psversion\fP function was removed. Please use
\fI\%cmd.shell_info\fP instead.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
The \fI\%win_service\fP module (which provides
the \fBservice\fP module on Windows platforms) has been changed as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The \fBconfig\fP function was removed. Please use \fI\%service.modify\fP instead.
.IP \(bu 2
The following arguments to the \fI\%service.create\fP function have been renamed:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBbinpath\fP has been renamed to \fBbin_path\fP
.IP \(bu 2
\fBdepend\fP has been renamed to \fBdependencies\fP
.IP \(bu 2
\fBDisplayName\fP has been renamed to \fBdisplay_name\fP
.IP \(bu 2
\fBerror\fP has been renamed to \fBerror_control\fP
.IP \(bu 2
\fBgroup\fP has been renamed to \fBload_order_group\fP
.IP \(bu 2
\fBobj\fP has been renamed to \fBaccount_name\fP
.IP \(bu 2
\fBpassword\fP has been renamed to \fBaccount_password\fP
.IP \(bu 2
\fBstart\fP has been renamed to \fBstart_type\fP
.IP \(bu 2
\fBtype\fP has been renamed to \fBservice_type\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
The \fI\%nacl\fP module has been changed as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The following arguments have been renamed in the \fI\%nacl.keygen\fP, \fI\%nacl.enc\fP, and
\fI\%nacl.dec\fP:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBkey_file\fP has been renamed to \fBsk_file\fP
.IP \(bu 2
\fBkey\fP has been renamed to \fBsk\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Runner Deprecations
.INDENT 0.0
.IP \(bu 2
The \fI\%manage\fP runner has been changed as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBroot_user\fP argument was removed from the \fI\%manage.bootstrap\fP function. Please use \fBsalt\-ssh\fP roster
entries for the host instead.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
The \fI\%nacl\fP runner has been changed as follows:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The following arguments have been renamed in the \fI\%nacl.keygen\fP, \fI\%nacl.enc\fP, and
\fI\%nacl.dec\fP:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBkey_file\fP has been renamed to \fBsk_file\fP
.IP \(bu 2
\fBkey\fP has been renamed to \fBsk\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS State Deprecations
.INDENT 0.0
.IP \(bu 2
In the \fBarchive\fP state, the
\fBtar_options\fP and \fBzip_options\fP options were removed. Please use
\fBoptions\fP instead.
.IP \(bu 2
The \fBcmd\fP state had the following changes:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The \fBuser\fP and \fBgroup\fP options were removed from the following functions
(please use \fBrunas\fP instead):
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fI\%cmd.run\fP
.IP \(bu 2
\fI\%cmd.script\fP
.IP \(bu 2
\fBcmd.wait\fP
.IP \(bu 2
\fBcmd.wait_script\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
In the \fI\%file\fP states, the \fBshow_diff\fP option was
removed in all states where it was previously supported. Please use
\fBshow_changes\fP instead.
.UNINDENT
.SS Grain Deprecations
.INDENT 0.0
.IP \(bu 2
For \fBsmartos\fP, some grains have been deprecated. These grains will be
removed in 3000:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
The \fBhypervisor_uuid\fP grain has been replaced with
\fBmdata:sdc:server_uuid\fP
.IP \(bu 2
The \fBdatacenter\fP grain has been replaced with
\fBmdata:sdc:datacenter_name\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Pillar Deprecations
.sp
The legacy configuration for \fBgit_pillar\fP has been removed. Please use the
new configuration for \fBgit_pillar\fP which was added in 2015.8.0, which is
documented \fI\%here\fP\&.
.SS Utils Deprecations
.INDENT 0.0
.IP \(bu 2
In \fBsalt.utils.cloud\fP, the \fBfire_event\fP function now requires a
\fBsock_dir\fP argument. It was previously optional.
.UNINDENT
.SS Other Miscellaneous Deprecations
.INDENT 0.0
.IP \(bu 2
In \fBversion.py\fP, the \fBrc_info\fP function was removed. Please use
\fBpre_info\fP instead.
.IP \(bu 2
Warnings for moving away from the \fBenv\fP option were removed. \fBsaltenv\fP
should be used instead. The removal of these warnings does not have a
behavior change. Only the warning text was removed.
.UNINDENT
.SS Minion Blackout
.sp
During a blackout, minions will not execute any remote execution commands,
except for \fI\%saltutil.refresh_pillar\fP\&.  Previously, support was added so that
blackouts are enabled using a special pillar key, \fBminion_blackout\fP set to
\fBTrue\fP and an optional pillar key \fBminion_blackout_whitelist\fP to specify
additional functions that are permitted during blackout. This release adds
support for using this feature in the grains as well, by using special grains
keys \fBminion_blackout\fP and \fBminion_blackout_whitelist\fP\&.
.SS Sentry Log Handler
.sp
Configuring sentry raven python client via \fBproject\fP, \fBservers\fP,
\fBpublic_key and \(ga\(gasecret_key\fP is deprecated and won\(aqt work with sentry
clients > 3.0.  Instead, the \fBdsn\fP config param must be used.
.SS RAET transport
.sp
We haven\(aqt been doing development on RAET for quite some time and decided that
2018.3.0 is the time to announce the deprecation. RAET support will be removed
in 3000. Please consider to move to \fBzeromq\fP or \fBtcp\fP transport instead of
\fBraet\fP\&.
.SS Salt 2018.3.1 Release Notes
.sp
Version 2018.3.1 is a bugfix release for \fI\%2018.3.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB525\fP
.IP \(bu 2
Total Issue References: \fB74\fP
.IP \(bu 2
Total PR References: \fB255\fP
.IP \(bu 2
Contributors: \fB55\fP (\fI\%Ch3LL\fP, \fI\%DmitryKuzmenko\fP, \fI\%Giandom\fP, \fI\%Kimol\fP, \fI\%L4rS6\fP,
\fI\%LukeCarrier\fP, \fI\%OrlandoArcapix\fP, \fI\%TamCore\fP, \fI\%The\-Loeki\fP, \fI\%UtahDave\fP, \fI\%aesposito91\fP,
\fI\%bbinet\fP, \fI\%bdrung\fP, \fI\%boltronics\fP, \fI\%bosatsu\fP, \fI\%clan\fP, \fI\%corywright\fP, \fI\%damon\-atkins\fP,
\fI\%dincamihai\fP, \fI\%dmurphy18\fP, \fI\%dnABic\fP, \fI\%douglasjreynolds\fP, \fI\%dwoz\fP, \fI\%edgan\fP, \fI\%ejparker12\fP,
\fI\%esell\fP, \fI\%ezh\fP, \fI\%femnad\fP, \fI\%folti\fP, \fI\%garethgreenaway\fP, \fI\%gtmanfred\fP, \fI\%isbm\fP, \fI\%jasperla\fP,
\fI\%johnj\fP, \fI\%mateiw\fP, \fI\%mcalmer\fP, \fI\%mirceaulinic\fP, \fI\%morganwillcock\fP, \fI\%opdude\fP, \fI\%pcn\fP, \fI\%pruiz\fP,
\fI\%psagers\fP, \fI\%psyer\fP, \fI\%rallytime\fP, \fI\%robinro\fP, \fI\%s0undt3ch\fP, \fI\%samodid\fP, \fI\%shengis\fP, \fI\%skjaro\fP,
\fI\%tankywoo\fP, \fI\%terminalmage\fP, \fI\%twangboy\fP, \fI\%vutny\fP, \fI\%yannj\-fr\fP, \fI\%zmedico\fP)
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
If you are using Jinja to dump lists or dictionaries in your SLS files,
this will now cause errors in Python 2 since Jinja does not produce
YAML\-compatible output when strings in the data structures contain unicode
types. The dictionary must be passed through a Jinja filter to produce
YAML\-compatible strings.
.sp
The below is an example of invalid SLS:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.mangaged:
    \- source: salt://foo.conf
    \- template: jinja
    \- defaults: {{ mydict }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To make it valid, use either one of Salt\(aqs own \fBjson\fP or \fByaml\fP
filters:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.mangaged:
    \- source: salt://foo.conf
    \- template: jinja
    \- defaults: {{ mydict | json }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Tornado 5.0 Support for Python 2 Only
.sp
Tornado 5.0 moves to using asyncio for all python3 versions.  Because of this
and changes in asyncio between python 3.4 and 3.5 to only be able to use one
ioloop, which requires some rearchitecting, support for tornado 5.0 and python3
versions of salt has been delayed to a later release.
.sp
For now, to use tornado 5.0, the python 2 version of salt must be used.
.SS Changes to Slack Engine pillars
.sp
When using \fBgroups_pillar_name\fP for the slack engine, the engine should be
used as part of a salt\-minion process running on the master.  This will allow
the minion to have pillars assigned to it, and will still allow the engine to
create a LocalClient connection to the master ipc sockets to control
environments.
.SS Changes to Automatically Updating the Roster File
.sp
In \fB2018.3.0\fP salt\-ssh was configured to automatically update the flat roster
file if a minion was not found for salt\-ssh. This was decided to be
undesirable as a default.  The \fB\-\-skip\-roster\fP flag has been removed and
replaced  with \fB\-\-update\-roster\fP, which will enable salt\-ssh to add minions
to the flat roster file.  This behavior can also be enabled by setting
\fBssh_update_roster: True\fP in the master config file.
.SS Changes to \fI\%file.blockreplace\fP State
.sp
The \fBappend_newline\fP argument was added to this state. Additionally, to
improve idempotence, if the string represented by \fBmarker_end\fP is found in
the middle of the line, the content preceding the marker will be removed when
the block is replaced. This allows one to remove \fBappend_newline: False\fP from
the SLS and have the block properly replaced if the end of the content block is
immediately followed by the \fBmarker_end\fP (i.e. no newline before the marker).
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This will require changes to your SLS if your \fBmarker_end\fP does not
include the very beginning of the content you want to keep.
.UNINDENT
.UNINDENT
.sp
See the \fI\%file.blockreplace\fP state
documentation for further information.
.SS Changelog for v2018.3.0..v2018.3.1
.sp
\fIGenerated at: 2018\-06\-06 17:43:01 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBISSUE\fP \fI\%#47955\fP: (\fI\%frogunder\fP) 2018.3.1 Creating Windows machine in Amazon using salt\-cloud fails. (refs: \fI\%#47989\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47998\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47989\fP to 2018.3.1
@ \fI2018\-06\-06 17:08:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47989\fP: (\fI\%dwoz\fP) Properly decode password from aws using m2crypto (refs: \fI\%#47998\fP)
.IP \(bu 2
605463ca0d Merge pull request \fI\%#47998\fP from rallytime/bp\-47989
.IP \(bu 2
1b7e9ac2d3 Lint fixes
.IP \(bu 2
0545152ddd Properly decode password from aws using m2crypto
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47965\fP: (\fI\%Ch3LL\fP) Add PR 47924 from 2018.3 branch
@ \fI2018\-06\-06 13:54:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
dbc798ac68 Merge pull request \fI\%#47965\fP from Ch3LL/gitpy_mac_3.1
.IP \(bu 2
bf608abd44 Catch all exceptions in git import for salt.utils.gitfs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47973\fP: (\fI\%terminalmage\fP) salt.modules.testinframod: fix TypeError invoking types.FunctionType
@ \fI2018\-06\-06 13:53:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
864d640633 Merge pull request \fI\%#47973\fP from terminalmage/fix\-testinfra
.IP \(bu 2
4518c89484 Lint: Remove unused six import
.IP \(bu 2
c6816b2149 salt.modules.testinframod: fix TypeError invoking types.FunctionType
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47236\fP: (\fI\%MorphBonehunter\fP) x509.private_key_managed broken after upgrade to 2018.3.0 (refs: \fI\%#47957\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47967\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47957\fP to 2018.3.1
@ \fI2018\-06\-06 13:53:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47957\fP: (\fI\%garethgreenaway\fP) [2018.8] Ensure x509 passphrase is a string (refs: \fI\%#47967\fP)
.IP \(bu 2
5ddcfff420 Merge pull request \fI\%#47967\fP from rallytime/bp\-47957
.IP \(bu 2
9a55579af1 removing unnecessary change
.IP \(bu 2
329b2e5956 Ensuring that when a passphrase is passed in, it is returned as a string from the passphrase callback.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47902\fP: (\fI\%Ch3LL\fP) Remove In Progress for 2018.3.1 Release Notes
@ \fI2018\-05\-30 18:26:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
9c964fdbce Merge pull request \fI\%#47902\fP from Ch3LL/rn_in_progress
.IP \(bu 2
f560a151cd Remove In Progress for 2018.3.1 Release Notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47897\fP: (\fI\%Ch3LL\fP) Add changelog to 2018.3.1 release notes
@ \fI2018\-05\-30 15:04:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea7b4fdc08 Merge pull request \fI\%#47897\fP from Ch3LL/rn_2018
.IP \(bu 2
e27ee273a7 Add == line to changelog line for release notes
.IP \(bu 2
61e56d275d Add changelog to 2018.3.1 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47784\fP: (\fI\%jpsv\fP) win_lgpo.py line 5368; AttributeError: \(aqOrderedDict\(aq object has no attribute \(aqlower\(aq (refs: \fI\%#47848\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47848\fP: (\fI\%twangboy\fP) Fix some major issues with the LGPO module
@ \fI2018\-05\-30 13:37:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
f15e636d5e Merge pull request \fI\%#47848\fP from twangboy/fix_47784
.IP \(bu 2
98facf8dc8 Remove log.debug statement in __virtual__
.IP \(bu 2
f037fa4064 Fix some major issues with the LGPO module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47881\fP: (\fI\%gtmanfred\fP) quote python_version in requirements.txt
@ \fI2018\-05\-29 21:12:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
92b8c4c08e Merge pull request \fI\%#47881\fP from gtmanfred/2018.3.1
.IP \(bu 2
3d874b5529 quote python_version in requirements.txt
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47874\fP: (\fI\%gtmanfred\fP) Tornado 5.0 is only supported on python 2 for now
@ \fI2018\-05\-29 19:45:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
705bf8172d Merge pull request \fI\%#47874\fP from gtmanfred/2018.3.1
.IP \(bu 2
13f920415a add tornado5 note to 2018.3.1
.IP \(bu 2
aeacd2b749 allow tornado 5.0 to be installed only for python2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47820\fP: (\fI\%Ch3LL\fP) Remove output_loglevel in mac_system module
@ \fI2018\-05\-25 13:10:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
09e8c5f0cd Merge pull request \fI\%#47820\fP from Ch3LL/mac_system
.IP \(bu 2
362414e53b Remove output_loglevel in mac_system module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47798\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47776\fP to 2018.3.1
@ \fI2018\-05\-23 15:10:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47776\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to failing _before_connect tests (refs: \fI\%#47798\fP)
.IP \(bu 2
7e314c26c8 Merge pull request \fI\%#47798\fP from rallytime/bp\-47776
.IP \(bu 2
ae881547d2 Fixing unit.test_minion.MinionTestCase.test_beacons_before_connect and unit.test_minion.MinionTestCase.test_scheduler_before_connect.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47782\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47775\fP to 2018.3.1
@ \fI2018\-05\-22 20:56:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47775\fP: (\fI\%gtmanfred\fP) catch UnsupportedOperation with AssertionError (refs: \fI\%#47782\fP)
.IP \(bu 2
9c610da0bc Merge pull request \fI\%#47782\fP from rallytime/bp\-47775
.IP \(bu 2
bab9c966c5 catch UnsupportedOperation with AssertionError
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47770\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47769\fP to 2018.3.1
@ \fI2018\-05\-22 17:27:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47769\fP: (\fI\%gtmanfred\fP) skip test that breaks test suite (refs: \fI\%#47770\fP)
.IP \(bu 2
4adf10b20b Merge pull request \fI\%#47770\fP from rallytime/bp\-47769
.IP \(bu 2
3cfb95c7bc skip test that breaks test suite
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47724\fP: (\fI\%terminalmage\fP) 2 master_tops/ext_nodes fixes
@ \fI2018\-05\-21 15:59:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
bbe8e62a98 Merge pull request \fI\%#47724\fP from terminalmage/master_tops_fixes
.IP \(bu 2
48b8c5acd1 Merge branch \(aq2018.3.1\(aq into master_tops_fixes
.IP \(bu 2
89b3070d4c Change deprecation warning to debug logging
.IP \(bu 2
ceb6e10f87 Fix spurious \(dqMalformed request\(dq error
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47484\fP: (\fI\%whytewolf\fP) Windows: pkg.latest state not updating packages. (refs: \fI\%#47702\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47739\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47702\fP to 2018.3.1
@ \fI2018\-05\-21 15:37:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47702\fP: (\fI\%damon\-atkins\fP) State pkg.latest called win pkg.install with list of pkgs and the required versions (refs: \fI\%#47739\fP)
.IP \(bu 2
97d6fe7434 Merge pull request \fI\%#47739\fP from rallytime/bp\-47702
.IP \(bu 2
f79da64bb0 Update is_windows path to use \fIplatform\fP
.IP \(bu 2
f04b19b5b6 Ensure targeted_pkgs always contains value for non\-windows.
.IP \(bu 2
14659f9cad Adjusted based on feed back.
.IP \(bu 2
9f18f7cdf5 Whitespace lint issues
.IP \(bu 2
2a29b28ee6 pkg.install execution module on windows ensures the software package is installed when no version is specified, it does not upgrade the software to the latest. This is per the design. pkg.latest must provide the versions to install to pkg.install
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47730\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47700\fP to 2018.3.1
@ \fI2018\-05\-21 15:36:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47700\fP: (\fI\%yannj\-fr\fP) fix roots modification time check (refs: \fI\%#47730\fP)
.IP \(bu 2
cfbe0ba73e Merge pull request \fI\%#47730\fP from rallytime/bp\-47700
.IP \(bu 2
9bc35b88ea fix roots modification time check
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47727\fP: (\fI\%Ch3LL\fP) Fix salt.utils.versions.warn_until spelling
@ \fI2018\-05\-21 13:41:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
3614d3d83a Merge pull request \fI\%#47727\fP from Ch3LL/spelling
.IP \(bu 2
47a8de5b73 Fix salt.utils.versions.warn_until spelling
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47736\fP: (\fI\%Ch3LL\fP) mac_utils test: patch __salt__[\(aqcmd.run*\(aq]
@ \fI2018\-05\-21 13:38:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb45cdaefe Merge pull request \fI\%#47736\fP from Ch3LL/fix_util_mac_test
.IP \(bu 2
ee90c779a8 mac_utils test: patch __salt__[\(aqcmd.run*\(aq]
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47641\fP: (\fI\%gtmanfred\fP) fix _create_stream and tornado 5.0
@ \fI2018\-05\-18 14:25:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
43930f8bac Merge pull request \fI\%#47641\fP from gtmanfred/2018.3.1
.IP \(bu 2
037fd92f59 fix pylint
.IP \(bu 2
75d42d8963 Fix last test for tornado
.IP \(bu 2
a046512287 allow using tornado 5.0
.IP \(bu 2
05e651f038 fix _create_stream and tornado 5.0
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47532\fP: (\fI\%edgan\fP) roster auto\-add feature in salt\-ssh\-2018.3.0 (refs: \fI\%#47541\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47541\fP: (\fI\%gtmanfred\fP) switch skip\-roster to update\-roster
@ \fI2018\-05\-18 13:29:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
9f926bcd1a Merge pull request \fI\%#47541\fP from gtmanfred/2018.3
.IP \(bu 2
8c5c780292 switch skip\-roster to update\-roster
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47719\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47692\fP to 2018.3.1
@ \fI2018\-05\-18 13:22:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47692\fP: (\fI\%dwoz\fP) Default windows to m1.small for ec2\-classic (refs: \fI\%#47719\fP)
.IP \(bu 2
a963f1b558 Merge pull request \fI\%#47719\fP from rallytime/bp\-47692
.IP \(bu 2
1d9f247fb7 Default windows to m1.small for ec2\-classic
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47706\fP: (\fI\%Ch3LL\fP) Add cmd._run_all_quiet to mac_utils and __utils__ in mac_service
@ \fI2018\-05\-18 01:11:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
c9108893ab Merge pull request \fI\%#47706\fP from Ch3LL/mac_service_util
.IP \(bu 2
3611af699f remove added space
.IP \(bu 2
9921caa143 fix pylint
.IP \(bu 2
317e41d3c0 use cmd._run_quiet and cmd._run_all_quiet instead of importing minion_mods in __salt__
.IP \(bu 2
a78652515a Add __salt__ to mac_utils and __utils__ in mac_service
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47664\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47645\fP to 2018.3.1
@ \fI2018\-05\-15 18:25:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47645\fP: (\fI\%Ch3LL\fP) query the pip path for test test_issue_2087_missing_pip (refs: \fI\%#47664\fP)
.IP \(bu 2
fb3bf1ff3e Merge pull request \fI\%#47664\fP from rallytime/bp\-47645
.IP \(bu 2
0a732d8e66 query the pip path for test test_issue_2087_missing_pip
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47647\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47601\fP and \fI\%#47643\fP to 2018.3.1
@ \fI2018\-05\-15 14:07:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47643\fP: (\fI\%dwoz\fP) Remove unwanted file (refs: \fI\%#47647\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47601\fP: (\fI\%dwoz\fP) Skip tests when we can not use runas (refs: \fI\%#47647\fP)
.IP \(bu 2
9039fee104 Merge pull request \fI\%#47647\fP from rallytime/bp\-47601\-and\-47643\-2018.3.1
.IP \(bu 2
7214fe17c8 Fix typo
.IP \(bu 2
506dceed17 Remove unwanted file
.IP \(bu 2
b6a21dfda3 use ignore\-undefined\-variable
.IP \(bu 2
2429f9fe8a Ignore pylint WindowsError
.IP \(bu 2
2d63682fea Better doc string
.IP \(bu 2
ec2adff699 Skip tests when we can not use runas
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47596\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47568\fP to 2018.3.1
@ \fI2018\-05\-10 22:09:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47568\fP: (\fI\%terminalmage\fP) salt.serializers.yaml/yamlex: remove invalid multi_constructor (refs: \fI\%#47596\fP)
.IP \(bu 2
17b5265d95 Merge pull request \fI\%#47596\fP from rallytime/bp\-47568
.IP \(bu 2
ecf5dc8b9f Add exception logging on serialize/deserialize exceptions
.IP \(bu 2
9659b19819 salt.serializers.yaml/yamlex: remove invalid multi_constructor
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47595\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47569\fP to 2018.3.1
@ \fI2018\-05\-10 22:08:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47569\fP: (\fI\%Ch3LL\fP) Update salt.utils.path mock in virtual core test (refs: \fI\%#47595\fP)
.IP \(bu 2
c4c400f3e9 Merge pull request \fI\%#47595\fP from rallytime/bp\-47569
.IP \(bu 2
0763f96458 update salt.utils.platform path for virt core test
.IP \(bu 2
718252c1ef Update salt.utils.path mock in virtual core test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47599\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47570\fP to 2018.3.1
@ \fI2018\-05\-10 22:06:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47570\fP: (\fI\%gtmanfred\fP) Update dependency to msgpack (refs: \fI\%#47599\fP)
.IP \(bu 2
ec7de14be0 Merge pull request \fI\%#47599\fP from rallytime/bp\-47570
.IP \(bu 2
9334c03da9 Update dependency to msgpack
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47571\fP: (\fI\%rallytime\fP) [2018.3.1] Update man pages
@ \fI2018\-05\-10 16:21:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
2a10d92669 Merge pull request \fI\%#47571\fP from rallytime/man\-pages
.IP \(bu 2
ade5e9f664 [2018.3.1] Update man pages
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47550\fP: (\fI\%pcn\fP) Fixes a bad deletion I did that only surfaced in 2018.3
@ \fI2018\-05\-09 13:36:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
85284caaf9 Merge pull request \fI\%#47550\fP from pcn/fix\-disable\-term\-protect\-in\-2018.3
.IP \(bu 2
d58a56877c Fixes a bad deletion I did that only surfaced in 2018.3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47553\fP: (\fI\%douglasjreynolds\fP) Unicode version error in lxc (refs: \fI\%#47554\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47554\fP: (\fI\%douglasjreynolds\fP) Converted unicode str version to a LooseVersion; matching line 2080.
@ \fI2018\-05\-09 13:34:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
f9083ff77e Merge pull request \fI\%#47554\fP from douglasjreynolds/lxc_unicode_fix
.IP \(bu 2
e6bce581c6 Converted unicode str version to _LooseVersion to match line 2080.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47518\fP: (\fI\%Ch3LL\fP) Fix 47364: ensure we are not caching zfs.is_supported
@ \fI2018\-05\-09 13:29:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
fe4e79f1de Merge pull request \fI\%#47518\fP from Ch3LL/zfs_support
.IP \(bu 2
d19fef963e remove unnecessary patch in zfs.is_supported test
.IP \(bu 2
58c4f29f96 Fix 47364: ensure we are not caching zfs.is_supported
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47159\fP: (\fI\%terminalmage\fP) Fix for whitelist/blacklist checking for non\-list iterables
@ \fI2018\-05\-08 20:43:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
332e9f13a6 Merge pull request \fI\%#47159\fP from terminalmage/whitelist_blacklist\-iter\-fix
.IP \(bu 2
ca936de372 Treat empty whitelist/blacklist as no whitelist/blacklist
.IP \(bu 2
bcccaf2621 Raise a TypeError when invalid input passed to check_whitelist_blacklist
.IP \(bu 2
2ae510ff2b Fix comment in test
.IP \(bu 2
17398efcf7 Fix for whitelist/blacklist checking for non\-list iterables
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47514\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-05\-08 18:36:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
21809ddc02 Merge pull request \fI\%#47514\fP from rallytime/merge\-2018.3
.IP \(bu 2
e2616b605f Update the pip tests to use the parsing syntax generated in PR \fI\%#47196\fP
.IP \(bu 2
b13b59791f Remove double instance of adding \fI\-\-format=json\fP in pip module
.IP \(bu 2
2ad60c7e81 Lint: remove duplicate function in helpers.py
.IP \(bu 2
75480158b3 Lint: cur_version should just be pip_version
.IP \(bu 2
5565d5e9b1 Update old utils paths with new utils paths
.IP \(bu 2
786076ac03 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
611ca1fc03 Merge pull request \fI\%#47476\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
1f91a85587 specify cache dir for pip install
.IP \(bu 2
99e150e09c check for kitchen\-vagrant gem before loading windows tests
.UNINDENT
.IP \(bu 2
7c3f2c56da Merge pull request \fI\%#47412\fP from twangboy/fix_47125
.INDENT 2.0
.IP \(bu 2
c9bab0b8e3 Merge branch \(aq2017.7\(aq into fix_47125
.IP \(bu 2
2600e404d5 Fix overly long line
.IP \(bu 2
5c8db05769 Fix issue where the cwd was being removed
.UNINDENT
.IP \(bu 2
4846e957c4 Merge pull request \fI\%#47467\fP from twangboy/cleanup_settings
.INDENT 2.0
.IP \(bu 2
9d498293b1 Remove unused settings, update NSIS
.UNINDENT
.IP \(bu 2
da9871d36b Merge pull request \fI\%#47196\fP from twangboy/fix_47024
.INDENT 2.0
.IP \(bu 2
14ee5537b9 Add @with_tempdir helper
.IP \(bu 2
6c3b5fa6fa Fix typo
.IP \(bu 2
f031710af2 Merge branch \(aq2017.7\(aq into fix_47024
.IP \(bu 2
7c46d9d0d4 Fix integration.modules.test_pip
.IP \(bu 2
22ac81df63 Fix integration.modules.test_pip
.IP \(bu 2
57d98224d4 Merge pull request #9 from terminalmage/twangboy/fix_47024
.INDENT 2.0
.IP \(bu 2
37a13d8004 Update pip unit tests to reflect changes
.IP \(bu 2
7f86779be0 Lint fix
.UNINDENT
.IP \(bu 2
c48d8f4f61 DRY and other fixes in pip module
.IP \(bu 2
b1117896a0 Change from global variable to __context__\(ga\(ga
.IP \(bu 2
3e6e524eca Fix some tests\(ga\(ga
.IP \(bu 2
c94f0f20e4 Fix lint error
.IP \(bu 2
fd47b21530 Fix merge conflict
.UNINDENT
.IP \(bu 2
e8c4524bae Merge pull request \fI\%#47455\fP from Ch3LL/unreleased_rn
.INDENT 2.0
.IP \(bu 2
b6d0cc2ab7 Add In Progress Warning for 2017.7.6 Release Notes
.UNINDENT
.IP \(bu 2
2c7a4b6179 Merge pull request \fI\%#47459\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
d228e72477 update ubuntu\-rolling to 18.04
.UNINDENT
.IP \(bu 2
64a64c0ed7 Merge pull request \fI\%#47462\fP from terminalmage/docs
.INDENT 2.0
.IP \(bu 2
6d7803ece0 Fix docs build on Sphinx 1.7+
.UNINDENT
.IP \(bu 2
6cd0d31c03 Merge pull request \fI\%#47438\fP from lomeroe/double_admx_test
.INDENT 2.0
.IP \(bu 2
4902f1e2ba check if a policy has either an enabled value or enabled list entry or a disabled value or disabled list entry when determining the state of the policy
.UNINDENT
.IP \(bu 2
ed69821d19 Merge pull request \fI\%#47433\fP from s0undt3ch/2017.7
.INDENT 2.0
.IP \(bu 2
5abadf25d6 Add missing requirements files not committed in \fI\%#47106\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47443\fP: (\fI\%skylerberg\fP) Input validation does not raise SaltInvocationError in win_dsc.py (refs: \fI\%#47505\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47516\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47505\fP to 2018.3
@ \fI2018\-05\-08 13:32:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47505\fP: (\fI\%dwoz\fP) Raise proper invocation errors (refs: \fI\%#47516\fP)
.IP \(bu 2
9559ac7679 Merge pull request \fI\%#47516\fP from rallytime/bp\-47505
.IP \(bu 2
7c60e4071e Raise proper invocation errors
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47502\fP: (\fI\%psagers\fP) service.enable (and .disable) destroys /etc/rc.conf on FreeBSD (refs: \fI\%#47503\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47515\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47503\fP to 2018.3
@ \fI2018\-05\-08 13:32:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47503\fP: (\fI\%psagers\fP) Fix \fI\%#47502\fP: Remove an extraneous (accidentally introduced?) call to rstrip() (refs: \fI\%#47515\fP)
.IP \(bu 2
bf79acfbc8 Merge pull request \fI\%#47515\fP from rallytime/bp\-47503
.IP \(bu 2
821dbb88a0 Fix \fI\%#47502\fP: Remove an extraneous (accidentally introduced?) call to rstrip.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47511\fP: (\fI\%joesusecom\fP) sshconfig salt\-ssh roster is missing in the documentation (refs: \fI\%#47531\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47531\fP: (\fI\%gtmanfred\fP) add ssh config doc for rosters
@ \fI2018\-05\-07 22:26:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
779b3ed056 Merge pull request \fI\%#47531\fP from gtmanfred/2018.3
.IP \(bu 2
92ded7162c add ssh config doc for rosters
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47520\fP: (\fI\%rallytime\fP) Cleanup weird spaces
@ \fI2018\-05\-07 19:50:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
95b2f9db30 Merge pull request \fI\%#47520\fP from rallytime/cleanup\-spaces
.IP \(bu 2
e9cb080a00 Cleanup weird spaces
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47495\fP: (\fI\%dwoz\fP) Fix crufty nssm.exe reference
@ \fI2018\-05\-07 19:12:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
05fc52f124 Merge pull request \fI\%#47495\fP from dwoz/uninstall_wart
.IP \(bu 2
caa36c9064 Merge branch \(aq2018.3\(aq into uninstall_wart
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47322\fP: (\fI\%masau\fP) lxc clone not working (refs: \fI\%#47494\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47494\fP: (\fI\%ejparker12\fP) Fixed lxc.clone unhandled exception in salt/modules/lxc.py
@ \fI2018\-05\-07 19:03:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
3cc7d3ae7c Merge pull request \fI\%#47494\fP from ejparker12/fix\-lxc\-clone
.IP \(bu 2
e0e2c9782d Fixed lxc.clone unhandled exception in salt/modules/lxc.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47496\fP: (\fI\%mateiw\fP) salt\-ssh \-\-extra\-filerefs doesn\(aqt include any files if no refs in state files (refs: \fI\%#47497\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47497\fP: (\fI\%mateiw\fP) Fix salt\-ssh \-\-extra\-filerefs to include files even if no refs in states to apply
@ \fI2018\-05\-07 19:02:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
adde83f639 Merge pull request \fI\%#47497\fP from mateiw/2018.3\-fix\-ssh\-extra\-files\-refs\-issue\-47496
.IP \(bu 2
d67239aae7 \-\-extra\-filerefs include files even if no refs in states to apply
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47404\fP: (\fI\%shengis\fP) Localized version of yum breaks pkg.install (refs: \fI\%#47441\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47441\fP: (\fI\%shengis\fP) Fix _run to reset LANGUAGE env variable
@ \fI2018\-05\-07 18:29:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
34b1b1ee53 Merge pull request \fI\%#47441\fP from shengis/fix\-run\-env\-reset
.IP \(bu 2
62fc16b721 Merge branch \(aq2018.3\(aq into fix\-run\-env\-reset
.IP \(bu 2
3b02b0bdc1 Merge branch \(aq2018.3\(aq into fix\-run\-env\-reset
.IP \(bu 2
ee2ab38c8c Fix _run to reset LANGUAGE env variable
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47479\fP: (\fI\%whytewolf\fP) win_task.info on py3 throwing error, but works in py2 (refs: \fI\%#47507\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47507\fP: (\fI\%gtmanfred\fP) fix win_task for py3
@ \fI2018\-05\-07 17:41:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
17cfd4f7cf Merge pull request \fI\%#47507\fP from gtmanfred/2018.3
.IP \(bu 2
19db39f402 fix win_task for py3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47472\fP: (\fI\%terminalmage\fP) salt.utils.hashutils: Fix UnicodeEncodeError in several funcs
@ \fI2018\-05\-07 13:31:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
a4c2df8fb2 Merge pull request \fI\%#47472\fP from terminalmage/hashutils
.IP \(bu 2
7266c9984d salt.utils.hashutils: Fix UnicodeEncodeError in several funcs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47485\fP: (\fI\%gtmanfred\fP) add openstack modules to doc index.rst
@ \fI2018\-05\-07 13:11:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
8b0a370189 Merge pull request \fI\%#47485\fP from gtmanfred/2018.3
.IP \(bu 2
c86163d79f add openstack modules to doc index.rst
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
3557fc5fa6 Fix crufty nssm.exe reference
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47482\fP: (\fI\%gtmanfred\fP) add all autodoc for new salt openstack modules
@ \fI2018\-05\-04 21:03:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
8df37f734a Merge pull request \fI\%#47482\fP from gtmanfred/2018.3
.IP \(bu 2
1f65d5cb73 add all autodoc for new salt openstack modules
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47447\fP: (\fI\%dwoz\fP) Fix failing test due to windows console encoding
@ \fI2018\-05\-04 16:41:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
d20ca15c5d Merge pull request \fI\%#47447\fP from dwoz/strv
.IP \(bu 2
8c01773833 Use the same non decodable bytes for all tests
.IP \(bu 2
983881a2a1 Add bytes that will not decode using cp1252
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47466\fP: (\fI\%dwoz\fP) bytes file that decodes the same utf\-8 and cp1252
@ \fI2018\-05\-04 15:54:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
8c5b30b541 Merge pull request \fI\%#47466\fP from dwoz/randbytes
.IP \(bu 2
fd9bc06aab bytes file that decodes the same utf\-8 and cp1252
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46660\fP: (\fI\%mruepp\fP) top file merging same does produce conflicting ids with gitfs (refs: \fI\%#47354\fP, \fI\%#46751\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47465\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47354\fP to 2018.3
@ \fI2018\-05\-04 13:06:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47354\fP: (\fI\%folti\fP) fix forward port of \fI\%#46751\fP (refs: \fI\%#47465\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46751\fP: (\fI\%folti\fP) top file merging strategy \(aqsame\(aq works again (refs: \fI\%#47354\fP)
.IP \(bu 2
3658604c43 Merge pull request \fI\%#47465\fP from rallytime/bp\-47354
.IP \(bu 2
3df6fa7990 fix forward port of \fI\%#46751\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47435\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-05\-04 13:05:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
fa293f8fac Merge pull request \fI\%#47435\fP from rallytime/merge\-2018.3
.IP \(bu 2
be0731da5f Add skipIfs back in for rest_tornado tests
.IP \(bu 2
fd98ee3dc1 Lint: Add missing blank line
.IP \(bu 2
561718b20b Update old is_windows utils path to new utils path
.IP \(bu 2
a94cdf8a0d Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
7ae3497b0c Merge pull request \fI\%#47429\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
8ae32033cc server_list_min should use state, not status
.UNINDENT
.IP \(bu 2
2f5fc4ecc5 Merge pull request \fI\%#47399\fP from isbm/isbm\-zeromq17\-deprecationwarning\-2017.7.2\-v2
.INDENT 2.0
.IP \(bu 2
a36e49fd27 fix pylint
.IP \(bu 2
98b5629b36 Fix imports
.IP \(bu 2
d94c0f0152 Remove unnecessary variable
.IP \(bu 2
8e377b5653 Lintfix: E0203 and attribute access
.IP \(bu 2
2aab70b1b8 Install ZMQ handler if <15 version
.IP \(bu 2
296c589f4b Use ZMQ switch utility in the integration tests
.IP \(bu 2
ab5fa34d7c Use ZMQ_VERSION_INFO constant everywhere
.IP \(bu 2
43b5558b82 Add trace logging on ZMQ sockets communication
.IP \(bu 2
164204a9fe Remove duplicate code for ZMQ monitor handling
.IP \(bu 2
834b1e4ff0 Remove obsolete ZMQIOLoop direct instance
.IP \(bu 2
1c90cbdb3c Remove an empty line
.IP \(bu 2
ef2e0acd66 Add logging on ZMQ socket exception
.IP \(bu 2
38ceed371d Lintfix: ident
.IP \(bu 2
1ece6a5f52 Lintfix: line too long
.IP \(bu 2
4e650c0b44 Remove code duplicate by reusing utilities functions
.IP \(bu 2
57da54b676 Fix imports
.IP \(bu 2
948368e9a1 Add libzmq version info builder
.IP \(bu 2
0b4a17b859 Update log exception message
.IP \(bu 2
116e1809fc Put a message alongside the exception to the logs
.IP \(bu 2
4bc43124b7 Remove unnecessary ZMQ import and check for its presence
.IP \(bu 2
05f4d40269 Use utility for ZMQ import handling in SSH client
.IP \(bu 2
457ef7d9a5 Use utility for ZMQ import handling in flo/zero
.IP \(bu 2
08dee6f5bd Use utility for ZMQ import handling
.IP \(bu 2
e2a353cfb0 Remove unnecessary ZMQ extra\-check for cache utils
.IP \(bu 2
c8f2cc271d Remove unnecessary ZMQ extra\-check for master utils
.IP \(bu 2
3940667bb9 Remove old ZMQ import handling
.IP \(bu 2
f34a53e029 Use ZMQ utility for version check
.IP \(bu 2
cbb26dcb28 Use ZMQ installer for master
.IP \(bu 2
453e83210a Add ZMQ version build
.IP \(bu 2
af9601e21d Use ZMQ importer utility in async
.IP \(bu 2
d50b2b2023 Incorporate tornado\-5 fixes
.IP \(bu 2
1fd9af0655 Add ZMQ backward\-compatibility tornado installer for older versions
.IP \(bu 2
ad4b40415c Add one place for handling various ZMQ versions and IOLoop classes
.UNINDENT
.IP \(bu 2
b14e974b5f Merge pull request \fI\%#47343\fP from Ch3LL/win_srv_test
.INDENT 2.0
.IP \(bu 2
2173b6f549 ensure we are enabling/disabling before test
.IP \(bu 2
d58be06751 Add additionatl service module integration tests and enable for windows
.UNINDENT
.IP \(bu 2
b0f3fb577f Merge pull request \fI\%#47375\fP from terminalmage/issue47310
.INDENT 2.0
.IP \(bu 2
fa2bea52bb Remove extra blank line to appease linter
.IP \(bu 2
f8ab2be81c Add debug logging if we fail to detect virtual packages
.IP \(bu 2
67c4fc56ac Warn on use of virtual packages in pkg.installed state
.UNINDENT
.IP \(bu 2
56235032f4 Merge pull request \fI\%#47415\fP from kstreee/fix\-local\-client\-tgt\-bug
.INDENT 2.0
.IP \(bu 2
b8d37e0a1e To add a test case for the syndic environment, copies the test case which was written by @mattp\- that was already merged into develop branch, related pr is \fI\%#46692\fP\&.
.IP \(bu 2
4627bad1fd Realizes \(aqtgt\(aq field into actual minions using ckminions to subscribe results of the minions before publishing a payload.
.UNINDENT
.IP \(bu 2
d65ceaee03 Merge pull request \fI\%#47286\fP from baniobloom/vpc_peering_connection_name_fix
.INDENT 2.0
.IP \(bu 2
a968965087 Merge branch \(aq2017.7\(aq into vpc_peering_connection_name_fix
.UNINDENT
.IP \(bu 2
8a5d4437bb Merge pull request \fI\%#47270\fP from meaksh/2017.7\-fix\-retcode\-on\-schedule\-utils
.INDENT 2.0
.IP \(bu 2
d299cf3385 Merge branch \(aq2017.7\(aq into 2017.7\-fix\-retcode\-on\-schedule\-utils
.IP \(bu 2
b6da600fff Initialize __context__ retcode for functions handled via schedule util module
.UNINDENT
.IP \(bu 2
5b51075384 Merge pull request \fI\%#47371\fP from rallytime/fix\-47264
.INDENT 2.0
.IP \(bu 2
a43485b49c Fix \(dqof pass\(dq typo in grains.delval docs: change to \(dqor pass\(dq
.UNINDENT
.IP \(bu 2
a86e53be66 Merge pull request \fI\%#47389\fP from dwoz/moregittestfix
.INDENT 2.0
.IP \(bu 2
67745c1362 Older GitPython versions will not have close
.UNINDENT
.IP \(bu 2
a5367eaf63 Merge pull request \fI\%#47388\fP from dwoz/test_pip_fix
.INDENT 2.0
.IP \(bu 2
eb26321e8b Fix missing import
.UNINDENT
.IP \(bu 2
9b59b991c2 Merge pull request \fI\%#47380\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
93d1445ec1 add io_loop handling to runtests engine
.UNINDENT
.IP \(bu 2
37822c0cbb Merge pull request \fI\%#47384\fP from dwoz/test_pip_fix
.INDENT 2.0
.IP \(bu 2
a37a9da1fb Fix py2 version of pip test
.UNINDENT
.IP \(bu 2
eefd96732e Merge pull request \fI\%#47382\fP from dwoz/gitfs_tests
.INDENT 2.0
.IP \(bu 2
1570708fac Close the repo and fix multiple tests
.UNINDENT
.IP \(bu 2
57c75ff660 Merge pull request \fI\%#47369\fP from terminalmage/ldap_pillar
.INDENT 2.0
.IP \(bu 2
085883ae2d Return an empty dict if no search_order in ldap ext_pillar config file
.UNINDENT
.IP \(bu 2
bcc66dd9bf Merge pull request \fI\%#47363\fP from DSRCorporation/bugs/replace_exc_info_with_exception
.INDENT 2.0
.IP \(bu 2
3f7b93a23c Tornado5.0: Future.exc_info is dropped
.UNINDENT
.IP \(bu 2
bcef34f7e1 Merge pull request \fI\%#47334\fP from terminalmage/ldap_pillar
.INDENT 2.0
.IP \(bu 2
0175a8687c pillar_ldap: Fix cryptic errors when config file fails to load
.IP \(bu 2
65c3ba7ff1 Remove useless documentation
.IP \(bu 2
5d67cb27de Remove unnecessary commented line
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
8de3d41adb fixed vpc_peering_connection_name option
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47464\fP: (\fI\%dwoz\fP) Skip tests not applicable to windows
@ \fI2018\-05\-04 13:04:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
51d21afd4f Merge pull request \fI\%#47464\fP from dwoz/skiP_syslog_tests
.IP \(bu 2
ca9393b7fb Skip tests not applicable to windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47456\fP: (\fI\%dwoz\fP) Sysname returns text type
@ \fI2018\-05\-04 02:57:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
3219430dcc Merge pull request \fI\%#47456\fP from dwoz/sysname
.IP \(bu 2
559ee1961f Sysname returns text type
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47458\fP: (\fI\%Ch3LL\fP) Add In Progress Warning for 2018.3.1 Release Notes
@ \fI2018\-05\-03 20:40:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
f3918514a7 Merge pull request \fI\%#47458\fP from Ch3LL/unreleased_rn_2018
.IP \(bu 2
6a261e5e3a Add In Progress Warning for 2018.3.1 Release Notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47448\fP: (\fI\%dwoz\fP) Fix missing import in test suite
@ \fI2018\-05\-03 14:30:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
9fbdcbe994 Merge pull request \fI\%#47448\fP from dwoz/transport_import
.IP \(bu 2
7e04eb82e1 Fix missing import in test suite
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47260\fP: (\fI\%mew1033\fP) disable_saltenv_mapping not working as expected (refs: \fI\%#47410\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47410\fP: (\fI\%terminalmage\fP) gitfs: Fix identification of base env when saltenv mapping is disabled
@ \fI2018\-05\-03 14:12:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
157a32af7f Merge pull request \fI\%#47410\fP from terminalmage/issue47260
.IP \(bu 2
3ab332ad0e Update tests to reflect bugfix
.IP \(bu 2
7b8127f336 gitfs: Fix identification of base env when saltenv mapping is disabled
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47413\fP: (\fI\%dmurphy18\fP) Repobuild improvements for Ubuntu 18.04 lack of gpg2 and better error checking
@ \fI2018\-05\-02 16:21:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
091e4cf9a6 Merge pull request \fI\%#47413\fP from saltstack/repobuild_improv
.IP \(bu 2
c064032110 Removed extra spaces for pylint
.IP \(bu 2
20c50b3331 Minor cleanup due to review comments
.IP \(bu 2
c143b359e9 Update for Ubuntu 18.04 lack of gpg2 and enhanced error checking
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47216\fP: (\fI\%twangboy\fP) Reg docs
@ \fI2018\-05\-02 13:33:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
5e5774fd37 Merge pull request \fI\%#47216\fP from twangboy/reg_docs
.IP \(bu 2
0beeb58b16 Fix lint, add bytes
.IP \(bu 2
bad441f8dc Fix some lint\(ga
.IP \(bu 2
af5139c2ff Add additional examples
.IP \(bu 2
24df6ec1b7 Additional docs formatting
.IP \(bu 2
ff46b27a60 Update reg docs, fix formatting issues
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47417\fP: (\fI\%gtmanfred\fP) revert instantiating a Caller Client in the engine
@ \fI2018\-05\-01 18:58:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
63baf4c4f8 Merge pull request \fI\%#47417\fP from gtmanfred/slack
.IP \(bu 2
5c8ea7f506 Update slack.py
.IP \(bu 2
ee8a5eeb10 revert instantiating a Caller Client in the engine
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45790\fP: (\fI\%bdarnell\fP) Test with Tornado 5.0b1 (refs: \fI\%#46066\fP, \fI\%#47106\fP, \fI\%#47433\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47368\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-05\-01 18:56:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47106\fP: (\fI\%DmitryKuzmenko\fP) Tornado50 compatibility fixes (refs: \fI\%#47374\fP, \fI\%#47368\fP, \fI\%#47433\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46002\fP: (\fI\%isbm\fP) Pyzmq 17.0.0 proper handling (refs: \fI\%#47374\fP, \fI\%#47368\fP)
.IP \(bu 2
0bdfaa5ffe Merge pull request \fI\%#47368\fP from rallytime/merge\-2018.3
.IP \(bu 2
46806e595b Update test assertion comment for pip pkgs
.IP \(bu 2
d9d24de49e Lint: Add missing import
.IP \(bu 2
c7b73d132e Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
31db8ca7ad Merge pull request \fI\%#47347\fP from dwoz/test_mysql_fix_again
.INDENT 2.0
.IP \(bu 2
add78fb618 Fix linter warnings
.IP \(bu 2
2644cc7553 Fix linter nits
.IP \(bu 2
799c601184 Proper fix for mysql tests
.UNINDENT
.UNINDENT
.IP \(bu 2
fefc0cc3ca Update old utils paths to use new utils paths
.IP \(bu 2
13e8124031 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
e573236848 Merge pull request \fI\%#47359\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
6214ed8133 add mention of the formulas channel to the formulas docs
.UNINDENT
.IP \(bu 2
629503b2a8 Merge pull request \fI\%#47317\fP from dwoz/threadshutdown
.INDENT 2.0
.IP \(bu 2
6db2a0e4d3 Log exceptions at exception level
.IP \(bu 2
d4ae787595 Do not join a thread that is stopped
.UNINDENT
.IP \(bu 2
aacd5cefe3 Merge pull request \fI\%#47304\fP from cachedout/test_cli_timeout_arg
.INDENT 2.0
.IP \(bu 2
85025af83c Pass timeout to salt CLI for tests
.UNINDENT
.IP \(bu 2
55534fb659 Merge pull request \fI\%#47311\fP from Ch3LL/firewall_windows
.INDENT 2.0
.IP \(bu 2
4e16c18c16 Add firewall module windows tests to whitelist
.IP \(bu 2
4b2fc4ec66 Add windows firewall execution modules integration tests
.UNINDENT
.IP \(bu 2
1667375a80 Merge pull request \fI\%#47348\fP from dwoz/no_symlinks
.INDENT 2.0
.IP \(bu 2
94a70e847a Ignore gitfs tests when symlinks not enabled
.UNINDENT
.IP \(bu 2
dac04261b5 Merge pull request \fI\%#47342\fP from dwoz/test_mysql_fix
.INDENT 2.0
.IP \(bu 2
7496f4c5a8 Fix mysql test cases
.UNINDENT
.IP \(bu 2
34e78ef564 Merge pull request \fI\%#47341\fP from dwoz/inet_pton_fix
.INDENT 2.0
.IP \(bu 2
85451f48d4 Fix python 3 support for inet_pton function
.UNINDENT
.IP \(bu 2
e4779f3246 Merge pull request \fI\%#47339\fP from dwoz/ssh_key_test_fix
.INDENT 2.0
.IP \(bu 2
e37a93a1ca Remove redundent close call
.IP \(bu 2
b2ae5889b7 Close the temporary file handle
.IP \(bu 2
9f7f83a975 Use salt.utils.fopen for line ending consistency
.UNINDENT
.IP \(bu 2
b221860151 Merge pull request \fI\%#47335\fP from dwoz/pip_test_fix
.INDENT 2.0
.IP \(bu 2
dcb6a22c00 Remove un\-needed string\-escape
.UNINDENT
.IP \(bu 2
1c527bfd3a Merge pull request \fI\%#47331\fP from dwoz/py3_wingroup_fix
.INDENT 2.0
.IP \(bu 2
cc154ef857 Do not encode usernames
.UNINDENT
.IP \(bu 2
708078b152 Merge pull request \fI\%#47329\fP from cachedout/frank_credit
.INDENT 2.0
.IP \(bu 2
33c0644ac4 Credit Frank Spierings
.UNINDENT
.IP \(bu 2
a545e55543 Merge pull request \fI\%#47281\fP from Ch3LL/system_test
.INDENT 2.0
.IP \(bu 2
c9181a75a6 Add destructivetest decorator on tests
.IP \(bu 2
0d0c8987fc Add win_system integration module tests
.UNINDENT
.IP \(bu 2
b64d930df0 Merge pull request \fI\%#47283\fP from Ch3LL/ntp_test
.INDENT 2.0
.IP \(bu 2
ced7f86546 Add windows ntp integration module tests
.UNINDENT
.IP \(bu 2
910aff910f Merge pull request \fI\%#47314\fP from Ch3LL/net_mac_test
.INDENT 2.0
.IP \(bu 2
67beb1451c Skip netstat test on macosx as its not supported
.UNINDENT
.IP \(bu 2
0549ef7c16 Merge pull request \fI\%#47307\fP from rallytime/bp\-47257
.INDENT 2.0
.IP \(bu 2
6c5b2f92bc Role is not a list but a dictionary
.UNINDENT
.IP \(bu 2
d6ff4689f6 Merge pull request \fI\%#47312\fP from rallytime/update\-bootstrap\-release
.INDENT 2.0
.IP \(bu 2
765cce06a2 Update bootstrap script to latest release: 2018.04.25
.UNINDENT
.IP \(bu 2
e0765f5719 Merge pull request \fI\%#47279\fP from dwoz/py3_build_fix
.INDENT 2.0
.IP \(bu 2
21dc1bab91 Pep\-8 line endings
.IP \(bu 2
717abedaf7 Fix comman wart
.IP \(bu 2
4100dcd64c Close might get called more than once
.IP \(bu 2
dbe671f943 Stop socket before queue on delete
.IP \(bu 2
9587f5c69e Silence pylint import\-error for six.moves
.IP \(bu 2
4b0c7d3b34 Fix typo
.IP \(bu 2
05adf7c2b1 Use six.moves for queue import
.IP \(bu 2
fe340778fa Gracefully shutdown worker threads
.UNINDENT
.IP \(bu 2
44f19b2f94 Merge pull request \fI\%#47113\fP from jfindlay/iptables_state
.INDENT 2.0
.IP \(bu 2
8bd08012ee modules,states.iptables support proto for policy ext
.UNINDENT
.IP \(bu 2
b7a6206330 Merge pull request \fI\%#47302\fP from Ch3LL/dead_code
.INDENT 2.0
.IP \(bu 2
daa68b4877 Add virtual grains test for core grains
.IP \(bu 2
a59dd2785d Remove dead code in core grains file for virt\-what
.UNINDENT
.IP \(bu 2
e29362acfc Merge pull request \fI\%#47303\fP from baniobloom/bug_fix_doc
.INDENT 2.0
.IP \(bu 2
b97c9df5f3 added clarity on how to figure out what is the oldest supported main release branch
.UNINDENT
.IP \(bu 2
0d9d55e013 Merge pull request \fI\%#47106\fP from DSRCorporation/bugs/tornado50
.INDENT 2.0
.IP \(bu 2
39e403b18d Merge branch \(aq2017.7\(aq into bugs/tornado50
.IP \(bu 2
6706b3a2d1 Run off of a temporary config
.IP \(bu 2
d6873800d5 Allow running pytest>=3.5.0
.IP \(bu 2
2da3983740 Tornado 5.0 compatibility fixes
.UNINDENT
.IP \(bu 2
2e014f4746 Merge pull request \fI\%#47271\fP from gtmanfred/amazon
.INDENT 2.0
.IP \(bu 2
8a53908908 Do not load rh_service module when booted with systemd
.IP \(bu 2
e4d1d5bf11 Revert \(dqsupport amazon linux 2 for service module\(dq
.UNINDENT
.IP \(bu 2
599b0ed1e9 Merge pull request \fI\%#47246\fP from cloudflare/fix\-44847\-2017.7
.INDENT 2.0
.IP \(bu 2
ad80028104 This way, we can pass flags such as \fBdebug\fP into the state, but also \fBtest\fP\&.
.UNINDENT
.IP \(bu 2
4e2e1f0719 Merge pull request \fI\%#47220\fP from benediktwerner/fix\-pip\-2017.7
.INDENT 2.0
.IP \(bu 2
0197c3e973 Fix pip test
.IP \(bu 2
34bf66c09f Fix pip.installed with pip>=10.0.0
.UNINDENT
.IP \(bu 2
92e606251f Merge pull request \fI\%#47272\fP from rallytime/reg\-windows\-codeowners
.INDENT 2.0
.IP \(bu 2
9445af0185 Add windows tests and reg module/state to CODEOWNERS file for team\-windows
.UNINDENT
.IP \(bu 2
9dca5c0221 Merge pull request \fI\%#47252\fP from rallytime/codeowners\-fixes
.INDENT 2.0
.IP \(bu 2
204b6af92b Fix the matching patterns in the CODEOWNERS file to use fnmatch patterns
.UNINDENT
.IP \(bu 2
3de1bb49c8 Merge pull request \fI\%#47177\fP from fpicot/fix_47173_pkg_normalize
.INDENT 2.0
.IP \(bu 2
149f846f34 fix normalize parameter in pkg.installed
.UNINDENT
.IP \(bu 2
10e30515dc Merge pull request \fI\%#47251\fP from Ch3LL/pub_fix_rn
.INDENT 2.0
.IP \(bu 2
fa4c2e6575 Update Docs to remove unnecessary + sign
.UNINDENT
.IP \(bu 2
bb7850a431 Merge pull request \fI\%#47249\fP from Ch3LL/pub_fix_rn
.INDENT 2.0
.IP \(bu 2
24dea24b7e Add CVE number to 2016.3.6 Release
.UNINDENT
.IP \(bu 2
56933eb0b2 Merge pull request \fI\%#47227\fP from pruiz/pruiz/zfs\-dataset\-present\-slow\-2017.7
.INDENT 2.0
.IP \(bu 2
fded61f19b Fix issue \fI\%#47225\fP: avoid zfs.filesystem_present slowdown when dataset has lots of snapshots
.UNINDENT
.IP \(bu 2
9825065048 Merge pull request \fI\%#47167\fP from smitty42/vbox\-skd\-fix
.INDENT 2.0
.IP \(bu 2
5de53139cd Merge branch \(aq2017.7\(aq into vbox\-skd\-fix
.UNINDENT
.IP \(bu 2
976f031170 Merge pull request \fI\%#47213\fP from dwoz/py3win
.INDENT 2.0
.IP \(bu 2
ad9c7f63f0 Fix coverate on py3 windows builds
.IP \(bu 2
91252bac95 Adding updates for python3 compatibility and new virtualbox SDK version support.
.UNINDENT
.IP \(bu 2
cebcd6d069 Merge pull request \fI\%#47197\fP from dwoz/testfix
.INDENT 2.0
.IP \(bu 2
25803c9176 Move process target to top level module namespace
.UNINDENT
.IP \(bu 2
d4269c2b70 Merge pull request \fI\%#47193\fP from Ch3LL/network_test
.INDENT 2.0
.IP \(bu 2
bbf9987c19 Add network module integration tests
.UNINDENT
.IP \(bu 2
c777248a78 Merge pull request \fI\%#47189\fP from Ch3LL/autoruns
.INDENT 2.0
.IP \(bu 2
6a88bedb7a Add autoruns to windows whitelist
.IP \(bu 2
e9e4d4af70 Add autoruns.list integration test for Windows
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47403\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47356\fP to 2018.3
@ \fI2018\-05\-01 15:19:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47356\fP: (\fI\%robinro\fP) Fix sysctl translate (refs: \fI\%#47403\fP)
.IP \(bu 2
4e6870305c Merge pull request \fI\%#47403\fP from rallytime/bp\-47356
.IP \(bu 2
9b682bc48e Fix sysctl translate
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47407\fP: (\fI\%terminalmage\fP) Reduce severity of missing X_update_interval key
@ \fI2018\-05\-01 15:18:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
7e0cdd6145 Merge pull request \fI\%#47407\fP from terminalmage/update\-interval\-log
.IP \(bu 2
abc592bfff Reduce severity of missing X_update_interval key
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47042\fP: (\fI\%valentin2105\fP) [ERROR] Unable to manage file: \(aqutf8\(aq codec can\(aqt decode byte  (refs: \fI\%#47061\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47405\fP: (\fI\%terminalmage\fP) Fix file.get_diff regression in 2018.3 branch
@ \fI2018\-05\-01 15:16:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47061\fP: (\fI\%terminalmage\fP) Fix diffing binary files in file.get_diff (refs: \fI\%#47405\fP)
.IP \(bu 2
1377942bcc Merge pull request \fI\%#47405\fP from terminalmage/binary\-diff
.IP \(bu 2
89ddb08026 Use a lambda instead of defining a one\-line function
.IP \(bu 2
b79ff04fda Remove no\-longer\-used enumerate
.IP \(bu 2
e03b865359 Add unit test for file.get_diff
.IP \(bu 2
5bdc9e9bd5 Fix UnboundLocalError in file.get_diff
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47325\fP: (\fI\%robertodocampo\fP) docker_container.running creates containers using the image ID as the image name (refs: \fI\%#47367\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47367\fP: (\fI\%terminalmage\fP) Start docker containers with image name instead of ID
@ \fI2018\-04\-30 18:46:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
c267e6083e Merge pull request \fI\%#47367\fP from terminalmage/issue47325
.IP \(bu 2
798134caa3 Add regression test for creating images with image name insead of ID
.IP \(bu 2
4ed47e839c Start docker containers with image name instead of ID
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47006\fP: (\fI\%cedwards\fP) marathon & fx2 grain modules cause master and minion failure (refs: \fI\%#47401\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47401\fP: (\fI\%gtmanfred\fP) fix proxy virtual checks for marathon and fx2
@ \fI2018\-04\-30 18:44:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
3bb00cbb55 Merge pull request \fI\%#47401\fP from gtmanfred/proxy
.IP \(bu 2
99f9231759 fix proxy virtual checks for marathon and fx2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47397\fP: (\fI\%rallytime\fP) Add 2018.3.1 Release Notes
@ \fI2018\-04\-30 14:44:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
c160fe36ce Merge pull request \fI\%#47397\fP from rallytime/2018.3.1\-release\-notes
.IP \(bu 2
3b40cdad2a Add 2018.3.1 Release Notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45790\fP: (\fI\%bdarnell\fP) Test with Tornado 5.0b1 (refs: \fI\%#46066\fP, \fI\%#47106\fP, \fI\%#47433\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47374\fP: (\fI\%DmitryKuzmenko\fP) tornado50 merge forward for 2018.3
@ \fI2018\-04\-29 16:29:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47106\fP: (\fI\%DmitryKuzmenko\fP) Tornado50 compatibility fixes (refs: \fI\%#47374\fP, \fI\%#47368\fP, \fI\%#47433\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46002\fP: (\fI\%isbm\fP) Pyzmq 17.0.0 proper handling (refs: \fI\%#47374\fP, \fI\%#47368\fP)
.IP \(bu 2
3400f829c4 Merge pull request \fI\%#47374\fP from DSRCorporation/bugs/tornado50\-2018.3
.IP \(bu 2
400999c54f fix pylint
.IP \(bu 2
47b6d409d1 add io_loop handling to runtests engine
.IP \(bu 2
fd074fdb7d use salt.utils.zeromq
.IP \(bu 2
4ae33c5d9a Run off of a temporary config
.IP \(bu 2
7938b4906e Allow running pytest>=3.5.0
.IP \(bu 2
34058c181e Tornado 5.0 compatibility fixes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47124\fP: (\fI\%mchugh19\fP) Vault module problem in 2018.3.0 (refs: \fI\%#47379\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47379\fP: (\fI\%dwoz\fP) Properly encode messages when creating/validating signatures with m2crypto
@ \fI2018\-04\-28 08:38:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
2afe4bee95 Merge pull request \fI\%#47379\fP from dwoz/m2crypto_regression
.IP \(bu 2
068f2d430d Always sign and verify bytes
.IP \(bu 2
7810ebaba9 Add sign regression tests
.IP \(bu 2
f4441c3a1c Adding regression test for 47124
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47277\fP: (\fI\%morganwillcock\fP) Fix minion crash on NetBSD
@ \fI2018\-04\-27 15:02:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
7390b72808 Merge pull request \fI\%#47277\fP from morganwillcock/netbsdswap
.IP \(bu 2
0bcb1a079a Merge branch \(aq2018.3\(aq into netbsdswap
.IP \(bu 2
30478e8c9c Use swapctl for NetBSD
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47320\fP: (\fI\%twangboy\fP) Change from NSSM to SSM
@ \fI2018\-04\-27 14:37:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
2b7c7ef704 Merge pull request \fI\%#47320\fP from twangboy/win_ssm
.IP \(bu 2
5549d83aae Use ssm instead of nssm
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47308\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47287\fP to 2018.3
@ \fI2018\-04\-27 13:50:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47287\fP: (\fI\%esell\fP) convert unicode ssh pass to str for azure (refs: \fI\%#47308\fP)
.IP \(bu 2
b6df5facce Merge pull request \fI\%#47308\fP from rallytime/bp\-47287
.IP \(bu 2
5f392a23fe convert unicode ssh pass to str for azure
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47324\fP: (\fI\%rlschilperoort\fP) archive.extracted keep and/or keep_source not working (refs: \fI\%#47332\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47332\fP: (\fI\%garethgreenaway\fP) [2018.3] Removing duplicate code from state/archive.py
@ \fI2018\-04\-27 13:12:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
efa3aab800 Merge pull request \fI\%#47332\fP from garethgreenaway/47324_archive_extracted_keep_keep_source
.IP \(bu 2
cc10bfec6b Removing redundant code which is prevening keep & keep_source from being set.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47326\fP: (\fI\%The\-Loeki\fP) Some Redis fixes
@ \fI2018\-04\-26 17:12:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
245d62ca16 Merge pull request \fI\%#47326\fP from The\-Loeki/redis\-cache\-sockets
.IP \(bu 2
d86fbe5bdd redis_return: add unix_socket_path to docs
.IP \(bu 2
ee9f533765 redis_cache: document UNIX socket access
.IP \(bu 2
5337558a5a redis_return: Let redis handle pool creation, add UNIX socket support
.IP \(bu 2
c90f83b0f9 redis_return: cluster_mode default to False in __virtual__ to prevent KeyError stacktraces
.IP \(bu 2
71e3286829 redis_return: Fix code blocks in docs
.IP \(bu 2
e6605f1c78 redis_cache fix code blox in docs
.IP \(bu 2
40e67747ee redis_cache: add socket to options
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47319\fP: (\fI\%dwoz\fP) Skip unix group tests on windows.
@ \fI2018\-04\-26 15:59:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
27a438f0ff Merge pull request \fI\%#47319\fP from dwoz/skip_tests
.IP \(bu 2
d9442d043e Skip tests not applicable to windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47293\fP: (\fI\%dwoz\fP) The grp module is not available on windows
@ \fI2018\-04\-25 20:22:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
057f668788 Merge pull request \fI\%#47293\fP from dwoz/win_build_fix
.IP \(bu 2
0386216005 Fix sneaky indention
.IP \(bu 2
082b8d0b3d Use salt.utils.platform
.IP \(bu 2
cc2538e08f The grp modules is not available on windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46862\fP: (\fI\%kivoli\fP) Setting locale.system fails in 2018.3 (refs: \fI\%#47280\fP, \fI\%#46869\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47280\fP: (\fI\%gtmanfred\fP) make sure not to send invalid information
@ \fI2018\-04\-25 17:46:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
fff4f8c1a5 Merge pull request \fI\%#47280\fP from gtmanfred/localectl
.IP \(bu 2
7c212cbb2d fix pylint
.IP \(bu 2
6754787e8e update localemod tests
.IP \(bu 2
9075070573 make sure not to send invalid information
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46977\fP: (\fI\%gtmanfred\fP) [2018.3.0] Backwards compatibility breaking change in 2018.3.0 (refs: \fI\%#47038\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47038\fP: (\fI\%garethgreenaway\fP) [2018.3] fix to fileclient.py
@ \fI2018\-04\-25 14:57:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
205701dcbe Merge pull request \fI\%#47038\fP from garethgreenaway/46977_fixing_fileclient_forward_compatibility
.IP \(bu 2
ba01d2133a Updating version.py to include Magnesium.
.IP \(bu 2
10c823dd79 The _ext_nodes master function has been renamed to _master_tops. To ensure compatibility when using older Salt masters we continue to pass the function as _ext_nodes until the Magnesium release.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47059\fP: (\fI\%OrlandoArcapix\fP) Some states incorrectly return None instead of an empty dict when there are no changes (refs: \fI\%#47060\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#46985\fP: (\fI\%OrlandoArcapix\fP) grafana4_user.present and grafana4_org.present states not working in 2018.3.0 (refs: \fI\%#47048\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47060\fP: (\fI\%OrlandoArcapix\fP) Return an empty dict for \(aqchanges\(aq instead of \(aqNone\(aq
@ \fI2018\-04\-25 14:55:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47048\fP: (\fI\%OrlandoArcapix\fP) Issue46985 fix grafana4 state (refs: \fI\%#47060\fP)
.IP \(bu 2
89daf4fdc7 Merge pull request \fI\%#47060\fP from OrlandoArcapix/Issue47059\-return_dict_from_state
.IP \(bu 2
5378e4fd07 Update grafana_datasource test to check for empty dict being returned on no changes, rather than None
.IP \(bu 2
f115452653 Return an empty dict for \(aqchanges\(aq instead of \(aqNone\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47089\fP: (\fI\%syphernl\fP) UnicodeDecodeError: \(aqascii\(aq codec can\(aqt decode byte 0xc3 in position 404: ordinal not in range(128) (refs: \fI\%#47153\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47153\fP: (\fI\%terminalmage\fP) salt.modules.ssh: properly encode/decode I/O
@ \fI2018\-04\-25 14:53:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
10cc0d312b Merge pull request \fI\%#47153\fP from terminalmage/issue47089
.IP \(bu 2
bdb52797f8 salt.modules.ssh: properly encode/decode I/O
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47199\fP: (\fI\%tkaehn\fP) Targeting by list (\-L) broken for minions behind syndic? (refs: \fI\%#47275\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47275\fP: (\fI\%terminalmage\fP) Fix false failure events sent when using syndic
@ \fI2018\-04\-25 13:56:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
b5d64f1a70 Merge pull request \fI\%#47275\fP from terminalmage/issue47199
.IP \(bu 2
8012ad12f8 Fix false failure events sent when using syndic
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47267\fP: (\fI\%skjaro\fP) Problem with beacon diskusage on windows platform in 2018.3 (refs: \fI\%#47284\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47284\fP: (\fI\%skjaro\fP) Fix beacon diskusage documentation for the new beahavior mentioned in issue \fI\%#47267\fP
@ \fI2018\-04\-25 13:52:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
6215a995d8 Merge pull request \fI\%#47284\fP from skjaro/beacon_diskusage_doc_fix
.IP \(bu 2
fcc042aa5f Fix beacon documentation for the new beahavior mentioned in issue \fI\%#47267\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47291\fP: (\fI\%bosatsu\fP) Fix proxy minion beacon doc
@ \fI2018\-04\-25 13:42:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ef4fe6ed2 Merge pull request \fI\%#47291\fP from bosatsu/fix\-proxy\-minion\-beacon\-doc
.IP \(bu 2
01980b4c43 Fix topics/releases/2018.3.0.rst to include correct example of proxy_example beacon yaml configuration.
.IP \(bu 2
9682e26eec Fix topics/proxyminion/beacon.rst to include correct example of salt_proxy beacon yaml configuration.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47239\fP: (\fI\%bosatsu\fP) Unable to load salt_proxy beacon on minion in 2018.3.0 (refs: \fI\%#47255\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47255\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to salt_proxy beacon and beacon tests
@ \fI2018\-04\-25 13:41:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea2d68b865 Merge pull request \fI\%#47255\fP from garethgreenaway/47239_fixes_to_salt_proxy_beacon
.IP \(bu 2
a2a8d78cb0 Fixing status beacon tests.
.IP \(bu 2
c87d6cae23 Ensure the salt_proxy is returning the correct tuple when the configuration is valid.  Update various beacon unit tests to ensure they are testing the results of the validate function for a True result.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47292\fP: (\fI\%dwoz\fP) Fix decorator wart
@ \fI2018\-04\-25 04:25:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47290\fP: (\fI\%dwoz\fP) Run cache_master test in tmp dir (refs: \fI\%#47292\fP)
.IP \(bu 2
19f9e8258f Merge pull request \fI\%#47292\fP from dwoz/cp_fix_again
.IP \(bu 2
7d045eb235 Fix decorator wart
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47285\fP: (\fI\%dwoz\fP) Fix reg grains test
@ \fI2018\-04\-25 00:16:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
da532aa1ac Merge pull request \fI\%#47285\fP from dwoz/core_test_fix
.IP \(bu 2
884f4c1829 Fix extra space
.IP \(bu 2
8a9027c0c9 Fix reg grains test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47290\fP: (\fI\%dwoz\fP) Run cache_master test in tmp dir (refs: \fI\%#47292\fP)
@ \fI2018\-04\-24 23:37:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
f591cff643 Merge pull request \fI\%#47290\fP from dwoz/test_cp_fix
.IP \(bu 2
5ff51affbd Run cache_master test in tmp dir
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47092\fP: (\fI\%syphernl\fP) [2018.3.0] pkg.installed breaks with virtual packages (refs: \fI\%#47250\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38838\fP: (\fI\%Zorlin\fP) Failing to remove nginx (refs: \fI\%#44455\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47250\fP: (\fI\%terminalmage\fP) Fix virtual package detection
@ \fI2018\-04\-24 19:22:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44455\fP: (\fI\%samodid\fP) Fix for \fI\%#38838\fP (refs: \fI\%#47250\fP)
.IP \(bu 2
6d323aa8f0 Merge pull request \fI\%#47250\fP from terminalmage/issue47092
.IP \(bu 2
b8630a70be Fix virtual package detection
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47225\fP: (\fI\%pruiz\fP) zfs.filesystem_present takes forever on a dataset with lots (10k+) of snapshots (refs: \fI\%#47228\fP, \fI\%#47227\fP, \fI\%#47226\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47228\fP: (\fI\%pruiz\fP) Fix issue \fI\%#47225\fP: avoid zfs.filesystem_present slowdown when dataset has lots of snapshots (2018.3 branch)
@ \fI2018\-04\-24 13:35:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47226\fP: (\fI\%pruiz\fP) Fix issue \fI\%#47225\fP: avoid zfs.filesystem_present slowdown when dataset has lots of snapshots (refs: \fI\%#47228\fP, \fI\%#47227\fP)
.IP \(bu 2
428e915d6a Merge pull request \fI\%#47228\fP from pruiz/pruiz/zfs\-dataset\-present\-slow\-2018.3
.IP \(bu 2
cfbf136ab2 Fix issue \fI\%#47225\fP: avoid zfs.filesystem_present slowdown when dataset has lots of snapshots
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46943\fP: (\fI\%Auha\fP) Slack.Engine could not start (refs: \fI\%#47262\fP, \fI\%#47109\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47262\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to targeting in Slack engine
@ \fI2018\-04\-24 13:18:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
0b836106b9 Merge pull request \fI\%#47262\fP from garethgreenaway/slack_engine_target_fix
.IP \(bu 2
bcdef641e8 Removing target and tgt_type from the cmdline that is passed along to Salt, the target is used else where and including it in the cmdline causes problem when it is passed along.  Adding an additional test to ensure we are getting the right targt.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47047\fP: (\fI\%Giandom\fP) Pillars aren\(aqt evaluated when alias is passed in Slack Engine (refs: \fI\%#47142\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47142\fP: (\fI\%garethgreenaway\fP) [2018.3] pillar and output formatting fixes to Slack engine
@ \fI2018\-04\-23 19:55:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
2ed4b38b02 Merge pull request \fI\%#47142\fP from garethgreenaway/47047_passing_pillar_to_slack_aliases
.IP \(bu 2
6f183e1d80 Initial commit for unit/engines/test_slack_engine
.IP \(bu 2
a2840fc230 Only include the rest of the cmdline if the cmd is an alias.
.IP \(bu 2
e846df7409 Fixing a bug when passing pillar values to aliases for the Slack engine.  Cleaned up the formatting of the results, color codes don\(aqt translate well into Slack output.  For any state runs, eg. highstate. apply, sls, we run the output through the highstate formater.  For anything else run it though the yaml outputer.  Running it though highstate causes errors when the output does match what the highstate output is expecting.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47245\fP: (\fI\%terminalmage\fP) Ensure we pass hexid as bytes when zmq_filtering enabled
@ \fI2018\-04\-23 16:54:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
42a0e655dc Merge pull request \fI\%#47245\fP from terminalmage/zeromq\-bytes
.IP \(bu 2
a7accc0548 Ensure we pass hexid as bytes when zmq_filtering enabled
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47242\fP: (\fI\%aesposito91\fP) PY3 fix for zeromq setsockopt
@ \fI2018\-04\-23 16:38:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
73525d1460 Merge pull request \fI\%#47242\fP from aesposito91/2018.3
.IP \(bu 2
b225351e6d Update napalm_syslog.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47117\fP: (\fI\%prashanthtuttu\fP) Napalm / Capirca Issue  (refs: \fI\%#47241\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47241\fP: (\fI\%mirceaulinic\fP) Fix the imports into the netacl execution and state modules
@ \fI2018\-04\-23 14:56:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
b78295aee9 Merge pull request \fI\%#47241\fP from cloudflare/fix\-47117
.IP \(bu 2
26c5583264 \fI\%#47117\fP: fix the napalm imports in the netacl state module
.IP \(bu 2
48396467c1 \fI\%#47117\fP: fix the napalm imports in the netacl execution module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47219\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixing a backward compatibility issue with vault module & runner
@ \fI2018\-04\-23 14:10:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
88557ea991 Merge pull request \fI\%#47219\fP from garethgreenaway/vault_backward_compatibility
.IP \(bu 2
1758081ffe When using the vault module on a 2018.3 minion against a 2017.7 master, the 2018.3 minion is expecting a verify element in the results from the Salt runner on the master.  The runner in 2017.7 did not include a verify element, which results in an error.  This change accounts for this by using the default in 2018.3 which is not to verify if not configured.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47186\fP: (\fI\%dmurphy18\fP) backport of issue 46933, updated ZFS handling to Salt 2018.3.x
@ \fI2018\-04\-23 14:07:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
370feadbd2 Merge pull request \fI\%#47186\fP from dmurphy18/zfs_backport_46933
.IP \(bu 2
283359d315 Corrected typo in comma\-seprated and 2018.3.0 \-> 2018.3.1
.IP \(bu 2
b7f8d5a22f Replace use of Fluorine with 2018.3.0 for comma\-separated warnings
.IP \(bu 2
3f30ab2ed6 ZFS backport of 46933 to 2018.3.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47217\fP: (\fI\%twangboy\fP) Remove installation of pywin32 from setup.py
@ \fI2018\-04\-23 13:32:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf3a67d11b Merge pull request \fI\%#47217\fP from twangboy/fix_setup
.IP \(bu 2
eb3d45bb08 Remove installation of pywin32 from setup.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47195\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-04\-20 19:25:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
8e21703f13 Merge pull request \fI\%#47195\fP from rallytime/merge\-2018.3
.IP \(bu 2
f90fd8c663 Test fix: file strings must be unicode in master config
.IP \(bu 2
bee4948df1 Lint: use full path for event utils function
.IP \(bu 2
120c5446b7 Update old utils paths to new utils paths
.IP \(bu 2
4718d31e53 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
65f344e371 Merge pull request \fI\%#47184\fP from Ch3LL/status_test
.INDENT 2.0
.IP \(bu 2
25a84428b8 Add status module integration modules tests for Windows
.UNINDENT
.IP \(bu 2
965600ad6c Merge pull request \fI\%#47163\fP from rallytime/jenkins\-autodoc
.INDENT 2.0
.IP \(bu 2
0039395017 Updage jenkins module autodocs to use jenkinsmod name instead
.UNINDENT
.IP \(bu 2
0a43dde5fc Merge pull request \fI\%#47185\fP from twangboy/add_tests
.INDENT 2.0
.IP \(bu 2
345daa0423 Add additional integration tests to whitelist
.UNINDENT
.IP \(bu 2
1a600bb9a4 Merge pull request \fI\%#47172\fP from dwoz/cover_without_admin
.INDENT 2.0
.IP \(bu 2
cadd759727 Use warnings to warn user
.IP \(bu 2
144c68e214 Allow non admin name based runs on windows
.UNINDENT
.IP \(bu 2
d5997d2301 Merge pull request \fI\%#47110\fP from kstreee/fix\-misusing\-of\-timeout
.INDENT 2.0
.IP \(bu 2
0624aee0ed Fixes misusing of the timeout option.
.UNINDENT
.IP \(bu 2
87ca2b4003 Merge pull request \fI\%#40961\fP from terminalmage/issue40948
.INDENT 2.0
.IP \(bu 2
6ba66cca41 Fix incorrect logic in exception check
.IP \(bu 2
fed5041c5f Make error more specific to aid in troubleshooting
.IP \(bu 2
8c67ab53b4 Fix path in log message
.IP \(bu 2
3198ca8b19 Make error more explicit when PKI dir not present for salt\-call
.UNINDENT
.IP \(bu 2
f5e63584d4 Merge pull request \fI\%#47134\fP from Ch3LL/user_win_test
.INDENT 2.0
.IP \(bu 2
e7c9bc4038 Add user integration tests for windows OS
.UNINDENT
.IP \(bu 2
da2f6a3fac Merge pull request \fI\%#47131\fP from gtmanfred/cli
.INDENT 2.0
.IP \(bu 2
1b1c29bf62 add __cli for master processes
.UNINDENT
.IP \(bu 2
9b8e6ffb8c Merge pull request \fI\%#47129\fP from rallytime/bp\-47121
.INDENT 2.0
.IP \(bu 2
11da526b21 add ImportError
.IP \(bu 2
bd0c23396c fix pip.req import error in pip 10.0.0
.UNINDENT
.IP \(bu 2
eb5ac51a48 Merge pull request \fI\%#47102\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
3dc93b310b fix tests
.IP \(bu 2
8497e08f8e fix pip module for 10.0.0
.IP \(bu 2
4c07a3d1e9 fix other tests
.IP \(bu 2
b71e3d8a04 don\(aqt allow using no_use_wheel for pip 10.0.0 or newer
.UNINDENT
.IP \(bu 2
c1dc42e67e Merge pull request \fI\%#47037\fP from twangboy/fix_dev_scripts
.INDENT 2.0
.IP \(bu 2
990a24d7ed Fix build_env scripts
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46906\fP: (\fI\%whytewolf\fP) Windows failure with PR 46541 (refs: \fI\%#47168\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47168\fP: (\fI\%gtmanfred\fP) fix metadata grain for py3 and windows
@ \fI2018\-04\-20 19:07:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
a56eb7e05d Merge pull request \fI\%#47168\fP from gtmanfred/metadata
.IP \(bu 2
396f7906e3 fix metadata grain for py3 and windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46918\fP: (\fI\%AmbicaY\fP) napalm/capirca issue (refs: \fI\%#47202\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47202\fP: (\fI\%mirceaulinic\fP) Fix \fI\%#46918\fP: add the TTL field
@ \fI2018\-04\-20 14:34:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
6135b76e2c Merge pull request \fI\%#47202\fP from cloudflare/fix\-46918
.IP \(bu 2
1e74141cc0 Fix \fI\%#46918\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47150\fP: (\fI\%srkunze\fP) [Regression] ip_to_host and SSH._expand_target require missing reverse\-lookup (refs: \fI\%#47191\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47191\fP: (\fI\%terminalmage\fP) salt\-ssh: Do not attempt to match host/ip to minion ID if reverse lookup fails
@ \fI2018\-04\-20 14:20:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
7f1115e611 Merge pull request \fI\%#47191\fP from terminalmage/issue47150
.IP \(bu 2
95a6f075cb Add debug logging when ip_to_host fails
.IP \(bu 2
45696e622b salt\-ssh: Do not attempt to match host/ip to minion ID if reverse lookup fails
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47122\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-04\-19 20:44:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
1947ffdf56 Merge pull request \fI\%#47122\fP from rallytime/merge\-2018.3
.IP \(bu 2
878fa06134 Test fix: remove tornado testing lib from class
.IP \(bu 2
a40f007962 lint: get_context is in stringutils.py now
.IP \(bu 2
3416e398c6 Update old utils paths references to use new paths
.IP \(bu 2
94c2a12be6 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
6a4c0b8a1a Merge pull request \fI\%#47108\fP from dwoz/async_test_fix
.INDENT 2.0
.IP \(bu 2
3d85e30ce5 AsyncTestCase is required for AsyncEventPublisher
.UNINDENT
.IP \(bu 2
03892eaf0b Merge pull request \fI\%#47068\fP from cachedout/catch_value_error_socket_test
.INDENT 2.0
.IP \(bu 2
7db5625632 Catch an operation on a closed socket in a test
.UNINDENT
.IP \(bu 2
1ea2885ec2 Merge pull request \fI\%#47065\fP from dwoz/jinja_test_fix
.INDENT 2.0
.IP \(bu 2
673cd31c65 Merge branch \(aq2017.7\(aq into jinja_test_fix
.UNINDENT
.IP \(bu 2
5293b5b5ca Merge pull request \fI\%#47077\fP from dwoz/test_state_fix
.INDENT 2.0
.IP \(bu 2
444da3f893 Fix py3 wart (chr vs bytesstring)
.IP \(bu 2
e8acca01c2 Fix failing state test by normalizing line endings
.UNINDENT
.IP \(bu 2
ca967de5da Merge pull request \fI\%#47067\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
f913a7859c use the recommended opennebula lookup method
.UNINDENT
.IP \(bu 2
7fddad6cd9 Merge pull request \fI\%#47064\fP from dwoz/roots_tests_fix
.INDENT 2.0
.IP \(bu 2
25fd7c0694 fix py3 wart, encode os.linesep
.IP \(bu 2
d79f1a1961 Fix fileserver roots tests
.UNINDENT
.IP \(bu 2
977c6939c4 Merge pull request \fI\%#47069\fP from cachedout/match_timeout_arg
.INDENT 2.0
.IP \(bu 2
b8990f5258 Pass the timeout variable to the CLI when calling salt in tests
.UNINDENT
.IP \(bu 2
2c4c19c622 Merge pull request \fI\%#47074\fP from dwoz/ignore_artifacts
.INDENT 2.0
.IP \(bu 2
c3941efad0 Kitchn should ignore artifacts directory
.UNINDENT
.IP \(bu 2
c484c0bd71 Merge pull request \fI\%#47055\fP from bloomberg/GH\-47000
.INDENT 2.0
.IP \(bu 2
8af3f5b874 GH\-47000: add proper handling of full_return in cmd_subset
.UNINDENT
.IP \(bu 2
f3496030cc Merge pull request \fI\%#47039\fP from twangboy/win_fix_winrm_script
.INDENT 2.0
.IP \(bu 2
6635b9003f Fix winrm powershell script
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
46fa2c04de Fix py3 os.linesep wart
.IP \(bu 2
3c565d7e54 Use salt.utils.fopen
.IP \(bu 2
aa965310f1 Clean up cruft
.IP \(bu 2
efc9866580 Jinja test fixes
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47162\fP: (\fI\%terminalmage\fP) Partial backport of \fI\%#47161\fP to 2018.3 branch
@ \fI2018\-04\-19 19:28:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47161\fP: (\fI\%terminalmage\fP) Fix failing pillar unit test (refs: \fI\%#47162\fP)
.IP \(bu 2
291cca7ed8 Merge pull request \fI\%#47162\fP from terminalmage/bp\-47161
.IP \(bu 2
d185f97a47 mocked file_roots and pillar_roots should be dicts
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47081\fP: (\fI\%sjorge\fP) file.directory with recursion fails if there are non\-ascii characters in the path (refs: \fI\%#47165\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47165\fP: (\fI\%terminalmage\fP) Make sure a str type is passed to os.walk
@ \fI2018\-04\-19 14:59:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
2ee8006da3 Merge pull request \fI\%#47165\fP from terminalmage/issue47081
.IP \(bu 2
9e29acb477 Make sure a str type is passed to os.walk
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47070\fP: (\fI\%terminalmage\fP) Use decorators for temp files/dirs in test suite
@ \fI2018\-04\-19 14:01:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
6257862bbb Merge pull request \fI\%#47070\fP from terminalmage/with_tempdir
.IP \(bu 2
048728d2b7 Remove unused imports
.IP \(bu 2
879c557264 Use decorators for temp files/dirs in test suite
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47155\fP: (\fI\%mcalmer\fP) Fix patchinstall for yumpkg
@ \fI2018\-04\-18 19:24:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
b46365614b Merge pull request \fI\%#47155\fP from mcalmer/fix\-patchinstall
.IP \(bu 2
382afba457 fix invalid string compare
.IP \(bu 2
8c19368938 provide kwargs to pkg_resource.parse_targets required to detect advisory type
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47042\fP: (\fI\%valentin2105\fP) [ERROR] Unable to manage file: \(aqutf8\(aq codec can\(aqt decode byte  (refs: \fI\%#47061\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47061\fP: (\fI\%terminalmage\fP) Fix diffing binary files in file.get_diff (refs: \fI\%#47405\fP)
@ \fI2018\-04\-18 18:52:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
13ae1a2413 Merge pull request \fI\%#47061\fP from terminalmage/issue47042
.IP \(bu 2
87f6cefea3 Rewrite flaky utf8 state to make it easier to troubleshoot
.IP \(bu 2
df6e535f05 Fix diffing binary files in file.get_diff
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47058\fP: (\fI\%terminalmage\fP) Fix calls to file.lsattr when lsattr is not installed
@ \fI2018\-04\-18 16:30:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
cba0f13cd9 Merge pull request \fI\%#47058\fP from terminalmage/lsattr
.IP \(bu 2
eeb067e910 Fix calls to file.lsattr when lsattr is not installed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46929\fP: (\fI\%noelmcloughlin\fP) 2018.3 regression file.managed.context parsing (refs: \fI\%#47104\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47104\fP: (\fI\%terminalmage\fP) yamlloader: Properly handle colons in inline dicts
@ \fI2018\-04\-18 16:22:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
b96ce23b3f Merge pull request \fI\%#47104\fP from terminalmage/issue46929
.IP \(bu 2
33bf6643cd Add additional test for plain scalars
.IP \(bu 2
508659b682 yamlloader: Properly handle colons in inline dicts
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46887\fP: (\fI\%julientravelaer\fP) ldap.managed broken with 2018.3.0 (refs: \fI\%#47029\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#46859\fP: (\fI\%cheribral\fP) pillar_ldap causing TypeError exceptions in python\-ldap with unicode objects (refs: \fI\%#47029\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47076\fP: (\fI\%terminalmage\fP) pillar_ldap: Load config options as str types
@ \fI2018\-04\-18 16:16:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47029\fP: (\fI\%terminalmage\fP) ldapmod.py/ldap3.py: Force modlist for search/modify/etc. to be str types (refs: \fI\%#47076\fP)
.IP \(bu 2
c12697b173 Merge pull request \fI\%#47076\fP from terminalmage/issue46859
.IP \(bu 2
c06c859caf pillar_ldap: Load config options as str types
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47107\fP: (\fI\%twangboy\fP) Fix issues with reg state, add tests
@ \fI2018\-04\-18 15:53:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
50bd885ec7 Merge pull request \fI\%#47107\fP from twangboy/fix_46932
.IP \(bu 2
ae8ab2ab1a Fix tests for py3, enable tearDown
.IP \(bu 2
3cf4ac1475 Add integration tests for reg state
.IP \(bu 2
cc259b146f Cast vdata to appropriate type in reg state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46909\fP: (\fI\%epelc\fP) Binary \fIcontents_pillar\fP with file.managed raises UnicodeDecodeError (refs: \fI\%#47041\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47041\fP: (\fI\%terminalmage\fP) Force null bytes to be str types
@ \fI2018\-04\-18 14:08:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
d6c59696be Merge pull request \fI\%#47041\fP from terminalmage/issue46909
.IP \(bu 2
e4182715be Special check specifically for bytes types
.IP \(bu 2
ee90dd5d95 Merge branch \(aq2018.3\(aq into issue46909
.IP \(bu 2
0e99343a7f Use the same way of defining contents in both file.managed states
.IP \(bu 2
5741d287b5 Move back to using null byte check for contents
.IP \(bu 2
8e214c9fa9 file.managed: Add test to ensure binary contents work
.IP \(bu 2
7b7dc94610 Use salt.utils.stringutils.is_binary to check if contents are binary
.IP \(bu 2
e3c969da81 PY3: Ensure binary contents work with file.managed
.IP \(bu 2
5d98a8bedd Make salt.utils.stringutils.to_binary work for bytestrings
.IP \(bu 2
1024000369 Force null bytes to be str types
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47007\fP: (\fI\%twangboy\fP) Fix some issues with the win_servermanager module
@ \fI2018\-04\-17 20:57:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
9a9f6524f8 Merge pull request \fI\%#47007\fP from twangboy/fix_46968
.IP \(bu 2
432db7c6ec Lint: Remove unused import
.IP \(bu 2
10341e8f8b Remove erroneous pop statement
.IP \(bu 2
56582f293a Remove redundant try/except block from state\(ga
.IP \(bu 2
6ad2427279 Remove unnecessary try/except blocks
.IP \(bu 2
92eeaa51bd Put some error checking in the shell command
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46943\fP: (\fI\%Auha\fP) Slack.Engine could not start (refs: \fI\%#47262\fP, \fI\%#47109\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47109\fP: (\fI\%garethgreenaway\fP) [2018.3] fixes to Slack engine
@ \fI2018\-04\-17 13:56:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
a52137ee36 Merge pull request \fI\%#47109\fP from garethgreenaway/46943_slack_engine_fixes
.IP \(bu 2
02baa76595 Fixing a bug that occurred when a comment was added to a message sent to Slack by Salt.  Also making \fIslack_engine:groups_pillar\fP optional.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47045\fP: (\fI\%tankywoo\fP) Fix ba7d00f5 for gentoo pkg.installed method
@ \fI2018\-04\-17 13:55:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c16a34c44 Merge pull request \fI\%#47045\fP from tankywoo/fix\-gentoo\-pkg\-installed
.IP \(bu 2
551f4e10cf Fix ba7d00f5 for gentoo pkg.installed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47053\fP: (\fI\%clan\fP) handle jinja error in <module> level
@ \fI2018\-04\-16 22:47:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
86c7cfef56 Merge pull request \fI\%#47053\fP from clan/jinja\-error
.IP \(bu 2
a847466946 handle jinja error in <module> level
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47062\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-04\-16 19:58:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
7bfa608e9f Merge pull request \fI\%#47062\fP from rallytime/merge\-2018.3
.IP \(bu 2
59f5880e72 lint fix
.IP \(bu 2
1ddf8c584b Update old utils files to new new utils files path
.IP \(bu 2
28a79ebba4 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
1700a10ebe Merge pull request \fI\%#46326\fP from kstreee/fix\-client\-local
.INDENT 2.0
.IP \(bu 2
0f358a9c9e Fixes a timing bug of saltnado\(aqs client local.
.UNINDENT
.IP \(bu 2
c3c00316c5 Merge pull request \fI\%#46913\fP from lomeroe/2017_7\-fix46877
.INDENT 2.0
.IP \(bu 2
369a0645ed move exception for clarity
.IP \(bu 2
32ce5bfda5 Use configparser serializer object to read psscript.ini and script.ini startup/shutdown script files.
.UNINDENT
.IP \(bu 2
9e37cfc9d6 Merge pull request \fI\%#47025\fP from terminalmage/fix\-server_id\-windows
.INDENT 2.0
.IP \(bu 2
cb0cf89ed3 Fix server_id grain in PY3 on Windows
.UNINDENT
.IP \(bu 2
2e193cfb45 Merge pull request \fI\%#47027\fP from rallytime/bp\-44508
.INDENT 2.0
.IP \(bu 2
8e72f362f4 Add priority field to support the latest capirca.
.IP \(bu 2
112f92baab Add priority field to support the latest capirca.
.UNINDENT
.IP \(bu 2
385fe2bc1e Merge pull request \fI\%#47020\fP from rallytime/bp\-46970
.INDENT 2.0
.IP \(bu 2
9373dff52b Update test_pkgrepo.py
.IP \(bu 2
13cf9eb5b1 Removing debugging.
.IP \(bu 2
a61a8593e5 Removing suse from pkgrepo comments tests.  the pkgrepo functions in SUSE pkg module do not support comments.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47066\fP: (\fI\%terminalmage\fP) Fix regression in handling of environment/saltenv
@ \fI2018\-04\-16 19:57:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
fa27e64a33 Merge pull request \fI\%#47066\fP from terminalmage/issue46979
.IP \(bu 2
5c4c0468ad Fix regression in handling of environment/saltenv
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47051\fP: (\fI\%rallytime\fP) Simplify LooseVersion check in \fI__virtual__\fP check in mac_assistive module
@ \fI2018\-04\-13 19:43:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
8761b81a69 Merge pull request \fI\%#47051\fP from rallytime/fix\-lint
.IP \(bu 2
d52b3689d9 Simplify LooseVersion check in \fI__virtual__\fP check in mac_assistive module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47057\fP: (\fI\%corywright\fP) Fix copy/paste typo in minionfs tutorial
@ \fI2018\-04\-13 19:43:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
bbb8018b55 Merge pull request \fI\%#47057\fP from corywright/fix\-minionfs\-whitelist\-docs
.IP \(bu 2
9b7ee97d12 Fix copy/paste typo in minionfs tutorial
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46931\fP: (\fI\%anlutro\fP) file.managed diff is switched when using template in salt\-ssh 2018.3 (refs: \fI\%#47046\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47046\fP: (\fI\%clan\fP) switch order of file to be diffed
@ \fI2018\-04\-13 13:40:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
d5afa4a2c5 Merge pull request \fI\%#47046\fP from clan/file_diff
.IP \(bu 2
bb58605c54 switch order of file to be diffed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46985\fP: (\fI\%OrlandoArcapix\fP) grafana4_user.present and grafana4_org.present states not working in 2018.3.0 (refs: \fI\%#47048\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47048\fP: (\fI\%OrlandoArcapix\fP) Issue46985 fix grafana4 state (refs: \fI\%#47060\fP)
@ \fI2018\-04\-13 13:34:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec9251ecd3 Merge pull request \fI\%#47048\fP from OrlandoArcapix/Issue46985\-fix\-grafana4\-state
.IP \(bu 2
259d747414 Remove accidentally added copy of a file
.IP \(bu 2
6c8c3da74d Return an empty dict instead of \(aqNone\(aq from grafana4 states
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47017\fP: (\fI\%opdude\fP) Don’t encode a unicode string
@ \fI2018\-04\-13 13:31:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
d8c4c221cf Merge pull request \fI\%#47017\fP from Unity\-Technologies/hotfix/pip_windows
.IP \(bu 2
838670f626 Don’t encode a unicode string
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46917\fP: (\fI\%boltronics\fP) mysql_grants.present broken with \fIdatabase: somedatabase.*\fP (refs: \fI\%#46919\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47019\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46919\fP to 2018.3
@ \fI2018\-04\-12 19:43:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46919\fP: (\fI\%boltronics\fP) Replace failing is and is not tests with == and != (refs: \fI\%#47019\fP)
.IP \(bu 2
5b7544eaa0 Merge pull request \fI\%#47019\fP from rallytime/bp\-46919
.IP \(bu 2
6837d6c138 Replace failing is and is not tests with == and !=
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46887\fP: (\fI\%julientravelaer\fP) ldap.managed broken with 2018.3.0 (refs: \fI\%#47029\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#46859\fP: (\fI\%cheribral\fP) pillar_ldap causing TypeError exceptions in python\-ldap with unicode objects (refs: \fI\%#47029\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47029\fP: (\fI\%terminalmage\fP) ldapmod.py/ldap3.py: Force modlist for search/modify/etc. to be str types (refs: \fI\%#47076\fP)
@ \fI2018\-04\-12 19:41:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
ac2d54d78a Merge pull request \fI\%#47029\fP from terminalmage/issue46859
.IP \(bu 2
ab6314247b ldapmod.py/ldap3.py: Force modlist for search/modify/etc. to be str types
.IP \(bu 2
7691dee4ed Add to_str option to decode funcs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46868\fP: (\fI\%tjyang\fP) 2017.7.4 to 2018.3.0 upgrade issue: Salt request timed out. The master is not responding (refs: \fI\%#46930\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46930\fP: (\fI\%dwoz\fP) Clean up bad public key headers
@ \fI2018\-04\-12 18:57:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
e6e07720fa Merge pull request \fI\%#46930\fP from dwoz/crptodomekeyfix
.IP \(bu 2
f2e484ed54 Merge branch \(aq2018.3\(aq into crptodomekeyfix
.IP \(bu 2
e1995a92ee Fix verify signature test
.IP \(bu 2
0ba32118d9 Add test for bad public key without m2crypto
.IP \(bu 2
a44c356233 Clean up bad public key headers
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46951\fP: (\fI\%Giandom\fP) Slack engine error using aliases: TypeError unhashable type (refs: \fI\%#47008\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47008\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixing aliases in slack engine
@ \fI2018\-04\-12 15:24:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
0e43becc12 Merge pull request \fI\%#47008\fP from garethgreenaway/46951_fixing_slack_engine_aliases
.IP \(bu 2
dc2a72d44f Fixing aliases in slack engine
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46947\fP: (\fI\%Giandom\fP) Slack engine groups error (refs: \fI\%#47009\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47009\fP: (\fI\%garethgreenaway\fP) [2018.3] fixes to slack engine documentation
@ \fI2018\-04\-12 15:20:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
c33de7c82d Merge pull request \fI\%#47009\fP from garethgreenaway/46947_slack_documentation_update_catch_non_dicts
.IP \(bu 2
f0fadbb4ce Fixing indention for slack documentation.  Updating try..except to ensure we catch when groups aren\(aqt dicts.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47023\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46997\fP to 2018.3
@ \fI2018\-04\-12 15:05:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46997\fP: (\fI\%LukeCarrier\fP) Fix repository (=> repository) typo in sls_build (refs: \fI\%#47023\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44638\fP: (\fI\%terminalmage\fP) Many improvements to docker network and container states (refs: \fI\%#46997\fP)
.IP \(bu 2
68d17c71f1 Merge pull request \fI\%#47023\fP from rallytime/bp\-46997
.IP \(bu 2
c2c60f4ffc Fix repository (=> repository) typo in sls_build
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47026\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-04\-12 14:39:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
9cf3c6406a Merge pull request \fI\%#47026\fP from rallytime/merge\-2018.3
.IP \(bu 2
ba70df9d62 Use msgpack utils for loads call, import msgpack for UnpackValueError
.IP \(bu 2
34a478dfe5 Update old fopen path with new utils files path
.IP \(bu 2
590c7fc13f Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
8f994e7cf9 Merge pull request \fI\%#46539\fP from jfoboss/patch\-1
.INDENT 2.0
.IP \(bu 2
6890122e41 Merge pull request \fI\%#1\fP from twangboy/pull_46539
.INDENT 2.0
.IP \(bu 2
19c3fadbe5 Fix unit test for win_ntp
.UNINDENT
.IP \(bu 2
826a8d3099 Fixing \fI\%#46504\fP
.UNINDENT
.IP \(bu 2
74d70e95a5 Merge pull request \fI\%#46999\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
791af8f6ce switch pip test package
.UNINDENT
.IP \(bu 2
8adaf7f526 Merge pull request \fI\%#46023\fP from bloomberg/parallel\-orch
.INDENT 2.0
.IP \(bu 2
0ac0b3ca29 Merge branch \(aq2017.7\(aq into parallel\-orch
.UNINDENT
.IP \(bu 2
39d65a39cf Merge pull request \fI\%#46613\fP from myinitialsarepm/fix_puppet.fact_and_puppet.facts
.INDENT 2.0
.IP \(bu 2
44ecd13abc Update tests to use cmd.run_all
.IP \(bu 2
7d7d40f541 Merge branch \(aq2017.7\(aq into fix_puppet.fact_and_puppet.facts
.IP \(bu 2
0ce1520bd0 Merge branch \(aq2017.7\(aq into fix_puppet.fact_and_puppet.facts
.IP \(bu 2
69e1f6f681 Fix puppet.fact and puppet.facts to use stdout.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
3d5e69600b address lint issues raised by @isbm
.IP \(bu 2
a9866c7a03 fix parallel mode py3 compatibility
.IP \(bu 2
6d7730864a removing prereq from test orch
.IP \(bu 2
6c8a25778f add integration test to runners/test_state to exercise parallel
.IP \(bu 2
2c86f16b39 cherry\-pick cdata KeyError prevention from \fI\%#39832\fP
.IP \(bu 2
26a96e8933 record start/stop duration for parallel processes separately
.IP \(bu 2
e4844bdf2b revisit previous join() behavior in check_requisites
.IP \(bu 2
f00a359cdf join() parallel process instead of a recursive sleep
.IP \(bu 2
6e7007a4dc add parallel support for orchestrations
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47021\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixing integration.modules.test_state_jinja_filters.StateModuleJinjaFiltersTest.test_path_which
@ \fI2018\-04\-12 13:12:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
d3be828696 Merge pull request \fI\%#47021\fP from garethgreenaway/920_state_module_jinja_filters_test_test_path_which
.IP \(bu 2
2ccf2c5fe0 Fixing test_path_which to check that the filter is available rather than results.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47022\fP: (\fI\%corywright\fP) Add auth.file module to auth documentation page
@ \fI2018\-04\-11 21:11:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
66e8445b82 Merge pull request \fI\%#47022\fP from corywright/add\-auth\-file\-module\-to\-docs
.IP \(bu 2
bd0918fc40 Add auth.file module to auth documentation page
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45774\fP: (\fI\%twangboy\fP) Fix __virtual__ issue in mac_system.py
@ \fI2018\-04\-11 14:26:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
12ecfdee93 Merge pull request \fI\%#45774\fP from twangboy/mac_add_service_util
.IP \(bu 2
5796696617 Fix tests for Py3
.IP \(bu 2
7b40218790 Fix lint, remove sentence from docstring
.IP \(bu 2
781880f0fc Add _available_services function for testing
.IP \(bu 2
6080633613 Add assert_called_with
.IP \(bu 2
1bf70b2033 Add more tests for available_services
.IP \(bu 2
b429fc3e74 Add tests for mac_utils
.IP \(bu 2
b5f67130cc Used *args and **kwargs
.IP \(bu 2
ed061617a2 Fix unicode_literal issue in mac_assistive
.IP \(bu 2
82e17e5fc8 Fix args/kwargs
.IP \(bu 2
455146500a Move some functions into mac_utils
.IP \(bu 2
125586264b Add utilsmac_service.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46953\fP: (\fI\%cskowronnek\fP) salt\-cloud azurearm [ERROR   ] There was a profile error: Parameter \(aqsubscription_id\(aq must be str. (refs: \fI\%#47012\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47012\fP: (\fI\%terminalmage\fP) Azure: ensure subscription_id is a str type
@ \fI2018\-04\-11 13:57:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
79347f108a Merge pull request \fI\%#47012\fP from terminalmage/issue46953
.IP \(bu 2
5192622a32 Azure: ensure subscription_id is a str type
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46526\fP: (\fI\%Ch3LL\fP) Add tests for new source_* minion options
@ \fI2018\-04\-10 19:56:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
6503bf8dfa Merge pull request \fI\%#46526\fP from Ch3LL/ip_conf
.IP \(bu 2
c01180ff47 Patch ZMQ versions for master_uri test
.IP \(bu 2
da38f332a5 Change comment and salt.utils.network import
.IP \(bu 2
e972ebdf1a Add for new source_* minion options
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46993\fP: (\fI\%L4rS6\fP) Fix: tuple instead of string
@ \fI2018\-04\-10 17:07:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
03907d3fce Merge pull request \fI\%#46993\fP from L4rS6/fix\-broken\-keystone\-auth/2018.3
.IP \(bu 2
e33ba1b3d5 Fix: tuple instead of string
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46990\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-04\-10 17:07:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
ffaee26540 Merge pull request \fI\%#46990\fP from rallytime/merge\-2018.3
.IP \(bu 2
ccc5bad2df Merge branch \(aq2017.7\(aq into merge\-2018.3
.INDENT 2.0
.IP \(bu 2
ba5421d988 Merge pull request \fI\%#46991\fP from gtmanfred/windows
.INDENT 2.0
.IP \(bu 2
98588c1dc5 use saltstack salt\-jenkins
.UNINDENT
.UNINDENT
.IP \(bu 2
2f1cf3e511 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
00c4067585 Merge pull request \fI\%#46975\fP from gtmanfred/windows
.INDENT 2.0
.IP \(bu 2
1f69c0d7f8 make sure windows outputs xml junit files
.IP \(bu 2
4a2ec1bbb3 support new versions of winrm\-fs
.IP \(bu 2
b9efec8526 remove libnacl on windows
.IP \(bu 2
2edd5eaf9e fix path
.IP \(bu 2
b03e272e44 windows work
.UNINDENT
.IP \(bu 2
3cf2353e41 Merge pull request \fI\%#46945\fP from vutny/doc\-faq\-fix\-jinja
.INDENT 2.0
.IP \(bu 2
bfdf54e61d [DOC] Fix Jinja block in FAQ page
.UNINDENT
.IP \(bu 2
fc2f728665 Merge pull request \fI\%#46925\fP from terminalmage/fix\-file.patch\-docstring
.INDENT 2.0
.IP \(bu 2
97695657f0 Remove reference to directory support in file.patch state
.UNINDENT
.IP \(bu 2
eef6c518e1 Merge pull request \fI\%#46900\fP from rallytime/bp\-46801
.INDENT 2.0
.IP \(bu 2
6a41e8b457 rename jenkins to jenkinsmod
.UNINDENT
.IP \(bu 2
71839b0303 Merge pull request \fI\%#46899\fP from rallytime/bp\-45116
.INDENT 2.0
.IP \(bu 2
b92f908da4 fix adding parameters to http.query from sdb yaml
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46339\fP: (\fI\%DmitryKuzmenko\fP) SSH State test failures
@ \fI2018\-04\-10 17:06:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
a34b92ae82 Merge pull request \fI\%#46339\fP from DSRCorporation/bugs/ssh_state_test_failures
.IP \(bu 2
bd98c49dc7 Merge branch \(aq2018.3\(aq into bugs/ssh_state_test_failures
.IP \(bu 2
6fdc458a7f Increase timeout for run_run in ShellCase
.IP \(bu 2
8e60cccdfb Give background task more chance to start.
.IP \(bu 2
e0b6878fac One more useful assert for better test results.
.IP \(bu 2
92a6c43c73 More logging and assertion fixes. Extended ssh ops timeout.
.IP \(bu 2
6ebdd17ac4 Advanced logging in the failing SSH State tests.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46989\fP: (\fI\%Ch3LL\fP) Fix redis cache log debug line
@ \fI2018\-04\-10 16:35:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
9924100c44 Merge pull request \fI\%#46989\fP from Ch3LL/redis_log
.IP \(bu 2
6160bc06c6 Fix redis cache log debug line
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46834\fP: (\fI\%oeuftete\fP) strftime filter not found in 2018.3.0 (refs: \fI\%#46848\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#46668\fP: (\fI\%anlutro\fP) Jinja2 filter strftime stopped working in salt\-ssh 2018.3 (refs: \fI\%#46848\fP, \fI\%#46744\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46848\fP: (\fI\%garethgreenaway\fP) [2018.8] salt\-ssh jinja filters tests
@ \fI2018\-04\-10 16:19:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
c6431936cb Merge pull request \fI\%#46848\fP from garethgreenaway/testing_jinja_filters_avaiable_via_salt_ssh
.IP \(bu 2
5fcda3eff8 Merge branch \(aq2018.3\(aq into testing_jinja_filters_avaiable_via_salt_ssh
.IP \(bu 2
0adfee9b11 Updating a couple tests.  Fixing check_whitelist_blacklist to work with PY3 when non\-iterables are passed.  Adding warning about lst_avg results being wrong and future updates in Neon.
.IP \(bu 2
f3f42146ca Removing expected from strftime and hashsum tests since the results are always different and we are only concerned about the filter being available.
.IP \(bu 2
860234c045 Fixing lint.
.IP \(bu 2
0891c6b580 fixing docstring
.IP \(bu 2
c8945e4b2e cleaning up some imports.
.IP \(bu 2
0599759e5b cleaning up some test doc strings.
.IP \(bu 2
dceda5eb88 Moving all jinja filter tests into support/jinja_filters.py.  Updaitng integration/ssh/test_jinja_filters.py to use those tests.  Adding integration/modules/test_state_jinja_filters.py to also use the common jinja filter tests.
.IP \(bu 2
07d7e3ca01 Adding a new integration test and corresponding state files to test availability of jinja filters when using salt\-ssh.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46880\fP: (\fI\%liquidgecka\fP) rabbitmq_policy broken in 2018.3.0 (refs: \fI\%#46973\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46973\fP: (\fI\%rallytime\fP) New \(dqapply_to\(dq kwarg in rabbitmq module should be added at the end
@ \fI2018\-04\-10 14:42:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41233\fP: (\fI\%dnABic\fP) added parameter apply_to for rabbitmq policy (refs: \fI\%#46973\fP)
.IP \(bu 2
fbbcb7584c Merge pull request \fI\%#46973\fP from rallytime/fix\-46880
.IP \(bu 2
8ce21f982c New \(dqapply_to\(dq kwarg in rabbitmq module should be added at the end
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46934\fP: (\fI\%d601\fP) GPG encrypted binary data in pillars breaks in 2018.3.0 (refs: \fI\%#46966\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46966\fP: (\fI\%terminalmage\fP) Fix traceback when attempting to decode binary data to unicode
@ \fI2018\-04\-10 14:08:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
58f59cfbff Merge pull request \fI\%#46966\fP from terminalmage/issue46934
.IP \(bu 2
df43ffdb8f salt.payload.Serial: fix traceback when unpacking binary blob
.IP \(bu 2
40a49358c9 gpg renderer: fix tranceback when decrypted ciphertext contains binary data
.IP \(bu 2
17a88f6a71 Include exc_info in pillar render errors to aid in troubleshooting
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46881\fP: (\fI\%SynPrime\fP) Cron.file \- source file not found (refs: \fI\%#46944\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46944\fP: (\fI\%garethgreenaway\fP) [2018.3] cron.file with salt source URL
@ \fI2018\-04\-10 13:34:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
e33e792e2a Merge pull request \fI\%#46944\fP from garethgreenaway/46881_Cron_file_source_file_not_found
.IP \(bu 2
438aafeb03 Adding kwargs to calls into file module functions
.IP \(bu 2
14d12b1d6b Remove unused imports.  Gating tests so they do not run on Windows
.IP \(bu 2
623d96f21a Adding dummy cron file for integration/states/test_cron
.IP \(bu 2
c8e01871d6 Adding an integration test to test cron.file.
.IP \(bu 2
ddc55d8f9b Fixing bug that made cron.file unable to use a file via a Salt URL.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46937\fP: (\fI\%gtmanfred\fP) enable_ssh_minions does not work with subset yet
@ \fI2018\-04\-07 02:54:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
08e8782f76 Merge pull request \fI\%#46937\fP from gtmanfred/2018.3
.IP \(bu 2
3fb75e903c enable_ssh_minions does not work with subset yet
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46936\fP: (\fI\%gtmanfred\fP) don\(aqt copy __pycache__ or .pyc files for kitchen
@ \fI2018\-04\-06 19:15:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
ac4e7cd73f Merge pull request \fI\%#46936\fP from gtmanfred/2018.3
.IP \(bu 2
91474878fa don\(aqt copy __pycache__ or .pyc files for kitchen
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46659\fP: (\fI\%stamak\fP) [salt\-cloud] [new oxygen openstack driver ] no public_ips and floating_ips in salt\-cloud output (refs: \fI\%#46912\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46912\fP: (\fI\%gtmanfred\fP) pull latest vm data after building for openstack shade driver
@ \fI2018\-04\-06 13:46:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
8105fd9715 Merge pull request \fI\%#46912\fP from gtmanfred/openstack
.IP \(bu 2
5ef538f8ad pull latest vm data after building for openstack shade driver
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46908\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-04\-05 21:27:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
735ea12960 Merge pull request \fI\%#46908\fP from rallytime/merge\-2018.3
.IP \(bu 2
102e966512 Remove redundant section in log setup
.IP \(bu 2
177c686b52 Update old utils paths to new utils paths
.IP \(bu 2
0a297e7319 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
d0f5b43753 Merge pull request \fI\%#44926\fP from frogunder/whitelisted_acl
.INDENT 2.0
.IP \(bu 2
18e460fc30 Merge branch \(aq2017.7\(aq into whitelisted_acl
.IP \(bu 2
1ad4d7d988 fix assert errors
.IP \(bu 2
e6a56016df update test
.IP \(bu 2
19a2244cb7 whitelist_acl_test
.UNINDENT
.IP \(bu 2
7d822f9cec Merge pull request \fI\%#46464\fP from gtmanfred/orchestration
.INDENT 2.0
.IP \(bu 2
637cdc6b7b fix pylint
.IP \(bu 2
0151013ddb document \fIcli\fP option for cmd_subset
.IP \(bu 2
4a3ed6607d add test for subset in orchestration
.IP \(bu 2
3112359dd6 fix salt subset in orchestrator
.UNINDENT
.IP \(bu 2
805ed1c964 Merge pull request \fI\%#46879\fP from dwoz/cloudtestfix
.INDENT 2.0
.IP \(bu 2
dc54fc53c3 Fix multiple typos causing tests to fail
.UNINDENT
.IP \(bu 2
f70f6de282 Merge pull request \fI\%#46647\fP from twangboy/win_fix_test_grains
.INDENT 2.0
.IP \(bu 2
c179388b0e Fix the tear down function in integration.modules.test_grains.GrainsAppendTestCase
.UNINDENT
.IP \(bu 2
91c078ce12 Merge pull request \fI\%#46756\fP from nages13/bugfix\-grain\-virtual_subtype
.INDENT 2.0
.IP \(bu 2
781f5030a4 Merge branch \(aqbugfix\-grain\-virtual_subtype\(aq of \fI\%https://github.com/nages13/salt\fP into bugfix\-grain\-virtual_subtype
.INDENT 2.0
.IP \(bu 2
cd1ac4b7f9 Merge branch \(aq2017.7\(aq into bugfix\-grain\-virtual_subtype
.IP \(bu 2
0ace76c0e7 Merge branch \(aq2017.7\(aq into bugfix\-grain\-virtual_subtype
.IP \(bu 2
9eb6f5c0d0 Merge branch \(aq2017.7\(aq into bugfix\-grain\-virtual_subtype
.IP \(bu 2
73d6d9d365 Merge branch \(aq2017.7\(aq into bugfix\-grain\-virtual_subtype
.IP \(bu 2
a4a17eba6a Merge branch \(aq2017.7\(aq into bugfix\-grain\-virtual_subtype
.IP \(bu 2
bf5034dbdb Merge branch \(aq2017.7\(aq into bugfix\-grain\-virtual_subtype
.IP \(bu 2
8d12770951 Merge branch \(aq2017.7\(aq into bugfix\-grain\-virtual_subtype
.UNINDENT
.IP \(bu 2
7e704c0e81 Moved down container check code below hypervisors to validate containers type running in virtual environment. Fixes \fI\%#46754\fP & \fI\%#43405\fP
.IP \(bu 2
710f74c4a6 fix grains[\(aqvirtual_subtype\(aq] to show Docker on xen kernels
.UNINDENT
.IP \(bu 2
058bbed221 Merge pull request \fI\%#46799\fP from garethgreenaway/46762_prereq_shenanigans_tests
.INDENT 2.0
.IP \(bu 2
13875e78cf Fixing documentation string for test.
.IP \(bu 2
3d288c44d4 Fixing test documentation
.IP \(bu 2
6cff02ef6a Adding tests for \fI\%#46788\fP
.UNINDENT
.IP \(bu 2
d9770bf3f8 Merge pull request \fI\%#46867\fP from terminalmage/unicode\-logging\-normalization
.INDENT 2.0
.IP \(bu 2
7652688e83 Backport string arg normalization to 2017.7 branch
.UNINDENT
.IP \(bu 2
9eb98b1f6e Merge pull request \fI\%#46770\fP from twangboy/fix_46433
.INDENT 2.0
.IP \(bu 2
89af0a6222 Merge branch \(aq2017.7\(aq into fix_46433
.IP \(bu 2
67b4697578 Remove unused import (ling)
.IP \(bu 2
9302fa5ab0 Clean up code comments
.IP \(bu 2
b383b9b330 Change the order of SID Lookup
.UNINDENT
.IP \(bu 2
9c776cffb7 Merge pull request \fI\%#46839\fP from gtmanfred/tupletarget
.INDENT 2.0
.IP \(bu 2
3b7208ce27 match tuple for targets as well
.UNINDENT
.IP \(bu 2
7db251dc11 Merge pull request \fI\%#46845\fP from rallytime/bp\-46817
.INDENT 2.0
.IP \(bu 2
36a0f6d8ca address filehandle/event leak in async run_job invocations
.UNINDENT
.IP \(bu 2
e3d17ab7bc Merge pull request \fI\%#46847\fP from dwoz/missing\-strdup
.INDENT 2.0
.IP \(bu 2
55845f4846 strdup from libc is not available on windows
.UNINDENT
.IP \(bu 2
f2dd79f9c4 Merge pull request \fI\%#46776\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
edc1059ee0 fix shrinking list in for loop bug
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46853\fP: (\fI\%terminalmage\fP) Add back date_format filter
@ \fI2018\-04\-05 20:33:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
9a47afc33b Merge pull request \fI\%#46853\fP from terminalmage/date_format_filter
.IP \(bu 2
266d13a665 Add back date_format filter
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46882\fP: (\fI\%jasperla\fP) Backport \fI\%#46280\fP \fI\%#46849\fP \fI\%#46852\fP to 2018.3
@ \fI2018\-04\-05 14:29:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46852\fP: (\fI\%jasperla\fP) fix creating a nic tag on a link with double 0 in the MAC (refs: \fI\%#46882\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46849\fP: (\fI\%jasperla\fP) Unbreak creating etherstubs on SmartOS (refs: \fI\%#46882\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46280\fP: (\fI\%jasperla\fP) Remove unneeded checks for binaries in SmartOS modules (refs: \fI\%#46882\fP)
.IP \(bu 2
a064a3e695 Merge pull request \fI\%#46882\fP from jasperla/smartos/backports
.IP \(bu 2
47a66975ff fix creating a nic tag on a link with double 0 in the MAC
.IP \(bu 2
a3cb0e576e Unbreak creating etherstubs on SmartOS
.IP \(bu 2
e703254990 Remove unneeded checks for binaries in SmartOS modules
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46873\fP: (\fI\%terminalmage\fP) Attempt UTF\-8 first when decoding/encoding
@ \fI2018\-04\-05 14:16:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
4e5e291c99 Merge pull request \fI\%#46873\fP from terminalmage/utf8\-first
.IP \(bu 2
cf28eb74aa Don\(aqt log command when output_loglevel == \(aqquiet\(aq
.IP \(bu 2
f59cee28db Remove hacky workarounds to get encode/decode tests to pass on Windows
.IP \(bu 2
76e5d81bb4 Remove hacky workaround to get Windows to decode deserialized data properly
.IP \(bu 2
0b5729e58a Remove hacky workaround to get git state/exec module to work properly on Windows
.IP \(bu 2
22ff48518f Attempt UTF\-8 first when decoding/encoding
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43499\fP: (\fI\%tyeapple\fP) zmq setsockopt need to adapt python3 (refs: \fI\%#46874\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46878\fP: (\fI\%terminalmage\fP) Backport \fI\%#46874\fP to 2018.3
@ \fI2018\-04\-05 13:26:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46874\fP: (\fI\%johnj\fP) Use bytestrings for PY3 compatibility when running setsockopt for zmq.SUBSCRIBE (refs: \fI\%#46878\fP)
.IP \(bu 2
1518762465 Merge pull request \fI\%#46878\fP from terminalmage/bp\-46874
.IP \(bu 2
d9511d04d4 \fI\%#43499\fP, zmq setsockopt need to adapt python3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46862\fP: (\fI\%kivoli\fP) Setting locale.system fails in 2018.3 (refs: \fI\%#47280\fP, \fI\%#46869\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46869\fP: (\fI\%gtmanfred\fP) Always return dictionary for _localectl_status
@ \fI2018\-04\-05 13:25:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
67894e3ee9 Merge pull request \fI\%#46869\fP from gtmanfred/2018.3
.IP \(bu 2
1496e985f7 fix pylint
.IP \(bu 2
75425dfd20 fix tests for localemod
.IP \(bu 2
2d7c7b5e33 Always return dictionary for _localectl_status
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46870\fP: (\fI\%mirceaulinic\fP) Correct the documentation for two new proxy modules
@ \fI2018\-04\-04 21:48:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
58c8ff18e2 Merge pull request \fI\%#46870\fP from cloudflare/proxy\-doc
.IP \(bu 2
f4b6184476 Corect and add the cimc proxy module to autodoc
.IP \(bu 2
a99bc202b9 Correct & add Panos to autodoc
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46729\fP: (\fI\%terminalmage\fP) Performance improvement/error catching in expr_match
@ \fI2018\-04\-04 20:25:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
d7e4b9d755 Merge pull request \fI\%#46729\fP from terminalmage/expr_match
.IP \(bu 2
70cfafe299 Add test case
.IP \(bu 2
250039b11f Restore original variable name
.IP \(bu 2
ae0f112a49 Log an exception when non\-string val/expr passed to expr_match
.IP \(bu 2
dac42a672b Performance improvement/error catching in expr_match
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46872\fP: (\fI\%terminalmage\fP) Backport \fI\%#46863\fP to 2018.3
@ \fI2018\-04\-04 19:04:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46863\fP: (\fI\%TamCore\fP) fixed top function which was broken since commit 002aa88a97e (refs: \fI\%#46872\fP)
.IP \(bu 2
e0b383afb5 Merge pull request \fI\%#46872\fP from terminalmage/bp\-46863
.IP \(bu 2
be284e5b99 Add skipIf when older mock present
.IP \(bu 2
db8faaee56 Add unit tests for ext_nodes master_tops module
.IP \(bu 2
ee437f7cbf fixed top function which was broken since commit 002aa88a97e
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46850\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-04\-04 18:07:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
5c76d98d1a Merge pull request \fI\%#46850\fP from rallytime/merge\-2018.3
.IP \(bu 2
a0fcd5c053 Fix test_cp failure: forgot to add tgt to test when @with_tempfile is present
.IP \(bu 2
d0202cab72 Resolve bad merge: there should only be one test_get_file_from_env_in_url test
.IP \(bu 2
e28f71b418 Lint: use full salt utils path
.IP \(bu 2
4ad50bbdee Update old utils paths to new paths
.IP \(bu 2
893196d3e6 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
1941426218 Merge pull request \fI\%#46838\fP from gtmanfred/npm
.INDENT 2.0
.IP \(bu 2
bff61dd291 use http registry for npm
.UNINDENT
.IP \(bu 2
e544254e7b Merge pull request \fI\%#46823\fP from rallytime/fix\-42312
.INDENT 2.0
.IP \(bu 2
dafa820f93 Improve __virtual__ checks in sensehat module
.UNINDENT
.IP \(bu 2
37f6d2de35 Merge pull request \fI\%#46641\fP from skizunov/develop3
.INDENT 2.0
.IP \(bu 2
c624aa4827 Make LazyLoader thread safe
.UNINDENT
.IP \(bu 2
989508b100 Merge pull request \fI\%#46837\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
8522c1d634 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
3e844ed1df Merge pull request \fI\%#46739\fP from rallytime/2016.11_update_version_doc
.INDENT 2.0
.IP \(bu 2
4d9fc5cc0f Update release versions for the 2016.11 branch
.UNINDENT
.UNINDENT
.IP \(bu 2
307e7f35f9 Merge pull request \fI\%#46740\fP from rallytime/2017.7_update_version_doc
.INDENT 2.0
.IP \(bu 2
7edf98d224 Update 2018.3.0 information and move branch from \(dqlatest\(dq to \(dqprevious\(dq
.IP \(bu 2
5336e866ac Update release versions for the 2017.7 branch
.UNINDENT
.IP \(bu 2
ebf5dd276f Merge pull request \fI\%#46783\fP from twangboy/fix_46680
.INDENT 2.0
.IP \(bu 2
da5ce25ef3 Fix unit tests on Linux
.IP \(bu 2
b7f4f377cd Add space I removed
.IP \(bu 2
f1c68a09b5 Fix network.managed test=True on Windows
.UNINDENT
.IP \(bu 2
f652f25cc1 Merge pull request \fI\%#46821\fP from rallytime/fix\-mantest\-failures
.INDENT 2.0
.IP \(bu 2
209a8029c3 Fix the new test failures from the mantest changes
.UNINDENT
.IP \(bu 2
c460f62081 Merge pull request \fI\%#46800\fP from lomeroe/2017_7\-46627
.INDENT 2.0
.IP \(bu 2
2bee383e9d correct create list item value names if the valuePrefix attribute does not exist on the list item, the value is the value name, other wise, the valuename a number with the valuePrefix prepended to it
.UNINDENT
.IP \(bu 2
df26f2641e Merge pull request \fI\%#46675\fP from dwoz/inspectlib\-tests
.INDENT 2.0
.IP \(bu 2
d39f4852d8 Handle non\-zero status exception
.IP \(bu 2
83c005802b Handle cases where git can not be found
.IP \(bu 2
628b87d5c4 Skip test when git symlinks are not configured
.UNINDENT
.IP \(bu 2
4083e7c460 Merge pull request \fI\%#46815\fP from terminalmage/bp\-46809
.INDENT 2.0
.IP \(bu 2
71d5601507 Fix sharedsecret authentication
.UNINDENT
.IP \(bu 2
3bac9717f4 Merge pull request \fI\%#46769\fP from dwoz/wincloudtest
.INDENT 2.0
.IP \(bu 2
eabc234e5d Fix config override name
.IP \(bu 2
5c22a0f88d Use aboslute imports
.IP \(bu 2
810042710d Set default cloud test timeout back to 500 seconds
.IP \(bu 2
5ac89ad307 Use winrm_verify_ssl option causing tests to pass
.IP \(bu 2
71858a709c allow not verifying ssl winrm saltcloud
.IP \(bu 2
ba5f11476c Adding windows minion tests for salt cloud
.UNINDENT
.IP \(bu 2
f1be939763 Merge pull request \fI\%#46786\fP from twangboy/fix_46757
.INDENT 2.0
.IP \(bu 2
b0053250ff Remove int(), just return \-1
.IP \(bu 2
7d56126d74 Fixes some lint
.IP \(bu 2
49b3e937da Return int(\-1) when pidfile contains invalid data
.UNINDENT
.IP \(bu 2
89bf24b15c Merge pull request \fI\%#46814\fP from terminalmage/bp\-46772
.INDENT 2.0
.IP \(bu 2
a9f26f2ab8 avoid breaking if AutoRemove is not found
.IP \(bu 2
97779c965d fix container removal if auto_remove was enabled
.UNINDENT
.IP \(bu 2
5ea4ffbdb6 Merge pull request \fI\%#46813\fP from terminalmage/event\-debug\-log
.INDENT 2.0
.IP \(bu 2
5d6de3a2eb Get rid of confusing debug logging
.UNINDENT
.IP \(bu 2
e533b7182d Merge pull request \fI\%#46766\fP from twangboy/win_fix_test_git
.INDENT 2.0
.IP \(bu 2
5afc66452c Remove unused/redundant imports
.IP \(bu 2
88fd72c52c Use with_tempfile decorator where possible
.UNINDENT
.IP \(bu 2
69d450db84 Merge pull request \fI\%#46778\fP from terminalmage/salt\-jenkins\-906
.INDENT 2.0
.IP \(bu 2
bbfd35d3ea Replace flaky SPM man test
.UNINDENT
.IP \(bu 2
c935ffb740 Merge pull request \fI\%#46788\fP from garethgreenaway/46762_prereq_shenanigans
.INDENT 2.0
.IP \(bu 2
fa7aed6424 Ensure failed tags are added to self.pre.
.UNINDENT
.IP \(bu 2
395b7f8fdc Merge pull request \fI\%#46655\fP from dwoz/pyobjects\-46350
.INDENT 2.0
.IP \(bu 2
5aabd442f2 Fix up import and docstring syntax
.IP \(bu 2
62d64c9230 Fix missing import
.IP \(bu 2
18b1730320 Skip test that requires pywin32 on *nix platforms
.IP \(bu 2
45dce1a485 Add reg module to globals
.IP \(bu 2
09f9322981 Fix pep8 wart
.IP \(bu 2
73d06f664b Fix linter error
.IP \(bu 2
009a8f56ea Fix up environ state tests for Windows
.IP \(bu 2
b4be10b8fc Fixing cleanUp method to restore environment
.UNINDENT
.IP \(bu 2
af45c49c42 Merge pull request \fI\%#46632\fP from dwoz/file\-recurse\-36802
.INDENT 2.0
.IP \(bu 2
44db77ae79 Fix lint errors and typo
.IP \(bu 2
cb5619537f Only change what is essential for test fix
.IP \(bu 2
eb822f5a12 Fix file.recurse w/ clean=True \fI\%#36802\fP
.UNINDENT
.IP \(bu 2
6e9f504ed1 Merge pull request \fI\%#46751\fP from folti/2017.7
.INDENT 2.0
.IP \(bu 2
7058f10381 same top merging strategy works again
.UNINDENT
.IP \(bu 2
d3623e0815 Merge pull request \fI\%#46691\fP from Ch3LL/win_group_test
.INDENT 2.0
.IP \(bu 2
7cda825e90 Add groupadd module integration tests for Windows
.UNINDENT
.IP \(bu 2
14ab50d3f4 Merge pull request \fI\%#46696\fP from dwoz/win_test_client
.INDENT 2.0
.IP \(bu 2
ec4634fc06 Better explanation in doc strings
.IP \(bu 2
d9ae2abb34 Fix splling in docstring
.IP \(bu 2
b40efc5db8 Windows test client fixes
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46851\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46844\fP to 2018.3
@ \fI2018\-04\-04 18:04:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46844\fP: (\fI\%UtahDave\fP) Fix warning format in 2018.3.0 release notes (refs: \fI\%#46851\fP)
.IP \(bu 2
b808ba7049 Merge pull request \fI\%#46851\fP from rallytime/bp\-46844
.IP \(bu 2
ab2ccea1af Quick grammar fix in 2018.3.0 release notes
.IP \(bu 2
af7bad3c7f Fix warning format in 2018.3.0 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46864\fP: (\fI\%femnad\fP) Attribute Error When Invoking Vault Module Method (refs: \fI\%#46865\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46865\fP: (\fI\%femnad\fP) Fix Log Line for Vault Token Generation Debug Line
@ \fI2018\-04\-04 14:52:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea56778e03 Merge pull request \fI\%#46865\fP from femnad/fix\-log\-in\-vault\-runner
.IP \(bu 2
01a5b88e7b Fix Log Line for Vault Token Generation Debug Line
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46836\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.0rc1 to 2018.3
@ \fI2018\-04\-03 16:54:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
a0e168ccee Merge pull request \fI\%#46836\fP from rallytime/merge\-2018.3
.IP \(bu 2
e75ba1f502 Merge branch \(aq2018.3.0rc1\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
39235715e6 Merge pull request \fI\%#46792\fP from damon\-atkins/patch\-1
.IP \(bu 2
db5b9464e6 provided an example
.IP \(bu 2
41e3e1e253 Update windows information in release notes
.IP \(bu 2
99447fbf49 Added more windows information
.IP \(bu 2
d4241006f2 Update 2018.3.0.rst Windows Items, Group topics
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46808\fP: (\fI\%ezh\fP) Sharedsecret authentication is broken (refs: \fI\%#46809\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46809\fP: (\fI\%ezh\fP) Fix sharedsecret authentication (refs: \fI\%#46815\fP)
@ \fI2018\-04\-03 16:53:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
4a358217a0 Merge pull request \fI\%#46809\fP from ezh/2018.3\-sharedsecret
.IP \(bu 2
20db8f03f7 Merge branch \(aq2018.3\(aq into 2018.3\-sharedsecret
.IP \(bu 2
9df6d18ec7 Fix sharedsecret authentication
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46820\fP: (\fI\%rallytime\fP) [2018.3] Update the latest release information for docs
@ \fI2018\-04\-03 14:36:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
1519d7d895 Merge pull request \fI\%#46820\fP from rallytime/2018.3_update_version_doc
.IP \(bu 2
274f8ee0dd [2018.3] Update the latest release information for docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46731\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46024\fP to 2018.3
@ \fI2018\-04\-02 19:00:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46024\fP: (\fI\%zmedico\fP) Trivial bug fixes for tagify and fire_args functions (refs: \fI\%#46731\fP)
.IP \(bu 2
07f1141722 Merge pull request \fI\%#46731\fP from rallytime/bp\-46024
.IP \(bu 2
ee4ee5b619 fire_args: fix UnboundLocalError: local variable \(aqtag\(aq
.IP \(bu 2
4ce2c21824 tagify: handle integer suffix list
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46779\fP: (\fI\%anlutro\fP) salt\-ssh 2018.3 states with \(dqrunas\(dq fail with \(dqEnvironment could not be retrieved for User\(dq (refs: \fI\%#46796\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46796\fP: (\fI\%terminalmage\fP) Fix regression introduced in merge\-forward
@ \fI2018\-04\-02 18:10:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46503\fP: (\fI\%psyer\fP) Fixes stdout user environment corruption (refs: \fI\%#46796\fP)
.IP \(bu 2
4f31c1062d Merge pull request \fI\%#46796\fP from terminalmage/issue46779
.IP \(bu 2
f8f9d045ac Add regression test
.IP \(bu 2
e0e4e19ba3 Include extra troubleshooting information
.IP \(bu 2
dcb0c67309 Fix regression introduced in merge\-forward
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46690\fP: (\fI\%dincamihai\fP) Fix unicode handling in pkg.info_installed
@ \fI2018\-03\-29 14:10:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
4609a7dd85 Merge pull request \fI\%#46690\fP from dincamihai/2018.3
.IP \(bu 2
980adf8253 Fix unicode handling in pkg.info_installed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46746\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-03\-28 21:13:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
e5b3c8fa91 Merge pull request \fI\%#46746\fP from rallytime/merge\-2018.3
.IP \(bu 2
e8864b7b0b Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
1222bdbc00 Merge pull request \fI\%#46732\fP from rallytime/bp\-46032
.INDENT 2.0
.IP \(bu 2
bf0b962dc0 Workaround python bug in traceback.format_exc()
.UNINDENT
.IP \(bu 2
50fe1e9480 Merge pull request \fI\%#46749\fP from vutny/doc\-deprecate\-copr
.INDENT 2.0
.IP \(bu 2
a1cc55da3d [DOC] Remove mentions of COPR repo from RHEL installation page
.UNINDENT
.IP \(bu 2
bd1e8bcc7d Merge pull request \fI\%#46734\fP from terminalmage/busybox
.INDENT 2.0
.IP \(bu 2
6502b6b4ff Make busybox image builder work with newer busybox releases
.UNINDENT
.IP \(bu 2
c09c6f819c Merge pull request \fI\%#46742\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
fd0e649d1e only use npm test work around on newer versions
.UNINDENT
.IP \(bu 2
3b6d5eca88 Merge pull request \fI\%#46743\fP from Ch3LL/mac_auth
.INDENT 2.0
.IP \(bu 2
4f1c42c0e3 Workaround getpwnam in auth test for MacOSX
.UNINDENT
.UNINDENT
.IP \(bu 2
d0278345fc Update old utils paths to new utils paths
.IP \(bu 2
e312efb5e7 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
b548a3e742 Merge pull request \fI\%#46171\fP from amaclean199/fix_mysql_grants_comparison
.INDENT 2.0
.IP \(bu 2
97db3d9766 Merge branch \(aq2017.7\(aq into fix_mysql_grants_comparison
.IP \(bu 2
0565b3980e Merge branch \(aq2017.7\(aq into fix_mysql_grants_comparison
.IP \(bu 2
8af407173d Merge branch \(aq2017.7\(aq into fix_mysql_grants_comparison
.IP \(bu 2
00d13f05c4 Fix mysql grant comparisons by stripping both of escape characters and quotes. Fixes \fI\%#26920\fP
.UNINDENT
.IP \(bu 2
554400e067 Merge pull request \fI\%#46709\fP from vutny/doc\-faq\-minion\-master\-restart
.INDENT 2.0
.IP \(bu 2
d0929280fc [DOC] Update FAQ about Salt self\-restarting
.UNINDENT
.IP \(bu 2
3f21e9cc65 Merge pull request \fI\%#46503\fP from psyer/fix\-cmd\-run\-env\-corrupt
.INDENT 2.0
.IP \(bu 2
e8582e80f2 Python 3\-compatibility fix to unit test
.IP \(bu 2
27f651906d Merge pull request \fI\%#1\fP from terminalmage/fix\-cmd\-run\-env\-corrupt
.INDENT 2.0
.IP \(bu 2
172d3b2e04 Allow cases where no marker was found to proceed without raising exception
.IP \(bu 2
35ad828ab8 Simplify the marker parsing logic
.UNINDENT
.IP \(bu 2
a09f20ab45 fix repr for the linter
.IP \(bu 2
4ee723ac0f Rework how errors are output
.IP \(bu 2
dc283940e0 Merge branch \(aq2017.7\(aq into fix\-cmd\-run\-env\-corrupt
.IP \(bu 2
a91926561f Fix linting problems
.IP \(bu 2
e8d3d017f9 fix bytes or str in find command
.IP \(bu 2
0877cfc38f Merge branch \(aq2017.7\(aq into fix\-cmd\-run\-env\-corrupt
.IP \(bu 2
86176d1252 Merge branch \(aq2017.7\(aq into fix\-cmd\-run\-env\-corrupt
.IP \(bu 2
3a7cc44ade Add python3 support for byte encoded markers
.IP \(bu 2
09048139c7 Do not show whole env in error
.IP \(bu 2
ed94700255 fix missing raise statement
.IP \(bu 2
15868bc88c Fixes stdout user environment corruption
.UNINDENT
.IP \(bu 2
ac2a6616a7 Merge pull request \fI\%#46432\fP from twangboy/win_locales_utf8
.INDENT 2.0
.IP \(bu 2
affa35c30d Revert passing encoding
.IP \(bu 2
a0ab27ef15 Merge remote\-tracking branch \(aqdw/win_locales_utf8\(aq into win_locales_utf8
.INDENT 2.0
.IP \(bu 2
9f95c50061 Use default SLS encoding, fall back to system encoding
.IP \(bu 2
6548d550d0 Use salt.utils.to_unicode
.IP \(bu 2
8c0164fb63 Add ability to specify encoding in sdecode
.IP \(bu 2
2e7985a81c Default to utf\-8 on Windows
.UNINDENT
.IP \(bu 2
8017860dcc Use salt.utils.to_unicode
.IP \(bu 2
c10ed26eab Add ability to specify encoding in sdecode
.IP \(bu 2
8d7e2d0058 Default to utf\-8 on Windows
.UNINDENT
.IP \(bu 2
fadc5e4ba4 Merge pull request \fI\%#46669\fP from terminalmage/pillar\-merge\-order
.INDENT 2.0
.IP \(bu 2
b4a1d34b47 Add option to return to pre\-2017.7.3 pillar include merge order
.UNINDENT
.IP \(bu 2
b90f0d1364 Merge pull request \fI\%#46711\fP from terminalmage/wildcard\-versions\-info
.INDENT 2.0
.IP \(bu 2
fc7d16f1af Add performance reminder for wildcard versions
.UNINDENT
.IP \(bu 2
6c80d90bb6 Merge pull request \fI\%#46693\fP from dwoz/test_smtp_return
.INDENT 2.0
.IP \(bu 2
5bf850c67f File and Pillar roots are dictionaries
.UNINDENT
.IP \(bu 2
9a6bc1418c Merge pull request \fI\%#46543\fP from dafenko/fix\-add\-saltenv\-pillarenv\-to\-pillar\-item
.INDENT 2.0
.IP \(bu 2
6d5b2068aa Merge branch \(aq2017.7\(aq into fix\-add\-saltenv\-pillarenv\-to\-pillar\-item
.IP \(bu 2
5219377313 Merge branch \(aq2017.7\(aq into fix\-add\-saltenv\-pillarenv\-to\-pillar\-item
.IP \(bu 2
b7d39caa86 Merge branch \(aq2017.7\(aq into fix\-add\-saltenv\-pillarenv\-to\-pillar\-item
.IP \(bu 2
25f1074a85 Add docstring for added parameters
.IP \(bu 2
973bc13955 Merge branch \(aq2017.7\(aq into fix\-add\-saltenv\-pillarenv\-to\-pillar\-item
.IP \(bu 2
164314a859 Merge branch \(aq2017.7\(aq into fix\-add\-saltenv\-pillarenv\-to\-pillar\-item
.IP \(bu 2
267ae9f633 Fix missing saltenv and pillarenv in pillar.item
.UNINDENT
.IP \(bu 2
f776040e25 Merge pull request \fI\%#46679\fP from vutny/doc\-state\-pkg
.INDENT 2.0
.IP \(bu 2
4a730383bf [DOC] Correct examples in \fIpkg\fP state module
.UNINDENT
.IP \(bu 2
47409eaa6e Merge pull request \fI\%#46646\fP from twangboy/win_fix_test_local_cache
.INDENT 2.0
.IP \(bu 2
8d93156604 Fix \fIunit.returners.test_local_cache\fP for Windows
.UNINDENT
.IP \(bu 2
0c2dce0416 Merge pull request \fI\%#46649\fP from terminalmage/issue46595
.INDENT 2.0
.IP \(bu 2
e82a1aa1ec Make server_id consistent on Python 3
.UNINDENT
.IP \(bu 2
4e7466a21c Merge pull request \fI\%#46588\fP from UtahDave/no_crash_winshell
.INDENT 2.0
.IP \(bu 2
b7842a1777 Update error message.
.IP \(bu 2
95dfdb91ca Don\(aqt stacktrace when salt\-ssh w/o saltwinshell
.UNINDENT
.IP \(bu 2
33af3cfc7c Merge pull request \fI\%#46631\fP from rallytime/update\-pillar\-unit\-tests
.INDENT 2.0
.IP \(bu 2
0f728186aa Fix pillar unit test failures: file_roots and pillar_roots environments should be lists
.UNINDENT
.IP \(bu 2
d329e7af78 Merge pull request \fI\%#46640\fP from terminalmage/file.copy\-docs
.INDENT 2.0
.IP \(bu 2
480c5f8faa Clarify the docs for the file.copy state
.UNINDENT
.IP \(bu 2
ff40590c06 Merge pull request \fI\%#46642\fP from vutny/doc\-cloud\-index
.INDENT 2.0
.IP \(bu 2
51e6aa54a1 [DOC] Unify cloud modules index header
.UNINDENT
.IP \(bu 2
83ed40c06a Merge pull request \fI\%#46619\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
bcbddf5d07 Merge branch \(aq2017.7.5\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
19bb725698 Merge pull request \fI\%#46612\fP from Ch3LL/7.5_rn
.INDENT 2.0
.IP \(bu 2
6076bfa2ee Add changelog to 2017.7.5 release
.UNINDENT
.IP \(bu 2
31c78aef11 Merge pull request \fI\%#46572\fP from dmurphy18/update_xxxbuild
.INDENT 2.0
.IP \(bu 2
c87511570d Merge branch \(aq2017.7.5\(aq into update_xxxbuild
.UNINDENT
.IP \(bu 2
cdd768fa4d Merge pull request \fI\%#46577\fP from gtmanfred/2017.7.5
.INDENT 2.0
.IP \(bu 2
78cbf7b5cd Fix npm issue
.IP \(bu 2
c76f7eb028 enable debug logging on the minionlog
.UNINDENT
.IP \(bu 2
e6682c660c Merge pull request \fI\%#46551\fP from terminalmage/salt\-jenkins\-885
.INDENT 2.0
.IP \(bu 2
703b5e7e65 Change versionadded to show that 2018.3.0 will not have this function
.IP \(bu 2
010d260d06 Rewrite failing Suse pkg integration test
.IP \(bu 2
f3f5dec239 zypper.py: fix version argument being ignored
.IP \(bu 2
214f2d6ad3 Add pkg.list_repo_pkgs to zypper.py
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
0a541613f2 Additon of \-sa flag to allow for revision numbers other than \-0 or \-1
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
bd62699ccb Merge pull request \fI\%#46563\fP from gtmanfred/2017.7.5
.INDENT 2.0
.IP \(bu 2
8d5ab72983 virtualenv version too old for python3.6
.UNINDENT
.IP \(bu 2
2916708124 Merge pull request \fI\%#46561\fP from gtmanfred/2017.7.5
.INDENT 2.0
.IP \(bu 2
2c39ac6dfb disable verbose
.UNINDENT
.IP \(bu 2
ee3bff6e32 Merge pull request \fI\%#46537\fP from rallytime/bp\-46529
.INDENT 2.0
.IP \(bu 2
289c7a228f retry if there is a segfault
.UNINDENT
.IP \(bu 2
1271536a89 Merge pull request \fI\%#46519\fP from rallytime/man\-pages\-2017.7.5
.INDENT 2.0
.IP \(bu 2
782a5584f5 Update man pages for 2017.7.5
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
df12135439 Merge pull request \fI\%#46584\fP from twangboy/lgpo\-46568
.INDENT 2.0
.IP \(bu 2
661017104b Detect disabled reg_multi_sz elements properly
.UNINDENT
.IP \(bu 2
2fd3aa487c Merge pull request \fI\%#46624\fP from twangboy/win_fix_installer
.INDENT 2.0
.IP \(bu 2
fa0b0efe46 Fix some installer script inconsistencies
.UNINDENT
.IP \(bu 2
f038e3c452 Merge pull request \fI\%#46571\fP from garethgreenaway/46552_onfail_and_require
.INDENT 2.0
.IP \(bu 2
152c43c843 Accounting for a case when multiple onfails are used along with requires.  Previously if you have multiple states using \(aqonfail\(aq and two of those states using a \(aqrequire\(aq against the first one state, the last two will run even if the \(aqonfail\(aq isn\(aqt met because the \(aqrequire\(aq is met because the first state returns true even though it didn\(aqt execute.  This change adds an additional hidden variable that is used when checking requisities to determine if the state actually ran.
.UNINDENT
.IP \(bu 2
2677330e19 Merge pull request \fI\%#46520\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
caefedc095 make sure utils is empty for pickling for windows
.IP \(bu 2
2883548e6b pass utils to the scheduler for reloading in modules
.UNINDENT
.IP \(bu 2
7bc3c2e588 Merge pull request \fI\%#46531\fP from terminalmage/issue44299
.INDENT 2.0
.IP \(bu 2
b70c3389da Fix case where no comments specified
.IP \(bu 2
ce391c53f4 Add regression test for \fI\%#44299\fP
.IP \(bu 2
c3e36a6c94 Fix regression in yumpkg._parse_repo_file()
.IP \(bu 2
f0c79e3da3 Slight modification to salt.utils.pkg.rpm.combine_comments()
.UNINDENT
.IP \(bu 2
b80edb5d26 Merge pull request \fI\%#46567\fP from dwoz/runtest\-n\-wart
.INDENT 2.0
.IP \(bu 2
3b6901e19d Honor named tests when running integration suites
.UNINDENT
.IP \(bu 2
1dcd22e767 Merge pull request \fI\%#46580\fP from twangboy/win_update_docs_dism
.INDENT 2.0
.IP \(bu 2
d52b99d7a3 Clarify some issues with msu files in win_dism.py
.UNINDENT
.IP \(bu 2
0a68c22332 Merge pull request \fI\%#46541\fP from gtmanfred/metadata
.INDENT 2.0
.IP \(bu 2
19bd1d9db5 handle user\-data for metadata grains
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46668\fP: (\fI\%anlutro\fP) Jinja2 filter strftime stopped working in salt\-ssh 2018.3 (refs: \fI\%#46848\fP, \fI\%#46744\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46744\fP: (\fI\%garethgreenaway\fP) [2018.3] Ensure salt.utils.dateutils is available for templates via salt\-ssh
@ \fI2018\-03\-28 21:09:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
ef68df7f3a Merge pull request \fI\%#46744\fP from garethgreenaway/46668_jinja2_filter_strftime_unavailable
.IP \(bu 2
0b30955c00 Including salt.utils.dateutils so various jinja_filters are available when using salt\-ssh.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46334\fP: (\fI\%sjorge\fP) [2018.3.0rc1] Stacktrace on call to nacl.dec (refs: \fI\%#46426\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46720\fP: (\fI\%rallytime\fP) Bump deprecation notices in nacl module & runner to Neon
@ \fI2018\-03\-27 21:15:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46426\fP: (\fI\%garethgreenaway\fP) [2018.3.0rc1] fixes to nacl module & runner (refs: \fI\%#46639\fP, \fI\%#46720\fP)
.IP \(bu 2
65bb37effd Merge pull request \fI\%#46720\fP from rallytime/bump\-nacl\-deprecation
.IP \(bu 2
5102c0310c Bump deprecation notices in nacl module & runner to Neon
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46733\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.0rc1 to 2018.3
@ \fI2018\-03\-27 18:46:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
c83d9e66fe Merge pull request \fI\%#46733\fP from rallytime/merge\-2018.3
.IP \(bu 2
00d4eb26f3 Merge branch \(aq2018.3.0rc1\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46565\fP: (\fI\%twangboy\fP) Create reg salt util (2018.3)
@ \fI2018\-03\-26 22:03:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
0faced1d54 Merge pull request \fI\%#46565\fP from twangboy/win_fix_cmd_powershell_2018.3
.IP \(bu 2
5ee64e9b0e Fix lint (spelling error)
.IP \(bu 2
0de54ed953 Additional tests
.IP \(bu 2
fc9ecd75e2 Skip unit.state.test_reg unless on Windows
.IP \(bu 2
aa98bdf250 Fix some lint
.IP \(bu 2
e0d201a96f Make sure the docs are correct for the tests
.IP \(bu 2
f15f92318d Add tests for salt.utils.win_reg
.IP \(bu 2
f7112b19a2 Submit \fI\%#46527\fP against 2018.3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46334\fP: (\fI\%sjorge\fP) [2018.3.0rc1] Stacktrace on call to nacl.dec (refs: \fI\%#46426\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46639\fP: (\fI\%terminalmage\fP) Use the correct path for nacl certificates in Windows
@ \fI2018\-03\-26 19:20:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46426\fP: (\fI\%garethgreenaway\fP) [2018.3.0rc1] fixes to nacl module & runner (refs: \fI\%#46639\fP, \fI\%#46720\fP)
.IP \(bu 2
dd52368f90 Merge pull request \fI\%#46639\fP from terminalmage/nacl\-default\-path
.IP \(bu 2
2f7660fe35 Use the correct path for nacl certificates in Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46416\fP: (\fI\%dincamihai\fP) Fix cp.push empty file
@ \fI2018\-03\-26 17:52:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
2efef52a3e Merge pull request \fI\%#46416\fP from dincamihai/fix\-cp.push\-empty\-file
.IP \(bu 2
536ba0fa1e Fix cp.push empty file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46643\fP: (\fI\%mcalmer\fP) fix docker return
@ \fI2018\-03\-26 15:52:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
84579e7652 Merge pull request \fI\%#46643\fP from mcalmer/fix\-docker\-return
.IP \(bu 2
3ceb63f607 fix checking test results
.IP \(bu 2
af64632bf3 add unit test for failed login
.IP \(bu 2
0fc7989236 make it possible to use login, pull and push from module.run and detect errors
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46650\fP: (\fI\%Ch3LL\fP) Mirror libnacl imports in test from the nacl module
@ \fI2018\-03\-26 14:48:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
c67afbeb36 Merge pull request \fI\%#46650\fP from Ch3LL/nacl_test
.IP \(bu 2
9fef8bc431 Mirror libnacl imports in test from the nacl runner
.IP \(bu 2
f11d58a8e9 Mirror libnacl imports in test from the nacl module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46645\fP: (\fI\%terminalmage\fP) Add Unicode / Python 3 update to 2018.3.0 release notes
@ \fI2018\-03\-26 14:43:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
03b58a01cf Merge pull request \fI\%#46645\fP from terminalmage/release\-notes
.IP \(bu 2
986c7bcdae Rewrite unicode/py3 section
.IP \(bu 2
064bc83276 Add Unicode / Python 3 update to 2018.3.0 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46150\fP: (\fI\%whytewolf\fP) With chocolately.version some packages don\(aqt work with check_remote=True (refs: \fI\%#46661\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46661\fP: (\fI\%Kimol\fP) Chocolatey \- Lowered name of local and remote packages before comparing versions.
@ \fI2018\-03\-26 14:35:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
308c9ddfc3 Merge pull request \fI\%#46661\fP from Kimol/2018.3\-fix_chocolatey_check_remote_packages
.IP \(bu 2
52581e7918 Removed trailing whitespace
.IP \(bu 2
123a86947c Chocolatey \- Added lowering local packages for unifing both local and remote names to lowercase for comparison.
.IP \(bu 2
4be1a991c2 Lowered name of available packages before comparing with local packages
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46569\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3 (refs: \fI\%#46631\fP)
@ \fI2018\-03\-21 20:57:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e1f7c37f7 Merge pull request \fI\%#46569\fP from rallytime/merge\-2018.3
.IP \(bu 2
46ba72fb1c Fix pillar unit test failures: file_roots and pillar_roots environments should be lists
.IP \(bu 2
fe2d46dd0c Better merge conflict resolution for setup.py windows changes
.IP \(bu 2
8886b61576 Update old utils paths to new paths
.IP \(bu 2
8d1e1e7f94 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
048b2ba3f6 Merge pull request \fI\%#46547\fP from garethgreenaway/46427_service_module_cumulus
.INDENT 2.0
.IP \(bu 2
edd0b11447 Merge branch \(aq2017.7\(aq into 46427_service_module_cumulus
.IP \(bu 2
ea3c16080e Disable the \fIservice\fP module on Cumulus since it is using systemd.
.UNINDENT
.IP \(bu 2
98e3260b9a Merge pull request \fI\%#46548\fP from Ch3LL/profit_test
.INDENT 2.0
.IP \(bu 2
db96c4e72e check for foo,bar username,password set in profitbrick config
.UNINDENT
.IP \(bu 2
79f2a76609 Merge pull request \fI\%#46549\fP from Ch3LL/dimension_test
.INDENT 2.0
.IP \(bu 2
bb338c464c Fix dimensionsdata test random_name call
.UNINDENT
.IP \(bu 2
083846fe0e Merge pull request \fI\%#46529\fP from gtmanfred/kitchen
.INDENT 2.0
.IP \(bu 2
50d6e2c7be retry if there is a segfault
.UNINDENT
.IP \(bu 2
5cc11129f1 Merge pull request \fI\%#46511\fP from rallytime/bp\-45769
.INDENT 2.0
.IP \(bu 2
a8ffceda53 Suppress boto WARNING during decode, reference: \fI\%https://github.com/boto/boto/issues/2965\fP
.UNINDENT
.IP \(bu 2
0e90c8ca6f Merge pull request \fI\%#46493\fP from terminalmage/issue46207
.INDENT 2.0
.IP \(bu 2
f06ff68f10 salt\-call: don\(aqt re\-use initial pillar if CLI overrides passed
.UNINDENT
.IP \(bu 2
b11a8fc8e0 Merge pull request \fI\%#46450\fP from gtmanfred/salt_runner
.INDENT 2.0
.IP \(bu 2
7974ff7264 load grains for salt.cmd runner
.UNINDENT
.IP \(bu 2
22d753364b Merge pull request \fI\%#46337\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
d6d9e36359 add tests for names and listen/listen_in
.IP \(bu 2
3f8e0db572 let listen_in work with names
.IP \(bu 2
7161f4d4df fix listen to be able to handle names
.UNINDENT
.IP \(bu 2
b7191b8782 Merge pull request \fI\%#46413\fP from meaksh/2017.7\-explore\-result\-in\-depth
.INDENT 2.0
.IP \(bu 2
885751634e Add new unit test to check state.apply within module.run
.IP \(bu 2
9f19ad5264 Rename and fix recursive method
.IP \(bu 2
1476ace558 Fix Python3 and pylint issue
.IP \(bu 2
726ca3044d Explore \(aqmodule.run\(aq response to catch the \(aqresult\(aq in depth
.UNINDENT
.IP \(bu 2
02a79a2014 Merge pull request \fI\%#46496\fP from gtmanfred/kitchen
.INDENT 2.0
.IP \(bu 2
da002f78d0 include virtualenv path for py3 windows
.IP \(bu 2
fe2efe03ea remove duplicate setup
.UNINDENT
.IP \(bu 2
5c4c182d75 Merge pull request \fI\%#46330\fP from bdrung/fix_kubernetes_test_create_deployments
.INDENT 2.0
.IP \(bu 2
5008c53c44 Fix ValueError for template in AppsV1beta1DeploymentSpec
.UNINDENT
.IP \(bu 2
c7e05d3ff4 Merge pull request \fI\%#46482\fP from rongshengfang/fix\-keyerror\-in\-instance_present
.INDENT 2.0
.IP \(bu 2
ed8c83e89a Fix KeyError in salt/states/boto_ec2.py when an EIP is being associated to an existing instance with the instance_present state.
.UNINDENT
.IP \(bu 2
573d51afec Merge pull request \fI\%#46463\fP from terminalmage/mock\-2.0
.INDENT 2.0
.IP \(bu 2
b958b4699c Update requirements files to depend on mock>=2.0.0
.UNINDENT
.IP \(bu 2
a154d35fc7 Merge pull request \fI\%#46422\fP from rallytime/bp\-46300
.INDENT 2.0
.IP \(bu 2
829dfde8e8 Change stringutils path to old utils path for 2017.7
.IP \(bu 2
91db2e0782 Python 3 support
.UNINDENT
.IP \(bu 2
2afaca17a1 Merge pull request \fI\%#46320\fP from mcalmer/warn\-kubernetes
.INDENT 2.0
.IP \(bu 2
c493ced415 add warning about future config option change
.UNINDENT
.IP \(bu 2
c7f95581e3 Merge pull request \fI\%#46449\fP from bdrung/make\-doc\-theme\-configurable
.INDENT 2.0
.IP \(bu 2
4a5da2d144 Make documentation theme configurable
.UNINDENT
.IP \(bu 2
10ce0e9e20 Merge pull request \fI\%#46162\fP from rallytime/team\-suse\-zypper\-owner
.INDENT 2.0
.IP \(bu 2
13a295a3b7 Add \fIpkg\fP and \fIsnapper\fP to team\-suse
.IP \(bu 2
35c7b7b0d3 Add btrfs, xfs, yumpkg, and kubernetes file to team\-suse
.IP \(bu 2
485d777ac0 Add team\-suse to CODEOWNERS file for zypper files
.UNINDENT
.IP \(bu 2
cac096b311 Merge pull request \fI\%#46434\fP from gtmanfred/highstate_return
.INDENT 2.0
.IP \(bu 2
d18f1a55a7 fix pylint
.IP \(bu 2
9e2c3f7991 split return key value correctly
.UNINDENT
.IP \(bu 2
7dd71101ce Merge pull request \fI\%#46455\fP from whytewolf/Issue_44452_unicode_cloud
.INDENT 2.0
.IP \(bu 2
5fe474b1a8 .format remove fix for \fI\%#44452\fP
.UNINDENT
.IP \(bu 2
4c8d9026d3 Merge pull request \fI\%#46428\fP from twangboy/win_fix_reqs
.INDENT 2.0
.IP \(bu 2
e7ab97cc17 Remove six as a hard dep for Salt
.IP \(bu 2
cc67e5c2ef Set six to 1.11.0
.UNINDENT
.IP \(bu 2
e834d9a63b Merge pull request \fI\%#46454\fP from gtmanfred/kitchen
.INDENT 2.0
.IP \(bu 2
b8ab8434a5 fix windows for kitchen
.UNINDENT
.IP \(bu 2
2886dca88f Merge pull request \fI\%#46452\fP from gtmanfred/spm_cache_dir
.INDENT 2.0
.IP \(bu 2
169cf7a4e2 make spm cache_dir instead of all cachedirs
.UNINDENT
.IP \(bu 2
a188984cd9 Merge pull request \fI\%#46446\fP from bdrung/fix\-typos
.INDENT 2.0
.IP \(bu 2
7e6e80be87 heat: Fix spelling mistake of environment
.IP \(bu 2
a3c54b50f6 Fix various spelling mistakes
.UNINDENT
.IP \(bu 2
e35fc5263c Merge pull request \fI\%#46309\fP from bdrung/dynamic\-pillarenv
.INDENT 2.0
.IP \(bu 2
584b451fd1 Support dynamic pillar_root environment
.UNINDENT
.IP \(bu 2
35fe9827fe Merge pull request \fI\%#46430\fP from terminalmage/issue44032
.INDENT 2.0
.IP \(bu 2
f9f187e915 Improve reliability/idempotence of file.blockreplace state
.UNINDENT
.IP \(bu 2
2bad0a21c0 Merge pull request \fI\%#46429\fP from twangboy/win_fix_snmp
.INDENT 2.0
.IP \(bu 2
8995a9b8de Fix problem with __virtual__ in win_snmp
.UNINDENT
.IP \(bu 2
93a572f229 Merge pull request \fI\%#46100\fP from jfindlay/resolv_scope
.INDENT 2.0
.IP \(bu 2
d5561bedaf tests.unit.grains.core add scoped IPv6 nameserver
.IP \(bu 2
4e2e62d508 salt.utils.dns parse scope param for ipv6 servers
.UNINDENT
.IP \(bu 2
5acc1d5c54 Merge pull request \fI\%#46420\fP from bdrung/2017.7
.INDENT 2.0
.IP \(bu 2
e48c13d9e0 Fix SSH client exception if SSH is not found
.UNINDENT
.IP \(bu 2
ca6a76e317 Merge pull request \fI\%#46379\fP from angeloudy/2017.7
.INDENT 2.0
.IP \(bu 2
3acb59c74c Merge branch \(aq2017.7\(aq into 2017.7
.IP \(bu 2
d971e0c08b Fix indent
.IP \(bu 2
269514683f Update http.py
.IP \(bu 2
908c040ac3 Update http.py
.IP \(bu 2
51ba3c135b Update http.py
.IP \(bu 2
14aba24111 fix bytes\-object required error in python 3
.UNINDENT
.IP \(bu 2
73f9233557 Merge pull request \fI\%#46404\fP from gtmanfred/kitchen
.INDENT 2.0
.IP \(bu 2
c56baa95a8 clone .git for the version tests
.IP \(bu 2
3620611b5b fix unhold package for debian
.IP \(bu 2
5219f7d2ba fix minion log path
.UNINDENT
.IP \(bu 2
ca28cfd4e4 Merge pull request \fI\%#46310\fP from twangboy/win_update_installer_build
.INDENT 2.0
.IP \(bu 2
bcf8b19566 Update the installer build
.UNINDENT
.IP \(bu 2
decccbeca3 Merge pull request \fI\%#46316\fP from twangboy/win_fix_dsc
.INDENT 2.0
.IP \(bu 2
2042d33d59 Fix issues with the DSC module
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46620\fP: (\fI\%rallytime\fP) [2018.3] Merge 2018.3.0rc1 into 2018.3
@ \fI2018\-03\-20 22:45:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
8cdd56b9dc Merge pull request \fI\%#46620\fP from rallytime/merge\-2018.3.0rc1\-into\-2018.3
.IP \(bu 2
b03cda3cea Merge branch \(aq2018.3.0rc1\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46606\fP: (\fI\%Ch3LL\fP) add autodoc topics for infoblox state modules
@ \fI2018\-03\-19 21:35:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d2fe22ae2 Merge pull request \fI\%#46606\fP from Ch3LL/infoblox_docs
.IP \(bu 2
6eab6a7dc4 add autodoc topics for infoblox state modules
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46540\fP: (\fI\%s0undt3ch\fP) Some missing \fIisinstance\fP checks.
@ \fI2018\-03\-15 16:17:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
1191d5b379 Merge pull request \fI\%#46540\fP from s0undt3ch/2018.3
.IP \(bu 2
fa1d668774 Some missing \fIisinstance\fP checks. Committed again through a PR.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46513\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.0rc1 to 2018.3
@ \fI2018\-03\-15 15:58:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
5429438e4b Merge pull request \fI\%#46513\fP from rallytime/merge\-2018.3
.IP \(bu 2
aa760334a1 Merge branch \(aq2018.3.0rc1\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43208\fP: (\fI\%mitar\fP) Prevent user.present to change uid and gid of existing user (refs: \fI\%#46502\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46502\fP: (\fI\%terminalmage\fP) user.present: don\(aqt change uid/gid unless explicitly told to
@ \fI2018\-03\-13 14:25:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e073c7e8a Merge pull request \fI\%#46502\fP from terminalmage/issue43208
.IP \(bu 2
4106840deb user.present: don\(aqt change uid/gid unless explicitly told to
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46398\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-03\-12 20:25:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
7cdb00ca9c Merge pull request \fI\%#46398\fP from rallytime/merge\-2018.3
.IP \(bu 2
d22e5ba442 Merge fix: return back \fIwb+\fP mode in \fIcrypt.gen_keys\fP\&.
.IP \(bu 2
c7dddaf8ce Lint: Use log variable, not logger.
.IP \(bu 2
ca1860cd91 Use new get_umask function in mask calls in virt.py
.IP \(bu 2
19ec7b6de1 Update old utils paths with new utils paths
.IP \(bu 2
d83727fdf9 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
95586678c3 Merge pull request \fI\%#46394\fP from Ch3LL/mac_doc
.INDENT 2.0
.IP \(bu 2
158add6661 change oxdownload to oxdownload\-{python_version}
.IP \(bu 2
21aa848c89 Add mac py2 and py3 packages to mac installation docs
.UNINDENT
.IP \(bu 2
07b5d09ac1 Merge pull request \fI\%#46338\fP from rallytime/fix\-44831
.INDENT 2.0
.IP \(bu 2
90771da999 Remove cmd.wait deprecation reference in docs
.UNINDENT
.IP \(bu 2
3849e7a085 Merge pull request \fI\%#46333\fP from danlsgiga/issue\-42438
.INDENT 2.0
.IP \(bu 2
3b13f37b44 Revert changes in the code and change docs instead
.IP \(bu 2
38114a65d8 Fixes color parameter mismatch and handles 204 responses correctly
.UNINDENT
.IP \(bu 2
a8f2f1b063 Merge pull request \fI\%#46322\fP from terminalmage/issue44935
.INDENT 2.0
.IP \(bu 2
85ac6a9893 yamlify_arg: don\(aqt treat leading dashes as lists
.UNINDENT
.IP \(bu 2
da5c282cb2 Merge pull request \fI\%#46327\fP from samilaine/fix\-vmware\-cloud\-fqdn
.INDENT 2.0
.IP \(bu 2
4b8dfb326f Modify the way a FQDN is handled in the vmware cloud provider.
.UNINDENT
.IP \(bu 2
78c45d3786 Merge pull request \fI\%#46318\fP from terminalmage/squelch\-warnings
.INDENT 2.0
.IP \(bu 2
5889b36646 Skip type\-checking for several gitfs/git_pillar/winrepo params
.UNINDENT
.IP \(bu 2
bb0d6fc263 Merge pull request \fI\%#46312\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
749ae580ed add module_dirs to salt ssh thin tarball
.UNINDENT
.IP \(bu 2
88b5f7383d Merge pull request \fI\%#46242\fP from redbaron4/fix\-46127
.INDENT 2.0
.IP \(bu 2
06dba51617 Make changes from review
.IP \(bu 2
727ebe1056 Merge branch \(aq2017.7\(aq into fix\-46127
.IP \(bu 2
08d1ee8baf Fix Python3 test errors
.IP \(bu 2
aa9d709015 Pass env_vars to pip.freeze
.UNINDENT
.IP \(bu 2
a0716643e4 Merge pull request \fI\%#46265\fP from Ch3LL/profit_cloud
.INDENT 2.0
.IP \(bu 2
d4893eab4c Add username/password to profitbricks conf for cloud tests
.UNINDENT
.IP \(bu 2
ed7bffa7e0 Merge pull request \fI\%#46306\fP from rallytime/bp\-46256
.INDENT 2.0
.IP \(bu 2
6439bce4a8 Don\(aqt install msgpack 0.5.5
.UNINDENT
.IP \(bu 2
8c2c4e3316 Merge pull request \fI\%#46208\fP from terminalmage/audit\-umask\-usage
.INDENT 2.0
.IP \(bu 2
9c92aadce8 Disable blacklisted\-function check for legitimate uses
.IP \(bu 2
58a11aaa26 Disable pylint check in salt\-ssh shim
.IP \(bu 2
ecadf67659 Blacklist os.umask
.IP \(bu 2
31b1d98fcb Replace direct use of os.umask with use of existing context manager
.IP \(bu 2
82ce546e18 Prevent failed os.makedirs from leaving modified umask in place
.UNINDENT
.IP \(bu 2
978e869490 Merge pull request \fI\%#46293\fP from eliasp/2017.7\-44624\-py3\-compat
.INDENT 2.0
.IP \(bu 2
2e08b0d9c8 Fix Python3 comparison \fITypeError\fP in \fIsalt.modules.upstart\fP
.UNINDENT
.IP \(bu 2
bee4a66d0c Merge pull request \fI\%#46264\fP from terminalmage/issue46128
.INDENT 2.0
.IP \(bu 2
68000b7211 Fix incorrect merge conflict resolution
.UNINDENT
.IP \(bu 2
1e0b3aa348 Merge pull request \fI\%#46296\fP from vutny/doc\-pillar\-get
.INDENT 2.0
.IP \(bu 2
1faa8331e1 [DOC] Add missing params to \fIpillar.get\fP docstring
.UNINDENT
.IP \(bu 2
c490a50452 Merge pull request \fI\%#45874\fP from GwiYeong/2017.7\-local\-client\-hotfix
.INDENT 2.0
.IP \(bu 2
949aefc82b Merge branch \(aq2017.7\(aq into 2017.7\-local\-client\-hotfix
.IP \(bu 2
45d663f435 fix for local client timeout bug
.UNINDENT
.IP \(bu 2
8e8a3a2897 Merge pull request \fI\%#46261\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
8256ae5ee5 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
140ef4d6b9 Merge pull request \fI\%#46253\fP from rallytime/doc\-banners
.INDENT 2.0
.IP \(bu 2
07ed8c7db3 Update docbanner for SaltConf18
.UNINDENT
.IP \(bu 2
9fe86ee520 Merge pull request \fI\%#46179\fP from wedge\-jarrad/cifs\-remount\-fix
.INDENT 2.0
.IP \(bu 2
9ca25c4313 Add credentials and secretfile to mount.mounted mount_invisible_keys
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46421\fP: (\fI\%bdrung\fP) Skip SSHPasswordTests if ssh binary is not found
@ \fI2018\-03\-09 16:21:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
9c089aa4de Merge pull request \fI\%#46421\fP from bdrung/skip\-ssh\-tests\-if\-ssh\-is\-missing
.IP \(bu 2
3d6f658309 Skip SSHPasswordTests if ssh binary is not found
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46453\fP: (\fI\%bdrung\fP) Fix various spelling mistakes in 2018.3
@ \fI2018\-03\-09 14:48:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46446\fP: (\fI\%bdrung\fP) Fix various typos (refs: \fI\%#46453\fP)
.IP \(bu 2
4cbfde5839 Merge pull request \fI\%#46453\fP from bdrung/fix\-typos\-2018.3
.IP \(bu 2
3d37eca847 Fix various spelling mistakes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44032\fP: (\fI\%PhilippeAB\fP) blockreplace marker_end isn\(aqt applied with newline (refs: \fI\%#46430\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46437\fP: (\fI\%terminalmage\fP) Improve reliability/idempotence of file.blockreplace state (2018.3 branch)
@ \fI2018\-03\-08 15:38:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46430\fP: (\fI\%terminalmage\fP) Improve reliability/idempotence of file.blockreplace state (refs: \fI\%#46437\fP)
.IP \(bu 2
a43d999fb8 Merge pull request \fI\%#46437\fP from terminalmage/issue44032\-2018.3
.IP \(bu 2
4798187035 Improve reliability/idempotence of file.blockreplace state (2018.3 branch)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46328\fP: (\fI\%dincamihai\fP) Fix openscap push
@ \fI2018\-03\-07 17:51:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
0c66507aff Merge pull request \fI\%#46328\fP from dincamihai/2018.3.0rc1
.IP \(bu 2
b5e508f339 Fix openscap push
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46174\fP: (\fI\%twangboy\fP) Fix a unicode issue with the git module on Windows
@ \fI2018\-03\-06 18:53:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
82cb2ea5a0 Merge pull request \fI\%#46174\fP from twangboy/win_fix_test_git_2
.IP \(bu 2
80e3a47dd4 Add output_encoding argument to git state, and add docs
.IP \(bu 2
661a0687ec Fix git utf\-8 issues for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46235\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_ssh\fP for Windows
@ \fI2018\-03\-05 20:39:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
7690cf8564 Merge pull request \fI\%#46235\fP from twangboy/win_fix_test_ssh
.IP \(bu 2
9ea02d7045 Use write instead of writelines for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46332\fP: (\fI\%terminalmage\fP) Update the merge\-forward docs to reference the 2018.3 branch
@ \fI2018\-03\-05 19:39:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
c4f366cdd9 Merge pull request \fI\%#46332\fP from terminalmage/merge\-forward\-docs
.IP \(bu 2
0411845cec Update the merge\-forward docs to reference the 2018.3 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46307\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.0rc1 to 2018.3
@ \fI2018\-03\-03 12:56:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
241611aca5 Merge pull request \fI\%#46307\fP from rallytime/merge\-2018.3
.IP \(bu 2
c9fa21f62c Merge branch \(aq2018.3.0rc1\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46314\fP: (\fI\%terminalmage\fP) Merge 2017.7 branch into 2018.3
@ \fI2018\-03\-03 12:54:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
30c34f0c62 Merge pull request \fI\%#46314\fP from terminalmage/merge\-2017.7\-2018.3
.IP \(bu 2
61ab47ee70 Merge branch \(aq2017.7\(aq into merge\-2017.7\-2018.3
.INDENT 2.0
.IP \(bu 2
88a3166589 Merge pull request \fI\%#46276\fP from terminalmage/issue44046
.INDENT 2.0
.IP \(bu 2
a14d4daf8c salt.utils.docker.translate_input: operate on deepcopy of kwargs
.UNINDENT
.IP \(bu 2
da60399b8f Merge pull request \fI\%#46183\fP from oeuftete/fix\-docker\-container\-running\-host\-config\-ulimits
.INDENT 2.0
.IP \(bu 2
5b09644429 Sort lists from Ulimits before comparing
.IP \(bu 2
0b80f02226 Update old dockerng doc ref
.UNINDENT
.IP \(bu 2
509429f08c Merge pull request \fI\%#46260\fP from terminalmage/git_pillar
.INDENT 2.0
.IP \(bu 2
b1ce2501fd Normalize global git_pillar/winrepo config items
.UNINDENT
.IP \(bu 2
a97a3e6fb0 Merge pull request \fI\%#46101\fP from jfindlay/openrc_ret
.INDENT 2.0
.IP \(bu 2
2eef3c65a6 tests.unit.modules.gentoo_service add retcode arg
.IP \(bu 2
81ec66fd8b modules.gentoo_service handle stopped retcode
.UNINDENT
.IP \(bu 2
1a17593c05 Merge pull request \fI\%#46254\fP from rallytime/enterprise\-banner
.INDENT 2.0
.IP \(bu 2
f5fae3dedf Update enterprise banner
.UNINDENT
.IP \(bu 2
8c50ff32bd Merge pull request \fI\%#46250\fP from terminalmage/runner\-docs
.INDENT 2.0
.IP \(bu 2
91b4895087 Add documentation to the fileserver runner
.UNINDENT
.IP \(bu 2
53067cca43 Merge pull request \fI\%#46243\fP from racker\-markh/fix\-openstack\-private\-network\-issue
.INDENT 2.0
.IP \(bu 2
50c1e140f0 Don\(aqt check deny private_ips already in the original list of private_ips
.UNINDENT
.IP \(bu 2
15405c8760 Merge pull request \fI\%#46239\fP from terminalmage/issue46109
.INDENT 2.0
.IP \(bu 2
586d8b0dcf archive.extracted: don\(aqt check source file when if_missing path exists
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33177\fP: (\fI\%robnagler\fP) pillar.stack should not continue after errors (refs: \fI\%#46287\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46287\fP: (\fI\%bbinet\fP) Update PillarStack stack.py to latest upstream version
@ \fI2018\-03\-02 21:39:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
194b0317ac Merge pull request \fI\%#46287\fP from bbinet/upstream\-pillarstack
.IP \(bu 2
b14b6f2c95 Update PillarStack stack.py to latest upstream version
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46227\fP: (\fI\%Ch3LL\fP) Mock file_client call in smtp return test
@ \fI2018\-02\-28 22:12:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
7382654c70 Merge pull request \fI\%#46227\fP from Ch3LL/smtp_file_client
.IP \(bu 2
280dc9a2b6 Mock file_client call in smtp return test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46232\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-02\-28 19:16:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
123625213e Merge pull request \fI\%#46232\fP from rallytime/merge\-2018.3
.IP \(bu 2
04f24c1794 Lint: fix from a bad merge
.IP \(bu 2
aad61c77bd Update old utils paths to new paths
.IP \(bu 2
7243baf2c0 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
633e1208e4 Merge pull request \fI\%#46221\fP from terminalmage/salt\-jenkins\-854
.INDENT 2.0
.IP \(bu 2
0eb012659c Fix hanging tests in integration suite
.UNINDENT
.IP \(bu 2
7917277345 Merge pull request \fI\%#46214\fP from vutny/formulas\-readme\-formatting
.INDENT 2.0
.IP \(bu 2
d702846961 [DOC] Replace \fInote\fP rST block for GitHub
.UNINDENT
.IP \(bu 2
a2e099b744 Merge pull request \fI\%#46203\fP from Ch3LL/7.5_release
.INDENT 2.0
.IP \(bu 2
6ddf3246ce Add 2017.7.5 Release Notes File
.UNINDENT
.IP \(bu 2
973b227818 Merge pull request \fI\%#46201\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
9ac2101baa Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
a4c5417d23 Merge pull request \fI\%#46132\fP from rallytime/2016.11_update_version_doc
.INDENT 2.0
.IP \(bu 2
d2196b6df3 Update release versions for the 2016.11 branch
.UNINDENT
.UNINDENT
.IP \(bu 2
89cf2e5061 Merge pull request \fI\%#46139\fP from bdrung/os\-grains
.INDENT 2.0
.IP \(bu 2
0b445f2a37 tests: Add unit tests for _parse_os_release()
.IP \(bu 2
f6069b77ed Fix osfinger grain on Debian
.IP \(bu 2
8dde55a761 tests: Add os_grains test cases for Debian
.IP \(bu 2
ff02ab9937 tests: Add Ubuntu 17.10 (artful) os_grains test case
.IP \(bu 2
77d5356aba Fix incorrect oscodename grain on Ubuntu
.IP \(bu 2
7e62dc9fd2 tests: Support reading os\-release files from disk
.IP \(bu 2
a92ec0db1b Make _parse_os_release() always callable
.IP \(bu 2
eee1fe5b38 tests: Dissolve _run_ubuntu_os_grains_tests
.IP \(bu 2
1d6ef731fe tests: Deduplicate _run_os_grains_tests()
.UNINDENT
.IP \(bu 2
c8c71e75ca Merge pull request \fI\%#46133\fP from rallytime/2017.7_update_version_doc
.INDENT 2.0
.IP \(bu 2
0ed338e643 Update release versions for the 2017.7 branch
.UNINDENT
.IP \(bu 2
390d592aa6 Merge pull request \fI\%#46185\fP from terminalmage/issue46124
.INDENT 2.0
.IP \(bu 2
3b58dd0da0 gitfs: Fix detection of base env when its ref is also mapped to a different env
.UNINDENT
.IP \(bu 2
705caa8cca Merge pull request \fI\%#46148\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
25deebf7a6 Merge branch \(aq2017.7.3\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
b5b083fd26 Merge pull request \fI\%#46074\fP from Ch3LL/update\-7.4
.INDENT 2.0
.IP \(bu 2
8d0eeeb059 Update 2017.7.4 Release Notes with new fixes
.UNINDENT
.IP \(bu 2
32f3d00e44 Merge pull request \fI\%#46066\fP from rallytime/pin\-tornado
.INDENT 2.0
.IP \(bu 2
6dc1a3b9dc Pin tornado version in requirements file
.UNINDENT
.IP \(bu 2
85761ee650 Merge pull request \fI\%#46036\fP from terminalmage/issue43769
.INDENT 2.0
.IP \(bu 2
e2140d9a84 Mock the ssh.key_is_encrypted utils func
.IP \(bu 2
169924b3fe Move ssh.key_is_encrypted to a utils module temporarily
.IP \(bu 2
54f4d78f7a Only keep ssh.py in the Windows installer
.IP \(bu 2
5f04531e1b Keep ssh state and execution modules in the installer
.IP \(bu 2
f2b69f703d git.latest: Fix regression with identity file usage
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
10a47dcbc4 Merge pull request \fI\%#46137\fP from damon\-atkins/2017.7_fix_ec2_pillar2
.INDENT 2.0
.IP \(bu 2
99e7f6a7d3 update ec2 pillar arguments with better names
.UNINDENT
.IP \(bu 2
d74cb14557 Merge pull request \fI\%#46145\fP from terminalmage/issue46004
.INDENT 2.0
.IP \(bu 2
467ff841cd pillarenv argument should default to None and not the value from opts
.IP \(bu 2
2a185855ea Better solution for fixing the opts munging in pillar.show_pillar runner
.IP \(bu 2
e2c4702e0c Update tests to reflect changes to the SaltCacheLoader
.IP \(bu 2
f9301fcc34 Document behavior when orchestration runnner invoked with non\-orch states
.IP \(bu 2
9644579cd0 Instantiate the SaltCacheLoader\(aqs fileclient in the __init__
.IP \(bu 2
f9a6c86e21 salt.runners.pillar.show_pillar: don\(aqt modify master opts
.IP \(bu 2
e0940a9fc4 Properly detect use of the state.orch alias and add orch jid to kwargs
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42932\fP: (\fI\%bobrik\fP) cmd.run with bg: true doesn\(aqt fail properly (refs: \fI\%#46172\fP, \fI\%#45932\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46172\fP: (\fI\%The\-Loeki\fP) cmdmod: reimplementation of \fI\%#45932\fP for Oxygen
@ \fI2018\-02\-28 19:14:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45932\fP: (\fI\%The\-Loeki\fP) Fix cmd run_all bg error (refs: \fI\%#46172\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39980\fP: (\fI\%vutny\fP) [2016.3] Allow using \fIbg\fP kwarg for \fIcmd.run\fP state function (refs: \fI\%#46172\fP, \fI\%#45932\fP)
.IP \(bu 2
20d869c228 Merge pull request \fI\%#46172\fP from The\-Loeki/fix_cmd_run_all_bg_oxygen
.IP \(bu 2
3ecf5018d0 Merge branch \(aq2018.3\(aq into fix_cmd_run_all_bg_oxygen
.IP \(bu 2
b5315e817b Merge branch \(aq2018.3\(aq into fix_cmd_run_all_bg_oxygen
.IP \(bu 2
beabf4f06b cmdmod: reimplementation of \fI\%#45932\fP for Oxygen
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46238\fP: (\fI\%terminalmage\fP) Don\(aqt allow salt.utils.files.fopen() to open stdin/stdout/stderr
@ \fI2018\-02\-28 19:08:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
687575b582 Merge pull request \fI\%#46238\fP from terminalmage/fds\-in\-fopen
.IP \(bu 2
fe1527a3c4 Don\(aqt allow salt.utils.files.fopen() to open stdin/stdout/stderr
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46219\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_network\fP for Windows
@ \fI2018\-02\-28 15:45:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
3da5dcb313 Merge pull request \fI\%#46219\fP from twangboy/win_fix_inet_pton
.IP \(bu 2
46f1d2cc09 Use six.text_type instead of six.u
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46228\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_pip\fP for Windows
@ \fI2018\-02\-28 15:37:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
44343f8063 Merge pull request \fI\%#46228\fP from twangboy/win_fix_test_pip
.IP \(bu 2
415821eee9 Fix encoding issue
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46198\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.0rc1 to 2018.3
@ \fI2018\-02\-27 15:17:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
adc8950bbe Merge pull request \fI\%#46198\fP from rallytime/merge\-2018.3
.IP \(bu 2
1b4dc71930 Lint fix
.IP \(bu 2
776f2ea5d7 Merge branch \(aq2018.3.0rc1\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45849\fP: (\fI\%Epiclemonaid\fP) XenServer Provisioning errors out on this line. removing it succeeds. (refs: \fI\%#46168\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46168\fP: (\fI\%gtmanfred\fP) driver and provider should be specified
@ \fI2018\-02\-26 16:17:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
06d2dff3ac Merge pull request \fI\%#46168\fP from gtmanfred/2018.3
.IP \(bu 2
ac99bd26db driver and provider should be specified
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46161\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-02\-26 15:29:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
605e5eff73 Merge pull request \fI\%#46161\fP from rallytime/merge\-2018.3
.IP \(bu 2
69ac94baca Update utils paths
.IP \(bu 2
cffbf52c10 Lint fix: remove extra line
.IP \(bu 2
79bed6cff1 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
0398ce0482 Merge pull request \fI\%#46135\fP from rallytime/bp\-46088
.INDENT 2.0
.IP \(bu 2
57a60f62a3 fix kernel subpackages install bug
.UNINDENT
.IP \(bu 2
1fcbbd1e02 Merge pull request \fI\%#46136\fP from rallytime/bp\-46115
.INDENT 2.0
.IP \(bu 2
0a481d707f update digitalocean salt\-cloud driver
.UNINDENT
.IP \(bu 2
11e5e8eb86 Merge pull request \fI\%#45911\fP from twangboy/win_fix_lgpo_unicode
.INDENT 2.0
.IP \(bu 2
bcde5cc625 Update log statement
.IP \(bu 2
e9fa53d3b7 Change the Invalid Data Message
.IP \(bu 2
c818d4b791 Convert reg values to unicode for debug
.UNINDENT
.IP \(bu 2
524a6a72a0 Merge pull request \fI\%#46123\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
8d36730ef7 If no pubkey is passed in openmode fail
.UNINDENT
.IP \(bu 2
e48fa58012 Merge pull request \fI\%#46131\fP from vutny/doc\-formula\-formatting
.INDENT 2.0
.IP \(bu 2
d8fb051e44 [DOC] Fix code\-blocks for reStructuredText
.UNINDENT
.IP \(bu 2
6cea44ee95 Merge pull request \fI\%#46118\fP from rallytime/bp\-44603
.INDENT 2.0
.IP \(bu 2
2a2c23c66b Fix acme state to correctly return on test
.UNINDENT
.IP \(bu 2
16c382b55b Merge pull request \fI\%#46121\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
4c2f504a85 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
e197a0fbc5 Merge pull request \fI\%#46076\fP from rallytime/bp\-46066
.INDENT 2.0
.IP \(bu 2
b94d73c53e Pin tornado version in requirements file
.UNINDENT
.IP \(bu 2
c72c1bde5f Merge pull request \fI\%#46093\fP from wedge\-jarrad/contributing\-doc\-typo
.INDENT 2.0
.IP \(bu 2
5a0fe104f7 Fix contributing doc typo
.UNINDENT
.IP \(bu 2
3cb83ea87e Merge pull request \fI\%#45992\fP from bgridley/fix\-routes\-present\-state
.INDENT 2.0
.IP \(bu 2
679787699c Add vpc_peering_connection_id to describe_route_tables route_keys
.UNINDENT
.IP \(bu 2
8a60635da0 Merge pull request \fI\%#46000\fP from terminalmage/issue45910
.INDENT 2.0
.IP \(bu 2
8cf13325ee salt.states.reg.present: Prevent traceback when reg data is binary
.UNINDENT
.IP \(bu 2
1f44e285dc Merge pull request \fI\%#46011\fP from terminalmage/fix\-solaris\-runas
.INDENT 2.0
.IP \(bu 2
8ee0a3a28b Move Solaris USER workaround up a bit
.IP \(bu 2
13cdb52690 cmdmod.py: runas workaround for platforms that don\(aqt set a USER env var
.UNINDENT
.IP \(bu 2
30fb8f7be0 Merge pull request \fI\%#45467\fP from twangboy/win_exclude_hidden
.INDENT 2.0
.IP \(bu 2
ea41215646 Make the regex pattern less greedy
.IP \(bu 2
6d223cffa7 Add tip about passing bogus saltenv
.IP \(bu 2
1282ae3a93 Skip hidden first
.IP \(bu 2
437a457911 Skip hidden dirs in genrepo
.IP \(bu 2
87dc554dc3 Add final updates to docs
.IP \(bu 2
3646d5c897 Fix some docs formatting, add some warnings
.IP \(bu 2
35c81faf5a Log the source_dir when caching the files
.IP \(bu 2
91c3da8dfd Improve docs for pkg.refresh_db
.IP \(bu 2
4803d92707 Add some documentation
.IP \(bu 2
08b82e0875 Fix lint error, use raw
.IP \(bu 2
2f712691cf Exclude hidden directories in pkg.refresh_db
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
b92346645b Merge pull request \fI\%#46107\fP from amendlik/yumpkg\-assumeyes
.INDENT 2.0
.IP \(bu 2
8d9a432fb2 Add \-\-assumeyes to yum/dnf commands in yumpkg.refresh_db
.UNINDENT
.IP \(bu 2
14fe423e0c Merge pull request \fI\%#46094\fP from kstreee/fix\-memory\-leak
.INDENT 2.0
.IP \(bu 2
48080a1bae Fixes memory leak, saltclients should be cleaned after used.
.IP \(bu 2
aba00805f4 Adds set_close_callback function to removes stream instance after closed from a set streams.
.UNINDENT
.IP \(bu 2
320c2037e1 Merge pull request \fI\%#46097\fP from vutny/fix\-https\-link
.INDENT 2.0
.IP \(bu 2
2062fd0e5c [DOC] Put https link to the formulas doc page
.UNINDENT
.IP \(bu 2
0eb137fb4e Merge pull request \fI\%#46103\fP from bdrung/2017.7
.INDENT 2.0
.IP \(bu 2
dd3f936557 Fix skipping Kubernetes tests if client is not installed
.UNINDENT
.IP \(bu 2
c3a938e994 Merge pull request \fI\%#46070\fP from Ch3LL/fix\-doc\-dns
.INDENT 2.0
.IP \(bu 2
2a5d855d97 add required arg to dns_check jinja doc example
.UNINDENT
.IP \(bu 2
01042e9d77 Merge pull request \fI\%#46067\fP from rallytime/bp\-45994
.INDENT 2.0
.IP \(bu 2
a07bb48726 Correct formatting for lint
.IP \(bu 2
e8678f633d Fix Comment being None not \(aq\(aq and inject quotes into the TXT ChangeRecords
.UNINDENT
.IP \(bu 2
5e0e2a30e2 Merge pull request \fI\%#45932\fP from The\-Loeki/fix_cmd_run_all_bg
.INDENT 2.0
.IP \(bu 2
f83da27ca5 Merge branch \(aq2017.7\(aq into fix_cmd_run_all_bg
.IP \(bu 2
771758fbca Merge branch \(aq2017.7\(aq into fix_cmd_run_all_bg
.IP \(bu 2
c54fcf7a2d cmd: move separate DRY logging blocks into _run, prevent logging on bg=True, don\(aqt use_vt on bg
.IP \(bu 2
ebb1f81a9b cmd run: when running in bg, force ignore_retcode=True
.UNINDENT
.IP \(bu 2
45ace39961 Merge pull request \fI\%#46062\fP from vutny/pg\-user\-state\-fix\-typo
.INDENT 2.0
.IP \(bu 2
a5fbe4e95e Fix typo in postgres_user.present state function
.UNINDENT
.IP \(bu 2
edcb64de76 Merge pull request \fI\%#45763\fP from twangboy/win_fix_path_rehash
.INDENT 2.0
.IP \(bu 2
b9a2bc7b29 Fix hyperlinks
.IP \(bu 2
29912adc15 Move the test_rehash test to test_win_functions
.IP \(bu 2
adc594c183 Remove duplicate link
.IP \(bu 2
e84628c1eb Add some comments to the code
.IP \(bu 2
d50d5f582f Add additional info to docs for \fIbroadcast_setting_change\fP
.IP \(bu 2
3a54e09cd9 Rename setting to message
.IP \(bu 2
a3f9e99bc0 Change to a generic function to broadcast change
.IP \(bu 2
79299361c3 Create refresh_environment salt util
.IP \(bu 2
967b83940c Fix rehash function
.UNINDENT
.IP \(bu 2
a46fbc546c Merge pull request \fI\%#46042\fP from jfindlay/file_tree_doc
.INDENT 2.0
.IP \(bu 2
0ba4954a4b salt.pillar.file_tree revise module documentation
.IP \(bu 2
3c6a5bf967 salt.pillar.file_tree provide better debug info
.IP \(bu 2
bb1cdc451e salt.pillar.file_tree no stack trace when nodegroups undefined
.UNINDENT
.IP \(bu 2
de86126dd8 Merge pull request \fI\%#46013\fP from rallytime/bp\-45598
.INDENT 2.0
.IP \(bu 2
2ea3fef543 No lazy logging
.IP \(bu 2
f427b0febc Change formatting style of logging lines per review
.IP \(bu 2
ebb244396b Patch around ResourceRecords needing to be present for AliasTarget entries to work
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46160\fP: (\fI\%rallytime\fP) Mark 2 tests as flaky
@ \fI2018\-02\-23 19:10:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
05b771bfd7 Merge pull request \fI\%#46160\fP from rallytime/flaky\-tests
.IP \(bu 2
49e49ae51b Mark 2 tests as flaky
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46006\fP: (\fI\%dincamihai\fP) Remove obsolete unicode handling in pkg.info_installed
@ \fI2018\-02\-22 19:22:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
9b2bc1982c Merge pull request \fI\%#46006\fP from dincamihai/oxygen.rc1
.IP \(bu 2
99079fc442 Remove obsolete unicode handling in pkg.info_installed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46078\fP: (\fI\%rallytime\fP) [oxygen] Merge forward from oxygen.rc1 to oxygen
@ \fI2018\-02\-20 21:49:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
93dab45307 Merge pull request \fI\%#46078\fP from rallytime/merge\-oxygen
.IP \(bu 2
2d0f81fd1b Merge branch \(aqoxygen.rc1\(aq into \(aqoxygen\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45938\fP: (\fI\%edgan\fP) zookeeper.present state doesn\(aqt deal with an existing zode with no ACL specified (refs: \fI\%#46043\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46071\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46043\fP to oxygen
@ \fI2018\-02\-16 19:56:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46043\fP: (\fI\%edgan\fP) Allow zookeeper znode creation to not require an ACL (refs: \fI\%#46071\fP)
.IP \(bu 2
8d99c3b8fe Merge pull request \fI\%#46071\fP from rallytime/bp\-46043
.IP \(bu 2
b82c8bd630 Allow zookeeper znode creation to not require an ACL
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46056\fP: (\fI\%Ch3LL\fP) Fix mac_assistive module not loading
@ \fI2018\-02\-16 14:57:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
5a31422432 Merge pull request \fI\%#46056\fP from Ch3LL/ver_mac
.IP \(bu 2
e44f5133c5 Fix mac_assistive module not loading
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46041\fP: (\fI\%rallytime\fP) [oxygen] Merge forward from 2017.7 to oxygen
@ \fI2018\-02\-16 14:55:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
cdca28f5da Merge pull request \fI\%#46041\fP from rallytime/merge\-oxygen
.IP \(bu 2
e060a74fd8 Merge branch \(aq2017.7\(aq into \(aqoxygen\(aq
.INDENT 2.0
.IP \(bu 2
07e5735471 Merge pull request \fI\%#46016\fP from rallytime/bp\-45826
.INDENT 2.0
.IP \(bu 2
1916e5c4a4 Fix selinux.fcontext_policy_present for Centos 6
.UNINDENT
.IP \(bu 2
a1f4092811 Merge pull request \fI\%#46015\fP from rallytime/bp\-45785
.INDENT 2.0
.IP \(bu 2
ef6ffb1492 Resolve linting errors
.IP \(bu 2
8047066c46 Remove unused import
.IP \(bu 2
8f7c45935a Add tests for salt.modules.selinux.fcontext_get_policy
.IP \(bu 2
bafb7b4e6e Ensure parsed fields are stripped
.IP \(bu 2
a830a6e819 m/selinux.fcontext_get_policy allow long filespecs
.UNINDENT
.IP \(bu 2
96097c037e Merge pull request \fI\%#46012\fP from rallytime/bp\-45462
.INDENT 2.0
.IP \(bu 2
9f76836a6c emit port cli version, variants as separate args
.UNINDENT
.IP \(bu 2
1279924f5f Merge pull request \fI\%#45991\fP from terminalmage/fix\-duplicate\-extra\-opts
.INDENT 2.0
.IP \(bu 2
916766f651 yumpkg: Fix a couple issues with _get_extra_opts
.UNINDENT
.IP \(bu 2
8b9adc258e Merge pull request \fI\%#46017\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
a06645ce71 Merge branch \(aq2017.7.3\(aq into \(aq2017.7\(aq
.IP \(bu 2
6d534c6e7e Merge pull request \fI\%#46009\fP from Ch3LL/rn_7.4
.INDENT 2.0
.IP \(bu 2
ac0baf4b34 Add 2017.7.4 Release Notes with PRs
.UNINDENT
.IP \(bu 2
ca76a0b328 Merge pull request \fI\%#45981\fP from gtmanfred/2017.7.3
.INDENT 2.0
.IP \(bu 2
0d448457dc apparently local is not set by default
.IP \(bu 2
2a92f4bc16 use local config for vault when masterless
.UNINDENT
.IP \(bu 2
6530649dbc Merge pull request \fI\%#45953\fP from rallytime/bp\-45928\-2017.7.3
.INDENT 2.0
.IP \(bu 2
85363189d1 Fixing vault when used with pillar over salt\-ssh
.UNINDENT
.IP \(bu 2
fb378cebb0 Merge pull request \fI\%#45934\fP from rallytime/bp\-45902
.INDENT 2.0
.IP \(bu 2
bb83e8b345 Add regression test for issue 45893
.IP \(bu 2
cdda66d759 Remove duplicated section in docstring and fix example
.IP \(bu 2
4b6351cda6 Check the effective saltenv for cached archive
.UNINDENT
.IP \(bu 2
0d74151c71 Merge pull request \fI\%#45935\fP from rallytime/bp\-45742
.INDENT 2.0
.IP \(bu 2
6a0b5f7af3 Removed the chained copy
.IP \(bu 2
ad1150fad4 list.copy() is not compatible with python 2.7
.UNINDENT
.UNINDENT
.IP \(bu 2
d20ff89414 Merge pull request \fI\%#45988\fP from rallytime/bp\-45797
.INDENT 2.0
.IP \(bu 2
953a400d79 follow symlinks
.UNINDENT
.IP \(bu 2
b18087cee0 Merge pull request \fI\%#45711\fP from bdrung/fix\-unicode\-tests
.INDENT 2.0
.IP \(bu 2
b6181b5ed6 Fix Unicode tests when run with LC_ALL=POSIX
.UNINDENT
.IP \(bu 2
5271fb1d40 Merge pull request \fI\%#45878\fP from damon\-atkins/2017.7_fix_ec2_pillar
.INDENT 2.0
.IP \(bu 2
0e74025714 Merge branch \(aq2017.7\(aq into 2017.7_fix_ec2_pillar
.IP \(bu 2
b4d0b23891 py3 fix
.IP \(bu 2
75d9e20d8a Add ignoring \(aqterminated\(aq, \(aqstopped\(aq instances, to improve changes of a single match
.IP \(bu 2
0093472a37 added tag_key_list and tag_key_sep to create ec2_tags_list
.IP \(bu 2
afb3968aa7 ec2_pillar could not find instance\-id, resolved. add support to use any tag to compare minion id against.
.UNINDENT
.IP \(bu 2
cf367dbd04 Merge pull request \fI\%#45942\fP from terminalmage/issue45679\-2017.7
.INDENT 2.0
.IP \(bu 2
89cbd72a0d Don\(aqt try to sort ports when translating docker input
.IP \(bu 2
9cd47b39dd Fix incorrect translation of docker port_bindings \-> ports
.UNINDENT
.IP \(bu 2
dae41de7a8 Merge pull request \fI\%#45959\fP from rallytime/state\-doc\-update
.INDENT 2.0
.IP \(bu 2
6f781cb95d A couple of grammar updates for the state compiler docs
.UNINDENT
.IP \(bu 2
007214f7bf Merge pull request \fI\%#45908\fP from DimensionDataResearch/fix/issue/45884
.INDENT 2.0
.IP \(bu 2
1a75786b5a Fix linter warnings.
.IP \(bu 2
82ec0b589c Revert to using salt.utils.cloud.is_public_ip.
.IP \(bu 2
9b6b01873b Fix violations reported by flake8.
.IP \(bu 2
a2bc155c73 Use __utils__[\(aqcloud.\(aq] instead of salt.cloud.utils.
.IP \(bu 2
98907a32cb Ensure \(aqauth\(aq parameter is correctly passed to dimensiondata driver.
.IP \(bu 2
de26b03e2c Fix copy/paste bug in dimensiondata provider integration test.
.IP \(bu 2
6b1b6be427 Add integration tests for dimensiondata cloud provider.
.IP \(bu 2
f6ea9fed7d Ensure that event data provided by the dimensiondata driver is serialisable.
.UNINDENT
.IP \(bu 2
efcbfa868c Merge pull request \fI\%#45985\fP from garethgreenaway/2017_7_fixing_mac_tests_again
.INDENT 2.0
.IP \(bu 2
7b8dc14433 Missing \fIformat\fP in the call to write.
.UNINDENT
.IP \(bu 2
bf03abd07c Merge pull request \fI\%#45958\fP from garethgreenaway/backport\-fixing_mactests_queue_full
.INDENT 2.0
.IP \(bu 2
25dffaae91 Backporting \fI\%#45935\fP
.UNINDENT
.IP \(bu 2
bab365d6c6 Merge pull request \fI\%#45949\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
f51687e903 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
7779fea7ba Merge pull request \fI\%#45940\fP from dmurphy18/fix_aix_cmdmod
.INDENT 2.0
.IP \(bu 2
dd2788419b Fix use of \(aqsu\(aq for AIX to use \(aq\-\(aq
.UNINDENT
.UNINDENT
.IP \(bu 2
7fd00ec752 Merge pull request \fI\%#45928\fP from garethgreenaway/45915_fixing_vault_pillar_for_salt_ssh
.INDENT 2.0
.IP \(bu 2
259e60e5d4 Fixing vault when used with pillar over salt\-ssh
.UNINDENT
.IP \(bu 2
9d14ad9ccf Merge pull request \fI\%#45925\fP from terminalmage/fix\-spelling
.INDENT 2.0
.IP \(bu 2
7a143fe454 Fix spelling error in docstring
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45972\fP: (\fI\%mcalmer\fP) move log_file option to changeable defaults
@ \fI2018\-02\-15 18:57:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
057e895faf Merge pull request \fI\%#45972\fP from mcalmer/allow\-salt\-ssh\-define\-log_file
.IP \(bu 2
f89a20bf3e move log_file option to changeable defaults
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46007\fP: (\fI\%rallytime\fP) [oxygen] Merge forward from oxygen.rc1 to oxygen
@ \fI2018\-02\-13 18:50:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
d4377d4678 Merge pull request \fI\%#46007\fP from rallytime/merge\-oxygen
.IP \(bu 2
d6c2d0693a Merge branch \(aqoxygen.rc1\(aq into \(aqoxygen\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45944\fP: (\fI\%mirceaulinic\fP) Add NetBox module autodoc
@ \fI2018\-02\-13 00:01:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
069f790b3c Merge pull request \fI\%#45944\fP from cloudflare/netbox\-autodoc
.IP \(bu 2
ed69b987cf Add NetBox module autodoc
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45984\fP: (\fI\%garethgreenaway\fP) [oxygen] Missing \fIformat\fP in the call to write.
@ \fI2018\-02\-12 19:06:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
2a6285d313 Merge pull request \fI\%#45984\fP from garethgreenaway/fixing_mac_tests_again
.IP \(bu 2
ae7791d30b Missing \fIformat\fP in the call to write.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45922\fP: (\fI\%rallytime\fP) [oxygen] Merge forward from 2017.7 to oxygen
@ \fI2018\-02\-09 20:24:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
88f481a3df Merge pull request \fI\%#45922\fP from rallytime/merge\-oxygen
.IP \(bu 2
9c49c8d47c Remove extra patch
.IP \(bu 2
b96f4cf8ad Remove duplicate import in cmdmod.py
.IP \(bu 2
34ecdffa71 Replace old utils paths with new paths
.IP \(bu 2
d80547e0b8 Merge branch \(aq2017.7\(aq into \(aqoxygen\(aq
.IP \(bu 2
0cbe93cd69 Merge pull request \fI\%#45920\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
e4e4744218 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
27ff82f996 Merge pull request \fI\%#45864\fP from rallytime/release\-note\-fix
.INDENT 2.0
.IP \(bu 2
104a24f244 Remove extraneous ] in release notes for 2016.11.9
.UNINDENT
.IP \(bu 2
5fa010de2b Merge pull request \fI\%#45787\fP from rallytime/2016.11.9_docs
.INDENT 2.0
.IP \(bu 2
a38d4d44fa [2016.11] Bump latest and previous versions
.UNINDENT
.UNINDENT
.IP \(bu 2
643a8a5278 Merge pull request \fI\%#45814\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
d8eec9aa97 fix cookies dict size changing in http.query
.UNINDENT
.IP \(bu 2
3a3f87c16d Merge pull request \fI\%#45877\fP from rallytime/new\-release\-notes
.INDENT 2.0
.IP \(bu 2
f937e8ba81 Add release notes file for 2017.7.4 release
.UNINDENT
.IP \(bu 2
1c3cc00670 Merge pull request \fI\%#45904\fP from rallytime/bp\-41017
.INDENT 2.0
.IP \(bu 2
80c56cdcea Fixed typo in pkg state documentation
.UNINDENT
.IP \(bu 2
317d35bd15 Merge pull request \fI\%#45907\fP from terminalmage/fix\-grains\-backport
.INDENT 2.0
.IP \(bu 2
6cf7e50cc4 Fix backport of grains fix
.UNINDENT
.IP \(bu 2
dade5f0cab Merge pull request \fI\%#45906\fP from rallytime/bp\-45548
.INDENT 2.0
.IP \(bu 2
1befa7386c Update x509.py
.UNINDENT
.IP \(bu 2
82c473a1fe Merge pull request \fI\%#45902\fP from terminalmage/issue45893
.INDENT 2.0
.IP \(bu 2
9d200efc26 Add regression test for issue 45893
.IP \(bu 2
1468f1d0ff Remove duplicated section in docstring and fix example
.IP \(bu 2
6cc5cd9b8a Check the effective saltenv for cached archive
.UNINDENT
.IP \(bu 2
fdedde3cfb Merge pull request \fI\%#45862\fP from rallytime/bp\-45830
.INDENT 2.0
.IP \(bu 2
1024856f9a Wrapping the put_nowait in a try...except and catching the exception when the multiprocessing queue is full.  This situation is happening when running the full testing suite on MacOS where the queue limit is 32767 vs on Linux where the queue limit is unlimited.
.UNINDENT
.IP \(bu 2
43a45b42c3 Merge pull request \fI\%#45779\fP from The\-Loeki/patch\-3
.INDENT 2.0
.IP \(bu 2
8575ae3d52 Merge branch \(aq2017.7\(aq into patch\-3
.IP \(bu 2
47cf00d88e SSH shell shim: Don\(aqt use $() for optimal support
.UNINDENT
.IP \(bu 2
cca997d0da Merge pull request \fI\%#45788\fP from rallytime/2017.7.3_docs
.INDENT 2.0
.IP \(bu 2
d5faf6126b [2017.7] Bump latest and previous versions
.UNINDENT
.IP \(bu 2
746206cebe Merge pull request \fI\%#45842\fP from rallytime/bp\-45827
.INDENT 2.0
.IP \(bu 2
c631598a87 Fix traceback in disks grains when /sys/block not available
.UNINDENT
.IP \(bu 2
900aadcd67 Merge pull request \fI\%#45721\fP from garethgreenaway/44978_show_duration_when_no_state_run
.INDENT 2.0
.IP \(bu 2
359265869f Adding a couple tests to ensure that duration is included in state run results even when states do not run.
.IP \(bu 2
912347abc3 Include the duration when a state does not run, for example when the \fIonchanges\fP requisite is not met.
.UNINDENT
.IP \(bu 2
80a2d009b4 Merge pull request \fI\%#45517\fP from kstreee/fix\-mkdir
.INDENT 2.0
.IP \(bu 2
24d41f2451 Fixes base dir making logic to ensure not raising the exception when base directory already exists.
.UNINDENT
.IP \(bu 2
7a4b1b2e77 Merge pull request \fI\%#45835\fP from kstreee/fix\-missing\-return\-statement
.INDENT 2.0
.IP \(bu 2
68c7f3dcba Adds a missing return statement.
.UNINDENT
.IP \(bu 2
0a04f118c2 Merge pull request \fI\%#45840\fP from rallytime/bp\-45603
.INDENT 2.0
.IP \(bu 2
9653363131 Fix for duplicate entries with pkrepo.managed
.UNINDENT
.IP \(bu 2
bd2178cd5f Merge pull request \fI\%#45716\fP from ciiqr/fix_cmd_script_quoting
.INDENT 2.0
.IP \(bu 2
217791079b some code cleanup (lint errors and escape_argument as _cmd_quote)
.IP \(bu 2
1c29bc5a3d fixed quoting of script path in cmd.script
.UNINDENT
.IP \(bu 2
272f912c7c Merge pull request \fI\%#45719\fP from bdrung/fix\-python3\-sphinx\-build
.INDENT 2.0
.IP \(bu 2
179e8fbe73 doc: Do not mock non\-existing __qualname__ attribute
.IP \(bu 2
971e59ebe2 Drop enforcing new\-style object for SaltYamlSafeLoader
.UNINDENT
.IP \(bu 2
fc04336c3b Merge pull request \fI\%#45764\fP from mchugh19/2017.7
.INDENT 2.0
.IP \(bu 2
0a7f1a4d75 English better
.IP \(bu 2
37e067c7b5 support amazon linux 2 for service module
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45861\fP: (\fI\%rallytime\fP) [oxygen] Merge forward from oxygen.rc1 to oxygen
@ \fI2018\-02\-08 13:39:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
048c18ea42 Merge pull request \fI\%#45861\fP from rallytime/merge\-oxygen
.IP \(bu 2
6d812ac192 Merge branch \(aqoxygen.rc1\(aq into \(aqoxygen\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45852\fP: (\fI\%Giandom\fP) fix\-missing\-highstate\-module\-import
@ \fI2018\-02\-05 15:02:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
1bd38fb3b7 Merge pull request \fI\%#45852\fP from Giandom/fix\-missing\-highstate\-module\-import
.IP \(bu 2
dc5a8f9233 fix\-missing\-highstate\-module\-import
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45829\fP: (\fI\%rallytime\fP) [oxygen] Merge forward from 2017.7 to oxygen
@ \fI2018\-02\-02 20:20:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
5f54ce7b5f Merge pull request \fI\%#45829\fP from rallytime/merge\-oxygen
.IP \(bu 2
34a17819ca Add opts to salt.utils.jid.gen_jid call in minion.py
.IP \(bu 2
79d071df9c Merge branch \(aq2017.7\(aq into \(aqoxygen\(aq
.IP \(bu 2
f234bf52f4 Merge pull request \fI\%#45756\fP from roaldnefs/fix\-grafana4\-documentation
.INDENT 2.0
.IP \(bu 2
92979c0b57 Fix grafana4 states documentation
.UNINDENT
.IP \(bu 2
685b683db5 Merge pull request \fI\%#45801\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
26e992e011 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
746386d04c Merge pull request \fI\%#45794\fP from vutny/doc\-file\-state\-examples
.INDENT 2.0
.IP \(bu 2
ddfeae6a29 [DOC] Fix code\-block rST directive in file state module
.UNINDENT
.IP \(bu 2
abc9ece214 Merge pull request \fI\%#45780\fP from vutny/doc\-pkgrepo\-zypper
.IP \(bu 2
f80c7d8d69 [DOC] Add missing gpgautoimport for pkgrepo.managed
.UNINDENT
.IP \(bu 2
c7d319f3bc Merge pull request \fI\%#45802\fP from rallytime/merge\-2017.7\-from\-2017.7.3
.INDENT 2.0
.IP \(bu 2
eb48513ba0 Merge branch \(aq2017.7.3\(aq into \(aq2017.7\(aq
.IP \(bu 2
1439da8d76 Merge pull request \fI\%#45755\fP from terminalmage/issue45743
.IP \(bu 2
8af1251c59 salt.crypt: Ensure message is encoded before signing
.UNINDENT
.IP \(bu 2
96e9232cc2 Merge pull request \fI\%#45761\fP from gtmanfred/2017.7
.IP \(bu 2
280767ed57 generate a jid for cache_jobs on the minion
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45819\fP: (\fI\%Giandom\fP) oxygen\-added\-highstate\-output\-to\-slack\-engine
@ \fI2018\-02\-01 18:38:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
3471796c51 Merge pull request \fI\%#45819\fP from Giandom/oxygen\-added\-highstate\-output\-to\-slack\-engine
.IP \(bu 2
1af8899a9d oxygen\-added\-highstate\-output\-to\-slack\-engine
.UNINDENT
.UNINDENT
.SS Salt 2018.3.2 Release Notes
.sp
Version 2018.3.2 is a bugfix release for \fI\%2018.3.0\fP\&.
.sp
The \fB2018.3.2\fP release contains only a small number of fixes, which are detailed
below.
.sp
This release fixes two critical issues.
.sp
The first is Issue \fI\%#48038\fP, which is a critical bug that occurs in a multi\-syndic
setup where the same job is run multiple times on a minion.
.sp
The second issue is \fI\%#48130\fP\&. This bug appears in certain setups where the Master
reports a Minion time\-out, even though the job is still running on the Minion.
.sp
Both of these issues have been fixed with this release.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB7\fP
.IP \(bu 2
Total Issue References: \fB2\fP
.IP \(bu 2
Total PR References: \fB10\fP
.IP \(bu 2
Contributors: \fB4\fP (\fI\%cro\fP, \fI\%garethgreenaway\fP, \fI\%gtmanfred\fP, \fI\%rallytime\fP)
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
If you are using Jinja to dump lists or dictionaries in your SLS files,
this will now cause errors in Python 2 since Jinja does not produce
YAML\-compatible output when strings in the data structures contain unicode
types. The dictionary must be passed through a Jinja filter to produce
YAML\-compatible strings.
.sp
The below is an example of invalid SLS:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.mangaged:
    \- source: salt://foo.conf
    \- template: jinja
    \- defaults: {{ mydict }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To make it valid, use either one of Salt\(aqs own \fBjson\fP or \fByaml\fP
filters:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.mangaged:
    \- source: salt://foo.conf
    \- template: jinja
    \- defaults: {{ mydict | json }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Changelog for v2018.3.1..v2018.3.2
.sp
\fIGenerated at: 2018\-06\-17 19:17:16 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBISSUE\fP \fI\%#48130\fP: (\fI\%rmarchei\fP) Minion timeouts with 2018.3.1 (refs: \fI\%#48158\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48158\fP: (\fI\%gtmanfred\fP) always listen when gathering job info
@ \fI2018\-06\-17 19:04:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
521e926458 Merge pull request \fI\%#48158\fP from gtmanfred/2018.3.2
.IP \(bu 2
cecf564433 always listen when gathering job info
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48138\fP: (\fI\%rallytime\fP) Update man pages for 2018.3.2
@ \fI2018\-06\-14 21:22:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
f154545aff Merge pull request \fI\%#48138\fP from rallytime/man\-pages\-2018.3.2
.IP \(bu 2
8c340134f5 Update man pages for 2018.3.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48137\fP: (\fI\%gtmanfred\fP) [2018.3.2] bootstrap kitchen branch tests with 2017.7.6
@ \fI2018\-06\-14 21:20:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
b49271b76d Merge pull request \fI\%#48137\fP from gtmanfred/2018.3.2
.IP \(bu 2
6128519e8b bootstrap kitchen branch tests with 2017.7.6
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48129\fP: (\fI\%rallytime\fP) Add release notes for 2018.3.2
@ \fI2018\-06\-14 15:48:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
21aaf1cbc4 Merge pull request \fI\%#48129\fP from rallytime/release\-notes\-2018.3.2
.IP \(bu 2
0b13be0111 Add release notes for 2018.3.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48100\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48014\fP to 2018.3.2
@ \fI2018\-06\-14 12:54:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48014\fP: (\fI\%cro\fP) Find job pause (refs: \fI\%#48100\fP)
.IP \(bu 2
36b99ae80a Merge pull request \fI\%#48100\fP from rallytime/bp\-48014
.IP \(bu 2
77feccc5c4 Lint: Add blank line
.IP \(bu 2
159b052962 One more case where returner doesn\(aqt respond
.IP \(bu 2
91b45b4cc4 Catch two cases when a returner is not able to be contacted\-\-these would throw a stacktrace.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48099\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47915\fP to 2018.3.2
@ \fI2018\-06\-14 12:54:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47915\fP: (\fI\%garethgreenaway\fP) [2018.3] state runner pause resume kill (refs: \fI\%#48099\fP)
.IP \(bu 2
40c1bfdec9 Merge pull request \fI\%#48099\fP from rallytime/bp\-47915
.IP \(bu 2
3556850058 fixing typo in alias_function call.
.IP \(bu 2
4b0ff496fa Some fixes to the set_pause and rm_pause function in the state runner, renaming to in line with the functions in the state module.  Including aliases to previous names for back\-ward compatibility.  Including a soft_kill function to kill running orchestration states.  A new test to test soft_kill functionality.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48038\fP: (\fI\%austinpapp\fP) jobs are not dedup\(aqing minion side (refs: \fI\%#48075\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48097\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48075\fP to 2018.3.2
@ \fI2018\-06\-14 12:52:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48075\fP: (\fI\%garethgreenaway\fP) [2017.7] Ensure that the shared list of jids is passed (refs: \fI\%#48097\fP)
.IP \(bu 2
074a97dcfa Merge pull request \fI\%#48097\fP from rallytime/bp\-48075
.IP \(bu 2
e4c719b55f Ensure that the shared list of jids is passed when creating the Minion.  Fixes an issue when minions are pointed at multiple syndics.
.UNINDENT
.UNINDENT
.SS Salt 2018.3.3 Release Notes
.sp
Version 2018.3.3 is a security and bugfix release for \fI\%2018.3.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB548\fP
.IP \(bu 2
Total Issue References: \fB69\fP
.IP \(bu 2
Total PR References: \fB341\fP
.IP \(bu 2
Contributors: \fB55\fP (\fI\%Ch3LL\fP, \fI\%FedericoCeratto\fP, \fI\%KaiSforza\fP, \fI\%L4rS6\fP, \fI\%Lutseslav\fP,
\fI\%The\-Loeki\fP, \fI\%Vaelatern\fP, \fI\%admd\fP, \fI\%aesposito91\fP, \fI\%asenci\fP, \fI\%astorath\fP, \fI\%azelezni\fP,
\fI\%babs\fP, \fI\%bbczeuz\fP, \fI\%bbinet\fP, \fI\%brejoc\fP, \fI\%cro\fP, \fI\%daa\fP, \fI\%dmurphy18\fP, \fI\%dubb\-b\fP, \fI\%dwoz\fP,
\fI\%eliasp\fP, \fI\%ezh\fP, \fI\%garethgreenaway\fP, \fI\%gtmanfred\fP, \fI\%isbm\fP, \fI\%jeduardo\fP, \fI\%kt97679\fP,
\fI\%kuetrzi\fP, \fI\%linoplt\fP, \fI\%lomeroe\fP, \fI\%lusche\fP, \fI\%mateiw\fP, \fI\%max\-arnold\fP, \fI\%maxim\-sermin\fP,
\fI\%meaksh\fP, \fI\%mmulqueen\fP, \fI\%morganwillcock\fP, \fI\%mtorromeo\fP, \fI\%nullify005\fP, \fI\%paulcollinsiii\fP,
\fI\%pritambaral\fP, \fI\%rallytime\fP, \fI\%rares\-pop\fP, \fI\%rmarchei\fP, \fI\%rosscdh\fP, \fI\%sizgiyaev\fP, \fI\%sjorge\fP,
\fI\%t0fik\fP, \fI\%terminalmage\fP, \fI\%travispaul\fP, \fI\%twangboy\fP, \fI\%vinian\fP, \fI\%weswhet\fP, \fI\%zerthimon\fP)
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
If you are using Jinja to dump lists or dictionaries in your SLS files,
this will now cause errors in Python 2 since Jinja does not produce
YAML\-compatible output when strings in the data structures contain unicode
types. The dictionary must be passed through a Jinja filter to produce
YAML\-compatible strings.
.sp
The below is an example of invalid SLS:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.mangaged:
    \- source: salt://foo.conf
    \- template: jinja
    \- defaults: {{ mydict }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To make it valid, use either one of Salt\(aqs own \fBjson\fP or \fByaml\fP
filters. Another option would be to use Jinja\(aqs \fI\%tojson\fP filter.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/foo.conf:
  file.mangaged:
    \- source: salt://foo.conf
    \- template: jinja
    \- defaults: {{ mydict | tojson }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Security Fix
.sp
CVE\-2018\-15751 Remote command execution and incorrect access control when using salt\-api.
.sp
CVE\-2018\-15750 Directory traversal vulnerability when using salt\-api. Allows an attacker to determine what files exist on a server when querying /run or /events.
.sp
Credit and thanks for discovery and responsible disclosure: nullbr4in, xcuter, koredge, loupos, blackcon, Naver Business Platform
.SS Changes to win_timezone
.sp
Improves timezone detection by using the pytz module.
.sp
\fBtimezone.get_offset\fP and \fBtimezone.get_zonecode\fP now work properly.
.sp
Adds \fBtimezone.list\fP to list supported timezones in either Windows or Unix
format.
.SS New Jinja Filter
.sp
The \fI\%tojson\fP filter (from Jinja 2.9 and later) has been ported to
Salt, and will be used when this filter is not available. This allows older LTS
releases such as CentOS 7 and Ubuntu 14.04 to use this filter.
.sp
You can use this filter any time you wish to dump a list or dictionary into an
SLS file, to ensure that the result is able to be loaded by the YAML renderer.
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  bar.baz:
    \- some_arg: {{ mydict | tojson }}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS MacOSX escape characters with runas
.sp
You are now required to escape quotes when using the runas argument with the
cmd module on macosx.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cmd.run \(aqecho \(aq\e\(aq\(aqh=\e\(dqbaz\e\(dq\(aq\e\(aq\(aq\(aq runas=macuser
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Changelog for v2018.3.2..v2018.3.3
.sp
\fIGenerated at: 2018\-09\-21 17:45:27 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#49662\fP: (\fI\%dwoz\fP) Fix another bad filename reference in whitelist
@ \fI2018\-09\-14 22:20:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d8cc0b3f4 Merge pull request \fI\%#49662\fP from dwoz/2018.3.3
.IP \(bu 2
e109023013 Fix another bad filename reference in whitelist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49655\fP: (\fI\%dwoz\fP) Fix windows test whitelist errors
@ \fI2018\-09\-14 20:34:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
6391560d57 Merge pull request \fI\%#49655\fP from dwoz/2018.3.3
.IP \(bu 2
8a4946478e Fix windows test whitelist errors
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49641\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49632\fP to 2018.3.3
@ \fI2018\-09\-13 16:46:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49632\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixing integration.states.test_file.FileTest.test_directory_max_depth (refs: \fI\%#49641\fP)
.IP \(bu 2
3fb3ffdb37 Merge pull request \fI\%#49641\fP from rallytime/bp\-49632
.IP \(bu 2
d11a400825 Fixing failing test under python 3.7 causaed by changes to how os.makedirs sets initial permissions.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49633\fP: (\fI\%garethgreenaway\fP) [2018.3.3] Moving test_build_whitespace_split_regex to TestBuildWhitespaceRegex
@ \fI2018\-09\-13 06:57:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
0096cf10b5 Merge pull request \fI\%#49633\fP from garethgreenaway/moving_test_into_correct_class
.IP \(bu 2
370de07617 Lint: Add extra blank line
.IP \(bu 2
27b93fcc68 Moving the test_build_whitespace_split_regex test into the TestBuildWhitespaceRegex class.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49594\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49580\fP to 2018.3.3
@ \fI2018\-09\-10 19:59:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49580\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixing tests for Python 3.7 (refs: \fI\%#49594\fP)
.IP \(bu 2
e3a14e3535 Merge pull request \fI\%#49594\fP from rallytime/bp\-49580
.IP \(bu 2
41a2586fc0 Add file coding line at top of file
.IP \(bu 2
7df3bebf53 Fixing lint.
.IP \(bu 2
5fee38d1db Fixes various tests that were failing under python 3.7.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49589\fP: (\fI\%rallytime\fP) Update old utils paths to use new utils paths
@ \fI2018\-09\-10 16:51:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
39f9c9c952 Merge pull request \fI\%#49589\fP from rallytime/utils\-paths
.IP \(bu 2
5de2245c11 Update old utils paths to use new utils paths
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49550\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49548\fP to 2018.3.3
@ \fI2018\-09\-07 00:36:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49548\fP: (\fI\%garethgreenaway\fP) [2018.3] Disabling State boto tests for Python 3.7+ (refs: \fI\%#49550\fP)
.IP \(bu 2
202da7a94f Merge pull request \fI\%#49550\fP from rallytime/bp\-49548
.IP \(bu 2
180692ccee Disable various boto tests when run under python 3.7 because of //github.com/spulec/moto/issues/1706. which was causing the test suite to hang on unit tests.  This PR is disabling the tests in the test_boto_vpc state tests.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49542\fP: (\fI\%twangboy\fP) Update openssl
@ \fI2018\-09\-06 16:11:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
cae2d61568 Merge pull request \fI\%#49542\fP from twangboy/fix_osx_build_3
.IP \(bu 2
fe02b2276f Add 1.0.2p shasum file
.IP \(bu 2
5f06dc2762 Fix issues with osx build scripts on 2018.3.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49536\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49524\fP to 2018.3.3
@ \fI2018\-09\-06 16:00:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49524\fP: (\fI\%garethgreenaway\fP) [2018.3] Disable boto tests under 3.7 (refs: \fI\%#49536\fP)
.IP \(bu 2
d9f09da5d9 Merge pull request \fI\%#49536\fP from rallytime/bp\-49524
.IP \(bu 2
9e7203e08a Disable various boto tests when run under python 3.7 because of //github.com/spulec/moto/issues/1706. which was causing the test suite to hang on unit tests.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49535\fP: (\fI\%Ch3LL\fP) Skip test_virt and pip_state requirements tests on macosx
@ \fI2018\-09\-06 15:59:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
cb934bf0b6 Merge pull request \fI\%#49535\fP from Ch3LL/skip_pip_mac
.IP \(bu 2
50237e9daf Skip test_virt and pip_state requirements tests on macosx
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49499\fP: (\fI\%rallytime\fP) Pin CherryPy version to < 18.0.0 in requirements files for PY2
@ \fI2018\-09\-04 18:52:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
87d3dfe085 Merge pull request \fI\%#49499\fP from rallytime/pin\-cherrypy\-2018.3.3
.IP \(bu 2
9e274335a3 Pin CherryPy version to < 18.0.0 in requirements files for PY2
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#1075\fP: (\fI\%Ch3LL\fP) [2018.3.3] arch python3 tests do not finish (refs: \fI\%#49303\fP, \fI\%#49451\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49467\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49451\fP to 2018.3.3
@ \fI2018\-08\-31 17:38:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49451\fP: (\fI\%gtmanfred\fP) Handle thread shutdown on system exit (refs: \fI\%#49467\fP)
.IP \(bu 2
39fdacc434 Merge pull request \fI\%#49467\fP from rallytime/bp\-49451
.IP \(bu 2
b891a0a8d3 add lock for proxy minion process too
.IP \(bu 2
72519878c0 start thread in try block
.IP \(bu 2
b878f01662 use finally instead of catching baseexception
.IP \(bu 2
de98be6093 use rlock so blocking can be passed in py2
.IP \(bu 2
d346b42332 import Callable from collections.abc for python3.7
.IP \(bu 2
d7a410070a Handle thread shutdown on system exit
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49468\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49291\fP and \fI\%#49331\fP to 2018.3.3
@ \fI2018\-08\-31 17:37:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49331\fP: (\fI\%dwoz\fP) Use salt.utils to ensure string type (refs: \fI\%#49468\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49291\fP: (\fI\%dwoz\fP) Add dedent that sets line endings (refs: \fI\%#49468\fP)
.IP \(bu 2
37d1455d69 Merge pull request \fI\%#49468\fP from rallytime/bp\-49291\-and\-49331
.IP \(bu 2
944f8e96c8 Use salt.utils to ensure string type
.IP \(bu 2
6c92ed2021 Fix review nits
.IP \(bu 2
0e18b157e3 Re\-factor dedent to fix warts
.IP \(bu 2
b5034067f8 Use salt.utils.to_* functions
.IP \(bu 2
6399d035a4 Add dedent that sets line endings
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49449\fP: (\fI\%rallytime\fP) Mark status test as flaky
@ \fI2018\-08\-30 18:10:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
0cda22e7a9 Merge pull request \fI\%#49449\fP from rallytime/flaky\-test
.IP \(bu 2
0f322bb39f Mark status test as flaky
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49444\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49299\fP to 2018.3.3
@ \fI2018\-08\-30 18:10:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49299\fP: (\fI\%dwoz\fP) Work around cmd.run unicode issues in test for now (refs: \fI\%#49444\fP)
.IP \(bu 2
bcc5f1a7c1 Merge pull request \fI\%#49444\fP from rallytime/bp\-49299
.IP \(bu 2
b8c5a5bb91 Fix string formatting wart in file state tests
.IP \(bu 2
19756022be Fix wart in file state test
.IP \(bu 2
ba68388342 Work around cmd.run unicode issues in test for now
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49448\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49400\fP to 2018.3.3
@ \fI2018\-08\-30 18:04:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49400\fP: (\fI\%rallytime\fP) Mark pillar refresh test as flaky (refs: \fI\%#49448\fP)
.IP \(bu 2
38713e2db9 Merge pull request \fI\%#49448\fP from rallytime/bp\-49400
.IP \(bu 2
b953fe0079 Mark pillar refresh test as flaky
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49446\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49356\fP to 2018.3.3
@ \fI2018\-08\-30 18:04:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49356\fP: (\fI\%dwoz\fP) Fix tests that use timed_subprocess for py3 (refs: \fI\%#49446\fP)
.IP \(bu 2
d6ddcab351 Merge pull request \fI\%#49446\fP from rallytime/bp\-49356
.IP \(bu 2
8022b0c3d6 Fix tests that use timed_subprocess for py3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49445\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49192\fP to 2018.3.3
@ \fI2018\-08\-30 18:03:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49192\fP: (\fI\%dwoz\fP) Test fixes flaky test and unicode environment key/value (refs: \fI\%#49445\fP)
.IP \(bu 2
1a67956c0f Merge pull request \fI\%#49445\fP from rallytime/bp\-49192
.IP \(bu 2
20148d4438 Test fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49443\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49197\fP to 2018.3.3
@ \fI2018\-08\-30 18:03:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49197\fP: (\fI\%dwoz\fP) File state line ending fixes (refs: \fI\%#49443\fP)
.IP \(bu 2
33f59d44de Merge pull request \fI\%#49443\fP from rallytime/bp\-49197
.IP \(bu 2
5fe821978e File state line ending fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49442\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49180\fP and related fixes to 2018.3.3
@ \fI2018\-08\-30 18:02:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49186\fP: (\fI\%dwoz\fP) Fix typo in \fI\%#49180\fP (refs: \fI\%#49442\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49180\fP: (\fI\%dwoz\fP) Cherry\-pick test fixes (refs: \fI\%#49442\fP, \fI\%#49186\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49167\fP: (\fI\%dwoz\fP) Fix remaining file state integration tests (py3) (refs: \fI\%#49173\fP, \fI\%#49442\fP)
.IP \(bu 2
60758059c3 Merge pull request \fI\%#49442\fP from rallytime/bp\-49180
.IP \(bu 2
e155568957 Fix typo
.IP \(bu 2
608a1ae7ba Account for file renames
.IP \(bu 2
e8e6a46a2b Fix directory unit test
.IP \(bu 2
2f865c398e Fix is_windows checks
.IP \(bu 2
6460f7f217 Account for normalized dirs in unit tests
.IP \(bu 2
f4b7101a35 Simplify dict keys lookup
.IP \(bu 2
942b68bfc8 Fix remaining file state integration tests (py3)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49441\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49240\fP to 2018.3.3
@ \fI2018\-08\-30 18:02:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49240\fP: (\fI\%dwoz\fP) file state test fixes (refs: \fI\%#49362\fP, \fI\%#49441\fP)
.IP \(bu 2
1f4906346a Merge pull request \fI\%#49441\fP from rallytime/bp\-49240
.IP \(bu 2
22ed452479 Work around listdir encoding issues on py2 windows
.IP \(bu 2
f5be275835 file state test fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49440\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49258\fP to 2018.3.3
@ \fI2018\-08\-30 18:02:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49258\fP: (\fI\%gtmanfred\fP) flaky tests are flaky (refs: \fI\%#49440\fP)
.IP \(bu 2
cc27b67a37 Merge pull request \fI\%#49440\fP from rallytime/bp\-49258
.IP \(bu 2
0191af1423 flaky tests are flaky yo
.IP \(bu 2
720b671dda mark orchestration state tests as flaky
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48880\fP: (\fI\%damntoken\fP) Can\(aqt run cmd.run with UTF\-8 chars as arguments / parameters. With custom module. (refs: \fI\%#49322\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49368\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49322\fP to 2018.3.3
@ \fI2018\-08\-28 17:15:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49322\fP: (\fI\%dwoz\fP) Encode shell commands explicitly. (refs: \fI\%#49368\fP)
.IP \(bu 2
af80e64569 Merge pull request \fI\%#49368\fP from rallytime/bp\-49322
.IP \(bu 2
238853b9ec Encode shell commands explicitly.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49363\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49245\fP to 2018.3.3
@ \fI2018\-08\-28 17:14:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49245\fP: (\fI\%dwoz\fP) Skip grep unit tests on windows (refs: \fI\%#49363\fP)
.IP \(bu 2
0fee3e8786 Merge pull request \fI\%#49363\fP from rallytime/bp\-49245
.IP \(bu 2
cc606509d0 Fix is_windows call \- use the right path
.IP \(bu 2
5488fbea38 Skip grep unit tests on windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49361\fP: (\fI\%rallytime\fP) Back\-port  \fI\%#49244\fP to 2018.3.3
@ \fI2018\-08\-28 17:12:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49244\fP: (\fI\%dwoz\fP) Test fixes: unit.fileserver.test_gitfs (refs: \fI\%#49361\fP)
.IP \(bu 2
dbcd2fc726 Merge pull request \fI\%#49361\fP from rallytime/bp\-49244
.IP \(bu 2
e0909d3a25 Simplify by using to_unicode helper
.IP \(bu 2
4723c69092 Older GitPython version do not have a close method
.IP \(bu 2
d5fecba716 Fix up fileserver.test_gitfs tests on windows
.IP \(bu 2
4b688f6347 Remove unicode filenames on windows python 2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49362\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49240\fP to 2018.3.3
@ \fI2018\-08\-28 17:00:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49240\fP: (\fI\%dwoz\fP) file state test fixes (refs: \fI\%#49362\fP, \fI\%#49441\fP)
.IP \(bu 2
b4a1e1d365 Merge pull request \fI\%#49362\fP from rallytime/bp\-49240
.IP \(bu 2
16ca5b9694 Work around listdir encoding issues on py2 windows
.IP \(bu 2
7650208dbc file state test fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49365\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49270\fP to 2018.3.3
@ \fI2018\-08\-28 16:56:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49270\fP: (\fI\%dwoz\fP) Add async helper to test_sock_path_len (refs: \fI\%#49365\fP)
.IP \(bu 2
9ca9a775ff Merge pull request \fI\%#49365\fP from rallytime/bp\-49270
.IP \(bu 2
1b3f37a8b8 Add async helper to test_sock_path_len
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49364\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49243\fP to 2018.3.3
@ \fI2018\-08\-28 16:55:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49243\fP: (\fI\%dwoz\fP) Revert newline translation change (refs: \fI\%#49364\fP)
.IP \(bu 2
bbff57da16 Merge pull request \fI\%#49364\fP from rallytime/bp\-49243
.IP \(bu 2
5db77c6229 Revert newline translation change
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49347\fP: (\fI\%Ch3LL\fP) [2018.3.3] Backport \fI\%#49345\fP
@ \fI2018\-08\-28 01:54:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49345\fP: (\fI\%gtmanfred\fP) upgrade including linux kernels (refs: \fI\%#49347\fP)
.IP \(bu 2
74b78835b3 Merge pull request \fI\%#49347\fP from Ch3LL/bp_49345_2018.3.3
.IP \(bu 2
7bf5ba83c8 upgrade including linux kernels
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49323\fP: (\fI\%Ch3LL\fP) Skip nonexistent branch test for git versions <1.7.10
@ \fI2018\-08\-25 19:52:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
be6691d91b Merge pull request \fI\%#49323\fP from Ch3LL/skip_git
.IP \(bu 2
ee3d32f74e Skip nonexistent branch for git versions <1.7.10
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32737\fP: (\fI\%Lothiraldan\fP) No support for compound matcher in external auth configuration (refs: \fI\%#49236\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49313\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49236\fP to 2018.3.3
@ \fI2018\-08\-24 20:59:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49236\fP: (\fI\%terminalmage\fP) Allow compound matching in eauth config expressions (refs: \fI\%#49313\fP)
.IP \(bu 2
64d7b0e4c6 Merge pull request \fI\%#49313\fP from rallytime/bp\-49236
.IP \(bu 2
1a5ef996e3 Add \(aqminion_data_cache: True\(aq to mocked opts for minions unit tests
.IP \(bu 2
549f5d5a86 Allow compound matching in eauth config expressions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#1075\fP: (\fI\%Ch3LL\fP) [2018.3.3] arch python3 tests do not finish (refs: \fI\%#49303\fP, \fI\%#49451\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49311\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49303\fP to 2018.3.3
@ \fI2018\-08\-24 17:48:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49303\fP: (\fI\%gtmanfred\fP) use os._exit instead of sys.exit when daemonizing (refs: \fI\%#49311\fP)
.IP \(bu 2
7a89a4c8aa Merge pull request \fI\%#49311\fP from rallytime/bp\-49303
.IP \(bu 2
3fe1387751 use os._exit instead of sys.exit when daemonizing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49294\fP: (\fI\%Ch3LL\fP) Move run_function call from __init__ to setup
@ \fI2018\-08\-24 12:41:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
7bb356f11e Merge pull request \fI\%#49294\fP from Ch3LL/fed_28_tests
.IP \(bu 2
0a5d44a3db Move run_function call from __init__ to setup
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49302\fP: (\fI\%twangboy\fP) Fix installer 2018.3.3
@ \fI2018\-08\-24 12:41:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
a607f9332f Merge pull request \fI\%#49302\fP from twangboy/fix_installer_2018.3.3
.IP \(bu 2
68fd37575e Fix erroneous NSSM reference
.IP \(bu 2
103f2c289e Remove delete vcredist line
.IP \(bu 2
007a16638e Bring installer updates from 2017.7.8 to 2018.3.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49241\fP: (\fI\%terminalmage\fP) Don\(aqt silently catch SystemExit
@ \fI2018\-08\-22 12:57:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
bc0b4ac513 Merge pull request \fI\%#49241\fP from terminalmage/salt\-jenkins\-1078
.IP \(bu 2
08d144f2c7 Don\(aqt silently catch SystemExit
.IP \(bu 2
c0fdb818f7 Don\(aqt use a bare except!
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49239\fP: (\fI\%Ch3LL\fP) Use yaml\(aqs safe_dump in windows ec2 tests
@ \fI2018\-08\-22 08:48:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
0fb9ccf60a Merge pull request \fI\%#49239\fP from Ch3LL/win_yaml_test
.IP \(bu 2
f5b42dbb24 import salt.utils.yaml
.IP \(bu 2
67290eaff7 Use yaml\(aqs safe_dump in windows ec2 tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49182\fP: (\fI\%terminalmage\fP) Fix hanging syndic test
@ \fI2018\-08\-18 12:10:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
134f125b96 Merge pull request \fI\%#49182\fP from terminalmage/salt\-jenkins\-1078
.IP \(bu 2
a2d2cd317b Fix hanging syndic test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49172\fP: (\fI\%Ch3LL\fP) [2018.3.3] cherry pick \fI\%#49118\fP
@ \fI2018\-08\-17 20:54:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49118\fP: (\fI\%dwoz\fP) Multiple fixes for integration.states.test_file (refs: \fI\%#49172\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49088\fP: (\fI\%dwoz\fP) Multiple file state test fixes (refs: \fI\%#49118\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49087\fP: (\fI\%dwoz\fP) Filter out scheme\(aqs that are not valid (refs: \fI\%#49118\fP)
.IP \(bu 2
b3a247bfbb Merge pull request \fI\%#49172\fP from Ch3LL/bp\-49118
.IP \(bu 2
ce5e17bdbd update is_windows salt.utils to correct path
.IP \(bu 2
3fef112409 Multiple fixes for integration.states.test_file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49173\fP: (\fI\%Ch3LL\fP) [2018.3.3] cherry pick \fI\%#49167\fP
@ \fI2018\-08\-17 20:30:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49167\fP: (\fI\%dwoz\fP) Fix remaining file state integration tests (py3) (refs: \fI\%#49173\fP, \fI\%#49442\fP)
.IP \(bu 2
85ffc8db87 Merge pull request \fI\%#49173\fP from Ch3LL/bp\-49167
.IP \(bu 2
a1a298a13c Simplify dict keys lookup
.IP \(bu 2
3d26affa10 Fix remaining file state integration tests (py3)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49171\fP: (\fI\%Ch3LL\fP) [2018.3.3] cherry pick \fI\%#49103\fP
@ \fI2018\-08\-17 20:23:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49103\fP: (\fI\%dwoz\fP) Install the launcher so we can execute py files (refs: \fI\%#49171\fP)
.IP \(bu 2
ee54ea5f73 Merge pull request \fI\%#49171\fP from Ch3LL/bp\-49103
.IP \(bu 2
05a2b91fb2 Install the launcher so we can execute py files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49132\fP: (\fI\%Ch3LL\fP) [2018.3.3] backport PR \fI\%#49062\fP
@ \fI2018\-08\-17 14:51:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49062\fP: (\fI\%weswhet\fP) fix memoize on available macOS services (refs: \fI\%#49132\fP)
.IP \(bu 2
58034c9dc3 Merge pull request \fI\%#49132\fP from Ch3LL/bp\-49062
.IP \(bu 2
990fdb6a52 decorator link fix, updating context names, as well as updating macutils tests for latest changes
.IP \(bu 2
3ab5d282be fixing an issue with memoize on macOS services, switching to useing __context__ instead
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49142\fP: (\fI\%Ch3LL\fP) Remove \-Z script_arg for cloud tests
@ \fI2018\-08\-16 16:12:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
01f8f83cf0 Merge pull request \fI\%#49142\fP from Ch3LL/rm_z_arg
.IP \(bu 2
a1ef6a88a6 Remove \-Z script_arg for cloud tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49137\fP: (\fI\%Ch3LL\fP) [2018.3.3] Update bootstrap script to latest release (2018.08.15)
@ \fI2018\-08\-15 19:49:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
a03828884b Merge pull request \fI\%#49137\fP from Ch3LL/bootstrap_2018.3.3
.IP \(bu 2
eb9a612096 [2018.3.3] Update bootstrap script to latest release (2018.08.15)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49110\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-08\-14 17:11:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
b412bff534 Merge pull request \fI\%#49110\fP from rallytime/merge\-2018.3
.IP \(bu 2
4649f60209 Update old utils paths with new paths
.IP \(bu 2
49c2a784bb Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
d46e23f4c2 Merge pull request \fI\%#49109\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
3c5527f300 Merge branch \(aq2017.7.8\(aq into \(aq2017.7\(aq
.IP \(bu 2
01cf2c71ff Merge pull request \fI\%#49051\fP from rallytime/bp\-49046
.INDENT 2.0
.IP \(bu 2
fc0817cb35 The osfullname grain differs when using Python2 vs Python3, swapping this out for the \(dqOS\(dq grain which is consistent.
.UNINDENT
.UNINDENT
.IP \(bu 2
8954dd269f Merge pull request \fI\%#49090\fP from dwoz/file_line_fix
.INDENT 2.0
.IP \(bu 2
0dca634e3c Search for (but do not include) CRLF line ending
.UNINDENT
.IP \(bu 2
b99edc3dce Merge pull request \fI\%#49088\fP from dwoz/file_hash_diffs
.INDENT 2.0
.IP \(bu 2
054afb8197 Multiple file state test fixes
.UNINDENT
.IP \(bu 2
274977b6c4 Merge pull request \fI\%#49087\fP from dwoz/url_file_test_fixes
.INDENT 2.0
.IP \(bu 2
632b65f975 Filter out scheme\(aqs that are not valid
.UNINDENT
.IP \(bu 2
db5fb3232a Merge pull request \fI\%#49086\fP from rallytime/new\-doc\-img
.INDENT 2.0
.IP \(bu 2
90954203cb Update the DOCBANNER image for saltconf
.UNINDENT
.IP \(bu 2
af6ec1dce2 Merge pull request \fI\%#49045\fP from twangboy/fix_43164
.INDENT 2.0
.IP \(bu 2
589456d08f Fix lint errors
.IP \(bu 2
e79243566d Add rallytime\(aqs suggestions
.IP \(bu 2
d1ae6b3d6d Fix docs for the registry module and state
.UNINDENT
.IP \(bu 2
a840fea1a1 Merge pull request \fI\%#49083\fP from rallytime/bootstrap\-2017.7
.INDENT 2.0
.IP \(bu 2
358e14cdac [2017.7] Update bootstrap script to latest release
.UNINDENT
.IP \(bu 2
9db6cd5654 Merge pull request \fI\%#49059\fP from twangboy/fix_37984
.INDENT 2.0
.IP \(bu 2
7ed45b5b00 Remove import
.IP \(bu 2
7fb1edb469 Fix docs to clarify uptime output on Windows
.UNINDENT
.IP \(bu 2
f9db72f00c Merge pull request \fI\%#49061\fP from saltstack/revert\-48982\-new_logo_2017.7
.INDENT 2.0
.IP \(bu 2
98a8da728b Revert \(dqNew logo 2017.7 (WIP)\(dq
.UNINDENT
.IP \(bu 2
bbcd1869ec Merge pull request \fI\%#48982\fP from newwebash/new_logo_2017.7
.INDENT 2.0
.IP \(bu 2
5c1c311f77 Update Salt Conf ad
.IP \(bu 2
72dc63c426 Merge branch \(aq2017.7\(aq of \fI\%https://github.com/saltstack/salt\fP into new_logo_2017.7
.IP \(bu 2
9f4e78a7b9 Revert \(dqUpdate saltconf ad\(dq
.IP \(bu 2
3ab8cdb882 Update saltconf ad
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48665\fP: (\fI\%dgengtek\fP) salt\-api auth ldap generates a valid token when using bindpw and an invalid request (refs: \fI\%#48901\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48901\fP: (\fI\%garethgreenaway\fP) [2018.3] fix to auth/ldap.py
@ \fI2018\-08\-14 16:10:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
e78fc0e0eb Merge pull request \fI\%#48901\fP from garethgreenaway/48665_auth_ldap_valid_token_failed_auth
.IP \(bu 2
d4e4f2e803 Fixing a typo in a comment.
.IP \(bu 2
2eb167ea42 Fixing issue when a valid token is generated even when invalid user credentials are passed.  This change verifies that the binddn credentials are valid, then verifies that the username & password (if not None) are also valid.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49081\fP: (\fI\%frogunder\fP) Fluorine \- I see error/traceback when running minion in debug mode  (refs: \fI\%#49085\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49099\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49085\fP to 2018.3
@ \fI2018\-08\-14 12:42:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49085\fP: (\fI\%gtmanfred\fP) fix async call to process manager (refs: \fI\%#49099\fP)
.IP \(bu 2
484c1e0123 Merge pull request \fI\%#49099\fP from rallytime/bp\-49085
.IP \(bu 2
024d9cb843 fix async call to process manager
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49018\fP: (\fI\%Ch3LL\fP) add MasterPillarUtil tests (refs: \fI\%#49034\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49071\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49034\fP to 2018.3
@ \fI2018\-08\-13 20:15:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49034\fP: (\fI\%garethgreenaway\fP) [fluorine] Adding tests for MasterPillarUtil (refs: \fI\%#49071\fP)
.IP \(bu 2
bc033da677 Merge pull request \fI\%#49071\fP from rallytime/bp\-49034
.IP \(bu 2
8108a4d31a Adding some tests for the grains, pillar and mine functions in the cache runner.  These will also ensure that the relevant functions in salt.utils.master.MasterPillarUtil are functioning properly.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49077\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49075\fP to 2018.3
@ \fI2018\-08\-13 20:00:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49075\fP: (\fI\%gtmanfred\fP) fix last async issue (refs: \fI\%#49077\fP)
.IP \(bu 2
90c2f026b3 Merge pull request \fI\%#49077\fP from rallytime/bp\-49075
.IP \(bu 2
5e07b8306b fix last async issue
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49096\fP: (\fI\%rallytime\fP) Update the DOCBANNER image for saltconf
@ \fI2018\-08\-13 19:59:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
6942ef1102 Merge pull request \fI\%#49096\fP from rallytime/new\-doc\-img\-2018.3
.IP \(bu 2
75080705ce Update the DOCBANNER image for saltconf
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49055\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-08\-13 19:20:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
0e1ed7b923 Merge pull request \fI\%#49055\fP from rallytime/merge\-2018.3
.IP \(bu 2
83a15cb623 Add optimization_order config to mocked opts
.IP \(bu 2
ea6883ee55 Update old utils paths to new utils paths
.IP \(bu 2
201031fa8a Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
0d2a495378 Merge pull request \fI\%#49050\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
ed6fb8b739 Merge branch \(aq2017.7.8\(aq into \(aq2017.7\(aq
.IP \(bu 2
189e28691f Merge pull request \fI\%#49044\fP from Ch3LL/vultr_test
.INDENT 2.0
.IP \(bu 2
0dedfae4d1 increase timeout on vultr cloud integration test
.UNINDENT
.IP \(bu 2
c606a32cf2 Merge pull request \fI\%#49042\fP from rallytime/flaky\-jinja\-test
.INDENT 2.0
.IP \(bu 2
a43d9b4ba6 Mark a jinja template test as flaky
.UNINDENT
.IP \(bu 2
6415b6f73b Merge pull request \fI\%#49041\fP from Ch3LL/ec2_fix
.INDENT 2.0
.IP \(bu 2
cf7f2459b8 [2017.7.8] backport PR \fI\%#48212\fP
.UNINDENT
.IP \(bu 2
1db036406b Merge pull request \fI\%#49030\fP from rallytime/update\-client\-tests
.INDENT 2.0
.IP \(bu 2
f08ee6c6ae Update netapi client tests
.UNINDENT
.UNINDENT
.IP \(bu 2
70be9ac9b1 Merge pull request \fI\%#49046\fP from garethgreenaway/1022_fixing_test_failing_py3_Debian_test
.INDENT 2.0
.IP \(bu 2
fa2339bb91 The osfullname grain differs when using Python2 vs Python3, swapping this out for the \(dqOS\(dq grain which is consistent.
.UNINDENT
.IP \(bu 2
69c9b0afb1 Merge pull request \fI\%#49036\fP from cspeidel/doc\-fix\-netyang
.INDENT 2.0
.IP \(bu 2
f7ac085eb5 minor doc fix in netyang.py
.UNINDENT
.IP \(bu 2
c5f3fd6b2b Merge pull request \fI\%#48997\fP from AVeenstra/patch\-1
.INDENT 2.0
.IP \(bu 2
0e535f2c8c Unpacking dict with the six iterator
.IP \(bu 2
5e82685b89 Python 3 related fix in highstate_return.py
.UNINDENT
.IP \(bu 2
c06a3cf531 Merge pull request \fI\%#49021\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
ca82b3d57a Merge branch \(aq2017.7.8\(aq into merge\-2017.7
.INDENT 2.0
.IP \(bu 2
f73ba21bc7 Merge pull request \fI\%#49024\fP from rallytime/fix\-deb\-test
.INDENT 2.0
.IP \(bu 2
a9c16d9137 Fix test error in test_compiler jinja check
.UNINDENT
.UNINDENT
.IP \(bu 2
c6f8429e41 Merge branch \(aq2017.7.8\(aq into \(aq2017.7\(aq
.IP \(bu 2
6b6d68c615 Merge pull request \fI\%#49020\fP from rallytime/fix\-grains\-test
.INDENT 2.0
.IP \(bu 2
f72a3ac6be Make grains integration test more robust
.UNINDENT
.IP \(bu 2
92d6c25c7f Merge pull request \fI\%#49002\fP from rallytime/skip\-jinja\-deep\-error\-test
.INDENT 2.0
.IP \(bu 2
23b66ef8bb Skip test_jinja_deep_error on Debian 8
.UNINDENT
.IP \(bu 2
41d9f11eb3 Merge pull request \fI\%#48999\fP from rallytime/fix\-boto\-test
.INDENT 2.0
.IP \(bu 2
d0136b1be5 Update expected return value in boto test
.UNINDENT
.UNINDENT
.IP \(bu 2
2ddba6391a Merge pull request \fI\%#49010\fP from Ch3LL/univention
.INDENT 2.0
.IP \(bu 2
c09bce9afe Add univention OS to debian os_family mapping
.UNINDENT
.IP \(bu 2
41bd36842e Merge pull request \fI\%#48636\fP from terminalmage/loader\-fixes
.INDENT 2.0
.IP \(bu 2
0441cd56ef Add optimization_order to mocking
.IP \(bu 2
2256fad320 Process pycache files after .py files
.IP \(bu 2
a78663a301 Lint
.IP \(bu 2
0728b5f8b6 Add note about Python 3.5+ only support for optimization_order
.IP \(bu 2
764969ce08 Add a test to confirm that .py files are still loaded correctly
.IP \(bu 2
0f60beb6b6 Fix bad copypasta
.IP \(bu 2
fbcd142ea2 Add configuration docs for optimization_order config option
.IP \(bu 2
8af2d580f3 Only compile the suffix_order/map once per LazyLoader instance
.IP \(bu 2
4b95e5f313 Don\(aqt put __pycache__ dir in the file list
.IP \(bu 2
e7c10196da Quiet the byte compiling for PY2
.IP \(bu 2
9338370477 Add unit tests for loader optimization levels
.IP \(bu 2
c3622933c1 PY3: Support different optimization levels
.IP \(bu 2
6fc8da5bab Add optimization_order config option with default value
.IP \(bu 2
dfe423a1e0 Remove commented\-out log message
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49084\fP: (\fI\%rallytime\fP) [2018.3] Update bootstrap script to latest release
@ \fI2018\-08\-13 18:14:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
db7ec46875 Merge pull request \fI\%#49084\fP from rallytime/bootstrap\-2018.3
.IP \(bu 2
28dc8ce954 [2017.7] Update bootstrap script to latest release
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49052\fP: (\fI\%isbm\fP) Python 3.7 support (backport 2018.3)
@ \fI2018\-08\-13 13:06:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
b0d5acbe0d Merge pull request \fI\%#49052\fP from isbm/isbm\-python37\-support\-2018.3
.IP \(bu 2
4386a9ca1f Merge branch \(aq2018.3\(aq into isbm\-python37\-support\-2018.3
.IP \(bu 2
bc85a5fa98 Fix configuration setting
.IP \(bu 2
47078a300f Remove async keyword, moving it into the kwargs.
.IP \(bu 2
31dccc4fdf fix unicode literals
.IP \(bu 2
990936992c Keep runner API unchanged
.IP \(bu 2
46bafcafef Fix nag\-message
.IP \(bu 2
5c887ac2ae Support original API
.IP \(bu 2
2c22e794d4 Use kwargs instead of directly named parameters
.IP \(bu 2
7d095491d9 Update docstring
.IP \(bu 2
9807e8dbb7 Add \(aqasync\(aq backward compatibility
.IP \(bu 2
e8608aa9be Revert api call: it is about \(dqfunctionname_async\(dq suffix.
.IP \(bu 2
0543578336 Deprecate \(aqasync\(aq parameter in Mandrill API
.IP \(bu 2
1107de0dec Lintfix: PEP8 requires two empty lines
.IP \(bu 2
2a18e335af Fix function signatures in Cassandra module
.IP \(bu 2
603f94e2a3 Cleanup docstrings at module level
.IP \(bu 2
b9718d3a09 Fix log error/info/warning and exception messages
.IP \(bu 2
6e77aff69a Fix local opts from CLI
.IP \(bu 2
493e48ddb5 Remove internal variables/properties with the reserved words
.IP \(bu 2
be07f64bc4 Change internal function signatures to avoid reserved word
.IP \(bu 2
7d095e0b26 Rename async function to asynchronous
.IP \(bu 2
35eaebb8a4 Fix docstrings
.IP \(bu 2
7a597f19b5 Fix comments
.IP \(bu 2
69920366ae Fix CLI config
.IP \(bu 2
173f3d7aa8 Fix docstring typo
.IP \(bu 2
b7da571624 Fix imports
.IP \(bu 2
7ec3954bef Rename module to full wording
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48557\fP: (\fI\%whytewolf\fP) file.line in python3 on windows 2012 r2 is adding extra CR line endings.  (refs: \fI\%#49026\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49026\fP: (\fI\%dwoz\fP) Fix file.line line endings
@ \fI2018\-08\-13 13:05:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
338ecb70ef Merge pull request \fI\%#49026\fP from dwoz/issue_48557
.IP \(bu 2
a4d22fda2f Merge remote\-tracking branch \(aqorigin/issue_48557\(aq into issue_48557
.INDENT 2.0
.IP \(bu 2
702e76cfc9 Merge branch \(aq2018.3\(aq into issue_48557
.UNINDENT
.IP \(bu 2
6cf93e8fc4 Skip newline in binary mode
.IP \(bu 2
2cf80c1595 Fix linter errors
.IP \(bu 2
baf291b4c8 Fix file.line line endings
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49038\fP: (\fI\%gtmanfred\fP) disable enable_ssh_minions to see if it is slowing down 2018.3 tests
@ \fI2018\-08\-10 18:07:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
602fed7806 Merge pull request \fI\%#49038\fP from gtmanfred/slowtest
.IP \(bu 2
6bc44c91c4 remove localhost from tests
.IP \(bu 2
7b168a5aac disable enable_ssh_minions to see if it is slowing down 2018.3 tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48996\fP: (\fI\%jils2013\fP) file.get_diff not work on version:2018.3.2  (refs: \fI\%#49033\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49033\fP: (\fI\%terminalmage\fP) Fix file.get_diff for remote files
@ \fI2018\-08\-09 21:06:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
4eeb75f028 Merge pull request \fI\%#49033\fP from terminalmage/issue48996
.IP \(bu 2
163aea71c8 Lint
.IP \(bu 2
d6e5038022 Fix file.get_diff for remote files
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48856\fP: (\fI\%travispaul\fP) Salt fails to start on NetBSD 8 (refs: \fI\%#48926\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48926\fP: (\fI\%travispaul\fP) Handle ifconfig output differently for NetBSD >= 8.0
@ \fI2018\-08\-09 20:07:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
b24c96a292 Merge pull request \fI\%#48926\fP from travispaul/fix\-netbsd\-8\-new\-ifconfig
.IP \(bu 2
d59b6d8269 Add unit test for NetBSD 8 ifconfig changes
.IP \(bu 2
80f8a667d1 Handle ifconfig output differently for NetBSD >= 8.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48803\fP: (\fI\%dmurphy18\fP) Support for execution modules and states mount on AIX
@ \fI2018\-08\-09 17:51:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
7d6b9ed0a5 Merge pull request \fI\%#48803\fP from dmurphy18/aix_filesystems
.IP \(bu 2
92818f816b Fixes for testing
.IP \(bu 2
77dd7a1743 Adjust unit tests
.IP \(bu 2
eaed033cde Updated for review comments and adjusted locking when writing files
.IP \(bu 2
5bf9e6085b Update due to review comments
.IP \(bu 2
9fb5641dc7 Mount unit tests for modules and states for AIX
.IP \(bu 2
b28f427432 Save off work after laptop issue
.IP \(bu 2
e5c2741fe7 module and states mount support for AIX
.IP \(bu 2
b701e16ad0 Further updates to support for mount on AIX
.IP \(bu 2
210076276f Initial support for handling /etc/filesystems on AIX
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48496\fP: (\fI\%icy\fP) Salt\-key unable to delete the certificate Test=True (refs: \fI\%#48929\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48929\fP: (\fI\%terminalmage\fP) 2 salt\-key fixes
@ \fI2018\-08\-09 17:50:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
2a38905a8a Merge pull request \fI\%#48929\fP from terminalmage/issue48496
.IP \(bu 2
7ac10f9eac 2 salt\-key fixes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47481\fP: (\fI\%whytewolf\fP) Oxygen: task.add_trigger with start_date stating strptime needs a string not int. (refs: \fI\%#49022\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49022\fP: (\fI\%dwoz\fP) Document time format idiosyncrasies
@ \fI2018\-08\-09 17:47:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb9d23bfa1 Merge pull request \fI\%#49022\fP from dwoz/47481_docs
.IP \(bu 2
313a3d93d6 Document time format idiosyncrasies
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48932\fP: (\fI\%twangboy\fP) Fix pkg.install when pkg already installed
@ \fI2018\-08\-09 17:45:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
9b6a9ff4f1 Merge pull request \fI\%#48932\fP from twangboy/fix_win_repo
.IP \(bu 2
075ea29d29 remove .lower(), fix debug messages
.IP \(bu 2
d7c2f476ac Remove current: version for latest as well
.IP \(bu 2
522ac26459 Fix typo in code comment
.IP \(bu 2
47b2898a85 return empty dict on no changes
.IP \(bu 2
6532706d2f Make the tests run on Linux
.IP \(bu 2
cfe55a391a Add tests for pkg.install output
.IP \(bu 2
8ec058f498 Clarify code comment
.IP \(bu 2
8af2cfd54a Fix issues where current is not returned
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49011\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-08\-09 17:34:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
d7b7a92ef6 Merge pull request \fI\%#49011\fP from rallytime/merge\-2018.3
.IP \(bu 2
02670969d0 Apply fix to ssh init file that was there before merge
.IP \(bu 2
7e1f7915e4 Revert \(dqAllow for not being prompted to supply a password to deploy keys to a minion with salt\-ssh\(dq
.IP \(bu 2
00416d54d1 Revert \(dqadd key\-deploy test\(dq
.IP \(bu 2
c26fa0d6c4 Mark orchestration test as expensive
.IP \(bu 2
fceb6d8d6f Update old utils paths to use new paths
.IP \(bu 2
3e6445a9d6 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
b49eeca6e9 Merge pull request \fI\%#49003\fP from rallytime/boto\-test\-2017.7
.INDENT 2.0
.IP \(bu 2
1a23bb233f Update expected return value in boto test
.UNINDENT
.IP \(bu 2
51eed1fdfb Merge pull request \fI\%#48988\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
df8699e2e7 Merge branch \(aq2017.7.8\(aq into \(aq2017.7\(aq
.IP \(bu 2
a1e54634dc Merge pull request \fI\%#48976\fP from rallytime/tornado
.INDENT 2.0
.IP \(bu 2
0bd838ab6c Skip unreliable tornado tests
.UNINDENT
.IP \(bu 2
22713be9c1 Merge pull request \fI\%#48979\fP from rallytime/bp\-48959
.IP \(bu 2
03aa0e49b0 Merge pull request \fI\%#48970\fP from Ch3LL/back_48962
.INDENT 2.0
.IP \(bu 2
3ce1b8a3c9 Update the elif block to only be true for versions below Debian 9.
.UNINDENT
.IP \(bu 2
e6cea5e3c7 Merge pull request \fI\%#48968\fP from rallytime/man\-pages
.INDENT 2.0
.IP \(bu 2
64fe3be41a Update man pages for 2017.7.8 release
.UNINDENT
.UNINDENT
.IP \(bu 2
10fd4661ff Merge pull request \fI\%#48978\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
6108363f82 clean up gemfile
.UNINDENT
.IP \(bu 2
5b2423e527 Merge pull request \fI\%#48959\fP from rallytime/flaky\-tests
.INDENT 2.0
.IP \(bu 2
aaf986d728 Mark one grains test as flaky & convert to pytest notation
.IP \(bu 2
e7e5abcf48 Mark 2 matcher tests as flaky
.UNINDENT
.IP \(bu 2
79994ecab4 Merge pull request \fI\%#48962\fP from garethgreenaway/1022_test_service_disable_debian_part_deux
.INDENT 2.0
.IP \(bu 2
9e71551b36 Update the elif block to only be true for versions below Debian 9.
.UNINDENT
.IP \(bu 2
1a1bda00cb Merge pull request \fI\%#48960\fP from dwoz/block_replace_tests
.INDENT 2.0
.IP \(bu 2
94ac2b4fc7 Multiple block replace test fixes
.UNINDENT
.IP \(bu 2
93b862f350 Merge pull request \fI\%#48957\fP from whytewolf/beacons_log_doc_change
.INDENT 2.0
.IP \(bu 2
a77fd16869 Update salt.beacons.log to reflect that re module is used for matching.
.UNINDENT
.IP \(bu 2
0245cffb07 Merge pull request \fI\%#48955\fP from terminalmage/service\-systemd
.INDENT 2.0
.IP \(bu 2
23f87bd536 Don\(aqt load service.py if minion is running a non\-sysvinit init system
.UNINDENT
.IP \(bu 2
848d583438 Merge pull request \fI\%#48950\fP from KaiSforza/kitchenfix\-2017.7
.INDENT 2.0
.IP \(bu 2
5242cb143a Added a quote to kitchen Jenkinsfiles
.UNINDENT
.IP \(bu 2
928d688d65 Merge pull request \fI\%#48943\fP from rallytime/flaky\-tests
.INDENT 2.0
.IP \(bu 2
668da57ab9 Mark some shell and runner integration tests as flaky
.UNINDENT
.IP \(bu 2
cd42510d3a Merge pull request \fI\%#48940\fP from rallytime/bp\-48852
.INDENT 2.0
.IP \(bu 2
fa4ef92e79 Record all the artifacts from the build
.UNINDENT
.IP \(bu 2
43649a68be Merge pull request \fI\%#48935\fP from garethgreenaway/1045_test_pkg_015_installed_held_centos
.INDENT 2.0
.IP \(bu 2
0bb10107b6 Merge branch \(aq2017.7\(aq into 1045_test_pkg_015_installed_held_centos
.IP \(bu 2
24d5e6a22f Fixing the test_pkg_015_installed_held test to be able to successfully run on CentOS
.UNINDENT
.IP \(bu 2
2421e2a570 Merge pull request \fI\%#47100\fP from gtmanfred/ssh
.INDENT 2.0
.IP \(bu 2
5b443af7ae add key\-deploy test
.IP \(bu 2
a131c9beeb Allow for not being prompted to supply a password to deploy keys to a minion with salt\-ssh
.UNINDENT
.IP \(bu 2
d541bd6446 Merge pull request \fI\%#48891\fP from damon\-atkins/2017.7_win_pkg.list_pkgs_not_found
.INDENT 2.0
.IP \(bu 2
a4af1dbfb1 Fix win_pkg issues introduced Jan 2018. If DisplayVersion does not exist it should return version as \(dqNot Found\(dq
.UNINDENT
.IP \(bu 2
5f6a56f5dc Merge pull request \fI\%#48896\fP from rallytime/bp\-48730
.INDENT 2.0
.IP \(bu 2
57aa204c9d Merge branch \(aq2017.7\(aq into bp\-48730
.IP \(bu 2
4995922584 Forgot variable in signature
.IP \(bu 2
0503bc18b6 Fix batch install using pkgng
.UNINDENT
.IP \(bu 2
0c64bba865 Merge pull request \fI\%#48933\fP from garethgreenaway/1022_debian_8_failing_service\-test
.INDENT 2.0
.IP \(bu 2
280d1d2ad2 Fixing failing test, integration.modules.test_service.ServiceModuleTest.test_service_disable_doesnot_exist, on Debian 8 and higher.
.UNINDENT
.IP \(bu 2
0c3d2c6a09 Merge pull request \fI\%#48922\fP from rallytime/cache\-doc\-error
.INDENT 2.0
.IP \(bu 2
8ca89df7e8 Update backticks on job_cache docs
.UNINDENT
.IP \(bu 2
8d1fc4f8e5 Merge pull request \fI\%#48866\fP from Ch3LL/cmd_win_tests
.INDENT 2.0
.IP \(bu 2
905da13653 Merge branch \(aq2017.7\(aq into cmd_win_tests
.UNINDENT
.IP \(bu 2
57d58e7541 Merge pull request \fI\%#48920\fP from rallytime/bp\-48904\-2017.7
.INDENT 2.0
.IP \(bu 2
a55f92954a No rehashing in parallel
.IP \(bu 2
3be11e06fe Add docs for new escape kwarg
.IP \(bu 2
391bb8a411 use a specific path for just the cmd._run call
.IP \(bu 2
62c66ba489 make sure we lower the check on shell
.IP \(bu 2
9312a993a5 Add cmd module integration tests for windows and fix space in path issue
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48123\fP: (\fI\%c\-wicklein\fP) file.directory with recurse fails when it encounters a broken symbolic link (refs: \fI\%#48985\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48985\fP: (\fI\%garethgreenaway\fP)  [2018.3] Fix to salt/modules/file.py
@ \fI2018\-08\-09 15:03:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
3325b7d4c0 Merge pull request \fI\%#48985\fP from garethgreenaway/48123_file_directory_recurse_fails_broken_symlink
.IP \(bu 2
10c4eca206 Merge branch \(aq2018.3\(aq into 48123_file_directory_recurse_fails_broken_symlink
.IP \(bu 2
a404cc030f Fixing the issue when using the file.directory state with recurse if the directory contains a broken symbolic link. This fix adds an additional conditional, is_link, before running lsattr since lsattr does not work on symlinks and causes issues when that symlink is broken.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47695\fP: (\fI\%AmbicaY\fP) Continuous error in the proxy minion logs (refs: \fI\%#49019\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49019\fP: (\fI\%garethgreenaway\fP) [2018.3] Fix to scheduler when global enabled key is present
@ \fI2018\-08\-09 13:06:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
d353c02a8c Merge pull request \fI\%#49019\fP from garethgreenaway/47695_fixing_scheduler_bug_when_enabled_is_present
.IP \(bu 2
aff1b8f6d4 Lint.
.IP \(bu 2
8935c08141 Fixing a bug that occurs if the \(dqenabled\(dq key is present in the scheduler items dictionary.  Adding a test to ensure scheduler runs as expected when that key is present.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49023\fP: (\fI\%The\-Loeki\fP) Salt SSH appends IdentityFile=agent\-forwarding
@ \fI2018\-08\-09 12:55:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
a56bc7ffb9 Merge pull request \fI\%#49023\fP from The\-Loeki/patch\-1
.IP \(bu 2
8b53571c70 Salt SSH appends IdentityFile=agent\-forwarding
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48981\fP: (\fI\%Ch3LL\fP) Add warning to mac runas docs about escaping characters
@ \fI2018\-08\-08 19:43:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
4590494b50 Merge pull request \fI\%#48981\fP from Ch3LL/mac_runas_quote
.IP \(bu 2
8269b55b84 remove unnecessary spaces in cmdmod.py docs
.IP \(bu 2
757daf7d7e add runas macosx warning in 2018.3.3 release notes
.IP \(bu 2
4e9e985b14 Add warning to mac runas docs about escaping characters
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49004\fP: (\fI\%rallytime\fP) Port \fI\%#48999\fP to 2018.3
@ \fI2018\-08\-08 15:32:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48999\fP: (\fI\%rallytime\fP) Update expected return value in boto test (refs: \fI\%#49004\fP, \fI\%#49003\fP)
.IP \(bu 2
b87bf905c2 Merge pull request \fI\%#49004\fP from rallytime/boto\-test\-2018.3
.IP \(bu 2
9f0b9a1073 Update expected return value in boto test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48987\fP: (\fI\%twangboy\fP) Fix issue with win_iis.create_cert_binding
@ \fI2018\-08\-08 13:29:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
630f61e625 Merge pull request \fI\%#48987\fP from twangboy/fix_48786
.IP \(bu 2
86d0836f90 Fix issue with iterating over None
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48777\fP: (\fI\%jonasgit\fP) file.recurse fails on file contents encoding not utf\-8 (refs: \fI\%#48934\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48934\fP: (\fI\%terminalmage\fP) Properly handle latin\-1 encoding in file diffs
@ \fI2018\-08\-07 21:02:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab1a713bc3 Merge pull request \fI\%#48934\fP from terminalmage/issue48777
.IP \(bu 2
52c64e4d51 Fix to_unicode test
.IP \(bu 2
e2d19f40b6 Only try latin\-1 from get_diff instead of by default
.IP \(bu 2
d39fa889f3 Add stringutils.get_diff to mocks
.IP \(bu 2
5b191c9120 Fix incorrect use of __salt__ when __utils__ is needed
.IP \(bu 2
53ba10ad5f Skip pylint false\-positives
.IP \(bu 2
f14f4dae22 Add unit test for latin\-1 fallback, multi\-encoding
.IP \(bu 2
906644a80f PY3 scoping fix
.IP \(bu 2
726dd4331f Add integration test for latin\-1 file diffs
.IP \(bu 2
2dd1f31d23 Use BASE_FILES instead of redundant STATE_DIR
.IP \(bu 2
612ffb5fe8 Use new get_diff helper in file module
.IP \(bu 2
c632265802 Make to_unicode/to_str/to_bytes helpers attempt latin\-1
.IP \(bu 2
2a0cb49b01 Add get_diff to salt.utils.stringutils
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47766\fP: (\fI\%zerthimon\fP) salt\-cloud: openstack driver: crash on instance creation (refs: \fI\%#48956\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48956\fP: (\fI\%gtmanfred\fP) if booted from volume, use string from image
@ \fI2018\-08\-07 16:39:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
bad995462c Merge pull request \fI\%#48956\fP from gtmanfred/openstack
.IP \(bu 2
4cb1636c4b if booted from volume, use string from image
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48306\fP: (\fI\%davidscholberg\fP) Documentation update for custom returners used for master job cache (refs: \fI\%#48319\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48319\fP: (\fI\%gtmanfred\fP) don\(aqt break older returners right now
@ \fI2018\-08\-06 13:19:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
71f587edd7 Merge pull request \fI\%#48319\fP from gtmanfred/jid
.IP \(bu 2
084e7f0ef4 Merge branch \(aq2018.3\(aq into jid
.IP \(bu 2
60661b4cd0 document minions required on save_load
.IP \(bu 2
a8c243071d document passing in minions
.IP \(bu 2
d49381c0b6 don\(aqt break save_load backwards compat
.IP \(bu 2
cfcacf953a don\(aqt break older returners right now
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48941\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48912\fP to 2018.3
@ \fI2018\-08\-06 13:09:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48912\fP: (\fI\%maxim\-sermin\fP) make jboss7.py compatible with 2018.3.0 and later (refs: \fI\%#48941\fP)
.IP \(bu 2
1623e53ef4 Merge pull request \fI\%#48941\fP from rallytime/bp\-48912
.IP \(bu 2
3f55b2f89e make jboss7.py compatible with 2018.3.0 and later
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48897\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48863\fP to 2018.3
@ \fI2018\-08\-05 19:15:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48863\fP: (\fI\%admd\fP) Decode file contents for python2 as well (refs: \fI\%#48897\fP)
.IP \(bu 2
070af9d925 Merge pull request \fI\%#48897\fP from rallytime/bp\-48863
.IP \(bu 2
0ee1940232 Merge branch \(aq2018.3\(aq into bp\-48863
.IP \(bu 2
f40b966d99 decode file contents for python2 as well
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48928\fP: (\fI\%Ch3LL\fP) fix test_runas integration test for macosx
@ \fI2018\-08\-05 14:24:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
abd7f1312d Merge pull request \fI\%#48928\fP from Ch3LL/mac_runas
.IP \(bu 2
3d6455dbcd remove unnecessary comment in setup
.IP \(bu 2
8e30db0217 move destructivetest to testname
.IP \(bu 2
708dec8740 add destructivetest to setup and teardown for runas test
.IP \(bu 2
c0730ff968 fix test_runas integration test for macosx
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48899\fP: (\fI\%Ch3LL\fP) remove base_top_file file in teardown and add sleep
@ \fI2018\-08\-05 14:23:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
dbd300ff70 Merge pull request \fI\%#48899\fP from Ch3LL/unit_state
.IP \(bu 2
0272cadff8 Merge branch \(aq2018.3\(aq into unit_state
.IP \(bu 2
5896c7fc36 remove base_top_file file in teardown and add sleep
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48898\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-08\-05 14:23:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
ffa1fcc682 Merge pull request \fI\%#48898\fP from rallytime/merge\-2018.3
.IP \(bu 2
1f093cef4a Merge branch \(aq2018.3\(aq into merge\-2018.3
.IP \(bu 2
b3a5aa49d7 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
e79ccb35b1 Merge pull request \fI\%#48876\fP from Vaelatern/make\-network\-learning\-optional
.INDENT 2.0
.IP \(bu 2
a4905b0e5d Make IP_LEARNING optional
.UNINDENT
.IP \(bu 2
f8bfab4f9f Merge pull request \fI\%#48890\fP from Ch3LL/cmd_test
.INDENT 2.0
.IP \(bu 2
acda4ed9ab add sleep in test_cmd integration test
.UNINDENT
.IP \(bu 2
52722f6ded Merge pull request \fI\%#48885\fP from rallytime/flaky\-tests\-shadow
.INDENT 2.0
.IP \(bu 2
da871a2d57 Mark shadow module integration test as flaky
.UNINDENT
.IP \(bu 2
bf0895656e Merge pull request \fI\%#48884\fP from rallytime/flaky\-tests\-matchers
.INDENT 2.0
.IP \(bu 2
38d9eae537 Merge branch \(aq2017.7\(aq into flaky\-tests\-matchers
.UNINDENT
.IP \(bu 2
a567666938 Merge pull request \fI\%#48868\fP from terminalmage/fix\-loader\-race
.INDENT 2.0
.IP \(bu 2
5f1169b9a2 Fix race when SIGTERM/SIGINT received while lazyloading a module
.UNINDENT
.IP \(bu 2
0ca0b6f2f2 Merge pull request \fI\%#48883\fP from terminalmage/salt\-jenkins\-1023
.INDENT 2.0
.IP \(bu 2
c61f75cb50 Fix failing git worktree tests
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
3660dff13c Separate compound matcher tests into individual tests
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
a84f5155a1 Merge pull request \fI\%#48869\fP from Ch3LL/mac_shell_tests
.INDENT 2.0
.IP \(bu 2
3734b1ec89 Catch socket.error exception in testprogram
.UNINDENT
.IP \(bu 2
7f56b8bf44 Merge pull request \fI\%#48867\fP from rallytime/skip\-tornado\-test
.INDENT 2.0
.IP \(bu 2
7320aa9104 Skip unreliable tornado test.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48893\fP: (\fI\%Ch3LL\fP) handle when ca_certs is None in utils.http
@ \fI2018\-08\-03 20:30:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
848e26ed0b Merge pull request \fI\%#48893\fP from Ch3LL/http_tests
.IP \(bu 2
16d251f7ff Merge branch \(aq2018.3\(aq into http_tests
.IP \(bu 2
5674dddb2a handle when ca_certs is None in utils.http
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48903\fP: (\fI\%Vaelatern\fP) Wrap ElementTree.tostring to make strs, not bytes
@ \fI2018\-08\-03 19:12:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48877\fP: (\fI\%Vaelatern\fP) Wrap ElementTree.tostring to make strs, not bytes (refs: \fI\%#48903\fP)
.IP \(bu 2
f1adf56017 Merge pull request \fI\%#48903\fP from Vaelatern/improve\-salt\-cloud\-python3\-virt
.IP \(bu 2
c45447fe0b Wrap ElementTree.tostring to make strs, not bytes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48900\fP: (\fI\%Ch3LL\fP) skip getpwnam check on mac in unit test_cmdmod
@ \fI2018\-08\-03 16:38:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
d23471262d Merge pull request \fI\%#48900\fP from Ch3LL/cmd_unit
.IP \(bu 2
b82dd708be skip getpwnam check on mac in unit test_cmdmod
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48921\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48904\fP to 2018.3
@ \fI2018\-08\-03 15:17:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48904\fP: (\fI\%KaiSforza\fP) No rehashing in parallel (refs: \fI\%#48921\fP, \fI\%#48920\fP)
.IP \(bu 2
d622a49b58 Merge pull request \fI\%#48921\fP from rallytime/bp\-48904
.IP \(bu 2
b504625f61 No rehashing in parallel
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48877\fP: (\fI\%Vaelatern\fP) Wrap ElementTree.tostring to make strs, not bytes (refs: \fI\%#48903\fP)
@ \fI2018\-08\-02 19:28:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
1e150923aa Merge pull request \fI\%#48877\fP from Vaelatern/improve\-salt\-cloud\-libvirt\-python3\-libvirt
.IP \(bu 2
fb7885315c Wrap ElementTree.tostring to make strs, not bytes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48824\fP: (\fI\%rallytime\fP) Bump deprecation in win_servermanager state to Neon
@ \fI2018\-08\-02 18:01:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
1fb7d9431b Merge pull request \fI\%#48824\fP from rallytime/win_servermanager_deprecations
.IP \(bu 2
6ef5412528 Bump deprecation in win_servermanager state to Neon
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37512\fP: (\fI\%ChristianBeer\fP) What\(aqs the precedence if multiple master configurations are specified? (refs: \fI\%#48888\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48888\fP: (\fI\%terminalmage\fP) Explicitly document the configuration override priority
@ \fI2018\-08\-02 16:57:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec8e07e8ce Merge pull request \fI\%#48888\fP from terminalmage/issue37512
.IP \(bu 2
7dce7cde14 Explicitly document the configuration override priority
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48871\fP: (\fI\%dwoz\fP) Remove unicode key pairs from environ after test
@ \fI2018\-08\-01 22:33:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
d4bb3a0963 Merge pull request \fI\%#48871\fP from dwoz/test_cleanup
.IP \(bu 2
f2e15e7f1d Do not re\-define tearDown
.IP \(bu 2
4f8a191a69 Remove unicode key pairs from environ after test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48843\fP: (\fI\%isbm\fP) Prevent u\(aqsomething\(aq to appear in help info.
@ \fI2018\-08\-01 20:38:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
bec79e83a3 Merge pull request \fI\%#48843\fP from isbm/isbm\-log\-level\-names\-fix\-2
.IP \(bu 2
a63686180d Merge branch \(aq2018.3\(aq into isbm\-log\-level\-names\-fix\-2
.IP \(bu 2
783c96ac72 Prevent u\(aqsomething\(aq to appear in help info.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48855\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-08\-01 17:44:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
a8376b537a Merge pull request \fI\%#48855\fP from rallytime/merge\-2018.3
.IP \(bu 2
44998c208e Lint: Fix undefined logger variable
.IP \(bu 2
92c9317a25 Update old utils paths to use new paths
.IP \(bu 2
15bfba7143 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
05f2d65de3 Merge pull request \fI\%#48853\fP from rallytime/bp\-48850
.INDENT 2.0
.IP \(bu 2
3c33ee554a Skip tests in integration.shell.test_master
.UNINDENT
.IP \(bu 2
8a1285239a Merge pull request \fI\%#48426\fP from garethgreenaway/46689_fixing_pkg_held_when_package_is_installed
.INDENT 2.0
.IP \(bu 2
9b0f5dd212 Fixing indentation, removing some unnecessary conditionals.
.IP \(bu 2
727964ab55 One last cleanup.
.IP \(bu 2
11cb86e6eb General cleanup in pkg state, reducing duplicate code.  Fixing the requires_salt_modules decorator, sys.doc was returning too much information for the event to handle.  This change specifically calls sys.doc with the module name.
.IP \(bu 2
16fb6ae635 Make sure pkg.hold and pkg.unhold are available before running the test.
.IP \(bu 2
998651102d Fixing a situation when a package is already installed via salt or manually and a state attempts to set that package to be held.  Previously the holding/unholding logic was only being run against packages that were being installed.  This change moves the holding logic outside and runs it against all desired packages.  Adding a new test to test holding logic.
.UNINDENT
.IP \(bu 2
c8e69431ff Merge pull request \fI\%#47734\fP from OrlandoArcapix/Issue47689\-pip\-state\-performance
.INDENT 2.0
.IP \(bu 2
662bd1f780 Merge branch \(aq2017.7\(aq into Issue47689\-pip\-state\-performance
.IP \(bu 2
66936b4f41 Changed string comparison in pip test to match new confirmation string \- ref PR \fI\%#47734\fP\&.
.IP \(bu 2
bb5939d6ef Merge branch \(aq2017.7\(aq into Issue47689\-pip\-state\-performance
.IP \(bu 2
d6a49ae41c Merge branch \(aq2017.7\(aq into Issue47689\-pip\-state\-performance
.IP \(bu 2
d4083fc9d1 Merge branch \(aqIssue47689\-pip\-state\-performance\(aq of github.com:OrlandoArcapix/salt into Issue47689\-pip\-state\-performance
.INDENT 2.0
.IP \(bu 2
779b5fa785 Merge branch \(aq2017.7\(aq into Issue47689\-pip\-state\-performance
.UNINDENT
.IP \(bu 2
f3653349ab Removed whitespaces at end of added comments lines
.IP \(bu 2
db11f2ff4b Merge branch \(aq2017.7\(aq into Issue47689\-pip\-state\-performance
.IP \(bu 2
eac0178de2 Ref: \fI\%#47689\fP \- document additional kwarg passed to pip._check_if_installed function
.IP \(bu 2
0d19803106 Merge branch \(aq2017.7\(aq into Issue47689\-pip\-state\-performance
.IP \(bu 2
d3678bf2f3 \fI\%#47689\fP fix lint errors
.IP \(bu 2
4fec8f6bcc \fI\%#47698\fP improve run\-speed of pip package state checks by only loading the current package list once when checking multiple packages
.UNINDENT
.IP \(bu 2
83a5b3cc47 Merge pull request \fI\%#48844\fP from AVeenstra/fix\-python3\-incompatibility
.INDENT 2.0
.IP \(bu 2
f238779a62 Merge branch \(aq2017.7\(aq into fix\-python3\-incompatibility
.IP \(bu 2
6b1805afc6 Fixed Python 3 incompatibility in methods in nilrt_ip and debian_ip.
.UNINDENT
.IP \(bu 2
136ff6735a Merge pull request \fI\%#48662\fP from slaws/fix\-retention\-schedule\-48637
.INDENT 2.0
.IP \(bu 2
3c8f5f5b3d pylint fix
.IP \(bu 2
5539eff39e Excluding relative dirs in state.file.retention_schedule
.UNINDENT
.IP \(bu 2
1fc04f281b Merge pull request \fI\%#48840\fP from gtmanfred/docs
.INDENT 2.0
.IP \(bu 2
8d2d268c4a fix links in pkg doc.
.UNINDENT
.IP \(bu 2
0a19f845ea Merge pull request \fI\%#48834\fP from gtmanfred/slsutil
.INDENT 2.0
.IP \(bu 2
f9441d2bef read output of stringio if it is readable
.UNINDENT
.IP \(bu 2
2e00939a6e Merge pull request \fI\%#48788\fP from Ch3LL/timezone_windows
.INDENT 2.0
.IP \(bu 2
de95a6a215 add unused import to timezone test file
.IP \(bu 2
22e424859e add unused import to import
.IP \(bu 2
0840fc3117 disable pylint import error
.IP \(bu 2
f09d1a2c7e Add timzeon windows integration tests and fix get_zone
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48659\fP: (\fI\%dstoliker\fP) file.grep with glob (*) in path produces file not found error (refs: \fI\%#48830\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48830\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to file.grep
@ \fI2018\-07\-31 21:30:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
e23ba01cd2 Merge pull request \fI\%#48830\fP from garethgreenaway/48659_file_grep_glob_fix
.IP \(bu 2
0791b0a03c FileGrepTestCase tests back to 2018.3
.IP \(bu 2
2e01c55e7e Fixing a bug that prevents specifying wildcards for filenames.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48814\fP: (\fI\%isbm\fP) dmidecode race conditions check
@ \fI2018\-07\-31 20:48:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
9fda70b3d0 Merge pull request \fI\%#48814\fP from isbm/isbm\-2018.3\-smbios\-bugfix
.IP \(bu 2
5f1141dc05 Merge branch \(aq2018.3\(aq into isbm\-2018.3\-smbios\-bugfix
.IP \(bu 2
b00ee5feef Update clean clause
.IP \(bu 2
b1b2e9c222 Remove multiple returns and combine logic to just one clause
.IP \(bu 2
fd77f760ee Rephrase explanatory comment
.IP \(bu 2
1031e06443 Remove unnecessary code
.IP \(bu 2
c379b7e4ed Get rid of global variable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48804\fP: (\fI\%Ch3LL\fP) Use brew path from which cmd in mac_brew module
@ \fI2018\-07\-31 20:24:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
3d16a63ff2 Merge pull request \fI\%#48804\fP from Ch3LL/mac_brew
.IP \(bu 2
e818c752b3 Merge branch \(aq2018.3\(aq into mac_brew
.IP \(bu 2
41e3d17f29 Use brew path from which cmd in mac_brew module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48836\fP: (\fI\%dwoz\fP) Fix unicode directory listing on py2
@ \fI2018\-07\-31 20:22:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
950c1014aa Merge pull request \fI\%#48836\fP from dwoz/unicode_names_py2
.IP \(bu 2
47e158b9f0 Optomize if statement
.IP \(bu 2
9b462394b2 Fix unicode directory listing on py2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48847\fP: (\fI\%terminalmage\fP) Update file.blockreplace docs to reflect changed functionality
@ \fI2018\-07\-31 18:11:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
baf8c5784a Merge pull request \fI\%#48847\fP from terminalmage/issue48695
.IP \(bu 2
e2bdf7fb92 Update file.blockreplace docs to reflect changed functionality
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48587\fP: (\fI\%twangboy\fP) Fix lgpo issue on Py3
@ \fI2018\-07\-31 18:05:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
644a1f4ff8 Merge pull request \fI\%#48587\fP from twangboy/fix_lgpo
.IP \(bu 2
a42621c817 Write file in normal mode
.IP \(bu 2
bfcbdeca3b Fix lgpo issue on Py3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48796\fP: (\fI\%Ch3LL\fP) Remove fake su used in integration tests
@ \fI2018\-07\-31 17:08:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
2bacc23481 Merge pull request \fI\%#48796\fP from Ch3LL/remove_su
.IP \(bu 2
d3b7f2cb18 Remove fake su used in integration tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38310\fP: (\fI\%ghost\fP) Unable to checkout external pillar git repo using its git tag (refs: \fI\%#48689\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48689\fP: (\fI\%linoplt\fP) Fix ext_pillar remote checkout using tag (pygit2)
@ \fI2018\-07\-31 16:15:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
00d06bda76 Merge pull request \fI\%#48689\fP from linoplt/fix_38310_pygit2_checkout_ext_pillar_remote_using_tag
.IP \(bu 2
eb4361dcc2 Merge branch \(aq2018.3\(aq into fix_38310_pygit2_checkout_ext_pillar_remote_using_tag
.IP \(bu 2
c20977e3bc Merge branch \(aq2018.3\(aq into fix_38310_pygit2_checkout_ext_pillar_remote_using_tag
.IP \(bu 2
b0157c215b Fix ext_pillar remote checkout using tag (pygit2)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48838\fP: (\fI\%sizgiyaev\fP) Fixed: added additional return code 200 for succeeded vault api request
@ \fI2018\-07\-31 16:14:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
5e14e36195 Merge pull request \fI\%#48838\fP from sizgiyaev/fix\-vault\-policy\-state
.IP \(bu 2
02d09c6281 Fixed: added additional return code 200 for succeeded api request
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48714\fP: (\fI\%dwoz\fP) Always transfer bytes from fileserver roots
@ \fI2018\-07\-30 22:37:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
69f81214d1 Merge pull request \fI\%#48714\fP from dwoz/state_echo_fix
.IP \(bu 2
ce3ed43dab Always use unix line endings
.IP \(bu 2
d5e60090bc Merge pull request \fI\%#2\fP from terminalmage/state_echo_fix
.INDENT 2.0
.IP \(bu 2
52fc1c955d Simplify file contents in roots fileserver test
.IP \(bu 2
b6f73e8e57 Remove trailing whitespace on what should be a blank line
.UNINDENT
.IP \(bu 2
95329acb1e Fileserver transfers bytes
.IP \(bu 2
aa34a80997 Always transfer bytes from fileserver roots
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48822\fP: (\fI\%Ch3LL\fP) Fix salt\-ssh state.sls_id TypeError key must be a string
@ \fI2018\-07\-30 20:29:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
16ca4ec2eb Merge pull request \fI\%#48822\fP from Ch3LL/ssh_2018_id
.IP \(bu 2
01f6a15da0 Fix salt\-ssh state.sls_id TypeError key must be a string
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47999\fP: (\fI\%arthurlogilab\fP) Carbon returner failing when run through scheduler on log.trace (refs: \fI\%#48757\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48791\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48757\fP to 2018.3
@ \fI2018\-07\-27 21:30:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48757\fP: (\fI\%kuetrzi\fP) Update carbon_return.py (refs: \fI\%#48791\fP)
.IP \(bu 2
488f6716d4 Merge pull request \fI\%#48791\fP from rallytime/bp\-48757
.IP \(bu 2
f440ebe91f Update carbon_return.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48799\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-07\-27 21:30:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
fae29f4257 Merge pull request \fI\%#48799\fP from rallytime/merge\-2018.3
.IP \(bu 2
487458ad4b Update old utils paths to use new utils paths
.IP \(bu 2
436510796f Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
8e61f3dce0 Merge pull request \fI\%#48742\fP from frogunder/45014
.INDENT 2.0
.IP \(bu 2
f08058b043 Merge branch \(aq45014\(aq of \fI\%https://github.com/frogunder/salt\fP into 45014
.INDENT 2.0
.IP \(bu 2
757fde70c6 Merge branch \(aq2017.7\(aq into 45014
.UNINDENT
.IP \(bu 2
33c20c1ec0 fix tests
.IP \(bu 2
a7a914060d add windows integration tests for states.file
.UNINDENT
.IP \(bu 2
d74f47b340 Merge pull request \fI\%#48795\fP from rallytime/fix\-48417
.INDENT 2.0
.IP \(bu 2
5123b17ffd Update linting docs to contain .testing.pylintrc use
.UNINDENT
.IP \(bu 2
bbea9ae936 Merge pull request \fI\%#48789\fP from rallytime/bp\-48783
.INDENT 2.0
.IP \(bu 2
682a05bebe Threshold was wrong
.IP \(bu 2
d4ca0e3a97 test: except for OSError only
.IP \(bu 2
4547231909 Only run lint checks against changed files
.UNINDENT
.IP \(bu 2
41464d4b39 Merge pull request \fI\%#48731\fP from zer0def/virt\-runner\-init\-args
.INDENT 2.0
.IP \(bu 2
a1fa081ad0 Documentation to missing parameters in virt.init runner.
.IP \(bu 2
365ebdf539 Fixed \fIenable_vnc\fP runner arg being passed into \fIseed_cmd\fP module arg in \fIvirt.init\fP\&.
.UNINDENT
.IP \(bu 2
169afea16a Merge pull request \fI\%#48749\fP from Ch3LL/logo_docs
.INDENT 2.0
.IP \(bu 2
73b1fc29f0 Update Saltstack Logo banner on docs.saltproject.io
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48020\fP: (\fI\%calvinhp\fP) mine.get not returning data in a state.orchestrate sls  (refs: \fI\%#48765\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48765\fP: (\fI\%FedericoCeratto\fP) [2018.3] Fix mine.get not returning data
@ \fI2018\-07\-27 18:01:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd67d2a805 Merge pull request \fI\%#48765\fP from FedericoCeratto/fix_mine.get_not_returning_data
.IP \(bu 2
7183a6e0e8 Workaround for \fI\%#48020\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48747\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-07\-26 18:14:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
6978ce5d1d Merge pull request \fI\%#48747\fP from rallytime/merge\-2018.3
.IP \(bu 2
4122da40b5 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
781c6a6c36 Merge pull request \fI\%#48743\fP from rallytime/saltconf\-ad\-2017.7
.INDENT 2.0
.IP \(bu 2
6df8fd8652 Update DOCBANNER with new SaltConf18 image
.UNINDENT
.IP \(bu 2
ce4e22224e Merge pull request \fI\%#48720\fP from Ch3LL/mac_file_path
.INDENT 2.0
.IP \(bu 2
01d25fae19 Fix test_managed_source_hash_indifferent_case on macosx to correct tmp path
.UNINDENT
.IP \(bu 2
4b9f037d43 Merge pull request \fI\%#48719\fP from Ch3LL/service_mac_state
.INDENT 2.0
.IP \(bu 2
f44a2fc349 Enable service if disabled before running state service tests
.UNINDENT
.IP \(bu 2
b2431eab10 Merge pull request \fI\%#48715\fP from rallytime/flaky\-tests
.INDENT 2.0
.IP \(bu 2
7332cce567 [2017.7] Mark some tornado tests as flaky
.UNINDENT
.IP \(bu 2
801eae3b8d Merge pull request \fI\%#48672\fP from frogunder/45012
.INDENT 2.0
.IP \(bu 2
0747f2e58a add service enabled test
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48676\fP: (\fI\%djneades\fP) salt\-ssh should not target wrong minion from roster file as a result of reverse\-DNS lookups (refs: \fI\%#48771\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48771\fP: (\fI\%gtmanfred\fP) only do reverse dns lookup on ips for salt\-ssh
@ \fI2018\-07\-26 15:41:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
5ea43817ab Merge pull request \fI\%#48771\fP from gtmanfred/2018.3
.IP \(bu 2
535fb8f8e7 only do reverse dns lookup on ips for salt\-ssh
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48752\fP: (\fI\%garethgreenaway\fP) [2018.3] Fix when state file is integers
@ \fI2018\-07\-25 15:03:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
f2ef2d3ef6 Merge pull request \fI\%#48752\fP from garethgreenaway/fix_state_file_all_integers
.IP \(bu 2
790801c67e Fixing a case where the state module would fail if the state file being passed was all integers.  Added a new tests for this edge case.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46896\fP: (\fI\%Poil\fP) Proxy + file.managed => Comment: Failed to cache xxx invalid arguments to setopt (refs: \fI\%#48754\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48754\fP: (\fI\%lomeroe\fP) send proxy/ca_cert parameters as strings (not unicode) to tornado httpclient
@ \fI2018\-07\-25 14:55:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
030c921914 Merge pull request \fI\%#48754\fP from lomeroe/fix\-tornado\-proxy
.IP \(bu 2
d33056704b pass proxy_user, proxy_password, proxy_host, and ca_certs through salt.utils.stringutils.to_str()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48769\fP: (\fI\%Ch3LL\fP) Update Saltstack Logo banner on docs.saltproject.io
@ \fI2018\-07\-25 14:47:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
1eee4b136b Merge pull request \fI\%#48769\fP from Ch3LL/update_doc_2018.3
.IP \(bu 2
0cb4bac798 Update Saltstack Logo banner on docs.saltproject.io
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48760\fP: (\fI\%dwoz\fP) Multiple windows test fixes
@ \fI2018\-07\-25 11:55:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
19afa3b023 Merge pull request \fI\%#48760\fP from dwoz/test_file_fixes
.IP \(bu 2
a89019e956 Multiple windows test fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48753\fP: (\fI\%dwoz\fP) Finally fix prepend for real
@ \fI2018\-07\-25 00:07:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
e6dace3959 Merge pull request \fI\%#48753\fP from dwoz/fix_prepend
.IP \(bu 2
0d1e8ab3f8 Merge branch \(aq2018.3\(aq into fix_prepend
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48756\fP: (\fI\%dwoz\fP) os.uname is not available on py2 windows
@ \fI2018\-07\-24 23:38:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
8aef6d9960 Merge pull request \fI\%#48756\fP from dwoz/core_grains_fix
.IP \(bu 2
b7a37ecf11 os.uname is not available on py2 windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48536\fP: (\fI\%whytewolf\fP) diskusage beacon does not recognize tmpfs disks in linux.  (refs: \fI\%#48718\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48718\fP: (\fI\%garethgreenaway\fP) [2018.3] beacon diskusage fixes
@ \fI2018\-07\-24 17:45:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
062fe7cccf Merge pull request \fI\%#48718\fP from garethgreenaway/48536_beacon_diskusage_fixes
.IP \(bu 2
38a65e8fb3 Fixing test_diskusage_nomatch and test_diskusage_match_regex
.IP \(bu 2
6ecca166ff Updating psutil.disk_partitions to pull in all mounts not just the physical ones.  Check to see if the mount point from the configuration ends with a $ (regular expression end of line) if not we add one in to ensure that a simple / does not end up matching all mount points.  Updating tests accordingly.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48711\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-07\-24 17:38:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
e873621009 Merge pull request \fI\%#48711\fP from rallytime/merge\-2018.3
.IP \(bu 2
ea5c063237 Update old utils paths to use new paths
.IP \(bu 2
e740d3b208 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
689c231d2b Merge pull request \fI\%#48691\fP from Ch3LL/win_repo_pkg_test
.INDENT 2.0
.IP \(bu 2
4b7d6d80c5 Remove unnecessary jinja in curl.sls file
.IP \(bu 2
2bedadfadb Add windows pkg module integration tests
.UNINDENT
.IP \(bu 2
83e4bba916 Merge pull request \fI\%#48635\fP from nbraud/acme
.INDENT 2.0
.IP \(bu 2
3673bae9de modules/acme: explicitly ignore the \fIperms\fP return value
.IP \(bu 2
1800a231e8 Fixup some schema expectations
.IP \(bu 2
8c718cb417 acme: Make the private key mode configurable
.IP \(bu 2
917dea6761 modules/acme: Use file.check_perms ret\-morphing powers
.IP \(bu 2
d2241ceb2d module/acme: Do not exit early when the certificate already exists
.IP \(bu 2
98af0db826 modules/acme: Set the private key filemode to 0640
.UNINDENT
.IP \(bu 2
85991680c8 Merge pull request \fI\%#48345\fP from twangboy/fix_48169
.INDENT 2.0
.IP \(bu 2
ead19725b6 Merge branch \(aq2017.7\(aq into fix_48169
.IP \(bu 2
653fbcb383 Fix some docs errata
.IP \(bu 2
8898e5ff11 Add warn_until Fluorine
.IP \(bu 2
707906ac15 Fix unit.state.test_powercfg
.IP \(bu 2
32c5014eb6 Fix unit tests
.IP \(bu 2
0d9c56e540 Add some more logging
.IP \(bu 2
b20453de9f Use minutes to set
.IP \(bu 2
7dc7eb11c2 Fix documentation to denote seconds when setting
.UNINDENT
.IP \(bu 2
96447ce541 Merge pull request \fI\%#48656\fP from Ch3LL/windows_ip_mod
.INDENT 2.0
.IP \(bu 2
90c3f568b1 Add windows ip module integration tests
.UNINDENT
.IP \(bu 2
0c5fff3dc8 Merge pull request \fI\%#48638\fP from twangboy/fix_vcredist
.INDENT 2.0
.IP \(bu 2
e30d17099d Use goto instead of if statement
.IP \(bu 2
e1042fa084 Remove vcredist for Py3
.UNINDENT
.IP \(bu 2
1ebd96d909 Merge pull request \fI\%#48664\fP from Ch3LL/srv_disable_mac
.INDENT 2.0
.IP \(bu 2
f1fbfad387 move the disable call up in try block
.IP \(bu 2
f60d21bda4 reverse assertion order for service disable test
.IP \(bu 2
3727d1b3b9 switch try/except to match 2018.3
.IP \(bu 2
fb953c2369 [2017.7] Fix service.disabled test for macosx
.UNINDENT
.IP \(bu 2
3da3cf2f3f Merge pull request \fI\%#48625\fP from Ch3LL/ssh_state
.INDENT 2.0
.IP \(bu 2
f590eb2b02 Update state.py
.IP \(bu 2
9790ee3d0d Follow up to PR \fI\%#48555\fP
.UNINDENT
.IP \(bu 2
33812f78f1 Merge pull request \fI\%#48673\fP from Ch3LL/mac_port
.INDENT 2.0
.IP \(bu 2
87dd85a220 Use different pub and ret ports for testprogram integration tests
.UNINDENT
.IP \(bu 2
5f6a7c4d89 Merge pull request \fI\%#48675\fP from Ch3LL/mac_disable
.INDENT 2.0
.IP \(bu 2
c78efab828 Fix mac service.disable tests
.UNINDENT
.IP \(bu 2
93d2f51d2b Merge pull request \fI\%#48658\fP from wyardley/wyardley\-npm\-json\-output\-2017
.INDENT 2.0
.IP \(bu 2
7ff3c9c5ff Improve handling of npm json output (\fI\%#43138\fP)
.UNINDENT
.IP \(bu 2
3e293b0513 Merge pull request \fI\%#48678\fP from OrlandoArcapix/fix\-npm\-dryrun\-test
.INDENT 2.0
.IP \(bu 2
851a404f6b Fix for issue \fI\%#48677\fP \- return True when no changes are to be made with npm.bootstrap with test=true
.UNINDENT
.IP \(bu 2
07a1f6520f Merge pull request \fI\%#48580\fP from rallytime/fix\-46884
.INDENT 2.0
.IP \(bu 2
736b382e91 Don\(aqt error on retcode 0 in libcrypto.OPENSSL_init_crypto call
.UNINDENT
.IP \(bu 2
9874429741 Merge pull request \fI\%#48628\fP from terminalmage/testinfra
.INDENT 2.0
.IP \(bu 2
5ace9f01ec Fix NameError in testinfra module
.UNINDENT
.IP \(bu 2
0d4c80205f Merge pull request \fI\%#48651\fP from gtmanfred/pylint\-2017.7
.INDENT 2.0
.IP \(bu 2
b6ee52f859 handle pyzmq for python3.4
.UNINDENT
.IP \(bu 2
160ae29cf2 Merge pull request \fI\%#48647\fP from gtmanfred/pylint\-2017.7
.INDENT 2.0
.IP \(bu 2
ff818c4ca2 disable checks on pylint
.UNINDENT
.IP \(bu 2
47b1032efa Merge pull request \fI\%#48593\fP from pritambaral/fix/2017.7\-importlib\-pyc\-loading\-order
.INDENT 2.0
.IP \(bu 2
add7894dee loader: Fix suffix order when importlib is used
.UNINDENT
.IP \(bu 2
9da7b2ec8d Merge pull request \fI\%#48630\fP from dubb\-b/pipeline\-updates
.INDENT 2.0
.IP \(bu 2
8594a8dd05 Adding PY_COLORS=1 as PY_COLORS = 1 instead
.IP \(bu 2
314b0e3599 Adding PY_COLORS=1 for python programs to use ANSI Colors
.IP \(bu 2
b705e8f7a5 Adding correct spacing to options section
.IP \(bu 2
9d8a7e07db Adding options to Jenkins pipline builds
.UNINDENT
.IP \(bu 2
a8ae2adf64 Merge pull request \fI\%#48633\fP from saltstack/revert\-48610\-2017.7
.INDENT 2.0
.IP \(bu 2
bab4a769d4 Revert \(dqonly run pylint on files that change\(dq
.UNINDENT
.IP \(bu 2
6e32bb7f74 Merge pull request \fI\%#48614\fP from rallytime/bp\-48562
.INDENT 2.0
.IP \(bu 2
cb654bbf2c Add timeouts to all s3 queries
.UNINDENT
.IP \(bu 2
1b6e6388f8 Merge pull request \fI\%#48588\fP from garethgreenaway/48415_event_send_multi_master
.INDENT 2.0
.IP \(bu 2
fab25af1a9 Adding some quick documentation about why we are setting ret=True following the channel.send.
.IP \(bu 2
bf78f4b188 If the channel send is successful and does not raise an exception, we set ret to True, in case a previous exception from a previous channel send to another master has sent it to False.
.IP \(bu 2
8d1551c5fb When using Salt multi\-master, if we encouter a salt master that has not accepted the minion key yet we should not exit right away, rather continue on and try the next salt master available in the list.
.UNINDENT
.IP \(bu 2
24ffda49ba Merge pull request \fI\%#48610\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
779d1a3dcb only run pylint on files that change
.UNINDENT
.IP \(bu 2
5391dd0a8d Merge pull request \fI\%#48584\fP from Ch3LL/mac_user_grp
.INDENT 2.0
.IP \(bu 2
585ee9db90 Fix grp import for mac in test_user integration test
.UNINDENT
.IP \(bu 2
61572b6780 Merge pull request \fI\%#48555\fP from Ch3LL/ssh_id
.INDENT 2.0
.IP \(bu 2
f69932f506 fix pylint
.IP \(bu 2
70e36764ee Add more tests for salt\-ssh state.sls_id
.IP \(bu 2
dab80e805c Fix state.sls_id to run on ssh minion and not master
.UNINDENT
.IP \(bu 2
aa6dcf39e8 Merge pull request \fI\%#48583\fP from Ch3LL/mac_flaky_tests
.INDENT 2.0
.IP \(bu 2
4ba2299a87 import flaky decorator on mac tests
.IP \(bu 2
811220b41e Add flaky decorator to mac_system and mac_timezone tests
.UNINDENT
.IP \(bu 2
6973152057 Merge pull request \fI\%#48534\fP from xetix/fix\-zypper\-latest_version
.INDENT 2.0
.IP \(bu 2
9985f0b4c1 Lint: remove extra blank line
.IP \(bu 2
5fbead8a36 Merge branch \(aq2017.7\(aq into fix\-zypper\-latest_version
.IP \(bu 2
56ac449271 Merge branch \(aqfix\-zypper\-latest_version\(aq of \fI\%https://github.com/xetix/salt\fP into fix\-zypper\-latest_version
.INDENT 2.0
.IP \(bu 2
44e87f5a0f Adding testcase for this fix.
.IP \(bu 2
b354c6863c Fix behaviour of function latest_version in zypper module when multiple packages are passed to function. Function now properly return dict with empty string as version if latest packages is already installed, and multiple packages are passed to function
.UNINDENT
.IP \(bu 2
db35d0c1e1 Adding testcase for this fix.
.IP \(bu 2
d2513757ed Fix behaviour of function latest_version in zypper module when multiple packages are passed to function. Function now properly return dict with empty string as version if latest packages is already installed, and multiple packages are passed to function
.UNINDENT
.IP \(bu 2
10124034cb Merge pull request \fI\%#48582\fP from dwoz/test_prepend_fix
.INDENT 2.0
.IP \(bu 2
f37571e0bd Merge branch \(aq2017.7\(aq into test_prepend_fix
.UNINDENT
.IP \(bu 2
13f67335f3 Merge pull request \fI\%#48564\fP from dwoz/test_prepend_fix
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
136ddf5f54 Finally fix prepend for real
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 2.0
.IP \(bu 2
66b25e65bf Fix failing prepend test
.UNINDENT
.IP \(bu 2
b8ce27729f Merge pull request \fI\%#48558\fP from dwoz/test_file_fix
.INDENT 2.0
.IP \(bu 2
c858bf477f Remove which mock to get the test passing
.UNINDENT
.IP \(bu 2
a15c65202d Merge pull request \fI\%#48552\fP from KaiSforza/jenkins\-junit\-2017
.INDENT 2.0
.IP \(bu 2
72b1830974 Set up junit in jenkins
.UNINDENT
.IP \(bu 2
f73108026e Merge pull request \fI\%#48550\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
d5c603d9b6 add posargs to tox pylint
.UNINDENT
.IP \(bu 2
113b0426f8 Merge pull request \fI\%#48535\fP from asnell/asnell\-patch\-2
.INDENT 2.0
.IP \(bu 2
d328f6e43d Update manage_file helptext
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48744\fP: (\fI\%rallytime\fP) [2018.3] Update DOCBANNER with new SaltConf18 image
@ \fI2018\-07\-24 17:15:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c7f1c549d Merge pull request \fI\%#48744\fP from rallytime/saltconf\-ad\-2018.3
.IP \(bu 2
dbc1f8b772 Update DOCBANNER with new SaltConf18 image
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48726\fP: (\fI\%dwoz\fP) Skip test when syslog not available
@ \fI2018\-07\-24 16:12:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
04ab17a4d6 Merge pull request \fI\%#48726\fP from dwoz/syslogtest
.IP \(bu 2
00f04cfd59 Skip test when syslog not available
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48727\fP: (\fI\%dwoz\fP) Windows compatible cp test
@ \fI2018\-07\-24 14:41:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
af837424aa Merge pull request \fI\%#48727\fP from dwoz/file_cp_test_fix
.IP \(bu 2
6e7824266b Windows compatible cp test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40004\fP: (\fI\%te\-af\-github\fP) svn changes report (refs: \fI\%#47510\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#21025\fP: (\fI\%RobertFach\fP) svn.export reports invalid change data (2014.7.x) (refs: \fI\%#47510\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48710\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47510\fP to 2018.3
@ \fI2018\-07\-23 21:11:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47510\fP: (\fI\%daa\fP) Fix svn export invalid changes data (refs: \fI\%#48710\fP)
.IP \(bu 2
04125b077d Merge pull request \fI\%#48710\fP from rallytime/bp\-47510
.IP \(bu 2
ebcd3b1c6b fixed test for svn.export
.IP \(bu 2
e79f4aa5cc put name under \(dqnew\(dq key in changes dictionary to be in line with svn.latest
.IP \(bu 2
163f99089c made svn.export changes data dictionary, fixes \fI\%#21025\fP, \fI\%#40004\fP
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
3a941055c1 Use \fIsalt.utils.platform.is_windows\fP
.IP \(bu 2
33e48f7ad7 Finally fix prepend for real
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48699\fP: (\fI\%terminalmage\fP) Add missing release notes mention of file.blockreplace changes
@ \fI2018\-07\-23 13:34:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
e1dd10be70 Merge pull request \fI\%#48699\fP from terminalmage/issue48695
.IP \(bu 2
7ad832c901 Add missing release notes mention of file.blockreplace changes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48700\fP: (\fI\%dwoz\fP) Call sync_modules to fix Windows test case
@ \fI2018\-07\-22 22:23:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab44a05fe4 Merge pull request \fI\%#48700\fP from dwoz/ext_mod_test
.IP \(bu 2
d731e6bf8e Call sync_all to fix Windows test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48653\fP: (\fI\%terminalmage\fP) docker_container.running: Fix regression in test mode
@ \fI2018\-07\-20 19:15:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a494205f2 Merge pull request \fI\%#48653\fP from terminalmage/docker\-unboundlocal
.IP \(bu 2
b0440871a0 Merge branch \(aq2018.3\(aq into docker\-unboundlocal
.IP \(bu 2
9515dd17ff docker_container.running: Fix regression in test mode
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47059\fP: (\fI\%OrlandoArcapix\fP) Some states incorrectly return None instead of an empty dict when there are no changes (refs: \fI\%#48685\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#46985\fP: (\fI\%OrlandoArcapix\fP) grafana4_user.present and grafana4_org.present states not working in 2018.3.0 (refs: \fI\%#48685\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48685\fP: (\fI\%bbinet\fP) Use empty dict for \(aqchanges\(aq instead of None
@ \fI2018\-07\-20 17:12:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48671\fP: (\fI\%bbinet\fP) Few fixes to the grafana module and states (refs: \fI\%#48685\fP)
.IP \(bu 2
266c6f250e Merge pull request \fI\%#48685\fP from bbinet/none\-changes
.IP \(bu 2
842eb3da24 Use empty dict for \(aqchanges\(aq instead of None
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48670\fP: (\fI\%bbinet\fP) Add the \(dqtraverse\(dq jinja filter
@ \fI2018\-07\-20 16:36:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
5a6f7a085c Merge pull request \fI\%#48670\fP from bbinet/traverse
.IP \(bu 2
32b6d22cf2 Fix RST syntax issue in doc
.IP \(bu 2
37a41226d5 Add the \(dqtraverse\(dq jinja filter
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48594\fP: (\fI\%pritambaral\fP) Backport 48418
@ \fI2018\-07\-20 14:57:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48418\fP: (\fI\%pritambaral\fP) Fix multi\-sls \fIsalt.state\fP orchestration in masterless systems (refs: \fI\%#48594\fP)
.IP \(bu 2
ff11763fd3 Merge pull request \fI\%#48594\fP from pritambaral/bp\-48418
.IP \(bu 2
adcee28b84 Fix multi\-sls \fIsalt.state\fP orchestration in masterless systems
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48184\fP: (\fI\%mmulqueen\fP) Invalid DMI prevents salt\-minion from running (refs: \fI\%#48440\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48440\fP: (\fI\%mmulqueen\fP) Make core.py tolerant of invalid chars in DMI data
@ \fI2018\-07\-20 14:48:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48216\fP: (\fI\%Ch3LL\fP) Fix UnicodeDecodeError when reading file to determine virtual grain (refs: \fI\%#48440\fP)
.IP \(bu 2
111908f519 Merge pull request \fI\%#48440\fP from mmulqueen/patch\-1
.IP \(bu 2
5bbbdc74cd Make core.py tolerant of invalid chars in DMI data
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48663\fP: (\fI\%Ch3LL\fP) [2018.3] Fix service.disabled test for macosx
@ \fI2018\-07\-20 14:32:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
4e77b242f2 Merge pull request \fI\%#48663\fP from Ch3LL/srv_disable_mac_2018
.IP \(bu 2
bddfbd75d2 reverse assertion order for service disable test
.IP \(bu 2
2bfaf7fe89 Fix service.disabled test for macosx
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48304\fP: (\fI\%Ch3LL\fP) Fix macosx grains when swapusage returns comma
@ \fI2018\-07\-20 14:30:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
dfc1582475 Merge pull request \fI\%#48304\fP from Ch3LL/swap_mac
.IP \(bu 2
5d6135e1e2 Fix macosx grains when swapusage returns comma
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48671\fP: (\fI\%bbinet\fP) Few fixes to the grafana module and states (refs: \fI\%#48685\fP)
@ \fI2018\-07\-20 13:58:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d7eabd24e Merge pull request \fI\%#48671\fP from bbinet/grafana\-fixes
.IP \(bu 2
3c5083f550 Add support for dry run (test=True) of grafana states
.IP \(bu 2
7e7ae8ace7 influxdb: fix conflicts in function arg names with client_args
.IP \(bu 2
73a24b774a Ignore readOnly option when diffing
.IP \(bu 2
81f0cf8a3f Add missing profile argument to grafana4.get_user_data
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48650\fP: (\fI\%gtmanfred\fP) [2018.3] handle pyzmq for python3.4
@ \fI2018\-07\-18 17:34:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
e828167114 Merge pull request \fI\%#48650\fP from gtmanfred/pylint\-2018.3
.IP \(bu 2
3c1882077e handle pyzmq for python3.4
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48648\fP: (\fI\%gtmanfred\fP) [2018.3] disable checks on pylint
@ \fI2018\-07\-18 16:21:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
a6f8acf4dc Merge pull request \fI\%#48648\fP from gtmanfred/pylint\-2018.3
.IP \(bu 2
7c34c2965e disable checks on pylint
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48634\fP: (\fI\%dwoz\fP) Sync modules for state tests
@ \fI2018\-07\-17 20:33:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
01c9c59a97 Merge pull request \fI\%#48634\fP from dwoz/state\-module\-test\-fix
.IP \(bu 2
9dfd2ae392 Sync modules for state tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48585\fP: (\fI\%astorath\fP) replaced meta tag
@ \fI2018\-07\-16 14:11:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb7bfc757c Merge pull request \fI\%#48585\fP from astorath/fix\-vault\-meta
.IP \(bu 2
42fd3d5f67 replaced meta tag
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48579\fP: (\fI\%Ch3LL\fP) Fix python2 syslog returner expecting string bytes not unicode
@ \fI2018\-07\-13 19:50:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
4b16537a29 Merge pull request \fI\%#48579\fP from Ch3LL/fix_syslog
.IP \(bu 2
d8288a0ffc add unicode type for syslog test for tag
.IP \(bu 2
17e69382d5 Fix python2 syslog returner expecting string bytes not unicode
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48542\fP: (\fI\%calvinhp\fP) Missing state git.cloned is listed in the docs as new for 2018.3.2 (refs: \fI\%#48547\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48547\fP: (\fI\%gtmanfred\fP) fix git.cloned doc versionadded
@ \fI2018\-07\-13 18:46:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
3549ce408d Merge pull request \fI\%#48547\fP from gtmanfred/git.cloned
.IP \(bu 2
b596a945ea Merge branch \(aq2018.3\(aq into git.cloned
.IP \(bu 2
e41f4922a0 fix git.cloned doc versionadded
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48110\fP: (\fI\%whytewolf\fP) file.line on windows not treating unix line endings correctly. (refs: \fI\%#48503\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48503\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46291\fP to 2018.3
@ \fI2018\-07\-13 17:14:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48380\fP: (\fI\%twangboy\fP) Detect and preserve line endings (refs: \fI\%#48503\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46291\fP: (\fI\%t0fik\fP) Line mixed line ends (refs: \fI\%#48503\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45498\fP: (\fI\%t0fik\fP) Added support for mixed line ending in file (refs: \fI\%#46291\fP)
.IP \(bu 2
ee257a1f91 Merge pull request \fI\%#48503\fP from rallytime/bp\-46291
.IP \(bu 2
8bc71688ea Remove /sr.* pattern from test
.IP \(bu 2
5e2e2a63fa Update file unit tests to handle \(dqwritelines\(dq change
.IP \(bu 2
5d38aa8b33 Update file.line to use \fIwritelines\fP instead of joining
.IP \(bu 2
d0b6e82ecb Add \(aqname\(aq as the passed in filepath for test_line_insert_ensure_before_first_line test
.IP \(bu 2
d8920cb61f Update \fItest_line_insert_ensure_before_first_line\fP to use new mock_open methodologies
.IP \(bu 2
475f075d8e Handle list of lines instead of strings in file.line func
.IP \(bu 2
b9ddd53b04 Added comments
.IP \(bu 2
f3517a1852 List comprehension replaced
.IP \(bu 2
adfa3aed0d Empty match on delete or replace not causing IndexError exception
.IP \(bu 2
5169b1f7fd Comprehensions converting to unicode replaced by salt.utils.data.decode_list
.IP \(bu 2
d3e8679e05 Removed regex compilation
.IP \(bu 2
f29815b49b Fixed file permissions
.IP \(bu 2
d2af81e9c7 Make integration green. Added test for mode ensure insert before first line
.IP \(bu 2
9b7df671a5 file.line function refactored
.IP \(bu 2
3af551ebe1 /sr.* pattern should raise exception
.IP \(bu 2
935a9b9d56 test_line_insert_end fixed
.IP \(bu 2
7d6e3ad2e2 Make tests green
.IP \(bu 2
75a7e368a6 Setting end of line
.IP \(bu 2
489e381100 Added _set_line_eol and _get_eol functions
.IP \(bu 2
aacbb8c0e2 line function refactored to work on list
.IP \(bu 2
de668166f9 _regex_to_static refactored to work on lists
.IP \(bu 2
464eef6fe1 _get_line_indent renamed to _set_line_indent
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48507\fP: (\fI\%emersonveenstra\fP) mysql_grants.present escape option incorrectly reports failure (refs: \fI\%#48561\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48561\fP: (\fI\%garethgreenaway\fP) [2018.3] fixes to grants in mysql module
@ \fI2018\-07\-13 14:24:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d923f2943 Merge pull request \fI\%#48561\fP from garethgreenaway/48507_mysql_grants_incorrect_failure
.IP \(bu 2
14c59da72c Following a successful grant application in the MySQL module, the new grant and the desired grant are mismatched because the new grant from Mysql included hashmarks.  This change adds the replace which is included for other items such as database name and username.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48529\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-07\-12 17:59:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b5a930449 Merge pull request \fI\%#48529\fP from rallytime/merge\-2018.3
.IP \(bu 2
f9b8c4b257 Use () when using with_tempfile decorator in tests
.IP \(bu 2
d3190ca0c0 Update old utils paths to new utils paths
.IP \(bu 2
29b05ffdd1 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
0c0c05c2bc Merge pull request \fI\%#48527\fP from saltstack/revert\-48525\-2017.7
.INDENT 2.0
.IP \(bu 2
18d06c1a93 Revert \(dqadd kazoo for testing zookeeper.\(dq
.UNINDENT
.IP \(bu 2
05bad3e71c Merge pull request \fI\%#48526\fP from twangboy/rollback_certifi\-win32
.INDENT 2.0
.IP \(bu 2
361b3cdc2f Rollback python\-certifi\-win32
.UNINDENT
.IP \(bu 2
db066effe4 Merge pull request \fI\%#48521\fP from Martin819/2017.7
.INDENT 2.0
.IP \(bu 2
d5d01f6698 Fix for GlusterFS 4.0 and above
.UNINDENT
.IP \(bu 2
ed0bd2bbec Merge pull request \fI\%#48525\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
d7a6bff2b2 add kazoo for testing zookeeper.
.UNINDENT
.IP \(bu 2
ad5a959ab9 Merge pull request \fI\%#48388\fP from garethgreenaway/48277_2017_7_file_roots_wrong
.INDENT 2.0
.IP \(bu 2
6f11da35a7 Fixing a few things in the new test.
.IP \(bu 2
cf747b14ec Fixing lint issue
.IP \(bu 2
16d36c79c8 When pillar items are compiled a new render is instantiated but the file_roots is the pillar_roots.  This change forces the __opts__[\(aqfile_roots\(aq] to be set to what is set in actual_file_roots for all renderers once compile_pillar has finished.  Adding a test when this situation is run via a orchestration runner.
.UNINDENT
.IP \(bu 2
38df812257 Merge pull request \fI\%#48512\fP from gtmanfred/npm
.INDENT 2.0
.IP \(bu 2
9ba0f6b3a0 pin pm and grunt packages for npm tests
.UNINDENT
.IP \(bu 2
04ba31147f Merge pull request \fI\%#48513\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
a466a4880f Merge branch \(aq2017.7.7\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
cfd21ed22c Merge pull request \fI\%#48172\fP from rallytime/2017.7.7\-release\-notes
.INDENT 2.0
.IP \(bu 2
a0ad794132 Update release notes for 2017.7.7
.UNINDENT
.IP \(bu 2
8af4452134 Merge pull request \fI\%#48157\fP from gtmanfred/2017.7.7
.INDENT 2.0
.IP \(bu 2
d8209e8a40 always listen when gathering job info
.UNINDENT
.IP \(bu 2
b98c52ee51 Merge pull request \fI\%#48140\fP from rallytime/man\-pages\-2017.7.7
.INDENT 2.0
.IP \(bu 2
8893bf0d4c Update man pages for 2017.7.7
.UNINDENT
.IP \(bu 2
baa0363336 Merge pull request \fI\%#48136\fP from gtmanfred/2017.7.7
.INDENT 2.0
.IP \(bu 2
fce1c31146 bootstrap kitchen branch tests with 2017.7.6
.UNINDENT
.IP \(bu 2
b0ba08f4d9 Merge pull request \fI\%#48134\fP from rallytime/release\-notes\-2017.7.7
.INDENT 2.0
.IP \(bu 2
217005b8f1 Add missing \fIv\fP for tag reference
.IP \(bu 2
d53569d1e3 Add release notes file for 2017.7.7
.UNINDENT
.IP \(bu 2
084de927fe Merge pull request \fI\%#48098\fP from rallytime/bp\-48075\-2017.7.7
.INDENT 2.0
.IP \(bu 2
e4e62e8b3a Ensure that the shared list of jids is passed when creating the Minion.  Fixes an issue when minions are pointed at multiple syndics.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
f0352ea95a Merge pull request \fI\%#48514\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
739bf92599 upgrade dependencies for pytest tests
.UNINDENT
.IP \(bu 2
5372b60137 Merge pull request \fI\%#48491\fP from grokrecursion/group\-fix\-v2
.INDENT 2.0
.IP \(bu 2
1556b37221 fixed pylint errors
.IP \(bu 2
f6d9177dab fixed indentation for pep8
.IP \(bu 2
b9556bf923 v2 try of gid converted to integer
.UNINDENT
.IP \(bu 2
16d3daab3c Merge pull request \fI\%#48375\fP from Ch3LL/file_copy
.INDENT 2.0
.IP \(bu 2
d16a790775 Add mode to _makedirs call in file.copy
.IP \(bu 2
2cbcb4fd26 Add user and group to makedirs cmd in file.copy
.UNINDENT
.IP \(bu 2
d38951b1b3 Merge pull request \fI\%#48490\fP from KaiSforza/cifixes
.INDENT 2.0
.IP \(bu 2
9fe7199af5 Mark failed if anything is found
.IP \(bu 2
6749a6bf19 Stop archiving the docs
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48553\fP: (\fI\%KaiSforza\fP) Set up junit in jenkins
@ \fI2018\-07\-12 16:24:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
a95b8efd8a Merge pull request \fI\%#48553\fP from KaiSforza/jenkins\-junit\-2018
.IP \(bu 2
412ffcc956 Set up junit in jenkins
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48551\fP: (\fI\%gtmanfred\fP) add posargs to tox pylint
@ \fI2018\-07\-12 14:35:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
c4aed02740 Merge pull request \fI\%#48551\fP from gtmanfred/2018.3
.IP \(bu 2
a6a286af28 add posargs to tox pylint
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48533\fP: (\fI\%terminalmage\fP) Fix UnicodeDecodeError in sh beacon
@ \fI2018\-07\-12 13:38:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
260da0d545 Merge pull request \fI\%#48533\fP from terminalmage/sh\-beacon
.IP \(bu 2
7ac5ac06c9 Fix UnicodeDecodeError in sh beacon
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48519\fP: (\fI\%Lutseslav\fP) Mysql module alter_db quotation missing (refs: \fI\%#48520\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48520\fP: (\fI\%Lutseslav\fP) Add quotes to schema name in ALTER DATABASE.
@ \fI2018\-07\-11 19:15:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
8761ac2589 Merge pull request \fI\%#48520\fP from Lutseslav/fix\-alter\-databases\-with\-special\-symbols
.IP \(bu 2
d088b00ff2 Merge branch \(aq2018.3\(aq into fix\-alter\-databases\-with\-special\-symbols
.IP \(bu 2
59629e9757 Merge branch \(aq2018.3\(aq into fix\-alter\-databases\-with\-special\-symbols
.IP \(bu 2
da8336712e Add quotes to schema name in ALTER DATABASE.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48528\fP: (\fI\%gtmanfred\fP) add 2018.3 requirements for tox/pytest tests
@ \fI2018\-07\-11 18:13:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
ad4f7efafd Merge pull request \fI\%#48528\fP from gtmanfred/2018.3
.IP \(bu 2
221559358a add 2018.3 requirements for tox/pytest tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48336\fP: (\fI\%JuanManuelVizcainoAbad\fP) file.directory (refs: \fI\%#48399\fP, \fI\%#48398\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48508\fP: (\fI\%rallytime\fP) [2018.3] Fix 2 bugs found in the file.check_perms function
@ \fI2018\-07\-11 15:03:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48399\fP: (\fI\%garethgreenaway\fP) [2017.7] fixes to module/file.py (refs: \fI\%#48508\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48398\fP: (\fI\%garethgreenaway\fP) [2018.3] fixes to module/file.py (refs: \fI\%#48508\fP)
.IP \(bu 2
70e5fcb8a5 Merge pull request \fI\%#48508\fP from rallytime/fix\-file\-bug
.IP \(bu 2
0747eb5476 Move comment string join and test/changes check to bottom of file.check_perms
.IP \(bu 2
aefa1dbe21 Fix up bad merge \- remove extra section of \(dqmode\(dq changes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48277\fP: (\fI\%dvenckus\fP) init.sls with included states fails with more than one, \(aqTemplate was specified incorrectly: False\(aq (refs: \fI\%#48388\fP, \fI\%#48389\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#46986\fP: (\fI\%github\-abcde\fP) opts file_roots gets overwritten with pillar_roots in orchestration run (refs: \fI\%#48388\fP, \fI\%#48389\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48389\fP: (\fI\%garethgreenaway\fP) [2018.3] reset file_roots for renderers after compile_pillar
@ \fI2018\-07\-11 13:13:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
5a0b274bf1 Merge pull request \fI\%#48389\fP from garethgreenaway/48277_2018_3_file_roots_wrong
.IP \(bu 2
4b492fa633 Removing unused start_time variable from test_orchestration_with_pillar_dot_items test.
.IP \(bu 2
30c5855d20 Fixing a few things in the new test.
.IP \(bu 2
36b7253418 Fixing lint issue
.IP \(bu 2
ab6abfad31 When pillar items are compiled a new render is instantiated but the file_roots is the pillar_roots.  This change forces the __opts__[\(aqfile_roots\(aq] to be set to what is set in actual_file_roots for all renderers once compile_pillar has finished.  Adding a test when this situation is run via a orchestration runner.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48342\fP: (\fI\%jeffclay\fP) UnicodeDecodeError when using cache mysql (refs: \fI\%#48495\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48495\fP: (\fI\%garethgreenaway\fP) [2018.3] Fix to mysql cache module
@ \fI2018\-07\-10 12:54:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
f9fd1a889a Merge pull request \fI\%#48495\fP from garethgreenaway/48342_mysql_cache_unicode
.IP \(bu 2
0029f19033 Ensure the query_string is a bytestring, otherwise an attempt will be made to convert the msgpack data to unicode which will result in a UnicodeDecodeError error.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48487\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-07\-09 18:38:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc3eeef6b3 Merge pull request \fI\%#48487\fP from rallytime/merge\-2018.3
.IP \(bu 2
54341d1a8d Update old utils paths to use new utils paths
.IP \(bu 2
68aabff0cf Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
22cd4206c4 Merge pull request \fI\%#48472\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
c7a3a7d8bd update jenkins tests to use tox for lint
.IP \(bu 2
44aaac1d33 use tox to run pylint
.UNINDENT
.IP \(bu 2
27ea8f35ea Merge pull request \fI\%#48476\fP from twangboy/fix_dependencies
.INDENT 2.0
.IP \(bu 2
b0087d425c Add license info
.IP \(bu 2
935f9b560c Fix dependencies
.UNINDENT
.IP \(bu 2
acf42864aa Merge pull request \fI\%#48399\fP from garethgreenaway/48336_2017_7_ensure_chmod_setuid_with_chown
.INDENT 2.0
.IP \(bu 2
8efd33320f Normalize the mode before we compare it.
.IP \(bu 2
f894f0ecb8 Setting the mode with setuid or setgid bits in addition to setting the owner and group will force the setuid & setgid bits to reset.  This change ensures that we set the mode after setting the owner & group.
.UNINDENT
.IP \(bu 2
6166ff6b78 Merge pull request \fI\%#48471\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
392ab4e51f Add some configurations to tox
.UNINDENT
.IP \(bu 2
6234d9b15d Merge pull request \fI\%#48433\fP from discogestalt/fix\-redis.hmset
.INDENT 2.0
.IP \(bu 2
65817ac74d Use clean_kwargs method instead
.IP \(bu 2
f7fa7f57c6 Found another issue with redismod.hmset
.IP \(bu 2
5624865f86 Fix issue with redismod.hmset method
.UNINDENT
.IP \(bu 2
aacee0fe2c Merge pull request \fI\%#48428\fP from terminalmage/fix\-jobs.lookup_jid
.INDENT 2.0
.IP \(bu 2
6509aa9089 Fix outputter detection in jobs.lookup_jid runner
.UNINDENT
.IP \(bu 2
a7e52f0de2 Merge pull request \fI\%#48429\fP from rallytime/bp\-46824
.INDENT 2.0
.IP \(bu 2
8b4486248d Added ignore_retcode to mock unit tests
.IP \(bu 2
f8beab71dd Regression to ignore retcodes on crontab calls
.UNINDENT
.IP \(bu 2
4576ef20bc Merge pull request \fI\%#48432\fP from dwoz/file\-prepend\-again
.INDENT 2.0
.IP \(bu 2
349a2b279e Prepend test needs file.touch method
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48481\fP: (\fI\%terminalmage\fP) Improve the slack engine docs
@ \fI2018\-07\-09 13:41:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
4d4d2eacce Merge pull request \fI\%#48481\fP from terminalmage/slack\-engine
.IP \(bu 2
56e8a1eb93 Improve the slack engine docs
.IP \(bu 2
dde9c0640d Add information on creating bot users
.IP \(bu 2
513c6af975 Fix inaccurate docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48348\fP: (\fI\%dwoz\fP) Fix multiple git module tests
@ \fI2018\-07\-06 20:35:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
491b5b077c Merge pull request \fI\%#48348\fP from dwoz/test_git
.IP \(bu 2
5ca5e060b3 Merge branch \(aq2018.3\(aq into test_git
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48454\fP: (\fI\%terminalmage\fP) Improve error message when ext_pillar is incorrectly formatted
@ \fI2018\-07\-06 18:03:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd6a6a97c5 Merge pull request \fI\%#48454\fP from terminalmage/issue48107
.IP \(bu 2
269dbab7f6 Improve error message when ext_pillar is incorrectly formatted
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48336\fP: (\fI\%JuanManuelVizcainoAbad\fP) file.directory (refs: \fI\%#48399\fP, \fI\%#48398\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48398\fP: (\fI\%garethgreenaway\fP) [2018.3] fixes to module/file.py (refs: \fI\%#48508\fP)
@ \fI2018\-07\-06 18:02:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
a9dc758e73 Merge pull request \fI\%#48398\fP from garethgreenaway/48336_ensure_chmodd_setuid_with_chown
.IP \(bu 2
2454652914 Normalize the mode before we compare it.
.IP \(bu 2
08ad5665de Fixing test to ensure it works under py3
.IP \(bu 2
2b25d8c95b Setting the mode with setuid or setgid bits in addition to setting the owner and group will force the setuid & setgid bits to reset.  This change ensures that we set the mode after setting the owner & group.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48431\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-07\-05 17:23:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
2baa7f189f Merge pull request \fI\%#48431\fP from rallytime/merge\-2018.3
.IP \(bu 2
3e59dda0b1 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
422441505d Merge pull request \fI\%#48422\fP from rallytime/fix\-48230
.INDENT 2.0
.IP \(bu 2
a6abf85621 Allow file.managed to work with uppercase source_hash in test=true mode
.IP \(bu 2
4c691ac57a Add regression test for Issue \fI\%#48230\fP
.UNINDENT
.IP \(bu 2
83e387c951 Merge pull request \fI\%#48410\fP from dwoz/service_dead_test_fix
.INDENT 2.0
.IP \(bu 2
5c0923448d Fix service dead test on windows
.UNINDENT
.IP \(bu 2
d3ba345da5 Merge pull request \fI\%#48413\fP from twangboy/fix_47811
.INDENT 2.0
.IP \(bu 2
c5aad04140 handle unc paths
.UNINDENT
.IP \(bu 2
827ef2aac4 Merge pull request \fI\%#48416\fP from dwoz/service_integration_fix
.INDENT 2.0
.IP \(bu 2
c43f150dcd Fix service integration test (py3)
.UNINDENT
.IP \(bu 2
10fe7d2b9b Merge pull request \fI\%#48385\fP from Ch3LL/1update_version_doc_2017.7
.INDENT 2.0
.IP \(bu 2
3cf335b0b9 Update release versions for the 2017.7 branch
.UNINDENT
.IP \(bu 2
f8a9a037e6 Merge pull request \fI\%#48405\fP from Ch3LL/rm_inprog_2017.7
.INDENT 2.0
.IP \(bu 2
03ed5167fa [2017.7] Remove In Progress Warning on 2017.7.7
.UNINDENT
.IP \(bu 2
8ac867c168 Merge pull request \fI\%#48409\fP from dwoz/test_prepend_fix
.INDENT 2.0
.IP \(bu 2
9c7085b70f Fix file state prepend test
.UNINDENT
.IP \(bu 2
10e93bff7f Merge pull request \fI\%#48396\fP from dwoz/symlink_test_fix
.INDENT 2.0
.IP \(bu 2
d3456d31e6 Fix file.symlink state test for windows
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48310\fP: (\fI\%mtorromeo\fP) Backport ini_manage fixes to 2018.3
@ \fI2018\-07\-05 16:27:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
432cbbb5ee Merge pull request \fI\%#48310\fP from mtorromeo/ini\-manage\-backports
.IP \(bu 2
88f80fdf77 Fixed pylint useless\-super\-delegation warning.
.IP \(bu 2
e20f4cacd4 Uniformed reports between ini.options_absent and ini.options_present
.IP \(bu 2
2c3ae0b6c9 pylint cosmetics.
.IP \(bu 2
0c0d10d18f Fixes dry run false positive when option value is a number.
.IP \(bu 2
70144bccbb Fixes dry run in ini_manage + Fixes related bug \- when working with options which are not in section. + Fixes related tests + Fixes pylint warnings
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48402\fP: (\fI\%elsmorian\fP) Running SaltStack master with no init system repeatedly logs \(dqcould not determine init system \(dq (refs: \fI\%#48441\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48441\fP: (\fI\%terminalmage\fP) Switch init system log message to debug
@ \fI2018\-07\-05 14:43:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
84fd3d2784 Merge pull request \fI\%#48441\fP from terminalmage/issue48402
.IP \(bu 2
d758995763 Switch init system log message to debug
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48386\fP: (\fI\%Ch3LL\fP) Update release versions for the 2018.3 branch
@ \fI2018\-07\-03 13:37:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
871c9e3b98 Merge pull request \fI\%#48386\fP from Ch3LL/1update_version_doc_2018.3
.IP \(bu 2
84a1994110 Update release versions for the 2018.3 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48404\fP: (\fI\%Ch3LL\fP) [2018.3] Remove In Progress Warning on 2017.7.7
@ \fI2018\-07\-03 13:33:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
ddb83ad4ce Merge pull request \fI\%#48404\fP from Ch3LL/rm_inprog_2018.3
.IP \(bu 2
ef288f2a74 [2018.3] Remove In Progress Warning on 2017.7.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48339\fP: (\fI\%terminalmage\fP) Backport tojson filter from \fI\%#48309\fP to 2018.3
@ \fI2018\-07\-02 17:52:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48309\fP: (\fI\%terminalmage\fP) Drop support for Python 2 unicode string literals in YAML renderer (refs: \fI\%#48339\fP)
.IP \(bu 2
5b38019ca0 Merge pull request \fI\%#48339\fP from terminalmage/backport\-tojson\-filter
.IP \(bu 2
4433bec891 Add release notes for tojson jinja filter
.IP \(bu 2
ac36998801 Tweak docs to reflect backported filter
.IP \(bu 2
c636b18cf0 Add unit test for tojson filter
.IP \(bu 2
e34e39f0e2 Document filter deprecation
.IP \(bu 2
b9a4f288b2 Deprecate json_encode_dict and json_encode_list jinja filters
.IP \(bu 2
3896e3468c Use upstream tojson filter, if present
.IP \(bu 2
1499c6abcf Implement tojson jinja filter for those using Jinja < 2.9
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48274\fP: (\fI\%ipmb\fP) s3.get signature failure with + in the object name (refs: \fI\%#48328\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48328\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to utils/s3.py
@ \fI2018\-07\-02 13:22:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
222c1d65db Merge pull request \fI\%#48328\fP from garethgreenaway/48274_s3_get_signature_fail
.IP \(bu 2
22cafc8334 fixing lint issue
.IP \(bu 2
131486203e Need to pass the URL path through quote to ensure any special characters are being quoted properly. if we include local_file for a PUT, read the file into data before passing it along to requests.requests.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48358\fP: (\fI\%Ch3LL\fP) Fix corrupt public key with m2crypto python3
@ \fI2018\-07\-02 13:10:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
d3c658bdcf Merge pull request \fI\%#48358\fP from Ch3LL/m2crypto_fix
.IP \(bu 2
8fdd34d430 m2crypto open file in rb mode for pub key
.IP \(bu 2
a964db4663 Fix corrupt public key with m2crypto python3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48367\fP: (\fI\%asenci\fP) salt.proxy.fx2: dictionary changed size during iteration (refs: \fI\%#48368\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#46765\fP: (\fI\%roskens\fP) pkg.mod_repo fails with a python error when removing a dictionary key (refs: \fI\%#46776\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48384\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48368\fP to 2018.3
@ \fI2018\-07\-01 04:19:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48368\fP: (\fI\%asenci\fP) Fix issue \fI\%#48367\fP using the same approach as PR \fI\%#46776\fP (refs: \fI\%#48384\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46776\fP: (\fI\%gtmanfred\fP) fix shrinking list in for loop bug (refs: \fI\%#48368\fP)
.IP \(bu 2
2fd63d66dc Merge pull request \fI\%#48384\fP from rallytime/bp\-48368
.IP \(bu 2
430c462f34 Fix issue \fI\%#48367\fP using the same approach as PR \fI\%#46776\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48394\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-07\-01 04:13:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
3b53e2d206 Merge pull request \fI\%#48394\fP from rallytime/merge\-2018.3
.IP \(bu 2
047f5b5f39 Update old utils paths to new utils paths
.IP \(bu 2
c4fd2a0930 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
7e25f26837 Merge pull request \fI\%#48362\fP from twangboy/fix_48276
.INDENT 2.0
.IP \(bu 2
77629f640a Fix module unit tests
.IP \(bu 2
b5ca560b73 Fix lint error
.IP \(bu 2
210e280ecf Use explicit parameter names
.IP \(bu 2
776db98a5c Handle missing registry entries
.UNINDENT
.IP \(bu 2
80222b6b7c Merge pull request \fI\%#48383\fP from rallytime/bp\-48379
.INDENT 2.0
.IP \(bu 2
9fc7815594 Clean up the workspaces at the end for every job
.UNINDENT
.IP \(bu 2
aa68aa774a Merge pull request \fI\%#48382\fP from rallytime/bp\-48346
.INDENT 2.0
.IP \(bu 2
6a70ba222e Use the right ssh key to destroy kitchen
.UNINDENT
.IP \(bu 2
9519f640e7 Merge pull request \fI\%#48381\fP from rallytime/bp\-48330
.INDENT 2.0
.IP \(bu 2
6857bedcc2 Add warnings plugin to replace violations
.UNINDENT
.IP \(bu 2
14db0aa35d Merge pull request \fI\%#48363\fP from dubb\-b/2017.7
.INDENT 2.0
.IP \(bu 2
c0b962e28d Changing debug to info for logging
.UNINDENT
.IP \(bu 2
5b29cd326f Merge pull request \fI\%#48352\fP from Ch3LL/wheel_doc
.INDENT 2.0
.IP \(bu 2
89ada68165 Add missing key to accept_dict function in wheel docs
.UNINDENT
.IP \(bu 2
02cf19ee3b Merge pull request \fI\%#48329\fP from rallytime/codeowners\-roster\-files
.INDENT 2.0
.IP \(bu 2
5e56615e00 Trigger review requests for team\-ssh for roster files
.UNINDENT
.IP \(bu 2
53cf1794be Merge pull request \fI\%#48349\fP from ralex/fix\-manjaro\-service\-behaviour
.INDENT 2.0
.IP \(bu 2
6cafce547e Disable the \fIservice\fP module on Manjaro since it is using systemd
.UNINDENT
.IP \(bu 2
89dfcf3a4e Merge pull request \fI\%#48324\fP from Ch3LL/update_version_doc_2017.7
.INDENT 2.0
.IP \(bu 2
47845ba810 Update release versions for the 2017.7 branch
.UNINDENT
.IP \(bu 2
ece4c30aac Merge pull request \fI\%#48331\fP from rallytime/bp\-48215
.INDENT 2.0
.IP \(bu 2
9d6ba3e247 Set jobs to pending when they come in
.IP \(bu 2
727d2b4ffe Use proper creds with githubNotify
.IP \(bu 2
d355861c5c Test using different credentials
.UNINDENT
.IP \(bu 2
ab05e00d8c Merge pull request \fI\%#48332\fP from rallytime/bp\-48321
.INDENT 2.0
.IP \(bu 2
d72af6ab4e Jenkins needs the / to get the directory
.UNINDENT
.IP \(bu 2
21ed5b97ce Merge pull request \fI\%#48295\fP from rallytime/bp\-48193
.INDENT 2.0
.IP \(bu 2
352fe33fd6 Separate set_result() to a new line apart from Future() call
.IP \(bu 2
c0180ff33d Properly configure syndic in test case
.IP \(bu 2
d0a98534a9 Properly wait on returns in saltnado
.UNINDENT
.IP \(bu 2
9aa4687ab9 Merge pull request \fI\%#48117\fP from twangboy/fix_48026
.INDENT 2.0
.IP \(bu 2
dd37f8fbc2 Disable services that are set to manual
.UNINDENT
.IP \(bu 2
caf630487c Merge pull request \fI\%#48207\fP from rallytime/bp\-48189
.INDENT 2.0
.IP \(bu 2
e9d09e0375 Use old is_windows utils path on 2017.7
.IP \(bu 2
b965d6c9b3 If pip binary is passed to bin_env, use that pip binary
.UNINDENT
.IP \(bu 2
06a927b2aa Merge pull request \fI\%#48293\fP from rallytime/bp\-47453
.INDENT 2.0
.IP \(bu 2
e96ab6778e don\(aqt reset system locale when running rabbitmqctl commands
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45939\fP: (\fI\%andygabby\fP) user.present with hash_password: True detects change on every state.apply/highstate (refs: \fI\%#47147\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47147\fP: (\fI\%eliasp\fP) states.user.present: Make usage of \fIhash_password\fP idempotent
@ \fI2018\-06\-30 13:29:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
9b364e25cf Merge pull request \fI\%#47147\fP from eliasp/2018.3\-issue\-45939\-shadow\-hash\-salt
.IP \(bu 2
dd3be1d76e Add warning log message when using MD5 for hashing shadow passwords
.IP \(bu 2
5451ab6b7a states.user.present: Make usage of \fIhash_password\fP idempotent
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48297\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-06\-30 12:57:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
89857ea8b9 Merge pull request \fI\%#48297\fP from rallytime/merge\-2018.3
.IP \(bu 2
9498618418 Use \fIsaltenv\fP opts instead of \fIenvironment\fP
.IP \(bu 2
1c8bd35f28 Update old utils paths to use new utils paths
.IP \(bu 2
c7bb8a50b0 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
95ef006e00 Merge pull request \fI\%#48219\fP from zer0def/lxc\-bootstrap\-fixes
.INDENT 2.0
.IP \(bu 2
c77058560b Merge branch \(aq2017.7\(aq into lxc\-bootstrap\-fixes
.IP \(bu 2
d63cf3f072 Fixes another case of legacy configuration key usage warning getting in the way of changing container\(aqs state.
.UNINDENT
.IP \(bu 2
3327181507 Merge pull request \fI\%#48234\fP from dwoz/thin_dir
.INDENT 2.0
.IP \(bu 2
70c603451b Fix py2 thin dir issues
.UNINDENT
.IP \(bu 2
83d7d286c4 Merge pull request \fI\%#48080\fP from lusche/2017.7
.INDENT 2.0
.IP \(bu 2
917dc985fc \fI\%#47984\fP remove the line completely
.IP \(bu 2
ba12ee947b Merge branch \(aq2017.7\(aq of \fI\%https://github.com/saltstack/salt\fP into 2017.7
.IP \(bu 2
dfb13d5051 Bugfix \fI\%#47984\fP messed up cert serial
.UNINDENT
.IP \(bu 2
bccb4dcd46 Merge pull request \fI\%#48232\fP from gtmanfred/cloud
.INDENT 2.0
.IP \(bu 2
d108112e1a do not expand kwargs for cloud.action
.UNINDENT
.IP \(bu 2
056f43f663 Merge pull request \fI\%#48238\fP from mirceaulinic/fix\-sdb\-cache
.INDENT 2.0
.IP \(bu 2
51e5fbfa1d SDB cache module: AttributeError: \(aqCache\(aq object has no attribute \(aqset\(aq
.UNINDENT
.IP \(bu 2
731ec0a11a Merge pull request \fI\%#48037\fP from terminalmage/fix\-custom\-types\-sync\-docs
.INDENT 2.0
.IP \(bu 2
052ae83c4b Update versionchanged
.IP \(bu 2
8b1bd0eda2 Update test to reflect changed argument name
.IP \(bu 2
5e75936198 Change 2018.3.2 to 2018.3.3
.IP \(bu 2
c53ad603fc Rename sync \-> sync_mods per review suggestion
.IP \(bu 2
e4d67c5fd8 Update docs to include references to new \(dqsync\(dq argument
.IP \(bu 2
cb8e6f9fb8 Remove redundant mocking
.IP \(bu 2
bc3ad795e9 Add test for sync argument to state.sls
.IP \(bu 2
f81ccd1fdd Add sync option to state.apply/state.sls
.IP \(bu 2
8289b07e24 Fix documentation on when custom types are synced
.UNINDENT
.IP \(bu 2
0bae927048 Merge pull request \fI\%#48249\fP from rallytime/2017.7.7\-release\-notes\-update
.INDENT 2.0
.IP \(bu 2
36032c8ee7 Update release notes for 2017.7.7
.UNINDENT
.IP \(bu 2
8e06471817 Merge pull request \fI\%#48242\fP from asnell/asnell\-patch\-1
.INDENT 2.0
.IP \(bu 2
f66bf60073 Add sample list data via command line pillar
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48364\fP: (\fI\%dubb\-b\fP) Changing debug to info for logging
@ \fI2018\-06\-28 20:48:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
c5746deb5f Merge pull request \fI\%#48364\fP from dubb\-b/2018.3
.IP \(bu 2
d8260b6628 Changing debug to info for logging
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48354\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.2 to 2018.3
@ \fI2018\-06\-28 20:26:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
0202493b60 Merge pull request \fI\%#48354\fP from rallytime/merge\-2018.3.2\-to\-2018.3
.IP \(bu 2
fface7cc74 Merge branch \(aq2018.3.2\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48347\fP: (\fI\%dwoz\fP) Fixes fileserver maintenance process on Windows
@ \fI2018\-06\-28 13:17:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
bbabbbf76b Merge pull request \fI\%#48347\fP from dwoz/sigfix
.IP \(bu 2
ccdff5029f Remove unneeded attribute
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
e8362adf71 fopen does not support encoding
.IP \(bu 2
487161ba8f Fix file encoding on windows
.IP \(bu 2
fc760685ee Fix multiple git module tests
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47975\fP: (\fI\%terminalmage\fP) Add a new git.cloned state
@ \fI2018\-06\-27 20:53:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
67303d7901 Merge pull request \fI\%#47975\fP from terminalmage/issue47937
.IP \(bu 2
34b24bb7fa Merge branch \(aq2018.3\(aq into issue47937
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48323\fP: (\fI\%Ch3LL\fP) Update release versions for the 2018.3 branch
@ \fI2018\-06\-27 13:44:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b8d55428e Merge pull request \fI\%#48323\fP from Ch3LL/update_version_doc_2018.3
.IP \(bu 2
b4548aca56 Update release versions for the 2018.3 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48326\fP: (\fI\%Ch3LL\fP) Remove In Progress Warning for 2018.3.2 Release
@ \fI2018\-06\-27 13:43:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
7cf403e313 Merge pull request \fI\%#48326\fP from Ch3LL/rn_remove_in_prog
.IP \(bu 2
dfce1ad5ed Remove In Progress Warning for 2018.3.2 Release
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48301\fP: (\fI\%terminalmage\fP) Fix typos in new mock_open docs
@ \fI2018\-06\-25 19:08:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
60ffad5126 Merge pull request \fI\%#48301\fP from terminalmage/docs
.IP \(bu 2
6c33345f05 Fix typos in new mock_open docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48292\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48288\fP to 2018.3
@ \fI2018\-06\-25 19:07:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48288\fP: (\fI\%rmarchei\fP) fix lsattr.get in file.check_perms (refs: \fI\%#48292\fP)
.IP \(bu 2
4760f87153 Merge pull request \fI\%#48292\fP from rallytime/bp\-48288
.IP \(bu 2
d6620573bb fix lsattr.get in file.check_perms
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48296\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48258\fP to 2018.3
@ \fI2018\-06\-25 19:04:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48258\fP: (\fI\%nullify005\fP) preserve tuples for ldap modification operations (refs: \fI\%#48296\fP)
.IP \(bu 2
27207fc510 Merge pull request \fI\%#48296\fP from rallytime/bp\-48258
.IP \(bu 2
8b7f36f264 preserve tuples for ldap modification operations
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48204\fP: (\fI\%zerthimon\fP) State mysql_user.present Exception with mysql 8.0.11 (refs: \fI\%#48275\fP, \fI\%#48228\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48275\fP: (\fI\%garethgreenaway\fP) [2018.3] Follow up fix to MySQL user for password management
@ \fI2018\-06\-25 13:23:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
d5265da945 Merge pull request \fI\%#48275\fP from garethgreenaway/mysql_fix_followup
.IP \(bu 2
bb024b9115 Removing unnecessary code.
.IP \(bu 2
8b542e1745 With MySQL versions 8.0.11 and beyond, since the PASSWORD function has been removed we need to hash the password string before comparing when checking if the user exists.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48286\fP: (\fI\%terminalmage\fP) Don\(aqt load the grains again when printing them via salt\-call \-g
@ \fI2018\-06\-25 13:19:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f306525a7 Merge pull request \fI\%#48286\fP from terminalmage/caller\-print_grains
.IP \(bu 2
caa62c051f Don\(aqt load the grains again when printing them via salt\-call \-g
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48279\fP: (\fI\%terminalmage\fP) Add documentation/further enhancements to rewritten mock_open
@ \fI2018\-06\-25 13:12:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
27a0e95174 Merge pull request \fI\%#48279\fP from terminalmage/mock_open\-docs
.IP \(bu 2
65c575ae9c Fix spelling error
.IP \(bu 2
830a624ce8 Ignore IOError when tearing down filehandles not opened for reading
.IP \(bu 2
3b6356f4b0 Raise TypeError when trying to read from filehandles not opened for reading
.IP \(bu 2
09aae0c82b Add more examples and information on strict string types
.IP \(bu 2
8c069d105d Add some mock_open docs
.IP \(bu 2
a13d1fe1a0 Update mock_open usage to reflect read_data type enforcement
.IP \(bu 2
374a8ce31f Add more mock_open tests
.IP \(bu 2
0f06adb008 Improve code\-reuse in mock_open tests
.IP \(bu 2
0e8c83bac6 2 MockFH enhancements:
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48141\fP: (\fI\%zerthimon\fP) salt\-api request causes exception (refs: \fI\%#48236\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48236\fP: (\fI\%garethgreenaway\fP) [2018.3] Fix to cmd_batch
@ \fI2018\-06\-25 12:58:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
6ee856631b Merge pull request \fI\%#48236\fP from garethgreenaway/48141_salt_api_local_batch
.IP \(bu 2
aea4f7ae14 Fixing test_local_batch
.IP \(bu 2
ce3e1eaf2c Removing sort.
.IP \(bu 2
83accf3b20 Fixing test_local_batch
.IP \(bu 2
ff14b99752 Fixing a typo in the comment.
.IP \(bu 2
85cef126e0 Adding note about why salt.utils.versions is being re\-imported.  Adding a test for local_batch.
.IP \(bu 2
808805fd3d Fixing cmd_batch to work correctly when called via salt\-api.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48204\fP: (\fI\%zerthimon\fP) State mysql_user.present Exception with mysql 8.0.11 (refs: \fI\%#48275\fP, \fI\%#48228\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48228\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to mysql module
@ \fI2018\-06\-22 15:44:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
09b036c26e Merge pull request \fI\%#48228\fP from garethgreenaway/48204_mysql_user_password_exception
.IP \(bu 2
1b2ffcef1d Updating the mysql module to not use the PASSWORD when MySQL is version 8.0.11 or higher, where the PASSWORD function has been removed.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48252\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-06\-22 15:13:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
67cb5563ef Merge pull request \fI\%#48252\fP from rallytime/merge\-2018.3
.IP \(bu 2
84ec655c24 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
a172f9de84 Merge pull request \fI\%#48226\fP from terminalmage/fix\-alias\-docstring
.INDENT 2.0
.IP \(bu 2
fb237272f5 Don\(aqt display \(dqNone\(dq in SaltInvocationError when Salt installed using \-OO
.IP \(bu 2
90c90f5d5c Fix docstring construction in alias_function when Salt installed using \-OO
.UNINDENT
.IP \(bu 2
c6a0207cae Merge pull request \fI\%#48227\fP from Ch3LL/fix_win_tests
.INDENT 2.0
.IP \(bu 2
236773e3e9 Skip new sha256 files on repo.saltstack.com/windows
.UNINDENT
.IP \(bu 2
6929423528 Merge pull request \fI\%#48131\fP from bowmanjd\-lms/fix\-apk\-python3
.INDENT 2.0
.IP \(bu 2
f5d2835299 Merge branch \(aq2017.7\(aq into fix\-apk\-python3
.IP \(bu 2
022f9cba50 Fix py3\-incompatible dict.keys()[x] call in apk.py
.UNINDENT
.IP \(bu 2
868c17377f Merge pull request \fI\%#48185\fP from DSRCorporation/bugs/47901_future_done_exception
.INDENT 2.0
.IP \(bu 2
5f63316311 Merge branch \(aq2017.7\(aq into bugs/47901_future_done_exception
.IP \(bu 2
9f2dbf94cb Don\(aqt call .exception() on future unless it\(aqs done.
.UNINDENT
.IP \(bu 2
80a3e37c2e Merge pull request \fI\%#48192\fP from twangboy/fix_pip_version_2017.7
.INDENT 2.0
.IP \(bu 2
59ae2cc5fc Use \-\-disable\-pip\-version\-check for build_env_#.ps1
.UNINDENT
.IP \(bu 2
12e2b8882a Merge pull request \fI\%#48201\fP from zer0def/lxc\-bootstrap\-fixes
.INDENT 2.0
.IP \(bu 2
6f6d3d40d4 Take lxcpath into account when bootstrapping new containers. Version comparison fixes.
.UNINDENT
.IP \(bu 2
e079fce38d Merge pull request \fI\%#48190\fP from terminalmage/fix\-vfstab\-test
.INDENT 2.0
.IP \(bu 2
8d70d14362 Fix mount.vfstab unit test
.UNINDENT
.IP \(bu 2
c8b9cec986 Merge pull request \fI\%#48115\fP from KaiSforza/pr\-lint\-2017
.INDENT 2.0
.IP \(bu 2
494727ab39 Add docs, kitchen tests
.IP \(bu 2
317023bb20 Move .jenkins to .ci for future
.IP \(bu 2
dedc313cee Make it parallel so we don\(aqt fail right away
.IP \(bu 2
cd13426726 Add a .jenkins file to run pylint
.UNINDENT
.IP \(bu 2
fc1752b721 Merge pull request \fI\%#48174\fP from terminalmage/docker\-update\-mine
.INDENT 2.0
.IP \(bu 2
9af09e0127 Mock config.get due to changes in _refresh_mine_cache
.IP \(bu 2
c5802ad465 Fix the version number in versionadded
.IP \(bu 2
d403ae58d7 Add unit test for docker.update_mine
.IP \(bu 2
44c275698a Actually it\(aqs more than just add/remove that updates the mine
.IP \(bu 2
0cb6996b07 Add release notes mention of docker.update_mine config option
.IP \(bu 2
de05097b20 Add docs for new config option
.IP \(bu 2
04c55a9178 Add note in mine.get_docker docstring about new config item
.IP \(bu 2
4e456255c0 Allow mine update to be disabled using new config option
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48029\fP: (\fI\%vinian\fP) syndic failed to auth when restart salt\-master on syndic master (refs: \fI\%#48034\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48034\fP: (\fI\%vinian\fP) restart salt\-syndic when salt\-master restart
@ \fI2018\-06\-21 20:12:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
9f0bd90c5b Merge pull request \fI\%#48034\fP from vinian/restart\-salt\-syndic\-when\-salt\-master\-retart
.IP \(bu 2
f7652d8c8b restart salt\-syndic when salt\-master restart
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48250\fP: (\fI\%rallytime\fP) Update release notes for 2018.3.2
@ \fI2018\-06\-21 18:30:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab2ba942ad Merge pull request \fI\%#48250\fP from rallytime/2018.3.2\-release\-notes\-update
.IP \(bu 2
19c104b6cd Update release notes for 2018.3.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48166\fP: (\fI\%terminalmage\fP) Add trace logging and optimize file handling in grains.core.os_data
@ \fI2018\-06\-21 18:02:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
51928ff050 Merge pull request \fI\%#48166\fP from terminalmage/salt\-jenkins\-1000
.IP \(bu 2
b73df0ab00 Change call_args to call.args to reflect changes to MockFH
.IP \(bu 2
0c2cc07704 remove unused import
.IP \(bu 2
b8c0a55cf3 Add test for tell()
.IP \(bu 2
1cbe89feee Implement tell() for filehandle iteration
.IP \(bu 2
efb8f49d42 Add tests for read_data being a list, and containing unicode or bytestrings
.IP \(bu 2
38df912fa6 Operate on a copy of the read_data
.IP \(bu 2
71eeae1240 Update mount module unit tests to reflect changes in mock_open
.IP \(bu 2
16c414e120 Update nfs3 module tests to reflect changes in mock_open
.IP \(bu 2
b7eab25d6c Update grub_legacy module tests to reflect changes in mock_open
.IP \(bu 2
cc002b8fd7 Update new network unit test to reflect changes in mock_open
.IP \(bu 2
a8f11594f1 Update new core grains tests to reflect changes in mock_open
.IP \(bu 2
84ce18d956 Update crypt unit tests to reflect changes in mock_open
.IP \(bu 2
67c036dc2d Add MockCall to tests.support.mock to track calls
.IP \(bu 2
2556a1e13d Remove unused import
.IP \(bu 2
fd9d700157 Add additional docs to MockOpen class
.IP \(bu 2
6acb4c83ec Update newly added test to reflect renaming of handles attribute
.IP \(bu 2
77e5288d42 Update fibre_channel grains tests to reflect changes in mock_open
.IP \(bu 2
ed40371a06 Update timezone module tests to reflect changes in mock_open
.IP \(bu 2
fc0aa9934f Track call_count in MockOpen
.IP \(bu 2
2598d2453a Update snapper module tests to reflect changes in mock_open
.IP \(bu 2
51b3faa7b4 Add support for passing multiple strings for a given match in read_data
.IP \(bu 2
55487c175c Fix mock_open call to use new multifile syntax
.IP \(bu 2
7f516ef73a Update puppet module tests to reflect changes in mock_open
.IP \(bu 2
33a97c4ecc Update btmp beacon tests to reflect changes in mock_open
.IP \(bu 2
bc027cfa94 Update wtmp beacon tests to reflect changes in mock_open
.IP \(bu 2
f5823252bb Track call args/kwargs in MockFH
.IP \(bu 2
335591ca90 Mock the seek function in MockFH
.IP \(bu 2
7eb4b1ae1c Update cp.push test to reflect changes to mock_open
.IP \(bu 2
2be19cfa89 Report correct location when reading using explicit size and EOF reached
.IP \(bu 2
5ec95ba5ca On second thought, actually implement tell()
.IP \(bu 2
19022eb9e5 Add tell mock to MockFH
.IP \(bu 2
4b5a393445 Update junos tests to reflect changes to mock_open
.IP \(bu 2
278a222b09 Update dnsutil tests to reflect changes to mock_open
.IP \(bu 2
4e67955572 Replace the rest of mock_open with a class
.IP \(bu 2
75307a47c5 Update linux_sysctl tests to reflect changes to mock_open
.IP \(bu 2
05c68fd5d9 Use explicit config file and fix remaining mac_sysctl tests
.IP \(bu 2
836fde9a30 Allow Python 2 to accept an exception as read_data
.IP \(bu 2
543385fd02 Add writelines_calls property
.IP \(bu 2
42fa842456 Make read funcs mocks so their calls can be tracked
.IP \(bu 2
675f03c58f Update mac_sysctl tests to reflect new mock_open behavior
.IP \(bu 2
3d2c41d395 Update file module tests to reflect new mock_open behavior
.IP \(bu 2
b9200dbc3e add a dict containing the handles to the mock_open return object
.IP \(bu 2
852ba4b982 Add mocked close() function to MockFH
.IP \(bu 2
f6b46bc608 Remove unused import
.IP \(bu 2
20f60a769b Add blank lines to appease linter
.IP \(bu 2
48d7cfa6d3 Add multifile tests for mock_open
.IP \(bu 2
1861e9b944 mock_open: rewrite multi\-file support
.IP \(bu 2
5e6b539770 Use function for empty string
.IP \(bu 2
cb2620ad2b Update core grains tests to reflect EAFP changes
.IP \(bu 2
5d09b178d7 Separate mocked file contents per filename, not glob
.IP \(bu 2
875102f538 Modify mock_open to support multiple file paths
.IP \(bu 2
096ace74df Move lsb_release parsing into its own function
.IP \(bu 2
6a0828beed Add unit tests for mock_open
.IP \(bu 2
8ba6cadac7 More mock_open bugfixes
.IP \(bu 2
329dea218e Add a bunch of logging for linux os_data core grains
.IP \(bu 2
2c64b270df Add timestamp to the minion\(aqs log_fmt_console
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48216\fP: (\fI\%Ch3LL\fP) Fix UnicodeDecodeError when reading file to determine virtual grain (refs: \fI\%#48440\fP)
@ \fI2018\-06\-20 16:53:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
6072d1ef9c Merge pull request \fI\%#48216\fP from Ch3LL/grains_unicode
.IP \(bu 2
c4334f3f14 Fix UnicodeDecodeError when reading file to determine virtual grain
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48212\fP: (\fI\%Ch3LL\fP) Fix python3 ec2 salt\-cloud TypeError when installing salt (refs: \fI\%#49041\fP)
@ \fI2018\-06\-20 16:00:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
77a75ebdcf Merge pull request \fI\%#48212\fP from Ch3LL/py3_ec2
.IP \(bu 2
b0d75f459a Fix python3 ec2 salt\-cloud TypeError when installing salt
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47984\fP: (\fI\%jeduardo\fP) x509 module/state writing wrong certificate serial number to CRL  (refs: \fI\%#47986\fP, \fI\%#48080\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48209\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47986\fP to 2018.3
@ \fI2018\-06\-20 13:44:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48080\fP: (\fI\%lusche\fP) Bugfix \fI\%#47984\fP messed up cert serial (refs: \fI\%#48209\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47986\fP: (\fI\%jeduardo\fP) Fix serial number writing into CRL files with the x509 module (refs: \fI\%#48209\fP)
.IP \(bu 2
de614d31f5 Merge pull request \fI\%#48209\fP from rallytime/bp\-47986
.IP \(bu 2
f4b3bd5d2c Changed salt.utils.fopen to salt.utils.files.fopen
.IP \(bu 2
8686872909 Fixed typos, removed repeated unit tests, and applied code fixes suggested by linter.
.IP \(bu 2
382df48a72 Removed useless new line
.IP \(bu 2
5aa99d14c4 Added unit tests for CRL creation and certificate revocation with CRL
.IP \(bu 2
cc12844922 Fixed a problem where the OpenSSL bindings refuse to consume unicode strings.
.IP \(bu 2
399cf08860 Stopped converting the certificate hexadecimal serial number to an integer in order to avoid breaking CRLs.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48210\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.1 to 2018.3
@ \fI2018\-06\-20 13:43:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f88df6e89 Merge pull request \fI\%#48210\fP from rallytime/merge\-2018.3
.IP \(bu 2
dae65da256 Merge branch \(aq2018.3.1\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48186\fP: (\fI\%rallytime\fP) Add autodoc module for saltcheck.py
@ \fI2018\-06\-19 19:03:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b4897f050 Merge pull request \fI\%#48186\fP from rallytime/saltcheck\-docs
.IP \(bu 2
314fc2d889 Clean up some doc references
.IP \(bu 2
da7603d879 Add autodoc module for saltcheck.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48191\fP: (\fI\%twangboy\fP) Use the \-\-disable\-pip\-version\-check option
@ \fI2018\-06\-19 18:13:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
7274a33c80 Merge pull request \fI\%#48191\fP from twangboy/fix_pip_check
.IP \(bu 2
5c00fce6bf Use the \-\-disable\-pip\-version\-check option
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48122\fP: (\fI\%pasmon\fP) Salt minion 2017.7.6 disregards \(dqbin_env\(dq in pip state (refs: \fI\%#48189\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48189\fP: (\fI\%gtmanfred\fP) If pip binary is passed to bin_env, use that pip binary (refs: \fI\%#48207\fP)
@ \fI2018\-06\-19 18:08:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
96f79b0674 Merge pull request \fI\%#48189\fP from gtmanfred/pip
.IP \(bu 2
96c59f3d93 If pip binary is passed to bin_env, use that pip binary
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48165\fP: (\fI\%terminalmage\fP) Fix regression with top_file_merging_strategy=same
@ \fI2018\-06\-19 18:03:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
71e385501b Merge pull request \fI\%#48165\fP from terminalmage/issue48144
.IP \(bu 2
92ac2a2d6a Remove unused imports
.IP \(bu 2
15a44d5dd4 Remove redundant top file merging tests
.IP \(bu 2
12100d9bd3 Add more top file merging tests
.IP \(bu 2
0ed686cb3f Add unit test for show_top with \(dqsame\(dq merging strategy
.IP \(bu 2
35e5492fb7 Revert 7058f10 / 3df6fa7
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46806\fP: (\fI\%ezh\fP) Lack of debug messages on authentication fail. (refs: \fI\%#46807\fP, \fI\%#48179\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48179\fP: (\fI\%ezh\fP) 2018.3 auth
@ \fI2018\-06\-19 14:16:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46807\fP: (\fI\%ezh\fP) Reduce initial authentication setup complexity (refs: \fI\%#48179\fP)
.IP \(bu 2
2a8e1c6539 Merge pull request \fI\%#48179\fP from ezh/2018.3\-auth
.IP \(bu 2
9ed2d2ec55 Fix integration.shell.test_key and integration.shell.test_runner
.IP \(bu 2
26a6f79730 Fix integration tests test_list_acc_wrong_eauth, test_salt_run_with_wrong_eauth
.IP \(bu 2
b84c4321c4 Add more verbose debug messages for auth subsystem
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48188\fP: (\fI\%gtmanfred\fP) allow virtual aliases to be used for the driver name
@ \fI2018\-06\-18 21:49:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
0231008cf8 Merge pull request \fI\%#48188\fP from gtmanfred/2018.3
.IP \(bu 2
45249d3e10 allow virtual aliases to be used for the driver name
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48116\fP: (\fI\%KaiSforza\fP) Add jenkinsfiles to define tests in 2018
@ \fI2018\-06\-18 21:27:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
0f95238dca Merge pull request \fI\%#48116\fP from KaiSforza/pr\-lint\-2018
.IP \(bu 2
f158bed5bd Add docs, kitchen tests
.IP \(bu 2
904a70c187 Move .jenkins to .ci for future
.IP \(bu 2
365fa0e51f Make it parallel so we don\(aqt fail right away
.IP \(bu 2
e594979745 Add a .jenkins file to run pylint
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48146\fP: (\fI\%rmarchei\fP) mysql_query.run: exception on 2018.3 (refs: \fI\%#48164\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48164\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to mysql state
@ \fI2018\-06\-18 13:10:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
60c9490bdc Merge pull request \fI\%#48164\fP from garethgreenaway/48146_mysql_output_to_file
.IP \(bu 2
a040643a82 Accounting for certain situations when the query result is not a string, but actually a dictionary.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48113\fP: (\fI\%gaetanquentin\fP) state file.line has error and  erase file content completely, while with mode  test=true it is ok (refs: \fI\%#48156\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48156\fP: (\fI\%garethgreenaway\fP) [2018.3] Unicode fixes for file.line
@ \fI2018\-06\-17 19:34:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
85ebcbd3f2 Merge pull request \fI\%#48156\fP from garethgreenaway/48113_ensure_writing_strings_with_file_dot_line
.IP \(bu 2
5a9ef0d1ae Unless we\(aqre using py2 and Windows, ensure we\(aqre writing out a string when using file.line.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48161\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-06\-17 19:33:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
33400e72db Merge pull request \fI\%#48161\fP from rallytime/merge\-2018.3
.IP \(bu 2
0733fa1b02 Update utils path for which function to new path
.IP \(bu 2
398cc78224 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
df2a156338 Merge pull request \fI\%#48061\fP from garethgreenaway/port_47049_2017_7
.INDENT 2.0
.IP \(bu 2
7c472fed51 Fixing failing test_set_hwclock_aix test.
.IP \(bu 2
ccb0acc958 Porting \fI\%#47049\fP to 2017.7.
.UNINDENT
.IP \(bu 2
5ec3cf2dd4 Merge pull request \fI\%#48143\fP from Ch3LL/fix_long_job
.INDENT 2.0
.IP \(bu 2
48b5d2e9d3 Add timeout argument to run_salt for ShellCase
.UNINDENT
.IP \(bu 2
e1e566d1f8 Merge pull request \fI\%#48135\fP from rallytime/release\-notes\-2017.7
.INDENT 2.0
.IP \(bu 2
7a97f157b3 Add missing \fIv\fP for tag reference
.IP \(bu 2
2f2b69ed37 Add \(dqin progress\(dq notation to 2017.7.7 release notes
.IP \(bu 2
06a1151a63 Add release notes file for 2017.7.7
.IP \(bu 2
885b2862ce Move 2017.7.7 release notes to 2017.7.8
.UNINDENT
.IP \(bu 2
ac9dabbfaa Merge pull request \fI\%#48105\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
cdb45874de Merge branch \(aq2017.7.6\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
16916d6bd2 Merge pull request \fI\%#47880\fP from gtmanfred/2017.7.6
.INDENT 2.0
.IP \(bu 2
987ae6358b quote python_version in requirements.txt
.UNINDENT
.IP \(bu 2
27670168ea Merge pull request \fI\%#47875\fP from rallytime/release\-notes\-dot\-six
.INDENT 2.0
.IP \(bu 2
58dee4c829 Remove sentence about the release being in progress
.IP \(bu 2
b3dcb7330e Remove \(dqin progress\(dq too
.IP \(bu 2
99e1df7823 Update 2017.7.6 release notes: remove \(dqunreleased\(dq text
.UNINDENT
.IP \(bu 2
1f0bada07c Merge pull request \fI\%#47873\fP from gtmanfred/2017.7.6
.INDENT 2.0
.IP \(bu 2
a1c1b5b5cf allow tornado 5.0 to be installed only for python2
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
2da56a69d9 Merge pull request \fI\%#48101\fP from rallytime/update\-doc\-refs\-2017.7
.INDENT 2.0
.IP \(bu 2
7ba6f5fb36 Update 2017.7.7 reference to 2017.7.8
.UNINDENT
.IP \(bu 2
5a0e3d46e7 Merge pull request \fI\%#48091\fP from terminalmage/fix\-file_roots\-monkeypatching
.INDENT 2.0
.IP \(bu 2
6fe711ad76 Reverse monkeypatching after test_symlink_list finishes
.UNINDENT
.IP \(bu 2
053b019a8f Merge pull request \fI\%#48088\fP from rallytime/update_version_doc_2017.7
.INDENT 2.0
.IP \(bu 2
1b8d1c936b Remove \(dqin progress\(dq info for 2017.7.6 release notes
.IP \(bu 2
9a0f4d190a Update release versions for the 2017.7 branch
.UNINDENT
.IP \(bu 2
d6d2c5ee18 Merge pull request \fI\%#48075\fP from garethgreenaway/48038_jobs_are_not_deduping_minion_side
.INDENT 2.0
.IP \(bu 2
c537b3275b Ensure that the shared list of jids is passed when creating the Minion.  Fixes an issue when minions are pointed at multiple syndics.
.UNINDENT
.IP \(bu 2
aa33cc0b0c Merge pull request \fI\%#48071\fP from terminalmage/gitfs\-docs
.INDENT 2.0
.IP \(bu 2
24545204b3 Fix inaccurate gitfs_saltenv example in GitFS Walkthrough
.UNINDENT
.IP \(bu 2
fb4ceacb88 Merge pull request \fI\%#48053\fP from rallytime/bp\-48040
.INDENT 2.0
.IP \(bu 2
265b22b194 states/github.py fix for incorrect positional argument
.UNINDENT
.IP \(bu 2
f37dcaac6d Merge pull request \fI\%#48024\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
56b074ab27 allow specifying a different state to run on converge
.IP \(bu 2
cc9c4b4d5a add pytest coverage and xml junits
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48145\fP: (\fI\%max\-arnold\fP) Failed to load ext_pillar saltclass: can only assign an iterable (refs: \fI\%#48155\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48155\fP: (\fI\%max\-arnold\fP) Do not fail on empty saltclass classes (fix for \fI\%#48145\fP)
@ \fI2018\-06\-15 20:21:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
9aa9a83b10 Merge pull request \fI\%#48155\fP from max\-arnold/2018.3
.IP \(bu 2
63ab02c648 Do not fail on empty saltclass classes declaration \fI\%#48145\fP
.IP \(bu 2
3d4fcbe3aa Add test for issue \fI\%#48145\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48104\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_win_status\fP
@ \fI2018\-06\-15 17:05:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
152c09cc0c Merge pull request \fI\%#48104\fP from twangboy/fix_test_win_status
.IP \(bu 2
1ec3f436ee Fix test_error_logged_if_process_get_owner_fails
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48147\fP: (\fI\%brejoc\fP) Fix for sorting of multi\-version packages
@ \fI2018\-06\-15 17:03:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
8cf03110d4 Merge pull request \fI\%#48147\fP from brejoc/2018.3\-multi\-version\-fix
.IP \(bu 2
90ed25447d Swtiching to salt.utils.versions like linter suggested
.IP \(bu 2
ed09574073 Fix for sorting of multi\-version packages (bsc#1097174 and bsc#1097413)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47956\fP: (\fI\%dmurphy18\fP) Improved support for mount on AIX
@ \fI2018\-06\-15 13:40:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
2edc5f5442 Merge pull request \fI\%#47956\fP from dmurphy18/aix_mount_support
.IP \(bu 2
f2a3e321db Improved support for mount on AIX
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48012\fP: (\fI\%Timandes\fP) Found UnicodeDecodeError when trying to start Salt Master (refs: \fI\%#48081\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48081\fP: (\fI\%terminalmage\fP) Fix UnicodeDecodeError when parsing hosts file with non\-ascii
@ \fI2018\-06\-15 12:41:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
c05c176782 Merge pull request \fI\%#48081\fP from terminalmage/issue48012
.IP \(bu 2
8d2fb0bf25 Fix cp.push test
.IP \(bu 2
e230a7223f Fix definition of test data for wtmp/btmp beacon tests
.IP \(bu 2
82874a8c10 Import six like we do everywhere else
.IP \(bu 2
54f9a2ab54 Remove unused import
.IP \(bu 2
767cc7e87f fix tabs
.IP \(bu 2
db19636f56 Get rid of additional newline append
.IP \(bu 2
7427e192ba Fix more crappy mocking
.IP \(bu 2
4eaa5789ce Fix crappy mocking
.IP \(bu 2
248467edac Add regression test for _generate_minion_id()
.IP \(bu 2
5e62d6d45f Fix UnicodeDecodeError when parsing hosts file with non\-ascii
.IP \(bu 2
e6a4744f85 Use errno instead of hard\-coding error 2
.IP \(bu 2
ff63f36932 Fixes / enhancements for mock_open
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48133\fP: (\fI\%rallytime\fP) Updates the 2018.3.2 and 2018.3.3 release notes files
@ \fI2018\-06\-14 21:21:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48129\fP: (\fI\%rallytime\fP) Add release notes for 2018.3.2 (refs: \fI\%#48133\fP)
.IP \(bu 2
5d92e2763a Merge pull request \fI\%#48133\fP from rallytime/release\-notes\-2018.3
.IP \(bu 2
afe1e91972 Add \(dqin progress\(dq notation to 2018.3.2 release notes
.IP \(bu 2
3e4272ac09 Add release notes for 2018.3.2
.IP \(bu 2
88c584cb0d Move 2018.3.2 release notes to 2018.3.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48103\fP: (\fI\%terminalmage\fP) Fix for gitfs base env being pinned to commit ID
@ \fI2018\-06\-14 16:29:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
0e3f846836 Merge pull request \fI\%#48103\fP from terminalmage/gitfs\-base\-pinned\-to\-commit
.IP \(bu 2
31ab2fe8de Fix for gitfs base env being pinned to commit ID
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48077\fP: (\fI\%twangboy\fP) Fix issue with \fIsalt.utils.parsers\fP on Windows
@ \fI2018\-06\-14 16:22:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
4b6f1c7f75 Merge pull request \fI\%#48077\fP from twangboy/fix_parsers
.IP \(bu 2
0f7d7691a2 Call logger in each case
.IP \(bu 2
0e99dd741c Fix logic for non\-root
.IP \(bu 2
2d2534a688 Fix parsers for Windows, fix tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48096\fP: (\fI\%twangboy\fP) Fix \fIunit.utils.test_which\fP on Windows
@ \fI2018\-06\-14 13:15:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
80332b32a7 Merge pull request \fI\%#48096\fP from twangboy/fix_test_which
.IP \(bu 2
d26fc56f13 Use os.sep for paths
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48102\fP: (\fI\%rallytime\fP) [2018.3] Update 2018.3.2 references to 2018.3.3
@ \fI2018\-06\-14 13:14:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
66b2200913 Merge pull request \fI\%#48102\fP from rallytime/update\-doc\-refs\-2018.3
.IP \(bu 2
1c9bcce3d8 Update 2018.3.2 references to 2018.3.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48109\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47851\fP to 2018.3
@ \fI2018\-06\-14 13:09:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47851\fP: (\fI\%rares\-pop\fP) Fixup! add master.py:FileserverUpdate **kwargs (refs: \fI\%#48109\fP)
.IP \(bu 2
2902ee0b14 Merge pull request \fI\%#48109\fP from rallytime/bp\-47851
.IP \(bu 2
e9dc30bf8e Fixup! add master.py:FileserverUpdate **kwargs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47925\fP: (\fI\%JonGriggs\fP) GitFS looking for files in the master branch only (refs: \fI\%#47943\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47943\fP: (\fI\%terminalmage\fP) Make sure we set the effective environment when lock_saltenv is True
@ \fI2018\-06\-13 20:02:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
2529292568 Merge pull request \fI\%#47943\fP from terminalmage/issue47925
.IP \(bu 2
534e1a7100 Merge branch \(aq2018.3\(aq into issue47925
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48089\fP: (\fI\%rallytime\fP) Update release versions for the 2018.3 branch
@ \fI2018\-06\-13 14:03:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
9e1d0040e4 Merge pull request \fI\%#48089\fP from rallytime/update_version_doc_2018.3
.IP \(bu 2
fad6a0991e Remove \(dqin progress\(dq info for 2018.3.1 release notes
.IP \(bu 2
a3b3b0a0e1 Remove \(dqin progress\(dq info for 2017.7.6 release notes
.IP \(bu 2
f9be1b9125 Update release versions for the 2018.3 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48054\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-06\-13 12:58:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
b10b7355a0 Merge pull request \fI\%#48054\fP from rallytime/merge\-2018.3
.IP \(bu 2
508d70fabf Update old utils paths to use new paths
.IP \(bu 2
3d2ea16c3a Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
ffee3576ec Merge pull request \fI\%#48044\fP from twangboy/wua_add_fail_code
.INDENT 2.0
.IP \(bu 2
d41d0c25eb Add faile code for WinHTTP send/receive error
.UNINDENT
.IP \(bu 2
871a910fcb Merge pull request \fI\%#48009\fP from dwoz/winswarmfix
.INDENT 2.0
.IP \(bu 2
5027c7bb84 minionswarm runs on windows
.UNINDENT
.IP \(bu 2
0dcaead36d Merge pull request \fI\%#47968\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
ae1b0d28bb pass LANG and HOME into tox commands
.IP \(bu 2
8d15b93d00 remove tox virtualenvs from doc tests
.IP \(bu 2
e1872e2036 simplify tox.ini
.IP \(bu 2
81bd01f5af add tests.txt for running tests with tox requirements
.IP \(bu 2
556a2067fc fix masterapi test to use testing directory for configs
.IP \(bu 2
5a41f484ef add EXPENSIVE_TESTS
.IP \(bu 2
055cd5a6ba set DESTRUCTIVE_TESTS environment variable for pytest
.UNINDENT
.IP \(bu 2
42dd6b83eb Merge pull request \fI\%#47978\fP from twangboy/fix_test_pkg
.INDENT 2.0
.IP \(bu 2
8bb36b3a4b Add try/finally, fix typo in 7zip def file
.UNINDENT
.IP \(bu 2
a67b21ef3d Merge pull request \fI\%#47959\fP from twangboy/fix_test_service
.INDENT 2.0
.IP \(bu 2
0cd47aa81e Remove unused import
.IP \(bu 2
d4b42540e3 Fix failing test when service doesn\(aqt exist
.UNINDENT
.IP \(bu 2
b81d482067 Merge pull request \fI\%#47983\fP from garethgreenaway/backport_47843_2017_7
.INDENT 2.0
.IP \(bu 2
7b7fb1f5d5 Adding missing test sls file.
.IP \(bu 2
54e51bc627 Backporting \fI\%#47843\fP to 2017.7, updating test for 2017.7.
.UNINDENT
.IP \(bu 2
d56ddad22c Merge pull request \fI\%#47533\fP from twangboy/fix_47178
.INDENT 2.0
.IP \(bu 2
24717cbc21 Change version added to 2017.7.7
.IP \(bu 2
0592f1bac2 Fix issues with functions that user makedirs on Windows
.UNINDENT
.IP \(bu 2
5c56b8c755 Merge pull request \fI\%#47827\fP from twangboy/fix_47791
.INDENT 2.0
.IP \(bu 2
fbbd91f09e Add more descriptive debug message
.IP \(bu 2
365f81651b Fix deprecated exception handling
.IP \(bu 2
8dd6710b93 Use local instead of network
.IP \(bu 2
980d99d74b Fix issue when archive is on mapped drive
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48060\fP: (\fI\%gtmanfred\fP) mark test as expensive
@ \fI2018\-06\-13 12:58:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
c83818e4f9 Merge pull request \fI\%#48060\fP from gtmanfred/2018.3
.IP \(bu 2
914935c4d4 Merge branch \(aq2018.3\(aq into 2018.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48057\fP: (\fI\%terminalmage\fP) Fix link without target in 2018.3.0 release notes
@ \fI2018\-06\-11 18:50:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
a4eb41623d Merge pull request \fI\%#48057\fP from terminalmage/docs\-2018.3
.IP \(bu 2
20f71ff6f6 Fix link without target in 2018.3.0 release notes
.IP \(bu 2
d8c035e5e5 mark test as expensive
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48042\fP: (\fI\%terminalmage\fP) Switch to trace level logging for further test failure troubleshooting
@ \fI2018\-06\-11 14:03:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
0f9a3122df Merge pull request \fI\%#48042\fP from terminalmage/salt\-jenkins\-1000
.IP \(bu 2
b33a0b5eaa Switch to trace level logging for further test failure troubleshooting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48041\fP: (\fI\%terminalmage\fP) salt.utils.hashutils: Only decode to utf\-8 on Windows
@ \fI2018\-06\-11 13:31:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c5389189a Merge pull request \fI\%#48041\fP from terminalmage/hashutils\-fix\-windows
.IP \(bu 2
58c7cd33d7 salt.utils.hashutils: Only decode to utf\-8 on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48014\fP: (\fI\%cro\fP) Find job pause
@ \fI2018\-06\-08 13:48:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
dcae209951 Merge pull request \fI\%#48014\fP from cro/find_job_pause
.IP \(bu 2
440aa67c4f Lint: Add blank line
.IP \(bu 2
7b0e99a511 One more case where returner doesn\(aqt respond
.IP \(bu 2
5abeedf882 Catch two cases when a returner is not able to be contacted\-\-these would throw a stacktrace.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47915\fP: (\fI\%garethgreenaway\fP) [2018.3] state runner pause resume kill
@ \fI2018\-06\-07 16:08:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea85f882bc Merge pull request \fI\%#47915\fP from garethgreenaway/state_runner_pause_resume_kill
.IP \(bu 2
2ecbe9c034 fixing typo in alias_function call.
.IP \(bu 2
4377e0cc08 Some fixes to the set_pause and rm_pause function in the state runner, renaming to in line with the functions in the state module.  Including aliases to previous names for back\-ward compatibility.  Including a soft_kill function to kill running orchestration states.  A new test to test soft_kill functionality.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48002\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47923\fP to 2018.3
@ \fI2018\-06\-07 15:25:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47923\fP: (\fI\%isbm\fP) Prevent crash if files in file.recurse (refs: \fI\%#48002\fP)
.IP \(bu 2
5c11fcde60 Merge pull request \fI\%#48002\fP from rallytime/bp\-47923
.IP \(bu 2
9465e5f1e9 Use to_unicode from stringutils avoid deprecation warning
.IP \(bu 2
73d33cbfc3 Prevent crash if files in file.recurse
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48003\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-06\-07 15:25:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
3d0a087c71 Merge pull request \fI\%#48003\fP from rallytime/merge\-2018.3
.IP \(bu 2
a6533a9332 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
998a1c13d5 Merge pull request \fI\%#47966\fP from mbunkus/fix\-postfix\-prefix\-free\-key\-names\-assumption
.INDENT 2.0
.IP \(bu 2
0ae402d1b5 Fix postfix.set_main\(aqs assumption of prefix\-free key names
.UNINDENT
.IP \(bu 2
df50ce7b1b Merge pull request \fI\%#47824\fP from twangboy/fix_setup.py
.INDENT 2.0
.IP \(bu 2
4538b3abb3 Remove \(aqlen\-as\-condition\(aq disablement
.IP \(bu 2
d4efcc3c8b Skip lint errors
.IP \(bu 2
1b3977f8d4 Remove m2crypto download for Windows
.UNINDENT
.IP \(bu 2
3e91a31134 Merge pull request \fI\%#47922\fP from damon\-atkins/2017.7_win_pkg_keys_fix
.INDENT 2.0
.IP \(bu 2
7129203b1b Merge branch \(aq2017.7\(aq into 2017.7_win_pkg_keys_fix
.UNINDENT
.IP \(bu 2
8008fca2f6 Merge pull request \fI\%#47933\fP from terminalmage/add\-pillar.get\-docs
.INDENT 2.0
.IP \(bu 2
4eb022b675 Clarify pillar.get docs
.UNINDENT
.IP \(bu 2
ab565bfaa3 Merge pull request \fI\%#47944\fP from terminalmage/fix\-git.detached\-docs
.INDENT 2.0
.IP \(bu 2
1d082b4389 Replace use of deprecated argument name in git.detached docstring
.IP \(bu 2
6253793cb6 Merge branch \(aq2017.7\(aq into 2017.7_win_pkg_keys_fix
.IP \(bu 2
4ce0fe6546 win_pkg under py3 keys returns a view instead of a list, wrap keys in list()
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48022\fP: (\fI\%morganwillcock\fP) win_wua state: fix function name in examples
@ \fI2018\-06\-07 15:03:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a05212f60 Merge pull request \fI\%#48022\fP from morganwillcock/patch\-1
.IP \(bu 2
443f4d6f21 win_wua state: fix function name in examples
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47546\fP: (\fI\%ender8282\fP) archive.extracted fails when archive includes files with non\-ascii names with 2018.3.0 (refs: \fI\%#48015\fP, \fI\%#47572\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48015\fP: (\fI\%garethgreenaway\fP) [2018.3] more unicode nonsense in archive module
@ \fI2018\-06\-07 14:44:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
406efb161e Merge pull request \fI\%#48015\fP from garethgreenaway/47546_more_unicode_nonsense
.IP \(bu 2
f457f9cb84 Adding a test to ensure archive.list returns the right results when a tar file contains a file with unicode in its name.
.IP \(bu 2
9af49bc595 Ensure member names are decoded before adding to various lists.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47955\fP: (\fI\%frogunder\fP) 2018.3.1 Creating Windows machine in Amazon using salt\-cloud fails. (refs: \fI\%#47989\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47989\fP: (\fI\%dwoz\fP) Properly decode password from aws using m2crypto
@ \fI2018\-06\-06 20:44:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
1ce7d6c38a Merge pull request \fI\%#47989\fP from dwoz/awscloud
.IP \(bu 2
23ab2727be Fix linter errors
.IP \(bu 2
6c8daa2b85 Properly decode password from aws using m2crypto
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47976\fP: (\fI\%terminalmage\fP) Capture and log output of processes that timed out and were killed
@ \fI2018\-06\-06 19:17:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
76068c83f5 Merge pull request \fI\%#47976\fP from terminalmage/salt\-jenkins\-1000
.IP \(bu 2
41e5a75027 Add catch_timeout to run_script
.IP \(bu 2
551ada8e4d Capture and log output of processes that timed out and were killed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47990\fP: (\fI\%terminalmage\fP) Docs fixes in 2018.3 release branch
@ \fI2018\-06\-06 17:15:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
f12a52736e Merge pull request \fI\%#47990\fP from terminalmage/2018.3\-docs
.IP \(bu 2
f89d2ccd30 Clean up Sphinx warnings
.IP \(bu 2
f5fc936865 Add clarifying comment so that we don\(aqt break this
.IP \(bu 2
94849780ac fix docs build error due to IndexError
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47982\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_win_dns_client\fP tests
@ \fI2018\-06\-06 15:02:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d56af3cad Merge pull request \fI\%#47982\fP from twangboy/fix_test_win_dns_client
.IP \(bu 2
2dcdf6788c Force string to ModuleType
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47985\fP: (\fI\%twangboy\fP) Fix \fIunit.states.test_reg\fP test failure
@ \fI2018\-06\-06 14:56:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
1b4c72345b Merge pull request \fI\%#47985\fP from twangboy/fix_test_reg
.IP \(bu 2
4ce551811f Remove the unnecessary \fIto_unicode\fP stuff
.IP \(bu 2
863ded39fa Mock \fIreg.cast_vdata\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47236\fP: (\fI\%MorphBonehunter\fP) x509.private_key_managed broken after upgrade to 2018.3.0 (refs: \fI\%#47957\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47957\fP: (\fI\%garethgreenaway\fP) [2018.8] Ensure x509 passphrase is a string
@ \fI2018\-06\-05 13:27:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
84100570f7 Merge pull request \fI\%#47957\fP from garethgreenaway/47236_ensure_passphrase_is_a_string
.IP \(bu 2
99bad3cca6 removing unnecessary change
.IP \(bu 2
e22df8473d Ensuring that when a passphrase is passed in, it is returned as a string from the passphrase callback.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
d0cf06a24d Make sure we set the effective environment when lock_saltenv is True
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
8da6ce45dc Finish the docstring for git.cloned state
.IP \(bu 2
4a8260a5e5 Add tests for git.cloned state
.IP \(bu 2
311179da05 Add git.cloned state
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47926\fP: (\fI\%dmurphy18\fP) Backport of PR 47808 to 2018.3, improved grains support for AIX
@ \fI2018\-06\-04 19:31:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47808\fP: (\fI\%dmurphy18\fP) Updated AIX support for grains reported (refs: \fI\%#47926\fP)
.IP \(bu 2
c355da9e0d Merge pull request \fI\%#47926\fP from dmurphy18/backport_pr47808
.IP \(bu 2
ac15d2093a Backport of PR 47808 to 2018.3, improved grains support for AIX
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47927\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-06\-04 18:55:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
a46e42ab11 Merge pull request \fI\%#47927\fP from rallytime/merge\-2018.3
.IP \(bu 2
5baab66f4b Lint: Whitespace fix
.IP \(bu 2
7e1d278d19 Update old utils paths to use new utils paths
.IP \(bu 2
3273bbdab7 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
a2b588299b Merge pull request \fI\%#47860\fP from terminalmage/state\-writing\-docs
.INDENT 2.0
.IP \(bu 2
8cb33d3dec Quiet the linter
.IP \(bu 2
af51e16f23 Use more elegant RST syntax
.IP \(bu 2
91cd57d1e0 Update mocking to reflect changes in service module
.IP \(bu 2
b9ace5a859 Fix crappy mocking
.IP \(bu 2
bc9e3acef3 Lint fixes
.IP \(bu 2
d37f7e4f04 Add 2017.7.6 release notes
.IP \(bu 2
9dddeeefab Improve documentation on syncing states
.IP \(bu 2
f465fa3ca7 Add best practices docs for writing states
.IP \(bu 2
93ee5ee2b0 Fix all Sphinx warnings
.IP \(bu 2
64b9b4d0b8 Clarify that name would override the id declaration
.UNINDENT
.IP \(bu 2
d2f3377b5b Merge pull request \fI\%#47877\fP from dwoz/sleep_audit
.INDENT 2.0
.IP \(bu 2
ebc7cde9cb Revert job chunk wait time change
.UNINDENT
.IP \(bu 2
735e92093e Merge pull request \fI\%#47917\fP from dwoz/winsuite
.INDENT 2.0
.IP \(bu 2
118601ebd6 Fix windows tests suite breakage
.UNINDENT
.IP \(bu 2
63efb76d51 Merge pull request \fI\%#47822\fP from Ch3LL/win_user_test
.INDENT 2.0
.IP \(bu 2
3a691b405f add user_home path for both windows and linux
.IP \(bu 2
788abf771e Add user state integration tests to windows
.UNINDENT
.IP \(bu 2
b9da4f1221 Merge pull request \fI\%#47876\fP from doesitblend/add\-file\-read\-windows
.INDENT 2.0
.IP \(bu 2
3f7e7ec327 Add file.read function to Windows module
.UNINDENT
.IP \(bu 2
cbe2ecfae8 Merge pull request \fI\%#47882\fP from frogunder/45013
.INDENT 2.0
.IP \(bu 2
38d114a2d2 add whoami test
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47931\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47913\fP to 2018.3
@ \fI2018\-06\-04 14:39:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47913\fP: (\fI\%rares\-pop\fP) Fixup! beacons/avahi_announce.py finding grains (refs: \fI\%#47931\fP)
.IP \(bu 2
4db1f8c603 Merge pull request \fI\%#47931\fP from rallytime/bp\-47913
.IP \(bu 2
c51e732f4d Fixup! beacons/avahi_announce.py finding grains
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47930\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47725\fP to 2018.3
@ \fI2018\-06\-04 14:38:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47725\fP: (\fI\%bbczeuz\fP) network_settings beacon: Update example to follow new cfg convention (refs: \fI\%#47930\fP)
.IP \(bu 2
d05a6c70d3 Merge pull request \fI\%#47930\fP from rallytime/bp\-47725
.IP \(bu 2
5c666409f3 Spelling fix
.IP \(bu 2
cfe0a5bb42 network_settings: Fix doc using new list/dict syntax
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47557\fP: (\fI\%L4rS6\fP) fix broken rabbitmq list policies in rabbitmq version 3.7
@ \fI2018\-06\-04 13:25:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
484d83014b Merge pull request \fI\%#47557\fP from L4rS6/fix\-broken\-rabbitmq\-list\-policies
.IP \(bu 2
6d7ef27557 Merge branch \(aq2018.3\(aq into fix\-broken\-rabbitmq\-list\-policies
.IP \(bu 2
e043ea2833 refactored list_policies code and added more tests
.IP \(bu 2
eea81feb7b fix broken rabbitmq list policies in rabbitmq version 3.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47949\fP: (\fI\%terminalmage\fP) Continued troubleshooting on salt\-jenkins 1000
@ \fI2018\-06\-04 13:17:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
866a2fbf5e Merge pull request \fI\%#47949\fP from terminalmage/salt\-jenkins\-1000
.IP \(bu 2
9c369c6aa8 Remove temp logging from test
.IP \(bu 2
af02d5ba7b Add result logging to run_script, make returns DRY
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47941\fP: (\fI\%terminalmage\fP) Update test logging for salt\-jenkins
@ \fI2018\-06\-03 02:40:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
0b85d1273f Merge pull request \fI\%#47941\fP from terminalmage/salt\-jenkins\-1000
.IP \(bu 2
fb66368af9 Update test logging for salt\-jenkins 1000
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47924\fP: (\fI\%Ch3LL\fP) Catch all exceptions in git import for salt.utils.gitfs
@ \fI2018\-06\-01 21:06:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
58b5f2b4dd Merge pull request \fI\%#47924\fP from Ch3LL/mac_gitpy
.IP \(bu 2
75c51ad69b Catch all exceptions in git import for salt.utils.gitfs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47269\fP: (\fI\%isdig\fP) Reopen Windows Minion That Has IAM Role Cannot Access to S3 (refs: \fI\%#47879\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47879\fP: (\fI\%dwoz\fP) Fix ami role usage warts \fI\%#47269\fP
@ \fI2018\-06\-01 14:11:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
b88ec5258d Merge pull request \fI\%#47879\fP from dwoz/ami_role_fix
.IP \(bu 2
3884c2cf5f Fix ami role usage warts \fI\%#47269\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47788\fP: (\fI\%twangboy\fP) Use pytz to calculate timezones
@ \fI2018\-05\-31 18:33:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
b09596982b Merge pull request \fI\%#47788\fP from twangboy/fix_47559
.IP \(bu 2
0d229c6182 Merge branch \(aq2018.3\(aq into fix_47559
.IP \(bu 2
9e612ec9e7 Fix markup in release notes
.IP \(bu 2
60499d18f0 Skip test if pytz not present
.IP \(bu 2
72cc361c7b Move pytz to 3rd party import, add to __virtual__
.IP \(bu 2
b8a6488688 Update __virtual__ function
.IP \(bu 2
9923176b68 Use __utils__, fix unit tests
.IP \(bu 2
73e033f555 Return offset in the same format as Unix
.IP \(bu 2
5656183c5e Add timezone.list, add 2018.3.2 release notes
.IP \(bu 2
986f6c9b2a Use pytz to calculate timezones
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47899\fP: (\fI\%terminalmage\fP) salt\-jenkins issue 1000
@ \fI2018\-05\-31 18:24:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
ae73cb3947 Merge pull request \fI\%#47899\fP from terminalmage/salt\-jenkins\-1000
.IP \(bu 2
25afc932f7 WIP salt\-jenkins issue 1000
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47753\fP: (\fI\%Ch3LL\fP) Add stderr launchctl helper class and fix service mac tests
@ \fI2018\-05\-31 18:16:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
8f78e3aef6 Merge pull request \fI\%#47753\fP from Ch3LL/service_mac
.IP \(bu 2
185c9e9ae2 only stop service if its running
.IP \(bu 2
e15e674955 Add stderr launchctl helper class and fix service mac tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47908\fP: (\fI\%meaksh\fP) Align SUSE salt\-master.service \(aqLimitNOFILES\(aq limit with upstream Salt
@ \fI2018\-05\-31 18:13:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
828bf39695 Merge pull request \fI\%#47908\fP from meaksh/2018.3\-align\-suse\-salt\-master\-service
.IP \(bu 2
efe308013a Align SUSE salt\-master.service \(aqLimitNOFILES\(aq limit with upstream Salt
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47868\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-05\-30 21:20:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
b4bac9b41b Merge pull request \fI\%#47868\fP from rallytime/merge\-2018.3
.IP \(bu 2
e5d386e91c Update solaris core grains test
.IP \(bu 2
267f09c1a0 Lint: Remove unused import
.IP \(bu 2
120ee16b70 Replace old utils paths with new utils paths
.IP \(bu 2
dc32b67c03 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
4b28e510f1 Merge pull request \fI\%#47853\fP from dwoz/py3\-cloud\-test
.INDENT 2.0
.IP \(bu 2
c2f8aef7c5 Fix for py3 ec2 cloud tests
.UNINDENT
.IP \(bu 2
215efa6b73 Merge pull request \fI\%#47847\fP from garethgreenaway/47833_reactor_runner_documentation
.INDENT 2.0
.IP \(bu 2
03676712de Adding some addition documentation to the reactor runner indicating that the reactor system must be active prior to using it.
.UNINDENT
.IP \(bu 2
0bf651b470 Merge pull request \fI\%#47846\fP from Ch3LL/p_refresh_test
.INDENT 2.0
.IP \(bu 2
019edad8e4 Fix flaky refresh pillar integration test
.UNINDENT
.IP \(bu 2
799fce979d Merge pull request \fI\%#47552\fP from twangboy/fix_46981
.INDENT 2.0
.IP \(bu 2
cffc9b7806 Merge branch \(aq2017.7\(aq into fix_46981
.IP \(bu 2
81308a4a44 Add release notes for 2017.7.7
.IP \(bu 2
008af0ac6b Fix unit tests
.IP \(bu 2
87097eefb6 Add comments about how get is returning data
.IP \(bu 2
f1f1bfc5c1 Show GPO settings, raise error if trying to set gpo managed settings
.UNINDENT
.IP \(bu 2
ffc2ebc373 Merge pull request \fI\%#47691\fP from lomeroe/solaris_product_grains
.INDENT 2.0
.IP \(bu 2
6889befc6b Merge branch \(aq2017.7\(aq into solaris_product_grains
.IP \(bu 2
49053bc106 lint fix
.IP \(bu 2
6f185c9179 another lint fix
.IP \(bu 2
dbffba6876 fix tons of errors in my tests
.IP \(bu 2
8c9355d34c Lint fix
.IP \(bu 2
b29ec75da7 Update regexes in core grains for detecting the \(aqproduct\(aq grain on Solaris Sparc systems.  Additionally, copy the \(aqproduct\(aq grain to \(aqproductname\(aq to be consistent with other OSes.
.UNINDENT
.IP \(bu 2
96b7c0cc76 Merge pull request \fI\%#47778\fP from Ch3LL/win_state_pkg
.INDENT 2.0
.IP \(bu 2
e1786de6b0 Merge branch \(aq2017.7\(aq into win_state_pkg
.IP \(bu 2
f8c467d3e6 Fix text editor error
.IP \(bu 2
872e162137 Add test_pkg integration state tests to windows
.UNINDENT
.IP \(bu 2
6f934c2259 Merge pull request \fI\%#47823\fP from Ch3LL/win_dns_test
.INDENT 2.0
.IP \(bu 2
7848114d6a Add win_dns module integration tests for windows
.UNINDENT
.IP \(bu 2
e63e04602d Merge pull request \fI\%#47838\fP from rallytime/bp\-47810
.INDENT 2.0
.IP \(bu 2
bd2b62fa66 better debug message
.IP \(bu 2
83565c55df Address PR feedback
.IP \(bu 2
50bce3a2f3 make decode_linode_plan_label a private function
.IP \(bu 2
2ba4fc4cea fix raising when a \(aqGB\(aq format invalid plan is supplied
.IP \(bu 2
3afb50d5a2 slight cleanup
.IP \(bu 2
319fbd3406 match quotation mark types properly
.IP \(bu 2
95e0202223 more consistent use of parens in logged warning
.IP \(bu 2
f52926ca87 log a warning when the user supplied a label we could decode but was not in the proper format
.IP \(bu 2
121303d827 reduce complexity of get_plan_id by moving decoding of the user\-supplied label to its own function
.IP \(bu 2
cf534c7314 Fix Linode plan selection
.UNINDENT
.IP \(bu 2
9ef6e60617 Merge pull request \fI\%#47805\fP from twangboy/add_sign.bat
.INDENT 2.0
.IP \(bu 2
66d8b0331a Add sign.bat script for signing packages
.UNINDENT
.IP \(bu 2
93420950d3 Merge pull request \fI\%#47500\fP from dwoz/winuser
.INDENT 2.0
.IP \(bu 2
0ca5224cbf Merge branch \(aq2017.7\(aq into winuser
.IP \(bu 2
e5948902af Use salt utils method for this_user
.IP \(bu 2
a056a293f1 Centeralize test username lookup
.IP \(bu 2
6a6ab69722 Get the current username on windows
.UNINDENT
.IP \(bu 2
552526f309 Merge pull request \fI\%#47802\fP from rallytime/bp\-40892
.INDENT 2.0
.IP \(bu 2
bb357da084 add minion function to reload beacon \fI\%#35960\fP
.UNINDENT
.IP \(bu 2
c9cccf53b9 Merge pull request \fI\%#47816\fP from Ch3LL/disable_windows
.INDENT 2.0
.IP \(bu 2
2509d36888 Add windows to service disable ERROR check in tests
.UNINDENT
.IP \(bu 2
2cb6634c6b Merge pull request \fI\%#47773\fP from frogunder/45011
.INDENT 2.0
.IP \(bu 2
7c9b0bda33 add win_servermanager.list_available test
.UNINDENT
.IP \(bu 2
e65dece202 Merge pull request \fI\%#47807\fP from dwoz/winrmtests
.INDENT 2.0
.IP \(bu 2
1f1cc1357a Increase instance size for cloud tests
.IP \(bu 2
be8dcd21f1 Try an even bigger timeout
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47900\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.1 to 2018.3
@ \fI2018\-05\-30 18:09:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
21550dbd2d Merge pull request \fI\%#47900\fP from rallytime/merge\-2018.3.1\-to\-2018.3
.IP \(bu 2
2801eecb26 Merge branch \(aq2018.3.1\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30367\fP: (\fI\%paulfanelli\fP) salt\-run orchestration via state.sls always successful; it is ignoring state return value (refs: \fI\%#47843\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47843\fP: (\fI\%garethgreenaway\fP) [2018.3] orchestration results False when function is False (refs: \fI\%#47983\fP)
@ \fI2018\-05\-30 17:21:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
a0bf565741 Merge pull request \fI\%#47843\fP from garethgreenaway/30367_orch_return_false_when_function_fails
.IP \(bu 2
09242697b8 Merge branch \(aq2018.3\(aq into 30367_orch_return_false_when_function_fails
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47866\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47814\fP to 2018.3
@ \fI2018\-05\-29 19:55:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47814\fP: (\fI\%travispaul\fP) Bugfixes and unit tests for pkgin module (refs: \fI\%#47866\fP)
.IP \(bu 2
da6f7a5538 Merge pull request \fI\%#47866\fP from rallytime/bp\-47814
.IP \(bu 2
d50c0ab96b Lint test_pkgin.py
.IP \(bu 2
4dac0b4a31 pkgin latest_version bugfix
.IP \(bu 2
4ae0313797 Bugfixes and unit tests for pkgin module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47865\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47600\fP to 2018.3
@ \fI2018\-05\-29 19:54:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47600\fP: (\fI\%travispaul\fP) Prevent crash on NetBSD and OpenBSD when no swap is configured. (refs: \fI\%#47865\fP)
.IP \(bu 2
d9e7f2b5b1 Merge pull request \fI\%#47865\fP from rallytime/bp\-47600
.IP \(bu 2
f9f464fa51 Prevent crash on NetBSD and OpenBSD when no swap is configured.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47221\fP: (\fI\%azelezni\fP) Fix boto_ec2 unused parameter \(dqnetwork_interfaces\(dq
@ \fI2018\-05\-29 14:41:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
61561a8279 Merge pull request \fI\%#47221\fP from azelezni/fix\-boto_ec2\-network_interfaces
.IP \(bu 2
03ee0023eb Fix unused network_interfaces parameter
.IP \(bu 2
1ece61ddfa Fix unused network_interfaces parameter
.IP \(bu 2
3e074be9c3 Fixing lint
.IP \(bu 2
02609b6e61 Adding state files for new test.
.IP \(bu 2
377e34c689 Updating function in saltmod to ensure that the result is a failure if the function being run returns as False.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47850\fP: (\fI\%rallytime\fP) Fix autodoc for new swarm module
@ \fI2018\-05\-26 01:53:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
c4d828c986 Merge pull request \fI\%#47850\fP from rallytime/swarm\-autodoc
.IP \(bu 2
467c8fa45c Fix autodoc for new swarm module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47800\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-05\-26 01:17:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
30b31c5db5 Merge pull request \fI\%#47800\fP from rallytime/merge\-2018.3
.IP \(bu 2
9e3ce39e8c Typo: test_type \-\-> text_type
.IP \(bu 2
8877489386 Fix bad merge caught by test in zpool state
.IP \(bu 2
c328450be2 Update old utils paths to new paths
.IP \(bu 2
4abfd26e86 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
46618d2ce7 Merge pull request \fI\%#47765\fP from meaksh/2017.7\-fix\-zypper\-error\-reading\-repo
.INDENT 2.0
.IP \(bu 2
4475ba19b8 Prevent zypper from parsing repo configuration from not .repo files
.UNINDENT
.IP \(bu 2
0e87559ee3 Merge pull request \fI\%#47781\fP from rallytime/update\-linode\-sizes
.INDENT 2.0
.IP \(bu 2
a90c1b760e Update cloud test profile and docs to use new Linode size labels
.UNINDENT
.IP \(bu 2
3ddc56cb9b Merge pull request \fI\%#47748\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
b75f5ae38e Merge branch \(aq2017.7.6\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
edf94c915e Merge pull request \fI\%#47775\fP from gtmanfred/2017.7.6
.INDENT 2.0
.IP \(bu 2
548f65d056 catch UnsupportedOperation with AssertionError
.UNINDENT
.UNINDENT
.IP \(bu 2
17596f3025 Merge branch \(aq2017.7.6\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
8c38ecd75f Merge pull request \fI\%#47769\fP from gtmanfred/2017.7.6
.INDENT 2.0
.IP \(bu 2
3fdfc0fa82 skip test that breaks test suite
.UNINDENT
.UNINDENT
.IP \(bu 2
e458f4a031 Merge branch \(aq2017.7.6\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
0d5b473ce2 Merge pull request \fI\%#47747\fP from Ch3LL/rn_2017.7.6
.INDENT 2.0
.IP \(bu 2
d4aa83b92d Add changelog to 2017.7.6 release notes
.UNINDENT
.IP \(bu 2
8a5b34f7d9 Merge pull request \fI\%#47702\fP from damon\-atkins/2017.7.6_fix_pkg.latest_state
.INDENT 2.0
.IP \(bu 2
adcc094e08 Merge branch \(aq2017.7.6\(aq into 2017.7.6_fix_pkg.latest_state
.UNINDENT
.IP \(bu 2
d610c192d9 Merge pull request \fI\%#47700\fP from yannj\-fr/2017.7.6
.INDENT 2.0
.IP \(bu 2
961c1ef61e fix roots modification time check
.INDENT 2.0
.IP \(bu 2
2a73e905df Merge branch \(aq2017.7.6\(aq into 2017.7.6
.UNINDENT
.UNINDENT
.IP \(bu 2
266749420f Merge pull request \fI\%#47632\fP from gtmanfred/2017.7.6
.INDENT 2.0
.IP \(bu 2
2c50c0d2f5 fix pylint
.IP \(bu 2
4a29057b16 Fix last test for tornado
.IP \(bu 2
550ef2e272 allow using tornado 5.0
.IP \(bu 2
62e468448b handle new _create_stream in tornado 5.0
.UNINDENT
.IP \(bu 2
2643c356af Merge pull request \fI\%#47720\fP from rallytime/bp\-47692\-2017.7.6
.INDENT 2.0
.IP \(bu 2
6e5cb36839 Default windows to m1.small for ec2\-classic
.INDENT 2.0
.IP \(bu 2
20d9785244 fix roots modification time check
.UNINDENT
.IP \(bu 2
aef37dd1ce fix roots modification time check
.IP \(bu 2
d51662e053 Ensure targeted_pkgs always contains value for non\-windows.
.IP \(bu 2
83b4224cf8 Adjusted based on feed back.
.IP \(bu 2
12f983ce9f Whitespace lint issues
.IP \(bu 2
075d3d3c49 pkg.install execution module on windows ensures the software package is installed when no version is specified, it does not upgrade the software to the latest. This is per the design. pkg.latest must provide the versions to install to pkg.install
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
0ddc864f90 Merge pull request \fI\%#47779\fP from dwoz/winrmtests
.INDENT 2.0
.IP \(bu 2
d5eafe9d53 Use common timeout variable
.IP \(bu 2
7e948eb540 Increase ec2 cloud timeouts to 1000
.UNINDENT
.IP \(bu 2
17c4c8443c Merge pull request \fI\%#47430\fP from baniobloom/vpc_association_not_found
.INDENT 2.0
.IP \(bu 2
0f1d007f91 added catch for VPCAssociationNotFound
.UNINDENT
.IP \(bu 2
9c5dde1449 Merge pull request \fI\%#47525\fP from baniobloom/duplicate_sec_group_rule
.INDENT 2.0
.IP \(bu 2
dcc35df489 if we are trying to add the same rule then we are already in the desired state, return true
.UNINDENT
.IP \(bu 2
536ce2fa42 Merge pull request \fI\%#47772\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
67756a50fd lock down dependencies for kitchen\-salt
.UNINDENT
.IP \(bu 2
12b330f049 Merge pull request \fI\%#47749\fP from terminalmage/issue47717
.INDENT 2.0
.IP \(bu 2
cd484bef69 Fix \(dqdnf list upgrades\(dq parsing
.UNINDENT
.IP \(bu 2
5cd18b9e70 Merge pull request \fI\%#47755\fP from dwoz/winrmtests
.INDENT 2.0
.IP \(bu 2
57dd89e6c3 Default to ec2 classic compatible images
.IP \(bu 2
f89668920a Be explicit about winrm setting
.UNINDENT
.IP \(bu 2
f45a96ba1d Merge pull request \fI\%#47668\fP from Ch3LL/win_pkg_test
.INDENT 2.0
.IP \(bu 2
a8981024de Add pkg.latest_version windows test
.UNINDENT
.IP \(bu 2
7b12444dfa Merge pull request \fI\%#47750\fP from dwoz/cloudtest
.INDENT 2.0
.IP \(bu 2
63b722ba21 Allow ssh_interface to default to public_ips
.UNINDENT
.IP \(bu 2
27fbb42210 Merge pull request \fI\%#47737\fP from dwoz/win_timeout
.INDENT 2.0
.IP \(bu 2
e88833a07d Cloud test fixup
.UNINDENT
.IP \(bu 2
1a93f060fb Merge pull request \fI\%#47729\fP from UtahDave/fix_get_info_doc
.INDENT 2.0
.IP \(bu 2
443a2d72a2 fix cli example to match function name
.UNINDENT
.IP \(bu 2
00a13761c7 Merge pull request \fI\%#47682\fP from terminalmage/issue47182
.INDENT 2.0
.IP \(bu 2
d0243e8f23 Suppress spurious lint failure
.IP \(bu 2
3b449f11fc Add regression test for excludes issue
.IP \(bu 2
28a7d2b81c Skip __exclude__ in find_sls_ids
.UNINDENT
.IP \(bu 2
518f7bcc62 Merge pull request \fI\%#47708\fP from darkpixel/47696\-do\-not\-enumerate\-none
.INDENT 2.0
.IP \(bu 2
54e9bf9ec9 Merge branch \(aq2017.7\(aq into 47696\-do\-not\-enumerate\-none
.UNINDENT
.IP \(bu 2
cad062eaa7 Merge pull request \fI\%#47681\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
6c06cb3ae3 Merge branch \(aq2017.7.6\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
fd2d45d9c2 Merge pull request \fI\%#47683\fP from Ch3LL/mac_user_test
.INDENT 2.0
.IP \(bu 2
5a1b25b9c7 Remove unnecessary setUp in states.test_user test for mac
.UNINDENT
.IP \(bu 2
f323799c42 Merge pull request \fI\%#47692\fP from dwoz/win_instance_type
.INDENT 2.0
.IP \(bu 2
20b6070d54 Default windows to m1.small for ec2\-classic
.UNINDENT
.IP \(bu 2
990ece5cd5 Merge pull request \fI\%#47665\fP from gtmanfred/cloud
.INDENT 2.0
.IP \(bu 2
fd8a02decb use dictupdate to update the providers dictionary and merge lists
.UNINDENT
.IP \(bu 2
a2ed8cbb7f Merge pull request \fI\%#47151\fP from zer0def/configparser\-defaultsect
.INDENT 2.0
.IP \(bu 2
a8f2ad977e Merge branch \(aq2017.7\(aq into configparser\-defaultsect
.IP \(bu 2
cca2a806c9 Made interaction with [DEFAULT] section in ConfigParser as sane as upstream permits.
.UNINDENT
.IP \(bu 2
e6fb8342ef Merge pull request \fI\%#47673\fP from terminalmage/bp\-45808
.INDENT 2.0
.IP \(bu 2
454291ad62 Fix errors when attempting to cache files with long names or URLs
.UNINDENT
.IP \(bu 2
b0446aab07 Merge pull request \fI\%#47670\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
dfd5a8715f add a pytest.ini and update a dependency for kitchen
.UNINDENT
.IP \(bu 2
0d06da6944 Merge pull request \fI\%#47626\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
418364a533 make dev_python27.txt have the same message as dev_python34.txt
.IP \(bu 2
d53b44d10f remove lock file
.IP \(bu 2
493ed7f93d use the toml dict format
.IP \(bu 2
e0f7cc1447 add proxy tests decorator to pytest conftest
.IP \(bu 2
0a621dd0ec add Pipfile for managing dependencies in salt
.IP \(bu 2
f78b81db94 simplify dev and base.txt to single files
.UNINDENT
.IP \(bu 2
a07a8906a0 Merge pull request \fI\%#47578\fP from Ch3LL/mac_service_disabled
.INDENT 2.0
.IP \(bu 2
6032a01f55 change disable check for upstart service on ubuntu14
.IP \(bu 2
33b4cfbc5b Change service assertion check for systemd platforms
.IP \(bu 2
14896f9743 change codeauthor and class name
.IP \(bu 2
502c5bdff5 Ensure mac_service.disabled is correctly querying services
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
95d4488f01 Merge branch \(aq2017.7.6\(aq into 47696\-do\-not\-enumerate\-none
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
16c2153385 Merge pull request \fI\%#47667\fP from Ch3LL/mac_user_enable
.INDENT 2.0
.IP \(bu 2
ba40d3d1a1 Update test_mac_user_enable_auto_login to test both py2 and py3
.UNINDENT
.IP \(bu 2
a4921e86c9 Merge pull request \fI\%#47645\fP from Ch3LL/py3_rm_pip
.INDENT 2.0
.IP \(bu 2
225d90ad4c query the pip path for test test_issue_2087_missing_pip
.UNINDENT
.IP \(bu 2
e441733ac1 Merge pull request \fI\%#47646\fP from rallytime/bp\-47601\-and\-47643
.INDENT 2.0
.IP \(bu 2
9e1d1a5ef8 Fix typo
.IP \(bu 2
4e94609136 Remove unwanted file
.IP \(bu 2
0109249c78 use ignore\-undefined\-variable
.IP \(bu 2
37caecb7f4 Ignore pylint WindowsError
.IP \(bu 2
c1135d90c7 Better doc string
.IP \(bu 2
e53d6b9ed9 Skip tests when we can not use runas
.IP \(bu 2
041e4c6ddb Wrap properties loop with a check for None.  Closes GH\-47696
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47581\fP: (\fI\%twangboy\fP) Add get_encoding salt util
@ \fI2018\-05\-25 20:40:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
da9eaa1825 Merge pull request \fI\%#47581\fP from twangboy/fix_47274
.IP \(bu 2
ff6600f25e Merge branch \(aq2018.3\(aq into fix_47274
.IP \(bu 2
6eff2f847b Add suggested changes
.IP \(bu 2
e27e9fd1e7 Fix tests on Py3
.IP \(bu 2
f398cbbdda Use os.linesep.join instead of textwrap.dedent
.IP \(bu 2
771392e299 Fix unit tests, add newline=\(aq\(aq to io.open
.IP \(bu 2
c0f735dde3 Remove comment
.IP \(bu 2
6d877bb48b Add comment
.IP \(bu 2
9f369d3f22 Remove to_encoding, create get_encoding
.IP \(bu 2
68be0f9ed2 Add is_encoding salt util
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47694\fP: (\fI\%thuhak\fP) utils/boto and utils/boto3 load error (refs: \fI\%#47726\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47726\fP: (\fI\%gtmanfred\fP) rename boto to botomod
@ \fI2018\-05\-25 20:37:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
b860d95b2c Merge pull request \fI\%#47726\fP from gtmanfred/2018.3
.IP \(bu 2
43997a466e fix tests
.IP \(bu 2
59180e09a8 switch all salt.utils.boto* calls to __utils__ calls
.IP \(bu 2
7e30f459c9 rename boto to botomod
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47701\fP: (\fI\%babs\fP) elasticsearch.index_template_present state with check_definition: True fails.  (refs: \fI\%#47703\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47803\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47703\fP to 2018.3
@ \fI2018\-05\-23 20:12:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47703\fP: (\fI\%babs\fP) Fix elasticsearch.index_template_present with check_definition (refs: \fI\%#47803\fP)
.IP \(bu 2
2a270162d0 Merge pull request \fI\%#47803\fP from rallytime/bp\-47703
.IP \(bu 2
8fce0c562d Fix elasticsearch with check_definition
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47804\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47761\fP to 2018.3
@ \fI2018\-05\-23 20:11:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47761\fP: (\fI\%zerthimon\fP) Fix userdata in openstack instances (refs: \fI\%#47804\fP)
.IP \(bu 2
780043e6fd Merge pull request \fI\%#47804\fP from rallytime/bp\-47761
.IP \(bu 2
b7bc306333 Fix userdata in openstack instances
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47776\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to failing _before_connect tests
@ \fI2018\-05\-23 15:10:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
1efe891c42 Merge pull request \fI\%#47776\fP from garethgreenaway/970_two_minion_unit_tests_failing
.IP \(bu 2
a5011b49ab Merge branch \(aq2018.3\(aq into 970_two_minion_unit_tests_failing
.IP \(bu 2
ef24f72169 Fixing unit.test_minion.MinionTestCase.test_beacons_before_connect and unit.test_minion.MinionTestCase.test_scheduler_before_connect.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47783\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.1 to 2018.3
@ \fI2018\-05\-23 14:51:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
4a6ca67883 Merge pull request \fI\%#47783\fP from rallytime/merge\-2018.3
.IP \(bu 2
1adb8ea27f Merge branch \(aq2018.3.1\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47149\fP: (\fI\%meaksh\fP) [2018.3] Strip trailing commas on Linux user\(aqs GECOS fields
@ \fI2018\-05\-22 21:18:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
f8a6a85d28 Merge pull request \fI\%#47149\fP from meaksh/2018.3\-remove\-trailing\-commas\-on\-linux\-user\-gecos\-fields
.IP \(bu 2
60ec3230db Merge branch \(aq2018.3\(aq into 2018.3\-remove\-trailing\-commas\-on\-linux\-user\-gecos\-fields
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46938\fP: (\fI\%racooper\fP) Beacons documentation update for 2018.3 (refs: \fI\%#47740\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47740\fP: (\fI\%garethgreenaway\fP) [2018.3] Updating Beacon topic to include list based configuration for Beacons
@ \fI2018\-05\-21 13:58:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
19f4137b63 Merge pull request \fI\%#47740\fP from garethgreenaway/46938_beacons_documentation
.IP \(bu 2
5d23ef4dd8 Updating Beacon topic to include list based configuration for Beacons
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47710\fP: (\fI\%terminalmage\fP) salt.loader: add error logging when whitelist lookup fails
@ \fI2018\-05\-18 16:56:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
22807ac756 Merge pull request \fI\%#47710\fP from terminalmage/fix\-loader\-whitelist
.IP \(bu 2
6192391b7b Add additional missing modules to whitelist
.IP \(bu 2
7192c38f66 Change key \-> function to make log message more clear
.IP \(bu 2
91f9fd38fd Fix loader whitelists in unit tests
.IP \(bu 2
d4f2662e5b Add error logging when whitelist lookup fails
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47680\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.1 to 2018.3
@ \fI2018\-05\-17 21:30:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
b91c0f5647 Merge pull request \fI\%#47680\fP from rallytime/merge\-2018.3
.IP \(bu 2
9b1773a763 Merge branch \(aq2018.3.1\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47545\fP: (\fI\%dmurphy18\fP) Fix non\-root build and signing for rpm packages
@ \fI2018\-05\-17 21:20:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
dbf12f9be2 Merge pull request \fI\%#47545\fP from dmurphy18/fix_nonroot_build
.IP \(bu 2
220f887fa6 Fixed review comment, changed file.chown to file.makedirs_perms
.IP \(bu 2
b15a1652b5 Changed versionadded from 2018.3.1 to 2018.3.2, to reflect when change should be accepted
.IP \(bu 2
90eb03e375 Additional error checking and minor cleanup
.IP \(bu 2
40d77e03d2 Correct building rpms with non\-root user
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47546\fP: (\fI\%ender8282\fP) archive.extracted fails when archive includes files with non\-ascii names with 2018.3.0 (refs: \fI\%#48015\fP, \fI\%#47572\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47572\fP: (\fI\%garethgreenaway\fP) [2018.3] archive module, filenames with Unicode characters
@ \fI2018\-05\-17 20:41:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
69056e5b67 Merge pull request \fI\%#47572\fP from garethgreenaway/47546_archive_non_ascii_filenames
.IP \(bu 2
5e97b8b44a Updating with requested changes.
.IP \(bu 2
cc1aa75a2f only convert to bytes when using Python2
.IP \(bu 2
0fe32f4066 Updating integration/modules/test_archive to include filenames with unicode characters.
.IP \(bu 2
5a9cadd125 Accounting for when files in an archive contain non\-ascii characters
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47661\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-05\-16 15:53:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
cb04d9c37e Merge pull request \fI\%#47661\fP from rallytime/merge\-2018.3
.IP \(bu 2
dd3e6f3f0a Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
f63d801858 Merge pull request \fI\%#47639\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
1503f1020f Merge branch \(aq2017.7.6\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
6f178ca908 Merge pull request \fI\%#47570\fP from gtmanfred/2017.7.6
.INDENT 2.0
.IP \(bu 2
84aa034e03 Update dependency to msgpack
.UNINDENT
.IP \(bu 2
98bd598701 Merge pull request \fI\%#47523\fP from rallytime/man\-pages
.INDENT 2.0
.IP \(bu 2
48ecb78dec [2017.7.6] Update man pages
.UNINDENT
.IP \(bu 2
e608ea9617 Merge pull request \fI\%#47517\fP from rallytime/bp\-47505\-2017.7.6
.IP \(bu 2
0734578533 Raise proper invocation errors
.UNINDENT
.UNINDENT
.IP \(bu 2
db0eef3e8b Merge pull request \fI\%#47643\fP from dwoz/runas_detect
.INDENT 2.0
.IP \(bu 2
8c5e54b8b3 Fix typo
.IP \(bu 2
69bc88f1c6 Remove unwanted file
.UNINDENT
.IP \(bu 2
6dd3ab9f06 Merge pull request \fI\%#47601\fP from dwoz/runas_detect
.INDENT 2.0
.IP \(bu 2
3235ac08cb use ignore\-undefined\-variable
.IP \(bu 2
58911d510a Ignore pylint WindowsError
.IP \(bu 2
17987d3c5a Better doc string
.IP \(bu 2
a48ac26573 Skip tests when we can not use runas
.UNINDENT
.IP \(bu 2
f61ccae627 Merge pull request \fI\%#47611\fP from Ch3LL/deb_doc
.INDENT 2.0
.IP \(bu 2
6d2ddd050f One more grammar fixup
.IP \(bu 2
2d5ff01261 Grammar fix
.IP \(bu 2
138847c9c4 Update debian install docs to reflect new latest debian releases
.UNINDENT
.IP \(bu 2
9e2fe284e4 Merge pull request \fI\%#47598\fP from rallytime/bp\-47568\-2017.7
.INDENT 2.0
.IP \(bu 2
09458c65cf Add exception logging on serialize/deserialize exceptions
.IP \(bu 2
c62c855f9c salt.serializers.yaml/yamlex: remove invalid multi_constructor
.UNINDENT
.IP \(bu 2
8a7913ccc3 Merge pull request \fI\%#47548\fP from Ch3LL/syslog
.INDENT 2.0
.IP \(bu 2
31f13a4197 sysloghander: check for 3.5.4 python version
.IP \(bu 2
a020352a03 Catch Sysloghandler errors when log file does not exist
.UNINDENT
.IP \(bu 2
82fb6ba366 Merge pull request \fI\%#47508\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
1a87e7455f allow pulling the mysql_query.run_file to pull from the fileserver
.UNINDENT
.IP \(bu 2
be29b58a09 Merge pull request \fI\%#47562\fP from rallytime/bp\-47513
.INDENT 2.0
.IP \(bu 2
357bc084b3 fix \fI\%#46546\fP
.UNINDENT
.IP \(bu 2
d3121fcfa4 Merge pull request \fI\%#47471\fP from meaksh/2017.7\-fix\-inconsistent\-scheduled\-jid\-with\-returners
.INDENT 2.0
.IP \(bu 2
f079939500 Do not override jid on returners, only sending back to master
.UNINDENT
.IP \(bu 2
662f6086db Merge pull request \fI\%#47313\fP from Circuitsoft/2017.7
.INDENT 2.0
.IP \(bu 2
237560b745 Merge branch \(aq2017.7\(aq into 2017.7
.IP \(bu 2
cb674fb1cb Enable opkg as pkgrepo handler on Poky
.IP \(bu 2
7a58fd157e Enable opkg on non\-NILinuxRT systems
.IP \(bu 2
139360c55f Add Poky to OS Information Grains
.IP \(bu 2
d74057224d Un\-normalize os_family in pkgrepo state
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47672\fP: (\fI\%terminalmage\fP) Backport \fI\%#47487\fP to 2018.3
@ \fI2018\-05\-16 13:55:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47487\fP: (\fI\%rosscdh\fP) bad ref to error fix (refs: \fI\%#47672\fP)
.IP \(bu 2
d17a16b648 Merge pull request \fI\%#47672\fP from terminalmage/bp\-47487
.IP \(bu 2
12abbfdcf7 bad ref to error fix
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47501\fP: (\fI\%mateiw\fP) salt\-ssh doesn\(aqt propagate pillar when overriding pillar in module.run + state.apply (refs: \fI\%#47504\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47504\fP: (\fI\%mateiw\fP) Fix pillar propagation in salt\-ssh when overriding pillar in module.run + state.apply
@ \fI2018\-05\-16 13:55:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d4f5203a7 Merge pull request \fI\%#47504\fP from mateiw/2018.3\-salt\-ssh\-pillar\-propagation\-issue\-47501
.IP \(bu 2
3ffa412ee5 Merge branch \(aq2018.3\(aq into 2018.3\-salt\-ssh\-pillar\-propagation\-issue\-47501
.IP \(bu 2
2f1485e067 Option to merge current pillar with opts[\(aqpillar\(aq] during pillar compile
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47212\fP: (\fI\%weswhet\fP) fix macOS running as user.
@ \fI2018\-05\-16 13:54:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
4fe78bbb9b Merge pull request \fI\%#47212\fP from weswhet/fix\-macos\-runas
.IP \(bu 2
8ee11d74af Merge branch \(aq2018.3\(aq into fix\-macos\-runas
.IP \(bu 2
e78fa45927 adding in requested changes
.IP \(bu 2
33c1492099 Merge branch \(aq2018.3\(aq into fix\-macos\-runas
.IP \(bu 2
0ecabcae78 adding in a fix for running commands as a user on macos
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47587\fP: (\fI\%FedericoOlivieri\fP) \-\-out=table broken in  2018.3.0 \(aqstr\(aq object but received a \(aqunicode\(aq (refs: \fI\%#47674\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47674\fP: (\fI\%terminalmage\fP) Fix regression in table outputter due to unicode types
@ \fI2018\-05\-16 13:41:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
0c7439a955 Merge pull request \fI\%#47674\fP from terminalmage/issue47587
.IP \(bu 2
43e3dcd398 Fix Python 3 incompatibility in table outputter
.IP \(bu 2
d729656703 Add unit tests for table outputter
.IP \(bu 2
907d182dea Fix regression in table outputter due to unicode strings
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47617\fP: (\fI\%aesposito91\fP) Update napalm.py
@ \fI2018\-05\-15 15:44:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
d1a1a594e9 Merge pull request \fI\%#47617\fP from aesposito91/2018.3
.IP \(bu 2
9f5d201dd7 Update napalm.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46871\fP: (\fI\%guettli\fP) Sentry Logging Handler (refs: \fI\%#47649\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47649\fP: (\fI\%paulcollinsiii\fP) Some additional details about Sentry for the docs
@ \fI2018\-05\-15 15:41:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
049abe2850 Merge pull request \fI\%#47649\fP from paulcollinsiii/sentry_docs
.IP \(bu 2
2a8dfd65d7 Some additional details about Sentry for the docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47642\fP: (\fI\%garethgreenaway\fP) [2018.3] Updating templates used by salt\-extend for unicode goodness
@ \fI2018\-05\-15 15:38:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
8a21b864df Merge pull request \fI\%#47642\fP from garethgreenaway/unicode_update_salt_extend_templates
.IP \(bu 2
68d73f7afc Updating the templates that the salt\-extend utility uses to include unicode_literals & print_function
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
0232a6e1ad Add \(aqother\(aq as valid kwargs for \(aquser.add\(aq method
.IP \(bu 2
ff861d9089 Merge branch \(aq2018.3\(aq into 2018.3\-remove\-trailing\-commas\-on\-linux\-user\-gecos\-fields
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47603\fP: (\fI\%terminalmage\fP) Move/merge more test modules
@ \fI2018\-05\-14 20:48:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
99f53c0a9f Merge pull request \fI\%#47603\fP from terminalmage/more\-test\-renaming
.IP \(bu 2
d612bd27e4 Move/merge more test modules
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47640\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.1 to 2018.3
@ \fI2018\-05\-14 17:59:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
cc3daa88f3 Merge pull request \fI\%#47640\fP from rallytime/merge\-2018.3
.IP \(bu 2
2827c56399 Merge branch \(aq2018.3.1\(aq into \(aq2018.3\(aq
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
f1680f1d9b Do make comparisons in a single line
.IP \(bu 2
7dea455c12 Add unit test for new method \(aquser.chother\(aq
.IP \(bu 2
694882632c Add \(aqother\(aq attribute to GECOS fields to avoid inconsistencies with chfn
.IP \(bu 2
6c089c9de1 Fix unsupported chars checking on GECOS fields
.IP \(bu 2
d5c9ca0fbc Add unit tests for GECOS fields
.IP \(bu 2
ed940c4f58 Strip trailing commas on Linux user GECOS fields
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47589\fP: (\fI\%Ch3LL\fP) Remove duplicate file id in watch_any doc example
@ \fI2018\-05\-10 22:06:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ec63dd041 Merge pull request \fI\%#47589\fP from Ch3LL/watch_any_doc
.IP \(bu 2
8cb97a48f5 Add additional state to watch_any doc example
.IP \(bu 2
f7223a3bbf Remove duplicate file id in watch_any doc example
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47564\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-05\-10 19:13:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
9836a7e62b Merge pull request \fI\%#47564\fP from rallytime/merge\-2018.3
.IP \(bu 2
295e302fcf Lint: Fix syntax error from bad merge\-conflict resolution
.IP \(bu 2
25f03ae425 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
291d3d3bd8 Merge pull request \fI\%#47540\fP from terminalmage/cmdmod\-home\-fix
.INDENT 2.0
.IP \(bu 2
e4b277f82e Fix corner case where runas user\(aqs HOME env value is incorrect
.UNINDENT
.IP \(bu 2
49af577b3e Merge pull request \fI\%#47547\fP from terminalmage/gitfs\-tutorial
.INDENT 2.0
.IP \(bu 2
806ffb298a Add masterless mode docs to gitfs tutorial
.UNINDENT
.IP \(bu 2
476ba053d1 Merge pull request \fI\%#47538\fP from terminalmage/pip\-docs
.INDENT 2.0
.IP \(bu 2
98e8ffeba4 Fix/clarify some of the pip module documentation
.UNINDENT
.IP \(bu 2
7cc8d9d30a Merge pull request \fI\%#47524\fP from dwoz/whitelistlines
.INDENT 2.0
.IP \(bu 2
2605ff8712 Gracefully handle blank lines in whitelist.txt
.UNINDENT
.IP \(bu 2
f1a5b13072 Merge pull request \fI\%#47527\fP from dwoz/test_file_name
.INDENT 2.0
.IP \(bu 2
4aea7ca571 Update doc string
.IP \(bu 2
b3289e5a1c Fix test file name
.UNINDENT
.IP \(bu 2
e9c1723175 Merge pull request \fI\%#47408\fP from Ch3LL/skip_diskusage
.INDENT 2.0
.IP \(bu 2
068da8ad7d Merge branch \(aq2017.7\(aq into skip_diskusage
.IP \(bu 2
1a7ffb4e0d return error if diskusage not available
.IP \(bu 2
10bd63a976 Skip status.diskusage integration tests on macsox
.UNINDENT
.IP \(bu 2
2f50ff7bc8 Merge pull request \fI\%#47480\fP from baniobloom/ConflictingDomainExists
.INDENT 2.0
.IP \(bu 2
d22ed7dffa added handling for the aws error ConflictingDomainExists
.UNINDENT
.IP \(bu 2
7f53be6e92 Merge pull request \fI\%#47444\fP from terminalmage/render_state\-spurious\-error
.INDENT 2.0
.IP \(bu 2
a1e9fe00fd Skip trying to render a template for a nonexistent SLS file
.UNINDENT
.IP \(bu 2
50b9c4d79d Merge pull request \fI\%#47478\fP from terminalmage/rename\-pip\-state\-test
.INDENT 2.0
.IP \(bu 2
9f7a9ebebd Rename pip state test modules to match naming convention
.UNINDENT
.IP \(bu 2
e78ac0f9b7 Merge pull request \fI\%#47505\fP from dwoz/win_dsc_fixes
.INDENT 2.0
.IP \(bu 2
d1fcb40d1c Raise proper invocation errors
.UNINDENT
.IP \(bu 2
0d4d5047d8 Merge pull request \fI\%#47499\fP from dwoz/win_run_timeout_again
.INDENT 2.0
.IP \(bu 2
c6697b9f16 Move kill process tree and re\-use it
.UNINDENT
.IP \(bu 2
6a4d0380b1 Merge pull request \fI\%#47493\fP from dwoz/win_run_timeout
.IP \(bu 2
fec1233dc4 Add support for windows timeout to run_salt
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47565\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47440\fP to 2018.3
@ \fI2018\-05\-10 18:15:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47440\fP: (\fI\%kt97679\fP) fix for the race condition, details are here: \fI\%https://github.com/salt\fP… (refs: \fI\%#47565\fP)
.IP \(bu 2
b22657ff9e Merge pull request \fI\%#47565\fP from rallytime/bp\-47440
.IP \(bu 2
7c43417d46 addressed feedback
.IP \(bu 2
1abe05207c fix for the race condition, details are here: \fI\%https://github.com/saltstack/salt/issues/33223#issuecomment\-386117236\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47590\fP: (\fI\%Ch3LL\fP) Fix firewalld prune_services deprecation warning
@ \fI2018\-05\-10 17:01:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
17e0fdca6c Merge pull request \fI\%#47590\fP from Ch3LL/firewall_warn
.IP \(bu 2
d29b8e0ae2 Fix firewalld prune_services deprecation warning
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47568\fP: (\fI\%terminalmage\fP) salt.serializers.yaml/yamlex: remove invalid multi_constructor (refs: \fI\%#47598\fP)
@ \fI2018\-05\-10 16:21:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
2fcb108d71 Merge pull request \fI\%#47568\fP from terminalmage/salt\-jenkins\-971
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38671\fP: (\fI\%MikeSpaceG\fP) zpool.get error (refs: \fI\%#47224\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47563\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47224\fP to 2018.3
@ \fI2018\-05\-10 16:18:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47224\fP: (\fI\%sjorge\fP) Zpool zol fixes (refs: \fI\%#47563\fP)
.IP \(bu 2
e3ee7053fb Merge pull request \fI\%#47563\fP from rallytime/bp\-47224
.IP \(bu 2
1d191445a7 FIX \fI\%#38671\fP \- zpool.get should support older zfs version
.IP \(bu 2
23705b12cb zpool.scub docs should mention pause is not always available
.IP \(bu 2
d73885aa5c Make sure the docs mention that createboot is only available on illumos
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47569\fP: (\fI\%Ch3LL\fP) Update salt.utils.path mock in virtual core test
@ \fI2018\-05\-10 15:18:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
8e26624db3 Merge pull request \fI\%#47569\fP from Ch3LL/core_virt
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47576\fP: (\fI\%rallytime\fP) [2018.3] Small Documentation Fixes
@ \fI2018\-05\-10 14:08:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc93715eea Merge pull request \fI\%#47576\fP from rallytime/doc\-updates
.IP \(bu 2
ca927fc14b Add extra lines that are needed for proper code\-block formatting
.IP \(bu 2
b330d763a4 Remove infoblox state autodoc file
.UNINDENT
.UNINDENT
.SS Salt 2018.3.4 Release Notes
.sp
Version 2018.3.4 is a bugfix release for \fI\%2018.3.0\fP\&.
.SS State Changes
.INDENT 0.0
.IP \(bu 2
The \fI\%host.present\fP state can now remove
the specified hostname from IPs not specified in the state. This can be done
by setting the newly\-added \fBclean\fP argument to \fBTrue\fP\&.
.UNINDENT
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB531\fP
.IP \(bu 2
Total Issue References: \fB111\fP
.IP \(bu 2
Total PR References: \fB412\fP
.IP \(bu 2
Contributors: \fB76\fP (\fI\%5uper5hoot\fP, \fI\%Ch3LL\fP, \fI\%ClaudiuPID\fP, \fI\%Giandom\fP, \fI\%KaiSforza\fP,
\fI\%MTecknology\fP, \fI\%ManicoW\fP, \fI\%OrangeDog\fP, \fI\%ShantonRU\fP, \fI\%The\-Loeki\fP, \fI\%Yxnt\fP, \fI\%aarnaud\fP,
\fI\%amendlik\fP, \fI\%angeloudy\fP, \fI\%bartlaarhoven\fP, \fI\%bbh\-kmd\fP, \fI\%bbinet\fP, \fI\%bdrung\fP, \fI\%bergmannf\fP,
\fI\%bluesliverx\fP, \fI\%bornwitbugs\fP, \fI\%brejoc\fP, \fI\%cachedout\fP, \fI\%casselt\fP, \fI\%cro\fP, \fI\%cstarke\fP,
\fI\%dgmorrisjr\fP, \fI\%dmurphy18\fP, \fI\%dubb\-b\fP, \fI\%dwoz\fP, \fI\%frogunder\fP, \fI\%garethgreenaway\fP, \fI\%gtmanfred\fP,
\fI\%isbm\fP, \fI\%jacobweinstock\fP, \fI\%jgleissner\fP, \fI\%jodok\fP, \fI\%jpsv\fP, \fI\%jyurdal\fP, \fI\%kiemlicz\fP,
\fI\%kunal\-bajpai\fP, \fI\%lexvella\fP, \fI\%lomeroe\fP, \fI\%m03\fP, \fI\%madrisan\fP, \fI\%mat813\fP, \fI\%mattp\-\fP,
\fI\%max\-arnold\fP, \fI\%mchugh19\fP, \fI\%meaksh\fP, \fI\%michaelgibson\fP, \fI\%nhavens\fP, \fI\%pirogoeth\fP, \fI\%rallytime\fP,
\fI\%rkrieger\fP, \fI\%rmarcinik\fP, \fI\%rongzeng54\fP, \fI\%rwaweber\fP, \fI\%s0undt3ch\fP, \fI\%sathieu\fP, \fI\%sheagcraig\fP,
\fI\%silenius\fP, \fI\%sunyq\fP, \fI\%t0fik\fP, \fI\%terminalmage\fP, \fI\%terrible\-broom\fP, \fI\%thebluesnevrdie\fP,
\fI\%thetaurean\fP, \fI\%tlemarchand\fP, \fI\%tonybaloney\fP, \fI\%twangboy\fP, \fI\%waynew\fP, \fI\%weswhet\fP, \fI\%whytewolf\fP,
\fI\%yosnoop\fP, \fI\%zwo\-bot\fP)
.UNINDENT
.SS Changelog for v2018.3.3..v2018.3.4
.sp
\fIGenerated at: 2019\-02\-06 20:56:17 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#51525\fP: (\fI\%twangboy\fP) Backport 51095 to 2018.3.4
@ \fI2019\-02\-06 20:20:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
a37fb7d Merge pull request \fI\%#51525\fP from twangboy/backport_51095_2018.3.4
.IP \(bu 2
b6acc92 Backport 51095
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51520\fP: (\fI\%frogunder\fP) Update man pages for 2018.3.4
@ \fI2019\-02\-06 18:42:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
602ddc8 Merge pull request \fI\%#51520\fP from frogunder/man_pages
.IP \(bu 2
0cbe3f8 Update man pages for 2018.3.4
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51428\fP: (\fI\%yosnoop\fP) salt.utils.dns.lookup fails with dig method on EL7 (refs: \fI\%#51429\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51429\fP: (\fI\%yosnoop\fP) The +nocl is supported much wider than +noclass
@ \fI2019\-02\-06 17:48:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f981c6 Merge pull request \fI\%#51429\fP from yosnoop/replace\-noclass\-with\-nocl\-for\-dig
.IP \(bu 2
5231e73 Merge branch \(aq2018.3.4\(aq into replace\-noclass\-with\-nocl\-for\-dig
.IP \(bu 2
14e6fb7 In case the test machine can\(aqt resolve
.IP \(bu 2
95e8a2f The +nocl is supported much wider than +noclass
.IP \(bu 2
a00d708 Test dig options for salt.utils.dns.lookup
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49226\fP: (\fI\%defanator\fP) salt\-cloud grains inheritance from provider to profile (2018 vs 2016) (refs: \fI\%#51366\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51441\fP: (\fI\%Ch3LL\fP) Backport \fI\%#51366\fP into 2018.3.4
@ \fI2019\-02\-06 17:42:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51366\fP: (\fI\%dwoz\fP) Cloud provider and profile configs are merged [2018.3] (refs: \fI\%#51441\fP)
.IP \(bu 2
209ef32 Merge pull request \fI\%#51441\fP from Ch3LL/bp\-51366
.IP \(bu 2
5bc466e Fix python 3 path for shell test cases
.IP \(bu 2
5351e5c Add testing path to run_script commands
.IP \(bu 2
2d8a364 Fix linter issues
.IP \(bu 2
9b8718a Cloud provider and profile configs are merged
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51458\fP: (\fI\%twangboy\fP) Add Py2 Warning for Py2 Installer
@ \fI2019\-02\-06 17:33:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
90a8682 Merge pull request \fI\%#51458\fP from twangboy/add_py2_warning
.IP \(bu 2
05522c0 Merge branch \(aq2018.3.4\(aq into add_py2_warning
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51460\fP: (\fI\%twangboy\fP) Update installer mac 2018.3.4
@ \fI2019\-02\-06 17:31:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
b492021 Merge pull request \fI\%#51460\fP from twangboy/update_installer_mac_2018.3.4
.IP \(bu 2
3c92688 Merge branch \(aq2018.3.4\(aq into update_installer_mac_2018.3.4
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51471\fP: (\fI\%twangboy\fP) Fix the failing dns test on Windows
@ \fI2019\-02\-03 22:03:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
892d98c Merge pull request \fI\%#51471\fP from twangboy/fix_test_win_dns_client
.IP \(bu 2
c9f6b01 Merge branch \(aq2018.3.4\(aq into fix_test_win_dns_client
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51462\fP: (\fI\%ShantonRU\fP) Fix insecure SQL queries in MySQL module
@ \fI2019\-02\-01 21:19:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
a05305d Merge pull request \fI\%#51462\fP from ShantonRU/fix\-insecure\-sql\-queries\-in\-mysql\-module\-1
.IP \(bu 2
d3ef2cb Merge branch \(aq2018.3.4\(aq into fix\-insecure\-sql\-queries\-in\-mysql\-module\-1
.IP \(bu 2
f47dda6 Fix improper use of socket authentication in mysql.user_chpass
.IP \(bu 2
ed62a2f Fix insecure SQL queries in mysql.user_chpass
.INDENT 2.0
.IP \(bu 2
33922c9 Fix the failing dns test on Windows
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51445\fP: (\fI\%terminalmage\fP) Remove custom grains module from 2018.3 branch
@ \fI2019\-02\-01 16:48:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
48936c2 Merge pull request \fI\%#51445\fP from terminalmage/fix\-custom\-grains\-traceback
.IP \(bu 2
191235d Remove custom grains module from 2018.3 branch
.IP \(bu 2
72fd1a2 Roll back icon change
.IP \(bu 2
7dd1704 Add welcome_py2.rtf
.IP \(bu 2
c93e9e3 Add Py2 Warning to installer package
.IP \(bu 2
b658900 Add Py2 Warning for Py2 Installer
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51438\fP: (\fI\%twangboy\fP) Add missing raise statement
@ \fI2019\-01\-30 20:04:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
a880e42 Merge pull request \fI\%#51438\fP from twangboy/fix_raise_2018.3.4
.IP \(bu 2
5830fad Add missing raise statement
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51432\fP: (\fI\%Ch3LL\fP) Backport \fI\%#51324\fP into 2018.3.4
@ \fI2019\-01\-30 17:51:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51324\fP: (\fI\%garethgreenaway\fP)  [2018.3] Fixes to x509 module and test (refs: \fI\%#51432\fP)
.IP \(bu 2
28b898c Merge pull request \fI\%#51432\fP from Ch3LL/bp\-51324
.IP \(bu 2
bd41ff0 Fixing various bits in x509 module and unit test to ensure tests are passing on python2 & python3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51377\fP: (\fI\%twangboy\fP) Fix issue when directory doesn\(aqt exist in LGPO module (2018.3.4)
@ \fI2019\-01\-29 17:33:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
01717d2 Merge pull request \fI\%#51377\fP from twangboy/fix_auditpol_2018.3.4
.IP \(bu 2
19e5181 Fix issue when directory doesn\(aqt exist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51338\fP: (\fI\%Ch3LL\fP) Backport \fI\%#51207\fP into 2018.3.4
@ \fI2019\-01\-27 23:44:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51207\fP: (\fI\%twangboy\fP) Backport 50771 to 2018.3 (refs: \fI\%#51338\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50771\fP: (\fI\%terminalmage\fP) Fix failing opensuse tests (refs: \fI\%#51207\fP)
.IP \(bu 2
43a9d2f Merge pull request \fI\%#51338\fP from Ch3LL/bp\-51207
.IP \(bu 2
345ae67 Backport PR# 50771 to 2018.3 branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51158\fP: (\fI\%AndreiPashkin\fP) saltmod.state doesn\(aqt respect \(dqroster\(dq argument (refs: \fI\%#51170\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51337\fP: (\fI\%Ch3LL\fP) Backport \fI\%#51170\fP into 2018.3.4
@ \fI2019\-01\-27 23:44:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51170\fP: (\fI\%dwoz\fP) Honor roster system for ssh orchestrations (refs: \fI\%#51337\fP)
.IP \(bu 2
3dcd11d Merge pull request \fI\%#51337\fP from Ch3LL/bp\-51170
.IP \(bu 2
4e85505 Merge branch \(aq2018.3.4\(aq into bp\-51170
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50221\fP: (\fI\%tkaehn\fP) file.managed: contents_pillar and pillar.file_tree with keep_newline is broken in 2018.3.3 (refs: \fI\%#51252\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51340\fP: (\fI\%Ch3LL\fP) Backport \fI\%#51252\fP into 2018.3.4
@ \fI2019\-01\-27 23:42:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51252\fP: (\fI\%dwoz\fP) Peserve newlines from pillar data for file.managed [2018.3] (refs: \fI\%#51340\fP)
.IP \(bu 2
7656aa5 Merge pull request \fI\%#51340\fP from Ch3LL/bp\-51252
.IP \(bu 2
e74a6c6 Fix py3 managed.file test failure
.IP \(bu 2
6f2c7cf Remoe un\-needed log statement
.IP \(bu 2
824950c Fix 50221 regression test on Windows
.IP \(bu 2
1840af9 peserve newlines from pillar data for file.managed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51290\fP: (\fI\%s0undt3ch\fP) [2018.3.4] Fix minion start
@ \fI2019\-01\-25 15:14:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
e90ca1d Merge pull request \fI\%#51290\fP from s0undt3ch/hotfix/fix\-network
.IP \(bu 2
da3aace Merge branch \(aq2018.3.4\(aq into hotfix/fix\-network
.IP \(bu 2
04f16b8 Fix tests. We no longer get \fIipaddress\fP instances back.
.IP \(bu 2
c3fa82a Fix minion start issue
.INDENT 2.0
.IP \(bu 2
c893dc4 Fix saltmod roster test
.IP \(bu 2
b61854f Roster defines the roster system not a file
.IP \(bu 2
484bab4 Fix linter
.IP \(bu 2
5e2db2f Honor roster file for ssh orchestrations
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51317\fP: (\fI\%terminalmage\fP) Fix regression in dynamic pillarenv
@ \fI2019\-01\-25 09:29:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
c8db7e3 Merge pull request \fI\%#51317\fP from terminalmage/fix\-pr\-50417
.IP \(bu 2
4be2891 Merge branch \(aq2018.3.4\(aq into fix\-pr\-50417
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51311\fP: (\fI\%twangboy\fP) Fix failing test \fIunit.states.test_file.TestFileState.test_managed\fP on Windows
@ \fI2019\-01\-24 21:09:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
e246fdb Merge pull request \fI\%#51311\fP from twangboy/fix_test_file.test_managed
.IP \(bu 2
f4177e0 Remove mode parameter on Windows
.IP \(bu 2
4c4ded3 Fix regression in dynamic pillarenv
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51195\fP: (\fI\%littleski\fP) fstab improperly escaped when spaces are used in options (refs: \fI\%#51226\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27160\fP: (\fI\%martinadolfi\fP) salt.states.mount persistence error using spaces in route (refs: \fI\%#39593\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51292\fP: (\fI\%Ch3LL\fP) Backport \fI\%#51226\fP into 2018.3.4
@ \fI2019\-01\-24 11:11:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51226\fP: (\fI\%garethgreenaway\fP) [2018.3] Handle spaces in fstab opts, similar fix to \fI\%#39593\fP (refs: \fI\%#51292\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39593\fP: (\fI\%zwo\-bot\fP) Fix issue \fI\%#27160\fP \- escape whitespaces in fstab entry in module mount when persist=True (refs: \fI\%#51226\fP)
.IP \(bu 2
40b20126 Merge pull request \fI\%#51292\fP from Ch3LL/bp\-51226
.IP \(bu 2
aba114e Merge branch \(aq2018.3.4\(aq into bp\-51226
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51295\fP: (\fI\%Ch3LL\fP) Backport \fI\%#51279\fP into 2018.3.4
@ \fI2019\-01\-24 11:10:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51279\fP: (\fI\%twangboy\fP) Backport __context__ support from develop (refs: \fI\%#51295\fP)
.IP \(bu 2
fc0bec5 Merge pull request \fI\%#51295\fP from Ch3LL/bp\-51279
.IP \(bu 2
5c4a7a4 Merge branch \(aq2018.3.4\(aq into bp\-51279
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51293\fP: (\fI\%Ch3LL\fP) Backport \fI\%#51233\fP into 2018.3.4
@ \fI2019\-01\-24 09:17:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51233\fP: (\fI\%Ch3LL\fP) Backport \fI\%#51105\fP to 2018.3 (refs: \fI\%#51293\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51105\fP: (\fI\%garethgreenaway\fP) [develop] Report permission changes in test mode (refs: \fI\%#51233\fP)
.IP \(bu 2
dacd1ea Merge pull request \fI\%#51293\fP from Ch3LL/bp\-51233\-2
.IP \(bu 2
a155fd7 Accounting for when permissions are not returned from file.check_perms, eg. windows systems.
.IP \(bu 2
53ba068 When test=True and there are permissions changes, report it.
.IP \(bu 2
d2eba77 Remove network.py patch
.IP \(bu 2
d431c71 Add __context__ support
.INDENT 2.0
.IP \(bu 2
de6c13d Handle spaces in fstab opts, similar fix to \fI\%#39593\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51248\fP: (\fI\%johnnybubonic\fP) \(dq[WARNING ] The file_roots parameter is not properly formatted, using defaults\(dq (refs: \fI\%#51278\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51278\fP: (\fI\%dwoz\fP) Warn about proper validation option
@ \fI2019\-01\-22 22:13:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
1abffb2 Merge pull request \fI\%#51278\fP from dwoz/issue51248
.IP \(bu 2
c614198 Use pillar roots validation method
.IP \(bu 2
0d2b0c6 Fix linter warnings
.IP \(bu 2
5b98895 Fix wart in pillar_roots validation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51230\fP: (\fI\%Ch3LL\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2019\-01\-18 19:50:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
e53e9b1 Merge pull request \fI\%#51230\fP from Ch3LL/merge\-2018.3
.IP \(bu 2
0ef7675 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
4a12c5f Merge pull request \fI\%#50852\fP from mirceaulinic/fix\-capirca
.INDENT 2.0
.IP \(bu 2
fa91267 Merge branch \(aq2017.7\(aq into fix\-capirca
.IP \(bu 2
71913ff Merge branch \(aq2017.7\(aq into fix\-capirca
.IP \(bu 2
6fc3484 Lint?
.IP \(bu 2
3d56750 Extra newline for lint
.IP \(bu 2
5176cd8 Improve the Capirca and related modules for ACL config generation
.UNINDENT
.IP \(bu 2
3f4759b Merge pull request \fI\%#50923\fP from astronouth7303/patch\-2
.INDENT 2.0
.IP \(bu 2
4f631a6 Document {% include %}
.UNINDENT
.IP \(bu 2
210e817 Merge pull request \fI\%#51111\fP from s0undt3ch/2017.7
.INDENT 2.0
.IP \(bu 2
08e0ae7 Update to salt\-bootstrap v2019.01.08
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51211\fP: (\fI\%sathieu\fP) file_roots envs with slash leads to \(dqNo such file or directory: \(aq/var/cache/salt/master/file_lists/roots/.foo/bar.w\(aq (refs: \fI\%#51212\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#48132\fP: (\fI\%BenjaminSchiborr\fP) Dynamic File Roots (refs: \fI\%#51212\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51212\fP: (\fI\%sathieu\fP) Allow slashes in file_roots envs.
@ \fI2019\-01\-17 17:29:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
26008ef Merge pull request \fI\%#51212\fP from sathieu/file_roots_slash
.IP \(bu 2
b769f18 Allow slash in file_roots envs
.IP \(bu 2
f9437e2 Test for file_roots envs with slash leads to \(dqNo such file or directory\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51209\fP: (\fI\%garethgreenaway\fP) [2018.3] Back\-port PR \fI\%#51124\fP to 2018.3
@ \fI2019\-01\-17 13:28:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51124\fP: (\fI\%Ch3LL\fP) Handle encoding when opening file for both py2/py3 (refs: \fI\%#51209\fP)
.IP \(bu 2
5916282 Merge pull request \fI\%#51209\fP from garethgreenaway/bp\-51124
.IP \(bu 2
82acce4 Handle encoding when opening file for both py2/py3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51184\fP: (\fI\%twangboy\fP) Fix win_lgpo_auditpol salt util on Windows
@ \fI2019\-01\-16 18:08:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
094bd33 Merge pull request \fI\%#51184\fP from twangboy/fix_auditpol
.IP \(bu 2
2e68d35 directly call cmd.run_all
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51191\fP: (\fI\%Ch3LL\fP) Backport \fI\%#50918\fP into 2018.3
@ \fI2019\-01\-16 18:02:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50918\fP: (\fI\%twangboy\fP) Fix \fItest_debian_ip\fP on Windows (refs: \fI\%#51191\fP)
.IP \(bu 2
ac71922 Merge pull request \fI\%#51191\fP from Ch3LL/bp\-50918
.IP \(bu 2
7300d84 Skip debian tests on Windows
.IP \(bu 2
4622433 Fix \fItest_debian_ip\fP on Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49883\fP: (\fI\%kiemlicz\fP) salt\-cloud azurearm is not working (refs: \fI\%#51144\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51144\fP: (\fI\%jgleissner\fP) 2018.3 azurearm py3
@ \fI2019\-01\-15 16:46:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
e7f53a3 Merge pull request \fI\%#51144\fP from jgleissner/2018.3\-azurearm\-py3
.IP \(bu 2
3178f1a msazure.py: remove unused imports
.IP \(bu 2
99a4b9d azurearm: fix list_locations
.IP \(bu 2
aebe34b azurearm: fix show_instance function
.IP \(bu 2
d80669f msazure: fix object_to_dict for python 3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51171\fP: (\fI\%twangboy\fP) Add random sleep time to avoid overloading Windows
@ \fI2019\-01\-15 16:45:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
1206f92 Merge pull request \fI\%#51171\fP from twangboy/fix_crypt
.IP \(bu 2
6caa93b Add random sleep time to avoid overloading Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51174\fP: (\fI\%jpsv\fP) Update OpsGenie to use their V2 API (2018.3)
@ \fI2019\-01\-15 16:44:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
a96deed Merge pull request \fI\%#51174\fP from jpsv/2018.3
.IP \(bu 2
055823e Update opsgenie.py
.IP \(bu 2
501c8df Merge branch \(aq2018.3\(aq into 2018.3
.IP \(bu 2
220aa8a Update opsgenie.py
.IP \(bu 2
5dc21cc Update to from V1 API to V2
.IP \(bu 2
f93ce7c Update to V2 API
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42280\fP: (\fI\%michaelgibson\fP) make ldap eauth 2 factor compatible (refs: \fI\%#42426\fP, \fI\%#45347\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51010\fP: (\fI\%amendlik\fP) Allow unauthenticated bind for listing LDAP groups
@ \fI2019\-01\-15 16:43:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45811\fP: (\fI\%gtmanfred\fP) Fix ldap eauth (refs: \fI\%#51010\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45347\fP: (\fI\%amendlik\fP) LDAP group membership (refs: \fI\%#51010\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42426\fP: (\fI\%michaelgibson\fP) adding 2\-factor auth capability to ldap eauth module \- \fI\%#42280\fP (refs: \fI\%#45347\fP)
.IP \(bu 2
563d487 Merge pull request \fI\%#51010\fP from amendlik/ldap\-groups
.IP \(bu 2
cd336ed Merge branch \(aq2018.3\(aq into ldap\-groups
.IP \(bu 2
94f8ee4 Update unit tests for auth.ldap
.IP \(bu 2
08e36d0 Allow unauthenticated bind for listing LDAP groups
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51112\fP: (\fI\%s0undt3ch\fP)  [2018.3] Update to salt\-bootstrap v2019.01.08
@ \fI2019\-01\-15 16:42:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
6dc3752 Merge pull request \fI\%#51112\fP from s0undt3ch/2018.3
.IP \(bu 2
4f1d846 Update to salt\-bootstrap v2019.01.08
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51097\fP: (\fI\%terminalmage\fP) Fix improper exception raises (2018.3)
@ \fI2019\-01\-15 16:38:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
b19c990 Merge pull request \fI\%#51097\fP from terminalmage/fix\-keyerror\-raise
.IP \(bu 2
a3c0b49 Fix poorly\-written test
.IP \(bu 2
c0ff7b1 Fix more incorrect exception raises
.IP \(bu 2
f11dbcc Fix improper KeyError raise
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51169\fP: (\fI\%twangboy\fP) More descriptive error when missing GitPython or PyGit2
@ \fI2019\-01\-15 16:37:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
8920a86 Merge pull request \fI\%#51169\fP from twangboy/fix_git_state
.IP \(bu 2
f2d1180 More descriptive error when missing GitPython or PyGit2
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51160\fP: (\fI\%amendlik\fP) Minion crashes with long hostname under Python 3 (refs: \fI\%#51173\fP, \fI\%#51161\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51173\fP: (\fI\%dwoz\fP) Avoid exceptions by passing bytes to idna
@ \fI2019\-01\-15 16:32:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51161\fP: (\fI\%amendlik\fP) Ignore exceptions when generating the minion ID (refs: \fI\%#51173\fP)
.IP \(bu 2
58eede6 Merge pull request \fI\%#51173\fP from dwoz/issue51160
.IP \(bu 2
11cc7b3 Remove un\-needed test
.IP \(bu 2
0f87812 Merge develop, Revert exception handling
.IP \(bu 2
7365a1a Pass bytes to idna
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51147\fP: (\fI\%Ch3LL\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2019\-01\-15 02:05:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
06854cf Merge pull request \fI\%#51147\fP from Ch3LL/merge\-2018.3
.IP \(bu 2
d39d8b7 Merge branch \(aq2018.3\(aq into merge\-2018.3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51160\fP: (\fI\%amendlik\fP) Minion crashes with long hostname under Python 3 (refs: \fI\%#51173\fP, \fI\%#51161\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51161\fP: (\fI\%amendlik\fP) Ignore exceptions when generating the minion ID (refs: \fI\%#51173\fP)
@ \fI2019\-01\-14 22:47:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
b79c09e Merge pull request \fI\%#51161\fP from amendlik/long\-hostname
.IP \(bu 2
6fcc4ad Merge branch \(aq2018.3\(aq into long\-hostname
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#51067\fP: (\fI\%rkrieger\fP) KeyError u\(aqmanufacturer\(aq causes salt\-minion crash on start with OpenBSD arm64 system (refs: \fI\%#51159\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#3\fP: (\fI\%thatch45\fP) libvirt module (refs: \fI\%#51159\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51159\fP: (\fI\%rkrieger\fP) Prevent crash by testing for \(aqmanufacturer\(aq in osdata on OpenBSD
@ \fI2019\-01\-14 18:08:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
1424734 Merge pull request \fI\%#51159\fP from rkrieger/fix\-issue\-51067
.IP \(bu 2
1440ccf Prevent crash by testing for \(aqmanufacturer\(aq in osdata on OpenBSD
.IP \(bu 2
1a4e307 Ignore exceptions when generating the minion ID
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51146\fP: (\fI\%terminalmage\fP) Fix invalid assignment in vsphere module
@ \fI2019\-01\-12 21:44:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
5e37326 Merge pull request \fI\%#51146\fP from terminalmage/fix\-vsphere\-tuple\-issue
.IP \(bu 2
5d60022 Fix invalid assignment in vsphere module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51154\fP: (\fI\%twangboy\fP) Add support for Advanced Audit policies
@ \fI2019\-01\-12 21:43:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
fad8621 Merge pull request \fI\%#51154\fP from twangboy/auditpol
.IP \(bu 2
9064376 Add support for Advanced Audit policies
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51151\fP: (\fI\%Ch3LL\fP) Backport \fI\%#51061\fP to 2018.3
@ \fI2019\-01\-12 03:18:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51061\fP: (\fI\%garethgreenaway\fP) [fluorine] fix to salt.utils.vt.Terminal (refs: \fI\%#51151\fP)
.IP \(bu 2
f7a100c Merge pull request \fI\%#51151\fP from Ch3LL/bp_51061
.IP \(bu 2
ffdae27 When writing output to stdout we want to ensure that the data is a string not bytes.
Under py2 the salt.utils.data.encode function results in a string but under py3 the result is a
bytestring. Swapping out salt.utils.data.encode for salt.utils.stringutils.to_str.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51150\fP: (\fI\%Ch3LL\fP) Back\-port \fI\%#49508\fP to 2018.3
@ \fI2019\-01\-12 03:18:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49508\fP: (\fI\%bergmannf\fP) Fix X509 remote signing on python3 (refs: \fI\%#51150\fP)
.IP \(bu 2
3a50a57 Merge pull request \fI\%#51150\fP from Ch3LL/bp\-49508
.IP \(bu 2
7ae53ad Do not silently ignore errors.
.IP \(bu 2
deb0134 Convert to string before sending via \(aqpublish\(aq.
.IP \(bu 2
651c551 Use to_str salt.utils when writing to a file.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50433\fP: (\fI\%zerthimon\fP) Wildcard grant fails in mysql_grants.present in mysql 8.x (refs: \fI\%#51152\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51152\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to mysql module to handle ALL PRIVILEGES grant
@ \fI2019\-01\-12 03:17:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
8bb589d Merge pull request \fI\%#51152\fP from garethgreenaway/50433_handle_grants_better
.IP \(bu 2
f7caa4d Fixing lint
.IP \(bu 2
e8c8c0f Adding some tests to ensure \(dqALL PRIVILEGES\(dq is handled correctly in 8.0 and 5.6
.IP \(bu 2
b4bfd9f Add additional grants.  Adding logic to handle when ALL or ALL PRIVILEGES is passed for
the grant, including some logic to handle the fact that the grants are split when show grants
is run for a particular user.
.INDENT 2.0
.IP \(bu 2
74edfd9 Fix pylint
.IP \(bu 2
81a3d47 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
8a76a19 Merge pull request \fI\%#50858\fP from jasonarewhy/bugfix\-2017.7/ubuntu\-networking\-searchdomain
.INDENT 2.0
.IP \(bu 2
3395a3d Merge branch \(aq2017.7\(aq into bugfix\-2017.7/ubuntu\-networking\-searchdomain
.IP \(bu 2
69d25aa update debian_ip test
.IP \(bu 2
a6b896c get searchdomain in Ubuntu 12+
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50849\fP: (\fI\%5uper5hoot\fP) MySQL version needs to be decoded (refs: \fI\%#51133\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51133\fP: (\fI\%5uper5hoot\fP) Fixes mysql server version comparison.
@ \fI2019\-01\-10 16:45:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
dda1ebb Merge pull request \fI\%#51133\fP from 5uper5hoot/issue\-\fI\%#50849\fP
.IP \(bu 2
ec14e13 Fixes mysql server version comparison.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50878\fP: (\fI\%max\-arnold\fP) Fix profile outputter docs
@ \fI2019\-01\-08 18:32:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d4321d Merge pull request \fI\%#50878\fP from max\-arnold/output\-docs
.IP \(bu 2
d7403da Fix profile outputter docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51076\fP: (\fI\%OrangeDog\fP) Typos in index_template_present documentation
@ \fI2019\-01\-08 18:25:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce87504 Merge pull request \fI\%#51076\fP from OrangeDog/patch\-1
.IP \(bu 2
568e4fb Revert add \-> check
.IP \(bu 2
4d7ebe7 Typos in index_template_present documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51081\fP: (\fI\%garethgreenaway\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2019\-01\-07 20:34:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
d08abf4 Merge pull request \fI\%#51081\fP from garethgreenaway/merge\-2018.3
.IP \(bu 2
027804a Merge branch \(aq2018.3\(aq into merge\-2018.3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50966\fP: (\fI\%klafkoff\fP) 2018.3.3 missing a patch to salt/modules/nxos.py (refs: \fI\%#51080\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51080\fP: (\fI\%garethgreenaway\fP) [2018.3] Fix to nxos module
@ \fI2019\-01\-07 18:07:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
335088b Merge pull request \fI\%#51080\fP from garethgreenaway/50966_nxos_ensure_kwargs_list
.IP \(bu 2
230a66b Merge branch \(aq2018.3\(aq into 50966_nxos_ensure_kwargs_list
.IP \(bu 2
629dc25 Ensure kwargs is a list before we attempt to loop through.  Similar fix to \fI\%https://github.com/rallytime/salt/commit/430c462f34eb4eedf2384e06fbee8dc19b8026f6\fP in the proxy module.
.INDENT 2.0
.IP \(bu 2
a20791b Merge branch \(aq2018.3\(aq into merge\-2018.3
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51079\fP: (\fI\%terminalmage\fP) Fix shadow.set_date/shadow.set_expire on F28
@ \fI2019\-01\-07 16:28:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
c47b646 Merge pull request \fI\%#51079\fP from terminalmage/salt\-jenkins\-1238
.IP \(bu 2
ccd5c15 Fix shadow.set_date/shadow.set_expire on F28
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47043\fP: (\fI\%xBytez\fP) lsattr slowing down archive.extracted (refs: \fI\%#51044\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51044\fP: (\fI\%terminalmage\fP) archive.extracted: Don\(aqt run lsattr when enforcing user/group ownership
@ \fI2019\-01\-03 19:26:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
aeeb047 Merge pull request \fI\%#51044\fP from terminalmage/issue47043
.IP \(bu 2
787b79a archive.extracted: Don\(aqt run lsattr when enforcing user/group ownership
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50964\fP: (\fI\%gtmanfred\fP) Add a long description to setup.py for the new pypi.org (refs: \fI\%#51031\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51034\fP: (\fI\%garethgreenaway\fP) Back\-port PR \fI\%#51031\fP to 2018.3
@ \fI2019\-01\-03 15:42:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#51031\fP: (\fI\%waynew\fP) Set long_description (refs: \fI\%#51034\fP)
.IP \(bu 2
04fdae5 Merge pull request \fI\%#51034\fP from garethgreenaway/bp\-51031
.IP \(bu 2
cd310c2 Set long_description
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50634\fP: (\fI\%marek\-obuchowicz\fP) Debian pkg.managed gpg/tty issue (refs: \fI\%#50972\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50972\fP: (\fI\%pirogoeth\fP) Use gpg\(aqs \-\-batch in apt\-key adv during repo key add
@ \fI2019\-01\-03 02:34:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
4685e0e Merge pull request \fI\%#50972\fP from pirogoeth/sjohn/2018.3\-apt\-key\-batch
.IP \(bu 2
cd3d755 Merge branch \(aq2018.3\(aq into sjohn/2018.3\-apt\-key\-batch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51028\fP: (\fI\%whytewolf\fP) AIX lsattr fix for file module.
@ \fI2019\-01\-03 01:52:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
44bc862 Merge pull request \fI\%#51028\fP from whytewolf/aix_lsattr_fix
.IP \(bu 2
1b733c6 Set lsattr functions to return None if \fIsalt.utils.platform.is_aix\fP returns true.
.IP \(bu 2
7410008 Merge branch \(aq2018.3\(aq into sjohn/2018.3\-apt\-key\-batch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51018\fP: (\fI\%garethgreenaway\fP) [fluorine] Merge forward from 2017.7 to 2018.3
@ \fI2019\-01\-01 23:11:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
b4774a8 Merge pull request \fI\%#51018\fP from garethgreenaway/merge\-2018.3
.INDENT 2.0
.IP \(bu 2
773bf31 Use gpg\(aqs \-\-batch in apt\-key adv during repo key add
.INDENT 2.0
.IP \(bu 2
9386aab Merge branch \(aq2017.7\(aq into merge\-2018.3
.IP \(bu 2
998feca Merge pull request \fI\%#51030\fP from terminalmage/issue38502
.INDENT 2.0
.IP \(bu 2
6dbd81f Add unit test to ensure we don\(aqt diff bare repos
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
12f7583 Merge branch \(aq2017.7\(aq into merge\-2018.3
.IP \(bu 2
4529150 Merge pull request \fI\%#50977\fP from rallytime/config\-docs
.INDENT 2.0
.IP \(bu 2
43c39e7 Add documentation to master config docs for job_cache_store_endtime
.IP \(bu 2
887cd07 Add some salt\-api options to the master config docs
.IP \(bu 2
0d49746 Fix some formatting in master config docs
.UNINDENT
.IP \(bu 2
409594b Merge pull request \fI\%#50991\fP from twangboy/requests_2017.7
.INDENT 2.0
.IP \(bu 2
32b9d2a Update requests for osx
.IP \(bu 2
413dc72 Merge branch \(aq2017.7\(aq of \fI\%https://github.com/saltstack/salt\fP into requests_2017.7
.UNINDENT
.IP \(bu 2
e053074 Merge pull request \fI\%#50983\fP from garethgreenaway/bp\-50885
.INDENT 2.0
.IP \(bu 2
09a8e6e fix a del in cloud vmware that crash when the key isn\(aqt there
.IP \(bu 2
4196690 Update requests to 2.21.0
.IP \(bu 2
23f78b0 Upgrade requests to 2.20.1
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50990\fP: (\fI\%twangboy\fP) Requests 2018.3
@ \fI2018\-12\-31 20:19:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
c53723a Merge pull request \fI\%#50990\fP from twangboy/requests_2018.3
.IP \(bu 2
e8b9233 Update requests on osx
.IP \(bu 2
b22856f Update requests to 2.21.0
.IP \(bu 2
242389b Merge branch \(aq2018.3\(aq of \fI\%https://github.com/saltstack/salt\fP into requests_2018.3
.IP \(bu 2
0d4b799 Upgrade requests to 2.20.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51004\fP: (\fI\%twangboy\fP) Add tests for the win_wusa state and module
@ \fI2018\-12\-31 20:03:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
cecd108 Merge pull request \fI\%#51004\fP from twangboy/win_wusa
.IP \(bu 2
0e92528 Merge branch \(aq2018.3\(aq into win_wusa
.IP \(bu 2
c0d2495 Fix lint, add test docs
.IP \(bu 2
1750270 Add state tests for win_wusa
.IP \(bu 2
6285b64 Update win_wusa and add tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#51014\fP: (\fI\%madrisan\fP) ssh module: missing space in error message
@ \fI2018\-12\-31 19:59:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e0515b Merge pull request \fI\%#51014\fP from madrisan/patch\-1
.IP \(bu 2
ab980fb ssh module: missing space in error message
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50883\fP: (\fI\%terminalmage\fP) Backport \fI\%#49622\fP to 2018.3 branch
@ \fI2018\-12\-31 19:58:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49622\fP: (\fI\%angeloudy\fP) fix command line options (refs: \fI\%#50883\fP)
.IP \(bu 2
582d6b4 Merge pull request \fI\%#50883\fP from terminalmage/bp\-49622
.IP \(bu 2
c93dbfa Update archive.py
.IP \(bu 2
925a9c9 Update archive.py
.IP \(bu 2
ed2bed3 fix command line options
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50945\fP: (\fI\%garethgreenaway\fP)  [2018.3] Merge forward from 2017.7 to 2018.8
@ \fI2018\-12\-30 00:05:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd9711b Merge pull request \fI\%#50945\fP from garethgreenaway/merge\-2017.7
.IP \(bu 2
43b3fa4 Merge branch \(aq2018.3\(aq into merge\-2017.7
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50854\fP: (\fI\%Ch3LL\fP) [fluorine] windows stops when cannot connect to master (refs: \fI\%#50855\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51006\fP: (\fI\%dwoz\fP) Let minions try to connect to master indefinitly
@ \fI2018\-12\-28 21:10:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50855\fP: (\fI\%dwoz\fP) Let minions try to connect to master indefinitly (refs: \fI\%#51006\fP)
.IP \(bu 2
b8615e1 Merge pull request \fI\%#51006\fP from dwoz/backport_50855
.IP \(bu 2
5563631 Let minions try to connect to master indefinitly
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50989\fP: (\fI\%mpx8701\fP) SLS error (An exception occurred in this state: Traceback) (refs: \fI\%#51005\fP)
.IP \(bu 2
\fBPR\fP \fI\%#51005\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to junos state module
@ \fI2018\-12\-28 20:51:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
cfed697 Merge pull request \fI\%#51005\fP from garethgreenaway/50989_fixing_junos_state_arguments
.IP \(bu 2
d4ac180 Fixing the arguments accepted by cli function in the junos state module which are passed along to the cli function in junos module, so they align.
.IP \(bu 2
3cfca8e Merge branch \(aq2018.3\(aq into merge\-2017.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50982\fP: (\fI\%twangboy\fP) Fix issue with LGPO when returning empty dict (2018.3)
@ \fI2018\-12\-26 19:58:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
daa591b Merge pull request \fI\%#50982\fP from twangboy/fix_lgpo_2018.3
.IP \(bu 2
d942934 Get rid of requests import (CaseInsensitiveDict)
.INDENT 2.0
.IP \(bu 2
6170fa5 Merge branch \(aq2018.3\(aq into merge\-2017.7
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46886\fP: (\fI\%bbh\-kmd\fP) Unable to get salt\-minion to call salt\-call with alternate configuration (refs: \fI\%#50959\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50984\fP: (\fI\%garethgreenaway\fP) Back\-port PR \fI\%#50959\fP to 2018.3
@ \fI2018\-12\-26 19:29:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50959\fP: (\fI\%bbh\-kmd\fP) \fI\%#46886\fP: Use correct path to config_dir when running salt from alternate placement. (refs: \fI\%#50984\fP)
.IP \(bu 2
110bc66 Merge pull request \fI\%#50984\fP from garethgreenaway/bp\-50959
.IP \(bu 2
20fa5c9 Update sudo.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50958\fP: (\fI\%bdrung\fP) Fix twilio version checking
@ \fI2018\-12\-25 10:46:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
8fc89a0 Merge pull request \fI\%#50958\fP from bdrung/fix\-twilio
.IP \(bu 2
df8d7b9 Fix twilio version checking
.INDENT 2.0
.IP \(bu 2
d89c9b5 Merge branch \(aq2018.3\(aq into merge\-2017.7
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50947\fP: (\fI\%cachedout\fP) Log full of IPv6 warnings (refs: \fI\%#50962\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50962\fP: (\fI\%terminalmage\fP) Remove redundant overrides for ip_address/ip_interface
@ \fI2018\-12\-21 22:04:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb87822 Merge pull request \fI\%#50962\fP from terminalmage/ipv6\-warnings
.IP \(bu 2
773b983 Merge branch \(aq2018.3\(aq into ipv6\-warnings
.IP \(bu 2
f3b1254 Remove redundant overrides for ip_address/ip_interface
.INDENT 2.0
.IP \(bu 2
cea01e7 Updating valigdate_tgt to ensure tests pass.
.IP \(bu 2
cdc7825 yet another lint fix.
.IP \(bu 2
f44a87e One last lint fix.
.IP \(bu 2
45f363b Fixing various lint errors.
.IP \(bu 2
6a65bf9 Merge branch \(aq2017.7\(aq into merge\-2017.7
.IP \(bu 2
747dd69 Merge pull request \fI\%#50876\fP from terminalmage/issue50153
.INDENT 2.0
.IP \(bu 2
676a12a Fix compound matching in eauth
.UNINDENT
.IP \(bu 2
07fca64 Merge pull request \fI\%#50909\fP from damon\-atkins/jenkins_pylint
.INDENT 2.0
.IP \(bu 2
da1fc32 change params.CHANGE_BRANCH to env.CHANGE_BRANCH
.UNINDENT
.IP \(bu 2
e7f0ab6 Merge pull request \fI\%#50873\fP from Ch3LL/bp\-50740
.INDENT 2.0
.IP \(bu 2
5fd9ed9 Merge branch \(aq2017.7\(aq into bp\-50740
.UNINDENT
.IP \(bu 2
2f77b2d Merge pull request \fI\%#50869\fP from garethgreenaway/50848_mysql_exception_test
.INDENT 2.0
.IP \(bu 2
3767d4f Merge branch \(aq2017.7\(aq into 50848_mysql_exception_test
.IP \(bu 2
af3e145 Cleanup.
.IP \(bu 2
b85c5bf Adding a test to ensure exception handling is correct.
.INDENT 2.0
.IP \(bu 2
4242e64 Merge branch \(aq2017.7\(aq into bp\-50740
.UNINDENT
.UNINDENT
.IP \(bu 2
a5caab7 Merge pull request \fI\%#50872\fP from Ch3LL/bp\-50864
.INDENT 2.0
.IP \(bu 2
fc9c64b fix typo in file.managed documentation
.IP \(bu 2
fd73f86 Catch UnicodeDecodeErrors in id verification
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50937\fP: (\fI\%Ch3LL\fP) Fix external_pillars documentation
@ \fI2018\-12\-20 19:15:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
49f2a35 Merge pull request \fI\%#50937\fP from Ch3LL/pillar_doc
.IP \(bu 2
1f01489 Fix external_pillars documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50919\fP: (\fI\%dpkirchner\fP) state.apply test documentation unclear (refs: \fI\%#50940\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50940\fP: (\fI\%terminalmage\fP) Fix confusing state module documentation
@ \fI2018\-12\-20 18:29:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
4213527 Merge pull request \fI\%#50940\fP from terminalmage/issue50919
.IP \(bu 2
3318927 Fix confusing state module documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50929\fP: (\fI\%twangboy\fP) Fix \fIunit.utils.test_lgpo_netsh\fP on Windows for Py3 (2018.3)
@ \fI2018\-12\-20 17:50:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
421e4f4 Merge pull request \fI\%#50929\fP from twangboy/fix_test_lgpo_netsh_2018.3
.IP \(bu 2
01f9beb Fix failing lgpo netsh tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50917\fP: (\fI\%dwoz\fP) Cherry pick test fixes from fluorine
@ \fI2018\-12\-19 17:56:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
b08b7e1 Merge pull request \fI\%#50917\fP from dwoz/test_fixes
.IP \(bu 2
16d10fb Fix linter warnings
.IP \(bu 2
b22f827 Increase and standardize ShellCase timeouts
.IP \(bu 2
a5c8c18 Do not pass unicode in environment
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50913\fP: (\fI\%bdrung\fP) Fix documentation build
@ \fI2018\-12\-19 16:03:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
59df6b4 Merge pull request \fI\%#50913\fP from bdrung/fix\-doc\-build
.IP \(bu 2
ecdb452 doc: Indroduce MOCK_MODULES_MAPPING
.IP \(bu 2
cf64824 doc: Move mock_decorator_with_params up
.IP \(bu 2
08ef669 doc: Address pylint issues in conf.py
.IP \(bu 2
67a3e37 doc: Mark preamble variable as raw string
.IP \(bu 2
b1e6080 doc: Fix reference to salt executors
.IP \(bu 2
e48b324 doc: Replace xa0 (non\-breaking space) by spaces
.IP \(bu 2
b973e7a doc: Fix iterating over the Mock object in Python 3
.IP \(bu 2
bb29948 doc: Do not mock non\-existing __mro_entries__ attribute
.IP \(bu 2
e6cf3c4 Do not mock json when building the documentation
.IP \(bu 2
4acaf45 Fix sphynx error about tornado.version_info
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50892\fP: (\fI\%cruscio\fP) archive.extracted source_hash is case sensitive (refs: \fI\%#50906\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50906\fP: (\fI\%garethgreenaway\fP) [2018.3] Ensure source_hash returned from get_source_sum is lowercase.
@ \fI2018\-12\-19 04:22:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
f4e6b88 Merge pull request \fI\%#50906\fP from garethgreenaway/50892_archive_extracted_source_hash_case_sensitive
.IP \(bu 2
bcf8f06 fixing lint
.IP \(bu 2
543ec7b Ensure source_hash returned from get_source_sum is lowercase.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50867\fP: (\fI\%Ch3LL\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-12\-14 21:32:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
b95b44f Merge pull request \fI\%#50867\fP from Ch3LL/merge\-2018.3
.IP \(bu 2
512293f Remove dunder_dictionaries.rst. Was added to modules/developing.rst
.IP \(bu 2
89b4e09 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
858cfac Merge pull request \fI\%#50863\fP from 5uper5hoot/fix\-issue\-50848
.INDENT 2.0
.IP \(bu 2
c90d201 Unpack exception args in python3 compatible way.
.UNINDENT
.IP \(bu 2
e28b2ba Merge pull request \fI\%#50752\fP from kstreee/fix\-memory\-leak
.INDENT 2.0
.IP \(bu 2
98cc63a Fixes a memory leak un\-cleared stream connections.
.UNINDENT
.IP \(bu 2
1f57602 Merge pull request \fI\%#50837\fP from Ch3LL/pyren_doc
.INDENT 2.0
.IP \(bu 2
a873019 Clarify py render docs when data context is available
.UNINDENT
.IP \(bu 2
fdff675 Merge pull request \fI\%#50844\fP from twangboy/fix_grains
.INDENT 2.0
.IP \(bu 2
473f4d7 Fix some unrelated lint
.IP \(bu 2
fd1a072 Fix grains for future windows releases
.UNINDENT
.IP \(bu 2
32dfaba Merge pull request \fI\%#50816\fP from dubb\-b/2017.7
.INDENT 2.0
.IP \(bu 2
dc7ff48 Pinning bootstrap to the tagged version of salt.
.UNINDENT
.IP \(bu 2
b1e5f3f Merge pull request \fI\%#50709\fP from mattLLVW/service_unmask
.INDENT 2.0
.IP \(bu 2
b199255 Merge branch \(aq2017.7\(aq into service_unmask
.IP \(bu 2
38addd1 salt style guideline
.IP \(bu 2
823c4ad Implement unmask in states.services
.IP \(bu 2
91a6bf5 Functional unmask, must add tests
.UNINDENT
.IP \(bu 2
e4e9563 Merge pull request \fI\%#50633\fP from astronouth7303/loader\-docs
.INDENT 2.0
.IP \(bu 2
03e3168 whitelist_modules is linked via enable_whitelist_modules for some reason? idk
.IP \(bu 2
5ca1f8e Typos
.IP \(bu 2
7cb1a87 Add a quick index of loader\-related settings
.IP \(bu 2
318ca48 Make a note to not import modules
.IP \(bu 2
6294658 Merge remote\-tracking branch \(aqorigin/2017.7\(aq into loader\-docs
.IP \(bu 2
678958e Editing
.IP \(bu 2
9d59629 Merge branch \(aq2017.7\(aq into loader\-docs
.IP \(bu 2
374d0e9 Finish the last sections
.IP \(bu 2
98da110 Migrate Dynamic Module Distribution to Modular Systems.
.IP \(bu 2
1bdd49d Add more links and write some system summaries
.IP \(bu 2
bd3796a Update TOC
.IP \(bu 2
3a9ab1b Merge dunders into developing, expand to cover all dunders.
.IP \(bu 2
d06739a Add short writeups for a bunch of systems.
.IP \(bu 2
705e7e4 Add a bunch of cross linking
.IP \(bu 2
40f9b16 Add missing module type sections
.IP \(bu 2
172d8c2 Refactor headings
.IP \(bu 2
53154a0 Oops, missed that
.IP \(bu 2
0dcd341 Possible horrific use of toctrees? maybe
.IP \(bu 2
bed3509 Refactor, add a TOC
.IP \(bu 2
f647c1d Fill in some missing modules
.IP \(bu 2
9d4b596 Merge branch \(aq2017.7\(aq into loader\-docs
.IP \(bu 2
26468df Add missing blank line
.IP \(bu 2
205fea9 Some more revising
.IP \(bu 2
d4a8f7e Remove some code from some links
.IP \(bu 2
65e4199 I feel like it should be up there
.IP \(bu 2
d44f5ce Rephrase footnote
.IP \(bu 2
125e46e Add section on how modules get loaded, including giant table of names
.IP \(bu 2
5bfc6c6 Update reference to modules/index
.IP \(bu 2
4b096c1 Move all the module\-development documentation into a single folder
.UNINDENT
.IP \(bu 2
dcdb9b2 Merge pull request \fI\%#50750\fP from bewing/pepa12
.INDENT 2.0
.IP \(bu 2
9931a41 Fix last key detection in pepa key_value_to_tree
.UNINDENT
.IP \(bu 2
cb85d5d Merge pull request \fI\%#50733\fP from marmarek/patch\-3
.INDENT 2.0
.IP \(bu 2
1011421 Report salt\-call exit code from ssh_py_shim.py
.UNINDENT
.IP \(bu 2
b086ff3 Merge pull request \fI\%#50756\fP from GwiYeong/local\-client\-fix
.INDENT 2.0
.IP \(bu 2
c488092 fix local client missing minion return
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50850\fP: (\fI\%akrus\fP) key_cache: sched prints error messages in logs (refs: \fI\%#50859\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50859\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes for key_cache and python3
@ \fI2018\-12\-13 23:57:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
216fa14 Merge pull request \fI\%#50859\fP from garethgreenaway/50850_python_key_cache_file_binary
.IP \(bu 2
ebc9a01 When reading and writing the key cache file, when using Python3, ensuring the file is read & written in binary mode.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50828\fP: (\fI\%twangboy\fP) Fix issues with lgpo state and util
@ \fI2018\-12\-13 16:37:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b45aad Merge pull request \fI\%#50828\fP from twangboy/fix_lgpo
.IP \(bu 2
05baa95 Merge branch \(aq2018.3\(aq into fix_lgpo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50843\fP: (\fI\%bdrung\fP) Fix RemoveCapacityFromDiskgroupTestCase require pyvmomi
@ \fI2018\-12\-12 20:36:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
6ea059d Merge pull request \fI\%#50843\fP from bdrung/fix\-tests
.IP \(bu 2
0d00ae4 Fix RemoveCapacityFromDiskgroupTestCase require pyvmomi
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50829\fP: (\fI\%ghost\fP) process.absent UnicodeDecodeError (refs: \fI\%#50839\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50839\fP: (\fI\%terminalmage\fP) Fix UnicodeDecodeError in ps module
@ \fI2018\-12\-12 19:59:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
14d7d1d Merge pull request \fI\%#50839\fP from terminalmage/issue50829
.IP \(bu 2
3a3d9b7 Ensure that unicode types returned from compatibility funcs
.IP \(bu 2
1a00abc Add unit test for _get_proc_cmdline
.IP \(bu 2
9eaa2ed Remove extraneous comments
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#49393\fP: (\fI\%Poil\fP) file.directory recurse not always changing perms (refs: \fI\%#50653\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50653\fP: (\fI\%lexvella\fP) Check file_mode in file.directory and _check_directory
@ \fI2018\-12\-12 16:30:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
264a042 Merge pull request \fI\%#50653\fP from lexvella/2018.3
.IP \(bu 2
4ea9386 Merge branch \(aq2018.3\(aq into 2018.3
.IP \(bu 2
42e4ab3 Merge branch \(aq2018.3\(aq into 2018.3
.IP \(bu 2
79f6b42 Check file_mode in file.directory and _check_directory
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
1233e2b Fix some lint
.IP \(bu 2
56c0e55 Fix issues with lgpo state and util
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45026\fP: (\fI\%angeloudy\fP) bytes error in mysql module (refs: \fI\%#50823\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50823\fP: (\fI\%terminalmage\fP) salt.modules.mysql: Decode fetch results before making string comparisons
@ \fI2018\-12\-11 21:04:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
a8ad17a Merge pull request \fI\%#50823\fP from terminalmage/issue45026
.IP \(bu 2
ec8e116 Decode fetch results before making string comparisons
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50817\fP: (\fI\%dubb\-b\fP) Adding git \(aqv\(aq to the bootstrap options
@ \fI2018\-12\-11 17:28:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
e31e731 Merge pull request \fI\%#50817\fP from dubb\-b/2018.3
.IP \(bu 2
48fc01f Adding git \(aqv\(aq to the bootstrap options
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50780\fP: (\fI\%twangboy\fP) Add netsh mechanism in the LGPO module
@ \fI2018\-12\-10 22:09:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
9b6b39c Merge pull request \fI\%#50780\fP from twangboy/lgpo_netsh
.IP \(bu 2
5eea728 Fix some lint
.IP \(bu 2
f077783 Add some tests
.IP \(bu 2
2dde12a Fix one more lint item
.IP \(bu 2
c55b7b4 Fix some lint
.IP \(bu 2
1247598 Add more policies
.IP \(bu 2
b2b9795 Fix overly long lines
.IP \(bu 2
f18d1aa Add additional policies that use netsh
.IP \(bu 2
cb50648 Add versionadded tags
.IP \(bu 2
00cbf26 Add the netsh mechanism to the lgpo module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50783\fP: (\fI\%sathieu\fP) gitfs/git_pillar: Fix UnicodeDecodeError while cleaning stale refs
@ \fI2018\-12\-10 20:34:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
0351296 Merge pull request \fI\%#50783\fP from sathieu/gitfs_stalerefs_unicode
.IP \(bu 2
ef160a6 gitfs/git_pillar: Fix UnicodeDecodeError while cleaning stale refs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45867\fP: (\fI\%Nick2253\fP) Icinga2 Module uses incorrect paths (refs: \fI\%#50615\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50765\fP: (\fI\%ClaudiuPID\fP) Fix icinga2 cert path
@ \fI2018\-12\-10 18:10:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50615\fP: (\fI\%ClaudiuPID\fP) Fixes icinga2 certs path for newer versions 2.8+ (refs: \fI\%#50765\fP)
.IP \(bu 2
deadf9c Merge pull request \fI\%#50765\fP from ClaudiuPID/fix\-icinga2\-cert\-path
.IP \(bu 2
ce1842e Merge branch \(aq2018.3\(aq into fix\-icinga2\-cert\-path
.IP \(bu 2
31878d5 Pylint fixes
.IP \(bu 2
47bfba1 Migrated to cmd.run_all and tested on working srv
.IP \(bu 2
a1dddce Fixes icinga2 certs path for newer versions 2.8+
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50692\fP: (\fI\%terminalmage\fP) Update a couple test modules to use with_tempdir/with_tempfile decorators
@ \fI2018\-12\-10 17:24:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
9f8289b Merge pull request \fI\%#50692\fP from terminalmage/update\-tests
.IP \(bu 2
36a4a1a Merge branch \(aq2018.3\(aq into update\-tests
.IP \(bu 2
be14517 Make x509 tests use tempfiles instead of hard\-coding them
.IP \(bu 2
a394cd7 Update file integration tests to use decorator for tempdirs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32245\fP: (\fI\%tkwilliams\fP) git_pillar should permit automatic mapping of environment to branch a\-la gitfs  (refs: \fI\%#50768\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50768\fP: (\fI\%sathieu\fP) git_pillar: Add support for all_saltenvs parameter
@ \fI2018\-12\-10 16:39:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a71567 Merge pull request \fI\%#50768\fP from sathieu/git_pillar_all_saltenvs
.IP \(bu 2
e971412 git_pillar: Add support for all_saltenvs parameter
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48801\fP: (\fI\%dstoliker\fP) salt.states.user.present \- mindays, warndays, and inactdays won\(aqt return to salt\(aqs default values (refs: \fI\%#50796\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50796\fP: (\fI\%dwoz\fP) Fix \fI\%#48801\fP min, max, inact, and warn changes
@ \fI2018\-12\-10 16:30:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
12a8447 Merge pull request \fI\%#50796\fP from dwoz/issue48801
.IP \(bu 2
6b95223 fix linter errors
.IP \(bu 2
87a04df Fix \fI\%#48801\fP min, max, inact, and warn changes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46388\fP: (\fI\%dynek\fP) IPv4 & v6 network configuration on Debian (refs: \fI\%#49355\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#40262\fP: (\fI\%pjediny\fP) Salt enforces configuration from /etc/network/interfaces.d/* to /etc/network/interface (refs: \fI\%#49355\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38672\fP: (\fI\%valentin2105\fP) IPv6 Network states is incomplete (refs: \fI\%#49355\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50804\fP: (\fI\%Ch3LL\fP) Back\-port \fI\%#49355\fP to 2018.3
@ \fI2018\-12\-10 16:21:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49355\fP: (\fI\%MTecknology\fP) Improve management of interfaces in debian\-based distributions (refs: \fI\%#50804\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46980\fP: (\fI\%MTecknology\fP) Fix broken rendering debian_eth.jinja. (refs: \fI\%#49355\fP)
.IP \(bu 2
b266e8b Merge pull request \fI\%#50804\fP from Ch3LL/bp\-49355
.IP \(bu 2
d34eade Use a temp file instead of /etc/network/interfaces for unit tests.
.IP \(bu 2
622c354 Support reading multiple addresses from interface files.
.IP \(bu 2
15c34fe Support unicode in space\-delimited list; fixes unit tests in py2.
.IP \(bu 2
0b59561 Added documentation about debian interfaces.d/*. (Fixes: \fI\%#40262\fP)
.IP \(bu 2
1b096fb Removed python lint.
.IP \(bu 2
6e41225 Finished adding support for multiple IP addresses.
.IP \(bu 2
4c7df5f Cleaned up documentation/examples in states.network:
.IP \(bu 2
601f434 Added support for \-ipaddrs and \-ipv6ipaddrs to modules.debian_ip().
.IP \(bu 2
638f899 Added support for loopback devices to modules.debian_ip(). (Fixes: \fI\%#38672\fP)
.IP \(bu 2
cf61c8d Added a bunch of unit tests for modules.debian_ip.build_interface().
.IP \(bu 2
b905cf6 Added support for dns_{nameservers,search} being a list or string.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50767\fP: (\fI\%dwoz\fP) Make sure ldap passwords are honored
@ \fI2018\-12\-05 22:59:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
dc9414c Merge pull request \fI\%#50767\fP from dwoz/ldap_no_pass
.IP \(bu 2
67aa591 Fix linter errors
.IP \(bu 2
be3945a Remove crufty import
.IP \(bu 2
91f50a4 Add more ldap auth tests for ZD\-2993
.IP \(bu 2
055a8d5 Make sure ldap passwords are honored
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50364\fP: (\fI\%sathieu\fP) git_pillar mountpoint ignores the root parameter (refs: \fI\%#50626\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50626\fP: (\fI\%sathieu\fP) git_pillar: Allow root and mountpoint parameters together
@ \fI2018\-12\-05 17:46:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
60aa0d5 Merge pull request \fI\%#50626\fP from sathieu/git_pillar_mountpoint_and_root
.IP \(bu 2
5423c27 git_pillar: Allow root and mountpoint parameters together
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50745\fP: (\fI\%bbinet\fP) Fix grafana dashboard updating when nothing has changed
@ \fI2018\-12\-04 19:26:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
c02387e Merge pull request \fI\%#50745\fP from bbinet/fix\-grafana\-dashboard\-update
.IP \(bu 2
7019d47 Fix grafana dashboard updating when nothing has changed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50737\fP: (\fI\%garethgreenaway\fP) [develop] Merge forward from 2017.7 to 2018.8
@ \fI2018\-12\-04 16:02:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
ae81498 Merge pull request \fI\%#50737\fP from garethgreenaway/merge\-2017.7
.IP \(bu 2
fde8db5 Merge branch \(aq2017.7\(aq into merge\-2017.7
.IP \(bu 2
246c055 Merge pull request \fI\%#50718\fP from dwoz/run_run_timeout
.INDENT 2.0
.IP \(bu 2
ecd8486 Honor run_run timeout for shell tests
.UNINDENT
.IP \(bu 2
979b3aa Merge pull request \fI\%#50702\fP from damon\-atkins/jenkins_pylint
.INDENT 2.0
.IP \(bu 2
5936066 ensure archiveArtifacts are always collected. Use CHANGE_BRANCH to detect merge\-forward
.UNINDENT
.IP \(bu 2
22acaaa Merge pull request \fI\%#50632\fP from astronouth7303/loader\-exception\-handler
.INDENT 2.0
.IP \(bu 2
0f72815 Merge branch \(aq2017.7\(aq into loader\-exception\-handler
.UNINDENT
.IP \(bu 2
d9e7be1 Merge pull request \fI\%#50670\fP from damon\-atkins/jenkins_pylint
.INDENT 2.0
.IP \(bu 2
b6d1605 ci/lint corrected filenames and test condition on full lint Also fix CODEOWNER team name
.INDENT 2.0
.IP \(bu 2
194801a Merge branch \(aqloader\-exception\-handler\(aq of github.com:astronouth7303/salt into loader\-exception\-handler
.INDENT 2.0
.IP \(bu 2
dadeb0d Merge branch \(aq2017.7\(aq into loader\-exception\-handler
.UNINDENT
.IP \(bu 2
8697744 Use single quotes per style guide
.IP \(bu 2
07868f1 Improve logging output
.IP \(bu 2
fb05bd5 Eat an exception from an entry point instead of letting it kill the system.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50685\fP: (\fI\%Ch3LL\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-11\-30 18:46:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
edaa9fe Merge pull request \fI\%#50685\fP from Ch3LL/merge_2018.3
.IP \(bu 2
d46aff0 Merge branch 2017.7 into 2018.3
.INDENT 2.0
.IP \(bu 2
6dc3afc Merge pull request \fI\%#50672\fP from garethgreenaway/49691_file_replace_search_only_return_false
.INDENT 2.0
.IP \(bu 2
7e7df06 lint
.IP \(bu 2
6b73c76 When using file.replace, with the search_only option, if the pattern does not exist in the file then we should return False.
.UNINDENT
.IP \(bu 2
1236b51 Merge pull request \fI\%#50659\fP from garethgreenaway/49954_gem_installed_less_than_greater_than_support
.INDENT 2.0
.IP \(bu 2
0ec8bcf When using the gem installed state, when passing a version that includes greater
than or less than symbols, ensure that the installed versions meets that requirement.
.UNINDENT
.IP \(bu 2
6317f3a Merge pull request \fI\%#50583\fP from damon\-atkins/jenkins_pylint
.INDENT 2.0
.IP \(bu 2
2d1f51c Fix lint only changes, full lint on merge forwards \- lint only changes previous diff
picked up out of data files, when the branch was out of date. \- full limit on merge forward
to pick up changes in the lint checks between versions. \- update CODEOWNERS for .ci/*
.UNINDENT
.IP \(bu 2
15bf09a Merge pull request \fI\%#50605\fP from Oloremo/fix\-supervisord\-dead\-state\-idempotency
.INDENT 2.0
.IP \(bu 2
ba3f281 Merge branch \(aq2017.7\(aq into fix\-supervisord\-dead\-state\-idempotency
.IP \(bu 2
cf9ab84 Merge branch \(aq2017.7\(aq into fix\-supervisord\-dead\-state\-idempotency
.IP \(bu 2
af386a2 Fixed the supervisord.dead state idempotency
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50016\fP: (\fI\%abednarik\fP) State augeas.change do not update config file (refs: \fI\%#50690\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50690\fP: (\fI\%garethgreenaway\fP)  [2018.3] fixes to augeas_cfg module
@ \fI2018\-11\-30 18:44:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
7cb2405 Merge pull request \fI\%#50690\fP from garethgreenaway/50016_ensure_path_is_str
.IP \(bu 2
cec7cb4 Older versions of python\-augeas need the path passed to aug.match to be a string.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49392\fP: (\fI\%Poil\fP) hosts not replacing existing entry (refs: \fI\%#50657\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50657\fP: (\fI\%terminalmage\fP) Rewrite host.present state to allow for removal of entries not matching IP
@ \fI2018\-11\-29 17:58:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
a5c7639 Merge pull request \fI\%#50657\fP from terminalmage/issue49392
.IP \(bu 2
2ddb587 Add release notes for new \(dqclean\(dq option
.IP \(bu 2
e4946f9 Rename \(dqremove\(dq argument to \(dqclean\(dq
.IP \(bu 2
7fd3bce Add remove parameter to host.present state
.IP \(bu 2
2671a30 Add unit tests for host.present state
.IP \(bu 2
30f1b85 Remove non\-matching IPs from hosts file
.IP \(bu 2
ec297a0 Performance improvements in hosts module
.IP \(bu 2
d1c2038 Add generic ip address validation function
.IP \(bu 2
9f54720 Add ignore ability to process_read_exception
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48759\fP: (\fI\%MyIgel\fP) acme.cert: Fail to update certificate after adding aliases / missing \-\-expand (refs: \fI\%#50683\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50683\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to acme module when adding aliases to existing certificate
@ \fI2018\-11\-29 17:46:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
b604785 Merge pull request \fI\%#50683\fP from garethgreenaway/48759_adding_aliases_include_expand
.IP \(bu 2
3940a0f When adding alises to an existing Certbot certificate, if we see a message about
expanding in the stderr returned from cmd.run_all we should rerun the cmd with \-\-expand included.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50406\fP: (\fI\%glkappe\fP) salt\-ssh can\(aqt use Mongo returner (refs: \fI\%#50664\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50664\fP: (\fI\%garethgreenaway\fP)  [2018.3] Fix to logic for configuring returners
@ \fI2018\-11\-28 05:24:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
15f9ae4 Merge pull request \fI\%#50664\fP from garethgreenaway/50406_salt_ssh_returner_configuration
.IP \(bu 2
3525411 When pulling values out of the available configuration for returners we should always
default to using keys for those returners, eg. mongo.user for the username. Otherwise in
certain situations, eg. when using salt\-ssh we will end up with the wrong value for the user.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50652\fP: (\fI\%twangboy\fP) Fix \fIunit.utils.test_mac_utils\fP on Windows
@ \fI2018\-11\-27 20:45:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
afbcf03 Merge pull request \fI\%#50652\fP from twangboy/fix_test_mac_utils
.IP \(bu 2
c4cb729 Fix path issues with the tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50640\fP: (\fI\%garethgreenaway\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-11\-26 22:33:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
61a824f Merge pull request \fI\%#50640\fP from garethgreenaway/merge\-2017
.IP \(bu 2
409c98f Merge branch \(aq2018.3\(aq into merge\-2017
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50403\fP: (\fI\%prometheanfire\fP) tornado 5.1.1 is not co\-installable with salt on python2.7 (refs: \fI\%#50639\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50639\fP: (\fI\%dwoz\fP) Handle pipenv like version restrictions
@ \fI2018\-11\-26 19:42:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
20a2de3 Merge pull request \fI\%#50639\fP from dwoz/pipfix
.IP \(bu 2
9c6f653 Handle pipenv like version restrictions
.INDENT 2.0
.IP \(bu 2
fced78b lint
.IP \(bu 2
45a1aa3 Merge branch \(aq2017.7\(aq into merge\-2017
.IP \(bu 2
b2cf134 Merge pull request \fI\%#50463\fP from dwoz/zmqpubserv
.INDENT 2.0
.IP \(bu 2
a289e3c Merge branch \(aq2017.7\(aq into zmqpubserv
.UNINDENT
.IP \(bu 2
6679242 Merge pull request \fI\%#50590\fP from garethgreenaway/bp\-50333
.INDENT 2.0
.IP \(bu 2
1f5aa4b pkg.installed currently fails when sources is used along with hold: True.
This was due to a change in \fI\%#48426\fP that swapped out sending the pkgs variable for the
desired variable instead. This caused problems with pkg.hold because desired and sources
are always populated, and pkg.hold can only include one or the other. This change just
includes desired in the call to pkg.hold since desired has the same value for sources.
.INDENT 2.0
.IP \(bu 2
39e811b Add issue url to tests
.IP \(bu 2
c4d7a43 Add debug log when connecting
.IP \(bu 2
4f81432 Set subscribe via sockopt for better compatibility
.IP \(bu 2
6882209 More reliable pub server publishing
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49957\fP: (\fI\%whytewolf\fP) salt\-master scheduled items ignore maxrunning. (refs: \fI\%#50130\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50130\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to schedule maxrunning on master
@ \fI2018\-11\-26 18:35:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b7ab35 Merge pull request \fI\%#50130\fP from garethgreenaway/49957_master_schedule_ignoring_maxrunning
.IP \(bu 2
2f6dac9 Updating test_maxrunning_master to Mock get_running_jobs.
.IP \(bu 2
abda0a4 Reverting changes to doc/conf.py.
.IP \(bu 2
6d072fc Some additional cleanup.
.IP \(bu 2
4bd0406 Adding integration.scheduler.test_maxrunning to ignore list.
.IP \(bu 2
45e160d Adding integration.scheduler.test_maxrunning to filename_map.yml
.IP \(bu 2
2201a46 Fixing lint
.IP \(bu 2
6c0ee32 removing unused cache_jobs function from utils/master.py
.IP \(bu 2
c2ed1d4 Adding some logging when the cache files are unable to be removed.
.IP \(bu 2
44940d6 Ensure minion tests using minion options.
.IP \(bu 2
722be43 Fixing lint
.IP \(bu 2
65b4421 Adding some master specific functions to uitls/masters.py to determine if a Salt
process is running. Updating utils/schedule.py to use the appropriate running function either
from utils/master.py or utils/minion.py depending on where the scheduled job is running. Adding
tests to test maxrunning in scheduled jobs for both the minion and master.
.IP \(bu 2
0d65304 Swapping manual mocking to autodoc_mock_imports
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50542\fP: (\fI\%doug\-stratoscale\fP) mysql.user_exists doesn\(aqt work with Mysql 8.0.13 (refs: \fI\%#50551\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50551\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to verify_login in mysql module
@ \fI2018\-11\-26 17:44:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
26759c2 Merge pull request \fI\%#50551\fP from garethgreenaway/50542_mysql_ensure_verify_login_uses_connection_host
.IP \(bu 2
96742aed4 Merge branch \(aq2018.3\(aq into 50542_mysql_ensure_verify_login_uses_connection_host
.IP \(bu 2
eb510a6 Merge branch \(aq2018.3\(aq into 50542_mysql_ensure_verify_login_uses_connection_host
.IP \(bu 2
6d2309d Merge branch \(aq2018.3\(aq into 50542_mysql_ensure_verify_login_uses_connection_host
.IP \(bu 2
db89b27 Merge branch \(aq2018.3\(aq into 50542_mysql_ensure_verify_login_uses_connection_host
.IP \(bu 2
0284323 Ensure that verify_login is using the host from the connection_args and not the host associated with the user.
Adding a test to ensure user_exists when the passed host is the MySQL wildcard %.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50619\fP: (\fI\%s0undt3ch\fP) Don\(aqt squash tracebacks and Unicode fixes
@ \fI2018\-11\-26 17:04:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
14c4fd5 Merge pull request \fI\%#50619\fP from s0undt3ch/2018.3
.IP \(bu 2
a4771d2 UNICODE!
.IP \(bu 2
72205a5 DO! NOT! SQUASH! TRACEBACKS!
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50562\fP: (\fI\%soostdijck\fP) scheduled highstate ignores blackout (refs: \fI\%#50586\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50586\fP: (\fI\%garethgreenaway\fP) [2018.3] minion_blackout for scheduled jobs
@ \fI2018\-11\-23 11:15:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
59809a1 Merge pull request \fI\%#50586\fP from garethgreenaway/50562_minion_blackout_scheduler
.IP \(bu 2
48673b7 Adding some defaults for minion_blackout code when pillar & grains are not available in opts.  Removing some debugging code.
.IP \(bu 2
9f422b2 Moving the minion_blackout code to the start of the try...except.  Adding a test to ensure we get a log.exception when minion_blackout is True.
.IP \(bu 2
2bf8fa5 Adding support for minion_blackout for jobs that are run from the Salt scheduler.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50576\fP: (\fI\%garethgreenaway\fP) Back\-port PR \fI\%#50549\fP to 2018.3
@ \fI2018\-11\-21 14:39:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50549\fP: (\fI\%cachedout\fP) Add security credits to release notes (refs: \fI\%#50576\fP)
.IP \(bu 2
5c28179 Merge pull request \fI\%#50576\fP from garethgreenaway/bp\-50549
.IP \(bu 2
807068d Typo fix
.IP \(bu 2
2ef8307 Typo fix
.IP \(bu 2
7c8957a Typo fix
.IP \(bu 2
c1ca603 Merge branch \(aq2018.3\(aq into bp\-50549
.IP \(bu 2
b163380 Add security credits to release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50599\fP: (\fI\%terminalmage\fP) Merge Sphinx fixes from 2017.7 to 2018.3
@ \fI2018\-11\-21 13:31:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
c9531d8 Merge pull request \fI\%#50599\fP from terminalmage/merge\-2018.3
.IP \(bu 2
ba82b07 Merge remote\-tracking branch \(aqupstream/2017.7\(aq into merge\-2018.3
.IP \(bu 2
1b8a8ac Merge pull request \fI\%#50592\fP from terminalmage/docs\-2017.7
.INDENT 2.0
.IP \(bu 2
db15776 Remove overline from section title
.IP \(bu 2
8127dd5 Disable unused shorturls plugin
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50254\fP: (\fI\%jmcook1\fP) file.line adding line every time (refs: \fI\%#50366\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50366\fP: (\fI\%t0fik\fP) 2018.3 fix issue50254
@ \fI2018\-11\-20 20:31:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
60b4622 Merge pull request \fI\%#50366\fP from jdsieci/2018.3\-fix\-issue50254
.IP \(bu 2
a9b9fa2 Fixed pylint warnings
.IP \(bu 2
342786b Issue \fI\%#50254\fP fixed
.IP \(bu 2
1ab59e7 Added integration tests
.IP \(bu 2
110f74f Added unit tests reproducing issue
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50558\fP: (\fI\%angeloudy\fP) \(aqtest=True\(aq does not work with artifactory.download (refs: \fI\%#50580\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#50155\fP: (\fI\%mikemartino\fP) artifactory.downloaded state is not respecting test=True (refs: \fI\%#50580\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50580\fP: (\fI\%garethgreenaway\fP) [2018.3] Adding test=True to artifactory.download.
@ \fI2018\-11\-20 16:37:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
735c9f4 Merge pull request \fI\%#50580\fP from garethgreenaway/50155_artificatory_download_state_test_true
.IP \(bu 2
7dd57d0 Lint.
.IP \(bu 2
3661ee0 Adding test=True to artifactory.download.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46292\fP: (\fI\%asymetrixs\fP) win_wua should have possibility to specify source file (refs: \fI\%#50397\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50577\fP: (\fI\%garethgreenaway\fP) Back\-port PR \fI\%#50397\fP to 2018.3
@ \fI2018\-11\-19 21:28:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50397\fP: (\fI\%tlemarchand\fP) Add Win WUSA management, to install Windows Update files (.msu). (refs: \fI\%#50577\fP)
.IP \(bu 2
015834d Merge pull request \fI\%#50577\fP from garethgreenaway/bp\-50397
.IP \(bu 2
dd2d872 Documentation
.IP \(bu 2
af6d21f Import unicode_literals from future and add versionadded tag
.IP \(bu 2
09dc09d Disable powershell modules list Add list_kbs function
.IP \(bu 2
05852d0 pchanges to changes named parameters
.IP \(bu 2
16525e4 Add Win WUSA management, to install Windows Update files (.msu).
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50570\fP: (\fI\%garethgreenaway\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-11\-19 20:04:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
12e0d80 Merge pull request \fI\%#50570\fP from garethgreenaway/merge\-2018.3
.IP \(bu 2
4c85119 merge\-forward 2017.7 to 2018.3
.IP \(bu 2
02238a7 Merge pull request \fI\%#50520\fP from dwoz/issue_50459
.INDENT 2.0
.IP \(bu 2
1aa2e34 Simplifie and portable homedir lookup
.IP \(bu 2
f14f747 Fix windows home dir lookup
.IP \(bu 2
d3620c3 Always set .gitconfig dir to user\(aqs home
.UNINDENT
.IP \(bu 2
edd9738 Merge pull request \fI\%#50532\fP from dubb\-b/2017.7
.INDENT 2.0
.IP \(bu 2
009e52d Adding tag to ec2 cloud tests
.UNINDENT
.IP \(bu 2
b0446f5 Merge pull request \fI\%#50500\fP from terminalmage/2017.7\-docs
.INDENT 2.0
.IP \(bu 2
870a364 Set docs jenkins job to treat warnings as errors
.IP \(bu 2
e03bdcd Update docs references for states with func_alias
.IP \(bu 2
8a2c08f Disable custom sphinx automodule
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50266\fP: (\fI\%4815162342lost\fP) grains.virtual show incorrect info (refs: \fI\%#50519\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50519\fP: (\fI\%garethgreenaway\fP) [2018.3] Fix to virtual core grain
@ \fI2018\-11\-16 23:42:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
6fba83c Merge pull request \fI\%#50519\fP from garethgreenaway/50266_core_virtual_grain_fixes
.IP \(bu 2
dcae2f0 Merge branch \(aq2018.3\(aq into 50266_core_virtual_grain_fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50427\fP: (\fI\%sathieu\fP) Backports git_pillar tests improvements to 2018.3
@ \fI2018\-11\-16 16:37:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50425\fP: (\fI\%sathieu\fP) git_pillar: Add tests for mountpoint parameter (refs: \fI\%#50427\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50407\fP: (\fI\%sathieu\fP) git_pillar: Add tests for root parameter (refs: \fI\%#50427\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50378\fP: (\fI\%sathieu\fP) Don\(aqt fail on git_pillar tests when destructive tests are not enable (refs: \fI\%#50427\fP)
.IP \(bu 2
84edd62 Merge pull request \fI\%#50427\fP from sathieu/bp\-git_pillar_tests
.IP \(bu 2
12ea1cc git_pillar: Add tests for mountpoint parameter
.IP \(bu 2
fce467e git_pillar: Add tests for root parameter
.IP \(bu 2
ba150a5 Don\(aqt fail on git_pillar tests when destructive tests are not enable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50530\fP: (\fI\%terminalmage\fP) Enable proxy/ssh daemons when filename mapping causes those tests to be run
@ \fI2018\-11\-15 23:03:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
4651481 Merge pull request \fI\%#50530\fP from terminalmage/salt\-jenkins\-1209
.IP \(bu 2
fbee11d Enable proxy/ssh daemons when filename mapping causes those tests to be run
.IP \(bu 2
4f30611 lint
.IP \(bu 2
4f9eb95 Fixing a typo in the _virtual function, should be checking for existing grains in
osdata not grains. Updating the detection to look for /sys/bus/xen/drivers/xenconsole instead
of specifically looking for any files under /sys/bus/xen/drivers. Some systems that are not
running as Xen PV hosts include files under that location, particular Oracle Linux.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50224\fP: (\fI\%mruepp\fP) Augeas changes state with setm not working (refs: \fI\%#50526\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50526\fP: (\fI\%terminalmage\fP) Work around augeas\(aq lack of unicode support
@ \fI2018\-11\-15 17:33:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c07ba4 Merge pull request \fI\%#50526\fP from terminalmage/issue50224
.IP \(bu 2
ee246ed Work around augeas\(aq lack of unicode support
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50503\fP: (\fI\%terminalmage\fP) Set jenkins docs job to treat any warnings as errors (2018.3 branch)
@ \fI2018\-11\-14 19:30:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
d83da51d Merge pull request \fI\%#50503\fP from terminalmage/2018.3\-docs
.IP \(bu 2
a4fc108 Fix docs configuration for renamed logstash engine
.IP \(bu 2
5b06464 Set docs jenkins job to treat warnings as errors
.IP \(bu 2
9b6c669 Update docs references for states with func_alias
.IP \(bu 2
62b5d40 Disable custom sphinx automodule
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48343\fP: (\fI\%bornwitbugs\fP) CPU Beacon TypeError (refs: \fI\%#50514\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50514\fP: (\fI\%bornwitbugs\fP) Load beacon fix
@ \fI2018\-11\-14 19:20:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
fa2f4a5 Merge pull request \fI\%#50514\fP from bornwitbugs/load_beacon_fix
.IP \(bu 2
e59ced6 Merge branch \(aq2018.3\(aq of github.com:saltstack/salt into load_beacon_fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50509\fP: (\fI\%Ch3LL\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-11\-14 17:52:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
a50377b Merge pull request \fI\%#50509\fP from Ch3LL/merge\-2018.3
.IP \(bu 2
178dab3 Merge branch 2017.7 into 2018.3
.IP \(bu 2
c00fd43 Merge pull request \fI\%#50493\fP from rallytime/bp\-50362
.INDENT 2.0
.IP \(bu 2
60559cf Remove flaky test
.IP \(bu 2
a696a8f Fix test_matcher on Windows
.UNINDENT
.IP \(bu 2
3cac1d0 Merge pull request \fI\%#50494\fP from terminalmage/2017.7\-docs
.INDENT 2.0
.IP \(bu 2
d561b26 Late import to fix docs build errors
.UNINDENT
.IP \(bu 2
0829944 Merge pull request \fI\%#50479\fP from Ch3LL/digital_ocean_location
.INDENT 2.0
.IP \(bu 2
917781d Lint: Add blank line
.IP \(bu 2
3583519 Update digital ocean location for cloud tests
.UNINDENT
.IP \(bu 2
accf681 Merge pull request \fI\%#50480\fP from terminalmage/docs
.INDENT 2.0
.IP \(bu 2
c34690e Don\(aqt import obsolete Directive class from Sphinx
.UNINDENT
.IP \(bu 2
2e9b3d2 Merge pull request \fI\%#50478\fP from rallytime/update\-bootstrap\-docs
.INDENT 2.0
.IP \(bu 2
66b078c Update the bootstrap script documentation to point to bootstrap repo
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50502\fP: (\fI\%twangboy\fP) Add definition for RestrictRemoteSAM
@ \fI2018\-11\-14 14:30:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
55b4914 Merge pull request \fI\%#50502\fP from twangboy/lgpo_2018.3
.IP \(bu 2
fe92a3a Add definition for RestrictRemoteSAM
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48734\fP: (\fI\%oddfellow\fP) salt\-run jobs.list_jobs has Target: unknown\-target (refs: \fI\%#50328\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#43453\fP: (\fI\%kunal\-bajpai\fP) Runner job \fIload\fP is never saved to job cache (refs: \fI\%#43454\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50328\fP: (\fI\%rallytime\fP) Fix issue with salt\-run jobs.list_jobs where Target: unknown\-target
@ \fI2018\-11\-13 19:49:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43454\fP: (\fI\%kunal\-bajpai\fP) Fix save_load which is never called for returner jobs (refs: \fI\%#50328\fP)
.IP \(bu 2
c1dde7e Merge pull request \fI\%#50328\fP from rallytime/fix\-48734
.IP \(bu 2
2c51cf9 Make target test job more specific to reduce test flakiness
.IP \(bu 2
caace3f Rewrite job cache target test to be more robust
.IP \(bu 2
b29fcfa New test must be py3 compatible...oops. :)
.IP \(bu 2
c684c29 Fix issue \fI\%#48734\fP
.IP \(bu 2
6859e0e Add regression test for issue \fI\%#48734\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50499\fP: (\fI\%dwoz\fP) Fix 2018.3 build
@ \fI2018\-11\-13 18:46:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
351faeb Merge pull request \fI\%#50499\fP from dwoz/build_fix
.IP \(bu 2
5754b4a Fix 2018.3 build
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50496\fP: (\fI\%terminalmage\fP) Fix 2018.3 docs build warnings
@ \fI2018\-11\-13 17:21:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
6f4b23f Merge pull request \fI\%#50496\fP from terminalmage/2018.3\-docs
.IP \(bu 2
cb25641 Fix header underline length to avoid another sphinx warning
.IP \(bu 2
9272f7b Fix more sphinx build errors
.IP \(bu 2
18a8104 Late import to fix docs build errors
.IP \(bu 2
d457132 Fix sphinx build warnings in 2018.3 branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50227\fP: (\fI\%sheagcraig\fP) mac_utils \fI_available_services\fP will fail with malformed launchd plists present (refs: \fI\%#50228\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50492\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50228\fP and \fI\%#50443\fP to 2018.3
@ \fI2018\-11\-13 16:59:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50443\fP: (\fI\%weswhet\fP) fix when checking for service Label on macOS (refs: \fI\%#50492\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50228\fP: (\fI\%sheagcraig\fP) Fix 50227 malformed plists (refs: \fI\%#50492\fP, \fI\%#50443\fP)
.IP \(bu 2
6b272c1 Merge pull request \fI\%#50492\fP from rallytime/bp\-50228\-and\-50443
.IP \(bu 2
7879a2d Fix logging format
.IP \(bu 2
f578392 Lint Fix: add mock_open import
.IP \(bu 2
e5b999b add try/except when checking for service Label
.IP \(bu 2
3c36bdd Fix linting errors.
.IP \(bu 2
fab57de Write tests to handle invalid launchd plist XML.
.IP \(bu 2
bb429b0 Condense service result assertions, add a binary plist test.
.IP \(bu 2
a809fef Factor out another helper function, implement broken symlink test.
.IP \(bu 2
216f7ef Update testing for mac_utils services.
.IP \(bu 2
89d8267 Fix trailing\-slash bug in User LaunchAgent appending.
.IP \(bu 2
0e23b6e Handle bad plists by ignoring them, with py2 and py3 specific approaches
.IP \(bu 2
fa44149 Avoid \fIAttributeError\fP when checking for exception types.
.IP \(bu 2
fd62b33 Add secondary exception handler for malformed plists.
.IP \(bu 2
ae6f49b Make test correctly generate a double exception.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50486\fP: (\fI\%twangboy\fP) Back port lgpo from Fluorine
@ \fI2018\-11\-13 09:40:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
da980d9 Merge pull request \fI\%#50486\fP from twangboy/lgpo_2018.3
.IP \(bu 2
bbbc07b Back port lgpo from Fluorine
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50218\fP: (\fI\%ata\-sql\fP) git.latest with unless command fails after upgrade to 2018.3.3 (refs: \fI\%#50456\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50456\fP: (\fI\%terminalmage\fP) Two bugfixes
@ \fI2018\-11\-13 06:06:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
7dd3438 Merge pull request \fI\%#50456\fP from terminalmage/issue50218
.IP \(bu 2
6143408 Add unit test for TimedProc regression
.IP \(bu 2
e234abd Add support for list of commands in git states\(aq onlyif/unless
.IP \(bu 2
cbf05c8 TimedProc: Don\(aqt assume args is a string
.IP \(bu 2
87de250 Exit gracefully when mod_run_check raises exception
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50455\fP: (\fI\%dubb\-b\fP) Adding the released version as the bootstrap minion.
@ \fI2018\-11\-12 22:52:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
d8514e6 Merge pull request \fI\%#50455\fP from dubb\-b/2018.3
.IP \(bu 2
fb61482 adding git
.IP \(bu 2
181b8a4 removing stable
.IP \(bu 2
fc93ad6 Adding the released version as the bootstrap minion.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50483\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50272\fP to 2018.3
@ \fI2018\-11\-12 22:45:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50272\fP: (\fI\%jyurdal\fP) Fix out of order docker Env comparison (refs: \fI\%#50483\fP)
.IP \(bu 2
cfb3351 Merge pull request \fI\%#50483\fP from rallytime/bp\-50272
.IP \(bu 2
0f02da7 Remove unnecessary u prefix from string literals
.IP \(bu 2
fc26ae8 Add unit test for comparing containers with the same env vars
.IP \(bu 2
cf7cb4b extra blank line after function definition(pylint)
.IP \(bu 2
1de9ce3 Compare sorted docker environment
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50481\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-11\-12 22:44:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
360ae6a Merge pull request \fI\%#50481\fP from rallytime/merge\-2018.3
.IP \(bu 2
1517bb3 Update old utils paths to use new paths
.IP \(bu 2
d8e7c47 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
e5f97cd Merge pull request \fI\%#50467\fP from dwoz/test_kitchen_up
.INDENT 2.0
.IP \(bu 2
8c5e93e Use patched version of test\-kitchen until next release
.UNINDENT
.IP \(bu 2
b16ff9c Merge pull request \fI\%#50469\fP from dwoz/minion_timeout_test
.INDENT 2.0
.IP \(bu 2
57f702d Fix linter warning
.IP \(bu 2
686153a Fix up integration.minion.test_timeout
.UNINDENT
.IP \(bu 2
45b438e Merge pull request \fI\%#50470\fP from dwoz/set_time_flaky
.INDENT 2.0
.IP \(bu 2
794ba17 Reset date and time after changing
.UNINDENT
.IP \(bu 2
c85561e Merge pull request \fI\%#50442\fP from rallytime/replace\-docbanner
.INDENT 2.0
.IP \(bu 2
193325d Update docbanner hyperlink
.UNINDENT
.IP \(bu 2
7200568 Merge pull request \fI\%#50439\fP from rallytime/bootstrap\-contributing\-docs
.INDENT 2.0
.IP \(bu 2
d2158aa Add bootstrap section to contributing docs
.UNINDENT
.IP \(bu 2
cca7a36 Merge pull request \fI\%#50441\fP from rallytime/replace\-docbanner
.INDENT 2.0
.IP \(bu 2
2af92bd Update SaltConf doc banner
.UNINDENT
.IP \(bu 2
1e72d20 Merge pull request \fI\%#50414\fP from flassman/backmerge\-for\-typeerror\-windows\-python3
.INDENT 2.0
.IP \(bu 2
20fff15 use exc.winerror not exc[0] to avoid python3 TypeError
.UNINDENT
.IP \(bu 2
93095cb Merge pull request \fI\%#50415\fP from flassman/pass\-cwd\-to\-runas_system
.INDENT 2.0
.IP \(bu 2
0113137 cwd needs to be passed from runas() to runas_system()
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50461\fP: (\fI\%absolutejam\fP) elementaryOS \(aqpkg\(aq __virtual__ returned false (refs: \fI\%#50468\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50468\fP: (\fI\%garethgreenaway\fP)  [2018.3] Adding elementary override to grains/core.py
@ \fI2018\-11\-12 16:41:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
3aaad17 Merge pull request \fI\%#50468\fP from garethgreenaway/50461_fix_elementary_os_family_grain
.IP \(bu 2
77e8dcc On later versions of elementary, the os_family is being populated as elementary.
In order for the aptpkg module to function, we need to override is to be Debian.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50311\fP: (\fI\%marek\-obuchowicz\fP) pkg.installed state fails even though it succeeded (refs: \fI\%#50590\fP, \fI\%#50333\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#46689\fP: (\fI\%mxork\fP) pkg.installed: hold: True not applied to a package which is already installed. (refs: \fI\%#48426\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50333\fP: (\fI\%garethgreenaway\fP) [2018.3] Fix to pkg.installed for sources and hold: True (refs: \fI\%#50590\fP)
@ \fI2018\-11\-08 18:02:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48426\fP: (\fI\%garethgreenaway\fP) [2017.7] fixes to states/pkg.py (refs: \fI\%#50333\fP)
.IP \(bu 2
d9179fb Merge pull request \fI\%#50333\fP from garethgreenaway/50311_pkg_installed_fails_sources_hold
.IP \(bu 2
7bc9b3d Merge branch \(aq2018.3\(aq into 50311_pkg_installed_fails_sources_hold
.IP \(bu 2
6e96728 pkg.installed currently fails when sources is used along with hold: True.  This was due
to a change in \fI\%#48426\fP that swapped out sending the pkgs variable for the desired variable
instead. This caused problems with pkg.hold because desired and sources are always populated,
and pkg.hold can only include one or the other. This change just includes desired in the call
to pkg.hold since desired has the same value for sources.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50434\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-11\-08 17:40:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
193c80a Merge pull request \fI\%#50434\fP from rallytime/merge\-2018.3
.IP \(bu 2
83dfbb2 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
ef4509e Merge pull request \fI\%#50370\fP from dwoz/pubd_msg_logs
.INDENT 2.0
.IP \(bu 2
58ced12 log jid to payload size
.IP \(bu 2
3c537b5 Log message flow to publish daemon
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50417\fP: (\fI\%meaksh\fP) Get the right target when using \(dq__env__\(dq on git ext_pillar to avoid merging problems
@ \fI2018\-11\-08 17:07:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
73ce80f Merge pull request \fI\%#50417\fP from meaksh/2018.3\-fix\-git_pillar\-__env__\-solving\-for\-merging
.IP \(bu 2
71af32d Remove unicode references
.IP \(bu 2
b7af5e5 Test git ext_pillar across multiple repos using __env__
.IP \(bu 2
59894e2 Resolve target branch when using __env__
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50292\fP: (\fI\%dstoliker\fP) sysctl in test=True mode results in [ERROR   ] Could not open sysctl file (refs: \fI\%#50423\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50423\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to sysctl modules and state
@ \fI2018\-11\-08 14:13:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
e9464c9 Merge pull request \fI\%#50423\fP from garethgreenaway/50292_no_error_log_test_true
.IP \(bu 2
95a7f12 Adding file check and empty list return to freebsd_sysctl.py
.IP \(bu 2
469c090 Adding a check to see if the config file exists, if not then return an empty list so we get the would be changes.  Adding a test for this functionality.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50420\fP: (\fI\%weswhet\fP) mac_system virtual function fails to load on 2018.3.3 (refs: \fI\%#50421\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50421\fP: (\fI\%weswhet\fP) fixing an issue on mac_system where the virtual function wouldnt load
@ \fI2018\-11\-07 21:57:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
fccf875 Merge pull request \fI\%#50421\fP from weswhet/fix\-mac_system\-loader
.IP \(bu 2
042445d fixing an issue on mac_system where the virtual function wouldnt load
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50409\fP: (\fI\%casselt\fP) Fix test mode for mount state if device_name_regex is used.
@ \fI2018\-11\-07 16:04:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
d2fc910 Merge pull request \fI\%#50409\fP from casselt/mount\-device_name_regex\-test\-mode\-fix
.IP \(bu 2
56d5a32 Fix test mode for mount state if device_name_regex is used.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50383\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-11\-06 15:51:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
c2fda9d Merge pull request \fI\%#50383\fP from rallytime/merge\-2018.3
.IP \(bu 2
e993692 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
cd7c95f Merge pull request \fI\%#50128\fP from mgomersbach/fix\-py3\-reload\-compat
.INDENT 2.0
.IP \(bu 2
e453e82 Satisfy pylint, use naming instead of W or E classification
.IP \(bu 2
d20581c Merge branch \(aqfix\-py3\-reload\-compat\(aq of github.com:mgomersbach/salt into fix\-py3\-reload\-compat
.INDENT 2.0
.IP \(bu 2
48c6a4f Merge branch \(aq2017.7\(aq into fix\-py3\-reload\-compat
.UNINDENT
.IP \(bu 2
5cd9741 Satisfy pylint
.IP \(bu 2
a2838db Satisfy pylint checks
.IP \(bu 2
05c598c Fix import error by utilizing six and strict version spec
.IP \(bu 2
95174e6 Merge branch \(aq2017.7\(aq into fix\-py3\-reload\-compat
.IP \(bu 2
ab8b5b4 Update workaround to root of file
.IP \(bu 2
37ab1f8 Update workaround to root of file
.IP \(bu 2
253ab11 Workaround for py2 builtin, =<3.3 imp and >=3.4 libimport quirks, solves \fI\%#50127\fP
.UNINDENT
.IP \(bu 2
aa6b149 Merge pull request \fI\%#50354\fP from rallytime/version_num_docs
.INDENT 2.0
.IP \(bu 2
0621f7d Add a few more feature release codenames to the version_numbers doc
.UNINDENT
.IP \(bu 2
6472100 Merge pull request \fI\%#50359\fP from dwoz/clitest
.INDENT 2.0
.IP \(bu 2
18b5d43 Increase cli batch test timeout for increased reliablity
.UNINDENT
.IP \(bu 2
99c8f35 Merge pull request \fI\%#50345\fP from dwoz/pub_d_logging
.INDENT 2.0
.IP \(bu 2
fd58523 Fix linter warnings
.IP \(bu 2
5e1db3c Fix ZMQ PubServer daemon logging works on winndows
.IP \(bu 2
8899832 Configure logging for ZMQ PubServer daemon
.UNINDENT
.IP \(bu 2
44f7af4 Merge pull request \fI\%#50350\fP from dubb\-b/2017.7
.INDENT 2.0
.IP \(bu 2
346a831 Updating the AMI\(aqs and sizes for the test run.
.UNINDENT
.IP \(bu 2
b947a18 Merge pull request \fI\%#50274\fP from rallytime/bp\-41472
.INDENT 2.0
.IP \(bu 2
0a1e607 When the minion key is denied by the master then exit status 77 (permission denied)
.UNINDENT
.IP \(bu 2
4725acd Merge pull request \fI\%#50195\fP from damon\-atkins/jenkins_pylint
.INDENT 2.0
.IP \(bu 2
eb13407 capture some extra info
.UNINDENT
.IP \(bu 2
ab8e845 Merge pull request \fI\%#50329\fP from twangboy/fix_cloud_winrm
.INDENT 2.0
.IP \(bu 2
cf5fb04 Check WinRM port before initiating connection
.UNINDENT
.IP \(bu 2
e535b38 Merge pull request \fI\%#50252\fP from dwoz/backport_fs_fix
.INDENT 2.0
.IP \(bu 2
59ac284 Do not allow age to be a negative number
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49523\fP: (\fI\%MTecknology\fP) [salt\-cloud] Non\-ascii chars cause an exception in salt\-cloud (refs: \fI\%#50146\fP, \fI\%#50236\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#50174\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50146\fP to 2018.3 (refs: \fI\%#50231\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50236\fP: (\fI\%rallytime\fP) Fix salt\-cloud UnicodeEncodeError when writing to stdout
@ \fI2018\-11\-05 22:04:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50235\fP: (\fI\%rallytime\fP) Don\(aqt encode the return values in utils/vt.py (refs: \fI\%#50236\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50231\fP: (\fI\%rallytime\fP) Revert \(dqBack\-port \fI\%#50146\fP to 2018.3\(dq (refs: \fI\%#50236\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50230\fP: (\fI\%rallytime\fP) Add various ssh tests to the filemap for salt/utils/vt.py changes (refs: \fI\%#50291\fP, \fI\%#50235\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50174\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50146\fP to 2018.3 (refs: \fI\%#50236\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50146\fP: (\fI\%MTecknology\fP) Improve handling of non\-ascii characters in terminal output. (Fixes: \fI\%#49523\fP) (refs: \fI\%#50235\fP, #\(gasaltstack/salt\(ga#50174\(ga_\(ga_, \fI\%#50174\fP, \fI\%#50231\fP, \fI\%#50236\fP)
.IP \(bu 2
46c7dc2d Merge pull request \fI\%#50236\fP from rallytime/fix\-cloud\-vt
.IP \(bu 2
c1984c9 Fix salt\-cloud UnicodeEncodeError when writing to stdout
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50062\fP: (\fI\%whytewolf\fP) max_event_size does not always trim large events.  (refs: \fI\%#50382\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50382\fP: (\fI\%garethgreenaway\fP) [2018.3] Fix to utils/dicttrim.py to honor max_event_size with nested dictionaries
@ \fI2018\-11\-05 20:04:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
ed4fa87 Merge pull request \fI\%#50382\fP from garethgreenaway/50062_max_event_size_does_not_always_trim_large_events
.IP \(bu 2
039f3d1 Increase limit for trimming.
.IP \(bu 2
7f77bfe Adding test for utils/dicttrim.py
.IP \(bu 2
9b55ac7 Adding _trim_dict_in_dict to utils/dictrim.py to be called from trim_dict when data contains a nested dictionary.  This will ensure that values will still be trimmed correctly.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50387\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50339\fP to 2018.3
@ \fI2018\-11\-05 20:03:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50339\fP: (\fI\%bartlaarhoven\fP) The driver requires dependency, not the other way around. (refs: \fI\%#50387\fP)
.IP \(bu 2
493d653 Merge pull request \fI\%#50387\fP from rallytime/bp\-50339
.IP \(bu 2
a3f264d Lint: Add extra blank line
.IP \(bu 2
bd18412 The driver requires dependency, not the other way around.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41342\fP: (\fI\%githubcdr\fP) beacons.state does not save as list (refs: \fI\%#50347\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50347\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to beacon state module
@ \fI2018\-11\-05 14:19:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
3022b7d Merge pull request \fI\%#50347\fP from garethgreenaway/41342_beacon_state_module_fixes
.IP \(bu 2
8885d1f Merge branch \(aq2018.3\(aq into 41342_beacon_state_module_fixes
.IP \(bu 2
c2354a9 Fixing beacon state test.  Adding a reset function to beacon module to clear out beacon configuration.  Useful for tests runs to ensure bits are left over between runs.
.IP \(bu 2
2390f47 Adding SaltReturnAssertsMixin back in
.IP \(bu 2
677d090 Remove zookeeper reference.
.IP \(bu 2
f3dee43 Updating the beacon state module to ensure that the format of the beacon data that is being sent along to the beacon execution module is in the right format.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41583\fP: (\fI\%seanjnkns\fP) mount.swap for swap file test=True results wrong (refs: \fI\%#50358\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50358\fP: (\fI\%garethgreenaway\fP) [2018.3] fixes to function mount.swap in mount state
@ \fI2018\-11\-05 14:16:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
929525a Merge pull request \fI\%#50358\fP from garethgreenaway/41583_mount_swap_test_true_wrong_results
.IP \(bu 2
b8ded8b Updating the swap function in the mount.swap function also check the device name when checking the fstab data.  Updating tests to reflect new behavior.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
d07c84d reordering ret dictionary in load test to ascending order
.IP \(bu 2
f704128 fixing type in load beacon module and adding option validators to config check function along with mock default values in test, fixes \fI\%#48343\fP
.IP \(bu 2
4114a4f fixing type in load beacon module and adding option validators to config check function along with mock default values in test
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49225\fP: (\fI\%onnodb\fP) [win_lgpo] lgpo_set always reports failure; Registry.pol corruption (refs: \fI\%#50006\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#48782\fP: (\fI\%mike2523\fP) [win_lgpo] Causes corrupt Registry.pol file (refs: \fI\%#50006\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50006\fP: (\fI\%lomeroe\fP) Correct more issues in lgpo
@ \fI2018\-11\-02 16:32:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ffa392 Merge pull request \fI\%#50006\fP from lomeroe/issue48782_2018.3
.IP \(bu 2
dc58252 update to use a single line if statement when dealing with prepended text
.IP \(bu 2
0e011ad add runTest method to class for PY2
.IP \(bu 2
377ec09 add a test for \fI\%#47784\fP
.IP \(bu 2
0a14505 change backslashes in comment string to fix lint error
.IP \(bu 2
02181d3 add fix/test for \fI\%#50079\fP
.IP \(bu 2
05f2951 more lint fixes
.IP \(bu 2
94b3335 lint fixes in test
.IP \(bu 2
2a79626 update test to actually work
.IP \(bu 2
42840ec add missing comma in function call
.IP \(bu 2
c283f50 Log a warning message instead of an exception when a SID cannot be converted to a username (for user rights assignments)
.IP \(bu 2
271bd70 capture and print exception information
.IP \(bu 2
bc94b8e update method for creating size field of **delvals items for py3 compatibility
.IP \(bu 2
d9fe28a fix clobbering of admx_search_results which was keeping some policies from being properly detected
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50340\fP: (\fI\%garethgreenaway\fP) [2018.3] Backporting \fI\%#48087\fP to 2018.3
@ \fI2018\-11\-01 18:15:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48087\fP: (\fI\%mat813\fP) Fix patching sysctl.conf on FreeBSD. (refs: \fI\%#50340\fP)
.IP \(bu 2
12de4b9 Merge pull request \fI\%#50340\fP from garethgreenaway/backport_48087_to_2018_3
.IP \(bu 2
56c87ff Backporting \fI\%#48087\fP to 2018.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50275\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49752\fP to 2018.3
@ \fI2018\-11\-01 16:50:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49752\fP: (\fI\%jodok\fP) add support for clonenum parameter (refs: \fI\%#50275\fP)
.IP \(bu 2
5e46434 Merge pull request \fI\%#50275\fP from rallytime/bp\-49752
.IP \(bu 2
e463d99 Merge branch \(aq2018.3\(aq into bp\-49752
.IP \(bu 2
1e10c6e add support for clonenum parameter
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47425\fP: (\fI\%raddessi\fP) states/netyang.managed ignores models when passed as a kwarg (refs: \fI\%#50301\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50316\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50301\fP to 2018.3
@ \fI2018\-11\-01 16:32:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50301\fP: (\fI\%tonybaloney\fP) Fixes issues raised in \fI\%#47425\fP for states.netyang (refs: \fI\%#50316\fP)
.IP \(bu 2
51e333a Merge pull request \fI\%#50316\fP from rallytime/bp\-50301
.IP \(bu 2
367b689 Merge pull request \fI\%#32\fP from tonybaloney/bp50301
.INDENT 2.0
.IP \(bu 2
529687a update test assertions
.UNINDENT
.IP \(bu 2
ba526ad remove unused import
.IP \(bu 2
220e57f create 2 simple unit tests for the netyang state module and fix issue in \fI\%#47425\fP
.IP \(bu 2
20bf306 reproduce bug in 47425
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50290\fP: (\fI\%twangboy\fP) Fix \fItest_state\fP for Windows
@ \fI2018\-10\-31 19:28:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
af1075b Merge pull request \fI\%#50290\fP from twangboy/fix_test_state
.IP \(bu 2
69c02fc Fix some lint and some typos
.IP \(bu 2
d184013 Fix typo
.IP \(bu 2
92b5ea0 Create salt util that copies file security info
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50050\fP: (\fI\%terminalmage\fP) Backport runtests.py\(aqs \-\-from\-filenames functionality to 2018.3 branch (refs: \fI\%#50308\fP, \fI\%#50291\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50291\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50230\fP to 2018.3
@ \fI2018\-10\-31 19:22:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50230\fP: (\fI\%rallytime\fP) Add various ssh tests to the filemap for salt/utils/vt.py changes (refs: \fI\%#50291\fP, \fI\%#50235\fP)
.IP \(bu 2
045d81c Merge pull request \fI\%#50291\fP from rallytime/bp\-50230
.IP \(bu 2
1aae681 Merge branch \(aq2018.3\(aq into bp\-50230
.IP \(bu 2
1ef712a Add various ssh tests to the filemap for salt/utils/vt.py changes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50315\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.3 to 2018.3
@ \fI2018\-10\-31 14:16:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
00437aa Merge pull request \fI\%#50315\fP from rallytime/merge\-2018.3
.IP \(bu 2
422465e Merge branch \(aq2018.3.3\(aq into \(aq2018.3\(aq
.IP \(bu 2
4d9e2a0 Merge pull request \fI\%#50088\fP from vulnbe/fix\-incorrect\-id\-handling\-2018\-3\-3
.IP \(bu 2
619f2f2 Fix incorrect id handling in file state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50309\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-10\-30 16:07:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
84ee7a3 Merge pull request \fI\%#50309\fP from rallytime/merge\-2018.3
.IP \(bu 2
381a59d Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
11fa33e Merge pull request \fI\%#50295\fP from dubb\-b/remove\-cloud\-change
.INDENT 2.0
.IP \(bu 2
80982ad Removing an un needed change and maybe fixing the lint error
.UNINDENT
.IP \(bu 2
e00c507 Merge pull request \fI\%#50287\fP from whytewolf/boto_vpc
.INDENT 2.0
.IP \(bu 2
5a39644 minor correction to boto_vpc.route_table_present example, subnet_names was on wrong indent level
.UNINDENT
.IP \(bu 2
37ae06c Merge pull request \fI\%#50280\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
5808074 fix InstallRequirement.from_line for pip 18.1
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50050\fP: (\fI\%terminalmage\fP) Backport runtests.py\(aqs \-\-from\-filenames functionality to 2018.3 branch (refs: \fI\%#50308\fP, \fI\%#50291\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50308\fP: (\fI\%rallytime\fP) Fix matcher grain file
@ \fI2018\-10\-30 15:27:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50182\fP: (\fI\%terminalmage\fP) Backport runtests.py modifications from develop to 2018.3 (refs: \fI\%#50308\fP)
.IP \(bu 2
b805bab Merge pull request \fI\%#50308\fP from rallytime/test\-fixes
.IP \(bu 2
f238522 Fix matcher grain file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50270\fP: (\fI\%terrible\-broom\fP) apt: speedup installing packages with \(aq>=\(aq or \(aq<=\(aq and reduced memory…
@ \fI2018\-10\-30 13:24:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
57fe6cd Merge pull request \fI\%#50270\fP from terrible\-broom/feature/apt\-cache\-show\-instead\-of\-dump
.IP \(bu 2
6c1b05a Lint: add extra blank line
.IP \(bu 2
a4df706 fix review notes
.IP \(bu 2
d059edd apt: speedup installing packages with \(aq>=\(aq or \(aq<=\(aq and reduced memory consumption
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50293\fP: (\fI\%gtmanfred\fP) update jenkins version for 2018.3
@ \fI2018\-10\-29 23:39:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a65402 Merge pull request \fI\%#50293\fP from saltstack/jenkins
.IP \(bu 2
fe6fbc4 update jenkins version for 2018.3
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-jenkins#1182\fP: (\fI\%gtmanfred\fP) clean up salt.utils for using 2018.3.3 (refs: \fI\%#50289\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50289\fP: (\fI\%gtmanfred\fP) ignore empty line in localectl status output
@ \fI2018\-10\-29 21:39:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
935f181 Merge pull request \fI\%#50289\fP from gtmanfred/2018.3
.IP \(bu 2
fb43061 fix test
.IP \(bu 2
5eb0e37 add extra space to localemod test
.IP \(bu 2
e8dc8ba if line in output of localectl is empty, ignore it
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50276\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-10\-29 19:05:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
10ba8b4 Merge pull request \fI\%#50276\fP from rallytime/merge\-2018.3
.IP \(bu 2
f05abb0 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
6ae8a33 Merge pull request \fI\%#50281\fP from dubb\-b/add_subnet
.INDENT 2.0
.IP \(bu 2
4fdcf7c Lint: Add extra blank line
.IP \(bu 2
cebfd8a Fixing lint error
.IP \(bu 2
0da6301 Merge branch \(aq2017.7\(aq of \fI\%https://github.com/saltstack/salt\fP into add_subnet
.IP \(bu 2
2df6115 Adding subnetID so it knows the right VPC to build the node in.
.UNINDENT
.UNINDENT
.IP \(bu 2
a0cfbdc Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
b94a43b Merge pull request \fI\%#50184\fP from ethanculler/fix\-minion\-return\-exception\-with\-return
.INDENT 2.0
.IP \(bu 2
283d41c Merge branch \(aq2017.7\(aq into fix\-minion\-return\-exception\-with\-return
.IP \(bu 2
a4e54d7 Added handling for minion return exceptions containing the word \(dqreturn\(dq
.UNINDENT
.IP \(bu 2
6b009b4 Merge pull request \fI\%#50258\fP from dubb\-b/fix_cloud_ec2
.INDENT 2.0
.IP \(bu 2
6a1e9f0 Adding securitygroupname as the config instead of securitygroup
.UNINDENT
.IP \(bu 2
3e1aac9 Merge pull request \fI\%#50251\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
061e599 bump salt version to 2017.7.8
.UNINDENT
.IP \(bu 2
fe9bc81 Merge pull request \fI\%#50233\fP from Ch3LL/bp\-50232
.INDENT 2.0
.IP \(bu 2
f83460d change order of search engine ids
.IP \(bu 2
bf3f217 Update search engine IDs for releases
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50282\fP: (\fI\%twangboy\fP) Fix \fIunit.beacons.test_diskusage\fP on Windows
@ \fI2018\-10\-29 18:37:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
0f1dc08 Merge pull request \fI\%#50282\fP from twangboy/fix_test_diskusage
.IP \(bu 2
fd369dd Mock is_windows = False
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50182\fP: (\fI\%terminalmage\fP) Backport runtests.py modifications from develop to 2018.3 (refs: \fI\%#50308\fP)
@ \fI2018\-10\-29 16:25:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
f7c2f04 Merge pull request \fI\%#50182\fP from terminalmage/issue50050
.IP \(bu 2
113d76e Revert \(dqMove jinja templating tests alongside salt/utils/jinja.py\(aqs tests\(dq
.IP \(bu 2
3057ca4 Lint fix: add extra blank line in core.py
.IP \(bu 2
8968f9d Revert \(dqRename test_map_conf test file to respect naming convention\(dq
.IP \(bu 2
85a9395 Remove saltclass pillar unit test for list expansion
.IP \(bu 2
3d95673 Use get_config_dir() instead of self.config_dir
.IP \(bu 2
e8b3a62 Add init file back in for unit/client pkg
.IP \(bu 2
d527dd2 Rename states/test_libvirt.py into states/test_virt.py
.IP \(bu 2
ab4a670 Remove pgjsonb returner unit tests
.IP \(bu 2
68ab3ee Remove \(dqtest_custom\(dq from grains section of filename_map
.IP \(bu 2
6814698 Remove test_error from scheduler tests
.IP \(bu 2
c55dcf0 Add init file back in for integration/cloud/clouds pkg
.IP \(bu 2
f485b4a enable testing only filemaps
.IP \(bu 2
dfa05b9 Remove test files for beacons that don\(aqt exist in 2018.3
.IP \(bu 2
85612cf runtests.py: Fix IndexError in \-\-from\-filenames
.IP \(bu 2
25097f9 Make sure from\-filenames intersect with names\-file
.IP \(bu 2
ed864ce runtests.py: Accept modified file list from a text file
.IP \(bu 2
059754c Add some doc tests to the filemap that should run on every PR
.IP \(bu 2
b1ee2e5 Set a default value for the filename map path
.IP \(bu 2
5ea1024 Add documentation explaining naming convention for test files
.IP \(bu 2
8f790c0 Fix conflicting dict key in filename map
.IP \(bu 2
f2e5512 Evan Moar Lint
.IP \(bu 2
65fef9a Moar Lint
.IP \(bu 2
39c2455 Lint
.IP \(bu 2
dd20f12 Make sure we always run the module names test
.IP \(bu 2
2ac939e Add test to check test module names and make sure they match the naming convention
.IP \(bu 2
785d298 Add integration.netapi.rest_tornado.test_app to filename map
.IP \(bu 2
662ca0d Rename files to match naming convention
.IP \(bu 2
186d333 Add back changes lost in cherry\-pick
.IP \(bu 2
a236531 Add back test accidentally deleted when cherry\-picking
.IP \(bu 2
eaa4da3 Rename providers to clouds to respect naming convention
.IP \(bu 2
85b96de Rename some files to avoid them being identified as test modules
.IP \(bu 2
bfb6015 Rename/consolidate salt.utils unit tests to conform to naming convention
.IP \(bu 2
84749dd Consolitdate and move salt\-ssh unit tests to proper location
.IP \(bu 2
71825a5 Consolidate and move loader tests to test/unit/test_loader.py
.IP \(bu 2
8326a09 Rename test_map_conf test file to respect naming convention
.IP \(bu 2
6d9c2eb Move jinja templating tests alongside salt/utils/jinja.py\(aqs tests
.IP \(bu 2
1ef43a3 Add additional paths to the filename map
.IP \(bu 2
75e6731 Use the new helper to get the test mods
.IP \(bu 2
c3dc8ec Add function to get all of the test modules
.IP \(bu 2
c5593bc Rename custom_grains.py so it\(aqs not identified as a test module
.IP \(bu 2
330c211 Consolidate saltclass pillar unit tests into single module
.IP \(bu 2
a642619 Rename test pgjsonb returner test file to match naming convention
.IP \(bu 2
6433c48 Don\(aqt import old module name
.IP \(bu 2
a97e032 Move helper outside of for loop
.IP \(bu 2
3f1b6fd Add more unit test mapping
.IP \(bu 2
ac3406d Fill out the filename map a bit
.IP \(bu 2
07d6f2a Enhancements to \-\-from\-filenames, \-\-filename\-map options
.IP \(bu 2
b851a41 Don\(aqt run unit or integration tests unnecessarily
.IP \(bu 2
569276b Add an initial filename_map
.IP \(bu 2
44199b1 Add \-\-from\-filenames and \-\-filename\-map options to parser
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50267\fP: (\fI\%m03\fP) Fix missing aptly config paths
@ \fI2018\-10\-29 13:27:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
1e8b092 Merge pull request \fI\%#50267\fP from m03/fix\-aptly\-config\-paths\-20183
.IP \(bu 2
319bb31 Fix missing aptly config paths
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50232\fP: (\fI\%Ch3LL\fP) Update search engine IDs for releases (refs: \fI\%#50233\fP)
@ \fI2018\-10\-25 20:15:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab0b022 Merge pull request \fI\%#50232\fP from Ch3LL/search_latest
.IP \(bu 2
3452d9b change order of search engine ids
.IP \(bu 2
c9546df Update search engine IDs for releases
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49523\fP: (\fI\%MTecknology\fP) [salt\-cloud] Non\-ascii chars cause an exception in salt\-cloud (refs: \fI\%#50146\fP, \fI\%#50236\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#50174\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50146\fP to 2018.3 (refs: \fI\%#50231\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50231\fP: (\fI\%rallytime\fP) Revert \(dqBack\-port \fI\%#50146\fP to 2018.3\(dq (refs: \fI\%#50236\fP)
@ \fI2018\-10\-25 20:12:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50146\fP: (\fI\%MTecknology\fP) Improve handling of non\-ascii characters in terminal output. (Fixes: \fI\%#49523\fP) (refs: \fI\%#50235\fP, #\(gasaltstack/salt\(ga#50174\(ga_\(ga_, \fI\%#50174\fP, \fI\%#50231\fP, \fI\%#50236\fP)
.IP \(bu 2
1c8cdf9 Merge pull request \fI\%#50231\fP from saltstack/revert\-50174\-bp\-50146
.IP \(bu 2
c76ac1b Revert \(dqBack\-port \fI\%#50146\fP to 2018.3\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50132\fP: (\fI\%ManicoW\fP) XCP\-ng packages and services management (refs: \fI\%#50140\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50172\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50140\fP to 2018.3
@ \fI2018\-10\-25 14:00:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50140\fP: (\fI\%ManicoW\fP) Adding XCP\-ng support (refs: \fI\%#50172\fP)
.IP \(bu 2
8dd4f43 Merge pull request \fI\%#50172\fP from rallytime/bp\-50140
.IP \(bu 2
02e0ea0 lint fix
.IP \(bu 2
819c46c fix lint errors and code factorization
.IP \(bu 2
8aa3598 Fix lint error
.IP \(bu 2
9092c4e Adding support for XCP\-ng
.IP \(bu 2
c516bc5 Adding XCP\-ng to os family map
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50063\fP: (\fI\%twangboy\fP) Use long when setting REG_QWORD
@ \fI2018\-10\-25 13:45:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
9ad43f2 Merge pull request \fI\%#50063\fP from twangboy/fix_50039
.IP \(bu 2
5fdba7d Disable lint error
.IP \(bu 2
84b8dd6 Add tests
.IP \(bu 2
4644bb6 Use long when setting REG_QWORD
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49965\fP: (\fI\%nkrishnakishor\fP) Beacon: Usage in windows (refs: \fI\%#50188\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50188\fP: (\fI\%garethgreenaway\fP) [2018.3] fixes to diskusage beacon
@ \fI2018\-10\-25 13:41:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
01b083e Merge pull request \fI\%#50188\fP from garethgreenaway/49965_beacon_diskusage_windows
.IP \(bu 2
1f0ab27 Merge branch \(aq2018.3\(aq into 49965_beacon_diskusage_windows
.IP \(bu 2
42b3203 Fixing lint
.IP \(bu 2
f65fa57 Fixing a bug in the diskusage beacon that prevented it from working on Windows.  Adding a couple tests to test functionality on Windows.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50214\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-10\-25 13:38:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
9ea51c0 Merge pull request \fI\%#50214\fP from rallytime/merge\-2018.3
.IP \(bu 2
897145c Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
017d394 Merge pull request \fI\%#50202\fP from Ch3LL/_2017.7.8
.INDENT 2.0
.IP \(bu 2
d520f9a Add tests with filname in token data
.IP \(bu 2
d45f6c7 Add empty token salt\-api integration tests
.IP \(bu 2
652dbf6 Ensure that tokens are hex to avoid hanging/errors in cherrypy
.UNINDENT
.IP \(bu 2
f28a4fa Merge pull request \fI\%#50211\fP from channias/fix\-spm\-modules\-install
.INDENT 2.0
.IP \(bu 2
9b203d5 Fix broken install of additional modules in SPM packages
.UNINDENT
.IP \(bu 2
6b4e07b Merge pull request \fI\%#50212\fP from dwoz/test_no_fail
.INDENT 2.0
.IP \(bu 2
7f613ac Do not fail if process already ended
.UNINDENT
.IP \(bu 2
85e22d2 Merge pull request \fI\%#50207\fP from Ch3LL/2update_version_doc_2017.7
.INDENT 2.0
.IP \(bu 2
198d25c Add 2017.7.8 previous release
.IP \(bu 2
d4e26ac Update release versions for the 2017.7 branch
.UNINDENT
.IP \(bu 2
d035695 Merge pull request \fI\%#50205\fP from Ch3LL/rn_2017.7.8
.INDENT 2.0
.IP \(bu 2
71ee68b [2017.7.8] remove in progress and add security details
.UNINDENT
.IP \(bu 2
ce341f2 Merge pull request \fI\%#50180\fP from max\-arnold/2017.7
.INDENT 2.0
.IP \(bu 2
881a521 Revert curly braces example for nested dictionaries
.UNINDENT
.IP \(bu 2
622bb51 Merge pull request \fI\%#50026\fP from damon\-atkins/jenkins_pylint
.INDENT 2.0
.IP \(bu 2
aebce88 Merge branch \(aq2017.7\(aq into jenkins_pylint
.IP \(bu 2
5f708fa use awk to create the other files, so git does not need to search again
.IP \(bu 2
6b96a24 Adjust jenkins linting process, only run stage if required, use git diff to find files, instead of find, report on status, changed and deleted files, lint only changed files.
.UNINDENT
.IP \(bu 2
aa66d1b Merge pull request \fI\%#50158\fP from vutny/doc/2017.7/fix\-http\-tutorial
.INDENT 2.0
.IP \(bu 2
fe2d70d [DOC] Fix JSON payload example in HTTP tutorial
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50162\fP: (\fI\%rbthomp\fP) Scheduled job runs in endless loop when using when: and  splay: together.  (refs: \fI\%#50216\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50216\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to scheduler, list of whens plus splay
@ \fI2018\-10\-25 13:31:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
51b3fa4 Merge pull request \fI\%#50216\fP from garethgreenaway/50162_when_plus_splay_endless_loop
.IP \(bu 2
685509f Fixing an issue when a combination of the when parameter as a list plus using the splay
parameter would cause the schedule to continuously run jobs in an endless loop, regardless of
if their scheduled time had been receached. Also fixing a related issue where scheduled jobs
that rely on _next_fire_time were not being run as the corrected splayed time but rather
running at the original scheduled time. Adding new tests.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50190\fP: (\fI\%dwoz\fP) Fix test_managed_file_with_grains_data on Windows
@ \fI2018\-10\-24 22:43:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
43303fb Merge pull request \fI\%#50190\fP from dwoz/grains_template_test
.IP \(bu 2
b77db48 Fix test_managed_file_with_grains_data on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50187\fP: (\fI\%garethgreenaway\fP) [2018.3] Adding fixes to scheduler tests to 2018.3
@ \fI2018\-10\-24 19:45:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49871\fP: (\fI\%garethgreenaway\fP) [fluorine] Updating scheduler tests for OS X (refs: \fI\%#50187\fP)
.IP \(bu 2
462314b Merge pull request \fI\%#50187\fP from garethgreenaway/port_49871_to_2018_3
.IP \(bu 2
25e7cb6 Merge branch \(aq2018.3\(aq into port_49871_to_2018_3
.IP \(bu 2
d232dfb Update test_eval.py
.IP \(bu 2
d8d8559 Fixing lint
.IP \(bu 2
76e6232 Removing unnecessary debugging lines
.IP \(bu 2
d2d0622 Back porting \fI\%#49871\fP to 2018.3.  Adding some additional changes to ensure they are passing on OS X.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50201\fP: (\fI\%Ch3LL\fP) [2018.3] Ensure that tokens are hex to avoid hanging/errors in cherrypy
@ \fI2018\-10\-24 19:44:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
8ad9a1b Merge pull request \fI\%#50201\fP from Ch3LL/_2018.3.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50208\fP: (\fI\%Ch3LL\fP)  Update release versions for the 2018.3 branch
@ \fI2018\-10\-24 15:52:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
88673ad Merge pull request \fI\%#50208\fP from Ch3LL/2update_version_doc_2018.3
.IP \(bu 2
cdbf493 Add 2017.7.8 previous release
.IP \(bu 2
6f775e7 Update release versions for the 2018.3 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50206\fP: (\fI\%Ch3LL\fP) [2018.3.3] remove in progress and add security details
@ \fI2018\-10\-24 15:50:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
db8ef1e Merge pull request \fI\%#50206\fP from Ch3LL/rn_2018.3.3
.IP \(bu 2
896caa1 Add 2016.11.10 release notes to 2018.3 branch
.IP \(bu 2
1e34158 [2018.3.3] remove in progress and add security details
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50200\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50181\fP to 2018.3
@ \fI2018\-10\-24 15:49:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50181\fP: (\fI\%cro\fP) Testinfra has a python packaging issue that is making version 1.17.0 fail to install some places (refs: \fI\%#50200\fP)
.IP \(bu 2
3d3db70 Merge pull request \fI\%#50200\fP from rallytime/bp\-50181
.IP \(bu 2
f3e5399 Ignore testinfra 1.17.0
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49523\fP: (\fI\%MTecknology\fP) [salt\-cloud] Non\-ascii chars cause an exception in salt\-cloud (refs: \fI\%#50146\fP, \fI\%#50236\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50174\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50146\fP to 2018.3 (refs: \fI\%#50236\fP)
@ \fI2018\-10\-23 18:16:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50146\fP: (\fI\%MTecknology\fP) Improve handling of non\-ascii characters in terminal output. (Fixes: \fI\%#49523\fP) (refs: \fI\%#50235\fP, #\(gasaltstack/salt\(ga#50174\(ga_\(ga_, \fI\%#50174\fP, \fI\%#50231\fP, \fI\%#50236\fP)
.IP \(bu 2
5f904dd Merge pull request \fI\%#50174\fP from rallytime/bp\-50146
.IP \(bu 2
601a5b8 Improve handling of non\-ascii characters in terminal output. (Fixes: \fI\%#49523\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50142\fP: (\fI\%m03\fP) stringutils.to_none AttributeError: \(aqmodule\(aq object has no attribute \(aqtex_type\(aq (refs: \fI\%#50143\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50173\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50143\fP to 2018.3
@ \fI2018\-10\-23 17:13:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50143\fP: (\fI\%m03\fP) Fix \fI\%#50142\fP, stringutils.to_none (refs: \fI\%#50173\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45429\fP: (\fI\%terminalmage\fP) [PY3] Add unicode_literals to salt.utils modules (R\-S) (refs: \fI\%#50143\fP)
.IP \(bu 2
1cd0339 Merge pull request \fI\%#50173\fP from rallytime/bp\-50143
.IP \(bu 2
f5d6080 Add test_to_none
.IP \(bu 2
c0ce36b Fix \fI\%#50142\fP, stringutils.to_none
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50171\fP: (\fI\%terminalmage\fP) Fix invalid RST link in docker_network docs
@ \fI2018\-10\-23 13:40:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
9331f1e Merge pull request \fI\%#50171\fP from terminalmage/docs
.IP \(bu 2
7ea1d6c Fix invalid RST link in docker_network docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50161\fP: (\fI\%rmarcinik\fP) Add a missing result for task.info
@ \fI2018\-10\-23 13:31:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
16eece3 Merge pull request \fI\%#50161\fP from rmarcinik/patch\-1
.IP \(bu 2
9848f06 Add a missing result for task.info
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50136\fP: (\fI\%terminalmage\fP) Add some debug logging before and after states gather pillar data
@ \fI2018\-10\-22 14:40:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
28bc5e3 Merge pull request \fI\%#50136\fP from terminalmage/debug\-logging
.IP \(bu 2
8592a0b Add some debug logging before and after states gather pillar data
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50129\fP: (\fI\%kmatsoukas\fP) Call to network.get_route fails when interface name contains a dash (refs: \fI\%#50147\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50147\fP: (\fI\%garethgreenaway\fP) [2018.3] Fix to modules/network.py
@ \fI2018\-10\-22 14:31:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
593c7ff Merge pull request \fI\%#50147\fP from garethgreenaway/50129_network_get_route_fails_dash_in_name
.IP \(bu 2
8fa87e3 Update test_network.py
.IP \(bu 2
3117969 Fixing scenario where the interface for the default route has a dash in it, regular expression used in get_route currently doesn\(aqt not account for this..  Adding some additional tests for network.get_route.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50156\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-10\-22 14:24:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
5c7a7d9 Merge pull request \fI\%#50156\fP from rallytime/merge\-2018.3
.IP \(bu 2
87e20fd Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
1a90c4f Merge pull request \fI\%#50144\fP from dwoz/winrm_fs_release
.INDENT 2.0
.IP \(bu 2
0951d85 Use newest winrm\-fs release
.UNINDENT
.IP \(bu 2
e096560 Merge pull request \fI\%#50113\fP from rallytime/bp\-49989
.INDENT 2.0
.IP \(bu 2
27c7ac9 Increase centos7\-py2 kitchen pr timeout to 8 hours
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50148\fP: (\fI\%MTecknology\fP) Proxmox fixups
@ \fI2018\-10\-22 11:55:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce375f4 Merge pull request \fI\%#50148\fP from MTecknology/proxmox\-fixups
.IP \(bu 2
4959947 Race condition still exists at one second timeout.
.IP \(bu 2
3a62f74 Add support for setting root ssh pubkey to proxmox containers.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50085\fP: (\fI\%dwoz\fP) Fix \fItest_win_pkg\fP yet again
@ \fI2018\-10\-19 18:16:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
0ece06e Merge pull request \fI\%#50085\fP from dwoz/win_pkg_redux
.IP \(bu 2
f22630e Merge branch \(aq2018.3\(aq into win_pkg_redux
.IP \(bu 2
0b033a6 Do not allow age to be a negative number
.IP \(bu 2
a24d8b8 Debug file list cache
.IP \(bu 2
9f5722a The test is not a flush problem
.IP \(bu 2
071f8a0 Add cache file name to list cache log
.IP \(bu 2
128c2c5 Flush and sync file contents
.IP \(bu 2
7d361d8 Add debug log when file list is returned from cache
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49980\fP: (\fI\%twangboy\fP) Add support for AddPrinterDrivers
@ \fI2018\-10\-19 13:19:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
0069247 Merge pull request \fI\%#49980\fP from twangboy/lgpo_add_printer_drivers
.IP \(bu 2
76c9301 Add support for AddPrinterDrivers
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50114\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50061\fP to 2018.3
@ \fI2018\-10\-19 11:46:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50061\fP: (\fI\%rongzeng54\fP) pkg.install bugfix (refs: \fI\%#50114\fP)
.IP \(bu 2
de23c83 Merge pull request \fI\%#50114\fP from rallytime/bp\-50061
.IP \(bu 2
1f09104 Add unit test for pkg.install with epoch
.IP \(bu 2
af253c6 pkg.install bugfix
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50074\fP: (\fI\%bigpick\fP) Arista EOS Salt Minion \- Debug Log Flooded with Repeated Message (refs: \fI\%#50115\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50115\fP: (\fI\%garethgreenaway\fP) [2018.3] Apply scheduler fixes and tests from \fI\%#49104\fP to 2018.3
@ \fI2018\-10\-19 11:45:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49104\fP: (\fI\%garethgreenaway\fP) [fluorine] Fixes to scheduler for jobs with seconds, minutes, etc. (refs: \fI\%#50115\fP)
.IP \(bu 2
9188bec Merge pull request \fI\%#50115\fP from garethgreenaway/apply_49104_to_2018_3
.IP \(bu 2
adb1e79 Apply scheduler fixes and tests from \fI\%#49104\fP to 2018.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50119\fP: (\fI\%terminalmage\fP) Squelch spurious errors logged in unit tests
@ \fI2018\-10\-19 11:42:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
e892042 Merge pull request \fI\%#50119\fP from terminalmage/boto\-tests
.IP \(bu 2
91812ff Squelch spurious errors logged in unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50120\fP: (\fI\%terminalmage\fP) Fix bad merge conflict resolution
@ \fI2018\-10\-19 11:38:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
35449b4 Merge pull request \fI\%#50120\fP from terminalmage/salt\-jenkins\-1137
.IP \(bu 2
1ddfd26 Fix bad merge conflict resolution
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50013\fP: (\fI\%Giandom\fP) Passed kwargs to db_exists in db_remove method
@ \fI2018\-10\-18 11:28:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
5123488 Merge pull request \fI\%#50013\fP from Giandom/2018.3
.IP \(bu 2
9c91df3 Merge branch \(aq2018.3\(aq into 2018.3
.IP \(bu 2
06bb245 Merge branch \(aq2018.3\(aq into 2018.3
.IP \(bu 2
04a99e0 Passed kwargs to db_remove
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50092\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-10\-17 19:57:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
aa94f60 Merge pull request \fI\%#50092\fP from rallytime/merge\-2018.3
.IP \(bu 2
8609064 Update old utils paths to use new paths
.IP \(bu 2
a984ad8 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
7ec3840 Merge pull request \fI\%#49794\fP from twangboy/fix_groupadd_test
.INDENT 2.0
.IP \(bu 2
3d3b67d Gate for Windows
.IP \(bu 2
decfa52 Check value of result instead of entire dict
.UNINDENT
.IP \(bu 2
e562838 Merge pull request \fI\%#50028\fP from basseed/fix\-windows\-virtual\-grain
.INDENT 2.0
.IP \(bu 2
8129ac6 removed whitespaces
.IP \(bu 2
82fa866 Fix \fI\%#50015\fP, Windows grain defaults to physical as unix grain
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#50073\fP: (\fI\%jorotenev\fP) boto_cloudfront update distribution fails (refs: \fI\%#50082\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50082\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixing a typo in the boto_cloudfront
@ \fI2018\-10\-17 19:35:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
d1f2c5d Merge pull request \fI\%#50082\fP from garethgreenaway/50073_fixing_typo_boto_cloudfront
.IP \(bu 2
b5b90a1 Fixing a typo in the boto_cloudfront.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50090\fP: (\fI\%garethgreenaway\fP) [2018.3] Fix to utils/vault.py
@ \fI2018\-10\-17 13:57:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
05bd2a0 Merge pull request \fI\%#50090\fP from garethgreenaway/fix_vault_sdb_runner_test
.IP \(bu 2
444a4e5 Merge branch \(aq2018.3\(aq into fix_vault_sdb_runner_test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49275\fP: (\fI\%dgengtek\fP) execution module cp.cache_file fails with error \(aqinvalid arguments to setopt\(aq (refs: \fI\%#50080\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50080\fP: (\fI\%terminalmage\fP) Ensure all string kwargs passed to Tornado\(aqs httpclient are str types
@ \fI2018\-10\-16 21:01:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
7092879 Merge pull request \fI\%#50080\fP from terminalmage/issue49275
.IP \(bu 2
4a6c327 Ensure all string kwargs passed to Tornado\(aqs httpclient are str types
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44979\fP: (\fI\%hunkeelin\fP) Firewalld state cause horrid performance during saltrun.  (refs: \fI\%#49811\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49811\fP: (\fI\%nhavens\fP) Optimize firewalld state
@ \fI2018\-10\-16 11:26:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
45b6da3 Merge pull request \fI\%#49811\fP from nhavens/optimize\-firewalld\-state
.IP \(bu 2
7d6e628 Merge branch \(aq2018.3\(aq into optimize\-firewalld\-state
.IP \(bu 2
a718b0c Merge branch \(aq2018.3\(aq into optimize\-firewalld\-state
.IP \(bu 2
f7299b9 Merge branch \(aq2018.3\(aq into optimize\-firewalld\-state
.IP \(bu 2
f289618 Merge branch \(aq2018.3\(aq into optimize\-firewalld\-state
.IP \(bu 2
41af513 Merge branch \(aq2018.3\(aq into optimize\-firewalld\-state
.IP \(bu 2
7cebab4 Merge branch \(aq2018.3\(aq into optimize\-firewalld\-state
.IP \(bu 2
c38bb7d Merge branch \(aq2018.3\(aq into optimize\-firewalld\-state
.IP \(bu 2
abed058 Merge branch \(aq2018.3\(aq into optimize\-firewalld\-state
.IP \(bu 2
0ec1f82 Merge branch \(aq2018.3\(aq into optimize\-firewalld\-state
.IP \(bu 2
db6b23b Merge branch \(aq2018.3\(aq into optimize\-firewalld\-state
.IP \(bu 2
4ca7e12 Merge branch \(aq2018.3\(aq into optimize\-firewalld\-state
.IP \(bu 2
4f7c914 fix invalid icmp type handling in firewalld state
.IP \(bu 2
2d2e2eb resolve lint error in firewalld state
.IP \(bu 2
081424d resolve indentation issues in updates to firewalld state
.IP \(bu 2
c92c4fe optimize firewalld.present rich rule handling
.IP \(bu 2
25d1daf optimize firewalld.present source handling
.IP \(bu 2
5f62c14 optimize firewalld.present interface handling
.IP \(bu 2
69f2c6c optimize firewalld.present service handling
.IP \(bu 2
71ec8e7 optimize firewalld.present port forward handling
.IP \(bu 2
f18e09e optimize firewalld.present open port handling
.IP \(bu 2
35193dc clean up firewalld.present masquerade code (DRY)
.IP \(bu 2
8c88784 optimize firewalld.present icmp block handling
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50055\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50024\fP to 2018.3
@ \fI2018\-10\-16 09:14:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50024\fP: (\fI\%rwaweber\fP) docs: Correct napalm topic spelling mistake and smooth out sentence (refs: \fI\%#50055\fP)
.IP \(bu 2
b94e0a0 Merge pull request \fI\%#50055\fP from rallytime/bp\-50024
.IP \(bu 2
1ea72a0 docs: Correct spelling mistake and smooth out sentence
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50056\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50029\fP to 2018.3
@ \fI2018\-10\-16 09:12:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50029\fP: (\fI\%thebluesnevrdie\fP) Expose docs for Ansible modules (refs: \fI\%#50056\fP)
.IP \(bu 2
14f3fac Merge pull request \fI\%#50056\fP from rallytime/bp\-50029
.IP \(bu 2
2e46a78 Expose docs for Ansible modules
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50064\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50022\fP to 2018.3
@ \fI2018\-10\-16 09:09:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50022\fP: (\fI\%bluesliverx\fP) Make test check_pillar more lenient (refs: \fI\%#50064\fP)
.IP \(bu 2
f3fe4b6 Merge pull request \fI\%#50064\fP from rallytime/bp\-50022
.IP \(bu 2
40da3ce Make test check_pillar more lenient
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49988\fP: (\fI\%whytewolf\fP) currently http error logging of urls contains full URL including passwords.  (refs: \fI\%#50066\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50066\fP: (\fI\%garethgreenaway\fP) [2018.3] Redact any passwords from source paths
@ \fI2018\-10\-16 09:08:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
c2a46ce Merge pull request \fI\%#50066\fP from garethgreenaway/49988_redact_passwords_in_source
.IP \(bu 2
27ef1e0 Redact any passwords that are in http/https based source paths.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50068\fP: (\fI\%garethgreenaway\fP) [2018.3] Updating salt.utils.mac_utils
@ \fI2018\-10\-16 09:07:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab2cb51 Merge pull request \fI\%#50068\fP from garethgreenaway/1140_mac_system_tests_2018_3_failing
.IP \(bu 2
eedeacb Updating another reference to salt.utils.mac_utils to use __utils__
.IP \(bu 2
6ef5ce4 Due to a previous PR the test_sdb_runner in sdb.test_vault was failing because of a
exception that was being swallowed in the test run_run function. The cause was that when vault
related functions were being run, if they were being run on the master then they were being
forced to run through the _get_token_and_url_from_master() function, which is pull the id
element out of the grains dictionary. When the call was taking place from a runner, the
exception was popping up since there is no id when called from a runner. This fix checks to see
if the id exists in the dictionary first, if it is there then _get_token_and_url_from_master()
is called, otherwise _use_local_config is called.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49987\fP: (\fI\%terminalmage\fP) Make Pillar no longer munge file_roots
@ \fI2018\-10\-15 21:58:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
4c4bb5a Merge pull request \fI\%#49987\fP from terminalmage/pillar_roots
.IP \(bu 2
f59506d Update tests to reflect behavior changes
.IP \(bu 2
58f5fde Make Pillar no longer munge file_roots
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50065\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50044\fP to 2018.3
@ \fI2018\-10\-15 21:32:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50044\fP: (\fI\%mchugh19\fP) add saltclass info from release notes to docs (refs: \fI\%#50065\fP)
.IP \(bu 2
1e377ac Merge pull request \fI\%#50065\fP from rallytime/bp\-50044
.IP \(bu 2
1eaaab7 Doc title formatting must match doc name length
.IP \(bu 2
6ac26b6 add saltclass docs from release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50038\fP: (\fI\%s0undt3ch\fP) Don\(aqt squash the traceback
@ \fI2018\-10\-15 20:36:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
8a6b435 Merge pull request \fI\%#50038\fP from s0undt3ch/2018.3
.IP \(bu 2
852257a Don\(aqt squash the traceback
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50054\fP: (\fI\%rallytime\fP) Back\-port \fI\%#50004\fP to 2018.3
@ \fI2018\-10\-15 20:36:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#50004\fP: (\fI\%kiemlicz\fP) \fI\%https://github.com/saltstack/salt/issues/49883\fP (refs: \fI\%#50054\fP)
.IP \(bu 2
dbfd7ee Merge pull request \fI\%#50054\fP from rallytime/bp\-50004
.IP \(bu 2
88e3202 \fI\%https://github.com/saltstack/salt/issues/49883\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50057\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-10\-15 20:35:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
a9e9974 Merge pull request \fI\%#50057\fP from rallytime/merge\-2018.3
.IP \(bu 2
1b5b018 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
9eb17ea Merge pull request \fI\%#50047\fP from rallytime/bp\-49605
.INDENT 2.0
.IP \(bu 2
e3a0f7b Add gce fix to 2017.7.9 release notes
.IP \(bu 2
e6d86fc document GCE instance credentials configuration
.IP \(bu 2
c3a0d1b allow empty service_account_private_key in GCE driver
.UNINDENT
.IP \(bu 2
6cdd390 Merge pull request \fI\%#50017\fP from gtmanfred/iptables
.INDENT 2.0
.IP \(bu 2
e552e4f Use parse_known_args when checking iptables rules
.UNINDENT
.IP \(bu 2
a6a66b9 Merge pull request \fI\%#50012\fP from dwoz/norm_log
.INDENT 2.0
.IP \(bu 2
f96b29d Use normal log formatting and add jid
.UNINDENT
.IP \(bu 2
15f86b2 Merge pull request \fI\%#50001\fP from kyentei/doc\-fix\-gpg
.INDENT 2.0
.IP \(bu 2
3d6ee3e Fix gpg state Documentation
.UNINDENT
.IP \(bu 2
7a235d7 Merge pull request \fI\%#50000\fP from kyentei/doc\-fix\-lvm
.INDENT 2.0
.IP \(bu 2
c2f3d87 Fix LVM state documentation
.UNINDENT
.IP \(bu 2
4edd094 Merge pull request \fI\%#49999\fP from kyentei/doc\-fix\-proxy
.INDENT 2.0
.IP \(bu 2
a180ed7 Fix proxy documentation
.UNINDENT
.IP \(bu 2
58d2302 Merge pull request \fI\%#49998\fP from kyentei/doc\-fix\-process
.INDENT 2.0
.IP \(bu 2
edd4f40 Fix documentation on process.py
.UNINDENT
.IP \(bu 2
411635b Merge pull request \fI\%#49997\fP from kyentei/doc\-fix\-mysql
.INDENT 2.0
.IP \(bu 2
01059cc Fix documentation for mysql processlist
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#50060\fP: (\fI\%rallytime\fP) [2018.3] Fix some pylint issues that have popped up recently
@ \fI2018\-10\-15 20:35:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
f1bcb1f Merge pull request \fI\%#50060\fP from rallytime/fix\-lint
.IP \(bu 2
a8f4f39 Merge branch \(aq2018.3\(aq into fix\-lint
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49927\fP: (\fI\%thetaurean\fP) File Tree external pillar fails to render templates in python 3 (refs: \fI\%#49943\fP)
.IP \(bu 2
\fBPR\fP \fI\%#50052\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49943\fP to 2018.3
@ \fI2018\-10\-15 20:06:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49943\fP: (\fI\%thetaurean\fP) Coerce string  when calling compile_template_str (refs: \fI\%#50052\fP)
.IP \(bu 2
b26b21c Merge pull request \fI\%#50052\fP from rallytime/bp\-49943
.IP \(bu 2
d336dec Handle non\-ASCII chars during template data decode
.IP \(bu 2
435afb7 Adjusted import to expose stringutils namespace
.IP \(bu 2
958c630 Coerce string  when calling compile_template_str
.IP \(bu 2
e73f13d [2018.3] Fix some pylint issues that have popped up recently
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49809\fP: (\fI\%Ch3LL\fP) Add additional asserts to help investigate test_win_pkg failure
@ \fI2018\-10\-13 18:00:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
fef7669 Merge pull request \fI\%#49809\fP from Ch3LL/win_pkg_flaky
.IP \(bu 2
f795b60 Merge pull request \fI\%#7\fP from dwoz/win_pkg_flaky
.INDENT 2.0
.IP \(bu 2
beaab2a Fix win_pkg test
.UNINDENT
.IP \(bu 2
75809b4 Merge pull request \fI\%#6\fP from dwoz/win_pkg_flaky
.INDENT 2.0
.IP \(bu 2
e5ea3f1 Try running fsync to avoid fs caching race condition
.UNINDENT
.IP \(bu 2
fd5e842 Merge pull request \fI\%#5\fP from dwoz/win_pkg_flaky
.INDENT 2.0
.IP \(bu 2
c386826 Log results of cache_dir for now
.UNINDENT
.IP \(bu 2
2cd4058 Merge pull request \fI\%#4\fP from dwoz/win_pkg_flaky
.INDENT 2.0
.IP \(bu 2
1005b91 Debug win_pkg
.UNINDENT
.IP \(bu 2
9dce5cc Fix the assertion message order
.IP \(bu 2
18e9a28 Add additional asserts to help investigate test_win_pkg failure
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49983\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-10\-11 13:27:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
8949873 Merge pull request \fI\%#49983\fP from rallytime/merge\-2018.3
.IP \(bu 2
f8e73e8 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
a8a3811 Merge pull request \fI\%#49972\fP from rallytime/release\-notes\-2017.7.9
.INDENT 2.0
.IP \(bu 2
6c00003 Add 2017.7.9 release notes file
.UNINDENT
.IP \(bu 2
8de58d6 Merge pull request \fI\%#49974\fP from rallytime/bp\-49940
.INDENT 2.0
.IP \(bu 2
a70358a Update mod_watch() description for all states.
.IP \(bu 2
bf3d064 Another attempt to clean up service.mod_watch description.
.IP \(bu 2
165b799 Clean up documentation/language in service state. (Fixes \fI\%#40819\fP)
.UNINDENT
.IP \(bu 2
d68e5d3 Merge pull request \fI\%#49978\fP from whytewolf/inotify_doc_change
.INDENT 2.0
.IP \(bu 2
b4d9523 using an exclude list that does not list every operating system leaves open the possability that it would work on those not listed
.UNINDENT
.IP \(bu 2
89cbbb6 Merge pull request \fI\%#49934\fP from rallytime/fix\-49925
.INDENT 2.0
.IP \(bu 2
216fd64 Remove event_publisher_pub_hwm and salt_event_pub_hwm from documentation
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49979\fP: (\fI\%cachedout\fP) Update license date and include NOTICE
@ \fI2018\-10\-11 12:57:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
c7d2482 Merge pull request \fI\%#49979\fP from cachedout/license_update
.IP \(bu 2
b4f148e Break out support and contributing docs into separate files
.IP \(bu 2
1dd0e34 Update license date and include NOTICE
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49973\fP: (\fI\%rallytime\fP) Add 2018.3.4 release notes file
@ \fI2018\-10\-10 17:46:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
ef61fc6 Merge pull request \fI\%#49973\fP from rallytime/release\-notes\-2018.3.4
.IP \(bu 2
32e7d90 Add 2018.3.4 release notes file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49975\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49958\fP to 2018.3
@ \fI2018\-10\-10 17:44:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49958\fP: (\fI\%garethgreenaway\fP) [fluorine] Fixes to mac_system.py (refs: \fI\%#49975\fP)
.IP \(bu 2
7d8f10c Merge pull request \fI\%#49975\fP from rallytime/bp\-49958
.IP \(bu 2
a229a50 Swap the call for mac_utils.available_services to use __utils__ so mac_utils.available_services has access to __context__
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49946\fP: (\fI\%isbm\fP) osversion/osversion_info/osmajorrelease grains fixes
@ \fI2018\-10\-10 14:01:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
c912d3a Merge pull request \fI\%#49946\fP from isbm/isbm\-osversion_info\-fixes
.IP \(bu 2
a17ba35 Fix proper part name in the string\-bound CPE
.IP \(bu 2
9d49607 Expand unit test to verify part name
.IP \(bu 2
a6b7d01 Remove linebreak
.IP \(bu 2
5376886 Keep CPE_NAME only for opensuse series
.IP \(bu 2
8af3904 Add part parsing
.IP \(bu 2
e202b41 Prevent possible crash if CPE_NAME is wrongly written in the distro
.IP \(bu 2
712083d Add unit test for broken CPE_NAME
.IP \(bu 2
1306ddb Add unit test for v2.3 of CPE format
.IP \(bu 2
04b61d3 Add unit test for WFN format of CPE_NAME
.IP \(bu 2
035690f Override VERSION_ID from os\-release, if CPE_NAME is given
.IP \(bu 2
08e235b Remove unnecessary linebreak
.IP \(bu 2
853e163 Add CPE_NAME parsing
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48204\fP: (\fI\%zerthimon\fP) State mysql_user.present Exception with mysql 8.0.11 (refs: \fI\%#49918\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49918\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixes to MySQL module
@ \fI2018\-10\-10 14:00:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
18fb5df Merge pull request \fI\%#49918\fP from garethgreenaway/48204_mysql_user_password_exception_part_deux
.IP \(bu 2
92c0680 Merge branch \(aq2018.3\(aq into 48204_mysql_user_password_exception_part_deux
.IP \(bu 2
71e53a3 Cleanup of debugging.
.IP \(bu 2
dd96c13 Fixing lint.
.IP \(bu 2
ac7da89 Tweaking a couple tests to account for new scenarios with later versions.
.IP \(bu 2
4320c43 Removing __mysql_hash_password, no longer needed.
.IP \(bu 2
0475acf Removing unnecessary empty line.
.IP \(bu 2
9265195 Updating the mysql update to handle changes in version 8.0.11 where PASSWORD was removed.  Updating unit tests.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49961\fP: (\fI\%dmurphy18\fP) Fix aix grains test for prtconf present
@ \fI2018\-10\-10 13:38:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
1c2e5be Merge pull request \fI\%#49961\fP from dmurphy18/fix_aix_grains
.IP \(bu 2
f38d543 Correct test for AIX grains prtconf
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49205\fP: (\fI\%ereslibre\fP) Compound targeting includes unexpected targets in the result (refs: \fI\%#49897\fP, \fI\%#49907\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49907\fP: (\fI\%brejoc\fP) 2018.3 fix for list compound targeting
@ \fI2018\-10\-10 13:33:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49897\fP: (\fI\%brejoc\fP) 2017.7 fix for list compound targeting (refs: \fI\%#49907\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49435\fP: (\fI\%brejoc\fP) No longer passes missing in list compound engine (refs: \fI\%#49897\fP, \fI\%#49907\fP)
.IP \(bu 2
e427306 Merge pull request \fI\%#49907\fP from brejoc/2018.3\-fix\-for\-list\-compound\-targeting
.IP \(bu 2
1bcadb9 Merge branch \(aq2018.3\(aq into 2018.3\-fix\-for\-list\-compound\-targeting
.IP \(bu 2
649c46c Adds check for engine before adding the additional engine argument
.IP \(bu 2
7d0b20c Minor fix for def test_batch_run_grains_targeting
.IP \(bu 2
0d64716 Ignore missing minions only when excluding them with \(aqnot\(aq
.IP \(bu 2
6a5f3cd No longer passes missing in list compound engine
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48599\fP: (\fI\%angeloudy\fP) module ldap3 \(aqTypeError: (\(aqexpected a byte string in the list\(aq\(aq (refs: \fI\%#48666\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49947\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48666\fP to 2018.3
@ \fI2018\-10\-09 17:48:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48666\fP: (\fI\%angeloudy\fP) values need to be bytes when writing back to ldap (refs: \fI\%#49947\fP)
.IP \(bu 2
143c723 Merge pull request \fI\%#49947\fP from rallytime/bp\-48666
.IP \(bu 2
5166917 Update ldap3.py
.IP \(bu 2
05e55bd values need to be bytes when writing to ldap
.IP \(bu 2
0d749e6 values need to be bytes when writing back to ldap
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49948\fP: (\fI\%rallytime\fP) Skip pillar refresh test
@ \fI2018\-10\-09 15:20:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
dbf994e Merge pull request \fI\%#49948\fP from rallytime/skip\-flaky\-test
.IP \(bu 2
df11c39 Skip pillar refresh test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49938\fP: (\fI\%s0undt3ch\fP) Handle missing \fIpkg_resources\fP package
@ \fI2018\-10\-09 13:41:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
614d172 Merge pull request \fI\%#49938\fP from s0undt3ch/2018.3
.IP \(bu 2
b1c2928 Handle missing \fIpkg_resources\fP package
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49942\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-10\-09 13:38:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
bce12c3 Merge pull request \fI\%#49942\fP from rallytime/merge\-2018.3
.IP \(bu 2
91534ee Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
327796e Merge pull request \fI\%#49911\fP from dubb\-b/slack\-pr
.INDENT 2.0
.IP \(bu 2
57e630c Adding failure messages for PR.
.UNINDENT
.IP \(bu 2
cf1df79 Merge pull request \fI\%#49900\fP from dwoz/presence_wart
.INDENT 2.0
.IP \(bu 2
7bd34f6 Connect before processing presence
.UNINDENT
.IP \(bu 2
8c4707d Merge pull request \fI\%#49899\fP from twangboy/fix_49892
.INDENT 2.0
.IP \(bu 2
a66765f Remove arrInstalled artifact
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49930\fP: (\fI\%isbm\fP) Get os_family for RPM distros from the RPM macros
@ \fI2018\-10\-09 13:31:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
a30c053 Merge pull request \fI\%#49930\fP from isbm/isbm\-osarch\-bugfix
.IP \(bu 2
f8a75f1 Fix imports
.IP \(bu 2
70d3de0 Strip and stringify the return for the osarch
.IP \(bu 2
a248371 Get os_family for RPM distros from the RPM macros.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49868\fP: (\fI\%dwoz\fP) windows shell tests
@ \fI2018\-10\-08 17:32:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
99c5dba Merge pull request \fI\%#49868\fP from dwoz/shelltests
.IP \(bu 2
9997f45 Merge branch \(aq2018.3\(aq into shelltests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49875\fP: (\fI\%dwoz\fP) Add spm tests to Windows suite
@ \fI2018\-10\-05 18:13:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
eee82d3 Merge pull request \fI\%#49875\fP from dwoz/win_spm_tests
.IP \(bu 2
e76a751 Use os.path.split for more consistency
.IP \(bu 2
bc54d15 Fix wart in spm on windows
.IP \(bu 2
df5e271 Add spm tests for windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49872\fP: (\fI\%twangboy\fP) Fix issues with windows file permissions when using reset=True
@ \fI2018\-10\-05 13:52:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
c0e2404 Merge pull request \fI\%#49872\fP from twangboy/fix_49861
.IP \(bu 2
01bd847 Gate the win_function a little better
.IP \(bu 2
bcdb366 Skip on non\-windows systems
.IP \(bu 2
02f6335 Fix some lint
.IP \(bu 2
8ecbe0e Add tests for check_perms
.IP \(bu 2
d6e7512 Fix issues with file permissions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49582\fP: (\fI\%UtahDave\fP) lgpo doesn\(aqt seem to allow for unsetting a gpo setting (refs: \fI\%#49902\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#48661\fP: (\fI\%mike2523\fP) win_lgpo: User Rights Assignment policies (refs: \fI\%#49902\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49902\fP: (\fI\%lomeroe\fP) lgpo better comments on user right assignments
@ \fI2018\-10\-05 13:41:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
d3a909f Merge pull request \fI\%#49902\fP from lomeroe/issue48661_2018.3
.IP \(bu 2
760d8f4 Merge branch \(aq2018.3\(aq into issue48661_2018.3
.IP \(bu 2
f72ca81 add comments on user right assignment policies when they are already set and note if cumulative_rights_assignment is True that the particular user is already granted the right
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
75dd5ab Merge branch \(aq2018.3\(aq into shelltests
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49896\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-10\-04 21:00:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
4eb43af Merge pull request \fI\%#49896\fP from rallytime/merge\-2018.3
.IP \(bu 2
41c8b31 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
b959033 Merge pull request \fI\%#49739\fP from twangboy/fix_49660
.INDENT 2.0
.IP \(bu 2
f3400ad Merge branch \(aq2017.7\(aq into fix_49660
.IP \(bu 2
0a4f5fc Merge branch \(aq2017.7\(aq into fix_49660
.IP \(bu 2
1f9bbc8 Populate changes dictionary
.UNINDENT
.IP \(bu 2
71669bd Merge pull request \fI\%#49885\fP from dwoz/gemfile
.INDENT 2.0
.IP \(bu 2
791e3ff Use dwoz/winrm\-fs for chunked downloads
.IP \(bu 2
f3999e1 Move vagrant to its own group
.UNINDENT
.IP \(bu 2
0662e37 Merge pull request \fI\%#49870\fP from KaiSforza/ci_actually_fail
.INDENT 2.0
.IP \(bu 2
9ef9206 Actually catch the exception when we fail
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
19072f0 Use os.path.split for more consistency
.IP \(bu 2
6c22459 Merge remote\-tracking branch \(aqorigin/shelltests\(aq into shelltests
.INDENT 2.0
.IP \(bu 2
43b292f Merge branch \(aq2018.3\(aq into shelltests
.IP \(bu 2
876c040 Fix wart in test_cp module
.IP \(bu 2
9e6ff11 Add syndic tests to whitelist.txt for Windows
.IP \(bu 2
9cab293 Fix wart in spm on windows
.IP \(bu 2
58e9d1b Add spm tests to whitelist.txt for Windows
.IP \(bu 2
7393610 Add more shell integration tests to whitelist
.IP \(bu 2
ce85d60 Add shell.test_key to whitelist and fix wart
.IP \(bu 2
6fbadd7 Skip tests not valid on windows
.IP \(bu 2
9debf29 Add shell cp tests and fix them
.UNINDENT
.IP \(bu 2
8bfa634 Fix warts in integration.shell.test_matcher
.IP \(bu 2
45d2142 Fix wart in test_cp module
.IP \(bu 2
0e4fbc5 Add syndic tests to whitelist.txt for Windows
.IP \(bu 2
f72ad01 Fix wart in spm on windows
.IP \(bu 2
4141cc8 Add spm tests to whitelist.txt for Windows
.IP \(bu 2
02ad722 Add more shell integration tests to whitelist
.IP \(bu 2
48275c0 Add shell.test_key to whitelist and fix wart
.IP \(bu 2
e5edff4 Skip tests not valid on windows
.IP \(bu 2
a389729 Add shell cp tests and fix them
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49744\fP: (\fI\%MTecknology\fP) Group state cannot force empty group membership (refs: \fI\%#49745\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49745\fP: (\fI\%MTecknology\fP) Remove all users from group when members list is empty.
@ \fI2018\-10\-03 13:48:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
85478cd Merge pull request \fI\%#49745\fP from MTecknology/fix\-49744
.IP \(bu 2
61afb5d Merge branch \(aq2018.3\(aq into fix\-49744
.IP \(bu 2
269bde2 Merge branch \(aq2018.3\(aq into fix\-49744
.IP \(bu 2
0b5d916 Modify if structure, as requested.
.IP \(bu 2
f57ce67 Remove all users from group when members list is empty. (Fixes \fI\%#49744\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49867\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-10\-03 13:23:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
05cd56b Merge pull request \fI\%#49867\fP from rallytime/merge\-2018.3
.IP \(bu 2
b53c3e6 Update old utils paths to use new utils paths
.IP \(bu 2
a65c60d Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
7fa2043 Merge pull request \fI\%#49858\fP from Paulo\-Nunes/fix\-requisite\-doc
.INDENT 2.0
.IP \(bu 2
fb6f818 Edit requisite documentation
.UNINDENT
.IP \(bu 2
0587fbc Merge pull request \fI\%#49828\fP from dwoz/testslogencoding
.INDENT 2.0
.IP \(bu 2
2b323df Merge branch \(aq2017.7\(aq into testslogencoding
.IP \(bu 2
7ce1b64 Use utf\-8 encoding for salt\-runtests.log
.UNINDENT
.IP \(bu 2
15ccffd Merge pull request \fI\%#49848\fP from terminalmage/fix\-version\-rst\-2017.7
.INDENT 2.0
.IP \(bu 2
af2dddb Fix badly formatted versionadded directive
.UNINDENT
.IP \(bu 2
297031b Merge pull request \fI\%#49777\fP from terminalmage/issue49738
.INDENT 2.0
.IP \(bu 2
8a9945e Update test docstring to reflect switch to using SHA1
.IP \(bu 2
7ddfd72 Switch from base64 encoding to sha1 digest for unique cache filename
.IP \(bu 2
0e26dc6 Explicitly import salt.utils.hashutils
.IP \(bu 2
dca90d7 Skip parallel states test on Windows until we can get it to work
.IP \(bu 2
5a11067 Add additional info to the assert to aid in troubleshooting
.IP \(bu 2
cb19086 Remove/replace unnecessary setUp/tearDown
.IP \(bu 2
b3e9678 Fix parallel states with long ID dec or name
.UNINDENT
.IP \(bu 2
98c9372 Merge pull request \fI\%#49763\fP from twangboy/fix_49730
.INDENT 2.0
.IP \(bu 2
99bc8f1 Merge branch \(aq2017.7\(aq into fix_49730
.IP \(bu 2
7a9278b Fix broken tests, add new tests
.IP \(bu 2
2cd1509 Merge branch \(aq2017.7\(aq into fix_49730
.IP \(bu 2
defba1c Merge branch \(aq2017.7\(aq into fix_49730
.IP \(bu 2
af1ed1c Add/fix tests
.IP \(bu 2
5005a4d Only clear dns entries if you pass []
.IP \(bu 2
048561e Add ability to clear DNS entries on static DNS
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49876\fP: (\fI\%KaiSforza\fP) Actually catch the exception when we fail
@ \fI2018\-10\-03 12:26:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
42b540b Merge pull request \fI\%#49876\fP from KaiSforza/ci_actually_fail_2018
.IP \(bu 2
c88a81d Actually catch the exception when we fail
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49852\fP: (\fI\%terminalmage\fP) Rename logstash engine filename to make it work with the loader
@ \fI2018\-10\-02 17:42:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
1c8def9 Merge pull request \fI\%#49852\fP from terminalmage/issue49627
.IP \(bu 2
559cf1b Rename logstash engine filename to make it work with the loader
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49850\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49798\fP to 2018.3
@ \fI2018\-10\-02 17:40:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49798\fP: (\fI\%mattp\-\fP) saltnado: teach runner about full_return (refs: \fI\%#49850\fP)
.IP \(bu 2
675df25 Merge pull request \fI\%#49850\fP from rallytime/bp\-49798
.IP \(bu 2
4b6dcd7 saltnado: teach runner about full_return
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49204\fP: (\fI\%mchugh19\fP) file.directory state fails if directory contains an invalid symlink (refs: \fI\%#49209\fP, \fI\%#49827\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49846\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49650\fP and \fI\%#49827\fP to 2018.3
@ \fI2018\-10\-01 20:05:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49827\fP: (\fI\%dgmorrisjr\fP) fixing mis\-spelling of lattrs in file.py, referencing \fI\%#49204\fP  (refs: \fI\%#49846\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49650\fP: (\fI\%Yxnt\fP) fix aliyun cloud typeerror (refs: \fI\%#49846\fP)
.IP \(bu 2
93d064a Merge pull request \fI\%#49846\fP from rallytime/bp\-49650
.IP \(bu 2
fb7fed7 referencing \fI\%#49204\fP, fixing mis\-spelling of lattrs on line 4514 per request from @gtmanfred
.IP \(bu 2
ec9fa92 use stringutils instead of hard code
.IP \(bu 2
a307ae0 fix aliyun cloud typeerror
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49520\fP: (\fI\%doesitblend\fP) Multi\-master DNS Issue \- minion connect fail (refs: \fI\%#49764\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49764\fP: (\fI\%garethgreenaway\fP) [2018.3] Adding retry_dns_count to minion
@ \fI2018\-10\-01 14:20:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec97806 Merge pull request \fI\%#49764\fP from garethgreenaway/49520_multimaster_dns_issue_fix
.IP \(bu 2
30ccc5e Merge branch \(aq2018.3\(aq into 49520_multimaster_dns_issue_fix
.IP \(bu 2
741928b Fixes per request from @rallytime.
.IP \(bu 2
04c5983 Moving the check for an empty self.minions into a io_loop.call_later call.
.IP \(bu 2
44ee2ec Updating default for retry_dns_count
.IP \(bu 2
75f64a6 Removing unnecessary code.
.IP \(bu 2
e66dc18 Updating the resolve_dns function in minion.py to include a new minion configuration option which will control how many attempts will be made when the master hostname is unable to be resolved before giving up.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49847\fP: (\fI\%terminalmage\fP) Fix badly formatted versionadded directive (2018.3 branch)
@ \fI2018\-10\-01 14:04:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
abdab68 Merge pull request \fI\%#49847\fP from terminalmage/fix\-version\-rst\-2018.3
.IP \(bu 2
a127548 Fix badly formatted versionadded directive
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49043\fP: (\fI\%awerner\fP) Unicode broken with file.blockreplace on Python2 (refs: \fI\%#49782\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49782\fP: (\fI\%dwoz\fP) Fix issue 49043
@ \fI2018\-10\-01 13:43:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
aca87ab Merge pull request \fI\%#49782\fP from dwoz/issue\-49043
.IP \(bu 2
b7d904f Merge branch \(aq2018.3\(aq into issue\-49043
.IP \(bu 2
ed35633 Revert diff newline change
.IP \(bu 2
2a901e9 Fix issue 49043
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49671\fP: (\fI\%mchugh19\fP) Vault execution module broken in pillar lookups (refs: \fI\%#49820\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49820\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixing vault when being used from Pillar
@ \fI2018\-10\-01 13:40:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a41d1b Merge pull request \fI\%#49820\fP from garethgreenaway/49671_fixing_vault_pillar
.IP \(bu 2
a57872f Merge branch \(aq2018.3\(aq into 49671_fixing_vault_pillar
.IP \(bu 2
5f13219 Merge branch \(aq2018.3\(aq into 49671_fixing_vault_pillar
.IP \(bu 2
b0ba2ec Fixing the scenario when vault values are used in Pillar, but due to a previous change the minion was not being granted token based access.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49842\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.3 to 2018.3
@ \fI2018\-10\-01 13:21:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf9c175 Merge pull request \fI\%#49842\fP from rallytime/merge\-2018.3
.IP \(bu 2
81b0aa7 Add \(dqin progress\(dq notation back to the 2018.3.3 release notes
.IP \(bu 2
0e76103 Merge branch \(aq2018.3.3\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49839\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-09\-30 16:32:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
e6382cb Merge pull request \fI\%#49839\fP from rallytime/merge\-2018.3
.IP \(bu 2
179e4b1 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
fd46d35 Merge pull request \fI\%#49823\fP from dubb\-b/timeout_addition
.INDENT 2.0
.IP \(bu 2
b25ac9f Adding some changes for the status
.IP \(bu 2
f6d9679 Updating syntax to be better and with new lines
.IP \(bu 2
855ffe6 Adding timeout to all pipelines so that the build aborts
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49815\fP: (\fI\%isbm\fP) Bugfix/rework: IPv6 scope errors (bp)
@ \fI2018\-09\-28 19:44:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
fccc08c Merge pull request \fI\%#49815\fP from isbm/isbm\-ipv6\-scope\-errors\-2018.3
.IP \(bu 2
c14f26f Reverse skipping tests: if no ipaddress
.IP \(bu 2
bb37ba0 Add IPv6 scoped test
.IP \(bu 2
facb34a Add additional check
.IP \(bu 2
615b09a Lintfix: W0611
.IP \(bu 2
3ce265e Remove unnecessary manipulation with IPv6 scope outside of the IPv6Address object instance
.IP \(bu 2
c314e1c Revert method remapping with pylint updates
.IP \(bu 2
0a86112 Lintfix refactor: remove duplicate returns as not needed
.IP \(bu 2
5932a0d Lintfix
.IP \(bu 2
f52ea0b Add Py3.4 old implementation\(aqs fix
.IP \(bu 2
1c02a31 Fix wrong type swap
.IP \(bu 2
54233ca Do not use introspection for method swap
.IP \(bu 2
12038ea Simplify checking clause
.IP \(bu 2
7f2208b Fix py2 case where the same class cannot initialise itself on Python2 via super.
.IP \(bu 2
cefb16b Add extra detection for hexadecimal packed bytes on Python2. This cannot be detected with type comparison, because bytes == str and at the same time bytes != str if compatibility is not around
.IP \(bu 2
379ead4 Lintfix: mute not called constructors
.IP \(bu 2
66ec29c Add scope on str
.IP \(bu 2
f5644bf Add logging to the ip_interface
.IP \(bu 2
8bb5438 Add real exception message
.IP \(bu 2
693e4d4 Move docstrings to their native places
.IP \(bu 2
77f1c44 Remove duplicated code
.IP \(bu 2
40d0e6b Use ternary operator instead
.IP \(bu 2
d05999e Remove multiple returns
.IP \(bu 2
3fde850 Remove unnecessary operator
.IP \(bu 2
deb0b4e Remove duplicated code
.IP \(bu 2
8e62633 Remove unnecessary variable for import detection
.IP \(bu 2
7a6ea3b Remove multiple returns and add check for address syntax
.IP \(bu 2
b40e1e1 Add debugging to the ip_address method (py2 and py3)
.IP \(bu 2
cab5f62 Add logging
.IP \(bu 2
eeab9f2 Isolate Py2 and Py3 mode
.IP \(bu 2
49b32b7 Check version via object
.IP \(bu 2
1ae94f1 Override standard IPv6Address class
.IP \(bu 2
5e970ea Fix unicode imports in compat
.IP \(bu 2
bbeec4d Fix ipaddress import
.IP \(bu 2
561c99e Remove unused import
.IP \(bu 2
0498e94 Fix ipaddress imports
.IP \(bu 2
b4f1a72 Add missing docstrings
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49784\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-09\-28 17:29:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
804d52c Merge pull request \fI\%#49784\fP from rallytime/merge\-2018.3
.IP \(bu 2
c6b9d18 Merge branch \(aq2018.3\(aq into merge\-2018.3
.IP \(bu 2
26461f9 Add helper import comments
.IP \(bu 2
22f055c Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
d2a193b Merge pull request \fI\%#49792\fP from KaiSforza/fixscriptedpipes
.INDENT 2.0
.IP \(bu 2
5b16996 Fix the new pipelines
.UNINDENT
.UNINDENT
.IP \(bu 2
dd27d80 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
8a71a43 Merge pull request \fI\%#49774\fP from KaiSforza/declarativeToScripted
.INDENT 2.0
.IP \(bu 2
cae88f2 Move all pipelines to be fully scripted
.UNINDENT
.IP \(bu 2
8fe8aac Merge pull request \fI\%#49736\fP from mattLLVW/fix\-file\-touch
.INDENT 2.0
.IP \(bu 2
1da9f34 Fix test opts in append, prepend states/file.py
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49790\fP: (\fI\%weswhet\fP) fixing an issue where sentry logger would fail to get tags from grain…
@ \fI2018\-09\-28 13:39:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
d191b08 Merge pull request \fI\%#49790\fP from weswhet/fixing\-sentry\-logger\-2018.3
.IP \(bu 2
201697d fixing an issue where sentry logger would fail to get tags from grains and some other lint fixes for this file
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49626\fP: (\fI\%PabloLemos\fP) target grains ip_interface no return received (refs: \fI\%#49791\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49791\fP: (\fI\%terminalmage\fP) Fix 3 bugs in subdict matching
@ \fI2018\-09\-28 13:38:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
4d9fc7c Merge pull request \fI\%#49791\fP from terminalmage/issue49626
.IP \(bu 2
6795472 Add clarifying comment
.IP \(bu 2
ac0f800 Fix 3 bugs in subdict matching
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49806\fP: (\fI\%isbm\fP) Bugfix: zypper ZYPPER_EXIT_NO_REPOS exit code
@ \fI2018\-09\-28 13:20:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
52b0472 Merge pull request \fI\%#49806\fP from isbm/isbm\-zypper\-errcode\-6\-bp
.IP \(bu 2
756ef77 Update error list for zypper
.IP \(bu 2
5b02548 Add error logging
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#1121\fP: (\fI\%rallytime\fP) [2018.3] 4 related tests failing on 2018.3 Python 3 (refs: \fI\%#49795\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49795\fP: (\fI\%gtmanfred\fP) fix test_managed_file_with_grains_data
@ \fI2018\-09\-26 22:48:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
fee6701 Merge pull request \fI\%#49795\fP from gtmanfred/tests
.IP \(bu 2
cf5c179 fix test_managed_file_with_grains_data
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49786\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49759\fP to 2018.3
@ \fI2018\-09\-26 18:22:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49759\fP: (\fI\%mattp\-\fP) runners.state.orch: generate jid if missing (refs: \fI\%#49786\fP)
.IP \(bu 2
04e5869 Merge pull request \fI\%#49786\fP from rallytime/bp\-49759
.IP \(bu 2
df3791c state.orch: generate jid if missing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49770\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-09\-25 19:03:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
4138683 Merge pull request \fI\%#49770\fP from rallytime/merge\-2018.3
.IP \(bu 2
d9ed59b Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
f664515 Merge pull request \fI\%#49760\fP from Ch3LL/raid_docs
.INDENT 2.0
.IP \(bu 2
0eb90c1 Add mdadm as dependency in mdadm state docs
.UNINDENT
.IP \(bu 2
d5a75bf Merge pull request \fI\%#49749\fP from erwindon/docufix
.INDENT 2.0
.IP \(bu 2
baee678 fixed link in documentation
.UNINDENT
.IP \(bu 2
5ef2def Merge pull request \fI\%#49703\fP from twangboy/fix_49675_2017.7
.INDENT 2.0
.IP \(bu 2
9127222 Merge branch \(aq2017.7\(aq into fix_49675_2017.7
.IP \(bu 2
4f54422 Fix reboot needed detection
.UNINDENT
.IP \(bu 2
b5726d2 Merge pull request \fI\%#49718\fP from vutny/doc/2017.7/add\-missing\-mock\-kwarg
.INDENT 2.0
.IP \(bu 2
3e19176 [DOC] Add missing \fImock\fP argument for \fIstate.apply\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49757\fP: (\fI\%bbinet\fP) Fix influxdb_user state when test=True
@ \fI2018\-09\-24 19:14:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
db6f68a Merge pull request \fI\%#49757\fP from bbinet/fix\-influxdb_user\-test
.IP \(bu 2
0d9ef4b Fix influxdb_user state when test=True
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49679\fP: (\fI\%dwoz\fP) Add more tests to whitelist
@ \fI2018\-09\-22 17:46:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec2386e Merge pull request \fI\%#49679\fP from dwoz/whitelist
.IP \(bu 2
0a3d95f Fix linter issues
.IP \(bu 2
4c457c9 Close handles only if they exist
.IP \(bu 2
a44b37a Merge remote\-tracking branch \(aqsaltstack/2018.3\(aq into whitelist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49722\fP: (\fI\%meaksh\fP) Fixes some issues on the Zypper module
@ \fI2018\-09\-21 13:38:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a3e127 Merge pull request \fI\%#49722\fP from meaksh/2018.3\-fix\-zypper\-issue\-on\-python3
.IP \(bu 2
bb9cb6e Fix wrong queryformat for zypper list_provides
.IP \(bu 2
d40c034 Fix index error when running on Python 3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49720\fP: (\fI\%cstarke\fP) Separate prlctl and prlsrvctl checks into each requiring function
@ \fI2018\-09\-21 13:32:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
e7bbb83 Merge pull request \fI\%#49720\fP from cstarke/2018.3
.IP \(bu 2
b0be6aa Add documentation for prlctl and prlsrvctl binary requirement
.IP \(bu 2
4f8476b Fix tests; add test for CommandExecutionError
.IP \(bu 2
3c96dd2 Fix tests for parallels module
.IP \(bu 2
9034c4e Add import for CommandExecutionError
.IP \(bu 2
752b6f8 Separate prlctl and prlsrvctl checks into each requiring function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49615\fP: (\fI\%terminalmage\fP) ping_interval: use service.restart instead of signaling
@ \fI2018\-09\-21 13:26:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
f745e43 Merge pull request \fI\%#49615\fP from terminalmage/ping\-interval
.IP \(bu 2
b49b018 Move service name logic to a separate function
.IP \(bu 2
2fddba3 ping_interval: use service.restart instead of signaling
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49731\fP: (\fI\%terminalmage\fP) Add warning about using jinja filters to dump dicts in Jinja
@ \fI2018\-09\-21 13:16:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a530d2 Merge pull request \fI\%#49731\fP from terminalmage/jinja\-filter\-warning
.IP \(bu 2
8393560 Add warning about using jinja filters to dump dicts in Jinja
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49696\fP: (\fI\%jgleissner\fP) loosen azure sdk dependencies in azurearm cloud driver
@ \fI2018\-09\-20 19:17:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
91acb82 Merge pull request \fI\%#49696\fP from jgleissner/2018.3\-azurearm\-deps
.IP \(bu 2
467e017 remove unused import from azurearm driver
.IP \(bu 2
bad28b6 loosen azure sdk dependencies in azurearm cloud driver
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49684\fP: (\fI\%twangboy\fP) Detect when system needs reboot after domain join
@ \fI2018\-09\-20 16:17:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
d434e36 Merge pull request \fI\%#49684\fP from twangboy/fix_49675
.IP \(bu 2
3600467 Fix some try/except blocks, mark a lazy test
.IP \(bu 2
871c11a Fix other functions in the same manner
.IP \(bu 2
1b5bc66 Merge branch \(aq2018.3\(aq into fix_49675
.IP \(bu 2
95e6f54 Detect when system needs reboot after domain join
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
9048970 Add some debug info to assert
.IP \(bu 2
536fce6 Increase function timeout
.IP \(bu 2
ed4de63 Fix file serialize test
.IP \(bu 2
5ac3738 Merge remote\-tracking branch \(aqsaltstack/2018.3\(aq into whitelist
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49710\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-09\-19 18:05:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
936cae5 Merge pull request \fI\%#49710\fP from rallytime/merge\-2018.3
.IP \(bu 2
d19c67f Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
6bd85b5 Merge pull request \fI\%#49706\fP from garethgreenaway/1120_remove_mock_os_path_join
.INDENT 2.0
.IP \(bu 2
f4ccc75 Removing mocking of os.path.join from two tests, one of which was failing when used with coverage argument.  No reason we should be mocking os.path.join.
.UNINDENT
.IP \(bu 2
c38dc61 Merge pull request \fI\%#49692\fP from rallytime/bp\-49688
.INDENT 2.0
.IP \(bu 2
fde7575 Order the runtests suites
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
1f60753 Do not use close_fds on Windows OS
.IP \(bu 2
4a54c7c Fix file serialize test
.IP \(bu 2
0ec1e1e Increase timeout on flaky test
.IP \(bu 2
6ae924b Skip test that is not applicable on windows
.IP \(bu 2
5980200 Increase timeout on flaky test
.IP \(bu 2
1757edd Increase ModuleTest.run_function timeout
.IP \(bu 2
7c7353c Add more tests to whitelist
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49708\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49555\fP to 2018.3
@ \fI2018\-09\-19 13:12:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49555\fP: (\fI\%bergmannf\fP) Change StringIO and BytesIO imports (refs: \fI\%#49708\fP)
.IP \(bu 2
b082f79 Merge pull request \fI\%#49708\fP from rallytime/bp\-49555
.IP \(bu 2
ed25416 Change StringIO import in python2 to import the class.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49707\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49702\fP to 2018.3
@ \fI2018\-09\-19 13:09:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49702\fP: (\fI\%rallytime\fP) Mark orchestration test as expensive (refs: \fI\%#49707\fP)
.IP \(bu 2
0e97d9e Merge pull request \fI\%#49707\fP from rallytime/bp\-49702
.IP \(bu 2
7ff24e5 Mark orchestration test as expensive
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49693\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-09\-18 20:05:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
0c4005d Merge pull request \fI\%#49693\fP from rallytime/merge\-2018.3
.IP \(bu 2
b39dacf Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
37cbd27 Merge pull request \fI\%#49685\fP from rallytime/pillar\-headings
.INDENT 2.0
.IP \(bu 2
02b2d54 Split intro docs for cmd_yamlex pillar into shorter lines.
.IP \(bu 2
c4cbe5b Fix heading line\-lengths
.UNINDENT
.IP \(bu 2
9bad295 Merge pull request \fI\%#49689\fP from terminalmage/2017.7\-docs
.INDENT 2.0
.IP \(bu 2
7e5bab7 Fix docs build errors (2017.7 branch)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49674\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.3 to 2018.3
@ \fI2018\-09\-18 13:37:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
a12176d Merge pull request \fI\%#49674\fP from rallytime/merge\-2018.3
.IP \(bu 2
7bcb809 Merge pull request \fI\%#31\fP from dwoz/merge\-2018.3
.INDENT 2.0
.IP \(bu 2
cb35ebb Account for filename changes
.UNINDENT
.IP \(bu 2
f3b122f Merge branch \(aq2018.3.3\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49593\fP: (\fI\%dwoz\fP) Add more tests to whitelist for Windows
@ \fI2018\-09\-17 14:57:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
e636dac Merge pull request \fI\%#49593\fP from dwoz/add_whitelist
.IP \(bu 2
2e1bf13 Merge branch \(aq2018.3\(aq into add_whitelist
.IP \(bu 2
2340a58 Fix runner returns test on Windows
.IP \(bu 2
f908cde Merge branch \(aq2018.3\(aq into add_whitelist
.IP \(bu 2
be5fccf Fix linter \- blank lines
.IP \(bu 2
e51b0f8 Fix binary file manage test
.IP \(bu 2
9e3b44d Fix linter issues
.IP \(bu 2
ca1b05e Fix multiple issues in x509 module and state
.IP \(bu 2
e603e7a Fix encoding issues in file and x509 states
.IP \(bu 2
7f93c7f Fix map file loading on windows
.IP \(bu 2
2959da0 Add some runners test files to whitelist
.IP \(bu 2
bee2902 Make windows file remove return like others
.IP \(bu 2
5770b05 Fix hitelist file order
.IP \(bu 2
10ec8be Fix linter issues
.IP \(bu 2
ccbcb55 Add more tests to whitelist for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49639\fP: (\fI\%isbm\fP) Retire MD5 checksum for pkg mgmt plugins
@ \fI2018\-09\-17 14:51:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
7823839 Merge pull request \fI\%#49639\fP from isbm/isbm\-yumnotify\-md5
.IP \(bu 2
11a94ca Remove an empty line
.IP \(bu 2
adb8324 Use SHA256 algorithm for zyppnotify plugin
.IP \(bu 2
27001cf Use SHA256 algorithm for yumnotify plugin
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49652\fP: (\fI\%rallytime\fP) [2018.3] Merge forwrad from 2018.3.3 to 2018.3
@ \fI2018\-09\-14 21:20:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
aecbe12 Merge pull request \fI\%#49652\fP from rallytime/merge\-2018.3
.IP \(bu 2
a8a3820 Merge branch \(aq2018.3.3\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49646\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-09\-14 13:30:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
530e281 Merge pull request \fI\%#49646\fP from rallytime/merge\-2018.3
.IP \(bu 2
186f57e Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
3c8ec8a Merge pull request \fI\%#49644\fP from rallytime/mark\-flaky\-test
.INDENT 2.0
.IP \(bu 2
be8a187 Mark grains test as flaky
.UNINDENT
.IP \(bu 2
8ac66f1 Merge pull request \fI\%#49643\fP from rallytime/bp\-49642
.INDENT 2.0
.IP \(bu 2
accef8c Skip some unreliable tests
.UNINDENT
.IP \(bu 2
7a75d5e Merge pull request \fI\%#49597\fP from rallytime/bp\-47232
.INDENT 2.0
.IP \(bu 2
c477b70 Fixed usage of ipaddress
.UNINDENT
.IP \(bu 2
2f6cdd9 Merge pull request \fI\%#49614\fP from rallytime/bp\-49546
.INDENT 2.0
.IP \(bu 2
0f3881a Skip flaky test on Python 3
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49642\fP: (\fI\%rallytime\fP) Skip some unreliable tests (refs: \fI\%#49643\fP)
@ \fI2018\-09\-13 18:24:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb1dcdf Merge pull request \fI\%#49642\fP from rallytime/flaky\-tests
.IP \(bu 2
8e74d1c Skip some unreliable tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49629\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.3 to 2018.3
@ \fI2018\-09\-13 14:00:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
e319ecc Merge pull request \fI\%#49629\fP from rallytime/merge\-2018.3
.IP \(bu 2
b628ad7 Merge branch \(aq2018.3.3\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49632\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixing integration.states.test_file.FileTest.test_directory_max_depth
@ \fI2018\-09\-13 13:51:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
93d43fa Merge pull request \fI\%#49632\fP from garethgreenaway/fixing_failing_test_python_3_7
.IP \(bu 2
588f744 Fixing failing test under python 3.7 causaed by changes to how os.makedirs sets initial permissions.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49580\fP: (\fI\%garethgreenaway\fP) [2018.3] Fixing tests for Python 3.7
@ \fI2018\-09\-12 16:33:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
7042fc0 Merge pull request \fI\%#49580\fP from garethgreenaway/fixing_failing_test_python_3_7
.IP \(bu 2
b6afdae Fixing lint.
.IP \(bu 2
d2fb68c Fixes various tests that were failing under python 3.7.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49606\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-09\-12 14:26:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab19082 Merge pull request \fI\%#49606\fP from rallytime/merge\-2018.3
.IP \(bu 2
c168268 Update old utils paths to use new paths
.IP \(bu 2
19598d8 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
aa560c5 Merge pull request \fI\%#49595\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
09247a3 Merge branch \(aq2017.7.8\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
4d865b4 Merge pull request \fI\%#49560\fP from rallytime/pkgng\-fix
.INDENT 2.0
.IP \(bu 2
f3e1534 [2017.7.8] Use correct path for is_true function
.UNINDENT
.IP \(bu 2
92369f0 Merge pull request \fI\%#49541\fP from twangboy/fix_osx_build_2
.INDENT 2.0
.IP \(bu 2
750d3fa Remove trusted host switches
.UNINDENT
.IP \(bu 2
397296f Merge pull request \fI\%#49539\fP from twangboy/fix_osx_build_2
.INDENT 2.0
.IP \(bu 2
6b42e73 Fix issues with build script on OSX
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
e8171de Merge pull request \fI\%#49596\fP from terminalmage/kill\-bare\-excepts\-with\-fire
.INDENT 2.0
.IP \(bu 2
729dc08 Kill bare excepts with fire
.UNINDENT
.IP \(bu 2
63b6643 Merge pull request \fI\%#49578\fP from twangboy/fix_49566
.INDENT 2.0
.IP \(bu 2
6a5a69c Merge branch \(aq2017.7\(aq into fix_49566
.UNINDENT
.IP \(bu 2
f9a01b7 Merge pull request \fI\%#49584\fP from terminalmage/squelch\-varstack\-error
.INDENT 2.0
.IP \(bu 2
c79a823 Squelch error logging when varstack is not installed
.UNINDENT
.IP \(bu 2
d4d2b36 Merge pull request \fI\%#49579\fP from dwoz/flaky_test
.INDENT 2.0
.IP \(bu 2
dbe40df Increase timeout for flaky git test
.UNINDENT
.IP \(bu 2
5cbe60b Merge pull request \fI\%#49570\fP from rallytime/doc\-fixes
.INDENT 2.0
.IP \(bu 2
de80bda Fix docstring + import order, move pylint disable to own line
.IP \(bu 2
393bc0f Fix doc build errors in saltnado documentation
.INDENT 2.0
.IP \(bu 2
6105ebb Use setup.py clean \-\-all
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49620\fP: (\fI\%dwoz\fP) Adding passing windows nacl runner tests to whitelist
@ \fI2018\-09\-12 14:19:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
0ce91d6 Merge pull request \fI\%#49620\fP from dwoz/nacltest
.IP \(bu 2
51500ac Adding passing windows nacl runner tests to whitelist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49532\fP: (\fI\%meaksh\fP) Fix wrong \(aqrecurse\(aq behavior on for linux_acl.present/absent states
@ \fI2018\-09\-12 14:16:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
c1f97c4 Merge pull request \fI\%#49532\fP from meaksh/2018.3\-fix\-linux_acl\-recursive\-problems
.IP \(bu 2
cf27069 Fix some pylint issues
.IP \(bu 2
a0ed59d Fix recursive cases on linux_acl.absent state
.IP \(bu 2
4a01849 Add unit tests to cover recursive cases of linux_acl states
.IP \(bu 2
f739b6f Fix typo on variable name
.IP \(bu 2
dc6d1d7 Fix wrong recurse behavior on for linux_acl.present state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49027\fP: (\fI\%lachlanmunro\fP) x509.certificate_managed certificate is mangled on process under py3 m2crypto (refs: \fI\%#49561\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#49008\fP: (\fI\%lachlanmunro\fP) x509.certificate_managed state fails under py3 m2crypto with \(dqint too large\(dq (refs: \fI\%#49561\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49561\fP: (\fI\%dwoz\fP) x509 module and state bug fixes
@ \fI2018\-09\-11 14:01:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
283e7d7 Merge pull request \fI\%#49561\fP from dwoz/m2crypto_test
.IP \(bu 2
5e591ea Merge branch \(aq2018.3\(aq into m2crypto_test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49592\fP: (\fI\%dwoz\fP) Fix binary file manage test
@ \fI2018\-09\-10 23:03:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
4478a44 Merge pull request \fI\%#49592\fP from dwoz/bin_file_fix
.IP \(bu 2
8556c3d Fix binary file manage test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49571\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-09\-10 12:58:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
9004422 Merge pull request \fI\%#49571\fP from rallytime/merge\-2018.3
.IP \(bu 2
a00aba9 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
5d267a2 Merge pull request \fI\%#49547\fP from rallytime/bp\-49518
.INDENT 2.0
.IP \(bu 2
4bb09f7 Skip service module integration tests on CentOS 7
.UNINDENT
.IP \(bu 2
4948071 Merge pull request \fI\%#49549\fP from rallytime/codeowners\-duplicate
.INDENT 2.0
.IP \(bu 2
4b257d2 Remove duplicate comment in CODEOWNERS file
.IP \(bu 2
faafe74 Merge branch \(aq2018.3\(aq into m2crypto_test
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49577\fP: (\fI\%dwoz\fP) Multiple unittest fixes for 2018.3 Python 3 Windows
@ \fI2018\-09\-08 05:53:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
4669a9a Merge pull request \fI\%#49577\fP from dwoz/unit_test_fixes
.IP \(bu 2
aa07b3f Multiple unittest fixes for 2018.3 Python 3 Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49533\fP: (\fI\%silenius\fP) [cherry\-pick] Optimize postgres groups management
@ \fI2018\-09\-07 18:58:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
8b971e5 Merge pull request \fI\%#49533\fP from silenius/2018.3.3
.IP \(bu 2
7eb8d6c Postgress module unit test fix.
.IP \(bu 2
b56aedc Optimize postgres groups management
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49543\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-09\-07 18:19:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a41b47 Merge pull request \fI\%#49543\fP from rallytime/merge\-2018.3
.IP \(bu 2
cf508a4 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
75a3b52 Merge pull request \fI\%#49527\fP from terminalmage/remove\-special\-envs\-handling
.INDENT 2.0
.IP \(bu 2
1478a76 Remove special handling for file_envs fileserver func
.UNINDENT
.IP \(bu 2
13f1d26 Merge pull request \fI\%#49512\fP from rallytime/merge\-2017.7
.INDENT 2.0
.IP \(bu 2
de7ef3d Add \(dqin progess\(dq notation back to 2017.7.8 release notes
.IP \(bu 2
edad2dc Merge branch \(aq2017.7.8\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
d24c96f Merge pull request \fI\%#49505\fP from Ch3LL/rn_7.8_2
.INDENT 2.0
.IP \(bu 2
d40b644 Update 2017.7.8 ChangeLog with new fixes
.UNINDENT
.IP \(bu 2
0d7b173 Merge pull request \fI\%#49498\fP from rallytime/pin\-cherrypy\-2017.7.8
.INDENT 2.0
.IP \(bu 2
81a6155 Pin CherryPy version to < 18.0.0 in requirements files for PY2
.UNINDENT
.IP \(bu 2
52ab2c0 Merge pull request \fI\%#49466\fP from rallytime/bp\-49461
.INDENT 2.0
.IP \(bu 2
5842800 Revert \(dqAllow for not being prompted to supply a password to deploy keys to a…\(dq
.UNINDENT
.IP \(bu 2
1bbe7df Merge pull request \fI\%#49284\fP from twangboy/fix_installer_osx
.INDENT 2.0
.IP \(bu 2
a112eaa Fix path to libsodium tarball
.UNINDENT
.IP \(bu 2
e0e8779 Merge pull request \fI\%#49272\fP from twangboy/fix_installer_more
.INDENT 2.0
.IP \(bu 2
a8f054b Add 64bit binaries for KB2999226 to the x86 installer
.UNINDENT
.IP \(bu 2
0eb6ddf Merge pull request \fI\%#49218\fP from twangboy/fix_installer
.INDENT 2.0
.IP \(bu 2
e8a1d2f Add more descriptive error when KB not found
.IP \(bu 2
71737ea Suppress all ui on vcredist installation
.IP \(bu 2
7dae9bb Fix Windows and OSX installers
.UNINDENT
.IP \(bu 2
e484f26 Merge pull request \fI\%#49116\fP from twangboy/fix_installer
.INDENT 2.0
.IP \(bu 2
1227095 Add nonfatal switch to VCRedist
.UNINDENT
.IP \(bu 2
0b9f2f8 Merge pull request \fI\%#49113\fP from Ch3LL/rn_7.8
.IP \(bu 2
f6b70bb Add changelog to 2017.7.8 release notes
.UNINDENT
.UNINDENT
.IP \(bu 2
208cfe6 Merge pull request \fI\%#49515\fP from rallytime/update\-codeowners
.INDENT 2.0
.IP \(bu 2
1faab8b Add some files to the CODEOWNERS files for team\-core to own
.UNINDENT
.IP \(bu 2
34e5174 Merge pull request \fI\%#49327\fP from twangboy/fix_win_service
.INDENT 2.0
.IP \(bu 2
74e944b Mark test_service_status_running as flaky
.IP \(bu 2
c69560c Merge branch \(aq2017.7\(aq into fix_win_service
.IP \(bu 2
53e2e05 Merge branch \(aq2017.7\(aq into fix_win_service
.IP \(bu 2
cf3d287 Merge branch \(aq2017.7\(aq into fix_win_service
.IP \(bu 2
1641851 Fix the name of the _cmd_quote test
.IP \(bu 2
97567af Skip tests on Linux systems
.IP \(bu 2
0ca9cd1 Fix some lint
.IP \(bu 2
3800966 Add tests
.IP \(bu 2
b0d646d Add more details to the functioning of _cmd_quote
.IP \(bu 2
a9856e2 Fix issues with win_service
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49452\fP: (\fI\%gtmanfred\fP) [python3.7] remove usage of collections.abc stuff from the collections shim (refs: \fI\%#49487\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49487\fP: (\fI\%garethgreenaway\fP) [2018.3] Swapping out collections imports
@ \fI2018\-09\-07 15:36:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
baafd6e Merge pull request \fI\%#49487\fP from garethgreenaway/49452_collections_abc
.IP \(bu 2
2fb3ef7 Merge branch \(aq2018.3\(aq into 49452_collections_abc
.IP \(bu 2
ebfd7f9 Merge branch \(aq2018.3\(aq into 49452_collections_abc
.IP \(bu 2
b27e86b Swapping out the version check for a try...except on the import from collections.abc with a fallback to importing from collections.
.IP \(bu 2
d118a9f Updating various imports that have been moved from collections to collections.abc, and will be deprecated in collections beginning in 3.8.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
abc9c1a Fix linter issues
.IP \(bu 2
8e42384 Fix multiple issues in x509 module and state
.IP \(bu 2
2a52158 Fix encoding issues in file and x509 states
.IP \(bu 2
49a6da7 Fix map file loading on windows
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49528\fP: (\fI\%dwoz\fP) Fix merge wart
@ \fI2018\-09\-06 23:12:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
06935e9 Merge pull request \fI\%#49528\fP from dwoz/mergetests
.IP \(bu 2
6a4f823 Fix merge wart
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49548\fP: (\fI\%garethgreenaway\fP) [2018.3] Disabling State boto tests for Python 3.7+
@ \fI2018\-09\-06 21:50:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
3298e70 Merge pull request \fI\%#49548\fP from garethgreenaway/1075_disable_boto_tests_part_deux
.IP \(bu 2
0f5191e Disable various boto tests when run under python 3.7 because of //github.com/spulec/moto/issues/1706. which was causing the test suite to hang on unit tests.  This PR is disabling the tests in the test_boto_vpc state tests.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49521\fP: (\fI\%terminalmage\fP) Fix _get_hash in splay executor
@ \fI2018\-09\-06 14:06:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
c346825 Merge pull request \fI\%#49521\fP from terminalmage/fix\-splay\-executor
.IP \(bu 2
bbb8fe8 Fix _get_hash in splay executor
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49526\fP: (\fI\%terminalmage\fP) Prevent lookup error when trying to lookup fileserver function from LazyDict
@ \fI2018\-09\-06 14:01:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
3f7c89c Merge pull request \fI\%#49526\fP from terminalmage/fix\-backends\-error\-logging
.IP \(bu 2
1f0288e Prevent lookup error when trying to lookup fileserver function from LazyDict
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49524\fP: (\fI\%garethgreenaway\fP) [2018.3] Disable boto tests under 3.7
@ \fI2018\-09\-06 13:35:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf939f9 Merge pull request \fI\%#49524\fP from garethgreenaway/1075_disable_boto_tests
.IP \(bu 2
5ec5578 Disable various boto tests when run under python 3.7 because of //github.com/spulec/moto/issues/1706. which was causing the test suite to hang on unit tests.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49511\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.3 to 2018.3
@ \fI2018\-09\-05 19:52:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
f73f2e5 Merge pull request \fI\%#49511\fP from rallytime/merge\-2018.3
.IP \(bu 2
3ffc6c2 Merge branch \(aq2018.3.3\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49500\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-09\-04 19:02:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
81a49a8 Merge pull request \fI\%#49500\fP from rallytime/merge\-2018.3
.IP \(bu 2
2317b5e Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
1cdaea2 Merge pull request \fI\%#49475\fP from dwoz/flaky_tests
.INDENT 2.0
.IP \(bu 2
f214929 Fix a flaky test and mark another as flaky
.UNINDENT
.IP \(bu 2
4ac4305 Merge pull request \fI\%#49457\fP from rallytime/labels\-docs
.INDENT 2.0
.IP \(bu 2
d1e51db Remove references to unused milestones in docs
.UNINDENT
.IP \(bu 2
41dcc3f Merge pull request \fI\%#49461\fP from saltstack/revert\-47100\-ssh
.INDENT 2.0
.IP \(bu 2
0d7180a Revert \(dqAllow for not being prompted to supply a password to deploy keys to a…\(dq
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49497\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49473\fP to 2018.3
@ \fI2018\-09\-04 18:44:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49473\fP: (\fI\%rallytime\fP) Use correct and explicit paths for salt utils libs (refs: \fI\%#49497\fP)
.IP \(bu 2
16ca360 Merge pull request \fI\%#49497\fP from rallytime/bp\-49473
.IP \(bu 2
1aa3935 Lint: Add range import from six
.IP \(bu 2
d06f6a5 Use correct and explicit paths for salt utils libs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49474\fP: (\fI\%dwoz\fP) Work around git\-python resource leaks
@ \fI2018\-09\-02 19:42:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
93df5c4 Merge pull request \fI\%#49474\fP from dwoz/gitfs_unit
.IP \(bu 2
56068e9 Merge branch \(aq2018.3\(aq into gitfs_unit
.IP \(bu 2
e697ddc Work around git\-python resource leaks
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49471\fP: (\fI\%Ch3LL\fP) Remove string conversion on frame object in sigusr1 handler
@ \fI2018\-09\-02 18:05:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
43ead5d Merge pull request \fI\%#49471\fP from Ch3LL/debug_sigusr1
.IP \(bu 2
1631b2f Remove string conversion on frame object in sigusr1 handler
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49454\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-08\-31 21:36:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
764b816 Merge pull request \fI\%#49454\fP from rallytime/merge\-2018.3
.IP \(bu 2
a97a7b0 Fix lint and test failures caused by bad merge
.IP \(bu 2
f7226f4 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
7a166bc Merge pull request \fI\%#49376\fP from twangboy/fix_48608
.INDENT 2.0
.IP \(bu 2
bf32e0c Merge branch \(aqfix_48608\(aq of \fI\%https://github.com/twangboy/salt\fP into fix_48608
.INDENT 2.0
.IP \(bu 2
9766f0d Merge branch \(aq2017.7\(aq into fix_48608
.UNINDENT
.IP \(bu 2
fb97b00 Fix broken path to libsodium tarball
.IP \(bu 2
535d83e Fix test for list_users
.IP \(bu 2
40d3f2e Use dscl to get list of users
.IP \(bu 2
e426459 Use a set to avoid duplicates
.UNINDENT
.IP \(bu 2
03d9750 Merge pull request \fI\%#49434\fP from dwoz/cleanup_exception_handling
.INDENT 2.0
.IP \(bu 2
9daa992 Fix group remove test logic
.IP \(bu 2
d74fab7 Clean up exception handling on py3
.UNINDENT
.IP \(bu 2
7099164 Merge pull request \fI\%#49389\fP from gtmanfred/2017.7
.INDENT 2.0
.IP \(bu 2
6c01662 remove cmd key from load
.IP \(bu 2
bdf3df3 add cli example
.IP \(bu 2
251f321 pass load on
.IP \(bu 2
be7c041 add test
.IP \(bu 2
0ace5c1 make file envs compatible with transport format
.UNINDENT
.IP \(bu 2
24faa5e Merge pull request \fI\%#49408\fP from terminalmage/issue49269
.INDENT 2.0
.IP \(bu 2
d02ec34 Allow our custom yaml dumper to NamespacedDictWrapper objects
.UNINDENT
.IP \(bu 2
5746fc8 Merge pull request \fI\%#49402\fP from rallytime/bp\-49321
.INDENT 2.0
.IP \(bu 2
7dec9fc Add flaky decorator to serializer test
.UNINDENT
.IP \(bu 2
5c723b0 Merge pull request \fI\%#49375\fP from terminalmage/revert\-49185
.INDENT 2.0
.IP \(bu 2
aaea274 Merge branch \(aq2017.7\(aq into revert\-49185
.IP \(bu 2
7372e9d Add minion documentation for enable_gpu_grains
.IP \(bu 2
ea1b53c Fix incorrect master docs for enable_gpu_grains
.IP \(bu 2
638210a Add validation type and default minion value for enable_gpu_grains
.IP \(bu 2
49ed156 Add enable_gpu_grains to the minion config stub
.IP \(bu 2
d1b7fb4 Revert \(dqUpdate documentation to correctly state enable_gpu_grains default\(dq
.UNINDENT
.IP \(bu 2
11d87e4 Merge pull request \fI\%#49387\fP from twangboy/fix_win_repo
.INDENT 2.0
.IP \(bu 2
2bf7eda Import GLOBAL_ONLY
.UNINDENT
.IP \(bu 2
651631d Merge pull request \fI\%#49390\fP from dwoz/archive_module
.INDENT 2.0
.IP \(bu 2
b332beb Fix archive tests for py3
.UNINDENT
.IP \(bu 2
c591d2b Merge pull request \fI\%#49385\fP from dwoz/sonofa
.INDENT 2.0
.IP \(bu 2
f9d7dbd The autoruns module has not been renamed
.UNINDENT
.IP \(bu 2
5d2c9b6 Merge pull request \fI\%#49371\fP from rallytime/bp\-49064
.INDENT 2.0
.IP \(bu 2
bc52f7c Stop running lint on all files when no changes
.UNINDENT
.IP \(bu 2
f1c904e Merge pull request \fI\%#49380\fP from twangboy/doc_48758
.INDENT 2.0
.IP \(bu 2
6cefbdf Add docs from a comment on issue 48758
.UNINDENT
.IP \(bu 2
b22a43d Merge pull request \fI\%#49324\fP from dwoz/windows_pr_builds
.INDENT 2.0
.IP \(bu 2
7abd9cd Merge branch \(aq2017.7\(aq into windows_pr_builds
.UNINDENT
.IP \(bu 2
b2e4121 Merge pull request \fI\%#49379\fP from dwoz/whitelistagain
.INDENT 2.0
.IP \(bu 2
56ea4ee Account for more tests that are not in 2017.7
.UNINDENT
.IP \(bu 2
7fa9120 Merge pull request \fI\%#49366\fP from rallytime/bp\-49232
.INDENT 2.0
.IP \(bu 2
74b05ef fix HTTP method for acl_info
.IP \(bu 2
b9fa7db Merge branch \(aq2017.7\(aq into windows_pr_builds
.IP \(bu 2
77f5fd3 Merge branch \(aq2017.7\(aq into windows_pr_builds
.IP \(bu 2
7cdba27 Add ci scripts for windows PR builds
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49025\fP: (\fI\%twangboy\fP) Fix several issues with LGPO
@ \fI2018\-08\-31 18:25:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ea22e5 Merge pull request \fI\%#49025\fP from twangboy/fix_48661
.IP \(bu 2
c27fd18 Merge branch \(aq2018.3\(aq into fix_48661
.IP \(bu 2
222c503 Fix several issues with LGPO
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49281\fP: (\fI\%aarnaud\fP) etcd_cache : Not working for mine (refs: \fI\%#49283\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49283\fP: (\fI\%aarnaud\fP) Fix \fI\%#49281\fP etcd_cache with mine cache
@ \fI2018\-08\-31 18:24:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd9ec94 Merge pull request \fI\%#49283\fP from aarnaud/fix\-etcd\-cache
.IP \(bu 2
13e1a17 Merge branch \(aq2018.3\(aq into fix\-etcd\-cache
.IP \(bu 2
6c0fb9c Fix \fI\%#49281\fP etcd_cache with mine cache
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49459\fP: (\fI\%dwoz\fP) Batch test fix cherry\-pick
@ \fI2018\-08\-30 23:02:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
64227f9 Merge pull request \fI\%#49459\fP from dwoz/batch_fix
.IP \(bu 2
fc39dcf Simplify cli test fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49453\fP: (\fI\%dwoz\fP) Fix up py3 git config tests
@ \fI2018\-08\-30 22:00:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
75285a3 Merge pull request \fI\%#49453\fP from dwoz/conffix
.IP \(bu 2
ac3c379 Fix up py3 git config tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49411\fP: (\fI\%terminalmage\fP) Allow our custom yaml dumper to NamespacedDictWrapper objects (2018.3 branch)
@ \fI2018\-08\-30 13:05:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
a962efc Merge pull request \fI\%#49411\fP from terminalmage/issue49269\-2018.3
.IP \(bu 2
a4cb35b Remove support for overriding the class name
.IP \(bu 2
82a8b73 Allow our custom yaml dumper to NamespacedDictWrapper objects
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49407\fP: (\fI\%rallytime\fP) Mark pkg module tests and flaky
@ \fI2018\-08\-30 13:01:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
8022a3b Merge pull request \fI\%#49407\fP from rallytime/pkg\-flaky
.IP \(bu 2
1609e11 Mark pkg module tests and flaky
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49406\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.3 to 2018.3
@ \fI2018\-08\-30 13:00:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
7f8c38a Merge pull request \fI\%#49406\fP from rallytime/merge\-2018.3
.IP \(bu 2
4939ee3 Merge branch \(aq2018.3.3\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49401\fP: (\fI\%rallytime\fP) Mark output file permissions test as flaky
@ \fI2018\-08\-29 18:13:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
68d630f Merge pull request \fI\%#49401\fP from rallytime/flaky\-output\-test
.IP \(bu 2
e13216b Mark output file permissions test as flaky
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49400\fP: (\fI\%rallytime\fP) Mark pillar refresh test as flaky
@ \fI2018\-08\-29 18:12:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
23610ed Merge pull request \fI\%#49400\fP from rallytime/flaky\-pillar\-test
.IP \(bu 2
fb62af6 Mark pillar refresh test as flaky
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49150\fP: (\fI\%sunyq\fP) hosts.rm_host changes /etc/hosts file with odd characters (refs: \fI\%#49394\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49394\fP: (\fI\%sunyq\fP) fix issue\(ga#49150\(ga_ hosts.rm_host changes /etc/hosts with odd characters
@ \fI2018\-08\-29 13:33:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
502e91c Merge pull request \fI\%#49394\fP from sunyq/2018.3
.IP \(bu 2
76ba5b6 fix issue\(ga#49150\(ga_ hosts.rm_host changes /etc/hosts with odd characters
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49386\fP: (\fI\%dwoz\fP) Cherry\-pick whitelist fix.
@ \fI2018\-08\-29 01:11:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
2cf2e62 Merge pull request \fI\%#49386\fP from dwoz/whitelistfix
.IP \(bu 2
2b08cf1 Account for more tests that are not in 2017.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49372\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-08\-28 19:03:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec04282 Merge pull request \fI\%#49372\fP from rallytime/merge\-2018.3
.IP \(bu 2
ab6cc1c Update old utils paths to use new paths
.IP \(bu 2
ac406c4 Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.IP \(bu 2
dfa3861 Merge pull request \fI\%#49354\fP from dwoz/fix_whitelist
.INDENT 2.0
.IP \(bu 2
aeb0fa3 custom_grains tests do not exist
.UNINDENT
.IP \(bu 2
14b8094 Merge pull request \fI\%#49346\fP from Ch3LL/bp\-49345
.INDENT 2.0
.IP \(bu 2
ce2733e upgrade including linux kernels
.UNINDENT
.IP \(bu 2
d8f2945 Merge pull request \fI\%#49344\fP from cachedout/test_matcher_flaky
.INDENT 2.0
.IP \(bu 2
a34ef2e Matcher test marked flaky
.UNINDENT
.IP \(bu 2
f08e720 Merge pull request \fI\%#49353\fP from dwoz/boto_fix
.INDENT 2.0
.IP \(bu 2
376019f Do not raise exception if passed bytes
.UNINDENT
.IP \(bu 2
4690ad0 Merge pull request \fI\%#49339\fP from dwoz/more_tests
.INDENT 2.0
.IP \(bu 2
d50324b Merge branch \(aq2017.7\(aq into more_tests
.UNINDENT
.IP \(bu 2
e371ad9 Merge pull request \fI\%#49341\fP from terminalmage/issue48717
.INDENT 2.0
.IP \(bu 2
1971d09 Update dynamic git_pillar docs to enclose env name in quotes
.UNINDENT
.IP \(bu 2
00b58ee Merge pull request \fI\%#49337\fP from dwoz/win_service_test_fix
.INDENT 2.0
.IP \(bu 2
1c1727e Fix broken service stop test
.UNINDENT
.IP \(bu 2
81428ed Merge pull request \fI\%#49291\fP from dwoz/dedent
.INDENT 2.0
.IP \(bu 2
1991198 Fix review nits
.IP \(bu 2
6abc2da Re\-factor dedent to fix warts
.IP \(bu 2
75b2e3d Use salt.utils.to_* functions
.IP \(bu 2
fa78a7b Add dedent that sets line endings
.INDENT 2.0
.IP \(bu 2
cd6706e Fix merge wart
.IP \(bu 2
b9c344b Fix module.archive tests for win py3
.IP \(bu 2
ac60fb8 Comment strange code
.IP \(bu 2
5fefd6f Simplify cli test fixes
.IP \(bu 2
1765d53 Fix archive tests on Windows platform
.IP \(bu 2
06f271f Add archive module tests to whitelist.txt
.IP \(bu 2
9cb8fe2 Add more tests to whitelist for windows
.IP \(bu 2
b8af238 Fix indent wart
.IP \(bu 2
bc971e4 add doc tests
.IP \(bu 2
8899a5e Add more client tests to whitelist
.IP \(bu 2
14cd7b48 Add cli tests to whitelist
.IP \(bu 2
3e55d10 Platform module doesn\(aqt exist in 2017.7
.IP \(bu 2
2733c02 Use double quotes on windows commands
.IP \(bu 2
0394ece The set command does not work like inline env vars
.UNINDENT
.UNINDENT
.IP \(bu 2
1fd5cf1 Merge pull request \fI\%#49320\fP from rallytime/fix\-48694
.INDENT 2.0
.IP \(bu 2
0964b5e Update documentation for \fI\%#48694\fP and add deprecation warning
.UNINDENT
.IP \(bu 2
c323096 Merge pull request \fI\%#49314\fP from rallytime/bp\-49277
.INDENT 2.0
.IP \(bu 2
6d691b2 Prepend current directory when path is just filename
.UNINDENT
.IP \(bu 2
c7bae5e Merge pull request \fI\%#49290\fP from rallytime/bp\-44504
.INDENT 2.0
.IP \(bu 2
6224f7b calling range is going up to the upper limit but not including it
.UNINDENT
.IP \(bu 2
7a44e59 Merge pull request \fI\%#49289\fP from rallytime/bp\-49170
.INDENT 2.0
.IP \(bu 2
4c29c17 forcing mine update in the proxy minion as well
.IP \(bu 2
b1d581a force mine update on minion start
.UNINDENT
.IP \(bu 2
221ea22 Merge pull request \fI\%#49278\fP from rallytime/bp\-49253
.INDENT 2.0
.IP \(bu 2
b331b5c skip ID 7 for vmware hard drives
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49356\fP: (\fI\%dwoz\fP) Fix tests that use timed_subprocess for py3
@ \fI2018\-08\-28 13:30:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
1faf6a7 Merge pull request \fI\%#49356\fP from dwoz/cmdmod
.IP \(bu 2
6ffeaae Fix tests that use timed_subprocess for py3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48299\fP: (\fI\%dosercz\fP) git.latest reports deleted tags in remote repo as new_tags in changes (refs: \fI\%#49305\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49336\fP: (\fI\%terminalmage\fP) Fix half\-baked comment
@ \fI2018\-08\-27 00:07:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49305\fP: (\fI\%terminalmage\fP) Allow git.latest to remove local tags which have been removed remotely (refs: \fI\%#49336\fP)
.IP \(bu 2
2d8055e Merge pull request \fI\%#49336\fP from terminalmage/issue48299
.IP \(bu 2
175e161 Fix half\-baked comment
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49331\fP: (\fI\%dwoz\fP) Use salt.utils to ensure string type
@ \fI2018\-08\-26 01:42:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
a2e7033 Merge pull request \fI\%#49331\fP from dwoz/strfix
.IP \(bu 2
7513474 Use salt.utils to ensure string type
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49312\fP: (\fI\%Ch3LL\fP) Fix keyerror in manage.bootstrap
@ \fI2018\-08\-25 19:55:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
d70eda8 Merge pull request \fI\%#49312\fP from Ch3LL/ssh_list_hosts
.IP \(bu 2
da71c97 Fix keyerror in manage.bootstrap
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49316\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2018.3.3 to 2018.3
@ \fI2018\-08\-25 19:53:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b2eba7 Merge pull request \fI\%#49316\fP from rallytime/merge\-2018.3
.IP \(bu 2
39c442c Merge branch \(aq2018.3.3\(aq into \(aq2018.3\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48880\fP: (\fI\%damntoken\fP) Can\(aqt run cmd.run with UTF\-8 chars as arguments / parameters. With custom module. (refs: \fI\%#49322\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49322\fP: (\fI\%dwoz\fP) Encode shell commands explicitly.
@ \fI2018\-08\-25 04:43:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
5766e98 Merge pull request \fI\%#49322\fP from dwoz/state_module_test_fix
.IP \(bu 2
1f7d50d Encode shell commands explicitly.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49299\fP: (\fI\%dwoz\fP) Work around cmd.run unicode issues in test for now
@ \fI2018\-08\-25 04:43:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
b47da0a Merge pull request \fI\%#49299\fP from dwoz/test_fix
.IP \(bu 2
f4bd644 Fix string formatting wart in file state tests
.IP \(bu 2
e84e608 Fix wart in file state test
.IP \(bu 2
71d4465 Work around cmd.run unicode issues in test for now
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48299\fP: (\fI\%dosercz\fP) git.latest reports deleted tags in remote repo as new_tags in changes (refs: \fI\%#49305\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49305\fP: (\fI\%terminalmage\fP) Allow git.latest to remove local tags which have been removed remotely (refs: \fI\%#49336\fP)
@ \fI2018\-08\-24 17:29:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
b65890c Merge pull request \fI\%#49305\fP from terminalmage/issue48299
.IP \(bu 2
4a093d9 lint
.IP \(bu 2
ed7b994 Gate tag manipulation behind a sync_tags argument
.IP \(bu 2
29de855 Add test for a removed tag
.IP \(bu 2
eb9a459 Properly handle tags deleted from remote repository
.IP \(bu 2
916c15a Add git.tag function
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49009\fP: (\fI\%msciciel\fP) file_ignore_regex / file_ignore_glob not working properly (refs: \fI\%#49308\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49308\fP: (\fI\%terminalmage\fP) Don\(aqt include ignored paths in mtime map
@ \fI2018\-08\-24 17:28:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
459354a Merge pull request \fI\%#49308\fP from terminalmage/issue49009
.IP \(bu 2
2badd7f Don\(aqt include ignored paths in mtime map
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49282\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3
@ \fI2018\-08\-24 16:45:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
914bb09 Merge pull request \fI\%#49282\fP from rallytime/merge\-2018.3
.IP \(bu 2
21a51c9 Add \(aqminion_data_cache: True\(aq to mocked opts for minions unit tests
.IP \(bu 2
196ce3f Call the \fIwith_tempfile\fP decorator correctly for 2018.3
.IP \(bu 2
37f24fd Fix unit test for file state
.IP \(bu 2
6f9a158 Update old utils paths with new paths
.IP \(bu 2
c3ecefc Merge branch \(aq2017.7\(aq into \(aq2018.3\(aq
.INDENT 2.0
.IP \(bu 2
879c3ad Merge pull request \fI\%#49262\fP from bloomberg/short\-circuit
.INDENT 2.0
.IP \(bu 2
a3594db extend #488588 to cover SyncAuth class
.UNINDENT
.IP \(bu 2
1900aff Merge pull request \fI\%#49144\fP from twangboy/fix_48163
.INDENT 2.0
.IP \(bu 2
ff5ec86 Work with seconds
.IP \(bu 2
7264008 Fix some lint (remove whitespace)\(ga
.IP \(bu 2
4f9973d Improve timeout in delete
.IP \(bu 2
a6ecb75 Remove testing debug stuff
.IP \(bu 2
7dd7953 Fix start/stop functions
.IP \(bu 2
fade0a6 Merge pull request \fI\%#10\fP from damon\-atkins/patch\-1
.INDENT 2.0
.IP \(bu 2
57c4b9f 2017_win_service_damon
.UNINDENT
.IP \(bu 2
d44eaee Add timeout support to the state
.IP \(bu 2
d579b3e Add timeout parameter
.UNINDENT
.IP \(bu 2
395bae6 Merge pull request \fI\%#49259\fP from gtmanfred/flaky\-2017.7
.INDENT 2.0
.IP \(bu 2
93a576e flaky tests are flaky yo
.IP \(bu 2
f518bd3 mark orchestration state tests as flaky
.UNINDENT
.IP \(bu 2
62cc0df Merge pull request \fI\%#49231\fP from minusf/mount\-check\-name
.INDENT 2.0
.IP \(bu 2
eb5cab3 fix some underhanging indent while here...
.IP \(bu 2
ec2a091 check for mandatory parameters to avoid false positives
.UNINDENT
.IP \(bu 2
d55d484 Merge pull request \fI\%#49242\fP from dwoz/blockreplace_better_fix
.INDENT 2.0
.IP \(bu 2
72c3727 Use six to make sure content is unicode
.IP \(bu 2
1bf0b18 Better blockfix replace
.IP \(bu 2
dd4fcd3 Revert \(dqMultiple block replace test fixes\(dq
.IP \(bu 2
d335842 Use os.linesep.join instead of textwrap.dedent
.UNINDENT
.IP \(bu 2
85f6d36 Merge pull request \fI\%#49236\fP from terminalmage/issue32737
.INDENT 2.0
.IP \(bu 2
233bbae Allow compound matching in eauth config expressions
.UNINDENT
.IP \(bu 2
5ba7f60 Merge pull request \fI\%#49187\fP from erwindon/py27fixnumberformat
.INDENT 2.0
.IP \(bu 2
12261a5 trailing whitespace removal
.IP \(bu 2
2149e22 Fix for \fI\%#45620\fP: \(dqSalt CLI is rounding floats to 2 decimal places\(dq (actually: Salt CLI is using only 12 digits for precision)
.UNINDENT
.IP \(bu 2
f8c55b8 Merge pull request \fI\%#49184\fP from ralish/external_nodes_docs
.INDENT 2.0
.IP \(bu 2
4fe38dc Merge branch \(aq2017.7\(aq into external_nodes_docs
.IP \(bu 2
2e29b29 Remove obsolete documentation on external_nodes setting
.UNINDENT
.IP \(bu 2
65205a4 Merge pull request \fI\%#49185\fP from ralish/enable_gpus_grains_doc
.INDENT 2.0
.IP \(bu 2
2fe675c Update documentation to correctly state enable_gpu_grains default
.UNINDENT
.IP \(bu 2
5aa282e Merge pull request \fI\%#48032\fP from zer0def/parted\-naming
.INDENT 2.0
.IP \(bu 2
563ad25 Merge branch \(aq2017.7\(aq into parted\-naming
.IP \(bu 2
07f8631 Fixed partition names with spaces effectively containing only the first word.
.UNINDENT
.IP \(bu 2
0157eac Merge pull request \fI\%#49164\fP from terminalmage/issue49154
.INDENT 2.0
.IP \(bu 2
c2aba7a Merge branch \(aq2017.7\(aq into issue49154
.IP \(bu 2
b4544d7 Add keep_source integration tests
.IP \(bu 2
82638c6 Fix bug in keep_source for non\-templated salt:// file sources
.UNINDENT
.IP \(bu 2
b510441 Merge pull request \fI\%#49179\fP from dwoz/test_unit_states_file
.INDENT 2.0
.IP \(bu 2
913ea5e Fix directory unit test
.IP \(bu 2
3363238 Account for normalized dirs in unit tests
.UNINDENT
.IP \(bu 2
7486fd5 Merge pull request \fI\%#49162\fP from erwindon/wheel_error_error
.INDENT 2.0
.IP \(bu 2
ca5df04 Merge branch \(aq2017.7\(aq into wheel_error_error
.IP \(bu 2
4335c5c Must have 2 lines between imports and code
.IP \(bu 2
ec1f013 Improved solution as per @dwoz\(aqs suggestion
.IP \(bu 2
20f134e Fixed unknown \(aqexceptions\(aq under Python3 (\fI\%#49152\fP)
.UNINDENT
.IP \(bu 2
7043286 Merge pull request \fI\%#49143\fP from Ch3LL/bp\-49142
.INDENT 2.0
.IP \(bu 2
d2e73cc Remove \-Z script_arg for cloud tests
.UNINDENT
.IP \(bu 2
8ab55f5 Merge pull request \fI\%#49167\fP from dwoz/filefix
.INDENT 2.0
.IP \(bu 2
b5ba073 Simplify dict keys lookup
.IP \(bu 2
6844251 Fix remaining file state integration tests (py3)
.UNINDENT
.IP \(bu 2
90bd560 Merge pull request \fI\%#49163\fP from dwoz/tmp_dir
.INDENT 2.0
.IP \(bu 2
3384864 add Exception type
.IP \(bu 2
9da79dd0 Allow test suite to finish if tmp dir removal fails
.UNINDENT
.IP \(bu 2
aa01a67 Merge pull request \fI\%#49136\fP from Ch3LL/bootstrap_2017.7
.INDENT 2.0
.IP \(bu 2
de40dfb [2017.7] Update bootstrap script to latest release (2018.08.15)
.UNINDENT
.IP \(bu 2
29fccbf Merge pull request \fI\%#49118\fP from dwoz/test_file_fixes
.INDENT 2.0
.IP \(bu 2
c6b781e Multiple fixes for integration.states.test_file
.UNINDENT
.IP \(bu 2
133e400 Merge pull request \fI\%#49103\fP from dwoz/cmd_test_fix
.IP \(bu 2
566a4ea Install the launcher so we can execute py files
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#1075\fP: (\fI\%Ch3LL\fP) [2018.3.3] arch python3 tests do not finish (refs: \fI\%#49303\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49303\fP: (\fI\%gtmanfred\fP) use os._exit instead of sys.exit when daemonizing
@ \fI2018\-08\-24 14:15:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
4c81c2e Merge pull request \fI\%#49303\fP from gtmanfred/forking
.IP \(bu 2
e06ce49 use os._exit instead of sys.exit when daemonizing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49276\fP: (\fI\%terminalmage\fP) Fix paths to moved functions
@ \fI2018\-08\-23 16:38:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
158c1ca Merge pull request \fI\%#49276\fP from terminalmage/fix\-moved\-funcs
.IP \(bu 2
322a988 Fix paths to moved functions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49270\fP: (\fI\%dwoz\fP) Add async helper to test_sock_path_len
@ \fI2018\-08\-23 16:17:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
ef39f85 Merge pull request \fI\%#49270\fP from dwoz/test_event_fix
.IP \(bu 2
51bf79a Add async helper to test_sock_path_len
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49199\fP: (\fI\%jacobweinstock\fP) Fix typeerror unicode
@ \fI2018\-08\-23 14:38:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
5da743a Merge pull request \fI\%#49199\fP from jacobweinstock/fix\-typeerror\-unicode
.IP \(bu 2
25608ef Merge branch \(aq2018.3\(aq into fix\-typeerror\-unicode
.IP \(bu 2
11ad11c add unicode_literals back to handle logging and other things.
.IP \(bu 2
6944baf add salt.utils.stringutils.to_bytes. add comment on unicode_literals.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49174\fP: (\fI\%rbthomp\fP) Beacon diskusage reporting incorrect diskusage value.  (refs: \fI\%#49264\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49264\fP: (\fI\%gtmanfred\fP) fix diskusage beacon
@ \fI2018\-08\-23 14:36:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
e28f8f1 Merge pull request \fI\%#49264\fP from gtmanfred/diskusage
.IP \(bu 2
15857c2c fix diskusage
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49253\fP: (\fI\%gtmanfred\fP) skip ID 7 for vmware hard drives (refs: \fI\%#49278\fP)
@ \fI2018\-08\-23 14:35:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
f6b2b93 Merge pull request \fI\%#49253\fP from gtmanfred/vmware
.IP \(bu 2
6e776ca skip ID 7 for vmware hard drives
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49159\fP: (\fI\%wenxin\-wang\fP) incorrect default value of minion\(aqs \(aqipv6\(aq option  (refs: \fI\%#49263\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49263\fP: (\fI\%terminalmage\fP) Revert default value for ipv6 to None
@ \fI2018\-08\-23 13:02:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
2a2bd48 Merge pull request \fI\%#49263\fP from terminalmage/issue49159
.IP \(bu 2
bf5d907 Revert default value for ipv6 to None
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49244\fP: (\fI\%dwoz\fP) Test fixes: unit.fileserver.test_gitfs
@ \fI2018\-08\-22 20:19:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec32428 Merge pull request \fI\%#49244\fP from dwoz/gitfs_fixes
.IP \(bu 2
b533fa1 Simplify by using to_unicode helper
.IP \(bu 2
5a0cda5 Older GitPython version do not have a close method
.IP \(bu 2
7452715 Fix up fileserver.test_gitfs tests on windows
.IP \(bu 2
800aa25 Remove unicode filenames on windows python 2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49265\fP: (\fI\%terminalmage\fP) Fix failing unit file module unit tests
@ \fI2018\-08\-22 19:35:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d7f846 Merge pull request \fI\%#49265\fP from terminalmage/fix\-failing\-file\-tests
.IP \(bu 2
6b51f71 Fix failing unit file module unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49240\fP: (\fI\%dwoz\fP) file state test fixes
@ \fI2018\-08\-22 18:16:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
4634752 Merge pull request \fI\%#49240\fP from dwoz/state_tests
.IP \(bu 2
1679a19 Work around listdir encoding issues on py2 windows
.IP \(bu 2
07ed841 file state test fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49260\fP: (\fI\%gtmanfred\fP) [2018.3] flaky tests
@ \fI2018\-08\-22 16:40:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
55ded9f Merge pull request \fI\%#49260\fP from gtmanfred/flaky\-2018.3
.IP \(bu 2
41973ff flaky tests are flaky yo
.IP \(bu 2
c927f1b mark orchestration state tests as flaky
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49245\fP: (\fI\%dwoz\fP) Skip grep unit tests on windows
@ \fI2018\-08\-22 15:18:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
6d023ca Merge pull request \fI\%#49245\fP from dwoz/skip_grep_windows
.IP \(bu 2
e305891 Skip grep unit tests on windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49243\fP: (\fI\%dwoz\fP) Revert newline translation change
@ \fI2018\-08\-22 15:12:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
75beede Merge pull request \fI\%#49243\fP from dwoz/fileserver_tests
.IP \(bu 2
86e3c46 Revert newline translation change
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48545\fP: (\fI\%bbinet\fP) Fix unreachable ssh\-id\-wrapper template when root_dir is relative
@ \fI2018\-08\-21 15:12:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
60605f0 Merge pull request \fI\%#48545\fP from bbinet/fix\-unreacheable\-ssh\-id\-wrapper
.IP \(bu 2
284dcf7 Fix unreachable ssh\-id\-wrapper template when root_dir is relative
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49204\fP: (\fI\%mchugh19\fP) file.directory state fails if directory contains an invalid symlink (refs: \fI\%#49209\fP, \fI\%#49827\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49209\fP: (\fI\%gtmanfred\fP) don\(aqt blow up check_perms if lsattr file doesn\(aqt exist
@ \fI2018\-08\-20 19:02:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
a4c51a9 Merge pull request \fI\%#49209\fP from gtmanfred/lsattr
.IP \(bu 2
ab918ca don\(aqt blow up check_perms if lsattr file doesn\(aqt exist
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49060\fP: (\fI\%The\-Loeki\fP) On Py3, redis job cache throws TypeError bytes / str   (refs: \fI\%#49190\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49190\fP: (\fI\%The\-Loeki\fP) decode_reponses=True on all Redis API interfaces
@ \fI2018\-08\-20 18:57:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
d29af00 Merge pull request \fI\%#49190\fP from The\-Loeki/redis\-fix
.IP \(bu 2
d126318 Merge branch \(aq2018.3\(aq into redis\-fix
.IP \(bu 2
7ff72eb redis cache no utf8 of course
.IP \(bu 2
bdaef39 decode_reponses=True on all Redis API interfaces
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49197\fP: (\fI\%dwoz\fP) File state line ending fixes
@ \fI2018\-08\-20 18:45:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
644ba3d Merge pull request \fI\%#49197\fP from dwoz/test_fix
.IP \(bu 2
a7cfe35 File state line ending fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49192\fP: (\fI\%dwoz\fP) Test fixes flaky test and unicode environment key/value
@ \fI2018\-08\-19 10:48:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
aaa9e37 Merge pull request \fI\%#49192\fP from dwoz/git_test_fix_ng
.IP \(bu 2
8ea89e9 Test fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49191\fP: (\fI\%The\-Loeki\fP) Make salt.utils.vault._get_connection publicly available
@ \fI2018\-08\-19 10:39:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
63cc737 Merge pull request \fI\%#49191\fP from The\-Loeki/vault_publ_conn
.IP \(bu 2
cab4192 publicize salt.utils.get_vault_connection()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49189\fP: (\fI\%dwoz\fP) Merge pull request \fI\%#49171\fP from Ch3LL/bp\-49103
@ \fI2018\-08\-18 20:51:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49171\fP: (\fI\%Ch3LL\fP) [2018.3.3] cherry pick \fI\%#49103\fP  (refs: \fI\%#49189\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49103\fP: (\fI\%dwoz\fP) Install the launcher so we can execute py files (refs: \fI\%#49189\fP, \fI\%#49171\fP)
.IP \(bu 2
1d843d4 Merge pull request \fI\%#49189\fP from dwoz/cmd_test_fix
.IP \(bu 2
8fd0c38 Merge pull request \fI\%#49171\fP from Ch3LL/bp\-49103
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49188\fP: (\fI\%cachedout\fP) Fix bug in test_pkg
@ \fI2018\-08\-18 17:36:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
5f905d7 Merge pull request \fI\%#49188\fP from cachedout/fix_test_pkg
.IP \(bu 2
2cd6519 Fix bug in test_pkg
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49056\fP: (\fI\%Ch3LL\fP) Add orch runner with mine.get integration tests
@ \fI2018\-08\-18 12:54:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
6fb8d4a Merge pull request \fI\%#49056\fP from Ch3LL/test_mine
.IP \(bu 2
3a8fed5 Handle race condition when running mine.update in orch mine test
.IP \(bu 2
b4e421c Add orch runner with mine.get integration tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49126\fP: (\fI\%The\-Loeki\fP) TLS cert_info fixes
@ \fI2018\-08\-18 12:19:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49123\fP: (\fI\%The\-Loeki\fP) Fix return of tls.cert_info extensions (refs: \fI\%#49126\fP)
.IP \(bu 2
0d0e11d Merge pull request \fI\%#49126\fP from The\-Loeki/tls\-impr
.IP \(bu 2
22240c0 Merge branch \(aq2018.3\(aq into tls\-impr
.IP \(bu 2
3ce2c3e tls.cert_info: strip newlines/spaces from extensions
.IP \(bu 2
d522d01 tls alt_names fix
.IP \(bu 2
d435dbc Fix bytes\-return of tls.cert_info extensions
.IP \(bu 2
9c7d3ea TLS cert_info: Accept IP Addresses as valid alt_names
.IP \(bu 2
7d6ecaf tls.check_info: Allow PEM as string input
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49186\fP: (\fI\%dwoz\fP) Fix typo in \fI\%#49180\fP
@ \fI2018\-08\-18 12:07:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49180\fP: (\fI\%dwoz\fP) Cherry\-pick test fixes (refs: \fI\%#49186\fP)
.IP \(bu 2
7dd70eb Merge pull request \fI\%#49186\fP from dwoz/test_fixes
.IP \(bu 2
95efc51 Fix typo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49180\fP: (\fI\%dwoz\fP) Cherry\-pick test fixes (refs: \fI\%#49186\fP)
@ \fI2018\-08\-18 04:08:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
6d57ac1 Merge pull request \fI\%#49180\fP from dwoz/test_fixes
.IP \(bu 2
3c49544 Account for file renames
.IP \(bu 2
acc144d Fix directory unit test
.IP \(bu 2
a7ee07a Fix is_windows checks
.IP \(bu 2
74b197f Account for normalized dirs in unit tests
.IP \(bu 2
a18d937 Merge pull request \fI\%#49167\fP from dwoz/filefix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49091\fP: (\fI\%terminalmage\fP) Rename/re\-organize test files in 2018.3 branch
@ \fI2018\-08\-17 12:26:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47337\fP: (\fI\%terminalmage\fP) Modify runtests.py to run a subset of tests based on filenames (refs: \fI\%#49091\fP)
.IP \(bu 2
8bda1e5 Merge pull request \fI\%#49091\fP from terminalmage/rename\-test\-files
.IP \(bu 2
3d8523b Fix import for moved module
.IP \(bu 2
613f061 Lint
.IP \(bu 2
81f272f Rename outputter tests to match naming convention
.IP \(bu 2
fba0336 Rename venafi test module to bring it closer to the naming convention
.IP \(bu 2
9c14500 Rename exec module integration test files to respect naming convention
.IP \(bu 2
91fa09e Rename providers to clouds to respect naming convention
.IP \(bu 2
d56dcdd Rename \(dqproviders\(dq dir to \(dqclouds\(dq to respect naming convention
.IP \(bu 2
f1b7d54 Rename virtualenv state test module to respect naming convention
.IP \(bu 2
c1f94db Split ssh state tests into separate modules to respect naming convention
.IP \(bu 2
9c8ba4a Split mysql database tests into two modules to respect naming convention
.IP \(bu 2
d51748e Rename some files to avoid them being identified as test modules
.IP \(bu 2
1fccbf7 Rename acl unit test module to confirm to naming convention
.IP \(bu 2
160223d Consolidate/move fileclient/fileserver tests to conform to naming convention
.IP \(bu 2
1aacf77 Rename/consolidate salt.utils unit tests to conform to naming convention
.IP \(bu 2
5a0990b Rename pillar unit test modules to reflect naming convention
.IP \(bu 2
516594b Consolidate netapi tests and move them to reflect naming convention
.IP \(bu 2
8f5fef5 Consolitdate and move salt\-ssh unit tests to proper location
.IP \(bu 2
9801ce3 Consolidate and move loader tests to test/unit/test_loader.py
.IP \(bu 2
f72bbc5 Rename beacon unit test modules to conform with naming convention
.IP \(bu 2
fa76cb6 Move inspectlib tests to conform with naming convention
.IP \(bu 2
81e3823 Move shared kernelpkg test cases to tests/support/
.IP \(bu 2
e0d95b6 Consolidate misplaced tests into tests/unit/test_config.py
.IP \(bu 2
3a1ec12 Rename slack engine test file to respect naming convention
.IP \(bu 2
c9c9d20 Rename test_map_conf test file to respect naming convention
.IP \(bu 2
5c936c0 Rename the aptpkg state module to respect naming convention
.IP \(bu 2
ac50eb8 Remove redundant \(dqtest\(dq from filename
.IP \(bu 2
b03a563 Move jinja templating tests alongside salt/utils/jinja.py\(aqs tests
.IP \(bu 2
b49d8df Fix bad copypasta in docstring
.IP \(bu 2
069102b Rename sentry returner test to match naming convention
.IP \(bu 2
2398083 Use tests.support.paths instead of deprecated integration module
.IP \(bu 2
ffb842d Move salt.utils.context tests to their proper location
.IP \(bu 2
d69069b Move context cache tests to their proper location
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49062\fP: (\fI\%weswhet\fP) fix memoize on available macOS services
@ \fI2018\-08\-15 15:34:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
c8510a6 Merge pull request \fI\%#49062\fP from weswhet/fix\-mac\-available\-services
.IP \(bu 2
f1b40c4 decorator link fix, updating context names, as well as updating macutils tests for latest changes
.IP \(bu 2
1e4497d fixing an issue with memoize on macOS services, switching to useing __context__ instead
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#49100\fP: (\fI\%pruiz\fP) salt.utils.yamldumper.dump/safe_dump incorrectly return \(aqstr\(aq instead of unicode on python2.7 (centos) (refs: \fI\%#49125\fP)
.IP \(bu 2
\fBPR\fP \fI\%#49125\fP: (\fI\%terminalmage\fP) Ensure that we don\(aqt feed jinja2.Markup() a str type
@ \fI2018\-08\-15 04:02:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
21435be Merge pull request \fI\%#49125\fP from terminalmage/issue49100
.IP \(bu 2
ec258e2 Add integration tests for yaml and json filters
.IP \(bu 2
f5f16cf Ensure that we don\(aqt feed jinja2.Markup() a str type
.UNINDENT
.UNINDENT
.SS Salt 2018.3.5 Release Notes
.sp
Version 2018.3.5 is a CVE\-fix release for \fI\%2018.3.0\fP\&.
.SS Security Fix
.sp
\fBCVE\-2019\-17361\fP
.sp
With the Salt NetAPI enabled in addition to having a SSH roster defined,
unauthenticated access is possible when specifying the client as SSH.
Additionally, when the raw_shell option is specified any arbitrary command
may be run on the Salt master when specifying SSH options.
.SS Salt 2017.7.0 Release Notes \- Codename Nitrogen
.SS Python 3
.sp
The 2017.7 Salt Release adds initial Python 3 support.
.sp
The default Python version of Salt will remain Python 2, although Python 3 packages will be supplied for users who want to help test this new feature.
.SS Python 2.6 Deprecation
.sp
Salt will no longer support Python 2.6. We will provide python2.7 packages on our \fI\%repo\fP for RedHat and CentOS 6 to ensure users can still run Salt on these platforms.
.sp
As this will impact the installation of additional dependencies for salt modules please use pip packages if there is not a package available in a repository. You will need to install the python27\-pip package to get access to the correct pip27 executable: \fByum install python27\-pip\fP
.SS Known Issues
.sp
The following salt\-cloud drivers have known issues running with Python 3. These drivers will not work with Python 3, and Python 2.7 should be used instead:
.INDENT 0.0
.IP \(bu 2
Joyent
.IP \(bu 2
When running under Python 3, users who require Unicode support should ensure that a locale is set on their machines.
Users using the \fIC\fP locale are advised to switch to a UTF\-aware locale to ensure proper functionality with Salt with Python 3.
.UNINDENT
.SS Remember to update the Salt Master first
.sp
Salt\(aqs policy has always been that when upgrading, the minion should never be
on a newer version than the master.  Specifically with this update, because of
changes in the fileclient, the 2017.7 minion requires a 2017.7 master.
.sp
Backwards compatibility is still maintained, so older minions can still be used.
.sp
More information can be found in the \fI\%Salt FAQ\fP
.SS States Added for Management of systemd Unit Masking
.sp
The \fI\%service.masked\fP and
\fI\%service.umasked\fP states have been
added to allow Salt to manage masking of systemd units.
.sp
Additionally, the following functions in the \fBsystemd\fP execution module have changed to accommodate the fact
that indefinite and runtime masks can co\-exist for the same unit:
.INDENT 0.0
.IP \(bu 2
\fBservice.masked\fP \- The return from
this function has changed from previous releases. Before, \fBFalse\fP would be
returned if the unit was not masked, and the output of \fBsystemctl is\-enabled
<unit name>\fP would be returned if the unit was masked. However, since
indefinite and runtime masks can exist for the same unit at the same time,
this function has been altered to accept a \fBruntime\fP argument. If \fBTrue\fP,
the minion will be checked for a runtime mask assigned to the named unit. If
\fBFalse\fP, then the minion will be checked for an indefinite mask. If one is
found, \fBTrue\fP will be returned. If not, then \fBFalse\fP will be returned.
.IP \(bu 2
\fBservice.masked\fP \- This function used
to just run \fBsystemctl is\-enabled <unit name>\fP and based on the return
from this function the corresponding mask type would be removed. However, if
both runtime and indefinite masks are set for the same unit, then \fBsystemctl
is\-enabled <unit name>\fP would show just the indefinite mask. The indefinite
mask would be removed, but the runtime mask would remain. The function has
been modified to accept a \fBruntime\fP argument, and will attempt to remove a
runtime mask if that argument is set to \fBTrue\fP\&. If set to \fBFalse\fP, it
will attempt to remove an indefinite mask.
.UNINDENT
.sp
These new \fBruntime\fP arguments default to \fBFalse\fP\&.
.SS Pillar Encryption
.sp
Beginning in 2016.3.0 the CLI pillar data passed to several functions could
conditionally be passed through a renderer to be decrypted. This functionality
has now been extended to pillar SLS files as well. See \fI\%here\fP for detailed documentation on this feature.
.SS Grains Changes
.INDENT 0.0
.IP \(bu 2
The \fBosmajorrelease\fP grain has been changed from a string to an integer.
State files, especially those using a templating language like Jinja, may
need to be adjusted to account for this change.
.IP \(bu 2
Add ability to specify disk backing mode in the VMWare salt cloud profile.
.UNINDENT
.SS State Module Changes
.INDENT 0.0
.IP \(bu 2
The \fI\%service.running\fP and
\fI\%service.dead\fP states now support a
\fBno_block\fP argument which, when set to \fBTrue\fP on systemd minions, will
start/stop the service using the \fB\-\-no\-block\fP flag in the \fBsystemctl\fP
command. On non\-systemd minions, a warning will be issued.
.IP \(bu 2
The \fI\%module.run\fP state has dropped its
previous syntax with \fBm_\fP prefix for reserved keywords. Additionally, it
allows running several functions in a batch.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
It is necessary to explicitly turn on the new behavior (see below)
.UNINDENT
.UNINDENT
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
# Before
run_something:
  module.run:
    \- name: mymodule.something
    \- m_name: \(aqsome name\(aq
    \- kwargs: {
      first_arg: \(aqone\(aq,
      second_arg: \(aqtwo\(aq,
      do_stuff: \(aqTrue\(aq
    }

# After
run_something:
  module.run:
    \- mymodule.something:
      \- name: some name
      \- first_arg: one
      \- second_arg: two
      \- do_stuff: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Since a lot of users are already using \fI\%module.run\fP states, this new behavior must currently be
explicitly turned on, to allow users to take their time updating their SLS
files. However, please keep in mind that the new syntax will take effect in
the next feature release of Salt (Oxygen) and the old usage will no longer be
supported at that time.
.sp
Another feature of the new \fI\%module.run\fP is that
it allows calling many functions in a single batch, such as:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
run_something:
  module.run:
    \- mymodule.function_without_parameters:
    \- mymodule.another_function:
      \- myparam
      \- my_other_param
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In a rare case that you have a function that needs to be called several times but
with the different parameters, an additional feature of \(dqtagging\(dq is to the
rescue. In order to tag a function, use a colon delimiter. For example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
run_something:
  module.run:
    \- mymodule.same_function:1:
    \- mymodule.same_function:2:
      \- myparam
      \- my_other_param
    \- mymodule.same_function:3:
      \- foo: bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The example above will run \fImymodule.same_function\fP three times with the
different parameters.
.sp
To enable the new behavior for \fI\%module.run\fP,
add the following to the minion config file:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
use_superseded:
  \- module.run
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
The default for the \fBfingerprint_hash_type\fP option used in the \fBpresent\fP
function in the \fBssh\fP state changed from
\fBmd5\fP to \fBsha256\fP\&.
.UNINDENT
.SS Execution Module Changes
.INDENT 0.0
.IP \(bu 2
Several functions in the \fBsystemd\fP execution
module have gained a \fBno_block\fP argument, which when set to \fBTrue\fP will
use \fB\-\-no\-block\fP in the \fBsystemctl\fP command.
.IP \(bu 2
In the \fBsolarisips\fP \fBpkg\fP module, the
default value for the \fBrefresh\fP argument to the \fBlist_upgrades\fP function
has been changed from \fBFalse\fP to \fBTrue\fP\&. This makes the function more
consistent with all of the other \fBpkg\fP modules (The other
\fBpkg.list_upgrades\fP functions all defaulted to \fBTrue\fP).
.IP \(bu 2
The functions which handle masking in the \fBsystemd\fP module have changed. These changes are described
above alongside the information on the new states which have been added to
manage masking of systemd units.
.IP \(bu 2
The \fI\%pkg.list_repo_pkgs\fP
function for yum/dnf\-based distros has had its default output format changed.
In prior releases, results would be organized by repository. Now, the default
for each package will be a simple list of versions. To get the old behavior,
pass \fBbyrepo=True\fP to the function.
.IP \(bu 2
A \fBpkg.list_repo_pkgs\fP function has been added for both
\fI\%Debian/Ubuntu\fP and
\fBArch Linux\fP\-based distros.
.IP \(bu 2
The \fI\%system\fP module changed its return format
from \(dqHH:MM AM/PM\(dq to \(dqHH:MM:SS AM/PM\(dq for \fIget_system_time\fP\&.
.IP \(bu 2
The default for the \fBfingerprint_hash_type\fP option used in the
\fI\%ssh\fP execution module changed from \fBmd5\fP to
\fBsha256\fP\&.
.UNINDENT
.SS Proxy Module Changes
.sp
The \fI\%proxy_merge_grains_in_module\fP configuration variable
introduced in 2016.3, has been changed, defaulting to \fBTrue\fP\&.
.sp
The connection with the remote device is kept alive by default, when the
module implements the \fBalive\fP function and \fI\%proxy_keep_alive\fP
is set to \fBTrue\fP\&. The polling interval is set using the
\fI\%proxy_keep_alive_interval\fP option which defaults to 1 minute.
.sp
The developers are also able to use the \fI\%proxy_always_alive\fP,
when designing a proxy module flexible enough to open the
connection with the remote device only when required.
.SS Wildcard Versions in \fI\%pkg.installed\fP States
.INDENT 0.0
.IP \(bu 2
The \fI\%pkg.installed\fP state now supports
wildcards in package versions, for the following platforms:
.INDENT 2.0
.IP \(bu 2
SUSE/openSUSE Leap/Thumbleweed
.IP \(bu 2
Debian/Ubuntu
.IP \(bu 2
RHEL/CentOS
.IP \(bu 2
Arch Linux
.UNINDENT
.sp
This support also extends to any derivatives of these distros, which use the
\fI\%aptpkg\fP, \fI\%yumpkg\fP, or
\fBpacman\fP providers for the \fBpkg\fP virtual module.
.sp
Using wildcards can be useful for packages where the release name is built into
the version in some way, such as for RHEL/CentOS which typically has version
numbers like \fB1.2.34\-5.el7\fP\&. An example of the usage for this would be:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
mypkg:
  pkg.installed:
    \- version: \(aq1.2.34*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Master Configuration Additions
.INDENT 0.0
.IP \(bu 2
\fI\%syndic_forward_all_events\fP \- Option on multi\-syndic or single
when connected to multiple masters to be able to send events to all connected
masters.
.IP \(bu 2
\fI\%eauth_acl_module\fP \- In case external auth is enabled master can
get authenticate and get the authorization list from different auth modules.
.IP \(bu 2
\fI\%keep_acl_in_token\fP \- Option that allows master to build ACL once
for each user being authenticated and keep it in the token.
.UNINDENT
.SS Minion Configuration Additions
.INDENT 0.0
.IP \(bu 2
\fI\%pillarenv_from_saltenv\fP \- When set to \fBTrue\fP (default is
\fBFalse\fP), the \fI\%pillarenv\fP option will take the same value as
the effective saltenv when running states. This would allow a user to run
\fBsalt \(aq*\(aq state.apply mysls saltenv=dev\fP, and the SLS for both the state
and pillar data would be sourced from the \fBdev\fP environment, essentially
the equivalent of running \fBsalt \(aq*\(aq state.apply mysls saltenv=dev
pillarenv=dev\fP\&. Note that if \fI\%pillarenv\fP is set in the minion
config file, or if \fBpillarenv\fP is provided on the CLI, it will override
this option.
.UNINDENT
.SS salt\-api Changes
.sp
The \fBrest_cherrypy\fP netapi module has received a few minor improvements:
.INDENT 0.0
.IP \(bu 2
A CORS bugfix.
.IP \(bu 2
A new \fB/token\fP convenience endpoint to generate Salt eauth tokens.
.IP \(bu 2
A proof\-of\-concept JavaScript single\-page application intended to demonstrate
how to use the Server\-Sent Events stream in an application. It is available
in a default install by visiting the \fB/app\fP URL in a browser.
.UNINDENT
.SS Python API Changes
.SS \fBexpr_form\fP Deprecation
.sp
The \fI\%LocalClient\fP\(aqs \fBexpr_form\fP argument has been
deprecated and renamed to \fBtgt_type\fP\&. This change was made due to numerous
reports of confusion among community members, since the targeting method is
published to minions as \fBtgt_type\fP, and appears as \fBtgt_type\fP in the job
cache as well.
.sp
While \fBexpr_form\fP will continue to be supported until the \fB2019.2.0\fP
release cycle (two major releases after this one), those who are using the
\fI\%LocalClient\fP (either directly, or implictly via a
\fI\%netapi module\fP) are encouraged to update their code
to use \fBtgt_type\fP\&.
.SS \fBfull_return\fP Argument in \fBLocalClient\fP and \fBRunnerClient\fP
.sp
An \fBfull_return\fP argument has been added to the \fBcmd\fP and \fBcmd_sync\fP
methods in \fBLocalClient\fP and \fBRunnerClient\fP which causes the return data
structure to include job meta data such as \fBretcode\fP\&.
.sp
This is useful at the Python API:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
>>> import salt.client
>>> client = salt.client.LocalClient()
>>> client.cmd(\(dq*\(dq, \(dqcmd.run\(dq, [\(dqreturn 1\(dq], full_return=True)
{\(aqjerry\(aq: {\(aqjid\(aq: \(aq20170520151213898053\(aq, \(aqret\(aq: \(aq\(aq, \(aqretcode\(aq: 1}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As well as from salt\-api:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
% curl \-b /tmp/cookies.txt \-sS http://localhost:8000 \e
    \-H \(aqContent\-type: application/json\(aq \e
    \-d \(aq[{
        \(dqclient\(dq: \(dqlocal\(dq,
        \(dqtgt\(dq: \(dq*\(dq,
        \(dqfun\(dq: \(dqcmd.run\(dq,
        \(dqarg\(dq: [\(dqreturn 1\(dq],
        \(dqfull_return\(dq: true
    }]\(aq

{\(dqreturn\(dq: [{\(dqjerry\(dq: {\(dqjid\(dq: \(dq20170520151531477653\(dq, \(dqretcode\(dq: 1, \(dqret\(dq: \(dq\(dq}}]}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Jinja
.SS Filters
.sp
New filters in 2017.7.0:
.INDENT 0.0
.IP \(bu 2
\fI\%to_bool\fP
.IP \(bu 2
\fI\%exactly_n_true\fP
.IP \(bu 2
\fI\%exactly_one_true\fP
.IP \(bu 2
\fI\%quote\fP
.IP \(bu 2
\fI\%regex_search\fP
.IP \(bu 2
\fI\%regex_match\fP
.IP \(bu 2
\fI\%uuid\fP
.IP \(bu 2
\fI\%is_list\fP
.IP \(bu 2
\fI\%is_iter\fP
.IP \(bu 2
\fI\%min\fP
.IP \(bu 2
\fI\%max\fP
.IP \(bu 2
\fI\%avg\fP
.IP \(bu 2
\fI\%union\fP
.IP \(bu 2
\fI\%intersect\fP
.IP \(bu 2
\fI\%difference\fP
.IP \(bu 2
\fI\%symmetric_difference\fP
.IP \(bu 2
\fI\%is_sorted\fP
.IP \(bu 2
\fI\%compare_lists\fP
.IP \(bu 2
\fI\%compare_dicts\fP
.IP \(bu 2
\fI\%is_hex\fP
.IP \(bu 2
\fI\%contains_whitespace\fP
.IP \(bu 2
\fI\%substring_in_list\fP
.IP \(bu 2
\fI\%check_whitelist_blacklist\fP
.IP \(bu 2
\fI\%date_format\fP
.IP \(bu 2
\fBstr_to_num\fP
.IP \(bu 2
\fI\%to_bytes\fP
.IP \(bu 2
\fI\%json_decode_list\fP
.IP \(bu 2
\fI\%json_decode_dict\fP
.IP \(bu 2
\fBrand_str\fP
.IP \(bu 2
\fI\%md5\fP
.IP \(bu 2
\fI\%sha256\fP
.IP \(bu 2
\fI\%sha512\fP
.IP \(bu 2
\fI\%base64_encode\fP
.IP \(bu 2
\fI\%base64_decode\fP
.IP \(bu 2
\fI\%hmac\fP
.IP \(bu 2
\fI\%http_query\fP
.IP \(bu 2
\fI\%is_ip\fP
.IP \(bu 2
\fI\%is_ipv4\fP
.IP \(bu 2
\fI\%is_ipv6\fP
.IP \(bu 2
\fI\%ipaddr\fP
.IP \(bu 2
\fI\%ipv4\fP
.IP \(bu 2
\fI\%ipv6\fP
.IP \(bu 2
\fI\%network_hosts\fP
.IP \(bu 2
\fI\%network_size\fP
.IP \(bu 2
\fI\%gen_mac\fP
.IP \(bu 2
\fI\%mac_str_to_bytes\fP
.IP \(bu 2
\fI\%dns_check\fP
.IP \(bu 2
\fI\%is_text_file\fP
.IP \(bu 2
\fI\%is_binary_file\fP
.IP \(bu 2
\fI\%is_empty_file\fP
.IP \(bu 2
\fI\%file_hashsum\fP
.IP \(bu 2
\fI\%list_files\fP
.IP \(bu 2
\fI\%path_join\fP
.IP \(bu 2
\fI\%which\fP
.UNINDENT
.SS Logs
.sp
Another new feature \- although not limited to Jinja only \-
is being able to log debug messages directly from the template:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- do salt.log.error(\(aqlogging from jinja\(aq) \-%}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See the \fI\%logs\fP paragraph.
.SS Network Automation
.SS NAPALM
.sp
Introduced in 2016.11, the modules for cross\-vendor network automation
have been improved, enhanced and widenened in scope:
.INDENT 0.0
.IP \(bu 2
Manage network devices like servers: the NAPALM modules have been transformed
so they can run in both proxy and regular minions. That means, if the
operating system allows, the salt\-minion package can be installed directly
on the network gear. Examples of such devices (also covered by NAPALM)
include: Arista, Cumulus, Cisco IOS\-XR or Cisco Nexus.
.IP \(bu 2
Not always alive: in certain less dynamic environments,
maintaining the remote connection permanently open with the network device
is not always beneficial. In those particular cases, the user can select
to initialize the connection only when needed, by specifying the field
\fBalways_alive: false\fP in the \fI\%proxy configuration\fP
or using the \fI\%proxy_always_alive\fP option.
.IP \(bu 2
Proxy keepalive: due to external factors, the connection with the remote
device can be dropped, e.g.: packet loss, idle time (no commands issued
within a couple of minutes or seconds), or simply the device decides to kill
the process. In 2017.7.0 we have introduced the functionality to re\-establish
the connection. One can disable this feature through the
\fI\%proxy_keep_alive\fP option and adjust the polling frequency
specifying a custom value for \fI\%proxy_keep_alive_interval\fP,
in minutes.
.UNINDENT
.sp
New modules:
.INDENT 0.0
.IP \(bu 2
\fI\%Netconfig state module\fP \- Manage the configuration
of network devices using arbitrary templates and the Salt\-specific
advanced templating methodologies.
.IP \(bu 2
\fBNetwork ACL execution module\fP \- Generate and
load ACL (firewall) configuration on network devices.
.IP \(bu 2
\fI\%Network ACL state\fP \- Manage the firewall
configuration. It only requires writing the pillar structure correctly!
.IP \(bu 2
\fI\%NAPALM YANG execution module\fP \- Parse,
generate and load native device configuration in a standard way,
using the OpenConfig/IETF models. This module contains also helpers for
the states.
.IP \(bu 2
\fBNAPALM YANG state module\fP \- Manage the
network device configuration according to the YANG models (OpenConfig or IETF).
.IP \(bu 2
\fI\%NET finder\fP \- Runner to find details easily and
fast. It\(aqs smart enough to know what you are looking for. It will search
in the details of the network interfaces, IP addresses, MAC address tables,
ARP tables and LLDP neighbors.
.IP \(bu 2
\fI\%BGP finder\fP \- Runner to search BGP neighbors details.
.IP \(bu 2
\fI\%NAPALM syslog\fP \- Engine to import events
from the napalm\-logs library into the Salt event bus. The events are based
on the syslog messages from the network devices and structured following
the OpenConfig/IETF YANG models.
.IP \(bu 2
\fBNAPALM Helpers\fP \- Generic helpers for
NAPALM\-related operations. For example, the
\fBCompliance report\fP function
can be used inside the state modules to compare the expected and the
existing configuration.
.UNINDENT
.sp
New functions:
.INDENT 0.0
.IP \(bu 2
\fI\%Configuration getter\fP \- Return
the whole configuration of the network device.
.IP \(bu 2
\fI\%Optics getter\fP \- Fetches
the power usage on the various transceivers installed on the network device
(in dBm).
.UNINDENT
.sp
New grains: \fI\%Host\fP,
\fI\%Host DNS\fP,
\fI\%Username\fP and
\fI\%Optional args\fP\&.
.SS Custom Refspecs in GitFS / git_pillar / winrepo
.sp
It is now possible to specify the refspecs to use when fetching from remote
repositories for GitFS, git_pillar, and winrepo. More information on how this
feature works can be found \fI\%here\fP in the GitFS
Walkthrough. The git_pillar and winrepo versions of this feature work the same
as their GitFS counterpart.
.SS git_pillar \(dqmountpoints\(dq Feature Added
.sp
See \fI\%here\fP for detailed documentation.
.SS Big Improvements to Docker Support
.sp
The old \fBdocker\fP state and execution modules have been moved to
\fI\%salt\-contrib\fP\&. The \fBdockerng\fP execution module has been renamed to
\fBdocker\fP and now serves as Salt\(aqs official Docker
execution module.
.sp
The old \fBdockerng\fP state module has been split into 4 state modules:
.INDENT 0.0
.IP \(bu 2
\fI\%docker_container\fP \- States to manage
Docker containers
.IP \(bu 2
\fI\%docker_image\fP \- States to manage Docker
images
.IP \(bu 2
\fI\%docker_volume\fP \- States to manage
Docker volumes
.IP \(bu 2
\fI\%docker_network\fP \- States to manage
Docker networks
.UNINDENT
.sp
The reason for this change was to make states and requisites more clear. For
example, imagine this SLS:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myuser/appimage:
  docker.image_present:
    \- sls: docker.images.appimage

myapp:
  docker.running:
    \- image: myuser/appimage
    \- require:
      \- docker: myuser/appimage
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The new syntax would be:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
myuser/appimage:
  docker_image.present:
    \- sls: docker.images.appimage

myapp:
  docker_container.running:
    \- image: myuser/appimage
    \- require:
      \- docker_image: myuser/appimage
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is similar to how Salt handles MySQL, MongoDB, Zabbix, and other cases
where the same execution module is used to manage several different kinds
of objects (users, databases, roles, etc.).
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
With the \fI\%Moby announcement\fP coming at this year\(aqs \fI\%DockerCon\fP, Salt\(aqs
\fI\%docker\fP execution module (as well as the
state modules) work interchangeably when \fBdocker\fP is replaced with
\fBmoby\fP (e.g.  \fI\%moby_container.running\fP, \fI\%moby_image.present\fP, \fI\%moby.inspect_container\fP, etc.)
.UNINDENT
.UNINDENT
.sp
The old syntax will continue to work until the \fB2019.2.0\fP release of Salt.
The old \fBdockerng\fP naming will also continue to work until that release, so
no immediate changes need to be made to your SLS files (unless you were still
using the old docker states that have been moved to \fI\%salt\-contrib\fP).
.sp
The \fI\%docker_container.running\fP
state has undergone a significant change in how it determines whether or not a
container needs to be replaced. Rather than comparing individual arguments to
their corresponding values in the named container, a temporary container is
created (but not started) using the passed arguments. The two containers are
then compared to each other to determine whether or not there are changes, and
if so, the old container is stopped and destroyed, and the temporary container
is renamed and started.
.sp
Salt still needs to translate arguments into the format which docker\-py
expects, but if it does not properly do so, the \fI\%skip_translate\fP argument can be used to skip input
translation on an argument\-by\-argument basis, and you can then format your SLS
file to pass the data in the format that the docker\-py expects. This allows you
to work around any changes in Docker\(aqs API or issues with the input
translation, and continue to manage your Docker containers using Salt. Read the
documentation for \fI\%skip_translate\fP for more information.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When running the \fI\%docker_container.running\fP state for the first time after
upgrading to 2017.7.0, your container(s) may be replaced. The changes may
show diffs for certain parameters which say that the old value was an empty
string, and the new value is \fBNone\fP\&. This is due to the fact that in
prior releases Salt was passing empty strings for these values when
creating the container if they were undefined in the SLS file, where now
Salt simply does not pass any arguments not explicitly defined in the SLS
file. Subsequent runs of the state should not replace the container if the
configuration remains unchanged.
.UNINDENT
.UNINDENT
.SS New SSH Cache Roster
.sp
The \fI\%SSH cache Roster\fP has been rewritten from scratch
to increase its usefulness.  The new roster supports all minion matchers, so it
is now possible to target minions identically through \fIsalt\fP and \fIsalt\-ssh\fP\&.
.sp
Using the new \fBroster_order\fP configuration syntax it\(aqs now possible to
compose a roster out of any combination of grains, pillar and mine data and
even Salt SDB URLs.  The new release is also fully IPv4 and IPv6 enabled and
even has support for CIDR ranges.
.SS Salt\-SSH Default Options
.sp
Defaults for rosters can now be set, so that they don\(aqt have to be set on every
entry in a roster or specified from the commandline.
.sp
The new option is \fI\%roster_defaults\fP and is specified in the master
config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
roster_defaults:
  user: daniel
  sudo: True
  priv: /root/.ssh/id_rsa
  tty: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Blacklist or Whitelist Extmod Sync
.sp
The modules that are synced to minions can now be limited.
.sp
The following configuration options have been added for the master:
.INDENT 0.0
.IP \(bu 2
\fI\%extmod_whitelist\fP
.IP \(bu 2
\fI\%extmod_blacklist\fP
.UNINDENT
.sp
and for the minion:
.INDENT 0.0
.IP \(bu 2
\fI\%extmod_whitelist\fP
.IP \(bu 2
\fI\%extmod_blacklist\fP
.UNINDENT
.SS Additional Features
.INDENT 0.0
.IP \(bu 2
The \fI\%mine.update\fP function
has a new optional argument \fBmine_functions\fP that can be used
to refresh mine functions at a more specific interval
than scheduled using the \fBmine_interval\fP option.
However, this argument can be used by explicit schedule.
For example, if we need the mines for \fBnet.lldp\fP to be refreshed
every 12 hours:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  lldp_mine_update:
    function: mine.update
    kwargs:
      mine_functions:
        net.lldp: []
    hours: 12
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
The \fBsalt\fP runner has a new function: \fI\%salt.execute\fP\&.
It is mainly a shortcut to facilitate the execution of various functions
from other runners, e.g.:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
ret1 = __salt__[\(dqsalt.execute\(dq](\(dq*\(dq, \(dqmod.fun\(dq)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS New Modules
.SS Beacons
.INDENT 0.0
.IP \(bu 2
\fBsalt.beacons.log\fP
.UNINDENT
.SS Cache
.INDENT 0.0
.IP \(bu 2
\fI\%salt.cache.redis_cache\fP
.UNINDENT
.SS Engines
.INDENT 0.0
.IP \(bu 2
\fI\%salt.engines.stalekey\fP
.IP \(bu 2
\fI\%salt.engines.junos_syslog\fP
.IP \(bu 2
\fI\%salt.engines.napalm_syslog\fP
.UNINDENT
.SS Execution modules
.INDENT 0.0
.IP \(bu 2
\fBsalt.modules.apk\fP
.IP \(bu 2
\fI\%salt.modules.at_solaris\fP
.IP \(bu 2
\fI\%salt.modules.boto_kinesis\fP
.IP \(bu 2
\fI\%salt.modules.boto3_elasticache\fP
.IP \(bu 2
\fI\%salt.modules.boto3_route53\fP
.IP \(bu 2
\fI\%salt.modules.capirca_acl\fP
.IP \(bu 2
\fI\%salt.modules.freebsd_update\fP
.IP \(bu 2
\fI\%salt.modules.grafana4\fP
.IP \(bu 2
\fI\%salt.modules.heat\fP
.IP \(bu 2
\fI\%salt.modules.icinga2\fP
.IP \(bu 2
\fI\%salt.modules.kubernetesmod\fP
.IP \(bu 2
\fI\%salt.modules.logmod\fP
.IP \(bu 2
\fI\%salt.modules.mattermost\fP
.IP \(bu 2
\fBsalt.modules.namecheap_dns\fP
.IP \(bu 2
\fI\%salt.modules.namecheap_domains\fP
.IP \(bu 2
\fBsalt.modules.namecheap_ns\fP
.IP \(bu 2
\fI\%salt.modules.namecheap_users\fP
.IP \(bu 2
\fI\%salt.modules.namecheap_ssl\fP
.IP \(bu 2
\fBsalt.modules.napalm\fP
.IP \(bu 2
\fBsalt.modules.napalm_acl\fP
.IP \(bu 2
\fI\%salt.modules.napalm_yang_mod\fP
.IP \(bu 2
\fI\%salt.modules.pdbedit\fP
.IP \(bu 2
\fI\%salt.modules.solrcloud\fP
.IP \(bu 2
\fI\%salt.modules.statuspage\fP
.IP \(bu 2
\fI\%salt.modules.zonecfg\fP
.IP \(bu 2
\fI\%salt.modules.zoneadm\fP
.UNINDENT
.SS Grains
.INDENT 0.0
.IP \(bu 2
\fI\%salt.grains.metadata\fP
.IP \(bu 2
\fI\%salt.grains.mdata\fP
.UNINDENT
.SS Outputters
.INDENT 0.0
.IP \(bu 2
\fI\%salt.output.table_out\fP
.UNINDENT
.SS Pillar
.INDENT 0.0
.IP \(bu 2
\fI\%salt.pillar.postgres\fP
.IP \(bu 2
\fI\%salt.pillar.vmware_pillar\fP
.UNINDENT
.SS Returners
.INDENT 0.0
.IP \(bu 2
\fI\%salt.returners.mattermost_returner\fP
.IP \(bu 2
\fI\%salt.returners.highstate_return\fP
.UNINDENT
.SS Roster
.INDENT 0.0
.IP \(bu 2
\fI\%salt.roster.cache\fP
.UNINDENT
.SS Runners
.INDENT 0.0
.IP \(bu 2
\fI\%salt.runners.bgp\fP
.IP \(bu 2
\fI\%salt.runners.mattermost\fP
.IP \(bu 2
\fI\%salt.runners.net\fP
.UNINDENT
.SS SDB
.INDENT 0.0
.IP \(bu 2
\fI\%salt.sdb.yaml\fP
.IP \(bu 2
\fI\%salt.sdb.tism\fP
.IP \(bu 2
\fI\%salt.sdb.cache\fP
.UNINDENT
.SS States
.INDENT 0.0
.IP \(bu 2
\fI\%salt.states.boto_kinesis\fP
.IP \(bu 2
\fBsalt.states.boto_efs\fP
.IP \(bu 2
\fI\%salt.states.boto3_elasticache\fP
.IP \(bu 2
\fI\%salt.states.boto3_route53\fP
.IP \(bu 2
\fI\%salt.states.docker_container\fP
.IP \(bu 2
\fI\%salt.states.docker_image\fP
.IP \(bu 2
\fI\%salt.states.docker_network\fP
.IP \(bu 2
\fI\%salt.states.docker_volume\fP
.IP \(bu 2
\fI\%salt.states.elasticsearch\fP
.IP \(bu 2
\fI\%salt.states.grafana4_dashboard\fP
.IP \(bu 2
\fI\%salt.states.grafana4_datasource\fP
.IP \(bu 2
\fI\%salt.states.grafana4_org\fP
.IP \(bu 2
\fI\%salt.states.grafana4_user\fP
.IP \(bu 2
\fI\%salt.states.heat\fP
.IP \(bu 2
\fI\%salt.states.icinga2\fP
.IP \(bu 2
\fI\%salt.states.influxdb_continuous_query\fP
.IP \(bu 2
\fI\%salt.states.influxdb_retention_policy\fP
.IP \(bu 2
\fI\%salt.states.kubernetes\fP
.IP \(bu 2
\fI\%salt.states.logadm\fP
.IP \(bu 2
\fI\%salt.states.logrotate\fP
.IP \(bu 2
\fI\%salt.states.msteams\fP
.IP \(bu 2
\fI\%salt.states.netacl\fP
.IP \(bu 2
\fI\%salt.states.netconfig\fP
.IP \(bu 2
\fBsalt.states.netyang\fP
.IP \(bu 2
\fBsalt.states.nix\fP
.IP \(bu 2
\fI\%salt.states.pdbedit\fP
.IP \(bu 2
\fI\%salt.states.solrcloud\fP
.IP \(bu 2
\fI\%salt.states.statuspage\fP
.IP \(bu 2
\fI\%salt.states.vault\fP
.IP \(bu 2
\fI\%salt.states.win_wua\fP
.IP \(bu 2
\fI\%salt.states.zone\fP
.UNINDENT
.SS Deprecations
.SS General Deprecations
.INDENT 0.0
.IP \(bu 2
Removed support for aliasing \fBcmd.run\fP to \fBcmd.shell\fP\&.
.IP \(bu 2
Removed support for Dulwich from \fI\%GitFS\fP\&.
.IP \(bu 2
Beacon configurations should be lists instead of dictionaries.
.IP \(bu 2
The \fBPidfileMixin\fP has been removed. Please use \fBDaemonMixIn\fP instead.
.IP \(bu 2
The \fBuse_pending\fP argument was removed from the \fBsalt.utils.event.get_event\fP
function.
.IP \(bu 2
The \fBpending_tags\fP argument was removed from the \fBsalt.utils.event.get_event\fP
function.
.UNINDENT
.SS Configuration Option Deprecations
.INDENT 0.0
.IP \(bu 2
The \fBclient_acl\fP configuration option has been removed. Please use
\fBpublisher_acl\fP instead.
.IP \(bu 2
The \fBclient_acl_blacklist\fP configuration option has been removed.
Please use \fBpublisher_acl_blacklist\fP instead.
.IP \(bu 2
The \fBwin_gitrepos\fP configuration option has been removed. Please use
the \fBwinrepo_remotes\fP option instead.
.IP \(bu 2
The \fBwin_repo\fP configuration option has been removed. Please use
\fBwinrepo_dir\fP instead.
.IP \(bu 2
The \fBwin_repo_mastercachefile\fP configuration option has been removed.
Please use the \fBwinrepo_cachefile\fP option instead.
.UNINDENT
.SS Module Deprecations
.sp
The \fBgit\fP execution module had the following changes:
.INDENT 0.0
.IP \(bu 2
The \fBfmt\fP argument was removed from the \fBarchive\fP function. Please
use \fBformat\fP instead.
.IP \(bu 2
The \fBrepository\fP argument was removed from the \fBclone\fP function.
Please use \fBurl\fP instead.
.IP \(bu 2
The \fBis_global\fP argument was removed from the \fBconfig_set\fP function.
Please use \fBglobal\fP instead.
.IP \(bu 2
The \fBbranch\fP argument was removed from the \fBmerge\fP function. Please
use \fBrev\fP instead.
.IP \(bu 2
The \fBbranch\fP argument was removed from the \fBpush\fP function. Please
use \fBrev\fP instead.
.UNINDENT
.sp
The \fBglusterfs\fP execution module had the following functions removed:
.INDENT 0.0
.IP \(bu 2
\fBcreate\fP: Please use \fBcreate_volume\fP instead.
.IP \(bu 2
\fBdelete\fP: Please use \fBdelete_volume\fP instead.
.IP \(bu 2
\fBlist_peers\fP: Please use \fBpeer_status\fP instead.
.UNINDENT
.sp
The \fBhtpasswd\fP execution module had the following function removed:
.INDENT 0.0
.IP \(bu 2
\fBuseradd_all\fP: Please use \fBuseradd\fP instead.
.UNINDENT
.sp
The \fBimg\fP execution module has been removed. All of its associated functions
were marked for removal in the 2017.7.0 release. The functions removed in this
module are mapped as follows:
.INDENT 0.0
.IP \(bu 2
\fBmount_image\fP/\fBmnt_image\fP: Please use \fBmount.mount\fP instead.
.IP \(bu 2
\fBumount_image\fP: Please use \fBmount.umount\fP instead.
.IP \(bu 2
\fBbootstrap\fP: Please use \fBgenesis.bootstrap\fP instead.
.UNINDENT
.sp
The \fBsmartos_virt\fP execution module had the following functions removed:
.INDENT 0.0
.IP \(bu 2
\fBcreate\fP: Please use \fBstart\fP instead.
.IP \(bu 2
\fBdestroy\fP Please use \fBstop\fP instead.
.IP \(bu 2
\fBlist_vms\fP: Please use \fBlist_domains\fP instead.
.UNINDENT
.sp
The \fBvirt\fP execution module had the following functions removed:
.INDENT 0.0
.IP \(bu 2
\fBcreate\fP: Please use \fBstart\fP instead.
.IP \(bu 2
\fBdestroy\fP Please use \fBstop\fP instead.
.IP \(bu 2
\fBlist_vms\fP: Please use \fBlist_domains\fP instead.
.UNINDENT
.sp
The \fBvirtualenv_mod\fP execution module had the following changes:
.INDENT 0.0
.IP \(bu 2
The \fBpackage_or_requirement\fP argument was removed from both the
\fBget_resource_path\fP and the \fBget_resource_content\fP functions.
Please use \fBpackage\fP instead.
.IP \(bu 2
The \fBresource_name\fP argument was removed from both the
\fBget_resource_path\fP and \fBget_resource_content\fP functions.
Please use \fBresource\fP instead.
.UNINDENT
.sp
The \fBwin_repo\fP execution module had the following changes:
.INDENT 0.0
.IP \(bu 2
The \fBwin_repo_source_dir\fP option was removed from the \fBwin_repo\fP
module. Please use \fBwinrepo_source_dir\fP instead.
.UNINDENT
.sp
The \fBxapi\fP execution module had the following functions removed:
.INDENT 0.0
.IP \(bu 2
\fBcreate\fP: Please use \fBstart\fP instead.
.IP \(bu 2
\fBdestroy\fP: Please use \fBstop\fP instead.
.IP \(bu 2
\fBlist_vms\fP: Please use \fBlist_domains\fP instead.
.UNINDENT
.sp
The \fBzypper\fP execution module had the following function removed:
.INDENT 0.0
.IP \(bu 2
\fBinfo\fP: Please use \fBinfo_available\fP instead.
.UNINDENT
.SS Pillar Deprecations
.INDENT 0.0
.IP \(bu 2
Support for the \fBraw_data\fP argument for the file_tree ext_pillar has been
removed. Please use \fBkeep_newline\fP instead.
.IP \(bu 2
SQLite3 database connection configuration previously had keys under
pillar. This legacy compatibility has been removed.
.UNINDENT
.SS Proxy Minion Deprecations
.INDENT 0.0
.IP \(bu 2
The \fBproxy_merge_grains_in_module\fP default has been switched from
\fBFalse\fP to \fBTrue\fP\&.
.UNINDENT
.SS Salt\-API Deprecations
.INDENT 0.0
.IP \(bu 2
The \fBSaltAPI.run()\fP function has been removed. Please use the
\fBSaltAPI.start()\fP function instead.
.UNINDENT
.SS Salt\-Cloud Deprecations
.INDENT 0.0
.IP \(bu 2
Support for using the keyword \fBprovider\fP in salt\-cloud provider config
files has been removed. Please use \fBdriver\fP instead. The \fBprovider\fP
keyword should now only be used in cloud profile config files.
.UNINDENT
.SS Salt\-SSH Deprecations
.INDENT 0.0
.IP \(bu 2
The \fBwipe_ssh\fP option for \fBsalt\-ssh\fP has been removed. Please use the
\fBssh_wipe\fP option instead.
.UNINDENT
.SS State Deprecations
.sp
The \fBapache_conf\fP state had the following functions removed:
.INDENT 0.0
.IP \(bu 2
\fBdisable\fP: Please use \fBdisabled\fP instead.
.IP \(bu 2
\fBenable\fP: Please use \fBenabled\fP instead.
.UNINDENT
.sp
The \fBapache_module\fP state had the following functions removed:
.INDENT 0.0
.IP \(bu 2
\fBdisable\fP: Please use \fBdisabled\fP instead.
.IP \(bu 2
\fBenable\fP: Please use \fBenabled\fP instead.
.UNINDENT
.sp
The \fBapache_site\fP state had the following functions removed:
.INDENT 0.0
.IP \(bu 2
\fBdisable\fP: Please use \fBdisabled\fP instead.
.IP \(bu 2
\fBenable\fP: Please use \fBenabled\fP instead.
.UNINDENT
.sp
The \fBchocolatey\fP state had the following functions removed:
.INDENT 0.0
.IP \(bu 2
\fBinstall\fP: Please use \fBinstalled\fP instead.
.IP \(bu 2
\fBuninstall\fP: Please use \fBuninstalled\fP instead.
.UNINDENT
.sp
The \fBgit\fP state had the following changes:
.INDENT 0.0
.IP \(bu 2
The \fBconfig\fP function was removed. Please use \fBconfig_set\fP instead.
.IP \(bu 2
The \fBis_global\fP option was removed from the \fBconfig_set\fP function.
Please use \fBglobal\fP instead.
.IP \(bu 2
The \fBalways_fetch\fP option was removed from the \fBlatest\fP function, as
it no longer has any effect. Please see the \fI\%2015.8.0\fP
release notes for more information.
.IP \(bu 2
The \fBforce\fP option was removed from the \fBlatest\fP function. Please
use \fBforce_clone\fP instead.
.IP \(bu 2
The \fBremote_name\fP option was removed from the \fBlatest\fP function.
Please use \fBremote\fP instead.
.UNINDENT
.sp
The \fBglusterfs\fP state had the following function removed:
.INDENT 0.0
.IP \(bu 2
\fBcreated\fP: Please use \fBvolume_present\fP instead.
.UNINDENT
.sp
The \fBopenvswitch_port\fP state had the following change:
.INDENT 0.0
.IP \(bu 2
The \fBtype\fP option was removed from the \fBpresent\fP function. Please use \fBtunnel_type\fP instead.
.UNINDENT
.SS Build Notes
.SS Windows Installer Packages
.sp
Windows Installer packages have been patched with the following PR: \fI\%42347\fP
.SS Salt 2017.7.1 Release Notes
.sp
Version 2017.7.1 is a bugfix release for \fI\%2017.7.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB16\fP
.IP \(bu 2
Total Issue References: \fB12\fP
.IP \(bu 2
Total PR References: \fB31\fP
.IP \(bu 2
Contributors: \fB11\fP (\fI\%Ch3LL\fP, \fI\%TiteiKo\fP, \fI\%garethgreenaway\fP, \fI\%gtmanfred\fP, \fI\%llua\fP,
\fI\%rallytime\fP, \fI\%seedickcode\fP, \fI\%skizunov\fP, \fI\%terminalmage\fP, \fI\%twangboy\fP, \fI\%whiteinge\fP)
.UNINDENT
.SS Security Fix
.sp
\fBCVE\-2017\-12791\fP Maliciously crafted minion IDs can cause unwanted directory
traversals on the Salt\-master
.sp
Correct a flaw in minion id validation which could allow certain minions to
authenticate to a master despite not having the correct credentials. To exploit
the vulnerability, an attacker must create a salt\-minion with an ID containing
characters that will cause a directory traversal. Credit for discovering the
security flaw goes to: \fI\%Vernhk@qq.com\fP
.SS Changelog for v2017.7.0..v2017.7.1
.sp
\fIGenerated at: 2018\-05\-26 20:28:44 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#460\fP: (\fI\%Ch3LL\fP) decorator tests failing on python3 (refs: \fI\%#42548\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42595\fP: (\fI\%gtmanfred\fP) make sure to pass arg as well
@ \fI2017\-07\-28 16:21:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42548\fP: (\fI\%gtmanfred\fP) pass in empty kwarg for reactor (refs: \fI\%#42595\fP)
.IP \(bu 2
a50fe5433a Merge pull request \fI\%#42595\fP from gtmanfred/2017.7.1
.IP \(bu 2
8f73804b24 make sure to pass arg as well
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42597\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42590\fP to 2017.7.1
@ \fI2017\-07\-28 00:20:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42590\fP: (\fI\%TiteiKo\fP) Fix missing tornado import (refs: \fI\%#42597\fP)
.IP \(bu 2
3b583330de Merge pull request \fI\%#42597\fP from rallytime/bp\-42590
.IP \(bu 2
8818b06f22 Fix missing tornado import
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42404\fP: (\fI\%gabekahen\fP) [2017.7] file.managed with cmd_check \(dqNo such file or directory\(dq (refs: \fI\%#42411\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33708\fP: (\fI\%pepinje\fP) visudo check command leaves cache file in /tmp (refs: \fI\%#38063\fP, \fI\%#42411\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42598\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42411\fP to 2017.7.1
@ \fI2017\-07\-28 00:19:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42411\fP: (\fI\%seedickcode\fP) Fix file.managed check_cmd file not found \- Issue \fI\%#42404\fP (refs: \fI\%#42598\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38063\fP: (\fI\%llua\fP) tmp file clean up in file.manage \- fix for \fI\%#33708\fP (refs: \fI\%#42411\fP)
.IP \(bu 2
76f1e53e10 Merge pull request \fI\%#42598\fP from rallytime/bp\-42411
.IP \(bu 2
190cdb8693 Fix file.managed check_cmd file not found \- Issue \fI\%#42404\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42564\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42555\fP to 2017.7.1
@ \fI2017\-07\-26 17:32:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42555\fP: (\fI\%Ch3LL\fP) add changelog to 2017.7.1 release notes (refs: \fI\%#42564\fP)
.IP \(bu 2
5c7def9a43 Merge pull request \fI\%#42564\fP from rallytime/bp\-42555
.IP \(bu 2
7bcaa5a4cc small markup fix for title
.IP \(bu 2
d066b599ca add changelog to 2017.7.1 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#460\fP: (\fI\%Ch3LL\fP) decorator tests failing on python3 (refs: \fI\%#42548\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42548\fP: (\fI\%gtmanfred\fP) pass in empty kwarg for reactor (refs: \fI\%#42595\fP)
@ \fI2017\-07\-26 00:41:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
711b742c54 Merge pull request \fI\%#42548\fP from gtmanfred/2017.7.1
.IP \(bu 2
0257c1dc32 pass in empty kwarg for reactor
.IP \(bu 2
b948e980d2 update chunk, not kwarg in chunk
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42519\fP: (\fI\%xuhcc\fP) Error when installing package from file under Arch Linux (refs: \fI\%#42522\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42522\fP: (\fI\%gtmanfred\fP) pacman wildcard is only for repository installs
@ \fI2017\-07\-24 20:51:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
50c1635dcc Merge pull request \fI\%#42522\fP from gtmanfred/2017.7.1
.IP \(bu 2
7787fb9e1b pacman wildcard is only for repository installs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42508\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42474\fP to 2017.7.1
@ \fI2017\-07\-24 20:49:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42474\fP: (\fI\%whiteinge\fP) Cmd arg kwarg parsing test (refs: \fI\%#42508\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39646\fP: (\fI\%terminalmage\fP) Handle deprecation of passing string args to load_args_and_kwargs (refs: \fI\%#42474\fP)
.IP \(bu 2
05c07ac049 Merge pull request \fI\%#42508\fP from rallytime/bp\-42474
.IP \(bu 2
76fb074433 Add a test.arg variant that cleans the pub kwargs by default
.IP \(bu 2
624f63648e Lint fixes
.IP \(bu 2
d246a5fc61 Add back support for string kwargs
.IP \(bu 2
854e098aa0 Add LocalClient.cmd test for arg/kwarg parsing
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42427\fP: (\fI\%grichmond\-salt\fP) Issue Passing Variables created from load_json as Inline Pillar Between States (refs: \fI\%#42435\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42472\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42435\fP to 2017.7.1
@ \fI2017\-07\-24 15:11:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42435\fP: (\fI\%terminalmage\fP) Modify our custom YAML loader to treat unicode literals as unicode strings (refs: \fI\%#42472\fP)
.IP \(bu 2
95fe2558e4 Merge pull request \fI\%#42472\fP from rallytime/bp\-42435
.IP \(bu 2
5c47af5b98 Modify our custom YAML loader to treat unicode literals as unicode strings
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42374\fP: (\fI\%tyhunt99\fP) [2017.7.0] salt\-run mange.versions throws exception if minion is offline or unresponsive (refs: \fI\%#42436\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42473\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42436\fP to 2017.7.1
@ \fI2017\-07\-24 15:10:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42436\fP: (\fI\%garethgreenaway\fP) Fixes to versions function in manage runner (refs: \fI\%#42473\fP)
.IP \(bu 2
5b99d45f54 Merge pull request \fI\%#42473\fP from rallytime/bp\-42436
.IP \(bu 2
82ed919803 Updating the versions function inside the manage runner to account for when a minion is offline and we are unable to determine its version.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42381\fP: (\fI\%zebooka\fP) Git.detached broken in 2017.7.0 (refs: \fI\%#42399\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38878\fP: (\fI\%tomlaredo\fP) [Naming consistency] git.latest \(dqrev\(dq option VS git.detached \(dqref\(dq option (refs: \fI\%#38898\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42471\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42399\fP to 2017.7.1
@ \fI2017\-07\-24 15:09:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42399\fP: (\fI\%rallytime\fP) Update old \(dqref\(dq references to \(dqrev\(dq in git.detached state (refs: \fI\%#42471\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38898\fP: (\fI\%terminalmage\fP) git.detached: rename ref to rev for consistency (refs: \fI\%#42399\fP)
.IP \(bu 2
3d1a2d3f9f Merge pull request \fI\%#42471\fP from rallytime/bp\-42399
.IP \(bu 2
b9a4669e5a Update old \(dqref\(dq references to \(dqrev\(dq in git.detached state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42400\fP: (\fI\%Enquier\fP) Conflict in execution of passing pillar data to orch/reactor event executions 2017.7.0 (refs: \fI\%#42031\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42470\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42031\fP to 2017.7.1
@ \fI2017\-07\-24 15:09:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42031\fP: (\fI\%skizunov\fP) Fix: Reactor emits critical error (refs: \fI\%#42470\fP)
.IP \(bu 2
09766bccbc Merge pull request \fI\%#42470\fP from rallytime/bp\-42031
.IP \(bu 2
0a0c6287a4 Fix: Reactor emits critical error
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41949\fP: (\fI\%jrporcaro\fP) Event returner doesn\(aqt work with Windows Master (refs: \fI\%#42027\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42469\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42027\fP to 2017.7.1
@ \fI2017\-07\-21 22:41:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42027\fP: (\fI\%gtmanfred\fP) import salt.minion for EventReturn for Windows (refs: \fI\%#42469\fP)
.IP \(bu 2
d7b172a15b Merge pull request \fI\%#42469\fP from rallytime/bp\-42027
.IP \(bu 2
ed612b4ee7 import salt.minion for EventReturn for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42466\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42452\fP to 2017.7.1
@ \fI2017\-07\-21 19:41:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42452\fP: (\fI\%Ch3LL\fP) update windows urls to new py2/py3 naming scheme (refs: \fI\%#42466\fP)
.IP \(bu 2
8777b1a825 Merge pull request \fI\%#42466\fP from rallytime/bp\-42452
.IP \(bu 2
c10196f68c update windows urls to new py2/py3 naming scheme
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42439\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42409\fP to 2017.7.1
@ \fI2017\-07\-21 17:38:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42409\fP: (\fI\%twangboy\fP) Add Scripts to build Py3 on Mac (refs: \fI\%#42439\fP)
.IP \(bu 2
fceaaf41d0 Merge pull request \fI\%#42439\fP from rallytime/bp\-42409
.IP \(bu 2
8176964b41 Remove build and dist, sign pkgs
.IP \(bu 2
2c14d92a07 Fix hard coded pip path
.IP \(bu 2
82fdd7c2e1 Add support for Py3
.IP \(bu 2
2478447246 Update Python and other reqs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42403\fP: (\fI\%astronouth7303\fP) [2017.7] Pillar empty when state is applied from orchestrate (refs: \fI\%#42433\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42441\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42433\fP to 2017.7.1
@ \fI2017\-07\-21 17:37:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42433\fP: (\fI\%terminalmage\fP) Only force saltenv/pillarenv to be a string when not None (refs: \fI\%#42441\fP)
.IP \(bu 2
660400560b Merge pull request \fI\%#42441\fP from rallytime/bp\-42433
.IP \(bu 2
17f347123a Only force saltenv/pillarenv to be a string when not None
.UNINDENT
.UNINDENT
.SS Salt 2017.7.2 Release Notes
.sp
Version 2017.7.2 is a bugfix release for \fI\%2017.7.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB329\fP
.IP \(bu 2
Total Issue References: \fB73\fP
.IP \(bu 2
Total PR References: \fB236\fP
.IP \(bu 2
Contributors: \fB47\fP (\fI\%Ch3LL\fP, \fI\%CorvinM\fP, \fI\%DmitryKuzmenko\fP, \fI\%Giandom\fP, \fI\%Mapel88\fP, \fI\%Mareo\fP,
\fI\%SuperPommeDeTerre\fP, \fI\%The\-Loeki\fP, \fI\%abulford\fP, \fI\%amendlik\fP, \fI\%blarghmatey\fP, \fI\%brejoc\fP,
\fI\%cachedout\fP, \fI\%carsonoid\fP, \fI\%cro\fP, \fI\%damon\-atkins\fP, \fI\%darcoli\fP, \fI\%dmurphy18\fP, \fI\%frankiexyz\fP,
\fI\%garethgreenaway\fP, \fI\%gtmanfred\fP, \fI\%hibbert\fP, \fI\%isbm\fP, \fI\%ixs\fP, \fI\%jettero\fP, \fI\%jmarinaro\fP,
\fI\%justincbeard\fP, \fI\%kkoppel\fP, \fI\%llua\fP, \fI\%lomeroe\fP, \fI\%m03\fP, \fI\%mcalmer\fP, \fI\%mirceaulinic\fP,
\fI\%morganwillcock\fP, \fI\%nhavens\fP, \fI\%pabloh007\fP, \fI\%rallytime\fP, \fI\%seedickcode\fP, \fI\%shengis\fP,
\fI\%skizunov\fP, \fI\%terminalmage\fP, \fI\%the\-glu\fP, \fI\%thusoy\fP, \fI\%twangboy\fP, \fI\%vitaliyf\fP, \fI\%vutny\fP,
\fI\%whiteinge\fP)
.UNINDENT
.SS Security Fix
.sp
\fBCVE\-2017\-14695\fP Directory traversal vulnerability in minion id validation in
SaltStack. Allows remote minions with incorrect credentials to authenticate to
a master via a crafted minion ID. Credit for discovering the security flaw goes
to: Julian Brost (\fI\%julian@0x4a42.net\fP)
.sp
\fBCVE\-2017\-14696\fP Remote Denial of Service with a specially crafted
authentication request. Credit for discovering the security flaw goes to:
Julian Brost (\fI\%julian@0x4a42.net\fP)
.SS Changelog for v2017.7.1..v2017.7.2
.sp
\fIGenerated at: 2018\-05\-26 21:06:12 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#43868\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43847\fP to 2017.7.2
@ \fI2017\-10\-03 12:00:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43847\fP: (\fI\%cachedout\fP) Fix to module.run  (refs: \fI\%#43868\fP)
.IP \(bu 2
dd0b3388cf Merge pull request \fI\%#43868\fP from rallytime/bp\-43847
.IP \(bu 2
e21d8e9583 Use six.iterkeys() instead of dict.keys()
.IP \(bu 2
c297ae5557 Improve failures for module.run states
.IP \(bu 2
782e67c199 Lint
.IP \(bu 2
a6c2d78518 Fix typo found by @s0undt3ch
.IP \(bu 2
0cac15e502 Fix to module.run [WIP]
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43871\fP: (\fI\%rallytime\fP) Add updated release notes to 2017.7.2 branch
@ \fI2017\-10\-03 11:59:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
47af4ae38a Merge pull request \fI\%#43871\fP from rallytime/update\-release\-notes
.IP \(bu 2
2337904656 Add updated release notes to 2017.7.2 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43756\fP: (\fI\%gtmanfred\fP) split build and install for pkg osx
@ \fI2017\-09\-26 20:51:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
88414d5f73 Merge pull request \fI\%#43756\fP from gtmanfred/2017.7.2
.IP \(bu 2
f7df41fa94 split build and install for pkg osx
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43077\fP: (\fI\%Manoj2087\fP) Issue with  deleting key via wheel (refs: \fI\%#43330\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43585\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43330\fP to 2017.7.2
@ \fI2017\-09\-19 17:33:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43330\fP: (\fI\%terminalmage\fP) Fix reactor regression + unify reactor config schema (refs: \fI\%#43585\fP)
.IP \(bu 2
89f629233f Merge pull request \fI\%#43585\fP from rallytime/bp\-43330
.IP \(bu 2
c4f693bae8 Merge branch \(aq2017.7.2\(aq into bp\-43330
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43447\fP: (\fI\%UtahDave\fP) When using Syndic with Multi Master the top level master doesn\(aqt reliably get returns from lower minion. (refs: \fI\%#43526\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43586\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43526\fP to 2017.7.2
@ \fI2017\-09\-19 15:36:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43526\fP: (\fI\%DmitryKuzmenko\fP) Forward events to all masters syndic connected to (refs: \fI\%#43586\fP)
.IP \(bu 2
abb7fe4422 Merge pull request \fI\%#43586\fP from rallytime/bp\-43526
.IP \(bu 2
e076e9b634 Forward events to all masters syndic connected to.
.IP \(bu 2
7abd07fa07 Simplify client logic
.IP \(bu 2
b5f10696c2 Improve the reactor documentation
.IP \(bu 2
7a2f12b96a Include a better example for reactor in master conf file
.IP \(bu 2
531cac610e Rewrite the reactor unit tests
.IP \(bu 2
2a35ab7f39 Unify reactor configuration, fix caller reactors
.IP \(bu 2
4afb179bad Un\-deprecate passing kwargs outside of \(aqkwarg\(aq param
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43551\fP: (\fI\%twangboy\fP) Fix preinstall script on OSX for 2017.7.2
@ \fI2017\-09\-18 18:35:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
3d3b09302d Merge pull request \fI\%#43551\fP from twangboy/osx_fix_preinstall_2017.7.2
.IP \(bu 2
c3d9fb63f0 Merge branch \(aq2017.7.2\(aq into osx_fix_preinstall_2017.7.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43509\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43333\fP to 2017.7.2
@ \fI2017\-09\-15 21:21:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43333\fP: (\fI\%damon\-atkins\fP) Docs are wrong cache_dir (bool) and cache_file (str) cannot be passed as params + 1 bug (refs: \fI\%#43509\fP)
.IP \(bu 2
24691da888 Merge pull request \fI\%#43509\fP from rallytime/bp\-43333\-2017.7.2
.IP \(bu 2
b3dbafb035 Update doco
.IP \(bu 2
5cdcdbf428 Update win_pkg.py
.IP \(bu 2
c3e16661c3 Docs are wrong cache_dir (bool) and cache_file (str) cannot be passed on the cli (\fI\%#2\fP)
.IP \(bu 2
f33395f1ee Fix logic in \fI/etc/paths.d/salt\fP detection
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43440\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43421\fP to 2017.7.2
@ \fI2017\-09\-11 20:59:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43421\fP: (\fI\%gtmanfred\fP) Revert \(dqReduce fileclient.get_file latency by merging _file_find and … (refs: \fI\%#43440\fP)
.IP \(bu 2
8964cacbf8 Merge pull request \fI\%#43440\fP from rallytime/bp\-43421
.IP \(bu 2
ea6e661755 Revert \(dqReduce fileclient.get_file latency by merging _file_find and _file_hash\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43377\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43193\fP to 2017.7.2
@ \fI2017\-09\-11 15:32:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43193\fP: (\fI\%jettero\fP) Prevent spurious \(dqTemplate does not exist\(dq error (refs: \fI\%#43377\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39516\fP: (\fI\%jettero\fP) Prevent spurious \(dqTemplate does not exist\(dq error (refs: \fI\%#43193\fP)
.IP \(bu 2
7fda186b18 Merge pull request \fI\%#43377\fP from rallytime/bp\-43193
.IP \(bu 2
842b07fd25 Prevent spurious \(dqTemplate does not exist\(dq error
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42459\fP: (\fI\%iavael\fP) Broken ldap groups retrieval in salt.auth.ldap after upgrade to 2017.7 (refs: \fI\%#43283\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43315\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43283\fP to 2017.7.2
@ \fI2017\-09\-05 20:04:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43283\fP: (\fI\%DmitryKuzmenko\fP) Fix ldap token groups auth. (refs: \fI\%#43315\fP)
.IP \(bu 2
85dba1e898 Merge pull request \fI\%#43315\fP from rallytime/bp\-43283
.IP \(bu 2
f29f5b0cce Fix for tests: don\(aqt require \(aqgroups\(aq in the eauth token.
.IP \(bu 2
56938d5bf2 Fix ldap token groups auth.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43259\fP: (\fI\%mahesh21\fP) NameError: global name \(aq__opts__\(aq is not defined (refs: \fI\%#43266\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43266\fP: (\fI\%gtmanfred\fP) switch virtualbox cloud driver to use __utils__
@ \fI2017\-08\-30 18:36:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
26ff8088cb Merge pull request \fI\%#43266\fP from gtmanfred/virtualbox
.IP \(bu 2
382bf92de7 switch virtualbox cloud driver to use __utils__
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42936\fP: (\fI\%Mapel88\fP) bug in win_iis module & state \- container_setting (refs: \fI\%#43073\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43073\fP: (\fI\%Mapel88\fP) Fix bug \fI\%#42936\fP \- win_iis module container settings
@ \fI2017\-08\-30 18:34:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
ee209b144c Merge pull request \fI\%#43073\fP from Mapel88/patch\-2
.IP \(bu 2
b1a3d15b28 Remove trailing whitespace for linter
.IP \(bu 2
25c8190e48 Fix pylint errors
.IP \(bu 2
1eba8c4b8e Fix pylint errors
.IP \(bu 2
290d7b54af Fix plint errors
.IP \(bu 2
f4f32421ab Fix plint errors
.IP \(bu 2
ec20e9a19a Fix bug \fI\%#43110\fP \- win_iis module
.IP \(bu 2
009ef6686b Fix dictionary keys from string to int
.IP \(bu 2
dc793f9a05 Fix bug \fI\%#42936\fP \- win_iis state
.IP \(bu 2
13404a47b5 Fix bug \fI\%#42936\fP \- win_iis module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43254\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_inspect_collector\fP on Windows
@ \fI2017\-08\-30 15:46:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec1bedc646 Merge pull request \fI\%#43254\fP from twangboy/win_fix_test_inspect_collector
.IP \(bu 2
b401340e6c Fix \fIunit.modules.test_inspect_collector\fP on Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43241\fP: (\fI\%mirceaulinic\fP) Error whilst collecting napalm grains (refs: \fI\%#43255\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43255\fP: (\fI\%gtmanfred\fP) always return a dict object
@ \fI2017\-08\-30 14:47:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
1fc7307735 Merge pull request \fI\%#43255\fP from gtmanfred/2017.7
.IP \(bu 2
83b0bab34b opt_args needs to be a dict
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43229\fP: (\fI\%twangboy\fP) Bring changes from \fI\%#43228\fP to 2017.7
@ \fI2017\-08\-30 14:26:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43228\fP: (\fI\%twangboy\fP) Win fix pkg.install (refs: \fI\%#43229\fP)
.IP \(bu 2
fa904ee225 Merge pull request \fI\%#43229\fP from twangboy/win_fix_pkg.install\-2017.7
.IP \(bu 2
e007a1c26e Fix regex, add \fI\&.\fP
.IP \(bu 2
23ec47c74c Add _ to regex search
.IP \(bu 2
b1788b1e5f Bring changes from \fI\%#43228\fP to 2017.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43251\fP: (\fI\%twangboy\fP) Skips \fIunit.modules.test_groupadd\fP on Windows
@ \fI2017\-08\-30 13:56:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
25666f88f7 Merge pull request \fI\%#43251\fP from twangboy/win_skip_test_groupadd
.IP \(bu 2
5185071d5a Skips \fIunit.modules.test_groupadd\fP on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43256\fP: (\fI\%twangboy\fP) Skip mac tests for user and group
@ \fI2017\-08\-30 13:18:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
a8e09629b2 Merge pull request \fI\%#43256\fP from twangboy/win_skip_mac_tests
.IP \(bu 2
cec627a60b Skip mac tests for user and group
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42279\fP: (\fI\%dafyddj\fP) win_lgpo matches multiple policies due to startswith() (refs: \fI\%#43116\fP, \fI\%#43156\fP, \fI\%#43166\fP, \fI\%#43226\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43226\fP: (\fI\%lomeroe\fP) Fixes for issues in PR \fI\%#43166\fP
@ \fI2017\-08\-29 19:05:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43166\fP: (\fI\%lomeroe\fP) Backport \fI\%#43116\fP to 2017.7 (refs: \fI\%#43226\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43156\fP: (\fI\%lomeroe\fP) Backport \fI\%#43116\fP to 2017.7 (refs: \fI\%#43166\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43116\fP: (\fI\%lomeroe\fP) Fix 42279 in develop (refs: \fI\%#43166\fP, \fI\%#43156\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39773\fP: (\fI\%twangboy\fP) Make win_file use the win_dacl salt util (refs: \fI\%#43226\fP)
.IP \(bu 2
ac2189c870 Merge pull request \fI\%#43226\fP from lomeroe/fix_43166
.IP \(bu 2
0c424dc4a3 Merge branch \(aq2017.7\(aq into fix_43166
.IP \(bu 2
324cfd8d1e correcting bad format statement in search for policy to be disabled (fix for \fI\%#43166\fP) verify that file exists before attempting to remove (fix for commits from \fI\%#39773\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43227\fP: (\fI\%twangboy\fP) Fix \fIunit.fileserver.test_gitfs\fP for Windows
@ \fI2017\-08\-29 19:03:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
6199fb46dc Merge pull request \fI\%#43227\fP from twangboy/win_fix_unit_test_gitfs
.IP \(bu 2
c956d24283 Fix is_windows detection when USERNAME missing
.IP \(bu 2
869e8cc603 Fix \fIunit.fileserver.test_gitfs\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43217\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-08\-28 16:36:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
6adc03e4b4 Merge pull request \fI\%#43217\fP from rallytime/merge\-2017.7
.IP \(bu 2
3911df2f4b Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
5308c27f9f Merge pull request \fI\%#43202\fP from garethgreenaway/42642_2016_11_augeas_module_revert_fix
.INDENT 2.0
.IP \(bu 2
ef7e93eb3f Reverting this change due to it breaking other uses.
.UNINDENT
.IP \(bu 2
f16b7246e4 Merge pull request \fI\%#43103\fP from aogier/43101\-genesis\-bootstrap
.INDENT 2.0
.IP \(bu 2
db94f3bb1c better formatting
.IP \(bu 2
e5cc667762 tests: fix a leftover and simplify some parts
.IP \(bu 2
13e5997457 lint
.IP \(bu 2
216ced69e5 allow comma\-separated pkgs lists, quote args, test deb behaviour
.IP \(bu 2
d8612ae006 fix debootstrap and enhance packages selection/deletion via cmdline
.UNINDENT
.IP \(bu 2
4863771428 Merge pull request \fI\%#42663\fP from StreetHawkInc/fix_git_tag_check
.INDENT 2.0
.IP \(bu 2
2b5af5b59d Remove refs/tags prefix from remote tags
.IP \(bu 2
3f2e96e561 Convert set to list for serializer
.IP \(bu 2
2728e5d977 Only include new tags in changes
.IP \(bu 2
4b1df2f223 Exclude annotated tags from checks
.IP \(bu 2
389c037285 Check remote tags before deciding to do a fetch \fI\%#42329\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43201\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-08\-25 22:56:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
a563a9422a Merge pull request \fI\%#43201\fP from rallytime/merge\-2017.7
.IP \(bu 2
d40eba6b37 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
4193e7f0a2 Merge pull request \fI\%#43199\fP from corywright/disk\-format\-alias
.INDENT 2.0
.IP \(bu 2
f00d3a9ddc Add \fIdisk.format\fP alias for \fIdisk.format_\fP
.UNINDENT
.IP \(bu 2
5471f9fe0c Merge pull request \fI\%#43196\fP from gtmanfred/2016.11
.INDENT 2.0
.IP \(bu 2
ccd2241777 Pin request install to version
.UNINDENT
.IP \(bu 2
ace2715c60 Merge pull request \fI\%#43178\fP from terminalmage/issue43143
.INDENT 2.0
.IP \(bu 2
2640833400 git.detached: Fix traceback when rev is a SHA and is not present locally
.UNINDENT
.IP \(bu 2
12e9507b9e Merge pull request \fI\%#43179\fP from terminalmage/old\-deprecation
.INDENT 2.0
.IP \(bu 2
3adf8ad04b Fix missed deprecation
.UNINDENT
.IP \(bu 2
b595440d90 Merge pull request \fI\%#43171\fP from terminalmage/salt\-utils\-warning
.INDENT 2.0
.IP \(bu 2
7b5943a31a Add warning about adding new functions to salt/utils/__init__.py
.UNINDENT
.IP \(bu 2
4f273cac4f Merge pull request \fI\%#43173\fP from Ch3LL/add_branch_docs
.INDENT 2.0
.IP \(bu 2
1b24244bd3 Add New Release Branch Strategy to Contribution Docs
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42997\fP: (\fI\%twangboy\fP) Fix \fIunit.test_test_module_names\fP for Windows
@ \fI2017\-08\-25 21:19:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce04ab4286 Merge pull request \fI\%#42997\fP from twangboy/win_fix_test_module_names
.IP \(bu 2
2722e9521d Use os.path.join to create paths
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26995\fP: (\fI\%jbouse\fP) Issue with artifactory.downloaded and snapshot artifacts (refs: \fI\%#43006\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43006\fP: (\fI\%SuperPommeDeTerre\fP) Try to fix \fI\%#26995\fP
@ \fI2017\-08\-25 21:16:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
c0279e491e Merge pull request \fI\%#43006\fP from SuperPommeDeTerre/SuperPommeDeTerre\-patch\-\fI\%#26995\fP
.IP \(bu 2
30dd6f5d12 Merge remote\-tracking branch \(aqupstream/2017.7\(aq into SuperPommeDeTerre\-patch\-\fI\%#26995\fP
.IP \(bu 2
f42ae9b8cd Merge branch \(aqSuperPommeDeTerre\-patch\-#26995\(aq of \fI\%https://github.com/SuperPommeDeTerre/salt\fP into SuperPommeDeTerre\-patch\-#26995
.INDENT 2.0
.IP \(bu 2
50ee3d5682 Merge remote\-tracking branch \(aqremotes/origin/2017.7\(aq into SuperPommeDeTerre\-patch\-\fI\%#26995\fP
.IP \(bu 2
0b666e100b Fix typo.
.IP \(bu 2
1b8729b3e7 Fix for \fI\%#26995\fP
.UNINDENT
.IP \(bu 2
e314102978 Fix typo.
.IP \(bu 2
db11e1985b Fix for \fI\%#26995\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43162\fP: (\fI\%MorphBonehunter\fP) docker_container.running interference with restart_policy  (refs: \fI\%#43184\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43184\fP: (\fI\%terminalmage\fP) docker.compare_container: Perform boolean comparison when one side\(aqs value is null/None
@ \fI2017\-08\-25 18:42:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
b6c5314fe9 Merge pull request \fI\%#43184\fP from terminalmage/issue43162
.IP \(bu 2
081f42ad71 docker.compare_container: Perform boolean comparison when one side\(aqs value is null/None
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43165\fP: (\fI\%mirceaulinic\fP) Improve napalm state output in debug mode
@ \fI2017\-08\-24 23:05:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
688125bb4f Merge pull request \fI\%#43165\fP from cloudflare/fix\-napalm\-ret
.IP \(bu 2
c10717dc89 Lint and fix
.IP \(bu 2
1cd33cbaa9 Simplify the loaded_ret logic
.IP \(bu 2
0bbea6b04c Document the new compliance_report arg
.IP \(bu 2
3a906109bd Include compliance reports
.IP \(bu 2
3634055e34 Improve napalm state output in debug mode
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43155\fP: (\fI\%terminalmage\fP) Resolve image ID during container comparison
@ \fI2017\-08\-24 22:09:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
a6a327b1e5 Merge pull request \fI\%#43155\fP from terminalmage/issue43001
.IP \(bu 2
0186835ebf Fix docstring in test
.IP \(bu 2
a0bb654e46 Fixing lint issues
.IP \(bu 2
d5b2a0be68 Resolve image ID during container comparison
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43170\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-08\-24 19:22:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
c071fd44c8 Merge pull request \fI\%#43170\fP from rallytime/merge\-2017.7
.IP \(bu 2
3daad5a3a2 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
669b376abf Merge pull request \fI\%#43151\fP from ushmodin/2016.11
.INDENT 2.0
.IP \(bu 2
c5841e2ade state.sls hangs on file.recurse with clean: True on windows
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43040\fP: (\fI\%darcoli\fP) gitFS ext_pillar with branch name __env__ results in empty pillars (refs: \fI\%#43041\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43168\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43041\fP to 2017.7
@ \fI2017\-08\-24 19:07:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43041\fP: (\fI\%darcoli\fP) Do not try to match pillarenv with __env__ (refs: \fI\%#43168\fP)
.IP \(bu 2
034c325a09 Merge pull request \fI\%#43168\fP from rallytime/bp\-43041
.IP \(bu 2
d010b74b87 Do not try to match pillarenv with __env__
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43172\fP: (\fI\%rallytime\fP) Move new utils/__init__.py funcs to utils.files.py
@ \fI2017\-08\-24 19:05:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43056\fP: (\fI\%damon\-atkins\fP) safe_filename_leaf(file_basename) and safe_filepath(file_path_name) (refs: \fI\%#43172\fP)
.IP \(bu 2
d48938e6b4 Merge pull request \fI\%#43172\fP from rallytime/move\-utils\-funcs
.IP \(bu 2
5385c7901e Move new utils/__init__.py funcs to utils.files.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43043\fP: (\fI\%pabloh007\fP) docker.save and docker.load problem (refs: \fI\%#43061\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43061\fP: (\fI\%pabloh007\fP) Have docker.save use the image name when valid if not use image id, i…
@ \fI2017\-08\-24 16:32:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
e60f586442 Merge pull request \fI\%#43061\fP from pabloh007/fix\-save\-image\-name\-id
.IP \(bu 2
0ffc57d1df Have docker.save use the image name when valid if not use image id, issue when loading and image is savid with id issue \fI\%#43043\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42279\fP: (\fI\%dafyddj\fP) win_lgpo matches multiple policies due to startswith() (refs: \fI\%#43116\fP, \fI\%#43156\fP, \fI\%#43166\fP, \fI\%#43226\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43166\fP: (\fI\%lomeroe\fP) Backport \fI\%#43116\fP to 2017.7 (refs: \fI\%#43226\fP)
@ \fI2017\-08\-24 15:01:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43156\fP: (\fI\%lomeroe\fP) Backport \fI\%#43116\fP to 2017.7 (refs: \fI\%#43166\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43116\fP: (\fI\%lomeroe\fP) Fix 42279 in develop (refs: \fI\%#43166\fP, \fI\%#43156\fP)
.IP \(bu 2
9da57543f8 Merge pull request \fI\%#43166\fP from lomeroe/bp\-43116\-2017.7
.IP \(bu 2
af181b3257 correct fopen calls from salt.utils for 2017.7
.IP \(bu 2
f74480f11e lint fix
.IP \(bu 2
ecd446fd55 track xml namespace to ensure policies w/duplicate IDs or Names do not conflict
.IP \(bu 2
9f3047c420 add additional checks for ADM policies that have the same ADMX policy ID (\fI\%#42279\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43056\fP: (\fI\%damon\-atkins\fP) safe_filename_leaf(file_basename) and safe_filepath(file_path_name) (refs: \fI\%#43172\fP)
@ \fI2017\-08\-23 17:35:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
44b3caead1 Merge pull request \fI\%#43056\fP from damon\-atkins/2017.7
.IP \(bu 2
08ded1546e more lint
.IP \(bu 2
6e9c0957fb fix typo
.IP \(bu 2
ee41171c9f lint fixes
.IP \(bu 2
8c864f02c7 fix missing imports
.IP \(bu 2
964cebd954 safe_filename_leaf(file_basename) and safe_filepath(file_path_name)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43146\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-08\-23 16:56:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
6ca9131a23 Merge pull request \fI\%#43146\fP from rallytime/merge\-2017.7
.IP \(bu 2
bcbe180fbc Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
ae9d2b7985 Merge pull request \fI\%#42986\fP from renner/systemd\-notify
.INDENT 2.0
.IP \(bu 2
79c53f3f81 Fallback to systemd_notify_call() in case of socket.error
.IP \(bu 2
f1765472dd Notify systemd synchronously (via NOTIFY_SOCKET)
.UNINDENT
.IP \(bu 2
b420fbe618 Merge pull request \fI\%#43037\fP from mcarlton00/fix\-bhyve\-grains
.INDENT 2.0
.IP \(bu 2
73315f0cf0 Issue \fI\%#43036\fP Bhyve virtual grain in Linux VMs
.UNINDENT
.IP \(bu 2
0a86f2d884 Merge pull request \fI\%#43100\fP from vutny/doc\-add\-missing\-utils\-ext
.INDENT 2.0
.IP \(bu 2
af743ff6c3 [DOCS] Add missing \fIutils\fP sub\-dir listed for \fIextension_modules\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43123\fP: (\fI\%twangboy\fP) Fix \fIunit.utils.test_which\fP for Windows
@ \fI2017\-08\-23 16:01:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
03f652159f Merge pull request \fI\%#43123\fP from twangboy/win_fix_test_which
.IP \(bu 2
ed97cff5f6 Fix \fIunit.utils.test_which\fP for Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42505\fP: (\fI\%ikogan\fP) selinux.fcontext_policy_present exception looking for selinux.filetype_id_to_string (refs: \fI\%#43068\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43142\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43068\fP to 2017.7
@ \fI2017\-08\-23 15:56:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43068\fP: (\fI\%ixs\fP) Mark selinux._filetype_id_to_string as public function (refs: \fI\%#43142\fP)
.IP \(bu 2
5a4fc07863 Merge pull request \fI\%#43142\fP from rallytime/bp\-43068
.IP \(bu 2
efc1c8c506 Mark selinux._filetype_id_to_string as public function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43038\fP: (\fI\%twangboy\fP) Fix \fIunit.utils.test_url\fP for Windows
@ \fI2017\-08\-23 13:35:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
0467a0e3bf Merge pull request \fI\%#43038\fP from twangboy/win_unit_utils_test_url
.IP \(bu 2
7f5ee55f57 Fix \fIunit.utils.test_url\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43097\fP: (\fI\%twangboy\fP) Fix \fIgroup.present\fP for Windows
@ \fI2017\-08\-23 13:19:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
e9ccaa61d2 Merge pull request \fI\%#43097\fP from twangboy/win_fix_group
.IP \(bu 2
43b0360763 Fix lint
.IP \(bu 2
9ffe315d7d Add kwargs
.IP \(bu 2
4f4e34c79f Fix group state for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43115\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42067\fP to 2017.7
@ \fI2017\-08\-22 20:09:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42067\fP: (\fI\%vitaliyf\fP) Removed several uses of name.split(\(aq.\(aq)[0] in SoftLayer driver. (refs: \fI\%#43115\fP)
.IP \(bu 2
8140855627 Merge pull request \fI\%#43115\fP from rallytime/bp\-42067
.IP \(bu 2
8a6ad0a9cf Fixed typo.
.IP \(bu 2
9a5ae2bba1 Removed several uses of name.split(\(aq.\(aq)[0] in SoftLayer driver.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42962\fP: (\fI\%twangboy\fP) Fix \fIunit.test_doc test\fP for Windows
@ \fI2017\-08\-22 18:06:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
1e1a81036c Merge pull request \fI\%#42962\fP from twangboy/win_unit_test_doc
.IP \(bu 2
201ceae4c4 Fix lint, remove debug statement
.IP \(bu 2
37029c1a16 Fix unit.test_doc test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42995\fP: (\fI\%twangboy\fP) Fix malformed requisite for Windows
@ \fI2017\-08\-22 16:50:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
d347d1cf8f Merge pull request \fI\%#42995\fP from twangboy/win_fix_invalid_requisite
.IP \(bu 2
93390de88b Fix malformed requisite for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43108\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42988\fP to 2017.7
@ \fI2017\-08\-22 16:49:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42988\fP: (\fI\%thusoy\fP) Fix broken negation in iptables (refs: \fI\%#43108\fP)
.IP \(bu 2
1c7992a832 Merge pull request \fI\%#43108\fP from rallytime/bp\-42988
.IP \(bu 2
1a987cb948 Fix broken negation in iptables
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43107\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-08\-22 16:11:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
c6993f4a84 Merge pull request \fI\%#43107\fP from rallytime/merge\-2017.7
.IP \(bu 2
328dd6aa23 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
e2bf2f448e Merge pull request \fI\%#42985\fP from DSRCorporation/bugs/15171_recursion_limit
.INDENT 2.0
.IP \(bu 2
651b1bab09 Properly handle \fIprereq\fP having lost requisites.
.UNINDENT
.IP \(bu 2
e51333306c Merge pull request \fI\%#43092\fP from mitodl/2016.11
.INDENT 2.0
.IP \(bu 2
d4b113acdf Fixed issue with silently passing all tests in Testinfra module
.UNINDENT
.IP \(bu 2
77a443ce8e Merge pull request \fI\%#43060\fP from twangboy/osx_update_pkg_scripts
.INDENT 2.0
.IP \(bu 2
ef8a14cdf9 Remove /opt/salt instead of /opt/salt/bin
.IP \(bu 2
2dd62aa1da Add more information to the description
.IP \(bu 2
f44f5b70dc Only stop services if they are running
.IP \(bu 2
3b62bf953c Remove salt from the path
.IP \(bu 2
ebdca3a0f5 Update pkg\-scripts
.UNINDENT
.IP \(bu 2
1b1b6da803 Merge pull request \fI\%#43064\fP from terminalmage/issue42869
.INDENT 2.0
.IP \(bu 2
093c0c2f77 Fix race condition in git.latest
.UNINDENT
.IP \(bu 2
96e8e836d1 Merge pull request \fI\%#43054\fP from lorengordon/fix/yumpkg/config\-parser
.INDENT 2.0
.IP \(bu 2
3b2cb81a72 fix typo in salt.modules.yumpkg
.IP \(bu 2
38add0e4a2 break if leading comments are all fetched
.IP \(bu 2
d7f65dc7a7 fix configparser import & log if error was raised
.IP \(bu 2
ca1b1bb633 use configparser to parse yum repo file
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42996\fP: (\fI\%twangboy\fP) Fix \fIunit.test_stateconf\fP for Windows
@ \fI2017\-08\-21 22:43:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
f9b4976c02 Merge pull request \fI\%#42996\fP from twangboy/win_fix_test_stateconf
.IP \(bu 2
92dc3c0ece Use os.sep for path
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43024\fP: (\fI\%twangboy\fP) Fix \fIunit.utils.test_find\fP for Windows
@ \fI2017\-08\-21 22:38:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
19fc644c9b Merge pull request \fI\%#43024\fP from twangboy/win_unit_utils_test_find
.IP \(bu 2
fbe54c9a33 Remove unused import six (lint)
.IP \(bu 2
b04d1a2f18 Fix \fIunit.utils.test_find\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43088\fP: (\fI\%gtmanfred\fP) allow docker util to be reloaded with reload_modules
@ \fI2017\-08\-21 22:14:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a531169fc Merge pull request \fI\%#43088\fP from gtmanfred/2017.7
.IP \(bu 2
373a9a0be4 allow docker util to be reloaded with reload_modules
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43091\fP: (\fI\%blarghmatey\fP) Fixed issue with silently passing all tests in Testinfra module
@ \fI2017\-08\-21 22:06:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
83e528f0b3 Merge pull request \fI\%#43091\fP from mitodl/2017.7
.IP \(bu 2
b502560e61 Fixed issue with silently passing all tests in Testinfra module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41994\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_cmdmod\fP on Windows
@ \fI2017\-08\-21 21:53:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
5482524270 Merge pull request \fI\%#41994\fP from twangboy/win_unit_test_cmdmod
.IP \(bu 2
a5f7288ad9 Skip test that uses pwd, not available on Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42873\fP: (\fI\%TheVakman\fP) osquery Data Empty Upon Return / Reporting Not Installed (refs: \fI\%#42933\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42933\fP: (\fI\%garethgreenaway\fP) Fixes to osquery module
@ \fI2017\-08\-21 20:48:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
b33c4abc15 Merge pull request \fI\%#42933\fP from garethgreenaway/42873_2017_7_osquery_fix
.IP \(bu 2
8915e62bd9 Removing an import that is not needed.
.IP \(bu 2
74bc377eb4 Updating the other function that uses cmd.run_all
.IP \(bu 2
e6a4619ec1 Better approach without using python_shell=True.
.IP \(bu 2
5ac41f496d When running osquery commands through cmd.run we should pass python_shell=True to ensure everything is formatted right.  \fI\%#42873\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43093\fP: (\fI\%gtmanfred\fP) Fix ec2 list_nodes_full to work on 2017.7
@ \fI2017\-08\-21 20:21:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
53c2115769 Merge pull request \fI\%#43093\fP from gtmanfred/ec2
.IP \(bu 2
c7cffb5a04 This block isn\(aqt necessary
.IP \(bu 2
b7283bcc6f _vm_provider_driver isn\(aqt needed anymore
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43085\fP: (\fI\%brejoc\fP) Patch for Kubernetes module missing from 2017.7 and 2017.7.1 (refs: \fI\%#43087\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43087\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42174\fP to 2017.7
@ \fI2017\-08\-21 18:40:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42174\fP: (\fI\%mcalmer\fP) kubernetes: provide client certificate authentication (refs: \fI\%#43087\fP)
.IP \(bu 2
32f9ade4db Merge pull request \fI\%#43087\fP from rallytime/bp\-42174
.IP \(bu 2
cf6563645b add support for certificate authentication to kubernetes module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43029\fP: (\fI\%terminalmage\fP) Normalize the salt caching API
@ \fI2017\-08\-21 16:54:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
882fcd846f Merge pull request \fI\%#43029\fP from terminalmage/fix\-func\-alias
.IP \(bu 2
f8f74a310c Update localfs cache tests to reflect changes to func naming
.IP \(bu 2
c4ae79b229 Rename other refs to cache.ls with cache.list
.IP \(bu 2
ee59d127e8 Normalize the salt caching API
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42843\fP: (\fI\%brejoc\fP) Kubernetes module won\(aqt work with Kubernetes Python client > 1.0.2 (refs: \fI\%#42845\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43039\fP: (\fI\%gtmanfred\fP) catch ImportError for kubernetes.client import
@ \fI2017\-08\-21 14:32:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42845\fP: (\fI\%brejoc\fP) API changes for Kubernetes version 2.0.0 (refs: \fI\%#43039\fP)
.IP \(bu 2
dbee735f6e Merge pull request \fI\%#43039\fP from gtmanfred/kube
.IP \(bu 2
7e269cb368 catch ImportError for kubernetes.client import
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43058\fP: (\fI\%rallytime\fP) Update release version number for jenkins.run function
@ \fI2017\-08\-21 14:13:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
c56a8499b3 Merge pull request \fI\%#43058\fP from rallytime/fix\-release\-num
.IP \(bu 2
d7eef70df0 Update release version number for jenkins.run function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43051\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-08\-18 17:05:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
7b0c94768a Merge pull request \fI\%#43051\fP from rallytime/merge\-2017.7
.IP \(bu 2
153a463b86 Lint: Add missing blank line
.IP \(bu 2
84829a6f8c Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
43aa46f512 Merge pull request \fI\%#43048\fP from rallytime/bp\-43031
.INDENT 2.0
.IP \(bu 2
35e45049e2 use a ruby gem that doesn\(aqt have dependencies
.UNINDENT
.IP \(bu 2
ad89ff3104 Merge pull request \fI\%#43023\fP from terminalmage/fix\-jenkins\-xml\-caching
.INDENT 2.0
.IP \(bu 2
33fd8ff939 Update jenkins.py
.IP \(bu 2
fc306fc8c3 Add missing colon in \fIif\fP statement
.IP \(bu 2
822eabcc81 Catch exceptions raised when making changes to jenkins
.IP \(bu 2
91b583b493 Improve and correct exception raising
.IP \(bu 2
f096917a0e Raise an exception if we fail to cache the config xml
.UNINDENT
.IP \(bu 2
2957467ed7 Merge pull request \fI\%#43026\fP from rallytime/bp\-43020
.INDENT 2.0
.IP \(bu 2
0eb15a1f67 test with gem that appears to be abandoned
.UNINDENT
.IP \(bu 2
4150b094fe Merge pull request \fI\%#43033\fP from rallytime/bp\-42760
.INDENT 2.0
.IP \(bu 2
3e3f7f5d8e Catch TypeError thrown by m2crypto when parsing missing subjects in certificate files.
.UNINDENT
.IP \(bu 2
b124d3667e Merge pull request \fI\%#43032\fP from rallytime/bp\-42547
.INDENT 2.0
.IP \(bu 2
ea4d7f4176 Updated testinfra modules to work with more recent versions
.UNINDENT
.IP \(bu 2
a88386ad44 Merge pull request \fI\%#43027\fP from pabloh007/fix\-docker\-save\-push\-2016\-11
.INDENT 2.0
.IP \(bu 2
d0fd949f85 Fixes ignore push flag for docker.push module issue \fI\%#42992\fP
.UNINDENT
.IP \(bu 2
51d16840bb Merge pull request \fI\%#42890\fP from DSRCorporation/bugs/42627_salt\-cp
.INDENT 2.0
.IP \(bu 2
cfddbf1c75 Apply code review: update the doc
.IP \(bu 2
afedd3b654 Typos and version fixes in the doc.
.IP \(bu 2
9fedf6012e Fixed \(aqtest_valid_docs\(aq test.
.IP \(bu 2
999388680c Make chunked mode in salt\-cp optional (disabled by default).
.UNINDENT
.IP \(bu 2
b3c253cdfa Merge pull request \fI\%#43009\fP from rallytime/merge\-2016.11
.INDENT 2.0
.IP \(bu 2
566ba4fe76 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
13b8637d53 Merge pull request \fI\%#42942\fP from Ch3LL/2016.3.6_follow_up
.INDENT 2.0
.IP \(bu 2
f281e1795f move additional minion config options to 2016.3.8 release notes
.IP \(bu 2
168604ba6b remove merge conflict
.IP \(bu 2
8a07d95212 update release notes with cve number
.IP \(bu 2
149633fdca Add release notes for 2016.3.7 release
.IP \(bu 2
7a4cddcd95 Add clean_id function to salt.utils.verify.py
.UNINDENT
.IP \(bu 2
bbb1b29ccb Merge pull request \fI\%#42954\fP from Ch3LL/latest_2016.3
.INDENT 2.0
.IP \(bu 2
b551e66744 [2016.3] Bump latest and previous versions
.UNINDENT
.IP \(bu 2
5d5edc54b7 Merge pull request \fI\%#42949\fP from Ch3LL/2016.3.7_docs
.INDENT 2.0
.IP \(bu 2
d75d3741f8 Add Security Notice to 2016.3.7 Release Notes
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
37c63e7cf2 Merge pull request \fI\%#43021\fP from terminalmage/fix\-network\-test
.INDENT 2.0
.IP \(bu 2
4089b7b1bc Use socket.AF_INET6 to get the correct value instead of doing an OS check
.UNINDENT
.IP \(bu 2
8f6423247c Merge pull request \fI\%#43019\fP from rallytime/bootstrap_2017.08.17
.INDENT 2.0
.IP \(bu 2
2f762b3a17 Update bootstrap script to latest stable: v2017.08.17
.UNINDENT
.IP \(bu 2
ff1caeee68 Merge pull request \fI\%#43014\fP from Ch3LL/fix_network_mac
.INDENT 2.0
.IP \(bu 2
b8eee4401e Change AF_INET6 family for mac in test_host_to_ips
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43035\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.1 to 2017.7
@ \fI2017\-08\-18 12:58:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42948\fP: (\fI\%Ch3LL\fP) [2017.7.1] Add clean_id function to salt.utils.verify.py (refs: \fI\%#43035\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42945\fP: (\fI\%Ch3LL\fP) [2017.7] Add clean_id function to salt.utils.verify.py (refs: \fI\%#43035\fP)
.IP \(bu 2
d15b0ca937 Merge pull request \fI\%#43035\fP from rallytime/merge\-2017.7
.IP \(bu 2
756128a896 Merge branch \(aq2017.7.1\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
ab1b099730 Merge pull request \fI\%#42948\fP from Ch3LL/2017.7.0_follow_up
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42989\fP: (\fI\%blbradley\fP) GitFS GitPython performance regression in 2017.7.1 (refs: \fI\%#43002\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43034\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43002\fP to 2017.7
@ \fI2017\-08\-17 23:18:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43002\fP: (\fI\%the\-glu\fP) Try to fix \fI\%#42989\fP (refs: \fI\%#43034\fP)
.IP \(bu 2
bcbb973a71 Merge pull request \fI\%#43034\fP from rallytime/bp\-43002
.IP \(bu 2
350c0767dc Try to fix \fI\%#42989\fP by doing sslVerify and refspecs for origin remote only if there is no remotes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42375\fP: (\fI\%dragonpaw\fP) salt.modules.*.__virtualname__ doens\(aqt work as documented. (refs: \fI\%#42523\fP, \fI\%#42958\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42958\fP: (\fI\%gtmanfred\fP) runit module should also be loaded as runit
@ \fI2017\-08\-17 22:30:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
9182f55bbb Merge pull request \fI\%#42958\fP from gtmanfred/2017.7
.IP \(bu 2
fd6874668b runit module should also be loaded as runit
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43031\fP: (\fI\%gtmanfred\fP) use a ruby gem that doesn\(aqt have dependencies (refs: \fI\%#43048\fP)
@ \fI2017\-08\-17 22:26:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
5985cc4e8e Merge pull request \fI\%#43031\fP from gtmanfred/test_gem
.IP \(bu 2
ba80a7d4b5 use a ruby gem that doesn\(aqt have dependencies
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43030\fP: (\fI\%rallytime\fP) Small cleanup to dockermod.save
@ \fI2017\-08\-17 22:26:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
246176b1a6 Merge pull request \fI\%#43030\fP from rallytime/dockermod\-minor\-change
.IP \(bu 2
d6a5e85632 Small cleanup to dockermod.save
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42992\fP: (\fI\%pabloh007\fP) docker.save  flag push does is ignored (refs: \fI\%#42993\fP, \fI\%#43027\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42993\fP: (\fI\%pabloh007\fP) Fixes ignored push flag for docker.push module issue \fI\%#42992\fP
@ \fI2017\-08\-17 18:50:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
160001120b Merge pull request \fI\%#42993\fP from pabloh007/fix\-docker\-save\-push
.IP \(bu 2
fe7554cfeb Fixes ignored push flag for docker.push module issue \fI\%#42992\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42941\fP: (\fI\%danlsgiga\fP) pkg.installed fails on installing from HTTPS rpm source (refs: \fI\%#42967\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42967\fP: (\fI\%terminalmage\fP) Fix bug in on_header callback when no Content\-Type is found in headers
@ \fI2017\-08\-17 18:48:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
9009a971b1 Merge pull request \fI\%#42967\fP from terminalmage/issue42941
.IP \(bu 2
b838460816 Fix bug in on_header callback when no Content\-Type is found in headers
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43008\fP: (\fI\%evelineraine\fP) states.service.running always succeeds when watched state has changes (refs: \fI\%#43016\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43016\fP: (\fI\%gtmanfred\fP) service should return false on exception
@ \fI2017\-08\-17 18:08:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
58f070d7a7 Merge pull request \fI\%#43016\fP from gtmanfred/service
.IP \(bu 2
21c264fe55 service should return false on exception
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43020\fP: (\fI\%gtmanfred\fP) test with gem that appears to be abandoned (refs: \fI\%#43026\fP)
@ \fI2017\-08\-17 16:40:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
973d288eca Merge pull request \fI\%#43020\fP from gtmanfred/test_gem
.IP \(bu 2
0a1f40a664 test with gem that appears to be abandoned
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42999\fP: (\fI\%garethgreenaway\fP) Fixes to slack engine
@ \fI2017\-08\-17 15:46:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
9cd0607fd4 Merge pull request \fI\%#42999\fP from garethgreenaway/slack_engine_allow_editing_messages
.IP \(bu 2
0ece2a8f0c Fixing a bug that prevented editing Slack messages and having the commands resent to the Slack engine.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43010\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-08\-17 15:10:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
31627a9163 Merge pull request \fI\%#43010\fP from rallytime/merge\-2017.7
.IP \(bu 2
8a0f948e4a Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
1ee9499d28 Merge pull request \fI\%#42968\fP from vutny/doc\-salt\-cloud\-ref
.INDENT 2.0
.IP \(bu 2
44ed53b1df [DOCS] Fix link to Salt Cloud Feature Matrix
.UNINDENT
.IP \(bu 2
923f9741fe Merge pull request \fI\%#42291\fP from vutny/fix\-38839
.INDENT 2.0
.IP \(bu 2
5f8f98a01f Fix \fI\%#38839\fP: remove \fIstate\fP from Reactor runner kwags
.UNINDENT
.IP \(bu 2
c20bc7d515 Merge pull request \fI\%#42940\fP from gtmanfred/2016.11
.INDENT 2.0
.IP \(bu 2
253e216a8d fix IP address spelling
.IP \(bu 2
bd63074e7a create new ip address before checking list of allocated ips
.UNINDENT
.IP \(bu 2
d6496eca72 Merge pull request \fI\%#42959\fP from rallytime/bp\-42883
.INDENT 2.0
.IP \(bu 2
c6b9ca4b9e Lint fix: add missing space
.IP \(bu 2
5597b1a30e Skip 2 failing tests in Python 3 due to upstream bugs
.IP \(bu 2
a0b19bdc27 Update account id value in boto_secgroup module unit test
.IP \(bu 2
60b406e088 @mock_elb needs to be changed to @mock_elb_deprecated as well
.IP \(bu 2
6ae1111295 Replace @mock_ec2 calls with @mock_ec2_deprecated calls
.UNINDENT
.IP \(bu 2
6366e05d0d Merge pull request \fI\%#42944\fP from Ch3LL/2016.11.6_follow_up
.INDENT 2.0
.IP \(bu 2
7e0a20afca Add release notes for 2016.11.7 release
.IP \(bu 2
63823f8c3e Add clean_id function to salt.utils.verify.py
.UNINDENT
.IP \(bu 2
49d339c976 Merge pull request \fI\%#42952\fP from Ch3LL/latest_2016.11
.INDENT 2.0
.IP \(bu 2
74e7055d54 [2016.11] Bump latest and previous versions
.UNINDENT
.IP \(bu 2
b0d2e05a79 Merge pull request \fI\%#42950\fP from Ch3LL/2016.11.7_docs
.INDENT 2.0
.IP \(bu 2
a6f902db40 Add Security Notice to 2016.11.77 Release Notes
.UNINDENT
.IP \(bu 2
c0ff69f88c Merge pull request \fI\%#42836\fP from lyft/backport\-utils.versions\-to\-2016.11
.INDENT 2.0
.IP \(bu 2
86ce7004a2 Backport salt.utils.versions from develop to 2016.11
.UNINDENT
.IP \(bu 2
64a79dd5ac Merge pull request \fI\%#42919\fP from rallytime/bp\-42871
.INDENT 2.0
.IP \(bu 2
4e46c968e6 Update joyent.rst
.UNINDENT
.IP \(bu 2
bea8ec1098 Merge pull request \fI\%#42918\fP from rallytime/bp\-42848
.INDENT 2.0
.IP \(bu 2
cdb48126f7 Make lint happier.
.IP \(bu 2
62eca9b00b Execute fire_master asynchronously in the main minion thread.
.UNINDENT
.IP \(bu 2
52bce329cb Merge pull request \fI\%#42861\fP from twangboy/win_pkg_install_salt
.INDENT 2.0
.IP \(bu 2
0d3789f0c6 Fix pkg.install salt\-minion using salt\-call
.UNINDENT
.IP \(bu 2
b9f4f87aa5 Merge pull request \fI\%#42798\fP from s\-sebastian/2016.11
.INDENT 2.0
.IP \(bu 2
1cc86592ed Update return data before calling returners
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42842\fP: (\fI\%Giandom\fP) retrieve kwargs passed with slack engine (refs: \fI\%#42884\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42884\fP: (\fI\%Giandom\fP) Convert to dict type the pillar string value passed from slack
@ \fI2017\-08\-16 22:30:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
82be9dceb6 Merge pull request \fI\%#42884\fP from Giandom/2017.7.1\-fix\-slack\-engine\-pillar\-args
.IP \(bu 2
80fd733c99 Update slack.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42963\fP: (\fI\%twangboy\fP) Fix \fIunit.test_fileclient\fP for Windows
@ \fI2017\-08\-16 14:18:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
42bd553b98 Merge pull request \fI\%#42963\fP from twangboy/win_unit_test_fileclient
.IP \(bu 2
e9febe4893 Fix unit.test_fileclient
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42964\fP: (\fI\%twangboy\fP) Fix \fIsalt.utils.recursive_copy\fP for Windows
@ \fI2017\-08\-16 14:17:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
7dddeeea8d Merge pull request \fI\%#42964\fP from twangboy/win_fix_recursive_copy
.IP \(bu 2
121cd4ef81 Fix \fIsalt.utils.recursive_copy\fP for Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42943\fP: (\fI\%mirceaulinic\fP) \fIextension_modules\fP defaulting to \fI/var/cache/minion\fP although running under proxy minion (refs: \fI\%#42946\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42946\fP: (\fI\%mirceaulinic\fP) extension_modules should default to $CACHE_DIR/proxy/extmods
@ \fI2017\-08\-15 21:26:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
6da4d1d95e Merge pull request \fI\%#42946\fP from cloudflare/px_extmods_42943
.IP \(bu 2
73f9135340 extension_modules should default to /proxy/extmods
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42945\fP: (\fI\%Ch3LL\fP) [2017.7] Add clean_id function to salt.utils.verify.py (refs: \fI\%#43035\fP)
@ \fI2017\-08\-15 18:04:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
95645d49f9 Merge pull request \fI\%#42945\fP from Ch3LL/2017.7.0_follow_up
.IP \(bu 2
dcd92042e3 remove extra doc
.IP \(bu 2
693a504ef0 update release notes with cve number
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42427\fP: (\fI\%grichmond\-salt\fP) Issue Passing Variables created from load_json as Inline Pillar Between States (refs: \fI\%#42435\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42812\fP: (\fI\%terminalmage\fP) Update custom YAML loader tests to properly test unicode literals
@ \fI2017\-08\-15 17:50:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42435\fP: (\fI\%terminalmage\fP) Modify our custom YAML loader to treat unicode literals as unicode strings (refs: \fI\%#42812\fP)
.IP \(bu 2
47ff9d5627 Merge pull request \fI\%#42812\fP from terminalmage/yaml\-loader\-tests
.IP \(bu 2
9d8486a894 Add test for custom YAML loader with unicode literal strings
.IP \(bu 2
a0118bcece Remove bytestrings and use textwrap.dedent for readability
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42953\fP: (\fI\%Ch3LL\fP) [2017.7] Bump latest and previous versions
@ \fI2017\-08\-15 17:23:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
5d0c2198ac Merge pull request \fI\%#42953\fP from Ch3LL/latest_2017.7
.IP \(bu 2
cbecf65823 [2017.7] Bump latest and previous versions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42951\fP: (\fI\%Ch3LL\fP) Add Security Notice to 2017.7.1 Release Notes
@ \fI2017\-08\-15 16:49:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
730e71db17 Merge pull request \fI\%#42951\fP from Ch3LL/2017.7.1_docs
.IP \(bu 2
1d8f827c58 Add Security Notice to 2017.7.1 Release Notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42868\fP: (\fI\%carsonoid\fP) Stub out required functions in redis_cache
@ \fI2017\-08\-15 14:33:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
c1c8cb9bfa Merge pull request \fI\%#42868\fP from carsonoid/redisjobcachefix
.IP \(bu 2
885bee2a7d Stub out required functions for redis cache
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42810\fP: (\fI\%amendlik\fP) Ignore error values when listing Windows SNMP community strings
@ \fI2017\-08\-15 03:55:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
e192d6e0af Merge pull request \fI\%#42810\fP from amendlik/win\-snmp\-community
.IP \(bu 2
dc20e4651b Ignore error values when listing Windows SNMP community strings
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42920\fP: (\fI\%cachedout\fP) pid_race
@ \fI2017\-08\-15 03:49:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
a1817f1de3 Merge pull request \fI\%#42920\fP from cachedout/pid_race
.IP \(bu 2
5e930b8cbd If we catch the pid file in a transistory state, return None
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42925\fP: (\fI\%terminalmage\fP) Add debug logging to troubleshoot test failures
@ \fI2017\-08\-15 03:47:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
11a33fe692 Merge pull request \fI\%#42925\fP from terminalmage/f26\-debug\-logging
.IP \(bu 2
8165f46165 Add debug logging to troubleshoot test failures
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42913\fP: (\fI\%twangboy\fP) Change service shutdown timeouts for salt\-minion service (Windows)
@ \fI2017\-08\-14 20:55:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
a537197030 Merge pull request \fI\%#42913\fP from twangboy/win_change_timeout
.IP \(bu 2
ffb23fbe47 Remove the line that wipes out the cache
.IP \(bu 2
a3becf8342 Change service shutdown timeouts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42800\fP: (\fI\%skizunov\fP) Fix exception when master_type=disable
@ \fI2017\-08\-14 20:53:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca0555f616 Merge pull request \fI\%#42800\fP from skizunov/develop6
.IP \(bu 2
fa5822009f Fix exception when master_type=disable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42679\fP: (\fI\%mirceaulinic\fP) Add multiprocessing option for NAPALM proxy
@ \fI2017\-08\-14 20:45:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
3af264b664 Merge pull request \fI\%#42679\fP from cloudflare/napalm\-multiprocessing
.IP \(bu 2
9c4566db0c multiprocessing option tagged for 2017.7.2
.IP \(bu 2
37bca1b902 Add multiprocessing option for NAPALM proxy
.IP \(bu 2
a2565ba8e5 Add new napalm option: multiprocessing
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42611\fP: (\fI\%nhavens\fP) selinux.boolean state does not return changes (refs: \fI\%#42612\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42657\fP: (\fI\%nhavens\fP) back\-port \fI\%#42612\fP to 2017.7
@ \fI2017\-08\-14 19:42:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42612\fP: (\fI\%nhavens\fP) fix for issue \fI\%#42611\fP (refs: \fI\%#42657\fP)
.IP \(bu 2
4fcdab3ae9 Merge pull request \fI\%#42657\fP from nhavens/2017.7
.IP \(bu 2
d73c4b55b7 back\-port \fI\%#42612\fP to 2017.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42709\fP: (\fI\%whiteinge\fP) Add token_expire_user_override link to auth runner docstring
@ \fI2017\-08\-14 19:03:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
d2b6ce327a Merge pull request \fI\%#42709\fP from whiteinge/doc\-token_expire_user_override
.IP \(bu 2
c7ea631558 Add more docs on the token_expire param
.IP \(bu 2
4a9f6ba44f Add token_expire_user_override link to auth runner docstring
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42803\fP: (\fI\%gmcwhistler\fP) master_type: str, not working as expected, parent salt\-minion process dies. (refs: \fI\%#42848\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#42753\fP: (\fI\%grichmond\-salt\fP) SaltReqTimeout Error on Some Minions when One Master in a Multi\-Master Configuration is Unavailable (refs: \fI\%#42848\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42848\fP: (\fI\%DmitryKuzmenko\fP) Execute fire_master asynchronously in the main minion thread. (refs: \fI\%#42918\fP)
@ \fI2017\-08\-14 18:28:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
c6a7bf02e9 Merge pull request \fI\%#42848\fP from DSRCorporation/bugs/42753_mmaster_timeout
.IP \(bu 2
7f5412c19e Make lint happier.
.IP \(bu 2
ff66b7aaf0 Execute fire_master asynchronously in the main minion thread.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42911\fP: (\fI\%gtmanfred\fP) cloud driver isn\(aqt a provider
@ \fI2017\-08\-14 17:47:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a3279ea50 Merge pull request \fI\%#42911\fP from gtmanfred/2017.7
.IP \(bu 2
99046b441f cloud driver isn\(aqt a provider
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42860\fP: (\fI\%skizunov\fP) hash_and_stat_file should return a 2\-tuple
@ \fI2017\-08\-14 15:44:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
4456f7383d Merge pull request \fI\%#42860\fP from skizunov/develop7
.IP \(bu 2
5f85a03636 hash_and_stat_file should return a 2\-tuple
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42889\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-08\-14 14:16:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
c6ca7d639f Merge pull request \fI\%#42889\fP from rallytime/merge\-2017.7
.IP \(bu 2
fb7117f2ac Use salt.utils.versions.LooseVersion instead of distutils
.IP \(bu 2
29ff19c587 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
c15d0034fe Merge pull request \fI\%#41977\fP from redmatter/fix\-dockerng\-network\-ignores\-test
.INDENT 2.0
.IP \(bu 2
1cc2aa503a Fix dockerng.network_* ignoring of tests=True
.UNINDENT
.IP \(bu 2
3b9c3c5671 Merge pull request \fI\%#42886\fP from sarcasticadmin/adding_docs_salt_outputs
.INDENT 2.0
.IP \(bu 2
744bf954ff Adding missing output flags to salt cli
.UNINDENT
.IP \(bu 2
e5b98c8a88 Merge pull request \fI\%#42882\fP from gtmanfred/2016.11
.INDENT 2.0
.IP \(bu 2
da3402a53d make sure cmd is not run when npm isn\(aqt installed
.UNINDENT
.IP \(bu 2
5962c9588b Merge pull request \fI\%#42788\fP from amendlik/saltify\-timeout
.INDENT 2.0
.IP \(bu 2
928b523797 Remove waits and retries from Saltify deployment
.UNINDENT
.IP \(bu 2
227ecddd13 Merge pull request \fI\%#42877\fP from terminalmage/add\-cron\-state\-virtual
.INDENT 2.0
.IP \(bu 2
f1de196740 Add virtual func for cron state module
.UNINDENT
.IP \(bu 2
ab9f6cef33 Merge pull request \fI\%#42859\fP from terminalmage/gitpython\-git\-cli\-note
.INDENT 2.0
.IP \(bu 2
35e05c9515 Add note about git CLI requirement for GitPython to GitFS tutorial
.UNINDENT
.IP \(bu 2
682b4a8d14 Merge pull request \fI\%#42856\fP from gtmanfred/2016.11
.INDENT 2.0
.IP \(bu 2
b458b89fb8 skip cache_clean test if npm version is >= 5.0.0
.UNINDENT
.IP \(bu 2
01ea854029 Merge pull request \fI\%#42864\fP from whiteinge/syndic\-log\-root_dir
.INDENT 2.0
.IP \(bu 2
4b1f55da9c Make syndic_log_file respect root_dir setting
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42898\fP: (\fI\%mirceaulinic\fP) Minor eos doc correction
@ \fI2017\-08\-14 13:42:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
4b6fe2ee59 Merge pull request \fI\%#42898\fP from mirceaulinic/patch\-11
.IP \(bu 2
93be79a135 Index eos under the installation instructions list
.IP \(bu 2
f903e7bc39 Minor eos doc correction
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42883\fP: (\fI\%rallytime\fP) Fix failing boto tests (refs: \fI\%#42959\fP)
@ \fI2017\-08\-11 20:29:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
1764878754 Merge pull request \fI\%#42883\fP from rallytime/fix\-boto\-tests
.IP \(bu 2
6a7bf99848 Lint fix: add missing space
.IP \(bu 2
43643227c6 Skip 2 failing tests in Python 3 due to upstream bugs
.IP \(bu 2
7f46603e9c Update account id value in boto_secgroup module unit test
.IP \(bu 2
7c1d493fdd @mock_elb needs to be changed to @mock_elb_deprecated as well
.IP \(bu 2
3055e17ed5 Replace @mock_ec2 calls with @mock_ec2_deprecated calls
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42885\fP: (\fI\%terminalmage\fP) Move weird tearDown test to an actual tearDown
@ \fI2017\-08\-11 19:14:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
b21778efac Merge pull request \fI\%#42885\fP from terminalmage/fix\-f26\-tests
.IP \(bu 2
462d653082 Move weird tearDown test to an actual tearDown
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42870\fP: (\fI\%boltronics\fP) webutil.useradd marked as deprecated:: 2016.3.0 by mistake? (refs: \fI\%#42887\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42887\fP: (\fI\%rallytime\fP) Remove extraneous \(dqdeprecated\(dq notation
@ \fI2017\-08\-11 18:34:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
9868ab6f3b Merge pull request \fI\%#42887\fP from rallytime/fix\-42870
.IP \(bu 2
71e7581a2d Remove extraneous \(dqdeprecated\(dq notation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42881\fP: (\fI\%gtmanfred\fP) fix vmware for python 3.4.2 in salt.utils.vmware
@ \fI2017\-08\-11 17:52:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
da71f2a11b Merge pull request \fI\%#42881\fP from gtmanfred/vmware
.IP \(bu 2
05ecc6ac8d fix vmware for python 3.4.2 in salt.utils.vmware
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42843\fP: (\fI\%brejoc\fP) Kubernetes module won\(aqt work with Kubernetes Python client > 1.0.2 (refs: \fI\%#42845\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42845\fP: (\fI\%brejoc\fP) API changes for Kubernetes version 2.0.0 (refs: \fI\%#43039\fP)
@ \fI2017\-08\-11 14:04:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
c7750d5717 Merge pull request \fI\%#42845\fP from brejoc/updates\-for\-kubernetes\-2.0.0
.IP \(bu 2
81674aa88a Version info in :optdepends: not needed anymore
.IP \(bu 2
71995505bc Not depending on specific K8s version anymore
.IP \(bu 2
d8f7d7a7c0 API changes for Kubernetes version 2.0.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42678\fP: (\fI\%frankiexyz\fP) Add eos.rst in the installation guide
@ \fI2017\-08\-11 13:58:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
459fdedc67 Merge pull request \fI\%#42678\fP from frankiexyz/2017.7
.IP \(bu 2
1598571f52 Add eos.rst in the installation guide
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42646\fP: (\fI\%gmacon\fP) SPM fails to install multiple packages (refs: \fI\%#42778\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42778\fP: (\fI\%gtmanfred\fP) make sure to use the correct out_file
@ \fI2017\-08\-11 13:44:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ce96eb1a1 Merge pull request \fI\%#42778\fP from gtmanfred/spm
.IP \(bu 2
7ef691e8da make sure to use the correct out_file
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#480\fP: (\fI\%rallytime\fP) [2017.7] PY3 Debian 8 has several vmware unit tests failing (refs: \fI\%#42857\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42857\fP: (\fI\%gtmanfred\fP) use older name if _create_unverified_context is unavailable
@ \fI2017\-08\-11 13:37:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
3d05d89e09 Merge pull request \fI\%#42857\fP from gtmanfred/vmware
.IP \(bu 2
c1f673eca4 use older name if _create_unverified_context is unavailable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42866\fP: (\fI\%twangboy\fP) Change to GitPython version 2.1.1
@ \fI2017\-08\-11 13:23:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
7e8cfff21c Merge pull request \fI\%#42866\fP from twangboy/osx_downgrade_gitpython
.IP \(bu 2
28053a84a6 Change GitPython version to 2.1.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42855\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-08\-10 21:40:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ce18637be Merge pull request \fI\%#42855\fP from rallytime/merge\-2017.7
.IP \(bu 2
08bbcf5790 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
2dde1f77e9 Merge pull request \fI\%#42851\fP from terminalmage/bp\-42651
.INDENT 2.0
.IP \(bu 2
a3da86eea8 fix syntax
.IP \(bu 2
6ecdbcec1d make sure names are correct
.IP \(bu 2
f83b553d6e add py3 for versionlock
.IP \(bu 2
21934f61bb python2\- prefix for fedora 26 packages
.UNINDENT
.IP \(bu 2
c746f79a3a Merge pull request \fI\%#42806\fP from rallytime/fix\-42683
.INDENT 2.0
.IP \(bu 2
8c8640d6b8 Update doc references in glusterfs.volume_present
.UNINDENT
.IP \(bu 2
27a8a2695a Merge pull request \fI\%#42829\fP from twangboy/win_pkg_fix_install
.INDENT 2.0
.IP \(bu 2
83b9b230cd Add winrepo to docs about supporting versions in pkgs
.IP \(bu 2
81fefa6e67 Add ability to pass version in pkgs list
.UNINDENT
.IP \(bu 2
3c3ac6aeb2 Merge pull request \fI\%#42838\fP from twangboy/win_doc_pki
.INDENT 2.0
.IP \(bu 2
f0a1d06b46 Standardize PKI Client
.IP \(bu 2
7de687aa57 Document requirements for win_pki
.UNINDENT
.IP \(bu 2
b3e2ae3c58 Merge pull request \fI\%#42805\fP from rallytime/bp\-42552
.INDENT 2.0
.IP \(bu 2
5a91c1f2d1 update consul module following this documentation \fI\%https://www.consul.io/api/acl/acl.html\fP
.UNINDENT
.IP \(bu 2
d2ee7934ed Merge pull request \fI\%#42804\fP from rallytime/bp\-42784
.INDENT 2.0
.IP \(bu 2
dbd29e4aaa only read file if it is not a string
.UNINDENT
.IP \(bu 2
4cbf8057b3 Merge pull request \fI\%#42826\fP from terminalmage/fix\-spelling
.INDENT 2.0
.IP \(bu 2
00f93142e4 Fix misspelling of \(dqversions\(dq
.UNINDENT
.IP \(bu 2
de997edd90 Merge pull request \fI\%#42786\fP from Ch3LL/fix_typo
.INDENT 2.0
.IP \(bu 2
90a2fb66a2 Fix typo for template_dict in http docs
.UNINDENT
.IP \(bu 2
bf6153ebe5 Merge pull request \fI\%#42795\fP from lomeroe/bp\-42744_201611
.INDENT 2.0
.IP \(bu 2
695f8c1ae4 fix \fI\%#42600\fP in develop
.UNINDENT
.IP \(bu 2
61fad97286 Merge pull request \fI\%#42748\fP from whiteinge/save\-before\-output
.INDENT 2.0
.IP \(bu 2
de60b77c82 Workaround Orchestrate problem that highstate outputter mutates data
.UNINDENT
.IP \(bu 2
a4e3e7e786 Merge pull request \fI\%#42764\fP from amendlik/cloud\-win\-loop
.INDENT 2.0
.IP \(bu 2
f3dcfca4e0 Fix infinite loops on failed Windows deployments
.UNINDENT
.IP \(bu 2
da85326ad4 Merge pull request \fI\%#42694\fP from gtmanfred/2016.11
.INDENT 2.0
.IP \(bu 2
1a0457af51 allow adding extra remotes to a repository
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42774\fP: (\fI\%rossengeorgiev\fP) pkg.installed succeeds, but fails when you specify package version (refs: \fI\%#42808\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42808\fP: (\fI\%terminalmage\fP) Fix regression in yum/dnf version specification
@ \fI2017\-08\-10 15:59:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
f954f4f33a Merge pull request \fI\%#42808\fP from terminalmage/issue42774
.IP \(bu 2
c69f17dd18 Add integration test for \fI\%#42774\fP
.IP \(bu 2
78d826dd14 Fix regression in yum/dnf version specification
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42639\fP: (\fI\%amnonbc\fP) k8s module needs a way to manage configmaps (refs: \fI\%#42807\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42807\fP: (\fI\%rallytime\fP) Update modules \-\-> states in kubernetes doc module
@ \fI2017\-08\-10 14:10:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
d9b0f44885 Merge pull request \fI\%#42807\fP from rallytime/fix\-42639
.IP \(bu 2
152eb88d9f Update modules \-\-> states in kubernetes doc module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42818\fP: (\fI\%Mapel88\fP) Bug in win_iis module \- \(dqcreate_cert_binding\(dq (refs: \fI\%#42841\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42841\fP: (\fI\%Mapel88\fP) Fix bug \fI\%#42818\fP in win_iis module
@ \fI2017\-08\-10 13:44:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
b8c7bda68d Merge pull request \fI\%#42841\fP from Mapel88/patch\-1
.IP \(bu 2
497241fbcb Fix bug \fI\%#42818\fP in win_iis module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42697\fP: (\fI\%Ch3LL\fP) [Python3] NameError when running salt\-run manage.versions (refs: \fI\%#42782\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42782\fP: (\fI\%rallytime\fP) Add a cmp compatibility function utility
@ \fI2017\-08\-09 22:37:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
135f9522d0 Merge pull request \fI\%#42782\fP from rallytime/fix\-42697
.IP \(bu 2
d707f94863 Update all other calls to \(dqcmp\(dq function
.IP \(bu 2
5605104285 Add a cmp compatibility function utility
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42784\fP: (\fI\%gtmanfred\fP) only read file if ret is not a string in http.query (refs: \fI\%#42804\fP)
@ \fI2017\-08\-08 17:20:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
ac752223ad Merge pull request \fI\%#42784\fP from gtmanfred/http
.IP \(bu 2
d397c90e92 only read file if it is not a string
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42600\fP: (\fI\%twangboy\fP) Unable to set \(aqNot Configured\(aq using win_lgpo execution module (refs: \fI\%#42744\fP, \fI\%#42794\fP, \fI\%#42795\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42794\fP: (\fI\%lomeroe\fP) Backport \fI\%#42744\fP to 2017.7
@ \fI2017\-08\-08 17:16:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42744\fP: (\fI\%lomeroe\fP) fix \fI\%#42600\fP in develop (refs: \fI\%#42794\fP, \fI\%#42795\fP)
.IP \(bu 2
44995b1abf Merge pull request \fI\%#42794\fP from lomeroe/bp\-42744
.IP \(bu 2
0acffc6df5 fix \fI\%#42600\fP in develop
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42707\fP: (\fI\%cro\fP) Service module and state fails on FreeBSD (refs: \fI\%#42708\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42708\fP: (\fI\%cro\fP) Do not change the arguments of the function when memoizing
@ \fI2017\-08\-08 13:47:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
dcf474c47c Merge pull request \fI\%#42708\fP from cro/dont_change_args_during_memoize
.IP \(bu 2
a260e913b5 Do not change the arguments of the function when memoizing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42783\fP: (\fI\%rallytime\fP) Sort lists before comparing them in python 3 unit test
@ \fI2017\-08\-08 13:25:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42206\fP: (\fI\%rallytime\fP) [PY3] Fix test that is flaky in Python 3 (refs: \fI\%#42783\fP)
.IP \(bu 2
ddb671b8fe Merge pull request \fI\%#42783\fP from rallytime/fix\-flaky\-py3\-test
.IP \(bu 2
998834fbac Sort lists before compairing them in python 3 unit test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42721\fP: (\fI\%hibbert\fP) Allow no ip sg
@ \fI2017\-08\-07 22:07:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
d69822fe93 Merge pull request \fI\%#42721\fP from hibbert/allow_no_ip_sg
.IP \(bu 2
f58256802a allow_no_ip_sg: Allow user to not supply ipaddress or securitygroups when running boto_efs.create_mount_target
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42538\fP: (\fI\%marnovdm\fP) docker_container.running issue since 2017.7.0: passing domainname gives Error 500: json: cannot unmarshal array into Go value of type string (refs: \fI\%#42769\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42769\fP: (\fI\%terminalmage\fP) Fix domainname parameter input translation
@ \fI2017\-08\-07 20:46:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf7938fbe0 Merge pull request \fI\%#42769\fP from terminalmage/issue42538
.IP \(bu 2
665de2d1f9 Fix domainname parameter input translation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42388\fP: (\fI\%The\-Loeki\fP) pillar.items pillar_env & pillar_override are never used
@ \fI2017\-08\-07 17:51:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
7bf2cdb363 Merge pull request \fI\%#42388\fP from The\-Loeki/patch\-1
.IP \(bu 2
664f4b577b pillar.items pillar_env & pillar_override are never used
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42770\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.1 to 2017.7
@ \fI2017\-08\-07 16:21:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
9a8c9ebffc Merge pull request \fI\%#42770\fP from rallytime/merge\-2017.7.1\-into\-2017.7
.IP \(bu 2
6d17c9d227 Merge branch \(aq2017.7.1\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42768\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-08\-07 16:21:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
c765e528d0 Merge pull request \fI\%#42768\fP from rallytime/merge\-2017.7
.IP \(bu 2
0f75482c37 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
7b2119feee Merge pull request \fI\%#42669\fP from garethgreenaway/42642_2016_11_augeas_module_fix
.INDENT 2.0
.IP \(bu 2
24413084e2 Updating the call to shlex_split to pass the posix=False argument so that quotes are preserved.
.UNINDENT
.IP \(bu 2
30725769ed Merge pull request \fI\%#42629\fP from xiaoanyunfei/tornadoapi
.INDENT 2.0
.IP \(bu 2
1e13383b95 tornado api
.UNINDENT
.IP \(bu 2
f0f00fcee1 Merge pull request \fI\%#42655\fP from whiteinge/rest_cherrypy\-reenable\-stats
.INDENT 2.0
.IP \(bu 2
deb6316d67 Fix lint errors
.IP \(bu 2
6bd91c8b03 Reenable cpstats for rest_cherrypy
.UNINDENT
.IP \(bu 2
21cf15f9c3 Merge pull request \fI\%#42693\fP from gilbsgilbs/fix\-rabbitmq\-tags
.INDENT 2.0
.IP \(bu 2
78fccdc7e2 Cast to list in case tags is a tuple.
.IP \(bu 2
287b57b5c5 Fix RabbitMQ tags not properly set.
.UNINDENT
.IP \(bu 2
f2b0c9b4fa Merge pull request \fI\%#42574\fP from sbojarski/boto\-cfn\-error\-reporting
.INDENT 2.0
.IP \(bu 2
5c945f10c2 Fix debug message in \(dqboto_cfn._validate\(dq function.
.IP \(bu 2
181a1beecc Fixed error reporting in \(dqboto_cfn.present\(dq function.
.UNINDENT
.IP \(bu 2
bc1effc4f2 Merge pull request \fI\%#42623\fP from terminalmage/fix\-unicode\-constructor
.INDENT 2.0
.IP \(bu 2
fcf45889dd Fix unicode constructor in custom YAML loader
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42651\fP: (\fI\%gtmanfred\fP) python2\- prefix for fedora 26 packages (refs: \fI\%#42851\fP)
@ \fI2017\-08\-07 14:35:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
3f5827f61e Merge pull request \fI\%#42651\fP from gtmanfred/2017.7
.IP \(bu 2
8784899942 fix syntax
.IP \(bu 2
178cc1bd81 make sure names are correct
.IP \(bu 2
f179b97b52 add py3 for versionlock
.IP \(bu 2
1958d18634 python2\- prefix for fedora 26 packages
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42688\fP: (\fI\%hibbert\fP) salt.modules.boto_efs module Invalid type for parameter Tags \- type: <type \(aqdict\(aq>, valid types: <type \(aqlist\(aq>, <type \(aqtuple\(aq> (refs: \fI\%#42689\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42689\fP: (\fI\%hibbert\fP) boto_efs_fix_tags: Fix \fI\%#42688\fP invalid type for parameter tags
@ \fI2017\-08\-06 17:47:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
791248e398 Merge pull request \fI\%#42689\fP from hibbert/boto_efs_fix_tags
.IP \(bu 2
157fb28851 boto_efs_fix_tags: Fix \fI\%#42688\fP invalid type for parameter tags
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42705\fP: (\fI\%hbruch\fP) salt.states.docker_container.running replaces container on subsequent runs if oom_kill_disable unsupported (refs: \fI\%#42745\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42745\fP: (\fI\%terminalmage\fP) docker.compare_container: treat null oom_kill_disable as False
@ \fI2017\-08\-05 15:28:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
1b3407649b Merge pull request \fI\%#42745\fP from terminalmage/issue42705
.IP \(bu 2
710bdf6115 docker.compare_container: treat null oom_kill_disable as False
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42649\fP: (\fI\%tehsu\fP) local_batch no longer working in 2017.7.0, 500 error (refs: \fI\%#42704\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42704\fP: (\fI\%whiteinge\fP) Add import to work around likely multiprocessing scoping bug
@ \fI2017\-08\-04 23:03:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
5d5b22021b Merge pull request \fI\%#42704\fP from whiteinge/expr_form\-warn\-scope\-bug
.IP \(bu 2
03b675a618 Add import to work around likely multiprocessing scoping bug
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42741\fP: (\fI\%kkoppel\fP) docker_container.running keeps re\-creating containers with links to other containers (refs: \fI\%#42743\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42743\fP: (\fI\%kkoppel\fP) Fix docker.compare_container for containers with links
@ \fI2017\-08\-04 16:00:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
888e954e73 Merge pull request \fI\%#42743\fP from kkoppel/fix\-issue\-42741
.IP \(bu 2
de6d3cc0cf Update dockermod.py
.IP \(bu 2
58b997c67f Added a helper function that removes container names from container HostConfig:Links values to enable compare_container() to make the correct decision about differences in links.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42668\fP: (\fI\%UtahDave\fP) Minions under syndics don\(aqt respond to MoM (refs: \fI\%#42710\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#42545\fP: (\fI\%paul\-mulvihill\fP) Salt\-api failing to return results for minions connected via syndics. (refs: \fI\%#42710\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42710\fP: (\fI\%gtmanfred\fP) use subtraction instead of or
@ \fI2017\-08\-04 15:14:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
03a7f9bbee Merge pull request \fI\%#42710\fP from gtmanfred/syndic
.IP \(bu 2
683561a711 use subtraction instead of or
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42670\fP: (\fI\%gtmanfred\fP) render kubernetes docs
@ \fI2017\-08\-03 20:30:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
005182b6a1 Merge pull request \fI\%#42670\fP from gtmanfred/kube
.IP \(bu 2
bca17902f5 add version added info
.IP \(bu 2
4bbfc751ae render kubernetes docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42712\fP: (\fI\%twangboy\fP) Remove master config file from minion\-only installer
@ \fI2017\-08\-03 20:25:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
df354ddabf Merge pull request \fI\%#42712\fP from twangboy/win_build_pkg
.IP \(bu 2
8604312a7b Remove master conf in minion install
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42714\fP: (\fI\%cachedout\fP) Set fact gathering style to \(aqold\(aq for test_junos
@ \fI2017\-08\-03 13:39:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb1dfd4a42 Merge pull request \fI\%#42714\fP from cachedout/workaround_jnpr_test_bug
.IP \(bu 2
834d6c605e Set fact gathering style to \(aqold\(aq for test_junos
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42481\fP: (\fI\%twangboy\fP) Fix \fIunit.test_crypt\fP for Windows
@ \fI2017\-08\-01 18:10:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
4c1d931654 Merge pull request \fI\%#42481\fP from twangboy/win_unit_test_crypt
.IP \(bu 2
102509029e Remove chown mock, fix path seps
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42654\fP: (\fI\%morganwillcock\fP) Disable ZFS in the core grain for NetBSD
@ \fI2017\-08\-01 17:52:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
8bcefb5e67 Merge pull request \fI\%#42654\fP from morganwillcock/zfsgrain
.IP \(bu 2
49023deb94 Disable ZFS grain on NetBSD
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42421\fP: (\fI\%bfilipek\fP) archive.extracted on Windows failed when dir not exist (refs: \fI\%#42453\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42453\fP: (\fI\%gtmanfred\fP) don\(aqt pass user to makedirs on windows
@ \fI2017\-07\-31 19:57:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
5baf2650fc Merge pull request \fI\%#42453\fP from gtmanfred/makedirs
.IP \(bu 2
559d432930 fix tests
.IP \(bu 2
afa7a13ce3 use logic from file.directory for makedirs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42603\fP: (\fI\%twangboy\fP) Add runas_passwd as a global for states
@ \fI2017\-07\-31 19:49:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb81e78f71 Merge pull request \fI\%#42603\fP from twangboy/win_fix_runas
.IP \(bu 2
0c9e40012b Remove deprecation, add logic to state.py
.IP \(bu 2
464ec34713 Fix another instance of runas_passwd
.IP \(bu 2
18d6ce4d55 Add global vars to cmd.call
.IP \(bu 2
6c71ab6f80 Remove runas and runas_password after state run
.IP \(bu 2
4ea264e3db Change to runas_password in docs
.IP \(bu 2
61aba35718 Deprecate password, make runas_password a named arg
.IP \(bu 2
41f0f75a06 Add new var to list, change to runas_password
.IP \(bu 2
b9c91eba60 Add runas_passwd as a global for states
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42541\fP: (\fI\%Mareo\fP) Avoid confusing warning when using file.line
@ \fI2017\-07\-31 19:41:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
75ba23c253 Merge pull request \fI\%#42541\fP from epita/fix\-file\-line\-warning
.IP \(bu 2
2fd172e07b Avoid confusing warning when using file.line
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42625\fP: (\fI\%twangboy\fP) Fix the list function in the win_wua execution module
@ \fI2017\-07\-31 19:27:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
3d328eba80 Merge pull request \fI\%#42625\fP from twangboy/fix_win_wua
.IP \(bu 2
1340c15ce7 Add general usage instructions
.IP \(bu 2
19f34bda55 Fix docs, formatting
.IP \(bu 2
b17495c9c8 Fix problem with list when install=True
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42514\fP: (\fI\%rickh563\fP) \fImodule.run\fP does not work as expected in 2017.7.0 (refs: \fI\%#42602\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42602\fP: (\fI\%garethgreenaway\fP) Use superseded and deprecated configuration from pillar
@ \fI2017\-07\-31 18:53:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
25094ad9b1 Merge pull request \fI\%#42602\fP from garethgreenaway/42514_2017_7_superseded_deprecated_from_pillar
.IP \(bu 2
2e132daa73 Slight update to formatting
.IP \(bu 2
74bae13939 Small update to something I missed in the first commit.  Updating tests to also test for pillar values.
.IP \(bu 2
928a4808dd Updating the superseded and deprecated decorators to work when specified as pillar values.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42621\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-07\-28 19:45:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
b7cd30d3ee Merge pull request \fI\%#42621\fP from rallytime/merge\-2017.7
.IP \(bu 2
58dcb58a47 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
cbf752cd73 Merge pull request \fI\%#42515\fP from gtmanfred/backslash
.INDENT 2.0
.IP \(bu 2
cc4e45656d Allow not interpreting backslashes in the repl
.UNINDENT
.IP \(bu 2
549495831f Merge pull request \fI\%#42586\fP from gdubroeucq/2016.11
.INDENT 2.0
.IP \(bu 2
9c0b5cc1d6 Remove extra newline
.IP \(bu 2
d2ef4483e4 yumpkg.py: clean
.IP \(bu 2
a96f7c09e0 yumpkg.py: add option to the command \(dqcheck\-update\(dq
.UNINDENT
.IP \(bu 2
6b45debf28 Merge pull request \fI\%#41988\fP from redmatter/fix\-dockerng\-network\-matching
.INDENT 2.0
.IP \(bu 2
9eea796da8 Add regression tests for \fI\%#41982\fP
.IP \(bu 2
3369f0072f Fix broken unit test test_network_absent
.IP \(bu 2
0ef6cf634c Add trace logging of dockerng.networks result
.IP \(bu 2
515c612808 Fix dockerng.network_* name matching
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34245\fP: (\fI\%Talkless\fP) ini.options_present always report state change (refs: \fI\%#41690\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42618\fP: (\fI\%rallytime\fP) Back\-port \fI\%#41690\fP to 2017.7
@ \fI2017\-07\-28 19:27:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41690\fP: (\fI\%m03\fP) Fix issue \fI\%#34245\fP with ini.options_present reporting changes (refs: \fI\%#42618\fP)
.IP \(bu 2
d48749b476 Merge pull request \fI\%#42618\fP from rallytime/bp\-41690
.IP \(bu 2
22c6a7c7ff Improve output precision
.IP \(bu 2
ee4ea6b860 Fix \fI\%#34245\fP ini.options_present reporting changes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42588\fP: (\fI\%ixs\fP) salt\-ssh fails when using scan roster and detected minions are uncached (refs: \fI\%#42589\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42619\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42589\fP to 2017.7
@ \fI2017\-07\-28 19:26:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42589\fP: (\fI\%ixs\fP) Fix ssh\-salt calls with scan roster for uncached clients (refs: \fI\%#42619\fP)
.IP \(bu 2
e671242a4f Merge pull request \fI\%#42619\fP from rallytime/bp\-42589
.IP \(bu 2
cd5eb93903 Fix ssh\-salt calls with scan roster for uncached clients
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41982\fP: (\fI\%abulford\fP) dockerng.network_* matches too easily (refs: \fI\%#42006\fP, \fI\%#41988\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42006\fP: (\fI\%abulford\fP) Fix dockerng.network_* name matching
@ \fI2017\-07\-28 15:52:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41988\fP: (\fI\%abulford\fP) Fix dockerng.network_* name matching (refs: \fI\%#42006\fP)
.IP \(bu 2
7d385f8bdc Merge pull request \fI\%#42006\fP from redmatter/fix\-dockerng\-network\-matching\-2017.7
.IP \(bu 2
f83960c02a Lint: Remove extra line at end of file.
.IP \(bu 2
c7d364ec56 Add regression tests for \fI\%#41982\fP
.IP \(bu 2
d31f2913bd Fix broken unit test test_network_absent
.IP \(bu 2
d42f781c64 Add trace logging of docker.networks result
.IP \(bu 2
8c00c63b55 Fix dockerng.network_* name matching
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#12587\fP: (\fI\%Katafalkas\fP) salt\-cloud custom functions/actions (refs: \fI\%#42616\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42616\fP: (\fI\%amendlik\fP) Sync cloud modules
@ \fI2017\-07\-28 15:40:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
ee8aee1496 Merge pull request \fI\%#42616\fP from amendlik/sync\-clouds
.IP \(bu 2
ab21bd9b5b Sync cloud modules when saltutil.sync_all is run
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42601\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-07\-27 22:32:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
e2dd443002 Merge pull request \fI\%#42601\fP from rallytime/merge\-2017.7
.IP \(bu 2
36a1bcf8c5 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
4b16109122 Merge pull request \fI\%#42339\fP from isbm/isbm\-jobs\-scheduled\-in\-a\-future\-bsc1036125
.INDENT 2.0
.IP \(bu 2
bbba84ce2d Bugfix: Jobs scheduled to run at a future time stay pending for Salt minions (bsc#1036125)
.UNINDENT
.IP \(bu 2
6c5a7c604a Merge pull request \fI\%#42077\fP from vutny/fix\-jobs\-scheduled\-with\-whens
.INDENT 2.0
.IP \(bu 2
b1960cea44 Fix scheduled job run on Master if \fIwhen\fP parameter is a list
.UNINDENT
.IP \(bu 2
f9cb536589 Merge pull request \fI\%#42414\fP from vutny/unify\-hash\-params\-format
.INDENT 2.0
.IP \(bu 2
d1f2a93368 DOCS: unify hash sum with hash type format
.UNINDENT
.IP \(bu 2
535c922511 Merge pull request \fI\%#42523\fP from rallytime/fix\-42375
.INDENT 2.0
.IP \(bu 2
685c2cced6 Add information about returning a tuple with an error message
.IP \(bu 2
fa466519c4 Add a mention of the True/False returns with __virtual__()
.UNINDENT
.IP \(bu 2
0df0e7e749 Merge pull request \fI\%#42527\fP from twangboy/win_wua
.INDENT 2.0
.IP \(bu 2
0373791f2a Correct capatlization
.IP \(bu 2
af3bcc927b Document changes to Windows Update in 10/2016
.UNINDENT
.IP \(bu 2
69b06586da Merge pull request \fI\%#42551\fP from binocvlar/fix\-lack\-of\-align\-check\-output
.INDENT 2.0
.IP \(bu 2
c4fabaa192 Remove \(aq\-s\(aq (\-\-script) argument to parted within align_check function
.UNINDENT
.IP \(bu 2
9e0b4e9faf Merge pull request \fI\%#42573\fP from rallytime/bp\-42433
.INDENT 2.0
.IP \(bu 2
0293429e24 Only force saltenv/pillarenv to be a string when not None
.UNINDENT
.IP \(bu 2
e931ed2517 Merge pull request \fI\%#42571\fP from twangboy/win_add_pythonpath
.INDENT 2.0
.IP \(bu 2
d55a44dd1a Avoid loading user site packages
.IP \(bu 2
9af1eb2741 Ignore any PYTHON* environment vars already on the system
.IP \(bu 2
4e2fb03a95 Add pythonpath to batch files and service
.UNINDENT
.IP \(bu 2
de2f397041 Merge pull request \fI\%#42387\fP from DSRCorporation/bugs/42371_KeyError_WeakValueDict
.INDENT 2.0
.IP \(bu 2
e721c7eee2 Don\(aqt use \fIkey in weakvaluedict\fP because it could lie.
.UNINDENT
.IP \(bu 2
641a9d7efd Merge pull request \fI\%#41968\fP from root360\-AndreasUlm/fix\-rabbitmqctl\-output\-handler
.INDENT 2.0
.IP \(bu 2
76fd941d91 added tests for rabbitmq 3.6.10 output handler
.IP \(bu 2
3602af1e1b Fix rabbitmqctl output handler for 3.6.10
.UNINDENT
.IP \(bu 2
66fede378a Merge pull request \fI\%#42479\fP from gtmanfred/interface
.INDENT 2.0
.IP \(bu 2
c32c1b2803 fix pylint
.IP \(bu 2
99ec634c6b validate ssh_interface for ec2
.UNINDENT
.IP \(bu 2
a925c7029a Merge pull request \fI\%#42516\fP from rallytime/fix\-42405
.INDENT 2.0
.IP \(bu 2
e3a6717efa Add info about top file to pillar walk\-through example to include edit.vim
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42148\fP: (\fI\%sjorge\fP) [2017.7.0rc1] use_superseded and module.run changes from release notes do nothing? (refs: \fI\%#42270\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42290\fP: (\fI\%isbm\fP) Backport of \fI\%#42270\fP
@ \fI2017\-07\-27 22:30:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42270\fP: (\fI\%The\-Loeki\fP) State module.run/wait misses args when looking for kwargs (refs: \fI\%#42290\fP)
.IP \(bu 2
22eea389fa Merge pull request \fI\%#42290\fP from isbm/isbm\-module_run_parambug_42270_217
.IP \(bu 2
e38d432f90 Fix docs
.IP \(bu 2
1e8a56eda5 Describe function tagging
.IP \(bu 2
1d7233224b Describe function batching
.IP \(bu 2
1391a05d5e Bugfix: syntax error in the example
.IP \(bu 2
8c71257a4b Call unnamed parameters properly
.IP \(bu 2
94c97a8f25 Update and correct the error message
.IP \(bu 2
ea8351362c Bugfix: args gets ignored alongside named parameters
.IP \(bu 2
74689e3462 Add ability to use tagged functions in the same set
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42251\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_win_ip\fP for Windows
@ \fI2017\-07\-27 19:22:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
4c20f1cfbb Merge pull request \fI\%#42251\fP from twangboy/unit_win_test_win_ip
.IP \(bu 2
97261bfe69 Fix win_inet_pton check for malformatted ip addresses
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42255\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_win_system\fP for Windows
@ \fI2017\-07\-27 19:12:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
2985e4c0e6 Merge pull request \fI\%#42255\fP from twangboy/win_unit_test_win_system
.IP \(bu 2
acc0345bc8 Fix unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42528\fP: (\fI\%twangboy\fP) Namespace \fIcmp_to_key\fP in the pkg state for Windows
@ \fI2017\-07\-27 18:30:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
a573386260 Merge pull request \fI\%#42528\fP from twangboy/win_fix_pkg_state
.IP \(bu 2
a040443fa1 Move functools import inside pylint escapes
.IP \(bu 2
118d5134e2 Remove namespaced function \fIcmp_to_key\fP
.IP \(bu 2
a02c91adda Namespace \fIcmp_to_key\fP in the pkg state for Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42521\fP: (\fI\%rickh563\fP) chocolatey.installed broken on 2017.7.0 (refs: \fI\%#42534\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42534\fP: (\fI\%jmarinaro\fP) Fixes AttributeError thrown by chocolatey state
@ \fI2017\-07\-27 17:59:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
62ae12bcd9 Merge pull request \fI\%#42534\fP from jmarinaro/2017.7
.IP \(bu 2
b242d2d6b5 Fixes AttributeError thrown by chocolatey state Fixes \fI\%#42521\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40354\fP: (\fI\%exc414\fP) CentOS 6.8 Init Script \- Sed unterminated address regex (refs: \fI\%#42557\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#37312\fP: (\fI\%gtmanfred\fP) CLI flags should take overload settings in the config files (refs: \fI\%#42557\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42557\fP: (\fI\%justincbeard\fP) Fixing output so \-\-force\-color and \-\-no\-color override master and min…
@ \fI2017\-07\-27 17:07:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
52605c249d Merge pull request \fI\%#42557\fP from justincbeard/bugfix_37312
.IP \(bu 2
ee3bc6eb10 Fixing output so \-\-force\-color and \-\-no\-color override master and minion config color value
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42567\fP: (\fI\%skizunov\fP) Fix disable_<tag\-name> config option
@ \fI2017\-07\-27 17:05:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab33517efb Merge pull request \fI\%#42567\fP from skizunov/develop3
.IP \(bu 2
0f0b7e3e0a Fix disable_<tag\-name> config option
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42577\fP: (\fI\%twangboy\fP) Compile scripts with \-E \-s params for Salt on Mac
@ \fI2017\-07\-26 22:44:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
30bb941179 Merge pull request \fI\%#42577\fP from twangboy/mac_scripts
.IP \(bu 2
69d5973651 Compile scripts with \-E \-s params for python
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42524\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-07\-26 22:41:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
60cd078164 Merge pull request \fI\%#42524\fP from rallytime/merge\-2017.7
.IP \(bu 2
14d8d795f6 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
1bd5bbccc2 Merge pull request \fI\%#42509\fP from clem\-compilatio/fix\-42417
.INDENT 2.0
.IP \(bu 2
72924b06b8 Fix _assign_floating_ips in openstack.py
.UNINDENT
.IP \(bu 2
4bf35a74de Merge pull request \fI\%#42464\fP from garethgreenaway/2016_11_remove_tmp_identity_file
.INDENT 2.0
.IP \(bu 2
ff24102d51 Uncomment the line that removes the temporary identity file.
.UNINDENT
.IP \(bu 2
e2120dbd0e Merge pull request \fI\%#42443\fP from garethgreenaway/42357_pass_args_kwargs_correctly
.INDENT 2.0
.IP \(bu 2
635810b3e3 Updating the slack engine in 2016.11 to pass the args and kwrags correctly to LocalClient
.UNINDENT
.IP \(bu 2
8262cc9054 Merge pull request \fI\%#42200\fP from shengis/sqlite3_fix_row_absent_2016.11
.INDENT 2.0
.IP \(bu 2
407b8f4bb3 Fix \fI\%#42198\fP If where_args is not set, not using it in the delete request.
.UNINDENT
.IP \(bu 2
d9df97e5a3 Merge pull request \fI\%#42424\fP from goten4/2016.11
.INDENT 2.0
.IP \(bu 2
1c0574d05e Fix error message when tornado or pycurl is not installed
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42575\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.1 to 2017.7
@ \fI2017\-07\-26 22:39:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
2acde837df Merge pull request \fI\%#42575\fP from rallytime/merge\-2017.7.1\-into\-2017.7
.IP \(bu 2
63bb0fb2c4 pass in empty kwarg for reactor
.IP \(bu 2
2868061ee4 update chunk, not kwarg in chunk
.IP \(bu 2
46715e9d94 Merge branch \(aq2017.7.1\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42555\fP: (\fI\%Ch3LL\fP) add changelog to 2017.7.1 release notes
@ \fI2017\-07\-26 14:57:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
1d93e92194 Merge pull request \fI\%#42555\fP from Ch3LL/7.1_add_changelog
.IP \(bu 2
fb69e71093 add changelog to 2017.7.1 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42266\fP: (\fI\%twangboy\fP) Fix \fIunit.states.test_file\fP for Windows
@ \fI2017\-07\-25 20:26:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
07c2793e86 Merge pull request \fI\%#42266\fP from twangboy/win_unit_states_test_file
.IP \(bu 2
669aaee10d Mock file exists properly
.IP \(bu 2
a4231c9827 Fix ret mock for linux
.IP \(bu 2
0c484f8979 Fix unit tests on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42484\fP: (\fI\%shengis\fP) Fix a potential Exception with an explicit error message
@ \fI2017\-07\-25 18:34:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
df417eae17 Merge pull request \fI\%#42484\fP from shengis/fix\-explicit\-error\-msg\-x509\-sign\-remote
.IP \(bu 2
0b548c72e1 Fix a potential Exception with an explicit error message
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#396\fP: (\fI\%Ch3LL\fP) Python3 Fix Test: JoyentTest.test_instance (refs: \fI\%#42529\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#41720\fP: (\fI\%rallytime\fP) [Py3] Some salt\-cloud drivers do not work using Python 3 (refs: \fI\%#42529\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42529\fP: (\fI\%gtmanfred\fP) Fix joyent for python3
@ \fI2017\-07\-25 16:37:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
0f25ec76f9 Merge pull request \fI\%#42529\fP from gtmanfred/2017.7
.IP \(bu 2
b7ebb4d81a these drivers do not actually have an issue.
.IP \(bu 2
e90ca7a114 use salt encoding for joyent on 2017.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42465\fP: (\fI\%garethgreenaway\fP) [2017.7] Small fix to modules/git.py
@ \fI2017\-07\-24 17:24:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
488457c5a0 Merge pull request \fI\%#42465\fP from garethgreenaway/2017_7_remove_tmp_identity_file
.IP \(bu 2
1920dc6079 Uncomment the line that removes the temporary identity file.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23516\fP: (\fI\%dkiser\fP) BUG: cron job scheduler sporadically works (refs: \fI\%#42077\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42107\fP: (\fI\%vutny\fP) [2017.7] Fix scheduled jobs if \fIwhen\fP parameter is a list
@ \fI2017\-07\-24 17:04:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42077\fP: (\fI\%vutny\fP) Fix scheduled job run on Master if \fIwhen\fP parameter is a list (refs: \fI\%#42107\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41973\fP: (\fI\%vutny\fP) Fix Master/Minion scheduled jobs based on Cron expressions (refs: \fI\%#42077\fP)
.IP \(bu 2
4f044999fa Merge pull request \fI\%#42107\fP from vutny/2017.7\-fix\-jobs\-scheduled\-with\-whens
.IP \(bu 2
905be493d4 [2017.7] Fix scheduled jobs if \fIwhen\fP parameter is a list
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42506\fP: (\fI\%terminalmage\fP) Add PER_REMOTE_ONLY to init_remotes call in git_pillar runner
@ \fI2017\-07\-24 16:59:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
6eaa0763e1 Merge pull request \fI\%#42506\fP from terminalmage/fix\-git\-pillar\-runner
.IP \(bu 2
6352f447ce Add PER_REMOTE_ONLY to init_remotes call in git_pillar runner
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42502\fP: (\fI\%shengis\fP) Fix azurerm query to show IPs
@ \fI2017\-07\-24 15:54:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
b88e645f10 Merge pull request \fI\%#42502\fP from shengis/fix_azurerm_request_ips
.IP \(bu 2
92f1890701 Fix azurerm query to show IPs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42180\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_timezone\fP for Windows
@ \fI2017\-07\-24 14:46:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
c793d83d26 Merge pull request \fI\%#42180\fP from twangboy/win_unit_test_timezone
.IP \(bu 2
832a3d86dd Skip tests that use os.symlink on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42474\fP: (\fI\%whiteinge\fP) Cmd arg kwarg parsing test
@ \fI2017\-07\-24 14:13:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39646\fP: (\fI\%terminalmage\fP) Handle deprecation of passing string args to load_args_and_kwargs (refs: \fI\%#42474\fP)
.IP \(bu 2
083ff00410 Merge pull request \fI\%#42474\fP from whiteinge/cmd\-arg\-kwarg\-parsing\-test
.IP \(bu 2
0cc0c0967a Lint fixes
.IP \(bu 2
66093738c8 Add back support for string kwargs
.IP \(bu 2
622ff5be40 Add LocalClient.cmd test for arg/kwarg parsing
.IP \(bu 2
9f4eb80d90 Add a test.arg variant that cleans the pub kwargs by default
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42425\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-07\-21 22:43:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
c91a5e539e Merge pull request \fI\%#42425\fP from rallytime/merge\-2017.7
.IP \(bu 2
ea457aa0a5 Remove ALIASES block from template util
.IP \(bu 2
c673b64583 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
42bb1a64ca Merge pull request \fI\%#42350\fP from twangboy/win_fix_ver_grains_2016.11
.INDENT 2.0
.IP \(bu 2
8c048403d7 Detect Server OS with a desktop release name
.UNINDENT
.IP \(bu 2
0a72e56f6b Merge pull request \fI\%#42356\fP from meaksh/2016.11\-AliasesLoader\-wrapper\-fix
.INDENT 2.0
.IP \(bu 2
915d94219e Allow checking whether a function is available on the AliasesLoader wrapper
.UNINDENT
.IP \(bu 2
10eb7b7a79 Merge pull request \fI\%#42368\fP from twangboy/win_fix_build_2016.11
.INDENT 2.0
.IP \(bu 2
a7c910c31e Remove build and dist directories before install
.UNINDENT
.IP \(bu 2
016189f62f Merge pull request \fI\%#42370\fP from rallytime/merge\-2016.11
.INDENT 2.0
.IP \(bu 2
0aa5dde1de Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
e9b0f20f8a Merge pull request \fI\%#42359\fP from Ch3LL/doc\-update\-2016.3
.INDENT 2.0
.IP \(bu 2
dc85b5edbe [2016.3] Update version numbers in doc config for 2017.7.0 release
.UNINDENT
.UNINDENT
.IP \(bu 2
f06a6f1796 Merge pull request \fI\%#42360\fP from Ch3LL/doc\-update\-2016.11
.INDENT 2.0
.IP \(bu 2
b90b7a7506 [2016.11] Update version numbers in doc config for 2017.7.0 release
.UNINDENT
.IP \(bu 2
e0595b0a0f Merge pull request \fI\%#42319\fP from rallytime/config\-docs
.INDENT 2.0
.IP \(bu 2
b40f980632 Add more documentation for config options that are missing from master/minion docs
.UNINDENT
.IP \(bu 2
78940400e3 Merge pull request \fI\%#42352\fP from CorvinM/issue42333
.INDENT 2.0
.IP \(bu 2
526b6ee14d Multiple documentation fixes
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42357\fP: (\fI\%Giandom\fP) Salt pillarenv problem with slack engine (refs: \fI\%#42443\fP, \fI\%#42444\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42444\fP: (\fI\%garethgreenaway\fP) [2017.7] Fix to slack engine
@ \fI2017\-07\-21 22:03:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
10e4d9234b Merge pull request \fI\%#42444\fP from garethgreenaway/42357_2017_7_pass_args_kwargs_correctly
.IP \(bu 2
f411cfc2a9 Updating the slack engine in 2017.7 to pass the args and kwrags correctly to LocalClient
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42461\fP: (\fI\%rallytime\fP) Bump warning version from Oxygen to Fluorine in roster cache
@ \fI2017\-07\-21 21:33:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
723be49fac Merge pull request \fI\%#42461\fP from rallytime/bump\-roster\-cache\-deprecations
.IP \(bu 2
c0df0137f5 Bump warning version from Oxygen to Fluorine in roster cache
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42374\fP: (\fI\%tyhunt99\fP) [2017.7.0] salt\-run mange.versions throws exception if minion is offline or unresponsive (refs: \fI\%#42436\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42436\fP: (\fI\%garethgreenaway\fP) Fixes to versions function in manage runner
@ \fI2017\-07\-21 19:41:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
09521602c1 Merge pull request \fI\%#42436\fP from garethgreenaway/42374_manage_runner_minion_offline
.IP \(bu 2
0fd39498c0 Updating the versions function inside the manage runner to account for when a minion is offline and we are unable to determine its version.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42427\fP: (\fI\%grichmond\-salt\fP) Issue Passing Variables created from load_json as Inline Pillar Between States (refs: \fI\%#42435\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42435\fP: (\fI\%terminalmage\fP) Modify our custom YAML loader to treat unicode literals as unicode strings (refs: \fI\%#42812\fP)
@ \fI2017\-07\-21 19:40:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
54193ea543 Merge pull request \fI\%#42435\fP from terminalmage/issue42427
.IP \(bu 2
31273c7ec1 Modify our custom YAML loader to treat unicode literals as unicode strings
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42381\fP: (\fI\%zebooka\fP) Git.detached broken in 2017.7.0 (refs: \fI\%#42399\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38878\fP: (\fI\%tomlaredo\fP) [Naming consistency] git.latest \(dqrev\(dq option VS git.detached \(dqref\(dq option (refs: \fI\%#38898\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42399\fP: (\fI\%rallytime\fP) Update old \(dqref\(dq references to \(dqrev\(dq in git.detached state
@ \fI2017\-07\-21 19:38:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38898\fP: (\fI\%terminalmage\fP) git.detached: rename ref to rev for consistency (refs: \fI\%#42399\fP)
.IP \(bu 2
0b3179135c Merge pull request \fI\%#42399\fP from rallytime/fix\-42381
.IP \(bu 2
d9d94fe02f Update old \(dqref\(dq references to \(dqrev\(dq in git.detached state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42400\fP: (\fI\%Enquier\fP) Conflict in execution of passing pillar data to orch/reactor event executions 2017.7.0 (refs: \fI\%#42031\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42031\fP: (\fI\%skizunov\fP) Fix: Reactor emits critical error
@ \fI2017\-07\-21 19:38:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd4adb483d Merge pull request \fI\%#42031\fP from skizunov/develop3
.IP \(bu 2
540977b4b1 Fix: Reactor emits critical error
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41949\fP: (\fI\%jrporcaro\fP) Event returner doesn\(aqt work with Windows Master (refs: \fI\%#42027\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42027\fP: (\fI\%gtmanfred\fP) import salt.minion for EventReturn for Windows
@ \fI2017\-07\-21 19:37:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
3abf7ad7d7 Merge pull request \fI\%#42027\fP from gtmanfred/2017.7
.IP \(bu 2
fd4458b6c7 import salt.minion for EventReturn for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42454\fP: (\fI\%terminalmage\fP) Document future renaming of new rand_str jinja filter
@ \fI2017\-07\-21 18:47:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
994d3dc74a Merge pull request \fI\%#42454\fP from terminalmage/jinja\-docs\-2017.7
.IP \(bu 2
98b661406e Document future renaming of new rand_str jinja filter
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42452\fP: (\fI\%Ch3LL\fP) update windows urls to new py2/py3 naming scheme
@ \fI2017\-07\-21 17:20:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
4480075129 Merge pull request \fI\%#42452\fP from Ch3LL/fix_url_windows
.IP \(bu 2
3f4a918f73 update windows urls to new py2/py3 naming scheme
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42404\fP: (\fI\%gabekahen\fP) [2017.7] file.managed with cmd_check \(dqNo such file or directory\(dq (refs: \fI\%#42411\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33708\fP: (\fI\%pepinje\fP) visudo check command leaves cache file in /tmp (refs: \fI\%#42411\fP, \fI\%#38063\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42411\fP: (\fI\%seedickcode\fP) Fix file.managed check_cmd file not found \- Issue \fI\%#42404\fP
@ \fI2017\-07\-20 21:59:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38063\fP: (\fI\%llua\fP) tmp file clean up in file.manage \- fix for \fI\%#33708\fP (refs: \fI\%#42411\fP)
.IP \(bu 2
33e90be1fe Merge pull request \fI\%#42411\fP from seedickcode/check_cmd_fix
.IP \(bu 2
4ae3911f01 Fix file.managed check_cmd file not found \- Issue \fI\%#42404\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42409\fP: (\fI\%twangboy\fP) Add Scripts to build Py3 on Mac
@ \fI2017\-07\-20 21:36:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
edde31376a Merge pull request \fI\%#42409\fP from twangboy/mac_py3_scripts
.IP \(bu 2
ac0e04af72 Remove build and dist, sign pkgs
.IP \(bu 2
9d66e273c4 Fix hard coded pip path
.IP \(bu 2
7b8d6cbbd2 Add support for Py3
.IP \(bu 2
aa4eed93c8 Update Python and other reqs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42403\fP: (\fI\%astronouth7303\fP) [2017.7] Pillar empty when state is applied from orchestrate (refs: \fI\%#42433\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42433\fP: (\fI\%terminalmage\fP) Only force saltenv/pillarenv to be a string when not None (refs: \fI\%#42573\fP)
@ \fI2017\-07\-20 21:32:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
82982f940d Merge pull request \fI\%#42433\fP from terminalmage/issue42403
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42408\fP: (\fI\%CorvinM\fP) Fix documentation misformat in salt.states.file.replace
@ \fI2017\-07\-20 00:45:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
a71938cefe Merge pull request \fI\%#42408\fP from CorvinM/file\-replace\-doc\-fix
.IP \(bu 2
246a2b3e74 Fix documentation misformat in salt.states.file.replace
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42347\fP: (\fI\%twangboy\fP) Fixes problem with Version and OS Release related grains on certain versions of Python
@ \fI2017\-07\-19 17:05:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
d385dfd19d Merge pull request \fI\%#42347\fP from twangboy/win_fix_ver_grains
.IP \(bu 2
ef1f663fc9 Detect server OS with a desktop release name
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42366\fP: (\fI\%twangboy\fP) Remove build and dist directories before install
@ \fI2017\-07\-19 16:37:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
eb9e4206c9 Merge pull request \fI\%#42366\fP from twangboy/win_fix_build
.IP \(bu 2
0946002713 Add blank line after delete
.IP \(bu 2
f7c0bb4f46 Remove build and dist directories before install
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42373\fP: (\fI\%Ch3LL\fP) Add initial 2017.7.1 Release Notes File
@ \fI2017\-07\-19 16:28:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
af7820f25d Merge pull request \fI\%#42373\fP from Ch3LL/add_2017.7.1
.IP \(bu 2
ce1c1b6d28 Add initial 2017.7.1 Release Notes File
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42150\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_pip\fP for Windows
@ \fI2017\-07\-19 16:01:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
59e012b485 Merge pull request \fI\%#42150\fP from twangboy/win_unit_test_pip
.IP \(bu 2
4ee24202fc Fix unit tests for test_pip
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42154\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_reg_win\fP for Windows
@ \fI2017\-07\-19 16:00:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
ade25c6b34 Merge pull request \fI\%#42154\fP from twangboy/win_unit_test_reg
.IP \(bu 2
00d9a52802 Fix problem with handling REG_QWORD in list values
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42182\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_useradd\fP for Windows
@ \fI2017\-07\-19 15:55:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
07593675e2 Merge pull request \fI\%#42182\fP from twangboy/win_unit_test_useradd
.IP \(bu 2
8260a71c07 Disable tests that require pwd in Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42364\fP: (\fI\%twangboy\fP) Windows Package notes for 2017.7.0
@ \fI2017\-07\-18 19:24:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
a175c40c1d Merge pull request \fI\%#42364\fP from twangboy/release_notes_2017.7.0
.IP \(bu 2
96517d1355 Add note about patched windows packages
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42361\fP: (\fI\%Ch3LL\fP) [2017.7] Update version numbers in doc config for 2017.7.0 release
@ \fI2017\-07\-18 19:23:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
4dfe50e558 Merge pull request \fI\%#42361\fP from Ch3LL/doc\-update\-2017.7
.IP \(bu 2
dc5bb301f7 [2017.7] Update version numbers in doc config for 2017.7.0 release
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42363\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-07\-18 18:40:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
587138d771 Merge pull request \fI\%#42363\fP from rallytime/merge\-2017.7
.IP \(bu 2
7aa31ff030 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
b256001760 Merge pull request \fI\%#42353\fP from terminalmage/fix\-git\-test
.INDENT 2.0
.IP \(bu 2
14cf6ce322 is_windows is a function, not a propery/attribute
.UNINDENT
.IP \(bu 2
866a1febb4 Merge pull request \fI\%#42264\fP from rallytime/fix\-41116
.INDENT 2.0
.IP \(bu 2
bd638880e3 Add mono\-spacing to salt\-minion reference for consistency
.IP \(bu 2
30d62f43da Update minion restart section in FAQ doc for windows
.UNINDENT
.IP \(bu 2
9a707088ad Merge pull request \fI\%#42275\fP from terminalmage/issue42194
.INDENT 2.0
.IP \(bu 2
663874908a pkg.installed: pack name/version into pkgs argument
.UNINDENT
.IP \(bu 2
e588f235e0 Merge pull request \fI\%#42269\fP from rallytime/fix\-41721
.INDENT 2.0
.IP \(bu 2
f2250d474a Add a note about using different styles of quotes.
.IP \(bu 2
38d9b3d553 Add some clarity to \(dqmultiple quotes\(dq section of yaml docs
.UNINDENT
.IP \(bu 2
5aaa214a75 Merge pull request \fI\%#42282\fP from rallytime/fix\-42152
.INDENT 2.0
.IP \(bu 2
f032223843 Handle libcloud objects that throw RepresenterErrors with \-\-out=yaml
.UNINDENT
.IP \(bu 2
fb5697a4bc Merge pull request \fI\%#42308\fP from lubyou/42295\-fix\-file\-absent\-windows
.INDENT 2.0
.IP \(bu 2
026ccf401a Force file removal on Windows. Fixes \fI\%#42295\fP
.UNINDENT
.IP \(bu 2
da2a8a518f Merge pull request \fI\%#42314\fP from rallytime/fix\-42267
.INDENT 2.0
.IP \(bu 2
c406046940 Add clarification to salt ssh docs about key auto\-generation.
.UNINDENT
.IP \(bu 2
acadd54013 Merge pull request \fI\%#41945\fP from garethgreenaway/41936_allow_identity_files_with_user
.INDENT 2.0
.IP \(bu 2
44841e5626 Moving the call to cp.get_file inside the with block to ensure the umask is preserved when we grab the file.
.IP \(bu 2
f9ba60eed8 Merge pull request \fI\%#1\fP from terminalmage/pr\-41945
.INDENT 2.0
.IP \(bu 2
1b6026177c Restrict set_umask to mkstemp call only
.UNINDENT
.IP \(bu 2
68549f3496 Fixing umask to we can set files as executable.
.IP \(bu 2
4949bf3ff3 Updating to swap on the new salt.utils.files.set_umask context_manager
.IP \(bu 2
8faa9f6d92 Updating PR with requested changes.
.IP \(bu 2
494765e939 Updating the git module to allow an identity file to be used when passing the user parameter
.UNINDENT
.IP \(bu 2
f90e04a2bc Merge pull request \fI\%#42289\fP from CorvinM/bp\-41543
.INDENT 2.0
.IP \(bu 2
357dc22f05 Fix user creation with empty password
.UNINDENT
.IP \(bu 2
a91a3f81b1 Merge pull request \fI\%#42123\fP from vutny/fix\-master\-utils\-import
.INDENT 2.0
.IP \(bu 2
6bb8b8f98c Add missing doc for \fButils_dirs\fP Minion config option
.IP \(bu 2
f1bc58f6d5 Utils: add example of module import
.UNINDENT
.IP \(bu 2
e2aa5114e4 Merge pull request \fI\%#42261\fP from rallytime/minor\-doc\-fix
.INDENT 2.0
.IP \(bu 2
8c76bbb53d Some minor doc fixes for dnsutil module so they\(aqll render correctly
.UNINDENT
.IP \(bu 2
3e9dfbc9cc Merge pull request \fI\%#42262\fP from rallytime/bp\-42224
.INDENT 2.0
.IP \(bu 2
c31ded341c Remove duplicate instruction in Openstack Rackspace config example
.UNINDENT
.IP \(bu 2
7780579c36 Merge pull request \fI\%#42181\fP from garethgreenaway/42137_backport_fix_from_2017_7
.INDENT 2.0
.IP \(bu 2
a34970b45b Back porting the fix for 2017.7 that ensures the order of the names parameter.
.UNINDENT
.IP \(bu 2
72537868a6 Merge pull request \fI\%#42253\fP from gtmanfred/2016.11
.INDENT 2.0
.IP \(bu 2
53e25760be Only use unassociated ips when unable to allocate
.UNINDENT
.IP \(bu 2
b2a4698b5d Merge pull request \fI\%#42252\fP from UtahDave/2016.11local
.INDENT 2.0
.IP \(bu 2
e6a9563d47 simple doc updates
.UNINDENT
.IP \(bu 2
781fe13be7 Merge pull request \fI\%#42235\fP from astronouth7303/patch\-1\-2016.3
.INDENT 2.0
.IP \(bu 2
4cb51bd03a Make note of dig partial requirement.
.IP \(bu 2
08e7d8351a Abolish references to \fIdig\fP in examples.
.UNINDENT
.IP \(bu 2
83cbd76f16 Merge pull request \fI\%#42215\fP from twangboy/win_iis_docs
.INDENT 2.0
.IP \(bu 2
c07e22041a Add missing config to example
.UNINDENT
.IP \(bu 2
274946ab00 Merge pull request \fI\%#42211\fP from terminalmage/issue40928
.INDENT 2.0
.IP \(bu 2
22a18fa2ed Only pass a saltenv in orchestration if one was explicitly passed (2016.11)
.UNINDENT
.IP \(bu 2
89261cf06c Merge pull request \fI\%#42173\fP from rallytime/bp\-37424
.INDENT 2.0
.IP \(bu 2
01addb6053 Avoid Early Convert ret[\(aqcomment\(aq] to String
.UNINDENT
.IP \(bu 2
3b17fb7f83 Merge pull request \fI\%#42175\fP from rallytime/bp\-39366
.INDENT 2.0
.IP \(bu 2
53f7b987e8 Pass sig to service.status in after_toggle
.UNINDENT
.IP \(bu 2
ea16f47f0a Merge pull request \fI\%#42172\fP from rallytime/merge\-2016.11
.INDENT 2.0
.IP \(bu 2
b1fa332a11 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
8fa1fa5bb1 Merge pull request \fI\%#42155\fP from phsteve/doc\-fix\-puppet
.IP \(bu 2
fb2cb78a31 Fix docs for puppet.plugin_sync so code\-block renders properly and sync is spelled consistently
.UNINDENT
.UNINDENT
.IP \(bu 2
6307b9873f Merge pull request \fI\%#42176\fP from rallytime/bp\-42109
.INDENT 2.0
.IP \(bu 2
686926daf7 Update aws.rst \- add Debian default username
.UNINDENT
.IP \(bu 2
28c4e4c3b7 Merge pull request \fI\%#42095\fP from terminalmage/docker\-login\-debugging
.INDENT 2.0
.IP \(bu 2
bd27870a71 Add debug logging to dockerng.login
.UNINDENT
.IP \(bu 2
2b754bc5af Merge pull request \fI\%#42119\fP from terminalmage/issue42116
.INDENT 2.0
.IP \(bu 2
9a268949e3 Add integration test for 42116
.IP \(bu 2
1bb42bb609 Fix regression when CLI pillar override is used with salt\-call
.UNINDENT
.IP \(bu 2
8c0a83cbb5 Merge pull request \fI\%#42121\fP from terminalmage/issue42114
.INDENT 2.0
.IP \(bu 2
d14291267f Fix pillar.get when saltenv is passed
.UNINDENT
.IP \(bu 2
687992c240 Merge pull request \fI\%#42094\fP from terminalmage/quiet\-exception
.INDENT 2.0
.IP \(bu 2
47d61f4edf Prevent command from showing in exception when output_loglevel=quiet
.UNINDENT
.IP \(bu 2
dad255160c Merge pull request \fI\%#42163\fP from vutny/fix\-42115
.INDENT 2.0
.IP \(bu 2
b27b1e340a Fix \fI\%#42115\fP: parse libcloud \(dqrc\(dq version correctly
.UNINDENT
.IP \(bu 2
2a8ae2b3b6 Merge pull request \fI\%#42164\fP from Ch3LL/fix_kerb_doc
.INDENT 2.0
.IP \(bu 2
7c0fb248ec Fix kerberos create_keytab doc
.UNINDENT
.IP \(bu 2
678d4d4098 Merge pull request \fI\%#42141\fP from rallytime/bp\-42098
.INDENT 2.0
.IP \(bu 2
bd80243233 Change repo_ng to repo\-ng
.UNINDENT
.IP \(bu 2
c8afd7a3c9 Merge pull request \fI\%#42140\fP from rallytime/bp\-42097
.INDENT 2.0
.IP \(bu 2
9c4e132540 Import datetime
.IP \(bu 2
1435bf177e require large timediff for ipv6 warning
.UNINDENT
.IP \(bu 2
c239664c8b Merge pull request \fI\%#42142\fP from Ch3LL/change_builds
.INDENT 2.0
.IP \(bu 2
e1694af39c Update builds available for rc1
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42340\fP: (\fI\%isbm\fP) Bugfix: Jobs scheduled to run at a future time stay pending for Salt …
@ \fI2017\-07\-18 18:13:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
55b7a5cb4a Merge pull request \fI\%#42340\fP from isbm/isbm\-jobs\-scheduled\-in\-a\-future\-2017.7\-bsc1036125
.IP \(bu 2
774d204d65 Bugfix: Jobs scheduled to run at a future time stay pending for Salt minions (bsc#1036125)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42327\fP: (\fI\%mirceaulinic\fP) Default skip_verify to False
@ \fI2017\-07\-18 18:04:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
e72616c5f1 Merge pull request \fI\%#42327\fP from mirceaulinic/patch\-10
.IP \(bu 2
c830573a2c Trailing whitespaces
.IP \(bu 2
c83e6fc696 Default skip_verify to False
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42151\fP: (\fI\%sjorge\fP) Doc errors in jinja doc for develop branch (refs: \fI\%#42179\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42179\fP: (\fI\%rallytime\fP) Fix some documentation issues found in jinja filters doc topic
@ \fI2017\-07\-18 18:01:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
ba799b2831 Merge pull request \fI\%#42179\fP from rallytime/fix\-42151
.IP \(bu 2
798d29276e Add note about \(dqto_bytes\(dq jinja filter issues when using yaml_jinja renderer
.IP \(bu 2
1bbff572ab Fix some documentation issues found in jinja filters doc topic
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42076\fP: (\fI\%abulford\fP) dockerng.volume_present test looks as though it would cause a change (refs: \fI\%#42087\fP, \fI\%#42086\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42087\fP: (\fI\%abulford\fP) Make result=true if Docker volume already exists
@ \fI2017\-07\-17 18:41:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42086\fP: (\fI\%abulford\fP) Make result=true if Docker volume already exists (refs: \fI\%#42087\fP)
.IP \(bu 2
8dbb93851d Merge pull request \fI\%#42087\fP from redmatter/fix\-dockerng\-volume\-present\-result\-2017.7
.IP \(bu 2
2e1dc95500 Make result=true if Docker volume already exists
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42166\fP: (\fI\%sjorge\fP) [2017.7.0rc1] jinja filter network_hosts fails on large IPv6 networks (refs: \fI\%#42186\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42186\fP: (\fI\%rallytime\fP) Use long_range function for IPv6Network hosts() function
@ \fI2017\-07\-17 18:39:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
c84d6db548 Merge pull request \fI\%#42186\fP from rallytime/fix\-42166
.IP \(bu 2
b8bcc0d599 Add note to various network_hosts docs about long_run for IPv6 networks
.IP \(bu 2
11862743c2 Use long_range function for IPv6Network hosts() function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42210\fP: (\fI\%terminalmage\fP) Only pass a saltenv in orchestration if one was explicitly passed (2017.7)
@ \fI2017\-07\-17 18:22:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
e7b79e0fd2 Merge pull request \fI\%#42210\fP from terminalmage/issue40928\-2017.7
.IP \(bu 2
771ade5d73 Only pass a saltenv in orchestration if one was explicitly passed (2017.7)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42236\fP: (\fI\%mirceaulinic\fP) New option for napalm proxy/minion: provider
@ \fI2017\-07\-17 18:19:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
0e49021b0e Merge pull request \fI\%#42236\fP from cloudflare/napalm\-provider
.IP \(bu 2
1ac69bd737 Document the provider option and rearrange the doc
.IP \(bu 2
4bf4b14161 New option for napalm proxy/minion: provider
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42257\fP: (\fI\%twangboy\fP) Fix \fIunit.pillar.test_git\fP for Windows
@ \fI2017\-07\-17 17:51:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ec5bb1c2f Merge pull request \fI\%#42257\fP from twangboy/win_unit_pillar_test_git
.IP \(bu 2
45be32666a Add error\-handling function to shutil.rmtree
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42258\fP: (\fI\%twangboy\fP) Fix \fIunit.states.test_environ\fP for Windows
@ \fI2017\-07\-17 17:50:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
36395625c2 Merge pull request \fI\%#42258\fP from twangboy/win_unit_states_tests_environ
.IP \(bu 2
55b278c478 Mock the reg.read_value function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42265\fP: (\fI\%rallytime\fP) Gate boto_elb tests if proper version of moto isn\(aqt installed
@ \fI2017\-07\-17 17:47:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
894bdd2b19 Merge pull request \fI\%#42265\fP from rallytime/gate\-moto\-version
.IP \(bu 2
78cdee51d5 Gate boto_elb tests if proper version of moto isn\(aqt installed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42277\fP: (\fI\%twangboy\fP) Fix \fIunit.states.test_winrepo\fP for Windows
@ \fI2017\-07\-17 17:37:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
baf04f2a2d Merge pull request \fI\%#42277\fP from twangboy/win_unit_states_test_winrepo
.IP \(bu 2
ed89cd0b93 Use os.sep for path seps
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42309\fP: (\fI\%terminalmage\fP) Change \(dqTBD\(dq in versionadded to \(dq2017.7.0\(dq
@ \fI2017\-07\-17 17:11:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
be6b211683 Merge pull request \fI\%#42309\fP from terminalmage/fix\-versionadded
.IP \(bu 2
603f5b7de6 Change \(dqTBD\(dq in versionadded to \(dq2017.7.0\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42206\fP: (\fI\%rallytime\fP) [PY3] Fix test that is flaky in Python 3 (refs: \fI\%#42783\fP)
@ \fI2017\-07\-17 17:09:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
acd29f9b38 Merge pull request \fI\%#42206\fP from rallytime/fix\-flaky\-test
.IP \(bu 2
2be4865f48 [PY3] Fix test that is flaky in Python 3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42126\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-07\-17 17:07:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
8f1cb287cf Merge pull request \fI\%#42126\fP from rallytime/merge\-2017.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42078\fP: (\fI\%damon\-atkins\fP) pkg.install and pkg.remove fix version number input.
@ \fI2017\-07\-05 06:04:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
4780d7830a Merge pull request \fI\%#42078\fP from damon\-atkins/fix_convert_flt_str_version_on_cmd_line
.IP \(bu 2
09d37dd892 Fix comment typo
.IP \(bu 2
7167549425 Handle version=None  when converted to a string it becomes \(aqNone\(aq parm should default to empty string rather than None, it would fix better with existing code.
.IP \(bu 2
4fb2bb1856 Fix typo
.IP \(bu 2
cf55c3361c pkg.install and pkg.remove on the command line take number version numbers, store them within a float. However version is a string, to support versions numbers like 1.3.4
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42105\fP: (\fI\%Ch3LL\fP) Update releasecanddiate doc with new 2017.7.0rc1 Release
@ \fI2017\-07\-04 03:14:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
46d575acbc Merge pull request \fI\%#42105\fP from Ch3LL/update_rc
.IP \(bu 2
d4e7b91608 Update releasecanddiate doc with new 2017.7.0rc1 Release
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41885\fP: (\fI\%astronouth7303\fP) Recommended pip installation outdated? (refs: \fI\%#42099\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42099\fP: (\fI\%rallytime\fP) Remove references in docs to pip install salt\-cloud
@ \fI2017\-07\-03 22:13:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
d38548bbbd Merge pull request \fI\%#42099\fP from rallytime/fix\-41885
.IP \(bu 2
c2822e05ad Remove references in docs to pip install salt\-cloud
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42076\fP: (\fI\%abulford\fP) dockerng.volume_present test looks as though it would cause a change (refs: \fI\%#42087\fP, \fI\%#42086\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42086\fP: (\fI\%abulford\fP) Make result=true if Docker volume already exists (refs: \fI\%#42087\fP)
@ \fI2017\-07\-03 15:48:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
81d606a8cb Merge pull request \fI\%#42086\fP from redmatter/fix\-dockerng\-volume\-present\-result
.IP \(bu 2
8d549685a7 Make result=true if Docker volume already exists
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25842\fP: (\fI\%shikhartanwar\fP) Running salt\-minion as non\-root user to execute sudo commands always returns an error (refs: \fI\%#42021\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42021\fP: (\fI\%gtmanfred\fP) Set concurrent to True when running states with sudo
@ \fI2017\-06\-30 21:02:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
7160697123 Merge pull request \fI\%#42021\fP from gtmanfred/2016.11
.IP \(bu 2
26beb18aa5 Set concurrent to True when running states with sudo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42029\fP: (\fI\%terminalmage\fP) Mock socket.getaddrinfo in unit.utils.network_test.NetworkTestCase.test_host_to_ips
@ \fI2017\-06\-30 20:58:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
b784fbbdf8 Merge pull request \fI\%#42029\fP from terminalmage/host_to_ips
.IP \(bu 2
26f848e111 Mock socket.getaddrinfo in unit.utils.network_test.NetworkTestCase.test_host_to_ips
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42055\fP: (\fI\%dmurphy18\fP) Upgrade support for gnupg v2.1 and higher
@ \fI2017\-06\-30 20:54:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
e067020b9b Merge pull request \fI\%#42055\fP from dmurphy18/handle_gnupgv21
.IP \(bu 2
e20cea6350 Upgrade support for gnupg v2.1 and higher
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42048\fP: (\fI\%Ch3LL\fP) Add initial 2016.11.7 Release Notes
@ \fI2017\-06\-30 16:00:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
74ba2abc48 Merge pull request \fI\%#42048\fP from Ch3LL/add_11.7
.IP \(bu 2
1de5e008a0 Add initial 2016.11.7 Release Notes
.UNINDENT
.UNINDENT
.SS Salt 2017.7.3 Release Notes
.sp
Version 2017.7.3 is a bugfix release for \fI\%2017.7.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB501\fP
.IP \(bu 2
Total Issue References: \fB94\fP
.IP \(bu 2
Total PR References: \fB423\fP
.IP \(bu 2
Contributors: \fB86\fP (\fI\%3add3287\fP, \fI\%BenoitKnecht\fP, \fI\%Ch3LL\fP, \fI\%CorvinM\fP, \fI\%Da\-Juan\fP,
\fI\%DmitryKuzmenko\fP, \fI\%Giandom\fP, \fI\%The\-Loeki\fP, \fI\%UtahDave\fP, \fI\%adelcast\fP, \fI\%amendlik\fP, \fI\%angeloudy\fP,
\fI\%anlutro\fP, \fI\%arthurlogilab\fP, \fI\%basepi\fP, \fI\%benediktwerner\fP, \fI\%brejoc\fP, \fI\%cachedout\fP,
\fI\%campbellmc\fP, \fI\%chnrxn\fP, \fI\%clan\fP, \fI\%corywright\fP, \fI\%damon\-atkins\fP, \fI\%dincamihai\fP, \fI\%dmurphy18\fP,
\fI\%eliasp\fP, \fI\%eradman\fP, \fI\%forksaber\fP, \fI\%frogunder\fP, \fI\%gaborn57\fP, \fI\%garethgreenaway\fP, \fI\%golmaal\fP,
\fI\%gracinet\fP, \fI\%gtmanfred\fP, \fI\%haam3r\fP, \fI\%isbm\fP, \fI\%jettero\fP, \fI\%jf\fP, \fI\%jubrad\fP, \fI\%keesbos\fP,
\fI\%kris\-anderson\fP, \fI\%lomeroe\fP, \fI\%mateiw\fP, \fI\%mattLLVW\fP, \fI\%mephi42\fP, \fI\%mirceaulinic\fP, \fI\%mkurtak\fP,
\fI\%morganwillcock\fP, \fI\%msummers42\fP, \fI\%mtorromeo\fP, \fI\%multani\fP, \fI\%mvivaldi\fP, \fI\%mz\-bmcqueen\fP,
\fI\%nasenbaer13\fP, \fI\%nicholasmhughes\fP, \fI\%oarmstrong\fP, \fI\%pkruk\fP, \fI\%pratik705\fP, \fI\%psagers\fP,
\fI\%rallytime\fP, \fI\%rbjorklin\fP, \fI\%rcallphin\fP, \fI\%renner\fP, \fI\%rhoths\fP, \fI\%richardsimko\fP, \fI\%rklaren\fP,
\fI\%roaldnefs\fP, \fI\%s0undt3ch\fP, \fI\%samodid\fP, \fI\%skizunov\fP, \fI\%skjaro\fP, \fI\%steverweber\fP, \fI\%sumeetisp\fP,
\fI\%t0fik\fP, \fI\%techhat\fP, \fI\%terminalmage\fP, \fI\%timfreund\fP, \fI\%timka\fP, \fI\%tkwilliams\fP, \fI\%twangboy\fP,
\fI\%unthought\fP, \fI\%vernondcole\fP, \fI\%vutny\fP, \fI\%wedge\-jarrad\fP, \fI\%whytewolf\fP, \fI\%xuhcc\fP)
.UNINDENT
.SS Windows Changes
.SS \fI\%pkg\fP Execution Module\(ga
.sp
Significate changes (PR #43708 & #45390, damon\-atkins) have been made to the
pkg execution module. Users should test this release against their existing
package sls definition files.
.INDENT 0.0
.IP \(bu 2
\fI\%pkg.list_available\fP no longer
defaults to refreshing the winrepo meta database.
.IP \(bu 2
\fI\%pkg.install\fP without a \fBversion\fP
parameter no longer upgrades software if the software is already installed.
Use \fBpkg.install version=latest\fP (or simply use a \fI\%pkg.latest\fP state to get the old behavior.
.IP \(bu 2
\fI\%pkg.list_pkgs\fP now returns
multiple versions if software installed more than once.
.IP \(bu 2
\fI\%pkg.list_pkgs\fP now returns \fBNot
Found\fP when the version is not found instead of \fB(value not set)\fP which
matches the contents of the sls definitions.
.IP \(bu 2
\fI\%pkg.remove\fP will wait up to 3 seconds
(normally about a second) to detect changes in the registry after removing
software, improving reporting of version changes.
.IP \(bu 2
\fI\%pkg.remove\fP can remove \fBlatest\fP
software, if \fBlatest\fP is defined in sls definition.
.IP \(bu 2
Documentation was update for the execution module to match the style in new
versions, some corrections as well.
.IP \(bu 2
All install/remove commands are prefix with cmd.exe shell and cmdmod is
called with a command line string instead of a list. Some sls files in
saltstack/salt\-winrepo\-ng expected the commands to be prefixed with cmd.exe
(i.e. the use of \fB&\fP).
.IP \(bu 2
Some execution module functions results, now behave more like their
Unix/Linux versions.
.UNINDENT
.SS \fI\%cmd\fP Execution Module
.sp
Due to a difference in how Python\(aqs \fBsubprocess.Popen()\fP spawns processes on
Windows, passing the command as a list of arguments can result in problems.
This is because Windows\(aq \fICreateProcess\fP requires the command to be passed as a
single string. Therefore, \fBsubprocess\fP will attempt to re\-assemble the list
of arguments into as string. Some escaped characters and quotes can cause the
resulting string to be incorrectly\-assembled, resulting in a failure to execute
the command.
.sp
Salt now deals with these cases by joining the list of arguments correctly and
ensuring that the command is passed to \fBsubprocess.Popen()\fP as a string.
.SS Changelog for v2017.7.2..v2017.7.3
.sp
\fIGenerated at: 2018\-05\-26 21:36:50 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBISSUE\fP \fI\%#45743\fP: (\fI\%frogunder\fP) Multi\-master PKI not working on Py3 (refs: \fI\%#45755\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45755\fP: (\fI\%terminalmage\fP) salt.crypt: Ensure message is encoded before signing
@ \fI2018\-01\-29 19:04:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
1439da8d76 Merge pull request \fI\%#45755\fP from terminalmage/issue45743
.IP \(bu 2
8af1251c59 salt.crypt: Ensure message is encoded before signing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45700\fP: (\fI\%Ch3LL\fP) Add PRs to 2017.7.3 Release Notes
@ \fI2018\-01\-25 20:56:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
fe194d755f Merge pull request \fI\%#45700\fP from Ch3LL/7.3_rn
.IP \(bu 2
84c8216901 Add PRs to 2017.7.3 Release Notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45681\fP: (\fI\%damon\-atkins\fP) 2017.7.3 Release notes for Windows
@ \fI2018\-01\-25 15:13:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce41f6a6ee Merge pull request \fI\%#45681\fP from damon\-atkins/2017.7.3_win_release_notes
.IP \(bu 2
1d21f86228 Update 2017.7.3.rst
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45672\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45667\fP to 2017.7.3
@ \fI2018\-01\-25 14:04:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45667\fP: (\fI\%gtmanfred\fP) default to upgrading when refreshing on archlinux (refs: \fI\%#45672\fP)
.IP \(bu 2
2f303439b7 Merge pull request \fI\%#45672\fP from rallytime/bp\-45667
.IP \(bu 2
74bbaeb7ce we should default to upgrading when refreshing on archlinux
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45669\fP: (\fI\%rallytime\fP) Update man pages for 2017.7.3 release
@ \fI2018\-01\-24 21:04:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
23ff1264e0 Merge pull request \fI\%#45669\fP from rallytime/man\-pages\-2017.7.3
.IP \(bu 2
d31b41adeb Update man pages for 2017.7.3 release
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45666\fP: (\fI\%terminalmage\fP) Fix failing pkg integration tests for releases with no \(aq.\(aq
@ \fI2018\-01\-24 17:19:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
9a17405ba6 Merge pull request \fI\%#45666\fP from terminalmage/salt\-jenkins\-793
.IP \(bu 2
4a6ab729dd Fix failing pkg integration tests for releases with no \(aq.\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45664\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45452\fP to 2017.7.3
@ \fI2018\-01\-24 15:33:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45452\fP: (\fI\%adelcast\fP) opkg.py: make owner function return value, instead of iterator (refs: \fI\%#45664\fP)
.IP \(bu 2
0717f7a578 Merge pull request \fI\%#45664\fP from rallytime/bp\-45452
.IP \(bu 2
369720677b opkg.py: make owner function return value, instead of iterator
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45649\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45634\fP to 2017.7.3
@ \fI2018\-01\-24 14:59:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45634\fP: (\fI\%Ch3LL\fP) Add different service name for Mac 10.13 test (refs: \fI\%#45649\fP)
.IP \(bu 2
7934372b7b Merge pull request \fI\%#45649\fP from rallytime/bp\-45634
.IP \(bu 2
1c78fc23ea Add different service name for Mac 10.13 test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45654\fP: (\fI\%twangboy\fP) Merge forward \fI\%#45638\fP
@ \fI2018\-01\-24 14:59:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45638\fP: (\fI\%twangboy\fP) Win fix shell info (refs: \fI\%#45654\fP)
.IP \(bu 2
770f0c4664 Merge pull request \fI\%#45654\fP from twangboy/win_fix_shell_info_2017.7.3
.IP \(bu 2
5bb01aeb8c Merge forward \fI\%#45638\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45653\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45611\fP to 2017.7.3
@ \fI2018\-01\-24 05:20:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45611\fP: (\fI\%terminalmage\fP) Fix unnecessary/incorrect usage of six.binary_type (refs: \fI\%#45653\fP)
.IP \(bu 2
6fc293da46 Merge pull request \fI\%#45653\fP from rallytime/bp\-45611
.IP \(bu 2
0a6b06d8ea Fix unnecessary/incorrect usage of six.binary_type
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45642\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45636\fP to 2017.7.3
@ \fI2018\-01\-23 22:00:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45636\fP: (\fI\%Ch3LL\fP)  Fix mac service and pkg tests for 10.13 (refs: \fI\%#45642\fP)
.IP \(bu 2
0a07e0d259 Merge pull request \fI\%#45642\fP from rallytime/bp\-45636
.IP \(bu 2
df0ad54c9a remove unnecessary variable for test
.IP \(bu 2
acb14fd43d fix pylint
.IP \(bu 2
a9b12cd1ea Fix mac service and pkg tests for 10.13
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45645\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45606\fP to 2017.7.3
@ \fI2018\-01\-23 21:54:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45606\fP: (\fI\%terminalmage\fP) Fix bug affecting salt\-ssh when root_dir differs from the default (refs: \fI\%#45645\fP)
.IP \(bu 2
f37a5b6d8d Merge pull request \fI\%#45645\fP from rallytime/bp\-45606
.IP \(bu 2
d52d96f30a Fix bug affecting salt\-ssh when root_dir differs from the default
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45641\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45508\fP to 2017.7.3
@ \fI2018\-01\-23 21:18:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45508\fP: (\fI\%frogunder\fP) fix test_archive test for mac on 2017.7 branch (refs: \fI\%#45641\fP)
.IP \(bu 2
e659793c09 Merge pull request \fI\%#45641\fP from rallytime/bp\-45508
.IP \(bu 2
e6917a291e fix test_archive test for mac on 2017.7 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45604\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45582\fP to 2017.7.3
@ \fI2018\-01\-22 16:54:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45582\fP: (\fI\%terminalmage\fP) Two salt\-ssh fixes (refs: \fI\%#45604\fP)
.IP \(bu 2
ced3269ae8 Merge pull request \fI\%#45604\fP from rallytime/bp\-45582
.IP \(bu 2
bc8a450cc7 Remove state.py utils file from thin list
.IP \(bu 2
629e6c9674 Further fixes to for salt\-ssh test under heavy load
.IP \(bu 2
0dff596b59 Add salt/utils/state.py to thin tarball
.IP \(bu 2
a61afda100 Pass on OSError if thin tarball already removed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45591\fP: (\fI\%gtmanfred\fP) mark minion_blackout tests as flaky
@ \fI2018\-01\-22 00:14:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
4672baa6c8 Merge pull request \fI\%#45591\fP from gtmanfred/2017.7.3
.IP \(bu 2
f7fd35fc4a test updating the minion blackout timeout to 10 seconds
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45585\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45579\fP to 2017.7.3
@ \fI2018\-01\-22 00:13:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45579\fP: (\fI\%terminalmage\fP) Test suite stability fixes (refs: \fI\%#45585\fP)
.IP \(bu 2
2a992f9017 Merge pull request \fI\%#45585\fP from rallytime/bp\-45579
.IP \(bu 2
0292c8345b Lint fix: use six\(aqs map
.IP \(bu 2
108d8cbeef Use correct utils path for 2017.7
.IP \(bu 2
a38f4cb6d6 Restrict pyzmq optimizations to pyzmq >= 14.3.0
.IP \(bu 2
58ad558346 Fix event unpack
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45573\fP: (\fI\%gtmanfred\fP) update 2017.7.3 tests
@ \fI2018\-01\-20 20:05:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
19cd97ed3b Merge pull request \fI\%#45573\fP from gtmanfred/2017.7.3
.IP \(bu 2
bd3cb47fa7 fix mock for opensuse
.IP \(bu 2
808e26e69a test simple website
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45570\fP: (\fI\%gtmanfred\fP) Fix tests for 2017.7.3
@ \fI2018\-01\-20 15:01:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
e72d81ef22 Merge pull request \fI\%#45570\fP from gtmanfred/2017.7.3
.IP \(bu 2
1f71f301ba specify checking man page path
.IP \(bu 2
2ddbcb45c1 fix pkg_resources for usage with testing pip
.IP \(bu 2
0ba39a7108 switch systemd\-journald for sshd for arch service test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45538\fP: (\fI\%gtmanfred\fP) Backport test fixes to 2017.7.3
@ \fI2018\-01\-19 14:39:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
7bc60c56d4 Merge pull request \fI\%#45538\fP from gtmanfred/2017.7.3
.IP \(bu 2
801e0639b6 Merge branch \(aq2017.7.3\(aq into 2017.7.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45533\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45529\fP to 2017.7.3
@ \fI2018\-01\-18 22:52:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45529\fP: (\fI\%Ch3LL\fP) Fix UnboundLocalError for pacman pkg installs (refs: \fI\%#45533\fP)
.IP \(bu 2
8ad65e3359 Merge pull request \fI\%#45533\fP from rallytime/bp\-45529
.IP \(bu 2
6d56c64d88 Fix UnboundLocalError for pacman pkg installs
.INDENT 2.0
.IP \(bu 2
8d907ee1a0 fix moto version
.IP \(bu 2
1241ab5fc6 fix test boto imports
.IP \(bu 2
f4b6367cf9 fix fedora pkg test
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45394\fP: (\fI\%dmurphy18\fP) git.latest fails when \(dqdepth\(dq  is used with a non\-default branch (refs: \fI\%#45399\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45442\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45399\fP to 2017.7.3
@ \fI2018\-01\-17 17:20:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45399\fP: (\fI\%terminalmage\fP) Fix git.latest failure when rev is not the default branch (refs: \fI\%#45442\fP)
.IP \(bu 2
7379f9e3e5 Merge pull request \fI\%#45442\fP from rallytime/bp\-45399
.IP \(bu 2
590a6db626 Lint: use support TMP path instead of integration TMP path
.IP \(bu 2
c081b2c62c Fix git.latest failure when rev is not the default branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45468\fP: (\fI\%twangboy\fP) Fix some issues with reg.py
@ \fI2018\-01\-16 22:23:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
ee5090f69b Merge pull request \fI\%#45468\fP from twangboy/win_reg
.IP \(bu 2
a0d21c6354 Fix some issues with reg.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44913\fP: (\fI\%ari\fP) FreeBSD packaging install performance regression (refs: \fI\%#45174\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45434\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45174\fP to 2017.7.3
@ \fI2018\-01\-14 12:43:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45174\fP: (\fI\%eradman\fP) Do not force pkg reinstall on FreeBSD (refs: \fI\%#45434\fP)
.IP \(bu 2
ef7a896eb6 Merge pull request \fI\%#45434\fP from rallytime/bp\-45174
.IP \(bu 2
b310ff7ab8 Do not force pkg reinstall on FreeBSD
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45395\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45380\fP to 2017.7.3
@ \fI2018\-01\-12 18:49:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45380\fP: (\fI\%twangboy\fP) Backport changes from \fI\%#45308\fP (refs: \fI\%#45395\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45308\fP: (\fI\%twangboy\fP) Fix \fIintegration.modules.test_state\fP for Windows (refs: \fI\%#45380\fP)
.IP \(bu 2
c3fdd1dcc4 Merge pull request \fI\%#45395\fP from rallytime/bp\-45380
.IP \(bu 2
0356b3d56f Backport changes from \fI\%#45308\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44107\fP: (\fI\%anlutro\fP) salt\-ssh 2017.7 doesn\(aqt work with Python 3, missing backports_abc (refs: \fI\%#45294\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45294\fP: (\fI\%gtmanfred\fP) include backports_abc
@ \fI2018\-01\-11 18:18:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
f7da716d32 Merge pull request \fI\%#45294\fP from gtmanfred/2017.7
.IP \(bu 2
3633ceeaa7 Merge branch \(aq2017.7\(aq into 2017.7
.IP \(bu 2
29806e4496 ignore salt.ext in pylint
.IP \(bu 2
8b597a4890 include backports_abc
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43130\fP: (\fI\%boltronics\fP) module.run documentation issues (refs: \fI\%#45381\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45381\fP: (\fI\%gtmanfred\fP) fix module.run docs
@ \fI2018\-01\-11 18:02:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
f77a3e9cd4 Merge pull request \fI\%#45381\fP from gtmanfred/module.run
.IP \(bu 2
230e899192 fix module.run docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43995\fP: (\fI\%dragonpaw\fP) Using zmq built with \-\-enable\-draft breaks Salt (refs: \fI\%#45368\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45368\fP: (\fI\%DmitryKuzmenko\fP) Fixes to work with pyzmq with \-\-enable\-drafts
@ \fI2018\-01\-11 17:53:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
8efd29f4d9 Merge pull request \fI\%#45368\fP from DSRCorporation/bugs/zmq_draft
.IP \(bu 2
7622e355cf Minor: removed a stale comment.
.IP \(bu 2
00f31bf9b5 Fixes to work with pyzmq with \-\-enable\-drafts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45371\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45158\fP to 2017.7
@ \fI2018\-01\-11 17:51:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45158\fP: (\fI\%terminalmage\fP) Fix integration.modules.test_state.StateModuleTest.test_exclude (refs: \fI\%#45371\fP)
.IP \(bu 2
22c3efda06 Merge pull request \fI\%#45371\fP from rallytime/bp\-45158
.IP \(bu 2
3565bc2bf2 Don\(aqt use include\-test SLS in orch tests
.IP \(bu 2
8bc17e0d7a Fix integration.modules.test_state.StateModuleTest.test_exclude
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45387\fP: (\fI\%renner\fP) Set SHELL environment variable
@ \fI2018\-01\-11 16:23:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40630\fP: (\fI\%mateiw\fP) develop: SUSE specific changes to salt\-api.service (refs: \fI\%#45387\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40620\fP: (\fI\%mateiw\fP) SUSE specific changes to salt\-api.service (refs: \fI\%#40630\fP, \fI\%#45387\fP)
.IP \(bu 2
3a0e2de995 Merge pull request \fI\%#45387\fP from renner/patch\-2
.IP \(bu 2
530ddd2d29 Set SHELL environment variable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45388\fP: (\fI\%terminalmage\fP) Fix loader error in 2017.7 tests
@ \fI2018\-01\-11 16:13:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
dcf98a2260 Merge pull request \fI\%#45388\fP from terminalmage/fix\-test\-loader\-error
.IP \(bu 2
5473c085d9 Fix loader error in 2017.7 tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45382\fP: (\fI\%terminalmage\fP) Skip flaky test on 2017.7 branch
@ \fI2018\-01\-11 14:23:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
d15f9e1020 Merge pull request \fI\%#45382\fP from terminalmage/salt\-jenkins\-686
.IP \(bu 2
ff3039db6c Skip flaky test on 2017.7 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45369\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2018\-01\-10 22:14:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
dbe21b2c0d Merge pull request \fI\%#45369\fP from rallytime/merge\-2017.7
.IP \(bu 2
f65e091df8 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
0959ae4ea3 Merge pull request \fI\%#45327\fP from lomeroe/bp\-44861_2016.11
.INDENT 2.0
.IP \(bu 2
784139f734 Check for values other than 0 or 1
.UNINDENT
.IP \(bu 2
a6db5f95f0 Merge pull request \fI\%#45268\fP from damon\-atkins/2016.11_win_pkg_pkg_install_latest
.INDENT 2.0
.IP \(bu 2
325a9f0f66 Update 2016.11.9.rst
.IP \(bu 2
4da9200b9c Update 2016.11.9.rst
.IP \(bu 2
126aee36ac Update 2016.11.9.rst
.IP \(bu 2
1c01967943 Update 2016.11.9.rst
.IP \(bu 2
a0d89882b8 Fix pkg.install packagename version=latest i.e. if on an old version upgrade to the latest
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45379\fP: (\fI\%rhoths\fP) Minor spelling/grammar fixes in the highstate returner documentation
@ \fI2018\-01\-10 20:09:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
55979b3a48 Merge pull request \fI\%#45379\fP from rhoths/rhoths\-doc\-highstate\-1
.IP \(bu 2
afbbd492cd Minor spelling/grammar fixes in highstate returner
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45358\fP: (\fI\%UtahDave\fP) gate the minion data cache refresh events.
@ \fI2018\-01\-10 17:21:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45299\fP: (\fI\%garethgreenaway\fP) [2017.7] config gate auth_events (refs: \fI\%#45358\fP)
.IP \(bu 2
541e59fa75 Merge pull request \fI\%#45358\fP from UtahDave/gate_data_cache_refresh
.IP \(bu 2
379b6cd23e should be \fIself\fP, not \fIsalt\fP
.IP \(bu 2
a82e158f2d gate the minion data cache refresh events.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45297\fP: (\fI\%Ch3LL\fP) Allow macosx service state tests to check for pid return
@ \fI2018\-01\-09 20:47:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb87010461 Merge pull request \fI\%#45297\fP from Ch3LL/mac_service_state
.IP \(bu 2
4e569b5802 Allow macosx service state tests to check for pid return
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45351\fP: (\fI\%dmurphy18\fP) Update debbuild to explicitly include source code for Debian, Ubuntu
@ \fI2018\-01\-09 17:21:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
beedf6e815 Merge pull request \fI\%#45351\fP from dmurphy18/upd_debbuild
.IP \(bu 2
478dc70092 Update debbuild flags
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45299\fP: (\fI\%garethgreenaway\fP) [2017.7] config gate auth_events (refs: \fI\%#45358\fP)
@ \fI2018\-01\-09 15:00:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
66da9b47bc Merge pull request \fI\%#45299\fP from garethgreenaway/config_gate_auth_events
.IP \(bu 2
9a15ec3430 Updating versionadded string.  Fixing typo.
.IP \(bu 2
edfc3dc078 Adding in documentation for \fIauth_events\fP configuration option
.IP \(bu 2
3ee4eabffd Fixing small typo
.IP \(bu 2
6a28bddcc9 Adding some code to config gate if auth_events are sent
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44856\fP: (\fI\%Ch3LL\fP) Add state.running ssh integration test
@ \fI2018\-01\-08 21:40:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
8d04c2b3d4 Merge pull request \fI\%#44856\fP from Ch3LL/running_test
.IP \(bu 2
9a35a73711 add time limit to while loop
.IP \(bu 2
aeb5f4e248 Add state.running ssh integration test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#675\fP: (\fI\%rallytime\fP) [2017.7] unit.states.test_file.TestFileState.test_directory
is failing on Fedora 27 and CentOS 6 (refs: \fI\%#45295\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45295\fP: (\fI\%gtmanfred\fP) test directory that doesn\(aqt exist
@ \fI2018\-01\-08 20:59:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0e5e70277 Merge pull request \fI\%#45295\fP from gtmanfred/test_directory
.IP \(bu 2
e6178fe6d4 Merge branch \(aq2017.7\(aq into test_directory
.IP \(bu 2
24114e91c1 test was different slightly on 2017.7
.IP \(bu 2
d20fc93625 test directory that doesn\(aqt exist
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#678\fP: (\fI\%rallytime\fP) [2017.7] Proxy Minion Tests for Py3 are failing (refs: \fI\%#45302\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45302\fP: (\fI\%gtmanfred\fP) fix proxy tests for py3 on 2017.7
@ \fI2018\-01\-08 17:41:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
f49b204b75 Merge pull request \fI\%#45302\fP from gtmanfred/proxyp3
.IP \(bu 2
b295ec0429 make dummy proxy module py3 compatible
.IP \(bu 2
8736e21f65 fix starting proxy minion on py3
.IP \(bu 2
e2824a7253 fix py3 tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45279\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2018\-01\-08 17:26:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
eea7158e82 Merge pull request \fI\%#45279\fP from rallytime/merge\-2017.7
.IP \(bu 2
8025b14584 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
1c5e905b61 Merge pull request \fI\%#45256\fP from rallytime/bp\-45034
.INDENT 2.0
.IP \(bu 2
68f971b38f Apply test fixes from \fI\%#45034\fP to parsers_test.py
.IP \(bu 2
9454236694 Fix for pidfile removal logging
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44853\fP: (\fI\%gtmanfred\fP) remove not from vault utils
@ \fI2018\-01\-05 17:43:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
dab4a8cff3 Merge pull request \fI\%#44853\fP from gtmanfred/vault
.IP \(bu 2
bfee1cead6 set role for loading minion config
.IP \(bu 2
c5af2e5048 if utils is not loaded, load it
.IP \(bu 2
6a5e0f9ac1 remove not from vault utils
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45277\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45025\fP to 2017.7
@ \fI2018\-01\-05 15:35:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45025\fP: (\fI\%steverweber\fP) Fix pillar include merge order (refs: \fI\%#45277\fP)
.IP \(bu 2
f09d0e5fdb Merge pull request \fI\%#45277\fP from rallytime/bp\-45025
.IP \(bu 2
942c14bb29 pillar body overrides includes
.IP \(bu 2
1152202fdc fix pillar includes from merging over the current sls defines
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45276\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45260\fP to 2017.7
@ \fI2018\-01\-05 14:45:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45260\fP: (\fI\%gtmanfred\fP) Make some kitchen\-salt tests blue (refs: \fI\%#45276\fP)
.IP \(bu 2
fc84f1104f Merge pull request \fI\%#45276\fP from rallytime/bp\-45260
.IP \(bu 2
9ab1af738f switch kitchen\-salt to use rsync transport to preserve symlinks
.IP \(bu 2
cf98ed472e fix up symlinks
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43340\fP: (\fI\%syphernl\fP) Upgrading Salt via Salt results in dying minions and broken dpkg (refs: \fI\%#45255\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45255\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44427\fP to 2017.7
@ \fI2018\-01\-04 21:46:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44427\fP: (\fI\%samodid\fP) use KillMode=process for salt\-minion.service (refs: \fI\%#45255\fP)
.IP \(bu 2
ff9880c498 Merge pull request \fI\%#45255\fP from rallytime/bp\-44427
.IP \(bu 2
6ceafbbf3a use KillMode=process for salt\-minion.service
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23454\fP: (\fI\%HontoNoRoger\fP) SLS rendering error with Salt\-SSH (pydsl) (refs: \fI\%#45251\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45251\fP: (\fI\%forksaber\fP) Fix \fI\%#23454\fP : make pydsl work with salt\-ssh
@ \fI2018\-01\-04 21:33:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
e715eb603f Merge pull request \fI\%#45251\fP from forksaber/salt\-ssh\-pydsl
.IP \(bu 2
b3660d5190 [\fI\%#23454\fP] make pydsl work with salt\-ssh
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45254\fP: (\fI\%Ch3LL\fP) Add darwin value for ssh grain items tests on MacOSX
@ \fI2018\-01\-04 21:31:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
2934b60d53 Merge pull request \fI\%#45254\fP from Ch3LL/fix_mac_grain_ssh
.IP \(bu 2
b4b59b89cd remove platform from salt.utils call for 2017.7
.IP \(bu 2
85e853a63d Add darwin value for ssh grain items tests on MacOSX
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45135\fP: (\fI\%twangboy\fP) Fix win_dacl problems with SIDs
@ \fI2018\-01\-04 21:01:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
af2d880303 Merge pull request \fI\%#45135\fP from twangboy/win_fix_dacl
.IP \(bu 2
b31e08946a Merge branch \(aq2017.7\(aq into win_fix_dacl
.IP \(bu 2
35a417f510 Fix win_dacl problems with SIDs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43806\fP: (\fI\%Ch3LL\fP) Add spm man Test to Auto Test Suite (refs: \fI\%#44930\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44930\fP: (\fI\%frogunder\fP) man_spm_test
@ \fI2018\-01\-04 20:58:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0a3770035 Merge pull request \fI\%#44930\fP from frogunder/man_spm
.IP \(bu 2
48e6953e1f fix_string_error
.IP \(bu 2
c9fa4ed2a7 man_spm_test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45259\fP: (\fI\%Ch3LL\fP) Fix MacOSX Service Status Check and integration test
@ \fI2018\-01\-04 14:25:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
543eebf411 Merge pull request \fI\%#45259\fP from Ch3LL/fix\-mac\-service\-test
.IP \(bu 2
74e6ed60ea Fix MacOSX Service Status Check and integration test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45263\fP: (\fI\%sumeetisp\fP) Updating python version for 2017.7
@ \fI2018\-01\-04 14:16:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
bbbd1872a7 Merge pull request \fI\%#45263\fP from sumeetisp/2017.7
.IP \(bu 2
e3a5ee3a08 Merge branch \(aq2017.7\(aq into 2017.7
.IP \(bu 2
71aea9a3bc Merge pull request #1 from sumeetisp/sumeetisp\-python\-version
.INDENT 2.0
.IP \(bu 2
1b4806e2b9 Updating python version
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45244\fP: (\fI\%twangboy\fP) Fix search/replace in Py3
@ \fI2018\-01\-04 14:02:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
d46e1197be Merge pull request \fI\%#45244\fP from twangboy/win_fix_portable.py
.IP \(bu 2
e3a8279c01 Get path to python binary based on executable
.IP \(bu 2
03aec37040 Fix search/replace in Py3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45233\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2018\-01\-03 15:34:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
eba360870a Merge pull request \fI\%#45233\fP from rallytime/merge\-2017.7
.IP \(bu 2
a3d251b2cd Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
b75f50afe3 Merge pull request \fI\%#45235\fP from rallytime/bp\-45209
.INDENT 2.0
.IP \(bu 2
2d0a9bbf7e enable UsePAM for ssh tests
.UNINDENT
.UNINDENT
.IP \(bu 2
5d9a1e91e9 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
3ab962b01a Merge pull request \fI\%#44965\fP from gtmanfred/2016.11
.INDENT 2.0
.IP \(bu 2
a5d8a6340e check if VALUE is a string_type
.UNINDENT
.IP \(bu 2
40fb30f63f Merge pull request \fI\%#45232\fP from rasathus/2016.11
.INDENT 2.0
.IP \(bu 2
7a2bd8f49b Merge branch \(aq2016.11\(aq into 2016.11
.IP \(bu 2
de53c45c29 Backport \fI\%#27160\fP to 2016.11
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45175\fP: (\fI\%amendlik\fP) Pkg uptodate
@ \fI2018\-01\-02 17:38:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
693cc807e8 Merge pull request \fI\%#45175\fP from amendlik/pkg\-uptodate
.IP \(bu 2
4f514a29a7 Merge branch \(aq2017.7\(aq into pkg\-uptodate
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45226\fP: (\fI\%gtmanfred\fP) Update kitchen to use runtests verifier on 2017.7
@ \fI2017\-12\-31 18:13:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
1b3f3ba1be Merge pull request \fI\%#45226\fP from gtmanfred/2017.7
.IP \(bu 2
4f3b089e0e fix copying back
.IP \(bu 2
f56f062a6a download xml for junit
.IP \(bu 2
7cc342a5d6 use new runtests verifier
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45221\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-12\-30 18:08:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
7d3a6cbc65 Merge pull request \fI\%#45221\fP from rallytime/merge\-2017.7
.IP \(bu 2
508599e159 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
707ef55175 Merge pull request \fI\%#45161\fP from lomeroe/bp\-44944_2016.11
.INDENT 2.0
.IP \(bu 2
0a4c6b5a83 remove references to six.unichr
.IP \(bu 2
f3196d795d lint fixes for static regexes
.IP \(bu 2
11b637d108 lint fixes
.IP \(bu 2
c14d6282ad do not decode registry.pol file wholesale, but instead decode individual elements of the file
.UNINDENT
.IP \(bu 2
6f52034e08 Merge pull request \fI\%#45199\fP from gtmanfred/status
.INDENT 2.0
.IP \(bu 2
fb07f9ea7d status.pid returns pid ids not process names
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45176\fP: (\fI\%thuhak\fP) osquery execution module does\(aqt work with attrs parameter (refs: \fI\%#45204\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45204\fP: (\fI\%garethgreenaway\fP) [2017.7] Fixes to osquery module & addition of unit tests
@ \fI2017\-12\-30 13:25:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
abed378981 Merge pull request \fI\%#45204\fP from garethgreenaway/45176_fixes_to_osquery_module
.IP \(bu 2
dc933e9e24 Fixing typo
.IP \(bu 2
d834bd1b6f Fixing some minor lint issues.
.IP \(bu 2
4738205154 Fixing a bug when attributes are passed to various osquery module functions.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
66884334d9 Update states.pkg for Python3 compatibility
.IP \(bu 2
2a7d76ad6e Fail pkg.uptodate if expected packages are not upgraded
.IP \(bu 2
29ef67bac2 Test pkg.uptodate with failed upgrades
.IP \(bu 2
23ab93353b Produce changes dict for pkg.uptodate dry\-run mode
.IP \(bu 2
7c67ec39d9 Add tests for pkg.uptodate state
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45203\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-12\-29 01:11:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
5991d8ca15 Merge pull request \fI\%#45203\fP from rallytime/merge\-2017.7
.IP \(bu 2
430c913c8c Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
d3381e27d0 Merge pull request \fI\%#45118\fP from garethgreenaway/44728_nodegroups_seq
.INDENT 2.0
.IP \(bu 2
0ff811de70 Swapping import to be the old path for 2016.11
.IP \(bu 2
b3e2f388f5 Fix to allow nodegroups to include sequences
.UNINDENT
.IP \(bu 2
f969aca3a3 Merge pull request \fI\%#45127\fP from twangboy/win_fix_pkg
.INDENT 2.0
.IP \(bu 2
14639739f2 Fix issue with 1641 return code
.UNINDENT
.IP \(bu 2
dc357b39f0 Merge pull request \fI\%#45137\fP from twangboy/win_fix_reg_tests
.INDENT 2.0
.IP \(bu 2
b6f4ef8d73 Catch correct error type in list_keys and list_values
.UNINDENT
.IP \(bu 2
0aa1662731 Merge pull request \fI\%#45130\fP from rallytime/api\-groups
.INDENT 2.0
.IP \(bu 2
2dcc8df845 Resolve groups for salt api
.UNINDENT
.IP \(bu 2
7dc3cc4641 Merge pull request \fI\%#45114\fP from twangboy/win_fix_pam
.INDENT 2.0
.IP \(bu 2
cf5eae1f77 Move pam library load to try/except block
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45201\fP: (\fI\%rallytime\fP) [2017.7] Check for running on python3 before decoding bytes
@ \fI2017\-12\-28 22:59:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45090\fP: (\fI\%angeloudy\fP) fix TypeError in python 3 (refs: \fI\%#45201\fP)
.IP \(bu 2
882267314f Merge pull request \fI\%#45201\fP from rallytime/fix\-jinja\-template\-test\-failure
.IP \(bu 2
b4af3bdff8 Check for running on python3 before decoding bytes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45200\fP: (\fI\%rallytime\fP) [2017.7] Fix docstring integration test failure
@ \fI2017\-12\-28 22:58:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44552\fP: (\fI\%Da\-Juan\fP) pip_state: Check if available upgrades fulfill version requirements. (refs: \fI\%#45200\fP)
.IP \(bu 2
2e18398f12 Merge pull request \fI\%#45200\fP from rallytime/fix\-docstring\-test\-failure
.IP \(bu 2
a26d4795bd [2017.7] Fix docstring integration test failure
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45186\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44922\fP to 2017.7
@ \fI2017\-12\-28 19:02:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44922\fP: (\fI\%dincamihai\fP) Fix salt\-master for old psutil (refs: \fI\%#45186\fP)
.IP \(bu 2
67d97303b5 Merge pull request \fI\%#45186\fP from rallytime/bp\-44922
.IP \(bu 2
6970fe8103 Fix salt\-master for old psutil
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44624\fP: (\fI\%eliasp\fP) Fix Traceback when using the \fIservice.enabled\fP state on non\-booted systems
@ \fI2017\-12\-28 10:58:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
30d7f7257a Merge pull request \fI\%#44624\fP from eliasp/fix\-upstart\-utmp\-exception
.IP \(bu 2
43d44e051a Do not blindly assume presence of either \fI/var/run/utmp\fP or \fI/run/utmp\fP, none of both might be available (e.g. on non\-booted systems).
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45183\fP: (\fI\%twangboy\fP) Add libnacl dependency
@ \fI2017\-12\-27 22:08:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
3832e7b227 Merge pull request \fI\%#45183\fP from twangboy/win_add_libnacl_2017.7
.IP \(bu 2
b46845888d Add libnacl dependency
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44928\fP: (\fI\%rcallphin\fP) Duplicating master token when no match for Minion policy (Vault Module) (refs: \fI\%#44966\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44966\fP: (\fI\%rcallphin\fP) Fix bug with vault runner creating token on empty policy
@ \fI2017\-12\-22 20:30:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
fbbf33574e Merge pull request \fI\%#44966\fP from rcallphin/fix\-bug\-vault\-empty\-policy
.IP \(bu 2
7f327ab760 Lint: Remove extra whitespace
.IP \(bu 2
04ab6a5e9d Merge branch \(aq2017.7\(aq into fix\-bug\-vault\-empty\-policy
.IP \(bu 2
5be463bb46 Merge branch \(aq2017.7\(aq into fix\-bug\-vault\-empty\-policy
.IP \(bu 2
48d9cc3674 Fix bug with vault runner creating token on empty policy
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44552\fP: (\fI\%Da\-Juan\fP) pip_state: Check if available upgrades fulfill version requirements. (refs: \fI\%#45200\fP)
@ \fI2017\-12\-22 19:25:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
487207f61d Merge pull request \fI\%#44552\fP from Da\-Juan/avoid_unneeded_pip_install
.IP \(bu 2
49a6a8f02e Merge branch \(aq2017.7\(aq into avoid_unneeded_pip_install
.IP \(bu 2
3a8e62493d pip_state: Check if available upgrades fulfill version requirements
.IP \(bu 2
62252d74d9 pip_state: Compare versions using pkg_resources.parse_version
.IP \(bu 2
5219ab974c Add list_all_versions function to pip module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45090\fP: (\fI\%angeloudy\fP) fix TypeError in python 3 (refs: \fI\%#45201\fP)
@ \fI2017\-12\-22 18:11:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
5ae26f0c09 Merge pull request \fI\%#45090\fP from angeloudy/2017.7
.IP \(bu 2
cf411f8984 Merge branch \(aq2017.7\(aq into 2017.7
.IP \(bu 2
177fd18671 fix TypeError in python 3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44315\fP: (\fI\%whytewolf\fP) cmd.* cwd does not escape spaces. 2017.7.2 (refs: \fI\%#45134\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45134\fP: (\fI\%garethgreenaway\fP) [2017.7] fix to cmd.script for cwd with space
@ \fI2017\-12\-22 15:31:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
a1946730a9 Merge pull request \fI\%#45134\fP from garethgreenaway/44315_cmd_script_cwd_with_space
.IP \(bu 2
48eafe3206 Adding some tests to tests cmd.script with cwd
.IP \(bu 2
8dfcf71b08 Adding _cmd_quote to handle cases when the current working directory for cmd.script might have a space in it.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44964\fP: (\fI\%Giandom\fP) added\-highstate\-output\-to\-slack\-engine
@ \fI2017\-12\-21 21:32:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
f41adfc913 Merge pull request \fI\%#44964\fP from Giandom/2017.7\-added\-highstate\-output\-to\-slack\-engine
.IP \(bu 2
4526c158f1 added\-highstate\-output\-to\-slack\-engine
.IP \(bu 2
573a0a4143 added\-highstate\-output\-to\-slack\-engine
.IP \(bu 2
9a6e03ce6e added\-highstate\-output\-to\-slack\-engine
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45124\fP: (\fI\%gtmanfred\fP) enable using kitchen\-salt with ec2 on 2017.7
@ \fI2017\-12\-21 19:11:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
b49ee97938 Merge pull request \fI\%#45124\fP from gtmanfred/2017.7
.IP \(bu 2
d0586013eb fix pylint
.IP \(bu 2
59e2e56d13 chmod the xml files before trying to copy
.IP \(bu 2
a5c1410e23 catch IOError when copying xml files back
.IP \(bu 2
23bd38ad66 enable using kitchen\-salt on ec2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45087\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-12\-20 22:24:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
42e894570d Merge pull request \fI\%#45087\fP from rallytime/merge\-2017.7
.IP \(bu 2
fe81e2d39a Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
7e128e8f15 Merge pull request \fI\%#45100\fP from rallytime/bp\-45070
.INDENT 2.0
.IP \(bu 2
0bdb46dab9 add clouds modules to index
.UNINDENT
.IP \(bu 2
bdf93f339d Merge pull request \fI\%#45098\fP from rallytime/bp\-45092
.INDENT 2.0
.IP \(bu 2
80b6bd6813 Fix integration.states.test_pip.PipStateTest.test_pip_installed_weird_install
.UNINDENT
.UNINDENT
.IP \(bu 2
4f21a2bbfd Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
324b7d4058 Merge pull request \fI\%#44078\fP from rossengeorgiev/fix\-41044
.INDENT 2.0
.IP \(bu 2
a81a6fe23c fix \fI\%#41044\fP; allow for date param to be 0
.UNINDENT
.IP \(bu 2
48a59761df Merge pull request \fI\%#44970\fP from rallytime/update\-bootstrap\-script
.INDENT 2.0
.IP \(bu 2
b2c8057427 Update bootstrap script to latest release: 2017.12.13
.UNINDENT
.IP \(bu 2
637fdaed58 Merge pull request \fI\%#45069\fP from rallytime/bp\-45040
.INDENT 2.0
.IP \(bu 2
aa438e1605 Installation Fails on headless machines.
.UNINDENT
.IP \(bu 2
4d6d640381 Merge pull request \fI\%#44969\fP from rallytime/bp\-41305
.INDENT 2.0
.IP \(bu 2
5c4bee43dc correct accept_vpc_peering_connection
.UNINDENT
.IP \(bu 2
10de468f13 Merge pull request \fI\%#45031\fP from terminalmage/fix\-mysql\-returner
.INDENT 2.0
.IP \(bu 2
f3bd12c27c Fix invalid exception class in mysql returner
.UNINDENT
.IP \(bu 2
9a7406207f Merge pull request \fI\%#44972\fP from terminalmage/bp\-44958
.INDENT 2.0
.IP \(bu 2
a416bf0112 No need to manually do connect_pub, use listen=True in run_job
.IP \(bu 2
3ec004bd2e Fix a race condition in manage runner
.UNINDENT
.IP \(bu 2
1032ca3290 Merge pull request \fI\%#44385\fP from gtmanfred/schedule
.INDENT 2.0
.IP \(bu 2
9e15c38da2 add comma
.IP \(bu 2
855d933cb7 schedule should be a dict
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45112\fP: (\fI\%Ch3LL\fP) Fix spm big file build test to check /tmp
@ \fI2017\-12\-20 22:09:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
9550e742ac Merge pull request \fI\%#45112\fP from Ch3LL/fix\-arch
.IP \(bu 2
1bd7110a14 Fix spm big file build test to check /tmp
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44303\fP: (\fI\%mwerickso\fP) boto3_route53 module times out on retries (refs: \fI\%#44976\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45068\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44976\fP to 2017.7
@ \fI2017\-12\-20 16:31:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44976\fP: (\fI\%tkwilliams\fP) Fix bad variable name in boto3_route53 module \- resolves \fI\%#44303\fP (refs: \fI\%#45068\fP)
.IP \(bu 2
71f9c7ee49 Merge pull request \fI\%#45068\fP from rallytime/bp\-44976
.IP \(bu 2
0ca0f37805 44303 \- resolves \fI\%#44303\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44961\fP: (\fI\%golmaal\fP) The archive tar function fails to untar file when dest argument is passed (refs: \fI\%#44983\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45099\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44983\fP to 2017.7
@ \fI2017\-12\-20 14:41:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44983\fP: (\fI\%golmaal\fP) Ref:44961 \- Modified archive.tar to add dest at the end of the tar cmd (refs: \fI\%#45099\fP)
.IP \(bu 2
54a33c0e1d Merge pull request \fI\%#45099\fP from rallytime/bp\-44983
.IP \(bu 2
23361de8a2 Ref:44961 \- Modified archive.tar to add dest argument at the end of the tar cmd.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43533\fP: (\fI\%Ch3LL\fP) Add status.pid Test to Auto Test Suite (refs: \fI\%#44650\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44650\fP: (\fI\%frogunder\fP) add status.pid test
@ \fI2017\-12\-19 16:21:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
e0d7b330fa Merge pull request \fI\%#44650\fP from frogunder/status
.IP \(bu 2
904c0da893 Merge branch \(aq2017.7\(aq into status
.IP \(bu 2
619bd2be1e fix lint error
.IP \(bu 2
d406cb07a3 add status.pid test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44516\fP: (\fI\%doesitblend\fP) Windows PY3 Minion Returns UTF16 UnicodeError (refs: \fI\%#45161\fP, \fI\%#44944\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44944\fP: (\fI\%lomeroe\fP) win_lgpo registry.pol encoding updates (refs: \fI\%#45161\fP)
@ \fI2017\-12\-19 14:42:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
422d8b8f1b Merge pull request \fI\%#44944\fP from lomeroe/update_regpol_encoding
.IP \(bu 2
07d04c7bc7 lint fixes for static regexes
.IP \(bu 2
d17c46ce41 lint fixes
.IP \(bu 2
ab8e431729 do not decode registry.pol file wholesale, but instead decode individual elements of the file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44938\fP: (\fI\%The\-Loeki\fP) Libcloud dns fixes
@ \fI2017\-12\-18 15:47:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
d9a4b9681e Merge pull request \fI\%#44938\fP from The\-Loeki/libcloud_dns_fixes
.IP \(bu 2
276e8828ae libcloud_dns: pylint fix
.IP \(bu 2
c994423286 Merge branch \(aq2017.7\(aq into libcloud_dns_fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44951\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-12\-16 13:16:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
5137be01ec Merge pull request \fI\%#44951\fP from rallytime/merge\-2017.7
.IP \(bu 2
a0d2dd2069 Lint fix
.IP \(bu 2
9db4179462 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
68d901b12c Merge pull request \fI\%#44770\fP from cruscio/2016.11
.INDENT 2.0
.IP \(bu 2
e2682bf441 Fix minion ping_interval documentation
.UNINDENT
.IP \(bu 2
d4ab55ec47 Merge pull request \fI\%#44335\fP from gtmanfred/2016.11
.INDENT 2.0
.IP \(bu 2
3f1268d67f fix patching for python 2.6
.IP \(bu 2
1d0bd5bb32 Merge branch \(aq2016.11\(aq into 2016.11
.IP \(bu 2
f02b02032d Merge pull request #4 from terminalmage/pr\-44335
.INDENT 2.0
.IP \(bu 2
b4eb1527a6 Add test for PR 44335
.UNINDENT
.IP \(bu 2
a30af3252e add docker\-ce to docker subtype grains check
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44995\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_file\fP for Windows
@ \fI2017\-12\-15 17:05:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
698b04779e Merge pull request \fI\%#44995\fP from twangboy/win_fix_atomicfile
.IP \(bu 2
8316481944 Comment the salt import
.IP \(bu 2
fe34f0c877 Set owner properly on Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44934\fP: (\fI\%vernondcole\fP) http.wait_for_successful_query does not pause for documented intervals (refs: \fI\%#44968\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44968\fP: (\fI\%gtmanfred\fP) fix http wait for state
@ \fI2017\-12\-14 20:06:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e1a57b9bc Merge pull request \fI\%#44968\fP from gtmanfred/http
.IP \(bu 2
ca6936f6eb fix http wait for state
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
c72db283d5 libcloud_dns: Further fixes to state output, pylint fixes
.IP \(bu 2
e9bbc23b11 Merge branch \(aq2017.7\(aq into libcloud_dns_fixes
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44811\fP: (\fI\%xuhcc\fP) rbenv.installed fails when rbenv installed globally (refs: \fI\%#44900\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44900\fP: (\fI\%xuhcc\fP) Fix TypeError during rbenv ruby installation when rbenv is not found
@ \fI2017\-12\-14 17:37:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
c4f0894689 Merge pull request \fI\%#44900\fP from xuhcc/rbenv\-ret\-fix
.IP \(bu 2
fdd8310c31 Merge branch \(aq2017.7\(aq into rbenv\-ret\-fix
.IP \(bu 2
bfd0972d25 Fix TypeError during rbenv ruby installation when rbenv is not found
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44974\fP: (\fI\%twangboy\fP) Skip test_log_created on Windows
@ \fI2017\-12\-14 13:59:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
f0c2cf3cec Merge pull request \fI\%#44974\fP from twangboy/win_skip_test_parsers
.IP \(bu 2
40665d7b08 Skip test_log_created on Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44820\fP: (\fI\%msteed\fP) Custom returner breaks manage runner (refs: \fI\%#44958\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44958\fP: (\fI\%terminalmage\fP) Fix a race condition in manage runner (refs: \fI\%#44972\fP)
@ \fI2017\-12\-13 15:20:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
dad2d723ca Merge pull request \fI\%#44958\fP from terminalmage/issue44820
.IP \(bu 2
ef749abfc6 No need to manually do connect_pub, use listen=True in run_job
.IP \(bu 2
2ac70cfab5 Fix a race condition in manage runner
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44956\fP: (\fI\%terminalmage\fP) Avoid traceback when bogus value in pidfile
@ \fI2017\-12\-13 14:30:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
db58345abb Merge pull request \fI\%#44956\fP from terminalmage/fix\-get_pidfile
.IP \(bu 2
d66f3a98d7 Avoid traceback when bogus value in pidfile
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44932\fP: (\fI\%knine\fP) ACLs Not Completely Verified (refs: \fI\%#44945\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44945\fP: (\fI\%gtmanfred\fP) Fix handling of effective acls
@ \fI2017\-12\-12 21:49:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
e8e3b3c8ff Merge pull request \fI\%#44945\fP from gtmanfred/2017.7
.IP \(bu 2
66bb755751 add test for effective acls
.IP \(bu 2
0ff52a93dd use last entry in acl
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44942\fP: (\fI\%rallytime\fP) Update README with SaltConf18 info
@ \fI2017\-12\-12 21:47:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
47dc7b7afb Merge pull request \fI\%#44942\fP from rallytime/readme\-saltconf\-update
.IP \(bu 2
d1317c44e2 Update README with SaltConf18 info
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44665\fP: (\fI\%mvivaldi\fP) Documentation of salt renders jinja (refs: \fI\%#44943\fP, \fI\%#44895\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44943\fP: (\fI\%mvivaldi\fP) Fix for the jinja documentation
@ \fI2017\-12\-12 20:20:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
7572982419 Merge pull request \fI\%#44943\fP from mvivaldi/filters\-doc
.IP \(bu 2
d23ac4eabc Fix for the jinja documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43417\fP: (\fI\%damon\-atkins\fP) win_pkg:  pkg.install and pkg.remove general issues (refs: \fI\%#44832\fP, \fI\%#43708\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44832\fP: (\fI\%damon\-atkins\fP) win_pkg: Merge full copy of 2016.11 with many fixes and improvements to 2017.7
@ \fI2017\-12\-12 18:30:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
465cacad83 Merge pull request \fI\%#44832\fP from damon\-atkins/2017.7_replace_with_newer_2016.11_win_pkg
.IP \(bu 2
a4f0b41ba2 Should be a smaller change set since recent update from 2016.11
.IP \(bu 2
695334b201 Merge branch \(aq2017.7_replace_with_newer_2016.11_win_pkg\(aq of github.com:damon\-atkins/salt into 2017.7_replace_with_newer_2016.11_win_pkg
.INDENT 2.0
.IP \(bu 2
843e204582 Merge branch \(aq2017.7\(aq into 2017.7_replace_with_newer_2016.11_win_pkg
.UNINDENT
.IP \(bu 2
4b60b1ec84 Merge remote branch \(aqrefs/remotes/upstream/2017.7\(aq into 2017.7_replace_with_newer_2016.11_win_pkg
.IP \(bu 2
b46f818a57 Raise a PR to fix 2016 issues committed here, fixed issues with merge.
.IP \(bu 2
32ef1e12ae Merge branch \(aq2017.7\(aq into 2017.7_replace_with_newer_2016.11_win_pkg
.IP \(bu 2
494835c3f2 I backported develop and applied a long list of fixes to 2016.11 this brings these
fixes into 2017.7 \- Software was not always being removed, general if & was in the string or
msi was downloaded to uninstall the software \- pkg.list_upgrades failed. Added support for
\(aqlatest\(aq and \(aqNot Found\(aq for version_cmp() to fix this. \- output fixes \- pkg.list_available no
longer forces a pkg.refresh_db this is no longer required, as by default it will update if
older than 6 hours \- cmd /s /c is prefixed for all commands i.e. installs and removes. \- cmd
are now strings, instead of a list when using cmd.run. As windows only supports strings. And
the \(dq were being broken
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44754\fP: (\fI\%twangboy\fP) Fix inet_pton for Windows on Py3
@ \fI2017\-12\-12 14:04:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
a811a92b17 Merge pull request \fI\%#44754\fP from twangboy/win_fix_inet_pton
.IP \(bu 2
25a20109fe Merge branch \(aq2017.7\(aq into win_fix_inet_pton
.IP \(bu 2
849b99eb34 Merge branch \(aq2017.7\(aq into win_fix_inet_pton
.IP \(bu 2
df1e6a202b Use salt.ext.six
.IP \(bu 2
5ac8112585 Use six to ensure unicode value
.IP \(bu 2
9b5d8c421b Handle unicode values
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44931\fP: (\fI\%pkruk\fP) add missing parenthis to keep integration with python3
@ \fI2017\-12\-12 13:49:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
53b34e24cd Merge pull request \fI\%#44931\fP from pkruk/fix\-missing\-parenthis
.IP \(bu 2
b1ed739b44 Merge branch \(aq2017.7\(aq into fix\-missing\-parenthis
.IP \(bu 2
4f1b1f12d2 Merge branch \(aqfix\-missing\-parenthis\(aq of \fI\%https://github.com/pkruk/salt\fP into fix\-missing\-parenthis
.INDENT 2.0
.IP \(bu 2
3475d3fa01 add missing parenthis to keep integration with python3
.UNINDENT
.IP \(bu 2
adf38cacfb add missing parenthis to keep integration with python3
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
ad55e33f57 libcloud_dns: fix state output
.IP \(bu 2
a68d594e3a libcloud_dns: copy args before deleting from them
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44891\fP: (\fI\%twangboy\fP) Fix issue with unsafe path in Windows jenkins tests
@ \fI2017\-12\-11 21:10:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
ba6146250a Merge pull request \fI\%#44891\fP from twangboy/win_fix_verify
.IP \(bu 2
7232579167 Allow test suite file_roots as a safe path
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44921\fP: (\fI\%Ch3LL\fP)  Add test to ensure log files are created
@ \fI2017\-12\-11 18:24:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
85160fd297 Merge pull request \fI\%#44921\fP from Ch3LL/log_test
.IP \(bu 2
3bb58fb577 skip salt\-key log creation test
.IP \(bu 2
6a379195bc Add test to ensure log files are created
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44787\fP: (\fI\%rallytime\fP) GroupAdd test: Add destructive test decorator to entire class
@ \fI2017\-12\-11 18:14:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
54d29a61cb Merge pull request \fI\%#44787\fP from rallytime/groupadd\-destructive\-clean
.IP \(bu 2
817ac002b0 Add destructive test decorator to test class
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44665\fP: (\fI\%mvivaldi\fP) Documentation of salt renders jinja (refs: \fI\%#44943\fP, \fI\%#44895\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44895\fP: (\fI\%mvivaldi\fP) Jinja Filters doc
@ \fI2017\-12\-11 15:32:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
0292e3612a Merge pull request \fI\%#44895\fP from mvivaldi/filters\-doc
.IP \(bu 2
62409d608a Added Escape Filters and Set Theory Filters in jinja documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44879\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-12\-10 16:53:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44855\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7 (refs: \fI\%#44879\fP)
.IP \(bu 2
df28f312ac Merge pull request \fI\%#44879\fP from rallytime/merge\-2017.7
.IP \(bu 2
23c5a4ca3e Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
bb1f8dceaf Merge pull request \fI\%#44579\fP from roaldnefs/fix\-cron\-identifier
.INDENT 2.0
.IP \(bu 2
df73a4c051 Merge branch \(aq2016.11\(aq into fix\-cron\-identifier
.UNINDENT
.IP \(bu 2
af0131fa1f Merge pull request \fI\%#44852\fP from damon\-atkins/2016.11_win_pkg_typo_n_fix
.INDENT 2.0
.IP \(bu 2
0e7c19084f Lint: Remove extra whitespace
.IP \(bu 2
7c7e21f94d Fix spelling typo, and fix backwards campatible minion option for repo location
.UNINDENT
.IP \(bu 2
88c0d66b4e Merge pull request \fI\%#44794\fP from terminalmage/issue44365
.INDENT 2.0
.IP \(bu 2
3b8b6f25e6 Remove debugging line
.IP \(bu 2
153bf45b03 Fix regression in file.managed when source_hash used with local file
.UNINDENT
.IP \(bu 2
c8bb9dfbbb Merge pull request \fI\%#44738\fP from rallytime/bump\-oxygen\-warnings
.INDENT 2.0
.IP \(bu 2
ead3c569e1 Bump deprecation warnings from Oxygen to Fluorine
.UNINDENT
.IP \(bu 2
88e3aab00d Merge pull request \fI\%#44741\fP from gtmanfred/rhip
.INDENT 2.0
.IP \(bu 2
439dc8dce6 if gateway is not specified use iface
.INDENT 2.0
.IP \(bu 2
3ec4329307 Merge branch \(aq2016.11\(aq into fix\-cron\-identifier
.IP \(bu 2
99fa05a456 Fix for bug in cron state
.IP \(bu 2
97328faeac Fix for bug in cron module
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44880\fP: (\fI\%UtahDave\fP) Determine windows hardware arch correctly
@ \fI2017\-12\-08 22:24:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
8e14bc3941 Merge pull request \fI\%#44880\fP from UtahDave/2017.7local
.IP \(bu 2
6e3c7ac1ac Merge branch \(aq2017.7\(aq into 2017.7local
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44861\fP: (\fI\%twangboy\fP) Fix win_lgpo for unknown values (refs: \fI\%#45327\fP)
@ \fI2017\-12\-08 18:52:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
dc51174670 Merge pull request \fI\%#44861\fP from twangboy/win_fix_lgpo_invalid_value
.IP \(bu 2
89f65e19ff Check for values other than 0 or 1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44621\fP: (\fI\%isbm\fP) Bugfix: errors in external pillar causes crash, instead of report of them
@ \fI2017\-12\-08 18:46:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
f5a143f8c5 Merge pull request \fI\%#44621\fP from isbm/isbm\-bsc1068446\-2017.7
.IP \(bu 2
0d2675c4fe Use variable, instead of direct value
.IP \(bu 2
1ddc47da0a Add unit test for _get_pillar_errors when external pillar is clean and internal contains errors
.IP \(bu 2
68480d5dc9 Add unit test for _get_pillar_errors when both external and internal pillars contains errors
.IP \(bu 2
218a59e93b Add unit test for _get_pillar_errors when external pillar has errors and internal is clean
.IP \(bu 2
3ce19356c2 Add unit test for _get_pillar_errors when external and internal pillars are clean
.IP \(bu 2
67034139d9 Fix unit test: wrong error types in side effect
.IP \(bu 2
d9359bca13 Bugfix: unit test mistakenly expects pillar errors as a string, while it is a list
.IP \(bu 2
8c2bdc696b Bugfix: do not pull \(aq_errors\(aq from unchecked objects
.IP \(bu 2
d5e30999c7 Remove unused variable (no exception, within the try/finally block)
.IP \(bu 2
aad668d559 Fix and clarify docstring.
.IP \(bu 2
c2c47e4e71 Rename function from ambiguous name
.IP \(bu 2
265de8e61c Bugfix the logic according to the exact described purpose of the function.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
dae9c6aa5c Determine windows hardware arch correctly
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43379\fP: (\fI\%twangboy\fP) Fix file.managed on Windows with test=True
@ \fI2017\-12\-07 21:10:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
abe089ad54 Merge pull request \fI\%#43379\fP from twangboy/win_fix_file.managed
.IP \(bu 2
edcd581ca5 Merge branch \(aq2017.7\(aq into win_fix_file.managed
.IP \(bu 2
a27bb6993a Fix py3 error
.IP \(bu 2
0ff9fa498a Fix test_directory
.IP \(bu 2
187bc1e61e Add back the try/finally blocks
.IP \(bu 2
d7241d004f Fix 2 more tests
.IP \(bu 2
d5dd42aebe Fix integration tests for Windows
.IP \(bu 2
d56bc9aae9 Fix typo
.IP \(bu 2
af5565859e Use file functions for symlink and remove
.IP \(bu 2
72ac59c991 Fix some more integration tests for Linux
.IP \(bu 2
3f0499cbc4 Fix some integration tests
.IP \(bu 2
a24b964ea5 Fix unit test to handle new Exception
.IP \(bu 2
e3c3845f73 Raise CommandExecutionError when file doesn\(aqt exist
.IP \(bu 2
4602f499a2 Remove loader module mixin, add linux paths
.IP \(bu 2
99b27c037f Add tests to avoid future regression
.IP \(bu 2
5c215ed8c2 Fix documentation formatting
.IP \(bu 2
6a4e77e4b9 Return empty or unmodified dict on file not found
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44565\fP: (\fI\%arthurlogilab\fP) NameError: global name \(aq__jid_event__\(aq is not defined when running a runner in the scheduler (refs: \fI\%#44570\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44570\fP: (\fI\%gtmanfred\fP) Include client mixin globals in scheduler for runner modules
@ \fI2017\-12\-07 20:23:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
cf4cbcd340 Merge pull request \fI\%#44570\fP from gtmanfred/2017.7
.IP \(bu 2
7b17f9f63c Merge branch \(aq2017.7\(aq into 2017.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44494\fP: (\fI\%skizunov\fP) Fix broken \fIbeacons_before_connect\fP feature
@ \fI2017\-12\-07 18:24:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38289\fP: (\fI\%skizunov\fP) Add config options for running beacons/scheduler before connect (refs: \fI\%#44494\fP)
.IP \(bu 2
febb913743 Merge pull request \fI\%#44494\fP from skizunov/develop2
.IP \(bu 2
7adcfbf8ec Merge branch \(aq2017.7\(aq into develop2
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44298\fP: (\fI\%skjaro\fP) ipset state check problem (refs: \fI\%#44356\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#39552\fP: (\fI\%Xiami2012\fP) ipset.check new implementation by @lingonl has countless critical bugs (refs: \fI\%#44356\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44512\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44356\fP to 2017.7
@ \fI2017\-12\-07 14:44:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44356\fP: (\fI\%skjaro\fP) Fix ipset state with multiple entries and subtypes separated with comma (refs: \fI\%#44512\fP)
.IP \(bu 2
284a817565 Merge pull request \fI\%#44512\fP from rallytime/bp\-44356
.IP \(bu 2
6f92c71834 Merge branch \(aq2017.7\(aq into bp\-44356
.IP \(bu 2
9a325146df Fix lint violation
.IP \(bu 2
5aac729855 Fix check multiple entries with subtypes separated with comma
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44748\fP: (\fI\%twangboy\fP) Fix auto login support for OSX
@ \fI2017\-12\-07 14:22:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
74ee7ce541 Merge pull request \fI\%#44748\fP from twangboy/osx_fix_auto_login
.IP \(bu 2
068e463870 Fix lint, add integration tests
.IP \(bu 2
3df886df75 Fix lint, add gtmanfreds change
.IP \(bu 2
16cb24614f Add kcpassword functionality
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44842\fP: (\fI\%twangboy\fP) Win fix lgpo unicode on Py3 issue
@ \fI2017\-12\-07 14:21:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
b60cca174c Merge pull request \fI\%#44842\fP from twangboy/win_fix_lgpo
.IP \(bu 2
efe77999d1 Gate log.debug statement behind successful pop
.IP \(bu 2
1c0ec79cd1 Fix py3 issue
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44843\fP: (\fI\%twangboy\fP) Fix 2 typos in lgpo module
@ \fI2017\-12\-06 17:56:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb58e2fec0 Merge pull request \fI\%#44843\fP from twangboy/win_fix_lgpo_typo
.IP \(bu 2
c8f93e6dd7 Fix 2 types, shorten line lengths for spellchecking
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44827\fP: (\fI\%mz\-bmcqueen\fP) add more clone options to virtualbox and add better dhcp handling
@ \fI2017\-12\-06 15:02:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
d6c37ea19c Merge pull request \fI\%#44827\fP from mz\-bmcqueen/2017.7
.IP \(bu 2
4ead3014b7 Merge branch \(aq2017.7\(aq into 2017.7
.IP \(bu 2
b7ce154014 Merge branch \(aq2017.7\(aq of \fI\%https://github.com/mz\-bmcqueen/salt\fP into 2017.7
.INDENT 2.0
.IP \(bu 2
2f80f431b3 Merge branch \(aq2017.7\(aq into 2017.7
.UNINDENT
.IP \(bu 2
c2018c9021 fix pylint complaints
.IP \(bu 2
c38ff74261 add more clone options to virtualbox and add better dhcp handling
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44824\fP: (\fI\%Ch3LL\fP) Add spm \-y and \-f arg integration tests
@ \fI2017\-12\-05 21:49:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
019169ed61 Merge pull request \fI\%#44824\fP from Ch3LL/spm_args
.IP \(bu 2
d8f81d2e4d fix pylint
.IP \(bu 2
61ac5cf157 Add spm \-y and \-f arg integration tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44742\fP: (\fI\%Ch3LL\fP) Add salt\-cloud action rename integration test
@ \fI2017\-12\-05 17:44:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
59b930668c Merge pull request \fI\%#44742\fP from Ch3LL/cloud_action_test
.IP \(bu 2
951d09ca2f remove unnecessary try/except block
.IP \(bu 2
c329ced7ee Add salt\-cloud action rename integration test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42676\fP: (\fI\%mind\-code\fP) Changes in Pillar defined Beacons only apply after Minion restart (refs: \fI\%#44771\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44771\fP: (\fI\%garethgreenaway\fP) [2017.7] Back porting \fI\%#44071\fP
@ \fI2017\-12\-05 17:16:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44071\fP: (\fI\%garethgreenaway\fP) [develop] Various fixes to beacons (refs: \fI\%#44771\fP)
.IP \(bu 2
10442d9211 Merge pull request \fI\%#44771\fP from garethgreenaway/42676_backport_44071
.IP \(bu 2
ec2a8b2032 Merge branch \(aq2017.7\(aq into 42676_backport_44071
.IP \(bu 2
180971203e Updating minion to respond to list_available events for beacons
.IP \(bu 2
db6fcefe62 Adding list_available which is used by the add function to verify that a becaon exists.
.IP \(bu 2
e9e0318bc6 Backporting fixes related to having beacons in pillar from \fI\%#44071\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44784\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-12\-05 17:13:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44732\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7 (refs: \fI\%#44784\fP)
.IP \(bu 2
23d151b40a Merge pull request \fI\%#44784\fP from rallytime/merge\-2017.7\-1
.IP \(bu 2
3d9eafc4bd Lint: Remove extra empty lines at end of files
.IP \(bu 2
239f3511bf Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
97e0cf569c Merge pull request \fI\%#44699\fP from jfindlay/attr_file
.INDENT 2.0
.IP \(bu 2
9e5a40ea7c Merge branch \(aq2016.11\(aq into attr_file
.IP \(bu 2
5c34607f6c utils/files remove temp file upon move failure
.UNINDENT
.IP \(bu 2
7434e0afdf Merge pull request \fI\%#44714\fP from rallytime/fix\-44556
.INDENT 2.0
.IP \(bu 2
1bbe1abeb2 Allow \-\-static option to display state runs with highstate output
.UNINDENT
.IP \(bu 2
998d714ee7 Merge pull request \fI\%#44517\fP from whytewolf/publish_port_doc_missing
.INDENT 2.0
.IP \(bu 2
4b5855283a missed one place where i didn\(aqt chanbge master_port from my copy to publish_port
.IP \(bu 2
e4610baea5 update doc to have publish port
.UNINDENT
.IP \(bu 2
6169b52749 Merge pull request \fI\%#41279\fP from Ch3LL/add_grain_tests
.INDENT 2.0
.IP \(bu 2
1b64f15692 Merge branch \(aq2016.11\(aq into add_grain_tests
.UNINDENT
.IP \(bu 2
dc6de050a9 Merge pull request \fI\%#44563\fP from creideiki/pgjsonb\-timestamps\-44544
.INDENT 2.0
.IP \(bu 2
231e412ca4 Merge branch \(aq2016.11\(aq into pgjsonb\-timestamps\-44544
.UNINDENT
.IP \(bu 2
4369df020b Merge pull request \fI\%#44602\fP from rallytime/fix\-44601
.INDENT 2.0
.IP \(bu 2
ff303fd060 Handle timeout_monitor/TimeoutError issues for new versions of CherryPy
.UNINDENT
.IP \(bu 2
4a4756fc37 Merge pull request \fI\%#44604\fP from lorengordon/doc\-exclude
.INDENT 2.0
.IP \(bu 2
c4a6c40eb3 Documents the exclude argument in state execution module
.IP \(bu 2
15c445e6b9 Send Unix timestamps to database in pgjsonb
.IP \(bu 2
095f1b7d7a Merge branch \(aq2016.11\(aq into add_grain_tests
.UNINDENT
.IP \(bu 2
91d46d4cfc Merge pull request \fI\%#44434\fP from whytewolf/1837
.INDENT 2.0
.IP \(bu 2
d148e39dda change from md to rst for code reference
.IP \(bu 2
955e305bda fix bad english, as requested by cachedout
.IP \(bu 2
7256fcc1c9 update note to take into account grains_cache
.IP \(bu 2
7a2981585e Merge branch \(aq2016.11\(aq into 1837
.IP \(bu 2
aca0405b26 add a note that describes grain rebuilding on restart and refresh
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
9ea4db4224 mock socket.getaddrinfo
.IP \(bu 2
78a07e30f4 add more fqdn tests and remove some of the mocking
.IP \(bu 2
5dbf4144ce add ipv6 in opts
.IP \(bu 2
eabc1b4f9c Add fqdn and dns core grain tests
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
a3bd99317f Merge pull request \fI\%#44321\fP from gvengel/fix\-file\-line\-diff\-output
.INDENT 2.0
.IP \(bu 2
69a50204a6 Add newline for lint.
.IP \(bu 2
ef7b6bbb81 Fixed issue with file.line on Windows running Python 2.
.IP \(bu 2
8f89c99fa5 Fix FileModuleTest setUp and tearDown to work on Windows.
.IP \(bu 2
3ac5391f5f Namespace missing functions for file.line on Windows.
.IP \(bu 2
b2b8f075b9 Fixed test to work on Windows.
.IP \(bu 2
5a5a2dd026 Added integration test for issue \fI\%#41474\fP
.IP \(bu 2
24d7315f1a Fix file.line diff formatting.
.UNINDENT
.IP \(bu 2
9ca563718d Merge pull request \fI\%#43708\fP from damon\-atkins/2016.11_43417_Backport_and_Fixes
.INDENT 2.0
.IP \(bu 2
04d03ea6b8 Updated comment
.IP \(bu 2
1dd565e585 Merge remote branch \(aqupstream/2016.11\(aq into 2016.11_43417_Backport_and_Fixes
.IP \(bu 2
dd48ba2616 Merge remote branch \(aqupstream/2016.11\(aq into 2016.11_43417_Backport_and_Fixes
.IP \(bu 2
a0d08598bf dco fix
.IP \(bu 2
9467899fc6 Merge remote branch \(aqupstream/2016.11\(aq into 2016.11_43417_Backport_and_Fixes
.IP \(bu 2
6dc180fd0e doco fixes
.IP \(bu 2
2496a42ea4 lint fix
.IP \(bu 2
2c937fbe19 Merge remote branch \(aqupstream/2016.11\(aq into 2016.11_43417_Backport_and_Fixes
.IP \(bu 2
c9c8c48a4d all remove/install commands are passed to cmd.exe /s /c and commands are passed as strings to cmdmod
.IP \(bu 2
350244bd93 typo in comments and doc strings.
.IP \(bu 2
ec31f5a9bd 2017.11/develop version() was ignoring saltenv setting.
.IP \(bu 2
b314549a32 Backport of devlop to 2016.11 with additional bug fixes
.UNINDENT
.IP \(bu 2
68ea22188e Merge pull request \fI\%#44477\fP from rallytime/bp\-44424
.INDENT 2.0
.IP \(bu 2
4a9f8dcc96 Fix \fI\%#44423\fP: Handle index=None and index=0 distinctly
.UNINDENT
.IP \(bu 2
2c89050a24 Merge pull request \fI\%#44483\fP from terminalmage/issue44034
.INDENT 2.0
.IP \(bu 2
a9db8becea salt\-call: account for instances where __pillar__ is empty
.UNINDENT
.IP \(bu 2
b5c2028680 Merge pull request \fI\%#44489\fP from whytewolf/1956_log\-granular\-levels
.INDENT 2.0
.IP \(bu 2
9cdeb4e903 update log\-granular\-levels to describe what they are filtering on
.UNINDENT
.IP \(bu 2
ea07f9c54c Merge pull request \fI\%#44193\fP from twangboy/win_fix_reg
.INDENT 2.0
.IP \(bu 2
44d6d9f46d Remove unused import (lint)
.IP \(bu 2
f7502436bd Fix various issues
.IP \(bu 2
221e6e3b91 make salt.utils.to_unicode return none when passed none
.IP \(bu 2
ce41acc788 Fix many issues with reg.py
.IP \(bu 2
4a19df1f7f Use six.text_type instead of str
.IP \(bu 2
1b12acd303 Check type before casting
.IP \(bu 2
03fa37b445 Cast vdata to its proper type
.UNINDENT
.IP \(bu 2
ed8da2450b Merge pull request \fI\%#43863\fP from nicholasmhughes/fix\-atomicfile\-permission\-copy
.INDENT 2.0
.IP \(bu 2
ea852ec5d3 remove index use with stat module attributes
.IP \(bu 2
dbeeb0e917 fixes \fI\%#38452\fP atomicfile only copies mode and not user/group perms
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44788\fP: (\fI\%kris\-anderson\fP) Example yaml of influxdb_user state
@ \fI2017\-12\-04 14:28:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
4643a112e7 Merge pull request \fI\%#44788\fP from kris\-anderson/example\-yaml\-of\-influxdb\-user\-state
.IP \(bu 2
afd23d058c converted yaml example to use 2 spaces
.IP \(bu 2
29e410c1ea added a code\-block example of how the yaml should be formatted
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42713\fP: (\fI\%boltronics\fP) 2017.7.0 master upgrade breaks mine data on non\-glob matching on minions (refs: \fI\%#44735\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44735\fP: (\fI\%gracinet\fP) Backported issue \fI\%#42713\fP to 2017.7
@ \fI2017\-12\-04 01:43:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ebac09f60 Merge pull request \fI\%#44735\fP from gracinet/42713_backport_2017.7
.IP \(bu 2
6806d83314 Merge branch \(aq2017.7\(aq into 42713_backport_2017.7
.IP \(bu 2
fb586c6dce Backported issue \fI\%#42713\fP to 2017.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44766\fP: (\fI\%twangboy\fP) Fix \fIunit.utils.test_process\fP for Windows
@ \fI2017\-12\-02 13:15:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
06ce7b7328 Merge pull request \fI\%#44766\fP from twangboy/win_fix_test_process
.IP \(bu 2
a5737e8fc3 Fix lint errors
.IP \(bu 2
be96de09cc Fix pickling error by decorating
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44083\fP: (\fI\%ari\fP) timezone.system fails when /etc/localtime is missing on FreeBSD (refs: \fI\%#44605\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44716\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44605\fP to 2017.7
@ \fI2017\-12\-01 23:12:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44605\fP: (\fI\%campbellmc\fP) Add handling for FreeBSD in timezone.zone_compare (refs: \fI\%#44716\fP)
.IP \(bu 2
f8b8a8966d Merge pull request \fI\%#44716\fP from rallytime/bp\-44605
.IP \(bu 2
9d43221422 Correct indentation
.IP \(bu 2
d6e28ebed1 Add handling for FreeBSD in method zone_compare to avoid exception when
/etc/localtime file does is absent.  This is valid configuration on FreeBSD and represents UTC.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41869\fP: (\fI\%mirceaulinic\fP) Thorium: unable to execute runners (refs: \fI\%#44781\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44781\fP: (\fI\%mirceaulinic\fP) Correct the thorium runner
@ \fI2017\-12\-01 22:55:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
8ed6287762 Merge pull request \fI\%#44781\fP from cloudflare/thorium\-fix\-41869
.IP \(bu 2
83c73a69cb Instance the Runner class instead of the RunnerClient as we\(aqre running on the Master
.IP \(bu 2
b72b7c5402 Correct the thorium runner
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44466\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_disk\fP for Windows
@ \fI2017\-12\-01 22:31:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
52596be102 Merge pull request \fI\%#44466\fP from twangboy/win_fix_test_disk
.IP \(bu 2
5615862f23 Fix some lint
.IP \(bu 2
627d5ab0c9 Mock \fIsalt.utils.which\fP
.IP \(bu 2
e5a96fe00f Skip test_fstype on Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42763\fP: (\fI\%xuhcc\fP) acme.cert state falsely reports about renewed certificate (refs: \fI\%#44667\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44719\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44667\fP to 2017.7
@ \fI2017\-12\-01 15:20:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44667\fP: (\fI\%oarmstrong\fP) Fix acme.cert to run certbot non\-interactively (refs: \fI\%#44719\fP)
.IP \(bu 2
b9ad4bba2d Merge pull request \fI\%#44719\fP from rallytime/bp\-44667
.IP \(bu 2
3d85a260c4 Fix acme.cert to run certbot non\-interactively
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44744\fP: (\fI\%brmzkw\fP) roster_defaults breaks salt\-ssh globbing (refs: \fI\%#44747\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44747\fP: (\fI\%gtmanfred\fP) use a copy so roster_defaults doesn\(aqt mangle
@ \fI2017\-12\-01 15:13:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
d23192c492 Merge pull request \fI\%#44747\fP from gtmanfred/roster_defaults
.IP \(bu 2
911411ed8f add unit test
.IP \(bu 2
eefcfc719c use a copy so roster_defaults doesn\(aqt mangle
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44694\fP: (\fI\%thuhak\fP) state module at.absent does\(aqt work (refs: \fI\%#44717\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44717\fP: (\fI\%garethgreenaway\fP) [2017.7] Fixes to at module
@ \fI2017\-12\-01 14:37:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
20f20ad9e1 Merge pull request \fI\%#44717\fP from garethgreenaway/44694_at_absent_failing_to_find_jobs
.IP \(bu 2
1f2b3c5f46 Merge branch \(aq2017.7\(aq into 44694_at_absent_failing_to_find_jobs
.IP \(bu 2
3bb385b44e removing debugging logging
.IP \(bu 2
7f0ff5a8b0 When passing IDs on the command line convert them all the strings for later comparison.
.IP \(bu 2
99e436add4 When looking for job ids to remove based on the tag_name the comparison was comparing an INT to a STR, so the correct job id was not being returned.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44136\fP: (\fI\%dupsatou\fP) KeyError: \(aqrunas\(aq after updating to latest salt in yum repo. (refs: \fI\%#44695\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44695\fP: (\fI\%gtmanfred\fP) pop None for runas and runas_password
@ \fI2017\-12\-01 14:35:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
6e61aa787f Merge pull request \fI\%#44695\fP from gtmanfred/pop
.IP \(bu 2
0efb90b6f7 Merge branch \(aq2017.7\(aq into pop
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44725\fP: (\fI\%whytewolf\fP) document note suggesting systemd\-run \-\-scope with cmd.run_bg
@ \fI2017\-11\-30 19:18:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
20391c54c0 Merge pull request \fI\%#44725\fP from whytewolf/1919_cmd.run_no_daemons
.IP \(bu 2
4b11f8d66d add quick documentation suggesting systemd\-run \-\-scope if using cmd.run_bg with systemd
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42300\fP: (\fI\%mirceaulinic\fP) Grains state doesn\(aqt work (fine) with proxy minions (refs: \fI\%#44760\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#42074\fP: (\fI\%mirceaulinic\fP) How to configure static grains for proxy minions (refs: \fI\%#44549\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44760\fP: (\fI\%mirceaulinic\fP) Fix the grains.setvals execution function when working with proxy minions
@ \fI2017\-11\-30 18:27:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44549\fP: (\fI\%mirceaulinic\fP) Allow proxy minions to load static grains (refs: \fI\%#44760\fP)
.IP \(bu 2
85451ae977 Merge pull request \fI\%#44760\fP from cloudflare/px\-grains\-set\-42300
.IP \(bu 2
655139d01c Different path to the static grains file when running under a proxy minion
.IP \(bu 2
3eec8dbc63 Dummy proxy: catch EOFError instead of IOError
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44583\fP: (\fI\%creideiki\fP) Using splay in cron schedule throws exception \(dqunsupported operand type(s) for +: \(aqNoneType\(aq and \(aqint\(aq\(dq (refs: \fI\%#44640\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44640\fP: (\fI\%vutny\fP) Fix \fI\%#44583\fP: splay with cron\-like scheduled jobs
@ \fI2017\-11\-30 15:30:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
06fb80b69c Merge pull request \fI\%#44640\fP from vutny/fix\-cron\-schedule\-splay
.IP \(bu 2
d1f247e49e Add basic unit tests for schedule util eval func
.IP \(bu 2
6ff8e75ac6 Fix \fI\%#44583\fP: splay with cron\-like scheduled jobs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44712\fP: (\fI\%Ch3LL\fP) Add pillar ssh integration tests
@ \fI2017\-11\-30 15:29:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
e5a1401b82 Merge pull request \fI\%#44712\fP from Ch3LL/ssh_pillar_items
.IP \(bu 2
97ec0e6ea0 Merge branch \(aq2017.7\(aq into ssh_pillar_items
.IP \(bu 2
c7f5af1274 Add pillar ssh integration tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44763\fP: (\fI\%mirceaulinic\fP) Just a small improvement to the Thorium documentation
@ \fI2017\-11\-30 14:38:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e1c946990 Merge pull request \fI\%#44763\fP from cloudflare/thorium\-doc
.IP \(bu 2
f8d69dd0ba Add thorium_roots configuration example
.IP \(bu 2
4610fb4e62 thorium_roots not thorium_roots_dir
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44531\fP: (\fI\%mirceaulinic\fP) Add deprecation notes for the NAPALM native templates
@ \fI2017\-11\-30 14:18:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
8ba2df1ea0 Merge pull request \fI\%#44531\fP from cloudflare/deprecate\-napalm\-tpl
.IP \(bu 2
b462776d8b Add deprecation notes for the NAPALM native templates
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44737\fP: (\fI\%twangboy\fP) Skip \fIunit.transport.test_ipc\fP for Windows
@ \fI2017\-11\-29 19:18:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
7bde48282e Merge pull request \fI\%#44737\fP from twangboy/win_skip_test_ipc
.IP \(bu 2
4e0359b603 Skip IPC transport tests in Windows, not supported
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44629\fP: (\fI\%Ch3LL\fP) Add masterless state.highstate integration test
@ \fI2017\-11\-29 19:05:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
c5206113ce Merge pull request \fI\%#44629\fP from Ch3LL/high_masterless
.IP \(bu 2
9b7421b261 Change check to the state id
.IP \(bu 2
9cc853e3d5 Add masterless state.highstate integration test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44613\fP: (\fI\%Ch3LL\fP) Add pillar.items test for masterless
@ \fI2017\-11\-29 14:43:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
2dc3e5c42a Merge pull request \fI\%#44613\fP from Ch3LL/pillar_masterless
.IP \(bu 2
2c2e1e2332 Merge branch \(aq2017.7\(aq into pillar_masterless
.IP \(bu 2
69134e83ca Change order of local kwarg in run_call method
.IP \(bu 2
b3b5ecc6ff Add pillar.items test for masterless
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44659\fP: (\fI\%Ch3LL\fP) Add state.sls_id to ssh wrapper and tests
@ \fI2017\-11\-29 14:41:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
cc05481026 Merge pull request \fI\%#44659\fP from Ch3LL/ssh_sls_id
.IP \(bu 2
04b5a3dd4e Add state.sls_id to ssh wrapper and tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44698\fP: (\fI\%Ch3LL\fP) Add salt\-ssh mine.get integration test
@ \fI2017\-11\-28 22:15:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
642eed11e1 Merge pull request \fI\%#44698\fP from Ch3LL/mine_ssh
.IP \(bu 2
f6a72acfe3 Merge branch \(aq2017.7\(aq into mine_ssh
.IP \(bu 2
9e67babf85 Add teardown to remove ssh dir
.IP \(bu 2
f90b4f7653 Add salt\-ssh mine.get integration test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44697\fP: (\fI\%Ch3LL\fP) Sort the show_top results for test_state_show_top test
@ \fI2017\-11\-28 20:35:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
5d82df5667 Merge pull request \fI\%#44697\fP from Ch3LL/show_top_test
.IP \(bu 2
974db59dc1 convert the assert to a union set instead
.IP \(bu 2
add43c4cfe Sort the show_top results for test_state_show_top test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44608\fP: (\fI\%Ch3LL\fP) Add jinja to ssh sls test file
@ \fI2017\-11\-27 22:00:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
f2f6817e86 Merge pull request \fI\%#44608\fP from Ch3LL/ssh_jinja
.IP \(bu 2
df669b551d Merge branch \(aq2017.7\(aq into ssh_jinja
.IP \(bu 2
ca97517795 Add jinja to ssh sls test file
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33957\fP: (\fI\%ghost\fP) grains.setval doesn\(aqt setval if set in /etc/salt/minion (refs: \fI\%#44663\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44663\fP: (\fI\%whytewolf\fP) Update notes around grains topic, and salt.modules.grains and salt.state.grains
@ \fI2017\-11\-27 21:33:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
04b97bcfad Merge pull request \fI\%#44663\fP from whytewolf/ZD1777_ensure_understanding_of_minion_config_over_grains_file
.IP \(bu 2
c9122e4b85 fixed pylint error, and updated description on at the top the the module and state.
.IP \(bu 2
7fb208b5ad Update note in topics/grains to reflect that not all grains are ignored. only those set in the minion config
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44332\fP: (\fI\%mirceaulinic\fP) Improve the net.load_config execution function
@ \fI2017\-11\-27 21:22:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
364deee6ac Merge pull request \fI\%#44332\fP from cloudflare/improve\-net\-load
.IP \(bu 2
cd0bac87e6 Merge branch \(aq2017.7\(aq into improve\-net\-load
.IP \(bu 2
6d861f9a74 Disable pylint warning
.IP \(bu 2
3a0945ce3d Merge pull request #11 from tonybaloney/gh_44332_clone
.INDENT 2.0
.IP \(bu 2
88ef9f18fc ignore lint error on import
.IP \(bu 2
25427d845e convert key iterator to list as python 3 won\(aqt index an iterator
.UNINDENT
.IP \(bu 2
bce50154e5 Merge branch \(aq2017.7\(aq into improve\-net\-load
.IP \(bu 2
ba4a62769c Fix trailing spaces
.IP \(bu 2
0a47a7acbf Merge pull request #10 from tonybaloney/gh_44332_clone
.INDENT 2.0
.IP \(bu 2
ba0280e727 linting updates
.IP \(bu 2
78b90f3d0c add remaining tests
.IP \(bu 2
386c4e5791 add tests for all the getters
.UNINDENT
.IP \(bu 2
f3d2d1aaaa Merge pull request #9 from tonybaloney/gh_44332_clone
.INDENT 2.0
.IP \(bu 2
c63222358b update tests with correct assertions and mock methods on device instance
.IP \(bu 2
b69c559c52 fix kwargs typo
.UNINDENT
.IP \(bu 2
edea76d3f3 Improve the net.load_config function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44664\fP: (\fI\%mvivaldi\fP) Patch 1
@ \fI2017\-11\-27 21:17:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
b6a1ed06b8 Merge pull request \fI\%#44664\fP from mvivaldi/patch\-1
.IP \(bu 2
4551999ec7 Update jinja.py
.IP \(bu 2
ae13d57307 Update file.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42074\fP: (\fI\%mirceaulinic\fP) How to configure static grains for proxy minions (refs: \fI\%#44549\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44549\fP: (\fI\%mirceaulinic\fP) Allow proxy minions to load static grains (refs: \fI\%#44760\fP)
@ \fI2017\-11\-27 20:57:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
9ea4ee1479 Merge pull request \fI\%#44549\fP from cloudflare/fix\-proxy\-grains
.IP \(bu 2
7b03574ab6 Merge branch \(aq2017.7\(aq into fix\-proxy\-grains
.IP \(bu 2
0320174ea4 Add doc note regarding static grains on proxy minions
.IP \(bu 2
509d1af832 Allow proxy minions to load static grains
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44572\fP: (\fI\%Ch3LL\fP) Add watch_in integration test
@ \fI2017\-11\-27 20:52:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
5ec7ea0bb5 Merge pull request \fI\%#44572\fP from Ch3LL/watchin_test
.IP \(bu 2
0a54584ddb Merge branch \(aq2017.7\(aq into watchin_test
.IP \(bu 2
898c28e6d9 Merge branch \(aq2017.7\(aq into watchin_test
.IP \(bu 2
3df70f3fed remove iter for watch_in failure test
.IP \(bu 2
ac437ddf90 add order check and remove iter
.IP \(bu 2
5f2b4f434e Add watch_in integration test
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
c6733ac1ee pop None
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44616\fP: (\fI\%Ch3LL\fP) Add Non Base Environment salt:// source integration test
@ \fI2017\-11\-22 16:13:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
d6ccf4bb30 Merge pull request \fI\%#44616\fP from Ch3LL/nonbase_test
.IP \(bu 2
80b71652e3 Merge branch \(aq2017.7\(aq into nonbase_test
.IP \(bu 2
c9ba33432e Add Non Base Environment salt:// source integration test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44617\fP: (\fI\%Ch3LL\fP) Add ssh thin_dir integration test
@ \fI2017\-11\-22 16:12:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ace504c8c Merge pull request \fI\%#44617\fP from Ch3LL/thindir_ssh
.IP \(bu 2
071a1bd65b Merge branch \(aq2017.7\(aq into thindir_ssh
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44625\fP: (\fI\%Ch3LL\fP) Add salt\-key \-d integration test
@ \fI2017\-11\-22 03:15:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
2cd618f99b Merge pull request \fI\%#44625\fP from Ch3LL/delete_key_test
.IP \(bu 2
443dc1e16b Merge branch \(aq2017.7\(aq into delete_key_test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44601\fP: (\fI\%rallytime\fP) CherryPy 12.0 removed support for \(dqengine.timeout_monitor.on\(dq config option (refs: \fI\%#44602\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44614\fP: (\fI\%rallytime\fP) [2017.7] Move PR \fI\%#44602\fP forward to 2017.7
@ \fI2017\-11\-21 21:21:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44602\fP: (\fI\%rallytime\fP) Handle timeout_monitor attribute error for new versions of CherryPy (refs: \fI\%#44614\fP)
.IP \(bu 2
4f30e845ee Merge pull request \fI\%#44614\fP from rallytime/44602\-2017.7
.IP \(bu 2
628f015c1b Move TimoutError check lower down in exception list
.IP \(bu 2
d26d9ff5e4 Handle timeout_monitor/TimeoutError issues for new versions of CherryPy
.IP \(bu 2
359a59dd64 Add salt\-key \-d integration test
.IP \(bu 2
74ededafa7 Add ssh thin_dir integration test
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
4d0806e28c Merge branch \(aq2017.7\(aq into develop2
.IP \(bu 2
4d0d023115 Fix broken \fIbeacons_before_connect\fP feature
.INDENT 2.0
.IP \(bu 2
98536110d9 Merge branch \(aq2017.7\(aq into 2017.7
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44571\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43822\fP to 2017.7
@ \fI2017\-11\-20 19:01:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43822\fP: (\fI\%chnrxn\fP) check_result: Correctly check the __extend__ state. (refs: \fI\%#44571\fP)
.IP \(bu 2
136b9e3bc4 Merge pull request \fI\%#44571\fP from rallytime/bp\-43822
.IP \(bu 2
f81bb61f2d check_result: Correctly check the __extend__ state.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44588\fP: (\fI\%rallytime\fP) Add documentation about logging before modules are loaded
@ \fI2017\-11\-20 18:43:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44576\fP: (\fI\%rallytime\fP) Remove logging from top of napalm util file (refs: \fI\%#44588\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44439\fP: (\fI\%mirceaulinic\fP)  Adapt napalm modules to the new library structure (refs: \fI\%#44576\fP)
.IP \(bu 2
bea7f65291 Merge pull request \fI\%#44588\fP from rallytime/logging\-in\-virtual\-funcs
.IP \(bu 2
90d1cb221d Add documentation about logging before modules are loaded
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44513\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44472\fP to 2017.7
@ \fI2017\-11\-20 16:09:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44472\fP: (\fI\%mephi42\fP) nova: fix endpoint URL determination in _v3_setup() (refs: \fI\%#44513\fP)
.IP \(bu 2
a8044b73c3 Merge pull request \fI\%#44513\fP from rallytime/bp\-44472
.IP \(bu 2
6e00e415d3 nova: fix endpoint URL determination in _v3_setup()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44596\fP: (\fI\%roaldnefs\fP) Fixed Mattermost module documentation
@ \fI2017\-11\-19 23:30:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
f55b9daa63 Merge pull request \fI\%#44596\fP from roaldnefs/fix\-mattermost\-doc
.IP \(bu 2
549f4806ce Fixed documentation in Mattermost module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44528\fP: (\fI\%tkwilliams\fP) INFRA\-5978 \- fix for \fI\%https://github.com/saltstack/salt/issues/44290\fP
@ \fI2017\-11\-17 17:35:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
f84a2b5ab1 Merge pull request \fI\%#44528\fP from bodhi\-space/infra5978
.IP \(bu 2
ba1d57f5eb Merge branch \(aq2017.7\(aq into infra5978
.IP \(bu 2
021692b6c9 INFRA\-5978 \- pylint / whitespace fix
.IP \(bu 2
c2210aaf7c INFRA\-5978 \- fix for \fI\%https://github.com/saltstack/salt/issues/44290\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44537\fP: (\fI\%Ch3LL\fP) Add multiple salt\-ssh state integration tests
@ \fI2017\-11\-17 17:17:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
7f2dd0382c Merge pull request \fI\%#44537\fP from Ch3LL/ssh_highlow
.IP \(bu 2
b98df6de24 Add known_hosts_file to salt\-ssh opts_pkg in wfuncs
.IP \(bu 2
913eedc699 Add multiple salt\-ssh state integration tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44576\fP: (\fI\%rallytime\fP) Remove logging from top of napalm util file (refs: \fI\%#44588\fP)
@ \fI2017\-11\-17 14:55:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44439\fP: (\fI\%mirceaulinic\fP)  Adapt napalm modules to the new library structure (refs: \fI\%#44576\fP)
.IP \(bu 2
1975fb41bc Merge pull request \fI\%#44576\fP from rallytime/remove\-napalm\-logging
.IP \(bu 2
eb91af999e Remove logging from top of napalm util file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44575\fP: (\fI\%Ch3LL\fP) Add service.running integration state test
@ \fI2017\-11\-16 22:27:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
c2c3048f46 Merge pull request \fI\%#44575\fP from Ch3LL/ser_run_test
.IP \(bu 2
7536150567 Add service.running integration state test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44518\fP: (\fI\%twangboy\fP) Pass root_dir to the win_verify_env function
@ \fI2017\-11\-16 20:57:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
24b1d7af31 Merge pull request \fI\%#44518\fP from twangboy/win_fix_verify_env
.IP \(bu 2
47114fdb30 Pass root_dirs to the win_verify_env function
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
3385f7faf3 fix pylint
.IP \(bu 2
a2af3cb857 Include client mixin globals in scheduler for runner modules
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44551\fP: (\fI\%mirceaulinic\fP) Removes proxy minions false alarms and security risks
@ \fI2017\-11\-16 15:09:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
1643bb7fd4 Merge pull request \fI\%#44551\fP from cloudflare/annoying\-tmpnam
.IP \(bu 2
ce1882943d Use salt.utils.files.mkstemp() instead
.IP \(bu 2
6689bd3b2d Don\(aqt use dangerous os.tmpnam
.IP \(bu 2
2d6176b0bc Fx2 proxy minion: clean return, like all the other modules
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30454\fP: (\fI\%favoretti\fP) Using yaml serializer inside jinja template results in unicode being prepended by \(aq!!python/unicode\(aq (refs: \fI\%#30481\fP, \fI\%#42064\fP, \fI\%#38554\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44541\fP: (\fI\%terminalmage\fP) Fix test to reflect changes in YAML dumper
@ \fI2017\-11\-15 13:23:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42064\fP: (\fI\%The\-Loeki\fP) utils.jinja: use utils.yamldumper for safe yaml dumping (refs: \fI\%#44541\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38554\fP: (\fI\%multani\fP) Fix YAML deserialization of unicode (refs: \fI\%#42064\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30481\fP: (\fI\%basepi\fP) Add yaml_safe jinja filter (refs: \fI\%#38554\fP)
.IP \(bu 2
60083ac27b Merge pull request \fI\%#44541\fP from terminalmage/fix\-yaml\-test
.IP \(bu 2
5b8f54084b Merge branch \(aq2017.7\(aq into fix\-yaml\-test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44538\fP: (\fI\%gtmanfred\fP) Fix up some test kitchen stuff
@ \fI2017\-11\-14 20:36:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
5c123eb551 Merge pull request \fI\%#44538\fP from gtmanfred/kitchen
.IP \(bu 2
3e04d2d44c use kitchen\-sync for copying files
.IP \(bu 2
9bc70fd31b back up to 2017.7.1 for kitchen tests
.IP \(bu 2
3b93ea058b ubuntu 14 and centos 6 should not have py3 tests
.IP \(bu 2
958e1aeb8d Fix test to reflect changes in YAML dumper
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30454\fP: (\fI\%favoretti\fP) Using yaml serializer inside jinja template results in unicode being prepended by \(aq!!python/unicode\(aq (refs: \fI\%#30481\fP, \fI\%#42064\fP, \fI\%#38554\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42064\fP: (\fI\%The\-Loeki\fP) utils.jinja: use utils.yamldumper for safe yaml dumping (refs: \fI\%#44541\fP)
@ \fI2017\-11\-13 19:45:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38554\fP: (\fI\%multani\fP) Fix YAML deserialization of unicode (refs: \fI\%#42064\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30481\fP: (\fI\%basepi\fP) Add yaml_safe jinja filter (refs: \fI\%#38554\fP)
.IP \(bu 2
27a7b607b1 Merge pull request \fI\%#42064\fP from The\-Loeki/jinja_unicode
.IP \(bu 2
b1cf43c02d Merge branch \(aq2017.7\(aq into jinja_unicode
.IP \(bu 2
8c2ac58523 Merge branch \(aq2017.7\(aq into jinja_unicode
.IP \(bu 2
57dc6226a2 Merge branch \(aq2017.7\(aq into jinja_unicode
.IP \(bu 2
0a8346b585 Merge branch \(aq2017.7\(aq into jinja_unicode
.IP \(bu 2
393fe061b2 jinja utils: yaml import still necessary
.IP \(bu 2
3c9130f9f0 utils.jinja: use utils.yamldumper for safe yaml dumping
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43692\fP: (\fI\%mirceaulinic\fP) Addressing a bug in the network find runner
@ \fI2017\-11\-13 19:42:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
b1f14c7518 Merge pull request \fI\%#43692\fP from cloudflare/fix\-net\-runner
.IP \(bu 2
02ffb4f38e Merge branch \(aq2017.7\(aq into fix\-net\-runner
.IP \(bu 2
4b2f791bd2 Check if addr is short IPv6
.IP \(bu 2
765504c137 Add all the possible keys to the result
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42393\fP: (\fI\%The\-Loeki\fP) pillarenv ignored with Salt Master pillar_cache: True (refs: \fI\%#43689\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#36153\fP: (\fI\%krcroft\fP) Pillarenv doesn\(aqt allow using separate pillar environments (refs: \fI\%#43689\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43689\fP: (\fI\%The\-Loeki\fP) make cached pillars use pillarenv rather than saltenv
@ \fI2017\-11\-13 19:30:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
1e94a5bd5f Merge pull request \fI\%#43689\fP from The\-Loeki/cached_pilarenv
.IP \(bu 2
395c0c424d Merge branch \(aq2017.7\(aq into cached_pilarenv
.IP \(bu 2
60e001733b make cached pillars use pillarenv rather than saltenv
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43837\fP: (\fI\%twangboy\fP) Fix \fIunit.states.test_archive\fP for Windows
@ \fI2017\-11\-13 19:12:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
f9b273a894 Merge pull request \fI\%#43837\fP from twangboy/win_unit_test_archive
.IP \(bu 2
5505a8819a Merge branch \(aq2017.7\(aq into win_unit_test_archive
.IP \(bu 2
b1dfe9c3c8 Format patching with statements for easier reading
.IP \(bu 2
ba2f2eb788 Add Erik\(aqs changes
.IP \(bu 2
4ef1e3eb97 Fix \fIunit.states.test_archive\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44507\fP: (\fI\%Ch3LL\fP) Increase sleep timeout for pillar refresh test
@ \fI2017\-11\-13 18:29:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
caa81728a0 Merge pull request \fI\%#44507\fP from Ch3LL/pillar_time
.IP \(bu 2
ffa4bddcad Increase sleep timeout for pillar refresh test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44302\fP: (\fI\%morganwillcock\fP) Fix traceback and incorrect message when resolving an unresolvable SID
@ \fI2017\-11\-13 18:19:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
cffea5ac71 Merge pull request \fI\%#44302\fP from morganwillcock/badsid
.IP \(bu 2
f3af106e33 Merge branch \(aqbadsid\(aq of \fI\%https://github.com/morganwillcock/salt\fP into badsid
.INDENT 2.0
.IP \(bu 2
95733fbb3b Merge branch \(aq2017.7\(aq into badsid
.IP \(bu 2
facc2cd16e Merge branch \(aq2017.7\(aq into badsid
.UNINDENT
.IP \(bu 2
c7cf5f6f70 Format pywintypes.error
.IP \(bu 2
9572aabb67 Fix traceback and incorrect message when resolving an unresolvable SID
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44439\fP: (\fI\%mirceaulinic\fP)  Adapt napalm modules to the new library structure (refs: \fI\%#44576\fP)
@ \fI2017\-11\-13 17:43:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
32fc952000 Merge pull request \fI\%#44439\fP from cloudflare/fix\-napalm
.IP \(bu 2
f45378af04 Lint: remove extra spaces
.IP \(bu 2
c6a38258a3 Add napalm>2.0.0 note and update URLs
.IP \(bu 2
52f73835b8 Adapt napalm modules to the new library structure
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44457\fP: (\fI\%twangboy\fP) Remove wmi monkeypatching
@ \fI2017\-11\-13 17:38:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
ebbe5949ea Merge pull request \fI\%#44457\fP from twangboy/win_remove_wmi_monkeypatching
.IP \(bu 2
6c872e95e6 Add back the setup_loader_modules function
.IP \(bu 2
20273e3697 No need for setup_loader_modules since we\(aqre actually importing wmi
.IP \(bu 2
8c107873cd Remove wmi monkeypatching
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44490\fP: (\fI\%Ch3LL\fP) Enable test_deploy ssh test
@ \fI2017\-11\-13 17:12:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
1da1a97d7d Merge pull request \fI\%#44490\fP from Ch3LL/ssh_ping
.IP \(bu 2
e952cd6712 Enable test_deploy ssh test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44491\fP: (\fI\%Ch3LL\fP) Add salt\-ssh raw integration tests
@ \fI2017\-11\-13 15:47:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
18624d6798 Merge pull request \fI\%#44491\fP from Ch3LL/ssh_raw
.IP \(bu 2
3dc8673417 change class name to raw
.IP \(bu 2
308596ac8d Add salt\-ssh raw integration tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44492\fP: (\fI\%twangboy\fP) Fix \fIunit.utils.test_cloud\fP for Windows
@ \fI2017\-11\-13 15:44:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
aa17bfa8e7 Merge pull request \fI\%#44492\fP from twangboy/win_skip_mode_check
.IP \(bu 2
2f30ad93b1 Skips mode check in Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44484\fP: (\fI\%Ch3LL\fP) Add orchestration tests when target exists or not
@ \fI2017\-11\-10 19:24:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b95495e75 Merge pull request \fI\%#44484\fP from Ch3LL/orch_test
.IP \(bu 2
f3ec6df76e Add orchestration tests when target exists or not
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44480\fP: (\fI\%Ch3LL\fP) Add integration pillar command line test
@ \fI2017\-11\-10 19:14:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
62c42ca6fb Merge pull request \fI\%#44480\fP from Ch3LL/override_pillar
.IP \(bu 2
12fed1b4d8 Add integration pillar command line test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44317\fP: (\fI\%Ch3LL\fP) Add state tests and state request system to salt\-ssh
@ \fI2017\-11\-10 18:28:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
cc08ad2edc Merge pull request \fI\%#44317\fP from Ch3LL/ssh_test
.IP \(bu 2
46bce3bd5e add additional parser argument for ssh integration tests
.IP \(bu 2
e9231430b5 remove logic similar to cloud/proxy tests
.IP \(bu 2
c731eb8ea6 add ssh dir to test runner when \-\-ssh\-tests set
.IP \(bu 2
8089a885c2 add wipe function to other run_ssh method
.IP \(bu 2
200b12ae6a change versionadded salt version
.IP \(bu 2
e3ebb5e9b3 fix comment and variables
.IP \(bu 2
faef0886a7 Add state tests and state request system to salt\-ssh
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44478\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-11\-10 18:00:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
6669035a30 Merge pull request \fI\%#44478\fP from rallytime/merge\-2017.7
.IP \(bu 2
9fcc2a70b5 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
a66cd67d15 Merge pull request \fI\%#44260\fP from seanjnkns/issue\-39901
.INDENT 2.0
.IP \(bu 2
ed8cccf457 \fI\%#39901\fP: Fix pylint
.IP \(bu 2
43c81dfdee \fI\%#39901\fP: Add unit tests
.IP \(bu 2
613d500876 Merge branch \(aq2016.11\(aq into issue\-39901
.IP \(bu 2
b97e8046ca Utilize salt.utils.validate.net.* and _raise_error_iface
.IP \(bu 2
6818f3631d Fixes \fI\%#39901\fP for RH/CentOS 7
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44444\fP: (\fI\%twangboy\fP) LGPO: Issue with Maximum Password Age
@ \fI2017\-11\-10 17:26:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
60719d0683 Merge pull request \fI\%#44444\fP from twangboy/win_lgpo_non_zero
.IP \(bu 2
de6b394445 Remove unneeded functions
.IP \(bu 2
ee0914f7e9 Fix some lint, remove unnecessary function
.IP \(bu 2
d52a7c12db Fix typo in PasswordComplexity policy
.IP \(bu 2
44f8f43812 Fix problem where 0 isn\(aqt 0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44467\fP: (\fI\%twangboy\fP) Fix \fIunit.test_doc\fP for Windows
@ \fI2017\-11\-10 15:21:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
4f3a79df07 Merge pull request \fI\%#44467\fP from twangboy/win_fix_test_doc
.IP \(bu 2
0a9e862bf4 Use regex to split
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44443\fP: (\fI\%Ch3LL\fP) Add salt\-ssh grains.items test
@ \fI2017\-11\-09 00:42:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
ff4f13877f Merge pull request \fI\%#44443\fP from Ch3LL/ssh_grains
.IP \(bu 2
5d1a9af4b5 Add salt\-ssh grains.items test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44429\fP: (\fI\%Ch3LL\fP) Fix orch doc from pillat.get to pillar.get
@ \fI2017\-11\-07 23:06:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
dcdf2d4c90 Merge pull request \fI\%#44429\fP from Ch3LL/orch_doc
.IP \(bu 2
38ca5520f0 Fix orch doc from pillat.get to pillar.get
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42568\fP: (\fI\%clallen\fP) Orchestration runner doesn\(aqt populate __pillar__ based on pillarenv (refs: \fI\%#43817\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43817\fP: (\fI\%The\-Loeki\fP) Orchestrate runner forces pillarenv and saltenv to None
@ \fI2017\-11\-07 06:00:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
62c4addef8 Merge pull request \fI\%#43817\fP from The\-Loeki/orch\-pillarenv
.IP \(bu 2
3fd652623c orchestrate runner: retain default envs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44408\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-11\-06 15:53:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
9e4708b7b9 Merge pull request \fI\%#44408\fP from rallytime/merge\-2017.7
.IP \(bu 2
edbbd5fc2b Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
5e289f42ba Merge pull request \fI\%#44383\fP from gtmanfred/2016kitchen
.INDENT 2.0
.IP \(bu 2
b65f4ea4ea switch salt\-jenkins over to saltstack
.UNINDENT
.IP \(bu 2
cab54e34b5 Merge pull request \fI\%#44173\fP from twangboy/win_system_docs
.INDENT 2.0
.IP \(bu 2
8e111b413d Fix some of the wording and grammar errors
.IP \(bu 2
a12bc5ae41 Use google style docstrings
.UNINDENT
.IP \(bu 2
7aaea1d179 Merge pull request \fI\%#44304\fP from jfindlay/cron_id
.INDENT 2.0
.IP \(bu 2
cc038c5bec states.cron identifier defaults to name
.UNINDENT
.IP \(bu 2
e4dbbde734 Merge pull request \fI\%#44322\fP from rossengeorgiev/saltssh\-docs\-update
.INDENT 2.0
.IP \(bu 2
b18f2e5a6d fix program name and description for \-\-static
.IP \(bu 2
5b10918f02 updated CLI docs for salt\-ssh
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44358\fP: (\fI\%The\-Loeki\fP) Kubernetes client certificate file usage fix
@ \fI2017\-11\-03 21:51:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
b11da0d2da Merge pull request \fI\%#44358\fP from The\-Loeki/kube\-client\-cert\-file
.IP \(bu 2
35a8b0bb38 Kubernetes client certificate file usage fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44347\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-11\-03 21:48:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
1974e52c06 Merge pull request \fI\%#44347\fP from rallytime/merge\-2017.7
.IP \(bu 2
9bad04b94b Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
4e6f09e3eb Merge pull request \fI\%#44345\fP from gtmanfred/2016kitchen
.INDENT 2.0
.IP \(bu 2
79b8b2d0bf remove binding
.UNINDENT
.IP \(bu 2
209847c8c2 Merge pull request \fI\%#44342\fP from gtmanfred/2016kitchen
.INDENT 2.0
.IP \(bu 2
c50508f0b7 render template files platforms.yml and driver.yml
.UNINDENT
.IP \(bu 2
1be65224cb Merge pull request \fI\%#44339\fP from corywright/issue\-44336\-fix\-archive\-tar\-docs\-2016\-11
.INDENT 2.0
.IP \(bu 2
9c1c35a59f Remove leading dash (\-) from options in archive.tar documentation
.UNINDENT
.IP \(bu 2
bebc33daf5 Merge pull request \fI\%#44295\fP from HeinleinSupport/issue44272
.INDENT 2.0
.IP \(bu 2
f972715a45 fixes issue \fI\%#44272\fP
.UNINDENT
.IP \(bu 2
e7ca9f8407 Merge pull request \fI\%#44286\fP from gtmanfred/2016.11
.INDENT 2.0
.IP \(bu 2
193e715e37 use our git repo for kitchen\-salt
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44364\fP: (\fI\%Ch3LL\fP) Include disk size check for test_spm_build_big_file test
@ \fI2017\-11\-01 13:57:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
aea9f4a115 Merge pull request \fI\%#44364\fP from Ch3LL/fix_size_test
.IP \(bu 2
952c6bfea4 Include file size check for test_spm_build_big_file test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44239\fP: (\fI\%boltronics\fP) \-\-progress fails when hosts routed via syndic (refs: \fI\%#44273\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44273\fP: (\fI\%DmitryKuzmenko\fP) Workaround progressbar failure if minion is behind syndic.
@ \fI2017\-10\-31 17:07:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
609de9367a Merge pull request \fI\%#44273\fP from DSRCorporation/bugs/44239_syndic_progress
.IP \(bu 2
e1a7605623 Workaround progressbar failure if minion is behind syndic.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44350\fP: (\fI\%gtmanfred\fP) update salt\-jenkins repo to 2017.7
@ \fI2017\-10\-30 21:31:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
eef6dbfa58 Merge pull request \fI\%#44350\fP from gtmanfred/2017.7
.IP \(bu 2
cf71e3d9f2 update salt\-jenkins repo to 2017.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44346\fP: (\fI\%gtmanfred\fP) remove binding from erb template rendering (2017.7)
@ \fI2017\-10\-30 20:57:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
d586b3bf97 Merge pull request \fI\%#44346\fP from gtmanfred/2017.7
.IP \(bu 2
bf577c3d8b remove binding
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44343\fP: (\fI\%gtmanfred\fP) render template files platforms.yml and driver.yml (2017.7)
@ \fI2017\-10\-30 20:04:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
547aac6658 Merge pull request \fI\%#44343\fP from gtmanfred/2017.7
.IP \(bu 2
ec24fbc0c2 render template files platforms.yml and driver.yml
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44336\fP: (\fI\%corywright\fP) Docs for archive.tar should not use leading dash for tar options (refs: \fI\%#44339\fP, \fI\%#44338\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44338\fP: (\fI\%corywright\fP) Remove leading dash from options in archive.tar docs (2017.7 and develop)
@ \fI2017\-10\-30 18:59:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
6e2a74c18b Merge pull request \fI\%#44338\fP from corywright/issue\-44336\-fix\-archive\-tar\-docs\-2017\-7\-and\-newer
.IP \(bu 2
49b0abc284 Remove leading dash (\-) from options in archive.tar documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44265\fP: (\fI\%Ch3LL\fP)  Add service.status integration test
@ \fI2017\-10\-30 15:00:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
71923bed97 Merge pull request \fI\%#44265\fP from Ch3LL/service_test
.IP \(bu 2
716aabc0bf Merge branch \(aq2017.7\(aq into service_test
.IP \(bu 2
dd5c823210 remove skipIf import
.IP \(bu 2
ff92f31cbe remove skipif for docker
.IP \(bu 2
c13f37eee4 change service name depending on os
.IP \(bu 2
980c43ebc9 change skip message check to docker
.IP \(bu 2
3955537609 change skip if check to docker
.IP \(bu 2
aa8875a0e2 change service name to docker
.IP \(bu 2
654071028b change service to crond
.IP \(bu 2
7911b4b3eb Add service.status integration test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44294\fP: (\fI\%nasenbaer13\fP) Boto asg fixes, Backport of \fI\%#43858\fP
@ \fI2017\-10\-30 14:48:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43858\fP: (\fI\%nasenbaer13\fP) Boto_ASG fixes for scaling policy rate limiting and tag conversion (refs: \fI\%#44294\fP)
.IP \(bu 2
8ae9769bfb Merge pull request \fI\%#44294\fP from eyj/boto_asg
.IP \(bu 2
f5ad6aeb70 Debug log added when throttled by API
.IP \(bu 2
c05d9aeced Encode tags as utf\-8, retry policy readout
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44312\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44287\fP to 2017.7
@ \fI2017\-10\-30 14:25:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44287\fP: (\fI\%jf\fP) Fix utils.files.guess_archive_type to recognize the \(dqtbz\(dq extension as well (refs: \fI\%#44312\fP)
.IP \(bu 2
68a9bebf90 Merge pull request \fI\%#44312\fP from rallytime/bp\-44287
.IP \(bu 2
4d02e61f97 Merge branch \(aq2017.7\(aq into bp\-44287
.IP \(bu 2
ba0eaae95e Fix utils.files.guess_archive_type to recognize the \(dqtbz\(dq extension as well (also tidy up list of extensions)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44258\fP: (\fI\%oarmstrong\fP) docker_container.running recreates containers with multiple links (refs: \fI\%#44262\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44311\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44262\fP to 2017.7
@ \fI2017\-10\-30 14:25:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44262\fP: (\fI\%oarmstrong\fP) docker_container.running sort list of links (refs: \fI\%#44311\fP)
.IP \(bu 2
b8854e27c0 Merge pull request \fI\%#44311\fP from rallytime/bp\-44262
.IP \(bu 2
72d617cfbe Merge branch \(aq2017.7\(aq into bp\-44262
.IP \(bu 2
ae34a15503 docker_container.running sort list of links
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44314\fP: (\fI\%gtmanfred\fP) update .kitchen.yml to run py3 tests too
@ \fI2017\-10\-30 14:23:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
48df79ef77 Merge pull request \fI\%#44314\fP from gtmanfred/2017.7
.IP \(bu 2
54265769c4 Merge branch \(aq2017.7\(aq into 2017.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44316\fP: (\fI\%rallytime\fP) Fix lint failure on 2017.7 branch
@ \fI2017\-10\-27 18:36:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
dbc5e224e9 Merge pull request \fI\%#44316\fP from rallytime/fix\-lint
.IP \(bu 2
6d2490f6a0 Fix lint failure on 2017.7 branch
.IP \(bu 2
39262b625e update .kitchen.yml to run py3 tests too
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44279\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-10\-27 16:17:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
b2b0c770a4 Merge pull request \fI\%#44279\fP from rallytime/merge\-2017.7
.IP \(bu 2
8237f45a46 Add print_function to __future__ import list
.IP \(bu 2
055b0701de Lint fix from sloppy merge conflict resolution
.IP \(bu 2
1c3cb5c6a4 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
8a1ea165af Merge pull request \fI\%#44259\fP from gtmanfred/2016.11
.INDENT 2.0
.IP \(bu 2
56a3ad8f68 fix pylint comments
.IP \(bu 2
4add666db1 add comment to Gemfile and move copyartifacts
.IP \(bu 2
b4c8f7eb57 fix pylint
.IP \(bu 2
392fd4f837 try newest salttesting
.IP \(bu 2
79251287d0 add logging
.IP \(bu 2
38963d5a82 use transport if not set in state_file
.IP \(bu 2
10e309a64f which vagrant should go to stderr
.IP \(bu 2
9307564de0 fix output columns
.IP \(bu 2
2da22f87e1 test opennebula
.IP \(bu 2
9f38f16905 add opennebula to Gemfile
.IP \(bu 2
7465f9b27a add script for copying back artifacts
.IP \(bu 2
255118cfd7 run tests with kitchen
.UNINDENT
.IP \(bu 2
9d6bc8509b Merge pull request \fI\%#44268\fP from twangboy/win_fix_lgpo_typo
.INDENT 2.0
.IP \(bu 2
a6a4c10a77 Fix typo
.UNINDENT
.IP \(bu 2
0beb65a283 Merge pull request \fI\%#44269\fP from terminalmage/fix\-log\-message
.INDENT 2.0
.IP \(bu 2
bc9cd65496 Fix log message in salt.utils.gitfs
.UNINDENT
.IP \(bu 2
304dd2529d Merge pull request \fI\%#44160\fP from gtmanfred/directory
.INDENT 2.0
.IP \(bu 2
a7d3d668f4 missed removing changes in the next test
.IP \(bu 2
ac0b5ec440 fix test
.IP \(bu 2
d3d00c3e62 add changes to test return
.UNINDENT
.IP \(bu 2
e10395483d Merge pull request \fI\%#44205\fP from rallytime/bp\-44177
.INDENT 2.0
.IP \(bu 2
b9940f8521 Fixing default redis.host in documentation
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44291\fP: (\fI\%Ch3LL\fP) add saltutil.refresh_pillar test
@ \fI2017\-10\-27 15:19:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd5b9dd0aa Merge pull request \fI\%#44291\fP from Ch3LL/pillar_test
.IP \(bu 2
34e2955445 add saltutil.refresh_pillar test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44267\fP: (\fI\%twangboy\fP) Fix type and Py3 issues in LGPO module
@ \fI2017\-10\-27 14:27:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
ba17a1c4d0 Merge pull request \fI\%#44267\fP from twangboy/win_fix_lgpo
.IP \(bu 2
5d22d34cac Use unicode_literals
.IP \(bu 2
40636397d8 Fix set for Py3
.IP \(bu 2
8f8c706426 Fix typo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44285\fP: (\fI\%Ch3LL\fP) add spm integration tests for remove and build
@ \fI2017\-10\-26 21:20:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
e16707c403 Merge pull request \fI\%#44285\fP from Ch3LL/all_spm
.IP \(bu 2
1f77f3e6a3 add skipif logic for fallocate cmd
.IP \(bu 2
03b5c4bc6d add spm integration tests for remove and build
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44301\fP: (\fI\%twangboy\fP) Fix test_pydsl on Windows
@ \fI2017\-10\-26 21:14:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
6392896a22 Merge pull request \fI\%#44301\fP from twangboy/win_fix_test_pydsl
.IP \(bu 2
6db23757bc Fix test_pydsl on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44293\fP: (\fI\%UtahDave\fP) Fix documentation grammar and spelling errors
@ \fI2017\-10\-26 13:05:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
8787d02688 Merge pull request \fI\%#44293\fP from UtahDave/fix_unittest_docs
.IP \(bu 2
c919648ab4 Fix documentation grammar and spelling errors
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44248\fP: (\fI\%Ch3LL\fP) SPM tests: use _spm_build_files method during test_build setup
@ \fI2017\-10\-25 19:45:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
6e33743c1a Merge pull request \fI\%#44248\fP from Ch3LL/spm_create_repo
.IP \(bu 2
0a387c2ecd fix pylint
.IP \(bu 2
f383f05a93 Add SPM create_repo integration test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44253\fP: (\fI\%Ch3LL\fP) Add multiple spm integration tests
@ \fI2017\-10\-25 13:36:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd75be24ca Merge pull request \fI\%#44253\fP from Ch3LL/spm_install
.IP \(bu 2
9e2e785034 add spm tests to test runner
.IP \(bu 2
4729ccd32b Add multiple spm integration tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44254\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_win_groupadd\fP for Windows
@ \fI2017\-10\-25 13:33:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
75ee1ebc50 Merge pull request \fI\%#44254\fP from twangboy/win_fix_test_win_groupadd
.IP \(bu 2
609361bf48 Fix some lint errors
.IP \(bu 2
1f44d8d5e6 Document helper functions
.IP \(bu 2
b0caec320e Move _get_all_groups up to the top
.IP \(bu 2
7a3ff9387d Mock the rest of the tests
.IP \(bu 2
5ce14df82c Change how members are retrieved in win_groupadd
.IP \(bu 2
6ab82394be Set up mocking
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44266\fP: (\fI\%Ch3LL\fP) Add state, grains and service proxy tests
@ \fI2017\-10\-25 13:08:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
4c23fa63bb Merge pull request \fI\%#44266\fP from Ch3LL/proxy_tests
.IP \(bu 2
e5701b472d Add state, grains and service proxy tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43187\fP: (\fI\%mirceaulinic\fP) How to point from an execution module that a certain function failed (refs: \fI\%#44244\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44244\fP: (\fI\%mirceaulinic\fP) Add explicit non\-zero retcode to napalm config functions
@ \fI2017\-10\-24 09:23:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
c849f350ba Merge pull request \fI\%#44244\fP from cloudflare/add\-retcode
.IP \(bu 2
a1f27c9f00 Add explicit non\-zero retcode to napalm config functions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44227\fP: (\fI\%rklaren\fP) salt\-cloud leaves a broken vm around when the salt bootstrap fails (refs: \fI\%#44228\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44228\fP: (\fI\%rklaren\fP) Fixes \fI\%#44227\fP, make salt\-cloud/libvirt cleanup after errors more robust
@ \fI2017\-10\-23 17:09:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
195b225540 Merge pull request \fI\%#44228\fP from rklaren/fix\-salt\-cloud\-libvirt\-cleanup\-after\-errors
.IP \(bu 2
7917d1e61e Incorporate review comments.
.IP \(bu 2
3a10b6aef1 Fixes \fI\%#44227\fP, make salt\-cloud/libvirt cleanup after errors more robust
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19532\fP: (\fI\%stolendog\fP) salt\-ssh running git clone with not root user (refs: \fI\%#43769\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#10582\fP: (\fI\%mtorromeo\fP) Git ssh helper may be unable run (refs: \fI\%#43769\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44008\fP: (\fI\%mtorromeo\fP) Backport \fI\%#43769\fP to 2017.7
@ \fI2017\-10\-23 14:19:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43769\fP: (\fI\%mtorromeo\fP) Copy git ssh\-id\-wrapper to /tmp only if necessary (Fixes \fI\%#10582\fP, \fI\%#19532\fP) (refs: \fI\%#44008\fP)
.IP \(bu 2
01e7bab990 Merge pull request \fI\%#44008\fP from mtorromeo/git\-noexec\-fix
.IP \(bu 2
a7a841d9d2 Merge branch \(aq2017.7\(aq into git\-noexec\-fix
.IP \(bu 2
d177240cfc Merge branch \(aq2017.7\(aq into git\-noexec\-fix
.IP \(bu 2
a63e6ca963 Copy git ssh\-id\-wrapper to /tmp only if necessary (Fixes \fI\%#10582\fP, Fixes \fI\%#19532\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44202\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-10\-23 14:18:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
85c0ef493f Merge pull request \fI\%#44202\fP from rallytime/merge\-2017.7
.IP \(bu 2
99ff7a5c12 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
09ddfd0c08 Merge pull request \fI\%#44167\fP from garethgreenaway/44140_debian_ip_fixes
.INDENT 2.0
.IP \(bu 2
5f7555846f When looping through the various pre, post, up and down commands put them into the interface dict using the right internet family variable.
.UNINDENT
.IP \(bu 2
9f9e936b52 Merge pull request \fI\%#43830\fP from rallytime/bp\-43644
.INDENT 2.0
.IP \(bu 2
12845ae802 Several fixes for RDS DB parameter group management
.UNINDENT
.IP \(bu 2
07db6a3d8b Merge pull request \fI\%#43994\fP from oeuftete/fix\-manage\-runner\-presence
.INDENT 2.0
.IP \(bu 2
f3980d7d83 Fix manage.present to show lost minions
.UNINDENT
.IP \(bu 2
a07537e258 Merge pull request \fI\%#44188\fP from terminalmage/issue44150
.INDENT 2.0
.IP \(bu 2
0692f442db yumpkg: Check pkgname instead of name to see if it is a kernel pkg
.UNINDENT
.IP \(bu 2
715edc0cea Merge pull request \fI\%#44158\fP from rallytime/bp\-44089
.INDENT 2.0
.IP \(bu 2
534faf0b7a Catch on empty Virtualbox network addr \fI\%#43427\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44208\fP: (\fI\%twangboy\fP) Fix some lint in PR: 44080
@ \fI2017\-10\-20 16:42:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
d7dc2bd0e8 Merge pull request \fI\%#44208\fP from twangboy/win_fix_group.present
.IP \(bu 2
61e2e9ccda Fix some lint
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43843\fP: (\fI\%twangboy\fP) Fix \fIunit.states.test_mount\fP for Windows
@ \fI2017\-10\-20 14:27:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
c6d27ada51 Merge pull request \fI\%#43843\fP from twangboy/win_unit_test_mount
.IP \(bu 2
a862e0bf2d Remove unneeded import
.IP \(bu 2
d78f27466d Fix \fIunit.states.test_mount\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44111\fP: (\fI\%anlutro\fP) Try to correctly parse debian codename from /etc/os\-release
@ \fI2017\-10\-19 22:23:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
372820ea38 Merge pull request \fI\%#44111\fP from alprs/fix\-deb8\-py3\-oscodename
.IP \(bu 2
1e1e5a3ff6 try to correctly parse debian codename from /etc/os\-release
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44187\fP: (\fI\%twangboy\fP) Fix pickling errors on Windows
@ \fI2017\-10\-19 20:36:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
75136152c1 Merge pull request \fI\%#44187\fP from twangboy/win_fix_unit_test_daemons.py
.IP \(bu 2
64d2e4f732 Fix pickling errors on Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44181\fP: (\fI\%jonans\fP) Scheduler with multiple when values doesn\(aqt run (refs: \fI\%#44186\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44186\fP: (\fI\%garethgreenaway\fP) [2017.7] scheduler fixes
@ \fI2017\-10\-19 20:36:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
7a89cd8697 Merge pull request \fI\%#44186\fP from garethgreenaway/44181_scheduler_multiple_whens
.IP \(bu 2
7eef3b3571 Adding a copy.deepcopy to the for loop that looks for old jobs to avoid stale jobs ending up in the list.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43896\fP: (\fI\%twangboy\fP) Fix win_lgpo execution module
@ \fI2017\-10\-19 20:13:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
1d16ae8ba7 Merge pull request \fI\%#43896\fP from twangboy/win_fix_lgpo_scom
.IP \(bu 2
648d1b8d99 Catch CommandExecutionError
.IP \(bu 2
0040082d0a Fix pylint error
.IP \(bu 2
91258cd6a8 Fix typo
.IP \(bu 2
261dba347d Put the file.remove in a try/except/else block
.IP \(bu 2
020c2a2b85 Fix syntax error
.IP \(bu 2
d5bec99126 Fix some lint
.IP \(bu 2
b96186d60d Fix INSTALL_LANGUAGE
.IP \(bu 2
5471bd521f Fix problem with file handle
.IP \(bu 2
5ec58c6200 Use System Install Language as default fallback
.IP \(bu 2
f9ad446019 Fix win_lgpo execution module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44080\fP: (\fI\%twangboy\fP) Fix a regression in \fIgroup.present\fP in Windows
@ \fI2017\-10\-19 20:10:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
98356b86af Merge pull request \fI\%#44080\fP from twangboy/win_fix_group.present
.IP \(bu 2
29bc80ff87 Improve get_sam_name
.IP \(bu 2
ef759a3875 Fix example in function docs for get_sam_name
.IP \(bu 2
43740c5fed Document 15 character limit
.IP \(bu 2
83f36cc2ef Account for 15 character limit in hostname
.IP \(bu 2
aa278966de Remove *args, pass gid as a keyword
.IP \(bu 2
5230ecd7e1 Accept *args
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44171\fP: (\fI\%Ch3LL\fP) Add SPM Build Integration Tests
@ \fI2017\-10\-19 19:49:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
5ef124bf2d Merge pull request \fI\%#44171\fP from Ch3LL/spm_int
.IP \(bu 2
cd79e9444e remove unneded kwarg
.IP \(bu 2
1541376c4f Add spm build test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44157\fP: (\fI\%benediktwerner\fP) Added \(aqversionadded\(aq tags to sensehat modules
@ \fI2017\-10\-19 14:13:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
34a843252d Merge pull request \fI\%#44157\fP from benediktwerner/2017.7
.IP \(bu 2
bd825b51cc Changed sensehat versionadded from 2017.7 to 2017.7.0
.IP \(bu 2
f1d3c5bbcf Added \(aqversionadded\(aq tags to sensehat modules
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44164\fP: (\fI\%terminalmage\fP) Fix examples in docker_container.{stopped,absent} docstrings
@ \fI2017\-10\-19 14:12:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
1427c72e1e Merge pull request \fI\%#44164\fP from terminalmage/fix\-docker\-docstring
.IP \(bu 2
7b46489e33 Fix examples in docker_container.{stopped,absent} docstrings
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44168\fP: (\fI\%twangboy\fP) Fix \fIunit.test_auth\fP for Windows
@ \fI2017\-10\-19 14:12:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
77969c4161 Merge pull request \fI\%#44168\fP from twangboy/win_skip_pam_eath
.IP \(bu 2
bb1d2eb85b Skip tests that are failing on PAM eauth
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44151\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-10\-18 16:52:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
88a776d9d2 Merge pull request \fI\%#44151\fP from rallytime/merge\-2017.7
.IP \(bu 2
6aa8f03a4a Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
0cd493b691 Merge pull request \fI\%#44131\fP from rallytime/bp\-44029
.INDENT 2.0
.IP \(bu 2
bebf301976 fixed test addressing issue \fI\%#43307\fP, disk.format_ to disk.format
.IP \(bu 2
b4ba7ae2fc addresses issue \fI\%#43307\fP, disk.format_ to disk.format
.UNINDENT
.IP \(bu 2
3a68e356f8 Merge pull request \fI\%#44093\fP from gtmanfred/fix\-44087
.INDENT 2.0
.IP \(bu 2
5455c5053b fix pylint
.IP \(bu 2
f749cafa25 don\(aqt filter if return is not a dict
.UNINDENT
.IP \(bu 2
c785d7a847 Merge pull request \fI\%#44122\fP from cachedout/gpg_pr_template
.INDENT 2.0
.IP \(bu 2
e41e3d76be Typo fix
.IP \(bu 2
37c7980880 Add note about GPG signing to PR template
.UNINDENT
.IP \(bu 2
bf90ea1f51 Merge pull request \fI\%#44124\fP from rallytime/merge\-2016.11
.INDENT 2.0
.IP \(bu 2
59861291c8 Merge branch \(aq2016.11.8\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
57623e2abe Merge pull request \fI\%#44028\fP from rallytime/bp\-44011
.INDENT 2.0
.IP \(bu 2
89e084bda3 Do not allow IDs with null bytes in decoded payloads
.IP \(bu 2
206ae23f15 Don\(aqt allow path separators in minion ID
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
13f3ffa83a Merge pull request \fI\%#44097\fP from gtmanfred/openneb
.INDENT 2.0
.IP \(bu 2
c29655b2c2 Merge branch \(aq2016.11\(aq into openneb
.IP \(bu 2
bd2490b149 OpenNebula does not require the template_id to be specified
.UNINDENT
.IP \(bu 2
ac3e4df964 Merge pull request \fI\%#44110\fP from roaldnefs/fix\-doc\-local\-returner
.INDENT 2.0
.IP \(bu 2
efd58f7594 Merge branch \(aq2016.11\(aq into fix\-doc\-local\-returner
.IP \(bu 2
881f1822f2 Format fix code example local returner doc
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43918\fP: (\fI\%mwerickso\fP) subset argument does not work with saltmod.state (refs: \fI\%#43933\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43933\fP: (\fI\%gtmanfred\fP) if expect_minions is passed use that instead
@ \fI2017\-10\-18 16:43:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
0b47eb7242 Merge pull request \fI\%#43933\fP from gtmanfred/2017.7
.IP \(bu 2
272dcc6ba5 add inline comment about popping expect_minions
.IP \(bu 2
b615ce1762 if expect_minions is passed use that instead
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44081\fP: (\fI\%skizunov\fP) Windows: Fix usage of pkgrepo state
@ \fI2017\-10\-18 16:16:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
36da1a7fac Merge pull request \fI\%#44081\fP from skizunov/develop3
.IP \(bu 2
351d16840b Move strip_uri to salt/utils/pkg/deb.py
.IP \(bu 2
f54c7a6f01 Windows: Fix usage of pkgrepo state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43913\fP: (\fI\%twangboy\fP) Fix \fIunit.templates.test_jinja\fP for Windows
@ \fI2017\-10\-17 21:09:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
afcaa0c591 Merge pull request \fI\%#43913\fP from twangboy/win_fix_test_jinja
.IP \(bu 2
a4e2d8059d Fix \fIunit.templates.test_jinja\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43917\fP: (\fI\%twangboy\fP) Fix \fIunit.test_pillar\fP for Windows
@ \fI2017\-10\-17 21:06:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc5754c6a1 Merge pull request \fI\%#43917\fP from twangboy/win_unit_test_pillar
.IP \(bu 2
00dbba5712 Fix \fIunit.test_pillar\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44133\fP: (\fI\%cachedout\fP) Fix typos in parallel states docs
@ \fI2017\-10\-17 15:24:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
6252f82f58 Merge pull request \fI\%#44133\fP from cachedout/fix_parallel_docs
.IP \(bu 2
8d1c1e21f0 Fix typos in parallel states docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44135\fP: (\fI\%timfreund\fP) Insert missing verb in gitfs walkthrough
@ \fI2017\-10\-17 14:32:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d3f5db867 Merge pull request \fI\%#44135\fP from timfreund/insert_missing_verb
.IP \(bu 2
9557504b75 Insert missing verb in gitfs walkthrough
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44055\fP: (\fI\%nasenbaer13\fP) Activate jid_queue also for SingleMinions to workaround (Backport)
@ \fI2017\-10\-16 20:14:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43860\fP: (\fI\%nasenbaer13\fP) Activate jid_queue also for SingleMinions (occurs on reconnect) (refs: \fI\%#44055\fP)
.IP \(bu 2
a9700f6061 Merge pull request \fI\%#44055\fP from eyj/jid_queue
.IP \(bu 2
4bdd5bbf6b Merge branch \(aq2017.7\(aq into jid_queue
.IP \(bu 2
facef2227d Merge branch \(aq2017.7\(aq into jid_queue
.IP \(bu 2
2fedcec6bb Merge branch \(aq2017.7\(aq into jid_queue
.IP \(bu 2
255aa94c64 Activate jid_queue also for SingleMinions to workaround 0mq reconnection issues
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44125\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.2 to 2017.7
@ \fI2017\-10\-16 20:02:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
2fba45cd3f Merge pull request \fI\%#44125\fP from rallytime/merge\-2017.7
.IP \(bu 2
c4ae4a6b50 Merge branch \(aq2017.7.2\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
5d719a2219 Merge pull request \fI\%#44027\fP from rallytime/bp\-44012
.IP \(bu 2
f7824e41f3 Don\(aqt allow path separators in minion ID
.IP \(bu 2
44060dc9c1 Do not allow IDs with null bytes in decoded payloads
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43307\fP: (\fI\%marek\-knappe\fP) Filesystem creation is failing on newly created LV (refs: \fI\%#44029\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44029\fP: (\fI\%msummers42\fP) addresses issue \fI\%#43307\fP, disk.format_ to disk.format (refs: \fI\%#44131\fP)
@ \fI2017\-10\-16 19:59:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
68974aa74d Merge pull request \fI\%#44029\fP from msummers42/2017.7
.IP \(bu 2
16e1c1dfc8 fixed test addressing issue \fI\%#43307\fP, disk.format_ to disk.format
.IP \(bu 2
3d597db51c Merge branch \(aq2017.7\(aq into 2017.7
.IP \(bu 2
18fb0be96a addresses issue \fI\%#43307\fP, disk.format_ to disk.format
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44079\fP: (\fI\%skizunov\fP) opkg: Fix usage with pkgrepo.managed
@ \fI2017\-10\-16 19:58:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0bbe65ffa Merge pull request \fI\%#44079\fP from skizunov/develop2
.IP \(bu 2
0614d1af30 Merge branch \(aq2017.7\(aq into develop2
.IP \(bu 2
b6b12fe495 opkg: Fix usage with pkgrepo.managed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44090\fP: (\fI\%pratik705\fP) Fix create_attach_volumes salt\-cloud action for gcp
@ \fI2017\-10\-16 19:04:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
22a8253595 Merge pull request \fI\%#44090\fP from pratik705/fix\-create_attach_volumes_salt\-cloud_action\-GCP
.IP \(bu 2
3eefd334c5 Fixed \(dqcreate_attach_volumes\(dq salt\-cloud action for GCP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44121\fP: (\fI\%benediktwerner\fP) Fixed code snippet in unit testing documentation
@ \fI2017\-10\-16 18:28:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
888e5f51a2 Merge pull request \fI\%#44121\fP from benediktwerner/2017.7
.IP \(bu 2
1319c822bd Fixed code snippet in unit testing doc
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44098\fP: (\fI\%twangboy\fP) Return multiprocessing queue in LogSetupMock class
@ \fI2017\-10\-16 18:14:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
9fe94d7843 Merge pull request \fI\%#44098\fP from twangboy/win_mock_test_parsers
.IP \(bu 2
cc43ca27af Return multiprocessing queue in LogSetupMock class
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44118\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-10\-16 17:01:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
0ee04eaf1d Merge pull request \fI\%#44118\fP from rallytime/merge\-2017.7
.IP \(bu 2
bbec47afbc Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
c960ca32c2 Merge pull request \fI\%#44092\fP from techhat/awsunicode
.INDENT 2.0
.IP \(bu 2
bbd9db4d00 One more encoding
.IP \(bu 2
0e8b325667 Apparently __salt_system_encoding__ is a thing
.IP \(bu 2
1e7211838d Use system encoding
.IP \(bu 2
1af21bbe5e Made sure that unicoded data is sent to sha256()
.UNINDENT
.IP \(bu 2
d89c317d96 Merge pull request \fI\%#44021\fP from whiteinge/cpstats\-attribute\-error
.INDENT 2.0
.IP \(bu 2
bf14e5f578 Also catch cpstats AttributeError for bad CherryPy release ~5.6.0
.UNINDENT
.IP \(bu 2
bbdabe242a Merge pull request \fI\%#44025\fP from dayid/lover_typo
.INDENT 2.0
.IP \(bu 2
385980c21a Merge branch \(aq2016.11\(aq of \fI\%https://github.com/saltstack/salt\fP into lover_typo
.IP \(bu 2
266dc00a23 Typo correction of lover to lower
.UNINDENT
.IP \(bu 2
d8f3891a5e Merge pull request \fI\%#44030\fP from rallytime/merge\-2016.11
.INDENT 2.0
.IP \(bu 2
53eaf0d75c Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
64fd839377 Merge pull request \fI\%#44010\fP from Ch3LL/2016.3.7_follow_up
.INDENT 2.0
.IP \(bu 2
9a00302cd8 fix 2016.3.7 release notes merge conflict
.IP \(bu 2
63da1214db Do not allow IDs with null bytes in decoded payloads
.IP \(bu 2
ee792581fc Don\(aqt allow path separators in minion ID
.IP \(bu 2
8aab65c718 fix 2016.3.7 release notes merge conflict
.UNINDENT
.IP \(bu 2
bd73dcb02c Merge pull request \fI\%#43977\fP from Ch3LL/3.8_sec
.IP \(bu 2
5fb3f5f6b1 Add Security Notes to 2016.3.8 Release Notes
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44099\fP: (\fI\%twangboy\fP) Skip Master, Minion, and Syndic parser tests
@ \fI2017\-10\-16 16:07:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
28fa097b9b Merge pull request \fI\%#44099\fP from twangboy/win_skip_test_parsers
.IP \(bu 2
caf086c05a Skip Master, Minion, and Syndic parser tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44106\fP: (\fI\%roaldnefs\fP) Fix mattermost returner documentation
@ \fI2017\-10\-16 13:12:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
dbf112ead7 Merge pull request \fI\%#44106\fP from roaldnefs/fix\-doc\-mattermost_returner
.IP \(bu 2
b3761a0401 Fix doc indentation in mattermost_returner
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44054\fP: (\fI\%nasenbaer13\fP) Backport of missing delete_on_termination
@ \fI2017\-10\-13 15:45:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43859\fP: (\fI\%nasenbaer13\fP) Add missing delete_on_termination passthrough. Adapt docs. (refs: \fI\%#44054\fP)
.IP \(bu 2
fd2c51b76c Merge pull request \fI\%#44054\fP from eyj/boto_lc
.IP \(bu 2
34d4629a64 Merge branch \(aq2017.7\(aq into boto_lc
.IP \(bu 2
9efd63526a Adapted documentation of delete_on_termination parameter
.IP \(bu 2
eb2bfd047b Add missing delete_on_termination passthrough. Adapt docs.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44076\fP: (\fI\%Ch3LL\fP) Add spm shell tests
@ \fI2017\-10\-13 14:32:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
b61ed96268 Merge pull request \fI\%#44076\fP from Ch3LL/spm_test
.IP \(bu 2
d2e91c33bd Add spm shell tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44051\fP: (\fI\%twangboy\fP) Fix some documentation formatting issues in the win_dacl state
@ \fI2017\-10\-12 15:40:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
e38f313ac0 Merge pull request \fI\%#44051\fP from twangboy/win_fix_docs_dacl
.IP \(bu 2
377d6b6171 Fix some docs in the win_dacl state module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44066\fP: (\fI\%Ch3LL\fP) Add Known CherryPy Issue to 2017.7.2 Release Notes
@ \fI2017\-10\-12 15:18:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
a85837d72b Merge pull request \fI\%#44066\fP from Ch3LL/cherry_release
.IP \(bu 2
8e597fcce9 Add Known CherryPy Issue to 2017.7.2 Release Notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43643\fP: (\fI\%doublez13\fP) salt\-ssh: multiple targets fails after upgrade to 2017.7 (refs: \fI\%#43889\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#43449\fP: (\fI\%ecgg\fP) salt\-ssh \-L with hosts down or unreachable returns wrong results (refs: \fI\%#43889\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43889\fP: (\fI\%CorvinM\fP) Fix issue with using roster_defaults with flat or cloud rosters.
@ \fI2017\-10\-11 23:22:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
fcab77ac7b Merge pull request \fI\%#43889\fP from CorvinM/issue43449
.IP \(bu 2
fefd28d896 Add futureproofing to roster_defaults to support roster dictionary options
.IP \(bu 2
aebe76b6f8 Fix issue with using roster_defaults with flat or cloud rosters. fixes \fI\%#43449\fP fixes \fI\%#43643\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44031\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-10\-11 22:03:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ad1c6d1d9 Merge pull request \fI\%#44031\fP from rallytime/merge\-2017.7
.IP \(bu 2
1d4a6c3949 Lint: Fixup undefined variable errors
.IP \(bu 2
788ad0609a Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
0dbf41e79e Merge pull request \fI\%#44011\fP from Ch3LL/2016.11.7_follow_up
.INDENT 2.0
.IP \(bu 2
c0149101c0 Do not allow IDs with null bytes in decoded payloads
.IP \(bu 2
19481423dd Don\(aqt allow path separators in minion ID
.UNINDENT
.IP \(bu 2
d61300df20 Merge pull request \fI\%#44023\fP from Ch3LL/11.9rn
.INDENT 2.0
.IP \(bu 2
7f9015eb41 Add 2016.11.9 Release Note File
.UNINDENT
.IP \(bu 2
9ff53bf63a Merge pull request \fI\%#44019\fP from benediktwerner/2016.11
.INDENT 2.0
.IP \(bu 2
bc53598027 Fixed spelling mistake in salt_bootstrap tutorial
.IP \(bu 2
6c30344824 Added missing tutorial docs to the tutorial index
.UNINDENT
.IP \(bu 2
364523f5f8 Merge pull request \fI\%#43955\fP from meaksh/2016.11\-fix\-2291
.INDENT 2.0
.IP \(bu 2
a81b78381b Merge branch \(aq2016.11\(aq into 2016.11\-fix\-2291
.IP \(bu 2
44bc91bb98 Enable \(aq\-\-with\-salt\-version\(aq parameter for setup.py script
.UNINDENT
.IP \(bu 2
fec714b91d Merge pull request \fI\%#43962\fP from bobrik/kmod\-built\-in
.INDENT 2.0
.IP \(bu 2
95ab901553 Report built\-in modiles in kmod.available, fixes \fI\%#43945\fP
.UNINDENT
.IP \(bu 2
e434c39c4e Merge pull request \fI\%#43960\fP from cro/ldap_nopw_bind2
.INDENT 2.0
.IP \(bu 2
962a20cf4b Require that bindpw be non\-empty if auth.ldap.anonymous=False
.IP \(bu 2
9df3d91d8f Release notes blurb for change to bindpw requirements
.UNINDENT
.IP \(bu 2
e9dfda2177 Merge pull request \fI\%#43991\fP from Ch3LL/3.8_sec_2
.INDENT 2.0
.IP \(bu 2
1977df8462 Add Security Notes to 2016.3.8 Release Notes
.UNINDENT
.IP \(bu 2
2346d2691e Merge pull request \fI\%#43968\fP from rossengeorgiev/fix\-zenoss\-prod_state
.INDENT 2.0
.IP \(bu 2
e6d31c1ea6 fix zenoss state module not respecting test=true
.UNINDENT
.IP \(bu 2
8d56a5ac45 Merge pull request \fI\%#43776\fP from Ch3LL/2016.11.8_docs
.INDENT 2.0
.IP \(bu 2
f72bc00000 [2016.11] Bump latest and previous versions
.UNINDENT
.IP \(bu 2
21bf71c3f5 Merge pull request \fI\%#43976\fP from Ch3LL/11.8_sec
.INDENT 2.0
.IP \(bu 2
f0c3184288 Add Security Notes to 2016.11.8 Release Notes
.UNINDENT
.IP \(bu 2
1d5397ab5b Merge pull request \fI\%#43973\fP from terminalmage/fix\-grains.has_value
.INDENT 2.0
.IP \(bu 2
bf45ae6e6a Fix grains.has_value when value is False
.UNINDENT
.IP \(bu 2
9ac3f2ea7b Merge pull request \fI\%#43888\fP from rallytime/bp\-43841
.INDENT 2.0
.IP \(bu 2
87d676f08a add \-n with netstat so we don\(aqt resolve
.UNINDENT
.IP \(bu 2
f880ac4c08 Merge pull request \fI\%#43916\fP from dereckson/fix\-typo\-cloud\-scaleway
.INDENT 2.0
.IP \(bu 2
15b8b8a9f4 Fix typo in salt\-cloud scaleway documentation
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44045\fP: (\fI\%isbm\fP) Bugfix: always return a string \(dqlist\(dq on unknown job target type.
@ \fI2017\-10\-11 21:58:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
5db1e8c6ca Merge pull request \fI\%#44045\fP from isbm/isbm\-tgttype\-fix\-2017\-port
.IP \(bu 2
471ff35c2f Bugfix: always return a string \(dqlist\(dq on unknown job target type.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43949\fP: (\fI\%arthurlogilab\fP) [logger] [sentry] KeyError: \(aqSENTRY_PROJECT\(aq (refs: \fI\%#43950\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44026\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43950\fP to 2017.7
@ \fI2017\-10\-11 15:27:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43950\fP: (\fI\%arthurlogilab\fP) [log/sentry] avoid KeyError: \(aqSENTRY_PROJECT\(aq (refs: \fI\%#44026\fP)
.IP \(bu 2
6c8f7fd5ec Merge pull request \fI\%#44026\fP from rallytime/bp\-43950
.IP \(bu 2
a37e0bad62 [log/sentry] avoid KeyError: \(aqSENTRY_PROJECT\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44012\fP: (\fI\%Ch3LL\fP) Security Fixes for 2017.7.2 (refs: \fI\%#44027\fP)
@ \fI2017\-10\-10 20:04:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
369ee8a132 Merge pull request \fI\%#44012\fP from Ch3LL/2017.7.1_follow_up
.IP \(bu 2
92e05cf1c0 Don\(aqt allow path separators in minion ID
.IP \(bu 2
70133aa305 Do not allow IDs with null bytes in decoded payloads
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44024\fP: (\fI\%Ch3LL\fP) Add 2017.7.3 Release Note File
@ \fI2017\-10\-10 20:03:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
4fe029a0ab Merge pull request \fI\%#44024\fP from Ch3LL/7.3rn
.IP \(bu 2
027f509368 Add 2017.7.3 Release Note File
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43997\fP: (\fI\%unthought\fP) gce cloud provider breaks for make_master: True (refs: \fI\%#43998\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43998\fP: (\fI\%unthought\fP) Fix gce make_master
@ \fI2017\-10\-10 20:01:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
e484d16817 Merge pull request \fI\%#43998\fP from unthought/fix\-gce\-make_master
.IP \(bu 2
6e9f0fa24e Fix GCE provider: #create returns bootstrap result
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44013\fP: (\fI\%DenisBY\fP) pkgrepo.managed broken in 2017.7.2 (refs: \fI\%#44016\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44016\fP: (\fI\%terminalmage\fP) Fix on_header callback when not redirecting and no Content\-Type present
@ \fI2017\-10\-10 19:59:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
82b92d54b3 Merge pull request \fI\%#44016\fP from terminalmage/issue44013
.IP \(bu 2
d594b95f92 No need to set a specific encoding if one hasn\(aqt been provided via the headers
.IP \(bu 2
425ede4b84 Fix on_header callback when not redirecting and no Content\-Type present
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43952\fP: (\fI\%t0fik\fP) add requisites to stateconf ( backport \fI\%#43920\fP)
@ \fI2017\-10\-10 13:03:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43920\fP: (\fI\%t0fik\fP) Added missing requisites to stateconf renderer (refs: \fI\%#43952\fP)
.IP \(bu 2
bd879eb66e Merge pull request \fI\%#43952\fP from jdsieci/2017.7_add_requisites_to_stateconf
.IP \(bu 2
9994c64670 Merge branch \(aq2017.7\(aq into 2017.7_add_requisites_to_stateconf
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43777\fP: (\fI\%Ch3LL\fP) [2017.7] Bump latest and previous versions
@ \fI2017\-10\-09 17:21:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
a4358dfa36 Merge pull request \fI\%#43777\fP from Ch3LL/2017.7.2_docs
.IP \(bu 2
410c624f7a [2017.7] Bump latest and previous versions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43978\fP: (\fI\%Ch3LL\fP) Add Security Notes to 2017.7.2 Release Notes
@ \fI2017\-10\-09 17:20:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
2a064c1a72 Merge pull request \fI\%#43978\fP from Ch3LL/7.2_sec
.IP \(bu 2
57fd6f7bcb Add Security Notes to 2017.7.2 Release Notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43932\fP: (\fI\%techhat\fP) Don\(aqt try to modify dict while looping through it
@ \fI2017\-10\-06 21:20:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
d9530e3c52 Merge pull request \fI\%#43932\fP from techhat/moddict
.IP \(bu 2
4a77560646 Don\(aqt try to modify dict while looping through it
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43956\fP: (\fI\%terminalmage\fP) Fix fileclient\(aqs get_url when redirecting to a redirect
@ \fI2017\-10\-06 21:19:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
39893a1dab Merge pull request \fI\%#43956\fP from terminalmage/fix\-get_url\-redirects
.IP \(bu 2
9a4f6a260f Fix fileclient\(aqs get_url when redirecting to a redirect
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43943\fP: (\fI\%twangboy\fP) Fix \fIunit.utils.test_utils\fP for Windows
@ \fI2017\-10\-06 19:35:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
1baf286719 Merge pull request \fI\%#43943\fP from twangboy/win_unit_test_utils
.IP \(bu 2
254dac7723 Fix \fIunit.utils.test_utils\fP for Windows
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
89200ff28e rebase from 2017.7.2
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43939\fP: (\fI\%terminalmage\fP) Fix typo in log message
@ \fI2017\-10\-05 23:20:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
a8f1750323 Merge pull request \fI\%#43939\fP from terminalmage/fix\-typo
.IP \(bu 2
29d8cf4f26 Fix typo in log message
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43909\fP: (\fI\%frogunder\fP) state.highstate not working on py3 setup (refs: \fI\%#43910\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#43605\fP: (\fI\%cruscio\fP) Module.Run: Passed invalid arguments to state.apply: can\(aqt serialize dict_keys([\(aqtask.create_task\(aq]) (refs: \fI\%#43910\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43910\fP: (\fI\%terminalmage\fP) Don\(aqt put unserializable dict.keys() into state return
@ \fI2017\-10\-05 20:33:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a718eb1ed Merge pull request \fI\%#43910\fP from terminalmage/issue43605
.IP \(bu 2
042e092ac8 Don\(aqt put unserializable dict.keys() into state return
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41894\fP: (\fI\%DR3EVR8u8c\fP) Salt\-cloud can\(aqt resize root volume with public ami images (refs: \fI\%#43907\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#39257\fP: (\fI\%aig787\fP) Using del_root_vol_on_destroy option in salt\-cloud gives IndexError (refs: \fI\%#43907\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43927\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43907\fP to 2017.7
@ \fI2017\-10\-05 20:10:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43907\fP: (\fI\%richardsimko\fP) Make sure EBS volume exists before querying (refs: \fI\%#43927\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33115\fP: (\fI\%rbjorklin\fP) Fix override of ec2 volumetype (refs: \fI\%#43907\fP)
.IP \(bu 2
a7a59868c8 Merge pull request \fI\%#43927\fP from rallytime/bp\-43907
.IP \(bu 2
f62e8ca87f Make sure volume exists before querying
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43934\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-10\-05 20:07:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
4fcd4709ea Merge pull request \fI\%#43934\fP from rallytime/merge\-2017.7
.IP \(bu 2
eaca3291e2 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
2ab7549d48 Merge pull request \fI\%#43884\fP from UtahDave/2016.11local
.INDENT 2.0
.IP \(bu 2
e3b2857285 Merge branch \(aq2016.11\(aq into 2016.11local
.UNINDENT
.IP \(bu 2
4b882d4272 Merge pull request \fI\%#43869\fP from terminalmage/issue43522
.INDENT 2.0
.IP \(bu 2
fe28b0d4fb Only join cmd if it\(aqs not a string
.IP \(bu 2
8c671fd0c1 Update SaltConf banner per Rhett\(aqs request
.UNINDENT
.IP \(bu 2
a2161efda3 Merge pull request \fI\%#43707\fP from terminalmage/issue43373
.INDENT 2.0
.IP \(bu 2
3ebde1895f Merge branch \(aq2016.11\(aq into issue43373
.IP \(bu 2
e580ed4caa Merge branch \(aq2016.11\(aq into issue43373
.IP \(bu 2
5b3be6e8af Fix failing unit test
.IP \(bu 2
f73764481b Add missing support for use/use_in requisites to state.sls_id
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43658\fP: (\fI\%kvnaveen\fP) KeyError: \(aqas_dict\(aq [DEBUG   ] LazyLoaded nested.output (refs: \fI\%#43886\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43886\fP: (\fI\%techhat\fP) Fix object_to_dict in azure
@ \fI2017\-10\-05 19:33:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
7d174172a0 Merge pull request \fI\%#43886\fP from techhat/azuredict
.IP \(bu 2
223a1eea83 Fix object_to_dict in azure
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43899\fP: (\fI\%gtmanfred\fP) enable tox for tests
@ \fI2017\-10\-04 15:08:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
7038248820 Merge pull request \fI\%#43899\fP from gtmanfred/2017.7
.IP \(bu 2
51eca1a6bd enable tox for tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43828\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-10\-04 13:10:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
a5abe33e1c Merge pull request \fI\%#43828\fP from rallytime/merge\-2017.7
.IP \(bu 2
2ff02e4320 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
85b3aa332a Merge pull request \fI\%#43807\fP from terminalmage/issue43522
.INDENT 2.0
.IP \(bu 2
d8708bf698 cmdmod: Don\(aqt list\-ify string commands on Windows
.UNINDENT
.IP \(bu 2
ea8d273c2b Merge pull request \fI\%#43768\fP from vutny/fix\-pylint\-deprecation\-warnings
.INDENT 2.0
.IP \(bu 2
f8b3fa9da1 Merge branch \(aq2016.11\(aq into fix\-pylint\-deprecation\-warnings
.IP \(bu 2
651ed16ad3 Fix Pylint deprecated option warnings
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43854\fP: (\fI\%keesbos\fP) Map __env__ in git_pillar before sanity checks
@ \fI2017\-10\-02 20:44:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43656\fP: (\fI\%keesbos\fP) Git pillar fixes (refs: \fI\%#43854\fP)
.IP \(bu 2
36b0b1174b Merge pull request \fI\%#43854\fP from keesbos/2017.7
.IP \(bu 2
fba9c9a935 Map __env__ in git_pillar before sanity checks
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43847\fP: (\fI\%cachedout\fP) Fix to module.run
@ \fI2017\-10\-02 19:25:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
c81e8457b8 Merge pull request \fI\%#43847\fP from cachedout/module_run_compare
.IP \(bu 2
b11f8c8f29 Merge pull request #17 from terminalmage/pr\-43847
.INDENT 2.0
.IP \(bu 2
93eaba7c54 Use six.iterkeys() instead of dict.keys()
.IP \(bu 2
5d56a03a67 Improve failures for module.run states
.UNINDENT
.IP \(bu 2
71780beb5a Merge branch \(aq2017.7\(aq into module_run_compare
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43819\fP: (\fI\%mephi42\fP) archive.extracted shows the http password in the comment field on failure (refs: \fI\%#43844\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43844\fP: (\fI\%garethgreenaway\fP) [2017.7] Changes to states/file.py and states/archived.py
@ \fI2017\-10\-01 09:08:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd01e0ce67 Merge pull request \fI\%#43844\fP from garethgreenaway/43819_redact_url_additions
.IP \(bu 2
c58c72aff9 When using URLs in archive.extracted, on failure the username & password is in the exception.  Calling salt.utils.url.redact_http_basic_auth to ensure the credentials are redacted.
.INDENT 2.0
.IP \(bu 2
f0b985cbbe Merge branch \(aqmodule_run_compare\(aq of \fI\%ssh://github.com/cachedout/salt\fP into module_run_compare
.INDENT 2.0
.IP \(bu 2
aefc773c2f Merge branch \(aq2017.7\(aq into module_run_compare
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43840\fP: (\fI\%twangboy\fP) Fix \fIunit.states.test_augeas\fP for Windows
@ \fI2017\-09\-29 21:53:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f52546eab Merge pull request \fI\%#43840\fP from twangboy/win_fix_test_augeas
.IP \(bu 2
fd1d6c31de Fix \fIunit.states.test_augeas\fP for Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43553\fP: (\fI\%dafyddj\fP) Vagrant setup (Windows guest) broken on upgrade to 2017.7 (refs: \fI\%#43801\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43801\fP: (\fI\%terminalmage\fP) Properly handle UNC paths in salt.utils.path.readlink()
@ \fI2017\-09\-29 09:58:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
c6fd2cd452 Merge pull request \fI\%#43801\fP from terminalmage/issue43553
.IP \(bu 2
66e6e89dc7 Properly handle UNC paths in salt.utils.path.readlink()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43800\fP: (\fI\%Ch3LL\fP) Add note to nitrogen release notes about pip for cent6
@ \fI2017\-09\-28 17:36:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
7304907db6 Merge pull request \fI\%#43800\fP from Ch3LL/update_7.0
.IP \(bu 2
50779c3b1c Add note to nitrogen release notes about pip for cent6
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43779\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_state\fP for Windows
@ \fI2017\-09\-28 14:27:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
6f687fdcff Merge pull request \fI\%#43779\fP from twangboy/win_fix_test_state
.IP \(bu 2
a64fe75816 Use os agnostic paths
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43782\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_virt\fP for Windows
@ \fI2017\-09\-28 14:25:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
db0f569f7a Merge pull request \fI\%#43782\fP from twangboy/win_fix_test_virt
.IP \(bu 2
7192332758 Fix \fIunit.modules.test_virt\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43723\fP: (\fI\%nicholasmhughes\fP) Fix ini_manage error and change handling
@ \fI2017\-09\-28 09:52:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd4fc52f1e Merge pull request \fI\%#43723\fP from nicholasmhughes/ini_manage\-error\-handling
.IP \(bu 2
d68c5c4be0 prevent exception when test=True
.IP \(bu 2
cfe37916c3 handling changes per section
.IP \(bu 2
1c484f6ad5 prevent exception when test=True
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43781\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_status\fP for Windows
@ \fI2017\-09\-28 09:06:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
5e29507c21 Merge pull request \fI\%#43781\fP from twangboy/win_fix_test_status
.IP \(bu 2
16ae8253c1 Mock which, use os.linesep for cmd.run return
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43785\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_znc\fP for Windows
@ \fI2017\-09\-28 08:56:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
05c78ae649 Merge pull request \fI\%#43785\fP from twangboy/win_fix_test_znc
.IP \(bu 2
7d90721f6b Merge branch \(aq2017.7\(aq into win_fix_test_znc
.IP \(bu 2
228e74c8e3 Fix \fIunit.modules.test_znc\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43786\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_zypper\fP for Windows
@ \fI2017\-09\-28 08:51:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
10ddb8491c Merge pull request \fI\%#43786\fP from twangboy/win_fix_test_zypper
.IP \(bu 2
1c05e37a66 Merge branch \(aq2017.7\(aq into win_fix_test_zypper
.IP \(bu 2
aafec7ab0e Fix \fIunit.modules.test_zypper\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43773\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-09\-28 08:48:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
9615ca32d5 Merge pull request \fI\%#43773\fP from rallytime/merge\-2017.7
.IP \(bu 2
f7035ed7da Merge branch \(aq2017.7\(aq into merge\-2017.7
.IP \(bu 2
dfef4a722c Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
1a8cc60bb4 Merge pull request \fI\%#43772\fP from gtmanfred/2016.11
.INDENT 2.0
.IP \(bu 2
0194c60960 don\(aqt print Minion not responding with quiet
.UNINDENT
.IP \(bu 2
9dee896fb9 Merge pull request \fI\%#43747\fP from rallytime/gpg\-verification
.INDENT 2.0
.IP \(bu 2
7a70de19f4 Merge branch \(aq2016.11\(aq into gpg\-verification
.IP \(bu 2
23bb4a5dde Add GPG Verification section to Contributing Docs
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43784\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_win_service\fP
@ \fI2017\-09\-28 03:14:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
9a9cc69d55 Merge pull request \fI\%#43784\fP from twangboy/win_fix_test_win_service
.IP \(bu 2
058e50e530 Fix \fIunit.modules.test_win_service\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43774\fP: (\fI\%The\-Loeki\fP) typo fix aka what is a \(aqmasterarpi\(aq
@ \fI2017\-09\-27 18:52:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
1254da1df5 Merge pull request \fI\%#43774\fP from The\-Loeki/patch\-1
.IP \(bu 2
84bbe85e60 typo fix aka what is a \(aqmasterarpi\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43732\fP: (\fI\%twangboy\fP) Skip \fIunit.stats.test_mac_packages\fP on Windows
@ \fI2017\-09\-27 14:48:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
3f888753d4 Merge pull request \fI\%#43732\fP from twangboy/win_skip_mac_pkg_tests
.IP \(bu 2
1c01e06097 Only skip test on Windows
.IP \(bu 2
ec99a3ce3c Fix lint error
.IP \(bu 2
61f8a2f7ff Skip mac specific tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43761\fP: (\fI\%Ch3LL\fP) Release Notes for 2017.7.2
@ \fI2017\-09\-27 14:34:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb86935d99 Merge pull request \fI\%#43761\fP from Ch3LL/release_2017.7.2
.IP \(bu 2
caf5795856 add mac patch notes
.IP \(bu 2
3d5fce0955 Add 2017.7.2 Release Notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43767\fP: (\fI\%twangboy\fP) Skip \fIunit.modules.test_snapper\fP on Windows
@ \fI2017\-09\-27 14:10:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
5ea603cf16 Merge pull request \fI\%#43767\fP from twangboy/win_skip_test_snapper
.IP \(bu 2
b41b9c8378 Skip snapper tests on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43759\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-09\-27 13:30:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
77c2c7cbf7 Merge pull request \fI\%#43759\fP from rallytime/merge\-2017.7
.IP \(bu 2
120f49f2c4 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
1cc3ad1c8d Merge pull request \fI\%#43733\fP from terminalmage/issue43729
.INDENT 2.0
.IP \(bu 2
6e5c99bda0 Allow docker_events engine to work with newer docker\-py
.UNINDENT
.IP \(bu 2
5d38be4ff7 Merge pull request \fI\%#43458\fP from terminalmage/issue42082
.INDENT 2.0
.IP \(bu 2
5f90812b12 Fix missing PER_REMOTE_ONLY in cache.clear_git_lock runner
.UNINDENT
.IP \(bu 2
023a563657 Merge pull request \fI\%#43727\fP from rallytime/fix\-43650
.INDENT 2.0
.IP \(bu 2
babad12d83 Revise \(dqContributing\(dq docs: merge\-forwards/release branches explained!
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43737\fP: (\fI\%syedaali\fP) salt.loaded.int.module.boto_kinesis.__virtual__() is wrongly
returning \fINone\fP\&. It should either return \fITrue\fP, \fIFalse\fP or a new name. If you\(aqre the developer
of the module \(aqboto_kinesis\(aq, please fix this. (refs: \fI\%#43748\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43748\fP: (\fI\%rallytime\fP) Add message to boto_kinesis modules if boto libs are missing
@ \fI2017\-09\-27 13:19:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
5c203df056 Merge pull request \fI\%#43748\fP from rallytime/fix\-43737
.IP \(bu 2
5a2593dbd3 Add message to boto_kinesis modules if boto libs are missing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43731\fP: (\fI\%twangboy\fP) Fix \fIunit.beacons.test_status\fP for Windows
@ \fI2017\-09\-26 16:25:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
2581098595 Merge pull request \fI\%#43731\fP from twangboy/win_unit_beacons_test_status
.IP \(bu 2
dc1b36b7e2 Change expected return for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43724\fP: (\fI\%brejoc\fP) Improved delete_deployment test for kubernetes module
@ \fI2017\-09\-26 16:19:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
10f3d47498 Merge pull request \fI\%#43724\fP from brejoc/2017.7.kubernetes_delete_test
.IP \(bu 2
85b0a8c401 Improved delete_deployment test for kubernetes module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43734\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_poudriere\fP for Windows
@ \fI2017\-09\-26 14:13:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
13cc27bdab Merge pull request \fI\%#43734\fP from twangboy/win_unit_test_poudriere
.IP \(bu 2
922e60fa67 Add os agnostic paths
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43742\fP: (\fI\%terminalmage\fP) Fix incorrect value in docstring
@ \fI2017\-09\-26 13:55:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
41aeee7ac8 Merge pull request \fI\%#43742\fP from terminalmage/fix\-docstring
.IP \(bu 2
553335b1c9 Fix incorrect value in docstring
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41998\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_environ\fP for Windows
@ \fI2017\-09\-26 12:25:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
d78b9a3294 Merge pull request \fI\%#41998\fP from twangboy/win_unit_test_environ
.IP \(bu 2
d73ef44cf6 Mock with uppercase KEY
.IP \(bu 2
048e16883f Use uppercase KEY
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42036\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_file\fP for Windows
@ \fI2017\-09\-26 12:23:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
7fbbea3806 Merge pull request \fI\%#42036\fP from twangboy/win_unit_test_file
.IP \(bu 2
056f3bb4c0 Use with to open temp file
.IP \(bu 2
352fe69e35 Clarify the purpose of the for loop
.IP \(bu 2
b55172d5dc Split by Windows and Linux style line endings
.IP \(bu 2
e20aa5c39b Fix line, use os.sep instead of os.linesep
.IP \(bu 2
d5f27901e3 Fix additional bytestring issue
.IP \(bu 2
716e99c453 Fix py3 bytestring problems
.IP \(bu 2
543610570c Fix bytestring issues, fix errored tests
.IP \(bu 2
9fe83a34a5 Remove old variable declaration
.IP \(bu 2
c5cf5e92c1 Fix many tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43557\fP: (\fI\%clan\fP) disable modify yaml constructor
@ \fI2017\-09\-25 14:03:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
a81d4b8d8d Merge pull request \fI\%#43557\fP from clan/yaml
.IP \(bu 2
485471c8a7 Merge branch \(aq2017.7\(aq into yaml
.IP \(bu 2
da15658304 remove modify yaml constructor
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43566\fP: (\fI\%damon\-atkins\fP) 2017.7 update salt.utils.files.safe_filepath func
@ \fI2017\-09\-25 13:58:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
b5beec16e8 Merge pull request \fI\%#43566\fP from damon\-atkins/2017.7_update_safe_filename_func
.IP \(bu 2
c7a652784a remove blank line at end of file
.IP \(bu 2
e97651d49b Merge branch \(aq2017.7\(aq into 2017.7_update_safe_filename_func
.IP \(bu 2
3b4c1bbf7f Merge branch \(aq2017.7\(aq into 2017.7_update_safe_filename_func
.IP \(bu 2
4c88c80ef9 Merge branch \(aq2017.7\(aq into 2017.7_update_safe_filename_func
.IP \(bu 2
4171d11838 utils.files.safe_filepath add support to override the os default directory separator
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43711\fP: (\fI\%wedge\-jarrad\fP) fcontext_get_policy emits command error if policy doesn\(aqt exist (refs: \fI\%#43712\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43712\fP: (\fI\%wedge\-jarrad\fP) Ignore retcode on call to grep in selinux.py module
@ \fI2017\-09\-25 13:56:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
3bb337cf6a Merge pull request \fI\%#43712\fP from wedge\-jarrad/fix\-43711
.IP \(bu 2
96c1ef48e6 Ignore retcode on call to grep in selinux.py module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43659\fP: (\fI\%gaborn57\fP) unable to retrieve pillar data in postgres db (refs: \fI\%#43716\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43716\fP: (\fI\%gaborn57\fP) Corrected custom port handling
@ \fI2017\-09\-25 13:44:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b7411e335 Merge pull request \fI\%#43716\fP from gaborn57/2017.7
.IP \(bu 2
78137c0860 Corrected custom port handling
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43700\fP: (\fI\%rklaren\fP) Ensure salt\-cloud with libvirt provider does not write low level errors to stderr
@ \fI2017\-09\-25 01:47:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43684\fP: (\fI\%rklaren\fP) salt\-cloud libvirt updates (refs: \fI\%#43700\fP)
.IP \(bu 2
6bbd50c453 Merge pull request \fI\%#43700\fP from rklaren/fix\-libvirt\-stderr\-spam
.IP \(bu 2
88530c4cb6 Lint fixes
.IP \(bu 2
235bec492e salt\-cloud + libvirt: Mention Fedora 26 support
.IP \(bu 2
9aecf5f847 Remove stderr spam when using salt\-cloud with libvirt
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43702\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-09\-25 01:26:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
437ac03801 Merge pull request \fI\%#43702\fP from rallytime/merge\-2017.7
.IP \(bu 2
132b1b343b Merge branch \(aq2017.7\(aq into merge\-2017.7
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38971\fP: (\fI\%morganwillcock\fP) archive.extracted: lots of unnecessary file transferring, copying, and hashing (refs: \fI\%#43681\fP, \fI\%#43518\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43681\fP: (\fI\%terminalmage\fP) Backport the non\-fileclient changes from PR 43518 to 2017.7
@ \fI2017\-09\-22 19:27:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43518\fP: (\fI\%terminalmage\fP) Reduce unnecessary file downloading in archive/file states (refs: \fI\%#43681\fP)
.IP \(bu 2
47cd8723c6 Merge pull request \fI\%#43681\fP from terminalmage/issue38971\-2017.7
.IP \(bu 2
91edf865e2 Merge branch \(aq2017.7\(aq into issue38971\-2017.7
.IP \(bu 2
84f34c93be Backport the non\-fileclient changes from PR 43518 to 2017.7
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43396\fP: (\fI\%mkurtak\fP) yumpkg pkg.installed slowed down due to wildcard namig support (refs: \fI\%#43687\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43687\fP: (\fI\%mkurtak\fP) yumpkg.py: install calls list_repo_pkgs only if wildcard is used in pkg name
@ \fI2017\-09\-22 19:23:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a1c5185f5 Merge pull request \fI\%#43687\fP from mkurtak/fix\-43396
.IP \(bu 2
b1e64b11fb yumpkg.py: install calls list_repo_pkgs only if wildcard in pkg name is used
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43124\fP: (\fI\%UtahDave\fP) publisher_acl with regex on username not working and has no documentation (refs: \fI\%#43467\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43467\fP: (\fI\%DmitryKuzmenko\fP) Bugs/43124 users regex
@ \fI2017\-09\-22 19:21:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a79549af4 Merge pull request \fI\%#43467\fP from DSRCorporation/bugs/43124_users_regex
.IP \(bu 2
14bf2dd8ff Support regex in publisher_acl.
.IP \(bu 2
9fe32f8b6e Regex support for user names in external_auth config.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43381\fP: (\fI\%V3XATI0N\fP) Sharing minion data cache causes false errors in returns (refs: \fI\%#43670\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43670\fP: (\fI\%DmitryKuzmenko\fP) Fix for \fIlist\fP and \fIcontains\fP redis cache logic.
@ \fI2017\-09\-22 17:56:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
0e86266b93 Merge pull request \fI\%#43670\fP from DSRCorporation/bugs/43381_redis_cache_fix
.IP \(bu 2
1c979d5809 Update redis cache \fIcontains\fP logic to use more efficient \fIsismember\fP\&.
.IP \(bu 2
039d236948 Fixed \fIlist\fP and \fIcontains\fP redis cache logic.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
6e5cf65d65 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
f46c858f25 Merge pull request \fI\%#43648\fP from rallytime/handle\-boto\-vpc\-errors
.INDENT 2.0
.IP \(bu 2
54842b5012 Handle VPC/Subnet ID not found errors in boto_vpc module
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43697\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-09\-22 17:31:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
aa47da35dd Merge pull request \fI\%#43697\fP from rallytime/merge\-2017.7
.IP \(bu 2
cbae45bec4 Lint: Remove extra line at end of file
.IP \(bu 2
fca4e5563a Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
9dba34aa06 Merge pull request \fI\%#43575\fP from akissa/fix\-csr\-not\-recreated\-if\-key\-changes
.INDENT 2.0
.IP \(bu 2
b1b4dafd39 Fix CSR not recreated if key changes
.UNINDENT
.IP \(bu 2
1d4fa48209 Merge pull request \fI\%#43672\fP from rallytime/bp\-43415
.INDENT 2.0
.IP \(bu 2
3fb42bc238 Fix env_order in state.py
.UNINDENT
.IP \(bu 2
ff832ee607 Merge pull request \fI\%#43673\fP from rallytime/bp\-43652
.INDENT 2.0
.IP \(bu 2
d91c47c6f0 Salt Repo has Deb 9 and 8
.UNINDENT
.IP \(bu 2
365cb9fba8 Merge pull request \fI\%#43677\fP from terminalmage/runners\-docs\-2016.11
.INDENT 2.0
.IP \(bu 2
2fd88e94fa Fix RST headers for runners (2016.11 branch)
.UNINDENT
.IP \(bu 2
be38239e5d Merge pull request \fI\%#43534\fP from twangboy/win_fix_pkg.install_2016.11
.INDENT 2.0
.IP \(bu 2
1546c1ca04 Add posix=False to call to salt.utils.shlex_split
.UNINDENT
.IP \(bu 2
0d3fd3d374 Merge pull request \fI\%#43661\fP from moio/2016.11\-multiprocessing\-doc\-fix
.INDENT 2.0
.IP \(bu 2
625eabb83f multiprocessing minion option: documentation fixes
.UNINDENT
.IP \(bu 2
6b4516c025 Merge pull request \fI\%#43646\fP from brejoc/2016.11.4\-pidfile\-tests
.INDENT 2.0
.IP \(bu 2
96f39a420b Fixed linting
.IP \(bu 2
08fba98735 Fixed several issues with the test
.IP \(bu 2
3a089e450f Added tests for pid\-file deletion in DaemonMixIn
.UNINDENT
.IP \(bu 2
cfb1625741 Merge pull request \fI\%#43591\fP from rallytime/merge\-2016.11
.INDENT 2.0
.IP \(bu 2
57b9d642c2 Merge branch \(aq2016.11.8\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
e83421694f Merge pull request \fI\%#43550\fP from twangboy/osx_fix_preinstall_2016.11.8
.INDENT 2.0
.IP \(bu 2
1b0a4d39d2 Fix logic in \fI/etc/paths.d/salt\fP detection
.UNINDENT
.IP \(bu 2
a648f75949 Merge pull request \fI\%#43508\fP from rallytime/bp\-43333
.INDENT 2.0
.IP \(bu 2
d4981a2717 Update doco
.IP \(bu 2
a7c8b9e048 Update win_pkg.py
.IP \(bu 2
1d6dc6fb72 Docs are wrong cache_dir (bool) and cache_file (str) cannot be passed on the cli (#2)
.UNINDENT
.IP \(bu 2
e7009877bc Merge pull request \fI\%#43434\fP from rallytime/2016.11.8\-release\-notes
.INDENT 2.0
.IP \(bu 2
68f529ee5e Add 2016.11.8 release notes
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
8671b91f62 Merge pull request \fI\%#43572\fP from vutny/fix\-salt\-cloud\-list\-min\-instance\-set
.INDENT 2.0
.IP \(bu 2
21966e7ce8 cloud.action: list_nodes_min returns all instances
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43314\fP: (\fI\%twangboy\fP) Fix \fIunit.utils.test_verify\fP for Windows
@ \fI2017\-09\-21 22:26:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
e6dc4d64df Merge pull request \fI\%#43314\fP from twangboy/win_fix_unit.utils.test_verify
.IP \(bu 2
9ada7f626c Merge branch \(aq2017.7\(aq into win_fix_unit.utils.test_verify
.IP \(bu 2
c0dc3f73ef Use sys.platform instead of salt.utils to detect Windows
.IP \(bu 2
e496d28cbf Fix \fIunit.utils.test_verify\fP for Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43599\fP: (\fI\%vernondcole\fP) Incorrect default for salt.cache.Cache() if opts does not define \(dqcache\(dq (refs: \fI\%#43680\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43680\fP: (\fI\%vernondcole\fP) correct default value for salt.cache.Cache
@ \fI2017\-09\-21 20:09:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec34df2c27 Merge pull request \fI\%#43680\fP from vernondcole/fix\-salt.cache.Cache\-default
.IP \(bu 2
292f8c79b8 correct default value for salt.cache.Cache
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43530\fP: (\fI\%twangboy\fP) Fixes removal of double\-quotes by shlex_split in winrepo
@ \fI2017\-09\-21 18:04:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
99d9d784b1 Merge pull request \fI\%#43530\fP from twangboy/win_fix_pkg.install
.IP \(bu 2
7f59119f95 Merge branch \(aq2017.7\(aq into win_fix_pkg.install
.IP \(bu 2
f146399f7a Use posix=False for shlex.split
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43671\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.2 to 2017.7
@ \fI2017\-09\-21 16:39:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
12b5e62d81 Merge pull request \fI\%#43671\fP from rallytime/merge\-2017.7
.IP \(bu 2
a401166bd5 Merge branch \(aq2017.7.2\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43676\fP: (\fI\%terminalmage\fP) Fix RST headers for runners (2017.7 branch)
@ \fI2017\-09\-21 16:36:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
e3a2fbc2a3 Merge pull request \fI\%#43676\fP from terminalmage/runners\-docs\-2017.7
.IP \(bu 2
9b74634b23 Fix badly\-formatted RST in mattermost runner docstring
.IP \(bu 2
c0a79c70a4 Fix RST headers for runners (2017.7 branch)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43235\fP: (\fI\%brejoc\fP) Improve delete_deployment handling
@ \fI2017\-09\-20 21:33:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
d02953ce6a Merge pull request \fI\%#43235\fP from brejoc/improve\-async\-operation\-handling\-in\-kubernetes\-module
.IP \(bu 2
4e8da3045f Fixed logic for windows fallback
.IP \(bu 2
3b1cb884b9 Merge branch \(aq2017.7\(aq into improve\-async\-operation\-handling\-in\-kubernetes\-module
.IP \(bu 2
d1b5ec098c Merge branch \(aq2017.7\(aq into improve\-async\-operation\-handling\-in\-kubernetes\-module
.IP \(bu 2
35cf69bc50 Moved exception Salt core
.IP \(bu 2
7431ec64e3 Removed unused sys import
.IP \(bu 2
0c71da95f6 Using salt method to identify MS Windows, single instead of double quotes
.IP \(bu 2
20619b24c4 Fixed test for delete_deployment
.IP \(bu 2
91076bbafa Merge branch \(aq2017.7\(aq into improve\-async\-operation\-handling\-in\-kubernetes\-module
.IP \(bu 2
7b600e2832 Added pylint\-disable statements and import for salt.ext.six.moves.range
.IP \(bu 2
99fe138325 Code styling and added log message for timeout
.IP \(bu 2
dcd8d4f639 Merge branch \(aq2017.7\(aq into improve\-async\-operation\-handling\-in\-kubernetes\-module
.IP \(bu 2
702a058c38 Fixed linting
.IP \(bu 2
3fe623778e Added Windows fallback
.IP \(bu 2
52b1cb8147 Compatibility with Python3.6
.IP \(bu 2
767af9bb4f Added timeout for checking the deployment
.IP \(bu 2
32d7d34fe5 First simple draft for the deletion verification
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43554\fP: (\fI\%twangboy\fP) Win fix chocolatey
@ \fI2017\-09\-20 16:06:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
73cb0c27b5 Merge pull request \fI\%#43554\fP from twangboy/win_fix_chocolatey
.IP \(bu 2
e04acb6216 Merge branch \(aq2017.7\(aq into win_fix_chocolatey
.IP \(bu 2
56be5c35eb Improve logic for handling chocolatey states
.IP \(bu 2
bcbf7b4e68 Add logic for test=True
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43598\fP: (\fI\%davidvon\fP) Passed invalid arguments to mysql.file_query: unsupported operand type(s) for +=: \(aqint\(aq and \(aqtuple\(aq (refs: \fI\%#43625\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43625\fP: (\fI\%gtmanfred\fP) results and columns are lists for mysql returns
@ \fI2017\-09\-20 15:42:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
ed7eeaaafb Merge pull request \fI\%#43625\fP from gtmanfred/2017.7
.IP \(bu 2
f84b50a06b results and columns are lists for mysql returns
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43560\fP: (\fI\%smitelli\fP) salt.states.linux_acl requires setfacl/getacl binaries but this is not obvious (refs: \fI\%#43587\fP, \fI\%#43580\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43587\fP: (\fI\%rallytime\fP) Add reason to linux_acl state loading failure
@ \fI2017\-09\-19 16:26:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43580\fP: (\fI\%garethgreenaway\fP) Updating ACL module and state module documentation (refs: \fI\%#43587\fP)
.IP \(bu 2
1bda4832ef Merge pull request \fI\%#43587\fP from rallytime/fix\-virtual
.IP \(bu 2
e5297e3869 Add reason to linux_acl state loading failure
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43584\fP: (\fI\%cachedout\fP) Enhance engines docs
@ \fI2017\-09\-18 20:40:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e19533e3c Merge pull request \fI\%#43584\fP from cachedout/engines_doc_clarification
.IP \(bu 2
634536b0ff Merge branch \(aq2017.7\(aq into engines_doc_clarification
.IP \(bu 2
1a619708c1 Enhance engines docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43519\fP: (\fI\%terminalmage\fP) Fix incorrect handling of pkg virtual and os_family grain
@ \fI2017\-09\-18 20:35:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
50b134ef4c Merge pull request \fI\%#43519\fP from terminalmage/fix\-aptpkg
.IP \(bu 2
0e3c447567 Fix incorrect handling of pkg virtual and os_family grain
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43520\fP: (\fI\%clan\fP) _search_name is \(aq\(aq if acl type is other
@ \fI2017\-09\-18 20:33:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd953f36ae Merge pull request \fI\%#43520\fP from clan/acl
.IP \(bu 2
54216177c1 _search_name is \(aq\(aq if acl type is other
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43561\fP: (\fI\%wedge\-jarrad\fP) Clean up doc formatting in selinux state & module
@ \fI2017\-09\-18 20:28:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
ad9663a7fc Merge pull request \fI\%#43561\fP from wedge\-jarrad/selinux\-doc\-cleanup
.IP \(bu 2
1bd263cd51 Clean up doc formatting in selinux state & module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43560\fP: (\fI\%smitelli\fP) salt.states.linux_acl requires setfacl/getacl binaries but this is not obvious (refs: \fI\%#43587\fP, \fI\%#43580\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43580\fP: (\fI\%garethgreenaway\fP) Updating ACL module and state module documentation (refs: \fI\%#43587\fP)
@ \fI2017\-09\-18 20:11:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
cc3d9c1a01 Merge pull request \fI\%#43580\fP from garethgreenaway/43560_update_linux_acl_documentation
.IP \(bu 2
e63fae4c91 Merge branch \(aq2017.7\(aq into 43560_update_linux_acl_documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43523\fP: (\fI\%skizunov\fP) Add back lost logic for multifunc_ordered
@ \fI2017\-09\-18 17:46:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38168\fP: (\fI\%skizunov\fP) Add support for a multi\-func job using same func more than once (refs: \fI\%#43523\fP)
.IP \(bu 2
bf7b23316f Merge pull request \fI\%#43523\fP from skizunov/develop2
.IP \(bu 2
fb579321a9 Add back lost logic for multifunc_ordered
.INDENT 2.0
.IP \(bu 2
117a0ddbbc Updating the documentation to call out the requirement for the getfacl and setfacl binaries
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
49f25b9f19 Lint
.IP \(bu 2
31d17c0124 Fix typo found by @s0undt3ch
.IP \(bu 2
5dba74d2cb Fix to module.run [WIP]
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43447\fP: (\fI\%UtahDave\fP) When using Syndic with Multi Master the top level master doesn\(aqt reliably get returns from lower minion. (refs: \fI\%#43526\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43526\fP: (\fI\%DmitryKuzmenko\fP) Forward events to all masters syndic connected to
@ \fI2017\-09\-18 16:54:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
e29efecf4f Merge pull request \fI\%#43526\fP from DSRCorporation/bugs/43447_syndic_events_forwarding
.IP \(bu 2
64d6109654 Merge branch \(aq2017.7\(aq into bugs/43447_syndic_events_forwarding
.IP \(bu 2
3b2a529385 Merge branch \(aq2017.7\(aq into bugs/43447_syndic_events_forwarding
.IP \(bu 2
0e4a744d95 Forward events to all masters syndic connected to.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43077\fP: (\fI\%Manoj2087\fP) Issue with  deleting key via wheel (refs: \fI\%#43330\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43330\fP: (\fI\%terminalmage\fP) Fix reactor regression + unify reactor config schema
@ \fI2017\-09\-18 16:46:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
56b671e087 Merge pull request \fI\%#43330\fP from terminalmage/issue43077
.IP \(bu 2
a7b4e1f782 Simplify client logic
.IP \(bu 2
b85c8510c7 Improve the reactor documentation
.IP \(bu 2
20f6f3cc39 Include a better example for reactor in master conf file
.IP \(bu 2
4243a2211d Rewrite the reactor unit tests
.IP \(bu 2
9db3f5ae6d Unify reactor configuration, fix caller reactors
.IP \(bu 2
34b6c3b65f Un\-deprecate passing kwargs outside of \(aqkwarg\(aq param
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33793\fP: (\fI\%mstarostik\fP) states.ssh_auth adds bogus newline before newly added keys (refs: \fI\%#43483\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43505\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43483\fP to 2017.7
@ \fI2017\-09\-15 21:22:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43483\fP: (\fI\%3add3287\fP) Handle bogus newline before newly added keys (refs: \fI\%#43505\fP)
.IP \(bu 2
078d5d17de Merge pull request \fI\%#43505\fP from rallytime/bp\-43483
.IP \(bu 2
c68dd5b8a4 Lint: fix spacing
.IP \(bu 2
406f61ac9a Fix indentation from tabs to spaces
.IP \(bu 2
923ec62771 Copy paste typo
.IP \(bu 2
6f6619242f Fix checking for newline on end of file by properly checking the last byte of the file if the file is non empty.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43464\fP: (\fI\%psagers\fP) acme.cert state: IOError on failure to create a new certificate (refs: \fI\%#43465\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43491\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43465\fP to 2017.7
@ \fI2017\-09\-15 18:24:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43465\fP: (\fI\%psagers\fP) acme.cert: avoid IOError on failure. (refs: \fI\%#43491\fP)
.IP \(bu 2
a6df3f2acc Merge pull request \fI\%#43491\fP from rallytime/bp\-43465
.IP \(bu 2
3118faca0a acme.cert: avoid IOError on failure.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43492\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-09\-15 18:23:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
3620c15c9a Merge pull request \fI\%#43492\fP from rallytime/merge\-2017.7
.IP \(bu 2
4251ce5a27 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
f2b86fa2db Merge pull request \fI\%#43461\fP from twangboy/win_norestart
.INDENT 2.0
.IP \(bu 2
2d269d1a76 Change all comment markers to \(aq#\(aq
.IP \(bu 2
d80aea16cb Handle ErrorCodes returned by VCRedist installer
.IP \(bu 2
fb31e9a530 Add /norestart switch to vcredist install
.UNINDENT
.IP \(bu 2
90e8ca9c36 Merge pull request \fI\%#43366\fP from brejoc/2016.11.pidfile\-fix
.INDENT 2.0
.IP \(bu 2
6e3eb76c79 Removed unused format argument
.IP \(bu 2
daf4948b3d Catching error when PIDfile cannot be deleted
.UNINDENT
.IP \(bu 2
a6c458607a Merge pull request \fI\%#43442\fP from garethgreenaway/43386_2016_11_schedule_kwargs_pub
.INDENT 2.0
.IP \(bu 2
e637ecbe86 Merge branch \(aq2016.11\(aq into 43386_2016_11_schedule_kwargs_pub
.IP \(bu 2
6114df8dc3 Adding a small check to ensure we do not continue to populate kwargs with __pub_ items from the kwargs item.
.UNINDENT
.IP \(bu 2
3c429299f9 Merge pull request \fI\%#43456\fP from rallytime/43445_follow_up
.INDENT 2.0
.IP \(bu 2
35c1d8898d Add Neon to version list
.UNINDENT
.IP \(bu 2
6db7a721c0 Merge pull request \fI\%#43441\fP from meaksh/2016.11\-salt\-bash\-completion\-fix
.INDENT 2.0
.IP \(bu 2
be4f26ab21 Use $HOME to get the user home directory instead using \(aq~\(aq char
.UNINDENT
.IP \(bu 2
05fff44a50 Merge pull request \fI\%#43445\fP from rallytime/bump\-deprecation\-warning
.INDENT 2.0
.IP \(bu 2
c91cd1c6d9 Bump deprecation warning for boto_vpc.describe_route_table
.UNINDENT
.IP \(bu 2
c57dc5f0e3 Merge pull request \fI\%#43432\fP from rallytime/bp\-43419
.INDENT 2.0
.IP \(bu 2
c471a29527 make cache dirs when spm starts
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43479\fP: (\fI\%haam3r\fP) Mattermost runner failing to retrieve config values due to unavailable config runner   (refs: \fI\%#43513\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43513\fP: (\fI\%haam3r\fP) Issue \fI\%#43479\fP No runners.config in 2017.7 branch
@ \fI2017\-09\-15 14:58:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
8a90c7059b Merge pull request \fI\%#43513\fP from haam3r/2017.7
.IP \(bu 2
58f7d051c9 Issue \fI\%#43479\fP No runners.config in 2017.7 branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42926\fP: (\fI\%nixjdm\fP) network.system not setting hostname in hosts file, preventing sudo. (refs: \fI\%#43431\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43431\fP: (\fI\%mattLLVW\fP) Fix /etc/hosts not being modified when hostname is changed
@ \fI2017\-09\-13 18:35:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3d9e2d9b2 Merge pull request \fI\%#43431\fP from mattLLVW/fix\-hosts\-deb
.IP \(bu 2
c6320b1dff Merge branch \(aq2017.7\(aq into fix\-hosts\-deb
.IP \(bu 2
a3b2e19149 Fix /etc/hosts not being modified when hostname is changed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43403\fP: (\fI\%twangboy\fP) Proper timestamp conversion in \fIredis.lastsave\fP
@ \fI2017\-09\-12 21:18:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
a09f289fbb Merge pull request \fI\%#43403\fP from twangboy/win_fix_redismod
.IP \(bu 2
f6da23e1aa Properly handle timestamp conversion
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43463\fP: (\fI\%twangboy\fP) Add \fI/norestart\fP switch to vcredist installer
@ \fI2017\-09\-12 20:29:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
0eaa5acb72 Merge pull request \fI\%#43463\fP from twangboy/win_norestart_2017.7
.IP \(bu 2
6984b8fd60 Add /norestart to vcredist installer
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43386\fP: (\fI\%rajvidhimar\fP) Scheduler\(aqs job_kwargs not working as expected. (refs: \fI\%#43443\fP, \fI\%#43442\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43443\fP: (\fI\%garethgreenaway\fP) [2017.7] Fixes to scheduler __pub values in kwargs
@ \fI2017\-09\-12 18:14:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
2fc237a806 Merge pull request \fI\%#43443\fP from garethgreenaway/43386_2017_7_schedule_kwargs_pub
.IP \(bu 2
a29a9855a6 Fixing typo.
.IP \(bu 2
2681b7d3fa Merge branch \(aq2017.7\(aq into 43386_2017_7_schedule_kwargs_pub
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39775\fP: (\fI\%mirceaulinic\fP) Proxy \fImine_interval\fP config ignored (refs: \fI\%#41547\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41547\fP: (\fI\%mirceaulinic\fP) Override proxy minion opts with pillar data
@ \fI2017\-09\-11 21:47:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
5378ac7756 Merge pull request \fI\%#41547\fP from cloudflare/px_merge_pillar_opts
.IP \(bu 2
aad39ba665 Document the new opts
.IP \(bu 2
cdc0d9674a Allow disabling the mines details merge
.IP \(bu 2
732b63b0b9 Merge mine details whenever possible
.IP \(bu 2
96b31d5643 Override proxy opts with pillar data when required
.IP \(bu 2
fd499887f9 Define new proxy merge pillar in opts... opts
.IP \(bu 2
abab6fd91c Override minion opts with pillar data
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41943\fP: (\fI\%twangboy\fP) Fix \fIunit.returners.test_local_cache\fP for Windows
@ \fI2017\-09\-11 21:34:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
08d102c869 Merge pull request \fI\%#41943\fP from twangboy/win_unit_test_local_cache
.IP \(bu 2
3777b34572 Merge branch \(aq2017.7\(aq into win_unit_test_local_cache
.IP \(bu 2
35b79ecde6 Remove \fIcur\fP variable, use time.time() in comparison
.IP \(bu 2
9b61533b09 Get more accurate currnet time in local_cache
.IP \(bu 2
844e3f65bc Fix unit tests for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43424\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_hosts\fP for Windows
@ \fI2017\-09\-11 21:28:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
50ab79f0cb Merge pull request \fI\%#43424\fP from twangboy/win_unit_test_hosts
.IP \(bu 2
90dcf8287c Fix \fIunit.modules.test_hosts\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42652\fP: (\fI\%skizunov\fP) Fix loader.py\(aqs raw_mod() to look in all module dirs
@ \fI2017\-09\-11 19:43:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
0f0ed5a093 Merge pull request \fI\%#42652\fP from skizunov/develop3
.IP \(bu 2
d82e406f15 Fix loader.py\(aqs raw_mod() to look in all module dirs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43438\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-09\-11 18:33:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca091bc8a4 Merge pull request \fI\%#43438\fP from rallytime/merge\-2017.7
.IP \(bu 2
ef7b4242c3 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
57cccd75d0 Merge pull request \fI\%#43390\fP from aogier/43387\-genesis\-qemu
.INDENT 2.0
.IP \(bu 2
496f14a7e7 forgot to mock the proper one
.IP \(bu 2
51c7a1ba00 only check if static_qemu is_executable()
.IP \(bu 2
70642e495d better qemu_static parameter mangle in deboostrap management, tests
.UNINDENT
.IP \(bu 2
6106aec696 Merge pull request \fI\%#43356\fP from gtmanfred/2016.11
.INDENT 2.0
.IP \(bu 2
3f19b247f3 Add handler.messages back in for test comparison
.IP \(bu 2
9911b04208 fix test
.IP \(bu 2
3c6ae99a77 never\-download got readded
.UNINDENT
.IP \(bu 2
e638fac54e Merge pull request \fI\%#43325\fP from doesitblend/salt\-mine\-doc\-fix
.INDENT 2.0
.IP \(bu 2
1e94d0ac3a Lint: Remove trailing whitespace
.IP \(bu 2
51af8f8757 Fix mine_interval phrasing in default file
.IP \(bu 2
ba0cdd4536 Fix phrasing for mine_interval description
.IP \(bu 2
9ff03c2d43 Update Salt Mine documentation to show that the mine_interval option is configured in minutes.
.UNINDENT
.IP \(bu 2
fc587f784a Merge pull request \fI\%#43105\fP from aogier/43086\-no\-member
.INDENT 2.0
.IP \(bu 2
5111cf8bad Merge branch \(aq2016.11\(aq into 43086\-no\-member
.UNINDENT
.IP \(bu 2
d97a680372 Merge pull request \fI\%#43333\fP from damon\-atkins/2016.11
.INDENT 2.0
.IP \(bu 2
92de2bb498 Update doco
.IP \(bu 2
fc9c61d12e Update win_pkg.py
.IP \(bu 2
c91fc14704 Merge branch \(aq2016.11\(aq into 2016.11
.IP \(bu 2
cb3af2bbbd Docs are wrong cache_dir (bool) and cache_file (str) cannot be passed on the cli (#2)
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
42a118ff56 fixed cmd composition and unified his making across module
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
3fd59ed369 Adding a small check to ensure we do not continue to populate kwargs with __pub_ items from the kwargs item.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43320\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_alternatives\fP for Windows
@ \fI2017\-09\-11 17:28:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
a9592dd3e2 Merge pull request \fI\%#43320\fP from twangboy/win_fix_alternatives
.IP \(bu 2
a909813fa5 Remove unused import (lint)
.IP \(bu 2
3ef8d714cb Fix unit tests to mock salt.utils.path.readlink
.IP \(bu 2
c0d81aa1ce Use salt.utils.path.readlink
.IP \(bu 2
7c4460164b Fix alternatives for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43363\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_ini_manage\fP for Windows
@ \fI2017\-09\-11 17:10:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
9b89e49846 Merge pull request \fI\%#43363\fP from twangboy/scratch_ini_tests
.IP \(bu 2
a94319a082 Make sure formatting of TEST_FILE_CONTENT matches original
.IP \(bu 2
6263bc8983 Remove print statement
.IP \(bu 2
79cd3831ae Fix empty value preserved test
.IP \(bu 2
85997391f1 Is this handled the same on Linux and Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43421\fP: (\fI\%gtmanfred\fP) Revert \(dqReduce fileclient.get_file latency by merging _file_find and …
@ \fI2017\-09\-11 17:07:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
673ce387c1 Merge pull request \fI\%#43421\fP from gtmanfred/compat
.IP \(bu 2
f85bf8c18f Revert \(dqReduce fileclient.get_file latency by merging _file_find and _file_hash\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42165\fP: (\fI\%arount\fP) top_file_merging_strategy: merge does not works (refs: \fI\%#43415\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43415\fP: (\fI\%mattLLVW\fP) Fix env_order in state.py (refs: \fI\%#43672\fP)
@ \fI2017\-09\-11 15:18:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
47d982fd37 Merge pull request \fI\%#43415\fP from mattLLVW/fix\-env\-order
.IP \(bu 2
f6313a1b2c Merge branch \(aq2017.7\(aq into fix\-env\-order
.IP \(bu 2
e93a962980 Fix env_order in state.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43422\fP: (\fI\%twangboy\fP) Fix \fIunit.cloud.clouds.test_ec2\fP for Windows
@ \fI2017\-09\-11 15:17:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
e89e23a32e Merge pull request \fI\%#43422\fP from twangboy/win_unit_cloud_ec2
.IP \(bu 2
1379627334 Fix \fIunit.cloud.clouds.test_ec2\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43423\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_gem\fP for Windows
@ \fI2017\-09\-11 15:15:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
54f833ac59 Merge pull request \fI\%#43423\fP from twangboy/win_unit_test_gem
.IP \(bu 2
b2cea18d13 Fix \fIunit.modules.test_gem\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43419\fP: (\fI\%gtmanfred\fP) make cache dirs when spm starts (refs: \fI\%#43432\fP)
@ \fI2017\-09\-11 13:42:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
b3116109e5 Merge pull request \fI\%#43419\fP from gtmanfred/2017.7
.IP \(bu 2
58378866e5 make cache dirs when spm starts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43371\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-09\-08 15:39:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
9b27473763 Merge pull request \fI\%#43371\fP from rallytime/merge\-2017.7
.IP \(bu 2
7b07b58396 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
0c986f5eba Merge pull request \fI\%#43361\fP from rallytime/bp\-43329
.INDENT 2.0
.IP \(bu 2
b09e5b4379 Fix \fI\%#43295\fP, better handling of consul initialization issues
.UNINDENT
.IP \(bu 2
22287439e6 Merge pull request \fI\%#42903\fP from junovitch/issue\-35840\-fix\-preserve\-minion\-cache\-2016.11
.INDENT 2.0
.IP \(bu 2
c9d4fdbd45 Merge branch \(aq2016.11\(aq into issue\-35840\-fix\-preserve\-minion\-cache\-2016.11
.IP \(bu 2
93a68e32a5 Merge branch \(aq2016.11\(aq into issue\-35840\-fix\-preserve\-minion\-cache\-2016.11
.IP \(bu 2
079f097985 Fix \(aqpreserve_minion_cache: True\(aq functionality (fixes \fI\%#35840\fP)
.UNINDENT
.IP \(bu 2
4860e10757 Merge pull request \fI\%#43360\fP from terminalmage/sj\-496
.INDENT 2.0
.IP \(bu 2
433bca14b1 Fix KeyError in yumpkg configparser code on Python 3
.IP \(bu 2
f6c16935d8 Move \-\-showduplicates before repository\-packages
.UNINDENT
.IP \(bu 2
4ba2dbe41e Merge pull request \fI\%#43244\fP from rallytime/release\-branch\-clarifications
.INDENT 2.0
.IP \(bu 2
0d5a46dbaa Update release branch section with a few more details
.UNINDENT
.IP \(bu 2
1a012eb3d7 Merge pull request \fI\%#43359\fP from gtmanfred/ipaddr
.INDENT 2.0
.IP \(bu 2
23d9abb560 ipaddr_start ipaddr_end for el7
.UNINDENT
.IP \(bu 2
8f88111be8 Merge pull request \fI\%#43247\fP from rallytime/mentionbot\-backports
.INDENT 2.0
.IP \(bu 2
2b85757d73 Always notify tkwilliams when changes occur on boto files
.IP \(bu 2
40b5a29f90 Add basepi to userBlacklist for mention bot
.IP \(bu 2
bad8f56969 Always notify ryan\-lane when changes occur on boto files
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43398\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_mount\fP for Windows
@ \fI2017\-09\-08 13:39:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
97f05ff603 Merge pull request \fI\%#43398\fP from twangboy/win_fix_test_mount
.IP \(bu 2
4a8d7e522c Fix tests, Use full path to salt.utils.which
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43399\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_pam\fP for Windows
@ \fI2017\-09\-08 13:37:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a4cc5c1b0 Merge pull request \fI\%#43399\fP from twangboy/win_fix_test_pam
.IP \(bu 2
6257aa964a Fix \fIunit.modules.test_pam\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43400\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_parted\fP for Windows
@ \fI2017\-09\-08 13:37:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
2b5cfae3f8 Merge pull request \fI\%#43400\fP from twangboy/win_unit_test_parted
.IP \(bu 2
8e3e897ee2 Fix \fIunit.modules.test_parted\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43401\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_pw_group\fP for Windows
@ \fI2017\-09\-08 13:35:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
332deeb013 Merge pull request \fI\%#43401\fP from twangboy/win_unit_test_pw_group
.IP \(bu 2
78e39a1b9d Fix \fIunit.modules.test_pw_group\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43402\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_qemu_nbd\fP for Windows
@ \fI2017\-09\-08 13:34:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
c0f54bfef1 Merge pull request \fI\%#43402\fP from twangboy/win_unit_test_qemu_nbd
.IP \(bu 2
531ce8022b Fix \fIunit.modules.test_qemu_nbd\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43404\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_seed\fP for Windows
@ \fI2017\-09\-08 13:32:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
be88fbb45f Merge pull request \fI\%#43404\fP from twangboy/win_unit_test_seed
.IP \(bu 2
6ceb895a84 Use os.path.join for paths
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43301\fP: (\fI\%twangboy\fP) Fix \fIunit.test_spm\fP for Windows
@ \fI2017\-09\-08 13:24:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
612c6a8756 Merge pull request \fI\%#43301\fP from twangboy/win_fix_unit_test_spm
.IP \(bu 2
8608a6b303 Merge branch \(aq2017.7\(aq into win_fix_unit_test_spm
.IP \(bu 2
b8da04c04d Add Mike\(aqs changes
.IP \(bu 2
f36efbd6a7 Fix \fIunit.test_spm\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43372\fP: (\fI\%skizunov\fP) Fix system.set_system_time when no hw clock is present
@ \fI2017\-09\-07 17:45:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
f959113694 Merge pull request \fI\%#43372\fP from skizunov/develop5
.IP \(bu 2
281e471853 Fix system.set_system_time when no hw clock is present
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43193\fP: (\fI\%jettero\fP) Prevent spurious \(dqTemplate does not exist\(dq error
@ \fI2017\-09\-06 20:16:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39516\fP: (\fI\%jettero\fP) Prevent spurious \(dqTemplate does not exist\(dq error (refs: \fI\%#43193\fP)
.IP \(bu 2
6d13535ed0 Merge pull request \fI\%#43193\fP from jettero/template\-dne\-again
.IP \(bu 2
cde8aed2cf Merge branch \(aq2017.7\(aq into template\-dne\-again
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42706\fP: (\fI\%blarghmatey\fP) Parallel Cache Failure (refs: \fI\%#43018\fP, \fI\%#43159\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43159\fP: (\fI\%jubrad\fP) Bp 43018
@ \fI2017\-09\-05 22:29:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43056\fP: (\fI\%damon\-atkins\fP) safe_filename_leaf(file_basename) and safe_filepath(file_path_name) (refs: \fI\%#43159\fP, \fI\%#43172\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43018\fP: (\fI\%jubrad\fP) Update state.py (refs: \fI\%#43159\fP, \fI\%#43727\fP)
.IP \(bu 2
015cbc57d9 Merge pull request \fI\%#43159\fP from jubrad/bp\-43018
.IP \(bu 2
25419a56db Merge branch \(aq2017.7\(aq into bp\-43018
.IP \(bu 2
971b4c0890 Merge branch \(aq2017.7\(aq into bp\-43018
.IP \(bu 2
4f8e6c65e5 access safe_filename_leaf through utils.files, changed in \fI\%#43172\fP
.IP \(bu 2
42064883ea state.py remove unused urllib import
.IP \(bu 2
4957268b37 update state.py to use safe_filename_leaf
.IP \(bu 2
b8ead879ed Fixing lint issues
.IP \(bu 2
446457d017 Swapping \fIfrom\fP for \fIimport\fP
.IP \(bu 2
fb80e17400 state.py: fix import and utf8 encode before quote
.IP \(bu 2
1dcf167bb7 Update state.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43232\fP: (\fI\%terminalmage\fP) Improve inheritance in salt.utils.gitfs
@ \fI2017\-09\-05 20:37:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
6e1b541b46 Merge pull request \fI\%#43232\fP from terminalmage/gitfs\-inheritance
.IP \(bu 2
53bd3a3e23 Improve inheritance in salt.utils.gitfs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43238\fP: (\fI\%s0undt3ch\fP) Include the line number by default on the log file format
@ \fI2017\-09\-05 20:31:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
086b220091 Merge pull request \fI\%#43238\fP from s0undt3ch/2017.7
.IP \(bu 2
630a1db3ab Include the line number by default on the log file format
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43294\fP: (\fI\%twangboy\fP) Win build scripts
@ \fI2017\-09\-05 20:12:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
09dc58cde5 Merge pull request \fI\%#43294\fP from twangboy/win_build_scripts
.IP \(bu 2
9979ccb613 Remove Py2 and Py3 in the same run
.IP \(bu 2
a5d9f85db6 Modifications to build scripts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43322\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-09\-05 18:21:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
21ab306ef4 Merge pull request \fI\%#43322\fP from rallytime/merge\-2017.7
.IP \(bu 2
b1062f8c15 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
02867fdcd2 Merge pull request \fI\%#43277\fP from rallytime/owners\-file
.INDENT 2.0
.IP \(bu 2
2b4da0f0e7 Add CODEOWNERS file
.UNINDENT
.IP \(bu 2
1c1c484479 Merge pull request \fI\%#43312\fP from lordcirth/fix\-cron\-docs
.INDENT 2.0
.IP \(bu 2
ec94a13750 cron docs: Remind user to use quotes for special strings
.UNINDENT
.IP \(bu 2
0d1ed4b750 Merge pull request \fI\%#43290\fP from lordcirth/fix\-file\-path\-docs
.INDENT 2.0
.IP \(bu 2
14a4591854 file.py docs: correct group and mode
.IP \(bu 2
d4214ca283 file.py docs: specify absolute paths
.UNINDENT
.IP \(bu 2
26ff89539e Merge pull request \fI\%#43274\fP from terminalmage/fix\-int\-types
.INDENT 2.0
.IP \(bu 2
d533877743 Use six.integer_types instead of int
.UNINDENT
.IP \(bu 2
cf21f91fb2 Merge pull request \fI\%#43271\fP from twangboy/win_fix_pkg.install
.INDENT 2.0
.IP \(bu 2
91b062f564 Fix formatting issue, spaces surrounding +
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43324\fP: (\fI\%twangboy\fP) Fix \fIunit.modules.test_chef\fP for Windows
@ \fI2017\-09\-05 16:40:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
62429c547d Merge pull request \fI\%#43324\fP from twangboy/fix_unit.modules.test_chef
.IP \(bu 2
5bd5ea042a Fix \fIunit.modules.test_chef\fP for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43268\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43237\fP to 2017.7
@ \fI2017\-09\-01 18:17:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43237\fP: (\fI\%timka\fP) .utils.aws.get_location() expects a dict (refs: \fI\%#43268\fP)
.IP \(bu 2
367668a0a3 Merge pull request \fI\%#43268\fP from rallytime/bp\-43237
.IP \(bu 2
047ad07da4 .utils.aws.get_location() expects a dict
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43270\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2017\-09\-01 18:09:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
02504dd363 Merge pull request \fI\%#43270\fP from rallytime/merge\-2017.7
.IP \(bu 2
f8b025f6dc Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
3a0b02f3ae Merge pull request \fI\%#43228\fP from twangboy/win_fix_pkg.install
.INDENT 2.0
.IP \(bu 2
13dfabb1ce Fix regex statement, add \fI\&.\fP
.IP \(bu 2
31ff69f0ad Add underscore to regex search
.IP \(bu 2
3cf2b6575c Fix spelling
.IP \(bu 2
ed030a35a5 Use regex to detect salt\-minion install
.IP \(bu 2
e5daff495a Fix pkg.install
.UNINDENT
.IP \(bu 2
b4c689dff5 Merge pull request \fI\%#43191\fP from viktorkrivak/fix\-apache\-config\-multi\-entity
.INDENT 2.0
.IP \(bu 2
c15bcbe1cc Merge remote\-tracking branch \(aqupstream/2016.11\(aq into fix\-apache\-config\-multi\-entity
.IP \(bu 2
4164047951 Fix apache.config with multiple statement At this moment when you post more than
one statement in config only last is used. Also file is rewritten multiple times until last
statement is written. Example: salt \(aq*\(aq apache.config /etc/httpd/conf.d/ports.conf
config=\(dq[{\(aqListen\(aq: \(aq8080\(aq}, {\(aqProxy\(aq: \(dqSomething\(dq}]\(dq Ends only with Proxy Something and
ignore Listen 8080, This patch fix this issue.
.UNINDENT
.IP \(bu 2
b90e59ede9 Merge pull request \fI\%#43154\fP from lomeroe/bp\-43116\-2016.11
.IP \(bu 2
8f593b0b02 verify that files exist before trying to remove them, win_file.remove raises an exception if the file does not exist
.IP \(bu 2
33a30bac06 correcting bad format statement in search for policy to be disabled
.IP \(bu 2
acc3d7ac82 correct fopen calls from salt.utils for 2016.11\(aqs utils function
.IP \(bu 2
2da1cdd109 lint fix
.IP \(bu 2
61bd12c0de track xml namespace to ensure policies w/duplicate IDs or Names do not conflict
.IP \(bu 2
f232bed9f9 add additional checks for ADM policies that have the same ADMX policy ID (\fI\%#42279\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42459\fP: (\fI\%iavael\fP) Broken ldap groups retrieval in salt.auth.ldap after upgrade to 2017.7 (refs: \fI\%#43283\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43283\fP: (\fI\%DmitryKuzmenko\fP) Fix ldap token groups auth.
@ \fI2017\-09\-01 17:49:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
ece0e393ef Merge pull request \fI\%#43283\fP from DSRCorporation/bugs/42459_broken_ldap_groups
.IP \(bu 2
3ad6911210 Fix for tests: don\(aqt require \(aqgroups\(aq in the eauth token.
.IP \(bu 2
1f104cf85b Fix ldap token groups auth.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43149\fP: (\fI\%BenoitKnecht\fP) Fix iptables.get_rules when rules contain \-\-nfmask or \-\-ctmask
@ \fI2017\-09\-01 15:57:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
4f023c4cb6 Merge pull request \fI\%#43149\fP from BenoitKnecht/2017.7.1
.IP \(bu 2
3c1ddc9bde modules: iptables: correctly parse \fI\-\-nfmask\fP/\fI\-\-ctmask\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43258\fP: (\fI\%nomeelnoj\fP) metadata_server_grains problems (refs: \fI\%#43265\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43265\fP: (\fI\%gtmanfred\fP) make sure meta\-data grains work on ec2
@ \fI2017\-09\-01 15:31:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
cf2b75bb86 Merge pull request \fI\%#43265\fP from gtmanfred/2017.7
.IP \(bu 2
04dd8ebedb make sure meta\-data grains work on ec2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43299\fP: (\fI\%twangboy\fP) Fix \fIunit.netapi.rest_cherrypy.test_tools\fP for Windows
@ \fI2017\-09\-01 15:13:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
618b221895 Merge pull request \fI\%#43299\fP from twangboy/win_fix_netapi_cherrypy
.IP \(bu 2
fd74acb603 Merge branch \(aq2017.7\(aq into win_fix_netapi_cherrypy
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43300\fP: (\fI\%twangboy\fP) Fix \fIunit.netapi.rest_tornado.test_handlers\fP for Windows
@ \fI2017\-09\-01 13:10:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
aee654da92 Merge pull request \fI\%#43300\fP from twangboy/win_fix_netapi_rest_tornado
.IP \(bu 2
c93d2ed386 Use os.sep instead of \(aq/\(aq
.IP \(bu 2
3fbf24b91a Use os.sep instead of \(aq/\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43259\fP: (\fI\%mahesh21\fP) NameError: global name \(aq__opts__\(aq is not defined (refs: \fI\%#43266\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43278\fP: (\fI\%gtmanfred\fP) bootstrap can come from dunders
@ \fI2017\-08\-31 13:31:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43266\fP: (\fI\%gtmanfred\fP) switch virtualbox cloud driver to use __utils__ (refs: \fI\%#43278\fP)
.IP \(bu 2
aed2975979 Merge pull request \fI\%#43278\fP from gtmanfred/virtualbox
.IP \(bu 2
c4ae2de30f bootstrap can come from dunders
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42975\fP: (\fI\%brejoc\fP) Added unit tests for Kubernetes module
@ \fI2017\-08\-30 20:30:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
479e0e06ac Merge pull request \fI\%#42975\fP from brejoc/tests\-for\-kubernetes\-module
.IP \(bu 2
fdad9177b5 Merge branch \(aq2017.7\(aq into tests\-for\-kubernetes\-module
.IP \(bu 2
c227cb25ad Skipping test on ImportError
.IP \(bu 2
bd76a870ce Dunder vars are now defined via setup_loader_modules
.IP \(bu 2
3c99e61637 Renamed test to match new convention
.IP \(bu 2
caf78d206d Fixed imports for pytest
.IP \(bu 2
c8e98c8d8a Added unit tests for Kubernetes module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42935\fP: (\fI\%BenjaminSchubert\fP) docker_image.present always ends up failing even on correct result. (refs: \fI\%#43176\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43176\fP: (\fI\%terminalmage\fP) docker_image states: Handle Hub images prefixed with \(dqdocker.io/\(dq
@ \fI2017\-08\-30 20:08:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca7df1d4cf Merge pull request \fI\%#43176\fP from terminalmage/issue42935
.IP \(bu 2
df18a89836 Lint: Remove unused import
.IP \(bu 2
7279f98e92 docker_image states: Handle Hub images prefixed with \(dqdocker.io/\(dq
.IP \(bu 2
f7c945f6e4 Prevent spurious \(dqTemplate does not exist\(dq error
.UNINDENT
.UNINDENT
.SS Salt 2017.7.4 Release Notes
.sp
Version 2017.7.4 is a bugfix release for \fI\%2017.7.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB8\fP
.IP \(bu 2
Total Issue References: \fB4\fP
.IP \(bu 2
Total PR References: \fB11\fP
.IP \(bu 2
Contributors: \fB6\fP (\fI\%Ch3LL\fP, \fI\%garethgreenaway\fP, \fI\%gtmanfred\fP, \fI\%marccardinal\fP, \fI\%rallytime\fP, \fI\%terminalmage\fP)
.UNINDENT
.SS Changelog for v2017.7.3..v2017.7.4
.sp
\fIGenerated at: 2018\-05\-26 21:48:28 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#46074\fP: (\fI\%Ch3LL\fP) Update 2017.7.4 Release Notes with new fixes
@ \fI2018\-02\-16 16:47:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
b5b083fd26 Merge pull request \fI\%#46074\fP from Ch3LL/update\-7.4
.IP \(bu 2
8d0eeeb059 Update 2017.7.4 Release Notes with new fixes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45790\fP: (\fI\%bdarnell\fP) Test with Tornado 5.0b1 (refs: \fI\%#46066\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46066\fP: (\fI\%rallytime\fP) Pin tornado version in requirements file
@ \fI2018\-02\-16 16:40:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
32f3d00e44 Merge pull request \fI\%#46066\fP from rallytime/pin\-tornado
.IP \(bu 2
6dc1a3b9dc Pin tornado version in requirements file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46036\fP: (\fI\%terminalmage\fP) git.latest: Fix regression with identity file usage
@ \fI2018\-02\-16 13:57:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
85761ee650 Merge pull request \fI\%#46036\fP from terminalmage/issue43769
.IP \(bu 2
e2140d9a84 Mock the ssh.key_is_encrypted utils func
.IP \(bu 2
169924b3fe Move ssh.key_is_encrypted to a utils module temporarily
.IP \(bu 2
54f4d78f7a Only keep ssh.py in the Windows installer
.IP \(bu 2
5f04531e1b Keep ssh state and execution modules in the installer
.IP \(bu 2
f2b69f703d git.latest: Fix regression with identity file usage
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46009\fP: (\fI\%Ch3LL\fP) Add 2017.7.4 Release Notes with PRs
@ \fI2018\-02\-13 16:40:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
6d534c6e7e Merge pull request \fI\%#46009\fP from Ch3LL/rn_7.4
.IP \(bu 2
ac0baf4b34 Add 2017.7.4 Release Notes with PRs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45976\fP: (\fI\%ghost\fP) 6a5e0f9 introduces regression that breaks Vault module for salt masterless (refs: \fI\%#45981\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45981\fP: (\fI\%gtmanfred\fP) use local config for vault when masterless
@ \fI2018\-02\-13 15:22:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca76a0b328 Merge pull request \fI\%#45981\fP from gtmanfred/2017.7.3
.IP \(bu 2
0d448457dc apparently local is not set by default
.IP \(bu 2
2a92f4bc16 use local config for vault when masterless
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45915\fP: (\fI\%MatthiasKuehneEllerhold\fP) 2017.7.3: Salt\-SSH & Vault Pillar: Permission denied \(dqminion.pem\(dq (refs: \fI\%#45928\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45953\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45928\fP to 2017.7.3
@ \fI2018\-02\-09 22:29:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45928\fP: (\fI\%garethgreenaway\fP) [2017.7] Fixing vault when used with pillar over salt\-ssh (refs: \fI\%#45953\fP)
.IP \(bu 2
6530649dbc Merge pull request \fI\%#45953\fP from rallytime/bp\-45928\-2017.7.3
.IP \(bu 2
85363189d1 Fixing vault when used with pillar over salt\-ssh
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45893\fP: (\fI\%CrackerJackMack\fP) archive.extracted ValueError \(dqNo path specified\(dq in 2017.7.3 (refs: \fI\%#45902\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45934\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45902\fP to 2017.7.3
@ \fI2018\-02\-09 16:31:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45902\fP: (\fI\%terminalmage\fP) Check the effective saltenv for cached archive (refs: \fI\%#45934\fP)
.IP \(bu 2
fb378cebb0 Merge pull request \fI\%#45934\fP from rallytime/bp\-45902
.IP \(bu 2
bb83e8b345 Add regression test for issue 45893
.IP \(bu 2
cdda66d759 Remove duplicated section in docstring and fix example
.IP \(bu 2
4b6351cda6 Check the effective saltenv for cached archive
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45935\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45742\fP to 2017.7.3
@ \fI2018\-02\-09 14:02:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45742\fP: (\fI\%marccardinal\fP) list.copy() is not compatible with python 2.7 (refs: \fI\%#45935\fP)
.IP \(bu 2
0d74151c71 Merge pull request \fI\%#45935\fP from rallytime/bp\-45742
.IP \(bu 2
6a0b5f7af3 Removed the chained copy
.IP \(bu 2
ad1150fad4 list.copy() is not compatible with python 2.7
.UNINDENT
.UNINDENT
.SS Salt 2017.7.5 Release Notes
.sp
Version 2017.7.5 is a bugfix release for \fI\%2017.7.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB213\fP
.IP \(bu 2
Total Issue References: \fB58\fP
.IP \(bu 2
Total PR References: \fB202\fP
.IP \(bu 2
Contributors: \fB52\fP (\fI\%Ch3LL\fP, \fI\%DmitryKuzmenko\fP, \fI\%GwiYeong\fP, \fI\%L4rS6\fP, \fI\%SteffenKockel\fP,
\fI\%The\-Loeki\fP, \fI\%amendlik\fP, \fI\%andreaspe\fP, \fI\%angeloudy\fP, \fI\%aphor\fP, \fI\%bdrung\fP, \fI\%cebe\fP, \fI\%ciiqr\fP,
\fI\%damon\-atkins\fP, \fI\%danlsgiga\fP, \fI\%ddoh94\fP, \fI\%dmurphy18\fP, \fI\%dwoz\fP, \fI\%eliasp\fP, \fI\%frogunder\fP,
\fI\%garethgreenaway\fP, \fI\%gclinch\fP, \fI\%gtmanfred\fP, \fI\%jfindlay\fP, \fI\%kstreee\fP, \fI\%marccardinal\fP,
\fI\%mcalmer\fP, \fI\%mchugh19\fP, \fI\%meaksh\fP, \fI\%michelsen\fP, \fI\%nullify005\fP, \fI\%oarmstrong\fP, \fI\%oeuftete\fP,
\fI\%philpep\fP, \fI\%racker\-markh\fP, \fI\%rallytime\fP, \fI\%redbaron4\fP, \fI\%roaldnefs\fP, \fI\%rongshengfang\fP,
\fI\%rongzeng54\fP, \fI\%rrroo\fP, \fI\%samilaine\fP, \fI\%samodid\fP, \fI\%skizunov\fP, \fI\%terminalmage\fP, \fI\%tintoy\fP,
\fI\%twangboy\fP, \fI\%viktordaniel\fP, \fI\%vutny\fP, \fI\%while0pass\fP, \fI\%whytewolf\fP, \fI\%zer0def\fP)
.UNINDENT
.SS Changes to \fI\%file.blockreplace\fP State
.sp
The \fBappend_newline\fP argument was added to this state. Additionally, to
improve idempotence, if the string represented by \fBmarker_end\fP is found in
the middle of the line, the content preceding the marker will be removed when
the block is replaced. This allows one to remove \fBappend_newline: False\fP from
the SLS and have the block properly replaced if the end of the content block is
immediately followed by the \fBmarker_end\fP (i.e. no newline before the marker).
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This will require changes to your SLS if your \fBmarker_end\fP does not
include the very beginning of the content you want to keep.
.UNINDENT
.UNINDENT
.sp
See the \fI\%file.blockreplace\fP state
documentation for further information.
.SS Changelog for v2017.7.4..v2017.7.5
.sp
\fIGenerated at: 2018\-05\-26 21:50:00 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#46612\fP: (\fI\%Ch3LL\fP) Add changelog to 2017.7.5 release notes
@ \fI2018\-03\-19 20:47:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
19bb725698 Merge pull request \fI\%#46612\fP from Ch3LL/7.5_rn
.IP \(bu 2
6076bfa2ee Add changelog to 2017.7.5 release
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46572\fP: (\fI\%dmurphy18\fP) Addition of \-sa flag to allow for revision numbers other than \-0 or \-1
@ \fI2018\-03\-19 20:07:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
31c78aef11 Merge pull request \fI\%#46572\fP from dmurphy18/update_xxxbuild
.IP \(bu 2
c87511570d Merge branch \(aq2017.7.5\(aq into update_xxxbuild
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#884\fP: (\fI\%gtmanfred\fP) [2017.7.5][Fedora 27][py2/py3] integration.states.test_npm.NpmStateTest.test_npm_install_url_referenced_package (refs: \fI\%#46577\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46577\fP: (\fI\%gtmanfred\fP) Fix npm issue
@ \fI2018\-03\-19 11:51:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
cdd768fa4d Merge pull request \fI\%#46577\fP from gtmanfred/2017.7.5
.IP \(bu 2
78cbf7b5cd Fix npm issue
.IP \(bu 2
c76f7eb028 enable debug logging on the minionlog
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46551\fP: (\fI\%terminalmage\fP) Fix failing pkg integration test on OpenSUSE
@ \fI2018\-03\-19 11:50:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
e6682c660c Merge pull request \fI\%#46551\fP from terminalmage/salt\-jenkins\-885
.IP \(bu 2
703b5e7e65 Change versionadded to show that 2018.3.0 will not have this function
.IP \(bu 2
010d260d06 Rewrite failing Suse pkg integration test
.IP \(bu 2
f3f5dec239 zypper.py: fix version argument being ignored
.IP \(bu 2
214f2d6ad3 Add pkg.list_repo_pkgs to zypper.py
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
0a541613f2 Additon of \-sa flag to allow for revision numbers other than \-0 or \-1
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#886\fP: (\fI\%gtmanfred\fP) [2017.7.5][Fedora 26/Ubuntu 17.10][py3] integration.states.test_pip.PipStateTest.test_46127_pip_env_vars (refs: \fI\%#46563\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46563\fP: (\fI\%gtmanfred\fP) virtualenv version too old for python3.6
@ \fI2018\-03\-15 20:17:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd62699ccb Merge pull request \fI\%#46563\fP from gtmanfred/2017.7.5
.IP \(bu 2
8d5ab72983 virtualenv version too old for python3.6
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46561\fP: (\fI\%gtmanfred\fP) disable verbose
@ \fI2018\-03\-15 16:36:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
2916708124 Merge pull request \fI\%#46561\fP from gtmanfred/2017.7.5
.IP \(bu 2
2c39ac6dfb disable verbose
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46537\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46529\fP to 2017.7.5
@ \fI2018\-03\-14 14:47:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46529\fP: (\fI\%gtmanfred\fP) retry if there is a segfault (refs: \fI\%#46537\fP)
.IP \(bu 2
ee3bff6e32 Merge pull request \fI\%#46537\fP from rallytime/bp\-46529
.IP \(bu 2
289c7a228f retry if there is a segfault
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46519\fP: (\fI\%rallytime\fP) Update man pages for 2017.7.5
@ \fI2018\-03\-13 20:00:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
1271536a89 Merge pull request \fI\%#46519\fP from rallytime/man\-pages\-2017.7.5
.IP \(bu 2
782a5584f5 Update man pages for 2017.7.5
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46207\fP: (\fI\%seanjnkns\fP) Issue \fI\%#44034\fP still unresolved (refs: \fI\%#46493\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#44034\fP: (\fI\%seanjnkns\fP) salt\-call pillar overrides broken in 2016.11.8 and 2017.7.2 (refs: \fI\%#44483\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46493\fP: (\fI\%terminalmage\fP) salt\-call: don\(aqt re\-use initial pillar if CLI overrides passed
@ \fI2018\-03\-12 20:41:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44483\fP: (\fI\%terminalmage\fP) salt\-call: account for instances where __pillar__ is empty (refs: \fI\%#46493\fP)
.IP \(bu 2
0e90c8ca6f Merge pull request \fI\%#46493\fP from terminalmage/issue46207
.IP \(bu 2
f06ff68f10 salt\-call: don\(aqt re\-use initial pillar if CLI overrides passed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46450\fP: (\fI\%gtmanfred\fP) load grains for salt.cmd runner
@ \fI2018\-03\-12 18:52:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
b11a8fc8e0 Merge pull request \fI\%#46450\fP from gtmanfred/salt_runner
.IP \(bu 2
7974ff7264 load grains for salt.cmd runner
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30115\fP: (\fI\%gtmanfred\fP) [BUG] listen does not appear to respect the special names directive (refs: \fI\%#46337\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46337\fP: (\fI\%gtmanfred\fP) Fix using names with listen and listen_in
@ \fI2018\-03\-12 18:50:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
22d753364b Merge pull request \fI\%#46337\fP from gtmanfred/2017.7
.IP \(bu 2
d6d9e36359 add tests for names and listen/listen_in
.IP \(bu 2
3f8e0db572 let listen_in work with names
.IP \(bu 2
7161f4d4df fix listen to be able to handle names
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46413\fP: (\fI\%meaksh\fP) Explore \(aqmodule.run\(aq state module output in depth to catch \(dqresult\(dq properly
@ \fI2018\-03\-12 18:49:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
b7191b8782 Merge pull request \fI\%#46413\fP from meaksh/2017.7\-explore\-result\-in\-depth
.IP \(bu 2
885751634e Add new unit test to check state.apply within module.run
.IP \(bu 2
9f19ad5264 Rename and fix recursive method
.IP \(bu 2
1476ace558 Fix Python3 and pylint issue
.IP \(bu 2
726ca3044d Explore \(aqmodule.run\(aq response to catch the \(aqresult\(aq in depth
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46496\fP: (\fI\%gtmanfred\fP) more test kitchen clean up
@ \fI2018\-03\-12 18:28:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
02a79a2014 Merge pull request \fI\%#46496\fP from gtmanfred/kitchen
.IP \(bu 2
da002f78d0 include virtualenv path for py3 windows
.IP \(bu 2
fe2efe03ea remove duplicate setup
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46329\fP: (\fI\%bdrung\fP) test_create_deployments fails with python\-kubernetes 4.0.0 (refs: \fI\%#46330\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46330\fP: (\fI\%bdrung\fP) Fix ValueError for template in AppsV1beta1DeploymentSpec
@ \fI2018\-03\-12 16:56:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
5c4c182d75 Merge pull request \fI\%#46330\fP from bdrung/fix_kubernetes_test_create_deployments
.IP \(bu 2
5008c53c44 Fix ValueError for template in AppsV1beta1DeploymentSpec
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46479\fP: (\fI\%rongshengfang\fP) boto_ec2.instance_present throwing KeyError exception when associating EIP to an existing instance (refs: \fI\%#46482\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46482\fP: (\fI\%rongshengfang\fP) Fix KeyError in salt/states/boto_ec2.py
@ \fI2018\-03\-12 15:13:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
c7e05d3ff4 Merge pull request \fI\%#46482\fP from rongshengfang/fix\-keyerror\-in\-instance_present
.IP \(bu 2
ed8c83e89a Fix KeyError in salt/states/boto_ec2.py when an EIP is being associated to an existing instance with the instance_present state.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46463\fP: (\fI\%terminalmage\fP) Update requirements files to depend on mock>=2.0.0
@ \fI2018\-03\-09 19:24:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
573d51afec Merge pull request \fI\%#46463\fP from terminalmage/mock\-2.0
.IP \(bu 2
b958b4699c Update requirements files to depend on mock>=2.0.0
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46299\fP: (\fI\%gclinch\fP) debconf module fails on Python 3 (refs: \fI\%#46300\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46422\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46300\fP to 2017.7
@ \fI2018\-03\-09 19:19:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46300\fP: (\fI\%gclinch\fP) Python 3 support for debconfmod (fixes \fI\%#46299\fP) (refs: \fI\%#46422\fP)
.IP \(bu 2
a154d35fc7 Merge pull request \fI\%#46422\fP from rallytime/bp\-46300
.IP \(bu 2
829dfde8e8 Change stringutils path to old utils path for 2017.7
.IP \(bu 2
91db2e0782 Python 3 support
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46320\fP: (\fI\%mcalmer\fP) add warning about future config option change
@ \fI2018\-03\-09 17:48:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
2afaca17a1 Merge pull request \fI\%#46320\fP from mcalmer/warn\-kubernetes
.IP \(bu 2
c493ced415 add warning about future config option change
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46449\fP: (\fI\%bdrung\fP) Make documentation theme configurable
@ \fI2018\-03\-09 17:47:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
c7f95581e3 Merge pull request \fI\%#46449\fP from bdrung/make\-doc\-theme\-configurable
.IP \(bu 2
4a5da2d144 Make documentation theme configurable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46162\fP: (\fI\%rallytime\fP) Add team\-suse to CODEOWNERS file for zypper files
@ \fI2018\-03\-09 17:46:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
10ce0e9e20 Merge pull request \fI\%#46162\fP from rallytime/team\-suse\-zypper\-owner
.IP \(bu 2
13a295a3b7 Add \fIpkg\fP and \fIsnapper\fP to team\-suse
.IP \(bu 2
35c7b7b0d3 Add btrfs, xfs, yumpkg, and kubernetes file to team\-suse
.IP \(bu 2
485d777ac0 Add team\-suse to CODEOWNERS file for zypper files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46434\fP: (\fI\%gtmanfred\fP) split return key value correctly
@ \fI2018\-03\-09 17:45:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
cac096b311 Merge pull request \fI\%#46434\fP from gtmanfred/highstate_return
.IP \(bu 2
d18f1a55a7 fix pylint
.IP \(bu 2
9e2c3f7991 split return key value correctly
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44452\fP: (\fI\%konstest\fP) salt\-cloud can\(aqt create snapshots, because there is a bug in the Unicode name of the virtual machine (refs: \fI\%#46455\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46455\fP: (\fI\%whytewolf\fP) .format remove fix for \fI\%#44452\fP
@ \fI2018\-03\-09 17:37:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
7dd71101ce Merge pull request \fI\%#46455\fP from whytewolf/Issue_44452_unicode_cloud
.IP \(bu 2
5fe474b1a8 .format remove fix for \fI\%#44452\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46428\fP: (\fI\%twangboy\fP) Fix issue with dev env install on Windows
@ \fI2018\-03\-09 14:52:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
4c8d9026d3 Merge pull request \fI\%#46428\fP from twangboy/win_fix_reqs
.IP \(bu 2
e7ab97cc17 Remove six as a hard dep for Salt
.IP \(bu 2
cc67e5c2ef Set six to 1.11.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46454\fP: (\fI\%gtmanfred\fP) fix windows for kitchen
@ \fI2018\-03\-08 21:19:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
e834d9a63b Merge pull request \fI\%#46454\fP from gtmanfred/kitchen
.IP \(bu 2
b8ab8434a5 fix windows for kitchen
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46451\fP: (\fI\%gmacon\fP) SPM fails to start with customized cache location (refs: \fI\%#46452\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46452\fP: (\fI\%gtmanfred\fP) make spm cache_dir instead of all cachedirs
@ \fI2018\-03\-08 21:12:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
2886dca88f Merge pull request \fI\%#46452\fP from gtmanfred/spm_cache_dir
.IP \(bu 2
169cf7a4e2 make spm cache_dir instead of all cachedirs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46446\fP: (\fI\%bdrung\fP) Fix various typos
@ \fI2018\-03\-08 21:11:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
a188984cd9 Merge pull request \fI\%#46446\fP from bdrung/fix\-typos
.IP \(bu 2
7e6e80be87 heat: Fix spelling mistake of environment
.IP \(bu 2
a3c54b50f6 Fix various spelling mistakes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#20581\fP: (\fI\%notpeter\fP) Many environments: one pillar_root (all your envs are belong to base) (refs: \fI\%#46309\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46309\fP: (\fI\%bdrung\fP) Support dynamic pillar_root environment
@ \fI2018\-03\-08 19:15:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
e35fc5263c Merge pull request \fI\%#46309\fP from bdrung/dynamic\-pillarenv
.IP \(bu 2
584b451fd1 Support dynamic pillar_root environment
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44032\fP: (\fI\%PhilippeAB\fP) blockreplace marker_end isn\(aqt applied with newline (refs: \fI\%#46430\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46430\fP: (\fI\%terminalmage\fP) Improve reliability/idempotence of file.blockreplace state
@ \fI2018\-03\-08 15:41:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
35fe9827fe Merge pull request \fI\%#46430\fP from terminalmage/issue44032
.IP \(bu 2
f9f187e915 Improve reliability/idempotence of file.blockreplace state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46429\fP: (\fI\%twangboy\fP) Fix problem with __virtual__ in win_snmp
@ \fI2018\-03\-07 23:26:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
2bad0a21c0 Merge pull request \fI\%#46429\fP from twangboy/win_fix_snmp
.IP \(bu 2
8995a9b8de Fix problem with __virtual__ in win_snmp
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46100\fP: (\fI\%jfindlay\fP) Handle IPv6 scope parameter in resolv.conf
@ \fI2018\-03\-07 19:51:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
93a572f229 Merge pull request \fI\%#46100\fP from jfindlay/resolv_scope
.IP \(bu 2
d5561bedaf tests.unit.grains.core add scoped IPv6 nameserver
.IP \(bu 2
4e2e62d508 salt.utils.dns parse scope param for ipv6 servers
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46420\fP: (\fI\%bdrung\fP) Fix SSH client exception if SSH is not found
@ \fI2018\-03\-07 17:49:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
5acc1d5c54 Merge pull request \fI\%#46420\fP from bdrung/2017.7
.IP \(bu 2
e48c13d9e0 Fix SSH client exception if SSH is not found
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46379\fP: (\fI\%angeloudy\fP)  TypeError: a bytes\-like object is required, not \(aqstr\(aq
@ \fI2018\-03\-07 15:00:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca6a76e317 Merge pull request \fI\%#46379\fP from angeloudy/2017.7
.IP \(bu 2
3acb59c74c Merge branch \(aq2017.7\(aq into 2017.7
.IP \(bu 2
d971e0c08b Fix indent
.IP \(bu 2
269514683f Update http.py
.IP \(bu 2
908c040ac3 Update http.py
.IP \(bu 2
51ba3c135b Update http.py
.IP \(bu 2
14aba24111 fix bytes\-object required error in python 3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46404\fP: (\fI\%gtmanfred\fP) get 2017.7 ready to switch over to the new jenkins
@ \fI2018\-03\-07 14:29:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
73f9233557 Merge pull request \fI\%#46404\fP from gtmanfred/kitchen
.IP \(bu 2
c56baa95a8 clone .git for the version tests
.IP \(bu 2
3620611b5b fix unhold package for debian
.IP \(bu 2
5219f7d2ba fix minion log path
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46192\fP: (\fI\%asymetrixs\fP) salt\-log\-setup: AttributeError \(aqNoneType\(aq object has no attribute \(aqflush\(aq (refs: \fI\%#46310\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46310\fP: (\fI\%twangboy\fP) Update the Windows installer build scripts
@ \fI2018\-03\-06 20:21:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca28cfd4e4 Merge pull request \fI\%#46310\fP from twangboy/win_update_installer_build
.IP \(bu 2
bcf8b19566 Update the installer build
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46316\fP: (\fI\%twangboy\fP) Fix issues with the DSC module
@ \fI2018\-03\-06 20:16:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
decccbeca3 Merge pull request \fI\%#46316\fP from twangboy/win_fix_dsc
.IP \(bu 2
2042d33d59 Fix issues with the DSC module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46394\fP: (\fI\%Ch3LL\fP) Add mac py2 and py3 packages to mac installation docs
@ \fI2018\-03\-06 16:45:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
95586678c3 Merge pull request \fI\%#46394\fP from Ch3LL/mac_doc
.IP \(bu 2
158add6661 change oxdownload to oxdownload\-{python_version}
.IP \(bu 2
21aa848c89 Add mac py2 and py3 packages to mac installation docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44831\fP: (\fI\%kivoli\fP) cmd.wait deprecated but cannot replicate conditional execution with onchanges (refs: \fI\%#46338\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46338\fP: (\fI\%rallytime\fP) Remove cmd.wait deprecation reference in docs
@ \fI2018\-03\-05 21:48:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
07b5d09ac1 Merge pull request \fI\%#46338\fP from rallytime/fix\-44831
.IP \(bu 2
90771da999 Remove cmd.wait deprecation reference in docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42438\fP: (\fI\%ajoaugustine\fP) Failed to send message: hipchat\-message (refs: \fI\%#46333\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46333\fP: (\fI\%danlsgiga\fP) Fixes color parameter mismatch and handles 204 responses correctly
@ \fI2018\-03\-05 19:42:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
3849e7a085 Merge pull request \fI\%#46333\fP from danlsgiga/issue\-42438
.IP \(bu 2
3b13f37b44 Revert changes in the code and change docs instead
.IP \(bu 2
38114a65d8 Fixes color parameter mismatch and handles 204 responses correctly
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44935\fP: (\fI\%grinapo\fP) module.file.replace string seems to be mutated into arrays (refs: \fI\%#46322\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46322\fP: (\fI\%terminalmage\fP) yamlify_arg: don\(aqt treat leading dashes as lists
@ \fI2018\-03\-05 15:40:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
a8f2f1b063 Merge pull request \fI\%#46322\fP from terminalmage/issue44935
.IP \(bu 2
85ac6a9893 yamlify_arg: don\(aqt treat leading dashes as lists
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46327\fP: (\fI\%samilaine\fP) Modify the way a FQDN is handled in the vmware cloud provider.
@ \fI2018\-03\-05 15:35:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
da5c282cb2 Merge pull request \fI\%#46327\fP from samilaine/fix\-vmware\-cloud\-fqdn
.IP \(bu 2
4b8dfb326f Modify the way a FQDN is handled in the vmware cloud provider.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46318\fP: (\fI\%terminalmage\fP) Skip type\-checking for several gitfs/git_pillar/winrepo params
@ \fI2018\-03\-05 15:04:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
78c45d3786 Merge pull request \fI\%#46318\fP from terminalmage/squelch\-warnings
.IP \(bu 2
5889b36646 Skip type\-checking for several gitfs/git_pillar/winrepo params
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45535\fP: (\fI\%whytewolf\fP) module_dirs left out salt\-ssh, leaving custom ext_pillars and modules out of salt\-ssh (refs: \fI\%#46312\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46312\fP: (\fI\%gtmanfred\fP) add module_dirs to salt ssh thin tarball
@ \fI2018\-03\-05 15:00:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb0d6fc263 Merge pull request \fI\%#46312\fP from gtmanfred/2017.7
.IP \(bu 2
749ae580ed add module_dirs to salt ssh thin tarball
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46127\fP: (\fI\%redbaron4\fP) pip.installed does not pass env_vars when calling freeze to check if package is already installed (refs: \fI\%#46242\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46242\fP: (\fI\%redbaron4\fP) Pass env_vars to pip.freeze
@ \fI2018\-03\-05 14:53:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
88b5f7383d Merge pull request \fI\%#46242\fP from redbaron4/fix\-46127
.IP \(bu 2
06dba51617 Make changes from review
.IP \(bu 2
727ebe1056 Merge branch \(aq2017.7\(aq into fix\-46127
.IP \(bu 2
08d1ee8baf Fix Python3 test errors
.IP \(bu 2
aa9d709015 Pass env_vars to pip.freeze
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46265\fP: (\fI\%Ch3LL\fP) Add username/password to profitbricks conf for cloud tests
@ \fI2018\-03\-02 21:40:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
a0716643e4 Merge pull request \fI\%#46265\fP from Ch3LL/profit_cloud
.IP \(bu 2
d4893eab4c Add username/password to profitbricks conf for cloud tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46306\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46256\fP to 2017.7
@ \fI2018\-03\-02 21:37:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46256\fP: (\fI\%rallytime\fP) Don\(aqt install msgpack 0.5.5 (refs: \fI\%#46306\fP)
.IP \(bu 2
ed7bffa7e0 Merge pull request \fI\%#46306\fP from rallytime/bp\-46256
.IP \(bu 2
6439bce4a8 Don\(aqt install msgpack 0.5.5
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46208\fP: (\fI\%terminalmage\fP) Blacklist os.umask
@ \fI2018\-03\-02 18:46:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
8c2c4e3316 Merge pull request \fI\%#46208\fP from terminalmage/audit\-umask\-usage
.IP \(bu 2
9c92aadce8 Disable blacklisted\-function check for legitimate uses
.IP \(bu 2
58a11aaa26 Disable pylint check in salt\-ssh shim
.IP \(bu 2
ecadf67659 Blacklist os.umask
.IP \(bu 2
31b1d98fcb Replace direct use of os.umask with use of existing context manager
.IP \(bu 2
82ce546e18 Prevent failed os.makedirs from leaving modified umask in place
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46293\fP: (\fI\%eliasp\fP) Fix Python3 comparison \fITypeError\fP in \fIsalt.modules.upstart\fP
@ \fI2018\-03\-02 16:36:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44624\fP: (\fI\%eliasp\fP) Fix Traceback when using the \fIservice.enabled\fP state on non\-booted systems (refs: \fI\%#46293\fP)
.IP \(bu 2
978e869490 Merge pull request \fI\%#46293\fP from eliasp/2017.7\-44624\-py3\-compat
.IP \(bu 2
2e08b0d9c8 Fix Python3 comparison \fITypeError\fP in \fIsalt.modules.upstart\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46128\fP: (\fI\%Boulet\-\fP) Mountpoint in git_pillar (refs: \fI\%#46264\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46264\fP: (\fI\%terminalmage\fP) Fix incorrect merge conflict resolution
@ \fI2018\-03\-02 14:21:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
bee4a66d0c Merge pull request \fI\%#46264\fP from terminalmage/issue46128
.IP \(bu 2
68000b7211 Fix incorrect merge conflict resolution
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46296\fP: (\fI\%vutny\fP) [DOC] Add missing params to \fIpillar.get\fP docstring
@ \fI2018\-03\-02 14:19:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
1e0b3aa348 Merge pull request \fI\%#46296\fP from vutny/doc\-pillar\-get
.IP \(bu 2
1faa8331e1 [DOC] Add missing params to \fIpillar.get\fP docstring
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45874\fP: (\fI\%GwiYeong\fP) fix for local client timeout bug
@ \fI2018\-03\-01 19:39:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
c490a50452 Merge pull request \fI\%#45874\fP from GwiYeong/2017.7\-local\-client\-hotfix
.IP \(bu 2
949aefc82b Merge branch \(aq2017.7\(aq into 2017.7\-local\-client\-hotfix
.IP \(bu 2
45d663f435 fix for local client timeout bug
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46261\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2018\-03\-01 17:55:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
8e8a3a2897 Merge pull request \fI\%#46261\fP from rallytime/merge\-2017.7
.IP \(bu 2
8256ae5ee5 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
140ef4d6b9 Merge pull request \fI\%#46253\fP from rallytime/doc\-banners
.INDENT 2.0
.IP \(bu 2
07ed8c7db3 Update docbanner for SaltConf18
.UNINDENT
.IP \(bu 2
9fe86ee520 Merge pull request \fI\%#46179\fP from wedge\-jarrad/cifs\-remount\-fix
.INDENT 2.0
.IP \(bu 2
9ca25c4313 Add credentials and secretfile to mount.mounted mount_invisible_keys
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44046\fP: (\fI\%t2b\fP) docker_container.running states fail if the argument ulimits is set and a watch requisite is triggered (refs: \fI\%#46276\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46276\fP: (\fI\%terminalmage\fP) salt.utils.docker.translate_input: operate on deepcopy of kwargs
@ \fI2018\-03\-01 15:37:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
88a3166589 Merge pull request \fI\%#46276\fP from terminalmage/issue44046
.IP \(bu 2
a14d4daf8c salt.utils.docker.translate_input: operate on deepcopy of kwargs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46182\fP: (\fI\%oeuftete\fP) docker_container.running is sensitive to HostConfig Ulimits ordering (refs: \fI\%#46183\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46183\fP: (\fI\%oeuftete\fP) Fix docker_container.running HostConfig Ulimits comparison
@ \fI2018\-02\-28 22:22:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
da60399b8f Merge pull request \fI\%#46183\fP from oeuftete/fix\-docker\-container\-running\-host\-config\-ulimits
.IP \(bu 2
5b09644429 Sort lists from Ulimits before comparing
.IP \(bu 2
0b80f02226 Update old dockerng doc ref
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46259\fP: (\fI\%terminalmage\fP) git_pillar_branch overrides branch defined in git_pillar configuration (refs: \fI\%#46260\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#46258\fP: (\fI\%terminalmage\fP) git_pillar_base doesn\(aqt work for values when PyYAML loads them as int/float (refs: \fI\%#46260\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46260\fP: (\fI\%terminalmage\fP) Normalize global git_pillar/winrepo config items
@ \fI2018\-02\-28 22:05:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
509429f08c Merge pull request \fI\%#46260\fP from terminalmage/git_pillar
.IP \(bu 2
b1ce2501fd Normalize global git_pillar/winrepo config items
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46101\fP: (\fI\%jfindlay\fP) In OpenRC exec module, make sure to ignore retcode on status
@ \fI2018\-02\-28 20:01:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
a97a3e6fb0 Merge pull request \fI\%#46101\fP from jfindlay/openrc_ret
.IP \(bu 2
2eef3c65a6 tests.unit.modules.gentoo_service add retcode arg
.IP \(bu 2
81ec66fd8b modules.gentoo_service handle stopped retcode
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46254\fP: (\fI\%rallytime\fP) Update enterprise banner
@ \fI2018\-02\-28 19:54:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a17593c05 Merge pull request \fI\%#46254\fP from rallytime/enterprise\-banner
.IP \(bu 2
f5fae3dedf Update enterprise banner
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46250\fP: (\fI\%terminalmage\fP) Add documentation to the fileserver runner
@ \fI2018\-02\-28 18:53:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
8c50ff32bd Merge pull request \fI\%#46250\fP from terminalmage/runner\-docs
.IP \(bu 2
91b4895087 Add documentation to the fileserver runner
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46215\fP: (\fI\%racker\-markh\fP) salt\-cloud will only intermittently build rackspace cloud instances with purely private networks (refs: \fI\%#46243\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46243\fP: (\fI\%racker\-markh\fP) Don\(aqt ignore \(aqprivate_ips\(aq unnecessarily
@ \fI2018\-02\-28 15:28:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
53067cca43 Merge pull request \fI\%#46243\fP from racker\-markh/fix\-openstack\-private\-network\-issue
.IP \(bu 2
50c1e140f0 Don\(aqt check deny private_ips already in the original list of private_ips
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46109\fP: (\fI\%rombert\fP) archive.extracted takes a long time (> 4 minutes) even though directory exists (refs: \fI\%#46239\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46239\fP: (\fI\%terminalmage\fP) archive.extracted: don\(aqt check source file when if_missing path exists
@ \fI2018\-02\-28 15:01:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
15405c8760 Merge pull request \fI\%#46239\fP from terminalmage/issue46109
.IP \(bu 2
586d8b0dcf archive.extracted: don\(aqt check source file when if_missing path exists
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46221\fP: (\fI\%terminalmage\fP) Fix hanging tests in integration suite
@ \fI2018\-02\-27 21:32:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
633e1208e4 Merge pull request \fI\%#46221\fP from terminalmage/salt\-jenkins\-854
.IP \(bu 2
0eb012659c Fix hanging tests in integration suite
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46214\fP: (\fI\%vutny\fP) [DOC] Replace \fInote\fP rST block for GitHub
@ \fI2018\-02\-27 17:42:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
7917277345 Merge pull request \fI\%#46214\fP from vutny/formulas\-readme\-formatting
.IP \(bu 2
d702846961 [DOC] Replace \fInote\fP rST block for GitHub
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46203\fP: (\fI\%Ch3LL\fP) Add 2017.7.5 Release Notes File
@ \fI2018\-02\-26 21:17:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
a2e099b744 Merge pull request \fI\%#46203\fP from Ch3LL/7.5_release
.IP \(bu 2
6ddf3246ce Add 2017.7.5 Release Notes File
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46201\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2018\-02\-26 18:56:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
973b227818 Merge pull request \fI\%#46201\fP from rallytime/merge\-2017.7
.IP \(bu 2
9ac2101baa Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
a4c5417d23 Merge pull request \fI\%#46132\fP from rallytime/2016.11_update_version_doc
.INDENT 2.0
.IP \(bu 2
d2196b6df3 Update release versions for the 2016.11 branch
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34423\fP: (\fI\%bdrung\fP) oscodename wrong on Debian 8 (jessie) (refs: \fI\%#46139\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46139\fP: (\fI\%bdrung\fP) Add os grains test cases for Debian/Ubuntu and fix oscodename on Ubuntu
@ \fI2018\-02\-26 16:44:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
89cf2e5061 Merge pull request \fI\%#46139\fP from bdrung/os\-grains
.IP \(bu 2
0b445f2a37 tests: Add unit tests for _parse_os_release()
.IP \(bu 2
f6069b77ed Fix osfinger grain on Debian
.IP \(bu 2
8dde55a761 tests: Add os_grains test cases for Debian
.IP \(bu 2
ff02ab9937 tests: Add Ubuntu 17.10 (artful) os_grains test case
.IP \(bu 2
77d5356aba Fix incorrect oscodename grain on Ubuntu
.IP \(bu 2
7e62dc9fd2 tests: Support reading os\-release files from disk
.IP \(bu 2
a92ec0db1b Make _parse_os_release() always callable
.IP \(bu 2
eee1fe5b38 tests: Dissolve _run_ubuntu_os_grains_tests
.IP \(bu 2
1d6ef731fe tests: Deduplicate _run_os_grains_tests()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46133\fP: (\fI\%rallytime\fP) Update release versions for the 2017.7 branch
@ \fI2018\-02\-26 16:42:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
c8c71e75ca Merge pull request \fI\%#46133\fP from rallytime/2017.7_update_version_doc
.IP \(bu 2
0ed338e643 Update release versions for the 2017.7 branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46124\fP: (\fI\%moremo\fP) GitFS  saltenv ref won\(aqt pick up multiple of the same ref (refs: \fI\%#46185\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46185\fP: (\fI\%terminalmage\fP) gitfs: Fix detection of base env when its ref is also mapped to a different env
@ \fI2018\-02\-26 14:52:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
390d592aa6 Merge pull request \fI\%#46185\fP from terminalmage/issue46124
.IP \(bu 2
3b58dd0da0 gitfs: Fix detection of base env when its ref is also mapped to a different env
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46148\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.3 to 2017.7
@ \fI2018\-02\-23 19:21:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
705caa8cca Merge pull request \fI\%#46148\fP from rallytime/merge\-2017.7
.IP \(bu 2
25deebf7a6 Merge branch \(aq2017.7.3\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46137\fP: (\fI\%damon\-atkins\fP) [2017.7] update ec2 pillar arguments with better names
@ \fI2018\-02\-23 13:32:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45878\fP: (\fI\%damon\-atkins\fP) ec2_pillar update to fix finding instance\-id (refs: \fI\%#46137\fP)
.IP \(bu 2
10a47dcbc4 Merge pull request \fI\%#46137\fP from damon\-atkins/2017.7_fix_ec2_pillar2
.IP \(bu 2
99e7f6a7d3 update ec2 pillar arguments with better names
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46004\fP: (\fI\%github\-abcde\fP) opts file_roots gets overwritten with pillar_roots in orchestration run (refs: \fI\%#46145\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46145\fP: (\fI\%terminalmage\fP) 3 small fixes for runners/orchestration
@ \fI2018\-02\-22 22:11:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
d74cb14557 Merge pull request \fI\%#46145\fP from terminalmage/issue46004
.IP \(bu 2
467ff841cd pillarenv argument should default to None and not the value from opts
.IP \(bu 2
2a185855ea Better solution for fixing the opts munging in pillar.show_pillar runner
.IP \(bu 2
e2c4702e0c Update tests to reflect changes to the SaltCacheLoader
.IP \(bu 2
f9301fcc34 Document behavior when orchestration runnner invoked with non\-orch states
.IP \(bu 2
9644579cd0 Instantiate the SaltCacheLoader\(aqs fileclient in the __init__
.IP \(bu 2
f9a6c86e21 salt.runners.pillar.show_pillar: don\(aqt modify master opts
.IP \(bu 2
e0940a9fc4 Properly detect use of the state.orch alias and add orch jid to kwargs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46135\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46088\fP to 2017.7
@ \fI2018\-02\-22 15:11:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46088\fP: (\fI\%rongzeng54\fP) fix kernel subpackages install bug (refs: \fI\%#46135\fP)
.IP \(bu 2
0398ce0482 Merge pull request \fI\%#46135\fP from rallytime/bp\-46088
.IP \(bu 2
57a60f62a3 fix kernel subpackages install bug
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45837\fP: (\fI\%johje349\fP) Salt Cloud does not recognise all Digitalocean sizes (refs: \fI\%#46115\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46136\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46115\fP to 2017.7
@ \fI2018\-02\-21 19:17:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46115\fP: (\fI\%samodid\fP) update digitalocean salt\-cloud driver (refs: \fI\%#46136\fP)
.IP \(bu 2
1fcbbd1e02 Merge pull request \fI\%#46136\fP from rallytime/bp\-46115
.IP \(bu 2
0a481d707f update digitalocean salt\-cloud driver
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45911\fP: (\fI\%twangboy\fP) LGPO Module: Convert reg values to unicode for debug
@ \fI2018\-02\-21 19:02:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
11e5e8eb86 Merge pull request \fI\%#45911\fP from twangboy/win_fix_lgpo_unicode
.IP \(bu 2
bcde5cc625 Update log statement
.IP \(bu 2
e9fa53d3b7 Change the Invalid Data Message
.IP \(bu 2
c818d4b791 Convert reg values to unicode for debug
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46085\fP: (\fI\%zmedico\fP) 2017.7.3 salt master with \(dqopen_mode: True\(dq becomes unresponsive if minion submits empty public key (refs: \fI\%#46123\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46123\fP: (\fI\%gtmanfred\fP) If no pubkey is passed in openmode fail
@ \fI2018\-02\-21 19:01:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
524a6a72a0 Merge pull request \fI\%#46123\fP from gtmanfred/2017.7
.IP \(bu 2
8d36730ef7 If no pubkey is passed in openmode fail
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46131\fP: (\fI\%vutny\fP) [DOC] Fix code\-blocks for reStructuredText
@ \fI2018\-02\-21 15:47:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
e48fa58012 Merge pull request \fI\%#46131\fP from vutny/doc\-formula\-formatting
.IP \(bu 2
d8fb051e44 [DOC] Fix code\-blocks for reStructuredText
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42763\fP: (\fI\%xuhcc\fP) acme.cert state falsely reports about renewed certificate (refs: \fI\%#44603\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#40208\fP: (\fI\%bewing\fP) Inconsistent state return when test=True (refs: \fI\%#44603\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46118\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44603\fP to 2017.7
@ \fI2018\-02\-21 15:21:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44603\fP: (\fI\%oarmstrong\fP) Fix acme state to correctly return on test (refs: \fI\%#46118\fP)
.IP \(bu 2
6cea44ee95 Merge pull request \fI\%#46118\fP from rallytime/bp\-44603
.IP \(bu 2
2a2c23c66b Fix acme state to correctly return on test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46121\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2018\-02\-21 10:07:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
16c382b55b Merge pull request \fI\%#46121\fP from rallytime/merge\-2017.7
.IP \(bu 2
4c2f504a85 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
e197a0fbc5 Merge pull request \fI\%#46076\fP from rallytime/bp\-46066
.INDENT 2.0
.IP \(bu 2
b94d73c53e Pin tornado version in requirements file
.UNINDENT
.IP \(bu 2
c72c1bde5f Merge pull request \fI\%#46093\fP from wedge\-jarrad/contributing\-doc\-typo
.INDENT 2.0
.IP \(bu 2
5a0fe104f7 Fix contributing doc typo
.UNINDENT
.IP \(bu 2
3cb83ea87e Merge pull request \fI\%#45992\fP from bgridley/fix\-routes\-present\-state
.INDENT 2.0
.IP \(bu 2
679787699c Add vpc_peering_connection_id to describe_route_tables route_keys
.UNINDENT
.IP \(bu 2
8a60635da0 Merge pull request \fI\%#46000\fP from terminalmage/issue45910
.INDENT 2.0
.IP \(bu 2
8cf13325ee salt.states.reg.present: Prevent traceback when reg data is binary
.UNINDENT
.IP \(bu 2
1f44e285dc Merge pull request \fI\%#46011\fP from terminalmage/fix\-solaris\-runas
.INDENT 2.0
.IP \(bu 2
8ee0a3a28b Move Solaris USER workaround up a bit
.IP \(bu 2
13cdb52690 cmdmod.py: runas workaround for platforms that don\(aqt set a USER env var
.UNINDENT
.IP \(bu 2
30fb8f7be0 Merge pull request \fI\%#45467\fP from twangboy/win_exclude_hidden
.INDENT 2.0
.IP \(bu 2
ea41215646 Make the regex pattern less greedy
.IP \(bu 2
6d223cffa7 Add tip about passing bogus saltenv
.IP \(bu 2
1282ae3a93 Skip hidden first
.IP \(bu 2
437a457911 Skip hidden dirs in genrepo
.IP \(bu 2
87dc554dc3 Add final updates to docs
.IP \(bu 2
3646d5c897 Fix some docs formatting, add some warnings
.IP \(bu 2
35c81faf5a Log the source_dir when caching the files
.IP \(bu 2
91c3da8dfd Improve docs for pkg.refresh_db
.IP \(bu 2
4803d92707 Add some documentation
.IP \(bu 2
08b82e0875 Fix lint error, use raw
.IP \(bu 2
2f712691cf Exclude hidden directories in pkg.refresh_db
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46106\fP: (\fI\%amendlik\fP) yumpkg.refresh_db hangs (refs: \fI\%#46107\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46107\fP: (\fI\%amendlik\fP) Add \-\-assumeyes on YUM/DNF commands
@ \fI2018\-02\-20 22:52:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
b92346645b Merge pull request \fI\%#46107\fP from amendlik/yumpkg\-assumeyes
.IP \(bu 2
8d9a432fb2 Add \-\-assumeyes to yum/dnf commands in yumpkg.refresh_db
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46094\fP: (\fI\%kstreee\fP) Fix memory leak
@ \fI2018\-02\-20 21:36:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
14fe423e0c Merge pull request \fI\%#46094\fP from kstreee/fix\-memory\-leak
.IP \(bu 2
48080a1bae Fixes memory leak, saltclients should be cleaned after used.
.IP \(bu 2
aba00805f4 Adds set_close_callback function to removes stream instance after closed from a set streams.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#13\fP: (\fI\%thatch45\fP) Expand the stats module (refs: \fI\%#46097\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46097\fP: (\fI\%vutny\fP) [DOC] Put https link to the formulas doc page
@ \fI2018\-02\-20 17:07:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
320c2037e1 Merge pull request \fI\%#46097\fP from vutny/fix\-https\-link
.IP \(bu 2
2062fd0e5c [DOC] Put https link to the formulas doc page
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46103\fP: (\fI\%bdrung\fP) Fix skipping Kubernetes tests if client is not installed
@ \fI2018\-02\-20 16:33:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
0eb137fb4e Merge pull request \fI\%#46103\fP from bdrung/2017.7
.IP \(bu 2
dd3f936557 Fix skipping Kubernetes tests if client is not installed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46070\fP: (\fI\%Ch3LL\fP) add required arg to dns_check jinja doc example
@ \fI2018\-02\-16 20:00:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3a938e994 Merge pull request \fI\%#46070\fP from Ch3LL/fix\-doc\-dns
.IP \(bu 2
2a5d855d97 add required arg to dns_check jinja doc example
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46067\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45994\fP to 2017.7
@ \fI2018\-02\-16 19:55:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45994\fP: (\fI\%nullify005\fP) Fix hosted zone Comment updates & quote TXT entries correctly (refs: \fI\%#46067\fP)
.IP \(bu 2
01042e9d77 Merge pull request \fI\%#46067\fP from rallytime/bp\-45994
.IP \(bu 2
a07bb48726 Correct formatting for lint
.IP \(bu 2
e8678f633d Fix Comment being None not \(aq\(aq and inject quotes into the TXT ChangeRecords
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42932\fP: (\fI\%bobrik\fP) cmd.run with bg: true doesn\(aqt fail properly (refs: \fI\%#45932\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45932\fP: (\fI\%The\-Loeki\fP) Fix cmd run_all bg error
@ \fI2018\-02\-16 14:53:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39980\fP: (\fI\%vutny\fP) [2016.3] Allow using \fIbg\fP kwarg for \fIcmd.run\fP state function (refs: \fI\%#45932\fP)
.IP \(bu 2
5e0e2a30e2 Merge pull request \fI\%#45932\fP from The\-Loeki/fix_cmd_run_all_bg
.IP \(bu 2
f83da27ca5 Merge branch \(aq2017.7\(aq into fix_cmd_run_all_bg
.IP \(bu 2
771758fbca Merge branch \(aq2017.7\(aq into fix_cmd_run_all_bg
.IP \(bu 2
c54fcf7a2d cmd: move separate DRY logging blocks into _run, prevent logging on bg=True, don\(aqt use_vt on bg
.IP \(bu 2
ebb1f81a9b cmd run: when running in bg, force ignore_retcode=True
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46062\fP: (\fI\%vutny\fP) Fix typo in postgres_user.present state function
@ \fI2018\-02\-16 14:44:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
45ace39961 Merge pull request \fI\%#46062\fP from vutny/pg\-user\-state\-fix\-typo
.IP \(bu 2
a5fbe4e95e Fix typo in postgres_user.present state function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45763\fP: (\fI\%twangboy\fP) Fix rehash function in win_path.py
@ \fI2018\-02\-15 20:05:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
edcb64de76 Merge pull request \fI\%#45763\fP from twangboy/win_fix_path_rehash
.IP \(bu 2
b9a2bc7b29 Fix hyperlinks
.IP \(bu 2
29912adc15 Move the test_rehash test to test_win_functions
.IP \(bu 2
adc594c183 Remove duplicate link
.IP \(bu 2
e84628c1eb Add some comments to the code
.IP \(bu 2
d50d5f582f Add additional info to docs for \fIbroadcast_setting_change\fP
.IP \(bu 2
3a54e09cd9 Rename setting to message
.IP \(bu 2
a3f9e99bc0 Change to a generic function to broadcast change
.IP \(bu 2
79299361c3 Create refresh_environment salt util
.IP \(bu 2
967b83940c Fix rehash function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46042\fP: (\fI\%jfindlay\fP) Revise file_tree pillar module documentation
@ \fI2018\-02\-15 19:29:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46027\fP: (\fI\%jfindlay\fP) Revise file_tree pillar module documentation (refs: \fI\%#46042\fP)
.IP \(bu 2
a46fbc546c Merge pull request \fI\%#46042\fP from jfindlay/file_tree_doc
.IP \(bu 2
0ba4954a4b salt.pillar.file_tree revise module documentation
.IP \(bu 2
3c6a5bf967 salt.pillar.file_tree provide better debug info
.IP \(bu 2
bb1cdc451e salt.pillar.file_tree no stack trace when nodegroups undefined
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46013\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45598\fP to 2017.7
@ \fI2018\-02\-15 16:11:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45598\fP: (\fI\%nullify005\fP) Patch around ResourceRecords needing to be present for AliasTarget (refs: \fI\%#46013\fP)
.IP \(bu 2
de86126dd8 Merge pull request \fI\%#46013\fP from rallytime/bp\-45598
.IP \(bu 2
2ea3fef543 No lazy logging
.IP \(bu 2
f427b0febc Change formatting style of logging lines per review
.IP \(bu 2
ebb244396b Patch around ResourceRecords needing to be present for AliasTarget entries to work
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45825\fP: (\fI\%philpep\fP) selinux.fcontext_policy_present doesn\(aqt work on Centos 6 with filetype = all files (refs: \fI\%#45826\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46016\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45826\fP to 2017.7
@ \fI2018\-02\-14 18:16:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45826\fP: (\fI\%philpep\fP) Fix selinux.fcontext_policy_present for Centos 6 (refs: \fI\%#46016\fP)
.IP \(bu 2
07e5735471 Merge pull request \fI\%#46016\fP from rallytime/bp\-45826
.IP \(bu 2
1916e5c4a4 Fix selinux.fcontext_policy_present for Centos 6
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45784\fP: (\fI\%oarmstrong\fP) SELinux module fcontext_get_policy fails with long regex (refs: \fI\%#45785\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46015\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45785\fP to 2017.7
@ \fI2018\-02\-14 18:16:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45785\fP: (\fI\%oarmstrong\fP) m/selinux.fcontext_get_policy allow long filespecs (refs: \fI\%#46015\fP)
.IP \(bu 2
a1f4092811 Merge pull request \fI\%#46015\fP from rallytime/bp\-45785
.IP \(bu 2
ef6ffb1492 Resolve linting errors
.IP \(bu 2
8047066c46 Remove unused import
.IP \(bu 2
8f7c45935a Add tests for salt.modules.selinux.fcontext_get_policy
.IP \(bu 2
bafb7b4e6e Ensure parsed fields are stripped
.IP \(bu 2
a830a6e819 m/selinux.fcontext_get_policy allow long filespecs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46012\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45462\fP to 2017.7
@ \fI2018\-02\-14 18:14:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45462\fP: (\fI\%aphor\fP) emit port cli version, variants as separate args (refs: \fI\%#46012\fP)
.IP \(bu 2
96097c037e Merge pull request \fI\%#46012\fP from rallytime/bp\-45462
.IP \(bu 2
9f76836a6c emit port cli version, variants as separate args
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45991\fP: (\fI\%terminalmage\fP) yumpkg: Fix a couple issues with _get_extra_opts
@ \fI2018\-02\-14 16:48:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
1279924f5f Merge pull request \fI\%#45991\fP from terminalmage/fix\-duplicate\-extra\-opts
.IP \(bu 2
916766f651 yumpkg: Fix a couple issues with _get_extra_opts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46017\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.3 to 2017.7
@ \fI2018\-02\-13 21:43:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
8b9adc258e Merge pull request \fI\%#46017\fP from rallytime/merge\-2017.7
.IP \(bu 2
a06645ce71 Merge branch \(aq2017.7.3\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45796\fP: (\fI\%L4rS6\fP) aliases module doesn\(aqt follow symlinks (refs: \fI\%#45797\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45988\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45797\fP to 2017.7
@ \fI2018\-02\-13 17:49:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45797\fP: (\fI\%L4rS6\fP) follow symlinks in aliases module (close \fI\%#45796\fP) (refs: \fI\%#45988\fP)
.IP \(bu 2
d20ff89414 Merge pull request \fI\%#45988\fP from rallytime/bp\-45797
.IP \(bu 2
953a400d79 follow symlinks
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45711\fP: (\fI\%bdrung\fP) Fix Unicode tests when run with LC_ALL=POSIX
@ \fI2018\-02\-13 17:42:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
b18087cee0 Merge pull request \fI\%#45711\fP from bdrung/fix\-unicode\-tests
.IP \(bu 2
b6181b5ed6 Fix Unicode tests when run with LC_ALL=POSIX
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45878\fP: (\fI\%damon\-atkins\fP) ec2_pillar update to fix finding instance\-id (refs: \fI\%#46137\fP)
@ \fI2018\-02\-13 17:34:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
5271fb1d40 Merge pull request \fI\%#45878\fP from damon\-atkins/2017.7_fix_ec2_pillar
.IP \(bu 2
0e74025714 Merge branch \(aq2017.7\(aq into 2017.7_fix_ec2_pillar
.IP \(bu 2
b4d0b23891 py3 fix
.IP \(bu 2
75d9e20d8a Add ignoring \(aqterminated\(aq, \(aqstopped\(aq instances, to improve changes of a single match
.IP \(bu 2
0093472a37 added tag_key_list and tag_key_sep to create ec2_tags_list
.IP \(bu 2
afb3968aa7 ec2_pillar could not find instance\-id, resolved. add support to use any tag to compare minion id against.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45942\fP: (\fI\%terminalmage\fP) Fix incorrect translation of docker port_bindings \-> ports (2017.7 branch)
@ \fI2018\-02\-13 16:10:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
cf367dbd04 Merge pull request \fI\%#45942\fP from terminalmage/issue45679\-2017.7
.IP \(bu 2
89cbd72a0d Don\(aqt try to sort ports when translating docker input
.IP \(bu 2
9cd47b39dd Fix incorrect translation of docker port_bindings \-> ports
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45959\fP: (\fI\%rallytime\fP) A couple of grammar updates for the state compiler docs
@ \fI2018\-02\-12 22:17:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
dae41de7a8 Merge pull request \fI\%#45959\fP from rallytime/state\-doc\-update
.IP \(bu 2
6f781cb95d A couple of grammar updates for the state compiler docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#45884\fP: (\fI\%tintoy\fP) \(dqTypeError: can\(aqt serialize <NodeImage\(dq when calling salt\-cloud with the dimensiondata driver (refs: \fI\%#45908\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#45884\fP: (\fI\%tintoy\fP) \(dqTypeError: can\(aqt serialize <NodeImage\(dq when calling salt\-cloud with the dimensiondata driver (refs: \fI\%#45908\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45908\fP: (\fI\%tintoy\fP) Fix for \fI\%#45884\fP (\(dqTypeError: can\(aqt serialize <NodeImage\(dq when calling salt\-cloud with the dimensiondata driver)
@ \fI2018\-02\-12 22:05:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
007214f7bf Merge pull request \fI\%#45908\fP from DimensionDataResearch/fix/issue/45884
.IP \(bu 2
1a75786b5a Fix linter warnings.
.IP \(bu 2
82ec0b589c Revert to using salt.utils.cloud.is_public_ip.
.IP \(bu 2
9b6b01873b Fix violations reported by flake8.
.IP \(bu 2
a2bc155c73 Use __utils__[\(aqcloud.\(aq] instead of salt.cloud.utils.
.IP \(bu 2
98907a32cb Ensure \(aqauth\(aq parameter is correctly passed to dimensiondata driver.
.IP \(bu 2
de26b03e2c Fix copy/paste bug in dimensiondata provider integration test.
.IP \(bu 2
6b1b6be427 Add integration tests for dimensiondata cloud provider.
.IP \(bu 2
f6ea9fed7d Ensure that event data provided by the dimensiondata driver is serialisable.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45985\fP: (\fI\%garethgreenaway\fP) [2017.7] Backport \fI\%#45894\fP \- Missing \fIformat\fP in the call to write.
@ \fI2018\-02\-12 20:22:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45894\fP: (\fI\%while0pass\fP) Fix inconcistencies in param description (refs: \fI\%#45985\fP)
.IP \(bu 2
efcbfa868c Merge pull request \fI\%#45985\fP from garethgreenaway/2017_7_fixing_mac_tests_again
.IP \(bu 2
7b8dc14433 Missing \fIformat\fP in the call to write.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45958\fP: (\fI\%garethgreenaway\fP) Backporting \fI\%#45935\fP to 2017.7
@ \fI2018\-02\-12 16:25:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45936\fP: (\fI\%garethgreenaway\fP) [oxygen] Fix to log/handlers/__init__.py (refs: \fI\%#45958\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45935\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45742\fP to 2017.7.3 (refs: \fI\%#45958\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45742\fP: (\fI\%marccardinal\fP) list.copy() is not compatible with python 2.7 (refs: \fI\%#45935\fP)
.IP \(bu 2
bf03abd07c Merge pull request \fI\%#45958\fP from garethgreenaway/backport\-fixing_mactests_queue_full
.IP \(bu 2
25dffaae91 Backporting \fI\%#45935\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45949\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2018\-02\-09 22:32:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
bab365d6c6 Merge pull request \fI\%#45949\fP from rallytime/merge\-2017.7
.IP \(bu 2
f51687e903 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
7779fea7ba Merge pull request \fI\%#45940\fP from dmurphy18/fix_aix_cmdmod
.INDENT 2.0
.IP \(bu 2
dd2788419b Fix use of \(aqsu\(aq for AIX to use \(aq\-\(aq
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45915\fP: (\fI\%MatthiasKuehneEllerhold\fP) 2017.7.3: Salt\-SSH & Vault Pillar: Permission denied \(dqminion.pem\(dq (refs: \fI\%#45928\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45928\fP: (\fI\%garethgreenaway\fP) [2017.7] Fixing vault when used with pillar over salt\-ssh
@ \fI2018\-02\-09 16:32:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
7fd00ec752 Merge pull request \fI\%#45928\fP from garethgreenaway/45915_fixing_vault_pillar_for_salt_ssh
.IP \(bu 2
259e60e5d4 Fixing vault when used with pillar over salt\-ssh
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45925\fP: (\fI\%terminalmage\fP) Fix spelling error in docstring
@ \fI2018\-02\-08 21:52:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d14ad9ccf Merge pull request \fI\%#45925\fP from terminalmage/fix\-spelling
.IP \(bu 2
7a143fe454 Fix spelling error in docstring
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45920\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2018\-02\-08 15:43:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
0cbe93cd69 Merge pull request \fI\%#45920\fP from rallytime/merge\-2017.7
.IP \(bu 2
e4e4744218 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
27ff82f996 Merge pull request \fI\%#45864\fP from rallytime/release\-note\-fix
.INDENT 2.0
.IP \(bu 2
104a24f244 Remove extraneous ] in release notes for 2016.11.9
.UNINDENT
.IP \(bu 2
5fa010de2b Merge pull request \fI\%#45787\fP from rallytime/2016.11.9_docs
.INDENT 2.0
.IP \(bu 2
a38d4d44fa [2016.11] Bump latest and previous versions
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45805\fP: (\fI\%bgridley\fP) Execution module victorops throws an error \(dqRuntimeError: dictionary changed size during iteration\(dq (refs: \fI\%#45814\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45814\fP: (\fI\%gtmanfred\fP) fix cookies dict size changing in http.query
@ \fI2018\-02\-08 15:35:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
643a8a5278 Merge pull request \fI\%#45814\fP from gtmanfred/2017.7
.IP \(bu 2
d8eec9aa97 fix cookies dict size changing in http.query
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45877\fP: (\fI\%rallytime\fP) Add release notes file for 2017.7.4 release
@ \fI2018\-02\-08 14:07:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a3f87c16d Merge pull request \fI\%#45877\fP from rallytime/new\-release\-notes
.IP \(bu 2
f937e8ba81 Add release notes file for 2017.7.4 release
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45904\fP: (\fI\%rallytime\fP) Back\-port \fI\%#41017\fP to 2017.7
@ \fI2018\-02\-08 13:57:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41017\fP: (\fI\%cebe\fP) Fixed typo in pkg state documentation (refs: \fI\%#45904\fP)
.IP \(bu 2
1c3cc00670 Merge pull request \fI\%#45904\fP from rallytime/bp\-41017
.IP \(bu 2
80c56cdcea Fixed typo in pkg state documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45907\fP: (\fI\%terminalmage\fP) Fix backport of grains fix
@ \fI2018\-02\-08 13:57:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
317d35bd15 Merge pull request \fI\%#45907\fP from terminalmage/fix\-grains\-backport
.IP \(bu 2
6cf7e50cc4 Fix backport of grains fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45906\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45548\fP to 2017.7
@ \fI2018\-02\-08 13:57:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45548\fP: (\fI\%viktordaniel\fP) Update x509.py \- documentation fix (refs: \fI\%#45906\fP)
.IP \(bu 2
dade5f0cab Merge pull request \fI\%#45906\fP from rallytime/bp\-45548
.IP \(bu 2
1befa7386c Update x509.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45893\fP: (\fI\%CrackerJackMack\fP) archive.extracted ValueError \(dqNo path specified\(dq in 2017.7.3 (refs: \fI\%#45902\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45902\fP: (\fI\%terminalmage\fP) Check the effective saltenv for cached archive
@ \fI2018\-02\-08 13:42:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
82c473a1fe Merge pull request \fI\%#45902\fP from terminalmage/issue45893
.IP \(bu 2
9d200efc26 Add regression test for issue 45893
.IP \(bu 2
1468f1d0ff Remove duplicated section in docstring and fix example
.IP \(bu 2
6cc5cd9b8a Check the effective saltenv for cached archive
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45862\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45830\fP to 2017.7
@ \fI2018\-02\-08 13:22:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45830\fP: (\fI\%garethgreenaway\fP)  [oxygen] Catch exception when logging queue is full (refs: \fI\%#45862\fP)
.IP \(bu 2
fdedde3cfb Merge pull request \fI\%#45862\fP from rallytime/bp\-45830
.IP \(bu 2
1024856f9a Wrapping the put_nowait in a try...except and catching the exception when the multiprocessing queue is full.  This situation is happening when running the full testing suite on MacOS where the queue limit is 32767 vs on Linux where the queue limit is unlimited.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45779\fP: (\fI\%The\-Loeki\fP) SSH shell shim: Don\(aqt use $() for optimal support
@ \fI2018\-02\-05 18:35:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
43a45b42c3 Merge pull request \fI\%#45779\fP from The\-Loeki/patch\-3
.IP \(bu 2
8575ae3d52 Merge branch \(aq2017.7\(aq into patch\-3
.IP \(bu 2
47cf00d88e SSH shell shim: Don\(aqt use $() for optimal support
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45788\fP: (\fI\%rallytime\fP) [2017.7] Bump latest and previous versions
@ \fI2018\-02\-05 15:30:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
cca997d0da Merge pull request \fI\%#45788\fP from rallytime/2017.7.3_docs
.IP \(bu 2
d5faf6126b [2017.7] Bump latest and previous versions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45842\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45827\fP to 2017.7
@ \fI2018\-02\-05 15:04:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45827\fP: (\fI\%terminalmage\fP) Fix traceback in disks grains when /sys/block not available (refs: \fI\%#45842\fP)
.IP \(bu 2
746206cebe Merge pull request \fI\%#45842\fP from rallytime/bp\-45827
.IP \(bu 2
c631598a87 Fix traceback in disks grains when /sys/block not available
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44978\fP: (\fI\%doesitblend\fP) State duration not always calculated (refs: \fI\%#45721\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45721\fP: (\fI\%garethgreenaway\fP)  [2017.7] Ensure duration and start time exist
@ \fI2018\-02\-05 14:59:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
900aadcd67 Merge pull request \fI\%#45721\fP from garethgreenaway/44978_show_duration_when_no_state_run
.IP \(bu 2
359265869f Adding a couple tests to ensure that duration is included in state run results even when states do not run.
.IP \(bu 2
912347abc3 Include the duration when a state does not run, for example when the \fIonchanges\fP requisite is not met.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45517\fP: (\fI\%kstreee\fP) Fixes base dir making logic to ensure not raising the exception when base directory already exists.
@ \fI2018\-02\-05 14:56:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
80a2d009b4 Merge pull request \fI\%#45517\fP from kstreee/fix\-mkdir
.IP \(bu 2
24d41f2451 Fixes base dir making logic to ensure not raising the exception when base directory already exists.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45835\fP: (\fI\%kstreee\fP) Adds a missing return statement.
@ \fI2018\-02\-02 22:51:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
7a4b1b2e77 Merge pull request \fI\%#45835\fP from kstreee/fix\-missing\-return\-statement
.IP \(bu 2
68c7f3dcba Adds a missing return statement.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45840\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45603\fP to 2017.7
@ \fI2018\-02\-02 20:17:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45603\fP: (\fI\%andreaspe\fP) Fix for duplicate entries with pkrepo.managed (refs: \fI\%#45840\fP)
.IP \(bu 2
0a04f118c2 Merge pull request \fI\%#45840\fP from rallytime/bp\-45603
.IP \(bu 2
9653363131 Fix for duplicate entries with pkrepo.managed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44315\fP: (\fI\%whytewolf\fP) cmd.* cwd does not escape spaces. 2017.7.2 (refs: \fI\%#45134\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45716\fP: (\fI\%ciiqr\fP) fixed quoting of script path in cmd.script
@ \fI2018\-02\-02 14:36:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45134\fP: (\fI\%garethgreenaway\fP) [2017.7] fix to cmd.script for cwd with space (refs: \fI\%#45716\fP)
.IP \(bu 2
bd2178cd5f Merge pull request \fI\%#45716\fP from ciiqr/fix_cmd_script_quoting
.IP \(bu 2
217791079b some code cleanup (lint errors and escape_argument as _cmd_quote)
.IP \(bu 2
1c29bc5a3d fixed quoting of script path in cmd.script
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45684\fP: (\fI\%bdrung\fP) salt documentation fails to build with Python 3 version of sphinx (refs: \fI\%#45719\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45719\fP: (\fI\%bdrung\fP) Fix python3 sphinx build
@ \fI2018\-02\-02 14:20:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
272f912c7c Merge pull request \fI\%#45719\fP from bdrung/fix\-python3\-sphinx\-build
.IP \(bu 2
179e8fbe73 doc: Do not mock non\-existing __qualname__ attribute
.IP \(bu 2
971e59ebe2 Drop enforcing new\-style object for SaltYamlSafeLoader
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45764\fP: (\fI\%mchugh19\fP) support amazon linux 2 for service module
@ \fI2018\-02\-02 14:12:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45758\fP: (\fI\%mchugh19\fP) support amazon linux 2 for service module (refs: \fI\%#45764\fP)
.IP \(bu 2
fc04336c3b Merge pull request \fI\%#45764\fP from mchugh19/2017.7
.IP \(bu 2
0a7f1a4d75 English better
.IP \(bu 2
37e067c7b5 support amazon linux 2 for service module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45756\fP: (\fI\%roaldnefs\fP) Fix Grafana4 states documentation
@ \fI2018\-01\-31 19:01:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
f234bf52f4 Merge pull request \fI\%#45756\fP from roaldnefs/fix\-grafana4\-documentation
.IP \(bu 2
92979c0b57 Fix grafana4 states documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45801\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2018\-01\-31 18:55:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
685b683db5 Merge pull request \fI\%#45801\fP from rallytime/merge\-2017.7
.IP \(bu 2
26e992e011 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
746386d04c Merge pull request \fI\%#45794\fP from vutny/doc\-file\-state\-examples
.INDENT 2.0
.IP \(bu 2
ddfeae6a29 [DOC] Fix code\-block rST directive in file state module
.UNINDENT
.IP \(bu 2
abc9ece214 Merge pull request \fI\%#45780\fP from vutny/doc\-pkgrepo\-zypper
.INDENT 2.0
.IP \(bu 2
f80c7d8d69 [DOC] Add missing gpgautoimport for pkgrepo.managed
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45802\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.3 to 2017.7
@ \fI2018\-01\-31 18:55:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
c7d319f3bc Merge pull request \fI\%#45802\fP from rallytime/merge\-2017.7\-from\-2017.7.3
.IP \(bu 2
eb48513ba0 Merge branch \(aq2017.7.3\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45738\fP: (\fI\%UtahCampusD\fP) minion cache overwritten for scheduled jobs (refs: \fI\%#45761\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45761\fP: (\fI\%gtmanfred\fP) generate a jid for cache_jobs on the minion
@ \fI2018\-01\-31 18:01:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
96e9232cc2 Merge pull request \fI\%#45761\fP from gtmanfred/2017.7
.IP \(bu 2
280767ed57 generate a jid for cache_jobs on the minion
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45301\fP: (\fI\%twangboy\fP) Ctl+C causes stack trace on Windows (refs: \fI\%#45707\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45707\fP: (\fI\%skizunov\fP) Fix exception when shutting down logging listener
@ \fI2018\-01\-30 13:28:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
38ed46a61a Merge pull request \fI\%#45707\fP from skizunov/develop2
.IP \(bu 2
e84801a381 Ensure we have at least one logging root handler
.IP \(bu 2
3da9b8dd33 Fix exception when shutting down logging listener
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45773\fP: (\fI\%terminalmage\fP) Fix misspellings
@ \fI2018\-01\-30 13:24:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
53008ffec7 Merge pull request \fI\%#45773\fP from terminalmage/fix\-misspelling
.IP \(bu 2
0a45f998fe Fix misspellings
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45489\fP: (\fI\%ipmb\fP) cache.grains runner returns all minions when match is not found (refs: \fI\%#45588\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45751\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45588\fP to 2017.7
@ \fI2018\-01\-29 17:12:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45588\fP: (\fI\%samodid\fP) update  MasterPillarUtil get_minion_grains method (refs: \fI\%#45751\fP)
.IP \(bu 2
454ed23f62 Merge pull request \fI\%#45751\fP from rallytime/bp\-45588
.IP \(bu 2
aa149a0e7a fix typo
.IP \(bu 2
3e794a043d  fix copy\-paste error in get_minion_grains method doc string
.IP \(bu 2
1fb94a08e0 update MasterPillarUtil
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45753\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2018\-01\-29 17:11:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
860e21955c Merge pull request \fI\%#45753\fP from rallytime/merge\-2017.7
.IP \(bu 2
cb50cce181 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
d7e09e2649 Merge pull request \fI\%#45749\fP from vutny/fix\-typo
.INDENT 2.0
.IP \(bu 2
e80bfb20c6 The \fIzypper.mod_repo\fP: fix typo in the docstring
.UNINDENT
.IP \(bu 2
cb6ce378ea Merge pull request \fI\%#45459\fP from vutny/salt\-cloud\-fix\-loading\-utf\-cache
.INDENT 2.0
.IP \(bu 2
b370796e9d Salt Cloud: write/read cached data in UTF\-8 explicitly
.IP \(bu 2
cd999201be [2016.11] Salt Cloud: fix loading UTF\-8 cached data
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40173\fP: (\fI\%gtmanfred\fP) Document the Open File limit issue better (refs: \fI\%#45688\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45688\fP: (\fI\%bdrung\fP) Raise LimitNOFILE to default max open files
@ \fI2018\-01\-29 14:26:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
9fb4d4a528 Merge pull request \fI\%#45688\fP from bdrung/raise\-max\-open\-files
.IP \(bu 2
bbedeec756 Raise LimitNOFILE to default max open files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45686\fP: (\fI\%bdrung\fP) Use dbus\-run\-session instead of dbus\-launch
@ \fI2018\-01\-29 14:24:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
79da49ec8b Merge pull request \fI\%#45686\fP from bdrung/2017.7
.IP \(bu 2
f49d0a0eec Use dbus\-run\-session instead of dbus\-launch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45740\fP: (\fI\%terminalmage\fP) Fix incorrect attempt at version comparison.
@ \fI2018\-01\-29 14:12:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
7fb666bcd2 Merge pull request \fI\%#45740\fP from terminalmage/fix\-incorrect\-version\-comparison
.IP \(bu 2
1e0b38dcaa Fix incorrect attempt at version comparison.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45747\fP: (\fI\%SteffenKockel\fP) Fix typos
@ \fI2018\-01\-29 13:53:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
fe636f53f8 Merge pull request \fI\%#45747\fP from SteffenKockel/2017.7
.IP \(bu 2
319b513183 Fix typos
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45734\fP: (\fI\%terminalmage\fP) Fix traceback in CLI output when value is trimmed
@ \fI2018\-01\-28 13:35:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
eb91ae8b6e Merge pull request \fI\%#45734\fP from terminalmage/fix\-trimmed\-output
.IP \(bu 2
966ad07452 Fix traceback in CLI output when value is trimmed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45712\fP: (\fI\%bdrung\fP) Decode git call output in Python 3
@ \fI2018\-01\-28 02:03:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
7516bfbffe Merge pull request \fI\%#45712\fP from bdrung/fix\-version\-decode
.IP \(bu 2
217183405a Decode git call output in Python 3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44449\fP: (\fI\%brianthelion\fP) salt\-ssh + salt\-cloud: cloud roster not working and/or \fIupdate_cachedir\fP is broken (refs: \fI\%#45720\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45720\fP: (\fI\%dwoz\fP) Salt cloud adds newly created insances to cache
@ \fI2018\-01\-26 22:45:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
91b848debb Merge pull request \fI\%#45720\fP from dwoz/issue\-44449\-prod\-fix
.IP \(bu 2
4a4bd6119d Salt cloud adds newly created insances to cache
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45724\fP: (\fI\%eliasp\fP) Typo (\fIHellium\fP → \fIHelium\fP)
@ \fI2018\-01\-26 22:37:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
831698f066 Merge pull request \fI\%#45724\fP from eliasp/2017.7\-typo\-from\-hell
.IP \(bu 2
bec78276f3 Replace left\-over mistyped codename reference (\fIHellium\fP → \fI2014.7.0\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45722\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2018\-01\-26 22:15:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
cdb21a0186 Merge pull request \fI\%#45722\fP from rallytime/merge\-2017.7
.IP \(bu 2
8e3a2e25fe Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
e4047a1234 Merge pull request \fI\%#45511\fP from twangboy/win_fix_git
.INDENT 2.0
.IP \(bu 2
160dd7c6ce Pull the first item in the list
.IP \(bu 2
52d6d78150 Only keep ssh.py in the Windows installer
.IP \(bu 2
54eb0db2c4 Keep ssh state and execution modules in the installer
.IP \(bu 2
0fa801a329 Add additional path to find ssh.exe
.UNINDENT
.IP \(bu 2
a550e8d25d Merge pull request \fI\%#45694\fP from twangboy/win_reg_add_keys
.INDENT 2.0
.IP \(bu 2
8f53cd2d68 Add new keys to subkey_slash_check
.IP \(bu 2
62050c711c Add support for additional reg keys
.UNINDENT
.IP \(bu 2
7ceebf62f0 Merge pull request \fI\%#45577\fP from zer0def/fix\-git\-detached\-31363
.INDENT 2.0
.IP \(bu 2
a924b971ef Applied PR \fI\%#40524\fP to \fIgit.detached\fP state module function. (refs \fI\%#31363\fP)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45718\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.3 to 2017.7
@ \fI2018\-01\-26 16:49:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a413e96c5 Merge pull request \fI\%#45718\fP from rallytime/merge\-2017.7
.IP \(bu 2
f10c7ee92d Merge branch \(aq2017.7.3\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45690\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2018\-01\-26 14:41:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0955519cf Merge pull request \fI\%#45690\fP from rallytime/merge\-2017.7
.IP \(bu 2
d4dac9f7cc Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
3a6837e232 Merge pull request \fI\%#45675\fP from Ch3LL/rn_2016.11.9
.INDENT 2.0
.IP \(bu 2
7b5bed36d9 Add new commits to 2016.11.9 release notes
.UNINDENT
.IP \(bu 2
915e259bad Merge pull request \fI\%#45663\fP from rallytime/bp\-45452\-2016.11
.INDENT 2.0
.IP \(bu 2
ae94fb61d9 opkg.py: make owner function return value, instead of iterator
.UNINDENT
.IP \(bu 2
ecd75c137f Merge pull request \fI\%#45651\fP from rallytime/merge\-2016.11
.INDENT 2.0
.IP \(bu 2
1583e1edbe Merge branch \(aq2016.11.9\(aq into \(aq2016.11\(aq
.IP \(bu 2
10812969f0 Merge pull request \fI\%#45638\fP from twangboy/win_fix_shell_info
.INDENT 2.0
.IP \(bu 2
872da3ffba Only convert text types in the list_values function
.IP \(bu 2
0e41535cdb Fix reg.py to only convert text types to unicode
.IP \(bu 2
3579534ea5 Fix issue with detecting powershell
.UNINDENT
.IP \(bu 2
2d1dd1186e Merge pull request \fI\%#45564\fP from Ch3LL/r\-notes\-2016
.IP \(bu 2
28e4398150 Merge pull request \fI\%#45563\fP from Ch3LL/man_2016
.UNINDENT
.IP \(bu 2
22bcd3d110 Merge pull request \fI\%#45600\fP from vutny/doc\-fix\-references
.INDENT 2.0
.IP \(bu 2
35675fe6b3 [DOC] Fix references on Salt Formulas page
.UNINDENT
.IP \(bu 2
0d622f92a9 Merge pull request \fI\%#45542\fP from UtahDave/doc_mixed_transports
.INDENT 2.0
.IP \(bu 2
b5b5054ec2 capitalize masters and minions
.IP \(bu 2
f542bdf566 Add warning about using mixed transports
.UNINDENT
.IP \(bu 2
c70b9dc20b Merge pull request \fI\%#45565\fP from Ch3LL/r\-notes\-2016
.INDENT 2.0
.IP \(bu 2
325f4cbcda Add PR changes to 2016.11.9 Release Notes
.UNINDENT
.IP \(bu 2
d8526062c1 Merge pull request \fI\%#45562\fP from Ch3LL/man_2016
.INDENT 2.0
.IP \(bu 2
529bc0c680 update release number for salt\-call man page 2016.11.9
.IP \(bu 2
11b7222148 Update man pages for 2016.11.9
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45710\fP: (\fI\%michelsen\fP) Added source argument to function call
@ \fI2018\-01\-26 14:30:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
9c92e93834 Merge pull request \fI\%#45710\fP from michelsen/fix\-chocolatey\-state\-bug
.IP \(bu 2
8accc0ce5c Added source argument to function call
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45667\fP: (\fI\%gtmanfred\fP) default to upgrading when refreshing on archlinux
@ \fI2018\-01\-25 14:05:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
693f72d5a7 Merge pull request \fI\%#45667\fP from gtmanfred/syu
.IP \(bu 2
44c601102a we should default to upgrading when refreshing on archlinux
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45674\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.3 to 2017.7
@ \fI2018\-01\-24 22:46:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
bec946b080 Merge pull request \fI\%#45674\fP from rallytime/merge\-2017.7
.IP \(bu 2
9f78e53d4b Merge branch \(aq2017.7.3\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45590\fP: (\fI\%viq\fP) webhook engine does not work with tornado 4.5.2 (refs: \fI\%#45589\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45589\fP: (\fI\%gtmanfred\fP) change webhook headers to dict
@ \fI2018\-01\-24 22:32:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
50de847191 Merge pull request \fI\%#45589\fP from gtmanfred/2017.7
.IP \(bu 2
395d6f5c91 change webhook headers to dict
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45072\fP: (\fI\%vernondcole\fP) cannot build documentation on Ubuntu 17.10 (refs: \fI\%#45662\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45662\fP: (\fI\%bdrung\fP) Fix documentation generation
@ \fI2018\-01\-24 17:14:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
e21088c1a4 Merge pull request \fI\%#45662\fP from bdrung/2017.7
.IP \(bu 2
71076afbcc doc: Define fake version for msgpack and psutil
.IP \(bu 2
b6a5b745b1 doc: Mock keyring module import
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45650\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45555\fP to 2017.7
@ \fI2018\-01\-24 14:47:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45555\fP: (\fI\%ddoh94\fP) update winrepo_source_dir document (refs: \fI\%#45650\fP)
.IP \(bu 2
da82f190d2 Merge pull request \fI\%#45650\fP from rallytime/bp\-45555
.IP \(bu 2
e474d0416b update winrepo_source_dir document
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45611\fP: (\fI\%terminalmage\fP) Fix unnecessary/incorrect usage of six.binary_type
@ \fI2018\-01\-23 22:53:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
79ee24c0c7 Merge pull request \fI\%#45611\fP from terminalmage/tests\-log\-level
.IP \(bu 2
6aa865cf54 Fix unnecessary/incorrect usage of six.binary_type
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45652\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.3 to 2017.7
@ \fI2018\-01\-23 22:45:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
634d8dbcc0 Merge pull request \fI\%#45652\fP from rallytime/merge\-2017.7
.IP \(bu 2
4e907dc84b Merge branch \(aq2017.7.3\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45627\fP: (\fI\%bdrung\fP) Failing unit tests in Debian package build (refs: \fI\%#45630\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45630\fP: (\fI\%bdrung\fP) Fix tests
@ \fI2018\-01\-23 21:56:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
dbdef8230e Merge pull request \fI\%#45630\fP from bdrung/2017.7
.IP \(bu 2
76d44e9490 Fix skipping test when boto is not installed
.IP \(bu 2
2b9b262357 Fix unit.modules.test_cmdmod.CMDMODTestCase.test_run
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45619\fP: (\fI\%garethgreenaway\fP) [2017.7] Fixing test_mac_user_enable_auto_login
@ \fI2018\-01\-23 21:56:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
e5c9cd91e8 Merge pull request \fI\%#45619\fP from garethgreenaway/2017_7_test_mac_user_enable_auto_login
.IP \(bu 2
f5f03e1e6c Fixing integration.modules.test_mac_user.MacUserModuleTest.test_mac_user_disable_auto_login
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45644\fP: (\fI\%twangboy\fP) Add missing space to deprecation warning
@ \fI2018\-01\-23 21:55:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
8a95fc4257 Merge pull request \fI\%#45644\fP from twangboy/win_fix_dep_warns
.IP \(bu 2
de9bc384cc Add missing space to deprecation warning
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45634\fP: (\fI\%Ch3LL\fP) Add different service name for Mac 10.13 test
@ \fI2018\-01\-23 21:51:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
c290b6320b Merge pull request \fI\%#45634\fP from Ch3LL/mac\-service
.IP \(bu 2
31b712e27d Add different service name for Mac 10.13 test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45606\fP: (\fI\%terminalmage\fP) Fix bug affecting salt\-ssh when root_dir differs from the default
@ \fI2018\-01\-23 20:03:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
c28151f5f7 Merge pull request \fI\%#45606\fP from terminalmage/salt\-ssh\-root\-dir\-fix
.IP \(bu 2
3f9309521b Fix bug affecting salt\-ssh when root_dir differs from the default
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45636\fP: (\fI\%Ch3LL\fP)  Fix mac service and pkg tests for 10.13
@ \fI2018\-01\-23 18:44:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
0931b6417d Merge pull request \fI\%#45636\fP from Ch3LL/mac\-tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45609\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.3 to 2017.7
@ \fI2018\-01\-22 20:24:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
63a294f498 Merge pull request \fI\%#45609\fP from rallytime/merge\-2017.7
.IP \(bu 2
a5fc3b3363 Merge branch \(aq2017.7.3\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45431\fP: (\fI\%zer0def\fP) boto3_route53.hosted_zone_present state can fail due to related execution module function\(aqs typo (refs: \fI\%#45576\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45576\fP: (\fI\%zer0def\fP) Fixed boto3_route53 execution module function signature \fIdiSassociate_vpc_from_hosted_zone\fP typo. (refs \fI\%#45431\fP)
@ \fI2018\-01\-22 19:37:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
59329957ca Merge pull request \fI\%#45576\fP from zer0def/boto3\-route53\-typo
.IP \(bu 2
21e1e9e226 Fixed boto3_route53 execution module function signature \fIdiSassociate_vpc_from_hosted_zone\fP typo. (refs \fI\%#45431\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45552\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.3 to 2017.7
@ \fI2018\-01\-19 19:12:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
42b0d27f71 Merge pull request \fI\%#45552\fP from rallytime/merge\-2017.7\-from\-.3
.IP \(bu 2
dba7410b80 Merge branch \(aq2017.7.3\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45551\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2018\-01\-19 18:21:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
879cfcb889 Merge pull request \fI\%#45551\fP from rallytime/merge\-2017.7
.IP \(bu 2
e0ffa32b49 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
18e814a7bb Merge pull request \fI\%#45540\fP from rallytime/merge\-2016.11
.INDENT 2.0
.IP \(bu 2
441f819b7b Merge branch \(aq2016.11.9\(aq into \(aq2016.11\(aq
.IP \(bu 2
654df0f526 Merge pull request \fI\%#45532\fP from gtmanfred/2016.11.9
.INDENT 2.0
.IP \(bu 2
6c26025664 fix mock for opensuse
.UNINDENT
.UNINDENT
.IP \(bu 2
4f3b9b57fa Merge pull request \fI\%#45522\fP from rallytime/merge\-2016.11
.INDENT 2.0
.IP \(bu 2
36c038c92a Merge branch \(aq2016.11.9\(aq into \(aq2016.11\(aq
.IP \(bu 2
571c33aa39 Merge pull request \fI\%#45518\fP from gtmanfred/2016.11.9
.INDENT 2.0
.IP \(bu 2
5455d2dee6 fix centos 6 pip test
.IP \(bu 2
40255194b0 fix fedora pkg test
.UNINDENT
.UNINDENT
.IP \(bu 2
0638638fb9 Merge pull request \fI\%#45504\fP from rallytime/merge\-2016.11
.INDENT 2.0
.IP \(bu 2
d72fc74e8c Merge branch \(aq2016.11.9\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
4e0a0eec1f Merge pull request \fI\%#45443\fP from rallytime/bp\-45399\-2016.11.9
.INDENT 2.0
.IP \(bu 2
919e92c911 Fix git.latest failure when rev is not the default branch
.UNINDENT
.IP \(bu 2
ebd4db66b8 Merge pull request \fI\%#45493\fP from damon\-atkins/2016.11_fix_sls_defintion_wrong_type
.INDENT 2.0
.IP \(bu 2
af108440df win_pkg lint space after ,
.IP \(bu 2
c6e922a236 win_pkg lint issues
.IP \(bu 2
f4627d7a80 fix quote i.e. change \(ga to \(aq
.IP \(bu 2
6938a4c099 pkg.refresh_db report an issue if a sls pkg definition id not a dict instead of aborting.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
5a2a31bfff Merge pull request \fI\%#45495\fP from vutny/doc\-rhel\-pygit2\-compat
.INDENT 2.0
.IP \(bu 2
0d79b9eaff [DOC] Suggest to upgrade pygit2 and deps
.UNINDENT
.IP \(bu 2
9c4fb42e5f Merge pull request \fI\%#45481\fP from twangboy/fix_aptpkg
.INDENT 2.0
.IP \(bu 2
fd67b086b4 Fix if statement in __init__()
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42626\fP: (\fI\%UtahDave\fP) new args and kwargs options for publisher_acl are not documented at all and very little for external_auth (refs: \fI\%#45389\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45389\fP: (\fI\%DmitryKuzmenko\fP) Docs update for function args limit in pub acl.
@ \fI2018\-01\-18 22:56:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
28554ca935 Merge pull request \fI\%#45389\fP from DSRCorporation/bugs/42626_pub_acl_doc
.IP \(bu 2
f33ebcada0 Doc note about user names regex matching in pub acl and eauth.
.IP \(bu 2
e29c0ff19e Docs update for function args limit in pub acl.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45483\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2018\-01\-18 22:54:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
b3dc758ab0 Merge pull request \fI\%#45483\fP from rallytime/merge\-2017.7
.IP \(bu 2
de6d85959a Lint fix
.IP \(bu 2
9f547a31f0 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.INDENT 2.0
.IP \(bu 2
b756760415 Merge pull request \fI\%#45482\fP from rallytime/merge\-2016.11
.INDENT 2.0
.IP \(bu 2
3b38c77159 Merge branch \(aq2016.11.9\(aq into \(aq2016.11\(aq
.IP \(bu 2
7322efba92 Merge pull request \fI\%#45446\fP from rallytime/bp\-45390
.UNINDENT
.IP \(bu 2
96ae237d37 Merge pull request \fI\%#45448\fP from rallytime/merge\-2016.11.9
.INDENT 2.0
.IP \(bu 2
646379d981 Merge branch \(aq2016.11\(aq into \(aq2016.11.9\(aq
.UNINDENT
.IP \(bu 2
1ed323a3ee Merge pull request \fI\%#45437\fP from terminalmage/fix\-docstring
.INDENT 2.0
.IP \(bu 2
c11b16dc29 Fix incorrect wording in jboss7 docstrings
.UNINDENT
.IP \(bu 2
600fa3939f Merge pull request \fI\%#45390\fP from damon\-atkins/2016.11_win_pkg_remove_final_fixes
.INDENT 2.0
.IP \(bu 2
69f045ea24 lint too\-many\-blank\-lines
.IP \(bu 2
10a7501ede Update release notes
.IP \(bu 2
6f2affe01c fix pkg.remove, pkg.list_pkgs
.UNINDENT
.IP \(bu 2
057df44a4a Merge pull request \fI\%#45399\fP from terminalmage/fix\-git.latest\-depth
.IP \(bu 2
0cbc6767bf Fix git.latest failure when rev is not the default branch
.IP \(bu 2
b0ece9f4d4 Merge pull request \fI\%#45424\fP from twangboy/win_reg
.IP \(bu 2
30f06205f7 Fix some issues with reg.py
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45529\fP: (\fI\%Ch3LL\fP) Fix UnboundLocalError for pacman pkg installs
@ \fI2018\-01\-18 19:01:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
5e26282843 Merge pull request \fI\%#45529\fP from Ch3LL/pacman\-sources
.IP \(bu 2
e619d49ef3 Fix UnboundLocalError for pacman pkg installs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45508\fP: (\fI\%frogunder\fP) fix test_archive test for mac on 2017.7 branch
@ \fI2018\-01\-18 16:04:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
840c97417d Merge pull request \fI\%#45508\fP from frogunder/fix_mac_archive_tests_2017.7_branch
.IP \(bu 2
ccf062d62e fix test_archive test for mac on 2017.7 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45444\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45343\fP to 2017.7
@ \fI2018\-01\-17 17:17:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45343\fP: (\fI\%rrroo\fP) Support expr_form for manage.up, manage.down (refs: \fI\%#45444\fP)
.IP \(bu 2
e1403b6813 Merge pull request \fI\%#45444\fP from rallytime/bp\-45343
.IP \(bu 2
c7d2081390 Support expr_form for manage.up, manage.down
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45465\fP: (\fI\%terminalmage\fP) Backport \fI\%#45095\fP to 2017.7 branch
@ \fI2018\-01\-17 15:13:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45095\fP: (\fI\%terminalmage\fP) PY3: Make loader ignore .pyc files not in __pycache__ (refs: \fI\%#45465\fP)
.IP \(bu 2
4b2c88e2e6 Merge pull request \fI\%#45465\fP from terminalmage/bp\-45095
.IP \(bu 2
2f63a6dbf4 Optimization: don\(aqt allocate a new list to concatenate
.IP \(bu 2
5074741130 EAFP
.IP \(bu 2
85dbdc6a39 PY3: Make loader ignore .pyc files not in __pycache__
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45365\fP: (\fI\%meaksh\fP) Return an error when \(dqgid_from_name\(dq is set but group does not exist
@ \fI2018\-01\-16 18:31:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
5f58a87e84 Merge pull request \fI\%#45365\fP from meaksh/2017.7\-issue\-45345
.IP \(bu 2
da23067f80 Refactor to prevent logical bug when gid is 0
.IP \(bu 2
9fdaa0d5e9 Update documentation for \(aqgid_from_name\(aq parameter
.IP \(bu 2
52f9c06908 Fix integration tests for \(aquser.present\(aq state.
.IP \(bu 2
e2c32dc6dc Make pylint happy
.IP \(bu 2
a18dbe0c11 Return error when gid_from_name and group does not exist.
.IP \(bu 2
ce7b1f4baf Ensure empty string gid is set to None
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43535\fP: (\fI\%Ch3LL\fP) Add pkg.latest_version Test to Auto Test Suite (refs: \fI\%#44822\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44822\fP: (\fI\%frogunder\fP) add pkg_latest_version test
@ \fI2018\-01\-16 14:16:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
de080983e3 Merge pull request \fI\%#44822\fP from frogunder/pkg_latestversion
.IP \(bu 2
08644e02a0 skip if mac
.IP \(bu 2
dfb68f32d2 fix if statements and string
.IP \(bu 2
3504083849 add pkg_latest_version test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#603\fP: (\fI\%rallytime\fP) [oxygen] CentOS 7 is failing several boto tests with module import failures (refs: \fI\%#45401\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45435\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45401\fP to 2017.7
@ \fI2018\-01\-14 12:43:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45401\fP: (\fI\%gtmanfred\fP) fix boto import failures (refs: \fI\%#45435\fP)
.IP \(bu 2
cb3e0cffb3 Merge pull request \fI\%#45435\fP from rallytime/bp\-45401
.IP \(bu 2
b9761971c2 fix moto version
.IP \(bu 2
0cd95d1cc6 fix test boto imports
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45380\fP: (\fI\%twangboy\fP) Backport changes from \fI\%#45308\fP
@ \fI2018\-01\-11 19:45:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45308\fP: (\fI\%twangboy\fP) Fix \fIintegration.modules.test_state\fP for Windows (refs: \fI\%#45380\fP)
.IP \(bu 2
2340f0b487 Merge pull request \fI\%#45380\fP from twangboy/backport_45308
.IP \(bu 2
419be8a9b5 Backport changes from \fI\%#45308\fP
.UNINDENT
.UNINDENT
.SS Salt 2017.7.6 Release Notes
.sp
Version 2017.7.6 is a bugfix release for \fI\%2017.7.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB182\fP
.IP \(bu 2
Total Issue References: \fB60\fP
.IP \(bu 2
Total PR References: \fB217\fP
.IP \(bu 2
Contributors: \fB47\fP (\fI\%Ch3LL\fP, \fI\%DmitryKuzmenko\fP, \fI\%GwiYeong\fP, \fI\%Quarky9\fP, \fI\%RichardW42\fP,
\fI\%UtahDave\fP, \fI\%amaclean199\fP, \fI\%arif\-ali\fP, \fI\%baniobloom\fP, \fI\%bdrung\fP, \fI\%benediktwerner\fP,
\fI\%bmiguel\-teixeira\fP, \fI\%cachedout\fP, \fI\%dafenko\fP, \fI\%damon\-atkins\fP, \fI\%dwoz\fP, \fI\%ezh\fP, \fI\%folti\fP,
\fI\%fpicot\fP, \fI\%frogunder\fP, \fI\%garethgreenaway\fP, \fI\%gtmanfred\fP, \fI\%isbm\fP, \fI\%jeroennijhof\fP, \fI\%jfindlay\fP,
\fI\%jfoboss\fP, \fI\%kstreee\fP, \fI\%lomeroe\fP, \fI\%mattp\-\fP, \fI\%meaksh\fP, \fI\%mirceaulinic\fP, \fI\%myinitialsarepm\fP,
\fI\%mzbroch\fP, \fI\%nages13\fP, \fI\%paclat\fP, \fI\%pcjeff\fP, \fI\%pruiz\fP, \fI\%psyer\fP, \fI\%rallytime\fP, \fI\%s0undt3ch\fP,
\fI\%skizunov\fP, \fI\%smitty42\fP, \fI\%terminalmage\fP, \fI\%twangboy\fP, \fI\%vutny\fP, \fI\%yagnik\fP, \fI\%yannj\-fr\fP)
.UNINDENT
.SS Tornado 5.0 Support for Python 2 Only
.sp
Tornado 5.0 moves to using asyncio for all python3 versions.  Because of this
and changes in asyncio between python 3.4 and 3.5 to only be able to use one
ioloop, which requires some rearchitecting, support for tornado 5.0 and python3
versions of salt has been delayed to a later release.
.sp
For now, to use tornado 5.0, the python 2 version of salt must be used.
.SS Tornado 5.0 Support for Python 2 Only
.sp
Tornado 5.0 moves to using asyncio for all python3 versions.  Because of this
and changes in asyncio between python 3.4 and 3.5 to only be able to use one
ioloop, which requires some rearchitecting, support for tornado 5.0 and python3
versions of salt has been delayed to a later release.
.sp
For now, to use tornado 5.0, the python 2 version of salt must be used.
.SS Option to Return to Previous Pillar Include Behavior
.sp
Prior to version 2017.7.3, keys from \fI\%pillar includes\fP
would be merged on top of the pillar SLS. Since 2017.7.3, the includes are
merged together and then the pillar SLS is merged on top of that.
.sp
The \fI\%pillar_includes_override_sls\fP option has been added allow
users to switch back to the pre\-2017.7.3 behavior.
.SS Changelog for v2017.7.5..v2017.7.6
.sp
\fIGenerated at: 2018\-05\-29 14:05:53 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#47775\fP: (\fI\%gtmanfred\fP) catch UnsupportedOperation with AssertionError
@ \fI2018\-05\-22 19:04:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
edf94c915e Merge pull request \fI\%#47775\fP from gtmanfred/2017.7.6
.IP \(bu 2
548f65d056 catch UnsupportedOperation with AssertionError
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47769\fP: (\fI\%gtmanfred\fP) skip test that breaks test suite
@ \fI2018\-05\-22 15:12:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
8c38ecd75f Merge pull request \fI\%#47769\fP from gtmanfred/2017.7.6
.IP \(bu 2
3fdfc0fa82 skip test that breaks test suite
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47747\fP: (\fI\%Ch3LL\fP) Add changelog to 2017.7.6 release notes
@ \fI2018\-05\-21 14:25:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d5b473ce2 Merge pull request \fI\%#47747\fP from Ch3LL/rn_2017.7.6
.IP \(bu 2
d4aa83b92d Add changelog to 2017.7.6 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47484\fP: (\fI\%whytewolf\fP) Windows: pkg.latest state not updating packages. (refs: \fI\%#47702\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47702\fP: (\fI\%damon\-atkins\fP) State pkg.latest called win pkg.install with list of pkgs and the required versions
@ \fI2018\-05\-19 11:21:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
8a5b34f7d9 Merge pull request \fI\%#47702\fP from damon\-atkins/2017.7.6_fix_pkg.latest_state
.IP \(bu 2
adcc094e08 Merge branch \(aq2017.7.6\(aq into 2017.7.6_fix_pkg.latest_state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47700\fP: (\fI\%yannj\-fr\fP) fix roots modification time check
@ \fI2018\-05\-18 18:42:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
d610c192d9 Merge pull request \fI\%#47700\fP from yannj\-fr/2017.7.6
.IP \(bu 2
961c1ef61e fix roots modification time check
.INDENT 2.0
.IP \(bu 2
2a73e905df Merge branch \(aq2017.7.6\(aq into 2017.7.6
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47632\fP: (\fI\%gtmanfred\fP) handle new _create_stream in tornado 5.0
@ \fI2018\-05\-18 14:25:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
266749420f Merge pull request \fI\%#47632\fP from gtmanfred/2017.7.6
.IP \(bu 2
2c50c0d2f5 fix pylint
.IP \(bu 2
4a29057b16 Fix last test for tornado
.IP \(bu 2
550ef2e272 allow using tornado 5.0
.IP \(bu 2
62e468448b handle new _create_stream in tornado 5.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47720\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47692\fP to 2017.7.6
@ \fI2018\-05\-18 13:23:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47692\fP: (\fI\%dwoz\fP) Default windows to m1.small for ec2\-classic (refs: \fI\%#47720\fP)
.IP \(bu 2
2643c356af Merge pull request \fI\%#47720\fP from rallytime/bp\-47692\-2017.7.6
.IP \(bu 2
6e5cb36839 Default windows to m1.small for ec2\-classic
.INDENT 2.0
.IP \(bu 2
20d9785244 fix roots modification time check
.UNINDENT
.IP \(bu 2
aef37dd1ce fix roots modification time check
.IP \(bu 2
d51662e053 Ensure targeted_pkgs always contains value for non\-windows.
.IP \(bu 2
83b4224cf8 Adjusted based on feed back.
.IP \(bu 2
12f983ce9f Whitespace lint issues
.IP \(bu 2
075d3d3c49 pkg.install execution module on windows ensures the software package is installed when no version is specified, it does not upgrade the software to the latest. This is per the design. pkg.latest must provide the versions to install to pkg.install
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47667\fP: (\fI\%Ch3LL\fP) Update test_mac_user_enable_auto_login to test both py2 and py3
@ \fI2018\-05\-16 15:54:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
16c2153385 Merge pull request \fI\%#47667\fP from Ch3LL/mac_user_enable
.IP \(bu 2
ba40d3d1a1 Update test_mac_user_enable_auto_login to test both py2 and py3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47645\fP: (\fI\%Ch3LL\fP) query the pip path for test test_issue_2087_missing_pip
@ \fI2018\-05\-15 17:16:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
a4921e86c9 Merge pull request \fI\%#47645\fP from Ch3LL/py3_rm_pip
.IP \(bu 2
225d90ad4c query the pip path for test test_issue_2087_missing_pip
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47646\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47601\fP and \fI\%#47643\fP to 2017.7.6
@ \fI2018\-05\-15 14:04:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47643\fP: (\fI\%dwoz\fP) Remove unwanted file (refs: \fI\%#47646\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47601\fP: (\fI\%dwoz\fP) Skip tests when we can not use runas (refs: \fI\%#47646\fP)
.IP \(bu 2
e441733ac1 Merge pull request \fI\%#47646\fP from rallytime/bp\-47601\-and\-47643
.IP \(bu 2
9e1d1a5ef8 Fix typo
.IP \(bu 2
4e94609136 Remove unwanted file
.IP \(bu 2
0109249c78 use ignore\-undefined\-variable
.IP \(bu 2
37caecb7f4 Ignore pylint WindowsError
.IP \(bu 2
c1135d90c7 Better doc string
.IP \(bu 2
e53d6b9ed9 Skip tests when we can not use runas
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47570\fP: (\fI\%gtmanfred\fP) Update dependency to msgpack
@ \fI2018\-05\-10 13:23:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
6f178ca908 Merge pull request \fI\%#47570\fP from gtmanfred/2017.7.6
.IP \(bu 2
84aa034e03 Update dependency to msgpack
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47523\fP: (\fI\%rallytime\fP) [2017.7.6] Update man pages
@ \fI2018\-05\-08 13:31:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
98bd598701 Merge pull request \fI\%#47523\fP from rallytime/man\-pages
.IP \(bu 2
48ecb78dec [2017.7.6] Update man pages
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47443\fP: (\fI\%skylerberg\fP) Input validation does not raise SaltInvocationError in win_dsc.py (refs: \fI\%#47505\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47517\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47505\fP to 2017.7.6
@ \fI2018\-05\-07 19:42:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47505\fP: (\fI\%dwoz\fP) Raise proper invocation errors (refs: \fI\%#47517\fP)
.IP \(bu 2
e608ea9617 Merge pull request \fI\%#47517\fP from rallytime/bp\-47505\-2017.7.6
.IP \(bu 2
0734578533 Raise proper invocation errors
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47476\fP: (\fI\%gtmanfred\fP) Specify the cache directory for newer virtualenv modules
@ \fI2018\-05\-04 19:20:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
611ca1fc03 Merge pull request \fI\%#47476\fP from gtmanfred/2017.7
.IP \(bu 2
1f91a85587 specify cache dir for pip install
.IP \(bu 2
99e150e09c check for kitchen\-vagrant gem before loading windows tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47412\fP: (\fI\%twangboy\fP) Fix issue where the cwd was being removed
@ \fI2018\-05\-04 17:28:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
7c3f2c56da Merge pull request \fI\%#47412\fP from twangboy/fix_47125
.IP \(bu 2
c9bab0b8e3 Merge branch \(aq2017.7\(aq into fix_47125
.IP \(bu 2
2600e404d5 Fix overly long line
.IP \(bu 2
5c8db05769 Fix issue where the cwd was being removed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47467\fP: (\fI\%twangboy\fP) Remove unused settings, update NSIS
@ \fI2018\-05\-04 17:11:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
4846e957c4 Merge pull request \fI\%#47467\fP from twangboy/cleanup_settings
.IP \(bu 2
9d498293b1 Remove unused settings, update NSIS
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47196\fP: (\fI\%twangboy\fP) Fix issues with pip
@ \fI2018\-05\-04 14:23:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
da9871d36b Merge pull request \fI\%#47196\fP from twangboy/fix_47024
.IP \(bu 2
14ee5537b9 Add @with_tempdir helper
.IP \(bu 2
6c3b5fa6fa Fix typo
.IP \(bu 2
f031710af2 Merge branch \(aq2017.7\(aq into fix_47024
.IP \(bu 2
7c46d9d0d4 Fix integration.modules.test_pip
.IP \(bu 2
22ac81df63 Fix integration.modules.test_pip
.IP \(bu 2
57d98224d4 Merge pull request #9 from terminalmage/twangboy/fix_47024
.INDENT 2.0
.IP \(bu 2
37a13d8004 Update pip unit tests to reflect changes
.IP \(bu 2
7f86779be0 Lint fix
.UNINDENT
.IP \(bu 2
c48d8f4f61 DRY and other fixes in pip module
.IP \(bu 2
b1117896a0 Change from global variable to __context__\(ga\(ga
.IP \(bu 2
3e6e524eca Fix some tests\(ga\(ga
.IP \(bu 2
c94f0f20e4 Fix lint error
.IP \(bu 2
fd47b21530 Fix merge conflict
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47455\fP: (\fI\%Ch3LL\fP) Add In Progress Warning for 2017.7.6 Release Notes
@ \fI2018\-05\-04 13:44:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
e8c4524bae Merge pull request \fI\%#47455\fP from Ch3LL/unreleased_rn
.IP \(bu 2
b6d0cc2ab7 Add In Progress Warning for 2017.7.6 Release Notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47459\fP: (\fI\%gtmanfred\fP) update ubuntu\-rolling to 18.04
@ \fI2018\-05\-03 20:39:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
2c7a4b6179 Merge pull request \fI\%#47459\fP from gtmanfred/2017.7
.IP \(bu 2
d228e72477 update ubuntu\-rolling to 18.04
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47462\fP: (\fI\%terminalmage\fP) Fix docs build on Sphinx 1.7+
@ \fI2018\-05\-03 20:06:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
64a64c0ed7 Merge pull request \fI\%#47462\fP from terminalmage/docs
.IP \(bu 2
6d7803ece0 Fix docs build on Sphinx 1.7+
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47436\fP: (\fI\%lomeroe\fP) Some Administrative Template policies are not properly set by lgpo (refs: \fI\%#47438\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#44516\fP: (\fI\%doesitblend\fP) Windows PY3 Minion Returns UTF16 UnicodeError (refs: \fI\%#44944\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47438\fP: (\fI\%lomeroe\fP) lgpo fix for issue \fI\%#47436\fP
@ \fI2018\-05\-03 14:40:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44944\fP: (\fI\%lomeroe\fP) win_lgpo registry.pol encoding updates (refs: \fI\%#46913\fP, \fI\%#47438\fP)
.IP \(bu 2
6cd0d31c03 Merge pull request \fI\%#47438\fP from lomeroe/double_admx_test
.IP \(bu 2
4902f1e2ba check if a policy has either an enabled value or enabled list entry or a disabled value or disabled list entry when determining the state of the policy
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45790\fP: (\fI\%bdarnell\fP) Test with Tornado 5.0b1 (refs: \fI\%#47106\fP, \fI\%#47433\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47433\fP: (\fI\%s0undt3ch\fP) Add missing requirements files not committed in \fI\%#47106\fP
@ \fI2018\-05\-02 20:57:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47106\fP: (\fI\%DmitryKuzmenko\fP) Tornado50 compatibility fixes (refs: \fI\%#47433\fP)
.IP \(bu 2
ed69821d19 Merge pull request \fI\%#47433\fP from s0undt3ch/2017.7
.IP \(bu 2
5abadf25d6 Add missing requirements files not committed in \fI\%#47106\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47424\fP: (\fI\%bcharron\fP) \(dqsalt\-cloud \-m\(dq fails with nova driver: \(dqThere was a query error: u\(aqstate\(aq\(dq (refs: \fI\%#47429\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47429\fP: (\fI\%gtmanfred\fP) server_list_min should use state, not status
@ \fI2018\-05\-02 16:27:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
7ae3497b0c Merge pull request \fI\%#47429\fP from gtmanfred/2017.7
.IP \(bu 2
8ae32033cc server_list_min should use state, not status
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47399\fP: (\fI\%isbm\fP) zeromq 17 deprecation warning backport from 2018.3 + tornado 5 fixes
@ \fI2018\-05\-02 15:11:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
2f5fc4ecc5 Merge pull request \fI\%#47399\fP from isbm/isbm\-zeromq17\-deprecationwarning\-2017.7.2\-v2
.IP \(bu 2
a36e49fd27 fix pylint
.IP \(bu 2
98b5629b36 Fix imports
.IP \(bu 2
d94c0f0152 Remove unnecessary variable
.IP \(bu 2
8e377b5653 Lintfix: E0203 and attribute access
.IP \(bu 2
2aab70b1b8 Install ZMQ handler if <15 version
.IP \(bu 2
296c589f4b Use ZMQ switch utility in the integration tests
.IP \(bu 2
ab5fa34d7c Use ZMQ_VERSION_INFO constant everywhere
.IP \(bu 2
43b5558b82 Add trace logging on ZMQ sockets communication
.IP \(bu 2
164204a9fe Remove duplicate code for ZMQ monitor handling
.IP \(bu 2
834b1e4ff0 Remove obsolete ZMQIOLoop direct instance
.IP \(bu 2
1c90cbdb3c Remove an empty line
.IP \(bu 2
ef2e0acd66 Add logging on ZMQ socket exception
.IP \(bu 2
38ceed371d Lintfix: ident
.IP \(bu 2
1ece6a5f52 Lintfix: line too long
.IP \(bu 2
4e650c0b44 Remove code duplicate by reusing utilities functions
.IP \(bu 2
57da54b676 Fix imports
.IP \(bu 2
948368e9a1 Add libzmq version info builder
.IP \(bu 2
0b4a17b859 Update log exception message
.IP \(bu 2
116e1809fc Put a message alongside the exception to the logs
.IP \(bu 2
4bc43124b7 Remove unnecessary ZMQ import and check for its presence
.IP \(bu 2
05f4d40269 Use utility for ZMQ import handling in SSH client
.IP \(bu 2
457ef7d9a5 Use utility for ZMQ import handling in flo/zero
.IP \(bu 2
08dee6f5bd Use utility for ZMQ import handling
.IP \(bu 2
e2a353cfb0 Remove unnecessary ZMQ extra\-check for cache utils
.IP \(bu 2
c8f2cc271d Remove unnecessary ZMQ extra\-check for master utils
.IP \(bu 2
3940667bb9 Remove old ZMQ import handling
.IP \(bu 2
f34a53e029 Use ZMQ utility for version check
.IP \(bu 2
cbb26dcb28 Use ZMQ installer for master
.IP \(bu 2
453e83210a Add ZMQ version build
.IP \(bu 2
af9601e21d Use ZMQ importer utility in async
.IP \(bu 2
d50b2b2023 Incorporate tornado\-5 fixes
.IP \(bu 2
1fd9af0655 Add ZMQ backward\-compatibility tornado installer for older versions
.IP \(bu 2
ad4b40415c Add one place for handling various ZMQ versions and IOLoop classes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47343\fP: (\fI\%Ch3LL\fP) Add additional service module integration tests and enable for windows
@ \fI2018\-05\-02 13:39:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
b14e974b5f Merge pull request \fI\%#47343\fP from Ch3LL/win_srv_test
.IP \(bu 2
2173b6f549 ensure we are enabling/disabling before test
.IP \(bu 2
d58be06751 Add additionatl service module integration tests and enable for windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47375\fP: (\fI\%terminalmage\fP) Warn on use of virtual packages in pkg.installed state
@ \fI2018\-05\-01 21:12:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
b0f3fb577f Merge pull request \fI\%#47375\fP from terminalmage/issue47310
.IP \(bu 2
fa2bea52bb Remove extra blank line to appease linter
.IP \(bu 2
f8ab2be81c Add debug logging if we fail to detect virtual packages
.IP \(bu 2
67c4fc56ac Warn on use of virtual packages in pkg.installed state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47415\fP: (\fI\%kstreee\fP) Fixes a bug of rest_tornado\(aqs \(aqlocal\(aq client, complement fix of \fI\%#46326\fP
@ \fI2018\-05\-01 21:11:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47200\fP: (\fI\%kstreee\fP) Resolve a conflict with syndic timeout and bug fixes of the local client in rest_tornado (refs: \fI\%#47415\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47123\fP: (\fI\%rallytime\fP) [develop] Merge forward from 2018.3 to develop (refs: \fI\%#47200\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47110\fP: (\fI\%kstreee\fP) Fixes misusing of the timeout option. (refs: \fI\%#47200\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46692\fP: (\fI\%mattp\-\fP) saltnado bugfixes for ldap & syndics (refs: \fI\%#47123\fP, \fI\%#47200\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46326\fP: (\fI\%kstreee\fP) Fixes a timing bug of saltnado\(aqs client local. (refs: \fI\%#47110\fP, \fI\%#47123\fP, \fI\%#47200\fP, \fI\%#47415\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45874\fP: (\fI\%GwiYeong\fP) fix for local client timeout bug (refs: \fI\%#46326\fP)
.IP \(bu 2
56235032f4 Merge pull request \fI\%#47415\fP from kstreee/fix\-local\-client\-tgt\-bug
.IP \(bu 2
b8d37e0a1e To add a test case for the syndic environment, copies the test case which was written by @mattp\- that was already merged into develop branch, related pr is \fI\%#46692\fP\&.
.IP \(bu 2
4627bad1fd Realizes \(aqtgt\(aq field into actual minions using ckminions to subscribe results of the minions before publishing a payload.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47286\fP: (\fI\%baniobloom\fP) fixed vpc_peering_connection_name option
@ \fI2018\-05\-01 19:02:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
d65ceaee03 Merge pull request \fI\%#47286\fP from baniobloom/vpc_peering_connection_name_fix
.IP \(bu 2
a968965087 Merge branch \(aq2017.7\(aq into vpc_peering_connection_name_fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47270\fP: (\fI\%meaksh\fP) Fix minion scheduler to return \(aqretcode\(aq from executed functions
@ \fI2018\-04\-30 18:21:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
8a5d4437bb Merge pull request \fI\%#47270\fP from meaksh/2017.7\-fix\-retcode\-on\-schedule\-utils
.IP \(bu 2
d299cf3385 Merge branch \(aq2017.7\(aq into 2017.7\-fix\-retcode\-on\-schedule\-utils
.IP \(bu 2
b6da600fff Initialize __context__ retcode for functions handled via schedule util module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47264\fP: (\fI\%jf\fP) doc: \fI\%https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.grains.html#salt.modules.grains.delval\fP s/of pass/or pass/ (refs: \fI\%#47371\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47371\fP: (\fI\%rallytime\fP) Fix \(dqof pass\(dq typo in grains.delval docs: change to \(dqor pass\(dq
@ \fI2018\-04\-30 18:18:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b51075384 Merge pull request \fI\%#47371\fP from rallytime/fix\-47264
.IP \(bu 2
a43485b49c Fix \(dqof pass\(dq typo in grains.delval docs: change to \(dqor pass\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47389\fP: (\fI\%dwoz\fP) Older GitPython versions will not have close
@ \fI2018\-04\-29 16:42:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
a86e53be66 Merge pull request \fI\%#47389\fP from dwoz/moregittestfix
.IP \(bu 2
67745c1362 Older GitPython versions will not have close
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47388\fP: (\fI\%dwoz\fP) Fix missing import
@ \fI2018\-04\-28 18:33:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
a5367eaf63 Merge pull request \fI\%#47388\fP from dwoz/test_pip_fix
.IP \(bu 2
eb26321e8b Fix missing import
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47380\fP: (\fI\%gtmanfred\fP) add io_loop handling to runtests engine
@ \fI2018\-04\-28 17:25:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
9b59b991c2 Merge pull request \fI\%#47380\fP from gtmanfred/2017.7
.IP \(bu 2
93d1445ec1 add io_loop handling to runtests engine
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47384\fP: (\fI\%dwoz\fP) Fix py2 version of pip test
@ \fI2018\-04\-28 15:13:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
37822c0cbb Merge pull request \fI\%#47384\fP from dwoz/test_pip_fix
.IP \(bu 2
a37a9da1fb Fix py2 version of pip test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47382\fP: (\fI\%dwoz\fP) Close the repo and fix multiple tests
@ \fI2018\-04\-28 15:09:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
eefd96732e Merge pull request \fI\%#47382\fP from dwoz/gitfs_tests
.IP \(bu 2
1570708fac Close the repo and fix multiple tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47369\fP: (\fI\%terminalmage\fP) Return an empty dict if no search_order in ldap ext_pillar config file
@ \fI2018\-04\-27 20:58:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
57c75ff660 Merge pull request \fI\%#47369\fP from terminalmage/ldap_pillar
.IP \(bu 2
085883ae2d Return an empty dict if no search_order in ldap ext_pillar config file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47363\fP: (\fI\%DmitryKuzmenko\fP) Tornado5.0: Future.exc_info is dropped
@ \fI2018\-04\-27 18:30:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
bcc66dd9bf Merge pull request \fI\%#47363\fP from DSRCorporation/bugs/replace_exc_info_with_exception
.IP \(bu 2
3f7b93a23c Tornado5.0: Future.exc_info is dropped
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47334\fP: (\fI\%terminalmage\fP) pillar_ldap: Fix cryptic errors when config file fails to load
@ \fI2018\-04\-27 17:53:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
bcef34f7e1 Merge pull request \fI\%#47334\fP from terminalmage/ldap_pillar
.IP \(bu 2
0175a8687c pillar_ldap: Fix cryptic errors when config file fails to load
.IP \(bu 2
65c3ba7ff1 Remove useless documentation
.IP \(bu 2
5d67cb27de Remove unnecessary commented line
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47347\fP: (\fI\%dwoz\fP) Proper fix for mysql tests
@ \fI2018\-04\-27 17:27:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
31db8ca7ad Merge pull request \fI\%#47347\fP from dwoz/test_mysql_fix_again
.IP \(bu 2
add78fb618 Fix linter warnings
.IP \(bu 2
2644cc7553 Fix linter nits
.IP \(bu 2
799c601184 Proper fix for mysql tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47359\fP: (\fI\%gtmanfred\fP) add mention of the formulas channel to the formulas docs
@ \fI2018\-04\-27 16:56:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
e573236848 Merge pull request \fI\%#47359\fP from gtmanfred/2017.7
.IP \(bu 2
6214ed8133 add mention of the formulas channel to the formulas docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47317\fP: (\fI\%dwoz\fP) Do not join a thread that is stopped
@ \fI2018\-04\-27 13:15:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47279\fP: (\fI\%dwoz\fP) Gracefully shutdown worker threads (refs: \fI\%#47317\fP)
.IP \(bu 2
629503b2a8 Merge pull request \fI\%#47317\fP from dwoz/threadshutdown
.IP \(bu 2
6db2a0e4d3 Log exceptions at exception level
.IP \(bu 2
d4ae787595 Do not join a thread that is stopped
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47304\fP: (\fI\%cachedout\fP) Pass timeout to salt CLI for tests
@ \fI2018\-04\-27 13:11:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
aacd5cefe3 Merge pull request \fI\%#47304\fP from cachedout/test_cli_timeout_arg
.IP \(bu 2
85025af83c Pass timeout to salt CLI for tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47311\fP: (\fI\%Ch3LL\fP) Add firewall execution modules tests for windows
@ \fI2018\-04\-27 13:10:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
55534fb659 Merge pull request \fI\%#47311\fP from Ch3LL/firewall_windows
.IP \(bu 2
4e16c18c16 Add firewall module windows tests to whitelist
.IP \(bu 2
4b2fc4ec66 Add windows firewall execution modules integration tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47348\fP: (\fI\%dwoz\fP) Ignore gitfs tests when symlinks not enabled
@ \fI2018\-04\-27 13:08:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
1667375a80 Merge pull request \fI\%#47348\fP from dwoz/no_symlinks
.IP \(bu 2
94a70e847a Ignore gitfs tests when symlinks not enabled
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47342\fP: (\fI\%dwoz\fP) Fix mysql test cases
@ \fI2018\-04\-27 00:50:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
dac04261b5 Merge pull request \fI\%#47342\fP from dwoz/test_mysql_fix
.IP \(bu 2
7496f4c5a8 Fix mysql test cases
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47341\fP: (\fI\%dwoz\fP) Fix python 3 support for inet_pton function
@ \fI2018\-04\-26 23:35:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
34e78ef564 Merge pull request \fI\%#47341\fP from dwoz/inet_pton_fix
.IP \(bu 2
85451f48d4 Fix python 3 support for inet_pton function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47339\fP: (\fI\%dwoz\fP) Use salt.utils.fopen for line ending consistency
@ \fI2018\-04\-26 22:39:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
e4779f3246 Merge pull request \fI\%#47339\fP from dwoz/ssh_key_test_fix
.IP \(bu 2
e37a93a1ca Remove redundent close call
.IP \(bu 2
b2ae5889b7 Close the temporary file handle
.IP \(bu 2
9f7f83a975 Use salt.utils.fopen for line ending consistency
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47335\fP: (\fI\%dwoz\fP) Remove un\-needed string\-escape
@ \fI2018\-04\-26 21:49:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
b221860151 Merge pull request \fI\%#47335\fP from dwoz/pip_test_fix
.IP \(bu 2
dcb6a22c00 Remove un\-needed string\-escape
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47331\fP: (\fI\%dwoz\fP) Do not encode usernames
@ \fI2018\-04\-26 19:57:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
1c527bfd3a Merge pull request \fI\%#47331\fP from dwoz/py3_wingroup_fix
.IP \(bu 2
cc154ef857 Do not encode usernames
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47329\fP: (\fI\%cachedout\fP) Credit Frank Spierings
@ \fI2018\-04\-26 16:37:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
708078b152 Merge pull request \fI\%#47329\fP from cachedout/frank_credit
.IP \(bu 2
33c0644ac4 Credit Frank Spierings
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47281\fP: (\fI\%Ch3LL\fP) Add win_system integration module tests
@ \fI2018\-04\-26 16:07:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
a545e55543 Merge pull request \fI\%#47281\fP from Ch3LL/system_test
.IP \(bu 2
c9181a75a6 Add destructivetest decorator on tests
.IP \(bu 2
0d0c8987fc Add win_system integration module tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47283\fP: (\fI\%Ch3LL\fP) Add windows ntp integration module tests
@ \fI2018\-04\-26 16:04:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
b64d930df0 Merge pull request \fI\%#47283\fP from Ch3LL/ntp_test
.IP \(bu 2
ced7f86546 Add windows ntp integration module tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47314\fP: (\fI\%Ch3LL\fP) Skip netstat test on macosx as its not supported
@ \fI2018\-04\-26 16:00:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
910aff910f Merge pull request \fI\%#47314\fP from Ch3LL/net_mac_test
.IP \(bu 2
67beb1451c Skip netstat test on macosx as its not supported
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47307\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47257\fP to 2017.7
@ \fI2018\-04\-26 15:16:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47257\fP: (\fI\%jeroennijhof\fP) Role is not a list but a dictionary (refs: \fI\%#47307\fP)
.IP \(bu 2
0549ef7c16 Merge pull request \fI\%#47307\fP from rallytime/bp\-47257
.IP \(bu 2
6c5b2f92bc Role is not a list but a dictionary
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47312\fP: (\fI\%rallytime\fP) Update bootstrap script to latest release: 2018.04.25
@ \fI2018\-04\-26 15:15:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
d6ff4689f6 Merge pull request \fI\%#47312\fP from rallytime/update\-bootstrap\-release
.IP \(bu 2
765cce06a2 Update bootstrap script to latest release: 2018.04.25
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47279\fP: (\fI\%dwoz\fP) Gracefully shutdown worker threads (refs: \fI\%#47317\fP)
@ \fI2018\-04\-25 21:15:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
e0765f5719 Merge pull request \fI\%#47279\fP from dwoz/py3_build_fix
.IP \(bu 2
21dc1bab91 Pep\-8 line endings
.IP \(bu 2
717abedaf7 Fix comman wart
.IP \(bu 2
4100dcd64c Close might get called more than once
.IP \(bu 2
dbe671f943 Stop socket before queue on delete
.IP \(bu 2
9587f5c69e Silence pylint import\-error for six.moves
.IP \(bu 2
4b0c7d3b34 Fix typo
.IP \(bu 2
05adf7c2b1 Use six.moves for queue import
.IP \(bu 2
fe340778fa Gracefully shutdown worker threads
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47113\fP: (\fI\%jfindlay\fP) Support proto for IPSec policy extension in iptables state
@ \fI2018\-04\-25 18:01:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
44f19b2f94 Merge pull request \fI\%#47113\fP from jfindlay/iptables_state
.IP \(bu 2
8bd08012ee modules,states.iptables support proto for policy ext
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47302\fP: (\fI\%Ch3LL\fP) Remove unnecessary code from core grains and add test
@ \fI2018\-04\-25 17:58:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
b7a6206330 Merge pull request \fI\%#47302\fP from Ch3LL/dead_code
.IP \(bu 2
daa68b4877 Add virtual grains test for core grains
.IP \(bu 2
a59dd2785d Remove dead code in core grains file for virt\-what
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47303\fP: (\fI\%baniobloom\fP) Added clarity on oldest supported main release branch
@ \fI2018\-04\-25 17:52:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
e29362acfc Merge pull request \fI\%#47303\fP from baniobloom/bug_fix_doc
.IP \(bu 2
b97c9df5f3 added clarity on how to figure out what is the oldest supported main release branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45790\fP: (\fI\%bdarnell\fP) Test with Tornado 5.0b1 (refs: \fI\%#47106\fP, \fI\%#47433\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47106\fP: (\fI\%DmitryKuzmenko\fP) Tornado50 compatibility fixes (refs: \fI\%#47433\fP)
@ \fI2018\-04\-25 15:32:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d9d55e013 Merge pull request \fI\%#47106\fP from DSRCorporation/bugs/tornado50
.IP \(bu 2
39e403b18d Merge branch \(aq2017.7\(aq into bugs/tornado50
.IP \(bu 2
6706b3a2d1 Run off of a temporary config
.IP \(bu 2
d6873800d5 Allow running pytest>=3.5.0
.IP \(bu 2
2da3983740 Tornado 5.0 compatibility fixes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47258\fP: (\fI\%drewmat\fP) service state no longer working after kernel upgrade (refs: \fI\%#47271\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47271\fP: (\fI\%gtmanfred\fP) load rh_service for amazon linux not booted with systemd
@ \fI2018\-04\-25 14:47:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e014f4746 Merge pull request \fI\%#47271\fP from gtmanfred/amazon
.IP \(bu 2
8a53908908 Do not load rh_service module when booted with systemd
.IP \(bu 2
e4d1d5bf11 Revert \(dqsupport amazon linux 2 for service module\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44847\fP: (\fI\%malbertus\fP) netconfig.managed state.apply unexpected behaviour of test & debug variables (refs: \fI\%#47246\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47246\fP: (\fI\%mirceaulinic\fP) Attempting to fix \fI\%#44847\fP: allow a different way to get the test and debug flags into the netconfig state
@ \fI2018\-04\-25 14:44:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
599b0ed1e9 Merge pull request \fI\%#47246\fP from cloudflare/fix\-44847\-2017.7
.IP \(bu 2
ad80028104 This way, we can pass flags such as \fBdebug\fP into the state, but also \fBtest\fP\&.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47220\fP: (\fI\%benediktwerner\fP) Fix pip.installed when no changes occurred with pip >= 1.0.0
@ \fI2018\-04\-25 14:23:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47207\fP: (\fI\%benediktwerner\fP) Fix pip_state with pip3 if no changes occourred (refs: \fI\%#47220\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47102\fP: (\fI\%gtmanfred\fP) don\(aqt allow using no_use_wheel for pip 10.0.0 or newer (refs: \fI\%#47220\fP)
.IP \(bu 2
4e2e1f0719 Merge pull request \fI\%#47220\fP from benediktwerner/fix\-pip\-2017.7
.IP \(bu 2
0197c3e973 Fix pip test
.IP \(bu 2
34bf66c09f Fix pip.installed with pip>=10.0.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47272\fP: (\fI\%rallytime\fP) Add windows tests and reg module/state to CODEOWNERS file for team\-windows
@ \fI2018\-04\-25 13:25:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
92e606251f Merge pull request \fI\%#47272\fP from rallytime/reg\-windows\-codeowners
.IP \(bu 2
9445af0185 Add windows tests and reg module/state to CODEOWNERS file for team\-windows
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
8de3d41adb fixed vpc_peering_connection_name option
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47252\fP: (\fI\%rallytime\fP) Fix the matching patterns in the CODEOWNERS file to use fnmatch patterns
@ \fI2018\-04\-24 14:10:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
9dca5c0221 Merge pull request \fI\%#47252\fP from rallytime/codeowners\-fixes
.IP \(bu 2
204b6af92b Fix the matching patterns in the CODEOWNERS file to use fnmatch patterns
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47173\fP: (\fI\%fpicot\fP) pkg.installed ignores normalize parameter (refs: \fI\%#47177\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47177\fP: (\fI\%fpicot\fP) fix normalize parameter in pkg.installed
@ \fI2018\-04\-24 13:37:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
3de1bb49c8 Merge pull request \fI\%#47177\fP from fpicot/fix_47173_pkg_normalize
.IP \(bu 2
149f846f34 fix normalize parameter in pkg.installed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47251\fP: (\fI\%Ch3LL\fP) Update Docs to remove unnecessary + sign
@ \fI2018\-04\-23 19:37:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
10e30515dc Merge pull request \fI\%#47251\fP from Ch3LL/pub_fix_rn
.IP \(bu 2
fa4c2e6575 Update Docs to remove unnecessary + sign
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47249\fP: (\fI\%Ch3LL\fP) Add CVE number to 2016.3.6 Release
@ \fI2018\-04\-23 19:05:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb7850a431 Merge pull request \fI\%#47249\fP from Ch3LL/pub_fix_rn
.IP \(bu 2
24dea24b7e Add CVE number to 2016.3.6 Release
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47225\fP: (\fI\%pruiz\fP) zfs.filesystem_present takes forever on a dataset with lots (10k+) of snapshots (refs: \fI\%#47226\fP, \fI\%#47227\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47227\fP: (\fI\%pruiz\fP) Fix issue \fI\%#47225\fP: avoid zfs.filesystem_present slowdown when dataset has lots of snapshots (2017.7 branch)
@ \fI2018\-04\-23 14:05:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47226\fP: (\fI\%pruiz\fP) Fix issue \fI\%#47225\fP: avoid zfs.filesystem_present slowdown when dataset has lots of snapshots (refs: \fI\%#47227\fP)
.IP \(bu 2
56933eb0b2 Merge pull request \fI\%#47227\fP from pruiz/pruiz/zfs\-dataset\-present\-slow\-2017.7
.IP \(bu 2
fded61f19b Fix issue \fI\%#47225\fP: avoid zfs.filesystem_present slowdown when dataset has lots of snapshots
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47167\fP: (\fI\%smitty42\fP) Adding updates for python3 compatibility and new virtualbox SDK versi…
@ \fI2018\-04\-23 13:20:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
9825065048 Merge pull request \fI\%#47167\fP from smitty42/vbox\-skd\-fix
.IP \(bu 2
5de53139cd Merge branch \(aq2017.7\(aq into vbox\-skd\-fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47213\fP: (\fI\%dwoz\fP) Fix coverage on py3 windows builds
@ \fI2018\-04\-20 22:09:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
976f031170 Merge pull request \fI\%#47213\fP from dwoz/py3win
.IP \(bu 2
ad9c7f63f0 Fix coverate on py3 windows builds
.IP \(bu 2
91252bac95 Adding updates for python3 compatibility and new virtualbox SDK version support.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47197\fP: (\fI\%dwoz\fP) Move process target to top level module namespace
@ \fI2018\-04\-20 15:41:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
cebcd6d069 Merge pull request \fI\%#47197\fP from dwoz/testfix
.IP \(bu 2
25803c9176 Move process target to top level module namespace
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47193\fP: (\fI\%Ch3LL\fP) Add network module integration tests
@ \fI2018\-04\-20 13:37:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
d4269c2b70 Merge pull request \fI\%#47193\fP from Ch3LL/network_test
.IP \(bu 2
bbf9987c19 Add network module integration tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47189\fP: (\fI\%Ch3LL\fP) Add autoruns.list integration test for Windows
@ \fI2018\-04\-19 21:16:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
c777248a78 Merge pull request \fI\%#47189\fP from Ch3LL/autoruns
.IP \(bu 2
6a88bedb7a Add autoruns to windows whitelist
.IP \(bu 2
e9e4d4af70 Add autoruns.list integration test for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47184\fP: (\fI\%Ch3LL\fP) Add status module integration modules tests for Windows
@ \fI2018\-04\-19 19:38:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
65f344e371 Merge pull request \fI\%#47184\fP from Ch3LL/status_test
.IP \(bu 2
25a84428b8 Add status module integration modules tests for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47163\fP: (\fI\%rallytime\fP) Updage jenkins module autodocs to use jenkinsmod name instead
@ \fI2018\-04\-19 19:35:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46801\fP: (\fI\%yagnik\fP) rename jenkins to jenkinsmod (refs: \fI\%#46900\fP, \fI\%#47163\fP)
.IP \(bu 2
965600ad6c Merge pull request \fI\%#47163\fP from rallytime/jenkins\-autodoc
.IP \(bu 2
0039395017 Updage jenkins module autodocs to use jenkinsmod name instead
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47185\fP: (\fI\%twangboy\fP) Add additional integration tests to whitelist
@ \fI2018\-04\-19 18:20:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a43dde5fc Merge pull request \fI\%#47185\fP from twangboy/add_tests
.IP \(bu 2
345daa0423 Add additional integration tests to whitelist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47172\fP: (\fI\%dwoz\fP) Allow non admin name based runs on windows
@ \fI2018\-04\-19 17:26:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a600bb9a4 Merge pull request \fI\%#47172\fP from dwoz/cover_without_admin
.IP \(bu 2
cadd759727 Use warnings to warn user
.IP \(bu 2
144c68e214 Allow non admin name based runs on windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47110\fP: (\fI\%kstreee\fP) Fixes misusing of the timeout option. (refs: \fI\%#47200\fP)
@ \fI2018\-04\-18 17:16:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46326\fP: (\fI\%kstreee\fP) Fixes a timing bug of saltnado\(aqs client local. (refs: \fI\%#47110\fP, \fI\%#47123\fP, \fI\%#47200\fP, \fI\%#47415\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45874\fP: (\fI\%GwiYeong\fP) fix for local client timeout bug (refs: \fI\%#46326\fP)
.IP \(bu 2
d5997d2301 Merge pull request \fI\%#47110\fP from kstreee/fix\-misusing\-of\-timeout
.IP \(bu 2
0624aee0ed Fixes misusing of the timeout option.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40948\fP: (\fI\%ScoreUnder\fP) salt\-call falsely reports a master as down if it does not have PKI directories created (refs: \fI\%#40961\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40961\fP: (\fI\%terminalmage\fP) Make error more explicit when PKI dir not present for salt\-call
@ \fI2018\-04\-18 16:08:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
87ca2b4003 Merge pull request \fI\%#40961\fP from terminalmage/issue40948
.IP \(bu 2
6ba66cca41 Fix incorrect logic in exception check
.IP \(bu 2
fed5041c5f Make error more specific to aid in troubleshooting
.IP \(bu 2
8c67ab53b4 Fix path in log message
.IP \(bu 2
3198ca8b19 Make error more explicit when PKI dir not present for salt\-call
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47134\fP: (\fI\%Ch3LL\fP) Add user integration tests for windows OS
@ \fI2018\-04\-18 14:29:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
f5e63584d4 Merge pull request \fI\%#47134\fP from Ch3LL/user_win_test
.IP \(bu 2
e7c9bc4038 Add user integration tests for windows OS
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47131\fP: (\fI\%gtmanfred\fP) add __cli opts variable for master processes
@ \fI2018\-04\-17 21:33:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
da2f6a3fac Merge pull request \fI\%#47131\fP from gtmanfred/cli
.IP \(bu 2
1b1c29bf62 add __cli for master processes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47116\fP: (\fI\%pcjeff\fP) pip 10.0.0 can not import pip.req (refs: \fI\%#47121\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47129\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47121\fP to 2017.7
@ \fI2018\-04\-17 20:45:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47121\fP: (\fI\%pcjeff\fP) fix pip import error in pip 10.0.0 (refs: \fI\%#47129\fP)
.IP \(bu 2
9b8e6ffb8c Merge pull request \fI\%#47129\fP from rallytime/bp\-47121
.IP \(bu 2
11da526b21 add ImportError
.IP \(bu 2
bd0c23396c fix pip.req import error in pip 10.0.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47102\fP: (\fI\%gtmanfred\fP) don\(aqt allow using no_use_wheel for pip 10.0.0 or newer (refs: \fI\%#47220\fP)
@ \fI2018\-04\-17 20:44:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
eb5ac51a48 Merge pull request \fI\%#47102\fP from gtmanfred/2017.7
.IP \(bu 2
3dc93b310b fix tests
.IP \(bu 2
8497e08f8e fix pip module for 10.0.0
.IP \(bu 2
4c07a3d1e9 fix other tests
.IP \(bu 2
b71e3d8a04 don\(aqt allow using no_use_wheel for pip 10.0.0 or newer
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47037\fP: (\fI\%twangboy\fP) Fix build_env scripts
@ \fI2018\-04\-17 18:54:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
c1dc42e67e Merge pull request \fI\%#47037\fP from twangboy/fix_dev_scripts
.IP \(bu 2
990a24d7ed Fix build_env scripts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47108\fP: (\fI\%dwoz\fP) Fix unit.utils.test_event.TestAsyncEventPublisher.test_event_subscription
@ \fI2018\-04\-17 00:25:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a4c0b8a1a Merge pull request \fI\%#47108\fP from dwoz/async_test_fix
.IP \(bu 2
3d85e30ce5 AsyncTestCase is required for AsyncEventPublisher
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47068\fP: (\fI\%cachedout\fP) Catch an operation on a closed socket in a test
@ \fI2018\-04\-16 19:56:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
03892eaf0b Merge pull request \fI\%#47068\fP from cachedout/catch_value_error_socket_test
.IP \(bu 2
7db5625632 Catch an operation on a closed socket in a test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47065\fP: (\fI\%dwoz\fP) Jinja test fix
@ \fI2018\-04\-16 16:16:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
1ea2885ec2 Merge pull request \fI\%#47065\fP from dwoz/jinja_test_fix
.IP \(bu 2
673cd31c65 Merge branch \(aq2017.7\(aq into jinja_test_fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47077\fP: (\fI\%dwoz\fP) Fix failing state test by normalizing line endings
@ \fI2018\-04\-16 15:48:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
5293b5b5ca Merge pull request \fI\%#47077\fP from dwoz/test_state_fix
.IP \(bu 2
444da3f893 Fix py3 wart (chr vs bytesstring)
.IP \(bu 2
e8acca01c2 Fix failing state test by normalizing line endings
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46538\fP: (\fI\%HenriWahl\fP) salt\-cloud gives \(dqFutureWarning: The behavior of this method will change in future versions.\(dq (refs: \fI\%#47067\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47067\fP: (\fI\%gtmanfred\fP) use the recommended opennebula lookup method
@ \fI2018\-04\-16 15:48:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca967de5da Merge pull request \fI\%#47067\fP from gtmanfred/2017.7
.IP \(bu 2
f913a7859c use the recommended opennebula lookup method
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47064\fP: (\fI\%dwoz\fP) Fix fileserver roots tests
@ \fI2018\-04\-14 21:30:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
7fddad6cd9 Merge pull request \fI\%#47064\fP from dwoz/roots_tests_fix
.IP \(bu 2
25fd7c0694 fix py3 wart, encode os.linesep
.IP \(bu 2
d79f1a1961 Fix fileserver roots tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47069\fP: (\fI\%cachedout\fP) Pass the timeout variable to the CLI when calling salt in tests
@ \fI2018\-04\-14 15:20:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
977c6939c4 Merge pull request \fI\%#47069\fP from cachedout/match_timeout_arg
.IP \(bu 2
b8990f5258 Pass the timeout variable to the CLI when calling salt in tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47074\fP: (\fI\%dwoz\fP) Kitchn should ignore artifacts directory
@ \fI2018\-04\-14 13:06:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
2c4c19c622 Merge pull request \fI\%#47074\fP from dwoz/ignore_artifacts
.IP \(bu 2
c3941efad0 Kitchn should ignore artifacts directory
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47000\fP: (\fI\%mvintila\fP) Client API: full_return paramenter missing from cmd_subset function (refs: \fI\%#47055\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47055\fP: (\fI\%mattp\-\fP) \fI\%#47000\fP \- add proper handling of full_return in cmd_subset
@ \fI2018\-04\-13 20:17:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
c484c0bd71 Merge pull request \fI\%#47055\fP from bloomberg/GH\-47000
.IP \(bu 2
8af3f5b874 GH\-47000: add proper handling of full_return in cmd_subset
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47039\fP: (\fI\%twangboy\fP) Fix winrm powershell script
@ \fI2018\-04\-13 18:09:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
f3496030cc Merge pull request \fI\%#47039\fP from twangboy/win_fix_winrm_script
.IP \(bu 2
6635b9003f Fix winrm powershell script
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
46fa2c04de Fix py3 os.linesep wart
.IP \(bu 2
3c565d7e54 Use salt.utils.fopen
.IP \(bu 2
aa965310f1 Clean up cruft
.IP \(bu 2
efc9866580 Jinja test fixes
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46326\fP: (\fI\%kstreee\fP) Fixes a timing bug of saltnado\(aqs client local. (refs: \fI\%#47110\fP, \fI\%#47123\fP, \fI\%#47200\fP, \fI\%#47415\fP)
@ \fI2018\-04\-13 13:59:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45874\fP: (\fI\%GwiYeong\fP) fix for local client timeout bug (refs: \fI\%#46326\fP)
.IP \(bu 2
1700a10ebe Merge pull request \fI\%#46326\fP from kstreee/fix\-client\-local
.IP \(bu 2
0f358a9c9e Fixes a timing bug of saltnado\(aqs client local.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46877\fP: (\fI\%trudesea\fP) Unable to apply GPO (Windows 2016) (refs: \fI\%#46913\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#44516\fP: (\fI\%doesitblend\fP) Windows PY3 Minion Returns UTF16 UnicodeError (refs: \fI\%#44944\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46913\fP: (\fI\%lomeroe\fP) 2017.7 Fix \fI\%#46877\fP \-\- win_lgpo start/shutdown script reading
@ \fI2018\-04\-12 15:10:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44944\fP: (\fI\%lomeroe\fP) win_lgpo registry.pol encoding updates (refs: \fI\%#46913\fP, \fI\%#47438\fP)
.IP \(bu 2
c3c00316c5 Merge pull request \fI\%#46913\fP from lomeroe/2017_7\-fix46877
.IP \(bu 2
369a0645ed move exception for clarity
.IP \(bu 2
32ce5bfda5 Use configparser serializer object to read psscript.ini and script.ini startup/shutdown script files.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47025\fP: (\fI\%terminalmage\fP) Fix server_id grain in PY3 on Windows
@ \fI2018\-04\-12 15:08:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
9e37cfc9d6 Merge pull request \fI\%#47025\fP from terminalmage/fix\-server_id\-windows
.IP \(bu 2
cb0cf89ed3 Fix server_id grain in PY3 on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47027\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44508\fP to 2017.7
@ \fI2018\-04\-12 15:05:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44508\fP: (\fI\%mzbroch\fP) Capirca integration (refs: \fI\%#47027\fP)
.IP \(bu 2
2e193cfb45 Merge pull request \fI\%#47027\fP from rallytime/bp\-44508
.IP \(bu 2
8e72f362f4 Add priority field to support the latest capirca.
.IP \(bu 2
112f92baab Add priority field to support the latest capirca.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47020\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46970\fP to 2017.7
@ \fI2018\-04\-11 21:48:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46970\fP: (\fI\%garethgreenaway\fP)  [2017.7] fix to pkgrepo comments test (refs: \fI\%#47020\fP)
.IP \(bu 2
385fe2bc1e Merge pull request \fI\%#47020\fP from rallytime/bp\-46970
.IP \(bu 2
9373dff52b Update test_pkgrepo.py
.IP \(bu 2
13cf9eb5b1 Removing debugging.
.IP \(bu 2
a61a8593e5 Removing suse from pkgrepo comments tests.  the pkgrepo functions in SUSE pkg module do not support comments.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46504\fP: (\fI\%jfoboss\fP) ntp.managed fails on non\-english systems (refs: \fI\%#46539\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46539\fP: (\fI\%jfoboss\fP) \fI\%#46504\fP Fix
@ \fI2018\-04\-11 14:13:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
8f994e7cf9 Merge pull request \fI\%#46539\fP from jfoboss/patch\-1
.IP \(bu 2
6890122e41 Merge pull request #1 from twangboy/pull_46539
.INDENT 2.0
.IP \(bu 2
19c3fadbe5 Fix unit test for win_ntp
.UNINDENT
.IP \(bu 2
826a8d3099 Fixing \fI\%#46504\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46999\fP: (\fI\%gtmanfred\fP) switch pip test package
@ \fI2018\-04\-10 21:18:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
74d70e95a5 Merge pull request \fI\%#46999\fP from gtmanfred/2017.7
.IP \(bu 2
791af8f6ce switch pip test package
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46023\fP: (\fI\%mattp\-\fP) add parallel support for orchestrations
@ \fI2018\-04\-10 19:26:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
8adaf7f526 Merge pull request \fI\%#46023\fP from bloomberg/parallel\-orch
.IP \(bu 2
0ac0b3ca29 Merge branch \(aq2017.7\(aq into parallel\-orch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46581\fP: (\fI\%qcpeter\fP) puppet.fact tries to parse output to stderr (refs: \fI\%#46613\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46613\fP: (\fI\%myinitialsarepm\fP) Fix puppet.fact and puppet.facts to use stdout.
@ \fI2018\-04\-10 15:18:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
39d65a39cf Merge pull request \fI\%#46613\fP from myinitialsarepm/fix_puppet.fact_and_puppet.facts
.IP \(bu 2
44ecd13abc Update tests to use cmd.run_all
.IP \(bu 2
7d7d40f541 Merge branch \(aq2017.7\(aq into fix_puppet.fact_and_puppet.facts
.IP \(bu 2
0ce1520bd0 Merge branch \(aq2017.7\(aq into fix_puppet.fact_and_puppet.facts
.IP \(bu 2
69e1f6f681 Fix puppet.fact and puppet.facts to use stdout.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46991\fP: (\fI\%gtmanfred\fP) use saltstack salt\-jenkins
@ \fI2018\-04\-10 14:19:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
ba5421d988 Merge pull request \fI\%#46991\fP from gtmanfred/windows
.IP \(bu 2
98588c1dc5 use saltstack salt\-jenkins
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46975\fP: (\fI\%gtmanfred\fP) Make windows work for test runs in jenkinsci
@ \fI2018\-04\-10 13:41:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
00c4067585 Merge pull request \fI\%#46975\fP from gtmanfred/windows
.IP \(bu 2
1f69c0d7f8 make sure windows outputs xml junit files
.IP \(bu 2
4a2ec1bbb3 support new versions of winrm\-fs
.IP \(bu 2
b9efec8526 remove libnacl on windows
.IP \(bu 2
2edd5eaf9e fix path
.IP \(bu 2
b03e272e44 windows work
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46945\fP: (\fI\%vutny\fP) [DOC] Fix Jinja block in FAQ page
@ \fI2018\-04\-09 13:05:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
3cf2353e41 Merge pull request \fI\%#46945\fP from vutny/doc\-faq\-fix\-jinja
.IP \(bu 2
bfdf54e61d [DOC] Fix Jinja block in FAQ page
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46925\fP: (\fI\%terminalmage\fP) Remove reference to directory support in file.patch state
@ \fI2018\-04\-06 13:54:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc2f728665 Merge pull request \fI\%#46925\fP from terminalmage/fix\-file.patch\-docstring
.IP \(bu 2
97695657f0 Remove reference to directory support in file.patch state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46900\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46801\fP to 2017.7
@ \fI2018\-04\-06 13:47:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46801\fP: (\fI\%yagnik\fP) rename jenkins to jenkinsmod (refs: \fI\%#46900\fP, \fI\%#47163\fP)
.IP \(bu 2
eef6c518e1 Merge pull request \fI\%#46900\fP from rallytime/bp\-46801
.IP \(bu 2
6a41e8b457 rename jenkins to jenkinsmod
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46899\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45116\fP to 2017.7
@ \fI2018\-04\-06 13:47:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45116\fP: (\fI\%arif\-ali\fP) fix adding parameters to http.query from sdb yaml (refs: \fI\%#46899\fP)
.IP \(bu 2
71839b0303 Merge pull request \fI\%#46899\fP from rallytime/bp\-45116
.IP \(bu 2
b92f908da4 fix adding parameters to http.query from sdb yaml
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
3d5e69600b address lint issues raised by @isbm
.IP \(bu 2
a9866c7a03 fix parallel mode py3 compatibility
.IP \(bu 2
6d7730864a removing prereq from test orch
.IP \(bu 2
6c8a25778f add integration test to runners/test_state to exercise parallel
.IP \(bu 2
2c86f16b39 cherry\-pick cdata KeyError prevention from \fI\%#39832\fP
.IP \(bu 2
26a96e8933 record start/stop duration for parallel processes separately
.IP \(bu 2
e4844bdf2b revisit previous join() behavior in check_requisites
.IP \(bu 2
f00a359cdf join() parallel process instead of a recursive sleep
.IP \(bu 2
6e7007a4dc add parallel support for orchestrations
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43529\fP: (\fI\%Ch3LL\fP) Add publisher_acl Test to Auto Test Suite (refs: \fI\%#44926\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44926\fP: (\fI\%frogunder\fP) whitelist_acl_test
@ \fI2018\-04\-05 15:09:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0f5b43753 Merge pull request \fI\%#44926\fP from frogunder/whitelisted_acl
.IP \(bu 2
18e460fc30 Merge branch \(aq2017.7\(aq into whitelisted_acl
.IP \(bu 2
1ad4d7d988 fix assert errors
.IP \(bu 2
e6a56016df update test
.IP \(bu 2
19a2244cb7 whitelist_acl_test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46456\fP: (\fI\%vitaliyf\fP) \(dqValueError\(dq when running orch with \(dqsubset\(dq (refs: \fI\%#46464\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46464\fP: (\fI\%gtmanfred\fP) fix salt subset in orchestrator
@ \fI2018\-04\-05 14:52:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
7d822f9cec Merge pull request \fI\%#46464\fP from gtmanfred/orchestration
.IP \(bu 2
637cdc6b7b fix pylint
.IP \(bu 2
0151013ddb document \fIcli\fP option for cmd_subset
.IP \(bu 2
4a3ed6607d add test for subset in orchestration
.IP \(bu 2
3112359dd6 fix salt subset in orchestrator
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46523\fP: (\fI\%dwoz\fP) Add a test to the cloud suite for Windows minion on EC2 (refs: \fI\%#46879\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46879\fP: (\fI\%dwoz\fP) Fix multiple typos causing tests to fail
@ \fI2018\-04\-05 13:59:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
805ed1c964 Merge pull request \fI\%#46879\fP from dwoz/cloudtestfix
.IP \(bu 2
dc54fc53c3 Fix multiple typos causing tests to fail
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46647\fP: (\fI\%twangboy\fP) Fix the tear down function in integration.modules.test_grains
@ \fI2018\-04\-04 21:14:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
f70f6de282 Merge pull request \fI\%#46647\fP from twangboy/win_fix_test_grains
.IP \(bu 2
c179388b0e Fix the tear down function in integration.modules.test_grains.GrainsAppendTestCase
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46754\fP: (\fI\%nages13\fP) grain item virtual_subtype shows \(aqXen PV DomU\(aq on Docker containers (refs: \fI\%#46756\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#43405\fP: (\fI\%kfix\fP) LXD\-created LXC container is detected as a Xen domU (refs: \fI\%#46756\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46756\fP: (\fI\%nages13\fP) fix grains[\(aqvirtual_subtype\(aq] to show Docker on xen kernels
@ \fI2018\-04\-04 20:53:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
91c078ce12 Merge pull request \fI\%#46756\fP from nages13/bugfix\-grain\-virtual_subtype
.IP \(bu 2
781f5030a4 Merge branch \(aqbugfix\-grain\-virtual_subtype\(aq of \fI\%https://github.com/nages13/salt\fP into bugfix\-grain\-virtual_subtype
.INDENT 2.0
.IP \(bu 2
cd1ac4b7f9 Merge branch \(aq2017.7\(aq into bugfix\-grain\-virtual_subtype
.IP \(bu 2
0ace76c0e7 Merge branch \(aq2017.7\(aq into bugfix\-grain\-virtual_subtype
.IP \(bu 2
9eb6f5c0d0 Merge branch \(aq2017.7\(aq into bugfix\-grain\-virtual_subtype
.IP \(bu 2
73d6d9d365 Merge branch \(aq2017.7\(aq into bugfix\-grain\-virtual_subtype
.IP \(bu 2
a4a17eba6a Merge branch \(aq2017.7\(aq into bugfix\-grain\-virtual_subtype
.IP \(bu 2
bf5034dbdb Merge branch \(aq2017.7\(aq into bugfix\-grain\-virtual_subtype
.IP \(bu 2
8d12770951 Merge branch \(aq2017.7\(aq into bugfix\-grain\-virtual_subtype
.UNINDENT
.IP \(bu 2
7e704c0e81 Moved down container check code below hypervisors to validate containers type running in virtual environment. Fixes \fI\%#46754\fP & \fI\%#43405\fP
.IP \(bu 2
710f74c4a6 fix grains[\(aqvirtual_subtype\(aq] to show Docker on xen kernels
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46762\fP: (\fI\%ScoreUnder\fP) prereq stack overflow (refs: \fI\%#46788\fP, \fI\%#46799\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46799\fP: (\fI\%garethgreenaway\fP) [2017.7] Adding test for PR \fI\%#46788\fP
@ \fI2018\-04\-04 20:41:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46788\fP: (\fI\%garethgreenaway\fP) [2017.7] Ensure failed tags are added to self.pre (refs: \fI\%#46799\fP)
.IP \(bu 2
058bbed221 Merge pull request \fI\%#46799\fP from garethgreenaway/46762_prereq_shenanigans_tests
.IP \(bu 2
13875e78cf Fixing documentation string for test.
.IP \(bu 2
3d288c44d4 Fixing test documentation
.IP \(bu 2
6cff02ef6a Adding tests for \fI\%#46788\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46867\fP: (\fI\%terminalmage\fP) Backport string arg normalization to 2017.7 branch
@ \fI2018\-04\-04 18:06:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
d9770bf3f8 Merge pull request \fI\%#46867\fP from terminalmage/unicode\-logging\-normalization
.IP \(bu 2
7652688e83 Backport string arg normalization to 2017.7 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46770\fP: (\fI\%twangboy\fP) Change the order of SID Lookup
@ \fI2018\-04\-04 17:33:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
9eb98b1f6e Merge pull request \fI\%#46770\fP from twangboy/fix_46433
.IP \(bu 2
89af0a6222 Merge branch \(aq2017.7\(aq into fix_46433
.IP \(bu 2
67b4697578 Remove unused import (ling)
.IP \(bu 2
9302fa5ab0 Clean up code comments
.IP \(bu 2
b383b9b330 Change the order of SID Lookup
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46826\fP: (\fI\%robgott\fP) grain modules using tuples affect targeting (refs: \fI\%#46839\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46839\fP: (\fI\%gtmanfred\fP) match tuple for targets as well
@ \fI2018\-04\-04 14:07:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
9c776cffb7 Merge pull request \fI\%#46839\fP from gtmanfred/tupletarget
.IP \(bu 2
3b7208ce27 match tuple for targets as well
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40245\fP: (\fI\%czhong111\fP) salt\-api automatically restart caused by \(dqopening too many files\(dq (refs: \fI\%#46817\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#36374\fP: (\fI\%szjur\fP) Descriptor leaks in multithreaded environment (refs: \fI\%#46817\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#20639\fP: (\fI\%GrizzlyV\fP) salt.client.LocalClient leaks connections to local salt master (refs: \fI\%#46817\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46845\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46817\fP to 2017.7
@ \fI2018\-04\-03 19:52:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46817\fP: (\fI\%mattp\-\fP) address filehandle/event leak in async run_job invocations (refs: \fI\%#46845\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32145\fP: (\fI\%paclat\fP) fixes 29817 (refs: \fI\%#46817\fP)
.IP \(bu 2
7db251dc11 Merge pull request \fI\%#46845\fP from rallytime/bp\-46817
.IP \(bu 2
36a0f6d8ca address filehandle/event leak in async run_job invocations
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46847\fP: (\fI\%dwoz\fP) strdup from libc is not available on windows
@ \fI2018\-04\-03 19:51:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
e3d17ab7bc Merge pull request \fI\%#46847\fP from dwoz/missing\-strdup
.IP \(bu 2
55845f4846 strdup from libc is not available on windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46765\fP: (\fI\%roskens\fP) pkg.mod_repo fails with a python error when removing a dictionary key (refs: \fI\%#46776\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46776\fP: (\fI\%gtmanfred\fP) fix shrinking list in for loop bug
@ \fI2018\-04\-03 17:32:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
f2dd79f9c4 Merge pull request \fI\%#46776\fP from gtmanfred/2017.7
.IP \(bu 2
edc1059ee0 fix shrinking list in for loop bug
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46838\fP: (\fI\%gtmanfred\fP) use http registry for npm
@ \fI2018\-04\-03 17:02:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
1941426218 Merge pull request \fI\%#46838\fP from gtmanfred/npm
.IP \(bu 2
bff61dd291 use http registry for npm
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42312\fP: (\fI\%frogunder\fP) salt\-call \-\-local sys.doc none gives error/traceback in raspberry pi (refs: \fI\%#46823\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46823\fP: (\fI\%rallytime\fP) Improve __virtual__ checks in sensehat module
@ \fI2018\-04\-03 16:56:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
e544254e7b Merge pull request \fI\%#46823\fP from rallytime/fix\-42312
.IP \(bu 2
dafa820f93 Improve __virtual__ checks in sensehat module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46641\fP: (\fI\%skizunov\fP) Make LazyLoader thread safe
@ \fI2018\-04\-03 16:09:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
37f6d2de35 Merge pull request \fI\%#46641\fP from skizunov/develop3
.IP \(bu 2
c624aa4827 Make LazyLoader thread safe
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46837\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2016.11 to 2017.7
@ \fI2018\-04\-03 14:54:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
989508b100 Merge pull request \fI\%#46837\fP from rallytime/merge\-2017.7
.IP \(bu 2
8522c1d634 Merge branch \(aq2016.11\(aq into \(aq2017.7\(aq
.IP \(bu 2
3e844ed1df Merge pull request \fI\%#46739\fP from rallytime/2016.11_update_version_doc
.IP \(bu 2
4d9fc5cc0f Update release versions for the 2016.11 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46740\fP: (\fI\%rallytime\fP) Update release versions for the 2017.7 branch
@ \fI2018\-04\-03 14:36:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
307e7f35f9 Merge pull request \fI\%#46740\fP from rallytime/2017.7_update_version_doc
.IP \(bu 2
7edf98d224 Update 2018.3.0 information and move branch from \(dqlatest\(dq to \(dqprevious\(dq
.IP \(bu 2
5336e866ac Update release versions for the 2017.7 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46783\fP: (\fI\%twangboy\fP) Fix network.managed test=True on Windows
@ \fI2018\-04\-03 12:54:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
ebf5dd276f Merge pull request \fI\%#46783\fP from twangboy/fix_46680
.IP \(bu 2
da5ce25ef3 Fix unit tests on Linux
.IP \(bu 2
b7f4f377cd Add space I removed
.IP \(bu 2
f1c68a09b5 Fix network.managed test=True on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46821\fP: (\fI\%rallytime\fP) Fix the new test failures from the mantest changes
@ \fI2018\-04\-03 12:40:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46778\fP: (\fI\%terminalmage\fP) Replace flaky SPM man test (refs: \fI\%#46821\fP)
.IP \(bu 2
f652f25cc1 Merge pull request \fI\%#46821\fP from rallytime/fix\-mantest\-failures
.IP \(bu 2
209a8029c3 Fix the new test failures from the mantest changes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46627\fP: (\fI\%vangourd\fP) Win_LGPO fails on writing Administrative Template for Remote Assistance (refs: \fI\%#46800\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46800\fP: (\fI\%lomeroe\fP) fix win_lgpo to correctly create valuenames of list item types
@ \fI2018\-04\-03 12:38:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
c460f62081 Merge pull request \fI\%#46800\fP from lomeroe/2017_7\-46627
.IP \(bu 2
2bee383e9d correct create list item value names if the valuePrefix attribute does not exist on the list item, the value is the value name, other wise, the valuename a number with the valuePrefix prepended to it
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46347\fP: (\fI\%twangboy\fP) Build 449: unit.modules.test_inspect_collector (refs: \fI\%#46675\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46675\fP: (\fI\%dwoz\fP) Skip test when git symlinks are not configured
@ \fI2018\-04\-03 12:19:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
df26f2641e Merge pull request \fI\%#46675\fP from dwoz/inspectlib\-tests
.IP \(bu 2
d39f4852d8 Handle non\-zero status exception
.IP \(bu 2
83c005802b Handle cases where git can not be found
.IP \(bu 2
628b87d5c4 Skip test when git symlinks are not configured
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46808\fP: (\fI\%ezh\fP) Sharedsecret authentication is broken (refs: \fI\%#46809\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46815\fP: (\fI\%terminalmage\fP) Backport \fI\%#46809\fP to 2017.7
@ \fI2018\-04\-02 20:05:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46809\fP: (\fI\%ezh\fP) Fix sharedsecret authentication (refs: \fI\%#46815\fP)
.IP \(bu 2
4083e7c460 Merge pull request \fI\%#46815\fP from terminalmage/bp\-46809
.IP \(bu 2
71d5601507 Fix sharedsecret authentication
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46769\fP: (\fI\%dwoz\fP) Adding windows minion tests for salt cloud
@ \fI2018\-04\-02 18:51:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
3bac9717f4 Merge pull request \fI\%#46769\fP from dwoz/wincloudtest
.IP \(bu 2
eabc234e5d Fix config override name
.IP \(bu 2
5c22a0f88d Use aboslute imports
.IP \(bu 2
810042710d Set default cloud test timeout back to 500 seconds
.IP \(bu 2
5ac89ad307 Use winrm_verify_ssl option causing tests to pass
.IP \(bu 2
71858a709c allow not verifying ssl winrm saltcloud
.IP \(bu 2
ba5f11476c Adding windows minion tests for salt cloud
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46786\fP: (\fI\%twangboy\fP) Return int(\-1) when pidfile contains invalid data
@ \fI2018\-04\-02 18:42:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
f1be939763 Merge pull request \fI\%#46786\fP from twangboy/fix_46757
.IP \(bu 2
b0053250ff Remove int(), just return \-1
.IP \(bu 2
7d56126d74 Fixes some lint
.IP \(bu 2
49b3e937da Return int(\-1) when pidfile contains invalid data
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46814\fP: (\fI\%terminalmage\fP) Backport \fI\%#46772\fP to 2017.7
@ \fI2018\-04\-02 18:39:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46772\fP: (\fI\%bmiguel\-teixeira\fP) fix container removal if auto_remove was enabled (refs: \fI\%#46814\fP)
.IP \(bu 2
89bf24b15c Merge pull request \fI\%#46814\fP from terminalmage/bp\-46772
.IP \(bu 2
a9f26f2ab8 avoid breaking if AutoRemove is not found
.IP \(bu 2
97779c965d fix container removal if auto_remove was enabled
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46813\fP: (\fI\%terminalmage\fP) Get rid of confusing debug logging
@ \fI2018\-04\-02 18:19:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
5ea4ffbdb6 Merge pull request \fI\%#46813\fP from terminalmage/event\-debug\-log
.IP \(bu 2
5d6de3a2eb Get rid of confusing debug logging
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46766\fP: (\fI\%twangboy\fP) Change the way we\(aqre cleaning up after some tests
@ \fI2018\-03\-30 18:01:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
e533b7182d Merge pull request \fI\%#46766\fP from twangboy/win_fix_test_git
.IP \(bu 2
5afc66452c Remove unused/redundant imports
.IP \(bu 2
88fd72c52c Use with_tempfile decorator where possible
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46778\fP: (\fI\%terminalmage\fP) Replace flaky SPM man test (refs: \fI\%#46821\fP)
@ \fI2018\-03\-30 17:55:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
69d450db84 Merge pull request \fI\%#46778\fP from terminalmage/salt\-jenkins\-906
.IP \(bu 2
bbfd35d3ea Replace flaky SPM man test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46762\fP: (\fI\%ScoreUnder\fP) prereq stack overflow (refs: \fI\%#46788\fP, \fI\%#46799\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46788\fP: (\fI\%garethgreenaway\fP) [2017.7] Ensure failed tags are added to self.pre (refs: \fI\%#46799\fP)
@ \fI2018\-03\-30 17:11:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
c935ffb740 Merge pull request \fI\%#46788\fP from garethgreenaway/46762_prereq_shenanigans
.IP \(bu 2
fa7aed6424 Ensure failed tags are added to self.pre.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46354\fP: (\fI\%twangboy\fP) Build 449: unit.test_state (refs: \fI\%#46655\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#46350\fP: (\fI\%twangboy\fP) Build 449: unit.test_pyobjects.RendererTests (refs: \fI\%#46655\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#46349\fP: (\fI\%twangboy\fP) Build 449: unit.test_pydsl (refs: \fI\%#46655\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#46345\fP: (\fI\%twangboy\fP) Build 449: unit.test_pyobjects.MapTests (Manual Pass) (refs: \fI\%#46655\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46655\fP: (\fI\%dwoz\fP) Fixing cleanUp method to restore environment
@ \fI2018\-03\-29 18:31:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
395b7f8fdc Merge pull request \fI\%#46655\fP from dwoz/pyobjects\-46350
.IP \(bu 2
5aabd442f2 Fix up import and docstring syntax
.IP \(bu 2
62d64c9230 Fix missing import
.IP \(bu 2
18b1730320 Skip test that requires pywin32 on *nix platforms
.IP \(bu 2
45dce1a485 Add reg module to globals
.IP \(bu 2
09f9322981 Fix pep8 wart
.IP \(bu 2
73d06f664b Fix linter error
.IP \(bu 2
009a8f56ea Fix up environ state tests for Windows
.IP \(bu 2
b4be10b8fc Fixing cleanUp method to restore environment
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36802\fP: (\fI\%rmarcinik\fP) using clean=True parameter in file.recurse causes python process to spin out of control (refs: \fI\%#46632\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46632\fP: (\fI\%dwoz\fP) Fix file.recurse w/ clean=True \fI\%#36802\fP
@ \fI2018\-03\-29 18:30:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
af45c49c42 Merge pull request \fI\%#46632\fP from dwoz/file\-recurse\-36802
.IP \(bu 2
44db77ae79 Fix lint errors and typo
.IP \(bu 2
cb5619537f Only change what is essential for test fix
.IP \(bu 2
eb822f5a12 Fix file.recurse w/ clean=True \fI\%#36802\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46660\fP: (\fI\%mruepp\fP) top file merging same does produce conflicting ids with gitfs (refs: \fI\%#46751\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46751\fP: (\fI\%folti\fP) top file merging strategy \(aqsame\(aq works again
@ \fI2018\-03\-28 21:12:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
6e9f504ed1 Merge pull request \fI\%#46751\fP from folti/2017.7
.IP \(bu 2
7058f10381 same top merging strategy works again
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46691\fP: (\fI\%Ch3LL\fP) Add groupadd module integration tests for Windows
@ \fI2018\-03\-28 18:01:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
d3623e0815 Merge pull request \fI\%#46691\fP from Ch3LL/win_group_test
.IP \(bu 2
7cda825e90 Add groupadd module integration tests for Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46352\fP: (\fI\%twangboy\fP) Build 449: unit.test_client (refs: \fI\%#46696\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46696\fP: (\fI\%dwoz\fP) Windows \fIunit.test_client\fP fixes
@ \fI2018\-03\-28 17:55:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
14ab50d3f4 Merge pull request \fI\%#46696\fP from dwoz/win_test_client
.IP \(bu 2
ec4634fc06 Better explanation in doc strings
.IP \(bu 2
d9ae2abb34 Fix splling in docstring
.IP \(bu 2
b40efc5db8 Windows test client fixes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45956\fP: (\fI\%frogunder\fP) CTRL\-C gives traceback on py3 setup (refs: \fI\%#46032\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46732\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46032\fP to 2017.7
@ \fI2018\-03\-28 13:43:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46032\fP: (\fI\%DmitryKuzmenko\fP) Workaround python bug in traceback.format_exc() (refs: \fI\%#46732\fP)
.IP \(bu 2
1222bdbc00 Merge pull request \fI\%#46732\fP from rallytime/bp\-46032
.IP \(bu 2
bf0b962dc0 Workaround python bug in traceback.format_exc()
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28142\fP: (\fI\%zmalone\fP) Deprecate or update the copr repo (refs: \fI\%#46749\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46749\fP: (\fI\%vutny\fP) [DOC] Remove mentions of COPR repo from RHEL installation page
@ \fI2018\-03\-28 13:20:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
50fe1e9480 Merge pull request \fI\%#46749\fP from vutny/doc\-deprecate\-copr
.IP \(bu 2
a1cc55da3d [DOC] Remove mentions of COPR repo from RHEL installation page
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46734\fP: (\fI\%terminalmage\fP) Make busybox image builder work with newer busybox releases
@ \fI2018\-03\-27 21:14:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd1e8bcc7d Merge pull request \fI\%#46734\fP from terminalmage/busybox
.IP \(bu 2
6502b6b4ff Make busybox image builder work with newer busybox releases
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#902\fP: (\fI\%rallytime\fP) [2017.7/.5] Test failures for NPM on CentOS 6/7, Ubuntu 14, and OpenSUSE (refs: \fI\%#46742\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46742\fP: (\fI\%gtmanfred\fP) only use npm test work around on newer versions
@ \fI2018\-03\-27 21:13:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
c09c6f819c Merge pull request \fI\%#46742\fP from gtmanfred/2017.7
.IP \(bu 2
fd0e649d1e only use npm test work around on newer versions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46743\fP: (\fI\%Ch3LL\fP) Workaround getpwnam in auth test for MacOSX
@ \fI2018\-03\-27 21:10:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
3b6d5eca88 Merge pull request \fI\%#46743\fP from Ch3LL/mac_auth
.IP \(bu 2
4f1c42c0e3 Workaround getpwnam in auth test for MacOSX
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26920\fP: (\fI\%david\-fairbanks42\fP) MySQL grant with underscore and wildcard (refs: \fI\%#46171\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46171\fP: (\fI\%amaclean199\fP) Fix mysql grant comparisons
@ \fI2018\-03\-27 17:54:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
b548a3e742 Merge pull request \fI\%#46171\fP from amaclean199/fix_mysql_grants_comparison
.IP \(bu 2
97db3d9766 Merge branch \(aq2017.7\(aq into fix_mysql_grants_comparison
.IP \(bu 2
0565b3980e Merge branch \(aq2017.7\(aq into fix_mysql_grants_comparison
.IP \(bu 2
8af407173d Merge branch \(aq2017.7\(aq into fix_mysql_grants_comparison
.IP \(bu 2
00d13f05c4 Fix mysql grant comparisons by stripping both of escape characters and quotes. Fixes \fI\%#26920\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#5721\fP: (\fI\%ozgurakan\fP) salt\-minion can\(aqt restart itself (refs: \fI\%#46709\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46709\fP: (\fI\%vutny\fP) [DOC] Update FAQ about Salt self\-restarting
@ \fI2018\-03\-27 14:34:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
554400e067 Merge pull request \fI\%#46709\fP from vutny/doc\-faq\-minion\-master\-restart
.IP \(bu 2
d0929280fc [DOC] Update FAQ about Salt self\-restarting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46503\fP: (\fI\%psyer\fP) Fixes stdout user environment corruption
@ \fI2018\-03\-27 14:20:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
3f21e9cc65 Merge pull request \fI\%#46503\fP from psyer/fix\-cmd\-run\-env\-corrupt
.IP \(bu 2
e8582e80f2 Python 3\-compatibility fix to unit test
.IP \(bu 2
27f651906d Merge pull request #1 from terminalmage/fix\-cmd\-run\-env\-corrupt
.INDENT 2.0
.IP \(bu 2
172d3b2e04 Allow cases where no marker was found to proceed without raising exception
.IP \(bu 2
35ad828ab8 Simplify the marker parsing logic
.UNINDENT
.IP \(bu 2
a09f20ab45 fix repr for the linter
.IP \(bu 2
4ee723ac0f Rework how errors are output
.IP \(bu 2
dc283940e0 Merge branch \(aq2017.7\(aq into fix\-cmd\-run\-env\-corrupt
.IP \(bu 2
a91926561f Fix linting problems
.IP \(bu 2
e8d3d017f9 fix bytes or str in find command
.IP \(bu 2
0877cfc38f Merge branch \(aq2017.7\(aq into fix\-cmd\-run\-env\-corrupt
.IP \(bu 2
86176d1252 Merge branch \(aq2017.7\(aq into fix\-cmd\-run\-env\-corrupt
.IP \(bu 2
3a7cc44ade Add python3 support for byte encoded markers
.IP \(bu 2
09048139c7 Do not show whole env in error
.IP \(bu 2
ed94700255 fix missing raise statement
.IP \(bu 2
15868bc88c Fixes stdout user environment corruption
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46432\fP: (\fI\%twangboy\fP) Default to UTF\-8 for templated files
@ \fI2018\-03\-26 19:02:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
ac2a6616a7 Merge pull request \fI\%#46432\fP from twangboy/win_locales_utf8
.IP \(bu 2
affa35c30d Revert passing encoding
.IP \(bu 2
a0ab27ef15 Merge remote\-tracking branch \(aqdw/win_locales_utf8\(aq into win_locales_utf8
.INDENT 2.0
.IP \(bu 2
9f95c50061 Use default SLS encoding, fall back to system encoding
.IP \(bu 2
6548d550d0 Use salt.utils.to_unicode
.IP \(bu 2
8c0164fb63 Add ability to specify encoding in sdecode
.IP \(bu 2
2e7985a81c Default to utf\-8 on Windows
.UNINDENT
.IP \(bu 2
8017860dcc Use salt.utils.to_unicode
.IP \(bu 2
c10ed26eab Add ability to specify encoding in sdecode
.IP \(bu 2
8d7e2d0058 Default to utf\-8 on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46669\fP: (\fI\%terminalmage\fP) Add option to return to pre\-2017.7.3 pillar include merge order
@ \fI2018\-03\-26 19:00:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
fadc5e4ba4 Merge pull request \fI\%#46669\fP from terminalmage/pillar\-merge\-order
.IP \(bu 2
b4a1d34b47 Add option to return to pre\-2017.7.3 pillar include merge order
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46711\fP: (\fI\%terminalmage\fP) Add performance reminder for wildcard versions
@ \fI2018\-03\-26 18:07:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
b90f0d1364 Merge pull request \fI\%#46711\fP from terminalmage/wildcard\-versions\-info
.IP \(bu 2
fc7d16f1af Add performance reminder for wildcard versions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46353\fP: (\fI\%twangboy\fP) Build 449: unit.returners.test_smtp_return (refs: \fI\%#46693\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46693\fP: (\fI\%dwoz\fP) File and Pillar roots are dictionaries
@ \fI2018\-03\-26 15:15:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c80d90bb6 Merge pull request \fI\%#46693\fP from dwoz/test_smtp_return
.IP \(bu 2
5bf850c67f File and Pillar roots are dictionaries
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36153\fP: (\fI\%krcroft\fP) Pillarenv doesn\(aqt allow using separate pillar environments (refs: \fI\%#46543\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46543\fP: (\fI\%dafenko\fP) Fix missing saltenv and pillarenv in pillar.item
@ \fI2018\-03\-26 15:05:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
9a6bc1418c Merge pull request \fI\%#46543\fP from dafenko/fix\-add\-saltenv\-pillarenv\-to\-pillar\-item
.IP \(bu 2
6d5b2068aa Merge branch \(aq2017.7\(aq into fix\-add\-saltenv\-pillarenv\-to\-pillar\-item
.IP \(bu 2
5219377313 Merge branch \(aq2017.7\(aq into fix\-add\-saltenv\-pillarenv\-to\-pillar\-item
.IP \(bu 2
b7d39caa86 Merge branch \(aq2017.7\(aq into fix\-add\-saltenv\-pillarenv\-to\-pillar\-item
.IP \(bu 2
25f1074a85 Add docstring for added parameters
.IP \(bu 2
973bc13955 Merge branch \(aq2017.7\(aq into fix\-add\-saltenv\-pillarenv\-to\-pillar\-item
.IP \(bu 2
164314a859 Merge branch \(aq2017.7\(aq into fix\-add\-saltenv\-pillarenv\-to\-pillar\-item
.IP \(bu 2
267ae9f633 Fix missing saltenv and pillarenv in pillar.item
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46679\fP: (\fI\%vutny\fP) [DOC] Correct examples in \fIpkg\fP state module
@ \fI2018\-03\-26 14:40:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
f776040e25 Merge pull request \fI\%#46679\fP from vutny/doc\-state\-pkg
.IP \(bu 2
4a730383bf [DOC] Correct examples in \fIpkg\fP state module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46646\fP: (\fI\%twangboy\fP) Fix \fIunit.returners.test_local_cache\fP for Windows
@ \fI2018\-03\-26 14:16:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
47409eaa6e Merge pull request \fI\%#46646\fP from twangboy/win_fix_test_local_cache
.IP \(bu 2
8d93156604 Fix \fIunit.returners.test_local_cache\fP for Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46595\fP: (\fI\%aboe76\fP) saltstack server_id changes with each run on python3 (refs: \fI\%#46649\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46649\fP: (\fI\%terminalmage\fP) Make server_id consistent on Python 3
@ \fI2018\-03\-26 13:58:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
0c2dce0416 Merge pull request \fI\%#46649\fP from terminalmage/issue46595
.IP \(bu 2
e82a1aa1ec Make server_id consistent on Python 3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46588\fP: (\fI\%UtahDave\fP) Don\(aqt crash when saltwinshell is missing
@ \fI2018\-03\-21 20:26:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
4e7466a21c Merge pull request \fI\%#46588\fP from UtahDave/no_crash_winshell
.IP \(bu 2
b7842a1777 Update error message.
.IP \(bu 2
95dfdb91ca Don\(aqt stacktrace when salt\-ssh w/o saltwinshell
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22063\fP: (\fI\%jeanpralo\fP) Wildcard inside top.sls file for pillar (refs: \fI\%#41423\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#20581\fP: (\fI\%notpeter\fP) Many environments: one pillar_root (all your envs are belong to base) (refs: \fI\%#46309\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46631\fP: (\fI\%rallytime\fP) Fix pillar unit test failures: file_roots and pillar_roots environments should be lists
@ \fI2018\-03\-21 19:22:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46629\fP: (\fI\%terminalmage\fP) Fix symlink loop when file_roots/pillar_roots is a string instead of a list (refs: \fI\%#46631\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46569\fP: (\fI\%rallytime\fP) [2018.3] Merge forward from 2017.7 to 2018.3 (refs: \fI\%#46631\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46309\fP: (\fI\%bdrung\fP) Support dynamic pillar_root environment (refs: \fI\%#46631\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41423\fP: (\fI\%RichardW42\fP) pillar: target\(aqs state list support wildcard in top.sls (refs: \fI\%#46631\fP)
.IP \(bu 2
33af3cfc7c Merge pull request \fI\%#46631\fP from rallytime/update\-pillar\-unit\-tests
.IP \(bu 2
0f728186aa Fix pillar unit test failures: file_roots and pillar_roots environments should be lists
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26450\fP: (\fI\%typeshige\fP) file.copy: source file is not present. (refs: \fI\%#46640\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46640\fP: (\fI\%terminalmage\fP) Clarify the docs for the file.copy state
@ \fI2018\-03\-21 19:14:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
d329e7af78 Merge pull request \fI\%#46640\fP from terminalmage/file.copy\-docs
.IP \(bu 2
480c5f8faa Clarify the docs for the file.copy state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46642\fP: (\fI\%vutny\fP) [DOC] Unify cloud modules index header
@ \fI2018\-03\-21 19:13:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
ff40590c06 Merge pull request \fI\%#46642\fP from vutny/doc\-cloud\-index
.IP \(bu 2
51e6aa54a1 [DOC] Unify cloud modules index header
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46619\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.5 to 2017.7
@ \fI2018\-03\-20 19:03:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
83ed40c06a Merge pull request \fI\%#46619\fP from rallytime/merge\-2017.7
.IP \(bu 2
bcbddf5d07 Merge branch \(aq2017.7.5\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46584\fP: (\fI\%twangboy\fP) Fix issue LGPO issue
@ \fI2018\-03\-20 17:48:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
df12135439 Merge pull request \fI\%#46584\fP from twangboy/lgpo\-46568
.IP \(bu 2
661017104b Detect disabled reg_multi_sz elements properly
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46624\fP: (\fI\%twangboy\fP) Fix a few inconsitencies in the installer script
@ \fI2018\-03\-20 17:47:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
2fd3aa487c Merge pull request \fI\%#46624\fP from twangboy/win_fix_installer
.IP \(bu 2
fa0b0efe46 Fix some installer script inconsistencies
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46552\fP: (\fI\%JeffLee123\fP) State with require requisite executes despite onfail requisite on another state.   (refs: \fI\%#46571\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46571\fP: (\fI\%garethgreenaway\fP) [2017.7] fixes to state.py
@ \fI2018\-03\-20 13:40:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
f038e3c452 Merge pull request \fI\%#46571\fP from garethgreenaway/46552_onfail_and_require
.IP \(bu 2
152c43c843 Accounting for a case when multiple onfails are used along with requires.  Previously if you have multiple states using \(aqonfail\(aq and two of those states using a \(aqrequire\(aq against the first one state, the last two will run even if the \(aqonfail\(aq isn\(aqt met because the \(aqrequire\(aq is met because the first state returns true even though it didn\(aqt execute.  This change adds an additional hidden variable that is used when checking requisities to determine if the state actually ran.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46512\fP: (\fI\%blarghmatey\fP) git.pull failing when run from the salt scheduler (refs: \fI\%#46520\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46520\fP: (\fI\%gtmanfred\fP) pass utils to the scheduler for reloading in modules
@ \fI2018\-03\-20 13:35:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
2677330e19 Merge pull request \fI\%#46520\fP from gtmanfred/2017.7
.IP \(bu 2
caefedc095 make sure utils is empty for pickling for windows
.IP \(bu 2
2883548e6b pass utils to the scheduler for reloading in modules
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44299\fP: (\fI\%nhavens\fP) 2017.7.2 breaks pkgrepo.managed yum repo comments (refs: \fI\%#46531\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46531\fP: (\fI\%terminalmage\fP) Fix regression in yumpkg._parse_repo_file()
@ \fI2018\-03\-20 13:34:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
7bc3c2e588 Merge pull request \fI\%#46531\fP from terminalmage/issue44299
.IP \(bu 2
b70c3389da Fix case where no comments specified
.IP \(bu 2
ce391c53f4 Add regression test for \fI\%#44299\fP
.IP \(bu 2
c3e36a6c94 Fix regression in yumpkg._parse_repo_file()
.IP \(bu 2
f0c79e3da3 Slight modification to salt.utils.pkg.rpm.combine_comments()
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46521\fP: (\fI\%dwoz\fP) \fI\-\-name\fP argument not honored for cloud test suite (refs: \fI\%#46567\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46567\fP: (\fI\%dwoz\fP) Honor named tests when running integration suites
@ \fI2018\-03\-20 13:24:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
b80edb5d26 Merge pull request \fI\%#46567\fP from dwoz/runtest\-n\-wart
.IP \(bu 2
3b6901e19d Honor named tests when running integration suites
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46580\fP: (\fI\%twangboy\fP) Clarify some issues with msu files in win_dism.py
@ \fI2018\-03\-16 18:57:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
1dcd22e767 Merge pull request \fI\%#46580\fP from twangboy/win_update_docs_dism
.IP \(bu 2
d52b99d7a3 Clarify some issues with msu files in win_dism.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46073\fP: (\fI\%layer3switch\fP) salt 2017.7.3 grains metadata collection in AWS EC2 cause failure and nested iteration (refs: \fI\%#46541\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46541\fP: (\fI\%gtmanfred\fP) handle user\-data for metadata grains
@ \fI2018\-03\-15 17:21:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a68c22332 Merge pull request \fI\%#46541\fP from gtmanfred/metadata
.IP \(bu 2
19bd1d9db5 handle user\-data for metadata grains
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46427\fP: (\fI\%wasabi222\fP) cumulus linux should use systemd as a default service pkg instead of debian_service (refs: \fI\%#46547\fP)
.IP \(bu 2
\fBPR\fP \fI\%#46547\fP: (\fI\%garethgreenaway\fP) [2017.7] Disable service module for Cumulus
@ \fI2018\-03\-15 16:15:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
048b2ba3f6 Merge pull request \fI\%#46547\fP from garethgreenaway/46427_service_module_cumulus
.IP \(bu 2
edd0b11447 Merge branch \(aq2017.7\(aq into 46427_service_module_cumulus
.IP \(bu 2
ea3c16080e Disable the \fIservice\fP module on Cumulus since it is using systemd.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46548\fP: (\fI\%Ch3LL\fP) profitbrick test: check for foo,bar username,password set in profitbrick config
@ \fI2018\-03\-15 14:25:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
98e3260b9a Merge pull request \fI\%#46548\fP from Ch3LL/profit_test
.IP \(bu 2
db96c4e72e check for foo,bar username,password set in profitbrick config
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46549\fP: (\fI\%Ch3LL\fP) Fix dimensionsdata test random_name call
@ \fI2018\-03\-15 14:23:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
79f2a76609 Merge pull request \fI\%#46549\fP from Ch3LL/dimension_test
.IP \(bu 2
bb338c464c Fix dimensionsdata test random_name call
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46529\fP: (\fI\%gtmanfred\fP) retry if there is a segfault
@ \fI2018\-03\-13 22:41:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
083846fe0e Merge pull request \fI\%#46529\fP from gtmanfred/kitchen
.IP \(bu 2
50d6e2c7be retry if there is a segfault
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#46511\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45769\fP to 2017.7
@ \fI2018\-03\-13 17:08:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45769\fP: (\fI\%Quarky9\fP) Suppress boto WARNING during SQS msg decode in sqs_engine (refs: \fI\%#46511\fP)
.IP \(bu 2
5cc11129f1 Merge pull request \fI\%#46511\fP from rallytime/bp\-45769
.IP \(bu 2
a8ffceda53 Suppress boto WARNING during decode, reference: \fI\%https://github.com/boto/boto/issues/2965\fP
.UNINDENT
.UNINDENT
.SS Salt 2017.7.7 Release Notes
.sp
Version 2017.7.7 is a bugfix release for \fI\%2017.7.0\fP\&.
.sp
The \fB2017.7.7\fP release contains only a small number of fixes, which are detailed
below.
.sp
This release fixes two critical issues.
.sp
The first is Issue \fI\%#48038\fP, which is a critical bug that occurs in a multi\-syndic
setup where the same job is run multiple times on a minion.
.sp
The second issue is \fI\%#48130\fP\&. This bug appears in certain setups where the Master
reports a Minion time\-out, even though the job is still running on the Minion.
.sp
Both of these issues have been fixed with this release.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB5\fP
.IP \(bu 2
Total Issue References: \fB2\fP
.IP \(bu 2
Total PR References: \fB6\fP
.IP \(bu 2
Contributors: \fB3\fP (\fI\%garethgreenaway\fP, \fI\%gtmanfred\fP, \fI\%rallytime\fP)
.UNINDENT
.SS Changelog for v2017.7.6..v2017.7.7
.sp
\fIGenerated at: 2018\-06\-17 19:26:52 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBISSUE\fP \fI\%#48130\fP: (\fI\%rmarchei\fP) Minion timeouts with 2018.3.1 (refs: \fI\%#48157\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48157\fP: (\fI\%gtmanfred\fP) always listen when gathering job info
@ \fI2018\-06\-17 19:04:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
8af4452134 Merge pull request \fI\%#48157\fP from gtmanfred/2017.7.7
.IP \(bu 2
d8209e8a40 always listen when gathering job info
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48140\fP: (\fI\%rallytime\fP) Update man pages for 2017.7.7
@ \fI2018\-06\-14 21:22:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
b98c52ee51 Merge pull request \fI\%#48140\fP from rallytime/man\-pages\-2017.7.7
.IP \(bu 2
8893bf0d4c Update man pages for 2017.7.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48136\fP: (\fI\%gtmanfred\fP) [2017.7.7] bootstrap kitchen branch tests with 2017.7.6
@ \fI2018\-06\-14 21:20:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
baa0363336 Merge pull request \fI\%#48136\fP from gtmanfred/2017.7.7
.IP \(bu 2
fce1c31146 bootstrap kitchen branch tests with 2017.7.6
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48134\fP: (\fI\%rallytime\fP) Add release notes file for 2017.7.7
@ \fI2018\-06\-14 16:31:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
b0ba08f4d9 Merge pull request \fI\%#48134\fP from rallytime/release\-notes\-2017.7.7
.IP \(bu 2
217005b8f1 Add missing \fIv\fP for tag reference
.IP \(bu 2
d53569d1e3 Add release notes file for 2017.7.7
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48038\fP: (\fI\%austinpapp\fP) jobs are not dedup\(aqing minion side (refs: \fI\%#48075\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48098\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48075\fP to 2017.7.7
@ \fI2018\-06\-14 12:53:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48075\fP: (\fI\%garethgreenaway\fP) [2017.7] Ensure that the shared list of jids is passed (refs: \fI\%#48098\fP)
.IP \(bu 2
084de927fe Merge pull request \fI\%#48098\fP from rallytime/bp\-48075\-2017.7.7
.IP \(bu 2
e4e62e8b3a Ensure that the shared list of jids is passed when creating the Minion.  Fixes an issue when minions are pointed at multiple syndics.
.UNINDENT
.UNINDENT
.SS Salt 2017.7.8 Release Notes
.sp
Version 2017.7.8 is a security and bugfix release for \fI\%2017.7.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB237\fP
.IP \(bu 2
Total Issue References: \fB48\fP
.IP \(bu 2
Total PR References: \fB279\fP
.IP \(bu 2
Contributors: \fB52\fP (\fI\%AVeenstra\fP, \fI\%Ch3LL\fP, \fI\%Circuitsoft\fP, \fI\%DmitryKuzmenko\fP, \fI\%KaiSforza\fP,
\fI\%Martin819\fP, \fI\%OrlandoArcapix\fP, \fI\%UtahDave\fP, \fI\%Vaelatern\fP, \fI\%abednarik\fP, \fI\%asnell\fP,
\fI\%b1naryth1ef\fP, \fI\%baniobloom\fP, \fI\%basepi\fP, \fI\%bdrung\fP, \fI\%beornf\fP, \fI\%bmcorser\fP, \fI\%bowmanjd\-lms\fP,
\fI\%damon\-atkins\fP, \fI\%darkpixel\fP, \fI\%discogestalt\fP, \fI\%doesitblend\fP, \fI\%dqminh\fP, \fI\%dubb\-b\fP, \fI\%dwoz\fP,
\fI\%frankiexyz\fP, \fI\%frogunder\fP, \fI\%fzipi\fP, \fI\%garethgreenaway\fP, \fI\%grokrecursion\fP, \fI\%gtmanfred\fP,
\fI\%jacksontj\fP, \fI\%jagguli\fP, \fI\%lejambon\fP, \fI\%lomeroe\fP, \fI\%lordcirth\fP, \fI\%lusche\fP, \fI\%mbunkus\fP,
\fI\%meaksh\fP, \fI\%mirceaulinic\fP, \fI\%nbraud\fP, \fI\%pritambaral\fP, \fI\%ralex\fP, \fI\%rallytime\fP, \fI\%rmcintosh\fP,
\fI\%slaws\fP, \fI\%terminalmage\fP, \fI\%twangboy\fP, \fI\%twellspring\fP, \fI\%wyardley\fP, \fI\%xetix\fP, \fI\%zer0def\fP)
.UNINDENT
.SS Security Fix
.sp
CVE\-2018\-15751 Remote command execution and incorrect access control when using salt\-api.
.sp
CVE\-2018\-15750 Directory traversal vulnerability when using salt\-api. Allows an attacker to determine what files exist on a server when querying /run or /events.
.sp
Credit and thanks for discovery and responsible disclosure: nullbr4in, xcuter, koredge, loupos, blackcon, Naver Business Platform
.SS New win_snmp behavior
.INDENT 0.0
.IP \(bu 2
\fI\%win_snmp.get_community_names\fP now returns the SNMP settings
actually in effect on the box. If settings are managed via GroupPolicy, those
settings will be returned. Otherwise, normal settings are returned.
.IP \(bu 2
\fI\%win_snmp.set_community_names\fP now raises an error when SNMP
settings are being managed by GroupPolicy.
.UNINDENT
.SS Option Added to Disable Docker Mine Updates
.sp
When a docker container is added, removed, started, stopped, etc., the results
of a \fBdocker.ps verbose=True all=True host=True\fP are sent to the \fI\%mine\fP, to be
used by \fI\%mine.get_docker\fP\&.
.sp
A new config option (\fI\%docker.update_mine\fP) has been added.  When
set to \fBFalse\fP, Salt will not send this information to the mine. This is
useful in cases where sensitive information is stored in the container\(aqs
environment.
.SS Changelog for v2017.7.7..v2017.7.8
.sp
\fIGenerated at: 2018\-09\-04 21:09:41 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#49498\fP: (\fI\%rallytime\fP) Pin CherryPy version to < 18.0.0 in requirements files for PY2
@ \fI2018\-09\-04 17:55:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d7b173b24 Merge pull request \fI\%#49498\fP from rallytime/pin\-cherrypy\-2017.7.8
.IP \(bu 2
81a6155b6b Pin CherryPy version to < 18.0.0 in requirements files for PY2
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47087\fP: (\fI\%darkpixel\fP) How do I stop the prompt \(dqPermission denied for host <hostname>, do you want to deploy the salt\-ssh key? (password required):\(dq? (refs: \fI\%#47100\fP, #\(gasaltstack/salt\(ga#47100\(ga_\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#47100\fP: (\fI\%gtmanfred\fP) Allow for not being prompted to supply a password to deploy keys to a… (refs: \fI\%#49461\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49466\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49461\fP to 2017.7.8
@ \fI2018\-08\-31 15:44:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49461\fP: (\fI\%gtmanfred\fP) Revert \(dqAllow for not being prompted to supply a password to deploy keys to a…\(dq (refs: \fI\%#49466\fP)
.IP \(bu 2
52ab2c0574 Merge pull request \fI\%#49466\fP from rallytime/bp\-49461
.IP \(bu 2
58428003b1 Revert \(dqAllow for not being prompted to supply a password to deploy keys to a…\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49284\fP: (\fI\%twangboy\fP) Fix path to libsodium tarball
@ \fI2018\-08\-23 17:19:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
1bbe7df6c4 Merge pull request \fI\%#49284\fP from twangboy/fix_installer_osx
.IP \(bu 2
a112eaa597 Fix path to libsodium tarball
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49272\fP: (\fI\%twangboy\fP) Add 64 bit binaries for KB2999226 to the x86 installer
@ \fI2018\-08\-23 14:27:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
e0e8779985 Merge pull request \fI\%#49272\fP from twangboy/fix_installer_more
.IP \(bu 2
a8f054b2d2 Add 64bit binaries for KB2999226 to the x86 installer
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49218\fP: (\fI\%twangboy\fP) Fix Windows and OSX installers
@ \fI2018\-08\-21 01:10:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
0eb6ddf0e8 Merge pull request \fI\%#49218\fP from twangboy/fix_installer
.IP \(bu 2
e8a1d2f772 Add more descriptive error when KB not found
.IP \(bu 2
71737ea687 Suppress all ui on vcredist installation
.IP \(bu 2
7dae9bb2a1 Fix Windows and OSX installers
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49116\fP: (\fI\%twangboy\fP) Fix windows installer script
@ \fI2018\-08\-14 17:09:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
e484f261ee Merge pull request \fI\%#49116\fP from twangboy/fix_installer
.IP \(bu 2
1227095c5d Add nonfatal switch to VCRedist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49113\fP: (\fI\%Ch3LL\fP) Add changelog to 2017.7.8 release notes
@ \fI2018\-08\-14 15:03:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
0b9f2f8884 Merge pull request \fI\%#49113\fP from Ch3LL/rn_7.8
.IP \(bu 2
f6b70bb653 Add changelog to 2017.7.8 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49051\fP: (\fI\%rallytime\fP) Back\-port \fI\%#49046\fP to 2017.7.8
@ \fI2018\-08\-10 17:19:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49046\fP: (\fI\%garethgreenaway\fP) [2017.7] Another fix to tests/integration/modules/test_service.py (refs: \fI\%#49051\fP)
.IP \(bu 2
01cf2c71ff Merge pull request \fI\%#49051\fP from rallytime/bp\-49046
.IP \(bu 2
fc0817cb35 The osfullname grain differs when using Python2 vs Python3, swapping this out for the \(dqOS\(dq grain which is consistent.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49044\fP: (\fI\%Ch3LL\fP) increase timeout on vultr cloud integration test
@ \fI2018\-08\-10 01:28:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
189e28691f Merge pull request \fI\%#49044\fP from Ch3LL/vultr_test
.IP \(bu 2
0dedfae4d1 increase timeout on vultr cloud integration test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49042\fP: (\fI\%rallytime\fP) Mark a jinja template test as flaky
@ \fI2018\-08\-09 21:05:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
c606a32cf2 Merge pull request \fI\%#49042\fP from rallytime/flaky\-jinja\-test
.IP \(bu 2
a43d9b4ba6 Mark a jinja template test as flaky
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49041\fP: (\fI\%Ch3LL\fP) [2017.7.8] backport PR \fI\%#48212\fP
@ \fI2018\-08\-09 21:05:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48212\fP: (\fI\%Ch3LL\fP) Fix python3 ec2 salt\-cloud TypeError when installing salt (refs: \fI\%#49041\fP)
.IP \(bu 2
6415b6f73b Merge pull request \fI\%#49041\fP from Ch3LL/ec2_fix
.IP \(bu 2
cf7f2459b8 [2017.7.8] backport PR \fI\%#48212\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49030\fP: (\fI\%rallytime\fP) Update netapi client tests
@ \fI2018\-08\-09 17:11:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
1db036406b Merge pull request \fI\%#49030\fP from rallytime/update\-client\-tests
.IP \(bu 2
f08ee6c6ae Update netapi client tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49024\fP: (\fI\%rallytime\fP) Fix test error in test_compiler jinja check
@ \fI2018\-08\-09 12:43:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#49002\fP: (\fI\%rallytime\fP) Skip test_jinja_deep_error on Debian 8 (refs: \fI\%#49024\fP)
.IP \(bu 2
f73ba21bc7 Merge pull request \fI\%#49024\fP from rallytime/fix\-deb\-test
.IP \(bu 2
a9c16d9137 Fix test error in test_compiler jinja check
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49020\fP: (\fI\%rallytime\fP) Make grains integration test more robust
@ \fI2018\-08\-08 20:59:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b6d68c615 Merge pull request \fI\%#49020\fP from rallytime/fix\-grains\-test
.IP \(bu 2
f72a3ac6be Make grains integration test more robust
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#49002\fP: (\fI\%rallytime\fP) Skip test_jinja_deep_error on Debian 8 (refs: \fI\%#49024\fP)
@ \fI2018\-08\-08 19:18:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
92d6c25c7f Merge pull request \fI\%#49002\fP from rallytime/skip\-jinja\-deep\-error\-test
.IP \(bu 2
23b66ef8bb Skip test_jinja_deep_error on Debian 8
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48999\fP: (\fI\%rallytime\fP) Update expected return value in boto test
@ \fI2018\-08\-08 14:42:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
41d9f11eb3 Merge pull request \fI\%#48999\fP from rallytime/fix\-boto\-test
.IP \(bu 2
d0136b1be5 Update expected return value in boto test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48976\fP: (\fI\%rallytime\fP) Skip unreliable tornado tests
@ \fI2018\-08\-07 18:55:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
a1e54634dc Merge pull request \fI\%#48976\fP from rallytime/tornado
.IP \(bu 2
0bd838ab6c Skip unreliable tornado tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48979\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48959\fP to 2017.7.8
@ \fI2018\-08\-07 18:11:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48959\fP: (\fI\%rallytime\fP) Mark some more tests as flaky (refs: \fI\%#48979\fP)
.IP \(bu 2
22713be9c1 Merge pull request \fI\%#48979\fP from rallytime/bp\-48959
.IP \(bu 2
aaf986d728 Mark one grains test as flaky & convert to pytest notation
.IP \(bu 2
e7e5abcf48 Mark 2 matcher tests as flaky
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48970\fP: (\fI\%Ch3LL\fP) [2017.7.8] Backport \fI\%#48962\fP
@ \fI2018\-08\-07 15:01:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48962\fP: (\fI\%garethgreenaway\fP) [2017.7] Fixing tests/integration/modules/test_service.py (refs: \fI\%#48970\fP)
.IP \(bu 2
03aa0e49b0 Merge pull request \fI\%#48970\fP from Ch3LL/back_48962
.IP \(bu 2
3ce1b8a3c9 Update the elif block to only be true for versions below Debian 9.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48968\fP: (\fI\%rallytime\fP) Update man pages for 2017.7.8 release
@ \fI2018\-08\-07 14:29:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
e6cea5e3c7 Merge pull request \fI\%#48968\fP from rallytime/man\-pages
.IP \(bu 2
64fe3be41a Update man pages for 2017.7.8 release
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48950\fP: (\fI\%KaiSforza\fP) Added a quote to kitchen Jenkinsfiles
@ \fI2018\-08\-06 14:29:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
848d583438 Merge pull request \fI\%#48950\fP from KaiSforza/kitchenfix\-2017.7
.IP \(bu 2
5242cb143a Added a quote to kitchen Jenkinsfiles
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48943\fP: (\fI\%rallytime\fP) Mark some shell and runner integration tests as flaky
@ \fI2018\-08\-06 13:08:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
928d688d65 Merge pull request \fI\%#48943\fP from rallytime/flaky\-tests
.IP \(bu 2
668da57ab9 Mark some shell and runner integration tests as flaky
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48940\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48852\fP to 2017.7
@ \fI2018\-08\-05 21:32:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48852\fP: (\fI\%KaiSforza\fP) Record all the artifacts from the build (refs: \fI\%#48940\fP)
.IP \(bu 2
cd42510d3a Merge pull request \fI\%#48940\fP from rallytime/bp\-48852
.IP \(bu 2
fa4ef92e79 Record all the artifacts from the build
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48935\fP: (\fI\%garethgreenaway\fP) [2017.7] Fix to test_pkg.test_pkg_015_installed_held
@ \fI2018\-08\-05 19:47:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
43649a68be Merge pull request \fI\%#48935\fP from garethgreenaway/1045_test_pkg_015_installed_held_centos
.IP \(bu 2
0bb10107b6 Merge branch \(aq2017.7\(aq into 1045_test_pkg_015_installed_held_centos
.IP \(bu 2
24d5e6a22f Fixing the test_pkg_015_installed_held test to be able to successfully run on CentOS
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47087\fP: (\fI\%darkpixel\fP) How do I stop the prompt \(dqPermission denied for host <hostname>, do you want to deploy the salt\-ssh key? (password required):\(dq? (refs: \fI\%#47100\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47100\fP: (\fI\%gtmanfred\fP) Allow for not being prompted to supply a password to deploy keys to a…
@ \fI2018\-08\-05 19:12:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
2421e2a570 Merge pull request \fI\%#47100\fP from gtmanfred/ssh
.IP \(bu 2
5b443af7ae add key\-deploy test
.IP \(bu 2
a131c9beeb Allow for not being prompted to supply a password to deploy keys to a minion with salt\-ssh
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48865\fP: (\fI\%mts\-avco\fP) Windows packages are hidden in pkg.list_pkgs if they have no DisplayVersion (refs: \fI\%#48891\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48891\fP: (\fI\%damon\-atkins\fP) win_pkg: Fix issue introduced in Jan 2018 DisplayVersion missing should result…
@ \fI2018\-08\-05 18:53:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
d541bd6446 Merge pull request \fI\%#48891\fP from damon\-atkins/2017.7_win_pkg.list_pkgs_not_found
.IP \(bu 2
a4af1dbfb1 Fix win_pkg issues introduced Jan 2018. If DisplayVersion does not exist it should return version as \(dqNot Found\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27056\fP: (\fI\%oogali\fP) pkgng provider on FreeBSD does not do BATCH=yes (refs: \fI\%#48730\fP, \fI\%#29909\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48896\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48730\fP to 2017.7
@ \fI2018\-08\-05 18:20:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48730\fP: (\fI\%fzipi\fP) Fix batch install on FreeBSD using pkgng (refs: \fI\%#48896\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29909\fP: (\fI\%abednarik\fP) FreeBSD pkgng fix for non\-interactive install. (refs: \fI\%#48730\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29907\fP: (\fI\%bmcorser\fP) Presumably what was meant (refs: \fI\%#48730\fP)
.IP \(bu 2
5f6a56f5dc Merge pull request \fI\%#48896\fP from rallytime/bp\-48730
.IP \(bu 2
57aa204c9d Merge branch \(aq2017.7\(aq into bp\-48730
.IP \(bu 2
4995922584 Forgot variable in signature
.IP \(bu 2
0503bc18b6 Fix batch install using pkgng
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48933\fP: (\fI\%garethgreenaway\fP) [2017.7] Fix to test_service_disable_doesnot_exist
@ \fI2018\-08\-05 14:29:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
0c64bba865 Merge pull request \fI\%#48933\fP from garethgreenaway/1022_debian_8_failing_service\-test
.IP \(bu 2
280d1d2ad2 Fixing failing test, integration.modules.test_service.ServiceModuleTest.test_service_disable_doesnot_exist, on Debian 8 and higher.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48922\fP: (\fI\%rallytime\fP) Update backticks on job_cache docs
@ \fI2018\-08\-03 21:05:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
0c3d2c6a09 Merge pull request \fI\%#48922\fP from rallytime/cache\-doc\-error
.IP \(bu 2
8ca89df7e8 Update backticks on job_cache docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48866\fP: (\fI\%Ch3LL\fP) Add cmd module integration tests for windows and fix space in path issue
@ \fI2018\-08\-03 21:03:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
8d1fc4f8e5 Merge pull request \fI\%#48866\fP from Ch3LL/cmd_win_tests
.IP \(bu 2
905da13653 Merge branch \(aq2017.7\(aq into cmd_win_tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48920\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48904\fP to 2017.7
@ \fI2018\-08\-03 15:17:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48904\fP: (\fI\%KaiSforza\fP) No rehashing in parallel (refs: \fI\%#48920\fP)
.IP \(bu 2
57d58e7541 Merge pull request \fI\%#48920\fP from rallytime/bp\-48904\-2017.7
.IP \(bu 2
a55f92954a No rehashing in parallel
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48876\fP: (\fI\%Vaelatern\fP) Make IP_LEARNING optional
@ \fI2018\-08\-02 19:30:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
e79ccb35b1 Merge pull request \fI\%#48876\fP from Vaelatern/make\-network\-learning\-optional
.IP \(bu 2
a4905b0e5d Make IP_LEARNING optional
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48890\fP: (\fI\%Ch3LL\fP) add sleep in test_cmd integration test
@ \fI2018\-08\-02 19:15:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
f8bfab4f9f Merge pull request \fI\%#48890\fP from Ch3LL/cmd_test
.IP \(bu 2
acda4ed9ab add sleep in test_cmd integration test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48885\fP: (\fI\%rallytime\fP) Mark shadow module integration test as flaky
@ \fI2018\-08\-02 19:04:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
52722f6ded Merge pull request \fI\%#48885\fP from rallytime/flaky\-tests\-shadow
.IP \(bu 2
da871a2d57 Mark shadow module integration test as flaky
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48884\fP: (\fI\%rallytime\fP) Separate compound matcher tests into individual tests
@ \fI2018\-08\-02 19:04:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf0895656e Merge pull request \fI\%#48884\fP from rallytime/flaky\-tests\-matchers
.IP \(bu 2
38d9eae537 Merge branch \(aq2017.7\(aq into flaky\-tests\-matchers
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48868\fP: (\fI\%terminalmage\fP) Fix race when SIGTERM/SIGINT received while lazyloading a module
@ \fI2018\-08\-02 17:13:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
a567666938 Merge pull request \fI\%#48868\fP from terminalmage/fix\-loader\-race
.IP \(bu 2
5f1169b9a2 Fix race when SIGTERM/SIGINT received while lazyloading a module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48883\fP: (\fI\%terminalmage\fP) Fix failing git worktree tests
@ \fI2018\-08\-02 16:51:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
0ca0b6f2f2 Merge pull request \fI\%#48883\fP from terminalmage/salt\-jenkins\-1023
.IP \(bu 2
c61f75cb50 Fix failing git worktree tests
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
3660dff13c Separate compound matcher tests into individual tests
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48869\fP: (\fI\%Ch3LL\fP) Catch socket.error exception in testprogram
@ \fI2018\-08\-02 14:19:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
a84f5155a1 Merge pull request \fI\%#48869\fP from Ch3LL/mac_shell_tests
.IP \(bu 2
3734b1ec89 Catch socket.error exception in testprogram
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48867\fP: (\fI\%rallytime\fP) Skip unreliable tornado test.
@ \fI2018\-08\-01 21:07:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
7f56b8bf44 Merge pull request \fI\%#48867\fP from rallytime/skip\-tornado\-test
.IP \(bu 2
7320aa9104 Skip unreliable tornado test.
.IP \(bu 2
3be11e06fe Add docs for new escape kwarg
.IP \(bu 2
391bb8a411 use a specific path for just the cmd._run call
.IP \(bu 2
62c66ba489 make sure we lower the check on shell
.IP \(bu 2
9312a993a5 Add cmd module integration tests for windows and fix space in path issue
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48853\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48850\fP to 2017.7
@ \fI2018\-07\-31 20:21:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48850\fP: (\fI\%rallytime\fP) Skip tests in integration.shell.test_master (refs: \fI\%#48853\fP)
.IP \(bu 2
05f2d65de3 Merge pull request \fI\%#48853\fP from rallytime/bp\-48850
.IP \(bu 2
3c33ee554a Skip tests in integration.shell.test_master
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46689\fP: (\fI\%mxork\fP) pkg.installed: hold: True not applied to a package which is already installed. (refs: \fI\%#48426\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48426\fP: (\fI\%garethgreenaway\fP) [2017.7] fixes to states/pkg.py
@ \fI2018\-07\-31 20:18:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
8a1285239a Merge pull request \fI\%#48426\fP from garethgreenaway/46689_fixing_pkg_held_when_package_is_installed
.IP \(bu 2
9b0f5dd212 Fixing indentation, removing some unnecessary conditionals.
.IP \(bu 2
727964ab55 One last cleanup.
.IP \(bu 2
11cb86e6eb General cleanup in pkg state, reducing duplicate code.  Fixing the requires_salt_modules decorator, sys.doc was returning too much information for the event to handle.  This change specifically calls sys.doc with the module name.
.IP \(bu 2
16fb6ae635 Make sure pkg.hold and pkg.unhold are available before running the test.
.IP \(bu 2
998651102d Fixing a situation when a package is already installed via salt or manually and a state attempts to set that package to be held.  Previously the holding/unholding logic was only being run against packages that were being installed.  This change moves the holding logic outside and runs it against all desired packages.  Adding a new test to test holding logic.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47689\fP: (\fI\%OrlandoArcapix\fP) Poor performance of pip.installed when given a list of packages (refs: \fI\%#47734\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47734\fP: (\fI\%OrlandoArcapix\fP) \fI\%#47689\fP improve run\-speed of pip package state
@ \fI2018\-07\-31 19:15:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
c8e69431ff Merge pull request \fI\%#47734\fP from OrlandoArcapix/Issue47689\-pip\-state\-performance
.IP \(bu 2
662bd1f780 Merge branch \(aq2017.7\(aq into Issue47689\-pip\-state\-performance
.IP \(bu 2
66936b4f41 Changed string comparison in pip test to match new confirmation string \- ref PR \fI\%#47734\fP\&.
.IP \(bu 2
bb5939d6ef Merge branch \(aq2017.7\(aq into Issue47689\-pip\-state\-performance
.IP \(bu 2
d6a49ae41c Merge branch \(aq2017.7\(aq into Issue47689\-pip\-state\-performance
.IP \(bu 2
d4083fc9d1 Merge branch \(aqIssue47689\-pip\-state\-performance\(aq of github.com:OrlandoArcapix/salt into Issue47689\-pip\-state\-performance
.INDENT 2.0
.IP \(bu 2
779b5fa785 Merge branch \(aq2017.7\(aq into Issue47689\-pip\-state\-performance
.UNINDENT
.IP \(bu 2
f3653349ab Removed whitespaces at end of added comments lines
.IP \(bu 2
db11f2ff4b Merge branch \(aq2017.7\(aq into Issue47689\-pip\-state\-performance
.IP \(bu 2
eac0178de2 Ref: \fI\%#47689\fP \- document additional kwarg passed to pip._check_if_installed function
.IP \(bu 2
0d19803106 Merge branch \(aq2017.7\(aq into Issue47689\-pip\-state\-performance
.IP \(bu 2
d3678bf2f3 \fI\%#47689\fP fix lint errors
.IP \(bu 2
4fec8f6bcc \fI\%#47698\fP improve run\-speed of pip package state checks by only loading the current package list once when checking multiple packages
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48844\fP: (\fI\%AVeenstra\fP) Fixed Python 3 incompatibility in methods in nilrt_ip and debian_ip.
@ \fI2018\-07\-31 17:20:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
83a5b3cc47 Merge pull request \fI\%#48844\fP from AVeenstra/fix\-python3\-incompatibility
.IP \(bu 2
f238779a62 Merge branch \(aq2017.7\(aq into fix\-python3\-incompatibility
.IP \(bu 2
6b1805afc6 Fixed Python 3 incompatibility in methods in nilrt_ip and debian_ip.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48637\fP: (\fI\%slaws\fP) state.file.retention_schedule does not ignore relative directory when using getmtime() (refs: \fI\%#48662\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48662\fP: (\fI\%slaws\fP) Excluding relative dirs in state.file.retention_schedule
@ \fI2018\-07\-31 16:15:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
136ff6735a Merge pull request \fI\%#48662\fP from slaws/fix\-retention\-schedule\-48637
.IP \(bu 2
3c8f5f5b3d pylint fix
.IP \(bu 2
5539eff39e Excluding relative dirs in state.file.retention_schedule
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48818\fP: (\fI\%guettli\fP) Broken Link in Docs (refs: \fI\%#48840\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48840\fP: (\fI\%gtmanfred\fP) fix links in pkg doc.
@ \fI2018\-07\-31 16:13:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
1fc04f281b Merge pull request \fI\%#48840\fP from gtmanfred/docs
.IP \(bu 2
8d2d268c4a fix links in pkg doc.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48834\fP: (\fI\%gtmanfred\fP) read output of stringio if it is readable
@ \fI2018\-07\-31 13:40:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a19f845ea Merge pull request \fI\%#48834\fP from gtmanfred/slsutil
.IP \(bu 2
f9441d2bef read output of stringio if it is readable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48788\fP: (\fI\%Ch3LL\fP) Add timzeone windows integration tests and fix get_zone
@ \fI2018\-07\-27 20:14:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e00939a6e Merge pull request \fI\%#48788\fP from Ch3LL/timezone_windows
.IP \(bu 2
de95a6a215 add unused import to timezone test file
.IP \(bu 2
22e424859e add unused import to import
.IP \(bu 2
0840fc3117 disable pylint import error
.IP \(bu 2
f09d1a2c7e Add timzeon windows integration tests and fix get_zone
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48742\fP: (\fI\%frogunder\fP) add windows integration tests for states.file
@ \fI2018\-07\-27 13:57:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
8e61f3dce0 Merge pull request \fI\%#48742\fP from frogunder/45014
.IP \(bu 2
f08058b043 Merge branch \(aq45014\(aq of \fI\%https://github.com/frogunder/salt\fP into 45014
.INDENT 2.0
.IP \(bu 2
757fde70c6 Merge branch \(aq2017.7\(aq into 45014
.UNINDENT
.IP \(bu 2
33c20c1ec0 fix tests
.IP \(bu 2
a7a914060d add windows integration tests for states.file
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48417\fP: (\fI\%samilaine\fP) Contribution Documentation Refers to Incorrect Pylintrc (refs: \fI\%#48795\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48795\fP: (\fI\%rallytime\fP) Update linting docs to contain .testing.pylintrc use
@ \fI2018\-07\-27 13:34:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
d74f47b340 Merge pull request \fI\%#48795\fP from rallytime/fix\-48417
.IP \(bu 2
5123b17ffd Update linting docs to contain .testing.pylintrc use
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48789\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48783\fP to 2017.7
@ \fI2018\-07\-26 21:47:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48783\fP: (\fI\%KaiSforza\fP) Only run lint checks against changed files (refs: \fI\%#48789\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48610\fP: (\fI\%gtmanfred\fP) only run pylint on files that change (refs: \fI\%#48783\fP)
.IP \(bu 2
bbea9ae936 Merge pull request \fI\%#48789\fP from rallytime/bp\-48783
.IP \(bu 2
682a05bebe Threshold was wrong
.IP \(bu 2
d4ca0e3a97 test: except for OSError only
.IP \(bu 2
4547231909 Only run lint checks against changed files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48731\fP: (\fI\%zer0def\fP) Fixed \fIenable_vnc\fP runner arg being passed into \fIseed_cmd\fP module arg in \fIvirt.init\fP\&.
@ \fI2018\-07\-26 21:13:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
41464d4b39 Merge pull request \fI\%#48731\fP from zer0def/virt\-runner\-init\-args
.IP \(bu 2
a1fa081ad0 Documentation to missing parameters in virt.init runner.
.IP \(bu 2
365ebdf539 Fixed \fIenable_vnc\fP runner arg being passed into \fIseed_cmd\fP module arg in \fIvirt.init\fP\&.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48749\fP: (\fI\%Ch3LL\fP) Update Saltstack Logo banner on docs.saltproject.io
@ \fI2018\-07\-25 13:05:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
169afea16a Merge pull request \fI\%#48749\fP from Ch3LL/logo_docs
.IP \(bu 2
73b1fc29f0 Update Saltstack Logo banner on docs.saltproject.io
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48743\fP: (\fI\%rallytime\fP) Update DOCBANNER with new SaltConf18 image
@ \fI2018\-07\-24 16:46:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
781c6a6c36 Merge pull request \fI\%#48743\fP from rallytime/saltconf\-ad\-2017.7
.IP \(bu 2
6df8fd8652 Update DOCBANNER with new SaltConf18 image
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48720\fP: (\fI\%Ch3LL\fP) Fix test_managed_source_hash_indifferent_case on macosx to correct tmp path
@ \fI2018\-07\-23 22:32:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce4e22224e Merge pull request \fI\%#48720\fP from Ch3LL/mac_file_path
.IP \(bu 2
01d25fae19 Fix test_managed_source_hash_indifferent_case on macosx to correct tmp path
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48719\fP: (\fI\%Ch3LL\fP) Enable service if disabled before running state service tests
@ \fI2018\-07\-23 21:01:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
4b9f037d43 Merge pull request \fI\%#48719\fP from Ch3LL/service_mac_state
.IP \(bu 2
f44a2fc349 Enable service if disabled before running state service tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48715\fP: (\fI\%rallytime\fP) [2017.7] Mark some tornado tests as flaky
@ \fI2018\-07\-23 17:27:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
b2431eab10 Merge pull request \fI\%#48715\fP from rallytime/flaky\-tests
.IP \(bu 2
7332cce567 [2017.7] Mark some tornado tests as flaky
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48672\fP: (\fI\%frogunder\fP) add service enabled test
@ \fI2018\-07\-23 15:38:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
801eae3b8d Merge pull request \fI\%#48672\fP from frogunder/45012
.IP \(bu 2
0747f2e58a add service enabled test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48691\fP: (\fI\%Ch3LL\fP) Add windows pkg module integration tests
@ \fI2018\-07\-22 20:01:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
689c231d2b Merge pull request \fI\%#48691\fP from Ch3LL/win_repo_pkg_test
.IP \(bu 2
4b7d6d80c5 Remove unnecessary jinja in curl.sls file
.IP \(bu 2
2bedadfadb Add windows pkg module integration tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48627\fP: (\fI\%nbraud\fP) acme module\(aqs group parameter is non\-functional (refs: \fI\%#48635\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#48626\fP: (\fI\%nbraud\fP) acme module fails to set file permissions if the certificate is already present (refs: \fI\%#48635\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48635\fP: (\fI\%nbraud\fP) Bug fixes in the acme module & state
@ \fI2018\-07\-22 19:53:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
83e4bba916 Merge pull request \fI\%#48635\fP from nbraud/acme
.IP \(bu 2
3673bae9de modules/acme: explicitly ignore the \fIperms\fP return value
.IP \(bu 2
1800a231e8 Fixup some schema expectations
.IP \(bu 2
8c718cb417 acme: Make the private key mode configurable
.IP \(bu 2
917dea6761 modules/acme: Use file.check_perms ret\-morphing powers
.IP \(bu 2
d2241ceb2d module/acme: Do not exit early when the certificate already exists
.IP \(bu 2
98af0db826 modules/acme: Set the private key filemode to 0640
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48345\fP: (\fI\%twangboy\fP) Fix behavior of powercfg module and state
@ \fI2018\-07\-20 17:37:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
85991680c8 Merge pull request \fI\%#48345\fP from twangboy/fix_48169
.IP \(bu 2
ead19725b6 Merge branch \(aq2017.7\(aq into fix_48169
.IP \(bu 2
653fbcb383 Fix some docs errata
.IP \(bu 2
8898e5ff11 Add warn_until Fluorine
.IP \(bu 2
707906ac15 Fix unit.state.test_powercfg
.IP \(bu 2
32c5014eb6 Fix unit tests
.IP \(bu 2
0d9c56e540 Add some more logging
.IP \(bu 2
b20453de9f Use minutes to set
.IP \(bu 2
7dc7eb11c2 Fix documentation to denote seconds when setting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48656\fP: (\fI\%Ch3LL\fP) Add windows ip module integration tests
@ \fI2018\-07\-20 14:57:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
96447ce541 Merge pull request \fI\%#48656\fP from Ch3LL/windows_ip_mod
.IP \(bu 2
90c3f568b1 Add windows ip module integration tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48638\fP: (\fI\%twangboy\fP) Remove vcredist 2015 from Py3 installer
@ \fI2018\-07\-20 14:56:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
0c5fff3dc8 Merge pull request \fI\%#48638\fP from twangboy/fix_vcredist
.IP \(bu 2
e30d17099d Use goto instead of if statement
.IP \(bu 2
e1042fa084 Remove vcredist for Py3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48664\fP: (\fI\%Ch3LL\fP) [2017.7] Fix service.disabled test for macosx
@ \fI2018\-07\-20 14:32:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
1ebd96d909 Merge pull request \fI\%#48664\fP from Ch3LL/srv_disable_mac
.IP \(bu 2
f1fbfad387 move the disable call up in try block
.IP \(bu 2
f60d21bda4 reverse assertion order for service disable test
.IP \(bu 2
3727d1b3b9 switch try/except to match 2018.3
.IP \(bu 2
fb953c2369 [2017.7] Fix service.disabled test for macosx
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48625\fP: (\fI\%Ch3LL\fP) Follow up to PR \fI\%#48555\fP
@ \fI2018\-07\-20 14:27:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48555\fP: (\fI\%Ch3LL\fP) Fix state.sls_id not running on ssh minion (refs: \fI\%#48625\fP)
.IP \(bu 2
3da3cf2f3f Merge pull request \fI\%#48625\fP from Ch3LL/ssh_state
.IP \(bu 2
f590eb2b02 Update state.py
.IP \(bu 2
9790ee3d0d Follow up to PR \fI\%#48555\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48673\fP: (\fI\%Ch3LL\fP) Use different pub and ret ports for testprogram integration tests
@ \fI2018\-07\-20 14:11:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
33812f78f1 Merge pull request \fI\%#48673\fP from Ch3LL/mac_port
.IP \(bu 2
87dd85a220 Use different pub and ret ports for testprogram integration tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48675\fP: (\fI\%Ch3LL\fP) Fix mac service.disable tests
@ \fI2018\-07\-20 14:09:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
5f6a7c4d89 Merge pull request \fI\%#48675\fP from Ch3LL/mac_disable
.IP \(bu 2
c78efab828 Fix mac service.disable tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43138\fP: (\fI\%F30\fP) npm.installed mistakenly throws error for packages which are \(dqinstalled via remote\(dq (refs: \fI\%#48492\fP, \fI\%#48658\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48658\fP: (\fI\%wyardley\fP) Improve handling of json output (\fI\%#43138\fP)
@ \fI2018\-07\-20 14:08:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48492\fP: (\fI\%wyardley\fP) Improve identifying json out in npm module (\fI\%#43138\fP) (refs: \fI\%#48658\fP)
.IP \(bu 2
93d2f51d2b Merge pull request \fI\%#48658\fP from wyardley/wyardley\-npm\-json\-output\-2017
.IP \(bu 2
7ff3c9c5ff Improve handling of npm json output (\fI\%#43138\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48677\fP: (\fI\%OrlandoArcapix\fP) npm.bootstrap does not return True (clean) with test=true and no changes (refs: \fI\%#48678\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48678\fP: (\fI\%OrlandoArcapix\fP) Fix for issue \fI\%#48677\fP \- return clean npm.bootstrap on no changes
@ \fI2018\-07\-20 14:07:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e293b0513 Merge pull request \fI\%#48678\fP from OrlandoArcapix/fix\-npm\-dryrun\-test
.IP \(bu 2
851a404f6b Fix for issue \fI\%#48677\fP \- return True when no changes are to be made with npm.bootstrap with test=true
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46884\fP: (\fI\%alexandergraul\fP) salt.utils.rsax931._init_libcrypto() fails to initialize libopenssl1_1\-1.1.0h (refs: \fI\%#48580\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48580\fP: (\fI\%rallytime\fP) Don\(aqt error on retcode 0 in libcrypto.OPENSSL_init_crypto call
@ \fI2018\-07\-19 19:21:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37772\fP: (\fI\%bdrung\fP) Support initializing OpenSSL 1.1 (refs: \fI\%#48580\fP)
.IP \(bu 2
07a1f6520f Merge pull request \fI\%#48580\fP from rallytime/fix\-46884
.IP \(bu 2
736b382e91 Don\(aqt error on retcode 0 in libcrypto.OPENSSL_init_crypto call
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48628\fP: (\fI\%terminalmage\fP) Fix NameError in testinfra module
@ \fI2018\-07\-18 21:34:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
9874429741 Merge pull request \fI\%#48628\fP from terminalmage/testinfra
.IP \(bu 2
5ace9f01ec Fix NameError in testinfra module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48651\fP: (\fI\%gtmanfred\fP) [2017.7] handle pyzmq for python3.4
@ \fI2018\-07\-18 17:34:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d4c80205f Merge pull request \fI\%#48651\fP from gtmanfred/pylint\-2017.7
.IP \(bu 2
b6ee52f859 handle pyzmq for python3.4
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48647\fP: (\fI\%gtmanfred\fP) [2017.7] disable checks on pylint
@ \fI2018\-07\-18 16:21:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
160ae29cf2 Merge pull request \fI\%#48647\fP from gtmanfred/pylint\-2017.7
.IP \(bu 2
ff818c4ca2 disable checks on pylint
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46924\fP: (\fI\%chschmitt\fP) Stale custom roster from __pycache__ executed instead of changed .py file (refs: \fI\%#48593\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48593\fP: (\fI\%pritambaral\fP) Fix importlib pyc loading order
@ \fI2018\-07\-17 21:06:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
47b1032efa Merge pull request \fI\%#48593\fP from pritambaral/fix/2017.7\-importlib\-pyc\-loading\-order
.IP \(bu 2
add7894dee loader: Fix suffix order when importlib is used
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48630\fP: (\fI\%dubb\-b\fP) Adding options to Jenkins pipline builds
@ \fI2018\-07\-17 20:16:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
9da7b2ec8d Merge pull request \fI\%#48630\fP from dubb\-b/pipeline\-updates
.IP \(bu 2
8594a8dd05 Adding PY_COLORS=1 as PY_COLORS = 1 instead
.IP \(bu 2
314b0e3599 Adding PY_COLORS=1 for python programs to use ANSI Colors
.IP \(bu 2
b705e8f7a5 Adding correct spacing to options section
.IP \(bu 2
9d8a7e07db Adding options to Jenkins pipline builds
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#48610\fP: (\fI\%gtmanfred\fP) only run pylint on files that change (refs: \fI\%#48633\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48633\fP: (\fI\%gtmanfred\fP) Revert \(dqonly run pylint on files that change\(dq
@ \fI2018\-07\-17 18:44:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
a8ae2adf64 Merge pull request \fI\%#48633\fP from saltstack/revert\-48610\-2017.7
.IP \(bu 2
bab4a769d4 Revert \(dqonly run pylint on files that change\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48614\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48562\fP to 2017.7
@ \fI2018\-07\-17 15:04:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48562\fP: (\fI\%basepi\fP) Add timeouts to all s3 queries (refs: \fI\%#48614\fP)
.IP \(bu 2
6e32bb7f74 Merge pull request \fI\%#48614\fP from rallytime/bp\-48562
.IP \(bu 2
cb654bbf2c Add timeouts to all s3 queries
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48415\fP: (\fI\%doesitblend\fP) Event.send short\-circuiting in multi\-master mode (refs: \fI\%#48588\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48588\fP: (\fI\%garethgreenaway\fP) [2017.7] event send multi master
@ \fI2018\-07\-17 10:31:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
1b6e6388f8 Merge pull request \fI\%#48588\fP from garethgreenaway/48415_event_send_multi_master
.IP \(bu 2
fab25af1a9 Adding some quick documentation about why we are setting ret=True following the channel.send.
.IP \(bu 2
bf78f4b188 If the channel send is successful and does not raise an exception, we set ret to True, in case a previous exception from a previous channel send to another master has sent it to False.
.IP \(bu 2
8d1551c5fb When using Salt multi\-master, if we encouter a salt master that has not accepted the minion key yet we should not exit right away, rather continue on and try the next salt master available in the list.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48610\fP: (\fI\%gtmanfred\fP) only run pylint on files that change (refs: \fI\%#48783\fP)
@ \fI2018\-07\-17 01:36:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
24ffda49ba Merge pull request \fI\%#48610\fP from gtmanfred/2017.7
.IP \(bu 2
779d1a3dcb only run pylint on files that change
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48584\fP: (\fI\%Ch3LL\fP) Fix grp import for mac in test_user integration test
@ \fI2018\-07\-16 19:28:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
5391dd0a8d Merge pull request \fI\%#48584\fP from Ch3LL/mac_user_grp
.IP \(bu 2
585ee9db90 Fix grp import for mac in test_user integration test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48555\fP: (\fI\%Ch3LL\fP) Fix state.sls_id not running on ssh minion (refs: \fI\%#48625\fP)
@ \fI2018\-07\-16 13:24:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
61572b6780 Merge pull request \fI\%#48555\fP from Ch3LL/ssh_id
.IP \(bu 2
f69932f506 fix pylint
.IP \(bu 2
70e36764ee Add more tests for salt\-ssh state.sls_id
.IP \(bu 2
dab80e805c Fix state.sls_id to run on ssh minion and not master
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48583\fP: (\fI\%Ch3LL\fP) Add flaky decorator to mac_system and mac_timezone tests
@ \fI2018\-07\-13 19:56:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
aa6dcf39e8 Merge pull request \fI\%#48583\fP from Ch3LL/mac_flaky_tests
.IP \(bu 2
4ba2299a87 import flaky decorator on mac tests
.IP \(bu 2
811220b41e Add flaky decorator to mac_system and mac_timezone tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48534\fP: (\fI\%xetix\fP) Fix behaviour of function latest_version in zypper module when multip…
@ \fI2018\-07\-13 19:56:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
6973152057 Merge pull request \fI\%#48534\fP from xetix/fix\-zypper\-latest_version
.IP \(bu 2
9985f0b4c1 Lint: remove extra blank line
.IP \(bu 2
5fbead8a36 Merge branch \(aq2017.7\(aq into fix\-zypper\-latest_version
.IP \(bu 2
56ac449271 Merge branch \(aqfix\-zypper\-latest_version\(aq of \fI\%https://github.com/xetix/salt\fP into fix\-zypper\-latest_version
.INDENT 2.0
.IP \(bu 2
44e87f5a0f Adding testcase for this fix.
.IP \(bu 2
b354c6863c Fix behaviour of function latest_version in zypper module when multiple packages are passed to function. Function now properly return dict with empty string as version if latest packages is already installed, and multiple packages are passed to function
.UNINDENT
.IP \(bu 2
db35d0c1e1 Adding testcase for this fix.
.IP \(bu 2
d2513757ed Fix behaviour of function latest_version in zypper module when multiple packages are passed to function. Function now properly return dict with empty string as version if latest packages is already installed, and multiple packages are passed to function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48582\fP: (\fI\%dwoz\fP) Finally fix prepend for real
@ \fI2018\-07\-13 18:45:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
10124034cb Merge pull request \fI\%#48582\fP from dwoz/test_prepend_fix
.IP \(bu 2
f37571e0bd Merge branch \(aq2017.7\(aq into test_prepend_fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48564\fP: (\fI\%dwoz\fP) Fix failing prepend test
@ \fI2018\-07\-13 14:12:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
13f67335f3 Merge pull request \fI\%#48564\fP from dwoz/test_prepend_fix
.INDENT 2.0
.IP \(bu 2
136ddf5f54 Finally fix prepend for real
.UNINDENT
.IP \(bu 2
66b25e65bf Fix failing prepend test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48558\fP: (\fI\%dwoz\fP) Remove which mock to get the test passing
@ \fI2018\-07\-12 19:04:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
b8ce27729f Merge pull request \fI\%#48558\fP from dwoz/test_file_fix
.IP \(bu 2
c858bf477f Remove which mock to get the test passing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48552\fP: (\fI\%KaiSforza\fP) Set up junit in jenkins
@ \fI2018\-07\-12 16:23:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
a15c65202d Merge pull request \fI\%#48552\fP from KaiSforza/jenkins\-junit\-2017
.IP \(bu 2
72b1830974 Set up junit in jenkins
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48550\fP: (\fI\%gtmanfred\fP) add posargs to tox pylint
@ \fI2018\-07\-12 14:34:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
f73108026e Merge pull request \fI\%#48550\fP from gtmanfred/2017.7
.IP \(bu 2
d5c603d9b6 add posargs to tox pylint
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48535\fP: (\fI\%asnell\fP) Update manage_file helptext
@ \fI2018\-07\-12 13:34:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
113b0426f8 Merge pull request \fI\%#48535\fP from asnell/asnell\-patch\-2
.IP \(bu 2
d328f6e43d Update manage_file helptext
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#48525\fP: (\fI\%gtmanfred\fP) add kazoo for testing zookeeper. (refs: \fI\%#48527\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48527\fP: (\fI\%gtmanfred\fP) Revert \(dqadd kazoo for testing zookeeper.\(dq
@ \fI2018\-07\-11 17:29:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
0c0c05c2bc Merge pull request \fI\%#48527\fP from saltstack/revert\-48525\-2017.7
.IP \(bu 2
18d06c1a93 Revert \(dqadd kazoo for testing zookeeper.\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48526\fP: (\fI\%twangboy\fP) Rollback python\-certifi\-win32
@ \fI2018\-07\-11 17:26:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
05bad3e71c Merge pull request \fI\%#48526\fP from twangboy/rollback_certifi\-win32
.IP \(bu 2
361b3cdc2f Rollback python\-certifi\-win32
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48521\fP: (\fI\%Martin819\fP) Back\-port \fI\%#48222\fP to 2017.7
@ \fI2018\-07\-11 16:42:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48222\fP: (\fI\%Martin819\fP) Fix GlusterFS module for version 4.0 and above (refs: \fI\%#48521\fP)
.IP \(bu 2
db066effe4 Merge pull request \fI\%#48521\fP from Martin819/2017.7
.IP \(bu 2
d5d01f6698 Fix for GlusterFS 4.0 and above
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48525\fP: (\fI\%gtmanfred\fP) add kazoo for testing zookeeper.
@ \fI2018\-07\-11 16:09:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
ed0bd2bbec Merge pull request \fI\%#48525\fP from gtmanfred/2017.7
.IP \(bu 2
d7a6bff2b2 add kazoo for testing zookeeper.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48277\fP: (\fI\%dvenckus\fP) init.sls with included states fails with more than one, \(aqTemplate was specified incorrectly: False\(aq (refs: \fI\%#48388\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#46986\fP: (\fI\%github\-abcde\fP) opts file_roots gets overwritten with pillar_roots in orchestration run (refs: \fI\%#48388\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48388\fP: (\fI\%garethgreenaway\fP) [2017.7] reset file_roots for renderers after compile_pillar
@ \fI2018\-07\-11 13:13:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
ad5a959ab9 Merge pull request \fI\%#48388\fP from garethgreenaway/48277_2017_7_file_roots_wrong
.IP \(bu 2
6f11da35a7 Fixing a few things in the new test.
.IP \(bu 2
cf747b14ec Fixing lint issue
.IP \(bu 2
16d36c79c8 When pillar items are compiled a new render is instantiated but the file_roots is the pillar_roots.  This change forces the __opts__[\(aqfile_roots\(aq] to be set to what is set in actual_file_roots for all renderers once compile_pillar has finished.  Adding a test when this situation is run via a orchestration runner.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48512\fP: (\fI\%gtmanfred\fP) pin pm and grunt packages for npm tests
@ \fI2018\-07\-11 13:06:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
38df812257 Merge pull request \fI\%#48512\fP from gtmanfred/npm
.IP \(bu 2
9ba0f6b3a0 pin pm and grunt packages for npm tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48513\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.7 to 2017.7
@ \fI2018\-07\-11 13:04:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
04ba31147f Merge pull request \fI\%#48513\fP from rallytime/merge\-2017.7
.IP \(bu 2
a466a4880f Merge branch \(aq2017.7.7\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48514\fP: (\fI\%gtmanfred\fP) upgrade dependencies for pytest tests
@ \fI2018\-07\-10 20:53:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
f0352ea95a Merge pull request \fI\%#48514\fP from gtmanfred/2017.7
.IP \(bu 2
739bf92599 upgrade dependencies for pytest tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48491\fP: (\fI\%grokrecursion\fP) Group gid fixed as integer
@ \fI2018\-07\-10 19:31:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
5372b60137 Merge pull request \fI\%#48491\fP from grokrecursion/group\-fix\-v2
.IP \(bu 2
1556b37221 fixed pylint errors
.IP \(bu 2
f6d9177dab fixed indentation for pep8
.IP \(bu 2
b9556bf923 v2 try of gid converted to integer
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48375\fP: (\fI\%Ch3LL\fP) Add user and group to makedirs cmd in file.copy
@ \fI2018\-07\-10 12:35:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
16d3daab3c Merge pull request \fI\%#48375\fP from Ch3LL/file_copy
.IP \(bu 2
d16a790775 Add mode to _makedirs call in file.copy
.IP \(bu 2
2cbcb4fd26 Add user and group to makedirs cmd in file.copy
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48490\fP: (\fI\%KaiSforza\fP) Cifixes
@ \fI2018\-07\-09 15:20:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
d38951b1b3 Merge pull request \fI\%#48490\fP from KaiSforza/cifixes
.IP \(bu 2
9fe7199af5 Mark failed if anything is found
.IP \(bu 2
6749a6bf19 Stop archiving the docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48472\fP: (\fI\%gtmanfred\fP) use tox to run pylint
@ \fI2018\-07\-07 02:46:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
22cd4206c4 Merge pull request \fI\%#48472\fP from gtmanfred/2017.7
.IP \(bu 2
c7a3a7d8bd update jenkins tests to use tox for lint
.IP \(bu 2
44aaac1d33 use tox to run pylint
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48476\fP: (\fI\%twangboy\fP) Fix dependencies
@ \fI2018\-07\-06 23:43:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
27ea8f35ea Merge pull request \fI\%#48476\fP from twangboy/fix_dependencies
.IP \(bu 2
b0087d425c Add license info
.IP \(bu 2
935f9b560c Fix dependencies
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48336\fP: (\fI\%JuanManuelVizcainoAbad\fP) file.directory (refs: \fI\%#48399\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48399\fP: (\fI\%garethgreenaway\fP) [2017.7] fixes to module/file.py
@ \fI2018\-07\-06 18:02:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
acf42864aa Merge pull request \fI\%#48399\fP from garethgreenaway/48336_2017_7_ensure_chmod_setuid_with_chown
.IP \(bu 2
8efd33320f Normalize the mode before we compare it.
.IP \(bu 2
f894f0ecb8 Setting the mode with setuid or setgid bits in addition to setting the owner and group will force the setuid & setgid bits to reset.  This change ensures that we set the mode after setting the owner & group.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48471\fP: (\fI\%gtmanfred\fP) Add some configurations to tox
@ \fI2018\-07\-06 17:45:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
6166ff6b78 Merge pull request \fI\%#48471\fP from gtmanfred/2017.7
.IP \(bu 2
392ab4e51f Add some configurations to tox
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48433\fP: (\fI\%discogestalt\fP) Fix issue with redismod.hmset method
@ \fI2018\-07\-06 15:55:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
6234d9b15d Merge pull request \fI\%#48433\fP from discogestalt/fix\-redis.hmset
.IP \(bu 2
65817ac74d Use clean_kwargs method instead
.IP \(bu 2
f7fa7f57c6 Found another issue with redismod.hmset
.IP \(bu 2
5624865f86 Fix issue with redismod.hmset method
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48428\fP: (\fI\%terminalmage\fP) Fix outputter detection in jobs.lookup_jid runner
@ \fI2018\-07\-06 14:37:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
aacee0fe2c Merge pull request \fI\%#48428\fP from terminalmage/fix\-jobs.lookup_jid
.IP \(bu 2
6509aa9089 Fix outputter detection in jobs.lookup_jid runner
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48429\fP: (\fI\%rallytime\fP) Back\-port \fI\%#46824\fP to 2017.7
@ \fI2018\-07\-03 21:45:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#46824\fP: (\fI\%beornf\fP) Regression to ignore retcodes on crontab calls (refs: \fI\%#48429\fP)
.IP \(bu 2
a7e52f0de2 Merge pull request \fI\%#48429\fP from rallytime/bp\-46824
.IP \(bu 2
8b4486248d Added ignore_retcode to mock unit tests
.IP \(bu 2
f8beab71dd Regression to ignore retcodes on crontab calls
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48432\fP: (\fI\%dwoz\fP) Prepend test needs file.touch method
@ \fI2018\-07\-03 21:32:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
4576ef20bc Merge pull request \fI\%#48432\fP from dwoz/file\-prepend\-again
.IP \(bu 2
349a2b279e Prepend test needs file.touch method
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48230\fP: (\fI\%whytewolf\fP) file.managed source_hash case\-sensitive for test=true (refs: \fI\%#48422\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38914\fP: (\fI\%hgfischer\fP) Uppercase checksums are not accepted by archive.extracted (refs: \fI\%#40754\fP, \fI\%#48422\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48422\fP: (\fI\%rallytime\fP) Allow file.managed to work with uppercase source_hash in test=true mode
@ \fI2018\-07\-03 16:40:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40754\fP: (\fI\%lordcirth\fP) file.manage_file: uppercase checksums now work (refs: \fI\%#48422\fP)
.IP \(bu 2
422441505d Merge pull request \fI\%#48422\fP from rallytime/fix\-48230
.IP \(bu 2
a6abf85621 Allow file.managed to work with uppercase source_hash in test=true mode
.IP \(bu 2
4c691ac57a Add regression test for Issue \fI\%#48230\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48410\fP: (\fI\%dwoz\fP) Fix service dead test on windows
@ \fI2018\-07\-03 14:17:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
83e387c951 Merge pull request \fI\%#48410\fP from dwoz/service_dead_test_fix
.IP \(bu 2
5c0923448d Fix service dead test on windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48413\fP: (\fI\%twangboy\fP) Fix archive.extracted to handle UNC paths
@ \fI2018\-07\-03 14:14:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
d3ba345da5 Merge pull request \fI\%#48413\fP from twangboy/fix_47811
.IP \(bu 2
c5aad04140 handle unc paths
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48416\fP: (\fI\%dwoz\fP) Fix service integration test (py3)
@ \fI2018\-07\-03 14:08:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
827ef2aac4 Merge pull request \fI\%#48416\fP from dwoz/service_integration_fix
.IP \(bu 2
c43f150dcd Fix service integration test (py3)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48385\fP: (\fI\%Ch3LL\fP) Update release versions for the 2017.7 branch
@ \fI2018\-07\-03 13:39:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
10fe7d2b9b Merge pull request \fI\%#48385\fP from Ch3LL/1update_version_doc_2017.7
.IP \(bu 2
3cf335b0b9 Update release versions for the 2017.7 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48405\fP: (\fI\%Ch3LL\fP) [2017.7] Remove In Progress Warning on 2017.7.7
@ \fI2018\-07\-03 13:32:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
f8a9a037e6 Merge pull request \fI\%#48405\fP from Ch3LL/rm_inprog_2017.7
.IP \(bu 2
03ed5167fa [2017.7] Remove In Progress Warning on 2017.7.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48409\fP: (\fI\%dwoz\fP) Fix file state prepend test
@ \fI2018\-07\-02 23:21:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
8ac867c168 Merge pull request \fI\%#48409\fP from dwoz/test_prepend_fix
.IP \(bu 2
9c7085b70f Fix file state prepend test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48396\fP: (\fI\%dwoz\fP) Fix file.symlink state test for windows
@ \fI2018\-07\-02 18:10:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
10e93bff7f Merge pull request \fI\%#48396\fP from dwoz/symlink_test_fix
.IP \(bu 2
d3456d31e6 Fix file.symlink state test for windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48362\fP: (\fI\%twangboy\fP) Fix stacktrace when registry entries are missing
@ \fI2018\-06\-30 13:20:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
7e25f26837 Merge pull request \fI\%#48362\fP from twangboy/fix_48276
.IP \(bu 2
77629f640a Fix module unit tests
.IP \(bu 2
b5ca560b73 Fix lint error
.IP \(bu 2
210e280ecf Use explicit parameter names
.IP \(bu 2
776db98a5c Handle missing registry entries
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48383\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48379\fP to 2017.7
@ \fI2018\-06\-29 19:48:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48379\fP: (\fI\%KaiSforza\fP) Clean up the workspaces at the end for every job (refs: \fI\%#48383\fP)
.IP \(bu 2
80222b6b7c Merge pull request \fI\%#48383\fP from rallytime/bp\-48379
.IP \(bu 2
9fc7815594 Clean up the workspaces at the end for every job
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48382\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48346\fP to 2017.7
@ \fI2018\-06\-29 19:45:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48346\fP: (\fI\%KaiSforza\fP) Use the right ssh key to destroy kitchen (refs: \fI\%#48382\fP)
.IP \(bu 2
aa68aa774a Merge pull request \fI\%#48382\fP from rallytime/bp\-48346
.IP \(bu 2
6a70ba222e Use the right ssh key to destroy kitchen
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48381\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48330\fP to 2017.7
@ \fI2018\-06\-29 19:43:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48330\fP: (\fI\%KaiSforza\fP) Add warnings plugin to replace violations (refs: \fI\%#48381\fP)
.IP \(bu 2
9519f640e7 Merge pull request \fI\%#48381\fP from rallytime/bp\-48330
.IP \(bu 2
6857bedcc2 Add warnings plugin to replace violations
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48363\fP: (\fI\%dubb\-b\fP) Changing debug to info for logging
@ \fI2018\-06\-28 20:45:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
14db0aa35d Merge pull request \fI\%#48363\fP from dubb\-b/2017.7
.IP \(bu 2
c0b962e28d Changing debug to info for logging
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48352\fP: (\fI\%Ch3LL\fP) Add missing key to accept_dict function in wheel docs
@ \fI2018\-06\-28 13:54:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b29cd326f Merge pull request \fI\%#48352\fP from Ch3LL/wheel_doc
.IP \(bu 2
89ada68165 Add missing key to accept_dict function in wheel docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48329\fP: (\fI\%rallytime\fP) Trigger review requests for team\-ssh for roster files
@ \fI2018\-06\-28 13:53:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
02cf19ee3b Merge pull request \fI\%#48329\fP from rallytime/codeowners\-roster\-files
.IP \(bu 2
5e56615e00 Trigger review requests for team\-ssh for roster files
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48316\fP: (\fI\%ralex\fP) Wrong init system used in virtual module \(dqservice\(dq on Manjaro (refs: \fI\%#48349\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48349\fP: (\fI\%ralex\fP) Disable the \(dqservice\(dq module on Manjaro since it is using systemd
@ \fI2018\-06\-28 13:32:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
53cf1794be Merge pull request \fI\%#48349\fP from ralex/fix\-manjaro\-service\-behaviour
.IP \(bu 2
6cafce547e Disable the \fIservice\fP module on Manjaro since it is using systemd
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48324\fP: (\fI\%Ch3LL\fP) Update release versions for the 2017.7 branch
@ \fI2018\-06\-27 13:44:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
89dfcf3a4e Merge pull request \fI\%#48324\fP from Ch3LL/update_version_doc_2017.7
.IP \(bu 2
47845ba810 Update release versions for the 2017.7 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48331\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48215\fP to 2017.7
@ \fI2018\-06\-27 13:12:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48215\fP: (\fI\%KaiSforza\fP) Notify during tests using different credentials (refs: \fI\%#48331\fP)
.IP \(bu 2
ece4c30aac Merge pull request \fI\%#48331\fP from rallytime/bp\-48215
.IP \(bu 2
9d6ba3e247 Set jobs to pending when they come in
.IP \(bu 2
727d2b4ffe Use proper creds with githubNotify
.IP \(bu 2
d355861c5c Test using different credentials
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48332\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48321\fP to 2017.7
@ \fI2018\-06\-27 13:12:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48321\fP: (\fI\%KaiSforza\fP) Jenkins needs the / to get the directory (refs: \fI\%#48332\fP)
.IP \(bu 2
ab05e00d8c Merge pull request \fI\%#48332\fP from rallytime/bp\-48321
.IP \(bu 2
d72af6ab4e Jenkins needs the / to get the directory
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42659\fP: (\fI\%szin2012\fP) rest_tornado is not able to return normal result  (refs: \fI\%#48193\fP, \fI\%#48295\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48295\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48193\fP to 2017.7
@ \fI2018\-06\-26 23:42:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48193\fP: (\fI\%jacksontj\fP) Properly wait on returns in saltnado (refs: \fI\%#48295\fP)
.IP \(bu 2
21ed5b97ce Merge pull request \fI\%#48295\fP from rallytime/bp\-48193
.IP \(bu 2
352fe33fd6 Separate set_result() to a new line apart from Future() call
.IP \(bu 2
c0180ff33d Properly configure syndic in test case
.IP \(bu 2
d0a98534a9 Properly wait on returns in saltnado
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48117\fP: (\fI\%twangboy\fP) service.disabled on Windows
@ \fI2018\-06\-26 23:35:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
9aa4687ab9 Merge pull request \fI\%#48117\fP from twangboy/fix_48026
.IP \(bu 2
dd37f8fbc2 Disable services that are set to manual
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48122\fP: (\fI\%pasmon\fP) Salt minion 2017.7.6 disregards \(dqbin_env\(dq in pip state (refs: \fI\%#48189\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48207\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48189\fP to 2017.7
@ \fI2018\-06\-25 19:26:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48189\fP: (\fI\%gtmanfred\fP) If pip binary is passed to bin_env, use that pip binary (refs: \fI\%#48207\fP)
.IP \(bu 2
caf630487c Merge pull request \fI\%#48207\fP from rallytime/bp\-48189
.IP \(bu 2
e9d09e0375 Use old is_windows utils path on 2017.7
.IP \(bu 2
b965d6c9b3 If pip binary is passed to bin_env, use that pip binary
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45383\fP: (\fI\%jodok\fP) RabbitMQ commands fail due to wrong locale (refs: \fI\%#47453\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48293\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47453\fP to 2017.7
@ \fI2018\-06\-25 19:06:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47453\fP: (\fI\%dqminh\fP) don\(aqt reset system locale when running rabbitmqctl commands (refs: \fI\%#48293\fP)
.IP \(bu 2
06a927b2aa Merge pull request \fI\%#48293\fP from rallytime/bp\-47453
.IP \(bu 2
e96ab6778e don\(aqt reset system locale when running rabbitmqctl commands
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48219\fP: (\fI\%zer0def\fP) Fix: LXC legacy configuration key warnings falsely report errors during state change
@ \fI2018\-06\-25 13:46:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
95ef006e00 Merge pull request \fI\%#48219\fP from zer0def/lxc\-bootstrap\-fixes
.IP \(bu 2
c77058560b Merge branch \(aq2017.7\(aq into lxc\-bootstrap\-fixes
.IP \(bu 2
d63cf3f072 Fixes another case of legacy configuration key usage warning getting in the way of changing container\(aqs state.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#46507\fP: (\fI\%nkv16786\fP) Failed to return clean data (refs: \fI\%#48234\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48234\fP: (\fI\%dwoz\fP) Fix py2 thin dir issues
@ \fI2018\-06\-25 13:33:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
3327181507 Merge pull request \fI\%#48234\fP from dwoz/thin_dir
.IP \(bu 2
70c603451b Fix py2 thin dir issues
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47984\fP: (\fI\%jeduardo\fP) x509 module/state writing wrong certificate serial number to CRL  (refs: \fI\%#48080\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48080\fP: (\fI\%lusche\fP) Bugfix \fI\%#47984\fP messed up cert serial
@ \fI2018\-06\-22 18:00:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
83d7d286c4 Merge pull request \fI\%#48080\fP from lusche/2017.7
.IP \(bu 2
917dc985fc \fI\%#47984\fP remove the line completely
.IP \(bu 2
ba12ee947b Merge branch \(aq2017.7\(aq of \fI\%https://github.com/saltstack/salt\fP into 2017.7
.IP \(bu 2
dfb13d5051 Bugfix \fI\%#47984\fP messed up cert serial
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48232\fP: (\fI\%gtmanfred\fP) do not expand kwargs for cloud.action
@ \fI2018\-06\-22 15:49:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
bccb4dcd46 Merge pull request \fI\%#48232\fP from gtmanfred/cloud
.IP \(bu 2
d108112e1a do not expand kwargs for cloud.action
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48238\fP: (\fI\%mirceaulinic\fP) SDB cache module: AttributeError: \(aqCache\(aq object has no attribute \(aqset\(aq
@ \fI2018\-06\-22 15:37:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
056f43f663 Merge pull request \fI\%#48238\fP from mirceaulinic/fix\-sdb\-cache
.IP \(bu 2
51e5fbfa1d SDB cache module: AttributeError: \(aqCache\(aq object has no attribute \(aqset\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48025\fP: (\fI\%onmeac\fP) Autoloading Utility Modules? (refs: \fI\%#48037\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48037\fP: (\fI\%terminalmage\fP) Add \(dqsync_mods\(dq argument to state.apply/state.sls
@ \fI2018\-06\-21 19:57:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
731ec0a11a Merge pull request \fI\%#48037\fP from terminalmage/fix\-custom\-types\-sync\-docs
.IP \(bu 2
052ae83c4b Update versionchanged
.IP \(bu 2
8b1bd0eda2 Update test to reflect changed argument name
.IP \(bu 2
5e75936198 Change 2018.3.2 to 2018.3.3
.IP \(bu 2
c53ad603fc Rename sync \-> sync_mods per review suggestion
.IP \(bu 2
e4d67c5fd8 Update docs to include references to new \(dqsync\(dq argument
.IP \(bu 2
cb8e6f9fb8 Remove redundant mocking
.IP \(bu 2
bc3ad795e9 Add test for sync argument to state.sls
.IP \(bu 2
f81ccd1fdd Add sync option to state.apply/state.sls
.IP \(bu 2
8289b07e24 Fix documentation on when custom types are synced
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48249\fP: (\fI\%rallytime\fP) Update release notes for 2017.7.7
@ \fI2018\-06\-21 18:30:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
0bae927048 Merge pull request \fI\%#48249\fP from rallytime/2017.7.7\-release\-notes\-update
.IP \(bu 2
36032c8ee7 Update release notes for 2017.7.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48242\fP: (\fI\%asnell\fP) Add sample list data via command line pillar
@ \fI2018\-06\-21 18:27:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
8e06471817 Merge pull request \fI\%#48242\fP from asnell/asnell\-patch\-1
.IP \(bu 2
f66bf60073 Add sample list data via command line pillar
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48226\fP: (\fI\%terminalmage\fP) 2 fixes for when Salt is installed using \-OO
@ \fI2018\-06\-20 20:12:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
a172f9de84 Merge pull request \fI\%#48226\fP from terminalmage/fix\-alias\-docstring
.IP \(bu 2
fb237272f5 Don\(aqt display \(dqNone\(dq in SaltInvocationError when Salt installed using \-OO
.IP \(bu 2
90c90f5d5c Fix docstring construction in alias_function when Salt installed using \-OO
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48227\fP: (\fI\%Ch3LL\fP) Skip new sha256 files on repo.saltstack.com/windows
@ \fI2018\-06\-20 20:12:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
c6a0207cae Merge pull request \fI\%#48227\fP from Ch3LL/fix_win_tests
.IP \(bu 2
236773e3e9 Skip new sha256 files on repo.saltstack.com/windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48128\fP: (\fI\%bowmanjd\-lms\fP) apk.py Python 3 compatibility (refs: \fI\%#48131\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48131\fP: (\fI\%bowmanjd\-lms\fP) Fix py3\-incompatible dict.keys()[x] call in apk.py
@ \fI2018\-06\-19 18:19:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
6929423528 Merge pull request \fI\%#48131\fP from bowmanjd\-lms/fix\-apk\-python3
.IP \(bu 2
f5d2835299 Merge branch \(aq2017.7\(aq into fix\-apk\-python3
.IP \(bu 2
022f9cba50 Fix py3\-incompatible dict.keys()[x] call in apk.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47901\fP: (\fI\%frogunder\fP) 2017.7.6 \- Exiting command with CTRL\-C gives Error/Traceback (refs: \fI\%#48185\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48185\fP: (\fI\%DmitryKuzmenko\fP) Don\(aqt call .exception() on future unless it\(aqs done.
@ \fI2018\-06\-19 18:16:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
868c17377f Merge pull request \fI\%#48185\fP from DSRCorporation/bugs/47901_future_done_exception
.IP \(bu 2
5f63316311 Merge branch \(aq2017.7\(aq into bugs/47901_future_done_exception
.IP \(bu 2
9f2dbf94cb Don\(aqt call .exception() on future unless it\(aqs done.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48192\fP: (\fI\%twangboy\fP) Use the \-\-disable\-pip\-version\-check option (2017.7)
@ \fI2018\-06\-19 18:13:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
80a3e37c2e Merge pull request \fI\%#48192\fP from twangboy/fix_pip_version_2017.7
.IP \(bu 2
59ae2cc5fc Use \-\-disable\-pip\-version\-check for build_env_#.ps1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48201\fP: (\fI\%zer0def\fP) Fixes to LXC bootstrap when alternate lxcpath is provided.
@ \fI2018\-06\-19 12:56:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
12e2b8882a Merge pull request \fI\%#48201\fP from zer0def/lxc\-bootstrap\-fixes
.IP \(bu 2
6f6d3d40d4 Take lxcpath into account when bootstrapping new containers. Version comparison fixes.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48190\fP: (\fI\%terminalmage\fP) Fix mount.vfstab unit test
@ \fI2018\-06\-18 21:47:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
e079fce38d Merge pull request \fI\%#48190\fP from terminalmage/fix\-vfstab\-test
.IP \(bu 2
8d70d14362 Fix mount.vfstab unit test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48115\fP: (\fI\%KaiSforza\fP) Add jenkinsfiles to define tests in 2017
@ \fI2018\-06\-18 21:27:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
c8b9cec986 Merge pull request \fI\%#48115\fP from KaiSforza/pr\-lint\-2017
.IP \(bu 2
494727ab39 Add docs, kitchen tests
.IP \(bu 2
317023bb20 Move .jenkins to .ci for future
.IP \(bu 2
dedc313cee Make it parallel so we don\(aqt fail right away
.IP \(bu 2
cd13426726 Add a .jenkins file to run pylint
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48174\fP: (\fI\%terminalmage\fP) Add docker.update_mine config option
@ \fI2018\-06\-18 19:04:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc1752b721 Merge pull request \fI\%#48174\fP from terminalmage/docker\-update\-mine
.IP \(bu 2
9af09e0127 Mock config.get due to changes in _refresh_mine_cache
.IP \(bu 2
c5802ad465 Fix the version number in versionadded
.IP \(bu 2
d403ae58d7 Add unit test for docker.update_mine
.IP \(bu 2
44c275698a Actually it\(aqs more than just add/remove that updates the mine
.IP \(bu 2
0cb6996b07 Add release notes mention of docker.update_mine config option
.IP \(bu 2
de05097b20 Add docs for new config option
.IP \(bu 2
04c55a9178 Add note in mine.get_docker docstring about new config item
.IP \(bu 2
4e456255c0 Allow mine update to be disabled using new config option
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47031\fP: (\fI\%lejambon\fP) Cannot set hwclock on UTC on CentOS 7 (refs: \fI\%#47049\fP, \fI\%#48061\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48061\fP: (\fI\%garethgreenaway\fP) [2017.7] Porting \fI\%#47049\fP to 2017.7.
@ \fI2018\-06\-15 17:15:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47049\fP: (\fI\%lejambon\fP) Centos set utc hwclock (refs: \fI\%#48061\fP)
.IP \(bu 2
df2a156338 Merge pull request \fI\%#48061\fP from garethgreenaway/port_47049_2017_7
.IP \(bu 2
7c472fed51 Fixing failing test_set_hwclock_aix test.
.IP \(bu 2
ccb0acc958 Porting \fI\%#47049\fP to 2017.7.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48143\fP: (\fI\%Ch3LL\fP) Add timeout argument to run_salt for ShellCase
@ \fI2018\-06\-15 17:04:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
5ec3cf2dd4 Merge pull request \fI\%#48143\fP from Ch3LL/fix_long_job
.IP \(bu 2
48b5d2e9d3 Add timeout argument to run_salt for ShellCase
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48135\fP: (\fI\%rallytime\fP) Update the 2017.7.7 and 2017.7.8 release notes
@ \fI2018\-06\-14 21:22:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48134\fP: (\fI\%rallytime\fP) Add release notes file for 2017.7.7 (refs: \fI\%#48135\fP)
.IP \(bu 2
e1e566d1f8 Merge pull request \fI\%#48135\fP from rallytime/release\-notes\-2017.7
.IP \(bu 2
7a97f157b3 Add missing \fIv\fP for tag reference
.IP \(bu 2
2f2b69ed37 Add \(dqin progress\(dq notation to 2017.7.7 release notes
.IP \(bu 2
06a1151a63 Add release notes file for 2017.7.7
.IP \(bu 2
885b2862ce Move 2017.7.7 release notes to 2017.7.8
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48105\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.6 to 2017.7
@ \fI2018\-06\-14 17:00:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
ac9dabbfaa Merge pull request \fI\%#48105\fP from rallytime/merge\-2017.7
.IP \(bu 2
cdb45874de Merge branch \(aq2017.7.6\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48101\fP: (\fI\%rallytime\fP) [2017.7] Update 2017.7.7 reference to 2017.7.8
@ \fI2018\-06\-14 13:14:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
2da56a69d9 Merge pull request \fI\%#48101\fP from rallytime/update\-doc\-refs\-2017.7
.IP \(bu 2
7ba6f5fb36 Update 2017.7.7 reference to 2017.7.8
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48091\fP: (\fI\%terminalmage\fP) Reverse monkeypatching after test_symlink_list finishes
@ \fI2018\-06\-13 18:02:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
5a0e3d46e7 Merge pull request \fI\%#48091\fP from terminalmage/fix\-file_roots\-monkeypatching
.IP \(bu 2
6fe711ad76 Reverse monkeypatching after test_symlink_list finishes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48088\fP: (\fI\%rallytime\fP) Update release versions for the 2017.7 branch
@ \fI2018\-06\-13 14:03:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
053b019a8f Merge pull request \fI\%#48088\fP from rallytime/update_version_doc_2017.7
.IP \(bu 2
1b8d1c936b Remove \(dqin progress\(dq info for 2017.7.6 release notes
.IP \(bu 2
9a0f4d190a Update release versions for the 2017.7 branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48038\fP: (\fI\%austinpapp\fP) jobs are not dedup\(aqing minion side (refs: \fI\%#48075\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48075\fP: (\fI\%garethgreenaway\fP) [2017.7] Ensure that the shared list of jids is passed
@ \fI2018\-06\-13 13:25:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
d6d2c5ee18 Merge pull request \fI\%#48075\fP from garethgreenaway/48038_jobs_are_not_deduping_minion_side
.IP \(bu 2
c537b3275b Ensure that the shared list of jids is passed when creating the Minion.  Fixes an issue when minions are pointed at multiple syndics.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48071\fP: (\fI\%terminalmage\fP) Fix inaccurate gitfs_saltenv example in GitFS Walkthrough
@ \fI2018\-06\-12 20:34:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
aa33cc0b0c Merge pull request \fI\%#48071\fP from terminalmage/gitfs\-docs
.IP \(bu 2
24545204b3 Fix inaccurate gitfs_saltenv example in GitFS Walkthrough
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#48039\fP: (\fI\%twellspring\fP) github.repo_present returns stacktrace, got multiple values for keyword argument profile (refs: \fI\%#48040\fP)
.IP \(bu 2
\fBPR\fP \fI\%#48053\fP: (\fI\%rallytime\fP) Back\-port \fI\%#48040\fP to 2017.7
@ \fI2018\-06\-12 14:46:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#48040\fP: (\fI\%twellspring\fP) states/github.py fix for incorrect positional argument (refs: \fI\%#48053\fP)
.IP \(bu 2
fb4ceacb88 Merge pull request \fI\%#48053\fP from rallytime/bp\-48040
.IP \(bu 2
265b22b194 states/github.py fix for incorrect positional argument
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48024\fP: (\fI\%gtmanfred\fP) add pytest coverage and xml junits
@ \fI2018\-06\-12 14:03:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
f37dcaac6d Merge pull request \fI\%#48024\fP from gtmanfred/2017.7
.IP \(bu 2
56b074ab27 allow specifying a different state to run on converge
.IP \(bu 2
cc9c4b4d5a add pytest coverage and xml junits
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48044\fP: (\fI\%twangboy\fP) Add fail code for WinHTTP send/receive error
@ \fI2018\-06\-11 13:49:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
ffee3576ec Merge pull request \fI\%#48044\fP from twangboy/wua_add_fail_code
.IP \(bu 2
d41d0c25eb Add faile code for WinHTTP send/receive error
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#48009\fP: (\fI\%dwoz\fP) minionswarm runs on windows
@ \fI2018\-06\-08 13:52:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
871a910fcb Merge pull request \fI\%#48009\fP from dwoz/winswarmfix
.IP \(bu 2
5027c7bb84 minionswarm runs on windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47968\fP: (\fI\%gtmanfred\fP) Clean up tox + pytest
@ \fI2018\-06\-06 21:23:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
0dcaead36d Merge pull request \fI\%#47968\fP from gtmanfred/2017.7
.IP \(bu 2
ae1b0d28bb pass LANG and HOME into tox commands
.IP \(bu 2
8d15b93d00 remove tox virtualenvs from doc tests
.IP \(bu 2
e1872e2036 simplify tox.ini
.IP \(bu 2
81bd01f5af add tests.txt for running tests with tox requirements
.IP \(bu 2
556a2067fc fix masterapi test to use testing directory for configs
.IP \(bu 2
5a41f484ef add EXPENSIVE_TESTS
.IP \(bu 2
055cd5a6ba set DESTRUCTIVE_TESTS environment variable for pytest
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47978\fP: (\fI\%twangboy\fP) Add try/finally, fix typo in 7zip def file
@ \fI2018\-06\-06 19:06:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
42dd6b83eb Merge pull request \fI\%#47978\fP from twangboy/fix_test_pkg
.IP \(bu 2
8bb36b3a4b Add try/finally, fix typo in 7zip def file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47959\fP: (\fI\%twangboy\fP) Fix failing test when service doesn\(aqt exist
@ \fI2018\-06\-06 19:05:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
a67b21ef3d Merge pull request \fI\%#47959\fP from twangboy/fix_test_service
.IP \(bu 2
0cd47aa81e Remove unused import
.IP \(bu 2
d4b42540e3 Fix failing test when service doesn\(aqt exist
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30367\fP: (\fI\%paulfanelli\fP) salt\-run orchestration via state.sls always successful; it is ignoring state return value (refs: \fI\%#47843\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47983\fP: (\fI\%garethgreenaway\fP) [2017.7] Backporting \fI\%#47843\fP
@ \fI2018\-06\-06 19:03:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47843\fP: (\fI\%garethgreenaway\fP) [2018.3] orchestration results False when function is False (refs: \fI\%#47983\fP)
.IP \(bu 2
b81d482067 Merge pull request \fI\%#47983\fP from garethgreenaway/backport_47843_2017_7
.IP \(bu 2
7b7fb1f5d5 Adding missing test sls file.
.IP \(bu 2
54e51bc627 Backporting \fI\%#47843\fP to 2017.7, updating test for 2017.7.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47533\fP: (\fI\%twangboy\fP) Fix issues with functions that use makedirs on Windows
@ \fI2018\-06\-06 17:20:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
d56ddad22c Merge pull request \fI\%#47533\fP from twangboy/fix_47178
.IP \(bu 2
24717cbc21 Change version added to 2017.7.7
.IP \(bu 2
0592f1bac2 Fix issues with functions that user makedirs on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47827\fP: (\fI\%twangboy\fP) Fix issue when archive is on mapped drive
@ \fI2018\-06\-06 17:18:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
5c56b8c755 Merge pull request \fI\%#47827\fP from twangboy/fix_47791
.IP \(bu 2
fbbd91f09e Add more descriptive debug message
.IP \(bu 2
365f81651b Fix deprecated exception handling
.IP \(bu 2
8dd6710b93 Use local instead of network
.IP \(bu 2
980d99d74b Fix issue when archive is on mapped drive
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47888\fP: (\fI\%mbunkus\fP) postfix.set_main overwrites wrong keys (refs: \fI\%#47966\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47966\fP: (\fI\%mbunkus\fP) Fix postfix.set_main\(aqs assumption of prefix\-free key names
@ \fI2018\-06\-06 15:43:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
998a1c13d5 Merge pull request \fI\%#47966\fP from mbunkus/fix\-postfix\-prefix\-free\-key\-names\-assumption
.IP \(bu 2
0ae402d1b5 Fix postfix.set_main\(aqs assumption of prefix\-free key names
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47824\fP: (\fI\%twangboy\fP) Fix issues with setup.py in Windows
@ \fI2018\-06\-05 17:39:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
df50ce7b1b Merge pull request \fI\%#47824\fP from twangboy/fix_setup.py
.IP \(bu 2
4538b3abb3 Remove \(aqlen\-as\-condition\(aq disablement
.IP \(bu 2
d4efcc3c8b Skip lint errors
.IP \(bu 2
1b3977f8d4 Remove m2crypto download for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47922\fP: (\fI\%damon\-atkins\fP) win_pkg: pkg.refresh_db verbose=True PY3 compatibility fix
@ \fI2018\-06\-05 13:31:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e91a31134 Merge pull request \fI\%#47922\fP from damon\-atkins/2017.7_win_pkg_keys_fix
.IP \(bu 2
7129203b1b Merge branch \(aq2017.7\(aq into 2017.7_win_pkg_keys_fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47933\fP: (\fI\%terminalmage\fP) Clarify pillar.get docs
@ \fI2018\-06\-04 14:07:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
8008fca2f6 Merge pull request \fI\%#47933\fP from terminalmage/add\-pillar.get\-docs
.IP \(bu 2
4eb022b675 Clarify pillar.get docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47944\fP: (\fI\%terminalmage\fP) Replace use of deprecated argument name in git.detached docstring
@ \fI2018\-06\-04 13:53:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab565bfaa3 Merge pull request \fI\%#47944\fP from terminalmage/fix\-git.detached\-docs
.IP \(bu 2
1d082b4389 Replace use of deprecated argument name in git.detached docstring
.IP \(bu 2
6253793cb6 Merge branch \(aq2017.7\(aq into 2017.7_win_pkg_keys_fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47860\fP: (\fI\%terminalmage\fP) Clean up doc build warnings, add best practices for writing states
@ \fI2018\-06\-01 14:42:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
a2b588299b Merge pull request \fI\%#47860\fP from terminalmage/state\-writing\-docs
.IP \(bu 2
8cb33d3dec Quiet the linter
.IP \(bu 2
af51e16f23 Use more elegant RST syntax
.IP \(bu 2
91cd57d1e0 Update mocking to reflect changes in service module
.IP \(bu 2
b9ace5a859 Fix crappy mocking
.IP \(bu 2
bc9e3acef3 Lint fixes
.IP \(bu 2
d37f7e4f04 Add 2017.7.6 release notes
.IP \(bu 2
9dddeeefab Improve documentation on syncing states
.IP \(bu 2
f465fa3ca7 Add best practices docs for writing states
.IP \(bu 2
93ee5ee2b0 Fix all Sphinx warnings
.IP \(bu 2
64b9b4d0b8 Clarify that name would override the id declaration
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47877\fP: (\fI\%dwoz\fP) Revert job chunk wait time change
@ \fI2018\-06\-01 14:11:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
d2f3377b5b Merge pull request \fI\%#47877\fP from dwoz/sleep_audit
.IP \(bu 2
ebc7cde9cb Revert job chunk wait time change
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
4ce0fe6546 win_pkg under py3 keys returns a view instead of a list, wrap keys in list()
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47917\fP: (\fI\%dwoz\fP) Fix windows tests suite breakage
@ \fI2018\-06\-01 11:42:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47500\fP: (\fI\%dwoz\fP) Get the current username on windows (refs: \fI\%#47917\fP)
.IP \(bu 2
735e92093e Merge pull request \fI\%#47917\fP from dwoz/winsuite
.IP \(bu 2
118601ebd6 Fix windows tests suite breakage
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47822\fP: (\fI\%Ch3LL\fP) Add user state integration tests to windows
@ \fI2018\-05\-30 21:13:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
63efb76d51 Merge pull request \fI\%#47822\fP from Ch3LL/win_user_test
.IP \(bu 2
3a691b405f add user_home path for both windows and linux
.IP \(bu 2
788abf771e Add user state integration tests to windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47876\fP: (\fI\%doesitblend\fP) Add file read windows
@ \fI2018\-05\-30 14:03:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
b9da4f1221 Merge pull request \fI\%#47876\fP from doesitblend/add\-file\-read\-windows
.IP \(bu 2
3f7e7ec327 Add file.read function to Windows module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47882\fP: (\fI\%frogunder\fP) add whoami test
@ \fI2018\-05\-30 13:47:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
cbe2ecfae8 Merge pull request \fI\%#47882\fP from frogunder/45013
.IP \(bu 2
38d114a2d2 add whoami test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47853\fP: (\fI\%dwoz\fP) Fix for py3 ec2 cloud tests
@ \fI2018\-05\-28 23:08:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
4b28e510f1 Merge pull request \fI\%#47853\fP from dwoz/py3\-cloud\-test
.IP \(bu 2
c2f8aef7c5 Fix for py3 ec2 cloud tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47833\fP: (\fI\%blefeuvr\fP) reactor.add | list | delete \-> python exception (refs: \fI\%#47847\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47847\fP: (\fI\%garethgreenaway\fP) [2017.7] reactor runner documentation
@ \fI2018\-05\-25 23:23:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
215efa6b73 Merge pull request \fI\%#47847\fP from garethgreenaway/47833_reactor_runner_documentation
.IP \(bu 2
03676712de Adding some addition documentation to the reactor runner indicating that the reactor system must be active prior to using it.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47846\fP: (\fI\%Ch3LL\fP) Fix flaky refresh pillar integration test
@ \fI2018\-05\-25 20:50:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
0bf651b470 Merge pull request \fI\%#47846\fP from Ch3LL/p_refresh_test
.IP \(bu 2
019edad8e4 Fix flaky refresh pillar integration test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47552\fP: (\fI\%twangboy\fP) Show GPO settings, raise error if trying to set gpo managed settings
@ \fI2018\-05\-25 20:41:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
799fce979d Merge pull request \fI\%#47552\fP from twangboy/fix_46981
.IP \(bu 2
cffc9b7806 Merge branch \(aq2017.7\(aq into fix_46981
.IP \(bu 2
81308a4a44 Add release notes for 2017.7.7
.IP \(bu 2
008af0ac6b Fix unit tests
.IP \(bu 2
87097eefb6 Add comments about how get is returning data
.IP \(bu 2
f1f1bfc5c1 Show GPO settings, raise error if trying to set gpo managed settings
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47690\fP: (\fI\%lomeroe\fP) productname grain missing on Solaris (refs: \fI\%#47691\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47691\fP: (\fI\%lomeroe\fP) Update regexes for Solaris \(aqproduct\(aq grain and copy to \(aqproductname\(aq grain
@ \fI2018\-05\-25 20:38:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
ffc2ebc373 Merge pull request \fI\%#47691\fP from lomeroe/solaris_product_grains
.IP \(bu 2
6889befc6b Merge branch \(aq2017.7\(aq into solaris_product_grains
.IP \(bu 2
49053bc106 lint fix
.IP \(bu 2
6f185c9179 another lint fix
.IP \(bu 2
dbffba6876 fix tons of errors in my tests
.IP \(bu 2
8c9355d34c Lint fix
.IP \(bu 2
b29ec75da7 Update regexes in core grains for detecting the \(aqproduct\(aq grain on Solaris Sparc systems.  Additionally, copy the \(aqproduct\(aq grain to \(aqproductname\(aq to be consistent with other OSes.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47778\fP: (\fI\%Ch3LL\fP) Add test_pkg integration state tests to windows
@ \fI2018\-05\-25 20:36:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
96b7c0cc76 Merge pull request \fI\%#47778\fP from Ch3LL/win_state_pkg
.IP \(bu 2
e1786de6b0 Merge branch \(aq2017.7\(aq into win_state_pkg
.IP \(bu 2
f8c467d3e6 Fix text editor error
.IP \(bu 2
872e162137 Add test_pkg integration state tests to windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47823\fP: (\fI\%Ch3LL\fP) Add win_dns module integration tests for windows
@ \fI2018\-05\-25 20:34:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
6f934c2259 Merge pull request \fI\%#47823\fP from Ch3LL/win_dns_test
.IP \(bu 2
7848114d6a Add win_dns module integration tests for windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47838\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47810\fP to 2017.7
@ \fI2018\-05\-25 20:33:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47810\fP: (\fI\%rmcintosh\fP) Fix Linode plan selection (refs: \fI\%#47838\fP)
.IP \(bu 2
e63e04602d Merge pull request \fI\%#47838\fP from rallytime/bp\-47810
.IP \(bu 2
bd2b62fa66 better debug message
.IP \(bu 2
83565c55df Address PR feedback
.IP \(bu 2
50bce3a2f3 make decode_linode_plan_label a private function
.IP \(bu 2
2ba4fc4cea fix raising when a \(aqGB\(aq format invalid plan is supplied
.IP \(bu 2
3afb50d5a2 slight cleanup
.IP \(bu 2
319fbd3406 match quotation mark types properly
.IP \(bu 2
95e0202223 more consistent use of parens in logged warning
.IP \(bu 2
f52926ca87 log a warning when the user supplied a label we could decode but was not in the proper format
.IP \(bu 2
121303d827 reduce complexity of get_plan_id by moving decoding of the user\-supplied label to its own function
.IP \(bu 2
cf534c7314 Fix Linode plan selection
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47805\fP: (\fI\%twangboy\fP) Add sign.bat script for signing packages
@ \fI2018\-05\-25 13:53:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
9ef6e60617 Merge pull request \fI\%#47805\fP from twangboy/add_sign.bat
.IP \(bu 2
66d8b0331a Add sign.bat script for signing packages
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47500\fP: (\fI\%dwoz\fP) Get the current username on windows (refs: \fI\%#47917\fP)
@ \fI2018\-05\-24 19:14:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
93420950d3 Merge pull request \fI\%#47500\fP from dwoz/winuser
.IP \(bu 2
0ca5224cbf Merge branch \(aq2017.7\(aq into winuser
.IP \(bu 2
e5948902af Use salt utils method for this_user
.IP \(bu 2
a056a293f1 Centeralize test username lookup
.IP \(bu 2
6a6ab69722 Get the current username on windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35960\fP: (\fI\%basepi\fP) Beacons cannot be reloaded/refreshed without minion restart (refs: \fI\%#40892\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47802\fP: (\fI\%rallytime\fP) Back\-port \fI\%#40892\fP to 2017.7
@ \fI2018\-05\-24 16:34:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40892\fP: (\fI\%jagguli\fP) add minion function to reload beacon \fI\%#35960\fP (refs: \fI\%#47802\fP)
.IP \(bu 2
552526f309 Merge pull request \fI\%#47802\fP from rallytime/bp\-40892
.IP \(bu 2
bb357da084 add minion function to reload beacon \fI\%#35960\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47816\fP: (\fI\%Ch3LL\fP) Add windows to service disable ERROR check in tests
@ \fI2018\-05\-24 15:31:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
c9cccf53b9 Merge pull request \fI\%#47816\fP from Ch3LL/disable_windows
.IP \(bu 2
2509d36888 Add windows to service disable ERROR check in tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47773\fP: (\fI\%frogunder\fP) add win_servermanager.list_available test
@ \fI2018\-05\-23 19:44:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
2cb6634c6b Merge pull request \fI\%#47773\fP from frogunder/45011
.IP \(bu 2
7c9b0bda33 add win_servermanager.list_available test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47807\fP: (\fI\%dwoz\fP) Try an even bigger timeout
@ \fI2018\-05\-23 19:38:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
e65dece202 Merge pull request \fI\%#47807\fP from dwoz/winrmtests
.IP \(bu 2
1f1cc1357a Increase instance size for cloud tests
.IP \(bu 2
be8dcd21f1 Try an even bigger timeout
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47765\fP: (\fI\%meaksh\fP) Prevent zypper from parsing repo configuration from not .repo files
@ \fI2018\-05\-23 14:45:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
46618d2ce7 Merge pull request \fI\%#47765\fP from meaksh/2017.7\-fix\-zypper\-error\-reading\-repo
.IP \(bu 2
4475ba19b8 Prevent zypper from parsing repo configuration from not .repo files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47781\fP: (\fI\%rallytime\fP) Update cloud test profile and docs to use new Linode size labels
@ \fI2018\-05\-23 13:09:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
0e87559ee3 Merge pull request \fI\%#47781\fP from rallytime/update\-linode\-sizes
.IP \(bu 2
a90c1b760e Update cloud test profile and docs to use new Linode size labels
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47748\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.6 to 2017.7
@ \fI2018\-05\-22 20:53:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ddc56cb9b Merge pull request \fI\%#47748\fP from rallytime/merge\-2017.7
.IP \(bu 2
b75f5ae38e Merge branch \(aq2017.7.6\(aq into \(aq2017.7\(aq
.IP \(bu 2
17596f3025 Merge branch \(aq2017.7.6\(aq into \(aq2017.7\(aq
.IP \(bu 2
e458f4a031 Merge branch \(aq2017.7.6\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47779\fP: (\fI\%dwoz\fP) Increase ec2 cloud timeouts to 1000
@ \fI2018\-05\-22 20:35:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
0ddc864f90 Merge pull request \fI\%#47779\fP from dwoz/winrmtests
.IP \(bu 2
d5eafe9d53 Use common timeout variable
.IP \(bu 2
7e948eb540 Increase ec2 cloud timeouts to 1000
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47430\fP: (\fI\%baniobloom\fP) Add catch for VPCAssociationNotFound
@ \fI2018\-05\-22 14:54:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
17c4c8443c Merge pull request \fI\%#47430\fP from baniobloom/vpc_association_not_found
.IP \(bu 2
0f1d007f91 added catch for VPCAssociationNotFound
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47525\fP: (\fI\%baniobloom\fP) Trying to add a duplicate sec group rule true
@ \fI2018\-05\-22 14:51:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
9c5dde1449 Merge pull request \fI\%#47525\fP from baniobloom/duplicate_sec_group_rule
.IP \(bu 2
dcc35df489 if we are trying to add the same rule then we are already in the desired state, return true
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47772\fP: (\fI\%gtmanfred\fP) lock down dependencies for kitchen\-salt
@ \fI2018\-05\-22 14:21:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
536ce2fa42 Merge pull request \fI\%#47772\fP from gtmanfred/2017.7
.IP \(bu 2
67756a50fd lock down dependencies for kitchen\-salt
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47717\fP: (\fI\%server\-monitoring\fP) Invalid output of pkg.list_upgrades on Fedora 27 Server (refs: \fI\%#47749\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47749\fP: (\fI\%terminalmage\fP) Fix \(dqdnf list upgrades\(dq parsing
@ \fI2018\-05\-22 12:51:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
12b330f049 Merge pull request \fI\%#47749\fP from terminalmage/issue47717
.IP \(bu 2
cd484bef69 Fix \(dqdnf list upgrades\(dq parsing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47755\fP: (\fI\%dwoz\fP) Be explicit about winrm setting
@ \fI2018\-05\-21 22:39:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
5cd18b9e70 Merge pull request \fI\%#47755\fP from dwoz/winrmtests
.IP \(bu 2
57dd89e6c3 Default to ec2 classic compatible images
.IP \(bu 2
f89668920a Be explicit about winrm setting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47668\fP: (\fI\%Ch3LL\fP) Add pkg.latest_version windows test
@ \fI2018\-05\-21 20:26:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
f45a96ba1d Merge pull request \fI\%#47668\fP from Ch3LL/win_pkg_test
.IP \(bu 2
a8981024de Add pkg.latest_version windows test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47750\fP: (\fI\%dwoz\fP) Allow ssh_interface to default to public_ips
@ \fI2018\-05\-21 17:14:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
7b12444dfa Merge pull request \fI\%#47750\fP from dwoz/cloudtest
.IP \(bu 2
63b722ba21 Allow ssh_interface to default to public_ips
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47737\fP: (\fI\%dwoz\fP) Cloud test fixup
@ \fI2018\-05\-21 14:19:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
27fbb42210 Merge pull request \fI\%#47737\fP from dwoz/win_timeout
.IP \(bu 2
e88833a07d Cloud test fixup
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47729\fP: (\fI\%UtahDave\fP) fix cli example to match function name
@ \fI2018\-05\-19 11:31:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a93f060fb Merge pull request \fI\%#47729\fP from UtahDave/fix_get_info_doc
.IP \(bu 2
443a2d72a2 fix cli example to match function name
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47182\fP: (\fI\%MartinEmrich\fP) state.highstate error with require_in: sls:  (refs: \fI\%#47682\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47682\fP: (\fI\%terminalmage\fP) Fix traceback when excludes are present in an included SLS file
@ \fI2018\-05\-18 16:47:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
00a13761c7 Merge pull request \fI\%#47682\fP from terminalmage/issue47182
.IP \(bu 2
d0243e8f23 Suppress spurious lint failure
.IP \(bu 2
3b449f11fc Add regression test for excludes issue
.IP \(bu 2
28a7d2b81c Skip __exclude__ in find_sls_ids
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47696\fP: (\fI\%darkpixel\fP) 2017.7.5 zpool.present does not check for properties=None before attempting to enumerate properties (refs: \fI\%#47708\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47708\fP: (\fI\%darkpixel\fP) Wrap properties loop with a check for None.  Closes GH\-47696
@ \fI2018\-05\-18 15:25:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
518f7bcc62 Merge pull request \fI\%#47708\fP from darkpixel/47696\-do\-not\-enumerate\-none
.IP \(bu 2
54e9bf9ec9 Merge branch \(aq2017.7\(aq into 47696\-do\-not\-enumerate\-none
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47681\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.6 to 2017.7
@ \fI2018\-05\-17 21:30:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
cad062eaa7 Merge pull request \fI\%#47681\fP from rallytime/merge\-2017.7
.IP \(bu 2
6c06cb3ae3 Merge branch \(aq2017.7.6\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47683\fP: (\fI\%Ch3LL\fP) Remove unnecessary setUp in states.test_user test for mac
@ \fI2018\-05\-17 21:28:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd2d45d9c2 Merge pull request \fI\%#47683\fP from Ch3LL/mac_user_test
.IP \(bu 2
5a1b25b9c7 Remove unnecessary setUp in states.test_user test for mac
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47692\fP: (\fI\%dwoz\fP) Default windows to m1.small for ec2\-classic
@ \fI2018\-05\-17 14:44:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
f323799c42 Merge pull request \fI\%#47692\fP from dwoz/win_instance_type
.IP \(bu 2
20b6070d54 Default windows to m1.small for ec2\-classic
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45125\fP: (\fI\%wes\-novack\fP) salt\-cloud no longer picking up master setting from provider file (refs: \fI\%#47665\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47665\fP: (\fI\%gtmanfred\fP) use dictupdate to update the providers dictionary and merge lists
@ \fI2018\-05\-16 15:59:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
990ece5cd5 Merge pull request \fI\%#47665\fP from gtmanfred/cloud
.IP \(bu 2
fd8a02decb use dictupdate to update the providers dictionary and merge lists
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47151\fP: (\fI\%zer0def\fP) Allow interaction with default section in ConfigParser serializer
@ \fI2018\-05\-16 13:53:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
a2ed8cbb7f Merge pull request \fI\%#47151\fP from zer0def/configparser\-defaultsect
.IP \(bu 2
a8f2ad977e Merge branch \(aq2017.7\(aq into configparser\-defaultsect
.IP \(bu 2
cca2a806c9 Made interaction with [DEFAULT] section in ConfigParser as sane as upstream permits.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40846\fP: (\fI\%ghost\fP) file.managed fails for long URLs (refs: \fI\%#45808\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47673\fP: (\fI\%terminalmage\fP) Backport \fI\%#45808\fP to 2017.7
@ \fI2018\-05\-16 13:52:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45808\fP: (\fI\%b1naryth1ef\fP) [bugfix] Fix for oversized filenames in fileclient (refs: \fI\%#47673\fP)
.IP \(bu 2
e6fb8342ef Merge pull request \fI\%#47673\fP from terminalmage/bp\-45808
.IP \(bu 2
454291ad62 Fix errors when attempting to cache files with long names or URLs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47670\fP: (\fI\%gtmanfred\fP) add a pytest.ini and update a dependency for kitchen
@ \fI2018\-05\-16 01:56:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
b0446aab07 Merge pull request \fI\%#47670\fP from gtmanfred/2017.7
.IP \(bu 2
dfd5a8715f add a pytest.ini and update a dependency for kitchen
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47626\fP: (\fI\%gtmanfred\fP) Implement Pipfile and remove extra requirements.txt files
@ \fI2018\-05\-16 00:03:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d06da6944 Merge pull request \fI\%#47626\fP from gtmanfred/2017.7
.IP \(bu 2
418364a533 make dev_python27.txt have the same message as dev_python34.txt
.IP \(bu 2
d53b44d10f remove lock file
.IP \(bu 2
493ed7f93d use the toml dict format
.IP \(bu 2
e0f7cc1447 add proxy tests decorator to pytest conftest
.IP \(bu 2
0a621dd0ec add Pipfile for managing dependencies in salt
.IP \(bu 2
f78b81db94 simplify dev and base.txt to single files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47578\fP: (\fI\%Ch3LL\fP) Ensure mac_service.disabled is correctly querying services
@ \fI2018\-05\-15 18:26:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
a07a8906a0 Merge pull request \fI\%#47578\fP from Ch3LL/mac_service_disabled
.IP \(bu 2
6032a01f55 change disable check for upstart service on ubuntu14
.IP \(bu 2
33b4cfbc5b Change service assertion check for systemd platforms
.IP \(bu 2
14896f9743 change codeauthor and class name
.IP \(bu 2
502c5bdff5 Ensure mac_service.disabled is correctly querying services
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47639\fP: (\fI\%rallytime\fP) [2017.7] Merge forward from 2017.7.6 to 2017.7
@ \fI2018\-05\-14 17:58:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
f63d801858 Merge pull request \fI\%#47639\fP from rallytime/merge\-2017.7
.IP \(bu 2
1503f1020f Merge branch \(aq2017.7.6\(aq into \(aq2017.7\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47643\fP: (\fI\%dwoz\fP) Remove unwanted file
@ \fI2018\-05\-14 17:53:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
db0eef3e8b Merge pull request \fI\%#47643\fP from dwoz/runas_detect
.IP \(bu 2
8c5e54b8b3 Fix typo
.IP \(bu 2
69bc88f1c6 Remove unwanted file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47601\fP: (\fI\%dwoz\fP) Skip tests when we can not use runas
@ \fI2018\-05\-14 15:26:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
6dd3ab9f06 Merge pull request \fI\%#47601\fP from dwoz/runas_detect
.IP \(bu 2
3235ac08cb use ignore\-undefined\-variable
.IP \(bu 2
58911d510a Ignore pylint WindowsError
.IP \(bu 2
17987d3c5a Better doc string
.IP \(bu 2
a48ac26573 Skip tests when we can not use runas
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47611\fP: (\fI\%Ch3LL\fP) Update debian install docs to reflect new latest debian releases
@ \fI2018\-05\-11 16:32:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
f61ccae627 Merge pull request \fI\%#47611\fP from Ch3LL/deb_doc
.IP \(bu 2
6d2ddd050f One more grammar fixup
.IP \(bu 2
2d5ff01261 Grammar fix
.IP \(bu 2
138847c9c4 Update debian install docs to reflect new latest debian releases
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47598\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47568\fP to 2017.7
@ \fI2018\-05\-10 22:06:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47568\fP: (\fI\%terminalmage\fP) salt.serializers.yaml/yamlex: remove invalid multi_constructor (refs: \fI\%#47598\fP)
.IP \(bu 2
9e2fe284e4 Merge pull request \fI\%#47598\fP from rallytime/bp\-47568\-2017.7
.IP \(bu 2
09458c65cf Add exception logging on serialize/deserialize exceptions
.IP \(bu 2
c62c855f9c salt.serializers.yaml/yamlex: remove invalid multi_constructor
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47548\fP: (\fI\%Ch3LL\fP) Catch Sysloghandler errors when log file does not exist
@ \fI2018\-05\-10 20:23:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
8a7913ccc3 Merge pull request \fI\%#47548\fP from Ch3LL/syslog
.IP \(bu 2
31f13a4197 sysloghander: check for 3.5.4 python version
.IP \(bu 2
a020352a03 Catch Sysloghandler errors when log file does not exist
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47491\fP: (\fI\%doc987\fP) mysql_query.run_file Doesn\(aqt Work when query_file = salt://... (refs: \fI\%#47508\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47508\fP: (\fI\%gtmanfred\fP) allow pulling the mysql_query.run_file to pull from the fileserver
@ \fI2018\-05\-10 18:12:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
82fb6ba366 Merge pull request \fI\%#47508\fP from gtmanfred/2017.7
.IP \(bu 2
1a87e7455f allow pulling the mysql_query.run_file to pull from the fileserver
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47203\fP: (\fI\%aesposito91\fP) NAPALM grains not updating (refs: \fI\%#47513\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#46546\fP: (\fI\%ppalmieri\fP) salt\-minion installed on vEOS does not give vendor grain (refs: \fI\%#47513\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47562\fP: (\fI\%rallytime\fP) Back\-port \fI\%#47513\fP to 2017.7
@ \fI2018\-05\-10 15:19:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#47513\fP: (\fI\%frankiexyz\fP) Fix \fI\%#46546\fP eos napalm\(aqs grains issue  (refs: \fI\%#47562\fP)
.IP \(bu 2
be29b58a09 Merge pull request \fI\%#47562\fP from rallytime/bp\-47513
.IP \(bu 2
357bc084b3 fix \fI\%#46546\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47471\fP: (\fI\%meaksh\fP) Fix inconsistency with \(dqjid\(dq on minion scheduled jobs and the returners output
@ \fI2018\-05\-09 18:20:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
d3121fcfa4 Merge pull request \fI\%#47471\fP from meaksh/2017.7\-fix\-inconsistent\-scheduled\-jid\-with\-returners
.IP \(bu 2
f079939500 Do not override jid on returners, only sending back to master
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47313\fP: (\fI\%Circuitsoft\fP) Add Poky/Yocto support
@ \fI2018\-05\-09 17:31:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
662f6086db Merge pull request \fI\%#47313\fP from Circuitsoft/2017.7
.IP \(bu 2
237560b745 Merge branch \(aq2017.7\(aq into 2017.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47540\fP: (\fI\%terminalmage\fP) Fix corner case where runas user\(aqs HOME env value is incorrect
@ \fI2018\-05\-08 20:31:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
291d3d3bd8 Merge pull request \fI\%#47540\fP from terminalmage/cmdmod\-home\-fix
.IP \(bu 2
e4b277f82e Fix corner case where runas user\(aqs HOME env value is incorrect
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24148\fP: (\fI\%abng88\fP) Update gitfs docs to include tutorial on how to configure gitfs for salt\-call (masterless) (refs: \fI\%#47547\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47547\fP: (\fI\%terminalmage\fP) Add masterless mode docs to gitfs tutorial
@ \fI2018\-05\-08 20:24:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
49af577b3e Merge pull request \fI\%#47547\fP from terminalmage/gitfs\-tutorial
.IP \(bu 2
806ffb298a Add masterless mode docs to gitfs tutorial
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47538\fP: (\fI\%terminalmage\fP) Fix/clarify some of the pip module documentation
@ \fI2018\-05\-08 15:24:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
476ba053d1 Merge pull request \fI\%#47538\fP from terminalmage/pip\-docs
.IP \(bu 2
98e8ffeba4 Fix/clarify some of the pip module documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47524\fP: (\fI\%dwoz\fP) Gracefully handle blank lines in whitelist.txt
@ \fI2018\-05\-08 15:04:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
7cc8d9d30a Merge pull request \fI\%#47524\fP from dwoz/whitelistlines
.IP \(bu 2
2605ff8712 Gracefully handle blank lines in whitelist.txt
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47527\fP: (\fI\%dwoz\fP) Test file name
@ \fI2018\-05\-07 22:02:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
f1a5b13072 Merge pull request \fI\%#47527\fP from dwoz/test_file_name
.IP \(bu 2
4aea7ca571 Update doc string
.IP \(bu 2
b3289e5a1c Fix test file name
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47408\fP: (\fI\%Ch3LL\fP) Skip status.diskusage integration tests on macsox
@ \fI2018\-05\-07 19:06:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
e9c1723175 Merge pull request \fI\%#47408\fP from Ch3LL/skip_diskusage
.IP \(bu 2
068da8ad7d Merge branch \(aq2017.7\(aq into skip_diskusage
.IP \(bu 2
1a7ffb4e0d return error if diskusage not available
.IP \(bu 2
10bd63a976 Skip status.diskusage integration tests on macsox
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47480\fP: (\fI\%baniobloom\fP) added handling for the aws error ConflictingDomainExists
@ \fI2018\-05\-07 19:05:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
2f50ff7bc8 Merge pull request \fI\%#47480\fP from baniobloom/ConflictingDomainExists
.IP \(bu 2
d22ed7dffa added handling for the aws error ConflictingDomainExists
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47444\fP: (\fI\%terminalmage\fP) Skip trying to render a template for a nonexistent SLS file
@ \fI2018\-05\-07 13:48:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
7f53be6e92 Merge pull request \fI\%#47444\fP from terminalmage/render_state\-spurious\-error
.IP \(bu 2
a1e9fe00fd Skip trying to render a template for a nonexistent SLS file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47478\fP: (\fI\%terminalmage\fP) Rename pip state test modules to match naming convention
@ \fI2018\-05\-07 13:13:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
50b9c4d79d Merge pull request \fI\%#47478\fP from terminalmage/rename\-pip\-state\-test
.IP \(bu 2
9f7a9ebebd Rename pip state test modules to match naming convention
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#47443\fP: (\fI\%skylerberg\fP) Input validation does not raise SaltInvocationError in win_dsc.py (refs: \fI\%#47505\fP)
.IP \(bu 2
\fBPR\fP \fI\%#47505\fP: (\fI\%dwoz\fP) Raise proper invocation errors
@ \fI2018\-05\-07 13:05:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
e78ac0f9b7 Merge pull request \fI\%#47505\fP from dwoz/win_dsc_fixes
.IP \(bu 2
d1fcb40d1c Raise proper invocation errors
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47499\fP: (\fI\%dwoz\fP) Move kill process tree and re\-use it
@ \fI2018\-05\-06 20:54:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d4d5047d8 Merge pull request \fI\%#47499\fP from dwoz/win_run_timeout_again
.IP \(bu 2
c6697b9f16 Move kill process tree and re\-use it
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#47493\fP: (\fI\%dwoz\fP) Add support for windows timeout to run_salt
@ \fI2018\-05\-06 05:34:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a4d0380b1 Merge pull request \fI\%#47493\fP from dwoz/win_run_timeout
.IP \(bu 2
fec1233dc4 Add support for windows timeout to run_salt
.IP \(bu 2
cb674fb1cb Enable opkg as pkgrepo handler on Poky
.IP \(bu 2
7a58fd157e Enable opkg on non\-NILinuxRT systems
.IP \(bu 2
139360c55f Add Poky to OS Information Grains
.IP \(bu 2
d74057224d Un\-normalize os_family in pkgrepo state
.IP \(bu 2
95d4488f01 Merge branch \(aq2017.7.6\(aq into 47696\-do\-not\-enumerate\-none
.IP \(bu 2
041e4c6ddb Wrap properties loop with a check for None.  Closes GH\-47696
.UNINDENT
.UNINDENT
.SS In Progress: Salt 2017.7.9 Release Notes
.sp
Version 2017.7.9 is an \fBunreleased\fP bugfix release for \fI\%2017.7.0\fP\&.
This release is still in progress and has not been released yet.
.SS Salt Cloud Features
.SS GCE Driver
.sp
The GCE salt cloud driver can now be used with GCE instance credentials by
setting the configuration parameters \fBservice_account_private_key\fP and
\fBservice_account_private_email\fP to an empty string.
.SS Salt 2016.11.0 Release Notes \- Codename Carbon
.SS New Features
.SS Docker Introspection and Configuration
.sp
Major additions have been made to the Docker support in 2016.11.0. The new
addition allows Salt to be executed within a Docker container without a
minion running or installed in the container. This allows states to
be run inside a container, but also all of Salt\(aqs remote execution
commands to be run inside docker containers as well. This makes
container introspection simple and powerful. See the tutorial on using
this new feature here:
.sp
See \fI\%Salt in Docker Containers\fP\&.
.SS Advanced Ceph Control
.sp
Our friends over at SUSE have delivered a powerful new tool to make the
deployment of Ceph storage systems using Salt very easy. These new Ceph
tools allow for a storage system to be easily defined using the new
\fIceph.quorum\fP state.
.SS Thorium Additions and Improvements
.sp
The Thorium advanced reactor has undergone extensive testing and updates.
These updates include many more Thorium states, a system for automating
key management, the ability to use Thorium to easily replace old
reactors and a great deal of stability and bug fixes.
.SS State Rollback Using Snapper
.sp
Rollback has been one of the most prevalent requests for Salt. We
have researched it extensively and concluded that the only way to
accomplish truly reliable rollback would be to execute it at
the filesystem layer. To accomplish this we have introduced Snapper
integration into Salt States.
.sp
Snapper is a tool which allows for simple and reliable snapshots
of the filesystem to be made. With the new \fIsnapper_states\fP option
set to \fITrue\fP in the minion config a snapshot will be made before
and after every Salt State run.
.sp
These snapshots can be viewed, managed and rolled back to via the
\fIsnapper\fP execution module.
.SS Preserve File Perms in File States
.sp
This feature has been requested for years, the ability to set a flag
and use the same file permissions for files deployed to a minion as
the permissions set to the file on the master. Just set the \fIkeep_mode\fP
option on any file management state to \fITrue\fP\&.
.SS Ponies!
.sp
We all agreed that cowsay was just not good enough, install the \fIponysay\fP
command and the new \fIpony\fP outputter will work. Fun for the whole family!
.SS Additional Features
.INDENT 0.0
.IP \(bu 2
Minions can run in stand\-alone mode to use beacons and engines without
having to connect to a master. (Thanks @adelcast!)
.IP \(bu 2
Added a \fBsalt\fP runner to allow running salt modules via salt\-run.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run salt.cmd test.ping
# call functions with arguments and keyword arguments
salt\-run salt.cmd test.arg 1 2 3 a=1
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
Added SSL support to Cassandra CQL returner.
SSL can be enabled by setting \fBssl_options\fP for the returner.
Also added support for specifying \fBprotocol_version\fP when establishing
cluster connection.
.IP \(bu 2
The \fBmode\fP parameter in the \fI\%file.managed\fP state, and the \fBfile_mode\fP parameter in the
\fI\%file.recurse\fP state, can both now be set
to \fBkeep\fP and the minion will keep the mode of the file from the Salt
fileserver. This works only with files coming from sources prefixed with
\fBsalt://\fP, or files local to the minion (i.e. those which are absolute
paths, or are prefixed with \fBfile://\fP). For example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/myapp/myapp.conf:
  file.managed:
    \- source: salt://conf/myapp/myapp.conf
    \- mode: keep

/var/www/myapp:
  file.recurse:
    \- source: salt://path/to/myapp
    \- dir_mode: 755
    \- file_mode: keep
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
The \fBjunos\fP state module is now available. It has all the functions
that are present in the \fBjunos\fP execution module.
.IP \(bu 2
The \fBjunos\fP state module is now available. It has all the functions
that are present in the \fBjunos\fP execution module.
.IP \(bu 2
The minion data cache is a pluggable data store now. It\(aqs configurable with
\fI\%cache\fP option. Default is \fBlocalfs\fP\&.
.IP \(bu 2
User names in \fBclient_acl\fP support glob matching now.
.UNINDENT
.SS New Top File Merging Strategy for States
.sp
A new strategy called \fBmerge_all\fP has been added to provide a new way of
merging top file matches when executing a \fI\%highstate\fP\&.
See the \fI\%top_file_merging_strategy\fP documentation for further
information.
.sp
In addition, the \fBsame\fP merging strategy was not functioning as documented.
This has now been corrected. While this is technically a bugfix, we decided to
hold a change in top file merging until a feature release to minimize user
impact.
.SS Improved Archive Extraction Support
.sp
The \fI\%archive.extracted\fP state has been
overhauled. Notable changes include the following:
.INDENT 0.0
.IP \(bu 2
When enforcing ownership (with the \fBuser\fP and/or \fBgroup\fP arguments), the
\fBif_missing\fP argument no longer has any connection to which path(s) have
ownership enforced. Instead, the paths are determined using the either the
newly\-added \fI\%archive.list\fP function, or
the newly\-added \fBenforce_ownership_on\fP argument.
.IP \(bu 2
\fBif_missing\fP also is no longer required to skip extraction, as Salt is now
able to tell which paths would be present if the archive were extracted. It
should, in most cases, only be necessary in cases where a semaphore file is
used to conditionally skip extraction of the archive.
.IP \(bu 2
Password\-protected ZIP archives are now detected before extraction, and the
state fails without attempting to extract the archive if no password was
specified.
.IP \(bu 2
By default, a single top\-level directory is enforced, to guard against
\(aqtar\-bombs\(aq. This enforcement can be disabled by setting \fBenforce_toplevel\fP
to \fBFalse\fP\&.
.IP \(bu 2
The \fBtar_options\fP and \fBzip_options\fP arguments have been deprecated in
favor of a single \fBoptions\fP argument.
.IP \(bu 2
The \fBarchive_format\fP argument is now optional. The ending of the \fBsource\fP
argument is used to guess whether it is a tar, zip or rar file. If the
\fBarchive_format\fP cannot be guessed, then it will need to be specified, but
in many cases it can now be omitted.
.IP \(bu 2
Ownership enforcement is now performed irrespective of whether or not the
archive needed to be extracted. This means that the state can be re\-run after
the archive has been fully extracted to repair changes to ownership.
.UNINDENT
.sp
A number of new arguments were also added. See the docs py:func:\fIdocs for the
archive.extracted state <salt.states.archive.extracted>\fP for more information.
.sp
Additionally, the following changes have been made to the \fI\%archive\fP execution module:
.INDENT 0.0
.IP \(bu 2
A new function (\fI\%archive.list\fP) has
been added. This function lists the files/directories in an archive file, and
supports a \fBverbose\fP argument that gives a more detailed breakdown of which
paths are files, which are directories, and which paths are at the top level
of the archive.
.IP \(bu 2
A new function (\fI\%archive.is_encrypted\fP) has been added. This function will
return \fBTrue\fP if the archive is a password\-protected ZIP file, \fBFalse\fP if
not. If the archive is not a ZIP file, an error will be raised.
.IP \(bu 2
\fI\%archive.cmd_unzip\fP now supports
passing a password, bringing it to feature parity with
\fI\%archive.unzip\fP\&. Note that this is
still not considered to be secure, and \fI\%archive.unzip\fP is recommended for dealing with
password\-protected ZIP archives.
.IP \(bu 2
The default value for the \fBextract_perms\fP argument to
\fI\%archive.unzip\fP has been changed to
\fBTrue\fP\&.
.UNINDENT
.SS Improved Checksum Handling in \fI\%file.managed\fP, \fI\%archive.extracted\fP States
.sp
When the \fBsource_hash\fP argument for these states refers to a file containing
checksums, Salt now looks for checksums matching the name of the source URI, as
well as the file being managed. Prior releases only looked for checksums
matching the filename being managed. Additionally, a new argument
(\fBsource_hash_name\fP) has been added, which allows the user to disambiguate
ambiguous matches when more than one matching checksum is found in the
\fBsource_hash\fP file.
.sp
A more detailed explanation of this functionality can be found in the
\fI\%file.managed\fP documentation, in the
section for the new \fBsource_hash_name\fP argument.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This improved functionality is also available in the \fB2016.3\fP (Boron)
release cycle, starting with the 2016.3.5 release.
.UNINDENT
.UNINDENT
.SS Config Changes
.sp
The following default config values were changed:
.INDENT 0.0
.IP \(bu 2
\fBgitfs_ssl_verify\fP: Changed from \fBFalse\fP to \fBTrue\fP
.IP \(bu 2
\fBgit_pillar_ssl_verify\fP: Changed from \fBFalse\fP to \fBTrue\fP
.IP \(bu 2
\fBwinrepo_ssl_verify\fP: Changed from \fBFalse\fP to \fBTrue\fP
.UNINDENT
.SS Grains Changes
.INDENT 0.0
.IP \(bu 2
All core grains containing \fBVMWare\fP have been changed to \fBVMware\fP, which
is the \fI\%official capitalization\fP\&.  Additionally,
all references to \fBVMWare\fP in the documentation have been changed to
\fBVMware\fP \fI\%issue 30807\fP\&.  Environments using versions of Salt before and
after Salt 2016.11.0 should employ case\-insensitive grain matching on these
grains.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
{% set on_vmware = grains[\(aqvirtual\(aq].lower() == \(aqvmware\(aq %}
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
On Windows the \fBcpu_model\fP grain has been changed to provide the actual cpu
model name and not the cpu family.
.sp
Old behavior:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
root@master:~# salt \(aqtestwin200\(aq grains.item cpu_model
testwin200:
    \-\-\-\-\-\-\-\-\-\-
    cpu_model:
        Intel64 Family 6 Model 58 Stepping 9, GenuineIntel
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
New behavior:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
root@master:~# salt \(aqtestwin200\(aq grains.item cpu_model
testwin200:
    \-\-\-\-\-\-\-\-\-\-
    cpu_model:
        Intel(R) Core(TM) i7\-3520M CPU @ 2.90GHz
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Beacons Changes
.INDENT 0.0
.IP \(bu 2
The \fBloadavg\fP beacon now outputs averages as integers instead of strings.
(Via \fI\%issue 31124\fP\&.)
.UNINDENT
.SS Runner Changes
.INDENT 0.0
.IP \(bu 2
Runners can now call out to \fI\%utility modules\fP
via \fB__utils__\fP\&.
.IP \(bu 2
ref:\fIUtility modules <writing\-utility\-modules>\fP (placed in
\fBsalt://_utils/\fP) are now able to be synced to the master, making it easier
to use them in custom runners. A \fI\%saltutil.sync_utils\fP function has been added to the
\fI\%saltutil runner\fP to facilitate the syncing of
utility modules to the master.
.UNINDENT
.SS Pillar Changes
.INDENT 0.0
.IP \(bu 2
Thanks to the new \fI\%saltutil.sync_utils\fP runner, it is now easier to get
ref:\fIutility modules <writing\-utility\-modules>\fP synced to the correct
location on the Master so that they are available in execution modules called
from Pillar SLS files.
.UNINDENT
.SS Junos Module Changes
.INDENT 0.0
.IP \(bu 2
The following new functionalities were added to the junos module
.INDENT 2.0
.IP \(bu 2
facts \- Displays the facts gathered during the connection.
.IP \(bu 2
shutdown \- Shut down or reboot a device running Junos OS.
.IP \(bu 2
install_config \- Modify the configuration of a Junos device.
.IP \(bu 2
install_os \- Install Junos OS software package.
.IP \(bu 2
zeroize \- Remove all configuration information on the Routing Engines and reset all key values on a device.
.IP \(bu 2
file_copy \- Copy file from proxy to the Junos device.
.UNINDENT
.UNINDENT
.SS Network Automation: NAPALM
.sp
Beginning with 2016.11.0, network automation is included by default in the core
of Salt. It is based on a the \fI\%NAPALM\fP
library and provides facilities to manage the configuration and retrieve data
from network devices running widely used operating systems such: JunOS, IOS\-XR,
eOS, IOS, NX\-OS etc.
.INDENT 0.0
.IP \(bu 2
see \fI\%the complete list of supported devices\fP\&.
.UNINDENT
.sp
The connection is established via the \fI\%NAPALM proxy\fP\&.
.sp
In the current release, the following modules were included:
.INDENT 0.0
.IP \(bu 2
\fI\%NAPALM grains\fP \- Select network devices based on their characteristics
.IP \(bu 2
\fI\%NET execution module\fP \- Networking basic features
.IP \(bu 2
\fI\%NTP execution module\fP
.IP \(bu 2
\fI\%BGP execution module\fP
.IP \(bu 2
\fI\%Routes execution module\fP
.IP \(bu 2
\fI\%SNMP execution module\fP
.IP \(bu 2
\fI\%Users execution module\fP
.IP \(bu 2
\fI\%Probes execution module\fP
.IP \(bu 2
\fI\%NTP peers management state\fP
.IP \(bu 2
\fI\%SNMP configuration management state\fP
.IP \(bu 2
\fI\%Users management state\fP
.UNINDENT
.SS Cisco NXOS Proxy Minion
.sp
Beginning with 2016.11.0, there is a proxy minion that can be used to configure
nxos cisco devices over ssh.
.INDENT 0.0
.IP \(bu 2
\fI\%Proxy Minion\fP
.IP \(bu 2
\fI\%Execution Module\fP
.IP \(bu 2
\fI\%State Module\fP
.UNINDENT
.SS Cisco Network Services Orchestrator Proxy Minion
.sp
Beginning with 2016.11.0, there is a proxy minion to use the Cisco Network
Services Orchestrator as a proxy minion.
.INDENT 0.0
.IP \(bu 2
\fI\%Proxy Minion\fP
.IP \(bu 2
\fI\%Execution Module\fP
.IP \(bu 2
\fI\%State Module\fP
.UNINDENT
.SS Junos Module Changes
.INDENT 0.0
.IP \(bu 2
The following new functionalities were added to the junos module
.INDENT 2.0
.IP \(bu 2
facts \- Displays the facts gathered during the connection.
.IP \(bu 2
shutdown \- Shut down or reboot a device running Junos OS.
.IP \(bu 2
install_config \- Modify the configuration of a Junos device.
.IP \(bu 2
install_os \- Install Junos OS software package.
.IP \(bu 2
zeroize \- Remove all configuration information on the Routing Engines and reset all key values on a device.
.IP \(bu 2
file_copy \- Copy file from proxy to the Junos device.
.UNINDENT
.UNINDENT
.SS Returner Changes
.INDENT 0.0
.IP \(bu 2
Any returner which implements a \fIsave_load\fP function is now required to
accept a \fIminions\fP keyword argument. All returners which ship with Salt
have been modified to do so.
.UNINDENT
.SS Renderer Changes
.sp
Added the ability to restrict allowed renderers. Two new config parameters,
\fBrenderer_whitelist\fP and \fBrenderer_blacklist\fP are
introduced for this purpose.
.SS eAuth Changes
.INDENT 0.0
.IP \(bu 2
External auth modules\(aq \fBauth\fP method can return an ACL list for the given
username instead of \fBTrue\fP\&. This list should be in the same format as
described in the \fI\%eAuth documentation\fP\&. It will be
used for the user instead of one set in master config.
.sp
Example of the \fBauth\fP method return that allows a user to execute functions
in the \fBtest\fP and \fBnetwork\fP modules on the minions that match the \fBweb*\fP
target and allow access to \fBwheel\fP and \fBrunner\fP modules:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
[{\(dqweb*\(dq: [\(dqtest.*\(dq, \(dqnetwork.*\(dq]}, \(dq@wheel\(dq, \(dq@runner\(dq]
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
External auth is supported by \fI\%salt\-run\fP and
\fI\%salt\-key\fP now. Note that master must be started to
use them with eAuth.
.UNINDENT
.SS External Module Packaging
.sp
Modules may now be packaged via entry\-points in setuptools. See
\fI\%external module packaging\fP tutorial
for more information.
.SS Functionality Changes
.INDENT 0.0
.IP \(bu 2
The \fBonfail\fP requisite now uses OR logic instead of AND logic.
\fI\%issue 22370\fP
.IP \(bu 2
The consul external pillar now strips leading and trailing whitespace.
\fI\%issue 31165\fP
.IP \(bu 2
The win_system.py state is now case sensitive for computer names. Previously
computer names set with a state were converted to all caps. If you have a
state setting computer names with lower case letters in the name that has
been applied, the computer name will be changed again to apply the case
sensitive name.
.IP \(bu 2
The \fBmac_user.list_groups\fP function in the \fBmac_user\fP execution module
now lists all groups for the specified user, including groups beginning with
an underscore. In previous releases, groups beginning with an underscore were
excluded from the list of groups.
.IP \(bu 2
The \fBjunos.call_rpc\fP function in the \fBjunos\fP execution module can now be used
to call any valid rpc. Earlier it used to call only \(dqget_software_information\(dq.
.IP \(bu 2
A new option for minions called \fBmaster_tries\fP has been added. This
specifies the number of times a minion should attempt to contact a master to
attempt a connection.  This allows better handling of occasional master
downtime in a multi\-master topology.
.IP \(bu 2
The default hash_type is now sha256 instead of md5. You will need to make sure both
your master and minion share the same hash_type.
.IP \(bu 2
Nodegroups consisting of a simple list of minion IDs can now also be declared
as a yaml list. The below two examples are equivalent:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
# Traditional way
nodegroups:
  \- group1: L@host1,host2,host3

# New way (optional)
nodegroups:
  \- group1:
    \- host1
    \- host2
    \- host3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS New Azure ARM Cloud Driver
.sp
A new cloud driver has been added for Azure ARM, aka, the Azure Resource
Manager. The older Azure driver is still required to work with the older Azure
API. This new driver works with the newer ARM API, which is managed via the
newer Azure Portal website.
.SS New Modules
.SS Beacons
.INDENT 0.0
.IP \(bu 2
\fI\%salt.beacons.avahi_announce\fP
.IP \(bu 2
\fI\%salt.beacons.bonjour_announce\fP
.IP \(bu 2
\fI\%salt.beacons.haproxy\fP
.IP \(bu 2
\fI\%salt.beacons.status\fP
.UNINDENT
.SS Clouds
.INDENT 0.0
.IP \(bu 2
\fBsalt.cloud.clouds.azurearm\fP
.UNINDENT
.SS Engines
.INDENT 0.0
.IP \(bu 2
\fBsalt.engines.hipchat\fP
.IP \(bu 2
\fI\%salt.engines.http_logstash\fP
.UNINDENT
.SS Modules
.INDENT 0.0
.IP \(bu 2
\fI\%salt.modules.boto_cloudwatch_event\fP
.IP \(bu 2
\fI\%salt.modules.celery\fP
.IP \(bu 2
\fI\%salt.modules.ceph\fP
.IP \(bu 2
\fBsalt.modules.influx08\fP
.IP \(bu 2
\fI\%salt.modules.inspectlib.entities\fP
.IP \(bu 2
\fI\%salt.modules.inspectlib.fsdb\fP
.IP \(bu 2
\fI\%salt.modules.inspectlib.kiwiproc\fP
.IP \(bu 2
\fI\%salt.modules.inspector\fP
.IP \(bu 2
\fI\%salt.modules.libcloud_dns\fP
.IP \(bu 2
\fI\%salt.modules.openstack_mng\fP
.IP \(bu 2
\fI\%salt.modules.servicenow\fP
.IP \(bu 2
\fI\%salt.modules.testinframod\fP
.IP \(bu 2
\fI\%salt.modules.win_lgpo\fP
.IP \(bu 2
\fI\%salt.modules.win_pki\fP
.IP \(bu 2
\fI\%salt.modules.win_psget\fP
.IP \(bu 2
\fI\%salt.modules.win_snmp\fP
.IP \(bu 2
\fI\%salt.modules.xbpspkg\fP
.UNINDENT
.SS Outputters
.INDENT 0.0
.IP \(bu 2
\fI\%salt.output.pony\fP
.UNINDENT
.SS Pillar
.INDENT 0.0
.IP \(bu 2
\fI\%salt.pillar.csvpillar\fP
.IP \(bu 2
\fI\%salt.pillar.http_json\fP
.IP \(bu 2
\fI\%salt.pillar.makostack\fP
.UNINDENT
.SS Returners
.INDENT 0.0
.IP \(bu 2
\fI\%salt.returners.zabbix_return\fP
.UNINDENT
.SS Runners
.INDENT 0.0
.IP \(bu 2
\fI\%salt.runners.auth\fP
.IP \(bu 2
\fI\%salt.runners.event\fP
.IP \(bu 2
\fI\%salt.runners.smartos_vmadm\fP
.IP \(bu 2
\fI\%salt.runners.vistara\fP
.UNINDENT
.SS SDB
.INDENT 0.0
.IP \(bu 2
\fI\%salt.sdb.env\fP
.UNINDENT
.SS States
.INDENT 0.0
.IP \(bu 2
\fI\%salt.states.boto_cloudwatch_event\fP
.IP \(bu 2
\fI\%salt.states.csf\fP
.IP \(bu 2
\fI\%salt.states.ethtool\fP
.IP \(bu 2
\fI\%salt.states.influxdb08_database\fP
.IP \(bu 2
\fI\%salt.states.influxdb08_user\fP
.IP \(bu 2
\fI\%salt.states.libcloud_dns\fP
.IP \(bu 2
\fI\%salt.states.snapper\fP
.IP \(bu 2
\fI\%salt.states.testinframod\fP
.IP \(bu 2
\fI\%salt.states.win_lgpo\fP
.IP \(bu 2
\fI\%salt.states.win_pki\fP
.IP \(bu 2
\fI\%salt.states.win_snmp\fP
.UNINDENT
.SS Thorium
.INDENT 0.0
.IP \(bu 2
\fI\%salt.thorium.calc\fP
.IP \(bu 2
\fI\%salt.thorium.key\fP
.IP \(bu 2
\fI\%salt.thorium.runner\fP
.IP \(bu 2
\fI\%salt.thorium.status\fP
.IP \(bu 2
\fI\%salt.thorium.wheel\fP
.UNINDENT
.SS Deprecations
.SS General Deprecations
.INDENT 0.0
.IP \(bu 2
\fBenv\fP to \fBsaltenv\fP
.sp
All occurrences of \fBenv\fP and some occurrences of \fB__env__\fP marked for
deprecation in Salt 2016.11.0 have been removed.  The new way to use the salt
environment setting is with a variable called \fBsaltenv\fP:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
def fcn(msg=\(dq\(dq, env=\(dqbase\(dq, refresh=True, saltenv=\(dqbase\(dq, **kwargs): ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
has been changed to
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
def fcn(msg=\(dq\(dq, refresh=True, saltenv=\(dqbase\(dq, **kwargs): ...
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 2.0
.IP \(bu 2
If \fBenv\fP (or \fB__env__\fP) is supplied as a keyword argument to a function
that also accepts arbitrary keyword arguments, then a new warning informs the
user that \fBenv\fP is no longer used if it is found.  This new warning will be
removed in Salt 2017.7.0.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
def fcn(msg=\(dq\(dq, refresh=True, saltenv=\(dqbase\(dq, **kwargs): ...
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
# will result in a warning log message
fcn(msg=\(dqadd more salt\(dq, env=\(dqprod\(dq, refresh=False)
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
If \fBenv\fP (or \fB__env__\fP) is supplied as a keyword argument to a function
that does not accept arbitrary keyword arguments, then python will issue an
error.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
def fcn(msg=\(dq\(dq, refresh=True, saltenv=\(dqbase\(dq): ...
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
# will result in a python TypeError
fcn(msg=\(dqadd more salt\(dq, env=\(dqprod\(dq, refresh=False)
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
If \fBenv\fP (or \fB__env__\fP) is supplied as a positional argument to a
function, then undefined behavior will occur, as the removal of \fBenv\fP and
\fB__env__\fP from the function\(aqs argument list changes the function\(aqs
signature.
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
def fcn(msg=\(dq\(dq, refresh=True, saltenv=\(dqbase\(dq): ...
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
# will result in refresh evaluating to True and saltenv likely not being a string at all
fcn(\(dqadd more salt\(dq, \(dqprod\(dq, False)
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
Deprecations in \fBminion.py\fP:
.INDENT 2.0
.IP \(bu 2
The \fBsalt.minion.parse_args_and_kwargs\fP function has been removed. Please
use the \fBsalt.minion.load_args_and_kwargs\fP function instead.
.UNINDENT
.UNINDENT
.SS Cloud Deprecations
.INDENT 0.0
.IP \(bu 2
The \fBvsphere\fP cloud driver has been removed. Please use the \fBvmware\fP cloud driver
instead.
.IP \(bu 2
The \fBprivate_ip\fP option in the \fBlinode\fP cloud driver is deprecated and has been
removed. Use the \fBassign_private_ip\fP option instead.
.IP \(bu 2
The \fBcreate_dns_record\fP and \fBdelete_dns_record\fP functions are deprecated and have
been removed from the \fBdigital_ocean\fP driver. Use the \fBpost_dns_record\fP function
instead.
.UNINDENT
.SS Execution Module Deprecations
.INDENT 0.0
.IP \(bu 2
The \fBblockdev\fP execution module had four functions removed:
.INDENT 2.0
.IP \(bu 2
dump
.IP \(bu 2
tune
.IP \(bu 2
resize2fs
.IP \(bu 2
wipe
.UNINDENT
.sp
The \fBdisk\fP module should be used instead with the same function names.
.IP \(bu 2
The \fBboto_vpc\fP execution module had two functions removed,
\fBboto_vpc.associate_new_dhcp_options_to_vpc\fP and
\fBboto_vpc.associate_new_network_acl_to_subnet\fP in favor of more concise function
names, \fBboto_vpc.create_dhcp_options\fP and \fBboto_vpc.create_network_acl\fP, respectively.
.IP \(bu 2
The \fBdata\fP execution module had \fBgetval\fP and \fBgetvals\fP functions removed
in favor of one function, \fBget\fP, which combines the functionality of the
removed functions.
.IP \(bu 2
File module deprecations:
.INDENT 2.0
.IP \(bu 2
The \fBcontains_regex_multiline\fP function was removed. Use \fBfile.search\fP instead.
.IP \(bu 2
Additional command line options for \fBfile.grep\fP should be passed one at a time.
Please do not pass more than one in a single argument.
.UNINDENT
.IP \(bu 2
The \fBlxc\fP execution module has the following changes:
.INDENT 2.0
.IP \(bu 2
The \fBrun_cmd\fP function was removed. Use \fBlxc.run\fP instead.
.IP \(bu 2
The \fBnic\fP argument was removed from the \fBlxc.init\fP function. Use \fBnetwork_profile\fP
instead.
.IP \(bu 2
The \fBclone\fP argument was removed from the \fBlxc.init\fP function. Use \fBclone_from\fP
instead.
.IP \(bu 2
passwords passed to the \fBlxc.init\fP function will be assumed to be hashed, unless
\fBpassword_encrypted=False\fP\&.
.IP \(bu 2
The \fBrestart\fP argument for \fBlxc.start\fP was removed. Use \fBlxc.restart\fP instead.
.IP \(bu 2
The old style of defining lxc containers has been removed. Please use keys under which
LXC profiles should be configured such as \fBlxc.container_profile.profile_name\fP\&.
.UNINDENT
.IP \(bu 2
The \fBenv\fP and \fBactivate\fP keyword arguments have been removed from the \fBinstall\fP
function in the \fBpip\fP execution module. The use of \fBbin_env\fP replaces both of these
options.
.IP \(bu 2
\fBreg\fP execution module
.sp
Functions in the \fBreg\fP execution module had misleading and confusing names
for dealing with the Windows registry. They failed to clearly differentiate
between hives, keys, and name/value pairs. Keys were treated like value names.
There was no way to delete a key.
.sp
New functions were added in 2015.5 to properly work with the registry. They
also made it possible to edit key default values as well as delete an entire
key tree recursively. With the new functions in place, the following functions
have been deprecated:
.INDENT 2.0
.IP \(bu 2
read_key
.IP \(bu 2
set_key
.IP \(bu 2
create_key
.IP \(bu 2
delete_key
.UNINDENT
.sp
Use the following functions instead:
.INDENT 2.0
.IP \(bu 2
for \fBread_key\fP use \fBread_value\fP
.IP \(bu 2
for \fBset_key\fP use \fBset_value\fP
.IP \(bu 2
for \fBcreate_key\fP use \fBset_value\fP with no \fBvname\fP and no \fBvdata\fP
.IP \(bu 2
for \fBdelete_key\fP use \fBdelete_key_recursive\fP\&. To delete a value, use
\fBdelete_value\fP\&.
.UNINDENT
.IP \(bu 2
The \fBhash_hostname\fP option was removed from the \fBsalt.modules.ssh\fP execution
module. The \fBhash_known_hosts\fP option should be used instead.
.IP \(bu 2
The \fBhuman_readable\fP option was removed from the \fBuptime\fP function in the
\fBstatus\fP execution module. The function was also updated in 2015.8.9 to return
a more complete offering of uptime information, formatted as an easy\-to\-read
dictionary. This updated function replaces the need for the \fBhuman_readable\fP
option.
.IP \(bu 2
The \fBpersist\fP kwarg was removed from the \fBwin_useradd\fP execution module. This
option is no longer supported for Windows. \fBpersist\fP is only supported as part
of user management in UNIX/Linux.
.IP \(bu 2
The \fBzpool_list\fP function in the \fBzpool\fP execution module was removed. Use \fBlist\fP
instead.
.UNINDENT
.SS Outputter Module Deprecations
.INDENT 0.0
.IP \(bu 2
The \fBcompact\fP outputter has been removed. Set \fBstate_verbose\fP to \fBFalse\fP instead.
.UNINDENT
.SS Runner Module Deprecations
.INDENT 0.0
.IP \(bu 2
The \fBgrains.cache\fP runner no longer accepts \fBoutputter\fP or \fBminion\fP as keyword arguments.
Users will need to specify an outputter using the \fB\-\-out\fP option. \fBtgt\fP is
replacing the \fBminion\fP kwarg.
.IP \(bu 2
The \fBfileserver\fP runner no longer accepts the \fBoutputter\fP keyword argument. Users will
need to specify an outputter using the \fB\-\-out\fP option.
.IP \(bu 2
The \fBjobs\fP runner no longer accepts the \fBoutputter\fP keyword argument. Users will need to
specify an outputter using the \fB\-\-out\fP option.
.IP \(bu 2
\fBvirt\fP runner module:
.INDENT 2.0
.IP \(bu 2
The \fBhyper\fP kwarg was removed from the \fBinit\fP, \fBlist\fP, and \fBquery\fP functions.
Use the \fBhost\fP option instead.
.IP \(bu 2
The \fBnext_hyper\fP function was removed. Use the \fBnext_host\fP function instead.
.IP \(bu 2
The \fBhyper_info\fP function was removed. Use the \fBhost_info\fP function instead.
.UNINDENT
.UNINDENT
.SS State Module Deprecations
.INDENT 0.0
.IP \(bu 2
The \fBenv\fP and \fBactivate\fP keyword arguments were removed from the \fBinstalled\fP
function in the \fBpip\fP state module. The use of \fBbin_env\fP replaces both of these
options.
.IP \(bu 2
\fBreg\fP state module
.sp
The \fBreg\fP state module was modified to work with the new functions in the
execution module. Some logic was left in the \fBreg.present\fP and the
\fBreg.absent\fP functions to handle existing state files that used the final
key in the name as the value name. That logic has been removed so you now must
specify value name (\fBvname\fP) and, if needed, value data (\fBvdata\fP).
.sp
For example, a state file that adds the version value/data pair to the
Software\eSalt key in the HKEY_LOCAL_MACHINE hive used to look like this:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
HKEY_LOCAL_MACHINE\e\eSoftware\e\eSalt\e\eversion:
  reg.present:
    \- value: 2016.3.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now it should look like this:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
HKEY_LOCAL_MACHINE\e\eSoftware\e\eSalt
  reg.present:
    \- vname: version
    \- vdata: 2016.3.1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A state file for removing the same value added above would have looked like
this:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
HKEY_LOCAL_MACHINE\e\eSoftware\e\eSalt\e\eversion:
  reg.absent:
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now it should look like this:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
HKEY_LOCAL_MACHINE\e\eSoftware\e\eSalt
  reg.absent:
    \- vname: version
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This new structure is important as it allows salt to deal with key default
values which was not possible before. If vname is not passed, salt will work
with the default value for that hivekey.
.sp
Additionally, since you could only delete a value from a the state module, a
new function (\fBkey_absent\fP) has been added to allow you to delete a registry
key and all subkeys and name/value pairs recursively. It uses the new
\fBdelete_key_recursive\fP function.
.sp
For additional information see the documentation for the \fBreg\fP execution and
state modules.
.IP \(bu 2
\fBlxc\fP state module: The following functions were removed from the \fBlxc\fP state
module:
.INDENT 2.0
.IP \(bu 2
\fBcreated\fP: replaced by the \fBpresent\fP state.
.IP \(bu 2
\fBstarted\fP: replaced by the \fBrunning\fP state.
.IP \(bu 2
\fBcloned\fP: replaced by the \fBpresent\fP state. Use the \fBclone_from\fP argument
to set the name of the clone source.
.UNINDENT
.IP \(bu 2
The \fBhash_hostname\fP option was removed from the \fBsalt.states.ssh_known_hosts\fP
state. The \fBhash_known_hosts\fP option should be used instead.
.IP \(bu 2
The \fBalways\fP kwarg used in the \fBbuilt\fP function of the \fBpkgbuild\fP state module
was removed. Use \fBforce\fP instead.
.UNINDENT
.SS Utils Module Deprecations
.INDENT 0.0
.IP \(bu 2
The use of \fBjid_dir\fP and \fBjid_load\fP were removed from the
\fBsalt.utils.jid\fP\&. \fBjid_dir\fP functionality for job_cache management was moved to
the \fBlocal_cache\fP returner. \fBjid_load\fP data is now retrieved from the
\fBmaster_job_cache\fP\&.
.IP \(bu 2
\fBip_in_subnet\fP function in \fBsalt.utils.network.py\fP has been removed. Use the
\fBin_subnet\fP function instead.
.IP \(bu 2
The \fBiam\fP utils module had two functions removed: \fBsalt.utils.iam.get_iam_region\fP
and \fBsalt.utils.iam.get_iam_metadata\fP in favor of the aws utils functions
\fBsalt.utils.aws.get_region_from_metadata\fP and \fBsalt.utils.aws.creds\fP, respectively.
.UNINDENT
.SS Salt 2016.11.1 Release Notes
.sp
Version 2016.11.1 is a bugfix release for \fI\%2016.11.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB89\fP
.IP \(bu 2
Total Issue References: \fB29\fP
.IP \(bu 2
Total PR References: \fB83\fP
.IP \(bu 2
Contributors: \fB30\fP (\fI\%Ch3LL\fP, \fI\%Da\-Juan\fP, \fI\%DmitryKuzmenko\fP, \fI\%MTecknology\fP, \fI\%adelcast\fP,
\fI\%attiasr\fP, \fI\%bbinet\fP, \fI\%cachedout\fP, \fI\%cro\fP, \fI\%dmurphy18\fP, \fI\%gtmanfred\fP, \fI\%isbm\fP, \fI\%jeanpralo\fP,
\fI\%kraney\fP, \fI\%kstreee\fP, \fI\%lorengordon\fP, \fI\%mateiw\fP, \fI\%mirceaulinic\fP, \fI\%morsik\fP, \fI\%mschneider82\fP,
\fI\%rallytime\fP, \fI\%rbjorklin\fP, \fI\%scott\-w\fP, \fI\%sjorge\fP, \fI\%skizunov\fP, \fI\%techhat\fP, \fI\%terminalmage\fP,
\fI\%thatch45\fP, \fI\%ticosax\fP, \fI\%whiteinge\fP)
.UNINDENT
.SS Changelog for v2016.11.0..v2016.11.1
.sp
\fIGenerated at: 2018\-05\-27 14:25:03 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#38186\fP: (\fI\%Ch3LL\fP) add 2016.11.1 changelog to release notes
.IP \(bu 2
\fBPR\fP \fI\%#38182\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2016\-12\-09 21:25:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
23c039347e Merge pull request \fI\%#38182\fP from rallytime/merge\-2016.11
.IP \(bu 2
627242ab5d Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
65b2ad7b14 Merge pull request \fI\%#38163\fP from Ch3LL/enabled_ec2_cloud
.INDENT 2.0
.IP \(bu 2
be74c45463 enabled ec2 cloud tests
.UNINDENT
.IP \(bu 2
b63f74e034 Merge pull request \fI\%#38177\fP from vutny/fix\-cp\-get\-file\-str
.INDENT 2.0
.IP \(bu 2
a449980672 Correct \fIcp.get_file_str\fP docstring and add integration tests
.UNINDENT
.IP \(bu 2
7596313be0 Merge pull request \fI\%#38153\fP from vutny/master\-includes\-error\-tolerance
.INDENT 2.0
.IP \(bu 2
cd0154ee93 Master config includes may contain errors and be safely skipped
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38094\fP: (\fI\%bfilipek\fP) TypeError: object of type \(aqfloat\(aq has no len() in grains.filter_by (refs: \fI\%#38158\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38158\fP: (\fI\%cachedout\fP) Fix type problem in grains.filter_by
@ \fI2016\-12\-09 21:24:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
8355adc535 Merge pull request \fI\%#38158\fP from cachedout/issue_38094
.IP \(bu 2
e8196e23c2 Lint, remove set literal
.IP \(bu 2
9f4ebb3c18 Fix type problem in grains.filter_by
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38090\fP: (\fI\%jf\fP) pkg.installed does not seem to refresh the repo database, no matter what (refs: \fI\%#38113\fP, \fI\%#38156\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38156\fP: (\fI\%terminalmage\fP) Remove rtag when windows minion refreshes early in state
@ \fI2016\-12\-09 21:15:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
31a157d902 Merge pull request \fI\%#38156\fP from terminalmage/fix\-windows\-refresh
.IP \(bu 2
258bd4c2aa Remove rtag when windows minion refreshes early in state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37981\fP: (\fI\%tazaki\fP) Salt\-cloud ec2 vpc securitygroupid always returning default (refs: \fI\%#38183\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38183\fP: (\fI\%cro\fP) Fix bad set operations when setting up securitygroups in AWS.
@ \fI2016\-12\-09 21:12:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
c638952684 Merge pull request \fI\%#38183\fP from cro/fix_37891
.IP \(bu 2
0527d6f25e Fix bad set operations when setting up securitygroups in AWS.  Fixes \fI\%#37891\fP\&.
.IP \(bu 2
\fBPR\fP \fI\%#38181\fP: (\fI\%rallytime\fP) Reset socket default timeout to None (fixes daemons_tests failures)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38148\fP: (\fI\%whiteinge\fP) Remove ssh_async from NetapiClient clients; it is not implemented
@ \fI2016\-12\-09 18:49:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
7ccbedd2cc Merge pull request \fI\%#38148\fP from whiteinge/no\-ssh\-async\-client
.IP \(bu 2
cb58cd4795 Remove ssh_async from NetapiClient clients; it is not implemented
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38160\fP: (\fI\%terminalmage\fP) Update information about xz\-utils in archive state/module docs
@ \fI2016\-12\-09 18:34:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
8d4e194400 Merge pull request \fI\%#38160\fP from terminalmage/update\-archive\-docs
.IP \(bu 2
8e4ad3cff3 Update information about xz\-utils in archive state/module docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38024\fP: (\fI\%Ch3LL\fP) 2016.11.0 release notes missing azure arm reference (refs: \fI\%#38164\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38164\fP: (\fI\%techhat\fP) Add Azure ARM docs for 2016.11.0
@ \fI2016\-12\-09 18:00:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
05136f0d8c Merge pull request \fI\%#38164\fP from techhat/azuredocs
.IP \(bu 2
71b787e250 Add Azure ARM docs for 2016.11.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38173\fP: (\fI\%rallytime\fP) Bump some win* module deprecations from Nitrogen to Oxygen
@ \fI2016\-12\-09 16:57:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
e3c858cc28 Merge pull request \fI\%#38173\fP from rallytime/update\-win\-deprecation\-versions
.IP \(bu 2
09a50b25e7 Bump some win* module deprecations from Nitrogen to Oxygen
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38036\fP: (\fI\%terminalmage\fP) archive.extracted: fix problems with overwrite arg
@ \fI2016\-12\-08 19:08:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37889\fP: (\fI\%isbm\fP) Allow overwrite archives extraction (refs: \fI\%#38036\fP)
.IP \(bu 2
827bf59999 Merge pull request \fI\%#38036\fP from terminalmage/archive\-extracted\-override
.IP \(bu 2
a1c70c7b95 archive.extracted: fix problems with overwrite arg
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38133\fP: (\fI\%terminalmage\fP) Fix edge case in creation of trans tar for salt\-thin
@ \fI2016\-12\-08 17:47:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
50773a5f96 Merge pull request \fI\%#38133\fP from terminalmage/zd1067
.IP \(bu 2
71e0bd023f Fix edge case in creation of trans tar for salt\-thin
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38138\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2016\-12\-07 20:15:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
6026cb23b2 Merge pull request \fI\%#38138\fP from rallytime/merge\-2016.11
.IP \(bu 2
28b56ea3b4 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
86091db647 Skip daemon unit tests when running on Python 2.6 (\fI\%#38134\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38130\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2016\-12\-07 20:11:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
90478ef25e Merge pull request \fI\%#38130\fP from rallytime/merge\-2016.11
.IP \(bu 2
4d7d9abb41 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
d3d98fd4eb Merge pull request \fI\%#38102\fP from rallytime/fix\-38091
.INDENT 2.0
.IP \(bu 2
4f79d5a0d1 Add False + msg tuple return if requests is missing for zenoss module
.UNINDENT
.IP \(bu 2
8c8cbc2734 Merge pull request \fI\%#38104\fP from rallytime/bp\-36794
.INDENT 2.0
.IP \(bu 2
c906c8a0d5 Pylint fixes
.IP \(bu 2
da3ebf83e6 FreeBSD sysctl module now handels config_file parameter in show method
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38129\fP: (\fI\%Ch3LL\fP) Fix beacon index
.IP \(bu 2
\fBPR\fP \fI\%#38127\fP: (\fI\%rallytime\fP) Add versionadded tags for network module funcs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38042\fP: (\fI\%MTecknology\fP) [2016.11.0] Invalid interfaces file produced by debian_ip module (refs: \fI\%#38043\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38043\fP: (\fI\%MTecknology\fP) Debian networking fix
@ \fI2016\-12\-07 17:32:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd06bab673 Merge pull request \fI\%#38043\fP from MTecknology/2016.11
.IP \(bu 2
6d5e132e44 Removing trailing whitespace from previous commit
.IP \(bu 2
f882674acf Adding some options that are valid for inet6 blocks.
.IP \(bu 2
81cb688d4c Better check for dual stack.
.IP \(bu 2
525c746274 May Cthulhu take mercy on my soul for this commit.
.IP \(bu 2
300ca6047e I guess this makes the previous commit a bit redundant, but I\(aqm not sure if I want to remove it.
.IP \(bu 2
6e7fc39c68 This now seems absurdly obvious, but I\(aqm not ruling out that I\(aqll break everything.
.IP \(bu 2
82d2b89e0c Rolling back unit test.
.IP \(bu 2
b3edbcfd05 Adding larger and more complete debian_ip unit test.
.IP \(bu 2
3afd7b6cf4 Adding the valid/documented \(aqslaves\(aq option.
.IP \(bu 2
b6b1adc091 Typo: missing closing parenthesis
.IP \(bu 2
756e41caf2 Fixing a typo; line should not be commented
.IP \(bu 2
32a1374748 Corrects expected return value
.IP \(bu 2
88f9d9f22c Mostly whitespace & comment changes
.IP \(bu 2
41ffb8d805 Removing redundant line
.IP \(bu 2
3a8168667b Ensure iface_dict not being populated will not produce a stacktrace
.IP \(bu 2
4de2cb2805 Corrects regression in debian_ip/debian_eth.jinja
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38107\fP: (\fI\%cachedout\fP) Status beacon should raise proper exception
@ \fI2016\-12\-07 17:21:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38088\fP: (\fI\%dmurphy18\fP) Updated to match formulas and allow for missing functions (refs: \fI\%#38107\fP)
.IP \(bu 2
4b9a7f2295 Merge pull request \fI\%#38107\fP from cachedout/supercede_38088
.IP \(bu 2
73d724845d Change to log.debug per Tom
.IP \(bu 2
da135b1b59 Fix docs
.IP \(bu 2
792b422dc2 Pylint fix
.IP \(bu 2
88e03bba6d Fix typo
.IP \(bu 2
a8ce153252 Status beacon should raise proper exception
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38101\fP: (\fI\%lorengordon\fP) Clarifies file.replace behavior on symlinks
@ \fI2016\-12\-07 13:27:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
da8f5ac0c6 Merge pull request \fI\%#38101\fP from lorengordon/file\-replace\-note
.IP \(bu 2
345990f2b0 Clarifies file.replace behavior on symlinks
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38090\fP: (\fI\%jf\fP) pkg.installed does not seem to refresh the repo database, no matter what (refs: \fI\%#38113\fP, \fI\%#38156\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38113\fP: (\fI\%terminalmage\fP) Revert changes to refresh tag for pkg states
@ \fI2016\-12\-07 13:11:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
d47761f349 Merge pull request \fI\%#38113\fP from terminalmage/issue38090
.IP \(bu 2
9f347df012 Revert changes to refresh tag for pkg states
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37976\fP: (\fI\%t0nyhays\fP) Error when status beacon fires (2016.11.0) (refs: \fI\%#38120\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38120\fP: (\fI\%Da\-Juan\fP) Fix status beacon config default values
@ \fI2016\-12\-07 13:08:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
d4c34e0a58 Merge pull request \fI\%#38120\fP from Da\-Juan/2016.11
.IP \(bu 2
7e4a35e8ad Fix status beacon config default values
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38114\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2016\-12\-07 12:45:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
6868089a87 Merge pull request \fI\%#38114\fP from rallytime/merge\-2016.11
.IP \(bu 2
fec9dec23a Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
fbc87769b9 Merge pull request \fI\%#38083\fP from twangboy/fix_refresh_db
.INDENT 2.0
.IP \(bu 2
978af6d83c Remove only .sls files from the cached winrepo\-ng
.UNINDENT
.IP \(bu 2
9dcfdeef6b Merge pull request \fI\%#38059\fP from rallytime/daemons\-test\-fix
.INDENT 2.0
.IP \(bu 2
eb372b27d8 Add missing \(dqnot\(dq statement: The last syndic test should assertFalse()
.IP \(bu 2
4e10f8e018 Call exec_test for the Syndic daemon in tests.unit.daemons_test.py
.UNINDENT
.IP \(bu 2
9cd42b9b3f Merge pull request \fI\%#38039\fP from rallytime/fix\-37939
.INDENT 2.0
.IP \(bu 2
1da7aacfbe Update unit tests to account for additional file.search call
.IP \(bu 2
8a685b1820 Check to see if a line is already commented before moving on
.IP \(bu 2
f2c045520d Write an integration test demonstrating the issue
.UNINDENT
.IP \(bu 2
a34a763984 Merge pull request \fI\%#38045\fP from terminalmage/issue38037
.INDENT 2.0
.IP \(bu 2
65289503d9 Simplify logic for matching desired pkg arch with actual pkg arch
.IP \(bu 2
3babbcda94 yumpkg.py: don\(aqt include non\-upgrade versions found by \(dqyum list available\(dq
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38109\fP: (\fI\%gtmanfred\fP) mode needs to be an integer
@ \fI2016\-12\-07 11:58:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
b9920e54ee Merge pull request \fI\%#38109\fP from gtmanfred/2016.11
.IP \(bu 2
7546760eb3 mode needs to be an integer
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38103\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37283\fP to 2016.11
@ \fI2016\-12\-06 23:12:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37283\fP: (\fI\%jeanpralo\fP) Handle docker\-compose up to version 1.9.0 (refs: \fI\%#38103\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37215\fP: (\fI\%mschneider82\fP) removed version check (refs: \fI\%#37283\fP)
.IP \(bu 2
fd77dcbd0f Merge pull request \fI\%#38103\fP from rallytime/bp\-37283
.IP \(bu 2
11944df69b handle up to version 1.9.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38057\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11 (refs: \fI\%#38059\fP)
@ \fI2016\-12\-06 23:11:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
5d9d6b9280 Merge pull request \fI\%#38057\fP from rallytime/merge\-2016.11
.IP \(bu 2
342884018b Fix SaltKeyOptionParserTestCase test failures
.IP \(bu 2
186e2d0d03 Don\(aqt allow libcloud mock module injection in unit/states/libcloud_dns_test.py either
.IP \(bu 2
d513a60189 Do not allow libcloud to be injected as a mock value in the libcloud_dns_test
.IP \(bu 2
74a417e527 Update the mocked cloud configs to also include master configs
.IP \(bu 2
f2c8cb13d0 Better merge conflict resolution from the initial merge
.IP \(bu 2
8fd53a4808 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
6724fe4871 Modify daemons test to use multiprocessing (\fI\%#38034\fP)
.IP \(bu 2
6942d5d95b Merge pull request \fI\%#37995\fP from rallytime/merge\-2016.3
.INDENT 2.0
.IP \(bu 2
b44e17921c Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
7a7e36728f Merge pull request \fI\%#37978\fP from terminalmage/ext_pillar_first\-docs
.INDENT 2.0
.IP \(bu 2
61ed9a8657 Add clarifying language to ext_pillar_first docs
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
cd66c179cb fix broken yaml code block (\fI\%#38002\fP)
.IP \(bu 2
3dd45fbedf Merge pull request \fI\%#37912\fP from attiasr/fix_aws_response_encoding
.INDENT 2.0
.IP \(bu 2
ba4ec4e7f1 use Requests result encoding to encode the text
.IP \(bu 2
abe4eb3b98 fix encoding problem aws responses
.UNINDENT
.IP \(bu 2
69a74a4d2d Merge pull request \fI\%#37950\fP from vutny/fix\-starting\-up\-syndic
.INDENT 2.0
.IP \(bu 2
7d9bc9abce syndic_master: correct default value, documentation and example config
.IP \(bu 2
92a7c7ed1b Set default Salt Master address for a Syndic (like for a Minion)
.UNINDENT
.IP \(bu 2
7f269bc7f9 Add clarification on expr_form usage and future deprecation (\fI\%#37964\fP)
.IP \(bu 2
1001987f64 Catch possible exception from lsb_release (\fI\%#37962\fP)
.IP \(bu 2
330021cd8b Handle empty tokens safely (\fI\%#37961\fP)
.IP \(bu 2
ea46639ce7 Merge pull request \fI\%#37272\fP from vutny/fix\-getting\-default\-logging\-opts
.INDENT 2.0
.IP \(bu 2
e5ce52388a Fix description in the Salt Syndic usage info
.IP \(bu 2
518a3dd7ee Add unit tests for Salt parsers processing logging options
.IP \(bu 2
83d6a44254 Add \fIssh_log_file\fP option to master config and documentation
.IP \(bu 2
c8a0915460 Fix configuration example and documentation for \fIsyndic_log_file\fP option
.IP \(bu 2
e64dd3ed6b Correct default attributes for various parser classes
.IP \(bu 2
82a2e216b3 Fix default usage string for Salt command line programs
.IP \(bu 2
45dffa292f Fix readding and updating logfile and pidfile config options for Salt API
.IP \(bu 2
f47253c21b Fix reading and applying Salt Cloud default configuration
.IP \(bu 2
fad5bec936 Work with a copy of default opts dictionaries
.IP \(bu 2
b7c24811e5 Fix \fIlog_level_logfile\fP config value type
.IP \(bu 2
1bd76a1d96 Fix setting temporary log level if CLI option omitted
.IP \(bu 2
121848cc77 Fix obtaining \fIlog_granular_levels\fP config setting
.IP \(bu 2
44cf07fec2 Make CLI options take precedence for setting up logfile_logger
.IP \(bu 2
61afaf1792 Fix setting option attributes when processing \fIlog_level\fP and \fIlog_file\fP
.IP \(bu 2
3c60e2388e Fix processing of \fIlog_level_logfile\fP config setting
.IP \(bu 2
55a0af5bbd Use attribute functions for getting/setting options and config values
.IP \(bu 2
c25f2d091e Fix getting Salt API default logfile option
.IP \(bu 2
f2422373c1 Remove processing of unused and undocumented \fIcli_*_log_*\fP config options
.IP \(bu 2
2065e8311c Get default logging level and file from default opts dict
.UNINDENT
.IP \(bu 2
f2f957da6c Merge pull request \fI\%#37925\fP from kontrolld/add\-ipv6\-centos\-network
.INDENT 2.0
.IP \(bu 2
ac2b477412 Adding IPv6 functionality for CentOS /etc/sysconfig/network
.UNINDENT
.IP \(bu 2
c07ad11279 Merge pull request \fI\%#37899\fP from DSRCorporation/bugs/37059_schedule_task_hang
.INDENT 2.0
.IP \(bu 2
9497748546 Clear functions context in schedule tasks for ZeroMQ.
.UNINDENT
.IP \(bu 2
a55519db40 Merge pull request \fI\%#37928\fP from techhat/issue37737
.INDENT 2.0
.IP \(bu 2
a09a60e89b Don\(aqt modify self.opts directly
.UNINDENT
.IP \(bu 2
9d17f1ce90 Merge pull request \fI\%#37929\fP from gtmanfred/2016.3
.INDENT 2.0
.IP \(bu 2
c7d2c73503 add list_nodes_min to nova driver
.UNINDENT
.IP \(bu 2
3bb743b59f Merge pull request \fI\%#37926\fP from kontrolld/fix\-ipv6\-centos\-network
.INDENT 2.0
.IP \(bu 2
3ed42e5b44 updated
.IP \(bu 2
3b3bc4f239 Fixes no IPv6 functionality in /etc/sysconfig/network
.UNINDENT
.IP \(bu 2
271170a9f3 Merge pull request \fI\%#37921\fP from rallytime/merge\-2016.3
.INDENT 2.0
.IP \(bu 2
523a67c422 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
4cdc6cf5ec Update earlier release channels\(aq docs with Carbon release notes (\fI\%#37914\fP)
.IP \(bu 2
d31491a7fe [2015.8] Update version numbers in doc config for 2016.11.0 release (\fI\%#37918\fP)
.UNINDENT
.UNINDENT
.IP \(bu 2
6cd6429ac0 Merge pull request \fI\%#37924\fP from cachedout/fix_gem_states
.INDENT 2.0
.IP \(bu 2
894cca3427 Update test for new gem ver
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38112\fP: (\fI\%rallytime\fP) Account for case where vim install already exists and is at an older version
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19502\fP: (\fI\%kt97679\fP) salt\-ssh fails to run state.highstate with custom master_tops (refs: \fI\%#38021\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38021\fP: (\fI\%mateiw\fP) Add master_tops support in salt\-ssh
@ \fI2016\-12\-06 14:26:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
f8c67a9598 Merge pull request \fI\%#38021\fP from mateiw/salt\-ssh_master_tops
.IP \(bu 2
65a0f102fd Add/remove newlines
.IP \(bu 2
7037fa116d Add master_tops support in salt\-ssh
.IP \(bu 2
\fBPR\fP \fI\%#38084\fP: (\fI\%rallytime\fP) Start release notes file for 2016.11.1 release
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37878\fP: (\fI\%kstreee\fP) Makes threads avoid blocking waiting while communicating using Zeromq.
@ \fI2016\-12\-05 19:50:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
78295516e7 Merge pull request \fI\%#37878\fP from kstreee/2016.11
.IP \(bu 2
9103878c4f Fixes blocking waiting through implementing a socket pool class.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37987\fP: (\fI\%rbjorklin\fP) consul_pillar support for limiting pillar exposure via minion targeting
@ \fI2016\-12\-05 19:48:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37985\fP: (\fI\%rbjorklin\fP) consul_pillar support for limiting pillar exposure via minion targeting (refs: \fI\%#37987\fP)
.IP \(bu 2
0809ccd429 Merge pull request \fI\%#37987\fP from rbjorklin/consul\-pillar\-target
.IP \(bu 2
5d0454a7ca Ignore W1401 (anomalous\-backslash\-in\-string)
.IP \(bu 2
2e929a5ecc Linting fixes
.IP \(bu 2
171cab1726 Fixed possible incorrect behavior if target wasn\(aqt on start/end of str
.IP \(bu 2
7440582ce8 consul_pillar support for limiting pillar exposure via minion targeting
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38062\fP: (\fI\%UtahDave\fP) archive execution module not loading on Windows in 2016.11.0 (refs: \fI\%#38067\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38067\fP: (\fI\%terminalmage\fP) Remove virtual funcs for archive state/module
@ \fI2016\-12\-05 16:37:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
83dcfe81ea Merge pull request \fI\%#38067\fP from terminalmage/issue38062
.IP \(bu 2
2e0f26a084 Remove virtual funcs for archive state/module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38001\fP: (\fI\%tomlaredo\fP) Regression on postgres_group.present (\(aqpostgres_group\(aq __virtual__ returned False) (refs: \fI\%#38023\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#37986\fP: (\fI\%marek\-obuchowicz\fP) Module postgres \- wrong docs, doesn\(aqt work with debian 8.5 (refs: \fI\%#38023\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#37935\fP: (\fI\%ipmb\fP) Postgres module regression on 2016.11 (refs: \fI\%#37946\fP, \fI\%#37993\fP, \fI\%#38023\fP, \fI\%#38058\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38058\fP: (\fI\%rallytime\fP) Remove initdb dependency in postgres module
@ \fI2016\-12\-04 04:19:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38023\fP: (\fI\%gtmanfred\fP) Expand error message for postgres states (refs: \fI\%#38058\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37993\fP: (\fI\%ticosax\fP) Remove initdb dependency to consume postgres module. (refs: \fI\%#38058\fP)
.IP \(bu 2
c9933670f9 Merge pull request \fI\%#38058\fP from rallytime/remove\-init\-db\-dep
.IP \(bu 2
c1ceeca3d3 Remove initdb dependency in postgres module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37969\fP: (\fI\%lordcirth\fP) Archive.extracted fails if \-user: root is specified (refs: \fI\%#38004\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38004\fP: (\fI\%terminalmage\fP) Fix regression in user/group mgmt for archive.extracted
@ \fI2016\-12\-02 18:28:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
1ac53e5196 Merge pull request \fI\%#38004\fP from terminalmage/issue37969
.IP \(bu 2
23bb90a7ce Add integration test for archive.extracted with user/group set to root
.IP \(bu 2
e5ee721696 Don\(aqt use simple boolean check on uid/gid
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37941\fP: (\fI\%L4rS6\fP) Outdated documentation for 2016.11.x (refs: \fI\%#38051\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38051\fP: (\fI\%Ch3LL\fP) add docs for hash_type change to sha256
@ \fI2016\-12\-02 18:11:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
e90cbbef08 Merge pull request \fI\%#38051\fP from Ch3LL/fix_hash_docs
.IP \(bu 2
e95f88fbe3 add docs for hash_type change to sha256
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38000\fP: (\fI\%morganwillcock\fP) 2016.11.0: saltutil.runner returns a different dict structure and breaks template rendering (refs: \fI\%#38028\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38028\fP: (\fI\%terminalmage\fP) Pass full_return to saltutil.runner
@ \fI2016\-12\-02 09:49:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
1b52289508 Merge pull request \fI\%#38028\fP from terminalmage/issue38000
.IP \(bu 2
9bf13d55b4 Pass full_return to saltutil.runner
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37980\fP: (\fI\%tveastman\fP) Having \(aqgit\(aq in fileserver_backends and no gitfs_remotes defined causes a crash (refs: \fI\%#38044\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38044\fP: (\fI\%terminalmage\fP) Remove debugging code
@ \fI2016\-12\-02 09:43:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
41c44ff684 Merge pull request \fI\%#38044\fP from terminalmage/issue37980
.IP \(bu 2
f70a0409b3 Remove debugging code
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38035\fP: (\fI\%dmurphy18\fP) Updated to return status from make_repo similar to rpmbuild.py
@ \fI2016\-12\-01 22:30:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
9661258f22 Merge pull request \fI\%#38035\fP from dmurphy18/fix_debbuild
.IP \(bu 2
3bca96e7f2 Updated to return status from make_repo similar to rpmbuild.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38001\fP: (\fI\%tomlaredo\fP) Regression on postgres_group.present (\(aqpostgres_group\(aq __virtual__ returned False) (refs: \fI\%#38023\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#37986\fP: (\fI\%marek\-obuchowicz\fP) Module postgres \- wrong docs, doesn\(aqt work with debian 8.5 (refs: \fI\%#38023\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#37935\fP: (\fI\%ipmb\fP) Postgres module regression on 2016.11 (refs: \fI\%#37946\fP, \fI\%#37993\fP, \fI\%#38023\fP, \fI\%#38058\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38023\fP: (\fI\%gtmanfred\fP) Expand error message for postgres states (refs: \fI\%#38058\fP)
@ \fI2016\-12\-01 22:05:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
141b5c5656 Merge pull request \fI\%#38023\fP from gtmanfred/2016.11
.IP \(bu 2
1aa43eba80 Expand error message for postgres states
.IP \(bu 2
ac72ee600e Revert \(dqUpdated the bins_dir to default to pg_bin \fI\%#37935\fP\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38026\fP: (\fI\%rallytime\fP) Back\-port \fI\%#38015\fP to 2016.11
@ \fI2016\-12\-01 19:16:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38015\fP: (\fI\%morsik\fP) Typo fix (refs: \fI\%#38026\fP)
.IP \(bu 2
79486421f5 Merge pull request \fI\%#38026\fP from rallytime/bp\-38015
.IP \(bu 2
11becf3e68 Typo fix
.IP \(bu 2
\fBPR\fP \fI\%#38022\fP: (\fI\%DmitryKuzmenko\fP) Added Carbon release notes. Fixed sphinx errors in the file.
.IP \(bu 2
\fBPR\fP \fI\%#38011\fP: (\fI\%rallytime\fP) Adjust code examples to use the actual bootstrap\-salt.sh file name
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37940\fP: (\fI\%alex\-zel\fP) dockerng.sls_build fails on some distributions (refs: \fI\%#37954\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37954\fP: (\fI\%gtmanfred\fP) use sleep from path for docker.sls_build
@ \fI2016\-11\-30 18:08:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a041277ea Merge pull request \fI\%#37954\fP from gtmanfred/2016.11
.IP \(bu 2
9caf0b406d use sleep from path for docker.sls_build
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37935\fP: (\fI\%ipmb\fP) Postgres module regression on 2016.11 (refs: \fI\%#37946\fP, \fI\%#37993\fP, \fI\%#38023\fP, \fI\%#38058\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37993\fP: (\fI\%ticosax\fP) Remove initdb dependency to consume postgres module. (refs: \fI\%#38058\fP)
@ \fI2016\-11\-30 18:08:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ef5c98845 Merge pull request \fI\%#37993\fP from ticosax/remove\-initdb\-requirement
.IP \(bu 2
c5c7a53d72 Remove initdb dependency to consume postgres module.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37997\fP: (\fI\%cachedout\fP) Update gem test for 2016.11
@ \fI2016\-11\-30 17:13:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e5565685c Merge pull request \fI\%#37997\fP from cachedout/gem_test_carbon
.IP \(bu 2
1d221aa91c Update gem test for 2016.11
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36723\fP: (\fI\%white\-hat\fP) ext_pillar_first option is broken in 2016.3 (refs: \fI\%#36807\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24501\fP: (\fI\%astehlik\fP) Order in top.sls file is not respected for pillar data in local mode (refs: \fI\%#31316\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#19332\fP: (\fI\%QuinnyPig\fP) Nondeterminism in Pillar (refs: \fI\%#31316\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37979\fP: (\fI\%terminalmage\fP) Revert addition of pillar_roots_override_ext_pillar
@ \fI2016\-11\-30 14:34:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36807\fP: (\fI\%terminalmage\fP) Fix pillar merging when ext_pillar_first is enabled (refs: \fI\%#37979\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31316\fP: (\fI\%kraney\fP) Let ext_pillar_first determine the override order (refs: \fI\%#37979\fP)
.IP \(bu 2
ca3a9488f1 Merge pull request \fI\%#37979\fP from terminalmage/revert\-pillar\-change
.IP \(bu 2
6135dfa4dd Revert addition of pillar_roots_override_ext_pillar
.IP \(bu 2
\fBPR\fP \fI\%#37970\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37958\fP to 2016.11
.IP \(bu 2
\fBPR\fP \fI\%#37958\fP: (\fI\%mirceaulinic\fP) Fix RST link format in Carbon release notes (refs: \fI\%#37970\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37971\fP: (\fI\%rallytime\fP) Lint 2016.11 sooner rather than later
.IP \(bu 2
\fBPR\fP \fI\%#37955\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11 (refs: \fI\%#37971\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37935\fP: (\fI\%ipmb\fP) Postgres module regression on 2016.11 (refs: \fI\%#37946\fP, \fI\%#37993\fP, \fI\%#38023\fP, \fI\%#38058\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37946\fP: (\fI\%scott\-w\fP) Updated the bins_dir to default to pg_bin
@ \fI2016\-11\-29 16:48:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
36f91408c5 Merge pull request \fI\%#37946\fP from scott\-w/37935\-fix\-bin\-dir
.IP \(bu 2
d33d403969 Restored missing initdb \fI\%#37935\fP
.IP \(bu 2
a041b9f8e8 Use Salt deprecation warning \fI\%#37935\fP
.IP \(bu 2
a96789353f Updated the bins_dir to default to pg_bin \fI\%#37935\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37889\fP: (\fI\%isbm\fP) Allow overwrite archives extraction (refs: \fI\%#38036\fP)
@ \fI2016\-11\-29 16:18:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
d8650c5474 Merge pull request \fI\%#37889\fP from isbm/isbm\-states\-archive\-fix
.IP \(bu 2
e67706bd29 Document the behaviour.
.IP \(bu 2
1970814111 Prevent crash during externally changed archive permissions
.IP \(bu 2
91b42578b2 Add overwrite option so the extraction of the archive can be always performed.
.IP \(bu 2
e6958f7f15 Remove nonsense comment and react on generally absent path name
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37869\fP: (\fI\%isbm\fP) Input sanitation (16.11)
@ \fI2016\-11\-29 16:17:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
e2b9e58d30 Merge pull request \fI\%#37869\fP from isbm/isbm\-input\-sanitation\-16.11
.IP \(bu 2
f9ec5d68af Use six instead of builtins
.IP \(bu 2
203dfcb238 Use American spelling instead
.IP \(bu 2
91ed307af9 Sanitise input for the keys and IDs
.IP \(bu 2
86623f913d Add a stub for ID sanitiser (at the moment same as hostname)
.IP \(bu 2
637144c841 Rename \(dqgeneral.py\(dq to \(dqsanitisers.py\(dq
.IP \(bu 2
f2571fc8bf Add hostname sanitiser
.IP \(bu 2
3ae086aff4 Add filename sanitiser
.IP \(bu 2
816b1d1977 Add general sanitisers
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37884\fP: (\fI\%isbm\fP) Do not include \(dqgpg\-pubkey\(dq packages, filtering by their name
@ \fI2016\-11\-28 21:11:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
e539a94a56 Merge pull request \fI\%#37884\fP from isbm/isbm\-zypper\-gpgkey\-pkg\-filter
.IP \(bu 2
038374a586 Do not include \(dqgpg\-pubkey\(dq packages, filtering by their name
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37882\fP: (\fI\%attiasr\fP) multiple issues in boto_rds state and module
@ \fI2016\-11\-28 21:09:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
eb3d81a1de Merge pull request \fI\%#37882\fP from attiasr/fix_missing_tags
.IP \(bu 2
73b3c5fa1a Add newline
.IP \(bu 2
166c42bc51 fix boto_rds.describe
.IP \(bu 2
ddd88ba047 fix boto_rds.describe  parameters and subnetgroup_present
.IP \(bu 2
bfe7f92cb4 fix missing tags in call to boto_rds.exists
.IP \(bu 2
\fBPR\fP \fI\%#37931\fP: (\fI\%rallytime\fP) Remove release candidate doc ref from 2016.11.0 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37930\fP: (\fI\%cachedout\fP) Remove dictionary comprehension in netusers
@ \fI2016\-11\-28 20:27:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
3d2dabc7b7 Merge pull request \fI\%#37930\fP from cachedout/fix_comp
.IP \(bu 2
670e83200b Remove dictionary comprehension in netusers
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37923\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2016\-11\-28 19:55:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
0f8b187d15 Merge pull request \fI\%#37923\fP from rallytime/merge\-2016.11
.IP \(bu 2
da7f5518eb Don\(aqt let 2016.3 doc config changes overwrite the 2016.11 changes
.IP \(bu 2
dfedd1185a Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
c35ba1f390 Merge pull request \fI\%#37916\fP from rallytime/doc\-update\-2016.3
.INDENT 2.0
.IP \(bu 2
bd40592289 [2016.3] Update version numbers in doc config for 2016.11.0 release
.UNINDENT
.IP \(bu 2
e13a2488c8 Merge pull request \fI\%#37785\fP from Cloudtek/ddns\-respect\-trailing\-dot
.INDENT 2.0
.IP \(bu 2
262e3b3697 respect trailing dot in ddns name parameter
.UNINDENT
.IP \(bu 2
c03b389422 Merge pull request \fI\%#37895\fP from fj40crawler/fix\-augeas\-return\-for\-test
.INDENT 2.0
.IP \(bu 2
ddc238df36 Fixed augeas_test.py to match True v.s. None for test_change_in_test_mode
.IP \(bu 2
ef75c459c0 Merge branch \(aq2016.3\(aq of github.com:saltstack/salt into fix\-augeas\-return\-for\-test
.IP \(bu 2
b0fe0cd256 Change return value for salt/states/augeas.py to be True instead of None for cases where salt is run with test=True. Fixes \fI\%#37870\fP
.UNINDENT
.IP \(bu 2
fdbc31e8d8 Merge pull request \fI\%#37907\fP from Talkless/patch\-2
.INDENT 2.0
.IP \(bu 2
072a319490 Fix server trust in test run of svn.latest
.UNINDENT
.IP \(bu 2
f39fdf443f Merge pull request \fI\%#37896\fP from toanju/2016.3
.INDENT 2.0
.IP \(bu 2
c95304188e rh networking: add missing values
.UNINDENT
.IP \(bu 2
ea935c5a91 Merge pull request \fI\%#37886\fP from bdrung/fix\-typos
.INDENT 2.0
.IP \(bu 2
9a51ba5c5b Fix various spelling mistakes
.UNINDENT
.IP \(bu 2
371b0a86d9 Merge pull request \fI\%#37736\fP from dhaines/issue\-37732
.INDENT 2.0
.IP \(bu 2
7ef590a505 Update selinux.py
.IP \(bu 2
516a67e6a3 fix indexing error
.IP \(bu 2
4e49c1e991 fix typo
.IP \(bu 2
b16f2d8400 handle semodule version >=2.4 (\fI\%#37732\fP) and fix typo
.UNINDENT
.IP \(bu 2
87aeb66fbf Merge pull request \fI\%#37797\fP from clan/extfs
.INDENT 2.0
.IP \(bu 2
acf0f960ef check count of columns after split
.UNINDENT
.IP \(bu 2
f7c7109152 Merge pull request \fI\%#37762\fP from twangboy/fix_chocolatey_state
.INDENT 2.0
.IP \(bu 2
9696b6dfa5 Use keyword args instead of relying on ordering
.IP \(bu 2
398eaa074d Add pre_versions to the available arguments
.UNINDENT
.IP \(bu 2
56baa92d55 Merge pull request \fI\%#37866\fP from meaksh/2016.3\-bp\-37149\-36938\-36784
.INDENT 2.0
.IP \(bu 2
9d8d578109 Fix pkg.latest_version when latest already installed
.IP \(bu 2
ffca0d491c \- acl.delfacl: fix position of \-X option to setfacl
.IP \(bu 2
3dfed6b841 Adjust linux_acl unit test argument ordering
.IP \(bu 2
f185ecdde1 core.py: quote style fixed
.IP \(bu 2
8404d13424 Setting up OS grains for SLES Expanded Support (SUSE\(aqs Red Hat compatible platform)
.UNINDENT
.IP \(bu 2
d0cc7f0d56 Merge pull request \fI\%#37863\fP from rallytime/bp\-36893
.INDENT 2.0
.IP \(bu 2
4c70534991 Add versionadded to reauth option in dockerng module
.IP \(bu 2
5ca2c388c2 added documentation for the new reuth option in docker registry configuration
.IP \(bu 2
5b0c11ab47 add option to force a reauth for a docker registry
.UNINDENT
.IP \(bu 2
b17a118e72 add multiline encryption documentation to nacl (\fI\%#37847\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37927\fP: (\fI\%thatch45\fP) Add a release notes reference to the docker\-sls tutorial
.IP \(bu 2
\fBPR\fP \fI\%#37917\fP: (\fI\%rallytime\fP) [2016.11] Update version numbers in doc config for 2016.11.0 release
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37890\fP: (\fI\%bbinet\fP) Fix support for extra_mods=\(aqsix\(aq to add six module to a thin.tgz tarball
@ \fI2016\-11\-28 13:53:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
ee00592995 Merge pull request \fI\%#37890\fP from bbinet/fix\-genthin\-six
.IP \(bu 2
7fceaa3476 Fix support for extra_mods=\(aqsix\(aq to add six module to a thin.tgz tarball
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37713\fP: (\fI\%aboe76\fP) masterless minion can\(aqt call pillar.item from pillar stack (development branch) (refs: \fI\%#37843\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37843\fP: (\fI\%terminalmage\fP) Don\(aqt skip pillar compilation when master_type==\(aqdisable\(aq
.IP \(bu 2
\fBPR\fP \fI\%#32521\fP: (\fI\%adelcast\fP) Fix salt\-call on standalone minion case (refs: \fI\%#37843\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37449\fP: (\fI\%thatch45\fP) Allow TLS connections in the Tornado TCP transport (refs: \fI\%#37776\fP, \fI\%#37859\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37849\fP: (\fI\%skizunov\fP) Eliminate warning when \(aqssl\(aq not set
.IP \(bu 2
\fBPR\fP \fI\%#37776\fP: (\fI\%DmitryKuzmenko\fP) Full TLS/SSL options support as provided by Tornado TCPServer. (refs: \fI\%#37849\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37449\fP: (\fI\%thatch45\fP) Allow TLS connections in the Tornado TCP transport (refs: \fI\%#37776\fP, \fI\%#37859\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37859\fP: (\fI\%DmitryKuzmenko\fP) TLS example config
.IP \(bu 2
\fBPR\fP \fI\%#37841\fP: (\fI\%terminalmage\fP) Clarify the master_type docs
.IP \(bu 2
\fBPR\fP \fI\%#37831\fP: (\fI\%skizunov\fP) PY3: Fix exception when handling connect exception in TCP transport
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37829\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2016\-11\-22 15:26:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd81d2fa67 Merge pull request \fI\%#37829\fP from rallytime/merge\-2016.11
.IP \(bu 2
3d6d32edc5 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
aa3748744c add missing chloginclass (\fI\%#37827\fP)
.IP \(bu 2
0e74bad284 Update branch refs to more relevant branch (\fI\%#37826\fP)
.IP \(bu 2
6a9b49c782 Add \(dqnames\(dq option to file state docs: point users to highstate doc examples (\fI\%#37823\fP)
.IP \(bu 2
aaf587de63 Clarify keystone.user_present password state docs with default behavior (\fI\%#37821\fP)
.IP \(bu 2
c300863159 Add some dependency documentation to libvirt docs (\fI\%#37820\fP)
.IP \(bu 2
485270f74e Merge pull request \fI\%#37772\fP from bdrung/openssl1.1
.INDENT 2.0
.IP \(bu 2
819c9658ed Support initializing OpenSSL 1.1
.UNINDENT
.IP \(bu 2
4910912ffa Update orchestrate runner file.copy doc example (\fI\%#37817\fP)
.IP \(bu 2
c5d3d8b66a Merge pull request \fI\%#37816\fP from rallytime/bp\-32157
.INDENT 2.0
.IP \(bu 2
d9c297119e Add quotes to cron doc
.UNINDENT
.IP \(bu 2
97e6b6aabe Merge pull request \fI\%#37812\fP from rallytime/bp\-37790
.INDENT 2.0
.IP \(bu 2
ca3b6e7874 Update proxmox.rst with more options and LXC
.UNINDENT
.IP \(bu 2
27703c54bc Merge pull request \fI\%#37811\fP from rallytime/bp\-37789
.INDENT 2.0
.IP \(bu 2
ba3fef48e1  fix comment
.IP \(bu 2
a021f76a9b issue: 37751 Add documentation for option privileged
.UNINDENT
.IP \(bu 2
adac9d7c0c Merge pull request \fI\%#37810\fP from rallytime/bp\-37775
.INDENT 2.0
.IP \(bu 2
2bed91437b Document \fIpython\fP argument in \fIsalt.states.virtualenv_mod\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37794\fP: (\fI\%sjorge\fP) network.routes should not raise exception if no interface
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37815\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2016\-11\-21 20:22:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
628c4a3d27 Merge pull request \fI\%#37815\fP from rallytime/merge\-2016.11
.IP \(bu 2
c6b5fd3715 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
7de784411d Add nodegroup check to ckminions (\fI\%#37763\fP)
.IP \(bu 2
d674369efc Fix ip/port issue with salt\-call (\fI\%#37766\fP)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37449\fP: (\fI\%thatch45\fP) Allow TLS connections in the Tornado TCP transport (refs: \fI\%#37776\fP, \fI\%#37859\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37776\fP: (\fI\%DmitryKuzmenko\fP) Full TLS/SSL options support as provided by Tornado TCPServer. (refs: \fI\%#37849\fP)
@ \fI2016\-11\-21 20:11:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
0b30b93dbb Merge pull request \fI\%#37776\fP from DSRCorporation/features/37449_tls
.IP \(bu 2
6857b9b8b1 Documented new TLS/SSL settings.
.IP \(bu 2
e42898f2e3 Full TLS/SSL options support as provided by Tornado TCPServer.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37773\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2016\-11\-18 19:18:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
3835f91d99 Merge pull request \fI\%#37773\fP from rallytime/merge\-2016.11
.IP \(bu 2
c859fc9ec1 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
c62ff6b023 Add thorium path to syspaths (\fI\%#37767\fP)
.IP \(bu 2
bff949f4e9 Merge pull request \fI\%#37760\fP from hu\-dabao/fix_cb_returner
.INDENT 2.0
.IP \(bu 2
de372f277e 1. returner no need to check whether the jid exists for external job cache setup 2. add full_ret to return doc so that the document will be informative 3. make ttl as a config attribute because salt\-minion does not have keep_jobs attribute 4. add password into config attribute 5. update the documents accordingly
.UNINDENT
.IP \(bu 2
1f976ac212 Merge pull request \fI\%#37738\fP from terminalmage/issue36629
.INDENT 2.0
.IP \(bu 2
da46678c51 Allow pillar.get to retrieve fresh pillar data when saltenv passed
.UNINDENT
.IP \(bu 2
7aee7fc63c Switch default filter tag for ONE resources from user only to all resources (\fI\%#37745\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37764\fP: (\fI\%mirceaulinic\fP) Doc fixes and \fIreplace\fP feature
@ \fI2016\-11\-18 03:15:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
6f0f70c9a3 Merge pull request \fI\%#37764\fP from cloudflare/NET\-UPDATE
.IP \(bu 2
c3f0202fdd Replace feature and doc fixes
.UNINDENT
.UNINDENT
.SS Salt 2016.11.10 Release Notes
.sp
Version 2016.11.10 is a security release for \fI\%2016.11.0\fP\&.
.SS Changes for v2016.11.9..v2016.11.10
.SS Security Fix
.sp
CVE\-2018\-15751 Remote command execution and incorrect access control when using salt\-api.
.sp
CVE\-2018\-15750 Directory traversal vulnerability when using salt\-api. Allows an attacker to determine what files exist on a server when querying /run or /events.
.sp
Credit and thanks for discovery and responsible disclosure: nullbr4in, xcuter, koredge, loupos, blackcon, Naver Business Platform
.SS Salt 2016.11.2 Release Notes
.sp
Version 2016.11.2 is a bugfix release for \fI\%2016.11.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB157\fP
.IP \(bu 2
Total Issue References: \fB34\fP
.IP \(bu 2
Total PR References: \fB116\fP
.IP \(bu 2
Contributors: \fB45\fP (\fI\%Ch3LL\fP, \fI\%Cybolic\fP, \fI\%DmitryKuzmenko\fP, \fI\%UtahDave\fP, \fI\%Vaelatern\fP,
\fI\%alex\-zel\fP, \fI\%alxwr\fP, \fI\%amendlik\fP, \fI\%anlutro\fP, \fI\%aosagie\fP, \fI\%basdusee\fP, \fI\%bbinet\fP,
\fI\%benediktwerner\fP, \fI\%cachedout\fP, \fI\%clinta\fP, \fI\%cro\fP, \fI\%dereckson\fP, \fI\%disaster123\fP, \fI\%ewapptus\fP,
\fI\%ezh\fP, \fI\%folti\fP, \fI\%gmacon\fP, \fI\%gqgunhed\fP, \fI\%gtmanfred\fP, \fI\%kkoppel\fP, \fI\%lorengordon\fP,
\fI\%martintamare\fP, \fI\%mcalmer\fP, \fI\%meaksh\fP, \fI\%mirceaulinic\fP, \fI\%mostafahussein\fP, \fI\%mvdwalle\fP,
\fI\%rallytime\fP, \fI\%rbjorklin\fP, \fI\%scthi\fP, \fI\%sjorge\fP, \fI\%techhat\fP, \fI\%terminalmage\fP, \fI\%tsaridas\fP,
\fI\%twangboy\fP, \fI\%vutny\fP, \fI\%wolfpackmars2\fP, \fI\%yhekma\fP, \fI\%yopito\fP, \fI\%yue9944882\fP)
.UNINDENT
.SS Security Fixes
.sp
\fBCVE\-2017\-5192\fP local_batch client external authentication not respected
.sp
The \fBLocalClient.cmd_batch()\fP method client does not accept \fBexternal_auth\fP
credentials and so access to it from salt\-api has been removed for now. This
vulnerability allows code execution for already\-authenticated users and is only
in effect when running salt\-api as the \fBroot\fP user.
.sp
\fBCVE\-2017\-5200\fP Salt\-api allows arbitrary command execution on a salt\-master
via Salt\(aqs ssh_client
.sp
Users of Salt\-API and salt\-ssh could execute a command on the salt master via a
hole when both systems were enabled.
.sp
We recommend everyone upgrade to 2016.11.2 as soon as possible.
.SS Changelog for v2016.11.1..v2016.11.2
.sp
\fIGenerated at: 2018\-05\-27 19:28:11 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#38859\fP: (\fI\%alxwr\fP) fix parsing of sockstat \-4
@ \fI2017\-01\-23 16:47:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec59ae67c8 Merge pull request \fI\%#38859\fP from alxwr/2016.11
.IP \(bu 2
30fe5641c7 fix parsing of sockstat \-4
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38850\fP: (\fI\%techhat\fP) Strip .p from cache file names
@ \fI2017\-01\-23 16:28:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
5fe6db6201 Merge pull request \fI\%#38850\fP from techhat/stripcache
.IP \(bu 2
109cb62e76 Remove .p from test
.IP \(bu 2
534aa3f527 Strip .p from cache file names
.IP \(bu 2
\fBPR\fP \fI\%#38848\fP: (\fI\%Ch3LL\fP) add 2016.11.2 changelog to release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38819\fP: (\fI\%twangboy\fP) Remove \fIUsers\fP from c:\esalt [DO NOT MERGE FORWARD]
@ \fI2017\-01\-20 20:17:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
4913c4f90c Merge pull request \fI\%#38819\fP from twangboy/salt_perms_2016.11
.IP \(bu 2
eb04ed7eef Remove \fIUser\fP from c:salt
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38815\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-01\-20 18:53:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
a275b9714e Merge pull request \fI\%#38815\fP from rallytime/merge\-2016.11
.IP \(bu 2
ce6d1b103d Make sure we\(aqre using the opts dict mocking in parsers_test
.IP \(bu 2
315b2c8712 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
d14f0c64eb Merge pull request \fI\%#38812\fP from rallytime/pyobjects\-test
.INDENT 2.0
.IP \(bu 2
f3e84c1ab7 Update pyobjects test to be a list
.UNINDENT
.IP \(bu 2
50f03f8057 Merge pull request \fI\%#38813\fP from gtmanfred/2016.3
.INDENT 2.0
.IP \(bu 2
ce3472cec2 catch SIGPIPE in vmware connection
.UNINDENT
.IP \(bu 2
23b8b47258 Merge pull request \fI\%#38809\fP from twangboy/fix_hostname_2016.3
.INDENT 2.0
.IP \(bu 2
d57a51f9f9 Fix tests for get_hostname
.IP \(bu 2
7ca3fd7484 Fix get_hostname to handle longer computer names
.UNINDENT
.IP \(bu 2
1033bbdde8 Merge pull request \fI\%#38808\fP from vutny/fix\-38388
.INDENT 2.0
.IP \(bu 2
9bd203ffcc Fix \fI\%#38388\fP
.UNINDENT
.IP \(bu 2
f3ae3cd5c8 Merge pull request \fI\%#38668\fP from terminalmage/issue38604
.INDENT 2.0
.IP \(bu 2
0ea97cdad9 Merge pull request \fI\%#10\fP from cachedout/pr\-38668
.INDENT 2.0
.IP \(bu 2
db81afc035 Munge retcode into return data for batching
.UNINDENT
.IP \(bu 2
a642a995dc Return the ret data from batch execution instead of raw data
.UNINDENT
.IP \(bu 2
c6a19a9e5a Merge pull request \fI\%#38789\fP from rallytime/fix\-38622
.INDENT 2.0
.IP \(bu 2
af41fe0c6e Update some saltenv refs to environment in salt.modules.state docs
.UNINDENT
.IP \(bu 2
e0bf700020 Merge pull request \fI\%#38790\fP from cachedout/fix_pyobjects_test_typo
.INDENT 2.0
.IP \(bu 2
a66afb5f0f Fix typo in pyobjects test
.UNINDENT
.IP \(bu 2
6e9785edea Merge pull request \fI\%#38792\fP from rallytime/fix\-38629
.INDENT 2.0
.IP \(bu 2
1e125e2844 Update pillar tutorial lanuage regarding pillar_opts settings
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38832\fP: (\fI\%terminalmage\fP) archive.extracted: Identify symlinks when checking for incorrect types
@ \fI2017\-01\-20 18:36:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
efe1bf10e8 Merge pull request \fI\%#38832\fP from terminalmage/issue38711
.IP \(bu 2
d10c068e25 Update archive state unit tests to reflect symlinks in archive.list
.IP \(bu 2
d6adfb6d12 Identify symlinks when looking for incorrect types
.IP \(bu 2
09b9e95f7c archive.list: organize symlinks separately from files in verbose mode
.IP \(bu 2
e6483f096d Support removing symlinks in salt.utils.rm_rf
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38726\fP: (\fI\%twangboy\fP) Add VC Redist 2008 SP1 MFC to installer
@ \fI2017\-01\-19 19:13:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
10a3d8b8dd Merge pull request \fI\%#38726\fP from twangboy/vcredist
.IP \(bu 2
f00a65355d change extensions .ext to .exe
.IP \(bu 2
98c40e278c Add VC Redist 2008 SP1 MFC to installer
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38810\fP: (\fI\%UtahDave\fP) Fix beacon doc
@ \fI2017\-01\-18 21:37:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
d5f2d92a4e Merge pull request \fI\%#38810\fP from UtahDave/fix_beacon_doc_zd1035
.IP \(bu 2
dbe9edb806 fix reactor example.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38811\fP: (\fI\%techhat\fP) Show a lot less data when requesting a VM
@ \fI2017\-01\-18 21:08:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
88faf08a71 Merge pull request \fI\%#38811\fP from techhat/sanvm
.IP \(bu 2
47c19325cf Show a lot less data when requesting a VM
.IP \(bu 2
\fBPR\fP \fI\%#38807\fP: (\fI\%Ch3LL\fP) refine the os detection in archive test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38799\fP: (\fI\%aosagie\fP) Parse ansible dynamic inventory output correctly
@ \fI2017\-01\-18 15:32:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
e3ca6881c8 Merge pull request \fI\%#38799\fP from aosagie/fix\-ansible\-dynamic\-roster
.IP \(bu 2
26d6f699a7 Parse ansible dynamic inventory output correctly
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38787\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-01\-18 08:39:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
76df6a43f3 Merge pull request \fI\%#38787\fP from rallytime/merge\-2016.11
.IP \(bu 2
2aad54c49f Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
3417adc617 Merge pull request \fI\%#38796\fP from saltstack/revert\-38707\-root_dir_fix\-gh
.INDENT 2.0
.IP \(bu 2
cb080f3bbe Revert \(dqFixed prepending of root_dir override to the other paths\(dq
.UNINDENT
.UNINDENT
.IP \(bu 2
64d866f7ab Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
bab3479a3c Merge pull request \fI\%#38585\fP from rallytime/follow\-up\-38527
.INDENT 2.0
.IP \(bu 2
05587201b6 Pylint fix: add line at end of file
.IP \(bu 2
fa01367599 Keep a copy of the DEFAULT_API_OPTS and restore them after the test run
.IP \(bu 2
2ad07634d9 Test clean up
.IP \(bu 2
fd2ee7db30 Add some simple unit tests for salt.config.api_config function
.IP \(bu 2
3d2fefc83b Make sure the pidfile and log_file values are overridden by api opts
.IP \(bu 2
1f6b540e46 Make sure the pidfile and log_file values are overridden by api opts
.IP \(bu 2
04d307f917 salt\-api no longer forces the default timeout
.UNINDENT
.IP \(bu 2
0fb6bb7b77 Merge pull request \fI\%#38707\fP from alexbleotu/root_dir_fix\-gh
.INDENT 2.0
.IP \(bu 2
0bac8c8be3 Fixed prepending of root_dir override to the other paths
.UNINDENT
.IP \(bu 2
96c9dc10f7 Merge pull request \fI\%#38774\fP from vutny/dev\-test\-docs
.INDENT 2.0
.IP \(bu 2
4620dc4afa DOCS: add C++ compiler installation on RHEL required for bundled 0mq
.UNINDENT
.IP \(bu 2
aedfbb7a43 Merge pull request \fI\%#38749\fP from vutny/pkg\-build\-better\-exception\-msg
.INDENT 2.0
.IP \(bu 2
53f2be5b21 pkg build modules throw better exception message if keyid wasn\(aqt found
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38660\fP: (\fI\%techhat\fP) Don\(aqt force salt.cache to use cachedir from opts
@ \fI2017\-01\-17 18:38:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
4e6146f65f Merge pull request \fI\%#38660\fP from techhat/cachedir
.IP \(bu 2
be55b57abf One last fix
.IP \(bu 2
fc24b24998 Add correct function name
.IP \(bu 2
9bbecf7960 Typo fix
.IP \(bu 2
436ba28f08 Change getlist back to list (using _list)
.IP \(bu 2
ff734fe93b Default to CACHE_DIR in syspaths
.IP \(bu 2
380abd3744 Add cachedir args to tests
.IP \(bu 2
deb08c0587 Not every module will need cachedir
.IP \(bu 2
4489f7cac0 Don\(aqt force salt.cache to use cachedir from opts
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37948\fP: (\fI\%djacobs2016\fP) ssh_known_hosts.present is failing when checking key/host (refs: \fI\%#37982\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33932\fP: (\fI\%folti\fP) ssh_known_hosts.present: hashing global known hosts file makes it readable by root only (refs: \fI\%#33933\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38667\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37982\fP to 2016.11
@ \fI2017\-01\-17 15:42:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37982\fP: (\fI\%wolfpackmars2\fP) Update ssh.py (refs: \fI\%#38667\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33933\fP: (\fI\%folti\fP) ssh: keep original permissions, when hashing known_hosts (refs: \fI\%#38667\fP)
.IP \(bu 2
89dc86e2bc Merge pull request \fI\%#38667\fP from rallytime/bp\-37982
.IP \(bu 2
be91e46a93 Update ssh.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38759\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-01\-17 15:22:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
751e14c523 Merge pull request \fI\%#38759\fP from rallytime/merge\-2016.11
.IP \(bu 2
30e8a66fb0 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
8466b34e82 Merge pull request \fI\%#38743\fP from rallytime/merge\-2016.3
.INDENT 2.0
.IP \(bu 2
d24776f5e9 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
6869621ed1 Merge pull request \fI\%#38731\fP from rallytime/merge\-2015.8
.INDENT 2.0
.IP \(bu 2
9eb191b6ac Pylint fix
.IP \(bu 2
b910499dbe Various follow up fixes
.IP \(bu 2
e8309a6bbf Add release notes for 2015.8.13
.IP \(bu 2
f881f366b7 Merge pull request \fI\%#20\fP from rallytime/2015.8.12_follow_up\-batch\-tests
.INDENT 2.0
.IP \(bu 2
34282322c0 Clean up tests and docs for batch execution
.UNINDENT
.IP \(bu 2
c80b20b957 Merge pull request \fI\%#19\fP from whiteinge/batchclient
.INDENT 2.0
.IP \(bu 2
3d8f3d18f6 Remove batch execution from NetapiClient and Saltnado
.UNINDENT
.IP \(bu 2
97b0f64923 Lintfix
.IP \(bu 2
d1516664f7 Add explanation comment
.IP \(bu 2
62f2c87080 Add docstring
.IP \(bu 2
9b0a786aeb Explain what it is about and how to configure that
.IP \(bu 2
5ea3579e10 Pick up a specified roster file from the configured locations
.IP \(bu 2
3a8614c5df Disable custom rosters in API
.IP \(bu 2
c0e5a1171d Add roster disable flag
.UNINDENT
.IP \(bu 2
e9c59e9b8f Merge pull request \fI\%#38602\fP from terminalmage/fix\-boto\-test
.IP \(bu 2
3424a108ac Fix failing unit.states.boto_vpc_test.BotoVpcRouteTableTestCase.test_present_with_routes
.UNINDENT
.IP \(bu 2
a642cdef79 Merge pull request \fI\%#38723\fP from rallytime/fix\-38674
.INDENT 2.0
.IP \(bu 2
706c885f55 Remove \(dqevent_publisher_pub_hwm\(dq and \(dqsalt_event_pub_hwm\(dq from config/__init__.py
.UNINDENT
.IP \(bu 2
fc545af10b Merge pull request \fI\%#38669\fP from rallytime/update\-bootstrap\-script
.INDENT 2.0
.IP \(bu 2
78ba76e34c Update bootstrap script verstion to latest release
.UNINDENT
.IP \(bu 2
50d417f267 Merge pull request \fI\%#38693\fP from twangboy/update_jinja
.INDENT 2.0
.IP \(bu 2
e0c7e5549b Update jinja2 to 2.9.4
.UNINDENT
.IP \(bu 2
f4233bb18d Merge pull request \fI\%#38739\fP from vutny/fix\-runtests\-doc
.INDENT 2.0
.IP \(bu 2
b872bb63f6 DOCS: correct examples of running test suite
.UNINDENT
.IP \(bu 2
51d4707071 DOCS: add links to File State Backups page where necessary (\fI\%#38735\fP)
.IP \(bu 2
6d3717b9ee Proofread jinja_to_execution_module tutorial (\fI\%#38720\fP)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38775\fP: (\fI\%charburns\fP) Error using napalm netusers (refs: \fI\%#38778\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38778\fP: (\fI\%mirceaulinic\fP) Fix \(dqError using napalm netusers\(dq
@ \fI2017\-01\-17 15:20:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb6291d93a Merge pull request \fI\%#38778\fP from cloudflare/fix\-38775
.IP \(bu 2
b3388f7162 Fix \fI\%#38775\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38528\fP: (\fI\%MorphBonehunter\fP) x509 make permissions configurable (refs: \fI\%#38664\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38081\fP: (\fI\%haraldrudell\fP) x509 state or module cannot generate password protected private keys (refs: \fI\%#38664\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38664\fP: (\fI\%clinta\fP) X509 Improvements. Expose setting permissions, encrypted private keys, and combined key and cert management in one state
@ \fI2017\-01\-17 02:20:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
6663107021 Merge pull request \fI\%#38664\fP from clinta/x509\-passphrase2
.IP \(bu 2
77c78723fe pep8
.IP \(bu 2
a2b20ee518 No mutable default args, remove unneeded import
.IP \(bu 2
b48b85cc70 bug fixes
.IP \(bu 2
f62393b864 pep8
.IP \(bu 2
c8613243a1 change documentation
.IP \(bu 2
9a0abde9ac expose passphrase functionality to state
.IP \(bu 2
e47a93d496 add passphrase to execution module
.IP \(bu 2
a4d6598f1e preserve detailed change reports
.IP \(bu 2
d0ad251778 combine private key and cert management
.IP \(bu 2
3d1474d911 cross call file.managed to get permissions options
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38682\fP: (\fI\%mirceaulinic\fP) [2016.11.2/napalm] Better error message when NotImplementedError raised
@ \fI2017\-01\-15 18:34:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf6d74c98e Merge pull request \fI\%#38682\fP from cloudflare/NotImplementedError\-MSG
.IP \(bu 2
f847639dee Better error message when NotImplementedError raised
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37996\fP: (\fI\%stefan\-as\fP) influxdb_user.present does not pass client_args (refs: \fI\%#38695\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38695\fP: (\fI\%rallytime\fP) Pass in client_args when calling influxdb execution module funcs
@ \fI2017\-01\-15 18:33:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
df12e49d80 Merge pull request \fI\%#38695\fP from rallytime/fix\-37996
.IP \(bu 2
05b0975888 Pass in client_args when calling influxdb execution module funcs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38521\fP: (\fI\%vladvasiliu\fP) State cloud.present on AWS: TypeError: \(aqNoneType\(aq object is not iterable (refs: \fI\%#38651\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#37981\fP: (\fI\%tazaki\fP) Salt\-cloud ec2 vpc securitygroupid always returning default (refs: \fI\%#38183\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38651\fP: (\fI\%rallytime\fP) Don\(aqt lose the set reference for ec2 securitygroup ids
@ \fI2017\-01\-15 18:06:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38183\fP: (\fI\%cro\fP) Fix bad set operations when setting up securitygroups in AWS. (refs: \fI\%#38651\fP)
.IP \(bu 2
834e5469fc Merge pull request \fI\%#38651\fP from rallytime/fix\-38521
.IP \(bu 2
830c03cec6 Don\(aqt lose the set reference for ec2 securitygroup ids
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38216\fP: (\fI\%pgrishin\fP) salt\-run: can\(aqt get cache.grains (refs: \fI\%#38659\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38659\fP: (\fI\%techhat\fP) Turn None into an empty string (for minion matching)
@ \fI2017\-01\-15 18:02:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
8b38cfea8d Merge pull request \fI\%#38659\fP from techhat/issue38216
.IP \(bu 2
4073c91584 Turn None into an empty string (for minion matching)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38703\fP: (\fI\%yhekma\fP) The \fItest\fP option is only valid for the minion, not the master
@ \fI2017\-01\-15 17:56:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
0ad5d22ad4 Merge pull request \fI\%#38703\fP from yhekma/docfix
.IP \(bu 2
57df3bf148 The \fItest\fP option is only valid for the minion, not the master
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38718\fP: (\fI\%terminalmage\fP) Fix for dynamic git_pillar when pillarenv is used
@ \fI2017\-01\-15 14:37:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
8c1222e7db Merge pull request \fI\%#38718\fP from terminalmage/zd909
.IP \(bu 2
12bbea5a24 Fix for dynamic git_pillar when pillarenv is used
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38677\fP: (\fI\%yhekma\fP) consul cache backend broken (refs: \fI\%#38676\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38676\fP: (\fI\%yhekma\fP) Removed overloading of list()
@ \fI2017\-01\-15 05:42:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
aae8b54860 Merge pull request \fI\%#38676\fP from yhekma/2016.11
.IP \(bu 2
3237d23e1c Localfs should also be changed of course
.IP \(bu 2
9d9de67219 We do not want to overload the list() type because if we do, we turn this function into a recursive one, which results in an exception because set() cannot be concatenated with str (\(aq/\(aq)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38684\fP: (\fI\%rukender\fP) 2016.11.1 :[ERROR][11182] Failed to import beacons avahi_announce (refs: \fI\%#38713\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38713\fP: (\fI\%rallytime\fP) Add NameError to exception in avahi_announce beacon
@ \fI2017\-01\-15 05:33:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
c246ab41c5 Merge pull request \fI\%#38713\fP from rallytime/fix\-38684
.IP \(bu 2
db60bed24c Add NameError to exception in avahi_announce beacon
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38729\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-01\-13 23:15:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c14774c04 Merge pull request \fI\%#38729\fP from rallytime/merge\-2016.11
.IP \(bu 2
4e1e45d640 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
7b850d472d Merge pull request \fI\%#38647\fP from gtmanfred/nova
.INDENT 2.0
.IP \(bu 2
5be9b60851 add documentation about using keystoneauth for v3
.IP \(bu 2
7b657ca4ae add the ability to use keystone v2 and v3
.IP \(bu 2
5646ae1b34 add ability to use keystoneauth to authenticate in nova driver
.UNINDENT
.IP \(bu 2
383768d838 Merge pull request \fI\%#38650\fP from rallytime/remove\-ubuntu\-ppa\-docs
.INDENT 2.0
.IP \(bu 2
30429b2e44 Remove the installation instructions for out\-of\-date community ppa
.UNINDENT
.IP \(bu 2
7d9f56e3b5 Merge pull request \fI\%#38657\fP from DSRCorporation/bugs/38087_syndic_event_format_fix
.INDENT 2.0
.IP \(bu 2
594c33f396 Publish the \(aqdata\(aq field content for Syndic evets
.UNINDENT
.IP \(bu 2
83987511fd Merge pull request \fI\%#38649\fP from Ch3LL/test_apply_template
.INDENT 2.0
.IP \(bu 2
47f8b68e0b fix unit.modules.file_test
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38631\fP: (\fI\%doitian\fP) In Orchestration, kwargs are not passed to state.sls in masterless mode (refs: \fI\%#38635\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38635\fP: (\fI\%lorengordon\fP) Sends pass\-through params to state module
@ \fI2017\-01\-10 20:01:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
cfd82d1631 Merge pull request \fI\%#38635\fP from lorengordon/issue\-38631
.IP \(bu 2
14666138b9 Sends pass\-through params to state module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38640\fP: (\fI\%mirceaulinic\fP) Import napalm_base instead of napalm
@ \fI2017\-01\-10 19:58:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
017094a207 Merge pull request \fI\%#38640\fP from cloudflare/NAPALM\-IMPORTS
.IP \(bu 2
8f13f63880 Import napalm_base instead of napalm
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38661\fP: (\fI\%techhat\fP) Add sane cache defaults for minion and cloud
@ \fI2017\-01\-10 19:55:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
79663132dd Merge pull request \fI\%#38661\fP from techhat/sanedefault
.IP \(bu 2
aee40648ec Add a sane cache default for cloud
.IP \(bu 2
c9e01a36e7 Add a sane cache default for minions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38645\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-01\-10 19:54:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
b0ed91ce2d Merge pull request \fI\%#38645\fP from rallytime/merge\-2016.11
.IP \(bu 2
7a668e9749 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
74ddc71be3 Merge pull request \fI\%#38626\fP from saltstack/revert\-37358\-2016.3.3_issue37355
.INDENT 2.0
.IP \(bu 2
e912ac99c2 Revert \(dqFix/workaround for issue \fI\%#37355\fP\(dq
.UNINDENT
.IP \(bu 2
5e58b32934 Merge pull request \fI\%#37358\fP from Firewire2002/2016.3.3_issue37355
.INDENT 2.0
.IP \(bu 2
910da18bfd fixed typo
.IP \(bu 2
4fbc5ddd06 fixed wrong renamed variable and spaces
.IP \(bu 2
92366e646c issue \fI\%#37355\fP
.IP \(bu 2
7dc87ab7b8 issue \fI\%#37355\fP
.IP \(bu 2
2878180405 issue \fI\%#37355\fP
.UNINDENT
.IP \(bu 2
6c2fe615aa Merge pull request \fI\%#35390\fP from alexandr\-orlov/2016.3
.INDENT 2.0
.IP \(bu 2
cd5ae17e8d fxd missed proper grains dictionary
.UNINDENT
.IP \(bu 2
2579cfa42d Merge pull request \fI\%#38618\fP from rallytime/bp\-38579
.INDENT 2.0
.IP \(bu 2
2052ecee2c Add copy import
.IP \(bu 2
2c8845aaa0 add test for pillar.get() + default value
.IP \(bu 2
c2f98d2f04 ticket 38558: add unit test, deepcopy() only if necessary
.IP \(bu 2
30ae0a1958 added deepcopy of default if merge=True
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38627\fP: (\fI\%cachedout\fP) Pr 38476
@ \fI2017\-01\-06 22:05:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38476\fP: (\fI\%amendlik\fP) Key fingerprints (refs: \fI\%#38627\fP)
.IP \(bu 2
d67f6937d7 Merge pull request \fI\%#38627\fP from cachedout/pr\-38476
.IP \(bu 2
2a423ffedd Add changes to raetkey
.IP \(bu 2
55ad9d6c6c Add hash_type argument to MultiKeyCLI.finger_all function
.IP \(bu 2
c8681269a4 Add hash_type argument to key module fingerprint functions
.IP \(bu 2
d0f4c300b7 Add hash_type argument to wheel fingerprint functions
.IP \(bu 2
e558ddcb18 Add finger_master function to wheel.key module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38595\fP: (\fI\%yue9944882\fP) Redis ext job cache occurred error (refs: \fI\%#38610\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38610\fP: (\fI\%yue9944882\fP) Fix \fI\%#38595\fP \- Unexpected error log from redis retuner in master\(aqs log
@ \fI2017\-01\-06 21:47:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
b13cd1370f Merge pull request \fI\%#38610\fP from yue9944882/2016.11
.IP \(bu 2
54325cf293 Fix \fI\%#38595\fP \- Unexpected error log from redis retuner in master\(aqs log
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36148\fP: (\fI\%alex\-zel\fP) Eauth error with openLDAP groups (refs: \fI\%#38406\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38406\fP: (\fI\%alex\-zel\fP) Fix eauth error with openLDAP/389 directory server groups
@ \fI2017\-01\-06 21:40:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
179d385003 Merge pull request \fI\%#38406\fP from alex\-zel/fix\-eauth\-groups\-permissions
.IP \(bu 2
6b9e9d8f89 Fix eauth error with openLDAP/389 directory server groups
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38619\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-01\-06 17:51:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
82e9b3d1a1 Merge pull request \fI\%#38619\fP from rallytime/merge\-2016.11
.IP \(bu 2
0efb2d844e Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
da676cebd6 Merge pull request \fI\%#38601\fP from terminalmage/pillar\-get
.INDENT 2.0
.IP \(bu 2
8613d7254d pillar.get: Raise exception when merge=True and default is not a dict
.UNINDENT
.IP \(bu 2
224fc7712a Merge pull request \fI\%#38600\fP from terminalmage/issue38459\-2016.3
.INDENT 2.0
.IP \(bu 2
8a45b13e76 Avoid errors when sudo_user is set
.UNINDENT
.IP \(bu 2
a376970f88 Merge pull request \fI\%#38589\fP from tobithiel/fix_rvm_rbenv_warning
.INDENT 2.0
.IP \(bu 2
9ec470b4a5 State Gem: fix incorrect warning about missing rvm/rbenv
.UNINDENT
.IP \(bu 2
02e6a78254 Merge pull request \fI\%#38567\fP from pass\-by\-value/pgjsonb_queue_changes_2016.3
.INDENT 2.0
.IP \(bu 2
67879ebe65 Create queue if one doesn\(aqt exist
.UNINDENT
.IP \(bu 2
0889cbdb31 Merge pull request \fI\%#38587\fP from rallytime/fix\-37498
.INDENT 2.0
.IP \(bu 2
2a5880966f Change daemontools __virtualname__ from service to daemontools
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38612\fP: (\fI\%sjorge\fP) network.ifacestartswith throws exception on Solaris\-like platforms
@ \fI2017\-01\-06 17:20:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
f64e003a69 Merge pull request \fI\%#38612\fP from sjorge/2016.11\-solaris\-ifacestartswith
.IP \(bu 2
26fae54f5b network.ifacestartswith throws exception on Solaris\-like platforms
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37027\fP: (\fI\%sjorge\fP) Solaris FQDN/UQDN and documentation/consistency (refs: \fI\%#38615\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38615\fP: (\fI\%sjorge\fP) add note related to issue \fI\%#37027\fP
@ \fI2017\-01\-06 16:38:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
5820ceee16 Merge pull request \fI\%#38615\fP from sjorge/2016.11\-solarisdocs
.IP \(bu 2
fbdd32f46b add note related to issue \fI\%#37027\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38598\fP: (\fI\%terminalmage\fP) Avoid errors when sudo_user is set (refs: \fI\%#38600\fP, \fI\%#38599\fP)
@ \fI2017\-01\-05 23:16:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
a27fdb46a7 Merge pull request \fI\%#38598\fP from terminalmage/issue38459
.IP \(bu 2
b37f7ffa38 Avoid errors when sudo_user is set
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38599\fP: (\fI\%terminalmage\fP) archive.extracted: Prevent traceback when state.single cannot be run
@ \fI2017\-01\-05 23:16:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38598\fP: (\fI\%terminalmage\fP) Avoid errors when sudo_user is set (refs: \fI\%#38600\fP, \fI\%#38599\fP)
.IP \(bu 2
d6b7019df6 Merge pull request \fI\%#38599\fP from terminalmage/archive\-results\-handling
.IP \(bu 2
9aceb8186d archive.extracted: Prevent traceback when state.single cannot be run
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38517\fP: (\fI\%basdusee\fP) Slack.py engine 100% CPU load due to missing time.sleep(1) (refs: \fI\%#38520\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38520\fP: (\fI\%basdusee\fP) Fix issue \fI\%#38517\fP, added time.sleep(1) at line 227 in slack.py
@ \fI2017\-01\-05 20:35:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
d486b42ceb Merge pull request \fI\%#38520\fP from basdusee/fix\-issue\-38517
.IP \(bu 2
e3a883c915 Small fix on the fix regarding indentation
.IP \(bu 2
8adeae6f81 Fix issue \fI\%#38517\fP, added time.sleep(1) at line 227 in slack.py engine.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38485\fP: (\fI\%wasabi222\fP) bgp.config not working (refs: \fI\%#38499\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38577\fP: (\fI\%mirceaulinic\fP) Fix function headers as per \fI\%#38499\fP
@ \fI2017\-01\-05 18:41:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38499\fP: (\fI\%mirceaulinic\fP) Fix \fI\%#38485\fP (refs: \fI\%#38577\fP)
.IP \(bu 2
0706cde626 Merge pull request \fI\%#38577\fP from cloudflare/PREP\-2016.11.2
.IP \(bu 2
62bee3c793 Fix function headers as per \fI\%#38499\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38578\fP: (\fI\%mirceaulinic\fP) [2016.11] Port 5123f11 from develop into 2016.11.2
@ \fI2017\-01\-05 18:11:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
55d1747792 Merge pull request \fI\%#38578\fP from cloudflare/PORT\-5123f1
.IP \(bu 2
dea7866d57 Update net.load_template doc: 2016.11.2
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38462\fP: (\fI\%g\-shockfx\fP) Can\(gat add beacon memusage on Windows (refs: \fI\%#38584\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38584\fP: (\fI\%rallytime\fP) Allow memusage beacon to load on Windows
@ \fI2017\-01\-05 18:08:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
be69bafe6e Merge pull request \fI\%#38584\fP from rallytime/fix\-38462
.IP \(bu 2
1fe945df5e Allow memusage beacon to load on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38570\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11 (refs: \fI\%#38585\fP)
@ \fI2017\-01\-05 14:28:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
14b643fd48 Merge pull request \fI\%#38570\fP from rallytime/merge\-2016.11
.IP \(bu 2
30f14d15df Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
7b74436d13 Merge pull request \fI\%#38562\fP from rallytime/arch\-install\-docs
.INDENT 2.0
.IP \(bu 2
8b1897ace9 Update arch installation docs with correct package name
.UNINDENT
.IP \(bu 2
01860702cb Merge pull request \fI\%#38560\fP from Ch3LL/fix_api_log
.INDENT 2.0
.IP \(bu 2
1b45e9670b fix api logfile
.UNINDENT
.IP \(bu 2
0056620a53 Merge pull request \fI\%#38531\fP from rallytime/bp\-33601
.INDENT 2.0
.IP \(bu 2
c36cb39825 remove the unnecessary double trigger
.IP \(bu 2
38414493bf fix spacing lint error
.IP \(bu 2
8c1defc710 Remove uncessary type from alias commands. Deduplicate alias handling to autodetect function selection. Add error reporting to slack connectivty problems. Cleanup slack\(aqs unicode conversion
.IP \(bu 2
c2f23bc45e Fix slack engine to run on python2.6
.UNINDENT
.IP \(bu 2
50242c7f17 Merge pull request \fI\%#38541\fP from techhat/issue38187
.INDENT 2.0
.IP \(bu 2
eae3a435dd Strip user:pass from cached URLs
.UNINDENT
.IP \(bu 2
325dc56e59 Merge pull request \fI\%#38554\fP from multani/fix/30454
.INDENT 2.0
.IP \(bu 2
2e7f743371 yaml: support unicode serialization/deserialization
.IP \(bu 2
df76113c5c jinja: test the \(dqyaml\(dq filter with ordered dicts
.IP \(bu 2
f7712d417f Revert \(dqAdd yaml_safe filter\(dq
.UNINDENT
.IP \(bu 2
4ddbc2ecaa add note about pyVmomi locale workaround (\fI\%#38536\fP)
.IP \(bu 2
1c951d152b fix gce image bug (\fI\%#38542\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38509\fP: (\fI\%mostafahussein\fP) Stop request from being processed if bad ip
@ \fI2017\-01\-04 20:05:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
9a1550d336 Merge pull request \fI\%#38509\fP from mostafahussein/2016.11
.IP \(bu 2
8847289c3e remove commented code
.IP \(bu 2
420817a963 Stop request from being processed if bad ip
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38518\fP: (\fI\%kkoppel\fP) slack_notify.call_hook returns tracebacks (refs: \fI\%#38522\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38522\fP: (\fI\%kkoppel\fP) Fix usage of salt.utils.http.query in slack_notify.call_hook
@ \fI2017\-01\-04 20:04:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
bc07d420e9 Merge pull request \fI\%#38522\fP from kkoppel/fix\-issue\-38518
.IP \(bu 2
ff1e7f0c71 Fix usage of salt.utils.http.query in slack_notify.call_hook
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38524\fP: (\fI\%rbjorklin\fP) salt\-api seems to ignore rest_timeout since 2016.11.0 (refs: \fI\%#38585\fP, \fI\%#38527\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38527\fP: (\fI\%rbjorklin\fP) salt\-api no longer forces the default timeout (refs: \fI\%#38585\fP)
@ \fI2017\-01\-04 17:10:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
42fef270ee Merge pull request \fI\%#38527\fP from rbjorklin/api\-timeout\-fix
.IP \(bu 2
0202f68820 salt\-api no longer forces the default timeout
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38529\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-01\-04 17:06:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
1895eb7533 Merge pull request \fI\%#38529\fP from rallytime/merge\-2016.11
.IP \(bu 2
85f470207c Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
ec60f9c721 Merge pull request \fI\%#38487\fP from gtmanfred/2016.3
.INDENT 2.0
.IP \(bu 2
048b9f6b9d add test
.IP \(bu 2
c480c11528 allow spaces in cron env
.IP \(bu 2
c529ec8c34 allow crons to have multiple spaces
.UNINDENT
.IP \(bu 2
c5ba11b5e0 Merge pull request \fI\%#38491\fP from gtmanfred/timing
.INDENT 2.0
.IP \(bu 2
79368c7528 Use UTC for timing in case timezone changes
.UNINDENT
.IP \(bu 2
86f0aa0bb3 Merge pull request \fI\%#38503\fP from jinm/issue_38472_jinm
.INDENT 2.0
.IP \(bu 2
0cd9df299f Hash type fallback for file management
.UNINDENT
.IP \(bu 2
ed2ba4bd1b Merge pull request \fI\%#38457\fP from bshelton229/git\-latest\-head\-bug
.INDENT 2.0
.IP \(bu 2
558e7a771a Stops git.latest checking for local changes in a bare repo
.UNINDENT
.IP \(bu 2
36e21b22cb Merge pull request \fI\%#38385\fP from dragon788/2016.3\-double\-dash
.INDENT 2.0
.IP \(bu 2
86c4b56f47 Newline for lint compat
.IP \(bu 2
9d9b686057 Address review comments, consistency of quotes
.IP \(bu 2
df9bd5e7f9 Use unambigous long names with double dashes
.UNINDENT
.IP \(bu 2
59f2560d88 Merge pull request \fI\%#38474\fP from cachedout/key_loop
.INDENT 2.0
.IP \(bu 2
de504538e1 Allow an existing ioloop to be passed to salt\-key
.UNINDENT
.IP \(bu 2
3d0c752acd Merge pull request \fI\%#38467\fP from gtmanfred/2016.3
.INDENT 2.0
.IP \(bu 2
7b7c6b3878 file.line fail with mode=delete
.UNINDENT
.IP \(bu 2
940025d5c4 Merge pull request \fI\%#38434\fP from slinn0/issue_38433_fixes
.INDENT 2.0
.IP \(bu 2
22af87a3fc Fixes for \fI\%https://github.com/saltstack/salt/issues/38433\fP
.UNINDENT
.IP \(bu 2
e5eb51255b Update deprecation notices to the correct version (\fI\%#38421\fP)
.IP \(bu 2
9ce53318df file.managed: Fix failure when filename contains unicode chars (\fI\%#38415\fP)
.IP \(bu 2
2cdb59d055 Merge pull request \fI\%#38419\fP from Ch3LL/fix_doc_scsi
.INDENT 2.0
.IP \(bu 2
234043b8bb fix scsci docs example
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38539\fP: (\fI\%twangboy\fP) Fix DSC LCM Config int checks
@ \fI2017\-01\-04 16:56:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec4f118ca2 Merge pull request \fI\%#38539\fP from twangboy/dsc_int_checks
.IP \(bu 2
5657fd1956 Add repr flag for str
.IP \(bu 2
aea4219502 Fix DSC LCM Config int checks
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38549\fP: (\fI\%meaksh\fP) Adding multiple SUBVOLUME support and some fixes to the Snapper module
@ \fI2017\-01\-04 15:32:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
53449c89a5 Merge pull request \fI\%#38549\fP from meaksh/2016.11\-snapper\-multiple\-subvolumen\-support
.IP \(bu 2
ef26e93bb7 Some fixes and pylint
.IP \(bu 2
1e6ba45db4 Fixes pre/post snapshot order to get the inverse status
.IP \(bu 2
68d5475c1f Fixing Snapper unit tests for SUBVOLUME support
.IP \(bu 2
e9919a913f Removing possible double \(aq/\(aq from the file paths
.IP \(bu 2
8b4f87f226 Updating and fixing the documentation
.IP \(bu 2
edea45272a Raises \(dqCommandExecutionError\(dq if snapper command fails
.IP \(bu 2
3841e1143b Only include diff in the state response if \fIinclude_diff\fP is True
.IP \(bu 2
7803e7716c Adds multiple SUBVOLUME support to the Snapper module
.IP \(bu 2
\fBPR\fP \fI\%#38545\fP: (\fI\%rallytime\fP) Move boto_vpc.describe_route_table deprecation version to Oxygen
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38471\fP: (\fI\%twangboy\fP) Fix Problem with win_service module
@ \fI2017\-01\-01 20:30:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
5e80104a70 Merge pull request \fI\%#38471\fP from twangboy/fix_win_service
.IP \(bu 2
810471b9cd Fix problem with some services getting access denied
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38485\fP: (\fI\%wasabi222\fP) bgp.config not working (refs: \fI\%#38499\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38499\fP: (\fI\%mirceaulinic\fP) Fix \fI\%#38485\fP (refs: \fI\%#38577\fP)
@ \fI2017\-01\-01 17:42:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a09049a2d Merge pull request \fI\%#38499\fP from cloudflare/FIX\-38485
.IP \(bu 2
18018139f3 Fix \fI\%#38485\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38501\fP: (\fI\%mvdwalle\fP) Do not assume every object is a server
@ \fI2017\-01\-01 17:37:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
13f0b809df Merge pull request \fI\%#38501\fP from mvdwalle/fix\-gogrid\-list\-password
.IP \(bu 2
bd7dee9a10 Do not assume every object is a server
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38461\fP: (\fI\%anlutro\fP) Improvements/fixes to kapacitor task change detection
@ \fI2016\-12\-29 17:08:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
aa0c843553 Merge pull request \fI\%#38461\fP from alprs/fix\-kapacitor_changes
.IP \(bu 2
52721e97d6 clean up and fix tests
.IP \(bu 2
8648775c2a if task is not defined, it\(aqs not up to date
.IP \(bu 2
c3ab954c6e improvements/fixes to kapacitor task change detection
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38473\fP: (\fI\%twangboy\fP) Change OSX/OS X to macOS where possible
@ \fI2016\-12\-29 16:35:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
2c51eb9d16 Merge pull request \fI\%#38473\fP from twangboy/osx_to_macos
.IP \(bu 2
e96bfe8fa2 Change OSX/OS X to macOS where possible
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38412\fP: (\fI\%bbinet\fP) Update PillarStack stack.py to latest upstream version
@ \fI2016\-12\-28 19:28:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
2497fb547e Merge pull request \fI\%#38412\fP from bbinet/pillarstack\-updates
.IP \(bu 2
b66b4bd060 Fix lint violations in stack.py
.IP \(bu 2
6a30fe6aeb Update PillarStack stack.py to latest upstream version
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38456\fP: (\fI\%twangboy\fP) Gate Windows Specific Salt Utils
@ \fI2016\-12\-28 18:44:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
5395d3210a Merge pull request \fI\%#38456\fP from twangboy/gate_win_utils
.IP \(bu 2
d34d110a84 Fix lint, fix boto module
.IP \(bu 2
c20111142f Gate Windows Utils
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38428\fP: (\fI\%gqgunhed\fP) fixed typo: lq command\-line syntax
@ \fI2016\-12\-27 15:42:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
7c7799162b Merge pull request \fI\%#38428\fP from gqgunhed/fix_lq_typo
.IP \(bu 2
d79d682e8b fixed typo: lq command\-line syntax
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38443\fP: (\fI\%lorengordon\fP) 2016.11 breaks file.managed on Windows (refs: \fI\%#38444\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34101\fP: (\fI\%windoverwater\fP) archive.extracted breakage due to 2016.3.0 upgrade from 2015.8.10 (refs: \fI\%#37368\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38444\fP: (\fI\%lorengordon\fP) Adds new import required for \fIextract_hash\fP
@ \fI2016\-12\-27 15:37:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37368\fP: (\fI\%terminalmage\fP) Overhaul archive.extracted state (refs: \fI\%#38444\fP)
.IP \(bu 2
f5984d0f81 Merge pull request \fI\%#38444\fP from lorengordon/issue\-38443
.IP \(bu 2
b2925ad7b7 Adds new import required for \fIextract_hash\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38071\fP: (\fI\%luochun\-95\fP) remote execute is very slow (refs: \fI\%#38167\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38167\fP: (\fI\%cachedout\fP) Kill pkg_resources for CLI tools [DO NOT MERGE]
@ \fI2016\-12\-22 22:11:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
4c4f07ca4c Merge pull request \fI\%#38167\fP from cachedout/no_pkg_resources
.IP \(bu 2
ec6901720a Remove debugging
.IP \(bu 2
f28e33b9b6 Remove from all but salt cli
.IP \(bu 2
bb3af72317 Remove from salt\-call
.IP \(bu 2
c676846066 Kill pkg_resources for CLI tools
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38417\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2016\-12\-22 19:00:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
2fc8c154af Merge pull request \fI\%#38417\fP from rallytime/merge\-2016.11
.IP \(bu 2
efb8a8ddf5 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
27253522c8 Improve pillar documentation (\fI\%#38407\fP)
.IP \(bu 2
423b1fddff Merge pull request \fI\%#38398\fP from terminalmage/issue38372
.INDENT 2.0
.IP \(bu 2
c80dbaa914 Fix call to file.get_managed in cron.file state
.UNINDENT
.IP \(bu 2
5a33d1e697 Fix http.query when result has no text (\fI\%#38382\fP)
.IP \(bu 2
b74b5c7d38 Merge pull request \fI\%#38390\fP from meaksh/2016.3\-fix\-try\-restart\-for\-autorestarting\-on\-SUSE\-systems
.INDENT 2.0
.IP \(bu 2
de6ec05ec0 add try\-restart to fix autorestarting on SUSE systems
.UNINDENT
.IP \(bu 2
2c3a39760a Merge pull request \fI\%#38221\fP from UtahDave/fix_default_returner
.INDENT 2.0
.IP \(bu 2
385640765b remove a blank line to satisfy linter
.IP \(bu 2
9c248aa14c validate return opt, remove default.
.IP \(bu 2
8bb37f9fe7 specify allowed types and default for \(dqreturner\(dq
.IP \(bu 2
11863a4bfe add examples of default minion returners
.IP \(bu 2
e7c6012655 add support for default returners using \fIreturn\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38342\fP: (\fI\%scthi\fP) Bugfix ext pillar nodegroups
@ \fI2016\-12\-22 16:47:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
bbc149c67f Merge pull request \fI\%#38342\fP from scthi/bugfix\-ext\-pillar\-nodegroups
.IP \(bu 2
dba315c4b6 ext\-pillar nodegroups works for all minions now.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38403\fP: (\fI\%terminalmage\fP) git_pillar: Document the transition from env to saltenv in the jinja context
@ \fI2016\-12\-22 16:34:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
453476d982 Merge pull request \fI\%#38403\fP from terminalmage/document\-saltenv
.IP \(bu 2
0a72e0f0be git_pillar: Document the transition from env to saltenv in the jinja context
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38253\fP: (\fI\%gmacon\fP) There was no error installing package \(aqsetuptools\(aq although it does not show when calling \(aqpip.freeze\(aq. (refs: \fI\%#38354\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38354\fP: (\fI\%gmacon\fP) Use \-\-all when calling pip.py
@ \fI2016\-12\-20 20:40:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
12436efb54 Merge pull request \fI\%#38354\fP from gmacon/pip\-freeze\-all
.IP \(bu 2
dca24b270e Use \-\-all when calling pip.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38348\fP: (\fI\%rallytime\fP) Update autodoc topics for new modules added in 2016.11
@ \fI2016\-12\-20 20:36:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
68430b1fa6 Merge pull request \fI\%#38348\fP from rallytime/mod\-docs\-2016.11
.IP \(bu 2
b31c2412ca Add __iter__ and next options to doc/conf.py
.IP \(bu 2
b8c16094c4 Revert \(dqMove import/error messaging logic for snapper module into __virtual__()\(dq
.IP \(bu 2
640db5b5ac Move import/error messaging logic for snapper module into __virtual__()
.IP \(bu 2
366271f459 Add snapper to state index doc module list
.IP \(bu 2
135d254c80 Remove netapi autodoc files: they should not be added as their doc structure is different
.IP \(bu 2
0006139aca Update autodoc topics for new modules added in 2016.11
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38377\fP: (\fI\%DmitryKuzmenko\fP) Implementation and docs for Consul key\-value store plugin for minion data cache.
@ \fI2016\-12\-20 20:36:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
6ee7b2bae7 Merge pull request \fI\%#38377\fP from DSRCorporation/features/consul_cache
.IP \(bu 2
6fb4430ae3 Configuration options and documentation for Consul data cache plugin.
.IP \(bu 2
dad748f57a Data cache plugin configuration documentation.
.IP \(bu 2
c7209cd90c Consul data cache plugin.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38373\fP: (\fI\%rallytime\fP) Back\-port \fI\%#38212\fP to 2016.11
@ \fI2016\-12\-20 20:35:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38212\fP: (\fI\%disaster123\fP) ZMQ: add an option for zmq.BACKLOG to salt master (zmq_backlog) (refs: \fI\%#38373\fP)
.IP \(bu 2
f6d1b559bc Merge pull request \fI\%#38373\fP from rallytime/bp\-38212
.IP \(bu 2
52fc6daac0 ZMQ: add an option for zmq.BACKLOG to salt master (zmq_backlog)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38374\fP: (\fI\%mirceaulinic\fP) NAPALM proxy module: Fix optional_args key issue
@ \fI2016\-12\-20 20:34:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
69c3f19fc1 Merge pull request \fI\%#38374\fP from cloudflare/FIX\-NAPALM\-PROXY
.IP \(bu 2
44169315d8 Fix optional_args key issue
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38048\fP: (\fI\%ezh\fP) [2016.11.0] Salt\-cloud throws TypeError exception (refs: \fI\%#38073\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38073\fP: (\fI\%ezh\fP) 2016.11
@ \fI2016\-12\-20 14:51:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
530f495955 Merge pull request \fI\%#38073\fP from doublescoring/2016.11
.IP \(bu 2
42d3d26f28 [38073] Fix test assertion
.IP \(bu 2
9b37ead913 Fix broken os.write without string.encode
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38344\fP: (\fI\%bbinet\fP) Fix influxdb_database.present state
@ \fI2016\-12\-20 13:57:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
67908d5aba Merge pull request \fI\%#38344\fP from bbinet/fix\-influx\-createdb
.IP \(bu 2
c6b075d6f4 Fix influxdb_database.present state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38358\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2016\-12\-20 00:11:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
04d6898958 Merge pull request \fI\%#38358\fP from rallytime/merge\-2016.11
.IP \(bu 2
c6e191ad0d Remove doc markup references from 2016.11 branch
.IP \(bu 2
513058945c Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
09d9cff992 Merge pull request \fI\%#38288\fP from terminalmage/archive\-extracted\-local\-source\-2016.3
.INDENT 2.0
.IP \(bu 2
845e3d0e75 Update tests to reflect change in cache behavior
.IP \(bu 2
5a08d7c70a archive.extracted: don\(aqt try to cache local sources (2016.3 branch)
.UNINDENT
.IP \(bu 2
bf37667f8a Merge pull request \fI\%#38312\fP from cro/proxy_config_in_cfg
.INDENT 2.0
.IP \(bu 2
2006c4000e Typo
.IP \(bu 2
689d95b10f Backport feature allowing proxy config to live in pillar OR /etc/salt/proxy.
.UNINDENT
.IP \(bu 2
c83db5a785 Merge pull request \fI\%#38320\fP from rallytime/cleanup\-doc\-refs
.INDENT 2.0
.IP \(bu 2
62978cb7a0 Don\(aqt check the doc/conf.py file for doc markup refs
.IP \(bu 2
770e732d76 Add a unit test to search for new doc markup refs
.IP \(bu 2
5c42a361a0 Remove \(dq:doc:\(dq references from all doc/topics/installation/* files
.IP \(bu 2
23bce1c929 Remove \(dq:doc:\(dq references from all doc/topics/releases/* files
.IP \(bu 2
4aafa41d22 Remove \(dq:doc:\(dq references from a bunch of doc/* files
.IP \(bu 2
02bfe7912c Remove more \(dq:doc:\(dq references from doc/* files
.IP \(bu 2
6e32267d0c Remove \(dq:doc:\(dq references in salt/* files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38285\fP: (\fI\%terminalmage\fP) archive.extracted: don\(aqt try to cache local sources
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37947\fP: (\fI\%vutny\fP) Fix \fIsalt\-minion\fP initscript for RHEL5 (SysV) to pick up proper python version
@ \fI2016\-12\-19 21:03:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
13414949e3 Merge pull request \fI\%#37947\fP from vutny/fix\-rhel5\-minion\-init
.IP \(bu 2
c94e798b8a SysV init script for rpm: get and show unique PIDs only
.IP \(bu 2
8ff68c4128 Fix initscript for RHEL5 (SysV) to pick up proper python version
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38106\fP: (\fI\%techhat\fP) \(dqtest\(dq is not necessarily in opts, for thorium
@ \fI2016\-12\-19 14:40:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
4d072ca689 Merge pull request \fI\%#38106\fP from techhat/stateget
.IP \(bu 2
5edc16f606 \(dqtest\(dq is not necessarily in opts, for thorium
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38333\fP: (\fI\%amendlik\fP) Suppress errors when checking if an alternative exists
@ \fI2016\-12\-19 13:40:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
a01fade604 Merge pull request \fI\%#38333\fP from amendlik/states\-alternatives
.IP \(bu 2
8bfcd5bcd5 Adjust alternatives test for updated error message
.IP \(bu 2
09dee3c611 Suppress errors when checking if an alternative exists
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38340\fP: (\fI\%ewapptus\fP) Backport PR \fI\%#38251\fP: Fixed nested orchestrate not respecting failures
@ \fI2016\-12\-19 13:31:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38251\fP: (\fI\%ewapptus\fP) Fixed nested orchestrate not respecting failures (refs: \fI\%#38340\fP)
.IP \(bu 2
15d3b476e9 Merge pull request \fI\%#38340\fP from ewapptus/bp\-38251
.IP \(bu 2
266e0a465c Fixed nested orchestrate not respecting failures
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38229\fP: (\fI\%mcalmer\fP) provide kwargs of sls_build to dockerng.create
@ \fI2016\-12\-18 13:13:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
ecd441d090 Merge pull request \fI\%#38229\fP from mcalmer/dockerng\-sls_build\-kwargs
.IP \(bu 2
e7292fabb7 make it explicit that we want to delete these keys
.IP \(bu 2
4c710139b5 use default values for pop() to prevent KeyError raised
.IP \(bu 2
455c18325c provide kwargs to dockerng.create to provide all features to sls_build as well
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36204\fP: (\fI\%stanvarlamov\fP) Salt\-Cloud: salt.runners.cloud.create exits with True on Python process (ec2.py) exception (refs: \fI\%#37333\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38309\fP: (\fI\%ewapptus\fP) Backport PR \fI\%#37333\fP: Fixed state.salt.runner() reporting success on exceptions
@ \fI2016\-12\-18 12:39:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37333\fP: (\fI\%benediktwerner\fP) Fixed state.salt.runner() reporting success on exceptions (refs: \fI\%#38309\fP)
.IP \(bu 2
d2ce9c3e71 Merge pull request \fI\%#38309\fP from ewapptus/bp\-37333
.IP \(bu 2
a2b1259671 Fixed display of errors
.IP \(bu 2
14a39f914e Fixed state.salt.runner return value on exceptions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38323\fP: (\fI\%rallytime\fP) Update the Cloud Provider Specifics links in cloud docs
@ \fI2016\-12\-18 12:30:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
ebb9f6cbbc Merge pull request \fI\%#38323\fP from rallytime/update\-cloud\-provider\-links
.IP \(bu 2
022caf23e9 Update the Cloud Provider Specifics links in cloud docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38324\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2016\-12\-18 12:30:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
5bd7471e30 Merge pull request \fI\%#38324\fP from rallytime/merge\-2016.11
.IP \(bu 2
5940db5b3f Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
6367ca7d2a Add nick to args for create_multi (\fI\%#38281\fP)
.IP \(bu 2
235682b1e6 Merge pull request \fI\%#38313\fP from dragon788/2016.3\-chocolatey\-fix
.INDENT 2.0
.IP \(bu 2
1f5fc17551 Use machine readable output for list
.IP \(bu 2
cdbd2fbe3c Added limit\-output to eliminate false packages
.UNINDENT
.IP \(bu 2
9e78ddc80e Merge pull request \fI\%#38279\fP from rallytime/fix\-38174
.INDENT 2.0
.IP \(bu 2
4a62d01577 Add docs for syndic_wait setting
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38246\fP: (\fI\%martintamare\fP) Windows Minion unable to start via nssm (refs: \fI\%#38247\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38325\fP: (\fI\%rallytime\fP) Back\-port \fI\%#38247\fP to 2016.11
@ \fI2016\-12\-18 12:28:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38247\fP: (\fI\%martintamare\fP) fix(win_function): handle other language (refs: \fI\%#38325\fP)
.IP \(bu 2
83523d2f73 Merge pull request \fI\%#38325\fP from rallytime/bp\-38247
.IP \(bu 2
4b6c5438e3 fix(win_functions): syntax
.IP \(bu 2
e602f17e3d fix(win_function): handle other language
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30195\fP: (\fI\%Vaelatern\fP) Add Void Linux support in Salt (refs: \fI\%#31262\fP, \fI\%#38326\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38326\fP: (\fI\%yopito\fP) fix runit init support (grain init) in 2016.11
@ \fI2016\-12\-18 12:07:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31262\fP: (\fI\%Vaelatern\fP) Add support for Void Linux (refs: \fI\%#38326\fP)
.IP \(bu 2
54a2bb95de Merge pull request \fI\%#38326\fP from yopito/fix\-runit\-init\-support
.IP \(bu 2
25b91bb686 fix detection of runit as init system (grain init)
.IP \(bu 2
\fBPR\fP \fI\%#38322\fP: (\fI\%rallytime\fP) Add azurearm module to doc index
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38305\fP: (\fI\%dereckson\fP) Avoid normalization call for normalized mode value
@ \fI2016\-12\-16 17:31:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
1e4f299e7d Merge pull request \fI\%#38305\fP from dereckson/fix\-mode\-extraneous\-normalization
.IP \(bu 2
573ac3565e Avoid normalization call for normalized mode value
.IP \(bu 2
\fBPR\fP \fI\%#38291\fP: (\fI\%terminalmage\fP) Improve documentation for archive.extracted in 2016.11
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37966\fP: (\fI\%Cybolic\fP) salt\-cloud EC2 instance can\(aqt be initiated (refs: \fI\%#37967\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38298\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37967\fP to 2016.11
@ \fI2016\-12\-16 15:20:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37967\fP: (\fI\%Cybolic\fP) Fixed faulty logic preventing instance initialisation. (refs: \fI\%#38298\fP)
.IP \(bu 2
3cf0135d50 Merge pull request \fI\%#38298\fP from rallytime/bp\-37967
.IP \(bu 2
42d367f39d Fixed faulty logic preventing instance initialisation.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38070\fP: (\fI\%ezh\fP) [2016.11.0] Salt\-cloud throws UnicodeDecodeError exception (refs: \fI\%#38076\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38076\fP: (\fI\%ezh\fP) Fix decoding of broken string from remote sources
@ \fI2016\-12\-15 19:05:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
f4f0036f30 Merge pull request \fI\%#38076\fP from doublescoring/fix\-2016.11\-38070
.IP \(bu 2
70c8db5489 Fix decoding of broken string from remote sources
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38278\fP: (\fI\%rallytime\fP) Back\-port \fI\%#38207\fP to 2016.11
@ \fI2016\-12\-15 18:09:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38207\fP: (\fI\%tsaridas\fP) remove empty strings from list but not ones with one empty space char (refs: \fI\%#38278\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38188\fP: (\fI\%tsaridas\fP) fix for push_dir in different OS (refs: \fI\%#38203\fP, \fI\%#38207\fP)
.IP \(bu 2
2ccab22c19 Merge pull request \fI\%#38278\fP from rallytime/bp\-38207
.IP \(bu 2
5e8bf571d8 python3 compatibility and fix pylint
.IP \(bu 2
e0df047000 remove empty strings from list but not ones with one empty space char
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38277\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2016\-12\-15 18:09:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
a748e842a8 Merge pull request \fI\%#38277\fP from rallytime/merge\-2016.11
.IP \(bu 2
49a3355915 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
fc9e1dff35 Merge pull request \fI\%#38248\fP from meaksh/salt\-api\-successfully\-close\-child\-processes
.INDENT 2.0
.IP \(bu 2
ee6eae9855 Successfully exit of salt\-api child processes when SIGTERM.
.UNINDENT
.IP \(bu 2
3c718ed35e Merge pull request \fI\%#38254\fP from terminalmage/check\-pillarenv
.INDENT 2.0
.IP \(bu 2
fa9ad311c6 Also check if pillarenv is in opts
.UNINDENT
.IP \(bu 2
6b9060c38f [2016.3] Bump latest release version to 2016.11.1 (\fI\%#38256\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38231\fP: (\fI\%tjuup\fP) Typo: salt\-key deleted (refs: \fI\%#38232\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38232\fP: (\fI\%rallytime\fP) Strip final \(aqe\(aq in key cmd to correct \(dqdeleted\(dq misspelling
@ \fI2016\-12\-15 10:38:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
0af343e71f Merge pull request \fI\%#38232\fP from rallytime/fix\-38231
.IP \(bu 2
26e1ee3650 Strip final \(aqe\(aq in key cmd to correct \(dqdeleted\(dq misspelling
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38200\fP: (\fI\%sebw\fP) selinux.mode doesn\(aqt return any output and doesn\(aqt persist (refs: \fI\%#38236\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38236\fP: (\fI\%gtmanfred\fP) SELINUXTYPE should not be changed
@ \fI2016\-12\-15 10:37:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c1ca9dae7 Merge pull request \fI\%#38236\fP from gtmanfred/2016.11
.IP \(bu 2
d1b070c894 clean up selinux unit test
.IP \(bu 2
96eabd4939 SELINUXTYPE should not be changed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38228\fP: (\fI\%vquiering\fP) archive.extracted with options and user/group (refs: \fI\%#38262\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38262\fP: (\fI\%terminalmage\fP) Fix archive.extracted when \-\-strip or \-\-strip\-components is in the options
@ \fI2016\-12\-15 08:57:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd32dc3e9b Merge pull request \fI\%#38262\fP from terminalmage/issue38228
.IP \(bu 2
6442f8a7b5 Add tests for \-\-strip/\-\-strip\-components
.IP \(bu 2
c502e68f12 Detect \-\-strip/\-\-strip\-components in tar options and handle properly
.IP \(bu 2
e95770594d Add strip_components arg to archive.list
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38264\fP: (\fI\%mirceaulinic\fP) Port \fI\%#37862\fP into 2016.11
@ \fI2016\-12\-15 08:51:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37862\fP: (\fI\%mirceaulinic\fP) [2016.11.1] Docstring fixes and new features for napalm_network (refs: \fI\%#38264\fP)
.IP \(bu 2
b232bd8ce8 Merge pull request \fI\%#38264\fP from cloudflare/PORT\-37862
.IP \(bu 2
28bbb73151 Import from napalm_base instead of napalm
.IP \(bu 2
0a675afc40 Vice\-versa docstring
.IP \(bu 2
09c50176e2 More docfix
.IP \(bu 2
215b8f38e2 Lint cleanup
.IP \(bu 2
\fBPR\fP \fI\%#38260\fP: (\fI\%rallytime\fP) Add 2016.11.2 release notes
.IP \(bu 2
\fBPR\fP \fI\%#38257\fP: (\fI\%rallytime\fP) [2016.11] Bump latest release version to 2016.11.1
.IP \(bu 2
\fBPR\fP \fI\%#38233\fP: (\fI\%terminalmage\fP) Correct an inaccurate warning when top_file_merging_strategy == merge_all
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38234\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2016\-12\-13 18:28:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
ba62fcf2ec Merge pull request \fI\%#38234\fP from rallytime/merge\-2016.11
.IP \(bu 2
6a327d1367 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
004e46afe7 Merge pull request \fI\%#38198\fP from vutny/unit\-tests\-require\-libcloud\-boto3
.INDENT 2.0
.IP \(bu 2
a6098bac1a Remove note about SaltTesting installation, now it is in the requirements
.IP \(bu 2
004bff113e Add missing requirements for running unit tests: libcloud and boto3
.UNINDENT
.IP \(bu 2
9d497bc74c Merge pull request \fI\%#38213\fP from rallytime/skip\-tls\-test
.INDENT 2.0
.IP \(bu 2
bdb807fc7c Skip test_cert_info tls unit test on pyOpenSSL upstream errors
.UNINDENT
.IP \(bu 2
203109dd17 Merge pull request \fI\%#38224\fP from whiteinge/cors\-options\-unauthed
.INDENT 2.0
.IP \(bu 2
de4d3227ab Allow CORS OPTIONS requests to be unauthenticated
.UNINDENT
.IP \(bu 2
721a5feccd Merge pull request \fI\%#38223\fP from whiteinge/salt\-api\-root_dirs
.INDENT 2.0
.IP \(bu 2
bfbf390c0e Add root_dir to salt\-api file paths
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38205\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2016\-12\-12 18:13:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
7ead1ed336 Merge pull request \fI\%#38205\fP from rallytime/merge\-2016.11
.IP \(bu 2
e31f97cf71 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
70f7d22ad6 Merge pull request \fI\%#38191\fP from terminalmage/issue38162
.INDENT 2.0
.IP \(bu 2
1ae543a98a Clarify the fact that git_pillar.update does not fast\-forward
.UNINDENT
.IP \(bu 2
28171cbfc5 Merge pull request \fI\%#38194\fP from vutny/integration\-test\-requirements\-doc
.INDENT 2.0
.IP \(bu 2
e9f419ff64 Document the requirements for running ZeroMQ\-based integration tests
.UNINDENT
.IP \(bu 2
a4ef037ab1 Merge pull request \fI\%#38185\fP from rallytime/bp\-38181
.IP \(bu 2
609f814454 Reset socket default timeout to None (fixes daemons_tests failures)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38203\fP: (\fI\%rallytime\fP) Back\-port \fI\%#38188\fP to 2016.11
@ \fI2016\-12\-12 17:48:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38188\fP: (\fI\%tsaridas\fP) fix for push_dir in different OS (refs: \fI\%#38203\fP, \fI\%#38207\fP)
.IP \(bu 2
669409d681 Merge pull request \fI\%#38203\fP from rallytime/bp\-38188
.IP \(bu 2
50d3200b12 removing not needed join
.IP \(bu 2
7af708e1e7 fix for push_dir in different OS
.UNINDENT
.UNINDENT
.SS Salt 2016.11.3 Release Notes
.sp
Version 2016.11.3 is a bugfix release for \fI\%2016.11.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB137\fP
.IP \(bu 2
Total Issue References: \fB49\fP
.IP \(bu 2
Total PR References: \fB130\fP
.IP \(bu 2
Contributors: \fB47\fP (\fI\%Ch3LL\fP, \fI\%DmitryKuzmenko\fP, \fI\%MTecknology\fP, \fI\%The\-Loeki\fP, \fI\%UtahDave\fP,
\fI\%anlutro\fP, \fI\%arthru\fP, \fI\%axmetishe\fP, \fI\%bailsman\fP, \fI\%bobrik\fP, \fI\%cachedout\fP, \fI\%clinta\fP,
\fI\%corywright\fP, \fI\%cro\fP, \fI\%dmaziuk\fP, \fI\%dmitrievav\fP, \fI\%dmurphy18\fP, \fI\%eliasp\fP, \fI\%eradman\fP, \fI\%ezh\fP,
\fI\%gtmanfred\fP, \fI\%hu\-dabao\fP, \fI\%hujunya\fP, \fI\%isbm\fP, \fI\%jak3kaj\fP, \fI\%janhorstmann\fP, \fI\%joe\-niland\fP,
\fI\%kevinanderson1\fP, \fI\%kstreee\fP, \fI\%l2ol33rt\fP, \fI\%lomeroe\fP, \fI\%mcalmer\fP, \fI\%meaksh\fP, \fI\%mirceaulinic\fP,
\fI\%morganwillcock\fP, \fI\%nasenbaer13\fP, \fI\%nicholasmhughes\fP, \fI\%rallytime\fP, \fI\%sakateka\fP, \fI\%sergeizv\fP,
\fI\%sjorge\fP, \fI\%techhat\fP, \fI\%terminalmage\fP, \fI\%thatch45\fP, \fI\%toanju\fP, \fI\%twangboy\fP, \fI\%vutny\fP)
.UNINDENT
.SS Changelog for v2016.11.2..v2016.11.3
.sp
\fIGenerated at: 2018\-05\-27 19:39:56 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#39536\fP: (\fI\%twangboy\fP) Namespace \(aqstatus\(aq functions in \(aqwin_status\(aq
@ \fI2017\-02\-21 23:45:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39005\fP: (\fI\%cro\fP) Ungate the status.py module and raise unsupported errors in functions not executable on Windows. (refs: \fI\%#39536\fP)
.IP \(bu 2
40f72db53e Merge pull request \fI\%#39536\fP from twangboy/fix_win_status
.IP \(bu 2
d5453e2f9e Remove unused import (lint)
.IP \(bu 2
837c32e673 Remove list2cmdline
.IP \(bu 2
c258cb3f73 Streamline wmic command returns for easier parsing
.IP \(bu 2
6d2cf8171e Fix \(aqping_master\(aq function
.IP \(bu 2
d946d10597 Namespace \(aqstatus\(aq functions in \(aqwin_status\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39534\fP: (\fI\%rallytime\fP) Fix breakage in aptpkg and dpkg execution modules
@ \fI2017\-02\-21 20:31:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39418\fP: (\fI\%anlutro\fP) Allow aptpkg.info_installed on package names that aren\(aqt installed (refs: \fI\%#39534\fP)
.IP \(bu 2
dc8f578447 Merge pull request \fI\%#39534\fP from rallytime/fix\-pkg\-function\-specs
.IP \(bu 2
d34a8fe9dc Fix breakage in aptpkg and dpkg execution modules
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34712\fP: (\fI\%richardscollin\fP) Salt Test Suite Error \- develop (refs: \fI\%#37366\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39521\fP: (\fI\%vutny\fP) Upgrade SaltTesting to run test suite for 2016.11 and add SaltPyLint
.IP \(bu 2
\fBPR\fP \fI\%#37366\fP: (\fI\%eradman\fP) dev_python*.txt: use current SaltTesting and SaltPyLint modules (refs: \fI\%#39521\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39370\fP: (\fI\%twangboy\fP) Gate win_osinfo and winservice
@ \fI2017\-02\-17 23:53:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
e4c71683d9 Merge pull request \fI\%#39370\fP from twangboy/gate_win_utils
.IP \(bu 2
167cdb3447 Gate windows specific imports, add __virtual__
.IP \(bu 2
e67387deb7 Add option to return a Non instantiated class
.IP \(bu 2
315b0cc105 Clarify return value for win_osinfo
.IP \(bu 2
994314ed3d Fix more docs
.IP \(bu 2
2bbe3cbf49 Fix some docs
.IP \(bu 2
4103563ee1 Merge branch \(aqgate_win_utils\(aq of \fI\%https://github.com/twangboy/salt\fP into gate_win_utils
.INDENT 2.0
.IP \(bu 2
24c1bd079d Remove extra newlines
.UNINDENT
.IP \(bu 2
82a86ced55 Add helper function for winservice
.IP \(bu 2
0051b5a5e2 Put the win_osinfo classes in a helper function
.IP \(bu 2
4e08534877 Gate win_osinfo and winservice better
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39486\fP: (\fI\%twangboy\fP) Remove orphaned function list_configurable_policies
@ \fI2017\-02\-17 22:21:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
a3e71b6cce Merge pull request \fI\%#39486\fP from twangboy/win_remove_orphaned
.IP \(bu 2
1328055c4d Remove orphaned function list_configurable_policies
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39418\fP: (\fI\%anlutro\fP) Allow aptpkg.info_installed on package names that aren\(aqt installed (refs: \fI\%#39534\fP)
@ \fI2017\-02\-17 18:34:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
87b269fc80 Merge pull request \fI\%#39418\fP from alprs/fix\-aptpkg_info_nonexistent_pkg
.IP \(bu 2
246bf1e938 add failhard argument to various apt pkg functions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39438\fP: (\fI\%mirceaulinic\fP) file.get_managed: refetch source when file hashsum is changed
@ \fI2017\-02\-17 17:58:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
e816d6c23e Merge pull request \fI\%#39438\fP from cloudflare/fix_39422
.IP \(bu 2
8453800639 file.get_managed: refetch cached file when hashsum chnaged
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39203\fP: (\fI\%dmaziuk\fP) salt.users gecos field (refs: \fI\%#39432\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39432\fP: (\fI\%dmaziuk\fP) Quick and dirty fix for GECOS fields with more than 3 commas
@ \fI2017\-02\-17 17:57:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
a5fe8f0fa6 Merge pull request \fI\%#39432\fP from dmaziuk/issue39203
.IP \(bu 2
41c046308c Remove #
.IP \(bu 2
4f877c6b6f Quick and dirty fix for GECOS fields with more than 3 commas
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39484\fP: (\fI\%corywright\fP) The Reactor docs should use pillar=\(aq{}\(aq instead of \(aqpillar={}\(aq
@ \fI2017\-02\-17 17:50:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
3665229a5a Merge pull request \fI\%#39484\fP from corywright/fix\-reactor\-docs\-pillar\-keyword\-args
.IP \(bu 2
cc90d0d53f The Reactor docs should use pillar=\(aq{}\(aq instead of \(aqpillar={}\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39456\fP: (\fI\%twangboy\fP) Add salt icon to buildenv directory
@ \fI2017\-02\-16 22:47:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e3a9c5e58 Merge pull request \fI\%#39456\fP from twangboy/win_fix_icon
.IP \(bu 2
8dd915dae4 Add salt icon to buildenv directory
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39462\fP: (\fI\%twangboy\fP) Use url_path instead of url_data.path
@ \fI2017\-02\-16 22:44:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
63adc03484 Merge pull request \fI\%#39462\fP from twangboy/win_fix_fileclient
.IP \(bu 2
a96bc13133 Use url_path instead of url_data.path
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39458\fP: (\fI\%rallytime\fP) Fix more warnings in doc build
@ \fI2017\-02\-16 21:45:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
e9b034f02f Merge pull request \fI\%#39458\fP from rallytime/fixup\-more\-doc\-build\-warnings
.IP \(bu 2
e698bc3508 Fix more warnings in doc build
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39437\fP: (\fI\%sakateka\fP) Fixes about saltfile
@ \fI2017\-02\-16 20:32:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
e4f8c2bfb0 Merge pull request \fI\%#39437\fP from sakateka/fixes_about_saltfile
.IP \(bu 2
ab68524d7a less pylint: salt/utils/parsers.py
.IP \(bu 2
9e7d9dcc78 Revert \(dqpylint: salt/utils/parsers.py\(dq
.IP \(bu 2
f3f129c8f1 document ~/.salt/Saltfile
.IP \(bu 2
33f3614b1e pylint: salt/utils/parsers.py
.IP \(bu 2
0f36e10e7d expand config_dir and \(aq~/.salt/Saltfile\(aq as last resort
.IP \(bu 2
\fBPR\fP \fI\%#39451\fP: (\fI\%Ch3LL\fP) add 2016.11.3 changelog to release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38032\fP: (\fI\%meggiebot\fP) Add missing Carbon docs (refs: \fI\%#39448\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39448\fP: (\fI\%gtmanfred\fP) Add release notes for cisco proxy minions added in Carbon
@ \fI2017\-02\-16 17:29:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
8e2cbd2307 Merge pull request \fI\%#39448\fP from gtmanfred/2016.11
.IP \(bu 2
3172e88700 Add release notes for cisco proxy minions added in Carbon
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39428\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-02\-16 00:01:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
070904b719 Merge pull request \fI\%#39428\fP from rallytime/merge\-2016.11
.IP \(bu 2
2acb188ac9 Change \fBpath\fP value from a tuple to a list
.IP \(bu 2
6d78adbf08 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
4ff13acf8b salt.fileserver.roots: Fix regression in symlink_list (\fI\%#39409\fP)
.IP \(bu 2
8b8ab8ef8e Merge pull request \fI\%#39362\fP from dincamihai/cp\-push\-test\-2016.3
.INDENT 2.0
.IP \(bu 2
91383c5a19 Add cp.push test
.UNINDENT
.IP \(bu 2
4b726f955b Merge pull request \fI\%#39380\fP from joe\-niland/quote\-numeric\-usernames
.INDENT 2.0
.IP \(bu 2
c2edfdd464 Quote numeric user names so pwd.getpwnam handles them properly
.UNINDENT
.IP \(bu 2
1116d32df9 Merge pull request \fI\%#39400\fP from meaksh/2016.3\-fix\-local\-cache\-issue
.INDENT 2.0
.IP \(bu 2
e7e559ef5c Prevents \(aqOSError\(aq exception in case path doesn\(aqt exist
.UNINDENT
.IP \(bu 2
6c854da1d4 Merge pull request \fI\%#39300\fP from terminalmage/loader\-optimization
.INDENT 2.0
.IP \(bu 2
d3e5d1525e Replace more usage of str.format in the loader
.UNINDENT
.IP \(bu 2
5286b5ff1b Merge pull request \fI\%#39337\fP from terminalmage/issue34428
.INDENT 2.0
.IP \(bu 2
a7d2135dc2 Don\(aqt re\-walk the roots fileserver in symlink_list()
.UNINDENT
.IP \(bu 2
ce781deeb5 Merge pull request \fI\%#39339\fP from cro/pillar_filetree_doc
.INDENT 2.0
.IP \(bu 2
410810cea2 Clarification on external pillar usage.
.UNINDENT
.IP \(bu 2
fa3014393c Document the upstream RedHat bug with their pygit2 package (\fI\%#39316\fP)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39360\fP: (\fI\%bbinet\fP) file.symlink should not try to set ownership to root:root (refs: \fI\%#39364\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39429\fP: (\fI\%rallytime\fP) Back\-port \fI\%#39364\fP to 2016.11
@ \fI2017\-02\-15 21:27:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39364\fP: (\fI\%gtmanfred\fP) set default user variable to the user cmd runs as (refs: \fI\%#39429\fP)
.IP \(bu 2
54a572e50c Merge pull request \fI\%#39429\fP from rallytime/bp\-39364
.IP \(bu 2
157f4dcdf9 set default user variable to the user cmd runs as
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39424\fP: (\fI\%twangboy\fP) Fix problem with too many connection attempts in Windows
@ \fI2017\-02\-15 18:51:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
881ebf2e93 Merge pull request \fI\%#39424\fP from twangboy/win_fix_dos
.IP \(bu 2
d3f7dd7f50 Add sleep to eval_master
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30561\fP: (\fI\%jfindlay\fP) salt\-ssh fails with IPv6 address (refs: \fI\%#39419\fP, \fI\%#38831\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#22984\fP: (\fI\%tomasfejfar\fP) salt\-ssh problem possibly related to ipv6 (refs: \fI\%#39419\fP, \fI\%#38831\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39419\fP: (\fI\%The\-Loeki\fP) Backport Salt\-SSH IPv6 fixes to 2016.11
@ \fI2017\-02\-15 17:33:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38877\fP: (\fI\%The\-Loeki\fP) Salt\-SSH client: Don\(aqt overwrite self.host w/IPv6 brackets (refs: \fI\%#39419\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38831\fP: (\fI\%The\-Loeki\fP) Salt\-SSH deal with raw IPv6 addresses (refs: \fI\%#39419\fP, \fI\%#38877\fP)
.IP \(bu 2
47872355a8 Merge pull request \fI\%#39419\fP from The\-Loeki/bp\-ssh\-ipv6
.IP \(bu 2
4fc5626f16 Don\(aqt overwrite self.host w/IPv6 brackets
.IP \(bu 2
dd1223468b Salt\-SSH deal with raw IPv6 addresses
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39379\fP: (\fI\%terminalmage\fP) win_pkg: remove all installed versions when no explicit version passed
@ \fI2017\-02\-14 18:41:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
878946d0f8 Merge pull request \fI\%#39379\fP from terminalmage/issue34821
.IP \(bu 2
fd9ab8e4e3 Remove extra newline
.IP \(bu 2
5871825b9e win_pkg: remove all installed versions when no explicit version passed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39392\fP: (\fI\%anlutro\fP) Make sure OrderedDict order is preserved in nested output
@ \fI2017\-02\-14 17:50:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
caffef88cf Merge pull request \fI\%#39392\fP from alprs/fix\-nested_output_ordered_dict
.IP \(bu 2
625a770a23 make sure OrderedDict order is preserved in output
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39378\fP: (\fI\%dmurphy18\fP) Update make_repo in debbuild.py execution module to utilize timeout
@ \fI2017\-02\-14 17:10:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
f2459e3ce8 Merge pull request \fI\%#39378\fP from dmurphy18/deb_pkg_fix
.IP \(bu 2
4bd47cc18a Updated all make_repo loops to use timeout value for retries
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39358\fP: (\fI\%Kimamisa\fP) Backport the RDS\ fix in Carbon (refs: \fI\%#39369\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39369\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37338\fP to 2016.11
@ \fI2017\-02\-13 21:41:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37338\fP: (\fI\%bailsman\fP) Fix wait_status in boto_rds.create() (refs: \fI\%#39369\fP)
.IP \(bu 2
99554d9d72 Merge pull request \fI\%#39369\fP from rallytime/bp\-37338
.IP \(bu 2
2e7f6e8e37 Fix wait_status in boto_rds.create()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39303\fP: (\fI\%kstreee\fP) Removes a redundant test case after removed \(aqbatch\(aq in \(aqnetapi\(aq.
@ \fI2017\-02\-13 19:55:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
03ab8b1b5a Merge pull request \fI\%#39303\fP from kstreee/fix\-testcase\-rm\-batch\-in\-netapi
.IP \(bu 2
51972d0724 Removes a redundant test case after removed \(aqbatch\(aq in \(aqnetapi\(aq.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39315\fP: (\fI\%Ch3LL\fP) improve salt\-run salt.cmd test
@ \fI2017\-02\-13 19:00:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
60640f77d7 Merge pull request \fI\%#39315\fP from Ch3LL/fix_run_salt_test
.IP \(bu 2
b3cbc5a408 improve salt\-run salt.cmd test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39243\fP: (\fI\%morganwillcock\fP) win_system.reboot: can return True without rebooting (refs: \fI\%#39311\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39311\fP: (\fI\%morganwillcock\fP) win_system: return False from a skipped reboot
@ \fI2017\-02\-13 18:59:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
2ca63a93cd Merge pull request \fI\%#39311\fP from morganwillcock/skip\-reboot
.IP \(bu 2
0f3abb613d Clarify success for shutdown function
.IP \(bu 2
dcb4d05275 win_system: return False from a skipped reboot
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39346\fP: (\fI\%joe\-niland\fP) Ignore non\-HTTP IIS bindings
@ \fI2017\-02\-13 18:18:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
082105fa84 Merge pull request \fI\%#39346\fP from joe\-niland/handle\-iis\-bindings
.IP \(bu 2
8d5afdb0ae win_iis module: list_sites \- when retrieving bindings, ignore bindigs whose protocols do not have host headers
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39321\fP: (\fI\%mgresser\fP) Grain matching failing where grain value is an INT (refs: \fI\%#39361\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39361\fP: (\fI\%gtmanfred\fP) make sure both variables are strings.
@ \fI2017\-02\-13 17:20:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
a3a9a8e1ed Merge pull request \fI\%#39361\fP from gtmanfred/2016.11
.IP \(bu 2
ee2275ad67 make sure both variables are strings.
.IP \(bu 2
\fBPR\fP \fI\%#39341\fP: (\fI\%eliasp\fP) Add creation/configuration of Salt PKI dirs to hacking docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39317\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-02\-10 23:07:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce1f01f81a Merge pull request \fI\%#39317\fP from rallytime/merge\-2016.11
.IP \(bu 2
c1df446b7a Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
9de559ff4e Merge pull request \fI\%#39313\fP from rallytime/merge\-2016.3
.INDENT 2.0
.IP \(bu 2
0b8dddf12b Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
fc551bcf5d Merge pull request \fI\%#39293\fP from sergeizv/grammar\-fix
.INDENT 2.0
.IP \(bu 2
70f2b586d3 Rewrap paragraph
.IP \(bu 2
e6ab5178ea Grammar fix
.UNINDENT
.IP \(bu 2
8a1b45632a Merge pull request \fI\%#39295\fP from sergeizv/typo\-fix
.INDENT 2.0
.IP \(bu 2
5d9f36d58d Fix typo
.UNINDENT
.IP \(bu 2
cfaafece34 Merge pull request \fI\%#39296\fP from sergeizv/whitespace\-fix
.INDENT 2.0
.IP \(bu 2
1d4c1dc140 Whitespace fix in docs Makefile
.UNINDENT
.IP \(bu 2
0b4dcf4a47 Merge pull request \fI\%#39294\fP from sergeizv/fix\-link
.INDENT 2.0
.IP \(bu 2
04bde6eed2 Fix link in proxyminion guide
.UNINDENT
.UNINDENT
.IP \(bu 2
dd3ca0ecb0 Fix \fI\%#38595\fP \- Unexpected error log from redis retuner in master\(aqs log (\fI\%#39299\fP)
.IP \(bu 2
f16027d30e Merge pull request \fI\%#39297\fP from cro/pg_returner_docs
.INDENT 2.0
.IP \(bu 2
28bac649ae Typo
.IP \(bu 2
19fedcdd23 Add doc to recommend pgjsonb for master job caches
.UNINDENT
.IP \(bu 2
77e50ed8b7 Merge pull request \fI\%#39286\fP from terminalmage/fix\-pillarenv\-precedence
.INDENT 2.0
.IP \(bu 2
3cb9833e57 Allow minion/CLI saltenv/pillarenv to override master when compiling pillar
.UNINDENT
.IP \(bu 2
52440416ca Merge pull request \fI\%#39221\fP from lvg01/fix\-bug\-39220
.INDENT 2.0
.IP \(bu 2
e8a41d6341 Removes to early content stripping (stripping is already done when needed with ident:true), fixes \fI\%#39220\fP
.IP \(bu 2
a4b169e0bd Fixed wrong logic, fixes \fI\%#39220\fP
.UNINDENT
.IP \(bu 2
5a27207c57 Add warning for Dulwich removal (\fI\%#39280\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38451\fP: (\fI\%ezh\fP) 2016.11 file.replace has multiple errors under python 3 (refs: \fI\%#38464\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38464\fP: (\fI\%ezh\fP) [38451] Fix file.replace 2016.11
@ \fI2017\-02\-09 23:07:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3c621aab0 Merge pull request \fI\%#38464\fP from doublescoring/fix\-2016.11\-38451
.IP \(bu 2
81f0337338 [38451] Fix few bugs after review
.IP \(bu 2
1bdab253ad [38451] Fix pylint W1699(incompatible\-py3\-code)
.IP \(bu 2
3bfc6547da [38451] Fix file.replace to make it suitable to python 3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39291\fP: (\fI\%terminalmage\fP) Add note about using saltenv jinja var in pillar top files
@ \fI2017\-02\-09 21:43:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
6365211a6f Merge pull request \fI\%#39291\fP from terminalmage/pillar\-docs
.IP \(bu 2
fbd551e069 Add note about using saltenv jinja var in pillar top files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39281\fP: (\fI\%twangboy\fP) Require VCRedist on 2008R2 and below instead of 2008
@ \fI2017\-02\-09 17:59:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
a496ec2a16 Merge pull request \fI\%#39281\fP from twangboy/win_installer
.IP \(bu 2
ef5078729a Capitalize the \(aqr\(aq for 2008R2
.IP \(bu 2
1b6bd634ac Require VCRedist on 2008R2 and below instead of 2008
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39264\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-02\-09 17:10:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
db6140aa83 Merge pull request \fI\%#39264\fP from rallytime/merge\-2016.11
.IP \(bu 2
a9c2c106c1 Pylint fix
.IP \(bu 2
f6aad99db2 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
1b9217d636 Update jsonschema tests to reflect change in jsonschema 2.6.0 (\fI\%#39260\fP)
.IP \(bu 2
c1d16cc3d0 Better handling of enabled/disabled arguments in pkgrepo.managed (\fI\%#39251\fP)
.IP \(bu 2
8e88f71dd9 Merge pull request \fI\%#39227\fP from terminalmage/loader\-optimization
.INDENT 2.0
.IP \(bu 2
c750662946 Loader optimzation
.UNINDENT
.IP \(bu 2
bc89b297f8 Merge pull request \fI\%#39228\fP from gtmanfred/2016.3
.INDENT 2.0
.IP \(bu 2
afee047b08 default to utf8 encoding if not specified
.UNINDENT
.IP \(bu 2
d9b0671dbd Merge pull request \fI\%#39231\fP from terminalmage/clarify\-jenkins\-depends
.INDENT 2.0
.IP \(bu 2
ad1b1255f2 Add clarification for jenkins execution module
.UNINDENT
.IP \(bu 2
ddcff89a84 Merge pull request \fI\%#39232\fP from terminalmage/issue21342
.INDENT 2.0
.IP \(bu 2
c88896c277 Avoid recursion in s3/svn ext_pillars
.UNINDENT
.IP \(bu 2
ef4e437bbc Fix the win_ip_test failures (\fI\%#39230\fP)
.IP \(bu 2
df5f934c34 Merge pull request \fI\%#39199\fP from rallytime/bp\-39170
.INDENT 2.0
.IP \(bu 2
c129905310 Added missing source_hash_name argument in get_managed function Additional fix to  \fI\%#33187\fP Customer was still seeing errors, this should now work. Tested with 2015.8.13 and 2016.11.2
.UNINDENT
.IP \(bu 2
2621c119fd Merge pull request \fI\%#39206\fP from cachedout/issue_issue_37174
.INDENT 2.0
.IP \(bu 2
be31e0559c Ignore empty dicts in highstate outputter
.UNINDENT
.IP \(bu 2
dd440452ea Merge pull request \fI\%#39209\fP from terminalmage/sorted\-envs
.INDENT 2.0
.IP \(bu 2
e6dda4a625 Sort the return list from the fileserver.envs runner
.UNINDENT
.IP \(bu 2
7bed68743e [2016.3] Pylint fix (\fI\%#39202\fP)
.IP \(bu 2
ab76054127 Merge pull request \fI\%#39197\fP from cachedout/pr\-38793
.INDENT 2.0
.IP \(bu 2
f3d35fb5c6 Lint fixes
.IP \(bu 2
624f25b78d Fix for \fI\%#38697\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39269\fP: (\fI\%alexharrington\fP) Remount forced with lizardfs fuse filesystem due to device mismatch (refs: \fI\%#39276\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#39106\fP: (\fI\%carsten\-AEI\fP) CVMFS fuse mount gets remounted every time (refs: \fI\%#39276\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39276\fP: (\fI\%gtmanfred\fP) _device_mismatch_ignored will never be True
@ \fI2017\-02\-09 17:05:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
304eb19b18 Merge pull request \fI\%#39276\fP from gtmanfred/2016.11
.IP \(bu 2
6635a9fd3b _device_mismatch_ignored will never be True
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39238\fP: (\fI\%dmurphy18\fP) Update disk fstype, inodeusage, percent and mount.active functions for AIX support
@ \fI2017\-02\-08 21:53:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
7611698474 Merge pull request \fI\%#39238\fP from dmurphy18/fix_aix_disk_mount
.IP \(bu 2
a8a519c493 Removed space for pylint
.IP \(bu 2
8fa0ffa427 Updates due to code review comments
.IP \(bu 2
97c59a8d1c Updated mount functionality for active on AIX
.IP \(bu 2
1a32b2cc89 Updated disk functionality for fstype, inodeuage and percent on AIX
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39233\fP: (\fI\%rallytime\fP) Various doc updates to fix warnings in doc build
@ \fI2017\-02\-08 19:29:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
99bfa7dfee Merge pull request \fI\%#39233\fP from rallytime/fixup\-more\-doc\-build\-warnings
.IP \(bu 2
2f74dcf685 Various doc updates to fix warnings in doc build
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39237\fP: (\fI\%axmetishe\fP) fix rds subnet group creation
@ \fI2017\-02\-08 19:04:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
59e927b520 Merge pull request \fI\%#39237\fP from axmetishe/2016.11
.IP \(bu 2
6f4be8b69c fix rds subnet group creation
.IP \(bu 2
\fBPR\fP \fI\%#39234\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
.IP \(bu 2
\fBPR\fP \fI\%#39225\fP: (\fI\%terminalmage\fP) Put legacy git_pillar on a deprecation path for Oxygen
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39078\fP: (\fI\%morganwillcock\fP) setup.py: cannot install without setting global options (refs: \fI\%#39180\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39180\fP: (\fI\%morganwillcock\fP) setup.py: Remove global options from install command
@ \fI2017\-02\-07 16:20:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
19c3d90a32 Merge pull request \fI\%#39180\fP from morganwillcock/setup
.IP \(bu 2
d7e05091a2 Remove global options from Install
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38863\fP: (\fI\%hujunya\fP) fix django auth not work
@ \fI2017\-02\-07 15:43:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
a0907bc861 Merge pull request \fI\%#38863\fP from hujunya/fix_django_auth
.IP \(bu 2
2a99ff46d3 check if django_auth_path has been in sys.path
.IP \(bu 2
933ebf15d7 fix pylint violations
.IP \(bu 2
6b5a7f4b64 fix django auth not work
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39198\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-02\-06 21:01:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3e541e0a2 Merge pull request \fI\%#39198\fP from rallytime/merge\-2016.11
.IP \(bu 2
7ea5f7f82f Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
fa45cbc359 Merge pull request \fI\%#39166\fP from Ch3LL/fix_boto_ec2_docs
.INDENT 2.0
.IP \(bu 2
90af696331 fix boto ec2 module create_image doc
.UNINDENT
.IP \(bu 2
a40cb46249 Merge pull request \fI\%#39173\fP from rallytime/restore\-community\-docs
.INDENT 2.0
.IP \(bu 2
5aeddf42a0 Restore \(dqSalt Community\(dq doc section
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39059\fP: (\fI\%mirceaulinic\fP) KeyError: \(aqmultiprocessing\(aq in the master logs (proxy minions) (refs: \fI\%#39063\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39063\fP: (\fI\%mirceaulinic\fP) Avoid KeyError: \(aqmultiprocessing\(aq in the master logs
@ \fI2017\-02\-06 19:37:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
2a85d73f59 Merge pull request \fI\%#39063\fP from cloudflare/ISS\-39059
.IP \(bu 2
7118eff034 Avoid KeyError: \(aqmultiprocessing\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38782\fP: (\fI\%lomeroe\fP) win_lgpo unable to find some Administrative Template policies (refs: \fI\%#38783\fP, \fI\%#39083\fP, \fI\%#39090\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38761\fP: (\fI\%DaveOHenry\fP) Cannot apply state that contains lgpo.set (refs: \fI\%#39083\fP, \fI\%#39088\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38689\fP: (\fI\%lomeroe\fP) win_lgpo state fails to set single policy due to case sensitive check (refs: \fI\%#39083\fP, \fI\%#39084\fP, \fI\%#38690\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38100\fP: (\fI\%skjaro\fP) Problem with win_lgpo.py in salt 2016.11.0 (refs: \fI\%#39083\fP, \fI\%#39089\fP, \fI\%#38779\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#21485\fP: (\fI\%lorengordon\fP) Feature Request: Manage Windows Local Security Policy Settings (refs: \fI\%#36336\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39083\fP: (\fI\%lomeroe\fP) Backport \fI\%#36336\fP to 2016.11
@ \fI2017\-02\-06 18:50:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36336\fP: (\fI\%lomeroe\fP) add additional static policies to computer configuration policy class (refs: \fI\%#39083\fP)
.IP \(bu 2
91c25bd651 Merge pull request \fI\%#39083\fP from lomeroe/bp\-36336
.IP \(bu 2
03e5319124 Merge branch \(aq2016.11\(aq into bp\-36336
.IP \(bu 2
981ec89a4d update command line example to correct policy name
.IP \(bu 2
e2574da0b8 Fix/Add documentation, 80 char line lengths
.IP \(bu 2
5e94a30a34 add additional static policies to computer configuration policy class duplicate code cleanup/misc code efficiencies
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39153\fP: (\fI\%nicholasmhughes\fP) Fix selinux.mode state config file handling
@ \fI2017\-02\-06 18:37:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
30455079fe Merge pull request \fI\%#39153\fP from nicholasmhughes/fix\-selinux.mode\-config\-predictability
.IP \(bu 2
8d8ba9c7d2 added the new getconfig function to the test
.IP \(bu 2
a6a24e1a1b Addressed edge case when attempting to set the config file to \(aqDisabled\(aq. The state should only check the file, since the in\-memory setting won\(aqt disappear until after reboot.
.IP \(bu 2
6858658cc2 The selinux.mode state only checked the current status of SELinux in memory (getenforce) when determining if changes needed to be made. The /etc/selinux/config file could have a different value, and it would not be changed. This commit enhances idempotency of the state in regards to both the in\-memory and configuration file enforcement of SELinux.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38081\fP: (\fI\%haraldrudell\fP) x509 state or module cannot generate password protected private keys (refs: \fI\%#39159\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39159\fP: (\fI\%clinta\fP) Csr crl passphrase
@ \fI2017\-02\-06 18:36:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
7b5eb17cbe Merge pull request \fI\%#39159\fP from clinta/csr\-crl\-passphrase
.IP \(bu 2
cf548ac717 Remove unnecessary pass
.IP \(bu 2
4ebf7a3df4 Remove unnecessary pass statement
.IP \(bu 2
6a8046970e fix csr bugs and pep8
.IP \(bu 2
36dcf5f3da only overwrite if overwrite option is specified
.IP \(bu 2
403000d375 recreate cert on bad password
.IP \(bu 2
6497094ba7 passphrase for crl
.IP \(bu 2
3ef809fb0f passphrase for csr
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39162\fP: (\fI\%meaksh\fP) Adding more function to Snapper module
@ \fI2017\-02\-06 18:33:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
b240468525 Merge pull request \fI\%#39162\fP from meaksh/snapper\-module\-improvements
.IP \(bu 2
f950732fa0 pylint fixes
.IP \(bu 2
aa2f9906e0 Removing extra spaces
.IP \(bu 2
9d6a33f257 Adds \(aqsnapper.create_config\(aq unit tests
.IP \(bu 2
d38ed505f8 Adds \(aqsnapper.modify_snapshots\(aq unit tests
.IP \(bu 2
d5496ccc99 Adds \(aqsnapper.delete_snapshots\(aq unit tests
.IP \(bu 2
3eecb6076b Snapper: Adding support for creating configurations
.IP \(bu 2
041e54d42a Snapper: Adding support for snapshot metadata modification
.IP \(bu 2
eaf5de9dce Snapper: Adding support for deleting snapshots
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38370\fP: (\fI\%tjyang\fP) Salt\-Cloud: There was a query error: Required field \(dqdeviceChange\(dq not provided (not @optional) (refs: \fI\%#39171\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39171\fP: (\fI\%techhat\fP) Raise an error for a disk size that is too small
@ \fI2017\-02\-06 18:19:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
6f9251ebed Merge pull request \fI\%#39171\fP from techhat/issue38370
.IP \(bu 2
ec57a39c00 Typo
.IP \(bu 2
2ed2932387 Clean up debug logs
.IP \(bu 2
671282656a Raise an error for a disk size that is too small
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39179\fP: (\fI\%mcalmer\fP) fix error parsing
@ \fI2017\-02\-06 17:57:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
036f36dc9b Merge pull request \fI\%#39179\fP from mcalmer/fix\-dockerng\-error\-parsing
.IP \(bu 2
6750ccd78e fix error parsing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39189\fP: (\fI\%morganwillcock\fP) Fix NetBSD sockstat parsing
@ \fI2017\-02\-06 17:28:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
30f83156cb Merge pull request \fI\%#39189\fP from morganwillcock/sockstat
.IP \(bu 2
344d13eff5 Fix NetBSD sockstat example
.IP \(bu 2
64b693195c Fix NetBSD sockstat parsing
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38003\fP: (\fI\%morganwillcock\fP) salt.runners.cache functions seem to ignore minion targeting parameter (refs: \fI\%#39141\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39141\fP: (\fI\%UtahDave\fP) Don\(aqt overwrite the minion_ids var that was passed
@ \fI2017\-02\-03 20:56:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a9704189f Merge pull request \fI\%#39141\fP from UtahDave/fix_cache_lookup_ZD1187
.IP \(bu 2
0340614d15 return all minions\(aq grains if no tgt
.IP \(bu 2
f833bf3a79 Don\(aqt overwrite the minion_ids var that was passed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39164\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-02\-03 17:57:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
d19cee716f Merge pull request \fI\%#39164\fP from rallytime/merge\-2016.11
.IP \(bu 2
6504bb6b02 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
9de08af950 Apply fix from \fI\%#38705\fP to 2016.3 branch (\fI\%#39077\fP)
.IP \(bu 2
da3053ea9b update vmware getting started doc (\fI\%#39146\fP)
.IP \(bu 2
e78ca0f575 Fixing a weird edge case when using salt syndics and targetting via pillar.  Without this fix the master of masters ends up in an infinite loop since the data returned from the minions is differently structured than if a sync was not in use. (\fI\%#39145\fP)
.IP \(bu 2
cd8077ab81 Merge pull request \fI\%#38804\fP from alexbleotu/root_dir_fix\-2016.3\-gh
.INDENT 2.0
.IP \(bu 2
b3bdd3b04a Add missing whiteline
.IP \(bu 2
c7715acd53 Merge pull request \fI\%#3\fP from cro/ab_rootdirfix
.INDENT 2.0
.IP \(bu 2
e8cbafaaf1 When running testsuite, salt.syspaths.ROOT_DIR is often empty.
.UNINDENT
.IP \(bu 2
b12dd44a26 Merge pull request \fI\%#1\fP from cro/ab_rootdirfix
.INDENT 2.0
.IP \(bu 2
bffc537aca Remove extra if statements (rstrip will check for the presence anyway).
.UNINDENT
.IP \(bu 2
97521b3468 Second attempt to fix prepending of root_dir to paths
.UNINDENT
.IP \(bu 2
6ffeda3ee5 Clarify ipv6 option for minion and interface for master, closes \fI\%#39118\fP (\fI\%#39131\fP)
.IP \(bu 2
646b9ea4e5 Don\(aqt abort pillar.get with merge=True if default is None (\fI\%#39116\fP)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39152\fP: (\fI\%twangboy\fP) Remove files not needed by salt\-minion
@ \fI2017\-02\-03 17:11:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
ed12512045 Merge pull request \fI\%#39152\fP from twangboy/win_installer
.IP \(bu 2
5ff8a14317 Fix problem deleting files
.IP \(bu 2
4524dd49d4 Remove files not needed by salt\-minion
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38691\fP: (\fI\%lomeroe\fP) win_lgpo module throws a key error when run with return_not_configured=True (refs: \fI\%#39085\fP, \fI\%#38666\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39085\fP: (\fI\%lomeroe\fP) Backport \fI\%#38666\fP to 2016.11
.IP \(bu 2
\fBPR\fP \fI\%#38666\fP: (\fI\%lomeroe\fP) correct issue when running lgpo.get with return_not_configured=True (refs: \fI\%#39085\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39086\fP: (\fI\%lomeroe\fP) Backport \fI\%#38165\fP to 2016.11
.IP \(bu 2
\fBPR\fP \fI\%#38165\fP: (\fI\%lomeroe\fP) have _in_range_inclusive function attempt to convert a string to an i… (refs: \fI\%#39086\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38241\fP: (\fI\%frogunder\fP) mine.get and salt\-ssh gives error message (refs: \fI\%#38970\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38970\fP: (\fI\%gtmanfred\fP) when using local_cache we have to pass the list of minions
@ \fI2017\-02\-02 19:24:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
4eec641b65 Merge pull request \fI\%#38970\fP from gtmanfred/2016.11
.IP \(bu 2
ebb9df3ec7 when using local_cache we have to pass the list of minions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39110\fP: (\fI\%morganwillcock\fP) archive.extracted: 2016.11.2 returns state failure for some zip formats, if already extracted (refs: \fI\%#39128\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39128\fP: (\fI\%terminalmage\fP) Fix archive.list on Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#36712\fP: (\fI\%dmitrievav\fP) s3.put function does not create s3 bucket (refs: \fI\%#36714\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39133\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36714\fP to 2016.11
.IP \(bu 2
\fBPR\fP \fI\%#36714\fP: (\fI\%dmitrievav\fP) s3.put can\(aqt create s3 bucket (refs: \fI\%#39133\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38689\fP: (\fI\%lomeroe\fP) win_lgpo state fails to set single policy due to case sensitive check (refs: \fI\%#39083\fP, \fI\%#39084\fP, \fI\%#38690\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39084\fP: (\fI\%lomeroe\fP) Backport \fI\%#38690\fP to 2016.11
.IP \(bu 2
\fBPR\fP \fI\%#38690\fP: (\fI\%lomeroe\fP) correct checking of policy_class to compare with lower() version of t… (refs: \fI\%#39084\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38100\fP: (\fI\%skjaro\fP) Problem with win_lgpo.py in salt 2016.11.0 (refs: \fI\%#39083\fP, \fI\%#39089\fP, \fI\%#38779\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39089\fP: (\fI\%lomeroe\fP) Backport \fI\%#38779\fP to 2016.11
.IP \(bu 2
\fBPR\fP \fI\%#38779\fP: (\fI\%lomeroe\fP) win_lgpo handle errors when \(aqencoding=\(dqunicode\(dq\(aq exists in ADMX file (refs: \fI\%#39089\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38782\fP: (\fI\%lomeroe\fP) win_lgpo unable to find some Administrative Template policies (refs: \fI\%#38783\fP, \fI\%#39083\fP, \fI\%#39090\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39090\fP: (\fI\%lomeroe\fP) Backport  \fI\%#38783\fP to 2016.11
.IP \(bu 2
\fBPR\fP \fI\%#38783\fP: (\fI\%lomeroe\fP) Perform a \(dqstarts\-with\(dq search to match ADML text names (refs: \fI\%#39090\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38761\fP: (\fI\%DaveOHenry\fP) Cannot apply state that contains lgpo.set (refs: \fI\%#39083\fP, \fI\%#39088\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39088\fP: (\fI\%lomeroe\fP) Backport  \fI\%#37262\fP to 2016.11
.IP \(bu 2
\fBPR\fP \fI\%#37262\fP: (\fI\%lomeroe\fP) correct issues in win_lgpo module (refs: \fI\%#39088\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39122\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-02\-01 21:41:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
50d72da3f6 Merge pull request \fI\%#39122\fP from rallytime/merge\-2016.11
.IP \(bu 2
a782b00ee1 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
cc9b69b6bc Merge pull request \fI\%#39091\fP from terminalmage/update\-test\-valid\-docs
.INDENT 2.0
.IP \(bu 2
d76f0380d0 add debug logging for batch vars
.IP \(bu 2
b4afea2a25 Don\(aqt fail test if data is empty
.IP \(bu 2
b3a5d549c1 Account for trimmed value in \(aqsalt \-d\(aq output
.IP \(bu 2
909916c78e Run test_valid_docs in batches
.UNINDENT
.IP \(bu 2
bcee3d1ef6 Move fileclient tests to tests/integration/fileserver/fileclient_test.py (\fI\%#39081\fP)
.IP \(bu 2
122422bc08 Bump openstack deprecation notice to Oxygen (\fI\%#39067\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39087\fP: (\fI\%lomeroe\fP) Backport \fI\%#37375\fP to 2016.11
@ \fI2017\-02\-01 19:02:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37375\fP: (\fI\%lomeroe\fP) add updating gpt.ini file when ADM template policies are modified (gp… (refs: \fI\%#39087\fP)
.IP \(bu 2
f8a6863d98 Merge pull request \fI\%#39087\fP from lomeroe/bp\-37375
.IP \(bu 2
c3aaa536f3 _in_range_inclusive class method incorrectly called isinstance
.IP \(bu 2
ce263f9372 set_computer_policy and set_user_policy call \(dqset\(dq by the original function name (set) instead of the aliased function name set_
.IP \(bu 2
ff7d74bfb0 correct tool extension guid for user registry policies
.IP \(bu 2
08f0078ef3 spelling correction
.IP \(bu 2
5fc40485f7 add updating gpt.ini file when ADM template policies are modified (gpt.ini file must exist with proper data for ADM policies to apply)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39094\fP: (\fI\%rallytime\fP) Add a bunch of missing doc module references
@ \fI2017\-02\-01 18:56:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
c4c6e701af Merge pull request \fI\%#39094\fP from rallytime/doc\-build\-warnings
.IP \(bu 2
b866427f59 Add a bunch of missing doc module references
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39108\fP: (\fI\%janhorstmann\fP) [Bugfix] Fix state x509.crl_managed
@ \fI2017\-02\-01 18:32:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
d302bb747e Merge pull request \fI\%#39108\fP from janhorstmann/fix\-x509\-state
.IP \(bu 2
9f5c532510 [Bugfix] Fix state x509.crl_managed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39100\fP: (\fI\%whytewolf\fP) salt\-run fileserver.update Exception (refs: \fI\%#39107\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#39098\fP: (\fI\%FraaJad\fP) state.event runner fails with TypeError: argument of type \(aqNoneType\(aq is not iterable  (refs: \fI\%#39107\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38638\fP: (\fI\%mirceaulinic\fP) \fIsalt.cmd\fP runner raises TypeError when function returns bool (refs: \fI\%#39107\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39107\fP: (\fI\%mirceaulinic\fP) Check if data[\(aqreturn\(aq] is dict type
@ \fI2017\-02\-01 18:21:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf61ec9515 Merge pull request \fI\%#39107\fP from cloudflare/FIX\-38638
.IP \(bu 2
7c34815979 Check if data[\(aqreturn\(aq] is dict type
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39065\fP: (\fI\%jak3kaj\fP) primary bonding option is not applied (refs: \fI\%#39068\fP, \fI\%#39069\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39069\fP: (\fI\%jak3kaj\fP) Update primary bonding option in rh_ip.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39065\fP: (\fI\%jak3kaj\fP) primary bonding option is not applied (refs: \fI\%#39068\fP, \fI\%#39069\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39068\fP: (\fI\%jak3kaj\fP) Update primary bonding option in debian_ip.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38704\fP: (\fI\%nasenbaer13\fP) Archive extracted fails when another state run is queued (refs: \fI\%#38705\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39076\fP: (\fI\%terminalmage\fP) Re\-submit PR \fI\%#38705\fP against 2016.11 branch
@ \fI2017\-01\-31 20:11:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38705\fP: (\fI\%nasenbaer13\fP) Fix for \fI\%#38704\fP archive extracted and dockerio states (refs: \fI\%#39077\fP, \fI\%#39076\fP)
.IP \(bu 2
9836d7dd29 Merge pull request \fI\%#39076\fP from terminalmage/pr\-38705
.IP \(bu 2
15db8d47ed Fix for \fI\%#38704\fP archive extracted and dockerio states
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39057\fP: (\fI\%sergeizv\fP) modules.linux_lvm.fullversion provides incomplete info (refs: \fI\%#39058\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39058\fP: (\fI\%sergeizv\fP) Fix salt.modules.linux_lvm.fullversion
@ \fI2017\-01\-31 19:01:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
86b4b77bfe Merge pull request \fI\%#39058\fP from sergeizv/fix\-lvm\-fullversion
.IP \(bu 2
e46c89f9ed Fix salt.modules.linux_lvm.fullversion
.IP \(bu 2
fb7ef99838 Fix mock emulating lvm version
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39051\fP: (\fI\%afletch\fP) salt.roster.cache / salt.utils.cloud is_public_ip \- incorrect public IP address (refs: \fI\%#39066\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39066\fP: (\fI\%techhat\fP) 127.0.0.0/8 is all loopback
@ \fI2017\-01\-31 18:43:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
721b245f90 Merge pull request \fI\%#39066\fP from techhat/issue39051
.IP \(bu 2
ea43bb8101 127.0.0.0/8 is all loopback
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39070\fP: (\fI\%sergeizv\fP) modules.linux_lvm.pvcreate misbehaves if all submitted devices are already LVM PVs (refs: \fI\%#39071\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39071\fP: (\fI\%sergeizv\fP) Fix modules.linux_lvm.pvcreate on existing LVM PVs
@ \fI2017\-01\-31 18:36:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
c54d9f4e2a Merge pull request \fI\%#39071\fP from sergeizv/fix\-lvm\-pvcreate
.IP \(bu 2
f1e3e86e6a Fix modules.linux_lvm.pvcreate on existing LVM PVs
.IP \(bu 2
0f84ca2487 Add test for modules.linux_lvm.pvcreate on existing LVM PVs
.IP \(bu 2
3967992bfd Fix test for modules.linux_lvm.pvcreate
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39048\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-01\-31 15:55:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
88b171f863 Merge pull request \fI\%#39048\fP from rallytime/merge\-2016.11
.IP \(bu 2
b2b3989773 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
a24af5ac46 Merge pull request \fI\%#39047\fP from rallytime/merge\-2016.3
.INDENT 2.0
.IP \(bu 2
b732a1f646 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
56ccae6ff7 Add 2015.8.14 release notes file (\fI\%#39046\fP)
.IP \(bu 2
5943fe65d3 Update 2015.8.13 release notes (\fI\%#39037\fP)
.UNINDENT
.IP \(bu 2
fef1b1133d Add 2016.3.6 release notes file (\fI\%#39045\fP)
.IP \(bu 2
7c43f4ac32 [2016.3] Update release numbers for doc build (\fI\%#39042\fP)
.IP \(bu 2
ff324599d5 Update 2016.3.5 release notes (\fI\%#39038\fP)
.IP \(bu 2
5b09dc4198 Merge pull request \fI\%#39028\fP from terminalmage/clarify\-delimiter\-argument
.INDENT 2.0
.IP \(bu 2
f29ef071f3 Clarify delimiter argument
.UNINDENT
.IP \(bu 2
1ff359fa58 Add CLI Example for rest_sample_utils.get_test_string function (\fI\%#39030\fP)
.IP \(bu 2
f13fb9ef1e Enable __proxy__ availability in states, highstate, and utils. Enable __utils__ availability in proxies. (\fI\%#38899\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39035\fP: (\fI\%cro\fP) Add CLI Examples so tests will pass
.IP \(bu 2
\fBPR\fP \fI\%#39044\fP: (\fI\%rallytime\fP) Add 2016.11.3 release notes file
.IP \(bu 2
\fBPR\fP \fI\%#39040\fP: (\fI\%rallytime\fP) [2016.11] Update release numbers for doc build
.IP \(bu 2
\fBPR\fP \fI\%#39039\fP: (\fI\%rallytime\fP) Update 2016.11.2 release notes
.IP \(bu 2
\fBPR\fP \fI\%#39005\fP: (\fI\%cro\fP) Ungate the status.py module and raise unsupported errors in functions not executable on Windows. (refs: \fI\%#39536\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39012\fP: (\fI\%terminalmage\fP) Fix \(dqinvalid lexer\(dq errors in docs build
@ \fI2017\-01\-28 06:47:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
e70904c480 Merge pull request \fI\%#39012\fP from terminalmage/invalid\-lexer
.IP \(bu 2
868001baac Fix \(dqinvalid lexer\(dq errors in docs build
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39003\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-01\-28 00:09:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
cea0f32936 Merge pull request \fI\%#39003\fP from rallytime/merge\-2016.11
.IP \(bu 2
76e95087fd Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
da96221741 Merge pull request \fI\%#38951\fP from DSRCorporation/bugs/37938_fix_depends_decorator_memleak
.INDENT 2.0
.IP \(bu 2
0b18f34678 Keep the only one record per module\-function in depends decorator.
.UNINDENT
.IP \(bu 2
85165edb70 Merge pull request \fI\%#38982\fP from rallytime/fix\-34780
.INDENT 2.0
.IP \(bu 2
1583c5579a Set response when using \(dqGET\(dq method in s3 utils
.UNINDENT
.IP \(bu 2
cfdbc99e12 Merge pull request \fI\%#38989\fP from alprs/docfix\-state_pt3_environ
.INDENT 2.0
.IP \(bu 2
52a9ad1c60 fix SLS in environment variable examples
.UNINDENT
.IP \(bu 2
55e4d2572e Merge pull request \fI\%#39000\fP from rallytime/skip\-badload\-test
.INDENT 2.0
.IP \(bu 2
4b3ff0fe0f Skip the test_badload test until Jenkins move is complete
.UNINDENT
.IP \(bu 2
fe054eb772 Merge pull request \fI\%#38995\fP from terminalmage/fix\-pillar.item\-docstring
.INDENT 2.0
.IP \(bu 2
06d094dd8f Fix pillar.item docstring
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38853\fP: (\fI\%bobrik\fP) file.serialize still expects show_diff instead of show_changes (refs: \fI\%#38908\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38908\fP: (\fI\%bobrik\fP) Deprecate show_diff for file.serialize to mimic file.managed, closes \fI\%#38853\fP
@ \fI2017\-01\-27 17:15:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
58543d5cbf Merge pull request \fI\%#38908\fP from bobrik/show\-changes\-for\-serialize
.IP \(bu 2
e0af212c1b Remove unnecessary blank lines
.IP \(bu 2
a08c1ca530 Deprecate show_diff for file.serialize to mimic file.managed, closes \fI\%#38853\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#1021\fP: (\fI\%sjorge\fP) salt\-bootstrap missing salt\-api.xml on smartos (refs: \fI\%#38978\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38978\fP: (\fI\%sjorge\fP) fixes \fI\%saltstack/salt\-bootstrap#1021\fP
@ \fI2017\-01\-27 17:05:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
4b75dfac95 Merge pull request \fI\%#38978\fP from sjorge/2016.11\-bootstrap
.IP \(bu 2
26eb35f99d fixes salt/salt\-bootstrap\(ga#1021\(ga_
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38991\fP: (\fI\%isbm\fP) Isbm zypper state unknown pkg crash
@ \fI2017\-01\-27 16:59:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
b40f369d98 Merge pull request \fI\%#38991\fP from isbm/isbm\-zypper\-state\-unknown\-pkg\-crash
.IP \(bu 2
35f620e1c8 Prevent crash on unknown to the repo package
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38979\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-01\-26 22:56:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e76662166 Merge pull request \fI\%#38979\fP from rallytime/merge\-2016.11
.IP \(bu 2
fdaa5ac1b0 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
b66b6f6423 Merge pull request \fI\%#38950\fP from mbom2004/2016.3
.INDENT 2.0
.IP \(bu 2
c09f39d6c9 Remove unused json import
.IP \(bu 2
249efa3068 Fixed Logstash Engine in file logstash.py
.UNINDENT
.IP \(bu 2
a6c6e47842 Handle changing \(dqis_default\(dq value in moto package for boto test mock (\fI\%#38973\fP)
.IP \(bu 2
b965b5dcc2 Merge pull request \fI\%#38952\fP from terminalmage/zd1168
.INDENT 2.0
.IP \(bu 2
6b014e53fc Rename on_demand_pillar to on_demand_ext_pillar
.IP \(bu 2
d216f90c63 Document new on_demand_pillar option and add to config template
.IP \(bu 2
426b20f02f Add documentation for on\-demand pillar to pillar.ext docstring
.IP \(bu 2
7b10274b6b Make on\-demand ext_pillars tunable
.IP \(bu 2
d54723ccae Add on_demand_pillar config option
.UNINDENT
.IP \(bu 2
2c4ad85a78 Merge pull request \fI\%#38948\fP from rallytime/bump\-template\-context\-deprecation
.INDENT 2.0
.IP \(bu 2
749e0031d7 Bump the template context deprecation version to Oxygen
.UNINDENT
.IP \(bu 2
e4514ca7d8 Merge pull request \fI\%#38946\fP from rallytime/bp\-37632
.INDENT 2.0
.IP \(bu 2
ee37cdace9 Fix some lint
.IP \(bu 2
c08071e182 Fix versions report for server OSs
.UNINDENT
.IP \(bu 2
953a20350a Merge pull request \fI\%#38913\fP from Adaephon\-GH/patch\-1
.INDENT 2.0
.IP \(bu 2
e2f4a16fdd Removing trailing whitespace
.IP \(bu 2
616292c6b1 Ignore plist files without Label key
.UNINDENT
.IP \(bu 2
826dce1059 Merge pull request \fI\%#38917\fP from twangboy/update_jinja_mac
.INDENT 2.0
.IP \(bu 2
62e608b627 Update Jinja2 to 2.9.4
.UNINDENT
.IP \(bu 2
b27733cc33 Merge pull request \fI\%#38925\fP from terminalmage/issue38540
.INDENT 2.0
.IP \(bu 2
76392fc6ad Fix traceback when a netapi module uses wheel_async
.IP \(bu 2
bd4474fa62 Fix \(aqsuccess\(aq value for wheel commands
.UNINDENT
.IP \(bu 2
618596f0cc Merge pull request \fI\%#38926\fP from gtmanfred/2016.3
.INDENT 2.0
.IP \(bu 2
9cae953c93 add note about pysss for pam eauth
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38937\fP: (\fI\%arthru\fP) Fix smtp ret require gnupg
@ \fI2017\-01\-26 20:08:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
0660cc3cf2 Merge pull request \fI\%#38937\fP from HashBangDev/fix\-smtp\-ret\-require\-gnupg
.IP \(bu 2
399556b9fe Remove trailing whitespace
.IP \(bu 2
f308d13a17 log an error on gnupg absence instead of raising an exception
.IP \(bu 2
0427879d19 fails if gpgowner is set in smtp returner config but the installation lacks gnupg module
.IP \(bu 2
27449c5a9b smtp returner does not require gnupg to be installed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38816\fP: (\fI\%grichmond\-salt\fP) Errors in cloud runners are not reliably being captured as failures. (refs: \fI\%#38955\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38955\fP: (\fI\%techhat\fP) Do a better job at error detection in runners
@ \fI2017\-01\-26 20:00:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
d947c5c449 Merge pull request \fI\%#38955\fP from techhat/issue38816
.IP \(bu 2
ea8654f400 Typo
.IP \(bu 2
94050ff716 Watch out for bools
.IP \(bu 2
0142b0bcb3 Do a better job at error detection in runners
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38953\fP: (\fI\%thatch45\fP) fix an issue where thorium would remove keys of reattaching minions
@ \fI2017\-01\-26 19:15:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
04a5b05c36 Merge pull request \fI\%#38953\fP from thatch45/thorium_keyfix
.IP \(bu 2
68e96b11ac This is faster and cleaner
.IP \(bu 2
13d28a34a6 fix an issue where thorium would remove keys of reattaching minions
.IP \(bu 2
\fBPR\fP \fI\%#38972\fP: (\fI\%rallytime\fP) Add CLI Example for rest_sample_utils.get_test_string function (refs: \fI\%#39030\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38957\fP: (\fI\%mcalmer\fP) Fix timezone handling for rpm installtime
@ \fI2017\-01\-26 18:41:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
27166fad4e Merge pull request \fI\%#38957\fP from mcalmer/fix\-rpm\-install_date\-timezone
.IP \(bu 2
c7da9f87b6 Fix timezone handling for rpm installtime
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38965\fP: (\fI\%toanju\fP) salt\-cloud will use list_floating_ips for OpenStack
@ \fI2017\-01\-26 16:44:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34280\fP: (\fI\%kevinanderson1\fP) salt\-cloud will use list_floating_ips for Openstack (refs: \fI\%#38965\fP)
.IP \(bu 2
ec690a0a12 Merge pull request \fI\%#38965\fP from toanju/2016.11
.IP \(bu 2
1253ce9b63 salt\-cloud will use list_floating_ips for OpenStack
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38949\fP: (\fI\%clinta\fP) Use signing passphrase as public passphrase when generating self\-sign…
@ \fI2017\-01\-25 20:20:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
d906e8fadb Merge pull request \fI\%#38949\fP from clinta/x509\-passphrase\-bug
.IP \(bu 2
c8697e38a8 Use signing passphrase as public passphrase when generating self\-signed certificates
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38929\fP: (\fI\%MTecknology\fP) Fix psutil regressions in 2016.11
@ \fI2017\-01\-25 20:17:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
de3b2cc97b Merge pull request \fI\%#38929\fP from MTecknology/2016.11
.IP \(bu 2
73a8c6d121 Load core grains only if required.
.IP \(bu 2
4966011cb5 Modules might still be needed, even if psutil loads.
.IP \(bu 2
fb0432fd21 Fixes a regression with old versions of python\-psutil.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38940\fP: (\fI\%isbm\fP) Isbm sanitizers fix and unit test
@ \fI2017\-01\-25 20:15:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ec806c003 Merge pull request \fI\%#38940\fP from isbm/isbm\-sanitizers\-fix\-and\-unit\-test
.IP \(bu 2
a112b790fe Fix typo
.IP \(bu 2
47a16916c3 Add unit test
.IP \(bu 2
046c5436eb Fix leading dots on sanitized hostname
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38944\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-01\-25 19:44:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
e420763285 Merge pull request \fI\%#38944\fP from rallytime/merge\-2016.11
.IP \(bu 2
ee33a53a64 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
405d86a2ca Merge pull request \fI\%#38847\fP from terminalmage/issue38825
.INDENT 2.0
.IP \(bu 2
11a47803ce Use log.exception() instead
.IP \(bu 2
e40fac589a Catch MinionError in file.source_list
.UNINDENT
.IP \(bu 2
b5df104fc2 Merge pull request \fI\%#38875\fP from terminalmage/issue36121
.INDENT 2.0
.IP \(bu 2
fbc4d2a2c4 reactor: ensure glob_ref is a string
.IP \(bu 2
2e443d79a3 cp.cache_file: add note re: return for nonexistent salt:// path
.UNINDENT
.IP \(bu 2
e9ebec4d80 Merge pull request \fI\%#38890\fP from cro/vmware_reset_vm_20163
.INDENT 2.0
.IP \(bu 2
0146562fb4 Call correct function for resetting a VM
.UNINDENT
.IP \(bu 2
c3fbfcd231 Merge pull request \fI\%#38883\fP from techhat/dontrequire
.INDENT 2.0
.IP \(bu 2
67bc4d6687 Don\(aqt require text_out path to exist
.UNINDENT
.IP \(bu 2
6430a45196 Merge pull request \fI\%#38851\fP from terminalmage/docker\-py\-2.0
.INDENT 2.0
.IP \(bu 2
3c061b21fe Support docker\-py 2.0 in dockerng
.UNINDENT
.IP \(bu 2
ac8008d843 Merge pull request \fI\%#38844\fP from cachedout/http_memory_leak
.INDENT 2.0
.IP \(bu 2
c46bf85518 Fix memory leak in HTTP client
.UNINDENT
.IP \(bu 2
dfe6dfe963 Merge pull request \fI\%#38823\fP from gtmanfred/2016.3
.INDENT 2.0
.IP \(bu 2
f0a71e8707 pass pillar to compound matcher in match module
.UNINDENT
.IP \(bu 2
a04ab86da1 Merge pull request \fI\%#38833\fP from Ch3LL/add_release_notes_2016.3.5
.IP \(bu 2
374dc1ab88 skip 2016.3.5 due to :doc: references
.IP \(bu 2
31f324c4ff add 2016.3.5 changelog to release notes
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38753\fP: (\fI\%alexbleotu\fP) \fI__proxy__\fP dunder is not injected when invoking the \fIsalt\fP variable in sls files (refs: \fI\%#38899\fP, \fI\%#38900\fP, \fI\%#38829\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38557\fP: (\fI\%alexbleotu\fP) Proxy not working on develop (refs: \fI\%#38829\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38265\fP: (\fI\%mirceaulinic\fP) \fI__utils__\fP object not available in proxy module (refs: \fI\%#38899\fP, \fI\%#38900\fP, \fI\%#38829\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#32918\fP: (\fI\%mirceaulinic\fP) Proxy minions reconnection (refs: \fI\%#38829\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38900\fP: (\fI\%cro\fP) Enable __proxy__ availability in states, highstate, and utils. Enable __utils__ for proxies.
@ \fI2017\-01\-25 19:36:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38899\fP: (\fI\%cro\fP) Enable __proxy__ availability in states, highstate, and utils. Enable __utils__ for proxies. (refs: \fI\%#38900\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38829\fP: (\fI\%cro\fP) MANY dunder variable fixes for proxies + proxy keepalive from @mirceaulinic (refs: \fI\%#38899\fP, \fI\%#38900\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37864\fP: (\fI\%mirceaulinic\fP) Proxy keepalive feature (refs: \fI\%#38829\fP)
.IP \(bu 2
bd4889ac73 Merge pull request \fI\%#38900\fP from cro/px_dunder_201611
.IP \(bu 2
9a86fddfa1 Remove extra call to salt.loader.utils.
.IP \(bu 2
f4ba89735c Resolve merge conflict
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38918\fP: (\fI\%thatch45\fP) Thorium typos
@ \fI2017\-01\-25 19:00:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
f94b8798b6 Merge pull request \fI\%#38918\fP from thatch45/thorium_typos
.IP \(bu 2
0b4aca9145 fix some minor typos in the thorium docs
.IP \(bu 2
58a18e2b58 Add test= True to the master so that thorium does not stack trace
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38543\fP: (\fI\%amendlik\fP) salt \-\-subset returns wrong number of minions (refs: \fI\%#38919\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38919\fP: (\fI\%cachedout\fP) Correctly pass subset to cmd_subset
@ \fI2017\-01\-25 18:59:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
32fbb945b7 Merge pull request \fI\%#38919\fP from cachedout/issue_38543
.IP \(bu 2
a555de7c56 Correctly pass subset to cmd_subset
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38922\fP: (\fI\%twangboy\fP) Fix 64bit detection, vcredist only on <= 2008
@ \fI2017\-01\-25 18:47:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b3c738bfd Merge pull request \fI\%#38922\fP from twangboy/fix_vcredist
.IP \(bu 2
214e1cc598 Fix 64bit detection, vcredist only on <= 2008
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38371\fP: (\fI\%syphernl\fP) [2016.11.1] Scheduled highstates not returning to master (refs: \fI\%#38923\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38923\fP: (\fI\%DmitryKuzmenko\fP) Fixed broken __schedule_return handler.
@ \fI2017\-01\-25 18:45:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36202\fP: (\fI\%hu\-dabao\fP) for 36049, log current connected master and make status module more useful and efficient (refs: \fI\%#38923\fP)
.IP \(bu 2
954658523b Merge pull request \fI\%#38923\fP from DSRCorporation/bugs/38371_fix_schedule_return
.IP \(bu 2
b18f675486 Fixed broken __schedule_return handler.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38927\fP: (\fI\%l2ol33rt\fP) Adding explicit install of python\-systemd in jessie\-backports on Debian Guide
@ \fI2017\-01\-25 18:21:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
828e9bd8f9 Merge pull request \fI\%#38927\fP from l2ol33rt/debian_doc_fix
.IP \(bu 2
9cc9c6110d Adding explicit call to python\-systemd in jessie\-backports
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37413\fP: (\fI\%Snarfingcode666\fP) Salt\-cloud vmware missing reboot command (refs: \fI\%#38890\fP, \fI\%#38887\fP, \fI\%#38889\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38889\fP: (\fI\%cro\fP) Backport \fI\%#38887\fP to 2016.11: Call correct function for resetting a VM
@ \fI2017\-01\-24 15:20:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38887\fP: (\fI\%cro\fP) Enable resetting a VM via salt\-cloud & VMware driver (refs: \fI\%#38890\fP, \fI\%#38889\fP)
.IP \(bu 2
5ff5e97598 Merge pull request \fI\%#38889\fP from cro/vmware_reset_vm_201611
.IP \(bu 2
76a9920a6b Call correct function for resetting a VM
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38891\fP: (\fI\%UtahDave\fP) Proper function parameter default
@ \fI2017\-01\-24 15:06:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
53d0aa8855 Merge pull request \fI\%#38891\fP from UtahDave/fix_cassandra_protocol_version
.IP \(bu 2
c475609683 Proper function parameter default
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38904\fP: (\fI\%terminalmage\fP) Add top file merging docs to the master config file documentation
@ \fI2017\-01\-24 14:59:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
c680ee3174 Merge pull request \fI\%#38904\fP from terminalmage/docs
.IP \(bu 2
42a3652620 Add top file merging docs to the master config file documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38885\fP: (\fI\%meaksh\fP) Increasing timeouts for running integrations tests
@ \fI2017\-01\-23 18:59:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
41a3055213 Merge pull request \fI\%#38885\fP from meaksh/2016.11\-fix\-tests\-issues
.IP \(bu 2
4311b0b6de Increasing timeouts for running integrations tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38639\fP: (\fI\%isbm\fP) Isbm disable custom roster for api 2016.11
@ \fI2017\-01\-23 18:59:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
bde6d3eee7 Merge pull request \fI\%#38639\fP from isbm/isbm\-disable\-custom\-roster\-for\-api\-2016.11
.IP \(bu 2
ffbd45062e Explain what it is about and how to configure that
.UNINDENT
.UNINDENT
.SS Salt 2016.11.4 Release Notes
.sp
Version 2016.11.4 is a bugfix release for \fI\%2016.11.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB276\fP
.IP \(bu 2
Total Issue References: \fB63\fP
.IP \(bu 2
Total PR References: \fB223\fP
.IP \(bu 2
Contributors: \fB62\fP (\fI\%Ch3LL\fP, \fI\%DennisHarper\fP, \fI\%DmitryKuzmenko\fP, \fI\%L4rS6\fP, \fI\%MasterNayru\fP,
\fI\%Seb\-Solon\fP, \fI\%The\-Loeki\fP, \fI\%UtahDave\fP, \fI\%aabognah\fP, \fI\%alankrita\fP, \fI\%amontalban\fP,
\fI\%ardakuyumcu\fP, \fI\%attiasr\fP, \fI\%bdrung\fP, \fI\%bewing\fP, \fI\%cachedout\fP, \fI\%cro\fP, \fI\%defanator\fP,
\fI\%discountbin\fP, \fI\%dmurphy18\fP, \fI\%drawsmcgraw\fP, \fI\%eldadru\fP, \fI\%garethgreenaway\fP, \fI\%githubcdr\fP,
\fI\%gtmanfred\fP, \fI\%hkrist\fP, \fI\%isbm\fP, \fI\%jbadson\fP, \fI\%jeanpralo\fP, \fI\%jettero\fP, \fI\%jinm\fP, \fI\%joe\-niland\fP,
\fI\%kaszuba\fP, \fI\%lomeroe\fP, \fI\%lorengordon\fP, \fI\%mateiw\fP, \fI\%mcalmer\fP, \fI\%mchugh19\fP, \fI\%meaksh\fP,
\fI\%mirceaulinic\fP, \fI\%mlalpho\fP, \fI\%narendraingale2\fP, \fI\%nmadhok\fP, \fI\%rallytime\fP, \fI\%redbaron4\fP,
\fI\%roaldnefs\fP, \fI\%s0undt3ch\fP, \fI\%skazi0\fP, \fI\%skizunov\fP, \fI\%smarsching\fP, \fI\%sofixa\fP, \fI\%sp1r\fP,
\fI\%sthrasher\fP, \fI\%techhat\fP, \fI\%terminalmage\fP, \fI\%thatch45\fP, \fI\%thor\fP, \fI\%ticosax\fP, \fI\%twangboy\fP,
\fI\%vutny\fP, \fI\%whiteinge\fP, \fI\%zer0def\fP)
.UNINDENT
.SS AIX Support Expanded
.sp
AIX support has been added for the following execution modules:
.INDENT 0.0
.IP \(bu 2
\fI\%user\fP
.IP \(bu 2
\fI\%group\fP
.IP \(bu 2
\fI\%network\fP
.IP \(bu 2
\fI\%status\fP
.IP \(bu 2
\fI\%timezone\fP
.UNINDENT
.sp
Additionally, AIX is now supported in the \fI\%disk.iostat\fP remote\-execution function, and the \fI\%status\fP beacon is now supported.
.SS Minion Data Cache Enhancement
.sp
Memcache is now supported as a data store for the minion data cache.
.sp
Memcache is an additional cache layer that keeps a limited amount of data
fetched from the minion data cache for a limited period of time in memory that
makes cache operations faster. It doesn\(aqt make much sense for the \fBlocalfs\fP
cache driver but helps for more complex drivers like \fBconsul\fP\&.
.sp
For more details see \fBmemcache_expire_seconds\fP and other \fBmemcache_*\fP
options in the master config reverence.
.SS Docker Fixes
.INDENT 0.0
.IP \(bu 2
Docker authentication has been re\-organized. Instead of attempting a login
for each push/pull (which was unnecessary), a new function called
\fBdockerng.login\fP has been added, which
authenticates to the registry and adds the credential token to the
\fB~/.docker/config.json\fP\&. After upgrading, if you have not already performed
a \fBdocker login\fP on the minion using the docker CLI, you will need to run
\fBdockerng.login\fP to login. This only
needs to be done once.
.IP \(bu 2
A bug in resolving the tag name for images in a custom registry (where a
colon can appear in the image name, e.g.
\fBmyregistry.com:5000/image:tagname\fP) has been fixed. In previous releases,
Salt would use the colon to separate the tag name from the image name, and if
there was no colon, the default tag name of \fBlatest\fP would be assumed.
However, this caused custom registry images to be misidentified when no
explicit tag name was passed (e.g. \fBmyregistry.com:5000/image\fP). To work
around this in earlier releases, simply specify the tag name.
.UNINDENT
.SS Salt\-Cloud Fixes
.sp
2016.11.0 added support for templating userdata files for the \fI\%ec2\fP driver, using the \fI\%renderer\fP option from
the master config file. However, as the default renderer first evaluates jinja
templating, followed by loading the data as a YAML dictionary, this results in
unpredictable results when userdata files are comprised of non\-YAML data (which
they generally are).
.sp
2016.11.4 fixes this by only templating the userdata_file when it is explicitly
configured to do so. This is done by adding a new optional parameter to the
cloud profile called \fBuserdata_template\fP\&. This option is used in the same way
as the \fBtemplate\fP argument in \fI\%file.managed\fP states, it is simply set to the desired templating
renderer:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-config:
  # Pass userdata to the instance to be created
  userdata_file: /etc/salt/my\-userdata\-file
  userdata_template: jinja
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If no \fBuserdata_template\fP  option is set in the cloud profile, then
salt\-cloud will check for the presence of the master configuration parameter
\fBuserdata_renderer\fP\&. If this is also not set, then no templating
will be performed on the userdata_file.
.sp
In addition, the other cloud drivers which support setting a \fBuserdata_file\fP
(\fBazurearm\fP, \fBnova\fP, and \fI\%openstack\fP)
have had templating support added to bring them to feature parity with the ec2
driver\(aqs implementation of the \fBuserdata_file\fP option.
.SS Changelog for v2016.11.3..v2016.11.4
.sp
\fIGenerated at: 2018\-05\-27 19:46:47 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#40708\fP: (\fI\%Ch3LL\fP) Add 2016.11.4 Release Note ChangeLog
@ \fI2017\-04\-14 22:12:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
e5cd6086a7 Merge pull request \fI\%#40708\fP from Ch3LL/2016.11.4_release
.IP \(bu 2
d228fb6e02 Add 2016.11.4 Release Note ChangeLog
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40685\fP: (\fI\%Ch3LL\fP) Fix errno code for filecache test for other operating systems.
@ \fI2017\-04\-14 16:54:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
77028a6c4e Merge pull request \fI\%#40685\fP from Ch3LL/fix_mac_file
.IP \(bu 2
9ea6e8b456 remove io and change to EROFS
.IP \(bu 2
688791ff60 remove try\-except and change errno
.IP \(bu 2
e30afc4c01 add exception type
.IP \(bu 2
acf333df08 change errno code for fileclient test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40688\fP: (\fI\%jbadson\fP) Syslog returner does not work with Python 2.6 (refs: \fI\%#40689\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40689\fP: (\fI\%jbadson\fP) Fixes bug that prevents syslog returner from working under Python 2.6
@ \fI2017\-04\-14 10:45:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
bc70772f9d Merge pull request \fI\%#40689\fP from jbadson/fix\-syslog\-returner
.IP \(bu 2
e5a3a7d217 Fixes bug that prevents syslog returner from working under Python 2.6
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40658\fP: (\fI\%sebw\fP) State tomcat.war_deployed regression when WAR filename contains version (refs: \fI\%#40690\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40690\fP: (\fI\%thor\fP) Fixes \fI\%#40658\fP: even clearer and working(!) Tomcat version handling
@ \fI2017\-04\-14 10:44:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
983d35ad38 Merge pull request \fI\%#40690\fP from thor/2016.11\-tomcat
.IP \(bu 2
09145ea1a5 Fixes unindexed strfmt curly braces for python 2.6
.IP \(bu 2
b78fc46b91 Fixes \fI\%#40658\fP: clearer version handling
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40686\fP: (\fI\%twangboy\fP) Fix \(aqsalt\-minion\(aq service for Win 10 Creators Update 1703
@ \fI2017\-04\-13 20:00:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
3cd9a50b22 Merge pull request \fI\%#40686\fP from twangboy/fix_service
.IP \(bu 2
b6ac4aa86d Fix service for win10 update
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40675\fP: (\fI\%gtmanfred\fP) use loader for getting war version
@ \fI2017\-04\-13 19:58:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
ad4d6839fd Merge pull request \fI\%#40675\fP from gtmanfred/2016.11
.IP \(bu 2
a61fc824c4 use loader for war extraction
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38497\fP: (\fI\%chrisLeeTW\fP) local_batch client ignore external auth (refs: \fI\%#40598\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40680\fP: (\fI\%rallytime\fP) Back\-port \fI\%#40598\fP to 2016.11
@ \fI2017\-04\-13 19:58:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40598\fP: (\fI\%mchugh19\fP) Ensure batch uses passed eauth token or credentials (refs: \fI\%#40680\fP)
.IP \(bu 2
7ea526f59e Merge pull request \fI\%#40680\fP from rallytime/bp\-40598
.IP \(bu 2
cc1643eb1f Fix netapi lint
.IP \(bu 2
e790930f5a re\-add batch support to cherrypy saltapi
.IP \(bu 2
6eec04b2db pop out of kwargs
.IP \(bu 2
260dd84758 Create eauth dict for passing into batch class
.IP \(bu 2
5fb8190d44 Ensure batch uses passed eauth token or credentials
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40681\fP: (\fI\%cachedout\fP) Allow status beacon to run on all operating systems
@ \fI2017\-04\-13 19:33:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
db68df23dd Merge pull request \fI\%#40681\fP from cachedout/status_beacon
.IP \(bu 2
ecbb0d186f Allow status beacon to run on all operating systems
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40678\fP: (\fI\%Ch3LL\fP) fix test_fstype test for mac
@ \fI2017\-04\-13 19:20:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
39dd6e284d Merge pull request \fI\%#40678\fP from Ch3LL/fix_mac_fstype
.IP \(bu 2
60724980ec fix test_fstype test for mac
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40665\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35665\fP to 2016.11
@ \fI2017\-04\-12 21:06:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35665\fP: (\fI\%sthrasher\fP) Speed up /jobs for salt\-api when run under cherrypy. (refs: \fI\%#40665\fP)
.IP \(bu 2
6df76f6687 Merge pull request \fI\%#40665\fP from rallytime/bp\-35665
.IP \(bu 2
0f897b2426 Switch from comprehension to logic used in jobs runner. This makes it easier to deal with potential unicode in returns.
.IP \(bu 2
78dd629f09 Fix compat issues with /jobs return values.
.IP \(bu 2
4778bc7365 Speed up /jobs for salt\-api when run under cherrypy.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40666\fP: (\fI\%gtmanfred\fP) make sure userdata is always defined in ec2
@ \fI2017\-04\-12 21:06:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e41a248a5 Merge pull request \fI\%#40666\fP from gtmanfred/userdata
.IP \(bu 2
5e92fd0948 make sure userdata is always defined in ec2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40662\fP: (\fI\%twangboy\fP) Backport msi\-conformant\-version function
@ \fI2017\-04\-12 18:49:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
b245abbea5 Merge pull request \fI\%#40662\fP from twangboy/backport_msi_versioning
.IP \(bu 2
825832812b Backport msi\-conformant\-version function
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39868\fP: (\fI\%amontalban\fP) archive.extracted issue when source_hash_update=True and extracted files does not exist (refs: \fI\%#40551\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40551\fP: (\fI\%terminalmage\fP) Fix four issues in archive.extracted state
@ \fI2017\-04\-12 18:37:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
92b5f03beb Merge pull request \fI\%#40551\fP from terminalmage/issue39868
.IP \(bu 2
a722ca9ccf archive.extracted: also cleanup fileclient\(aqs cached location
.IP \(bu 2
5ea1f607b0 Fix mocking in unit tests
.IP \(bu 2
8dfa51f31f Moar fixes for source_hash_update
.IP \(bu 2
7103707d49 Remove unnecessary versionadded lines
.IP \(bu 2
a717881f53 Just get a hash for the source archive
.IP \(bu 2
9da4eb18bf Check hash of cached source against source_hash before downloading archive
.IP \(bu 2
ad24faa59d Fix three issues in archive.extracted state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40637\fP: (\fI\%twangboy\fP) Add unicode_literals import
@ \fI2017\-04\-12 16:55:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
0638418d22 Merge pull request \fI\%#40637\fP from twangboy/fix_unicode_issues
.IP \(bu 2
021783dbae Add unicode_literals import
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40651\fP: (\fI\%twangboy\fP) Fix status.diskusage for Windows on Py3
@ \fI2017\-04\-12 16:21:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
491661f323 Merge pull request \fI\%#40651\fP from twangboy/fix_diskusage_py3
.IP \(bu 2
7c5079ec91 Correct capitalization problem with api call
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40624\fP: (\fI\%sumeetisp\fP) Issue \- grains.append (refs: \fI\%#40631\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40631\fP: (\fI\%gtmanfred\fP) if grain is defined as None still convert in append
@ \fI2017\-04\-12 16:19:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
3aabd85e53 Merge pull request \fI\%#40631\fP from gtmanfred/grains
.IP \(bu 2
b0bd99c26d add comment and unit test
.IP \(bu 2
b21bc7528f if grain is defined as None still convert in append
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40167\fP: (\fI\%alias454\fP) file.replace diff results output showing additional characters (refs: \fI\%#40629\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40629\fP: (\fI\%aabognah\fP) Fixing issue # 40167
@ \fI2017\-04\-11 22:45:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
3737289bee Merge pull request \fI\%#40629\fP from aabognah/fix\-bug\-40167
.IP \(bu 2
28f7744cb6 Fixing issue # 40167 with file.replace where the diff output does not display correctly.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40646\fP: (\fI\%twangboy\fP) Keep network.py execution module
@ \fI2017\-04\-11 22:03:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
2a22bea290 Merge pull request \fI\%#40646\fP from twangboy/fix_win_network
.IP \(bu 2
0f7a81cd34 Keep network.py execution module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40645\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-04\-11 20:59:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
e1f5a5dfc3 Merge pull request \fI\%#40645\fP from rallytime/merge\-2016.11
.IP \(bu 2
8de6497933 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
2ae9eaa176 Merge pull request \fI\%#40638\fP from rallytime/bp\-40571
.INDENT 2.0
.IP \(bu 2
2d1c4be2df pkgrepo.managed: properly handle comments for debian
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40594\fP: (\fI\%anlutro\fP) salt\-ssh file.recurse adds a lot of unwanted directories (refs: \fI\%#40642\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38458\fP: (\fI\%duk3luk3\fP) salt\-ssh uses sudo to create cache dir, later fails to access it (refs: \fI\%#40442\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40642\fP: (\fI\%DmitryKuzmenko\fP) Correctly resolve relative cache path to absolute.
@ \fI2017\-04\-11 20:43:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40442\fP: (\fI\%gtmanfred\fP) allow file_client to figure out cachedir (refs: \fI\%#40642\fP)
.IP \(bu 2
6c4ae3c914 Merge pull request \fI\%#40642\fP from DSRCorporation/bugs/40594_ssh_cachedir
.IP \(bu 2
055256c518 Correctly resolve relative cache path to absolute.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40075\fP: (\fI\%afletch\fP) salt\-ssh temporary files \- insecure permissions (refs: \fI\%#40609\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40609\fP: (\fI\%gtmanfred\fP) stat_file when keep is set, instead of mirroring all file permissions
@ \fI2017\-04\-11 18:48:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
8492cef7a5 Merge pull request \fI\%#40609\fP from gtmanfred/2016.11
.IP \(bu 2
6e34c2b5e5 stat file when placing it on server instead of caching
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40620\fP: (\fI\%mateiw\fP) SUSE specific changes to salt\-api.service
@ \fI2017\-04\-11 14:45:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
05ac613ecf Merge pull request \fI\%#40620\fP from mateiw/2016.11\-suse\-saltapi\-service
.IP \(bu 2
ee911a74b4 suse specific changes to salt\-api.service
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39463\fP: (\fI\%githubcdr\fP) Transport TCP minions don\(aqt reconnect/recover (refs: \fI\%#40614\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40614\fP: (\fI\%gtmanfred\fP) add retries on authentications of the salt minion reconnecting
@ \fI2017\-04\-10 22:42:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
b0a2414d68 Merge pull request \fI\%#40614\fP from gtmanfred/tcp
.IP \(bu 2
a86b101ae6 add retries on authentications of the salt minion reconnecting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40606\fP: (\fI\%kaszuba\fP) Use correct exec_driver in dockerng.sls module
@ \fI2017\-04\-10 22:25:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
f7e121a9ee Merge pull request \fI\%#40606\fP from kaszuba/fix\-dockerng\-sls
.IP \(bu 2
3a0d61f108 Use correct exec_driver in dockerng.sls module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39863\fP: (\fI\%daswathn\fP) Salt\-Master not responding when the list of minions are high after upgrade to 2016.11.2 (refs: \fI\%#40615\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40615\fP: (\fI\%rallytime\fP) Call out to _pki_minions() once, rather than in a loop in _check_list_minions()
@ \fI2017\-04\-10 22:22:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34920\fP: (\fI\%cachedout\fP) Key cache (refs: \fI\%#40615\fP)
.IP \(bu 2
b6cf948afe Merge pull request \fI\%#40615\fP from rallytime/fix\-39863
.IP \(bu 2
1a9f03ab92 Call out to _pki_minions() once, rather than in a loop in _check_list_minions()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40588\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-04\-07 19:30:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
4fa58be222 Merge pull request \fI\%#40588\fP from rallytime/merge\-2016.11
.IP \(bu 2
5a419b8aae Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
83f6d3d3bb Merge pull request \fI\%#40567\fP from terminalmage/fix\-pillar\-get\-merge\-lists
.INDENT 2.0
.IP \(bu 2
cb4db56eb5 Allow pillar.get to merge list as well as dictionaries
.UNINDENT
.IP \(bu 2
a8304cd5a1 Merge pull request \fI\%#40552\fP from terminalmage/fix\-hash\-type\-refs
.INDENT 2.0
.IP \(bu 2
8c61f333ae Don\(aqt use __opts__.get() for hash_type
.UNINDENT
.IP \(bu 2
705e1d8a08 Merge pull request \fI\%#40562\fP from terminalmage/fix\-get\-client
.INDENT 2.0
.IP \(bu 2
7f1ef72f83 Fix dockerng _get_client() regression
.UNINDENT
.IP \(bu 2
00f8ef0c55 Merge pull request \fI\%#40548\fP from Ch3LL/fix_vultrpy
.INDENT 2.0
.IP \(bu 2
7710355e3a check for salt install fail on vultur test
.IP \(bu 2
aae3d14ea4 fix vultr cloud race condition to match on 0*
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40575\fP: (\fI\%rallytime\fP) Back\-port \fI\%#40559\fP to 2016.11
@ \fI2017\-04\-07 15:42:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40559\fP: (\fI\%jinm\fP) Fix v3 for \fI\%https://github.com/saltstack/salt/issues/38472\fP (refs: \fI\%#40575\fP)
.IP \(bu 2
3d07f637ca Merge pull request \fI\%#40575\fP from rallytime/bp\-40559
.IP \(bu 2
8280e5256e Fix v3 for \fI\%https://github.com/saltstack/salt/issues/38472\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40576\fP: (\fI\%rallytime\fP) Back\-port \fI\%#40573\fP to 2016.11
@ \fI2017\-04\-07 15:20:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40573\fP: (\fI\%ardakuyumcu\fP) Fix typo in IAM state for managed policies (refs: \fI\%#40576\fP)
.IP \(bu 2
9041ca2ba5 Merge pull request \fI\%#40576\fP from rallytime/bp\-40573
.IP \(bu 2
12180808ee Fix typo in IAM state for managed policies
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40563\fP: (\fI\%terminalmage\fP) Merge\-forward 2016.3 \-> 2016.11
@ \fI2017\-04\-07 15:08:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40562\fP: (\fI\%terminalmage\fP) Fix dockerng _get_client() regression (refs: \fI\%#40563\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40481\fP: (\fI\%terminalmage\fP) Backport auth and custom registry fixes from \fI\%#40480\fP to 2016.3 branch (refs: \fI\%#40563\fP, \fI\%#40562\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40480\fP: (\fI\%terminalmage\fP) Improved Docker auth handling and other misc. Docker improvements (refs: \fI\%#40481\fP)
.IP \(bu 2
f8bc423ef9 Merge pull request \fI\%#40563\fP from terminalmage/merge\-2016.3\-2016.11
.IP \(bu 2
0c608d7417 Add client_args_mock back to test
.IP \(bu 2
a7a78da984 remove unused imports
.IP \(bu 2
a6d68f50fe Merge remote\-tracking branch \(aqupstream/2016.3\(aq into merge\-2016.3\-2016.11
.INDENT 2.0
.IP \(bu 2
0918311330 Don\(aqt mark files that already were deleted as errors
.IP \(bu 2
51d88a16c8 Merge branch \(aqzer0def\-fix\-31363\(aq into 2016.3
.INDENT 2.0
.IP \(bu 2
7f3cbd5cf9 Merge branch \(aqfix\-31363\(aq of \fI\%https://github.com/zer0def/salt\fP into zer0def\-fix\-31363
.IP \(bu 2
3c750c2b24 Changed rm_rf\(aqs argument to actually remove intended file. (refs \fI\%#31363\fP)
.IP \(bu 2
9ed85f3c59 Remove directory content instead of directory itself when using \fIforce_clone\fP in \fIgit.latest\fP state. (refs \fI\%#31363\fP)
.UNINDENT
.IP \(bu 2
cfba4cb422 Merge pull request \fI\%#40534\fP from terminalmage/issue39892
.INDENT 2.0
.IP \(bu 2
ad88c58a09 Check master\(aqs ssh_minion_opts for fileserver/pillar values and ignore them
.UNINDENT
.IP \(bu 2
8da27c9e1d Merge pull request \fI\%#40306\fP from terminalmage/issue40279
.INDENT 2.0
.IP \(bu 2
57ace1f336 Merge branch \(aqissue40279\(aq of \fI\%https://github.com/terminalmage/salt\fP into issue40279
.INDENT 2.0
.IP \(bu 2
8bcdf1a761 Remove unused import for lint
.UNINDENT
.IP \(bu 2
808ad76419 systemd.py: when getting all services, don\(aqt repeat gathering of systemd services
.IP \(bu 2
2d219af67a Don\(aqt use context caching for gathering systemd services
.UNINDENT
.IP \(bu 2
97caac4c0a Merge pull request \fI\%#40481\fP from terminalmage/docker\-auth\-handling\-2016.3
.INDENT 2.0
.IP \(bu 2
dcef1e0d4b Make sure we keep the cached client when clearing context
.IP \(bu 2
1e2a04cfc5 Backport auth and custom registry fixes from \fI\%#40480\fP to 2016.3 branch
.UNINDENT
.IP \(bu 2
e62603d5eb Merge pull request \fI\%#40505\fP from gtmanfred/2016.3
.INDENT 2.0
.IP \(bu 2
6e2f9080ca update docs for logging handlers
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39778\fP: (\fI\%Talkless\fP) pkgrepo.managed state always report changes with test=True on APT system (refs: \fI\%#40571\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40571\fP: (\fI\%terminalmage\fP) pkgrepo.managed: properly handle comments for debian (refs: \fI\%#40638\fP)
@ \fI2017\-04\-06 21:55:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd757fffa3 Merge pull request \fI\%#40571\fP from terminalmage/issue39778
.IP \(bu 2
191610482d pkgrepo.managed: properly handle comments for debian
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40278\fP: (\fI\%UtahDave\fP) cloud.action giving errors on 2016.11.1 (refs: \fI\%#40572\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40572\fP: (\fI\%rallytime\fP) Clean out kwargs dict in cloud.action before calling cloud driver function
@ \fI2017\-04\-06 21:53:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
b1698e830e Merge pull request \fI\%#40572\fP from rallytime/fix\-40278
.IP \(bu 2
c978486452 Clean out kwargs dict in cloud.action before calling cloud driver function
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39842\fP: (\fI\%smarsching\fP) File module removes trailing newline on Windows (refs: \fI\%#39882\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39882\fP: (\fI\%smarsching\fP) Fix handling of trailing newlines on Windows
@ \fI2017\-04\-06 21:12:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
62d8ad2b4b Merge pull request \fI\%#39882\fP from smarsching/issue\-39842
.IP \(bu 2
d485d1af44 Fix context for _splitlines_preserving_trailing_newline.
.IP \(bu 2
76cb7bf612 Fix trailing newlines on Windows (\fI\%#39842\fP).
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40451\fP: (\fI\%isbm\fP) Fileclient testcase (2016.11)
@ \fI2017\-04\-06 19:53:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
ae13de622a Merge pull request \fI\%#40451\fP from isbm/isbm\-fileclient\-testcase\-2016.11
.IP \(bu 2
74c65557dd Add space before in\-lint comment for lint
.IP \(bu 2
35fcb8b52d Fix race condition on cache directory creation
.IP \(bu 2
aba94495a5 Lintfix (Py3 code compat)
.IP \(bu 2
9f9dc6e4e7 Add unit test case for fileclient
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40084\fP: (\fI\%podstava\fP) profile fields in azurearm salt\-cloud need to be actualized to sources (refs: \fI\%#40564\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40564\fP: (\fI\%techhat\fP) Update Azure ARM docs
@ \fI2017\-04\-06 18:17:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
74366c57a4 Merge pull request \fI\%#40564\fP from techhat/azuredocs
.IP \(bu 2
08d071bc68 Update Azure ARM docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40005\fP: (\fI\%vutny\fP) \fIssh_known_hosts.present\fP does not support SHA256 key fingerprints (refs: \fI\%#40543\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40543\fP: (\fI\%rallytime\fP) Add the \(dqfingerprint_hash_type\(dq option to ssh state and module
@ \fI2017\-04\-05 21:21:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
cb9dcb1e1b Merge pull request \fI\%#40543\fP from rallytime/fix\-40005
.IP \(bu 2
1ef81e6a55 Add the \(dqfingerprint_hash_type\(dq option to ssh state and module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40540\fP: (\fI\%DmitryKuzmenko\fP) A quick fix for Cache has no \(aqlist\(aq attribute.
@ \fI2017\-04\-05 18:50:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40494\fP: (\fI\%rallytime\fP) [develop] Merge forward from 2016.11 to develop (refs: \fI\%#40540\fP)
.IP \(bu 2
3f0695575a Merge pull request \fI\%#40540\fP from DSRCorporation/bugs/40494_merge_forward_cache_list_fix
.IP \(bu 2
c0fd5634cf A quick fix for Cache has no \(aqlist\(aq attribute.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32662\fP: (\fI\%anlutro\fP) salt\-cloud: allow templating of EC2 userdata, similar to deploy script (refs: \fI\%#32698\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40464\fP: (\fI\%terminalmage\fP) salt\-cloud: Do not pass userdata_file through yaml renderer
@ \fI2017\-04\-05 17:32:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32698\fP: (\fI\%techhat\fP) Allow EC2 userdata to be templated (refs: \fI\%#40464\fP)
.IP \(bu 2
28fc048030 Merge pull request \fI\%#40464\fP from terminalmage/userdata\-renderer
.IP \(bu 2
84ee693006 Nova and openstack don\(aqt accept base64\-encoded userdata
.IP \(bu 2
73f4c43e2a Allow for userdata_template to be disabled in a cloud_profile
.IP \(bu 2
78b4798b1b Update compile_template test to use StringIO
.IP \(bu 2
5f7c5613ce Properly handle renderers which return StringIO objects
.IP \(bu 2
d551b0d857 Bring in salt.utils.stringio from develop branch
.IP \(bu 2
6a6ef0adf8 Move userdata templating to salt.utils.cloud
.IP \(bu 2
b440d0c679 Update 2016.11.4 release notes for userdata_renderer \-> userdata_template
.IP \(bu 2
a6183d93d3 Preserve windows newlines in salt.template.compile_template()
.IP \(bu 2
04f02df5fe Try to read compiled template as StringIO
.IP \(bu 2
79cc253bbf Only template the userdata_file if explicitly configured to do so
.IP \(bu 2
b580654f85 Update cloud docs to reflect userdata_renderer \-> userdata_template
.IP \(bu 2
a6064fb2e4 Rename userdata_renderer \-> userdata_template in master config docs
.IP \(bu 2
50f2b2831f Remove userdata_renderer value
.IP \(bu 2
cc2186f35a Add templating support for other cloud drivers that support userdata_file
.IP \(bu 2
be8d34c59b ec2: Add support for using userdata_renderer to template userdata_file
.IP \(bu 2
eddbd41265 Openstack did not have templating support for userdata_file before 2016.11.4
.IP \(bu 2
a85a416c72 Add userdata_renderer fix info to 2016.11.4 release notes
.IP \(bu 2
111188742a Add documentation for userdata_renderer
.IP \(bu 2
9ee2dcfc2d Add userdata_renderer master config param
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40530\fP: (\fI\%dmurphy18\fP) Update release information for 2016.11.4 for additional AIX support
@ \fI2017\-04\-05 16:20:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
990bde4c07 Merge pull request \fI\%#40530\fP from dmurphy18/aix_docupd
.IP \(bu 2
fd93caf206 Added further support for functionality on AIX for 2016.11.4
.IP \(bu 2
17b58917f2 Update release information for new AIX support
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40528\fP: (\fI\%dmurphy18\fP) Allow for nightly build designations in Salt versions
@ \fI2017\-04\-04 20:34:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
4d932691f1 Merge pull request \fI\%#40528\fP from dmurphy18/salt_nightlybuild
.IP \(bu 2
d62a119fc1 Allow for nightly build designations in Salt versions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37699\fP: (\fI\%gstachowiak\fP) Artifactory state. Incorrect timeout error reporting. (refs: \fI\%#40465\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40465\fP: (\fI\%rallytime\fP) Artifactory Execution & State Module: Fixup Error Handling
@ \fI2017\-04\-04 20:12:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
0ed385210f Merge pull request \fI\%#40465\fP from rallytime/fix\-37699
.IP \(bu 2
8f084f7056 Update unit test to look for actual string comment
.IP \(bu 2
ef664b46ae Artifactory State: Only wrap main function call to module in try/except and wrap exc comment in str()
.IP \(bu 2
f1015e3900 Artifactory Module: catch URLErrors as well as HTTPErrors
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39275\fP: (\fI\%yhekma\fP) Cache backend gets hit a \fIlot\fP (refs: \fI\%#40497\fP, \fI\%#40429\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40497\fP: (\fI\%DmitryKuzmenko\fP) Memcache documentation and minor updates.
@ \fI2017\-04\-04 19:55:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40429\fP: (\fI\%DmitryKuzmenko\fP) MemCache \- a minion data cache booster. (refs: \fI\%#40497\fP, \fI\%#40468\fP)
.IP \(bu 2
7a04ed2439 Merge pull request \fI\%#40497\fP from DSRCorporation/features/39275_memcache
.IP \(bu 2
82c45b1a52 Memcache documentation and minor updates.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38683\fP: (\fI\%gstachowiak\fP) require/order/failhard combination error (refs: \fI\%#40504\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40504\fP: (\fI\%rallytime\fP) Group checks for failhard setting in () in state.check_failhard function
@ \fI2017\-04\-04 19:53:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
d654de52ed Merge pull request \fI\%#40504\fP from rallytime/fix\-38683
.IP \(bu 2
ede4c28887 Group checks for failhard setting in () in state.check_failhard function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40503\fP: (\fI\%thatch45\fP) first pass at adding support for pycryptodome installed as
@ \fI2017\-04\-04 19:39:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
4d5d7d9712 Merge pull request \fI\%#40503\fP from thatch45/2016.11
.IP \(bu 2
e21fd54d1b fix lint on the lint ignores...
.IP \(bu 2
60113248b1 pycryptodome adds RSA to the key header which the openssl
.IP \(bu 2
206dec63ff fix the cryptodome version lookup for the versions report
.IP \(bu 2
d3b77092b5 good catch
.IP \(bu 2
31c6a10d1b first pass at adding support for pycryptodome installed as
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40525\fP: (\fI\%dmurphy18\fP) Add support for disk.iostat on AIX
@ \fI2017\-04\-04 19:31:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
0dd92c63ea Merge pull request \fI\%#40525\fP from dmurphy18/aix_dskiostat
.IP \(bu 2
712537272b Added support on AIX for disk.iostat
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40496\fP: (\fI\%rallytime\fP) Back\-port \fI\%#40415\fP to 2016.11
@ \fI2017\-04\-04 17:19:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40415\fP: (\fI\%defanator\fP) Fix boto_vpc.create_route() to work with interface_id (refs: \fI\%#40496\fP)
.IP \(bu 2
a6291b17c1 Merge pull request \fI\%#40496\fP from rallytime/bp\-40415
.IP \(bu 2
f8b3006898 Fix boto_vpc.create_route() to work with interface_id
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39275\fP: (\fI\%yhekma\fP) Cache backend gets hit a \fIlot\fP (refs: \fI\%#40497\fP, \fI\%#40429\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40468\fP: (\fI\%techhat\fP) Add __func_alias__ back in
@ \fI2017\-04\-04 17:02:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40429\fP: (\fI\%DmitryKuzmenko\fP) MemCache \- a minion data cache booster. (refs: \fI\%#40497\fP, \fI\%#40468\fP)
.IP \(bu 2
3eb8e0baf1 Merge pull request \fI\%#40468\fP from techhat/cachealias
.IP \(bu 2
6ec0baa9a0 Swap around aliases
.IP \(bu 2
76e54a2900 Add __func_alias__ back in
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29104\fP: (\fI\%adithep\fP) Merging Order warning (refs: \fI\%#39109\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39109\fP: (\fI\%bdrung\fP) Fix top_file_merging_strategy warning if env_order is set
@ \fI2017\-04\-04 14:20:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
8c0befaa8b Merge pull request \fI\%#39109\fP from bdrung/fix\-merge\-order\-warning
.IP \(bu 2
fbf8fcfa98 Simplify _get_envs() by using list comprehensions
.IP \(bu 2
74a3b066ea Fix top_file_merging_strategy warning if env_order is set
.IP \(bu 2
ec219b5f42 Remove duplicate client_envs variable definitions
.IP \(bu 2
6279f7c120 fix do to pre correct on python randome function
.IP \(bu 2
66b9515af7 Fix up the doc for failover clarity
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40495\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-04\-03 18:36:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
02a1f642ab Merge pull request \fI\%#40495\fP from rallytime/merge\-2016.11
.IP \(bu 2
8111909bb1 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
3d45a004b0 Merge pull request \fI\%#40427\fP from terminalmage/clarify\-master\-tops\-docs
.INDENT 2.0
.IP \(bu 2
bda781d8f9 Grammar fix
.IP \(bu 2
0d7b0c4ef0 Improve the master_tops documentation
.IP \(bu 2
d27340a9f2 Add saltutil.sync_tops runner func
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40466\fP: (\fI\%dmurphy18\fP) Support for execution module status on AIX
@ \fI2017\-04\-01 00:28:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
ac82972cb3 Merge pull request \fI\%#40466\fP from dmurphy18/aix_status
.IP \(bu 2
7c0b30d9a4 Support for AIX
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39275\fP: (\fI\%yhekma\fP) Cache backend gets hit a \fIlot\fP (refs: \fI\%#40497\fP, \fI\%#40429\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40429\fP: (\fI\%DmitryKuzmenko\fP) MemCache \- a minion data cache booster. (refs: \fI\%#40497\fP, \fI\%#40468\fP)
@ \fI2017\-03\-31 20:21:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
fdb0250c95 Merge pull request \fI\%#40429\fP from DSRCorporation/features/39275_memcache
.IP \(bu 2
4475d1757d In\-memory minion data cache.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38458\fP: (\fI\%duk3luk3\fP) salt\-ssh uses sudo to create cache dir, later fails to access it (refs: \fI\%#40442\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40442\fP: (\fI\%gtmanfred\fP) allow file_client to figure out cachedir (refs: \fI\%#40642\fP)
@ \fI2017\-03\-31 20:14:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
31d4e6949c Merge pull request \fI\%#40442\fP from gtmanfred/salt\-ssh
.IP \(bu 2
8367735063 allow file_client to figure out cachedir
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40456\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-31 17:51:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
0cfcd188a9 Merge pull request \fI\%#40456\fP from rallytime/merge\-2016.11
.IP \(bu 2
0da4c46b68 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
c26f4cc76c Merge pull request \fI\%#40371\fP from terminalmage/pr\-40344
.INDENT 2.0
.IP \(bu 2
a8bcaa73d7 Force use of posixpath when joining salt fileserver paths in gitfs
.IP \(bu 2
cafa08d8e0 Add ability for salt.utils.path_join to force the use of posixpath
.UNINDENT
.IP \(bu 2
df9df82959 Merge pull request \fI\%#40379\fP from rallytime/tests\-for\-39855
.INDENT 2.0
.IP \(bu 2
96259d6c63 Lint fix
.IP \(bu 2
4f7ac1431e Create a unit test for the _replace_auth_key function in the ssh module
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40443\fP: (\fI\%gtmanfred\fP) prepend ssh_log_file with root_dir
@ \fI2017\-03\-31 09:23:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
8617be9c6d Merge pull request \fI\%#40443\fP from gtmanfred/sshlog
.IP \(bu 2
7f6046deec prepend ssh_log_file with root_dir
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40376\fP: (\fI\%nmadhok\fP) Backporting changes in vmware cloud driver from develop branch to 2016.11 branch
@ \fI2017\-03\-30 22:35:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
132d8b7b88 Merge pull request \fI\%#40376\fP from nmadhok/2016.11
.IP \(bu 2
dd62310941 Adding unit tests for vmware_test
.IP \(bu 2
36edf0af64 Add additional VMware related exceptions
.IP \(bu 2
034ef30f7c Remove old vmware unit tests
.IP \(bu 2
7c144888da Backporting changes in vmware cloud driver from develop branch to 2016.11 branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39692\fP: (\fI\%djsly\fP) tuned module and state are broken on 7.3 families.  (refs: \fI\%#40387\fP, \fI\%#39719\fP, \fI\%#39768\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40387\fP: (\fI\%redbaron4\fP) More complete fix for 39692
@ \fI2017\-03\-30 22:29:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
dfaa670b66 Merge pull request \fI\%#40387\fP from redbaron4/fix\-39692
.IP \(bu 2
77a40a0c44 Lint fixes
.IP \(bu 2
8c1adfafd5 More complete fix for 39692
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#7287\fP: (\fI\%dragozov\fP) django.loaddata treats fixture list as arguments and prepends \(dq\-\-\(dq for each (refs: \fI\%#40404\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40404\fP: (\fI\%roaldnefs\fP) Fix for fixtures in the djangomod module
@ \fI2017\-03\-30 22:26:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
313d21626f Merge pull request \fI\%#40404\fP from roaldnefs/fix\-djangomod\-loaddata
.IP \(bu 2
92285cb045 Fix for fixtures in the djangomod module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40416\fP: (\fI\%lorengordon\fP) Adds some missing file functions on Windows
@ \fI2017\-03\-30 22:22:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
5379899442 Merge pull request \fI\%#40416\fP from lorengordon/win\-file\-funcs
.IP \(bu 2
8edaf25e10 Adds some missing file functions on Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40417\fP: (\fI\%lorengordon\fP) \fItemp.file\fP does not close the file handle (refs: \fI\%#40418\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40418\fP: (\fI\%lorengordon\fP) Closes handle to temporary file before returning the path
@ \fI2017\-03\-30 22:22:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f5d6b88f9 Merge pull request \fI\%#40418\fP from lorengordon/close\-temp\-file
.IP \(bu 2
7baf2809cf Closes handle to temporary file before returning the path
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40430\fP: (\fI\%twangboy\fP) Fix logic for __virtual__ in win_dsc and win_psget
@ \fI2017\-03\-30 22:06:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
5c78d55eab Merge pull request \fI\%#40430\fP from twangboy/fix_virtual
.IP \(bu 2
08e95ce4f0 Add logging on __virtual__ failures
.IP \(bu 2
43ecb1a597 Fix logic for __virtual__
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40431\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-30 21:37:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
b855f29928 Merge pull request \fI\%#40431\fP from rallytime/merge\-2016.11
.IP \(bu 2
d5576d75e7 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
b6770fd81f Merge pull request \fI\%#40407\fP from aesdana/fix_rabbitmq_version_check
.INDENT 2.0
.IP \(bu 2
4c0763fa2f Added split to cut off debian_revision from rabbitmq\-server version Fixes \fI\%#40396\fP
.UNINDENT
.IP \(bu 2
d4fb45d9f8 Merge pull request \fI\%#40424\fP from terminalmage/fix\-open\-filehandle
.INDENT 2.0
.IP \(bu 2
66251263cf Fix open filehandles
.UNINDENT
.IP \(bu 2
8708096365 Merge pull request \fI\%#40399\fP from terminalmage/docker\-py_version
.INDENT 2.0
.IP \(bu 2
14c6575655 Add docker\-py version to the versions report
.UNINDENT
.IP \(bu 2
ff1266b3a6 Merge pull request \fI\%#40391\fP from Ch3LL/2016.3.7_release_notes
.INDENT 2.0
.IP \(bu 2
f532ec5288 initial 2016.3.7 release notes
.UNINDENT
.IP \(bu 2
96bf9427b0 Merge pull request \fI\%#40368\fP from Ch3LL/bump_version_3
.INDENT 2.0
.IP \(bu 2
a02fa7dd1f [2016.3] Bump previous version to 2016.3.6
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40401\fP: (\fI\%roaldnefs\fP) fix Ubuntu notation in docs/faq.rst
@ \fI2017\-03\-29 20:28:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
7d900d31ea Merge pull request \fI\%#40401\fP from roaldnefs/fix\-doc\-faq
.IP \(bu 2
21f161fecc fix Ubuntu notation in docs/faq.rst
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29028\fP: (\fI\%kevins9\fP) state.sls fails to render state with pillar data: Jinja variable \(aqdict object\(aq has no attribute (refs: \fI\%#37795\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40390\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37795\fP to 2016.11
@ \fI2017\-03\-29 19:05:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37795\fP: (\fI\%jettero\fP) please tell me where is the “error: \(aqdict\(aq object has no …” (refs: \fI\%#40390\fP)
.IP \(bu 2
70a3f963ec Merge pull request \fI\%#40390\fP from rallytime/bp\-37795
.IP \(bu 2
1ba15577bd Pylint fix
.IP \(bu 2
ec65924659 please tell me where is the \(dqerror: \(aqdict\(aq object has no attribute \(aqseek\(aq\(dq ??
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40395\fP: (\fI\%rallytime\fP) Handle AttributeError for dockerng_mod.docker attempt fails and docker is installed
@ \fI2017\-03\-29 17:47:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
f8fbfff7dc Merge pull request \fI\%#40395\fP from rallytime/catch\-attribute\-error\-docker\-test
.IP \(bu 2
99c8dcc18e Handle AttributeError for dockerng_mod.docker attempt fails and docker is installed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40362\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-28 22:50:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
d7d3d68035 Merge pull request \fI\%#40362\fP from rallytime/merge\-2016.11
.IP \(bu 2
4f1543c2a1 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
1381f97292 Merge pull request \fI\%#40264\fP from meaksh/2016.3\-gather_job_timeout\-fix
.INDENT 2.0
.IP \(bu 2
68dccae5b4 Makes sure \(dqgather_job_timeout\(dq is an integer
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40372\fP: (\fI\%zer0def\fP) Fixes related to cache directory argument changes in pip>=6.
@ \fI2017\-03\-28 22:48:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
2febd05896 Merge pull request \fI\%#40372\fP from zer0def/pip\-cache\-fixes
.IP \(bu 2
d68067f1d7 Merge remote\-tracking branch \(aqmain/2016.11\(aq into pip\-cache\-fixes
.IP \(bu 2
4f23a23ca8 Fixed the \fItest_install_download_cache_argument_in_resulting_command\fP to accommodate introduced cache directory argument fixes and renamed it to \fItest_install_download_cache_dir_arguments_in_resulting_command\fP\&.
.IP \(bu 2
9d0f94eeba Fixed unnecessary API changes introduced with suggested changes.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40369\fP: (\fI\%Ch3LL\fP) [2016.11] Bump previous version to 2016.3.6
@ \fI2017\-03\-28 18:50:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
6162698c87 Merge pull request \fI\%#40369\fP from Ch3LL/bump_version_11
.IP \(bu 2
7597d96edb [2016.11] Bump previous version to 2016.3.6
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40322\fP: (\fI\%Whissi\fP) ssh_auth.absent: Wrong comment when test=True (refs: \fI\%#40333\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#40321\fP: (\fI\%Whissi\fP) state.alternatives: Wrong comment when test=True (refs: \fI\%#40333\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40333\fP: (\fI\%gtmanfred\fP) fix some test=True comments
@ \fI2017\-03\-28 16:11:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d2cb5b837 Merge pull request \fI\%#40333\fP from gtmanfred/2016.11
.IP \(bu 2
5596620dfb fix some test=True comments
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40347\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-28 02:39:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb37f133fc Merge pull request \fI\%#40347\fP from rallytime/merge\-2016.11
.IP \(bu 2
e77e86db3a Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
17ab1da0ab Merge pull request \fI\%#40345\fP from twangboy/fix_osx_build
.INDENT 2.0
.IP \(bu 2
3207d670c5 Fix osx build
.UNINDENT
.IP \(bu 2
7ab10491ab Merge pull request \fI\%#40338\fP from UtahDave/fix_cherrypy_ssl_error_link
.INDENT 2.0
.IP \(bu 2
280b501950 Upstream cherrypy moved to Github from Bitbucket
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#40332\fP: (\fI\%zer0def\fP) Fixes related to cache directory argument changes in pip>=6. (refs: \fI\%#40346\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40346\fP: (\fI\%cachedout\fP) Revert \(dqFixes related to cache directory argument changes in pip>=6.\(dq
@ \fI2017\-03\-27 23:17:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
a572b46183 Merge pull request \fI\%#40346\fP from saltstack/revert\-40332\-pip\-cache\-fixes
.IP \(bu 2
b4753d1a5a Revert \(dqFixes related to cache directory argument changes in pip>=6.\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40296\fP: (\fI\%L4rS6\fP) Wrong documentation in mount.mounted (refs: \fI\%#40326\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40326\fP: (\fI\%L4rS6\fP) Update mount state documentation (Fixes: \fI\%#40296\fP)
@ \fI2017\-03\-27 23:15:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
a91bab867e Merge pull request \fI\%#40326\fP from L4rS6/update\-mount\-state\-doc
.IP \(bu 2
a717c527a1 Update mount state documentation (Fixes: \fI\%#40296\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40328\fP: (\fI\%L4rS6\fP) Fixes wrong compared extra_mount_ignore_fs_keys key.
@ \fI2017\-03\-27 23:14:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca2980cfb0 Merge pull request \fI\%#40328\fP from L4rS6/fix\-mount\-state\-extra\-ignore\-fs\-key
.IP \(bu 2
f0f68b9033 Fixes wrong compared extra_mount_ignore_fs_keys key.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40329\fP: (\fI\%isbm\fP) Merge tops (backport)
@ \fI2017\-03\-27 23:13:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a6c5d0297 Merge pull request \fI\%#40329\fP from isbm/isbm\-merge\-tops\-201611
.IP \(bu 2
a762c9edda Merge output from master_tops
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40285\fP: (\fI\%rallytime\fP) Dockerng unit tests fixes: isolate global variables
@ \fI2017\-03\-27 23:05:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
2b7b2f1cb4 Merge pull request \fI\%#40285\fP from rallytime/docker\-test\-fixes
.IP \(bu 2
0f263a52e0 Mock out the get_client_args mocks in the dockerng module tests more aggressively
.IP \(bu 2
f1352fe253 Add one more dockerng.version mock that was missed previously
.IP \(bu 2
0d31d2c4d1 Add a couple more patches for docker.version information
.IP \(bu 2
a9c5eebaf0 Clean up dockerng unit tests to avoid global variables and fixup some patching
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40341\fP: (\fI\%twangboy\fP) Fix service.create, fix docs
@ \fI2017\-03\-27 21:46:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
01efc842c1 Merge pull request \fI\%#40341\fP from twangboy/fix_win_service
.IP \(bu 2
6736457ec8 Docs for create
.IP \(bu 2
652cf08f8a Fix service.create, fix docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40332\fP: (\fI\%zer0def\fP) Fixes related to cache directory argument changes in pip>=6.
@ \fI2017\-03\-27 21:01:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
8eabcca6dc Merge pull request \fI\%#40332\fP from zer0def/pip\-cache\-fixes
.IP \(bu 2
7976840100 Fixes related to cache directory changes in pip>=6.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40337\fP: (\fI\%Ch3LL\fP) Add archive.extracted with use_cmd_unzip argument
@ \fI2017\-03\-27 21:00:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
ceba1b9bc6 Merge pull request \fI\%#40337\fP from Ch3LL/add_unzip_test
.IP \(bu 2
8b21b4c8bb add use_cmd_unzip test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40312\fP: (\fI\%rallytime\fP) Update minion data cache documentation
@ \fI2017\-03\-27 20:56:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
a192597ec2 Merge pull request \fI\%#40312\fP from rallytime/cache\-docs
.IP \(bu 2
5363e0b58b Update minion data cache documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40315\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-27 15:11:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
7f16754619 Merge pull request \fI\%#40315\fP from rallytime/merge\-2016.11
.IP \(bu 2
c65d602f60 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
7c21153d3a Merge pull request \fI\%#40300\fP from meaksh/2016.3\-adding\-timeouts\-parameters\-to\-cmd_batch
.INDENT 2.0
.IP \(bu 2
9174e6f281 Fixes testing opts dict for batch unit tests
.IP \(bu 2
b1de79abcf Adds custom \(aqtimeout\(aq and \(aqgather_job_timeout\(aq to \(aqlocal_batch\(aq client
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40313\fP: (\fI\%techhat\fP) Add minimum and maximum to calls to calc
@ \fI2017\-03\-27 14:54:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
a9a73bf8dc Merge pull request \fI\%#40313\fP from techhat/calcref
.IP \(bu 2
7106a86258 Use named kwargs
.IP \(bu 2
822f3b81c3 Add minimum and maximum to calls to calc
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40247\fP: (\fI\%eldadru\fP) boto_rds.delete wait_for_deletion checks rds status incorrectly and always loop until timeout (refs: \fI\%#40277\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40277\fP: (\fI\%eldadru\fP) Fixing boto_rds.py delete() wait_for_deletion,  if statement was inco…
@ \fI2017\-03\-24 22:29:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d0762deca Merge pull request \fI\%#40277\fP from eldadru/Fix\-40247\-boto_rds\-delete\-wait\-for\-deletion\-failure
.IP \(bu 2
3c15a32764 Fixing boto_rds.py delete() wait_for_deletion,  if statement was incorrectly checking the return value of boto_rds.py exists() method.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40280\fP: (\fI\%bewing\fP) Clean up temporary file in net.load_template
@ \fI2017\-03\-24 22:27:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40273\fP: (\fI\%bewing\fP) Clean up temporary file in net.load_template (refs: \fI\%#40280\fP)
.IP \(bu 2
6c29c81d01 Merge pull request \fI\%#40280\fP from bewing/bp_40273
.IP \(bu 2
f028e939f5 Clean up temporary file in net.load_template
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37972\fP: (\fI\%ebauman\fP) salt\-run execution for master with no AAAA record adds significant execution time (refs: \fI\%#40310\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40310\fP: (\fI\%gtmanfred\fP) add warning when no host/dns record is found for fqdn_ip
@ \fI2017\-03\-24 21:55:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
839b620f32 Merge pull request \fI\%#40310\fP from gtmanfred/2016.11
.IP \(bu 2
cff027ddc6 add warning when no host/dns record is found for fqdn
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40288\fP: (\fI\%dmurphy18\fP) Execution module network support for AIX
@ \fI2017\-03\-24 20:10:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
eb86d55478 Merge pull request \fI\%#40288\fP from dmurphy18/aix_network
.IP \(bu 2
b53a95dab1 Further update to us in  similar to review comments
.IP \(bu 2
59c0bdc14d Updated for review comments
.IP \(bu 2
031c9457ba Execution module network support for AIX
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40308\fP: (\fI\%rallytime\fP) Back\-port \fI\%#38835\fP to 2016.11
@ \fI2017\-03\-24 19:00:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38835\fP: (\fI\%UtahDave\fP) Cache docs (refs: \fI\%#40308\fP)
.IP \(bu 2
4928026253 Merge pull request \fI\%#40308\fP from rallytime/bp\-38835
.IP \(bu 2
3ba50d3c52 add info about what is cached
.IP \(bu 2
77e8f6aff9 fix config example
.IP \(bu 2
61f2fa9339 Add documentation for the Minion data cache
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40287\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-24 16:50:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
12a9fc43c9 Merge pull request \fI\%#40287\fP from rallytime/merge\-2016.11
.IP \(bu 2
77415369cc Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
0e2d52c3ea Merge pull request \fI\%#40260\fP from lubyou/fix\-join_domain
.INDENT 2.0
.IP \(bu 2
1cb15d1ea8 use win32api.FormatMessage() to get the error message for the system code
.UNINDENT
.IP \(bu 2
0c62bb37d3 Merge pull request \fI\%#40275\fP from UtahDave/2016.3local
.INDENT 2.0
.IP \(bu 2
9f0c9802c2 remove reference to auth_minion.
.UNINDENT
.IP \(bu 2
57ce474d73 Merge pull request \fI\%#40265\fP from terminalmage/issue40219
.INDENT 2.0
.IP \(bu 2
1a731e0216 Pop off the version when aggregating pkg states
.IP \(bu 2
0055fda3e9 Properly aggregate version when passed with name
.IP \(bu 2
62d76f50fc Don\(aqt aggregate both name/pkgs and sources in pkg states
.UNINDENT
.IP \(bu 2
b208630d85 Merge pull request \fI\%#40201\fP from sergeizv/cloud\-roster\-fixes\-2016.3
.INDENT 2.0
.IP \(bu 2
d87b377ad2 cloud roster: Don\(aqt stop if minion wasn\(aqt found in cloud cache index
.IP \(bu 2
a6865e0283 cloud roster: Check whether show_instance succeeded on node
.IP \(bu 2
1b45c8e8c2 cloud roster: Check provider and profile configs for ssh_username
.IP \(bu 2
a18250b2e4 cloud roster: Return proper target name
.IP \(bu 2
637930b2b3 cloud roster: Fix extracting instance\(aqs info
.IP \(bu 2
dd1d3aac74 cloud roster: Work with custom conf dir
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40250\fP: (\fI\%techhat\fP) Add wait_for_fun() to set_tags()
@ \fI2017\-03\-23 16:42:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40225\fP: (\fI\%techhat\fP) Add wait_for_fun() to set_tags() (refs: \fI\%#40250\fP)
.IP \(bu 2
b7f9100e6d Merge pull request \fI\%#40250\fP from techhat/settags
.IP \(bu 2
baff7a046d Add wait_for_fun() to set_tags()
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39976\fP: (\fI\%peterhirn\fP) win_lgpo missing policies, eg. \fIPrevent the usage of OneDrive for file storage\fP (refs: \fI\%#40255\fP, \fI\%#40253\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40255\fP: (\fI\%lomeroe\fP) backport \fI\%#40253\fP
@ \fI2017\-03\-23 16:36:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40253\fP: (\fI\%lomeroe\fP) correct method of getting \(aqtext\(aq of the XML object to compare to the … (refs: \fI\%#40255\fP)
.IP \(bu 2
904e144ae4 Merge pull request \fI\%#40255\fP from lomeroe/fix_39976_2016.11
.IP \(bu 2
0e9f5820cc backport \fI\%#40253\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40240\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-23 14:14:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40237\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11 (refs: \fI\%#40240\fP)
.IP \(bu 2
720a362c7a Merge pull request \fI\%#40240\fP from rallytime/merge\-2016.11
.IP \(bu 2
5c5b74b09a Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
35ced607dd Merge pull request \fI\%#40226\fP from terminalmage/issue40149
.INDENT 2.0
.IP \(bu 2
2a8df9384c Fix wrong errno in systemd.py
.UNINDENT
.IP \(bu 2
24c4ae9c21 Merge pull request \fI\%#40232\fP from rallytime/update\-release\-notes
.INDENT 2.0
.IP \(bu 2
2ead188b4f Update release notes for 2016.3.6
.UNINDENT
.IP \(bu 2
c59ae9a82c Merge pull request \fI\%#39855\fP from Foxlik/use_regex_to_compare_authorized_keys
.INDENT 2.0
.IP \(bu 2
d46845a5b6 Add newline at end of file
.IP \(bu 2
d4a3c8a66a Use regular expression instead of split when replacing authorized_keys
.UNINDENT
.IP \(bu 2
fd10430018 Merge pull request \fI\%#40221\fP from rallytime/bp\-39179
.INDENT 2.0
.IP \(bu 2
07dc2de084 fix error parsing
.UNINDENT
.IP \(bu 2
a27a2cc3bb Merge pull request \fI\%#40206\fP from cro/sign_pub_take2
.INDENT 2.0
.IP \(bu 2
01048de83f leave sign_pub_messages off on minion by default.
.IP \(bu 2
a82b005507 Leave sign_pub_messages off by default.
.UNINDENT
.IP \(bu 2
d1abb4cbaa Merge pull request \fI\%#40193\fP from rallytime/bp\-40117
.INDENT 2.0
.IP \(bu 2
cf1857904b More optimization.
.IP \(bu 2
5a08266814 Removed debug statemnt
.IP \(bu 2
f557f7c6bb Added fix for issue 39393
.IP \(bu 2
bb62278b73 Reverting changes.
.IP \(bu 2
a9107cde44 Added if condition for broken link.
.UNINDENT
.IP \(bu 2
0f1ff4d4a8 Merge pull request \fI\%#40196\fP from twangboy/win_fix_deps
.INDENT 2.0
.IP \(bu 2
6761527793 Update dependencies for PyOpenSSL
.UNINDENT
.IP \(bu 2
b0501515cb Merge pull request \fI\%#40184\fP from terminalmage/link\-reactor\-example
.INDENT 2.0
.IP \(bu 2
a42be82993 Link to minion start reactor example from FAQ.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39445\fP: (\fI\%systemtrap\fP) state file.copy for directories does not set ownership recursively (refs: \fI\%#40030\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40231\fP: (\fI\%rallytime\fP) Back\-port \fI\%#40030\fP to 2016.11
@ \fI2017\-03\-22 23:14:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40030\fP: (\fI\%narendraingale2\fP) Added changes for fix_39445 (refs: \fI\%#40231\fP)
.IP \(bu 2
c40376250f Merge pull request \fI\%#40231\fP from rallytime/bp\-40030
.IP \(bu 2
4d1c687cbd Using lchown insted of chown.
.IP \(bu 2
52b3d986b5 Added changes for fix_39445
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#40225\fP: (\fI\%techhat\fP) Add wait_for_fun() to set_tags() (refs: \fI\%#40239\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40239\fP: (\fI\%cachedout\fP) Revert \(dqAdd wait_for_fun() to set_tags()\(dq
@ \fI2017\-03\-22 22:59:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
e39f5cbf40 Merge pull request \fI\%#40239\fP from saltstack/revert\-40225\-waitforfun
.IP \(bu 2
95bdab87b4 Revert \(dqAdd wait_for_fun() to set_tags()\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40225\fP: (\fI\%techhat\fP) Add wait_for_fun() to set_tags() (refs: \fI\%#40250\fP)
@ \fI2017\-03\-22 18:15:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
11d2f5abec Merge pull request \fI\%#40225\fP from techhat/waitforfun
.IP \(bu 2
89b5010883 Add wait_for_fun() to set_tags()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40172\fP: (\fI\%dmurphy18\fP) Fix solaris network
@ \fI2017\-03\-22 17:41:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
c8cfbb7df6 Merge pull request \fI\%#40172\fP from dmurphy18/fix_solaris_network
.IP \(bu 2
a6218b9484 Updated use of tail on Solaris and Sun\-like OS
.IP \(bu 2
90e6a1d8f6 Further update to support correct tail in network for Solaris
.IP \(bu 2
5b6d33dd70 Fix use of correct tail on Solaris for active_tcp
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40210\fP: (\fI\%rallytime\fP) Skip flaky test for now
@ \fI2017\-03\-22 16:34:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
e9a4e8548b Merge pull request \fI\%#40210\fP from rallytime/test\-skip
.IP \(bu 2
0ba773d86b Skip flaky test for now
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40204\fP: (\fI\%sofixa\fP) InfluxDB returner present on salt\-minion(installed via salt\-bootstrap and updated via apt\-get) has a bug (refs: \fI\%#40209\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40209\fP: (\fI\%sofixa\fP) change InfluxDB get_version to expect status code 204
@ \fI2017\-03\-21 21:42:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
0b00489eb2 Merge pull request \fI\%#40209\fP from sofixa/2016.11
.IP \(bu 2
e1cc7234ff change InfluxDB get_version to expect status code 204
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39775\fP: (\fI\%mirceaulinic\fP) Proxy \fImine_interval\fP config ignored (refs: \fI\%#39935\fP, #saltstack/salt\(ga#39935\(ga_, \fI\%#39776\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#39935\fP: (\fI\%cro\fP) Add special token to insert the minion id into the default_include path (refs: \fI\%#40202\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40202\fP: (\fI\%cro\fP) Revert \(dqAdd special token to insert the minion id into the default_include path\(dq
@ \fI2017\-03\-21 21:37:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
66bc680d0a Merge pull request \fI\%#40202\fP from saltstack/revert\-39935\-namespace_proxy_cfg
.IP \(bu 2
bb71710747 Revert \(dqAdd special token to insert the minion id into the default_include path\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40199\fP: (\fI\%whiteinge\fP) Ponysay emergency hotfix
@ \fI2017\-03\-21 21:10:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
d8f0b79997 Merge pull request \fI\%#40199\fP from whiteinge/ponysay\-emergency\-hotfix
.IP \(bu 2
85ea61b544 Add depends note
.IP \(bu 2
5a271acfdc Fix ponysay outputter hardcoded path
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40194\fP: (\fI\%terminalmage\fP) Change imports for dockerng tests
@ \fI2017\-03\-21 19:34:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
82cee58e72 Merge pull request \fI\%#40194\fP from terminalmage/fix\-docker\-test\-imports
.IP \(bu 2
6caedb0de8 Change imports for dockerng tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40189\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-21 18:02:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
0b512f9ffb Merge pull request \fI\%#40189\fP from rallytime/merge\-2016.11
.IP \(bu 2
a55c4138a8 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
d4e6c58526 Merge pull request \fI\%#40182\fP from terminalmage/dockerng\-mod_watch\-stopped
.INDENT 2.0
.IP \(bu 2
4629a26fb7 Add support for \(dqstopped\(dq state to dockerng\(aqs mod_watch
.UNINDENT
.IP \(bu 2
a0b4082484 Merge pull request \fI\%#40171\fP from Ch3LL/2016.3.6_release
.INDENT 2.0
.IP \(bu 2
9c6d8d892f additional PRs/issues for 2016.3.6 release notes
.UNINDENT
.IP \(bu 2
33ba7821f7 Merge pull request \fI\%#40120\fP from sergeizv/gce\-expand\-node\-fix
.INDENT 2.0
.IP \(bu 2
9d0fbe7e01 gce: Exclude GCENodeDriver objects from _expand_node result
.UNINDENT
.IP \(bu 2
48843977c3 Merge pull request \fI\%#40122\fP from meaksh/2016.3\-yum\-downloadonly\-support
.INDENT 2.0
.IP \(bu 2
067f3f77c2 Adding downloadonly support to yum/dnf module
.UNINDENT
.IP \(bu 2
60e1d4e2f3 Merge pull request \fI\%#40159\fP from cro/sign_pub
.INDENT 2.0
.IP \(bu 2
e663b761fb Fix small syntax error
.IP \(bu 2
0a0f46fb14 Turn on sign_pub_messages by default.  Make sure messages with no \(aqsig\(aq are dropped with error when sign_pub_messages is True.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39779\fP: (\fI\%sp1r\fP) Pillar scheduling is broken (refs: \fI\%#40034\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38523\fP: (\fI\%MorphBonehunter\fP) schedule not changed on pillar update after minion restart (refs: \fI\%#40034\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#36134\fP: (\fI\%Ch3LL\fP) carbon: multi\-master with failover does not failover when master goes down (refs: \fI\%#36437\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40034\fP: (\fI\%sp1r\fP) Disallow modification of jobs from pillar with schedule execution module
@ \fI2017\-03\-21 16:36:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36437\fP: (\fI\%DmitryKuzmenko\fP) Keep the schedule jobs in ONE place. (refs: \fI\%#40034\fP)
.IP \(bu 2
d9cb222aa8 Merge pull request \fI\%#40034\fP from sp1r/fix\-pillar\-scheduling
.IP \(bu 2
595f786327 fix evaluating jobs when \(dqpillar\(dq is missing in opts
.IP \(bu 2
9d5db1910c fix initial data structure for schedule tests
.IP \(bu 2
d3a2489c9c schedule tests to ensure pillar jobs are not modified
.IP \(bu 2
27385ff49c added a check ensuring schedule is a dict before merging
.IP \(bu 2
14d71918b2 Fixes \fI\%#39779\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40160\fP: (\fI\%eldadru\fP) Fix this issue: \fI\%https://github.com/saltstack/salt/issues/40073\fP, descr…
@ \fI2017\-03\-20 21:37:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
257c862c52 Merge pull request \fI\%#40160\fP from eldadru/fix\-issue\-40073\-boto\-rds\-describe\-empty\-dict
.IP \(bu 2
954c871332 Fix this issue: \fI\%https://github.com/saltstack/salt/issues/40073\fP, describe return dictionary returned empty , probably as result of incorrect past merge (see discussion on issue)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40162\fP: (\fI\%rallytime\fP) Make sure the tornado web server is stopped at the end of the test class
@ \fI2017\-03\-20 20:35:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
aec504173a Merge pull request \fI\%#40162\fP from rallytime/archive\-integration\-test\-fixes
.IP \(bu 2
dd193cc740 Make sure the tornado web server is stopped at the end of the test class
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40158\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-20 20:34:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
461e15f0f4 Merge pull request \fI\%#40158\fP from rallytime/merge\-2016.11
.IP \(bu 2
88f3ebd7e9 Remove extra \(dqconnect\(dq kwarg caught by linter
.IP \(bu 2
f4d4768a6d Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
28e4fc17b6 Merge pull request \fI\%#40123\fP from twangboy/win_fix_network
.INDENT 2.0
.IP \(bu 2
06dfd55ef9 Adds support for inet_pton in Windows to network util
.UNINDENT
.IP \(bu 2
35ddb79f59 Merge pull request \fI\%#40141\fP from bobrik/fallback\-resolve
.INDENT 2.0
.IP \(bu 2
af1545deed Use the first address if cannot connect to any
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40165\fP: (\fI\%rallytime\fP) Don\(aqt try to run the dockerng unit tests if docker\-py is missing
@ \fI2017\-03\-20 20:33:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
b235f0953f Merge pull request \fI\%#40165\fP from rallytime/gate\-docker\-unit\-tests
.IP \(bu 2
f32d8a8683 Don\(aqt try to run the dockerng unit tests if docker\-py is missing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40085\fP: (\fI\%mirceaulinic\fP) VRF arg and better doc for ping and traceroute
@ \fI2017\-03\-20 19:48:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
db9fb58b82 Merge pull request \fI\%#40085\fP from cloudflare/fix\-ping\-tr
.IP \(bu 2
6cbdd61b54 Strip trailing whitespaces
.IP \(bu 2
897a2a37c3 VRF arg and better doc for ping and traceroute
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40095\fP: (\fI\%skizunov\fP) dns_check should not try to connect when connect=False
@ \fI2017\-03\-17 17:31:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
3bac06f099 Merge pull request \fI\%#40095\fP from skizunov/develop2
.IP \(bu 2
880790f743 dns_check should not try to connect when connect=False
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40096\fP: (\fI\%skizunov\fP) When building up the \(aqmaster_uri_list\(aq, do not try to connect
@ \fI2017\-03\-17 17:13:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
31da90edd9 Merge pull request \fI\%#40096\fP from skizunov/develop3
.IP \(bu 2
eb9a0a6fd1 When building up the \(aqmaster_uri_list\(aq, do not try to connect
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40111\fP: (\fI\%eldadru\fP) Fixing simple issue 40081 \- the key parameter of the method create ov…
@ \fI2017\-03\-17 17:00:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
5303386d93 Merge pull request \fI\%#40111\fP from eldadru/fix\-issue\-40081\-boto\-rds\-create\-overwritten\-key\-parameter
.IP \(bu 2
78b5d112d7 Fixing simple issue 40081 \- the key parameter of the method create overwritten by internal loop.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40118\fP: (\fI\%rallytime\fP) Add CLI Example for dockerng.get_client_args
@ \fI2017\-03\-17 16:34:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
d2e376e8f2 Merge pull request \fI\%#40118\fP from rallytime/cli\-example
.IP \(bu 2
bb496bb7f4 Add CLI Example for dockerng.get_client_args
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40097\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-17 15:17:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
baef5009aa Merge pull request \fI\%#40097\fP from rallytime/merge\-2016.11
.IP \(bu 2
ef1ff38f8d Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
116201f345 Merge pull request \fI\%#40059\fP from terminalmage/fix\-virtualenv\-traceback
.INDENT 2.0
.IP \(bu 2
e3cfd29d6b Fix traceback when virtualenv.managed is invoked with nonexistent user
.UNINDENT
.IP \(bu 2
a01b52b9a3 Merge pull request \fI\%#40090\fP from rallytime/bp\-40056
.INDENT 2.0
.IP \(bu 2
ae012db87a update mention bot blacklist
.UNINDENT
.IP \(bu 2
d1570bba4c Merge pull request \fI\%#40057\fP from cachedout/ollie_blacklist
.INDENT 2.0
.IP \(bu 2
0ac2e83d37 Merge branch \(aq2016.3\(aq into ollie_blacklist
.IP \(bu 2
5592c680b5 More mentionbot blacklists
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39771\fP: (\fI\%mirceaulinic\fP) Empty __proxy__ dunder inside scheduler (refs: \fI\%#40077\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40077\fP: (\fI\%mirceaulinic\fP) Fix \fI\%#39771\fP (Empty __proxy__ dunder inside scheduler)
@ \fI2017\-03\-16 20:56:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
9ef3e070c2 Merge pull request \fI\%#40077\fP from cloudflare/fix\-39771
.IP \(bu 2
cd319e7e39 Add proxy kwarg to scheduler
.IP \(bu 2
c6e6dd1a04 ProxyMinion: correctly build the scheduler
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40088\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-16 19:58:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
b12720a56f Merge pull request \fI\%#40088\fP from rallytime/merge\-2016.11
.IP \(bu 2
626bd03885 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
d36bdb1a6e Merge pull request \fI\%#40070\fP from Ch3LL/2016.3.6_release
.INDENT 2.0
.IP \(bu 2
a1f8b49bd1 update 2016.3.6 release notes with additional PR\(aqs
.UNINDENT
.IP \(bu 2
8dcffc7751 Merge pull request \fI\%#40018\fP from meaksh/2016.3\-handling\-timeouts\-for\-manage.up\-runner
.INDENT 2.0
.IP \(bu 2
9f5c3b7dcd Allows one to set custom timeouts for \(aqmanage.up\(aq and \(aqmanage.status\(aq
.IP \(bu 2
2102d9c75c Allows one to set \(aqtimeout\(aq and \(aqgather_job_timeout\(aq via kwargs
.UNINDENT
.IP \(bu 2
22fc5299a2 Merge pull request \fI\%#40038\fP from velom/fix\-pip\-freeze\-parsing
.INDENT 2.0
.IP \(bu 2
3fae91d879 correctly parse \(dqpkg_name===version\(dq from pip freeze
.UNINDENT
.IP \(bu 2
3584f935fa Merge pull request \fI\%#40053\fP from saltstack/rh_ip_patch
.INDENT 2.0
.IP \(bu 2
219947acdb Update rh_ip.py
.UNINDENT
.IP \(bu 2
837432d3d2 Merge pull request \fI\%#40041\fP from terminalmage/issue40011
.INDENT 2.0
.IP \(bu 2
5b5d1b375c Fix transposed lines in salt.utils.process
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40055\fP: (\fI\%rallytime\fP) Update \(dqyaml\(dq code\-block references with \(dqjinja\(dq where needed
@ \fI2017\-03\-16 16:30:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
703ab23953 Merge pull request \fI\%#40055\fP from rallytime/doc\-build\-warnings
.IP \(bu 2
72d16c9fa9 Update \(dqyaml\(dq code\-block references with \(dqjinja\(dq where needed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40072\fP: (\fI\%meaksh\fP) [2016.11] Allows overriding \(aqtimeout\(aq and \(aqgather_job_timeout\(aq to \(aqmanage.up\(aq runner call
@ \fI2017\-03\-16 15:31:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40018\fP: (\fI\%meaksh\fP) Allows overriding \(aqtimeout\(aq and \(aqgather_job_timeout\(aq to \(aqmanage.up\(aq runner call (refs: \fI\%#40072\fP)
.IP \(bu 2
e73a1d0e54 Merge pull request \fI\%#40072\fP from meaksh/2016.11\-handling\-timeouts\-for\-manage.up\-runner
.IP \(bu 2
40246d3723 Allows one to set custom timeouts for \(aqmanage.up\(aq and \(aqmanage.status\(aq
.IP \(bu 2
ad232fdc01 Allows one to set \(aqtimeout\(aq and \(aqgather_job_timeout\(aq via kwargs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40045\fP: (\fI\%terminalmage\fP) Fix error when chhome is invoked by user.present state in Windows
@ \fI2017\-03\-15 19:00:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
2f28ec26ee Merge pull request \fI\%#40045\fP from terminalmage/fix\-windows\-user\-present
.IP \(bu 2
359af3bb2b Fix error when chhome is invoked by user.present state in Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40047\fP: (\fI\%rallytime\fP) Back\-port \fI\%#40000\fP to 2016.11
@ \fI2017\-03\-15 17:47:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40000\fP: (\fI\%skizunov\fP) Fix exception in salt\-call when master_type is \(aqdisable\(aq (refs: \fI\%#40047\fP)
.IP \(bu 2
4067625676 Merge pull request \fI\%#40047\fP from rallytime/bp\-40000
.IP \(bu 2
11766c7259 Fix exception in salt\-call when master_type is \(aqdisable\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40023\fP: (\fI\%jeanpralo\fP) We need to match on .p not just strip \(aq.p\(aq otherwise it will remove a…
@ \fI2017\-03\-14 23:14:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
86f7195e0e Merge pull request \fI\%#40023\fP from jeanpralo/fix\-minions\-cant\-finish\-by\-char\-p
.IP \(bu 2
d7b0c8ae88 We need to match on .p not just strip \(aq.p\(aq otherwise it will remove any p from the string even if we have no dot
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40025\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-14 23:14:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
277bd17ff2 Merge pull request \fI\%#40025\fP from rallytime/merge\-2016.11
.IP \(bu 2
029f28bbd5 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
ee7f3b1200 Merge pull request \fI\%#40021\fP from Ch3LL/2016.3.6_release
.INDENT 2.0
.IP \(bu 2
f3e7e4fb2a Add 2016.3.6 Release Notes
.UNINDENT
.IP \(bu 2
26895b7be2 Merge pull request \fI\%#40016\fP from terminalmage/fix\-grains\-test
.INDENT 2.0
.IP \(bu 2
0ec81a4cde Fixup a syntax error
.IP \(bu 2
5d84b40bfd Attempt to fix failing grains tests in 2016.3
.UNINDENT
.IP \(bu 2
0c61d064ad Merge pull request \fI\%#39980\fP from vutny/cmd\-run\-state\-bg
.INDENT 2.0
.IP \(bu 2
a81dc9dfc1 [2016.3] Allow using \fIbg\fP kwarg for \fIcmd.run\fP state function
.UNINDENT
.IP \(bu 2
b042484455 Merge pull request \fI\%#39994\fP from rallytime/ulimits\-dockerng\-version
.INDENT 2.0
.IP \(bu 2
37bd800fac Add a versionadded tag for dockerng ulimits addition
.UNINDENT
.IP \(bu 2
e125c94ba5 Merge pull request \fI\%#39988\fP from terminalmage/dockerng\-timeout
.INDENT 2.0
.IP \(bu 2
bd2519ed1b Add comment explaining change from \fI\%#39973\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40020\fP: (\fI\%dmurphy18\fP) Full support for execution module timezone on AIX
@ \fI2017\-03\-14 21:05:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
8db74fb275 Merge pull request \fI\%#40020\fP from dmurphy18/aix_timezone
.IP \(bu 2
aabbbffd45 Full support to execution module timezone on AIX
.IP \(bu 2
16d5c7ce4a WIP: timezone support for AIX
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39924\fP: (\fI\%dmurphy18\fP) Add AIX support for user and group execution modules
@ \fI2017\-03\-14 21:04:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
60066da614 Merge pull request \fI\%#39924\fP from dmurphy18/salt_aix_fixMar
.IP \(bu 2
5077c989bb Updated changes file for added AIX support
.IP \(bu 2
8e107bd43e WIP: support for useradd on AIX
.IP \(bu 2
2f87d727d6 WIP: group support for AIX
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40010\fP: (\fI\%jettero\fP) S3 bucket path broken
@ \fI2017\-03\-14 19:01:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
cd73eafec8 Merge pull request \fI\%#40010\fP from jettero/s3\-bucket\-path\-broken
.IP \(bu 2
acee5bf7c8 clarify this, because it messes people up in the mailing lists, and myself briefly before I thought about it
.IP \(bu 2
8102ac8e3c same here
.IP \(bu 2
21b79e00be In order for the heredoc to be correct, bucket and path have to default to \(aq\(aq, not None
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39991\fP: (\fI\%terminalmage\fP) Document the fact that the checksum type can be omitted in file.managed states
@ \fI2017\-03\-14 15:58:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
61f1fb04c5 Merge pull request \fI\%#39991\fP from terminalmage/source_hash\-docs
.IP \(bu 2
537fc36029 Document the fact that the checksum type can be omitted in file.managed states
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39984\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-13 18:30:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
53d14d8ad9 Merge pull request \fI\%#39984\fP from rallytime/merge\-2016.11
.IP \(bu 2
ef6f4b15ca Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
cd0336e868 Merge pull request \fI\%#39973\fP from terminalmage/dockerng\-timeout
.INDENT 2.0
.IP \(bu 2
869416e7db Don\(aqt use docker.Client instance from context if missing attributes
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39967\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-10 23:45:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
31c00740e7 Merge pull request \fI\%#39967\fP from rallytime/merge\-2016.11
.IP \(bu 2
3022466615 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
282c607d26 Merge pull request \fI\%#39962\fP from cachedout/disable_mentionbot_delay_3
.INDENT 2.0
.IP \(bu 2
7a638f204b Disable mention bot delay on 2016.3
.UNINDENT
.IP \(bu 2
1e0c88ae08 Merge pull request \fI\%#39937\fP from cachedout/gpg_zypper
.INDENT 2.0
.IP \(bu 2
13ed0d1209 Fix \-\-non\-gpg\-checks in zypper module
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39963\fP: (\fI\%cachedout\fP) Mention bot delay disable for 2016.11
@ \fI2017\-03\-10 20:25:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
269a2fd739 Merge pull request \fI\%#39963\fP from cachedout/disable_mentionbot_delay_11
.IP \(bu 2
5fcea05691 Mention bot delay disable for 2016.11
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#7997\fP: (\fI\%shantanub\fP) Proper way to upgrade salt\-minions / salt\-master packages without losing minion connectivity (refs: \fI\%#39952\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39952\fP: (\fI\%vutny\fP) Fix \fI\%#7997\fP: describe how to upgrade Salt Minion in a proper way
@ \fI2017\-03\-10 18:41:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
6350b07384 Merge pull request \fI\%#39952\fP from vutny/doc\-faq\-minion\-upgrade\-restart
.IP \(bu 2
d989d749d6 Fix \fI\%#7997\fP: describe how to upgrade Salt Minion in a proper way
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39775\fP: (\fI\%mirceaulinic\fP) Proxy \fImine_interval\fP config ignored (refs: \fI\%#39935\fP, #saltstack/salt\(ga#39935\(ga_, \fI\%#39776\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39935\fP: (\fI\%cro\fP) Add special token to insert the minion id into the default_include path
@ \fI2017\-03\-10 17:51:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
dc7d4f4224 Merge pull request \fI\%#39935\fP from cro/namespace_proxy_cfg
.IP \(bu 2
e4aef54c73 Add special token to insert the minion id into the default_include path
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39936\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-10 17:05:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
9503a1d0c6 Merge pull request \fI\%#39936\fP from rallytime/merge\-2016.11
.IP \(bu 2
c8b5d390b5 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
4526fc6e08 Merge pull request \fI\%#39929\fP from terminalmage/pr\-39770\-2016.3
.INDENT 2.0
.IP \(bu 2
cf0100dabe Scrap event\-based approach for refreshing grains
.UNINDENT
.IP \(bu 2
111110caf8 Merge pull request \fI\%#39919\fP from The\-Loeki/patch\-1
.INDENT 2.0
.IP \(bu 2
170cbadc54 CIDR matching supports IPv6, update docs
.UNINDENT
.IP \(bu 2
caf10e9988 Merge pull request \fI\%#39899\fP from techhat/cleanupdisks
.INDENT 2.0
.IP \(bu 2
baf4579e63 Update cleanup function for azure
.UNINDENT
.IP \(bu 2
fcf95f3654 Merge pull request \fI\%#39871\fP from terminalmage/squelch\-import\-warning
.INDENT 2.0
.IP \(bu 2
2b2ec69d04 Squelch warning for pygit2 import
.UNINDENT
.IP \(bu 2
f223fa8906 Merge pull request \fI\%#39794\fP from cachedout/clean_monitor_socket_shutdown
.INDENT 2.0
.IP \(bu 2
2e683e788b Clean up errors which might be thrown when the monitor socket shuts down
.UNINDENT
.IP \(bu 2
4002dc1947 Merge pull request \fI\%#39819\fP from terminalmage/top\-file\-matching\-docs
.INDENT 2.0
.IP \(bu 2
7178e77eee Improve the Top File matching docs
.UNINDENT
.IP \(bu 2
c08aaeb7fd Merge pull request \fI\%#39820\fP from ni3mm4nd/beacons_topic_doc_typo
.INDENT 2.0
.IP \(bu 2
804b12048c Add missing apostrophe
.UNINDENT
.IP \(bu 2
cbd2a4e3cc Merge pull request \fI\%#39826\fP from cachedout/yubikey_fix
.INDENT 2.0
.IP \(bu 2
6125eff02d Add group func to yubikey auth
.UNINDENT
.IP \(bu 2
f575ef459f Merge pull request \fI\%#39624\fP from drawsmcgraw/39622
.INDENT 2.0
.IP \(bu 2
13da50be33 Fix indention lint errors
.IP \(bu 2
545026352f Address issue 39622
.UNINDENT
.IP \(bu 2
1f3619c1e5 Merge pull request \fI\%#39796\fP from cachedout/master_shutdown
.INDENT 2.0
.IP \(bu 2
e31d46c1b8 Stop the process manager when it no longer has processes to manage
.UNINDENT
.IP \(bu 2
53341cf152 Merge pull request \fI\%#39791\fP from gtmanfred/2016.3
.INDENT 2.0
.IP \(bu 2
3ab4f843bf load runners if role is master
.UNINDENT
.IP \(bu 2
c234c25092 Merge pull request \fI\%#39784\fP from sergeizv/fix\-39782
.INDENT 2.0
.IP \(bu 2
b71c3fe13c Revert \(dqcloud.clouds.ec2: cache each named node (\fI\%#33164\fP)\(dq
.UNINDENT
.IP \(bu 2
4ee59be22c Merge pull request \fI\%#39766\fP from rallytime/fix\-ipv6\-connection
.INDENT 2.0
.IP \(bu 2
65b239664e Restore ipv6 connectivity and \(dqmaster: <ip>:<port>\(dq support
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38121\fP: (\fI\%Da\-Juan\fP) Beacon configuration doesn\(aqt work as a list (refs: \fI\%#39932\fP, \fI\%#39930\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39932\fP: (\fI\%rallytime\fP) Cherry\-pick the beacon fixes made in \fI\%#39930\fP to 2016.11
@ \fI2017\-03\-10 00:21:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39930\fP: (\fI\%s0undt3ch\fP) Moar Py3 and a fix for \fI\%#38121\fP (refs: \fI\%#39932\fP)
.IP \(bu 2
899e037f0a Merge pull request \fI\%#39932\fP from rallytime/cp\-beacon\-fixes
.IP \(bu 2
4a52cca926 Pylint fixes
.IP \(bu 2
4627c4ea6d Code cleanup and make sure the beacons config file is deleted after testing
.IP \(bu 2
c7fc09f97d Support the new list configuration format.
.IP \(bu 2
be06df9b64 Remove \fI*args, **kwargs\fP\&. Not needed, not useful.
.IP \(bu 2
4a242829ee These tests aren\(aqt even using mock!
.IP \(bu 2
6408b123e7 These tests are not destructive
.IP \(bu 2
50e51b5b9d The beacons configuration is now a list. Handle it!
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39933\fP: (\fI\%hkrist\fP) Fixed rawfile_json returner output format.
@ \fI2017\-03\-10 00:20:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e68edee4a Merge pull request \fI\%#39933\fP from hkrist/fix\-rawfile_json_returner\-format
.IP \(bu 2
4d0ddcd110 Fixed rawfile_json returner output format. It outputted python object instead of standard json.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39934\fP: (\fI\%dmurphy18\fP) Correct comment lines output from execution module\(aqs host.list_hosts
@ \fI2017\-03\-10 00:20:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb0dc33c42 Merge pull request \fI\%#39934\fP from dmurphy18/fix_host_list
.IP \(bu 2
e7b9a45079 Correct comment lines output got list_hosts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39900\fP: (\fI\%twangboy\fP) Namespace the line function properly in win_file
@ \fI2017\-03\-09 22:19:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
a6f88d03df Merge pull request \fI\%#39900\fP from twangboy/win_fix_line
.IP \(bu 2
462bdecd33 Namespace the line function properly in win_file
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37741\fP: (\fI\%discountbin\fP) Check in file.replace state for ignore_if_missing (refs: \fI\%#37743\fP, \fI\%#39910\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39910\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37743\fP to 2016.11
@ \fI2017\-03\-09 22:16:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37743\fP: (\fI\%discountbin\fP) Adding check for ignore_if_missing param when calling _check_file. (refs: \fI\%#39910\fP)
.IP \(bu 2
77ecff4e02 Merge pull request \fI\%#39910\fP from rallytime/bp\-37743
.IP \(bu 2
ca306c0860 Replace pass with updated comment for return
.IP \(bu 2
1a78878b47 Adding check for ignore_if_missing param when calling _check_file.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39770\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-03\-09 22:00:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
c2d4d17589 Merge pull request \fI\%#39770\fP from rallytime/merge\-2016.11
.IP \(bu 2
dbaea3de73 Remove extra refresh reference that snuck in
.IP \(bu 2
d9f48ac6ea Don\(aqt shadow refresh_pillar
.IP \(bu 2
d86b03dc90 Remove manual refresh code from minion.py
.IP \(bu 2
a7e419e35f Scrap event\-based approach for refreshing grains
.IP \(bu 2
776a9431b9 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
a24da31131 Merge pull request \fI\%#39761\fP from cachedout/issue_33187
.INDENT 2.0
.IP \(bu 2
c2df29edb2 Properly display error in jboss7 state
.UNINDENT
.IP \(bu 2
0888bc32ef Merge pull request \fI\%#39728\fP from rallytime/update\-release\-ver\-2016.3
.INDENT 2.0
.IP \(bu 2
c9bc8af8f2 [2016.3] Bump latest release version to 2016.11.3
.UNINDENT
.IP \(bu 2
b52dbeec68 Merge pull request \fI\%#39619\fP from terminalmage/zd1207
.INDENT 2.0
.IP \(bu 2
c7dfb494a6 Fix mocking for grains refresh
.IP \(bu 2
7e0ced3b45 Properly hand proxy minions
.IP \(bu 2
692c456da3 Add a function to simply refresh the grains
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39872\fP: (\fI\%techhat\fP) Add installation tips for azurearm driver
@ \fI2017\-03\-07 23:18:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
801ff28053 Merge pull request \fI\%#39872\fP from techhat/fixdocs
.IP \(bu 2
35440c5936 Add installation tips for azure
.IP \(bu 2
2a1ae0bf2e Change example master in azure docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39837\fP: (\fI\%terminalmage\fP) Fix regression in archive.extracted when it runs file.directory
@ \fI2017\-03\-07 04:09:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
6d0f15c31a Merge pull request \fI\%#39837\fP from terminalmage/more\-issue39751
.IP \(bu 2
0285ff3c7d Fix regression in archive.extracted when it runs file.directory
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39858\fP: (\fI\%techhat\fP) Reorder keys that were being declared in the wrong place
@ \fI2017\-03\-07 03:51:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
68752a2a18 Merge pull request \fI\%#39858\fP from techhat/statuskey
.IP \(bu 2
507a4f7f93 Reorder keys that were being declared in the wrong place
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38830\fP: (\fI\%danielmotaleite\fP) salt\-ssh: vault fails to use config (refs: \fI\%#38943\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39862\fP: (\fI\%rallytime\fP) Back\-port \fI\%#38943\fP to 2016.11
@ \fI2017\-03\-07 03:34:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38943\fP: (\fI\%thatch45\fP) When we generate the pillar we should send in the master opts (refs: \fI\%#39862\fP)
.IP \(bu 2
49c8faa141 Merge pull request \fI\%#39862\fP from rallytime/bp\-38943
.IP \(bu 2
e21b16c002 try it with a different init sequence
.IP \(bu 2
92cac0ff8b make it a deepcopy
.IP \(bu 2
58cb8cd4f5 make sure to copy the top dict reference since we are moding it
.IP \(bu 2
a0b671ea43 When we generate the pillar we should send in the master opts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39852\fP: (\fI\%rallytime\fP) Back\-port \fI\%#39651\fP to 2016.11
@ \fI2017\-03\-06 21:18:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39651\fP: (\fI\%DennisHarper\fP) Checking Instance when calling a function that can return None (refs: \fI\%#39852\fP)
.IP \(bu 2
8ecc719f90 Merge pull request \fI\%#39852\fP from rallytime/bp\-39651
.IP \(bu 2
bb5ddbe18c Checking instance exists in master._get_cached_minion_data when cache.fetch returns None
.IP \(bu 2
79f2a7cbb7 Update __init__.py
.IP \(bu 2
e2a232921d Checking instance exists in master._get_cached_minion_data when cache.fetch returns None
.IP \(bu 2
838774291d Update __init__.py
.IP \(bu 2
ff6f63e9dd Checking instance exists in master._get_cached_minion_data when cache.fetch returns None
.IP \(bu 2
855f87554c Checking instance exists in master._get_cached_minion_data when cache.fetch returns None
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39052\fP: (\fI\%githubcdr\fP) Minion restart very slow since 2016.11.2 (refs: \fI\%#39104\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39851\fP: (\fI\%rallytime\fP) Back\-port \fI\%#39104\fP to 2016.11
@ \fI2017\-03\-06 21:17:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39104\fP: (\fI\%githubcdr\fP) Do not use name resolving for \-\-notrim check (refs: \fI\%#39851\fP)
.IP \(bu 2
897275ae5f Merge pull request \fI\%#39851\fP from rallytime/bp\-39104
.IP \(bu 2
6539dbdbca Do not use name resolving for \-\-notrim check
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38231\fP: (\fI\%tjuup\fP) Typo: salt\-key deleted (refs: \fI\%#39799\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39799\fP: (\fI\%Ch3LL\fP) Fix deleted message when key is deleted
@ \fI2017\-03\-03 05:17:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0440e2a2a Merge pull request \fI\%#39799\fP from Ch3LL/fix_salt_key_msg
.IP \(bu 2
8346682cf7 Fix deleted message when key is deleted
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38962\fP: (\fI\%gstachowiak\fP) Broken /jobs in salt\-api in salt 2016.11.1 (Carbon) (refs: \fI\%#39472\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39472\fP: (\fI\%whiteinge\fP) Update _reformat_low to not run kwarg dicts through parse_input
@ \fI2017\-03\-02 17:46:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
9f70ad7164 Merge pull request \fI\%#39472\fP from whiteinge/_reformat_low\-update
.IP \(bu 2
d11f5381a4 Add RunnerClient test for old/new\-style arg/kwarg parsing
.IP \(bu 2
ec377ab379 Reenable skipped RunnerClient tests
.IP \(bu 2
27f7fd9ad4 Update _reformat_low to run arg through parse_input
.IP \(bu 2
5177153459 Revert parse_input change from \fI\%#32005\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39727\fP: (\fI\%terminalmage\fP) salt.modules.state: check gathered pillar for errors instead of in\-memory pillar
@ \fI2017\-03\-02 17:06:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
7dfc4b572a Merge pull request \fI\%#39727\fP from terminalmage/issue39627
.IP \(bu 2
3bb0ebd872 Update tests for PR 39727
.IP \(bu 2
c334b59c96 salt.modules.state: check gathered pillar for errors instead of in\-memory pillar
.IP \(bu 2
97dd8a13d9 Ensure that ext_pillar begins with pillar_override if ext_pillar_first is True
.IP \(bu 2
f951266944 Add log message for successful makostack processing
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39775\fP: (\fI\%mirceaulinic\fP) Proxy \fImine_interval\fP config ignored (refs: \fI\%#39935\fP, #saltstack/salt\(ga#39935\(ga_, \fI\%#39776\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39776\fP: (\fI\%mirceaulinic\fP) WIP: Save _schedule.conf under <proxy ID> dir
@ \fI2017\-03\-02 16:27:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
965f474316 Merge pull request \fI\%#39776\fP from cloudflare/proxy\-schedule
.IP \(bu 2
35b8b8fd64 Save _schedule.conf under <minion ID> dir
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39788\fP: (\fI\%cachedout\fP) Disable one API test that is flaky
@ \fI2017\-03\-02 16:17:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
555f1473f6 Merge pull request \fI\%#39788\fP from cachedout/disable_api_test
.IP \(bu 2
523e377b33 Disable one API test that is flaky
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39762\fP: (\fI\%terminalmage\fP) Fix regression in file.get_managed
@ \fI2017\-03\-02 02:59:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
793979cbe6 Merge pull request \fI\%#39762\fP from terminalmage/issue39751
.IP \(bu 2
64db0b8563 Add integration tests for remote file sources
.IP \(bu 2
f9f894d981 Fix regression in file.get_managed when skip_verify=True
.IP \(bu 2
28651a6699 Remove next(iter()) extraction
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35088\fP: (\fI\%Modulus\fP) salt/cloud/ec2.py encoding problems. (refs: \fI\%#37912\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39767\fP: (\fI\%rallytime\fP) Back\-port \fI\%#38316\fP to 2016.11
@ \fI2017\-03\-02 02:54:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38316\fP: (\fI\%mlalpho\fP) salt utils aws encoding fix (refs: \fI\%#39767\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37912\fP: (\fI\%attiasr\fP) fix encoding problem aws responses (refs: \fI\%#38316\fP)
.IP \(bu 2
91a9337ab3 Merge pull request \fI\%#39767\fP from rallytime/bp\-38316
.IP \(bu 2
1dcf018df7 requests api says Response.encoding can sometimes be None \fI\%http://docs.python\-requests.org/en/master/api/#requests.Response.encoding\fP and result.text.encode() doesn\(aqt accept None and expects a string.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39692\fP: (\fI\%djsly\fP) tuned module and state are broken on 7.3 families.  (refs: \fI\%#40387\fP, \fI\%#39719\fP, \fI\%#39768\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39768\fP: (\fI\%rallytime\fP) Back\-port \fI\%#39719\fP to 2016.11
@ \fI2017\-03\-02 02:54:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39719\fP: (\fI\%Seb\-Solon\fP) Support new version of tuned\-adm binary (refs: \fI\%#39768\fP)
.IP \(bu 2
4a01bd64ea Merge pull request \fI\%#39768\fP from rallytime/bp\-39719
.IP \(bu 2
d7cb70f203 Enh: Support new version of tuned\-adm binary
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39760\fP: (\fI\%Ch3LL\fP) Initial 2016.11.4 Release Notes Doc
@ \fI2017\-03\-01 18:43:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
780457f934 Merge pull request \fI\%#39760\fP from Ch3LL/2016.11.4_notes
.IP \(bu 2
1853c998c4 add initial 2016.11.4 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39731\fP: (\fI\%twangboy\fP) Add docs for Kwargs in pkg.refresh_db
@ \fI2017\-02\-28 22:02:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
0147f78ab5 Merge pull request \fI\%#39731\fP from twangboy/win_pkg_docs
.IP \(bu 2
423e6f7448 Add docs for Kwargs in pkg.refresh_db
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39710\fP: (\fI\%huangfupeng\fP) schedule.add parameter can not use “after“ (refs: \fI\%#39734\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39734\fP: (\fI\%garethgreenaway\fP) Missing parameter in the schedule.add function
@ \fI2017\-02\-28 20:43:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
fce2d184f3 Merge pull request \fI\%#39734\fP from garethgreenaway/39710_missing_schedule_add_parameter
.IP \(bu 2
63eb610245 Per \fI\%#39710\fP, missing parameter in the schedule.add function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39729\fP: (\fI\%rallytime\fP) [2016.11] Bump latest release version to 2016.11.3
@ \fI2017\-02\-28 18:08:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
7b4865c058 Merge pull request \fI\%#39729\fP from rallytime/update\-release\-ver\-2016.11
.IP \(bu 2
b5a7111ad9 [2016.11] Bump latest release version to 2016.11.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39721\fP: (\fI\%vutny\fP) DOCS: add 2nd level header for advanced targeting methods
@ \fI2017\-02\-28 17:57:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
47e494fe07 Merge pull request \fI\%#39721\fP from vutny/doc\-targeting
.IP \(bu 2
1d86cf1161 DOCS: add 2nd level header for advanced targeting methods
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39683\fP: (\fI\%alankrita\fP) Error in Saltstack\(aqs rest auth \(dqAuthentication module threw \(aqstatus\(aq \(dq (refs: \fI\%#39711\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39711\fP: (\fI\%alankrita\fP) Fix error in Saltstack\(aqs rest auth \(dqAuthentication module threw \(aqstatus\(aq \(dq
@ \fI2017\-02\-28 15:56:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
d39b679d82 Merge pull request \fI\%#39711\fP from alankrita/fix\-rest\-eauth
.IP \(bu 2
ee426562a7 Fix error in Saltstack\(aqs rest auth \(dqAuthentication module threw \(aqstatus\(aq \(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39699\fP: (\fI\%techhat\fP) Strip shabang line from rendered HTTP data
@ \fI2017\-02\-28 00:05:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
3940321462 Merge pull request \fI\%#39699\fP from techhat/httpshabang
.IP \(bu 2
559eb93576 Strip shabang line from rendered HTTP data
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39694\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-02\-27 22:13:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
00f121eade Merge pull request \fI\%#39694\fP from rallytime/merge\-2016.11
.IP \(bu 2
756f1de2d2 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
3f8b5e6733 Merge pull request \fI\%#39487\fP from bobrik/mode\-docs
.INDENT 2.0
.IP \(bu 2
41ef69b3ca Document default permission modes for file module
.UNINDENT
.IP \(bu 2
f7389bf1f5 Merge pull request \fI\%#39641\fP from smarsching/issue\-39169\-2016.3
.INDENT 2.0
.IP \(bu 2
88c2d9a540 Fix return data structure for runner (issue \fI\%#39169\fP).
.UNINDENT
.IP \(bu 2
fc970b6a16 Merge pull request \fI\%#39633\fP from terminalmage/fix\-systemd\-typo
.INDENT 2.0
.IP \(bu 2
ca54541abe Add missing unit test for disable func
.IP \(bu 2
17109e1522 Fix misspelled argument in salt.modules.systemd.disable()
.UNINDENT
.IP \(bu 2
53e78d67f6 Merge pull request \fI\%#39613\fP from terminalmage/fix\-docs
.INDENT 2.0
.IP \(bu 2
9342eda377 Fix inaccurate documentation
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39642\fP: (\fI\%drawsmcgraw\fP) boto_vpc.nat_gateway_present does not honor the allocation_id parameter like the module does (refs: \fI\%#39643\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39643\fP: (\fI\%drawsmcgraw\fP) issue 39642 \- boto_vpc.nat_gateway_present should accept parameter al…
@ \fI2017\-02\-27 20:19:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
2c919e31d6 Merge pull request \fI\%#39643\fP from drawsmcgraw/39642
.IP \(bu 2
56d9adfbf6 issue 39642 \- boto_vpc.nat_gateway_present should accept parameter allocation_id.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39666\fP: (\fI\%terminalmage\fP) Rewrite the test_valid_docs test
@ \fI2017\-02\-26 20:14:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
df013c5f31 Merge pull request \fI\%#39666\fP from terminalmage/test_valid_docs
.IP \(bu 2
5a3c099e4f Rewrite the tests_valid_docs test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39662\fP: (\fI\%The\-Loeki\fP) Py3 compat: Force minions to be a list for local serialized caches
@ \fI2017\-02\-26 02:36:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
a29a7be7f8 Merge pull request \fI\%#39662\fP from The\-Loeki/py3cachefix
.IP \(bu 2
b02ef984f7 Add comment
.IP \(bu 2
0fe5c90a05 Py3 compat: Force minions to be a list for local serialized caches
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39644\fP: (\fI\%vutny\fP) Improve and align dockerng execution module docs
@ \fI2017\-02\-25 04:16:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd6efd18b1 Merge pull request \fI\%#39644\fP from vutny/dockerng\-docs
.IP \(bu 2
c4988e874e Improve and align dockerng execution module docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39516\fP: (\fI\%jettero\fP) Prevent spurious \(dqTemplate does not exist\(dq error
@ \fI2017\-02\-24 23:41:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
fffab54078 Merge pull request \fI\%#39516\fP from jettero/give\-pillarenv\-tops\-similar\-treatment
.IP \(bu 2
8fe48fa5c4 prevent billions of inexplicable lines of this:
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39654\fP: (\fI\%skizunov\fP) Fix issue where compile_pillar failure causes minion to exit
@ \fI2017\-02\-24 22:47:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
be9629b180 Merge pull request \fI\%#39654\fP from skizunov/develop2
.IP \(bu 2
9f80bbce07 Fix issue where compile_pillar failure causes minion to exit
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39653\fP: (\fI\%cachedout\fP) Use salt\(aqs ordereddict for comparison
@ \fI2017\-02\-24 22:46:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
e63cbbaab9 Merge pull request \fI\%#39653\fP from cachedout/26_odict
.IP \(bu 2
91eb7210bb Use salt\(aqs ordereddict for comparison
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38836\fP: (\fI\%toanctruong\fP) file.managed with S3 Source errors out with obscure message (refs: \fI\%#39609\fP, \fI\%#39589\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39609\fP: (\fI\%gtmanfred\fP) initialize the Client stuff in FSClient
@ \fI2017\-02\-24 18:50:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
0bc6027e68 Merge pull request \fI\%#39609\fP from gtmanfred/2016.11
.IP \(bu 2
0820620ef8 initialize the Client stuff in FSClient
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39615\fP: (\fI\%skizunov\fP) Bonjour/Avahi beacons: Make sure TXT record length is valid
@ \fI2017\-02\-24 18:47:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
28035c07b3 Merge pull request \fI\%#39615\fP from skizunov/develop2
.IP \(bu 2
b1c7e9b505 Bonjour/Avahi beacons: Make sure TXT record length is valid
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39617\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-02\-24 16:07:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
e9410fb669 Merge pull request \fI\%#39617\fP from rallytime/merge\-2016.11
.IP \(bu 2
13622899d2 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
4e2b852f83 Merge pull request \fI\%#39600\fP from vutny/state\-file\-docs
.INDENT 2.0
.IP \(bu 2
9b0427c27a state.file: drop non\-relevant examples for \fIsource_hash\fP parameter
.UNINDENT
.IP \(bu 2
ed83420417 Merge pull request \fI\%#39584\fP from cachedout/mentionbot_docs
.INDENT 2.0
.IP \(bu 2
652044b18f A note in the docs about mentionbot
.UNINDENT
.IP \(bu 2
d3e50b4f2f Merge pull request \fI\%#39583\fP from cachedout/mentionbot_blacklist
.INDENT 2.0
.IP \(bu 2
62491c900d Add empty blacklist to mention bot
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38758\fP: (\fI\%bobrik\fP) Remote state execution is much slower on 2016.11.1 compared to 2016.3.4 (refs: \fI\%#39505\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33575\fP: (\fI\%anlutro\fP) File states seem slower in 2016.3, especially on first cache retrieval (refs: \fI\%#33896\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29643\fP: (\fI\%matthayes\fP) Can\(aqt get batch mode and \-\-failhard to work as expected (refs: \fI\%#31164\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#28569\fP: (\fI\%andrejohansson\fP) Reactor alert on highstate fail (refs: \fI\%#31164\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39505\fP: (\fI\%cachedout\fP) Threadsafety option for context dictionaries
@ \fI2017\-02\-23 19:38:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37378\fP: (\fI\%skizunov\fP) Fix \fI__context__\fP to properly sandbox (refs: \fI\%#39505\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33896\fP: (\fI\%DmitryKuzmenko\fP) Don\(aqt deep copy context dict values. (refs: \fI\%#39505\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31164\fP: (\fI\%DmitryKuzmenko\fP) Issues/29643 fix invalid retcode (refs: \fI\%#33896\fP)
.IP \(bu 2
0d31201e08 Merge pull request \fI\%#39505\fP from cachedout/issue_38758
.IP \(bu 2
1dba2f9cb0 Add warning in docs
.IP \(bu 2
9cf654b72c Threadsafety option for context dictionaries
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39507\fP: (\fI\%joe\-niland\fP) Detect IIS version and vary certificate association command depending on version
@ \fI2017\-02\-23 19:15:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
c0d4357f46 Merge pull request \fI\%#39507\fP from joe\-niland/iis\-7\-cert\-binding
.IP \(bu 2
c94f0b8c62 Fix additional issue whereby existing certificate bindings were not found in IIS 7.5, due to the fact that IIS earlier than 8 doesn\(aqt support SNI
.IP \(bu 2
18effe0103 Detect IIS version and vary certificate association command depending on version
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39565\fP: (\fI\%terminalmage\fP) states.file.patch/modules.file.check_hash: use hash length to determine type
@ \fI2017\-02\-23 19:14:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
e6f5e8a474 Merge pull request \fI\%#39565\fP from terminalmage/issue39512
.IP \(bu 2
cbdf905b9f Update test to reflect new state comment
.IP \(bu 2
650dbaca4e states.file.patch/modules.file.check_hash: use hash length to determine type
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39591\fP: (\fI\%mcalmer\fP) fix case in os_family for Suse
@ \fI2017\-02\-23 19:07:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
53e22b8f15 Merge pull request \fI\%#39591\fP from mcalmer/fix\-case\-in\-os_family
.IP \(bu 2
81bd96e32d fix case in os_family for Suse
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38452\fP: (\fI\%jf\fP) file.line with mode=delete does not preserve ownership of a file (refs: \fI\%#39592\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39592\fP: (\fI\%skazi0\fP) Ensure user/group/file_mode after line edit
@ \fI2017\-02\-23 18:40:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
aee43f7fa4 Merge pull request \fI\%#39592\fP from skazi0/line\-user\-fix
.IP \(bu 2
baf84b4430 Ensure user/group/file_mode after line edit
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39596\fP: (\fI\%ticosax\fP) Reduce scope of try except StopIteration wrapping
@ \fI2017\-02\-23 18:16:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
6ab4151213 Merge pull request \fI\%#39596\fP from ticosax/reduce\-scope\-catehed\-exception
.IP \(bu 2
54cdacb680 Reduce scope of try except StopIteration wrapping
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38836\fP: (\fI\%toanctruong\fP) file.managed with S3 Source errors out with obscure message (refs: \fI\%#39609\fP, \fI\%#39589\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39610\fP: (\fI\%rallytime\fP) Back\-port \fI\%#39589\fP to 2016.11
@ \fI2017\-02\-23 17:48:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39589\fP: (\fI\%MasterNayru\fP) Allow masterless minions to pull files from S3 (refs: \fI\%#39610\fP)
.IP \(bu 2
b1c3b84862 Merge pull request \fI\%#39610\fP from rallytime/bp\-39589
.IP \(bu 2
83ec174d44 Set utils property explicitly for FSClient
.IP \(bu 2
3889006149 Allow masterless minions to pull files from S3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39606\fP: (\fI\%rallytime\fP) [2016.11] Pylint: add missing import
@ \fI2017\-02\-23 16:39:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
fe15ed9b92 Merge pull request \fI\%#39606\fP from rallytime/lint\-2016.11
.IP \(bu 2
71164348e7 [2016.11] Pylint: add missing import
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39573\fP: (\fI\%thatch45\fP) Added a few more comments to the ssl docs
@ \fI2017\-02\-23 02:17:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39554\fP: (\fI\%DmitryKuzmenko\fP) Cosmetic: support bool value for \(aqssl\(aq config option. (refs: \fI\%#39573\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39528\fP: (\fI\%thatch45\fP) Add better ssl option docs (refs: \fI\%#39554\fP)
.IP \(bu 2
5987c4e30e Merge pull request \fI\%#39573\fP from thatch45/ssl_docs
.IP \(bu 2
b230c35eac This should be good to go now
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39577\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-02\-23 02:10:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
b8e321cbec Merge pull request \fI\%#39577\fP from rallytime/merge\-2016.11
.IP \(bu 2
397c756a01 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
8352e6b44b Merge pull request \fI\%#39579\fP from rallytime/fix\-lint
.INDENT 2.0
.IP \(bu 2
65889e1f30 [2016.3] Pylint: Remove unused import
.UNINDENT
.IP \(bu 2
43dba3254c Merge pull request \fI\%#39578\fP from cachedout/2016.3
.INDENT 2.0
.IP \(bu 2
344499eef7 Add mention\-bot configuration
.UNINDENT
.UNINDENT
.IP \(bu 2
c52cecd856 Fix syntax error leftover from incomplete merge\-conflict resolution
.IP \(bu 2
7b9b3f700d Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
8f7a0f9d96 Merge pull request \fI\%#39542\fP from twangboy/gate_ssh_known_hosts
.INDENT 2.0
.IP \(bu 2
c90a52ef27 Remove expensive check
.IP \(bu 2
6d645cae0e Add __virtual__ function
.UNINDENT
.IP \(bu 2
c10965833a Merge pull request \fI\%#39289\fP from bobrik/autodetect\-ipv6
.INDENT 2.0
.IP \(bu 2
2761a1b244 Move new kwargs to the end of argument list
.IP \(bu 2
0df6b922e7 Narrow down connection exception to socket.error
.IP \(bu 2
e8a2cc0488 Do no try to connect to salt master in syndic config test
.IP \(bu 2
af9578631e Properly log address that failed to resolve or pass connection check
.IP \(bu 2
9a34fbeba9 Actually connect to master instead of checking route availability
.IP \(bu 2
c494839c65 Avoid bare exceptions in dns_check
.IP \(bu 2
29f376676d Rewrite dns_check to try to connect to address
.IP \(bu 2
55965ce505 Autodetect IPv6 connectivity from minion to master
.UNINDENT
.IP \(bu 2
3fb928b63a Merge pull request \fI\%#39569\fP from s0undt3ch/2016.3
.INDENT 2.0
.IP \(bu 2
49da135abd Don\(aqt use our own six dictionary fixes in this branch
.UNINDENT
.IP \(bu 2
91e3319df8 Merge pull request \fI\%#39508\fP from dincamihai/openscap
.INDENT 2.0
.IP \(bu 2
9fedb84607 Always return oscap\(aqs stderr
.IP \(bu 2
0ecde2cd02 Include oscap returncode in response
.UNINDENT
.IP \(bu 2
fbe2194a93 Merge pull request \fI\%#39562\fP from terminalmage/issue30802
.INDENT 2.0
.IP \(bu 2
c50374041d Add ulimits to dockerng state/exec module
.IP \(bu 2
da42040c1a Try the docker\-py 2.0 client name first
.UNINDENT
.IP \(bu 2
01d4a84a2f dockerng.get_client_args: Fix path for endpoint config for some versions of docker\-py (\fI\%#39544\fP)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39574\fP: (\fI\%Ch3LL\fP) Update 2016.11.3 release notes
@ \fI2017\-02\-23 00:10:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
cff9334929 Merge pull request \fI\%#39574\fP from Ch3LL/update_release_notes
.IP \(bu 2
c0f8c35df7 fix reference to set in docs
.IP \(bu 2
663f6f159d add additional PRs to 2016.11.3 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39528\fP: (\fI\%thatch45\fP) Add better ssl option docs (refs: \fI\%#39554\fP)
@ \fI2017\-02\-22 18:29:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
b492f7094c Merge pull request \fI\%#39528\fP from thatch45/ssl_docs
.IP \(bu 2
c357e37831 Add minion config
.IP \(bu 2
539bb2aa80 Add better ssl option docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#35869\fP: (\fI\%amontalban\fP) timezone.system state fails on FreeBSD when /etc/localtime does not exists (refs: \fI\%#39532\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39532\fP: (\fI\%amontalban\fP) Fix case when /etc/localtime is a file and it is not updated
@ \fI2017\-02\-22 18:28:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
0dad49cdff Merge pull request \fI\%#39532\fP from amontalban/corner_case_35869
.IP \(bu 2
f0d3c16547 Fix case when /etc/localtime is a file and it is not updated
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39540\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-02\-22 18:24:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
9cfaf3b599 Merge pull request \fI\%#39540\fP from rallytime/merge\-2016.11
.IP \(bu 2
49fe4e891e Merge branch \(aq2016.11\(aq into \(aq2016.11\(aq
.IP \(bu 2
c613d19e76 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
dff35b58f8 Merge pull request \fI\%#39498\fP from terminalmage/pr\-39483
.INDENT 2.0
.IP \(bu 2
20b097a745 dockerng: compare sets instead of lists of security_opt
.UNINDENT
.IP \(bu 2
6418e725ed Merge pull request \fI\%#39497\fP from terminalmage/docker\-compat\-fixes
.INDENT 2.0
.IP \(bu 2
cbd0270bac docker: make docker\-exec the default execution driver
.IP \(bu 2
a6a17d58aa Handle docker\-py 2.0\(aqs new host_config path
.UNINDENT
.IP \(bu 2
9c4292fb4e Merge pull request \fI\%#39423\fP from dincamihai/openscap
.INDENT 2.0
.IP \(bu 2
9d13422ac1 OpenSCAP module
.UNINDENT
.IP \(bu 2
7dd2502360 Merge pull request \fI\%#39464\fP from gtmanfred/2016.3
.INDENT 2.0
.IP \(bu 2
f829d6f9fc skip false values from preferred_ip
.UNINDENT
.IP \(bu 2
db359ff2c3 Merge pull request \fI\%#39460\fP from cachedout/win_dism_test_fix
.INDENT 2.0
.IP \(bu 2
e652a45592 Fix mocks in win_disim tests
.UNINDENT
.IP \(bu 2
9dbfba9b57 Merge pull request \fI\%#39426\fP from morganwillcock/dism
.INDENT 2.0
.IP \(bu 2
a7d5118262 Return failure when package path does not exist
.UNINDENT
.IP \(bu 2
56162706e3 Merge pull request \fI\%#39431\fP from UtahDave/fix_grains.setval_performance
.INDENT 2.0
.IP \(bu 2
391bbecd90 add docs
.IP \(bu 2
709c197f84 allow sync_grains to be disabled on grains.setval
.UNINDENT
.IP \(bu 2
239e16e612 Merge pull request \fI\%#39405\fP from rallytime/fix\-39304
.INDENT 2.0
.IP \(bu 2
bd1fe03ce7 Update :depends: docs for boto states and modules
.UNINDENT
.IP \(bu 2
415102f346 Merge pull request \fI\%#39411\fP from rallytime/fix\-38762
.INDENT 2.0
.IP \(bu 2
e13febe58d Update external_cache docs with other configuration options
.UNINDENT
.IP \(bu 2
7e1803b617 Update docs on upstream EPEL7 pygit2/libgit2 issues (\fI\%#39421\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39554\fP: (\fI\%DmitryKuzmenko\fP) Cosmetic: support bool value for \(aqssl\(aq config option. (refs: \fI\%#39573\fP)
@ \fI2017\-02\-22 16:59:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39528\fP: (\fI\%thatch45\fP) Add better ssl option docs (refs: \fI\%#39554\fP)
.IP \(bu 2
56fe2f198e Merge pull request \fI\%#39554\fP from DSRCorporation/bugs/ssl_bool
.IP \(bu 2
7a6fc11291 Cosmetic: support bool value for \(aqssl\(aq config option.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39560\fP: (\fI\%vutny\fP) [CLOUD] Log error when private/public IP was not detected
@ \fI2017\-02\-22 16:49:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
cf37f83565 Merge pull request \fI\%#39560\fP from vutny/cloud\-detect\-ips
.IP \(bu 2
567bb50884 [CLOUD] Log error when private/public IP was not detected
.UNINDENT
.UNINDENT
.SS Salt 2016.11.5 Release Notes
.sp
Version 2016.11.5 is a bugfix release for \fI\%2016.11.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB82\fP
.IP \(bu 2
Total Issue References: \fB23\fP
.IP \(bu 2
Total PR References: \fB80\fP
.IP \(bu 2
Contributors: \fB32\fP (\fI\%BenoitKnecht\fP, \fI\%Ch3LL\fP, \fI\%DmitryKuzmenko\fP, \fI\%Enquier\fP, \fI\%SolarisYan\fP,
\fI\%UtahDave\fP, \fI\%alexproca\fP, \fI\%benediktwerner\fP, \fI\%bobrik\fP, \fI\%brd\fP, \fI\%cachedout\fP, \fI\%clinta\fP,
\fI\%corywright\fP, \fI\%cro\fP, \fI\%danlsgiga\fP, \fI\%drawsmcgraw\fP, \fI\%ezh\fP, \fI\%gtmanfred\fP, \fI\%isbm\fP, \fI\%jf\fP,
\fI\%jleproust\fP, \fI\%lorengordon\fP, \fI\%nevins\-b\fP, \fI\%oeuftete\fP, \fI\%peter\-funktionIT\fP, \fI\%rallytime\fP,
\fI\%rkgrunt\fP, \fI\%senthilkumar\-e\fP, \fI\%sjorge\fP, \fI\%skizunov\fP, \fI\%terminalmage\fP, \fI\%twangboy\fP)
.UNINDENT
.SS Patched Packages
.sp
Due to the critical nature of issue \fI\%issue 41230\fP we have decided to patch the
2016.11.5 packages with \fI\%PR 41244\fP\&. This issue affects all calls to a
salt\-minion if there is an ipv6 nameserver set on the minion\(aqs host. The
patched packages on repo.saltstack.com will divert from the v2016.11.5 tag and
pypi packages due to the patches applied to the packages.
.SS Changelog for v2016.11.4..v2016.11.5
.sp
\fIGenerated at: 2018\-05\-27 20:12:47 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#41134\fP: (\fI\%twangboy\fP) Fix \fIpkg.install\fP on Windows on 2016.11
@ \fI2017\-05\-09 15:10:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
a10f0146a4 Merge pull request \fI\%#41134\fP from twangboy/fix_get_msiexec
.IP \(bu 2
d808a60129 Remove redundant if statement
.IP \(bu 2
b4d6d5a927 Fix for version_num of None and Latest
.IP \(bu 2
0f31822a83 Fix problem when use_msiexec is a bool
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41100\fP: (\fI\%frogunder\fP) Exception occurred in runner jobs.list_jobs (refs: \fI\%#41102\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41102\fP: (\fI\%gtmanfred\fP) don\(aqt pass jid to list_jobs
@ \fI2017\-05\-08 17:45:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ecab68bb9 Merge pull request \fI\%#41102\fP from gtmanfred/2016.11
.IP \(bu 2
83057d0f0f don\(aqt pass jid to list_jobs
.IP \(bu 2
505cb45722 Merge branch \(aqfix\-file\-blockreplace\-diff\-in\-test\-mode\(aq of \fI\%https://github.com/L4rS6/salt\fP into L4rS6\-fix\-file\-blockreplace\-diff\-in\-test\-mode
.IP \(bu 2
de9f66b448 show chanages in file.blockreplace function in testing mode. also used same programming style as in file.managed function:   (ret[\(aqchanges\(aq][\(aqdiff\(aq] = ret[\(aqpchanges\(aq][\(aqdiff\(aq])
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41103\fP: (\fI\%lorengordon\fP) Adds a get_route() function to win_network.py
@ \fI2017\-05\-06 06:19:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
2af89beb53 Merge pull request \fI\%#41103\fP from lorengordon/win.get_route
.IP \(bu 2
93ce5644ea Adds test for win_network.get_route
.IP \(bu 2
b9cbbc0290 Adds a get_route() function to win_network.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41098\fP: (\fI\%rallytime\fP) Back\-port \fI\%#41088\fP to 2016.11
@ \fI2017\-05\-05 19:04:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41088\fP: (\fI\%sjorge\fP) Fix docs for zfs state module (refs: \fI\%#41098\fP)
.IP \(bu 2
2f9b5a4074 Merge pull request \fI\%#41098\fP from rallytime/bp\-41088
.IP \(bu 2
dc6cd2ea45 Fix docs for zfs state module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41097\fP: (\fI\%rallytime\fP) Back\-port \fI\%#41079\fP to 2016.11
@ \fI2017\-05\-05 19:03:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41079\fP: (\fI\%brd\fP) Remove an extra colon that is causing rendering issues (refs: \fI\%#41097\fP)
.IP \(bu 2
2123001f32 Merge pull request \fI\%#41097\fP from rallytime/bp\-41079
.IP \(bu 2
845b49c304 Remove and extra colon that is causing rendering issues
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41093\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-05\-05 17:22:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
ff6fa2b120 Merge pull request \fI\%#41093\fP from rallytime/merge\-2016.11
.IP \(bu 2
a670eaa1db Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
247400c44e Merge pull request \fI\%#41083\fP from rallytime/git\-state\-fix
.INDENT 2.0
.IP \(bu 2
b85ee48ff4 Git state: head_ref should be head_rev in \(dqlatest\(dq function
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41084\fP: (\fI\%rallytime\fP) Skip the test_salt_documentation_arguments_not_assumed test for Arch
@ \fI2017\-05\-04 21:56:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41074\fP: (\fI\%rallytime\fP) Skip integration.shell.matcher.MatchTest.test_salt_documentation test for Arch (refs: \fI\%#41084\fP)
.IP \(bu 2
4c2e636cd1 Merge pull request \fI\%#41084\fP from rallytime/disable\-matcher\-test\-arch
.IP \(bu 2
da811fe505 Skip the correct test for the matcher tests in Arch
.IP \(bu 2
b9d1ce9aed Revert \(dqSkip integration.shell.matcher.MatchTest.test_salt_documentation test for Arch\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41069\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-05\-04 20:34:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
1179720327 Merge pull request \fI\%#41069\fP from rallytime/merge\-2016.11
.IP \(bu 2
08c58919cb Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
69418092bd Merge pull request \fI\%#41070\fP from rallytime/lint\-2016.3
.INDENT 2.0
.IP \(bu 2
486e2ba62e Pylint: remove extra line in mac_system module
.UNINDENT
.UNINDENT
.IP \(bu 2
db70b2d42e Pylint: remove extra line in mac_system module
.IP \(bu 2
855d157aa6 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
3101694d71 Merge pull request \fI\%#41048\fP from willkil/mac_system_non_root
.INDENT 2.0
.IP \(bu 2
b65b82a750 mac_system: return False for non\-root user
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41074\fP: (\fI\%rallytime\fP) Skip integration.shell.matcher.MatchTest.test_salt_documentation test for Arch (refs: \fI\%#41084\fP)
@ \fI2017\-05\-04 19:26:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d638abc62 Merge pull request \fI\%#41074\fP from rallytime/disable\-matcher\-test\-arch
.IP \(bu 2
9eb482d5c7 Skip integration.shell.matcher.MatchTest.test_salt_documentation test for Arch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41078\fP: (\fI\%Ch3LL\fP) Add 2016.11.5 release notes and change log
@ \fI2017\-05\-04 19:00:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
72c854d9ac Merge pull request \fI\%#41078\fP from Ch3LL/add_2016.11.5_release
.IP \(bu 2
96ed815687 Add 2016.11.5 release notes and change log
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40879\fP: (\fI\%peter\-funktionIT\fP) Update win_pki.py
@ \fI2017\-05\-04 16:12:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
eac8401e90 Merge pull request \fI\%#40879\fP from peter\-funktionIT/2016.11
.IP \(bu 2
80fa9e5b76 Update win_pki.py
.IP \(bu 2
a48b05f158 Update win_pki.py
.IP \(bu 2
3a4e6d9d91 Update win_pki.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40928\fP: (\fI\%sokratisg\fP) Orchestration runner, highstate and environment question (refs: \fI\%#41036\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41036\fP: (\fI\%terminalmage\fP) Do not force effective saltenv when running states via orchestration
@ \fI2017\-05\-04 15:44:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
547a9738db Merge pull request \fI\%#41036\fP from terminalmage/issue40928
.IP \(bu 2
72ef34c420 Do not force effective saltenv when running states via orchestration
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41039\fP: (\fI\%terminalmage\fP) Look for currently\-running python\(aqs pip first
@ \fI2017\-05\-04 15:43:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
6e2458e171 Merge pull request \fI\%#41039\fP from terminalmage/improve\-pip\-bin
.IP \(bu 2
effe8b9432 Look for currently\-running python\(aqs pip first
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41049\fP: (\fI\%Ch3LL\fP) fix integration wheel test_gen test
@ \fI2017\-05\-04 15:33:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
ff39613a53 Merge pull request \fI\%#41049\fP from Ch3LL/fix_wheel_test
.IP \(bu 2
ba223827b9 fix integration wheel test_gen test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41054\fP: (\fI\%terminalmage\fP) Update package targets for Arch pkg tests
@ \fI2017\-05\-04 14:59:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
4e4b3514b4 Merge pull request \fI\%#41054\fP from terminalmage/salt\-jenkins\-315
.IP \(bu 2
ee493bae47 Update package targets for Arch pkg tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41046\fP: (\fI\%twangboy\fP) Fix pkg.remove
@ \fI2017\-05\-04 14:58:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
62dff52820 Merge pull request \fI\%#41046\fP from twangboy/fix_pkg_remove
.IP \(bu 2
2af38e5564 Use target instead of version_num
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41045\fP: (\fI\%terminalmage\fP) Clarify gitfs docs
@ \fI2017\-05\-03 22:24:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
2b47b7bec6 Merge pull request \fI\%#41045\fP from terminalmage/clarify\-gitfs\-docs
.IP \(bu 2
c757eda331 Clarify gitfs docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41032\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-05\-03 19:31:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
819007cd00 Merge pull request \fI\%#41032\fP from rallytime/merge\-2016.11
.IP \(bu 2
d26fd0bbf4 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
b00acb0034 Merge pull request \fI\%#41011\fP from terminalmage/docker\-refresh\-credentials
.INDENT 2.0
.IP \(bu 2
b8d1dcc307 Use proposed docker\-py reload_config() func
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35699\fP: (\fI\%jleproust\fP) LVM state fails to add new device, volume group name is empty string (refs: \fI\%#41007\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41007\fP: (\fI\%jleproust\fP) Recognize LVM2 pv with empty vg as orphan
@ \fI2017\-05\-03 18:24:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
d7fbd38474 Merge pull request \fI\%#41007\fP from jleproust/fix_lvm_empty_vg
.IP \(bu 2
3b9a845145 Recognize LVM2 pv with empty vg as orphan
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41029\fP: (\fI\%rallytime\fP) Back\-port \fI\%#38565\fP to 2016.11
@ \fI2017\-05\-03 17:05:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38565\fP: (\fI\%drawsmcgraw\fP) Update management of ip addresses for salt cloud azurearm module (refs: \fI\%#41029\fP)
.IP \(bu 2
4eab962e9e Merge pull request \fI\%#41029\fP from rallytime/bp\-38565
.IP \(bu 2
2df93ae3ab Update management of ip addresses. \- Assign static, private IP addresses. \- Ability to not assign a public IP to a VM.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41012\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-05\-02 22:06:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
97500f078d Merge pull request \fI\%#41012\fP from rallytime/merge\-2016.11
.IP \(bu 2
fc756c595c Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
19894f68ca Merge pull request \fI\%#40724\fP from cro/minion_key_revoke_cfg
.INDENT 2.0
.IP \(bu 2
cbc70195c0 Change message level when minion requests key revoke and feature is turned off.
.IP \(bu 2
65ea8997b7 Add allow_minion_key_revoke config option
.IP \(bu 2
8920495943 Add config option to prevent minions from revoking their own keys.
.UNINDENT
.IP \(bu 2
129859f79b Merge pull request \fI\%#40952\fP from terminalmage/fix\-dockerng.login\-docs
.INDENT 2.0
.IP \(bu 2
dfbbeb5946 Fix documentation for docker login function in pre\-nitrogen release branches
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40726\fP: (\fI\%benediktwerner\fP) Fixed minion keys remaining pending after auto signing and fixed typo (Resubmitted to 2016.3)
@ \fI2017\-05\-02 16:57:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
e210eaead4 Merge pull request \fI\%#40726\fP from benediktwerner/fix\-minions\-remain\-pending\-after\-autosign\-and\-typo
.IP \(bu 2
82c144e960 Fixed minion keys remaining pending after auto signing and fixed typo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40960\fP: (\fI\%danlsgiga\fP) Fix consul module \(dqAttributeError: \(aqdict\(aq object has no attribute \(aqjson\(aq\(dq
@ \fI2017\-05\-02 16:16:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
4f342e2fe5 Merge pull request \fI\%#40960\fP from danlsgiga/2016.11
.IP \(bu 2
6e4cc6db47 Fix consul module \(dqAttributeError: \(aqdict\(aq object has no attribute \(aqjson\(aq\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40963\fP: (\fI\%twangboy\fP) Fix fullname parameter for add function
@ \fI2017\-05\-02 16:08:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3b329b398 Merge pull request \fI\%#40963\fP from twangboy/fix_win_useradd
.IP \(bu 2
5371b6b85e Fix fullname parameter for add function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40995\fP: (\fI\%twangboy\fP) Remove unused code fragments
@ \fI2017\-05\-02 15:31:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
d79c033239 Merge pull request \fI\%#40995\fP from twangboy/remove_utils
.IP \(bu 2
8c01aacd9b Remove unused code fragments
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40981\fP: (\fI\%ezh\fP) docker\-events engine is broken with modern docker (refs: \fI\%#40982\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40991\fP: (\fI\%rallytime\fP) Back\-port \fI\%#40982\fP to 2016.11
@ \fI2017\-05\-01 22:31:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40982\fP: (\fI\%ezh\fP) Fix docker_events field handling (refs: \fI\%#40991\fP)
.IP \(bu 2
c6162876d6 Merge pull request \fI\%#40991\fP from rallytime/bp\-40982
.IP \(bu 2
8fcb7205db Fix docker_events field handling
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40965\fP: (\fI\%weirdbricks\fP) salt\-cloud sudo failing (refs: \fI\%#40987\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40987\fP: (\fI\%gtmanfred\fP) get sudo_password correctly
@ \fI2017\-05\-01 19:39:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
3fb24929c6 Merge pull request \fI\%#40987\fP from gtmanfred/2016.11
.IP \(bu 2
2ed694cac6 get sudo_password correctly
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40988\fP: (\fI\%santzi\fP) status.netdev tx_bytes is always zero (refs: \fI\%#40992\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40992\fP: (\fI\%gtmanfred\fP) fix bug in status.netdev
@ \fI2017\-05\-01 19:38:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
ecbac138d1 Merge pull request \fI\%#40992\fP from gtmanfred/netdev
.IP \(bu 2
a9eed7f1c9 fix bug in status.netdev
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40976\fP: (\fI\%sjorge\fP) smtp.send_msg state oddities (refs: \fI\%#40993\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40993\fP: (\fI\%gtmanfred\fP) smtp state can use profile or sender
@ \fI2017\-05\-01 19:35:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
d852320d34 Merge pull request \fI\%#40993\fP from gtmanfred/smtp
.IP \(bu 2
068ebfd9ec smtp state can use profile or sender
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40958\fP: (\fI\%rallytime\fP) Back\-port \fI\%#40939\fP to 2016.11
@ \fI2017\-04\-28 18:01:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40939\fP: (\fI\%Ch3LL\fP) Allow vmware to query deploy arg from opts (refs: \fI\%#40958\fP)
.IP \(bu 2
fc26fb8a05 Merge pull request \fI\%#40958\fP from rallytime/bp\-40939
.IP \(bu 2
3e9394862f allow vmware to query deploy arg from opts
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34640\fP: (\fI\%nevins\-b\fP) utils.shlex_split removing quotes which are required for augeas (refs: #\(gasaltstack/salt#34643\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#34643\fP: (\fI\%nevins\-b\fP) fix augeas module so shlex doesn\(aqt strip quotes (refs: \fI\%#38115\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40957\fP: (\fI\%rallytime\fP) Back\-port \fI\%#38115\fP to 2016.11
@ \fI2017\-04\-28 18:01:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38115\fP: (\fI\%cro\fP) Revert \(dqfix augeas module so shlex doesn\(aqt strip quotes\(dq (refs: \fI\%#40957\fP)
.IP \(bu 2
a586e12180 Merge pull request \fI\%#40957\fP from rallytime/bp\-38115
.IP \(bu 2
eb889173b0 Revert \(dqfix augeas module so shlex doesn\(aqt strip quotes\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40635\fP: (\fI\%promorphus\fP) Orchestrate + Batches returns false failed information (refs: \fI\%#40905\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40905\fP: (\fI\%rkgrunt\fP) Fixed issue with parsing of master minion returns when batching is en…
@ \fI2017\-04\-28 17:52:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
00a15eba60 Merge pull request \fI\%#40905\fP from rkgrunt/40635
.IP \(bu 2
4f9c92a012 Fixed issue with parsing of master minion returns when batching is enabled.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40954\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-04\-28 16:41:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb50d4f646 Merge pull request \fI\%#40954\fP from rallytime/merge\-2016.11
.IP \(bu 2
7f31e41aa6 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
55a399583e Merge pull request \fI\%#40930\fP from rallytime/bp\-40811
.INDENT 2.0
.IP \(bu 2
3ccb553f9f get config_dir based off conf_file
.UNINDENT
.IP \(bu 2
7bc01be859 Merge pull request \fI\%#40927\fP from terminalmage/docs
.INDENT 2.0
.IP \(bu 2
8c078f144c Add additional note about quoting within load_yaml
.IP \(bu 2
123b5cdc11 Add documentation for PyYAML\(aqs loading of time expressions
.UNINDENT
.IP \(bu 2
7eab9c6cf4 Merge pull request \fI\%#40891\fP from terminalmage/pip\-installed
.INDENT 2.0
.IP \(bu 2
75e6bc0aa3 Fix two issues with pip.install
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39531\fP: (\fI\%ypid\fP) Use yaml.safe_* instead of yaml.load / yaml.dump / … (refs: \fI\%#40751\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40751\fP: (\fI\%rallytime\fP) Use Salt\(aqs SaltYamlSafeLoader and SafeOrderedDumper classes for yaml.load/dump
@ \fI2017\-04\-28 12:56:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
909d519ddb Merge pull request \fI\%#40751\fP from rallytime/fix\-39531
.IP \(bu 2
85dc4164f5 Don\(aqt change the salt.utils.jinja yaml Dumper class
.IP \(bu 2
4fe6ac93c6 Add extra line for lint
.IP \(bu 2
55cfa12975 Use salt.utils.yamldumper with SafeOderedDumper as the Dumper in yaml.dump
.IP \(bu 2
62c4d37c2f Use salt.utils.yamlloader with SaltYamlSafeLoader as the Loader with yaml.load
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37307\fP: (\fI\%szjur\fP) Minions run every job twice and open 2 connections to the same syndic \- apparently after reconnection between masters (refs: \fI\%#40861\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40861\fP: (\fI\%DmitryKuzmenko\fP) Don\(aqt run status.master while minion is failing\-over.
@ \fI2017\-04\-28 12:14:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
18fdd8cc34 Merge pull request \fI\%#40861\fP from DSRCorporation/bugs/37307_minion_run_jobs_twice
.IP \(bu 2
f0d46d04af Don\(aqt run status.master while minion is failing\-over.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40923\fP: (\fI\%terminalmage\fP) aptpkg: fix temp pkg unhold when version is specified
@ \fI2017\-04\-28 11:59:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
62cb7b1ae6 Merge pull request \fI\%#40923\fP from terminalmage/aptpkg\-install\-fix\-unhold
.IP \(bu 2
6dda4f2bc3 aptpkg: fix temp pkg unhold when version is specified
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40908\fP: (\fI\%nicksloan\fP) If master_port is a string the minion cannot connect and prints an unhelpful error message (refs: \fI\%#40933\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#39118\fP: (\fI\%bobrik\fP) Minion ipv6 option is not documented (refs: \fI\%#39289\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40933\fP: (\fI\%gtmanfred\fP) allow master_port to be a string
@ \fI2017\-04\-28 11:54:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39289\fP: (\fI\%bobrik\fP) Autodetect IPv6 connectivity from minion to master (refs: \fI\%#40933\fP)
.IP \(bu 2
9d92ba7878 Merge pull request \fI\%#40933\fP from gtmanfred/2016.11
.IP \(bu 2
194423c08e allow master_port to be a string
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40912\fP: (\fI\%razed11\fP) IPV6 Warning when ipv6 set to False (refs: \fI\%#40934\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40934\fP: (\fI\%gtmanfred\fP) Only display IPvX warning if role is master
@ \fI2017\-04\-28 11:53:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
d5e0b8b655 Merge pull request \fI\%#40934\fP from gtmanfred/ipv6
.IP \(bu 2
7855cd6ce6 Only display IPvX warning if role is master
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40881\fP: (\fI\%stamak\fP) 2016.11 SoftLayer salt\-cloud driver connects on private IP instead of public IP (refs: \fI\%#40935\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40935\fP: (\fI\%gtmanfred\fP) Attempt to connect to public ip address in softlayer
@ \fI2017\-04\-28 11:43:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
8fdfe4ece6 Merge pull request \fI\%#40935\fP from gtmanfred/softlayer
.IP \(bu 2
d6eb11410f Attempt to connect to public ip address in softlayer
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40936\fP: (\fI\%terminalmage\fP) Add dockerng fixes to 2016.11.4 release notes
@ \fI2017\-04\-27 19:54:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
7404309bec Merge pull request \fI\%#40936\fP from terminalmage/release_notes
.IP \(bu 2
e494ae43e5 Add dockerng fixes to 2016.11.4 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33093\fP: (\fI\%gtmanfred\fP) [salt\-cloud][nova] race condition when assigning floating ips to cloud servers (refs: \fI\%#37696\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40929\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37696\fP to 2016.11
@ \fI2017\-04\-27 17:43:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37696\fP: (\fI\%SolarisYan\fP) if vm state is not ACTIVE, it will fail (refs: \fI\%#40929\fP)
.IP \(bu 2
a622518ad2 Merge pull request \fI\%#40929\fP from rallytime/bp\-37696
.IP \(bu 2
1a28722c5a Pylint fix
.IP \(bu 2
8e0a9864c5 if vm state is not ACTIVE, associate floating ip to it will fail.So we should wait for state of vm is ACTIVE,then associate the assigned floating ip to it
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40921\fP: (\fI\%corywright\fP) Make salt.auth.rest heading consistent with all other salt.auth documentation
@ \fI2017\-04\-27 17:36:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
f88ce8e4de Merge pull request \fI\%#40921\fP from corywright/consistent\-salt\-auth\-headings
.IP \(bu 2
2995a05c2b Make salt.auth.rest heading consistent with all other salt.auth documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37824\fP: (\fI\%dxiri\fP) SSLError Trying to use v3 API of Openstack Newton as provider. (refs: \fI\%#40752\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40752\fP: (\fI\%Enquier\fP) Add ability to specify a custom SSL certificate or disable SSL verification in KeystoneAuth v3
@ \fI2017\-04\-27 17:29:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
26be306b5c Merge pull request \fI\%#40752\fP from Enquier/nova_ssl_2
.IP \(bu 2
817f49296e fixing lint errors in keystone auth error
.IP \(bu 2
f683636c61 fix trailing whitespace
.IP \(bu 2
4a70b8c0cc fixing minor error in security_groups security groups parser had incorrect split action which caused errors
.IP \(bu 2
c9d6f8e5ed adding note in documentation
.IP \(bu 2
c24dfe3fba adding support for cacert verification
.IP \(bu 2
bfaf5e322d Merge pull request \fI\%#5\fP from saltstack/2016.11
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40845\fP: (\fI\%e\-senthilkumar\fP) /jobs call is broken in 2016.11.4 (refs: \fI\%#40894\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40894\fP: (\fI\%senthilkumar\-e\fP) Fix for broken /jobs/<jid> in 2016.11.4
@ \fI2017\-04\-27 11:33:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
0f2ec1e1db Merge pull request \fI\%#40894\fP from senthilkumar\-e/broken_jobs_api_fix
.IP \(bu 2
2f55b26e08 Fixing the pylint issue
.IP \(bu 2
fb607bab75 Fix for broken /jobs/<jid> in 2016.11.4
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40876\fP: (\fI\%BenoitKnecht\fP) states: sqlite3: fix table_present with multi\-line schema
@ \fI2017\-04\-26 15:21:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea55c15367 Merge pull request \fI\%#40876\fP from BenoitKnecht/fix\-sqlite3\-table\-present\-with\-multiline\-schema
.IP \(bu 2
2ca627d02d states: sqlite3: fix table_present with multi\-line schema
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40741\fP: (\fI\%clinta\fP) Regression in 2016.11.3. File.managed downloads every time. (refs: \fI\%#40742\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40742\fP: (\fI\%clinta\fP) Fix \fI\%#40741\fP
@ \fI2017\-04\-25 22:52:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
e09bafdceb Merge pull request \fI\%#40742\fP from clinta/40741
.IP \(bu 2
72bf5af9e6 Set sfn if cached_sum == source_sum
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40859\fP: (\fI\%skizunov\fP) Fix TCP Transport to work with Tornado 4.5
@ \fI2017\-04\-25 04:29:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
5249496f74 Merge pull request \fI\%#40859\fP from skizunov/develop2
.IP \(bu 2
958ecdace8 Fix TCP Transport to work with Tornado 4.5
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40862\fP: (\fI\%gtmanfred\fP) status should be an int
@ \fI2017\-04\-24 23:11:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca80f287af Merge pull request \fI\%#40862\fP from gtmanfred/2016.11
.IP \(bu 2
87ec1da771 status should be an int
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40865\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-04\-24 23:06:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
c95341959d Merge pull request \fI\%#40865\fP from rallytime/merge\-2016.11
.IP \(bu 2
53ad3159cc Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
2a71dc3552 Merge pull request \fI\%#40854\fP from Ch3LL/11.4_release_2016.3
.INDENT 2.0
.IP \(bu 2
889540a313 [2016.3] Bump latest release version to 2016.11.4
.UNINDENT
.IP \(bu 2
b5f67f0750 Merge pull request \fI\%#40822\fP from lordcirth/fix\-rsync\-changes
.INDENT 2.0
.IP \(bu 2
1b304bb476 Extra space before inline comment
.IP \(bu 2
ea4592de91 rsync.py: Don\(aqt return changes when clean
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40855\fP: (\fI\%Ch3LL\fP) [2016.11] Bump latest release version to 2016.11.4
@ \fI2017\-04\-24 17:37:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
7861f12df8 Merge pull request \fI\%#40855\fP from Ch3LL/11.4_release_2016.11
.IP \(bu 2
e7b604339d [2016.11] Bump latest release version to 2016.11.4
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40817\fP: (\fI\%isbm\fP) Some UT for cloud
@ \fI2017\-04\-23 10:01:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
25b62aee47 Merge pull request \fI\%#40817\fP from isbm/isbm\-skip\-false\-values\-from\-preferred\-ip\-201611
.IP \(bu 2
7c5714b90b Describe debug information
.IP \(bu 2
e0210ff8cb Reformat idents, fix typos
.IP \(bu 2
fb777e3f3e PEP8: fix unused variable
.IP \(bu 2
b2e85de85d Fix lint, typos and readability
.IP \(bu 2
116c96a4b7 Fix UT parameter changes
.IP \(bu 2
61558f08e7 Lintfix E0602
.IP \(bu 2
ed84420df0 Add unit test for node ip filtering
.IP \(bu 2
82582cff77 Skip test, if libcloud is not around
.IP \(bu 2
f005d53c56 Fix name error exception
.IP \(bu 2
b668e60b4c Move out nested function for testing purposes
.IP \(bu 2
5e574a24d9 Add unit test for nova connector
.IP \(bu 2
181d0780d0 Lintfix
.IP \(bu 2
8e9ce1a68d Move out nested function to be unit\-testable
.IP \(bu 2
cd43805770 Add initial unit test for openstack cloud module
.IP \(bu 2
177f31446d Add fake preferred IP function for testing
.IP \(bu 2
d1aeb13ac7 Move out openstack\(aqs nested function to be testable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40824\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-04\-21 20:03:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
50ddf219a6 Merge pull request \fI\%#40824\fP from rallytime/merge\-2016.11
.IP \(bu 2
f31f9512b8 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
3b9ebeb98f Merge pull request \fI\%#40754\fP from lordcirth/fix\-uppercase\-checksums
.INDENT 2.0
.IP \(bu 2
c80c792704 remove too many newlines for lint
.IP \(bu 2
a7d8f375e8 file.manage_file: uppercase checksums now work
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40811\fP: (\fI\%UtahDave\fP) get config_dir based off conf_file if __opts__[\(aqconfig_dir\(aq] doesn\(aqt exist (refs: \fI\%#40930\fP)
@ \fI2017\-04\-21 17:44:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
d6e26d18cb Merge pull request \fI\%#40811\fP from UtahDave/2016.11local
.IP \(bu 2
9f6e2e9c92 get config_dir based off conf_file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40820\fP: (\fI\%gtmanfred\fP) remove deprecated firstgen rackspace cloud driver
@ \fI2017\-04\-21 17:42:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
ddedf05b7d Merge pull request \fI\%#40820\fP from gtmanfred/2016.11
.IP \(bu 2
b60a8d013a remove rackspace from index
.IP \(bu 2
559aa1d8b6 remove deprecated firstgen rackspace cloud driver
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40797\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-04\-20 19:42:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
2ab42489df Merge pull request \fI\%#40797\fP from rallytime/merge\-2016.11
.IP \(bu 2
22500a7261 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
623e2eb61f Merge pull request \fI\%#40791\fP from a\-powell/s3\-util\-get\-memory\-fix
.INDENT 2.0
.IP \(bu 2
36f6521014 Merge remote\-tracking branch \(aqupstream/2016.3\(aq into s3\-util\-get\-memory\-fix
.IP \(bu 2
04637cd4eb Fixing objects being loaded into memory when performing a GET request with a local file specified.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40800\fP: (\fI\%rallytime\fP) Back\-port \fI\%#40720\fP to 2016.11
@ \fI2017\-04\-20 19:41:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40720\fP: (\fI\%oeuftete\fP) Call tornado.httputil.url_concat compatibly (refs: \fI\%#40800\fP)
.IP \(bu 2
ced839f841 Merge pull request \fI\%#40800\fP from rallytime/bp\-40720
.IP \(bu 2
6c0124ae21 Call tornado.httputil.url_concat compatibly
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19137\fP: (\fI\%jeffclay\fP) MSI installer(s) for windows minion (refs: \fI\%#40716\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40785\fP: (\fI\%alexproca\fP) win_pkg: backport 2016.11 add msiexec override to enable selection of 32 or 64 msiexec.exe
@ \fI2017\-04\-20 16:45:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40716\fP: (\fI\%alexproca\fP) win_pkg: add msiexec override to enable selection of 32 or 64 msiexec.exe (refs: \fI\%#40785\fP)
.IP \(bu 2
5388ffa7a2 Merge pull request \fI\%#40785\fP from alexproca/backport\-winexec\-selection
.IP \(bu 2
91cafd5094 Add option to select 32 or 64 version of msiexec
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40796\fP: (\fI\%terminalmage\fP) Fix inaccurate nodegroup docs
@ \fI2017\-04\-20 16:08:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
f0f135c71d Merge pull request \fI\%#40796\fP from terminalmage/fix\-nodegroup\-docs
.IP \(bu 2
f99259a6eb Fix inaccurate nodegroup docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40737\fP: (\fI\%jf\fP) Fix consul_pillar documentation: \(aqroot=\(aq canNOT start with a slash (refs: \fI\%#40760\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40769\fP: (\fI\%rallytime\fP) Back\-port \fI\%#40760\fP to 2016.11
@ \fI2017\-04\-19 20:23:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40760\fP: (\fI\%jf\fP) Fix \(aqroot=/...\(aq references in consul_pillar documentation: \(aqkeys should not start with a forward slash\(aq! (refs: \fI\%#40769\fP)
.IP \(bu 2
d8f78550d9 Merge pull request \fI\%#40769\fP from rallytime/bp\-40760
.IP \(bu 2
71ac15fc4c Fix \(aqroot=/...\(aq references in consul_pillar documentation: \(aqkeys should not start with a forward slash\(aq!
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40756\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-04\-19 17:47:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
61f8de43df Merge pull request \fI\%#40756\fP from rallytime/merge\-2016.11
.IP \(bu 2
0e087323f1 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
f4f3ee69ba Merge pull request \fI\%#40721\fP from gtmanfred/2016.3
.INDENT 2.0
.IP \(bu 2
58b88859b3 unset the bitwise instead of toggle
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29602\fP: (\fI\%multani\fP) cloud.action start raises \(dqgot an unexpected keyword argument \(aqkwargs\(aq\(dq (refs: \fI\%#40735\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40735\fP: (\fI\%rallytime\fP) Handle stacktraces in cloud.action function in module and runner
@ \fI2017\-04\-18 20:05:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
3557b5140e Merge pull request \fI\%#40735\fP from rallytime/handle\-cloud\-traces
.IP \(bu 2
87154a95a4 Use \fIlog.error\fP instead of \fIlog.err\fP
.IP \(bu 2
b35bf919a3 Handle stacktraces in cloud.action function in module and runner
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40745\fP: (\fI\%cro\fP) Backport \fIAdd support for specifying a datastore for new disks.\fP PR \fI\%#36457\fP
@ \fI2017\-04\-18 20:00:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36457\fP: (\fI\%cro\fP) Add support for specifying a datastore for new disks. (refs: \fI\%#40745\fP)
.IP \(bu 2
e700d8183b Merge pull request \fI\%#40745\fP from cro/vmware_disk_datastore_bp
.IP \(bu 2
1460f82ce4 Remove leftover conflict markers (oops! :\-/ )
.IP \(bu 2
b26be652dd Remove leftover conflict markers (oops! :\-/ )
.IP \(bu 2
096f063464 Remove leftover conflict markers (oops! :\-/ )
.IP \(bu 2
d24078d1a0 Add docs for \(dqdatastore\(dq param for disks
.IP \(bu 2
500d6b281d Document validity of a datastore key inside a disk definition.
.IP \(bu 2
7608b10225 Add support for specifying a datastore for new disks.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40740\fP: (\fI\%cro\fP) Backport pr \fI\%#39802\fP to add random_startup_delay
@ \fI2017\-04\-18 19:47:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39802\fP: (\fI\%cachedout\fP) A random startup delay option for minions (refs: \fI\%#40740\fP)
.IP \(bu 2
78dbab01dc Merge pull request \fI\%#40740\fP from cro/minion_delay_start
.IP \(bu 2
2ab95b7dd5 Set minion test to use default opts
.IP \(bu 2
785e6060a9 Add requested docs
.IP \(bu 2
8ab321f934 A random startup delay option for minions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40728\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-04\-17 21:13:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
a48ecc4a5c Merge pull request \fI\%#40728\fP from rallytime/merge\-2016.11
.IP \(bu 2
0a5e05a6e5 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
bf8bb0fde6 Merge pull request \fI\%#40719\fP from rallytime/bp\-40714
.INDENT 2.0
.IP \(bu 2
d6c436246b Make salt.modules.pw_user.get_loginclass return string rather than dict
.UNINDENT
.IP \(bu 2
4145d33e46 Merge pull request \fI\%#40718\fP from terminalmage/fix\-docstring
.IP \(bu 2
14e8b85da5 Fix copypasta in the pw_user docstring
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36967\fP: (\fI\%gmykhailiuta\fP) S3fs objects list gets truncated (refs: \fI\%#40707\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40707\fP: (\fI\%gtmanfred\fP) Use markers when s3 bucket list is truncated
@ \fI2017\-04\-17 16:45:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
c5cbfc2e63 Merge pull request \fI\%#40707\fP from gtmanfred/2016.11
.IP \(bu 2
1932f7265d Use markers when s3 bucket list is truncated
.UNINDENT
.UNINDENT
.SS Salt 2016.11.6 Release Notes
.sp
Version 2016.11.6 is a bugfix release for \fI\%2016.11.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB137\fP
.IP \(bu 2
Total Issue References: \fB58\fP
.IP \(bu 2
Total PR References: \fB153\fP
.IP \(bu 2
Contributors: \fB49\fP (\fI\%BenoitKnecht\fP, \fI\%Ch3LL\fP, \fI\%Enquier\fP, \fI\%F30\fP, \fI\%Foxlik\fP, \fI\%The\-Loeki\fP,
\fI\%UtahDave\fP, \fI\%abednarik\fP, \fI\%alex\-zel\fP, \fI\%arif\-ali\fP, \fI\%automate\-solutions\fP, \fI\%axmetishe\fP,
\fI\%bdrung\fP, \fI\%cachedout\fP, \fI\%cro\fP, \fI\%darenjacobs\fP, \fI\%dmurphy18\fP, \fI\%dschaller\fP, \fI\%epcim\fP,
\fI\%garethgreenaway\fP, \fI\%github\-abcde\fP, \fI\%gtmanfred\fP, \fI\%isbm\fP, \fI\%jettero\fP, \fI\%jmarinaro\fP, \fI\%kiorky\fP,
\fI\%lomeroe\fP, \fI\%lordcirth\fP, \fI\%lorengordon\fP, \fI\%lubyou\fP, \fI\%mcalmer\fP, \fI\%moio\fP, \fI\%onlyanegg\fP,
\fI\%peter\-funktionIT\fP, \fI\%pkazmierczak\fP, \fI\%pprkut\fP, \fI\%rallytime\fP, \fI\%ricohouse\fP, \fI\%seanjnkns\fP,
\fI\%sebw\fP, \fI\%skizunov\fP, \fI\%svinota\fP, \fI\%t0fik\fP, \fI\%terminalmage\fP, \fI\%tmeneau\fP, \fI\%tonybaloney\fP,
\fI\%twangboy\fP, \fI\%whiteinge\fP, \fI\%yannj\-fr\fP)
.UNINDENT
.SS Changelog for v2016.11.5..v2016.11.6
.sp
\fIGenerated at: 2018\-05\-27 20:18:17 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#41861\fP: (\fI\%twangboy\fP) Fix problems with get_rule and delete_rule
@ \fI2017\-06\-20 20:37:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
afc61ffe63 Merge pull request \fI\%#41861\fP from twangboy/fix_win_firewall
.IP \(bu 2
78892074f5 Fix problems with get_rule and delete_rule
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41778\fP: (\fI\%frogunder\fP) 2016.11.6 \- TCP Transport gives Exception (refs: \fI\%#41787\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41787\fP: (\fI\%skizunov\fP) Fix \fI\%#41778\fP
@ \fI2017\-06\-20 20:11:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41436\fP: (\fI\%skizunov\fP) TCP transport: Fix occasional errors when using salt command (refs: \fI\%#41787\fP)
.IP \(bu 2
938d4fddf1 Merge pull request \fI\%#41787\fP from skizunov/develop3
.IP \(bu 2
2ffd20cede Fix \fI\%#41778\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41812\fP: (\fI\%skizunov\fP) TCP: Fix salt\-master in bad state if remote side closed connection
@ \fI2017\-06\-20 19:46:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
03b6ae5ea8 Merge pull request \fI\%#41812\fP from skizunov/develop4
.IP \(bu 2
736420eb83 TCP: Fix salt\-master in bad state if remote side closed connection
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41857\fP: (\fI\%dmurphy18\fP) Modified support for deprecated netstat being removed by utilizing ss
@ \fI2017\-06\-20 18:46:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
cf2252bcea Merge pull request \fI\%#41857\fP from dmurphy18/netstat_fix
.IP \(bu 2
017fbdbc53 Modified support for deprecated netstat being removed by utilizing ss
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40878\fP: (\fI\%joewreschnig\fP) SSH modules spam warning about MD5 fingerprints when there aren\(aqt any (refs: \fI\%#41837\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#40005\fP: (\fI\%vutny\fP) \fIssh_known_hosts.present\fP does not support SHA256 key fingerprints (refs: \fI\%#40543\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41837\fP: (\fI\%rallytime\fP) Add fingerpint_hash_type option to ssh_auth state and related functions
@ \fI2017\-06\-20 18:14:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40543\fP: (\fI\%rallytime\fP) Add the \(dqfingerprint_hash_type\(dq option to ssh state and module (refs: \fI\%#41837\fP)
.IP \(bu 2
12ec5f9f23 Merge pull request \fI\%#41837\fP from rallytime/fix\-40878
.IP \(bu 2
48ff5d2a62 Add fingerpint_hash_type option to ssh_auth state and related functions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41839\fP: (\fI\%cro\fP) Extend proxy to jinja
@ \fI2017\-06\-19 23:03:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
e7fc30f482 Merge pull request \fI\%#41839\fP from cro/extend_proxy_to_jinja
.IP \(bu 2
172d3520ea Merge branch \(aqextend_proxy_to_jinja\(aq of github.com:cro/salt into extend_proxy_to_jinja
.INDENT 2.0
.IP \(bu 2
2e4a0633da Extend __proxy__ to jinja as \fIproxy\fP (like __salt__\->salt)
.UNINDENT
.IP \(bu 2
2ffad2af35 Extend __proxy__ to jinja as \fIproxy\fP (like __salt__\->salt)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41733\fP: (\fI\%sumeetisp\fP) Salt Rest Api call (refs: \fI\%#41786\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#40845\fP: (\fI\%e\-senthilkumar\fP) /jobs call is broken in 2016.11.4 (refs: \fI\%#41786\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38962\fP: (\fI\%gstachowiak\fP) Broken /jobs in salt\-api in salt 2016.11.1 (Carbon) (refs: \fI\%#39472\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41786\fP: (\fI\%whiteinge\fP) Runner arg parsing regressions
@ \fI2017\-06\-19 23:00:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39472\fP: (\fI\%whiteinge\fP) Update _reformat_low to not run kwarg dicts through parse_input (refs: \fI\%#41786\fP)
.IP \(bu 2
58387b127a Merge pull request \fI\%#41786\fP from whiteinge/runner\-arg\-parsing\-regressions
.IP \(bu 2
bf15c0bb5f Restore sending __current_eauth_* through to the function
.IP \(bu 2
6be975da2c Fix regressions from not calling load_args_and_kwargs
.IP \(bu 2
9d1cc1a176 Add test to check that runners ignore invalid kwargs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41776\fP: (\fI\%gtmanfred\fP) npm 5.0.0 added a second line after fsevents
@ \fI2017\-06\-19 16:53:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
be0e9abedb Merge pull request \fI\%#41776\fP from gtmanfred/2016.11
.IP \(bu 2
733a2279ca npm 5.0.0 added a second line after fsevents
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32400\fP: (\fI\%rallytime\fP) Document Default Config Values (refs: \fI\%#41783\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41783\fP: (\fI\%rallytime\fP) Add a bunch of config options to the various master/minion files that are missing
@ \fI2017\-06\-19 16:42:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
d94d4e4d19 Merge pull request \fI\%#41783\fP from rallytime/config\-doc\-updates
.IP \(bu 2
c828ad803a Add a bunch of config options to the various master/minion files that are missing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41816\fP: (\fI\%twangboy\fP) Upgrade psutil to version 5.2.2
@ \fI2017\-06\-17 01:51:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
2c681887d3 Merge pull request \fI\%#41816\fP from twangboy/update_psutil_req
.IP \(bu 2
8b4e3ad77d Upgrade psutil to version 5.2.2
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41785\fP: (\fI\%UtahDave\fP) Using master tops without a top.sls file causes extra errors in minion log (refs: \fI\%#41803\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41803\fP: (\fI\%terminalmage\fP) Don\(aqt log an error when no top.sls is found
@ \fI2017\-06\-16 22:49:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e5fe7ca4b Merge pull request \fI\%#41803\fP from terminalmage/issue41785
.IP \(bu 2
f9f4d49f05 Don\(aqt log an error when no top.sls is found
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41801\fP: (\fI\%terminalmage\fP) Don\(aqt take hostname from name param when creating docker container (2016.11 branch)
@ \fI2017\-06\-16 17:02:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
d12bc4ee68 Merge pull request \fI\%#41801\fP from terminalmage/issue41781\-2016.11
.IP \(bu 2
8236d3e1c3 Don\(aqt take hostname from name param when creating docker container (2016.11 branch)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41768\fP: (\fI\%rallytime\fP) Manually back\-port the changes in PR \fI\%#41615\fP
@ \fI2017\-06\-15 20:41:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41615\fP: (\fI\%Ch3LL\fP) Fix get_hwclock_aix test on MacOSX (refs: \fI\%#41768\fP)
.IP \(bu 2
87e2e72d94 Merge pull request \fI\%#41768\fP from rallytime/bp\-41615
.IP \(bu 2
b6cc0b6bf0 Manually backport the changes in PR \fI\%#41615\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41740\fP: (\fI\%terminalmage\fP) Fix spurious error when glob/regex used in publisher_acl
@ \fI2017\-06\-15 15:14:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
36cb223ab2 Merge pull request \fI\%#41740\fP from terminalmage/zd1532
.IP \(bu 2
e5f3d08751 Fix spurious error when glob/regex used in publisher_acl
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41749\fP: (\fI\%terminalmage\fP) Fix bug in pkg_resource.parse_targets when version passed
@ \fI2017\-06\-15 15:05:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
126a36747b Merge pull request \fI\%#41749\fP from terminalmage/parse_targets
.IP \(bu 2
698806fb09 No need to manually create pkg_params dict when name and version passed
.IP \(bu 2
7484bcc6c6 parse_targets: include version in packed return data
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41753\fP: (\fI\%rallytime\fP) Back\-port \fI\%#41449\fP to 2016.11
@ \fI2017\-06\-14 22:16:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41449\fP: (\fI\%sebw\fP) Fix state \(dqsvn.latest\(dq diff output in test mode (refs: \fI\%#41753\fP)
.IP \(bu 2
2c24012ded Merge pull request \fI\%#41753\fP from rallytime/bp\-41449
.IP \(bu 2
fae41c2875 Adjusting SVN unit test
.IP \(bu 2
eac6b151eb Improved SVN output in test mode
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41750\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-06\-14 22:15:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
e685858269 Merge pull request \fI\%#41750\fP from rallytime/merge\-2016.11
.IP \(bu 2
89834e49c2 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
c5a79a1ea6 Merge pull request \fI\%#41695\fP from xiaoanyunfei/fixRecursion
.INDENT 2.0
.IP \(bu 2
c54fde69a0 fix spell error
.IP \(bu 2
bc855b4711 fix swallow exception
.IP \(bu 2
c0b1f57fc0 add exception
.IP \(bu 2
aacf9f0a44 fix  maximum recursion depth exceeded
.UNINDENT
.IP \(bu 2
4b43ba3366 Merge pull request \fI\%#41585\fP from cro/sign_minion_messages
.INDENT 2.0
.IP \(bu 2
628f709c3c Correct test\-\-caching requires files on disk but the test just supplies what would have been read from disk.
.IP \(bu 2
687872a488 Lint
.IP \(bu 2
dadf4b851c Add documentation to the example master and minion configuration files. Move
minion event signing to a saner place. Enable dropping messages when signature does not
verify or when minion is not adding the signature to its payloads.
.IP \(bu 2
e44673cdae Add caching of key.
.IP \(bu 2
c3917d1e91 Fat finger fix.
.IP \(bu 2
3b9326fda7 Sign_minion_messages support
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41756\fP: (\fI\%Ch3LL\fP) Add Change Log to 2016.11.6 Release Notes
@ \fI2017\-06\-14 20:57:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
36cc8f1e35 Merge pull request \fI\%#41756\fP from Ch3LL/2016.11.6_release
.IP \(bu 2
fa368f21ac Add Change Log to 2016.11.6 Release Notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40155\fP: (\fI\%grichmond\-salt\fP) State module boto_vpc not working with boto 2 (refs: \fI\%#41692\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41692\fP: (\fI\%rallytime\fP) Add boto and boto3 version dependencies to boto_vpc state docs
@ \fI2017\-06\-14 19:05:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
edcafc6a26 Merge pull request \fI\%#41692\fP from rallytime/fix\-40155
.IP \(bu 2
539c1b0692 Add boto and boto3 version dependencies to boto_vpc state docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39918\fP: (\fI\%kivoli\fP) Enabling list merging leads to multiplying of unique list items (refs: \fI\%#40902\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40902\fP: (\fI\%lorengordon\fP) Removes duplicates when merging pillar lists and adds pillar.get override for pillar_merge_lists
@ \fI2017\-06\-14 18:39:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
bdaeb55a77 Merge pull request \fI\%#40902\fP from lorengordon/pillar\-get\-merge\-lists
.IP \(bu 2
6e35673fe3 Preserves order when removing duplicates
.IP \(bu 2
18eda7084c Updates list merge tests to check for sorted, unique lists
.IP \(bu 2
74bf91f99e Sorts the list when removing duplicates
.IP \(bu 2
26a4b1b17f Adds pillar.get param to control list merge/overwrite behavior
.IP \(bu 2
ed04bae94c Removes duplicate values when merging lists
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32743\fP: (\fI\%tonybaloney\fP) Issue with salt\-cloud on OpenSUSE (refs: \fI\%#41723\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41723\fP: (\fI\%rallytime\fP) Support apache\-libcloud work\-around for issue \fI\%#32743\fP for versions older than 2.0.0
@ \fI2017\-06\-14 17:13:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40837\fP: (\fI\%tonybaloney\fP) Upgrade apache\-libcloud package dependency for 2.0 (refs: \fI\%#41723\fP)
.IP \(bu 2
203ec6730f Merge pull request \fI\%#41723\fP from rallytime/libcloud\-support
.IP \(bu 2
1e9a06000b Bump version check down to 1.4.0 and use distutils.version lib
.IP \(bu 2
a30f654b04 Support apache\-libcloud work\-around for issue \fI\%#32743\fP for versions older than 2.0.0
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41654\fP: (\fI\%Enquier\fP) Nova Cloud module doesn\(aqt work for python\-novaclient 8.0.0+ (refs: \fI\%#41655\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41655\fP: (\fI\%Enquier\fP) Allow Nova cloud module to set a specific floating ip address
@ \fI2017\-06\-14 16:44:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
62dbf5083c Merge pull request \fI\%#41655\fP from Enquier/nova\-cloud\-set_ip_address
.IP \(bu 2
293bc64158 Removed empty debug log
.IP \(bu 2
3d9871fe11 Cleaning up, removing debugging tests
.IP \(bu 2
c78e5feea9 Fixing error message
.IP \(bu 2
404dffb6b8 Debugging variable format
.IP \(bu 2
6fa3b976a5 removing string call
.IP \(bu 2
005995e1b0 modifying variable calls
.IP \(bu 2
9e5e7a38ec Testing variable changes
.IP \(bu 2
05e240f37f Debugging Format of floating_ip variable
.IP \(bu 2
366aca00a8 Adding Max version check for Nova since Cloud no longer operates at higher versions
.IP \(bu 2
6f66c9d10c Fixing response of  floating_ip_show to align with other floating ip\(aqs. Spelling fix
.IP \(bu 2
58459adbe8 Adding ability to set a Floating IP by a specific IP address
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41731\fP: (\fI\%terminalmage\fP) Clarify that archive_format is required pre\-2016.11.0
@ \fI2017\-06\-14 15:05:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
82eab84883 Merge pull request \fI\%#41731\fP from terminalmage/docs
.IP \(bu 2
d3f4ea1a84 Clarify that archive_format is required pre\-2016.11.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41663\fP: (\fI\%skizunov\fP) Don\(aqt invoke lspci if enable_lspci is False
@ \fI2017\-06\-13 21:19:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
b6d27beac2 Merge pull request \fI\%#41663\fP from skizunov/develop3
.IP \(bu 2
154d6ce59e Don\(aqt invoke lspci if enable_lspci is False
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40446\fP: (\fI\%sumeetisp\fP) [Documentation] include list of kwargs for ec2.create_volume in cloud driver (refs: \fI\%#41693\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41693\fP: (\fI\%rallytime\fP) Document available kwargs for ec2.create_volume function
@ \fI2017\-06\-13 19:51:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
46b8d5dc4b Merge pull request \fI\%#41693\fP from rallytime/fix\-40446
.IP \(bu 2
569eb2bf7e Document available kwargs for ec2.create_volume function
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41691\fP: (\fI\%jdonofrio728\fP) Can\(aqt pass integers as cmd.run environment variables (refs: \fI\%#41696\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41696\fP: (\fI\%terminalmage\fP) Handle a few edge/corner cases with non\-string input to cmd.run
@ \fI2017\-06\-13 18:48:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
aab55d304a Merge pull request \fI\%#41696\fP from terminalmage/issue41691
.IP \(bu 2
0623e40d33 Apparently some funcs are passing tuples to cmd.run_*
.IP \(bu 2
cdbfb94cfe Handle a few edge/corner cases with non\-string input to cmd.run
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41697\fP: (\fI\%terminalmage\fP) Resubmit \fI\%#41545\fP against 2016.11 branch
@ \fI2017\-06\-13 16:10:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41545\fP: (\fI\%kiorky\fP) Make print_cli resilient on slow systems (refs: \fI\%#41697\fP)
.IP \(bu 2
97897d7a7a Merge pull request \fI\%#41697\fP from terminalmage/pr\-41545
.IP \(bu 2
faaacf88bf Use error name instead of error number
.IP \(bu 2
7eacda5cbf Make print_cli resilient on slow systems
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40605\fP: (\fI\%sumeetisp\fP) Salt\-run manage.bootstrap (refs: \fI\%#41711\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41711\fP: (\fI\%rallytime\fP) Update deprecated version info in manage.bootstrap func for root_user
@ \fI2017\-06\-13 16:04:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
09260d7c08 Merge pull request \fI\%#41711\fP from rallytime/fix\-40605
.IP \(bu 2
903c2ffca5 Update deprecated version info in manage.bootstrap fucn for root_user
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39668\fP: (\fI\%mirceaulinic\fP) Master scheduled job not recorded on the event bus (refs: \fI\%#41658\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41658\fP: (\fI\%garethgreenaway\fP) Fixes to the salt scheduler
@ \fI2017\-06\-13 16:00:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
d563b3e345 Merge pull request \fI\%#41658\fP from garethgreenaway/39668_schedule_runners_fire_events
.IP \(bu 2
d688a1cd88 Enable jobs scheduled on the master to fire their return data to the event bus
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41706\fP: (\fI\%twangboy\fP) Add missing batch files
@ \fI2017\-06\-13 15:32:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
3c3b9343b7 Merge pull request \fI\%#41706\fP from twangboy/batch_files
.IP \(bu 2
0d4be0220b Add batch files for master
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41710\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-06\-13 15:11:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
1afc4adc5a Merge pull request \fI\%#41710\fP from rallytime/merge\-2016.11
.IP \(bu 2
5150916556 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
5058b0de1f Merge pull request \fI\%#41707\fP from terminalmage/master\-tops\-docs
.INDENT 2.0
.IP \(bu 2
6ec9dfb7f3 Update version in master\-tops docs
.UNINDENT
.IP \(bu 2
1c1964d807 Merge pull request \fI\%#41689\fP from yannj\-fr/fix\-41688
.INDENT 2.0
.IP \(bu 2
a47eddccd2 Fix \fI\%#41688\fP : fix mkfs command linux\-swap support
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41702\fP: (\fI\%gtmanfred\fP) npm 5 and greater requires \-\-force for cache clean
@ \fI2017\-06\-12 23:21:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
5d763b9b7f Merge pull request \fI\%#41702\fP from gtmanfred/2016.11
.IP \(bu 2
8bd19fcc17 fix version number
.IP \(bu 2
0fa380f75c npm 5 and greater requires \-\-force for cache clean
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41668\fP: (\fI\%yannj\-fr\fP) Parted modules mkfs command does not work with NTFS (refs: \fI\%#41670\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41704\fP: (\fI\%rallytime\fP) Back\-port \fI\%#41670\fP to 2016.11
@ \fI2017\-06\-12 23:20:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41670\fP: (\fI\%yannj\-fr\fP) fixes \fI\%#41668\fP ntfs case problem in parted module (refs: \fI\%#41704\fP)
.IP \(bu 2
f6519e7f80 Merge pull request \fI\%#41704\fP from rallytime/bp\-41670
.IP \(bu 2
8afc8792d1 fixes \fI\%#41668\fP ntfs case problem in parted module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39939\fP: (\fI\%martinschipper\fP) Relative symlinks are changed with file.recurse 2016.11.3 (refs: \fI\%#41700\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41700\fP: (\fI\%terminalmage\fP) roots: return actual link destination when listing symlinks
@ \fI2017\-06\-12 22:07:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
0b89377dce Merge pull request \fI\%#41700\fP from terminalmage/issue39939
.IP \(bu 2
bdbb265a0b roots: return actual link destination when listing symlinks
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41699\fP: (\fI\%rallytime\fP) Remove note about version incompatibility with salt\-cloud
@ \fI2017\-06\-12 19:44:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
7cf47f9651 Merge pull request \fI\%#41699\fP from rallytime/troubleshooting\-doc\-update
.IP \(bu 2
c91ca5f809 Remove note about version incompatibility with salt\-cloud
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40410\fP: (\fI\%DarrenDai\fP) Targeting Minions by IP Range via restful API doesn\(aqt work (refs: \fI\%#41694\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41694\fP: (\fI\%rallytime\fP) Add ipcidr options to \(dqAllowed Values\(dq list in LocalClient expr_form docs
@ \fI2017\-06\-12 19:06:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
d68a6316b8 Merge pull request \fI\%#41694\fP from rallytime/fix\-40410
.IP \(bu 2
6de9da1d5d Add ipcidr options to \(dqAllowed Values\(dq list in LocalClient expr_form docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41365\fP: (\fI\%lubyou\fP) file.managed chokes on windows paths when source_hash is set to the URI of a file that contains source hash strings (refs: \fI\%#41659\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41659\fP: (\fI\%lubyou\fP) Use re.escape to escape paths before handing them to re.match
@ \fI2017\-06\-12 18:10:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
80d4a3ab98 Merge pull request \fI\%#41659\fP from lubyou/41365\-fix\-file\-managed
.IP \(bu 2
d49a1579b0 Use re.escape to escape paths, before handing them to re.match
.IP \(bu 2
ac240facca use correct variable
.IP \(bu 2
c777eba2c1 Use re.escape to escape paths, before handing them to re.match
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41661\fP: (\fI\%whiteinge\fP) Add note about avoiding the \fI\-i\fP flag for the /keys endpoint
@ \fI2017\-06\-09 15:03:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
564d5fd9d3 Merge pull request \fI\%#41661\fP from whiteinge/rest_cherrypy\-keys\-headers
.IP \(bu 2
a66ffc9d3e Add note about avoiding the \fI\-i\fP flag for the /keys endpoint
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41651\fP: (\fI\%Sakorah\fP) pkg.installed fails when unholding and test=true (refs: \fI\%#41660\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41660\fP: (\fI\%garethgreenaway\fP) Fix to modules/aptpkg.py for unheld
@ \fI2017\-06\-09 14:53:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
38424f3e3e Merge pull request \fI\%#41660\fP from garethgreenaway/41651_fixing_aptpkg_held_unheld_with_test
.IP \(bu 2
30da2370a4 Fix when test=True and packages were being set to unheld.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41656\fP: (\fI\%rallytime\fP) Back\-port \fI\%#41575\fP to 2016.11
@ \fI2017\-06\-08 22:43:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41575\fP: (\fI\%dschaller\fP) Fix 41562 (refs: \fI\%#41656\fP)
.IP \(bu 2
a308b960d8 Merge pull request \fI\%#41656\fP from rallytime/bp\-41575
.IP \(bu 2
4374e6b034 Replace \(dqtbd\(dq with release version information
.IP \(bu 2
81413896d1 Lint: Add index numbers to format {} calls
.IP \(bu 2
384570384e only list top level npm modules during {un)install
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41456\fP: (\fI\%bdrung\fP) Fix pkgrepo.managed always return changes for test=true
@ \fI2017\-06\-08 18:21:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
e6d37b5f3e Merge pull request \fI\%#41456\fP from bdrung/fix\-pkgrepo.managed\-changes\-check
.IP \(bu 2
d3ce7bf05f Fix pkgrepo.managed always return changes for test=true
.IP \(bu 2
1592687294 Document aptpkg architectures parameter
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41478\fP: (\fI\%jf\fP) security / information leak with consul pillar when substitution values are not present (refs: \fI\%#41530\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41530\fP: (\fI\%gtmanfred\fP) Set default for consul_pillar to None
@ \fI2017\-06\-08 18:13:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
721e5b6cb9 Merge pull request \fI\%#41530\fP from gtmanfred/2016.11
.IP \(bu 2
2a4633ce16 Set default for consul_pillar to None
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41629\fP: (\fI\%lubyou\fP) salt.states.cmd.script: Parameter \(dqargs\(dq is overwritten if \(dqname/id\(dq contains spaces (refs: \fI\%#41638\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41638\fP: (\fI\%gtmanfred\fP) don\(aqt overwrite args if they are passed to the script
@ \fI2017\-06\-08 17:48:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
8926d1c731 Merge pull request \fI\%#41638\fP from gtmanfred/cmdscript
.IP \(bu 2
6c7d68b97d don\(aqt overwrite args if they are passed to the script
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41639\fP: (\fI\%dmurphy18\fP) Update notrim check, netstat takes minutes if large number connections
@ \fI2017\-06\-07 23:03:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
ecb09b8694 Merge pull request \fI\%#41639\fP from dmurphy18/minion_netstat_check
.IP \(bu 2
7ab3319090 Update notrim check, netstat takes minutes if large number connections \- 260K
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38894\fP: (\fI\%amendlik\fP) salt.runner and salt.wheel ignore test=True (refs: \fI\%#41309\fP, \fI\%#41611\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41611\fP: (\fI\%garethgreenaway\fP) Additional fixes to states/saltmod.py
@ \fI2017\-06\-07 22:58:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
2913a33b27 Merge pull request \fI\%#41611\fP from garethgreenaway/41309_right_return_res
.IP \(bu 2
fda41ede76 Updating result values to be None for test cases.
.IP \(bu 2
003f2d9323 Following the documentation, when passed the test=True argument the runner and wheel functions should return a result value of False.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41626\fP: (\fI\%ruiaylin\fP) When onlyif and bg are used together the (refs: \fI\%#41637\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41637\fP: (\fI\%gtmanfred\fP) never run bg for onlyif or unless cmd states
@ \fI2017\-06\-07 17:37:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
334a5fc2a0 Merge pull request \fI\%#41637\fP from gtmanfred/cmd
.IP \(bu 2
40fb6c6249 never run bg for onlyif or unless cmd states
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41255\fP: (\fI\%lordcirth\fP) linux_syctl.default_config(): only return path, don\(aqt create it
@ \fI2017\-06\-07 14:13:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
34dd9ea862 Merge pull request \fI\%#41255\fP from lordcirth/fix\-sysctl\-test\-11
.IP \(bu 2
0089be4440 linux_sysctl: use dirname() as suggested
.IP \(bu 2
262d95e41d linux_syctl.default_config(): only return path, don\(aqt create it
.IP \(bu 2
277232b3ac linux_sysctl.persist(): create config dir if needed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35481\fP: (\fI\%giany\fP) global_identifier does not work when using Softlayer driver (refs: \fI\%#41551\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41616\fP: (\fI\%rallytime\fP) Back\-port \fI\%#41551\fP to 2016.11
@ \fI2017\-06\-06 22:44:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41551\fP: (\fI\%darenjacobs\fP) Update __init__.py (refs: \fI\%#41616\fP)
.IP \(bu 2
4cf577771b Merge pull request \fI\%#41616\fP from rallytime/bp\-41551
.IP \(bu 2
53bca96328 Update __init__.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41552\fP: (\fI\%Enquier\fP) Adding logic so that update_floatingip can disassociate floatingip\(aqs
@ \fI2017\-06\-06 18:25:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
846ca54688 Merge pull request \fI\%#41552\fP from Enquier/neutron\-floatingip\-remove
.IP \(bu 2
aeed51c1e3 Adding port=None default and documentation
.IP \(bu 2
fcce05e1e4 Adding logic so that update_floatingip can disassociate floatingip\(aqs Previously update_floatingip would cause an error if port is set to None.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41569\fP: (\fI\%gtmanfred\fP) Check all entries in result
@ \fI2017\-06\-06 18:18:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
b720ecb732 Merge pull request \fI\%#41569\fP from gtmanfred/fix_test_result_check
.IP \(bu 2
19ea5481b6 remove test that never passed
.IP \(bu 2
e2a4d5e1e2 Check all entries in result
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41540\fP: (\fI\%UtahDave\fP) archive.extracted fails on second run (refs: \fI\%#41599\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41599\fP: (\fI\%garethgreenaway\fP) Fixes to modules/archive.py
@ \fI2017\-06\-06 18:02:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
d9546c6283 Merge pull request \fI\%#41599\fP from garethgreenaway/41540_fixes_to_archive_module
.IP \(bu 2
66a136e6d8 Fixing issues raised in \fI\%#41540\fP when a zip file is created on a Windows system.
The issue has two parts, first directories that end up in the archive end up in the results of
aarchive.list twice as they show up as both files and directories because of the logic to
handle the fact that Windows doesn\(aqt mark them as directories. This issue shows up when an
extraction is run a second time since the module verified the file types and the subdirectory
is not a file. The second issue is related to permissions, if Salt is told to extract
permissions (which is the default) then the directory and files end up being unreadable since
the permissions are not available. This change sets the permissions to what the default umask
for the user running Salt is.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40950\fP: (\fI\%idokaplan\fP) Import certificate (refs: \fI\%#41453\fP, \fI\%#41383\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41453\fP: (\fI\%peter\-funktionIT\fP) Update win_pki.py
@ \fI2017\-06\-06 17:15:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41383\fP: (\fI\%peter\-funktionIT\fP) Update win_pki.py (refs: \fI\%#41453\fP)
.IP \(bu 2
10ac80ee96 Merge pull request \fI\%#41453\fP from peter\-funktionIT/fix_win_pki_state_import_cert
.IP \(bu 2
d146fd029c Update win_pki.py
.IP \(bu 2
ef8e3ef569 Update win_pki.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41557\fP: (\fI\%dmurphy18\fP) Add symbolic link for salt\-proxy service similar to other service files
@ \fI2017\-06\-06 17:13:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
3335fcbc7d Merge pull request \fI\%#41557\fP from dmurphy18/fix\-proxy\-service
.IP \(bu 2
ffe492d6a9 Add symbolic link salt\-proxy service similar to other service files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41597\fP: (\fI\%rallytime\fP) Back\-port \fI\%#41533\fP to 2016.11
@ \fI2017\-06\-06 15:15:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41533\fP: (\fI\%svinota\fP) unit tests: add pyroute2 interface dict test (refs: \fI\%#41597\fP)
.IP \(bu 2
65ed230f45 Merge pull request \fI\%#41597\fP from rallytime/bp\-41533
.IP \(bu 2
535b8e8d8e Update new pyroute2 unit test to conform with 2016.11 branch standards
.IP \(bu 2
5c86dee73c unit tests: test_pyroute2 \-\- add skipIf
.IP \(bu 2
026b39493f unit tests: add encoding clause into test_pyroute2
.IP \(bu 2
9ab203d54b unit tests: fix absolute imports in test_pyroute2
.IP \(bu 2
1f507cfa7a unit tests: add pyroute2 interface dict test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41596\fP: (\fI\%rallytime\fP) Back\-port \fI\%#41487\fP to 2016.11
@ \fI2017\-06\-06 02:44:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41487\fP: (\fI\%svinota\fP) clean up \fIchange\fP attribute from interface dict (refs: \fI\%#41596\fP)
.IP \(bu 2
bf8aed153d Merge pull request \fI\%#41596\fP from rallytime/bp\-41487
.IP \(bu 2
7b497d9ec6 clean up \fIchange\fP attribute from interface dict
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41435\fP: (\fI\%seanjnkns\fP) 2016.11: Keystone.endpoint_present overwrites all interfaces (refs: \fI\%#41509\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41509\fP: (\fI\%seanjnkns\fP) Add keystone V3 API support for keystone.endpoint_present|absent
@ \fI2017\-06\-03 03:01:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
cc6c98a8d8 Merge pull request \fI\%#41509\fP from seanjnkns/fix\-keystone\-v3\-endpoint_present
.IP \(bu 2
095e5949a3 Fix unit tests for PR \fI\%#41509\fP
.IP \(bu 2
eb7ef3c856 Add keystone V3 API support for keystone.endpoint_present|get, endpoint_absent|delete.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38061\fP: (\fI\%Ch3LL\fP) x509.crl_managed ValueError when digest is not specified in the module (refs: \fI\%#41539\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41539\fP: (\fI\%gtmanfred\fP) allow digest to be empty in create_crl
@ \fI2017\-06\-02 17:00:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a08649637 Merge pull request \fI\%#41539\fP from gtmanfred/x509
.IP \(bu 2
0989be8919 allow digest to be empty in create_crl
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41154\fP: (\fI\%mephi42\fP) archive.extracted outputs password embedded in archive URL (refs: \fI\%#41561\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41561\fP: (\fI\%terminalmage\fP) Redact HTTP basic authentication in archive.extracted
@ \fI2017\-06\-02 15:33:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ae8336895 Merge pull request \fI\%#41561\fP from terminalmage/issue41154
.IP \(bu 2
cbf8acbafc Redact HTTP basic authentication in archive.extracted
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41436\fP: (\fI\%skizunov\fP) TCP transport: Fix occasional errors when using salt command (refs: \fI\%#41787\fP)
@ \fI2017\-06\-01 16:37:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
39840bfe4e Merge pull request \fI\%#41436\fP from skizunov/develop2
.IP \(bu 2
07d5862773 unit.transport.tcp_test: Clean up channel after use
.IP \(bu 2
4b6aec7154 Preserve original IO Loop on cleanup
.IP \(bu 2
892c6d4d24 TCP transport: Fix occasional errors when using salt command
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41335\fP: (\fI\%syphernl\fP) [2016.11.5] ssh_auth.present: IndexError: list index out of range (refs: \fI\%#41337\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41337\fP: (\fI\%Foxlik\fP) Fix \fI\%#41335\fP \- list index out of range on empty line in authorized_keys
@ \fI2017\-05\-31 19:59:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
06ed4f077b Merge pull request \fI\%#41337\fP from Foxlik/2016.11
.IP \(bu 2
916fecb64f modify ssh_test.py, to check empty lines and comments in authorized_keys \fI\%#41335\fP
.IP \(bu 2
011d6d65e7 Fix \fI\%#41335\fP \- list index out of range on empty line in authorized_keys
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41512\fP: (\fI\%twangboy\fP) Use psutil where possible in win_status.py
@ \fI2017\-05\-31 19:56:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
1ace72d871 Merge pull request \fI\%#41512\fP from twangboy/fix_win_status
.IP \(bu 2
582d09b484 Get psutil import
.IP \(bu 2
fd88bb277f Remove unused imports (lint)
.IP \(bu 2
41a39dff00 Use psutil where possible
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41490\fP: (\fI\%t0fik\fP) Backport of SELinux module installation and removal
@ \fI2017\-05\-31 19:38:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
683cc5f414 Merge pull request \fI\%#41490\fP from jdsieci/2016.11_selinux
.IP \(bu 2
e2fbada1c1 Backport of SELinux module installation and removal
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41522\fP: (\fI\%jettero\fP) Sadly, you can\(aqt have \(aq.\(aqs and \(aq$\(aqs in dict keys in a mongodb doc.
@ \fI2017\-05\-31 15:55:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e7e84b8f2 Merge pull request \fI\%#41522\fP from jettero/mongodb\-keys\-are\-stupid
.IP \(bu 2
12648f5439 dang, thought I already got that. Apparently only got the bottom one. This should do it.
.IP \(bu 2
7c4a763518 ugh, forgot about this lint too. This one looks especially terrible.
.IP \(bu 2
c973988d8d forgot about the linter pass … fixed
.IP \(bu 2
da0d9e4045 Sadly, you can\(aqt have \(aq.\(aqs and \(aq$\(aqs in dict keys in a mongodb doc.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41504\fP: (\fI\%mtkennerly\fP) Can\(aqt set REG_DWORD registry value larger than 0x7FFFFFFF (refs: \fI\%#41506\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41506\fP: (\fI\%gtmanfred\fP) check for integer types
@ \fI2017\-05\-31 00:48:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
30ad4fd9a0 Merge pull request \fI\%#41506\fP from gtmanfred/2016.11
.IP \(bu 2
5fe2e9bbf5 check for integer types
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41469\fP: (\fI\%Ch3LL\fP) Fix keep_jobs keyerror in redis returner
@ \fI2017\-05\-30 18:37:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
06ef17dec3 Merge pull request \fI\%#41469\fP from Ch3LL/fix_redis_error
.IP \(bu 2
8ee1251a3a Fix keep_jobs keyerror in redis returner
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41473\fP: (\fI\%twangboy\fP) Fix win_firewall execution and state modules
@ \fI2017\-05\-30 18:35:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
7a09b2b678 Merge pull request \fI\%#41473\fP from twangboy/fix_win_firewall
.IP \(bu 2
e503b455c3 Fix lint error
.IP \(bu 2
d3f0f8bcd2 Fix win_firewall execution and state modules
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41499\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-05\-30 18:06:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
f635cb11c4 Merge pull request \fI\%#41499\fP from rallytime/merge\-2016.11
.IP \(bu 2
20d893d397 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
964b1ee027 Merge pull request \fI\%#41439\fP from terminalmage/salt\-cp\-base64
.INDENT 2.0
.IP \(bu 2
ebf6cc78c7 base64 encode binary data sent using salt\-cp
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41464\fP: (\fI\%rallytime\fP) Back\-port \fI\%#39850\fP to 2016.11
@ \fI2017\-05\-26 21:22:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39850\fP: (\fI\%epcim\fP) Fix endpoint handling per region (refs: \fI\%#41464\fP)
.IP \(bu 2
83f1e48241 Merge pull request \fI\%#41464\fP from rallytime/bp\-39850
.IP \(bu 2
9b84b751b2 Pylint fixes
.IP \(bu 2
6db8915021 Endpoint handling per region, fixes \fI\%#35874\fP \- extend tests for multiple regions \- region arg by default set to None \- print verbose changes to be exec.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41443\fP: (\fI\%UtahDave\fP) use proper arg number
@ \fI2017\-05\-26 20:36:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
960c5767fa Merge pull request \fI\%#41443\fP from UtahDave/fix_args_masterpy
.IP \(bu 2
dfbdc275ca use proper arg number
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41341\fP: (\fI\%lorengordon\fP) TypeError traceback in network.system with retain_settings=True (refs: \fI\%#41350\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41350\fP: (\fI\%lorengordon\fP) Supports quoted values in /etc/sysconfig/network
@ \fI2017\-05\-26 16:22:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
88c28c18c3 Merge pull request \fI\%#41350\fP from lorengordon/issue\-41341
.IP \(bu 2
f2f6da7039 Supports quoted values in /etc/sysconfig/network
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41398\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-05\-26 15:17:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
824f2d3b69 Merge pull request \fI\%#41398\fP from rallytime/merge\-2016.11
.IP \(bu 2
2941e9c923 Merge pull request \fI\%#22\fP from terminalmage/merge\-2016.11
.INDENT 2.0
.IP \(bu 2
087a958afc base64 encode binary data sent using salt\-cp
.UNINDENT
.IP \(bu 2
503f925275 Add missing import
.IP \(bu 2
d2d9a3d29f Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
d617c9fe72 Merge pull request \fI\%#41265\fP from terminalmage/issue41234
.INDENT 2.0
.IP \(bu 2
edf552fe9a Update PKG_TARGETS for RHEL\-based distros
.IP \(bu 2
0ecc7b9b20 yumpkg: fix latest_version() when showdupesfromrepos=1 set in /etc/yum.conf
.UNINDENT
.IP \(bu 2
26bd914580 Merge pull request \fI\%#41316\fP from Ch3LL/update_latest_2016.3
.INDENT 2.0
.IP \(bu 2
520740d862 [2016.13] Bump latest release version to 2016.11.5
.UNINDENT
.IP \(bu 2
18898b7d1f Merge pull request \fI\%#41216\fP from terminalmage/issue16592
.INDENT 2.0
.IP \(bu 2
0e15fdbb1a Update salt\-cp integration test to reflect recent changes
.IP \(bu 2
10dc695cc4 Make salt\-cp work with larger files
.IP \(bu 2
c078180539 Make KeyErrors more specific when interpreting returns
.IP \(bu 2
fc401c9eb4 Add generator functions for reading files
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41442\fP: (\fI\%UtahDave\fP) use proper arg number
@ \fI2017\-05\-26 13:42:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec08064b99 Merge pull request \fI\%#41442\fP from UtahDave/fix_args
.IP \(bu 2
0324833c9e use proper arg number
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37824\fP: (\fI\%dxiri\fP) SSLError Trying to use v3 API of Openstack Newton as provider. (refs: \fI\%#41397\fP, \fI\%#40752\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#36548\fP: (\fI\%abonillasuse\fP) openstack auth with nova driver (refs: \fI\%#38647\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41397\fP: (\fI\%Enquier\fP) Updating Nova/Neutron modules to support KeystoneAuth and SSLVerify
@ \fI2017\-05\-25 21:16:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40752\fP: (\fI\%Enquier\fP) Add ability to specify a custom SSL certificate or disable SSL verification in KeystoneAuth v3 (refs: \fI\%#41397\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38647\fP: (\fI\%gtmanfred\fP) Allow novaclient to use keystoneauth1 sessions for authentication (refs: \fI\%#41397\fP)
.IP \(bu 2
22096d9213 Merge pull request \fI\%#41397\fP from Enquier/neutron\-ssl\-verify
.IP \(bu 2
d25dcf61d5 Small error in nova that was preventing execution
.IP \(bu 2
0e7a1009ed Updated module docs to include changes made
.IP \(bu 2
05e0192665 Adding missing os_auth_system
.IP \(bu 2
4e0f4981e4 allow service_type to be specified default is now \(aqnetwork\(aq
.IP \(bu 2
991e84343f Added non\-profile and defaults for Neutron
.IP \(bu 2
c93f112c9b Updating Nova Module to include use_keystone Auth
.IP \(bu 2
66ab1e5184 Re\-adding neutron dependency check
.IP \(bu 2
cce07eefc2 Updating Neutron module to support KeystoneAuth
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34460\fP: (\fI\%Ch3LL\fP) Receive an error when using salt\-api to call a runner (refs: \fI\%#41409\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41409\fP: (\fI\%garethgreenaway\fP) Fixes to ipc transport
@ \fI2017\-05\-25 21:06:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
14a58cf536 Merge pull request \fI\%#41409\fP from garethgreenaway/34460_fixes_ipc_transport
.IP \(bu 2
5613b72dfe Updating the exception variable to be more in line with the rest of the exception code
.IP \(bu 2
41eee8b333 Fixing a potential lint issue
.IP \(bu 2
760d561dfa Fixing a potential lint issue
.IP \(bu 2
c11bcd0d12 Changing the approaching and including an except for the action socket.error exception, then logging a trace log if error number is 0 and an error log otherwise.
.IP \(bu 2
3f950596f4 Fixing lint issues.
.IP \(bu 2
f3a6531a69 On occasion an exception will occur which results in the event not returning
properly, even though the wire_bytes is correctly populated. In this situation, we log to trace
and continue. \fI\%#34460\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41421\fP: (\fI\%UtahDave\fP) Correct doc to actually blacklist a module
@ \fI2017\-05\-25 21:01:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
824428700d Merge pull request \fI\%#41421\fP from UtahDave/fix_blacklist_docs
.IP \(bu 2
5eb27571a0 Correct doc to actually blacklist a module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41353\fP: (\fI\%rmarchei\fP) Orchestrate runner needs saltenv on 2016.11.5 (refs: \fI\%#41431\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41431\fP: (\fI\%terminalmage\fP) Fix regression in state orchestration
@ \fI2017\-05\-25 18:44:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
b98d5e00d4 Merge pull request \fI\%#41431\fP from terminalmage/issue41353
.IP \(bu 2
16eae64cca Fix regression in state orchestration
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41338\fP: (\fI\%ricohouse\fP) Exception not raised when running config compare and the device (Juniper) returns error (refs: \fI\%#41429\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41429\fP: (\fI\%ricohouse\fP) Issue \fI\%#41338\fP: Return false when compare config fails
@ \fI2017\-05\-25 17:18:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
eeff3dd7fb Merge pull request \fI\%#41429\fP from ricohouse/fix\-compare\-bug
.IP \(bu 2
9b61665c4c Issue \fI\%#41338\fP: Return false when compare config fails
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41414\fP: (\fI\%Ch3LL\fP) Update bootstrap script verstion to latest release(v2017.05.24)
@ \fI2017\-05\-24 19:51:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
561a416cf3 Merge pull request \fI\%#41414\fP from Ch3LL/update_bootstrap
.IP \(bu 2
d8c03eef60 Update bootstrap script verstion to latest release(v2017.05.24)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41336\fP: (\fI\%mcalmer\fP) fix setting and getting locale on SUSE systems
@ \fI2017\-05\-24 17:46:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
88fd3c0ed9 Merge pull request \fI\%#41336\fP from mcalmer/fix\-locale\-on\-SUSE
.IP \(bu 2
f30f5c8a25 fix unit tests
.IP \(bu 2
428baa9bce fix setting and getting locale on SUSE systems
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41393\fP: (\fI\%rallytime\fP) Back\-port \fI\%#41235\fP to 2016.11
@ \fI2017\-05\-24 16:08:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41235\fP: (\fI\%moio\fP) rest_cherrypy: remove sleep call (refs: \fI\%#41393\fP)
.IP \(bu 2
4265959647 Merge pull request \fI\%#41393\fP from rallytime/bp\-41235
.IP \(bu 2
c79c0e3f43 rest_cherrypy: remove sleep call
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41394\fP: (\fI\%rallytime\fP) Back\-port \fI\%#41243\fP to 2016.11
@ \fI2017\-05\-24 16:00:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41243\fP: (\fI\%arif\-ali\fP) Remove the keys that don\(aqt exist in the new change (refs: \fI\%#41394\fP)
.IP \(bu 2
83f54694f9 Merge pull request \fI\%#41394\fP from rallytime/bp\-41243
.IP \(bu 2
a5351302af Lint fix
.IP \(bu 2
05fadc0af3 Remove the keys that don\(aqt exist in the new change
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41401\fP: (\fI\%bdrung\fP) Add documentation key to systemd service files
@ \fI2017\-05\-24 15:49:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a45ac30f0 Merge pull request \fI\%#41401\fP from bdrung/systemd\-service\-documentation\-key
.IP \(bu 2
3f7f30895d Add documentation key to systemd service files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41404\fP: (\fI\%bdrung\fP) Fix typos
@ \fI2017\-05\-24 14:42:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
d34333c30b Merge pull request \fI\%#41404\fP from bdrung/fix\-typos
.IP \(bu 2
33a7f8b2ec Fix typos
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41388\fP: (\fI\%bdrung\fP) Do not require sphinx\-build for cleaning docs
@ \fI2017\-05\-23 19:32:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
3083764195 Merge pull request \fI\%#41388\fP from bdrung/clean\-doc\-without\-sphinx
.IP \(bu 2
5b79a0a9f8 Do not require sphinx\-build for cleaning docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41362\fP: (\fI\%automate\-solutions\fP) On AWS EC2: salt\-cloud \-f delete_keypair ec2 keyname=mykeypair doesn\(aqt delete the keypair (refs: \fI\%#41364\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41364\fP: (\fI\%automate\-solutions\fP) Fix issue \fI\%#41362\fP invalid parameter used: KeyName.1 instead of KeyName
@ \fI2017\-05\-23 17:32:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
842875e590 Merge pull request \fI\%#41364\fP from automate\-solutions/fix\-issue\-41362
.IP \(bu 2
cfd8eb7a87 Set DescribeKeyPairs back to KeyName.1 according to documentation
.IP \(bu 2
6a82ddc6fc Fix issue \fI\%#41362\fP invalid parameter used: KeyName.1 instead of KeyName
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40950\fP: (\fI\%idokaplan\fP) Import certificate (refs: \fI\%#41453\fP, \fI\%#41383\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41383\fP: (\fI\%peter\-funktionIT\fP) Update win_pki.py (refs: \fI\%#41453\fP)
@ \fI2017\-05\-23 17:26:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
92f94e66bc Merge pull request \fI\%#41383\fP from peter\-funktionIT/fix\-win_pki\-get_cert_file
.IP \(bu 2
4d9bd06176 Update win_pki.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41113\fP: (\fI\%cro\fP) Rescue proxy_auto_tests PR from git rebase hell
@ \fI2017\-05\-22 17:05:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39575\fP: (\fI\%cro\fP) WIP: Proxy auto test, feedback appreciated (refs: \fI\%#41113\fP)
.IP \(bu 2
1ba95684a9 Merge pull request \fI\%#41113\fP from cro/proxy_auto_test2
.IP \(bu 2
19db038b99 Fix test\-\-use proxy_config instead of minion_config
.IP \(bu 2
7749ceadb6 Change default proxy minion opts so only the proxy\-specific ones are listed, and the rest are taken from DEFAULT_MINION_OPTS.
.IP \(bu 2
106394c80c Lint.
.IP \(bu 2
3be90cc9f4 Rescue proxy_auto_tests PR from git rebase hell
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41360\fP: (\fI\%cro\fP) Sysrc on FreeBSD, YAML overeager to coerce to bool and int
@ \fI2017\-05\-22 15:54:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
375892d910 Merge pull request \fI\%#41360\fP from cro/sysrc_fix
.IP \(bu 2
6db31ce52a Fix problem with sysrc on FreeBSD, YAML overeager to coerce to bool and int.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41190\fP: (\fI\%jheidbrink\fP) Cannot extract tar.xz archive when it exceeds size of /tmp (refs: \fI\%#41372\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41372\fP: (\fI\%terminalmage\fP) Don\(aqt use intermediate file when listing contents of tar.xz file
@ \fI2017\-05\-22 15:36:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
01b71c75c1 Merge pull request \fI\%#41372\fP from terminalmage/issue41190
.IP \(bu 2
1f08936d9c Remove unused import
.IP \(bu 2
68cb897520 Replace reference to fileobj
.IP \(bu 2
788874408a Remove \(aq*\(aq from mode
.IP \(bu 2
3d4b833627 Don\(aqt use intermediate file when listing contents of tar.xz file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41373\fP: (\fI\%alex\-zel\fP) Allow HTTP authentication to ES.
@ \fI2017\-05\-22 15:32:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
5edfcf972c Merge pull request \fI\%#41373\fP from alex\-zel/patch\-3
.IP \(bu 2
3192eab128 Allow HTTP authentication to ES.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40748\fP: (\fI\%djhaskin987\fP) Consul backend minion cache does not work (refs: \fI\%#41287\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41287\fP: (\fI\%garethgreenaway\fP) Fix to consul cache
@ \fI2017\-05\-19 18:32:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
29bd7f48b7 Merge pull request \fI\%#41287\fP from garethgreenaway/40748_2016_11_consul
.IP \(bu 2
5039fe12fb Removing chdir as it is no needed with this change
.IP \(bu 2
4550c3ce49 Updating the code that is pulling in the list of cached minions to use
self.cache.list instead of relying on checking the local file system, which only works for the
localfs cache method. \fI\%#40748\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38894\fP: (\fI\%amendlik\fP) salt.runner and salt.wheel ignore test=True (refs: \fI\%#41309\fP, \fI\%#41611\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41309\fP: (\fI\%garethgreenaway\fP) Adding test argument for runners & wheel orchestration modules
@ \fI2017\-05\-19 18:26:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
672aaa88d3 Merge pull request \fI\%#41309\fP from garethgreenaway/38894_allowing_test_argument
.IP \(bu 2
e1a88e8bf7 Allowing test=True to be passed for salt.runner and salt.wheel when used with orchestration
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41306\fP: (\fI\%lomeroe\fP) win_lgpo does not properly pack group policy version number in gpt.ini (refs: \fI\%#41319\fP, \fI\%#41307\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41319\fP: (\fI\%lomeroe\fP) backport \fI\%#41307\fP to 2016.11, properly pack version numbers into single
@ \fI2017\-05\-19 18:25:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41307\fP: (\fI\%lomeroe\fP) properly pack/unpack the version numbers into a number (refs: \fI\%#41319\fP)
.IP \(bu 2
140b0427e1 Merge pull request \fI\%#41319\fP from lomeroe/bp_41307
.IP \(bu 2
4f0aa577a5 backport 41307 to 2016.11, properly pack version numbers into single number
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41327\fP: (\fI\%Ch3LL\fP) Add 2016.11.6 Release Notes
@ \fI2017\-05\-19 18:05:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
6bdb7cca7d Merge pull request \fI\%#41327\fP from Ch3LL/add_2016.11.6_release
.IP \(bu 2
e5fc0aeb9c Add 2016.11.6 Release Notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41329\fP: (\fI\%lorengordon\fP) Corrects versionadded for win_network.get_route
@ \fI2017\-05\-19 17:47:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
1faffd3932 Merge pull request \fI\%#41329\fP from lorengordon/doc\-fix
.IP \(bu 2
3c471247f0 Corrects versionadded for win_network.get_route
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41322\fP: (\fI\%Ch3LL\fP) Add patched packages warning to 2016.11.5 release notes
@ \fI2017\-05\-18 21:53:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
6ca65592da Merge pull request \fI\%#41322\fP from Ch3LL/fix_release_2016.11.5_notes
.IP \(bu 2
9a1bf4205f fix url refs in rst
.IP \(bu 2
cde008ff77 Add patched packages warning to 2016.11.5 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41208\fP: (\fI\%pkazmierczak\fP) Fix: zypper handling of multiple version packages
@ \fI2017\-05\-18 15:44:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
9f359d841f Merge pull request \fI\%#41208\fP from pkazmierczak/pkazmierczak\-zypper\-multiple\-ver\-pkgs
.IP \(bu 2
d411a91676 Reverted back to cascading with statements for python 2.6 compat
.IP \(bu 2
7204013653 Compacted with statements in the unit test.
.IP \(bu 2
6c4c08042c Added unit tests and copied the behavior to .upgrade method, too.
.IP \(bu 2
5f952007f6 Fix: zypper handling of multiple version packages
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41317\fP: (\fI\%Ch3LL\fP) [2016.11] Bump latest release version to 2016.11.5
@ \fI2017\-05\-18 15:34:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
bcef99adb6 Merge pull request \fI\%#41317\fP from Ch3LL/update_latest_2016.11
.IP \(bu 2
cdb072c207 [2016.11] Bump latest release version to 2016.11.5
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41232\fP: (\fI\%axmetishe\fP) Add basic auth for SPM
@ \fI2017\-05\-17 19:08:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
b8ddd7ee08 Merge pull request \fI\%#41232\fP from axmetishe/2016.11
.IP \(bu 2
76104f23b4 Add basic auth for SPM
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41236\fP: (\fI\%BenoitKnecht\fP) states: cron: show correct changes when using \fIspecial\fP
@ \fI2017\-05\-17 18:51:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
7bdb66d969 Merge pull request \fI\%#41236\fP from BenoitKnecht/2016.11
.IP \(bu 2
33211d032e states: cron: show correct changes when using \fIspecial\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41269\fP: (\fI\%isbm\fP) Bugfix: Unable to use \(dq127\(dq as hostname for the Minion ID
@ \fI2017\-05\-17 18:31:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
1c1e092f56 Merge pull request \fI\%#41269\fP from isbm/isbm\-minion\-id\-127\-name
.IP \(bu 2
5168ef8959 Add unit test for hostname can be started from 127
.IP \(bu 2
0d0354198b Harden to 127. IP part
.IP \(bu 2
d9c8324a6b Unit test for accepting hosts names as 127
.IP \(bu 2
65b03c667b Bugfix: unable to use 127 as hostname
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41289\fP: (\fI\%garethgreenaway\fP) Fixing consul cache
@ \fI2017\-05\-17 16:54:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0fa31d4ca Merge pull request \fI\%#41289\fP from garethgreenaway/2016_11_5_fix_consul_cache_ls
.IP \(bu 2
780a28c9a0 Swapping the order in the func_alias so the ls function is available.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41291\fP: (\fI\%lomeroe\fP) win_lgpo does not properly convert large decimal values in regpol data (refs: \fI\%#41301\fP, \fI\%#41303\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41303\fP: (\fI\%lomeroe\fP) backport \fI\%#41301\fP \-\- properly convert packed string to decimal values
@ \fI2017\-05\-17 16:32:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41301\fP: (\fI\%lomeroe\fP) properly convert packed string to decimal values (refs: \fI\%#41303\fP)
.IP \(bu 2
6566648948 Merge pull request \fI\%#41303\fP from lomeroe/bp\-41301
.IP \(bu 2
f4b93f9d9a properly convert packed string to decimal values
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41231\fP: (\fI\%kaihowl\fP) PR \fI\%#30777\fP misses an update to the documentation for pkg.installed and hold:true (refs: \fI\%#41251\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#30733\fP: (\fI\%ealphonse\fP) version\-controlled packages with hold: True can no longer be upgraded by salt (refs: \fI\%#30777\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41283\fP: (\fI\%terminalmage\fP) Backport \fI\%#41251\fP to 2016.11
@ \fI2017\-05\-16 18:01:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41251\fP: (\fI\%abednarik\fP) Update apt module regarding upgrade against hold packages. (refs: \fI\%#41283\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30777\fP: (\fI\%abednarik\fP) Fix update apt hold pkgs (refs: \fI\%#41251\fP)
.IP \(bu 2
44598617be Merge pull request \fI\%#41283\fP from terminalmage/bp\-41251
.IP \(bu 2
ed03ca534f Update apt module regarding upgrade against hold packages.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41181\fP: (\fI\%gtmanfred\fP) add resolving extra flags to yum upgrade
@ \fI2017\-05\-16 04:07:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
d8e9676fcf Merge pull request \fI\%#41181\fP from gtmanfred/2016.11
.IP \(bu 2
2ca71713b1 use six and clean_kwargs
.IP \(bu 2
c9bf09a5a1 add resolving extra flags to yum upgrade
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40177\fP: (\fI\%eldadru\fP) libcloud_dns state \(dqglobal name \(aq__salt__\(aq is not defined\(dq in salt.cmd runner (refs: \fI\%#40246\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41220\fP: (\fI\%rallytime\fP) Back\-port \fI\%#40246\fP to 2016.11
@ \fI2017\-05\-15 17:59:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40246\fP: (\fI\%tonybaloney\fP) Fix libcloud_dns state module bug (refs: \fI\%#41220\fP)
.IP \(bu 2
75942235f0 Merge pull request \fI\%#41220\fP from rallytime/bp\-40246
.IP \(bu 2
79f1bb2bba Remove unused/duplicate imports leftover from merge\-conflict resolution
.IP \(bu 2
2f610680e5 remove unused imports
.IP \(bu 2
9b7de2e7d7 fix unit tests
.IP \(bu 2
49d94559ab linting
.IP \(bu 2
4b260a4594 linting
.IP \(bu 2
41d1adab5f fix up tests
.IP \(bu 2
b3822e03fc add fixes for incorrectly importing modules directly instead of using __salt__
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41230\fP: (\fI\%RealKelsar\fP) 2016.11.5 IPv6 nameserver in resolv.conf leads to minion exception (refs: \fI\%#41244\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#40912\fP: (\fI\%razed11\fP) IPV6 Warning when ipv6 set to False (refs: \fI\%#40934\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41244\fP: (\fI\%cachedout\fP) Fix ipv6 nameserver grains
@ \fI2017\-05\-15 17:55:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40934\fP: (\fI\%gtmanfred\fP) Only display IPvX warning if role is master (refs: \fI\%#41244\fP)
.IP \(bu 2
53d5b3e816 Merge pull request \fI\%#41244\fP from cachedout/fix_ipv6_nameserver_grains
.IP \(bu 2
f745db1a43 Lint
.IP \(bu 2
6e1ab69710 Partial revert of \fI\%#40934\fP
.IP \(bu 2
88f49f9146 Revert \(dqOnly display IPvX warning if role is master\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41242\fP: (\fI\%pprkut\fP) Fix changing a mysql user to unix socket authentication.
@ \fI2017\-05\-15 17:00:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
895fe582eb Merge pull request \fI\%#41242\fP from M2Mobi/mysql_socket_auth
.IP \(bu 2
7d8359766d Fix changing a mysql user to unix socket authentication.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40940\fP: (\fI\%djhaskin987\fP) When \fIstate_aggregate\fP is set to \fITrue\fP, the \fIlatest\fP keyword doesn\(aqt work with pkg.installed (refs: \fI\%#41101\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41101\fP: (\fI\%terminalmage\fP) Fix \(dqlatest\(dq keyword for version specification when used with aggregation
@ \fI2017\-05\-15 16:52:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
50d8fde123 Merge pull request \fI\%#41101\fP from terminalmage/issue40940
.IP \(bu 2
7fe64219ae Add rtag check to integration test for pkg.refresh_db
.IP \(bu 2
88a08aa3bf Add comments to explain what removing the rtag file actually does
.IP \(bu 2
92011dbe5f Fix \(dqlatest\(dq keyword for version specification when used with aggregation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34775\fP: (\fI\%babilen\fP) Please allow users to disable branch environment mapping in GitFS (refs: \fI\%#41144\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41146\fP: (\fI\%terminalmage\fP) gitfs: Backport performance fixes for getting tree objects
@ \fI2017\-05\-12 17:35:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41144\fP: (\fI\%terminalmage\fP) gitfs: Add two new options to affect saltenv mapping (refs: \fI\%#41146\fP)
.IP \(bu 2
049712ba53 Merge pull request \fI\%#41146\fP from terminalmage/backport\-get_tree\-performance\-improvement
.IP \(bu 2
f9d6734afe gitfs: Backport performance fixes for getting tree objects
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41135\fP: (\fI\%shallot\fP) gpg renderer doesn\(aqt seem to work with salt\-ssh, tries to execute gpg on the minion? (refs: \fI\%#41161\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41161\fP: (\fI\%The\-Loeki\fP) gpg renderer: fix gpg_keydir always reverting to default
@ \fI2017\-05\-12 17:19:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
4215a0b99d Merge pull request \fI\%#41161\fP from The\-Loeki/2016.11
.IP \(bu 2
24946fef18 gpg renderer: fix gpg_keydir always reverting to default
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41162\fP: (\fI\%onlyanegg\fP) Elasticsearch module functions should pass hosts and profile to index_exists() (refs: \fI\%#41163\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41163\fP: (\fI\%onlyanegg\fP) Elasticsearch \- pass hosts and profile to index_exists()
@ \fI2017\-05\-12 17:18:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b10fc58ba Merge pull request \fI\%#41163\fP from onlyanegg/elasticsearch\-pass_profile_to_index_exists
.IP \(bu 2
7f512c701b Pass hosts and profile to index_exists() method
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41185\fP: (\fI\%jmarinaro\fP) package name collisions in chocolatey state (refs: \fI\%#41186\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41186\fP: (\fI\%jmarinaro\fP) Fix package name collisions in chocolatey state
@ \fI2017\-05\-12 17:01:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
d433cf850d Merge pull request \fI\%#41186\fP from jmarinaro/fix\-chocolatey\-package\-collision
.IP \(bu 2
229f3bf9f3 apply changes to uninstalled function
.IP \(bu 2
ffd4c7ef04 Fix package name collisions in chocolatey state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41189\fP: (\fI\%github\-abcde\fP) utils/minions.py: Fixed case where data is an empty dict resulting in…
@ \fI2017\-05\-12 16:32:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb5ef41ce0 Merge pull request \fI\%#41189\fP from github\-abcde/utils\-minions\-fix
.IP \(bu 2
853dc5406c utils/minions.py: Fixed case where data is an empty dict resulting in errors.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41104\fP: (\fI\%Ch3LL\fP) Add test to query results of /jobs call in api
@ \fI2017\-05\-10 20:11:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
b136b15330 Merge pull request \fI\%#41104\fP from Ch3LL/add_jobs_test
.IP \(bu 2
dac16583b7 add test to query results of /jobs call in api
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41170\fP: (\fI\%lomeroe\fP) Backport \fI\%#41081\fP to 2016.11
@ \fI2017\-05\-10 19:58:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41081\fP: (\fI\%lomeroe\fP) Update win_dns_client to use reg.read_value and set_value (refs: \fI\%#41170\fP)
.IP \(bu 2
ca18b4df93 Merge pull request \fI\%#41170\fP from lomeroe/bp\-41081
.IP \(bu 2
2af89f2165 update mock data
.IP \(bu 2
b7fa115a59 update win_dns_client tests with correct module names
.IP \(bu 2
4d05a22675 Update win_dns_client to use reg.read_value and set_value
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41173\fP: (\fI\%twangboy\fP) Add silent action to MsgBox for Path Actions
@ \fI2017\-05\-10 19:57:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
d7ec37b003 Merge pull request \fI\%#41173\fP from twangboy/fix_installer
.IP \(bu 2
24b11ffdc2 Add release notes
.IP \(bu 2
96918dcfa6 Add silent action to MsgBox for Path Actions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41158\fP: (\fI\%Ch3LL\fP) 2016.11.5 release notes: add additional commits
@ \fI2017\-05\-09 22:41:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
88e93b7fe5 Merge pull request \fI\%#41158\fP from Ch3LL/update_2016.11.5
.IP \(bu 2
28371aa035 2016.11.5 release notes: add additional commits
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41148\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-05\-09 20:23:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
d2ae7deff2 Merge pull request \fI\%#41148\fP from rallytime/merge\-2016.11
.IP \(bu 2
aba35e20dd Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
2969153097 Merge pull request \fI\%#41122\fP from terminalmage/masterless\-env_cache\-fix
.INDENT 2.0
.IP \(bu 2
be732f0577 gitfs: refresh env cache during update in masterless
.UNINDENT
.IP \(bu 2
b8f0a4f108 Merge pull request \fI\%#41123\fP from terminalmage/gitfs\-vsts\-note
.INDENT 2.0
.IP \(bu 2
f6a16956a0 Add note on lack of support for VSTS in older libssh2 releases.
.UNINDENT
.IP \(bu 2
8f79b6f537 Merge pull request \fI\%#41090\fP from bbinet/rdurations_float
.IP \(bu 2
fd48a63653 rdurations should be floats so that they can be summed when profiling
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41147\fP: (\fI\%rallytime\fP) Back\-port \fI\%#39676\fP to 2016.11
@ \fI2017\-05\-09 18:40:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39676\fP: (\fI\%F30\fP) Fix comments about the \(dqhash_type\(dq option (refs: \fI\%#41147\fP)
.IP \(bu 2
2156395b2e Merge pull request \fI\%#41147\fP from rallytime/bp\-39676
.IP \(bu 2
5b55fb2452 Fix comments about the \(dqhash_type\(dq option
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40852\fP: (\fI\%isbm\fP) Isbm fix coregrains constants bsc#1032931
@ \fI2017\-05\-09 18:35:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
a2f359fa13 Merge pull request \fI\%#40852\fP from isbm/isbm\-fix\-coregrains\-constants\-bsc#1032931
.IP \(bu 2
f3b12a3f5b Do not use multiple variables in \(dqwith\(dq statement as of lint issues
.IP \(bu 2
35a8d99934 Disable the test for a while
.IP \(bu 2
76cb1b7150 Rewrite test case for using no patch decorators
.IP \(bu 2
f71af0b625 Fix lint issues
.IP \(bu 2
0e6abb3e37 Add UT on set_hw_clock on Gentoo
.IP \(bu 2
a2b1d4638c Add UT for set_hwclock on Debian
.IP \(bu 2
5356a0821a Bugfix: use correct grain name for SUSE platform
.IP \(bu 2
88e8184702 Add UT set_hwclock on SUSE
.IP \(bu 2
0cd590f927 Fix UT names
.IP \(bu 2
bee94ade63 Add UT for set_hwclock on RedHat
.IP \(bu 2
dfe2610d05 Add UT for set_hwclock on Arch
.IP \(bu 2
d000a8a6f5 Add UT for set_hwclock on solaris
.IP \(bu 2
d2614aedaa Fix docstrings
.IP \(bu 2
6d782191dc Add UT for set_hwclock on AIX
.IP \(bu 2
d303e0dd8a Add UT for AIX on get_hwclock
.IP \(bu 2
86f2d83781 Add UT on Solaris
.IP \(bu 2
c3cafed6d5 Add UT for Debian on get_hwclock
.IP \(bu 2
d337c09357 Add UT for RedHat/SUSE platforms on get_hwclock
.IP \(bu 2
501a59ca7e Bugfix: use correct grain for SUSE and RedHat platform
.IP \(bu 2
f25dc5c56c Add UT for get_hwclock on SUSE platform
.IP \(bu 2
08e00c865c Remove dead code
.IP \(bu 2
1216a0bf12 Add UT for get_hwclock on UTC/localtime
.IP \(bu 2
39332c71d3 Remove duplicate code
.IP \(bu 2
58676c568d Add UT for Debian on set_zone
.IP \(bu 2
1b9ce37b1b Add UT for gentoo on set_zone
.IP \(bu 2
cf7f766a68 Bugfix: use correct os_family grain value for SUSE series
.IP \(bu 2
6ed9be985e Adjust UT to use correct grain for SUSE series
.IP \(bu 2
ce4c836a60 Add UT for set_zone on SUSE series
.IP \(bu 2
155a498b49 Doc fix
.IP \(bu 2
a40876cdac Remove unnecessary mock patch
.IP \(bu 2
ffab2db213 Fix doc for RH UT
.IP \(bu 2
72388f7ae2 Add UT for RedHat\(aqs set_zone
.IP \(bu 2
11595d3a42 Refactor with setup/teardown
.IP \(bu 2
ce6a06de98 Bugfix: use correct grain constant for platform
.IP \(bu 2
28072c9e41 Adjust the test so it is using the right grain for SUSE systems
.IP \(bu 2
7a0e4be4f8 Add unit test for get_zone and various platforms
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41105\fP: (\fI\%terminalmage\fP) ssl_verify gitfs/git_pillar option does not work with pygit2 (refs: \fI\%#41111\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41111\fP: (\fI\%terminalmage\fP) Allow \(dqssl_verify: False\(dq to work with pygit2
@ \fI2017\-05\-09 17:56:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
6fa41dc89d Merge pull request \fI\%#41111\fP from terminalmage/issue41105
.IP \(bu 2
8c6410e3cd Add notices about ssl_verify only working in 0.23.2 and newer
.IP \(bu 2
98ce829729 Support ssl_verify in pygit2
.IP \(bu 2
f73c4b7167 Add http(s) auth config docs for GitPython
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41008\fP: (\fI\%cro\fP) Look in /opt/\fI/lib instead of just /opt/local/lib on Illumos distros.
@ *2017\-05\-09 16:56:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
81add1b944 Merge pull request \fI\%#41008\fP from cro/rsax_smos
.IP \(bu 2
a4f7aa145e Look for libcrypto in both /opt/tools and /opt/local on Illumos\-based distros.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41124\fP: (\fI\%gtmanfred\fP) add user_data to digitalocean
@ \fI2017\-05\-09 16:47:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
c649725e9b Merge pull request \fI\%#41124\fP from gtmanfred/do
.IP \(bu 2
2370d9316b add user_data to digital ocean
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41125\fP: (\fI\%tmeneau\fP) service.running returns True if enable=None and init script returns 0 (refs: \fI\%#41127\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41127\fP: (\fI\%tmeneau\fP) Fix incorrect service.running state response when enable=None and init script returns 0
@ \fI2017\-05\-09 16:43:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0a3fcf33a Merge pull request \fI\%#41127\fP from xetus\-oss/fix\-41125\-service\-running
.IP \(bu 2
d8766562c9 fix incorrect service.running success response
.UNINDENT
.UNINDENT
.SS Salt 2016.11.7 Release Notes
.sp
Version 2016.11.7 is a bugfix release for \fI\%2016.11.0\fP\&.
.SS Security Fix
.sp
\fBCVE\-2017\-12791\fP Maliciously crafted minion IDs can cause unwanted directory
traversals on the Salt\-master
.sp
This release corrects a flaw in minion ID validation which could allow certain
minions to authenticate to a master despite not having the correct credentials.
To exploit the vulnerability, an attacker must create a salt\-minion with an ID
containing characters that will cause a directory traversal. Credit for
discovering the security flaw goes to: \fI\%Vernhk@qq.com\fP
.SS Salt 2016.11.8 Release Notes
.sp
Version 2016.11.8 is a bugfix release for \fI\%2016.11.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB171\fP
.IP \(bu 2
Total Issue References: \fB68\fP
.IP \(bu 2
Total PR References: \fB202\fP
.IP \(bu 2
Contributors: \fB61\fP (\fI\%AFriemann\fP, \fI\%Ch3LL\fP, \fI\%CorvinM\fP, \fI\%Da\-Juan\fP, \fI\%DmitryKuzmenko\fP,
\fI\%UtahDave\fP, \fI\%abulford\fP, \fI\%amalleo25\fP, \fI\%amendlik\fP, \fI\%aneeshusa\fP, \fI\%aogier\fP, \fI\%arount\fP,
\fI\%arthurlogilab\fP, \fI\%astronouth7303\fP, \fI\%binocvlar\fP, \fI\%blarghmatey\fP, \fI\%cachedout\fP,
\fI\%clem\-compilatio\fP, \fI\%corywright\fP, \fI\%cri\-epita\fP, \fI\%damon\-atkins\fP, \fI\%davidjb\fP, \fI\%dglloyd\fP,
\fI\%dmurphy18\fP, \fI\%ferringb\fP, \fI\%garethgreenaway\fP, \fI\%gdubroeucq\fP, \fI\%gilbsgilbs\fP, \fI\%goten4\fP,
\fI\%gtmanfred\fP, \fI\%isbm\fP, \fI\%jagguli\fP, \fI\%kevinanderson1\fP, \fI\%kojiromike\fP, \fI\%kstreee\fP, \fI\%leeclemens\fP,
\fI\%lomeroe\fP, \fI\%lorengordon\fP, \fI\%lubyou\fP, \fI\%mcarlton00\fP, \fI\%meaksh\fP, \fI\%morganwillcock\fP, \fI\%nhavens\fP,
\fI\%pabloh007\fP, \fI\%rallytime\fP, \fI\%remijouannet\fP, \fI\%renner\fP, \fI\%root360\-AndreasUlm\fP, \fI\%s\-sebastian\fP,
\fI\%sarcasticadmin\fP, \fI\%sbojarski\fP, \fI\%shengis\fP, \fI\%tdutrion\fP, \fI\%terminalmage\fP, \fI\%toanju\fP,
\fI\%twangboy\fP, \fI\%ushmodin\fP, \fI\%viktorkrivak\fP, \fI\%vutny\fP, \fI\%whiteinge\fP, \fI\%xiaoanyunfei\fP)
.UNINDENT
.SS Security Fix
.sp
\fBCVE\-2017\-14695\fP Directory traversal vulnerability in minion id validation in
SaltStack. Allows remote minions with incorrect credentials to authenticate to
a master via a crafted minion ID. Credit for discovering the security flaw goes
to: Julian Brost (\fI\%julian@0x4a42.net\fP)
.sp
\fBCVE\-2017\-14696\fP Remote Denial of Service with a specially crafted
authentication request. Credit for discovering the security flaw goes to:
Julian Brost (\fI\%julian@0x4a42.net\fP)
.SS Anonymous Binds and LDAP/Active Directory
.sp
When \fBauth.ldap.anonymous\fP is set to \fBFalse\fP, the bind password can no
longer be empty.
.SS Changelog for v2016.11.7..v2016.11.8
.sp
\fIGenerated at: 2018\-05\-27 20:23:07 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#43508\fP: (\fI\%rallytime\fP) Back\-port  \fI\%#43333\fP to 2016.11.8
@ \fI2017\-09\-14 21:40:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43333\fP: (\fI\%damon\-atkins\fP) Docs are wrong cache_dir (bool) and cache_file (str) cannot be passed as params + 1 bug (refs: \fI\%#43508\fP)
.IP \(bu 2
a648f75949 Merge pull request \fI\%#43508\fP from rallytime/bp\-43333
.IP \(bu 2
d4981a2717 Update doco
.IP \(bu 2
a7c8b9e048 Update win_pkg.py
.IP \(bu 2
1d6dc6fb72 Docs are wrong cache_dir (bool) and cache_file (str) cannot be passed on the cli (\fI\%#2\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43434\fP: (\fI\%rallytime\fP) Add 2016.11.8 release notes
@ \fI2017\-09\-11 17:06:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
e7009877bc Merge pull request \fI\%#43434\fP from rallytime/2016.11.8\-release\-notes
.IP \(bu 2
68f529ee5e Add 2016.11.8 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43271\fP: (\fI\%twangboy\fP) Fix minor formatting issue
@ \fI2017\-08\-30 18:35:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
cf21f91fb2 Merge pull request \fI\%#43271\fP from twangboy/win_fix_pkg.install
.IP \(bu 2
91b062f564 Fix formatting issue, spaces surrounding +
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43228\fP: (\fI\%twangboy\fP) Win fix pkg.install
@ \fI2017\-08\-30 14:26:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a0b02f3ae Merge pull request \fI\%#43228\fP from twangboy/win_fix_pkg.install
.IP \(bu 2
13dfabb1ce Fix regex statement, add \fI\&.\fP
.IP \(bu 2
31ff69f0ad Add underscore to regex search
.IP \(bu 2
3cf2b6575c Fix spelling
.IP \(bu 2
ed030a35a5 Use regex to detect salt\-minion install
.IP \(bu 2
e5daff495a Fix pkg.install
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43191\fP: (\fI\%viktorkrivak\fP) Fix apache.config with multiple statement
@ \fI2017\-08\-28 18:13:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
b4c689dff5 Merge pull request \fI\%#43191\fP from viktorkrivak/fix\-apache\-config\-multi\-entity
.IP \(bu 2
c15bcbe1cc Merge remote\-tracking branch \(aqupstream/2016.11\(aq into fix\-apache\-config\-multi\-entity
.IP \(bu 2
4164047951 Fix apache.config with multiple statement At this moment when you post more than one statement in config only last is used. Also file is rewrote multiple times until last statement is written. Example: salt \(aq*\(aq apache.config /etc/httpd/conf.d/ports.conf config=\(dq[{\(aqListen\(aq: \(aq8080\(aq}, {\(aqProxy\(aq: \(dqSomething\(dq}]\(dq Ends only with    Proxy Something and ignore Listen 8080, This patch fix this issue.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42279\fP: (\fI\%dafyddj\fP) win_lgpo matches multiple policies due to startswith() (refs: \fI\%#43154\fP, \fI\%#43116\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43154\fP: (\fI\%lomeroe\fP) Backport \fI\%#43116\fP to 2016.11
@ \fI2017\-08\-28 16:40:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43116\fP: (\fI\%lomeroe\fP) Fix 42279 in develop (refs: \fI\%#43154\fP)
.IP \(bu 2
b90e59ede9 Merge pull request \fI\%#43154\fP from lomeroe/bp\-43116\-2016.11
.IP \(bu 2
8f593b0b02 verify that files exist before trying to remove them, win_file.remove raises an exception if the file does not exist
.IP \(bu 2
33a30bac06 correcting bad format statement in search for policy to be disabled
.IP \(bu 2
acc3d7ac82 correct fopen calls from salt.utils for 2016.11\(aqs utils function
.IP \(bu 2
2da1cdd109 lint fix
.IP \(bu 2
61bd12c0de track xml namespace to ensure policies w/duplicate IDs or Names do not conflict
.IP \(bu 2
f232bed9f9 add additional checks for ADM policies that have the same ADMX policy ID (\fI\%#42279\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42642\fP: (\fI\%githubcdr\fP) state.augeas (refs: \fI\%#42669\fP, \fI\%#43202\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43202\fP: (\fI\%garethgreenaway\fP) Reverting previous augeas module changes
@ \fI2017\-08\-28 13:14:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
5308c27f9f Merge pull request \fI\%#43202\fP from garethgreenaway/42642_2016_11_augeas_module_revert_fix
.IP \(bu 2
ef7e93eb3f Reverting this change due to it breaking other uses.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43101\fP: (\fI\%aogier\fP) genesis.bootstrap fails if no pkg AND exclude_pkgs (which can\(aqt be a string) (refs: \fI\%#43103\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43103\fP: (\fI\%aogier\fP) genesis.bootstrap deboostrap fix
@ \fI2017\-08\-25 20:48:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
f16b7246e4 Merge pull request \fI\%#43103\fP from aogier/43101\-genesis\-bootstrap
.IP \(bu 2
db94f3bb1c better formatting
.IP \(bu 2
e5cc667762 tests: fix a leftover and simplify some parts
.IP \(bu 2
13e5997457 lint
.IP \(bu 2
216ced69e5 allow comma\-separated pkgs lists, quote args, test deb behaviour
.IP \(bu 2
d8612ae006 fix debootstrap and enhance packages selection/deletion via cmdline
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42329\fP: (\fI\%jagguli\fP) State git.latest does not pull latest tags (refs: \fI\%#42663\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42663\fP: (\fI\%jagguli\fP) Check remote tags before deciding to do a fetch \fI\%#42329\fP
@ \fI2017\-08\-25 20:14:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
4863771428 Merge pull request \fI\%#42663\fP from StreetHawkInc/fix_git_tag_check
.IP \(bu 2
2b5af5b59d Remove refs/tags prefix from remote tags
.IP \(bu 2
3f2e96e561 Convert set to list for serializer
.IP \(bu 2
2728e5d977 Only include new tags in changes
.IP \(bu 2
4b1df2f223 Exclude annotated tags from checks
.IP \(bu 2
389c037285 Check remote tags before deciding to do a fetch \fI\%#42329\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43198\fP: (\fI\%corywright\fP) disk.format_ needs to be aliased to disk.format (refs: \fI\%#43199\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43199\fP: (\fI\%corywright\fP) Add \fIdisk.format\fP alias for \fIdisk.format_\fP
@ \fI2017\-08\-25 19:21:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
4193e7f0a2 Merge pull request \fI\%#43199\fP from corywright/disk\-format\-alias
.IP \(bu 2
f00d3a9ddc Add \fIdisk.format\fP alias for \fIdisk.format_\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#495\fP: (\fI\%Ch3LL\fP) npm tests failing (refs: \fI\%#43196\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43196\fP: (\fI\%gtmanfred\fP) Pin request install to version for npm tests
@ \fI2017\-08\-25 18:43:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
5471f9fe0c Merge pull request \fI\%#43196\fP from gtmanfred/2016.11
.IP \(bu 2
ccd2241777 Pin request install to version
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43143\fP: (\fI\%abulford\fP) git.detached does not fetch if rev is missing from local (refs: \fI\%#43178\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43178\fP: (\fI\%terminalmage\fP) git.detached: Fix traceback when rev is a SHA and is not present locally
@ \fI2017\-08\-25 13:58:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
ace2715c60 Merge pull request \fI\%#43178\fP from terminalmage/issue43143
.IP \(bu 2
2640833400 git.detached: Fix traceback when rev is a SHA and is not present locally
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43179\fP: (\fI\%terminalmage\fP) Fix missed deprecation
@ \fI2017\-08\-24 22:52:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
12e9507b9e Merge pull request \fI\%#43179\fP from terminalmage/old\-deprecation
.IP \(bu 2
3adf8ad04b Fix missed deprecation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43171\fP: (\fI\%terminalmage\fP) Add warning about adding new functions to salt/utils/__init__.py
@ \fI2017\-08\-24 19:10:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
b595440d90 Merge pull request \fI\%#43171\fP from terminalmage/salt\-utils\-warning
.IP \(bu 2
7b5943a31a Add warning about adding new functions to salt/utils/__init__.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43173\fP: (\fI\%Ch3LL\fP) Add New Release Branch Strategy to Contribution Docs
@ \fI2017\-08\-24 19:04:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
4f273cac4f Merge pull request \fI\%#43173\fP from Ch3LL/add_branch_docs
.IP \(bu 2
1b24244bd3 Add New Release Branch Strategy to Contribution Docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43151\fP: (\fI\%ushmodin\fP) state.sls hangs on file.recurse with clean: True on windows
@ \fI2017\-08\-23 17:25:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42969\fP: (\fI\%ushmodin\fP) state.sls hangs on file.recurse with clean: True on windows (refs: \fI\%#43151\fP)
.IP \(bu 2
669b376abf Merge pull request \fI\%#43151\fP from ushmodin/2016.11
.IP \(bu 2
c5841e2ade state.sls hangs on file.recurse with clean: True on windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42986\fP: (\fI\%renner\fP) Notify systemd synchronously (via NOTIFY_SOCKET)
@ \fI2017\-08\-22 16:52:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
ae9d2b7985 Merge pull request \fI\%#42986\fP from renner/systemd\-notify
.IP \(bu 2
79c53f3f81 Fallback to systemd_notify_call() in case of socket.error
.IP \(bu 2
f1765472dd Notify systemd synchronously (via NOTIFY_SOCKET)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43036\fP: (\fI\%mcarlton00\fP) Linux VMs in Bhyve aren\(aqt displayed properly in grains (refs: \fI\%#43037\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43037\fP: (\fI\%mcarlton00\fP) Issue \fI\%#43036\fP Bhyve virtual grain in Linux VMs
@ \fI2017\-08\-22 16:43:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
b420fbe618 Merge pull request \fI\%#43037\fP from mcarlton00/fix\-bhyve\-grains
.IP \(bu 2
73315f0cf0 Issue \fI\%#43036\fP Bhyve virtual grain in Linux VMs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43100\fP: (\fI\%vutny\fP) [DOCS] Add missing \fIutils\fP sub\-dir listed for \fIextension_modules\fP
@ \fI2017\-08\-22 15:40:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a86f2d884 Merge pull request \fI\%#43100\fP from vutny/doc\-add\-missing\-utils\-ext
.IP \(bu 2
af743ff6c3 [DOCS] Add missing \fIutils\fP sub\-dir listed for \fIextension_modules\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#15171\fP: (\fI\%JensRantil\fP) Maximum recursion limit hit related to requisites (refs: \fI\%#42985\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42985\fP: (\fI\%DmitryKuzmenko\fP) Properly handle \fIprereq\fP having lost requisites.
@ \fI2017\-08\-21 22:49:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
e2bf2f448e Merge pull request \fI\%#42985\fP from DSRCorporation/bugs/15171_recursion_limit
.IP \(bu 2
651b1bab09 Properly handle \fIprereq\fP having lost requisites.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43092\fP: (\fI\%blarghmatey\fP) Fixed issue with silently passing all tests in Testinfra module
@ \fI2017\-08\-21 20:22:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
e51333306c Merge pull request \fI\%#43092\fP from mitodl/2016.11
.IP \(bu 2
d4b113acdf Fixed issue with silently passing all tests in Testinfra module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43060\fP: (\fI\%twangboy\fP) Osx update pkg scripts
@ \fI2017\-08\-21 20:06:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
77a443ce8e Merge pull request \fI\%#43060\fP from twangboy/osx_update_pkg_scripts
.IP \(bu 2
ef8a14cdf9 Remove /opt/salt instead of /opt/salt/bin
.IP \(bu 2
2dd62aa1da Add more information to the description
.IP \(bu 2
f44f5b70dc Only stop services if they are running
.IP \(bu 2
3b62bf953c Remove salt from the path
.IP \(bu 2
ebdca3a0f5 Update pkg\-scripts
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42869\fP: (\fI\%abednarik\fP) Git Module : Failed to update repository (refs: \fI\%#43064\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43064\fP: (\fI\%terminalmage\fP) Fix race condition in git.latest
@ \fI2017\-08\-21 14:29:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
1b1b6da803 Merge pull request \fI\%#43064\fP from terminalmage/issue42869
.IP \(bu 2
093c0c2f77 Fix race condition in git.latest
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42041\fP: (\fI\%lorengordon\fP) pkg.list_repo_pkgs fails to find pkgs with spaces around yum repo enabled value (refs: \fI\%#43054\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43054\fP: (\fI\%lorengordon\fP) Uses ConfigParser to read yum config files
@ \fI2017\-08\-18 20:49:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42045\fP: (\fI\%arount\fP) Fix: salt.modules.yumpkg: ConfigParser to read ini like files. (refs: \fI\%#43054\fP)
.IP \(bu 2
96e8e836d1 Merge pull request \fI\%#43054\fP from lorengordon/fix/yumpkg/config\-parser
.IP \(bu 2
3b2cb81a72 fix typo in salt.modules.yumpkg
.IP \(bu 2
38add0e4a2 break if leading comments are all fetched
.IP \(bu 2
d7f65dc7a7 fix configparser import & log if error was raised
.IP \(bu 2
ca1b1bb633 use configparser to parse yum repo file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43048\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43031\fP to 2016.11
@ \fI2017\-08\-18 12:56:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43031\fP: (\fI\%gtmanfred\fP) use a ruby gem that doesn\(aqt have dependencies (refs: \fI\%#43048\fP)
.IP \(bu 2
43aa46f512 Merge pull request \fI\%#43048\fP from rallytime/bp\-43031
.IP \(bu 2
35e45049e2 use a ruby gem that doesn\(aqt have dependencies
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43023\fP: (\fI\%terminalmage\fP) Fixes/improvements to Jenkins state/module
@ \fI2017\-08\-18 01:33:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
ad89ff3104 Merge pull request \fI\%#43023\fP from terminalmage/fix\-jenkins\-xml\-caching
.IP \(bu 2
33fd8ff939 Update jenkins.py
.IP \(bu 2
fc306fc8c3 Add missing colon in \fIif\fP statement
.IP \(bu 2
822eabcc81 Catch exceptions raised when making changes to jenkins
.IP \(bu 2
91b583b493 Improve and correct exception raising
.IP \(bu 2
f096917a0e Raise an exception if we fail to cache the config xml
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43026\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43020\fP to 2016.11
@ \fI2017\-08\-17 23:19:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43020\fP: (\fI\%gtmanfred\fP) test with gem that appears to be abandoned (refs: \fI\%#43026\fP)
.IP \(bu 2
2957467ed7 Merge pull request \fI\%#43026\fP from rallytime/bp\-43020
.IP \(bu 2
0eb15a1f67 test with gem that appears to be abandoned
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40490\fP: (\fI\%alxwr\fP) saltstack x509 incompatible to m2crypto 0.26.0 (refs: \fI\%#42760\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43033\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42760\fP to 2016.11
@ \fI2017\-08\-17 22:24:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42760\fP: (\fI\%AFriemann\fP) Catch TypeError thrown by m2crypto when parsing missing subjects in c… (refs: \fI\%#43033\fP)
.IP \(bu 2
4150b094fe Merge pull request \fI\%#43033\fP from rallytime/bp\-42760
.IP \(bu 2
3e3f7f5d8e Catch TypeError thrown by m2crypto when parsing missing subjects in certificate files.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43032\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42547\fP to 2016.11
@ \fI2017\-08\-17 21:53:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42547\fP: (\fI\%blarghmatey\fP) Updated testinfra modules to work with more recent versions (refs: \fI\%#43032\fP)
.IP \(bu 2
b124d3667e Merge pull request \fI\%#43032\fP from rallytime/bp\-42547
.IP \(bu 2
ea4d7f4176 Updated testinfra modules to work with more recent versions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42992\fP: (\fI\%pabloh007\fP) docker.save  flag push does is ignored (refs: \fI\%#43027\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43027\fP: (\fI\%pabloh007\fP) Fixes ignore push flag for docker.push module issue \fI\%#42992\fP
@ \fI2017\-08\-17 19:55:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
a88386ad44 Merge pull request \fI\%#43027\fP from pabloh007/fix\-docker\-save\-push\-2016\-11
.IP \(bu 2
d0fd949f85 Fixes ignore push flag for docker.push module issue \fI\%#42992\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42627\fP: (\fI\%taigrrr8\fP) salt\-cp no longer works.  Was working a few months back. (refs: \fI\%#42890\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42890\fP: (\fI\%DmitryKuzmenko\fP) Make chunked mode in salt\-cp optional
@ \fI2017\-08\-17 18:37:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
51d16840bb Merge pull request \fI\%#42890\fP from DSRCorporation/bugs/42627_salt\-cp
.IP \(bu 2
cfddbf1c75 Apply code review: update the doc
.IP \(bu 2
afedd3b654 Typos and version fixes in the doc.
.IP \(bu 2
9fedf6012e Fixed \(aqtest_valid_docs\(aq test.
.IP \(bu 2
999388680c Make chunked mode in salt\-cp optional (disabled by default).
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43009\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-08\-17 18:00:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
b3c253cdfa Merge pull request \fI\%#43009\fP from rallytime/merge\-2016.11
.IP \(bu 2
566ba4fe76 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
13b8637d53 Merge pull request \fI\%#42942\fP from Ch3LL/2016.3.6_follow_up
.INDENT 2.0
.IP \(bu 2
f281e1795f move additional minion config options to 2016.3.8 release notes
.IP \(bu 2
168604ba6b remove merge conflict
.IP \(bu 2
8a07d95212 update release notes with cve number
.IP \(bu 2
149633fdca Add release notes for 2016.3.7 release
.IP \(bu 2
7a4cddcd95 Add clean_id function to salt.utils.verify.py
.UNINDENT
.IP \(bu 2
bbb1b29ccb Merge pull request \fI\%#42954\fP from Ch3LL/latest_2016.3
.INDENT 2.0
.IP \(bu 2
b551e66744 [2016.3] Bump latest and previous versions
.UNINDENT
.IP \(bu 2
5d5edc54b7 Merge pull request \fI\%#42949\fP from Ch3LL/2016.3.7_docs
.INDENT 2.0
.IP \(bu 2
d75d3741f8 Add Security Notice to 2016.3.7 Release Notes
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43021\fP: (\fI\%terminalmage\fP) Use socket.AF_INET6 to get the correct value instead of doing an OS check
@ \fI2017\-08\-17 17:57:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43014\fP: (\fI\%Ch3LL\fP) Change AF_INET6 family for mac in test_host_to_ips (refs: \fI\%#43021\fP)
.IP \(bu 2
37c63e7cf2 Merge pull request \fI\%#43021\fP from terminalmage/fix\-network\-test
.IP \(bu 2
4089b7b1bc Use socket.AF_INET6 to get the correct value instead of doing an OS check
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43019\fP: (\fI\%rallytime\fP) Update bootstrap script to latest stable: v2017.08.17
@ \fI2017\-08\-17 17:56:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
8f6423247c Merge pull request \fI\%#43019\fP from rallytime/bootstrap_2017.08.17
.IP \(bu 2
2f762b3a17 Update bootstrap script to latest stable: v2017.08.17
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43014\fP: (\fI\%Ch3LL\fP) Change AF_INET6 family for mac in test_host_to_ips (refs: \fI\%#43021\fP)
@ \fI2017\-08\-17 16:17:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
ff1caeee68 Merge pull request \fI\%#43014\fP from Ch3LL/fix_network_mac
.IP \(bu 2
b8eee4401e Change AF_INET6 family for mac in test_host_to_ips
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42968\fP: (\fI\%vutny\fP) [DOCS] Fix link to Salt Cloud Feature Matrix
@ \fI2017\-08\-16 13:16:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
1ee9499d28 Merge pull request \fI\%#42968\fP from vutny/doc\-salt\-cloud\-ref
.IP \(bu 2
44ed53b1df [DOCS] Fix link to Salt Cloud Feature Matrix
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38839\fP: (\fI\%DaveOHenry\fP) Invoking runner.cloud.action via reactor sls fails (refs: \fI\%#42291\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42291\fP: (\fI\%vutny\fP) Fix \fI\%#38839\fP: remove \fIstate\fP from Reactor runner kwags
@ \fI2017\-08\-15 23:01:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
923f9741fe Merge pull request \fI\%#42291\fP from vutny/fix\-38839
.IP \(bu 2
5f8f98a01f Fix \fI\%#38839\fP: remove \fIstate\fP from Reactor runner kwags
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42644\fP: (\fI\%stamak\fP)   nova salt\-cloud \-P  Private IPs returned, but not public. Checking for misidentified IPs (refs: \fI\%#42940\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42940\fP: (\fI\%gtmanfred\fP) create new ip address before checking list of allocated ips
@ \fI2017\-08\-15 21:47:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
c20bc7d515 Merge pull request \fI\%#42940\fP from gtmanfred/2016.11
.IP \(bu 2
253e216a8d fix IP address spelling
.IP \(bu 2
bd63074e7a create new ip address before checking list of allocated ips
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42959\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42883\fP to 2016.11
@ \fI2017\-08\-15 21:25:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42883\fP: (\fI\%rallytime\fP) Fix failing boto tests (refs: \fI\%#42959\fP)
.IP \(bu 2
d6496eca72 Merge pull request \fI\%#42959\fP from rallytime/bp\-42883
.IP \(bu 2
c6b9ca4b9e Lint fix: add missing space
.IP \(bu 2
5597b1a30e Skip 2 failing tests in Python 3 due to upstream bugs
.IP \(bu 2
a0b19bdc27 Update account id value in boto_secgroup module unit test
.IP \(bu 2
60b406e088 @mock_elb needs to be changed to @mock_elb_deprecated as well
.IP \(bu 2
6ae1111295 Replace @mock_ec2 calls with @mock_ec2_deprecated calls
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42944\fP: (\fI\%Ch3LL\fP) [2016.11] Add clean_id function to salt.utils.verify.py
@ \fI2017\-08\-15 18:06:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
6366e05d0d Merge pull request \fI\%#42944\fP from Ch3LL/2016.11.6_follow_up
.IP \(bu 2
7e0a20afca Add release notes for 2016.11.7 release
.IP \(bu 2
63823f8c3e Add clean_id function to salt.utils.verify.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42952\fP: (\fI\%Ch3LL\fP) [2016.11] Bump latest and previous versions
@ \fI2017\-08\-15 17:23:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
49d339c976 Merge pull request \fI\%#42952\fP from Ch3LL/latest_2016.11
.IP \(bu 2
74e7055d54 [2016.11] Bump latest and previous versions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42950\fP: (\fI\%Ch3LL\fP) Add Security Notice to 2016.11.7 Release Notes
@ \fI2017\-08\-15 16:50:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
b0d2e05a79 Merge pull request \fI\%#42950\fP from Ch3LL/2016.11.7_docs
.IP \(bu 2
a6f902db40 Add Security Notice to 2016.11.77 Release Notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42836\fP: (\fI\%aneeshusa\fP) Backport salt.utils.versions from develop to 2016.11
@ \fI2017\-08\-14 20:56:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42835\fP: (\fI\%aneeshusa\fP) Fix typo in utils/versions.py module (refs: \fI\%#42836\fP)
.IP \(bu 2
c0ff69f88c Merge pull request \fI\%#42836\fP from lyft/backport\-utils.versions\-to\-2016.11
.IP \(bu 2
86ce7004a2 Backport salt.utils.versions from develop to 2016.11
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42919\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42871\fP to 2016.11
@ \fI2017\-08\-14 20:44:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42871\fP: (\fI\%amalleo25\fP) Update joyent.rst (refs: \fI\%#42919\fP)
.IP \(bu 2
64a79dd5ac Merge pull request \fI\%#42919\fP from rallytime/bp\-42871
.IP \(bu 2
4e46c968e6 Update joyent.rst
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42803\fP: (\fI\%gmcwhistler\fP) master_type: str, not working as expected, parent salt\-minion process dies. (refs: \fI\%#42848\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#42753\fP: (\fI\%grichmond\-salt\fP) SaltReqTimeout Error on Some Minions when One Master in a Multi\-Master Configuration is Unavailable (refs: \fI\%#42848\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42918\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42848\fP to 2016.11
@ \fI2017\-08\-14 20:43:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42848\fP: (\fI\%DmitryKuzmenko\fP) Execute fire_master asynchronously in the main minion thread. (refs: \fI\%#42918\fP)
.IP \(bu 2
bea8ec1098 Merge pull request \fI\%#42918\fP from rallytime/bp\-42848
.IP \(bu 2
cdb48126f7 Make lint happier.
.IP \(bu 2
62eca9b00b Execute fire_master asynchronously in the main minion thread.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42861\fP: (\fI\%twangboy\fP) Fix pkg.install salt\-minion using salt\-call
@ \fI2017\-08\-14 19:07:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
52bce329cb Merge pull request \fI\%#42861\fP from twangboy/win_pkg_install_salt
.IP \(bu 2
0d3789f0c6 Fix pkg.install salt\-minion using salt\-call
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42798\fP: (\fI\%s\-sebastian\fP) Update return data before calling returners
@ \fI2017\-08\-14 15:51:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
b9f4f87aa5 Merge pull request \fI\%#42798\fP from s\-sebastian/2016.11
.IP \(bu 2
1cc86592ed Update return data before calling returners
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41976\fP: (\fI\%abulford\fP) dockerng network states do not respect test=True (refs: \fI\%#41977\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41977\fP: (\fI\%abulford\fP) Fix dockerng.network_* ignoring of tests=True
@ \fI2017\-08\-11 18:37:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
c15d0034fe Merge pull request \fI\%#41977\fP from redmatter/fix\-dockerng\-network\-ignores\-test
.IP \(bu 2
1cc2aa503a Fix dockerng.network_* ignoring of tests=True
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42886\fP: (\fI\%sarcasticadmin\fP) Adding missing output flags to salt cli docs
@ \fI2017\-08\-11 18:35:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
3b9c3c5671 Merge pull request \fI\%#42886\fP from sarcasticadmin/adding_docs_salt_outputs
.IP \(bu 2
744bf954ff Adding missing output flags to salt cli
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42882\fP: (\fI\%gtmanfred\fP) make sure cmd is not run when npm isn\(aqt installed
@ \fI2017\-08\-11 17:53:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
e5b98c8a88 Merge pull request \fI\%#42882\fP from gtmanfred/2016.11
.IP \(bu 2
da3402a53d make sure cmd is not run when npm isn\(aqt installed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42788\fP: (\fI\%amendlik\fP) Remove waits and retries from Saltify deployment
@ \fI2017\-08\-11 15:38:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
5962c9588b Merge pull request \fI\%#42788\fP from amendlik/saltify\-timeout
.IP \(bu 2
928b523797 Remove waits and retries from Saltify deployment
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42877\fP: (\fI\%terminalmage\fP) Add virtual func for cron state module
@ \fI2017\-08\-11 15:33:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
227ecddd13 Merge pull request \fI\%#42877\fP from terminalmage/add\-cron\-state\-virtual
.IP \(bu 2
f1de196740 Add virtual func for cron state module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42859\fP: (\fI\%terminalmage\fP) Add note about git CLI requirement for GitPython to GitFS tutorial
@ \fI2017\-08\-11 14:53:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab9f6cef33 Merge pull request \fI\%#42859\fP from terminalmage/gitpython\-git\-cli\-note
.IP \(bu 2
35e05c9515 Add note about git CLI requirement for GitPython to GitFS tutorial
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#475\fP: (\fI\%rallytime\fP) Arch is failing npm cache test (refs: \fI\%#42856\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#41770\fP: (\fI\%Ch3LL\fP) NPM v5 incompatible with salt.modules.cache_list (refs: \fI\%#42856\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42856\fP: (\fI\%gtmanfred\fP) skip cache_clean test if npm version is >= 5.0.0
@ \fI2017\-08\-11 13:39:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
682b4a8d14 Merge pull request \fI\%#42856\fP from gtmanfred/2016.11
.IP \(bu 2
b458b89fb8 skip cache_clean test if npm version is >= 5.0.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42864\fP: (\fI\%whiteinge\fP) Make syndic_log_file respect root_dir setting
@ \fI2017\-08\-11 13:28:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
01ea854029 Merge pull request \fI\%#42864\fP from whiteinge/syndic\-log\-root_dir
.IP \(bu 2
4b1f55da9c Make syndic_log_file respect root_dir setting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42851\fP: (\fI\%terminalmage\fP) Backport \fI\%#42651\fP to 2016.11
@ \fI2017\-08\-10 18:02:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42651\fP: (\fI\%gtmanfred\fP) python2\- prefix for fedora 26 packages (refs: \fI\%#42851\fP)
.IP \(bu 2
2dde1f77e9 Merge pull request \fI\%#42851\fP from terminalmage/bp\-42651
.IP \(bu 2
a3da86eea8 fix syntax
.IP \(bu 2
6ecdbcec1d make sure names are correct
.IP \(bu 2
f83b553d6e add py3 for versionlock
.IP \(bu 2
21934f61bb python2\- prefix for fedora 26 packages
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42683\fP: (\fI\%rgcosma\fP) Gluster module broken in 2017.7 (refs: \fI\%#42806\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42806\fP: (\fI\%rallytime\fP) Update doc references in glusterfs.volume_present
@ \fI2017\-08\-10 14:10:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
c746f79a3a Merge pull request \fI\%#42806\fP from rallytime/fix\-42683
.IP \(bu 2
8c8640d6b8 Update doc references in glusterfs.volume_present
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42829\fP: (\fI\%twangboy\fP) Fix passing version in pkgs as shown in docs
@ \fI2017\-08\-10 14:07:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
27a8a2695a Merge pull request \fI\%#42829\fP from twangboy/win_pkg_fix_install
.IP \(bu 2
83b9b230cd Add winrepo to docs about supporting versions in pkgs
.IP \(bu 2
81fefa6e67 Add ability to pass version in pkgs list
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42838\fP: (\fI\%twangboy\fP) Document requirements for win_pki
@ \fI2017\-08\-10 13:59:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
3c3ac6aeb2 Merge pull request \fI\%#42838\fP from twangboy/win_doc_pki
.IP \(bu 2
f0a1d06b46 Standardize PKI Client
.IP \(bu 2
7de687aa57 Document requirements for win_pki
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42805\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42552\fP to 2016.11
@ \fI2017\-08\-09 22:37:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42552\fP: (\fI\%remijouannet\fP) update consul module following this documentation \fI\%https://www.consul\fP\&.… (refs: \fI\%#42805\fP)
.IP \(bu 2
b3e2ae3c58 Merge pull request \fI\%#42805\fP from rallytime/bp\-42552
.IP \(bu 2
5a91c1f2d1 update consul module following this documentation \fI\%https://www.consul.io/api/acl/acl.html\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42731\fP: (\fI\%infoveinx\fP) http.query template_data render exception (refs: \fI\%#42804\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42804\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42784\fP to 2016.11
@ \fI2017\-08\-09 22:37:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42784\fP: (\fI\%gtmanfred\fP) only read file if ret is not a string in http.query (refs: \fI\%#42804\fP)
.IP \(bu 2
d2ee7934ed Merge pull request \fI\%#42804\fP from rallytime/bp\-42784
.IP \(bu 2
dbd29e4aaa only read file if it is not a string
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42826\fP: (\fI\%terminalmage\fP) Fix misspelling of \(dqversions\(dq
@ \fI2017\-08\-09 19:39:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
4cbf8057b3 Merge pull request \fI\%#42826\fP from terminalmage/fix\-spelling
.IP \(bu 2
00f93142e4 Fix misspelling of \(dqversions\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42786\fP: (\fI\%Ch3LL\fP) Fix typo for template_dict in http docs
@ \fI2017\-08\-08 18:14:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
de997edd90 Merge pull request \fI\%#42786\fP from Ch3LL/fix_typo
.IP \(bu 2
90a2fb66a2 Fix typo for template_dict in http docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42600\fP: (\fI\%twangboy\fP) Unable to set \(aqNot Configured\(aq using win_lgpo execution module (refs: \fI\%#42795\fP, \fI\%#42744\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42795\fP: (\fI\%lomeroe\fP) backport \fI\%#42744\fP to 2016.11
@ \fI2017\-08\-08 17:17:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42744\fP: (\fI\%lomeroe\fP) fix \fI\%#42600\fP in develop (refs: \fI\%#42795\fP)
.IP \(bu 2
bf6153ebe5 Merge pull request \fI\%#42795\fP from lomeroe/bp\-42744_201611
.IP \(bu 2
695f8c1ae4 fix \fI\%#42600\fP in develop
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42747\fP: (\fI\%whiteinge\fP) Outputters mutate data which can be a problem for Runners and perhaps other things (refs: \fI\%#42748\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42748\fP: (\fI\%whiteinge\fP) Workaround Orchestrate problem that highstate outputter mutates data
@ \fI2017\-08\-07 21:11:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
61fad97286 Merge pull request \fI\%#42748\fP from whiteinge/save\-before\-output
.IP \(bu 2
de60b77c82 Workaround Orchestrate problem that highstate outputter mutates data
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42764\fP: (\fI\%amendlik\fP) Fix infinite loop with salt\-cloud and Windows nodes
@ \fI2017\-08\-07 20:47:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
a4e3e7e786 Merge pull request \fI\%#42764\fP from amendlik/cloud\-win\-loop
.IP \(bu 2
f3dcfca4e0 Fix infinite loops on failed Windows deployments
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42690\fP: (\fI\%ChristianBeer\fP) git.latest state with remote set fails on first try (refs: \fI\%#42694\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42694\fP: (\fI\%gtmanfred\fP) allow adding extra remotes to a repository
@ \fI2017\-08\-07 18:08:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
da85326ad4 Merge pull request \fI\%#42694\fP from gtmanfred/2016.11
.IP \(bu 2
1a0457af51 allow adding extra remotes to a repository
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42642\fP: (\fI\%githubcdr\fP) state.augeas (refs: \fI\%#42669\fP, \fI\%#43202\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42669\fP: (\fI\%garethgreenaway\fP)  [2016.11] Fixes to augeas module
@ \fI2017\-08\-06 17:58:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
7b2119feee Merge pull request \fI\%#42669\fP from garethgreenaway/42642_2016_11_augeas_module_fix
.IP \(bu 2
24413084e2 Updating the call to shlex_split to pass the posix=False argument so that quotes are preserved.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42629\fP: (\fI\%xiaoanyunfei\fP) tornado api
@ \fI2017\-08\-03 22:21:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
30725769ed Merge pull request \fI\%#42629\fP from xiaoanyunfei/tornadoapi
.IP \(bu 2
1e13383b95 tornado api
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42655\fP: (\fI\%whiteinge\fP) Reenable cpstats for rest_cherrypy
@ \fI2017\-08\-03 20:44:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33806\fP: (\fI\%cachedout\fP) Work around upstream cherrypy bug (refs: \fI\%#42655\fP)
.IP \(bu 2
f0f00fcee1 Merge pull request \fI\%#42655\fP from whiteinge/rest_cherrypy\-reenable\-stats
.IP \(bu 2
deb6316d67 Fix lint errors
.IP \(bu 2
6bd91c8b03 Reenable cpstats for rest_cherrypy
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42686\fP: (\fI\%gilbsgilbs\fP) Unable to set multiple RabbitMQ tags (refs: \fI\%#42693\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42693\fP: (\fI\%gilbsgilbs\fP) Fix RabbitMQ tags not properly set.
@ \fI2017\-08\-03 20:23:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
21cf15f9c3 Merge pull request \fI\%#42693\fP from gilbsgilbs/fix\-rabbitmq\-tags
.IP \(bu 2
78fccdc7e2 Cast to list in case tags is a tuple.
.IP \(bu 2
287b57b5c5 Fix RabbitMQ tags not properly set.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41433\fP: (\fI\%sbojarski\fP) boto_cfn.present fails when reporting error for failed state (refs: \fI\%#42574\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42574\fP: (\fI\%sbojarski\fP) Fixed error reporting in \(dqboto_cfn.present\(dq function.
@ \fI2017\-08\-01 17:55:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
f2b0c9b4fa Merge pull request \fI\%#42574\fP from sbojarski/boto\-cfn\-error\-reporting
.IP \(bu 2
5c945f10c2 Fix debug message in \(dqboto_cfn._validate\(dq function.
.IP \(bu 2
181a1beecc Fixed error reporting in \(dqboto_cfn.present\(dq function.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42623\fP: (\fI\%terminalmage\fP) Fix unicode constructor in custom YAML loader
@ \fI2017\-07\-31 19:25:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
bc1effc4f2 Merge pull request \fI\%#42623\fP from terminalmage/fix\-unicode\-constructor
.IP \(bu 2
fcf45889dd Fix unicode constructor in custom YAML loader
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42515\fP: (\fI\%gtmanfred\fP) Allow not interpreting backslashes in the repl
@ \fI2017\-07\-28 16:00:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
cbf752cd73 Merge pull request \fI\%#42515\fP from gtmanfred/backslash
.IP \(bu 2
cc4e45656d Allow not interpreting backslashes in the repl
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42456\fP: (\fI\%gdubroeucq\fP) Use yum lib  (refs: \fI\%#42586\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42586\fP: (\fI\%gdubroeucq\fP) [Fix] yumpkg.py: add option to the command \(dqcheck\-update\(dq
@ \fI2017\-07\-27 23:52:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
549495831f Merge pull request \fI\%#42586\fP from gdubroeucq/2016.11
.IP \(bu 2
9c0b5cc1d6 Remove extra newline
.IP \(bu 2
d2ef4483e4 yumpkg.py: clean
.IP \(bu 2
a96f7c09e0 yumpkg.py: add option to the command \(dqcheck\-update\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41982\fP: (\fI\%abulford\fP) dockerng.network_* matches too easily (refs: \fI\%#41988\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41988\fP: (\fI\%abulford\fP) Fix dockerng.network_* name matching
@ \fI2017\-07\-27 21:25:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b45debf28 Merge pull request \fI\%#41988\fP from redmatter/fix\-dockerng\-network\-matching
.IP \(bu 2
9eea796da8 Add regression tests for \fI\%#41982\fP
.IP \(bu 2
3369f0072f Fix broken unit test test_network_absent
.IP \(bu 2
0ef6cf634c Add trace logging of dockerng.networks result
.IP \(bu 2
515c612808 Fix dockerng.network_* name matching
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42339\fP: (\fI\%isbm\fP) Bugfix: Jobs scheduled to run at a future time stay pending for Salt minions (bsc#1036125)
@ \fI2017\-07\-27 19:05:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
4b16109122 Merge pull request \fI\%#42339\fP from isbm/isbm\-jobs\-scheduled\-in\-a\-future\-bsc1036125
.IP \(bu 2
bbba84ce2d Bugfix: Jobs scheduled to run at a future time stay pending for Salt minions (bsc#1036125)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23516\fP: (\fI\%dkiser\fP) BUG: cron job scheduler sporadically works (refs: \fI\%#42077\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42077\fP: (\fI\%vutny\fP) Fix scheduled job run on Master if \fIwhen\fP parameter is a list
@ \fI2017\-07\-27 19:04:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41973\fP: (\fI\%vutny\fP) Fix Master/Minion scheduled jobs based on Cron expressions (refs: \fI\%#42077\fP)
.IP \(bu 2
6c5a7c604a Merge pull request \fI\%#42077\fP from vutny/fix\-jobs\-scheduled\-with\-whens
.IP \(bu 2
b1960cea44 Fix scheduled job run on Master if \fIwhen\fP parameter is a list
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42414\fP: (\fI\%vutny\fP) DOCS: unify hash sum with hash type format
@ \fI2017\-07\-27 18:48:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
f9cb536589 Merge pull request \fI\%#42414\fP from vutny/unify\-hash\-params\-format
.IP \(bu 2
d1f2a93368 DOCS: unify hash sum with hash type format
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42375\fP: (\fI\%dragonpaw\fP) salt.modules.*.__virtualname__ doens\(aqt work as documented. (refs: \fI\%#42523\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42523\fP: (\fI\%rallytime\fP) Add a mention of the True/False returns with __virtual__()
@ \fI2017\-07\-27 18:13:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
535c922511 Merge pull request \fI\%#42523\fP from rallytime/fix\-42375
.IP \(bu 2
685c2cced6 Add information about returning a tuple with an error message
.IP \(bu 2
fa466519c4 Add a mention of the True/False returns with __virtual__()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42527\fP: (\fI\%twangboy\fP) Document changes to Windows Update in Windows 10/Server 2016
@ \fI2017\-07\-27 17:45:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
0df0e7e749 Merge pull request \fI\%#42527\fP from twangboy/win_wua
.IP \(bu 2
0373791f2a Correct capatlization
.IP \(bu 2
af3bcc927b Document changes to Windows Update in 10/2016
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42551\fP: (\fI\%binocvlar\fP) Remove \(aq\-s\(aq (\-\-script) argument to parted within align_check function
@ \fI2017\-07\-27 17:35:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
69b06586da Merge pull request \fI\%#42551\fP from binocvlar/fix\-lack\-of\-align\-check\-output
.IP \(bu 2
c4fabaa192 Remove \(aq\-s\(aq (\-\-script) argument to parted within align_check function
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42403\fP: (\fI\%astronouth7303\fP) [2017.7] Pillar empty when state is applied from orchestrate (refs: \fI\%#42433\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42573\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42433\fP to 2016.11
@ \fI2017\-07\-27 13:51:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42433\fP: (\fI\%terminalmage\fP) Only force saltenv/pillarenv to be a string when not None (refs: \fI\%#42573\fP)
.IP \(bu 2
9e0b4e9faf Merge pull request \fI\%#42573\fP from rallytime/bp\-42433
.IP \(bu 2
0293429e24 Only force saltenv/pillarenv to be a string when not None
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42571\fP: (\fI\%twangboy\fP) Avoid loading system PYTHON* environment vars
@ \fI2017\-07\-26 22:48:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
e931ed2517 Merge pull request \fI\%#42571\fP from twangboy/win_add_pythonpath
.IP \(bu 2
d55a44dd1a Avoid loading user site packages
.IP \(bu 2
9af1eb2741 Ignore any PYTHON* environment vars already on the system
.IP \(bu 2
4e2fb03a95 Add pythonpath to batch files and service
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42371\fP: (\fI\%tsaridas\fP) Minion unresponsive after trying to failover (refs: \fI\%#42387\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42387\fP: (\fI\%DmitryKuzmenko\fP) Fix race condition in usage of weakvaluedict
@ \fI2017\-07\-25 20:57:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
de2f397041 Merge pull request \fI\%#42387\fP from DSRCorporation/bugs/42371_KeyError_WeakValueDict
.IP \(bu 2
e721c7eee2 Don\(aqt use \fIkey in weakvaluedict\fP because it could lie.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41955\fP: (\fI\%root360\-AndreasUlm\fP) rabbitmq 3.6.10 changed output => rabbitmq\-module broken (refs: \fI\%#41968\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41968\fP: (\fI\%root360\-AndreasUlm\fP) Fix rabbitmqctl output sanitizer for version 3.6.10
@ \fI2017\-07\-25 19:12:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
641a9d7efd Merge pull request \fI\%#41968\fP from root360\-AndreasUlm/fix\-rabbitmqctl\-output\-handler
.IP \(bu 2
76fd941d91 added tests for rabbitmq 3.6.10 output handler
.IP \(bu 2
3602af1e1b Fix rabbitmqctl output handler for 3.6.10
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42477\fP: (\fI\%aikar\fP) Invalid ssh_interface value prevents salt\-cloud provisioning without reason of why (refs: \fI\%#42479\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42479\fP: (\fI\%gtmanfred\fP) validate ssh_interface for ec2
@ \fI2017\-07\-25 18:37:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
66fede378a Merge pull request \fI\%#42479\fP from gtmanfred/interface
.IP \(bu 2
c32c1b2803 fix pylint
.IP \(bu 2
99ec634c6b validate ssh_interface for ec2
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42405\fP: (\fI\%felrivero\fP) The documentation is incorrectly compiled (PILLAR section) (refs: \fI\%#42516\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42516\fP: (\fI\%rallytime\fP) Add info about top file to pillar walk\-through example to include edit.vim
@ \fI2017\-07\-25 17:01:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
a925c7029a Merge pull request \fI\%#42516\fP from rallytime/fix\-42405
.IP \(bu 2
e3a6717efa Add info about top file to pillar walk\-through example to include edit.vim
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42417\fP: (\fI\%clem\-compilatio\fP) salt\-cloud \- openstack \- \(dqno more floating IP addresses\(dq error \- but public_ip in node (refs: \fI\%#42509\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42509\fP: (\fI\%clem\-compilatio\fP) Fix _assign_floating_ips in openstack.py
@ \fI2017\-07\-24 17:14:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
1bd5bbccc2 Merge pull request \fI\%#42509\fP from clem\-compilatio/fix\-42417
.IP \(bu 2
72924b06b8 Fix _assign_floating_ips in openstack.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42464\fP: (\fI\%garethgreenaway\fP) [2016.11] Small fix to modules/git.py
@ \fI2017\-07\-21 21:28:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
4bf35a74de Merge pull request \fI\%#42464\fP from garethgreenaway/2016_11_remove_tmp_identity_file
.IP \(bu 2
ff24102d51 Uncomment the line that removes the temporary identity file.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42357\fP: (\fI\%Giandom\fP) Salt pillarenv problem with slack engine (refs: \fI\%#42443\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42443\fP: (\fI\%garethgreenaway\fP) [2016.11] Fix to slack engine
@ \fI2017\-07\-21 15:48:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
e2120dbd0e Merge pull request \fI\%#42443\fP from garethgreenaway/42357_pass_args_kwargs_correctly
.IP \(bu 2
635810b3e3 Updating the slack engine in 2016.11 to pass the args and kwrags correctly to LocalClient
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42198\fP: (\fI\%shengis\fP) state sqlite3.row_absent fail with \(dqparameters are of unsupported type\(dq (refs: \fI\%#42200\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42200\fP: (\fI\%shengis\fP) Fix \fI\%#42198\fP
@ \fI2017\-07\-21 14:47:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
8262cc9054 Merge pull request \fI\%#42200\fP from shengis/sqlite3_fix_row_absent_2016.11
.IP \(bu 2
407b8f4bb3 Fix \fI\%#42198\fP If where_args is not set, not using it in the delete request.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42413\fP: (\fI\%goten4\fP) Invalid error message when proxy_host is set and tornado not installed (refs: \fI\%#42424\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42424\fP: (\fI\%goten4\fP) Fix error message when tornado or pycurl is not installed
@ \fI2017\-07\-20 21:53:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
d9df97e5a3 Merge pull request \fI\%#42424\fP from goten4/2016.11
.IP \(bu 2
1c0574d05e Fix error message when tornado or pycurl is not installed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42350\fP: (\fI\%twangboy\fP) Fixes problem with Version and OS Release related grains on certain versions of Python (2016.11)
@ \fI2017\-07\-19 17:07:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
42bb1a64ca Merge pull request \fI\%#42350\fP from twangboy/win_fix_ver_grains_2016.11
.IP \(bu 2
8c048403d7 Detect Server OS with a desktop release name
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42356\fP: (\fI\%meaksh\fP) Allow checking whether a function is available on the AliasesLoader wrapper
@ \fI2017\-07\-19 16:56:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a72e56f6b Merge pull request \fI\%#42356\fP from meaksh/2016.11\-AliasesLoader\-wrapper\-fix
.IP \(bu 2
915d94219e Allow checking whether a function is available on the AliasesLoader wrapper
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42368\fP: (\fI\%twangboy\fP) Remove build and dist directories before install (2016.11)
@ \fI2017\-07\-19 16:47:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
10eb7b7a79 Merge pull request \fI\%#42368\fP from twangboy/win_fix_build_2016.11
.IP \(bu 2
a7c910c31e Remove build and dist directories before install
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42370\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-07\-18 22:39:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
016189f62f Merge pull request \fI\%#42370\fP from rallytime/merge\-2016.11
.IP \(bu 2
0aa5dde1de Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
e9b0f20f8a Merge pull request \fI\%#42359\fP from Ch3LL/doc\-update\-2016.3
.INDENT 2.0
.IP \(bu 2
dc85b5edbe [2016.3] Update version numbers in doc config for 2017.7.0 release
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42360\fP: (\fI\%Ch3LL\fP) [2016.11] Update version numbers in doc config for 2017.7.0 release
@ \fI2017\-07\-18 19:23:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
f06a6f1796 Merge pull request \fI\%#42360\fP from Ch3LL/doc\-update\-2016.11
.IP \(bu 2
b90b7a7506 [2016.11] Update version numbers in doc config for 2017.7.0 release
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32400\fP: (\fI\%rallytime\fP) Document Default Config Values (refs: \fI\%#42319\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42319\fP: (\fI\%rallytime\fP) Add more documentation for config options that are missing from master/minion docs
@ \fI2017\-07\-18 18:02:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
e0595b0a0f Merge pull request \fI\%#42319\fP from rallytime/config\-docs
.IP \(bu 2
b40f980632 Add more documentation for config options that are missing from master/minion docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42333\fP: (\fI\%b3hni4\fP) Getting \(dqinvalid type of dict, a list is required\(dq when trying to configure engines in master config file (refs: \fI\%#42352\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42352\fP: (\fI\%CorvinM\fP) Multiple documentation fixes
@ \fI2017\-07\-18 15:10:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
78940400e3 Merge pull request \fI\%#42352\fP from CorvinM/issue42333
.IP \(bu 2
526b6ee14d Multiple documentation fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42353\fP: (\fI\%terminalmage\fP) is_windows is a function, not a propery/attribute
@ \fI2017\-07\-18 14:38:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
b256001760 Merge pull request \fI\%#42353\fP from terminalmage/fix\-git\-test
.IP \(bu 2
14cf6ce322 is_windows is a function, not a propery/attribute
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41116\fP: (\fI\%hrumph\fP) FAQ has wrong instructions for upgrading Windows minion. (refs: \fI\%#42264\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42264\fP: (\fI\%rallytime\fP) Update minion restart section in FAQ doc for windows
@ \fI2017\-07\-17 17:40:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
866a1febb4 Merge pull request \fI\%#42264\fP from rallytime/fix\-41116
.IP \(bu 2
bd638880e3 Add mono\-spacing to salt\-minion reference for consistency
.IP \(bu 2
30d62f43da Update minion restart section in FAQ doc for windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42194\fP: (\fI\%jryberg\fP) pkg version: latest are now broken, appending <package>\-latest to filename (refs: \fI\%#42275\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42275\fP: (\fI\%terminalmage\fP) pkg.installed: pack name/version into pkgs argument
@ \fI2017\-07\-17 17:38:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
9a707088ad Merge pull request \fI\%#42275\fP from terminalmage/issue42194
.IP \(bu 2
663874908a pkg.installed: pack name/version into pkgs argument
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41721\fP: (\fI\%sazaro\fP) state.sysrc broken when setting the value to YES or NO (refs: \fI\%#42269\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42269\fP: (\fI\%rallytime\fP) Add some clarity to \(dqmultiple quotes\(dq section of yaml docs
@ \fI2017\-07\-17 17:38:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
e588f235e0 Merge pull request \fI\%#42269\fP from rallytime/fix\-41721
.IP \(bu 2
f2250d474a Add a note about using different styles of quotes.
.IP \(bu 2
38d9b3d553 Add some clarity to \(dqmultiple quotes\(dq section of yaml docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42152\fP: (\fI\%dubb\-b\fP) salt\-cloud errors on Rackspace driver using \-out=yaml  (refs: \fI\%#42282\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42282\fP: (\fI\%rallytime\fP) Handle libcloud objects that throw RepresenterErrors with \-\-out=yaml
@ \fI2017\-07\-17 17:36:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
5aaa214a75 Merge pull request \fI\%#42282\fP from rallytime/fix\-42152
.IP \(bu 2
f032223843 Handle libcloud objects that throw RepresenterErrors with \-\-out=yaml
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42295\fP: (\fI\%lubyou\fP) file.absent fails on windows if the file to be removed has the \(dqreadonly\(dq attribute set (refs: \fI\%#42308\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42308\fP: (\fI\%lubyou\fP) Force file removal on Windows. Fixes \fI\%#42295\fP
@ \fI2017\-07\-17 17:12:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb5697a4bc Merge pull request \fI\%#42308\fP from lubyou/42295\-fix\-file\-absent\-windows
.IP \(bu 2
026ccf401a Force file removal on Windows. Fixes \fI\%#42295\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42267\fP: (\fI\%gzcwnk\fP) salt\-ssh not creating ssh keys automatically as per documentation (refs: \fI\%#42314\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42314\fP: (\fI\%rallytime\fP) Add clarification to salt ssh docs about key auto\-generation.
@ \fI2017\-07\-17 14:07:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
da2a8a518f Merge pull request \fI\%#42314\fP from rallytime/fix\-42267
.IP \(bu 2
c406046940 Add clarification to salt ssh docs about key auto\-generation.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41936\fP: (\fI\%michaelkarrer81\fP) git.latest identity does not set the correct user for the private key file on the minion (refs: \fI\%#41945\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41945\fP: (\fI\%garethgreenaway\fP) Fixes to modules/git.py
@ \fI2017\-07\-14 17:46:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
acadd54013 Merge pull request \fI\%#41945\fP from garethgreenaway/41936_allow_identity_files_with_user
.IP \(bu 2
44841e5626 Moving the call to cp.get_file inside the with block to ensure the umask is preserved when we grab the file.
.IP \(bu 2
f9ba60eed8 Merge pull request \fI\%#1\fP from terminalmage/pr\-41945
.INDENT 2.0
.IP \(bu 2
1b6026177c Restrict set_umask to mkstemp call only
.UNINDENT
.IP \(bu 2
68549f3496 Fixing umask to we can set files as executable.
.IP \(bu 2
4949bf3ff3 Updating to swap on the new salt.utils.files.set_umask context_manager
.IP \(bu 2
8faa9f6d92 Updating PR with requested changes.
.IP \(bu 2
494765e939 Updating the git module to allow an identity file to be used when passing the user parameter
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42240\fP: (\fI\%casselt\fP) empty_password in user.present always changes password, even with test=True (refs: \fI\%#42289\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42289\fP: (\fI\%CorvinM\fP) Multiple empty_password fixes for state.user
@ \fI2017\-07\-14 16:14:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41543\fP: (\fI\%cri\-epita\fP) Fix user creation with empty password (refs: \fI\%#42289\fP)
.IP \(bu 2
f90e04a2bc Merge pull request \fI\%#42289\fP from CorvinM/bp\-41543
.IP \(bu 2
357dc22f05 Fix user creation with empty password
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42123\fP: (\fI\%vutny\fP) DOCS: describe importing custom util classes
@ \fI2017\-07\-12 15:53:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
a91a3f81b1 Merge pull request \fI\%#42123\fP from vutny/fix\-master\-utils\-import
.IP \(bu 2
6bb8b8f98c Add missing doc for \fButils_dirs\fP Minion config option
.IP \(bu 2
f1bc58f6d5 Utils: add example of module import
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42261\fP: (\fI\%rallytime\fP) Some minor doc fixes for dnsutil module so they\(aqll render correctly
@ \fI2017\-07\-11 23:14:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
e2aa5114e4 Merge pull request \fI\%#42261\fP from rallytime/minor\-doc\-fix
.IP \(bu 2
8c76bbb53d Some minor doc fixes for dnsutil module so they\(aqll render correctly
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42262\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42224\fP to 2016.11
@ \fI2017\-07\-11 23:14:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42224\fP: (\fI\%tdutrion\fP) Remove duplicate instruction in Openstack Rackspace config example (refs: \fI\%#42262\fP)
.IP \(bu 2
3e9dfbc9cc Merge pull request \fI\%#42262\fP from rallytime/bp\-42224
.IP \(bu 2
c31ded341c Remove duplicate instruction in Openstack Rackspace config example
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42137\fP: (\fI\%kiemlicz\fP) cmd.run with multiple commands \- random order of execution (refs: \fI\%#42181\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42181\fP: (\fI\%garethgreenaway\fP) fixes to state.py for names parameter
@ \fI2017\-07\-11 21:21:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
7780579c36 Merge pull request \fI\%#42181\fP from garethgreenaway/42137_backport_fix_from_2017_7
.IP \(bu 2
a34970b45b Back porting the fix for 2017.7 that ensures the order of the names parameter.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42253\fP: (\fI\%gtmanfred\fP) Only use unassociated ips when unable to allocate
@ \fI2017\-07\-11 20:53:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38965\fP: (\fI\%toanju\fP) salt\-cloud will use list_floating_ips for OpenStack (refs: \fI\%#42253\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34280\fP: (\fI\%kevinanderson1\fP) salt\-cloud will use list_floating_ips for Openstack (refs: \fI\%#38965\fP)
.IP \(bu 2
72537868a6 Merge pull request \fI\%#42253\fP from gtmanfred/2016.11
.IP \(bu 2
53e25760be Only use unassociated ips when unable to allocate
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42252\fP: (\fI\%UtahDave\fP) simple docstring updates
@ \fI2017\-07\-11 20:48:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
b2a4698b5d Merge pull request \fI\%#42252\fP from UtahDave/2016.11local
.IP \(bu 2
e6a9563d47 simple doc updates
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42232\fP: (\fI\%astronouth7303\fP) Half of dnsutil refers to dig (refs: \fI\%#42235\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42235\fP: (\fI\%astronouth7303\fP) Abolish references to \fIdig\fP in examples.
@ \fI2017\-07\-10 20:06:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
781fe13be7 Merge pull request \fI\%#42235\fP from astronouth7303/patch\-1\-2016.3
.IP \(bu 2
4cb51bd03a Make note of dig partial requirement.
.IP \(bu 2
08e7d8351a Abolish references to \fIdig\fP in examples.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42215\fP: (\fI\%twangboy\fP) Add missing config to example
@ \fI2017\-07\-07 20:18:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
83cbd76f16 Merge pull request \fI\%#42215\fP from twangboy/win_iis_docs
.IP \(bu 2
c07e22041a Add missing config to example
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42211\fP: (\fI\%terminalmage\fP) Only pass a saltenv in orchestration if one was explicitly passed (2016.11)
@ \fI2017\-07\-07 20:16:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
274946ab00 Merge pull request \fI\%#42211\fP from terminalmage/issue40928
.IP \(bu 2
22a18fa2ed Only pass a saltenv in orchestration if one was explicitly passed (2016.11)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42173\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37424\fP to 2016.11
@ \fI2017\-07\-07 16:39:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37424\fP: (\fI\%kojiromike\fP) Avoid Early Convert ret[\(aqcomment\(aq] to String (refs: \fI\%#42173\fP)
.IP \(bu 2
89261cf06c Merge pull request \fI\%#42173\fP from rallytime/bp\-37424
.IP \(bu 2
01addb6053 Avoid Early Convert ret[\(aqcomment\(aq] to String
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39365\fP: (\fI\%dglloyd\fP) service.running fails if sysv script has no status command and enable: True (refs: \fI\%#39366\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42175\fP: (\fI\%rallytime\fP) Back\-port \fI\%#39366\fP to 2016.11
@ \fI2017\-07\-06 19:51:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39366\fP: (\fI\%dglloyd\fP) Pass sig to service.status in after_toggle (refs: \fI\%#42175\fP)
.IP \(bu 2
3b17fb7f83 Merge pull request \fI\%#42175\fP from rallytime/bp\-39366
.IP \(bu 2
53f7b987e8 Pass sig to service.status in after_toggle
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42172\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-07\-06 18:16:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea16f47f0a Merge pull request \fI\%#42172\fP from rallytime/merge\-2016.11
.IP \(bu 2
b1fa332a11 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
8fa1fa5bb1 Merge pull request \fI\%#42155\fP from phsteve/doc\-fix\-puppet
.INDENT 2.0
.IP \(bu 2
fb2cb78a31 Fix docs for puppet.plugin_sync so code\-block renders properly and sync is spelled consistently
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42176\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42109\fP to 2016.11
@ \fI2017\-07\-06 18:15:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42109\fP: (\fI\%arthurlogilab\fP) [doc] Update aws.rst \- add Debian default username (refs: \fI\%#42176\fP)
.IP \(bu 2
6307b9873f Merge pull request \fI\%#42176\fP from rallytime/bp\-42109
.IP \(bu 2
686926daf7 Update aws.rst \- add Debian default username
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42095\fP: (\fI\%terminalmage\fP) Add debug logging to dockerng.login
@ \fI2017\-07\-06 17:13:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
28c4e4c3b7 Merge pull request \fI\%#42095\fP from terminalmage/docker\-login\-debugging
.IP \(bu 2
bd27870a71 Add debug logging to dockerng.login
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42116\fP: (\fI\%terminalmage\fP) CLI pillar override regression in 2017.7.0rc1 (refs: \fI\%#42119\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42119\fP: (\fI\%terminalmage\fP) Fix regression in CLI pillar override for salt\-call
@ \fI2017\-07\-06 17:02:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
2b754bc5af Merge pull request \fI\%#42119\fP from terminalmage/issue42116
.IP \(bu 2
9a268949e3 Add integration test for 42116
.IP \(bu 2
1bb42bb609 Fix regression when CLI pillar override is used with salt\-call
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42114\fP: (\fI\%clallen\fP) saltenv bug in pillar.get execution module function (refs: \fI\%#42121\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42121\fP: (\fI\%terminalmage\fP) Fix pillar.get when saltenv is passed
@ \fI2017\-07\-06 16:52:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
8c0a83cbb5 Merge pull request \fI\%#42121\fP from terminalmage/issue42114
.IP \(bu 2
d14291267f Fix pillar.get when saltenv is passed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42094\fP: (\fI\%terminalmage\fP) Prevent command from showing in exception when output_loglevel=quiet
@ \fI2017\-07\-06 16:18:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
687992c240 Merge pull request \fI\%#42094\fP from terminalmage/quiet\-exception
.IP \(bu 2
47d61f4edf Prevent command from showing in exception when output_loglevel=quiet
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42115\fP: (\fI\%nomeelnoj\fP) Installing EPEL repo breaks salt\-cloud (refs: \fI\%#42163\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42163\fP: (\fI\%vutny\fP) Fix \fI\%#42115\fP: parse libcloud \(dqrc\(dq version correctly
@ \fI2017\-07\-06 16:15:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
dad255160c Merge pull request \fI\%#42163\fP from vutny/fix\-42115
.IP \(bu 2
b27b1e340a Fix \fI\%#42115\fP: parse libcloud \(dqrc\(dq version correctly
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42164\fP: (\fI\%Ch3LL\fP) Fix kerberos create_keytab doc
@ \fI2017\-07\-06 15:55:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
2a8ae2b3b6 Merge pull request \fI\%#42164\fP from Ch3LL/fix_kerb_doc
.IP \(bu 2
7c0fb248ec Fix kerberos create_keytab doc
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42141\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42098\fP to 2016.11
@ \fI2017\-07\-06 15:11:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42098\fP: (\fI\%twangboy\fP) Change repo_ng to repo\-ng (refs: \fI\%#42141\fP)
.IP \(bu 2
678d4d4098 Merge pull request \fI\%#42141\fP from rallytime/bp\-42098
.IP \(bu 2
bd80243233 Change repo_ng to repo\-ng
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42140\fP: (\fI\%rallytime\fP) Back\-port \fI\%#42097\fP to 2016.11
@ \fI2017\-07\-06 15:11:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42097\fP: (\fI\%gtmanfred\fP) require large timediff for ipv6 warning (refs: \fI\%#42140\fP)
.IP \(bu 2
c8afd7a3c9 Merge pull request \fI\%#42140\fP from rallytime/bp\-42097
.IP \(bu 2
9c4e132540 Import datetime
.IP \(bu 2
1435bf177e require large timediff for ipv6 warning
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42142\fP: (\fI\%Ch3LL\fP) Update builds available for rc1
@ \fI2017\-07\-05 21:11:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
c239664c8b Merge pull request \fI\%#42142\fP from Ch3LL/change_builds
.IP \(bu 2
e1694af39c Update builds available for rc1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42078\fP: (\fI\%damon\-atkins\fP) pkg.install and pkg.remove fix version number input.
@ \fI2017\-07\-05 06:04:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
4780d7830a Merge pull request \fI\%#42078\fP from damon\-atkins/fix_convert_flt_str_version_on_cmd_line
.IP \(bu 2
09d37dd892 Fix comment typo
.IP \(bu 2
7167549425 Handle version=None  when converted to a string it becomes \(aqNone\(aq parm should default to empty string rather than None, it would fix better with existing code.
.IP \(bu 2
4fb2bb1856 Fix typo
.IP \(bu 2
cf55c3361c pkg.install and pkg.remove on the command line take number version numbers, store them within a float. However version is a string, to support versions numbers like 1.3.4
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42105\fP: (\fI\%Ch3LL\fP) Update releasecanddiate doc with new 2017.7.0rc1 Release
@ \fI2017\-07\-04 03:14:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
46d575acbc Merge pull request \fI\%#42105\fP from Ch3LL/update_rc
.IP \(bu 2
d4e7b91608 Update releasecanddiate doc with new 2017.7.0rc1 Release
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41885\fP: (\fI\%astronouth7303\fP) Recommended pip installation outdated? (refs: \fI\%#42099\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42099\fP: (\fI\%rallytime\fP) Remove references in docs to pip install salt\-cloud
@ \fI2017\-07\-03 22:13:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
d38548bbbd Merge pull request \fI\%#42099\fP from rallytime/fix\-41885
.IP \(bu 2
c2822e05ad Remove references in docs to pip install salt\-cloud
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42076\fP: (\fI\%abulford\fP) dockerng.volume_present test looks as though it would cause a change (refs: \fI\%#42086\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42086\fP: (\fI\%abulford\fP) Make result=true if Docker volume already exists
@ \fI2017\-07\-03 15:48:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
81d606a8cb Merge pull request \fI\%#42086\fP from redmatter/fix\-dockerng\-volume\-present\-result
.IP \(bu 2
8d549685a7 Make result=true if Docker volume already exists
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25842\fP: (\fI\%shikhartanwar\fP) Running salt\-minion as non\-root user to execute sudo commands always returns an error (refs: \fI\%#42021\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42021\fP: (\fI\%gtmanfred\fP) Set concurrent to True when running states with sudo
@ \fI2017\-06\-30 21:02:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
7160697123 Merge pull request \fI\%#42021\fP from gtmanfred/2016.11
.IP \(bu 2
26beb18aa5 Set concurrent to True when running states with sudo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42029\fP: (\fI\%terminalmage\fP) Mock socket.getaddrinfo in unit.utils.network_test.NetworkTestCase.test_host_to_ips
@ \fI2017\-06\-30 20:58:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
b784fbbdf8 Merge pull request \fI\%#42029\fP from terminalmage/host_to_ips
.IP \(bu 2
26f848e111 Mock socket.getaddrinfo in unit.utils.network_test.NetworkTestCase.test_host_to_ips
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42055\fP: (\fI\%dmurphy18\fP) Upgrade support for gnupg v2.1 and higher
@ \fI2017\-06\-30 20:54:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
e067020b9b Merge pull request \fI\%#42055\fP from dmurphy18/handle_gnupgv21
.IP \(bu 2
e20cea6350 Upgrade support for gnupg v2.1 and higher
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42048\fP: (\fI\%Ch3LL\fP) Add initial 2016.11.7 Release Notes
@ \fI2017\-06\-30 16:00:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
74ba2abc48 Merge pull request \fI\%#42048\fP from Ch3LL/add_11.7
.IP \(bu 2
1de5e008a0 Add initial 2016.11.7 Release Notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42024\fP: (\fI\%leeclemens\fP) doc: Specify versionadded for SELinux policy install/uninstall
@ \fI2017\-06\-29 23:29:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca4e619edb Merge pull request \fI\%#42024\fP from leeclemens/doc/selinux
.IP \(bu 2
b63a3c0fae doc: Specify versionadded for SELinux policy install/uninstall
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#41961\fP: (\fI\%cachedout\fP) Allow docs to be built under Python 3 (refs: \fI\%#42028\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42030\fP: (\fI\%whiteinge\fP) Re\-add msgpack to mocked imports
@ \fI2017\-06\-29 20:47:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42028\fP: (\fI\%whiteinge\fP) Revert \(dqAllow docs to be built under Python 3\(dq (refs: \fI\%#42030\fP)
.IP \(bu 2
50856d0e28 Merge pull request \fI\%#42030\fP from whiteinge/revert\-py3\-doc\-chagnes\-pt\-2
.IP \(bu 2
18dfa9893c Re\-add msgpack to mocked imports
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#41961\fP: (\fI\%cachedout\fP) Allow docs to be built under Python 3 (refs: \fI\%#42028\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#42028\fP: (\fI\%whiteinge\fP) Revert \(dqAllow docs to be built under Python 3\(dq (refs: \fI\%#42030\fP)
@ \fI2017\-06\-29 19:47:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
53031d2f55 Merge pull request \fI\%#42028\fP from saltstack/revert\-41961\-py3_doc
.IP \(bu 2
5592e6e5d4 Revert \(dqAllow docs to be built under Python 3\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42013\fP: (\fI\%dusto\fP) Misspelled nozeroconf in salt/modules/rh_ip.py (refs: \fI\%#42017\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42017\fP: (\fI\%lorengordon\fP) Fixes typo \(dqnozerconf\(dq \-> \(dqnozeroconf\(dq
@ \fI2017\-06\-29 17:30:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
1416bf70b9 Merge pull request \fI\%#42017\fP from lorengordon/issue\-42013
.IP \(bu 2
b6cf5f2528 Fixes typo nozerconf \-> nozeroconf
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41906\fP: (\fI\%terminalmage\fP) Better support for numeric saltenvs
@ \fI2017\-06\-29 17:19:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
0ebb50b601 Merge pull request \fI\%#41906\fP from terminalmage/numeric\-saltenv
.IP \(bu 2
2d798de982 Better support for numeric saltenvs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41995\fP: (\fI\%terminalmage\fP) Temporarily set the umask before writing an auth token
@ \fI2017\-06\-29 01:09:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a3c03c2d5 Merge pull request \fI\%#41995\fP from terminalmage/token\-umask
.IP \(bu 2
4f54b0069f Temporarily set the umask before writing an auth token
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41999\fP: (\fI\%terminalmage\fP) Update IP address for unit.utils.network_test.NetworkTestCase.test_host_to_ips
@ \fI2017\-06\-29 01:01:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
e3801b0e78 Merge pull request \fI\%#41999\fP from terminalmage/fix\-network\-test
.IP \(bu 2
fb6a93314f Update IP address for unit.utils.network_test.NetworkTestCase.test_host_to_ips
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18659\fP: (\fI\%whiteinge\fP) mod_aggregate not working for list\-form configuration (refs: \fI\%#41991\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41991\fP: (\fI\%Da\-Juan\fP) Accept a list for state_aggregate global setting
@ \fI2017\-06\-29 00:58:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
a7f38929cb Merge pull request \fI\%#41991\fP from Da\-Juan/fix\-state_aggregate\-list
.IP \(bu 2
c9075b8f84 Accept a list for state_aggregate setting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41993\fP: (\fI\%UtahDave\fP) change out salt support link to SaltConf link
@ \fI2017\-06\-29 00:55:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
7424f879a3 Merge pull request \fI\%#41993\fP from UtahDave/2016.11local
.IP \(bu 2
bff050ad52 change out salt support link to SaltConf link
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41987\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-06\-28 20:19:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
3b9ccf09d7 Merge pull request \fI\%#41987\fP from rallytime/merge\-2016.11
.IP \(bu 2
48867c4a82 Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
c589eae03f Merge pull request \fI\%#41981\fP from Ch3LL/11.6_3
.IP \(bu 2
2516ae1349 [2016.3] Bump latest release version to 2016.11.6
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41985\fP: (\fI\%rallytime\fP) Back\-port \fI\%#41780\fP to 2016.11
@ \fI2017\-06\-28 20:18:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41780\fP: (\fI\%ferringb\fP) Fix salt.util.render_jinja_tmpl usage for when not used in an environmnet (refs: \fI\%#41985\fP)
.IP \(bu 2
768339d734 Merge pull request \fI\%#41985\fP from rallytime/bp\-41780
.IP \(bu 2
8f8d3a473a Fix salt.util.render_jinja_tmpl usage for when not used in an environment.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34963\fP: (\fI\%craigafinch\fP) Incorrect behavior or documentation for comments in salt.states.pkgrepo.managed (refs: \fI\%#41820\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41986\fP: (\fI\%rallytime\fP) Back\-port \fI\%#41820\fP to 2016.11
@ \fI2017\-06\-28 20:18:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41820\fP: (\fI\%nhavens\fP) Fix yum repo file comments to work as documented in pkgrepo.managed (refs: \fI\%#41986\fP)
.IP \(bu 2
bd9090c0bf Merge pull request \fI\%#41986\fP from rallytime/bp\-41820
.IP \(bu 2
72320e35b9 Fix yum repo file comments to work as documented in pkgrepo.managed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41973\fP: (\fI\%vutny\fP) Fix Master/Minion scheduled jobs based on Cron expressions (refs: \fI\%#42077\fP)
@ \fI2017\-06\-28 16:39:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
a31da52635 Merge pull request \fI\%#41973\fP from vutny/fix\-croniter\-scheduled\-jobs
.IP \(bu 2
148788e652 Fix Master/Minion scheduled jobs based on Cron expressions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41980\fP: (\fI\%Ch3LL\fP) [2016.11] Bump latest release version to 2016.11.6
@ \fI2017\-06\-28 15:35:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
689ff93349 Merge pull request \fI\%#41980\fP from Ch3LL/11.6_11
.IP \(bu 2
fe4f5711d5 [2016.11] Bump latest release version to 2016.11.6
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41961\fP: (\fI\%cachedout\fP) Allow docs to be built under Python 3
@ \fI2017\-06\-27 21:11:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
82b1eb28ab Merge pull request \fI\%#41961\fP from cachedout/py3_doc
.IP \(bu 2
7aacddf6ef Allow docs to be built under Python 3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41948\fP: (\fI\%davidjb\fP) Fix Composer state\(aqs \fIname\fP docs; formatting
@ \fI2017\-06\-27 17:51:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41933\fP: (\fI\%davidjb\fP) Fix Composer state\(aqs \fIname\fP docs and improve formatting (refs: \fI\%#41948\fP)
.IP \(bu 2
f0eb51df17 Merge pull request \fI\%#41948\fP from davidjb/patch\-9
.IP \(bu 2
0e4b3d9a42 Fix Composer state\(aqs \fIname\fP docs; formatting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41914\fP: (\fI\%vutny\fP) archive.extracted: fix hash sum verification for local archives
@ \fI2017\-06\-26 17:59:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
e28e10ded2 Merge pull request \fI\%#41914\fP from vutny/fix\-archive\-extracted\-local\-file\-hash
.IP \(bu 2
54910fe55f archive.extracted: fix hash sum verification for local archives
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41912\fP: (\fI\%Ch3LL\fP) Allow pacman module to run on Manjaro
@ \fI2017\-06\-26 15:35:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
76ad6ff064 Merge pull request \fI\%#41912\fP from Ch3LL/fix_manjaro
.IP \(bu 2
e4dd72a3e7 Update os_name_map in core grains for new manjaro systems
.IP \(bu 2
aa7c839fc5 Allow pacman module to run on Manjaro
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38093\fP: (\fI\%DmitryKuzmenko\fP) Make threads avoid blocking waiting while communicating using TCP transport. (refs: \fI\%#41516\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41516\fP: (\fI\%kstreee\fP) Implements MessageClientPool to avoid blocking waiting for zeromq and tcp communications.
@ \fI2017\-06\-26 14:41:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37878\fP: (\fI\%kstreee\fP) Makes threads avoid blocking waiting while communicating using Zeromq. (refs: \fI\%#41516\fP)
.IP \(bu 2
ff67d47a2e Merge pull request \fI\%#41516\fP from kstreee/fix\-blocking\-waiting\-tcp\-connection
.IP \(bu 2
df96969959 Removes redundant closing statements.
.IP \(bu 2
94b9ea51eb Implements MessageClientPool to avoid blocking waiting for zeromq and tcp communications.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41888\fP: (\fI\%Ch3LL\fP) Add additional commits to 2016.11.6 release notes
@ \fI2017\-06\-22 16:19:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
c90cb6798a Merge pull request \fI\%#41888\fP from Ch3LL/change_release
.IP \(bu 2
4e1239d980 Add additional commits to 2016.11.6 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41882\fP: (\fI\%Ch3LL\fP) Add pycryptodome to crypt_test
@ \fI2017\-06\-21 19:51:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
4a326444fe Merge pull request \fI\%#41882\fP from Ch3LL/fix_crypt_test
.IP \(bu 2
6f70dbd0e1 Add pycryptodome to crypt_test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41877\fP: (\fI\%Ch3LL\fP) Fix netstat and routes test
@ \fI2017\-06\-21 16:16:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
13df29ed9b Merge pull request \fI\%#41877\fP from Ch3LL/fix_netstat_test
.IP \(bu 2
d2076a6c93 Patch salt.utils.which for test_route test
.IP \(bu 2
51f7e107dc Patch salt.utils.which for test_netstat test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41367\fP: (\fI\%lubyou\fP) certutil.add_store does not work on non english windows versions or on Windows 10 (localised or English) (refs: \fI\%#41566\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41566\fP: (\fI\%morganwillcock\fP) win_certutil: workaround for reading serial numbers with non\-English languages
@ \fI2017\-06\-21 15:40:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
66f8c83c93 Merge pull request \fI\%#41566\fP from morganwillcock/certutil
.IP \(bu 2
c337d52d0c Fix test data for test_get_serial, and a typo
.IP \(bu 2
7f6961378e test and lint fixes
.IP \(bu 2
8ee48432f4 Suppress output of crypt context and be more specific with whitespace vs. serial
.IP \(bu 2
61f817d172 Match serials based on output position (fix for non\-English languages)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41679\fP: (\fI\%terminalmage\fP) Prevent unnecessary duplicate pillar compilation
@ \fI2017\-06\-21 15:32:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
4d0f5c433d Merge pull request \fI\%#41679\fP from terminalmage/get\-top\-file\-envs
.IP \(bu 2
a916e8da49 Improve normalization of saltenv/pillarenv usage for states
.IP \(bu 2
02f293a19c Update state unit tests to reflect recent changes
.IP \(bu 2
b7e5c11165 Don\(aqt compile pillar data when getting top file envs
.IP \(bu 2
8d6fdb7c9a Don\(aqt compile pillar twice for salt\-call
.IP \(bu 2
d2abfbf4ed Add initial_pillar argument to salt.state
.IP \(bu 2
70186de532 salt.pillar: rename the \(dqpillar\(dq argument to \(dqpillar_override\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39668\fP: (\fI\%mirceaulinic\fP) Master scheduled job not recorded on the event bus (refs: \fI\%#41658\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#12653\fP: (\fI\%pengyao\fP) salt schedule doesn\(aqt return jobs result info to master (refs: \fI\%#41853\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41853\fP: (\fI\%vutny\fP) Fix master side scheduled jobs to return events
@ \fI2017\-06\-20 22:06:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41695\fP: (\fI\%xiaoanyunfei\fP) fix max RecursionError, Ellipsis (refs: \fI\%#41853\fP)
.IP \(bu 2
\fBPR\fP \fI\%#41658\fP: (\fI\%garethgreenaway\fP) Fixes to the salt scheduler (refs: \fI\%#41853\fP)
.IP \(bu 2
29b0acc3a2 Merge pull request \fI\%#41853\fP from vutny/fix\-master\-schedule\-event
.IP \(bu 2
e206c381c6 Fix master side scheduled jobs to return events
.UNINDENT
.UNINDENT
.SS Salt 2016.11.9 Release Notes
.sp
Version 2016.11.9 is a bugfix release for \fI\%2016.11.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB143\fP
.IP \(bu 2
Total Issue References: \fB60\fP
.IP \(bu 2
Total PR References: \fB167\fP
.IP \(bu 2
Contributors: \fB54\fP (\fI\%Ch3LL\fP, \fI\%UtahDave\fP, \fI\%VertigoRay\fP, \fI\%akissa\fP, \fI\%aogier\fP, \fI\%arthtux\fP,
\fI\%austinpapp\fP, \fI\%basepi\fP, \fI\%benediktwerner\fP, \fI\%bobrik\fP, \fI\%brejoc\fP, \fI\%cachedout\fP, \fI\%cetanu\fP,
\fI\%corywright\fP, \fI\%creideiki\fP, \fI\%cro\fP, \fI\%cruscio\fP, \fI\%damon\-atkins\fP, \fI\%dayid\fP, \fI\%defanator\fP,
\fI\%dereckson\fP, \fI\%dijit\fP, \fI\%doesitblend\fP, \fI\%garethgreenaway\fP, \fI\%gtmanfred\fP, \fI\%gurubert\fP,
\fI\%gvengel\fP, \fI\%jfindlay\fP, \fI\%johnj\fP, \fI\%jubrad\fP, \fI\%junovitch\fP, \fI\%lomeroe\fP, \fI\%lordcirth\fP,
\fI\%lorengordon\fP, \fI\%mattLLVW\fP, \fI\%meaksh\fP, \fI\%moio\fP, \fI\%msummers42\fP, \fI\%mtkennerly\fP,
\fI\%nicholasmhughes\fP, \fI\%oeuftete\fP, \fI\%rallytime\fP, \fI\%rasathus\fP, \fI\%roaldnefs\fP, \fI\%rossengeorgiev\fP,
\fI\%seanjnkns\fP, \fI\%senthilkumar\-e\fP, \fI\%techhat\fP, \fI\%terminalmage\fP, \fI\%twangboy\fP, \fI\%vernondcole\fP,
\fI\%vutny\fP, \fI\%whiteinge\fP, \fI\%whytewolf\fP)
.UNINDENT
.SS Windows Changes
.SS \fI\%pkg\fP Execution Module\(ga
.sp
Significate changes (PR #43708 & #45390, damon\-atkins) have been made to the
pkg execution module. Users should test this release against their existing
package sls definition files.
.INDENT 0.0
.IP \(bu 2
\fI\%pkg.list_available\fP no longer
defaults to refreshing the winrepo meta database.
.IP \(bu 2
\fI\%pkg.install\fP without a \fBversion\fP
parameter no longer upgrades software if the software is already installed.
Use \fBpkg.install version=latest\fP (or simply use a \fI\%pkg.latest\fP state to get the old behavior.
.IP \(bu 2
\fI\%pkg.list_pkgs\fP now returns
multiple versions if software installed more than once.
.IP \(bu 2
\fI\%pkg.list_pkgs\fP now returns \fBNot
Found\fP when the version is not found instead of \fB(value not set)\fP which
matches the contents of the sls definitions.
.IP \(bu 2
\fI\%pkg.remove\fP will wait up to 3 seconds
(normally about a second) to detect changes in the registry after removing
software, improving reporting of version changes.
.IP \(bu 2
\fI\%pkg.remove\fP can remove \fBlatest\fP
software, if \fBlatest\fP is defined in sls definition.
.IP \(bu 2
Documentation was update for the execution module to match the style in new
versions, some corrections as well.
.IP \(bu 2
All install/remove commands are prefix with cmd.exe shell and cmdmod is
called with a command line string instead of a list. Some sls files in
saltstack/salt\-winrepo\-ng expected the commands to be prefixed with cmd.exe
(i.e. the use of \fB&\fP).
.IP \(bu 2
Some execution module functions results, now behave more like their
Unix/Linux versions.
.UNINDENT
.SS \fI\%cmd\fP Execution Module
.sp
Due to a difference in how Python\(aqs \fBsubprocess.Popen()\fP spawns processes on
Windows, passing the command as a list of arguments can result in problems.
This is because Windows\(aq \fICreateProcess\fP requires the command to be passed as a
single string. Therefore, \fBsubprocess\fP will attempt to re\-assemble the list
of arguments into as string. Some escaped characters and quotes can cause the
resulting string to be incorrectly\-assembled, resulting in a failure to execute
the command.
.sp
Salt now deals with these cases by joining the list of arguments correctly and
ensuring that the command is passed to \fBsubprocess.Popen()\fP as a string.
.SS Changelog for v2016.11.8..v2016.11.9
.sp
\fIGenerated at: 2018\-05\-27 20:28:05 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#45638\fP: (\fI\%twangboy\fP) Win fix shell info
@ \fI2018\-01\-23 22:38:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
10812969f0 Merge pull request \fI\%#45638\fP from twangboy/win_fix_shell_info
.IP \(bu 2
872da3ffba Only convert text types in the list_values function
.IP \(bu 2
0e41535cdb Fix reg.py to only convert text types to unicode
.IP \(bu 2
3579534ea5 Fix issue with detecting powershell
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45564\fP: (\fI\%Ch3LL\fP) Add PR changes to 2016.11.9 Release Notes
@ \fI2018\-01\-19 21:36:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d1dd1186e Merge pull request \fI\%#45564\fP from Ch3LL/r\-notes\-2016
.IP \(bu 2
325f4cbcda Add PR changes to 2016.11.9 Release Notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45563\fP: (\fI\%Ch3LL\fP) Update man pages for 2016.11.9
@ \fI2018\-01\-19 21:19:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
28e4398150 Merge pull request \fI\%#45563\fP from Ch3LL/man_2016
.IP \(bu 2
529bc0c680 update release number for salt\-call man page 2016.11.9
.IP \(bu 2
11b7222148 Update man pages for 2016.11.9
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45532\fP: (\fI\%gtmanfred\fP) fix mock for opensuse
@ \fI2018\-01\-18 22:48:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
654df0f526 Merge pull request \fI\%#45532\fP from gtmanfred/2016.11.9
.IP \(bu 2
6c26025664 fix mock for opensuse
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45518\fP: (\fI\%gtmanfred\fP) fix last 2016.11.9 failing tests
@ \fI2018\-01\-18 12:03:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
571c33aa39 Merge pull request \fI\%#45518\fP from gtmanfred/2016.11.9
.IP \(bu 2
5455d2dee6 fix centos 6 pip test
.IP \(bu 2
40255194b0 fix fedora pkg test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45394\fP: (\fI\%dmurphy18\fP) git.latest fails when \(dqdepth\(dq  is used with a non\-default branch (refs: \fI\%#45399\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45443\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45399\fP to 2016.11.9
@ \fI2018\-01\-17 14:53:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45399\fP: (\fI\%terminalmage\fP) Fix git.latest failure when rev is not the default branch (refs: \fI\%#45443\fP)
.IP \(bu 2
4e0a0eec1f Merge pull request \fI\%#45443\fP from rallytime/bp\-45399\-2016.11.9
.IP \(bu 2
919e92c911 Fix git.latest failure when rev is not the default branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45432\fP: (\fI\%TheBigBear\fP) winrepo\-ng fault pkg.refresh_db doesn\(aqt work \- it processes ANY stray .git metadata *.sls files present on minion (refs: \fI\%#45493\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45493\fP: (\fI\%damon\-atkins\fP) win_pkg: pkg.refresh_db report an issue if a sls pkg definition does not contain a dict instead of aborting
@ \fI2018\-01\-17 14:52:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
ebd4db66b8 Merge pull request \fI\%#45493\fP from damon\-atkins/2016.11_fix_sls_defintion_wrong_type
.IP \(bu 2
af108440df win_pkg lint space after ,
.IP \(bu 2
c6e922a236 win_pkg lint issues
.IP \(bu 2
f4627d7a80 fix quote i.e. change \(ga to \(aq
.IP \(bu 2
6938a4c099 pkg.refresh_db report an issue if a sls pkg definition id not a dict instead of aborting.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45446\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45390\fP to 2016.11.9
@ \fI2018\-01\-16 20:08:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45390\fP: (\fI\%damon\-atkins\fP) win_pkg: fix pkg.remove, pkg.list_pkgs (refs: \fI\%#45446\fP)
.IP \(bu 2
7322efba92 Merge pull request \fI\%#45446\fP from rallytime/bp\-45390
.IP \(bu 2
69f045ea24 lint too\-many\-blank\-lines
.IP \(bu 2
10a7501ede Update release notes
.IP \(bu 2
6f2affe01c fix pkg.remove, pkg.list_pkgs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45424\fP: (\fI\%twangboy\fP) Fix some issues with reg.py
@ \fI2018\-01\-13 19:34:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
b0ece9f4d4 Merge pull request \fI\%#45424\fP from twangboy/win_reg
.IP \(bu 2
30f06205f7 Fix some issues with reg.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45327\fP: (\fI\%lomeroe\fP) Backport \fI\%#44861\fP to 2016.11
@ \fI2018\-01\-08 21:10:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44861\fP: (\fI\%twangboy\fP) Fix win_lgpo for unknown values (refs: \fI\%#45327\fP)
.IP \(bu 2
0959ae4ea3 Merge pull request \fI\%#45327\fP from lomeroe/bp\-44861_2016.11
.IP \(bu 2
784139f734 Check for values other than 0 or 1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45268\fP: (\fI\%damon\-atkins\fP) Fix pkg.install packagename version=latest i.e. if on an old version is installed
@ \fI2018\-01\-08 17:34:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
a6db5f95f0 Merge pull request \fI\%#45268\fP from damon\-atkins/2016.11_win_pkg_pkg_install_latest
.IP \(bu 2
325a9f0f66 Update 2016.11.9.rst
.IP \(bu 2
4da9200b9c Update 2016.11.9.rst
.IP \(bu 2
126aee36ac Update 2016.11.9.rst
.IP \(bu 2
1c01967943 Update 2016.11.9.rst
.IP \(bu 2
a0d89882b8 Fix pkg.install packagename version=latest i.e. if on an old version upgrade to the latest
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45256\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45034\fP to 2016.11
@ \fI2018\-01\-04 14:25:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45034\fP: (\fI\%brejoc\fP) Fix for pidfile removal logging (refs: \fI\%#45256\fP)
.IP \(bu 2
1c5e905b61 Merge pull request \fI\%#45256\fP from rallytime/bp\-45034
.IP \(bu 2
68f971b38f Apply test fixes from \fI\%#45034\fP to parsers_test.py
.IP \(bu 2
9454236694 Fix for pidfile removal logging
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-jenkins#598\fP: (\fI\%rallytime\fP) [oxygen] CentOS 7 is failing ~ 20 tests in the integration.ssh.test_state.SSHStateTest (refs: \fI\%#45209\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45235\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45209\fP to 2016.11
@ \fI2018\-01\-02 20:20:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45209\fP: (\fI\%gtmanfred\fP) enable UsePAM for ssh tests (refs: \fI\%#45235\fP)
.IP \(bu 2
b75f50afe3 Merge pull request \fI\%#45235\fP from rallytime/bp\-45209
.IP \(bu 2
2d0a9bbf7e enable UsePAM for ssh tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44965\fP: (\fI\%gtmanfred\fP) check if VALUE is a string_type
@ \fI2018\-01\-02 16:42:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ab962b01a Merge pull request \fI\%#44965\fP from gtmanfred/2016.11
.IP \(bu 2
a5d8a6340e check if VALUE is a string_type
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27160\fP: (\fI\%martinadolfi\fP) salt.states.mount persistence error using spaces in route (refs: \fI\%#45232\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45232\fP: (\fI\%rasathus\fP) Backport \fI\%#27160\fP to 2016.11
@ \fI2018\-01\-02 15:48:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
40fb30f63f Merge pull request \fI\%#45232\fP from rasathus/2016.11
.IP \(bu 2
7a2bd8f49b Merge branch \(aq2016.11\(aq into 2016.11
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44516\fP: (\fI\%doesitblend\fP) Windows PY3 Minion Returns UTF16 UnicodeError (refs: \fI\%#44944\fP, \fI\%#45161\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45161\fP: (\fI\%lomeroe\fP) Backport \fI\%#44944\fP to 2016.11
@ \fI2017\-12\-30 13:19:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44944\fP: (\fI\%lomeroe\fP) win_lgpo registry.pol encoding updates (refs: \fI\%#45161\fP)
.IP \(bu 2
707ef55175 Merge pull request \fI\%#45161\fP from lomeroe/bp\-44944_2016.11
.IP \(bu 2
0a4c6b5a83 remove references to six.unichr
.IP \(bu 2
f3196d795d lint fixes for static regexes
.IP \(bu 2
11b637d108 lint fixes
.IP \(bu 2
c14d6282ad do not decode registry.pol file wholesale, but instead decode individual elements of the file
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45188\fP: (\fI\%jak3kaj\fP) salt state status.process always returns false (refs: \fI\%#45199\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45199\fP: (\fI\%gtmanfred\fP) status.pid returns pid ids not process names
@ \fI2017\-12\-28 19:06:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
6f52034e08 Merge pull request \fI\%#45199\fP from gtmanfred/status
.IP \(bu 2
fb07f9ea7d status.pid returns pid ids not process names
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44728\fP: (\fI\%casselt\fP) Nodegroups can not be defined by glob with ? or seq (refs: \fI\%#45118\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45118\fP: (\fI\%garethgreenaway\fP) [2016.11] Fix to allow nodegroups to include sequences
@ \fI2017\-12\-27 18:49:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
d3381e27d0 Merge pull request \fI\%#45118\fP from garethgreenaway/44728_nodegroups_seq
.IP \(bu 2
0ff811de70 Swapping import to be the old path for 2016.11
.IP \(bu 2
b3e2f388f5 Fix to allow nodegroups to include sequences
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45127\fP: (\fI\%twangboy\fP) Fix issue with 1641 return code
@ \fI2017\-12\-22 15:18:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
f969aca3a3 Merge pull request \fI\%#45127\fP from twangboy/win_fix_pkg
.IP \(bu 2
14639739f2 Fix issue with 1641 return code
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45137\fP: (\fI\%twangboy\fP) Catch correct error type in list_keys and list_values
@ \fI2017\-12\-22 14:45:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
dc357b39f0 Merge pull request \fI\%#45137\fP from twangboy/win_fix_reg_tests
.IP \(bu 2
b6f4ef8d73 Catch correct error type in list_keys and list_values
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45130\fP: (\fI\%rallytime\fP) Resolve groups for salt api
@ \fI2017\-12\-21 20:38:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
0aa1662731 Merge pull request \fI\%#45130\fP from rallytime/api\-groups
.IP \(bu 2
2dcc8df845 Resolve groups for salt api
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45114\fP: (\fI\%twangboy\fP) Move pam library load to try/except block
@ \fI2017\-12\-21 14:37:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
7dc3cc4641 Merge pull request \fI\%#45114\fP from twangboy/win_fix_pam
.IP \(bu 2
cf5eae1f77 Move pam library load to try/except block
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45049\fP: (\fI\%vernondcole\fP) salt cloud module documentation is missing from the index. (refs: \fI\%#45070\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45100\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45070\fP to 2016.11
@ \fI2017\-12\-20 14:55:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45070\fP: (\fI\%vernondcole\fP) insert clouds modules in index (refs: \fI\%#45100\fP)
.IP \(bu 2
7e128e8f15 Merge pull request \fI\%#45100\fP from rallytime/bp\-45070
.IP \(bu 2
0bdb46dab9 add clouds modules to index
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45098\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45092\fP to 2016.11
@ \fI2017\-12\-20 14:40:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45092\fP: (\fI\%terminalmage\fP) Fix integration.states.test_pip.PipStateTest.test_pip_installed_weird_install (refs: \fI\%#45098\fP)
.IP \(bu 2
bdf93f339d Merge pull request \fI\%#45098\fP from rallytime/bp\-45092
.IP \(bu 2
80b6bd6813 Fix integration.states.test_pip.PipStateTest.test_pip_installed_weird_install
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41044\fP: (\fI\%pirxthepilot\fP) user.present \(aqdate\(aq parameter is not applying (refs: \fI\%#44078\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44078\fP: (\fI\%rossengeorgiev\fP) user.present: allow date param to be 0
@ \fI2017\-12\-19 15:59:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
324b7d4058 Merge pull request \fI\%#44078\fP from rossengeorgiev/fix\-41044
.IP \(bu 2
a81a6fe23c fix \fI\%#41044\fP; allow for date param to be 0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44970\fP: (\fI\%rallytime\fP) Update bootstrap script to latest release: 2017.12.13
@ \fI2017\-12\-19 15:49:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
48a59761df Merge pull request \fI\%#44970\fP from rallytime/update\-bootstrap\-script
.IP \(bu 2
b2c8057427 Update bootstrap script to latest release: 2017.12.13
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#45036\fP: (\fI\%dijit\fP) Quiet installation of packaged minions fails due to redistributable not being quietly installed [py3] [Windows] (refs: \fI\%#45040\fP)
.IP \(bu 2
\fBPR\fP \fI\%#45069\fP: (\fI\%rallytime\fP) Back\-port \fI\%#45040\fP to 2016.11
@ \fI2017\-12\-19 14:25:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#45040\fP: (\fI\%dijit\fP) Installation Fails on headless machines. (refs: \fI\%#45069\fP)
.IP \(bu 2
637fdaed58 Merge pull request \fI\%#45069\fP from rallytime/bp\-45040
.IP \(bu 2
aa438e1605 Installation Fails on headless machines.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
de53c45c29 Backport \fI\%#27160\fP to 2016.11
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41286\fP: (\fI\%arthtux\fP) boto_vpc.accept_vpc_peering_connection wait a object  (refs: \fI\%#41305\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44969\fP: (\fI\%rallytime\fP) Back\-port \fI\%#41305\fP to 2016.11
@ \fI2017\-12\-15 17:22:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#41305\fP: (\fI\%arthtux\fP) correct accept_vpc_peering_connection (refs: \fI\%#44969\fP)
.IP \(bu 2
4d6d640381 Merge pull request \fI\%#44969\fP from rallytime/bp\-41305
.IP \(bu 2
5c4bee43dc correct accept_vpc_peering_connection
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#45031\fP: (\fI\%terminalmage\fP) Fix invalid exception class in mysql returner
@ \fI2017\-12\-15 15:00:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
10de468f13 Merge pull request \fI\%#45031\fP from terminalmage/fix\-mysql\-returner
.IP \(bu 2
f3bd12c27c Fix invalid exception class in mysql returner
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44820\fP: (\fI\%msteed\fP) Custom returner breaks manage runner (refs: \fI\%#44958\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44972\fP: (\fI\%terminalmage\fP) Backport \fI\%#44958\fP to 2016.11 branch
@ \fI2017\-12\-14 16:56:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44958\fP: (\fI\%terminalmage\fP) Fix a race condition in manage runner (refs: \fI\%#44972\fP)
.IP \(bu 2
9a7406207f Merge pull request \fI\%#44972\fP from terminalmage/bp\-44958
.IP \(bu 2
a416bf0112 No need to manually do connect_pub, use listen=True in run_job
.IP \(bu 2
3ec004bd2e Fix a race condition in manage runner
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44378\fP: (\fI\%llua\fP) minion: infinite loop during start when schedule key is null  (refs: \fI\%#44385\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44385\fP: (\fI\%gtmanfred\fP) schedule should be a dict in opts
@ \fI2017\-12\-12 20:44:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
1032ca3290 Merge pull request \fI\%#44385\fP from gtmanfred/schedule
.IP \(bu 2
9e15c38da2 add comma
.IP \(bu 2
855d933cb7 schedule should be a dict
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44734\fP: (\fI\%cruscio\fP) Documentation inconsistency for minion ping_interval timing (refs: \fI\%#44770\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44770\fP: (\fI\%cruscio\fP) Fix minion ping_interval documentation
@ \fI2017\-12\-11 19:50:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
68d901b12c Merge pull request \fI\%#44770\fP from cruscio/2016.11
.IP \(bu 2
e2682bf441 Fix minion ping_interval documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44292\fP: (\fI\%andrew\-regan\fP) grains[\(aqvirtual_subtype\(aq] assignment for Docker broken on Mac (refs: \fI\%#44335\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44335\fP: (\fI\%gtmanfred\fP) add docker\-ce to docker subtype grains check
@ \fI2017\-12\-10 17:17:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
d4ab55ec47 Merge pull request \fI\%#44335\fP from gtmanfred/2016.11
.IP \(bu 2
3f1268d67f fix patching for python 2.6
.IP \(bu 2
1d0bd5bb32 Merge branch \(aq2016.11\(aq into 2016.11
.IP \(bu 2
f02b02032d Merge pull request \fI\%#4\fP from terminalmage/pr\-44335
.INDENT 2.0
.IP \(bu 2
b4eb1527a6 Add test for PR 44335
.UNINDENT
.IP \(bu 2
a30af3252e add docker\-ce to docker subtype grains check
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44530\fP: (\fI\%roaldnefs\fP) Identifier not working in salt.states.cron when special is used (refs: \fI\%#44579\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44579\fP: (\fI\%roaldnefs\fP) Fix bug in cron module and state \- Fixes \fI\%#44530\fP
@ \fI2017\-12\-07 20:18:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb1f8dceaf Merge pull request \fI\%#44579\fP from roaldnefs/fix\-cron\-identifier
.IP \(bu 2
df73a4c051 Merge branch \(aq2016.11\(aq into fix\-cron\-identifier
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44852\fP: (\fI\%damon\-atkins\fP) win_pkg fix spelling typos and minion option 2016.11
@ \fI2017\-12\-06 16:49:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
af0131fa1f Merge pull request \fI\%#44852\fP from damon\-atkins/2016.11_win_pkg_typo_n_fix
.IP \(bu 2
0e7c19084f Lint: Remove extra whitespace
.IP \(bu 2
7c7e21f94d Fix spelling typo, and fix backwards campatible minion option for repo location
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44365\fP: (\fI\%icycle77\fP) file.managed appears to ignore source_hash check (refs: \fI\%#44794\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44794\fP: (\fI\%terminalmage\fP) Fix regression in file.managed when source_hash used with local file
@ \fI2017\-12\-04 14:23:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
88c0d66b4e Merge pull request \fI\%#44794\fP from terminalmage/issue44365
.IP \(bu 2
3b8b6f25e6 Remove debugging line
.IP \(bu 2
153bf45b03 Fix regression in file.managed when source_hash used with local file
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35777\fP: (\fI\%rallytime\fP) Properly deprecate template context data in Fluorine (refs: \fI\%#44738\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#35523\fP: (\fI\%rallytime\fP) Come up with a reasonable alternative for lxc.edited_conf (refs: \fI\%#44738\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44738\fP: (\fI\%rallytime\fP) Bump some deprecation warnings from Oxygen to Fluorine
@ \fI2017\-12\-01 23:10:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
c8bb9dfbbb Merge pull request \fI\%#44738\fP from rallytime/bump\-oxygen\-warnings
.IP \(bu 2
ead3c569e1 Bump deprecation warnings from Oxygen to Fluorine
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44730\fP: (\fI\%msciciel\fP) State network.routes could not add route without gateway on centos7 (refs: \fI\%#44741\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44741\fP: (\fI\%gtmanfred\fP) if gateway is not specified use iface
@ \fI2017\-12\-01 23:09:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
88e3aab00d Merge pull request \fI\%#44741\fP from gtmanfred/rhip
.IP \(bu 2
439dc8dce6 if gateway is not specified use iface
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31405\fP: (\fI\%SEJeff\fP) Salt leaves tmp file when file.managed dest file is immutable (refs: \fI\%#44699\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44699\fP: (\fI\%jfindlay\fP) utils/files.py remove temp file upon move failure
@ \fI2017\-12\-01 15:03:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
97e0cf569c Merge pull request \fI\%#44699\fP from jfindlay/attr_file
.IP \(bu 2
9e5a40ea7c Merge branch \(aq2016.11\(aq into attr_file
.IP \(bu 2
5c34607f6c utils/files remove temp file upon move failure
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44556\fP: (\fI\%doesitblend\fP) \-\-static option doesn\(aqt return highstate output (refs: \fI\%#44714\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44714\fP: (\fI\%rallytime\fP) Allow \-\-static option to display state runs with highstate output
@ \fI2017\-12\-01 14:31:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
7434e0afdf Merge pull request \fI\%#44714\fP from rallytime/fix\-44556
.IP \(bu 2
1bbe1abeb2 Allow \-\-static option to display state runs with highstate output
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44517\fP: (\fI\%whytewolf\fP) Publish port doc missing
@ \fI2017\-11\-28 21:50:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
998d714ee7 Merge pull request \fI\%#44517\fP from whytewolf/publish_port_doc_missing
.IP \(bu 2
4b5855283a missed one place where i didn\(aqt chanbge master_port from my copy to publish_port
.IP \(bu 2
e4610baea5 update doc to have publish port
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#41279\fP: (\fI\%Ch3LL\fP) Add fqdn and dns core grain tests
@ \fI2017\-11\-27 21:28:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
6169b52749 Merge pull request \fI\%#41279\fP from Ch3LL/add_grain_tests
.IP \(bu 2
1b64f15692 Merge branch \(aq2016.11\(aq into add_grain_tests
.IP \(bu 2
095f1b7d7a Merge branch \(aq2016.11\(aq into add_grain_tests
.IP \(bu 2
9ea4db4224 mock socket.getaddrinfo
.IP \(bu 2
78a07e30f4 add more fqdn tests and remove some of the mocking
.IP \(bu 2
5dbf4144ce add ipv6 in opts
.IP \(bu 2
eabc1b4f9c Add fqdn and dns core grain tests
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
3ec4329307 Merge branch \(aq2016.11\(aq into fix\-cron\-identifier
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44544\fP: (\fI\%creideiki\fP) pgjsonb returner sets wrong timezone on timestamps in database when using Python 2 (refs: \fI\%#44563\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44563\fP: (\fI\%creideiki\fP) Send Unix timestamps to database in pgjsonb returner
@ \fI2017\-11\-21 17:44:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
dc6de050a9 Merge pull request \fI\%#44563\fP from creideiki/pgjsonb\-timestamps\-44544
.IP \(bu 2
231e412ca4 Merge branch \(aq2016.11\(aq into pgjsonb\-timestamps\-44544
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44601\fP: (\fI\%rallytime\fP) CherryPy 12.0 removed support for \(dqengine.timeout_monitor.on\(dq config option (refs: \fI\%#44602\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44602\fP: (\fI\%rallytime\fP) Handle timeout_monitor attribute error for new versions of CherryPy
@ \fI2017\-11\-20 21:38:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
4369df020b Merge pull request \fI\%#44602\fP from rallytime/fix\-44601
.IP \(bu 2
ff303fd060 Handle timeout_monitor/TimeoutError issues for new versions of CherryPy
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44604\fP: (\fI\%lorengordon\fP) Documents the exclude argument in state execution module
@ \fI2017\-11\-20 18:19:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
4a4756fc37 Merge pull request \fI\%#44604\fP from lorengordon/doc\-exclude
.IP \(bu 2
c4a6c40eb3 Documents the exclude argument in state execution module
.IP \(bu 2
15c445e6b9 Send Unix timestamps to database in pgjsonb
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
99fa05a456 Fix for bug in cron state
.IP \(bu 2
97328faeac Fix for bug in cron module
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44434\fP: (\fI\%whytewolf\fP) add a note that describes grain rebuilding on restart and refresh
@ \fI2017\-11\-14 11:21:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
91d46d4cfc Merge pull request \fI\%#44434\fP from whytewolf/1837
.IP \(bu 2
d148e39dda change from md to rst for code reference
.IP \(bu 2
955e305bda fix bad english, as requested by cachedout
.IP \(bu 2
7256fcc1c9 update note to take into account grains_cache
.IP \(bu 2
7a2981585e Merge branch \(aq2016.11\(aq into 1837
.IP \(bu 2
aca0405b26 add a note that describes grain rebuilding on restart and refresh
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#41474\fP: (\fI\%dmaziuk\fP) state.file.* line endings (refs: \fI\%#44321\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44321\fP: (\fI\%gvengel\fP) Fix file.line diff formatting.
@ \fI2017\-11\-13 19:36:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
a3bd99317f Merge pull request \fI\%#44321\fP from gvengel/fix\-file\-line\-diff\-output
.IP \(bu 2
69a50204a6 Add newline for lint.
.IP \(bu 2
ef7b6bbb81 Fixed issue with file.line on Windows running Python 2.
.IP \(bu 2
8f89c99fa5 Fix FileModuleTest setUp and tearDown to work on Windows.
.IP \(bu 2
3ac5391f5f Namespace missing functions for file.line on Windows.
.IP \(bu 2
b2b8f075b9 Fixed test to work on Windows.
.IP \(bu 2
5a5a2dd026 Added integration test for issue \fI\%#41474\fP
.IP \(bu 2
24d7315f1a Fix file.line diff formatting.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43417\fP: (\fI\%damon\-atkins\fP) win_pkg:  pkg.install and pkg.remove general issues (refs: \fI\%#43708\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43708\fP: (\fI\%damon\-atkins\fP) Merge Ready : Backport develop win_pkg to 2016.11 with additional bug fixes
@ \fI2017\-11\-13 19:33:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
9ca563718d Merge pull request \fI\%#43708\fP from damon\-atkins/2016.11_43417_Backport_and_Fixes
.IP \(bu 2
04d03ea6b8 Updated comment
.IP \(bu 2
1dd565e585 Merge remote branch \(aqupstream/2016.11\(aq into 2016.11_43417_Backport_and_Fixes
.IP \(bu 2
dd48ba2616 Merge remote branch \(aqupstream/2016.11\(aq into 2016.11_43417_Backport_and_Fixes
.IP \(bu 2
a0d08598bf dco fix
.IP \(bu 2
9467899fc6 Merge remote branch \(aqupstream/2016.11\(aq into 2016.11_43417_Backport_and_Fixes
.IP \(bu 2
6dc180fd0e doco fixes
.IP \(bu 2
2496a42ea4 lint fix
.IP \(bu 2
2c937fbe19 Merge remote branch \(aqupstream/2016.11\(aq into 2016.11_43417_Backport_and_Fixes
.IP \(bu 2
c9c8c48a4d all remove/install commands are passed to cmd.exe /s /c and commands are passed as strings to cmdmod
.IP \(bu 2
350244bd93 typo in comments and doc strings.
.IP \(bu 2
ec31f5a9bd 2017.11/develop version() was ignoring saltenv setting.
.IP \(bu 2
b314549a32 Backport of devlop to 2016.11 with additional bug fixes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44423\fP: (\fI\%mtkennerly\fP) The win_path.exists state cannot prepend to the very start of the PATH (refs: \fI\%#44424\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44477\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44424\fP to 2016.11
@ \fI2017\-11\-13 17:33:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44424\fP: (\fI\%mtkennerly\fP) Fix \fI\%#44423\fP: Handle index=None and index=0 distinctly in the win_path.exists state (refs: \fI\%#44477\fP)
.IP \(bu 2
68ea22188e Merge pull request \fI\%#44477\fP from rallytime/bp\-44424
.IP \(bu 2
4a9f8dcc96 Fix \fI\%#44423\fP: Handle index=None and index=0 distinctly
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44034\fP: (\fI\%seanjnkns\fP) salt\-call pillar overrides broken in 2016.11.8 and 2017.7.2 (refs: \fI\%#44483\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44483\fP: (\fI\%terminalmage\fP) salt\-call: account for instances where __pillar__ is empty
@ \fI2017\-11\-13 17:30:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
2c89050a24 Merge pull request \fI\%#44483\fP from terminalmage/issue44034
.IP \(bu 2
a9db8becea salt\-call: account for instances where __pillar__ is empty
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44489\fP: (\fI\%whytewolf\fP) update log\-granular\-levels to describe what they are filtering on
@ \fI2017\-11\-13 17:27:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
b5c2028680 Merge pull request \fI\%#44489\fP from whytewolf/1956_log\-granular\-levels
.IP \(bu 2
9cdeb4e903 update log\-granular\-levels to describe what they are filtering on
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44193\fP: (\fI\%twangboy\fP) Fix reg.py for use with LGPO module
@ \fI2017\-11\-10 19:01:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea07f9c54c Merge pull request \fI\%#44193\fP from twangboy/win_fix_reg
.IP \(bu 2
44d6d9f46d Remove unused import (lint)
.IP \(bu 2
f7502436bd Fix various issues
.IP \(bu 2
221e6e3b91 make salt.utils.to_unicode return none when passed none
.IP \(bu 2
ce41acc788 Fix many issues with reg.py
.IP \(bu 2
4a19df1f7f Use six.text_type instead of str
.IP \(bu 2
1b12acd303 Check type before casting
.IP \(bu 2
03fa37b445 Cast vdata to its proper type
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43863\fP: (\fI\%nicholasmhughes\fP) Atomicfile only copies mode and not user/group perms
@ \fI2017\-11\-10 18:47:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
ed8da2450b Merge pull request \fI\%#43863\fP from nicholasmhughes/fix\-atomicfile\-permission\-copy
.IP \(bu 2
ea852ec5d3 remove index use with stat module attributes
.IP \(bu 2
dbeeb0e917 fixes \fI\%#38452\fP atomicfile only copies mode and not user/group perms
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39901\fP: (\fI\%seanjnkns\fP) network.managed ipaddrs ignored (refs: \fI\%#44260\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44260\fP: (\fI\%seanjnkns\fP) Fixes \fI\%#39901\fP for RH/CentOS 7
@ \fI2017\-11\-07 23:14:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
a66cd67d15 Merge pull request \fI\%#44260\fP from seanjnkns/issue\-39901
.IP \(bu 2
ed8cccf457 \fI\%#39901\fP: Fix pylint
.IP \(bu 2
43c81dfdee \fI\%#39901\fP: Add unit tests
.IP \(bu 2
613d500876 Merge branch \(aq2016.11\(aq into issue\-39901
.IP \(bu 2
b97e8046ca Utilize salt.utils.validate.net.* and _raise_error_iface
.IP \(bu 2
6818f3631d Fixes \fI\%#39901\fP for RH/CentOS 7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44383\fP: (\fI\%gtmanfred\fP) switch salt\-jenkins over to saltstack for kitchen\-salt tests
@ \fI2017\-11\-03 19:56:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
5e289f42ba Merge pull request \fI\%#44383\fP from gtmanfred/2016kitchen
.IP \(bu 2
b65f4ea4ea switch salt\-jenkins over to saltstack
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44173\fP: (\fI\%twangboy\fP) Use google style docstrings in win_system.py
@ \fI2017\-10\-31 17:56:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
cab54e34b5 Merge pull request \fI\%#44173\fP from twangboy/win_system_docs
.IP \(bu 2
8e111b413d Fix some of the wording and grammar errors
.IP \(bu 2
a12bc5ae41 Use google style docstrings
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44304\fP: (\fI\%jfindlay\fP) states.cron identifier defaults to name
@ \fI2017\-10\-31 16:39:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
7aaea1d179 Merge pull request \fI\%#44304\fP from jfindlay/cron_id
.IP \(bu 2
cc038c5bec states.cron identifier defaults to name
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44313\fP: (\fI\%rossengeorgiev\fP) salt\-ssh: \-\-user option missing from the cli documentation (refs: \fI\%#44322\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44322\fP: (\fI\%rossengeorgiev\fP) updated CLI docs for salt\-ssh
@ \fI2017\-10\-30 21:39:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
e4dbbde734 Merge pull request \fI\%#44322\fP from rossengeorgiev/saltssh\-docs\-update
.IP \(bu 2
b18f2e5a6d fix program name and description for \-\-static
.IP \(bu 2
5b10918f02 updated CLI docs for salt\-ssh
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44345\fP: (\fI\%gtmanfred\fP) remove binding from erb template rendering
@ \fI2017\-10\-30 20:57:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
4e6f09e3eb Merge pull request \fI\%#44345\fP from gtmanfred/2016kitchen
.IP \(bu 2
79b8b2d0bf remove binding
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44342\fP: (\fI\%gtmanfred\fP) render template files platforms.yml and driver.yml
@ \fI2017\-10\-30 20:04:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
209847c8c2 Merge pull request \fI\%#44342\fP from gtmanfred/2016kitchen
.IP \(bu 2
c50508f0b7 render template files platforms.yml and driver.yml
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44336\fP: (\fI\%corywright\fP) Docs for archive.tar should not use leading dash for tar options (refs: \fI\%#44339\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44339\fP: (\fI\%corywright\fP) Remove leading dash from options in archive.tar docs (2016.11)
@ \fI2017\-10\-30 19:00:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
1be65224cb Merge pull request \fI\%#44339\fP from corywright/issue\-44336\-fix\-archive\-tar\-docs\-2016\-11
.IP \(bu 2
9c1c35a59f Remove leading dash (\-) from options in archive.tar documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44272\fP: (\fI\%gurubert\fP) [patch] win_service.stop() fails (refs: \fI\%#44295\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44295\fP: (\fI\%gurubert\fP) fixes issue \fI\%#44272\fP
@ \fI2017\-10\-27 14:28:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
bebc33daf5 Merge pull request \fI\%#44295\fP from HeinleinSupport/issue44272
.IP \(bu 2
f972715a45 fixes issue \fI\%#44272\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44286\fP: (\fI\%gtmanfred\fP) use our git repo for kitchen\-salt
@ \fI2017\-10\-25 19:27:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
e7ca9f8407 Merge pull request \fI\%#44286\fP from gtmanfred/2016.11
.IP \(bu 2
193e715e37 use our git repo for kitchen\-salt
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44259\fP: (\fI\%gtmanfred\fP) begin switching in kitchen\-salt for running the test suite
@ \fI2017\-10\-25 13:30:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
8a1ea165af Merge pull request \fI\%#44259\fP from gtmanfred/2016.11
.IP \(bu 2
56a3ad8f68 fix pylint comments
.IP \(bu 2
4add666db1 add comment to Gemfile and move copyartifacts
.IP \(bu 2
b4c8f7eb57 fix pylint
.IP \(bu 2
392fd4f837 try newest salttesting
.IP \(bu 2
79251287d0 add logging
.IP \(bu 2
38963d5a82 use transport if not set in state_file
.IP \(bu 2
10e309a64f which vagrant should go to stderr
.IP \(bu 2
9307564de0 fix output columns
.IP \(bu 2
2da22f87e1 test opennebula
.IP \(bu 2
9f38f16905 add opennebula to Gemfile
.IP \(bu 2
7465f9b27a add script for copying back artifacts
.IP \(bu 2
255118cfd7 run tests with kitchen
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44268\fP: (\fI\%twangboy\fP) Fix typo
@ \fI2017\-10\-25 13:01:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d6bc8509b Merge pull request \fI\%#44268\fP from twangboy/win_fix_lgpo_typo
.IP \(bu 2
a6a4c10a77 Fix typo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44269\fP: (\fI\%terminalmage\fP) Fix log message in salt.utils.gitfs
@ \fI2017\-10\-25 13:00:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
0beb65a283 Merge pull request \fI\%#44269\fP from terminalmage/fix\-log\-message
.IP \(bu 2
bc9cd65496 Fix log message in salt.utils.gitfs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44155\fP: (\fI\%rhoths\fP) file.directory with clean not triggering listener in test mode (refs: \fI\%#44160\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44160\fP: (\fI\%gtmanfred\fP) add changes to test return
@ \fI2017\-10\-23 14:35:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
304dd2529d Merge pull request \fI\%#44160\fP from gtmanfred/directory
.IP \(bu 2
a7d3d668f4 missed removing changes in the next test
.IP \(bu 2
ac0b5ec440 fix test
.IP \(bu 2
d3d00c3e62 add changes to test return
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44205\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44177\fP to 2016.11
@ \fI2017\-10\-23 14:09:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44177\fP: (\fI\%senthilkumar\-e\fP) Fixing default redis.host in documentation (refs: \fI\%#44205\fP)
.IP \(bu 2
e10395483d Merge pull request \fI\%#44205\fP from rallytime/bp\-44177
.IP \(bu 2
b9940f8521 Fixing default redis.host in documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44140\fP: (\fI\%vtolstov\fP) incorrect network interfaces settings with network.managed under debian jessie (refs: \fI\%#44167\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44167\fP: (\fI\%garethgreenaway\fP) Fixes to modules/debian_ip
@ \fI2017\-10\-20 14:25:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
09ddfd0c08 Merge pull request \fI\%#44167\fP from garethgreenaway/44140_debian_ip_fixes
.IP \(bu 2
5f7555846f When looping through the various pre, post, up and down commands put them into the interface dict using the right internet family variable.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43830\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43644\fP to 2016.11
@ \fI2017\-10\-19 22:57:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43644\fP: (\fI\%defanator\fP) Several fixes for RDS DB parameter group management (refs: \fI\%#43830\fP)
.IP \(bu 2
9f9e936b52 Merge pull request \fI\%#43830\fP from rallytime/bp\-43644
.IP \(bu 2
12845ae802 Several fixes for RDS DB parameter group management
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43936\fP: (\fI\%oeuftete\fP) manage.present still reports \fIlost\fP minion (refs: \fI\%#43994\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38367\fP: (\fI\%tyeapple\fP) logic error in connected_ids  function of salt/utils/minions.py when using include_localhost=True (refs: \fI\%#43994\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43994\fP: (\fI\%oeuftete\fP) Fix manage.present to show lost minions
@ \fI2017\-10\-19 22:27:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
07db6a3d8b Merge pull request \fI\%#43994\fP from oeuftete/fix\-manage\-runner\-presence
.IP \(bu 2
f3980d7d83 Fix manage.present to show lost minions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44150\fP: (\fI\%rossengeorgiev\fP) version param in pkg.installed broken in 2016.11.8/2017.7.2 in EL6\-7 (refs: \fI\%#44188\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44188\fP: (\fI\%terminalmage\fP) yumpkg: Check pkgname instead of name to see if it is a kernel pkg
@ \fI2017\-10\-19 22:20:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
a07537e258 Merge pull request \fI\%#44188\fP from terminalmage/issue44150
.IP \(bu 2
0692f442db yumpkg: Check pkgname instead of name to see if it is a kernel pkg
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43427\fP: (\fI\%tylerjones4508\fP) Salt\-Cloud  There was a profile error: invalid literal for int() with base 10: (refs: \fI\%#44089\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44158\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44089\fP to 2016.11
@ \fI2017\-10\-19 20:38:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44089\fP: (\fI\%cetanu\fP) Catch on empty Virtualbox network addr \fI\%#43427\fP (refs: \fI\%#44158\fP)
.IP \(bu 2
715edc0cea Merge pull request \fI\%#44158\fP from rallytime/bp\-44089
.IP \(bu 2
534faf0b7a Catch on empty Virtualbox network addr \fI\%#43427\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43307\fP: (\fI\%marek\-knappe\fP) Filesystem creation is failing on newly created LV (refs: \fI\%#44029\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44131\fP: (\fI\%rallytime\fP) Back\-port \fI\%#44029\fP to 2016.11
@ \fI2017\-10\-17 15:05:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#44029\fP: (\fI\%msummers42\fP) addresses issue \fI\%#43307\fP, disk.format_ to disk.format (refs: \fI\%#44131\fP)
.IP \(bu 2
0cd493b691 Merge pull request \fI\%#44131\fP from rallytime/bp\-44029
.IP \(bu 2
bebf301976 fixed test addressing issue \fI\%#43307\fP, disk.format_ to disk.format
.IP \(bu 2
b4ba7ae2fc addresses issue \fI\%#43307\fP, disk.format_ to disk.format
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#44087\fP: (\fI\%mfussenegger\fP) Using state.highstate with \fIterse=true\fP prevents useful error output  (refs: \fI\%#44093\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44093\fP: (\fI\%gtmanfred\fP) don\(aqt filter if return is not a dict
@ \fI2017\-10\-16 19:13:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a68e356f8 Merge pull request \fI\%#44093\fP from gtmanfred/fix\-44087
.IP \(bu 2
5455c5053b fix pylint
.IP \(bu 2
f749cafa25 don\(aqt filter if return is not a dict
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44122\fP: (\fI\%cachedout\fP) Add note about GPG signing to PR template
@ \fI2017\-10\-16 19:09:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
c785d7a847 Merge pull request \fI\%#44122\fP from cachedout/gpg_pr_template
.IP \(bu 2
e41e3d76be Typo fix
.IP \(bu 2
37c7980880 Add note about GPG signing to PR template
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44124\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.11.8 to 2016.11
@ \fI2017\-10\-16 19:07:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf90ea1f51 Merge pull request \fI\%#44124\fP from rallytime/merge\-2016.11
.IP \(bu 2
59861291c8 Merge branch \(aq2016.11.8\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
57623e2abe Merge pull request \fI\%#44028\fP from rallytime/bp\-44011
.INDENT 2.0
.IP \(bu 2
89e084bda3 Do not allow IDs with null bytes in decoded payloads
.IP \(bu 2
206ae23f15 Don\(aqt allow path separators in minion ID
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44097\fP: (\fI\%gtmanfred\fP) OpenNebula does not require the template_id to be specified
@ \fI2017\-10\-16 18:36:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
13f3ffa83a Merge pull request \fI\%#44097\fP from gtmanfred/openneb
.IP \(bu 2
c29655b2c2 Merge branch \(aq2016.11\(aq into openneb
.IP \(bu 2
bd2490b149 OpenNebula does not require the template_id to be specified
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44110\fP: (\fI\%roaldnefs\fP) Format fix code example local returner doc
@ \fI2017\-10\-16 15:57:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
ac3e4df964 Merge pull request \fI\%#44110\fP from roaldnefs/fix\-doc\-local\-returner
.IP \(bu 2
efd58f7594 Merge branch \(aq2016.11\(aq into fix\-doc\-local\-returner
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44092\fP: (\fI\%techhat\fP) Made sure that unicoded data is sent to sha256()
@ \fI2017\-10\-13 21:20:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
c960ca32c2 Merge pull request \fI\%#44092\fP from techhat/awsunicode
.IP \(bu 2
bbd9db4d00 One more encoding
.IP \(bu 2
0e8b325667 Apparently __salt_system_encoding__ is a thing
.IP \(bu 2
1e7211838d Use system encoding
.IP \(bu 2
1af21bbe5e Made sure that unicoded data is sent to sha256()
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43581\fP: (\fI\%jcourington\fP) cherrypy stats issue (refs: \fI\%#44021\fP)
.IP \(bu 2
\fBPR\fP \fI\%#44021\fP: (\fI\%whiteinge\fP) Also catch cpstats AttributeError for bad CherryPy release ~5.6.0
@ \fI2017\-10\-12 18:11:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#42655\fP: (\fI\%whiteinge\fP) Reenable cpstats for rest_cherrypy (refs: \fI\%#44021\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33806\fP: (\fI\%cachedout\fP) Work around upstream cherrypy bug (refs: \fI\%#42655\fP)
.IP \(bu 2
d89c317d96 Merge pull request \fI\%#44021\fP from whiteinge/cpstats\-attribute\-error
.IP \(bu 2
bf14e5f578 Also catch cpstats AttributeError for bad CherryPy release ~5.6.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44025\fP: (\fI\%dayid\fP) Typo correction of lover to lower
@ \fI2017\-10\-11 17:31:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
bbdabe242a Merge pull request \fI\%#44025\fP from dayid/lover_typo
.IP \(bu 2
385980c21a Merge branch \(aq2016.11\(aq of \fI\%https://github.com/saltstack/salt\fP into lover_typo
.IP \(bu 2
266dc00a23 Typo correction of lover to lower
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44030\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11
@ \fI2017\-10\-11 13:01:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
d8f3891a5e Merge pull request \fI\%#44030\fP from rallytime/merge\-2016.11
.IP \(bu 2
53eaf0d75c Merge branch \(aq2016.3\(aq into \(aq2016.11\(aq
.IP \(bu 2
64fd839377 Merge pull request \fI\%#44010\fP from Ch3LL/2016.3.7_follow_up
.INDENT 2.0
.IP \(bu 2
9a00302cd8 fix 2016.3.7 release notes merge conflict
.IP \(bu 2
63da1214db Do not allow IDs with null bytes in decoded payloads
.IP \(bu 2
ee792581fc Don\(aqt allow path separators in minion ID
.IP \(bu 2
8aab65c718 fix 2016.3.7 release notes merge conflict
.UNINDENT
.IP \(bu 2
bd73dcb02c Merge pull request \fI\%#43977\fP from Ch3LL/3.8_sec
.IP \(bu 2
5fb3f5f6b1 Add Security Notes to 2016.3.8 Release Notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44011\fP: (\fI\%Ch3LL\fP) Security Fixes for 2016.11.8 (refs: \fI\%#44028\fP)
@ \fI2017\-10\-10 20:04:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
0dbf41e79e Merge pull request \fI\%#44011\fP from Ch3LL/2016.11.7_follow_up
.IP \(bu 2
c0149101c0 Do not allow IDs with null bytes in decoded payloads
.IP \(bu 2
19481423dd Don\(aqt allow path separators in minion ID
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44023\fP: (\fI\%Ch3LL\fP) Add 2016.11.9 Release Note File
@ \fI2017\-10\-10 20:03:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
d61300df20 Merge pull request \fI\%#44023\fP from Ch3LL/11.9rn
.IP \(bu 2
7f9015eb41 Add 2016.11.9 Release Note File
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#44019\fP: (\fI\%benediktwerner\fP) Added missing docs to the tutorial index and fixed  spelling mistake
@ \fI2017\-10\-10 19:57:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
9ff53bf63a Merge pull request \fI\%#44019\fP from benediktwerner/2016.11
.IP \(bu 2
bc53598027 Fixed spelling mistake in salt_bootstrap tutorial
.IP \(bu 2
6c30344824 Added missing tutorial docs to the tutorial index
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43955\fP: (\fI\%meaksh\fP) Enable a new \(aq\-\-with\-salt\-version\(aq parameter for the \(dqsetup.py\(dq script
@ \fI2017\-10\-10 17:36:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
364523f5f8 Merge pull request \fI\%#43955\fP from meaksh/2016.11\-fix\-2291
.IP \(bu 2
a81b78381b Merge branch \(aq2016.11\(aq into 2016.11\-fix\-2291
.IP \(bu 2
44bc91bb98 Enable \(aq\-\-with\-salt\-version\(aq parameter for setup.py script
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43945\fP: (\fI\%bobrik\fP) kmod.present doesn\(aqt work with compiled\-in modules (refs: \fI\%#43962\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43962\fP: (\fI\%bobrik\fP) Report built\-in modiles in kmod.available, fixes \fI\%#43945\fP
@ \fI2017\-10\-10 16:31:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
fec714b91d Merge pull request \fI\%#43962\fP from bobrik/kmod\-built\-in
.IP \(bu 2
95ab901553 Report built\-in modiles in kmod.available, fixes \fI\%#43945\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43960\fP: (\fI\%cro\fP) Require that bindpw be non\-empty when auth.ldap.anonymous is False
@ \fI2017\-10\-09 23:09:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
e434c39c4e Merge pull request \fI\%#43960\fP from cro/ldap_nopw_bind2
.IP \(bu 2
962a20cf4b Require that bindpw be non\-empty if auth.ldap.anonymous=False
.IP \(bu 2
9df3d91d8f Release notes blurb for change to bindpw requirements
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43991\fP: (\fI\%Ch3LL\fP) Add Security Notes to 2016.3.8 Release Notes
@ \fI2017\-10\-09 22:00:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
e9dfda2177 Merge pull request \fI\%#43991\fP from Ch3LL/3.8_sec_2
.IP \(bu 2
1977df8462 Add Security Notes to 2016.3.8 Release Notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42947\fP: (\fI\%rossengeorgiev\fP) Zenoss state changes production state even when test=true (refs: \fI\%#43968\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43968\fP: (\fI\%rossengeorgiev\fP) fix zenoss state module not respecting test=true
@ \fI2017\-10\-09 21:27:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
2346d2691e Merge pull request \fI\%#43968\fP from rossengeorgiev/fix\-zenoss\-prod_state
.IP \(bu 2
e6d31c1ea6 fix zenoss state module not respecting test=true
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43776\fP: (\fI\%Ch3LL\fP) [2016.11] Bump latest and previous versions
@ \fI2017\-10\-09 17:22:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
8d56a5ac45 Merge pull request \fI\%#43776\fP from Ch3LL/2016.11.8_docs
.IP \(bu 2
f72bc00000 [2016.11] Bump latest and previous versions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43976\fP: (\fI\%Ch3LL\fP) Add Security Notes to 2016.11.8 Release Notes
@ \fI2017\-10\-09 17:20:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
21bf71c3f5 Merge pull request \fI\%#43976\fP from Ch3LL/11.8_sec
.IP \(bu 2
f0c3184288 Add Security Notes to 2016.11.8 Release Notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43973\fP: (\fI\%terminalmage\fP) Fix grains.has_value when value is False
@ \fI2017\-10\-09 14:59:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
1d5397ab5b Merge pull request \fI\%#43973\fP from terminalmage/fix\-grains.has_value
.IP \(bu 2
bf45ae6e6a Fix grains.has_value when value is False
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43888\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43841\fP to 2016.11
@ \fI2017\-10\-05 20:09:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43841\fP: (\fI\%austinpapp\fP) add \-n with netstat so we don\(aqt resolve IPs (refs: \fI\%#43888\fP)
.IP \(bu 2
9ac3f2ea7b Merge pull request \fI\%#43888\fP from rallytime/bp\-43841
.IP \(bu 2
87d676f08a add \-n with netstat so we don\(aqt resolve
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43916\fP: (\fI\%dereckson\fP) Fix typo in salt\-cloud scaleway documentation
@ \fI2017\-10\-05 18:58:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
f880ac4c08 Merge pull request \fI\%#43916\fP from dereckson/fix\-typo\-cloud\-scaleway
.IP \(bu 2
15b8b8a9f4 Fix typo in salt\-cloud scaleway documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43884\fP: (\fI\%UtahDave\fP) Update SaltConf banner per Rhett\(aqs request
@ \fI2017\-10\-04 13:08:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
2ab7549d48 Merge pull request \fI\%#43884\fP from UtahDave/2016.11local
.IP \(bu 2
e3b2857285 Merge branch \(aq2016.11\(aq into 2016.11local
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43869\fP: (\fI\%terminalmage\fP) Only join cmd if it\(aqs not a string
@ \fI2017\-10\-03 16:25:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
4b882d4272 Merge pull request \fI\%#43869\fP from terminalmage/issue43522
.IP \(bu 2
fe28b0d4fb Only join cmd if it\(aqs not a string
.IP \(bu 2
8c671fd0c1 Update SaltConf banner per Rhett\(aqs request
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43373\fP: (\fI\%rgcosma\fP) use keyword breaks sls_id (refs: \fI\%#43707\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43707\fP: (\fI\%terminalmage\fP) Add missing support for use/use_in requisites to state.sls_id
@ \fI2017\-10\-01 14:07:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
a2161efda3 Merge pull request \fI\%#43707\fP from terminalmage/issue43373
.IP \(bu 2
3ebde1895f Merge branch \(aq2016.11\(aq into issue43373
.IP \(bu 2
e580ed4caa Merge branch \(aq2016.11\(aq into issue43373
.IP \(bu 2
5b3be6e8af Fix failing unit test
.IP \(bu 2
f73764481b Add missing support for use/use_in requisites to state.sls_id
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43807\fP: (\fI\%terminalmage\fP) cmdmod: Don\(aqt list\-ify string commands on Windows
@ \fI2017\-09\-29 02:48:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
85b3aa332a Merge pull request \fI\%#43807\fP from terminalmage/issue43522
.IP \(bu 2
d8708bf698 cmdmod: Don\(aqt list\-ify string commands on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43768\fP: (\fI\%vutny\fP) Fix Pylint deprecated option warnings
@ \fI2017\-09\-28 12:27:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea8d273c2b Merge pull request \fI\%#43768\fP from vutny/fix\-pylint\-deprecation\-warnings
.IP \(bu 2
f8b3fa9da1 Merge branch \(aq2016.11\(aq into fix\-pylint\-deprecation\-warnings
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40311\fP: (\fI\%cralston0\fP) \-\-hide\-timeout used with \-\-output json \-\-static produces unparseable JSON (refs: \fI\%#43772\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43772\fP: (\fI\%gtmanfred\fP) don\(aqt print Minion not responding with quiet
@ \fI2017\-09\-27 15:39:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a8cc60bb4 Merge pull request \fI\%#43772\fP from gtmanfred/2016.11
.IP \(bu 2
0194c60960 don\(aqt print Minion not responding with quiet
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43747\fP: (\fI\%rallytime\fP) Add GPG Verification section to Contributing Docs
@ \fI2017\-09\-26 21:25:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
9dee896fb9 Merge pull request \fI\%#43747\fP from rallytime/gpg\-verification
.IP \(bu 2
7a70de19f4 Merge branch \(aq2016.11\(aq into gpg\-verification
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43729\fP: (\fI\%The\-Loeki\fP) Docker events engine broken on newer docker.py  (refs: \fI\%#43733\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43733\fP: (\fI\%terminalmage\fP) Allow docker_events engine to work with newer docker\-py
@ \fI2017\-09\-26 16:47:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
1cc3ad1c8d Merge pull request \fI\%#43733\fP from terminalmage/issue43729
.IP \(bu 2
6e5c99bda0 Allow docker_events engine to work with newer docker\-py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42082\fP: (\fI\%stamak\fP) [salt.utils.gitfs ][CRITICAL] Invalid gitfs configuration parameter \(aqsaltenv\(aq in remote git+ssh://git@ourgitserver/ourgitrepo.git. (refs: \fI\%#43458\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43458\fP: (\fI\%terminalmage\fP) Fix missing PER_REMOTE_ONLY in cache.clear_git_lock runner
@ \fI2017\-09\-26 14:39:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
5d38be4ff7 Merge pull request \fI\%#43458\fP from terminalmage/issue42082
.IP \(bu 2
5f90812b12 Fix missing PER_REMOTE_ONLY in cache.clear_git_lock runner
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
23bb4a5dde Add GPG Verification section to Contributing Docs
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43650\fP: (\fI\%rallytime\fP) Review contributing documentation and the merge\-forward process (refs: \fI\%#43727\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#42706\fP: (\fI\%blarghmatey\fP) Parallel Cache Failure (refs: \fI\%#43018\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43727\fP: (\fI\%rallytime\fP) Revise \(dqContributing\(dq docs: merge\-forwards/release branches explained!
@ \fI2017\-09\-26 12:43:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43018\fP: (\fI\%jubrad\fP) Update state.py (refs: \fI\%#43727\fP)
.IP \(bu 2
023a563657 Merge pull request \fI\%#43727\fP from rallytime/fix\-43650
.IP \(bu 2
babad12d83 Revise \(dqContributing\(dq docs: merge\-forwards/release branches explained!
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43648\fP: (\fI\%rallytime\fP) Handle VPC/Subnet ID not found errors in boto_vpc module
@ \fI2017\-09\-22 17:40:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
f46c858f25 Merge pull request \fI\%#43648\fP from rallytime/handle\-boto\-vpc\-errors
.IP \(bu 2
54842b5012 Handle VPC/Subnet ID not found errors in boto_vpc module
.INDENT 2.0
.IP \(bu 2
651ed16ad3 Fix Pylint deprecated option warnings
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43575\fP: (\fI\%akissa\fP) Fix CSR not recreated if key changes
@ \fI2017\-09\-21 17:52:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
9dba34aa06 Merge pull request \fI\%#43575\fP from akissa/fix\-csr\-not\-recreated\-if\-key\-changes
.IP \(bu 2
b1b4dafd39 Fix CSR not recreated if key changes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#42165\fP: (\fI\%arount\fP) top_file_merging_strategy: merge does not works (refs: \fI\%#43415\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43672\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43415\fP to 2016.11
@ \fI2017\-09\-21 16:38:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43415\fP: (\fI\%mattLLVW\fP) Fix env_order in state.py (refs: \fI\%#43672\fP)
.IP \(bu 2
1d4fa48209 Merge pull request \fI\%#43672\fP from rallytime/bp\-43415
.IP \(bu 2
3fb42bc238 Fix env_order in state.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43673\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43652\fP to 2016.11
@ \fI2017\-09\-21 16:37:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43652\fP: (\fI\%VertigoRay\fP) Salt Repo has Deb 9 and 8 (refs: \fI\%#43673\fP)
.IP \(bu 2
ff832ee607 Merge pull request \fI\%#43673\fP from rallytime/bp\-43652
.IP \(bu 2
d91c47c6f0 Salt Repo has Deb 9 and 8
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43677\fP: (\fI\%terminalmage\fP) Fix RST headers for runners (2016.11 branch)
@ \fI2017\-09\-21 16:35:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
365cb9fba8 Merge pull request \fI\%#43677\fP from terminalmage/runners\-docs\-2016.11
.IP \(bu 2
2fd88e94fa Fix RST headers for runners (2016.11 branch)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43534\fP: (\fI\%twangboy\fP) Fixes removal of double\-quotes by shlex_split in winrepo for 2016.11
@ \fI2017\-09\-21 14:39:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
be38239e5d Merge pull request \fI\%#43534\fP from twangboy/win_fix_pkg.install_2016.11
.IP \(bu 2
1546c1ca04 Add posix=False to call to salt.utils.shlex_split
.IP \(bu 2
\fBPR\fP \fI\%#43663\fP: (\fI\%moio\fP) multiprocessing minion option: documentation fixes (develop) (refs: \fI\%#43661\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43661\fP: (\fI\%moio\fP) multiprocessing minion option: documentation fixes (2016.11)
@ \fI2017\-09\-21 13:02:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d3fd3d374 Merge pull request \fI\%#43661\fP from moio/2016.11\-multiprocessing\-doc\-fix
.IP \(bu 2
625eabb83f multiprocessing minion option: documentation fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43646\fP: (\fI\%brejoc\fP) Added tests for pid\-file deletion in DaemonMixIn
@ \fI2017\-09\-20 19:21:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b4516c025 Merge pull request \fI\%#43646\fP from brejoc/2016.11.4\-pidfile\-tests
.IP \(bu 2
96f39a420b Fixed linting
.IP \(bu 2
08fba98735 Fixed several issues with the test
.IP \(bu 2
3a089e450f Added tests for pid\-file deletion in DaemonMixIn
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43591\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.11.8 to 2016.11
@ \fI2017\-09\-19 16:18:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
cfb1625741 Merge pull request \fI\%#43591\fP from rallytime/merge\-2016.11
.IP \(bu 2
57b9d642c2 Merge branch \(aq2016.11.8\(aq into \(aq2016.11\(aq
.INDENT 2.0
.IP \(bu 2
e83421694f Merge pull request \fI\%#43550\fP from twangboy/osx_fix_preinstall_2016.11.8
.IP \(bu 2
1b0a4d39d2 Fix logic in \fI/etc/paths.d/salt\fP detection
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43572\fP: (\fI\%vutny\fP) cloud.action: list_nodes_min returns all EC2 instances
@ \fI2017\-09\-18 20:36:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
8671b91f62 Merge pull request \fI\%#43572\fP from vutny/fix\-salt\-cloud\-list\-min\-instance\-set
.IP \(bu 2
21966e7ce8 cloud.action: list_nodes_min returns all instances
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43461\fP: (\fI\%twangboy\fP) Add \fI/norestart\fP switch to vcredist install
@ \fI2017\-09\-12 20:33:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
f2b86fa2db Merge pull request \fI\%#43461\fP from twangboy/win_norestart
.IP \(bu 2
2d269d1a76 Change all comment markers to \(aq#\(aq
.IP \(bu 2
d80aea16cb Handle ErrorCodes returned by VCRedist installer
.IP \(bu 2
fb31e9a530 Add /norestart switch to vcredist install
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43267\fP: (\fI\%brejoc\fP) OSError \- Can\(aqt delete PIDfile when not root (refs: \fI\%#43366\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43366\fP: (\fI\%brejoc\fP) Catching error when PIDfile cannot be deleted
@ \fI2017\-09\-12 15:31:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
90e8ca9c36 Merge pull request \fI\%#43366\fP from brejoc/2016.11.pidfile\-fix
.IP \(bu 2
6e3eb76c79 Removed unused format argument
.IP \(bu 2
daf4948b3d Catching error when PIDfile cannot be deleted
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43386\fP: (\fI\%rajvidhimar\fP) Scheduler\(aqs job_kwargs not working as expected. (refs: \fI\%#43442\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43442\fP: (\fI\%garethgreenaway\fP)  [2016.11] Fixes to scheduler __pub values in kwargs
@ \fI2017\-09\-12 15:16:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
a6c458607a Merge pull request \fI\%#43442\fP from garethgreenaway/43386_2016_11_schedule_kwargs_pub
.IP \(bu 2
e637ecbe86 Merge branch \(aq2016.11\(aq into 43386_2016_11_schedule_kwargs_pub
.IP \(bu 2
6114df8dc3 Adding a small check to ensure we do not continue to populate kwargs with __pub_ items from the kwargs item.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43223\fP: (\fI\%rallytime\fP) Properly deprecate describe_route_table function in boto_vpc module (refs: \fI\%#43445\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43456\fP: (\fI\%rallytime\fP) Add Neon to version list
@ \fI2017\-09\-12 15:00:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43445\fP: (\fI\%rallytime\fP) Bump deprecation warning for boto_vpc.describe_route_table (refs: \fI\%#43456\fP)
.IP \(bu 2
3c429299f9 Merge pull request \fI\%#43456\fP from rallytime/43445_follow_up
.IP \(bu 2
35c1d8898d Add Neon to version list
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43441\fP: (\fI\%meaksh\fP) Use $HOME to get the user home directory instead using \(aq~\(aq char
@ \fI2017\-09\-11 21:25:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
6db7a721c0 Merge pull request \fI\%#43441\fP from meaksh/2016.11\-salt\-bash\-completion\-fix
.IP \(bu 2
be4f26ab21 Use $HOME to get the user home directory instead using \(aq~\(aq char
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43223\fP: (\fI\%rallytime\fP) Properly deprecate describe_route_table function in boto_vpc module (refs: \fI\%#43445\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43445\fP: (\fI\%rallytime\fP) Bump deprecation warning for boto_vpc.describe_route_table (refs: \fI\%#43456\fP)
@ \fI2017\-09\-11 21:23:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
05fff44a50 Merge pull request \fI\%#43445\fP from rallytime/bump\-deprecation\-warning
.IP \(bu 2
c91cd1c6d9 Bump deprecation warning for boto_vpc.describe_route_table
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43432\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43419\fP to 2016.11
@ \fI2017\-09\-11 17:36:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43419\fP: (\fI\%gtmanfred\fP) make cache dirs when spm starts (refs: \fI\%#43432\fP)
.IP \(bu 2
c57dc5f0e3 Merge pull request \fI\%#43432\fP from rallytime/bp\-43419
.IP \(bu 2
c471a29527 make cache dirs when spm starts
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43387\fP: (\fI\%aogier\fP) genesis.bootstrap debootstrap fails if no qemu specified (refs: \fI\%#43390\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43390\fP: (\fI\%aogier\fP) better qemu_static parameter mangle in deboostrap management, tests
@ \fI2017\-09\-11 13:18:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
57cccd75d0 Merge pull request \fI\%#43390\fP from aogier/43387\-genesis\-qemu
.IP \(bu 2
496f14a7e7 forgot to mock the proper one
.IP \(bu 2
51c7a1ba00 only check if static_qemu is_executable()
.IP \(bu 2
70642e495d better qemu_static parameter mangle in deboostrap management, tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43338\fP: (\fI\%LEMNX\fP) virtualenv never\-download (refs: \fI\%#43356\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43356\fP: (\fI\%gtmanfred\fP) never\-download got readded
@ \fI2017\-09\-07 17:46:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
6106aec696 Merge pull request \fI\%#43356\fP from gtmanfred/2016.11
.IP \(bu 2
3f19b247f3 Add handler.messages back in for test comparison
.IP \(bu 2
9911b04208 fix test
.IP \(bu 2
3c6ae99a77 never\-download got readded
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43325\fP: (\fI\%doesitblend\fP) mine_interval option is minutes not seconds
@ \fI2017\-09\-07 16:58:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
e638fac54e Merge pull request \fI\%#43325\fP from doesitblend/salt\-mine\-doc\-fix
.IP \(bu 2
1e94d0ac3a Lint: Remove trailing whitespace
.IP \(bu 2
51af8f8757 Fix mine_interval phrasing in default file
.IP \(bu 2
ba0cdd4536 Fix phrasing for mine_interval description
.IP \(bu 2
9ff03c2d43 Update Salt Mine documentation to show that the mine_interval option is configured in minutes.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43086\fP: (\fI\%aogier\fP) pylint: Instance of \(aqtuple\(aq has no \(aqextend\(aq member (no\-member) (refs: \fI\%#43105\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43105\fP: (\fI\%aogier\fP) groupadd module: string does not have attribute \(aqextend\(aq, plus homogeneous \fIcmd\fP parm building
@ \fI2017\-09\-06 15:49:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc587f784a Merge pull request \fI\%#43105\fP from aogier/43086\-no\-member
.IP \(bu 2
5111cf8bad Merge branch \(aq2016.11\(aq into 43086\-no\-member
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43333\fP: (\fI\%damon\-atkins\fP) Docs are wrong cache_dir (bool) and cache_file (str) cannot be passed as params + 1 bug
@ \fI2017\-09\-06 14:21:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
d97a680372 Merge pull request \fI\%#43333\fP from damon\-atkins/2016.11
.IP \(bu 2
92de2bb498 Update doco
.IP \(bu 2
fc9c61d12e Update win_pkg.py
.IP \(bu 2
c91fc14704 Merge branch \(aq2016.11\(aq into 2016.11
.IP \(bu 2
cb3af2bbbd Docs are wrong cache_dir (bool) and cache_file (str) cannot be passed on the cli (\fI\%#2\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43295\fP: (\fI\%V3XATI0N\fP) salt.cache.redis_cache does not actually work. (refs: \fI\%#43329\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43361\fP: (\fI\%rallytime\fP) Back\-port \fI\%#43329\fP to 2016.11
@ \fI2017\-09\-05 23:23:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43329\fP: (\fI\%johnj\fP) Fix \fI\%#43295\fP, better handling of consul initialization (refs: \fI\%#43361\fP)
.IP \(bu 2
0c986f5eba Merge pull request \fI\%#43361\fP from rallytime/bp\-43329
.IP \(bu 2
b09e5b4379 Fix \fI\%#43295\fP, better handling of consul initialization issues
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35840\fP: (\fI\%junovitch\fP) preserve_minion_cache is broken in 2016.3+ (refs: \fI\%#42903\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42903\fP: (\fI\%junovitch\fP) Fix \(aqpreserve_minion_cache: True\(aq functionality (fixes \fI\%#35840\fP)
@ \fI2017\-09\-05 22:57:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
22287439e6 Merge pull request \fI\%#42903\fP from junovitch/issue\-35840\-fix\-preserve\-minion\-cache\-2016.11
.IP \(bu 2
c9d4fdbd45 Merge branch \(aq2016.11\(aq into issue\-35840\-fix\-preserve\-minion\-cache\-2016.11
.IP \(bu 2
93a68e32a5 Merge branch \(aq2016.11\(aq into issue\-35840\-fix\-preserve\-minion\-cache\-2016.11
.IP \(bu 2
079f097985 Fix \(aqpreserve_minion_cache: True\(aq functionality (fixes \fI\%#35840\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43360\fP: (\fI\%terminalmage\fP) Fix failing tests in Fedora
@ \fI2017\-09\-05 22:23:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
4860e10757 Merge pull request \fI\%#43360\fP from terminalmage/sj\-496
.IP \(bu 2
433bca14b1 Fix KeyError in yumpkg configparser code on Python 3
.IP \(bu 2
f6c16935d8 Move \-\-showduplicates before repository\-packages
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43244\fP: (\fI\%rallytime\fP) Update release branch section with a few more details
@ \fI2017\-09\-05 20:27:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ba2dbe41e Merge pull request \fI\%#43244\fP from rallytime/release\-branch\-clarifications
.IP \(bu 2
0d5a46dbaa Update release branch section with a few more details
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#43348\fP: (\fI\%9maf4you\fP) network.managed doesn\(aqt work on CentOS 7 (refs: \fI\%#43359\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43359\fP: (\fI\%gtmanfred\fP) ipaddr_start ipaddr_end for el7
@ \fI2017\-09\-05 19:44:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a012eb3d7 Merge pull request \fI\%#43359\fP from gtmanfred/ipaddr
.IP \(bu 2
23d9abb560 ipaddr_start ipaddr_end for el7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43247\fP: (\fI\%rallytime\fP) Back\-port various mention bot settings to 2016.11
@ \fI2017\-09\-05 18:17:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#43206\fP: (\fI\%rallytime\fP) Always notify tkwilliams when changes occur on boto files (refs: \fI\%#43247\fP)
.IP \(bu 2
\fBPR\fP \fI\%#43183\fP: (\fI\%basepi\fP) Add basepi to userBlacklist for mention bot (refs: \fI\%#43247\fP)
.IP \(bu 2
\fBPR\fP \fI\%#42923\fP: (\fI\%rallytime\fP) Always notify ryan\-lane when changes occur on boto files (refs: \fI\%#43247\fP)
.IP \(bu 2
8f88111be8 Merge pull request \fI\%#43247\fP from rallytime/mentionbot\-backports
.IP \(bu 2
2b85757d73 Always notify tkwilliams when changes occur on boto files
.IP \(bu 2
40b5a29f90 Add basepi to userBlacklist for mention bot
.IP \(bu 2
bad8f56969 Always notify ryan\-lane when changes occur on boto files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43277\fP: (\fI\%rallytime\fP) Add CODEOWNERS file
@ \fI2017\-09\-01 16:56:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
02867fdcd2 Merge pull request \fI\%#43277\fP from rallytime/owners\-file
.IP \(bu 2
2b4da0f0e7 Add CODEOWNERS file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43312\fP: (\fI\%lordcirth\fP) cron docs: Remind user to use quotes for special strings
@ \fI2017\-09\-01 16:24:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
1c1c484479 Merge pull request \fI\%#43312\fP from lordcirth/fix\-cron\-docs
.IP \(bu 2
ec94a13750 cron docs: Remind user to use quotes for special strings
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43290\fP: (\fI\%lordcirth\fP) Clarify file.py docs
@ \fI2017\-09\-01 14:30:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d1ed4b750 Merge pull request \fI\%#43290\fP from lordcirth/fix\-file\-path\-docs
.IP \(bu 2
14a4591854 file.py docs: correct group and mode
.IP \(bu 2
d4214ca283 file.py docs: specify absolute paths
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#43274\fP: (\fI\%terminalmage\fP) Use six.integer_types instead of int
@ \fI2017\-08\-30 21:32:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
26ff89539e Merge pull request \fI\%#43274\fP from terminalmage/fix\-int\-types
.IP \(bu 2
d533877743 Use six.integer_types instead of int
.IP \(bu 2
42a118ff56 fixed cmd composition and unified his making across module
.IP \(bu 2
881f1822f2 Format fix code example local returner doc
.UNINDENT
.UNINDENT
.SS Salt 2016.3.0 Release Notes \- Codename Boron
.SS Known Issues
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
\fBSome Salt Masters may need to apply a patch for Default Job Cache to
prevent a possible crash\fP
.sp
An issue exists that prevents the Salt master from cleaning the default job
cache. This issue can cause an overconsumption of resources resulting in a
crash. 2016.3.0 Salt masters should apply the patch in \fI\%PR 33555\fP\&. This
issue will be addressed in 2016.3.1.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
\fI\%issue 33516\fP: When upgrading from 2015.8.10 to 2016.3.0 on centos7/redhat7
salt\-minion must be restarted twice.
.IP \(bu 2
\fI\%issue 33517\fP: SPM does not work on amazon linux 2015 in 2016.3.0.
.UNINDENT
.SS Backwards\-incompatible Changes
.INDENT 0.0
.IP \(bu 2
The default path for the \fI\%extension_modules\fP master config
option has been changed.  Prior to this release, the location was a directory
named \fBextmods\fP in the Salt cachedir. On most platforms, this would put the
\fI\%extension_modules\fP directory in \fB/var/cache/salt/extmods\fP\&.
It has been moved one directory down, into the master cachedir. On most
platforms, this is \fB/var/cache/salt/master/extmods\fP\&. Most users won\(aqt have
to worry about this, but those who have been manually placing custom runners
into \fB/var/cache/salt/extmods/runners\fP, or outputters into
\fB/var/cache/salt/extmods/output\fP, etc. will be affected by this. To
transition, it is recommended not to simply move the extmods directory into
\fB/var/cache/salt/master\fP, but to copy the custom modules into the salt
fileserver under \fBsalt://_runners\fP, \fBsalt://_output\fP, etc. and sync them
using the functions in the new \fI\%saltutil runner\fP\&.
.IP \(bu 2
The \fBpkg.check_db\fP function has been
removed for yum/dnf.
.UNINDENT
.SS Core Changes
.INDENT 0.0
.IP \(bu 2
The \fBonchanges\fP requisite now fires if \fBany\fP watched state changes. \fI\%issue 19592\fP\&.
.IP \(bu 2
The \fBext_pillar\fP functions \fBmust\fP now accept a minion ID as the first
argument. This stops the deprecation path started in Salt 0.17.x. Before this
minion ID first argument was introduced, the minion ID could be retrieved
accessing \fB__opts__[\(aqid\(aq]\fP losing the reference to the master ID initially
set in opts. This is no longer the case, \fB__opts__[\(aqid\(aq]\fP will be kept as
the master ID.
.IP \(bu 2
Custom types can now be synced to the master using the new \fI\%saltutil
runner\fP\&. Before, these needed to manually be placed
under the \fI\%extension_modules\fP directory. This allows custom
modules to easily be synced to the master to make them available when
compiling Pillar data. Just place custom runners into \fBsalt://_runners\fP,
custom outputters into \fBsalt://_output\fP, etc. and use the functions from
the \fI\%saltutil runner\fP to sync them.
.IP \(bu 2
The \fBclient_acl\fP configuration options were renamed to \fBpublisher_acl\fP\&.
.IP \(bu 2
Added a new \fB\-\-config\-dump\fP option (\fI\%issue 26639\fP).
.IP \(bu 2
TCP Transport presence events were updated to work with a NAT (\fI\%PR 30629\fP).
.IP \(bu 2
A \fI\%minion_pillar_cache\fP setting was added to save rendered
pillar data to cachedir for later use when file_client is set to local
(\fI\%PR 30428\fP).
.IP \(bu 2
Added the ability for binary data (such as a license key) to be distributed
via pillar using the \fI\%file.managed\fP
(\fI\%issue 9569\fP).
.IP \(bu 2
Scheduled jobs now include \fBsuccess\fP and \fBretcode\fP (\fI\%issue 24237\fP).
.IP \(bu 2
The \fBsaltversioninfo\fP grain was changed from a string to a list to enable
reading values by index. (\fI\%PR 30082\fP).
.IP \(bu 2
A \fI\%pillar_merge_lists\fP option was added to enable recursively
merging pillar lists by aggregating them instead of replacing them
(\fI\%PR 30062\fP).
.IP \(bu 2
Grain values reported by Debian 8 (jessie) when lsb\-release is installed were
updated for consistency (\fI\%PR 28649\fP).
.IP \(bu 2
A new option for minions called master_tries has been added. This specifies
the number of times a minion should attempt to contact a master to attempt
a connection. This allows better handling of occasional master downtime in
a multi\-master topology.
.IP \(bu 2
The default directory for deploying the salt\-thin tarball has changed for
salt\-ssh. It is now /var/tmp instead of /tmp. Users may also wish
to delete any directories in /tmp ending with \fI_salt/\fP\&. (\fI\%issue 32771\fP)
.UNINDENT
.SS External Module Packaging
.sp
Modules may now be packaged via entry\-points in setuptools. See
\fI\%external module packaging\fP tutorial
for more information.
.SS Cloud Changes
.INDENT 0.0
.IP \(bu 2
Refactored the OpenNebula driver and added numerous \fB\-\-function\fP and
\fB\-\-action\fP commands to enhance Salt support for image, template, security group,
virtual network and virtual machine management in OpenNebula.
.IP \(bu 2
Added execution/state modules to support the deployment of AWS cognito
identity pools (\fI\%PR 31094\fP).
.IP \(bu 2
Added ability to set tags and listener policies on a AWS ELB (\fI\%PR 27552\fP).
.UNINDENT
.SS Platform Changes
.INDENT 0.0
.IP \(bu 2
Renamed modules related to macOS. The following module filenames were changed.
The virtual name remained unchanged.
.IP \(bu 2
\fI\%PR #30558\fP: renamed osxdesktop.py to mac_desktop.py
.IP \(bu 2
\fI\%PR #30557\fP: renamed macports.py to mac_ports.py
.IP \(bu 2
\fI\%PR #30556\fP: renamed darwin_sysctl.py to mac_sysctl.py
.IP \(bu 2
\fI\%PR #30555\fP: renamed brew.py to mac_brew.py
.IP \(bu 2
\fI\%PR #30552\fP: renamed darwin_pkgutil.py to mac_pkgutil.py
.UNINDENT
.SS Package Support
.INDENT 0.0
.IP \(bu 2
Ubuntu Xenial: Packages for Ubuntu Xenial (16.04) are available for 2016.3.0 and
onwards. See \fI\%repo.saltstack.com\fP for more information. Note that Xenial comes
with Debian\(aqs packaged version of Salt 2015.8.8 and official \fI\%repo.saltstack.com\fP
packages are available for 2015.8 releases beginning with Salt 2015.8.11.
.UNINDENT
.SS Proxy Minion Changes
.sp
The deprecated config option \fBenumerate_proxy_minions\fP has been removed.
.sp
As mentioned in earlier documentation, the \fBadd_proxymodule_to_opts\fP
configuration variable defaults to \fBFalse\fP in this release.  This means if you
have proxymodules or other code looking in \fB__opts__[\(aqproxymodule\(aq]\fP you
will need to set this variable in your \fB/etc/salt/proxy\fP file, or
modify your code to use the \fI__proxy__\fP injected variable.
.sp
The \fB__proxyenabled__\fP directive now only applies to grains and proxy modules
themselves.  Standard execution modules and state modules are not prevented
from loading for proxy minions.
.sp
Support has been added to Salt\(aqs loader allowing custom proxymodules
to be placed in \fBsalt://_proxy\fP\&.  Proxy minions that need these modules
will need to be restarted to pick up any changes.  A corresponding utility function,
\fBsaltutil.sync_proxymodules\fP, has been added to sync these modules to minions.
.sp
Enhancements in grains processing have made the \fB__proxyenabled__\fP directive
somewhat redundant in dynamic grains code.  It is still required, but best
practices for the \fB__virtual__\fP function in grains files have changed.  It
is now recommended that the \fB__virtual__\fP functions check to make sure
they are being loaded for the correct proxytype, example below:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def __virtual__():
    \(dq\(dq\(dq
    Only work on proxy
    \(dq\(dq\(dq
    try:
        if salt.utils.is_proxy() and __opts__[\(dqproxy\(dq][\(dqproxytype\(dq] == \(dqssh_sample\(dq:
            return __virtualname__
    except KeyError:
        pass

    return False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBsalt.utils.is_proxy()\fP has been renamed to
\fBsalt.utils.platform.is_proxy\fP as of the Oxygen release.
.UNINDENT
.UNINDENT
.sp
The try/except block above exists because grains are processed very early
in the proxy minion startup process, sometimes earlier than the proxy
key in the \fB__opts__\fP dictionary is populated.
.sp
Grains are loaded so early in startup that no dunder dictionaries are
present, so \fB__proxy__\fP, \fB__salt__\fP, etc. are not available.  Custom
grains located in \fB/srv/salt/_grains\fP and in the salt install grains
directory can now take a single argument, \fBproxy\fP, that is identical
to \fB__proxy__\fP\&.  This enables patterns like
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
def get_ip(proxy):
    \(dq\(dq\(dq
    Ask the remote device what IP it has
    \(dq\(dq\(dq
    return {\(dqip\(dq: proxy[\(dqproxymodulename.get_ip\(dq]()}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then the grain \fBip\fP will contain the result of calling the \fBget_ip()\fP function
in the proxymodule called \fBproxymodulename\fP\&.
.sp
Proxy modules now benefit from including a function called \fBinitialized()\fP\&.  This
function should return \fBTrue\fP if the proxy\(aqs \fBinit()\fP function has been successfully
called.  This is needed to make grains processing easier.
.sp
Finally, if there is a function called \fBgrains\fP in the proxymodule, it
will be executed on proxy\-minion startup and its contents will be merged with
the rest of the proxy\(aqs grains.  Since older proxy\-minions might have used other
methods to call such a function and add its results to grains, this is config\-gated
by a new proxy configuration option called \fBproxy_merge_grains_in_module\fP\&.  This
defaults to \fBFalse\fP in this release.  It will default to True in the release after
next.  The next release is codenamed \fBCarbon\fP, the following is \fBNitrogen\fP\&.
.sp
The example proxy minions \fBrest_sample\fP and \fBssh_sample\fP have been updated to
reflect these changes.
.SS Syndic Updates
.sp
A major performance and management issue was found and fixed in the syndic. This makes
the Salt Syndic substantially more reliable and performant. Please make sure that the
syndic and the master of masters which syndics attach to are updated, otherwise the
syndic fixes alone can cause minor performance issues with older master of masters.
Please update masters first, then syndics.
Minions do not need to be updated for this fix to work.
.SS Module Changes
.INDENT 0.0
.IP \(bu 2
\fI\%file execution module\fP: \fBshow_diff\fP is deprecated in favor
of \fBshow_changes\fP\&. (\fI\%PR 30988\fP)
.IP \(bu 2
\fI\%reg execution module\fP:
.INDENT 2.0
.IP \(bu 2
Removed the following deprecated functions from the reg module (\fI\%PR 30956\fP):
.INDENT 2.0
.IP \(bu 2
read_key
.IP \(bu 2
set_key
.IP \(bu 2
create_key
.IP \(bu 2
delete_key
.UNINDENT
.IP \(bu 2
Removed force parameter from reg state module
.IP \(bu 2
Fixed virtual function in state
.IP \(bu 2
Improved error information for \fBreg.delete_value\fP function
.UNINDENT
.IP \(bu 2
\fI\%jboss7 execution module\fP: \fBdeployed\fP function was
decoupled from Artifactory by removing Artifactory\-specific functionality.
Note that the changes in some of the function arguments break existing state
files, see \fI\%issue 30515\fP and \fI\%PR 3080\fP for details.
.IP \(bu 2
\fI\%pkg state module\fP: The \fBwait\fP function was removed,
the functionality was replaced with the \fBonchanges\fP requisite (\fI\%PR 30297\fP).
.IP \(bu 2
\fI\%firewalld state module\fP: A \fBpermanent\fP argument
was added \fBadd_port\fP\&. Note that \fBpermanent\fP defaults to \fBTrue\fP, which changes
previous behavior (\fI\%PR 30275\fP). A \fBbind\fP function was also added that allows
binding zones to interfaces and sources (\fI\%PR 29497\fP).
.IP \(bu 2
\fI\%journald beacon module\fP: The event string was updated
to include a tag. Note this might impact existing reactors based on this beacon.
(\fI\%PR 30116\fP).
.IP \(bu 2
\fI\%postgres_privileges state module\fP:
The default value of the \fBprepend\fP argument was changed from \fBNone\fP to
\fBpublic\fP\&.
.IP \(bu 2
\fI\%zenoss execution module\fP: The
\fBadd_device\fP function was updated with a default value of \fB1000\fP for
\fBprod_state\fP to match the documentation (\fI\%PR 28924\fP).
.IP \(bu 2
The etcd execution module, state module, returner module, and util module
were refactor (\fI\%PR 28599\fP). This refactor changes error returns for
several functions (primarily edge cases):
.INDENT 2.0
.IP \(bu 2
get: Used to return \(aq\(aq on key\-not\-found. Now returns None.
.IP \(bu 2
set: Used to return \(aq\(aq on issues setting keys. Now returns None.
.IP \(bu 2
ls: Used to return {path: {}} on key\-not\-found. Now returns None.
.IP \(bu 2
Tree: Used to return {} on key\-not\-found. Now returns None.
.UNINDENT
.IP \(bu 2
\fI\%smartos_virt execution module\fP: Updated to
use most of the new smartos_vmadm (\fI\%PR 28284\fP).
.IP \(bu 2
\fI\%apache_conf state module\fP,
\fI\%apache_module state module\fP, and
\fI\%apache_site state module\fP: the \fBenable\fP and
\fBdisable\fP functions were renamed to \fBenabled\fP and \fBdisabled\fP,
respectively.  In \fI\%PR 33562\fP, these functions were readded and properly
deprecated and will be removed in Salt 2017.7.0.  This fix will be available
in 2016.3.1.  As a workaround, try
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
apache_module.enable{{ \(aqd\(aq if grains.saltversioninfo == [2016, 3, 0] else \(aq\(aq }}
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS New Features
.SS Thorium \- Provisional New Reactor
.sp
The 2016.3 release introduces the new Thorium Reactor. This reactor is an
experimental new feature that implements a flow programming interface using
the salt state system as the engine. This means that the Thorium reactor uses
a classic state tree approach to create a reactor that can aggregate event
data from multiple sources and make aggregate decisions about executing
reactions.
.sp
This feature is both experimental and provisional, it may be removed and APIs
may be changed. This system should be considered as ambitious as the Salt
State System in that the scope of adding a programmable logic engine of
this scale into the event systems is non trivial.
.sp
See \fI\%Thorium Complex Reactor\fP\&.
.SS Improved Mac OS Support
.SS Improved Solaris Support
.sp
A lot of work was done to improve support for SmartOS. This work also
resulted in improvements for Solaris and illumos as SmartOS.
.INDENT 0.0
.IP \(bu 2
rewrite of \fI\%vmadm module\fP (SmartOS)
.IP \(bu 2
rewrite of \fI\%imgadm module\fP (SmartOS)
.IP \(bu 2
deprecation of \fI\%virt module\fP in favor of vmadm (SmartOS)
.IP \(bu 2
implemented \fI\%smartos state\fP (SmartOS)
.IP \(bu 2
improved \fI\%zpool module\fP add SmartOS, illumos and Solaris support
.IP \(bu 2
improved \fI\%zfs module\fP add SmartOS, illumos and Solaris support
.IP \(bu 2
implemented \fI\%zpool state\fP
.IP \(bu 2
implemented \fI\%zfs state\fP
implemented \fI\%solaris_system\fP system module to provide better Solaris support (\fI\%PR 30519\fP)
.IP \(bu 2
other minor fixes to grains, localmod, ...
.UNINDENT
.SS Tornado Transport
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
The Tornado Transport wire protocol was changed in 2016.3, making it incompatible with 2015.8 (\fI\%PR 29339\fP).
.UNINDENT
.UNINDENT
.SS Windows DSC Integration (Experiemental)
.SS Dimension Data Cloud Support
.sp
A SaltStack Cloud driver for \fI\%Dimension Data Public Cloud\fP, provides the driver functionality to service automation for any of the Dimension
Data Public Cloud locations:
.INDENT 0.0
.IP \(bu 2
Deploy new virtual machines
.IP \(bu 2
List and query virtual machine images
.IP \(bu 2
Destroy and query virtual machines
.UNINDENT
.sp
Documentation of the Dimension Data SaltStack integration is found on \fI\%developer.dimensiondata.com\fP
.SS Minion Blackout
.sp
During a blackout, minions will not execute any remote execution commands,
except for \fI\%saltutil.refresh_pillar\fP\&. Blackouts are enabled using a special
pillar key, \fBminion_blackout\fP set to \fBTrue\fP\&.
.sp
See \fI\%Minion Blackout\fP\&.
.SS Splunk Returner
.sp
A Splunk Returner that uses HTTP Event Collector is now available (\fI\%PR 30718\fP).
.SS SQLCipher Pillar Module
.sp
Support was added for retrieving pillar data via queries to SQLCiper databases (\fI\%PR 29782\fP).
.SS New Modules
.sp
The following list contains a link to the new modules added in this release.
.SS Beacons
.INDENT 0.0
.IP \(bu 2
\fI\%beacons.adb\fP
.IP \(bu 2
\fI\%beacons.glxinfo\fP
.IP \(bu 2
\fI\%beacons.memusage\fP
.IP \(bu 2
\fI\%beacons.network_settings\fP
.IP \(bu 2
\fI\%beacons.proxy_example\fP
.IP \(bu 2
\fI\%beacons.salt_proxy\fP
.UNINDENT
.SS Engines
.INDENT 0.0
.IP \(bu 2
\fI\%engines.docker_events\fP
.IP \(bu 2
\fI\%engines.redis_sentinel\fP
.IP \(bu 2
\fI\%engines.slack\fP
.IP \(bu 2
\fI\%engines.sqs_events\fP
.IP \(bu 2
\fI\%engines.thorium\fP
.UNINDENT
.SS Execution Modules
.INDENT 0.0
.IP \(bu 2
\fI\%modules.bcache\fP
.IP \(bu 2
\fI\%modules.beacons\fP
.IP \(bu 2
\fI\%modules.boto_cloudtrail\fP
.IP \(bu 2
\fI\%modules.boto_datapipeline\fP
.IP \(bu 2
\fI\%modules.boto_iot\fP
.IP \(bu 2
\fI\%modules.boto_lambda\fP
.IP \(bu 2
\fI\%modules.boto_s3_bucket\fP
.IP \(bu 2
\fI\%modules.chronos\fP
.IP \(bu 2
\fBmodules.cytest\fP
.IP \(bu 2
\fI\%modules.dockercompose\fP
.IP \(bu 2
\fBmodules.dsc\fP
.IP \(bu 2
\fI\%modules.ethtool\fP
.IP \(bu 2
\fI\%modules.github\fP
.IP \(bu 2
\fI\%modules.infoblox\fP
.IP \(bu 2
\fI\%modules.iwtools\fP
.IP \(bu 2
\fBmodules.jenkins\fP
.IP \(bu 2
\fI\%modules.linux_ip\fP
.IP \(bu 2
\fI\%modules.mac_assistive\fP
.IP \(bu 2
\fBmodules.mac_brew\fP
.IP \(bu 2
\fBmodules.mac_defaults\fP
.IP \(bu 2
\fI\%modules.mac_desktop\fP
.IP \(bu 2
\fI\%modules.mac_keychain\fP
.IP \(bu 2
\fI\%modules.mac_pkgutil\fP
.IP \(bu 2
\fBmodules.mac_ports\fP
.IP \(bu 2
\fI\%modules.mac_power\fP
.IP \(bu 2
\fI\%modules.mac_service\fP
.IP \(bu 2
\fI\%modules.mac_shadow\fP
.IP \(bu 2
\fI\%modules.mac_softwareupdate\fP
.IP \(bu 2
\fI\%modules.mac_sysctl\fP
.IP \(bu 2
\fI\%modules.mac_system\fP
.IP \(bu 2
\fI\%modules.mac_timezone\fP
.IP \(bu 2
\fI\%modules.mac_xattr\fP
.IP \(bu 2
\fI\%modules.marathon\fP
.IP \(bu 2
\fI\%modules.minion\fP
.IP \(bu 2
\fI\%modules.openvswitch\fP
.IP \(bu 2
\fI\%modules.opkg\fP
.IP \(bu 2
\fI\%modules.philips_hue\fP
.IP \(bu 2
\fI\%modules.proxy\fP
.IP \(bu 2
\fI\%modules.pushbullet\fP
.IP \(bu 2
\fI\%modules.restartcheck\fP
.IP \(bu 2
\fI\%modules.s6\fP
.IP \(bu 2
\fI\%modules.salt_proxy\fP
.IP \(bu 2
\fBmodules.ssh_package\fP
.IP \(bu 2
\fI\%modules.ssh_service\fP
.IP \(bu 2
\fI\%modules.sysfs\fP
.IP \(bu 2
\fI\%modules.vboxmanage\fP
.IP \(bu 2
\fI\%modules.win_certutil\fP
.IP \(bu 2
\fI\%modules.win_dism\fP
.IP \(bu 2
\fI\%modules.win_dism\fP
.IP \(bu 2
\fI\%modules.win_license\fP
.IP \(bu 2
\fI\%modules.win_iis\fP
.IP \(bu 2
\fI\%modules.win_task\fP
.IP \(bu 2
\fI\%modules.zabbix\fP
.UNINDENT
.SS Pillar
.INDENT 0.0
.IP \(bu 2
\fI\%pillar.http_yaml\fP
.IP \(bu 2
\fI\%pillar.stack\fP
.UNINDENT
.SS Proxy
.INDENT 0.0
.IP \(bu 2
\fI\%proxy.chronos\fP
.IP \(bu 2
\fI\%proxy.junos\fP
.IP \(bu 2
\fI\%proxy.marathon\fP
.IP \(bu 2
\fBproxy.phillips_hue\fP
.IP \(bu 2
\fI\%proxy.ssh_sample\fP
.UNINDENT
.SS Roster
.INDENT 0.0
.IP \(bu 2
\fI\%roster.range\fP
.UNINDENT
.SS States
.INDENT 0.0
.IP \(bu 2
\fI\%states.apache_conf\fP
.IP \(bu 2
\fI\%states.apache_site\fP
.IP \(bu 2
\fI\%states.boto_cloudtrail\fP
.IP \(bu 2
\fI\%states.boto_datapipeline\fP
.IP \(bu 2
\fI\%states.boto_iot\fP
.IP \(bu 2
\fBstates.boto_lamda\fP
.IP \(bu 2
\fI\%states.boto_s3_bucket\fP
.IP \(bu 2
\fI\%states.chocolatey\fP
.IP \(bu 2
\fI\%states.chronos_job\fP
.IP \(bu 2
\fI\%states.firewall\fP
.IP \(bu 2
\fI\%states.github\fP
.IP \(bu 2
\fI\%states.gpg\fP
.IP \(bu 2
\fI\%states.grafana_dashboard\fP
.IP \(bu 2
\fI\%states.grafana_datasource\fP
.IP \(bu 2
\fBstates.infoblox\fP
.IP \(bu 2
\fI\%states.jenkins\fP
.IP \(bu 2
\fI\%states.mac_assistive\fP
.IP \(bu 2
\fBstates.mac_defaults\fP
.IP \(bu 2
\fI\%states.mac_keychain\fP
.IP \(bu 2
\fI\%states.mac_xattr\fP
.IP \(bu 2
\fI\%states.marathon_app\fP
.IP \(bu 2
\fI\%states.openvswitch_bridge\fP
.IP \(bu 2
\fI\%states.openvswitch_port\fP
.IP \(bu 2
\fI\%states.postgres_cluster\fP
.IP \(bu 2
\fI\%states.proxy\fP
.IP \(bu 2
\fI\%states.salt_proxy\fP
.IP \(bu 2
\fI\%states.virt\fP
.IP \(bu 2
\fI\%states.win_certutil\fP
.IP \(bu 2
\fI\%states.win_dism\fP
.IP \(bu 2
\fI\%states.win_license\fP
.IP \(bu 2
\fI\%states.zabbix_host\fP
.IP \(bu 2
\fI\%states.zabbix_hostgroup\fP
.IP \(bu 2
\fI\%states.zabbix_user\fP
.IP \(bu 2
\fI\%states.zabbix_usergroup\fP
.UNINDENT
.SS Salt 2016.3.1 Release Notes
.sp
Version 2016.3.1 is a bugfix release for \fI\%2016.3.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB87\fP
.IP \(bu 2
Total Issue References: \fB23\fP
.IP \(bu 2
Total PR References: \fB58\fP
.IP \(bu 2
Contributors: \fB25\fP (\fI\%abednarik\fP, \fI\%amontalban\fP, \fI\%anlutro\fP, \fI\%babilen\fP, \fI\%cachedout\fP,
\fI\%clburlison\fP, \fI\%danslimmon\fP, \fI\%eliasp\fP, \fI\%glomium\fP, \fI\%jacobhammons\fP, \fI\%jfindlay\fP, \fI\%kev009\fP,
\fI\%lomeroe\fP, \fI\%michalsuba\fP, \fI\%neil\-williamson\fP, \fI\%onorua\fP, \fI\%opdude\fP, \fI\%rallytime\fP, \fI\%sjorge\fP,
\fI\%terminalmage\fP, \fI\%thatch45\fP, \fI\%ticosax\fP, \fI\%tomlaredo\fP, \fI\%twangboy\fP, \fI\%zigarn\fP)
.UNINDENT
.SS Final Release of Debian 7 Packages
.sp
Regular security support for Debian 7 ended on April 25th, 2016. As a result,
2016.3.1 and 2015.8.10 will be the last Salt releases for which Debian 7
packages are created.
.SS Changelog for v2016.3.0..v2016.3.1
.sp
\fIGenerated at: 2018\-05\-27 04:31:54 UTC\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#33883\fP: (\fI\%jfindlay\fP) add 2016.3.1 release notes
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#33866\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-06\-08 19:49:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
be20ce1bbf Merge pull request \fI\%#33866\fP from rallytime/merge\-2016.3
.IP \(bu 2
595d4f2ac3 Fixup new groupadd tests for syntax change in 2016.3
.IP \(bu 2
c5b4ec0b0f Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
ec09095c45 Merge pull request \fI\%#33827\fP from cachedout/issue_33810
.INDENT 2.0
.IP \(bu 2
9d36f1e474 Fix broken locate.locate function
.UNINDENT
.IP \(bu 2
f7b3d0eda0 Merge pull request \fI\%#33839\fP from cachedout/fix_pkgresource_test_stacktrace
.INDENT 2.0
.IP \(bu 2
435547a747 Fix another unit test stacktrace in pkg_resource
.UNINDENT
.IP \(bu 2
5f081ef31c Merge pull request \fI\%#33840\fP from cachedout/remove_matcher_unit_tests
.INDENT 2.0
.IP \(bu 2
6297448377 Remove matcher tests
.UNINDENT
.IP \(bu 2
cda032dab2 Merge pull request \fI\%#33836\fP from cachedout/fix_winserver_manager_test
.INDENT 2.0
.IP \(bu 2
453fb1ac91 Fixing more stupid unit tests
.UNINDENT
.IP \(bu 2
1db559afe9 Merge pull request \fI\%#33805\fP from jfindlay/pkg_tests
.INDENT 2.0
.IP \(bu 2
0c069ddc95 states.pkg int tests: skip if pkg mgr unavailable
.UNINDENT
.IP \(bu 2
3984b65486 Merge pull request \fI\%#33808\fP from jfindlay/gem_tests
.INDENT 2.0
.IP \(bu 2
f7c19a1a58 modules.gem int tests: relax version checks
.IP \(bu 2
6af47d2ba7 modules.gem int tests: remove pkgs before testing install
.UNINDENT
.IP \(bu 2
c30d8a8c61 Merge pull request \fI\%#33770\fP from jfindlay/service_tests
.INDENT 2.0
.IP \(bu 2
f13f914755 states.service: add integration tests
.IP \(bu 2
90aee79c39 states.service.mod_watch: update unit test
.IP \(bu 2
d210a92f09 states.service.mod_watch: update sfun and force docs
.UNINDENT
.IP \(bu 2
7fdfbe9a28 Merge pull request \fI\%#33691\fP from jtand/gem_integration_test
.INDENT 2.0
.IP \(bu 2
ff2dae103d ubuntu doesn\(aqt install default gems when ruby is installed
.IP \(bu 2
504df9a65a Fixed lint error
.IP \(bu 2
0cb1bfa0d3 Removed extra :
.IP \(bu 2
86f59b3e80 Made more pythonic
.IP \(bu 2
2f36f34981 Fixed salt.util import. Added status check to make sure external resource is available
.IP \(bu 2
400a71ec33 Removed redundancies
.IP \(bu 2
91db411bea A couple lint fixes
.IP \(bu 2
c97f3319b9 Add check for gem binary
.IP \(bu 2
210aceb402 Refactored tests to not use return messages
.IP \(bu 2
9d437bd45d Removed artifact from testing
.IP \(bu 2
134e1fa888 Fixed typos, and added destructiveTest decorator
.IP \(bu 2
37bc3ad8fd Fixed typo, uninstalled to uninstall
.IP \(bu 2
5b23b91ac6 Integration test for gem module
.UNINDENT
.IP \(bu 2
bb4194bb79 Merge pull request \fI\%#33777\fP from sodium\-chloride/2015.8\-2016\-0604\-1939
.INDENT 2.0
.IP \(bu 2
c1fd830a1a Fix minor docstring issue of arg being missing
.UNINDENT
.IP \(bu 2
c749aea409 Merge pull request \fI\%#33759\fP from cachedout/issue_31219
.INDENT 2.0
.IP \(bu 2
15a39f8646 Catch no minions exception in batch mode
.UNINDENT
.IP \(bu 2
47d668e071 Merge pull request \fI\%#33719\fP from cachedout/fixup_33653
.INDENT 2.0
.IP \(bu 2
635efa248b Change to just surround the mkdir
.IP \(bu 2
21b7123a60 Catch oserror for race condition
.UNINDENT
.IP \(bu 2
11e39e7203 Merge pull request \fI\%#33712\fP from meaksh/fix\-for\-groupadd\-module\-failures\-in\-SLE11\-2015.8
.INDENT 2.0
.IP \(bu 2
ab738416ba pylint fix
.IP \(bu 2
bf27e5d36e test_members cleanup
.IP \(bu 2
ba815dbf76 improvements on groupadd unit tests
.IP \(bu 2
3bbc5ae0d9 one line is better
.IP \(bu 2
a53dc192c9 fix groupadd module for sles11 systems
.UNINDENT
.IP \(bu 2
2c450a7494 Merge pull request \fI\%#33718\fP from rallytime/bp\-33700
.INDENT 2.0
.IP \(bu 2
a6a446121a Fix speed issue
.IP \(bu 2
a41146730a Fix incorrect args passed to timezone.set_hwclock
.UNINDENT
.IP \(bu 2
b07701f0a0 Merge pull request \fI\%#33727\fP from terminalmage/issue33725
.INDENT 2.0
.IP \(bu 2
d8ba7ed5a5 Fix git_pillar edge case for remote repos without a master branch
.UNINDENT
.IP \(bu 2
015e50cec8 Merge pull request \fI\%#33728\fP from jfindlay/test_state_test
.INDENT 2.0
.IP \(bu 2
87e018af2a states.test.configurable_test_state: add unit tests
.IP \(bu 2
c2d0679c4b states.test.configurable_test_state: refactor change_data
.IP \(bu 2
f06ff1af1f states.test.configurable_test_state test mode
.UNINDENT
.IP \(bu 2
1cf8fe3f1d Merge pull request \fI\%#33729\fP from twangboy/fix_win_servermanager
.INDENT 2.0
.IP \(bu 2
2de91d166f Fix docstring
.IP \(bu 2
9870479d99 Add exclude option to state
.IP \(bu 2
50bd76e206 Add exclude option
.UNINDENT
.IP \(bu 2
6c150d840d Merge pull request \fI\%#33743\fP from vutny/drop\-debian\-community\-repo\-doc
.INDENT 2.0
.IP \(bu 2
8621f5be54 Debian installation docs: drop section about community\-maintained repository
.UNINDENT
.IP \(bu 2
56c0a42e12 Create missing jid dir if it doesn\(aqt exist (\fI\%#33653\fP)
.IP \(bu 2
8a566ff4b9 Merge pull request \fI\%#33654\fP from twangboy/fix_win_servermanager
.INDENT 2.0
.IP \(bu 2
6c7b21676a Fix lint and tests
.IP \(bu 2
4775e6bdf0 Add additional params to state
.IP \(bu 2
b0af32346d Add additional params to install and remove
.UNINDENT
.IP \(bu 2
996ff56dd4 Merge pull request \fI\%#33679\fP from terminalmage/issue33424
.INDENT 2.0
.IP \(bu 2
9da40c4437 Append empty dictionaries for saltenvs with no top file
.IP \(bu 2
5eb1b3ca62 Only compile the template contents if they evaluate to True
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33843\fP: (\fI\%richardscollin\fP) 2016.3 Test Suite TCP Error (refs: \fI\%#33860\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33860\fP: (\fI\%cachedout\fP) Allow socket closes when the socket is disconnected
@ \fI2016\-06\-08 18:26:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
669aa92d59 Merge pull request \fI\%#33860\fP from cachedout/issue_33843
.IP \(bu 2
2c88e22c07 Use errno
.IP \(bu 2
e7de99dd0e Correct silly mistake
.IP \(bu 2
7a46360a13 Allow socket closes when the socket is disconnected
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33818\fP: (\fI\%saltuser\fP) 2016.3.0 minion default log level INFO (refs: \fI\%#33821\fP, \fI\%#33861\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33861\fP: (\fI\%cachedout\fP) Set master and cloud to log level warning
.IP \(bu 2
\fBPR\fP \fI\%#33821\fP: (\fI\%cachedout\fP) Restore default log level to warning (refs: \fI\%#33861\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33698\fP: (\fI\%opdude\fP) Vsphere fixes
@ \fI2016\-06\-08 14:12:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
a3202f1ad6 Merge pull request \fI\%#33698\fP from Unity\-Technologies/vsphere\-fixes
.IP \(bu 2
8ff5906fad Revert \(dqFix\ a bug when creating a new VM and changing the network info\(dq
.IP \(bu 2
636f4c00f0 Make sure we only use GetConnection if we are using a proxy salt minion
.IP \(bu 2
64e9334d56 Fix a bug with self signed certificates and creating a new VM
.IP \(bu 2
7834aeda7d Fix\ a bug when creating a new VM and changing the network info
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33771\fP: (\fI\%twangboy\fP) Additional functionality to win_dism.py
@ \fI2016\-06\-08 13:58:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
01aaf3e2a9 Merge pull request \fI\%#33771\fP from twangboy/win_dism
.IP \(bu 2
9be45fe37a Fix some more lint
.IP \(bu 2
421dc97957 Fix/add unit tests for state
.IP \(bu 2
8d66fac74c Add missing unit tests
.IP \(bu 2
60f856f73d Fix unit tests for module
.IP \(bu 2
b574947afe Fix some lint errors
.IP \(bu 2
a32774c07d Add salt.utils.compare_lists
.IP \(bu 2
7ff7050705 Fix incorrect parameters in the state
.IP \(bu 2
b8ee89f18e Fix typos
.IP \(bu 2
10458d8a70 Remove multiple lookups, faster
.IP \(bu 2
d9b848c0d9 Change to dict instead of error
.IP \(bu 2
6510e0a5b0 Add restart option
.IP \(bu 2
da8562dbc8 Add quiet and norestart options
.IP \(bu 2
946371bf1f Handle errors, ensure add/remove
.IP \(bu 2
7e6382a8b2 Use list instead of string for cmd
.IP \(bu 2
fbdd28f144 Add state functions
.IP \(bu 2
90a4ee3d96 Merge branch \(aq2016.3\(aq of \fI\%https://github.com/saltstack/salt\fP into win_dism
.IP \(bu 2
00c24abe1f Add get functions
.IP \(bu 2
c6621053fd Add additional functions
.IP \(bu 2
36507845b6 Update documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33649\fP: (\fI\%tyhunt99\fP) 2016.3.0 dockerng state fails comparing cmd configuration (refs: \fI\%#33851\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33851\fP: (\fI\%ticosax\fP) [dockerng] Add support for edge case when \fICmd\fP and \fIEntrypoint\fP can\(aqt be blanked
@ \fI2016\-06\-08 13:52:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
f546e47552 Merge pull request \fI\%#33851\fP from ticosax/fix\-entrypoint\-support
.IP \(bu 2
0d40e1c4f3 Add support for edge case when Cmd and Entrypoint can\(aqt be blanked
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33818\fP: (\fI\%saltuser\fP) 2016.3.0 minion default log level INFO (refs: \fI\%#33821\fP, \fI\%#33861\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33821\fP: (\fI\%cachedout\fP) Restore default log level to warning (refs: \fI\%#33861\fP)
@ \fI2016\-06\-07 16:51:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
3f6d06a060 Merge pull request \fI\%#33821\fP from cachedout/issue_33818
.IP \(bu 2
52f1f77a38 Restore default log level to warning
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33578\fP: (\fI\%ohauer\fP) 2016.3.0 FreeBSD Failed to load grains defined in grain file disks.disks in function <function disks at 0x80cff9320>, error: (refs: \fI\%#33604\fP, \fI\%#33767\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33767\fP: (\fI\%amontalban\fP) Fix \fI\%#33604\fP implementation when \(aqgeom disk list\(aq does not output rotat…
@ \fI2016\-06\-07 14:41:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33604\fP: (\fI\%kev009\fP) Fix \fI\%#33578\fP disks grain (refs: \fI\%#33767\fP)
.IP \(bu 2
3e48b701e3 Merge pull request \fI\%#33767\fP from amontalban/2016.3
.IP \(bu 2
b8c0dd5b4c Fix \fI\%#33604\fP implementation when \(aqgeom disk list\(aq does not output rotationrate. \fI\%#33578\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33806\fP: (\fI\%cachedout\fP) Work around upstream cherrypy bug
@ \fI2016\-06\-07 14:39:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
a84588c788 Merge pull request \fI\%#33806\fP from cachedout/cherrypy_1444
.IP \(bu 2
1b537d41b6 Work around upstream cherrypy bug
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33754\fP: (\fI\%zerthimon\fP) boto_s3_bucket.present is not idempotent (refs: \fI\%#33776\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33776\fP: (\fI\%danslimmon\fP) Fixed ACL user comparison. Resolves \fI\%#33754\fP\&.
@ \fI2016\-06\-06 11:11:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
94f98b4ab8 Merge pull request \fI\%#33776\fP from danslimmon/s3\-bucket\-idempotency\-33754
.IP \(bu 2
35b84f1877 Fixed bug where _prep_acl_for_compare() would edit but not return
.IP \(bu 2
f87bc347fd Fixed ACL user comparison. Resolves \fI\%#33754\fP\&.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33741\fP: (\fI\%jopohl\fP) pkg.install: ERROR: Zypper command failure: Unknown option \(aq\-\-no\-refresh\(aq (refs: \fI\%#33763\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33763\fP: (\fI\%abednarik\fP) Insert \-\-no\-refresh before install in Zypper.
@ \fI2016\-06\-06 10:53:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
a92e155a04 Merge pull request \fI\%#33763\fP from abednarik/abednarik_zypper_no_refresh_fix
.IP \(bu 2
7c909a1d7f Insert \-\-no\-refresh before install in Zypper.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33647\fP: (\fI\%closepin\fP) Pillars passed from command\-line override pillar subtrees instead of merging (refs: \fI\%#33764\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33764\fP: (\fI\%terminalmage\fP) Merge instead of update pillar overrides
@ \fI2016\-06\-06 10:52:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
306848a2d7 Merge pull request \fI\%#33764\fP from terminalmage/issue33647
.IP \(bu 2
914003c995 Merge instead of update pillar overrides
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33772\fP: (\fI\%danslimmon\fP) Fixed spelling of \(dqthrough\(dq
@ \fI2016\-06\-06 10:50:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
b37a862b70 Merge pull request \fI\%#33772\fP from danslimmon/trough\-through
.IP \(bu 2
ea3498aedc Fixed spelling of \(dqthrough\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33614\fP: (\fI\%knuta\fP) grains.has_key()  always returns false in 2016.3.0 (refs: \fI\%#33651\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33651\fP: (\fI\%cachedout\fP) Restore grains context to renderers
@ \fI2016\-06\-03 20:48:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
a8d9221631 Merge pull request \fI\%#33651\fP from cachedout/issue_33614
.IP \(bu 2
5518e1dd14 Fix whitespace
.IP \(bu 2
7b50e1766e Better fix
.IP \(bu 2
4e18ff7000 Restore grains context to renderers
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33757\fP: (\fI\%cachedout\fP) Reminder not to return non\-serializable data from states
@ \fI2016\-06\-03 19:23:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
daf462e430 Merge pull request \fI\%#33757\fP from cachedout/state_set_doc
.IP \(bu 2
500d4ccec2 Reminder not to return non\-serializable data from states
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33605\fP: (\fI\%morganwillcock\fP) win_pkg: UnicodeEncodeError where DisplayName includes \(dqEspañol\(dq (refs: \fI\%#33670\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33670\fP: (\fI\%rallytime\fP) Handle non\-ascii package names in state.format_log
@ \fI2016\-06\-03 16:16:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
a5684ed123 Merge pull request \fI\%#33670\fP from rallytime/fix\-33605
.IP \(bu 2
59bd51f4c8 Update test to correct iteration
.IP \(bu 2
a580d1c6e0 Add unit test for format_log change
.IP \(bu 2
e68097445c Revert \(dqTrack down more unicode instances and add a test\(dq
.IP \(bu 2
9729aed262 Track down more unicode instances and add a test
.IP \(bu 2
ae332d1f88 Handle non\-ascii package names in state.format_log
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33588\fP: (\fI\%whytewolf\fP) rabbitmq_user.present error  (refs: \fI\%#33641\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33723\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33641\fP to 2016.3
@ \fI2016\-06\-03 16:07:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33641\fP: (\fI\%glomium\fP) check rabbitmq version and use different api to validate a users pass… (refs: \fI\%#33723\fP)
.IP \(bu 2
56eab363ff Merge pull request \fI\%#33723\fP from rallytime/bp\-33641
.IP \(bu 2
77a51a00a3 pylint W0141, W0702
.IP \(bu 2
f8518939a7 check rabbitmq version and use different api to validate a users password
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32059\fP: (\fI\%fuzzy\-id\fP) dockerng fails with: create_container() got an unexpected keyword argument \(aqbinds\(aq (refs: \fI\%#33748\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33748\fP: (\fI\%ticosax\fP) HostConfig has been introduced by docker api version 1.15
@ \fI2016\-06\-03 15:28:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
c2b970789c Merge pull request \fI\%#33748\fP from ticosax/adjust\-api\-version\-host\-config
.IP \(bu 2
134e4a9abf HostConfig has been intoriduced by docker api version 1.15
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33745\fP: (\fI\%eliasp\fP) Typo (\fIprivilages\fP → \fIprivileges\fP)
@ \fI2016\-06\-03 15:14:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
e08c685a6c Merge pull request \fI\%#33745\fP from eliasp/2016.3\-typo\-privilages\-privileges
.IP \(bu 2
646bc426c6 Typo (\fIprivilages\fP → \fIprivileges\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33537\fP: (\fI\%anlutro\fP) apache_module state functions changed names with no deprecation warning or backward compatibility (refs: \fI\%#33562\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33562\fP: (\fI\%jfindlay\fP) states.apache_*: readd and deprecate enable and disable
@ \fI2016\-06\-02 19:51:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29651\fP: (\fI\%zigarn\fP) Deb apache fixes (refs: \fI\%#33562\fP)
.IP \(bu 2
5f4c6902aa Merge pull request \fI\%#33562\fP from jfindlay/apache_funcs
.IP \(bu 2
9b0eb858a6 add note and workaround to release notes
.IP \(bu 2
17306bfc69 states.apache_*: readd and deprecate enable and disable
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33632\fP: (\fI\%rbjorklin\fP) dockerng.volume_present: Dryrun isn\(aqt dry (refs: \fI\%#33659\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33659\fP: (\fI\%danslimmon\fP) Added test mode to states.dockerng. Resolves \fI\%#33632\fP\&.
@ \fI2016\-06\-02 17:45:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
d3253effe9 Merge pull request \fI\%#33659\fP from danslimmon/dockerng\-dryrun\-33632
.IP \(bu 2
ef885c1b7e Added test mode to dockerng.volume_present. Resolves \fI\%#33632\fP\&.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33696\fP: (\fI\%clburlison\fP) Update mac native package for upcoming release
@ \fI2016\-06\-02 17:44:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
1d6582b659 Merge pull request \fI\%#33696\fP from clburlison/2016.3\-pkg\-fix
.IP \(bu 2
b483d1d8a6 Update mac native package for upcoming release
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33710\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-06\-02 16:19:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
78966f5f30 Merge pull request \fI\%#33710\fP from rallytime/merge\-2016.3
.IP \(bu 2
b7accb0b3b Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
c8dc70b96a Merge pull request \fI\%#33685\fP from jfindlay/get_url_test
.INDENT 2.0
.IP \(bu 2
2b5035fdc0 modules.cp.get_url: add test for \fI\%https://\fP
.UNINDENT
.IP \(bu 2
5e022ff29c Merge pull request \fI\%#33581\fP from dincamihai/2015.8
.INDENT 2.0
.IP \(bu 2
788730ea72 DRY test
.IP \(bu 2
1d3769ccfa Improve zypper_patcher_config looks
.IP \(bu 2
42d8d4195c Assert only gpgautoimport: True works
.IP \(bu 2
ced75e8e62 Reverse if conditions and rename variable
.IP \(bu 2
80bfbe5c52 Reduce dicts and lists to one line where possible
.IP \(bu 2
1d5d6d7d60 Update test method names to pass pylint
.IP \(bu 2
c7ae5907ee Call zypper refresh after adding/modifying a repository
.UNINDENT
.IP \(bu 2
069ee15b7c Merge pull request \fI\%#33681\fP from rallytime/bp\-33599
.INDENT 2.0
.IP \(bu 2
45143a599b use requests streaming for uploads/downloads to file (return_bin unchanged) allows downloading files larger than amount of memory (non\-stream reads into memory before writing to disk or uploading)
.IP \(bu 2
4a9b23f03f first go at having requests use streaming for get/put requests
.UNINDENT
.IP \(bu 2
13537c4891 Merge pull request \fI\%#33396\fP from babilen/issue\-33393
.INDENT 2.0
.IP \(bu 2
57e0475cd4 Make pip InstallationError import more robust
.IP \(bu 2
291a3e21fa Remove duplicated code.
.UNINDENT
.IP \(bu 2
7bce4ece1a Merge pull request \fI\%#33652\fP from terminalmage/zh723
.INDENT 2.0
.IP \(bu 2
411841603a Lower the log level for failed auths
.UNINDENT
.IP \(bu 2
504989388a Merge pull request \fI\%#33615\fP from danslimmon/mysql\-traceback\-33582
.INDENT 2.0
.IP \(bu 2
180099ae9f Wrote test for broken server connection
.IP \(bu 2
c6c3ff02e3 Added some error checking to resolve \fI\%#33582\fP\&.
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32916\fP: (\fI\%giannello\fP) file.managed memory usage with s3 sources (refs: \fI\%#33599\fP, \fI\%#33682\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33682\fP: (\fI\%lomeroe\fP) backport \fI\%#33599\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#33599\fP: (\fI\%lomeroe\fP) Fix s3 large file download (refs: \fI\%#33681\fP, \fI\%#33682\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33532\fP: (\fI\%Routhinator\fP) 2016.3 breaks existing formulas that work on 2015.8 (refs: \fI\%#33688\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33688\fP: (\fI\%terminalmage\fP) Undo __repr__() and __str__() parts of d5a7dcc
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29265\fP: (\fI\%mbochenk\fP) mysql_user.present does not work with MySQL 5.7 (refs: \fI\%#33690\fP, \fI\%#32440\fP, \fI\%#30603\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33690\fP: (\fI\%neil\-williamson\fP) Remove explicit PW column default from mysql_user
.IP \(bu 2
\fBPR\fP \fI\%#32440\fP: (\fI\%neil\-williamson\fP) Automatically detect correct MySQL password column for 5.7 and fix setting passwords (refs: \fI\%#33690\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30603\fP: (\fI\%michalsuba\fP) addressing \fI\%#29265\fP (refs: \fI\%#32440\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33680\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32942\fP to 2016.3
@ \fI2016\-06\-01 22:14:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32942\fP: (\fI\%onorua\fP) Make tornado raise error configurable (refs: \fI\%#33680\fP)
.IP \(bu 2
c725854596 Merge pull request \fI\%#33680\fP from rallytime/bp\-32942
.IP \(bu 2
09751ecb04 Make tornado raise error configurable (\fI\%#32942\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33677\fP: (\fI\%twangboy\fP) Pass kwargs to cmd.run
@ \fI2016\-06\-01 20:20:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
9571dad678 Merge pull request \fI\%#33677\fP from twangboy/fix_runas
.IP \(bu 2
4272afe0d5 Pass kwargs to cmd.run
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33529\fP: (\fI\%djneades\fP) pkg.latest completely broken on FreeBSD in salt\-ssh 2016.3 (refs: \fI\%#33648\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33648\fP: (\fI\%terminalmage\fP) salt.modules.pkgng: Fix incorrect usage of _pkg()
@ \fI2016\-06\-01 16:37:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
d566ec4b31 Merge pull request \fI\%#33648\fP from terminalmage/issue33529
.IP \(bu 2
4ad80d29b6 salt.modules.pkgng: Fix incorrect usage of _pkg()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33646\fP: (\fI\%jfindlay\fP) Fix more tmp paths on MacOS
@ \fI2016\-06\-01 16:36:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
e92d6e214f Merge pull request \fI\%#33646\fP from jfindlay/mac_tests
.IP \(bu 2
c53a727c18 tests.runtests: use globally\-determined tempdir
.IP \(bu 2
8295b48459 test.integration: use hard /tmp on MacOS
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33656\fP: (\fI\%cachedout\fP) Fix indentation error in minion.py
@ \fI2016\-06\-01 16:23:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33076\fP: (\fI\%cachedout\fP) Avoid second grains load on windows multiprocessing (refs: \fI\%#33656\fP)
.IP \(bu 2
9603cd3c0d Merge pull request \fI\%#33656\fP from cachedout/fix_33076
.IP \(bu 2
8259d4091f Fix indentation error in minion.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33637\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-05\-31 18:43:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
b379dc57fd Merge pull request \fI\%#33637\fP from rallytime/merge\-2016.3
.IP \(bu 2
cd05d2bed1 Fix zypper test
.IP \(bu 2
74a7b78e00 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
b47182e47c Merge pull request \fI\%#33558\fP from twangboy/fix_win_servermanager
.INDENT 2.0
.IP \(bu 2
62a6bde0ea Fix comment when already installed
.IP \(bu 2
79bc7195dc Fix unit tests
.IP \(bu 2
56a6f6bb83 Fix changes
.IP \(bu 2
8ebe99ec5e Fix restart_needed
.IP \(bu 2
6e478cbda0 Add restart needed
.IP \(bu 2
72ebf26616 Add missing import
.IP \(bu 2
193583be96 Use dictionary compare for changes in remove
.IP \(bu 2
1ae7dd76c1 Use dictionary compare for changes
.UNINDENT
.IP \(bu 2
58d89d66e3 Merge pull request \fI\%#33555\fP from cachedout/issue_33544
.INDENT 2.0
.IP \(bu 2
fe7ee7a470 Fix crashing Maintenence process
.UNINDENT
.IP \(bu 2
d052908729 Merge pull request \fI\%#33501\fP from meaksh/zypper\-download\-check\-signature\-2015.8
.INDENT 2.0
.IP \(bu 2
eaaef25c79 lint issue fixed
.IP \(bu 2
6b6febb211 unit tests for rpm.checksum() and zypper.download()
.UNINDENT
.IP \(bu 2
e2d0c4abb1 Merge pull request \fI\%#33513\fP from rallytime/fix\-33319
.INDENT 2.0
.IP \(bu 2
81c1471209 Add a section to the jinja docs about escaping jinja
.UNINDENT
.IP \(bu 2
fabc15e616 Merge pull request \fI\%#33520\fP from jacobhammons/release\-notes.8
.INDENT 2.0
.IP \(bu 2
42e358af7d Updated version numbers in the docs for the 2016.3.0 release
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33638\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33613\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#33613\fP: (\fI\%abednarik\fP) Updated apache_module for backward compatible. (refs: \fI\%#33638\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33590\fP: (\fI\%morganwillcock\fP) ini_manage.options_absent: only works in test mode (TypeError: unhashable type: \(aqlist\(aq) (refs: \fI\%#33606\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33606\fP: (\fI\%danslimmon\fP) Fixed ini.options_absent. Resolves \fI\%#33590\fP\&.
@ \fI2016\-05\-31 15:51:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
23506f8279 Merge pull request \fI\%#33606\fP from danslimmon/ini\-optionsabsent\-33590
.IP \(bu 2
fb13852102 Fixed ini.options_absent. Resolves \fI\%#33590\fP\&.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33578\fP: (\fI\%ohauer\fP) 2016.3.0 FreeBSD Failed to load grains defined in grain file disks.disks in function <function disks at 0x80cff9320>, error: (refs: \fI\%#33604\fP, \fI\%#33767\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33604\fP: (\fI\%kev009\fP) Fix \fI\%#33578\fP disks grain (refs: \fI\%#33767\fP)
@ \fI2016\-05\-31 15:17:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
44e8c9e720 Merge pull request \fI\%#33604\fP from kev009/fix\-33578
.IP \(bu 2
e452ec514e Ignore cdroms in disks grain
.IP \(bu 2
8bf0290024 Make disks grain datatyper more resilient
.IP \(bu 2
\fBPR\fP \fI\%#33631\fP: (\fI\%babilen\fP) Fix \(aqvirt\(aq state names in cloud controller tutorial
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33603\fP: (\fI\%sjorge\fP) allow esky packages to be build on base64 2015Q4
@ \fI2016\-05\-29 00:36:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
e9a0c9304a Merge pull request \fI\%#33603\fP from sjorge/2016.3\-smartos\-esky
.IP \(bu 2
1064102394 add no\-wheel, instructions were failing for someone testing due to wheel being used nog producing an egg
.IP \(bu 2
c85e03ecf7 allow for newer pyzmq in esky packages
.IP \(bu 2
1620b8c0fa allow esky packages to be build on base64 2015Q4
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33565\fP: (\fI\%jamesp9\fP) Typo in states/virtualenv_mod.py (refs: \fI\%#33576\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33576\fP: (\fI\%tomlaredo\fP) Fix \fI\%#33565\fP (typo causes invalid syntax)
@ \fI2016\-05\-27 16:46:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
afd3c1b9bd Merge pull request \fI\%#33576\fP from rodacom/2016.3
.IP \(bu 2
9f7d81e0cc Fix \fI\%#33565\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33530\fP: (\fI\%kluoto\fP) Centos7 pkg.upgrade failure on 2016.3 (refs: \fI\%#33549\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33549\fP: (\fI\%thatch45\fP) Fix for \fI\%#33530\fP
@ \fI2016\-05\-26 19:26:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
71145ddda7 Merge pull request \fI\%#33549\fP from thatch45/33530
.IP \(bu 2
b906859fce Fix for \fI\%#33530\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33538\fP: (\fI\%anlutro\fP) Fix a KeyError if group is provided but not user in cmd states
@ \fI2016\-05\-26 17:58:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
4831c6a353 Merge pull request \fI\%#33538\fP from alprs/fix\-cmd_user_runas_deprecation_bug
.IP \(bu 2
c738a0de76 fix a KeyError if group is provided but not user
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33543\fP: (\fI\%arthurlogilab\fP) Thorium documentation is incorrectly formatted and appears partially on docs.saltproject.io (refs: \fI\%#33550\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33550\fP: (\fI\%jacobhammons\fP) Fixes display of thorium docs
@ \fI2016\-05\-26 17:57:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
5287a1b8c8 Merge pull request \fI\%#33550\fP from saltstack/jacobhammons\-patch\-1
.IP \(bu 2
65df3a6fa2 Refs \fI\%#33543\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33509\fP: (\fI\%twangboy\fP) Detect System Architecture for Mac Build
@ \fI2016\-05\-26 14:40:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a95f8a977 Merge pull request \fI\%#33509\fP from twangboy/fix_arch
.IP \(bu 2
7844059dcf Handle system architecture
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33522\fP: (\fI\%jfindlay\fP) rework modules.mac_brew.latest_version to work around brew version inconsistency
@ \fI2016\-05\-26 14:19:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
0bc881b4da Merge pull request \fI\%#33522\fP from jfindlay/mac_pkg
.IP \(bu 2
2781377b17 modules.mac_brew: update unit tests
.IP \(bu 2
0ed3598fc9 modules.mac_brew int tests: add latest_version test
.IP \(bu 2
8789c2d06d modules.mac_brew int tests: add list_upgrades,info_installed
.IP \(bu 2
be381e0fc9 modules.mac_brew int tests: move decorators to class
.IP \(bu 2
fa3ec8a2bf modules.mac_brew.latest_version: refactor to use standard methods
.IP \(bu 2
58492c29cf modules.mac_brew: add info_installed function
.IP \(bu 2
9abf8f4832 modules.mac_brew.list_upgrades: use brew\(aqs json output
.IP \(bu 2
77a4f5b01e modules.mac_brew: move retcode check to _call_brew
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33519\fP: (\fI\%jacobhammons\fP) New doc site layout, 2016.3.0 release note known issue additions
@ \fI2016\-05\-26 13:53:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
518713f5e5 Merge pull request \fI\%#33519\fP from jacobhammons/2016.3.0rel
.IP \(bu 2
a424c38f5d New doc site layout, 2016.3.0 release note known issue additions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33508\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-05\-25 20:34:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
9199101ef2 Merge pull request \fI\%#33508\fP from rallytime/merge\-2016.3
.IP \(bu 2
a5e0141eda Merge branch \(aq2015.8\(aq into \(aq2106.3\(aq
.IP \(bu 2
5a6b037cbd Merge pull request \fI\%#33507\fP from rallytime/merge\-2015.8
.INDENT 2.0
.IP \(bu 2
03b0c97520 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
6f7fda0354 Merge pull request \fI\%#33486\fP from jtand/2015.5
.INDENT 2.0
.IP \(bu 2
d1e210fff8 Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into 2015.5
.IP \(bu 2
ee2ae0ea8a Added docstring examples to glance.image_schema and schema_get
.IP \(bu 2
59e90064e6 modules.swift.head does not have a body. Should not be checked for a docstring right now.
.UNINDENT
.IP \(bu 2
f72ec1479b Merge pull request \fI\%#33482\fP from rallytime/pillar\-opts\-docs
.INDENT 2.0
.IP \(bu 2
087564528d Add pillar_opts docs to master.rst
.UNINDENT
.IP \(bu 2
dc644b145d Merge pull request \fI\%#33488\fP from rallytime/fix\-18752
.INDENT 2.0
.IP \(bu 2
b0a9f4181f Add docs for the syndic_finger config
.UNINDENT
.IP \(bu 2
a4e84aa7d2 Merge pull request \fI\%#33454\fP from scubahub/2015.5
.INDENT 2.0
.IP \(bu 2
df3c0b8e78 Correct (and make consistent) determination of the test flag.
.UNINDENT
.IP \(bu 2
3a52ace673 manage account information for pam (\fI\%#33473\fP)
.UNINDENT
.IP \(bu 2
ee76be3b0b Merge pull request \fI\%#33503\fP from rallytime/fix\-15252
.INDENT 2.0
.IP \(bu 2
cfc07f7641 Add docs about minion config file in standalone minion docs
.UNINDENT
.IP \(bu 2
e9b648e461 Merge pull request \fI\%#33474\fP from cachedout/issue_29451
.INDENT 2.0
.IP \(bu 2
aa2bac3a0d Remove debugging
.IP \(bu 2
68d8050cb8 Fix diskusage beacon
.UNINDENT
.IP \(bu 2
3bfb6bf719 Merge pull request \fI\%#33465\fP from meaksh/check\-if\-job\-returns\-successfully\-2015.8
.INDENT 2.0
.IP \(bu 2
9deb70fd8e jobs.exit_success() now works parsing the results of jobs.lookup_id()
.IP \(bu 2
7ba40c4f31 jobs.exit_success allow checking if a job has executed and exit successfully
.UNINDENT
.IP \(bu 2
70eb7b66f3 Merge pull request \fI\%#33487\fP from jtand/glance_doc_fixes
.INDENT 2.0
.IP \(bu 2
0b1cae05d9 Added docstring examples to glance methods and nova.list
.IP \(bu 2
ebf1256545 Don\(aqt need to check swift.head due to it having no body
.UNINDENT
.IP \(bu 2
56ea979916 Merge pull request \fI\%#33481\fP from rallytime/fix\-33423
.INDENT 2.0
.IP \(bu 2
7fd3e8f361 Fix docs about etcd config options and add pillar_opts doc
.UNINDENT
.IP \(bu 2
2394cdc4bf Merge pull request \fI\%#33490\fP from rallytime/fix\-16319
.INDENT 2.0
.IP \(bu 2
0c5548f9d1 Document the postgres.psql_query function
.UNINDENT
.IP \(bu 2
ede232f0f1 Merge pull request \fI\%#33480\fP from jfindlay/service_doc
.INDENT 2.0
.IP \(bu 2
29c00a1b1b states.service: clarify function description language
.IP \(bu 2
6a9ae09e79 states.service.__virtual__: add load fail reason
.UNINDENT
.IP \(bu 2
4f96cc1f54 Return full pending computer name (\fI\%#33483\fP)
.IP \(bu 2
a89be5e9d4 Use six.string_types in jobs runner (\fI\%#33499\fP)
.IP \(bu 2
2e24a04565 Merge pull request \fI\%#33491\fP from BlaineAtAffirm/2015.8
.INDENT 2.0
.IP \(bu 2
7599b18995 fix jobs.list_jobs failing with search_target
.UNINDENT
.IP \(bu 2
1861af427e Merge pull request \fI\%#33478\fP from rallytime/bp\-32484
.INDENT 2.0
.IP \(bu 2
042f17efa4 Only unsub if we have a jid
.UNINDENT
.IP \(bu 2
b8154b678e Merge pull request \fI\%#33457\fP from rallytime/doc\-formatting
.INDENT 2.0
.IP \(bu 2
82f8f3efff Make doc formatting consistent and use correct versionadded
.UNINDENT
.IP \(bu 2
1dfa95651c Don\(aqt allow a \(dqrepo\(dq kwarg for pkgrepo.managed (\fI\%#33477\fP)
.IP \(bu 2
b4071b07f1 Allow for config entry to be a list in a dict for beacons (\fI\%#33476\fP)
.IP \(bu 2
9f56ab4c45 Merge pull request \fI\%#33469\fP from meaksh/zypper\-download\-check\-signature\-2015.8
.INDENT 2.0
.IP \(bu 2
a65071a6d1 simpler rpm.checksum function
.IP \(bu 2
80fe303e38 Renamed check_sig to checksum and some refactoring
.IP \(bu 2
d56e3f4258 bugfix: showing errors when a package download fails using zypper pkg.download
.IP \(bu 2
8a21b9149e check the signature of downloaded RPM files
.UNINDENT
.IP \(bu 2
00f9090928 Add docs about PyYAML\(aqs 1024 character limitations for simple keys (\fI\%#33459\fP)
.IP \(bu 2
3b12f396b4 Prevent several minion processes on the same machine (\fI\%#33464\fP)
.IP \(bu 2
c8b4f338d8 Make \-\-gpg\-auto\-import\-keys a global param when calling zypper (\fI\%#33432\fP)
.IP \(bu 2
0c4e38ced4 Fix the saltutil.wheel function and add integration tests  (\fI\%#33414\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33505\fP: (\fI\%twangboy\fP) Fix build script where pip didn\(aqt work
@ \fI2016\-05\-25 18:15:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
a43ffadcb7 Merge pull request \fI\%#33505\fP from twangboy/fix_build_script
.IP \(bu 2
7d78e5d612 Fix build script where pip wouldn\(aqt work
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33076\fP: (\fI\%cachedout\fP) Avoid second grains load on windows multiprocessing (refs: \fI\%#33656\fP)
@ \fI2016\-05\-25 17:10:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
4cf40da7d7 Merge pull request \fI\%#33076\fP from cachedout/win_grains
.IP \(bu 2
dab9825c88 Fix indentation error
.IP \(bu 2
b14e2cce9e Avoid second grains load on windows multiprocessing
.UNINDENT
.UNINDENT
.SS Salt 2016.3.2 Release Notes
.sp
Version 2016.3.2 is a bugfix release for \fI\%2016.3.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB200\fP
.IP \(bu 2
Total Issue References: \fB66\fP
.IP \(bu 2
Total PR References: \fB177\fP
.IP \(bu 2
Contributors: \fB52\fP (\fI\%Ch3LL\fP, \fI\%DarkKnightCZ\fP, \fI\%DmitryKuzmenko\fP, \fI\%Inveracity\fP, \fI\%abalashov\fP,
\fI\%abednarik\fP, \fI\%adelcast\fP, \fI\%ajacoutot\fP, \fI\%amendlik\fP, \fI\%anlutro\fP, \fI\%aphor\fP, \fI\%artxki\fP, \fI\%bbinet\fP,
\fI\%bensherman\fP, \fI\%cachedout\fP, \fI\%christoe\fP, \fI\%clinta\fP, \fI\%cro\fP, \fI\%dmurphy18\fP, \fI\%dongweiming\fP,
\fI\%eliasp\fP, \fI\%eradman\fP, \fI\%farcaller\fP, \fI\%garethgreenaway\fP, \fI\%glomium\fP, \fI\%gtmanfred\fP, \fI\%isbm\fP,
\fI\%jacobhammons\fP, \fI\%jacobweinstock\fP, \fI\%jfindlay\fP, \fI\%jmacfar\fP, \fI\%jnhmcknight\fP, \fI\%justinta\fP,
\fI\%l2ol33rt\fP, \fI\%lomeroe\fP, \fI\%meaksh\fP, \fI\%nulfox\fP, \fI\%opdude\fP, \fI\%peterdemin\fP, \fI\%rallytime\fP,
\fI\%s0undt3ch\fP, \fI\%secumod\fP, \fI\%sjmh\fP, \fI\%sjorge\fP, \fI\%terminalmage\fP, \fI\%thatch45\fP, \fI\%themalkolm\fP,
\fI\%ticosax\fP, \fI\%tmehlinger\fP, \fI\%twangboy\fP, \fI\%vutny\fP, \fI\%whiteinge\fP)
.UNINDENT
.SS Returner Changes
.INDENT 0.0
.IP \(bu 2
Any returner which implements a \fBsave_load\fP function is now required to
accept a \fBminions\fP keyword argument. All returners which ship with Salt
have been modified to do so.
.UNINDENT
.SS Changelog for v2016.3.1..v2016.3.2
.sp
\fIGenerated at: 2018\-05\-27 04:37:58 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#34988\fP: (\fI\%rallytime\fP) Update release notes with new changes
@ \fI2016\-07\-27 15:54:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
721e6dcce8 Merge pull request \fI\%#34988\fP from rallytime/release\-notes\-update
.IP \(bu 2
a2aae987a6 Update release notes with new changes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34946\fP: (\fI\%anlutro\fP) Fix virtualenv behavior when requirements files are in subdirectories
@ \fI2016\-07\-27 14:43:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
d63ac1671c Merge pull request \fI\%#34946\fP from alprs/fix\-venv_reqs_subdir
.IP \(bu 2
f773d63cbb normalize requirements path to be absolute
.IP \(bu 2
bdec73bb03 remove unnecessary os.path.basename logic
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34957\fP: (\fI\%sjmh\fP) Don\(aqt fall through to checking auth entries
@ \fI2016\-07\-26 22:16:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
f765faa3aa Merge pull request \fI\%#34957\fP from sjmh/2016.3
.IP \(bu 2
0095dbe530 Don\(aqt fall through to checking auth entries
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34971\fP: (\fI\%cachedout\fP) Increase timeout for grains test
@ \fI2016\-07\-26 22:11:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d3b95dec9 Merge pull request \fI\%#34971\fP from cachedout/increase_timeout_grains_test
.IP \(bu 2
82d271b43a Increase timeout for grains test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34873\fP: (\fI\%Cashwini\fP) Scheduler on master does not recognize the date strings supported by python dateutil (refs: \fI\%#34951\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34873\fP: (\fI\%Cashwini\fP) Scheduler on master does not recognize the date strings supported by python dateutil (refs: \fI\%#34951\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34951\fP: (\fI\%vutny\fP) Fix \fI\%#34873\fP
@ \fI2016\-07\-26 17:07:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
f23e8c525e Merge pull request \fI\%#34951\fP from vutny/fix\-schedule\-dateutil
.IP \(bu 2
0faa490991 Fix job scheduling using \fBwhen\fP parameter (by \fBpython\-dateutil\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34935\fP: (\fI\%rallytime\fP) Avoid UnboundLocalError in beacons module
@ \fI2016\-07\-26 17:01:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34894\fP: (\fI\%rallytime\fP) [develop] Merge forward from 2016.3 to develop (refs: \fI\%#34935\fP)
.IP \(bu 2
deb1331601 Merge pull request \fI\%#34935\fP from rallytime/beacons\-mod\-cleanup
.IP \(bu 2
97a36ef367 Avoid UnboundLocalError in beacons module
.IP \(bu 2
\fBPR\fP \fI\%#34956\fP: (\fI\%cachedout\fP) Increase all run_script timeouts to 30s
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34933\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-25 22:09:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
5d194f2d17 Merge pull request \fI\%#34933\fP from rallytime/merge\-2016.3
.IP \(bu 2
8b295fe4ea Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
ec8fc058d4 Master performance improvement (\fI\%#34916\fP)
.IP \(bu 2
34dc2fd792 Merge pull request \fI\%#34911\fP from cachedout/backport_34906
.INDENT 2.0
.IP \(bu 2
8becec2f4f Backport \fI\%#34906\fP
.UNINDENT
.IP \(bu 2
6ccc27f697 Merge pull request \fI\%#34898\fP from hrumph/list_upgrades_refresh
.INDENT 2.0
.IP \(bu 2
acd4b1a23b Fixes \fI\%#33620\fP
.UNINDENT
.IP \(bu 2
5c13ee0e72 Merge pull request \fI\%#34606\fP from isbm/isbm\-config\-reading\-exit\-2015.8
.INDENT 2.0
.IP \(bu 2
5f5b802c0c Add option to master config reader on ignoring system exit for wrong configuration
.IP \(bu 2
6fc677f177 Ignore minion config errors everywhere but the minion itself
.IP \(bu 2
8699194647 Remove deprecation: BaseException.message deprecated as of 2.6
.IP \(bu 2
0e65cfec91 Fix lint: E8302
.IP \(bu 2
67faa56bf1 Use Salt default exit codes instead of hard\-coded values
.IP \(bu 2
a84556e596 Exit immediately on configuration error
.IP \(bu 2
43d965907c Raise an exception on any found wrong configuration file
.IP \(bu 2
30ed728d05 Cover exception handling in the utils.parsers
.IP \(bu 2
5e8c0c6bdb Introduce configuration error exception
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34760\fP: (\fI\%nate\-byrnes\fP) XenServer 7 needs correct provider setup for services. (refs: \fI\%#34915\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34915\fP: (\fI\%abednarik\fP) Update service_rh provider to exclude XenServer >= 7.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34926\fP: (\fI\%rallytime\fP) Lint \fI\%#34923\fP
@ \fI2016\-07\-25 14:53:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34923\fP: (\fI\%eliasp\fP) Handle exception when no Slack API key was provided (refs: \fI\%#34926\fP)
.IP \(bu 2
a7e7ec6d25 Merge pull request \fI\%#34926\fP from rallytime/lint\-34923
.IP \(bu 2
b3514abf1b Lint fixes for \fI\%#34923\fP
.IP \(bu 2
69afcc4060 Handle exception when no Slack API key was provided
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34908\fP: (\fI\%Ch3LL\fP) Cannot start proxy minion due to keyerror in grains (refs: \fI\%#34910\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34910\fP: (\fI\%cachedout\fP) Fix grains error on proxy minions
@ \fI2016\-07\-22 23:05:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
c663c8bb5b Merge pull request \fI\%#34910\fP from cachedout/proxy_grains
.IP \(bu 2
0970ebace8 Fix grains error on proxy minions
.IP \(bu 2
\fBPR\fP \fI\%#34864\fP: (\fI\%jmacfar\fP) Check for version in list of installed versions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34816\fP: (\fI\%msdogado\fP) VirtuozzoLinux not realized as RedHat by pkg (refs: #\(gasaltstack/salt\(ga#34878\(ga_\(ga_, \fI\%#34878\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#34878\fP: (\fI\%abednarik\fP) Add VirtuozzoLinux is yumpkg enable list. (refs: \fI\%#34902\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34902\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34878\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#34878\fP: (\fI\%abednarik\fP) Add VirtuozzoLinux is yumpkg enable list. (refs: \fI\%#34902\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34893\fP: (\fI\%msdogado\fP) rpm VirtuozzoLinux not working (refs: \fI\%#34901\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34901\fP: (\fI\%rallytime\fP) Add VirtuozzoLinux to the list of enabled distros for rpm.py
@ \fI2016\-07\-22 22:23:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
ad640cc046 Merge pull request \fI\%#34901\fP from rallytime/fix\-34893
.IP \(bu 2
45e2ce10a4 Add VirtuozzoLinux to the list of enabled distros for rpm.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34890\fP: (\fI\%msdogado\fP) VirtuozzoLinux enabling services not working (refs: \fI\%#34900\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34900\fP: (\fI\%rallytime\fP) Add VirtuozzoLinux to enabled platforms list in rh_service.py
@ \fI2016\-07\-22 22:21:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
5aa532f98b Merge pull request \fI\%#34900\fP from rallytime/fix\-34890
.IP \(bu 2
12824487cc Add VirtuozzoLinux to enabled platforms list in rh_service.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34887\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-22 18:04:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
ebebfa647f Merge pull request \fI\%#34887\fP from rallytime/merge\-2016.3
.IP \(bu 2
109b368d19 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
fb223e1bd4 Invalidate the target cache very quickly (\fI\%#34862\fP)
.IP \(bu 2
1ca1367289 Fail git.latest states with uncomitted changes when force_reset=False (\fI\%#34869\fP)
.IP \(bu 2
4f4381e5b9 Merge pull request \fI\%#34859\fP from cachedout/fix_wheel_test
.INDENT 2.0
.IP \(bu 2
b4be66dedf Fix wheel test
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34632\fP: (\fI\%eliasp\fP) Try to create the log directory when not present yet
@ \fI2016\-07\-22 17:34:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
eba34f7f4c Merge pull request \fI\%#34632\fP from eliasp/2016.3\-create\-logdir\-when\-needed
.IP \(bu 2
9c89470661 Try to create the log directory when not present yet
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34854\fP: (\fI\%rallytime\fP) Remove string_types import from state compiler
@ \fI2016\-07\-22 17:20:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
965f517889 Merge pull request \fI\%#34854\fP from rallytime/cleanup\-state\-imports
.IP \(bu 2
73d3075ce9 Remove string_types import from state compiler
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#26171\fP: (\fI\%HG00\fP) salt\-ssh from python2.6 master to python2.7 minion fails on \(dqfrom _elementtree import *\(dq (refs: \fI\%#34865\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34865\fP: (\fI\%thatch45\fP) This needs discussion, since this breaks SUSE
@ \fI2016\-07\-22 17:19:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
584d7606d4 Merge pull request \fI\%#34865\fP from thatch45/break_suse
.IP \(bu 2
6c5f363921 This needs discussion, since this breaks SUSE
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34858\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-21 21:01:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
aaede31f66 Merge pull request \fI\%#34858\fP from rallytime/merge\-2016.3
.IP \(bu 2
9227c3dd26 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
acc9e31c02 Merge pull request \fI\%#34822\fP from thatch45/ssh_fixes
.INDENT 2.0
.IP \(bu 2
b5de492143 fix \fI\%#34798\fP
.IP \(bu 2
5ad6bd7307 fix \fI\%#34796\fP
.UNINDENT
.IP \(bu 2
5d91139bc9 Merge pull request \fI\%#34847\fP from cachedout/pwall
.INDENT 2.0
.IP \(bu 2
2c8298dc6e Profile logging
.IP \(bu 2
3affafa2e9 Add an option to skip the verification of client_acl users
.UNINDENT
.IP \(bu 2
07d1d36653 Merge pull request \fI\%#34827\fP from thatch45/34691
.INDENT 2.0
.IP \(bu 2
1ccf35eca4 fix beacon list to include all beacons being processed
.UNINDENT
.IP \(bu 2
b375720251 Merge pull request \fI\%#34833\fP from rallytime/bp\-28521
.INDENT 2.0
.IP \(bu 2
e50a6783ce SPM: packaging doesn\(aqt work in Python 2.6. Fixed.
.UNINDENT
.IP \(bu 2
042646582f Merge pull request \fI\%#34823\fP from rallytime/bp\-25276
.INDENT 2.0
.IP \(bu 2
a028796eff copy spm.1 man page during setup Refs \fI\%#25213\fP
.UNINDENT
.IP \(bu 2
6c35d88268 Fix \fI\%#34648\fP (\fI\%#34828\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34852\fP: (\fI\%rallytime\fP) Skip GCE unit tests \- causes test suite to hang
@ \fI2016\-07\-21 17:52:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
b3d8143d36 Merge pull request \fI\%#34852\fP from rallytime/skip\-gce\-tests
.IP \(bu 2
15b4f5a8b3 Skip GCE unit tests \- causes test suite to hang
.IP \(bu 2
\fBPR\fP \fI\%#34850\fP: (\fI\%rallytime\fP) Update 2016.3.2 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34215\fP: (\fI\%rvora\fP) salt\-master crashes every few days (refs: \fI\%#34683\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34844\fP: (\fI\%vutny\fP) Fix getting total available memory without \fIpsutil\fP installed
@ \fI2016\-07\-21 17:12:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34683\fP: (\fI\%cachedout\fP) Fix publisher leak (refs: \fI\%#34844\fP)
.IP \(bu 2
650674d14a Merge pull request \fI\%#34844\fP from vutny/fix\-grains\-load\-in\-config\-init
.IP \(bu 2
4dc7827020 Fix comment in master config, prevents the service from starting
.IP \(bu 2
b4cfebb107 Fix Salt failure after merge of \fI\%#34683\fP
.IP \(bu 2
\fBPR\fP \fI\%#34848\fP: (\fI\%rallytime\fP) Update release notes for 2016.3.2
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34345\fP: (\fI\%edgan\fP) Salt master mode\(aqs and salt\-ssh mode\(aqs top.sls processing aren\(aqt the same (refs: \fI\%#34837\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34345\fP: (\fI\%edgan\fP) Salt master mode\(aqs and salt\-ssh mode\(aqs top.sls processing aren\(aqt the same (refs: \fI\%#34837\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34837\fP: (\fI\%thatch45\fP) Fix \fI\%#34345\fP
@ \fI2016\-07\-21 14:36:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
52a95b2ea3 Merge pull request \fI\%#34837\fP from thatch45/34345
.IP \(bu 2
1e8c585cd3 Fix \fI\%#34345\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#32591\fP: (\fI\%AndrewPashkin\fP) \(dqRuntimeError: maximum recursion depth exceeded\(dq in salt/utils/lazy.py, using Salt\-SSH (refs: \fI\%#34838\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34838\fP: (\fI\%thatch45\fP) Check if a valid value is passed to unlyif/unless
@ \fI2016\-07\-21 14:34:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
96450ac74d Merge pull request \fI\%#34838\fP from thatch45/unless_valid
.IP \(bu 2
1f34299a84 Check if a valid value is passed to unlyif/unless
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#32525\fP: (\fI\%anlutro\fP) state.show_low_sls not working in salt\-ssh (refs: \fI\%#34840\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34840\fP: (\fI\%thatch45\fP) update the state wrapper to include show_low_sls
@ \fI2016\-07\-21 14:34:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a5ef86d58 Merge pull request \fI\%#34840\fP from thatch45/state_update_ssh
.IP \(bu 2
77dce3920c update the state wrapper to include show_low_sls
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34762\fP: (\fI\%aphor\fP) zpool state module needs support for disk vdev (refs: \fI\%#34791\fP, \fI\%#34770\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34842\fP: (\fI\%sjorge\fP) 2016.3 zpool cleanup and fixes
@ \fI2016\-07\-21 14:32:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34770\fP: (\fI\%aphor\fP) zpool state module needs support for disk vdev \fI\%#34762\fP (refs: \fI\%#34842\fP)
.IP \(bu 2
5f67318fd7 Merge pull request \fI\%#34842\fP from sjorge/2016.3\-zpool\-simplifaction
.IP \(bu 2
a7ff9524b0 drop parsing of vdevs, error passthrough from zpool cli
.IP \(bu 2
25d6c8139b eliminate hardcoded vdev type from zpool state
.IP \(bu 2
47b8dc946c salt.states.zpool \- work with updates exec module
.IP \(bu 2
a5a98845c7 salt.module.zpool \- fix bug with properties on/off being parsed as true/false
.IP \(bu 2
dd64494a19 salt.modules.zpool \- drop vdev types to make it more future proof, fallback to zpool cli error messages
.IP \(bu 2
\fBPR\fP \fI\%#34825\fP: (\fI\%thatch45\fP) keep this beacon from stack tracing at the loader
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34824\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-20 20:54:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
b9db0b0036 Merge pull request \fI\%#34824\fP from rallytime/merge\-2016.3
.IP \(bu 2
094731f4b6 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
98fa4a404e Merge pull request \fI\%#34818\fP from jtand/mysql_state_integration_test_cleanup
.INDENT 2.0
.IP \(bu 2
9abb6f91bb Skip mysql state test if mysqladmin is not available
.UNINDENT
.IP \(bu 2
6636f2b449 Merge pull request \fI\%#34803\fP from junovitch/issue_24744
.INDENT 2.0
.IP \(bu 2
64c850410f salt/state.py: set \(aqchunk[\(aqorder\(aq] = 0\(aq with \(aqorder: first\(aq; fixes \fI\%#24744\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34670\fP: (\fI\%isbm\fP) Add \(dqosmajorrelease\(dq grain (2016.3)
@ \fI2016\-07\-20 14:39:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
62ef8fdb35 Merge pull request \fI\%#34670\fP from isbm/isbm\-osmajorrelease\-grain\-suse
.IP \(bu 2
a6bcbd615f Lintfix PEP8: E262
.IP \(bu 2
110a422d5a Keep osmajorrelease as a string type for 2016.3 release
.IP \(bu 2
208fd33b48 Add unit test for osmajorrelease grain
.IP \(bu 2
9a6b2175c6 Implement \(dqosmajorrelease\(dq by killing spaghetti
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34215\fP: (\fI\%rvora\fP) salt\-master crashes every few days (refs: \fI\%#34683\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34683\fP: (\fI\%cachedout\fP) Fix publisher leak (refs: \fI\%#34844\fP)
@ \fI2016\-07\-20 13:57:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
6ca9ffa7c7 Merge pull request \fI\%#34683\fP from cachedout/issue_34215
.IP \(bu 2
ccd53e9214 Lint
.IP \(bu 2
76eb46fb08 Document master setting
.IP \(bu 2
0dfe3aaf31 Set up dynamic config
.IP \(bu 2
3cfb82cdd4 Fix silly error
.IP \(bu 2
35a845fff5 Only set IPC with write buffer if set
.IP \(bu 2
b2d636017d Add IPC to minion opts
.IP \(bu 2
2c1c92c48e Lint
.IP \(bu 2
c4395ae84e Dial down default buffer and apply to just write buffer
.IP \(bu 2
3e3e2a997e Typo
.IP \(bu 2
78f6251c09 Correct issues with config
.IP \(bu 2
c138cc03e3 Configuration settings for IPC buffers
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34762\fP: (\fI\%aphor\fP) zpool state module needs support for disk vdev (refs: \fI\%#34791\fP, \fI\%#34770\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34791\fP: (\fI\%sjorge\fP) salt.state.zpool tweaks
@ \fI2016\-07\-19 20:56:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
49ab3fd2b5 Merge pull request \fI\%#34791\fP from sjorge/zpool\-state\-tweaks
.IP \(bu 2
d48c6d2dcb accomidate use of \(dqfake\(dq vdev type disk, this behavior may be broken later if a disk vdev ever gets added to the cli tools. improve documentation explaining how to create a striped pool without the \(dqfake\(dq vdev type
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34784\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-19 16:30:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
1617a7058a Merge pull request \fI\%#34784\fP from rallytime/merge\-2016.3
.IP \(bu 2
3e032dc397 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
58021035a9 Merge pull request \fI\%#34773\fP from randomed/mysql\-returner\-startup/2015.8
.INDENT 2.0
.IP \(bu 2
0cd55eb7d7 Add jid=req handling for mysql returner. It should also store the return jid into the jid list table.
.UNINDENT
.IP \(bu 2
10a1af9949 Remove unnedeed config test (\fI\%#34751\fP)
.IP \(bu 2
f19caac8e4 Merge pull request \fI\%#34754\fP from cachedout/disable_mid_test
.INDENT 2.0
.IP \(bu 2
46901c6e65 Disable test
.UNINDENT
.IP \(bu 2
81f29006f2 Merge pull request \fI\%#34741\fP from rallytime/bp\-34726
.INDENT 2.0
.IP \(bu 2
d949110993  Loop over updated keys in non recursive update
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34630\fP: (\fI\%bdrung\fP) Spelling errors (refs: \fI\%#34756\fP, \fI\%#34722\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#33923\fP: (\fI\%pavankumar2203\fP) Salt module certutil install doesn\(aqt work (refs: \fI\%#34756\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34756\fP: (\fI\%jacobhammons\fP) Rebuild man pages
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#27980\fP: (\fI\%rayba\fP) salt\-cloud 2015.5.0 azure provider could not be loaded (refs: \fI\%#34746\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34746\fP: (\fI\%rallytime\fP) Update azure lib dep to match the one in cloud.clouds.msazure
@ \fI2016\-07\-18 18:54:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
2a9738f00d Merge pull request \fI\%#34746\fP from rallytime/azure\-version
.IP \(bu 2
ead3eb1606 Update azure lib dep to match the one in cloud.clouds.msazure
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34744\fP: (\fI\%justinta\fP) Test valid docs fix
@ \fI2016\-07\-18 18:22:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
c0e2657c8e Merge pull request \fI\%#34744\fP from jtand/test_valid_docs_fix
.IP \(bu 2
4fe33a7695 add directives example to ldap3.modify
.IP \(bu 2
6fa40a0d46 Add cli examples for ldap3 module
.IP \(bu 2
b94e0dd95a ipset.long_range doesn\(aqt need a docstring
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34740\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-18 16:28:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
d4adf98b85 Merge pull request \fI\%#34740\fP from rallytime/merge\-2016.3
.IP \(bu 2
7d106c78f0 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
e9e5bbe38b Merge pull request \fI\%#34721\fP from rallytime/fix\-34703
.INDENT 2.0
.IP \(bu 2
9c803d05a5 Add output_file option to master config docs
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34607\fP: (\fI\%isbm\fP) Bugfix: Exit on configuration read (backport)
@ \fI2016\-07\-18 15:15:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
efc7599f85 Merge pull request \fI\%#34607\fP from isbm/isbm\-config\-reading\-exit\-2016.3
.IP \(bu 2
fb7542f920 Add option to master config reader on ignoring system exit for wrong configuration
.IP \(bu 2
abd10b5782 Ignore minion config errors everywhere but the minion itself
.IP \(bu 2
e5f43e6711 Remove deprecation: BaseException.message deprecated as of 2.6
.IP \(bu 2
23d1031a09 Fix lint: E8302
.IP \(bu 2
6b660678fa Use Salt default exit codes instead of hard\-coded values
.IP \(bu 2
0c2d3511c9 Exit immediately on configuration error
.IP \(bu 2
c5de6c8c4a Raise an exception on any found wrong configuration file
.IP \(bu 2
575767022b Cover exception handling in the utils.parsers
.IP \(bu 2
2cf696671f Introduce configuration error exception
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#34607\fP: (\fI\%isbm\fP) Bugfix: Exit on configuration read (backport) (refs: \fI\%#34739\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34739\fP: (\fI\%cachedout\fP) Remove unnedeed config test
@ \fI2016\-07\-18 15:15:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0e0c0186b Merge pull request \fI\%#34739\fP from cachedout/remove_config_test
.IP \(bu 2
4625ee65b8 Remove unnedeed config test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34630\fP: (\fI\%bdrung\fP) Spelling errors (refs: \fI\%#34756\fP, \fI\%#34722\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34722\fP: (\fI\%rallytime\fP) Various spelling fixes
@ \fI2016\-07\-16 19:49:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
abf5b976ed Merge pull request \fI\%#34722\fP from rallytime/fix\-34630
.IP \(bu 2
cca9446c37 Various spelling fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34714\fP: (\fI\%sjmh\fP) Fix ldap auth for function matches
@ \fI2016\-07\-16 19:49:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
922cc5a8a7 Merge pull request \fI\%#34714\fP from sjmh/fix/ldap_auth
.IP \(bu 2
d4144039bc Fix ldap auth for function matches
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34720\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-16 19:22:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
40626d786a Merge pull request \fI\%#34720\fP from rallytime/merge\-2016.3
.IP \(bu 2
c2130d5a04 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
08d00f3a61 Merge pull request \fI\%#34689\fP from Azidburn/fix_pkg_sources
.INDENT 2.0
.IP \(bu 2
2c0fc919b3 fix second run problems with pkg.installed using sources
.UNINDENT
.IP \(bu 2
4cb1ded520 Merge pull request \fI\%#34695\fP from isbm/isbm\-zypper\-product\-boolean\-values
.INDENT 2.0
.IP \(bu 2
5ed5142fbc Update test data for \(aqregisterrelease\(aq and \(aqproductline\(aq fields
.IP \(bu 2
21444ee240 Bugfix: return boolean only for \(aqisbase\(aq and \(aqinstalled\(aq attributes
.UNINDENT
.IP \(bu 2
aaa6f7d80a update 2015.8.11 release notes (\fI\%#34682\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34661\fP: (\fI\%chrimi\fP) Cron State documentation lacks information of \(dqNew in\(dq for special parameter in cron.present (refs: \fI\%#34707\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34707\fP: (\fI\%rallytime\fP) Add versionadded to \(dqspecial\(dq option in cron.present state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34696\fP: (\fI\%isbm\fP) Bugfix: Zypper \fIpkg.list_products\fP returns False on some empty values (2016.3)
@ \fI2016\-07\-15 21:18:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
51fce770a5 Merge pull request \fI\%#34696\fP from isbm/isbm\-zypper\-product\-boolean\-values\-2016.3
.IP \(bu 2
96021e257c Update test data for \(aqregisterrelease\(aq and \(aqproductline\(aq fields
.IP \(bu 2
337eee33ac Bugfix: return boolean only for \(aqisbase\(aq and \(aqinstalled\(aq attributes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34702\fP: (\fI\%farcaller\fP) Fixed dockerng.list_tags
@ \fI2016\-07\-15 20:50:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
45045f6900 Merge pull request \fI\%#34702\fP from farcaller/fixtags
.IP \(bu 2
032e35a28e Fixed dockerng.list_tags
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34548\fP: (\fI\%Inveracity\fP) win_dsc.set_lcm_config does not set multiple values, missing semicolon (refs: \fI\%#34549\fP, #saltstack/salt\(ga#34549\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#34549\fP: (\fI\%Inveracity\fP) fixes multiple values in mof configuration (refs: \fI\%#34681\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34681\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34549\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#34549\fP: (\fI\%Inveracity\fP) fixes multiple values in mof configuration (refs: \fI\%#34681\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34679\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-14 20:59:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
d57507dde8 Merge pull request \fI\%#34679\fP from rallytime/merge\-2016.3
.IP \(bu 2
0c566dce89 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
3192e1674b Merge pull request \fI\%#34676\fP from cachedout/partial_revert_34644
.INDENT 2.0
.IP \(bu 2
64a154826a Revert \(dqModify lodaer global test to use populated dunders\(dq
.UNINDENT
.IP \(bu 2
3b6f1089b2 Merge pull request \fI\%#34601\fP from lorengordon/clarify\-doc
.INDENT 2.0
.IP \(bu 2
bfe0dd0b8a Clarifies the proper way to reference states
.UNINDENT
.IP \(bu 2
bc63f25a6f Lint 34644 (\fI\%#34651\fP)
.IP \(bu 2
50360263c5 Adjust the mine test a little bit to give it a better chance of success (\fI\%#34647\fP)
.IP \(bu 2
8a0209101e Merge pull request \fI\%#34642\fP from jtand/mysql_integration_cleanup
.INDENT 2.0
.IP \(bu 2
dd1559a599 Check that mysqladmin exists before running mysql integration tests.
.UNINDENT
.IP \(bu 2
3e612c3794 Merge pull request \fI\%#34618\fP from jtand/network_integration_fix
.INDENT 2.0
.IP \(bu 2
34bcf9ccfc Changed network state test to use test=True
.IP \(bu 2
b2616833b0 Some small changes
.IP \(bu 2
ed59113e94 Change network state integration test to use test=True
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#33452\fP: (\fI\%Ch3LL\fP) Digital Ocean does not return anything on deletion (refs: \fI\%#34605\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34605\fP: (\fI\%gtmanfred\fP) catch error if no dns domains exist
@ \fI2016\-07\-14 15:20:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
b88c39e1d2 Merge pull request \fI\%#34605\fP from gtmanfred/2016.3
.IP \(bu 2
37b0943539 catch error if no dns domains exist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34557\fP: (\fI\%jacobweinstock\fP) handle jboss cli expression type in the parsing of output
@ \fI2016\-07\-14 15:09:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
b3dc6031fe Merge pull request \fI\%#34557\fP from jacobweinstock/jboss7_cli\-handle\-expression\-type
.IP \(bu 2
1945153399 handle jboss cli expression type in the parsing of the output
.IP \(bu 2
\fBPR\fP \fI\%#34652\fP: (\fI\%rallytime\fP) Spelling fixes found in sqlite3 pillar docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34382\fP: (\fI\%amontalban\fP) Exception: unsupported operand type(s) for \-: \(aqstr\(aq and \(aqint\(aq (refs: \fI\%#34565\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34554\fP: (\fI\%stjack99\fP) num_cpus grain missing with Salt 2016.3.1 on FreeBSD 10.x (refs: \fI\%#34565\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34565\fP: (\fI\%Ch3LL\fP) add num_cpus grain to freebsd
.IP \(bu 2
\fBPR\fP \fI\%#34621\fP: (\fI\%justinta\fP) Suse Leap doesn\(aqt have \(aqman\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34619\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-12 21:52:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
61f5045a0d Merge pull request \fI\%#34619\fP from rallytime/merge\-2016.3
.IP \(bu 2
f734afd0b0 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
9f123543e5 Merge pull request \fI\%#34617\fP from rallytime/merge\-2015.8
.INDENT 2.0
.IP \(bu 2
3026df346f Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
57df38e685 Update github IP for ssh state integration tests (\fI\%#34592\fP)
.IP \(bu 2
2e1007254b Avoid circular imports when calling salt.utils functions (\fI\%#34584\fP)
.UNINDENT
.IP \(bu 2
b90ae407f9 Add support for edge case when Cmd and Entrypoint can\(aqt be blanked (\fI\%#34593\fP)
.IP \(bu 2
12b579c4e3 When sorting list actual_data, make it a list (\fI\%#34590\fP)
.IP \(bu 2
7dd8035c62 Gate docker unit test to check for docker (\fI\%#34591\fP)
.IP \(bu 2
ae38c874da Add a bunch of documentation on getting files from other environments (\fI\%#34560\fP)
.IP \(bu 2
91e0656d44 Merge pull request \fI\%#34531\fP from terminalmage/issue34397
.INDENT 2.0
.IP \(bu 2
d0fec1b8f6 salt/modules/zypper.py: accept ignore_epoch argument
.IP \(bu 2
5ae9463c1f salt/modules/yumpkg.py: accept ignore_epoch argument
.IP \(bu 2
c2791117af salt/modules/rpm.py: accept ignore_epoch argument
.IP \(bu 2
c5de8b880d salt/modules/ebuild.py: accept ignore_epoch argument
.IP \(bu 2
4ee8e8f037 salt/modules/aptpkg.py: accept ignore_epoch argument
.IP \(bu 2
5b123b403c Pass ignore_epoch to salt.utils.compare_versions()
.IP \(bu 2
07368fac40 Accept ignore_epoch argument for salt.utils.compare_versions()
.UNINDENT
.IP \(bu 2
e99befad47 Merge pull request \fI\%#34545\fP from terminalmage/docker\-exec\-driver
.INDENT 2.0
.IP \(bu 2
dd5838e242 Handle cases where Docker Remote API returns an empty ExecutionDriver
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34585\fP: (\fI\%rallytime\fP) [2016.3] Avoid salt.utils circular imports when using \(dqfrom\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34616\fP: (\fI\%jacobhammons\fP) Adds a mock required for the network settings beacon
@ \fI2016\-07\-12 19:09:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
c8bdfb272d Merge pull request \fI\%#34616\fP from jacobhammons/network\-settings\-mock
.IP \(bu 2
5e2ddb5eb0 Adds a mock required for the network settings beacon
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34553\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-11 19:36:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
d8c8b4ac6f Merge pull request \fI\%#34553\fP from rallytime/merge\-2016.3
.IP \(bu 2
815c8b38d5 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
7120d43df0 Merge pull request \fI\%#34546\fP from rallytime/rename\-boto\-secgroup\-test
.INDENT 2.0
.IP \(bu 2
f8a3622be7 Rename unit.states.boto_secgroup to unit.states.boto_secgroup_test
.UNINDENT
.IP \(bu 2
ca92061821 Merge pull request \fI\%#34537\fP from rallytime/rename\-simple\-test
.INDENT 2.0
.IP \(bu 2
ceefb6e34c Rename tests.unit.simple to tests.unit.simple_test
.UNINDENT
.IP \(bu 2
fbab2f8c2b [2015.8] Update bootstrap script to latest stable (\fI\%#34527\fP)
.IP \(bu 2
6b8c76af83 Prevent many errors in the test suite in loader tests (\fI\%#34521\fP)
.IP \(bu 2
c2f296c95b Fix wrong order of retention_policy_exists (\fI\%#34507\fP)
.IP \(bu 2
685df80929 Merge pull request \fI\%#34518\fP from terminalmage/fix\-pkg.latest\-test
.INDENT 2.0
.IP \(bu 2
4aef44ecdf Fix pkg.latest integration test for non\-LTS ubuntu
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34569\fP: (\fI\%eliasp\fP) Minor doc fixes for PostgreSQL states
@ \fI2016\-07\-11 14:02:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b002e11b4 Merge pull request \fI\%#34569\fP from eliasp/2016.3\-postgres\-doc
.IP \(bu 2
221da29ef5 Typo (\fIdefaul\fP → \fIdefault\fP)
.IP \(bu 2
ba3d7c624b Add code formatting
.IP \(bu 2
b3409c97a2 Fix typo (\fIseens\fP → \fIseen\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34524\fP: (\fI\%terminalmage\fP) yumpkg: Avoid spurious logging in pkg.upgrade
@ \fI2016\-07\-07 22:06:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
7e1abd77ba Merge pull request \fI\%#34524\fP from terminalmage/yumpkg\-upgrade\-logging
.IP \(bu 2
40992f0790 yumpkg: Avoid spurious logging in pkg.upgrade
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34439\fP: (\fI\%edgan\fP) Fast memory leak on ctrl\-c out of  salt \(aq*\(aq state.highstate (refs: \fI\%#34490\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34490\fP: (\fI\%cachedout\fP) Fix master crash on ctl\-c for long\-running job
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34520\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-07 19:22:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
b9e87620f5 Merge pull request \fI\%#34520\fP from rallytime/merge\-2016.3
.IP \(bu 2
27988dde48 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
a516f116d1 Merge pull request \fI\%#34513\fP from cachedout/lower_loader_log
.INDENT 2.0
.IP \(bu 2
733c5d00c0 Lower the log level for modules which cannot be loaded to trace
.UNINDENT
.IP \(bu 2
63f0451041 Merge pull request \fI\%#34498\fP from rallytime/bootstrap\-tutorial\-doc\-fix
.INDENT 2.0
.IP \(bu 2
23c5739c3b Use \-O in wget develop example in bootstrap tutorial
.UNINDENT
.IP \(bu 2
3ebba020b6 Rename some unit test files by adding _test (\fI\%#34503\fP)
.IP \(bu 2
8722257b82 Improve top file merging documentation (\fI\%#34505\fP)
.IP \(bu 2
6ce7cb9616 Gracefully handle non\-XML output in GlusterFS execution module. (\fI\%#34492\fP)
.IP \(bu 2
75299456be Use skipTest for network state integration test (\fI\%#34489\fP)
.IP \(bu 2
0f3f87fbc5 Update dnsmasq.get_config docs to use correct config_file param. (\fI\%#34488\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34224\fP: (\fI\%tehsu\fP) salt\-cloud to rackspace uses public ip instead of private (refs: \fI\%#34499\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34499\fP: (\fI\%gtmanfred\fP) remove unnecessary block parsing ip addrs for nova
@ \fI2016\-07\-07 16:23:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
58f46eae15 Merge pull request \fI\%#34499\fP from gtmanfred/2016.3
.IP \(bu 2
019671d4c2 remove unnecessary block parsing ip addrs for nova
.IP \(bu 2
\fBPR\fP \fI\%#34468\fP: (\fI\%twangboy\fP) Use Python 2.7.12 for Windows Build
.IP \(bu 2
\fBPR\fP \fI\%#34493\fP: (\fI\%twangboy\fP) Use Python 2.7.12 for Mac Build
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34486\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-06 17:28:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
95094c73ff Merge pull request \fI\%#34486\fP from rallytime/merge\-2016.3
.IP \(bu 2
2b307b7ea1 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
e2f576e847 Merge pull request \fI\%#34462\fP from terminalmage/git\-describe\-always
.INDENT 2.0
.IP \(bu 2
6ef7ee198e Restrict use of \-\-always to git 1.5.6 and newer
.IP \(bu 2
c554b22fc8 modules/git: added \-\-always parameter for git.describe().
.UNINDENT
.IP \(bu 2
85f1f18239 Merge pull request \fI\%#34467\fP from rallytime/bp\-34457
.INDENT 2.0
.IP \(bu 2
746883741f Only access key metadata if we found key metadata
.UNINDENT
.IP \(bu 2
9e15337b74 Merge pull request \fI\%#34432\fP from twangboy/fix_file.append
.INDENT 2.0
.IP \(bu 2
13f11fddce Remove refactoring code
.IP \(bu 2
78f7c530bb Remove unit tests, integration tests written
.IP \(bu 2
b83392edea Remove len() in favor of boolean test
.IP \(bu 2
4373408163 Fix line error
.IP \(bu 2
2479b53e2f Fix erroneous report on newline code
.IP \(bu 2
75b6ed1fd5 Change back to binary read
.IP \(bu 2
65753cff6d Use os.linesep instead of n
.IP \(bu 2
a55d63f086 Fix object names
.IP \(bu 2
3e2fe12e5e Add new line if missing
.IP \(bu 2
0b7821c8db Fix file.append state
.UNINDENT
.IP \(bu 2
91e095bb41 Merge pull request \fI\%#34429\fP from terminalmage/pkg\-latest\-versioncheck
.INDENT 2.0
.IP \(bu 2
667f31a72a Skip version checking for targeted packages in pkg.latest state
.UNINDENT
.IP \(bu 2
0a264597ca Forgot reference to inotify (\fI\%#34455\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33915\fP: (\fI\%mattglv\fP) Orchestration runner output on Success vs Failures in 2016.3.0 (refs: \fI\%#34459\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34459\fP: (\fI\%terminalmage\fP) Ignore retcode when formatting highstate output
@ \fI2016\-07\-06 03:59:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
7867d49193 Merge pull request \fI\%#34459\fP from terminalmage/issue33915
.IP \(bu 2
82a70e015f Ignore retcode when formatting highstate output
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34371\fP: (\fI\%erikgrinaker\fP) git.detached does not work with commit ID as ref (refs: \fI\%#34463\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34463\fP: (\fI\%terminalmage\fP) states/git: pass required cwd parameter to git.describe.
@ \fI2016\-07\-06 03:59:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
ae6902290a Merge pull request \fI\%#34463\fP from terminalmage/issue34371
.IP \(bu 2
f981a5646a states/git: pass required cwd parameter to git.describe.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34395\fP: (\fI\%artxki\fP) Nonfunctioning default_password in states.postgres_user.present (refs: \fI\%#34436\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34466\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34436\fP to 2016.3
@ \fI2016\-07\-06 03:57:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34436\fP: (\fI\%artxki\fP) Fix \fI\%#34395\fP Nonfunctional default_password in states.postgres_user.present (refs: \fI\%#34466\fP)
.IP \(bu 2
8f8a6d2f68 Merge pull request \fI\%#34466\fP from rallytime/bp\-34436
.IP \(bu 2
e97c00b018 Fix \fI\%#34395\fP Nonfunctional default_password in states.postgres_user.present
.IP \(bu 2
\fBPR\fP \fI\%#34453\fP: (\fI\%justinta\fP) Arch linux does not have osrelease or osmajorrelease grains
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33697\fP: (\fI\%asloboda\-cisco\fP) Client clash with Tornado IOLoop (refs: \fI\%#34456\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34456\fP: (\fI\%thatch45\fP) Be more careful when making the SMinion
@ \fI2016\-07\-05 18:41:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc67a4e216 Merge pull request \fI\%#34456\fP from thatch45/2016.3
.IP \(bu 2
edd6b95c60 we need to be more careful when making the SMinion
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34452\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-05 17:49:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
72b4d6b52c Merge pull request \fI\%#34452\fP from rallytime/merge\-2016.3
.IP \(bu 2
91120dba01 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
7bb0868c66 Merge pull request \fI\%#34451\fP from rallytime/merge\-2015.8
.INDENT 2.0
.IP \(bu 2
55a91e22be Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
8c72ee56e4 Merge pull request \fI\%#34435\fP from cachedout/backport_config_dir_integration
.INDENT 2.0
.IP \(bu 2
0e2c71a537 Backport change to integraiton test suite
.UNINDENT
.UNINDENT
.IP \(bu 2
e65d1ae374 Merge pull request \fI\%#34401\fP from terminalmage/rpm\-version_cmp
.INDENT 2.0
.IP \(bu 2
7cefd4182d Use rpmdev\-vercmp as a fallback for version comparison on RHEL5
.UNINDENT
.IP \(bu 2
5ddf417432 Merge pull request \fI\%#34366\fP from steverweber/fix_servicerestart
.INDENT 2.0
.IP \(bu 2
7847c39024 Update service.py
.UNINDENT
.IP \(bu 2
485454febb Merge pull request \fI\%#34426\fP from cro/inotify\-linux\-only
.INDENT 2.0
.IP \(bu 2
54a02f25ba Document that inotify is Linux only
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34427\fP: (\fI\%twangboy\fP) Automated signing fixes for Ubuntu 16.04, 14.04, 12.04 (for dmurphy)
@ \fI2016\-07\-05 15:18:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
7508d291d2 Merge pull request \fI\%#34427\fP from twangboy/sign_fx
.IP \(bu 2
c804480982 Add changes suggested by @cachedout
.IP \(bu 2
494deda074 Automated signing fixes for Ubuntu 16.04, 14.04, 12.04
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34379\fP: (\fI\%UtahDave\fP) variable referenced before assignment (refs: \fI\%#34400\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34400\fP: (\fI\%cachedout\fP) Fix uninitialized value
@ \fI2016\-07\-01 17:42:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
b3875f397d Merge pull request \fI\%#34400\fP from cachedout/issue_34379
.IP \(bu 2
b413f05a4f Fix uninitialized value
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34404\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-01 15:02:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
d1cd36ab2b Merge pull request \fI\%#34404\fP from rallytime/merge\-2016.3
.IP \(bu 2
8398de0baf Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
fe18bbb527 Merge pull request \fI\%#34392\fP from cro/salt\-cloud\-doc\-clarify
.INDENT 2.0
.IP \(bu 2
6cce575d40 Clarify that salt\-cloud doesn\(aqt get installed by bootstrap
.UNINDENT
.IP \(bu 2
45b8fb10d7 Merge pull request \fI\%#34373\fP from jtand/network_state_integration_test
.INDENT 2.0
.IP \(bu 2
1d24053e36 network.system sls file
.IP \(bu 2
4a9e6af542 network.routes sls file
.IP \(bu 2
76c90b2ef6 network.managed sls file
.IP \(bu 2
84a36369fa Added network state integration test
.UNINDENT
.IP \(bu 2
d6af1de0b7 Optimize pkg integration tests and add a couple new tests (\fI\%#34377\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34292\fP: (\fI\%twangboy\fP) Fix runas function for System Account
@ \fI2016\-06\-30 18:25:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
ad63b1d3d3 Merge pull request \fI\%#34292\fP from twangboy/fix_runas
.IP \(bu 2
433f300eba Enable all privileges
.IP \(bu 2
5584cc2c6f Handle users that aren\(aqt admin
.IP \(bu 2
e9d2402c0b Fix runas function for System Account
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34388\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34378\fP to 2016.3
@ \fI2016\-06\-30 17:50:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34378\fP: (\fI\%adelcast\fP) network_settings.py: fix documentation (refs: \fI\%#34388\fP)
.IP \(bu 2
be9a831ef6 Merge pull request \fI\%#34388\fP from rallytime/bp\-34378
.IP \(bu 2
2040dbeca5 network_settings.py: fix documentation
.IP \(bu 2
\fBPR\fP \fI\%#34352\fP: (\fI\%cro\fP) Esxi dvs
.IP \(bu 2
\fBPR\fP \fI\%#34386\fP: (\fI\%rallytime\fP) Beacon network docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34376\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-06\-30 14:31:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
5a44b077a0 Merge pull request \fI\%#34376\fP from rallytime/merge\-2016.3
.IP \(bu 2
3149da1bcc Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
af8ef1e461 Merge pull request \fI\%#34368\fP from rallytime/merge\-2015.8
.INDENT 2.0
.IP \(bu 2
3bce0cb510 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
970aaa46d4 Merge pull request \fI\%#34252\fP from gtmanfred/2015.5
.INDENT 2.0
.IP \(bu 2
82183f1572 return list of nodes for lxc driver when called directly
.UNINDENT
.UNINDENT
.IP \(bu 2
94e094652c Back\-port \fI\%#34324\fP to 2015.8 (\fI\%#34344\fP)
.IP \(bu 2
11dc0203b0 Making salt\-ssh pass proper return codes for jinja rendering errors (\fI\%#34342\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34365\fP: (\fI\%sjorge\fP) fixes computenode_* grains on SmartOS compute nodes
@ \fI2016\-06\-29 17:55:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
3808d849fe Merge pull request \fI\%#34365\fP from sjorge/2016.3\-fix\-broken\-smartos\-grains
.IP \(bu 2
3ff895cacf fixes computenode_* grains on SmartOS compute nodes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34353\fP: (\fI\%cro\fP) Remove proxy check and additional GetConnection\-\-this makes the proxy…
@ \fI2016\-06\-29 14:54:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
65efb55917 Merge pull request \fI\%#34353\fP from cro/pyvmomi\-ssl\-fail
.IP \(bu 2
14ea29f446 Remove proxy check and additional GetConnection\-\-this makes the proxy fail to start.  Need to check to see if proxy memory leak is back.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34348\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-06\-28 23:28:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
c89d1ad27f Merge pull request \fI\%#34348\fP from rallytime/merge\-2016.3
.IP \(bu 2
c87a108a12 Don\(aqt forget the pylint disables for range
.IP \(bu 2
359e8ca2ce Pylint fixes
.IP \(bu 2
f9ab8ba46d Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
f6bd1ad47e Revert py3modernize lint changes (\fI\%#34339\fP)
.IP \(bu 2
046bdaa9f2 Merge pull request \fI\%#34306\fP from ghedo/iptables_flush_table
.INDENT 2.0
.IP \(bu 2
882c6c9c86 Do not force \(aqfilter\(aq table when flushing
.UNINDENT
.IP \(bu 2
0c60feac02 Doc clarifications to file modules, addition of new \fIprofile\fP log level to docs, fixed example in dnsmasq (\fI\%#34323\fP)
.IP \(bu 2
b793426c23 Remove unnecessarily\-disabled sanity check (\fI\%#34325\fP)
.IP \(bu 2
c5890a0eca Merge pull request \fI\%#34335\fP from rallytime/merge\-2015.8
.INDENT 2.0
.IP \(bu 2
2296587536 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
6cce545d92 Merge pull request \fI\%#34313\fP from rallytime/bootstrap\-2015.5
.INDENT 2.0
.IP \(bu 2
c7db73be92 [2015.5] Update to latest bootstrap script v2016.06.27
.UNINDENT
.UNINDENT
.IP \(bu 2
a6d3cc637b Typo in dockerio doc (\fI\%#34319\fP)
.IP \(bu 2
dd4c937009 Merge pull request \fI\%#34312\fP from rallytime/bootstrap\-2015.8
.INDENT 2.0
.IP \(bu 2
944a393f89 [2015.8] Update to latest bootstrap script v2016.06.27
.UNINDENT
.IP \(bu 2
91703d2dc4 Merge pull request \fI\%#34307\fP from rallytime/fix\-test\-example
.INDENT 2.0
.IP \(bu 2
f44a0543fe Fix test example in integration testing docs
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34255\fP: (\fI\%tmehlinger\fP) fire_event requisite does not work in orchestration states (refs: \fI\%#34256\fP, \fI\%#34343\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34343\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34256\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#34256\fP: (\fI\%tmehlinger\fP) detect running from master in State.event method (refs: \fI\%#34343\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34338\fP: (\fI\%themalkolm\fP) Add listen/listen_in support to stateconf.py
@ \fI2016\-06\-28 21:50:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
0b9cb602fe Merge pull request \fI\%#34338\fP from themalkolm/patch\-2
.IP \(bu 2
cd63541325 Add listen/listen_in support to stateconf.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34283\fP: (\fI\%sjorge\fP) 2016.3 mount vfstab support
@ \fI2016\-06\-28 19:23:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
80a659bb51 Merge pull request \fI\%#34283\fP from sjorge/2016.3\-mount\-fstab
.IP \(bu 2
b8c6948cd5 fixes broken rm_fstab test due to missing __grain__.kernel
.IP \(bu 2
d633e774ea actually do the cleanup, oops
.IP \(bu 2
987c240850 minor cleanup
.IP \(bu 2
c3667203bf add test for vfstab
.IP \(bu 2
80e9d1d278 set __grains__ for fstab unit test
.IP \(bu 2
f0f5d449c3 mount.vfstab implemented on Solaris like platforms
.IP \(bu 2
4398e8841b undo some changes to mount.fstab and mount.rm_fstab, create mount.vfstab and mount.rm_vfstab
.IP \(bu 2
133d3bb2bb mount.set_fstab errors out on Solaris like platforms
.IP \(bu 2
c0863fb024 mount.rm_fstab works with Solaris like platforms
.IP \(bu 2
151799ea74 initial vfstab support (Solaris like platforms)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34321\fP: (\fI\%Ch3LL\fP) Raspberry Pi salt\-minion missing osmajorrelease grain (refs: \fI\%#34322\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34322\fP: (\fI\%Ch3LL\fP) add osmajorrelease grain for raspbian
@ \fI2016\-06\-28 19:08:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
75aad073a9 Merge pull request \fI\%#34322\fP from Ch3LL/add_grains_majorrelease_test
.IP \(bu 2
693cc61aa4 add osmajorrelease to ubuntu and fix pylint
.IP \(bu 2
2fc3e8a54b add osmajorrelease grain for raspbian
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34337\fP: (\fI\%clinta\fP) Change merge\-if\-exists logic to properly report changes
@ \fI2016\-06\-28 18:41:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
81547f413d Merge pull request \fI\%#34337\fP from clinta/serialize\-merge
.IP \(bu 2
ebe7def2fb Change merge\-if\-exists logic to properly report changes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34300\fP: (\fI\%vutny\fP) Make apache.configfile state handle the Options list correctly
@ \fI2016\-06\-28 18:34:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
affc65dc79 Merge pull request \fI\%#34300\fP from vutny/fix\-apache\-vhost\-options
.IP \(bu 2
52001afdde Fix apache.configfile state example
.IP \(bu 2
64a9442e38 apache.config: correctly output a list of the Options
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33588\fP: (\fI\%whytewolf\fP) rabbitmq_user.present error  (refs: \fI\%#34333\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34333\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33734\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#34304\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33734\fP to 2016.3 (refs: \fI\%#34333\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33734\fP: (\fI\%glomium\fP) modules/rabbitmq.py version checking had a logical error (refs: \fI\%#34333\fP, \fI\%#34304\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34329\fP: (\fI\%clinta\fP) file.serialize merge_if_exists fails:  \(aqfunction\(aq object has no attribute \(aqdeserialize\(aq (refs: \fI\%#34330\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34330\fP: (\fI\%clinta\fP) fix \fI\%#34329\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34170\fP: (\fI\%rodoyle\fP) ps.top raises ValueError \(dqtoo many values to unpack\(dq when psutil > 4.1.0 (refs: \fI\%#34318\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34318\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32182\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#32182\fP: (\fI\%dongweiming\fP) Fix psutil.cpu_times unpack error (refs: \fI\%#34318\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34311\fP: (\fI\%rallytime\fP) [2016.3] Update to latest bootstrap script v2016.06.27
@ \fI2016\-06\-27 18:59:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
1398b1c51e Merge pull request \fI\%#34311\fP from rallytime/bootstrap\-2016.3
.IP \(bu 2
75aa7047bc [2016.3] Update to latest bootstrap script v2016.06.27
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34129\fP: (\fI\%onorua\fP) fqdn_ip4 and fqdn_ip6 are empty on 2016.3+ (refs: \fI\%#34284\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34284\fP: (\fI\%rallytime\fP) Don\(aqt require \(aqdomain\(aq to be present before checking fqdn_ip* grains
@ \fI2016\-06\-27 17:06:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
dc8462451d Merge pull request \fI\%#34284\fP from rallytime/fix\-34129
.IP \(bu 2
5f45a8ff73 Don\(aqt require \(aqdomain\(aq to be present before checking fqdn_ip* grains
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30493\fP: (\fI\%sjorge\fP) salt.modules.status mostly broken on solaris like operating systems. (refs: \fI\%#34296\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34296\fP: (\fI\%sjorge\fP) 2016.3 status module now works on Solaris like platforms
@ \fI2016\-06\-27 16:49:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
259935d6d2 Merge pull request \fI\%#34296\fP from sjorge/2016.3\-module.status
.IP \(bu 2
a26340c555 make status.all_status work on Solaris like platforms
.IP \(bu 2
33e24fa697 make status.cpustats work on Solaris like platforms
.IP \(bu 2
d214e9c776 correctly cast to int for status.netdevs on Solaris like platforms
.IP \(bu 2
b74761b52d make status.cpuinfo support Solaris like platforms and OpenBSD
.IP \(bu 2
2cd76d5ab5 make status.diskstats work on Solaris like platforms
.IP \(bu 2
3211538830 make status.diskusage work on Solaris like platforms
.IP \(bu 2
a12b311a62 make status.netdev compatible with Solaris like platforms
.IP \(bu 2
3bc01458aa make status.netstats compatible with Solaris like platforms
.IP \(bu 2
25678901fa avoid KeyError in ping_master
.IP \(bu 2
81d7fc98d8 make status.vmstats work on Solaris like platforms and OpenBSD
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34281\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-06\-24 21:51:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
376bec0455 Merge pull request \fI\%#34281\fP from rallytime/merge\-2016.3
.IP \(bu 2
ae8ad9329c Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
d235b1245b Merge pull request \fI\%#34233\fP from thegoodduke/for_2015.8_ipset
.INDENT 2.0
.IP \(bu 2
4da5e35bf4 ipset: fix the comment containing blank
.UNINDENT
.IP \(bu 2
65c5675a3f Merge pull request \fI\%#34257\fP from rallytime/fix\-34037
.INDENT 2.0
.IP \(bu 2
d7a5e9b10e Remove test that doesn\(aqt actually test anything
.IP \(bu 2
c4c037d600 Use \(aqconfig_dir\(aq setting instead of CONFIG_DIR in gpg renderer
.UNINDENT
.IP \(bu 2
203870f147 Merge pull request \fI\%#34274\fP from clinta/2015.8
.INDENT 2.0
.IP \(bu 2
6572454918 Don\(aqt escape source before calling managed
.UNINDENT
.IP \(bu 2
a59dc85a15 Merge pull request \fI\%#34258\fP from rallytime/merge\-2015.8
.INDENT 2.0
.IP \(bu 2
ea914b67cd Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
8d5ed91980 Merge pull request \fI\%#34225\fP from richardscollin/fix\-win\-set\-datetime
.INDENT 2.0
.IP \(bu 2
6286771ef7 Fix win_system.set_system_date_time
.UNINDENT
.IP \(bu 2
cb1e8bf082 Merge pull request \fI\%#34232\fP from thegoodduke/for_2015.5_ipset
.INDENT 2.0
.IP \(bu 2
344eb60762 ipset: fix commont containing blank
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34271\fP: (\fI\%opdude\fP) Fixed symlinks on windows where the slashes don\(aqt match
@ \fI2016\-06\-24 17:05:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
805171c949 Merge pull request \fI\%#34271\fP from Unity\-Technologies/hotfix/windows_symlinks
.IP \(bu 2
e0a1a55431 Fixed symlinks on windows where the slashes don\(aqt match
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#14915\fP: (\fI\%johngrasty\fP) SmartOS/OmniOS \- mount module fails. (refs: \fI\%#34254\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34254\fP: (\fI\%sjorge\fP) Fix for \fI\%#14915\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34259\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-06\-24 14:27:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
39579ce5f6 Merge pull request \fI\%#34259\fP from rallytime/merge\-2016.3
.IP \(bu 2
eeaf3cc1e7 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
92962957c8 Merge pull request \fI\%#34093\fP from terminalmage/issue33873
.INDENT 2.0
.IP \(bu 2
5edb45d746 win_pkg: refresh pkg database if refresh=True passed to version() or list_pkgs()
.IP \(bu 2
0078adee35 Catch CommandExecutionError in pkg states
.UNINDENT
.IP \(bu 2
cb5399787c Merge pull request \fI\%#34136\fP from meaksh/salt\-suse\-os\-detection\-2015.8
.INDENT 2.0
.IP \(bu 2
97f1958863 some cleanup and renaming
.IP \(bu 2
72c8e5d78f better way to check for openSUSE Leap
.IP \(bu 2
548971bdc9 Fix for SUSE OS grains in 2015.8
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34134\fP: (\fI\%meaksh\fP) Fixed behavior for SUSE OS grains in 2016.3 (refs: \fI\%#34136\fP)
@ \fI2016\-06\-23 20:24:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33903\fP: (\fI\%meaksh\fP) Fetching grains[\(aqos\(aq] from /etc/os\-release on SUSE systems if it is possible (refs: \fI\%#34134\fP)
.IP \(bu 2
3acda896f2 Merge pull request \fI\%#34134\fP from meaksh/salt\-suse\-os\-detection
.IP \(bu 2
23ce0b431b some cleanup and renaming
.IP \(bu 2
516bbc454d better way to check for openSUSE Leap
.IP \(bu 2
44eda2ad9f Fix for openSUSE Tumbleweed
.IP \(bu 2
0d4a710d86 fixes for fopen mock and some os_release_map for SLES11SP3
.IP \(bu 2
d6410a03b8 unit tests for SUSE os grains detection
.IP \(bu 2
47ecb7013b Normalization of osfullname grain for openSUSE
.IP \(bu 2
9c81f434fa one clause to set OS grain from CPE_NAME
.IP \(bu 2
d78d57b717 Test fixed: get OS grain from /etc/os\-release if possible
.IP \(bu 2
d80e0532ff fix: osarch_mock
.IP \(bu 2
db00ec756d osarch mock for unit test
.IP \(bu 2
dabc5cab7e lint fix
.IP \(bu 2
9ac514724b testing if SUSE os grain is set from /etc/os\-release
.IP \(bu 2
bc671336a7 Getting the \(aqos\(aq grain from CPE_NAME inside /etc/os\-release for SUSE and openSUSE
.IP \(bu 2
64af4d4145 Adding SLES_SAP to OS_FAMILY_MAP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34137\fP: (\fI\%christoe\fP) Win_task info function broken (refs: \fI\%#34159\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34135\fP: (\fI\%christoe\fP) Arguments to Windows task creation module are not used (refs: \fI\%#34159\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34159\fP: (\fI\%christoe\fP) Fixes to the win_task module
@ \fI2016\-06\-23 17:54:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
5f42fd4486 Merge pull request \fI\%#34159\fP from christoe/2016.3
.IP \(bu 2
f4143669db Fixes \fI\%#34135\fP, Fixes \fI\%#34137\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34223\fP: (\fI\%peterdemin\fP) Fixed typo in filtering LDAP\(aqs potential_ous
@ \fI2016\-06\-23 17:26:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a0267149f Merge pull request \fI\%#34223\fP from peterdemin/bugfix\-eauth\-ldap\-expanding
.IP \(bu 2
8bb03ec109 Fixed typo in filtering LDAP\(aqs potential_ous
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34239\fP: (\fI\%vutny\fP) file.find module: fix handling of broken symlinks
@ \fI2016\-06\-23 17:25:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
f74f176bd5 Merge pull request \fI\%#34239\fP from vutny/file\-find\-broken\-symlinks
.IP \(bu 2
7e164c4f86 file.find module: fix handling of broken symlinks
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34229\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-06\-22 22:57:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
4157f6fd39 Merge pull request \fI\%#34229\fP from rallytime/merge\-2016.3
.IP \(bu 2
940ac86d4e Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
56c7267631 fix regression from \fI\%#33681\fP which causes pulling a list of s3 objects via s3.query to fail (\fI\%#34208\fP)
.IP \(bu 2
02eb331494 Fix a pair of gitfs bugs (\fI\%#34218\fP)
.IP \(bu 2
6d643cd528 Merge pull request \fI\%#34182\fP from rallytime/fix\-34043
.INDENT 2.0
.IP \(bu 2
b7d49c5052 Handle child PIDs differently depending on the availability of psutils
.UNINDENT
.IP \(bu 2
5d3ec31564 Clarify pkg.list_repo_pkgs docstring for held packages (\fI\%#34188\fP)
.IP \(bu 2
5bca5c42f1 Change target for dockerng assuming default status to Nitrogen release (\fI\%#34206\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33879\fP: (\fI\%Ch3LL\fP) saltutil.wheel minions.connected does not return anything with remote minions (refs: \fI\%#34214\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34214\fP: (\fI\%rallytime\fP) Update saltutil.wheel docs to specify remote vs local minion behavior
@ \fI2016\-06\-22 19:22:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
b5ea1495af Merge pull request \fI\%#34214\fP from rallytime/fix\-33879
.IP \(bu 2
1be05f6a87 Update saltutil.wheel docs to specify remote vs local minion behavior
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34074\fP: (\fI\%fooka03\fP) Unable to use S3 file backend with 2016.3.1 on Ubuntu 14.04 or 16.04 (refs: \fI\%#34209\fP, \fI\%#34208\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#32916\fP: (\fI\%giannello\fP) file.managed memory usage with s3 sources (refs: \fI\%#33599\fP, \fI\%#33682\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34209\fP: (\fI\%lomeroe\fP) fix regression in s3.query from \fI\%#33682\fP
@ \fI2016\-06\-22 18:50:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33682\fP: (\fI\%lomeroe\fP) backport \fI\%#33599\fP to 2016.3 (refs: \fI\%#34209\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33599\fP: (\fI\%lomeroe\fP) Fix s3 large file download (refs: \fI\%#33681\fP, \fI\%#33682\fP)
.IP \(bu 2
4205fd605c Merge pull request \fI\%#34209\fP from lomeroe/fix_s3_utils_regression_33682
.IP \(bu 2
a2b99703b1 fix regression in s3.query from \fI\%#33682\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34222\fP: (\fI\%cachedout\fP) Lint 34200
@ \fI2016\-06\-22 18:48:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34200\fP: (\fI\%secumod\fP) Fix parted module set CLI example (refs: \fI\%#34222\fP)
.IP \(bu 2
05a4785c8c Merge pull request \fI\%#34222\fP from cachedout/lint_34200
.IP \(bu 2
eadf80a56f Linted \fI\%#34200\fP
.IP \(bu 2
2cd0433f8d Fix parted module set CLI example
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34197\fP: (\fI\%eliasp\fP) Make \fImodule.ssh.recv_known_host()\fP more resilient against hosts not returning a key
@ \fI2016\-06\-22 17:26:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
0cbdb73fc5 Merge pull request \fI\%#34197\fP from eliasp/2016.3\-salt.modules.ssh.recv_known_host\-empty_results
.IP \(bu 2
82c4b1229e Make \fImodule.ssh.recv_known_host()\fP more resilient against hosts not returning a key
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34199\fP: (\fI\%DarkKnightCZ\fP) cmdmod.exec_all doesn\(aqt work with Windows PowerShell (refs: \fI\%#34201\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34196\fP: (\fI\%DarkKnightCZ\fP) Salt call cmdmod.exec_code_all fails on Windows minion due to invalid file mode (refs: \fI\%#34198\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34201\fP: (\fI\%DarkKnightCZ\fP) Suffix temp file with .sr1 and add mandatory argument when executing PowerShell script
@ \fI2016\-06\-22 17:21:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34198\fP: (\fI\%DarkKnightCZ\fP) Don\(aqt use binary mode for cmdmod.exec_code (refs: \fI\%#34201\fP)
.IP \(bu 2
606ae3c886 Merge pull request \fI\%#34201\fP from DarkKnightCZ/cmdmod\-34199
.IP \(bu 2
05748743bc Suffix temp file with .sr1 and add \-File argument when executing PowerShell code via cmdmod.exec_code
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34196\fP: (\fI\%DarkKnightCZ\fP) Salt call cmdmod.exec_code_all fails on Windows minion due to invalid file mode (refs: \fI\%#34198\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34198\fP: (\fI\%DarkKnightCZ\fP) Don\(aqt use binary mode for cmdmod.exec_code (refs: \fI\%#34201\fP)
@ \fI2016\-06\-22 17:14:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
cb704b780b Merge pull request \fI\%#34198\fP from DarkKnightCZ/cmdmod\-34196
.IP \(bu 2
04553cd3de Don\(aqt use binary mode for cmdmod.exec_code
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34172\fP: (\fI\%dmurphy18\fP) Support for building with local packages on Debian and Ubuntu
@ \fI2016\-06\-22 16:36:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
0578a2f87d Merge pull request \fI\%#34172\fP from dmurphy18/debbuild_deps
.IP \(bu 2
f7f8a5d33f Fixed pylint issues
.IP \(bu 2
82fa276141 Support for building with local packages on Debian and Ubuntu
.IP \(bu 2
\fBPR\fP \fI\%#34194\fP: (\fI\%vutny\fP) Correct the docstrings formatting in pkgbuild modules and state
.IP \(bu 2
\fBPR\fP \fI\%#34056\fP: (\fI\%vutny\fP) Make rpmbuild module work on non\-RPM based GNU/Linux systems (refs: \fI\%#34194\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34186\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-06\-21 23:26:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
a8429c2595 Merge pull request \fI\%#34186\fP from rallytime/merge\-2016.3
.IP \(bu 2
318c2ed6a1 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
1c4369d093 Merge pull request \fI\%#34184\fP from rallytime/merge\-2015.8
.INDENT 2.0
.IP \(bu 2
8e36e90966 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
5411ebb3b4 Merge pull request \fI\%#34141\fP from jtand/boto_vpc_test_fix
.INDENT 2.0
.IP \(bu 2
b7ac6c735a Moved imports to top, out of _get_moto_version function
.IP \(bu 2
02f9ba99ba Updated version check. Moved check into its own function
.IP \(bu 2
d445026c56 Updated test to work with new moto version. Changed strings to unicode
.UNINDENT
.UNINDENT
.IP \(bu 2
c059d6c08c Merge pull request \fI\%#34176\fP from rallytime/bp\-34103
.INDENT 2.0
.IP \(bu 2
2e5e7ed03c Fix diskusage beacon
.UNINDENT
.IP \(bu 2
5cbaaed167 Merge pull request \fI\%#34179\fP from terminalmage/issue34114
.INDENT 2.0
.IP \(bu 2
86d1b8e864 Raise the correct exception when gitfs lockfile is empty
.UNINDENT
.IP \(bu 2
67deded119 Merge pull request \fI\%#34178\fP from terminalmage/remove\-comment
.INDENT 2.0
.IP \(bu 2
4965be72b1 Remove unnecesssary comment
.UNINDENT
.IP \(bu 2
6387d1636e fix salt \-\-summary to count not responding minions correctly (\fI\%#34165\fP)
.IP \(bu 2
e5949ea6f1 doc: add missing dot (\fI\%#34175\fP)
.IP \(bu 2
47595d6795 Typo fix (\fI\%#34174\fP)
.IP \(bu 2
3669048654 Merge pull request \fI\%#34077\fP from rallytime/grains\-tests
.INDENT 2.0
.IP \(bu 2
2199bb8a78 Add integration tests for grains.append
.IP \(bu 2
37cfe70724 Add some grains targeting tests
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34162\fP: (\fI\%ryanwalder\fP) salt\-call default loglevel regression (refs: \fI\%#34173\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34173\fP: (\fI\%rallytime\fP) Update docs to match log_level default
@ \fI2016\-06\-21 17:15:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
3413c494bd Merge pull request \fI\%#34173\fP from rallytime/fix\-34162
.IP \(bu 2
f577681f0b Update docs to match log_level warning default
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34094\fP: (\fI\%avandendorpe\fP) cron.file is broken (refs: \fI\%#34095\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34095\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32396\fP to 2016.3
@ \fI2016\-06\-21 16:12:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32396\fP: (\fI\%eradman\fP) Unbreak cron.file (refs: \fI\%#34095\fP)
.IP \(bu 2
c596bf5744 Merge pull request \fI\%#34095\fP from rallytime/bp\-32396
.IP \(bu 2
074b6ab5c2 Correct pylint error
.IP \(bu 2
20ff5c879a Unbreak cron.file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34108\fP: (\fI\%l2ol33rt\fP) Make dockerng.absent state honor test=true
@ \fI2016\-06\-21 15:55:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
b98687875f Merge pull request \fI\%#34108\fP from l2ol33rt/docker_absent_dryrun
.IP \(bu 2
5598cb4a21 Make docker.absent honor test=true
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34012\fP: (\fI\%viq\fP) States mount.* fail on OpenBSD\(aqs tmpfs (refs: \fI\%#34133\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34133\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34057\fP to 2016.3
@ \fI2016\-06\-21 15:53:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34057\fP: (\fI\%ajacoutot\fP) _active_mounts_openbsd: unbreak output for special filesystems (refs: \fI\%#34133\fP)
.IP \(bu 2
a75386a669 Merge pull request \fI\%#34133\fP from rallytime/bp\-34057
.IP \(bu 2
f7be5e182b _active_mounts_openbsd: unbreak output for special filesystems
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34156\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-06\-21 15:52:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd989dac78 Merge pull request \fI\%#34156\fP from rallytime/merge\-2016.3
.IP \(bu 2
b061b86946 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
65fba5b4d7 Merge pull request \fI\%#34142\fP from isbm/isbm\-getid\-loglevel\-shift
.INDENT 2.0
.IP \(bu 2
236a67b702 Move log message from INFO to DEBUG.
.UNINDENT
.IP \(bu 2
79a719b719 Update documentation on \(dqrefresh\(dq behavior in pkg states (\fI\%#34100\fP)
.IP \(bu 2
6d0d52fa86 modules.pkg int tests: skip refresh_db upon error (\fI\%#34072\fP)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34110\fP: (\fI\%garethgreenaway\fP) Fixes to git module & state module related to identity file
@ \fI2016\-06\-21 15:52:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
b302cb03ef Merge pull request \fI\%#34110\fP from garethgreenaway/git_needs_saltenv_for_identity
.IP \(bu 2
68092cdc8c When specifying the SSH identity to use with Git as a salt URL, eg. salt://files/identity, if that file exists outside of the default base environment the file won\(aqt be accessible so we need to include the saltenv.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34120\fP: (\fI\%rmohta\fP) Correct package name to systemd\-python for RHEL 7 in docs.saltproject.io (refs: \fI\%#34138\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#31402\fP: (\fI\%vutny\fP) [repo] systemd\-python required package is missing from RHEL7 archive (refs: \fI\%#34138\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34138\fP: (\fI\%rallytime\fP) Update package dep note to systemd\-python for RHEL7 install
@ \fI2016\-06\-21 15:51:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c3405755a Merge pull request \fI\%#34138\fP from rallytime/fix\-34120
.IP \(bu 2
73f3e12ce6 Update package dep note to systemd\-python for RHEL7 install
.IP \(bu 2
\fBPR\fP \fI\%#34166\fP: (\fI\%vutny\fP) Fix YAML indentation in Apache state docstrings
.IP \(bu 2
\fBPR\fP \fI\%#34098\fP: (\fI\%terminalmage\fP) Restore old refresh logic
.IP \(bu 2
\fBPR\fP \fI\%#34087\fP: (\fI\%bbinet\fP) Encourage to report issues to upstream PillarStack project
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34075\fP: (\fI\%jfindlay\fP) modules.inspectlib.kiwiproc: import gate lxml
@ \fI2016\-06\-17 15:36:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
9da592a297 Merge pull request \fI\%#34075\fP from jfindlay/import_xml
.IP \(bu 2
f882a72348 modules.inspectlib.kiwiproc: import gate lxml
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34056\fP: (\fI\%vutny\fP) Make rpmbuild module work on non\-RPM based GNU/Linux systems (refs: \fI\%#34194\fP)
@ \fI2016\-06\-17 15:14:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
52b852216a Merge pull request \fI\%#34056\fP from vutny/rpmbuild\-support\-debian
.IP \(bu 2
8ff36d4f2b Expose virtual pkgbuild module as rpmbuild on non\-RPM based systems if all required utilities are in place
.IP \(bu 2
758f5cd77c Make rpmbuild module work on Debian GNU/Linux and derivatives
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34073\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-06\-16 23:02:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
f2a2c2bf53 Merge pull request \fI\%#34073\fP from rallytime/merge\-2016.3
.IP \(bu 2
f6bfaede21 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
1b76de1557 Merge pull request \fI\%#34069\fP from rallytime/test\-minion\-return\-message
.INDENT 2.0
.IP \(bu 2
60561ac6fc Add a test to check for disconnected minion messaging
.UNINDENT
.IP \(bu 2
3119693dac Merge pull request \fI\%#34048\fP from terminalmage/issue30100
.INDENT 2.0
.IP \(bu 2
715e7af8a4 Ensure only one fileserver update in a masterless run
.UNINDENT
.IP \(bu 2
dd03024931 Merge pull request \fI\%#34011\fP from rallytime/bp\-33948\-2015.8
.INDENT 2.0
.IP \(bu 2
a4660d1ff7 Warn when custom returners don\(aqt have minions kwarg in save_load
.IP \(bu 2
78befde62f Add note to release notes about returner minions kwarg change
.IP \(bu 2
4e7f35fa36 Fix loop over cache in auth checking!
.IP \(bu 2
06963e0505 Save an entire minion cache traversal on each master pub
.UNINDENT
.IP \(bu 2
bca437128e Fixed a bug in the consul.py module that was preventing services (\fI\%#34051\fP)
.IP \(bu 2
8ba117c7f6 Merge pull request \fI\%#34045\fP from jacobhammons/release\-prev
.INDENT 2.0
.IP \(bu 2
43b4a12aa2 Updated latest release version
.UNINDENT
.IP \(bu 2
f9bfcde61f Always make changes to minion config if set (\fI\%#34020\fP)
.IP \(bu 2
e25dba49e2 More YAML indentation fixes in state module examples (\fI\%#34030\fP)
.IP \(bu 2
5b5eae4ca9 Merge pull request \fI\%#34018\fP from rallytime/merge\-2015.8
.INDENT 2.0
.IP \(bu 2
77f44f3087 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
871f7966ce Lint fix for \fI\%#34000\fP (\fI\%#34005\fP)
.IP \(bu 2
f758e42172 Fix incorrectly written test (\fI\%#34000\fP)
.IP \(bu 2
cf6281b4cf Add loader.utils() example to calling minion_mods (\fI\%#33953\fP)
.IP \(bu 2
6b98e8a9ea Merge pull request \fI\%#33880\fP from terminalmage/zh744
.INDENT 2.0
.IP \(bu 2
ea726d11c8 pkg.uptodate: Pass kwargs to pkg.list_upgrades
.IP \(bu 2
de90b35d2b salt/modules/zypper.py: add fromrepo support to list_upgrades
.IP \(bu 2
35fbb06df5 salt/modules/win_pkg.py: add kwargs to list_upgrades
.IP \(bu 2
bf5505f425 salt/modules/solarisips.py: add kwargs to list_upgrades
.IP \(bu 2
6e89a8be98 salt/modules/pkgutil.py: add kwargs to list_upgrades
.IP \(bu 2
5179dbcec4 salt/modules/pacman.py: add kwargs to list_upgrades
.IP \(bu 2
46e5a52784 salt/modules/macports.py: add kwargs to list_upgrades
.IP \(bu 2
76143b76ca salt/modules/ebuild.py: add kwargs to list_upgrades
.IP \(bu 2
b40fc9bc62 salt/modules/brew.py: add kwargs to list_upgrades
.IP \(bu 2
4f11c16d86 salt/modules/aptpkg.py: add fromrepo support to list_upgrades
.UNINDENT
.IP \(bu 2
cb88960ed1 Merge pull request \fI\%#33904\fP from rallytime/bp\-33806
.INDENT 2.0
.IP \(bu 2
638ccf501d Work around upstream cherrypy bug
.UNINDENT
.UNINDENT
.IP \(bu 2
7d940aed1f states.file: fix indentation in YAML examples (\fI\%#34003\fP)
.IP \(bu 2
4c7fac0aaa Remove loader test for pam module (\fI\%#34002\fP)
.IP \(bu 2
c4dab6a074 Merge pull request \fI\%#33990\fP from jacobhammons/community\-projects
.INDENT 2.0
.IP \(bu 2
b20213fd79 Adds links to several current Salt\-related projects Removes the salt_projects.rst file which hasn\(aqt been updated in a long time, this is replaced by the updated topics/projects/index.rst file Adds a note about Salt Pack to the installation doc
.UNINDENT
.IP \(bu 2
444c15792c Merge pull request \fI\%#33983\fP from twangboy/fix_docs_join_domain
.INDENT 2.0
.IP \(bu 2
b057be04b4 Fix typo, more documentation
.IP \(bu 2
d8c2f3e57a Clarify the \fIaccount_exists\fP parameter
.UNINDENT
.IP \(bu 2
9bd2317992 Merge pull request \fI\%#33951\fP from jfindlay/gem_tests
.INDENT 2.0
.IP \(bu 2
2eb633ccad modules.gem int tests: only check known installed gems
.IP \(bu 2
9f3e18b037 modules.gem int tests: (un)install a non\-core gem
.UNINDENT
.IP \(bu 2
53baae6eb1 Merge pull request \fI\%#33984\fP from jfindlay/disk_capacity
.INDENT 2.0
.IP \(bu 2
6cbe31e6c2 states.disk: rewrite unit tests
.IP \(bu 2
82c77b533f states.disk.status: validate percent values
.IP \(bu 2
aedc4e15e5 states.disk: add documentation
.UNINDENT
.IP \(bu 2
fa5efb6a69 Merge pull request \fI\%#33985\fP from rallytime/more\-batch\-tests
.INDENT 2.0
.IP \(bu 2
3e7ab8c7b3 Write some more simple batch command tests
.UNINDENT
.IP \(bu 2
6080846cce acl.ClientACL: add unit tests (\fI\%#33684\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33831\fP: (\fI\%astehlik\fP) file.managed state should not download a file if the checksum did not change (refs: \fI\%#34010\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34010\fP: (\fI\%terminalmage\fP) Do not cache remote files if they are already cached
@ \fI2016\-06\-16 21:03:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
790384f413 Merge pull request \fI\%#34010\fP from terminalmage/issue33831
.IP \(bu 2
636d081ae0 Do not cache remote files if they are already cached
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34009\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33948\fP to 2016.3 + add log message (refs: \fI\%#34011\fP)
@ \fI2016\-06\-16 21:01:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33948\fP: (\fI\%cachedout\fP) Save an entire minion cache traversal on each master pub (refs: \fI\%#34011\fP, \fI\%#34009\fP)
.IP \(bu 2
dd26d6fd74 Merge pull request \fI\%#34009\fP from rallytime/bp\-33948
.IP \(bu 2
239af9ae5e Warn when custom returners don\(aqt have minions kwarg in save_load
.IP \(bu 2
c776d2d795 Add note to release notes about returner minions kwarg change
.IP \(bu 2
5f696082e3 Fix loop over cache in auth checking!
.IP \(bu 2
180c312715 Save an entire minion cache traversal on each master pub
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33927\fP: (\fI\%phil123456\fP) Salt \- windows minion cannot do anything (refs: \fI\%#33941\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33941\fP: (\fI\%cachedout\fP) Don\(aqt call os.getppid() on Windows
@ \fI2016\-06\-16 20:56:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
5f4ef46d2f Merge pull request \fI\%#33941\fP from cachedout/issue_33927
.IP \(bu 2
5fe889c7f1 Don\(aqt call os.getppid() on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34067\fP: (\fI\%jacobhammons\fP) Fixes doc refresh bug on chrome mobile.
@ \fI2016\-06\-16 18:44:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
fa253aa62b Merge pull request \fI\%#34067\fP from jacobhammons/mobile\-fix
.IP \(bu 2
ce027fd769 Fixes doc refresh bug on chrome mobile.
.IP \(bu 2
\fBPR\fP \fI\%#34050\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34026\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#34026\fP: (\fI\%bensherman\fP) removed method that doesn\(aqt exist (refs: \fI\%#34050\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33987\fP: (\fI\%isbm\fP) inspectlib cleanup
@ \fI2016\-06\-15 22:09:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
73ff11585e Merge pull request \fI\%#33987\fP from isbm/isbm\-inspectlib\-cleanup
.IP \(bu 2
e36821510f Fix documentation: add an example how to export system to the Kiwi
.IP \(bu 2
fe300ccf73 Lintfix
.IP \(bu 2
96423076b1 Add unit test for file tree
.IP \(bu 2
8975036b27 Add get_unmanaged_files test
.IP \(bu 2
be5f12fcaf Add initial unit test for inspectlib.collector.Inspector
.IP \(bu 2
652c96d7e7 Stop build (not implemented yet)
.IP \(bu 2
58e85ea0ab Refactor class caller
.IP \(bu 2
878f67674a Sort package names
.IP \(bu 2
c31818b4aa Fix lint: PEP8 multiplication of 4.
.IP \(bu 2
c87fff3680 Add root\-only warning when exporting system with Kiwi
.IP \(bu 2
9bd80f02fc Implement users Kiwi export
.IP \(bu 2
e191f338c7 Cleanup code
.IP \(bu 2
80f45defae Implement packages and patterns gathering
.IP \(bu 2
ad45a265f5 Add Debian support for the repo generator
.IP \(bu 2
6280ad137e Semifix: sometimes SQLite3 is locked. TODO: a proper handling required.
.IP \(bu 2
51567ab61d Implement SUSE repositories export
.IP \(bu 2
e4ac113927 Add Kiwi support to the collector/inspector
.IP \(bu 2
eceeb4ecf2 Add ability to specify an additional PID file
.IP \(bu 2
f522a91ac6 Add ISO/image build (stub) and export to the Kiwi
.IP \(bu 2
bb19684606 Add Kiwi processor exception
.IP \(bu 2
805e2ce204 Add Kiwi exported (initial)
.IP \(bu 2
a52f9f7107 Add default configuration
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34038\fP: (\fI\%Ch3LL\fP) user.list_users does not work on smartos (refs: \fI\%#34042\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34042\fP: (\fI\%sjorge\fP) fix \fI\%#34038\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34025\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-06\-15 19:41:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
f546a00dc9 Merge pull request \fI\%#34025\fP from rallytime/merge\-2016.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34044\fP: (\fI\%jacobhammons\fP) Updated latest release to 2016.3.1
@ \fI2016\-06\-15 19:20:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
3035520594 Merge pull request \fI\%#34044\fP from jacobhammons/3.1
.IP \(bu 2
a4b67fd1e9 Updated latest release to 2016.3.1 Clean up installation instructions code\-block type updates Add link to jinja tutorial
.IP \(bu 2
\fBPR\fP \fI\%#34014\fP: (\fI\%jnhmcknight\fP) fix launch config creation params
.IP \(bu 2
\fBPR\fP \fI\%#34021\fP: (\fI\%twangboy\fP) Always make changes to minion config if set (2016.3)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34031\fP: (\fI\%eliasp\fP) \fIstates.postgres_privileges\fP expects a real list, not a comma\-separated string
@ \fI2016\-06\-15 16:34:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
5f90717fd3 Merge pull request \fI\%#34031\fP from eliasp/2016.3\-salt.states.postgres_privileges\-doc\-priv\-list
.IP \(bu 2
d3198ea538 \fIstates.postgres_privileges\fP expects a real list, not a comma\-separated string for \fIprivileges\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33023\fP: (\fI\%cmclaughlin\fP) rest_cherrypy eauth can\(aqt handle some characters (refs: \fI\%#33995\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23522\fP: (\fI\%nbirnel\fP) Update the best practices documentation to include simpler examples of of jinja dictionaries (refs: \fI\%#33995\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#12470\fP: (\fI\%whiteinge\fP) Document how to (and not NOT to) use Jinja in states (refs: \fI\%#33995\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#10480\fP: (\fI\%gravyboat\fP) Create documentation that talks about using Jinja specifically for Salt. (refs: \fI\%#33995\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#10206\fP: (\fI\%rabits\fP) Jinja import: Jinja variable \(aqsalt\(aq is undefined (refs: \fI\%#33995\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33995\fP: (\fI\%jacobhammons\fP) Understanding Jinja topic, Jinja doc issues.
@ \fI2016\-06\-14 02:00:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
1132bc5d0b Merge pull request \fI\%#33995\fP from jacobhammons/doc\-fixes
.IP \(bu 2
887a415138 Adds new Understanding Jinja topic, and fixes several Jinja doc issues. Removes the \(dqFull list of builtin ...\(dq from each module reference list, leaving just the module type for scanability.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33900\fP: (\fI\%amendlik\fP) Document sudo policy for gitfs post\-receive hook
@ \fI2016\-06\-14 01:04:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
a400f6a6c3 Merge pull request \fI\%#33900\fP from amendlik/gitfs\-hook\-doc
.IP \(bu 2
b4a28e2684 Add clarifying documentation about the need for sudo in the git hook
.IP \(bu 2
1046279cb7 Document sudo policy for gitfs post\-receive hook
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33980\fP: (\fI\%twangboy\fP) Use full path to python.exe
@ \fI2016\-06\-14 00:46:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
28c886edd0 Merge pull request \fI\%#33980\fP from twangboy/fix_build
.IP \(bu 2
dd7d55afb9 Use full path to python.exe
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33993\fP: (\fI\%s0undt3ch\fP) Call \fIsys.exit()\fP instead of \fIexit()\fP
@ \fI2016\-06\-14 00:30:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
26fee377ec Merge pull request \fI\%#33993\fP from s0undt3ch/2016.3
.IP \(bu 2
34f7d90d9f Call \fIsys.exit()\fP instead of \fIexit()\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33976\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-06\-13 19:29:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e934cffef Merge pull request \fI\%#33976\fP from rallytime/merge\-2016.3
.IP \(bu 2
19d49d94f2 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
a74f1b8077 ZD 762 (\fI\%#33942\fP)
.IP \(bu 2
0281d491c6 Merge pull request \fI\%#33946\fP from rallytime/bp\-33698
.INDENT 2.0
.IP \(bu 2
5fdfed1cb9 Make sure we only use GetConnection if we are using a proxy salt minion
.IP \(bu 2
1505c5724b Fix a bug with self signed certificates and creating a new VM
.UNINDENT
.IP \(bu 2
dff3f51955 Merge pull request \fI\%#33952\fP from rallytime/fix\-33911
.INDENT 2.0
.IP \(bu 2
03b7cbbd2c Add base argument to salt\-ssh grains wrapper for filter_by func
.UNINDENT
.IP \(bu 2
4a8064918a Adds a \(dqGenerated on <timestamp>\(dq line to the footer of each doc html page in the doc (\fI\%#33962\fP)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33868\fP: (\fI\%abalashov\fP) Returner configuration override options don\(aqt work for scheduled jobs (schedule module) (refs: \fI\%#33912\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33912\fP: (\fI\%abalashov\fP) utils/schedule.py:handle_func() \- Fix for accessing returner configur…
@ \fI2016\-06\-13 17:18:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
8d8ed59b85 Merge pull request \fI\%#33912\fP from abalashov/abalashov/fix\-schedule\-returner\-config
.IP \(bu 2
b5a4f8b313 utils/schedule.py:handle_func() \- Fix for accessing returner configuration attributes \(aqreturn_config\(aq and \(aqreturn_kwargs\(aq.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33945\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-06\-13 15:44:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
81e16bb93f Merge pull request \fI\%#33945\fP from rallytime/merge\-2016.3
.IP \(bu 2
b4ab322ce1 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
b3ec39d644 Correct issue with ping on rotate with minion cache (\fI\%#33765\fP)
.IP \(bu 2
378dd7ca06 Merge pull request \fI\%#33888\fP from jfindlay/random_check
.INDENT 2.0
.IP \(bu 2
6acee3cc30 modules.random_org._query: only return text if present
.IP \(bu 2
82f95429db modules.random_org unit tests: skip if random.org down
.IP \(bu 2
1f9422e0cd utils.http.query: also except gaierror with tornado
.UNINDENT
.IP \(bu 2
2dc1914e7c Add connecting_settings to boto_elb state attributes list (\fI\%#33936\fP)
.IP \(bu 2
91a2184f2d Wait for up to a minute for sync_after_install (\fI\%#33917\fP)
.IP \(bu 2
ef6da0be5d Merge pull request \fI\%#33877\fP from rallytime/merge\-2015.8
.IP \(bu 2
398534a9e7 Fix ret return from merge\-conflict resolution
.IP \(bu 2
b8e4706074 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
cdda593c50 Merge pull request \fI\%#33829\fP from terminalmage/update\-versionchanged
.INDENT 2.0
.IP \(bu 2
f7028eb1c6 Update versionchanged directive
.UNINDENT
.IP \(bu 2
b8e6c144d8 Merge pull request \fI\%#33833\fP from terminalmage/issue33645
.INDENT 2.0
.IP \(bu 2
91745c2a67 Support syncing pillar modules to masterless minions
.UNINDENT
.IP \(bu 2
e061788e81 Merge pull request \fI\%#33814\fP from terminalmage/archive\-extracted\-xz
.INDENT 2.0
.IP \(bu 2
897a716df2 Support extraction of XZ archives in archive.extracted state
.UNINDENT
.IP \(bu 2
fa983e91cf Merge pull request \fI\%#33778\fP from sodium\-chloride/2015.5\-2016\-0604\-1938
.INDENT 2.0
.IP \(bu 2
a5fb6d7a69 Fix minor docstring issues
.UNINDENT
.IP \(bu 2
b9133326c8 Merge pull request \fI\%#33726\fP from jtand/sysmod_skip_valid_docs_glance
.INDENT 2.0
.IP \(bu 2
ebee8a89af glance.warn_until shouldn\(aqt be checked for a doc string
.UNINDENT
.IP \(bu 2
137f0b19f3 Merge pull request \fI\%#33611\fP from TargetHolding/2015.5
.IP \(bu 2
1dd15a603b solve\(aq TypeError: expected string or buffer\(aq in json/decoder.py
.IP \(bu 2
eaf42ca892 solve AttributeError: \(aqmodule\(aq object has no attribute \(aqexception\(aq
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33960\fP: (\fI\%nulfox\fP) Fix mongo get_load to return full mongo record instead of non\-existant \(aqload\(aq key
@ \fI2016\-06\-13 15:37:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
68d261fe5b Merge pull request \fI\%#33960\fP from mecarus/2016.3
.IP \(bu 2
d622133a49 The jid load comes in directly, not as \(aqload\(aq key. Should return the mongo record directly without accessing keys
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33961\fP: (\fI\%jacobhammons\fP) 2016.3.0 known issues update
@ \fI2016\-06\-13 02:59:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
8f56406507 Merge pull request \fI\%#33961\fP from jacobhammons/release
.IP \(bu 2
2cf787d4ba 2016.3.0 known issues update
.IP \(bu 2
\fBPR\fP \fI\%#33908\fP: (\fI\%ticosax\fP) [boto_lambda] handle omitted Permissions parameter
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33575\fP: (\fI\%anlutro\fP) File states seem slower in 2016.3, especially on first cache retrieval (refs: \fI\%#33896\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29643\fP: (\fI\%matthayes\fP) Can\(aqt get batch mode and \-\-failhard to work as expected (refs: \fI\%#31164\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#28569\fP: (\fI\%andrejohansson\fP) Reactor alert on highstate fail (refs: \fI\%#31164\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33896\fP: (\fI\%DmitryKuzmenko\fP) Don\(aqt deep copy context dict values.
@ \fI2016\-06\-10 15:32:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31164\fP: (\fI\%DmitryKuzmenko\fP) Issues/29643 fix invalid retcode (refs: \fI\%#33896\fP)
.IP \(bu 2
16b5e9dcc1 Merge pull request \fI\%#33896\fP from DSRCompany/issues/33575_do_not_deep_copy_context
.IP \(bu 2
8e34d0a9c3 Don\(aqt deep copy context dict values.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#3077\fP: (\fI\%torhve\fP) Client ACL and external auth system should have support for limiting functions to certain arguments (refs: \fI\%#29153\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33905\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33847\fP to 2016.3
@ \fI2016\-06\-10 15:22:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33847\fP: (\fI\%whiteinge\fP) Add docs for arg/kwarg eauth matching (refs: \fI\%#33905\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29153\fP: (\fI\%DmitryKuzmenko\fP) ACL limit args (refs: \fI\%#33847\fP)
.IP \(bu 2
01323322b0 Merge pull request \fI\%#33905\fP from rallytime/bp\-33847
.INDENT 2.0
.IP \(bu 2
b6ebd7b6ef Add docs for arg/kwarg eauth matching
.UNINDENT
.IP \(bu 2
261baeb5b5 Ensure tht pillar have freshest grains (\fI\%#33910\fP)
.IP \(bu 2
00e016ecfc Add note about Xenial packages to 2016.3.0 release notes (\fI\%#33870\fP)
.UNINDENT
.UNINDENT
.SS Salt 2016.3.3 Release Notes
.sp
Version 2016.3.3 is a bugfix release for \fI\%2016.3.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB108\fP
.IP \(bu 2
Total Issue References: \fB26\fP
.IP \(bu 2
Total PR References: \fB115\fP
.IP \(bu 2
Contributors: \fB36\fP (\fI\%The\-Loeki\fP, \fI\%abednarik\fP, \fI\%cachedout\fP, \fI\%cro\fP, \fI\%deniszh\fP, \fI\%dkruger\fP,
\fI\%dmurphy18\fP, \fI\%eliasp\fP, \fI\%farcaller\fP, \fI\%galet\fP, \fI\%gtmanfred\fP, \fI\%hu\-dabao\fP, \fI\%isbm\fP,
\fI\%jacobhammons\fP, \fI\%jacobweinstock\fP, \fI\%jfindlay\fP, \fI\%justinta\fP, \fI\%kstreee\fP, \fI\%lubyou\fP,
\fI\%markuskramerIgitt\fP, \fI\%meaksh\fP, \fI\%miihael\fP, \fI\%mzupan\fP, \fI\%nishigori\fP, \fI\%rallytime\fP, \fI\%s0undt3ch\fP,
\fI\%skizunov\fP, \fI\%tankywoo\fP, \fI\%terminalmage\fP, \fI\%thatch45\fP, \fI\%theredcat\fP, \fI\%ticosax\fP, \fI\%tonybaloney\fP,
\fI\%twangboy\fP, \fI\%vutny\fP, \fI\%whiteinge\fP)
.UNINDENT
.SS Known Issues
.sp
\fI\%issue 36055\fP: Salt Cloud events (\fBsalt/cloud\fP) are not generated on the
master event bus when provisioning cloud systems.
.sp
\fI\%Bootstrap Issue #973\fP: \fBpython\-futures\fP is not installed when installing
from a git tag on RedHat\-based distributions. \fBPython futures\fP is needed when
.sp
running Salt with the TCP transport. This is fixed on the \fBdevelop\fP branch of
the \fI\%salt\-bootstrap repo\fP and the fix will be included in the upcoming release
of salt\-bootstrap, but is a bug in the bootstrap release that ships with this
version of Salt. Please see the \fI\%salt\-bootstrap repo\fP for more information on
how to update your bootstrap version.
.SS Changelog for v2016.3.2..v2016.3.3
.sp
\fIGenerated at: 2018\-05\-27 04:47:36 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#35603\fP: (\fI\%rallytime\fP) Make sure version label is correct in header
.IP \(bu 2
\fBPR\fP \fI\%#35602\fP: (\fI\%rallytime\fP) Update release notes for 2016.3.3
.IP \(bu 2
\fBISSUE\fP \fI\%#35102\fP: (\fI\%TheBigBear\fP) Exception raised when processing __virtual__ function for mac_system \- (mac os x installation relies on un\-installed \(aqmac_service_helper.sh\(aq) (refs: \fI\%#35580\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35580\fP: (\fI\%twangboy\fP) Fix mac_service attempts to parse non\-plist files
@ \fI2016\-08\-19 09:24:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
9683bb3c58 Merge pull request \fI\%#35580\fP from twangboy/fix_35102
.IP \(bu 2
4122e66ed5 Handle malformed plist files
.IP \(bu 2
52feff9309 Fix mac_service attempts to parse non\-plist files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35586\fP: (\fI\%hu\-dabao\fP) Fix 35420,  add run_on_start in build_schedule_item
@ \fI2016\-08\-19 09:23:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
c4ec94d6e8 Merge pull request \fI\%#35586\fP from hu\-dabao/fix\-35420
.IP \(bu 2
2d3a882cc2 fix 35420, add run_on_start in build_schedule_item, remove redundancy of enabled
.IP \(bu 2
\fBPR\fP \fI\%#35583\fP: (\fI\%terminalmage\fP) Fix localemod tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35579\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-18 22:00:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
d1339fd9f5 Merge pull request \fI\%#35579\fP from rallytime/merge\-2016.3
.IP \(bu 2
00dff9dcbd Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
26a7f7d9f7 Merge pull request \fI\%#35577\fP from terminalmage/unit\-file\-changes
.INDENT 2.0
.IP \(bu 2
6cb0fb47f3 pkg/salt\-syndic.service: change Type to notify
.IP \(bu 2
175ba99e0e pkg/salt\-minion.service: remove KillMode, change Type to notify
.IP \(bu 2
540ec28954 pkg/salt\-master.service: remove KillMode
.IP \(bu 2
69fad464ab pkg/salt\-api.service: change Type to notify
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35571\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-18 19:50:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
f7a18234db Merge pull request \fI\%#35571\fP from rallytime/merge\-2016.3
.IP \(bu 2
2930df924e Update localemod_test systemd.sd_booted mock to use salt.utils.systemd.booted
.IP \(bu 2
e61b04a707 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
2a5d1a0eee fix\-35384, fix the logic caused by wrong indent (\fI\%#35566\fP)
.IP \(bu 2
feb852f8c0 Clarify config.get docstring (\fI\%#35492\fP)
.IP \(bu 2
205d8e2e7b Merge pull request \fI\%#35483\fP from gtmanfred/2015.8
.INDENT 2.0
.IP \(bu 2
2d8ec1e9db use __opts__ in salt.utils.cloud for cache functions
.UNINDENT
.IP \(bu 2
70fa2d0901 Merge pull request \fI\%#35546\fP from whiteinge/salt\-api\-eauth\-fail\-gracefully
.INDENT 2.0
.IP \(bu 2
eb3574adae Don\(aqt fail hard if the user\(aqs permissions cannot be found
.IP \(bu 2
ec597bd54c Change groups check in token to look for truthy values
.UNINDENT
.IP \(bu 2
61fec6caa9 add missing glob import (\fI\%#35525\fP)
.IP \(bu 2
0e3f2fc6cb Whitespace fix for 2015.8 (\fI\%#35540\fP)
.IP \(bu 2
fd3274c800 Merge pull request \fI\%#35510\fP from terminalmage/issue33516
.INDENT 2.0
.IP \(bu 2
5b5f19d269 Update zypper unit test to reflect call to config.get
.IP \(bu 2
2730edb516 Add note about systemd\-run usage in package states
.IP \(bu 2
e2d9e87e10 salt/modules/systemd.py: Use systemd\-run \-\-scope where needed
.IP \(bu 2
22919a25bc Notify systemd on salt\-api start
.IP \(bu 2
a40b3f8a08 Notify systemd on syndic start
.IP \(bu 2
e847d3af30 Notify systemd on minion start
.IP \(bu 2
d648887afc salt/modules/zypper.py: Use systemd\-run \-\-scope where needed
.IP \(bu 2
2e17976722 salt/modules/yumpkg.py: Use systemd\-run \-\-scope where needed
.IP \(bu 2
86b59c1e74 salt/modules/pacman.py: Use systemd\-run \-\-scope where needed
.IP \(bu 2
e32d92c6d5 salt/modules/ebuild.py: Use systemd\-run \-\-scope where needed
.IP \(bu 2
c7d21d3ae3 salt/modules/aptpkg.py: Use systemd\-run \-\-scope where needed
.IP \(bu 2
f83e0ef242 Add unit tests for salt.utils.systemd
.IP \(bu 2
5b12f030c6 Add func to salt.utils.systemd to tell if scopes are available
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35573\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33337\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#33337\fP: (\fI\%mzupan\fP) adding the () to make changes work (refs: \fI\%#35573\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35572\fP: (\fI\%terminalmage\fP) Fix poor formatting in pkg state docs
@ \fI2016\-08\-18 18:15:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
73b549ed00 Merge pull request \fI\%#35572\fP from terminalmage/docs
.IP \(bu 2
7d7a7de9e6 Fix poor formatting in pkg state docs
.IP \(bu 2
\fBPR\fP \fI\%#35545\fP: (\fI\%hu\-dabao\fP) fix\-35384, fix cmd.run unless (refs: \fI\%#35566\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35463\fP: (\fI\%skizunov\fP) Make \fIauth_timeout\fP user configurable again (refs: \fI\%#35489\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35489\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35463\fP to 2016.3
@ \fI2016\-08\-18 07:16:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35463\fP: (\fI\%skizunov\fP) Make \fIauth_timeout\fP user configurable again (refs: \fI\%#35489\fP)
.IP \(bu 2
f2eb3dc105 Merge pull request \fI\%#35489\fP from rallytime/bp\-35463
.IP \(bu 2
bbf7ce121b Remove final self.MINION_CONNECT_TIMEOUT ref
.IP \(bu 2
cf2e2daab9 Make \fIauth_timeout\fP user configurable again
.IP \(bu 2
\fBPR\fP \fI\%#35538\fP: (\fI\%thatch45\fP) Treat python XML as an optdep
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35526\fP: (\fI\%thatch45\fP) Always deploy the thin to /var/tmp
@ \fI2016\-08\-17 19:44:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
e2bd575461 Merge pull request \fI\%#35526\fP from thatch45/ssh_W_tmp
.IP \(bu 2
a381f02cfe Always deploy the thin to /var/tmp
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35522\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-17 18:07:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
8b770869e4 Merge pull request \fI\%#35522\fP from rallytime/merge\-2016.3
.IP \(bu 2
ff212d8976 Whitespace fix
.IP \(bu 2
c305d8d99b Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
b3b28cb760 Might be a good idea to be able to download the software we make (\fI\%#35513\fP)
.IP \(bu 2
9f87081cef Merge pull request \fI\%#35302\fP from Ch3LL/add_job_cache_test
.INDENT 2.0
.IP \(bu 2
ccb2a5cadf remove unused imports
.IP \(bu 2
512ae81dfd remove TMP and add integration.TMP
.IP \(bu 2
c9b7c3cf80 need to add returners option in other places
.IP \(bu 2
7316df7a02 fix pylint
.IP \(bu 2
50a4f0fe6a fix comment
.IP \(bu 2
6837acf742 add job cache integration tests
.UNINDENT
.IP \(bu 2
1c82c6bee5 Merge pull request \fI\%#35512\fP from cachedout/fixup_35419
.INDENT 2.0
.IP \(bu 2
253662541a Fix import
.IP \(bu 2
f16a30786b Fixes consul.agent_service_register which was broken for registering service checks.
.UNINDENT
.IP \(bu 2
e1a373fa4c Merge pull request \fI\%#35497\fP from deepakhj/2015.8
.INDENT 2.0
.IP \(bu 2
685db4ab88 Fix spacing
.UNINDENT
.IP \(bu 2
4048255ed6 Merge pull request \fI\%#35508\fP from terminalmage/update\-docstring
.INDENT 2.0
.IP \(bu 2
67c945fce0 Add Carbon to versionadded for git.diff
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35516\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34441\fP to 2016.3
@ \fI2016\-08\-17 15:47:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34441\fP: (\fI\%markuskramerIgitt\fP) Copy and delete silently, do not list each file (refs: \fI\%#35516\fP)
.IP \(bu 2
e86a39a115 Merge pull request \fI\%#35516\fP from rallytime/bp\-34441
.IP \(bu 2
e47c661cb0 Copy and delete silently, do not list each file
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#34502\fP: (\fI\%markuskramerIgitt\fP) Windows installer build scripts will exit on error (refs: \fI\%#35517\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35517\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34502\fP to 2016.3
@ \fI2016\-08\-17 15:47:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34502\fP: (\fI\%markuskramerIgitt\fP) Windows installer build scripts will exit on error (refs: \fI\%#35517\fP)
.IP \(bu 2
45080d9860 Merge pull request \fI\%#35517\fP from rallytime/bp\-34502
.IP \(bu 2
32da48df08 setup.py will not print each individual file
.IP \(bu 2
698a076a39 Completely remove Python and verify
.IP \(bu 2
7406bd22a6 Errors will stop the scripts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35429\fP: (\fI\%tankywoo\fP) Fix iptables target options with no arguments
@ \fI2016\-08\-17 10:05:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
c1deb945d7 Merge pull request \fI\%#35429\fP from tankywoo/fix\-iptables\-target\-options
.IP \(bu 2
914eb60d51 Fix iptables target options with no arguments
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35458\fP: (\fI\%iggy\fP) SALT.STATES.APACHE_MODULE needs version annotations (refs: \fI\%#35495\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35495\fP: (\fI\%rallytime\fP) Use correct deprecated notation instead of a warning for apache_module.enable state function.
@ \fI2016\-08\-17 09:36:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
678759ba6c Merge pull request \fI\%#35495\fP from rallytime/fix\-35458
.IP \(bu 2
9bae3d09a6 Use correct deprecated notation instead of a warning.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35336\fP: (\fI\%Sylvain303\fP) documentation state.file.managed parameter template not reflecting TEMPLATE_REGISTRY (refs: \fI\%#35360\fP, \fI\%#35498\fP, \fI\%#35406\fP, #saltstack/salt\(ga#35360\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35360\fP: (\fI\%rallytime\fP) Add all template registery templates to file.managed docs (refs: \fI\%#35406\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35498\fP: (\fI\%rallytime\fP) Add supported templates list to all template doc references in file state
@ \fI2016\-08\-17 09:33:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35406\fP: (\fI\%rallytime\fP) Provide links to the renderers in the template docs (refs: \fI\%#35498\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35360\fP: (\fI\%rallytime\fP) Add all template registery templates to file.managed docs (refs: \fI\%#35498\fP)
.IP \(bu 2
5bd44b10a7 Merge pull request \fI\%#35498\fP from rallytime/file\-state\-docs
.IP \(bu 2
6190b2d738 Add supported templates list to all template doc references in file state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35487\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-16 18:36:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
6df4648765 Merge pull request \fI\%#35487\fP from rallytime/merge\-2016.3
.IP \(bu 2
c6c82be1de Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
bfe7107a87 Update bootstrap script to latest stable (2016.08.16) (\fI\%#35486\fP)
.IP \(bu 2
240fc12863 Merge pull request \fI\%#35413\fP from cachedout/issue_35296
.INDENT 2.0
.IP \(bu 2
fb8a12d677 Fix silly error
.IP \(bu 2
3646cf1afa Additional checks on master and integration test
.IP \(bu 2
09efde7634 Splat the list into os.path.join
.IP \(bu 2
fc0d5878bc Set file_recv on test master
.IP \(bu 2
81c4d136c5 Transition file push paths to lists
.UNINDENT
.IP \(bu 2
c3319b2a8b Merge pull request \fI\%#35476\fP from cachedout/issue_35380
.INDENT 2.0
.IP \(bu 2
c05fcf33d1 Fixup SSH bug where sudo without sudo user would break
.UNINDENT
.IP \(bu 2
004778c966 Merge pull request \fI\%#35471\fP from terminalmage/issue34479
.INDENT 2.0
.IP \(bu 2
e243c63e43 win_pkg: Fix traceback when package is not installed
.UNINDENT
.IP \(bu 2
5c9428c32d Merge pull request \fI\%#35448\fP from isbm/isbm\-zypper\-106\-fix
.INDENT 2.0
.IP \(bu 2
dd82e6a848 Add ignore_repo_failure option to suppress zypper\(aqs exit code 106 on unavailable repos
.UNINDENT
.IP \(bu 2
1473474b04 Merge pull request \fI\%#35451\fP from isbm/isbm\-zypper\-mod_repo\-unchanged
.INDENT 2.0
.IP \(bu 2
8790197d86 Fix Unit test for suppressing the exception removal on non\-modified repos
.IP \(bu 2
3f00c6997a Remove zypper\(aqs raise exception if mod_repo has no arguments and/or no changes
.UNINDENT
.IP \(bu 2
a8c4f17f50 Merge pull request \fI\%#35453\fP from theothergraham/fix_CacheDisk
.INDENT 2.0
.IP \(bu 2
ae5b233d51 fixes \fI\%#34279\fP
.UNINDENT
.IP \(bu 2
d8c35b5260 Merge pull request \fI\%#35459\fP from thatch45/shim_fix
.INDENT 2.0
.IP \(bu 2
10037b00cb Some environments refuse to return the command output
.UNINDENT
.IP \(bu 2
38b60a32e5 [2015.8] Update bootstrap script to latest stable (2016.08.15) (\fI\%#35460\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34161\fP: (\fI\%bobrik\fP) Salt command can hang forever because of one broken minion (refs: \fI\%#35446\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35446\fP: (\fI\%cachedout\fP) Make salt\-client aware of edge\-case where saltutil might be broken
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35422\fP: (\fI\%ViaviSolutions\fP) aptpkg.py: install_recommends: True does not force \(dq\-\-install\-recommends\(dq (refs: \fI\%#35449\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35449\fP: (\fI\%dkruger\fP) aptpkg will specify \-\-install\-recommends if enabled by the SLS
@ \fI2016\-08\-16 01:38:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
f90ecbb15e Merge pull request \fI\%#35449\fP from dkruger/fix\-35422
.IP \(bu 2
f54bf445b5 aptpkg will specify \-\-install\-recommends if enabled by the SLS
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33367\fP: (\fI\%supertom\fP) [salt\-cloud] libcloud >= 1.0.0 incompatible regarding node_state (refs: \fI\%#33518\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35467\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33518\fP to 2016.3
@ \fI2016\-08\-16 01:17:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35235\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33518\fP to 2016.3 (refs: \fI\%#35467\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33518\fP: (\fI\%tonybaloney\fP) Fix libcloud bug \fI\%#33367\fP (refs: \fI\%#35235\fP, \fI\%#35467\fP)
.IP \(bu 2
d2dd78e25b Merge pull request \fI\%#35467\fP from rallytime/bp\-33518
.IP \(bu 2
e427815caf fix clrf
.IP \(bu 2
be41a400fa commit fix
.IP \(bu 2
06530b5461 add a test to check existing functionality is broken
.IP \(bu 2
\fBPR\fP \fI\%#35461\fP: (\fI\%rallytime\fP) [2016.3] Update bootstrap script to latest stable (2016.08.15)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35456\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-15 19:16:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
9b2c075611 Merge pull request \fI\%#35456\fP from rallytime/merge\-2016.3
.IP \(bu 2
6a86a12294 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
d75005c519 Fix cp.push_dir pushing empty dirs (\fI\%#35442\fP)
.IP \(bu 2
09925ba353 Minor doc fixup (\fI\%#35436\fP)
.IP \(bu 2
a0b128a85a Merge pull request \fI\%#35132\fP from sjorge/2015.8\-35121
.INDENT 2.0
.IP \(bu 2
5cb38c8ae0 switch to fpread().splitlines(), as per @lorengordon suggestion
.IP \(bu 2
634f1dded5 fixes \fI\%#35121\fP, causing lots of mayham (onchange) with 2016.3.2 for me
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35308\fP: (\fI\%farcaller\fP) Actually fixed dockerng.list_tags (refs: \fI\%#35447\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#34702\fP: (\fI\%farcaller\fP) Fixed dockerng.list_tags (refs: \fI\%#35447\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35447\fP: (\fI\%ticosax\fP) [dockerng] RepoTags can be also be None with docker 1.12
.IP \(bu 2
\fBPR\fP \fI\%#34702\fP: (\fI\%farcaller\fP) Fixed dockerng.list_tags (refs: #\(gasaltstack/salt#35308\(ga_)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#35403\fP: (\fI\%randomed\fP) Setting ext_job_cache breaks on salt\-master (refs: \fI\%#35427\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35427\fP: (\fI\%cachedout\fP) Correct errant call to argspec from master. Fix ext_job_cache.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35423\fP: (\fI\%Ch3LL\fP) Stacktrace when running state.sls against an sls does not exist (refs: \fI\%#35428\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35428\fP: (\fI\%cachedout\fP) Resolve stacktrace logged by highstate outputter if sls cannot be found
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35412\fP: (\fI\%s0undt3ch\fP) Only allow one sync read to happen at a time.
@ \fI2016\-08\-12 23:57:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
607169a01b Merge pull request \fI\%#35412\fP from s0undt3ch/2016.3
.IP \(bu 2
f54b3cc514 Only allow one sync read to happen at a time.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35336\fP: (\fI\%Sylvain303\fP) documentation state.file.managed parameter template not reflecting TEMPLATE_REGISTRY (refs: \fI\%#35360\fP, \fI\%#35498\fP, \fI\%#35406\fP, #saltstack/salt\(ga#35360\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35360\fP: (\fI\%rallytime\fP) Add all template registery templates to file.managed docs (refs: \fI\%#35406\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35406\fP: (\fI\%rallytime\fP) Provide links to the renderers in the template docs (refs: \fI\%#35498\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35393\fP: (\fI\%deniszh\fP) No need to run ddns update every time
@ \fI2016\-08\-12 12:40:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
b3e9e98b40 Merge pull request \fI\%#35393\fP from deniszh/2016.3_fix35350
.IP \(bu 2
6f2f080f4a No need to run dns update every time
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35407\fP: (\fI\%hu\-dabao\fP) [Fix\-35094] None will not be added to grains which generate [none]
@ \fI2016\-08\-12 12:34:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
a5fe05b7f9 Merge pull request \fI\%#35407\fP from hu\-dabao/fix\-35094
.IP \(bu 2
a23108f795 None will not be added to grains which generate [none]
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35411\fP: (\fI\%eliasp\fP) modules.event.send(): Prevent backtrace for masterless Minions
@ \fI2016\-08\-12 12:29:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
4dc776ffbf Merge pull request \fI\%#35411\fP from eliasp/2016.3\-modules.event\-handle\-file_client\-opt
.IP \(bu 2
8d7244bdd9 modules.event.send(): Also check for \fIfile_client\fP and \fIuse_master_when_local\fP opts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35395\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-11 20:59:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
c032506e6b Merge pull request \fI\%#35395\fP from rallytime/merge\-2016.3
.IP \(bu 2
0d1aa630f1 Lint fix
.IP \(bu 2
cf038ee3fe Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
d9c20c0456 Update freebsd.rst (\fI\%#35394\fP)
.IP \(bu 2
a375dd7e1f Clean up open filehandles (\fI\%#35359\fP)
.IP \(bu 2
9ea7a34c30 Merge pull request \fI\%#35339\fP from isbm/isbm\-2015.8\-minion\-importerror\-fix
.INDENT 2.0
.IP \(bu 2
12af60b7be Fix continuous minion restart if a dependency wasn\(aqt installed
.UNINDENT
.IP \(bu 2
fd9b05ace4 Merge pull request \fI\%#35357\fP from twangboy/file.recurse.clean.2015.8
.INDENT 2.0
.IP \(bu 2
d328ec0157 Fix file.recurse with clean: True
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35226\fP: (\fI\%mathieubouchard\fP) Do not throw an exception when an invalid requisite is set (refs: \fI\%#35373\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35373\fP: (\fI\%cachedout\fP) Raise SaltRenderError on bad requisite
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35352\fP: (\fI\%twangboy\fP) Fix file.recurse with clean: True  on Windows (2016.3)
@ \fI2016\-08\-11 00:46:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
72f3548671 Merge pull request \fI\%#35352\fP from twangboy/file.recurse.clean
.IP \(bu 2
ecad616d08 Fix file.recurse with clean: True
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35356\fP: (\fI\%jfindlay\fP) document log levels and warn on all logging below info
@ \fI2016\-08\-11 00:45:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
0fcfc70cc8 Merge pull request \fI\%#35356\fP from jfindlay/log_levels
.IP \(bu 2
2fc3a55338 utils.verify.verify_log: warn at all levels less than info
.IP \(bu 2
72a3f18a2e log.setup: minor optimization
.IP \(bu 2
66332510c6 doc.ref.configuration.logging: document log levels
.IP \(bu 2
93616eff3e doc.ref.configuration.logging: fix formatting
.IP \(bu 2
472a2d31de doc.ref.configuration.logging: cleanup formatting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35358\fP: (\fI\%twangboy\fP) Update libsodium deps
@ \fI2016\-08\-11 00:36:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
2f7be03053 Merge pull request \fI\%#35358\fP from twangboy/update_libsodium_deps
.IP \(bu 2
d120a8906f Add vcredist 14 dlls
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35336\fP: (\fI\%Sylvain303\fP) documentation state.file.managed parameter template not reflecting TEMPLATE_REGISTRY (refs: \fI\%#35360\fP, \fI\%#35498\fP, \fI\%#35406\fP, #saltstack/salt\(ga#35360\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#35360\fP: (\fI\%rallytime\fP) Add all template registery templates to file.managed docs (refs: \fI\%#35498\fP)
@ \fI2016\-08\-11 00:35:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
f9e03b9c59 Merge pull request \fI\%#35360\fP from rallytime/fix\-35336
.IP \(bu 2
30badb5402 Add all template registery templates to file.managed docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24745\fP: (\fI\%The\-Loeki\fP) RFC: disk versus blockdev (refs: \fI\%#24893\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#25267\fP: (\fI\%jfindlay\fP) Disk module improvements (refs: \fI\%#35361\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35362\fP: (\fI\%rallytime\fP) Correct deprecation version tags
@ \fI2016\-08\-11 00:34:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35361\fP: (\fI\%rallytime\fP) Blockdev deprecations (refs: \fI\%#35362\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25267\fP: (\fI\%jfindlay\fP) Disk module improvements (refs: \fI\%#35362\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24893\fP: (\fI\%The\-Loeki\fP) Contribution: Disk module improvements (refs: #\(gasaltstack/salt\(ga#25267\(ga_\(ga_, \fI\%#25267\fP)
.IP \(bu 2
3c628d3cbc Merge pull request \fI\%#35362\fP from rallytime/correct\-deprecated\-tag
.IP \(bu 2
507827a014 Correct deprecation version tags
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35347\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-10 20:07:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
87e29188c0 Merge pull request \fI\%#35347\fP from rallytime/merge\-2016.3
.IP \(bu 2
a651962e95 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
4618b433e9 Merge pull request \fI\%#35323\fP from thatch45/ssh_crazy
.INDENT 2.0
.IP \(bu 2
8a5b47b5d7 Collect all error data from the wfuncs call
.IP \(bu 2
11864c31b7 suppress a stack trace to show clean ssh error
.IP \(bu 2
9fbfa282fa wow this solves an issue!
.UNINDENT
.IP \(bu 2
cfae862972 Merge pull request \fI\%#35325\fP from kev009/fbsd\-netstat\-route
.INDENT 2.0
.IP \(bu 2
0d49dd3c29 Fix fbsd netstat route on fbsd 10+
.UNINDENT
.IP \(bu 2
244c3bd495 Pass port to ssh.check_known_host, closes \fI\%#35264\fP (\fI\%#35301\fP)
.IP \(bu 2
243909f39d file.recurse: Do not convert octal mode string to int (\fI\%#35309\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35334\fP: (\fI\%cachedout\fP) Restore random_master functionality
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35331\fP: (\fI\%hu\-dabao\fP) fix 35165, salt\-run jobs.exit_success jid is broken
@ \fI2016\-08\-10 11:50:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
78dfd18ec6 Merge pull request \fI\%#35331\fP from hu\-dabao/fix\-35165
.IP \(bu 2
4dcce18d01 fix 35165, salt\-run jobs.exit_success jid is broken
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35318\fP: (\fI\%rallytime\fP) Remove legacy compat docs in mysql pillar since the code was removed already
@ \fI2016\-08\-10 11:34:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30913\fP: (\fI\%justinta\fP) Deprecated code removed.  (refs: \fI\%#35318\fP)
.IP \(bu 2
fcca0b9333 Merge pull request \fI\%#35318\fP from rallytime/remove\-deprecation\-docs
.IP \(bu 2
75f205e485 Remove legacy compat docs in mysql pillar since the code was removed already
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35329\fP: (\fI\%hu\-dabao\fP) sys.doc will skip all not connected minions
@ \fI2016\-08\-10 11:18:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
3446dc9ec6 Merge pull request \fI\%#35329\fP from hu\-dabao/fix\-tiny\-salt\-cli
.IP \(bu 2
4b806a70ea sys.doc will skip all not connected minions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35306\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-09 18:50:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
31f7d307a7 Merge pull request \fI\%#35306\fP from rallytime/merge\-2016.3
.IP \(bu 2
2d3eadfe49 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
2efc1b333b Merge pull request \fI\%#35290\fP from terminalmage/issue35051
.INDENT 2.0
.IP \(bu 2
d621aa7b61 Update runner/wheel unit tests to reflect new key in ret dict
.IP \(bu 2
90c12a9c7b Add __orchestration__ key to orch returns for runner/wheel funcs
.IP \(bu 2
7b8c3b86e7 Suppress error about invalid changes data for orchestration jobs
.IP \(bu 2
54a1704d6c Suppress event for wheel/runner funcs executed from orchestration
.IP \(bu 2
f409f62bf2 Accept print_event option in WheelClient.cmd()
.IP \(bu 2
b42b25ccce Add cmd func for RunnerClient
.IP \(bu 2
480065fe00 Add print_event option to client mixins
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35229\fP: (\fI\%lubyou\fP) Ignore import error for pwd module in mac_shadow
@ \fI2016\-08\-09 15:48:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
94529d0578 Merge pull request \fI\%#35229\fP from lubyou/fix\-mac_shadow
.IP \(bu 2
b45039c240 Do not blindly ignore import failures
.IP \(bu 2
c1d5670b79 Ignore import error for pwd module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35227\fP: (\fI\%isbm\fP) Isbm osfinger ubuntu fix
@ \fI2016\-08\-09 15:38:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce7aeb6ca4 Merge pull request \fI\%#35227\fP from isbm/isbm\-osfinger\-ubuntu\-fix
.IP \(bu 2
fe5da97283 Lintfix: E8303
.IP \(bu 2
6eea62d4ec Add a deprecation warning
.IP \(bu 2
4dc45f2509 Add grains unit test for Ubuntu systems
.IP \(bu 2
3904e4b81c Bugfix: Ubuntu osfinger should contain also minor version
.IP \(bu 2
a69f97f9ad Bugfix: use oscodename if lsb_distrib_codename key exists empty.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35286\fP: (\fI\%hu\-dabao\fP) fix 34425, a bug that sys.doc cannot output format
@ \fI2016\-08\-09 09:50:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
47e328f755 Merge pull request \fI\%#35286\fP from hu\-dabao/fix\-34425
.IP \(bu 2
86fb359f58 fix 34425, a bug that sys.doc cannot output format
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27294\fP: (\fI\%stenstad\fP) salt\-cloud should support Openstack Identitiy v3 for authentication (refs: \fI\%#35213\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35275\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35213\fP to 2016.3
@ \fI2016\-08\-09 00:02:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35213\fP: (\fI\%gtmanfred\fP) add identity v3 support to openstack driver (refs: \fI\%#35275\fP)
.IP \(bu 2
d79cb1b4ec Merge pull request \fI\%#35275\fP from rallytime/bp\-35213
.IP \(bu 2
9b9fc508cc add identity v3 support to openstack driver
.IP \(bu 2
\fBPR\fP \fI\%#35278\fP: (\fI\%dmurphy18\fP) Increase timeout for siging to 10 seconds when signing rpm packages
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35276\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-08 18:20:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
959a00e4b7 Merge pull request \fI\%#35276\fP from rallytime/merge\-2016.3
.IP \(bu 2
2b4c156df1 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
f8158124d5 Merge pull request \fI\%#35211\fP from cachedout/issue_31074
.INDENT 2.0
.IP \(bu 2
6f53232e6d Better error handling and a workaround for group mismatch.
.IP \(bu 2
5b56a4acf7 Docs
.IP \(bu 2
ae04e7aaeb Initial POC
.UNINDENT
.IP \(bu 2
3e4eb13daa Merge pull request \fI\%#35271\fP from bobrik/default\-output\-profile
.INDENT 2.0
.IP \(bu 2
6cdee21036 Default state_output_profile to True everywhere, closes \fI\%#35166\fP
.UNINDENT
.IP \(bu 2
673e1aa1aa Merge pull request \fI\%#35233\fP from terminalmage/issue32719
.INDENT 2.0
.IP \(bu 2
730a077041 Do not attempt to get fqdn_ip{4,6} grains when ipv{4,6} grains are empty
.UNINDENT
.IP \(bu 2
cdf3c0fe73 Merge pull request \fI\%#35202\fP from multani/fix/test\-doc
.INDENT 2.0
.IP \(bu 2
1642dba5d1 doc: fix broken links in the test documentation page
.UNINDENT
.IP \(bu 2
e1331cd2a3 Merge pull request \fI\%#35236\fP from rallytime/bp\-35119
.INDENT 2.0
.IP \(bu 2
9ade78de7b Revise unnecessary code duplication
.IP \(bu 2
7c15f5b20a Fix formatting
.IP \(bu 2
64f93f8938 Assume two EVRs are equal if E and V are equal but one R is missing.
.UNINDENT
.IP \(bu 2
4f2b8aa5b6 Merge pull request \fI\%#35240\fP from derekmaciel/bp\-35225
.INDENT 2.0
.IP \(bu 2
9ed47f713a Add missing documentation for pkg.installed
.UNINDENT
.IP \(bu 2
4bcfaa97d0 Merge pull request \fI\%#35241\fP from terminalmage/gitfs\-fixes
.INDENT 2.0
.IP \(bu 2
e05648cc2d Break from loop when file is found
.IP \(bu 2
6764a88601 Ensure that failed recursion results in no blob object being returned
.UNINDENT
.IP \(bu 2
f6d7360e0b Merge pull request \fI\%#35245\fP from rallytime/bp\-35039
.INDENT 2.0
.IP \(bu 2
51ab9cd6d4 Add saltenv support to module.run
.UNINDENT
.IP \(bu 2
d65a5c7134 Merge pull request \fI\%#35249\fP from terminalmage/issue35214
.INDENT 2.0
.IP \(bu 2
bcd5129e9f Fix regression in git.latest when update is fast\-forward
.IP \(bu 2
e2e8bbbfde Add integration test for \fI\%#35214\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35003\fP: (\fI\%edgan\fP) rabbitmq_user.present broken on Ubuntu 16.04 Xenial (refs: \fI\%#35232\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34481\fP: (\fI\%L4rS6\fP) rabbitmq_user.present with password keyword throws exception (refs: \fI\%#35232\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33588\fP: (\fI\%whytewolf\fP) rabbitmq_user.present error  (refs: \fI\%#35232\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35274\fP: (\fI\%rallytime\fP) Lint fixes for 2016.3 branch
@ \fI2016\-08\-08 16:45:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35232\fP: (\fI\%theredcat\fP) fix rabbitmq version detection using a package\-agnostic version (refs: \fI\%#35274\fP)
.IP \(bu 2
157939d5b0 Merge pull request \fI\%#35274\fP from rallytime/lint\-2016.3
.IP \(bu 2
0d3d711e9c Lint fixes for 2016.3 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35269\fP: (\fI\%meaksh\fP) Checksum validation for zypper pkg.download in 2016.3 and develop
@ \fI2016\-08\-08 14:45:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
c58bb18624 Merge pull request \fI\%#35269\fP from meaksh/checksum\-during\-zypper\-pkg\-download\-for\-2016.3\-and\-develop
.IP \(bu 2
18700e821e unit tests for rpm.checksum() and zypper.download()
.IP \(bu 2
c3f29ab205 checksum validation during zypper pkg.download
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35197\fP: (\fI\%vutny\fP) Make \fIpkgbuild.repo\fP state recognize \fIcreaterepo\fP command return code
@ \fI2016\-08\-06 23:20:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
d3f2ce2a1a Merge pull request \fI\%#35197\fP from vutny/pkgbuild\-repo\-failure\-detection
.IP \(bu 2
a5f6630e97 Make \fIpkgbuild.repo\fP state recognize \fIcreaterepo\fP command return code
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34446\fP: (\fI\%mirceaulinic\fP) Proxy minions & straight minion using the same caching directory (refs: \fI\%#35178\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35178\fP: (\fI\%cro\fP) Add append_minionid_config_dirs option
@ \fI2016\-08\-06 22:21:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
f004b831d2 Merge pull request \fI\%#35178\fP from cro/proxy_cache_fix2
.IP \(bu 2
84cc7d67c0 Add documentation for append_minionid_config_dirs.
.IP \(bu 2
f0961e741e Merge with 2016.3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35234\fP: (\fI\%Sylvain303\fP) Bug: module disk.wipe don\(aqt wipe the filesystem information (refs: \fI\%#35253\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35259\fP: (\fI\%cachedout\fP) Fixup 35253
@ \fI2016\-08\-06 21:59:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35253\fP: (\fI\%abednarik\fP) Fix disk.wipe missing option. (refs: \fI\%#35259\fP)
.IP \(bu 2
6eb1c48469 Merge pull request \fI\%#35259\fP from cachedout/fixup_35253
.IP \(bu 2
104116f464 Add release notes and include entry about disk.wipe fix
.IP \(bu 2
6714e8f386 Fix mock call in disk wipe test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35234\fP: (\fI\%Sylvain303\fP) Bug: module disk.wipe don\(aqt wipe the filesystem information (refs: \fI\%#35253\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35253\fP: (\fI\%abednarik\fP) Fix disk.wipe missing option. (refs: \fI\%#35259\fP)
@ \fI2016\-08\-06 21:55:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
4e7d7f8e4c Merge pull request \fI\%#35253\fP from abednarik/disk_wipe_fix
.IP \(bu 2
ff33df4ba1 Fix disk.wipe missing option.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35206\fP: (\fI\%hu\-dabao\fP) Make the log level back to warning for unclassified exc
@ \fI2016\-08\-06 21:40:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
eeede82109 Merge pull request \fI\%#35206\fP from hu\-dabao/fix\-exc\-log
.IP \(bu 2
676be7d711 Make the log level back to warning for unclassified exc
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35196\fP: (\fI\%isbm\fP) Deprecate status.uptime one version later
@ \fI2016\-08\-06 08:39:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
21808e27d5 Merge pull request \fI\%#35196\fP from isbm/isbm\-too\-fast\-uptime\-deprecation
.IP \(bu 2
6f3a32dace Deprecate status.uptime one version later
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35207\fP: (\fI\%eliasp\fP) Handle exceptions in \fI_get_virtual()\fP and in \fI_get_virtual()\fP consumers
@ \fI2016\-08\-06 08:29:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
100645e557 Merge pull request \fI\%#35207\fP from eliasp/2016.3\-modules.aptpkg\-handle\-exceptions
.IP \(bu 2
2f11df98ca Handle exceptions in \fI_get_virtual()\fP and in \fI_get_virtual()\fP consumers
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35003\fP: (\fI\%edgan\fP) rabbitmq_user.present broken on Ubuntu 16.04 Xenial (refs: \fI\%#35232\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34481\fP: (\fI\%L4rS6\fP) rabbitmq_user.present with password keyword throws exception (refs: \fI\%#35232\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33588\fP: (\fI\%whytewolf\fP) rabbitmq_user.present error  (refs: \fI\%#35232\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35232\fP: (\fI\%theredcat\fP) fix rabbitmq version detection using a package\-agnostic version (refs: \fI\%#35274\fP)
@ \fI2016\-08\-06 08:13:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
7302a8a6e5 Merge pull request \fI\%#35232\fP from theredcat/fix\-rabbitmq\-version\-detection
.IP \(bu 2
f75eb2ecc7 Fix runas in code order and make the check_password work with the new >3.5.7 version
.IP \(bu 2
4d8119b88b fix rabbitmq version detection using a package\-agnostic version
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35244\fP: (\fI\%rallytime\fP) Back\-port \fI\%#31677\fP to 2016.3
@ \fI2016\-08\-06 07:53:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31677\fP: (\fI\%miihael\fP) Return correct value for services that must be enabled in Systemd (refs: \fI\%#35244\fP)
.IP \(bu 2
2e9fa3799c Merge pull request \fI\%#35244\fP from rallytime/bp\-31677
.IP \(bu 2
45d563d5ac Return correct value for services that must be enabled in Systemd, not in SysV
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35182\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-03 20:57:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd0496eef5 Merge pull request \fI\%#35182\fP from rallytime/merge\-2016.3
.IP \(bu 2
c35974f78f Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
67d8dd0fd0 Don\(aqt discard running beacons config when listing becaons (\fI\%#35174\fP)
.IP \(bu 2
3754550dd2 Add missing CLI Examples to aws_sqs module funcs (\fI\%#35173\fP)
.IP \(bu 2
4967ed275f doc version update to 2015.8.11, updates to release notes (\fI\%#35145\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35150\fP: (\fI\%rallytime\fP) Start release notes for 2016.3.3
@ \fI2016\-08\-03 13:46:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
f9f92ad326 Merge pull request \fI\%#35150\fP from rallytime/2016.3.3\-release\-notes
.IP \(bu 2
a64026fc99 Start release notes for 2016.3.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35157\fP: (\fI\%hu\-dabao\fP) master returned from func should be a string as designed so far
@ \fI2016\-08\-03 13:29:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
518ecf897a Merge pull request \fI\%#35157\fP from hu\-dabao/func\-return\-string
.IP \(bu 2
a7506af4c9 master returned from func should be a string as designed so far
.IP \(bu 2
\fBPR\fP \fI\%#35147\fP: (\fI\%jacobhammons\fP) doc version updated to 2016.3.2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35136\fP: (\fI\%s0undt3ch\fP) Don\(aqt restart processes if the manager is not set to restart them
@ \fI2016\-08\-02 18:40:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
dc7d7db3d5 Merge pull request \fI\%#35136\fP from s0undt3ch/2016.3
.IP \(bu 2
7b8bf2d2b4 Don\(aqt restart processes if the manager is not set to restart them
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35133\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-02 18:06:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf04bd3316 Merge pull request \fI\%#35133\fP from rallytime/merge\-2016.3
.IP \(bu 2
0d5f0b6016 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
81845ee31d Merge pull request \fI\%#35114\fP from terminalmage/git_pillar\-env\-remap\-docs
.INDENT 2.0
.IP \(bu 2
5951554e9f Add clarification docs on a common git_pillar misconfiguration
.UNINDENT
.IP \(bu 2
88a9fb1b31 Merge pull request \fI\%#34768\fP from hrumph/bad\-installed\-state
.INDENT 2.0
.IP \(bu 2
e1fcb8311d Put pkg.latest_version in try/except structure Move refreshed or refresh to different spot (just for code tidyness)
.IP \(bu 2
e0b6261659 changed name of variable \(aqrefreshed\(aq to \(aqwas_refreshed\(aq
.IP \(bu 2
340110b4b4 Move check for rtag to outermost\-nesting in function
.IP \(bu 2
ac67c6b493 Lint fix
.IP \(bu 2
0435a1375e Get rid of repetition in code by using new \(dqrefreshed\(dq variable instead
.IP \(bu 2
3b1dc978e2 Lint fix
.IP \(bu 2
a9bd1b92b9 lint fixes
.IP \(bu 2
71d69343ef Fixes \fI\%#34767\fP
.UNINDENT
.IP \(bu 2
343576408f Merge pull request \fI\%#35043\fP from rallytime/new\-release\-notes
.INDENT 2.0
.IP \(bu 2
bdcc81a384 Start release notes file for 2015.8.12
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35120\fP: (\fI\%kstreee\fP) The \(aq_handle_event_socket_recv\(aq function in Salt Api is missing first data of stream.
@ \fI2016\-08\-02 16:22:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd91006ed7 Merge pull request \fI\%#35120\fP from kstreee/fix\-missing\-first\-stream\-data
.IP \(bu 2
28f793caac Fix missing first data in stream when subscribing stream using a function \(aqread_async\(aq.
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35011\fP: (\fI\%nishigori\fP) Fix docstring for code\-block of rst (refs: \fI\%#35131\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35131\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35011\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#35011\fP: (\fI\%nishigori\fP) Fix docstring for code\-block of rst (refs: \fI\%#35131\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35110\fP: (\fI\%hu\-dabao\fP) Do not return job status back to master for master_alive and master_failback schedules
@ \fI2016\-08\-02 07:49:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
77b1f43b0d Merge pull request \fI\%#35110\fP from hu\-dabao/master\-check\-lighter
.IP \(bu 2
3a3b66e27d don\(aqt return job status back to master for master_alive and master_failback schedules
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35104\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-01 18:56:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
94a983f129 Merge pull request \fI\%#35104\fP from rallytime/merge\-2016.3
.IP \(bu 2
dda2c32325 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
848bf0272f Merge pull request \fI\%#35050\fP from terminalmage/fix\-saltdev\-arg
.INDENT 2.0
.IP \(bu 2
40cfa7cf17 Avoid needlessly running 2 argspecs in salt.utils.format_call()
.IP \(bu 2
fd186b7e4c Pass environment as \(aqsaltdev\(aq if runner/wheel func accepts a saltdev argument
.IP \(bu 2
951b52ab93 Pass __env__ from saltmod orch states to to saltutil.{runner,wheel}
.UNINDENT
.IP \(bu 2
2144178ae0 Merge pull request \fI\%#35066\fP from jfindlay/postgres_log
.INDENT 2.0
.IP \(bu 2
c2c442234f returners.postgres_local_cache: do not log in __virtual__
.UNINDENT
.IP \(bu 2
7121618142 Merge pull request \fI\%#35024\fP from bobrik/daemon\-reload\-fix
.INDENT 2.0
.IP \(bu 2
c300615e9d Cache systemd unit update check per unit, closes \fI\%#34927\fP
.UNINDENT
.IP \(bu 2
865c29f126 Expressly deny a minion if a key cannot be found instead of raising stacktrace (\fI\%#35026\fP)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32761\fP: (\fI\%notpeter\fP) Ubuntu 16.04 Xenial Xerus Support (refs: #\(gasaltstack/salt#33870\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#33870\fP: (\fI\%rallytime\fP) Add note about Xenial packages to 2016.3.0 release notes (refs: \fI\%#35105\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35105\fP: (\fI\%rallytime\fP) Update 2016.3.0 release notes with repo.saltstack.com Xenial pkg availability
@ \fI2016\-08\-01 17:26:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c056a829e Merge pull request \fI\%#35105\fP from rallytime/update\-2016.3.0\-release\-notes
.IP \(bu 2
fbaff3e98e Update 2016.3.0 release notes with repo.saltstack.com Xenial pkg availability
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35059\fP: (\fI\%vutny\fP) Add \fIfun_args\fP field to events generated by execution of Master modules
@ \fI2016\-08\-01 13:01:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f8a0fd1e7 Merge pull request \fI\%#35059\fP from vutny/event\-function\-args
.IP \(bu 2
19d080445b Add \fIfun_args\fP field to events generated by execution of Master modules
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34955\fP: (\fI\%lubyou\fP) force dism to always output english text
@ \fI2016\-08\-01 12:54:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
d137c4b986 Merge pull request \fI\%#34955\fP from lubyou/fix\-dism\-on\-non\-english\-systems
.IP \(bu 2
63c974a3d0 add missing comma
.IP \(bu 2
775ea73578 fix unit tests
.IP \(bu 2
51869807f1 force dism to always output english text
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35078\fP: (\fI\%jacobweinstock\fP) added missing non\-keyword argument skip_verify to __get_artifact func…
@ \fI2016\-08\-01 12:22:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
ff7ddf0b68 Merge pull request \fI\%#35078\fP from jacobweinstock/fix\-missing\-non\-keyword\-argument
.IP \(bu 2
c40314ba80 added missing non\-keyword argument skip_verify to __get_artifact function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35008\fP: (\fI\%hu\-dabao\fP) Fix multimaster failover on more than two masters and failback behaviour
@ \fI2016\-07\-29 16:34:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
878e200cd9 Merge pull request \fI\%#35008\fP from hu\-dabao/fix\-multimaster
.IP \(bu 2
12da890910 Fix multimaster failover on more than two masters and failback behaviour
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#33536\fP: (\fI\%murzick\fP) pkgrepo.managed does not disable a yum repo with \(dqdisabled: True\(dq (refs: \fI\%#35055\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33536\fP: (\fI\%murzick\fP) pkgrepo.managed does not disable a yum repo with \(dqdisabled: True\(dq (refs: \fI\%#35055\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35055\fP: (\fI\%galet\fP) \fI\%#33536\fP pkgrepo.managed does not disable a yum repo with \(dqdisabled: True\(dq
@ \fI2016\-07\-29 15:40:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
11ed147448 Merge pull request \fI\%#35055\fP from galet/2016.3
.IP \(bu 2
d70796bbfe \fI\%#33536\fP pkgrepo.managed does not disable a yum repo with \(dqdisabled: True\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35039\fP: (\fI\%whiteinge\fP) Add saltenv support to module.run (refs: \fI\%#35245\fP)
@ \fI2016\-07\-29 14:01:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
ebaee39b2b Merge pull request \fI\%#35039\fP from whiteinge/module\-run\-saltenv
.IP \(bu 2
7ef287e09e Add saltenv support to module.run
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35046\fP: (\fI\%eliasp\fP) Prevent backtrace in \fIsalt.states.network\fP
@ \fI2016\-07\-29 13:59:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
32ed78a399 Merge pull request \fI\%#35046\fP from eliasp/2016.3\-salt.states.network\-prevent\-backtrace
.IP \(bu 2
1542cd5124 Prevent backtrace in \fIsalt.states.network\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35054\fP: (\fI\%lubyou\fP) Only fail user lookup is the user parameter is required
@ \fI2016\-07\-29 13:58:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
f34bb7a8de Merge pull request \fI\%#35054\fP from lubyou/fix\-win_dacl\-disable_inheritance
.IP \(bu 2
1e4e856fb2 Only fail user lookup is the user parameter is required
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35029\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-28 18:01:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
bee303db51 Merge pull request \fI\%#35029\fP from rallytime/merge\-2016.3
.IP \(bu 2
65f9365ee0 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
2b511f3013 Merge pull request \fI\%#35000\fP from rallytime/bp\-33875
.INDENT 2.0
.IP \(bu 2
35696ad637 Pylint fix
.IP \(bu 2
f9fd6ddd8a Fixup \fI\%#33875\fP
.IP \(bu 2
56b1f6c651 Fix naive fileserver map diff algorithm
.UNINDENT
.IP \(bu 2
837bc6ba7d Merge pull request \fI\%#34994\fP from rallytime/bp\-34835
.INDENT 2.0
.IP \(bu 2
9268a793de same thing for the mine in salt\-ssh
.IP \(bu 2
3e11e19714 Fix the mine in salt ssh
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35021\fP: (\fI\%terminalmage\fP) Don\(aqt add \(aq.\(aq to strerror when passed string ends in ? or !
.IP \(bu 2
\fBPR\fP \fI\%#34983\fP: (\fI\%eliasp\fP) modules.slack.post_message: Allow sending messages to direct\-message …
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34996\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-07\-27 19:03:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
05cfb1cefc Merge pull request \fI\%#34996\fP from rallytime/merge\-2016.3
.IP \(bu 2
a7d4f93697 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
b58c663d8d Merge pull request \fI\%#34991\fP from cachedout/ssh_timeout
.INDENT 2.0
.IP \(bu 2
39cd8da399 Lint diff against salt\-testing
.IP \(bu 2
443e5cdde2 Add timeout to ssh tests
.UNINDENT
.IP \(bu 2
5f8370ae8d Refine errors in client (\fI\%#34976\fP)
.IP \(bu 2
a83cdf9339 Merge pull request \fI\%#34831\fP from thatch45/recoverssh
.IP \(bu 2
fa73041a49 If the thin does not match, then redeploy, don\(aqt error
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34987\fP: (\fI\%eliasp\fP) salt.states.slack: check correct result attribute
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34526\fP: (\fI\%danielmotaleite\fP) salt\-ssh + mine = weird error (refs: \fI\%#34835\fP, #saltstack/salt\(ga#34835\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#34835\fP: (\fI\%thatch45\fP) Make the mine and publish combine minion and master opts in salt\-ssh (refs: \fI\%#34994\fP)
@ \fI2016\-07\-27 17:25:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
edeb0eda36 Merge pull request \fI\%#34835\fP from thatch45/34526_
.IP \(bu 2
1d2477df05 same thing for the mine in salt\-ssh
.IP \(bu 2
6b6c5ff278 Fix the mine in salt ssh
.UNINDENT
.UNINDENT
.SS Salt 2016.3.4 Release Notes
.sp
Version 2016.3.4 is a bugfix release for \fI\%2016.3.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB275\fP
.IP \(bu 2
Total Issue References: \fB119\fP
.IP \(bu 2
Total PR References: \fB374\fP
.IP \(bu 2
Contributors: \fB80\fP (\fI\%BenoitKnecht\fP, \fI\%Ch3LL\fP, \fI\%DavidWittman\fP, \fI\%DmitryKuzmenko\fP, \fI\%Jlin317\fP,
\fI\%Kimamisa\fP, \fI\%UtahDave\fP, \fI\%aaronm\-cloudtek\fP, \fI\%abednarik\fP, \fI\%ahammond\fP, \fI\%alertedsnake\fP,
\fI\%alexander\-bauer\fP, \fI\%amontalban\fP, \fI\%basepi\fP, \fI\%bl4ckcontact\fP, \fI\%bx2\fP, \fI\%cachedout\fP,
\fI\%clarkperkins\fP, \fI\%clinta\fP, \fI\%cro\fP, \fI\%damon\-atkins\fP, \fI\%danlsgiga\fP, \fI\%darkalia\fP, \fI\%dmurphy18\fP,
\fI\%do3meli\fP, \fI\%edhgoose\fP, \fI\%efficks\fP, \fI\%eliasp\fP, \fI\%eradman\fP, \fI\%fix7\fP, \fI\%galet\fP, \fI\%goestin\fP,
\fI\%gtmanfred\fP, \fI\%hrumph\fP, \fI\%hu\-dabao\fP, \fI\%isbm\fP, \fI\%jackywu\fP, \fI\%jacobhammons\fP, \fI\%jbonachera\fP, \fI\%jf\fP,
\fI\%jfindlay\fP, \fI\%jizhilong\fP, \fI\%justinta\fP, \fI\%kstreee\fP, \fI\%l2ol33rt\fP, \fI\%lomeroe\fP, \fI\%lorengordon\fP,
\fI\%maximeguillet\fP, \fI\%meaksh\fP, \fI\%mikeadamz\fP, \fI\%mirceaulinic\fP, \fI\%morganwillcock\fP, \fI\%mrproper\fP,
\fI\%multani\fP, \fI\%nvtkaszpir\fP, \fI\%oba11\fP, \fI\%onorua\fP, \fI\%opdude\fP, \fI\%orymate\fP, \fI\%oz123\fP,
\fI\%pass\-by\-value\fP, \fI\%pbdeuchler\fP, \fI\%rallytime\fP, \fI\%roosri\fP, \fI\%silenius\fP, \fI\%skizunov\fP, \fI\%slinn0\fP,
\fI\%stanislavb\fP, \fI\%swiftgist\fP, \fI\%techhat\fP, \fI\%terminalmage\fP, \fI\%thatch45\fP, \fI\%theredcat\fP, \fI\%ticosax\fP,
\fI\%twangboy\fP, \fI\%vutny\fP, \fI\%whiteinge\fP, \fI\%xbglowx\fP, \fI\%xiaoanyunfei\fP, \fI\%yhekma\fP)
.UNINDENT
.SS Known Issues
.sp
The Salt Minion does not clean up files in \fB/tmp\fP when rendering templates.
This potentially results in either running out of disk space or running out of
inodes. Please see \fI\%issue 37541\fP for more information. This bug was fixed with
\fI\%PR 37540\fP, which will be available in the \fB2016.3.5\fP release of
Salt.
.sp
The release of the \fBbootstrap\-salt.sh\fP script that is included with 2016.3.4
release has a bug in it that fails to install salt correctly for git installs
using tags in the 2015.5 branch.  This bug has not been fixed in the
\fI\%salt\-bootstrap repository\fP yet, but the \fI\%previous bootstrap release\fP
(v2016.08.16) does not contain this bug.
.SS Changes
.INDENT 0.0
.IP \(bu 2
The \fIdisk.wipe\fP execution module function has been modified
so that it correctly wipes a disk.
.IP \(bu 2
Add ability to clone from a snapshot to the VMWare salt\-cloud driver.
.IP \(bu 2
Add ability to specify disk backing mode in the VMWare salt cloud profile.
.UNINDENT
.SS Changelog for v2016.3.3..v2016.3.4
.sp
\fIGenerated at: 2018\-05\-27 04:56:54 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#37285\fP: (\fI\%rallytime\fP) Update 2016.3.4 release notes
.IP \(bu 2
\fBISSUE\fP \fI\%#37281\fP: (\fI\%frogunder\fP) 2016.3.4: Raet Transport not working (refs: \fI\%#37282\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37282\fP: (\fI\%thatch45\fP) add cpub to raet event for compat
@ \fI2016\-10\-27 21:33:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
3b62a89e45 Merge pull request \fI\%#37282\fP from thatch45/raet_cpub
.IP \(bu 2
90f778dbc1 Add func for compat with main event system
.IP \(bu 2
8e52f425e4 add cpub to raet event for compat
.IP \(bu 2
\fBPR\fP \fI\%#37278\fP: (\fI\%jfindlay\fP) update 2016.3.4 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37252\fP: (\fI\%vutny\fP) Set logging level to \(aqinfo\(aq for message about init system detection
@ \fI2016\-10\-27 06:15:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0ce3de50c Merge pull request \fI\%#37252\fP from vutny/suppress\-init\-grain\-error
.IP \(bu 2
3f20cc01ed Set logging level to \(aqinfo\(aq for message about init system detection
.IP \(bu 2
\fBPR\fP \fI\%#37259\fP: (\fI\%rallytime\fP) [2016.3] Update man pages for the 2016.3 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37257\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-10\-26 17:32:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
2087cfce90 Merge pull request \fI\%#37257\fP from rallytime/merge\-2016.3
.IP \(bu 2
2066f10d7b Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
f49ccdf30f Merge pull request \fI\%#37234\fP from rallytime/bp\-37167
.INDENT 2.0
.IP \(bu 2
a7dbb5bfc9 fixes pkgrepo for fedora>22 \fI\%saltstack/salt#31240\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37238\fP: (\fI\%cmclaughlin\fP) Restarting master causes minion to hang (refs: \fI\%#37254\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#37192\fP: (\fI\%Ch3LL\fP) 2016.3.4: Windows minion does not kill process running in foreground (refs: \fI\%#37254\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#37191\fP: (\fI\%Ch3LL\fP) 2016.3.4: Multi\-Master Failover minion hangs when masters not running (refs: \fI\%#37254\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#35480\fP: (\fI\%jelenak\fP) 200 processes of salt\-master (2016.3.2) (refs: \fI\%#36184\fP, \fI\%#36555\fP, \fI\%#37254\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37254\fP: (\fI\%DmitryKuzmenko\fP) Bugs/37191 minion hangs
@ \fI2016\-10\-26 16:28:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea6155c3f4 Merge pull request \fI\%#37254\fP from DSRCorporation/bugs/37191_minion_hangs
.IP \(bu 2
9ee24b2d70 Revert \(dqDon\(aqt set the \fIdaemon\fP flag for LoggingQueue process.\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37187\fP: (\fI\%darkalia\fP) Supervisord is considered as \(dqsystemd\(dq in grains (refs: \fI\%#37218\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37218\fP: (\fI\%darkalia\fP) Issue \fI\%#37187\fP Do not parse first /proc/1/cmdline binary if it\(aqs not \fIb…
@ *2016\-10\-26 01:41:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
d1a6bb72ac Merge pull request \fI\%#37218\fP from darkalia/37187_supervisor_2016.3
.IP \(bu 2
a8dfc6bb96 Issue \fI\%#37187\fP Do not parse first /proc/1/cmdline binary if it\(aqs not *bin/init and set supervisord
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37239\fP: (\fI\%Ch3LL\fP) Fix cloud tests timeout
@ \fI2016\-10\-26 01:11:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
760ed9f56d Merge pull request \fI\%#37239\fP from Ch3LL/fix_cloud_timeout
.IP \(bu 2
394fccf556 fix run_cloud timeout
.IP \(bu 2
23947c5944 change timeout for cloud tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37244\fP: (\fI\%rallytime\fP) Update bootstrap release to 2016.10.25
@ \fI2016\-10\-26 00:46:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c5f619398 Merge pull request \fI\%#37244\fP from rallytime/update\-bootstrap
.IP \(bu 2
f728a5bc7b Update bootstrap release to 2016.10.25
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36334\fP: (\fI\%pass\-by\-value\fP) Add ability to specify disk backing mode for VMware cloud profile (refs: \fI\%#37245\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37245\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36334\fP to 2016.3
@ \fI2016\-10\-26 00:41:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36334\fP: (\fI\%pass\-by\-value\fP) Add ability to specify disk backing mode for VMware cloud profile (refs: \fI\%#37245\fP)
.IP \(bu 2
bb7caf8c42 Merge pull request \fI\%#37245\fP from rallytime/bp\-36334
.IP \(bu 2
f64ca3c442 Update release notes and version added
.IP \(bu 2
0a3d266d6b Add ability to specify disk backing mode for VMware cloud profile
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37132\fP: (\fI\%bl4ckcontact\fP) Incorrect flag defined for disabling AD computer account in win_system.py (refs: \fI\%#37154\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37233\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37154\fP to 2016.3
@ \fI2016\-10\-25 18:32:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37154\fP: (\fI\%bl4ckcontact\fP) modules.win_system.py: Fix flag disabling AD Computer objects (refs: \fI\%#37233\fP)
.IP \(bu 2
3c94315d35 Merge pull request \fI\%#37233\fP from rallytime/bp\-37154
.IP \(bu 2
849af162f1 modules.win_system.py: Fix flag disabling AD Computer objects
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37232\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37153\fP to 2016.3
@ \fI2016\-10\-25 18:32:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37153\fP: (\fI\%eradman\fP) Update configuration examples for Joyent (refs: \fI\%#37232\fP)
.IP \(bu 2
94852f2eb1 Merge pull request \fI\%#37232\fP from rallytime/bp\-37153
.IP \(bu 2
3829b7592f Update configuration examples for Joyent
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37228\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-10\-25 18:22:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
a913eed92a Merge pull request \fI\%#37228\fP from rallytime/merge\-2016.3
.IP \(bu 2
b99d6733b6 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
d608465d77 Merge pull request \fI\%#37178\fP from isbm/isbm\-fix\-saltapi\-ssh\-crash
.INDENT 2.0
.IP \(bu 2
44da411c3a Do not prematurily raise an exception, let the main loop take care of it instead
.IP \(bu 2
ee48deeded Do not restart the whole thing if roster is not around
.IP \(bu 2
b8f4e46920 Fix PEP8
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37213\fP: (\fI\%cachedout\fP) More salttesting fixes
@ \fI2016\-10\-25 07:53:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
6aaf6bf399 Merge pull request \fI\%#37213\fP from cachedout/more_salttesting_fixes
.IP \(bu 2
0bbf06bd86 Lint fix
.IP \(bu 2
f609917760 Workaround for utils
.IP \(bu 2
a6a24c2b3b Workaround for tornado test startup error
.IP \(bu 2
88bcfa2c0a Fix TCP test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37194\fP: (\fI\%sjorge\fP) function_cache in modules.mine docs? (refs: \fI\%#37207\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37207\fP: (\fI\%cachedout\fP) Correct documentation for mine_functions
@ \fI2016\-10\-25 07:25:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
b448455c31 Merge pull request \fI\%#37207\fP from cachedout/issue_37194
.IP \(bu 2
9fcdf6da94 Correct documentation for mine_functions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37182\fP: (\fI\%Ch3LL\fP) 2016.3.4: multi\-master minion stack trace when killed with ctrl+c (refs: \fI\%#37208\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37208\fP: (\fI\%cachedout\fP) Give multimion a process manager and its own destroy method
@ \fI2016\-10\-25 07:24:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
a5e1c041cc Merge pull request \fI\%#37208\fP from cachedout/issue_37182
.IP \(bu 2
1449770b0b Give multimion a process manager and its own destroy method
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37206\fP: (\fI\%cachedout\fP) Address transport test hang
@ \fI2016\-10\-25 05:25:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
e19ee88b6b Merge pull request \fI\%#37206\fP from cachedout/transport_test_hang
.IP \(bu 2
c4393d5e9e Address transport test hang
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37179\fP: (\fI\%isbm\fP) Fix Salt\-API ssh crash (2016.3)
@ \fI2016\-10\-25 04:52:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
6737fd3ad9 Merge pull request \fI\%#37179\fP from isbm/isbm\-fix\-saltapi\-ssh\-crash\-2016\-3
.IP \(bu 2
28edda457e Do not prematurily raise an exception, let the main loop take care of it instead
.IP \(bu 2
372f2bbd93 Do not restart the whole thing if roster is not around
.IP \(bu 2
8d1450cc47 Fix PEP8
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#37176\fP: (\fI\%guettli\fP) docs for \(dqload tags\(dq explains \(dqimport_yaml\(dq (refs: \fI\%#37183\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37183\fP: (\fI\%gtmanfred\fP) load tags should reference the actual load tags
@ \fI2016\-10\-25 04:38:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
815dfd1c04 Merge pull request \fI\%#37183\fP from gtmanfred/2016.3
.IP \(bu 2
1b7b4b1a0c load tags should reference the actual load tags
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37188\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-10\-25 04:37:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca63376c97 Merge pull request \fI\%#37188\fP from rallytime/merge\-2016.3
.IP \(bu 2
ccb664050d Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
b3e79dcd51 Merge pull request \fI\%#37139\fP from awerner/fix\-spm\-download\-remote\-download
.INDENT 2.0
.IP \(bu 2
a606a42575 Minor style change
.IP \(bu 2
e3916813bb Download spm package from remote repository and save it to cache directory
.UNINDENT
.IP \(bu 2
35b4494157 Merge pull request \fI\%#37162\fP from rallytime/bp\-36823
.INDENT 2.0
.IP \(bu 2
3032a542d9 Use NotifyAccess=all in all unit files
.IP \(bu 2
4826995973 Remove EnvironmentFile and Restart lines from unit files
.IP \(bu 2
3be15694d2 Use Type=notify for debian systemd units
.IP \(bu 2
d58fda6f67 Use control\-group default for killmode
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37186\fP: (\fI\%rallytime\fP) Pylint fix for 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#37175\fP: (\fI\%cachedout\fP) Fix test hang (refs: \fI\%#37186\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37175\fP: (\fI\%cachedout\fP) Fix test hang (refs: \fI\%#37186\fP)
@ \fI2016\-10\-24 09:55:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d7af935e5 Merge pull request \fI\%#37175\fP from cachedout/fix_test_hange
.IP \(bu 2
0fecb5ff2e Remove sleep. Thanks @s0undt3ch
.IP \(bu 2
cedc609503 Fix test suite hang on salt testing
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36866\fP: (\fI\%sjorge\fP) [2016.11.0rc1] salt\-master <> salt\-minion communication borken due to master_alive_interval (refs: \fI\%#37144\fP, \fI\%#37117\fP, \fI\%#37142\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37144\fP: (\fI\%DmitryKuzmenko\fP) Bugs/36866 salt minion communication broken 2016.3
@ \fI2016\-10\-24 03:19:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37142\fP: (\fI\%DmitryKuzmenko\fP) status.master: don\(aqt fail if host_to_ips returns None (refs: \fI\%#37144\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37117\fP: (\fI\%DmitryKuzmenko\fP) Updated host_to_ip to return all the IPs instead of the first one. (refs: \fI\%#37144\fP, \fI\%#37142\fP)
.IP \(bu 2
334313ec64 Merge pull request \fI\%#37144\fP from DSRCorporation/bugs/36866_salt\-minion_communication_broken_2016.3
.IP \(bu 2
87c2e93e40 Don\(aqt fail if host_to_ips returns None.
.IP \(bu 2
f625e6d3a9 Updated host_to_ip to return all the IPs instead of the first one.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37158\fP: (\fI\%jfindlay\fP) add mock for \fIstatus.uptime\fP unit test (refs: \fI\%#37157\fP)
@ \fI2016\-10\-24 03:13:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37157\fP: (\fI\%jfindlay\fP) Implement \fIstatus.uptime\fP on macOS (refs: \fI\%#37158\fP)
.IP \(bu 2
c5d81a8ade Merge pull request \fI\%#37158\fP from jfindlay/mac_skip_uptime
.IP \(bu 2
094eac06eb modules.status.uptime unit test: mock on linux
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37037\fP: (\fI\%mikeadamz\fP) schedule state always reports changed when running in highstate (refs: \fI\%#37098\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37161\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37098\fP to 2016.3
@ \fI2016\-10\-24 03:13:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37098\fP: (\fI\%mikeadamz\fP) Add run_on_start to SCHEDULE_CONF (refs: \fI\%#37161\fP)
.IP \(bu 2
e51f90b459 Merge pull request \fI\%#37161\fP from rallytime/bp\-37098
.IP \(bu 2
36bc2a1ded Add run_on_start to SCHEDULE_CONF
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37159\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37107\fP to 2016.3
@ \fI2016\-10\-22 13:55:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37107\fP: (\fI\%do3meli\fP) use versionadded and deprecated warnings in apache_module (refs: \fI\%#37159\fP)
.IP \(bu 2
b5025c044e Merge pull request \fI\%#37159\fP from rallytime/bp\-37107
.IP \(bu 2
c63126a2f0 removed trailing whitespaces in apache_module.py
.IP \(bu 2
a812cbfea7 use versionadded and deprecated warnings in apache_module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37163\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-10\-22 13:52:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
1e520b3f48 Merge pull request \fI\%#37163\fP from rallytime/merge\-2016.3
.IP \(bu 2
8fff95b3b4 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
a5335a2f15 Merge pull request \fI\%#37137\fP from awerner/fix\-spm\-msgpack
.INDENT 2.0
.IP \(bu 2
52d47cece9 SPM\-METADATA are now loaded as yaml from remote URLs
.UNINDENT
.IP \(bu 2
8c46d69251 Merge pull request \fI\%#37109\fP from meaksh/zypper\-distupgrade\-support\-2015.8
.INDENT 2.0
.IP \(bu 2
330f830c9b Disables \(aqnovendorchange\(aq for old SLEs versions
.IP \(bu 2
01b0a6917c Minor pylint fixes
.IP \(bu 2
7dbb0bd252 Unit tests fixes
.IP \(bu 2
e89982b6d2 Improves \(aqdryrun\(aq outputting. Setting \(aqnovendorchange\(aq as not supported for SLE11
.IP \(bu 2
c5a34cbadf Adds multiple repositories support to \(aqfromrepo\(aq parameter
.UNINDENT
.IP \(bu 2
38fdd28962 Merge pull request \fI\%#37087\fP from vutny/gpg\-fix\-short\-keyid
.INDENT 2.0
.IP \(bu 2
c589cba8a9 salt.modules.gpg: allow getting keys by short key ID
.UNINDENT
.IP \(bu 2
3a37a22366 Merge pull request \fI\%#37088\fP from meaksh/zypper\-distupgrade\-support\-2015.8
.INDENT 2.0
.IP \(bu 2
c0641a4027 Fix in log message
.IP \(bu 2
a092a974da Refactor: Cleanup and pylint fixes
.IP \(bu 2
1331ae5c72 Unit tests for zypper upgrade and dist\-upgrade
.IP \(bu 2
4bcfef2ba2 Adding \(aqdist\-upgrade\(aq support to zypper module
.UNINDENT
.IP \(bu 2
2f29e9e956 Merge pull request \fI\%#37090\fP from zer0def/silence\-prereq\-supervisord\-warnings
.INDENT 2.0
.IP \(bu 2
6a4bfbb485 Silence warnings about \(dq__prerequired__\(dq being an invalid kwarg when using \fIprereq\fP\&. (no refs)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37150\fP: (\fI\%rallytime\fP) Allow the minion test daemons a couple of tries to connect to the master
.IP \(bu 2
\fBPR\fP \fI\%#37152\fP: (\fI\%rallytime\fP) Add note about salt\-bootstrap known issue for 2016.3.4
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37135\fP: (\fI\%aaronm\-cloudtek\fP) Fix example signing policy in salt.states.x509 docs
@ \fI2016\-10\-21 11:45:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
8de7b39b5e Merge pull request \fI\%#37135\fP from Cloudtek/x509\-docs\-fix
.IP \(bu 2
ce87f7311b Fix example signing policy in salt.states.x509 docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37140\fP: (\fI\%vutny\fP) pkgbuild.repo: fix GPG signing with \fIuse_passphrase=False\fP
@ \fI2016\-10\-21 09:37:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
41ae90d3c3 Merge pull request \fI\%#37140\fP from vutny/pkgbuild\-repo\-sign\-with\-no\-passphrase
.IP \(bu 2
409a3100a7 pkgbuild.repo: fix GPG signing with \fIuse_passphrase=False\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37071\fP: (\fI\%vutny\fP) pkgbuild.repo: add \fItimeout\fP parameter for waiting passphrase prompt
@ \fI2016\-10\-21 05:20:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
96a1292a7e Merge pull request \fI\%#37071\fP from vutny/pkgbuild\-repo\-gpg\-sign\-timeout
.IP \(bu 2
cfc3a0ed92 pkgbuild.repo: add \fItimeout\fP parameter for waiting passphrase prompt
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#31454\fP: (\fI\%johje349\fP) Salt Mine memory leak (refs: \fI\%#36024\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#37018\fP: (\fI\%tsaridas\fP) get events from python (refs: \fI\%#37115\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#31454\fP: (\fI\%johje349\fP) Salt Mine memory leak (refs: \fI\%#36720\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37115\fP: (\fI\%DmitryKuzmenko\fP) Backport/36720 fix race condition
@ \fI2016\-10\-21 05:16:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36720\fP: (\fI\%skizunov\fP) Fix race condition when returning events from commands (refs: \fI\%#37115\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36024\fP: (\fI\%DmitryKuzmenko\fP) Don\(aqt subscribe to events if not sure it would read them. (refs: \fI\%#36720\fP)
.IP \(bu 2
274120300d Merge pull request \fI\%#37115\fP from DSRCorporation/backport/36720_fix_race_condition
.IP \(bu 2
d7e3209e13 For IPCClient, remove entry from instance map on close
.IP \(bu 2
82e27634a7 Fix race condition when returning events from commands
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37119\fP: (\fI\%jfindlay\fP) log.setup: only assign user if defined
@ \fI2016\-10\-21 05:14:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36203\fP: (\fI\%xiaoanyunfei\fP) fix owner of MultiprocessingLoggingQueue (refs: \fI\%#37119\fP)
.IP \(bu 2
169a82e62b Merge pull request \fI\%#37119\fP from jfindlay/log_proc_user
.IP \(bu 2
8c29949a0e log.setup: only assign user if defined
.IP \(bu 2
1d503f032c tests.integration: pass opts as a dict
.IP \(bu 2
\fBPR\fP \fI\%#37126\fP: (\fI\%Ch3LL\fP) fix digital ocean image name in profile
.IP \(bu 2
\fBPR\fP \fI\%#37125\fP: (\fI\%jfindlay\fP) add 2016.3.4 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37120\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36246\fP to 2016.3
@ \fI2016\-10\-20 19:38:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36418\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36246\fP to 2016.3 (refs: \fI\%#37120\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36246\fP: (\fI\%twangboy\fP) Fix test_issue_6833_pip_upgrade_pip test on OS X (refs: \fI\%#36418\fP, \fI\%#37120\fP)
.IP \(bu 2
2a35f57be8 Merge pull request \fI\%#37120\fP from rallytime/bp\-36246
.IP \(bu 2
f1c8d98119 Skip weird_install test on Mac OS X
.IP \(bu 2
90de794290 Fix test_issue_6833_pip_upgrade_pip test on OSX
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37103\fP: (\fI\%cachedout\fP) Remove unnecessary sleep from unit.utils.process_test.TestProcessMana…
@ \fI2016\-10\-20 08:45:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
0b87e7890a Merge pull request \fI\%#37103\fP from cachedout/fix_proc_test
.IP \(bu 2
d7aebd1877 Remove unnecessary sleep from unit.utils.process_test.TestProcessManager.test_restarting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36823\fP: (\fI\%terminalmage\fP) Update debian systemd unit files to use default KillMode, Type=notify (refs: \fI\%#37162\fP)
@ \fI2016\-10\-20 05:54:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36806\fP: (\fI\%l2ol33rt\fP) Deb systemd should use control\-group default for killmode (refs: \fI\%#36823\fP)
.IP \(bu 2
326bbd5e30 Merge pull request \fI\%#36823\fP from terminalmage/pr\-36806
.IP \(bu 2
fb6e545f78 Use NotifyAccess=all in all unit files
.IP \(bu 2
0ccf789172 Remove EnvironmentFile and Restart lines from unit files
.IP \(bu 2
ddd44e9b13 Use Type=notify for debian systemd units
.IP \(bu 2
036d73f31b Use control\-group default for killmode
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37030\fP: (\fI\%isbm\fP) Fix status.uptime for Solaris 9, 10 and 11.
@ \fI2016\-10\-20 05:52:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
0c40e71e17 Merge pull request \fI\%#37030\fP from isbm/isbm\-solaris\-status\-fix
.IP \(bu 2
7d7b5ef9a9 Lintfix: E8303 too many blank lines
.IP \(bu 2
c11940d14c Fix status.uptime for Solaris 9, 10 and 11.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37101\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2016.3 to carbon
@ \fI2016\-10\-20 05:39:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
eb88c73222 Merge pull request \fI\%#37101\fP from rallytime/merge\-2016.3
.IP \(bu 2
b445a5e579 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
68eeb29783 Add warning about GitPython 2.0.9 incompatibility with Python 2.6 (\fI\%#37099\fP)
.IP \(bu 2
39d59ab0df Merge pull request \fI\%#36880\fP from vutny/cp\-get\-salt\-url
.INDENT 2.0
.IP \(bu 2
d1ab98b459 cp.get_url: update usage doc and add tests for \fIfile://\fP URL with \fIdest=None\fP
.IP \(bu 2
c7cf79e959 cp.get_url: add note and test for \fI\%https://\fP URL with \fBdest=None\fP
.IP \(bu 2
ff55f77179 cp.get_url: write more verbose docstring
.IP \(bu 2
94a34a08ba cp.get_url: add integration tests
.IP \(bu 2
983f82fcf4 cp.get_url: fix variable type check
.IP \(bu 2
b33f4d7b93 cp.get_url: log error message if no file could be fetched from \fIsalt://\fP URL
.IP \(bu 2
99cf3038cc cp.get_url: fix \fIdest=None\fP behaviour with \fIsalt://\fP URL
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36958\fP: (\fI\%twangboy\fP) Fix bug where cmd.powershell fails to return
@ \fI2016\-10\-19 16:03:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
8d44efed78 Merge pull request \fI\%#36958\fP from twangboy/fix_cmd_powershell
.IP \(bu 2
427be7b422 Add versionadded
.IP \(bu 2
d8e0e0e482 Fix missing comma
.IP \(bu 2
7b46d04a84 Add note about increased completion times
.IP \(bu 2
9365581a36 Clarify docs, add depth option
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37086\fP: (\fI\%cachedout\fP) Make salt\-call a first\-class citizen for multi\-master
@ \fI2016\-10\-19 15:19:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
beb54b3ffa Merge pull request \fI\%#37086\fP from cachedout/mm_req
.IP \(bu 2
7dc15c1a48 Lint utils
.IP \(bu 2
9bbe3c998b Lint error in publish
.IP \(bu 2
e22a3d2be6 Add multi\-master support to publish.publish
.IP \(bu 2
7f141ba38c Add function to search for substr in list
.IP \(bu 2
007eef84d7 Extend support to event.fire_master
.IP \(bu 2
8171c73b00 Multi\-master support for salt\-call
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36814\fP: (\fI\%martin\-helmich\fP) x509.create_csr creates invalid CSR (refs: \fI\%#36898\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36898\fP: (\fI\%clinta\fP) X509 fixes
@ \fI2016\-10\-19 03:03:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b94153ea6 Merge pull request \fI\%#36898\fP from clinta/x509\-fixes
.IP \(bu 2
e732fe7725 fix docs on CSR state
.IP \(bu 2
9b6f1a336c fix quotes and remove dependency on pkg_resources
.IP \(bu 2
eb4433d1ae return early if there are no requested extensions in the csr
.IP \(bu 2
d00cf8ef87 allow specifying digest for crl
.IP \(bu 2
dd50705e58 fix \fI\%#36814\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34872\fP: (\fI\%cbuechler\fP) \(dqMinion did not return\(dq executing state with long running command, 2016.3 regression (refs: \fI\%#37025\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37025\fP: (\fI\%cro\fP) Make salt.utils.minion._check_cmdline work on OSes without /proc.
@ \fI2016\-10\-19 03:00:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
a32b8cd741 Merge pull request \fI\%#37025\fP from cro/freebsd_no_proc
.IP \(bu 2
1ac87e0efd Make salt.utils.minion._check_cmdline work on OSes without /proc.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37050\fP: (\fI\%twangboy\fP) Fix service state for Windows (DO NOT MERGE FORWARD)
@ \fI2016\-10\-19 02:46:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36923\fP: (\fI\%twangboy\fP) Fix service state for Windows (refs: \fI\%#37050\fP)
.IP \(bu 2
e09d9f85c5 Merge pull request \fI\%#37050\fP from twangboy/fix_win_service_state
.IP \(bu 2
b3b688e298 Fix tests
.IP \(bu 2
1e1ee786c9 Set service to manual if disabled on start
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#29322\fP: (\fI\%mrproper\fP) add http proxy support for tornado (refs: \fI\%#37076\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37076\fP: (\fI\%jfindlay\fP) Document proxy settings
@ \fI2016\-10\-19 02:30:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
5e998638a4 Merge pull request \fI\%#37076\fP from jfindlay/proxy_doc
.IP \(bu 2
7328df68f5 doc.topic.tutorials.http.query: add proxy section
.IP \(bu 2
331072b35d doc.topic.tutorials.http.query: add subheadings
.IP \(bu 2
478def4923 doc.ref.configuration.minion: add proxy vars
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37001\fP: (\fI\%phil123456\fP) URGENT : archive.extracted does not work anymore (refs: \fI\%#37081\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37081\fP: (\fI\%terminalmage\fP) Fix archive.extracted remote source_hash verification
@ \fI2016\-10\-19 02:22:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
9ec366833e Merge pull request \fI\%#37081\fP from terminalmage/issue37001
.IP \(bu 2
a3c4deeb82 Fix archive.extracted remote source_hash verification
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35097\fP: (\fI\%jwhite530\fP) Minions die with \(dqun\-handled exception from the multiprocessing process\(dq (refs: \fI\%#37064\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37064\fP: (\fI\%cachedout\fP) Unify job check in scheduler
@ \fI2016\-10\-19 02:08:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
67faee1f94 Merge pull request \fI\%#37064\fP from cachedout/issue_35097
.IP \(bu 2
980ba892c9 Unify job check in scheduler
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37072\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-10\-18 15:23:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
7ef10f6de6 Merge pull request \fI\%#37072\fP from rallytime/merge\-2016.3
.IP \(bu 2
78a144f19a Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
7dd91c2880 Merge pull request \fI\%#37053\fP from rallytime/update\-fedora\-install\-docs
.INDENT 2.0
.IP \(bu 2
24e0f5e024 Update the Fedora installation docs
.UNINDENT
.IP \(bu 2
4eb0a89b7c remove options from pylint (\fI\%#37054\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37049\fP: (\fI\%terminalmage\fP) Further clarification on new grains docs from \fI\%#37028\fP
@ \fI2016\-10\-18 01:47:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37028\fP: (\fI\%damon\-atkins\fP) Update topics/grains doco, about considerations before adding a Grain (refs: \fI\%#37049\fP)
.IP \(bu 2
71fd01ab8d Merge pull request \fI\%#37049\fP from terminalmage/grains\-docs
.IP \(bu 2
854586c6a4 Add one more paragraph
.IP \(bu 2
a0502a7b90 Restructure grain writing docs
.IP \(bu 2
4e419e90ac Further clarification on new grains docs from \fI\%#37028\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#18419\fP: (\fI\%jasonrm\fP) salt\-cloud fails to run as non\-root user (refs: \fI\%#35483\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34806\fP: (\fI\%jerrykan\fP) salt\-cloud ignores sock_dir when firing event (refs: \fI\%#35483\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37057\fP: (\fI\%rallytime\fP) [2016.3] Update salt.utils.cloud references to __utils__ for cache funcs
@ \fI2016\-10\-18 01:31:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35483\fP: (\fI\%gtmanfred\fP) use __utils__ in salt.cloud (refs: \fI\%#35855\fP, \fI\%#37057\fP, \fI\%#36070\fP)
.IP \(bu 2
9a6671ce69 Merge pull request \fI\%#37057\fP from rallytime/cloud\-utils\-cleanup
.IP \(bu 2
d0dc7d4e55 [2016.3] Update salt.utils.cloud references to __utils__ for cache funcs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36977\fP: (\fI\%twangboy\fP) Remove whitespace from string commands
@ \fI2016\-10\-17 22:32:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
f8cd7b7b28 Merge pull request \fI\%#36977\fP from twangboy/fix_cmd_run
.IP \(bu 2
6586050736 Move strip to powershell block, add \-NoProfile
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37048\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-10\-17 16:05:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
9378b22d80 Merge pull request \fI\%#37048\fP from rallytime/merge\-2016.3
.IP \(bu 2
5efd6d3df9 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
7f5aced50e Merge pull request \fI\%#36972\fP from zer0def/supervisor\-state\-fixes
.INDENT 2.0
.IP \(bu 2
53801c6e80 Mitigates failure reports when making sure an existing supervisor process group is running, despite success.
.UNINDENT
.IP \(bu 2
4e2ad07b0f Prevent source files in /tmp from being deleted by file.managed states (\fI\%#37023\fP)
.IP \(bu 2
4e9824a65e args does not always exist (\fI\%#37019\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37028\fP: (\fI\%damon\-atkins\fP) Update topics/grains doco, about considerations before adding a Grain (refs: \fI\%#37049\fP)
@ \fI2016\-10\-17 09:54:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
104a153a1f Merge pull request \fI\%#37028\fP from damon\-atkins/update_topics_grains_doco
.IP \(bu 2
01e83a715e doc/topics/grains Update doco on when a grain should be created
.IP \(bu 2
a0e1fcc951 Add information to consider before adding a Grain to doco\(aqs for Grains
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37012\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-10\-14 18:07:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
c30656814d Merge pull request \fI\%#37012\fP from rallytime/merge\-2016.3
.IP \(bu 2
a7c9a72104 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
c6254d59fd Merge pull request \fI\%#36807\fP from terminalmage/issue36723
.INDENT 2.0
.IP \(bu 2
7d60e73308 Fix pillar merging when ext_pillar_first is enabled
.UNINDENT
.IP \(bu 2
e2bc94b029 cp.get_file_str: do not fail if file not found (\fI\%#36936\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34397\fP: (\fI\%jaredhanson11\fP) ignore_epoch needs to be passed through to version_cmp functions (refs: \fI\%#34531\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37007\fP: (\fI\%skizunov\fP) opkg: Support ignore_epoch argument in version comparisons
.IP \(bu 2
\fBPR\fP \fI\%#34531\fP: (\fI\%terminalmage\fP) Support ignore_epoch argument in version comparisons (refs: \fI\%#37007\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36808\fP: (\fI\%gtmanfred\fP) allow for closing stuff in beacons (refs: \fI\%#36835\fP)
@ \fI2016\-10\-14 15:50:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
8b3e65448d Merge pull request \fI\%#36808\fP from gtmanfred/beacons
.IP \(bu 2
727d4f309a allow for closing stuff in beacons
.IP \(bu 2
\fBPR\fP \fI\%#36993\fP: (\fI\%terminalmage\fP) Make helper funcs private
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27316\fP: (\fI\%efficks\fP) Extracted state with zip format failed on Windows (refs: \fI\%#27317\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27207\fP: (\fI\%PredatorVI\fP) archive.extracted state not preserving file permissions (refs: \fI\%#33906\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26569\fP: (\fI\%ssgward\fP) Add support for password\-protected zip files in archive.extracted on Windows (refs: \fI\%#31116\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23822\fP: (\fI\%sidcarter\fP) Zip file extracted permissions are incorrect (refs: \fI\%#25128\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36539\fP: (\fI\%jfindlay\fP) Prefer archive.cmd_unzip (refs: #\(gasaltstack/salt\(ga#36648\(ga_\(ga_, \fI\%#36648\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36986\fP: (\fI\%jfindlay\fP) modules.archive.unzip: zipfile is stdlib
@ \fI2016\-10\-13 21:38:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36648\fP: (\fI\%jfindlay\fP) Integration tests for archive execution module (refs: \fI\%#36986\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33906\fP: (\fI\%lomeroe\fP) Archive unzip permissions (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#31116\fP: (\fI\%UtahDave\fP) Add password support for zip files in archive module and state (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#27764\fP: (\fI\%basepi\fP) Merge forward from 2015.8 to develop (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#27317\fP: (\fI\%efficks\fP) State unzip should use unzip command instead of unzip_cmd. (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#25128\fP: (\fI\%stanislavb\fP) Use cmd_unzip to preserve permissions (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
a75761de87 Merge pull request \fI\%#36986\fP from jfindlay/arch_test
.IP \(bu 2
2ec2684860 modules.archive.unzip: zipfile is stdlib
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36422\fP: (\fI\%rippiedoos\fP) No error Reporting for (yum)pkg.upgrade (refs: #\(gasaltstack/salt#36450\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36980\fP: (\fI\%rallytime\fP) Skip pkg.upgrade test if pkg install/upgrade has problems (refs: \fI\%#36981\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36450\fP: (\fI\%terminalmage\fP) Normalize pkg.upgrade and raise CommandExecutionError on failure (refs: \fI\%#36981\fP, #\(gasaltstack/salt#36980\(ga_)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36981\fP: (\fI\%rallytime\fP) Skip pkg.upgrades test on distros other that Suse in 2016.3
@ \fI2016\-10\-13 21:29:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
c7595b84a7 Merge pull request \fI\%#36981\fP from rallytime/upgrades\-test\-fix
.IP \(bu 2
a5ae737057 Skip pkg.upgrades test on distros other that Suse in 2016.3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36671\fP: (\fI\%wrigtim\fP) systemd.py available() breaks on latest LSB\-compliant versions of systemd (refs: \fI\%#36755\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36755\fP: (\fI\%terminalmage\fP) systemd.py: check retcode for service availability in systemd >= 231
@ \fI2016\-10\-13 19:41:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b782c15e1 Merge pull request \fI\%#36755\fP from terminalmage/issue36671
.IP \(bu 2
d916c2b49c Handle cases where retcode/output feature is backported
.IP \(bu 2
b3364646ad Update systemd module unit tests
.IP \(bu 2
a2439acbc9 systemd.py: check retcode for service availability in systemd >= 231
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36746\fP: (\fI\%Ch3LL\fP) Carbon: When killing a job jid output missing (refs: \fI\%#36750\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36750\fP: (\fI\%terminalmage\fP) Add the CLI client and pub_data as class attributes
@ \fI2016\-10\-13 19:38:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
10d255c511 Merge pull request \fI\%#36750\fP from terminalmage/issue36746
.IP \(bu 2
0e7c600e02 Only display Ctrl\-c message on SIGINT
.IP \(bu 2
9025be48c5 Include the jid (when available) in SystemExit message on Ctrl\-c
.IP \(bu 2
9c9f1f620b Add the CLI client and pub_data as class attributes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36240\fP: (\fI\%hrumph\fP) win_certutil add_store state not installing certificates (refs: \fI\%#36241\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36241\fP: (\fI\%hrumph\fP) Fixes \fI\%#36240\fP
@ \fI2016\-10\-12 23:28:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ac9ced202 Merge pull request \fI\%#36241\fP from hrumph/cert_problem
.IP \(bu 2
51230fc263 Merge pull request \fI\%#1\fP from rallytime/pr\-36241
.INDENT 2.0
.IP \(bu 2
32846794c8 Update mocks for failing tests in win_certutil_test
.UNINDENT
.IP \(bu 2
b26578d1ac Fixes \fI\%#36240\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36950\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-10\-12 20:57:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
c1f84388d6 Merge pull request \fI\%#36950\fP from rallytime/merge\-2016.3
.IP \(bu 2
1d3ce45ac0 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
2ccc44f314 Merge pull request \fI\%#36914\fP from rallytime/suse_show_link
.INDENT 2.0
.IP \(bu 2
b8ffd9f53f Allow alternatives.show_link function to work on Suse distros
.UNINDENT
.UNINDENT
.IP \(bu 2
5362e5183e Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
fe2f094838 salt.modules.gpg: initialize GnuPG home dir with correct ownership (\fI\%#36824\fP)
.IP \(bu 2
4b21cca909 Fix race condition in which files were removed during a file.directory (\fI\%#36928\fP)
.IP \(bu 2
7838d8d3f9 Remove \(dqTargeting with Executions\(dq section from docs (\fI\%#36925\fP)
.IP \(bu 2
a56bf8bd2d Update references to future default value change that was reverted (\fI\%#36924\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36948\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36943\fP to 2016.3
@ \fI2016\-10\-12 18:33:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36943\fP: (\fI\%orymate\fP) doc: document what the argument of salt \-\-subset means (refs: \fI\%#36948\fP)
.IP \(bu 2
7e2128c05d Merge pull request \fI\%#36948\fP from rallytime/bp\-36943
.IP \(bu 2
d2f8f18430 doc: document what the argument of salt \-\-subset means
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36946\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36892\fP to 2016.3
@ \fI2016\-10\-12 18:32:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36892\fP: (\fI\%nvtkaszpir\fP) Update tutorial.rst (refs: \fI\%#36946\fP)
.IP \(bu 2
f43a10252d Merge pull request \fI\%#36946\fP from rallytime/bp\-36892
.IP \(bu 2
94c97ee726 Update tutorial.rst
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35198\fP: (\fI\%goestin\fP) beacons modules: service fails (refs: \fI\%#35199\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36945\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35199\fP to 2016.3
@ \fI2016\-10\-12 18:31:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35199\fP: (\fI\%goestin\fP) fix for issue \fI\%#35198\fP (refs: \fI\%#36945\fP)
.IP \(bu 2
5c70669ac0 Merge pull request \fI\%#36945\fP from rallytime/bp\-35199
.IP \(bu 2
390b906c2f adhere pep8 e713
.IP \(bu 2
79c9905fc5 Re\-added accidentally removed line 85
.IP \(bu 2
8bba13896a Fixed issue \fI\%#35198\fP now without deprecated code.
.IP \(bu 2
1241d87f1d fix for issue \fI\%#35198\fP
.IP \(bu 2
\fBPR\fP \fI\%#36949\fP: (\fI\%terminalmage\fP) Fix versionadded
.IP \(bu 2
\fBPR\fP \fI\%#36930\fP: (\fI\%jfindlay\fP) return opennebula errors to user
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36929\fP: (\fI\%rallytime\fP) [yumpkg] Skip test_pkg_upgrade_has_pending_upgrades if there are no upgrades
@ \fI2016\-10\-11 22:55:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
6ea1f59058 Merge pull request \fI\%#36929\fP from rallytime/fix\-pending\-upgrade\-test
.IP \(bu 2
32829b9474 [yumpkg] Skip test_pkg_upgrade_has_pending_upgrades if there are no upgrades
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36906\fP: (\fI\%sjorge\fP) [docs] comments about targetting execution still correct? (refs: \fI\%#36926\fP, #\(gasaltstack/salt\(ga#36925\(ga_\(ga_, \fI\%#36925\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36925\fP: (\fI\%rallytime\fP) Remove \(dqTargeting with Executions\(dq section from docs (refs: \fI\%#36926\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36926\fP: (\fI\%rallytime\fP) [2016.3] Remove \(dqTargeting with Executions\(dq section from docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36915\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-10\-11 19:49:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
b7f87e0aed Merge pull request \fI\%#36915\fP from rallytime/merge\-2016.3
.IP \(bu 2
971c27cba2 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
f3443fb992 Properly handle \(dqshared\(dq arg in git.init when it is a bool (\fI\%#36912\fP)
.IP \(bu 2
bdbf1619cb Check for test=True in salt.wait_for_event orchestration events (\fI\%#36897\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36820\fP: (\fI\%BenoitKnecht\fP) Fix diff output of test runs for Debian slave interfaces
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36855\fP: (\fI\%edwardsdanielj\fP) Issue with setting up schedule job via state.apply (refs: \fI\%#36894\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36894\fP: (\fI\%jfindlay\fP) states.schedule: splay is not ordereddict
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36885\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-10\-10 19:30:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
86ac8bd680 Merge pull request \fI\%#36885\fP from rallytime/merge\-2016.3
.IP \(bu 2
c09b9d6e6a Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
3ce4897b97 Merge pull request \fI\%#36857\fP from terminalmage/systemd\-unit\-tests
.INDENT 2.0
.IP \(bu 2
7c78d6f419 Add unit tests for systemd scope usage
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36889\fP: (\fI\%terminalmage\fP) salt\-ssh: Try \(dqcommand \-v\(dq before falling back to \(dqwhich\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36804\fP: (\fI\%Ch3LL\fP) CARBON: error when using pkg.installed with url source (refs: \fI\%#36830\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36830\fP: (\fI\%terminalmage\fP) fileclient: Change queryarg comparison from None to simple boolean check
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36853\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33939\fP to 2016.3
@ \fI2016\-10\-07 21:44:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33939\fP: (\fI\%bx2\fP) Removed \fI!\fP\-password check for salt\-cloud vultr provider (refs: \fI\%#36853\fP)
.IP \(bu 2
6a6bdf3e3f Merge pull request \fI\%#36853\fP from rallytime/bp\-33939
.IP \(bu 2
efbc09c1a6 Removed \fI!\fP\-password check
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36852\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36743\fP to 2016.3
@ \fI2016\-10\-07 21:35:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36743\fP: (\fI\%do3meli\fP) corrected OS Name in openbsd_sysctl module load error message (refs: \fI\%#36852\fP)
.IP \(bu 2
01348bde18 Merge pull request \fI\%#36852\fP from rallytime/bp\-36743
.IP \(bu 2
899130d11f corrected OS Name in module load error message
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36844\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-10\-07 19:20:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
0b7661244d Merge pull request \fI\%#36844\fP from rallytime/merge\-2016.3
.IP \(bu 2
1c3a9a3ee9 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
3e6b16de2b Merge pull request \fI\%#36786\fP from cachedout/fixup_36676
.INDENT 2.0
.IP \(bu 2
3c93134e57 Typo
.IP \(bu 2
13eb463bd9 Fixup alterernatives module
.UNINDENT
.IP \(bu 2
c126f2e132 Merge pull request \fI\%#36757\fP from cachedout/issue_33841
.INDENT 2.0
.IP \(bu 2
4bce452500 Resolve issue with minion failing to restart on failure
.UNINDENT
.IP \(bu 2
89f9fc8c0d Merge pull request \fI\%#36749\fP from jacobhammons/file\-dict
.INDENT 2.0
.IP \(bu 2
71f91b3a50 Fixes the cli examples to reference the correct function
.UNINDENT
.IP \(bu 2
804a2a1ab0 Merge pull request \fI\%#36730\fP from rallytime/bp\-36028
.INDENT 2.0
.IP \(bu 2
4be4f900ee Back\-port \fI\%#36028\fP to 2015.8
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36835\fP: (\fI\%jfindlay\fP) unify and expand beacon documentation
@ \fI2016\-10\-07 15:59:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36808\fP: (\fI\%gtmanfred\fP) allow for closing stuff in beacons (refs: \fI\%#36835\fP)
.IP \(bu 2
dc5d821be6 Merge pull request \fI\%#36835\fP from jfindlay/beacon_doc
.IP \(bu 2
b2eccdefd5 doc.topics.beacons: reflow text at 80 chars
.IP \(bu 2
b181f9890d doc.topics.{reactor|beacons}: unify examples, many minor edits
.IP \(bu 2
28b4e30009 doc.glossary: use parenthesis
.IP \(bu 2
82cf39db00 doc.glossary: add JID
.IP \(bu 2
cc071b75cb doc.glossary: add idempotent
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36787\fP: (\fI\%maximeguillet\fP) postgres.* calls fail with postgresql 9.6 and .psqlrc custom file (refs: \fI\%#36789\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36789\fP: (\fI\%maximeguillet\fP) Fix behavior of psql \-c option with postgresql 9.6
@ \fI2016\-10\-06 11:24:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
1284de27fc Merge pull request \fI\%#36789\fP from maximeguillet/fix\-psqlrc\-pg9.6
.IP \(bu 2
b59c23bef1 Fix one remaining postgresql tests linked to \fI\%#36787\fP\&.
.IP \(bu 2
8b92ae2061 Fix postgresql tests using position in the argument list of psql.
.IP \(bu 2
21f2a17a07 Fix postgresql tests by adding \-\-no\-psqlrc option introduced by \fI\%#36787\fP\&.
.IP \(bu 2
574e30e915 Fix behavior of psql \-c option with postgresql 9.6
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36579\fP: (\fI\%scubahub\fP) No error generated when reactor file does not exist. (refs: \fI\%#36797\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36797\fP: (\fI\%cachedout\fP) Error on reaction with missing SLS file
@ \fI2016\-10\-06 11:19:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
a1d59f4d2f Merge pull request \fI\%#36797\fP from cachedout/issue_36579
.IP \(bu 2
6ce4653fa3 Error on reaction with missing SLS file
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#36788\fP: (\fI\%damon\-atkins\fP) pillar/libvirt.py assume certtool is available and works every time (refs: \fI\%#36803\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36803\fP: (\fI\%gtmanfred\fP) do not load libvirt pillar if certtool is unavailable
@ \fI2016\-10\-06 11:15:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
b75130be2d Merge pull request \fI\%#36803\fP from gtmanfred/2016.3
.IP \(bu 2
2183737085 do not load libvirt pillar if certtool is unavailable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36815\fP: (\fI\%BenoitKnecht\fP) Fix glance.image_present state
@ \fI2016\-10\-06 10:29:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
39148dc711 Merge pull request \fI\%#36815\fP from BenoitKnecht/fix\-glance\-image\-present\-state\-2016.3
.IP \(bu 2
342eee444d states: glance: handle image list instead of dict
.IP \(bu 2
02b91ecf15 states: glance: import keystone exceptions from new location
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36738\fP: (\fI\%edhgoose\fP) rpmdev\-vercmp throws lots of warnings on Amazon Linux (refs: \fI\%#36739\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36754\fP: (\fI\%terminalmage\fP) Base rpmdev\-vercmp comparison result on retcode
@ \fI2016\-10\-05 12:50:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36739\fP: (\fI\%edhgoose\fP) Add support for rpmdevtools returning < / > / == (refs: \fI\%#36754\fP)
.IP \(bu 2
81c935f210 Merge pull request \fI\%#36754\fP from terminalmage/issue36738
.IP \(bu 2
928c99d2f7 Base rpmdev\-vercmp comparison result on retcode
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36728\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3 (refs: \fI\%#36785\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36785\fP: (\fI\%cachedout\fP) Fixup merge forward \fI\%#36728\fP
@ \fI2016\-10\-05 11:02:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36728\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3 (refs: \fI\%#36785\fP)
.IP \(bu 2
4bdb997dae Merge pull request \fI\%#36785\fP from cachedout/pr\-36728
.IP \(bu 2
118ba8a772 Update alternatives module to strip newline chars
.IP \(bu 2
24b8bba145 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
a01a68d4be Merge pull request \fI\%#36676\fP from vutny/redhat\-alternatives\-detect\-fail
.INDENT 2.0
.IP \(bu 2
bba9d0d105 \fIalternatives.install\fP state: detect \fIalternatives\fP command failed
.UNINDENT
.IP \(bu 2
eab4fd563a Merge pull request \fI\%#36700\fP from terminalmage/update\-faq
.INDENT 2.0
.IP \(bu 2
3d15eedfe0 Add additional information about onchanges/onchanges_in
.IP \(bu 2
57ecbe6c53 Update minion restart example to use onchanges instead of cmd.wait
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36766\fP: (\fI\%bx2\fP) salt\-cloud (vultr) throws NameError: global name \(aq__opts__\(aq is not defined (refs: \fI\%#36768\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36768\fP: (\fI\%gtmanfred\fP) add __utils__ to vultr cloud provider
@ \fI2016\-10\-05 06:59:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
90cca6b135 Merge pull request \fI\%#36768\fP from gtmanfred/2016.3
.IP \(bu 2
9df2fd11dd add __utils__ to vultr cloud provider
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36764\fP: (\fI\%cachedout\fP) Another bit of detection for failed pip tests
@ \fI2016\-10\-04 13:05:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
8ff69bf0c7 Merge pull request \fI\%#36764\fP from cachedout/more_pip_test_fixing
.IP \(bu 2
b9f5343449 Another bit of detection for failed pip tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27316\fP: (\fI\%efficks\fP) Extracted state with zip format failed on Windows (refs: \fI\%#27317\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27207\fP: (\fI\%PredatorVI\fP) archive.extracted state not preserving file permissions (refs: \fI\%#33906\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26569\fP: (\fI\%ssgward\fP) Add support for password\-protected zip files in archive.extracted on Windows (refs: \fI\%#31116\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23822\fP: (\fI\%sidcarter\fP) Zip file extracted permissions are incorrect (refs: \fI\%#25128\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36722\fP: (\fI\%rallytime\fP) Skip cmd_unzip test if salt.utils.which(\(aqzip\(aq) isn\(aqt available (refs: \fI\%#36747\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36648\fP: (\fI\%jfindlay\fP) Integration tests for archive execution module (refs: \fI\%#36747\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36539\fP: (\fI\%jfindlay\fP) Prefer archive.cmd_unzip (refs: #\(gasaltstack/salt\(ga#36648\(ga_\(ga_, \fI\%#36648\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36747\fP: (\fI\%jfindlay\fP) modules.archive integration tests: check for gzip, rar
@ \fI2016\-10\-04 11:47:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33906\fP: (\fI\%lomeroe\fP) Archive unzip permissions (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#31116\fP: (\fI\%UtahDave\fP) Add password support for zip files in archive module and state (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#27764\fP: (\fI\%basepi\fP) Merge forward from 2015.8 to develop (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#27317\fP: (\fI\%efficks\fP) State unzip should use unzip command instead of unzip_cmd. (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#25128\fP: (\fI\%stanislavb\fP) Use cmd_unzip to preserve permissions (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
5c0cbfc4c6 Merge pull request \fI\%#36747\fP from jfindlay/arch_test
.IP \(bu 2
b5fcca9983 modules.archive int tests: check for gzip, rar
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36744\fP: (\fI\%cachedout\fP) Fix issue where test suite could hang on shutdown
@ \fI2016\-10\-03 15:37:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
93f1daa4ce Merge pull request \fI\%#36744\fP from cachedout/fix_test_shutdown
.IP \(bu 2
cdf2a56564 Fix issue where test suite could hang on shutdown
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#32490\fP: (\fI\%davegiles\fP) __proxy__ not available when called from state.sls_id, fine from state.highstate (refs: \fI\%#36696\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36696\fP: (\fI\%cro\fP) pass __proxy__ in state.sls_id
@ \fI2016\-10\-01 09:37:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
6fa9ec36d2 Merge pull request \fI\%#36696\fP from cro/proxy_in_sls_id
.IP \(bu 2
891004f3be try/except for when __proxy__ is not injected.
.IP \(bu 2
e8e53d60be pass __proxy__ in state.sls_id
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36716\fP: (\fI\%vutny\fP) salt.modules.ini_manage: fix creating options in empty file
@ \fI2016\-10\-01 09:35:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
e0b288feb3 Merge pull request \fI\%#36716\fP from vutny/fix\-ini\-manage
.IP \(bu 2
73eb773fb0 salt.modules.ini_manage: fix creating options in empty file
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29421\fP: (\fI\%scbunn\fP) pillar data leaks through environments (refs: \fI\%#36435\fP, #saltstack/salt\(ga#36435\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36628\fP: (\fI\%yhekma\fP) Update doc to reflect the version where \(aqnone\(aq was added as a pillar_… (refs: \fI\%#36724\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36435\fP: (\fI\%yhekma\fP) Add \(dqnone\(dq as a pillar merging strategy (refs: #\(gasaltstack/salt\(ga#36628\(ga_\(ga_, \fI\%#36628\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36724\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36628\fP to 2016.3
@ \fI2016\-10\-01 09:33:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36628\fP: (\fI\%yhekma\fP) Update doc to reflect the version where \(aqnone\(aq was added as a pillar_… (refs: \fI\%#36724\fP)
.IP \(bu 2
97713b09f5 Merge pull request \fI\%#36724\fP from rallytime/bp\-36628
.IP \(bu 2
3bb2cb6379 Update doc to reflect the version where \(aqnone\(aq was added as a pillar_source_merging_strategy
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36643\fP: (\fI\%roosri\fP) a small, and unfortunate error (refs: \fI\%#36725\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36725\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36643\fP to 2016.3
@ \fI2016\-10\-01 09:33:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36643\fP: (\fI\%roosri\fP) a small, and unfortunate error (refs: \fI\%#36725\fP)
.IP \(bu 2
8e7529764b Merge pull request \fI\%#36725\fP from rallytime/bp\-36643
.IP \(bu 2
c5b8e442f9 a small, and unfortunate error
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36726\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36722\fP to 2016.3
@ \fI2016\-10\-01 09:32:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36722\fP: (\fI\%rallytime\fP) Skip cmd_unzip test if salt.utils.which(\(aqzip\(aq) isn\(aqt available (refs: \fI\%#36726\fP)
.IP \(bu 2
cf32c59b6a Merge pull request \fI\%#36726\fP from rallytime/bp\-36722
.IP \(bu 2
5904cc04c6 Skip cmd_unzip test if salt.utils.which(\(aqzip\(aq) isn\(aqt available
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#36718\fP: (\fI\%Ch3LL\fP) Error when using archive.zip  on python2.6  (refs: \fI\%#36719\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36719\fP: (\fI\%Ch3LL\fP) fix python26 archive zip module
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36616\fP: (\fI\%cro\fP) Zypper fix test (refs: \fI\%#36699\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36699\fP: (\fI\%cachedout\fP) Fix error in test
@ \fI2016\-09\-30 11:28:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
7d022a3f39 Merge pull request \fI\%#36699\fP from cachedout/fixup_36616
.IP \(bu 2
16f5bb70ec Remove line that checks against unordered keys
.IP \(bu 2
0e9148293a Fix error in test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36669\fP: (\fI\%jackywu\fP) fix bug of including loopback addr will never work (refs: \fI\%#36670\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36670\fP: (\fI\%jackywu\fP) fix bug for including loopback addr
@ \fI2016\-09\-30 10:21:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
0aa35596c0 Merge pull request \fI\%#36670\fP from jackywu/2016.3
.IP \(bu 2
48d2d512d8 fix bug for including loopback addr
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36692\fP: (\fI\%lorengordon\fP) Expose \fIignore_if_missing\fP param to the file.replace state (refs: \fI\%#36694\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36694\fP: (\fI\%lorengordon\fP) Exposes \fIignore_if_missing\fP to file.replace state module
@ \fI2016\-09\-30 10:12:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
0e8c9abe8d Merge pull request \fI\%#36694\fP from lorengordon/issue\-36692
.IP \(bu 2
35f3bb3a8a Exposes \fIignore_if_missing\fP to file.replace state module
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35356\fP: (\fI\%jfindlay\fP) document log levels and warn on all logging below info (refs: \fI\%#36686\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36686\fP: (\fI\%jfindlay\fP) log levels doc: try long form table
@ \fI2016\-09\-29 18:21:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
c089ac6c67 Merge pull request \fI\%#36686\fP from jfindlay/log_levels
.IP \(bu 2
4dd4fc94dc log levels doc: try long form table
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36690\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-29 17:46:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
e0a851b2f1 Merge pull request \fI\%#36690\fP from rallytime/merge\-2016.3
.IP \(bu 2
7fc38c9aca Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
7d1972bd5c Merge pull request \fI\%#36684\fP from rallytime/merge\-2015.8
.INDENT 2.0
.IP \(bu 2
838722d225 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
8f1ba2fa26 Merge pull request \fI\%#36678\fP from rallytime/merge\-2015.5
.IP \(bu 2
51240ecb13 Merge branch \(aq2014.7\(aq into \(aq2015.5\(aq
.IP \(bu 2
86dc3dc9f7 Merge pull request \fI\%#36641\fP from fuzzy\-id/fix\-lvm\-thin\-argument
.IP \(bu 2
740516aace fix thin argument for \(aqlvm.lv_create\(aq
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36680\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-29 16:49:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
f95dd696e5 Merge pull request \fI\%#36680\fP from rallytime/merge\-2016.3
.IP \(bu 2
3e4ac617d3 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
e4c5d0bfd6 Merge pull request \fI\%#36664\fP from cachedout/remove_useless_size_check
.INDENT 2.0
.IP \(bu 2
3d098c64ef Remove possible race between grains dumps in test
.UNINDENT
.IP \(bu 2
8cfe371a5a Merge pull request \fI\%#36663\fP from cachedout/skip_pip_tests_on_download_fail
.INDENT 2.0
.IP \(bu 2
0c7fb91dc5 Fix error
.UNINDENT
.IP \(bu 2
e3f8618982 Merge pull request \fI\%#36662\fP from cachedout/skip_pip_tests_on_download_fail
.INDENT 2.0
.IP \(bu 2
0bbc60ccd7 Skip over tests where upstream pip isn\(aqt there
.UNINDENT
.IP \(bu 2
3249a11e71 Merge pull request \fI\%#36661\fP from cachedout/fix_grain_test_race
.INDENT 2.0
.IP \(bu 2
2dcb92134d Fix race between minion job timeout and cli test timeout
.UNINDENT
.IP \(bu 2
b0190f248e Merge pull request \fI\%#36660\fP from cachedout/fix_2068_issue_test
.INDENT 2.0
.IP \(bu 2
f4906fe771 Fix test not to rely on external resources
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28125\fP: (\fI\%peter\-slovak\fP) [2015.8] support for __env__ in Git external pillar (refs: \fI\%#36659\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36659\fP: (\fI\%terminalmage\fP) Support dynamic env in new\-style git_pillar
@ \fI2016\-09\-29 05:04:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
eab1680f3f Merge pull request \fI\%#36659\fP from terminalmage/issue28125
.IP \(bu 2
45352b36bd Support dynamic env in new\-style git_pillar
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34927\fP: (\fI\%bobrik\fP) Salt does not run \(dqsystemd daemon\-reload\(dq on unit override (refs: \fI\%#36538\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36538\fP: (\fI\%clinta\fP) daemon\-reload on call to service.avaliable
@ \fI2016\-09\-29 02:28:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
0c2bd4b66b Merge pull request \fI\%#36538\fP from clinta/daemon\-reload
.IP \(bu 2
833beb9b36 Merge pull request \fI\%#1\fP from terminalmage/pr\-36538
.INDENT 2.0
.IP \(bu 2
c4060ba2c1 Move check for service availability to a helper function
.UNINDENT
.IP \(bu 2
20c2c91bba daemon\-reload on call to service.avaliable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36616\fP: (\fI\%cro\fP) Zypper fix test
@ \fI2016\-09\-29 02:26:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
d8a61eb9f6 Merge pull request \fI\%#36616\fP from cro/zypper_fix_test
.IP \(bu 2
b618a5c07d Remove debugging
.IP \(bu 2
3870589462 Test for pkg.upgrade.  Most robust on Suse but better than nothing elsewhere
.IP \(bu 2
867638ff48 Test for pkg.upgrade.  Most robust on Suse but better than nothing elsewhere
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36621\fP: (\fI\%terminalmage\fP) Fix shadowed builtins
@ \fI2016\-09\-29 02:25:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
ccd92d22d2 Merge pull request \fI\%#36621\fP from terminalmage/fix\-shadowed\-builtins
.IP \(bu 2
62729eff8d Update tests to include fix for renamed function
.IP \(bu 2
283aca8f2a Update test to reflect new function signature
.IP \(bu 2
0f158b5edd Fix shadowed builtins
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36618\fP: (\fI\%onorua\fP) Fix memory leak for 0mq transport in case of TCP DDOS (refs: \fI\%#36636\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36636\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36618\fP to 2016.3
@ \fI2016\-09\-29 02:23:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36618\fP: (\fI\%onorua\fP) Fix memory leak for 0mq transport in case of TCP DDOS (refs: \fI\%#36636\fP)
.IP \(bu 2
24f82b2809 Merge pull request \fI\%#36636\fP from rallytime/bp\-36618
.IP \(bu 2
275845c3d2 Fix memory leak for 0mq transport
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27316\fP: (\fI\%efficks\fP) Extracted state with zip format failed on Windows (refs: \fI\%#27317\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27207\fP: (\fI\%PredatorVI\fP) archive.extracted state not preserving file permissions (refs: \fI\%#33906\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26569\fP: (\fI\%ssgward\fP) Add support for password\-protected zip files in archive.extracted on Windows (refs: \fI\%#31116\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23822\fP: (\fI\%sidcarter\fP) Zip file extracted permissions are incorrect (refs: \fI\%#25128\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36539\fP: (\fI\%jfindlay\fP) Prefer archive.cmd_unzip (refs: #\(gasaltstack/salt\(ga#36648\(ga_\(ga_, \fI\%#36648\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36648\fP: (\fI\%jfindlay\fP) Integration tests for archive execution module (refs: \fI\%#36986\fP)
@ \fI2016\-09\-29 02:16:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33906\fP: (\fI\%lomeroe\fP) Archive unzip permissions (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#31116\fP: (\fI\%UtahDave\fP) Add password support for zip files in archive module and state (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#27764\fP: (\fI\%basepi\fP) Merge forward from 2015.8 to develop (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#27317\fP: (\fI\%efficks\fP) State unzip should use unzip command instead of unzip_cmd. (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#25128\fP: (\fI\%stanislavb\fP) Use cmd_unzip to preserve permissions (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
750ff8220c Merge pull request \fI\%#36648\fP from jfindlay/arch_test
.IP \(bu 2
cc4d958557 modules.archive: add integration tests
.IP \(bu 2
99bf89447b modules.archive: add opts arg to g(un)zip
.IP \(bu 2
c1219e68c5 modules.archive.unzip: depend on zipfile module
.IP \(bu 2
315b031de9 modules.archive: use less redundant message
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36389\fP: (\fI\%cachedout\fP) Pr 36386 (refs: \fI\%#36650\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36650\fP: (\fI\%rallytime\fP) Revert \(dqPr 36386\(dq
@ \fI2016\-09\-29 02:11:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36386\fP: (\fI\%xiaoanyunfei\fP) fix salt\-api\(aqs default opts were covered by salt\-master \fI\%#35734\fP (refs: \fI\%#36389\fP, \fI\%#36650\fP, #saltstack/salt\(ga#36389\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#35734\fP: (\fI\%xiaoanyunfei\fP) fix salt\-api\(aqs default opts were covered by salt\-master (refs: \fI\%#36386\fP)
.IP \(bu 2
91aa464d5d Merge pull request \fI\%#36650\fP from saltstack/revert\-36389\-pr\-36386
.IP \(bu 2
33ef5bffe6 Revert \(dqPr 36386\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36304\fP: (\fI\%Ch3LL\fP) stack trace when transport is not a currently supported transport (refs: \fI\%#36646\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36646\fP: (\fI\%rallytime\fP) Provide an error message when invalid transport is set
@ \fI2016\-09\-28 22:52:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab5c0e9e65 Merge pull request \fI\%#36646\fP from rallytime/fix\-36304
.IP \(bu 2
ae021d6dec Provide an error message when invalid transport is set
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36635\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-28 21:10:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
6d9b28506c Merge pull request \fI\%#36635\fP from rallytime/merge\-2016.3
.IP \(bu 2
787c1f557e Pylint fix
.IP \(bu 2
da574e5b03 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
f0d561a229 Merge pull request \fI\%#36632\fP from isbm/isbm\-thin\-modules\-config\-15.8
.INDENT 2.0
.IP \(bu 2
975f8bb27d Add extra\-mods options to the Salt\-Thin via SSH CLI
.IP \(bu 2
a441b35588 Add documentation about Salt Thin configuration
.IP \(bu 2
3bfb17ee62 Add a description of the thin/min parameters to the master config
.IP \(bu 2
3d878f9da5 Get the thin Salt with configured extra modules on SSH
.IP \(bu 2
2be9330be6 Add thin options to the master config.
.IP \(bu 2
58577d342e Generate thin with configured extrta modules
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36553\fP: (\fI\%nilliams\fP) states.hg.latest claims to succeed despite errors (refs: \fI\%#36620\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36620\fP: (\fI\%rallytime\fP) Don\(aqt allow mercurial states to return True with errors
@ \fI2016\-09\-28 05:50:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
83da81cdfd Merge pull request \fI\%#36620\fP from rallytime/fix\-36553
.IP \(bu 2
a828bdd0b8 Update test mocks for cmd.run_all dicts
.IP \(bu 2
3904dfc5a8 Don\(aqt allow mercurial states to return True with errors
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36622\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-28 05:39:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
1c001d0ee1 Merge pull request \fI\%#36622\fP from rallytime/merge\-2016.3
.IP \(bu 2
90c66ef756 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
9b9e167b47 Merge pull request \fI\%#36562\fP from kiorky/s2015.8
.INDENT 2.0
.IP \(bu 2
47c3d03035 Fix pkg.latest_version using localized output
.UNINDENT
.IP \(bu 2
4ab52ae0f6 Merge pull request \fI\%#36607\fP from vutny/detect\-service\-fail
.INDENT 2.0
.IP \(bu 2
c4f899b3b3 \fIsalt.states.service\fP: detect that service failed to start/stop
.UNINDENT
.IP \(bu 2
5de036b56c Merge pull request \fI\%#36611\fP from multani/2015.8
.INDENT 2.0
.IP \(bu 2
79fdc12395 jinja: fix YAML terminator removal in Jinja\(aqs \(dqyaml\(dq filter
.UNINDENT
.IP \(bu 2
6e36191fc4 Fix trust key 2015.8 (\fI\%#36540\fP)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36520\fP: (\fI\%twangboy\fP) Fix cmd.script runas for Windows
@ \fI2016\-09\-28 04:07:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
e7def534b1 Merge pull request \fI\%#36520\fP from twangboy/fix_cmd.script_runas
.IP \(bu 2
377ced5c24 Remove directory in Windows with runas
.IP \(bu 2
25d52efeac Fix mkdir
.IP \(bu 2
18d41f7711 Add mkdir
.IP \(bu 2
9d55bff914 Use cachedir for Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#32368\fP: (\fI\%vitaliyf\fP) Low timeout values causes duplicate commands to execute (refs: \fI\%#36564\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36564\fP: (\fI\%DmitryKuzmenko\fP) Improve and fix \fI_check_cache_minions\fP
@ \fI2016\-09\-28 02:50:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
798bf3086b Merge pull request \fI\%#36564\fP from DSRCorporation/bugs/32368_grains_match_bug
.IP \(bu 2
be61f97db3 Minor: syntax error fixes.
.IP \(bu 2
29660ed672 Improve and fix \fI_check_cache_minions\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36606\fP: (\fI\%danlsgiga\fP) Add support for ACL Tokens in consul_pillar with the option consul.token
@ \fI2016\-09\-28 02:46:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
133705d567 Merge pull request \fI\%#36606\fP from danlsgiga/consul_pillar_token
.IP \(bu 2
a5907c9c89 Add support for ACL Tokens in consul_pillar with the option consul.token
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36613\fP: (\fI\%slinn0\fP) Remove file.check_managed_changes  when not needed (backport of PR \fI\%#36589\fP to 2016.3)
@ \fI2016\-09\-28 02:35:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36589\fP: (\fI\%slinn0\fP) Do not generate pchanges in file.managed unless test=True (refs: \fI\%#36613\fP)
.IP \(bu 2
b365f1e34d Merge pull request \fI\%#36613\fP from slinn0/2016.3_36588_fixes
.IP \(bu 2
d9da5cb2d4 Backport of PR \fI\%#36589\fP / Issue \fI\%#36588\fP to 2016.3 branch.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36609\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-27 18:34:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
e23af98d97 Merge pull request \fI\%#36609\fP from rallytime/merge\-2016.3
.IP \(bu 2
f15d4a38bd Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
57ec792f6b Merge pull request \fI\%#36550\fP from rickyninja/2015.8
.INDENT 2.0
.IP \(bu 2
f9ef30aabe Add version_cmp for FreeBSD pkg.
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36595\fP: (\fI\%cachedout\fP) Remove tests which no longer apply
@ \fI2016\-09\-27 07:38:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
25fa754d94 Merge pull request \fI\%#36595\fP from cachedout/issue_7754_fix
.IP \(bu 2
3a83b0bd16 Remove tests which no longer apply
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36586\fP: (\fI\%gehzumteufel\fP) Documentation update (refs: \fI\%#36594\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36594\fP: (\fI\%cachedout\fP) Update boostrap docs to recent versions of Ubuntu
@ \fI2016\-09\-27 06:18:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
aed98f47de Merge pull request \fI\%#36594\fP from cachedout/issue_36586
.IP \(bu 2
1e6a60ab01 Update boostrap docs to recent versions of Ubuntu
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36585\fP: (\fI\%twangboy\fP) Add pyOpenSSL to req file for Windows
@ \fI2016\-09\-27 05:49:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
c79f525863 Merge pull request \fI\%#36585\fP from twangboy/add_pyopenssl
.IP \(bu 2
5fc63a1054 Add pyOpenSSL to req file for Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36568\fP: (\fI\%lkx007\fP) cp.push remove_source problem (refs: \fI\%#36572\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36572\fP: (\fI\%cachedout\fP) Fix salt.utils.rm_rf to delete files too
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36491\fP: (\fI\%cro\fP) pkg.upgrade does not upgrade on Leap 42.1 or Tumbleweed (refs: \fI\%#36495\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36495\fP: (\fI\%cro\fP) Fix pkg.upgrade for zypper
@ \fI2016\-09\-26 10:02:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0dd92b037 Merge pull request \fI\%#36495\fP from cro/zypper_fix
.IP \(bu 2
6c5807c4be Fix pkg.upgrade for zypper
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27316\fP: (\fI\%efficks\fP) Extracted state with zip format failed on Windows (refs: \fI\%#27317\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27207\fP: (\fI\%PredatorVI\fP) archive.extracted state not preserving file permissions (refs: \fI\%#33906\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26569\fP: (\fI\%ssgward\fP) Add support for password\-protected zip files in archive.extracted on Windows (refs: \fI\%#31116\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23822\fP: (\fI\%sidcarter\fP) Zip file extracted permissions are incorrect (refs: \fI\%#25128\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36539\fP: (\fI\%jfindlay\fP) Prefer archive.cmd_unzip
@ \fI2016\-09\-26 10:02:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33906\fP: (\fI\%lomeroe\fP) Archive unzip permissions (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#31116\fP: (\fI\%UtahDave\fP) Add password support for zip files in archive module and state (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#27764\fP: (\fI\%basepi\fP) Merge forward from 2015.8 to develop (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#27317\fP: (\fI\%efficks\fP) State unzip should use unzip command instead of unzip_cmd. (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#25128\fP: (\fI\%stanislavb\fP) Use cmd_unzip to preserve permissions (refs: \fI\%#36539\fP, #saltstack/salt\(ga#36539\(ga_)
.IP \(bu 2
4bca246a27 Merge pull request \fI\%#36539\fP from jfindlay/arch_perms
.IP \(bu 2
d64ae48783 states.archive: use archive.cmd_unzip when possible
.IP \(bu 2
928a7891b4 modules.archive.unzip: log a warning about perms
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36514\fP: (\fI\%nilliams\fP) salt.stages.hg errors when \-identity option is used (refs: \fI\%#36546\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36546\fP: (\fI\%rallytime\fP) Mercurial Module: Pass the identity_path portion as own arg
@ \fI2016\-09\-26 09:44:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab50cde391 Merge pull request \fI\%#36546\fP from rallytime/fix\-36514
.IP \(bu 2
9afe76759e Mercurial Module: Pass the identity_path portion as own arg
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35480\fP: (\fI\%jelenak\fP) 200 processes of salt\-master (2016.3.2) (refs: \fI\%#36184\fP, \fI\%#36555\fP, \fI\%#37254\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36555\fP: (\fI\%DmitryKuzmenko\fP) Bugs/35480 master shutdown
@ \fI2016\-09\-26 09:25:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
aea55fce61 Merge pull request \fI\%#36555\fP from DSRCorporation/bugs/35480_master_shutdown
.IP \(bu 2
6ad2998715 Wait for kill in ProcessManager should be greater in main process than in subprocess.
.IP \(bu 2
c9c45a5d79 Don\(aqt set the \fIdaemon\fP flag for LoggingQueue process.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36542\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-23 22:47:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
a1e0afe1c7 Merge pull request \fI\%#36542\fP from rallytime/merge\-2016.3
.IP \(bu 2
861a001749 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
07c9d040c0 Fixup the rabbitmq_user state test failure (\fI\%#36541\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29421\fP: (\fI\%scbunn\fP) pillar data leaks through environments (refs: \fI\%#36435\fP, \fI\%saltstack/salt#36435\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36532\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36435\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#36435\fP: (\fI\%yhekma\fP) Add \(dqnone\(dq as a pillar merging strategy (refs: \fI\%#36532\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36535\fP: (\fI\%rallytime\fP) Be explicit about the salt.utils.templates import
.IP \(bu 2
\fBPR\fP \fI\%#36537\fP: (\fI\%rallytime\fP) Wrap the entire GrainsAppendTestCase class with destructiveTest
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36529\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-23 16:42:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
55cf4d6a04 Merge pull request \fI\%#36529\fP from rallytime/merge\-2016.3
.IP \(bu 2
52cf40db8c Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
1c3758544c Merge pull request \fI\%#36441\fP from twangboy/update_setup
.INDENT 2.0
.IP \(bu 2
fc4a03a75d Check for existing library on Windows
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36483\fP: (\fI\%dmurphy18\fP) Isolate sun IPv6 fix to Sun OS only
@ \fI2016\-09\-23 09:24:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
03491634ff Merge pull request \fI\%#36483\fP from dmurphy18/aix_fix_ipv6
.IP \(bu 2
b68f982c6a Updated check as per code review
.IP \(bu 2
cbcdb472fe Isolate SUN IPv6 fix to Sun Os only
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36279\fP: (\fI\%alertedsnake\fP) state.postgres_privileges should allow grants to ALL tables/sequences. (refs: \fI\%#36280\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36280\fP: (\fI\%alertedsnake\fP) Feature/2016.3 better postgresql grants
@ \fI2016\-09\-23 07:55:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36249\fP: (\fI\%alertedsnake\fP) Quote postgres privilege target names (refs: \fI\%#36280\fP)
.IP \(bu 2
654fa8d770 Merge pull request \fI\%#36280\fP from jwplayer/feature/2016.3\-better\-postgresql\-grants
.IP \(bu 2
e7a597da00 Bugfix: don\(aqt concatenate when not needed
.IP \(bu 2
ba60b7972a Additional documentation.
.IP \(bu 2
8b877f014d \(aqAll\(aq grants for PostgreSQL.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36508\fP: (\fI\%twangboy\fP) Fix chocolatey
@ \fI2016\-09\-23 07:36:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
8104d5c92a Merge pull request \fI\%#36508\fP from twangboy/fix_chocolatey
.IP \(bu 2
a7c858d9ab Fix retcodes
.IP \(bu 2
feadd827a7 Add additional functionality to upgrade
.IP \(bu 2
fb5eb4dc03 Fix retcodes, add upgrade function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36519\fP: (\fI\%terminalmage\fP) Rewrite minionfs walkthrough
@ \fI2016\-09\-23 05:19:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
364f74dfc9 Merge pull request \fI\%#36519\fP from terminalmage/docs
.IP \(bu 2
2df51ce3e9 Rewrite minionfs walkthrough
.IP \(bu 2
cc9d41fb0e Change items in minionfs blacklist/whitelist example
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36505\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-22 17:37:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
6f54e16cdf Merge pull request \fI\%#36505\fP from rallytime/merge\-2016.3
.IP \(bu 2
5bd4d6430b Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
bf6195b9a6 \fIpostgres_extension\fP state: small corrections in docstrings (\fI\%#36500\fP)
.IP \(bu 2
b021ea5d40 Merge pull request \fI\%#36464\fP from vutny/postgres\-tablespace\-options
.INDENT 2.0
.IP \(bu 2
580aed87b9 Fix \fIoptions\fP parameter processing in \fIpostgres_tablespace.present\fP
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35813\fP: (\fI\%UtahCampusD\fP) Empty dictionary returned from grains.items command within local client (refs: \fI\%#36496\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36496\fP: (\fI\%cachedout\fP) Add repr to namespacedict
@ \fI2016\-09\-22 04:34:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
464c4305f9 Merge pull request \fI\%#36496\fP from cachedout/namespace_repr
.IP \(bu 2
333842c319 Add repr to namespacedict
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36474\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-22 04:16:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
a0f838af36 Merge pull request \fI\%#36474\fP from rallytime/merge\-2016.3
.IP \(bu 2
8805b57a1e Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
41d3c09857 Merge pull request \fI\%#35433\fP from terminalmage/issue34790
.INDENT 2.0
.IP \(bu 2
71b51f49ba Add integration tests for PR \fI\%#35433\fP
.IP \(bu 2
82515eccde Add an additional hint for cases where rev == \(aqHEAD\(aq
.IP \(bu 2
4b7e2f9475 git.latest: Add a hint for possible rev changes resulting in non\-fast\-forward failures
.UNINDENT
.IP \(bu 2
87263b9387 Merge pull request \fI\%#36445\fP from notpeter/salt_cloud_iam_role
.INDENT 2.0
.IP \(bu 2
469d1a61fe Remove (required).
.IP \(bu 2
98449e66f5 Better docs for use\-instance\-role\-credentials.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36475\fP: (\fI\%amendlik\fP) GitFS online documentation is missing a section present in the code (refs: \fI\%#36478\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36478\fP: (\fI\%rallytime\fP) Add the \(dqbash\(dq option to the \(dqcode\-block\(dqdirective.
@ \fI2016\-09\-22 04:15:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec4f4f49ca Merge pull request \fI\%#36478\fP from rallytime/fix\-36475
.IP \(bu 2
7be7d5832f Add the \(dqbash\(dq option to the \(dqcode\-block\(dqdirective.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36484\fP: (\fI\%terminalmage\fP) Fix for temp files being left over by salt\-cloud execution
@ \fI2016\-09\-22 04:11:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36482\fP: (\fI\%clarkperkins\fP) Have salt\-cloud clean up tmp files (refs: \fI\%#36484\fP)
.IP \(bu 2
4c6e7bf873 Merge pull request \fI\%#36484\fP from terminalmage/salt\-cloud\-tmp\-files
.IP \(bu 2
0bf520e089 Ensure temp file is actually removed
.IP \(bu 2
072fd823f7 Use os.write() on file descriptor instead of opening a filehandle
.IP \(bu 2
f61e8d6366 Fix for temp files being left over by salt\-cloud execution
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36486\fP: (\fI\%terminalmage\fP) Improve the rebase docs in contributing guidelines
@ \fI2016\-09\-21 19:21:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
9005a87635 Merge pull request \fI\%#36486\fP from terminalmage/rebase\-docs
.IP \(bu 2
4839c325ae Improve the rebase docs in contributing guidelines
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36455\fP: (\fI\%twangboy\fP) Update docs for Windows
@ \fI2016\-09\-21 14:28:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
bc5ac9adae Merge pull request \fI\%#36455\fP from twangboy/windows_installation_docs
.IP \(bu 2
ec67a9bb2f Add cachedout\(aqs recommendations
.IP \(bu 2
26a40dadbe Update docs for Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36459\fP: (\fI\%cachedout\fP) Pr 36426
@ \fI2016\-09\-21 06:34:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
3d23371ca2 Merge pull request \fI\%#36459\fP from cachedout/pr\-36426
.IP \(bu 2
bb5c01ae9d Lint
.IP \(bu 2
85d2068326 Refactor for testing and adding related engine tests
.IP \(bu 2
266adae2fd Make sqs_events engine support owner_acct_id
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36442\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-20 23:16:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
c8e15dcdca Merge pull request \fI\%#36442\fP from rallytime/merge\-2016.3
.IP \(bu 2
2740fb7bfd Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
266dd7c00a Merge pull request \fI\%#36379\fP from twangboy/windows_grains
.INDENT 2.0
.IP \(bu 2
6138390da7 Fix typo
.IP \(bu 2
cf045e5c03 Remove comment
.IP \(bu 2
ddb6e11bcb Remove refactoring
.IP \(bu 2
45dc920db0 Clarify comments
.IP \(bu 2
211fd3b47e Improve version checking
.IP \(bu 2
88be5a3761 Check for Python 2.7.12 and 3.5.2
.IP \(bu 2
6f80f0062a Add osservicepack grain
.IP \(bu 2
04c4ec4f81 Fix lint
.IP \(bu 2
5789ea99cf Force string
.IP \(bu 2
6c5bd7664b Fix join syntax
.IP \(bu 2
ac8610d523 Add ServicePack to osrelease
.IP \(bu 2
92034936c1 Fix windows grains for os
.UNINDENT
.IP \(bu 2
5625827ee2 Merge pull request \fI\%#36378\fP from terminalmage/issue36321
.INDENT 2.0
.IP \(bu 2
7b1f621206 Fix git.latest test with local changes to reflect changes in state
.IP \(bu 2
0364fedb76 Use a single conditional
.IP \(bu 2
0dd1e7b53e git.latest Treat an up\-to\-date checkout with local changes as up\-to\-date
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36310\fP: (\fI\%thatch45\fP) Fix bug where the client will destroy the loop
@ \fI2016\-09\-20 13:14:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0a495f08b Merge pull request \fI\%#36310\fP from thatch45/keep_loop
.IP \(bu 2
a3c0d4a0ab Add docstring
.IP \(bu 2
083f1d998a Fix bug where the client will destroy the loop
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36394\fP: (\fI\%oba11\fP) fix accound_id in boto_iam and get_region in boto_sns
@ \fI2016\-09\-20 13:11:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
6e16ca46ed Merge pull request \fI\%#36394\fP from oba11/module\-fixes
.IP \(bu 2
966685020c fix accound_id in boto_iam and get_region in boto_sns
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36424\fP: (\fI\%jfindlay\fP) skip some mac_timezone tests
@ \fI2016\-09\-20 06:43:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36194\fP: (\fI\%jfindlay\fP) skip some mac_timezone tests (refs: \fI\%#36424\fP)
.IP \(bu 2
ae1fc430c2 Merge pull request \fI\%#36424\fP from jfindlay/bp\-36194
.IP \(bu 2
a20a2148bf skip some mac_timezone tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36388\fP: (\fI\%qurczak\fP) pkg.list_upgrades return debug information rather than packages list (refs: \fI\%#36428\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36428\fP: (\fI\%terminalmage\fP) A couple fixes for Antergos Linux
@ \fI2016\-09\-20 06:42:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
6319e3419a Merge pull request \fI\%#36428\fP from terminalmage/issue36388
.IP \(bu 2
b0069ad0d8 pacman.py: use os_family grain to assign as pkg virtual module
.IP \(bu 2
5d632dbfca Properly set os grain for Antergos
.IP \(bu 2
0ae8dca2d0 pkg.list_upgrades: Ignore \(dqdownloading\(dq lines in pacman output
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36373\fP: (\fI\%frioux\fP) Salt\-API does not validate input properly (refs: \fI\%#36425\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36425\fP: (\fI\%whiteinge\fP) Check for dictionary explicitly since we\(aqre accessing it as one
@ \fI2016\-09\-20 06:41:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
155bd14b5e Merge pull request \fI\%#36425\fP from whiteinge/salt\-api\-dict\-payload
.IP \(bu 2
0b63ed258f Check for dictionary explicitly since we\(aqre accessing it as one
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#18341\fP: (\fI\%falzm\fP) Dry\-running state.highstate only returns the first change  (refs: \fI\%#36199\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36199\fP: (\fI\%thatch45\fP) skip all failhards if test=True
@ \fI2016\-09\-20 05:38:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
420be364ee Merge pull request \fI\%#36199\fP from thatch45/fix_18341
.IP \(bu 2
e13d61f06a skip all failhards if test=True
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36418\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36246\fP to 2016.3 (refs: \fI\%#37120\fP)
@ \fI2016\-09\-19 21:56:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36246\fP: (\fI\%twangboy\fP) Fix test_issue_6833_pip_upgrade_pip test on OS X (refs: \fI\%#36418\fP, \fI\%#37120\fP)
.IP \(bu 2
b2365f553e Merge pull request \fI\%#36418\fP from rallytime/bp\-36246
.IP \(bu 2
aab02f28b4 Ensure we have a test venv created using virtualenv < 13.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36419\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36329\fP to 2016.3
@ \fI2016\-09\-19 21:56:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36329\fP: (\fI\%oz123\fP) Fix a minor typo in docs (refs: \fI\%#36419\fP)
.IP \(bu 2
bc703e2062 Merge pull request \fI\%#36419\fP from rallytime/bp\-36329
.IP \(bu 2
ffdebf7a25 Fix a minor typo in docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36420\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36365\fP to 2016.3
@ \fI2016\-09\-19 21:56:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36365\fP: (\fI\%Kimamisa\fP) Fix a minor typo in docs (refs: \fI\%#36420\fP)
.IP \(bu 2
fbfa0657fc Merge pull request \fI\%#36420\fP from rallytime/bp\-36365
.IP \(bu 2
864e513fca Fix a minor typo in docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36413\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-19 18:59:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
3dd2590e28 Merge pull request \fI\%#36413\fP from rallytime/merge\-2016.3
.IP \(bu 2
c64e489f6f Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
9bc4eeb71e Fix typo (\fI\%#36409\fP)
.IP \(bu 2
ac5c812e4b Fix OS identification for CloudLinux (\fI\%#36408\fP)
.IP \(bu 2
bb4d69f58a git.latest: fail gracefully for misconfigured remote repo (\fI\%#36391\fP)
.IP \(bu 2
ad7045ad3b Merge pull request \fI\%#36315\fP from puneetk/patch\-6
.INDENT 2.0
.IP \(bu 2
3ac308ac76 Update aptpkg.py
.IP \(bu 2
892cc4cd48 Update aptpkg.py
.IP \(bu 2
cbe98d97a3 Fix pylint whitespace errors
.IP \(bu 2
e5371ac720  No force_yes parameter to pkg.upgrade \fI\%#21248\fP
.UNINDENT
.IP \(bu 2
2aa6df859a Merge pull request \fI\%#36381\fP from twangboy/fix_win_service
.INDENT 2.0
.IP \(bu 2
04edea5c59 Add \(aq/y\(aq switch to the net stop and start commands
.UNINDENT
.IP \(bu 2
373c5db180 Merge pull request \fI\%#36384\fP from twangboy/update_setup_req
.INDENT 2.0
.IP \(bu 2
a817aef1c2 Add windows requirements file
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36371\fP: (\fI\%nasenbaer13\fP) _extern_path in fileclient is broken (refs: \fI\%#36305\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36305\fP: (\fI\%gtmanfred\fP) cache query args with url as well
@ \fI2016\-09\-19 18:30:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
a8a3a9f021 Merge pull request \fI\%#36305\fP from gtmanfred/2016.3
.IP \(bu 2
70e7f6d58b cache query args with url as well
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36389\fP: (\fI\%cachedout\fP) Pr 36386
@ \fI2016\-09\-17 11:54:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36386\fP: (\fI\%xiaoanyunfei\fP) fix salt\-api\(aqs default opts were covered by salt\-master \fI\%#35734\fP (refs: \fI\%#36389\fP, \fI\%#36650\fP, #saltstack/salt\(ga#36389\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#35734\fP: (\fI\%xiaoanyunfei\fP) fix salt\-api\(aqs default opts were covered by salt\-master (refs: \fI\%#36386\fP)
.IP \(bu 2
602bd2d1ef Merge pull request \fI\%#36389\fP from cachedout/pr\-36386
.IP \(bu 2
f5d63d93cc Lint
.IP \(bu 2
93269cfb65 fix salt\-api log and pid
.IP \(bu 2
\fBPR\fP \fI\%#36352\fP: (\fI\%pass\-by\-value\fP) Update versionadded and release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36369\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-16 16:31:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
495d365e54 Merge pull request \fI\%#36369\fP from rallytime/merge\-2016.3
.IP \(bu 2
37aea4188a Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
40b2e3d189 Merge pull request \fI\%#36353\fP from rallytime/refresh\-db\-cleanup
.INDENT 2.0
.IP \(bu 2
275319193a Check for Ign/Hit membership instead of == in aptpkg.refresh_db
.UNINDENT
.IP \(bu 2
df9d9b3624 Merge pull request \fI\%#36355\fP from rallytime/bp\-36288
.INDENT 2.0
.IP \(bu 2
70ffdafbf0 Schema test requires jsonschema 2.5.0 or above
.UNINDENT
.IP \(bu 2
3f308d7694 postgres_extension: report changes when an extension was installed (\fI\%#36335\fP)
.IP \(bu 2
d2a583bc22 Merge pull request \fI\%#36337\fP from cachedout/conduct
.INDENT 2.0
.IP \(bu 2
2fb61b9c9f SaltStack\(aqs code of conduct
.UNINDENT
.IP \(bu 2
ef128ad0b0 Return None when find_file identifies the path as a directory (\fI\%#36342\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36249\fP: (\fI\%alertedsnake\fP) Quote postgres privilege target names (refs: \fI\%#36280\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36330\fP: (\fI\%silenius\fP) set __virtualname__ to \(aqservice\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36338\fP: (\fI\%jbonachera\fP) infoblox.present state does not use \(dqinfoblox_server\(dq, \(dqinfoblox_user\(dq or \(dqinfoblox_password\(dq arguments (refs: \fI\%#36339\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36339\fP: (\fI\%jbonachera\fP) Use infoblox_* values if present in arguments
.IP \(bu 2
\fBPR\fP \fI\%#36345\fP: (\fI\%gtmanfred\fP) remove help message from glance module
.IP \(bu 2
\fBPR\fP \fI\%#36346\fP: (\fI\%rallytime\fP) Add resize2fs unit test from blockdev_test to disk_test
.IP \(bu 2
\fBPR\fP \fI\%#36344\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3 (refs: \fI\%#36346\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36292\fP: (\fI\%lorengordon\fP) pkg.check_db is not available in salt 2016.3? (refs: \fI\%#36350\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36350\fP: (\fI\%terminalmage\fP) Add note about yumpkg.check_db removal in Boron
@ \fI2016\-09\-15 20:32:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
f09c3e499f Merge pull request \fI\%#36350\fP from terminalmage/docs
.IP \(bu 2
b815c98577 Add note about yumpkg.check_db removal in Boron
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36344\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3 (refs: \fI\%#36346\fP)
@ \fI2016\-09\-15 17:38:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
a33da842c0 Merge pull request \fI\%#36344\fP from rallytime/merge\-2016.3
.IP \(bu 2
d1f560147d Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
dc518c5340 Skip test_resize2fs if resize2fs does not exists (\fI\%#36325\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36308\fP: (\fI\%ahammond\fP) salt\-cloud defaults to IPv6 rather than IPv6 (refs: \fI\%#36312\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36312\fP: (\fI\%ahammond\fP) merge error overwrites correct ssh_host with stale data in ip_address
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35819\fP: (\fI\%cable2999\fP) pkg.group_installed doesn\(aqt handle missing package group (refs: #\(gasaltstack/salt\(ga#35907\(ga_\(ga_, \fI\%#35907\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35907\fP: (\fI\%rallytime\fP) Catch CommandExecutionError when the group in group_installed doesn\(aqt exist (refs: \fI\%#36299\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36299\fP: (\fI\%rallytime\fP) Gate the pkg.group_installed state test: not all pkg modules have group_install
@ \fI2016\-09\-14 19:04:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a3019bbf1 Merge pull request \fI\%#36299\fP from rallytime/gate\-pkg\-group\-installed\-test
.IP \(bu 2
9e15df9b23 Switch the order of the decorator
.IP \(bu 2
ee997be6d8 Fix pkg group test by passing a list instead of str
.IP \(bu 2
c7d8867096 Gate the pkg.group_installed state test: not all pkg modules have group_install
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33686\fP: (\fI\%BretFisher\fP) blockreplace marker_end isn\(aqt applied with newline (refs: #\(gasaltstack/salt\(ga#36273\(ga_\(ga_, \fI\%#36273\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36273\fP: (\fI\%techhat\fP) Add append_newline flag for \fI\%#33686\fP (refs: \fI\%#36295\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36295\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36273\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#36273\fP: (\fI\%techhat\fP) Add append_newline flag for \fI\%#33686\fP (refs: \fI\%#36295\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36296\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36124\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#36124\fP: (\fI\%twangboy\fP) Skip test on all OS\(aqs but linux (refs: \fI\%#36296\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36297\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-14 16:07:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
a8a72c985f Merge pull request \fI\%#36297\fP from rallytime/merge\-2016.3
.IP \(bu 2
e2f1cf6025 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
b9b8e45362 Merge pull request \fI\%#36272\fP from terminalmage/improved\-gitfs\-logging
.INDENT 2.0
.IP \(bu 2
223a20e987 Improved gitfs/git_pillar error logging
.UNINDENT
.IP \(bu 2
abb6aacb4b Merge pull request \fI\%#36277\fP from terminalmage/gitfs\-check\-key\-path
.INDENT 2.0
.IP \(bu 2
4fee18c820 salt.utils.gitfs: Check for existence of ssh keys
.UNINDENT
.IP \(bu 2
ed2d2bd331 Integration tests fixes for 2015.8 (\fI\%#36262\fP)
.IP \(bu 2
297a12c387 Fix misspelling of \(dqoccurred\(dq in log messages/exceptions (\fI\%#36270\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36178\fP: (\fI\%cachedout\fP) Filter out pub kwargs from cloud runner
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36238\fP: (\fI\%pass\-by\-value\fP) Add ability to clone from a snapshot to salt\-cloud vmware driver
@ \fI2016\-09\-14 05:31:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc7a1d536f Merge pull request \fI\%#36238\fP from pass\-by\-value/vmware_clone_from_snapshot
.IP \(bu 2
dd670bd18f Fix lint error and add try except
.IP \(bu 2
d96981639b Add ability to clone from a snapshot to salt\-cloud vmware driver
.IP \(bu 2
\fBPR\fP \fI\%#36263\fP: (\fI\%meaksh\fP) Integration tests fixes for 2016.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36264\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-13 18:25:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
d634fd8628 Merge pull request \fI\%#36264\fP from rallytime/merge\-2016.3
.IP \(bu 2
f603757b55 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
931486ba35 Merge pull request \fI\%#36096\fP from twangboy/update_setup
.INDENT 2.0
.IP \(bu 2
dc1988add5 fix download when requests not present
.IP \(bu 2
b4479bff5f Add additional required dll\(aqs
.UNINDENT
.IP \(bu 2
b0dd6ff5c8 Merge pull request \fI\%#36244\fP from terminalmage/gen\-back\-bug
.INDENT 2.0
.IP \(bu 2
363b21fd9b salt.fileserver.Fileserver: Don\(aqt try to split a list in _gen_back
.UNINDENT
.IP \(bu 2
dcc9380996 Merge pull request \fI\%#36245\fP from terminalmage/roots\-bug
.INDENT 2.0
.IP \(bu 2
75d4997b70 roots backend: Don\(aqt include \(aq.\(aq or \(aq..\(aq in empty_dirs
.UNINDENT
.IP \(bu 2
fdf40907b7 Some unit tests fixes (\fI\%#36227\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33525\fP: (\fI\%anlutro\fP) file.serialize no longer indents/pretty\-prints in 2016.3 (refs: \fI\%#35688\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35688\fP: (\fI\%cachedout\fP) Splat serializer default configs into the serializer kwargs
@ \fI2016\-09\-13 09:21:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
de06116075 Merge pull request \fI\%#35688\fP from cachedout/issue_33525
.IP \(bu 2
4910e8191c Provide fallback for serializers without opts
.IP \(bu 2
a238666aba Add serializer test
.IP \(bu 2
345fd2a9e5 Splat serializer default configs into the serializer kwargs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36021\fP: (\fI\%mirceaulinic\fP) Scheduled runners not executed (for proxy minions, at least) (refs: \fI\%#36025\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36025\fP: (\fI\%mirceaulinic\fP) Potential fix for \fI\%#36021\fP
@ \fI2016\-09\-13 07:46:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
d9d477ed45 Merge pull request \fI\%#36025\fP from cloudflare/CF\-FIX\-36021
.IP \(bu 2
03007be6b1 Potential fix for \fI\%#36021\fP
.IP \(bu 2
\fBPR\fP \fI\%#36183\fP: (\fI\%opdude\fP) Fix timezones states on OS X
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36235\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-12 17:40:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
fcbebb40c3 Merge pull request \fI\%#36235\fP from rallytime/merge\-2016.3
.IP \(bu 2
99dcf84b62 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
4e9490eebe Merge pull request \fI\%#36214\fP from vutny/postgres\-extension\-doc
.INDENT 2.0
.IP \(bu 2
5fe548f043 \fIpostgres_extension\fP state module: fix docstrings
.UNINDENT
.IP \(bu 2
5b7b96c0b7 Merge pull request \fI\%#36205\fP from vutny/postgres\-tablespace\-doc
.INDENT 2.0
.IP \(bu 2
78296b90d8 Add missing \fImaintenance_db\fP kwarg to \fIpostgres_tablespace.present\fP docstring
.UNINDENT
.IP \(bu 2
6a5f7cb346 Ignore states that do not have a numeric jid, i.e. \(aqreq\(aq (\fI\%#36185\fP)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35423\fP: (\fI\%Ch3LL\fP) Stacktrace when running state.sls against an sls does not exist (refs: \fI\%#36137\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33915\fP: (\fI\%mattglv\fP) Orchestration runner output on Success vs Failures in 2016.3.0 (refs: \fI\%#36137\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#25664\fP: (\fI\%sdm24\fP) 2015.5.2  MySQL Returner: salt\-run jobs.lookup_jid doesn\(aqt return full result for highstate output (refs: \fI\%#35559\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36137\fP: (\fI\%cachedout\fP) Allow highstate outputter to show all results
@ \fI2016\-09\-12 16:37:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35559\fP: (\fI\%Jlin317\fP) Fix highstate outputter when it\(aqs given multiple results (refs: \fI\%#36137\fP)
.IP \(bu 2
7b96197c5e Merge pull request \fI\%#36137\fP from cachedout/issue_35423
.IP \(bu 2
1e8431f2b8 Allow highstate outputter to show all results
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35340\fP: (\fI\%dqminh\fP) Custom modules are only resynced to minions at highstate (refs: \fI\%#36217\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36217\fP: (\fI\%cachedout\fP) Docs clarification for module sync and state.apply
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35480\fP: (\fI\%jelenak\fP) 200 processes of salt\-master (2016.3.2) (refs: \fI\%#36184\fP, \fI\%#36555\fP, \fI\%#37254\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36184\fP: (\fI\%DmitryKuzmenko\fP) Disable signal handling while handling signal
@ \fI2016\-09\-11 22:59:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
6ebe655e17 Merge pull request \fI\%#36184\fP from DSRCorporation/bugs/35480_master_shutdown
.IP \(bu 2
229504efef Removed unused import.
.IP \(bu 2
ca8eb7e076 Don\(aqt run the same signal handler twice. Catch os.kill errors.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36203\fP: (\fI\%xiaoanyunfei\fP) fix owner of MultiprocessingLoggingQueue (refs: \fI\%#37119\fP)
@ \fI2016\-09\-11 09:15:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
f11f093f8c Merge pull request \fI\%#36203\fP from xiaoanyunfei/logowner
.IP \(bu 2
74dc90c7bb cancle pr last
.IP \(bu 2
90e4a25dd0 Merge branch \(aqlogowner\(aq of \fI\%https://github.com/xiaoanyunfei/salt\fP into logowner
.INDENT 2.0
.IP \(bu 2
bd61b88fc8 fix log owner
.IP \(bu 2
58160ed6c0 Merge branch \(aq2016.3\(aq of github.com:saltstack/salt into 2016.3
.IP \(bu 2
f2de71782b move back
.IP \(bu 2
b8214824fd add simplify code
.IP \(bu 2
aec9385c6b Merge branch \(aq2016.3\(aq of github.com:saltstack/salt into 2016.3
.IP \(bu 2
1074b3355d Merge branch \(aq2016.3\(aq of github.com:saltstack/salt into 2016.3
.IP \(bu 2
ea0d74cd27 fix salt\-api opts
.UNINDENT
.IP \(bu 2
ffd87b2f2f fix logqueue owner
.IP \(bu 2
\fBPR\fP \fI\%#36193\fP: (\fI\%thatch45\fP) Fix stack trace in salt\-ssh gitfs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36188\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-09 18:59:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
f035121291 Merge pull request \fI\%#36188\fP from rallytime/merge\-2016.3
.IP \(bu 2
521a7b2470 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
d4628f3c6b Allow additional kwargs in states.dockerng.image_present (\fI\%#36156\fP)
.IP \(bu 2
24b0387b92 Back\-port \fI\%#36070\fP to 2015.8 (\fI\%#36169\fP)
.IP \(bu 2
116d7ac3e5 If windows pkg db hasn\(aqt been created yet, refresh the db instead of stacktracing (\fI\%#36008\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35819\fP: (\fI\%cable2999\fP) pkg.group_installed doesn\(aqt handle missing package group (refs: #\(gasaltstack/salt\(ga#35907\(ga_\(ga_, \fI\%#35907\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35907\fP: (\fI\%rallytime\fP) Catch CommandExecutionError when the group in group_installed doesn\(aqt exist
@ \fI2016\-09\-09 10:14:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
1d5f97d36b Merge pull request \fI\%#35907\fP from rallytime/fix\-35819
.IP \(bu 2
d7380d83be requires_system_grains decorator needs a grains=None kwarg
.IP \(bu 2
b20f6b9384 Catch CommandExecutionError when group_installed doesn\(aqt exist
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#35972\fP: (\fI\%tjyang\fP) DeprecationWarning: The \(dqosmajorrelease\(dq will be a type of an integer. (refs: \fI\%#36068\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35637\fP: (\fI\%cachedout\fP) Add Nitrogen release notes  (refs: \fI\%#36068\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36068\fP: (\fI\%rallytime\fP) Remove grains type deprecation warning from 2016.3
@ \fI2016\-09\-09 10:00:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
40127b6bf3 Merge pull request \fI\%#36068\fP from rallytime/fix\-35972
.IP \(bu 2
2b7679c9f6 Remove grains type deprecation warning from 2016.3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36094\fP: (\fI\%UtahDave\fP) Windows stacktraces on msgpack on Carbon (refs: \fI\%#36152\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36152\fP: (\fI\%cachedout\fP) Remove unnecessary unpack
@ \fI2016\-09\-09 09:13:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
24bd03734d Merge pull request \fI\%#36152\fP from cachedout/issue_36094
.IP \(bu 2
95eb95a0f8 Remove unnecessary unpack
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36158\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-08 21:53:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
dc3a68ed8c Merge pull request \fI\%#36158\fP from rallytime/merge\-2016.3
.IP \(bu 2
7f955bda0a Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
6242702288 Fix issue with cp.push (\fI\%#36136\fP)
.IP \(bu 2
0e13118f6e Document \fIowner\fP kwarg for \fIpostgres_schema.present\fP state function (\fI\%#36147\fP)
.IP \(bu 2
4cc8ea9577 Merge pull request \fI\%#36146\fP from meaksh/tests\-fixes\-for\-2015.8
.INDENT 2.0
.IP \(bu 2
9f9aa4779c rename darwin_sysctl.py to mac_sysctl.py
.IP \(bu 2
2cf6f36d89 modules.darwin_sysctl: __virtual__ return err msg.
.IP \(bu 2
f74ca15f50 Remove test for file dir behavior
.IP \(bu 2
c65aefee20 Fix tests that assert CommandExecutionError (\fI\%#32485\fP)
.IP \(bu 2
f8c0b439b8 Fixed more lint
.IP \(bu 2
63ff731009 Fixed tests
.IP \(bu 2
04b1a4a9ca Fixed use of assert_has_calls in tests.
.IP \(bu 2
46e4bb58e5 Fixed LoadAuthTestCase
.IP \(bu 2
4e9733ad6d Rename dockerio.py unit tests to dockerio_test.py
.IP \(bu 2
ec0cc943e0 Make sure spm tests are picked up by runtests.
.IP \(bu 2
2605f34849 Fix missing first data in stream when subscribing stream using a function \(aqread_async\(aq.
.IP \(bu 2
305bab8be0 Fixed _interfaces_ifconfig output for SunOS test
.IP \(bu 2
b5ca02c867 Fix tests that assert CommandExecutionError (\fI\%#32485\fP)
.IP \(bu 2
1fb6340fef Fix tests (\fI\%#35693\fP)
.IP \(bu 2
5977f1f54c Skip utils_test if timelib is not installed (\fI\%#32699\fP)
.IP \(bu 2
d1b9a4061e Fixing skipped boto tests to prevent errors if boto3 does not exists.
.UNINDENT
.IP \(bu 2
c4ddfe3887 Merge pull request \fI\%#35954\fP from morganwillcock/upgrade\-on\-batteries
.INDENT 2.0
.IP \(bu 2
108f9470f2 win_pkg: report failure for failed launch of Scheduled Task
.IP \(bu 2
e0978220f7 win_pkg: allow minion upgrade when using batteries
.UNINDENT
.IP \(bu 2
94b7659304 Merge pull request \fI\%#36129\fP from terminalmage/pygit2\-ssl_verify
.INDENT 2.0
.IP \(bu 2
640f0c17c6 pygit2: Prevent traceback on initial gitfs setup
.UNINDENT
.IP \(bu 2
7cdbc546f1 Back\-port \fI\%#36062\fP to 2015.8 (\fI\%#36118\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36170\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36154\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#36154\fP: (\fI\%DavidWittman\fP) Remove unclosed backticks in walkthrough doc (refs: \fI\%#36170\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36055\fP: (\fI\%gladiatr72\fP) 2016.3.3 \-\- missing salt\-cloud events on the master event bus (refs: \fI\%#36161\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36161\fP: (\fI\%jacobhammons\fP) Adds \fI\%#36055\fP to release notes
@ \fI2016\-09\-08 17:11:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ccf8a841f Merge pull request \fI\%#36161\fP from jacobhammons/relnotes
.IP \(bu 2
ecb0979be7 Adds \fI\%#36055\fP to release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36139\fP: (\fI\%meaksh\fP) Fixing unit tests for 2016.3
@ \fI2016\-09\-08 13:20:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f909038f0 Merge pull request \fI\%#36139\fP from meaksh/tests\-fixes\-for\-2016.3
.IP \(bu 2
52a7ed605e Fixed _interfaces_ifconfig output for SunOS test
.IP \(bu 2
158bcbff65 Fix tests that assert CommandExecutionError (\fI\%#32485\fP)
.IP \(bu 2
8b480167e1 Fix tests (\fI\%#35693\fP)
.IP \(bu 2
29814f9d43 Skip utils_test if timelib is not installed (\fI\%#32699\fP)
.IP \(bu 2
d1d806f893 Fix PortageConfigTestCase in case of portage is not present
.IP \(bu 2
1c260e4bd0 Fix tests to prevent errors when libcloud is not present
.IP \(bu 2
71ebf2c8cd Fixing skipped boto tests to prevent errors if boto3 does not exists.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36143\fP: (\fI\%multani\fP) doc: fix doc formatting for salt.states.mount
@ \fI2016\-09\-08 13:11:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
3eb3df55ad Merge pull request \fI\%#36143\fP from multani/fix\-doc\-state\-mount
.IP \(bu 2
035a212a9b doc: fix doc formatting for salt.states.mount
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#18419\fP: (\fI\%jasonrm\fP) salt\-cloud fails to run as non\-root user (refs: \fI\%#35483\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#36057\fP: (\fI\%Inveracity\fP) Regression in opennebula cloud provider (refs: \fI\%#36070\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34806\fP: (\fI\%jerrykan\fP) salt\-cloud ignores sock_dir when firing event (refs: \fI\%#35483\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36070\fP: (\fI\%rallytime\fP) Use __utils__ instead of salt.utils.cloud in opennebula driver (refs: \fI\%#36169\fP)
@ \fI2016\-09\-08 01:18:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35483\fP: (\fI\%gtmanfred\fP) use __utils__ in salt.cloud (refs: \fI\%#35855\fP, \fI\%#37057\fP, \fI\%#36070\fP)
.IP \(bu 2
70da628018 Merge pull request \fI\%#36070\fP from rallytime/fix\-36057
.IP \(bu 2
de4f77cb68 Fixup failing test: need to mock __utils__ instead of salt.utils.cloud call
.IP \(bu 2
25e3f2b4b8 Use __utils__ instead of salt.utils.cloud in opennebula driver
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36089\fP: (\fI\%terminalmage\fP) Support running git states / remote exec funcs as a different user in Windows
@ \fI2016\-09\-08 01:17:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
b7556a2aeb Merge pull request \fI\%#36089\fP from terminalmage/issue35565
.IP \(bu 2
796156c5f5 Add attribution
.IP \(bu 2
2e56527ead Move command logging to before win_runas
.IP \(bu 2
91eafddda6 Pass the \(dqpassword\(dq param to git module functions
.IP \(bu 2
7871065d32 Use \(dquser\(dq instead of \(dqrunas\(dq in _git_run() helper
.IP \(bu 2
5943b4662c Add \(dqpassword\(dq param to funcs which support the user parameter
.IP \(bu 2
5c7b9f0341 Make \(dqpassword\(dq an explicit argument, not a kwarg
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35923\fP: (\fI\%kstreee\fP) Fixes a bug that Ctrl\-c not working on Salt CLI.
@ \fI2016\-09\-07 11:47:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
45ba2e806b Merge pull request \fI\%#35923\fP from kstreee/fix\-cli\-stalling
.IP \(bu 2
6569267afc Fixes a bug that Ctrl\-c not working on Salt CLI.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18341\fP: (\fI\%falzm\fP) Dry\-running state.highstate only returns the first change  (refs: \fI\%#36078\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36078\fP: (\fI\%thatch45\fP) Failhard test=True fix
@ \fI2016\-09\-07 05:10:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
48dc5ad4ee Merge pull request \fI\%#36078\fP from thatch45/failhard_test
.IP \(bu 2
9b36904149 Fix failhard causing test=True to failhard too soon
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34515\fP: (\fI\%vernondcole\fP) Please actually implement skip_verify for archive.extracted (refs: \fI\%#34529\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34529\fP: (\fI\%Ch3LL\fP) Add skip_verify for archive.extracted
@ \fI2016\-09\-06 21:05:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
40081176af Merge pull request \fI\%#34529\fP from Ch3LL/add_skip_verify_archive
.IP \(bu 2
38203e3d2c add tornado web app to serve up static file for test
.IP \(bu 2
617f5680e4 add windows path and add custom tar
.IP \(bu 2
c5035118bf add skip_verify option to archive.extracted
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36073\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-06 19:45:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc41c744a0 Merge pull request \fI\%#36073\fP from rallytime/merge\-2016.3
.IP \(bu 2
e9c634685b Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
fa09050150 consul: fix formatting of consul.agent_join (\fI\%#36061\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36030\fP: (\fI\%whiteinge\fP) Add include_* kwargs to the *_dict key functions (refs: \fI\%#36040\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36040\fP: (\fI\%rallytime\fP) Add docs for new kwargs added to the wheel key module
.IP \(bu 2
\fBPR\fP \fI\%#36047\fP: (\fI\%whiteinge\fP) Doc cherrypy deemphasize urlencoded
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36039\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-02 21:50:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
74143999d3 Merge pull request \fI\%#36039\fP from rallytime/merge\-2016.3
.IP \(bu 2
5f499cfd41 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
1b39c7ed48 Merge pull request \fI\%#35978\fP from DSRCorporation/bugs/28462_update_auth_data_on_reauth
.INDENT 2.0
.IP \(bu 2
778ae9a9ff Update auth data on reauth.
.UNINDENT
.IP \(bu 2
b652271ddc Fix type error in networkfbsd osmajorrelease compare (\fI\%#36016\fP)
.IP \(bu 2
bc81818075 Merge pull request \fI\%#36018\fP from meaksh/bp\-36000\-to\-2015.8
.INDENT 2.0
.IP \(bu 2
8c05d2aac5 Lint for \fI\%#35916\fP
.IP \(bu 2
b5fe6100ee Check for single quote before splitting on single quote
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#35683\fP: (\fI\%JensRantil\fP) Salt wheel key documentation improvements (refs: \fI\%#35824\fP, #saltstack/salt\(ga#35824\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35824\fP: (\fI\%rallytime\fP) Add more documentation to the wheel key module (refs: \fI\%#36038\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36038\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35824\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#35824\fP: (\fI\%rallytime\fP) Add more documentation to the wheel key module (refs: \fI\%#36038\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36033\fP: (\fI\%gtmanfred\fP) catch unicode encoding errors in json outputter
.IP \(bu 2
\fBPR\fP \fI\%#36010\fP: (\fI\%eliasp\fP) modules.service: Do not default to OpenRC on Gentoo, also allow systemd
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33969\fP: (\fI\%Inveracity\fP) Redis returner stacktrace in clean_old_jobs 2016.3.0 (refs: \fI\%#33998\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36014\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33998\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#33998\fP: (\fI\%jizhilong\fP) fix redis_return\(aqs clean_old_jobs. (refs: \fI\%#36014\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35618\fP: (\fI\%komljen\fP) [salt\-cloud] With \(aqmake_master: True\(aq minions are configured with the masters public IP address on AWS (refs: \fI\%#35919\fP, #saltstack/salt\(ga#35919\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35919\fP: (\fI\%rallytime\fP) Add documentation about salt_interface to EC2 docs (refs: \fI\%#36015\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36015\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35919\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#35919\fP: (\fI\%rallytime\fP) Add documentation about salt_interface to EC2 docs (refs: \fI\%#36015\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36000\fP: (\fI\%rallytime\fP) Lint \fI\%#35916\fP (refs: \fI\%#36019\fP, \fI\%#36018\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35916\fP: (\fI\%swiftgist\fP) Check for single quote before splitting on single quote (refs: \fI\%#36019\fP, \fI\%#36018\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36019\fP: (\fI\%meaksh\fP) Back\-port \fI\%#36000\fP to 2016.3
@ \fI2016\-09\-02 20:34:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36000\fP: (\fI\%rallytime\fP) Lint \fI\%#35916\fP (refs: \fI\%#36019\fP, \fI\%#36018\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35916\fP: (\fI\%swiftgist\fP) Check for single quote before splitting on single quote (refs: #\(gasaltstack/salt\(ga#36000\(ga_\(ga_, \fI\%#36000\fP)
.IP \(bu 2
e88df5845d Merge pull request \fI\%#36019\fP from meaksh/bp\-36000\-to\-2016.3
.IP \(bu 2
1b2abeabd1 Lint for \fI\%#35916\fP
.IP \(bu 2
8b4f46fbd0 Check for single quote before splitting on single quote
.IP \(bu 2
\fBPR\fP \fI\%#36028\fP: (\fI\%thatch45\fP) Fix error when profiling is turned on and minions don\(aqt return (refs: \fI\%#36730\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36030\fP: (\fI\%whiteinge\fP) Add include_* kwargs to the *_dict key functions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#31454\fP: (\fI\%johje349\fP) Salt Mine memory leak (refs: \fI\%#36024\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36024\fP: (\fI\%DmitryKuzmenko\fP) Don\(aqt subscribe to events if not sure it would read them. (refs: \fI\%#36720\fP)
@ \fI2016\-09\-02 15:41:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
cd60ec5d57 Merge pull request \fI\%#36024\fP from DSRCorporation/bugs/31454_local_client_memleak
.IP \(bu 2
01911c530e Don\(aqt subscribe to events if not sure it would read them.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36023\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-02 15:37:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
32d5f896d4 Merge pull request \fI\%#36023\fP from rallytime/merge\-2016.3
.IP \(bu 2
a63c9dfc6a Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
e6b93c2380 Merge pull request \fI\%#36022\fP from saltstack/revert\-33770\-service_tests
.INDENT 2.0
.IP \(bu 2
6cf56843d4 Revert \(dqservice state integration tests\(dq
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36004\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-09\-01 21:11:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
d248ab0120 Merge pull request \fI\%#36004\fP from rallytime/merge\-2016.3
.IP \(bu 2
318bffed1d Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
678f10cf8b Avoid traceback in mac_user.py when user.chhome is invoked from a user state (\fI\%#35901\fP)
.IP \(bu 2
2da501071e Merge pull request \fI\%#35967\fP from twangboy/improve_show_sls_2015.8
.INDENT 2.0
.IP \(bu 2
2ed9a82ef8 Allow full path to be passed to show_sls
.UNINDENT
.IP \(bu 2
d86fba15b3 Merge pull request \fI\%#35981\fP from cachedout/cptestcase_license
.INDENT 2.0
.IP \(bu 2
dd562dd200 Update Salt\(aqs licensing information to include cptestcase
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35952\fP: (\fI\%twangboy\fP) Load UserProfile when using RunAs (2016.3)
@ \fI2016\-09\-01 15:18:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
f7b85cb70b Merge pull request \fI\%#35952\fP from twangboy/fix_win_runas_2016.3
.IP \(bu 2
3721a09ea3 Load UserProfile on RunAs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35959\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-31 22:14:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
b8ca3f5e4d Merge pull request \fI\%#35959\fP from rallytime/merge\-2016.3
.IP \(bu 2
bb4605ffee Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
0f0f15d048 Merge pull request \fI\%#35956\fP from jacobhammons/dot12
.INDENT 2.0
.IP \(bu 2
3e21e35933 Version docs to 2015.8.12
.UNINDENT
.IP \(bu 2
d2db4ea7a2 cachedir should be /cloud not /master (\fI\%#35897\fP)
.IP \(bu 2
f4cdcc0d66 Better logging when file_recv_max_size is exceeded (\fI\%#35914\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35955\fP: (\fI\%jacobhammons\fP) Version docs to 2016.3.3
@ \fI2016\-08\-31 20:35:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
a87b91a8ea Merge pull request \fI\%#35955\fP from jacobhammons/dot3
.IP \(bu 2
ac8fe6ff9e Version docs to 2016.3.3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#875\fP: (\fI\%dhoffutt\fP) state pkg won\(aqt install package nscd (refs: \fI\%#35865\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35865\fP: (\fI\%jacobhammons\fP) Fix incremental doc builds \- OS X, postgres returner, tcp transport doc updates
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35829\fP: (\fI\%amontalban\fP) FreeBSD pkg.latest speed improvement (refs: \fI\%#35904\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35904\fP: (\fI\%amontalban\fP) Fixes \fI\%#35829\fP for branch 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#35931\fP: (\fI\%vutny\fP) Salt Cloud: add \fIcentos\fP default user for official CentOS AMIs
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35892\fP: (\fI\%cachedout\fP) Fixup Docker test (refs: \fI\%#35926\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35581\fP: (\fI\%pbdeuchler\fP) Correctly check if image is in current tags (refs: \fI\%#35926\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35926\fP: (\fI\%ticosax\fP) [dockerng] Mention that docker image names must be given with repository
.IP \(bu 2
\fBPR\fP \fI\%#35581\fP: (\fI\%pbdeuchler\fP) Correctly check if image is in current tags (refs: \fI\%#35926\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35825\fP: (\fI\%tjyang\fP) \(dq\(aqdrac\(aq __virtual__ returned False\(dq from salt\-run   drac.version host (refs: \fI\%#35868\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35868\fP: (\fI\%rallytime\fP) Add more helpful return messages for drac runner
@ \fI2016\-08\-31 01:33:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca06c62900 Merge pull request \fI\%#35868\fP from rallytime/fix\-35825
.IP \(bu 2
00ae17248e Update error message to be more helpful and fix doc formatting
.IP \(bu 2
30a422bfe0 Add more helpful return messages for drac runner
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35903\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 into 2016.3
@ \fI2016\-08\-30 17:15:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
95b89dbce9 Merge pull request \fI\%#35903\fP from rallytime/merge\-2016.3
.IP \(bu 2
9e55bee5d5 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
08e10f69eb Clarifies how to create aliased functions (\fI\%#35891\fP)
.IP \(bu 2
6dd5f68a08 Merge pull request \fI\%#35856\fP from vutny/2015.8
.INDENT 2.0
.IP \(bu 2
eceedadfa5 salt\-cloud: fix path to Salt Master socket dir
.UNINDENT
.IP \(bu 2
336d1a700d Merge pull request \fI\%#35880\fP from terminalmage/issue35747
.INDENT 2.0
.IP \(bu 2
123a611066 pacman.py: Fix incorrect return in pkg.latest_version
.UNINDENT
.IP \(bu 2
6383451c99 Merge pull request \fI\%#35884\fP from terminalmage/clarify\-pkg\-latest\-logic
.INDENT 2.0
.IP \(bu 2
b0b419d1d8 Fix condition for Gentoo USE flag update
.IP \(bu 2
1542fd4716 Add clarifying comments to the pkg.latest state
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#18419\fP: (\fI\%jasonrm\fP) salt\-cloud fails to run as non\-root user (refs: \fI\%#35483\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34806\fP: (\fI\%jerrykan\fP) salt\-cloud ignores sock_dir when firing event (refs: \fI\%#35483\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35855\fP: (\fI\%vutny\fP) [REGRESSION] salt\-cloud: fix path to Salt Master socket dir (refs: \fI\%#35856\fP)
@ \fI2016\-08\-30 07:09:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35483\fP: (\fI\%gtmanfred\fP) use __utils__ in salt.cloud (refs: \fI\%#35855\fP, \fI\%#37057\fP, \fI\%#36070\fP)
.IP \(bu 2
cf8f081401 Merge pull request \fI\%#35855\fP from vutny/salt\-cloud\-fix\-sock_dir
.IP \(bu 2
a662ea5337 salt\-cloud: fix path to Salt Master socket dir
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35881\fP: (\fI\%whiteinge\fP) Add fail\-safe in case Salt gives us data we can\(aqt serialize
@ \fI2016\-08\-30 06:43:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
f0987cf27a Merge pull request \fI\%#35881\fP from whiteinge/salt\-api\-catch\-serializer\-error
.IP \(bu 2
6e27fad21f Add fail\-safe in case Salt gives us data we can\(aqt serialize
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35837\fP: (\fI\%JensRantil\fP) Doc improvement: Mention engine under extension modules (refs: \fI\%#35864\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35864\fP: (\fI\%rallytime\fP) Add engines to list of extension module options in master config docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35835\fP: (\fI\%JensRantil\fP) Incorrect SQS config documentation statement (refs: \fI\%#35861\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35861\fP: (\fI\%rallytime\fP) Fix IAM roles statement to be boto version specific in sqs_events
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35834\fP: (\fI\%JensRantil\fP) Incorrect SQS engine config (refs: \fI\%#35860\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35860\fP: (\fI\%rallytime\fP) Fix doc formatting for sqs_events engine example config
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35859\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-29 18:21:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
96747bc3bb Merge pull request \fI\%#35859\fP from rallytime/merge\-2016.3
.IP \(bu 2
5f93d682aa Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
eda2ae0add Merge pull request \fI\%#35781\fP from thatch45/ssh_deploy_more
.INDENT 2.0
.IP \(bu 2
2558dcc100 follow up on the re\-deploy if there is a checksum mismatch
.UNINDENT
.IP \(bu 2
165237412c Merge pull request \fI\%#35815\fP from gtmanfred/2015.8
.INDENT 2.0
.IP \(bu 2
805d43598e list_nodes_min should return a minimum dictionary
.UNINDENT
.IP \(bu 2
b12c6577d2 Merge pull request \fI\%#35833\fP from terminalmage/2015.8\-top\-file\-merging\-docs
.INDENT 2.0
.IP \(bu 2
c534d88280 More clarification/correction in minion docs
.IP \(bu 2
e9e6ea8485 One more tweak to top file merging docs
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34478\fP: (\fI\%hujunya\fP) makedir bug in the file module (refs: \fI\%#35849\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35849\fP: (\fI\%theredcat\fP) Fix potential infinite loop with no error when using recursive makedirs
@ \fI2016\-08\-29 11:37:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
dc705ff675 Merge pull request \fI\%#35849\fP from theredcat/fix_file_makedirs_infinite_loop
.IP \(bu 2
86d5398b28 Fix potential infinite loop with no error when using recursive makedirs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35682\fP: (\fI\%vutny\fP) [BACKPORT] Fix empty \fIfun_agrs\fP field in Reactor generated events
@ \fI2016\-08\-29 04:11:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35659\fP: (\fI\%vutny\fP) Fix empty \fIfun_agrs\fP field in Reactor generated events (refs: \fI\%#35682\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35059\fP: (\fI\%vutny\fP) Add \fIfun_args\fP field to events generated by execution of Master modules (refs: \fI\%#35659\fP, \fI\%#35682\fP)
.IP \(bu 2
433743f609 Merge pull request \fI\%#35682\fP from vutny/backport\-35659
.IP \(bu 2
78d16a8057 [BACKPORT] Fix empty \fIfun_agrs\fP field in Reactor generated events
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34973\fP: (\fI\%szjur\fP) Syndic stops forwarding job results if the local salt\-master is restarted (refs: \fI\%#35792\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35792\fP: (\fI\%DmitryKuzmenko\fP) Reconnect syndic to event bus if master disappeared.
@ \fI2016\-08\-29 02:13:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
30c2db7b09 Merge pull request \fI\%#35792\fP from DSRCorporation/bugs/34973_syndic_reconnect_master_2016.3
.IP \(bu 2
9afdbb0e97 Reconnect syndic to master event bus if master disappears.
.IP \(bu 2
ab1afd002e Fixed syndic event bus connection.
.IP \(bu 2
ea8e1385c1 Fixed syndic unhandled future exception if master is stopped.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35817\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-26 20:44:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
43c08ae431 Merge pull request \fI\%#35817\fP from rallytime/merge\-2016.3
.IP \(bu 2
e8e73b55ac Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
d285fe64b7 Merge pull request \fI\%#35811\fP from rallytime/bp\-35576
.INDENT 2.0
.IP \(bu 2
04c063b315 Updated user.py to redact password when test=true
.UNINDENT
.IP \(bu 2
e212c55b7a Schedule documentation update (\fI\%#35745\fP)
.IP \(bu 2
eb4d2f299b Better unicode handling in gitfs (\fI\%#35802\fP)
.IP \(bu 2
0ee237a9cb Remove extra \(dqto\(dq in top.rst docs (\fI\%#35808\fP)
.IP \(bu 2
2fc61763d8 Correct the top_file_merging_strategy documentation (\fI\%#35774\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35788\fP: (\fI\%hu\-dabao\fP) fix 34241, webutil.useradd_all is deprecated
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#33536\fP: (\fI\%murzick\fP) pkgrepo.managed does not disable a yum repo with \(dqdisabled: True\(dq (refs: \fI\%#35055\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33536\fP: (\fI\%murzick\fP) pkgrepo.managed does not disable a yum repo with \(dqdisabled: True\(dq (refs: \fI\%#35055\fP, \fI\%#35806\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35810\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35806\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#35806\fP: (\fI\%rallytime\fP) Bump the deprecation warning in pkgrepo state to Nitrogen (refs: \fI\%#35810\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35055\fP: (\fI\%galet\fP) \fI\%#33536\fP pkgrepo.managed does not disable a yum repo with \(dqdisabled: True\(dq (refs: \fI\%#35806\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35741\fP: (\fI\%fix7\fP) modjk: use of auth credentials to access jk\-status broken (refs: \fI\%#35796\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35796\fP: (\fI\%fix7\fP) Fix \fI\%#35741\fP
.IP \(bu 2
\fBPR\fP \fI\%#35807\fP: (\fI\%jacobhammons\fP) Adds mock for tornado.locks
.IP \(bu 2
\fBPR\fP \fI\%#35800\fP: (\fI\%alexander\-bauer\fP) Trivial documentation spelling fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35763\fP: (\fI\%isbm\fP) Sphinx crash: documentation config fix
@ \fI2016\-08\-25 21:12:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
9b5ee2155e Merge pull request \fI\%#35763\fP from isbm/isbm\-doc\-conf\-sphinx\-crashfix
.IP \(bu 2
a56ae4e8f5 Configure importing Mock to handle \(aqtotal\(aq method from psutils properly
.IP \(bu 2
9c057d0266 Return psutil back to the list of mocked imports
.IP \(bu 2
3d7758461e Improve Mock to be flexible and able to mock methods from the mocked modules
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35771\fP: (\fI\%bdrung\fP) Spelling errors in salt 2016.3.2 (refs: \fI\%#35773\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35773\fP: (\fI\%rallytime\fP) Documentation spelling fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35767\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-25 16:09:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
e355c1cf90 Merge pull request \fI\%#35767\fP from rallytime/merge\-2016.3
.IP \(bu 2
8ad6a12c80 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
2a12795bac Fixes Windows download paths (\fI\%#35742\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#20575\fP: (\fI\%starchy\fP) \(dqsalt \-\-subset=n\(dq appears to always choose the same nodes (refs: \fI\%#35753\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35753\fP: (\fI\%rallytime\fP) Fixup the unit.client_test.LocalClientTestCase.test_cmd_subset from \fI\%#35720\fP
@ \fI2016\-08\-25 15:55:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35720\fP: (\fI\%hu\-dabao\fP) fix 20575, make subset really return random subset (refs: \fI\%#35753\fP)
.IP \(bu 2
b3f6367621 Merge pull request \fI\%#35753\fP from rallytime/fix\-client\-unit\-test
.IP \(bu 2
92f8c836e8 Add cmd_mock back in to function spec
.IP \(bu 2
a671f0a092 Fixup the unit.client_test.LocalClientTestCase.test_cmd_subset from \fI\%#35720\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35458\fP: (\fI\%iggy\fP) SALT.STATES.APACHE_MODULE needs version annotations (refs: \fI\%#35732\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35732\fP: (\fI\%rallytime\fP) Add versionadded for enabled function in apache_module state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35737\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-24 19:48:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
bab0e3d449 Merge pull request \fI\%#35737\fP from rallytime/merge\-2016.3
.IP \(bu 2
61e37d5956 Merge branch \(aq2015.8\(aq into \(aq2106.3\(aq
.IP \(bu 2
06a75be8bd Merge pull request \fI\%#35701\fP from gtmanfred/2015.8
.INDENT 2.0
.IP \(bu 2
2d2bc1ffea use aws.get_location in s3 modules
.UNINDENT
.IP \(bu 2
79bc01b88c Make test runs behave better (\fI\%#35708\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35729\fP: (\fI\%cachedout\fP) Remove docs mocks for msgpack and psutils
@ \fI2016\-08\-24 14:42:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
7877ff1d5e Merge pull request \fI\%#35729\fP from cachedout/fix_docs_build
.IP \(bu 2
fdbf01d5ad Remove docs mocks for msgpack and psutils
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35628\fP: (\fI\%jf\fP) Fix user.present state reporting for groups when remove_groups=false
@ \fI2016\-08\-24 08:15:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
962e493304 Merge pull request \fI\%#35628\fP from jf/fix_user.present_reporting_when_remove_groups=false
.IP \(bu 2
1f818c832e Fix user.present state reporting for groups when remove_groups=false
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35696\fP: (\fI\%xiaoanyunfei\fP) fix maximum recursion depth bug
@ \fI2016\-08\-24 08:01:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
02d86c6550 Merge pull request \fI\%#35696\fP from xiaoanyunfei/2016.3
.IP \(bu 2
5db9255926 fix maximum recursion depth
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35720\fP: (\fI\%hu\-dabao\fP) fix 20575, make subset really return random subset (refs: \fI\%#35753\fP)
@ \fI2016\-08\-24 07:03:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
79d10aea2d Merge pull request \fI\%#35720\fP from hu\-dabao/fix\-20575
.IP \(bu 2
70af980c01 fix 20575, make subset really return random subset
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35700\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-23 17:23:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
5d0b9a248e Merge pull request \fI\%#35700\fP from rallytime/merge\-2016.3
.IP \(bu 2
9e9923c3f4 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
aee5b62542 Merge pull request \fI\%#35680\fP from terminalmage/issue35630
.INDENT 2.0
.IP \(bu 2
d76659a63a Don\(aqt use six.text_type() in salt.utils.gitfs
.UNINDENT
.IP \(bu 2
74678923b8 Fixup doc formatting for the sqs_events engine (\fI\%#35663\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35634\fP: (\fI\%hu\-dabao\fP) fix 34922, StopIteration should not throw exception out
@ \fI2016\-08\-23 08:13:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
f305389172 Merge pull request \fI\%#35634\fP from hu\-dabao/fix\-34922
.IP \(bu 2
fe338ff41f fix 34922, StopIteration should not throw exception out
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35679\fP: (\fI\%twangboy\fP) Revert to vcredist 12 (2013)
@ \fI2016\-08\-23 08:05:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
e45aa55d79 Merge pull request \fI\%#35679\fP from twangboy/change.vcredist.version.2016.3
.IP \(bu 2
3d6d473d48 Revert to vcredist 12 (2013)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35662\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-22 19:03:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
9fe0972761 Merge pull request \fI\%#35662\fP from rallytime/merge\-2016.3
.IP \(bu 2
1d819d7cc2 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
399e9f57cc Update release notes for 2015.8.12 (\fI\%#35614\fP)
.IP \(bu 2
f7f8221169 Everything in the sample master config file should be commented out (\fI\%#35611\fP)
.IP \(bu 2
c9070c212f Merge pull request \fI\%#35569\fP from rallytime/test\-for\-35384
.INDENT 2.0
.IP \(bu 2
30f42d5352 Write test for multiple unless commands where 1st cmd passes and 2nd fails
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35661\fP: (\fI\%justinta\fP) Backport \fI\%#35627\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#35627\fP: (\fI\%cachedout\fP) Comment boto lambda test (refs: \fI\%#35661\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35615\fP: (\fI\%hu\-dabao\fP) fix 35591, verify the acl file exist before proceed
@ \fI2016\-08\-21 04:41:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
67692f868c Merge pull request \fI\%#35615\fP from hu\-dabao/fix\-35591
.IP \(bu 2
402b83e4d3 change file verification to exist
.IP \(bu 2
7355eb4ecd move python lib import after absolute_import
.IP \(bu 2
69a2427670 fix 35591, verify the acl file exist before proceed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35485\fP: (\fI\%cro\fP) Cassandra returner bugfixes and documentation.
@ \fI2016\-08\-20 02:42:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
de6fca3909 Merge pull request \fI\%#35485\fP from cro/jpmc_cass_return
.IP \(bu 2
0b01a7a266 Six import for range.
.IP \(bu 2
7e87d4170d Fix Py3 lint?
.IP \(bu 2
d4336d011c [1,2,3] \-> range(1,4)
.IP \(bu 2
cec7f6a7ec remove unneeded import
.IP \(bu 2
e31555345f Add timeout documentation.
.IP \(bu 2
901ab8b74c Remove unnecessary log statements
.IP \(bu 2
1954c1a3f3 Update cassandra returner for JPMC
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35519\fP: (\fI\%morganwillcock\fP) win_dism state doesn\(aqt handle all success return codes (refs: \fI\%#35520\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35520\fP: (\fI\%morganwillcock\fP) Check for all success return codes in win_dism state
@ \fI2016\-08\-20 02:35:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
edefff51d4 Merge pull request \fI\%#35520\fP from morganwillcock/dism\-return\-codes
.IP \(bu 2
0b95b85e69 Check for all success return codes in dism state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35616\fP: (\fI\%xbglowx\fP) Remove duplicate auth_tries in minion docs
@ \fI2016\-08\-20 02:32:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
27211dbd64 Merge pull request \fI\%#35616\fP from xbglowx/2016.3
.IP \(bu 2
2801f0fdcc Remove duplicate auth_tries in minion docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34992\fP: (\fI\%szjur\fP) Syndic strips vital parts of events (such as \(aqretcode\(aq and \(aqsuccess\(aq) (refs: \fI\%#35552\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35552\fP: (\fI\%DmitryKuzmenko\fP) Syndic fix: don\(aqt strip \(aqretcode\(aq and \(aqsuccess\(aq from events.
@ \fI2016\-08\-20 02:00:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
25ac9bacc6 Merge pull request \fI\%#35552\fP from DSRCorporation/bugs/34992_syndic_strip_retcode
.IP \(bu 2
d036299f6f Syndic fix: don\(aqt strip \(aqretcode\(aq and \(aqsuccess\(aq from events.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25664\fP: (\fI\%sdm24\fP) 2015.5.2  MySQL Returner: salt\-run jobs.lookup_jid doesn\(aqt return full result for highstate output (refs: \fI\%#35559\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35559\fP: (\fI\%Jlin317\fP) Fix highstate outputter when it\(aqs given multiple results (refs: \fI\%#36137\fP)
@ \fI2016\-08\-20 01:56:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
bec8322e13 Merge pull request \fI\%#35559\fP from Jlin317/fix_highstate_outputter
.IP \(bu 2
27aa038cc6 Fix highstate outputter when it\(aqs given multiple results
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32478\fP: (\fI\%oliver\-dungey\fP) rsync.synchronized \- user/group options required (refs: \fI\%#32739\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35605\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32739\fP to 2016.3
@ \fI2016\-08\-20 01:39:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32739\fP: (\fI\%abednarik\fP) Rsync synchronized updates. (refs: \fI\%#35605\fP)
.IP \(bu 2
4153aeba29 Merge pull request \fI\%#35605\fP from rallytime/bp\-32739
.IP \(bu 2
36d8b4a409 Rsync synchronized updates.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35606\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-08\-19 22:19:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
6eabe6356f Merge pull request \fI\%#35606\fP from rallytime/merge\-2016.3
.IP \(bu 2
f2eb625778 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
0c7aa802f5 Update release notes for 2015.8.12 (\fI\%#35600\fP)
.IP \(bu 2
dd12b48239 Update release notes for 2015.8.12 (\fI\%#35599\fP)
.IP \(bu 2
beb6ca8ef9 Update linux_sysctl tests to reflect new context key (\fI\%#35584\fP)
.IP \(bu 2
fd08d33597 Add warning about AWS flagging of nmap usage (\fI\%#35575\fP)
.UNINDENT
.UNINDENT
.SS Salt 2016.3.5 Release Notes
.sp
Version 2016.3.5 is a bugfix release for \fI\%2016.3.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB190\fP
.IP \(bu 2
Total Issue References: \fB112\fP
.IP \(bu 2
Total PR References: \fB281\fP
.IP \(bu 2
Contributors: \fB74\fP (\fI\%Ch3LL\fP, \fI\%DmitryKuzmenko\fP, \fI\%Firewire2002\fP, \fI\%Mrten\fP, \fI\%Talkless\fP,
\fI\%TronPaul\fP, \fI\%UtahDave\fP, \fI\%aaronm\-cloudtek\fP, \fI\%alex\-zel\fP, \fI\%alexandr\-orlov\fP, \fI\%alexbleotu\fP,
\fI\%attiasr\fP, \fI\%basepi\fP, \fI\%bdrung\fP, \fI\%bshelton229\fP, \fI\%cachedout\fP, \fI\%calve\fP, \fI\%clan\fP, \fI\%clinta\fP,
\fI\%cro\fP, \fI\%dere\fP, \fI\%dereckson\fP, \fI\%dhaines\fP, \fI\%dincamihai\fP, \fI\%do3meli\fP, \fI\%dragon788\fP, \fI\%edgan\fP,
\fI\%fedusia\fP, \fI\%fj40crawler\fP, \fI\%genuss\fP, \fI\%gtmanfred\fP, \fI\%haeac\fP, \fI\%heewa\fP, \fI\%hu\-dabao\fP,
\fI\%jeanpralo\fP, \fI\%jfindlay\fP, \fI\%jinm\fP, \fI\%kevinquinnyo\fP, \fI\%kontrolld\fP, \fI\%laleocen\fP, \fI\%lorengordon\fP,
\fI\%m03\fP, \fI\%mcalmer\fP, \fI\%mchugh19\fP, \fI\%meaksh\fP, \fI\%mikejford\fP, \fI\%moio\fP, \fI\%multani\fP, \fI\%nevins\-b\fP,
\fI\%pass\-by\-value\fP, \fI\%rallytime\fP, \fI\%rbjorklin\fP, \fI\%siccrusher\fP, \fI\%silenius\fP, \fI\%sjmh\fP, \fI\%sjorge\fP,
\fI\%skizunov\fP, \fI\%slinn0\fP, \fI\%sofixa\fP, \fI\%techhat\fP, \fI\%tedski\fP, \fI\%terminalmage\fP, \fI\%thatch45\fP,
\fI\%thusoy\fP, \fI\%toanju\fP, \fI\%tobithiel\fP, \fI\%twangboy\fP, \fI\%tyhunt99\fP, \fI\%vutny\fP, \fI\%wanparo\fP, \fI\%whiteinge\fP,
\fI\%xiaoanyunfei\fP, \fI\%yhekma\fP, \fI\%zwo\-bot\fP)
.UNINDENT
.SS Security Fixes
.sp
\fBCVE\-2017\-5192\fP local_batch client external authentication not respected
.sp
The \fBLocalClient.cmd_batch()\fP method client does not accept \fBexternal_auth\fP
credentials and so access to it from salt\-api has been removed for now. This
vulnerability allows code execution for already\-authenticated users and is only
in effect when running salt\-api as the \fBroot\fP user.
.sp
\fBCVE\-2017\-5200\fP Salt\-api allows arbitrary command execution on a salt\-master via
Salt\(aqs ssh_client
.sp
Users of Salt\-API and salt\-ssh could execute a command on the salt master via a
hole when both systems were enabled.
.sp
We recommend everyone on the 2016.3 branch upgrade to a patched release as soon
as possible.
.SS Improved Checksum Handling in \fI\%file.managed\fP, \fI\%archive.extracted\fP States
.sp
When the \fBsource_hash\fP argument for these states refers to a file containing
checksums, Salt now looks for checksums matching the name of the source URI, as
well as the file being managed. Prior releases only looked for checksums
matching the filename being managed. Additionally, a new argument
(\fBsource_hash_name\fP) has been added, which allows the user to disambiguate
ambiguous matches when more than one matching checksum is found in the
\fBsource_hash\fP file.
.sp
A more detailed explanation of this functionality can be found in the
\fI\%file.managed\fP documentation, in the
section for the new \fBsource_hash_name\fP argument.
.SS Changelog for v2016.3.4..v2016.3.5
.sp
\fIGenerated at: 2018\-05\-27 05:09:33 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#38833\fP: (\fI\%Ch3LL\fP) add 2016.3.5 changelog to release notes
@ \fI2017\-01\-19 23:27:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
a04ab86da1 Merge pull request \fI\%#38833\fP from Ch3LL/add_release_notes_2016.3.5
.IP \(bu 2
374dc1ab88 skip 2016.3.5 due to :doc: references
.IP \(bu 2
31f324c4ff add 2016.3.5 changelog to release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38812\fP: (\fI\%rallytime\fP) Update pyobjects test to be a list
@ \fI2017\-01\-18 21:06:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
d14f0c64eb Merge pull request \fI\%#38812\fP from rallytime/pyobjects\-test
.IP \(bu 2
f3e84c1ab7 Update pyobjects test to be a list
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36598\fP: (\fI\%ikkaro\fP) CloudClient vmware driver reusing SI bug (refs: \fI\%#38813\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38813\fP: (\fI\%gtmanfred\fP) catch SIGPIPE in vmware connection
@ \fI2017\-01\-18 21:05:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
50f03f8057 Merge pull request \fI\%#38813\fP from gtmanfred/2016.3
.IP \(bu 2
ce3472cec2 catch SIGPIPE in vmware connection
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38809\fP: (\fI\%twangboy\fP) Fix get_hostname to handle longer computer names
@ \fI2017\-01\-18 19:32:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
23b8b47258 Merge pull request \fI\%#38809\fP from twangboy/fix_hostname_2016.3
.IP \(bu 2
d57a51f9f9 Fix tests for get_hostname
.IP \(bu 2
7ca3fd7484 Fix get_hostname to handle longer computer names
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38388\fP: (\fI\%johje349\fP) No INFO logs in minion log file (refs: \fI\%#38808\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38808\fP: (\fI\%vutny\fP) Fix \fI\%#38388\fP
@ \fI2017\-01\-18 18:19:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
1033bbdde8 Merge pull request \fI\%#38808\fP from vutny/fix\-38388
.IP \(bu 2
9bd203ffcc Fix \fI\%#38388\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38604\fP: (\fI\%jsandas\fP) Using \(dqbatch\(dq with saltmod errors with \(dqValueError: need more than 2 values to unpack\(dq (refs: \fI\%#38668\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38668\fP: (\fI\%terminalmage\fP) Fix proposal for \fI\%#38604\fP
@ \fI2017\-01\-18 17:53:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
f3ae3cd5c8 Merge pull request \fI\%#38668\fP from terminalmage/issue38604
.IP \(bu 2
0ea97cdad9 Merge pull request \fI\%#10\fP from cachedout/pr\-38668
.INDENT 2.0
.IP \(bu 2
db81afc035 Munge retcode into return data for batching
.UNINDENT
.IP \(bu 2
a642a995dc Return the ret data from batch execution instead of raw data
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38622\fP: (\fI\%mikejford\fP) Incorrect saltenv argument documentation in salt.modules.state (refs: \fI\%#38789\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38789\fP: (\fI\%rallytime\fP) Update some saltenv refs to environment in salt.modules.state docs
@ \fI2017\-01\-18 15:39:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
c6a19a9e5a Merge pull request \fI\%#38789\fP from rallytime/fix\-38622
.IP \(bu 2
af41fe0c6e Update some saltenv refs to environment in salt.modules.state docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38790\fP: (\fI\%cachedout\fP) Fix typo in pyobjects test
@ \fI2017\-01\-18 15:38:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
e0bf700020 Merge pull request \fI\%#38790\fP from cachedout/fix_pyobjects_test_typo
.IP \(bu 2
a66afb5f0f Fix typo in pyobjects test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38629\fP: (\fI\%Arabus\fP) Conflicting documentation about default value of pillar_opts (refs: \fI\%#38792\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38792\fP: (\fI\%rallytime\fP) Update pillar tutorial lanuage regarding pillar_opts settings
@ \fI2017\-01\-18 15:38:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
6e9785edea Merge pull request \fI\%#38792\fP from rallytime/fix\-38629
.IP \(bu 2
1e125e2844 Update pillar tutorial lanuage regarding pillar_opts settings
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#38707\fP: (\fI\%alexbleotu\fP) Fixed prepending of root_dir override to the other paths (refs: \fI\%#38796\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38796\fP: (\fI\%cachedout\fP) Revert \(dqFixed prepending of root_dir override to the other paths\(dq
@ \fI2017\-01\-17 23:18:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
3417adc617 Merge pull request \fI\%#38796\fP from saltstack/revert\-38707\-root_dir_fix\-gh
.IP \(bu 2
cb080f3bbe Revert \(dqFixed prepending of root_dir override to the other paths\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38524\fP: (\fI\%rbjorklin\fP) salt\-api seems to ignore rest_timeout since 2016.11.0 (refs: \fI\%#38585\fP, \fI\%#38527\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38479\fP: (\fI\%tyeapple\fP) api_logfile setting takes no effect (refs: \fI\%#38585\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38585\fP: (\fI\%rallytime\fP) Follow up to PR \fI\%#38527\fP
@ \fI2017\-01\-17 18:40:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38570\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11 (refs: \fI\%#38585\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38560\fP: (\fI\%Ch3LL\fP) fix api logfile (refs: \fI\%#38585\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38527\fP: (\fI\%rbjorklin\fP) salt\-api no longer forces the default timeout (refs: \fI\%#38585\fP)
.IP \(bu 2
bab3479a3c Merge pull request \fI\%#38585\fP from rallytime/follow\-up\-38527
.IP \(bu 2
05587201b6 Pylint fix: add line at end of file
.IP \(bu 2
fa01367599 Keep a copy of the DEFAULT_API_OPTS and restore them after the test run
.IP \(bu 2
2ad07634d9 Test clean up
.IP \(bu 2
fd2ee7db30 Add some simple unit tests for salt.config.api_config function
.IP \(bu 2
3d2fefc83b Make sure the pidfile and log_file values are overridden by api opts
.IP \(bu 2
1f6b540e46 Make sure the pidfile and log_file values are overridden by api opts
.IP \(bu 2
04d307f917 salt\-api no longer forces the default timeout
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38707\fP: (\fI\%alexbleotu\fP) Fixed prepending of root_dir override to the other paths
@ \fI2017\-01\-17 15:40:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
0fb6bb7b77 Merge pull request \fI\%#38707\fP from alexbleotu/root_dir_fix\-gh
.IP \(bu 2
0bac8c8be3 Fixed prepending of root_dir override to the other paths
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38774\fP: (\fI\%vutny\fP) DOCS: add C++ compiler installation on RHEL required for bundled 0mq
@ \fI2017\-01\-17 15:21:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
96c9dc10f7 Merge pull request \fI\%#38774\fP from vutny/dev\-test\-docs
.IP \(bu 2
4620dc4afa DOCS: add C++ compiler installation on RHEL required for bundled 0mq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38749\fP: (\fI\%vutny\fP) pkg build modules throw better exception message if keyid wasn\(aqt found
@ \fI2017\-01\-17 02:13:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
aedfbb7a43 Merge pull request \fI\%#38749\fP from vutny/pkg\-build\-better\-exception\-msg
.IP \(bu 2
53f2be5b21 pkg build modules throw better exception message if keyid wasn\(aqt found
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38743\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2017\-01\-17 01:46:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
8466b34e82 Merge pull request \fI\%#38743\fP from rallytime/merge\-2016.3
.IP \(bu 2
d24776f5e9 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
6869621ed1 Merge pull request \fI\%#38731\fP from rallytime/merge\-2015.8
.INDENT 2.0
.IP \(bu 2
9eb191b6ac Pylint fix
.IP \(bu 2
b910499dbe Various follow up fixes
.IP \(bu 2
e8309a6bbf Add release notes for 2015.8.13
.IP \(bu 2
f881f366b7 Merge pull request \fI\%#20\fP from rallytime/2015.8.12_follow_up\-batch\-tests
.INDENT 2.0
.IP \(bu 2
34282322c0 Clean up tests and docs for batch execution
.UNINDENT
.IP \(bu 2
c80b20b957 Merge pull request \fI\%#19\fP from whiteinge/batchclient
.INDENT 2.0
.IP \(bu 2
3d8f3d18f6 Remove batch execution from NetapiClient and Saltnado
.UNINDENT
.IP \(bu 2
97b0f64923 Lintfix
.IP \(bu 2
d1516664f7 Add explanation comment
.IP \(bu 2
62f2c87080 Add docstring
.IP \(bu 2
9b0a786aeb Explain what it is about and how to configure that
.IP \(bu 2
5ea3579e10 Pick up a specified roster file from the configured locations
.IP \(bu 2
3a8614c5df Disable custom rosters in API
.IP \(bu 2
c0e5a1171d Add roster disable flag
.UNINDENT
.IP \(bu 2
e9c59e9b8f Merge pull request \fI\%#38602\fP from terminalmage/fix\-boto\-test
.INDENT 2.0
.IP \(bu 2
3424a108ac Fix failing unit.states.boto_vpc_test.BotoVpcRouteTableTestCase.test_present_with_routes
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38674\fP: (\fI\%jackywu\fP) There is no code to use parameter \(aqevent_publisher_pub_hwm\(aq in saltstack\-2016.3 (refs: \fI\%#38723\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38723\fP: (\fI\%rallytime\fP) Remove \(dqevent_publisher_pub_hwm\(dq and \(dqsalt_event_pub_hwm\(dq from config/__init__.py
@ \fI2017\-01\-15 18:36:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29294\fP: (\fI\%skizunov\fP) ZeroMQ no longer required when transport is TCP (refs: \fI\%#38723\fP)
.IP \(bu 2
a642cdef79 Merge pull request \fI\%#38723\fP from rallytime/fix\-38674
.IP \(bu 2
706c885f55 Remove \(dqevent_publisher_pub_hwm\(dq and \(dqsalt_event_pub_hwm\(dq from config/__init__.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38669\fP: (\fI\%rallytime\fP) Update bootstrap script verstion to latest release
@ \fI2017\-01\-15 18:03:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc545af10b Merge pull request \fI\%#38669\fP from rallytime/update\-bootstrap\-script
.IP \(bu 2
78ba76e34c Update bootstrap script verstion to latest release
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38693\fP: (\fI\%twangboy\fP) Update jinja2 to 2.9.4
@ \fI2017\-01\-15 14:40:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
50d417f267 Merge pull request \fI\%#38693\fP from twangboy/update_jinja
.IP \(bu 2
e0c7e5549b Update jinja2 to 2.9.4
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38739\fP: (\fI\%vutny\fP) DOCS: correct examples of running test suite
@ \fI2017\-01\-15 14:35:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
f4233bb18d Merge pull request \fI\%#38739\fP from vutny/fix\-runtests\-doc
.IP \(bu 2
b872bb63f6 DOCS: correct examples of running test suite
.IP \(bu 2
\fBPR\fP \fI\%#38735\fP: (\fI\%vutny\fP) DOCS: add links to File State Backups page where necessary
.IP \(bu 2
\fBPR\fP \fI\%#38720\fP: (\fI\%dereckson\fP) Proofread jinja_to_execution_module tutorial
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36548\fP: (\fI\%abonillasuse\fP) openstack auth with nova driver (refs: \fI\%#38647\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38647\fP: (\fI\%gtmanfred\fP) Allow novaclient to use keystoneauth1 sessions for authentication
@ \fI2017\-01\-10 17:48:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
7b850d472d Merge pull request \fI\%#38647\fP from gtmanfred/nova
.IP \(bu 2
5be9b60851 add documentation about using keystoneauth for v3
.IP \(bu 2
7b657ca4ae add the ability to use keystone v2 and v3
.IP \(bu 2
5646ae1b34 add ability to use keystoneauth to authenticate in nova driver
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38648\fP: (\fI\%ericuldall\fP) No release file error from PPA on Ubuntu (refs: \fI\%#38650\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38572\fP: (\fI\%COLABORATI\fP) ppa:saltstack/salt failure (refs: \fI\%#38650\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34504\fP: (\fI\%AvinashDeluxeVR\fP) Installation documentation for Ubuntu server and Windows minion leads the user to use different salt versions. (refs: \fI\%#38650\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38650\fP: (\fI\%rallytime\fP) Remove the installation instructions for out\-of\-date community ppa
@ \fI2017\-01\-10 17:47:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
383768d838 Merge pull request \fI\%#38650\fP from rallytime/remove\-ubuntu\-ppa\-docs
.IP \(bu 2
30429b2e44 Remove the installation instructions for out\-of\-date community ppa
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38087\fP: (\fI\%UtahDave\fP) The \(aqdata\(aq field in the return from a minion below a syndic is wrapped in an extra \(aqdata\(aq field. (refs: \fI\%#38657\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38657\fP: (\fI\%DmitryKuzmenko\fP) Publish the \(aqdata\(aq field content for Syndic evets
@ \fI2017\-01\-10 16:59:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
7d9f56e3b5 Merge pull request \fI\%#38657\fP from DSRCorporation/bugs/38087_syndic_event_format_fix
.IP \(bu 2
594c33f396 Publish the \(aqdata\(aq field content for Syndic evets
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38649\fP: (\fI\%Ch3LL\fP) fix unit.modules.file_test
@ \fI2017\-01\-10 16:44:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
83987511fd Merge pull request \fI\%#38649\fP from Ch3LL/test_apply_template
.IP \(bu 2
47f8b68e0b fix unit.modules.file_test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37355\fP: (\fI\%Firewire2002\fP) salt\-ssh \- ImportError: No module named backports.ssl_match_hostname (refs: \fI\%#38626\fP, #\(gasaltstack/salt\(ga#37358\(ga_\(ga_, \fI\%#37358\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34600\fP: (\fI\%davidpsv17\fP) Error trying a salt\-ssh test.ping (refs: #\(gasaltstack/salt\(ga#37358\(ga_\(ga_, \fI\%#37358\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27355\fP: (\fI\%jerob\fP) salt ssh error with debian 7 on target (refs: #\(gasaltstack/salt\(ga#37358\(ga_\(ga_, \fI\%#37358\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#37358\fP: (\fI\%Firewire2002\fP) Fix/workaround for issue \fI\%#37355\fP (refs: \fI\%#38626\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38626\fP: (\fI\%cachedout\fP) Revert \(dqFix/workaround for issue \fI\%#37355\fP\(dq
@ \fI2017\-01\-06 21:28:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
74ddc71be3 Merge pull request \fI\%#38626\fP from saltstack/revert\-37358\-2016.3.3_issue37355
.IP \(bu 2
e912ac99c2 Revert \(dqFix/workaround for issue \fI\%#37355\fP\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37355\fP: (\fI\%Firewire2002\fP) salt\-ssh \- ImportError: No module named backports.ssl_match_hostname (refs: \fI\%#38626\fP, #\(gasaltstack/salt\(ga#37358\(ga_\(ga_, \fI\%#37358\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34600\fP: (\fI\%davidpsv17\fP) Error trying a salt\-ssh test.ping (refs: #\(gasaltstack/salt\(ga#37358\(ga_\(ga_, \fI\%#37358\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27355\fP: (\fI\%jerob\fP) salt ssh error with debian 7 on target (refs: #\(gasaltstack/salt\(ga#37358\(ga_\(ga_, \fI\%#37358\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37358\fP: (\fI\%Firewire2002\fP) Fix/workaround for issue \fI\%#37355\fP
@ \fI2017\-01\-06 18:58:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
5e58b32934 Merge pull request \fI\%#37358\fP from Firewire2002/2016.3.3_issue37355
.IP \(bu 2
910da18bfd fixed typo
.IP \(bu 2
4fbc5ddd06 fixed wrong renamed variable and spaces
.IP \(bu 2
92366e646c issue \fI\%#37355\fP
.IP \(bu 2
7dc87ab7b8 issue \fI\%#37355\fP
.IP \(bu 2
2878180405 issue \fI\%#37355\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35390\fP: (\fI\%alexandr\-orlov\fP) Returns back missed proper grains dictionary for file module
@ \fI2017\-01\-06 18:02:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c2fe615aa Merge pull request \fI\%#35390\fP from alexandr\-orlov/2016.3
.IP \(bu 2
cd5ae17e8d fxd missed proper grains dictionary
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38558\fP: (\fI\%multani\fP) pillar.get(\(dq...\(dq, default=var, merge=true) updates default value (refs: \fI\%#38579\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38618\fP: (\fI\%rallytime\fP) Back\-port \fI\%#38579\fP to 2016.3
@ \fI2017\-01\-06 17:37:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38579\fP: (\fI\%zwo\-bot\fP) Fix \fI\%#38558\fP \- pillar.get with default= ...,merge=true influence subsequent calls of pillar.get (refs: \fI\%#38618\fP)
.IP \(bu 2
2579cfa42d Merge pull request \fI\%#38618\fP from rallytime/bp\-38579
.IP \(bu 2
2052ecee2c Add copy import
.IP \(bu 2
2c8845aaa0 add test for pillar.get() + default value
.IP \(bu 2
c2f98d2f04 ticket 38558: add unit test, deepcopy() only if necessary
.IP \(bu 2
30ae0a1958 added deepcopy of default if merge=True
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38601\fP: (\fI\%terminalmage\fP) pillar.get: Raise exception when merge=True and default is not a dict
@ \fI2017\-01\-05 23:15:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
da676cebd6 Merge pull request \fI\%#38601\fP from terminalmage/pillar\-get
.IP \(bu 2
8613d7254d pillar.get: Raise exception when merge=True and default is not a dict
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38600\fP: (\fI\%terminalmage\fP) Avoid errors when sudo_user is set (2016.3 branch)
@ \fI2017\-01\-05 20:57:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38598\fP: (\fI\%terminalmage\fP) Avoid errors when sudo_user is set (refs: \fI\%#38600\fP)
.IP \(bu 2
224fc7712a Merge pull request \fI\%#38600\fP from terminalmage/issue38459\-2016.3
.IP \(bu 2
8a45b13e76 Avoid errors when sudo_user is set
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38589\fP: (\fI\%tobithiel\fP) State Gem: fix incorrect warning about missing rvm/rbenv
@ \fI2017\-01\-05 20:12:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
a376970f88 Merge pull request \fI\%#38589\fP from tobithiel/fix_rvm_rbenv_warning
.IP \(bu 2
9ec470b4a5 State Gem: fix incorrect warning about missing rvm/rbenv
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38567\fP: (\fI\%pass\-by\-value\fP) Create queue if one doesn\(aqt exist
@ \fI2017\-01\-05 18:46:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
02e6a78254 Merge pull request \fI\%#38567\fP from pass\-by\-value/pgjsonb_queue_changes_2016.3
.IP \(bu 2
67879ebe65 Create queue if one doesn\(aqt exist
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37498\fP: (\fI\%githubcdr\fP) service.restart salt\-minion fails on Ubuntu 14.04.5 LTS (refs: \fI\%#37748\fP, \fI\%#38587\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38587\fP: (\fI\%rallytime\fP) Change daemontools __virtualname__ from service to daemontools
@ \fI2017\-01\-05 18:06:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
0889cbdb31 Merge pull request \fI\%#38587\fP from rallytime/fix\-37498
.IP \(bu 2
2a5880966f Change daemontools __virtualname__ from service to daemontools
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38562\fP: (\fI\%rallytime\fP) Update arch installation docs with correct package name
@ \fI2017\-01\-04 20:04:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
7b74436d13 Merge pull request \fI\%#38562\fP from rallytime/arch\-install\-docs
.IP \(bu 2
8b1897ace9 Update arch installation docs with correct package name
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38560\fP: (\fI\%Ch3LL\fP) fix api logfile (refs: \fI\%#38585\fP)
@ \fI2017\-01\-04 19:03:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
01860702cb Merge pull request \fI\%#38560\fP from Ch3LL/fix_api_log
.IP \(bu 2
1b45e9670b fix api logfile
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38531\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33601\fP to 2016.3
@ \fI2017\-01\-04 16:56:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33601\fP: (\fI\%mchugh19\fP) Fix slack engine to run on python2.6 (refs: \fI\%#38531\fP)
.IP \(bu 2
0056620a53 Merge pull request \fI\%#38531\fP from rallytime/bp\-33601
.IP \(bu 2
c36cb39825 remove the unnecessary double trigger
.IP \(bu 2
38414493bf fix spacing lint error
.IP \(bu 2
8c1defc710 Remove uncessary type from alias commands. Deduplicate alias handling to autodetect function selection. Add error reporting to slack connectivty problems. Cleanup slack\(aqs unicode conversion
.IP \(bu 2
c2f23bc45e Fix slack engine to run on python2.6
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38187\fP: (\fI\%curiositycasualty\fP) username/password saved as cleartext when using URIs with user:pass@ format (refs: \fI\%#38541\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38541\fP: (\fI\%techhat\fP) Strip user:pass from cached URLs
@ \fI2017\-01\-04 15:39:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
50242c7f17 Merge pull request \fI\%#38541\fP from techhat/issue38187
.IP \(bu 2
eae3a435dd Strip user:pass from cached URLs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30454\fP: (\fI\%favoretti\fP) Using yaml serializer inside jinja template results in unicode being prepended by \(aq!!python/unicode\(aq (refs: \fI\%#30481\fP, \fI\%#38554\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38554\fP: (\fI\%multani\fP) Fix YAML deserialization of unicode
@ \fI2017\-01\-04 15:31:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30481\fP: (\fI\%basepi\fP) Add yaml_safe jinja filter (refs: \fI\%#38554\fP)
.IP \(bu 2
325dc56e59 Merge pull request \fI\%#38554\fP from multani/fix/30454
.IP \(bu 2
2e7f743371 yaml: support unicode serialization/deserialization
.IP \(bu 2
df76113c5c jinja: test the \(dqyaml\(dq filter with ordered dicts
.IP \(bu 2
f7712d417f Revert \(dqAdd yaml_safe filter\(dq
.IP \(bu 2
\fBPR\fP \fI\%#38536\fP: (\fI\%UtahDave\fP) add note about pyVmomi locale workaround
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38353\fP: (\fI\%Ch3LL\fP) salt\-cloud gce specifying  (refs: \fI\%#38542\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38542\fP: (\fI\%Ch3LL\fP) fix gce image bug
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38449\fP: (\fI\%swalladge\fP) Parsing issues in \fIlist_tab\fP (salt/modules/cron.py) (refs: \fI\%#38487\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38487\fP: (\fI\%gtmanfred\fP) Fix crontab issues with spaces
@ \fI2017\-01\-01 20:33:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec60f9c721 Merge pull request \fI\%#38487\fP from gtmanfred/2016.3
.IP \(bu 2
048b9f6b9d add test
.IP \(bu 2
c480c11528 allow spaces in cron env
.IP \(bu 2
c529ec8c34 allow crons to have multiple spaces
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37684\fP: (\fI\%thusoy\fP) State execution duration is timezone\-dependent (refs: \fI\%#38491\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38491\fP: (\fI\%gtmanfred\fP) Use UTC for timing in case timezone changes
@ \fI2017\-01\-01 20:30:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
c5ba11b5e0 Merge pull request \fI\%#38491\fP from gtmanfred/timing
.IP \(bu 2
79368c7528 Use UTC for timing in case timezone changes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38472\fP: (\fI\%jinm\fP) file.managed Unable to manage file: \(aqhash_type\(aq (2016.3.4) (refs: \fI\%#38503\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38503\fP: (\fI\%jinm\fP) Hash type fallback for file management
@ \fI2017\-01\-01 17:36:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
86f0aa0bb3 Merge pull request \fI\%#38503\fP from jinm/issue_38472_jinm
.IP \(bu 2
0cd9df299f Hash type fallback for file management
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38457\fP: (\fI\%bshelton229\fP) Stops git.latest checking for local changes in a bare repo
@ \fI2016\-12\-30 14:28:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
ed2ba4bd1b Merge pull request \fI\%#38457\fP from bshelton229/git\-latest\-head\-bug
.IP \(bu 2
558e7a771a Stops git.latest checking for local changes in a bare repo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38385\fP: (\fI\%dragon788\fP) Use unambigous long names with double dashes
@ \fI2016\-12\-29 17:10:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
36e21b22cb Merge pull request \fI\%#38385\fP from dragon788/2016.3\-double\-dash
.IP \(bu 2
86c4b56f47 Newline for lint compat
.IP \(bu 2
9d9b686057 Address review comments, consistency of quotes
.IP \(bu 2
df9bd5e7f9 Use unambigous long names with double dashes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38209\fP: (\fI\%limited\fP) Accepting a minion causes tornado to exit (refs: \fI\%#38474\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38474\fP: (\fI\%cachedout\fP) Allow an existing ioloop to be passed to salt\-key
@ \fI2016\-12\-29 16:28:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
59f2560d88 Merge pull request \fI\%#38474\fP from cachedout/key_loop
.IP \(bu 2
de504538e1 Allow an existing ioloop to be passed to salt\-key
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38438\fP: (\fI\%jf\fP) file.line with mode=delete breaks on empty file (refs: \fI\%#38467\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38467\fP: (\fI\%gtmanfred\fP) file.line fail with mode=delete
@ \fI2016\-12\-28 20:00:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
3d0c752acd Merge pull request \fI\%#38467\fP from gtmanfred/2016.3
.IP \(bu 2
7b7c6b3878 file.line fail with mode=delete
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38434\fP: (\fI\%slinn0\fP) Make sysctl.persist fail when failing to set a value into the running kernel
@ \fI2016\-12\-27 15:37:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
940025d5c4 Merge pull request \fI\%#38434\fP from slinn0/issue_38433_fixes
.IP \(bu 2
22af87a3fc Fixes for \fI\%https://github.com/saltstack/salt/issues/38433\fP
.IP \(bu 2
\fBPR\fP \fI\%#38421\fP: (\fI\%rallytime\fP) Update deprecation notices to the correct version
.IP \(bu 2
\fBPR\fP \fI\%#38420\fP: (\fI\%rallytime\fP) Removed various deprecation notices from salt/modules/* files (refs: \fI\%#38421\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38282\fP: (\fI\%sash\-kan\fP) file.managed fails when file (which contains utf\-characters in the name) exists (refs: \fI\%#38415\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38415\fP: (\fI\%terminalmage\fP) file.managed: Fix failure when filename contains unicode chars
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38419\fP: (\fI\%Ch3LL\fP) fix scsci docs example
@ \fI2016\-12\-22 18:57:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
2cdb59d055 Merge pull request \fI\%#38419\fP from Ch3LL/fix_doc_scsi
.IP \(bu 2
234043b8bb fix scsci docs example
.IP \(bu 2
\fBPR\fP \fI\%#38407\fP: (\fI\%terminalmage\fP) Improve pillar documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38372\fP: (\fI\%fanirama\fP) Issue with cron.file. Source: salt://path/to/crontab_file not found (refs: \fI\%#38398\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38398\fP: (\fI\%terminalmage\fP) Fix call to file.get_managed in cron.file state
@ \fI2016\-12\-22 16:46:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
423b1fddff Merge pull request \fI\%#38398\fP from terminalmage/issue38372
.IP \(bu 2
c80dbaa914 Fix call to file.get_managed in cron.file state
.IP \(bu 2
\fBPR\fP \fI\%#38382\fP: (\fI\%heewa\fP) Fix http.query when result has no text
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38390\fP: (\fI\%meaksh\fP) Add \(dqtry\-restart\(dq to fix autorestarting on SUSE systems
@ \fI2016\-12\-21 16:06:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
b74b5c7d38 Merge pull request \fI\%#38390\fP from meaksh/2016.3\-fix\-try\-restart\-for\-autorestarting\-on\-SUSE\-systems
.IP \(bu 2
de6ec05ec0 add try\-restart to fix autorestarting on SUSE systems
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38221\fP: (\fI\%UtahDave\fP) Fix default returner
@ \fI2016\-12\-20 20:34:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
2c3a39760a Merge pull request \fI\%#38221\fP from UtahDave/fix_default_returner
.IP \(bu 2
385640765b remove a blank line to satisfy linter
.IP \(bu 2
9c248aa14c validate return opt, remove default.
.IP \(bu 2
8bb37f9fe7 specify allowed types and default for \(dqreturner\(dq
.IP \(bu 2
11863a4bfe add examples of default minion returners
.IP \(bu 2
e7c6012655 add support for default returners using \fIreturn\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38288\fP: (\fI\%terminalmage\fP) archive.extracted: don\(aqt try to cache local sources (2016.3 branch)
@ \fI2016\-12\-18 13:07:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
09d9cff992 Merge pull request \fI\%#38288\fP from terminalmage/archive\-extracted\-local\-source\-2016.3
.IP \(bu 2
845e3d0e75 Update tests to reflect change in cache behavior
.IP \(bu 2
5a08d7c70a archive.extracted: don\(aqt try to cache local sources (2016.3 branch)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38312\fP: (\fI\%cro\fP) Backport feature allowing proxy config to live in pillar OR /etc/salt/proxy
@ \fI2016\-12\-18 12:39:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf37667f8a Merge pull request \fI\%#38312\fP from cro/proxy_config_in_cfg
.IP \(bu 2
2006c4000e Typo
.IP \(bu 2
689d95b10f Backport feature allowing proxy config to live in pillar OR /etc/salt/proxy.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#12788\fP: (\fI\%whiteinge\fP) Comb through docs to replace :doc: roles with :ref: (refs: \fI\%#38320\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38320\fP: (\fI\%rallytime\fP) Cleanup doc internal markup references
@ \fI2016\-12\-18 12:31:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
c83db5a785 Merge pull request \fI\%#38320\fP from rallytime/cleanup\-doc\-refs
.IP \(bu 2
62978cb7a0 Don\(aqt check the doc/conf.py file for doc markup refs
.IP \(bu 2
770e732d76 Add a unit test to search for new doc markup refs
.IP \(bu 2
5c42a361a0 Remove \(dq:doc:\(dq references from all doc/topics/installation/* files
.IP \(bu 2
23bce1c929 Remove \(dq:doc:\(dq references from all doc/topics/releases/* files
.IP \(bu 2
4aafa41d22 Remove \(dq:doc:\(dq references from a bunch of doc/* files
.IP \(bu 2
02bfe7912c Remove more \(dq:doc:\(dq references from doc/* files
.IP \(bu 2
6e32267d0c Remove \(dq:doc:\(dq references in salt/* files
.IP \(bu 2
\fBPR\fP \fI\%#38281\fP: (\fI\%mikejford\fP) Add nick to args for create_multi
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38290\fP: (\fI\%dragon788\fP) Need to use machine automation friendly output (refs: \fI\%#38313\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38313\fP: (\fI\%dragon788\fP) 2016.3 chocolatey fix
@ \fI2016\-12\-16 17:20:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
235682b1e6 Merge pull request \fI\%#38313\fP from dragon788/2016.3\-chocolatey\-fix
.IP \(bu 2
1f5fc17551 Use machine readable output for list
.IP \(bu 2
cdbd2fbe3c Added limit\-output to eliminate false packages
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38174\fP: (\fI\%NickDubelman\fP) [syndic] Why can\(aqt a syndic node signal when all of its minions have returned? (refs: \fI\%#38279\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#32400\fP: (\fI\%rallytime\fP) Document Default Config Values (refs: \fI\%#38279\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38279\fP: (\fI\%rallytime\fP) Add docs for syndic_wait setting
@ \fI2016\-12\-15 18:30:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
9e78ddc80e Merge pull request \fI\%#38279\fP from rallytime/fix\-38174
.IP \(bu 2
4a62d01577 Add docs for syndic_wait setting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38248\fP: (\fI\%meaksh\fP) Successfully exit of salt\-api child processes when SIGTERM is received
@ \fI2016\-12\-15 09:16:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc9e1dff35 Merge pull request \fI\%#38248\fP from meaksh/salt\-api\-successfully\-close\-child\-processes
.IP \(bu 2
ee6eae9855 Successfully exit of salt\-api child processes when SIGTERM.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38254\fP: (\fI\%terminalmage\fP) Also check if pillarenv is in opts
@ \fI2016\-12\-15 09:10:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
3c718ed35e Merge pull request \fI\%#38254\fP from terminalmage/check\-pillarenv
.IP \(bu 2
fa9ad311c6 Also check if pillarenv is in opts
.IP \(bu 2
\fBPR\fP \fI\%#38256\fP: (\fI\%rallytime\fP) [2016.3] Bump latest release version to 2016.11.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38198\fP: (\fI\%vutny\fP) Add missing requirements for running unit tests: libcloud and boto3
@ \fI2016\-12\-13 14:12:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
004e46afe7 Merge pull request \fI\%#38198\fP from vutny/unit\-tests\-require\-libcloud\-boto3
.IP \(bu 2
a6098bac1a Remove note about SaltTesting installation, now it is in the requirements
.IP \(bu 2
004bff113e Add missing requirements for running unit tests: libcloud and boto3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38213\fP: (\fI\%rallytime\fP) Skip test_cert_info tls unit test on pyOpenSSL upstream errors
@ \fI2016\-12\-13 12:05:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d497bc74c Merge pull request \fI\%#38213\fP from rallytime/skip\-tls\-test
.IP \(bu 2
bdb807fc7c Skip test_cert_info tls unit test on pyOpenSSL upstream errors
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38224\fP: (\fI\%whiteinge\fP) Allow CORS OPTIONS requests to be unauthenticated
@ \fI2016\-12\-13 12:02:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
203109dd17 Merge pull request \fI\%#38224\fP from whiteinge/cors\-options\-unauthed
.IP \(bu 2
de4d3227ab Allow CORS OPTIONS requests to be unauthenticated
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38223\fP: (\fI\%whiteinge\fP) Add root_dir to salt\-api file paths
@ \fI2016\-12\-13 07:44:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37272\fP: (\fI\%vutny\fP) Get default logging level and log file from default opts dict (refs: \fI\%#38223\fP)
.IP \(bu 2
721a5feccd Merge pull request \fI\%#38223\fP from whiteinge/salt\-api\-root_dirs
.IP \(bu 2
bfbf390c0e Add root_dir to salt\-api file paths
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38162\fP: (\fI\%747project\fP) git_pillar does not detect changes to remote repository when told to update (refs: \fI\%#38191\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38191\fP: (\fI\%terminalmage\fP) Clarify the fact that git_pillar.update does not fast\-forward
@ \fI2016\-12\-12 09:45:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
70f7d22ad6 Merge pull request \fI\%#38191\fP from terminalmage/issue38162
.IP \(bu 2
1ae543a98a Clarify the fact that git_pillar.update does not fast\-forward
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38194\fP: (\fI\%vutny\fP) Document the requirements for running ZeroMQ\-based integration tests
@ \fI2016\-12\-12 09:42:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
28171cbfc5 Merge pull request \fI\%#38194\fP from vutny/integration\-test\-requirements\-doc
.IP \(bu 2
e9f419ff64 Document the requirements for running ZeroMQ\-based integration tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38185\fP: (\fI\%rallytime\fP) Back\-port \fI\%#38181\fP to 2016.3
@ \fI2016\-12\-09 22:27:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38181\fP: (\fI\%rallytime\fP) Reset socket default timeout to None (fixes daemons_tests failures) (refs: \fI\%#38185\fP)
.IP \(bu 2
a4ef037ab1 Merge pull request \fI\%#38185\fP from rallytime/bp\-38181
.IP \(bu 2
609f814454 Reset socket default timeout to None (fixes daemons_tests failures)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38163\fP: (\fI\%Ch3LL\fP) enabled ec2 cloud tests
@ \fI2016\-12\-09 18:01:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
65b2ad7b14 Merge pull request \fI\%#38163\fP from Ch3LL/enabled_ec2_cloud
.IP \(bu 2
be74c45463 enabled ec2 cloud tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38177\fP: (\fI\%vutny\fP) Correct \fIcp.get_file_str\fP docstring and add integration tests
@ \fI2016\-12\-09 16:55:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
b63f74e034 Merge pull request \fI\%#38177\fP from vutny/fix\-cp\-get\-file\-str
.IP \(bu 2
a449980672 Correct \fIcp.get_file_str\fP docstring and add integration tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38153\fP: (\fI\%vutny\fP) Master config includes may contain errors and be safely skipped
@ \fI2016\-12\-08 17:43:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
7596313be0 Merge pull request \fI\%#38153\fP from vutny/master\-includes\-error\-tolerance
.IP \(bu 2
cd0154ee93 Master config includes may contain errors and be safely skipped
.IP \(bu 2
\fBPR\fP \fI\%#38134\fP: (\fI\%rallytime\fP) Skip daemon unit tests when running on Python 2.6
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38091\fP: (\fI\%tjyang\fP) [WARNING ] salt.loaded.int.module.zenoss.__virtual__() is wrongly returning \fINone\fP\&.  (refs: \fI\%#38102\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38102\fP: (\fI\%rallytime\fP) Add False + msg tuple return if requests is missing for zenoss module
@ \fI2016\-12\-07 13:24:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
d3d98fd4eb Merge pull request \fI\%#38102\fP from rallytime/fix\-38091
.IP \(bu 2
4f79d5a0d1 Add False + msg tuple return if requests is missing for zenoss module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36707\fP: (\fI\%do3meli\fP) slow FreeBSD sysctl module with test=true (refs: \fI\%#36794\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38104\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36794\fP to 2016.3
@ \fI2016\-12\-07 13:23:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36794\fP: (\fI\%do3meli\fP) FreeBSD sysctl module now handels config_file parameter in show method (refs: \fI\%#38104\fP)
.IP \(bu 2
8c8cbc2734 Merge pull request \fI\%#38104\fP from rallytime/bp\-36794
.IP \(bu 2
c906c8a0d5 Pylint fixes
.IP \(bu 2
da3ebf83e6 FreeBSD sysctl module now handels config_file parameter in show method
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35342\fP: (\fI\%morganwillcock\fP) win_pkg: refresh_db doesn\(aqt remove cached items which have been renamed or removed (refs: \fI\%#38083\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38083\fP: (\fI\%twangboy\fP) Only delete .sls files from winrepo\-ng [DO NOT MERGE FORWARD]
@ \fI2016\-12\-06 14:13:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
fbc87769b9 Merge pull request \fI\%#38083\fP from twangboy/fix_refresh_db
.IP \(bu 2
978af6d83c Remove only .sls files from the cached winrepo\-ng
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38059\fP: (\fI\%rallytime\fP) Call exec_test for the Syndic daemon in tests.unit.daemons_test.py
@ \fI2016\-12\-04 04:18:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38057\fP: (\fI\%rallytime\fP) [2016.11] Merge forward from 2016.3 to 2016.11 (refs: \fI\%#38059\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38034\fP: (\fI\%cachedout\fP) Modify daemons test to use multiprocessing (refs: \fI\%#38059\fP)
.IP \(bu 2
9dcfdeef6b Merge pull request \fI\%#38059\fP from rallytime/daemons\-test\-fix
.IP \(bu 2
eb372b27d8 Add missing \(dqnot\(dq statement: The last syndic test should assertFalse()
.IP \(bu 2
4e10f8e018 Call exec_test for the Syndic daemon in tests.unit.daemons_test.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37939\fP: (\fI\%Talkless\fP) file.comment always report changes in test=True mode (refs: \fI\%#38039\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38039\fP: (\fI\%rallytime\fP) Check to see if a line is already commented before moving on
@ \fI2016\-12\-02 20:08:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
9cd42b9b3f Merge pull request \fI\%#38039\fP from rallytime/fix\-37939
.IP \(bu 2
1da7aacfbe Update unit tests to account for additional file.search call
.IP \(bu 2
8a685b1820 Check to see if a line is already commented before moving on
.IP \(bu 2
f2c045520d Write an integration test demonstrating the issue
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38037\fP: (\fI\%dmurphy18\fP) pkg.latest and yumpkg.latest_version return incorrect package versions 2016.3 and 2016.11 (refs: \fI\%#38045\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38045\fP: (\fI\%terminalmage\fP) yumpkg.py: don\(aqt include non\-upgrade versions found by \(dqyum list available\(dq
@ \fI2016\-12\-02 20:07:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
a34a763984 Merge pull request \fI\%#38045\fP from terminalmage/issue38037
.IP \(bu 2
65289503d9 Simplify logic for matching desired pkg arch with actual pkg arch
.IP \(bu 2
3babbcda94 yumpkg.py: don\(aqt include non\-upgrade versions found by \(dqyum list available\(dq
.IP \(bu 2
\fBPR\fP \fI\%#38034\fP: (\fI\%cachedout\fP) Modify daemons test to use multiprocessing (refs: \fI\%#38059\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37995\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-11\-30 20:12:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
6942d5d95b Merge pull request \fI\%#37995\fP from rallytime/merge\-2016.3
.IP \(bu 2
b44e17921c Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
7a7e36728f Merge pull request \fI\%#37978\fP from terminalmage/ext_pillar_first\-docs
.INDENT 2.0
.IP \(bu 2
61ed9a8657 Add clarifying language to ext_pillar_first docs
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38002\fP: (\fI\%laleocen\fP) fix broken yaml code block
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35088\fP: (\fI\%Modulus\fP) salt/cloud/ec2.py encoding problems. (refs: \fI\%#37912\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37912\fP: (\fI\%attiasr\fP) fix encoding problem aws responses
@ \fI2016\-11\-30 18:10:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
3dd45fbedf Merge pull request \fI\%#37912\fP from attiasr/fix_aws_response_encoding
.IP \(bu 2
ba4ec4e7f1 use Requests result encoding to encode the text
.IP \(bu 2
abe4eb3b98 fix encoding problem aws responses
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37950\fP: (\fI\%vutny\fP) Set default Salt Master address for a Syndic (like for a Minion)
@ \fI2016\-11\-30 18:09:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
69a74a4d2d Merge pull request \fI\%#37950\fP from vutny/fix\-starting\-up\-syndic
.IP \(bu 2
7d9bc9abce syndic_master: correct default value, documentation and example config
.IP \(bu 2
92a7c7ed1b Set default Salt Master address for a Syndic (like for a Minion)
.IP \(bu 2
\fBPR\fP \fI\%#37964\fP: (\fI\%terminalmage\fP) Add clarification on expr_form usage and future deprecation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37867\fP: (\fI\%tobiasBora\fP) Bug into lsb_release that crash salt (refs: \fI\%#37962\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37962\fP: (\fI\%cachedout\fP) Catch possible exception from lsb_release
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37945\fP: (\fI\%gstachowiak\fP) Missing exception handling in salt.master.Maintenance. Process never completes. (refs: \fI\%#37961\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37961\fP: (\fI\%cachedout\fP) Handle empty tokens safely
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37272\fP: (\fI\%vutny\fP) Get default logging level and log file from default opts dict (refs: \fI\%#38223\fP)
@ \fI2016\-11\-28 23:04:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea46639ce7 Merge pull request \fI\%#37272\fP from vutny/fix\-getting\-default\-logging\-opts
.IP \(bu 2
e5ce52388a Fix description in the Salt Syndic usage info
.IP \(bu 2
518a3dd7ee Add unit tests for Salt parsers processing logging options
.IP \(bu 2
83d6a44254 Add \fIssh_log_file\fP option to master config and documentation
.IP \(bu 2
c8a0915460 Fix configuration example and documentation for \fIsyndic_log_file\fP option
.IP \(bu 2
e64dd3ed6b Correct default attributes for various parser classes
.IP \(bu 2
82a2e216b3 Fix default usage string for Salt command line programs
.IP \(bu 2
45dffa292f Fix readding and updating logfile and pidfile config options for Salt API
.IP \(bu 2
f47253c21b Fix reading and applying Salt Cloud default configuration
.IP \(bu 2
fad5bec936 Work with a copy of default opts dictionaries
.IP \(bu 2
b7c24811e5 Fix \fIlog_level_logfile\fP config value type
.IP \(bu 2
1bd76a1d96 Fix setting temporary log level if CLI option omitted
.IP \(bu 2
121848cc77 Fix obtaining \fIlog_granular_levels\fP config setting
.IP \(bu 2
44cf07fec2 Make CLI options take precedence for setting up logfile_logger
.IP \(bu 2
61afaf1792 Fix setting option attributes when processing \fIlog_level\fP and \fIlog_file\fP
.IP \(bu 2
3c60e2388e Fix processing of \fIlog_level_logfile\fP config setting
.IP \(bu 2
55a0af5bbd Use attribute functions for getting/setting options and config values
.IP \(bu 2
c25f2d091e Fix getting Salt API default logfile option
.IP \(bu 2
f2422373c1 Remove processing of unused and undocumented \fIcli_*_log_*\fP config options
.IP \(bu 2
2065e8311c Get default logging level and file from default opts dict
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37925\fP: (\fI\%kontrolld\fP) Fix missing ipv6 options centos network
@ \fI2016\-11\-28 22:38:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
f2f957da6c Merge pull request \fI\%#37925\fP from kontrolld/add\-ipv6\-centos\-network
.IP \(bu 2
ac2b477412 Adding IPv6 functionality for CentOS /etc/sysconfig/network
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37059\fP: (\fI\%basepi\fP) Beacon fileserver operations cause scheduled jobs with fileserver operations to hang (refs: \fI\%#37899\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37899\fP: (\fI\%DmitryKuzmenko\fP) Clear functions context in schedule tasks for ZeroMQ.
@ \fI2016\-11\-28 22:23:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
c07ad11279 Merge pull request \fI\%#37899\fP from DSRCorporation/bugs/37059_schedule_task_hang
.IP \(bu 2
9497748546 Clear functions context in schedule tasks for ZeroMQ.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37737\fP: (\fI\%b\-harper\fP) python client api CloudClient multiple calls needed (refs: \fI\%#37928\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37928\fP: (\fI\%techhat\fP) Don\(aqt modify self.opts directly
@ \fI2016\-11\-28 21:07:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
a55519db40 Merge pull request \fI\%#37928\fP from techhat/issue37737
.IP \(bu 2
a09a60e89b Don\(aqt modify self.opts directly
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37929\fP: (\fI\%gtmanfred\fP) add list_nodes_min to nova driver
@ \fI2016\-11\-28 21:05:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d17f1ce90 Merge pull request \fI\%#37929\fP from gtmanfred/2016.3
.IP \(bu 2
c7d2c73503 add list_nodes_min to nova driver
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37926\fP: (\fI\%kontrolld\fP) Fixes no IPv6 functionality in /etc/sysconfig/network
@ \fI2016\-11\-28 20:40:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
3bb743b59f Merge pull request \fI\%#37926\fP from kontrolld/fix\-ipv6\-centos\-network
.IP \(bu 2
3ed42e5b44 updated
.IP \(bu 2
3b3bc4f239 Fixes no IPv6 functionality in /etc/sysconfig/network
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37921\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-11\-28 19:54:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
271170a9f3 Merge pull request \fI\%#37921\fP from rallytime/merge\-2016.3
.IP \(bu 2
523a67c422 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
4cdc6cf5ec Update earlier release channels\(aq docs with Carbon release notes (\fI\%#37914\fP)
.IP \(bu 2
d31491a7fe [2015.8] Update version numbers in doc config for 2016.11.0 release (\fI\%#37918\fP)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37924\fP: (\fI\%cachedout\fP) Update test for new gem ver
@ \fI2016\-11\-28 18:17:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
6cd6429ac0 Merge pull request \fI\%#37924\fP from cachedout/fix_gem_states
.IP \(bu 2
894cca3427 Update test for new gem ver
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37916\fP: (\fI\%rallytime\fP) [2016.3] Update version numbers in doc config for 2016.11.0 release
@ \fI2016\-11\-28 17:09:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
c35ba1f390 Merge pull request \fI\%#37916\fP from rallytime/doc\-update\-2016.3
.IP \(bu 2
bd40592289 [2016.3] Update version numbers in doc config for 2016.11.0 release
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37287\fP: (\fI\%aaronm\-cloudtek\fP) salt.states.ddns.present: \(aqNS\(aq record type always returns as changed (refs: \fI\%#37785\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37785\fP: (\fI\%aaronm\-cloudtek\fP) respect trailing dot in ddns name parameter
@ \fI2016\-11\-28 14:02:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
e13a2488c8 Merge pull request \fI\%#37785\fP from Cloudtek/ddns\-respect\-trailing\-dot
.IP \(bu 2
262e3b3697 respect trailing dot in ddns name parameter
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37870\fP: (\fI\%fj40crawler\fP) salt.states.augeas.change returns None when test=True (refs: \fI\%#37895\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37895\fP: (\fI\%fj40crawler\fP) Change return value for salt/states/augeas.py to be True instead of N…
@ \fI2016\-11\-28 13:49:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
c03b389422 Merge pull request \fI\%#37895\fP from fj40crawler/fix\-augeas\-return\-for\-test
.IP \(bu 2
ddc238df36 Fixed augeas_test.py to match True v.s. None for test_change_in_test_mode
.IP \(bu 2
ef75c459c0 Merge branch \(aq2016.3\(aq of github.com:saltstack/salt into fix\-augeas\-return\-for\-test
.IP \(bu 2
b0fe0cd256 Change return value for salt/states/augeas.py to be True instead of None for cases where salt is run with test=True. Fixes \fI\%#37870\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37907\fP: (\fI\%Talkless\fP) Fix server trust in test run of svn.latest
@ \fI2016\-11\-28 13:47:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
fdbc31e8d8 Merge pull request \fI\%#37907\fP from Talkless/patch\-2
.IP \(bu 2
072a319490 Fix server trust in test run of svn.latest
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37896\fP: (\fI\%toanju\fP) rh networking: add missing values
@ \fI2016\-11\-27 10:30:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
f39fdf443f Merge pull request \fI\%#37896\fP from toanju/2016.3
.IP \(bu 2
c95304188e rh networking: add missing values
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37886\fP: (\fI\%bdrung\fP) Fix various spelling mistakes
@ \fI2016\-11\-25 02:59:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea935c5a91 Merge pull request \fI\%#37886\fP from bdrung/fix\-typos
.IP \(bu 2
9a51ba5c5b Fix various spelling mistakes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37732\fP: (\fI\%dhaines\fP) list_semod() (from modules/selinux.py) incompatible with policycoreutils\-2.5 (RHEL 7.3) (refs: \fI\%#37736\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37736\fP: (\fI\%dhaines\fP) handle semodule version >=2.4 (\fI\%#37732\fP) and fix typo
@ \fI2016\-11\-24 01:44:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
371b0a86d9 Merge pull request \fI\%#37736\fP from dhaines/issue\-37732
.IP \(bu 2
7ef590a505 Update selinux.py
.IP \(bu 2
516a67e6a3 fix indexing error
.IP \(bu 2
4e49c1e991 fix typo
.IP \(bu 2
b16f2d8400 handle semodule version >=2.4 (\fI\%#37732\fP) and fix typo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37797\fP: (\fI\%clan\fP) check count of columns after split
@ \fI2016\-11\-24 01:28:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
87aeb66fbf Merge pull request \fI\%#37797\fP from clan/extfs
.IP \(bu 2
acf0f960ef check count of columns after split
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37762\fP: (\fI\%twangboy\fP) Add pre_versions to chocolatey.installed
@ \fI2016\-11\-24 01:27:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
f7c7109152 Merge pull request \fI\%#37762\fP from twangboy/fix_chocolatey_state
.IP \(bu 2
9696b6dfa5 Use keyword args instead of relying on ordering
.IP \(bu 2
398eaa074d Add pre_versions to the available arguments
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37866\fP: (\fI\%meaksh\fP) Backport \fI\%#37149\fP \fI\%#36938\fP and \fI\%#36784\fP to 2016.3
@ \fI2016\-11\-23 21:54:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37857\fP: (\fI\%meaksh\fP) Backport \fI\%#37149\fP and \fI\%#36938\fP to 2015.8 (refs: \fI\%#37866\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37856\fP: (\fI\%meaksh\fP) Backport \fI\%#36784\fP to 2015.8 (refs: \fI\%#37866\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37149\fP: (\fI\%dincamihai\fP) Fix pkg.latest_version when latest already installed (refs: \fI\%#37857\fP, \fI\%#37866\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36938\fP: (\fI\%wanparo\fP) acl.delfacl: fix position of \-X option to setfacl (refs: \fI\%#37857\fP, \fI\%#37866\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36784\fP: (\fI\%moio\fP) OS grains for SLES Expanded Support (refs: \fI\%#37856\fP, \fI\%#37866\fP)
.IP \(bu 2
56baa92d55 Merge pull request \fI\%#37866\fP from meaksh/2016.3\-bp\-37149\-36938\-36784
.IP \(bu 2
9d8d578109 Fix pkg.latest_version when latest already installed
.IP \(bu 2
ffca0d491c \- acl.delfacl: fix position of \-X option to setfacl
.IP \(bu 2
3dfed6b841 Adjust linux_acl unit test argument ordering
.IP \(bu 2
f185ecdde1 core.py: quote style fixed
.IP \(bu 2
8404d13424 Setting up OS grains for SLES Expanded Support (SUSE\(aqs Red Hat compatible platform)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32829\fP: (\fI\%tyhunt99\fP) Dockerng appears to not be using docker registries pillar data (refs: \fI\%#36893\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37863\fP: (\fI\%rallytime\fP) Back\-port \fI\%#36893\fP to 2016.3
@ \fI2016\-11\-23 17:09:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36893\fP: (\fI\%tyhunt99\fP) add option to force a reauth for a docker registry (refs: \fI\%#37863\fP)
.IP \(bu 2
d0cc7f0d56 Merge pull request \fI\%#37863\fP from rallytime/bp\-36893
.IP \(bu 2
4c70534991 Add versionadded to reauth option in dockerng module
.IP \(bu 2
5ca2c388c2 added documentation for the new reuth option in docker registry configuration
.IP \(bu 2
5b0c11ab47 add option to force a reauth for a docker registry
.IP \(bu 2
\fBPR\fP \fI\%#37847\fP: (\fI\%laleocen\fP) add multiline encryption documentation to nacl
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37787\fP: (\fI\%elyulka\fP) user.present state fails to change loginclass on FreeBSD (refs: \fI\%#37827\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37827\fP: (\fI\%silenius\fP) add missing chloginclass
.IP \(bu 2
\fBPR\fP \fI\%#37826\fP: (\fI\%rallytime\fP) Update branch refs to more relevant branch
.IP \(bu 2
\fBPR\fP \fI\%#37822\fP: (\fI\%laleocen\fP) add documentation for multiline encryption using nacl (refs: \fI\%#37826\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19269\fP: (\fI\%markuskramerIgitt\fP) Undocumented  feature \fInames:\fP of \fIfile.directory\fP (refs: \fI\%#37823\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37823\fP: (\fI\%rallytime\fP) Add \(dqnames\(dq option to file state docs: point users to highstate doc examples
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#15697\fP: (\fI\%arthurlogilab\fP) keystone.user_present should not re\-set the password when user exists (refs: \fI\%#37821\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37821\fP: (\fI\%rallytime\fP) Clarify keystone.user_present password state docs with default behavior
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#5999\fP: (\fI\%pille\fP) libvirt.keys does not work (refs: \fI\%#37820\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37820\fP: (\fI\%rallytime\fP) Add some dependency documentation to libvirt docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37772\fP: (\fI\%bdrung\fP) Support initializing OpenSSL 1.1
@ \fI2016\-11\-21 20:28:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
485270f74e Merge pull request \fI\%#37772\fP from bdrung/openssl1.1
.IP \(bu 2
819c9658ed Support initializing OpenSSL 1.1
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37383\fP: (\fI\%edwardsdanielj\fP) Orchestration arguments (kwarg) not being interperted / How I learned to stop worrying about documentation and love experimenting (refs: \fI\%#37817\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37817\fP: (\fI\%rallytime\fP) Update orchestrate runner file.copy doc example
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37653\fP: (\fI\%gravyboat\fP) Salt.cron docs don\(aqt wrap @hourly and @daily correctly in quotes for the examples (refs: \fI\%#37816\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#31953\fP: (\fI\%sjorge\fP) Documentation for salt.states.cron is incorrect (refs: \fI\%#32157\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37816\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32157\fP to 2016.3
@ \fI2016\-11\-21 20:22:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32157\fP: (\fI\%cachedout\fP) Add quotes to cron doc (refs: \fI\%#37816\fP)
.IP \(bu 2
c5d3d8b66a Merge pull request \fI\%#37816\fP from rallytime/bp\-32157
.IP \(bu 2
d9c297119e Add quotes to cron doc
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37812\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37790\fP to 2016.3
@ \fI2016\-11\-21 18:46:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37790\fP: (\fI\%sofixa\fP) Update cloud/proxmox.rst with more options and LXC (refs: \fI\%#37812\fP)
.IP \(bu 2
97e6b6aabe Merge pull request \fI\%#37812\fP from rallytime/bp\-37790
.IP \(bu 2
ca3b6e7874 Update proxmox.rst with more options and LXC
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37751\fP: (\fI\%freach\fP) Documentation salt.states.dockerng.running: \(dqprivileged\(dq property undocumented (refs: \fI\%#37789\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37811\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37789\fP to 2016.3
@ \fI2016\-11\-21 18:46:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37789\fP: (\fI\%fedusia\fP) issue: 37751 (refs: \fI\%#37811\fP)
.IP \(bu 2
27703c54bc Merge pull request \fI\%#37811\fP from rallytime/bp\-37789
.IP \(bu 2
ba3fef48e1  fix comment
.IP \(bu 2
a021f76a9b issue: 37751 Add documentation for option privileged
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37810\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37775\fP to 2016.3
@ \fI2016\-11\-21 18:45:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37775\fP: (\fI\%calve\fP) Document \fIpython\fP argument in \fIsalt.states.virtualenv_mod\fP (refs: \fI\%#37810\fP)
.IP \(bu 2
adac9d7c0c Merge pull request \fI\%#37810\fP from rallytime/bp\-37775
.IP \(bu 2
2bed91437b Document \fIpython\fP argument in \fIsalt.states.virtualenv_mod\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37742\fP: (\fI\%blaketmiller\fP) Cannot match on nodegroup when checking minions (refs: \fI\%#37763\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37763\fP: (\fI\%cachedout\fP) Add nodegroup check to ckminions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37725\fP: (\fI\%secumod\fP) salt\-call incorrectly parses master hostname:port from minion config (refs: \fI\%#37766\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37766\fP: (\fI\%cachedout\fP) Fix ip/port issue with salt\-call
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33709\fP: (\fI\%msummers42\fP) Any/All Salt\-SSH invocations in 2016.3.0 Fails with AttributeError: \(aqmodule\(aq object has no attribute \(aqBASE_THORIUM_ROOTS_DIR\(aq (refs: \fI\%#37767\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37767\fP: (\fI\%cachedout\fP) Add thorium path to syspaths
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37760\fP: (\fI\%hu\-dabao\fP) Fix couchbase returner and add couple of more features
@ \fI2016\-11\-18 00:28:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
bff949f4e9 Merge pull request \fI\%#37760\fP from hu\-dabao/fix_cb_returner
.IP \(bu 2
de372f277e 1. returner no need to check whether the jid exists for external job cache setup 2. add full_ret to return doc so that the document will be informative 3. make ttl as a config attribute because salt\-minion does not have keep_jobs attribute 4. add password into config attribute 5. update the documents accordingly
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36629\fP: (\fI\%yhekma\fP) The pillar run module does not honor saltenv (refs: \fI\%#37738\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37738\fP: (\fI\%terminalmage\fP) Allow pillar.get to retrieve fresh pillar data when saltenv passed
@ \fI2016\-11\-17 23:13:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f976ac212 Merge pull request \fI\%#37738\fP from terminalmage/issue36629
.IP \(bu 2
da46678c51 Allow pillar.get to retrieve fresh pillar data when saltenv passed
.IP \(bu 2
\fBPR\fP \fI\%#37745\fP: (\fI\%cro\fP) Switch default filter tag for ONE resources from user only to all resources
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37498\fP: (\fI\%githubcdr\fP) service.restart salt\-minion fails on Ubuntu 14.04.5 LTS (refs: \fI\%#37748\fP, \fI\%#38587\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37748\fP: (\fI\%silenius\fP) check for SERVICE_DIR in __virtual__ in salt.modules.daemontools
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37734\fP: (\fI\%Ch3LL\fP) Joyent Cloud Size Issue (refs: \fI\%#37735\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37735\fP: (\fI\%Ch3LL\fP) change size and image of joyent profile
@ \fI2016\-11\-16 21:07:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
fa7883115e Merge pull request \fI\%#37735\fP from Ch3LL/fix_joyent_profile
.IP \(bu 2
9ef41dcdfc change size and image of joyent profile
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37731\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-11\-16 17:13:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
98e25c68aa Merge pull request \fI\%#37731\fP from rallytime/merge\-2016.3
.IP \(bu 2
ec1389711f Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
f417dbbe99 Merge pull request \fI\%#37718\fP from terminalmage/docs
.INDENT 2.0
.IP \(bu 2
23b8b2a3f4 Fix incorrectly\-formatted RST
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37724\fP: (\fI\%cachedout\fP) Warn on AES test for systems with > 1 core
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37721\fP: (\fI\%terminalmage\fP) Fix for pillar setting \(aqenvironment\(aq key in __gen_opts()
@ \fI2016\-11\-16 16:04:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
35655d521f Merge pull request \fI\%#37721\fP from terminalmage/zd909
.IP \(bu 2
acdd5513da Update git_pillar docs to reflect info from bugfix
.IP \(bu 2
433737d2dc Fix for pillar setting \(aqenvironment\(aq key in __gen_opts()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37719\fP: (\fI\%terminalmage\fP) Fix incorrectly\-formatted RST (2016.3 branch)
@ \fI2016\-11\-16 08:20:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
99cda7c003 Merge pull request \fI\%#37719\fP from terminalmage/docs\-2016.3
.IP \(bu 2
f163b4c724 Fix incorrectly\-formatted RST
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37694\fP: (\fI\%cachedout\fP) Catch differences in git URLs in npm state
@ \fI2016\-11\-16 01:56:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
8dea695c7c Merge pull request \fI\%#37694\fP from cachedout/npm_git
.IP \(bu 2
0e3bc2366a Catch differences in git URLs in npm state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37665\fP: (\fI\%kluoto\fP) boto_elb state fails as key is overwritten by the code (refs: \fI\%#37705\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37705\fP: (\fI\%rallytime\fP) Don\(aqt overwrite the \(dqkey\(dq variable passed in to _listeners_present func
@ \fI2016\-11\-15 21:26:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
329448ccd7 Merge pull request \fI\%#37705\fP from rallytime/fix\-37665
.IP \(bu 2
3b7e9c5e3b Don\(aqt overwrite the \(dqkey\(dq variable passed in to _listeners_present func
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37707\fP: (\fI\%Ch3LL\fP) add timeout increase on azure tests
@ \fI2016\-11\-15 21:24:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37239\fP: (\fI\%Ch3LL\fP) Fix cloud tests timeout (refs: \fI\%#37707\fP)
.IP \(bu 2
ac9a316b50 Merge pull request \fI\%#37707\fP from Ch3LL/fix_timeout_azure
.IP \(bu 2
363122c675 add timeout increase on azure tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37704\fP: (\fI\%twangboy\fP) Fix test disabled 2016.3 [DO NOT MERGE FORWARD]
@ \fI2016\-11\-15 16:48:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
1ece265354 Merge pull request \fI\%#37704\fP from twangboy/fix_test_disabled_2016.3
.IP \(bu 2
a0429cf839 Use nfsd instead of apsd for test_disabled
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37690\fP: (\fI\%twangboy\fP) Update pyzmq to 15.3.0 for 2016.3 [DO NOT MERGE FORWARD]
@ \fI2016\-11\-15 03:10:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
44f05acbff Merge pull request \fI\%#37690\fP from twangboy/update_pyzmq_2016.3
.IP \(bu 2
cf55342150 Update pyzmq to version 15.3.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37680\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32965\fP to 2016.3
@ \fI2016\-11\-15 02:56:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32965\fP: (\fI\%kevinquinnyo\fP) Fix \(aqpresent\(aq option when used without \(aqkey_type\(aq (refs: \fI\%#37680\fP)
.IP \(bu 2
a743d8b5e6 Merge pull request \fI\%#37680\fP from rallytime/bp\-32965
.IP \(bu 2
1865b13645 Fix \(aqpresent\(aq option when used without \(aqkey_type\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35964\fP: (\fI\%edgan\fP) salt\-ssh doesn\(aqt set the return code to non\-zero on highstate rendering error (refs: \fI\%#35965\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37681\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35965\fP to 2016.3
@ \fI2016\-11\-14 21:19:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35965\fP: (\fI\%edgan\fP) Set the return code to 1 on salt\-ssh highstate errors (refs: \fI\%#37681\fP)
.IP \(bu 2
1c2d6ff293 Merge pull request \fI\%#37681\fP from rallytime/bp\-35965
.IP \(bu 2
700f3fa57f Set the return code to 1 on salt\-ssh highstate errors
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37668\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-11\-14 15:43:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
1b456b55dc Merge pull request \fI\%#37668\fP from rallytime/merge\-2016.3
.IP \(bu 2
ef684c6b02 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
a01b66556f Add docs for rotate_aes_key (\fI\%#37641\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37492\fP: (\fI\%JensRantil\fP) Failing \fIsalt \-b 1 minion state.highstate\fP has wrong exit code (refs: \fI\%#37625\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37625\fP: (\fI\%cachedout\fP) Return with proper retcodes in batch mode
@ \fI2016\-11\-12 20:29:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
305e51d1c0 Merge pull request \fI\%#37625\fP from cachedout/issue_37492
.IP \(bu 2
b6031524e5 Return with proper retcodes in batch mode
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34547\fP: (\fI\%sebw\fP) salt\-cloud deployment fails when deploy: True (refs: \fI\%#37607\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37639\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37607\fP to 2016.3
@ \fI2016\-11\-11 20:29:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37607\fP: (\fI\%techhat\fP) Try the connection again, in case it\(aqs been reset (refs: \fI\%#37639\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35673\fP: (\fI\%cro\fP) Proxies don\(aqt handle reusing the SmartConnect instances very well.  D… (refs: \fI\%#37607\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34059\fP: (\fI\%alexbleotu\fP) Vmware common gh (refs: \fI\%#37607\fP)
.IP \(bu 2
7510cd4da9 Merge pull request \fI\%#37639\fP from rallytime/bp\-37607
.IP \(bu 2
9914c93bc4 Pylint: Remove kwargs that are not in the 2016.3 branch
.IP \(bu 2
d941e9354d Disable pylint warning
.IP \(bu 2
940ee49a0b Lint fix
.IP \(bu 2
69893f0c38 Try the connection again, in case it\(aqs been reset
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#37118\fP: (\fI\%gtmanfred\fP) group in file.find module unable to be a list (refs: \fI\%#37349\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#37118\fP: (\fI\%gtmanfred\fP) group in file.find module unable to be a list (refs: \fI\%#37349\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37638\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37349\fP to 2016.3
@ \fI2016\-11\-11 20:29:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37349\fP: (\fI\%haeac\fP) Pull request for Bug \fI\%#37118\fP (refs: \fI\%#37638\fP)
.IP \(bu 2
24ca96010d Merge pull request \fI\%#37638\fP from rallytime/bp\-37349
.IP \(bu 2
ba2105bc39 Fix for Bug \fI\%#37118\fP, the wrong parameter was being used to convert the group name to group id.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37643\fP: (\fI\%Ch3LL\fP) digital ocean list_keypairs limits to 20 keys (refs: \fI\%#37644\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37644\fP: (\fI\%Ch3LL\fP) digital ocean list_keypairs: increase limit for ssh keys parsed
@ \fI2016\-11\-11 20:28:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
e1e8b81d16 Merge pull request \fI\%#37644\fP from Ch3LL/fix_37643
.IP \(bu 2
c02961a2f5 list_keypairs: increase limit for ssh keys parsed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37541\fP: (\fI\%yhekma\fP) salt\-minion does not clean up temp files for templates (refs: \fI\%#37540\fP, \fI\%#37640\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37640\fP: (\fI\%rallytime\fP) Add known issue \fI\%#37541\fP to 2016.3.4 release notes
@ \fI2016\-11\-11 20:28:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
a97c2ad34b Merge pull request \fI\%#37640\fP from rallytime/update\-release\-notes
.IP \(bu 2
6d6de12aff Grammatical fix
.IP \(bu 2
24d7f20e16 Add known issue \fI\%#37541\fP to 2016.3.4 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37642\fP: (\fI\%cro\fP) Forward\-port change from 2015.8 adding release note for rotate_aes_key
@ \fI2016\-11\-11 20:27:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
fab3eaa237 Merge pull request \fI\%#37642\fP from cro/rotate_aes_doc
.IP \(bu 2
1ca5b958c6 Forward\-port change from 2015.8 adding release note for rotate_aes_key
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37628\fP: (\fI\%TronPaul\fP) [git 2016.3] Refreshing of an s3 file server results in an exception (refs: \fI\%#37629\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37629\fP: (\fI\%TronPaul\fP) fix __opts__ and provider being None in salt.utils.aws:get_location
@ \fI2016\-11\-11 09:49:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
4c07b3534a Merge pull request \fI\%#37629\fP from TronPaul/fix\-s3fs\-opts
.IP \(bu 2
a452cded20 fix __opts__ and provider being None issue
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37481\fP: (\fI\%thatch45\fP) Raet internal client reference fix
@ \fI2016\-11\-11 04:39:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
200d9fcb6e Merge pull request \fI\%#37481\fP from thatch45/raet_client
.IP \(bu 2
50d911160b Attempted fix, needs user verification
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37611\fP: (\fI\%jeanpralo\fP) Fix cmd batch raw
@ \fI2016\-11\-11 02:53:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
b14faf1c68 Merge pull request \fI\%#37611\fP from jeanpralo/fix\-cmd\-batch\-raw
.IP \(bu 2
4f16840ef1 add integration test for salt.client.LocalClient.cmd_batch
.IP \(bu 2
ead47e4bba update ret dict to avoid hanging
.IP \(bu 2
0a2f153b6e fix dict key for raw support to avoid exception
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37614\fP: (\fI\%gtmanfred\fP) remove redundant code
@ \fI2016\-11\-11 02:49:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
35c8333d04 Merge pull request \fI\%#37614\fP from gtmanfred/2016.3
.IP \(bu 2
71c2df89a9 remove redundent code
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37627\fP: (\fI\%cachedout\fP) Exempt pip.iteritems from test_valid_docs test
@ \fI2016\-11\-11 02:48:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
4fab707bdd Merge pull request \fI\%#37627\fP from cachedout/pr\-36706
.IP \(bu 2
94df2f8e6f Exempt pip.iteritems from test_valid_docs test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36644\fP: (\fI\%b1naryth1ef\fP) env_vars not properly validated/casted to strings w/ virtualenv.manage/pip.install (refs: \fI\%#36706\fP)
.IP \(bu 2
\fBPR\fP \fI\%#36706\fP: (\fI\%siccrusher\fP) Add basic sanity checks for env_vars in pip.install function
@ \fI2016\-11\-11 02:47:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
ee74f3116e Merge pull request \fI\%#36706\fP from siccrusher/fix_env_var_validation
.IP \(bu 2
fb27f8b69e Revert change
.IP \(bu 2
79f3e83f8d Use fully\-qualified path for six
.IP \(bu 2
0ca1222833 Update pip.py
.IP \(bu 2
b15de371c1 * Ensure src is python3 compatible
.IP \(bu 2
0976a2d1ae * Before passing on the env_vars dictionary ensure all values are   strings. Fixes \fI\%#36644\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37491\fP: (\fI\%JensRantil\fP) \(dqFailed to authenticate! ...\(dq error should exit non\-zero (refs: \fI\%#37626\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37626\fP: (\fI\%cachedout\fP) Exit with proper retcode on hard client failures
@ \fI2016\-11\-11 02:38:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
902a97575e Merge pull request \fI\%#37626\fP from cachedout/issue_37491
.IP \(bu 2
bab9a729b1 Exit with proper retcode on hard client failures
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37617\fP: (\fI\%terminalmage\fP) Clarify docs for git_pillar dynamic env feature
@ \fI2016\-11\-11 01:52:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
845f835177 Merge pull request \fI\%#37617\fP from terminalmage/git_pillar\-docs
.IP \(bu 2
8cdf5dbb51 Clarify docs for git_pillar dynamic env feature
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#36627\fP: (\fI\%sjmh\fP) Skip rest of loop on failed func match
@ \fI2016\-11\-10 23:47:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
3079d78332 Merge pull request \fI\%#36627\fP from sjmh/fix/auth_skip_nomatch
.IP \(bu 2
b3baaf30d0 Skip rest of loop on failed func match
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37600\fP: (\fI\%mcalmer\fP) change TIMEZONE on SUSE systems (bsc#1008933)
@ \fI2016\-11\-10 21:54:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
a71e7c77b3 Merge pull request \fI\%#37600\fP from mcalmer/fix\-timezone\-on\-SUSE
.IP \(bu 2
3530b542f0 change TIMEZONE on SUSE systems (bsc#1008933)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37238\fP: (\fI\%cmclaughlin\fP) Restarting master causes minion to hang (refs: \fI\%#37438\fP, \fI\%#37602\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#37018\fP: (\fI\%tsaridas\fP) get events from python (refs: \fI\%#37438\fP, \fI\%#37602\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37602\fP: (\fI\%DmitryKuzmenko\fP) Handle master restart in appropriate places using \fIsalt.event\fP listener.
@ \fI2016\-11\-10 21:53:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37438\fP: (\fI\%DmitryKuzmenko\fP) Fix for \fI\%#37238\fP salt hang on master restart (refs: \fI\%#37602\fP)
.IP \(bu 2
39b75878cf Merge pull request \fI\%#37602\fP from DSRCorporation/bugs/37238_salt_hang_on_master_restart
.IP \(bu 2
d3d987b19c Handle master restart in appropriate places using \fIsalt.event\fP listener.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37608\fP: (\fI\%gtmanfred\fP) allow multiline returns from docker for mac
@ \fI2016\-11\-10 21:48:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
019e1a721b Merge pull request \fI\%#37608\fP from gtmanfred/2016.3
.IP \(bu 2
74aee1e372 allow multiline returns from docker for mac
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37592\fP: (\fI\%craigafinch\fP) State git.latest does not work with SSH (refs: \fI\%#37604\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#37551\fP: (\fI\%viict\fP) git.latest \(dqNot a valid commit name\(dq (refs: \fI\%#37604\fP, \fI\%#37571\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37604\fP: (\fI\%terminalmage\fP) Documentation improvements and corrections
.IP \(bu 2
\fBPR\fP \fI\%#37579\fP: (\fI\%pass\-by\-value\fP) Use existing VM\(aqs VDD size if not specified in the cloud profile
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37541\fP: (\fI\%yhekma\fP) salt\-minion does not clean up temp files for templates (refs: \fI\%#37540\fP, \fI\%#37640\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37540\fP: (\fI\%yhekma\fP) Added prefix to tempfile for template
@ \fI2016\-11\-10 00:37:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
fdd13b4145 Merge pull request \fI\%#37540\fP from yhekma/2016.3
.IP \(bu 2
93a59f8034 Added prefix to tempfile for template
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37084\fP: (\fI\%aaronm\-cloudtek\fP) x509.certificate_managed does not work with m2crypto >=0.25 (refs: \fI\%#37578\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37578\fP: (\fI\%clinta\fP) Update for m2crypto changes removing lhash
.IP \(bu 2
\fBPR\fP \fI\%#37584\fP: (\fI\%clinta\fP) Fix eauth example for limiting args
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37551\fP: (\fI\%viict\fP) git.latest \(dqNot a valid commit name\(dq (refs: \fI\%#37604\fP, \fI\%#37571\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37571\fP: (\fI\%terminalmage\fP) Add a test to ensure we don\(aqt check for fast\-forward before fetching
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33645\fP: (\fI\%ketzacoatl\fP) saltutil.sync_all does not sync custom pillar modules to masterless minions (refs: \fI\%#33833\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#25297\fP: (\fI\%Akilesh1597\fP) perform \(aqrefresh_pillar\(aq as a part of \(aqsync_all\(aq (refs: \fI\%#25361\fP, \fI\%#37521\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37553\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37521\fP to 2016.3
@ \fI2016\-11\-08 23:11:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37521\fP: (\fI\%genuss\fP) refresh_pillar() should be called always with refresh=True during saltutil.sync_all (refs: \fI\%#37553\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33833\fP: (\fI\%terminalmage\fP) Support syncing pillar modules to masterless minions (refs: \fI\%#37521\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25361\fP: (\fI\%tedski\fP) perform \fIrefresh_pillar\fP as part of \fIsync_all\fP when \fIrefresh=True\fP (refs: \fI\%#37521\fP)
.IP \(bu 2
b01c247ea9 Merge pull request \fI\%#37553\fP from rallytime/bp\-37521
.IP \(bu 2
30f92b05f4 refresh_pillar() should be called always
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#37549\fP: (\fI\%Mrten\fP) sqlite is not found in 2015.8 (refs: \fI\%#37565\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37565\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37549\fP to 2016.3
@ \fI2016\-11\-08 23:10:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37549\fP: (\fI\%Mrten\fP) sqlite is not found in 2015.8 (refs: \fI\%#37565\fP)
.IP \(bu 2
694df30d40 Merge pull request \fI\%#37565\fP from rallytime/bp\-37549
.IP \(bu 2
c92a90b8e5 Update sqlite3.py
.IP \(bu 2
fb76557a2a sqlite is not found in 2015.8
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37511\fP: (\fI\%jdelic\fP) service.dead now only operates if the service file exists (refs: \fI\%#37562\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37562\fP: (\fI\%terminalmage\fP) Fix regression in service.dead state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37554\fP: (\fI\%sjmh\fP) salt\-api doesn\(aqt dynamically re\-read nodegroups configuration (refs: \fI\%#37560\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37560\fP: (\fI\%whiteinge\fP) Skip config type checking for sdb values
.IP \(bu 2
\fBPR\fP \fI\%#37556\fP: (\fI\%rallytime\fP) Don\(aqt pass the vpc id to boto.vpc.create_internet_gateway func
.IP \(bu 2
\fBPR\fP \fI\%#37543\fP: (\fI\%multani\fP) Documentation rendering fixes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#31081\fP: (\fI\%JensRantil\fP) salt.modules.file.line documentation unclarities (refs: \fI\%#37457\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37457\fP: (\fI\%rallytime\fP) Fixup file.line docs to be more clear and consistent
@ \fI2016\-11\-08 00:29:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
96b8b9a849 Merge pull request \fI\%#37457\fP from rallytime/fix\-31081
.IP \(bu 2
25821bb8db Clarify which modes use \(dqbefore\(dq, \(dqafter\(dq, and \(dqindent\(dq options
.IP \(bu 2
8b2d2b9e7b Clarify file.line state docs as well
.IP \(bu 2
b2615892eb Move note about using mode=insert with location options to mode section
.IP \(bu 2
db0b0cefb8 Fixup file.line docs to be more clear and consistent
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35799\fP: (\fI\%davegiles\fP) dsc.apply_config hangs (no error) on empty directory on target (refs: \fI\%#37526\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37526\fP: (\fI\%twangboy\fP) Remove loop from dsc.apply_config
@ \fI2016\-11\-08 00:23:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
7de790ffed Merge pull request \fI\%#37526\fP from twangboy/fix_35799
.IP \(bu 2
fc4260911c Remove unnecessary format
.IP \(bu 2
c934a2bfa7 Remove the loop from apply_config
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#37515\fP: (\fI\%rallytime\fP) [carbon] Merge forward from 2016.3 to carbon (refs: \fI\%#37534\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37534\fP: (\fI\%rallytime\fP) Back\-port fix needed from \fI\%#37515\fP
@ \fI2016\-11\-08 00:14:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37515\fP: (\fI\%rallytime\fP) [carbon] Merge forward from 2016.3 to carbon (refs: \fI\%#37534\fP)
.IP \(bu 2
94811df2ea Merge pull request \fI\%#37534\fP from rallytime/bp\-merge\-foward\-fix
.IP \(bu 2
d1b2af1d69 Add missing source_hash_name args to a couple funcs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37533\fP: (\fI\%whiteinge\fP) Return a 504 response instead of 500 for Salt timeouts
@ \fI2016\-11\-08 00:14:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
17adbb0c9f Merge pull request \fI\%#37533\fP from whiteinge/salt\-api\-504\-timeouts
.IP \(bu 2
63226aeda6 Return a 504 response instead of 500 for Salt timeouts
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#36679\fP: (\fI\%lorengordon\fP) Command \(aqImport\-Module ServerManager\(aq failed with return code: 1 (refs: #\(gasaltstack/salt\(ga#36736\(ga_\(ga_, \fI\%#36736\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36736\fP: (\fI\%m03\fP) Fix issue 36679 win_servermanager error (refs: \fI\%#37529\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37529\fP: (\fI\%lorengordon\fP) Backport: PR 36736 to 2016.3
@ \fI2016\-11\-08 00:04:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#36736\fP: (\fI\%m03\fP) Fix issue 36679 win_servermanager error
.IP \(bu 2
a9f03eee6f Merge pull request \fI\%#37529\fP from lorengordon/bp\-36736
.IP \(bu 2
21c2664b6a Fix issue 36679 win_servermanager failure
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37444\fP: (\fI\%Tanoti\fP) Returning False from __virtual__ in a returner does not return expected error (refs: #\(gasaltstack/salt\(ga#37502\(ga_\(ga_, \fI\%#37519\fP, \fI\%#37502\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#37502\fP: (\fI\%cachedout\fP) Log proper message on returners that cannot be loaded (refs: \fI\%#37519\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37519\fP: (\fI\%rallytime\fP) Update returner __virtual__() return messages for loader
@ \fI2016\-11\-07 23:06:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
19475aada6 Merge pull request \fI\%#37519\fP from rallytime/returner\-load\-errors
.IP \(bu 2
fb261a31f3 Update returner __virtual__() return messages for loader
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35016\fP: (\fI\%pingangit\fP) TypeError: save_minions() got an unexpected keyword argument \(aqsyndic_id\(aq (refs: \fI\%#37527\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37527\fP: (\fI\%rallytime\fP) Add syndic_id=None kwarg to save_minions funcs in returners
@ \fI2016\-11\-07 23:04:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
fefdfab850 Merge pull request \fI\%#37527\fP from rallytime/fix\-35016
.IP \(bu 2
2944b244aa Add syndic_id=None kwarg to save_minions funcs in returners
.IP \(bu 2
\fBPR\fP \fI\%#37530\fP: (\fI\%gtmanfred\fP) fix Lithium to 2015.5.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37514\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-11\-07 16:51:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
743164844d Merge pull request \fI\%#37514\fP from rallytime/merge\-2016.3
.IP \(bu 2
41166aede4 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
c505a059ef [2015.8] Doc version updated to 2016.3.4 (\fI\%#37482\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36713\fP: (\fI\%Tanoti\fP) ExtraData: unpack(b) received extra data after upgrading to 2016.3.3 (refs: \fI\%#37503\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37503\fP: (\fI\%cachedout\fP) Catch loader error on returners without save_load
@ \fI2016\-11\-07 09:33:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d924d0820 Merge pull request \fI\%#37503\fP from cachedout/issue_36713
.IP \(bu 2
5f7f971b2c Catch loader error on returners without save_load
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37448\fP: (\fI\%alisson276\fP) In \(aqsalt/key\(aq events there are acts that never happen (refs: \fI\%#37499\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37499\fP: (\fI\%cachedout\fP) Clarify docs on salt\-key events
@ \fI2016\-11\-07 09:33:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
d95bf59f97 Merge pull request \fI\%#37499\fP from cachedout/key_docs_clarify
.IP \(bu 2
2758e74785 Clarify docs on salt\-key events
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37500\fP: (\fI\%cachedout\fP) Remove unused flag
@ \fI2016\-11\-07 09:33:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
1dd1408ae6 Merge pull request \fI\%#37500\fP from cachedout/remove_include_errors
.IP \(bu 2
6c705b11e0 Remove unused flag
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37444\fP: (\fI\%Tanoti\fP) Returning False from __virtual__ in a returner does not return expected error (refs: #\(gasaltstack/salt\(ga#37502\(ga_\(ga_, \fI\%#37519\fP, \fI\%#37502\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37502\fP: (\fI\%cachedout\fP) Log proper message on returners that cannot be loaded
@ \fI2016\-11\-07 09:32:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
4b6f1ab1c4 Merge pull request \fI\%#37502\fP from cachedout/issue_37444
.IP \(bu 2
4c5ab057ce Remove debugging
.IP \(bu 2
17d01e4f4c Log proper message on returners that cannot be loaded
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37389\fP: (\fI\%d101nelson\fP) Some core grains are inaccurate or incomplete for Solaris (refs: \fI\%#37472\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37494\fP: (\fI\%sjorge\fP) Forgot to update os_family map in \fI\%#37472\fP
@ \fI2016\-11\-06 22:18:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37472\fP: (\fI\%sjorge\fP) 2016.3 solaris grains improvements (refs: \fI\%#37494\fP)
.IP \(bu 2
2422dafd52 Merge pull request \fI\%#37494\fP from sjorge/2016.3\-osfam_map
.IP \(bu 2
96ba545492 Forgot to update os_family map in \fI\%#37472\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37496\fP: (\fI\%mcalmer\fP) fix status handling in sysv init scripts
@ \fI2016\-11\-06 22:18:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
41bd8e3f52 Merge pull request \fI\%#37496\fP from mcalmer/fix\-status\-handling\-in\-sysv\-init\-scripts
.IP \(bu 2
1fb2c4dfcf fix status handling in sysv init scripts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37497\fP: (\fI\%terminalmage\fP) Update 2016.3.5 release notes with source_hash_name explanation
@ \fI2016\-11\-06 22:17:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
e741a773a5 Merge pull request \fI\%#37497\fP from terminalmage/release_notes
.IP \(bu 2
c08038d9ea Update 2016.3.5 release notes with source_hash_name explanation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37486\fP: (\fI\%twangboy\fP) Add requirement for PowerShell 3 on Windows
@ \fI2016\-11\-06 06:01:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
f4426c2233 Merge pull request \fI\%#37486\fP from twangboy/fix_win_docs
.IP \(bu 2
9e0631a1ae Add docs denoting the requirement for at least PowerShell 3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37493\fP: (\fI\%cachedout\fP) Add sdb support to minion and master configs
@ \fI2016\-11\-06 06:00:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
a1f355a569 Merge pull request \fI\%#37493\fP from cachedout/minion_master_sdb
.IP \(bu 2
9761a462c2 Add sdb support to minion and master configs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31135\fP: (\fI\%jeffreyctang\fP) file.line   mode=replace breaks on empty file. (refs: \fI\%#37452\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37452\fP: (\fI\%rallytime\fP) file.line with mode=replace on an empty file should return False, not stacktrace
@ \fI2016\-11\-06 01:55:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
be93710fee Merge pull request \fI\%#37452\fP from rallytime/fix\-31135
.IP \(bu 2
c792f76d2f Bump log level from debug to warning on empty file
.IP \(bu 2
5f181cf00d file.line with mode=replace on an empty file should return False
.IP \(bu 2
94a00c66eb Write a unit test demonstrating stack trace in \fI\%#31135\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37001\fP: (\fI\%phil123456\fP) URGENT : archive.extracted does not work anymore (refs: \fI\%#37081\fP, #saltstack/salt\(ga#37081\(ga_)
.IP \(bu 2
\fBISSUE\fP \fI\%#29010\fP: (\fI\%The\-Loeki\fP) file.managed download failing checksum testing for Ubuntu initrd w/source_hash (refs: \fI\%#37469\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#37081\fP: (\fI\%terminalmage\fP) Fix archive.extracted remote source_hash verification (refs: \fI\%#37469\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37469\fP: (\fI\%terminalmage\fP) Rewrite file.extract_hash to improve its matching ability
@ \fI2016\-11\-06 01:50:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37081\fP: (\fI\%terminalmage\fP) Fix archive.extracted remote source_hash verification (refs: \fI\%#37469\fP)
.IP \(bu 2
129b0387e6 Merge pull request \fI\%#37469\fP from terminalmage/issue29010
.IP \(bu 2
a3f38e5a9f Update file.extract_hash unit tests
.IP \(bu 2
b26b528f79 Add the source_hash_name param to file.managed states
.IP \(bu 2
52fe72d402 Rewrite file.extract_hash
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37389\fP: (\fI\%d101nelson\fP) Some core grains are inaccurate or incomplete for Solaris (refs: \fI\%#37472\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37472\fP: (\fI\%sjorge\fP) 2016.3 solaris grains improvements (refs: \fI\%#37494\fP)
@ \fI2016\-11\-06 01:46:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
9426b9d5c4 Merge pull request \fI\%#37472\fP from sjorge/2016.3\-solaris\-grains
.IP \(bu 2
2958f5ce52 detect and properly handle OmniOS
.IP \(bu 2
37c3a7f5ab handle Oracle Solaris better
.IP \(bu 2
69706d32be parse minorrelease if it has a / in it
.IP \(bu 2
d1cf4a0e56 improve regex for parsing /etc/release using files from Solaris 8 SPARC and Solaris 10
.IP \(bu 2
88eddef765 some more cleanup for smartos
.IP \(bu 2
d3ff39f09c improve smartos os version grains
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37478\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-11\-04 20:30:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ba63aba48 Merge pull request \fI\%#37478\fP from rallytime/merge\-2016.3
.IP \(bu 2
3483a445f2 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
35888c2e30 Merge pull request \fI\%#37408\fP from terminalmage/issue37286
.INDENT 2.0
.IP \(bu 2
4e4a05731e Strip slashes from gitfs mountpoints
.UNINDENT
.IP \(bu 2
b6c57c6c8d Merge pull request \fI\%#37418\fP from terminalmage/issue36849
.INDENT 2.0
.IP \(bu 2
740bc54239 Do not use compression in tornado httpclient requests
.UNINDENT
.IP \(bu 2
7fba8aaa7e Merge pull request \fI\%#37441\fP from rallytime/bp\-37428
.INDENT 2.0
.IP \(bu 2
6fe3ef49de Fix incorrect reference of __utils__ in salt.utils
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37485\fP: (\fI\%rallytime\fP) Get release notes started for 2016.3.5
.IP \(bu 2
\fBPR\fP \fI\%#37483\fP: (\fI\%rallytime\fP) [2016.3] Doc version updated to 2016.3.4
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37123\fP: (\fI\%nevins\-b\fP) file.recurse state doesn\(aqt support pulling from other environments (refs: \fI\%#37121\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37121\fP: (\fI\%nevins\-b\fP) allow the file.recurse state to support saltenv
@ \fI2016\-11\-04 05:59:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
580eca709b Merge pull request \fI\%#37121\fP from nevins\-b/2016.3
.IP \(bu 2
99d2c360ed making messaging in tests match new return
.IP \(bu 2
bc4b0e7cda adding test for saltenv in file.recurse source url
.IP \(bu 2
3315b67075 fixing saltenv if not set in url
.IP \(bu 2
a9683cbbd8 allow the file.recurse state to support saltenv (salt://example/dir?saltenv=dev)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37426\fP: (\fI\%jfindlay\fP) Wait for macOS to change system settings
@ \fI2016\-11\-04 04:35:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37351\fP: (\fI\%jfindlay\fP) modules.mac_power: give macOS time to change setting (refs: \fI\%#37426\fP)
.IP \(bu 2
766b1437c2 Merge pull request \fI\%#37426\fP from jfindlay/mac_sleep
.IP \(bu 2
43a8e199bf modules.mac_power: wait for system to make change
.IP \(bu 2
feabca6e0b modules.mac_system: wait for system to make change
.IP \(bu 2
0213eb9a07 utils.mac_utils: add confirm_updated
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37238\fP: (\fI\%cmclaughlin\fP) Restarting master causes minion to hang (refs: \fI\%#37438\fP, \fI\%#37602\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#37018\fP: (\fI\%tsaridas\fP) get events from python (refs: \fI\%#37438\fP, \fI\%#37602\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37438\fP: (\fI\%DmitryKuzmenko\fP) Fix for \fI\%#37238\fP salt hang on master restart (refs: \fI\%#37602\fP)
@ \fI2016\-11\-04 04:10:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
9eab5c8f71 Merge pull request \fI\%#37438\fP from DSRCorporation/bugs/37238_salt_hang_on_master_restart
.IP \(bu 2
f253d3ce4a Auto reconnect \fIsalt\fP to master if the connection was lost.
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#31207\fP: (\fI\%thusoy\fP) Remove error logging of missing boto libraries (refs: \fI\%#37440\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37440\fP: (\fI\%rallytime\fP) Back\-port \fI\%#31207\fP to 2016.3
@ \fI2016\-11\-04 04:09:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31207\fP: (\fI\%thusoy\fP) Remove error logging of missing boto libraries (refs: \fI\%#37440\fP)
.IP \(bu 2
9aa7073f70 Merge pull request \fI\%#37440\fP from rallytime/bp\-31207
.IP \(bu 2
c71ae61271 Remove error logging of missing boto libraries
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37442\fP: (\fI\%twangboy\fP) Create paths.d directory
@ \fI2016\-11\-04 04:07:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
edbfadca21 Merge pull request \fI\%#37442\fP from twangboy/fix_osx_postinstall
.IP \(bu 2
8091a3065e Create paths.d directory
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37445\fP: (\fI\%twangboy\fP) Check for Server os before checking [DO NOT MERGE FORWARD]
@ \fI2016\-11\-04 04:04:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
afb1b3cee5 Merge pull request \fI\%#37445\fP from twangboy/fix_import_error_2016.3
.IP \(bu 2
c0d5ebdd8a Check for Server os before checking
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37446\fP: (\fI\%twangboy\fP) Detect VC++ for Python on Win32
@ \fI2016\-11\-04 04:04:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
7a9f95ab3b Merge pull request \fI\%#37446\fP from twangboy/fix_build_32
.IP \(bu 2
2de69f48f8 Detect VC for Python correctly on 32bit Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#36961\fP: (\fI\%nullify005\fP) boto_secgroup assumes a string when checking ip_protocol validity when not tcp|udp|all|\-1 (refs: \fI\%#37447\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37447\fP: (\fI\%rallytime\fP) Cast ip_protocol rule as a str() in boto_secgroup.present
@ \fI2016\-11\-04 04:03:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
651e0f728f Merge pull request \fI\%#37447\fP from rallytime/fix\-36961
.IP \(bu 2
6b930ac7aa Cast ip_protocol rule as a str() in boto_secgroup.present
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36446\fP: (\fI\%whiteinge\fP) Custom salt\-api config problem (refs: \fI\%#37455\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#36386\fP: (\fI\%xiaoanyunfei\fP) fix salt\-api\(aqs default opts were covered by salt\-master \fI\%#35734\fP (refs: \fI\%#37455\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37455\fP: (\fI\%techhat\fP) Make api opts respect correct root_dir
@ \fI2016\-11\-04 03:25:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35734\fP: (\fI\%xiaoanyunfei\fP) fix salt\-api\(aqs default opts were covered by salt\-master (refs: #\(gasaltstack/salt#36386\(ga_)
.IP \(bu 2
a51d944c7c Merge pull request \fI\%#37455\fP from techhat/issue36446
.IP \(bu 2
7eff90d61d Make api opts respect correct root_dir
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37459\fP: (\fI\%twangboy\fP) Fix error message when ConvertTo\-Json not supported [DO NOT MERGE FORWARD]
@ \fI2016\-11\-04 03:22:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
3591bf0f58 Merge pull request \fI\%#37459\fP from twangboy/fix_dsc_json_msg_2016.3
.IP \(bu 2
949b70913d Use cmd.run_all instead of cmd.shell
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37430\fP: (\fI\%meaksh\fP) Including resolution parameters in the Zypper debug\-solver call during a dry\-run dist\-upgrade (2016.3)
@ \fI2016\-11\-03 14:35:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37353\fP: (\fI\%meaksh\fP) Including resolution parameters in the Zypper debug\-solver call during a dry\-run dist\-upgrade (refs: \fI\%#37430\fP)
.IP \(bu 2
80a99c4cc5 Merge pull request \fI\%#37430\fP from meaksh/zypper\-dist\-upgrade\-debug\-solver\-fix\-2016.3
.IP \(bu 2
ffc596f215 Including resolver params for Zypper debug\-solver
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37388\fP: (\fI\%tyhunt99\fP) [2016.3.4] Refreshing of an s3 file server results in an exception.  (refs: \fI\%#37428\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37428\fP: (\fI\%cachedout\fP) Fix incorrect reference of __utils__ in salt.utils (refs: \fI\%#37441\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37419\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2016\-11\-02 21:40:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
7864f9b79d Merge pull request \fI\%#37419\fP from rallytime/merge\-2016.3
.IP \(bu 2
bce47c9175 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.INDENT 2.0
.IP \(bu 2
7b1d3b5562 Merge pull request \fI\%#37392\fP from rallytime/bp\-33190
.IP \(bu 2
4063bae5de catch None cases for comments in jboss7 state module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37416\fP: (\fI\%terminalmage\fP) Fix regression in output for Ctrl\-c\(aqed CLI jobs
.IP \(bu 2
\fBPR\fP \fI\%#37414\fP: (\fI\%pass\-by\-value\fP) Add unit tests for cloning from snapshot
.IP \(bu 2
\fBPR\fP \fI\%#37350\fP: (\fI\%pass\-by\-value\fP) Add handling for full and linked clone (refs: \fI\%#37414\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#37401\fP: (\fI\%cachedout\fP) Bootstrap delay option for salt\-cloud (refs: \fI\%#37404\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37404\fP: (\fI\%cachedout\fP) Revert \(dqBootstrap delay option for salt\-cloud\(dq
@ \fI2016\-11\-02 09:48:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
ecd794a233 Merge pull request \fI\%#37404\fP from saltstack/revert\-37401\-bootstrap_delay
.IP \(bu 2
e864de8f03 Revert \(dqBootstrap delay option for salt\-cloud\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37401\fP: (\fI\%cachedout\fP) Bootstrap delay option for salt\-cloud
@ \fI2016\-11\-02 09:02:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
2eb44fbd11 Merge pull request \fI\%#37401\fP from cachedout/bootstrap_delay
.IP \(bu 2
6e42b0e157 Bootstrap delay option for salt\-cloud
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37350\fP: (\fI\%pass\-by\-value\fP) Add handling for full and linked clone (refs: \fI\%#37414\fP)
@ \fI2016\-11\-02 08:02:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
9446e48da0 Merge pull request \fI\%#37350\fP from pass\-by\-value/full_and_linked_clone_v1
.IP \(bu 2
d8b1c9c777 Add handling for full and linked clone and commit disk mode additions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34841\fP: (\fI\%Ch3LL\fP) Wrong return when using \fIuser.chgroups\fP on windows (refs: \fI\%#37386\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37386\fP: (\fI\%rallytime\fP) Fix win_useradd.chgroups return when cmd.run_all retcode != 0
@ \fI2016\-11\-02 06:34:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
c7f4d7f76a Merge pull request \fI\%#37386\fP from rallytime/fix\-34841
.IP \(bu 2
c70492a1fe Fix win_useradd.chgroups return when cmd.run_all retcode != 0
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34263\fP: (\fI\%vernondcole\fP) Use of dnsmasq.set_config injects unintentional text into the configuration file. (refs: \fI\%#37390\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37390\fP: (\fI\%rallytime\fP) Don\(aqt insert __pub* keys into dnsmasq config file with set_config function
@ \fI2016\-11\-02 06:31:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
34b6c6459a Merge pull request \fI\%#37390\fP from rallytime/fix\-34263
.IP \(bu 2
e082ff538b Fix failing test now that we\(aqre raising a CommandExecutionError
.IP \(bu 2
c6a3476abb Filter out the __pub keys passed via **kwargs for dnsmasq.set_config
.IP \(bu 2
fd380c79b9 Add test case to reproduce dnsmasq.set_config failure in \fI\%#34263\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35163\fP: (\fI\%SolarisYan\fP) salt file.mkdir (refs: \fI\%#35287\fP, \fI\%#35189\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37391\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35287\fP to 2016.3
@ \fI2016\-11\-02 06:18:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35287\fP: (\fI\%dere\fP) 2016.3 (refs: \fI\%#37391\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35189\fP: (\fI\%dere\fP) return value for file.mkdir instead of None (refs: \fI\%#35287\fP)
.IP \(bu 2
798b2acbe3 Merge pull request \fI\%#37391\fP from rallytime/bp\-35287
.IP \(bu 2
0e1ebea5a4 Simplify return value to \(dqTrue\(dq.
.IP \(bu 2
13022c5cc4 return value for mkdir instead of None
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37264\fP: (\fI\%junster1\fP) Parsing __grains__ with json.dumps in a module is returning an empty dict in 2016.3.3 (refs: \fI\%#37279\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37279\fP: (\fI\%gtmanfred\fP) initialize super class of NamespacedDictWrapper
@ \fI2016\-11\-01 15:12:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a4833b3a1 Merge pull request \fI\%#37279\fP from gtmanfred/2016.3
.IP \(bu 2
597f346d57 initialize super class of NamespacedDictWrapper
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37351\fP: (\fI\%jfindlay\fP) modules.mac_power: give macOS time to change setting (refs: \fI\%#37426\fP)
@ \fI2016\-10\-31 19:15:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
351175931c Merge pull request \fI\%#37351\fP from jfindlay/mac_set
.IP \(bu 2
0c58056d84 modules.mac_power: give macOS time to change setting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#37340\fP: (\fI\%cachedout\fP) SIGILL \-> SIGKILL in process test
@ \fI2016\-10\-31 08:50:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
25c987e33a Merge pull request \fI\%#37340\fP from cachedout/ill_kill_3
.IP \(bu 2
a6b7417fe9 SIGILL \-> SIGKILL in process test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35480\fP: (\fI\%jelenak\fP) 200 processes of salt\-master (2016.3.2) (refs: \fI\%#37306\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37306\fP: (\fI\%DmitryKuzmenko\fP) Don\(aqt use os.wait() on subprocesses managed by \fImultiprocessing\fP\&.
@ \fI2016\-10\-31 06:55:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
7f1654894d Merge pull request \fI\%#37306\fP from DSRCorporation/bugs/35480_master_shutdown_no_process_error
.IP \(bu 2
b6937ebaa8 Don\(aqt use os.wait() on subprocesses managed by \fImultiprocessing\fP\&.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34998\fP: (\fI\%exowaucka\fP) placementgroup parameter for salt\-cloud is undocumented (refs: \fI\%#37314\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37314\fP: (\fI\%rallytime\fP) Document the existence of placementgroup option in ec2 driver
@ \fI2016\-10\-31 06:42:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf8ba97d54 Merge pull request \fI\%#37314\fP from rallytime/fix\-34998
.IP \(bu 2
39459ed30b Document the existence of placementgroup option in ec2 driver
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36148\fP: (\fI\%alex\-zel\fP) Eauth error with openLDAP groups (refs: \fI\%#37219\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37219\fP: (\fI\%alex\-zel\fP) Fix freeipa ldap groups
@ \fI2016\-10\-28 04:33:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
e0baf4b193 Merge pull request \fI\%#37219\fP from alex\-zel/fix\-freeipa\-ldap\-groups
.IP \(bu 2
b5b2e7e097 Remove trailing whitespaces
.IP \(bu 2
32f906b020 Add support for FreeIPA
.UNINDENT
.UNINDENT
.SS Salt 2016.3.6 Release Notes
.sp
Version 2016.3.6 is a bugfix release for \fI\%2016.3.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB119\fP
.IP \(bu 2
Total Issue References: \fB52\fP
.IP \(bu 2
Total PR References: \fB163\fP
.IP \(bu 2
Contributors: \fB43\fP (\fI\%Adaephon\-GH\fP, \fI\%Ch3LL\fP, \fI\%DmitryKuzmenko\fP, \fI\%Foxlik\fP, \fI\%GideonRed\-zz\fP,
\fI\%The\-Loeki\fP, \fI\%UtahDave\fP, \fI\%alexbleotu\fP, \fI\%anlutro\fP, \fI\%bobrik\fP, \fI\%cachedout\fP, \fI\%cro\fP,
\fI\%dincamihai\fP, \fI\%drawsmcgraw\fP, \fI\%fboismenu\fP, \fI\%galet\fP, \fI\%garethgreenaway\fP, \fI\%grep4linux\fP,
\fI\%gtmanfred\fP, \fI\%jacobhammons\fP, \fI\%jfindlay\fP, \fI\%joe\-niland\fP, \fI\%lvg01\fP, \fI\%mbom2004\fP, \fI\%mcalmer\fP,
\fI\%mchugh19\fP, \fI\%meaksh\fP, \fI\%mirceaulinic\fP, \fI\%morganwillcock\fP, \fI\%narendraingale2\fP, \fI\%nasenbaer13\fP,
\fI\%ni3mm4nd\fP, \fI\%rallytime\fP, \fI\%s0undt3ch\fP, \fI\%sergeizv\fP, \fI\%smarsching\fP, \fI\%techhat\fP, \fI\%terminalmage\fP,
\fI\%thatch45\fP, \fI\%twangboy\fP, \fI\%velom\fP, \fI\%vutny\fP, \fI\%yue9944882\fP)
.UNINDENT
.SS Security Fix
.sp
\fBCVE\-2017\-7893\fP Compromised salt\-minions can impersonate the salt\-master.
(Discovery credit: Frank Spierings)
.SS Changelog for v2016.3.5..v2016.3.6
.sp
\fIGenerated at: 2018\-05\-27 13:45:07 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#40232\fP: (\fI\%rallytime\fP) Update release notes for 2016.3.6
@ \fI2017\-03\-22 21:09:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
24c4ae9c21 Merge pull request \fI\%#40232\fP from rallytime/update\-release\-notes
.IP \(bu 2
2ead188b4f Update release notes for 2016.3.6
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39854\fP: (\fI\%Foxlik\fP) quoted space in authorized_keys confuses ssh.py (refs: \fI\%#39855\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39855\fP: (\fI\%Foxlik\fP) Use regular expression instead of split when replacing authorized_keys
@ \fI2017\-03\-22 18:28:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
c59ae9a82c Merge pull request \fI\%#39855\fP from Foxlik/use_regex_to_compare_authorized_keys
.IP \(bu 2
d46845a5b6 Add newline at end of file
.IP \(bu 2
d4a3c8a66a Use regular expression instead of split when replacing authorized_keys
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40221\fP: (\fI\%rallytime\fP) Back\-port \fI\%#39179\fP to 2016.3
@ \fI2017\-03\-22 17:40:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39179\fP: (\fI\%mcalmer\fP) fix error parsing (refs: \fI\%#40221\fP)
.IP \(bu 2
fd10430018 Merge pull request \fI\%#40221\fP from rallytime/bp\-39179
.IP \(bu 2
07dc2de084 fix error parsing
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40203\fP: (\fI\%frogunder\fP) 2016.3.6. Minion don\(aqt connect to older master. (refs: \fI\%#40206\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40206\fP: (\fI\%cro\fP) Leave sign_pub_messages off by default.
@ \fI2017\-03\-22 16:43:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
a27a2cc3bb Merge pull request \fI\%#40206\fP from cro/sign_pub_take2
.IP \(bu 2
01048de83f leave sign_pub_messages off on minion by default.
.IP \(bu 2
a82b005507 Leave sign_pub_messages off by default.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40193\fP: (\fI\%rallytime\fP) Back\-port \fI\%#40117\fP to 2016.3
@ \fI2017\-03\-22 16:42:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40117\fP: (\fI\%narendraingale2\fP) Fix force remove (refs: \fI\%#40193\fP)
.IP \(bu 2
d1abb4cbaa Merge pull request \fI\%#40193\fP from rallytime/bp\-40117
.IP \(bu 2
cf1857904b More optimization.
.IP \(bu 2
5a08266814 Removed debug statemnt
.IP \(bu 2
f557f7c6bb Added fix for issue 39393
.IP \(bu 2
bb62278b73 Reverting changes.
.IP \(bu 2
a9107cde44 Added if condition for broken link.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40196\fP: (\fI\%twangboy\fP) Update dependencies for PyOpenSSL
@ \fI2017\-03\-22 16:40:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
0f1ff4d4a8 Merge pull request \fI\%#40196\fP from twangboy/win_fix_deps
.IP \(bu 2
6761527793 Update dependencies for PyOpenSSL
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40184\fP: (\fI\%terminalmage\fP) Link to minion start reactor example from FAQ.
@ \fI2017\-03\-21 17:33:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
b0501515cb Merge pull request \fI\%#40184\fP from terminalmage/link\-reactor\-example
.IP \(bu 2
a42be82993 Link to minion start reactor example from FAQ.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40182\fP: (\fI\%terminalmage\fP) Add support for \(dqstopped\(dq state to dockerng\(aqs mod_watch
@ \fI2017\-03\-21 15:40:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
d4e6c58526 Merge pull request \fI\%#40182\fP from terminalmage/dockerng\-mod_watch\-stopped
.IP \(bu 2
4629a26fb7 Add support for \(dqstopped\(dq state to dockerng\(aqs mod_watch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40171\fP: (\fI\%Ch3LL\fP) additional PRs/issues for 2016.3.6 release notes
@ \fI2017\-03\-20 22:14:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
a0b4082484 Merge pull request \fI\%#40171\fP from Ch3LL/2016.3.6_release
.IP \(bu 2
9c6d8d892f additional PRs/issues for 2016.3.6 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40120\fP: (\fI\%sergeizv\fP) gce: Exclude GCENodeDriver objects from _expand_node result
@ \fI2017\-03\-20 21:44:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
33ba7821f7 Merge pull request \fI\%#40120\fP from sergeizv/gce\-expand\-node\-fix
.IP \(bu 2
9d0fbe7e01 gce: Exclude GCENodeDriver objects from _expand_node result
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40122\fP: (\fI\%meaksh\fP) Adding \(dqpkg.install downloadonly=True\(dq support to yum/dnf execution module
@ \fI2017\-03\-20 21:44:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
48843977c3 Merge pull request \fI\%#40122\fP from meaksh/2016.3\-yum\-downloadonly\-support
.IP \(bu 2
067f3f77c2 Adding downloadonly support to yum/dnf module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40159\fP: (\fI\%cro\fP) Turn on sign_pub_messages by default.
@ \fI2017\-03\-20 21:00:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
60e1d4e2f3 Merge pull request \fI\%#40159\fP from cro/sign_pub
.IP \(bu 2
e663b761fb Fix small syntax error
.IP \(bu 2
0a0f46fb14 Turn on sign_pub_messages by default.  Make sure messages with no \(aqsig\(aq are dropped with error when sign_pub_messages is True.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40123\fP: (\fI\%twangboy\fP) Adds support for inet_pton in Windows to network util
@ \fI2017\-03\-20 16:25:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
28e4fc17b6 Merge pull request \fI\%#40123\fP from twangboy/win_fix_network
.IP \(bu 2
06dfd55ef9 Adds support for inet_pton in Windows to network util
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39995\fP: (\fI\%frogunder\fP) Head of Develop \-  Multimaster error (refs: \fI\%#40141\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#39118\fP: (\fI\%bobrik\fP) Minion ipv6 option is not documented (refs: \fI\%#39289\fP, \fI\%#39131\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40141\fP: (\fI\%bobrik\fP) Use the first address if cannot connect to any
@ \fI2017\-03\-20 15:06:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39289\fP: (\fI\%bobrik\fP) Autodetect IPv6 connectivity from minion to master (refs: \fI\%#39766\fP, \fI\%#40141\fP)
.IP \(bu 2
35ddb79f59 Merge pull request \fI\%#40141\fP from bobrik/fallback\-resolve
.IP \(bu 2
af1545deed Use the first address if cannot connect to any
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40059\fP: (\fI\%terminalmage\fP) Fix traceback when virtualenv.managed is invoked with nonexistent user
@ \fI2017\-03\-16 20:46:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
116201f345 Merge pull request \fI\%#40059\fP from terminalmage/fix\-virtualenv\-traceback
.IP \(bu 2
e3cfd29d6b Fix traceback when virtualenv.managed is invoked with nonexistent user
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40090\fP: (\fI\%rallytime\fP) Back\-port \fI\%#40056\fP to 2016.3
@ \fI2017\-03\-16 19:42:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#40056\fP: (\fI\%thatch45\fP) update mention bot blacklist (refs: \fI\%#40090\fP)
.IP \(bu 2
a01b52b9a3 Merge pull request \fI\%#40090\fP from rallytime/bp\-40056
.IP \(bu 2
ae012db87a update mention bot blacklist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40057\fP: (\fI\%cachedout\fP) More mentionbot blacklists
@ \fI2017\-03\-16 18:10:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
d1570bba4c Merge pull request \fI\%#40057\fP from cachedout/ollie_blacklist
.IP \(bu 2
0ac2e83d37 Merge branch \(aq2016.3\(aq into ollie_blacklist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40070\fP: (\fI\%Ch3LL\fP) update 2016.3.6 release notes with additional PR\(aqs
@ \fI2017\-03\-16 15:43:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
d36bdb1a6e Merge pull request \fI\%#40070\fP from Ch3LL/2016.3.6_release
.IP \(bu 2
a1f8b49bd1 update 2016.3.6 release notes with additional PR\(aqs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40018\fP: (\fI\%meaksh\fP) Allows overriding \(aqtimeout\(aq and \(aqgather_job_timeout\(aq to \(aqmanage.up\(aq runner call
@ \fI2017\-03\-15 19:43:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
8dcffc7751 Merge pull request \fI\%#40018\fP from meaksh/2016.3\-handling\-timeouts\-for\-manage.up\-runner
.IP \(bu 2
9f5c3b7dcd Allows one to set custom timeouts for \(aqmanage.up\(aq and \(aqmanage.status\(aq
.IP \(bu 2
2102d9c75c Allows one to set \(aqtimeout\(aq and \(aqgather_job_timeout\(aq via kwargs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40038\fP: (\fI\%velom\fP) correctly parse \(dqpkg_name===version\(dq from pip freeze
@ \fI2017\-03\-15 19:30:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
22fc5299a2 Merge pull request \fI\%#40038\fP from velom/fix\-pip\-freeze\-parsing
.IP \(bu 2
3fae91d879 correctly parse \(dqpkg_name===version\(dq from pip freeze
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40036\fP: (\fI\%oogali\fP) UnboundLocalError: local variable \(aqifcfg\(aq referenced before assignment (refs: \fI\%#40053\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40053\fP: (\fI\%gtmanfred\fP) Update rh_ip.py
@ \fI2017\-03\-15 18:57:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
3584f935fa Merge pull request \fI\%#40053\fP from saltstack/rh_ip_patch
.IP \(bu 2
219947acdb Update rh_ip.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40011\fP: (\fI\%tsaridas\fP) salt\-minion does not shutdown properly 2016.11.3 rh6 (refs: \fI\%#40041\fP)
.IP \(bu 2
\fBPR\fP \fI\%#40041\fP: (\fI\%terminalmage\fP) Fix transposed lines in salt.utils.process
@ \fI2017\-03\-15 17:58:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
837432d3d2 Merge pull request \fI\%#40041\fP from terminalmage/issue40011
.IP \(bu 2
5b5d1b375c Fix transposed lines in salt.utils.process
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40021\fP: (\fI\%Ch3LL\fP) 2016.3.6 release notes with change log
@ \fI2017\-03\-14 21:06:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
ee7f3b1200 Merge pull request \fI\%#40021\fP from Ch3LL/2016.3.6_release
.IP \(bu 2
f3e7e4fb2a Add 2016.3.6 Release Notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#40016\fP: (\fI\%terminalmage\fP) Attempt to fix failing grains tests in 2016.3
@ \fI2017\-03\-14 18:34:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
26895b7be2 Merge pull request \fI\%#40016\fP from terminalmage/fix\-grains\-test
.IP \(bu 2
0ec81a4cde Fixup a syntax error
.IP \(bu 2
5d84b40bfd Attempt to fix failing grains tests in 2016.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39980\fP: (\fI\%vutny\fP) [2016.3] Allow using \fIbg\fP kwarg for \fIcmd.run\fP state function
@ \fI2017\-03\-14 17:16:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
0c61d064ad Merge pull request \fI\%#39980\fP from vutny/cmd\-run\-state\-bg
.IP \(bu 2
a81dc9dfc1 [2016.3] Allow using \fIbg\fP kwarg for \fIcmd.run\fP state function
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39942\fP: (\fI\%Foxlik\fP) Web Documentation not in sync with release 2016.11.3 (refs: \fI\%#39994\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39994\fP: (\fI\%rallytime\fP) Add a versionadded tag for dockerng ulimits addition
@ \fI2017\-03\-13 20:58:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
b042484455 Merge pull request \fI\%#39994\fP from rallytime/ulimits\-dockerng\-version
.IP \(bu 2
37bd800fac Add a versionadded tag for dockerng ulimits addition
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39988\fP: (\fI\%terminalmage\fP) Add comment explaining change from \fI\%#39973\fP
@ \fI2017\-03\-13 18:37:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39973\fP: (\fI\%terminalmage\fP) Don\(aqt use docker.Client instance from context if missing attributes (refs: \fI\%#39988\fP)
.IP \(bu 2
e125c94ba5 Merge pull request \fI\%#39988\fP from terminalmage/dockerng\-timeout
.IP \(bu 2
bd2519ed1b Add comment explaining change from \fI\%#39973\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39973\fP: (\fI\%terminalmage\fP) Don\(aqt use docker.Client instance from context if missing attributes (refs: \fI\%#39988\fP)
@ \fI2017\-03\-11 14:57:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
cd0336e868 Merge pull request \fI\%#39973\fP from terminalmage/dockerng\-timeout
.IP \(bu 2
869416e7db Don\(aqt use docker.Client instance from context if missing attributes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39962\fP: (\fI\%cachedout\fP) Disable mention bot delay on 2016.3
@ \fI2017\-03\-10 20:24:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
282c607d26 Merge pull request \fI\%#39962\fP from cachedout/disable_mentionbot_delay_3
.IP \(bu 2
7a638f204b Disable mention bot delay on 2016.3
.INDENT 2.0
.IP \(bu 2
5592c680b5 More mentionbot blacklists
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39937\fP: (\fI\%cachedout\fP) Fix \-\-non\-gpg\-checks in zypper module
@ \fI2017\-03\-10 18:02:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
1e0c88ae08 Merge pull request \fI\%#39937\fP from cachedout/gpg_zypper
.IP \(bu 2
13ed0d1209 Fix \-\-non\-gpg\-checks in zypper module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39929\fP: (\fI\%terminalmage\fP) Scrap event\-based approach for refreshing grains (2016.3 branch)
@ \fI2017\-03\-09 22:03:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
4526fc6e08 Merge pull request \fI\%#39929\fP from terminalmage/pr\-39770\-2016.3
.IP \(bu 2
cf0100dabe Scrap event\-based approach for refreshing grains
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22080\fP: (\fI\%The\-Loeki\fP) CIDR matching for IPv6 / improve IPv6 support in utils.network (refs: \fI\%#39919\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39919\fP: (\fI\%The\-Loeki\fP) CIDR matching supports IPv6, update docs
@ \fI2017\-03\-09 16:03:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
111110caf8 Merge pull request \fI\%#39919\fP from The\-Loeki/patch\-1
.IP \(bu 2
170cbadc54 CIDR matching supports IPv6, update docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39899\fP: (\fI\%techhat\fP) Update cleanup function for azure
@ \fI2017\-03\-08 23:28:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
caf10e9988 Merge pull request \fI\%#39899\fP from techhat/cleanupdisks
.IP \(bu 2
baf4579e63 Update cleanup function for azure
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39871\fP: (\fI\%terminalmage\fP) Squelch warning for pygit2 import
@ \fI2017\-03\-07 20:40:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
fcf95f3654 Merge pull request \fI\%#39871\fP from terminalmage/squelch\-import\-warning
.IP \(bu 2
2b2ec69d04 Squelch warning for pygit2 import
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39794\fP: (\fI\%cachedout\fP) Clean up errors which might be thrown when the monitor socket shuts down
@ \fI2017\-03\-04 16:12:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
f223fa8906 Merge pull request \fI\%#39794\fP from cachedout/clean_monitor_socket_shutdown
.IP \(bu 2
2e683e788b Clean up errors which might be thrown when the monitor socket shuts down
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39819\fP: (\fI\%terminalmage\fP) Improve the Top File matching docs
@ \fI2017\-03\-04 16:06:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
4002dc1947 Merge pull request \fI\%#39819\fP from terminalmage/top\-file\-matching\-docs
.IP \(bu 2
7178e77eee Improve the Top File matching docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39820\fP: (\fI\%ni3mm4nd\fP) Add missing apostrophe in Beacons topic documentation
@ \fI2017\-03\-04 16:05:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
c08aaeb7fd Merge pull request \fI\%#39820\fP from ni3mm4nd/beacons_topic_doc_typo
.IP \(bu 2
804b12048c Add missing apostrophe
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39826\fP: (\fI\%cachedout\fP) Add group func to yubikey auth
@ \fI2017\-03\-04 16:02:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
cbd2a4e3cc Merge pull request \fI\%#39826\fP from cachedout/yubikey_fix
.IP \(bu 2
6125eff02d Add group func to yubikey auth
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39622\fP: (\fI\%drawsmcgraw\fP) boto_vpc.create_subnet does not properly assign tags (refs: \fI\%#39624\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39624\fP: (\fI\%drawsmcgraw\fP) Address issue 39622
@ \fI2017\-03\-03 15:59:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
f575ef459f Merge pull request \fI\%#39624\fP from drawsmcgraw/39622
.IP \(bu 2
13da50be33 Fix indention lint errors
.IP \(bu 2
545026352f Address issue 39622
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39119\fP: (\fI\%frogunder\fP) Head of 2016.3 \- Salt\-Master uses 90 seconds to restart (refs: \fI\%#39796\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39796\fP: (\fI\%cachedout\fP) Stop the process manager when it no longer has processes to manage
@ \fI2017\-03\-02 23:03:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f3619c1e5 Merge pull request \fI\%#39796\fP from cachedout/master_shutdown
.IP \(bu 2
e31d46c1b8 Stop the process manager when it no longer has processes to manage
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39333\fP: (\fI\%jagguli\fP) Not Available error \- Scheduling custom runner functions  (refs: \fI\%#39791\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38514\fP: (\fI\%githubcdr\fP) Unable to schedule runners (refs: \fI\%#39791\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39791\fP: (\fI\%gtmanfred\fP) load runners if role is master
@ \fI2017\-03\-02 19:43:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
53341cf152 Merge pull request \fI\%#39791\fP from gtmanfred/2016.3
.IP \(bu 2
3ab4f843bf load runners if role is master
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39782\fP: (\fI\%sergeizv\fP) salt\-cloud show_instance action fails on EC2 instances (refs: \fI\%#39784\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33162\fP: (\fI\%jfindlay\fP) Key error with salt.utils.cloud.cache_node and EC2 (refs: \fI\%#39784\fP, \fI\%#33164\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39784\fP: (\fI\%sergeizv\fP) Fix 39782
@ \fI2017\-03\-02 16:08:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33164\fP: (\fI\%jfindlay\fP) cloud.clouds.ec2: cache each named node (refs: \fI\%#39784\fP)
.IP \(bu 2
c234c25092 Merge pull request \fI\%#39784\fP from sergeizv/fix\-39782
.IP \(bu 2
b71c3fe13c Revert \(dqcloud.clouds.ec2: cache each named node (\fI\%#33164\fP)\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39336\fP: (\fI\%GevatterGaul\fP) salt\-minion fails with IPv6 (refs: \fI\%#39766\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#39118\fP: (\fI\%bobrik\fP) Minion ipv6 option is not documented (refs: \fI\%#39289\fP, \fI\%#39131\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39766\fP: (\fI\%rallytime\fP) Restore ipv6 connectivity and \(dqmaster: <ip>:<port>\(dq support
@ \fI2017\-03\-02 02:55:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39289\fP: (\fI\%bobrik\fP) Autodetect IPv6 connectivity from minion to master (refs: \fI\%#39766\fP, \fI\%#40141\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25021\fP: (\fI\%GideonRed\-zz\fP) Introduce ip:port minion config (refs: \fI\%#39766\fP)
.IP \(bu 2
4ee59be22c Merge pull request \fI\%#39766\fP from rallytime/fix\-ipv6\-connection
.IP \(bu 2
65b239664e Restore ipv6 connectivity and \(dqmaster: <ip>:<port>\(dq support
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33187\fP: (\fI\%usbportnoy\fP) Deploy to jboss TypeError at boss7.py:469 (refs: \fI\%#39761\fP, \fI\%#39170\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39761\fP: (\fI\%cachedout\fP) Properly display error in jboss7 state
@ \fI2017\-03\-01 18:43:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
a24da31131 Merge pull request \fI\%#39761\fP from cachedout/issue_33187
.IP \(bu 2
c2df29edb2 Properly display error in jboss7 state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39728\fP: (\fI\%rallytime\fP) [2016.3] Bump latest release version to 2016.11.3
@ \fI2017\-02\-28 18:07:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
0888bc32ef Merge pull request \fI\%#39728\fP from rallytime/update\-release\-ver\-2016.3
.IP \(bu 2
c9bc8af8f2 [2016.3] Bump latest release version to 2016.11.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39619\fP: (\fI\%terminalmage\fP) Add a function to simply refresh the grains
@ \fI2017\-02\-28 00:20:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
b52dbeec68 Merge pull request \fI\%#39619\fP from terminalmage/zd1207
.IP \(bu 2
c7dfb494a6 Fix mocking for grains refresh
.IP \(bu 2
7e0ced3b45 Properly hand proxy minions
.IP \(bu 2
692c456da3 Add a function to simply refresh the grains
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39482\fP: (\fI\%bobrik\fP) file.managed and file mode don\(aqt mention default mode (refs: \fI\%#39487\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39487\fP: (\fI\%bobrik\fP) Document default permission modes for file module
@ \fI2017\-02\-24 23:49:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
3f8b5e6733 Merge pull request \fI\%#39487\fP from bobrik/mode\-docs
.IP \(bu 2
41ef69b3ca Document default permission modes for file module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39169\fP: (\fI\%blueyed\fP) Using batch\-mode with \fIsalt.state\fP in orchestration runner considers all minions to have failed (refs: \fI\%#39641\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39641\fP: (\fI\%smarsching\fP) Return runner return code in a way compatible with check_state_result
@ \fI2017\-02\-24 23:07:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
f7389bf1f5 Merge pull request \fI\%#39641\fP from smarsching/issue\-39169\-2016.3
.IP \(bu 2
88c2d9a540 Fix return data structure for runner (issue \fI\%#39169\fP).
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39633\fP: (\fI\%terminalmage\fP) Fix misspelled argument in salt.modules.systemd.disable()
@ \fI2017\-02\-24 18:21:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc970b6a16 Merge pull request \fI\%#39633\fP from terminalmage/fix\-systemd\-typo
.IP \(bu 2
ca54541abe Add missing unit test for disable func
.IP \(bu 2
17109e1522 Fix misspelled argument in salt.modules.systemd.disable()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39613\fP: (\fI\%terminalmage\fP) Fix inaccurate documentation
@ \fI2017\-02\-24 06:07:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
53e78d67f6 Merge pull request \fI\%#39613\fP from terminalmage/fix\-docs
.IP \(bu 2
9342eda377 Fix inaccurate documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39600\fP: (\fI\%vutny\fP) state.file: drop non\-relevant examples for \fIsource_hash\fP parameter
@ \fI2017\-02\-23 16:55:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
4e2b852f83 Merge pull request \fI\%#39600\fP from vutny/state\-file\-docs
.IP \(bu 2
9b0427c27a state.file: drop non\-relevant examples for \fIsource_hash\fP parameter
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39584\fP: (\fI\%cachedout\fP) A note in the docs about mentionbot
@ \fI2017\-02\-23 15:12:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
ed83420417 Merge pull request \fI\%#39584\fP from cachedout/mentionbot_docs
.IP \(bu 2
652044b18f A note in the docs about mentionbot
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39583\fP: (\fI\%cachedout\fP) Add empty blacklist to mention bot
@ \fI2017\-02\-23 02:22:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
d3e50b4f2f Merge pull request \fI\%#39583\fP from cachedout/mentionbot_blacklist
.IP \(bu 2
62491c900d Add empty blacklist to mention bot
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39579\fP: (\fI\%rallytime\fP) [2016.3] Pylint: Remove unused import
@ \fI2017\-02\-22 23:46:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
8352e6b44b Merge pull request \fI\%#39579\fP from rallytime/fix\-lint
.IP \(bu 2
65889e1f30 [2016.3] Pylint: Remove unused import
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39578\fP: (\fI\%cachedout\fP) Add mention\-bot configuration
@ \fI2017\-02\-22 23:39:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
43dba3254c Merge pull request \fI\%#39578\fP from cachedout/2016.3
.IP \(bu 2
344499eef7 Add mention\-bot configuration
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39542\fP: (\fI\%twangboy\fP) Gate ssh_known_hosts state against Windows
@ \fI2017\-02\-22 20:16:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
8f7a0f9d96 Merge pull request \fI\%#39542\fP from twangboy/gate_ssh_known_hosts
.IP \(bu 2
c90a52ef27 Remove expensive check
.IP \(bu 2
6d645cae0e Add __virtual__ function
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39118\fP: (\fI\%bobrik\fP) Minion ipv6 option is not documented (refs: \fI\%#39289\fP, \fI\%#39131\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39289\fP: (\fI\%bobrik\fP) Autodetect IPv6 connectivity from minion to master (refs: \fI\%#39766\fP, \fI\%#40141\fP)
@ \fI2017\-02\-22 19:05:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
c10965833a Merge pull request \fI\%#39289\fP from bobrik/autodetect\-ipv6
.IP \(bu 2
2761a1b244 Move new kwargs to the end of argument list
.IP \(bu 2
0df6b922e7 Narrow down connection exception to socket.error
.IP \(bu 2
e8a2cc0488 Do no try to connect to salt master in syndic config test
.IP \(bu 2
af9578631e Properly log address that failed to resolve or pass connection check
.IP \(bu 2
9a34fbeba9 Actually connect to master instead of checking route availability
.IP \(bu 2
c494839c65 Avoid bare exceptions in dns_check
.IP \(bu 2
29f376676d Rewrite dns_check to try to connect to address
.IP \(bu 2
55965ce505 Autodetect IPv6 connectivity from minion to master
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39569\fP: (\fI\%s0undt3ch\fP) Don\(aqt use our own six dictionary fixes in this branch
@ \fI2017\-02\-22 18:59:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
3fb928b63a Merge pull request \fI\%#39569\fP from s0undt3ch/2016.3
.IP \(bu 2
49da135abd Don\(aqt use our own six dictionary fixes in this branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39508\fP: (\fI\%dincamihai\fP) Openscap
@ \fI2017\-02\-22 18:36:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
91e3319df8 Merge pull request \fI\%#39508\fP from dincamihai/openscap
.IP \(bu 2
9fedb84607 Always return oscap\(aqs stderr
.IP \(bu 2
0ecde2cd02 Include oscap returncode in response
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30802\fP: (\fI\%kjelle\fP) Missing ulimits on docker.running / dockerng.running (refs: \fI\%#39562\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39562\fP: (\fI\%terminalmage\fP) Add ulimits to dockerng state/exec module
@ \fI2017\-02\-22 16:31:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
fbe2194a93 Merge pull request \fI\%#39562\fP from terminalmage/issue30802
.IP \(bu 2
c50374041d Add ulimits to dockerng state/exec module
.IP \(bu 2
da42040c1a Try the docker\-py 2.0 client name first
.IP \(bu 2
\fBPR\fP \fI\%#39544\fP: (\fI\%terminalmage\fP) dockerng.get_client_args: Fix path for endpoint config for some versions of docker\-py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39447\fP: (\fI\%Foxlik\fP) dockerng keeps restarting privileged container (refs: \fI\%#39483\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39498\fP: (\fI\%terminalmage\fP) Resubmit PR \fI\%#39483\fP against 2016.3 branch
@ \fI2017\-02\-20 19:35:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39483\fP: (\fI\%Foxlik\fP) dockerng: compare sets instead of lists of security_opt (refs: \fI\%#39498\fP)
.IP \(bu 2
dff35b58f8 Merge pull request \fI\%#39498\fP from terminalmage/pr\-39483
.IP \(bu 2
20b097a745 dockerng: compare sets instead of lists of security_opt
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39497\fP: (\fI\%terminalmage\fP) Two dockerng compatibility fixes
@ \fI2017\-02\-19 17:43:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
6418e725ed Merge pull request \fI\%#39497\fP from terminalmage/docker\-compat\-fixes
.IP \(bu 2
cbd0270bac docker: make docker\-exec the default execution driver
.IP \(bu 2
a6a17d58aa Handle docker\-py 2.0\(aqs new host_config path
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39423\fP: (\fI\%dincamihai\fP) Openscap module
@ \fI2017\-02\-17 18:31:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
9c4292fb4e Merge pull request \fI\%#39423\fP from dincamihai/openscap
.IP \(bu 2
9d13422ac1 OpenSCAP module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39444\fP: (\fI\%clem\-compilatio\fP) salt\-cloud \- IPv6 and IPv4 private_ips  \- preferred_ip sends False to is_public_ip (refs: \fI\%#39464\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39464\fP: (\fI\%gtmanfred\fP) skip false values from preferred_ip
@ \fI2017\-02\-16 22:48:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
7dd2502360 Merge pull request \fI\%#39464\fP from gtmanfred/2016.3
.IP \(bu 2
f829d6f9fc skip false values from preferred_ip
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39460\fP: (\fI\%cachedout\fP) Fix mocks in win_disim tests
@ \fI2017\-02\-16 19:27:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
db359ff2c3 Merge pull request \fI\%#39460\fP from cachedout/win_dism_test_fix
.IP \(bu 2
e652a45592 Fix mocks in win_disim tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39426\fP: (\fI\%morganwillcock\fP) win_dism: Return failure when package path does not exist
@ \fI2017\-02\-16 00:09:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
9dbfba9b57 Merge pull request \fI\%#39426\fP from morganwillcock/dism
.IP \(bu 2
a7d5118262 Return failure when package path does not exist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39431\fP: (\fI\%UtahDave\fP) Fix grains.setval performance
@ \fI2017\-02\-15 23:56:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
56162706e3 Merge pull request \fI\%#39431\fP from UtahDave/fix_grains.setval_performance
.IP \(bu 2
391bbecd90 add docs
.IP \(bu 2
709c197f84 allow sync_grains to be disabled on grains.setval
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39304\fP: (\fI\%Auha\fP) boto_s3_bucket documentation dependency clarification (refs: \fI\%#39405\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39405\fP: (\fI\%rallytime\fP) Update :depends: docs for boto states and modules
@ \fI2017\-02\-15 17:32:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
239e16e612 Merge pull request \fI\%#39405\fP from rallytime/fix\-39304
.IP \(bu 2
bd1fe03ce7 Update :depends: docs for boto states and modules
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38762\fP: (\fI\%oz123\fP) Configuration information for custom returners (refs: \fI\%#39411\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39411\fP: (\fI\%rallytime\fP) Update external_cache docs with other configuration options
@ \fI2017\-02\-15 17:30:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
415102f346 Merge pull request \fI\%#39411\fP from rallytime/fix\-38762
.IP \(bu 2
e13febe58d Update external_cache docs with other configuration options
.IP \(bu 2
\fBPR\fP \fI\%#39421\fP: (\fI\%terminalmage\fP) Update docs on upstream EPEL7 pygit2/libgit2 issues
.IP \(bu 2
\fBPR\fP \fI\%#39409\fP: (\fI\%terminalmage\fP) salt.fileserver.roots: Fix regression in symlink_list
.IP \(bu 2
\fBPR\fP \fI\%#39337\fP: (\fI\%terminalmage\fP) Don\(aqt re\-walk the roots fileserver in symlink_list() (refs: \fI\%#39409\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39362\fP: (\fI\%dincamihai\fP) Add cp.push test
@ \fI2017\-02\-14 18:42:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
8b8ab8ef8e Merge pull request \fI\%#39362\fP from dincamihai/cp\-push\-test\-2016.3
.IP \(bu 2
91383c5a19 Add cp.push test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39380\fP: (\fI\%joe\-niland\fP) Quote numeric user names so pwd.getpwnam handles them properly
@ \fI2017\-02\-14 18:33:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
4b726f955b Merge pull request \fI\%#39380\fP from joe\-niland/quote\-numeric\-usernames
.IP \(bu 2
c2edfdd464 Quote numeric user names so pwd.getpwnam handles them properly
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39400\fP: (\fI\%meaksh\fP) Prevents \(aqOSError\(aq exception in case certain job cache path doesn\(aqt exist
@ \fI2017\-02\-14 18:27:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
1116d32df9 Merge pull request \fI\%#39400\fP from meaksh/2016.3\-fix\-local\-cache\-issue
.IP \(bu 2
e7e559ef5c Prevents \(aqOSError\(aq exception in case path doesn\(aqt exist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39300\fP: (\fI\%terminalmage\fP) Replace more usage of str.format in the loader
@ \fI2017\-02\-13 19:01:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39227\fP: (\fI\%terminalmage\fP) Loader optimzation (refs: \fI\%#39300\fP)
.IP \(bu 2
6c854da1d4 Merge pull request \fI\%#39300\fP from terminalmage/loader\-optimization
.IP \(bu 2
d3e5d1525e Replace more usage of str.format in the loader
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39337\fP: (\fI\%terminalmage\fP) Don\(aqt re\-walk the roots fileserver in symlink_list() (refs: \fI\%#39409\fP)
@ \fI2017\-02\-13 18:41:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
5286b5ff1b Merge pull request \fI\%#39337\fP from terminalmage/issue34428
.IP \(bu 2
a7d2135dc2 Don\(aqt re\-walk the roots fileserver in symlink_list()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39339\fP: (\fI\%cro\fP) Add link to external pillar documentation for clarification.
@ \fI2017\-02\-13 18:40:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce781deeb5 Merge pull request \fI\%#39339\fP from cro/pillar_filetree_doc
.IP \(bu 2
410810cea2 Clarification on external pillar usage.
.IP \(bu 2
\fBPR\fP \fI\%#39316\fP: (\fI\%terminalmage\fP) Document the upstream RedHat bug with their pygit2 package
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39313\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2017\-02\-10 16:23:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
9de559ff4e Merge pull request \fI\%#39313\fP from rallytime/merge\-2016.3
.IP \(bu 2
0b8dddf12b Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
fc551bcf5d Merge pull request \fI\%#39293\fP from sergeizv/grammar\-fix
.INDENT 2.0
.IP \(bu 2
70f2b586d3 Rewrap paragraph
.IP \(bu 2
e6ab5178ea Grammar fix
.UNINDENT
.IP \(bu 2
8a1b45632a Merge pull request \fI\%#39295\fP from sergeizv/typo\-fix
.INDENT 2.0
.IP \(bu 2
5d9f36d58d Fix typo
.UNINDENT
.IP \(bu 2
cfaafece34 Merge pull request \fI\%#39296\fP from sergeizv/whitespace\-fix
.INDENT 2.0
.IP \(bu 2
1d4c1dc140 Whitespace fix in docs Makefile
.UNINDENT
.IP \(bu 2
0b4dcf4a47 Merge pull request \fI\%#39294\fP from sergeizv/fix\-link
.INDENT 2.0
.IP \(bu 2
04bde6eed2 Fix link in proxyminion guide
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38595\fP: (\fI\%yue9944882\fP) Redis ext job cache occurred error (refs: \fI\%#38610\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39299\fP: (\fI\%rallytime\fP) Back\-port \fI\%#38610\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#38610\fP: (\fI\%yue9944882\fP) Fix \fI\%#38595\fP \- Unexpected error log from redis retuner in master\(aqs log (refs: \fI\%#39299\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39297\fP: (\fI\%cro\fP) Add doc to recommend pgjsonb for master job caches
@ \fI2017\-02\-09 22:49:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
f16027d30e Merge pull request \fI\%#39297\fP from cro/pg_returner_docs
.IP \(bu 2
28bac649ae Typo
.IP \(bu 2
19fedcdd23 Add doc to recommend pgjsonb for master job caches
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39286\fP: (\fI\%terminalmage\fP) Allow minion/CLI saltenv/pillarenv to override master when compiling pillar
@ \fI2017\-02\-09 21:22:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
77e50ed8b7 Merge pull request \fI\%#39286\fP from terminalmage/fix\-pillarenv\-precedence
.IP \(bu 2
3cb9833e57 Allow minion/CLI saltenv/pillarenv to override master when compiling pillar
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39220\fP: (\fI\%lvg01\fP) state file.line skips leading spaces in content with mode:ensure and indent:False (refs: \fI\%#39221\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39221\fP: (\fI\%lvg01\fP) Fix bug 39220
@ \fI2017\-02\-09 18:12:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
52440416ca Merge pull request \fI\%#39221\fP from lvg01/fix\-bug\-39220
.IP \(bu 2
e8a41d6341 Removes to early content stripping (stripping is already done when needed with ident:true), fixes \fI\%#39220\fP
.IP \(bu 2
a4b169e0bd Fixed wrong logic, fixes \fI\%#39220\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36913\fP: (\fI\%terminalmage\fP) Support custom refspecs in GitFS (refs: \fI\%#39210\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39280\fP: (\fI\%terminalmage\fP) Add warning for Dulwich removal
.IP \(bu 2
\fBPR\fP \fI\%#39210\fP: (\fI\%terminalmage\fP) salt.utils.gitfs: remove dulwich support, make refspecs configurable (refs: \fI\%#39280\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39260\fP: (\fI\%terminalmage\fP) Update jsonschema tests to reflect change in jsonschema 2.6.0
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#33536\fP: (\fI\%murzick\fP) pkgrepo.managed does not disable a yum repo with \(dqdisabled: True\(dq (refs: \fI\%#35055\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33536\fP: (\fI\%murzick\fP) pkgrepo.managed does not disable a yum repo with \(dqdisabled: True\(dq (refs: \fI\%#35055\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39251\fP: (\fI\%terminalmage\fP) Better handling of enabled/disabled arguments in pkgrepo.managed
.IP \(bu 2
\fBPR\fP \fI\%#35055\fP: (\fI\%galet\fP) \fI\%#33536\fP pkgrepo.managed does not disable a yum repo with \(dqdisabled: True\(dq (refs: \fI\%#39251\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39227\fP: (\fI\%terminalmage\fP) Loader optimzation (refs: \fI\%#39300\fP)
@ \fI2017\-02\-08 19:38:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
8e88f71dd9 Merge pull request \fI\%#39227\fP from terminalmage/loader\-optimization
.IP \(bu 2
c750662946 Loader optimzation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38856\fP: (\fI\%fhaynes\fP) salt\-cloud throws an exception when ec2 does not return encoding (refs: \fI\%#39228\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39228\fP: (\fI\%gtmanfred\fP) default to utf8 encoding if not specified
@ \fI2017\-02\-08 19:36:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
bc89b297f8 Merge pull request \fI\%#39228\fP from gtmanfred/2016.3
.IP \(bu 2
afee047b08 default to utf8 encoding if not specified
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39231\fP: (\fI\%terminalmage\fP) Add clarification for jenkins execution module
@ \fI2017\-02\-08 19:34:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
d9b0671dbd Merge pull request \fI\%#39231\fP from terminalmage/clarify\-jenkins\-depends
.IP \(bu 2
ad1b1255f2 Add clarification for jenkins execution module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39232\fP: (\fI\%terminalmage\fP) Avoid recursion in s3/svn ext_pillars
@ \fI2017\-02\-08 19:33:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
ddcff89a84 Merge pull request \fI\%#39232\fP from terminalmage/issue21342
.IP \(bu 2
c88896c277 Avoid recursion in s3/svn ext_pillars
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38697\fP: (\fI\%fboismenu\fP) On Windows, ip.get_all_interfaces returns at most 2 DNS/WINS Servers (refs: \fI\%#38793\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39230\fP: (\fI\%rallytime\fP) Fix the win_ip_test failures
.IP \(bu 2
\fBPR\fP \fI\%#38793\fP: (\fI\%fboismenu\fP) Fix for \fI\%#38697\fP (refs: \fI\%#39197\fP, \fI\%#39230\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33187\fP: (\fI\%usbportnoy\fP) Deploy to jboss TypeError at boss7.py:469 (refs: \fI\%#39761\fP, \fI\%#39170\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39199\fP: (\fI\%rallytime\fP) Back\-port \fI\%#39170\fP to 2016.3
@ \fI2017\-02\-07 16:19:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39170\fP: (\fI\%grep4linux\fP) Added missing source_hash_name argument in get_managed function (refs: \fI\%#39199\fP)
.IP \(bu 2
df5f934c34 Merge pull request \fI\%#39199\fP from rallytime/bp\-39170
.IP \(bu 2
c129905310 Added missing source_hash_name argument in get_managed function Additional fix to  \fI\%#33187\fP Customer was still seeing errors, this should now work. Tested with 2015.8.13 and 2016.11.2
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37174\fP: (\fI\%mikeadamz\fP) The State execution failed to record the order in which all states were executed spam while running pkg.upgrade from orchestration runner (refs: \fI\%#39206\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39206\fP: (\fI\%cachedout\fP) Ignore empty dicts in highstate outputter
@ \fI2017\-02\-07 16:11:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
2621c119fd Merge pull request \fI\%#39206\fP from cachedout/issue_issue_37174
.IP \(bu 2
be31e0559c Ignore empty dicts in highstate outputter
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39209\fP: (\fI\%terminalmage\fP) Sort the return list from the fileserver.envs runner
@ \fI2017\-02\-07 16:07:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd440452ea Merge pull request \fI\%#39209\fP from terminalmage/sorted\-envs
.IP \(bu 2
e6dda4a625 Sort the return list from the fileserver.envs runner
.IP \(bu 2
\fBPR\fP \fI\%#39202\fP: (\fI\%rallytime\fP) [2016.3] Pylint fix
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38697\fP: (\fI\%fboismenu\fP) On Windows, ip.get_all_interfaces returns at most 2 DNS/WINS Servers (refs: \fI\%#38793\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39197\fP: (\fI\%cachedout\fP) Pr 38793
@ \fI2017\-02\-06 19:23:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38793\fP: (\fI\%fboismenu\fP) Fix for \fI\%#38697\fP (refs: \fI\%#39197\fP, \fI\%#39230\fP)
.IP \(bu 2
ab76054127 Merge pull request \fI\%#39197\fP from cachedout/pr\-38793
.IP \(bu 2
f3d35fb5c6 Lint fixes
.IP \(bu 2
624f25b78d Fix for \fI\%#38697\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39166\fP: (\fI\%Ch3LL\fP) fix boto ec2 module create_image doc
@ \fI2017\-02\-06 18:27:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
fa45cbc359 Merge pull request \fI\%#39166\fP from Ch3LL/fix_boto_ec2_docs
.IP \(bu 2
90af696331 fix boto ec2 module create_image doc
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39173\fP: (\fI\%rallytime\fP) Restore \(dqSalt Community\(dq doc section
@ \fI2017\-02\-06 18:19:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30770\fP: (\fI\%jacobhammons\fP) Doc restructuring, organization, and cleanup (refs: \fI\%#39173\fP)
.IP \(bu 2
\fBPR\fP \fI\%#10792\fP: (\fI\%cachedout\fP) Documentation overhaul (refs: \fI\%#39173\fP)
.IP \(bu 2
a40cb46249 Merge pull request \fI\%#39173\fP from rallytime/restore\-community\-docs
.IP \(bu 2
5aeddf42a0 Restore \(dqSalt Community\(dq doc section
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38704\fP: (\fI\%nasenbaer13\fP) Archive extracted fails when another state run is queued (refs: \fI\%#38705\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39077\fP: (\fI\%terminalmage\fP) Apply fix from \fI\%#38705\fP to 2016.3 branch
.IP \(bu 2
\fBPR\fP \fI\%#38705\fP: (\fI\%nasenbaer13\fP) Fix for \fI\%#38704\fP archive extracted and dockerio states (refs: \fI\%#39077\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39146\fP: (\fI\%gtmanfred\fP) update vmware getting started doc
.IP \(bu 2
\fBPR\fP \fI\%#39145\fP: (\fI\%garethgreenaway\fP) [2016.3] Fix when targeting via pillar with Salt syndic
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38804\fP: (\fI\%alexbleotu\fP) Second attempt to fix prepending of root_dir to paths
@ \fI2017\-02\-02 16:10:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
cd8077ab81 Merge pull request \fI\%#38804\fP from alexbleotu/root_dir_fix\-2016.3\-gh
.IP \(bu 2
b3bdd3b04a Add missing whiteline
.IP \(bu 2
c7715acd53 Merge pull request \fI\%#3\fP from cro/ab_rootdirfix
.INDENT 2.0
.IP \(bu 2
e8cbafaaf1 When running testsuite, salt.syspaths.ROOT_DIR is often empty.
.UNINDENT
.IP \(bu 2
b12dd44a26 Merge pull request \fI\%#1\fP from cro/ab_rootdirfix
.INDENT 2.0
.IP \(bu 2
bffc537aca Remove extra if statements (rstrip will check for the presence anyway).
.UNINDENT
.IP \(bu 2
97521b3468 Second attempt to fix prepending of root_dir to paths
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#39118\fP: (\fI\%bobrik\fP) Minion ipv6 option is not documented (refs: \fI\%#39289\fP, \fI\%#39131\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#39131\fP: (\fI\%bobrik\fP) Clarify ipv6 option for minion and interface for master, closes \fI\%#39118\fP
.IP \(bu 2
\fBPR\fP \fI\%#39116\fP: (\fI\%terminalmage\fP) Don\(aqt abort pillar.get with merge=True if default is None
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39091\fP: (\fI\%terminalmage\fP) Run test_valid_docs in batches
@ \fI2017\-02\-01 19:09:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
cc9b69b6bc Merge pull request \fI\%#39091\fP from terminalmage/update\-test\-valid\-docs
.IP \(bu 2
d76f0380d0 add debug logging for batch vars
.IP \(bu 2
b4afea2a25 Don\(aqt fail test if data is empty
.IP \(bu 2
b3a5d549c1 Account for trimmed value in \(aqsalt \-d\(aq output
.IP \(bu 2
909916c78e Run test_valid_docs in batches
.IP \(bu 2
\fBPR\fP \fI\%#39081\fP: (\fI\%terminalmage\fP) Move fileclient tests to tests/integration/fileserver/fileclient_test.py
.IP \(bu 2
\fBPR\fP \fI\%#39067\fP: (\fI\%rallytime\fP) Bump openstack deprecation notice to Oxygen
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39047\fP: (\fI\%rallytime\fP) [2016.3] Merge forward from 2015.8 to 2016.3
@ \fI2017\-01\-30 23:48:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
a24af5ac46 Merge pull request \fI\%#39047\fP from rallytime/merge\-2016.3
.IP \(bu 2
b732a1f646 Merge branch \(aq2015.8\(aq into \(aq2016.3\(aq
.IP \(bu 2
56ccae6ff7 Add 2015.8.14 release notes file (\fI\%#39046\fP)
.IP \(bu 2
5943fe65d3 Update 2015.8.13 release notes (\fI\%#39037\fP)
.IP \(bu 2
\fBPR\fP \fI\%#39045\fP: (\fI\%rallytime\fP) Add 2016.3.6 release notes file
.IP \(bu 2
\fBPR\fP \fI\%#39042\fP: (\fI\%rallytime\fP) [2016.3] Update release numbers for doc build
.IP \(bu 2
\fBPR\fP \fI\%#39038\fP: (\fI\%rallytime\fP) Update 2016.3.5 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39028\fP: (\fI\%terminalmage\fP) Clarify delimiter argument
@ \fI2017\-01\-30 18:20:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b09dc4198 Merge pull request \fI\%#39028\fP from terminalmage/clarify\-delimiter\-argument
.IP \(bu 2
f29ef071f3 Clarify delimiter argument
.IP \(bu 2
\fBPR\fP \fI\%#39030\fP: (\fI\%rallytime\fP) Back\-port \fI\%#38972\fP to 2016.3
.IP \(bu 2
\fBPR\fP \fI\%#38972\fP: (\fI\%rallytime\fP) Add CLI Example for rest_sample_utils.get_test_string function (refs: \fI\%#39030\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38753\fP: (\fI\%alexbleotu\fP) \fI__proxy__\fP dunder is not injected when invoking the \fIsalt\fP variable in sls files (refs: \fI\%#38899\fP, \fI\%#38829\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38557\fP: (\fI\%alexbleotu\fP) Proxy not working on develop (refs: \fI\%#38829\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38265\fP: (\fI\%mirceaulinic\fP) \fI__utils__\fP object not available in proxy module (refs: \fI\%#38899\fP, \fI\%#38829\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#32918\fP: (\fI\%mirceaulinic\fP) Proxy minions reconnection (refs: \fI\%#38829\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38899\fP: (\fI\%cro\fP) Enable __proxy__ availability in states, highstate, and utils. Enable __utils__ for proxies.
.IP \(bu 2
\fBPR\fP \fI\%#38829\fP: (\fI\%cro\fP) MANY dunder variable fixes for proxies + proxy keepalive from @mirceaulinic (refs: \fI\%#38899\fP)
.IP \(bu 2
\fBPR\fP \fI\%#37864\fP: (\fI\%mirceaulinic\fP) Proxy keepalive feature (refs: \fI\%#38829\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37938\fP: (\fI\%johje349\fP) Memory leak in Reactor (refs: \fI\%#38951\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33890\fP: (\fI\%hvnsweeting\fP) salt memleak when running state.sls (refs: \fI\%#38951\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38951\fP: (\fI\%DmitryKuzmenko\fP) Keep the only one record per module\-function in depends decorator.
@ \fI2017\-01\-27 17:05:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
da96221741 Merge pull request \fI\%#38951\fP from DSRCorporation/bugs/37938_fix_depends_decorator_memleak
.IP \(bu 2
0b18f34678 Keep the only one record per module\-function in depends decorator.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34780\fP: (\fI\%joehoyle\fP) S3fs broken in 2016.3.1 (refs: \fI\%#38982\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38982\fP: (\fI\%rallytime\fP) Set response when using \(dqGET\(dq method in s3 utils
@ \fI2017\-01\-27 17:04:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
85165edb70 Merge pull request \fI\%#38982\fP from rallytime/fix\-34780
.IP \(bu 2
1583c5579a Set response when using \(dqGET\(dq method in s3 utils
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38989\fP: (\fI\%anlutro\fP) Documentation: fix SLS in environment variable examples
@ \fI2017\-01\-27 17:00:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
cfdbc99e12 Merge pull request \fI\%#38989\fP from alprs/docfix\-state_pt3_environ
.IP \(bu 2
52a9ad1c60 fix SLS in environment variable examples
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#39000\fP: (\fI\%rallytime\fP) Skip the test_badload test until Jenkins move is complete
@ \fI2017\-01\-27 16:58:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
55e4d2572e Merge pull request \fI\%#39000\fP from rallytime/skip\-badload\-test
.IP \(bu 2
4b3ff0fe0f Skip the test_badload test until Jenkins move is complete
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38995\fP: (\fI\%terminalmage\fP) Fix pillar.item docstring
@ \fI2017\-01\-27 16:58:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
fe054eb772 Merge pull request \fI\%#38995\fP from terminalmage/fix\-pillar.item\-docstring
.IP \(bu 2
06d094dd8f Fix pillar.item docstring
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34551\fP: (\fI\%mbom2004\fP) salt.engines.logstash not loading (refs: \fI\%#38950\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38950\fP: (\fI\%mbom2004\fP) Fixed Logstash Engine in file logstash.py
@ \fI2017\-01\-26 19:10:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
b66b6f6423 Merge pull request \fI\%#38950\fP from mbom2004/2016.3
.IP \(bu 2
c09f39d6c9 Remove unused json import
.IP \(bu 2
249efa3068 Fixed Logstash Engine in file logstash.py
.IP \(bu 2
\fBPR\fP \fI\%#38973\fP: (\fI\%rallytime\fP) Handle changing \(dqis_default\(dq value in moto package for boto test mock
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38952\fP: (\fI\%terminalmage\fP) Make the ext_pillars available to pillar.ext tunable
@ \fI2017\-01\-26 19:01:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
b965b5dcc2 Merge pull request \fI\%#38952\fP from terminalmage/zd1168
.IP \(bu 2
6b014e53fc Rename on_demand_pillar to on_demand_ext_pillar
.IP \(bu 2
d216f90c63 Document new on_demand_pillar option and add to config template
.IP \(bu 2
426b20f02f Add documentation for on\-demand pillar to pillar.ext docstring
.IP \(bu 2
7b10274b6b Make on\-demand ext_pillars tunable
.IP \(bu 2
d54723ccae Add on_demand_pillar config option
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35777\fP: (\fI\%rallytime\fP) Properly deprecate template context data in Fluorine (refs: \fI\%#38948\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38948\fP: (\fI\%rallytime\fP) Bump the template context deprecation version to Oxygen
@ \fI2017\-01\-25 19:45:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
2c4ad85a78 Merge pull request \fI\%#38948\fP from rallytime/bump\-template\-context\-deprecation
.IP \(bu 2
749e0031d7 Bump the template context deprecation version to Oxygen
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38946\fP: (\fI\%rallytime\fP) Back\-port \fI\%#37632\fP to 2016.3
@ \fI2017\-01\-25 19:40:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#37632\fP: (\fI\%twangboy\fP) Fix versions report for Windows Server platforms (refs: \fI\%#38946\fP)
.IP \(bu 2
e4514ca7d8 Merge pull request \fI\%#38946\fP from rallytime/bp\-37632
.IP \(bu 2
ee37cdace9 Fix some lint
.IP \(bu 2
c08071e182 Fix versions report for server OSs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38913\fP: (\fI\%Adaephon\-GH\fP) Ignore plist files without Label key
@ \fI2017\-01\-25 19:07:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
953a20350a Merge pull request \fI\%#38913\fP from Adaephon\-GH/patch\-1
.IP \(bu 2
e2f4a16fdd Removing trailing whitespace
.IP \(bu 2
616292c6b1 Ignore plist files without Label key
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38917\fP: (\fI\%twangboy\fP) Update Jinja2 to 2.9.4
@ \fI2017\-01\-25 19:05:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
826dce1059 Merge pull request \fI\%#38917\fP from twangboy/update_jinja_mac
.IP \(bu 2
62e608b627 Update Jinja2 to 2.9.4
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38540\fP: (\fI\%amendlik\fP) API wheel client throws exception and success=true (refs: \fI\%#38925\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#38537\fP: (\fI\%amendlik\fP) API client wheel_async always returns status 500 (refs: \fI\%#38925\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38925\fP: (\fI\%terminalmage\fP) Fix two wheel issues in netapi
@ \fI2017\-01\-25 18:28:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
b27733cc33 Merge pull request \fI\%#38925\fP from terminalmage/issue38540
.IP \(bu 2
76392fc6ad Fix traceback when a netapi module uses wheel_async
.IP \(bu 2
bd4474fa62 Fix \(aqsuccess\(aq value for wheel commands
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38926\fP: (\fI\%gtmanfred\fP) add note about pysss for pam eauth
@ \fI2017\-01\-25 18:12:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
618596f0cc Merge pull request \fI\%#38926\fP from gtmanfred/2016.3
.IP \(bu 2
9cae953c93 add note about pysss for pam eauth
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38825\fP: (\fI\%IshMalik\fP) file.managed multiple sources for redundency failure (refs: \fI\%#38847\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38847\fP: (\fI\%terminalmage\fP) Catch MinionError in file.source_list
@ \fI2017\-01\-24 16:03:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
405d86a2ca Merge pull request \fI\%#38847\fP from terminalmage/issue38825
.IP \(bu 2
11a47803ce Use log.exception() instead
.IP \(bu 2
e40fac589a Catch MinionError in file.source_list
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#36121\fP: (\fI\%Ashald\fP) TemplateNotFound/Unable to cache file (refs: \fI\%#38875\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38875\fP: (\fI\%terminalmage\fP) Reactor: fix traceback when salt:// path is nonexistent
@ \fI2017\-01\-24 15:23:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
b5df104fc2 Merge pull request \fI\%#38875\fP from terminalmage/issue36121
.IP \(bu 2
fbc4d2a2c4 reactor: ensure glob_ref is a string
.IP \(bu 2
2e443d79a3 cp.cache_file: add note re: return for nonexistent salt:// path
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#37413\fP: (\fI\%Snarfingcode666\fP) Salt\-cloud vmware missing reboot command (refs: \fI\%#38887\fP, \fI\%#38890\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38890\fP: (\fI\%cro\fP) Backport  \fI\%#38887\fP to 2016.3: Enable resetting a VM via salt\-cloud & VMware driver
@ \fI2017\-01\-24 15:15:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38887\fP: (\fI\%cro\fP) Enable resetting a VM via salt\-cloud & VMware driver (refs: \fI\%#38890\fP)
.IP \(bu 2
e9ebec4d80 Merge pull request \fI\%#38890\fP from cro/vmware_reset_vm_20163
.IP \(bu 2
0146562fb4 Call correct function for resetting a VM
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38883\fP: (\fI\%techhat\fP) Don\(aqt require text_out path to exist
@ \fI2017\-01\-23 18:20:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#38867\fP: (\fI\%mchugh19\fP) Touch deploy.sh before use (refs: \fI\%#38883\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32026\fP: (\fI\%techhat\fP) Don\(aqt require the decode_out file to already exist (refs: \fI\%#38883\fP)
.IP \(bu 2
c3fbfcd231 Merge pull request \fI\%#38883\fP from techhat/dontrequire
.IP \(bu 2
67bc4d6687 Don\(aqt require text_out path to exist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38851\fP: (\fI\%terminalmage\fP) Support docker\-py 2.0 in dockerng
@ \fI2017\-01\-23 16:48:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
6430a45196 Merge pull request \fI\%#38851\fP from terminalmage/docker\-py\-2.0
.IP \(bu 2
3c061b21fe Support docker\-py 2.0 in dockerng
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#38844\fP: (\fI\%cachedout\fP) Fix memory leak in HTTP client
@ \fI2017\-01\-20 20:59:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
ac8008d843 Merge pull request \fI\%#38844\fP from cachedout/http_memory_leak
.IP \(bu 2
c46bf85518 Fix memory leak in HTTP client
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#38798\fP: (\fI\%ripta\fP) \fImatch.compound\fP fails to match when pillar data is used (refs: \fI\%#38823\fP)
.IP \(bu 2
\fBPR\fP \fI\%#38823\fP: (\fI\%gtmanfred\fP) pass pillar to compound matcher in match module
@ \fI2017\-01\-20 19:19:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
dfe6dfe963 Merge pull request \fI\%#38823\fP from gtmanfred/2016.3
.IP \(bu 2
f0a71e8707 pass pillar to compound matcher in match module
.UNINDENT
.UNINDENT
.SS Salt 2016.3.7 Release Notes
.sp
Version 2016.3.7 is a bugfix release for \fI\%2016.3.0\fP\&.
.SS Security Fix
.sp
\fBCVE\-2017\-12791\fP Maliciously crafted minion IDs can cause unwanted directory
traversals on the Salt\-master
.sp
This release corrects a flaw in minion ID validation which could allow certain minions to
authenticate to a master despite not having the correct credentials. To exploit
the vulnerability, an attacker must create a salt\-minion with an ID containing
characters that will cause a directory traversal. Credit for discovering the
security flaw goes to: \fI\%Vernhk@qq.com\fP
.SS Changelog for v2016.3.6..v2016.3.7
.sp
\fIGenerated at: 2018\-05\-27 14:09:17 UTC\fP
.INDENT 0.0
.IP \(bu 2
11d176ff1b Add release notes for 2016.3.7 release
.IP \(bu 2
dc649ded51 Add clean_id function to salt.utils.verify.py
.UNINDENT
.SS Salt 2016.3.8 Release Notes
.sp
Version 2016.3.8 is a bugfix release for \fI\%2016.3.0\fP\&.
.SS Security Fix
.sp
\fBCVE\-2017\-14695\fP Directory traversal vulnerability in minion id validation in
SaltStack. Allows remote minions with incorrect credentials to authenticate to
a master via a crafted minion ID. Credit for discovering the security flaw goes
to: Julian Brost (\fI\%julian@0x4a42.net\fP)
.sp
\fBCVE\-2017\-14696\fP Remote Denial of Service with a specially crafted
authentication request. Credit for discovering the security flaw goes to:
Julian Brost (\fI\%julian@0x4a42.net\fP)
.SS Changelog for v2016.3.7..v2016.3.8
.sp
\fIGenerated at: 2018\-05\-27 14:11:36 UTC\fP
.INDENT 0.0
.IP \(bu 2
8cf08bd7be Update 2016.3.7 Release Notes
.IP \(bu 2
0425defe84 Do not allow IDs with null bytes in decoded payloads
.IP \(bu 2
31b38f50eb Don\(aqt allow path separators in minion ID
.UNINDENT
.SS Salt 2016.3.9 Release Notes
.sp
Version 2016.3.9 is a bugfix release for \fI\%2016.3.0\fP\&.
.SS Master Changes
.sp
The following options have been added to the master config file:
.INDENT 0.0
.IP \(bu 2
\fI\%allow_minion_key_revoke\fP \- This option controls whether a
minion can request that the master revoke its key. When \fBTrue\fP, a minion
can request a key revocation and the master will comply. If it is \fBFalse\fP,
the key will not be revoked by the msater.
.IP \(bu 2
\fBrequire_minion_sign_messages\fP \- This requires that minions
cryptographically sign the messages they publish to the master. If minions
are not signing, then log this information at loglevel \fBINFO\fP and drop the
message without acting on it.
.IP \(bu 2
\fBdrop_messages_signature_fail\fP \- Drop messages from minions when
their signatures do not validate. Note that when this option is \fBFalse\fP but
\fIrequire_minion_sign_messages\fP is \fBTrue\fP, minions \fIMUST\fP sign their
messages, but the validity of their signatures is ignored.
.IP \(bu 2
\fBminion_sign_messages\fP \- Causes the minion to cryptographically
sign the payload of messages it places on the event bus for the master. The
payloads are signed with the minion\(aqs private key so the master can verify
the signature with its public key.
.UNINDENT
.SS Salt 2015.8.0 Release Notes \- Codename Beryllium
.SS 2015.8.0 Detailed Change List
.sp
Extended changelog courtesy of Todd Stansell (\fI\%https://github.com/tjstansell/salt\-changelogs\fP)
.sp
\fIGenerated at: 2015\-09\-09T18:15:43Z\fP
.sp
This list includes all pull requests merged into the 2015.8 branch between the
forking of the branch from develop and the release of 2015.8.0.
.sp
Statistics:
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB682\fP
.IP \(bu 2
Total Issue references: \fB342\fP
.IP \(bu 2
Total PR references: \fB866\fP
.UNINDENT
.sp
Pull Requests:
.INDENT 0.0
.IP \(bu 2
\fI\%#26993\fP: (\fIwhiteinge\fP) Backport \fI\%#26975\fP
.IP \(bu 2
\fI\%#26970\fP: (\fIcachedout\fP) Revert \(dqbetter path query parsing in fileserver\(dq
.IP \(bu 2
\fI\%#26980\fP: (\fIterminalmage\fP) Use human\-readable cachedirs for gitfs\-backed winrepo
.IP \(bu 2
\fI\%#26969\fP: (\fITheBigBear\fP) URL of salt windows downloads has changed
.IP \(bu 2
\fI\%#26968\fP: (\fITheBigBear\fP) URL of salt windows downloads has changed
.IP \(bu 2
\fI\%#26958\fP: (\fIs0undt3ch\fP) Bradthurber bootstrap command line help doc update
.IP \(bu 2
\fI\%#26949\fP: (\fIrallytime\fP) Back\-port \fI\%#25148\fP to 2015.8
.IP \(bu 2
\fI\%#26914\fP: (\fIcro\fP) Add salt\-proxy script and manpage to setup.py so they will get installed.
.IP \(bu 2
\fI\%#26909\fP: (\fIterminalmage\fP) Don\(aqt try to git clone from /tmp on Windows
.IP \(bu 2
\fI\%#26910\fP: (\fIs0undt3ch\fP) Sometimes the event system is just too fast
.IP \(bu 2
\fI\%#26905\fP: (\fIs0undt3ch\fP) Exit the loop if run_once is true
.IP \(bu 2
\fI\%#26897\fP: (\fImsteed\fP) spm file hash part deux
.IP \(bu 2
\fI\%#26900\fP: (\fIs0undt3ch\fP) If no tag is passed, don\(aqt actually subscribe to anything.
.IP \(bu 2
\fI\%#26880\fP: (\fIs0undt3ch\fP) Restore backwards compatibility to \fIsalt.utils.event\fP
.IP \(bu 2
\fI\%#26896\fP: (\fImsteed\fP) spm remove: use pkgfiles to calculate file hashes
.IP \(bu 2
\fI\%#26891\fP: (\fIjtand\fP) Fixed an unboundlocalerror
.IP \(bu 2
\fI\%#26892\fP: (\fIcachedout\fP) Make the testing ioloop the current one
.IP \(bu 2
\fI\%#26886\fP: (\fIjtand\fP) Gets the azure version correctly on python\-azure 1.0.0
.IP \(bu 2
\fI\%#26870\fP: (\fIrallytime\fP) Back\-port \fI\%#26834\fP to 2015.8
.IP \(bu 2
\fI\%#26865\fP: (\fIdmurphy18\fP) Fix apt preferences for apts, repos for pbuilder building for Debian
.IP \(bu 2
\fI\%#26873\fP: (\fIterminalmage\fP) Properly handle getting local config values in older git versions
.IP \(bu 2
\fI\%#26869\fP: (\fIrallytime\fP) Fix provider \-\-> driver change for salt\-cloud lxc
.IP \(bu 2
\fI\%#26858\fP: (\fIterminalmage\fP) Fix a couple version checks for git state and execution module
.IP \(bu 2
\fI\%#26853\fP: (\fIUtahDave\fP) Fix salt\-cloud on windows
.IP \(bu 2
\fI\%#26852\fP: (\fIbasepi\fP) [2015.8] Only reference msgpack if it imported successfully
.IP \(bu 2
\fI\%#26835\fP: (\fIterminalmage\fP) Backport \fI\%#26572\fP to 2015.8
.IP \(bu 2
\fI\%#26836\fP: (\fIjacobhammons\fP) Added rst source for salt\-proxy man page, added build and copy lines …
.IP \(bu 2
\fI\%#26818\fP: (\fIterminalmage\fP) Support empty repositories in git.latest
.IP \(bu 2
\fI\%#26819\fP: (\fIrallytime\fP) Make sure we\(aqre calling _validate_name in the correct place in 2015.8 Linode driver
.IP \(bu 2
\fI\%#26841\fP: (\fIl2ol33rt\fP) Fix reference before assignment in sqs engine
.IP \(bu 2
\fI\%#26822\fP: (\fIterminalmage\fP) Add some missing imports for masterless winrepo
.IP \(bu 2
\fI\%#26831\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#26826\fP: (\fItechhat\fP) Pass a package name to unregister_file()
.IP \(bu 2
\fI\%#26757\fP: (\fIcachedout\fP) Fix various filehandle leaks
.IP \(bu 2
\fI\%#26816\fP: (\fIgtmanfred\fP) rev defaults to HEAD
.IP \(bu 2
\fI\%#26801\fP: (\fIjacobhammons\fP) Added doc for dockerng minion configuration options
.IP \(bu 2
\fI\%#26808\fP: (\fIanlutro\fP) Fix git init argument formatting
.IP \(bu 2
\fI\%#26807\fP: (\fIterminalmage\fP) Move salt.utils.itersplit() to salt.utils.itertools.split()
.IP \(bu 2
\fI\%#26796\fP: (\fIjacobhammons\fP) Add doc for __states__
.IP \(bu 2
\fI\%#26764\fP: (\fIsjorge\fP) salt.utils.is_proxy() is no longer always true on SunOS/Illumos/SmartOS
.IP \(bu 2
\fI\%#26772\fP: (\fIsjorge\fP) pull in smartos \(aqvirt\(aq module from develop
.IP \(bu 2
\fI\%#26726\fP: (\fIterminalmage\fP) Redact HTTPS Basic Auth in states/funcs which deal with git remotes
.IP \(bu 2
\fI\%#26769\fP: (\fIterminalmage\fP) Use \-\-track to set tracking branch on older git versions
.IP \(bu 2
\fI\%#26765\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#26761\fP: (\fIsjorge\fP) fix SPM paths on smartos/illumos esky
.IP \(bu 2
\fI\%#26751\fP: (\fIterminalmage\fP) Fixes for masterless winrepo
.IP \(bu 2
\fI\%#26745\fP: (\fIrallytime\fP) Make sure pyrax configs are in place before checking for deps
.IP \(bu 2
\fI\%#26746\fP: (\fIrallytime\fP) Make sure nova configs are set before checking for dependencies
.IP \(bu 2
\fI\%#26750\fP: (\fIbasepi\fP) [2015.8] Add __utils__ to state modules
.IP \(bu 2
\fI\%#26752\fP: (\fIcro\fP) Fix typo in some diagram labels
.IP \(bu 2
\fI\%#26747\fP: (\fIbasepi\fP) [2015.8] Add __states__ to state modules, for cross\-calling states
.IP \(bu 2
\fI\%#26744\fP: (\fIbasepi\fP) [2015.8] Fix issue from \fI\%#26717\fP
.IP \(bu 2
\fI\%#26737\fP: (\fIdmurphy18\fP)  Fix to allow for package naming other than just salt
.IP \(bu 2
\fI\%#26742\fP: (\fIrallytime\fP) Only warn about vsphere deprecation if vsphere is configured
.IP \(bu 2
\fI\%#26733\fP: (\fIsjorge\fP) Refactor of smartos_vmadm module
.IP \(bu 2
\fI\%#26735\fP: (\fIs0undt3ch\fP) Add \fI\&.hg\fP and \fI\&.cvs\fP to spm_build_exclude
.IP \(bu 2
\fI\%#26720\fP: (\fIUtahDave\fP) Updates for winrepo in 2015.8 to support jinja, while maintaining backwards compat
.IP \(bu 2
\fI\%#26719\fP: (\fIjodv\fP) Backport 26532 to 2015.8
.IP \(bu 2
\fI\%#26721\fP: (\fIrallytime\fP) Linode Driver Cleanup
.IP \(bu 2
\fI\%#26707\fP: (\fItechhat\fP) Add top_level_dir to FORMULAs
.IP \(bu 2
\fI\%#26723\fP: (\fIs0undt3ch\fP) Handle SPM paths in the setup script
.IP \(bu 2
\fI\%#26717\fP: (\fIbasepi\fP) [2015.8] Revert loader changes from \fI\%#26645\fP
.IP \(bu 2
\fI\%#26712\fP: (\fItechhat\fP) Move SPM paths around
.IP \(bu 2
\fI\%#26680\fP: (\fITheBigBear\fP) add more python libs info in \(aq\-\-versions\-report\(aq
.IP \(bu 2
\fI\%#26716\fP: (\fIterminalmage\fP) Allow git identity to be a list
.IP \(bu 2
\fI\%#26691\fP: (\fIgarethgreenaway\fP) Fixes to ipset module for 2015.8
.IP \(bu 2
\fI\%#26701\fP: (\fIkev009\fP) Ignore the first element of kern.disks split, which is the sysctl name (new disks grain)
.IP \(bu 2
\fI\%#26678\fP: (\fIterminalmage\fP) Restructure git.latest rewrite to work better when following HEAD
.IP \(bu 2
\fI\%#26679\fP: (\fIrallytime\fP) Back\-port \fI\%#26661\fP to 2015.8
.IP \(bu 2
\fI\%#26684\fP: (\fItechhat\fP) Add reactor formulas to spm
.IP \(bu 2
\fI\%#26682\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#26671\fP: (\fIrallytime\fP) Warn users if cloud driver dependencies are missing.
.IP \(bu 2
\fI\%#26674\fP: (\fIrallytime\fP) Back\-port \fI\%#26583\fP to 2015.8
.IP \(bu 2
\fI\%#26670\fP: (\fItechhat\fP) Set up SPM to install \-conf packages
.IP \(bu 2
\fI\%#26657\fP: (\fIjfindlay\fP) top file compilation fixes
.IP \(bu 2
\fI\%#26659\fP: (\fITheBigBear\fP) minor doc edits \- spelling
.IP \(bu 2
\fI\%#26654\fP: (\fIjfindlay\fP) merge \fI\%#26650\fP
.IP \(bu 2
\fI\%#26567\fP: (\fIjtand\fP) Added git version check to git module
.IP \(bu 2
\fI\%#26649\fP: (\fItwangboy\fP) Fixed Lint for real in win_repo.py
.IP \(bu 2
\fI\%#26608\fP: (\fIjacobhammons\fP) 2015.8.0 release notes and doc/conf.py updates
.IP \(bu 2
\fI\%#26646\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#26645\fP: (\fIrallytime\fP) Back\-port \fI\%#26390\fP to 2015.8
.IP \(bu 2
\fI\%#26642\fP: (\fItwangboy\fP) Added function to render winrepo Jinja
.IP \(bu 2
\fI\%#26625\fP: (\fItwangboy\fP) Correctly detect packages with no version, docs
.IP \(bu 2
\fI\%#26575\fP: (\fImsteed\fP) Update spm for integration into raas
.IP \(bu 2
\fI\%#26635\fP: (\fIcro\fP) Don\(aqt report windows as a proxy.
.IP \(bu 2
\fI\%#26622\fP: (\fIrallytime\fP) [2015.8] Also add \-Z to script args for cloud tests
.IP \(bu 2
\fI\%#26619\fP: (\fIrallytime\fP) Apply cloud test fixes from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#26603\fP: (\fIterminalmage\fP) Fixes for git.latest, git module integration tests, etc.
.IP \(bu 2
\fI\%#26577\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#26534\fP: (\fIcachedout\fP) Bump required Tornado version to 4.2.1
.IP \(bu 2
\fI\%#26566\fP: (\fIcachedout\fP) Don\(aqt stacktrace trying to publish without a master
.IP \(bu 2
\fI\%#26541\fP: (\fIterminalmage\fP) Make winrepo execution module use the same code as the runner
.IP \(bu 2
\fI\%#26530\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#26570\fP: (\fIcachedout\fP) Fix haproxy docs to be valid
.IP \(bu 2
\fI\%#26562\fP: (\fIcachedout\fP) Fix suprious error message with systemd\-detect
.IP \(bu 2
\fI\%#26557\fP: (\fIjfindlay\fP) add docs to \fI\%#26550\fP
.IP \(bu 2
\fI\%#26544\fP: (\fInmadhok\fP) Do not raise KeyError when calling avail_images if VM/template is in disconnected state
.IP \(bu 2
\fI\%#26501\fP: (\fIterminalmage\fP) Update git_pillar docs, add git.list_worktrees function
.IP \(bu 2
\fI\%#26521\fP: (\fIterminalmage\fP) Work around upstream git bug when cloning repo as root
.IP \(bu 2
\fI\%#26518\fP: (\fIkrak3n\fP) Fix for \fI\%#25492\fP
.IP \(bu 2
\fI\%#26514\fP: (\fIevverx\fP) Unmask a runtime masked services too
.IP \(bu 2
\fI\%#26529\fP: (\fImnalt\fP) bugfix: fix service.enable for missing rc.conf
.IP \(bu 2
\fI\%#26516\fP: (\fItechhat\fP) Move more path operations into SPM loader
.IP \(bu 2
\fI\%#26533\fP: (\fIcachedout\fP) Fix too aggressive even init check
.IP \(bu 2
\fI\%#26522\fP: (\fIcro\fP) Do not load package provider if its not a proxy
.IP \(bu 2
\fI\%#26531\fP: (\fIcachedout\fP) Fix failing event tests and modify event init
.IP \(bu 2
\fI\%#26433\fP: (\fIcro\fP) Add support for default proxy config options, change default location of proxy config and log to /etc/salt/proxy and /var/log/proxy
.IP \(bu 2
\fI\%#26504\fP: (\fInmadhok\fP) [Backport] Adding ability to specify the virtual hardware version when creating VM
.IP \(bu 2
\fI\%#26517\fP: (\fIcachedout\fP) Better fix for opensuse tornado httpclient
.IP \(bu 2
\fI\%#26479\fP: (\fIrallytime\fP) Don\(aqt allow VMs with duplicate names to be created in EC2/AWS
.IP \(bu 2
\fI\%#26488\fP: (\fIcachedout\fP) Don\(aqt pass unsupported kwarg to tornado
.IP \(bu 2
\fI\%#26451\fP: (\fIterminalmage\fP) Use \(aqrpm \-qa\(aq instead of repoquery to list installed packages
.IP \(bu 2
\fI\%#26491\fP: (\fIjacobhammons\fP) doc site css fix for tiny fonts that appeared in code or pre tags in …
.IP \(bu 2
\fI\%#26442\fP: (\fIrallytime\fP) Hide API Key from debug logs for Linode Driver
.IP \(bu 2
\fI\%#26441\fP: (\fIrallytime\fP) Refactor a few linode functions to be useful with salt\-cloud command
.IP \(bu 2
\fI\%#26485\fP: (\fIs0undt3ch\fP) One more missed typo
.IP \(bu 2
\fI\%#26495\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#26492\fP: (\fIcachedout\fP) Fix schedule test error on py26
.IP \(bu 2
\fI\%#26489\fP: (\fIcachedout\fP) Fixing more tarfile tests on py2.6
.IP \(bu 2
\fI\%#26475\fP: (\fIcachedout\fP) Better object checking on asyncreq cleanup
.IP \(bu 2
\fI\%#26477\fP: (\fIcachedout\fP) Fix integration.modules.git.GitModuleTest.test_archive on py26
.IP \(bu 2
\fI\%#26469\fP: (\fIjtand\fP) \-\-annotate and \-\-message aren\(aqt valid options in older versions of git.
.IP \(bu 2
\fI\%#26439\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#26464\fP: (\fIrallytime\fP) Back\-port \fI\%#26456\fP to 2015.8
.IP \(bu 2
\fI\%#26463\fP: (\fIrallytime\fP) Back\-port \fI\%#26455\fP to 2015.8
.IP \(bu 2
\fI\%#26449\fP: (\fIs0undt3ch\fP) The CLI options are not meant to include underscores.
.IP \(bu 2
\fI\%#26270\fP: (\fIsjorge\fP) salt.modules.network now supports SmartOS and SunOS < Solaris 11
.IP \(bu 2
\fI\%#26436\fP: (\fITheBigBear\fP) minor edits
.IP \(bu 2
\fI\%#26410\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#26427\fP: (\fIanlutro\fP) git.latest with no rev: fix concatenation error (NoneType and str)
.IP \(bu 2
\fI\%#26307\fP: (\fIcachedout\fP) Fix bug in top file ordering
.IP \(bu 2
\fI\%#26428\fP: (\fIcro\fP) Update docs to reflect new pillar structure
.IP \(bu 2
\fI\%#26429\fP: (\fIcachedout\fP) Add release note regarding tcp transport on freebsd
.IP \(bu 2
\fI\%#26418\fP: (\fIdriskell\fP) Fix forward\-merged caching from 2015.5 into 2015.8 to be compatible with the new match_func
.IP \(bu 2
\fI\%#26252\fP: (\fIDmitryKuzmenko\fP) Issues/24048 http client 2015.8
.IP \(bu 2
\fI\%#26413\fP: (\fIevverx\fP) Fix service.{start,restart,reload,force\-reload} for masked services
.IP \(bu 2
\fI\%#26393\fP: (\fIdmurphy18\fP) Added option parameters to make_repo to allow for configuration settings
.IP \(bu 2
\fI\%#26422\fP: (\fITheBigBear\fP) no dots in SLS filename __AND__ any directories (incl git repos)
.IP \(bu 2
\fI\%#26323\fP: (\fI0xf10e\fP) Fix Credentials used in \fIglance\fP Exec Module
.IP \(bu 2
\fI\%#26341\fP: (\fIterminalmage\fP) Rewrite git state and execution modules
.IP \(bu 2
\fI\%#26419\fP: (\fIterminalmage\fP) Only use pygit2.errors if it exists
.IP \(bu 2
\fI\%#26423\fP: (\fIeliasp\fP) doc \- Correct function name for peer configuration
.IP \(bu 2
\fI\%#26401\fP: (\fIcachedout\fP) Adapt proxy minion to tornado (w/lint)
.IP \(bu 2
\fI\%#26400\fP: (\fIrallytime\fP) Back\-port \fI\%#26318\fP to 2015.8
.IP \(bu 2
\fI\%#26397\fP: (\fIs0undt3ch\fP) A single \fIisinstance()\fP check for all types is enough
.IP \(bu 2
\fI\%#26385\fP: (\fIgtmanfred\fP) don\(aqt require volume endpoint in nova driver
.IP \(bu 2
\fI\%#26287\fP: (\fItechhat\fP) Break out SPM components into loaders
.IP \(bu 2
\fI\%#26384\fP: (\fITheBigBear\fP)  Fix shell quoting for cmd.run
.IP \(bu 2
\fI\%#26391\fP: (\fIrallytime\fP) Back\-port \fI\%#26367\fP to 2015.8
.IP \(bu 2
\fI\%#26383\fP: (\fIrallytime\fP) Allow the creation of a VM without a profile
.IP \(bu 2
\fI\%#26375\fP: (\fIs0undt3ch\fP) [2015.8] Schema DictItem required attribute fixes
.IP \(bu 2
\fI\%#26363\fP: (\fIgarethgreenaway\fP) Fixes to mount state 2015.8
.IP \(bu 2
\fI\%#26347\fP: (\fI0xf10e\fP) Load \(aqpkgng\(aq as \(aqpkg\(aq on FreeBSD 9 when \fIproviders:pkg\fP == \(aqpkgng\(aq
.IP \(bu 2
\fI\%#26361\fP: (\fITronPaul\fP) sign security token
.IP \(bu 2
\fI\%#26346\fP: (\fITronPaul\fP) Fix s3 using IAM credentials
.IP \(bu 2
\fI\%#26331\fP: (\fImnalt\fP) fix bug in sysrc to allow for empty rc variables
.IP \(bu 2
\fI\%#26334\fP: (\fIrallytime\fP) Call salt.utils.cloud.bootstrap in GCE Driver provisioning
.IP \(bu 2
\fI\%#26308\fP: (\fIdmurphy18\fP) Support for environment overrides building packages
.IP \(bu 2
\fI\%#26279\fP: (\fITheScriptSage\fP) Merge changes for pull\(ga#26083\(ga_ and pull\(ga#25632\(ga_ into 2015.8
.IP \(bu 2
\fI\%#26224\fP: (\fIcachedout\fP) Cleanup of a few cases to move to salt.utils.fopen
.IP \(bu 2
\fI\%#26260\fP: (\fInmadhok\fP) Correct spelling of integration in docs
.IP \(bu 2
\fI\%#26226\fP: (\fIrallytime\fP) Fix \fI\%#25463\fP
.IP \(bu 2
\fI\%#26248\fP: (\fInmadhok\fP) Initial commit of unit tests for vmware cloud driver
.IP \(bu 2
\fI\%#26228\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#26244\fP: (\fInmadhok\fP) Backport additions to VMware cloud driver from develop to 2015.8 branch
.IP \(bu 2
\fI\%#26235\fP: (\fIsjorge\fP) salt.utils.is_smartos_zone, inverse of is_smartos_globalzone
.IP \(bu 2
\fI\%#26221\fP: (\fIsjorge\fP) SmartOS grain fixes
.IP \(bu 2
\fI\%#26218\fP: (\fIterminalmage\fP) Add warning about file.recurse unicode errors with vim swap files.
.IP \(bu 2
\fI\%#26214\fP: (\fIrallytime\fP) Back\-port \fI\%#24878\fP to 2015.8
.IP \(bu 2
\fI\%#26211\fP: (\fItechhat\fP) Move SPM to its own directory
.IP \(bu 2
\fI\%#26197\fP: (\fITronPaul\fP) Fix GitFS when whitelisting base
.IP \(bu 2
\fI\%#26200\fP: (\fIanlutro\fP) Make it possible to run salt\-cloud as current user
.IP \(bu 2
\fI\%#26201\fP: (\fIkev009\fP) Avoid VBOX storage emulation bugs in FreeBSD disks grain
.IP \(bu 2
\fI\%#26188\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#26194\fP: (\fIbasepi\fP) Allow virtual grains to be generated even if virt\-what is not available
.IP \(bu 2
\fI\%#26176\fP: (\fIrallytime\fP) Back\-port \fI\%#26165\fP to 2015.8
.IP \(bu 2
\fI\%#26169\fP: (\fIterminalmage\fP) Fix attribute error in gitfs\(aq find_file functions
.IP \(bu 2
\fI\%#26170\fP: (\fInmadhok\fP) [Backport] Make sure variable is a dictionary before popping something from it.
.IP \(bu 2
\fI\%#26143\fP: (\fInmadhok\fP) VMware cloud driver fixes [forward port from 2015.5 into 2015.8]
.IP \(bu 2
\fI\%#26173\fP: (\fIjacobhammons\fP) Updates to cloud docs for the provider > driver change
.IP \(bu 2
\fI\%#26125\fP: (\fIevverx\fP) Use timedatectl set\-timezone to tzsetting if available
.IP \(bu 2
\fI\%#26145\fP: (\fIsjorge\fP) smartos_imgadm cleanup
.IP \(bu 2
\fI\%#26148\fP: (\fIterminalmage\fP) Refactor winrepo support
.IP \(bu 2
\fI\%#26128\fP: (\fIsjorge\fP) imgadm.avail should return multiple results
.IP \(bu 2
\fI\%#26109\fP: (\fIjfindlay\fP) fix quote indent
.IP \(bu 2
\fI\%#26089\fP: (\fIanlutro\fP) User state/module: fix coercing of None into string \(dqNone\(dq in GECOS
.IP \(bu 2
\fI\%#26081\fP: (\fIcachedout\fP) Move invocation routine up
.IP \(bu 2
\fI\%#26086\fP: (\fIrallytime\fP) Back\-port \fI\%#26019\fP to 2015.8
.IP \(bu 2
\fI\%#26087\fP: (\fIrallytime\fP) Back\-port \fI\%#26059\fP to 2015.8
.IP \(bu 2
\fI\%#26052\fP: (\fIjtand\fP) Rh_ip fix
.IP \(bu 2
\fI\%#26078\fP: (\fIcachedout\fP) Fix missing key in error return
.IP \(bu 2
\fI\%#26074\fP: (\fIbasepi\fP) [2015.8] Re\-apply \fI\%#25358\fP in 2015.8
.IP \(bu 2
\fI\%#26069\fP: (\fIjfindlay\fP) fix win_firewall.delete_rule
.IP \(bu 2
\fI\%#26066\fP: (\fIs0undt3ch\fP) [2015.8] Update to latest bootstrap stable release v2015.06.08
.IP \(bu 2
\fI\%#26049\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#26026\fP: (\fIanlutro\fP) Fix httpasswd result false positive in test mode
.IP \(bu 2
\fI\%#26037\fP: (\fIrallytime\fP) Back\-port \fI\%#25489\fP to 2015.8
.IP \(bu 2
\fI\%#26004\fP: (\fItechhat\fP) Allow updating a single SPM repo at a time
.IP \(bu 2
\fI\%#26012\fP: (\fIcachedout\fP) Merge kwargs into opts for tcp client
.IP \(bu 2
\fI\%#26007\fP: (\fIanlutro\fP) file.managed: wrap os.remove in if isfile, don\(aqt remove on success
.IP \(bu 2
\fI\%#26009\fP: (\fIterminalmage\fP) Add winrepo and dockerng information to 2015.8.0 release notes
.IP \(bu 2
\fI\%#26006\fP: (\fIbasepi\fP) Revert \fI\%#25727\fP in favor of \fI\%#25645\fP
.IP \(bu 2
\fI\%#26001\fP: (\fIcachedout\fP) Fix failing tests
.IP \(bu 2
\fI\%#25978\fP: (\fIanlutro\fP) Correct service state changes in test mode
.IP \(bu 2
\fI\%#25982\fP: (\fIsjorge\fP) salt.modules.smartos_* limit to global zone only
.IP \(bu 2
\fI\%#25989\fP: (\fIrallytime\fP) Back\-port \fI\%#25832\fP to 2015.8
.IP \(bu 2
\fI\%#25988\fP: (\fIcachedout\fP) Move \fI\%#25642\fP to 2015.8
.IP \(bu 2
\fI\%#25999\fP: (\fIs0undt3ch\fP) Include subschema defaults
.IP \(bu 2
\fI\%#25997\fP: (\fIs0undt3ch\fP) Allow getting a defaults dictionary from schema defaults
.IP \(bu 2
\fI\%#25979\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#25902\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#25956\fP: (\fIanlutro\fP) Fix user argument to cron functions
.IP \(bu 2
\fI\%#25946\fP: (\fIsjorge\fP) Fix for salt.utils.decorators under esky
.IP \(bu 2
\fI\%#25957\fP: (\fIanlutro\fP) Remove temporary file after file.managed with checkcmd
.IP \(bu 2
\fI\%#25874\fP: (\fIrallytime\fP) Back\-port \fI\%#25668\fP to 2015.8
.IP \(bu 2
\fI\%#25929\fP: (\fIsjorge\fP) salt.module.pkgin\(aqs __virtual__() should not return None if pkg_info is not present
.IP \(bu 2
\fI\%#25952\fP: (\fIgarethgreenaway\fP) Log when event.fire and event.fire_master fail 2015.8
.IP \(bu 2
\fI\%#25944\fP: (\fIsjorge\fP) Smartos libcrypto nonesky fix
.IP \(bu 2
\fI\%#25906\fP: (\fIdmurphy18\fP) Cherry\-pick of pkgbuild changes from develop branch
.IP \(bu 2
\fI\%#25925\fP: (\fIsjorge\fP) Create default log location in smartos esky buildscript
.IP \(bu 2
\fI\%#25928\fP: (\fIcachedout\fP) Fix stacktrace for non\-existant states
.IP \(bu 2
\fI\%#25922\fP: (\fIjacksontj\fP) Correct max_wait \-> max_auth_wait in MultiMinion
.IP \(bu 2
\fI\%#25907\fP: (\fIrallytime\fP) Back\-port \fI\%#25892\fP to 2015.8
.IP \(bu 2
\fI\%#25910\fP: (\fIterminalmage\fP) Pass osarch to check_32()
.IP \(bu 2
\fI\%#25849\fP: (\fIbasepi\fP) Repress template error for GPG renderer (can\(aqt seek an OrderedDict)
.IP \(bu 2
\fI\%#25868\fP: (\fIrallytime\fP) Back\-port \fI\%#25404\fP to 2015.8
.IP \(bu 2
\fI\%#25896\fP: (\fIcachedout\fP) Lint
.IP \(bu 2
\fI\%#25876\fP: (\fIjacksontj\fP) Fixes for 2015.8
.IP \(bu 2
\fI\%#25867\fP: (\fIrallytime\fP) Back\-port \fI\%#25370\fP to 2015.8
.IP \(bu 2
\fI\%#25845\fP: (\fIjacobhammons\fP) updated versionadded
.IP \(bu 2
\fI\%#25836\fP: (\fIjacksontj\fP) Keep track of SyncWrapper\(aqs IOLoop usage
.IP \(bu 2
\fI\%#25859\fP: (\fI0xf10e\fP) warn_until(Carbon,...) instead of Boron
.IP \(bu 2
\fI\%#25505\fP: (\fI0xf10e\fP) Glance state module for 2015.8 \(dqBeryllium\(dq
.IP \(bu 2
\fI\%#25843\fP: (\fIjtand\fP) Fixed a lint error in parsers.py
.IP \(bu 2
\fI\%#25835\fP: (\fItechhat\fP) spm update_repo doesn\(aqt always require arguments
.IP \(bu 2
\fI\%#25837\fP: (\fIjacobhammons\fP) regenerated man pages
.IP \(bu 2
\fI\%#25830\fP: (\fIsjorge\fP) Loading of libcrypto on smartos esky fixed
.IP \(bu 2
\fI\%#25808\fP: (\fIjfindlay\fP) add highstate opts to config/__init__.py, update docs
.IP \(bu 2
\fI\%#25820\fP: (\fIsjorge\fP) Prerequisite to fix the smartos libcrypto loading
.IP \(bu 2
\fI\%#25781\fP: (\fIanlutro\fP) Fix iptables.build_rule
.IP \(bu 2
\fI\%#25764\fP: (\fIgtmanfred\fP) allow use of cloudnetworks in ssh_interface
.IP \(bu 2
\fI\%#25736\fP: (\fIjfindlay\fP) insert explicit formatter number
.IP \(bu 2
\fI\%#25742\fP: (\fIrallytime\fP) Back\-port \fI\%#25731\fP to 2015.8
.IP \(bu 2
\fI\%#25741\fP: (\fIrallytime\fP) Back\-port \fI\%#25727\fP to 2015.8
.IP \(bu 2
\fI\%#25712\fP: (\fIcachedout\fP) Fix outputter for state.apply
.IP \(bu 2
\fI\%#25698\fP: (\fIrallytime\fP) Back\-port \fI\%#25659\fP to 2015.8
.IP \(bu 2
\fI\%#25690\fP: (\fIanlutro\fP) Fix highstate duration alignment (again)
.IP \(bu 2
\fI\%#25684\fP: (\fIdavidjb\fP) Fix doc around Include/Exclude for states
.IP \(bu 2
\fI\%#25549\fP: (\fItechhat\fP) Switch Scaleway to salt.utils.cloud.bootstrap()
.IP \(bu 2
\fI\%#25667\fP: (\fIjfindlay\fP) add 2015.8.0rc2 autogenerated changelog
.IP \(bu 2
\fI\%#25653\fP: (\fIanlutro\fP) Properly align highstate duration sum
.IP \(bu 2
\fI\%#25663\fP: (\fIrallytime\fP) Back\-port \fI\%#25638\fP to 2015.8
.IP \(bu 2
\fI\%#25639\fP: (\fIterminalmage\fP) Don\(aqt do pre\-flight check on git_pillar if it is not configured
.IP \(bu 2
\fI\%#25587\fP: (\fIcachedout\fP) Fix prereq in salt.state
.IP \(bu 2
\fI\%#25628\fP: (\fIanlutro\fP) Highstate output: show duration in seconds instead of milliseconds when appropriate
.IP \(bu 2
\fI\%#25631\fP: (\fIbasepi\fP) Remove trailing whitespace
.IP \(bu 2
\fI\%#25627\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#25626\fP: (\fIbasepi\fP) Fix the highstate outputter if \(aqduration\(aq is not present
.IP \(bu 2
\fI\%#25601\fP: (\fIterminalmage\fP) Fix error message when local bin pkg path is not absolute
.IP \(bu 2
\fI\%#25595\fP: (\fIterminalmage\fP) Bring git_pillar up to feature parity with gitfs
.IP \(bu 2
\fI\%#25619\fP: (\fIcachedout\fP) Lint stateconf changes
.IP \(bu 2
\fI\%#25578\fP: (\fIdavidjb\fP) Allow parent relative includes in state files
.IP \(bu 2
\fI\%#25610\fP: (\fIs0undt3ch\fP) [2015.8] Update the bootstrap script to latest release v2015.07.22
.IP \(bu 2
\fI\%#25599\fP: (\fIjfindlay\fP) fix transport settings in \fI\%#25596\fP
.IP \(bu 2
\fI\%#25596\fP: (\fIjfindlay\fP) Tcp test
.IP \(bu 2
\fI\%#25591\fP: (\fIgarethgreenaway\fP) Return data for scheduled jobs in 2015.8 default to True.
.IP \(bu 2
\fI\%#25588\fP: (\fIbasepi\fP) Fix some of the retcode work from \fI\%#23105\fP
.IP \(bu 2
\fI\%#25583\fP: (\fIjtand\fP) Fixed lint error where pprint wasn\(aqt imported.
.IP \(bu 2
\fI\%#25572\fP: (\fIrallytime\fP) Back\-port \fI\%#25570\fP to 2015.8
.IP \(bu 2
\fI\%#25575\fP: (\fIrallytime\fP) Make Sure Scaleway driver works with deprecation paths
.IP \(bu 2
\fI\%#25564\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#25566\fP: (\fItechhat\fP) Fix download process for SPM repo updates
.IP \(bu 2
\fI\%#25553\fP: (\fItechhat\fP) Switch SoftLayer to salt.utils.cloud.bootstrap()
.IP \(bu 2
\fI\%#25552\fP: (\fItechhat\fP) Update pricing for SoftlayerHW
.IP \(bu 2
\fI\%#25547\fP: (\fItechhat\fP) Switch Parallels to salt.utils.cloud.bootstrap()
.IP \(bu 2
\fI\%#25548\fP: (\fItechhat\fP) Switch Proxmox to salt.utils.cloud.bootstrap()
.IP \(bu 2
\fI\%#25543\fP: (\fItechhat\fP) Switch GCE to salt.utils.cloud.bootstrap()
.IP \(bu 2
\fI\%#25546\fP: (\fItechhat\fP) Switch CloudStack to salt.utils.cloud.bootstrap()
.IP \(bu 2
\fI\%#25558\fP: (\fIcachedout\fP) Lint config_test
.IP \(bu 2
\fI\%#25515\fP: (\fIs0undt3ch\fP) salt.utils.schema fixes
.IP \(bu 2
\fI\%#25514\fP: (\fIgarethgreenaway\fP) fixes to schedule.add documentation in 2015.8
.IP \(bu 2
\fI\%#25508\fP: (\fIs0undt3ch\fP) [2015.8] Update bootstrap script to latest stable release, v2015.07.17
.IP \(bu 2
\fI\%#25501\fP: (\fIbasepi\fP) Add optional job end time to the local_cache returner
.IP \(bu 2
\fI\%#25491\fP: (\fIs0undt3ch\fP) Let\(aqs call it for what it is!
.IP \(bu 2
\fI\%#25462\fP: (\fIrallytime\fP) Wrap is_profile_configrured calls in try/except block
.IP \(bu 2
\fI\%#25439\fP: (\fIrallytime\fP) Reduce digital_ocean API call frequency
.IP \(bu 2
\fI\%#25451\fP: (\fIs0undt3ch\fP) Salt\-SSH Scan roster bugfixes (And Py3 support)
.IP \(bu 2
\fI\%#25449\fP: (\fIruzarowski\fP) Exclude dotfiles and directories from minion key lists (Fixes \fI\%#25448\fP)
.IP \(bu 2
\fI\%#25421\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#25412\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#25415\fP: (\fIbechtoldt\fP) [docs] declare YAML as code block
.IP \(bu 2
\fI\%#25407\fP: (\fIrallytime\fP) Back\-port \fI\%#23236\fP to 2015.8
.IP \(bu 2
\fI\%#25409\fP: (\fIrallytime\fP) Back\-port \fI\%#24422\fP to 2015.8
.IP \(bu 2
\fI\%#25394\fP: (\fIrallytime\fP) Back\-port \fI\%#25355\fP to 2015.8
.IP \(bu 2
\fI\%#25393\fP: (\fIrallytime\fP) Back\-port \fI\%#25289\fP to 2015.8
.IP \(bu 2
\fI\%#25387\fP: (\fIcachedout\fP) Lint \fI\%#25319\fP
.IP \(bu 2
\fI\%#25319\fP: (\fIruzarowski\fP) [cloud:EC2] Move SourceDest logic to _update_enis and add  alias for delete_interface_on_terminate
.IP \(bu 2
\fI\%#25310\fP: (\fIanlutro\fP) Add an \(dqis list\(dq test to the jinja environment
.IP \(bu 2
\fI\%#25264\fP: (\fIruzarowski\fP) Fix AttributeError in fileserver update_opts
.IP \(bu 2
\fI\%#25372\fP: (\fIrallytime\fP) Don\(aqt stacktrace when provisioning instances with softlayer* drivers
.IP \(bu 2
\fI\%#25315\fP: (\fIruzarowski\fP) [cloud:EC2] Move handling of AssociatePublicIpAddress to associate_eip/allocate_new_eip logic depending on value type
.IP \(bu 2
\fI\%#25312\fP: (\fIruzarowski\fP) [cloud:EC2] Introduce eni Name property to set name tag value after its creation
.IP \(bu 2
\fI\%#25311\fP: (\fIruzarowski\fP) [cloud:EC2] Add ability to attach an existing eni
.IP \(bu 2
\fI\%#25280\fP: (\fIrallytime\fP) Remove deprecation warnings for Beryllium
.IP \(bu 2
\fI\%#25329\fP: (\fItwangboy\fP) Fixed some documentation errors
.IP \(bu 2
\fI\%#25300\fP: (\fIs0undt3ch\fP) Fix ordering issue & Added requirements support
.IP \(bu 2
\fI\%#25283\fP: (\fIjfindlay\fP) ensure ret is always defined
.IP \(bu 2
\fI\%#25252\fP: (\fIjfindlay\fP) make args optional with default values in win_firewall.delete_rule
.IP \(bu 2
\fI\%#25257\fP: (\fInotpeter\fP) Document SourceDestCheck added in \fI\%#25242\fP\&.
.IP \(bu 2
\fI\%#25298\fP: (\fItwangboy\fP) Continue if profile not found
.IP \(bu 2
\fI\%#25296\fP: (\fItwangboy\fP) Fixed file.comment for windows
.IP \(bu 2
\fI\%#25254\fP: (\fIrallytime\fP) Change versionadded/changed references from Beryllium to 2015.8.0
.IP \(bu 2
\fI\%#25285\fP: (\fIthusoy\fP) Remove error logging of missing victorops keys
.IP \(bu 2
\fI\%#25266\fP: (\fIruzarowski\fP) cloud: EC2 eni property SourceDestCheck is a AttributeBooleanValue
.IP \(bu 2
\fI\%#25216\fP: (\fIjfindlay\fP) replace shell code with native python code
.IP \(bu 2
\fI\%#25278\fP: (\fIrallytime\fP) Don\(aqt require size for all cloud drivers when checking profile configs
.IP \(bu 2
\fI\%#25271\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#25263\fP: (\fItechhat\fP) Allow non\-standard HTTP requests on tornado
.IP \(bu 2
\fI\%#25253\fP: (\fIs0undt3ch\fP) Remove the deprecation warning. The driver has been renamed.
.IP \(bu 2
\fI\%#25248\fP: (\fItechhat\fP) Do not resize while iterating
.IP \(bu 2
\fI\%#25244\fP: (\fIrallytime\fP) Remove parted deprecations and fix failing tests
.IP \(bu 2
\fI\%#25242\fP: (\fIruzarowski\fP) Make SourceDestCheck flag available to network interface definition
.IP \(bu 2
\fI\%#25226\fP: (\fInmadhok\fP) Backporting fix for issue \fI\%#25223\fP on 2015.8 branch
.IP \(bu 2
\fI\%#25234\fP: (\fIkrak3n\fP) Fix: Bug in boto_asg state argument passing to boto_asg module
.IP \(bu 2
\fI\%#25222\fP: (\fIrallytime\fP) Back\-port \fI\%#25219\fP to 2015.8
.IP \(bu 2
\fI\%#25188\fP: (\fIrallytime\fP) Use linode status descriptions instead of ints when logging status to CLI
.IP \(bu 2
\fI\%#25203\fP: (\fIs0undt3ch\fP) Added DictConfig with tests & More tests
.IP \(bu 2
\fI\%#25189\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fI\%#25184\fP: (\fIrallytime\fP) Back\-port \fI\%#25126\fP to 2015.8
.IP \(bu 2
\fI\%#25172\fP: (\fIs0undt3ch\fP) Comment out imports while the YAML and RST rendering is not in\-place.
.IP \(bu 2
\fI\%#25158\fP: (\fIs0undt3ch\fP) Comment out not implemented code
.IP \(bu 2
\fI\%#25145\fP: (\fIs0undt3ch\fP) Implement \fIoneOf\fP, \fIanyOf\fP, \fIallOf\fP and \fInot\fP with unit tests
.IP \(bu 2
\fI\%#25140\fP: (\fIs0undt3ch\fP) Make the detection code work under Python 3.4
.IP \(bu 2
\fI\%#25131\fP: (\fIs0undt3ch\fP) Array support in salt.utils.config
.IP \(bu 2
\fI\%#25130\fP: (\fIbasepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.UNINDENT
.sp
The 2015.8.0 feature release of Salt contains several major new features. As
usual the release notes are not exhaustive and primarily include the most
notable additions and improvements. Hundreds of bugs have been fixed and many
modules have been substantially updated and added.
.SS New SaltStack Installation Repositories
.sp
SaltStack now provides installation repositories for several platforms, with more to come.
For instructions, see: \fI\%repo.saltstack.com\fP\&.
.SS Send Event on State Completion
.sp
A \fBfire_event\fP global state keyword argument was added that allows any state to
send an event upon completion. Useful for custom progress bars and checking in
on long state runs. See \fI\%fire_event\fP\&.
.SS ZeroMQ socket monitoring
.sp
If \fBzmq_monitor\fP is enabled, log all ZMQ events for socket monitoring
purposes. Verbose, but useful.
.SS SPM (Salt Package Manager)
.sp
Allows Salt formulas to be packaged for ease of deployment. See \fI\%spm\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The spm executable was not included in the Debian or Ubuntu packages for the
2015.8.0 or the 2015.8.1 releases. This executable will be included in an
upcoming release. As a workaround, copy the SPM script from the salt library
installation into \fB/usr/local/bin\fP or your local equivalent.
.UNINDENT
.UNINDENT
.SS Specify a Single Environment for Top Files
.sp
A new \fBdefault_top\fP option was added to load the state top file
from a single, specific environment, rather than merging top data across all
environments. Additionally, new \fBtop_file_merge_strategy\fP and
\fI\%env_order\fP options were added for more control over top file
merging. See \fI\%The Top File\fP\&.
.SS Tornado TCP Transport
.sp
Implemented a pure\-TCP transport, in addition to ZeroMQ and RAET. The new
transport uses Tornado, which allows Salt to use a standardized set of libraries
for asynchronous behavior, which should greatly improve reliability and
performance.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Tornado is considered expiremental in this release. The following known
issues were being investigated at the time of release:
.INDENT 0.0
.IP \(bu 2
TCP tests show performance degredation over time (\fI\%issue 26051\fP)
.IP \(bu 2
TCP transport stacktrace on windows minion: Future exception was never
retrieved (\fI\%issue 25718\fP)
.IP \(bu 2
[freebsd] TCP transport not working in 2015.8.0rc3 (\fI\%issue 26364\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.SS Proxy Minion Enhancements
.sp
Proxy Minions have undergone a significant overhaul in 2015.8, see \fI\%Proxy Minion Enhancements\fP\&.
.SS Engines
.sp
Salt engines are long\-running, external processes that leverage Salt. See \fI\%Salt Engines\fP\&.
.SS Core Changes
.INDENT 0.0
.IP \(bu 2
Add system version info to \fBversions_report\fP, which appears in both \fBsalt
\-\-versions\-report\fP and \fBsalt \(aq*\(aq test.versions_report\fP\&. Also added is an
alias \fBtest.versions\fP to \fBtest.versions_report\fP\&. (\fI\%issue 21906\fP)
.IP \(bu 2
Add colorized console logging support.  This is activated by using
\fB%(colorlevel)s\fP, \fB%(colorname)s\fP, \fB%(colorprocess)s\fP, \fB%(colormsg)s\fP
in \fBlog_fmt_console\fP in the config file for any of \fBsalt\-master\fP,
\fBsalt\-minion\fP, and \fBsalt\-cloud\fP\&.
.UNINDENT
.SS Git Pillar
.sp
The git external pillar has been rewritten to bring it up to feature parity
with \fI\%gitfs\fP\&. Support for \fI\%pygit2\fP has been added,
bringing with it the ability to access authenticated repositories.
.sp
Using the new features will require updates to the git ext_pillar
configuration, further details can be found in the \fI\%pillar.git_pillar\fP docs.
.SS Salt Cloud Improvements
.INDENT 0.0
.IP \(bu 2
Pricing data from several cloud providers (GCE, DigitalOcean, SoftLayer_HW, EC2)
.IP \(bu 2
All cloud providers now use standardized bootstrapping code.
.IP \(bu 2
Modified the Linode Salt Cloud driver to use Linode\(aqs native API instead of
depending on apache\-libcloud or linode\-python.
.UNINDENT
.SS Salt Cloud Changes
.INDENT 0.0
.IP \(bu 2
Changed the default behavior of \fBrename_on_destroy\fP to be set to \fBTrue\fP
in the EC2 and AWS drivers.
.IP \(bu 2
Changed the default behavior of the EC2 and AWS drivers to always check for
duplicate names of VMs before trying to create a new VM. Will now throw an
error similarly to other salt\-cloud drivers when trying to create a VM of the
same name, even if the VM is in the \fBterminated\fP state.
.IP \(bu 2
When querying for VMs in \fBdigital_ocean.py\fP, the number of VMs to include in
a page was changed from 20 (default) to 200 to reduce the number of API calls
to Digital Ocean.Ocean.
.UNINDENT
.SS State and Execution Module Improvements
.INDENT 0.0
.IP \(bu 2
New and improved Docker state and execution modules (\fBstate\fP and \fBexecution module\fP).
.UNINDENT
.SS Git State and Execution Modules Rewritten
.sp
The git state and execution modules have gone through an extensive overhaul.
.SS Changes in the \fI\%git.latest\fP State
.INDENT 0.0
.IP \(bu 2
The \fBbranch\fP argument has been added, allowing for a custom branch name to
be used in the local checkout maintained by the \fI\%git.latest\fP state. This can be helpful in avoiding ambiguous
refs in the local checkout when a tag is used as the \fBrev\fP argument. If no
\fBbranch\fP is specified, then the state uses the value of \fBrev\fP as the
branch name.
.IP \(bu 2
The \fBalways_fetch\fP argument no longer has any effect, and will be removed
in a future release. The state now detects whether or not a fetch is needed
based on comparisons made between the local and remote repositories.
.IP \(bu 2
The \fBforce_fetch\fP argument has been added to force a fetch if the fetch is
not a fast\-forward (for instance, if someone has done a reset and
force\-pushed to the remote repository).
.IP \(bu 2
The \fBremote_name\fP argument has been deprecated and renamed to \fBremote\fP\&.
.IP \(bu 2
The \fBforce\fP argument has been deprecated and renamed to \fBforce_clone\fP to
reduce ambiguity with the other \(dqforce\(dq arguments.
.IP \(bu 2
Using SHA1 hashes (full or shortened) in the \fBrev\fP argument is now
properly supported.
.IP \(bu 2
Non\-fast\-forward merges are now detected before the repository is updated,
and the state will not update the repository if the change is not a
fast\-forward. Non\-fast\-forward updates must be overridden with the
\fBforce_reset\fP argument. If \fBforce_reset\fP is set to \fBTrue\fP, the state
will only reset the repository if it cannot be fast\-forwarded. This is in
contrast to the earlier behavior, in which a hard\-reset would be performed
every time the state was run if \fBforce_reset\fP was set to \fBTrue\fP\&.
.IP \(bu 2
A \fBgit pull\fP is no longer performed by this state, dropped in favor of a
fetch\-and\-merge (or fetch\-and\-reset) workflow.
.UNINDENT
.SS \fI\%git.config_unset\fP state added
.sp
This state allows for configuration values (or entire keys) to be unset. See
\fI\%here\fP for more information and example
SLS.
.SS git.config State Renamed to \fI\%git.config_set\fP
.sp
To reduce confusion after the addition of \fI\%git.config_unset\fP, the git.config state has been renamed to
\fI\%git.config_set\fP\&. The old config.get name
will still work for a couple releases, allowing time for SLS files to be
updated.
.sp
In addition, this state now supports managing multivar git configuration
values. See \fI\%here\fP for more information
and example SLS.
.SS Initial Support for Git Worktrees in Execution Module
.sp
Several functions have been added to the execution module to manage \fI\%worktrees\fP
(a feature new to Git 2.5.0). State support does not exist yet, but will follow
soon.
.SS New Functions in Git Execution Module
.INDENT 0.0
.IP \(bu 2
\fBgit.config_get_regexp\fP
.IP \(bu 2
\fI\%git.config_unset\fP
.IP \(bu 2
\fI\%git.is_worktree\fP
.IP \(bu 2
\fI\%git.list_branches\fP
.IP \(bu 2
\fI\%git.list_tags\fP
.IP \(bu 2
\fI\%git.list_worktrees\fP
.IP \(bu 2
\fI\%git.merge_base\fP
.IP \(bu 2
\fI\%git.merge_tree\fP
.IP \(bu 2
\fI\%git.rev_parse\fP
.IP \(bu 2
\fI\%git.version\fP
.IP \(bu 2
\fI\%git.worktree_rm\fP
.IP \(bu 2
\fI\%git.worktree_add\fP
.IP \(bu 2
\fI\%git.worktree_prune\fP
.UNINDENT
.SS Changes to Functions in Git Execution Module
.SS \fBgit.add\fP
.INDENT 0.0
.IP \(bu 2
\fB\-\-verbose\fP is now implied when running the \fBgit add\fP command, to provide
a list of the files added in the return data.
.UNINDENT
.SS \fI\%git.archive\fP
.INDENT 0.0
.IP \(bu 2
Now returns \fBTrue\fP when the \fBgit archive\fP command was successful, and
otherwise raises an error.
.IP \(bu 2
The \fBoverwrite\fP argument has been added to prevent an existing archive from
being overwritten by this function.
.IP \(bu 2
The \fBfmt\fP argument has been deprecated and renamed to \fBformat\fP\&.
.IP \(bu 2
Trailing slash no longer implied in \fBprefix\fP argument, must be included if
this argument is passed.
.UNINDENT
.SS \fI\%git.checkout\fP
.INDENT 0.0
.IP \(bu 2
The \fBrev\fP argument is now optional when using \fB\-b\fP or \fB\-B\fP in \fBopts\fP,
allowing for a branch to be created (or reset) using \fBHEAD\fP as the starting
point.
.UNINDENT
.SS \fI\%git.clone\fP
.INDENT 0.0
.IP \(bu 2
The \fBname\fP argument has been added to specify the name of the directory in
which to clone the repository. If this option is specified, then the clone
will be made within the directory specified by the \fBcwd\fP, instead of at
that location.
.IP \(bu 2
The \fBrepository\fP argument has been deprecated and renamed to \fBurl\fP\&.
.UNINDENT
.SS \fI\%git.config_get\fP
.INDENT 0.0
.IP \(bu 2
The \fBsetting_name\fP argument has been deprecated and renamed to \fBkey\fP\&.
.IP \(bu 2
The \fBglobal\fP argument has been added, to query the global git configuration
.IP \(bu 2
The \fBall\fP argument has been added to return a list of all values for the
specified key, allowing for all values in a multivar to be returned.
.IP \(bu 2
The \fBcwd\fP argument is now optional if \fBglobal\fP is set to \fBTrue\fP
.UNINDENT
.SS \fI\%git.config_set\fP
.INDENT 0.0
.IP \(bu 2
The value(s) of the key being set are now returned
.IP \(bu 2
The \fBsetting_name\fP argument has been deprecated and renamed to \fBkey\fP\&.
.IP \(bu 2
The \fBsetting_value\fP argument has been deprecated and renamed to \fBvalue\fP\&.
.IP \(bu 2
The \fBis_global\fP argument has been deprecated and renamed to \fBglobal\fP\&.
.IP \(bu 2
The \fBmultivar\fP argument has been added to specify a list of values to set
for the specified key. The \fBvalue\fP argument is not compatible with
\fBmultivar\fP\&.
.IP \(bu 2
The \fBadd\fP argument has been added to add a value to a key (this essentially
just adds an \fB\-\-add\fP to the \fBgit config\fP command that is run to set the
value).
.UNINDENT
.SS \fI\%git.fetch\fP
.INDENT 0.0
.IP \(bu 2
The \fBforce\fP argument has been added to force the fetch when it is not a
fast\-forward. This could have been achieved in previous Salt versions by
including \fB\-\-force\fP in the \fBopts\fP argument, this argument is just for
convenience and to match the usage of other functions with \fBforce\fP
arguments.
.IP \(bu 2
The \fBrefspecs\fP argument has been added to allow for one or more refspecs to
be provided which override the one(s) specified by the
\fBremote.remote_name.fetch\fP git configuration option.
.UNINDENT
.SS \fI\%git.ls_remote\fP
.INDENT 0.0
.IP \(bu 2
The \fBrepository\fP argument has been deprecated and renamed to \fBremote\fP\&.
.IP \(bu 2
The \fBbranch\fP argument has been deprecated and renamed to \fBref\fP\&.
.IP \(bu 2
The \fBopts\fP argument has been added to allow for additional CLI options to
be passed to the \fBgit ls\-remote\fP command.
.UNINDENT
.SS \fI\%git.merge\fP
.INDENT 0.0
.IP \(bu 2
The \fBbranch\fP argument has been deprecated and renamed to \fBrev\fP\&.
.UNINDENT
.SS \fI\%git.status\fP
.INDENT 0.0
.IP \(bu 2
Return data has been changed from a list of lists to a dictionary containing
lists of files in the modified, added, deleted, and untracked states.
.UNINDENT
.SS \fI\%git.submodule\fP
.INDENT 0.0
.IP \(bu 2
Added the \fBcommand\fP argument to allow for operations other than \fBupdate\fP
to be run on submodules, and deprecated the \fBinit\fP argument. To do a
submodule update with \fBinit=True\fP moving forward, use \fBcommand=update
opts=\(aq\-\-init\(aq\fP\&.
.UNINDENT
.INDENT 0.0
.IP \(bu 2
OpenStack Glance API V2 execution module
.IP \(bu 2
Amazon VPC state module
.IP \(bu 2
RallyDev execution module
.IP \(bu 2
BambooHR execution module
.IP \(bu 2
Stormpath execution, state modules
.IP \(bu 2
Remove unused argument \fBtimeout\fP in jboss7.status.
.IP \(bu 2
Deprecate \fBenabled\fP argument in \fBpkgrepo.managed\fP in favor of \fBdisabled\fP\&.
.IP \(bu 2
Archive module changes: In the \fBarchive.tar\fP and \fBarchive.cmd_unzip\fP
module functions, remove the arbitrary prefixing of the options string with
\fB\-\fP\&. An options string beginning with a \fB\-\-long\-option\fP, would have
uncharacteristically needed its first \fB\-\fP removed under the former scheme.
Also, tar will parse its options differently if short options are used with or
without a preceding \fB\-\fP, so it is better to not confuse the user into
thinking they\(aqre using the non\- \fB\-\fP format, when really they are using the
with\- \fB\-\fP format.
.IP \(bu 2
Added \fB__states__\fP to state modules, for cross\-calling states. This enables
using existing states when writing custom states. See \fI\%cross calling states\fP\&.
.UNINDENT
.SS Windows Improvements
.INDENT 0.0
.IP \(bu 2
Enhanced the windows minion silent installation with command line parameters
to configure the salt master and minion name.
.IP \(bu 2
Improved user management with additional capabilities in the user module for Windows.
.IP \(bu 2
Improved patch management with a new module for managing windows updates (\fBwin_wua\fP).
.IP \(bu 2
Turned on multi\-processing by default for windows in minion configuration.
.UNINDENT
.SS Windows Software Repo Changes
.sp
A next\-generation (ng) windows software repo is available for 2015.8.0 and
later minions. When using this new repository, the repo cache is compiled on
the Salt Minion, which enables pillar, grains and other things to be available
during compilation time.
.sp
See the Windows Software Repository documentation for more information.
.SS Changes to legacy Windows repository
.sp
If you have pre 2015.8 Windows minions connecting to your 2015.8 Salt master, you
can continue to use the legacy Windows repository for these Salt minions.
.sp
If you were previously using this repository and have customized settings, be
aware that several config options have been renamed to make their naming more
consistent.
.sp
See the Windows Software Repository documentation for more information.
.SS Win System Module
.sp
The unit of the \fBtimeout\fP parameter in the \fBsystem.halt\fP,
\fBsystem.poweroff\fP, \fBsystem.reboot\fP,  and \fBsystem.shutdown\fP functions has
been changed from seconds to minutes in order to be consistent with the linux
timeout setting. (\fI\%issue 24411\fP)  Optionally, the unit can be reverted to
seconds by specifying \fBin_seconds=True\fP\&.
.SS Other Improvements
.INDENT 0.0
.IP \(bu 2
Sanitize sensitive fields in http.query
.IP \(bu 2
Allow authorization to be read from Django and eauth
.IP \(bu 2
Add templating to SMTP returner
.IP \(bu 2
New REST module for SDB
.IP \(bu 2
Added rest_timeout config option and timeout argument to jobs api call
.IP \(bu 2
Provide config options for Raet lane and road buffer count. (Useful for BSD kernels)
.IP \(bu 2
Implemented ZeroMQ socket monitor for master and minion
.IP \(bu 2
Add end time to master job cache for jobs (optional, off by default)
.IP \(bu 2
Tornado is now the default backend for http.request
.IP \(bu 2
Support pillarenv selection as it\(aqs done for saltenv
.IP \(bu 2
salt was updated to use python\-crypto version 2.6.1, which removes the dependency on python\-m2crypto.
.UNINDENT
.SS Deprecations
.INDENT 0.0
.IP \(bu 2
The \fBdigital_ocean.py\fP Salt Cloud driver was removed in favor of the
\fBdigital_ocean_v2.py\fP driver as DigitalOcean has removed support for APIv1.
The \fBdigital_ocean_v2.py\fP was renamed to \fBdigital_ocean.py\fP and supports
DigitalOcean\(aqs APIv2.
.IP \(bu 2
The \fBvsphere.py\fP Salt Cloud driver has been deprecated in favor of the
\fBvmware.py\fP driver.
.IP \(bu 2
The \fBopenstack.py\fP Salt Cloud driver has been deprecated in favor of the
\fBnova.py\fP driver.
.IP \(bu 2
The use of \fBprovider\fP in Salt Cloud provider files to define cloud drivers
has been deprecated in favor of using \fBdriver\fP\&. Both terms will work until
the 2017.7.0 release of Salt. Example provider file:
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my\-ec2\-cloud\-config:
  id: \(aqHJGRYCILJLKJYG\(aq
  key: \(aqkdjgfsgm;woormgl/aserigjksjdhasdfgn\(aq
  private_key: /etc/salt/my_test_key.pem
  keyname: my_test_key
  securitygroup: default
  driver: ec2
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
The use of \fBlock\fP has been deprecated and from \fBsalt.utils.fopen\fP\&.
\fBsalt.utils.flopen\fP should be used instead.
.IP \(bu 2
The following args have been deprecated from the \fBrabbitmq_vhost.present\fP
state: \fBuser\fP, \fBowner\fP, \fBconf\fP, \fBwrite\fP, \fBread\fP, and \fBrunas\fP\&.
.IP \(bu 2
The use of \fBrunas\fP has been deprecated from the \fBrabbitmq_vhost.absent\fP
state.
.IP \(bu 2
Support for \fBoutput\fP in \fBmine.get\fP was removed. \fB\-\-out\fP should be used
instead.
.IP \(bu 2
The use of \fBdelim\fP was removed from the following functions in the \fBmatch\fP
execution module: \fBpillar_pcre\fP, \fBpillar\fP, \fBgrain_pcre\fP,
.UNINDENT
.SS Security Fixes
.sp
CVE\-2015\-6918 \- Git modules leaking HTTPS auth credentials to debug log
.sp
Updated the Git state and execution modules to no longer display HTTPS basic authentication credentials in loglevel debug output on the Salt master. These credentials are now replaced with \fBREDACTED\fP in the debug output. Thanks to Andreas Stieger <\fI\%asteiger@suse.com\fP> for bringing this to our attention.
.SS Major Bug Fixes
.INDENT 0.0
.IP \(bu 2
Fixed minion failover to next master on DNS errors (\fI\%issue 21082\fP)
.IP \(bu 2
Fixed memory consumption in SaltEvents (\fI\%issue 25557\fP)
.IP \(bu 2
Don\(aqt lookup outside system path in which() util (\fI\%issue 24085\fP)
.IP \(bu 2
Fixed broken jobs rest api call (\fI\%issue 23408\fP)
.IP \(bu 2
Fixed stale grains data using in modules (\fI\%issue 24073\fP)
.IP \(bu 2
Added ssh_identities_only config flag for ssh\-agent configured environments
(\fI\%issue 24096\fP)
.IP \(bu 2
Fixed \(dqobject has no attribute\(dq errors for Raet transport (\fI\%issue 21640\fP)
.IP \(bu 2
Flush event returners before master exit (\fI\%issue 22814\fP)
.IP \(bu 2
Fix CommandExecutionError in grains generation with lspci missing (\fI\%issue 23342\fP)
.IP \(bu 2
Fix salt\-ssh against CentOS 7 when python\-zmq not installed (\fI\%issue 23503\fP)
.IP \(bu 2
Fix salt\-ssh issues related to out\-of\-date six module (\fI\%issue 20949\fP)
.IP \(bu 2
Fix salt\-ssh thin generation after previous run was interrupted (\fI\%issue 24376\fP)
.IP \(bu 2
Use proper line endings on Windows with \(dqfile.managed\(dq w/contents (\fI\%issue 25675\fP)
.IP \(bu 2
Fixed broken comment/uncomment functions in file.py (\fI\%issue 24620\fP)
.IP \(bu 2
Fixed problem with unicode when changing computer description (\fI\%issue 12255\fP)
.IP \(bu 2
Fixed problem with chocolatey module not loading (\fI\%issue 25717\fP)
.IP \(bu 2
Fixed problem adding users to groups with spaces in the name (\fI\%issue 25144\fP)
.IP \(bu 2
Fixed problem adding full name to user account (\fI\%issue 25206\fP)
.IP \(bu 2
Fixed gem module stack trace (\fI\%issue 21041\fP)
.IP \(bu 2
Fixed problem with file.managed when test=True (\fI\%issue 20441\fP)
.IP \(bu 2
Fixed problem with powershell hanging while waiting for user input (\fI\%issue 13943\fP)
.IP \(bu 2
Fixed problem where the salt\-minion service would not consistently start
(\fI\%issue 25272\fP)
.IP \(bu 2
Fixed problem where pkg.refresh_db would return True even when winrepo.p was not
found (\fI\%issue 18919\fP)
.IP \(bu 2
Could someone please provide end to end example for Proxy Minion with REST
(\fI\%issue 25500\fP)
.IP \(bu 2
Proxy minions stopped working between 2014.7 and 2015.5 (\fI\%issue 25053\fP)
.IP \(bu 2
Proxy minion documentation includes outdated code sample (\fI\%issue 24018\fP)
.IP \(bu 2
Proxy Minion documentation missing grains example (\fI\%issue 18273\fP)
.IP \(bu 2
Improve process management in proxy minion (\fI\%issue 12024\fP)
.IP \(bu 2
Proxy minion never comes up with message \(aq I am XXX and I am not supposed to
start any proxies.\(aq (\fI\%issue 25908\fP)
.IP \(bu 2
Fixed an issue that caused an exception when using Salt mine from pillar. (\fI\%issue 11509\fP)
.UNINDENT
.SS Salt 2015.8.1 Release Notes
.sp
Version 2015.8.1 is a bugfix release for \fI\%2015.8.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB201\fP
.IP \(bu 2
Total Issue References: \fB39\fP
.IP \(bu 2
Total PR References: \fB135\fP
.IP \(bu 2
Contributors: \fB40\fP (\fI\%DmitryKuzmenko\fP, \fI\%The\-Loeki\fP, \fI\%TheBigBear\fP, \fI\%basepi\fP, \fI\%bechtoldt\fP,
\fI\%bernieke\fP, \fI\%blueyed\fP, \fI\%cachedout\fP, \fI\%cedwards\fP, \fI\%clinta\fP, \fI\%cro\fP, \fI\%deuscapturus\fP,
\fI\%dmurphy18\fP, \fI\%dsumsky\fP, \fI\%eliasp\fP, \fI\%flowhamster\fP, \fI\%isbm\fP, \fI\%jacksontj\fP, \fI\%jacobhammons\fP,
\fI\%jfindlay\fP, \fI\%justinta\fP, \fI\%l2ol33rt\fP, \fI\%macgyver13\fP, \fI\%meggiebot\fP, \fI\%msteed\fP, \fI\%multani\fP,
\fI\%nasenbaer13\fP, \fI\%perfinion\fP, \fI\%pprkut\fP, \fI\%rallytime\fP, \fI\%rhealitycheck\fP, \fI\%ruzarowski\fP,
\fI\%ryan\-lane\fP, \fI\%s0undt3ch\fP, \fI\%systembell\fP, \fI\%techhat\fP, \fI\%terminalmage\fP, \fI\%ticosax\fP, \fI\%twangboy\fP,
\fI\%whiteinge\fP)
.UNINDENT
.SS Security Fixes
.sp
\fBCVE\-2015\-6941\fP The Windows \fI\%user\fP module and
\fBsalt\-cloud\fP display passwords in log when log level is set to \fBdebug\fP
or more verbose.
.sp
For the Windows \fI\%user\fP module, the password is
now replaced with the string \fBXXX\-REDACTED\-XXX\fP\&.
.sp
For salt\-cloud, debug logging no longer displays \fBwin_password\fP and
\fBsudo_password\fP authentication credentials.
.sp
\fBCVE\-2015\-6918\fP Git state/execution modules log HTTPS auth credentials when
log level is set to \fBdebug\fP or more verbose.
.sp
These credentials are now replaced with \fBREDACTED\fP in the debug output.
Thanks to Andreas Stieger <\fI\%asteiger@suse.com\fP> for bringing this to our
attention.
.SS Major Bug Fixes
.INDENT 0.0
.IP \(bu 2
Add support for \fBspm.d/*.conf\fP configuration of SPM (\fI\%issue 27010\fP)
.IP \(bu 2
Fix \fBproxy\fP grains breakage for non\-proxy minions (\fI\%issue 27039\fP)
.IP \(bu 2
Fix global key management for git state
.IP \(bu 2
Fix passing http auth to \fButil.http\fP from \fBstate.file\fP (\fI\%issue 21917\fP)
.IP \(bu 2
Fix \fBmultiprocessing: True\fP in windows (on by default\(ga)
.IP \(bu 2
Add \fBpkg.info\fP to pkg modules
.IP \(bu 2
Fix name of \fBserial\fP grain (this was accidentally renamed in 2015.8.0\(ga)
.IP \(bu 2
Merge config values from \fBmaster.d\fP/\fBminion.d\fP conf files (rather than flat update\(ga)
.IP \(bu 2
Clean grains cache on grains sync (\fI\%issue 19853\fP)
.IP \(bu 2
Remove streamed response for fileclient to avoid HTTP redirection problems (\fI\%issue 27093\fP)
.IP \(bu 2
Fixed incorrect warning about \fBosrelease\fP grain (\fI\%issue 27065\fP)
.IP \(bu 2
Fix authentication via Salt\-API with tokens (\fI\%issue 27270\fP)
.IP \(bu 2
Fix winrepo downloads from https locations (\fI\%issue 27081\fP)
.IP \(bu 2
Fix potential error with salt\-call as non\-root user (\fI\%issue 26889\fP)
.IP \(bu 2
Fix global minion provider overrides (\fI\%issue 27209\fP)
.IP \(bu 2
Fix backward compatibility issues for pecl modules
.IP \(bu 2
Fix Windows uninstaller to only remove \fB\&./bin\fP, \fBsalt*\fP, \fBnssm.exe\fP, \fBuninst.exe\fP (\fI\%issue 27383\fP)
.IP \(bu 2
Fix misc issues with mongo returner.
.IP \(bu 2
Add sudo option to cloud config files (\fI\%issue 27398\fP)
.IP \(bu 2
Fix regression in RunnerClient argument handling (\fI\%issue 25107\fP)
.IP \(bu 2
Fix \fBdockerng.running\fP replacing creation hostconfig with runtime hostconfig (\fI\%issue 27265\fP)
.IP \(bu 2
Fix dockerng.running replacing creation hostconfig with runtime hostconfig (\fI\%issue 27265\fP)
.IP \(bu 2
Increased performance on boto asg/elb states due to \fB__states__\fP integration
.IP \(bu 2
Windows minion no longer requires powershell to restart (\fI\%issue 26629\fP)
.IP \(bu 2
Fix x509 module to support recent versions of OpenSSL (\fI\%issue 27326\fP)
.IP \(bu 2
Some issues with proxy minions were corrected.
.UNINDENT
.SS Known Issues
.INDENT 0.0
.IP \(bu 2
Proxy minions currently cannot execute a highstate because of the way
the proxymodule is being loaded internally.  This will be fixed in a
future release.
.UNINDENT
.SS Changelog for v2015.8.0..v2015.8.1
.sp
\fIGenerated at: 2018\-05\-27 22:48:32 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#27588\fP: (\fI\%jfindlay\fP) add autogenerated 2015.8.1 release notes
@ \fI2015\-10\-01 04:52:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
87d86e4b3e Merge pull request \fI\%#27588\fP from jfindlay/2015.8
.IP \(bu 2
f2eb20f26b add autogenerated 2015.8.1 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27584\fP: (\fI\%jacobhammons\fP) added changes list to 2015.8.1 release notes
@ \fI2015\-10\-01 04:32:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
f7510baf33 Merge pull request \fI\%#27584\fP from jacobhammons/release\-notes
.IP \(bu 2
ee4a3b3549 added changes list for 2015.8.1
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27532\fP: (\fI\%centromere\fP) salt\-cloud does not recognize terminated instances (refs: \fI\%#27575\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27575\fP: (\fI\%rallytime\fP) Don\(aqt report existing instances as running only if they\(aqre actually terminated in EC2
@ \fI2015\-09\-30 22:17:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a31b19f15 Merge pull request \fI\%#27575\fP from rallytime/fix\-27532
.IP \(bu 2
57c6535fc2 Make sure message is the most accurate. Instance may be stopped or shutting down.
.IP \(bu 2
da6b4b3604 Don\(aqt report existing instances as running only if they\(aqre actually terminated
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27290\fP: (\fI\%pirogoeth\fP) Grains set in minion_opts do not appear in a call to \fIgrains.items\fP\&. (refs: \fI\%#27573\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27573\fP: (\fI\%basepi\fP) [2015.8] Use the custom yaml serializer for minion_opts for salt\-ssh
@ \fI2015\-09\-30 21:16:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
bee78a4e5c Merge pull request \fI\%#27573\fP from basepi/salt\-ssh.grains.minion_opts.27290
.IP \(bu 2
0785438b3f Use the custom yaml serializer for minion_opts for salt\-ssh
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27326\fP: (\fI\%ralphvanetten\fP) Signing the X509 CA certificate does not work on Debian 8 (refs: \fI\%#27514\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27514\fP: (\fI\%clinta\fP) Recent Versions of OpenSSL don\(aqt allow importing incomplete PEMs
@ \fI2015\-09\-30 19:33:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
a4a53ecff5 Merge pull request \fI\%#27514\fP from clinta/2015.8\-27326
.IP \(bu 2
515e62bfa7 change \(dqNone\(dq to empty string
.IP \(bu 2
2989f24169 fix 27326 and fix minor errors in docs.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27564\fP: (\fI\%jacobhammons\fP) Man pages
@ \fI2015\-09\-30 19:29:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
6cf0228adc Merge pull request \fI\%#27564\fP from jacobhammons/man\-pages
.IP \(bu 2
cc37dc1087 updated version in salt.7
.IP \(bu 2
a9dcb23a13 regenerated man pages for 2015.8.1
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26629\fP: (\fI\%efficks\fP) Windows minion: Remove powershell dependencies (refs: \fI\%#27522\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27522\fP: (\fI\%twangboy\fP) Removed dependency on powershell to restart salt\-minion
@ \fI2015\-09\-30 16:19:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd11e0cd95 Merge pull request \fI\%#27522\fP from twangboy/fix_26629
.IP \(bu 2
163c54505d Fixed tests... hopefully
.IP \(bu 2
dc8c01ed07 Fixed some lint
.IP \(bu 2
2cb0f12696 Removed dependency on powershell to restart salt\-minion
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27550\fP: (\fI\%rallytime\fP) [2015.8] Clean up salt\-cloud logging and make it more useful
@ \fI2015\-09\-30 15:48:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
eb76531e96 Merge pull request \fI\%#27550\fP from rallytime/cloud\-logging
.IP \(bu 2
9e0fccd543 Don\(aqt commit private\-ip changes from testing another bug...
.IP \(bu 2
78c85fbb31 Add unit tests for new recursive function
.IP \(bu 2
d9a2dc6bc5 [2015.8] Clean up salt\-cloud logging and make it more useful
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27281\fP: (\fI\%lrhazi\fP) Wrong path for yum repo in installation\-rhel\-repo (refs: \fI\%#27517\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27179\fP: (\fI\%samhamilton\fP) Debian Install Instructions Shows Two Different Repos (refs: \fI\%#27517\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27517\fP: (\fI\%jacobhammons\fP) Updated install docs
@ \fI2015\-09\-30 15:19:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f7ea7c764 Merge pull request \fI\%#27517\fP from jacobhammons/install\-docs
.IP \(bu 2
167fd2304e Fixed a duplicated link ID
.IP \(bu 2
c05fa71f91 Updated install docs Refs \fI\%#27281\fP Refs \fI\%#27179\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27526\fP: (\fI\%eliasp\fP) Add missing newlines before param listing to fix doc rendering
@ \fI2015\-09\-30 15:19:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
2a4c11ae24 Merge pull request \fI\%#27526\fP from eliasp/2015.8\-modules.slack_notify\-doc\-params
.IP \(bu 2
204e66943f Add missing newlines before param listing to fix doc rendering
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27525\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-09\-30 03:38:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
e5de9409c2 Merge pull request \fI\%#27525\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
1f3eb1c526 Remove useless mocked unit test
.IP \(bu 2
73b90f155e Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
6d773f66c3 Merge pull request \fI\%#27516\fP from basepi/merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
a08951f0fa Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
5262f01325 Merge pull request \fI\%#27335\fP from rallytime/cloud\-logging\-7
.INDENT 2.0
.IP \(bu 2
adeb1dcad4 Pylint Fix
.IP \(bu 2
588c13783c Salt\-cloud logging clean up for windows functions
.IP \(bu 2
9b6000135c [2014.7] Fixup salt\-cloud logging
.UNINDENT
.UNINDENT
.IP \(bu 2
68d784c3dd Merge pull request \fI\%#27472\fP from cachedout/fix_27447
.INDENT 2.0
.IP \(bu 2
5e745ad6da Change recommended schema for data field in mysql event table
.UNINDENT
.IP \(bu 2
ee6e0ed057 Merge pull request \fI\%#27468\fP from cachedout/fix_27351
.INDENT 2.0
.IP \(bu 2
0bc37c0d41 Fix test
.IP \(bu 2
f9a19720de fix sysctl truncating newline on os x
.UNINDENT
.IP \(bu 2
a214c7f84e Merge pull request \fI\%#27479\fP from aboe76/fix_locale_suse
.INDENT 2.0
.IP \(bu 2
a8f2dad1be fix locale on opensuse and suse \fI\%#27438\fP
.UNINDENT
.IP \(bu 2
931f593b51 Merge pull request \fI\%#27483\fP from rallytime/fix\-17103
.INDENT 2.0
.IP \(bu 2
441241eb90 Change sync_outputters to sync_output for consistency, but alias sync_outputters
.IP \(bu 2
105528720b Outputters should sync to output, not outputters, on the minion.
.UNINDENT
.IP \(bu 2
9c2c028953 Merge pull request \fI\%#27484\fP from rallytime/bp\-27434\-and\-27470
.INDENT 2.0
.IP \(bu 2
5de2ee35ab Minor doc fixup.
.IP \(bu 2
af656c7e87 Doc: copy key to server via ssh\-copy\-id
.UNINDENT
.IP \(bu 2
927874d316 Merge pull request \fI\%#27469\fP from twangboy/fix_27433
.INDENT 2.0
.IP \(bu 2
a996ea46e2 Added quotes to version numbers example
.UNINDENT
.IP \(bu 2
382a53403f Merge pull request \fI\%#27467\fP from cachedout/lint_27375
.INDENT 2.0
.IP \(bu 2
4e54a98f5e Lint \fI\%#27375\fP
.IP \(bu 2
278ade52d2 file.managed: check contents_{pillar|grain} result
.UNINDENT
.IP \(bu 2
ed6207a438 Merge pull request \fI\%#27419\fP from rallytime/fix\-9856
.INDENT 2.0
.IP \(bu 2
551396564a Amend error log to include multiple tips for troubleshooting.
.UNINDENT
.IP \(bu 2
73fa89edf7 Merge pull request \fI\%#27426\fP from rallytime/fix\-16753
.INDENT 2.0
.IP \(bu 2
f6cbd81e66 Don\(aqt stacktrace if there are conflicting id errors in highstate
.UNINDENT
.IP \(bu 2
5dd1b70475 Merge pull request \fI\%#27408\fP from rallytime/fix\-27406\-for\-2015.5
.INDENT 2.0
.IP \(bu 2
39a4ae5a6c Remove hdd: 19 refs from SL docs \- no longer available from SoftLayer.
.IP \(bu 2
de2f9234d3 Use correct default for bandwidth
.IP \(bu 2
42d8127f79 Don\(aqt set the optional_products default to a boolean, and then try to loop.
.IP \(bu 2
9d8a3d8303 Fix avail_locations function for the softlayer_hw driver in 2015.5
.UNINDENT
.IP \(bu 2
8f9a3cfbaf Merge pull request \fI\%#27410\fP from jacobhammons/doc\-updates
.INDENT 2.0
.IP \(bu 2
a9fdecada1 Fix css layout Refs \fI\%#27389\fP sample typo fix in linux_acl additional module folders listed in dynamic\-modules
.UNINDENT
.IP \(bu 2
3746085587 Merge pull request \fI\%#27336\fP from rallytime/cloud\-logging\-five
.INDENT 2.0
.IP \(bu 2
7956b36076 [2015.5] Fixup salt\-cloud logging
.UNINDENT
.IP \(bu 2
5a3be10a3e Merge pull request \fI\%#27358\fP from lorengordon/escape\-search\-replacement\-text
.INDENT 2.0
.IP \(bu 2
88bb1fbfff Escape search replacement text, fixes \fI\%#27356\fP
.UNINDENT
.IP \(bu 2
6759f79d6d Merge pull request \fI\%#27345\fP from rallytime/docs\-for\-19236
.INDENT 2.0
.IP \(bu 2
1d3925bbfb Added version tag for ex_disk_type option
.IP \(bu 2
f23369300c Allow use of rst header links by separating options out from yaml example
.UNINDENT
.IP \(bu 2
c2efb291e2 Merge pull request \fI\%#26903\fP from bersace/fix\-defaults\-modules
.INDENT 2.0
.IP \(bu 2
474d7afc95 fixup! Review defaults loading
.IP \(bu 2
36141d226e fixup! Review defaults loading
.IP \(bu 2
62b6495358 fixup! Review defaults loading
.IP \(bu 2
cf0624e8b8 fixup! Review defaults loading
.IP \(bu 2
2c58bab977 fixup! Review defaults loading
.IP \(bu 2
82c5b1d8fd Review defaults loading
.UNINDENT
.IP \(bu 2
a372466922 Merge pull request \fI\%#27317\fP from efficks/fix27316
.INDENT 2.0
.IP \(bu 2
bf216c101e State unzip should use unzip command instead of unzip_cmd. Issue \fI\%#27316\fP
.UNINDENT
.IP \(bu 2
bd3771e80f Merge pull request \fI\%#27309\fP from rallytime/fix\-15514
.INDENT 2.0
.IP \(bu 2
9383d91ff8 Change a value list to a comma\-separated string in boto_route53.present
.UNINDENT
.IP \(bu 2
b5fe944875 Merge pull request \fI\%#27311\fP from jfindlay/maxoc
.INDENT 2.0
.IP \(bu 2
8ec2e921bd discuss replacement occurrences in file doc
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27513\fP: (\fI\%terminalmage\fP) Fix integration tests for worktree addition in git >= 2.6
@ \fI2015\-09\-29 18:39:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
0e37fb3bd3 Merge pull request \fI\%#27513\fP from terminalmage/fix\-worktree\-tests
.IP \(bu 2
519bdd6438 Fix integration tests for worktree addition in git >= 2.6
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27510\fP: (\fI\%rallytime\fP) Merge \fI\%#27475\fP with test fixes
@ \fI2015\-09\-29 18:34:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27475\fP: (\fI\%ryan\-lane\fP) Use __states__ for calls to other boto states (refs: \fI\%#27510\fP)
.IP \(bu 2
e974a3c8aa Merge pull request \fI\%#27510\fP from rallytime/ryan\-lane\-test\-fix
.IP \(bu 2
cae2c4e715 Syntax fix
.IP \(bu 2
458547ba03 Fix test failures for boto __state__ changes
.IP \(bu 2
5e25454fc1 Followups for using __states__
.IP \(bu 2
a01f8ac62c Use __states__ for calls to other boto states
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27265\fP: (\fI\%Arabus\fP) State: dockerng.running; creation hostconfig replaced with runtime hostconfig when using runtime options (refs: \fI\%#27451\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27451\fP: (\fI\%ticosax\fP) [dockerng] Enforce usage of host_config and require docker\-py>=1.4.0
@ \fI2015\-09\-29 15:51:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
d85b0cbd69 Merge pull request \fI\%#27451\fP from ticosax/dockerng\-host\-config\-support
.IP \(bu 2
b184faa55b Enforce usage of host_config and require docker\-py>=1.4.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27461\fP: (\fI\%cachedout\fP) Only clean context if it exists
@ \fI2015\-09\-29 15:49:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
e8f58a6a3f Merge pull request \fI\%#27461\fP from cachedout/clean_context_ioloop
.IP \(bu 2
7367a4e32b Only clean context if it exists
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27220\fP: (\fI\%TheBigBear\fP) [ERROR   ] Exception \(aqclose_fds is not supported on Windows platforms if you redirect stdin/stdout/stderr\(aq  (refs: \fI\%#27473\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27473\fP: (\fI\%terminalmage\fP) salt.utils.gitfs: Don\(aqt use close_fds=True on Windows
@ \fI2015\-09\-29 15:34:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
25a30a5621 Merge pull request \fI\%#27473\fP from terminalmage/issue27220
.IP \(bu 2
fa70ef2e31 salt.utils.gitfs: Don\(aqt use close_fds=True on Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27496\fP: (\fI\%blueyed\fP) Fix version reporting of gitpython
@ \fI2015\-09\-29 15:31:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
3807cd5c4e Merge pull request \fI\%#27496\fP from blueyed/fix\-gitpython\-version
.IP \(bu 2
d8969363c8 Fix version reporting of gitpython
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27502\fP: (\fI\%ticosax\fP) Add test to check we don\(aqt call inspect_image on absent images.
@ \fI2015\-09\-29 15:15:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25162\fP: (\fI\%ticosax\fP) [dockerng] Do not call inspect_image if we know the image is not downloaded (refs: \fI\%#27502\fP)
.IP \(bu 2
057fd0729d Merge pull request \fI\%#27502\fP from ticosax/backport\-test\-from\-develop
.IP \(bu 2
fadd9bd43e Add test to check we don\(aqt call inspect_image on absent images.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27497\fP: (\fI\%blueyed\fP) dockerng: fix image_present for forced, non\-existent image
@ \fI2015\-09\-29 13:49:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
f3da6e4bb3 Merge pull request \fI\%#27497\fP from blueyed/dockerng\-fix\-404\-private\-forced
.IP \(bu 2
e3c66cea3a dockerng: fix image_present for forced, non\-existent image
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27205\fP: (\fI\%msummers42\fP) In git.config_set state CommandExecutionError occurs when global=True when using salt 2015.8.0 (refs: \fI\%#27411\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27411\fP: (\fI\%terminalmage\fP) Fix invocation of git.config_get and git.config_set
@ \fI2015\-09\-28 22:53:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
284984e6ba Merge pull request \fI\%#27411\fP from terminalmage/issue27205
.IP \(bu 2
c3a17ae992 add missing commas
.IP \(bu 2
f2751ef7c4 Fix shadowed outer\-scope attributes
.IP \(bu 2
81a6c27010 Fix invocation of git.config_get and git.config_set
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27217\fP: (\fI\%nasenbaer13\fP) Gitfs cleans up wrong directories (refs: \fI\%#27218\fP, \fI\%#27477\fP, \fI\%#27276\fP, \fI\%#27382\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27477\fP: (\fI\%terminalmage\fP) Don\(aqt append role to hash_cachedir
@ \fI2015\-09\-28 22:26:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
cbcb5475b6 Merge pull request \fI\%#27477\fP from terminalmage/issue27217
.IP \(bu 2
c185e99970 Second attempt to fix \fI\%#27217\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27474\fP: (\fI\%whiteinge\fP) Add fake pymongo version attribute for the docs
@ \fI2015\-09\-28 21:49:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
2f71833260 Merge pull request \fI\%#27474\fP from whiteinge/docs\-pymongo\-fix
.IP \(bu 2
64b54e668a Add fake pymongo version attribute for the docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27466\fP: (\fI\%blueyed\fP) Fix version reporting of python\-gnupg and mysql\-python
@ \fI2015\-09\-28 20:25:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
9202f956f3 Merge pull request \fI\%#27466\fP from blueyed/fix\-gnupg\-version
.IP \(bu 2
9c1454fe59 Fix version reporting of mysql\-python
.IP \(bu 2
437fb4407e Fix version reporting of python\-gnupg
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27465\fP: (\fI\%ticosax\fP) Fix usage of dockerng \(dqcmd\(dq was \fI\%#27459\fP
@ \fI2015\-09\-28 19:27:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27459\fP: (\fI\%terminalmage\fP) Fix usage of dockerng \(dqcmd\(dq (refs: \fI\%#27465\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27444\fP: (\fI\%ticosax\fP) docker\-py expect only \fIcommand\fP argument not \fIcmd\fP (refs: \fI\%#27459\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27331\fP: (\fI\%terminalmage\fP) dockerng: Allow both cmd and command to be used to specify command (refs: \fI\%#27459\fP, \fI\%#27444\fP)
.IP \(bu 2
6d8e9af297 Merge pull request \fI\%#27465\fP from ticosax/fix\-dockerng\-cmd
.IP \(bu 2
a1ed6cda56 Skip test if docker\-py is not installed
.IP \(bu 2
6f7769aa94 Correct log messages/docstrings
.IP \(bu 2
cc8471bd1b dockerpy expect only \fIcommand\fP argument not \fIcmd\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27409\fP: (\fI\%pcn\fP) 2015.8.0 API (cherrypy) fails to lookup job id via pepper (refs: \fI\%#27417\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#25107\fP: (\fI\%whiteinge\fP) Regression in RunnerClient argument handling (refs: \fI\%#25243\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27417\fP: (\fI\%whiteinge\fP) Backport \fI\%#25243\fP into 2015.8
@ \fI2015\-09\-28 19:15:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25243\fP: (\fI\%DmitryKuzmenko\fP) Runnerclient regression fix (refs: \fI\%#27417\fP)
.IP \(bu 2
aefe6d794a Merge pull request \fI\%#27417\fP from whiteinge/bp\-25243
.IP \(bu 2
53e7a6b7c5 RunnerClient support old style commands with kwargs on top level.
.IP \(bu 2
10b522b86c Revert \(dqFixed GET /jobs/<id> requests\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27423\fP: (\fI\%dmurphy18\fP) Changes to support configurable repository for Debian / Ubuntu
@ \fI2015\-09\-28 17:34:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
a07411a4d9 Merge pull request \fI\%#27423\fP from dmurphy18/dgm_envfix
.IP \(bu 2
63407fd2a9 Changes to support configurable repository for Debian / Ubuntu
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26689\fP: (\fI\%double\-yaya\fP) Salt \- SSH using machine IP to execute commands, without having to write a roster file (refs: \fI\%#27398\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27428\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27398\fP to 2015.8
@ \fI2015\-09\-28 15:03:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27398\fP: (\fI\%flowhamster\fP) Allow cloud roster to use sudo (refs: \fI\%#27428\fP)
.IP \(bu 2
d4d96bb3fc Merge pull request \fI\%#27428\fP from rallytime/bp\-27398
.IP \(bu 2
6969326ae2 doc: added documentation to cloud roster and fixed whitespace
.IP \(bu 2
b4334649d5 Allow cloud roster to use sudo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27429\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27344\fP to 2015.8
@ \fI2015\-09\-28 15:01:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27344\fP: (\fI\%rhealitycheck\fP) Mongo returners patch 1 (refs: \fI\%#27429\fP)
.IP \(bu 2
668c69bd7e Merge pull request \fI\%#27429\fP from rallytime/bp\-27344
.IP \(bu 2
e39a57afe1 Update mongo_return.py
.IP \(bu 2
f796c9a44b Update mongo_return.py
.IP \(bu 2
30d07cbb27 Update mongo_return.py
.IP \(bu 2
44ef4b48fb Update mongo_future_return.py
.IP \(bu 2
34b160b841 Update mongo_return.py
.IP \(bu 2
b2b5623da3 Update mongo_future_return.py
.IP \(bu 2
07f9a8b95b Update mongo_return.py
.IP \(bu 2
b7ddc83b4d Update mongo_future_return.py
.IP \(bu 2
540b3f2690 Update mongo_return.py
.IP \(bu 2
405edd0718 Update mongo_future_return.py
.IP \(bu 2
5c753a54ff Update mongo_return.py
.IP \(bu 2
06e05befa7 Update mongo_future_return.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27450\fP: (\fI\%ticosax\fP) [dockerng] Fix typo in docstring
@ \fI2015\-09\-28 14:27:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
c639931340 Merge pull request \fI\%#27450\fP from ticosax/fix\-typo
.IP \(bu 2
9cea62de67 Fix typo in docstring
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27430\fP: (\fI\%jacksontj\fP) Fix bug introduced in eee0291ff8b65ff1e22f4dc2447a74aa28a3ce7f
@ \fI2015\-09\-26 01:09:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
333c305ba0 Merge pull request \fI\%#27430\fP from jacksontj/2015.8
.IP \(bu 2
d2aff12f8f Fix bug introduced in eee0291ff8b65ff1e22f4dc2447a74aa28a3ce7f
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27418\fP: (\fI\%terminalmage\fP) Don\(aqt always remove dest path in salt.utils.files.rename()
@ \fI2015\-09\-25 23:09:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f4ca089a2 Merge pull request \fI\%#27418\fP from terminalmage/file\-rename
.IP \(bu 2
7bc0949d48 Don\(aqt always remove dest path in salt.utils.files.rename()
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27032\fP: (\fI\%lorengordon\fP) Windows Installer: Please be more kind to existing configurations (refs: \fI\%#27383\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27383\fP: (\fI\%twangboy\fP) Uninstaller only removes specific files and dirs
@ \fI2015\-09\-25 22:47:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec5faf1829 Merge pull request \fI\%#27383\fP from twangboy/fix_27032
.IP \(bu 2
63a7305ae9 Uninstaller only removes specific files and dirs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27416\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27399\fP to 2015.8
@ \fI2015\-09\-25 22:39:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27399\fP: (\fI\%multani\fP) Various documentation fixes (refs: \fI\%#27416\fP)
.IP \(bu 2
9ab3c6dc5d Merge pull request \fI\%#27416\fP from rallytime/bp\-27399
.IP \(bu 2
1d848118c9 doc: fixed indentation in salt.renderers.jinja\(aqs documentation
.IP \(bu 2
f5d053a033 doc: fixed indentation in salt.modules.consul\(aqs documentation
.IP \(bu 2
06beea6b2f doc: fix etcd state documentation typos
.IP \(bu 2
97e69ebb97 doc: fix state\(aqs top documentation typo
.IP \(bu 2
b411730d60 doc: fix documentation formatting for state blockdev
.IP \(bu 2
ce91bb9446 doc: fix formatting in state boto_elb
.IP \(bu 2
c69229875e doc: fix links in Docker state documentation
.IP \(bu 2
15b751d6e2 doc: Docker state use ports and not port_bindings anymore
.IP \(bu 2
880b6e0944 doc: fix link to docker\-py documentation
.IP \(bu 2
33db0c27f8 doc: fix RAET links
.IP \(bu 2
e69ba2f943 doc: fix rendering of salt.states.hipchat
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27093\fP: (\fI\%TheBigBear\fP) 2015.8.0 winrepo downloader corrupts some installers (refs: \fI\%#27394\fP, \fI\%#27163\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27394\fP: (\fI\%jacksontj\fP) Remove streamed response for fileclient to avoid HTTP redirection problems
@ \fI2015\-09\-25 21:55:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27163\fP: (\fI\%terminalmage\fP) Workaround upstream tornado bug affecting redirects (refs: \fI\%#27394\fP)
.IP \(bu 2
9842d9728b Merge pull request \fI\%#27394\fP from jacksontj/2015.8
.IP \(bu 2
01132c305c Re\-add files.rename call instead of os.rename
.IP \(bu 2
acf2d51440 Remove streamed response for fileclient to avoid HTTP redirection problems
.IP \(bu 2
a6ecf35f25 Revert \(dqRemove unused import\(dq
.IP \(bu 2
66c73a3996 Revert \(dqWorkaround upstream tornado bug affecting redirects\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27415\fP: (\fI\%ryan\-lane\fP) Backwards compat fixes for pecl module
@ \fI2015\-09\-25 19:40:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
44b246bf93 Merge pull request \fI\%#27415\fP from lyft/fix\-pecl
.IP \(bu 2
8be8ef585c Backwards compat fixes for pecl module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27407\fP: (\fI\%meggiebot\fP) Adding stretch label definition
@ \fI2015\-09\-25 18:10:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
d76a77c911 Merge pull request \fI\%#27407\fP from saltstack/meggiebot\-patch\-1
.IP \(bu 2
1c779700f6 Adding stretch label definition
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27209\fP: (\fI\%justinta\fP) Provider overrides appear to be broken (refs: \fI\%#27388\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27388\fP: (\fI\%basepi\fP) [2015.8] Fix global provider overrides
@ \fI2015\-09\-25 16:49:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
db6acfd832 Merge pull request \fI\%#27388\fP from basepi/provider.overrides.27209
.IP \(bu 2
d87147e14b Don\(aqt use ret.items(), forces load of all modules
.IP \(bu 2
a5ee33a9ad pack __salt__ before loading provider overrides
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27354\fP: (\fI\%gravyboat\fP) salt\-ssh roster docs should note the requiretty option (refs: \fI\%#27386\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27386\fP: (\fI\%rallytime\fP) Document tty: True usage in salt\-ssh roster file
@ \fI2015\-09\-25 15:44:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
b72e0b1133 Merge pull request \fI\%#27386\fP from rallytime/fix\-27354
.IP \(bu 2
08c04da48b Document tty: True usage in salt\-ssh roster file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27380\fP: (\fI\%justinta\fP) Skipping Async tests
@ \fI2015\-09\-25 15:13:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
51e765078a Merge pull request \fI\%#27380\fP from jtand/async_tests
.IP \(bu 2
fd0dedeb99 Skipping Async tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27217\fP: (\fI\%nasenbaer13\fP) Gitfs cleans up wrong directories (refs: \fI\%#27218\fP, \fI\%#27477\fP, \fI\%#27276\fP, \fI\%#27382\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27382\fP: (\fI\%terminalmage\fP) Revert \(dqfixes \fI\%#27217\fP clear_old_remotes clears wrong directory (gitfs)\(dq
@ \fI2015\-09\-24 22:54:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
633af56517 Merge pull request \fI\%#27382\fP from terminalmage/revert\-27218
.IP \(bu 2
2379748f9e Revert \(dqfixes \fI\%#27217\fP clear_old_remotes clears wrong directory (gitfs)\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27361\fP: (\fI\%cro\fP) Correct some issues with proxy minions
@ \fI2015\-09\-24 16:03:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
12a021da11 Merge pull request \fI\%#27361\fP from cro/pxm_doc
.IP \(bu 2
1a2c41c9e3 Add versionadded.
.IP \(bu 2
93a6397598 func_alias should be list_ and should have a corresponding list_ fn.
.IP \(bu 2
0221f7ee4e Pylint
.IP \(bu 2
3a297d8036 Add release notes for proxy fixes.
.IP \(bu 2
39df44b841 Pylint
.IP \(bu 2
e3ebff9bce Fix some problems with the rest_sample, remove unnecessary file and make sure that rest_service has the right contents.
.IP \(bu 2
f4944fe68a Fix typo in docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27364\fP: (\fI\%ruzarowski\fP) SaltCloud[EC2] Fix missing credentials in modify_eni_properties api call
@ \fI2015\-09\-24 13:55:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
cff74510de Merge pull request \fI\%#27364\fP from ruzarowski/2015.8\-modify\-eni\-properties\-api\-call
.IP \(bu 2
100eea46d5 Issue \fI\%#27121\fP \- Remove leftover code comment
.IP \(bu 2
c58e7a00f3 Issue \fI\%#27121\fP \- Attempt to fix missing credentials when modifying eni properties
.IP \(bu 2
5d292a221e Merge remote\-tracking branch \(aqupstream/2015.8\(aq into 2015.8
.IP \(bu 2
4dbd9ebb30 Merge remote\-tracking branch \(aqupstream/2015.8\(aq into 2015.8
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27349\fP: (\fI\%jfindlay\fP) add freebsd install docs to release notes
@ \fI2015\-09\-24 13:51:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
928ef59a8a Merge pull request \fI\%#27349\fP from jfindlay/doc_typos
.IP \(bu 2
e509cfca17 fix typo in 2015.8.0 pull list
.IP \(bu 2
7137e731d3 add FreeBSD documentation to 2015.8.0 notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26889\fP: (\fI\%UtahDave\fP) salt\-call w/non root user outputs repeating error (refs: \fI\%#27343\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27343\fP: (\fI\%cachedout\fP) Close io loop before deleting attribute
@ \fI2015\-09\-24 13:49:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
331230ea4f Merge pull request \fI\%#27343\fP from cachedout/issue_26889
.IP \(bu 2
2b648e51af Close io loop before deleting attribute
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27337\fP: (\fI\%rallytime\fP) [2015.8] Fixup salt\-cloud logging
@ \fI2015\-09\-24 13:49:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
cd82ead005 Merge pull request \fI\%#27337\fP from rallytime/cloud\-logging\-eight
.IP \(bu 2
ed18384108 Merge pull request \fI\%#7\fP from jtand/cloud\-logging\-eight
.INDENT 2.0
.IP \(bu 2
a6c1d0b408 Fixed a bug where logging_command wasn\(aqt set as a key in a couple spots
.UNINDENT
.IP \(bu 2
8bb7cb7ff4 Use correct indexes
.IP \(bu 2
c3483002b0 [2015.8] Fixup salt\-cloud logging
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27332\fP: (\fI\%terminalmage\fP) Adjust dockerng/dockerio docstrings
@ \fI2015\-09\-24 13:45:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
b2f8418ffc Merge pull request \fI\%#27332\fP from terminalmage/adjust\-dockerng\-docstring
.IP \(bu 2
bdbf4d8e5c Add deprecation notice to dockerio state module
.IP \(bu 2
17829ab38d Fix name of dockerng module in dockerio docstring
.IP \(bu 2
ed5ae75180 Adjust dockerng docstrings
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27353\fP: (\fI\%cachedout\fP) Fix case where var not set in config
@ \fI2015\-09\-23 21:45:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
ac9e6c2532 Merge pull request \fI\%#27353\fP from cachedout/fix_retry_get
.IP \(bu 2
ea286e1874 Fix case where var not set in config
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21390\fP: (\fI\%fyatzeck\fP) Having trouble with GCE cloud profile assigning static IP and enabling IP forward (refs: \fI\%#27350\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27350\fP: (\fI\%rallytime\fP) Allow IP\-forwarding in GCE driver
@ \fI2015\-09\-23 21:36:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
3f6b06116f Merge pull request \fI\%#27350\fP from rallytime/fix\-21390
.IP \(bu 2
2bf566d934 Allow IP\-forwarding in GCE driver
.IP \(bu 2
484015a7a3 Added version tag for ex_disk_type option
.IP \(bu 2
a71ebc97b2 Allow use of rst header links by separating options out from yaml example
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27103\fP: (\fI\%twangboy\fP) Salt\-Minion doesn\(aqt display logs for new processes with multiprocessing on (refs: \fI\%#27305\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27305\fP: (\fI\%cachedout\fP) Re\-init logging system on Windows when using multiprocessing
@ \fI2015\-09\-23 15:32:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
6f3da863fc Merge pull request \fI\%#27305\fP from cachedout/issue_27103
.IP \(bu 2
7a7492d186 Fix typo
.IP \(bu 2
22c653482c Re\-init logging system on Windows when using multiprocessing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27331\fP: (\fI\%terminalmage\fP) dockerng: Allow both cmd and command to be used to specify command (refs: \fI\%#27459\fP, \fI\%#27444\fP)
@ \fI2015\-09\-23 15:27:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
684e33aeb2 Merge pull request \fI\%#27331\fP from terminalmage/dockerng\-cmd
.IP \(bu 2
7d4eaac8ae dockerng: Allow both cmd and command to be used to specify command
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27327\fP: (\fI\%isbm\fP) Fix a typo in the RPM output
@ \fI2015\-09\-23 14:27:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
a3f4fa1106 Merge pull request \fI\%#27327\fP from isbm/isbm\-pkg\-info\-typofix
.IP \(bu 2
7912f8c13b Fix typo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27312\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-09\-22 22:52:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
a789303d75 Merge pull request \fI\%#27312\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
647080d064 Add missing import
.IP \(bu 2
95e70f0bef Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.IP \(bu 2
ca4597b93a Merge pull request \fI\%#27310\fP from basepi/merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
7b75e4aed1 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
e90412d3b8 Merge pull request \fI\%#27252\fP from jfindlay/version.2014.7
.INDENT 2.0
.IP \(bu 2
3d28307a00 2014.7 \-> 2014.7.0
.UNINDENT
.UNINDENT
.IP \(bu 2
982c21c79f Merge pull request \fI\%#27308\fP from terminalmage/fix\-refresh_db\-regression
.INDENT 2.0
.IP \(bu 2
77686fb7ce Fix refresh_db regression in yumpkg.py
.UNINDENT
.IP \(bu 2
775a4f9ad0 Merge pull request \fI\%#27286\fP from terminalmage/return_retry_timer
.INDENT 2.0
.IP \(bu 2
540a7dfcf1 Add default values for new minion config options
.IP \(bu 2
453b883820 Add a configurable timer for minion return retries
.UNINDENT
.IP \(bu 2
02482c0572 Merge pull request \fI\%#27278\fP from rallytime/bp\-27256
.INDENT 2.0
.IP \(bu 2
1beddf6311 Fix error handling in salt.modules.file.statvfs
.UNINDENT
.IP \(bu 2
e36c019c37 Merge pull request \fI\%#27277\fP from rallytime/bp\-27230
.INDENT 2.0
.IP \(bu 2
3ce77db1bc Fix typo in AWS doc config
.UNINDENT
.IP \(bu 2
b22286476e Merge pull request \fI\%#27253\fP from jfindlay/version.2015.5
.INDENT 2.0
.IP \(bu 2
967e3bb72a 2015.5 \-> 2015.5.0
.UNINDENT
.IP \(bu 2
51a0193b54 Merge pull request \fI\%#27244\fP from garethgreenaway/ec2_create_snapshot_no_return_data_exception
.INDENT 2.0
.IP \(bu 2
820fd576b9 Fixing the cause when the r_data from aws.query is empty and an exception happens when looking for the snapshotID
.UNINDENT
.IP \(bu 2
26540f15bc Merge pull request \fI\%#27231\fP from jfindlay/cronchange
.INDENT 2.0
.IP \(bu 2
1e335297e2 only write cron file if it is changed
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27303\fP: (\fI\%jacobhammons\fP) Updated module doc index using \fI\%https://github.com/saltstack/salt/pull\fP…
@ \fI2015\-09\-22 19:29:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3b690273b Merge pull request \fI\%#27303\fP from jacobhammons/ref\-updates
.IP \(bu 2
7ac98a03b6 Updated module doc index using \fI\%https://github.com/saltstack/salt/pull/27203\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27081\fP: (\fI\%TheBigBear\fP) winrepo \- SSLError: [Errno 1] _ssl.c:510: error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed (refs: \fI\%#27301\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27301\fP: (\fI\%twangboy\fP) Pass ca_bundle for windows (fixes SSL Error)
@ \fI2015\-09\-22 19:00:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
aaa2db9943 Merge pull request \fI\%#27301\fP from twangboy/fix_27081
.IP \(bu 2
5c4f5f8944 Changed windows gate to check for verify_ssl option
.IP \(bu 2
e2fe5a60b5 Pass ca_bundle for windows (fixes SSL Error)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27300\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27287\fP to 2015.8
@ \fI2015\-09\-22 16:59:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27287\fP: (\fI\%rhealitycheck\fP) Mongo returners patch 1 (refs: \fI\%#27300\fP)
.IP \(bu 2
55f4050146 Merge pull request \fI\%#27300\fP from rallytime/bp\-27287
.IP \(bu 2
e49a6dc449 Update mongo_return.py
.IP \(bu 2
63153322b9 Update mongo_future_return.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27288\fP: (\fI\%rallytime\fP) Filter on \(aqname\(aq, not \(aqid\(aq, when listing images
@ \fI2015\-09\-21 22:37:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
d96462af48 Merge pull request \fI\%#27288\fP from rallytime/do\-cleanup
.IP \(bu 2
6e16fad760 Use name in all places, not id.
.IP \(bu 2
9b34542cb0 Filter on \(aqname\(aq, not \(aqid\(aq, when listing images
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27283\fP: (\fI\%justinta\fP) __grains__[\(aqosrelease\(aq] returns a string
@ \fI2015\-09\-21 19:18:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
688f24e9e4 Merge pull request \fI\%#27283\fP from jtand/yumpkg_yum_fix
.IP \(bu 2
b73f5289b4 __grains__[\(aqosrelease\(aq] returns a string. Cast to int for correct comparison
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27217\fP: (\fI\%nasenbaer13\fP) Gitfs cleans up wrong directories (refs: \fI\%#27218\fP, \fI\%#27477\fP, \fI\%#27276\fP, \fI\%#27382\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27276\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27218\fP to 2015.8
@ \fI2015\-09\-21 19:05:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27218\fP: (\fI\%nasenbaer13\fP) fixes \fI\%#27217\fP clear_old_remotes clears wrong directory (gitfs) (refs: \fI\%#27276\fP)
.IP \(bu 2
78d44a5c74 Merge pull request \fI\%#27276\fP from rallytime/bp\-27218
.IP \(bu 2
8c0991d527 fixes \fI\%#27217\fP clear_old_remotes clears wrong directory (gitfs)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27275\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27213\fP to 2015.8
@ \fI2015\-09\-21 19:05:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27213\fP: (\fI\%macgyver13\fP) Make get_event compatible with salt/client (refs: \fI\%#27275\fP)
.IP \(bu 2
d5ce81e8e7 Merge pull request \fI\%#27275\fP from rallytime/bp\-27213
.IP \(bu 2
5d4c90c479 Make get_event compatible with salt/client
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27274\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27272\fP to 2015.8
@ \fI2015\-09\-21 18:54:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27272\fP: (\fI\%techhat\fP) Make sure list_nodes_full contains a name attribute (refs: \fI\%#27274\fP)
.IP \(bu 2
2be21d6451 Merge pull request \fI\%#27274\fP from rallytime/bp\-27272
.IP \(bu 2
f3ea3259a5 Make sure list_nodes_full contains a name attribute
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27271\fP: (\fI\%isbm\fP) Bugfix: crash on token authentication via API
@ \fI2015\-09\-21 15:53:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
c0943dd4d1 Merge pull request \fI\%#27271\fP from isbm/isbm\-bufix\-27270
.IP \(bu 2
fc524c17b9 Reduce the criteria that would match empty iterables as well as None or False values
.IP \(bu 2
3152af78b5 Fix the crash on token auth via API (\fI\%http://git.io/vn4tx\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19947\fP: (\fI\%gczuczy\fP) Unable to supply provisioning script to softlayer create() (refs: \fI\%#27251\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27251\fP: (\fI\%rallytime\fP) Add support for post_uri in SoftLayer cloud drivers
@ \fI2015\-09\-21 15:43:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
b11ce6ac2a Merge pull request \fI\%#27251\fP from rallytime/fix\-19947
.IP \(bu 2
aafb776808 Add support for post_uri in SoftLayer cloud drivers
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21879\fP: (\fI\%bechtoldt\fP) Reference pages in documentation are outdated again (refs: \fI\%#27260\fP, \fI\%#25019\fP, \fI\%#21880\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#19262\fP: (\fI\%bechtoldt\fP) salt.pillar.file_tree doesn\(aqt appear in the documentation (refs: \fI\%#27260\fP, \fI\%#25019\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27260\fP: (\fI\%bechtoldt\fP) add missing module doc references
@ \fI2015\-09\-21 05:48:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25019\fP: (\fI\%bechtoldt\fP) add missing module documentation to references (refs: \fI\%#27260\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24421\fP: (\fI\%bechtoldt\fP) add missing module documentation  (refs: \fI\%#27260\fP, \fI\%#25019\fP)
.IP \(bu 2
\fBPR\fP \fI\%#21880\fP: (\fI\%bechtoldt\fP) update references, fixes \fI\%#21879\fP (refs: \fI\%#27260\fP, \fI\%#25019\fP)
.IP \(bu 2
\fBPR\fP \fI\%#20039\fP: (\fI\%bechtoldt\fP) completing some doc references (refs: \fI\%#27260\fP, \fI\%#25019\fP)
.IP \(bu 2
de6e5abe6c Merge pull request \fI\%#27260\fP from bechtoldt/missing_refs
.IP \(bu 2
3a7d31a91c add missing module references
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27254\fP: (\fI\%jfindlay\fP) 2015.2,2015.8,Beryllium \-> 2015.8.0
@ \fI2015\-09\-18 23:44:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a32b9f778 Merge pull request \fI\%#27254\fP from jfindlay/version.2015.8
.IP \(bu 2
8ea15f498e 2015.2,2015.8,Beryllium \-> 2015.8.0
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25079\fP: (\fI\%jondonas\fP) Salt\-cloud does not check for duplicate ssh keys when using provider such as DigitalOcean (refs: \fI\%#27245\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27245\fP: (\fI\%rallytime\fP) If two ssh keynames are found in DigitalOcean, abort and warn the user.
@ \fI2015\-09\-18 21:42:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
f3a847823b Merge pull request \fI\%#27245\fP from rallytime/fix\-25079
.IP \(bu 2
4b0f7cce1d If two ssh keynames are found in DigitalOcean, abort.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27065\fP: (\fI\%lorengordon\fP) 2015.8.0: yumpkg reporting \(dqUnexpected osrelease grain \(aq6.7\(aq\(dq (refs: \fI\%#27241\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27241\fP: (\fI\%jfindlay\fP) osrelease is only an integer for fedora
@ \fI2015\-09\-18 21:40:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
e4a5b004ae Merge pull request \fI\%#27241\fP from jfindlay/yumwarn
.IP \(bu 2
1f7570250f osrelease is only an integer for fedora
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27234\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-09\-18 20:41:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
f8e71f6d7d Merge pull request \fI\%#27234\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
be2b0fc497 Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
579f375f74 Merge pull request \fI\%#27233\fP from basepi/release.notes.stubs
.INDENT 2.0
.IP \(bu 2
f4563ea9b7 Add stub release notes for 2015.5.6
.UNINDENT
.IP \(bu 2
f5a322e3f2 Merge pull request \fI\%#27208\fP from basepi/nop.state.25423
.INDENT 2.0
.IP \(bu 2
9414b05b2c Add test.nop example
.IP \(bu 2
a84ce67b8f Add test.nop state
.UNINDENT
.IP \(bu 2
59a07cae68 Merge pull request \fI\%#27201\fP from jfindlay/sshhash
.INDENT 2.0
.IP \(bu 2
1b620b77cd rename hash_host arg to hash_known_hosts
.IP \(bu 2
12f14ae37c update hash_known_hosts docs in ssh module
.UNINDENT
.IP \(bu 2
560545c4c5 Merge pull request \fI\%#27214\fP from jacksontj/2015.5
.INDENT 2.0
.IP \(bu 2
e7526bdb44 Correctly support https, port 443 is not a requirement
.UNINDENT
.IP \(bu 2
7a34c7742d Merge pull request \fI\%#27172\fP from rallytime/bp\-27150
.INDENT 2.0
.IP \(bu 2
0d7ee4b209 Merge config values from master.d/minion.d conf files
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27240\fP: (\fI\%isbm\fP) Backport of the fix of \(aqpkg.info*\(aq for Beryllium
@ \fI2015\-09\-18 20:02:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d6c75cbd7 Merge pull request \fI\%#27240\fP from isbm/isbm\-pkg.info\-tz\-bugfix\-backport\-2015.8
.IP \(bu 2
19a361851a Return install date only if possible.
.IP \(bu 2
ff857bc8aa Return RPM package time in UTC timezone
.IP \(bu 2
eaa0f370bf Remove time fraction and return ISO in UTC
.IP \(bu 2
ce9570fce6 Return UTC timestamp for modification of path.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27222\fP: (\fI\%pprkut\fP) Support firewalld zone configuration in network.managed state for rh7 systems (refs: \fI\%#27223\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27223\fP: (\fI\%pprkut\fP) Support firewalld per interface zone config on rh7 systems
@ \fI2015\-09\-18 19:44:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
80a45b74ed Merge pull request \fI\%#27223\fP from M2Mobi/zone
.IP \(bu 2
48023669e7 Support permanent per interface firewalld zone configuration on rh7 systems.
.IP \(bu 2
\fBPR\fP \fI\%#27239\fP: (\fI\%bechtoldt\fP) test \fI\%#27238\fP prevent keyerror when partition doesn\(aqt exist (refs: \fI\%#27238\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27238\fP: (\fI\%bechtoldt\fP) salt.modules.disk.percent() throws KeyError when partition doesn\(aqt exist (refs: \fI\%#27239\fP)
@ \fI2015\-09\-18 19:37:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
652b2998af Merge pull request \fI\%#27238\fP from bechtoldt/fix_disk_percent_keyerror
.IP \(bu 2
0511f611bb prevent KeyError by checking whether partition even exists
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27232\fP: (\fI\%basepi\fP) [2015.8] Add stub release notes for 2015.8.1
@ \fI2015\-09\-18 16:53:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
253ac5e0c3 Merge pull request \fI\%#27232\fP from basepi/release.notes.stubs
.IP \(bu 2
25410706ee Add stub release notes for 2015.8.1
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24573\fP: (\fI\%bailsman\fP) cloud.profile RuntimeError: dictionary changed size during iteration (refs: \fI\%#27199\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27199\fP: (\fI\%rallytime\fP) Avoid RunTimeError (dictionary changed size during iteration) with keys()
@ \fI2015\-09\-18 15:44:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
c542cd49d0 Merge pull request \fI\%#27199\fP from rallytime/fix\-24573
.IP \(bu 2
6b2a00e947 Avoid RunTimeError (dictionary changed size during iteration) with keys()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27206\fP: (\fI\%rallytime\fP) Don\(aqt repeat GCE setup instructions, and make the use of .json files clearer
@ \fI2015\-09\-18 14:38:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b79ad69a9 Merge pull request \fI\%#27206\fP from rallytime/gce\-doc\-cleanup
.IP \(bu 2
cced6e9031 Don\(aqt repeat GCE setup instructions, and make the use of .json files clearer
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27210\fP: (\fI\%rallytime\fP) Refactor some digital ocean functions
@ \fI2015\-09\-18 14:38:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
1d022eb5de Merge pull request \fI\%#27210\fP from rallytime/do\-clean\-up
.IP \(bu 2
808a5b3b81 Make sure we set the full data to the ret variable
.IP \(bu 2
9b635004e2 Refactor some digital_ocean functions to help simplify the driver
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27197\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-09\-17 19:53:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
8c204a45ab Merge pull request \fI\%#27197\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
2c2a5f85ac Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
e956d88f5f Merge pull request \fI\%#27194\fP from rallytime/bp\-27180
.INDENT 2.0
.IP \(bu 2
327d343fef file copy ret result True if no change in test mode
.UNINDENT
.IP \(bu 2
a02d043309 Merge pull request \fI\%#27176\fP from basepi/merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
66f4641be3 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
c186e51764 Merge pull request \fI\%#27117\fP from jacobhammons/release\-docs\-2014.7
.INDENT 2.0
.IP \(bu 2
b69e11e0a4 made 2014.7 an archived release minor doc site updates
.UNINDENT
.IP \(bu 2
69d758ee2b Merge pull request \fI\%#27114\fP from cachedout/warn_on_insecure_log
.INDENT 2.0
.IP \(bu 2
507fb04683 Issue warning that some log levels may contain sensitive data
.UNINDENT
.IP \(bu 2
aa71bae8aa Merge pull request \fI\%#27075\fP from twangboy/fix_password_2014.7
.IP \(bu 2
c0689e3215 Replaced password with redacted when displayed
.UNINDENT
.IP \(bu 2
de2027426e Merge pull request \fI\%#27170\fP from rallytime/gce\-docs
.INDENT 2.0
.IP \(bu 2
a07db909bd Update Getting Started with GCE docs to use cloud.profiles or cloud.profiles.d examples
.UNINDENT
.IP \(bu 2
28cfdfd067 Merge pull request \fI\%#27167\fP from rallytime/bp\-27148
.INDENT 2.0
.IP \(bu 2
d12be52355 Pass filepointers to the serialize load functions.
.UNINDENT
.IP \(bu 2
4495f4f4d0 Merge pull request \fI\%#27168\fP from techhat/gateimpacket
.INDENT 2.0
.IP \(bu 2
cc448bfdc1 Add further gating of impacket library
.UNINDENT
.IP \(bu 2
3e5ef0dc30 Merge pull request \fI\%#27166\fP from rallytime/fix\-27100
.INDENT 2.0
.IP \(bu 2
50fb3a489a Allow a full\-query for EC2, even if there are no profiles defined
.UNINDENT
.IP \(bu 2
f1c9de7ed9 Merge pull request \fI\%#27162\fP from rallytime/softlayer\-service
.INDENT 2.0
.IP \(bu 2
d281068c70 Be explicit in using \(dqSoftLayer\(dq for service queries in SoftLayer drivers
.UNINDENT
.IP \(bu 2
59e9dfd8de Merge pull request \fI\%#27149\fP from twangboy/fix_27133
.INDENT 2.0
.IP \(bu 2
7992b7e20a Fixed some tests...  hopefully...
.IP \(bu 2
d4c8e30f5d Fixed problem with add/remove path
.UNINDENT
.IP \(bu 2
097fcd1017 Merge pull request \fI\%#27147\fP from rallytime/fix\-11669
.INDENT 2.0
.IP \(bu 2
55312ea03f Provide a more friendly error message.
.IP \(bu 2
36555856c7 Enforce bounds in the GCE Regex
.UNINDENT
.IP \(bu 2
f5c3f157dd Merge pull request \fI\%#27128\fP from eguven/2015.5\-fix\-test\-diff
.INDENT 2.0
.IP \(bu 2
ec2d68a84a don\(aqt show diff for test run if show_diff=False
.UNINDENT
.IP \(bu 2
088b1dbb3e Merge pull request \fI\%#27116\fP from jacobhammons/release\-docs\-2015.5
.INDENT 2.0
.IP \(bu 2
6e323b6dd3 Update latest to 2015.8, 2015.5 is now previous Assorted style and minor updates
.UNINDENT
.IP \(bu 2
440855b182 Merge pull request \fI\%#27033\fP from jfindlay/n0ne
.INDENT 2.0
.IP \(bu 2
3334b9d548 fix comment and unit test for reg state
.IP \(bu 2
391a09d5ac update reg state unit tests
.IP \(bu 2
ebbf2b05ca Fixed reg state module for None, 0, and \(aq\(aq values
.UNINDENT
.IP \(bu 2
35fc74132a Merge pull request \fI\%#26942\fP from Arabus/fix\-docker.run
.INDENT 2.0
.IP \(bu 2
e61e1de1f5 Fixes value typo for dockerio.loaded state
.IP \(bu 2
39fa11b696 further linting
.IP \(bu 2
4aec37397c Further Linting to quiet the linter
.IP \(bu 2
7eff8ad070 Code Linting and cmd call fix
.IP \(bu 2
a51676e0eb Fixes  \fI\%#17088\fP olyif and unless should run on the host
.IP \(bu 2
d0c6128b8f Fixes \fI\%#17088\fP retcode now returns True or False based on return status
.IP \(bu 2
8b2e7cc4f5 Syntax clarification
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27195\fP: (\fI\%jacobhammons\fP) Fixed sphinx / latex build warnings and errors
@ \fI2015\-09\-17 17:28:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
430c48c5ea Merge pull request \fI\%#27195\fP from jacobhammons/doc\-build
.IP \(bu 2
fad87e34a2 Fixed lint errors
.IP \(bu 2
e56f02b025 re\-add cheatsheet do\-over
.IP \(bu 2
60a8330561 re\-added cheatsheet.tex
.IP \(bu 2
f7a9e25d52 Fixed sphinx / latex build warnings and errors Added missing modules to contents
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27182\fP: (\fI\%bernieke\fP) fix restart_on_error
@ \fI2015\-09\-17 17:24:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
8f8e75c5ff Merge pull request \fI\%#27182\fP from Awingu/2015.8
.IP \(bu 2
693b81f7e4 fix restart_on_error \fI\%#27127\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27093\fP: (\fI\%TheBigBear\fP) 2015.8.0 winrepo downloader corrupts some installers (refs: \fI\%#27394\fP, \fI\%#27163\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27163\fP: (\fI\%terminalmage\fP) Workaround upstream tornado bug affecting redirects (refs: \fI\%#27394\fP)
@ \fI2015\-09\-17 16:09:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
97d2a5fddc Merge pull request \fI\%#27163\fP from terminalmage/issue27093
.IP \(bu 2
80b396db73 Handle potential ValueError when checking content length
.IP \(bu 2
a89c987943 Remove unused import
.IP \(bu 2
469e18f74c Workaround upstream tornado bug affecting redirects
.IP \(bu 2
f2a562ac60 Add salt.utils.files.rename() for cross\-platform renaming
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19954\fP: (\fI\%gczuczy\fP) Multiple disks on softlayer (refs: \fI\%#27173\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27177\fP: (\fI\%rallytime\fP) Remove note \- incorrect info
@ \fI2015\-09\-17 01:34:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27173\fP: (\fI\%rallytime\fP) Add the ability to specify multiple disks on the SoftLayer driver (refs: \fI\%#27177\fP)
.IP \(bu 2
65c59ec2ea Merge pull request \fI\%#27177\fP from rallytime/fix\-19954
.IP \(bu 2
531b44243d Remove note \- incorrect info
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19954\fP: (\fI\%gczuczy\fP) Multiple disks on softlayer (refs: \fI\%#27173\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27173\fP: (\fI\%rallytime\fP) Add the ability to specify multiple disks on the SoftLayer driver (refs: \fI\%#27177\fP)
@ \fI2015\-09\-17 00:32:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
cbb7e7f1a5 Merge pull request \fI\%#27173\fP from rallytime/fix\-19954
.IP \(bu 2
45c6aabde9 DeviceID \(aq1\(aq is reserved for the SWAP disk; let\(aqs skip it.
.IP \(bu 2
54e104cf5b Don\(aqt stacktrace if local_disk isn\(aqt set
.IP \(bu 2
fe74d203f5 Add the ability to specify multiple disks on the SoftLayer driver
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22724\fP: (\fI\%ty2u\fP) digital_ocean_v2.py doesn\(aqt restore snapshot (refs: \fI\%#26824\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27164\fP: (\fI\%rallytime\fP) Make sure changes from \fI\%#26824\fP to digital_ocean_v2.py driver make it to digital_ocean.py in 2015.8
@ \fI2015\-09\-16 18:55:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26824\fP: (\fI\%systembell\fP) [salt\-cloud] Fix creating droplet from snapshot in digital_ocean provider  (refs: \fI\%#27164\fP)
.IP \(bu 2
0e04588d58 Merge pull request \fI\%#27164\fP from rallytime/add\-26824\-changes\-to\-2015.8
.IP \(bu 2
a44bd763dd Make sure changes from \fI\%#26824\fP to digital_ocean_v2.py driver make it to digital_ocean.py in 2015.8
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19853\fP: (\fI\%ksalman\fP) master needs a way to invalidate grains on the minion (refs: \fI\%#27143\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27143\fP: (\fI\%cachedout\fP) Clean grains cache on grains sync
@ \fI2015\-09\-16 16:27:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
38d93a96fe Merge pull request \fI\%#27143\fP from cachedout/clean_grains_cache_on_sync
.IP \(bu 2
0a660a9f80 Break apart long line
.IP \(bu 2
6de2c2a50c Better error checking
.IP \(bu 2
252f7c7ea9 Clean grains cache on grains sync
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18582\fP: (\fI\%mainframe\fP) Allow merging file_roots and pillar_roots from different config files included from master.d (refs: \fI\%#27150\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27150\fP: (\fI\%cachedout\fP) Merge config values from master.d/minion.d conf files (refs: \fI\%#27172\fP)
@ \fI2015\-09\-16 15:36:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
626cbe61ce Merge pull request \fI\%#27150\fP from cachedout/issue_18582
.IP \(bu 2
6351a94d08 Merge config values from master.d/minion.d conf files
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27135\fP: (\fI\%SEJeff\fP) Regression in core grains in the latest version of salt (refs: \fI\%#27137\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27137\fP: (\fI\%jfindlay\fP) revert serial grain regression
@ \fI2015\-09\-15 21:52:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#22267\fP: (\fI\%The\-Loeki\fP) modify _hw core grains to use the new smbios module, add system uuid (refs: \fI\%#27137\fP)
.IP \(bu 2
72fad569b0 Merge pull request \fI\%#27137\fP from jfindlay/serial
.IP \(bu 2
78c9687f0e revert serial grain regression
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27144\fP: (\fI\%rallytime\fP) Don\(aqt stacktrace on softlayer_hw.show_all_prices if a code isn\(aqt supplied
@ \fI2015\-09\-15 21:52:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
58b56b9d78 Merge pull request \fI\%#27144\fP from rallytime/softlayer\-fixes
.IP \(bu 2
3963a5cf0f Don\(aqt stacktrace on softlayer_hw.show_all_prices if a code isn\(aqt supplied
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27139\fP: (\fI\%jacobhammons\fP) Updated key instruction on rhel7
@ \fI2015\-09\-15 16:06:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
b71de75c1c Merge pull request \fI\%#27139\fP from jacobhammons/rhel\-doc
.IP \(bu 2
7ed9f6260f Updated key instruction on rhel7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27134\fP: (\fI\%isbm\fP) Backport to 2015.8: \(dqpkg.info\(dq
@ \fI2015\-09\-15 15:57:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d8248930e Merge pull request \fI\%#27134\fP from isbm/isbm\-pkg.info\-backport\-2015.8
.IP \(bu 2
b60e6a37a7 Lintfix: E7801, C0321
.IP \(bu 2
cb4706c7e8 Add license extraction for Dpkg.
.IP \(bu 2
38753fe8b2 Enhance filter for the \(dqtechnical\(dq fields that are not generally needed as a package information for the CMDB
.IP \(bu 2
ffe8f14dae Implement additional package information merger
.IP \(bu 2
2aafc469d0 Fix the size and installed\-size keys
.IP \(bu 2
3fc389435b Add homepage translator key
.IP \(bu 2
25040c9c71 Docfix
.IP \(bu 2
911bae1baf Add alias for \(aqinfo\(aq of deprecation in v. Boron
.IP \(bu 2
306958dad0 Fix renamed method
.IP \(bu 2
6ba269fbc6 Remove \(aqN/A\(aq when no data.
.IP \(bu 2
137eb75ca2 Rename existing \(aqinfo\(aq to \(aqinfo_available\(aq
.IP \(bu 2
7b376fd5c3 Implement compatible \(aqinfo_installed\(aq. Returned keys are common to other systems with other package managers
.IP \(bu 2
ca7d0d5025 Implement compatible \(aqinfo_installed\(aq. Returned keys are common to other systems with other package managers
.IP \(bu 2
c1faebf0b5 Implement compatible \(aqinfo_installed\(aq. Returned keys are common to other systems with other package managers
.IP \(bu 2
f14f4036df Lint: regexp as a string
.IP \(bu 2
cabe863b81 Implement package info function
.IP \(bu 2
0668f1da53 Implement getting package installation time
.IP \(bu 2
e03716e5b5 Implement getting general packages information
.IP \(bu 2
8737d690fe Extract package description
.IP \(bu 2
a283d53737 Lintfix the regexp string
.IP \(bu 2
fc9c959678 Convert time to ISO 8601
.IP \(bu 2
9fb9296276 Return a detailed information about package(s)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27119\fP: (\fI\%l2ol33rt\fP) Boto dynamodb module should be using layer 2 abstractions
@ \fI2015\-09\-15 14:09:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
7f512852ef Merge pull request \fI\%#27119\fP from l2ol33rt/boto_dynamo_module_fix
.IP \(bu 2
46c7aee367 Boto dynamodb util should be using layer 2 abstractions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27092\fP: (\fI\%perfinion\fP) salt/master: chdir to root not homedir
@ \fI2015\-09\-15 14:09:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
100e340111 Merge pull request \fI\%#27092\fP from perfinion/chdir\-fix\-2015.8
.IP \(bu 2
284d268855 salt/master: chdir to root not homedir
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27131\fP: (\fI\%jacobhammons\fP) Install docs
@ \fI2015\-09\-15 12:34:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
7483556b5f Merge pull request \fI\%#27131\fP from jacobhammons/install\-docs
.IP \(bu 2
d1e8af9be6 added command to remove key from rhel6
.IP \(bu 2
69d64f177d moved rhel5 commands to separate lines
.IP \(bu 2
90431278ea Install instruction updates for rhel6 and debian
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27124\fP: (\fI\%jfindlay\fP) Backport \fI\%#27123\fP
@ \fI2015\-09\-15 08:37:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27123\fP: (\fI\%cedwards\fP) update for freebsd installation documentation (refs: \fI\%#27124\fP)
.IP \(bu 2
fc8afcc9f9 Merge pull request \fI\%#27124\fP from jfindlay/bp\-27123
.IP \(bu 2
016fb5fafe Update freebsd.rst
.IP \(bu 2
026fc9a884 update for freebsd installation documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27111\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-09\-15 07:29:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d62d3470c Merge pull request \fI\%#27111\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
ab519fb5ff Remove heavily\-mocked unit tests
.IP \(bu 2
274464a85b Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
59f2a0c7ae Merge pull request \fI\%#26977\fP from abh/2015.5\-ntppeer
.INDENT 2.0
.IP \(bu 2
df3d6e817f Add support for PEERNTP network interface configuration on RH derived systems
.UNINDENT
.IP \(bu 2
e05b1f3951 Merge pull request \fI\%#27023\fP from jfindlay/htwebutilpass
.INDENT 2.0
.IP \(bu 2
9f3d7890a6 add test support for htpasswd state mod
.UNINDENT
.IP \(bu 2
9f999c0027 Merge pull request \fI\%#27074\fP from twangboy/fix_password_2015.5
.INDENT 2.0
.IP \(bu 2
fdd3537456 Replaced password with redacted when displayed
.UNINDENT
.IP \(bu 2
46b44f85ed Merge pull request \fI\%#27073\fP from rallytime/remove\-lxc\-warning
.INDENT 2.0
.IP \(bu 2
76c056d02b Remove \(dquse develop branch\(dq warning from LXC tutorial now that 2015.5.0 has been released
.UNINDENT
.IP \(bu 2
caab21d99c Merge pull request \fI\%#27054\fP from rallytime/bp\-27029
.INDENT 2.0
.IP \(bu 2
0be393be22 Removed check for no package name
.UNINDENT
.IP \(bu 2
0227e1cb57 Merge pull request \fI\%#27053\fP from rallytime/bp\-26992
.INDENT 2.0
.IP \(bu 2
83798aff3c Do not use full return for documentation.
.IP \(bu 2
d9d5bbaa68 Summary requires full return information.
.UNINDENT
.IP \(bu 2
b72a0ef86d Merge pull request \fI\%#27052\fP from rallytime/bp\-26930
.INDENT 2.0
.IP \(bu 2
d9787aa318 aptpkg.mod_repo: Raise when key_url doesn\(aqt exist
.UNINDENT
.IP \(bu 2
8b554dd16f Merge pull request \fI\%#27049\fP from johanek/repoquery\-dedupe
.INDENT 2.0
.IP \(bu 2
c113916a23 When running repoquery to check for available versions of packages, run once for all packages rather than once per package
.UNINDENT
.IP \(bu 2
cc2cbf9869 Merge pull request \fI\%#27070\fP from stanislavb/2015.5
.INDENT 2.0
.IP \(bu 2
1e6e5ddc9c Deprecate salt.utils.iam in Carbon
.UNINDENT
.IP \(bu 2
e23caa8ccf Merge pull request \fI\%#27030\fP from jfindlay/winreg
.INDENT 2.0
.IP \(bu 2
120fbe78e0 remove trailing line in win_path exec module
.IP \(bu 2
b36a7107b2 update win_path exec module unit tests
.IP \(bu 2
a2dc6f2dd7 Fixes win_path module, migrates from reg.(set|get)_key to reg.(set|get)_value
.UNINDENT
.IP \(bu 2
843c28b435 Merge pull request \fI\%#27025\fP from cachedout/issue_25581
.INDENT 2.0
.IP \(bu 2
ecc09d9b93 Lint
.IP \(bu 2
bfcaab9ef4 Better try and error handling for prep_jid
.UNINDENT
.IP \(bu 2
b9baa0b39a Merge pull request \fI\%#27035\fP from terminalmage/useradd\-contextmanager
.INDENT 2.0
.IP \(bu 2
e430e97f6c Update user states to reflect changes to login class handling
.IP \(bu 2
f24b979c7c useradd.py: Use contextmanager to prevent leaked filehandles
.UNINDENT
.IP \(bu 2
1cdfdf7a92 Merge pull request \fI\%#27034\fP from rallytime/softlayer\-doc\-fix
.INDENT 2.0
.IP \(bu 2
cb641f8145 Update softlayer docs for where to find apikey
.UNINDENT
.IP \(bu 2
9e06d3f01a Merge pull request \fI\%#27024\fP from rallytime/bp\-27004
.INDENT 2.0
.IP \(bu 2
54d6fcf4c7 Fix \(aqdict\(aq object has no attribute split
.IP \(bu 2
bb29d73c71 Fix \(aqdict\(aq object has no attribute split
.IP \(bu 2
5f1a9c46aa Fix \(aqdict\(aq object has no attribute split
.IP \(bu 2
2bfdd9724e Fix \(aqdict\(aq object has no attribute split
.UNINDENT
.IP \(bu 2
9ab2cae1e4 Merge pull request \fI\%#27027\fP from rallytime/bp\-27013
.INDENT 2.0
.IP \(bu 2
19a6e9cb1c Remove unwanted debug statement.
.UNINDENT
.IP \(bu 2
2c8beb238f Merge pull request \fI\%#27026\fP from rallytime/bp\-27011
.INDENT 2.0
.IP \(bu 2
f8518d545f Move giant eventlisten.sh example out of the state.event docstring
.UNINDENT
.IP \(bu 2
e8cdcc62f7 Merge pull request \fI\%#26972\fP from twangboy/fix_20522
.INDENT 2.0
.IP \(bu 2
0110786fa9 Catch the 404 error from fileclient
.UNINDENT
.IP \(bu 2
fbc95f4685 Merge pull request \fI\%#26951\fP from terminalmage/fix\-timezone
.INDENT 2.0
.IP \(bu 2
30a4915762 Update tests to reflect changes to timezone module
.IP \(bu 2
b6f926919f Fix timezone module for CentOS
.UNINDENT
.IP \(bu 2
f2ad3c333c Merge pull request \fI\%#26875\fP from marccardinal/patch\-2
.INDENT 2.0
.IP \(bu 2
36d5a62262 LXC gateway provisioned only when IP is provided
.UNINDENT
.IP \(bu 2
7b2e7b1b37 Merge pull request \fI\%#26997\fP from twangboy/fix_symlink_windows
.INDENT 2.0
.IP \(bu 2
89cc02d4e0 Added \fIversionadded\fP
.IP \(bu 2
835177b0c8 Fixed symlinks for windows (don\(aqt use user root)
.UNINDENT
.IP \(bu 2
5389a85894 Merge pull request \fI\%#27001\fP from twangboy/fix_reg_docs
.INDENT 2.0
.IP \(bu 2
2980bbda17 Minor clarification
.IP \(bu 2
4684b2ddd1 Added CLI example for reg.delete_key_recursive
.UNINDENT
.IP \(bu 2
37814f5dff Merge pull request \fI\%#26996\fP from jacobhammons/beacon\-doc
.INDENT 2.0
.IP \(bu 2
e475ea688e Fixed typo
.IP \(bu 2
2401533d9e New content added to beacon docs.
.UNINDENT
.IP \(bu 2
4ba7eed711 Merge pull request \fI\%#26868\fP from joejulian/2015.5_lvm_vg_symlink_fix
.INDENT 2.0
.IP \(bu 2
3dfb33849a Use the actual device name when checking vgdisplay
.UNINDENT
.IP \(bu 2
1537e945be Merge pull request \fI\%#26955\fP from dsumsky/s3\-pillar\-module\-cache\-fix\-2015.5
.INDENT 2.0
.IP \(bu 2
8219acffe7 \- fixed pylint warnings
.IP \(bu 2
a3b10e8ab1  \- fixed broken caching in S3 ext_pillar module (file_md5 was a list)  \- added debugging messages  \- static parameters are available as module parameters now
.UNINDENT
.IP \(bu 2
3e902e86b1 Merge pull request \fI\%#26987\fP from rallytime/bp\-26966
.INDENT 2.0
.IP \(bu 2
6a29eac003 URL has changed
.UNINDENT
.IP \(bu 2
eddb532713 Merge pull request \fI\%#26915\fP from rallytime/joyent\-tests
.INDENT 2.0
.IP \(bu 2
d4ad42d697 Update Joyent Cloud Tests
.UNINDENT
.IP \(bu 2
f86814b2a4 Merge pull request \fI\%#26971\fP from rallytime/reactor\-doc\-fix
.INDENT 2.0
.IP \(bu 2
0214daad19 Fix a couple of typos in reactor docs
.UNINDENT
.IP \(bu 2
57b1080f94 Merge pull request \fI\%#26976\fP from saltstack/revert\-26899\-fix_26730
.INDENT 2.0
.IP \(bu 2
6dd54e6bec Revert \(dqfile.symlink gets windows account instead of root\(dq
.UNINDENT
.IP \(bu 2
67be01f5fe Merge pull request \fI\%#26975\fP from whiteinge/rest_cherrypy\-integration
.INDENT 2.0
.IP \(bu 2
9a0989585b Add additional \(aqgroups\(aq check to rest_cherrypy if groups are not used
.IP \(bu 2
d68aefcfde Remove mocks from rest_cherrypy integration tests
.IP \(bu 2
2aa3da8911 Rename the rest_cherrypy tests to conform to our convention
.UNINDENT
.IP \(bu 2
20a48f7f2e Merge pull request \fI\%#26899\fP from twangboy/fix_26730
.INDENT 2.0
.IP \(bu 2
9d9b3bb47a file.symlink gets windows account instead of root
.UNINDENT
.IP \(bu 2
dbc6b862f4 Merge pull request \fI\%#26960\fP from rallytime/cherrypy\-docs
.INDENT 2.0
.IP \(bu 2
c1420711db Fix bash code block formatting
.UNINDENT
.IP \(bu 2
f733e048c9 Merge pull request \fI\%#26940\fP from rallytime/api\-doc\-fix
.INDENT 2.0
.IP \(bu 2
00fe6a225c Fix minor doc typo in client api
.UNINDENT
.IP \(bu 2
de9350466e Merge pull request \fI\%#26871\fP from rallytime/bp\-26852
.INDENT 2.0
.IP \(bu 2
5a4c8dd2f5 Only reference msgpack if it imported successfully
.UNINDENT
.IP \(bu 2
a563af29d3 Merge pull request \fI\%#26851\fP from jacobhammons/doc\-bugs
.INDENT 2.0
.IP \(bu 2
ac3bd47440 states/pkgrepo examples, suse installation updates Refs \fI\%#26644\fP Refs \fI\%#26638\fP
.UNINDENT
.IP \(bu 2
5b1b934192 Merge pull request \fI\%#26817\fP from jfindlay/grouparg
.INDENT 2.0
.IP \(bu 2
82d33939f3 modify groupadd for rhel 5
.UNINDENT
.IP \(bu 2
cdc0ea2fe3 Merge pull request \fI\%#26824\fP from pravka/fix\-droplet\-creation\-from\-snapshot\-in\-dov2
.INDENT 2.0
.IP \(bu 2
00e3192536 removing log
.IP \(bu 2
e4a82d78d9 removing stringification of every value in the image dict
.IP \(bu 2
cdc2b4584a fixing condition for slug check
.UNINDENT
.IP \(bu 2
4af6951a4c Merge pull request \fI\%#26823\fP from joejulian/ctlfix
.INDENT 2.0
.IP \(bu 2
a9928cb143 pep8 fixes
.IP \(bu 2
6108ec4280 Gated dbus for os families that use it
.IP \(bu 2
e154c7b16f remove trailing spaces
.IP \(bu 2
c1c1266cc3 fix indent change
.IP \(bu 2
0a35320aa7 Use dbus directly
.UNINDENT
.IP \(bu 2
a1749b76b8 Merge pull request \fI\%#26820\fP from jfindlay/ctlfix
.INDENT 2.0
.IP \(bu 2
3a2c0d5fbb add default param in _parse_localectl in locale mod
.UNINDENT
.IP \(bu 2
ff733547c4 Merge pull request \fI\%#26821\fP from twangboy/fix_26788
.INDENT 2.0
.IP \(bu 2
cf979e4877 Fixed user.rename function in windows
.UNINDENT
.IP \(bu 2
c892be3255 Merge pull request \fI\%#26803\fP from twangboy/fix_26754
.INDENT 2.0
.IP \(bu 2
23576c65eb Added check for PyMySQL if MySQLdb import fails
.UNINDENT
.IP \(bu 2
6edfa36083 Merge pull request \fI\%#26815\fP from jfindlay/linstr
.IP \(bu 2
2ff5823944 stringify linode id before performing str actions
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27122\fP: (\fI\%terminalmage\fP) Fix broken link to git\-config(1) docs
@ \fI2015\-09\-15 07:25:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
886e7bc234 Merge pull request \fI\%#27122\fP from terminalmage/fix\-broken\-link
.IP \(bu 2
0b212ea5b3 Fix broken link to git\-config(1) docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27115\fP: (\fI\%jacobhammons\fP) Release docs
@ \fI2015\-09\-14 22:19:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
551bbe70af Merge pull request \fI\%#27115\fP from jacobhammons/release\-docs
.IP \(bu 2
42eaa80997 Restored missing css
.IP \(bu 2
9ab642295e Fixed a release notes typo and bad file rename
.IP \(bu 2
daa3f4eee0 Updated release notes, change 2015.8 to latest release for doc site
.IP \(bu 2
d939a38c8c release notes updates
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#11993\fP: (\fI\%UtahDave\fP) salt\-cloud \-Q output not consistent across providers (refs: \fI\%#27110\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27110\fP: (\fI\%rallytime\fP) Make sure \-Q output is consistent across salt\-cloud drivers
@ \fI2015\-09\-14 21:48:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
89c90df909 Merge pull request \fI\%#27110\fP from rallytime/fix\-11993
.IP \(bu 2
c1abc5a19f Remove implied Nones
.IP \(bu 2
5d7d357cdd digital_ocean list_nodes function should list public and private ips like other drivers
.IP \(bu 2
4b27aef406 Add \(aqname\(aq to the output of salt\-cloud \-Q commands, where needed, for consistency.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27050\fP: (\fI\%twangboy\fP) Turned multiprocessing on
@ \fI2015\-09\-14 17:34:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
860de8d877 Merge pull request \fI\%#27050\fP from twangboy/fix_minion_conf
.IP \(bu 2
7e35b13022 Turned multiprocessing on
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27086\fP: (\fI\%techhat\fP) Document development of SPM loader modules
@ \fI2015\-09\-13 04:52:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
c78d833540 Merge pull request \fI\%#27086\fP from techhat/spmdevdocs
.IP \(bu 2
ee0c8955dd Document development of SPM loader modules
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23125\fP: (\fI\%bemeyert\fP) Elasticsearch as master_job_cache throws critical (refs: \fI\%#26941\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26941\fP: (\fI\%msteed\fP) Make elasticsearch work as master job cache
@ \fI2015\-09\-12 17:13:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
25b11759f9 Merge pull request \fI\%#26941\fP from msteed/issue\-23125
.IP \(bu 2
ff88fe402c add versionadded info to save_load() & get_load()
.IP \(bu 2
5d2fae8a89 make master job cache index configurable
.IP \(bu 2
bc041fa4a7 Merge branch \(aqissue\-23125\(aq of github.com:msteed/salt into issue\-23125
.INDENT 2.0
.IP \(bu 2
9aedc2662e issue\-23125
.UNINDENT
.IP \(bu 2
593c4d6b2f issue\-23125
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27080\fP: (\fI\%bechtoldt\fP) [Proposal] Add Github SPM label for issues
@ \fI2015\-09\-12 14:32:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
b763d0ba52 Merge pull request \fI\%#27080\fP from bechtoldt/spm_doc
.IP \(bu 2
b9e5095bf5 add GH issue label SPM to docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27064\fP: (\fI\%twangboy\fP) Fixed user docs
@ \fI2015\-09\-11 22:37:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
cf59a03432 Merge pull request \fI\%#27064\fP from twangboy/user_docs
.IP \(bu 2
db03ca198e Fixed user docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27072\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26840\fP to 2015.8
@ \fI2015\-09\-11 22:35:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26840\fP: (\fI\%deuscapturus\fP) Update http.py (refs: \fI\%#27072\fP)
.IP \(bu 2
71c12cbf46 Merge pull request \fI\%#27072\fP from rallytime/bp\-26840
.IP \(bu 2
d0b9ececa4 Update http.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27060\fP: (\fI\%cro\fP) Fix grains breakage when hosts are not Linux, Windows, or SunOS
@ \fI2015\-09\-11 17:28:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
0e7555089f Merge pull request \fI\%#27060\fP from cro/proxy_grains_breakage
.IP \(bu 2
e697326f1b Don\(aqt check for proxy in the individual is_linux/is_windows/etc functions.  This breaks too many things.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27051\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26953\fP to 2015.8
@ \fI2015\-09\-11 16:28:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26953\fP: (\fI\%dsumsky\fP) S3 ext_pillar module has broken caching mechanism (refs: \fI\%#27051\fP)
.IP \(bu 2
8ee87b9f61 Merge pull request \fI\%#27051\fP from rallytime/bp\-26953
.IP \(bu 2
eac9d9aba9 Pylint Fix
.IP \(bu 2
453440753c \- fixed pylint warnings
.IP \(bu 2
b40dfa459e \- fixed broken caching in S3 ext_pillar module (file_md5 was a list) \- added debugging messages \- static parameters are available as module parameters now
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26864\fP: (\fI\%terminalmage\fP) Only do git_pillar preflight checks on new\-style git_pillar configs
@ \fI2015\-09\-11 07:47:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
249f55cd8c Merge pull request \fI\%#26864\fP from terminalmage/fix\-git_pillar\-tests
.IP \(bu 2
0b5a653f7c Only do git_pillar preflight checks on new\-style git_pillar configs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26967\fP: (\fI\%TheBigBear\fP) new URL for windows salt downloads
@ \fI2015\-09\-10 20:51:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
efaedb8aea Merge pull request \fI\%#26967\fP from TheBigBear/patch\-4
.IP \(bu 2
8d2c042cf7 new URL for windows salt downloads
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26921\fP: (\fI\%terminalmage\fP) Get rid of error in legacy git pillar when using branch mapping notation
@ \fI2015\-09\-10 20:06:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
757d3c4eab Merge pull request \fI\%#26921\fP from terminalmage/legacy_git_pillar_tests
.IP \(bu 2
28e07d5d06 Get rid of error in legacy git pillar when using branch mapping notation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26923\fP: (\fI\%rallytime\fP) Code clean up of cloud drivers and files
@ \fI2015\-09\-10 16:37:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
68eb508e6c Merge pull request \fI\%#26923\fP from rallytime/cloud\-cleanup
.IP \(bu 2
bf33c99b08 Remove redundant parentheses
.IP \(bu 2
5045989be7 Make sure function names comply
.IP \(bu 2
e327d9a8a4 Remove redundant parens
.IP \(bu 2
eee0291ff8 Code clean up of cloud drivers and files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27010\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26988\fP to 2015.8
@ \fI2015\-09\-10 16:30:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26988\fP: (\fI\%s0undt3ch\fP) Process \fIspm.d/*.conf\fP and add prefix root dir support to SPM directories (refs: \fI\%#27010\fP)
.IP \(bu 2
590c46f4e3 Merge pull request \fI\%#27010\fP from rallytime/bp\-26988
.IP \(bu 2
93b30b5ba8 Whitespace
.IP \(bu 2
685fa911e7 Version Added for new apply_spm_config function
.IP \(bu 2
9612a6c7ad Process \fIspm.d/*.conf\fP and add prefix root dir support to SPM directories
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26985\fP: (\fI\%rallytime\fP) Fix versionadded tag
@ \fI2015\-09\-10 16:29:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec185d77fa Merge pull request \fI\%#26985\fP from rallytime/versionadded\-fix
.IP \(bu 2
79eb606cb7 Fix versionadded tag
.UNINDENT
.UNINDENT
.SS Salt 2015.8.10 Release Notes
.sp
Version 2015.8.10 is a bugfix release for \fI\%2015.8.0\fP\&.
.sp
This release includes fixes for two issues discovered in \fI\%2015.8.9\fP:
.INDENT 0.0
.IP \(bu 2
Pip state broken in 2015.8.9 with pip <6.0 (\fI\%issue 33376\fP)
.IP \(bu 2
Fix traceback in logging for config validation (\fI\%PR 33386\fP)
.UNINDENT
.SS Final Release of Debian 7 Packages
.sp
Regular security support for Debian 7 ended on April 25th 2016. As a result,
2016.3.1 and 2015.8.10 will be the last Salt releases for which Debian
7 packages are created.
.SS Important Post\-Upgrade Instructions for Linux Mint
.sp
As a result of some upstream changes, the \fBos\fP grain on Mint Linux is now
being detected as \fBLinuxMint\fP (\fI\%issue 33295\fP). Run the following command
\fBafter you upgrade to 2015.8.10\fP to reset the \fBos\fP grain to \fBMint\fP and
the \fBos_family\fP grain to \fBDebian\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos:LinuxMint\(aq grains.setvals \(dq{\(aqos\(aq: \(aqMint\(aq, \(aqos_family\(aq: \(aqDebian\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Changelog for v2015.8.9..v2015.8.10
.sp
\fIGenerated at: 2018\-05\-28 00:51:57 UTC\fP
.INDENT 0.0
.IP \(bu 2
c3d2c4eaae Fix traceback in logging for config validation (\fI\%#33386\fP)
.IP \(bu 2
2a060ea1e8 restore whitespace
.IP \(bu 2
aa1f45d664 blast, put the try/except int he right place
.IP \(bu 2
be1a7659a3 maintain the fallabck because I am totally sick of this crap
.UNINDENT
.SS Salt 2015.8.11 Release Notes
.sp
Version 2015.8.11 is a bugfix release for \fI\%2015.8.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB122\fP
.IP \(bu 2
Total Issue References: \fB70\fP
.IP \(bu 2
Total PR References: \fB221\fP
.IP \(bu 2
Contributors: \fB48\fP (\fI\%AAbouZaid\fP, \fI\%BlaineAtAffirm\fP, \fI\%DmitryKuzmenko\fP, \fI\%The\-Loeki\fP,
\fI\%abednarik\fP, \fI\%babilen\fP, \fI\%bebehei\fP, \fI\%cachedout\fP, \fI\%clinta\fP, \fI\%complexsplit\fP, \fI\%cro\fP,
\fI\%danslimmon\fP, \fI\%dcolish\fP, \fI\%dincamihai\fP, \fI\%edgan\fP, \fI\%gerhardqux\fP, \fI\%ghedo\fP, \fI\%isbm\fP,
\fI\%jacobhammons\fP, \fI\%jfindlay\fP, \fI\%jodv\fP, \fI\%justinta\fP, \fI\%l13t\fP, \fI\%lomeroe\fP, \fI\%lorengordon\fP,
\fI\%lvg01\fP, \fI\%mcalmer\fP, \fI\%meaksh\fP, \fI\%morganwillcock\fP, \fI\%oeuftete\fP, \fI\%opdude\fP, \fI\%phistrom\fP,
\fI\%rallytime\fP, \fI\%rmarcinik\fP, \fI\%ryan\-lane\fP, \fI\%sacren\fP, \fI\%steverweber\fP, \fI\%techhat\fP, \fI\%tegbert\fP,
\fI\%terminalmage\fP, \fI\%thatch45\fP, \fI\%the\-glu\fP, \fI\%thegoodduke\fP, \fI\%ticosax\fP, \fI\%tveastman\fP, \fI\%twangboy\fP,
\fI\%vutny\fP, \fI\%zer0def\fP)
.UNINDENT
.SS Ubuntu 16.04 Packages
.sp
SaltStack is now providing official Salt 2015.8 \fI\%packages\fP for Ubuntu 16.04.
.SS Returner Changes
.INDENT 0.0
.IP \(bu 2
Any returner which implements a \fBsave_load\fP function is now required to
accept a \fBminions\fP keyword argument. All returners which ship with Salt
have been modified to do so.
.UNINDENT
.SS New Master Configuration Parameter
.INDENT 0.0
.IP \(bu 2
\fI\%rotate_aes_key\fP \- if \fBTrue\fP, causes Salt to generate a new
AES key whenever a minion key is deleted. This eliminates the chance that a
deleted minion could continue to eavesdrop on communications with the master
if it continues to run after its key is deleted.
.UNINDENT
.SS Changelog for v2015.8.10..v2015.8.11
.sp
\fIGenerated at: 2018\-05\-28 01:16:12 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#34682\fP: (\fI\%jfindlay\fP) update 2015.8.11 release notes
.IP \(bu 2
\fBPR\fP \fI\%#34676\fP: (\fI\%cachedout\fP) Revert \(dqModify lodaer global test to use populated dunders\(dq
@ \fI2016\-07\-14 18:12:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
3192e1674b Merge pull request \fI\%#34676\fP from cachedout/partial_revert_34644
.IP \(bu 2
64a154826a Revert \(dqModify lodaer global test to use populated dunders\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34601\fP: (\fI\%lorengordon\fP) Clarifies the proper way to reference states
@ \fI2016\-07\-14 14:20:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
3b6f1089b2 Merge pull request \fI\%#34601\fP from lorengordon/clarify\-doc
.IP \(bu 2
bfe0dd0b8a Clarifies the proper way to reference states
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#34644\fP: (\fI\%cachedout\fP) Cleanup loader errors (refs: \fI\%#34651\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34651\fP: (\fI\%rallytime\fP) Lint 34644
.IP \(bu 2
\fBPR\fP \fI\%#34647\fP: (\fI\%cachedout\fP) Adjust the mine test a little bit to give it a better chance of success
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34642\fP: (\fI\%justinta\fP) Check that mysqladmin exists before running mysql integration tests
@ \fI2016\-07\-13 18:12:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
8a0209101e Merge pull request \fI\%#34642\fP from jtand/mysql_integration_cleanup
.IP \(bu 2
dd1559a599 Check that mysqladmin exists before running mysql integration tests.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34618\fP: (\fI\%justinta\fP) Network state integration test test=True
@ \fI2016\-07\-13 16:30:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e612c3794 Merge pull request \fI\%#34618\fP from jtand/network_integration_fix
.IP \(bu 2
34bcf9ccfc Changed network state test to use test=True
.IP \(bu 2
b2616833b0 Some small changes
.IP \(bu 2
ed59113e94 Change network state integration test to use test=True
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34617\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-07\-12 20:11:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
9f123543e5 Merge pull request \fI\%#34617\fP from rallytime/merge\-2015.8
.IP \(bu 2
3026df346f Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
57df38e685 Update github IP for ssh state integration tests (\fI\%#34592\fP)
.IP \(bu 2
2e1007254b Avoid circular imports when calling salt.utils functions (\fI\%#34584\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33649\fP: (\fI\%tyhunt99\fP) 2016.3.0 dockerng state fails comparing cmd configuration (refs: #saltstack/salt\(ga#33851\(ga_, \fI\%#33851\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#33851\fP: (\fI\%ticosax\fP) [dockerng] Add support for edge case when \fICmd\fP and \fIEntrypoint\fP can\(aqt be blanked (refs: \fI\%#34593\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34593\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33851\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#33851\fP: (\fI\%ticosax\fP) [dockerng] Add support for edge case when \fICmd\fP and \fIEntrypoint\fP can\(aqt be blanked (refs: \fI\%#34593\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34590\fP: (\fI\%oeuftete\fP) [2015.8] dockerng: When sorting list actual_data, make it a list
.IP \(bu 2
\fBPR\fP \fI\%#34591\fP: (\fI\%justinta\fP) Gate docker unit test to check for docker
.IP \(bu 2
\fBPR\fP \fI\%#34560\fP: (\fI\%terminalmage\fP) Add a bunch of documentation on getting files from other environments
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34397\fP: (\fI\%jaredhanson11\fP) ignore_epoch needs to be passed through to version_cmp functions (refs: \fI\%#34531\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34531\fP: (\fI\%terminalmage\fP) Support ignore_epoch argument in version comparisons
@ \fI2016\-07\-08 16:43:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
91e0656d44 Merge pull request \fI\%#34531\fP from terminalmage/issue34397
.IP \(bu 2
d0fec1b8f6 salt/modules/zypper.py: accept ignore_epoch argument
.IP \(bu 2
5ae9463c1f salt/modules/yumpkg.py: accept ignore_epoch argument
.IP \(bu 2
c2791117af salt/modules/rpm.py: accept ignore_epoch argument
.IP \(bu 2
c5de8b880d salt/modules/ebuild.py: accept ignore_epoch argument
.IP \(bu 2
4ee8e8f037 salt/modules/aptpkg.py: accept ignore_epoch argument
.IP \(bu 2
5b123b403c Pass ignore_epoch to salt.utils.compare_versions()
.IP \(bu 2
07368fac40 Accept ignore_epoch argument for salt.utils.compare_versions()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34545\fP: (\fI\%terminalmage\fP) Handle cases where Docker Remote API returns an empty ExecutionDriver
@ \fI2016\-07\-08 16:34:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
e99befad47 Merge pull request \fI\%#34545\fP from terminalmage/docker\-exec\-driver
.IP \(bu 2
dd5838e242 Handle cases where Docker Remote API returns an empty ExecutionDriver
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34546\fP: (\fI\%rallytime\fP) Rename unit.states.boto_secgroup to unit.states.boto_secgroup_test
@ \fI2016\-07\-08 16:16:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
7120d43df0 Merge pull request \fI\%#34546\fP from rallytime/rename\-boto\-secgroup\-test
.IP \(bu 2
f8a3622be7 Rename unit.states.boto_secgroup to unit.states.boto_secgroup_test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34537\fP: (\fI\%rallytime\fP) Rename tests.unit.simple to tests.unit.simple_test
@ \fI2016\-07\-08 00:08:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca92061821 Merge pull request \fI\%#34537\fP from rallytime/rename\-simple\-test
.IP \(bu 2
ceefb6e34c Rename tests.unit.simple to tests.unit.simple_test
.IP \(bu 2
\fBPR\fP \fI\%#34527\fP: (\fI\%rallytime\fP) [2015.8] Update bootstrap script to latest stable
.IP \(bu 2
\fBPR\fP \fI\%#34521\fP: (\fI\%cachedout\fP) Prevent many errors in the test suite in loader tests
.IP \(bu 2
\fBPR\fP \fI\%#34507\fP: (\fI\%AAbouZaid\fP) Fix wrong order of retention_policy_exists.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34518\fP: (\fI\%terminalmage\fP) Fix pkg.latest integration test for non\-LTS ubuntu
@ \fI2016\-07\-07 19:29:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
685df80929 Merge pull request \fI\%#34518\fP from terminalmage/fix\-pkg.latest\-test
.IP \(bu 2
4aef44ecdf Fix pkg.latest integration test for non\-LTS ubuntu
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34513\fP: (\fI\%cachedout\fP) Lower the log level for modules which cannot be loaded to trace
@ \fI2016\-07\-07 17:00:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
a516f116d1 Merge pull request \fI\%#34513\fP from cachedout/lower_loader_log
.IP \(bu 2
733c5d00c0 Lower the log level for modules which cannot be loaded to trace
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34498\fP: (\fI\%rallytime\fP) Use \-O in the wget example in the bootstrap tutorial for the develop branch
@ \fI2016\-07\-07 16:30:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
63f0451041 Merge pull request \fI\%#34498\fP from rallytime/bootstrap\-tutorial\-doc\-fix
.IP \(bu 2
23c5739c3b Use \-O in wget develop example in bootstrap tutorial
.IP \(bu 2
\fBPR\fP \fI\%#34503\fP: (\fI\%rallytime\fP) Rename some unit test files by adding _test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34302\fP: (\fI\%ghost\fP) Salt gitfs loads top files from all branches and tags (refs: \fI\%#34505\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34505\fP: (\fI\%terminalmage\fP) Improve top file merging documentation
.IP \(bu 2
\fBPR\fP \fI\%#34492\fP: (\fI\%zer0def\fP) Gracefully handle non\-XML output in GlusterFS execution module.
.IP \(bu 2
\fBPR\fP \fI\%#34489\fP: (\fI\%justinta\fP) Use skipTest for network state integration test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34261\fP: (\fI\%vernondcole\fP) salt.modules.dnsmasq documentation errors (refs: \fI\%#34488\fP, \fI\%#34323\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34488\fP: (\fI\%rallytime\fP) Update dnsmasq.get_config docs to use correct config_file param.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34462\fP: (\fI\%terminalmage\fP) Use \-\-always when available to git describe
@ \fI2016\-07\-06 03:59:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
e2f576e847 Merge pull request \fI\%#34462\fP from terminalmage/git\-describe\-always
.IP \(bu 2
6ef7ee198e Restrict use of \-\-always to git 1.5.6 and newer
.IP \(bu 2
c554b22fc8 modules/git: added \-\-always parameter for git.describe().
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34467\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34457\fP to 2015.8
@ \fI2016\-07\-06 03:56:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34457\fP: (\fI\%ryan\-lane\fP) Only access key metadata if we found key metadata (refs: \fI\%#34467\fP)
.IP \(bu 2
85f1f18239 Merge pull request \fI\%#34467\fP from rallytime/bp\-34457
.IP \(bu 2
746883741f Only access key metadata if we found key metadata
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34432\fP: (\fI\%twangboy\fP) Fix file.append
@ \fI2016\-07\-05 23:14:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
9e15337b74 Merge pull request \fI\%#34432\fP from twangboy/fix_file.append
.IP \(bu 2
13f11fddce Remove refactoring code
.IP \(bu 2
78f7c530bb Remove unit tests, integration tests written
.IP \(bu 2
b83392edea Remove len() in favor of boolean test
.IP \(bu 2
4373408163 Fix line error
.IP \(bu 2
2479b53e2f Fix erroneous report on newline code
.IP \(bu 2
75b6ed1fd5 Change back to binary read
.IP \(bu 2
65753cff6d Use os.linesep instead of n
.IP \(bu 2
a55d63f086 Fix object names
.IP \(bu 2
3e2fe12e5e Add new line if missing
.IP \(bu 2
0b7821c8db Fix file.append state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34429\fP: (\fI\%terminalmage\fP) Skip version checking for targeted packages in pkg.latest state
@ \fI2016\-07\-05 17:50:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
91e095bb41 Merge pull request \fI\%#34429\fP from terminalmage/pkg\-latest\-versioncheck
.IP \(bu 2
667f31a72a Skip version checking for targeted packages in pkg.latest state
.IP \(bu 2
\fBPR\fP \fI\%#34455\fP: (\fI\%cro\fP) Forgot reference to inotify
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34451\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-07\-05 15:57:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
7bb0868c66 Merge pull request \fI\%#34451\fP from rallytime/merge\-2015.8
.IP \(bu 2
55a91e22be Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
8c72ee56e4 Merge pull request \fI\%#34435\fP from cachedout/backport_config_dir_integration
.INDENT 2.0
.IP \(bu 2
0e2c71a537 Backport change to integraiton test suite
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34390\fP: (\fI\%mgresser\fP) Use rpmdev\-vercmp to determine correct version of rpms in CentOS5 (refs: \fI\%#34401\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34401\fP: (\fI\%terminalmage\fP) Use rpmdev\-vercmp as a fallback for version comparison on RHEL5
@ \fI2016\-07\-01 17:42:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
e65d1ae374 Merge pull request \fI\%#34401\fP from terminalmage/rpm\-version_cmp
.IP \(bu 2
7cefd4182d Use rpmdev\-vercmp as a fallback for version comparison on RHEL5
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34366\fP: (\fI\%steverweber\fP) Update service.py
@ \fI2016\-07\-01 17:40:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
5ddf417432 Merge pull request \fI\%#34366\fP from steverweber/fix_servicerestart
.IP \(bu 2
7847c39024 Update service.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34426\fP: (\fI\%cro\fP) Document that inotify is Linux only
@ \fI2016\-07\-01 17:04:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
485454febb Merge pull request \fI\%#34426\fP from cro/inotify\-linux\-only
.IP \(bu 2
54a02f25ba Document that inotify is Linux only
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34392\fP: (\fI\%cro\fP) Clarify that salt\-cloud doesn\(aqt get installed by bootstrap
@ \fI2016\-06\-30 18:16:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
fe18bbb527 Merge pull request \fI\%#34392\fP from cro/salt\-cloud\-doc\-clarify
.IP \(bu 2
6cce575d40 Clarify that salt\-cloud doesn\(aqt get installed by bootstrap
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34373\fP: (\fI\%justinta\fP) Network state integration test
@ \fI2016\-06\-30 15:05:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
45b8fb10d7 Merge pull request \fI\%#34373\fP from jtand/network_state_integration_test
.IP \(bu 2
1d24053e36 network.system sls file
.IP \(bu 2
4a9e6af542 network.routes sls file
.IP \(bu 2
76c90b2ef6 network.managed sls file
.IP \(bu 2
84a36369fa Added network state integration test
.IP \(bu 2
\fBPR\fP \fI\%#34377\fP: (\fI\%terminalmage\fP) Optimize pkg integration tests and add a couple new tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34368\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-06\-29 17:54:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
af8ef1e461 Merge pull request \fI\%#34368\fP from rallytime/merge\-2015.8
.IP \(bu 2
3bce0cb510 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
970aaa46d4 Merge pull request \fI\%#34252\fP from gtmanfred/2015.5
.INDENT 2.0
.IP \(bu 2
82183f1572 return list of nodes for lxc driver when called directly
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34344\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34324\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#34324\fP: (\fI\%cachedout\fP) Test custom grains matcher (refs: \fI\%#34344\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33674\fP: (\fI\%edgan\fP) salt\-ssh returns a zero code on jinja template failure. (refs: \fI\%#34316\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#28300\fP: (\fI\%srkunze\fP) [salt\-ssh] Does not return non\-zero exit code (refs: \fI\%#34316\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34342\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34316\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#34316\fP: (\fI\%edgan\fP) Making salt\-ssh pass proper return codes for jinja rendering errors (refs: \fI\%#34342\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34339\fP: (\fI\%terminalmage\fP) Revert py3modernize lint changes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34306\fP: (\fI\%ghedo\fP) Fix iptables.flush state: Do not force \(aqfilter\(aq table when flushing
@ \fI2016\-06\-28 19:03:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
046bdaa9f2 Merge pull request \fI\%#34306\fP from ghedo/iptables_flush_table
.IP \(bu 2
882c6c9c86 Do not force \(aqfilter\(aq table when flushing
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34261\fP: (\fI\%vernondcole\fP) salt.modules.dnsmasq documentation errors (refs: \fI\%#34488\fP, \fI\%#34323\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34249\fP: (\fI\%ssgward\fP) Clarify doc on file.copy (refs: \fI\%#34323\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34247\fP: (\fI\%gravyboat\fP) Update logging docs to mention profile level (refs: \fI\%#34323\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33694\fP: (\fI\%hjc\fP) Document That Local Files Can Be Used as a Source for File States (refs: \fI\%#34323\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34323\fP: (\fI\%jacobhammons\fP) Doc clarifications to file modules, addition of new \fIprofile\fP log lev…
.IP \(bu 2
\fBPR\fP \fI\%#34325\fP: (\fI\%terminalmage\fP) Remove unnecessarily\-disabled sanity check
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34335\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-06\-28 15:07:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
c5890a0eca Merge pull request \fI\%#34335\fP from rallytime/merge\-2015.8
.IP \(bu 2
2296587536 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
6cce545d92 Merge pull request \fI\%#34313\fP from rallytime/bootstrap\-2015.5
.INDENT 2.0
.IP \(bu 2
c7db73be92 [2015.5] Update to latest bootstrap script v2016.06.27
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34319\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34244\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#34244\fP: (\fI\%the\-glu\fP) Typo in dockerio doc (refs: \fI\%#34319\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34312\fP: (\fI\%rallytime\fP) [2015.8] Update to latest bootstrap script v2016.06.27
@ \fI2016\-06\-27 18:59:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd4c937009 Merge pull request \fI\%#34312\fP from rallytime/bootstrap\-2015.8
.IP \(bu 2
944a393f89 [2015.8] Update to latest bootstrap script v2016.06.27
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34307\fP: (\fI\%rallytime\fP) Fix test example in integration testing docs
@ \fI2016\-06\-27 17:41:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
91703d2dc4 Merge pull request \fI\%#34307\fP from rallytime/fix\-test\-example
.IP \(bu 2
f44a0543fe Fix test example in integration testing docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34233\fP: (\fI\%thegoodduke\fP) ipset: fix the comment containing blank
@ \fI2016\-06\-24 19:28:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
d235b1245b Merge pull request \fI\%#34233\fP from thegoodduke/for_2015.8_ipset
.IP \(bu 2
4da5e35bf4 ipset: fix the comment containing blank
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34037\fP: (\fI\%bobrik\fP) salt\-call ignores \-\-config\-dir resulting in failing gpg renderer (refs: \fI\%#34257\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34257\fP: (\fI\%rallytime\fP) Use \(aqconfig_dir\(aq setting instead of CONFIG_DIR in gpg renderer
@ \fI2016\-06\-24 17:25:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
65c5675a3f Merge pull request \fI\%#34257\fP from rallytime/fix\-34037
.IP \(bu 2
d7a5e9b10e Remove test that doesn\(aqt actually test anything
.IP \(bu 2
c4c037d600 Use \(aqconfig_dir\(aq setting instead of CONFIG_DIR in gpg renderer
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34273\fP: (\fI\%clinta\fP) file.recurse does not properly cache files, adds a pipe to path (refs: \fI\%#34274\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34274\fP: (\fI\%clinta\fP) Don\(aqt escape source before calling managed
@ \fI2016\-06\-24 17:23:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
203870f147 Merge pull request \fI\%#34274\fP from clinta/2015.8
.IP \(bu 2
6572454918 Don\(aqt escape source before calling managed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34258\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-06\-24 14:27:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
a59dc85a15 Merge pull request \fI\%#34258\fP from rallytime/merge\-2015.8
.IP \(bu 2
ea914b67cd Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
8d5ed91980 Merge pull request \fI\%#34225\fP from richardscollin/fix\-win\-set\-datetime
.INDENT 2.0
.IP \(bu 2
6286771ef7 Fix win_system.set_system_date_time
.UNINDENT
.IP \(bu 2
cb1e8bf082 Merge pull request \fI\%#34232\fP from thegoodduke/for_2015.5_ipset
.INDENT 2.0
.IP \(bu 2
344eb60762 ipset: fix commont containing blank
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33873\fP: (\fI\%hrumph\fP) refresh: True not working with pkg.installed state (refs: \fI\%#34093\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34093\fP: (\fI\%terminalmage\fP) Catch CommandExecutionError in pkg states
@ \fI2016\-06\-23 21:00:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
92962957c8 Merge pull request \fI\%#34093\fP from terminalmage/issue33873
.IP \(bu 2
5edb45d746 win_pkg: refresh pkg database if refresh=True passed to version() or list_pkgs()
.IP \(bu 2
0078adee35 Catch CommandExecutionError in pkg states
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34136\fP: (\fI\%meaksh\fP) Fixed behavior for SUSE OS grains in 2015.8
@ \fI2016\-06\-23 20:24:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34134\fP: (\fI\%meaksh\fP) Fixed behavior for SUSE OS grains in 2016.3 (refs: \fI\%#34136\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33903\fP: (\fI\%meaksh\fP) Fetching grains[\(aqos\(aq] from /etc/os\-release on SUSE systems if it is possible (refs: \fI\%#34134\fP)
.IP \(bu 2
cb5399787c Merge pull request \fI\%#34136\fP from meaksh/salt\-suse\-os\-detection\-2015.8
.IP \(bu 2
97f1958863 some cleanup and renaming
.IP \(bu 2
72c8e5d78f better way to check for openSUSE Leap
.IP \(bu 2
548971bdc9 Fix for SUSE OS grains in 2015.8
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34074\fP: (\fI\%fooka03\fP) Unable to use S3 file backend with 2016.3.1 on Ubuntu 14.04 or 16.04 (refs: \fI\%#34208\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#32916\fP: (\fI\%giannello\fP) file.managed memory usage with s3 sources (refs: \fI\%#33599\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34208\fP: (\fI\%lomeroe\fP) fix regression from \fI\%#33681\fP which causes pulling a list of s3 objects …
.IP \(bu 2
\fBPR\fP \fI\%#33681\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33599\fP to 2015.8 (refs: \fI\%#34208\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33599\fP: (\fI\%lomeroe\fP) Fix s3 large file download (refs: \fI\%#33681\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34213\fP: (\fI\%terminalmage\fP) gitfs w/pygit2 \- corner case, traceback with short hexadecimal environment names (refs: \fI\%#34218\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34212\fP: (\fI\%terminalmage\fP) gitfs: commit SHAs no longer available as fileserver environments (refs: \fI\%#34218\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34218\fP: (\fI\%terminalmage\fP) Fix a pair of gitfs bugs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34043\fP: (\fI\%rallytime\fP) state execution stacktraces when psutil isn\(aqt installed (refs: \fI\%#34182\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34182\fP: (\fI\%rallytime\fP) Handle child PIDs differently depending on the availability of psutils
@ \fI2016\-06\-22 19:22:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33942\fP: (\fI\%cachedout\fP) ZD 762 (refs: \fI\%#34182\fP)
.IP \(bu 2
6d643cd528 Merge pull request \fI\%#34182\fP from rallytime/fix\-34043
.IP \(bu 2
b7d49c5052 Handle child PIDs differently depending on the availability of psutils
.IP \(bu 2
\fBPR\fP \fI\%#34188\fP: (\fI\%terminalmage\fP) Clarify pkg.list_repo_pkgs docstring for held packages
.IP \(bu 2
\fBPR\fP \fI\%#34206\fP: (\fI\%terminalmage\fP) Change target for dockerng assuming default status to Nitrogen release
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34184\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-06\-21 21:43:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
1c4369d093 Merge pull request \fI\%#34184\fP from rallytime/merge\-2015.8
.IP \(bu 2
8e36e90966 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
5411ebb3b4 Merge pull request \fI\%#34141\fP from jtand/boto_vpc_test_fix
.INDENT 2.0
.IP \(bu 2
b7ac6c735a Moved imports to top, out of _get_moto_version function
.IP \(bu 2
02f9ba99ba Updated version check. Moved check into its own function
.IP \(bu 2
d445026c56 Updated test to work with new moto version. Changed strings to unicode
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33972\fP: (\fI\%morganwillcock\fP) 2016.3.1 breaks diskusage beacon (refs: \fI\%#34176\fP, \fI\%#34103\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34176\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34103\fP to 2015.8
@ \fI2016\-06\-21 20:01:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34103\fP: (\fI\%morganwillcock\fP) Fix diskusage beacon (refs: \fI\%#34176\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33474\fP: (\fI\%cachedout\fP) Fix diskusage beacon (refs: \fI\%#34103\fP)
.IP \(bu 2
c059d6c08c Merge pull request \fI\%#34176\fP from rallytime/bp\-34103
.IP \(bu 2
2e5e7ed03c Fix diskusage beacon
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34114\fP: (\fI\%onorua\fP) can\(aqt read PID from lock file due to exception if gitfs_global_lock is enabled (refs: \fI\%#34179\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34179\fP: (\fI\%terminalmage\fP) Raise the correct exception when gitfs lockfile is empty
@ \fI2016\-06\-21 20:00:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
5cbaaed167 Merge pull request \fI\%#34179\fP from terminalmage/issue34114
.IP \(bu 2
86d1b8e864 Raise the correct exception when gitfs lockfile is empty
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34178\fP: (\fI\%terminalmage\fP) Remove unnecesssary comment
@ \fI2016\-06\-21 19:15:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
67deded119 Merge pull request \fI\%#34178\fP from terminalmage/remove\-comment
.IP \(bu 2
4965be72b1 Remove unnecesssary comment
.IP \(bu 2
\fBPR\fP \fI\%#34165\fP: (\fI\%mcalmer\fP) fix salt \-\-summary to count not responding minions correctly
.IP \(bu 2
\fBPR\fP \fI\%#34175\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34128\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#34128\fP: (\fI\%bebehei\fP) doc: add missing dot (refs: \fI\%#34175\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34174\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34066\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#34066\fP: (\fI\%complexsplit\fP) Typo fix (refs: \fI\%#34174\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34077\fP: (\fI\%rallytime\fP) Add some grains targeting tests
@ \fI2016\-06\-21 16:06:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
3669048654 Merge pull request \fI\%#34077\fP from rallytime/grains\-tests
.IP \(bu 2
2199bb8a78 Add integration tests for grains.append
.IP \(bu 2
37cfe70724 Add some grains targeting tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34142\fP: (\fI\%isbm\fP) Move log message from INFO to DEBUG.
@ \fI2016\-06\-20 18:57:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
65fba5b4d7 Merge pull request \fI\%#34142\fP from isbm/isbm\-getid\-loglevel\-shift
.IP \(bu 2
236a67b702 Move log message from INFO to DEBUG.
.IP \(bu 2
\fBPR\fP \fI\%#34100\fP: (\fI\%terminalmage\fP) Update documentation on \(dqrefresh\(dq behavior in pkg states
.IP \(bu 2
\fBPR\fP \fI\%#34072\fP: (\fI\%jfindlay\fP) modules.pkg int tests: skip refresh_db upon error
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34069\fP: (\fI\%rallytime\fP) Add a test to check for disconnected minion messaging
@ \fI2016\-06\-16 21:18:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
1b76de1557 Merge pull request \fI\%#34069\fP from rallytime/test\-minion\-return\-message
.IP \(bu 2
60561ac6fc Add a test to check for disconnected minion messaging
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30100\fP: (\fI\%armooo\fP) Masterless gitfs performance (refs: \fI\%#34048\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34048\fP: (\fI\%terminalmage\fP) RFC: proposed fix for multiple fileserver updates in masterless runs
@ \fI2016\-06\-16 21:10:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
3119693dac Merge pull request \fI\%#34048\fP from terminalmage/issue30100
.IP \(bu 2
715e7af8a4 Ensure only one fileserver update in a masterless run
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34011\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33948\fP and \fI\%#34009\fP to 2015.8
@ \fI2016\-06\-16 15:41:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34009\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33948\fP to 2016.3 + add log message (refs: \fI\%#34011\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33948\fP: (\fI\%cachedout\fP) Save an entire minion cache traversal on each master pub (refs: \fI\%#34011\fP, \fI\%#34009\fP)
.IP \(bu 2
dd03024931 Merge pull request \fI\%#34011\fP from rallytime/bp\-33948\-2015.8
.IP \(bu 2
a4660d1ff7 Warn when custom returners don\(aqt have minions kwarg in save_load
.IP \(bu 2
78befde62f Add note to release notes about returner minions kwarg change
.IP \(bu 2
4e7f35fa36 Fix loop over cache in auth checking!
.IP \(bu 2
06963e0505 Save an entire minion cache traversal on each master pub
.IP \(bu 2
\fBPR\fP \fI\%#34051\fP: (\fI\%tegbert\fP) Fixed a bug in the consul.py module that was preventing services
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34045\fP: (\fI\%jacobhammons\fP) Updated latest release version
@ \fI2016\-06\-15 19:22:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
8ba117c7f6 Merge pull request \fI\%#34045\fP from jacobhammons/release\-prev
.IP \(bu 2
43b4a12aa2 Updated latest release version
.IP \(bu 2
\fBPR\fP \fI\%#34020\fP: (\fI\%twangboy\fP) Always make changes to minion config if set (2015.8)
.IP \(bu 2
\fBPR\fP \fI\%#34030\fP: (\fI\%vutny\fP) More YAML indentation fixes in state module examples
.IP \(bu 2
\fBPR\fP \fI\%#34003\fP: (\fI\%vutny\fP) states.file: fix indentation in YAML examples (refs: \fI\%#34030\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34018\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-06\-14 22:53:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b5eae4ca9 Merge pull request \fI\%#34018\fP from rallytime/merge\-2015.8
.IP \(bu 2
77f44f3087 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
871f7966ce Lint fix for \fI\%#34000\fP (\fI\%#34005\fP)
.IP \(bu 2
f758e42172 Fix incorrectly written test (\fI\%#34000\fP)
.IP \(bu 2
cf6281b4cf Add loader.utils() example to calling minion_mods (\fI\%#33953\fP)
.IP \(bu 2
6b98e8a9ea Merge pull request \fI\%#33880\fP from terminalmage/zh744
.INDENT 2.0
.IP \(bu 2
ea726d11c8 pkg.uptodate: Pass kwargs to pkg.list_upgrades
.IP \(bu 2
de90b35d2b salt/modules/zypper.py: add fromrepo support to list_upgrades
.IP \(bu 2
35fbb06df5 salt/modules/win_pkg.py: add kwargs to list_upgrades
.IP \(bu 2
bf5505f425 salt/modules/solarisips.py: add kwargs to list_upgrades
.IP \(bu 2
6e89a8be98 salt/modules/pkgutil.py: add kwargs to list_upgrades
.IP \(bu 2
5179dbcec4 salt/modules/pacman.py: add kwargs to list_upgrades
.IP \(bu 2
46e5a52784 salt/modules/macports.py: add kwargs to list_upgrades
.IP \(bu 2
76143b76ca salt/modules/ebuild.py: add kwargs to list_upgrades
.IP \(bu 2
b40fc9bc62 salt/modules/brew.py: add kwargs to list_upgrades
.IP \(bu 2
4f11c16d86 salt/modules/aptpkg.py: add fromrepo support to list_upgrades
.UNINDENT
.IP \(bu 2
cb88960ed1 Merge pull request \fI\%#33904\fP from rallytime/bp\-33806
.INDENT 2.0
.IP \(bu 2
638ccf501d Work around upstream cherrypy bug
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34003\fP: (\fI\%vutny\fP) states.file: fix indentation in YAML examples (refs: \fI\%#34030\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#20809\fP: (\fI\%lorengordon\fP) Function pam.read_file is not available? (refs: \fI\%#34002\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34002\fP: (\fI\%lorengordon\fP) Remove loader test for pam module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33990\fP: (\fI\%jacobhammons\fP) Adds links to several current Salt\-related projects
@ \fI2016\-06\-14 01:15:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
c4dab6a074 Merge pull request \fI\%#33990\fP from jacobhammons/community\-projects
.IP \(bu 2
b20213fd79 Adds links to several current Salt\-related projects Removes the salt_projects.rst file which hasn\(aqt been updated in a long time, this is replaced by the updated topics/projects/index.rst file Adds a note about Salt Pack to the installation doc
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33983\fP: (\fI\%twangboy\fP) Clarify the \fIaccount_exists\fP parameter
@ \fI2016\-06\-14 01:11:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
444c15792c Merge pull request \fI\%#33983\fP from twangboy/fix_docs_join_domain
.IP \(bu 2
b057be04b4 Fix typo, more documentation
.IP \(bu 2
d8c2f3e57a Clarify the \fIaccount_exists\fP parameter
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33951\fP: (\fI\%jfindlay\fP) modules.gem int tests: more fixes
@ \fI2016\-06\-14 00:46:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
9bd2317992 Merge pull request \fI\%#33951\fP from jfindlay/gem_tests
.IP \(bu 2
2eb633ccad modules.gem int tests: only check known installed gems
.IP \(bu 2
9f3e18b037 modules.gem int tests: (un)install a non\-core gem
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33984\fP: (\fI\%jfindlay\fP) Add docs and tests to disk state
@ \fI2016\-06\-14 00:43:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
53baae6eb1 Merge pull request \fI\%#33984\fP from jfindlay/disk_capacity
.IP \(bu 2
6cbe31e6c2 states.disk: rewrite unit tests
.IP \(bu 2
82c77b533f states.disk.status: validate percent values
.IP \(bu 2
aedc4e15e5 states.disk: add documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33985\fP: (\fI\%rallytime\fP) Write some more simple batch command tests
@ \fI2016\-06\-14 00:38:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
fa5efb6a69 Merge pull request \fI\%#33985\fP from rallytime/more\-batch\-tests
.IP \(bu 2
3e7ab8c7b3 Write some more simple batch command tests
.IP \(bu 2
\fBPR\fP \fI\%#33684\fP: (\fI\%jfindlay\fP) add acl unit tests
.IP \(bu 2
\fBPR\fP \fI\%#33942\fP: (\fI\%cachedout\fP) ZD 762 (refs: \fI\%#34182\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33946\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33698\fP to 2015.8
@ \fI2016\-06\-13 15:55:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33698\fP: (\fI\%opdude\fP) Vsphere fixes (refs: \fI\%#33946\fP)
.IP \(bu 2
0281d491c6 Merge pull request \fI\%#33946\fP from rallytime/bp\-33698
.IP \(bu 2
5fdfed1cb9 Make sure we only use GetConnection if we are using a proxy salt minion
.IP \(bu 2
1505c5724b Fix a bug with self signed certificates and creating a new VM
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33911\fP: (\fI\%xlotlu\fP) salt\-ssh + grains.filter_by Type error: filter_by() got an unexpected keyword argument \(aqbase\(aq (refs: \fI\%#33952\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33952\fP: (\fI\%rallytime\fP) Add base argument to salt\-ssh grains wrapper for filter_by func
@ \fI2016\-06\-13 15:51:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
dff3f51955 Merge pull request \fI\%#33952\fP from rallytime/fix\-33911
.IP \(bu 2
03b7cbbd2c Add base argument to salt\-ssh grains wrapper for filter_by func
.IP \(bu 2
\fBPR\fP \fI\%#33962\fP: (\fI\%jacobhammons\fP) Adds a \(dqGenerated on <timestamp>\(dq line to the html footer
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29525\fP: (\fI\%apergos\fP) master config setting ping_on_rotate is broken if minion_data_cache is disabled (refs: \fI\%#33765\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33765\fP: (\fI\%cachedout\fP) Correct issue with ping on rotate with minion cache
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33888\fP: (\fI\%jfindlay\fP) random.org checks
@ \fI2016\-06\-10 15:45:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
378dd7ca06 Merge pull request \fI\%#33888\fP from jfindlay/random_check
.IP \(bu 2
6acee3cc30 modules.random_org._query: only return text if present
.IP \(bu 2
82f95429db modules.random_org unit tests: skip if random.org down
.IP \(bu 2
1f9422e0cd utils.http.query: also except gaierror with tornado
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31499\fP: (\fI\%Reiner030\fP) FeatureRequest: boto_elb misses connection_settings \- idle_timeout (refs: \fI\%#33936\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33936\fP: (\fI\%rallytime\fP) Add connecting_settings to boto_elb state attributes list
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29249\fP: (\fI\%timcharper\fP) \fIsalt\-cloud\fP \fIsync_after_install: all\fP does not seem to sync anything at all (refs: \fI\%#33917\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33917\fP: (\fI\%techhat\fP) Wait for up to a minute for sync_after_install
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33877\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-06\-09 14:50:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
ef6da0be5d Merge pull request \fI\%#33877\fP from rallytime/merge\-2015.8
.IP \(bu 2
398534a9e7 Fix ret return from merge\-conflict resolution
.IP \(bu 2
b8e4706074 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
cdda593c50 Merge pull request \fI\%#33829\fP from terminalmage/update\-versionchanged
.INDENT 2.0
.IP \(bu 2
f7028eb1c6 Update versionchanged directive
.UNINDENT
.IP \(bu 2
b8e6c144d8 Merge pull request \fI\%#33833\fP from terminalmage/issue33645
.INDENT 2.0
.IP \(bu 2
91745c2a67 Support syncing pillar modules to masterless minions
.UNINDENT
.IP \(bu 2
e061788e81 Merge pull request \fI\%#33814\fP from terminalmage/archive\-extracted\-xz
.INDENT 2.0
.IP \(bu 2
897a716df2 Support extraction of XZ archives in archive.extracted state
.UNINDENT
.IP \(bu 2
fa983e91cf Merge pull request \fI\%#33778\fP from sodium\-chloride/2015.5\-2016\-0604\-1938
.INDENT 2.0
.IP \(bu 2
a5fb6d7a69 Fix minor docstring issues
.UNINDENT
.IP \(bu 2
b9133326c8 Merge pull request \fI\%#33726\fP from jtand/sysmod_skip_valid_docs_glance
.INDENT 2.0
.IP \(bu 2
ebee8a89af glance.warn_until shouldn\(aqt be checked for a doc string
.UNINDENT
.IP \(bu 2
137f0b19f3 Merge pull request \fI\%#33611\fP from TargetHolding/2015.5
.INDENT 2.0
.IP \(bu 2
1dd15a603b solve\(aq TypeError: expected string or buffer\(aq in json/decoder.py
.IP \(bu 2
eaf42ca892 solve AttributeError: \(aqmodule\(aq object has no attribute \(aqexception\(aq
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33810\fP: (\fI\%chiro79\fP) locate.locate fails always (refs: \fI\%#33827\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33827\fP: (\fI\%cachedout\fP) Fix broken locate.locate function
@ \fI2016\-06\-08 13:49:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec09095c45 Merge pull request \fI\%#33827\fP from cachedout/issue_33810
.IP \(bu 2
9d36f1e474 Fix broken locate.locate function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33839\fP: (\fI\%cachedout\fP) Fix another unit test stacktrace in pkg_resource
@ \fI2016\-06\-08 13:32:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
f7b3d0eda0 Merge pull request \fI\%#33839\fP from cachedout/fix_pkgresource_test_stacktrace
.IP \(bu 2
435547a747 Fix another unit test stacktrace in pkg_resource
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33840\fP: (\fI\%cachedout\fP) Remove matcher tests
@ \fI2016\-06\-08 13:31:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
5f081ef31c Merge pull request \fI\%#33840\fP from cachedout/remove_matcher_unit_tests
.IP \(bu 2
6297448377 Remove matcher tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33836\fP: (\fI\%cachedout\fP) Fixing more stupid unit tests
@ \fI2016\-06\-07 21:34:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
cda032dab2 Merge pull request \fI\%#33836\fP from cachedout/fix_winserver_manager_test
.IP \(bu 2
453fb1ac91 Fixing more stupid unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33805\fP: (\fI\%jfindlay\fP) states.pkg int tests: skip if pkg mgr unavailable
@ \fI2016\-06\-07 14:40:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
1db559afe9 Merge pull request \fI\%#33805\fP from jfindlay/pkg_tests
.IP \(bu 2
0c069ddc95 states.pkg int tests: skip if pkg mgr unavailable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33808\fP: (\fI\%jfindlay\fP) fix some problems with the gem module integration tests
@ \fI2016\-06\-07 14:40:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
3984b65486 Merge pull request \fI\%#33808\fP from jfindlay/gem_tests
.IP \(bu 2
f7c19a1a58 modules.gem int tests: relax version checks
.IP \(bu 2
6af47d2ba7 modules.gem int tests: remove pkgs before testing install
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33770\fP: (\fI\%jfindlay\fP) service state integration tests
@ \fI2016\-06\-07 14:37:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
c30d8a8c61 Merge pull request \fI\%#33770\fP from jfindlay/service_tests
.IP \(bu 2
f13f914755 states.service: add integration tests
.IP \(bu 2
90aee79c39 states.service.mod_watch: update unit test
.IP \(bu 2
d210a92f09 states.service.mod_watch: update sfun and force docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33691\fP: (\fI\%justinta\fP) Gem integration test
@ \fI2016\-06\-06 11:13:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
7fdfbe9a28 Merge pull request \fI\%#33691\fP from jtand/gem_integration_test
.IP \(bu 2
ff2dae103d ubuntu doesn\(aqt install default gems when ruby is installed
.IP \(bu 2
504df9a65a Fixed lint error
.IP \(bu 2
0cb1bfa0d3 Removed extra :
.IP \(bu 2
86f59b3e80 Made more pythonic
.IP \(bu 2
2f36f34981 Fixed salt.util import. Added status check to make sure external resource is available
.IP \(bu 2
400a71ec33 Removed redundancies
.IP \(bu 2
91db411bea A couple lint fixes
.IP \(bu 2
c97f3319b9 Add check for gem binary
.IP \(bu 2
210aceb402 Refactored tests to not use return messages
.IP \(bu 2
9d437bd45d Removed artifact from testing
.IP \(bu 2
134e1fa888 Fixed typos, and added destructiveTest decorator
.IP \(bu 2
37bc3ad8fd Fixed typo, uninstalled to uninstall
.IP \(bu 2
5b23b91ac6 Integration test for gem module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33777\fP: (\fI\%sacren\fP) Fix minor docstring issue of arg being missing
@ \fI2016\-06\-06 10:44:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb4194bb79 Merge pull request \fI\%#33777\fP from sodium\-chloride/2015.8\-2016\-0604\-1939
.IP \(bu 2
c1fd830a1a Fix minor docstring issue of arg being missing
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31219\fP: (\fI\%gladiatr72\fP) when the minions have all been destroyed... (refs: \fI\%#33759\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33759\fP: (\fI\%cachedout\fP) Catch no minions exception in batch mode
@ \fI2016\-06\-03 21:22:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
c749aea409 Merge pull request \fI\%#33759\fP from cachedout/issue_31219
.IP \(bu 2
15a39f8646 Catch no minions exception in batch mode
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33554\fP: (\fI\%jfindlay\fP) local cache missing directories while running test suite (refs: \fI\%#33653\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33719\fP: (\fI\%cachedout\fP) Catch oserror for race condition
@ \fI2016\-06\-03 17:25:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33653\fP: (\fI\%cachedout\fP) Create missing jid dir if it doesn\(aqt exist (refs: \fI\%#33719\fP)
.IP \(bu 2
47d668e071 Merge pull request \fI\%#33719\fP from cachedout/fixup_33653
.IP \(bu 2
635efa248b Change to just surround the mkdir
.IP \(bu 2
21b7123a60 Catch oserror for race condition
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33712\fP: (\fI\%meaksh\fP) Fix for groupadd execution module failures in SLES11 systems
@ \fI2016\-06\-03 16:13:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
11e39e7203 Merge pull request \fI\%#33712\fP from meaksh/fix\-for\-groupadd\-module\-failures\-in\-SLE11\-2015.8
.IP \(bu 2
ab738416ba pylint fix
.IP \(bu 2
bf27e5d36e test_members cleanup
.IP \(bu 2
ba815dbf76 improvements on groupadd unit tests
.IP \(bu 2
3bbc5ae0d9 one line is better
.IP \(bu 2
a53dc192c9 fix groupadd module for sles11 systems
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33718\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33700\fP to 2015.8
@ \fI2016\-06\-03 16:10:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33700\fP: (\fI\%sacren\fP) Fix incorrect args passed to timezone.set_hwclock (refs: \fI\%#33718\fP)
.IP \(bu 2
2c450a7494 Merge pull request \fI\%#33718\fP from rallytime/bp\-33700
.IP \(bu 2
a6a446121a Fix speed issue
.IP \(bu 2
a41146730a Fix incorrect args passed to timezone.set_hwclock
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33725\fP: (\fI\%terminalmage\fP) git_pillar w/pygit2 fails to checkout a non\-master branch when remote repo has no master branch (refs: \fI\%#33727\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33727\fP: (\fI\%terminalmage\fP) Fix git_pillar edge case for remote repos without a master branch
@ \fI2016\-06\-03 16:03:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
b07701f0a0 Merge pull request \fI\%#33727\fP from terminalmage/issue33725
.IP \(bu 2
d8ba7ed5a5 Fix git_pillar edge case for remote repos without a master branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33728\fP: (\fI\%jfindlay\fP) Make \fIconfigurable_test_state\fP configurable in test mode
@ \fI2016\-06\-03 16:02:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
015e50cec8 Merge pull request \fI\%#33728\fP from jfindlay/test_state_test
.IP \(bu 2
87e018af2a states.test.configurable_test_state: add unit tests
.IP \(bu 2
c2d0679c4b states.test.configurable_test_state: refactor change_data
.IP \(bu 2
f06ff1af1f states.test.configurable_test_state test mode
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33729\fP: (\fI\%twangboy\fP) Add exclude option to win_servermanager
@ \fI2016\-06\-03 15:53:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
1cf8fe3f1d Merge pull request \fI\%#33729\fP from twangboy/fix_win_servermanager
.IP \(bu 2
2de91d166f Fix docstring
.IP \(bu 2
9870479d99 Add exclude option to state
.IP \(bu 2
50bd76e206 Add exclude option
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31816\fP: (\fI\%vutny\fP) Deprecate or update the \fI\%http://debian.saltstack.com/\fP (refs: \fI\%#33743\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33743\fP: (\fI\%vutny\fP) Debian installation docs: drop section about community\-maintained repo
@ \fI2016\-06\-03 15:29:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c150d840d Merge pull request \fI\%#33743\fP from vutny/drop\-debian\-community\-repo\-doc
.IP \(bu 2
8621f5be54 Debian installation docs: drop section about community\-maintained repository
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33554\fP: (\fI\%jfindlay\fP) local cache missing directories while running test suite (refs: \fI\%#33653\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33653\fP: (\fI\%cachedout\fP) Create missing jid dir if it doesn\(aqt exist (refs: \fI\%#33719\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33654\fP: (\fI\%twangboy\fP) Fix win servermanager
@ \fI2016\-06\-02 17:55:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
8a566ff4b9 Merge pull request \fI\%#33654\fP from twangboy/fix_win_servermanager
.IP \(bu 2
6c7b21676a Fix lint and tests
.IP \(bu 2
4775e6bdf0 Add additional params to state
.IP \(bu 2
b0af32346d Add additional params to install and remove
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33424\fP: (\fI\%thusoy\fP) Error logging with non\-environment branches in gitfs (refs: \fI\%#33679\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33679\fP: (\fI\%terminalmage\fP) Only compile the template contents if they evaluate to True
@ \fI2016\-06\-02 17:20:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
996ff56dd4 Merge pull request \fI\%#33679\fP from terminalmage/issue33424
.IP \(bu 2
9da40c4437 Append empty dictionaries for saltenvs with no top file
.IP \(bu 2
5eb1b3ca62 Only compile the template contents if they evaluate to True
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33685\fP: (\fI\%jfindlay\fP) modules.cp.get_url: add test for \fI\%https://\fP
@ \fI2016\-06\-01 22:25:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
c8dc70b96a Merge pull request \fI\%#33685\fP from jfindlay/get_url_test
.IP \(bu 2
2b5035fdc0 modules.cp.get_url: add test for \fI\%https://\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33581\fP: (\fI\%dincamihai\fP) Call zypper refresh after adding/modifying a repository
@ \fI2016\-06\-01 22:25:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
5e022ff29c Merge pull request \fI\%#33581\fP from dincamihai/2015.8
.IP \(bu 2
788730ea72 DRY test
.IP \(bu 2
1d3769ccfa Improve zypper_patcher_config looks
.IP \(bu 2
42d8d4195c Assert only gpgautoimport: True works
.IP \(bu 2
ced75e8e62 Reverse if conditions and rename variable
.IP \(bu 2
80bfbe5c52 Reduce dicts and lists to one line where possible
.IP \(bu 2
1d5d6d7d60 Update test method names to pass pylint
.IP \(bu 2
c7ae5907ee Call zypper refresh after adding/modifying a repository
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32916\fP: (\fI\%giannello\fP) file.managed memory usage with s3 sources (refs: \fI\%#33599\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33681\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33599\fP to 2015.8 (refs: \fI\%#34208\fP)
@ \fI2016\-06\-01 21:14:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33599\fP: (\fI\%lomeroe\fP) Fix s3 large file download (refs: \fI\%#33681\fP)
.IP \(bu 2
069ee15b7c Merge pull request \fI\%#33681\fP from rallytime/bp\-33599
.IP \(bu 2
45143a599b use requests streaming for uploads/downloads to file (return_bin unchanged) allows downloading files larger than amount of memory (non\-stream reads into memory before writing to disk or uploading)
.IP \(bu 2
4a9b23f03f first go at having requests use streaming for get/put requests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33393\fP: (\fI\%babilen\fP) pip.installed does not work with ancient pip versions (refs: \fI\%#33396\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33396\fP: (\fI\%babilen\fP) Issue 33393
@ \fI2016\-06\-01 21:12:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
13537c4891 Merge pull request \fI\%#33396\fP from babilen/issue\-33393
.IP \(bu 2
57e0475cd4 Make pip InstallationError import more robust
.IP \(bu 2
291a3e21fa Remove duplicated code.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33652\fP: (\fI\%terminalmage\fP) Lower the log level for failed auths
@ \fI2016\-06\-01 16:37:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
7bce4ece1a Merge pull request \fI\%#33652\fP from terminalmage/zh723
.IP \(bu 2
411841603a Lower the log level for failed auths
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33582\fP: (\fI\%waxie\fP) mysql module gives traceback if no working authentication (refs: \fI\%#33615\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33615\fP: (\fI\%danslimmon\fP) Fix crash on unconnectable MySQL server (resolves \fI\%#33582\fP)
@ \fI2016\-05\-31 16:03:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
504989388a Merge pull request \fI\%#33615\fP from danslimmon/mysql\-traceback\-33582
.IP \(bu 2
180099ae9f Wrote test for broken server connection
.IP \(bu 2
c6c3ff02e3 Added some error checking to resolve \fI\%#33582\fP\&.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33558\fP: (\fI\%twangboy\fP) Fix win servermanager
@ \fI2016\-05\-27 22:05:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
b47182e47c Merge pull request \fI\%#33558\fP from twangboy/fix_win_servermanager
.IP \(bu 2
62a6bde0ea Fix comment when already installed
.IP \(bu 2
79bc7195dc Fix unit tests
.IP \(bu 2
56a6f6bb83 Fix changes
.IP \(bu 2
8ebe99ec5e Fix restart_needed
.IP \(bu 2
6e478cbda0 Add restart needed
.IP \(bu 2
72ebf26616 Add missing import
.IP \(bu 2
193583be96 Use dictionary compare for changes in remove
.IP \(bu 2
1ae7dd76c1 Use dictionary compare for changes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33544\fP: (\fI\%tjuup\fP) Salt 2016.3.0 (Boron) clean_old_jobs fails  (refs: \fI\%#33555\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33555\fP: (\fI\%cachedout\fP) Fix crashing Maintenence process
@ \fI2016\-05\-26 19:25:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
58d89d66e3 Merge pull request \fI\%#33555\fP from cachedout/issue_33544
.IP \(bu 2
fe7ee7a470 Fix crashing Maintenence process
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33501\fP: (\fI\%meaksh\fP) unit tests for rpm.checksum() and zypper.download()
@ \fI2016\-05\-26 14:34:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
d052908729 Merge pull request \fI\%#33501\fP from meaksh/zypper\-download\-check\-signature\-2015.8
.IP \(bu 2
eaaef25c79 lint issue fixed
.IP \(bu 2
6b6febb211 unit tests for rpm.checksum() and zypper.download()
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33319\fP: (\fI\%ghost\fP) Salt interprets jinja syntax in contents pillar (refs: \fI\%#33513\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33513\fP: (\fI\%rallytime\fP) Add a section to the jinja docs about escaping jinja
@ \fI2016\-05\-26 14:24:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
e2d0c4abb1 Merge pull request \fI\%#33513\fP from rallytime/fix\-33319
.IP \(bu 2
81c1471209 Add a section to the jinja docs about escaping jinja
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33520\fP: (\fI\%jacobhammons\fP) Updated version numbers in the docs for the 2016.3.0 release
@ \fI2016\-05\-26 14:15:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
fabc15e616 Merge pull request \fI\%#33520\fP from jacobhammons/release\-notes.8
.IP \(bu 2
42e358af7d Updated version numbers in the docs for the 2016.3.0 release
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33507\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-05\-25 19:14:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
5a6b037cbd Merge pull request \fI\%#33507\fP from rallytime/merge\-2015.8
.IP \(bu 2
03b0c97520 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
6f7fda0354 Merge pull request \fI\%#33486\fP from jtand/2015.5
.INDENT 2.0
.IP \(bu 2
d1e210fff8 Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into 2015.5
.IP \(bu 2
ee2ae0ea8a Added docstring examples to glance.image_schema and schema_get
.IP \(bu 2
59e90064e6 modules.swift.head does not have a body. Should not be checked for a docstring right now.
.UNINDENT
.IP \(bu 2
f72ec1479b Merge pull request \fI\%#33482\fP from rallytime/pillar\-opts\-docs
.INDENT 2.0
.IP \(bu 2
087564528d Add pillar_opts docs to master.rst
.UNINDENT
.IP \(bu 2
dc644b145d Merge pull request \fI\%#33488\fP from rallytime/fix\-18752
.INDENT 2.0
.IP \(bu 2
b0a9f4181f Add docs for the syndic_finger config
.UNINDENT
.IP \(bu 2
a4e84aa7d2 Merge pull request \fI\%#33454\fP from scubahub/2015.5
.INDENT 2.0
.IP \(bu 2
df3c0b8e78 Correct (and make consistent) determination of the test flag.
.UNINDENT
.IP \(bu 2
3a52ace673 manage account information for pam (\fI\%#33473\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#15252\fP: (\fI\%gravyboat\fP) Standalone minion docs don\(aqt explain what file is being modified. (refs: \fI\%#33503\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33503\fP: (\fI\%rallytime\fP) Add docs about minion config file in standalone minion docs
@ \fI2016\-05\-25 17:23:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
ee76be3b0b Merge pull request \fI\%#33503\fP from rallytime/fix\-15252
.IP \(bu 2
cfc07f7641 Add docs about minion config file in standalone minion docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33474\fP: (\fI\%cachedout\fP) Fix diskusage beacon (refs: \fI\%#34103\fP)
@ \fI2016\-05\-25 17:10:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
e9b648e461 Merge pull request \fI\%#33474\fP from cachedout/issue_29451
.IP \(bu 2
aa2bac3a0d Remove debugging
.IP \(bu 2
68d8050cb8 Fix diskusage beacon
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33465\fP: (\fI\%meaksh\fP) jobs.exit_success allow checking if a job has executed and exit successfully
@ \fI2016\-05\-25 16:52:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
3bfb6bf719 Merge pull request \fI\%#33465\fP from meaksh/check\-if\-job\-returns\-successfully\-2015.8
.IP \(bu 2
9deb70fd8e jobs.exit_success() now works parsing the results of jobs.lookup_id()
.IP \(bu 2
7ba40c4f31 jobs.exit_success allow checking if a job has executed and exit successfully
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-jenkins#175\fP: (\fI\%justinta\fP) Adding back shade to setup states (refs: \fI\%#33487\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33487\fP: (\fI\%justinta\fP) Add docstring examples to glance.py and nova.py [2015.8]
@ \fI2016\-05\-25 16:47:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
70eb7b66f3 Merge pull request \fI\%#33487\fP from jtand/glance_doc_fixes
.IP \(bu 2
0b1cae05d9 Added docstring examples to glance methods and nova.list
.IP \(bu 2
ebf1256545 Don\(aqt need to check swift.head due to it having no body
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33423\fP: (\fI\%warden\fP) etcd profile doesn\(aqt work when used in master conf file (refs: \fI\%#33481\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33481\fP: (\fI\%rallytime\fP) Fix docs about etcd config options and add pillar_opts doc (refs: \fI\%#33482\fP)
@ \fI2016\-05\-25 16:41:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
56ea979916 Merge pull request \fI\%#33481\fP from rallytime/fix\-33423
.IP \(bu 2
7fd3e8f361 Fix docs about etcd config options and add pillar_opts doc
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#16319\fP: (\fI\%lsh\-0\fP) create a postgresql \fIquery\fP function (refs: \fI\%#33490\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33490\fP: (\fI\%rallytime\fP) Document the postgres.psql_query function
@ \fI2016\-05\-25 16:41:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
2394cdc4bf Merge pull request \fI\%#33490\fP from rallytime/fix\-16319
.IP \(bu 2
0c5548f9d1 Document the postgres.psql_query function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33480\fP: (\fI\%jfindlay\fP) states.service: minor doc updates
@ \fI2016\-05\-25 16:38:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
ede232f0f1 Merge pull request \fI\%#33480\fP from jfindlay/service_doc
.IP \(bu 2
29c00a1b1b states.service: clarify function description language
.IP \(bu 2
6a9ae09e79 states.service.__virtual__: add load fail reason
.IP \(bu 2
\fBPR\fP \fI\%#33483\fP: (\fI\%twangboy\fP) Return full pending computer name (2015.8)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32444\fP: (\fI\%justindesilets\fP) Feature Request \- jobs runner list by target (refs: \fI\%#33491\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33499\fP: (\fI\%cachedout\fP) Use six.string_types in jobs runner
.IP \(bu 2
\fBPR\fP \fI\%#33491\fP: (\fI\%BlaineAtAffirm\fP) fix jobs.list_jobs failing with search_target (refs: \fI\%#33499\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32444\fP: (\fI\%justindesilets\fP) Feature Request \- jobs runner list by target (refs: \fI\%#33491\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33491\fP: (\fI\%BlaineAtAffirm\fP) fix jobs.list_jobs failing with search_target (refs: \fI\%#33499\fP)
@ \fI2016\-05\-25 15:11:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e24a04565 Merge pull request \fI\%#33491\fP from BlaineAtAffirm/2015.8
.IP \(bu 2
7599b18995 fix jobs.list_jobs failing with search_target
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33467\fP: (\fI\%beelit94\fP) Orchestration gives exception when a target does not exist (refs: \fI\%#33478\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#32479\fP: (\fI\%ssgward\fP) Orchestration gives exception when a target does not exist (refs: \fI\%#32484\fP, \fI\%#33478\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33478\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32484\fP to 2015.8
@ \fI2016\-05\-24 19:14:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32484\fP: (\fI\%cachedout\fP) Only unsub if we have a jid (refs: \fI\%#33478\fP)
.IP \(bu 2
1861af427e Merge pull request \fI\%#33478\fP from rallytime/bp\-32484
.IP \(bu 2
042f17efa4 Only unsub if we have a jid
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33457\fP: (\fI\%rallytime\fP) Make doc formatting consistent and use correct versionadded
@ \fI2016\-05\-24 17:52:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
b8154b678e Merge pull request \fI\%#33457\fP from rallytime/doc\-formatting
.IP \(bu 2
82f8f3efff Make doc formatting consistent and use correct versionadded
.IP \(bu 2
\fBPR\fP \fI\%#33477\fP: (\fI\%terminalmage\fP) Don\(aqt allow a \(dqrepo\(dq kwarg for pkgrepo.managed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29451\fP: (\fI\%githubcdr\fP) 2015.8.3 pillar beacons bugged? (refs: \fI\%#33476\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33476\fP: (\fI\%cachedout\fP) Allow for config entry to be a list in a dict for beacons
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33469\fP: (\fI\%meaksh\fP) check the RPM signature of zypper pkg.download packages and report errors
@ \fI2016\-05\-24 16:09:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
9f56ab4c45 Merge pull request \fI\%#33469\fP from meaksh/zypper\-download\-check\-signature\-2015.8
.IP \(bu 2
a65071a6d1 simpler rpm.checksum function
.IP \(bu 2
80fe303e38 Renamed check_sig to checksum and some refactoring
.IP \(bu 2
d56e3f4258 bugfix: showing errors when a package download fails using zypper pkg.download
.IP \(bu 2
8a21b9149e check the signature of downloaded RPM files
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33389\fP: (\fI\%DaveQB\fP) Too many hostnames in pillar? (refs: \fI\%#33459\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33459\fP: (\fI\%rallytime\fP) Add docs about PyYAML\(aqs 1024 character limitations for simple keys
.IP \(bu 2
\fBPR\fP \fI\%#33464\fP: (\fI\%isbm\fP) Prevent several minion processes on the same machine
.IP \(bu 2
\fBPR\fP \fI\%#33432\fP: (\fI\%dincamihai\fP) Make \-\-gpg\-auto\-import\-keys a global param when calling zypper
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32446\fP: (\fI\%sel\-fish\fP) \(dq salt \(aq*\(aq saltutil.wheel minions.connected \(dq not work (refs: \fI\%#33414\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33414\fP: (\fI\%rallytime\fP) Fix the saltutil.wheel function and add integration tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29286\fP: (\fI\%harlanbarnes\fP) Can\(aqt disable Job Cache? (refs: \fI\%#33328\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33440\fP: (\fI\%rallytime\fP) Make sure the path we\(aqre removing is present first \- avoid an OSError
.IP \(bu 2
\fBPR\fP \fI\%#33328\fP: (\fI\%rallytime\fP) Update job_cache and keep_jobs docs to be more specific to their behavior (refs: \fI\%#33440\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26913\fP: (\fI\%imchairmanm\fP) manage.bootstrap runner quotation escape bug (refs: \fI\%#33443\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33443\fP: (\fI\%rallytime\fP) Avoid a syntax error by using \(dq instead of escaped \(aq
.IP \(bu 2
\fBPR\fP \fI\%#33436\fP: (\fI\%rmarcinik\fP) Fix virtual function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33438\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-05\-23 17:50:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
6e94a4a03b Merge pull request \fI\%#33438\fP from rallytime/merge\-2015.8
.IP \(bu 2
7c41c34528 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.INDENT 2.0
.IP \(bu 2
2cc650965a update 2015.5.11 release notes (\fI\%#33412\fP)
.IP \(bu 2
dc8ce2d8b1 Fix traceback in logging for config validation (\fI\%#33386\fP) (\fI\%#33405\fP)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33395\fP: (\fI\%fmnisme\fP) salt doc error (refs: \fI\%#33421\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33421\fP: (\fI\%abednarik\fP) Documentation update in file.serialize.
.IP \(bu 2
\fBPR\fP \fI\%#33398\fP: (\fI\%lvg01\fP) Fix LVM parameter devices as a pure list. Comma separated lists are c…
.IP \(bu 2
\fBPR\fP \fI\%#33406\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33387\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#33387\fP: (\fI\%tveastman\fP) Spelling correction. (refs: \fI\%#33406\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33298\fP: (\fI\%lorengordon\fP) Windows: pkg.install returns failed for msiexec/instmsi exit code 3010 (ERROR_SUCCESS_REBOOT_REQUIRED) (refs: \fI\%#33321\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33321\fP: (\fI\%lorengordon\fP) Update windows pkg.[install|remove] error logic
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29252\fP: (\fI\%mitar\fP) reload_modules is not documented for the pkg state (refs: \fI\%#33374\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33374\fP: (\fI\%rallytime\fP) Add note about reload_modules functionality for pkg.installed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31430\fP: (\fI\%The\-Loeki\fP) Salt Coding Style regarding absolute_imports (refs: \fI\%#33377\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33377\fP: (\fI\%rallytime\fP) Add note to absolute_imports practice about __future__ import
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21720\fP: (\fI\%kaithar\fP) Revisiting aliases.file option. (refs: \fI\%#33380\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33380\fP: (\fI\%rallytime\fP) Document how to set the alias file location for alias state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33403\fP: (\fI\%jacobhammons\fP) 2015.8.10 release notes
@ \fI2016\-05\-20 16:02:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
3c9def310c Merge pull request \fI\%#33403\fP from jacobhammons/dot10
.IP \(bu 2
e850c298a9 2015.8.10 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33381\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-05\-20 15:58:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
91059224f6 Merge pull request \fI\%#33381\fP from rallytime/merge\-2015.8
.IP \(bu 2
5aec32b20f Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.INDENT 2.0
.IP \(bu 2
d15f5e2cef Merge pull request \fI\%#33383\fP from thatch45/2015.5
.INDENT 2.0
.IP \(bu 2
f5ebcba21c restore whitespace
.IP \(bu 2
1d8b289db1 blast, put the try/except int he right place
.IP \(bu 2
081e6c5b83 maintain the fallabck because I am totally sick of this crap
.UNINDENT
.IP \(bu 2
755acfb97e Improve doc clarity for disable_modules documentation (\fI\%#33379\fP)
.UNINDENT
.IP \(bu 2
8ef7697806 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.INDENT 2.0
.IP \(bu 2
2b5ad128bf Better YAML syntax error handling (\fI\%#33375\fP)
.IP \(bu 2
bb3e98cad2 Merge pull request \fI\%#33372\fP from jacobhammons/release\-update
.INDENT 2.0
.IP \(bu 2
5ce502160b revved 2015.8 branch to .9 in version selector
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33386\fP: (\fI\%terminalmage\fP) Fix traceback in logging for config validation (refs: \fI\%#33405\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27737\fP: (\fI\%mpaolini\fP) name param never mentioned in pillar_ext git documentation (refs: \fI\%#33369\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33369\fP: (\fI\%rallytime\fP) Add note about name parameter in git_pillar docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32913\fP: (\fI\%hrumph\fP) Possible problem with salt.states.pkg.installed documentation (refs: \fI\%#33362\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33362\fP: (\fI\%rallytime\fP) Add win_pkg to list of modules that support \(dqversion\(dq in pkg.installed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27779\fP: (\fI\%jbouse\fP) [Doc] Hipchat returner documentation update (refs: \fI\%#33365\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33365\fP: (\fI\%rallytime\fP) Add note to docs about api settings for Hipchat API v2
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#828\fP: (\fI\%vutny\fP) Fix bootstrapping from git on Debian 8 by installing latest \fItornado\fP via pip (refs: \fI\%#32857\fP)
.IP \(bu 2
\fBPR\fP \fI\%#820\fP: (\fI\%dcolish\fP) Refactor of cli parsers, normalize around conf_file (refs: #\(gasaltstack/salt\-bootstrap#828\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#32857\fP: (\fI\%vutny\fP) Add initscripts, SystemD service units and environment files for Debian
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33370\fP: (\fI\%jacobhammons\fP) Update docs version to 2015.8.9
@ \fI2016\-05\-19 19:59:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
80f52a658e Merge pull request \fI\%#33370\fP from jacobhammons/2015.8.9
.IP \(bu 2
146b4df6be Updates docs version to 2015.8.9 Adds note regarding the os grain on Mint Linux Adds an FAQ regarding grains that change due to upstream changes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33366\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-05\-19 19:41:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e5689abbf Merge pull request \fI\%#33366\fP from rallytime/merge\-2015.8
.IP \(bu 2
52b3128678 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
55be0abf4d Expanded documentation for boto_elb state and module (\fI\%#33341\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33313\fP: (\fI\%morganwillcock\fP) pkg.py: pkgs parameter documented as not supported on Windows (refs: \fI\%#33361\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#3313\fP: (\fI\%mou\fP) If no fileserver backend initialized there should be warning or error message on performing various file operations (refs: \fI\%#33361\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33361\fP: (\fI\%rallytime\fP) Remove mentions of windows not supporting pkgs param
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29286\fP: (\fI\%harlanbarnes\fP) Can\(aqt disable Job Cache? (refs: \fI\%#33328\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33328\fP: (\fI\%rallytime\fP) Update job_cache and keep_jobs docs to be more specific to their behavior (refs: \fI\%#33440\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33295\fP: (\fI\%andrew\-vant\fP) Linux Mint service module not correctly detected. (refs: \fI\%#33359\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33359\fP: (\fI\%terminalmage\fP) Properly detect newer Linux Mint distros
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32260\fP: (\fI\%jagguli\fP) git.latest UnboundLocalError: local variable \(aqdesired_upstream\(aq referenced before assignmen (refs: \fI\%#33340\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33340\fP: (\fI\%terminalmage\fP) Fix UnboundLocalError in git.latest
.IP \(bu 2
\fBPR\fP \fI\%#33339\fP: (\fI\%phistrom\fP) states.boto_elb Describe parameters in register_instances function
.IP \(bu 2
\fBPR\fP \fI\%#33347\fP: (\fI\%rallytime\fP) Fix some link errors in the test writing tutorial
.IP \(bu 2
\fBPR\fP \fI\%#33312\fP: (\fI\%twangboy\fP) Fix network.managed for windows
.IP \(bu 2
\fBPR\fP \fI\%#33327\fP: (\fI\%cro\fP) Bp 28467 calm mine
.IP \(bu 2
\fBPR\fP \fI\%#28467\fP: (\fI\%jodv\fP) Make mine.update more manageable for large environments (refs: \fI\%#33327\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33334\fP: (\fI\%jfindlay\fP) import ps from psutil_compat in beacons
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21520\fP: (\fI\%jfindlay\fP) sudo.salt_call is broken (refs: \fI\%#25089\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33318\fP: (\fI\%jfindlay\fP) remove redundant, incorrect sudo_runas config documentation
.IP \(bu 2
\fBPR\fP \fI\%#25089\fP: (\fI\%jfindlay\fP) fix minion sudo (refs: \fI\%#33318\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22480\fP: (\fI\%thatch45\fP) Add sudo user docs into salt (refs: \fI\%#33318\fP)
.IP \(bu 2
\fBPR\fP \fI\%#20226\fP: (\fI\%thatch45\fP) Allow sudo priv escalation (refs: \fI\%#25089\fP, \fI\%#33318\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33323\fP: (\fI\%terminalmage\fP) Overeager globbing in systemd.py for sysv service detection (refs: \fI\%#33324\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33324\fP: (\fI\%terminalmage\fP) Disambiguate non\-exact matches when checking if sysv service is enabled
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30130\fP: (\fI\%dreampuf\fP) Non\-root minion not work with state.sls module (refs: \fI\%#33325\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33325\fP: (\fI\%cachedout\fP) Allow concurrency mode in state runs if using sudo
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29674\fP: (\fI\%jakehilton\fP) Salt Master Hang (refs: \fI\%#33333\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33333\fP: (\fI\%DmitryKuzmenko\fP) Fix master hanging after a request from minion with removed key.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33266\fP: (\fI\%Timandes\fP) Method \fIgrains.items\fP returns unexpected \fImanufacturer\fP information (refs: \fI\%#33302\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33306\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33302\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#33302\fP: (\fI\%The\-Loeki\fP) Cleanup comments in smbios.get output (fixes \fI\%#33266\fP) (refs: \fI\%#33306\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23643\fP: (\fI\%falzm\fP) Error in iptables module: argument \-\-match\-set: expected 2 argument(s) (refs: \fI\%#33314\fP, \fI\%#33301\fP, \fI\%#28325\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33314\fP: (\fI\%gerhardqux\fP) Fix iptables \-\-match\-set (\fI\%#23643\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33301\fP: (\fI\%gerhardqux\fP) Fix iptables \-\-match\-set (\fI\%#23643\fP) (refs: \fI\%#33314\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28325\fP: (\fI\%l13t\fP) Fix issue wiith \-\-match\-set option. \fI\%#23643\fP (refs: \fI\%#33314\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33308\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-05\-17 19:26:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0ed1616b0 Merge pull request \fI\%#33308\fP from rallytime/merge\-2015.8
.IP \(bu 2
1c43a62f85 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.INDENT 2.0
.IP \(bu 2
9b42a05519 Added some more docs for master and minion config settings (\fI\%#33292\fP)
.UNINDENT
.IP \(bu 2
5004d2fa61 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
8acee5e06c Fix iptables \-\-match\-set (\fI\%#23643\fP) (\fI\%#33301\fP)
.IP \(bu 2
757ef20a31 fix \(dqloose\(dq typo (\fI\%#33290\fP)
.IP \(bu 2
b7d98da64d Add auth_tries config option to minion.rst docs (\fI\%#33287\fP)
.IP \(bu 2
061851bcbf Document minion_id_caching config value (\fI\%#33282\fP)
.UNINDENT
.UNINDENT
.SS Salt 2015.8.12 Release Notes
.sp
Version 2015.8.12 is a bugfix release for \fI\%2015.8.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB58\fP
.IP \(bu 2
Total Issue References: \fB43\fP
.IP \(bu 2
Total PR References: \fB117\fP
.IP \(bu 2
Contributors: \fB29\fP (\fI\%Azidburn\fP, \fI\%Ch3LL\fP, \fI\%UtahDave\fP, \fI\%bobrik\fP, \fI\%cachedout\fP, \fI\%cedwards\fP,
\fI\%deepakhj\fP, \fI\%dere\fP, \fI\%gongled\fP, \fI\%gtmanfred\fP, \fI\%hrumph\fP, \fI\%hu\-dabao\fP, \fI\%isbm\fP, \fI\%jacobhammons\fP,
\fI\%jfindlay\fP, \fI\%jmesquita\fP, \fI\%junovitch\fP, \fI\%justinta\fP, \fI\%kev009\fP, \fI\%martinhoefling\fP, \fI\%multani\fP,
\fI\%rallytime\fP, \fI\%randomed\fP, \fI\%sjorge\fP, \fI\%terminalmage\fP, \fI\%thatch45\fP, \fI\%theothergraham\fP,
\fI\%twangboy\fP, \fI\%whiteinge\fP)
.UNINDENT
.SS Changelog for v2015.8.11..v2015.8.12
.sp
\fIGenerated at: 2018\-05\-28 01:19:12 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#35614\fP: (\fI\%rallytime\fP) Update release notes for 2015.8.12
.IP \(bu 2
\fBPR\fP \fI\%#35611\fP: (\fI\%rallytime\fP) Everything in the sample master config file should be commented out
.IP \(bu 2
\fBISSUE\fP \fI\%#35384\fP: (\fI\%ghost\fP) The unless requisite stops at first successful command (refs: \fI\%#35569\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35545\fP: (\fI\%hu\-dabao\fP) fix\-35384, fix cmd.run unless (refs: \fI\%#35566\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35569\fP: (\fI\%rallytime\fP) Write test for multiple unless commands where 1st cmd passes and 2nd fails
@ \fI2016\-08\-19 19:28:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35566\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35545\fP to 2015.8 (refs: \fI\%#35569\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35545\fP: (\fI\%hu\-dabao\fP) fix\-35384, fix cmd.run unless (refs: \fI\%#35569\fP, \fI\%#35566\fP)
.IP \(bu 2
c9070c212f Merge pull request \fI\%#35569\fP from rallytime/test\-for\-35384
.IP \(bu 2
30f42d5352 Write test for multiple unless commands where 1st cmd passes and 2nd fails
.IP \(bu 2
\fBPR\fP \fI\%#35600\fP: (\fI\%rallytime\fP) Update release notes for 2015.8.12
.IP \(bu 2
\fBPR\fP \fI\%#35599\fP: (\fI\%rallytime\fP) Update release notes for 2015.8.12
.IP \(bu 2
\fBPR\fP \fI\%#35584\fP: (\fI\%terminalmage\fP) Update linux_sysctl tests to reflect new context key
.IP \(bu 2
\fBPR\fP \fI\%#35575\fP: (\fI\%terminalmage\fP) Add warning about AWS flagging of nmap usage
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35577\fP: (\fI\%terminalmage\fP) Unit file changes for 2015.8.12, 2016.3.3
@ \fI2016\-08\-18 20:36:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
26a7f7d9f7 Merge pull request \fI\%#35577\fP from terminalmage/unit\-file\-changes
.IP \(bu 2
6cb0fb47f3 pkg/salt\-syndic.service: change Type to notify
.IP \(bu 2
175ba99e0e pkg/salt\-minion.service: remove KillMode, change Type to notify
.IP \(bu 2
540ec28954 pkg/salt\-master.service: remove KillMode
.IP \(bu 2
69fad464ab pkg/salt\-api.service: change Type to notify
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35545\fP: (\fI\%hu\-dabao\fP) fix\-35384, fix cmd.run unless (refs: \fI\%#35566\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35566\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35545\fP to 2015.8 (refs: \fI\%#35569\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35545\fP: (\fI\%hu\-dabao\fP) fix\-35384, fix cmd.run unless (refs: \fI\%#35569\fP, \fI\%#35566\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35492\fP: (\fI\%terminalmage\fP) Clarify config.get docstring
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#18419\fP: (\fI\%jasonrm\fP) salt\-cloud fails to run as non\-root user (refs: \fI\%#35483\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34806\fP: (\fI\%jerrykan\fP) salt\-cloud ignores sock_dir when firing event (refs: \fI\%#35483\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35483\fP: (\fI\%gtmanfred\fP) use __utils__ in salt.cloud
@ \fI2016\-08\-18 13:32:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
205d8e2e7b Merge pull request \fI\%#35483\fP from gtmanfred/2015.8
.IP \(bu 2
2d8ec1e9db use __opts__ in salt.utils.cloud for cache functions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35546\fP: (\fI\%whiteinge\fP) Salt api eauth fail gracefully
@ \fI2016\-08\-18 07:21:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
70fa2d0901 Merge pull request \fI\%#35546\fP from whiteinge/salt\-api\-eauth\-fail\-gracefully
.IP \(bu 2
eb3574adae Don\(aqt fail hard if the user\(aqs permissions cannot be found
.IP \(bu 2
ec597bd54c Change groups check in token to look for truthy values
.IP \(bu 2
\fBPR\fP \fI\%#35525\fP: (\fI\%UtahDave\fP) add missing glob import
.IP \(bu 2
\fBPR\fP \fI\%#35540\fP: (\fI\%rallytime\fP) Whitespace fix for 2015.8
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33803\fP: (\fI\%dmurphy18\fP) systemd notification is not fully supported by Salt  (refs: \fI\%#35510\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33516\fP: (\fI\%Ch3LL\fP) When upgrading from 2015.8.10 to 2016.3.0 on centos7/redhat7 I have to restart the salt\-minion twice  (refs: \fI\%#35510\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35510\fP: (\fI\%terminalmage\fP) Better systemd integration
@ \fI2016\-08\-17 18:54:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd3274c800 Merge pull request \fI\%#35510\fP from terminalmage/issue33516
.IP \(bu 2
5b5f19d269 Update zypper unit test to reflect call to config.get
.IP \(bu 2
2730edb516 Add note about systemd\-run usage in package states
.IP \(bu 2
e2d9e87e10 salt/modules/systemd.py: Use systemd\-run \-\-scope where needed
.IP \(bu 2
22919a25bc Notify systemd on salt\-api start
.IP \(bu 2
a40b3f8a08 Notify systemd on syndic start
.IP \(bu 2
e847d3af30 Notify systemd on minion start
.IP \(bu 2
d648887afc salt/modules/zypper.py: Use systemd\-run \-\-scope where needed
.IP \(bu 2
2e17976722 salt/modules/yumpkg.py: Use systemd\-run \-\-scope where needed
.IP \(bu 2
86b59c1e74 salt/modules/pacman.py: Use systemd\-run \-\-scope where needed
.IP \(bu 2
e32d92c6d5 salt/modules/ebuild.py: Use systemd\-run \-\-scope where needed
.IP \(bu 2
c7d21d3ae3 salt/modules/aptpkg.py: Use systemd\-run \-\-scope where needed
.IP \(bu 2
f83e0ef242 Add unit tests for salt.utils.systemd
.IP \(bu 2
5b12f030c6 Add func to salt.utils.systemd to tell if scopes are available
.IP \(bu 2
\fBPR\fP \fI\%#35513\fP: (\fI\%cachedout\fP) Might be a good idea to be able to download the software we make
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35302\fP: (\fI\%Ch3LL\fP) Add job cache test
@ \fI2016\-08\-17 10:45:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
9f87081cef Merge pull request \fI\%#35302\fP from Ch3LL/add_job_cache_test
.IP \(bu 2
ccb2a5cadf remove unused imports
.IP \(bu 2
512ae81dfd remove TMP and add integration.TMP
.IP \(bu 2
c9b7c3cf80 need to add returners option in other places
.IP \(bu 2
7316df7a02 fix pylint
.IP \(bu 2
50a4f0fe6a fix comment
.IP \(bu 2
6837acf742 add job cache integration tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35512\fP: (\fI\%cachedout\fP) Fixup 35419
@ \fI2016\-08\-17 10:11:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
1c82c6bee5 Merge pull request \fI\%#35512\fP from cachedout/fixup_35419
.IP \(bu 2
253662541a Fix import
.IP \(bu 2
f16a30786b Fixes consul.agent_service_register which was broken for registering service checks.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35497\fP: (\fI\%deepakhj\fP) Fixes spacing in requirements files
@ \fI2016\-08\-17 09:34:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
e1a373fa4c Merge pull request \fI\%#35497\fP from deepakhj/2015.8
.IP \(bu 2
685db4ab88 Fix spacing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35508\fP: (\fI\%terminalmage\fP) Add Carbon to versionadded for git.diff
@ \fI2016\-08\-17 06:17:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
4048255ed6 Merge pull request \fI\%#35508\fP from terminalmage/update\-docstring
.IP \(bu 2
67c945fce0 Add Carbon to versionadded for git.diff
.IP \(bu 2
\fBPR\fP \fI\%#35486\fP: (\fI\%rallytime\fP) Update bootstrap script to latest stable (2016.08.16)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35296\fP: (\fI\%szjur\fP) cp.push_dir gets confused when using upload_path and is probably insecure too (refs: \fI\%#35413\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35413\fP: (\fI\%cachedout\fP) Resolve path issues with cp.push
@ \fI2016\-08\-16 16:40:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
240fc12863 Merge pull request \fI\%#35413\fP from cachedout/issue_35296
.IP \(bu 2
fb8a12d677 Fix silly error
.IP \(bu 2
3646cf1afa Additional checks on master and integration test
.IP \(bu 2
09efde7634 Splat the list into os.path.join
.IP \(bu 2
fc0d5878bc Set file_recv on test master
.IP \(bu 2
81c4d136c5 Transition file push paths to lists
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#35380\fP: (\fI\%anlutro\fP) salt\-ssh with sudo stopped working (refs: \fI\%#35476\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35476\fP: (\fI\%cachedout\fP) Fixup SSH bug where sudo without sudo user would break
@ \fI2016\-08\-16 15:41:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3319b2a8b Merge pull request \fI\%#35476\fP from cachedout/issue_35380
.IP \(bu 2
c05fcf33d1 Fixup SSH bug where sudo without sudo user would break
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35471\fP: (\fI\%terminalmage\fP) win_pkg: Fix traceback when package is not installed
@ \fI2016\-08\-16 02:02:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
004778c966 Merge pull request \fI\%#35471\fP from terminalmage/issue34479
.IP \(bu 2
e243c63e43 win_pkg: Fix traceback when package is not installed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35448\fP: (\fI\%isbm\fP) Add ignore_repo_failure option to suppress zypper\(aqs exit code 106 on …
@ \fI2016\-08\-16 01:39:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
5c9428c32d Merge pull request \fI\%#35448\fP from isbm/isbm\-zypper\-106\-fix
.IP \(bu 2
dd82e6a848 Add ignore_repo_failure option to suppress zypper\(aqs exit code 106 on unavailable repos
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35451\fP: (\fI\%isbm\fP) Bugfix: zypper mod repo unchanged
@ \fI2016\-08\-16 01:38:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
1473474b04 Merge pull request \fI\%#35451\fP from isbm/isbm\-zypper\-mod_repo\-unchanged
.IP \(bu 2
8790197d86 Fix Unit test for suppressing the exception removal on non\-modified repos
.IP \(bu 2
3f00c6997a Remove zypper\(aqs raise exception if mod_repo has no arguments and/or no changes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34279\fP: (\fI\%vmadura\fP) Salt 2016.3.1 \- Master Side Pillar Cache (backend: Disk) never Expires. (refs: \fI\%#35453\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34279\fP: (\fI\%vmadura\fP) Salt 2016.3.1 \- Master Side Pillar Cache (backend: Disk) never Expires. (refs: \fI\%#35453\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35453\fP: (\fI\%theothergraham\fP) fixes \fI\%#34279\fP \- disk cache ttl expiry
@ \fI2016\-08\-16 01:34:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
a8c4f17f50 Merge pull request \fI\%#35453\fP from theothergraham/fix_CacheDisk
.IP \(bu 2
ae5b233d51 fixes \fI\%#34279\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35459\fP: (\fI\%thatch45\fP) Ensure that output for salt\-ssh gets back
@ \fI2016\-08\-16 01:29:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
d8c35b5260 Merge pull request \fI\%#35459\fP from thatch45/shim_fix
.IP \(bu 2
10037b00cb Some environments refuse to return the command output
.IP \(bu 2
\fBPR\fP \fI\%#35460\fP: (\fI\%rallytime\fP) [2015.8] Update bootstrap script to latest stable (2016.08.15)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#35010\fP: (\fI\%vchav73\fP) cp.push_dir returns incorrect result for non\-existent directories (refs: \fI\%#35442\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35442\fP: (\fI\%cachedout\fP) Fix cp.push_dir pushing empty dirs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#35387\fP: (\fI\%mzealey\fP) Document reload_grains and reload_pillar (refs: \fI\%#35436\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35436\fP: (\fI\%cachedout\fP) Minor doc fixup
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#35121\fP: (\fI\%sjorge\fP) file.append always results in change (refs: \fI\%#35132\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35132\fP: (\fI\%sjorge\fP) fixes , causing lots of mayham (onchange) with 2016.3.2 for me
@ \fI2016\-08\-15 07:11:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
a0b128a85a Merge pull request \fI\%#35132\fP from sjorge/2015.8\-35121
.IP \(bu 2
5cb38c8ae0 switch to fpread().splitlines(), as per @lorengordon suggestion
.IP \(bu 2
634f1dded5 fixes \fI\%#35121\fP, causing lots of mayham (onchange) with 2016.3.2 for me
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#34573\fP: (\fI\%cedwards\fP) Update freebsd.rst (refs: \fI\%#35394\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35394\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34573\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#34573\fP: (\fI\%cedwards\fP) Update freebsd.rst (refs: \fI\%#35394\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35359\fP: (\fI\%terminalmage\fP) Clean up open filehandles
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35339\fP: (\fI\%isbm\fP) Bugfix: Prevent continuous restart, if a dependency wasn\(aqt installed
@ \fI2016\-08\-11 16:15:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
9ea7a34c30 Merge pull request \fI\%#35339\fP from isbm/isbm\-2015.8\-minion\-importerror\-fix
.IP \(bu 2
12af60b7be Fix continuous minion restart if a dependency wasn\(aqt installed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35357\fP: (\fI\%twangboy\fP) Fix file.recurse with clean: True  on Windows (2015.8)
@ \fI2016\-08\-11 00:44:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd9b05ace4 Merge pull request \fI\%#35357\fP from twangboy/file.recurse.clean.2015.8
.IP \(bu 2
d328ec0157 Fix file.recurse with clean: True
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35323\fP: (\fI\%thatch45\fP) Fix issue with bad error check in salt\-vt
@ \fI2016\-08\-10 11:33:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
4618b433e9 Merge pull request \fI\%#35323\fP from thatch45/ssh_crazy
.IP \(bu 2
8a5b47b5d7 Collect all error data from the wfuncs call
.IP \(bu 2
11864c31b7 suppress a stack trace to show clean ssh error
.IP \(bu 2
9fbfa282fa wow this solves an issue!
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35325\fP: (\fI\%kev009\fP) Fix freebsd netstat route on fbsd 10+
@ \fI2016\-08\-10 11:33:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
cfae862972 Merge pull request \fI\%#35325\fP from kev009/fbsd\-netstat\-route
.IP \(bu 2
0d49dd3c29 Fix fbsd netstat route on fbsd 10+
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35264\fP: (\fI\%bobrik\fP) ssh_known_hosts.present is not idempotent in test=true with port (refs: \fI\%#35301\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35301\fP: (\fI\%bobrik\fP) Pass port to ssh.check_known_host, closes \fI\%#35264\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34945\fP: (\fI\%babilen\fP) file.recurse breaks directory permissions (refs: \fI\%#35309\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35309\fP: (\fI\%terminalmage\fP) file.recurse: Do not convert octal mode string to int
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35051\fP: (\fI\%terminalmage\fP) Runner/Wheel funcs still print return data to console when invoked from orchestration (refs: \fI\%#35290\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35290\fP: (\fI\%terminalmage\fP) Resolve a couple bugs in orchestration output
@ \fI2016\-08\-09 15:27:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
2efc1b333b Merge pull request \fI\%#35290\fP from terminalmage/issue35051
.IP \(bu 2
d621aa7b61 Update runner/wheel unit tests to reflect new key in ret dict
.IP \(bu 2
90c12a9c7b Add __orchestration__ key to orch returns for runner/wheel funcs
.IP \(bu 2
7b8c3b86e7 Suppress error about invalid changes data for orchestration jobs
.IP \(bu 2
54a1704d6c Suppress event for wheel/runner funcs executed from orchestration
.IP \(bu 2
f409f62bf2 Accept print_event option in WheelClient.cmd()
.IP \(bu 2
b42b25ccce Add cmd func for RunnerClient
.IP \(bu 2
480065fe00 Add print_event option to client mixins
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31074\fP: (\fI\%turtletraction\fP) salt\-ssh sudo_user execution not running as sudo_user (refs: \fI\%#35211\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35211\fP: (\fI\%cachedout\fP) Alternative sudo users for salt\-ssh
@ \fI2016\-08\-08 15:40:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
f8158124d5 Merge pull request \fI\%#35211\fP from cachedout/issue_31074
.IP \(bu 2
6f53232e6d Better error handling and a workaround for group mismatch.
.IP \(bu 2
5b56a4acf7 Docs
.IP \(bu 2
ae04e7aaeb Initial POC
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35166\fP: (\fI\%bobrik\fP) state_output_profile defaults are confusing (refs: \fI\%#35271\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35271\fP: (\fI\%bobrik\fP) Default state_output_profile to True everywhere, closes \fI\%#35166\fP
@ \fI2016\-08\-08 14:36:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e4eb13daa Merge pull request \fI\%#35271\fP from bobrik/default\-output\-profile
.IP \(bu 2
6cdee21036 Default state_output_profile to True everywhere, closes \fI\%#35166\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32719\fP: (\fI\%azweb76\fP) Salt\-Call Hangs when IPv6 is disabled on System (refs: \fI\%#35233\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35233\fP: (\fI\%terminalmage\fP) Do not attempt to get fqdn_ip{4,6} grains when ipv{4,6} grains are empty
@ \fI2016\-08\-06 22:58:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
673e1aa1aa Merge pull request \fI\%#35233\fP from terminalmage/issue32719
.IP \(bu 2
730a077041 Do not attempt to get fqdn_ip{4,6} grains when ipv{4,6} grains are empty
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35202\fP: (\fI\%multani\fP) doc: fix broken links in the test documentation page
@ \fI2016\-08\-06 08:29:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
cdf3c0fe73 Merge pull request \fI\%#35202\fP from multani/fix/test\-doc
.IP \(bu 2
1642dba5d1 doc: fix broken links in the test documentation page
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34861\fP: (\fI\%dere\fP) minion incorrectly reports package cannot be installed (refs: \fI\%#35119\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35236\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35119\fP to 2015.8
@ \fI2016\-08\-06 08:10:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35119\fP: (\fI\%dere\fP) Assume two EVRs are equal if E and V are equal but one R is missing. (refs: \fI\%#35236\fP)
.IP \(bu 2
e1331cd2a3 Merge pull request \fI\%#35236\fP from rallytime/bp\-35119
.IP \(bu 2
9ade78de7b Revise unnecessary code duplication
.IP \(bu 2
7c15f5b20a Fix formatting
.IP \(bu 2
64f93f8938 Assume two EVRs are equal if E and V are equal but one R is missing.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#29785\fP: (\fI\%paul\-mulvihill\fP) pkg.installed to accept \(aqlatest\(aq as a version keyword (refs: \fI\%#35225\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29785\fP: (\fI\%paul\-mulvihill\fP) pkg.installed to accept \(aqlatest\(aq as a version keyword (refs: \fI\%#35240\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35240\fP: (\fI\%dere\fP) Backport \fI\%#35225\fP to 2015.8
@ \fI2016\-08\-06 07:54:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35225\fP: (\fI\%dere\fP) Add missing documentation for pkg.installed (refs: \fI\%#35240\fP)
.IP \(bu 2
4f2b8aa5b6 Merge pull request \fI\%#35240\fP from derekmaciel/bp\-35225
.IP \(bu 2
9ed47f713a Add missing documentation for pkg.installed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35241\fP: (\fI\%terminalmage\fP) Ensure max recursion in gitfs results in no blob object being returned.
@ \fI2016\-08\-06 07:53:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
4bcfaa97d0 Merge pull request \fI\%#35241\fP from terminalmage/gitfs\-fixes
.IP \(bu 2
e05648cc2d Break from loop when file is found
.IP \(bu 2
6764a88601 Ensure that failed recursion results in no blob object being returned
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35039\fP: (\fI\%whiteinge\fP) Add saltenv support to module.run (refs: \fI\%#35245\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35245\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35039\fP to 2015.8
@ \fI2016\-08\-06 07:52:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#35039\fP: (\fI\%whiteinge\fP) Add saltenv support to module.run (refs: \fI\%#35245\fP)
.IP \(bu 2
f6d7360e0b Merge pull request \fI\%#35245\fP from rallytime/bp\-35039
.IP \(bu 2
51ab9cd6d4 Add saltenv support to module.run
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#35214\fP: (\fI\%tdenny\fP) git.latest fails on non\-fast\-forward when a fast\-forward is possible (refs: \fI\%#35249\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35249\fP: (\fI\%terminalmage\fP) Fix regression in git.latest
@ \fI2016\-08\-06 07:52:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
d65a5c7134 Merge pull request \fI\%#35249\fP from terminalmage/issue35214
.IP \(bu 2
bcd5129e9f Fix regression in git.latest when update is fast\-forward
.IP \(bu 2
e2e8bbbfde Add integration test for \fI\%#35214\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34691\fP: (\fI\%dmacvicar\fP) beacons.list does not include beacons configured from the pillar/ext_pillar (refs: #saltstack/salt\(ga#34827\(ga_, \fI\%#34827\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35146\fP: (\fI\%cachedout\fP) Don\(aqt discard running beacons config when listing becaons (refs: \fI\%#35174\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#34827\fP: (\fI\%thatch45\fP) fix beacon list to include all beacons being processed (refs: \fI\%#35146\fP, #\(gasaltstack/salt\(ga#35146\(ga_\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#35174\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35146\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#35146\fP: (\fI\%cachedout\fP) Don\(aqt discard running beacons config when listing becaons (refs: \fI\%#35174\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#35135\fP: (\fI\%rallytime\fP) Add missing CLI Examples to aws_sqs module funcs (refs: \fI\%#35173\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35173\fP: (\fI\%rallytime\fP) Back\-port \fI\%#35135\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#35135\fP: (\fI\%rallytime\fP) Add missing CLI Examples to aws_sqs module funcs (refs: \fI\%#35173\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35145\fP: (\fI\%jacobhammons\fP) doc version update to 2015.8.11, updates to release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35114\fP: (\fI\%terminalmage\fP) Add clarification docs on a common git_pillar misconfiguration
@ \fI2016\-08\-02 00:30:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
81845ee31d Merge pull request \fI\%#35114\fP from terminalmage/git_pillar\-env\-remap\-docs
.IP \(bu 2
5951554e9f Add clarification docs on a common git_pillar misconfiguration
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34767\fP: (\fI\%hrumph\fP) Ensure that pkg.installed function refreshes properly with windows. (refs: \fI\%#34768\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34767\fP: (\fI\%hrumph\fP) Ensure that pkg.installed function refreshes properly with windows. (refs: \fI\%#34768\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34768\fP: (\fI\%hrumph\fP) Fixes \fI\%#34767\fP
@ \fI2016\-08\-01 21:46:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
88a9fb1b31 Merge pull request \fI\%#34768\fP from hrumph/bad\-installed\-state
.IP \(bu 2
e1fcb8311d Put pkg.latest_version in try/except structure Move refreshed or refresh to different spot (just for code tidyness)
.IP \(bu 2
e0b6261659 changed name of variable \(aqrefreshed\(aq to \(aqwas_refreshed\(aq
.IP \(bu 2
340110b4b4 Move check for rtag to outermost\-nesting in function
.IP \(bu 2
ac67c6b493 Lint fix
.IP \(bu 2
0435a1375e Get rid of repetition in code by using new \(dqrefreshed\(dq variable instead
.IP \(bu 2
3b1dc978e2 Lint fix
.IP \(bu 2
a9bd1b92b9 lint fixes
.IP \(bu 2
71d69343ef Fixes \fI\%#34767\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35043\fP: (\fI\%rallytime\fP) Start release notes file for 2015.8.12
@ \fI2016\-08\-01 17:22:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
343576408f Merge pull request \fI\%#35043\fP from rallytime/new\-release\-notes
.IP \(bu 2
bdcc81a384 Start release notes file for 2015.8.12
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35050\fP: (\fI\%terminalmage\fP) [orchestration] Properly handle runner/wheel funcs which accept a \(aqsaltdev\(aq argument
@ \fI2016\-08\-01 15:48:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
848bf0272f Merge pull request \fI\%#35050\fP from terminalmage/fix\-saltdev\-arg
.IP \(bu 2
40cfa7cf17 Avoid needlessly running 2 argspecs in salt.utils.format_call()
.IP \(bu 2
fd186b7e4c Pass environment as \(aqsaltdev\(aq if runner/wheel func accepts a saltdev argument
.IP \(bu 2
951b52ab93 Pass __env__ from saltmod orch states to to saltutil.{runner,wheel}
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35066\fP: (\fI\%jfindlay\fP) returners.postgres_local_cache: do not log in __virtual__
@ \fI2016\-07\-30 01:32:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
2144178ae0 Merge pull request \fI\%#35066\fP from jfindlay/postgres_log
.IP \(bu 2
c2c442234f returners.postgres_local_cache: do not log in __virtual__
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34927\fP: (\fI\%bobrik\fP) Salt does not run \(dqsystemd daemon\-reload\(dq on unit override (refs: \fI\%#35024\fP)
.IP \(bu 2
\fBPR\fP \fI\%#35024\fP: (\fI\%bobrik\fP) Cache systemd unit update check per unit, closes \fI\%#34927\fP
@ \fI2016\-07\-28 17:56:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
7121618142 Merge pull request \fI\%#35024\fP from bobrik/daemon\-reload\-fix
.IP \(bu 2
c300615e9d Cache systemd unit update check per unit, closes \fI\%#34927\fP
.IP \(bu 2
\fBPR\fP \fI\%#35026\fP: (\fI\%cachedout\fP) Expressly deny a minion if a key cannot be found
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#33875\fP: (\fI\%jmesquita\fP) Fix naive fileserver map diff algorithm (refs: \fI\%#35000\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#35000\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33875\fP and \fI\%#34999\fP to 2015.8
@ \fI2016\-07\-27 21:55:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34999\fP: (\fI\%cachedout\fP) Fixup \fI\%#33875\fP (refs: \fI\%#35000\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33875\fP: (\fI\%jmesquita\fP) Fix naive fileserver map diff algorithm (refs: \fI\%#35000\fP, \fI\%#34999\fP)
.IP \(bu 2
2b511f3013 Merge pull request \fI\%#35000\fP from rallytime/bp\-33875
.IP \(bu 2
35696ad637 Pylint fix
.IP \(bu 2
f9fd6ddd8a Fixup \fI\%#33875\fP
.IP \(bu 2
56b1f6c651 Fix naive fileserver map diff algorithm
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34526\fP: (\fI\%danielmotaleite\fP) salt\-ssh + mine = weird error (refs: \fI\%#34835\fP, #\(gasaltstack/salt\(ga#34835\(ga_\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#34835\fP: (\fI\%thatch45\fP) Make the mine and publish combine minion and master opts in salt\-ssh (refs: \fI\%#34994\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34994\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34835\fP to 2015.8
@ \fI2016\-07\-27 18:21:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34835\fP: (\fI\%thatch45\fP) Make the mine and publish combine minion and master opts in salt\-ssh (refs: \fI\%#34994\fP)
.IP \(bu 2
837bc6ba7d Merge pull request \fI\%#34994\fP from rallytime/bp\-34835
.IP \(bu 2
9268a793de same thing for the mine in salt\-ssh
.IP \(bu 2
3e11e19714 Fix the mine in salt ssh
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34991\fP: (\fI\%cachedout\fP) SSH timeout
@ \fI2016\-07\-27 17:24:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
b58c663d8d Merge pull request \fI\%#34991\fP from cachedout/ssh_timeout
.IP \(bu 2
39cd8da399 Lint diff against salt\-testing
.IP \(bu 2
443e5cdde2 Add timeout to ssh tests
.IP \(bu 2
\fBPR\fP \fI\%#34976\fP: (\fI\%cachedout\fP) Refine errors in client
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34509\fP: (\fI\%srkunze\fP) No atomic  thin.tgz deploy (refs: \fI\%#34831\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34831\fP: (\fI\%thatch45\fP) If the thin does not match, then redeploy, don\(aqt error
@ \fI2016\-07\-26 22:27:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
a83cdf9339 Merge pull request \fI\%#34831\fP from thatch45/recoverssh
.IP \(bu 2
fa73041a49 If the thin does not match, then redeploy, don\(aqt error
.IP \(bu 2
\fBPR\fP \fI\%#34916\fP: (\fI\%cachedout\fP) Master performance improvement
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34911\fP: (\fI\%cachedout\fP) Backport \fI\%#34906\fP
@ \fI2016\-07\-22 23:23:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34906\fP: (\fI\%cachedout\fP) Set timeout for run_salt in test suite (refs: \fI\%#34911\fP)
.IP \(bu 2
34dc2fd792 Merge pull request \fI\%#34911\fP from cachedout/backport_34906
.IP \(bu 2
8becec2f4f Backport \fI\%#34906\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#33620\fP: (\fI\%TheBigBear\fP) [2016.3.0] win_pkg: pkg.list_upgrades loops (almost) endlessly \- cmds take VERY long (refs: \fI\%#34898\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34898\fP: (\fI\%hrumph\fP) Stop multiple refreshes during call to pkg.list_upgrades
@ \fI2016\-07\-22 22:28:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
6ccc27f697 Merge pull request \fI\%#34898\fP from hrumph/list_upgrades_refresh
.IP \(bu 2
acd4b1a23b Fixes \fI\%#33620\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34606\fP: (\fI\%isbm\fP) Bugfix: Exit on configuration read (backport) (refs: \fI\%#34751\fP)
@ \fI2016\-07\-22 17:35:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
5c13ee0e72 Merge pull request \fI\%#34606\fP from isbm/isbm\-config\-reading\-exit\-2015.8
.IP \(bu 2
5f5b802c0c Add option to master config reader on ignoring system exit for wrong configuration
.IP \(bu 2
6fc677f177 Ignore minion config errors everywhere but the minion itself
.IP \(bu 2
8699194647 Remove deprecation: BaseException.message deprecated as of 2.6
.IP \(bu 2
0e65cfec91 Fix lint: E8302
.IP \(bu 2
67faa56bf1 Use Salt default exit codes instead of hard\-coded values
.IP \(bu 2
a84556e596 Exit immediately on configuration error
.IP \(bu 2
43d965907c Raise an exception on any found wrong configuration file
.IP \(bu 2
30ed728d05 Cover exception handling in the utils.parsers
.IP \(bu 2
5e8c0c6bdb Introduce configuration error exception
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#27783\fP: (\fI\%anlutro\fP) salt\-ssh not properly updating file_lists, causing file.recurse to fail (refs: \fI\%#34862\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34862\fP: (\fI\%thatch45\fP) Fix salt\-ssh cacheing issue
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#34725\fP: (\fI\%akoumjian\fP) \fIgit.latest\fP with \fIforce_reset\fP set to \fITrue\fP does not reset local changes, causing it to fail. (refs: \fI\%#34869\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34869\fP: (\fI\%terminalmage\fP) Fail git.latest states with uncommitted changes when force_reset=False
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34859\fP: (\fI\%cachedout\fP) Fix wheel test
@ \fI2016\-07\-21 19:55:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
4f4381e5b9 Merge pull request \fI\%#34859\fP from cachedout/fix_wheel_test
.IP \(bu 2
b4be66dedf Fix wheel test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34798\fP: (\fI\%Ch3LL\fP) exception when running state.low over salt\-ssh (refs: \fI\%#34822\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34796\fP: (\fI\%Ch3LL\fP) exception when running state.high over salt\-ssh (refs: \fI\%#34822\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34822\fP: (\fI\%thatch45\fP) Fix salt\-ssh state.high and state.low
@ \fI2016\-07\-21 19:16:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
acc9e31c02 Merge pull request \fI\%#34822\fP from thatch45/ssh_fixes
.IP \(bu 2
b5de492143 fix \fI\%#34798\fP
.IP \(bu 2
5ad6bd7307 fix \fI\%#34796\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34847\fP: (\fI\%cachedout\fP) Add an option to skip the verification of client_acl users
@ \fI2016\-07\-21 17:55:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
5d91139bc9 Merge pull request \fI\%#34847\fP from cachedout/pwall
.IP \(bu 2
2c8298dc6e Profile logging
.IP \(bu 2
3affafa2e9 Add an option to skip the verification of client_acl users
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34691\fP: (\fI\%dmacvicar\fP) beacons.list does not include beacons configured from the pillar/ext_pillar (refs: #saltstack/salt\(ga#34827\(ga_, \fI\%#34827\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34827\fP: (\fI\%thatch45\fP) fix beacon list to include all beacons being processed
@ \fI2016\-07\-21 14:49:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
07d1d36653 Merge pull request \fI\%#34827\fP from thatch45/34691
.IP \(bu 2
1ccf35eca4 fix beacon list to include all beacons being processed
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#28521\fP: (\fI\%gongled\fP) SPM: packaging doesn\(aqt work in Python 2.6. Fixed. (refs: \fI\%#34833\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34833\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28521\fP to 2015.8
@ \fI2016\-07\-21 14:37:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28521\fP: (\fI\%gongled\fP) SPM: packaging doesn\(aqt work in Python 2.6. Fixed. (refs: \fI\%#34833\fP)
.IP \(bu 2
b375720251 Merge pull request \fI\%#34833\fP from rallytime/bp\-28521
.IP \(bu 2
e50a6783ce SPM: packaging doesn\(aqt work in Python 2.6. Fixed.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25213\fP: (\fI\%aboe76\fP) Add spm man page to setup.py (refs: #saltstack/salt\(ga#25276\(ga_, \fI\%#25276\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#25276\fP: (\fI\%jacobhammons\fP) copy spm.1 man page during setup (refs: \fI\%#34823\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34823\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25276\fP to 2015.8
@ \fI2016\-07\-20 20:56:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25276\fP: (\fI\%jacobhammons\fP) copy spm.1 man page during setup (refs: \fI\%#34823\fP)
.IP \(bu 2
042646582f Merge pull request \fI\%#34823\fP from rallytime/bp\-25276
.IP \(bu 2
a028796eff copy spm.1 man page during setup Refs \fI\%#25213\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34648\fP: (\fI\%bortels\fP) Error that % cannot start token (refs: \fI\%#34828\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#34648\fP: (\fI\%bortels\fP) Error that % cannot start token (refs: \fI\%#34828\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34828\fP: (\fI\%thatch45\fP) Fix \fI\%#34648\fP
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#34642\fP: (\fI\%justinta\fP) Check that mysqladmin exists before running mysql integration tests (refs: \fI\%#34818\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34818\fP: (\fI\%justinta\fP) Skip mysql state test if mysqladmin is not available
@ \fI2016\-07\-20 16:10:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
98fa4a404e Merge pull request \fI\%#34818\fP from jtand/mysql_state_integration_test_cleanup
.IP \(bu 2
9abb6f91bb Skip mysql state test if mysqladmin is not available
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#26278\fP: (\fI\%jiahua\-h\fP) \(dqorder: first\(dq doesn\(aqt work? (refs: \fI\%#34803\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#24744\fP: (\fI\%anlutro\fP) Allow states to define order: first (refs: \fI\%#34803\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24744\fP: (\fI\%anlutro\fP) Allow states to define order: first (refs: \fI\%#34803\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34803\fP: (\fI\%junovitch\fP) salt/state.py: set \(aqchunk[\(aqorder\(aq] = 0\(aq with \(aqorder: first\(aq; fixes \fI\%#24744\fP
@ \fI2016\-07\-20 13:56:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
6636f2b449 Merge pull request \fI\%#34803\fP from junovitch/issue_24744
.IP \(bu 2
64c850410f salt/state.py: set \(aqchunk[\(aqorder\(aq] = 0\(aq with \(aqorder: first\(aq; fixes \fI\%#24744\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34773\fP: (\fI\%randomed\fP) Bugfix: Startup states on minions are not being written to mysql returner
@ \fI2016\-07\-19 12:39:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
58021035a9 Merge pull request \fI\%#34773\fP from randomed/mysql\-returner\-startup/2015.8
.IP \(bu 2
0cd55eb7d7 Add jid=req handling for mysql returner. It should also store the return jid into the jid list table.
.IP \(bu 2
\fBPR\fP \fI\%#34751\fP: (\fI\%cachedout\fP) Remove unnedeed config test
.IP \(bu 2
\fBPR\fP \fI\%#34606\fP: (\fI\%isbm\fP) Bugfix: Exit on configuration read (backport) (refs: \fI\%#34751\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34754\fP: (\fI\%cachedout\fP) Disable test
@ \fI2016\-07\-18 18:40:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
f19caac8e4 Merge pull request \fI\%#34754\fP from cachedout/disable_mid_test
.IP \(bu 2
46901c6e65 Disable test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34678\fP: (\fI\%martinhoefling\fP) config.get module is broken due to bug in dictupdate.py (refs: \fI\%#34726\fP, #\(gasaltstack/salt\(ga#34726\(ga_\(ga_, \fI\%#34741\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#34726\fP: (\fI\%martinhoefling\fP) Always loop over updated keys in non recursive update (refs: \fI\%#34741\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34741\fP: (\fI\%rallytime\fP) Back\-port \fI\%#34726\fP to 2015.8
@ \fI2016\-07\-18 18:00:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#34726\fP: (\fI\%martinhoefling\fP) Always loop over updated keys in non recursive update (refs: \fI\%#34741\fP)
.IP \(bu 2
81f29006f2 Merge pull request \fI\%#34741\fP from rallytime/bp\-34726
.IP \(bu 2
d949110993  Loop over updated keys in non recursive update
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#34703\fP: (\fI\%Cashwini\fP) Is it possible to return output from python execution module to a file on salt master? (refs: \fI\%#34721\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34721\fP: (\fI\%rallytime\fP) Add output_file option to master config docs
@ \fI2016\-07\-16 20:04:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
e9e5bbe38b Merge pull request \fI\%#34721\fP from rallytime/fix\-34703
.IP \(bu 2
9c803d05a5 Add output_file option to master config docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#32276\fP: (\fI\%javicacheiro\fP) pkg.installed using sources from master fails with file not found after first successful run (refs: \fI\%#34689\fP)
.IP \(bu 2
\fBPR\fP \fI\%#34689\fP: (\fI\%Azidburn\fP) fix second run problems with pkg.installed using sources
@ \fI2016\-07\-15 21:19:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
08d00f3a61 Merge pull request \fI\%#34689\fP from Azidburn/fix_pkg_sources
.IP \(bu 2
2c0fc919b3 fix second run problems with pkg.installed using sources
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#34695\fP: (\fI\%isbm\fP) Bugfix: Zypper \fIpkg.list_products\fP returns False on some empty values (2015.8)
@ \fI2016\-07\-15 21:08:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
4cb1ded520 Merge pull request \fI\%#34695\fP from isbm/isbm\-zypper\-product\-boolean\-values
.IP \(bu 2
5ed5142fbc Update test data for \(aqregisterrelease\(aq and \(aqproductline\(aq fields
.IP \(bu 2
21444ee240 Bugfix: return boolean only for \(aqisbase\(aq and \(aqinstalled\(aq attributes
.UNINDENT
.UNINDENT
.SS Salt 2015.8.13 Release Notes
.sp
Version 2015.8.13 is a bugfix release for \fI\%2015.8.0\fP\&.
.SS Security Fixes
.sp
\fBCVE\-2017\-5192\fP local_batch client external authentication not respected
.sp
The \fBLocalClient.cmd_batch()\fP method client does not accept \fBexternal_auth\fP
credentials and so access to it from salt\-api has been removed for now. This
vulnerability allows code execution for already\-authenticated users and is only
in effect when running salt\-api as the \fBroot\fP user.
.sp
\fBCVE\-2017\-5200\fP Salt\-api allows arbitrary command execution on a salt\-master
via Salt\(aqs ssh_client
.sp
Users of Salt\-API and salt\-ssh could execute a command on the salt master via a
hole when both systems were enabled.
.sp
We recommend everyone on the 2015.8 branch upgrade to a patched release as soon
as possible.
.SS Salt 2015.8.2 Release Notes
.sp
Version 2015.8.2 is a bugfix release for \fI\%2015.8.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB379\fP
.IP \(bu 2
Total Issue References: \fB138\fP
.IP \(bu 2
Total PR References: \fB351\fP
.IP \(bu 2
Contributors: \fB83\fP (\fI\%DmitryKuzmenko\fP, \fI\%JaseFace\fP, \fI\%LoveIsGrief\fP, \fI\%MasterNayru\fP, \fI\%Oro\fP,
\fI\%SmithSamuelM\fP, \fI\%The\-Loeki\fP, \fI\%TheBigBear\fP, \fI\%aboe76\fP, \fI\%ajacoutot\fP, \fI\%anlutro\fP, \fI\%avinassh\fP,
\fI\%basepi\fP, \fI\%bdrung\fP, \fI\%bechtoldt\fP, \fI\%bernieke\fP, \fI\%blueyed\fP, \fI\%cachedout\fP, \fI\%cbuechler\fP,
\fI\%cedwards\fP, \fI\%clarkperkins\fP, \fI\%cro\fP, \fI\%dkiser\fP, \fI\%douglas\-vaz\fP, \fI\%dr4Ke\fP, \fI\%eguven\fP, \fI\%eliasp\fP,
\fI\%erchn\fP, \fI\%eyj\fP, \fI\%favadi\fP, \fI\%flavio\fP, \fI\%garethgreenaway\fP, \fI\%gravyboat\fP, \fI\%gtmanfred\fP,
\fI\%hedinfaok\fP, \fI\%hexedpackets\fP, \fI\%hyn\-salt\fP, \fI\%isbm\fP, \fI\%itsamenathan\fP, \fI\%jacksontj\fP,
\fI\%jacobhammons\fP, \fI\%jeffreyctang\fP, \fI\%jejenone\fP, \fI\%jfindlay\fP, \fI\%johnsocp\fP, \fI\%justinta\fP, \fI\%keesbos\fP,
\fI\%lathama\fP, \fI\%ldobson\fP, \fI\%lomeroe\fP, \fI\%martinhoefling\fP, \fI\%mbarrien\fP, \fI\%mbologna\fP, \fI\%merll\fP,
\fI\%mrosedale\fP, \fI\%msteed\fP, \fI\%multani\fP, \fI\%nasenbaer13\fP, \fI\%nmadhok\fP, \fI\%notpeter\fP, \fI\%opdude\fP,
\fI\%papertigers\fP, \fI\%pass\-by\-value\fP, \fI\%plastikos\fP, \fI\%quantonganh\fP, \fI\%rallytime\fP, \fI\%redmcg\fP,
\fI\%rowillia\fP, \fI\%ruzarowski\fP, \fI\%ryan\-lane\fP, \fI\%s0undt3ch\fP, \fI\%sdm24\fP, \fI\%sjansen\fP, \fI\%skizunov\fP,
\fI\%srkunze\fP, \fI\%techhat\fP, \fI\%terminalmage\fP, \fI\%ticosax\fP, \fI\%tkwilliams\fP, \fI\%toddtomkinson\fP,
\fI\%twangboy\fP, \fI\%twellspring\fP, \fI\%whiteinge\fP)
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
A significant orchestrate issue (\fI\%issue #29110\fP) was discovered during the
release process of 2015.8.2, so it has not been officially released.
Please use \fI\%2015.8.3\fP instead.
.UNINDENT
.UNINDENT
.SS Changelog for v2015.8.1..v2015.8.2
.sp
\fIGenerated at: 2018\-05\-27 23:17:44 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#28865\fP: (\fI\%jfindlay\fP) add 2015.8.2 release notes
@ \fI2015\-11\-13 17:30:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
af297bb0ae Merge pull request \fI\%#28865\fP from jfindlay/2015.8
.IP \(bu 2
1f847fc9ba add 2015.8.2 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27392\fP: (\fI\%ahammond\fP) schedule running state.orchestrate fails (refs: \fI\%#28730\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28730\fP: (\fI\%garethgreenaway\fP)  Fixes to how return_job is handled in the scheduler for the salt master.
@ \fI2015\-11\-13 16:58:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
15672a3faa Merge pull request \fI\%#28730\fP from garethgreenaway/27392_2015_8_scheduler_return_job_master
.IP \(bu 2
882350a543 Fixing the salt scheduler so that it only attempts to return the job data to the master if the scheduled job is running from a minion\(aqs scheduler.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28848\fP: (\fI\%cro\fP) Lint
@ \fI2015\-11\-13 13:46:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
5560cb662b Merge pull request \fI\%#28848\fP from cro/fx2_multi_creds
.IP \(bu 2
f032bffd7c Lint
.IP \(bu 2
6bb6703c3e Merge branch \(aqfx2_multi_creds\(aq of git://github.com/cro/salt into cro
.IP \(bu 2
3b7d22248c Fix fallback credentials, add grains based on dracr.server_info and dracr.inventory, fix short\-circuited for loop that was preventing retrieval of most data from CMC and DRAC devices, format responses from racadm more clearly.
.IP \(bu 2
b86c614564 Better logic around fallback credentials.
.IP \(bu 2
2701826a99 Update fx2.py, fix typos in new fallback parameters.
.IP \(bu 2
8ce5348808 Better variable name.
.IP \(bu 2
92038b8718 Default configuration file for proxy minions.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28842\fP: (\fI\%cachedout\fP) Add transport setting to shell test
@ \fI2015\-11\-12 21:43:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
778ace3ca5 Merge pull request \fI\%#28842\fP from cachedout/tcp_shell_test
.IP \(bu 2
785bf94f55 Add transport setting to shell test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28837\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-11\-12 21:17:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
5639971744 Merge pull request \fI\%#28837\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
1c91ad6765 fix lint
.IP \(bu 2
4b706ac76a Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
eb904665dc Merge pull request \fI\%#28832\fP from basepi/backport.28826
.INDENT 2.0
.IP \(bu 2
57be72eb91 Add backports_abc and singledispatch_helpers to thin as well
.IP \(bu 2
897cad627b Add singledispatch to the thin
.UNINDENT
.IP \(bu 2
eff811a0ad Merge pull request \fI\%#28833\fP from basepi/increase.gather_job_timeout.8647
.INDENT 2.0
.IP \(bu 2
c09243dd01 Increase the default gather_job_timeout
.UNINDENT
.IP \(bu 2
e4a036365d Merge pull request \fI\%#28829\fP from basepi/merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
f8b8441485 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
76e69b4bff Merge pull request \fI\%#28777\fP from rallytime/bp\-28740\-2014.7
.INDENT 2.0
.IP \(bu 2
da5fac2b36 Back\-port \fI\%#28740\fP to 2014.7
.UNINDENT
.IP \(bu 2
45c73ebf2f Merge pull request \fI\%#28716\fP from rallytime/bp\-28705
.INDENT 2.0
.IP \(bu 2
32e7bd3ea0 Account for new headers class in tornado 4.3
.UNINDENT
.IP \(bu 2
f4fe921965 Merge pull request \fI\%#28717\fP from cachedout/umask_note
.INDENT 2.0
.IP \(bu 2
1874300e08 Add note about recommended umask
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
5aeab71f76 Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
93562631aa Merge pull request \fI\%#28756\fP from MrCitron/fix\-25775
.INDENT 2.0
.IP \(bu 2
82075c809c Add logs and correct pylint error
.IP \(bu 2
e31e22d96a Fix 25775
.UNINDENT
.IP \(bu 2
30cc48e37f Merge pull request \fI\%#28786\fP from chrigl/fix\-28783
.INDENT 2.0
.IP \(bu 2
ba6d814553 closes \fI\%#28783\fP
.UNINDENT
.IP \(bu 2
8f1d0b636e Merge pull request \fI\%#28776\fP from rallytime/bp\-28740\-2015.5
.INDENT 2.0
.IP \(bu 2
49256b7d90 Back\-port \fI\%#28740\fP to 2015.5
.UNINDENT
.IP \(bu 2
77d4b980f1 Merge pull request \fI\%#28760\fP from dmyerscough/28732\-Fix\-cherrypi\-api\-keys\-endpoint
.INDENT 2.0
.IP \(bu 2
206d1684b2 Fixing CherryPy key bug
.UNINDENT
.IP \(bu 2
6f8f04975f Merge pull request \fI\%#28746\fP from rallytime/bp\-28718
.INDENT 2.0
.IP \(bu 2
092f441cad Account for no POST data
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28549\fP: (\fI\%ldelossa\fP) dockerng module issue (refs: \fI\%#28827\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28827\fP: (\fI\%jacksontj\fP) Cleanup virtual_timer in loader
@ \fI2015\-11\-12 19:39:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
c4fb185147 Merge pull request \fI\%#28827\fP from jacksontj/2015.8
.IP \(bu 2
f49502fd48 \fI__modules__\fP isn\(aqt a global, although \fI__salt__\fP is
.IP \(bu 2
c734cb8876 Fix virtual_timer branch such that it will catch exceptions.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28836\fP: (\fI\%cachedout\fP) Cast to dict to fix wheel tests in tcp
@ \fI2015\-11\-12 19:22:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
21520c6c1d Merge pull request \fI\%#28836\fP from cachedout/fix_tcp_wheel_tests
.IP \(bu 2
8d3244166b Cast to dict to fix wheel tests in tcp
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28834\fP: (\fI\%cachedout\fP) Fix breakage in tcp server
@ \fI2015\-11\-12 18:57:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
560671a170 Merge pull request \fI\%#28834\fP from cachedout/tcp_revert_master_uri
.IP \(bu 2
755d493bed Fix breakage in tcp server
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28804\fP: (\fI\%cachedout\fP) TCP test fixes
@ \fI2015\-11\-12 18:39:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
224602437a Merge pull request \fI\%#28804\fP from cachedout/tcp_test_fixes
.IP \(bu 2
f799971280 Change logic
.IP \(bu 2
52ed06500a Fix typo
.IP \(bu 2
9b18f372e6 Normalize IPC check among transports
.IP \(bu 2
e8ead2bfed Allow for tcp transport in publish
.IP \(bu 2
e33b903e7b Allow for tcp transport in mine
.IP \(bu 2
3d80e67a2d Allow for tcp transport in auth
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28828\fP: (\fI\%basepi\fP) salt\-ssh doesn\(aqt package tornado\(aqs new deps in the thin (refs: \fI\%#28826\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28826\fP: (\fI\%basepi\fP) [2015.8] Add new tornado deps to salt\-ssh thin (refs: \fI\%#28832\fP)
@ \fI2015\-11\-12 18:14:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
49992070db Merge pull request \fI\%#28826\fP from basepi/salt\-ssh.singledispatch.thin
.IP \(bu 2
1e1a74fd61 Add backports_abc and singledispatch_helpers to thin as well
.IP \(bu 2
da1a2773dd Add singledispatch to the thin
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28759\fP: (\fI\%jfindlay\fP) simplify stdin use of stdin in at.present state
@ \fI2015\-11\-12 18:11:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28187\fP: (\fI\%sjansen\fP) fix at.present (refs: \fI\%#28759\fP)
.IP \(bu 2
af52c3272f Merge pull request \fI\%#28759\fP from jfindlay/at
.IP \(bu 2
987d1fee7c simplify stdin use of stdin in at.present state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28824\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28778\fP and \fI\%#28820\fP to 2015.8
@ \fI2015\-11\-12 18:06:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28820\fP: (\fI\%cro\fP) Add versionadded directives for chronos and marathon proxy grains. (refs: \fI\%#28824\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28778\fP: (\fI\%toddtomkinson\fP) marathon and chronos proxy minions (refs: \fI\%#28824\fP)
.IP \(bu 2
08891cb210 Merge pull request \fI\%#28824\fP from rallytime/bp\-28778\-and\-28820
.IP \(bu 2
ab5943995b Change versionaddeds to 2015.8.2 from Boron
.IP \(bu 2
da7ad0df99 Add versionadded directives.
.IP \(bu 2
4bdd10fdf5 documentation updates
.IP \(bu 2
675bc2acce more pylint fixes
.IP \(bu 2
8e19b5c518 pylint fixes
.IP \(bu 2
ba94878f45 marathon and chronos proxy minions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23271\fP: (\fI\%twisty7867\fP) Unicode paths break file states with masterless minion on Vagrant/Ubuntu 14.04 (refs: \fI\%#28803\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28803\fP: (\fI\%jfindlay\fP) decode strings to utf\-8
@ \fI2015\-11\-12 04:59:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
30ea94439c Merge pull request \fI\%#28803\fP from jfindlay/sdecodes
.IP \(bu 2
11163380cf sdecode chunk name in state compiler
.IP \(bu 2
7f95c483e1 sdecode strings in file state
.IP \(bu 2
fe4d08526d sdecode strings in highstate outputter
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25363\fP: (\fI\%syphernl\fP) rabbitmq_{user|vhost}.present in test=True reports unnecessary changes (refs: \fI\%#28269\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24856\fP: (\fI\%pruiz\fP) rabbitmq_user state incorrectly reports result=True when using test=true (refs: \fI\%#28269\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28782\fP: (\fI\%rallytime\fP) Fixes to rabbitmq user state
@ \fI2015\-11\-12 00:59:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28269\fP: (\fI\%rallytime\fP) Refactor rabbitmq_user state to use test=True correctly (refs: \fI\%#28782\fP, \fI\%#28772\fP)
.IP \(bu 2
59b505ff7c Merge pull request \fI\%#28782\fP from rallytime/rabbitmq\-user\-state
.IP \(bu 2
e2b0fee57e Don\(aqt change perms list, only existing perms should be a dictionary.
.IP \(bu 2
7601647d69 Revert \(dqrabbitmq.list_user_permissions returns a dict, not a list. Don\(aqt expect a list.\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28429\fP: (\fI\%cbuechler\fP) salt\-cloud VMware driver fails with uncustomizable guest when not customizing guest (refs: \fI\%#28789\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28789\fP: (\fI\%nmadhok\fP) Provide ability to enable/disable customization for newly create VMs using VMware salt\-cloud driver
@ \fI2015\-11\-11 22:48:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
098d48ad26 Merge pull request \fI\%#28789\fP from nmadhok/2015.8\-customization\-fix
.IP \(bu 2
9294ebd984 Provide ability to enable/disable customization for new VMs. Fixes \fI\%#28429\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28692\fP: (\fI\%mrosedale\fP) puppet.run fails with arguments (refs: \fI\%#28768\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28768\fP: (\fI\%mrosedale\fP) 2015.8
@ \fI2015\-11\-11 19:29:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
1e510be55b Merge pull request \fI\%#28768\fP from mrosedale/2015.8
.IP \(bu 2
fbbbdcc02e Update puppet.py
.IP \(bu 2
1c1a4b4410 Update puppet.py
.IP \(bu 2
59bd6aef5c Merge pull request \fI\%#1\fP from mrosedale/mrosedale\-patch\-1
.INDENT 2.0
.IP \(bu 2
c26ea916aa Update puppet.py
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25363\fP: (\fI\%syphernl\fP) rabbitmq_{user|vhost}.present in test=True reports unnecessary changes (refs: \fI\%#28269\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24856\fP: (\fI\%pruiz\fP) rabbitmq_user state incorrectly reports result=True when using test=true (refs: \fI\%#28269\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28772\fP: (\fI\%rallytime\fP) rabbitmq.list_user_permissions returns a dict, not a list. Don\(aqt expect a list.
@ \fI2015\-11\-11 18:17:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28269\fP: (\fI\%rallytime\fP) Refactor rabbitmq_user state to use test=True correctly (refs: \fI\%#28782\fP, \fI\%#28772\fP)
.IP \(bu 2
a6cad46301 Merge pull request \fI\%#28772\fP from rallytime/rabbitmq\-user\-state
.IP \(bu 2
07482211eb rabbitmq.list_user_permissions returns a dict, not a list. Don\(aqt expect a list.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28724\fP: (\fI\%quantonganh\fP) Exception occurred when calling boto_vpc.route_table_present with test=True (refs: \fI\%#28725\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28774\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28725\fP to 2015.8
@ \fI2015\-11\-11 18:16:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28725\fP: (\fI\%quantonganh\fP) boto_vpc: return an empty dict in case cannot get the route tables (refs: \fI\%#28774\fP)
.IP \(bu 2
d570ac48f4 Merge pull request \fI\%#28774\fP from rallytime/bp\-28725
.IP \(bu 2
c3420461c3 boto_vpc: return an empty dict in case cannot get the route tables
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28775\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28740\fP to 2015.8
@ \fI2015\-11\-11 17:57:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28740\fP: (\fI\%MasterNayru\fP) Add missing S3 module import (refs: \fI\%#28777\fP, \fI\%#28775\fP, \fI\%#28776\fP)
.IP \(bu 2
806d1b3669 Merge pull request \fI\%#28775\fP from rallytime/bp\-28740
.IP \(bu 2
8a2780da18 Add missing S3 module import
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28755\fP: (\fI\%rallytime\fP) Move most vmware driver list_* functions to use salt.utils.vmware functions
@ \fI2015\-11\-11 17:49:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
f273c46f07 Merge pull request \fI\%#28755\fP from rallytime/vmware\-utils
.IP \(bu 2
5abe010023 Move most vmware driver list_* functions to use salt.utils.vmware functions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28655\fP: (\fI\%sjorge\fP) possible issue with state module boto_cfn/docker/... (refs: \fI\%#28744\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28744\fP: (\fI\%jfindlay\fP) import gate elementtree
@ \fI2015\-11\-11 16:29:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d912bf0d4 Merge pull request \fI\%#28744\fP from jfindlay/elementttree
.IP \(bu 2
e321d60002 import gate elementtree in artifactory module
.IP \(bu 2
f20f3f697b import gate elementtree in boto_iam state
.IP \(bu 2
9845d2f2c6 import gate elementtree in boto_cfn state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28726\fP: (\fI\%feigenblatt\fP) user.present ignores \(dqcreatehome: False\(dq (refs: \fI\%#28758\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28758\fP: (\fI\%jfindlay\fP) remove redundant logic in useradd execution module
@ \fI2015\-11\-11 16:22:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
b65e786351 Merge pull request \fI\%#28758\fP from jfindlay/user
.IP \(bu 2
dbd582cd8d fix doc formatting in user.present state
.IP \(bu 2
3824d2e9fc only change/report new home when createhome is True
.IP \(bu 2
3fbf81611f remove redundant logic in useradd execution module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28757\fP: (\fI\%mbarrien\fP) Bug fix: pip command to not quote spaces in cmd line args
@ \fI2015\-11\-11 16:08:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
6eced26013 Merge pull request \fI\%#28757\fP from mbarrien/fix\-pip\-cmd
.IP \(bu 2
6df6cb82a6 Fix pip command to not quote spaces in cmd line args
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28764\fP: (\fI\%multani\fP) Various documentation fixes
@ \fI2015\-11\-11 16:06:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
356bf2987d Merge pull request \fI\%#28764\fP from multani/fix/docs
.IP \(bu 2
1a31b69763 doc: fix documentation formatting in salt.utils.jinja
.IP \(bu 2
59c105b4b9 doc: fix documentation formatting in salt.states.boto_iam*
.IP \(bu 2
cbb167c8ee doc: fix documentation formatting in in salt.modules.lxc
.IP \(bu 2
cb03a89e52 doc: fix documentation formatting in salt.modules.aptpkg
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28752\fP: (\fI\%aboe76\fP) Update openSUSE grain for tumbleweed
@ \fI2015\-11\-11 03:54:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
d77c24e70d Merge pull request \fI\%#28752\fP from aboe76/suse_tumbleweed_grain
.IP \(bu 2
764cb16ef0 Update openSUSE grain for tumbleweed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28712\fP: (\fI\%hexedpackets\fP) Service registration in the Consul module is broken (refs: \fI\%#28713\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28713\fP: (\fI\%hexedpackets\fP) Rename consul.list to consul.list_keys.
@ \fI2015\-11\-11 00:57:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
a620bc5596 Merge pull request \fI\%#28713\fP from hexedpackets/fix\-consul\-module
.IP \(bu 2
0889907b3c Make consul.list a function alias.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28719\fP: (\fI\%jacobhammons\fP) removed dependencies info from docs
@ \fI2015\-11\-10 00:04:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
decc31a766 Merge pull request \fI\%#28719\fP from jacobhammons/spm
.IP \(bu 2
d7017be031 removed dependencies info from docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28709\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-11\-09 23:38:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
989069f44a Merge pull request \fI\%#28709\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
2d04ddc108 Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
f40c617bad Merge pull request \fI\%#28705\fP from cachedout/tornado_http_headers
.INDENT 2.0
.IP \(bu 2
7ac6cde1ee Account for new headers class in tornado 4.3
.UNINDENT
.UNINDENT
.IP \(bu 2
c90431eddc Rip out unit test that doesn\(aqt apply anymore
.IP \(bu 2
aeeaa7c90d Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
604a7b4199 Merge pull request \fI\%#28699\fP from rallytime/bp\-28670
.INDENT 2.0
.IP \(bu 2
e436b23296 psutil can fail to look\-up a uid and raise a KeyError
.UNINDENT
.IP \(bu 2
7bd3eb8370 Merge pull request \fI\%#28703\fP from rallytime/bp\-28690
.INDENT 2.0
.IP \(bu 2
a0988dab58 Fix 28689 : Check s3 ext pillar cache file before calculating expiration
.UNINDENT
.IP \(bu 2
2a40f57b93 Merge pull request \fI\%#28694\fP from s0undt3ch/2015.5
.INDENT 2.0
.IP \(bu 2
0910c6ffe4 Update to latest bootstrap script v2015.11.09
.UNINDENT
.IP \(bu 2
3249b322e8 Merge pull request \fI\%#28669\fP from rallytime/fix\-26592
.INDENT 2.0
.IP \(bu 2
098fb815af Use the \-q argument to strip extraneous messages from rabbitmq
.UNINDENT
.IP \(bu 2
29e8250d0c Merge pull request \fI\%#28645\fP from jacksontj/2015.5
.INDENT 2.0
.IP \(bu 2
f63c2d70a7 Rework minion return_retry_timer
.UNINDENT
.IP \(bu 2
1bbaea8aad Merge pull request \fI\%#28668\fP from twangboy/fix_15177
.INDENT 2.0
.IP \(bu 2
745b8f75f6 Fixed some lint
.IP \(bu 2
a43eb53f28 Added version added notes in docs
.IP \(bu 2
6b537c8640 Fixed join_domain and unjoin_domain for Windows
.UNINDENT
.IP \(bu 2
4ad5056066 Merge pull request \fI\%#28666\fP from jfindlay/r_data
.INDENT 2.0
.IP \(bu 2
29228f445f define r_data before using it in file module
.UNINDENT
.IP \(bu 2
e129e889ad Merge pull request \fI\%#28662\fP from cachedout/issue_24758
.INDENT 2.0
.IP \(bu 2
78f4894333 Add note about disabling master_alive_interval
.UNINDENT
.IP \(bu 2
df121d0cec Merge pull request \fI\%#28627\fP from twangboy/backport_win_useradd
.INDENT 2.0
.IP \(bu 2
87282b6354 Backport win_useradd
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28469\fP: (\fI\%mlalpho\fP) state boto_secgroup.present fails to find vpc_name (refs: \fI\%#28710\fP, \fI\%#28534\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28710\fP: (\fI\%rallytime\fP) Pass kwargs correctly to _get_group from get_group_id
@ \fI2015\-11\-09 22:29:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
8d5ab15c16 Merge pull request \fI\%#28710\fP from rallytime/fix\-28469
.IP \(bu 2
0571608f5d Pass kwargs correctly to _get_group from get_group_id
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28698\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28530\fP to 2015.8
@ \fI2015\-11\-09 18:11:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28530\fP: (\fI\%skizunov\fP) AsyncTCPReqChannel will fail after 10 uses (refs: \fI\%#28614\fP, \fI\%#28698\fP)
.IP \(bu 2
cfa0cec19c Merge pull request \fI\%#28698\fP from rallytime/bp\-28530
.IP \(bu 2
d94d0db805 AsyncTCPReqChannel will fail after 10 uses
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28678\fP: (\fI\%johnsocp\fP) Error in netapi/rest_tornado preventing it from starting (refs: \fI\%#28679\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28700\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28679\fP to 2015.8
@ \fI2015\-11\-09 18:07:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28679\fP: (\fI\%johnsocp\fP) Adding err variable definition to fix error that is preventing rest_tornado from initializing (refs: \fI\%#28700\fP)
.IP \(bu 2
2fe9e2e7c5 Merge pull request \fI\%#28700\fP from rallytime/bp\-28679
.IP \(bu 2
4e0870e636 Adding variable definition for issue \fI\%#28678\fP
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#868\fP: (\fI\%cachedout\fP) Always refresh the Arch Linux keyring if needed (refs: \fI\%#28695\fP, \fI\%#28694\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28695\fP: (\fI\%s0undt3ch\fP) [2015.8] Update to latest bootstrap script v2015.11.09
@ \fI2015\-11\-09 17:50:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
8ccea2a855 Merge pull request \fI\%#28695\fP from s0undt3ch/2015.8
.IP \(bu 2
bb6c60a330 Update to latest bootstrap script v2015.11.09
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28526\fP: (\fI\%clarkperkins\fP) yumpkg.installed broken in salt v2015.8.1 on CentOS 6 minions (refs: \fI\%#28656\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28656\fP: (\fI\%clarkperkins\fP) \fI\%#28526\fP fixed yumpkg module issue with pkg.installed
@ \fI2015\-11\-09 05:16:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
61ba00b1c3 Merge pull request \fI\%#28656\fP from clarkperkins/bugfix/fix\-yumpkg\-module
.IP \(bu 2
e11f87be93 \fI\%#28526\fP fixed yumpkg module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28588\fP: (\fI\%aboe76\fP) openSUSE Leap not recognized as \(aqSuse\(aq os grain and os_family grain (2015.8.1 )  (refs: \fI\%#28672\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28672\fP: (\fI\%jfindlay\fP) add OS grain support for SuSE Leap
@ \fI2015\-11\-08 01:05:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
54484e4e29 Merge pull request \fI\%#28672\fP from jfindlay/suse_grain
.IP \(bu 2
b44ba6fa9c add OS grain support for SuSE Leap
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28603\fP: (\fI\%alexharrington\fP) MooseFS/LizardFS mount options force remount (refs: \fI\%#28673\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28673\fP: (\fI\%jfindlay\fP) add hidden_opts to mount.mounted
@ \fI2015\-11\-08 00:51:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
476f55ebc0 Merge pull request \fI\%#28673\fP from jfindlay/mount_hide
.IP \(bu 2
1dcaa8e1d7 add hidden_opts to mount.mounted
.IP \(bu 2
d3aff8f6b8 minor refactor of mount state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28667\fP: (\fI\%cro\fP) saltutil.sync_all should sync proxymodules as well as the rest.
@ \fI2015\-11\-07 01:09:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
24d75709fa Merge pull request \fI\%#28667\fP from cro/proxy_sync_all
.IP \(bu 2
08e53b317f Sync proxymodules with sync_all
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28665\fP: (\fI\%jfindlay\fP) fixes to windows execution and state modules
@ \fI2015\-11\-07 00:47:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
019c13948a Merge pull request \fI\%#28665\fP from jfindlay/win_fixorz
.IP \(bu 2
e8c7371b56 fix minor doc issues in win_system module
.IP \(bu 2
5828f391b9 handle error on nonexistent net dev in win_network
.IP \(bu 2
d1560f9ea9 check for wua time setting as a str
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28542\fP: (\fI\%Ch3LL\fP) s3.get execution module returns error (refs: \fI\%#28660\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28660\fP: (\fI\%techhat\fP) Don\(aqt sign empty regions
@ \fI2015\-11\-06 20:49:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce3ce7ddf2 Merge pull request \fI\%#28660\fP from techhat/emptyregion
.IP \(bu 2
a52518494a Don\(aqt sign empty regions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28632\fP: (\fI\%terminalmage\fP) Fixes/improvements to pkgbuild state/modules
@ \fI2015\-11\-06 20:48:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
0583575f82 Merge pull request \fI\%#28632\fP from terminalmage/pkgbuild\-fixes
.IP \(bu 2
59f31b4dca Initialize logging in pkgbuild state
.IP \(bu 2
af0b2c4a33 Fix false\-positives for pkgbuild.built state
.IP \(bu 2
d83e779eac rpmbuild: Change return data to include a list of packages built
.IP \(bu 2
03d9321379 debbuild: Change return data to include a list of packages built
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28591\fP: (\fI\%ssgward\fP) SPM package install error (refs: \fI\%#28658\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28658\fP: (\fI\%techhat\fP) Remove _pkgdb_fun() references
@ \fI2015\-11\-06 20:25:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
b82abadd9b Merge pull request \fI\%#28658\fP from techhat/issue28591
.IP \(bu 2
4f2b175467 Remove _pkgdb_fun() references
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28470\fP: (\fI\%mlalpho\fP) salt boto_rds.present fails to execute, too many arguments (refs: \fI\%#28612\fP, \fI\%#28653\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28653\fP: (\fI\%rallytime\fP) Provide possible parameters for boto_rds.present engine values
@ \fI2015\-11\-06 18:58:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
e59d160120 Merge pull request \fI\%#28653\fP from rallytime/boto_rds_engine_docs
.IP \(bu 2
7b30d7e002 Provide possible parameters for boto_rds.present engine values
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28649\fP: (\fI\%bdrung\fP) Fix OS related grains on Debian
@ \fI2015\-11\-06 18:25:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
911761d8bc Merge pull request \fI\%#28649\fP from bdrung/2015.8
.IP \(bu 2
92a17d4cae Fix OS related grains on Debian
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26889\fP: (\fI\%UtahDave\fP) salt\-call w/non root user outputs repeating error (refs: \fI\%#28113\fP, \fI\%#27343\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28646\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28614\fP to 2015.8
@ \fI2015\-11\-06 18:19:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28614\fP: (\fI\%skizunov\fP) Fixed memory leak in AsyncTCPReqChannel (refs: \fI\%#28646\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28530\fP: (\fI\%skizunov\fP) AsyncTCPReqChannel will fail after 10 uses (refs: \fI\%#28614\fP, \fI\%#28698\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28113\fP: (\fI\%skizunov\fP) \(aqRuntimeError: IOLoop is closing\(aq thrown in Minion on TCP transport (refs: \fI\%#28614\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27343\fP: (\fI\%cachedout\fP) Close io loop before deleting attribute (refs: \fI\%#28614\fP)
.IP \(bu 2
7531bc7334 Merge pull request \fI\%#28646\fP from rallytime/bp\-28614
.IP \(bu 2
034cf28e57 Fixed memory leak in AsyncTCPReqChannel
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28647\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28624\fP to 2015.8
@ \fI2015\-11\-06 18:18:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28624\fP: (\fI\%hyn\-salt\fP) Added reasoning why boto_cloudwatch.py cannot be loaded. (refs: \fI\%#28647\fP)
.IP \(bu 2
a829120746 Merge pull request \fI\%#28647\fP from rallytime/bp\-28624
.IP \(bu 2
3b59cfae5f Added reasoning why boto_cloudwatch.py cannot be loaded.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28648\fP: (\fI\%rallytime\fP) Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
@ \fI2015\-11\-06 17:46:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
52d70c986d Merge pull request \fI\%#28648\fP from rallytime/merge\-2015.8
.IP \(bu 2
81c4974fde Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.INDENT 2.0
.IP \(bu 2
64a20228c6 Merge pull request \fI\%#28617\fP from cachedout/umask_module_sync
.INDENT 2.0
.IP \(bu 2
227792e158 Set restrictive umask on module sync
.UNINDENT
.IP \(bu 2
065f8c7fb3 Merge pull request \fI\%#28622\fP from gravyboat/update_puppet_module_docs
.INDENT 2.0
.IP \(bu 2
4ea28bed30 Update puppet module wording
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28638\fP: (\fI\%anlutro\fP) Salt\-SSH: Return more concise error when SSH command fails
@ \fI2015\-11\-06 16:54:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
4722e41787 Merge pull request \fI\%#28638\fP from alprs/saltssh\-handle_ssh_errors
.IP \(bu 2
5419b98363 return concise error when ssh fails
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28644\fP: (\fI\%pass\-by\-value\fP) Make sure versionchanged is correct
@ \fI2015\-11\-06 16:53:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
e72e60d4b4 Merge pull request \fI\%#28644\fP from pass\-by\-value/update_versionchanged
.IP \(bu 2
f4c297e794 Make sure versionchanged is correct
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#8\fP: (\fI\%thatch45\fP) Network persistence (refs: \fI\%#28615\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#64\fP: (\fI\%thatch45\fP) State file rendering system (refs: \fI\%#28615\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#54\fP: (\fI\%thatch45\fP) Release items (refs: \fI\%#28615\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28615\fP: (\fI\%The\-Loeki\fP) Fixes to FreeBSD pkg
@ \fI2015\-11\-05 23:43:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#198\fP: (\fI\%techhat\fP) Basic salt support for Tomcat (refs: \fI\%#28615\fP)
.IP \(bu 2
cf79722260 Merge pull request \fI\%#28615\fP from The\-Loeki/patch\-1
.IP \(bu 2
a9ee178e0d rehash is a shell builtin, needs cmd.shell to work
.IP \(bu 2
17f3852bdd environ.get has no output_loglevel
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28613\fP: (\fI\%cachedout\fP) Add facility to deepcopy bound methods in Py2.6 and apply to grains
@ \fI2015\-11\-05 23:28:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28587\fP: (\fI\%cachedout\fP) Reset yaml rendering hooks to avoid leaks (refs: \fI\%#28613\fP)
.IP \(bu 2
9196c57e3f Merge pull request \fI\%#28613\fP from cachedout/py26_method_deepcopy
.IP \(bu 2
0935fcf4fc Spelling is hard
.IP \(bu 2
2435b45195 Move to compat module to avoid namespace collisions in salt.utils
.IP \(bu 2
f519661875 Add facility to deepcopy bound methods in Py2.6 and apply to grains
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28527\fP: (\fI\%Oro\fP) boto_rds.create needs storage_type, which does not exist in boto.rds2 create_db_instance (refs: \fI\%#28561\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#28470\fP: (\fI\%mlalpho\fP) salt boto_rds.present fails to execute, too many arguments (refs: \fI\%#28612\fP, \fI\%#28653\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28612\fP: (\fI\%rallytime\fP) Remove unsupported storage_type argument for parity with boto_rds module
@ \fI2015\-11\-05 19:07:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28561\fP: (\fI\%Oro\fP) Issue \fI\%#28527\fP boto_rds.create does not work (refs: \fI\%#28612\fP)
.IP \(bu 2
2032d61e68 Merge pull request \fI\%#28612\fP from rallytime/fix\-28470
.IP \(bu 2
8fd26a5488 Remove unsupported storage_type argument for parity with boto_rds module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28611\fP: (\fI\%rallytime\fP) [2015.8] Be explicit about salt.utils.vmware function calls
@ \fI2015\-11\-05 18:43:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
d81330ac7f Merge pull request \fI\%#28611\fP from rallytime/vmware\-utils\-fix
.IP \(bu 2
f46547eb56 [2015.8] Be explicit about salt.utils.vmware function calls and avoid namespacing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28610\fP: (\fI\%pass\-by\-value\fP) Lxc config additions
@ \fI2015\-11\-05 18:43:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
35dbca24e7 Merge pull request \fI\%#28610\fP from pass\-by\-value/lxc_config_additions
.IP \(bu 2
83193641ca Add doc about cloud lxc options
.IP \(bu 2
8977ddad59 Add argument to init
.IP \(bu 2
2be3f8b5bb Add bootstrap delay and systemd check options
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28601\fP: (\fI\%nasenbaer13\fP) boto_asg.present overwrites custom dimensions in alarms (refs: \fI\%#28602\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28602\fP: (\fI\%nasenbaer13\fP) Allow setting of custom dimensions in asg alarm specification
@ \fI2015\-11\-05 15:00:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
464aa6b062 Merge pull request \fI\%#28602\fP from eyj/fix\-28601
.IP \(bu 2
963ad4250a Allow setting of custom dimensions in asg alarm specification
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28596\fP: (\fI\%rallytime\fP) Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
@ \fI2015\-11\-05 14:25:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
572d95b3e1 Merge pull request \fI\%#28596\fP from rallytime/merge\-2015.8
.IP \(bu 2
eec9d69387 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.INDENT 2.0
.IP \(bu 2
08295de5a5 Merge pull request \fI\%#28563\fP from s0undt3ch/2015.5
.INDENT 2.0
.IP \(bu 2
16f4db79a0 Update to latest bootstrap script v2015.11.04
.UNINDENT
.IP \(bu 2
1e09f186ce Merge pull request \fI\%#28541\fP from twangboy/fix_28173
.INDENT 2.0
.IP \(bu 2
7edf5ce370 Fixed problem with system.set_computer_name
.UNINDENT
.IP \(bu 2
f44ed780b5 Merge pull request \fI\%#28537\fP from jfindlay/decode_state_2015.5
.INDENT 2.0
.IP \(bu 2
06e514940c decode filename to utf\-8 in file.recurse state
.UNINDENT
.IP \(bu 2
6acf87593f Merge pull request \fI\%#28529\fP from rallytime/fix\-28272
.INDENT 2.0
.IP \(bu 2
a959681858 Add link to Sending a GH PR to documentation docs
.IP \(bu 2
1c612e2772 Update contributing and documentation pages to recommend submitting against branches
.UNINDENT
.IP \(bu 2
025bff2bf0 Merge pull request \fI\%#28548\fP from nmadhok/2015.5\-task\-error
.INDENT 2.0
.IP \(bu 2
804a0a6537 Tasks can be in queued state instead of running. Fixes \fI\%#28511\fP
.UNINDENT
.IP \(bu 2
63bd3e52b3 Merge pull request \fI\%#28531\fP from rallytime/fix\-24585
.INDENT 2.0
.IP \(bu 2
bc577b2531 Add versionadded directives to virtualenv_mod state/module
.UNINDENT
.IP \(bu 2
ea3bf972c4 Merge pull request \fI\%#28508\fP from twangboy/fix_unit_tests_windows
.INDENT 2.0
.IP \(bu 2
0da6ff7c50 Fixed some logic
.IP \(bu 2
cf1e059be5 Fixed windows tests
.UNINDENT
.IP \(bu 2
73c5735fc1 Merge pull request \fI\%#28525\fP from rallytime/route53_spacing
.INDENT 2.0
.IP \(bu 2
6ab2ce615c Fix spacing in doc examples for boto_route53 state and module
.UNINDENT
.IP \(bu 2
2d7f934f67 Merge pull request \fI\%#28517\fP from rallytime/fix\-28243
.INDENT 2.0
.IP \(bu 2
be8f650901 Punctuation.
.IP \(bu 2
fd846822c1 Add state_auto_order defaults to True note to ordering docs
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28593\fP: (\fI\%blueyed\fP) doc: fix typo with salt.states.file: s/preseve/preserve/
@ \fI2015\-11\-04 22:33:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
73c33e0b4a Merge pull request \fI\%#28593\fP from blueyed/fix\-typo\-preserve
.IP \(bu 2
eaf27d6ee7 doc: fix typo with salt.states.file: s/preseve/preserve/
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28578\fP: (\fI\%twangboy\fP) Fixed the script... something got broke...
@ \fI2015\-11\-04 22:00:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
8b483ee354 Merge pull request \fI\%#28578\fP from twangboy/fix_windows_installer_script
.IP \(bu 2
90b19a3279 Fixed the script... something got broke...
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28579\fP: (\fI\%jfindlay\fP) fix __virtual__ returns: tls,uptime mods
@ \fI2015\-11\-04 22:00:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
7ca7ed4b37 Merge pull request \fI\%#28579\fP from jfindlay/virt_ret
.IP \(bu 2
333c132378 fix __virtual__ returns: tls,uptime mods
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27574\fP: (\fI\%jgill\fP) salt\-cloud: Could not associate elastic ip address <None> with network interface <eni\-xxxxxxxx> (refs: \fI\%#28584\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28584\fP: (\fI\%rallytime\fP) If AssociatePublicIpAddress is set to True, don\(aqt auto\-assign eip.
@ \fI2015\-11\-04 21:59:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25315\fP: (\fI\%ruzarowski\fP) [cloud:EC2] Move handling of AssociatePublicIpAddress to associate_eip/allocate_new_eip logic depending on value type (refs: \fI\%#28584\fP)
.IP \(bu 2
ae764c6b5c Merge pull request \fI\%#28584\fP from rallytime/fix\-27574
.IP \(bu 2
490e1bd5bb If AssociatePublicIpAddress is set to True, don\(aqt auto\-assign eip.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28392\fP: (\fI\%jacksontj\fP) AsyncZeroMQReqChannel does not implement \fItries\fP (2015.8) (refs: \fI\%#28410\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28576\fP: (\fI\%jacksontj\fP) Only encode the zmq message once
@ \fI2015\-11\-04 21:59:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28410\fP: (\fI\%jacksontj\fP) Add retries to the zeromq.AsyncReqMessageClient (refs: \fI\%#28576\fP)
.IP \(bu 2
231cdd4316 Merge pull request \fI\%#28576\fP from jacksontj/transport
.IP \(bu 2
b29fc676a3 Only encode the zmq message once
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28587\fP: (\fI\%cachedout\fP) Reset yaml rendering hooks to avoid leaks (refs: \fI\%#28613\fP)
@ \fI2015\-11\-04 21:37:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab62f5cd12 Merge pull request \fI\%#28587\fP from cachedout/fix_yaml_render_leak
.IP \(bu 2
2da64bd736 Reset yaml rendering hooks to avoid leaks
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#3436\fP: (\fI\%madduck\fP) Pillar does not handle Unicode data (refs: \fI\%#28134\fP, #saltstack/salt\(ga#28134\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#28134\fP: (\fI\%bernieke\fP) fix unicode pillar values \fI\%#3436\fP (refs: \fI\%#28581\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28581\fP: (\fI\%basepi\fP) Revert b4875e585a165482c4c1ddc8987d76b0a71ef1b0
@ \fI2015\-11\-04 19:28:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
69081d00e0 Merge pull request \fI\%#28581\fP from saltstack/revert\-28134\-2015.8
.IP \(bu 2
0a07c90d5e Revert b4875e585a165482c4c1ddc8987d76b0a71ef1b0
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28477\fP: (\fI\%anlutro\fP) KeyError with file.managed HTTPS source (refs: \fI\%#28573\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28573\fP: (\fI\%jacksontj\fP) Add \fIbody\fP to salt.utils.http.query returns
@ \fI2015\-11\-04 17:18:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea3658eac8 Merge pull request \fI\%#28573\fP from jacksontj/2015.8
.IP \(bu 2
d55ea7550b Add \fIbody\fP to salt.utils.http.query returns
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#655\fP: (\fI\%thatch45\fP) Add general command management to service (refs: #\(gasaltstack/salt\-bootstrap#656\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#674\fP: (\fI\%jfindlay\fP) add support for repo.saltstack.com (refs: \fI\%#28564\fP, \fI\%#28563\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#665\fP: (\fI\%mbologna\fP) Change to \(aqdnf\(aq as package manager for Fedora 22\-> (refs: \fI\%#28564\fP, \fI\%#28563\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#656\fP: (\fI\%eyj\fP) Add bootstrap \-b flag (don\(aqt install dependencies) (refs: \fI\%#28564\fP, \fI\%#28563\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#654\fP: (\fI\%hedinfaok\fP) Fixes error finding python\-jinja2 in RHEL 7 (refs: \fI\%#28564\fP, \fI\%#28563\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#653\fP: (\fI\%cbuechler\fP) Make bootstrap work with FreeBSD 11\-CURRENT. (refs: \fI\%#28564\fP, \fI\%#28563\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28564\fP: (\fI\%s0undt3ch\fP) [2015.8] Update to latest bootstrap script v2015.11.04
@ \fI2015\-11\-04 15:29:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a729c2b40 Merge pull request \fI\%#28564\fP from s0undt3ch/2015.8
.IP \(bu 2
b6a53a6bfb Update to latest bootstrap script v2015.11.04
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28527\fP: (\fI\%Oro\fP) boto_rds.create needs storage_type, which does not exist in boto.rds2 create_db_instance (refs: \fI\%#28561\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28561\fP: (\fI\%Oro\fP) Issue \fI\%#28527\fP boto_rds.create does not work (refs: \fI\%#28612\fP)
@ \fI2015\-11\-04 15:13:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
fed4c6f482 Merge pull request \fI\%#28561\fP from Oro/fix\-boto\-rds\-create
.IP \(bu 2
54782b6fd9 Removed exception message where there is no exception
.IP \(bu 2
e08f45c824 Issue \fI\%#28527\fP boto_rds.create does not work
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28560\fP: (\fI\%bdrung\fP) Fix various typos
@ \fI2015\-11\-04 15:06:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec924e8410 Merge pull request \fI\%#28560\fP from bdrung/2015.8
.IP \(bu 2
89dcb66310 Fix \(dqallow one to do\(dq phrase
.IP \(bu 2
859b6b46a6 Fix typo of nonexistent
.IP \(bu 2
66921cc61e Fix typo of successfully
.IP \(bu 2
c1e3ef7c8d Fix typo of explicitly
.IP \(bu 2
029a95398c Fix typo of superfluous
.IP \(bu 2
026c215933 Fix typo of unnecessary
.IP \(bu 2
5f7fc5f94b Fix typo of editable
.IP \(bu 2
0b768944c2 Fix typo of daemon
.IP \(bu 2
5af49881d7 Fix typo of completely
.IP \(bu 2
14d2a16f74 Fix typos of compatibility
.IP \(bu 2
46a5a9b073 Fix typo of supported
.IP \(bu 2
abc490a78e Fix typo of useful
.IP \(bu 2
ddd412180c Fix typo of targeting
.IP \(bu 2
610a6a77ae Fix typo of version
.IP \(bu 2
e0a5d46a1e Fix typo of separated
.IP \(bu 2
7f11cfd5e1 Fix typo of helpful
.IP \(bu 2
2e9b520d84 Fix typos of omitted
.IP \(bu 2
3029f64481 Fix typo of compatibility
.IP \(bu 2
470e82f17f Fix typo of dictionary
.IP \(bu 2
5843c7aa24 Fix typo of optional
.IP \(bu 2
730d0f95e7 Fix typo of transferred
.IP \(bu 2
c7e7884de2 Fix typo of received
.IP \(bu 2
50eea287f3 Fix typo of management
.IP \(bu 2
cb01da81c6 Fix typos of parameter
.IP \(bu 2
45fcc7d339 Fix typo of don\(aqt
.IP \(bu 2
3624935d32 Fix typo of another
.IP \(bu 2
d16afe2607 Fix typo of software
.IP \(bu 2
b9b7cbe525 Fix typo of software
.IP \(bu 2
8edd2c1add Fix typos of dependency
.IP \(bu 2
3a5e2e3437 Fix typo of documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28528\fP: (\fI\%schlagify\fP) timezone.system error:  CommandExecutionError: Failed to parse timedatectl output, this is likely a bug (refs: \fI\%#28550\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28550\fP: (\fI\%jfindlay\fP) check timedatectl errno and return stdout on failure
@ \fI2015\-11\-04 15:00:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd0b291b63 Merge pull request \fI\%#28550\fP from jfindlay/ctl_err
.IP \(bu 2
11a9a5868f simplify timezone module unit test mocks
.IP \(bu 2
476b651c94 update timezone module unit tests for timedatectl
.IP \(bu 2
5c0e5dacc0 check timedatectl errno and return stdout on failure
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19249\fP: (\fI\%ahetmanski\fP) Cannot create cache_dir salt master exception. (refs: \fI\%#28545\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28545\fP: (\fI\%jfindlay\fP) pass on concurrent create of jid_dir in local_cache
@ \fI2015\-11\-04 14:54:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
e048667c91 Merge pull request \fI\%#28545\fP from jfindlay/concurrent_dir
.IP \(bu 2
58ad699331 pass on concurrent create of cache_dir in roots fs
.IP \(bu 2
e456184b04 pass on concurrent create of jid_dir in local_cache
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28544\fP: (\fI\%rallytime\fP) Start moving some vmware.py cloud funcs to utils/vmware.py
@ \fI2015\-11\-04 14:52:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
082ffd5734 Merge pull request \fI\%#28544\fP from rallytime/vmware\-utils
.IP \(bu 2
403fe37704 Pylint.
.IP \(bu 2
d9301eea95 Don\(aqt move _set_cd_or_dvd_backing_type yet
.IP \(bu 2
8d69639230 Start moving some vmware.py cloud funcs to utils/vmware.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28543\fP: (\fI\%gtmanfred\fP) clean up changes for pkg.uptodate and supervisord.dead
@ \fI2015\-11\-04 14:49:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf4f7cdc4b Merge pull request \fI\%#28543\fP from gtmanfred/2015.8
.IP \(bu 2
3d57b392cb return changes if supervisord stopped process
.IP \(bu 2
5547a34acc return empty changes if server is uptodate
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28524\fP: (\fI\%bmcorser\fP) UnicodeDecodeError in states.file (refs: \fI\%#28537\fP, \fI\%#28538\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28538\fP: (\fI\%jfindlay\fP) decode path and url to utf\-8 in url.create (refs: \fI\%#28537\fP)
@ \fI2015\-11\-04 14:48:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
d345768b81 Merge pull request \fI\%#28538\fP from jfindlay/decode_state
.IP \(bu 2
b05dfc5c58 decode path and url to utf\-8 in url.create
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28476\fP: (\fI\%ColorFuzzy\fP) state.sls UnicodeDecodeError (refs: \fI\%#28533\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28533\fP: (\fI\%jfindlay\fP) decode highstate error messages to utf\-8
@ \fI2015\-11\-04 14:47:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e0c8264db Merge pull request \fI\%#28533\fP from jfindlay/decode_err
.IP \(bu 2
9c9bb75c37 decode highstate error messages to utf\-8
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28547\fP: (\fI\%nmadhok\fP) [Backport] [2015.8] Tasks can be in queued state instead of running
@ \fI2015\-11\-04 04:13:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
cfc3146b2d Merge pull request \fI\%#28547\fP from nmadhok/2015.8\-task\-error
.IP \(bu 2
3fb1f9ee6b Tasks can be in queued state instead of running. Fixes \fI\%#28511\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28535\fP: (\fI\%techhat\fP) Fail gracefully if 169.254* isn\(aqt available
@ \fI2015\-11\-03 22:39:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
7e22e7cf24 Merge pull request \fI\%#28535\fP from techhat/fixcreds
.IP \(bu 2
8d9224bd09 Catch timeouts too
.IP \(bu 2
fa46dbb2a3 Lint
.IP \(bu 2
f05a5e0936 Fail gracefully if 169.254* isn\(aqt available
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28536\fP: (\fI\%cro\fP) Default configuration file for proxy minions.
@ \fI2015\-11\-03 21:26:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
9a5208e8aa Merge pull request \fI\%#28536\fP from cro/proxyconf
.IP \(bu 2
1e031c4940 Default configuration file for proxy minions.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28469\fP: (\fI\%mlalpho\fP) state boto_secgroup.present fails to find vpc_name (refs: \fI\%#28710\fP, \fI\%#28534\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28534\fP: (\fI\%rallytime\fP) Add versionadded directive for vpc_name arg in boto_secgroup.present
@ \fI2015\-11\-03 19:30:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
2bc78a32ef Merge pull request \fI\%#28534\fP from rallytime/fix\-28469
.IP \(bu 2
ebe3b34ae7 Add versionadded directive for vpc_name arg in boto_secgroup.present
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28516\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28489\fP to 2015.8
@ \fI2015\-11\-03 14:05:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28489\fP: (\fI\%TheBigBear\fP) Update windows\-package\-manager.rst (minor edit) adding missing single quote pairs. (refs: \fI\%#28516\fP)
.IP \(bu 2
c6a6fe0089 Merge pull request \fI\%#28516\fP from rallytime/bp\-28489
.IP \(bu 2
2e5684a1e4 Update windows\-package\-manager.rst
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28506\fP: (\fI\%basepi\fP) [2015.8] Log minion list for all rosters, at debug level
@ \fI2015\-11\-03 14:05:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
36a217acbd Merge pull request \fI\%#28506\fP from basepi/salt\-ssh.minions.log.debug
.IP \(bu 2
06cdb50494 Log minion list for all rosters, at debug level
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28514\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-11\-03 01:19:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
8cbea63e40 Merge pull request \fI\%#28514\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
463a03b2a9 Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.IP \(bu 2
63ce8f78d5 Merge pull request \fI\%#28512\fP from basepi/merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
61c382133a Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
4bf56cad3f Merge pull request \fI\%#28461\fP from cachedout/issue_28455
.INDENT 2.0
.IP \(bu 2
097838ec0c Wrap all cache calls in state.sls in correct umask
.UNINDENT
.IP \(bu 2
f3e61db045 Merge pull request \fI\%#28407\fP from DSRCompany/issues/24910_token_auth_fix_2014
.INDENT 2.0
.IP \(bu 2
b7b5bec309 Don\(aqt request creds if auth with key.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28502\fP: (\fI\%cachedout\fP) Lint \fI\%#28427\fP
@ \fI2015\-11\-02 21:09:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28427\fP: (\fI\%cro\fP) More updates (refs: \fI\%#28502\fP)
.IP \(bu 2
b919f55f8d Merge pull request \fI\%#28502\fP from cachedout/lint_28427
.IP \(bu 2
459a342102 Lint \fI\%#28427\fP
.IP \(bu 2
d354885c3d Lint
.IP \(bu 2
dbb1f0899e Lint
.IP \(bu 2
749383c413 Lint
.IP \(bu 2
0fa067ea30 Add datacenter getter/setter, change \(aqdell_switch\(aq to just \(aqswitch\(aq, trap call to change_password.
.IP \(bu 2
4bcb5a508b Add datacenter getter/setter, change \(aqdell_switch\(aq to just \(aqswitch\(aq, trap call to change_password.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28464\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-11\-02 20:18:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
238411c8ce Merge pull request \fI\%#28464\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
6f6e687cb4 Mock master_uri for even tests
.IP \(bu 2
3286a5250f Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
37ceae1e88 Merge pull request \fI\%#28448\fP from gwaters/add\-redhat\-notes
.INDENT 2.0
.IP \(bu 2
e70990704a added a note to the tutorial for those that redhat so they can use the state file too.
.UNINDENT
.IP \(bu 2
5ef50d60cd Merge pull request \fI\%#28406\fP from rallytime/bp\-28381
.INDENT 2.0
.IP \(bu 2
e5322d2c44 Add FreeBSD detection for VirtualBox
.UNINDENT
.IP \(bu 2
30d5f7bbae Merge pull request \fI\%#28413\fP from rallytime/bp\-28400
.INDENT 2.0
.IP \(bu 2
ae1921b922 Do not execute _preflight_check if not_installed list is empty in _find_install_targets. Calling with empty list on rhel/centos cause execution of repoquery \-\-whatprovides without pkg list which is memory consumptive task for host and also for red hat satellite server.
.UNINDENT
.IP \(bu 2
045d540aff Merge pull request \fI\%#28366\fP from erchn/fix_yumpkg_mod_repo_disabled
.INDENT 2.0
.IP \(bu 2
8187a4ce20 re\-arrange things a bit to have less overall changes
.IP \(bu 2
f1d570ff18 move todelete above disabled check, add comment
.IP \(bu 2
64feec413f also remove disabled key from repo_opts
.IP \(bu 2
2f2ebb7bb6 mark repo not enabled when pkgrepo state passes in disable: True
.UNINDENT
.IP \(bu 2
3923f4a569 Merge pull request \fI\%#28373\fP from beverlcl/fix\-use_carrier\-28372
.INDENT 2.0
.IP \(bu 2
32cffeceb6 Fixing bug \fI\%#28372\fP for use_carrier option on bonding network interfaces.
.UNINDENT
.IP \(bu 2
e07e3f257b Merge pull request \fI\%#28359\fP from rallytime/bp\-28358
.INDENT 2.0
.IP \(bu 2
9cacbf582b docstring typo fix \- list returners not runners
.UNINDENT
.IP \(bu 2
282be7ba5a Merge pull request \fI\%#28346\fP from twangboy/fix_installer
.INDENT 2.0
.IP \(bu 2
f65e3e5275 Updated documentation to reflect the new parameter
.IP \(bu 2
a0c5223554 Fixes \fI\%#27923\fP and \fI\%#28000\fP
.UNINDENT
.IP \(bu 2
7858f04ebc Merge pull request \fI\%#28315\fP from gwaters/update\-pillar\-doc
.INDENT 2.0
.IP \(bu 2
b15285c0b4 adding a working example of setting pillar data on the cli
.UNINDENT
.IP \(bu 2
45305ccf29 Merge pull request \fI\%#28211\fP from terminalmage/legacy_git_pillar\-2015.5
.INDENT 2.0
.IP \(bu 2
0d6a4ac115 Remove non\-functional test
.IP \(bu 2
ab991d61d9 Fix for ext_pillar being compiled twice in legacy git_pillar code (2015.5 branch)
.UNINDENT
.IP \(bu 2
a6cc84c407 Merge pull request \fI\%#28263\fP from cachedout/issue_26411\-1
.INDENT 2.0
.IP \(bu 2
3b880a5f07 New channel for event.fire_master
.IP \(bu 2
29e9533aab Stand up a new channel if using salt\-call
.UNINDENT
.IP \(bu 2
788e1463d8 Merge pull request \fI\%#28293\fP from cachedout/fix_28271
.INDENT 2.0
.IP \(bu 2
499ed8519b Minor grammar changes to \fI\%#28271\fP
.UNINDENT
.IP \(bu 2
e178af0b90 Merge pull request \fI\%#28271\fP from gwaters/update\-tutorial\-documentation
.INDENT 2.0
.IP \(bu 2
f96d39483d updated the tutorial with gravyboat\(aqs suggestions
.IP \(bu 2
b1f4a2bdf4 i think i changed the wrong header, updated to fix
.IP \(bu 2
846b3aece1 I found you can not run the cp.push commands until after enabling the feature in the conf, so I wanted to update the docs so others who try these commands won\(aqt bump into the same issue I had.
.UNINDENT
.IP \(bu 2
e3eff9b909 Merge pull request \fI\%#28280\fP from 0xf10e/patch\-1
.INDENT 2.0
.IP \(bu 2
6d4316b0ac Correct Jinja function load_* to import_*
.UNINDENT
.IP \(bu 2
909fa3dc97 Merge pull request \fI\%#28255\fP from cachedout/cli_opt
.INDENT 2.0
.IP \(bu 2
a2408157de Add __cli opt
.UNINDENT
.IP \(bu 2
0fa094ae11 Merge pull request \fI\%#28213\fP from rallytime/boto_route53_state
.INDENT 2.0
.IP \(bu 2
237d64ff11 If record returned None, don\(aqt continue with the state. Something went wrong.
.UNINDENT
.IP \(bu 2
1768014705 Merge pull request \fI\%#28238\fP from basepi/fix.schedule.present.28217
.INDENT 2.0
.IP \(bu 2
087a8dc3c2 Only insert enabled if it\(aqs a dict
.IP \(bu 2
5b49f41fab Fix schedule comparison to adjust for \(aqenabled\(aq being added in schedule.list
.IP \(bu 2
2dc1226ab8 Build new item with \(aqenabled\(aq if available
.UNINDENT
.IP \(bu 2
bdd48c92de Merge pull request \fI\%#28174\fP from lorengordon/file\-replace\-multiline
.INDENT 2.0
.IP \(bu 2
acdef2da60 Update docstrings with new guidance
.IP \(bu 2
0835b005b7 Use a test that makes the extra file read unnecessary
.IP \(bu 2
6d6121a6e5 Use \fIflags\fP when checking whether content was added previously
.IP \(bu 2
b25e609e9e Set \fIflags=8\fP since now the file is read as a MULTILINE string by default
.IP \(bu 2
89e8dcdffd Use \fIfinally\fP block to ensure mmap object is closed
.IP \(bu 2
5aea6647c9 Add support for multiline regex in file.replace
.UNINDENT
.IP \(bu 2
2225925fb5 Merge pull request \fI\%#28175\fP from twangboy/fix_19673
.INDENT 2.0
.IP \(bu 2
ae8fbb208f Fixes \fI\%#19673\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#15583\fP: (\fI\%dr4Ke\fP) state grain.present should accept dict values (isn\(aqt it?) (refs: \fI\%#26945\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#11870\fP: (\fI\%gpkvt\fP) Nested Grain\-Support for grains.present / grains.absent (refs: \fI\%#26945\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28486\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26945\fP to 2015.8
@ \fI2015\-11\-02 18:43:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26945\fP: (\fI\%dr4Ke\fP) Feature state grains support nested and dict (refs: \fI\%#28486\fP)
.IP \(bu 2
a25ce38fda Merge pull request \fI\%#28486\fP from rallytime/bp\-26945
.IP \(bu 2
8d26bbd777 grains module and state: documentation fixes
.IP \(bu 2
df7e936910 grains module and state: use a unique object...
.IP \(bu 2
df8ec1184c grains module documentation fixes
.IP \(bu 2
25e9a5c9ad grains state and module: fix version strings
.IP \(bu 2
eee2318873 grains state: allow deleting grain with \(aqFalse\(aq value
.IP \(bu 2
c92326f5ea grains module: yaml representer for OrderedDict
.IP \(bu 2
2c9c8d4073 grains state doc update
.IP \(bu 2
576252da05 grains state: list_present, list_absent support nested grain
.IP \(bu 2
62a1f37d86 grains state: nested support for grains.append
.IP \(bu 2
3019a055c9 grains state: rewrite doc + example
.IP \(bu 2
c19cff517a grains state: more tests
.IP \(bu 2
cc844e4a2c grains state tests: test the grain file content as well
.IP \(bu 2
1c5cd4c82d grains state: changes comment more accurate
.IP \(bu 2
563fd2b56c grains state: use DEFAULT_TARGET_DELIM
.IP \(bu 2
c63913e602 grains module: simpler comment for already set key
.IP \(bu 2
2000180791 grains.present uses grains.set
.IP \(bu 2
a03c79b13b module grains.set default comment is a string
.IP \(bu 2
64e9e2c3b3 grains.absent uses set(None)
.IP \(bu 2
6b8c245b87 grains state: new tests for nested grains
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28472\fP: (\fI\%gtmanfred\fP) overwrite more than one value with names
@ \fI2015\-11\-02 17:56:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
f3640b3ad6 Merge pull request \fI\%#28472\fP from gtmanfred/2015.8
.IP \(bu 2
8b90ccedf5 overwrite more than one value with names
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28493\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28492\fP to 2015.8
@ \fI2015\-11\-02 17:54:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28492\fP: (\fI\%cedwards\fP) Updated FreeBSD installation docs (refs: \fI\%#28493\fP)
.IP \(bu 2
e31ef51053 Merge pull request \fI\%#28493\fP from rallytime/bp\-28492
.IP \(bu 2
ffc77259c9 Updated FreeBSD installation docs:
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28494\fP: (\fI\%whiteinge\fP) Fix filter_by passing incorrect parameters to match functions
@ \fI2015\-11\-02 17:53:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
38c77206db Merge pull request \fI\%#28494\fP from whiteinge/match\-filter_by\-argfix
.IP \(bu 2
e61ac75d6f Fix filter_by passing incorrect parameters to match functions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23685\fP: (\fI\%Snergster\fP) inotify beacon on file. \(aqchange\(aq event to reactor to reset file to known state will cause loop (refs: \fI\%#28388\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28491\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28388\fP to 2015.8
@ \fI2015\-11\-02 17:13:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28388\fP: (\fI\%cachedout\fP) Beacon state disable (refs: \fI\%#28491\fP)
.IP \(bu 2
d19affd44d Merge pull request \fI\%#28491\fP from rallytime/bp\-28388
.IP \(bu 2
f740a19477 Working right now
.IP \(bu 2
700eaebad0 Disable starting to come to life
.IP \(bu 2
f8b17748ef More fixing
.IP \(bu 2
04585a2878 Documentation for disable_during_state_run
.IP \(bu 2
dbbd53689d Add documentation note in inotify beacon
.IP \(bu 2
40217fe813 More refactoring and add new option to disable during state run
.IP \(bu 2
19af5e5ed3 Starting on refactor of beacon config parsing
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#12363\fP: (\fI\%joehealy\fP) unable to manage password expiry of windows users (refs: \fI\%#28465\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28465\fP: (\fI\%twangboy\fP) Fix \fI\%#12363\fP: Password Expiration in Windows
@ \fI2015\-11\-02 17:01:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
f7042ba967 Merge pull request \fI\%#28465\fP from twangboy/fix_12363
.IP \(bu 2
bcf7d58dbb Fixed array if there\(aqs a problem with user.info
.IP \(bu 2
4b36cb8b6e Added documentation to win_shadow
.IP \(bu 2
fc8f197f69 Fix \fI\%#12363\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28484\fP: (\fI\%nasenbaer13\fP) Elasticcache subnet group creation raises TypeError (refs: \fI\%#28485\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28485\fP: (\fI\%nasenbaer13\fP) Fix invalid usage of _get_conn causing \fI\%#28484\fP
@ \fI2015\-11\-02 16:47:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec0cbec00b Merge pull request \fI\%#28485\fP from eyj/fix_28484
.IP \(bu 2
9d80fb6070 Fix invalid usage of _get_conn causing \fI\%#28484\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28453\fP: (\fI\%sdm24\fP) Fix Formatting for Nodegroup Targetting Docs (refs: \fI\%#28454\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#28268\fP: (\fI\%gravyboat\fP) Update nodegroup docs to explain how to target via nodegroups (refs: \fI\%#28306\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28454\fP: (\fI\%sdm24\fP) Fixed nodegroup doc formatting to correctly link to pillar_opts in the master config
@ \fI2015\-11\-02 15:14:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28306\fP: (\fI\%sdm24\fP) Updated the Nodegroup docs to include how to target nodegroups in SLS Jinja (refs: \fI\%#28454\fP)
.IP \(bu 2
1116798f21 Merge pull request \fI\%#28454\fP from sdm24/fix\-formatting\-in\-nodegroup\-docs
.IP \(bu 2
b968581eb1 Fixed nodegroup doc formatting to correctly link to pillar_opts in the master config
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28487\fP: (\fI\%cachedout\fP) Lint 28456
@ \fI2015\-11\-02 14:52:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
fac7803a59 Merge pull request \fI\%#28487\fP from cachedout/lint_28456
.IP \(bu 2
58fe15437a Lint \fI\%#28456\fP
.IP \(bu 2
322a28bb06 updated states.virtualenv_mod comments to reflect that some kwargs need \(aqdistribute: True\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24775\fP: (\fI\%ymote\fP) jinja returned host ip address with square bracket (refs: \fI\%#28457\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28457\fP: (\fI\%sdm24\fP) Clarified comments for grains/core.py for ip_interfaces, ip4_interfac…
@ \fI2015\-11\-02 14:47:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
22a4f14625 Merge pull request \fI\%#28457\fP from sdm24/update\-grain\-ip\-interfaces\-comments
.IP \(bu 2
eb92afe238 Clarified comments for grains/core.py for ip_interfaces, ip4_interfaces, and ip6_interfaces, to explicitly state that the ips for each interface are passed as a list
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28473\fP: (\fI\%anlutro\fP) Show check_cmd output on failure
@ \fI2015\-11\-02 14:15:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
5818b28c85 Merge pull request \fI\%#28473\fP from alprs/feature\-cmd_check_output
.IP \(bu 2
a772ce330a fix tests
.IP \(bu 2
90b01e9e0d show check_cmd output on failure
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28460\fP: (\fI\%justinta\fP) Skipped wipefs test if wipefs does not exist on OS
@ \fI2015\-10\-31 04:09:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
cfe39df7ac Merge pull request \fI\%#28460\fP from jtand/wipe_fs_fix
.IP \(bu 2
7ca79f1f7b Skipped wipefs test if wipefs does not exist on OS
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28426\fP: (\fI\%terminalmage\fP) pkgbuild.built: make template engine optional
@ \fI2015\-10\-30 17:13:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
9b44b5e347 Merge pull request \fI\%#28426\fP from terminalmage/pkgbuild\-template
.IP \(bu 2
6d32497848 pkgbuild.built: make template engine optional
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28123\fP: (\fI\%hrumph\fP) local.cmd not working for windows minions (refs: \fI\%#28422\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28422\fP: (\fI\%cachedout\fP) Handle windows logging on thread_multi [WIP]
@ \fI2015\-10\-30 17:12:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
31777cb4e9 Merge pull request \fI\%#28422\fP from cachedout/issue_28123
.IP \(bu 2
fd3b2a9e20 Handle windows logging on thread_multi
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#13513\fP: (\fI\%ironwilliamcash\fP) Windows Registry Key Problem on 64bit Machine (refs: \fI\%#28425\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28425\fP: (\fI\%twangboy\fP) Fix \fI\%#13513\fP \- Reflection
@ \fI2015\-10\-30 17:07:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
f9992fc948 Merge pull request \fI\%#28425\fP from twangboy/fix_13513
.IP \(bu 2
beb141df69 Fixed some lint
.IP \(bu 2
0d747355c4 Fix \fI\%#13513\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27980\fP: (\fI\%rayba\fP) salt\-cloud 2015.5.0 azure provider could not be loaded (refs: \fI\%#28417\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28417\fP: (\fI\%rallytime\fP) Add note about azure sdk version to getting started docs
@ \fI2015\-10\-29 19:47:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
4c8cd064a4 Merge pull request \fI\%#28417\fP from rallytime/azure\-version\-warning
.IP \(bu 2
8e3a2ba7e7 Add note about azure sdk version to getting started docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28392\fP: (\fI\%jacksontj\fP) AsyncZeroMQReqChannel does not implement \fItries\fP (2015.8) (refs: \fI\%#28410\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28410\fP: (\fI\%jacksontj\fP) Add retries to the zeromq.AsyncReqMessageClient (refs: \fI\%#28576\fP)
@ \fI2015\-10\-29 18:05:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
7ead823731 Merge pull request \fI\%#28410\fP from jacksontj/2015.8
.IP \(bu 2
70b5ae9b1d Add retries to the zeromq.AsyncReqMessageClient
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28382\fP: (\fI\%cedwards\fP) [FreeBSD] user state option \fIempty_password: True\fP fails with Traceback (refs: \fI\%#28395\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28404\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28395\fP to 2015.8
@ \fI2015\-10\-29 16:09:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28395\fP: (\fI\%cedwards\fP) Updating bsd_shadow to match mainline shadow (refs: \fI\%#28404\fP)
.IP \(bu 2
50845a1e91 Merge pull request \fI\%#28404\fP from rallytime/bp\-28395
.IP \(bu 2
badcb677e9 Use correct version release number
.IP \(bu 2
c5c66b8bab Updating bsd_shadow to match mainline shadow
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28405\fP: (\fI\%opdude\fP) Detect legacy versions of chocolatey correctly
@ \fI2015\-10\-29 15:57:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
e746b564b4 Merge pull request \fI\%#28405\fP from Unity\-Technologies/hotfix/choco\-version\-detect
.IP \(bu 2
0076d73872 Make sure we exit out correctly when checking for choco version
.IP \(bu 2
157e0f446d Detect legacy versions of chocolatey correctly
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28187\fP: (\fI\%sjansen\fP) fix at.present (refs: \fI\%#28759\fP)
@ \fI2015\-10\-29 15:49:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
4304001a8f Merge pull request \fI\%#28187\fP from sjansen/patch\-1
.IP \(bu 2
52c915e29d fix at.present
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28375\fP: (\fI\%merll\fP) Merge pillar includes correctly
@ \fI2015\-10\-29 15:12:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
5efac26c10 Merge pull request \fI\%#28375\fP from Precis/fix\-pillar\-include\-loop
.IP \(bu 2
f8e2c26473 Variable err is from previous loop, too.
.IP \(bu 2
042314246f Unit test for merging included pillars.
.IP \(bu 2
a42c51f9bf Do not merge previous values in pillar include loop.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28376\fP: (\fI\%ryan\-lane\fP) Support update of route53 records with multiple values
@ \fI2015\-10\-29 14:54:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28374\fP: (\fI\%ryan\-lane\fP) Support update of route53 records with multiple values (refs: \fI\%#28376\fP)
.IP \(bu 2
a69b124aaa Merge pull request \fI\%#28376\fP from lyft/multivalue\-route53\-values\-2015.8
.IP \(bu 2
cd221515a1 Support update of route53 records with multiple values
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28377\fP: (\fI\%terminalmage\fP) Deprecate \(aqalways\(aq in favor of \(aqforce\(aq in pkgbuild.built
@ \fI2015\-10\-29 14:42:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
9e5a510e73 Merge pull request \fI\%#28377\fP from terminalmage/force\-pkgbuild
.IP \(bu 2
f18305e19e Add versionadded directive
.IP \(bu 2
7046d0d896 Deprecate \(aqalways\(aq in favor of \(aqforce\(aq in pkgbuild.built
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28380\fP: (\fI\%cro\fP) Add missing call for service provider
@ \fI2015\-10\-29 14:26:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
cd632f798d Merge pull request \fI\%#28380\fP from cro/sshprox_fix
.IP \(bu 2
7bcc275dce Lint + logic error.
.IP \(bu 2
92d712a54b Add a missing call for the service provider
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28202\fP: (\fI\%guettli\fP) Docs: Difference between modules.cron.rm_job and modules.cron.rm (refs: \fI\%#28348\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28348\fP: (\fI\%jfindlay\fP) salt.utils.alias informs user they are using a renamed function
@ \fI2015\-10\-28 20:46:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
e7571e6d61 Merge pull request \fI\%#28348\fP from jfindlay/alias
.IP \(bu 2
7915d7e5e8 use alias util to formally alias module functions
.IP \(bu 2
6a8b61bd12 create function alias to improve api documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28364\fP: (\fI\%justinta\fP) In CentOS 5 the .split() causes a stacktrace.
@ \fI2015\-10\-28 20:46:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
072eb98a26 Merge pull request \fI\%#28364\fP from jtand/blockdev_test_fix
.IP \(bu 2
3b4d03ff1a In CentOS 5 the .split() causes a stacktrace. Confirmed.split() appears to be unneeded in other OSs.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26415\fP: (\fI\%CaesarC\fP) salt.wheel.WheelClient doesn\(aqt work follow the python api(AttributeError: \(aqNoneType\(aq object has no attribute \(aqget\(aq) (refs: \fI\%#28087\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28361\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28087\fP to 2015.8
@ \fI2015\-10\-28 20:44:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28087\fP: (\fI\%DmitryKuzmenko\fP) Revert \(dqUpdate __init__.py\(dq (refs: \fI\%#28361\fP)
.IP \(bu 2
06b928cfdb Merge pull request \fI\%#28361\fP from rallytime/bp\-28087
.IP \(bu 2
41536e55b9 Revert \(dqUpdate __init__.py\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28360\fP: (\fI\%multani\fP) Various documentation fixes
@ \fI2015\-10\-28 20:43:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
d9e5fba9b5 Merge pull request \fI\%#28360\fP from multani/fix/docs
.IP \(bu 2
ed4a54f839 doc: fix warnings in clouds.linode
.IP \(bu 2
5a9c4c2d60 doc: simplified states.postgres_tablespace introduction
.IP \(bu 2
cf38ff1384 doc: fix rendering of titles in the /ref/states/all/ index page
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28370\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28276\fP to 2015.8
@ \fI2015\-10\-28 20:37:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28276\fP: (\fI\%plastikos\fP) Correct state pkg.updtodate to succeed when packages are up\-to\-date (refs: \fI\%#28370\fP)
.IP \(bu 2
4157c8331b Merge pull request \fI\%#28370\fP from rallytime/bp\-28276
.IP \(bu 2
227ddbcb24 Simplify setting success when there are no pkg updates.
.IP \(bu 2
cd58165138 Correct state pkg.updtodate to succeed when packages are up\-to\-date
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27890\fP: (\fI\%dkiser\fP) pillar recurse list strategy (refs: \fI\%#27891\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#25954\fP: (\fI\%tbaker57\fP) [2015.8.0rc2] pillar merge strategy default behaviour change (refs: \fI\%#28353\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28353\fP: (\fI\%merll\fP) Consider each pillar match only once.
@ \fI2015\-10\-28 15:05:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27891\fP: (\fI\%dkiser\fP) introduce recurse_list pillar_source_merging_strategy (refs: \fI\%#28353\fP, \fI\%#28013\fP)
.IP \(bu 2
3942b4d0e6 Merge pull request \fI\%#28353\fP from Precis/fix\-pillar\-sls\-matches
.IP \(bu 2
2f3f2d6f29 Consider each pillar match only once.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28334\fP: (\fI\%anlutro\fP) iptables needs \-m comment for \-\-comment to work
@ \fI2015\-10\-28 14:24:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d8bea6c43 Merge pull request \fI\%#28334\fP from alprs/fix\-iptables_comment
.IP \(bu 2
170ea7c50d iptables needs \-m comment for \-\-comment to work
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27789\fP: (\fI\%eduherraiz\fP) UnicodeDecodeError: \(aqascii\(aq codec can\(aqt decode byte in 2015.8.0 (refs: \fI\%#28340\fP, \fI\%#27833\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28340\fP: (\fI\%jfindlay\fP) sdecode file and dir lists in fileclient
@ \fI2015\-10\-28 14:23:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
7000b6ee8f Merge pull request \fI\%#28340\fP from jfindlay/decode_client
.IP \(bu 2
bd9151b5e3 sdecode file and dir lists in fileclient
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28344\fP: (\fI\%ryan\-lane\fP) Fix iptables state for non\-filter tables
@ \fI2015\-10\-28 14:21:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
48448c9a48 Merge pull request \fI\%#28344\fP from lyft/fix\-iptables\-non\-filter
.IP \(bu 2
21ba070b3d Fix iptables state for non\-filter tables
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28343\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28342\fP to 2015.8
@ \fI2015\-10\-28 13:58:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28342\fP: (\fI\%gravyboat\fP) Fix up a dup doc entry for the file state. (refs: \fI\%#28343\fP)
.IP \(bu 2
72f0c106cf Merge pull request \fI\%#28343\fP from rallytime/bp\-28342
.IP \(bu 2
03d15dd090 Fix up a dup doc entry.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28330\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28305\fP to 2015.8
@ \fI2015\-10\-27 17:20:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28305\fP: (\fI\%rowillia\fP) Fix Cabal states. (refs: \fI\%#28330\fP)
.IP \(bu 2
64d5c2362a Merge pull request \fI\%#28330\fP from rallytime/bp\-28305
.IP \(bu 2
a46dbcb62b Fix Cabal states.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21216\fP: (\fI\%syphernl\fP) State rabbitmq_plugin missing proper error handling (refs: \fI\%#28270\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28270\fP: (\fI\%rallytime\fP) Refactor RabbitMQ Plugin State to correctly use test=true and format errors
@ \fI2015\-10\-27 17:18:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
a44c8d8dab Merge pull request \fI\%#28270\fP from rallytime/refactor_rabbitmq_plugin_state
.IP \(bu 2
9e40c3a6a6 Fine tuning and fix tests
.IP \(bu 2
d50916ccdd Pylint fix
.IP \(bu 2
196b18146d Refactor RabbitMQ Plugin State to correctly use test=true and format errors
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25363\fP: (\fI\%syphernl\fP) rabbitmq_{user|vhost}.present in test=True reports unnecessary changes (refs: \fI\%#28269\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24856\fP: (\fI\%pruiz\fP) rabbitmq_user state incorrectly reports result=True when using test=true (refs: \fI\%#28269\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28269\fP: (\fI\%rallytime\fP) Refactor rabbitmq_user state to use test=True correctly (refs: \fI\%#28782\fP, \fI\%#28772\fP)
@ \fI2015\-10\-27 17:17:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
4efd07eba5 Merge pull request \fI\%#28269\fP from rallytime/refactor_rabbitmq_user_state
.IP \(bu 2
aebbcb88ea Pylint fix
.IP \(bu 2
19b8b868a3 Clean\-up/fixes to rabbitmq_user state and test adjustments
.IP \(bu 2
3e0e8fc8c6 Refactor rabbitmq_user state to use test=True correctly
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27855\fP: (\fI\%dverbeek84\fP) boto_vpc is not reading availability_zone (refs: \fI\%#28299\fP, \fI\%#28168\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28299\fP: (\fI\%rallytime\fP) Add test for availability_zone check to boto_vpc_tests
@ \fI2015\-10\-27 14:17:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28168\fP: (\fI\%rallytime\fP) Make sure availability zone gets passed in boto_vpc module when creating subnet (refs: \fI\%#28299\fP)
.IP \(bu 2
93a930615e Merge pull request \fI\%#28299\fP from rallytime/tests\-for\-28168
.IP \(bu 2
65fdb50246 Get the list indice to compart before looking at keys
.IP \(bu 2
95defb87c5 Add test for availability_zone check to boto_vpc_tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28268\fP: (\fI\%gravyboat\fP) Update nodegroup docs to explain how to target via nodegroups (refs: \fI\%#28306\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28306\fP: (\fI\%sdm24\fP) Updated the Nodegroup docs to include how to target nodegroups in SLS Jinja (refs: \fI\%#28454\fP)
@ \fI2015\-10\-27 14:07:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
0ab7c0053d Merge pull request \fI\%#28306\fP from sdm24/update\-nodegroup\-docs\-with\-state\-targeting
.IP \(bu 2
02cac9d8c0 Update nodegroups.rst
.IP \(bu 2
b2c3307c2e Update nodegroups.rst
.IP \(bu 2
e79a930f57 updated nodegroups.rst
.IP \(bu 2
f2a6bc94df Updated the Nodegroup docs to include how to target nodegroups in SLS Jinja
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27435\fP: (\fI\%LukeCarrier\fP) firewalld state: firewalld.prepare calls new_service, not add_service (refs: \fI\%#28308\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28308\fP: (\fI\%rallytime\fP) Firewalld state services should use \-\-add\-service, not \-\-new\-service
@ \fI2015\-10\-27 14:02:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
bba26ffeca Merge pull request \fI\%#28308\fP from rallytime/fix\-27435
.IP \(bu 2
d37298f973 Don\(aqt forget to pass the zone!
.IP \(bu 2
fcafe6f355 Firewalld state services should use \-\-add\-service, not \-\-new\-service
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21744\fP: (\fI\%rallytime\fP) [2015.5] Multi\-Master Minions Block on Authentication (refs: \fI\%#28302\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28302\fP: (\fI\%DmitryKuzmenko\fP) Always close socket even if there is no stream.
@ \fI2015\-10\-27 01:08:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
044737ba6e Merge pull request \fI\%#28302\fP from DSRCompany/issues/21744_fix_context_term
.IP \(bu 2
b0fc66fa68 Always close socket even if there is no stream.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28282\fP: (\fI\%keesbos\fP) Fix for __env__ in legacy git_pillar
@ \fI2015\-10\-26 21:20:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
2f2f51906d Merge pull request \fI\%#28282\fP from keesbos/git\-pillar\-env\-fix
.IP \(bu 2
d46e09afc6 Fix for __env__ in legacy git_pillar
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28258\fP: (\fI\%pass\-by\-value\fP) Add service module for ssh proxy example
@ \fI2015\-10\-26 14:57:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a92bfbd42 Merge pull request \fI\%#28258\fP from pass\-by\-value/ssh_service
.IP \(bu 2
04bc1c64ad Add versionadded information
.IP \(bu 2
76d8d859f1 Add service module for ssh proxy example
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28294\fP: (\fI\%bechtoldt\fP) correct a bad default value in http utility
@ \fI2015\-10\-26 14:45:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25668\fP: (\fI\%techhat\fP) Sanitize sensitive fields in http.query() (refs: \fI\%#28294\fP)
.IP \(bu 2
25778cf1ba Merge pull request \fI\%#28294\fP from bechtoldt/fix_bad_param_default_val
.IP \(bu 2
4852c03d08 don\(aqt iterate over var that is NoneType
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28185\fP: (\fI\%justinta\fP) Added single package return for latest_version, fixed other bug.
@ \fI2015\-10\-26 14:09:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
0245820b73 Merge pull request \fI\%#28185\fP from jtand/zypper_pkg
.IP \(bu 2
457ff5d085 Added back nfo.get lines after finding the problem in them
.IP \(bu 2
5cdb15c9e3 Added single package return for latest_version, fixed other bug.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28297\fP: (\fI\%cachedout\fP) Lint fix proxy junos
@ \fI2015\-10\-26 13:59:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28116\fP: (\fI\%jejenone\fP) converted junos proxy minion to new __proxy__ global (refs: \fI\%#28297\fP)
.IP \(bu 2
443b486c22 Merge pull request \fI\%#28297\fP from cachedout/lint_fix_proxy_junos
.IP \(bu 2
5194d9a2ef Lint
.IP \(bu 2
28eff3caf2 converted junos proxy minion to new __proxy__ global added cli() in junos.py module to execute arbitrary command
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28209\fP: (\fI\%basepi\fP) Legacy git_pillar configs cause duplicate ext_pillar calls (refs: \fI\%#28210\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28210\fP: (\fI\%terminalmage\fP) Fix for ext_pillar being compiled twice in legacy git_pillar code (refs: \fI\%#28211\fP)
@ \fI2015\-10\-26 12:36:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
c8dd79d683 Merge pull request \fI\%#28210\fP from terminalmage/legacy_git_pillar
.IP \(bu 2
86f00e71bf Remove non\-functional test
.IP \(bu 2
b80da6e23a Fix for ext_pillar being compiled twice in legacy git_pillar code
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28203\fP: (\fI\%edhgoose\fP) blockdev.formatted failing on 2nd+ run, despite disk already being formatted  (refs: \fI\%#28265\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28265\fP: (\fI\%jfindlay\fP) fix blockdev execution and state modules
@ \fI2015\-10\-26 12:27:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
62485e567f Merge pull request \fI\%#28265\fP from jfindlay/blockdev
.IP \(bu 2
0dc72135de update blockdev exec and state module unit tests
.IP \(bu 2
07253cb5fb move fstype checks to blockdev execution module
.IP \(bu 2
20ec4a1dc6 move fs create logic from blockdev state to module
.IP \(bu 2
613671a85c safer examples in blockdev exec module docs
.IP \(bu 2
359df1bcf7 refactor dump in blockdev exec module
.IP \(bu 2
88acc9356d check, notify for deps in blockdev exec/state mods
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28266\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28260\fP to 2015.8
@ \fI2015\-10\-26 12:20:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28260\fP: (\fI\%justinta\fP) Ioflo lint (refs: \fI\%#28266\fP)
.IP \(bu 2
556d7d583e Merge pull request \fI\%#28266\fP from rallytime/bp\-28260
.IP \(bu 2
03509e60b2 Removed unnecessary blank line
.IP \(bu 2
2d06c97879 Moved lint disable to end of offending line
.IP \(bu 2
d13fe0cf53 Disabled lint check for ioflo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28253\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28063\fP to 2015.8
@ \fI2015\-10\-23 18:10:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28063\fP: (\fI\%SmithSamuelM\fP) Fixes broken Salt Raet. master.flo file path broken (refs: \fI\%#28253\fP)
.IP \(bu 2
acd2214c9d Merge pull request \fI\%#28253\fP from rallytime/bp\-28063
.IP \(bu 2
db4aa58f7b Changed reference to reflect refactor of ioflo package locations as of ioflo 1.2.3 Deprecated package locations still supported in ioflo for now
.IP \(bu 2
87abf84b54 Changed reference to reflect refactor of ioflo package locations as of ioflo 1.2.3 Deprecated package locations still supported in ioflo for now
.IP \(bu 2
19a81dcb77 Fixed exception in loader when no file extension
.IP \(bu 2
2afbe6803c Raet Salt broken when config moved to package directory The path to the master.flo file no longer worked This fixes
.IP \(bu 2
a177bf8f47 fixed unittests missing close of roadstack caused error on other tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28227\fP: (\fI\%jfindlay\fP) DigitalOcean FreeBSD profile fails with \fIimage: 10.2\fP (refs: \fI\%#28231\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28231\fP: (\fI\%rallytime\fP) Make sure we\(aqre compairing strings when getting images in the DO driver
@ \fI2015\-10\-23 13:49:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
570e7faa3b Merge pull request \fI\%#28231\fP from rallytime/fix\-28227
.IP \(bu 2
0985780f12 Make sure we\(aqre compairing strings when getting images in the DO driver
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28224\fP: (\fI\%techhat\fP) Optimize create_repo for large packages
@ \fI2015\-10\-23 13:40:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
1c55513ce3 Merge pull request \fI\%#28224\fP from techhat/spmoptimize
.IP \(bu 2
faeef55d2f Optimize create_repo for large packages
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27374\fP: (\fI\%mool\fP) boto_route53 state doesn\(aqt create a record (refs: \fI\%#28214\fP, \fI\%#28213\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28214\fP: (\fI\%rallytime\fP) Don\(aqt stacktrace if invalid credentials are passed to boto_route53 state
@ \fI2015\-10\-23 13:37:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28213\fP: (\fI\%rallytime\fP) If record returned None, don\(aqt continue with the state. Something went wrong (refs: \fI\%#28214\fP)
.IP \(bu 2
f269f40905 Merge pull request \fI\%#28214\fP from rallytime/fix_boto_route53_stacktrace
.IP \(bu 2
cdeb8caabe Pylint Fix
.IP \(bu 2
11c475b0ad Don\(aqt stacktrace if invalid credentials are passed to boto_route53 state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28228\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27562\fP to 2015.8
@ \fI2015\-10\-23 13:34:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27562\fP: (\fI\%techhat\fP) Add dependency resolution to SPM (refs: \fI\%#28228\fP)
.IP \(bu 2
0775d159f8 Merge pull request \fI\%#28228\fP from rallytime/bp\-27562
.IP \(bu 2
847809541e Updates as per @s0undt3ch
.IP \(bu 2
cf5fefdf5f Add dependency resolution to SPM
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28230\fP: (\fI\%jfindlay\fP) DigitalOcean FreeBSD fails to bootstrap: \fIPlease use the freebsd@ user to access this droplet.\fP (refs: \fI\%#28232\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28232\fP: (\fI\%rallytime\fP) Add documentation to supply the ssh_username: freebsd config to DO docs
@ \fI2015\-10\-23 13:31:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
af241dc054 Merge pull request \fI\%#28232\fP from rallytime/fix\-28230
.IP \(bu 2
8b06ab4335 Add documentation to supply the ssh_username: freebsd config to DO docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28198\fP: (\fI\%jacobhammons\fP) Added note regarding missing spm exe on Debian/Ubuntu
@ \fI2015\-10\-22 04:40:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
36dc12c62c Merge pull request \fI\%#28198\fP from jacobhammons/docs
.IP \(bu 2
cfadda0c0c Added note regarding missing spm exe on Debian/Ubuntu Minor fixes to spm docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28182\fP: (\fI\%erchn\fP) Some fixes for nova driver for Rackspace
@ \fI2015\-10\-21 21:26:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
fbad88fb99 Merge pull request \fI\%#28182\fP from erchn/fix_nova_rackspace
.IP \(bu 2
7b54f04ba2 wrap server_list[_detailed] in try/except block for TypeError
.IP \(bu 2
b7f8487615 rackconnectv3 default to False, not \(aqFalse\(aq get private_ips in rackconnectv2 environment and populate data object get public_ips and put in data object before returning \(dqresult\(dq structure
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27454\fP: (\fI\%MrFishFinger\fP)  firewalld returns a dictionary rather than a string in the ret[\(aqcomment\(aq] (refs: \fI\%#28181\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28181\fP: (\fI\%rallytime\fP) Revamp firewalld state to be more stateful.
@ \fI2015\-10\-21 21:19:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
a1a924f170 Merge pull request \fI\%#28181\fP from rallytime/fix\-27454
.IP \(bu 2
3e13880af8 Make sure we catch all potential exceptions
.IP \(bu 2
cb4efa87e8 Make sure state returns False when execution module calls fail
.IP \(bu 2
232b2825e4 Revamp firewalld state to be more stateful.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28176\fP: (\fI\%cro\fP) Add ping function
@ \fI2015\-10\-21 20:49:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
d93ad103c7 Merge pull request \fI\%#28176\fP from cro/ssh_no_ping
.IP \(bu 2
3e05437f15 Add ping function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28167\fP: (\fI\%The\-Loeki\fP) file.serialize needs to add a final newline to serialized files
@ \fI2015\-10\-21 17:12:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
8e08f39381 Merge pull request \fI\%#28167\fP from The\-Loeki/patch\-1
.IP \(bu 2
46bf6d4fa3 Update file.serialize test for Python serialized
.IP \(bu 2
66831fd087 file.serialize needs to add a final newline to serialized files
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27855\fP: (\fI\%dverbeek84\fP) boto_vpc is not reading availability_zone (refs: \fI\%#28299\fP, \fI\%#28168\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28168\fP: (\fI\%rallytime\fP) Make sure availability zone gets passed in boto_vpc module when creating subnet (refs: \fI\%#28299\fP)
@ \fI2015\-10\-21 14:48:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
559a517ad6 Merge pull request \fI\%#28168\fP from rallytime/fix\-27855
.IP \(bu 2
50fb77dc50 Make sure availability zone gets passed in boto_vpc module when creating subnet
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26107\fP: (\fI\%thecosmicfrog\fP) Issue targeting nodegroups \- Invalid compound target: ( L@ ... ) (refs: \fI\%#28148\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24660\fP: (\fI\%Mrten\fP) nodegroups not backwards compatible (refs: \fI\%#28148\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28148\fP: (\fI\%basepi\fP) [2015.8] Only expand nodegroups to lists if there is a nested nodegroup
@ \fI2015\-10\-21 13:20:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
dcd90363fe Merge pull request \fI\%#28148\fP from basepi/fix.nodegroup.backwards.compat.24660
.IP \(bu 2
11d6a2b6ac Add some docs
.IP \(bu 2
036d767a98 Keep track of recursive nodegroup_comp calls, keep list format if it\(aqs recursing
.IP \(bu 2
155634a0aa Finish thought
.IP \(bu 2
528b16756b Only expand nodegroups to lists if there is a nested nodegroup
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28155\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-10\-20 23:48:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
053ad408c7 Merge pull request \fI\%#28155\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
c4c889f97b Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.IP \(bu 2
ab18dcf637 Merge pull request \fI\%#28140\fP from rallytime/bsd\-installation\-doc
.INDENT 2.0
.IP \(bu 2
458a544d83 Add OpenBSD installation documentation to 2015.5 branch
.UNINDENT
.IP \(bu 2
fad38eb3c3 Merge pull request \fI\%#28138\fP from rallytime/bp\-28130\-sizes\-only
.INDENT 2.0
.IP \(bu 2
6ab31e1886 Pylint
.IP \(bu 2
37e4ed58a9 Added missing comma
.IP \(bu 2
667f5e669f Added a bunch of instance sizes and updated some outdated ones
.UNINDENT
.IP \(bu 2
ce8f858536 Merge pull request \fI\%#28097\fP from jacksontj/2015.5
.INDENT 2.0
.IP \(bu 2
75e04bcbbc For all multi\-part messages, check the headers. If the header is not your minion_id, skip the message
.UNINDENT
.IP \(bu 2
9cdb970289 Merge pull request \fI\%#28117\fP from rallytime/fix\-23655
.INDENT 2.0
.IP \(bu 2
dfb908e405 Clean up stacktrace when master can\(aqt be reached in lxc cloud driver
.UNINDENT
.IP \(bu 2
bf7ed0a397 Merge pull request \fI\%#28110\fP from terminalmage/masterless\-mode
.INDENT 2.0
.IP \(bu 2
ed90103124 Add explanation of file_client: local setting masterless mode
.UNINDENT
.IP \(bu 2
a569ef4980 Merge pull request \fI\%#28109\fP from rallytime/fix\-27940
.INDENT 2.0
.IP \(bu 2
18b2245611 Add created reactor event to lxc cloud driver
.UNINDENT
.IP \(bu 2
d4604fdb26 Merge pull request \fI\%#27996\fP from rallytime/fix\-21845
.INDENT 2.0
.IP \(bu 2
f8380d751e Provide empty string as default stdout instead of None
.IP \(bu 2
f9406b5828 Don\(aqt fail if pip package is already present and pip1 is installed
.UNINDENT
.IP \(bu 2
28b97c514f Merge pull request \fI\%#28056\fP from rallytime/bp\-28033
.INDENT 2.0
.IP \(bu 2
af2c5ab759 Fixed win_useradd.py
.UNINDENT
.IP \(bu 2
dfc3aaec74 Merge pull request \fI\%#28059\fP from rallytime/bp\-28040
.INDENT 2.0
.IP \(bu 2
76a0d4937b Revert \(dqAllow passing in auth_version, defaulting to 2.\(dq
.IP \(bu 2
63d5675d34 default auth_version = 2
.IP \(bu 2
8072716888 remove extra spaces
.IP \(bu 2
9770f56f04 cleanup whitespace, default to None to be consistent with profile
.IP \(bu 2
f4adfe98c0 Allow passing in auth_version, defaulting to 2.
.IP \(bu 2
fab1ad39af Rackspace support for switft module.
.UNINDENT
.IP \(bu 2
d1fa036b55 Merge pull request \fI\%#28047\fP from cachedout/issue_27534
.INDENT 2.0
.IP \(bu 2
6ea37ddbca Context manager
.IP \(bu 2
4d6f6bb371 Lint
.IP \(bu 2
59018289dc Restore FTP functionality to file client
.UNINDENT
.IP \(bu 2
fd2ca2df1b Merge pull request \fI\%#28032\fP from twangboy/fix_win_path
.INDENT 2.0
.IP \(bu 2
2bcac93314 Fixed win_path.py
.UNINDENT
.IP \(bu 2
88c1770be4 Merge pull request \fI\%#28037\fP from rallytime/bp\-28003
.INDENT 2.0
.IP \(bu 2
4fcf51fb1e Fix PR \fI\%#26336\fP
.UNINDENT
.IP \(bu 2
de727d8bd2 Merge pull request \fI\%#28031\fP from jacobhammons/relnotes6
.INDENT 2.0
.IP \(bu 2
05927bb6f0 Updated release notes with additional CVE information
.UNINDENT
.IP \(bu 2
16c0272849 Merge pull request \fI\%#28008\fP from jfindlay/host_path
.INDENT 2.0
.IP \(bu 2
9f7047dd3c platform independent line endings in hosts mod
.UNINDENT
.IP \(bu 2
d41018fa8e Merge pull request \fI\%#28012\fP from rallytime/fix\-28010
.INDENT 2.0
.IP \(bu 2
0d7059e0c2 Clean up stack trace when something goes wrong with minion output
.UNINDENT
.IP \(bu 2
f728307001 Merge pull request \fI\%#27995\fP from jacobhammons/pillar\-doc
.INDENT 2.0
.IP \(bu 2
2870af2ba3 added link to grains security FAQ to targeting and pillar topics.
.UNINDENT
.IP \(bu 2
efede904a7 Merge pull request \fI\%#27986\fP from jacobhammons/dot6
.INDENT 2.0
.IP \(bu 2
bb61c68c11 Changed current release to 5.6 and added CVE to release notes
.UNINDENT
.IP \(bu 2
831ec680d9 Merge pull request \fI\%#27913\fP from pass\-by\-value/proxmox_verify_ssl
.INDENT 2.0
.IP \(bu 2
0b721efe37 Set default
.UNINDENT
.IP \(bu 2
41cccb3a30 Merge pull request \fI\%#27876\fP from terminalmage/git_pillar\-AttributeError\-2015.5
.INDENT 2.0
.IP \(bu 2
07794c837a 2015.5 branch: Fix traceback when 2015.8 git ext_pillar config schema used
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28149\fP: (\fI\%pass\-by\-value\fP) Add clarification to cloud profile doc about host
@ \fI2015\-10\-20 19:46:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
53dd01fc24 Merge pull request \fI\%#28149\fP from pass\-by\-value/proxmox_profile_doc_change
.IP \(bu 2
bc371c55cd Add clarification to cloud profile doc about host
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28146\fP: (\fI\%cachedout\fP) Lint dracr.py
@ \fI2015\-10\-20 17:55:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
7badd634ae Merge pull request \fI\%#28146\fP from cachedout/lint_dracr
.IP \(bu 2
8b057f39e8 Lint dracr.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28118\fP: (\fI\%basepi\fP) Salt\-cloud Linode driver using RAM number for disk size (refs: \fI\%#28141\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28141\fP: (\fI\%rallytime\fP) Don\(aqt use RAM for root disk size in linode.py
@ \fI2015\-10\-20 17:32:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
5f99bd4dc6 Merge pull request \fI\%#28141\fP from rallytime/fix\-28118
.IP \(bu 2
59f8e41554 Don\(aqt use RAM for root disk size in linode.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28143\fP: (\fI\%justinta\fP) Removed blank line at end of chassis.py
@ \fI2015\-10\-20 16:39:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
7cd0440c33 Merge pull request \fI\%#28143\fP from jtand/lint_fix
.IP \(bu 2
427df95515 removed extraneous file
.IP \(bu 2
1a58283f23 Removed blank line at end of chassis.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28021\fP: (\fI\%blueyed\fP) Handle includes in \fIinclude_config\fP recursively
@ \fI2015\-10\-20 16:19:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
858875e9fd Merge pull request \fI\%#28021\fP from blueyed/recursive\-include
.IP \(bu 2
1d80520958 Handle includes in \fIinclude_config\fP recursively
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27998\fP: (\fI\%papertigers\fP) pkgin install broken (refs: \fI\%#28001\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28095\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28001\fP to 2015.8
@ \fI2015\-10\-20 16:18:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28001\fP: (\fI\%papertigers\fP) \fI\%#27998\fP Cleanup pkgin isatty mess (refs: \fI\%#28095\fP)
.IP \(bu 2
4dbaec6b0c Merge pull request \fI\%#28095\fP from rallytime/bp\-28001
.IP \(bu 2
ddf8a8d2bb Cleanup pkgin isatty mess
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28060\fP: (\fI\%LoveIsGrief\fP) Default paths for test environment (refs: \fI\%#28061\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28096\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28061\fP to 2015.8
@ \fI2015\-10\-20 16:15:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28061\fP: (\fI\%LoveIsGrief\fP) Fix \fI\%#28060\fP \- Default paths for test environment (refs: \fI\%#28096\fP)
.IP \(bu 2
572487073c Merge pull request \fI\%#28096\fP from rallytime/bp\-28061
.IP \(bu 2
cb8a72d580 Fix \fI\%#28060\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28139\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28103\fP to 2015.8
@ \fI2015\-10\-20 16:15:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28103\fP: (\fI\%ajacoutot\fP) OpenBSD salt package: update list of dependencies. (refs: \fI\%#28140\fP, \fI\%#28139\fP)
.IP \(bu 2
9ce526260b Merge pull request \fI\%#28139\fP from rallytime/bp\-28103
.IP \(bu 2
bc9159a126 OpenBSD salt package: update list of dependencies.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26844\fP: (\fI\%double\-yaya\fP) The function \(dqstate.sls\(dq is running as PID XXXX and was started at .... with jid XXXX always shows the current jid (refs: \fI\%#28098\fP, \fI\%#28097\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28098\fP: (\fI\%jacksontj\fP) For all multi\-part messages, check the headers. If the header is not …
@ \fI2015\-10\-20 15:00:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
97dfb00a68 Merge pull request \fI\%#28098\fP from jacksontj/2015.8
.IP \(bu 2
6d26842925 For all multi\-part messages, check the headers. If the header is not your minion\-id or a broadcast, drop the message.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#3436\fP: (\fI\%madduck\fP) Pillar does not handle Unicode data (refs: \fI\%#28134\fP, #saltstack/salt\(ga#28134\(ga_)
.IP \(bu 2
\fBPR\fP \fI\%#28134\fP: (\fI\%bernieke\fP) fix unicode pillar values \fI\%#3436\fP
@ \fI2015\-10\-20 14:51:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
b4875e585a Merge pull request \fI\%#28134\fP from Awingu/2015.8
.IP \(bu 2
53285f7781 fix unicode pillar values \fI\%#3436\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28076\fP: (\fI\%redmcg\fP) Replace option \(aqi\(aq with an explicit queryformat
@ \fI2015\-10\-20 13:59:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
f990a21029 Merge pull request \fI\%#28076\fP from redmcg/2015.8
.IP \(bu 2
07413ec162 Remove unnecessary padding from rpm.info
.IP \(bu 2
4987530986 Replace option \(aqi\(aq with an explicit queryformat
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28119\fP: (\fI\%jacksontj\fP) Check if the remote exists before casting to a string.
@ \fI2015\-10\-20 12:34:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
3fdb52d1bf Merge pull request \fI\%#28119\fP from jacksontj/fetch_issue
.IP \(bu 2
c012dcc2f6 Check if the remote exists before casting to a string.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28080\fP: (\fI\%githubcdr\fP) Salt minion locale module missing on Archlinux (refs: \fI\%#28105\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28105\fP: (\fI\%jfindlay\fP) add reason for not loading localemod
@ \fI2015\-10\-20 12:25:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
69ab1d30e2 Merge pull request \fI\%#28105\fP from jfindlay/locale_msg
.IP \(bu 2
1e75665a9a add reason for not loading localemod
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28074\fP: (\fI\%eliasp\fP) Salt logfiles are created world\-readable (refs: \fI\%#28108\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28108\fP: (\fI\%cachedout\fP) Set logfile permsissions correctly
@ \fI2015\-10\-20 12:25:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
8db7e016ec Merge pull request \fI\%#28108\fP from cachedout/issue_28074
.IP \(bu 2
b416dcc07b Set logfile permsissions correctly
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27922\fP: (\fI\%cro\fP) WIP States/Modules for managing Dell FX2 chassis via salt\-proxy
@ \fI2015\-10\-19 23:29:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
1085eeab2b Merge pull request \fI\%#27922\fP from cro/fx2
.IP \(bu 2
6ccafa2ae5 Lint
.IP \(bu 2
104c3cbe7f Lint
.IP \(bu 2
fe75594737 Lint
.IP \(bu 2
479137cef8 Lint
.IP \(bu 2
3712066fc9 More docs.
.IP \(bu 2
2a3ebf5688 More Documentation.
.IP \(bu 2
4ce2f8bb11 Documentation.
.IP \(bu 2
18663306fb Cleanup, add blade_idrac stub
.IP \(bu 2
0957beea46 Lint fixes and some changes by @rallytime
.IP \(bu 2
cca310eee0 WIP modules and states for managing Dell FX2 chassis via salt\-proxy
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28104\fP: (\fI\%pass\-by\-value\fP) Add documentation for proxy minion ssh
@ \fI2015\-10\-19 19:30:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
a715803c92 Merge pull request \fI\%#28104\fP from pass\-by\-value/proxy_ssh_docs
.IP \(bu 2
7c8f236115 Add documentation for proxy minion ssh
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27130\fP: (\fI\%githubcdr\fP) salt\-run broken in 2015.8? (refs: \fI\%#28020\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28020\fP: (\fI\%DmitryKuzmenko\fP) LazyLoader deepcopy fix.
@ \fI2015\-10\-19 13:17:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
07cac0b434 Merge pull request \fI\%#28020\fP from DSRCompany/issues/27130_loader_deepcopy_fix
.IP \(bu 2
5353518623 Fix lint errors
.IP \(bu 2
8c256c94f4 LazyLoader deepcopy fix.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27932\fP: (\fI\%eliasp\fP) Can\(aqt include Pillar SLS across GitPillar repositories (refs: \fI\%#27933\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27933\fP: (\fI\%eliasp\fP) Provide all git pillar dirs in \fIopts[pillar_roots]\fP
@ \fI2015\-10\-19 13:05:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
f884df5d78 Merge pull request \fI\%#27933\fP from eliasp/fix\-27932
.IP \(bu 2
05782aa78f Provide all git pillar dirs in \fIopts[pillar_roots]\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27890\fP: (\fI\%dkiser\fP) pillar recurse list strategy (refs: \fI\%#27891\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28013\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27891\fP to 2015.8
@ \fI2015\-10\-19 12:57:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27891\fP: (\fI\%dkiser\fP) introduce recurse_list pillar_source_merging_strategy (refs: \fI\%#28353\fP, \fI\%#28013\fP)
.IP \(bu 2
1db6406bef Merge pull request \fI\%#28013\fP from rallytime/bp\-27891
.IP \(bu 2
9ea33bf0e4 Pylint fixes
.IP \(bu 2
4af5b5c33f introduce recurse_list pillar_source_merging_strategy
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27938\fP: (\fI\%mostafahussein\fP) Grains are not rendering correctly (refs: \fI\%#28018\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28018\fP: (\fI\%rallytime\fP) Add example to Writing Grains of how grains can be loaded twice
@ \fI2015\-10\-19 12:47:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
26b3e01dda Merge pull request \fI\%#28018\fP from rallytime/fix\-27938
.IP \(bu 2
c23af0d8e2 Clarify loading vs rendering the final grains data structure
.IP \(bu 2
a4d7fb7e60 Add example to Writing Grains of how grains can be loaded twice
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28084\fP: (\fI\%cachedout\fP) \fI\%#28069\fP with lint
@ \fI2015\-10\-19 12:18:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28069\fP: (\fI\%blueyed\fP) dockerng: use error from modules.dockerng in states\(aq __virtual__ (refs: \fI\%#28084\fP)
.IP \(bu 2
c6e7dd4812 Merge pull request \fI\%#28084\fP from cachedout/lint_28069
.IP \(bu 2
8026212733 Lint
.IP \(bu 2
7a2c80cf6f dockerng: use error from modules.dockerng in states\(aq __virtual__
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28079\fP: (\fI\%The\-Loeki\fP) Fix for trace dump on failing imports for win32com & pythoncom 4 win_task
@ \fI2015\-10\-19 12:12:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
428e64e24d Merge pull request \fI\%#28079\fP from The\-Loeki/fix\-trace\-on\-windows\-tasks
.IP \(bu 2
869e212e81 Fix for trace dump on failing imports for win32com & pythoncom 4 win_task
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28081\fP: (\fI\%The\-Loeki\fP) fix for glance state trace error on import failure
@ \fI2015\-10\-19 12:08:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
2ac8fd793d Merge pull request \fI\%#28081\fP from The\-Loeki/fix\-trace\-on\-keystone\-state
.IP \(bu 2
258e11f754 fix for glance state trace error on import failure
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27794\fP: (\fI\%The\-Loeki\fP) Requests backend for HTTP fetches is broken after removing streamed response handlers (refs: \fI\%#28066\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28066\fP: (\fI\%jacksontj\fP) Use the generic \fItext\fP attribute, not .body of the handler
@ \fI2015\-10\-18 16:17:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
a2128c8f80 Merge pull request \fI\%#28066\fP from jacksontj/issue_27794
.IP \(bu 2
b1bf79821d Use the generic \fItext\fP attribute, not .body of the handler
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27828\fP: (\fI\%cubranic\fP) Note the version when \(aquser\(aq and \(aqgroup\(aq became available in docs for archive.extracted (refs: \fI\%#28019\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28019\fP: (\fI\%rallytime\fP) Clean up version added and deprecated msgs to be accurate
@ \fI2015\-10\-17 17:31:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
9c974c9a41 Merge pull request \fI\%#28019\fP from rallytime/fix\-27828
.IP \(bu 2
aca864643f Clean up version added and deprecated msgs to be accurate
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28058\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28041\fP to 2015.8
@ \fI2015\-10\-17 17:27:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28041\fP: (\fI\%gtmanfred\fP) use the correct discover_extensions (refs: \fI\%#28058\fP)
.IP \(bu 2
9adcd3b90d Merge pull request \fI\%#28058\fP from rallytime/bp\-28041
.IP \(bu 2
04ad8dc521 use the correct discover_extensions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28055\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28043\fP to 2015.8
@ \fI2015\-10\-17 17:26:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28043\fP: (\fI\%gtmanfred\fP) the nova driver does not require libcloud (refs: \fI\%#28055\fP)
.IP \(bu 2
6db970c93a Merge pull request \fI\%#28055\fP from rallytime/bp\-28043
.IP \(bu 2
744e556be7 the nova driver does not require libcloud
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28046\fP: (\fI\%pass\-by\-value\fP) Add pkg install and remove functions
@ \fI2015\-10\-17 14:56:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
d7263d2a8e Merge pull request \fI\%#28046\fP from pass\-by\-value/proxy_minion_ssh_example_additions
.IP \(bu 2
3435d28fc9 Add pkg install and remove functions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28050\fP: (\fI\%ryan\-lane\fP) Use a better method for checking dynamodb table existence
@ \fI2015\-10\-17 14:55:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd0fdd827e Merge pull request \fI\%#28050\fP from lyft/better\-dynamo\-exists\-check\-2015.8
.IP \(bu 2
24fff4ea12 Use a better method for checking dynamodb table existence
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28038\fP: (\fI\%gtmanfred\fP) [Docs] the ubuntu repo documentation needs to be fixed (refs: \fI\%#28042\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28042\fP: (\fI\%jfindlay\fP) fix repo path in ubuntu installation documentation
@ \fI2015\-10\-16 19:30:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
027092e2fb Merge pull request \fI\%#28042\fP from jfindlay/ubuntu_docs
.IP \(bu 2
ae92a8a1dc fix repo path in ubuntu installation documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28033\fP: (\fI\%twangboy\fP) Fixed win_useradd.py (refs: \fI\%#28056\fP)
@ \fI2015\-10\-16 19:19:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
a3390cfbe6 Merge pull request \fI\%#28033\fP from twangboy/fix_win_useradd
.IP \(bu 2
2137b5f79a Fixed win_useradd.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28027\fP: (\fI\%cro\fP) Make ssh conn persistent.
@ \fI2015\-10\-16 18:50:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
4f81358e9a Merge pull request \fI\%#28027\fP from cro/persistent_ssh
.IP \(bu 2
8b4067b6db Spelling, lint.
.IP \(bu 2
76a93d5922 Spelling.
.IP \(bu 2
c800f60338 Default multiprocessing to False since anything that needs salt.vt will have trouble with our forking model.
.IP \(bu 2
cc0ad81b3d Lint, remove debug.
.IP \(bu 2
e41b677450 Make SSH connection \(aqpersistent\(aq.  Note that right now this requires \(aqmultiprocessing: False\(aq in /etc/salt/proxy.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28029\fP: (\fI\%jacobhammons\fP) Updated release notes with additional CVE information
@ \fI2015\-10\-16 16:19:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
4dec2f9307 Merge pull request \fI\%#28029\fP from jacobhammons/relnotes8
.IP \(bu 2
0d1b691549 Updated release notes with additional CVE information
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28022\fP: (\fI\%jacobhammons\fP) Updated Debian and Ubuntu repo paths with new structure for 2015.8.1
@ \fI2015\-10\-16 15:31:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
5286c01f39 Merge pull request \fI\%#28022\fP from jacobhammons/install
.IP \(bu 2
e4d7df8695 Updated Debian and Ubuntu repo paths with new structure for 2015.8.1
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27971\fP: (\fI\%srkunze\fP) pip.installed returned Result: None (refs: \fI\%#27983\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27983\fP: (\fI\%rallytime\fP) Pip state run result should be False, not None, if installation error occurs.
@ \fI2015\-10\-16 13:37:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
340229355c Merge pull request \fI\%#27983\fP from rallytime/fix\-27971
.IP \(bu 2
9855290b99 Maintain stateful output if something went wrong running the pip command
.IP \(bu 2
5bcc89bb8e Pip state run result should be False, not None, if installation error occurs.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#20678\fP: (\fI\%damon\-atkins\fP) Windows Installer (Separation/Downloader/Contains VC++) (refs: \fI\%#27991\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27991\fP: (\fI\%twangboy\fP) Fix for \fI\%#20678\fP
@ \fI2015\-10\-16 13:33:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
97d473af0d Merge pull request \fI\%#27991\fP from twangboy/fix_20678
.IP \(bu 2
5254ba18b3 Fix for \fI\%#20678\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21845\fP: (\fI\%kitsemets\fP) pip.install: fails in v2015.2.0rc1 when the package is already installed (pip v1.0) (refs: \fI\%#27996\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27997\fP: (\fI\%rallytime\fP) Remove note about pip bug with pip v1 vs pip v2 return codes
@ \fI2015\-10\-16 13:23:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27996\fP: (\fI\%rallytime\fP) Don\(aqt fail if pip package is already present and pip1 is installed (refs: \fI\%#27997\fP)
.IP \(bu 2
bd7b39bc18 Merge pull request \fI\%#27997\fP from rallytime/remove\-pip\-bug\-note
.IP \(bu 2
f08d488313 Remove note about pip bug with pip v1 vs pip v2 return codes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27994\fP: (\fI\%justinta\fP) Fix schedule_test failure
@ \fI2015\-10\-16 13:20:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
3256e38932 Merge pull request \fI\%#27994\fP from jtand/schedule_test\-fix
.IP \(bu 2
cd67843bd0 Fix schedule_test failure
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27949\fP: (\fI\%itsamenathan\fP) Error enabling or disabling a beacon on a minion  (refs: \fI\%#27992\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27992\fP: (\fI\%cachedout\fP) Make load beacon config into list
@ \fI2015\-10\-16 12:43:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
4a7a25eef7 Merge pull request \fI\%#27992\fP from cachedout/issue_27949
.IP \(bu 2
8944e1395a Make load beacon config into list
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26336\fP: (\fI\%jfindlay\fP) windows user.present broken (refs: \fI\%#28003\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28003\fP: (\fI\%twangboy\fP) Fix \fI\%#26336\fP (refs: \fI\%#28037\fP)
@ \fI2015\-10\-16 12:43:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
bae81d3a8d Merge pull request \fI\%#28003\fP from twangboy/fix_26336
.IP \(bu 2
6c94146d86 Fix PR \fI\%#26336\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27984\fP: (\fI\%rallytime\fP) Versionadded for clean_file option for pkgrepo
@ \fI2015\-10\-15 18:57:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#19561\fP: (\fI\%favadi\fP) add pkgrepo.managed clean_file option (refs: \fI\%#27984\fP)
.IP \(bu 2
e15eeee2d3 Merge pull request \fI\%#27984\fP from rallytime/version\-clean\-file
.IP \(bu 2
b094c8843e Versionadded for clean_file option for pkgrepo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27989\fP: (\fI\%ryan\-lane\fP) Do not try to remove the main route table association
@ \fI2015\-10\-15 18:57:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
6efa71a482 Merge pull request \fI\%#27989\fP from lyft/boto_vpc\-main\-route\-association2\-2015.8
.IP \(bu 2
296931d29f Do not try to remove the main route table association
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27982\fP: (\fI\%pass\-by\-value\fP) Add example for salt\-proxy over SSH
@ \fI2015\-10\-15 17:27:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
7169fad02d Merge pull request \fI\%#27982\fP from pass\-by\-value/proxy_ssh_sample
.IP \(bu 2
b85f6ab339 Add example for salt\-proxy over SSH
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27985\fP: (\fI\%jacobhammons\fP) Changed current release to 8.1 and added CVEs to release notes
@ \fI2015\-10\-15 17:27:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0be1ab98e Merge pull request \fI\%#27985\fP from jacobhammons/dot1
.IP \(bu 2
236992b2be Changed current release to 8.1 and added CVEs to release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27750\fP: (\fI\%justyns\fP) Salt\-master too sensitive to whitespace in public keys (again) (refs: \fI\%#27979\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#21910\fP: (\fI\%justyns\fP) Salt\-master too whitespace\-sensitive when dealing with minion pub keys (refs: \fI\%#22115\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27979\fP: (\fI\%cachedout\fP) Fix regression with key whitespace
@ \fI2015\-10\-15 15:26:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#22115\fP: (\fI\%douglas\-vaz\fP) Strip whitespace characters using strip() for pub key check (refs: \fI\%#27979\fP)
.IP \(bu 2
7e4058605d Merge pull request \fI\%#27979\fP from cachedout/issue_27750
.IP \(bu 2
12c6bf4358 Fix regression with key whitespace
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27712\fP: (\fI\%eduherraiz\fP) saltutil.sync_all can\(aqt sync with the minion (refs: \fI\%#27977\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27977\fP: (\fI\%cachedout\fP) Decode unicode names in fileclient/server
@ \fI2015\-10\-15 15:17:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
6f8925ee84 Merge pull request \fI\%#27977\fP from cachedout/issuse_27712
.IP \(bu 2
5173ef43c8 Decode unicode names in fileclient/server
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27981\fP: (\fI\%justinta\fP) Fixed trailing whitespace lint
@ \fI2015\-10\-15 15:10:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc1375fc39 Merge pull request \fI\%#27981\fP from jtand/cloudstack\-lint
.IP \(bu 2
5dfad190c2 Fixed trailing whitespace lint
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27969\fP: (\fI\%jeffreyctang\fP) fix parse of { on next line
@ \fI2015\-10\-15 15:04:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
1ae302b202 Merge pull request \fI\%#27969\fP from jeffreyctang/logrotate_parse
.IP \(bu 2
2c9b2bc367 lint fixes
.IP \(bu 2
8c6197d42e fix parse of { on next line
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27978\fP: (\fI\%terminalmage\fP) Add note about dockerng.inspect_image usage
@ \fI2015\-10\-15 14:54:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
a4ba982b1d Merge pull request \fI\%#27978\fP from terminalmage/dockerng\-inspect_image\-docstring
.IP \(bu 2
595f4a6939 Add note about dockerng.inspect_image usage
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27955\fP: (\fI\%pass\-by\-value\fP) Bp 27868
@ \fI2015\-10\-15 12:43:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27868\fP: (\fI\%pass\-by\-value\fP) Add SSHConnection object
.IP \(bu 2
bd9d1ed8b5 Merge pull request \fI\%#27955\fP from pass\-by\-value/bp\-27868
.IP \(bu 2
c02ec8b943 Fix pylint errors
.IP \(bu 2
6553d135d0 Add SSHConnection object
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27953\fP: (\fI\%The\-Loeki\fP) Fix CloudStack cloud for new \(aqdriver\(aq syntax
@ \fI2015\-10\-15 12:38:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
c50802a80f Merge pull request \fI\%#27953\fP from The\-Loeki/patch\-1
.IP \(bu 2
f0d5c9f375 Pop deprecated \(aqprovider\(aq into new \(aqdriver\(aq key
.IP \(bu 2
4e6b09edd1 Fix CloudStack cloud for new \(aqdriver\(aq syntax
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27965\fP: (\fI\%ryan\-lane\fP) Fail in boto_asg.present if alarms fail
@ \fI2015\-10\-15 12:32:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
7006c37627 Merge pull request \fI\%#27965\fP from lyft/HOTFIX\-boto\-asg\-fix
.IP \(bu 2
b8f4079c33 Fail in boto_asg.present if alarms fail
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27958\fP: (\fI\%twangboy\fP) Added new functionality to win_task.py
@ \fI2015\-10\-15 12:30:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
6624ec1f48 Merge pull request \fI\%#27958\fP from twangboy/update_win_task
.IP \(bu 2
6ecbdba246 Added run_wait function
.IP \(bu 2
5731bdcadb Clarified an error
.IP \(bu 2
23b9c1c199 Added new functionality
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27956\fP: (\fI\%The\-Loeki\fP) Salt\-cloud CLI 2015.8 borks out with global name \(aq__opts__\(aq is not defined   (refs: \fI\%#27959\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27959\fP: (\fI\%techhat\fP) Change __opts__ to self.opts
@ \fI2015\-10\-14 22:29:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
1efa87a964 Merge pull request \fI\%#27959\fP from techhat/issue27956
.IP \(bu 2
bc01c48122 Change __opts__ to self.opts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27943\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27910\fP to 2015.8
@ \fI2015\-10\-14 20:27:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27910\fP: (\fI\%twellspring\fP) htpasswd state add comment about dependency on apache2\-utils (refs: \fI\%#27943\fP)
.IP \(bu 2
877e217388 Merge pull request \fI\%#27943\fP from rallytime/bp\-27910
.IP \(bu 2
33b3d8f5b3 Clarify that apache2\-utils is for Debian\-based distros
.IP \(bu 2
8ca0bc823c Add dependency on apache2\-utils
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27944\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27909\fP to 2015.8
@ \fI2015\-10\-14 20:26:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27909\fP: (\fI\%twellspring\fP) htpasswd module add comment about dependency on apache2\-utils (refs: \fI\%#27944\fP)
.IP \(bu 2
5f6edc8ac2 Merge pull request \fI\%#27944\fP from rallytime/bp\-27909
.IP \(bu 2
a3401c11b1 Clarify that apache2\-utils is for Debian\-based distros
.IP \(bu 2
08b7bdeb97 Add dependency on apache2\-utils
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27946\fP: (\fI\%justinta\fP) Changed grain to look at osmajorrelease instead of osrelease
@ \fI2015\-10\-14 19:54:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
f29ca5f87b Merge pull request \fI\%#27946\fP from jtand/pkgrepo\-fix
.IP \(bu 2
d88ac2589f Changed grain to look at osmajorrelease instead of osrelease
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27815\fP: (\fI\%tbaker57\fP) Documentation regarding associate_eip for EC2 profiles (refs: \fI\%#27914\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27914\fP: (\fI\%rallytime\fP) Use eipalloc instead of eni in EC2 interface properties example
@ \fI2015\-10\-14 14:37:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb900d428b Merge pull request \fI\%#27914\fP from rallytime/fix\-27815
.IP \(bu 2
13a9bc9053 Use eipalloc instead of eni in EC2 interface properties example
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27926\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27905\fP to 2015.8
@ \fI2015\-10\-14 14:35:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27905\fP: (\fI\%itsamenathan\fP) Small documentation error for beacon disable (refs: \fI\%#27926\fP)
.IP \(bu 2
679e603905 Merge pull request \fI\%#27926\fP from rallytime/bp\-27905
.IP \(bu 2
30e6b055ec Small documentation error fixed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27911\fP: (\fI\%ryan\-lane\fP) rules_egress in boto_secgroup should not manage egress rules, if set to None (refs: \fI\%#27927\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27927\fP: (\fI\%ryan\-lane\fP) Do not manage ingress or egress rules if set to None
@ \fI2015\-10\-14 14:03:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
3b4d86467b Merge pull request \fI\%#27927\fP from lyft/boto_secgroup\-fixes\-2015.8
.IP \(bu 2
0fedcc9a0b Update docs
.IP \(bu 2
9cc65bba76 Do not manage ingress or egress rules if set to None
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27928\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27908\fP to 2015.8
@ \fI2015\-10\-14 14:00:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27908\fP: (\fI\%lathama\fP) Documentation note kwargs for mdadm state already mentioned in module (refs: \fI\%#27928\fP)
.IP \(bu 2
b0f9db409d Merge pull request \fI\%#27928\fP from rallytime/bp\-27908
.IP \(bu 2
7febb06223 Sneaky white space
.IP \(bu 2
31d54bbe63 Note kwags for mdadm in state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27661\fP: (\fI\%alf\fP) The dockerng module uses deprecated API in docker\-py (refs: \fI\%#27676\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27676\fP: (\fI\%ticosax\fP) [dockerng] WIP No more runtime args passed to docker.start()
@ \fI2015\-10\-14 13:38:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d0b16559e Merge pull request \fI\%#27676\fP from ticosax/no\-more\-arg\-to\-docker\-start
.IP \(bu 2
a1d0ba392f fixup! Do not pass any argument to docker.start
.IP \(bu 2
8cddbb15c4 prevent potential error while reporting mismatch versions to user.
.IP \(bu 2
65c8762e1f Do not pass any argument to docker.start
.IP \(bu 2
d8cca2a009 docker.version_info is now provided.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27885\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-10\-13 22:44:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
722327ee5f Merge pull request \fI\%#27885\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
5ecd5615f2 Remove failing heavily\-mocked test
.IP \(bu 2
3b5e16db67 Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
c9c3b7760e Merge pull request \fI\%#27726\fP from jfindlay/hashhosts
.INDENT 2.0
.IP \(bu 2
ebce47de7c add docs to ssh.recv_known_host exec module fcn
.IP \(bu 2
b6ee16b1e5 deprecate hash_hostname in favor of hash_known_hosts
.UNINDENT
.IP \(bu 2
18e31584b0 Merge pull request \fI\%#27776\fP from jfindlay/local_msg
.INDENT 2.0
.IP \(bu 2
03afa3cffa return message when local jobs_cache not found
.UNINDENT
.IP \(bu 2
86cc7b5537 Merge pull request \fI\%#27766\fP from jfindlay/debmail
.INDENT 2.0
.IP \(bu 2
ee78da2c27 better check for debian userdel error
.UNINDENT
.IP \(bu 2
c224386c9a Merge pull request \fI\%#27758\fP from iggy/patch\-1
.INDENT 2.0
.IP \(bu 2
0994fb6a8c Remove redundant text from syslog returner
.UNINDENT
.IP \(bu 2
34a005041f Merge pull request \fI\%#27841\fP from terminalmage/issue27832
.INDENT 2.0
.IP \(bu 2
8e09fbd6a3 Detect Manjaro Linux as Arch derivative
.UNINDENT
.IP \(bu 2
3944a498ad Merge pull request \fI\%#27852\fP from rallytime/bp\-27806
.INDENT 2.0
.IP \(bu 2
a84bf18bc4 Empty string is falsy
.UNINDENT
.IP \(bu 2
7508a1c474 Merge pull request \fI\%#27838\fP from basepi/fix.runner.highstate.outputter.27831
.INDENT 2.0
.IP \(bu 2
8ae9b66fd9 Don\(aqt pop \(aqoutputter\(aq, we expect it further down
.UNINDENT
.IP \(bu 2
d178315f93 Merge pull request \fI\%#27791\fP from eguven/2015.5\-postgres\-user\-groups\-backport
.INDENT 2.0
.IP \(bu 2
2caf1d21d6 fix test
.IP \(bu 2
bc90c5bffe improve change reporting for postgres_user groups
.IP \(bu 2
8712bce91a backport postgres_user groups
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26908\fP: (\fI\%twangboy\fP) Fix \fIservice.restart salt\-minion\fP for other locales (refs: \fI\%#27882\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26906\fP: (\fI\%mblixter\fP) Bug fix #22020 causes a new bug due to the expected date format for the /SD parameter in schtask.exe (refs: \fI\%#27882\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27882\fP: (\fI\%twangboy\fP) Created win_task.py module
@ \fI2015\-10\-13 16:54:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
36f05fb526 Merge pull request \fI\%#27882\fP from twangboy/win_task_module
.IP \(bu 2
56c3f3ebb2 Fixed an egregious error with an import
.IP \(bu 2
07939ea29c More lint
.IP \(bu 2
14e060ed9c Fixed some tests
.IP \(bu 2
1e1bd29426 Fixed some lint
.IP \(bu 2
082277a727 Win_service.py to use the new task module
.IP \(bu 2
2212b52620 Created win_task.py module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27738\fP: (\fI\%fphhotchips\fP) Git Pillar locks not managed by fileserver runner (refs: \fI\%#27802\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27802\fP: (\fI\%terminalmage\fP) Correct warning logging when update lock is present for git_pillar/winrepo, add runner function for clearing git_pillar/winrepo locks
@ \fI2015\-10\-13 15:09:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
577191696d Merge pull request \fI\%#27802\fP from terminalmage/issue27738
.IP \(bu 2
1dbc3b5489 Fix comment in docstring that trailed off mid\-sentence
.IP \(bu 2
94b5fc572f Process both old and ng winrepo configs when clearing git locks
.IP \(bu 2
7f4366d42e Add CLI example
.IP \(bu 2
3952c66888 Change log message to reflect new runner function
.IP \(bu 2
c00ef718bf Add cache.clear_git_lock runner function
.IP \(bu 2
d7ca297f7b Add salt.fileserver.clear_lock()
.IP \(bu 2
947ed5f739 Clarify docstring
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26632\fP: (\fI\%ryanwalder\fP) postgres_user crashes when trying to add groups formed in a list (refs: \fI\%#27886\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27886\fP: (\fI\%rallytime\fP) Handle group lists as well as comma\-separated group strings.
@ \fI2015\-10\-13 15:00:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
d655bb3616 Merge pull request \fI\%#27886\fP from rallytime/fix\-26632
.IP \(bu 2
d235abf907 Handle group lists as well as comma\-separated group strings.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26313\fP: (\fI\%anlutro\fP) Timezone module error when timedatectl fails to query server (refs: \fI\%#27746\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27746\fP: (\fI\%anlutro\fP) timezone module: handle timedatectl errors
@ \fI2015\-10\-13 14:55:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
a158cd50e6 Merge pull request \fI\%#27746\fP from alprs/fix\-timedatectl_failure
.IP \(bu 2
f616b550b2 lint \- use indexed curly brace formatting
.IP \(bu 2
bc0f167850 update timezone mod unit tests for errors
.IP \(bu 2
ef26f067b2 timezone module: handle timedatectl errors
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27710\fP: (\fI\%anlutro\fP) salt\-ssh and system.reboot/shutdown (refs: \fI\%#27816\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27816\fP: (\fI\%anlutro\fP) Make system.reboot use \fIshutdown \-r\fP when available
@ \fI2015\-10\-13 14:52:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
9dc19caa79 Merge pull request \fI\%#27816\fP from alprs/fix\-reboot_delay
.IP \(bu 2
04ef51e524 make system.reboot use \fIshutdown \-r\fP when available
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27874\fP: (\fI\%rallytime\fP) Add mention of Periodic Table naming scheme to deprecation docs
@ \fI2015\-10\-13 14:51:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd92b8a2e3 Merge pull request \fI\%#27874\fP from rallytime/deprecation\-docs
.IP \(bu 2
8c056ba501 Add mention of Periodic Table naming scheme to deprecation docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27883\fP: (\fI\%terminalmage\fP) Work around \-\-is\-ancestor not being present in git\-merge\-base before git 1.8.0
@ \fI2015\-10\-13 14:51:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
7f96ebd69e Merge pull request \fI\%#27883\fP from terminalmage/git\-merge_base\-is_ancestor
.IP \(bu 2
45c666e8dd Work around \-\-is\-ancestor not being present in git\-merge\-base before git 1.8.0
.IP \(bu 2
38d715ec0a Remove redundant SaltInvocationError raises
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24111\fP: (\fI\%yermulnik\fP) cli option \(aq\-\-summary\(aq got broken after upgrade to 2015.5.1 (refs: \fI\%#24732\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27877\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27774\fP to 2015.8
@ \fI2015\-10\-13 14:50:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27774\fP: (\fI\%plastikos\fP) Summary is not correctly inspecting return data to identify not responding|connected minions (refs: \fI\%#27877\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27099\fP: (\fI\%plastikos\fP) Fix access to ret parameter of _print_returns_summary() (reverts 54b33dd35948 \fI\%#24732\fP) (refs: \fI\%#27774\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24732\fP: (\fI\%msteed\fP) Fix stacktrace when \fI\-\-summary\fP is used (refs: \fI\%#27099\fP)
.IP \(bu 2
4fb20d9b4f Merge pull request \fI\%#27877\fP from rallytime/bp\-27774
.IP \(bu 2
d940d87306 Summary is not correctly inspecting return data to identify not responding|connected minions.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26284\fP: (\fI\%storner\fP) apache_module.enable fails on SUSE (SLES 11 SP3) (refs: \fI\%#27878\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27878\fP: (\fI\%rallytime\fP) Use apache2ctl binary on SUSE in apache module
@ \fI2015\-10\-13 14:45:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
97da0a87e3 Merge pull request \fI\%#27878\fP from rallytime/fix\-26284
.IP \(bu 2
87f0d987a3 Use apache2ctl binary on SUSE in apache module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27879\fP: (\fI\%cro\fP) Add docs for 2015.8.2+ changes to proxies
@ \fI2015\-10\-13 14:45:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
067968c0e4 Merge pull request \fI\%#27879\fP from cro/proxydoc
.IP \(bu 2
5b33df9d19 Add docs for 2015.8.2+ changes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27731\fP: (\fI\%cro\fP) Add __proxy__ to replace opts[\(aqproxymodule\(aq]
@ \fI2015\-10\-12 20:41:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
922e2018ef Merge pull request \fI\%#27731\fP from cro/dunder_proxy
.IP \(bu 2
ba3e423b87 Missing object item throws an AttributeError not a NameError.
.IP \(bu 2
4cf2b56d5f Lint.
.IP \(bu 2
dc07245df2 @rallytime is awesome.  Moved proxy=None to end of def minion_mods
.IP \(bu 2
3152d8ee3f Minor loader fix
.IP \(bu 2
b15083d719 Flip sense of test for grains load at end of regular minion startup
.IP \(bu 2
37c145bcd5 More places where salt.state.State needs a proxy param, sysmod had wrong __proxyenabled__, core grains were checking for proxy the wrong way.
.IP \(bu 2
ed23f36279 One more check for presence of __proxy__
.IP \(bu 2
62d9f5092e what was I thinking?
.IP \(bu 2
ccf366e1a5 Lint
.IP \(bu 2
8aef6e8aa9 Fix comment
.IP \(bu 2
48f9755103 Oops, forgot temp var.
.IP \(bu 2
f0360ca00e More cleanup, found another spot where proxy needed to be passed to a load_modules.
.IP \(bu 2
81a4abfe5a __proxy__ is getting nuked somewhere
.IP \(bu 2
f9461ff298 Add config option so old\-style proxymodules will keep loading
.IP \(bu 2
3d6ed5b7ff Remove debug statement.
.IP \(bu 2
b5a19a9740 Enable syncing proxymodules from the master.  Proxymodules can go in /srv/salt/_proxy.
.IP \(bu 2
f878011543 Lint, and some parameter fixes to add proxy= to some overridden load_modules fns.
.IP \(bu 2
22f035d8eb Remove debug statement
.IP \(bu 2
4432499b45 More progress toward __proxy__
.IP \(bu 2
1a229c17b2 Further work on __proxy__
.IP \(bu 2
85fd6a41c7 One more check for presence of __proxy__
.IP \(bu 2
15e1d3e3df Forgot absolute_import.
.IP \(bu 2
c5d9d54f19 Fix py3 lint
.IP \(bu 2
dd50c33543 This module was accidentally overwriting core grains during tests.
.IP \(bu 2
525256fa68 Some calls to highstate won\(aqt have __proxy__ in scope
.IP \(bu 2
a615e5a876 what was I thinking?
.IP \(bu 2
fae3f3ca83 Lint
.IP \(bu 2
b049377cbe Remove rest_sample_test, it wasn\(aqt testing anything
.IP \(bu 2
42188480d4 Fix comment
.IP \(bu 2
4112c583e4 Oops, forgot temp var.
.IP \(bu 2
e9b281041c More cleanup, found another spot where proxy needed to be passed to a load_modules.
.IP \(bu 2
64f967d731 __proxy__ is getting nuked somewhere
.IP \(bu 2
bdffb9f57b Add config option so old\-style proxymodules will keep loading
.IP \(bu 2
b79b6a39dd Remove debug statement.
.IP \(bu 2
02fc2d9323 Enable syncing proxymodules from the master.  Proxymodules can go in /srv/salt/_proxy.
.IP \(bu 2
72032650b8 Add __proxy__ to the list of builtins.
.IP \(bu 2
db4c034596 Lint, and some parameter fixes to add proxy= to some overridden load_modules fns.
.IP \(bu 2
1032ad28fc Remove debug statement
.IP \(bu 2
c41e49d8e5 Make sure that the __proxy__ gets passed all the way into the state system.
.IP \(bu 2
4a20d48b35 More progress toward __proxy__
.IP \(bu 2
d337f4329e Further work on __proxy__
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26904\fP: (\fI\%anlutro\fP) pip install \-\-upgrade with virtualenv.managed? (refs: \fI\%#27745\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27745\fP: (\fI\%anlutro\fP) Add pip_upgrade arg to virtualenv.managed state
@ \fI2015\-10\-12 16:11:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
644f003fb2 Merge pull request \fI\%#27745\fP from alprs/fix\-virtualenv_pip_upgrade
.IP \(bu 2
4bd219f8d4 add pip_upgrade arg to virtualenv.managed state, clean up docstring
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27809\fP: (\fI\%ticosax\fP) [dockerng] Remove dockerng.ps caching
@ \fI2015\-10\-12 16:07:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
698f477336 Merge pull request \fI\%#27809\fP from ticosax/remove\-dockerng.ps\-caching
.IP \(bu 2
0eb1145856 Remove caching to prevent returning stale data from dockerng.ps
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27859\fP: (\fI\%ticosax\fP) [dockerng] Clarify doc port bindings
@ \fI2015\-10\-12 16:06:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
e96d06d71a Merge pull request \fI\%#27859\fP from ticosax/clarify\-doc\-port\-bindings
.IP \(bu 2
75f7a3ec55 Must be a string
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#8646\fP: (\fI\%micahhausler\fP) Make the clean parameter in the file.directory state respect foreign require_in (refs: \fI\%#27748\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27748\fP: (\fI\%multani\fP) Fix \fI\%#8646\fP
@ \fI2015\-10\-12 15:55:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
ba2a39d4b7 Merge pull request \fI\%#27748\fP from multani/fix\-8646
.IP \(bu 2
6d95cbc998 Fix lint errors
.IP \(bu 2
4ff9f4be2a Fix file.directory with clean=true and require_in with states ID
.IP \(bu 2
0d391275de Test cases to demonstrate bug \fI\%#8646\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27721\fP: (\fI\%ldobson\fP) boto_cloudwatch_alarm.present returns diff on no change (refs: \fI\%#27722\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27850\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27722\fP to 2015.8
@ \fI2015\-10\-12 15:31:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27722\fP: (\fI\%ldobson\fP) Sorted compare for alarm actions (refs: \fI\%#27850\fP)
.IP \(bu 2
ce1493e06b Merge pull request \fI\%#27850\fP from rallytime/bp\-27722
.IP \(bu 2
33936605a0 Sorted compare for alarm actions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27851\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27771\fP to 2015.8
@ \fI2015\-10\-12 15:31:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27771\fP: (\fI\%srkunze\fP) [VIRTUALENV_MOD] added docs strings to explain parameters (refs: \fI\%#27851\fP)
.IP \(bu 2
c95437a710 Merge pull request \fI\%#27851\fP from rallytime/bp\-27771
.IP \(bu 2
144a743503 added docs strings to explain parameters
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27789\fP: (\fI\%eduherraiz\fP) UnicodeDecodeError: \(aqascii\(aq codec can\(aqt decode byte in 2015.8.0 (refs: \fI\%#28340\fP, \fI\%#27833\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27833\fP: (\fI\%jfindlay\fP) decode path before string ops in fileclient
@ \fI2015\-10\-12 15:26:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
a41b59bf6e Merge pull request \fI\%#27833\fP from jfindlay/path_decode
.IP \(bu 2
66c74e591e decode path before string ops in fileclient
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27804\fP: (\fI\%chrismcmacken\fP) cmd.run/cmd.run_all documentation contradictory for python_shell argument (refs: \fI\%#27837\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27837\fP: (\fI\%jfindlay\fP) reverse truth in python_shell documentation
@ \fI2015\-10\-12 15:25:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
e264db7702 Merge pull request \fI\%#27837\fP from jfindlay/true_shell
.IP \(bu 2
1c9708a457 reverse truth in python_shell documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27860\fP: (\fI\%flavio\fP) Fix OS related grains on openSUSE and SUSE Linux Enterprise
@ \fI2015\-10\-12 15:22:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
faec838744 Merge pull request \fI\%#27860\fP from flavio/fix\-os\-grains\-on\-suse\-and\-opensuse
.IP \(bu 2
fc8d296d72 Fix OS related grains on openSUSE and SUSE Linux Enterprise
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27768\fP: (\fI\%rallytime\fP) Clean up bootstrap function to be slightly cleaner
@ \fI2015\-10\-12 15:06:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ac5344c31 Merge pull request \fI\%#27768\fP from rallytime/cleanup_bootstrap
.IP \(bu 2
9df6e106c3 Clean up bootstrap function to be slightly cleaner
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27797\fP: (\fI\%isbm\fP) Zypper module clusterfix
@ \fI2015\-10\-12 15:06:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
e1bd91e392 Merge pull request \fI\%#27797\fP from isbm/isbm\-zypper\-fixes
.IP \(bu 2
36281f6b06 Bugfix: crash if no package specified on adding a lock
.IP \(bu 2
29806a1af9 Bugfix: crash if no package specified on removing lock
.IP \(bu 2
453a18ea15 Return an actual amount of removed locks.
.IP \(bu 2
eaa6af9898 Bugfix: sometimes error goes to the STDOUT instead of STDERR in the RPM
.IP \(bu 2
350340dafa Bugfix: use boolean type instead of string \(dqYes\(dq or \(dqNo\(dq (NOTE: this was forgotten)
.IP \(bu 2
decb989eb4 Bugfix and refactor due to the crash on unknown package and incorrect return value
.IP \(bu 2
a6c285bd12 Initialization fix
.IP \(bu 2
510dedd29f Bugfix: newer Zypper includes also a version of installed package
.IP \(bu 2
f9bef516de Bugfix: broken \(dqupgrade_available\(dq and should always return dict.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27821\fP: (\fI\%leodus\fP) Deploy VM on Proxmox requires \(aqsize\(aq configuration setting? Not according the docs! (refs: \fI\%#27849\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27849\fP: (\fI\%rallytime\fP) Don\(aqt require a size parameter for proxmox profiles
@ \fI2015\-10\-11 01:33:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
286b08a0f5 Merge pull request \fI\%#27849\fP from rallytime/fix\-27821
.IP \(bu 2
1bf17c7d48 Don\(aqt require a size parameter for proxmox profiles
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27827\fP: (\fI\%techhat\fP) Add additional error checking to SPM
@ \fI2015\-10\-09 18:23:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
4a69db27cd Merge pull request \fI\%#27827\fP from techhat/spmfixes
.IP \(bu 2
ffc8df223b Add additional error checking to SPM
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27825\fP: (\fI\%martinhoefling\fP) Salt\-api is not adding cors headers if auth fails (refs: \fI\%#27826\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27826\fP: (\fI\%martinhoefling\fP) Fixes \fI\%#27825\fP
@ \fI2015\-10\-09 16:08:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
9bc19ba7d2 Merge pull request \fI\%#27826\fP from martinhoefling/fix\-27825
.IP \(bu 2
401e7de33d Fixes \fI\%#27825\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27824\fP: (\fI\%techhat\fP) Update Azure errors
@ \fI2015\-10\-09 15:25:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
1e2dede122 Merge pull request \fI\%#27824\fP from techhat/azureerrors
.IP \(bu 2
5b23ac7099 Update Azure errors
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27795\fP: (\fI\%eguven\fP) better change reporting for postgres_user groups
@ \fI2015\-10\-08 23:56:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec35666ff2 Merge pull request \fI\%#27795\fP from eguven/2015.8\-postgres_user\-group\-change
.IP \(bu 2
ffffede412 better change reporting for postgres_user groups
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27703\fP: (\fI\%ryan\-lane\fP) git.latest seems to ignore the user argument in 2015.8 (refs: \fI\%#27799\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27799\fP: (\fI\%terminalmage\fP) Fix usage of identity file in git.latest
@ \fI2015\-10\-08 23:36:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
5420006209 Merge pull request \fI\%#27799\fP from terminalmage/issue27703
.IP \(bu 2
75d2b07b0c Pass user in calls to git.rev_parse
.IP \(bu 2
786786a245 Fix wrong argument name for _git_run()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27717\fP: (\fI\%pass\-by\-value\fP) Proxy beacon example
@ \fI2015\-10\-08 22:58:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
0533a2b1dd Merge pull request \fI\%#27717\fP from pass\-by\-value/proxy_beacon_example
.IP \(bu 2
cac3da1ffa Fix pylint error
.IP \(bu 2
7fef5ea08c Make a call to beacon end point
.IP \(bu 2
497f965c33 Comment
.IP \(bu 2
8ad7082913 Add example beacon that works with salt\-proxy
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27793\fP: (\fI\%anlutro\fP) update code that changes log level of salt\-ssh shim command
@ \fI2015\-10\-08 19:20:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd9dba8f59 Merge pull request \fI\%#27793\fP from alprs/fix\-salt_ssh_b64_log
.IP \(bu 2
2597d13fc8 update code that changes log level of salt\-ssh shim command
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27714\fP: (\fI\%The\-Loeki\fP) 2015.8 git_pillar merge inconsistency/bug (refs: \fI\%#27761\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27761\fP: (\fI\%terminalmage\fP) Merge git pillar data instead of using dict.update()
@ \fI2015\-10\-08 15:00:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
bccb74ffc5 Merge pull request \fI\%#27761\fP from terminalmage/issue27714
.IP \(bu 2
d149095bb0 Merge git pillar data instead of using dict.update()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27741\fP: (\fI\%ticosax\fP) [dockerng] pass filters argument to dockerng.ps
@ \fI2015\-10\-08 03:40:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
2ae7ada3c9 Merge pull request \fI\%#27741\fP from ticosax/docker.containers\-filters
.IP \(bu 2
821ed72f37 pass filters argument to dockerng.ps
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27760\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-10\-07 19:11:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
82a51cebde Merge pull request \fI\%#27760\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
35425b14ad Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.IP \(bu 2
b2937b6a16 Merge pull request \fI\%#27759\fP from basepi/merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
792ee084bb Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
d284eb165b Merge pull request \fI\%#27390\fP from JaseFace/schedule\-missing\-enabled
.IP \(bu 2
563db71bfd Ensure we pass on the enable setting if present, or use the default of True if not in build_schedule_item() Prior to this, when schedule.present compares the existing schedule to the one crafted by this function, enabled will actually be removed at each run.  schedule.present sees a modification needs to be made, and invokes schedule.modify, which does so with enabled: True, creating and endless loop of an \(aqenabled\(aq removal and addition.
.UNINDENT
.IP \(bu 2
4b9128b491 Merge pull request \fI\%#27732\fP from jacobhammons/26673
.INDENT 2.0
.IP \(bu 2
75cc07cf10 noted that __virtual__ can return False and an error string
.IP \(bu 2
b928e1afa8 update docs for __virtual__ and __virtualname__ Refs \fI\%#26673\fP
.UNINDENT
.IP \(bu 2
a130896d1c Merge pull request \fI\%#27747\fP from Sacro/fix\-chocolatey\-version
.INDENT 2.0
.IP \(bu 2
8f1fa9e78e Chocolatey doesn\(aqt have a help command.
.UNINDENT
.IP \(bu 2
4e48651de0 Merge pull request \fI\%#27733\fP from jacobhammons/bug\-fixes
.INDENT 2.0
.IP \(bu 2
cbecd4f553 Updated saltstack2 theme to add SaltConf16 banner
.IP \(bu 2
117e0c2bcc Added hardening topic based on the information in Refs \fI\%#27088\fP
.UNINDENT
.IP \(bu 2
c58da846bf Merge pull request \fI\%#27706\fP from jacobhammons/bug\-fixes
.INDENT 2.0
.IP \(bu 2
76dc8de71b Assorted doc bugs Refs \fI\%#9051\fP Refs \fI\%#13407\fP Refs \fI\%#21475\fP Refs \fI\%#14876\fP Refs \fI\%#27005\fP
.UNINDENT
.IP \(bu 2
43fba89865 Merge pull request \fI\%#27695\fP from rallytime/bp\-27671
.INDENT 2.0
.IP \(bu 2
2a88028595 Added skip test_ext_pillar_env_mapping if git module does not exist.
.UNINDENT
.IP \(bu 2
cb3d92676e Merge pull request \fI\%#27524\fP from jfindlay/pkgng_quiet
.INDENT 2.0
.IP \(bu 2
5e9107b970 parse pkgng output in quiet mode for >= 1.6.0
.UNINDENT
.IP \(bu 2
5b88c55cc3 Merge pull request \fI\%#27686\fP from rallytime/bp\-27476
.INDENT 2.0
.IP \(bu 2
3e08d3de8a fix for: \fI\%https://github.com/saltstack/salt/issues/27373\fP
.UNINDENT
.IP \(bu 2
f9ddd4647f Merge pull request \fI\%#27684\fP from rallytime/bp\-27656
.INDENT 2.0
.IP \(bu 2
d3780cba00 Fix \fI\%#27655\fP: handling of success in postgres_local_cache
.UNINDENT
.IP \(bu 2
7ca6f854ff Merge pull request \fI\%#27683\fP from rallytime/bp\-27659
.INDENT 2.0
.IP \(bu 2
84b6ee0c58 .pub as public key is what we should send to remote
.UNINDENT
.IP \(bu 2
a0f3e34656 Merge pull request \fI\%#27682\fP from rallytime/bp\-27566
.INDENT 2.0
.IP \(bu 2
2a44255748 minor: fix/format doc for returners.local_cache.prep_jid
.IP \(bu 2
fd485e2396 returners.local_cache: fix endless loop on OSError
.UNINDENT
.IP \(bu 2
0b9ba911c4 Merge pull request \fI\%#27681\fP from rallytime/bp\-25928
.INDENT 2.0
.IP \(bu 2
17e1ddf137 Fix stacktrace for non\-existant states
.UNINDENT
.IP \(bu 2
23da0d316a Merge pull request \fI\%#27680\fP from rallytime/bp\-27535
.INDENT 2.0
.IP \(bu 2
04aed5e105 Versionadded change since 2015.5.6 has already been tagged
.IP \(bu 2
579f2646ba .. versionadded:: 2015.5.6
.IP \(bu 2
cbaf46e066 python <2.7 compatibility (pylint issue)
.IP \(bu 2
ecde499478 s/bin/b to avoid confusion with bin()
.IP \(bu 2
4237c5db80 add a __virtual__ to check that daemontools is installed properly
.IP \(bu 2
623935a1bc fix doc
.IP \(bu 2
573de3abd6 fix pylint issue
.IP \(bu 2
5eb6a30d40 fix pep8 issues
.IP \(bu 2
298cf4f5c0 import missing logging module
.IP \(bu 2
fe0ad36609 log was missing
.IP \(bu 2
e457083465 s/systemd/FreeBSD
.IP \(bu 2
3512712e89 forgot service name..
.IP \(bu 2
8f193a7bcc fixes \fI\%#27505\fP
.UNINDENT
.IP \(bu 2
7d7b97eab6 Merge pull request \fI\%#27442\fP from JaseFace/fix\-27391\-for\-2015.5
.INDENT 2.0
.IP \(bu 2
bfbf63e1cc Ensure we pass on the enable setting if present, or use the default of True if not in build_schedule_item() Prior to this, when schedule.present compares the existing schedule to the one crafted by this function, enabled will actually be removed at each run.  schedule.present sees a modification needs to be made, and invokes schedule.modify, which does so with enabled: True, creating and endless loop of an \(aqenabled\(aq removal and addition.
.UNINDENT
.IP \(bu 2
ccbba8656b Merge pull request \fI\%#27641\fP from rallytime/gate\-psutil\-diskusage
.INDENT 2.0
.IP \(bu 2
da2d93a3dd Gate the psutil import and add depends doc for diskusage beacon
.UNINDENT
.IP \(bu 2
09183994f9 Merge pull request \fI\%#27644\fP from rallytime/bp\-27640
.INDENT 2.0
.IP \(bu 2
a9063a9745 fix typo in default pillar path
.UNINDENT
.IP \(bu 2
27fcecccbe Merge pull request \fI\%#27612\fP from rallytime/fix\-27609
.INDENT 2.0
.IP \(bu 2
8dc047dc18 If external_up is set to None, don\(aqt stacktrace, just use the private ip.
.IP \(bu 2
2ebf790f9f [salt\-cloud] gce: don\(aqt stacktrace if Ephemeral is given instead of ephemeral
.UNINDENT
.IP \(bu 2
c84a1edc1b Merge pull request \fI\%#27568\fP from jacobhammons/man\-pages\-five
.INDENT 2.0
.IP \(bu 2
b59c03d20d regenerated man pages
.UNINDENT
.IP \(bu 2
304dc68f7f Merge pull request \fI\%#27582\fP from jfindlay/2015.5
.INDENT 2.0
.IP \(bu 2
4f0d55cda6 add 2015.5.6 release notes
.UNINDENT
.IP \(bu 2
7201ce71e4 Merge pull request \fI\%#27557\fP from jfindlay/mine_doc
.INDENT 2.0
.IP \(bu 2
3727d79bad edit mine doc for style and markup
.IP \(bu 2
7e037a4666 add doc motivating mine vs grains
.UNINDENT
.IP \(bu 2
59c3d5f93e Merge pull request \fI\%#27515\fP from jfindlay/suse_fire
.INDENT 2.0
.IP \(bu 2
4460ad2785 save iptables rules on SuSE
.UNINDENT
.IP \(bu 2
9b26357b19 Merge pull request \fI\%#27509\fP from jfindlay/gluster_reason
.INDENT 2.0
.IP \(bu 2
1ccda538d2 tell the user why the gluster module does not work
.UNINDENT
.IP \(bu 2
989733ea86 Merge pull request \fI\%#27379\fP from jfindlay/pip_vars
.IP \(bu 2
aee51ffdef document and check dict type for pip env_vars
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27643\fP: (\fI\%blueyed\fP) Please document extended return values of __virtual__ (refs: \fI\%#27724\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26755\fP: (\fI\%lorengordon\fP) Associate package dependencies to modules/states? (refs: \fI\%#27724\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27757\fP: (\fI\%jfindlay\fP) fix virtual fcn return doc indentation
@ \fI2015\-10\-07 17:50:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27724\fP: (\fI\%jfindlay\fP) update __virtual__ return documentation (refs: \fI\%#27757\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27116\fP: (\fI\%jacobhammons\fP) Update latest to 2015.8, 2015.5 is now previous (refs: \fI\%#27724\fP)
.IP \(bu 2
aced4229cb Merge pull request \fI\%#27757\fP from jfindlay/virtret
.IP \(bu 2
03400ef45b fix virtual fcn return doc indentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27636\fP: (\fI\%brian\-bk\fP) Salt\-ssh cannot do simple state \(aqtest.nop\(aq: \(dq\(aqtest.nop\(aq is not available.\(dq (refs: \fI\%#27754\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27754\fP: (\fI\%rallytime\fP) Change test.nop version directive to 2015.8.1
@ \fI2015\-10\-07 15:59:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
57b5b594bd Merge pull request \fI\%#27754\fP from rallytime/fix\-27636
.IP \(bu 2
31b9852d9a Change test.nop version directive to 2015.8.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27734\fP: (\fI\%jacobhammons\fP) Updated saltstack2 theme to add SaltConf16 banner
@ \fI2015\-10\-07 01:43:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
9a0171089d Merge pull request \fI\%#27734\fP from jacobhammons/theme\-updates
.IP \(bu 2
3a52d3606b Updated saltstack2 theme to add SaltConf16 banner
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27595\fP: (\fI\%ralphvanetten\fP) Debian package does not depend on python\-m2crypto which is required by the x509 state/module (refs: \fI\%#27719\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27727\fP: (\fI\%rallytime\fP) Merge \fI\%#27719\fP w/pylint fix
@ \fI2015\-10\-06 21:13:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27719\fP: (\fI\%jfindlay\fP) tell user when x509 exec/state module can\(aqt load (refs: \fI\%#27727\fP)
.IP \(bu 2
d3f2dfe835 Merge pull request \fI\%#27727\fP from rallytime/merge\-27719
.IP \(bu 2
a7fd156162 Pylint
.IP \(bu 2
6bf2ee2751 tell user when x509 exec/state module can\(aqt load
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27643\fP: (\fI\%blueyed\fP) Please document extended return values of __virtual__ (refs: \fI\%#27724\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26755\fP: (\fI\%lorengordon\fP) Associate package dependencies to modules/states? (refs: \fI\%#27724\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27724\fP: (\fI\%jfindlay\fP) update __virtual__ return documentation (refs: \fI\%#27757\fP)
@ \fI2015\-10\-06 21:06:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27116\fP: (\fI\%jacobhammons\fP) Update latest to 2015.8, 2015.5 is now previous (refs: \fI\%#27724\fP)
.IP \(bu 2
f26bcd2d21 Merge pull request \fI\%#27724\fP from jfindlay/virtret
.IP \(bu 2
6bddf80546 update __virtual__ return documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27481\fP: (\fI\%basepi\fP) Fix issues with cross\-calling states (refs: \fI\%#27725\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27725\fP: (\fI\%basepi\fP) Fix global injection for state cross calls
@ \fI2015\-10\-06 21:02:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
d67e8c5c2c Merge pull request \fI\%#27725\fP from basepi/states.cross.call.27481
.IP \(bu 2
e12269d871 Remove unused import
.IP \(bu 2
4e6505b2e7 Return the wrapper (whoops)
.IP \(bu 2
fadb954676 Use new method for injecting globals into state functions
.IP \(bu 2
17b267470a Add decorator for injecting globals into functions in the loader
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27628\fP: (\fI\%ticosax\fP) [dockerng] Add support of \fIlabels\fP parameter for dockerng
@ \fI2015\-10\-06 13:58:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
06e67d25f8 Merge pull request \fI\%#27628\fP from ticosax/dockerng\-container\-label
.IP \(bu 2
edf625c8b4 Add support of \fIlabels\fP parameter for dockerng
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26604\fP: (\fI\%ari\fP) Poor compound matcher documentation (2015.8 docs) (refs: \fI\%#27704\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27704\fP: (\fI\%jacobhammons\fP) Update compound matcher docs to clarify the usage of alternate delimi…
@ \fI2015\-10\-06 05:36:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
e47d849af6 Merge pull request \fI\%#27704\fP from jacobhammons/26604
.IP \(bu 2
1c51ce28a9 Update compound matcher docs to clarify the usage of alternate delimiters Refs \fI\%#26604\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27705\fP: (\fI\%rallytime\fP) Merge \fI\%#27602\fP with final pylint fix
@ \fI2015\-10\-05 23:36:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27602\fP: (\fI\%blueyed\fP) dockerng: fix/enhance version warning in __virtual__ (refs: \fI\%#27705\fP)
.IP \(bu 2
2491ce40f1 Merge pull request \fI\%#27705\fP from rallytime/merge\-27602
.IP \(bu 2
81aad83386 Ignore import error
.IP \(bu 2
561dc4cf94 dockerng: fix/enhance version warning in __virtual__
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#13850\fP: (\fI\%ryan\-lane\fP) s3:// urls in file.managed (and likely elsewhere) require s3.key and s3.keyid to be in minion config (refs: \fI\%#27691\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27691\fP: (\fI\%notpeter\fP) Faster timeout (3s vs 2min) for instance metadata lookups. \fI\%#13850\fP\&.
@ \fI2015\-10\-05 22:55:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
b76eb08c68 Merge pull request \fI\%#27691\fP from notpeter/iam_fail_faster
.IP \(bu 2
3d9483b4e2 Faster timeout (3s vs 2min) for instance metadata lookups. \fI\%#13850\fP\&.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27696\fP: (\fI\%blueyed\fP) loader.proxy: call \fI_modules_dirs\fP only once
@ \fI2015\-10\-05 22:42:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc78f49dc5 Merge pull request \fI\%#27696\fP from blueyed/load\-proxy\-call\-_module_dirs\-only\-once
.IP \(bu 2
55a76be6c1 loader.proxy: call \fI_modules_dirs\fP only once
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27630\fP: (\fI\%ticosax\fP) Expose container_id in mine.get_docker
@ \fI2015\-10\-05 21:56:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
77516912fa Merge pull request \fI\%#27630\fP from ticosax/include\-container\-id\-docker\-mine
.IP \(bu 2
7293ded2f6 fixup! Expose container_id in mine.get_docker
.IP \(bu 2
9e56a7e9db Expose container_id in mine.get_docker
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27600\fP: (\fI\%blueyed\fP) dockerng: use docker.version=auto by default
@ \fI2015\-10\-05 21:29:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
8453cb3eb1 Merge pull request \fI\%#27600\fP from blueyed/dockerng\-auto\-version
.IP \(bu 2
53c6e3b3de dockerng: use docker.version=auto by default
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27689\fP: (\fI\%rallytime\fP) Merge \fI\%#27448\fP with test fixes
@ \fI2015\-10\-05 21:17:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27448\fP: (\fI\%JaseFace\fP) Ensure we pass on the enable setting if present, or use the default of True if not in build_schedule_item() (refs: \fI\%#27689\fP)
.IP \(bu 2
7a4291008e Merge pull request \fI\%#27689\fP from rallytime/fix\-tests\-27448
.IP \(bu 2
05a506ec9f Use correct comment in test
.IP \(bu 2
8296fefb31 Merge \fI\%#27448\fP with test fixes
.IP \(bu 2
d9f5e9fd2f Ensure we pass on the enable setting if present, or use the default of True if not in build_schedule_item() Prior to this, when schedule.present compares the existing schedule to the one crafted by this function, enabled will actually be removed at each run.  schedule.present sees a modification needs to be made, and invokes schedule.modify, which does so with enabled: True, creating and endless loop of an \(aqenabled\(aq removal and addition.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27520\fP: (\fI\%rmarcinik\fP) winrepo is unavailable in 2015.8 (refs: \fI\%#27616\fP, \fI\%#27693\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23239\fP: (\fI\%cachedout\fP) [RFC] Deprecate ext_processses (refs: \fI\%#27693\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27693\fP: (\fI\%jacobhammons\fP) initial engines topic, updates to windows repo docs
@ \fI2015\-10\-05 21:05:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ddc87157a Merge pull request \fI\%#27693\fP from jacobhammons/doc\-updates
.IP \(bu 2
5a3e72fc8e __ops__ to __opts__
.IP \(bu 2
5a9867aad1 initial engines topic, updates to windows repo docs Refs \fI\%#23239\fP Refs \fI\%#27520\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27601\fP: (\fI\%blueyed\fP) dockerng: handle None in container.Names
@ \fI2015\-10\-05 20:32:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
f7f48d1eef Merge pull request \fI\%#27601\fP from blueyed/dockerng\-none\-names
.IP \(bu 2
b1442ac904 dockerng: handle None in container.Names
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27596\fP: (\fI\%blueyed\fP) gitfs: fix UnboundLocalError for \(aqmsg\(aq
@ \fI2015\-10\-05 20:18:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ffb5a3369 Merge pull request \fI\%#27596\fP from blueyed/fix\-gitfs\-UnboundLocalError
.IP \(bu 2
e70cbda490 gitfs: fix UnboundLocalError for \(aqmsg\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27651\fP: (\fI\%eliasp\fP) Check for existence of \(aqsubnetId\(aq key in subnet dict
@ \fI2015\-10\-05 17:01:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
4d7be3f972 Merge pull request \fI\%#27651\fP from eliasp/2015.8\-cloud.clouds.ec2\-check\-for\-subnetId\-before\-using\-it
.IP \(bu 2
f21a763809 Check for existence of \(aqsubnetId\(aq key in subnet dict
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23370\fP: (\fI\%lisa2lisa\fP) salt artifactory.downloaded module ignore classifier  (refs: \fI\%#27639\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27639\fP: (\fI\%rallytime\fP) Docement version added for new artifactory options
@ \fI2015\-10\-05 17:01:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
d9266505a7 Merge pull request \fI\%#27639\fP from rallytime/fix\-23370
.IP \(bu 2
6de99bd5b7 Docement version added for new artifactory options
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27677\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27675\fP to 2015.8
@ \fI2015\-10\-05 15:47:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27675\fP: (\fI\%avinassh\fP) Fix a typo (refs: \fI\%#27677\fP)
.IP \(bu 2
771e5136f1 Merge pull request \fI\%#27677\fP from rallytime/bp\-27675
.IP \(bu 2
bfa0acfbfe Fix a typo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27637\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27604\fP to 2015.8
@ \fI2015\-10\-05 14:54:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27604\fP: (\fI\%plastikos\fP) Fix module path to SaltCacheError (refs: \fI\%#27637\fP)
.IP \(bu 2
6bc5ddc561 Merge pull request \fI\%#27637\fP from rallytime/bp\-27604
.IP \(bu 2
3d2ee4297d Fix module path to SaltCacheError
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19291\fP: (\fI\%gfa\fP) pkg module could accept version: latest (refs: \fI\%#27657\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27657\fP: (\fI\%garethgreenaway\fP) Fix to pkg state module
@ \fI2015\-10\-03 23:56:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
905acc6229 Merge pull request \fI\%#27657\fP from garethgreenaway/19291_pkg_state_latest_fix
.IP \(bu 2
c950527b24 When latest is passed in the state as the version to install, once the package is installed the state runs will fail.  pkg.latest_version returned an empty string once the package is installed so we need to grab the installed version in that case to avoid passing an empty string to the pkg module in question.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27538\fP: (\fI\%lomeroe\fP) boto_iam is not passing parameters properly on a handful of function calls (refs: \fI\%#27539\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27632\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27539\fP to 2015.8
@ \fI2015\-10\-02 19:28:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27539\fP: (\fI\%lomeroe\fP) boto_iam updates to function calls that were not passing arguments properly (refs: \fI\%#27632\fP)
.IP \(bu 2
83ae6a1432 Merge pull request \fI\%#27632\fP from rallytime/bp\-27539
.IP \(bu 2
2b0afd0230 Add versionadded to new path option
.IP \(bu 2
e54afed73a moving path kwarg to end of function definition
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27545\fP: (\fI\%lomeroe\fP) boto_asg allow removing launch configuration with \(aqabsent\(aq state (refs: \fI\%#27546\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27544\fP: (\fI\%lomeroe\fP) boto_asg state incorrectly processes return from boto_vpc.get_subnet_association (refs: \fI\%#27559\fP, \fI\%#27546\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27633\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27559\fP to 2015.8
@ \fI2015\-10\-02 19:22:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27559\fP: (\fI\%lomeroe\fP) vpc_id fix for boto_vpc.get_subnet_association (refs: \fI\%#27633\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27546\fP: (\fI\%lomeroe\fP) boto_asg state updates (refs: \fI\%#27559\fP)
.IP \(bu 2
888e9bdf5d Merge pull request \fI\%#27633\fP from rallytime/bp\-27559
.IP \(bu 2
3f03815ada rebasing
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27463\fP: (\fI\%ryan\-lane\fP) boto_route53 module should default to region universal, rather then None (refs: \fI\%#27579\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27579\fP: (\fI\%rallytime\fP) Change boto_route53 region default to \(aquniversal\(aq to avoid problems with boto library
@ \fI2015\-10\-02 18:56:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
8b7da5e469 Merge pull request \fI\%#27579\fP from rallytime/fix\-27463
.IP \(bu 2
d5956132ef Change boto_route53 region default to \(aquniversal\(aq to avoid problems with boto library
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27581\fP: (\fI\%tkwilliams\fP) Add support for \(aqvpc_name\(aq tag in boto_secgroup module and state
@ \fI2015\-10\-02 15:40:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce4c64a2e3 Merge pull request \fI\%#27581\fP from tkwilliams/boto_secgroup_add_vpc_name
.IP \(bu 2
159cccf43f Faulty check logic around optional params
.IP \(bu 2
84ab0bbd74 One last bug to squash.  Seriously.  It\(aqs the last one.  Ever! \- fixed param vpc_id being passed where vpc_name was intended.
.IP \(bu 2
002cbf5cde Grrr.  Add back the import of SaltInvocationError that pylint wanted me to remove :)
.IP \(bu 2
0671c0d8d9 Consolidate some redundant code \- thanks @ryan\-lane !
.IP \(bu 2
fae1199276 Followed @ryan\-lane\(aqs suggestion to remove duplicated code from boto_vpc and instead call into that module
.IP \(bu 2
3a38a440b7 Merge remote\-tracking branch \(aqupstream/2015.8\(aq into boto_secgroup_add_vpc_name
.IP \(bu 2
f7ef0bcd4c Fixups for picayune pylint pedantery :)
.IP \(bu 2
35b66e28a3 Merge remote\-tracking branch \(aqupstream/2015.8\(aq into boto_secgroup_add_vpc_name
.IP \(bu 2
6770f721f8 Add support for \(aqvpc_name\(aq tag in boto_secgroup module and state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27624\fP: (\fI\%nasenbaer13\fP) Wait for sync is not passed to boto_route53 state
@ \fI2015\-10\-02 15:37:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb6f6b9ce4 Merge pull request \fI\%#27624\fP from eyj/fix_wait_for_sync
.IP \(bu 2
ed6a8c0aa6 Wait for sync is not passed to boto_route53 state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27614\fP: (\fI\%blueyed\fP) doc: minor fixes to doc and comments
@ \fI2015\-10\-02 15:34:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
eb59cb8d1c Merge pull request \fI\%#27614\fP from blueyed/doc\-minor
.IP \(bu 2
98a8c0f055 doc: minor fixes to doc and comments
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27627\fP: (\fI\%eyj\fP) Fix crash in boto_asg.get_instances if the requested attribute is None
@ \fI2015\-10\-02 15:33:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
61f8a6f39f Merge pull request \fI\%#27627\fP from eyj/pr\-instance\-attribute
.IP \(bu 2
03d7c6af3d Fix crash in boto_asg.get_instances if the requested attribute may be None
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27549\fP: (\fI\%carlpett\fP) Document winrepo_remotes_ng (refs: \fI\%#27616\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27520\fP: (\fI\%rmarcinik\fP) winrepo is unavailable in 2015.8 (refs: \fI\%#27616\fP, \fI\%#27693\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27616\fP: (\fI\%jacobhammons\fP) Updated windows software repository docs
@ \fI2015\-10\-02 05:04:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
764d70af79 Merge pull request \fI\%#27616\fP from jacobhammons/win\-repo\-docs
.IP \(bu 2
1c8b32ce26 Updated windows software repository docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27543\fP: (\fI\%lomeroe\fP) boto_elb incorrectly processes return from boto_vpc.get_subnet_assocaition (refs: \fI\%#27569\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27569\fP: (\fI\%lomeroe\fP) boto_vpc.get_subnet_association now returns a dict w/key of vpc_id, a…
@ \fI2015\-10\-01 16:03:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
db963b7864 Merge pull request \fI\%#27569\fP from lomeroe/fix_boto_elb
.IP \(bu 2
ae09a0fb61 boto_vpc.get_subnet_association now returns a dict w/key of vpc_id, adding code to handle the dict now
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25441\fP: (\fI\%ahammond\fP) modules.ps documentation missing (refs: \fI\%#27567\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27567\fP: (\fI\%whiteinge\fP) Use getattr to fetch psutil.version_info
@ \fI2015\-10\-01 15:39:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
b269cd4754 Merge pull request \fI\%#27567\fP from whiteinge/psutil\-version\-fix
.IP \(bu 2
7ebe9acc44 Use getattr to fetch psutil.version_info
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27583\fP: (\fI\%tkwilliams\fP) Fixup zypper module
@ \fI2015\-10\-01 15:38:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
9cc69e2440 Merge pull request \fI\%#27583\fP from tkwilliams/fix_zypper
.IP \(bu 2
cdd44e4128 Fixup zypper module \- expected return type of pkg.latest was changed without updating zypper module \- unchecked list deref fixed \- \(dqzypper info \-t\(dq out\-of\-date status field format has changed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27597\fP: (\fI\%blueyed\fP) gitfs: remove unused variable \(dqbad_per_remote_conf\(dq
@ \fI2015\-10\-01 15:38:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
5ca7e72c70 Merge pull request \fI\%#27597\fP from blueyed/gitfs\-remove\-unused\-bad_per_remote_conf
.IP \(bu 2
58af4d68f0 gitfs: remove unused variable \(dqbad_per_remote_conf\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27585\fP: (\fI\%ryan\-lane\fP) Fix undefined variable in cron state module
@ \fI2015\-10\-01 05:05:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
9805bdeddf Merge pull request \fI\%#27585\fP from lyft/cron\-fix
.IP \(bu 2
5474666b61 Fix undefined variable in cron state module
.UNINDENT
.UNINDENT
.SS Salt 2015.8.3 Release Notes
.sp
Version 2015.8.3 is a bugfix release for \fI\%2015.8.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB74\fP
.IP \(bu 2
Total Issue References: \fB26\fP
.IP \(bu 2
Total PR References: \fB64\fP
.IP \(bu 2
Contributors: \fB30\fP (\fI\%DmitryKuzmenko\fP, \fI\%RealKelsar\fP, \fI\%alexproca\fP, \fI\%anlutro\fP, \fI\%basepi\fP,
\fI\%bogdanr\fP, \fI\%cachedout\fP, \fI\%cedwards\fP, \fI\%chrigl\fP, \fI\%cro\fP, \fI\%fcrozat\fP, \fI\%gtmanfred\fP, \fI\%isbm\fP,
\fI\%jfindlay\fP, \fI\%kiorky\fP, \fI\%kt97679\fP, \fI\%lomeroe\fP, \fI\%lorengordon\fP, \fI\%mhoogendoorn\fP, \fI\%nmadhok\fP,
\fI\%optix2000\fP, \fI\%paulnivin\fP, \fI\%quantonganh\fP, \fI\%rallytime\fP, \fI\%s0undt3ch\fP, \fI\%schwing\fP, \fI\%sjorge\fP,
\fI\%tampakrap\fP, \fI\%terminalmage\fP, \fI\%ticosax\fP)
.UNINDENT
.SS Security Fix
.sp
\fBCVE\-2015\-8034\fP Saving \fI\%state.sls\fP cache
data to disk with insecure permissions
.sp
This affects users of the \fI\%state.sls\fP
function. The state run cache on the minion was being created with incorrect
permissions. This file could potentially contain sensitive data that was
inserted via jinja into the state SLS files. The permissions for this file are
now being set correctly. Thanks to \fI\%zmalone\fP for bringing this issue to our
attention.
.SS Changelog for v2015.8.2..v2015.8.3
.sp
\fIGenerated at: 2018\-05\-27 23:24:21 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#29173\fP: (\fI\%jfindlay\fP) add 2015.8.3 release notes
@ \fI2015\-11\-25 00:07:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
345206b68e Merge pull request \fI\%#29173\fP from jfindlay/2015.8
.IP \(bu 2
212f7dd281 add 2015.8.3 release notes
.IP \(bu 2
cafbb49cb6 add note on 2015.8.2 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29172\fP: (\fI\%basepi\fP) [2015.8] Backport new philips_hue proxy features from develop
@ \fI2015\-11\-24 23:52:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
5e88e9e9c0 Merge pull request \fI\%#29172\fP from basepi/philips_backport
.IP \(bu 2
1df6c3083b Backport new philips_hue proxy features from develop
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29167\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-11\-24 21:40:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
2fb1ca0eac Merge pull request \fI\%#29167\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
525f9fbbbb Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.IP \(bu 2
a26c10a811 Merge pull request \fI\%#29164\fP from jfindlay/bp\-29113
.INDENT 2.0
.IP \(bu 2
50fab35188 kill unneeded import
.UNINDENT
.IP \(bu 2
4f03196e7d Merge pull request \fI\%#29138\fP from jfindlay/2015.5
.INDENT 2.0
.IP \(bu 2
be045f5cb1 add 2015.5.8 release notes
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29141\fP: (\fI\%optix2000\fP) Add test case for require: sls with only import statements
@ \fI2015\-11\-24 16:17:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
68d6c454b8 Merge pull request \fI\%#29141\fP from optix2000/full_sls_import
.IP \(bu 2
596843e8d6 Add test case for sls with only import Tests \fI\%https://github.com/saltstack/salt/issues/10852\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29015\fP: (\fI\%jakehilton\fP) git_pillar not honoring git_pillar_base (refs: \fI\%#29072\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#28311\fP: (\fI\%strocknar\fP) git_pillar conflicts (refs: \fI\%#29072\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27432\fP: (\fI\%mafrosis\fP) Using specific tag as GitFS remote (refs: \fI\%#29072\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29072\fP: (\fI\%terminalmage\fP) Several gitfs/git_pillar fixes
@ \fI2015\-11\-24 16:04:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
732f5364a2 Merge pull request \fI\%#29072\fP from terminalmage/issue28311
.IP \(bu 2
dae738fda3 Use common code to detect envs
.IP \(bu 2
a9c0cacb77 Don\(aqt add head ref if head red matches desired ref
.IP \(bu 2
e7540e956b pygit2: Don\(aqt clean local heads along with stale remote refs
.IP \(bu 2
1e6c46f554 pygit2: Properly resolve base saltenv from tag ref
.IP \(bu 2
0c592ab552 Support string whitelist/blacklist
.IP \(bu 2
744487864d Fix base branch detection for git_pillar
.IP \(bu 2
1cd9a4d1b4 Add some debug logging for git_pillar
.IP \(bu 2
fac588c0bb Add HEAD ref in git_pillar/winrepo checkout
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29118\fP: (\fI\%ticosax\fP) [dockerng] Add networking capabilities
@ \fI2015\-11\-24 15:47:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
95689ee1a4 Merge pull request \fI\%#29118\fP from ticosax/dockerng\-network
.IP \(bu 2
e98d18ba41 Expose docker networking as state
.IP \(bu 2
94135d91c3 cosmetic
.IP \(bu 2
17ff5c1ab5 Add expose networking to modules.dockerng
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29144\fP: (\fI\%anlutro\fP) Error in fileclient with file.managed (refs: \fI\%#29145\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29145\fP: (\fI\%anlutro\fP) Remove duplicate import of salt.utils.s3
@ \fI2015\-11\-24 15:36:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
4b4f212d2d Merge pull request \fI\%#29145\fP from alprs/fix\-duplicate_import
.IP \(bu 2
e1101bea19 Remove duplicate import of salt.utils.s3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29147\fP: (\fI\%lomeroe\fP) boto_route53 unexpected keyword arguments in create_zone() (refs: \fI\%#29148\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29148\fP: (\fI\%lomeroe\fP) correcting parameter calls to boto get_zone/create_zone functions in …
@ \fI2015\-11\-24 15:33:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
6079569580 Merge pull request \fI\%#29148\fP from lomeroe/boto_route53_create_zone_fix\-backport
.IP \(bu 2
75408ccf99 correcting parameter calls to boto get_zone/create_zone functions in create_zone parameter check on create_zone on private_zone=True add boto version requirement
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29107\fP: (\fI\%lorengordon\fP) Salt hangs when passing a string representation as the \fIlength\fP parameter to \fIrandom.get_str()\fP (refs: \fI\%#29108\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29108\fP: (\fI\%lorengordon\fP) Enforce length as an int, fixes \fI\%#29107\fP
@ \fI2015\-11\-23 19:06:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
17638c734b Merge pull request \fI\%#29108\fP from lorengordon/type\-enforce\-length
.IP \(bu 2
c71825d3b0 Enforce length as an int, fixes \fI\%#29107\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29125\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-11\-23 18:48:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
233ab8a474 Merge pull request \fI\%#29125\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
1432cc806d Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
219367a23d Merge pull request \fI\%#29128\fP from cachedout/tweak_29122
.INDENT 2.0
.IP \(bu 2
b08858b040 Missed check
.IP \(bu 2
584efe81ee Set a safer default value for ret in saltmod
.UNINDENT
.UNINDENT
.IP \(bu 2
8d86bc3056 Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
2250a36647 Merge pull request \fI\%#29122\fP from cachedout/issue_29110
.INDENT 2.0
.IP \(bu 2
4b9302d794 Fix broken state orchestration
.UNINDENT
.IP \(bu 2
200e771efb Merge pull request \fI\%#29096\fP from rallytime/bp\-29093
.INDENT 2.0
.IP \(bu 2
f5734423a4 Compare gem versions as a string.
.UNINDENT
.IP \(bu 2
d8a2018bc8 Merge pull request \fI\%#29084\fP from rallytime/bp\-29055
.INDENT 2.0
.IP \(bu 2
52e650aed9 Add section to style guide
.UNINDENT
.IP \(bu 2
b5cff1a351 Merge pull request \fI\%#29083\fP from rallytime/bp\-29053
.INDENT 2.0
.IP \(bu 2
f1884de0e7 Update rabbitmq_user.py
.UNINDENT
.IP \(bu 2
b3e3bebef0 Merge pull request \fI\%#28932\fP from twangboy/fix_28928
.INDENT 2.0
.IP \(bu 2
0653a04887 Fixed user.present / user.absent in windows
.UNINDENT
.IP \(bu 2
a2e4a227e0 Merge pull request \fI\%#29011\fP from rallytime/bp\-28630
.INDENT 2.0
.IP \(bu 2
7baccc1b05 Lint \- newline before def
.IP \(bu 2
9e5c16d4da Reading S3 credentials from Pillar
.IP \(bu 2
a3216f813d Fixed requests HTTPError handler, it was still in urllib2 style
.UNINDENT
.IP \(bu 2
1a4cd6002f Merge pull request \fI\%#28982\fP from basepi/merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
bfbb109fbd Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
4b8bdd0afb Merge pull request \fI\%#28839\fP from cachedout/revert_28740
.IP \(bu 2
215b26c06f Revert \fI\%#28740\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29005\fP: (\fI\%fcrozat\fP) non\-standard umask breaks salt\-call call in salt\-ssh (refs: \fI\%#29126\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#28830\fP: (\fI\%fcrozat\fP) non\-standard umask breaks salt\-ssh deployement (refs: \fI\%#29126\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29126\fP: (\fI\%fcrozat\fP) Fix deployment when umask is non\-standard
@ \fI2015\-11\-23 17:53:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
dc0d47fa2e Merge pull request \fI\%#29126\fP from fcrozat/2015.8
.IP \(bu 2
4da11a5f3c Fix deployment when umask is non\-standard. Fixes \fI\%#29005\fP
.IP \(bu 2
bbccb752f9 Fix deployment when umask is non\-standard. Fixes \fI\%#28830\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29124\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28130\fP to 2015.8
@ \fI2015\-11\-23 17:31:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29120\fP: (\fI\%alexproca\fP) Import keypair (refs: \fI\%#29124\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28130\fP: (\fI\%bogdanr\fP) Ec2 upload public key and updated instances size list (refs: \fI\%#29124\fP)
.IP \(bu 2
994d8bd71a Merge pull request \fI\%#29124\fP from rallytime/bp\-28130
.IP \(bu 2
e290ea4a3f Pylint Fix
.IP \(bu 2
9d8e5c8b4d Added missing comma
.IP \(bu 2
4a7eee08a8 Documented import_keypair for the ec2 driver
.IP \(bu 2
715c12014c Added a bunch of instance sizes and updated some outdated ones
.IP \(bu 2
506ff01f65 Import public key
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29076\fP: (\fI\%RealKelsar\fP) We can\(aqt query installed use flags for a non installed pkg
@ \fI2015\-11\-23 16:19:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
d9c32011b4 Merge pull request \fI\%#29076\fP from RealKelsar/2015.8
.IP \(bu 2
f3d1ba1509 We can\(aqt query installed use flags for a non installed pkg. Also one if is enough...
.IP \(bu 2
96566d3060 We can\(aqt query installed use flags for a non installed pkg
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29100\fP: (\fI\%quantonganh\fP) boto_ec2.exists does not use region when checking? (refs: \fI\%#29070\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29097\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29070\fP to 2015.8
@ \fI2015\-11\-22 17:03:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29070\fP: (\fI\%quantonganh\fP) boto_ec2: missing region when checking existence of an EC2 instance (refs: \fI\%#29097\fP)
.IP \(bu 2
1931870f26 Merge pull request \fI\%#29097\fP from rallytime/bp\-29070
.IP \(bu 2
3b202efadc boto_ec2: missing region when checking existence of an EC2 instance
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29090\fP: (\fI\%gtmanfred\fP) clean up novaclient module
@ \fI2015\-11\-21 15:43:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb28b9186b Merge pull request \fI\%#29090\fP from gtmanfred/2015.8
.IP \(bu 2
2aab45f9d2 clean up novaclient module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29095\fP: (\fI\%terminalmage\fP) Add warning about pygit2 API instability
@ \fI2015\-11\-21 15:38:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ff54c6429 Merge pull request \fI\%#29095\fP from terminalmage/pygit2\-warning
.IP \(bu 2
139f5ba4c3 Add warning about pygit2 API instability
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28919\fP: (\fI\%cro\fP) Update Philips Hue proxy minion to support __proxy__ instead of proxymodule stored in __opts__
@ \fI2015\-11\-21 15:31:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
27160b0454 Merge pull request \fI\%#28919\fP from cro/hue_proxy_backport
.IP \(bu 2
8823225c81 Add \(aqversionadded\(aq
.IP \(bu 2
6bdf98d2c6 Backport philips_hue proxy module to 2015.8, use __proxy__ instead of opts[\(aqproxymodule\(aq]
.IP \(bu 2
0945d3b5b2 Add the license
.IP \(bu 2
a8be2d7382 Fix the docstring
.IP \(bu 2
13a8973f94 Validate if \(dqrequests\(dq are around. NOTE: this will be changed soon!
.IP \(bu 2
835e84181b Fix the documentation
.IP \(bu 2
68accf6180 Allow view status from all lamps, if not specified
.IP \(bu 2
96adc9cca9 Fix lint issues
.IP \(bu 2
cd00c5d99f Remove dead code
.IP \(bu 2
6a08d2b6b5 Implement static grains for the Philips HUE
.IP \(bu 2
5d3c3e09fc Bugfix: show all devices, if no specific IDs were passed
.IP \(bu 2
76e86d2d7d Implement color temperature
.IP \(bu 2
a2d87a18cc Fix the documentation
.IP \(bu 2
adeecb49d4 Implement brightness
.IP \(bu 2
a2b1a71e01 Fix crash if the controller is down
.IP \(bu 2
a7d5aafbe3 Update documentation for the color settings
.IP \(bu 2
15f83e180d Add more preset colors
.IP \(bu 2
44339f3dc1 Implement color setter with transition
.IP \(bu 2
0f4d5b9eac Implement effects method
.IP \(bu 2
f341910174 Implement alert function
.IP \(bu 2
e0c95b4c7f Separate device (lamps) getter
.IP \(bu 2
37ed834a63 Implement lamp rename
.IP \(bu 2
66b155c3db Enhance _set method so it can set more than just lights status
.IP \(bu 2
8e94aad5c1 Enhance internal ping report on failures (device is not reachable)
.IP \(bu 2
3bf79e6920 Implement blink function
.IP \(bu 2
334371d660 Use blink on internal ping
.IP \(bu 2
a8e4c2162c Fix bug: call in a proper order, if all devices
.IP \(bu 2
a98d5187f8 Remove the debug
.IP \(bu 2
a1244223bf Enhance switch method
.IP \(bu 2
e902764e25 Switch all lamps if IDs are not passed
.IP \(bu 2
1e508e9155 Fix bug: crash, if only one lamp ID is passed
.IP \(bu 2
c0e6706d9a Implement status
.IP \(bu 2
6d8e6d6e23 Fix lint
.IP \(bu 2
db053fbd8b Add licence
.IP \(bu 2
2abdb19934 Implement proxy minion configuration
.IP \(bu 2
1a75be3f71 Cleanup code
.IP \(bu 2
1a46a180bc Implement light switch ON/OFF
.IP \(bu 2
cc5ee382c5 Implement lights method.
.IP \(bu 2
bfbe4160b2 Add constants class\-struct
.IP \(bu 2
7a8d72de3f Implement device state change
.IP \(bu 2
d769bc85a7 Implement available device listing
.IP \(bu 2
c9e7f4dc18 Cleanup code
.IP \(bu 2
5503b6f20e Implement Philips HUE wrapper caller for Minion Proxy
.IP \(bu 2
1b11d1ec74 Initial implementation of Philips HUE proxy
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28810\fP: (\fI\%syedaali\fP) test.ping is not available (refs: \fI\%#29065\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#28761\fP: (\fI\%syedaali\fP) Numerous module import errors in /var/log/salt/minion (test,oracle,archive) (refs: \fI\%#29065\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#25756\fP: (\fI\%nshalman\fP) Esky builds on SmartOS broken in 2015.5 branch (refs: \fI\%#25946\fP, \fI\%#25923\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29065\fP: (\fI\%cachedout\fP) Handle failures inside python\(aqs inspect if a module is reloaded
@ \fI2015\-11\-20 18:10:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25946\fP: (\fI\%sjorge\fP) Fix for salt.utils.decorators under esky (refs: \fI\%#29065\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25923\fP: (\fI\%sjorge\fP) Fix for salt.utils.decorators and module.__name__ under esky (refs: \fI\%#25946\fP)
.IP \(bu 2
88c0354c0c Merge pull request \fI\%#29065\fP from cachedout/issue_28810
.IP \(bu 2
4767503eb2 Remove trailing whitespace
.IP \(bu 2
c5b667f048 Handle failures inside python\(aqs inspect if a module is reloaded
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29057\fP: (\fI\%paulnivin\fP) Add local file support for file.managed source list
@ \fI2015\-11\-19 21:57:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
714ef8ff27 Merge pull request \fI\%#29057\fP from lyft/file\-manage\-local\-source\-list
.IP \(bu 2
3d7aa19cd8 Support local files in list of sources
.IP \(bu 2
d175061c5d Add tests for file.source_list with local files
.IP \(bu 2
4f8e2a30fe Update documentation to clarify URL support for lists of sources with file.managed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28981\fP: (\fI\%mimianddaniel\fP) 2015.8.2 import pagerduty error  (refs: \fI\%#29017\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29017\fP: (\fI\%jfindlay\fP) pagerduty runner: add missing salt.utils import
@ \fI2015\-11\-19 19:28:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
f4f43381fc Merge pull request \fI\%#29017\fP from jfindlay/pager_util
.IP \(bu 2
5cc06207fe pagerduty runner: add missing salt.utils import
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29039\fP: (\fI\%anlutro\fP) Allow passing list of pip packages to virtualenv.managed
@ \fI2015\-11\-19 19:13:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
1c61bce0a6 Merge pull request \fI\%#29039\fP from alprs/feature\-virtualenv_pip_pkgs
.IP \(bu 2
f9bff51382 allow passing list of pip packages to virtualenv.managed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29047\fP: (\fI\%schwing\fP) Fix salt.modules.gpg.import_key exception: \(aqGPG_1_3_1 referenced before assignment\(aq
@ \fI2015\-11\-19 19:07:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
b692ab1cfb Merge pull request \fI\%#29047\fP from schwing/fix\-gpg\-exception
.IP \(bu 2
813f6e6808 Fix \(aqGPG_1_3_1 referenced before assignment\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29050\fP: (\fI\%terminalmage\fP) Make git_pillar global config option docs more prominent
@ \fI2015\-11\-19 19:06:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
b4fc2f28a4 Merge pull request \fI\%#29050\fP from terminalmage/issue29015
.IP \(bu 2
20da057a94 Make git_pillar global config option docs more prominent
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29048\fP: (\fI\%nmadhok\fP) Fix incorrect debug log statement
@ \fI2015\-11\-19 19:04:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
4b3b2fe1e7 Merge pull request \fI\%#29048\fP from nmadhok/patch\-1
.IP \(bu 2
9489d6c3b6 Update vmware.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29024\fP: (\fI\%jfindlay\fP) cache runner test: add new unit tests
@ \fI2015\-11\-19 19:02:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
e52c117368 Merge pull request \fI\%#29024\fP from jfindlay/run_test
.IP \(bu 2
0c0bce3ea6 cache runner test: add new unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28967\fP: (\fI\%cro\fP) Fix some issues with password changes
@ \fI2015\-11\-19 18:57:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
bcec8d8608 Merge pull request \fI\%#28967\fP from cro/fx2_switch
.IP \(bu 2
67b5b9b8d2 Add docs on automatic lockout on failed auth attempts.
.IP \(bu 2
8a3cea4d95 Lint.
.IP \(bu 2
04095e3b74 Prevent stacktrace if something goes wrong retrieving inventory
.IP \(bu 2
e7cbce15a5 Don\(aqt need to get grains at init time here now that we are confirming username and password differently.
.IP \(bu 2
e42100cf8a Switch from admin_password and fallback_admin_password to a list of passwords to try.
.IP \(bu 2
4b382e977d Add \(aqversionadded\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#8516\fP: (\fI\%xoJIog\fP) salt\-ssh not working with nodegroups and lists (refs: \fI\%#29020\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29020\fP: (\fI\%basepi\fP) [2015.8] Add special list\-only nodegroup support to salt\-ssh
@ \fI2015\-11\-18 21:15:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
14b5d0ed0f Merge pull request \fI\%#29020\fP from basepi/salt\-ssh.nodegroups.8516
.IP \(bu 2
6433abf36f Rename ssh_nodegroups to ssh_list_nodegroups
.IP \(bu 2
bd8487b3b9 Properly save minion list in local_cache for ssh jobs
.IP \(bu 2
4b1bf7d5e2 Add support for comma separated list matching in salt\-ssh
.IP \(bu 2
65c6528cbc Add \(dqnodegroup\(dq matching to salt\-ssh
.IP \(bu 2
688a78c08c Add new ssh_nodegroups config
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28911\fP: (\fI\%ccmills\fP) GitFS numeric tags cause errors with environments (refs: \fI\%#28970\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28970\fP: (\fI\%terminalmage\fP) Properly handle non\-string saltenvs
@ \fI2015\-11\-18 20:38:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
89801b172a Merge pull request \fI\%#28970\fP from terminalmage/issue28911
.IP \(bu 2
ec64ec85d6 Force file_roots environments to be strings
.IP \(bu 2
b2690140c7 Properly handle non\-string saltenvs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28945\fP: (\fI\%rallytime\fP) Dell Chassis State Example Improvements (refs: \fI\%#28959\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28959\fP: (\fI\%rallytime\fP) Add blade password example and make note of timeout
@ \fI2015\-11\-18 19:39:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
83c54351c9 Merge pull request \fI\%#28959\fP from rallytime/fix\-28945
.IP \(bu 2
2f326b57bf Clarify chassis password functionality
.IP \(bu 2
3614a88811 Add blade password example and make note of timeout
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29000\fP: (\fI\%kiorky\fP) [Mergeable] Fix up LXC
@ \fI2015\-11\-18 18:02:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
d8dc81bb2c Merge pull request \fI\%#29000\fP from kiorky/2015.8_lxc
.IP \(bu 2
a4d197821a LXC: doc
.IP \(bu 2
43fb0eff02 lxc: remove useless and error prone uses_systemd knob
.IP \(bu 2
7ec08cd41c Fix bootstrap delay kwarg exchange
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28995\fP: (\fI\%timcharper\fP) systemd.get_all broken on non\-bsd systems / salt\-bootstrap failure (refs: \fI\%#29014\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29014\fP: (\fI\%jfindlay\fP) systemd module: remove unneeded col command
@ \fI2015\-11\-18 17:58:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
eedd50e7c3 Merge pull request \fI\%#29014\fP from jfindlay/sysctl_col
.IP \(bu 2
d75e4d5d21 systemd module: line wrap function comment
.IP \(bu 2
960d2b936d systemd module: remove unneeded col command
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28983\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-11\-18 00:49:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
ac85cfdbd0 Merge pull request \fI\%#28983\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
f1c80ab943 Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.IP \(bu 2
edd26d763a Merge pull request \fI\%#28949\fP from whiteinge/sync\-sdb
.INDENT 2.0
.IP \(bu 2
b0ec9ab25b Add sync_sdb execution function
.UNINDENT
.IP \(bu 2
43da1bc4ce Merge pull request \fI\%#28930\fP from twangboy/fix_28888
.INDENT 2.0
.IP \(bu 2
f5c489eaad Added missing import mmap required by file.py
.UNINDENT
.IP \(bu 2
2488b873b8 Merge pull request \fI\%#28908\fP from rallytime/doc\-convention\-spelling
.INDENT 2.0
.IP \(bu 2
60e6eddb77 A couple of spelling fixes for doc conventions page.
.UNINDENT
.IP \(bu 2
827a1ae020 Merge pull request \fI\%#28902\fP from whiteinge/json\-keys
.INDENT 2.0
.IP \(bu 2
9745903301 Fix missing JSON support for /keys endpoint
.UNINDENT
.IP \(bu 2
d23bd49130 Merge pull request \fI\%#28897\fP from rallytime/bp\-28873
.INDENT 2.0
.IP \(bu 2
077e671ead Fix salt\-cloud help output typo
.UNINDENT
.IP \(bu 2
a9dc8b6ca6 Merge pull request \fI\%#28871\fP from basepi/mdadm.fix.28870
.INDENT 2.0
.IP \(bu 2
323bc2d2ac Fix command generation for mdadm.assemble
.UNINDENT
.IP \(bu 2
ec7fdc539b Merge pull request \fI\%#28864\fP from jfindlay/2015.5
.INDENT 2.0
.IP \(bu 2
648b697951 add 2015.5.7 release notes
.UNINDENT
.IP \(bu 2
bed45f4208 Merge pull request \fI\%#28731\fP from garethgreenaway/27392_2015_5_scheduler_return_job_master
.INDENT 2.0
.IP \(bu 2
771e9f7b6f Fixing the salt scheduler so that it only attempts to return the job data to the master if the scheduled job is running from a minion\(aqs scheduler.
.UNINDENT
.IP \(bu 2
06f4932876 Merge pull request \fI\%#28857\fP from rallytime/bp\-28851
.INDENT 2.0
.IP \(bu 2
aa4b193f87 [states/schedule] docstring: args, kwargs \-> job_args, job_kwargs
.UNINDENT
.IP \(bu 2
0934a52b34 Merge pull request \fI\%#28856\fP from rallytime/bp\-28853
.IP \(bu 2
37eeab2683 Typo (with → which)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28969\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28825\fP to 2015.8
@ \fI2015\-11\-17 20:43:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28825\fP: (\fI\%s0undt3ch\fP) Take into account a pygit2 bug (refs: \fI\%#28969\fP)
.IP \(bu 2
f172a0ee03 Merge pull request \fI\%#28969\fP from rallytime/bp\-28825
.IP \(bu 2
40f4ac5b21 Add missing import
.IP \(bu 2
2c43da1578 Take into account a pygit2 bug
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28784\fP: (\fI\%chrigl\fP) iptables.get_saved_rules tests pretty much useless (refs: \fI\%#28787\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#28783\fP: (\fI\%chrigl\fP) iptables.get_saved_rules does not handle family=ipv6 (refs: \fI\%#28787\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28787\fP: (\fI\%chrigl\fP) closes \fI\%#28784\fP
@ \fI2015\-11\-17 15:54:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
1e9214f4e4 Merge pull request \fI\%#28787\fP from chrigl/fix\-28784
.IP \(bu 2
8639e3e9c3 closes \fI\%#28784\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28944\fP: (\fI\%rallytime\fP) The ret result must contain \(aqname\(aq, not \(aqchassis_name\(aq for the state compiler.
@ \fI2015\-11\-17 15:34:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
d63344575a Merge pull request \fI\%#28944\fP from rallytime/dellchassis\-state\-name\-fix
.IP \(bu 2
f3ea01bbfa Make sure dellchassis.blade_idrac has a name arg and a ret[\(aqname\(aq]
.IP \(bu 2
fb718539e9 The ret result must contain \(aqname\(aq, not \(aqchassis_name\(aq for the state compiler
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28957\fP: (\fI\%terminalmage\fP) Fix version number for new state option
@ \fI2015\-11\-17 15:33:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
fcef9f8995 Merge pull request \fI\%#28957\fP from terminalmage/fix\-docstring
.IP \(bu 2
f159000de2 Fix version number for new state option
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28950\fP: (\fI\%DmitryKuzmenko\fP) PR 28812 which test fix
@ \fI2015\-11\-17 15:32:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28812\fP: (\fI\%isbm\fP) Enhance \(aqwhich\(aq decorator reliability (refs: \fI\%#28950\fP)
.IP \(bu 2
5b680c938a Merge pull request \fI\%#28950\fP from DSRCompany/pr/28812_which
.IP \(bu 2
18571000c5 Fix which test in PR\(ga#28812\(ga_
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28812\fP: (\fI\%isbm\fP) Enhance \(aqwhich\(aq decorator reliability (refs: \fI\%#28950\fP)
@ \fI2015\-11\-17 15:32:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
73719928f9 Merge pull request \fI\%#28812\fP from isbm/isbm\-which\-decorator\-enhancement
.IP \(bu 2
20033eeeb7 Save modified environment path
.IP \(bu 2
2d43199d20 Preserve \(aqfirst found first win\(aq ordering
.IP \(bu 2
1c59eedec2 Enhance \(aqwhich\(aq decorator reliability for peculiar environments
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28934\fP: (\fI\%terminalmage\fP) git.latest: Add update_head option to prevent local HEAD from being updated
@ \fI2015\-11\-17 15:15:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
facc34efed Merge pull request \fI\%#28934\fP from terminalmage/issue27883
.IP \(bu 2
6a35a39ca5 Add update_head option to git.latest
.IP \(bu 2
3787f7ed00 Change return output of git.fetch to a dict
.IP \(bu 2
9ca0f8f440 Add redirect_stderr argument to cmd.run_all
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28937\fP: (\fI\%rallytime\fP) Update dellchassis state example to use correct jinja syntax
@ \fI2015\-11\-17 15:12:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
7da93aad5b Merge pull request \fI\%#28937\fP from rallytime/chassis\-doc\-fix
.IP \(bu 2
d53713ddba We only need one fancy pillar example to match our state.
.IP \(bu 2
e2926b1996 Update dellchassis state example to use correct jinja syntax
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27961\fP: (\fI\%ahammond\fP) aggregate: False should disable aggregation even when state_aggregate: True enabled (refs: \fI\%#28889\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28889\fP: (\fI\%jfindlay\fP) state compiler: relax aggregate conditional check
@ \fI2015\-11\-16 17:39:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
16ebda999e Merge pull request \fI\%#28889\fP from jfindlay/aggregate
.IP \(bu 2
eb9970019a state compiler: relax aggregate conditional check
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24803\fP: (\fI\%cachedout\fP) Rewrite GPG renderer tests (refs: \fI\%#25470\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28921\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25470\fP to 2015.8
@ \fI2015\-11\-16 17:38:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25470\fP: (\fI\%jfindlay\fP) \fI\%#24314\fP with tests (refs: \fI\%#28921\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24314\fP: (\fI\%cedwards\fP) refactor gpg renderer; removing dependency on python\-gnupg (refs: \fI\%#28921\fP, \fI\%#25470\fP)
.IP \(bu 2
91a327bbce Merge pull request \fI\%#28921\fP from rallytime/bp\-25470
.IP \(bu 2
a5eee74c20 Change Beryllium to 2015.8.3 release
.IP \(bu 2
5ce61abf57 rewrite GPG unit tests
.IP \(bu 2
7aa424209e reduce globals in GPG renderer for easier testing
.IP \(bu 2
de5b6682ef log error and return ciphered txt on decrypt error
.IP \(bu 2
6afb344fe3 updated logic to properly detect GPG_KEYDIR path
.IP \(bu 2
bc9750b85e refactor gpg renderer; removing dependency on python\-gnupg
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28922\fP: (\fI\%rallytime\fP) Change 2015.8.2 release note title to reflect proper version
@ \fI2015\-11\-16 16:47:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
3707eb1e7c Merge pull request \fI\%#28922\fP from rallytime/release\-notes\-ver
.IP \(bu 2
61029f8db1 Change 2015.8.2 release note title to reflect proper version
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23971\fP: (\fI\%dumol\fP) Problems disabling a service in SLES11 SP3. (refs: \fI\%#28891\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28891\fP: (\fI\%jfindlay\fP) rh_service module: fix logic in _chkconfig_is_enabled
@ \fI2015\-11\-16 02:44:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
23eae0d9e0 Merge pull request \fI\%#28891\fP from jfindlay/chkconfig_check
.IP \(bu 2
e32a9aab85 rh_service._chkconfig_is_enabled unit tests
.IP \(bu 2
5a93b7e53c rh_service module: fix logic in _chkconfig_is_enabled
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24019\fP: (\fI\%dumol\fP) SUSE Linux Enterprise Server 11 SP3 not detected as SLES. (refs: \fI\%#28892\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28892\fP: (\fI\%jfindlay\fP) grains.core: correctly identify SLES 11 distrib_id
@ \fI2015\-11\-16 02:30:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
8e6acd97ae Merge pull request \fI\%#28892\fP from jfindlay/sles_grain
.IP \(bu 2
1cfdc500c9 grains.core: correctly identify SLES 11 distrib_id
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28910\fP: (\fI\%lorengordon\fP) Fix winrepo command in windows pkg mgmt doc
@ \fI2015\-11\-16 02:29:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
cf929c3847 Merge pull request \fI\%#28910\fP from lorengordon/patch\-1
.IP \(bu 2
64655398b3 Fix winrepo command in windows pkg mgmt doc
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28896\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28855\fP to 2015.8
@ \fI2015\-11\-15 00:43:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28855\fP: (\fI\%tampakrap\fP) fix the os grain in sle11sp4 to be SUSE instead of SLES (refs: \fI\%#28896\fP)
.IP \(bu 2
7a4fb9a790 Merge pull request \fI\%#28896\fP from rallytime/bp\-28855
.IP \(bu 2
baf238f270 fix the os grain in sle11sp4 to be SUSE instead of SLES
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28895\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28823\fP to 2015.8
@ \fI2015\-11\-15 00:43:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28823\fP: (\fI\%tampakrap\fP) Add support for priority and humanname in pkrepo zypper backend (refs: \fI\%#28895\fP)
.IP \(bu 2
64dc3c23e0 Merge pull request \fI\%#28895\fP from rallytime/bp\-28823
.IP \(bu 2
d167a6b83d Add support for priority and humanname in pkrepo zypper backend
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28754\fP: (\fI\%kt97679\fP) service.enabled fails on xen server (refs: \fI\%#28885\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28885\fP: (\fI\%kt97679\fP) fix for: service.enabled fails on xen server \fI\%#28754\fP
@ \fI2015\-11\-14 04:55:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
a45ce78e20 Merge pull request \fI\%#28885\fP from kt97679/2015.8
.IP \(bu 2
7d0f1f11cb fix for: service.enabled fails on xen server \fI\%#28754\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28880\fP: (\fI\%terminalmage\fP) Add \(dqprofile\(dq loglevel
@ \fI2015\-11\-14 02:07:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
58b57e77be Merge pull request \fI\%#28880\fP from terminalmage/profile\-logging
.IP \(bu 2
a62852d407 Add @wraps decorator
.IP \(bu 2
cac9f17307 Add profile logging for template rendering
.IP \(bu 2
c625725f70 Add decorator to do profile\-level logging for a function
.IP \(bu 2
5a2b94ce39 Add \(dqprofile\(dq loglevel
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28881\fP: (\fI\%basepi\fP) salt\-ssh stacktraces on first run (refs: \fI\%#28882\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28882\fP: (\fI\%basepi\fP) [2015.8] salt\-ssh: Check return type to make sure it\(aqs an error
@ \fI2015\-11\-14 00:14:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
5dc7fccb07 Merge pull request \fI\%#28882\fP from basepi/salt\-ssh.stacktrace.28881
.IP \(bu 2
f1a1cad607 Check return type to make sure it\(aqs actually an error
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28867\fP: (\fI\%rallytime\fP) [fx2 grains] Grains functions should return dictionaries
@ \fI2015\-11\-13 21:14:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
430e9376f6 Merge pull request \fI\%#28867\fP from rallytime/fx2\-grains\-patch
.IP \(bu 2
022cf5d230 [fx2 grains] Grains functions should return dictionaries
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28859\fP: (\fI\%mhoogendoorn\fP) ebuild.install runs \fIrefresh_db()\fP when \fIrefresh=False\fP is given. (refs: \fI\%#28863\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28863\fP: (\fI\%mhoogendoorn\fP) Fix ebuild.install causing extra refresh_db calls.
@ \fI2015\-11\-13 18:46:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
304072456e Merge pull request \fI\%#28863\fP from mhoogendoorn/fix\-issue\-28859
.IP \(bu 2
eca09b89a4 Fix ebuild.install causing extra refresh_db calls.
.UNINDENT
.UNINDENT
.SS Salt 2015.8.4 Release Notes
.sp
Version 2015.8.4 is a bugfix release for \fI\%2015.8.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB322\fP
.IP \(bu 2
Total Issue References: \fB120\fP
.IP \(bu 2
Total PR References: \fB312\fP
.IP \(bu 2
Contributors: \fB78\fP (\fI\%AkhterAli\fP, \fI\%DmitryKuzmenko\fP, \fI\%MadsRC\fP, \fI\%Oro\fP, \fI\%The\-Loeki\fP,
\fI\%abednarik\fP, \fI\%akissa\fP, \fI\%anlutro\fP, \fI\%basepi\fP, \fI\%bastiaanb\fP, \fI\%bdrung\fP, \fI\%borgstrom\fP,
\fI\%cachedout\fP, \fI\%clan\fP, \fI\%clinta\fP, \fI\%cournape\fP, \fI\%cro\fP, \fI\%ctrlrsf\fP, \fI\%dmacvicar\fP, \fI\%dmurphy18\fP,
\fI\%dnd\fP, \fI\%dr4Ke\fP, \fI\%eliasp\fP, \fI\%fcrozat\fP, \fI\%frioux\fP, \fI\%galet\fP, \fI\%garethgreenaway\fP, \fI\%gqgunhed\fP,
\fI\%gtmanfred\fP, \fI\%hexedpackets\fP, \fI\%isbm\fP, \fI\%jacksontj\fP, \fI\%jacobhammons\fP, \fI\%jfindlay\fP, \fI\%jleimbach\fP,
\fI\%job\fP, \fI\%joejulian\fP, \fI\%julianbrost\fP, \fI\%justinta\fP, \fI\%kingsquirrel152\fP, \fI\%kiorky\fP, \fI\%l2ol33rt\fP,
\fI\%lagesag\fP, \fI\%lorengordon\fP, \fI\%mbarrien\fP, \fI\%mpreziuso\fP, \fI\%multani\fP, \fI\%nmadhok\fP, \fI\%oeuftete\fP,
\fI\%opdude\fP, \fI\%optix2000\fP, \fI\%pass\-by\-value\fP, \fI\%paulnivin\fP, \fI\%plastikos\fP, \fI\%pritambaral\fP,
\fI\%rallytime\fP, \fI\%rasathus\fP, \fI\%rmatulat\fP, \fI\%ruxandraburtica\fP, \fI\%ryan\-lane\fP, \fI\%s0undt3ch\fP,
\fI\%seanjnkns\fP, \fI\%serge\-p\fP, \fI\%sjorge\fP, \fI\%stanislavb\fP, \fI\%tbaker57\fP, \fI\%techhat\fP, \fI\%terminalmage\fP,
\fI\%thatch45\fP, \fI\%thegoodduke\fP, \fI\%thomaso\-mirodin\fP, \fI\%ticosax\fP, \fI\%timcharper\fP, \fI\%tkunicki\fP,
\fI\%trevor\-h\fP, \fI\%twangboy\fP, \fI\%whiteinge\fP, \fI\%whytewolf\fP)
.UNINDENT
.SS Known Issues
.INDENT 0.0
.IP \(bu 2
\fB*_in\fP requisites (\fI\%issue 30820\fP)
.sp
This issue affects all users targeting an explicit \fB\- name: <name>\fP with a
\fB_in\fP requisite (such as \fBwatch_in\fP or \fBrequire_in\fP). If you are not
using explicit \fB\- name: <name>\fP arguments, are targeting with the state ID
instead of the name, or are not using \fB_in\fP requisites, then you should be
safe to upgrade to 2015.8.4.
.sp
This issue is resolved in the \fI\%2015.8.5\fP release.
.UNINDENT
.SS Security Fix
.sp
\fBCVE\-2016\-1866\fP Improper handling of clear messages on the minion, which
could result in executing commands not sent by the master.
.sp
This issue affects only the 2015.8.x releases of Salt. In order for an attacker
to use this attack vector, they would have to execute a successful attack on an
existing TCP connection between minion and master on the pub port. It does not
allow an external attacker to obtain the shared secret or decrypt any encrypted
traffic between minion and master. Thank you to Sebastian Krahmer
<\fI\%krahmer@suse.com\fP> for bringing this issue to our attention.
.sp
We recommend everyone upgrade to 2015.8.4 as soon as possible.
.SS Core Changes
.INDENT 0.0
.IP \(bu 2
Support for IAM roles added to S3 module
.IP \(bu 2
Added option \fBmock=True\fP for \fI\%state.sls\fP
and \fI\%state.highstate\fP\&. This allows
the state compiler to process sls data in a state run without actually
calling the state functions, thus providing feedback on the validity of the
arguments used for the functions beyond the preprocessing validation provided
by \fI\%state.show_sls\fP (\fI\%issue 30118\fP
and \fI\%issue 30189\fP).
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.sls core,edit.vim mock=True
salt \(aq*\(aq state.highstate mock=True
salt \(aq*\(aq state.apply edit.vim mock=True
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Changelog for v2015.8.3..v2015.8.4
.sp
\fIGenerated at: 2018\-05\-27 23:28:18 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#30615\fP: (\fI\%jfindlay\fP) add 2015.8.4 release notes
@ \fI2016\-01\-25 18:11:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
1c6c394d0e Merge pull request \fI\%#30615\fP from jfindlay/2015.8
.IP \(bu 2
e4043403e4 add 2015.8.4 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30612\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29940\fP to 2015.8
@ \fI2016\-01\-25 17:52:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29940\fP: (\fI\%dr4Ke\fP) file.line: better diff (refs: \fI\%#30612\fP)
.IP \(bu 2
ec50581aad Merge pull request \fI\%#30612\fP from rallytime/bp\-29940
.IP \(bu 2
3ebb8249d7 file.line: better diff
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30613\fP: (\fI\%basepi\fP) Fix minion/syndic clearfuncs
@ \fI2016\-01\-25 17:40:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
48373e0ea9 Merge pull request \fI\%#30613\fP from basepi/minion_clearfuncs_2015.8
.IP \(bu 2
a3c3182f39 Correctly handle clearfuncs on the syndic
.IP \(bu 2
098ce4335d Correct handle clearfuncs on the minion
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29601\fP: (\fI\%seanjnkns\fP) pillars not merging properly with 2015.8.3 (refs: \fI\%#30062\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30609\fP: (\fI\%seanjnkns\fP) Fix documentation for pillar_merge_lists which default is False, not …
@ \fI2016\-01\-25 17:15:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30062\fP: (\fI\%seanjnkns\fP) Remove recurse_list from pillar_source_merging_strategy and add pilla… (refs: \fI\%#30609\fP, \fI\%#30458\fP)
.IP \(bu 2
89b4f3de1b Merge pull request \fI\%#30609\fP from seanjnkns/backport_30602
.IP \(bu 2
9924acdc43 Fix documentation for pillar_merge_lists which default is False, not True.  From PR \fI\%#30062\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30584\fP: (\fI\%julianbrost\fP) file.line state: add missing colon in docstring
@ \fI2016\-01\-25 16:37:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
24ead62c41 Merge pull request \fI\%#30584\fP from julianbrost/fix\-doc\-file\-line\-missing\-colon
.IP \(bu 2
2ab367f95b file.line state: add missing colon in docstring
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30589\fP: (\fI\%terminalmage\fP) Merge 2015.5 into 2015.8
@ \fI2016\-01\-25 16:20:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
a7ba2df5e2 Merge pull request \fI\%#30589\fP from terminalmage/2015.5\-2015.8
.IP \(bu 2
d649551fbf Merge branch \(aq2015.5\(aq into 2015.5\-2015.8
.INDENT 2.0
.IP \(bu 2
a823e21428 Merge pull request \fI\%#30582\fP from terminalmage/dnf\-repoquery\-multiple\-targets
.INDENT 2.0
.IP \(bu 2
410da789f9 yumpkg.check_db: run separate repoquery commands when multiple names passed
.UNINDENT
.IP \(bu 2
8e56be7f4c Merge pull request \fI\%#30548\fP from jacobhammons/doc\-fixes
.INDENT 2.0
.IP \(bu 2
03c51bb54d Added placeholder release notes for 2015.5.10 Changed old doc links from docs.saltstack.org to docs.saltproject.io
.UNINDENT
.IP \(bu 2
1aafd4c5b5 Merge pull request \fI\%#30530\fP from terminalmage/yumpkg\-dnf\-cleanup
.INDENT 2.0
.IP \(bu 2
2586f71bcf 2015.5 tweaks from \fI\%#30529\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30599\fP: (\fI\%multani\fP) Documentation formatting fixes
@ \fI2016\-01\-25 15:37:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a55d11916 Merge pull request \fI\%#30599\fP from multani/fix/docs
.IP \(bu 2
038ecc4acd For doc formatting of salt.states.module
.IP \(bu 2
4062c63b9f Fix doc formatting for yaml_idiosyncrasies
.IP \(bu 2
6efb77bc04 Fix doc formatting of salt.modules.parted
.IP \(bu 2
a329adfb21 Add missing salt.queues.* documentation
.IP \(bu 2
2465cf4ba5 Remove non\-existing documentation
.IP \(bu 2
814e64c304 Fix documentation markup in salt.modules.osquery
.IP \(bu 2
d2614d6169 Fix documentation markup for salt.modules.ipmi
.IP \(bu 2
276eb3a843 Fix GCE documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#10157\fP: (\fI\%martinb3\fP) salt\-cloud actions don\(aqt have very useful error messages (refs: \fI\%#30554\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30554\fP: (\fI\%rallytime\fP) Make the salt\-cloud actions output more verbose and helpful
@ \fI2016\-01\-22 20:23:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
b1e604add3 Merge pull request \fI\%#30554\fP from rallytime/fix\-10157
.IP \(bu 2
6fa952f16d Make the salt\-cloud actions output more verbose and helpful
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30549\fP: (\fI\%techhat\fP) Salt Virt cleanup
@ \fI2016\-01\-22 18:45:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
2eb5a3803d Merge pull request \fI\%#30549\fP from techhat/virtcleanup
.IP \(bu 2
9baab73cd0 Fix copy pasta
.IP \(bu 2
6413c11f29 Salt Virt cleanup
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30553\fP: (\fI\%techhat\fP) AWS: Support 17\-character IDs
@ \fI2016\-01\-22 18:41:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
f63b183e43 Merge pull request \fI\%#30553\fP from techhat/awsid
.IP \(bu 2
a95fbff4bc Support 17\-character IDs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30532\fP: (\fI\%whiteinge\fP) Add execution module for working in sls files
@ \fI2016\-01\-22 17:25:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
05d05263ab Merge pull request \fI\%#30532\fP from whiteinge/slsutil\-mod
.IP \(bu 2
a57d9984e4 Add slsutil to doc index
.IP \(bu 2
155966c9d2 Add execution module for working in sls files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30529\fP: (\fI\%terminalmage\fP) Merge 2015.5 into 2015.8 (refs: \fI\%#30530\fP)
@ \fI2016\-01\-22 17:19:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
1da1bb9afc Merge pull request \fI\%#30529\fP from terminalmage/2015.5\-2015.8
.IP \(bu 2
e85ad690fb Lint fixes
.IP \(bu 2
43829ecee6 Docstring tweaks
.IP \(bu 2
92d5a2a49c Fix spelling
.IP \(bu 2
fdc60fc04a Modify pkg.group_installed to reflect changes in yumpkg.py
.IP \(bu 2
a118eb5d2e Merge branch \(aq2015.5\(aq into 2015.5\-2015.8
.IP \(bu 2
7798d42272 Merge pull request \fI\%#30484\fP from terminalmage/dnf\-yumpkg\-2015.5
.INDENT 2.0
.IP \(bu 2
330e26d1da Hide get_locked_packages
.IP \(bu 2
5a637420e8 Backport DNF support to 2015.5 branch
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30526\fP: (\fI\%twangboy\fP) Added FlushKey to make sure its changes are saved to disk
@ \fI2016\-01\-22 02:33:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
e366f6a7fd Merge pull request \fI\%#30526\fP from twangboy/reg_flushkey
.IP \(bu 2
23085ffbbb Added FlushKey to make sure its changes are saved to disk
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30521\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-01\-21 23:05:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
cdc731b8c5 Merge pull request \fI\%#30521\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
f22f5ff851 Fix lint
.IP \(bu 2
117fb205de Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
b348f804b1 Merge pull request \fI\%#30512\fP from jfindlay/repo_test
.INDENT 2.0
.IP \(bu 2
66f06f2bd3 disable pkgrepo test for ubuntu 15.10+
.UNINDENT
.IP \(bu 2
a9348dfef8 Merge pull request \fI\%#30478\fP from jtand/pip_8_update
.INDENT 2.0
.IP \(bu 2
6227368830 Convert version to int, instead of comparing strings to ints
.IP \(bu 2
20384a4810 Added InstallationError to except block
.IP \(bu 2
baa274bca9 Updated pip_state to work with pip 8.0
.UNINDENT
.IP \(bu 2
a30147c64f Merge pull request \fI\%#30482\fP from borgstrom/pyobjects_recursive
.INDENT 2.0
.IP \(bu 2
2c55a7580b Fixup lint errors
.IP \(bu 2
b46df0e4b5 Allow recursive salt:// imports
.IP \(bu 2
51bfa16173 Add test to prove that recursive imports are currently broken
.UNINDENT
.IP \(bu 2
5c7cc51937 Merge pull request \fI\%#30459\fP from jfindlay/pkg_tests
.INDENT 2.0
.IP \(bu 2
fb9972f590 modules.pkg: disable repo int test for ubuntu 15.10
.UNINDENT
.IP \(bu 2
dd2ceb4c07 Merge pull request \fI\%#30443\fP from jtand/boto_vpc_5
.INDENT 2.0
.IP \(bu 2
2f77152479 Boto uses False for is_default instead of None
.UNINDENT
.IP \(bu 2
62d9dddced Merge pull request \fI\%#30420\fP from attiasr/patch\-1
.INDENT 2.0
.IP \(bu 2
4de343c5a1 Backport \fI\%#26853\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30485\fP: (\fI\%justinta\fP) Updated pip_state to work with pip 8.0 on 2015.8
@ \fI2016\-01\-21 22:55:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
019af349af Merge pull request \fI\%#30485\fP from jtand/pip_8_update_2015.8
.IP \(bu 2
9cb17332fa Updated pip_state to work with pip 8.0 on 2015.8
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30494\fP: (\fI\%isbm\fP) Zypper: info_installed — \(aqerrors\(aq flag change to type \(aqboolean\(aq
@ \fI2016\-01\-21 22:55:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
3259fde362 Merge pull request \fI\%#30494\fP from isbm/isbm\-zypper\-nfoinst\-bool\-fix
.IP \(bu 2
4d7659270e Place the boolean check
.IP \(bu 2
58db1c3b16 Fix typo
.IP \(bu 2
43254aa993 Update docstring according to the boolean flag
.IP \(bu 2
a7d3e0d5ad Change \(aqerrors\(aq flag to boolean.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30506\fP: (\fI\%jacksontj\fP) Properly remove newlines after reading the file
@ \fI2016\-01\-21 22:53:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
596892326d Merge pull request \fI\%#30506\fP from jacksontj/2015.8
.IP \(bu 2
e1dea6f843 Properly remove newlines after reading the file
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30444\fP: (\fI\%dnd\fP) Cloning linode server with salt\-cloud fails trying to create disk config (refs: \fI\%#30508\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#30432\fP: (\fI\%dnd\fP) Cloning linode server with salt\-cloud requires payment term (refs: \fI\%#30508\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30508\fP: (\fI\%rallytime\fP) Fix Linode driver cloning functionality
@ \fI2016\-01\-21 22:53:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
15c7aedd46 Merge pull request \fI\%#30508\fP from rallytime/linode\-clone\-fixes
.IP \(bu 2
d26ed74bde Make sure the correct profile parameters are being checked when cloning
.IP \(bu 2
1d7e229377 Fix Linode driver cloning functionality.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30522\fP: (\fI\%terminalmage\fP) Update git.list_worktree tests to reflect new return data
@ \fI2016\-01\-21 22:34:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
79528c59c3 Merge pull request \fI\%#30522\fP from terminalmage/fix\-worktree\-tests
.IP \(bu 2
ea0ca70187 Add git.list_worktrees unit test
.IP \(bu 2
393015edbb Remove git.list_worktrees tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30465\fP: (\fI\%alandrees\fP) Nested imports with pyobjects (refs: \fI\%#30483\fP, \fI\%#30482\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30483\fP: (\fI\%borgstrom\fP) Pyobjects recursive import support (for 2015.8)
@ \fI2016\-01\-21 15:55:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
119f025073 Merge pull request \fI\%#30483\fP from borgstrom/pyobjects_recursive\-2015.8
.IP \(bu 2
788b672e3a Fixup lint errors
.IP \(bu 2
e148ea2d52 Allow recursive salt:// imports
.IP \(bu 2
6bbac64d3a Add test to prove that recursive imports are currently broken
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30491\fP: (\fI\%jacksontj\fP) Add multi\-IP support to network state
@ \fI2016\-01\-21 15:51:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
d8d19cf75d Merge pull request \fI\%#30491\fP from jacksontj/2015.8
.IP \(bu 2
82213555ca Normalize yaml spacing to 2 space
.IP \(bu 2
3d1469b8d9 Add example of multiple addrs/ipv6addrs to docs
.IP \(bu 2
91c8a1b4e4 Add support for multiple IP addresses per interface to rh_ip
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30496\fP: (\fI\%anlutro\fP) Fix KeyError when adding ignored pillars
@ \fI2016\-01\-21 15:51:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
56332ca504 Merge pull request \fI\%#30496\fP from alprs/fix\-ignored_pillars_keyerror
.IP \(bu 2
bbcb783621 fix KeyError when adding ignored pillars
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30359\fP: (\fI\%kingsquirrel152\fP) Removes suspected copy/paste error for zmq_filtering functionailty
@ \fI2016\-01\-20 18:42:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
e425cbd654 Merge pull request \fI\%#30359\fP from distil/zmq_filtering_bug_fix
.IP \(bu 2
44bfbbf15b Removes suspected copy/paste error.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30448\fP: (\fI\%cournape\fP) Fix osx scripts location
@ \fI2016\-01\-20 17:59:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
13add7d142 Merge pull request \fI\%#30448\fP from cournape/fix\-osx\-scripts\-location
.IP \(bu 2
3c27ab5310 BUG: fix osx .pkg script locations to match the .plist files.
.IP \(bu 2
ed9ab68d3b BUG: fix missing sudo when linking certify cert.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22820\fP: (\fI\%VynceMontgomery\fP) some docs missing again (cf #22720) (refs: \fI\%#30457\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30457\fP: (\fI\%rallytime\fP) Remove fsutils references from modules list
@ \fI2016\-01\-20 16:43:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
2b7d20cee7 Merge pull request \fI\%#30457\fP from rallytime/fix\-22820
.IP \(bu 2
3288ff104d Remove fsutils references from modules list
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30442\fP: (\fI\%ssplatt\fP) salt\-cloud linode query only lists private or public IP, not both (refs: \fI\%#30453\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30453\fP: (\fI\%rallytime\fP) Make sure private AND public IPs are listed for Linode driver
@ \fI2016\-01\-20 16:41:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
e706b71871 Merge pull request \fI\%#30453\fP from rallytime/fix\-30442
.IP \(bu 2
a1f882f4fe Make sure private AND public IPs are listed for Linode driver
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29601\fP: (\fI\%seanjnkns\fP) pillars not merging properly with 2015.8.3 (refs: \fI\%#30062\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30458\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30062\fP to 2015.8
@ \fI2016\-01\-20 16:40:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30062\fP: (\fI\%seanjnkns\fP) Remove recurse_list from pillar_source_merging_strategy and add pilla… (refs: \fI\%#30609\fP, \fI\%#30458\fP)
.IP \(bu 2
73f372dc98 Merge pull request \fI\%#30458\fP from rallytime/bp\-30062
.IP \(bu 2
9665d9655f Set (pillar_)merge_lists to default for PR \fI\%#30062\fP
.IP \(bu 2
7ea4dbf478 Fix lint for PR30062
.IP \(bu 2
e44a30620b Remove recurse_list from pillar_source_merging_strategy and add pillar_merge_list (bool) instead
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30468\fP: (\fI\%timcharper\fP) make note of s3 role assumption in upcoming changelog
@ \fI2016\-01\-20 16:28:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3fb4006b0 Merge pull request \fI\%#30468\fP from timcharper/2015.8
.IP \(bu 2
721c1c871b make note of s3 role assumption in upcoming changelog
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30470\fP: (\fI\%whiteinge\fP) Add example of the match_dict format to accept_dict wheel function
@ \fI2016\-01\-20 16:26:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
c611541916 Merge pull request \fI\%#30470\fP from whiteinge/match_dict
.IP \(bu 2
5034e13f5d Add example of the match_dict format to accept_dict wheel function
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28017\fP: (\fI\%ThomasZhou\fP) Using salt\-cloud nova driver, raise error: SaltNova\(aq object has no attribute \(aq_discover_extensions\(aq  (refs: \fI\%#30450\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30450\fP: (\fI\%gtmanfred\fP) fix extension loading in novaclient
@ \fI2016\-01\-19 21:16:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
d70e6b312a Merge pull request \fI\%#30450\fP from gtmanfred/2015.8
.IP \(bu 2
4aa6faaf48 fix extension loading in novaclient
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30150\fP: (\fI\%rapenne\-s\fP) file.line reset permissions to 600 (refs: \fI\%#30212\fP, \fI\%#30168\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30212\fP: (\fI\%abednarik\fP) Fix incorrect file permissions in file.line
@ \fI2016\-01\-19 21:15:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
0af5e16809 Merge pull request \fI\%#30212\fP from abednarik/fix_file_line_permissions
.IP \(bu 2
dec15d1357 Fix incorrect file permissions in file.line
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29918\fP: (\fI\%WangWenchao\fP) UnicodeDecodeError when saltutil.sync_modules for Windows  salt\-minion  2015.8.3 (refs: \fI\%#29947\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29947\fP: (\fI\%jfindlay\fP) fileclient: decode file list from master
@ \fI2016\-01\-19 20:36:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
3c12b451fe Merge pull request \fI\%#29947\fP from jfindlay/remote_decode
.IP \(bu 2
b9241fb6b0 state: use simple string formatting for messages
.IP \(bu 2
f6162f168c fileclient: decode file list from master
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30203\fP: (\fI\%terminalmage\fP) Update salt.modules.git.list_worktrees() to use \(aqgit worktree list\(aq for Git >= 2.7.0 (refs: \fI\%#30363\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30363\fP: (\fI\%terminalmage\fP) Use native \(dqlist\(dq subcommand to list git worktrees
@ \fI2016\-01\-19 20:35:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
6e8b1e89a5 Merge pull request \fI\%#30363\fP from terminalmage/issue30203
.IP \(bu 2
ee40491166 Fix redefined variable
.IP \(bu 2
5f95851987 Use native \(dqlist\(dq subcommand to list git worktrees
.IP \(bu 2
911105f27c Fix incorrect missing gitdir file detection
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30445\fP: (\fI\%justinta\fP) Boto uses False for is_default instead of None
@ \fI2016\-01\-19 18:28:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
dfb9dec84f Merge pull request \fI\%#30445\fP from jtand/boto_vpc_8
.IP \(bu 2
00943ff1e6 Boto uses False for is_default instead of None
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30406\fP: (\fI\%frioux\fP) Add an example of how to use file.managed/check_cmd
@ \fI2016\-01\-19 18:23:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
f9b3f3f038 Merge pull request \fI\%#30406\fP from ZipRecruiter/check\-cmd\-example
.IP \(bu 2
92e0d77a9a Add an example of how to use file.managed/check_cmd
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30424\fP: (\fI\%isbm\fP) Check if byte strings are properly encoded in UTF\-8
@ \fI2016\-01\-19 17:52:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
05ad3dcc94 Merge pull request \fI\%#30424\fP from isbm/isbm\-zypper\-utf\-8\-errors
.IP \(bu 2
a0f263f411 Clarify the error message
.IP \(bu 2
12f8e93247 Update documentation accordingly.
.IP \(bu 2
1d384b6abd Add error handling to the RPM broken strings
.IP \(bu 2
cf0dad3a6c Rename keywords arguments variable to a default name.
.IP \(bu 2
26aa801342 Check if byte strings are properly encoded in UTF\-8
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30051\fP: (\fI\%joejulian\fP) glusterfs.status fails with glusterfs 3.7 (refs: \fI\%#30075\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30405\fP: (\fI\%justinta\fP) Updated glusterfs.py for python2.6 compatibility.
@ \fI2016\-01\-15 22:50:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30075\fP: (\fI\%joejulian\fP) Convert glusterfs module to use xml (refs: \fI\%#30405\fP)
.IP \(bu 2
1bace55e45 Merge pull request \fI\%#30405\fP from jtand/glusterfs_py26
.IP \(bu 2
a332e06c4a Fixed lint error
.IP \(bu 2
522b4990ef Updated the rest of glusterfs.py for python2.6 compatibility
.IP \(bu 2
971ce58cd6 updated list_peers to be python2.6 compatible
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30396\fP: (\fI\%pass\-by\-value\fP) Remove hardcoded val
@ \fI2016\-01\-15 22:03:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
cb1c0958bd Merge pull request \fI\%#30396\fP from pass\-by\-value/remove_hardcoded_val
.IP \(bu 2
dd90b325e7 Get vm info
.IP \(bu 2
9430ad1465 Remove hardcoded value
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30391\fP: (\fI\%justinta\fP) Added else statements
@ \fI2016\-01\-15 19:17:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30389\fP: (\fI\%justinta\fP) Older versions of ipset don\(aqt support comments (refs: \fI\%#30391\fP)
.IP \(bu 2
60737c970e Merge pull request \fI\%#30391\fP from jtand/ipset
.IP \(bu 2
345b056406 Fixed lint error
.IP \(bu 2
c20f9b6a87 Added else statements
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30277\fP: (\fI\%webtrekker\fP) [salt\-cloud] Error actioning machines: \(aqascii\(aq codec can\(aqt encode character u\(aq\e\exa0\(aq in position 20 (refs: \fI\%#30374\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30375\fP: (\fI\%rallytime\fP) Wrap formatted log statements with six.u() in cloud/__init__.py
@ \fI2016\-01\-15 18:41:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30374\fP: (\fI\%rallytime\fP) Wrap formatted log statements with six.u() in the VMware module (refs: \fI\%#30375\fP)
.IP \(bu 2
6ac1f6cf54 Merge pull request \fI\%#30375\fP from rallytime/fix\-cloud\-log\-formatting
.IP \(bu 2
5e7fb0c428 Wrap formatted log statements with six.u() in cloud/__init__.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30384\fP: (\fI\%isbm\fP) Bugfix: info_available does not work correctly on SLE 11 series
@ \fI2016\-01\-15 18:31:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
c478148b60 Merge pull request \fI\%#30384\fP from isbm/isbm\-zypper\-info\-available\-fix
.IP \(bu 2
c7bc20e865 Split information, that is compatible with the Zypper\(aqs output on SLE11.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30376\fP: (\fI\%pritambaral\fP) Fix FLO_DIR path in 2015.8
@ \fI2016\-01\-15 18:25:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
9fe2df82bd Merge pull request \fI\%#30376\fP from pritambaral/fix/flo\-dir
.IP \(bu 2
534879e79f Revert \(dqRaet Salt broken when config moved to package directory\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30389\fP: (\fI\%justinta\fP) Older versions of ipset don\(aqt support comments (refs: \fI\%#30391\fP)
@ \fI2016\-01\-15 17:41:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ac3804ddc Merge pull request \fI\%#30389\fP from jtand/ipset
.IP \(bu 2
fac6c3f6ae Fixed some typos from testing
.IP \(bu 2
67d4997316 Older versions of ipset don\(aqt support comments
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30373\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-01\-15 16:23:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
4cc9422bf8 Merge pull request \fI\%#30373\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
5b53bf2597 Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
5a923b3aa9 Merge pull request \fI\%#30364\fP from rallytime/fix\-30341
.INDENT 2.0
.IP \(bu 2
79bcf151cb Add TLS version imports and add linode driver documentation notices
.UNINDENT
.IP \(bu 2
f037fd9c27 Merge pull request \fI\%#30184\fP from rallytime/bp\-30166
.INDENT 2.0
.IP \(bu 2
fa6b1b3022 adding split_env call to cp.hash_file to pick up saltenv in file query parameter
.UNINDENT
.IP \(bu 2
1d8413fd2f Merge pull request \fI\%#30291\fP from thegoodduke/for_fix_ipset
.INDENT 2.0
.IP \(bu 2
62d6ccf561 ipset: fix test=true & add comment for every entry
.UNINDENT
.IP \(bu 2
92889db638 Merge pull request \fI\%#30248\fP from jfindlay/2015.5
.INDENT 2.0
.IP \(bu 2
741f7aba31 add 2015.5.9 release notes
.UNINDENT
.IP \(bu 2
7a329d89d7 Merge pull request \fI\%#30237\fP from jacobhammons/man\-pages\-prev
.INDENT 2.0
.IP \(bu 2
2431c4c5c3 Updated man page and doc conf.py copyright year to 2016
.IP \(bu 2
fe3da1c174 Updated man pages and doc version for 2015.5.9
.UNINDENT
.IP \(bu 2
2c0b725924 Merge pull request \fI\%#30207\fP from rallytime/rabbitmq_states_doc_fix
.INDENT 2.0
.IP \(bu 2
8d48c24182 Use correct spacing in rabbitmq state examples
.UNINDENT
.IP \(bu 2
b49cf910f4 Merge pull request \fI\%#30191\fP from jacobhammons/banner\-prev
.INDENT 2.0
.IP \(bu 2
c3390955b0 Updated doc site banners
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30372\fP: (\fI\%jacobhammons\fP) Updated man pages for 2015.8.4, updated copyright to 2016
@ \fI2016\-01\-14 23:18:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
a9edb194a4 Merge pull request \fI\%#30372\fP from jacobhammons/man\-pages
.IP \(bu 2
891ddafcba Updated man pages for 2015.8.4, updated copyright to 2016
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30370\fP: (\fI\%rallytime\fP) Remove incomplete function
@ \fI2016\-01\-14 22:49:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
e77585de17 Merge pull request \fI\%#30370\fP from rallytime/remove\-incomplete\-func
.IP \(bu 2
e220fa5125 Remove incomplete function
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23215\fP: (\fI\%lichtamberg\fP) Rbenv: gem.installed not using correct ruby version if it\(aqs not default on 2015.02  (refs: \fI\%#28702\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30366\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28702\fP to 2015.8
@ \fI2016\-01\-14 21:10:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28702\fP: (\fI\%dnd\fP) Pass RBENV_VERSION in env dict, and protect shlex.split (refs: \fI\%#30366\fP)
.IP \(bu 2
eb1ecd9732 Merge pull request \fI\%#30366\fP from rallytime/bp\-28702
.IP \(bu 2
4f2274a275 Remove extra line
.IP \(bu 2
048b13cf73 Pass RBENV_VERSION in env dict, and protect shlex.split
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30361\fP: (\fI\%cro\fP) Flip the sense of the test for proxymodule imports, add more fns for esxi proxy
@ \fI2016\-01\-14 20:54:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
40594efc0b Merge pull request \fI\%#30361\fP from cro/esxi\-proxy2
.IP \(bu 2
8f7490ca98 Missed return statement.
.IP \(bu 2
389ede9e3e Lint
.IP \(bu 2
9db34d6ffe Lint
.IP \(bu 2
b5c7a46f7a Lint
.IP \(bu 2
1a3b1f2626 Don\(aqt use short variables
.IP \(bu 2
b80577182a Remove stub functions.
.IP \(bu 2
58f7fc3285 Don\(aqt use single character variables.
.IP \(bu 2
e712664bcf Better comment.
.IP \(bu 2
9e9a37d0d4 Indentation.
.IP \(bu 2
6c9bf76e19 Revert earlier vmware change for ssl cert checking.
.IP \(bu 2
db8a281ab8 Flip the sense of the test for items (modules, etc) loaded by the proxy.  Now load everything a regular minion would load, and only check to make sure __proxyenabled__ is present for proxymodules and grains
.IP \(bu 2
00c4ef6ec2 Need a list
.IP \(bu 2
0da7a6d6d1 Recreate the pr
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30267\fP: (\fI\%isbm\fP) Fix RPM issues with the date/time and add package attributes filtering
@ \fI2016\-01\-14 18:00:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
f4118be6e4 Merge pull request \fI\%#30267\fP from isbm/isbm\-zypper\-isotimefix
.IP \(bu 2
18281e7e0b Add \(dq*time_t\(dq as a separate attributes
.IP \(bu 2
4105157cfd Add *time_t to the docs
.IP \(bu 2
78e16a7b00 Construct RPM query dynamically
.IP \(bu 2
6992d74806 Update documentation for the valid package attributes
.IP \(bu 2
6710e4900d Use renamed variable (filter_attrs to attr)
.IP \(bu 2
b68e1228e9 Remove unnecessary check for the \(dqname\(dq key
.IP \(bu 2
e5b3e77186 Remove key transformations
.IP \(bu 2
9ac52c9123 Add zone to the ISO from unix time
.IP \(bu 2
d352c08305 Fix lint: unused import
.IP \(bu 2
d571381f76 Update the documentation for the Zypper module
.IP \(bu 2
5651a043e6 Update documentation for lowpkg
.IP \(bu 2
7edb0e8f3f Replace \(dq*_date_iso\(dq with \(dq*_date\(dq and use Unix time as \(dq*_date_time_t\(dq
.IP \(bu 2
b2b21f877a Add epoch (note: this is empty on SUSE systems)
.IP \(bu 2
0eebe10d9a Clarify description
.IP \(bu 2
a745d9ecdf Fix syntax for the documentation in zypper module
.IP \(bu 2
c95c2d24db Fix the documentation syntax
.IP \(bu 2
1fb84538b1 Update documentation
.IP \(bu 2
43ebff4dd7 Return build date in Unix ticks
.IP \(bu 2
bdaa1e4d6e Add package architecture attribute
.IP \(bu 2
ba64df4def Update documentation
.IP \(bu 2
6e3743dce6 Incorporate lowpkg.info into info_installed
.IP \(bu 2
b72b8d5323 Fix the documentation
.IP \(bu 2
181314b20e Add filtering per attributes feature
.IP \(bu 2
39e70ef762 Fix ISO and Unix time of the package for RPM systems on C locale.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30330\fP: (\fI\%JensRantil\fP) salt.state.file.absent doesn\(aqt document recursiveness (refs: \fI\%#30360\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30360\fP: (\fI\%jfindlay\fP) file.remove, file.absent: mention recursive dir removal
@ \fI2016\-01\-14 17:30:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
b61cb7a238 Merge pull request \fI\%#30360\fP from jfindlay/remove_doc
.IP \(bu 2
a21ccd2700 file.remove, file.absent: mention recursive dir removal
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26845\fP: (\fI\%maio\fP) Postgres module (user_exists) doesn\(aqt work with PostgreSQL 9.5 (refs: \fI\%#30221\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30221\fP: (\fI\%mbarrien\fP) No rolcatupdate for user_exist in Postgres>=9.5 \fI\%#26845\fP
@ \fI2016\-01\-14 16:52:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
ba8d128025 Merge pull request \fI\%#30221\fP from mbarrien/postgres\-9.5
.IP \(bu 2
a8f2bc7998 No rolcatupdate for user_exist in Postgres>=9.5 \fI\%#26845\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30358\fP: (\fI\%terminalmage\fP) Add libgit2 version to versions\-report
@ \fI2016\-01\-14 16:37:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
4787c2c9ad Merge pull request \fI\%#30358\fP from terminalmage/libgit2\-version
.IP \(bu 2
89fe571791 Add libgit2 version to versions\-report
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30346\fP: (\fI\%pass\-by\-value\fP) Prevent orphaned volumes
@ \fI2016\-01\-14 16:37:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
af2ddfd31c Merge pull request \fI\%#30346\fP from pass\-by\-value/aws_vols_attach
.IP \(bu 2
19fce03ee2 Prevent orphaned volumes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30349\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30347\fP to 2015.8
@ \fI2016\-01\-14 16:26:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30347\fP: (\fI\%rallytime\fP) Merge \fI\%#30231\fP with updates to dependency documentation (refs: \fI\%#30349\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30231\fP: (\fI\%nmadhok\fP) Fix issue where pyVmomi 6.0.0 raises SSL Error for systems using Python2.7+ (refs: \fI\%#30347\fP)
.IP \(bu 2
bccb8f3b5b Merge pull request \fI\%#30349\fP from rallytime/bp\-30347
.IP \(bu 2
df70afdaa3 Merge \fI\%#30231\fP with updates to dependency documentation
.IP \(bu 2
a7c2ad5505 Fix issue where pyVmomi 6.0.0 raises SSL Error for systems using Python2.7+
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30354\fP: (\fI\%anlutro\fP) Make sure all ignore_missing SLSes are caught
@ \fI2016\-01\-14 16:24:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#19429\fP: (\fI\%ryan\-lane\fP) Add new ignore_missing option to pillar top (refs: \fI\%#30354\fP)
.IP \(bu 2
7ee61f0d62 Merge pull request \fI\%#30354\fP from alprs/fix\-pillar_ignore_missing
.IP \(bu 2
2f662bbc8d make sure \fIall\fP ignore_missing slses are caught
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30356\fP: (\fI\%nmadhok\fP) Adding code author
@ \fI2016\-01\-14 16:23:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
4bdade6010 Merge pull request \fI\%#30356\fP from nmadhok/patch\-1
.IP \(bu 2
581e4f5dc7 Adding code author
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30340\fP: (\fI\%justinta\fP) Updated seed_test.py for changes made to seed module
@ \fI2016\-01\-13 22:50:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
d5b8776355 Merge pull request \fI\%#30340\fP from jtand/seed_test_fix
.IP \(bu 2
ee764ee952 Updated seed_test.py for changes made to seed module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26478\fP: (\fI\%rasathus\fP) nested upstart services are not supported (refs: \fI\%#26511\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30339\fP: (\fI\%jfindlay\fP) Backport \fI\%#26511\fP
@ \fI2016\-01\-13 22:35:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26511\fP: (\fI\%rasathus\fP) Adds support for nested upstart scripts in the form of subfolder/serv… (refs: \fI\%#30339\fP)
.IP \(bu 2
3bbed62d07 Merge pull request \fI\%#30339\fP from jfindlay/bp\-26511
.IP \(bu 2
89d9cd5e38 Adds support for nested upstart scripts in the form of subfolder/service.  This is implemented via an os.walk through the /etc/init folder, rather than the previous glob for *.conf method.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28339\fP: (\fI\%boboli\fP) salt\-call state.highstate fails with ZMQError when minion has no id set in /etc/salt/minion (refs: \fI\%#28423\fP, \fI\%#28431\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30343\fP: (\fI\%rallytime\fP) Fix 2015.8 from incomplete back\-port
@ \fI2016\-01\-13 21:56:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30187\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27606\fP to 2015.8 (refs: \fI\%#30343\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28431\fP: (\fI\%plastikos\fP) Use a broader test for unset \(dqid\(dq (refs: \fI\%#30343\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28423\fP: (\fI\%cachedout\fP) Fix issue with empty str as default minion id (refs: \fI\%#28431\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28189\fP: (\fI\%plastikos\fP) Always get default option settings from salt.config (refs: \fI\%#30343\fP, \fI\%#28431\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28131\fP: (\fI\%cachedout\fP) Set a fallback HWM (refs: \fI\%#30343\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27606\fP: (\fI\%plastikos\fP) RFC: Add additional ZMQ tuning parameters necessary for 1k+ minions per master [WIP] (refs: \fI\%#30343\fP, \fI\%#30187\fP)
.IP \(bu 2
6079a96e6e Merge pull request \fI\%#30343\fP from rallytime/fix\-2015.8
.IP \(bu 2
5eef9d5067 Use a broader test for unset \(dqid\(dq
.IP \(bu 2
460a3c98cc Additional corrections to use option defaults directly from salt.config
.IP \(bu 2
4e53ef0bf6 Always get default option settings from salt.config
.IP \(bu 2
94ee6f88af Set a fallback HWM
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30342\fP: (\fI\%eliasp\fP) Correct whitespace placement in error message
@ \fI2016\-01\-13 21:32:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
7276d808ff Merge pull request \fI\%#30342\fP from eliasp/2015.8\-log\-message\-format
.IP \(bu 2
8e37e36ac7 Correct whitespace placement in error message
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30250\fP: (\fI\%mbarrien\fP) npm.bootstrap state runs even when test=True (refs: \fI\%#30257\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30308\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30257\fP to 2015.8
@ \fI2016\-01\-13 19:20:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30257\fP: (\fI\%abednarik\fP) Add test in npm state. (refs: \fI\%#30308\fP)
.IP \(bu 2
10b5728f84 Merge pull request \fI\%#30308\fP from rallytime/bp\-30257
.IP \(bu 2
0b0d73756e Fix typos in nmp module.
.IP \(bu 2
deeeb71dda Add test in npm state.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30187\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27606\fP to 2015.8 (refs: \fI\%#30343\fP)
@ \fI2016\-01\-13 19:03:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27606\fP: (\fI\%plastikos\fP) RFC: Add additional ZMQ tuning parameters necessary for 1k+ minions per master [WIP] (refs: \fI\%#30343\fP, \fI\%#30187\fP)
.IP \(bu 2
afa61c03db Merge pull request \fI\%#30187\fP from rallytime/bp\-27606
.IP \(bu 2
8ef6d6c6fd Add additional ZMQ tuning parameters necessary for 1,000+ minions per server. Start collecting tuning parameters together in the master config file.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30223\fP: (\fI\%serge\-p\fP) adding support for DragonFly BSD
@ \fI2016\-01\-13 18:24:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
7e89a460e4 Merge pull request \fI\%#30223\fP from serge\-p/patch\-11
.IP \(bu 2
ec798acbcd Update pkgng.py
.IP \(bu 2
45206dfe3d adding support for DragonFly BSD
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28396\fP: (\fI\%ymote\fP) salt\-cloud parallel provisioning (\-P option) failed on 2015.8.1 (refs: \fI\%#30238\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23824\fP: (\fI\%kiorky\fP) salt.crypt broken in develop (refs: \fI\%#23825\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30238\fP: (\fI\%rallytime\fP) Reinit crypto before calling RSA.generate when generating keys.
@ \fI2016\-01\-13 18:22:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23825\fP: (\fI\%kiorky\fP) Fix crypto (refs: \fI\%#30238\fP)
.IP \(bu 2
5a8da62008 Merge pull request \fI\%#30238\fP from rallytime/fix\-28396
.IP \(bu 2
41d9df45bb Reinit crypto before calling RSA.generate when generating keys.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24237\fP: (\fI\%Grokzen\fP) Minion schedule return data missing some fields (refs: \fI\%#30246\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30246\fP: (\fI\%dmacvicar\fP) Add missing return data to scheduled jobs (\fI\%#24237\fP)
@ \fI2016\-01\-13 17:51:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
15707e0ac8 Merge pull request \fI\%#30246\fP from dmacvicar/dmacvicar\-2015.8\-24237
.IP \(bu 2
c462139dbb lint: E8713(test\-for\-membership\-should\-be\-not\-in)
.IP \(bu 2
5a1b2ca486 include the \(aqsuccess\(aq field in scheduled jobs return data (part of \fI\%#24237\fP)
.IP \(bu 2
f72a4ca42d add retcode to scheduled jobs return data (part of \fI\%#24237\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30292\fP: (\fI\%thegoodduke\fP) ipset: fix test=true & add comment for every entry
@ \fI2016\-01\-13 17:49:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30170\fP: (\fI\%thegoodduke\fP) ipset: fix comment and test (refs: \fI\%#30291\fP, \fI\%#30292\fP)
.IP \(bu 2
8706720148 Merge pull request \fI\%#30292\fP from thegoodduke/fix_ipset
.IP \(bu 2
49d70bff16 ipset: fix test=true & add comment for every entry
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30240\fP: (\fI\%snw1968\fP) firewalld inconsistent permanent option used for services but not ports \- other options required (refs: \fI\%#30275\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30275\fP: (\fI\%abednarik\fP) Add permanent argument in firewalld.
@ \fI2016\-01\-13 17:44:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea607675f5 Merge pull request \fI\%#30275\fP from abednarik/fix_firewalld_ports_permanent
.IP \(bu 2
e3d4bf51da Add permanent argument in firewalld.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30328\fP: (\fI\%cachedout\fP) Fix file test
@ \fI2016\-01\-13 17:42:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
f02db44757 Merge pull request \fI\%#30328\fP from cachedout/fix_file_test
.IP \(bu 2
dcfba51556 Lint
.IP \(bu 2
b9921128af Kill pointless tests
.IP \(bu 2
63c157d0a3 Fix test_managed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30310\fP: (\fI\%pass\-by\-value\fP) Empty bucket fix
@ \fI2016\-01\-13 17:30:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
edd94aea2c Merge pull request \fI\%#30310\fP from pass\-by\-value/empty_bucket_fix
.IP \(bu 2
aef5a8898c Add fix for else code path
.IP \(bu 2
9398c44945 Check and report empty S3 bucket
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30211\fP: (\fI\%techhat\fP) Execute choot on the correct path
@ \fI2016\-01\-13 16:53:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
f23f0f30d4 Merge pull request \fI\%#30211\fP from techhat/tmppath
.IP \(bu 2
11ac2ff0bf Revert \(dqWe\(aqre putting the keys directly in place; \-c isn\(aqt used\(dq
.IP \(bu 2
e75b48f5ff We\(aqre putting the keys directly in place; \-c isn\(aqt used
.IP \(bu 2
5d7a0f6d81 Execute choot on the correct path
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30286\fP: (\fI\%tkunicki\fP) salt\-cloud ec2 spot requests fail with userdata_file in config or profile (refs: \fI\%#30304\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30309\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30304\fP to 2015.8
@ \fI2016\-01\-13 16:41:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30304\fP: (\fI\%tkunicki\fP) add spot_prefix to UserData param (refs: \fI\%#30309\fP)
.IP \(bu 2
5154c71127 Merge pull request \fI\%#30309\fP from rallytime/bp\-30304
.IP \(bu 2
4a8cc87b47 add spot_prefix to UserData param
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30278\fP: (\fI\%nmadhok\fP) If datacenter is specified in the config, then look for managed objects under it
@ \fI2016\-01\-13 15:29:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
1624d6cebd Merge pull request \fI\%#30278\fP from nmadhok/2015.8\-samename\-objects\-fix
.IP \(bu 2
b0e86afa00 get_mor_by_property needs container_ref to be a positional parameter
.IP \(bu 2
56dfc63f91 If datacenter is specified, start all searches under datacenter
.IP \(bu 2
fcf77b738e If datacenter is specified then look under it instead of looking under inventory root folder
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30305\fP: (\fI\%jacobhammons\fP) Changed examples to use the \(dqexample.com\(dq domain instead of \(dqmycompan…
@ \fI2016\-01\-12 20:42:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc9304f7f8 Merge pull request \fI\%#30305\fP from jacobhammons/example\-domain
.IP \(bu 2
53d17f1f85 Changed examples to use the \(dqexample.com\(dq domain instead of \(dqmycompany.com\(dq or \(dqcompany.com\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30249\fP: (\fI\%mpreziuso\fP) Fixes performance and timeout issues on win_pkg.install
@ \fI2016\-01\-12 20:14:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
3bd02a898f Merge pull request \fI\%#30249\fP from mpreziuso/patch\-2
.IP \(bu 2
d6e6e10534 Fixes lint issues
.IP \(bu 2
3251424838 Fixes performance and timeout issues on win_pkg.install
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30217\fP: (\fI\%pass\-by\-value\fP) Make sure cloud actions can be called via salt run
@ \fI2016\-01\-12 20:11:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
461a741e14 Merge pull request \fI\%#30217\fP from pass\-by\-value/cloud_actions_dispatch
.IP \(bu 2
1f68ce05bc Fix pylint error
.IP \(bu 2
d5b1b60b99 Add CLI Example
.IP \(bu 2
5264449fdb Make sure cloud actions can be called via salt run
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#9569\fP: (\fI\%clearclaw\fP) How can a binary file, such as a license key, be distributed via Pillar? (refs: \fI\%#30268\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30268\fP: (\fI\%terminalmage\fP) Optimize file_tree ext_pillar and update file.managed to allow for binary contents
@ \fI2016\-01\-12 20:09:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
4a6b53f329 Merge pull request \fI\%#30268\fP from terminalmage/issue9569
.IP \(bu 2
724b2f36ce Add file_tree/file.managed/contents_pillar example to FAQ
.IP \(bu 2
854c7d9978 Remove old FAQ item referencing gitfs bug in 0.16.x
.IP \(bu 2
e9a6d709f9 salt.states.file.managed: Allow for binary contents
.IP \(bu 2
1ba448b619 salt.pillar.file_tree: Optimizations, deprecate raw_data
.IP \(bu 2
650cc0af5c salt.modules.file: Improve docstrings
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29078\fP: (\fI\%Reiner030\fP) boto_secgroup didn\(aqt work as expected in Debian Jessie (refs: \fI\%#30155\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30245\fP: (\fI\%rallytime\fP) Boto secgroup/iam_role: Add note stating us\-east\-1 is default region
@ \fI2016\-01\-12 20:04:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30155\fP: (\fI\%rallytime\fP) Update boto_secgroup and boto_iam_role docs to only use region OR profile (refs: \fI\%#30245\fP)
.IP \(bu 2
dbe7bcdc9a Merge pull request \fI\%#30245\fP from rallytime/botosecgroup\-docs
.IP \(bu 2
406a138f76 Boto secgroup/iam_role: Add note stating us\-east\-1 is default region
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30299\fP: (\fI\%rallytime\fP) ESXi Proxy minions states are located at salt.states.esxi, not vsphere.
@ \fI2016\-01\-12 20:03:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b183778f1 Merge pull request \fI\%#30299\fP from rallytime/esxi\-proxy\-doc\-fix
.IP \(bu 2
db68fc48a8 Fix CLI Example syntax
.IP \(bu 2
1cb9f29798 ESXi Proxy minions states are located at salt.states.esxi, not vsphere.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30202\fP: (\fI\%opdude\fP) Fixed the periodic call to beacons
@ \fI2016\-01\-12 19:58:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
903289d3fb Merge pull request \fI\%#30202\fP from Unity\-Technologies/hotfix/beacon_periodic
.IP \(bu 2
ea7a86fa7d Fixed the periodic call to beacons
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30303\fP: (\fI\%jacobhammons\fP) Changed notes to indicate that functions are matched using regular ex…
@ \fI2016\-01\-12 19:15:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
48d2bd9e78 Merge pull request \fI\%#30303\fP from jacobhammons/pcre\-match
.IP \(bu 2
e5079ab4c9 Changed notes to indicate that functions are matched using regular expressions instead of minions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29684\fP: (\fI\%snarfmonkey\fP) Upgrade from 2015.8.1 to 2015.8.3 via apt for Ubuntu 14.04 causes Dulwich\-backed gitfs to stop working (refs: \fI\%#30284\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30284\fP: (\fI\%terminalmage\fP) salt.utils.gitfs: Fix Dulwich env detection and submodule handling
@ \fI2016\-01\-12 19:11:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
675ac4b43f Merge pull request \fI\%#30284\fP from terminalmage/issue29684
.IP \(bu 2
a746014f7e salt.utils.gitfs: Fix Dulwich env detection and submodule handling
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30280\fP: (\fI\%jfindlay\fP) add state mocking to release notes
@ \fI2016\-01\-12 19:10:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
8f65e822d7 Merge pull request \fI\%#30280\fP from jfindlay/state_mock_doc
.IP \(bu 2
22c1129f02 modules.state.sls,highstate: mock versionadded
.IP \(bu 2
934de30939 add state mock to 2015.8.4 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30117\fP: (\fI\%MadsRC\fP) Service beacons fails with Stacktraces (refs: \fI\%#30121\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30273\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30121\fP to 2015.8
@ \fI2016\-01\-12 19:10:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30121\fP: (\fI\%MadsRC\fP) Patch for issue  \fI\%#30117\fP (refs: \fI\%#30273\fP)
.IP \(bu 2
c9ade42d10 Merge pull request \fI\%#30273\fP from rallytime/bp\-30121
.IP \(bu 2
c8c30f2105 I fail at linting... Fixed my uppercase/lowercase problem
.IP \(bu 2
0877b33026 Fixed some linting issues
.IP \(bu 2
8ec36497a1 Added note about systemd and uncleanshutdown. Also fixed line length of comments to max 80 characters as per PEP0008
.IP \(bu 2
a50428d02c On an unclean shutdown, if oncleanshutdown is given a path, an keyy:value of shutdown:unclean is added to the returned data. The documentation states that the key should be \(aquncleanshutdown\(aq and that the value should either be True or False. This is fixed in the code
.IP \(bu 2
51b57f1820 Fixed issue number \fI\%#30117\fP \- When no parameters are given to a service, the service object is of type None and thus isn\(aqt iterable. This is contrary to the documentation which states that there are default values. Default values added as False
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30301\fP: (\fI\%cachedout\fP) Accept whatever comes into hightstate mock for state tests
@ \fI2016\-01\-12 18:33:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a5a84a790 Merge pull request \fI\%#30301\fP from cachedout/fix_state_tests
.IP \(bu 2
2c62b464b1 Accept whatever comes into hightstate mock for state tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28586\fP: (\fI\%zmalone\fP) file.append does not differentiate between tabs and spaces (refs: \fI\%#30156\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30282\fP: (\fI\%cachedout\fP) Fix file.append logic
@ \fI2016\-01\-12 18:27:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30156\fP: (\fI\%abednarik\fP) Add option in file.append to ignore_whitespace. (refs: \fI\%#30282\fP)
.IP \(bu 2
8438d19815 Merge pull request \fI\%#30282\fP from cachedout/fix_30156
.IP \(bu 2
3f633ff15e Lint
.IP \(bu 2
99dd11dec2 Remove debugging
.IP \(bu 2
35ef585c54 Fix logic error in file.append
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30289\fP: (\fI\%cro\fP) Fix problems with targeting proxies by grains
@ \fI2016\-01\-12 18:16:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
530c9ec6ec Merge pull request \fI\%#30289\fP from cro/proxy_grains_fix
.IP \(bu 2
8362d76440 Add comments.
.IP \(bu 2
4e50962642 Merge branch \(aqproxy_grains_fix\(aq of github.com:cro/salt into proxy_grains_fix
.INDENT 2.0
.IP \(bu 2
61bb6a9a14 Lint.
.IP \(bu 2
7c35333509 Force a grains sync after we load the proxy\(aqs grains.
.IP \(bu 2
2855ba7da5 Disallow non\-proxyenabled modules and grains
.UNINDENT
.IP \(bu 2
8fd8f3beb7 Lint.
.IP \(bu 2
144fea02e5 Force a grains sync after we load the proxy\(aqs grains.
.IP \(bu 2
5ecf85017b Disallow non\-proxyenabled modules and grains
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30293\fP: (\fI\%cro\fP) Ensure we don\(aqt log stuff we shouldn\(aqt
@ \fI2016\-01\-12 18:04:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
75b83453cf Merge pull request \fI\%#30293\fP from cro/proxy_log_cleanup
.IP \(bu 2
b358fe370c Merge remote\-tracking branch \(aqorigin/proxy_log_cleanup\(aq into proxy_log_cleanup
.INDENT 2.0
.IP \(bu 2
c9a5680427 Add unused \(aqoutput_loglevel\(aq kwarg. This is here for when we alias cmd.run_all directly to _run_all_quiet in certain chicken\-and\-egg situations where modules need to work both before and after the __salt__ dictionary is populated (cf dracr.py).
.IP \(bu 2
8c46de12e4 Ensure we don\(aqt log stuff we shouldn\(aqt.
.UNINDENT
.IP \(bu 2
3267d92216 Add unused \(aqoutput_loglevel\(aq kwarg. This is here for when we alias cmd.run_all directly to _run_all_quiet in certain chicken\-and\-egg situations where modules need to work both before and after the __salt__ dictionary is populated (cf dracr.py).
.IP \(bu 2
6a86bdc6da Ensure we don\(aqt log stuff we shouldn\(aqt.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30279\fP: (\fI\%cachedout\fP) Allow modules to be packed into boto utils
@ \fI2016\-01\-12 16:53:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
46681658e0 Merge pull request \fI\%#30279\fP from cachedout/boto_pack
.IP \(bu 2
11d27ba694 Mock config module in utils test
.IP \(bu 2
62a1818287 Lint
.IP \(bu 2
cf440036dd Remove unused import
.IP \(bu 2
36d55ea0ad Allow modules to be packed into boto utils
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29951\fP: (\fI\%Reiner030\fP) boto_ec2 params needed (refs: \fI\%#30186\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30186\fP: (\fI\%rallytime\fP) Update CLI Examples in boto_ec2 module to reflect correct arg/kwarg positioning
@ \fI2016\-01\-08 19:00:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
54b9641330 Merge pull request \fI\%#30186\fP from rallytime/fix\-29951
.IP \(bu 2
a943b505cc Update CLI Examples in boto_ec2 module to reflect correct arg/kwarg positioning
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28586\fP: (\fI\%zmalone\fP) file.append does not differentiate between tabs and spaces (refs: \fI\%#30156\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30156\fP: (\fI\%abednarik\fP) Add option in file.append to ignore_whitespace. (refs: \fI\%#30282\fP)
@ \fI2016\-01\-08 16:07:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
1256fd11e1 Merge pull request \fI\%#30156\fP from abednarik/ignore_whitespace_file_append
.IP \(bu 2
af68086e5c Add option in file.append to ignore_whitespace.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30189\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30185\fP to 2015.8
@ \fI2016\-01\-07 23:32:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30185\fP: (\fI\%cachedout\fP) Fix \fI\%#30118\fP (refs: \fI\%#30189\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30118\fP: (\fI\%thatch45\fP) State mock (refs: \fI\%#30185\fP, \fI\%#30189\fP)
.IP \(bu 2
ad7522c98d Merge pull request \fI\%#30189\fP from rallytime/bp\-30185
.IP \(bu 2
70681bf03b Fix for mock state PR \fI\%#30118\fP
.IP \(bu 2
f9480f66d8 change arg to mocked to try test suite collision fix
.IP \(bu 2
2fbdcda703 fix some typos
.IP \(bu 2
6f757b8c81 Add Mock to state.sls
.IP \(bu 2
fb0cbd185e fix issue where the name may be in 2 places
.IP \(bu 2
5f0326e521 Start on the state mock system
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#9319\fP: (\fI\%gravyboat\fP) Update Reactor docs with an example using salt\-cloud from the commandline. (refs: \fI\%#30215\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#8146\fP: (\fI\%basepi\fP) Make implications of extra accepted keys on timeouts more obvious (refs: \fI\%#30215\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#6853\fP: (\fI\%Psycojoker\fP) Salt formulas should be way more visible in the documentation (refs: \fI\%#30215\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#4381\fP: (\fI\%mlister2006\fP) peer_run: glob, pcre matching. Better docs (refs: \fI\%#30215\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#2229\fP: (\fI\%alekibango\fP) how to debug zeromq problem with hanging salt communication? (refs: \fI\%#30215\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#15042\fP: (\fI\%cvrebert\fP) percent signs not escaped in cron commands (refs: \fI\%#30215\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#14946\fP: (\fI\%ryan\-lane\fP) reload_modules not documented in global state arguments documentation (refs: \fI\%#30215\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#13777\fP: (\fI\%gravyboat\fP) Update top module docs with more concise examples (refs: \fI\%#30215\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#13036\fP: (\fI\%tminn\fP) salstack tomcat module  (refs: \fI\%#30215\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30215\fP: (\fI\%jacobhammons\fP) Assorted doc bug fixes
@ \fI2016\-01\-07 21:53:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
8f30f7045a Merge pull request \fI\%#30215\fP from jacobhammons/doc\-issues
.IP \(bu 2
44ce704206 Updated \fIzmq_monitor\fP docs
.IP \(bu 2
0d2111d397 Assorted doc bug fixes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30204\fP: (\fI\%anlutro\fP) salt can\(aqt find local cache return file (refs: \fI\%#30206\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30206\fP: (\fI\%cachedout\fP) Revert \(dqFix incorrect file permissions in file.line\(dq
@ \fI2016\-01\-07 17:55:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
2000800915 Merge pull request \fI\%#30206\fP from cachedout/revert_30168
.IP \(bu 2
ee786293e7 Revert \(dqFix incorrect file permissions in file.line\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30190\fP: (\fI\%jacobhammons\fP) Updated doc site banners
@ \fI2016\-01\-06 22:37:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
5632ccb796 Merge pull request \fI\%#30190\fP from jacobhammons/banners
.IP \(bu 2
266023baf1 Updated doc site banners
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30171\fP: (\fI\%jamusj\fP) Python 2.7 dependency in x509.py (refs: \fI\%#30180\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30180\fP: (\fI\%jfindlay\fP) modules.x509._dec2hex: add fmt index for 2.6 compat
@ \fI2016\-01\-06 19:48:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
9a83247992 Merge pull request \fI\%#30180\fP from jfindlay/2.7x509
.IP \(bu 2
907469d04a modules.x509._dec2hex: add fmt index for 2.6 compat
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30179\fP: (\fI\%terminalmage\fP) Backport \fI\%#26962\fP to 2015.8 branch
@ \fI2016\-01\-06 19:48:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26962\fP: (\fI\%ctrlrsf\fP) Add \-\-state\-verbose command line option to salt cmd (refs: \fI\%#30179\fP)
.IP \(bu 2
6516d5b5d0 Merge pull request \fI\%#30179\fP from terminalmage/bp\-26962
.IP \(bu 2
08f2021f52 Fix pylint warnings: unnecessary parens after if keyword
.IP \(bu 2
a2ec721661 Add \-\-state\-verbose command line option to salt cmd
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29654\fP: (\fI\%schaarsc\fP) ssh_auth should report missing source (refs: \fI\%#29693\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29693\fP: (\fI\%abednarik\fP) Handle missing source file in ssh_auth.
@ \fI2016\-01\-06 17:13:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
27df7276bc Merge pull request \fI\%#29693\fP from abednarik/handle_missing_source_in_ssh_auth
.IP \(bu 2
fc024e3cf4 Handle missing source file in ssh_auth.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29078\fP: (\fI\%Reiner030\fP) boto_secgroup didn\(aqt work as expected in Debian Jessie (refs: \fI\%#30155\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30155\fP: (\fI\%rallytime\fP) Update boto_secgroup and boto_iam_role docs to only use region OR profile (refs: \fI\%#30245\fP)
@ \fI2016\-01\-06 17:09:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
f9863dd9fb Merge pull request \fI\%#30155\fP from rallytime/boto\-secgroup\-docfix
.IP \(bu 2
f0381a955f Update boto_secgroup and boto_iam_role docs to only use region OR profile.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29905\fP: (\fI\%Reiner030\fP) pillar referencing for boto profiles seems not completely working right / docu missing (refs: \fI\%#30158\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30158\fP: (\fI\%rallytime\fP) Move _option(value) calls to __salt__[\(aqconfig.option\(aq] in boto utils
@ \fI2016\-01\-06 16:35:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
e36e8e2e73 Merge pull request \fI\%#30158\fP from rallytime/fix\-29905
.IP \(bu 2
3321c5d408 Move _option(value) calls to __salt__[\(aqconfig.option\(aq] in boto utils
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29770\fP: (\fI\%Ch3LL\fP) disk.usage does not work on AIX (refs: \fI\%#30160\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30160\fP: (\fI\%dmurphy18\fP) Fix parsing disk usage for line with no number and AIX values in Kilos
@ \fI2016\-01\-06 16:34:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec009a6812 Merge pull request \fI\%#30160\fP from saltstack/aix_dskusage
.IP \(bu 2
8450df0483 Fix parsing disk usage for line with no number and AIX values in Kilos
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29919\fP: (\fI\%abcfy2\fP) State \fBgrains.append\fP cannot append to a non\-exist grain name. (refs: \fI\%#30162\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30162\fP: (\fI\%rallytime\fP) Update list_present and append grains state function docs to be more clear.
@ \fI2016\-01\-06 16:33:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
f808ffbbbd Merge pull request \fI\%#30162\fP from rallytime/fix\-29919
.IP \(bu 2
9bbd129c60 Update list_present and append grains state function docs to be more clear
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28923\fP: (\fI\%aabognah\fP) passing argument with \(aq=no\(aq to file.line (refs: \fI\%#30163\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30163\fP: (\fI\%rallytime\fP) Add warning about using \(dq=\(dq in file.line function
@ \fI2016\-01\-06 16:32:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
83245930a6 Merge pull request \fI\%#30163\fP from rallytime/fix\-28923
.IP \(bu 2
0e4f91fca2 Add warning about using \(dq=\(dq in file.line function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30164\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-01\-06 16:28:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
106efd258a Merge pull request \fI\%#30164\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
d73a7d6c4d Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
9363d6f5b6 Merge pull request \fI\%#30125\fP from abednarik/update_user_home
.INDENT 2.0
.IP \(bu 2
56544a77f6 Update user home event when createhome is set to False
.UNINDENT
.IP \(bu 2
1a5d585d91 Merge pull request \fI\%#30127\fP from jsutton/clarify\-documentation\-for\-random_master
.INDENT 2.0
.IP \(bu 2
01dbf385ef Adding random_master to reference and updating master_shuffle. Adding master_shuffle to the minion example config file as it is needed for multi\-master PKI.
.UNINDENT
.IP \(bu 2
28b1bbbe77 Merge pull request \fI\%#30110\fP from markckimball/fix\-verify_ssl\-in\-joyent\-cloud
.INDENT 2.0
.IP \(bu 2
e1c08cb269 Fixed flag sent to salt.utils.http in order for verify_ssl to work appropriately.
.UNINDENT
.IP \(bu 2
040412b0b1 Merge pull request \fI\%#30093\fP from zmalone/pillar\-notes
.INDENT 2.0
.IP \(bu 2
cfbfd58afe Noting that file_roots and \(dqstate tree\(dq should both be avoided, because in some environments, the actual states show up another level down.  Adding notes about why this is undesirable.
.UNINDENT
.IP \(bu 2
25edefc93a Merge pull request \fI\%#30097\fP from cachedout/note_on_password_process_list
.INDENT 2.0
.IP \(bu 2
58aec884ef Note concern about cleartext password in docs for shadow.gen_password
.UNINDENT
.IP \(bu 2
6b1c3a6bf2 Merge pull request \fI\%#30089\fP from mpreziuso/patch\-1
.INDENT 2.0
.IP \(bu 2
50533add40 Fixes terminology and adds more accurate details about the algorithms
.UNINDENT
.IP \(bu 2
200d09385d Merge pull request \fI\%#30086\fP from cachedout/issue_29921
.INDENT 2.0
.IP \(bu 2
8c29e2dd6a Document that gitfs needs recent libs
.UNINDENT
.IP \(bu 2
404414bf57 Merge pull request \fI\%#30070\fP from cachedout/issue_27835
.INDENT 2.0
.IP \(bu 2
60431e342a Add documentation on debugging salt\-ssh
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30150\fP: (\fI\%rapenne\-s\fP) file.line reset permissions to 600 (refs: \fI\%#30212\fP, \fI\%#30168\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30168\fP: (\fI\%abednarik\fP) Fix incorrect file permissions in file.line
@ \fI2016\-01\-06 16:25:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
e5d87a02b9 Merge pull request \fI\%#30168\fP from abednarik/2015.8
.IP \(bu 2
79daa25a15 Fix incorrect file permissions in file.line
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30154\fP: (\fI\%Oro\fP) Fix file serialize on windows
@ \fI2016\-01\-05 18:08:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
bed38d1a65 Merge pull request \fI\%#30154\fP from Oro/fix\-file\-serialize\-windows
.IP \(bu 2
071a675f8a Fix file serialize on windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30144\fP: (\fI\%rallytime\fP) Added generic ESXCLI command ability to ESXi Proxy Minion
@ \fI2016\-01\-05 16:23:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
7d51d8bb46 Merge pull request \fI\%#30144\fP from rallytime/vsphere\-esxcli\-cmd
.IP \(bu 2
2f9ec5db96 Added generic ESXCLI command ability to ESXi Proxy Minion
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29994\fP: (\fI\%adithep\fP) dockerng.push should not auto tag :latest (refs: \fI\%#30142\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29993\fP: (\fI\%adithep\fP) Dockerng as a whole is not compatible with v2 registries. (refs: \fI\%#30142\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30142\fP: (\fI\%terminalmage\fP) Fix dockerng.push, and allow for multiple images
@ \fI2016\-01\-04 22:53:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a21b3d46b Merge pull request \fI\%#30142\fP from terminalmage/issue29994
.IP \(bu 2
66698986e4 Fix dockerng.push, and allow for multiple images
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30051\fP: (\fI\%joejulian\fP) glusterfs.status fails with glusterfs 3.7 (refs: \fI\%#30075\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30075\fP: (\fI\%joejulian\fP) Convert glusterfs module to use xml (refs: \fI\%#30405\fP)
@ \fI2016\-01\-04 20:33:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
5419699bd2 Merge pull request \fI\%#30075\fP from iodatacenters/2015.8_gluster_usexml
.IP \(bu 2
01a8e7ee10 Convert glusterfs module to use xml
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30129\fP: (\fI\%optix2000\fP) Clean up _uptodate() in git state
@ \fI2016\-01\-04 20:23:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
a6d94358ed Merge pull request \fI\%#30129\fP from optix2000/2015.8
.IP \(bu 2
c68ea6332a No point to recast comments to a string. _uptodate() should only accept strings for comments.
.IP \(bu 2
6c5bac4909 Properly fix concat list issue in git state.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28814\fP: (\fI\%peter\-slovak\fP) The \(dqvirtual\(dq grain detection with virt\-what on LXC incorrectly yields \(dqphysical\(dq (refs: \fI\%#29589\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30139\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29589\fP to 2015.8
@ \fI2016\-01\-04 20:22:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29589\fP: (\fI\%abednarik\fP) Added lxc in virt\-what list. (refs: \fI\%#30139\fP)
.IP \(bu 2
68dfa0f5de Merge pull request \fI\%#30139\fP from rallytime/bp\-29589
.IP \(bu 2
2c73990ff2 Added lxc in virt\-what list.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29833\fP: (\fI\%iMilnb\fP) salt minion won\(aqt start: Non valid IP address match on BSD alias format (refs: \fI\%#30124\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30124\fP: (\fI\%abednarik\fP) Update regex to detect ip alias in OpenBSD.
@ \fI2016\-01\-04 19:48:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd8d3e6f6b Merge pull request \fI\%#30124\fP from abednarik/fix_openbsd_ip_alias
.IP \(bu 2
595a12977d Update regex to detect ip alias in OpenBSD.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30133\fP: (\fI\%stanislavb\fP) Fix typo in gpgkey URL
@ \fI2016\-01\-04 19:29:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3014be84b Merge pull request \fI\%#30133\fP from stanislavb/fix\-gpg\-key\-url\-typo
.IP \(bu 2
d81f6f7206 Fix typo in gpgkey URL
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29912\fP: (\fI\%rterbush\fP) s3 ext_pillar fails if key and keyid are not provided (refs: \fI\%#30126\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30126\fP: (\fI\%stanislavb\fP) Log S3 API error message
@ \fI2016\-01\-04 19:22:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
c06671a259 Merge pull request \fI\%#30126\fP from stanislavb/2015.8
.IP \(bu 2
8c4a101c8f Log S3 API error message
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30128\fP: (\fI\%oeuftete\fP) Log retryable transport errors as warnings
@ \fI2016\-01\-04 19:15:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
aeec21ea65 Merge pull request \fI\%#30128\fP from oeuftete/fileclient\-attempt\-error\-to\-warning
.IP \(bu 2
a5d99b13e1 Log retryable transport errors as warnings
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28171\fP: (\fI\%srkunze\fP) cron.rm cannot remove @special entries (refs: \fI\%#30096\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30096\fP: (\fI\%cachedout\fP) Add rm_special to crontab module
@ \fI2016\-01\-01 00:56:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
941bcaed07 Merge pull request \fI\%#30096\fP from cachedout/issue_28171
.IP \(bu 2
259a0582ac Add docs
.IP \(bu 2
ad9424820e Add rm_special to crontab module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30106\fP: (\fI\%techhat\fP) Ensure last dir
@ \fI2016\-01\-01 00:52:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
cb0f80831f Merge pull request \fI\%#30106\fP from techhat/seeddirs
.IP \(bu 2
01d1a49937 Ensure last dir
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30101\fP: (\fI\%gtmanfred\fP) fix bug where nova driver exits with no adminPass
@ \fI2015\-12\-31 13:45:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
6bc968db9a Merge pull request \fI\%#30101\fP from gtmanfred/2015.8
.IP \(bu 2
1b98f7af38 fix bug where nova driver exits with no adminPass
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30090\fP: (\fI\%techhat\fP) Add argument to isdir()
@ \fI2015\-12\-30 22:41:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
3652dbae76 Merge pull request \fI\%#30090\fP from techhat/seeddirs
.IP \(bu 2
f7c7d9c7c2 Add lstrip
.IP \(bu 2
c70257163b Add argument to isdir()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30094\fP: (\fI\%rallytime\fP) Fix doc formatting for cloud.create example in module.py state
@ \fI2015\-12\-30 22:40:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
a12bda4b30 Merge pull request \fI\%#30094\fP from rallytime/module_state_doc_fix
.IP \(bu 2
8fbee322b9 Fix doc formatting for cloud.create example in module.py state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30095\fP: (\fI\%rallytime\fP) Add the list_nodes_select function to linode driver
@ \fI2015\-12\-30 21:06:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
d7f46b5438 Merge pull request \fI\%#30095\fP from rallytime/select_query_linode
.IP \(bu 2
4731d9442e Add the list_nodes_select function to linode driver
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28763\fP: (\fI\%cybacolt\fP) grain saltversioninfo not returning values by index (refs: \fI\%#30082\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30082\fP: (\fI\%abednarik\fP) Fixed saltversioninfo grain return
@ \fI2015\-12\-30 18:23:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
dce64c0868 Merge pull request \fI\%#30082\fP from abednarik/fix_grain_saltversion_index
.IP \(bu 2
882e9ac9ed Fixed saltversioninfo grain return.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30084\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29987\fP to 2015.8
@ \fI2015\-12\-30 18:19:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29987\fP: (\fI\%pass\-by\-value\fP) Make sure output file works for salt cloud (refs: \fI\%#30084\fP)
.IP \(bu 2
5602b8833e Merge pull request \fI\%#30084\fP from rallytime/bp\-29987
.IP \(bu 2
16e1df90e9 Make sure output file works for salt cloud
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30071\fP: (\fI\%rallytime\fP) Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
@ \fI2015\-12\-29 23:18:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
654cab0314 Merge pull request \fI\%#30071\fP from rallytime/merge\-forward\-2015.8
.IP \(bu 2
394d7548c5 Additional spelling fixes for boto_vpc module
.IP \(bu 2
f7e58a241c Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.INDENT 2.0
.IP \(bu 2
84db12212d Merge pull request \fI\%#30059\fP from mpreziuso/patch\-1
.INDENT 2.0
.IP \(bu 2
1cb1c2da07 Fixes wrong function scope
.UNINDENT
.IP \(bu 2
1c6c9b1a06 Merge pull request \fI\%#30025\fP from jtand/boto_tests
.INDENT 2.0
.IP \(bu 2
e706642152 Skipping some Boto tests until resolved moto issue
.UNINDENT
.IP \(bu 2
0f91021c59 Merge pull request \fI\%#29949\fP from aletourneau/2015.5
.INDENT 2.0
.IP \(bu 2
cf855fe262 Fixed trailing white spaces
.IP \(bu 2
864801e002 fixed version
.IP \(bu 2
041d9346c4 Enhanced netscaler docstring
.UNINDENT
.IP \(bu 2
229d3eb60b Merge pull request \fI\%#29941\fP from cachedout/boto_spelling
.INDENT 2.0
.IP \(bu 2
b11bfd07b8 Fix spelling error in boto_vpc
.UNINDENT
.IP \(bu 2
69c5ada636 Merge pull request \fI\%#29908\fP from cachedout/issue_29880
.INDENT 2.0
.IP \(bu 2
4cd77b4118 Allow kwargs to be passed to pacman provide for update func
.UNINDENT
.IP \(bu 2
ad0de4d563 Merge pull request \fI\%#29909\fP from abednarik/freebsd_pkgng_non_interactive_fix
.INDENT 2.0
.IP \(bu 2
8ac213001a FreeBSD pkgng fix for non\-interactive install.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30067\fP: (\fI\%ryan\-lane\fP) Pass in kwargs to boto_secgroup.convert_to_group_ids explicitly
@ \fI2015\-12\-29 23:04:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
1bf9853808 Merge pull request \fI\%#30067\fP from lyft/boto\-elb\-stable\-fix
.IP \(bu 2
ae22edb1b4 Pass in kwargs to boto_secgroup.convert_to_group_ids explicitly
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30069\fP: (\fI\%techhat\fP) Ensure that pki_dir exists
@ \fI2015\-12\-29 23:03:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a37c4de1a Merge pull request \fI\%#30069\fP from techhat/seeddirs
.IP \(bu 2
0f05d49bde Ensure that pki_dir exists
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30045\fP: (\fI\%AkhterAli\fP) salt\-cloud make syndic not possible. (refs: \fI\%#30064\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30064\fP: (\fI\%rallytime\fP) Add Syndic documentation to miscellaneous Salt Cloud config options
@ \fI2015\-12\-29 20:15:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
896655602e Merge pull request \fI\%#30064\fP from rallytime/fix\-30045
.IP \(bu 2
6176f383e5 Spelling fixes
.IP \(bu 2
83c05729d6 Add Syndic documentation to miscellaneous Salt Cloud config options
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30049\fP: (\fI\%rallytime\fP) Add some more unit tests for the vsphere execution module
@ \fI2015\-12\-29 17:07:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
bad6daca93 Merge pull request \fI\%#30049\fP from rallytime/esxi\-unit\-tests
.IP \(bu 2
1a83147986 Remove unnecessary import block
.IP \(bu 2
695107ae6e Add some more unit tests for the vsphere execution module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30060\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27104\fP to 2015.8
@ \fI2015\-12\-29 17:06:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27104\fP: (\fI\%hexedpackets\fP) Remove only the file extension when checking missing cached nodes. (refs: \fI\%#30060\fP)
.IP \(bu 2
cedee772d7 Merge pull request \fI\%#30060\fP from rallytime/bp\-27104
.IP \(bu 2
f0566c4b8f Remove only the file extension on cached node files instead of replacing every \(aq.p\(aq substring.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28540\fP: (\fI\%whiteinge\fP) The rest_cherrypy automodule docs are hard to digest (refs: \fI\%#30048\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30048\fP: (\fI\%jacobhammons\fP) Remove internal APIs from rest_cherrypy docs.
@ \fI2015\-12\-28 23:24:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
87667e2de6 Merge pull request \fI\%#30048\fP from jacobhammons/28540
.IP \(bu 2
a04cebd48c Remove internal APIs from rest_cherrypy docs. Refs \fI\%#28540\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29960\fP: (\fI\%anlutro\fP) Circular import in salt.utils.jinja (refs: \fI\%#30043\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30043\fP: (\fI\%rallytime\fP) Be explicit about importing from salt.utils.jinja to avoid circular imports
@ \fI2015\-12\-28 21:35:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
3c63527313 Merge pull request \fI\%#30043\fP from rallytime/fix\-29960
.IP \(bu 2
a157c78bc8 Be explicit about importing from salt.utils.jinja to avoid circular imports
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30038\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30017\fP to 2015.8
@ \fI2015\-12\-28 20:41:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30017\fP: (\fI\%anlutro\fP) Change how alternatives states check for installed (refs: \fI\%#30038\fP)
.IP \(bu 2
6cdca314c7 Merge pull request \fI\%#30038\fP from rallytime/bp\-30017
.IP \(bu 2
aab35b883e Add versionadded directive for new check_exists function.
.IP \(bu 2
ca290ec3e1 change how alternatives states check for installed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30036\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29995\fP to 2015.8
@ \fI2015\-12\-28 20:41:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29995\fP: (\fI\%ruxandraburtica\fP) Location from profiles not correctly set (refs: \fI\%#30036\fP)
.IP \(bu 2
c846e7bc86 Merge pull request \fI\%#30036\fP from rallytime/bp\-29995
.IP \(bu 2
129a6d7b9f Added vm_ to the get_location query.
.IP \(bu 2
af8d01a367 Updated ec2 file to correctly propagate location.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30035\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29895\fP to 2015.8
@ \fI2015\-12\-28 20:20:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29895\fP: (\fI\%pass\-by\-value\fP) Do not SSH to the instance if deploy is False (refs: \fI\%#30035\fP)
.IP \(bu 2
27b0bd2c34 Merge pull request \fI\%#30035\fP from rallytime/bp\-29895
.IP \(bu 2
09f208fe63 Do not SSH to the instance if deploy is False
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30034\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29893\fP to 2015.8
@ \fI2015\-12\-28 20:20:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29893\fP: (\fI\%pass\-by\-value\fP) Add info about VolumeType (refs: \fI\%#30034\fP)
.IP \(bu 2
9e385369b7 Merge pull request \fI\%#30034\fP from rallytime/bp\-29893
.IP \(bu 2
2fcf1590b8 Add info about VolumeType
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30033\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29876\fP to 2015.8
@ \fI2015\-12\-28 20:20:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29876\fP: (\fI\%abednarik\fP) Updated Cloud msic section. (refs: \fI\%#30033\fP)
.IP \(bu 2
4d4dfd692a Merge pull request \fI\%#30033\fP from rallytime/bp\-29876
.IP \(bu 2
a257249789 Add versionadded to SSH Port docs
.IP \(bu 2
0bb83e51aa Updated Cloud msic section.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30029\fP: (\fI\%terminalmage\fP) git.latest: Fix handling of nonexistent branches
@ \fI2015\-12\-28 19:39:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
a5f7d9c2fc Merge pull request \fI\%#30029\fP from terminalmage/git.latest\-nonexistent\-branch
.IP \(bu 2
0b95894c9f git.latest: Fix handling of nonexistent branches
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30016\fP: (\fI\%anlutro\fP) Properly normalize locales in locale.gen_locale
@ \fI2015\-12\-28 15:33:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
e7fe24dc64 Merge pull request \fI\%#30016\fP from alprs/fix\-gen_locale_normalize
.IP \(bu 2
75eb4511d3 properly normalize locales in locale.gen_locale
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30015\fP: (\fI\%anlutro\fP) locale module: don\(aqt escape the slash in \en
@ \fI2015\-12\-28 15:31:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
90611e95f4 Merge pull request \fI\%#30015\fP from alprs/fix\-gen_locale_escaped_newline
.IP \(bu 2
5799729aee locale module: don\(aqt escape the slash in n
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30022\fP: (\fI\%gqgunhed\fP) Two minor typos fixed
@ \fI2015\-12\-28 15:22:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
b871ce5310 Merge pull request \fI\%#30022\fP from gqgunhed/winrepo_typo
.IP \(bu 2
a052ff016e fixed minor typos and a :ref: link
.IP \(bu 2
e47db1a076 Merge remote\-tracking branch \(aqrefs/remotes/saltstack/2015.8\(aq into winrepo_typo
.IP \(bu 2
0c4c8b9b5c Merge remote\-tracking branch \(aqrefs/remotes/saltstack/2015.8\(aq into 2015.8
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30026\fP: (\fI\%anlutro\fP) states.at: fix wrong variable being used
@ \fI2015\-12\-28 15:21:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
4b8ac20d45 Merge pull request \fI\%#30026\fP from alprs/fix\-at_without_tag_job
.IP \(bu 2
c0fe9c09bd states.at: fix wrong variable being used
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29966\fP: (\fI\%multani\fP) Fix bigip state/module documentation + serializers documentation
@ \fI2015\-12\-23 15:06:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
a3410fdf41 Merge pull request \fI\%#29966\fP from multani/fix/docs
.IP \(bu 2
e6e36372a4 doc: fix documentation link for salt.serializers
.IP \(bu 2
23ef472a07 bigip: fix documentation formatting, remove warnings during doc building
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29904\fP: (\fI\%twangboy\fP) Improvements to osx packaging scripts
@ \fI2015\-12\-22 21:40:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29858\fP: (\fI\%twangboy\fP) Osx build (refs: \fI\%#29904\fP)
.IP \(bu 2
8f8c8cedd0 Merge pull request \fI\%#29904\fP from twangboy/osx_build
.IP \(bu 2
0be53953af Added function to download and check hashes, added hash files
.IP \(bu 2
7f0b87bfb3 Added pre/post flight scripts (not running)
.IP \(bu 2
9eeb6da7bd Improvements to osx packaging scripts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29950\fP: (\fI\%multani\fP) boto_iam: fix deletion of IAM users when using delete_keys=true
@ \fI2015\-12\-22 18:43:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
9522bdf4a5 Merge pull request \fI\%#29950\fP from multani/fix/states.boto_iam\-delete\-user
.IP \(bu 2
516c8661f4 boto_iam: fix deletion of IAM users when using delete_keys=true
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29937\fP: (\fI\%multani\fP) Fix states.boto_iam group users
@ \fI2015\-12\-22 17:33:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
be95d4d79a Merge pull request \fI\%#29937\fP from multani/fix/states.boto_iam\-group\-users
.IP \(bu 2
5c86a78d75 boto_iam: handle group\(aqs users empty list by removing all users of the group
.IP \(bu 2
f3461053df boto_iam: passes connection information down to callees
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29934\fP: (\fI\%multani\fP) Fix state.boto_iam virtual name
@ \fI2015\-12\-22 17:16:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
4f2cc5eba7 Merge pull request \fI\%#29934\fP from multani/fix/boto_iam
.IP \(bu 2
503ede4178 Fix state.boto_iam virtual name
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29933\fP: (\fI\%Reiner030\fP) boto_rds.absent misses pillar variables for final backup (refs: \fI\%#29943\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29943\fP: (\fI\%cachedout\fP) Check args correctly in boto_rds
@ \fI2015\-12\-22 17:15:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
b36302291d Merge pull request \fI\%#29943\fP from cachedout/issue_29933
.IP \(bu 2
8bab5eaeaa Check args correctly in boto_rds
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29924\fP: (\fI\%gqgunhed\fP) fixed: uptime now working on non\-US Windows
@ \fI2015\-12\-22 15:03:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
02ed5b8fd1 Merge pull request \fI\%#29924\fP from gqgunhed/gqgunhed\-2015.8
.IP \(bu 2
b67c3b45e1 removed duplicate datetime line
.IP \(bu 2
ed8ee91dcf fixed: uptime now working on non\-US Windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29883\fP: (\fI\%serge\-p\fP) fix for nfs mounts in _active_mounts_openbsd()
@ \fI2015\-12\-21 18:26:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
5e44639334 Merge pull request \fI\%#29883\fP from serge\-p/patch\-6
.IP \(bu 2
dd94332f24 Update mount.py
.IP \(bu 2
9d059a1ea5 fix for nfs mounts in _active_mounts_openbsd()
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29866\fP: (\fI\%tony\fP) spm(1) command should obey Saltfile (refs: \fI\%#29894\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29894\fP: (\fI\%techhat\fP) Support Saltfile in SPM
@ \fI2015\-12\-21 18:03:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
08fd81cc3d Merge pull request \fI\%#29894\fP from techhat/spmsaltfile
.IP \(bu 2
279ec61274 Support Saltfile in SPM
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29856\fP: (\fI\%rallytime\fP) Added some initial unit tests for the salt.modules.vsphere.py file
@ \fI2015\-12\-21 17:12:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
4f46255044 Merge pull request \fI\%#29856\fP from rallytime/esxi\-unit\-tests
.IP \(bu 2
b908ebd123 Added some initial unit tests for the salt.modules.vsphere.py file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29855\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29740\fP to 2015.8
@ \fI2015\-12\-21 17:11:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29740\fP: (\fI\%kiorky\fP) Type mess in git.latest (refs: \fI\%#29855\fP)
.IP \(bu 2
096fec6182 Merge pull request \fI\%#29855\fP from rallytime/bp\-29740
.IP \(bu 2
4c5e277367 Type mess in git.latest
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29890\fP: (\fI\%multani\fP) Various documentation fixes
@ \fI2015\-12\-21 16:25:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
02ab9b8858 Merge pull request \fI\%#29890\fP from multani/fix/docs
.IP \(bu 2
5aa0e9b1e0 Fix documentation typo for pillars
.IP \(bu 2
f2b41d04d7 Fix rendering issues for Cherrypy netapi documentation.
.IP \(bu 2
6922da46dc doc: fix warnings + some rendering issues
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29850\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-12\-18 21:33:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
50f48c4bf3 Merge pull request \fI\%#29850\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
7402599c62 Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.IP \(bu 2
f43f3d166c Merge pull request \fI\%#29730\fP from rallytime/fix\-24698
.INDENT 2.0
.IP \(bu 2
120fd5fdf0 Update docker\-py version requirement to 0.6.0 for dockerio.py files
.UNINDENT
.IP \(bu 2
c393a4175a Merge pull request \fI\%#29715\fP from rallytime/fix\-23343
.INDENT 2.0
.IP \(bu 2
a0ed857c37 Install correct package version, if provided, for npm state.
.UNINDENT
.IP \(bu 2
1310afbbc2 Merge pull request \fI\%#29721\fP from terminalmage/nested\-output\-multiline\-fix
.INDENT 2.0
.IP \(bu 2
761be9cb93 Fix display of multiline strings when iterating over a list
.UNINDENT
.IP \(bu 2
52cc07cec9 Merge pull request \fI\%#29646\fP from rallytime/fix\-29488
.INDENT 2.0
.IP \(bu 2
c5fa9e9351 Don\(aqt stacktrace on kwargs.get if kwargs=None
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29811\fP: (\fI\%anlutro\fP) influxdb: add retention policy module functions
@ \fI2015\-12\-18 17:19:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
05d2aaaef2 Merge pull request \fI\%#29811\fP from alprs/feature\-influxdb_retention
.IP \(bu 2
51088d938a add tests, rename a function to more closely mirror influxdb
.IP \(bu 2
785da17a67 missing comma
.IP \(bu 2
7e9e9a1030 influxdb: add retention policy module functions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29396\fP: (\fI\%Ch3LL\fP) Windows 2012 Multi\-Master ZMQError (refs: \fI\%#29814\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29814\fP: (\fI\%basepi\fP) [2015.8][Windows] Fix multi\-master on windows
@ \fI2015\-12\-18 17:16:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
7eefaac58a Merge pull request \fI\%#29814\fP from basepi/multi\-master.windows.29396
.IP \(bu 2
2405501d75 Add documentation for tcp ipc_mode and multi\-master
.IP \(bu 2
307e867980 For tcp ipc_mode, give each minion different pub/pull ports
.IP \(bu 2
5a21893e82 Fix ipc_mode check in windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29819\fP: (\fI\%rallytime\fP) Add esxi module and state to docs build
@ \fI2015\-12\-18 16:20:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb4eb28645 Merge pull request \fI\%#29819\fP from rallytime/esxi\-docs
.IP \(bu 2
e7c5863468 Add esxi module and state to docs build
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29832\fP: (\fI\%jleimbach\fP) Fixed typo in order to use the keyboard module for RHEL without systemd
@ \fI2015\-12\-18 16:04:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
e865c787a4 Merge pull request \fI\%#29832\fP from jleimbach/fix\-keyboard.py\-for\-rhel\-without\-systemd
.IP \(bu 2
7b72b3c52c Fixed typo in order to use the keyboard module for RHEL without systemd
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29803\fP: (\fI\%rallytime\fP) Add vSphere module to doc ref module tree
@ \fI2015\-12\-17 18:52:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
4044f3bb93 Merge pull request \fI\%#29803\fP from rallytime/vsphere\-docs
.IP \(bu 2
3b7f5540ec Add vSphere module to doc ref module tree
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29751\fP: (\fI\%ether42\fP) mod_hostname behavior is systemd dependent (refs: \fI\%#29767\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29767\fP: (\fI\%abednarik\fP) Hosts file update in mod_hostname.
@ \fI2015\-12\-17 18:31:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
9b4c2194f6 Merge pull request \fI\%#29767\fP from abednarik/network_mod_hpstname_fix
.IP \(bu 2
eebd3e3e4a Hosts file update in mod_hostname.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29631\fP: (\fI\%joshughes\fP) pygit2: git submodules cause traceback in file_list (refs: \fI\%#29772\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29772\fP: (\fI\%terminalmage\fP) pygit2: skip submodules when traversing tree
@ \fI2015\-12\-17 18:23:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
0c65eeb82b Merge pull request \fI\%#29772\fP from terminalmage/issue29631
.IP \(bu 2
8c4ea64b0d pygit2: skip submodules when traversing tree
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29765\fP: (\fI\%gtmanfred\fP) allow nova driver to be boot from volume
@ \fI2015\-12\-17 18:20:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
1b430b251f Merge pull request \fI\%#29765\fP from gtmanfred/2015.8
.IP \(bu 2
e95f7561c5 cloudnetworks should be making public_ips a list
.IP \(bu 2
ec7e45fbfb add documentation for boot from volume on nova driver
.IP \(bu 2
eafcc5e3ac Add boot from volume for openstack nova
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29773\fP: (\fI\%l2ol33rt\fP) Append missing wget in debian installation guide
@ \fI2015\-12\-17 17:29:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
c4f226f31e Merge pull request \fI\%#29773\fP from l2ol33rt/debian_install_docfix
.IP \(bu 2
64cb4b0540 Append missing wget in debian installation guide
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29800\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29769\fP to 2015.8
@ \fI2015\-12\-17 17:28:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29769\fP: (\fI\%pass\-by\-value\fP) Add documentation about scopes (GCE) (refs: \fI\%#29800\fP)
.IP \(bu 2
aca4da3abc Merge pull request \fI\%#29800\fP from rallytime/bp\-29769
.IP \(bu 2
10bfcb8cb0 Add documentation about scopes (GCE)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29775\fP: (\fI\%paulnivin\fP) Change listen requisite resolution from name to ID declaration
@ \fI2015\-12\-16 22:56:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab61f78295 Merge pull request \fI\%#29775\fP from lyft/listen\-id\-declaration\-resolution\-stable
.IP \(bu 2
ff3a809c11 Change listen requisite resolution from name to ID declaration
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29754\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29719\fP to 2015.8
@ \fI2015\-12\-16 17:25:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29719\fP: (\fI\%gqgunhed\fP) fixed: include all items from kern.disks split (refs: \fI\%#29754\fP)
.IP \(bu 2
5af64b64f2 Merge pull request \fI\%#29754\fP from rallytime/bp\-29719
.IP \(bu 2
ed275977e3 fixed: include all items from kern.disks split
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29713\fP: (\fI\%The\-Loeki\fP) Pillar\-based cloud providers still forcing use of deprecated \(aqprovider\(aq
@ \fI2015\-12\-16 14:51:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27953\fP: (\fI\%The\-Loeki\fP) Fix CloudStack cloud for new \(aqdriver\(aq syntax (refs: \fI\%#29713\fP)
.IP \(bu 2
b3f17fdaf8 Merge pull request \fI\%#29713\fP from The\-Loeki/patch\-1
.IP \(bu 2
35fe2a5c18 lint fix
.IP \(bu 2
dfab6f8186 Update __init__.py
.IP \(bu 2
65e2d9ac1e Pillar\-based cloud providers still forcing use of deprecated \(aqprovider\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#14634\fP: (\fI\%Sacro\fP) \(aqunless\(aq documentation isn\(aqt logically plausible (refs: \fI\%#29729\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29729\fP: (\fI\%rallytime\fP) Further clarifications on \(dqunless\(dq and \(dqonlyif\(dq requisites.
@ \fI2015\-12\-16 14:45:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f4810be0f Merge pull request \fI\%#29729\fP from rallytime/fix\-14634
.IP \(bu 2
45b77fb288 Add note about shell truthiness vs python truthiness
.IP \(bu 2
3bfb87c031 Spelling fixes
.IP \(bu 2
15c466cc12 Further clarifications on \(dqunless\(dq and \(dqonlyif\(dq requisites.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29736\fP: (\fI\%akissa\fP) Pillar sqlite3 examples incorrect (refs: \fI\%#29737\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29737\fP: (\fI\%akissa\fP) fix pillar sqlite3 documentation examples
@ \fI2015\-12\-16 14:41:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
7084f79199 Merge pull request \fI\%#29737\fP from akissa/fix\-pillar\-sqlite3\-examples
.IP \(bu 2
1c98f8d609 fix pillar sqlite3 documentation examples
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29741\fP: (\fI\%akissa\fP) Pillar Sqlite3 does not honour database config option when using salt\-call (refs: \fI\%#29743\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29743\fP: (\fI\%akissa\fP) fix pillar sqlite not honouring config options
@ \fI2015\-12\-16 14:40:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
e977096409 Merge pull request \fI\%#29743\fP from akissa/fix\-pillar\-sqlite3\-does\-not\-honour\-config
.IP \(bu 2
6184fb1ae1 fix pillar sqlite not honouring config options
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29152\fP: (\fI\%guettli\fP) docs for states.postgres_user.present: name and password twice? (refs: \fI\%#29723\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29723\fP: (\fI\%rallytime\fP) Clarify db_user and db_password kwargs for postgres_user.present state function
@ \fI2015\-12\-15 23:58:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
2cea0b0a2d Merge pull request \fI\%#29723\fP from rallytime/fix\-29152
.IP \(bu 2
8d8fdd0a27 Clarify db_user and db_password kwargs for postgres_user.present state function
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29154\fP: (\fI\%guettli\fP) [Docs] for cmd.run. Missing link to details for \(dqstateful\(dq (refs: \fI\%#29722\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29722\fP: (\fI\%rallytime\fP) Link \(dqstateful\(dq kwargs to definition of what \(dqstateful\(dq means for cmd state.
@ \fI2015\-12\-15 23:25:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
30eab23c43 Merge pull request \fI\%#29722\fP from rallytime/fix\-29154
.IP \(bu 2
5c045a86af Link \(dqstateful\(dq kwargs to definition of what \(dqstateful\(dq means for cmd state.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29091\fP: (\fI\%gravyboat\fP) Salt pillar best practices should show 2 matchers in base (refs: \fI\%#29724\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29724\fP: (\fI\%rallytime\fP) Add examples of using multiple matching levels to Pillar docs
@ \fI2015\-12\-15 23:02:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
c9ca1a371e Merge pull request \fI\%#29724\fP from rallytime/fix\-29091
.IP \(bu 2
45080f3629 Add examples of using multiple matching levels to Pillar docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29726\fP: (\fI\%cachedout\fP) Disable some boto tests per resolution of moto issue
@ \fI2015\-12\-15 22:15:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
4985cc57f1 Merge pull request \fI\%#29726\fP from cachedout/disable_moto_2015_8
.IP \(bu 2
d19827fd3a Disable some boto tests per resolution of moto issue
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25723\fP: (\fI\%jamesog\fP) file.directory fails in test mode when using recurse ignore_files (refs: \fI\%#29708\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29708\fP: (\fI\%lagesag\fP) Fix test=True for file.directory with recurse ignore_files/ignore_dirs.
@ \fI2015\-12\-15 19:15:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
aba82abffd Merge pull request \fI\%#29708\fP from lagesag/fix\-file\-directory\-test\-mode
.IP \(bu 2
a872b5eecf PyLint fix \fI\%#25723\fP
.IP \(bu 2
3e46cb9213 Fix test=True for file.directory with recurse ignore_files/ignore_dirs.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29199\fP: (\fI\%hubez\fP) 2015.8.1 and 2015.5.6: salt\-minion self\-restart doesn\(aqt work in daemon mode. Works when not a daemon (refs: \fI\%#29642\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29642\fP: (\fI\%cachedout\fP) Correctly restart daemonized minions on failure
@ \fI2015\-12\-15 19:02:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
7c38dec0ad Merge pull request \fI\%#29642\fP from cachedout/issue_29199
.IP \(bu 2
8b2c6817cf Sleep before restart
.IP \(bu 2
4105e2abfb Correctly restart daemonized minions on failure
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29599\fP: (\fI\%cachedout\fP) Clean up minion shutdown
@ \fI2015\-12\-15 19:01:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd918394c3 Merge pull request \fI\%#29599\fP from cachedout/clean_minion_shutdown
.IP \(bu 2
0b917971fe Log at debug level instead
.IP \(bu 2
a04280ceb3 Re\-raise error to preserve restart behavior
.IP \(bu 2
dc480e332a Clean up warning on failed master ping.
.IP \(bu 2
049a3dbbbc Additional fixes.
.IP \(bu 2
8a4969b730 Clean up minion shutdown
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29675\fP: (\fI\%clinta\fP) allow returning all refs
@ \fI2015\-12\-15 18:55:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
31eb291caf Merge pull request \fI\%#29675\fP from clinta/git\-ls\-remote\-noref
.IP \(bu 2
f8c34b0c76 version updated
.IP \(bu 2
73b169e7dd lint, remove trainling whitespace
.IP \(bu 2
8400e68426 allow returning all refs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29683\fP: (\fI\%rallytime\fP) Catch more specific error to pass the error message through elegantly.
@ \fI2015\-12\-15 18:41:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
7c50533d3f Merge pull request \fI\%#29683\fP from rallytime/vsan_fixes
.IP \(bu 2
afc003079e Catch more specific error to pass the error message through elegantly.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29687\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-12\-15 18:38:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
30499e4896 Merge pull request \fI\%#29687\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
b51cba59c0 Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
f606c23ea8 Merge pull request \fI\%#29673\fP from rallytime/fix\-29661
.INDENT 2.0
.IP \(bu 2
e4af7a1157 Default value should be False and not \(aqFalse\(aq
.UNINDENT
.IP \(bu 2
f77c8e7baf Merge pull request \fI\%#29527\fP from jfindlay/2015.5
.INDENT 2.0
.IP \(bu 2
1a8044f0c9 2015.5.7 notes: add note about not being released
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27611\fP: (\fI\%benburkert\fP) PR #26818 broke git.latest with :mirror/:bare  (refs: \fI\%#29681\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29681\fP: (\fI\%clinta\fP) fix bare/mirror in git.latest
@ \fI2015\-12\-15 18:37:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
3c427e82bf Merge pull request \fI\%#29681\fP from clinta/git\-mirror
.IP \(bu 2
b387072a6f fix bare/mirror in git.latest
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29644\fP: (\fI\%rallytime\fP) Fixed a couple more ESXi proxy minion bugs
@ \fI2015\-12\-14 18:36:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
fe0778dad5 Merge pull request \fI\%#29644\fP from rallytime/esxi\-fixes
.IP \(bu 2
577d5487a3 Fixed a couple more ESXi proxy minion bugs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29645\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29558\fP to 2015.8
@ \fI2015\-12\-14 18:11:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29558\fP: (\fI\%ruxandraburtica\fP) Returning security group when no VPC id is given (refs: \fI\%#29645\fP)
.IP \(bu 2
ef2c9e3f61 Merge pull request \fI\%#29645\fP from rallytime/bp\-29558
.IP \(bu 2
2cf9374342 Replaced tabs with spaces.
.IP \(bu 2
5e7e3fe682 Returning security group when no VPC id is given, even if the group is not in EC2\-classic.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29630\fP: (\fI\%c4t3l\fP) Fresh minion install (2015.8.3) returns service __virtual__ is False errors on salt\-calls (refs: \fI\%#29632\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29581\fP: (\fI\%zmalone\fP) Complaints about pyOpenSSL version on Saltstack 2015.8.3 (refs: \fI\%#29632\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29632\fP: (\fI\%jfindlay\fP) reduce severity of tls module __virtual__ logging
@ \fI2015\-12\-11 20:11:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
a2a7f1527b Merge pull request \fI\%#29632\fP from jfindlay/tls_virt
.IP \(bu 2
3ed6a052fd modules.tls.__virtual__: don\(aqt spam everyone\(aqs error log
.IP \(bu 2
76a200e780 modules.tls.__virtual__: refactor cert path comment
.IP \(bu 2
0a0532e598 modules.tls.__virtual__: remove redundant parens
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29598\fP: (\fI\%javicacheiro\fP) Duplicated MTU entry added (refs: \fI\%#29606\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29606\fP: (\fI\%abednarik\fP) Fixed duplicate mtu entry in RedHat 7  network configuration.
@ \fI2015\-12\-11 17:24:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
f6f3aa6613 Merge pull request \fI\%#29606\fP from abednarik/remove_duplicate_mtu_entry_rh7_net_template
.IP \(bu 2
afb2f887ba Fixed duplicate mtu entry in RedHat 7  network configuration.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29613\fP: (\fI\%rallytime\fP) Various ESXi Proxy Minion Bug Fixes
@ \fI2015\-12\-11 17:18:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
c7e73bc4c8 Merge pull request \fI\%#29613\fP from rallytime/esxi\-fixes
.IP \(bu 2
aa5dd88b6f Various ESXi Proxy Minion Bug Fixes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26364\fP: (\fI\%cedwards\fP) [freebsd] TCP transport not working in 2015.8.0rc3 (refs: \fI\%#29628\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29628\fP: (\fI\%DmitryKuzmenko\fP) Don\(aqt create io_loop before fork
@ \fI2015\-12\-11 17:15:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
a56c763423 Merge pull request \fI\%#29628\fP from DSRCompany/bug/26364_freebsd_tcp
.IP \(bu 2
729ffcae36 Don\(aqt create io_loop before fork
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29609\fP: (\fI\%basepi\fP) [2015.8][salt\-ssh] Add ability to set salt\-ssh command umask in roster
@ \fI2015\-12\-10 22:52:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
41b8117237 Merge pull request \fI\%#29609\fP from basepi/salt\-ssh.umask.29574
.IP \(bu 2
0afa5b0d5d Add cmd_umask to roster docs
.IP \(bu 2
5c03f892bc Allow setting the cmd_umask from within the roster
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29586\fP: (\fI\%basepi\fP) Orchestrate doesn\(aqt handle minion error properly (refs: \fI\%#29603\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29546\fP: (\fI\%jefferyharrell\fP) Can\(aqt seem to get orchestrate to recognize a failed state (refs: \fI\%#29603\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29603\fP: (\fI\%basepi\fP) Fix orchestration failure\-checking
@ \fI2015\-12\-10 21:23:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
1e394f5ab1 Merge pull request \fI\%#29603\fP from basepi/orchestrate.failures.29546
.IP \(bu 2
2bdcadaa27 Remove unnecessary and
.IP \(bu 2
501f91a388 Fix error in failure checking for salt.state within orchestration
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29584\fP: (\fI\%kwilliams057\fP) dockerng image\-present fails when trying to pull from registry (refs: \fI\%#29597\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29597\fP: (\fI\%terminalmage\fP) dockerng: Prevent exception when API response contains empty dictionary
@ \fI2015\-12\-10 19:57:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
b5b80b9324 Merge pull request \fI\%#29597\fP from terminalmage/issue29584
.IP \(bu 2
d68067b5db dockerng: Prevent exception when API response contains empty dictionary
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29585\fP: (\fI\%job\fP) cidr argument in salt.modules.network.ip_addrs6() is broken (refs: \fI\%#29587\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29596\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29587\fP to 2015.8
@ \fI2015\-12\-10 19:57:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29587\fP: (\fI\%job\fP) Fix the \(aqcidr\(aq arg in salt.modules.network.ip_addrs6() (refs: \fI\%#29596\fP)
.IP \(bu 2
ffb54cced7 Merge pull request \fI\%#29596\fP from rallytime/bp\-29587
.IP \(bu 2
bfb75ce363 Fix the \(aqcidr\(aq arg in salt.modules.network.ip_addrs6()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29588\fP: (\fI\%rallytime\fP) Added ESXi Proxy Minion Tutorial
@ \fI2015\-12\-10 16:17:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
08dd663a27 Merge pull request \fI\%#29588\fP from rallytime/esxi\-proxy\-tutorial
.IP \(bu 2
5a2bb260d3 Added ESXi Proxy Minion Tutorial
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29557\fP: (\fI\%arthurlogilab\fP) [modules/nova] AttributeError: \(aqmodule\(aq object has no attribute \(aqdiscover_extensions\(aq when using nova.image_list (refs: \fI\%#29572\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29572\fP: (\fI\%gtmanfred\fP) [nova] use old discover_extensions if available
@ \fI2015\-12\-09 17:35:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
fe5db23863 Merge pull request \fI\%#29572\fP from gtmanfred/2015.8
.IP \(bu 2
d0ffa520f4 use old discover_extensions if available
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29009\fP: (\fI\%LoveIsGrief\fP) git.latest doesn\(aqt checkout submodules (refs: \fI\%#29545\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29545\fP: (\fI\%terminalmage\fP) git.latest: init submodules if not yet initialized
@ \fI2015\-12\-09 16:19:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
ecbc60ba05 Merge pull request \fI\%#29545\fP from terminalmage/issue29009
.IP \(bu 2
6619503aec git.latest: init submodules if not yet initialized
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29548\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29449\fP to 2015.8
@ \fI2015\-12\-09 16:19:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29449\fP: (\fI\%AkhterAli\fP) Adding message for null public IP (refs: \fI\%#29548\fP)
.IP \(bu 2
3b2c93a2e5 Merge pull request \fI\%#29548\fP from rallytime/bp\-29449
.IP \(bu 2
3715cd7d65 Adding message for null public IP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29547\fP: (\fI\%rallytime\fP) Refactored ESXCLI\-based functions to accept a list of esxi_hosts
@ \fI2015\-12\-09 16:08:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd67903bf9 Merge pull request \fI\%#29547\fP from rallytime/esxi\-proxy
.IP \(bu 2
469648dd07 Refactored ESXCLI\-based functions to accept a list of esxi_hosts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29563\fP: (\fI\%anlutro\fP) Fix a call to deprecated method in python\-influxdb
@ \fI2015\-12\-09 16:00:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
21437f9235 Merge pull request \fI\%#29563\fP from alprs/fix\-influx_deprecated_method
.IP \(bu 2
7c69c177ed update test
.IP \(bu 2
46d7d92069 fix a call to deprecated method in python\-influxdb
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29565\fP: (\fI\%bdrung\fP) Fix typos and missing release note
@ \fI2015\-12\-09 15:59:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
f29e0a7021 Merge pull request \fI\%#29565\fP from bdrung/2015.8
.IP \(bu 2
b96d8ff1d9 Minor update to release notes for missing fix
.IP \(bu 2
e72354aac4 Fix typo of specific
.IP \(bu 2
5708355762 Fix typo of comparison
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29540\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-12\-08 21:27:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
25d3a75d8c Merge pull request \fI\%#29540\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
e59364ad1d Fix failing unit test
.IP \(bu 2
9673fd0937 Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
867d550271 Merge pull request \fI\%#29539\fP from basepi/merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
2c9c4ba430 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
85aa70a6cb Merge pull request \fI\%#29392\fP from jacobhammons/2014.7
.INDENT 2.0
.IP \(bu 2
d7f0db1dd8 updated version number to not reference a specific build from the latest branch
.UNINDENT
.UNINDENT
.IP \(bu 2
de7f3d5a59 Merge pull request \fI\%#29504\fP from rallytime/fix\-12072
.INDENT 2.0
.IP \(bu 2
8357c95dc2 Document userdata_file option for EC2 driver
.UNINDENT
.IP \(bu 2
65deba8bb5 Merge pull request \fI\%#29507\fP from rallytime/ec2\-doc\-fix
.INDENT 2.0
.IP \(bu 2
90b4823bc2 Switch volumes and del_*_on_destroy example ordering
.UNINDENT
.IP \(bu 2
0918c9294f Merge pull request \fI\%#29469\fP from abednarik/doc_note_for_saltcloud_connection_timeout
.INDENT 2.0
.IP \(bu 2
8e5c3e366a Added Documentation note in salt cloud.
.UNINDENT
.IP \(bu 2
e43c7c05a6 Merge pull request \fI\%#29461\fP from dmyerscough/fix\-resource\-limits
.INDENT 2.0
.IP \(bu 2
85a8a3b033 Fix resource limits, systemd sets the default number of open files to 4096 causing te master to complain about limits when you have a large number of keys
.UNINDENT
.IP \(bu 2
730f02fbdf Merge pull request \fI\%#29439\fP from rallytime/bp\-28656
.INDENT 2.0
.IP \(bu 2
2f11bb021f \fI\%#28526\fP fixed yumpkg module
.UNINDENT
.IP \(bu 2
197210d52e Merge pull request \fI\%#29418\fP from jacobhammons/dot8
.INDENT 2.0
.IP \(bu 2
4f51a737f9 Added CVE 2015\-8034 to 2015.5.8 release notes
.UNINDENT
.IP \(bu 2
b3452f2a1a Merge pull request \fI\%#29389\fP from jacobhammons/2015.5
.INDENT 2.0
.IP \(bu 2
824721ff36 updated version numbers
.UNINDENT
.IP \(bu 2
6a7a95f28a Merge pull request \fI\%#28501\fP from twangboy/jmoney_26898
.INDENT 2.0
.IP \(bu 2
c0cf33332c Fixed some Lint...
.IP \(bu 2
df17fc59d3 Merge pull request \fI\%#6\fP from jfindlay/twang_test
.INDENT 2.0
.IP \(bu 2
bc7e0cfe64 add file.symlink unit tests
.IP \(bu 2
9381dc7215 orthogonalize file.symlink unit tests
.UNINDENT
.IP \(bu 2
8f462ba044 Merge pull request \fI\%#5\fP from cachedout/fix_twangboy_test
.INDENT 2.0
.IP \(bu 2
5293150d25 Fix tests
.UNINDENT
.IP \(bu 2
7d39091c91 Fixed some more lint
.IP \(bu 2
3dbd62af2c Fixed some tests... hopefully
.IP \(bu 2
f187db3288 Removed unnecessary logic
.IP \(bu 2
89ebd268e6 Added file attributes restore on fail
.IP \(bu 2
9ec72ca724 fix file state unit tests for win symlink feature
.IP \(bu 2
69c32a663e Fixed some lint
.IP \(bu 2
638dec5027 Fixed some tests... let\(aqs see if they\(aqre really are
.IP \(bu 2
5ed7a99792 Replaced instances of shutil.rmtree in file state
.IP \(bu 2
2651ce509f Fix file.remove for windows
.UNINDENT
.IP \(bu 2
760a521603 Merge pull request \fI\%#29348\fP from jtand/file_search_fix
.INDENT 2.0
.IP \(bu 2
04f82bd4fd Fixes an file.search on python2.6
.UNINDENT
.IP \(bu 2
51ea88d489 Merge pull request \fI\%#29336\fP from rallytime/bp\-29276
.INDENT 2.0
.IP \(bu 2
3a0e19debb Prevent adding port twice when adding entry in known hosts
.UNINDENT
.IP \(bu 2
28255af52a Merge pull request \fI\%#29333\fP from rallytime/bp\-29280
.INDENT 2.0
.IP \(bu 2
722d02ff4a Lint
.IP \(bu 2
4a0040c1b4 [Doc] Add note for SVN state
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29499\fP: (\fI\%rallytime\fP) Initial commit of ESXi Proxy Minion
@ \fI2015\-12\-08 21:10:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ae096b7ac Merge pull request \fI\%#29499\fP from rallytime/esxi\-proxy
.IP \(bu 2
d8b1ba3991 Make sure ESXCLI gating is correct in vsphere __virtual__
.IP \(bu 2
55589f8021 Provide some more inline comments for longer functions
.IP \(bu 2
baf2f8ce7a Pylint fix
.IP \(bu 2
763ae5d676 VMotion functions, gate ESXCLI requirement, allow protocol/port for ESXCLI function
.IP \(bu 2
d909df254e Bug fixes for esxi states
.IP \(bu 2
7102677679 Bug fixes and move ntp and ssh service start/stop/restart to single funcs
.IP \(bu 2
77b37add84 Added syslog_configured state, and some minor bug fixes
.IP \(bu 2
df49f533f6 More state functions and a couple of bug fixes
.IP \(bu 2
a50c74cfe2 Merge pull request \fI\%#13\fP from cro/esxi\-proxy3
.INDENT 2.0
.IP \(bu 2
87fc980f33 Add syslog config and network firewall rules enable
.UNINDENT
.IP \(bu 2
42be49f481 Merge pull request \fI\%#11\fP from cro/esxi\-proxy
.INDENT 2.0
.IP \(bu 2
d858642f05 Add documentation.
.IP \(bu 2
43879d1dfe Functions for setting network coredumps
.UNINDENT
.IP \(bu 2
7d7d2afa7f Initial commit of ESXi state and refactored vsan_add_disks to include a get function.
.IP \(bu 2
bc945a48db Add execution module functions to upload ssh key for root and retrieve ssh key for root.
.IP \(bu 2
238b0f5bea Update error return policy and add service running/policy functions
.IP \(bu 2
9ba9019419 Initial commit of ESXi proxy work.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29526\fP: (\fI\%jfindlay\fP) 2015.8.2 notes: add note about not being released
@ \fI2015\-12\-08 21:09:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
873f6a9460 Merge pull request \fI\%#29526\fP from jfindlay/2015.8
.IP \(bu 2
917e6f850c 2015.8.2 notes: add note about not being released
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29484\fP: (\fI\%m7v8\fP) patchlevel detection broken for openSuSE (refs: \fI\%#29531\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29531\fP: (\fI\%jfindlay\fP) grains.core: handle undefined variable
@ \fI2015\-12\-08 21:07:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
3de61e3655 Merge pull request \fI\%#29531\fP from jfindlay/suse_patch
.IP \(bu 2
1ad5a088fc grains.core: handle undefined variable
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29486\fP: (\fI\%m7v8\fP) Pull request breaks our setup (umask) (refs: \fI\%#29538\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29005\fP: (\fI\%fcrozat\fP) non\-standard umask breaks salt\-call call in salt\-ssh (refs: \fI\%#29126\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#28830\fP: (\fI\%fcrozat\fP) non\-standard umask breaks salt\-ssh deployement (refs: \fI\%#29126\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29538\fP: (\fI\%basepi\fP) [2015.8] [salt\-ssh] Remove umask around actual execution for salt\-ssh
@ \fI2015\-12\-08 20:45:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29126\fP: (\fI\%fcrozat\fP) Fix deployment when umask is non\-standard (refs: \fI\%#29538\fP)
.IP \(bu 2
1d8014411a Merge pull request \fI\%#29538\fP from basepi/salt\-ssh.umask.29486
.IP \(bu 2
5edfa014f5 Remove umask around actual execution for salt\-ssh
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28715\fP: (\fI\%mlalpho\fP) Tagging Resources with boto_rds (refs: \fI\%#29505\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29505\fP: (\fI\%rallytime\fP) Update boto_rds state docs to include funky yaml syntax for \(dqtags\(dq option.
@ \fI2015\-12\-08 17:05:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb02fc1ef1 Merge pull request \fI\%#29505\fP from rallytime/fix\-28715
.IP \(bu 2
f43f851a92 Update boto_rds state docs to include funky yaml syntax for \(dqtags\(dq option.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29513\fP: (\fI\%bdrung\fP) Drop obsolete syslog.target from systemd services
@ \fI2015\-12\-08 16:05:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
38888add5e Merge pull request \fI\%#29513\fP from bdrung/2015.8
.IP \(bu 2
b1a4ade618 Drop obsolete syslog.target from systemd services
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29500\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29467\fP to 2015.8
@ \fI2015\-12\-07 23:24:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29467\fP: (\fI\%serge\-p\fP) Update module.py (refs: \fI\%#29500\fP)
.IP \(bu 2
148dad6674 Merge pull request \fI\%#29500\fP from rallytime/bp\-29467
.IP \(bu 2
ca0be8bff0 Update module.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29001\fP: (\fI\%olfway\fP) debconf.set doesn\(aqt support \(dqprereq\(dq in states (refs: \fI\%#29463\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29463\fP: (\fI\%abednarik\fP) Add **kwargs to debconf.set.
@ \fI2015\-12\-07 19:56:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d11acc7db Merge pull request \fI\%#29463\fP from abednarik/debconf_fix_prereq_support
.IP \(bu 2
b17f1fed43 Add **kwargs to debconf.set.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29311\fP: (\fI\%Reiner030\fP) Feature Request: System uptime also in seconds (refs: \fI\%#29399\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29399\fP: (\fI\%jfindlay\fP) modules.status: add human_readable option to uptime
@ \fI2015\-12\-07 19:53:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
7efd6dd140 Merge pull request \fI\%#29399\fP from jfindlay/second_up
.IP \(bu 2
1903124814 modules.win_status: add reason to virtual ret
.IP \(bu 2
35ba7da470 modules.status: add reason to __virtual__ return
.IP \(bu 2
48e7beb0eb modules.status: add in_seconds option to uptime
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29433\fP: (\fI\%cro\fP) Files for building .pkg files for MacOS X
@ \fI2015\-12\-07 19:47:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
042daf91b8 Merge pull request \fI\%#29433\fP from cro/mac_native_pkg
.IP \(bu 2
8e191ae264 Add web references
.IP \(bu 2
5f1459d708 Update mac packaging
.IP \(bu 2
092b7ddd0a First crack at build files for Mac OS X Native package
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29445\fP: (\fI\%shawnbutts\fP) salt.loaded.int.module.nova.__virtual__() is wrongly returning \fINone\fP\&. (refs: \fI\%#29455\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29455\fP: (\fI\%jfindlay\fP) modules.nova.__init__: do not return \fBNone\fP
@ \fI2015\-12\-07 19:44:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
5ff3749108 Merge pull request \fI\%#29455\fP from jfindlay/nova_none
.IP \(bu 2
19da8233c8 modules.nova.__init__: do not return \fBNone\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29454\fP: (\fI\%jfindlay\fP) rh_service module __virtual__ return error messages
@ \fI2015\-12\-07 19:32:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
289e9d169e Merge pull request \fI\%#29454\fP from jfindlay/rh_service
.IP \(bu 2
9975508f86 modules.rh_service.__virtual__: handle SUSE osrelease as num
.IP \(bu 2
d7ab7bf51f modules.rh_service: __virtual__ error messages
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29476\fP: (\fI\%tbaker57\fP) Doc fix \- route_table_present needs subnet_names (not subnets) as a key
@ \fI2015\-12\-07 18:47:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
cb465927d6 Merge pull request \fI\%#29476\fP from tbaker57/boto_vpc_docfix
.IP \(bu 2
36946640b8 Fix \- don\(aqt specify \(aqname\(aq key inside the list \- just the subnet names
.IP \(bu 2
5cab4b775a Doc fix \- route_table_present needs subnet_names (not subnets) as a key
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29487\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29450\fP to 2015.8
@ \fI2015\-12\-07 17:25:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29450\fP: (\fI\%pass\-by\-value\fP) Raise error if dracr password is above 20 chars (refs: \fI\%#29487\fP)
.IP \(bu 2
6696cf6eb5 Merge pull request \fI\%#29487\fP from rallytime/bp\-29450
.IP \(bu 2
2c55c55ff1 Raise error if dracr password is above 20 chars
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29133\fP: (\fI\%cedwards\fP) FX2 proxy\-minion dellchassis idrac state incomplete (refs: \fI\%#29441\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29441\fP: (\fI\%rallytime\fP) Make sure docs line up with blade_idrac function specs
@ \fI2015\-12\-05 16:30:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
a1ffc5aacb Merge pull request \fI\%#29441\fP from rallytime/fix\-doc\-dellchassis
.IP \(bu 2
cf62361830 Make sure docs line up with blade_idrac function specs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29440\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28925\fP to 2015.8
@ \fI2015\-12\-05 00:21:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28925\fP: (\fI\%pass\-by\-value\fP) Fx2 firmware update (refs: \fI\%#29440\fP)
.IP \(bu 2
6cc6f776bc Merge pull request \fI\%#29440\fP from rallytime/bp\-28925
.IP \(bu 2
1b57a57c48 Lint fixes
.IP \(bu 2
7cea3afb4f Support multiple hosts
.IP \(bu 2
0be3620715 Set kwarg
.IP \(bu 2
b7324b5102 Add doc for new state
.IP \(bu 2
613dd0b7a2 Make sure creds are set before \fBracadm update\fP
.IP \(bu 2
929e679b25 Add firmware update state to dellchassis
.IP \(bu 2
6356af3b99 Raise error
.IP \(bu 2
820ad7b3df Validate file existence
.IP \(bu 2
94704304ec Add firmware update functions to module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29425\fP: (\fI\%paclat\fP) services for older OEL releases. (refs: \fI\%#29435\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29435\fP: (\fI\%galet\fP) Grains return wrong OS version and other OS related values for Oracle Linux
@ \fI2015\-12\-05 00:19:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
129f45f7c3 Merge pull request \fI\%#29435\fP from galet/2015.8
.IP \(bu 2
fdaa81ccf8 Grains return wrong OS version and other OS related values for Oracle Linux
.IP \(bu 2
c494ddd5fc Grains return wrong OS version and other OS related values for Oracle Linux
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#29313\fP: (\fI\%rmatulat\fP) state/host.present and alias\-assignment to multiple IPs fails (refs: \fI\%#29430\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29430\fP: (\fI\%rmatulat\fP) Fix host.present state limitation
@ \fI2015\-12\-04 23:08:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
e2b43a3f1e Merge pull request \fI\%#29430\fP from rall0r/2015.8
.IP \(bu 2
d3dacff4a2 Fix host.present state limitation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29417\fP: (\fI\%jacobhammons\fP) Repo install updates
@ \fI2015\-12\-04 02:39:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab890b632a Merge pull request \fI\%#29417\fP from jacobhammons/repo\-install\-updates
.IP \(bu 2
d58182c5fa updated repo path for RHEL installation
.IP \(bu 2
5e54359869 Updated Debian, RHEL / Cent, Ubuntu installation instructions with new repo structure for 2015.8.3. Added CVE\-2015\-8034 to release notes.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29402\fP: (\fI\%techhat\fP) Add rate limiting to linode
@ \fI2015\-12\-03 20:27:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
cb1e2e6e73 Merge pull request \fI\%#29402\fP from techhat/ratelimit
.IP \(bu 2
f0a4d93077 Add rate limiting to linode
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19332\fP: (\fI\%QuinnyPig\fP) Nondeterminism in Pillar (refs: \fI\%#29400\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29400\fP: (\fI\%twangboy\fP) Fix \fI\%#19332\fP
@ \fI2015\-12\-03 20:25:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
8fe39d0ef8 Merge pull request \fI\%#29400\fP from twangboy/fix_19332
.IP \(bu 2
7bdddaca53 Fixed grammar
.IP \(bu 2
d965d00a09 Fix \fI\%#19332\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29398\fP: (\fI\%cachedout\fP) Lint 29288
@ \fI2015\-12\-03 18:03:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
d2c0fcbc97 Merge pull request \fI\%#29398\fP from cachedout/lint_29288
.IP \(bu 2
3b0033e529 Lint \fI\%#29288\fP
.IP \(bu 2
386459ca6d Merge pull request \fI\%#1\fP from jfindlay/glustest
.INDENT 2.0
.IP \(bu 2
4d6c71aa80 modules.glusterfs: fix start_volume unit test
.UNINDENT
.IP \(bu 2
f336c44630 Bootstrap failed, retrying
.IP \(bu 2
bd729cb3ea Set default GlusterFS version to 6
.IP \(bu 2
443bfc6a81 Fixed volume status for >= 3.7 in glusterfs.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29116\fP: (\fI\%johnsocp\fP) Unresolvable masters in the minions masters list cause minion to raise an error (refs: \fI\%#29331\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29331\fP: (\fI\%DmitryKuzmenko\fP) Bugfix \- \fI\%#29116\fP raet dns error
@ \fI2015\-12\-03 17:10:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b8e7820ac Merge pull request \fI\%#29331\fP from DSRCompany/bug/29116_raet_dns_error_2
.IP \(bu 2
8c2b217af5 Make pylint happy
.IP \(bu 2
e5672ee716 Don\(aqt exit if no master found
.IP \(bu 2
1c324f5467 Don\(aqt fail if can\(aqt connect to master
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29390\fP: (\fI\%jacobhammons\fP) updated version numbers in documentation
@ \fI2015\-12\-03 17:02:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
7bc6b1210d Merge pull request \fI\%#29390\fP from jacobhammons/2015.8
.IP \(bu 2
486935b233 updated version numbers
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25446\fP: (\fI\%DmitryKuzmenko\fP) Stack overflow on LazyLoader deep copying (refs: \fI\%#29381\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29381\fP: (\fI\%nmadhok\fP) No need to deepcopy since six.iterkeys() creates a copy
@ \fI2015\-12\-03 15:54:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd677e1d58 Merge pull request \fI\%#29381\fP from nmadhok/2015.8\-runtime\-fix
.IP \(bu 2
f109698196 No need to deepcopy since six.iterkeys() creates a copy
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29349\fP: (\fI\%cro\fP) Fix mis\-setting chassis names
@ \fI2015\-12\-03 00:56:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
2973025058 Merge pull request \fI\%#29349\fP from cro/fx2_name_fix
.IP \(bu 2
95d6d72a5d Fix mis\-setting the name of the chassis.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29236\fP: (\fI\%sjorge\fP) network.mod_bufsize has wrong docstring (refs: \fI\%#29237\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29235\fP: (\fI\%sjorge\fP) network.get_bufsize has wrong docstring (refs: \fI\%#29237\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29234\fP: (\fI\%sjorge\fP) network.dig should only be available if we have the \(aqdig\(aq binary (refs: \fI\%#29237\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29233\fP: (\fI\%sjorge\fP) network.default_route does not seem to honor the family parameter (refs: \fI\%#29237\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29232\fP: (\fI\%sjorge\fP) network.active_tcp seems linux specific (refs: \fI\%#29237\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29231\fP: (\fI\%sjorge\fP) docstrings in salt/utils/network.py  are incorrect (refs: \fI\%#29237\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29334\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29237\fP to 2015.8
@ \fI2015\-12\-02 19:37:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29237\fP: (\fI\%sjorge\fP) Module network fixes (refs: \fI\%#29334\fP)
.IP \(bu 2
17d80c051a Merge pull request \fI\%#29334\fP from rallytime/bp\-29237
.IP \(bu 2
598226def1 fix unit test (attempt 1)
.IP \(bu 2
a461d7bf12 changed from Boron to 2015.8.4, so this can be backported
.IP \(bu 2
3892b12514 fix up a few remarks from jfindlay
.IP \(bu 2
2f940e22aa also we should keep returning {} for other systems
.IP \(bu 2
4953f58894 forgot to remove a debug line, how embarasing
.IP \(bu 2
e96f3c0c3b fix docs in salt/utils/network.py \fI\%#29231\fP \- looks like this got copied at some point
.IP \(bu 2
3888bb403f fixup network.default_route with family set on SunOS \fI\%#29233\fP
.IP \(bu 2
c0e6ea98a6 fix network.active_tcp on SunOS (we fake it until we make it) \fI\%#29232\fP
.IP \(bu 2
92f881284e add decorator to network.dig \fI\%#29234\fP
.IP \(bu 2
77950eb55c fix docstring for get_bufsize \fI\%#29235\fP
.IP \(bu 2
52fb80cd18 fix docstring for mod_bufsize \fI\%#29236\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28990\fP: (\fI\%adithep\fP) Dockerng volume (refs: \fI\%#29300\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29300\fP: (\fI\%ticosax\fP) [dockerng] Add support for volume management in dockerng
@ \fI2015\-12\-02 17:48:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
5ec7947595 Merge pull request \fI\%#29300\fP from ticosax/dockerng\-volumes
.IP \(bu 2
80d085ea92 fix typo
.IP \(bu 2
cb9cb463b0 Provide states for managing docker volumes
.IP \(bu 2
dff6fa1fb2 Add execution module to manage docker volumes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29218\fP: (\fI\%clan\fP) check service enable state in test mode
@ \fI2015\-12\-02 15:31:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
99b7d87688 Merge pull request \fI\%#29218\fP from clan/service_state
.IP \(bu 2
a1250a9729 check service enable state in test mode
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29315\fP: (\fI\%jfindlay\fP) dev tutorial doc: fix markup errors
@ \fI2015\-12\-01 21:42:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
08ced73b13 Merge pull request \fI\%#29315\fP from jfindlay/docs
.IP \(bu 2
e8e23dc444 dev tutorial doc: fix markup errors
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29317\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2015\-12\-01 21:28:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
a3a463ff8b Merge pull request \fI\%#29317\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
0d90dd3a19 Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.IP \(bu 2
14e94b3593 Merge pull request \fI\%#29316\fP from basepi/merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
33f40b3c47 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
d2fb2109a3 Merge pull request \fI\%#29296\fP from douardda/patch\-3
.IP \(bu 2
d2885390f4 Use process KillMode on Debian systems also
.UNINDENT
.IP \(bu 2
6a2ffbfb7c Merge pull request \fI\%#29216\fP from clan/file_search_on_proc_file
.INDENT 2.0
.IP \(bu 2
91a20c07a1 try mmap first
.IP \(bu 2
8aa4f2053e remove extra space to fix lint failure
.IP \(bu 2
d34e6b1a9a use read only if has read() method
.IP \(bu 2
3209c1cdb5 size is 0 doesn\(aqt mean no data, e.g, /proc/version
.UNINDENT
.IP \(bu 2
d6aaae8d7b Merge pull request \fI\%#29261\fP from attiasr/patch\-1
.INDENT 2.0
.IP \(bu 2
7a99b90596 add log and return if pkg already installed
.IP \(bu 2
1843c7ab8e fix incorrect reinstallation of windows pkg
.UNINDENT
.IP \(bu 2
9236188867 Merge pull request \fI\%#29214\fP from cro/ssl_verify_ssl
.INDENT 2.0
.IP \(bu 2
e9c13c561b Doc bug\-\-salt.utils.http takes verify_ssl not ssl_verify.
.UNINDENT
.IP \(bu 2
df7b35a86b Merge pull request \fI\%#29204\fP from lorengordon/fix\-29202
.IP \(bu 2
b1dae5e6fe Use os.path.join to return full path to ca bundle
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29240\fP: (\fI\%clan\fP) handle acl_type [[d]efault:][user|group|mask|other]
@ \fI2015\-12\-01 17:56:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
39667fda12 Merge pull request \fI\%#29240\fP from clan/linux_acl
.IP \(bu 2
02429aca69 handle acl_type [[d]efault:][user|group|mask|other]
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29305\fP: (\fI\%lorengordon\fP) Add \(aqfile\(aq as a source_hash proto
@ \fI2015\-12\-01 17:39:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
027bed7c90 Merge pull request \fI\%#29305\fP from lorengordon/source_hash_protos
.IP \(bu 2
53fdf0bf97 Update message for invalid source_hash
.IP \(bu 2
2d20d71bd5 Add \fIfile\fP as a source_hash proto
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29251\fP: (\fI\%adamsewell\fP) status.uptime causes exception on Windows minion 2015.8.1 (refs: \fI\%#29272\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29272\fP: (\fI\%jfindlay\fP) win_status module: handle 12 hour time in uptime
@ \fI2015\-12\-01 16:33:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
1129ee1d2e Merge pull request \fI\%#29272\fP from jfindlay/win_up_time
.IP \(bu 2
6a2315109e win_status module: python timedelta to find uptime
.IP \(bu 2
b7a535341f win_status module: handle 12 hour time in uptime
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26526\fP: (\fI\%JensRantil\fP) Managing a \fI\%file://\fP source fails (refs: \fI\%#29289\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29289\fP: (\fI\%terminalmage\fP) file.managed: Allow local file sources to use source_hash
@ \fI2015\-12\-01 16:19:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
0fd3e8b0fb Merge pull request \fI\%#29289\fP from terminalmage/issue26526
.IP \(bu 2
64ae3f996e file.managed: Allow local file sources to use source_hash
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29262\fP: (\fI\%anlutro\fP) ssh_auth.absent removes keys when test=True (refs: \fI\%#29264\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29264\fP: (\fI\%anlutro\fP) Prevent ssh_auth.absent from running when test=True
@ \fI2015\-11\-30 21:54:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
8d32d8d43d Merge pull request \fI\%#29264\fP from alprs/fix\-ssh_auth_absent_test
.IP \(bu 2
9193676f9c fix ssh_auth_test
.IP \(bu 2
febbfa792f prevent ssh_auth.absent from running when test=True
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29071\fP: (\fI\%eliasp\fP) \fIgit_pillar.update\fP runner can\(aqt handle >=2015.8.0 configuration (refs: \fI\%#29277\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29277\fP: (\fI\%terminalmage\fP) Update git_pillar runner to support new git ext_pillar config schema
@ \fI2015\-11\-30 21:39:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
459d30f27f Merge pull request \fI\%#29277\fP from terminalmage/issue29071
.IP \(bu 2
6981bb3be7 Update git_pillar runner to support new git ext_pillar config schema
.IP \(bu 2
293c8e635c Separate repo locking logic into its own function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29283\fP: (\fI\%cachedout\fP) Single\-quotes and use format
@ \fI2015\-11\-30 21:34:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29139\fP: (\fI\%thomaso\-mirodin\fP) [salt\-ssh] Add a range roster and range targeting options for the flat roster (refs: \fI\%#29283\fP)
.IP \(bu 2
df1f0d93c7 Merge pull request \fI\%#29283\fP from cachedout/style_29139
.IP \(bu 2
d764497b17 Single\-quotes and use format
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29139\fP: (\fI\%thomaso\-mirodin\fP) [salt\-ssh] Add a range roster and range targeting options for the flat roster (refs: \fI\%#29283\fP)
@ \fI2015\-11\-30 21:25:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
3aa84b6763 Merge pull request \fI\%#29139\fP from thomaso\-mirodin/salt\-ssh\-flat\-roster\-range\-filter
.IP \(bu 2
56b3302fe9 Pylint fixes for PR \fI\%#29139\fP
.IP \(bu 2
e010f2d3b5 Add a range roster for salt\-ssh
.IP \(bu 2
c5eeb77ebc Add range support to salt\-ssh\(aqs flat roster
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29282\fP: (\fIcachedout\fP) dev docs: add development tutorial (refs: \fI\%#29282\fP)
@ \fI2015\-11\-30 21:14:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
dbf7755aa2 Merge pull request \fI\%#29282\fP from cachedout/fix_29279
.IP \(bu 2
1efaab2dd5 Fix typo in \fI\%#29279\fP
.IP \(bu 2
a5ea39132f dev docs: add development tutorial
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28991\fP: (\fI\%timcharper\fP) allow role\-assumption with s3 credentials (refs: \fI\%#28994\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28994\fP: (\fI\%timcharper\fP) add support to s3 for aws role assumption
@ \fI2015\-11\-30 20:52:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
87e4aa4fae Merge pull request \fI\%#28994\fP from timcharper/2015.8.1\-dev
.IP \(bu 2
e060986828 add support to s3 for aws role assumption
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29209\fP: (\fI\%ssgward\fP) SPM logging level doesn\(aqt seem to be functional (refs: \fI\%#29278\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29278\fP: (\fI\%techhat\fP) Add verify_log to SPM
@ \fI2015\-11\-30 20:48:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
3d16434f14 Merge pull request \fI\%#29278\fP from techhat/issue29209
.IP \(bu 2
759e8c4542 Add verify_log to SPM
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29067\fP: (\fI\%jacksontj\fP) Fix infinite recursion in state compiler for prereq of SLSs
@ \fI2015\-11\-30 20:27:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
d651d7167e Merge pull request \fI\%#29067\fP from jacksontj/2015.8
.IP \(bu 2
64e439cda2 Add test for infinite recursion with sls prerequisites
.IP \(bu 2
d687682016 No reason to continuously resolve the k, v pair here since it doesn\(aqt change in the inner loop
.IP \(bu 2
6d747df5db Correctly resolve requisite_in for SLS requisites
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29161\fP: (\fI\%jefferyharrell\fP) saltmod.state\(aqs ret argument seems to do nothing (refs: \fI\%#29207\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29207\fP: (\fI\%jfindlay\fP) do not shadow ret function argument
@ \fI2015\-11\-30 20:14:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
d42bcea905 Merge pull request \fI\%#29207\fP from jfindlay/ret_non_shadow
.IP \(bu 2
5de0b93ac6 saltutil.cmd module: do not shadow ret function argument
.IP \(bu 2
7809f2a389 saltmod.state state: do not shadow ret function argument
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29215\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29192\fP to 2015.8
@ \fI2015\-11\-30 20:12:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29192\fP: (\fI\%bastiaanb\fP) fix issue 29191: only try partial matches when a wildcard has been sp… (refs: \fI\%#29215\fP)
.IP \(bu 2
8cc1d8de46 Merge pull request \fI\%#29215\fP from rallytime/bp\-29192
.IP \(bu 2
5226cd8f79 remove trailing whitespace fix subdict_match test cases
.IP \(bu 2
44713cdb95 fix issue 29191: only try partial matches when a wildcard has been specified
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29217\fP: (\fI\%clan\fP) show duration only if state_output_profile is False
@ \fI2015\-11\-30 20:11:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#19320\fP: (\fI\%clan\fP) add \(aqstate_output_profile\(aq option for profile output (refs: \fI\%#29217\fP)
.IP \(bu 2
f488d25911 Merge pull request \fI\%#29217\fP from clan/highstate_duration
.IP \(bu 2
9bdaae8325 show duration only if state_output_profile is False
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29221\fP: (\fI\%ticosax\fP) [dokcerng] Docu network mode
@ \fI2015\-11\-30 19:22:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
e5bd1c293d Merge pull request \fI\%#29221\fP from ticosax/docu\-network_mode
.IP \(bu 2
a0b674a0ea Extend documentation of network_mode parameter.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29250\fP: (\fI\%adamsewell\fP) status.cpu_load is not available on Salt 2015.8.1 (refs: \fI\%#29269\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29269\fP: (\fI\%jfindlay\fP) win_status module: fix function names in docs
@ \fI2015\-11\-30 19:14:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
7fd02c2145 Merge pull request \fI\%#29269\fP from jfindlay/winstatus
.IP \(bu 2
f2f2dab491 win_status module: fix function names in docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29213\fP: (\fI\%rallytime\fP) Move _wait_for_task func from vmware cloud to vmware utils
@ \fI2015\-11\-30 18:53:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c2e62f7d4 Merge pull request \fI\%#29213\fP from rallytime/vmware_utils_wait_for_task
.IP \(bu 2
44e7f83686 Move _wait_for_task func from vmware cloud to vmware utils
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29271\fP: (\fI\%techhat\fP) Pass full path for digest (SPM)
@ \fI2015\-11\-30 18:35:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
69cbc09ca0 Merge pull request \fI\%#29271\fP from techhat/issue29212
.IP \(bu 2
6cd6a0ace0 Pass full path for digest (SPM)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29244\fP: (\fI\%isbm\fP) List products consistently across all SLES systems
@ \fI2015\-11\-30 18:31:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
1efe484309 Merge pull request \fI\%#29244\fP from isbm/isbm\-zypper\-products
.IP \(bu 2
db36a73b16 Remove code duplication
.IP \(bu 2
d62abedbf7 Remove dead code
.IP \(bu 2
302b5d3bc1 List products consistently across all SLES systems
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29119\fP: (\fI\%mo\-mughrabi\fP) salt.modules.consul.catalog_register does not accept address as a string (refs: \fI\%#29255\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29255\fP: (\fI\%garethgreenaway\fP) fixes to consul module
@ \fI2015\-11\-30 18:30:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
318ad36449 Merge pull request \fI\%#29255\fP from garethgreenaway/29119_consul_module_fixes
.IP \(bu 2
655b0ec403 various fixes to the consul execution module, in particular a fix to address \fI\%#29119\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29208\fP: (\fI\%whytewolf\fP) Glance more profile errors
@ \fI2015\-11\-25 23:50:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
b225263279 Merge pull request \fI\%#29208\fP from whytewolf/glance_more_profile_errors
.IP \(bu 2
c8fe514ec1 found 3 more spots where the profile was not being passed through.
.IP \(bu 2
b2e3c1f8de Merge pull request \fI\%#1\fP from saltstack/2015.8
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29140\fP: (\fI\%davidballano\fP) mount.unmounted is not behaving as I would expect (refs: \fI\%#29200\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29200\fP: (\fI\%jfindlay\fP) mount state: unmount by device is optional
@ \fI2015\-11\-25 20:03:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
6d3c04516f Merge pull request \fI\%#29200\fP from jfindlay/singular_umount
.IP \(bu 2
b54de47b1b mount state: unmount by device is optional
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29187\fP: (\fI\%trevor\-h\fP) salt\-cloud Windows provisioning on EC2 fails to use winrm (refs: \fI\%#29205\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29205\fP: (\fI\%trevor\-h\fP) Fixes \fI\%#29187\fP \- using winrm on EC2
@ \fI2015\-11\-25 20:00:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
fffcf9fef6 Merge pull request \fI\%#29205\fP from trevor\-h/fix\-salt\-cloud\-winrm\-ec2
.IP \(bu 2
48e0edd0d2 Fixes \fI\%#29187\fP \- using winrm on EC2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29170\fP: (\fI\%cachedout\fP) Migrate pydsl tests to integration test suite
@ \fI2015\-11\-25 19:56:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
1937a47dec Merge pull request \fI\%#29170\fP from cachedout/refactor_pydsl_test
.IP \(bu 2
2477ff2eab Add __init__ and pydsl test
.IP \(bu 2
063f075a99 Add integration renderer tests to the suite
.IP \(bu 2
81bf332be4 Migrate pydsl tests to integration test suite
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29137\fP: (\fI\%Dravu\fP) MTU is output twice when used in network.managed (refs: \fI\%#29198\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29198\fP: (\fI\%jfindlay\fP) rh_ip module: only set the mtu once
@ \fI2015\-11\-25 18:11:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
11d68f7b1c Merge pull request \fI\%#29198\fP from jfindlay/single_mtu
.IP \(bu 2
0a8952f6ac rh_ip module: only set the mtu once
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29111\fP: (\fI\%eliasp\fP) Backtrace in state \fIssh_known_hosts.present\fP when \fIssh\-keygen\fP is not available (refs: \fI\%#29135\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29135\fP: (\fI\%jfindlay\fP) ssh_known_hosts.present state: catch not found exc
@ \fI2015\-11\-25 18:10:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
f19355e0bb Merge pull request \fI\%#29135\fP from jfindlay/ssh_except
.IP \(bu 2
363add7131 ssh_known_hosts.present state: catch not found exc
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29196\fP: (\fI\%s0undt3ch\fP) We need novaclient imported to compare versions
@ \fI2015\-11\-25 17:16:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a12197e13 Merge pull request \fI\%#29196\fP from s0undt3ch/2015.8
.IP \(bu 2
78a7c34f2b We need novaclient imported to compare versions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28072\fP: (\fI\%jchv\fP) pygit 0.23.2 is not supported in Salt 2015.8.1 (refs: \fI\%#29059\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29059\fP: (\fI\%terminalmage\fP) Work around upstream pygit2 bug
@ \fI2015\-11\-25 16:39:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
0c0e15d4e9 Merge pull request \fI\%#29059\fP from terminalmage/issue28072
.IP \(bu 2
82e223087e Work around upstream pygit2 bug
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29112\fP: (\fI\%eliasp\fP) Prevent backtrace (KeyError) in \fIssh_known_hosts.present\fP state
@ \fI2015\-11\-25 16:25:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
cc69c87dd2 Merge pull request \fI\%#29112\fP from eliasp/ssh_known_hosts.present\-backtrace\-test
.IP \(bu 2
3f19c311e8 Prevent backtrace (KeyError) in \fIssh_known_hosts.present\fP state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29178\fP: (\fI\%whytewolf\fP) Profile not being passed to keystone.endpoint_get in _auth. so if a p…
@ \fI2015\-11\-25 16:09:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
7775d65089 Merge pull request \fI\%#29178\fP from whytewolf/glance_keystone_profile_fix
.IP \(bu 2
807dd426a6 Profile not being passed to keystone.endpoint_get in _auth. so if a profiles are being used, then keystone.endpoint_get will not be able to authenticate causing glance to not be able to get its endpoint.
.UNINDENT
.UNINDENT
.SS Salt 2015.8.5 Release Notes
.sp
Version 2015.8.5 is a bugfix release for \fI\%2015.8.0\fP\&.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
About this Release
Salt 2015.8.5 is identical to the 2015.8.4 release with the addition of a
fix for \fI\%issue 30820\fP, fixed by \fI\%PR 30833\fP\&. See \fI\%here\fP for the 2015.8.4 release notes.
.UNINDENT
.UNINDENT
.SS Known Issue in \fBboto_*\fP execution modules
.sp
This release contains an issue that causes the \fBboto_*\fP execution modules to
display a \fB__salt__ not defined\fP error (\fI\%issue 30300\fP). This issue will be
fixed in an upcoming release, but can be manually resolved by completing the
following:
.INDENT 0.0
.IP 1. 3
Download the \fBboto_*\fP execution modules that you would like to update from
the 2015.8 branch of Salt. A complete list of affected modules with the
specific changes is available in :pull\(ga30867\(ga.
.sp
A simple way to get the updated modules is to \fI\%download\fP a zip file of the
2015.8 branch from GitHub. The updated modules are in the \fBsalt\emodules\fP
directory.
.IP 2. 3
Place the \fBboto_*\fP modules into \fBsalt://_modules\fP\&.
.IP 3. 3
Run the following command to sync these modules to all Salt minions:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq saltutil.sync_modules
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Changelog for v2015.8.4..v2015.8.5
.sp
\fIGenerated at: 2018\-05\-27 23:47:32 UTC\fP
.INDENT 0.0
.IP \(bu 2
c7db4350d5 Fix regression in scanning for state with \(aqname\(aq param
.UNINDENT
.SS Salt 2015.8.7 Release Notes
.sp
Version 2015.8.7 is a bugfix release for \fI\%2015.8.0\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Salt 2015.8.4, 2015.8.5, and 2015.8.7 were all released within a short
period due to regressions found soon after the releases of 2015.8.4 and
2015.8.5. See \fI\%here\fP for the 2015.8.4 release
notes, and \fI\%here\fP for the 2015.8.5 release notes.
.UNINDENT
.UNINDENT
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB2\fP
.IP \(bu 2
Total Issue References: \fB1\fP
.IP \(bu 2
Total PR References: \fB5\fP
.IP \(bu 2
Contributors: \fB4\fP (\fI\%gtmanfred\fP, \fI\%justinta\fP, \fI\%pass\-by\-value\fP, \fI\%terminalmage\fP)
.UNINDENT
.SS Change to Epoch Support for YUM/DNF
.sp
For \fI\%pkg.installed\fP states, on Linux
distributions which use yum/dnf, packages which have a non\-zero epoch in the
version number now require this epoch to be included when specifying an exact
version for a package. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim\-enhanced:
  pkg.installed:
    \- version: 2:7.4.160\-1.el7
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fI\%pkg.latest_version\fP and
\fI\%pkg.list_repo_pkgs\fP functions
can be used to get the correct version string to use, as they will now contain
the epoch when it is non\-zero.
.SS Changelog for v2015.8.5..v2015.8.7
.sp
\fIGenerated at: 2018\-05\-28 00:17:59 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#31111\fP: (\fI\%justinta\fP) Fixes failing npm test on arch.
@ \fI2016\-02\-10 21:51:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
8d84c636cf Merge pull request \fI\%#31111\fP from jtand/8_4_npm_fix
.IP \(bu 2
b0a48e5ef2 Fixes failing npm test on arch.
.IP \(bu 2
\fBPR\fP \fI\%#30217\fP: (\fI\%pass\-by\-value\fP) Make sure cloud actions can be called via salt run
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31014\fP: (\fI\%gtmanfred\fP) [2015.8] pkg breaks for yum pkgs.latest if the packages has an epoch (refs: \fI\%#31031\fP, \fI\%#31015\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31092\fP: (\fI\%terminalmage\fP) Apply PR \fI\%#31031\fP to 2015.8.4.follow_up
@ \fI2016\-02\-10 20:54:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31031\fP: (\fI\%terminalmage\fP) More complete fix for \fI\%#31014\fP (refs: \fI\%#31092\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31015\fP: (\fI\%gtmanfred\fP) include possible epoch in version for rpm (refs: \fI\%#31031\fP)
.IP \(bu 2
5a6a93e98b Merge pull request \fI\%#31092\fP from terminalmage/issue31014\-2015.8.4.follow_up
.INDENT 2.0
.IP \(bu 2
2767a4e519 Don\(aqt handle epoch specially for dnf
.IP \(bu 2
e5dfcc0ef2 More efficient way to add the epoch before version number
.IP \(bu 2
ed7462793c include possible epoch in version for rpm
.UNINDENT
.IP \(bu 2
6c6b66aedd Comment multiprocessing line in minion config
.IP \(bu 2
1f7dfefc4a Set multiprocessing to true in config.py
.IP \(bu 2
433c645c20 Fix remove placeholder files
.IP \(bu 2
71037560d4 Remove placeholder files
.IP \(bu 2
20b381fdf7 Set overwrite to off
.IP \(bu 2
ca50f56d6c Fix boto_secgroup
.IP \(bu 2
fd571d23de Fix boto test failures
.IP \(bu 2
cfb6588744 Fix regression when contents_pillar/contents_grains is a list.
.IP \(bu 2
881d8669e3 utils.aws: use time lib to conver to epoch seconds
.IP \(bu 2
31412920fc The call to cp.get_url needs the saltenv, if you\(aqre using environments other than base, it will fail.
.IP \(bu 2
a8694014a9 Fix regression in git_pillar when multiple remotes are configured
.IP \(bu 2
2243f25be5 Properly set the default value for pillar_merge_lists
.IP \(bu 2
c7472ff6aa Lint
.IP \(bu 2
d868711a83 Fix failing boto_vpc module unit tests
.IP \(bu 2
ed09516469 Fix failing state module tests
.IP \(bu 2
fd0e940088 Pylint fix
.IP \(bu 2
bc780a7c25 Don\(aqt use pack=pack. Just pass in pack=__salt__ always.
.IP \(bu 2
1ae022dbfe Pass in \(aqpack\(aq variable to utils.boto.assign_funcs function from ALL boto modules.
.IP \(bu 2
1efaff107d Remove bad symlinks in osx pkg dirs
.UNINDENT
.UNINDENT
.SS Salt 2015.8.8 Release Notes
.sp
Version 2015.8.8 is a bugfix release for \fI\%2015.8.0\fP\&.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
Version \fI\%2015.8.8.2\fP was released shortly after
2015.8.8 to fix several known issues.  If you installed 2015.8.8 before
03/30/2016, you likely have installed 2015.8.8 and can optionally upgrade
(find out which version you have installed using \fBsalt \-\-version\fP\&.
.UNINDENT
.UNINDENT
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB313\fP
.IP \(bu 2
Total Issue References: \fB146\fP
.IP \(bu 2
Total PR References: \fB312\fP
.IP \(bu 2
Contributors: \fB74\fP (\fI\%Ch3LL\fP, \fI\%DmitryKuzmenko\fP, \fI\%JohannesEbke\fP, \fI\%RabidCicada\fP, \fI\%Talkless\fP,
\fI\%The\-Loeki\fP, \fI\%abednarik\fP, \fI\%anlutro\fP, \fI\%basepi\fP, \fI\%bdrung\fP, \fI\%cachedout\fP,
\fI\%captaininspiration\fP, \fI\%clarkperkins\fP, \fI\%clinta\fP, \fI\%cro\fP, \fI\%darix\fP, \fI\%dmacvicar\fP, \fI\%dr4Ke\fP,
\fI\%dschaller\fP, \fI\%edencrane\fP, \fI\%garethgreenaway\fP, \fI\%gladiatr72\fP, \fI\%gtmanfred\fP, \fI\%iacopo\-papalini\fP,
\fI\%isbm\fP, \fI\%jacksontj\fP, \fI\%jacobhammons\fP, \fI\%jakehilton\fP, \fI\%jespada\fP, \fI\%jfindlay\fP, \fI\%joejulian\fP,
\fI\%justinta\fP, \fI\%kiorky\fP, \fI\%kraney\fP, \fI\%llua\fP, \fI\%mcalmer\fP, \fI\%mchugh19\fP, \fI\%mew1033\fP, \fI\%mlalpho\fP,
\fI\%moltob\fP, \fI\%multani\fP, \fI\%myii\fP, \fI\%opdude\fP, \fI\%paiou\fP, \fI\%pass\-by\-value\fP, \fI\%peripatetic\-sojourner\fP,
\fI\%pprince\fP, \fI\%rallytime\fP, \fI\%redmcg\fP, \fI\%replicant0wnz\fP, \fI\%rhansen\fP, \fI\%rmtmckenzie\fP, \fI\%s0undt3ch\fP,
\fI\%sakateka\fP, \fI\%sbreidba\fP, \fI\%seanjnkns\fP, \fI\%sjmh\fP, \fI\%sjorge\fP, \fI\%skizunov\fP, \fI\%szeestraten\fP,
\fI\%tbaker57\fP, \fI\%techhat\fP, \fI\%terminalmage\fP, \fI\%thusoy\fP, \fI\%ticosax\fP, \fI\%twangboy\fP, \fI\%virtualguy\fP,
\fI\%vutny\fP, \fI\%whiteinge\fP, \fI\%xmj\fP, \fI\%xopher\-mc\fP, \fI\%yannis666\fP, \fI\%youngnick\fP, \fI\%zygiss\fP)
.UNINDENT
.SS Security Fix
.sp
\fBCVE\-2016\-3176\fP Insecure configuration of PAM external authentication service
.sp
This issue affects all Salt versions prior to 2015.8.8/2015.5.10 when PAM
\fI\%external authentication\fP is enabled. This issue involves
passing an alternative PAM authentication service with a command that is sent
to \fI\%LocalClient\fP, enabling the attacker to bypass the
configured authentication service. Thank you to Dylan Frese <\fI\%dmfrese@gmail.com\fP>
for bringing this issue to our attention.
.sp
This update defines the PAM eAuth \fBservice\fP that users authenticate against
in the Salt Master configuration.
.SS Read Before Upgrading Debian 7 (Wheezy) from 2015.8.7 to 2015.8.8
.sp
Before you upgrade from 2015.8.7 on Debian 7, you must run the following
commands to remove previous packages:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo apt\-get remove python\-pycrypto
sudo apt\-get remove python\-apache\-libcloud
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that \fBpython\-pycrypto\fP will likely remove \fBpython\-apache\-libcloud\fP, so
the second command might not be necessary. These have been replaced by
\fBpython\-crypto\fP and \fBpython\-libcloud\fP with ~bpo70+1 moniker.
.SS Read Before Upgrading Debian 8 (Jessie) from Salt Versions Earlier than 2015.8.4
.sp
Salt \fBsystemd\fP service files are missing the following statement in these
versions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[Service]
KillMode=process
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This statement must be added to successfully upgrade on these earlier versions
of Salt.
.SS Changelog for v2015.8.7..v2015.8.8
.sp
\fIGenerated at: 2018\-05\-28 00:23:11 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#31964\fP: (\fI\%jfindlay\fP) update 2015.8.8 release notes
@ \fI2016\-03\-17 21:22:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
b9d0336cf8 Merge pull request \fI\%#31964\fP from jfindlay/2015.8
.IP \(bu 2
b984659678 update 2015.8.8 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31586\fP: (\fI\%frogunder\fP) Proxy minion service.modules fails (refs: \fI\%#31601\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#31585\fP: (\fI\%frogunder\fP) Proxy minion commands causing exceptions (refs: \fI\%#31601\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31947\fP: (\fI\%cro\fP) Move proxymodule assignment earlier in proxy minion init
@ \fI2016\-03\-17 18:14:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31601\fP: (\fI\%cro\fP) Proxy fixes for \fI\%#31585\fP and \fI\%#31586\fP
.IP \(bu 2
fefb694104 Merge pull request \fI\%#31947\fP from cro/bp\-31601
.IP \(bu 2
4eb193edb7 Lint, unrelated but fixed anyway.
.IP \(bu 2
d661081016 Lint.
.IP \(bu 2
59e0a6f923 Don\(aqt add this file
.IP \(bu 2
c68b968403 Old\-style proxymodules need to be setup earlier in minion init. Also include more correct comments in config.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31948\fP: (\fI\%rallytime\fP) Revert \(dqnot not\(dq deletion and add comment as to why that is there
@ \fI2016\-03\-17 17:00:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
a86490ee68 Merge pull request \fI\%#31948\fP from rallytime/disable\-pylint\-error
.IP \(bu 2
86196cd59d Revert \(dqnot not\(dq deletion and add comment as to why that is there
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31952\fP: (\fI\%rallytime\fP) Fix lint for 2015.8 branch
@ \fI2016\-03\-17 16:59:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
db3af864ae Merge pull request \fI\%#31952\fP from rallytime/lint\-2015.8
.IP \(bu 2
3e964ec9d4 Fix lint for 2015.8 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31933\fP: (\fI\%rallytime\fP) Fix linking syntax in testing docs
@ \fI2016\-03\-17 14:44:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
9ab4d6164b Merge pull request \fI\%#31933\fP from rallytime/fix\-test\-links
.IP \(bu 2
06dd2c0411 Fix linking syntax in testing docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31586\fP: (\fI\%frogunder\fP) Proxy minion service.modules fails (refs: \fI\%#31601\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#31585\fP: (\fI\%frogunder\fP) Proxy minion commands causing exceptions (refs: \fI\%#31601\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31930\fP: (\fI\%cro\fP) Backport changes from 2016.3
@ \fI2016\-03\-16 22:12:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31601\fP: (\fI\%cro\fP) Proxy fixes for \fI\%#31585\fP and \fI\%#31586\fP
.IP \(bu 2
723d0ca19f Merge pull request \fI\%#31930\fP from cro/bp\-31601
.IP \(bu 2
aa9a288b5a Add these files back in
.IP \(bu 2
916ef26957 Remove .orig file mistakenly added, reformat example.
.IP \(bu 2
3c8185571d Lint.
.IP \(bu 2
9de9b9e86d Missin import
.IP \(bu 2
d571f3b8fe Backport PR\(ga#31601\(ga_
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31924\fP: (\fI\%jfindlay\fP) update 2015.8.8 release notes
@ \fI2016\-03\-16 22:10:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce765ad2df Merge pull request \fI\%#31924\fP from jfindlay/2015.8
.IP \(bu 2
64dd8aebb2 update 2015.8.8 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31890\fP: (\fI\%damon\-atkins\fP) salt/fileclient.py get_url should include the URL in any error message (refs: \fI\%#31922\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31922\fP: (\fI\%cachedout\fP) For 2015.8 head
@ \fI2016\-03\-16 19:07:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
390ef9fea7 Merge pull request \fI\%#31922\fP from cachedout/issue_31890_1
.IP \(bu 2
da075d9341 For 2015.8 head
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31904\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-03\-16 17:23:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
03e8b72655 Merge pull request \fI\%#31904\fP from rallytime/merge\-2015.8
.IP \(bu 2
f8b4b1b211 last pylint!
.IP \(bu 2
892591a39c More pylint fixes
.IP \(bu 2
35b2076584 Pylint fixes
.IP \(bu 2
1a1ce05186 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.INDENT 2.0
.IP \(bu 2
440e0dcbe0 Merge pull request \fI\%#31825\fP from jtand/udpate_pylintrc
.INDENT 2.0
.IP \(bu 2
9a14e02766 Updated beacons/sh.py to work with enumerate()
.IP \(bu 2
0ecec691a0 Adjusted beacons to work with enumerate better
.IP \(bu 2
f509b4113e Fixed final lint error
.IP \(bu 2
5945b3f11f Fix and disable pylint errors
.IP \(bu 2
06ae6eaf55 Fixed pylint errors on jboss state and module
.IP \(bu 2
de96db97c8 Fixed more pylint errors, and disabled some more
.IP \(bu 2
c07b0a20b5 Merge branch \(aqlint_fixes\(aq into udpate_pylintrc
.INDENT 2.0
.IP \(bu 2
2e6a152308 Fixed lint error in lxc.py
.IP \(bu 2
908ca1a439 Fixed lint error in ssh_py_shim
.IP \(bu 2
404c1b50f7 Changed range(len()) to enumerate()
.IP \(bu 2
1e13586546 Changed range(len()) to enumerate()
.UNINDENT
.IP \(bu 2
9ccce7a9a5 Added more disables
.IP \(bu 2
9c1aab3b4e Updated .testing.pylintrc to match newer versions of pylint
.UNINDENT
.IP \(bu 2
471c9444a3 Merge pull request \fI\%#31900\fP from rallytime/fix\-psutil\-warning
.INDENT 2.0
.IP \(bu 2
22403d69ae Add \(dqpython module\(dq clarification to ps __virtual__ warning.
.UNINDENT
.IP \(bu 2
c44c1b5e59 Merge pull request \fI\%#31878\fP from rallytime/fix\-psutil\-warning
.INDENT 2.0
.IP \(bu 2
44b29f72a1 Make sure __virtual__ error message is helpful when psutil is missing
.UNINDENT
.IP \(bu 2
5c592b6768 Merge pull request \fI\%#31852\fP from rallytime/merge\-2015.5
.INDENT 2.0
.IP \(bu 2
1470de17fa Merge branch \(aq2014.7\(aq into \(aq2015.5\(aq
.IP \(bu 2
218c902091 Merge pull request \fI\%#31834\fP from jfindlay/2014.7
.INDENT 2.0
.IP \(bu 2
358fdad0c8 add 2014.7.8 release notes
.UNINDENT
.IP \(bu 2
a423c6cd04 Merge pull request \fI\%#31833\fP from jfindlay/2014.7
.INDENT 2.0
.IP \(bu 2
6910fcc584 add 2014.7.9 release notes
.UNINDENT
.IP \(bu 2
c5e7c03953 Merge pull request \fI\%#31826\fP from gtmanfred/2014.7
.IP \(bu 2
d73f70ebb2 Remove ability of authenticating user to specify pam service
.UNINDENT
.IP \(bu 2
0cc1d5db03 Merge pull request \fI\%#31827\fP from gtmanfred/2015.5
.INDENT 2.0
.IP \(bu 2
979173b78a Remove ability of authenticating user to specify pam service
.UNINDENT
.IP \(bu 2
8cf0b9eb3d Merge pull request \fI\%#31810\fP from whiteinge/saltenv\-jinja\-var
.INDENT 2.0
.IP \(bu 2
cb72b19240 Fix outdated Jinja \(aqenv\(aq variable reference
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31906\fP: (\fI\%sbreidba\fP) Win_dacl module: fix FULLCONTROL / FILE_ALL_ACCESS definition
@ \fI2016\-03\-16 15:20:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
a4b3462346 Merge pull request \fI\%#31906\fP from sbreidba/win_dacl_fixes
.IP \(bu 2
54d81b9b42 Fix FULLCONTROL / FILE_ALL_ACCESS definition (bugfix and code simplification). Use consistent mechanism fro obtaining user SID. Allow wildcarding (via optional parameters) for a variety of methods (get, rm_ace, check_ace).
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31745\fP: (\fI\%isbm\fP) Fix the always\-false behavior on checking state
@ \fI2016\-03\-15 23:02:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
b068eaa963 Merge pull request \fI\%#31745\fP from isbm/isbm\-always\-minion\-errcode\-2\-fix
.IP \(bu 2
1882e1c960 Adjust test
.IP \(bu 2
f96c8f9b5e Keep first level away from lists.
.IP \(bu 2
baaed005b8 Fix PEP8 continuation
.IP \(bu 2
1db61ea59a Fix the always\-false behavior on checking state (there are always lists at some point!)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31911\fP: (\fI\%rallytime\fP) Merge \fI\%#31903\fP with pylint fix
@ \fI2016\-03\-15 20:35:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31903\fP: (\fI\%terminalmage\fP) Use remote_ref instead of local_ref to see if checkout is necessary (refs: \fI\%#31911\fP)
.IP \(bu 2
d05c3eeba9 Merge pull request \fI\%#31911\fP from rallytime/merge\-31903\-with\-pylint
.IP \(bu 2
85e5acd11a Merge \fI\%#31903\fP with pylint fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31883\fP: (\fI\%paiou\fP) Fix scaleway cloud provider and manage x86 servers
@ \fI2016\-03\-15 20:31:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
819a4a8b54 Merge pull request \fI\%#31883\fP from mvpstars/scaleway\-x86
.IP \(bu 2
1662a080e1 Update scaleway cloud provider to manage x86 servers
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31903\fP: (\fI\%terminalmage\fP) Use remote_ref instead of local_ref to see if checkout is necessary (refs: \fI\%#31911\fP)
@ \fI2016\-03\-15 20:04:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
142c47c50d Merge pull request \fI\%#31903\fP from terminalmage/fix\-git\-pillar
.IP \(bu 2
af29940e1c Use remote_ref instead of local_ref to see if checkout is necessary
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31845\fP: (\fI\%sakateka\fP) Now a check_file_meta deletes temporary files when test=True
@ \fI2016\-03\-15 19:55:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
ffd65c36e5 Merge pull request \fI\%#31845\fP from sakateka/check_file_meta_clean_tmp
.IP \(bu 2
5b30336b89 Now a check_file_meta deletes temporary files when test=True
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31791\fP: (\fI\%alexbleotu\fP) Proxy minion starts spinning after running state.highstate (refs: \fI\%#31846\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#31728\fP: (\fI\%bgridley\fP) Custom grains syncing problem with proxy minion which causes high CPU utilization (refs: \fI\%#31846\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31901\fP: (\fI\%rallytime\fP) Back\-port \fI\%#31846\fP to 2015.8
@ \fI2016\-03\-15 19:12:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31846\fP: (\fI\%cro\fP) Proxy infinite loop (refs: \fI\%#31901\fP)
.IP \(bu 2
7428c73724 Merge pull request \fI\%#31901\fP from rallytime/bp\-31846
.IP \(bu 2
1edd6ce302 Extra comment.
.IP \(bu 2
6c2ef03b11 Fix event bus flood caused by unexpected recursive call.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31905\fP: (\fI\%terminalmage\fP) Update versionadded directive
@ \fI2016\-03\-15 18:43:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
37f1ce9be2 Merge pull request \fI\%#31905\fP from terminalmage/update\-versionadded
.IP \(bu 2
dcc196c9e1 Update versionadded directive
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31902\fP: (\fI\%rallytime\fP) Update versionadded tag for new funcs
@ \fI2016\-03\-15 18:41:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31857\fP: (\fI\%sjorge\fP) gen_password and del_password missing from solaris_shadow (refs: \fI\%#31902\fP)
.IP \(bu 2
35f6407d11 Merge pull request \fI\%#31902\fP from rallytime/update\-version\-31857
.IP \(bu 2
5cd09150cd Update versionadded tag for new funcs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31888\fP: (\fI\%terminalmage\fP) Fix salt.utils.decorators.Depends
@ \fI2016\-03\-15 17:09:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
1be9c91761 Merge pull request \fI\%#31888\fP from terminalmage/fix\-depends\-decorator
.IP \(bu 2
394410e2b0 Add integration test for depends decorator
.IP \(bu 2
caa3cc1007 Fix salt.utils.decorators.Depends
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31857\fP: (\fI\%sjorge\fP) gen_password and del_password missing from solaris_shadow (refs: \fI\%#31902\fP)
@ \fI2016\-03\-14 20:29:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
d357e4ea44 Merge pull request \fI\%#31857\fP from sjorge/solarish_shadow
.IP \(bu 2
38231303f3 .9 release as mentioned by rallytime
.IP \(bu 2
3e25f70968 fix version added
.IP \(bu 2
d768ed25b4 develop, 2016.3 and 2015.8 has missing gen_password and del_password for shadow module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31879\fP: (\fI\%cro\fP) Clarify some comments
@ \fI2016\-03\-14 19:59:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
1b0b2d3f1a Merge pull request \fI\%#31879\fP from cro/idrac_fixes_0314
.IP \(bu 2
42ef3a7970 Extra comment.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#8927\fP: (\fI\%brutasse\fP) file state: unable to use \fIcontents_pillar\fP with \fItemplate: jinja\fP (refs: \fI\%#31815\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26944\fP: (\fI\%boltronics\fP) file.managed contents and contents_pillar should support a template rendering engine (refs: \fI\%#31815\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#14664\fP: (\fI\%jacksontj\fP) Unable to have a template with file.managed contents (or contents_pillar) (refs: \fI\%#31815\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31815\fP: (\fI\%dr4Ke\fP) Fix template on contents 2015.8
@ \fI2016\-03\-14 17:41:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb81bbea23 Merge pull request \fI\%#31815\fP from dr4Ke/fix_template_on_contents_2015.8
.IP \(bu 2
dcd6f5a5a9 test for file.apply_template_on_contents
.IP \(bu 2
10d882296d file.managed: templating contents, not just files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31818\fP: (\fI\%anlutro\fP) Prevent event logs from writing huge amounts of data
@ \fI2016\-03\-14 17:27:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
aa120cb716 Merge pull request \fI\%#31818\fP from alprs/fix\-event_logging_spam
.IP \(bu 2
83fa136da7 work on event logging
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31293\fP: (\fI\%deuscapturus\fP) Git Pillars lose HEAD reference over time (refs: \fI\%#31836\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29239\fP: (\fI\%timwsuqld\fP) Occasionally git_pillar pull fails causing incorrect results of highstate (when running highstate for multiple minions) (refs: \fI\%#31836\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31836\fP: (\fI\%terminalmage\fP) Fix git_pillar race condition
@ \fI2016\-03\-14 15:48:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
f2445bdbdc Merge pull request \fI\%#31836\fP from terminalmage/issue31293
.IP \(bu 2
5048fa857c Fix duplicate output
.IP \(bu 2
155b84b88a salt.fileserver: Add ability to clear checkout locks
.IP \(bu 2
af410d8dd1 Pass through the lock_type
.IP \(bu 2
3d7796d5dd salt.runners.cache: Add ability to clear checkout locks
.IP \(bu 2
8e086099f5 salt.utils.gitfs: rewrite locking code
.IP \(bu 2
06b212519c Add GitLockError exception class
.IP \(bu 2
ad04ccfb93 Strip whitespace when splitting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31824\fP: (\fI\%rallytime\fP) Back\-port \fI\%#31819\fP to 2015.8
@ \fI2016\-03\-13 19:59:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31819\fP: (\fI\%mchugh19\fP) raise error on unsupported distro (refs: \fI\%#31824\fP)
.IP \(bu 2
5464be07b1 Merge pull request \fI\%#31824\fP from rallytime/bp\-31819
.IP \(bu 2
4d516adade raise error on unsupported distro
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24559\fP: (\fI\%iacopo\-papalini\fP) salt\-cloud \- Azure \- should be possible to specify virtual network & subnet in profile (refs: \fI\%#31856\fP, \fI\%#24569\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31856\fP: (\fI\%szeestraten\fP) Adds missing docs for Virtual Network and Subnet options in salt\-cloud Azure cloud profile
@ \fI2016\-03\-13 19:06:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24569\fP: (\fI\%iacopo\-papalini\fP) Fix Issue \fI\%#24559\fP \- salt\-cloud \- Azure \- should be possible to specify… (refs: \fI\%#31856\fP)
.IP \(bu 2
7781b357e0 Merge pull request \fI\%#31856\fP from szeestraten/add\-missing\-docs\-for\-azure\-cloud\-profile
.IP \(bu 2
a1a2229405 Adds missing docs for Azure cloud profile
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31839\fP: (\fI\%jfindlay\fP) add 2015.8.8 release notes
@ \fI2016\-03\-11 23:23:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
3f88f3a8cf Merge pull request \fI\%#31839\fP from jfindlay/2015.8
.IP \(bu 2
47ac41ba27 add 2015.8.8 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31828\fP: (\fI\%gtmanfred\fP) Remove ability of authenticating user to specify pam service
@ \fI2016\-03\-11 20:40:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
46bdd10a56 Merge pull request \fI\%#31828\fP from gtmanfred/2015.8
.IP \(bu 2
7c3134a3d3 Remove ability of authenticating user to specify pam service
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30489\fP: (\fI\%chris\-martin\fP) influxdb_user.present fails: \(dqInfluxDBClient\(aq object has no attribute \(aqget_list_cluster_admins\(dq (refs: \fI\%#31787\fP, \fI\%#31770\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31787\fP: (\fI\%anlutro\fP) Fix user_create and db_create for new versions of influxdb
@ \fI2016\-03\-11 15:19:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
3d370b471c Merge pull request \fI\%#31787\fP from alprs/fix\-influxdb_user
.IP \(bu 2
6a5211c8d8 don\(aqt swallow exceptions
.IP \(bu 2
a7e9c1e381 fix db_create for influxdb 0.9+
.IP \(bu 2
5a8a645d4b fix create_user for new versions of influxdb
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31800\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-03\-10 20:49:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
7fb2331ebc Merge pull request \fI\%#31800\fP from rallytime/merge\-2015.8
.IP \(bu 2
44c15f0b16 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
970ef0e445 Merge pull request \fI\%#31744\fP from brejoc/fix\-attribute\-error\-with\-older\-libcloud/2015.5
.INDENT 2.0
.IP \(bu 2
bb29dc2283 Added version to libcloud depends statement
.IP \(bu 2
87f9534fce Added log message with update suggestion for libcloud
.IP \(bu 2
72eab406cd Fix for AttributeError with libcloud <0.15
.UNINDENT
.IP \(bu 2
df2d23ba5d Merge pull request \fI\%#31740\fP from terminalmage/issue31666
.INDENT 2.0
.IP \(bu 2
aeaf5864cd Fall back to False when pillar_opts not set
.IP \(bu 2
fe19d77eb4 Add default value for pillar_opts on minion
.UNINDENT
.IP \(bu 2
e22f5c0a26 Merge pull request \fI\%#31750\fP from rallytime/bp\-26170
.INDENT 2.0
.IP \(bu 2
3c11234a05 Make sure variable is a dictionary before popping something from it.
.UNINDENT
.IP \(bu 2
9162925dd0 Merge pull request \fI\%#31689\fP from rallytime/bp\-29467
.INDENT 2.0
.IP \(bu 2
1f8f4cb99b Update module.py
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31797\fP: (\fI\%Ch3LL\fP) Change pkg name to less for suse pkg.info_installed test
@ \fI2016\-03\-10 19:08:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
75dfb2ed40 Merge pull request \fI\%#31797\fP from Ch3LL/fix_pkginfo_test
.IP \(bu 2
910f0d9ffc change pkg name to less for suse
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31617\fP: (\fI\%tampakrap\fP) service.running fails on sle11 sp3 and sp4 (refs: \fI\%#31629\fP, \fI\%#31793\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31793\fP: (\fI\%xopher\-mc\fP) fixing init system detection on sles 11, refs \fI\%#31617\fP
@ \fI2016\-03\-10 18:42:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
1386b72bbf Merge pull request \fI\%#31793\fP from xopher\-mc/fix_sles_state_service_module
.IP \(bu 2
d242cb19b4 fixing init system dectection on sles 11, refs \fI\%#31617\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31786\fP: (\fI\%isbm\fP) Bugfix: zypper doesn\(aqt detect base product on SLE11 series
@ \fI2016\-03\-10 18:12:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
2f28c166dd Merge pull request \fI\%#31786\fP from isbm/isbm\-zypper\-list\-products\-sles11
.IP \(bu 2
ee1a002673 Update test case to cover SLE11 and SLE12
.IP \(bu 2
4b134fb2ab Add SLE11 product info snapshot, rename previous
.IP \(bu 2
3c5fc857b2 Bugfix: on SLE11 series base product reported as additional
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31776\fP: (\fI\%gtmanfred\fP) ProxyMinion does not close connections (at least with esxi proxy) (refs: \fI\%#31780\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31780\fP: (\fI\%gtmanfred\fP) use already created vsphere connection
@ \fI2016\-03\-10 17:41:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
d6f669623c Merge pull request \fI\%#31780\fP from gtmanfred/2015.8
.IP \(bu 2
070eaf07f0 use already created vsphere connection
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31772\fP: (\fI\%sbreidba\fP) win_dacl state causes state.apply output to be YAML, not highstate (refs: \fI\%#31779\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31779\fP: (\fI\%sbreidba\fP) win_dacl state & module: return comment field as strings, not lists.
@ \fI2016\-03\-10 17:41:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
a067de3712 Merge pull request \fI\%#31779\fP from sbreidba/win\-dacl\-highstate\-output\-2015.8
.IP \(bu 2
aeb2bfcf46 win_dacl state & module: return comment field as strings, not lists.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31563\fP: (\fI\%sjorge\fP) regression in 2016.3 from today? (refs: \fI\%#31723\fP, \fI\%#31707\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31723\fP: (\fI\%sjorge\fP) file_ignore_regex is a list, not bool
@ \fI2016\-03\-09 23:36:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31707\fP: (\fI\%sjorge\fP) Fix incorrect default types for master_tops and file_ignore_regex  (refs: \fI\%#31723\fP)
.IP \(bu 2
baeefac252 Merge pull request \fI\%#31723\fP from sjorge/2015.8\-file_ignore_regex
.IP \(bu 2
df1ba94cbb file_ignore_regex is a list, not bool
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27960\fP: (\fI\%The\-Loeki\fP) salt\-cloud CLI 2015.8 borks out with SaltClientError: \(aqtimeout\(aq (refs: \fI\%#31747\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31747\fP: (\fI\%techhat\fP) Use get_local_client with MASTER opts, not MINION
@ \fI2016\-03\-09 23:14:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
cd43cf919c Merge pull request \fI\%#31747\fP from techhat/issue27960
.IP \(bu 2
44c100d610 Use get_local_client with MASTER opts, not MINION
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31688\fP: (\fI\%whiteinge\fP) Various SMTP returner fixes
@ \fI2016\-03\-09 22:40:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
286ea1f61b Merge pull request \fI\%#31688\fP from whiteinge/smtp\-renderer
.IP \(bu 2
76671b6a81 Check if we have a StringIO and grab the string instead
.IP \(bu 2
17b8cd755f Add a default for the subject
.IP \(bu 2
26479bee24 Clean up the SMTP returner docstring and show an actual config example
.IP \(bu 2
74563f17ed Make sure the email subject and body are strings
.IP \(bu 2
fc69d08e8e Default to just \(aqjinja\(aq for the SMTP renderer
.IP \(bu 2
2af7cd2789 Add missing \(aqport\(aq to smtp options
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31752\fP: (\fI\%rallytime\fP) Back\-port \fI\%#31686\fP to 2015.8
@ \fI2016\-03\-09 21:23:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31686\fP: (\fI\%myii\fP) Fix typo in example for section \fIwinrepo_dir_ng\fP (refs: \fI\%#31752\fP)
.IP \(bu 2
1d6d982e5c Merge pull request \fI\%#31752\fP from rallytime/bp\-31686
.IP \(bu 2
e4df5d9a55 Fix typo in example for section \fIwinrepo_dir_ng\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31733\fP: (\fI\%jacobhammons\fP) docs to clarify cloud configuration
@ \fI2016\-03\-09 20:54:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec90294442 Merge pull request \fI\%#31733\fP from jacobhammons/cloud\-docs
.IP \(bu 2
209c641a41 Made updates as suggested by @rallytime
.IP \(bu 2
26d4991cb3 moved previous intro to new quick start topic (topics/cloud/qs.rst) added new intro that explains the salt cloud configuration files added an inheritance and minion startup state example to topics/cloud/config.rst
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26498\fP: (\fI\%rallytime\fP) [salt\-cloud] Able to create multiple VMs with the same name across providers (refs: \fI\%#31754\fP, \fI\%#31775\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31775\fP: (\fI\%techhat\fP) Show correct provider/driver name
@ \fI2016\-03\-09 20:53:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
92ba7f3495 Merge pull request \fI\%#31775\fP from techhat/correctmsg
.IP \(bu 2
c1433650b4 Show correct provider/driver name
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26498\fP: (\fI\%rallytime\fP) [salt\-cloud] Able to create multiple VMs with the same name across providers (refs: \fI\%#31754\fP, \fI\%#31775\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31754\fP: (\fI\%techhat\fP) Check all providers, not just the current one
@ \fI2016\-03\-09 18:38:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
249a3602eb Merge pull request \fI\%#31754\fP from techhat/issue26498
.IP \(bu 2
08c61446b7 Check all providers, not just the current one
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31639\fP: (\fI\%mshirley\fP) salt\-cloud digital ocean api v2 doesn\(aqt implement all available actions (refs: \fI\%#31735\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31735\fP: (\fI\%rallytime\fP) Add reboot, start, and stop actions to digital ocean driver
@ \fI2016\-03\-09 17:57:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
7ad521f7a5 Merge pull request \fI\%#31735\fP from rallytime/fix\-31639
.IP \(bu 2
67d1aa6740 Remove experimental/incomplete function
.IP \(bu 2
b209623ca9 Add reboot, start, and stop actions to digital ocean driver
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30489\fP: (\fI\%chris\-martin\fP) influxdb_user.present fails: \(dqInfluxDBClient\(aq object has no attribute \(aqget_list_cluster_admins\(dq (refs: \fI\%#31787\fP, \fI\%#31770\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31770\fP: (\fI\%anlutro\fP) Fix influxdb user functionality for version 0.9+
@ \fI2016\-03\-09 17:09:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd3610c6a4 Merge pull request \fI\%#31770\fP from alprs/fix\-influxdb_user
.IP \(bu 2
1349bdd2e8 fix influxdb user functionality for version 0.9+
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31743\fP: (\fI\%Talkless\fP) Fix parentheses mismatch in documentation
@ \fI2016\-03\-08 18:01:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
c0868307df Merge pull request \fI\%#31743\fP from Talkless/patch\-1
.IP \(bu 2
26ff46dbc6 Fix parenthesis mismatch in documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31162\fP: (\fI\%isbm\fP) Remove MD5 digest from everywhere and default to SHA256
@ \fI2016\-03\-07 19:11:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
826fea6582 Merge pull request \fI\%#31162\fP from isbm/isbm\-md5\-to\-sha1
.IP \(bu 2
9d64abed0c Fix PyLint
.IP \(bu 2
327ea11139 Add daemons unit test to verify hash_type settings
.IP \(bu 2
f3aecc0b22 Standardize logging
.IP \(bu 2
51f556243d Verify if hash_type is using vulnerable algorithms
.IP \(bu 2
95ec634f00 Report environment failure, if any
.IP \(bu 2
63eedefe54 Use mixin for the daemon classes
.IP \(bu 2
82dd383630 Create a mixin class that will be reused in the similar instances (daemons)
.IP \(bu 2
36da8f5efa Use MD5 hash algorithm by default (until deprecated)
.IP \(bu 2
584325797c Remove SHA1 in favor of SHA256
.IP \(bu 2
373493c13f Remove SHA1 for SHA256
.IP \(bu 2
d5cb4dd424 Remove sha1 to sha265
.IP \(bu 2
73b8d35e01 Add note to the Tomcat module for SHA256
.IP \(bu 2
efb78f1055 Remove SHA1 to SHA265 by default
.IP \(bu 2
6198976edb Use SHA1 by default instead of MD5
.IP \(bu 2
73f2df76ce Use SHA1 hash by default in Tomcat module, refactor for support different algorithms
.IP \(bu 2
0d4e4e31f8 Use SHA1 hash by default
.IP \(bu 2
785717703b Use configurable hash_type for general Key fingerprinting
.IP \(bu 2
f0d931f4d0 Use hash_type configuration for the Cloud
.IP \(bu 2
95cb59dec7 Set default hash as SHA1 in config and explain why.
.IP \(bu 2
8f9543c292 Set config hash_type to SHA1
.IP \(bu 2
413eca124d Set default checksum for key fingerprint to SHA1
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30528\fP: (\fI\%UtahDave\fP) Missing Minion notifications missing from job cache (refs: \fI\%#31670\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31670\fP: (\fI\%terminalmage\fP) Write lists of minions targeted by syndic masters to job cache
@ \fI2016\-03\-07 18:51:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
a1f32b71bd Merge pull request \fI\%#31670\fP from terminalmage/issue30528
.IP \(bu 2
65e5a3c53e Pass syndic_id to save_minions()
.IP \(bu 2
cf94c2597a Add argument to save_minions() to pass a syndic ID
.IP \(bu 2
cb92114377 Add syndic_id param for API compatibility
.IP \(bu 2
1d39eec69b Skip events with minion lists but no jid
.IP \(bu 2
651e3926f7 lint fixes
.IP \(bu 2
0f175a4edf salt.returners.sqlite3_return: add no\-op save_minions() func for API compatibility
.IP \(bu 2
f8664103b1 salt.returners.redis_return: add no\-op save_minions() func for API compatibility
.IP \(bu 2
0ea1b76c22 salt.returners.postgres_local_cache: add no\-op save_minions() func for API compatibility
.IP \(bu 2
d6d794b484 salt.returners.postgres: add no\-op save_minions() func for API compatibility
.IP \(bu 2
82750ab699 salt.returners.pgjsonb: add no\-op save_minions() func for API compatibility
.IP \(bu 2
d8f90f6578 salt.returners.odbc: add no\-op save_minions() func for API compatibility
.IP \(bu 2
a1957c3706 salt.returners.mysql: add no\-op save_minions() func for API compatibility
.IP \(bu 2
ef6aa5de1c salt.returners.multi_returner: add no\-op save_minions() func for API compatibility
.IP \(bu 2
5b4eb58d99 salt.returners.mongo_return: add no\-op save_minions() func for API compatibility
.IP \(bu 2
da1acbb8f2 salt.returners.mongo_future_return: add no\-op save_minions() func for API compatibility
.IP \(bu 2
c13bb6549c salt.returners.memcache_return: add no\-op save_minions() func for API compatibility
.IP \(bu 2
4322ad9ef3 salt.returners.influxdb_return: add no\-op save_minions() func for API compatibility
.IP \(bu 2
1dd106183c salt.returners.etcd_return: add no\-op save_minions() func for API compatibility
.IP \(bu 2
8e80535516 salt.returners.couchdb_return: add no\-op save_minions() func for API compatibility
.IP \(bu 2
44538dfced salt.returners.cassandra_cql_return: add no\-op save_minions() func for API compatibility
.IP \(bu 2
084a78407a salt.returners.couchbase_return: move minion list updates to new save_minions() func
.IP \(bu 2
f731dc5d32 Update a job\(aqs minion list to include minion lists forwarded by syndic
.IP \(bu 2
504f7df460 Add utils function to invoke a returner\(aqs save_minions() func
.IP \(bu 2
0b4616a3eb Separate writing of serialized minion list into its own function
.IP \(bu 2
214fedc3f6 Simplify jobs.get_jobs logic, generally improve jobs runner docs
.IP \(bu 2
3f527be748 Add an exception class for errors encountered while locking files.
.IP \(bu 2
1e6b43eef8 Add a contextmanager for file locking
.IP \(bu 2
978b6cb32f Add missing RST file for slsutil module
.IP \(bu 2
2ad8ceffc2 Add salt.utils.split_input()
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31595\fP: (\fI\%dverbeek84\fP) dockerng ports specified in Dockerfile must be in sls file otherwise salt gives an error (refs: \fI\%#31711\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31711\fP: (\fI\%ticosax\fP) [dockerng] Port and Volume comparison should consider Dockerfile
@ \fI2016\-03\-07 18:25:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
24568b1a5d Merge pull request \fI\%#31711\fP from ticosax/fix\-port\-and\-volume\-discovery
.IP \(bu 2
cf38691597 Port and Volume comparison should consider Dockerfile
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31579\fP: (\fI\%bradthurber\fP) salt\-cloud delete with a map file fails when multiple providers defined (refs: \fI\%#31719\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31719\fP: (\fI\%techhat\fP) Don\(aqt worry about KeyErrors if the node is already removed
@ \fI2016\-03\-07 18:16:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
b936e09fb3 Merge pull request \fI\%#31719\fP from techhat/issue31579
.IP \(bu 2
88905095c9 Don\(aqt worry about KeyErrors if the node is already removed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31713\fP: (\fI\%ticosax\fP) [dockerng] Fix dockerng.network_present when container is given by name
@ \fI2016\-03\-07 15:14:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
604eb87e82 Merge pull request \fI\%#31713\fP from ticosax/fix\-dockerng\-networking\-container_id
.IP \(bu 2
3837cf44ca Fix network_present by dealing with containers ID\(aqs instead of names.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31704\fP: (\fI\%peripatetic\-sojourner\fP) Foreman external pillar doesn\(aqt load (refs: \fI\%#31705\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31705\fP: (\fI\%peripatetic\-sojourner\fP) Foreman pillar
@ \fI2016\-03\-07 14:24:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
8f28e4510d Merge pull request \fI\%#31705\fP from peripatetic\-sojourner/foreman_pillar
.IP \(bu 2
ba33d75949 passing lint test
.IP \(bu 2
63e39a8999 refactored parameter population for foreman pillar
.IP \(bu 2
c3325bc15d add return of virtualname
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31702\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-03\-06 19:24:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
aa5c13f0b8 Merge pull request \fI\%#31702\fP from rallytime/merge\-2015.8
.IP \(bu 2
6559ea15b0 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
d7914cdb14 Merge pull request \fI\%#31687\fP from cachedout/rm_gpg_test
.INDENT 2.0
.IP \(bu 2
8b00513ebb Removed useless tests
.UNINDENT
.IP \(bu 2
bd4d12a155 Merge pull request \fI\%#31660\fP from terminalmage/issue31619
.INDENT 2.0
.IP \(bu 2
da954d7b92 Add integration test for packages with epoch in version
.IP \(bu 2
4fa7e4defe Move epoch removal
.IP \(bu 2
290192af56 Remove epoch from version string if present when installing with yum
.UNINDENT
.IP \(bu 2
e33c1f456a Merge pull request \fI\%#31683\fP from rallytime/bp\-31578
.INDENT 2.0
.IP \(bu 2
8fe46789b7 allow queueing of state runs through saltmod
.UNINDENT
.IP \(bu 2
27f443895d Merge pull request \fI\%#31682\fP from cachedout/cache_meaning
.INDENT 2.0
.IP \(bu 2
a75e146125 Add definition of job cache to glossary
.UNINDENT
.IP \(bu 2
bd04c964d1 Merge pull request \fI\%#31658\fP from rallytime/add\-style\-to\-contrib
.INDENT 2.0
.IP \(bu 2
6b526b5878 Add mentioned of Salt\(aqs Coding Style docs to the Contributing docs
.UNINDENT
.IP \(bu 2
10658dffe6 Merge pull request \fI\%#31655\fP from rallytime/pylint\-docs
.INDENT 2.0
.IP \(bu 2
6e0377d376 Make note of pylint dependencies in docs
.UNINDENT
.IP \(bu 2
6075774a01 Merge pull request \fI\%#31440\fP from cachedout/master_tops_type
.INDENT 2.0
.IP \(bu 2
f49cc75049 Set correct type for master_tops config value
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31700\fP: (\fI\%s0undt3ch\fP) It\(aqs a function!
@ \fI2016\-03\-06 17:33:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
ace290629e Merge pull request \fI\%#31700\fP from s0undt3ch/2015.8
.IP \(bu 2
1ca2beea3e It\(aqs a function!
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31679\fP: (\fI\%cro\fP) Fix bad link to the sample REST endpoint in salt\-contrib.
@ \fI2016\-03\-04 21:05:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
cf438aa873 Merge pull request \fI\%#31679\fP from cro/proxy_contrib_doc_fix
.IP \(bu 2
d638971b73 Correct url to salt\-contrib
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21932\fP: (\fI\%clinta\fP) Salt Coding Style docs should list requirements for salt pylintrc (refs: \fI\%#31655\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31668\fP: (\fI\%rallytime\fP) Some more testing documentation improvements
@ \fI2016\-03\-04 20:48:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31658\fP: (\fI\%rallytime\fP) Add mentioned of Salt\(aqs Coding Style docs to the Contributing docs (refs: \fI\%#31668\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31655\fP: (\fI\%rallytime\fP) Make note of pylint dependencies in docs (refs: \fI\%#31668\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31641\fP: (\fI\%rallytime\fP) Improve Salt Testing tutorial to be a more comprehensive intro (refs: \fI\%#31668\fP)
.IP \(bu 2
97127a8b83 Merge pull request \fI\%#31668\fP from rallytime/testing\-docs
.IP \(bu 2
beb9d0fe84 Ensure all integration test classes and funcs are documented w/examples
.IP \(bu 2
7f8ebf7c97 Found another spelling error
.IP \(bu 2
c8c188535f Spelling fix
.IP \(bu 2
f260c51762 Some more testing documentation improvements
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29753\fP: (\fI\%jakehilton\fP) New minion fails to authenticate properly to multi\-master setup (refs: \fI\%#31653\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31653\fP: (\fI\%DmitryKuzmenko\fP) Don\(aqt attempt to verify token if it wasn\(aqt sent to master.
@ \fI2016\-03\-03 17:39:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
2ed7286af1 Merge pull request \fI\%#31653\fP from DSRCompany/issues/29753_multimaster_auth_fail
.IP \(bu 2
2557707cc7 Don\(aqt attempt to verify token if it wasn\(aqt sent to master.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31617\fP: (\fI\%tampakrap\fP) service.running fails on sle11 sp3 and sp4 (refs: \fI\%#31629\fP, \fI\%#31793\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31629\fP: (\fI\%darix\fP) Fix services on sles
@ \fI2016\-03\-03 16:41:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
118fcde425 Merge pull request \fI\%#31629\fP from darix/fix\-services\-on\-sles
.IP \(bu 2
9b8d6cbb72 make the suse check consistent with rh_service.py
.IP \(bu 2
c0c8a77242 Fix numerical check of osrelease
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31641\fP: (\fI\%rallytime\fP) Improve Salt Testing tutorial to be a more comprehensive intro (refs: \fI\%#31668\fP)
@ \fI2016\-03\-03 16:08:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
4d1701de60 Merge pull request \fI\%#31641\fP from rallytime/testing\-tutorial
.IP \(bu 2
6ab3961748 Improve Salt Testing tutorial to be a more comprehensive intro
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30651\fP: (\fI\%sjorge\fP) salt.states.grains.list_present should not show changes if none are made! (refs: \fI\%#31651\fP, \fI\%#30689\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31651\fP: (\fI\%dr4Ke\fP) test case: test_list_present_nested_already
@ \fI2016\-03\-03 16:02:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30689\fP: (\fI\%sjorge\fP) fix for \fI\%#30651\fP grains.list_present and grains.list_absent (refs: \fI\%#31651\fP, \fI\%#31271\fP)
.IP \(bu 2
584f8401b8 Merge pull request \fI\%#31651\fP from dr4Ke/test_case_for_30689
.IP \(bu 2
fc9dd356e8 test case: test_list_present_nested_already
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31643\fP: (\fI\%opdude\fP) Make sure we are really updating the mercurial repository
@ \fI2016\-03\-03 14:30:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
5566f1f2a7 Merge pull request \fI\%#31643\fP from Unity\-Technologies/hotfix/hg\-fix\-repo\-updated
.IP \(bu 2
ca41c4b8c1 Make sure we are really updating the mercurial repository
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30761\fP: (\fI\%sjmh\fP) Cannot target subsets of minions when using pillar and external_auth (refs: \fI\%#31598\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31598\fP: (\fI\%terminalmage\fP) Remove limitations on validation types for eauth targets
@ \fI2016\-03\-02 22:14:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
36c790eede Merge pull request \fI\%#31598\fP from terminalmage/issue30761
.IP \(bu 2
5dedaa2d9d Remove limitations on validation types for eauth targets
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31627\fP: (\fI\%jakehilton\fP) Handling error from using gevent 1.1.
@ \fI2016\-03\-02 22:01:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
cc4c31cf7f Merge pull request \fI\%#31627\fP from jakehilton/2015.8
.IP \(bu 2
02fb5ed616 Handling error from using gevent 1.1.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31630\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-03\-02 20:49:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
191241e71a Merge pull request \fI\%#31630\fP from rallytime/merge\-2015.8
.IP \(bu 2
75bb692990 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
6d31b8918f Merge pull request \fI\%#31622\fP from jfindlay/query_doc
.INDENT 2.0
.IP \(bu 2
4e48fec806 doc/topics/tutorials/http: update query decoding docs
.UNINDENT
.IP \(bu 2
dbf6e0786c Merge pull request \fI\%#31558\fP from cachedout/ensure_ssh_installed
.INDENT 2.0
.IP \(bu 2
cecc6e0a5f Don\(aqt stacktrace if ssh binary is not installed with salt\-ssh
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31594\fP: (\fI\%rallytime\fP) Back\-port \fI\%#31589\fP to 2015.8
@ \fI2016\-03\-02 16:33:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31589\fP: (\fI\%techhat\fP) Ensure that the latest node data is returned (refs: \fI\%#31594\fP)
.IP \(bu 2
38ddd62aef Merge pull request \fI\%#31594\fP from rallytime/bp\-31589
.IP \(bu 2
6cd89459c7 Ensure that the latest node data is returned
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31596\fP: (\fI\%joejulian\fP) gluster \-\-xml does not always produce xml with legacy versions (refs: \fI\%#31604\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31604\fP: (\fI\%joejulian\fP) Workaround for non\-xml output from gluster cli when not tty
@ \fI2016\-03\-02 15:53:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
86a0fc46b4 Merge pull request \fI\%#31604\fP from joejulian/2015.8_31596_workaround_no_xml_when_not_tty
.IP \(bu 2
c567a823a9 Workaround for non\-xml output from gluster cli when not tty
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31583\fP: (\fI\%vutny\fP) Remove trailing white spaces
@ \fI2016\-03\-02 15:38:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
36ce240596 Merge pull request \fI\%#31583\fP from vutny/remove\-trailing\-white\-spaces
.IP \(bu 2
bbcad93a8d Fix trailing white spaces in Salt PRM spec file
.IP \(bu 2
86433f2378 Revert changes in files used by \fIroots_test.py\fP integration test
.IP \(bu 2
e7a8dbf498 Remove trailing white spaces in tests files
.IP \(bu 2
776b2ea9a6 Remove trailing white spaces in files under \fIsalt/\fP dir
.IP \(bu 2
fbfc3abccf Remove trailing white spaces in files under \fIpkg/\fP dir
.IP \(bu 2
aebc48163d Remove trailing white spaces in documentation files
.IP \(bu 2
7eaf778695 Remove trailing white spaces in conf dir file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31592\fP: (\fI\%rallytime\fP) Back\-port \fI\%#31546\fP to 2015.8
@ \fI2016\-03\-01 23:51:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31546\fP: (\fI\%terminalmage\fP) Rework of PR \fI\%#31529\fP (refs: \fI\%#31592\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31529\fP: (\fI\%llua\fP) nspawn.py: Fix bad keyword assignment (refs: \fI\%#31546\fP)
.IP \(bu 2
c9fe8d87f3 Merge pull request \fI\%#31592\fP from rallytime/bp\-31546
.IP \(bu 2
9a296bd1bf Use clean_kwargs and invalid_kwargs utils funcs to handle invalid kwargs
.IP \(bu 2
43099a2b63 nspawn.py: Fix bad keyword assignment
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30866\fP: (\fI\%kevinquinnyo\fP) WheelClient cmd returns None but wheel functions called directly work (refs: \fI\%#31570\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26415\fP: (\fI\%CaesarC\fP) salt.wheel.WheelClient doesn\(aqt work follow the python api(AttributeError: \(aqNoneType\(aq object has no attribute \(aqget\(aq) (refs: \fI\%#28087\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31593\fP: (\fI\%rallytime\fP) Back\-port \fI\%#31570\fP to 2015.8
@ \fI2016\-03\-01 23:50:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31570\fP: (\fI\%cro\fP) Need to return the value (refs: \fI\%#31593\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28087\fP: (\fI\%DmitryKuzmenko\fP) Revert \(dqUpdate __init__.py\(dq (refs: \fI\%#31570\fP)
.IP \(bu 2
c8dbc93ac6 Merge pull request \fI\%#31593\fP from rallytime/bp\-31570
.IP \(bu 2
b2294d0a28 Need to return the value
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28585\fP: (\fI\%robthralls\fP) FIPS compliance (2015.8.1\-1) (refs: \fI\%#31567\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31567\fP: (\fI\%cachedout\fP) Restore FIPS compliance when using master_finger
@ \fI2016\-03\-01 19:50:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
068807558a Merge pull request \fI\%#31567\fP from cachedout/issue_28585
.IP \(bu 2
7006a1eecf Fix failed unit test
.IP \(bu 2
10cd328dda Lint
.IP \(bu 2
174337d020 Restore FIPS compliance when using master_finger
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31568\fP: (\fI\%twangboy\fP) Grant permissions using SID instead of name
@ \fI2016\-03\-01 04:22:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
77d9aae8bb Merge pull request \fI\%#31568\fP from twangboy/fix_perms
.IP \(bu 2
1f6a95694d Grant permissions using SID instead of name
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31516\fP: (\fI\%justinta\fP) beacons.enable_beacon does not write to beacons.conf on some OS\(aqs (refs: \fI\%#31561\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31561\fP: (\fI\%justinta\fP) Skipped test
@ \fI2016\-03\-01 04:11:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
ada5ab344d Merge pull request \fI\%#31561\fP from jtand/beacons_test_fix
.IP \(bu 2
196dd4db99 Skipped test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31041\fP: (\fI\%fredrikaverpil\fP) Reading about win_service in 2015.8.5 docs, but it\(aqs not available in 2015.8.5 (refs: \fI\%#31550\fP, \fI\%#31049\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31550\fP: (\fI\%rallytime\fP) Correct versionadded tag for win_service.config
@ \fI2016\-02\-29 21:11:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31049\fP: (\fI\%twangboy\fP) Fix versionadded in win_service.config (refs: \fI\%#31550\fP)
.IP \(bu 2
658c1865ab Merge pull request \fI\%#31550\fP from rallytime/win_service\-docs
.IP \(bu 2
51aa26334c Correct versionadded tag for win_service.config
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31549\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-02\-29 18:46:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
9bb9a54f8d Merge pull request \fI\%#31549\fP from rallytime/merge\-2015.8
.IP \(bu 2
b683df9b82 Pylint fix
.IP \(bu 2
24505d2dcf Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.INDENT 2.0
.IP \(bu 2
060a60fd90 Merge pull request \fI\%#31521\fP from terminalmage/issue24753
.INDENT 2.0
.IP \(bu 2
0d352bbc16 Add fileclient tests
.IP \(bu 2
d9370a8041 Update cp module salt\-ssh wrapper to use new cachedir param
.IP \(bu 2
0320494b1d Update the SSH state module wrappers to pass an alternate cachedir
.IP \(bu 2
65bdcb3afa Accept and pass through the alternate cachedir when prepping the thin tar
.IP \(bu 2
c3f7a2f2e5 Add ability to specify an alternate base dir for file caching
.UNINDENT
.IP \(bu 2
92f8f89218 Merge pull request \fI\%#31497\fP from rallytime/remove\-timeout\-dup
.INDENT 2.0
.IP \(bu 2
83e6480d20 Remove duplicate \(dqtimeout\(dq definition in Roster docs
.UNINDENT
.IP \(bu 2
da001bcb49 Merge pull request \fI\%#31472\fP from rallytime/update\-contributing\-docs
.INDENT 2.0
.IP \(bu 2
5871e4d1e0 Update contributing docs
.UNINDENT
.IP \(bu 2
f35e2dd1d3 Merge pull request \fI\%#31461\fP from DSRCompany/issues/30183_fix_multimaster_failover_2015.5
.INDENT 2.0
.IP \(bu 2
3d09c3b7a3 Set auth retry count to 0 if multimaster mode is failover.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29701\fP: (\fI\%tonyyang132\fP) Running salt\-call on salt master would crash the master node with code level 2015.8.3 (refs: \fI\%#31544\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27063\fP: (\fI\%lorengordon\fP) 2015.8.0: Error writing to \fI/var/log/salt/minion\fP? (refs: \fI\%#31544\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31544\fP: (\fI\%DmitryKuzmenko\fP) Protect getattr from recursion
@ \fI2016\-02\-29 17:48:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
5a6aff1791 Merge pull request \fI\%#31544\fP from DSRCompany/issues/29701_getattr_recursion_protection
.IP \(bu 2
b7a45b8fae Protect getattr from recursion
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30643\fP: (\fI\%Ch3LL\fP) multi\-master failover stack trace when minion fails over to other master (refs: \fI\%#31512\fP, \fI\%#31525\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#30181\fP: (\fI\%jakehilton\fP) Minion failover only works once (refs: \fI\%#31512\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29567\fP: (\fI\%freebsdly\fP) multi master failover successful but execute command ‘salt * test.ping’ on second master return ‘Minion did not return. [No response]’ (refs: \fI\%#31512\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31525\fP: (\fI\%DmitryKuzmenko\fP) Issues/30643 merge forward fixes
@ \fI2016\-02\-29 16:08:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31512\fP: (\fI\%DmitryKuzmenko\fP) Don\(aqt fork in try with critical finally logic. (refs: \fI\%#31525\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30796\fP: (\fI\%skizunov\fP) Fix minion failover after disconnect (refs: \fI\%#31512\fP, \fI\%#31525\fP)
.IP \(bu 2
d5a4daa17b Merge pull request \fI\%#31525\fP from DSRCompany/issues/30643_merge_forward_fixes
.IP \(bu 2
a50b33d96a Don\(aqt fork in try with critical finally logic.
.IP \(bu 2
877bc25381 Fix minion failover after disconnect
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24955\fP: (\fI\%damonnk\fP) Minion fails to start after bootstrap on Raspberry PI (refs: \fI\%#31536\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31536\fP: (\fI\%virtualguy\fP) Remove debian repo from raspbian installation
@ \fI2016\-02\-29 15:32:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
95af21325f Merge pull request \fI\%#31536\fP from virtrnd/remove\-jessie\-backports\-from\-raspbian\-install
.IP \(bu 2
e48900ac55 Use python\-tornado from jessie\-backports for pure debian
.IP \(bu 2
6e338e2601 Remove debian repo from raspbian installation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31193\fP: (\fI\%gwaters\fP) RHEL7 gpg key problem (refs: \fI\%#31528\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31528\fP: (\fI\%vutny\fP) Correct Salt Cloud documentation about updating Salt Bootstrap script
@ \fI2016\-02\-29 15:30:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
5965319600 Merge pull request \fI\%#31528\fP from vutny/cloud\-bootstrap\-doc
.IP \(bu 2
f7beeb69f2 Correct Salt Cloud documentation about updating Salt Bootstrap script
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31365\fP: (\fI\%cwicklein\fP) osrelease_info broken for CentOS 7 (refs: \fI\%#31539\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31539\fP: (\fI\%DmitryKuzmenko\fP) Added temporary workaround for CentOS 7 os\-release id bug.
@ \fI2016\-02\-29 15:30:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
96c0926298 Merge pull request \fI\%#31539\fP from DSRCompany/issues/31365_centos7_osrelease_fix
.IP \(bu 2
a3b806d126 Added temporary workaround for CentOS 7 os\-release id bug.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31508\fP: (\fI\%mcalmer\fP) Zypper correct exit code checking
@ \fI2016\-02\-26 15:21:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
95db870325 Merge pull request \fI\%#31508\fP from mcalmer/zypper\-correct\-exit\-code\-checking
.IP \(bu 2
66e8f6aa37 restructure the code a bit
.IP \(bu 2
f5c125de19 remove new lines between zypper command and check result
.IP \(bu 2
1425c6496c use specialized assert functions for tests
.IP \(bu 2
f266cfdaac test _zypper_check_result()
.IP \(bu 2
aff6467782 adapt tests to new zypper_check_result() output
.IP \(bu 2
edad780cdf use _zypper_check_result()
.IP \(bu 2
7c5d5a2b7a add _zypper_check_result() to raise and error or return stdout
.IP \(bu 2
a6785ef7a9 check zypper exit code everywhere
.IP \(bu 2
935b0510c9 add function to check zypper exit codes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#695\fP: (\fI\%mtippett\fP) Install Failures With Raspbian Jessie (refs: \fI\%#31510\fP, \fI\%#31477\fP, \fI\%#31458\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31510\fP: (\fI\%vutny\fP) Add installation guide for Raspbian (Debian on Raspberry Pi)
@ \fI2016\-02\-26 15:06:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
e51126179c Merge pull request \fI\%#31510\fP from vutny/debian\-raspbian\-install\-guide
.IP \(bu 2
50f3e072b1 Add instruction how to install salt\-minion on Debian Jessie from Stretch
.IP \(bu 2
abcd505178 Update Debian installation guide with information about Raspbian
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31498\fP: (\fI\%Ch3LL\fP) rename methods in pkg states test
@ \fI2016\-02\-25 23:29:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d458bb420 Merge pull request \fI\%#31498\fP from Ch3LL/rename_test
.IP \(bu 2
29a53f4353 rename methods in pkg states test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31427\fP: (\fI\%githubcdr\fP) salt.states.grains.list_present adds duplicates names (refs: \fI\%#31471\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31471\fP: (\fI\%cachedout\fP) Correct issue where duplicate items in grains list during state run will result in duplicate grains
@ \fI2016\-02\-25 20:15:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
625da0d261 Merge pull request \fI\%#31471\fP from cachedout/issue_31427
.IP \(bu 2
74c3053c91 Remove debugging
.IP \(bu 2
30eb5fccf7 Additional tests, but disable the test for distinct lists, because of a problem with context in test suite
.IP \(bu 2
3d2aec05e5 Check for duplicate grains during list insertion
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29727\fP: (\fI\%oeuftete\fP) dockerng.running does not pull image as documented (refs: \fI\%#31352\fP, \fI\%#31455\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31455\fP: (\fI\%ticosax\fP) [dockerng] Disable notset check
@ \fI2016\-02\-25 19:15:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
e85ae2341a Merge pull request \fI\%#31455\fP from ticosax/diable\-NOTSET\-check
.IP \(bu 2
e072937243 dockerd returns sometimes \fINone\fP or \fI[]\fP for ports.
.IP \(bu 2
5630401889 _api_mismatch was a good idea
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31488\fP: (\fI\%isbm\fP) Unit Test for Zypper\(aqs \(dqremove\(dq and \(dqpurge\(dq
@ \fI2016\-02\-25 17:52:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
e68a0947b7 Merge pull request \fI\%#31488\fP from isbm/isbm\-zypper\-ut\-removepurge
.IP \(bu 2
d30f2e4627 Implement unit test for remove and purge
.IP \(bu 2
4caf201052 Refactor code (a bit)
.IP \(bu 2
df89da4d15 Fix the docstring
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31485\fP: (\fI\%jacobhammons\fP) Fixed transport description in minion / master config
@ \fI2016\-02\-25 17:04:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
cd87760c87 Merge pull request \fI\%#31485\fP from jacobhammons/2015.8
.IP \(bu 2
748acab8b5 Fixed zeromq casing in transport settings
.IP \(bu 2
765a226907 Fixed transport description in minion / master config
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31411\fP: (\fI\%justinta\fP) Added some beacons execution module integration tests
@ \fI2016\-02\-25 16:16:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb1ef92e2b Merge pull request \fI\%#31411\fP from jtand/beacons_tests
.IP \(bu 2
7d32b56015 Added some more checks to verify beacon changes were actually happening
.IP \(bu 2
2da5285c03 Added codeauthor
.IP \(bu 2
fd1e2838ea Lint
.IP \(bu 2
421a112914 Added config_dir to test minion config
.IP \(bu 2
bf6a4c0983 Fixed lint error
.IP \(bu 2
3566fbbcca More updates to beacons test
.IP \(bu 2
37c4bf22d2 Updated beacons integration test
.IP \(bu 2
6db628be1a Basic integration tests for beacons execution module
.IP \(bu 2
3b238c2e68 Started adding beacons execution module tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31216\fP: (\fI\%oliver\-dungey\fP) pkg.installed documentation not consistent with implementation (refs: \fI\%#31475\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#30464\fP: (\fI\%sjmh\fP) pillar_env minion config option needs to be documented (refs: \fI\%#31475\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#30261\fP: (\fI\%MadsRC\fP) Add ability to define custom beacons (refs: \fI\%#31475\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29636\fP: (\fI\%ronnix\fP) Documentation for the refresh_password arg in postgres_user.present is confusing (refs: \fI\%#31475\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29528\fP: (\fI\%apergos\fP) nitpick for \(dqUsing Salt at scale\(dq tutorial (refs: \fI\%#31475\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29520\fP: (\fI\%arthurlogilab\fP) [doc] transport option not in default master configuration nor in the example file of the documentation (refs: \fI\%#31475\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#10330\fP: (\fI\%jhenry82\fP) exclude keyword not working (refs: \fI\%#31475\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31475\fP: (\fI\%jacobhammons\fP) Assorted doc issues
@ \fI2016\-02\-25 16:03:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e9a705e75 Merge pull request \fI\%#31475\fP from jacobhammons/2015.8
.IP \(bu 2
a72dc15720 Assorted doc issues Fixes \fI\%#10330\fP Fixes \fI\%#31216\fP Fixes \fI\%#30464\fP Fixes \fI\%#29520\fP Fixes \fI\%#30261\fP Fixes \fI\%#29636\fP Fixes \fI\%#29528\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#695\fP: (\fI\%mtippett\fP) Install Failures With Raspbian Jessie (refs: \fI\%#31510\fP, \fI\%#31477\fP, \fI\%#31458\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31477\fP: (\fI\%vutny\fP) Correct installation documentation for Ubuntu
@ \fI2016\-02\-25 16:01:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
3905dd81d3 Merge pull request \fI\%#31477\fP from vutny/correct\-doc\-install\-ubuntu
.IP \(bu 2
172f34a6ca Correct headers in Debian/Ubuntu/SUSE install instructions
.IP \(bu 2
4248f9ea0a Add common packages installation section to Debian install guide
.IP \(bu 2
8c6e179870 Add note about \fIamd64\fP packages to Ubuntu install guide
.IP \(bu 2
afaa24723a Update Ubuntu install guide:
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31479\fP: (\fI\%isbm\fP) Zypper unit tests & fixes
@ \fI2016\-02\-25 15:58:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
f027dc0cf8 Merge pull request \fI\%#31479\fP from isbm/isbm\-zypper\-unittest
.IP \(bu 2
9f64333ccb Do not use Zypper purge (reason: too dangerous)
.IP \(bu 2
bc05acf7c3 Fix PyLint
.IP \(bu 2
c0eab8b549 Add space before \(dqassert\(dq keyword
.IP \(bu 2
6bcb89a8f6 Implement list packages test
.IP \(bu 2
78837d2926 Add mocking data
.IP \(bu 2
0b64b8137f Implement test for version compare, where python fall\-back algorithm is called
.IP \(bu 2
18b30a3274 Implement test for version compare, where RPM algorithm is called
.IP \(bu 2
59eca53441 Adjust test case for the third package in the test static data
.IP \(bu 2
8034cf0b91 Add third test package static info
.IP \(bu 2
90f209569a Implement test for the upgrade_available
.IP \(bu 2
ad87e719d6 Bugfix: when only one package, no dict is returned. Still upgrade_available should return boolean.
.IP \(bu 2
7eb5f19cb4 Implement test for latest_available
.IP \(bu 2
e372c0b596 Implement test for the info_available
.IP \(bu 2
447771c0fc Add Zypper static data for the available packages
.IP \(bu 2
6989871d27 Implement test for info_installed
.IP \(bu 2
0cc6bce4aa Use strings instead of unicode strings
.IP \(bu 2
3342c03987 Implement list upgrades test
.IP \(bu 2
8862d7af65 Add list upgrades Zypper static data
.IP \(bu 2
4d38d318f4 Implement error handling test for listing upgrades
.IP \(bu 2
080b4ee617 Do not strip the output
.IP \(bu 2
53338402a5 Use renamed zypper products data file
.IP \(bu 2
c6135975b0 Rename Zypper products static test data file
.IP \(bu 2
ab3ff53d89 Reimplement list_upgrades to use XML output from Zypper instead
.IP \(bu 2
e87864986d Add Zypper unit test: test_list_products and test_refresh_db
.IP \(bu 2
cd6419fc9c Add Zypper Unit Test installed products sample data
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31370\fP: (\fI\%Ch3LL\fP) pkg.info_installed on ubuntu12 does not output info and stack trace (refs: \fI\%#31439\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#31366\fP: (\fI\%Ch3LL\fP) pkg.info_installed on centos5 does not output info (refs: \fI\%#31445\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31445\fP: (\fI\%rallytime\fP) Only use LONGSIZE in rpm.info if available. Otherwise, use SIZE.
@ \fI2016\-02\-24 18:35:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31439\fP: (\fI\%rallytime\fP) Fix lowpkg.info function for Ubuntu 12 \- make sure we have a pkg name (refs: \fI\%#31445\fP)
.IP \(bu 2
987dd89979 Merge pull request \fI\%#31445\fP from rallytime/fix\-31366
.IP \(bu 2
42415a4a7b Make rpm_tags query more concise
.IP \(bu 2
9965fe188a Added to pkg.info_installed test for RedHat and Suse systems
.IP \(bu 2
47cc7c3466 Add error check when retcode is 0, but stderr is present
.IP \(bu 2
294371243d Only use LONGSIZE in rpm.info if available. Otherwise, use SIZE.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31464\fP: (\fI\%Ch3LL\fP) integartion test: ensure decorator only runs on one method and not class
@ \fI2016\-02\-24 18:35:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
979c8b4faa Merge pull request \fI\%#31464\fP from Ch3LL/fix_int_test
.IP \(bu 2
a387d175d8 integartion test\- ensure decorator only runs on one method and not entire class
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#695\fP: (\fI\%mtippett\fP) Install Failures With Raspbian Jessie (refs: \fI\%#31510\fP, \fI\%#31477\fP, \fI\%#31458\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31458\fP: (\fI\%vutny\fP) Correct installation documentation for Debian
@ \fI2016\-02\-24 17:01:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
aa0a9a03dd Merge pull request \fI\%#31458\fP from vutny/correct\-doc\-install\-debian
.IP \(bu 2
42aa7eeafd Add section about installation from the Debian Main Repository
.IP \(bu 2
07dece2f8f Remove duplicate post\-installation section for Debian install guide
.IP \(bu 2
10c05f6943 Add install section for Debian Stretch (Testing) from community repository
.IP \(bu 2
b2c78e08dc Add note about supported Debian architectures on SaltStack corp repo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31457\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-02\-24 16:42:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
330c4d8b0f Merge pull request \fI\%#31457\fP from rallytime/merge\-2015.8
.IP \(bu 2
94b3cf08c7 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.INDENT 2.0
.IP \(bu 2
26733ce988 Merge pull request \fI\%#31442\fP from sastorsl/salt\-modules\-file.py\-copy\-check\-src
.INDENT 2.0
.IP \(bu 2
0a4132866d removed lint in the exception string
.IP \(bu 2
f8b5d498c3 Add os.path.exists(src) to file.py, def copy
.UNINDENT
.IP \(bu 2
e480727d27 Merge pull request \fI\%#31441\fP from cachedout/issue_30739
.INDENT 2.0
.IP \(bu 2
ffcfad1570 Include localhost minions in presence detection for runner
.UNINDENT
.IP \(bu 2
91ff95f093 Merge pull request \fI\%#31416\fP from carlwgeorge/selinux_doc_fix
.INDENT 2.0
.IP \(bu 2
0e6846d72e selinux module documentation fix
.UNINDENT
.IP \(bu 2
7d01979898 Merge pull request \fI\%#31336\fP from terminalmage/config\-validation\-logging
.INDENT 2.0
.IP \(bu 2
795008bad1 Improve config validation logging
.UNINDENT
.IP \(bu 2
fed096a29d Merge pull request \fI\%#31374\fP from sjorge/solarish_hwaddr
.INDENT 2.0
.IP \(bu 2
bdf2576dfb missed a .format and messed up the join
.IP \(bu 2
bbd2fdc96d fix for illumos/solaris hwaddr
.UNINDENT
.IP \(bu 2
6ee17f905b Merge pull request \fI\%#31339\fP from jacobhammons/dot7prev
.INDENT 2.0
.IP \(bu 2
07120a8d48 changed latest release to 2015.8.7
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31370\fP: (\fI\%Ch3LL\fP) pkg.info_installed on ubuntu12 does not output info and stack trace (refs: \fI\%#31439\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31439\fP: (\fI\%rallytime\fP) Fix lowpkg.info function for Ubuntu 12 \- make sure we have a pkg name (refs: \fI\%#31445\fP)
@ \fI2016\-02\-24 16:24:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
e553f18dc4 Merge pull request \fI\%#31439\fP from rallytime/fix\-31370
.IP \(bu 2
1931c61563 Only run this pkg.info_installed test on distros that have that func
.IP \(bu 2
0488668a00 Fix lowpkg.info function for Ubuntu 12 \- make sure we have a pkg name
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31456\fP: (\fI\%RabidCicada\fP) Clarified the form of requisite targets/requisite\-references
@ \fI2016\-02\-24 16:24:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
fcb12dbe96 Merge pull request \fI\%#31456\fP from RabidCicada/clarify\-requisites\-doc
.IP \(bu 2
87f4843490 Clarified the form of requisite targets/requisite\-references
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30431\fP: (\fI\%nbow\fP) cp.get_url with large files results in an Uncaught Exception (refs: \fI\%#30704\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27093\fP: (\fI\%TheBigBear\fP) 2015.8.0 winrepo downloader corrupts some installers (refs: \fI\%#30704\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31453\fP: (\fI\%DmitryKuzmenko\fP) Backport cp_geturl fix for large files into 2015.8
@ \fI2016\-02\-24 15:38:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30704\fP: (\fI\%DmitryKuzmenko\fP) Issues/30431 get url large file (refs: \fI\%#31453\fP)
.IP \(bu 2
7dac1db55d Merge pull request \fI\%#31453\fP from DSRCompany/issues/30431_get_url_large_file_2015.8_backbort
.IP \(bu 2
664bdec2b3 Backport cp_geturl fix for large files into 2015.8
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31444\fP: (\fI\%jacobhammons\fP) Documentation updates \- ddns state, file.line state/exe function, installation dependencies
@ \fI2016\-02\-23 22:40:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
8f6c4be618 Merge pull request \fI\%#31444\fP from jacobhammons/ddns\-docs
.IP \(bu 2
0b8fce1de4 Fixes \fI\%#31402\fP Added arguments to state \fIfile.line\fP to fix issue where exe module uses \fIline\fP and state module uses \fIname\fP\&. Reformatted parameters in exe module \fIfile.line\fP placeholder release notes for 2015.5.8
.IP \(bu 2
0b1fdf7e21 Added note clarifying when dnspython is not required
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31341\fP: (\fI\%twangboy\fP) Clarification on Windows Package Manager docs
@ \fI2016\-02\-23 16:09:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
42027e0d72 Merge pull request \fI\%#31341\fP from twangboy/package_manager_docs
.IP \(bu 2
c16cfc6360 Fix typos
.IP \(bu 2
8dff065cec Fix some formatting issues
.IP \(bu 2
dfef24f13b Merge branch \(aq2015.8\(aq of \fI\%https://github.com/saltstack/salt\fP into 2015.8
.IP \(bu 2
807257b138 Clarification for Windows Package Manger
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31380\fP: (\fI\%kiorky\fP) Bring up ext_pillar rendering errors as well
@ \fI2016\-02\-23 16:08:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
30d968c0a7 Merge pull request \fI\%#31380\fP from kiorky/p
.IP \(bu 2
e3e97a43ce Bring up ext_pillar rendering errors as well
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31410\fP: (\fI\%terminalmage\fP) Debian GNU/Linux grains broken in head of 2015.8 branch (refs: \fI\%#31418\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31418\fP: (\fI\%terminalmage\fP) Fix core grains when Debian OS detected as \(aqDebian GNU/Linux\(aq
@ \fI2016\-02\-23 15:49:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
64ed9fcd01 Merge pull request \fI\%#31418\fP from terminalmage/fix\-debian\-grains
.IP \(bu 2
5c833efc01 Support running grains tests
.IP \(bu 2
0e0cd17160 Rename core.py to core_test.py
.IP \(bu 2
d3cd1b596d Add unit test for core grains
.IP \(bu 2
e3d549d376 Fix debian grains setup
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31429\fP: (\fI\%mcalmer\fP) fix argument handling for pkg.download
@ \fI2016\-02\-23 15:48:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec01b994bd Merge pull request \fI\%#31429\fP from mcalmer/fix\-refresh\-arguments
.IP \(bu 2
299c07fa7d fix argument handling for pkg.download
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31432\fP: (\fI\%ticosax\fP) [dockerng] Hotfix docker 1.10.2
@ \fI2016\-02\-23 15:39:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
05c12b9ba1 Merge pull request \fI\%#31432\fP from ticosax/hotfix\-docker\-1.10.2
.IP \(bu 2
1e9f6ff324 handle inconsistencies in dockerd API
.IP \(bu 2
8484815f58 pep8
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31420\fP: (\fI\%twangboy\fP) Handle Unversioned Packages
@ \fI2016\-02\-22 23:46:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb81e905e4 Merge pull request \fI\%#31420\fP from twangboy/unversioned_pkgs
.IP \(bu 2
816e991e87 Fix version check
.IP \(bu 2
85d8b938ad Match unversioned packages to winrepo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31417\fP: (\fI\%jacobhammons\fP) ddns state docs updated with notes regarding the name, zone, and keyfile.
@ \fI2016\-02\-22 23:16:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
19d7810478 Merge pull request \fI\%#31417\fP from jacobhammons/ddns\-docs
.IP \(bu 2
5c4cbbb572 Added notes regarding the name, zone, and keyfile.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31391\fP: (\fI\%redmcg\fP) Added sanity check: is \(aqpillar\(aq in self.opts
@ \fI2016\-02\-22 20:05:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
ac6af79abc Merge pull request \fI\%#31391\fP from redmcg/master_schedule_fix
.IP \(bu 2
91e74feaf3 Added sanity check: is \(aqpillar\(aq in self.opts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31376\fP: (\fI\%cro\fP) Some distros don\(aqt have a /lib/systemd
@ \fI2016\-02\-22 18:11:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
c7bd13c9c9 Merge pull request \fI\%#31376\fP from cro/suse_service2
.IP \(bu 2
f3fec5562e We need one more mocked return from listdir.
.IP \(bu 2
ab9d9e7008 Can\(aqt add a tuple and a string.
.IP \(bu 2
8f12bdb1a0 Check to see if a path is a link, because it\(aqs likely that if it IS a link, one of the other paths points to it.  Ignore so we don\(aqt get duplicates.
.IP \(bu 2
8f0e866f1b Some distros do not seem to have a /lib/systemd, but do have a /usr/lib/systemd
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29727\fP: (\fI\%oeuftete\fP) dockerng.running does not pull image as documented (refs: \fI\%#31352\fP, \fI\%#31455\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27976\fP: (\fI\%syphernl\fP) Module dockerng.inspect_image always returns 404 (refs: \fI\%#31352\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31352\fP: (\fI\%ticosax\fP) [dockerng] Pull missing images when calling dockerng.running
@ \fI2016\-02\-22 16:54:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
105821efc7 Merge pull request \fI\%#31352\fP from ticosax/pull\-image\-on\-running
.IP \(bu 2
8c86eeb4dc Pull missing images when calling dockerng.running
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31378\fP: (\fI\%mcalmer\fP) Zypper refresh handling
@ \fI2016\-02\-22 16:50:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
83294e4f3a Merge pull request \fI\%#31378\fP from mcalmer/zypper\-refresh\-handling
.IP \(bu 2
274e6467be do not change kwargs in refresh while checking a value
.IP \(bu 2
644b14c273 simplify checking the refresh parameter
.IP \(bu 2
db0e0de2fd add refresh option to more functions
.IP \(bu 2
5836be3f59 unify behavior of refresh
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31229\fP: (\fI\%eykd\fP) git.latest broken behavior in 2015.8.x on older Git (refs: \fI\%#31373\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31373\fP: (\fI\%terminalmage\fP) Use \-\-set\-upstream instead of \-\-track to set upstream on older git
@ \fI2016\-02\-22 16:46:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
e24685b89a Merge pull request \fI\%#31373\fP from terminalmage/issue31229
.IP \(bu 2
28f0a75cc1 Use \-\-set\-upstream instead of \-\-track to set upstream on older git
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31137\fP: (\fI\%jeffreyctang\fP) logrotate creates .bak files in /etc/logrotate.d which logrotate reads. (refs: \fI\%#31390\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31390\fP: (\fI\%abednarik\fP) Fix Logrotate module.
@ \fI2016\-02\-22 16:09:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
c5790bc4d6 Merge pull request \fI\%#31390\fP from abednarik/remove_deprecated_psed_in_lorgotate
.IP \(bu 2
c1e0ff7785 Fix Logrotate module.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28004\fP: (\fI\%warden\fP) dockerng.image_present should allow public repository pulling by default (refs: \fI\%#31354\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31354\fP: (\fI\%ticosax\fP) [dockerng] Don\(aqt require auth for all registries
@ \fI2016\-02\-20 05:45:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
174ee10fc2 Merge pull request \fI\%#31354\fP from ticosax/dont\-require\-auth\-for\-all\-registries
.IP \(bu 2
4a9f661d66 It exists public registries where auth is not required.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31368\fP: (\fI\%whiteinge\fP) Update list of netapi clients for autoclass
@ \fI2016\-02\-19 20:57:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
8d0498eff4 Merge pull request \fI\%#31368\fP from whiteinge/netapi\-client\-list
.IP \(bu 2
0cfe5d89a0 Update list of netapi clients for autoclass
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31367\fP: (\fI\%techhat\fP) Add docs on how to actually use SDB
@ \fI2016\-02\-19 20:07:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
9b0e29107b Merge pull request \fI\%#31367\fP from techhat/sdbdocs
.IP \(bu 2
eea192a545 Add docs on how to actually use SDB
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31357\fP: (\fI\%ticosax\fP) [dockerng] Support docker inconsistencies
@ \fI2016\-02\-19 20:02:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
7e599f0e27 Merge pull request \fI\%#31357\fP from ticosax/support\-docker\-inconsistencies
.IP \(bu 2
3672b8e7b1 docker daemon returns sometimes empty list and sometimes None
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31353\fP: (\fI\%ticosax\fP) [dockerng] Fix when ports are integers
@ \fI2016\-02\-19 19:55:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31326\fP: (\fI\%ticosax\fP) [dockerng ] Detect settings removal (refs: \fI\%#31353\fP)
.IP \(bu 2
18bd78260d Merge pull request \fI\%#31353\fP from ticosax/fix\-when\-port\-are\-integers
.IP \(bu 2
20fdc43968 Follow up for \fI\%#31326\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31346\fP: (\fI\%ticosax\fP) Backport \fI\%#31130\fP to 2015.8
@ \fI2016\-02\-19 19:46:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31130\fP: (\fI\%ticosax\fP) Saltnado: provide also get parameters to the context (refs: \fI\%#31346\fP)
.IP \(bu 2
dec254a7a2 Merge pull request \fI\%#31346\fP from ticosax/backport\-31130\-to\-2015.8
.IP \(bu 2
a8dc33a5e3 Saltnado provide also get parameters to the context
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31332\fP: (\fI\%terminalmage\fP) Clarify documentation for gitfs/hgfs/svnfs mountpoint and root options
@ \fI2016\-02\-19 18:31:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
d639d65381 Merge pull request \fI\%#31332\fP from terminalmage/issue31167
.IP \(bu 2
eebc325040 Clarify documentation for gitfs/hgfs/svnfs mountpoint and root options
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31305\fP: (\fI\%mcalmer\fP) call zypper with option \-\-non\-interactive everywhere
@ \fI2016\-02\-19 18:14:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
d067e77fee Merge pull request \fI\%#31305\fP from mcalmer/zypper\-non\-interactive\-everywhere
.IP \(bu 2
75e776761c write a zypper command builder function
.IP \(bu 2
3df302fcb7 call zypper with option \-\-non\-interactive everywhere
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31337\fP: (\fI\%jacobhammons\fP) Release notes and versioning for 2015.8.7
@ \fI2016\-02\-19 00:20:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
98a14f8090 Merge pull request \fI\%#31337\fP from jacobhammons/dot7
.IP \(bu 2
d4fb33939e Release notes and versioning for 2015.8.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31326\fP: (\fI\%ticosax\fP) [dockerng ] Detect settings removal (refs: \fI\%#31353\fP)
@ \fI2016\-02\-18 22:02:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
f0ba9c1eca Merge pull request \fI\%#31326\fP from ticosax/2015.8\-dockerng\-detect\-settings\-removal
.IP \(bu 2
7bedd86ebe Add detection of removed settings.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31292\fP: (\fI\%twangboy\fP) Fix dunder virtual to check for Remote Administration Tools
@ \fI2016\-02\-18 18:57:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
130f515391 Merge pull request \fI\%#31292\fP from twangboy/win_servermanager
.IP \(bu 2
89b47ab3c5 Update return documentation for install/remove
.IP \(bu 2
a0be43120b Fix cmd_quote error
.IP \(bu 2
13cd57a890 Remove repeating Import ServerManager command
.IP \(bu 2
3270a2859f Add check for server manager module
.IP \(bu 2
4bdae47a44 Added checks for Windows 2008 R2
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30932\fP: (\fI\%johje349\fP) Glusterfs peered fails on secondary host in 2015.8.4 (refs: \fI\%#31287\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31287\fP: (\fI\%joejulian\fP) Rework tests and fix reverse peering with gluster 3.7
@ \fI2016\-02\-18 17:57:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
5d31714b44 Merge pull request \fI\%#31287\fP from joejulian/2015.8_30932_peer_probe_by_ip
.IP \(bu 2
783e9b2e13 Rework tests and fix reverse peering with gluster 3.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31196\fP: (\fI\%sakateka\fP) Here are a few fixes utils.network
@ \fI2016\-02\-18 17:27:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
a2f6447f8d Merge pull request \fI\%#31196\fP from sakateka/utils\-network\-fix
.IP \(bu 2
a7b11024dd fix typo
.IP \(bu 2
92fd48fcf7 Do not Fallback to use lsof if proc available
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29795\fP: (\fI\%vutny\fP) Unable to override state\-output setting in command line (refs: \fI\%#31299\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31299\fP: (\fI\%rallytime\fP) Allow state\-output and state\-verbose default settings to be set from CLI
@ \fI2016\-02\-18 17:25:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
d20a30b8be Merge pull request \fI\%#31299\fP from rallytime/fix\-29795
.IP \(bu 2
483f31922b Allow state\-output and state\-verbose default settings to be set from CLI
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31317\fP: (\fI\%terminalmage\fP) Fix versonadded directive
@ \fI2016\-02\-18 16:56:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
25d8af21c9 Merge pull request \fI\%#31317\fP from terminalmage/git\-version\-audit
.IP \(bu 2
acc3b54621 Fix versonadded directive
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30999\fP: (\fI\%orymate\fP) git.latest rev=tag fails with old git(1) (refs: \fI\%#31245\fP, \fI\%#31301\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31301\fP: (\fI\%terminalmage\fP) Corrected fix for \fI\%#30999\fP
@ \fI2016\-02\-18 15:59:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31245\fP: (\fI\%jespada\fP) fix git state for git version older than 1.9.2  (refs: \fI\%#31301\fP)
.IP \(bu 2
f2b662371c Merge pull request \fI\%#31301\fP from terminalmage/issue30999
.IP \(bu 2
625af70e08 Fix \-\-unset\-upstream handling
.IP \(bu 2
7940881797 fix git state github issue \fI\%#30999\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31302\fP: (\fI\%terminalmage\fP) Audit CLI opts used in git states
@ \fI2016\-02\-18 15:58:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
408d89e174 Merge pull request \fI\%#31302\fP from terminalmage/git\-version\-audit
.IP \(bu 2
ca410c0a94 Audit CLI opts used in git states
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31312\fP: (\fI\%terminalmage\fP) Merge 2015.5 into 2015.8
@ \fI2016\-02\-18 15:57:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
098f05eb3c Merge pull request \fI\%#31312\fP from terminalmage/merge\-forward\-2015.5\-2015.8
.IP \(bu 2
808d150fe4 Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.5\-2015.8
.IP \(bu 2
cd3400e67e Merge pull request \fI\%#31288\fP from notpeter/ssh_known_hosts_docs
.INDENT 2.0
.IP \(bu 2
3f573d89a2 Improve salt.states.ssh_known_hosts documentation.
.UNINDENT
.IP \(bu 2
875d9925fa Merge pull request \fI\%#31183\fP from heyfife/fix\-gce\-named\-static\-ip\-reservation
.INDENT 2.0
.IP \(bu 2
26774e2323 Fixed named external_ip reservation/re\-use code.
.UNINDENT
.IP \(bu 2
e56c402c0c Merge pull request \fI\%#31032\fP from terminalmage/issue31001
.INDENT 2.0
.IP \(bu 2
42daea4509 yumpkg.py: Remove repoquery usage everywhere but check_db
.IP \(bu 2
50befbc149 backport salt.utils.pkg.rpm to 2015.5
.IP \(bu 2
a1ad14994a Move salt.utils.itersplit() to salt.utils.itertools.split()
.IP \(bu 2
5b8646ce64 Ignore failure to install new enough dnf\-plugins\-core
.IP \(bu 2
defe0859fd Ensure that dnf\-plugins\-core 0.1.15 is installed
.UNINDENT
.IP \(bu 2
cec69b74f0 Merge pull request \fI\%#31264\fP from sjorge/if_missing\-155\-fix
.INDENT 2.0
.IP \(bu 2
545edbf5e1 fix if_missing gets appended to dirs list, take III
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31223\fP: (\fI\%pprince\fP) file_tree pillar: fails when data files at root end in \(aq\e\en\(aq (refs: \fI\%#31225\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31225\fP: (\fI\%pprince\fP) Fix in file_tree pillar (Fixes \fI\%#31223\fP\&.)
@ \fI2016\-02\-18 06:06:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
c58f654bc3 Merge pull request \fI\%#31225\fP from pprince/PR/bugfix/file_tree
.IP \(bu 2
d592d8636b Fix regression in file_tree pillar (Fixes \fI\%#31223\fP\&.)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31233\fP: (\fI\%mcalmer\fP) implement version_cmp for zypper
@ \fI2016\-02\-17 20:20:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
fe9e5d27e6 Merge pull request \fI\%#31233\fP from mcalmer/2015.8\-zypperpy\-add\-version_cmp
.IP \(bu 2
389a4b2548 Check if rpm\-python can be imported
.IP \(bu 2
6ad6a90955 pylint changes
.IP \(bu 2
7beaf26068 implement version_cmp for zypper
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31273\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-02\-17 20:14:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
93c03a400b Merge pull request \fI\%#31273\fP from rallytime/merge\-2015.5
.IP \(bu 2
11cfb636fb Pylint fix
.IP \(bu 2
023ad4635c Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.INDENT 2.0
.IP \(bu 2
fa3f474de9 Merge pull request \fI\%#31110\fP from cachedout/fixup_30730
.INDENT 2.0
.IP \(bu 2
5bf5848e04 Fixup unit test
.IP \(bu 2
f558f68e0a Fixes pylint warnings
.IP \(bu 2
56a975ec43 Attempt to fix pylint warnings
.IP \(bu 2
55d71be057 Make documentation and code examples consistent with code
.IP \(bu 2
1f04fed6f8 Change parameter name from includes to skips
.IP \(bu 2
ccf5e13e7d Adding support for skipHidden in SetInclude
.IP \(bu 2
4f2d4af2e7 Variable names standardization
.IP \(bu 2
f5917ac1e8 Fixes typo
.IP \(bu 2
26e5236073 Invert RebootRequired logic
.IP \(bu 2
8065a7abf6 Add basic documentation and define how the skips parameter works.
.IP \(bu 2
389fea7508 Change parameter name from includes to skips
.IP \(bu 2
30e1fef906 Adding support for skipHidden in SetInclude
.IP \(bu 2
1244eea5be Variable names standardization, consistent if/else logic with states.win_update
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31253\fP: (\fI\%gtmanfred\fP) allow for nova servers to be built with premade volumes
@ \fI2016\-02\-17 17:55:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
dc2e7c8956 Merge pull request \fI\%#31253\fP from gtmanfred/2015.8
.IP \(bu 2
36bf06e539 fix doc for boot_volume
.IP \(bu 2
9660c91b57 allow for nova servers to be built with premade volumes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30651\fP: (\fI\%sjorge\fP) salt.states.grains.list_present should not show changes if none are made! (refs: \fI\%#31651\fP, \fI\%#30689\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31271\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30689\fP to 2015.8
@ \fI2016\-02\-17 16:52:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30689\fP: (\fI\%sjorge\fP) fix for \fI\%#30651\fP grains.list_present and grains.list_absent (refs: \fI\%#31651\fP, \fI\%#31271\fP)
.IP \(bu 2
29e3dd091d Merge pull request \fI\%#31271\fP from rallytime/bp\-30689
.IP \(bu 2
3dae79d516 fix nested grains always show update due to __grains__.get() not supporting the \(dq:\(dq separator
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30461\fP: (\fI\%jfindlay\fP) update documentation on bootstrap\-supported platforms (refs: \fI\%#31255\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31255\fP: (\fI\%jacobhammons\fP) Fixes \fI\%#30461\fP
@ \fI2016\-02\-17 02:23:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
fcfc6f4fd3 Merge pull request \fI\%#31255\fP from jacobhammons/doc\-fixes
.IP \(bu 2
3c4f8215c3 Fixes \fI\%#30461\fP Credited Sebastian Kramer for finding CVE 2016\-1866 in release notes Added note about salt virt not working on KVM in a VM
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31106\fP: (\fI\%rvandegrift\fP) Exception from scheduled runner (refs: \fI\%#31189\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31189\fP: (\fI\%dmacvicar\fP) Fix crash with scheduler and runners (\fI\%#31106\fP)
@ \fI2016\-02\-16 18:49:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
62d76902ce Merge pull request \fI\%#31189\fP from dmacvicar/dmacvicar\-2015.8\-31106
.IP \(bu 2
9ad8cb1e6b Fix crash with scheduler and runners (\fI\%#31106\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30962\fP: (\fI\%fantasy86\fP) Targeting by matching ip address doesn\(aqt work (refs: \fI\%#31201\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#30169\fP: (\fI\%colinlabs\fP) Can\(aqt use Subnet/IP Address Matching (refs: \fI\%#31201\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29733\fP: (\fI\%roshan3133\fP) salt \-S <ipaddress> test.ping  command output getting list of minions which did not not return. (refs: \fI\%#31201\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29188\fP: (\fI\%bergemalm\fP) Unable to target minions via ipcidr in 2015.8 (refs: \fI\%#31201\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31201\fP: (\fI\%The\-Loeki\fP) Utilize prepared grains var in master\-side ipcidr matching
@ \fI2016\-02\-16 18:36:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
dc78d0a504 Merge pull request \fI\%#31201\fP from The\-Loeki/patch\-1
.IP \(bu 2
318689d728 Correct ordering of address/network matching, improve performance of master\-side cidr matching
.IP \(bu 2
4e4e0926da Utilize prepared grains var in master\-side ipcidr matching
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31239\fP: (\fI\%terminalmage\fP) Improve logging when master cannot decode a payload
@ \fI2016\-02\-16 16:35:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
60bbac36fa Merge pull request \fI\%#31239\fP from terminalmage/better\-bad\-load\-logging
.IP \(bu 2
1fbe3cba1f Improve logging when master cannot decode a payload
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31185\fP: (\fI\%twangboy\fP) pkg.refresh_db leaves old sls files if the name changes (refs: \fI\%#31190\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31190\fP: (\fI\%twangboy\fP) Clear minion cache before caching from master
@ \fI2016\-02\-16 16:11:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
80f1c3553b Merge pull request \fI\%#31190\fP from twangboy/refresh_db
.IP \(bu 2
860437665d Fix some lint
.IP \(bu 2
799d938d6a Clear minion cache before caching from master
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31226\fP: (\fI\%pprince\fP) Minor docs fix: file_tree pillar (Fixes \fI\%#31124\fP)
@ \fI2016\-02\-16 15:25:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31124\fP: (\fI\%zygiss\fP) Make load beacon cross\-platform (refs: \fI\%#31226\fP)
.IP \(bu 2
28a2b8097b Merge pull request \fI\%#31226\fP from pprince/PR/docfix/file_tree
.IP \(bu 2
c13852fbbf Minor docs fix: file_tree pillar (Fixes \fI\%#31124\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31234\fP: (\fI\%mcalmer\fP) improve doc for list_pkgs
@ \fI2016\-02\-16 15:25:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
9afad13306 Merge pull request \fI\%#31234\fP from mcalmer/zypperpy\-comment\-list_pkgs
.IP \(bu 2
e3bb862a32 improve doc for list_pkgs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31237\fP: (\fI\%mcalmer\fP) add handling for OEM products
@ \fI2016\-02\-16 15:12:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
e8f3a707ae Merge pull request \fI\%#31237\fP from mcalmer/zypper_py\-add\-OEM\-product\-handling
.IP \(bu 2
d773b7317b add handling for OEM products
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31182\fP: (\fI\%rallytime\fP) Back\-port \fI\%#31172\fP to 2015.8
@ \fI2016\-02\-13 21:36:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31172\fP: (\fI\%techhat\fP) Use correct deploy directory (refs: \fI\%#31182\fP)
.IP \(bu 2
415654ee9e Merge pull request \fI\%#31182\fP from rallytime/bp\-31172
.IP \(bu 2
a743778e98 Use correct deploy directory
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27498\fP: (\fI\%arthurlogilab\fP) [runner] salt\-run cache.clear_mine_func broken, can\(aqt take clear_mine_func (refs: \fI\%#31191\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31191\fP: (\fI\%rallytime\fP) Make sure doc example matches kwarg
@ \fI2016\-02\-13 21:34:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
434e05667a Merge pull request \fI\%#31191\fP from rallytime/fix\-27498
.IP \(bu 2
0bdbaa49d1 Make sure doc example matches kwarg
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31171\fP: (\fI\%Ch3LL\fP) added logic to check for installed package
@ \fI2016\-02\-12 22:10:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
c5e5af827c Merge pull request \fI\%#31171\fP from Ch3LL/megan\-20158
.IP \(bu 2
a12e2f566b fix lint error
.IP \(bu 2
a123efd4ef added logic to check for installed package
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30934\fP: (\fI\%marnovdm\fP) contents_pillar no longer works with lists in 2015.8.5 (refs: \fI\%#31026\fP, \fI\%#31177\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31177\fP: (\fI\%Ch3LL\fP) add integration test for issue \fI\%#30934\fP
@ \fI2016\-02\-12 22:09:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
a024d3536f Merge pull request \fI\%#31177\fP from Ch3LL/test_content_pillars
.IP \(bu 2
9204e3f562 add integration test for issue 30934w
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31181\fP: (\fI\%cachedout\fP) Lint 2015.8 branch
@ \fI2016\-02\-12 21:57:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f22335e28 Merge pull request \fI\%#31181\fP from cachedout/lint_20158
.IP \(bu 2
4c0be11627 Lint 2015.8 branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29423\fP: (\fI\%l13t\fP) iptables and match\-set with two parameters (refs: \fI\%#29718\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31169\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29718\fP to 2015.8
@ \fI2016\-02\-12 18:28:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29718\fP: (\fI\%thusoy\fP) Support match\-sets in iptables module (refs: \fI\%#31169\fP)
.IP \(bu 2
4d1b49c1e7 Merge pull request \fI\%#31169\fP from rallytime/bp\-29718
.IP \(bu 2
ceae2a16f8 Support match\-sets in iptables module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31170\fP: (\fI\%rallytime\fP) Back\-port \fI\%#31157\fP to 2015.8
@ \fI2016\-02\-12 18:27:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31157\fP: (\fI\%captaininspiration\fP) Fix locale generation on Ubuntu (refs: \fI\%#31170\fP)
.IP \(bu 2
f2efd3e6c1 Merge pull request \fI\%#31170\fP from rallytime/bp\-31157
.IP \(bu 2
27776b5f4e Fix locale generation on Ubuntu
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31147\fP: (\fI\%cro\fP) Documentation clarifications.
@ \fI2016\-02\-12 17:16:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
7f49fbb70d Merge pull request \fI\%#31147\fP from cro/fx2_doc
.IP \(bu 2
a005e4af55 Documentation clarifications.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31153\fP: (\fI\%edencrane\fP) Fixed invalid host causing \(aqreference to variable before assignment\(aq
@ \fI2016\-02\-12 16:30:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
7986b9e033 Merge pull request \fI\%#31153\fP from edencrane/fix\-network\-connect\-invalid\-hostname
.IP \(bu 2
a14c4bb5f2 Fixed invalid host causing \(aqreference to variable before assignment\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30994\fP: (\fI\%onorua\fP) beacon enable from state is failing (refs: \fI\%#31152\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31152\fP: (\fI\%garethgreenaway\fP) fixes to beacon module, state module and friends
@ \fI2016\-02\-12 16:27:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
f5ab76801b Merge pull request \fI\%#31152\fP from garethgreenaway/30994_beacon_add_failing_and_other_fixes
.IP \(bu 2
91b14dca40 fixing the beacon module and state module to handle passing enabled properly.  Also reworking how what is returned from the validating functions is handled to ensure when beacon configurations aren\(aqt validate the results indicate exactly why.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31149\fP: (\fI\%jfindlay\fP) add 2015.8.7 release notes
@ \fI2016\-02\-12 00:06:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
c8047d979d Merge pull request \fI\%#31149\fP from jfindlay/2015.8
.IP \(bu 2
b58783b895 add 2015.8.7 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31134\fP: (\fI\%isbm\fP) Fix types in the output data and return just a list of products
@ \fI2016\-02\-11 20:19:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
5c394ac49c Merge pull request \fI\%#31134\fP from isbm/isbm\-zypper\-list\-products
.IP \(bu 2
670a326e3d Fix types in the output data and return just a list of products
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31115\fP: (\fI\%nfillot\fP) 2015.8.5 salt\-cloud nova valid ip address was not found (refs: \fI\%#31120\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29758\fP: (\fI\%zaide\fP) 2015.8.3 salt\-call runners.cloud : local variable \(aqaccess_ip\(aq referenced before assignment (refs: \fI\%#31120\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29666\fP: (\fI\%tminn\fP) Nova driver broken for 2015.8.[1\-3] (refs: \fI\%#31120\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31120\fP: (\fI\%gtmanfred\fP) Clean up some bugs in the nova driver
@ \fI2016\-02\-11 20:17:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
8f2e3a26e5 Merge pull request \fI\%#31120\fP from gtmanfred/2015.8
.IP \(bu 2
4a411c0817 fix comment
.IP \(bu 2
47ecb7a150 include all ips in public_ips or private_ips
.IP \(bu 2
b2e8202f5d don\(aqt exit on a missing server
.IP \(bu 2
8ad1ee6db4 clean up references to access_ip extra network
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31099\fP: (\fI\%Ch3LL\fP) Cannot specify size in map file in 2015.8 (refs: \fI\%#31132\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31132\fP: (\fI\%rallytime\fP) Make sure required profile configurations passed in a map file work
@ \fI2016\-02\-11 20:16:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d592a398e Merge pull request \fI\%#31132\fP from rallytime/fix\-31099
.IP \(bu 2
1da03da9df Pylint fix
.IP \(bu 2
337592ec56 Make sure required profile configurations passed in a map file work
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31014\fP: (\fI\%gtmanfred\fP) [2015.8] pkg breaks for yum pkgs.latest if the packages has an epoch (refs: \fI\%#31131\fP, \fI\%#31015\fP, \fI\%#31031\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31131\fP: (\fI\%Ch3LL\fP) integration test for issue \fI\%#31014\fP
@ \fI2016\-02\-11 17:33:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
b831e0a865 Merge pull request \fI\%#31131\fP from Ch3LL/megan\-20158
.IP \(bu 2
af82b1233a integration test for issue \fI\%#31014\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31133\fP: (\fI\%cachedout\fP) Fixup 31121
@ \fI2016\-02\-11 17:32:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
e378afd891 Merge pull request \fI\%#31133\fP from cachedout/fixup_31121
.IP \(bu 2
a4040da46d Fix bad unit test
.IP \(bu 2
0e68fafb74 Fix alternative module and state.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31125\fP: (\fI\%isbm\fP) Force\-kill websocket\(aqs child processes faster than default two minutes.
@ \fI2016\-02\-11 16:50:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
a4a40262f8 Merge pull request \fI\%#31125\fP from isbm/isbm\-salt\-api\-service
.IP \(bu 2
f73f70375c Force\-kill websocket\(aqs child processes faster than default two minutes.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31119\fP: (\fI\%sakateka\fP) fixes for ipv6\-only multi\-master faliover
@ \fI2016\-02\-11 16:21:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
79c85859bc Merge pull request \fI\%#31119\fP from sakateka/fix\-for\-ipv6only\-failover
.IP \(bu 2
2c45d151d1 fix unintentional breaking changes
.IP \(bu 2
043a5e6fd7 fixes for ipv6\-only multi\-master faliover
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31107\fP: (\fI\%techhat\fP) Don\(aqt try to add a non\-existent IP address
@ \fI2016\-02\-10 21:52:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
825b510030 Merge pull request \fI\%#31107\fP from techhat/nebulaprivip
.IP \(bu 2
1fa69982c4 Don\(aqt try to add a non\-existent IP address
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31108\fP: (\fI\%justinta\fP) Changed npm integration test to install request.
@ \fI2016\-02\-10 21:52:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
c56a819fd8 Merge pull request \fI\%#31108\fP from jtand/npm_test_fix
.IP \(bu 2
a5eac47b25 Changed npm integration test to install request.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31105\fP: (\fI\%cachedout\fP) Lint 30975
@ \fI2016\-02\-10 21:11:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
de1abae9d1 Merge pull request \fI\%#31105\fP from cachedout/lint_30975
.IP \(bu 2
446b4c2aff Lint \fI\%#30975\fP
.IP \(bu 2
b4fe9aaa11 fixes issue in which s3.role_arn was defaulting to \(aq\(aq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31069\fP: (\fI\%symphorien\fP) Wrong filename in documentation for x509 state (refs: \fI\%#31100\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31100\fP: (\fI\%jfindlay\fP) states.x509: docs: peer.sls \-> peer.conf
@ \fI2016\-02\-10 20:47:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e5499748a Merge pull request \fI\%#31100\fP from jfindlay/x509_sls
.IP \(bu 2
6c303b99c2 states.x509: docs: peer.sls \-> peer.conf
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31103\fP: (\fI\%twangboy\fP) Point to reg.delete_key_recursive
@ \fI2016\-02\-10 20:46:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
f2bede1c00 Merge pull request \fI\%#31103\fP from twangboy/fix_reg_state
.IP \(bu 2
fe1ca906d2 Point to reg.delete_key_recursive
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31093\fP: (\fI\%techhat\fP) Ensure double directories don\(aqt get created
@ \fI2016\-02\-10 18:53:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
94fa76831f Merge pull request \fI\%#31093\fP from techhat/spmfix
.IP \(bu 2
4f4c8877ad Ensure double directories don\(aqt get created
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31056\fP: (\fI\%JensRantil\fP) file.symlink documentation improvement (refs: \fI\%#31095\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31095\fP: (\fI\%jfindlay\fP) modules.file, states.file: explain symbolic links
@ \fI2016\-02\-10 18:53:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
c015ca865c Merge pull request \fI\%#31095\fP from jfindlay/link_doc
.IP \(bu 2
7d9df6b26c modules.file, states.file: explain symbolic links
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31059\fP: (\fI\%mf\-collinhayden\fP) salt\-cloud rename fails in 2015.8.5 (refs: \fI\%#31061\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#30950\fP: (\fI\%tmaulik\fP) Salt\-cloud create_snapshot is not recognizing snapshot_name parameter  in salt 2015.8.5 (refs: \fI\%#31061\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31061\fP: (\fI\%rallytime\fP) Revert \fI\%#30217\fP \- was causing salt\-cloud \-a breakage
@ \fI2016\-02\-10 18:13:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30217\fP: (\fI\%pass\-by\-value\fP) Make sure cloud actions can be called via salt run (refs: \fI\%#31061\fP, \fI\%#30691\fP)
.IP \(bu 2
4d6706b3e7 Merge pull request \fI\%#31061\fP from rallytime/revert\-breakage
.IP \(bu 2
ced2d9f922 Revert \fI\%#30217\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31088\fP: (\fI\%gladiatr72\fP) request for color logging fix backport (refs: \fI\%#31090\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31090\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30542\fP to 2015.8
@ \fI2016\-02\-10 18:06:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30542\fP: (\fI\%gladiatr72\fP) address color log dict lookup exceptions w/ non\-posix log level names (refs: \fI\%#31090\fP)
.IP \(bu 2
482eea9883 Merge pull request \fI\%#31090\fP from rallytime/bp\-30542
.IP \(bu 2
67a713f2f6 Some 3rd\-party modules (e.g. gnupg) define custom log levels that emit at INFO level and above.  This patch sets the color data lookups to default to TextFormat(\(aqreset\(aq) rather than producing a stack trace every time a log message is generated from an affected module.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31085\fP: (\fI\%jacksontj\fP) Correctly remove path we added after loader is completed
@ \fI2016\-02\-10 17:47:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
5dcaa8d387 Merge pull request \fI\%#31085\fP from jacksontj/2015.8
.IP \(bu 2
dd5051c9e6 Correctly pop the path we added after loader is completed.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28142\fP: (\fI\%zmalone\fP) Deprecate or update the copr repo (refs: \fI\%#31037\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31037\fP: (\fI\%vutny\fP) Update RHEL installation guide to reflect latest repo changes
@ \fI2016\-02\-10 17:36:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
27bf83fa59 Merge pull request \fI\%#31037\fP from vutny/correct\-doc\-install\-on\-rhel
.IP \(bu 2
6370ddda9f Update RHEL installation guide
.IP \(bu 2
afdaefbf3d Add \fIsystemctl\fP examples for RHEL 7 to the installation guide
.IP \(bu 2
069a661eb1 Correct ZeroMQ4 repo install guide for RHEL
.IP \(bu 2
d2a9d67b5b Update installation instruction for community repos on RHEL
.IP \(bu 2
bbdf2523c8 Add workaround for RHEL 7 systems mentioned in the issue \fI\%#29094\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31050\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-02\-09 20:13:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
8704750cf9 Merge pull request \fI\%#31050\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
d86e014a39 Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.INDENT 2.0
.IP \(bu 2
1c699a1664 Merge pull request \fI\%#30974\fP from rallytime/bp\-30949
.INDENT 2.0
.IP \(bu 2
ff6542f593 Replace cfdisk with sfdisk
.UNINDENT
.IP \(bu 2
c7f87cc371 Merge pull request \fI\%#30942\fP from rallytime/bp\-30897
.INDENT 2.0
.IP \(bu 2
885e00ba54 Only remove the word linux from distroname when its not part of the name
.UNINDENT
.IP \(bu 2
35b7f62669 Merge pull request \fI\%#30922\fP from jacobhammons/prev\-rel\-notes
.INDENT 2.0
.IP \(bu 2
57c1ec637a Rev latest version to 2015.8.5
.UNINDENT
.IP \(bu 2
2488bb902e Merge pull request \fI\%#30865\fP from abednarik/better_boto_elb_error
.INDENT 2.0
.IP \(bu 2
3561e8c19b Better boto elb error message.
.UNINDENT
.IP \(bu 2
4da04f82c8 Merge pull request \fI\%#30831\fP from jacobhammons/readme\-update
.INDENT 2.0
.IP \(bu 2
01a92f5d98 Updated readme
.UNINDENT
.IP \(bu 2
90c1ea9f6c Merge pull request \fI\%#30829\fP from jacobhammons/release\-2015.5
.INDENT 2.0
.IP \(bu 2
c95bb60148 Version to 2015.8.4
.UNINDENT
.IP \(bu 2
80a36793cb Merge pull request \fI\%#30784\fP from rallytime/bp\-24952
.INDENT 2.0
.IP \(bu 2
a07908bdea Don\(aqt split the string on a single line
.UNINDENT
.IP \(bu 2
e978f5392f Merge pull request \fI\%#30764\fP from terminalmage/issue30560
.INDENT 2.0
.IP \(bu 2
39736afcd7 Work around yum versionlock\(aqs inability to remove holds by package name alone
.UNINDENT
.IP \(bu 2
6f565c0d76 Merge pull request \fI\%#30760\fP from toanju/2015.5
.INDENT 2.0
.IP \(bu 2
dc4256f7df Changed output format of arp_ip_target from list to comma delimited string
.UNINDENT
.IP \(bu 2
1c205b4898 Merge pull request \fI\%#30757\fP from yannis666/fix\-for\-mine\-update\-merge
.INDENT 2.0
.IP \(bu 2
61bb23e256 Fix to mine update to merge configuration
.UNINDENT
.IP \(bu 2
f9fde8f6a7 Merge pull request \fI\%#30749\fP from abednarik/fix_network_system_test
.INDENT 2.0
.IP \(bu 2
1e9e97df59 Fix Netwotk hostname Module in Debian systems.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31053\fP: (\fI\%cachedout\fP) Fix boto test failures
@ \fI2016\-02\-09 20:02:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
f13ffd4608 Merge pull request \fI\%#31053\fP from cachedout/boto_test_fix
.IP \(bu 2
c73b5a4a66 Fix boto_secgroup
.IP \(bu 2
25bcc68357 Fix boto test failures
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30938\fP: (\fI\%lorengordon\fP) Windows: Upgrade overwrites minion config file (refs: \fI\%#31029\fP, \fI\%#31028\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31029\fP: (\fI\%twangboy\fP) Windows defaults to multiprocessing true
@ \fI2016\-02\-09 18:20:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
87f2816ef5 Merge pull request \fI\%#31029\fP from twangboy/win_defaults
.IP \(bu 2
baffbbdb74 Comment multiprocessing line in minion config
.IP \(bu 2
933544b8c8 Set multiprocessing to true in config.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27796\fP: (\fI\%onsmribah\fP) IOError: [Errno 13] Permission denied: \(aq/var/cache/salt/master/.dfn\(aq when using python salt.wheel module (refs: \fI\%#30998\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30998\fP: (\fI\%dmacvicar\fP) add_key/reject_key: do not crash w/Permission denied: \(aq/var/cache/salt/master/.dfn\(aq (\fI\%#27796\fP)
@ \fI2016\-02\-09 17:57:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
0dcdd0a2a7 Merge pull request \fI\%#30998\fP from dmacvicar/dmacvicar\-2015.8\-27796
.IP \(bu 2
9602fe2aeb Do not crash on add_key/reject_key if the previous one set the drop file. (\fI\%#27796\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31041\fP: (\fI\%fredrikaverpil\fP) Reading about win_service in 2015.8.5 docs, but it\(aqs not available in 2015.8.5 (refs: \fI\%#31550\fP, \fI\%#31049\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31049\fP: (\fI\%twangboy\fP) Fix versionadded in win_service.config (refs: \fI\%#31550\fP)
@ \fI2016\-02\-09 17:55:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
e773fc822a Merge pull request \fI\%#31049\fP from twangboy/win_svc_docs
.IP \(bu 2
98005255d1 Fix versionadded in win_service.config
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30987\fP: (\fI\%youngnick\fP) Changed glusterfs.peer() module so state can handle localhost peering attempts.
@ \fI2016\-02\-09 17:51:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3f115724a Merge pull request \fI\%#30987\fP from youngnick/add\-back\-localhost\-peer\-handling
.IP \(bu 2
730b5ef3e2 Update tests to cover new peering return val.
.IP \(bu 2
b2407305e8 Changed glusterfs.peer() module call return val so state can handle localhost peering attempts.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31042\fP: (\fI\%moltob\fP) Allow using Windows path in archive.extracted name attribute
@ \fI2016\-02\-09 17:47:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
8518655bfb Merge pull request \fI\%#31042\fP from moltob/fix\-archive\-winpath
.IP \(bu 2
9dcc617a53 Allow using Windows path in archive.extracted name attribute, including drive letter colon and backslashes.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31012\fP: (\fI\%terminalmage\fP) Fix gitfs/git_pillar/winrepo provider to allow lowercase values
@ \fI2016\-02\-09 17:24:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
1950359580 Merge pull request \fI\%#31012\fP from terminalmage/fix\-gitfs\-provider\-lc
.IP \(bu 2
763581798b Add unit tests to ensure a valid provider
.IP \(bu 2
49ec61d58b Fix gitfs/git_pillar/winrepo provider to allow lowercase values
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30983\fP: (\fI\%JensRantil\fP) salt.modules.aptpkg.upgrade does not necessarily do \fIapt\-get dist\-upgrade\fP (refs: \fI\%#31024\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31024\fP: (\fI\%jfindlay\fP) modules.aptpkg.upgrade: clarify dist\-upgrade usage
@ \fI2016\-02\-09 17:20:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
3d8681b63e Merge pull request \fI\%#31024\fP from jfindlay/dist_upgrade
.IP \(bu 2
3d1be080ad modules.aptpkg.upgrade: clarify dist\-upgrade usage
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30938\fP: (\fI\%lorengordon\fP) Windows: Upgrade overwrites minion config file (refs: \fI\%#31029\fP, \fI\%#31028\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31028\fP: (\fI\%twangboy\fP) Fix config overwrite by windows installer
@ \fI2016\-02\-09 17:20:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
a0454ffb00 Merge pull request \fI\%#31028\fP from twangboy/fix_installer
.IP \(bu 2
8876893b5c Fix remove placeholder files
.IP \(bu 2
788855cc94 Remove placeholder files
.IP \(bu 2
c834a9d5e5 Set overwrite to off
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31014\fP: (\fI\%gtmanfred\fP) [2015.8] pkg breaks for yum pkgs.latest if the packages has an epoch (refs: \fI\%#31131\fP, \fI\%#31015\fP, \fI\%#31031\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31031\fP: (\fI\%terminalmage\fP) More complete fix for \fI\%#31014\fP
@ \fI2016\-02\-09 17:04:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31015\fP: (\fI\%gtmanfred\fP) include possible epoch in version for rpm (refs: \fI\%#31031\fP)
.IP \(bu 2
071b9d4904 Merge pull request \fI\%#31031\fP from terminalmage/issue31014
.IP \(bu 2
6d15a17d6b Fix yumpkg _get_branch_option()
.IP \(bu 2
4b855a85ee Don\(aqt handle epoch specially for dnf
.IP \(bu 2
5244de2fae More efficient way to add the epoch before version number
.IP \(bu 2
e1211ed89f include possible epoch in version for rpm
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30934\fP: (\fI\%marnovdm\fP) contents_pillar no longer works with lists in 2015.8.5 (refs: \fI\%#31026\fP, \fI\%#31177\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31026\fP: (\fI\%terminalmage\fP) Fix regression when contents_pillar/contents_grains is a list.
@ \fI2016\-02\-09 00:03:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
2b8f7a12e7 Merge pull request \fI\%#31026\fP from terminalmage/issue30934
.IP \(bu 2
f43aaf4dff Fix regression when contents_pillar/contents_grains is a list.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30472\fP: (\fI\%sjorge\fP)  KeyError with schedule (refs: \fI\%#30978\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30978\fP: (\fI\%garethgreenaway\fP) fixes to state.py in 2015.8
@ \fI2016\-02\-08 18:49:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
de215bd0cd Merge pull request \fI\%#30978\fP from garethgreenaway/30472_state_functions_no_default_retcode
.IP \(bu 2
e33b5140f6 removing extra spaces.
.IP \(bu 2
f668ccf1f7 removing duplicate code, just set the default in the _set_retcode function
.IP \(bu 2
5f2f0f60c0 The functions in the state module that return a retcode when something goes wrong, eg. a 1 or a 2, do not return a 0 when things go the way they\(aqre supposed to go.  With the recent changes to the scheduler to ensure that the retcode is returned this is problematic and results in exceptions when a state function is run from the schedule.  This simple fix ensures a default retcode of 0 exists, it is then override in the _set_retcode function if there is an issue with the run
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30893\fP: (\fI\%bdrung\fP) Make build reproducible
@ \fI2016\-02\-08 18:44:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
65fbf980cf Merge pull request \fI\%#30893\fP from bdrung/reproducible
.IP \(bu 2
089c869ec3 Make build reproducible
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30945\fP: (\fI\%cachedout\fP) Note that pillar cli args are sent via pub
@ \fI2016\-02\-08 18:43:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b0c7649c7 Merge pull request \fI\%#30945\fP from cachedout/note_pillar_cli
.IP \(bu 2
3ff7d49555 Note that pillar cli args are sent via pub
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31000\fP: (\fI\%rmtmckenzie\fP) Salt\-cloud profile state fails to create LXC minion (refs: \fI\%#31002\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31002\fP: (\fI\%rmtmckenzie\fP) Fix lxc cloud provided minion reporting present
@ \fI2016\-02\-08 18:14:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
3b7b6f2398 Merge pull request \fI\%#31002\fP from rmtmckenzie/cloud\-lxc\-provide\-fix
.IP \(bu 2
9b17fdce5e Fix lxc cloud provided minion reporting present
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31007\fP: (\fI\%justinta\fP) Fixed rabbitmq_vhost test failure.
@ \fI2016\-02\-08 17:48:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
c48122ae9a Merge pull request \fI\%#31007\fP from jtand/rabbitmq_vhost_test_fix
.IP \(bu 2
962e0deda5 Fixed rabbitmq_vhost test failure.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30993\fP: (\fI\%fredrikaverpil\fP) Overstate: \(dqThis documentation has been moved here\(dq (dead end) (refs: \fI\%#31004\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31004\fP: (\fI\%rallytime\fP) Remove overstate docs and a few references.
@ \fI2016\-02\-08 17:08:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
811461e4b4 Merge pull request \fI\%#31004\fP from rallytime/fix\-30993
.IP \(bu 2
33eb6ba125 Remove overstate docs and a few references.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30965\fP: (\fI\%anlutro\fP) Fix rabbitmq_vhost.present result when test=True
@ \fI2016\-02\-08 04:34:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
64125de6c7 Merge pull request \fI\%#30965\fP from alprs/fix\-rabbitmq_vhost_present_test
.IP \(bu 2
2313747958 return changes when test=True
.IP \(bu 2
95c8e74b72 make the code a bit simpler
.IP \(bu 2
aba29a73c4 fix rabbitmq_vhost.present result when test=True
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30955\fP: (\fI\%Ch3LL\fP) docs: add clarification when source is not defined
@ \fI2016\-02\-06 18:29:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
ef02779391 Merge pull request \fI\%#30955\fP from Ch3LL/clarify_file_doc
.IP \(bu 2
97b57ed2b1 docs: add clarification when source is not defined
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30941\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30879\fP to 2015.8
@ \fI2016\-02\-05 21:15:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30879\fP: (\fI\%rhansen\fP) Don\(aqt delete a Docker volume if the volume\(aqs driver differs (refs: \fI\%#30941\fP)
.IP \(bu 2
d9785451c0 Merge pull request \fI\%#30941\fP from rallytime/bp\-30879
.IP \(bu 2
eb6f289fc1 change default for volume_present()\(aqs force parameter to False
.IP \(bu 2
34f3057e04 add \(aqforce\(aq to replace (or not) volumes with driver mismatch
.IP \(bu 2
d6d3b15738 typo fixes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30940\fP: (\fI\%twangboy\fP) Fix Build Process for OSX
@ \fI2016\-02\-05 18:44:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
21a83065aa Merge pull request \fI\%#30940\fP from twangboy/mac_build_3
.IP \(bu 2
3654a0e0c2 Change 2015 to 2016 in license file
.IP \(bu 2
aa7d0602a8 Update instructions in readme.md for shasum
.IP \(bu 2
6f1a8f4146 Added code to add /opt/salt/bin to the path
.IP \(bu 2
1e7468a08c Disable master, syndic, and api in postinstall
.IP \(bu 2
d49b3dcf1b Re\-added start on load and keep alive
.IP \(bu 2
3ff50a2254 Removed keepalive option
.IP \(bu 2
eb5d04bdf1 Remove autostart for api, master, and syndic
.IP \(bu 2
3c0cce34c9 Added minimum requirements for installation
.IP \(bu 2
1dcc23c85b Fix error on kickstart command
.IP \(bu 2
7a163c46d8 Change to new way of starting and stopping services
.IP \(bu 2
23d47722b7 Fix preinstall and postinstall scripts
.IP \(bu 2
7ef723d815 Upgrade to latest pip
.IP \(bu 2
0f09ad517f Updated pip dependencies
.IP \(bu 2
d3d4c1d13f Removed GPL Licensed software from build
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30944\fP: (\fI\%jacobhammons\fP) 2015.8.5 release notes linking and clean up
@ \fI2016\-02\-05 17:40:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
183b500055 Merge pull request \fI\%#30944\fP from jacobhammons/rel\-notes
.IP \(bu 2
fbb7605366 2015.8.5 release notes linking and clean up
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30882\fP: (\fI\%hoonetorg\fP) state lvm.vg_present broken with pv on devicemapper\-dev (centos 7.2) (refs: \fI\%#30905\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26867\fP: (\fI\%joejulian\fP) lvm pv\(aqs can show as not belonging to their vg if symlink is used (refs: \fI\%#30905\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30905\fP: (\fI\%joejulian\fP) Add realpath to lvm.pvdisplay and use it in vg_present
@ \fI2016\-02\-05 17:05:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
91806b03b9 Merge pull request \fI\%#30905\fP from joejulian/2015.8_fix_lvm_pv_mapper
.IP \(bu 2
f96650f3c3 Add realpath to lvm.pvdisplay and use it in vg_present
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30923\fP: (\fI\%youngnick\fP) Starting a glusterfs volume after creation fails with an exception in 2015.8 and after. (refs: \fI\%#30924\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30924\fP: (\fI\%youngnick\fP) Fix small bug with starting volumes after creation.
@ \fI2016\-02\-05 16:58:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
af2832b69d Merge pull request \fI\%#30924\fP from youngnick/glusterfs\-start\-volume\-bug
.IP \(bu 2
be5295cf7b Fix small bug with starting volumes after creation.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30910\fP: (\fI\%cro\fP) fix iDRAC state
@ \fI2016\-02\-05 16:49:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a6666ad25 Merge pull request \fI\%#30910\fP from cro/fx2_idrac
.IP \(bu 2
68af2ab185 Lint.
.IP \(bu 2
c274c7ef6c Lint.
.IP \(bu 2
3e38b762bf Add generic command for executing racadm commands on individual blades in a chassis.
.IP \(bu 2
05979010f5 Finish the idrac state, fix problem with grains not loading sometimes.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30919\fP: (\fI\%garethgreenaway\fP) Fixes to ssh_auth state module
@ \fI2016\-02\-05 16:15:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
101fa12479 Merge pull request \fI\%#30919\fP from garethgreenaway/ssh_auth_cp_get_url_needs_saltenv
.IP \(bu 2
c9ba038553 The call to cp.get_url needs the saltenv, if you\(aqre using environments other than base, it will fail.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30300\fP: (\fI\%AkhterAli\fP) boto_route53 __salt__ not defined. (refs: \fI\%#30867\fP, \fI\%#30920\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30920\fP: (\fI\%jacobhammons\fP) Versioned to 2015.8.5, added known issue \fI\%#30300\fP to release notes
@ \fI2016\-02\-05 01:12:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
6d4fd11dd0 Merge pull request \fI\%#30920\fP from jacobhammons/release\-notes
.IP \(bu 2
93d47f8615 Versioned to 2015.8.5, added known issue \fI\%#30300\fP to release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30894\fP: (\fI\%terminalmage\fP) git module/state: Handle identity files more gracefully
@ \fI2016\-02\-04 23:55:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
3d3321ab92 Merge pull request \fI\%#30894\fP from terminalmage/issue30858
.IP \(bu 2
08741eb969 Update versionadded/versionchanged
.IP \(bu 2
8909d430e1 salt.states.git.latest(): Prevent tracebacks when git ssh auth fails
.IP \(bu 2
c961cf1c7d git: only use passphrase\-protected key if invoked using salt\-call
.IP \(bu 2
0b286f1bc3 Add global ssh_config path to git ssh wrapper
.IP \(bu 2
f813cce4ad Add salt.modules.ssh.key_is_encrypted()
.IP \(bu 2
1ae7c53e17 Add salt.utils.files.process_read_exception()
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30694\fP: (\fI\%pankajghadge\fP) Tomcat war deployment version issue in new SALT version (refs: \fI\%#30750\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30750\fP: (\fI\%jfindlay\fP) extract whole war version
@ \fI2016\-02\-04 21:41:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
2415b3e62e Merge pull request \fI\%#30750\fP from jfindlay/war_version
.IP \(bu 2
4b01c28ff9 modules,states.tomcat: allow specifying war version
.IP \(bu 2
6deecdca0f states.tomcat: _extract_war_version parses path
.IP \(bu 2
8dd3b6dfe9 modules.war._extract_war_version: allow non\-semver
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30817\fP: (\fI\%bogdanr\fP) If the private_key filespecified in the provider is missing then the driver will be disabled (refs: \fI\%#30884\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30884\fP: (\fI\%rallytime\fP) Move checks for private_key file existence and permissions to create function
@ \fI2016\-02\-04 21:03:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a6456eaa6 Merge pull request \fI\%#30884\fP from rallytime/fix\-30817
.IP \(bu 2
086ddae476 We need to check for a key_filename before looking for the path
.IP \(bu 2
e79321b418 Move checks for private_key file existence and permissions to create function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30888\fP: (\fI\%ticosax\fP) Backport \fI\%#30797\fP to 2015.8
@ \fI2016\-02\-04 21:02:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30797\fP: (\fI\%rhansen\fP) don\(aqt delete existing Docker volume if driver unspecified (refs: \fI\%#30888\fP)
.IP \(bu 2
4ae2d829f0 Merge pull request \fI\%#30888\fP from ticosax/backport\-30797
.IP \(bu 2
413c47a45f don\(aqt delete existing Docker volume if driver unspecified
.IP \(bu 2
68b51be869 add additional states.dockerng.volume_present() unit tests
.IP \(bu 2
849b94ed73 document the behavior if the driver is unspecified
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30895\fP: (\fI\%bdrung\fP) Fix various typos
@ \fI2016\-02\-04 20:55:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
4372851ad9 Merge pull request \fI\%#30895\fP from bdrung/2015.8
.IP \(bu 2
708f2ff8ea Fix typo of response
.IP \(bu 2
72c4eab6d7 Fix typo of propagate
.IP \(bu 2
4912e365cb Fix typo of directories
.IP \(bu 2
74c8aba03e Fix typo of exception
.IP \(bu 2
4692d84b07 Fix typos of improvement
.IP \(bu 2
213fc2d858 Fix typo of occurring
.IP \(bu 2
fe6124003b Fix typo of nonexistent
.IP \(bu 2
56ce7479b1 Fix typo of caught
.IP \(bu 2
821e690e65 Fix typo of development
.IP \(bu 2
b51279e086 Fix typo of override
.IP \(bu 2
4f2f04ea7d Fix typo of relevant
.IP \(bu 2
fe8be562c5 Fix typo of existence
.IP \(bu 2
4a2f4de1a8 Fix typo of across
.IP \(bu 2
9ae50c993e Fix typo of Length
.IP \(bu 2
20e79981e1 Fix typo of preferably
.IP \(bu 2
f8d9f608dd Fix typo of address
.IP \(bu 2
a7f12a13f0 Fix typo of keyword
.IP \(bu 2
bf92c3663b Fix typo of formatting
.IP \(bu 2
ca4450d881 Fix typo of won\(aqt
.IP \(bu 2
cd72b12161 Fix typo of that\(aqs
.IP \(bu 2
6db9724ec7 Fix typo of doesn\(aqt
.IP \(bu 2
58d46a7e98 Fix typo of certificate
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30887\fP: (\fI\%anlutro\fP) salt\-ssh fails on import msgpack \- 2015.8 (refs: \fI\%#30889\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30889\fP: (\fI\%anlutro\fP) Make msgpack an optional dependency in salt.utils.cache
@ \fI2016\-02\-04 20:53:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
cdca33021a Merge pull request \fI\%#30889\fP from alprs/fix\-cache_msgpack_optional
.IP \(bu 2
ab7aae3221 make msgpack an optional dependency in salt.utils.cache
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#6602\fP: (\fI\%corywright\fP) Add ability to match on nodegroups to the compound matcher (refs: \fI\%#30896\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#25292\fP: (\fI\%lichtamberg\fP) Nodegroup matching in pillars via salt\-SSH? (refs: \fI\%#30896\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30896\fP: (\fI\%vutny\fP) Update nodegroups parameter examples in master config example and docs
@ \fI2016\-02\-04 20:52:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
0dff45b4ac Merge pull request \fI\%#30896\fP from vutny/nodegroups\-in\-master\-config\-example
.IP \(bu 2
936c1ff6c8 Add explanation about \fIN@\fP classifier. Inspired by \fI\%#25292\fP
.IP \(bu 2
8bc2426816 Update example in master config documentation reference
.IP \(bu 2
ca8c0bdc3f Update nodegroups section example in master config according to docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30792\fP: (\fI\%bender\-the\-greatest\fP) Specifying version in pkgs list returns failure even though it succeeds (on Ubuntu) (refs: \fI\%#30898\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30898\fP: (\fI\%abednarik\fP) Fix pkg install with version.
@ \fI2016\-02\-04 20:52:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
33a400e943 Merge pull request \fI\%#30898\fP from abednarik/fix_pkg_version_debian_family
.IP \(bu 2
b15cdfd799 Fix pkg install with version.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30843\fP: (\fI\%HeathNaylor\fP) SALT.STATES.BOTO_ELB register_instances error (refs: \fI\%#30867\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#30808\fP: (\fI\%Reiner030\fP) Nice2have: better boto error handling when AWS service isn\(aqt available (here: some authentication problems) (refs: \fI\%#30867\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#30300\fP: (\fI\%AkhterAli\fP) boto_route53 __salt__ not defined. (refs: \fI\%#30867\fP, \fI\%#30920\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30867\fP: (\fI\%rallytime\fP) Pass in \(aqpack\(aq variable to utils.boto.assign_funcs function from ALL boto modules
@ \fI2016\-02\-04 18:37:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30279\fP: (\fI\%cachedout\fP) Allow modules to be packed into boto utils (refs: \fI\%#30867\fP)
.IP \(bu 2
89bac9076a Merge pull request \fI\%#30867\fP from rallytime/boto\-utils\-fix
.IP \(bu 2
6ad7642f6d Lint
.IP \(bu 2
58778dfc88 Fix failing boto_vpc module unit tests
.IP \(bu 2
adb85892de Fix failing state module tests
.IP \(bu 2
b5ec0991b0 Pylint fix
.IP \(bu 2
c26c01568f Don\(aqt use pack=pack. Just pass in pack=__salt__ always.
.IP \(bu 2
6146209c53 Pass in \(aqpack\(aq variable to utils.boto.assign_funcs function from ALL boto modules.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30798\fP: (\fI\%tbaker57\fP) salt/utils/aws.py has Python 2.7 dependency (refs: \fI\%#30849\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30849\fP: (\fI\%jfindlay\fP) utils.aws: use time lib to conver to epoch seconds
@ \fI2016\-02\-03 22:47:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
276cf626b0 Merge pull request \fI\%#30849\fP from jfindlay/aws_seconds
.IP \(bu 2
17ae74dab1 utils.aws: use time lib to conver to epoch seconds
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30869\fP: (\fI\%Ch3LL\fP) git pillar: do not see all pillar data with multiple repos in 2015.8.4 (refs: \fI\%#30874\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30874\fP: (\fI\%terminalmage\fP) Fix regression in git_pillar when multiple remotes are configured
@ \fI2016\-02\-03 22:24:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
4cbc8a8250 Merge pull request \fI\%#30874\fP from terminalmage/issue30869
.IP \(bu 2
9cf0c8126d Fix regression in git_pillar when multiple remotes are configured
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30814\fP: (\fI\%gpenin\fP) [2015.8.*][Ubuntu 12.04 LTS][dpkg.py] Invalid \(dq${binary:Package}\(dq field in dpkg\-query (refs: \fI\%#30850\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30850\fP: (\fI\%jfindlay\fP) modules.dpkg._get_pkg_info: allow for ubuntu 12.04
@ \fI2016\-02\-03 16:33:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
8410842aea Merge pull request \fI\%#30850\fP from jfindlay/dpkg_var
.IP \(bu 2
d53a88762e modules.dpkg._get_pkg_info: handle older ubuntu
.IP \(bu 2
d3c6732539 modules.dpkg._get_pkg_info: use pythonic initializers
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30852\fP: (\fI\%replicant0wnz\fP) Added more descriptive error message
@ \fI2016\-02\-03 16:30:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
9a3ec9d028 Merge pull request \fI\%#30852\fP from replicant0wnz/error\-message\-libgit
.IP \(bu 2
c3649023b5 Added more descriptive error message
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30847\fP: (\fI\%terminalmage\fP) Backport \fI\%#30844\fP to 2015.8 branch
@ \fI2016\-02\-03 16:26:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30844\fP: (\fI\%terminalmage\fP) Perform initial gitfs/git_pillar fetch when init\(aqing remotes on masterless minion (refs: \fI\%#30847\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30703\fP: (\fI\%kraney\fP) Fix for gitfs ext_pillar on standalone minion (refs: \fI\%#30844\fP)
.IP \(bu 2
0338f445d9 Merge pull request \fI\%#30847\fP from terminalmage/bp\-30844
.IP \(bu 2
58c4c01743 Add __role to master opts for gitfs integration tests
.IP \(bu 2
17dfec2dd4 Only perform initial fetch when running on a minion
.IP \(bu 2
53c4b4aaa4 gitfs: add initial fetch to pygit2 and dulwich
.IP \(bu 2
78f92e9ab2 Fix for gitfs ext_pillar on standalone minion
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30860\fP: (\fI\%vutny\fP) Correct installation documentation for RHEL\-based distributions
@ \fI2016\-02\-03 16:13:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
e51182495c Merge pull request \fI\%#30860\fP from vutny/correct\-doc\-install\-on\-rhel
.IP \(bu 2
6648fd4c62 Correct links to Fedora COPR repositories
.IP \(bu 2
083037fccc Remove duplicate post\-installation tasks section
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30841\fP: (\fI\%jacobhammons\fP) Release notes for 2015.8.5
@ \fI2016\-02\-03 00:04:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
f1cf027308 Merge pull request \fI\%#30841\fP from jacobhammons/release\-notes
.IP \(bu 2
6d0562ef86 Release notes for 2015.8.5
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30820\fP: (\fI\%Supermathie\fP) State runs involving watch_in or extending break on 2015.8.4 (refs: \fI\%#30837\fP, \fI\%#30835\fP, \fI\%#30833\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30835\fP: (\fI\%terminalmage\fP) Integration test for \fI\%#30820\fP
@ \fI2016\-02\-02 23:51:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
f8ac6002d3 Merge pull request \fI\%#30835\fP from terminalmage/issue30820
.IP \(bu 2
ef14956db0 Integration test for \fI\%#30820\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30820\fP: (\fI\%Supermathie\fP) State runs involving watch_in or extending break on 2015.8.4 (refs: \fI\%#30837\fP, \fI\%#30835\fP, \fI\%#30833\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30837\fP: (\fI\%jacobhammons\fP) Added known issue \fI\%#30820\fP to release notes
@ \fI2016\-02\-02 22:33:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
e0901854ce Merge pull request \fI\%#30837\fP from jacobhammons/release\-notes
.IP \(bu 2
29e12a7fef Added known issue \fI\%#30820\fP to release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28790\fP: (\fI\%jfindlay\fP) add grains (and others?) to salt modindex (refs: \fI\%#30832\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30832\fP: (\fI\%rallytime\fP) Add grains modules to salt modindex
@ \fI2016\-02\-02 21:47:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
b512c7757a Merge pull request \fI\%#30832\fP from rallytime/fix\-28790
.IP \(bu 2
ca044dd201 Add grains modules to salt modindex
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28971\fP: (\fI\%belt\-ascendlearning\fP) if the user exists, but has no permissions, rabbitmq_user.list_user_permissions() blows (refs: \fI\%#30822\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30822\fP: (\fI\%rallytime\fP) Make sure setting list_user_permissions to [\(aq\(aq, \(aq\(aq, \(aq\(aq] doesn\(aqt stacktrace
@ \fI2016\-02\-02 21:42:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
75db37a97d Merge pull request \fI\%#30822\fP from rallytime/rabbitmq\-user\-state\-fixes
.IP \(bu 2
272cc653ca Make sure setting list_user_permissions to [\(aq\(aq, \(aq\(aq, \(aq\(aq] doesn\(aqt stacktrace
.IP \(bu 2
a7afa7a368 Don\(aqt return a set() when checking for new tags in rabbitmq_user state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30820\fP: (\fI\%Supermathie\fP) State runs involving watch_in or extending break on 2015.8.4 (refs: \fI\%#30837\fP, \fI\%#30835\fP, \fI\%#30833\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30833\fP: (\fI\%terminalmage\fP) Fix regression in scanning for state with \(aqname\(aq param
@ \fI2016\-02\-02 21:25:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
557766f20b Merge pull request \fI\%#30833\fP from terminalmage/issue30820
.IP \(bu 2
be3b8e2be6 Fix regression in scanning for state with \(aqname\(aq param
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30722\fP: (\fI\%yannis666\fP) mine config is not merged from minion config and pillar (refs: \fI\%#30757\fP, \fI\%#30823\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30823\fP: (\fI\%yannis666\fP) Fix for mine to merge configuration on update.
@ \fI2016\-02\-02 20:21:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec4e2bb9bb Merge pull request \fI\%#30823\fP from yannis666/fix\-for\-mine\-update\-merge2
.IP \(bu 2
99c7c12aba Fix for mine to merge configuration on update. This fix was previously applied to 2015.5. It fixes \fI\%#30722\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30827\fP: (\fI\%jacobhammons\fP) Version to 2015.8.4, added CVE 2016\-1866 to release notes
@ \fI2016\-02\-02 20:03:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
d24b9f1ea1 Merge pull request \fI\%#30827\fP from jacobhammons/release\-2015.8
.IP \(bu 2
dfc1f7a57d Version to 2015.8.4, added CVE 2016\-1866 to release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30809\fP: (\fI\%anlutro\fP) Master configuration \(dqpillar_merge_lists\(dq has no effect (refs: \fI\%#30813\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29601\fP: (\fI\%seanjnkns\fP) pillars not merging properly with 2015.8.3 (refs: \fI\%#30062\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30813\fP: (\fI\%anlutro\fP) Properly set the default value for pillar_merge_lists
@ \fI2016\-02\-02 19:53:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30458\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30062\fP to 2015.8 (refs: \fI\%#30813\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30062\fP: (\fI\%seanjnkns\fP) Remove recurse_list from pillar_source_merging_strategy and add pilla… (refs: \fI\%#30813\fP, \fI\%#30458\fP)
.IP \(bu 2
f83845d7c3 Merge pull request \fI\%#30813\fP from alprs/fix\-pillar_merge_list_default
.IP \(bu 2
ec34cabee8 Properly set the default value for pillar_merge_lists
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30826\fP: (\fI\%cachedout\fP) Fix 30682
@ \fI2016\-02\-02 19:40:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
a3feba4a26 Merge pull request \fI\%#30826\fP from cachedout/fix_30682
.IP \(bu 2
3b246db0b0 Fix stupid test
.IP \(bu 2
12dc677628 Changed list conversion to use correct method and return whole set
.IP \(bu 2
97eb4b8bf7 Pop values from new_tags set before loading into dict value
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30818\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30790\fP to 2015.8
@ \fI2016\-02\-02 18:57:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30790\fP: (\fI\%xmj\fP) salt/modules/sysrc.py: Fix documentation for set_ (refs: \fI\%#30818\fP)
.IP \(bu 2
b25b845d05 Merge pull request \fI\%#30818\fP from rallytime/bp\-30790
.IP \(bu 2
c7c66afd0c salt/modules/sysrc.py: Fix documentation for set_
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30604\fP: (\fI\%vutny\fP) Reactor overwrites \fIuser\fP argument when calling runner or wheel module (refs: \fI\%#30815\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30815\fP: (\fI\%vutny\fP) Pick right user argument for updating reactor function\(aqs low data
@ \fI2016\-02\-02 16:50:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
3cb7a9ee54 Merge pull request \fI\%#30815\fP from vutny/reactor\-low\-data\-fix
.IP \(bu 2
4d4d67f9ac Pick right user argument for updating reactor function\(aqs low data
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30676\fP: (\fI\%bwillcox\fP) testsystemd.sh tries to use \(aqwhich\(aq that does not exist in centos 7 lxc rootfs (refs: \fI\%#30747\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30747\fP: (\fI\%jfindlay\fP) modules.lxc.running_systemd: use \fIcommand \-v\fP not \fIwhich\fP
@ \fI2016\-02\-02 14:54:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
36752906c4 Merge pull request \fI\%#30747\fP from jfindlay/lxc_which
.IP \(bu 2
f8f867570f modules.lxc.running_systemd: use \fIcommand \-v\fP not \fIwhich\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30800\fP: (\fI\%twangboy\fP) Ability to handle special case installations
@ \fI2016\-02\-02 14:25:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
8abb5b30ad Merge pull request \fI\%#30800\fP from twangboy/chrome
.IP \(bu 2
fe0747c14e Fix another typo
.IP \(bu 2
2815efc522 Fixes spelling
.IP \(bu 2
6027e1ec53 Updates documentation to reflect new features
.IP \(bu 2
1444ab1a48 Adds return success/failure for reg.broadcast_change
.IP \(bu 2
f2a36904d2 Fixes problem with missing key in old
.IP \(bu 2
581a4df523 Added logic for dealing with latest in remove
.IP \(bu 2
c4357a6d80 Adds more logic for detecting latest
.IP \(bu 2
40a66a2501 Logic for handling version: latest
.IP \(bu 2
b7dadd3b9b Fixes message formatting
.IP \(bu 2
a305c8ceae Added more descriptive failure message
.IP \(bu 2
fe49dcb57c Added broadcast change to force registry update
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30794\fP: (\fI\%rallytime\fP) A spelling fix and some spacing fixes for the boto_ec2 module docs
@ \fI2016\-02\-01 21:45:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
7b44c0844d Merge pull request \fI\%#30794\fP from rallytime/boto_ec2\-mod\-doc\-fix
.IP \(bu 2
5188bc4b96 A spelling fix and some spacing fixes for the boto_ec2 module docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23789\fP: (\fI\%hoonetorg\fP) log output of salt orchestrate run changed between 2014.7.5 and 2015.5.0 significantly \- hard to debug (refs: \fI\%#30756\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30756\fP: (\fI\%basepi\fP) [2015.8] Fix two error conditions in the highstate outputter
@ \fI2016\-02\-01 21:39:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f87ad0387 Merge pull request \fI\%#30756\fP from basepi/highstate.outputter.23789
.IP \(bu 2
16ad24d42c Import the logger
.IP \(bu 2
1b5c6a240c Handle non\-string types in comment
.IP \(bu 2
11e34d047b Ensure rdurations are all floats for the highstate outputter
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30788\fP: (\fI\%rallytime\fP) Fix incorrect doc example for dellchassis blade_idrac state
@ \fI2016\-02\-01 21:20:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
46adb2d1af Merge pull request \fI\%#30788\fP from rallytime/fix\-dellchassis\-doc\-example
.IP \(bu 2
bfc16d9f7a Fix incorrect doc example for dellchassis blade_idrac state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29161\fP: (\fI\%jefferyharrell\fP) saltmod.state\(aqs ret argument seems to do nothing (refs: \fI\%#30791\fP, \fI\%#29207\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30791\fP: (\fI\%Ch3LL\fP) do not shadow ret function argument for salt.function
@ \fI2016\-02\-01 20:07:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29207\fP: (\fI\%jfindlay\fP) do not shadow ret function argument (refs: \fI\%#30791\fP)
.IP \(bu 2
333041aeb1 Merge pull request \fI\%#30791\fP from Ch3LL/2015.8
.IP \(bu 2
d54f220c0a do not shadow ret function argument for salt.function
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30706\fP: (\fI\%carsonoid\fP) minion traceback when Log4mongo installed but not configured (refs: \fI\%#30726\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30726\fP: (\fI\%sjmh\fP) Fix improper use of yield in generator
@ \fI2016\-02\-01 18:13:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce3be26e8f Merge pull request \fI\%#30726\fP from sjmh/fix/log4mongo
.IP \(bu 2
d501f1cc03 Fix improper use of yield in generator
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30752\fP: (\fI\%terminalmage\fP) Backport systemd and yum/dnf optimizations from develop into 2015.8
@ \fI2016\-02\-01 18:11:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
a49b75e065 Merge pull request \fI\%#30752\fP from terminalmage/zh459
.IP \(bu 2
8a836c88f4 Update systemd tests
.IP \(bu 2
54ddb92474 Backport yum/dnf optimizations from develop into 2015.8
.IP \(bu 2
1ec13699b6 Backport systemd optimizations from develop into 2015.8
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30759\fP: (\fI\%thusoy\fP) Allow managing empty files
@ \fI2016\-01\-31 19:06:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea15628446 Merge pull request \fI\%#30759\fP from thusoy/empty\-files
.IP \(bu 2
c6244b46ac Allow managing empty files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30758\fP: (\fI\%thusoy\fP) Support mounting labelled volumes with multiple drives
@ \fI2016\-01\-31 19:04:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
120d8344e4 Merge pull request \fI\%#30758\fP from thusoy/multi\-device\-mount
.IP \(bu 2
9a6dc4898f Support mounting labelled volumes with multiple drives
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30686\fP: (\fI\%cachedout\fP) Master\-side pillar caching
@ \fI2016\-01\-31 18:52:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
9e8af2f994 Merge pull request \fI\%#30686\fP from cachedout/pillar_cache_2015_8
.IP \(bu 2
02d8ff626a Pillar cache for master
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30662\fP: (\fI\%JoaquinVeira\fP) UnicodeDecodeError on 2015.8 (refs: \fI\%#30675\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30675\fP: (\fI\%jfindlay\fP) handle non\-ascii minion IDs
@ \fI2016\-01\-29 23:12:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
4008e1719a Merge pull request \fI\%#30675\fP from jfindlay/decode_id
.IP \(bu 2
8f6737b6c4 output.key: decode minion ids to unicode
.IP \(bu 2
7a16f1c941 config: decode id to unicode
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29602\fP: (\fI\%multani\fP) cloud.action start raises \(dqgot an unexpected keyword argument \(aqkwargs\(aq\(dq (refs: \fI\%#30691\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30691\fP: (\fI\%rallytime\fP) Make sure we use the \(dqinstance\(dq kwarg in cloud.action.
@ \fI2016\-01\-29 23:11:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30217\fP: (\fI\%pass\-by\-value\fP) Make sure cloud actions can be called via salt run (refs: \fI\%#31061\fP, \fI\%#30691\fP)
.IP \(bu 2
5ca75fbdc9 Merge pull request \fI\%#30691\fP from rallytime/cloud\-action\-instance
.IP \(bu 2
0873a41601 Make note of empty dict return in docstring
.IP \(bu 2
64a73502ed Make sure we just the \(dqinstance\(dq kwarg in cloud.action.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30713\fP: (\fI\%rallytime\fP) Fix\-up autodoc proxy modules for consistency
@ \fI2016\-01\-29 23:10:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
7c632d61d3 Merge pull request \fI\%#30713\fP from rallytime/proxy\-module\-docs
.IP \(bu 2
86c3f2016e Fix\-up autodoc proxy modules for consistency
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30654\fP: (\fI\%Horgix\fP) Misleading locale(mod) module behavior (refs: \fI\%#30741\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30741\fP: (\fI\%jfindlay\fP) states.locale.__virtual__: return exec mod load err
@ \fI2016\-01\-29 23:00:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f5f41cc07 Merge pull request \fI\%#30741\fP from jfindlay/locale_state
.IP \(bu 2
a3a2a44735 states.locale.__virtual__: return exec mod load err
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30751\fP: (\fI\%basepi\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-01\-29 22:43:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
716c2bb7c8 Merge pull request \fI\%#30751\fP from basepi/merge\-forward\-2015.8
.IP \(bu 2
84eeab7720 Merge remote\-tracking branch \(aqupstream/2015.5\(aq into merge\-forward\-2015.8
.IP \(bu 2
076268089a Merge pull request \fI\%#30699\fP from abednarik/save_load_retry_time
.INDENT 2.0
.IP \(bu 2
186872cf49 Add Retry to save_load.
.UNINDENT
.IP \(bu 2
8d79d1b9c7 Merge pull request \fI\%#30659\fP from sjmh/fix\-scsi
.INDENT 2.0
.IP \(bu 2
3544dd995e Fix lsscsi issues for certain platforms
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30720\fP: (\fI\%clinta\fP) x509.pem_managed does not return changes dict
@ \fI2016\-01\-29 17:07:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
1f0d0f591e Merge pull request \fI\%#30720\fP from clinta/fix\-pem\-managed\-changes
.IP \(bu 2
5c28efa9d3 return changes on test as well
.IP \(bu 2
e611f0269c fix typos and no changes returned for pem_managed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30687\fP: (\fI\%clarkperkins\fP) Setting \(aqdel_root_vol_on_destroy\(aq changes the root volume type to \(aqstandard\(aq
@ \fI2016\-01\-28 00:02:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30677\fP: (\fI\%clarkperkins\fP) Fix EC2 volume creation logic (refs: \fI\%#30687\fP)
.IP \(bu 2
36db0f99ed Merge pull request \fI\%#30687\fP from clarkperkins/bugfix/del\-root\-vol\-loses\-type
.IP \(bu 2
a71e181c18 Don\(aqt set  on a volume when creating from a snapshot
.IP \(bu 2
8cef43c68d When setting del_root_vol_on_destroy, preserve the existing volumeType on the AMI
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28257\fP: (\fI\%peterzalewski\fP) git_pillar remote with multiple branches yields conflicting cachedirs or checkout conflict (refs: \fI\%#30673\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30673\fP: (\fI\%terminalmage\fP) Properly derive the git_pillar cachedir from the id instead of the URL
@ \fI2016\-01\-27 23:52:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
690b8d26b9 Merge pull request \fI\%#30673\fP from terminalmage/issue28257
.IP \(bu 2
8b5933fab4 Properly derive the git_pillar cachedir from the id instead of the URL
.IP \(bu 2
62654ade1d Add additional reason for pillar env being found
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30666\fP: (\fI\%cachedout\fP) Fix grains cache
@ \fI2016\-01\-27 22:23:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
9f0e97693c Merge pull request \fI\%#30666\fP from cachedout/grains_cache_fix
.IP \(bu 2
52716694f5 Fix grains cache
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30623\fP: (\fI\%twangboy\fP) Added service.config function
@ \fI2016\-01\-27 21:08:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
8b17c77d72 Merge pull request \fI\%#30623\fP from twangboy/add_config
.IP \(bu 2
c70e182cdf Fixed indenting... got messed up somehow...
.IP \(bu 2
246f75f2dd Renamed variables, updated docs, added tag
.IP \(bu 2
a4534ee94c Fixed documentation
.IP \(bu 2
54b50236a6 Fixed another error
.IP \(bu 2
76a0cf33e5 Fixed syntax error
.IP \(bu 2
3937380b79 Added service.config function
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30678\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30668\fP to 2015.8
@ \fI2016\-01\-27 20:39:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30668\fP: (\fI\%multani\fP) Fix salt.modules.mount documentation (refs: \fI\%#30678\fP)
.IP \(bu 2
6af1927bd3 Merge pull request \fI\%#30678\fP from rallytime/bp\-30668
.IP \(bu 2
7c7076e6af Fix salt.modules.mount documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30677\fP: (\fI\%clarkperkins\fP) Fix EC2 volume creation logic (refs: \fI\%#30687\fP)
@ \fI2016\-01\-27 18:09:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c71b29f25 Merge pull request \fI\%#30677\fP from clarkperkins/bugfix/ec2\-volume\-logic
.IP \(bu 2
bfec052e7d Added some extra documentation
.IP \(bu 2
ed2eee8e39 Allow volume params to be set even when specifying a snapshot
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18980\fP: (\fI\%lrhazi\fP) salt\-cloud: ExtraData: unpack(b) received extra data. (refs: \fI\%#30671\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30680\fP: (\fI\%cro\fP) Merge forward from 2015.5, primarily for \fI\%#30671\fP
@ \fI2016\-01\-27 17:56:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30671\fP: (\fI\%techhat\fP) Add file locking to cloud index (refs: \fI\%#30680\fP)
.IP \(bu 2
36142390d4 Merge pull request \fI\%#30680\fP from cro/mf20155\-20158\-20160127
.IP \(bu 2
f8ae3a20ff Merge remote\-tracking branch \(aqupstream/2015.5\(aq into mf20155\-20158\-20160127 Mergeforward from 2015.5.
.IP \(bu 2
516919525a Merge pull request \fI\%#30671\fP from techhat/lockcloud
.INDENT 2.0
.IP \(bu 2
4719f8d4ea Whitespace
.IP \(bu 2
8e7eca23e4 Add file locking to cloud index
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30663\fP: (\fI\%isbm\fP) Zypper: latest version bugfix and epoch support feature
@ \fI2016\-01\-27 17:10:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
f6feddecb4 Merge pull request \fI\%#30663\fP from isbm/isbm\-zypper\-latest\-versionfail
.IP \(bu 2
4336487765 Add support for epoch in Zypper
.IP \(bu 2
12d515fa0c Fix package status filtering on latest version
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30652\fP: (\fI\%mew1033\fP) Fix sh beacon
@ \fI2016\-01\-27 17:00:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d8ddeb525 Merge pull request \fI\%#30652\fP from mew1033/fix\-sh\-beacon
.IP \(bu 2
256d037e0f Fix sh beacon
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29678\fP: (\fI\%dschaller\fP) NPM Install Forces Silent (refs: \fI\%#29650\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30657\fP: (\fI\%jfindlay\fP) [2015.8] Backport \fI\%#30378\fP and \fI\%#29650\fP
@ \fI2016\-01\-27 00:34:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30378\fP: (\fI\%dschaller\fP) Adding silent flag to npm.bootstrap (refs: \fI\%#30657\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29650\fP: (\fI\%dschaller\fP) Adding ability to disable npm install silent flag (refs: \fI\%#30657\fP)
.IP \(bu 2
1fa1963895 Merge pull request \fI\%#30657\fP from jfindlay/backport_quiet
.IP \(bu 2
ca4adbf382 Adding ability to disable npm install silent flag
.IP \(bu 2
afe149eb6d Adding ability to disable npm install silent flag
.IP \(bu 2
c1101b5f0b Adding ability to disable npm install silent flag
.IP \(bu 2
d29ad8bbf6 Adding ability to disable npm install silent flag
.IP \(bu 2
7a21dbf0d9 Adding silent flag to npm.bootstrap
.IP \(bu 2
354c0bdf26 Adding silent flag to npm.bootstrap
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30656\fP: (\fI\%rallytime\fP) [2015.8] Merge 2015.5 into 2015.8
@ \fI2016\-01\-27 00:33:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
3621651bf8 Merge pull request \fI\%#30656\fP from rallytime/merge\-forward\-2015.8
.IP \(bu 2
76ab6981a5 Merge branch \(aq2015.5\(aq into 2015.8
.IP \(bu 2
643c9c9616 Merge pull request \fI\%#30586\fP from abednarik/fix_comment_line_perms
.IP \(bu 2
8b395a42cb Fix comment_line permissions.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30644\fP: (\fI\%tbaker57\fP) Another go at fixing 30573
@ \fI2016\-01\-26 20:18:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
30e03a8b0c Merge pull request \fI\%#30644\fP from tbaker57/another_go_at_30573
.IP \(bu 2
267b8827fd Another go at fixing 30573
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30611\fP: (\fI\%isbm\fP) Bugfix: Zypper \fIpkg.latest\fP crash fix
@ \fI2016\-01\-26 16:35:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
7d307e2a04 Merge pull request \fI\%#30611\fP from isbm/isbm\-zypper\-latest
.IP \(bu 2
a7141be651 Put \(aqkwargs\(aq on its own line according to the common pattern
.IP \(bu 2
ee9b3f859b Bugfix: do not treat SLS id as a package name if an empty \(aqpkgs\(aq list specified.
.IP \(bu 2
d3cfd8ed41 Cleanup formatting
.IP \(bu 2
1bdbaac658 Add error handling
.IP \(bu 2
2ec5cec8a4 Add a new line before the last return
.IP \(bu 2
424383b8c4 Remove unnecessary complexity and string increment
.IP \(bu 2
48e8d90343 Avoid backslashes where they are not needed
.IP \(bu 2
6df5d500f0 Use regexp type for the string.
.IP \(bu 2
c2ca141956 Get version as an explicit parameter
.IP \(bu 2
9e944db706 Check the version of the package, instead of the package name
.IP \(bu 2
59ea758efb Fix formatting
.IP \(bu 2
514f6349d4 Bugfix: crash on \(dqkey not found\(dq error
.IP \(bu 2
ea75f55a1a Fix PEP8: line continuation
.IP \(bu 2
ece35ebc26 Replace old fashion string memcopy with the list
.IP \(bu 2
716445e588 Fix PEP8: line continuation
.IP \(bu 2
0f11079ff9 Fix PEP8 for the operator
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#7811\fP: (\fI\%kiall\fP) RabbitMQ Cluster/Plugins/Policy etc states do not track changes, preventing \(dqwatch\(dq from working (refs: \fI\%#30631\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30631\fP: (\fI\%rallytime\fP) Refactor rabbitmq_cluster states to use test=true functionality correctly
@ \fI2016\-01\-26 16:23:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
5bc11d7539 Merge pull request \fI\%#30631\fP from rallytime/fix\-7811
.IP \(bu 2
bf9ffded6d Refactor rabbitmq_cluster states to use test=true functionality correctly
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25658\fP: (\fI\%tsaridas\fP) rabbitmq_policy.present state (refs: \fI\%#30628\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30628\fP: (\fI\%rallytime\fP) Refactor rabbitmq_policy states to use test=true functionality correctly
@ \fI2016\-01\-26 00:21:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
ef6c4e8377 Merge pull request \fI\%#30628\fP from rallytime/fix\-25658
.IP \(bu 2
1e8e86007c Refactor rabbitmq_policy states to use test=true functionality correctly
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30624\fP: (\fI\%cro\fP) Remove bad symlinks from osx pkg dir
@ \fI2016\-01\-26 00:02:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
80d0e428aa Merge pull request \fI\%#30624\fP from cro/remove_bad_symlinks
.IP \(bu 2
f5fd38624e Remove bad symlinks in osx pkg dirs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30621\fP: (\fI\%zer0def\fP) Current latest (2015.8.3) list of builtin states docu doesn\(aqt list \(aqglance\(aq (refs: \fI\%#30622\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30622\fP: (\fI\%rallytime\fP) Add glance state to list of state modules
@ \fI2016\-01\-25 23:55:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
330ea9a292 Merge pull request \fI\%#30622\fP from rallytime/fix\-30621
.IP \(bu 2
57b7e6cc93 Add glance state to list of state modules
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19288\fP: (\fI\%oba11\fP) AssociatePublicIpAddress doesn\(aqt work with salt\-cloud 2014.7.0 (refs: \fI\%#20972\fP, \fI\%#30591\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30618\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30591\fP to 2015.8
@ \fI2016\-01\-25 23:55:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30591\fP: (\fI\%mlalpho\fP) salt\-cloud\-clouds\-ec2 AssociatePublicIpAddress fix (refs: \fI\%#30618\fP)
.IP \(bu 2
\fBPR\fP \fI\%#20972\fP: (\fI\%JohannesEbke\fP) Fix interface cleanup when using AssociatePublicIpAddress in \fI\%#19288\fP (refs: \fI\%#30591\fP)
.IP \(bu 2
f00d8f398a Merge pull request \fI\%#30618\fP from rallytime/bp\-30591
.IP \(bu 2
2c9d59fa42 looks like a re\-merge of PR \fI\%#20972\fP which relates to \fI\%#19288\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30587\fP: (\fI\%sjorge\fP) [docs] docs confusing on client_acl and external_auth usage (refs: \fI\%#30625\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30625\fP: (\fI\%jfindlay\fP) doc.topics.eauth: clarify client_acl vs eauth
@ \fI2016\-01\-25 23:03:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b940d9655 Merge pull request \fI\%#30625\fP from jfindlay/eauth_acl
.IP \(bu 2
b5e2cff028 doc.topics.eauth: clarify client_acl vs eauth
.UNINDENT
.UNINDENT
.SS Salt 2015.8.8.2 Release Notes
.sp
Version 2015.8.8.2 is a bugfix release for \fI\%2015.8.0\fP\&.
.SS Fixes to 2015.8.8
.sp
Salt 2015.8.8.2 includes fixes for the following known issues in 2015.8.8:
.INDENT 0.0
.IP \(bu 2
Key master with value [...] has an invalid type of list Error (\fI\%issue 32044\fP)
.IP \(bu 2
Failed to import module win_dacl Error (\fI\%issue 32004\fP)
.IP \(bu 2
Wrong validation type for file_ignore_glob key (\fI\%issue 32114\fP)
.IP \(bu 2
Fix file.managed for windows (\fI\%issue 31969\fP)
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%issue 32183\fP prevents Salt Cloud from installing the Salt minion on new
systems. To workaround this issue, call \fBsalt\-cloud \-u\fP to update the
bootstrap script to the latest version.
.UNINDENT
.UNINDENT
.SS Changelog for v2015.8.8..v2015.8.8.2
.sp
\fIGenerated at: 2018\-05\-28 00:29:12 UTC\fP
.INDENT 0.0
.IP \(bu 2
403563e441 Change type check errors to debug loglevel
.IP \(bu 2
8323005b3d Support multiple valid option types when performing type checks
.IP \(bu 2
2f95082a96 Fixed validation type for file_ignore_glob Fixes \fI\%#32114\fP
.IP \(bu 2
2685e61d9e Move constant declaration into member variable to avoid issues when modules can\(aqt be loaded.
.IP \(bu 2
bc10d7dede Add apply_template_on_contents for windows
.UNINDENT
.SS Salt 2015.8.9 Release Notes
.sp
Version 2015.8.9 is a bugfix release for \fI\%2015.8.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB145\fP
.IP \(bu 2
Total Issue References: \fB110\fP
.IP \(bu 2
Total PR References: \fB264\fP
.IP \(bu 2
Contributors: \fB71\fP (\fI\%Ch3LL\fP, \fI\%DmitryKuzmenko\fP, \fI\%DylanFrese\fP, \fI\%Ferbla\fP, \fI\%Kurocon\fP,
\fI\%Lothiraldan\fP, \fI\%RuriRyan\fP, \fI\%Talkless\fP, \fI\%The\-Loeki\fP, \fI\%UtahDave\fP, \fI\%Xiami2012\fP, \fI\%abednarik\fP,
\fI\%afletch\fP, \fI\%ahammond\fP, \fI\%ahus1\fP, \fI\%aletourneau\fP, \fI\%alxf\fP, \fI\%amontalban\fP, \fI\%anlutro\fP,
\fI\%arthurlogilab\fP, \fI\%atengler\fP, \fI\%basepi\fP, \fI\%bdrung\fP, \fI\%bradthurber\fP, \fI\%cachedout\fP,
\fI\%captaininspiration\fP, \fI\%cedwards\fP, \fI\%clarkperkins\fP, \fI\%clinta\fP, \fI\%cro\fP, \fI\%dmurphy18\fP,
\fI\%exowaucka\fP, \fI\%garethgreenaway\fP, \fI\%guettli\fP, \fI\%idonin\fP, \fI\%isbm\fP, \fI\%jacobhammons\fP, \fI\%jbonachera\fP,
\fI\%jfindlay\fP, \fI\%jfray\fP, \fI\%junster1\fP, \fI\%justinta\fP, \fI\%krak3n\fP, \fI\%lalmeras\fP, \fI\%lloydoliver\fP,
\fI\%lomeroe\fP, \fI\%mcalmer\fP, \fI\%mitar\fP, \fI\%mrproper\fP, \fI\%multani\fP, \fI\%nmadhok\fP, \fI\%notpeter\fP, \fI\%onorua\fP,
\fI\%paclat\fP, \fI\%papertigers\fP, \fI\%rallytime\fP, \fI\%rkgrunt\fP, \fI\%sakateka\fP, \fI\%sbreidba\fP, \fI\%schancel\fP,
\fI\%sjorge\fP, \fI\%stk0vrfl0w\fP, \fI\%techhat\fP, \fI\%terminalmage\fP, \fI\%thatch45\fP, \fI\%ticosax\fP, \fI\%tomlaredo\fP,
\fI\%twangboy\fP, \fI\%twellspring\fP, \fI\%vutny\fP, \fI\%whiteinge\fP)
.UNINDENT
.SS Important Post\-Upgrade Instructions for Linux Mint
.sp
As a result of some upstream changes, the \fBos\fP grain on Mint Linux is now
being detected as \fBLinuxMint\fP (\fI\%issue 33295\fP). Run the following command
\fBafter you upgrade to 2015.8.9\fP to reset the \fBos\fP grain to \fBMint\fP and the
\fBos_family\fP grain to \fBDebian\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-G \(aqos:LinuxMint\(aq grains.setvals \(dq{\(aqos\(aq: \(aqMint\(aq, \(aqos_family\(aq: \(aqDebian\(aq}\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Changelog for v2015.8.8.2..v2015.8.9
.sp
\fIGenerated at: 2018\-05\-28 00:36:04 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#33310\fP: (\fI\%jfindlay\fP) update 2015.8.9 release notes
.IP \(bu 2
\fBPR\fP \fI\%#33293\fP: (\fI\%twangboy\fP) Fix minion start retry on Windows (2015.8)
@ \fI2016\-05\-17 17:03:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
e3eff27c55 Merge pull request \fI\%#33293\fP from twangboy/fix_33277_2015_8
.IP \(bu 2
652f0079db Fix minion start retry on Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31270\fP: (\fI\%4001982248998\fP) acl.present: TypeError on subsequent runs (refs: \fI\%#33172\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33305\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33172\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#33172\fP: (\fI\%Kurocon\fP) linux_acl: Allow \(aq\-\(aq as a separation character in ACL permissions. Fi… (refs: \fI\%#33305\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33299\fP: (\fI\%jbonachera\fP) salt\-cloud: scp_file() and sftp_file() don\(aqt work with ipv4\-only hosts  (refs: \fI\%#33300\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33243\fP: (\fI\%jbonachera\fP) salt\-cloud: wait_for_port() doesn\(aqt work with ipv4\-only hosts (refs: \fI\%#33246\fP, \fI\%#33300\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33300\fP: (\fI\%jbonachera\fP) Handle more ipv6 error as an exception \fI\%#33299\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26062\fP: (\fI\%silenius\fP) service.status is broken under FreeBSD (refs: \fI\%#33294\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23435\fP: (\fI\%JaseFace\fP) service.status currently reports an error on FreeBSD if the service isn\(aqt running (refs: \fI\%#33294\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33294\fP: (\fI\%terminalmage\fP) Ignore retcode when checking service\(aqs status
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33274\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-05\-16 16:41:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
06edba448e Merge pull request \fI\%#33274\fP from rallytime/merge\-2015.8
.IP \(bu 2
bf641d3a66 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
8fa72f6588 Clarify file.replace MULTILINE flag interaction with regex anchors (\fI\%#33137\fP)
.IP \(bu 2
4b1f460256 update 2015.5.11 release notes (\fI\%#33236\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30258\fP: (\fI\%rallytime\fP) Changes dictionary return should be mentioned in test state docs (refs: \fI\%#33254\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33254\fP: (\fI\%rallytime\fP) Add comment for test=true w/o changes ret and add changes dict example
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30946\fP: (\fI\%rallytime\fP) Update SaltStack Git Policy Documentation (refs: \fI\%#33252\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33252\fP: (\fI\%rallytime\fP) Update Git Policy docs to match Contribution guide
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33238\fP: (\fI\%clinta\fP) x509 CSR fails if the csr does not contain any extensions (refs: \fI\%#33239\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33239\fP: (\fI\%clinta\fP) Fix \fI\%#33238\fP
.IP \(bu 2
\fBPR\fP \fI\%#33245\fP: (\fI\%terminalmage\fP) Backport \fI\%#33244\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#33244\fP: (\fI\%terminalmage\fP) Properly report on invalid gitfs/git_pillar/winrepo repos (refs: \fI\%#33245\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32238\fP: (\fI\%ticosax\fP) [gitfs] only 2 argument are passed to this template when render error message (refs: \fI\%#33244\fP, \fI\%#33245\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30605\fP: (\fI\%eyj\fP) Update development/conventions/release.rst docs \- they\(aqre out of date with the current process. (refs: \fI\%#33253\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33253\fP: (\fI\%rallytime\fP) Update the release process docs
@ \fI2016\-05\-13 21:28:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
94a53da92e Merge pull request \fI\%#33253\fP from rallytime/fix\-30605
.IP \(bu 2
a129d05b6d Update the release process docs
.IP \(bu 2
\fBPR\fP \fI\%#33251\fP: (\fI\%jfindlay\fP) update 2015.8.9 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33243\fP: (\fI\%jbonachera\fP) salt\-cloud: wait_for_port() doesn\(aqt work with ipv4\-only hosts (refs: \fI\%#33246\fP, \fI\%#33300\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33246\fP: (\fI\%techhat\fP) Handle ipv6 error as an exception
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33073\fP: (\fI\%robnagler\fP) TypeError: unhashable type: \(aqdict\(aq (refs: \fI\%#33213\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33213\fP: (\fI\%terminalmage\fP) Check rendered YAML for invalid keys
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21903\fP: (\fI\%basepi\fP) Document _file.conf pattern for master.d/ and minion.d/ (refs: \fI\%#33224\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33224\fP: (\fI\%rallytime\fP) Make note of files that begin with \(aq_\(aq in master.d or minion.d dirs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31975\fP: (\fI\%rajvidhimar\fP) Docstrings not reflected in the salt documentation. (refs: \fI\%#33150\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33150\fP: (\fI\%rallytime\fP) Gate jnpr imports in salt.proxy.junos.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21315\fP: (\fI\%ryan\-lane\fP) No example documentation for http.query state (refs: \fI\%#33222\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33222\fP: (\fI\%rallytime\fP) Add docs for the http state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29796\fP: (\fI\%vutny\fP) Fail to use \(aqhighstate\(aq outputter explicitly  (refs: \fI\%#33215\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33215\fP: (\fI\%rallytime\fP) Don\(aqt stacktrace when using \-\-out=highstate at CLI during state run.
.IP \(bu 2
\fBPR\fP \fI\%#33219\fP: (\fI\%lalmeras\fP) propagate opts to salt.util.http call
.IP \(bu 2
\fBPR\fP \fI\%#33154\fP: (\fI\%lalmeras\fP) propagate opts to salt.util.http call (refs: \fI\%#33219\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33237\fP: (\fI\%jfindlay\fP) update 2015.8.9 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33217\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-05\-12 22:45:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
6dc5d605b1 Merge pull request \fI\%#33217\fP from rallytime/merge\-forward\-2015.8
.IP \(bu 2
4655607b58 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
698f1eb657 Merge pull request \fI\%#33211\fP from cachedout/user_kill
.INDENT 2.0
.IP \(bu 2
d4f2e5baa7 Don\(aqt try to kill a parent proc if we can\(aqt
.UNINDENT
.IP \(bu 2
f86832911e Resolve issue with pkg module on Mint Linux (\fI\%#33205\fP)
.IP \(bu 2
a09e1b6335 Add pip installed and removed test (\fI\%#33178\fP)
.IP \(bu 2
96e3586f12 update 2015.5.11 release notes (\fI\%#33197\fP)
.IP \(bu 2
09b072a412 Fix file.managed for Windows (\fI\%#33181\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33207\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32917\fP: (\fI\%bradthurber\fP) standalone minion pygit2 pillar data doesn\(aqt refresh without manual git fetch (refs: \fI\%#33204\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33204\fP: (\fI\%terminalmage\fP) Add a fetch when compiling git_pillar for masterless minions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33162\fP: (\fI\%jfindlay\fP) Key error with salt.utils.cloud.cache_node and EC2 (refs: \fI\%#33164\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33164\fP: (\fI\%jfindlay\fP) cloud.clouds.ec2: cache each named node
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32385\fP: (\fI\%aronneagu\fP) git.latest throws expected string or buffer (refs: \fI\%#33203\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33203\fP: (\fI\%terminalmage\fP) Properly handle failed git commands when redirect_stderr=True
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32685\fP: (\fI\%gidantribal\fP) git state does not take into account ssh config file (refs: \fI\%#33152\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33152\fP: (\fI\%terminalmage\fP) Don\(aqt force use of global ssh_config when git identity file is specified
.IP \(bu 2
\fBPR\fP \fI\%#33198\fP: (\fI\%jfindlay\fP) update 2015.8.9 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33188\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-05\-11 22:32:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
6177a6a36f Merge pull request \fI\%#33188\fP from rallytime/merge\-2015.8
.IP \(bu 2
f12bba6ebc Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
30868ab06c [2015.5] Update to latest bootstrap script v2016.05.11 (\fI\%#33185\fP)
.IP \(bu 2
264ad34b3b Pip fix (\fI\%#33180\fP)
.IP \(bu 2
43288b268d add 2015.5.11 release notes (\fI\%#33160\fP)
.IP \(bu 2
e0da8fda7d [2015.5] Update to latest bootstrap script v2016.05.10 (\fI\%#33155\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33161\fP: (\fI\%jfindlay\fP) add 2015.8.9 release notes
.IP \(bu 2
\fBPR\fP \fI\%#33156\fP: (\fI\%rallytime\fP) [2015.8] Update to latest bootstrap script v2016.05.10
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25040\fP: (\fI\%yi9\fP) grains.get can\(aqt get minion\(aqs /etc/salt/grains value in multi\-master set up (refs: \fI\%#33142\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33142\fP: (\fI\%cachedout\fP) Hash fileclients by opts
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22142\fP: (\fI\%multani\fP) State \fIacl.present\fP doesn\(aqt allow setting \(dqdefault\(dq ACLs (refs: \fI\%#31769\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33139\fP: (\fI\%rallytime\fP) Back\-port \fI\%#31769\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#31769\fP: (\fI\%DylanFrese\fP) Fix acl.present and acl.absent when adding default ACLs (refs: \fI\%#33139\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33144\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-05\-10 19:40:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
2800762b44 Merge pull request \fI\%#33144\fP from rallytime/merge\-2015.8
.IP \(bu 2
449176f06e Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
6cd1641840 Merge pull request \fI\%#33141\fP from jtand/disable_local_pkg_install_test
.INDENT 2.0
.IP \(bu 2
8b1e34fb17 Skipping salt\-call \-\-local test
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33140\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-05\-10 16:57:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
72d075e14e Merge pull request \fI\%#33140\fP from rallytime/merge\-2015.8
.IP \(bu 2
c732c8104b Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
878d34a865 Doc mock decorators (\fI\%#33132\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32834\fP: (\fI\%beardedeagle\fP) Masterless Minion \- Unable to query job cache (refs: \fI\%#33017\fP, \fI\%#33100\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33100\fP: (\fI\%rallytime\fP) If cache_jobs: True is set, populate the local job cache when running salt\-call
.IP \(bu 2
\fBPR\fP \fI\%#33135\fP: (\fI\%stk0vrfl0w\fP) Fix broken parsing of usermgmt.conf on OpenBSD
.IP \(bu 2
\fBPR\fP \fI\%#33129\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33101\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#33101\fP: (\fI\%thatch45\fP) Add a check that the cmdline of the found proc matches (refs: \fI\%#33129\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33064\fP: (\fI\%terminalmage\fP) salt.utils.gitfs: fix formatting for warning messages
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33058\fP: (\fI\%aclemetson\fP) Unable to run \(dqwin_servermanager.list_available\(dq on minion. (refs: \fI\%#33099\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33099\fP: (\fI\%twangboy\fP) Fix 33058
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32999\fP: (\fI\%basepi\fP) Stacktrace for \fImaster_finger\fP mismatch on minion (refs: \fI\%#33106\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33106\fP: (\fI\%abednarik\fP) Moved _finger_fail method to parent class.
@ \fI2016\-05\-09 16:31:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
8acc3147d6 Merge pull request \fI\%#33106\fP from abednarik/abednarik_master_Finger_stacktrace
.IP \(bu 2
91a69ba54a Moved _finger_fail method to parent class.
.IP \(bu 2
\fBPR\fP \fI\%#33102\fP: (\fI\%Ch3LL\fP) clarify docs that map is designed to be run once. is not stateful
.IP \(bu 2
\fBPR\fP \fI\%#33098\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33061\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#33061\fP: (\fI\%ahammond\fP) cloud.query needs to define mapper.opts (refs: \fI\%#33098\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33096\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-05\-06 19:27:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
c1f7aed8a5 Merge pull request \fI\%#33096\fP from rallytime/merge\-2015.8
.IP \(bu 2
0fd5e9d157 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
30edeadafd Lower display of msgpack failure msg to debug (\fI\%#33078\fP)
.IP \(bu 2
d4928c5a22 Use saltstack repo in buildpackage.py on CentOS 5 (\fI\%#33080\fP)
.IP \(bu 2
61d126cb98 add test for installing package while using salt\-call \-\-local (\fI\%#33025\fP)
.IP \(bu 2
6d3e4e8935 File and User test fixes for 2015.5 on Fedora23 (\fI\%#33055\fP)
.IP \(bu 2
d48b2b8b52 test pillar.items output (\fI\%#33060\fP)
.IP \(bu 2
398793bfc0 Fix minor document error of test.assertion (\fI\%#33067\fP)
.IP \(bu 2
f8757631b2 Saltfile with pillar tests (\fI\%#33045\fP)
.IP \(bu 2
1d7892421e Backport \fI\%#33021\fP manually to 2015.5 (\fI\%#33044\fP)
.IP \(bu 2
f00b5f91b3 Add run_on_start docs to schedule.rst (\fI\%#32958\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32865\fP: (\fI\%idonin\fP) salt\-cloud: fix ipv6\-only virtual machines
.IP \(bu 2
\fBPR\fP \fI\%#33084\fP: (\fI\%jfindlay\fP) modules.npm: do not log npm \-\-version at info level
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33068\fP: (\fI\%pythonwood\fP) salt\-ssh do not support centos5 because old\-version\-python  ? (refs: \fI\%#33081\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33081\fP: (\fI\%jfindlay\fP) ssh docs: install py\-2.6 for RHEL 5
@ \fI2016\-05\-06 15:18:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
3808d05838 Merge pull request \fI\%#33081\fP from jfindlay/ssh_doc
.IP \(bu 2
a2c927b173 ssh docs: install py\-2.6 for RHEL 5
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33088\fP: (\fI\%isbm\fP) Bugfix: Restore boolean values from the repo configuration
@ \fI2016\-05\-06 15:13:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
6d604926d3 Merge pull request \fI\%#33088\fP from isbm/isbm\-zypper\-fix\-booleans
.IP \(bu 2
3ca203eb8e Bugfix (follow\-up): setting priority requires non\-positive integer
.IP \(bu 2
79a46e091c Add repo config test
.IP \(bu 2
222b8369ca Add test data for repos
.IP \(bu 2
b746fa35f0 Bugfix: Restore boolean values from the repo configuration
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#12422\fP: (\fI\%creaky\fP) Bug: file.blockreplace inserts additional blank line on multi\-line content (refs: \fI\%#33049\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33082\fP: (\fI\%Ch3LL\fP) Fix tests for file.blockplace to remove newline
.IP \(bu 2
\fBPR\fP \fI\%#33049\fP: (\fI\%thatch45\fP) Don\(aqt append a newline when creating new content with blockreplace (refs: \fI\%#33082\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32892\fP: (\fI\%isbm\fP) Resolve Zypper locks on asynchronous calls
@ \fI2016\-05\-05 14:34:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb89877cf2 Merge pull request \fI\%#32892\fP from isbm/isbm\-zypper\-env\-variables
.IP \(bu 2
1601a7e07a Prevent the use of \(dqrefreshable\(dq together with \(dqnolock\(dq option.
.IP \(bu 2
52e1be2fa9 Remove unused variable in a constructor. Adjust the docstring accordingly.
.IP \(bu 2
7e00f566ef Move log message down to the point where it actually sleeps. Rephrase the message.
.IP \(bu 2
4b7dab83ff Fix PID file path for SLE11
.IP \(bu 2
7f37961d4b Rename tags
.IP \(bu 2
c55b0fab58 Test DOM parsing
.IP \(bu 2
c54e928e4f Add exception handling test
.IP \(bu 2
3d245bbe84 Parse DOM out of the box, when XML mode is called
.IP \(bu 2
6a98f523ac Add Zypper caller test suite
.IP \(bu 2
f189f90124 Bugfix: always trigger __getattr__ to reset and increment the configuration before the call.
.IP \(bu 2
7e1712dd80 Fix tests according to the new calling model
.IP \(bu 2
3a30b7fbcd Remove an obsolete test case
.IP \(bu 2
6e5877a2ee Add Zypper Call mock
.IP \(bu 2
bb5540cb4a Bugfix: inverted logic on raising (or not) exceptions
.IP \(bu 2
ce9262fe71 Make Zypper caller module\-level reusable
.IP \(bu 2
77dc8695af Update docstrings according to the bugfix
.IP \(bu 2
46d86b21d5 Bugfix: accept refresh override param
.IP \(bu 2
cb40618262 Fire an event about released Zypper with its result
.IP \(bu 2
0728f0bc00 Replace string values with the constants
.IP \(bu 2
6af3f7141b Check if zypper lock exists and add more debug logging
.IP \(bu 2
0167b30a75 Add Zypper lock constant
.IP \(bu 2
370ff21d36 Fire an event to the Master about blocked Zypper.
.IP \(bu 2
1727ca3de2 Use new Zypper call implementation
.IP \(bu 2
485164aa5c Remove blocking\-prone Zypper call implementation
.IP \(bu 2
f161f0612c Implement block\-proof Zypper call implementation
.IP \(bu 2
baf35ed708 Remove one\-char variables
.IP \(bu 2
2c94eb016f Remove an unused variable
.IP \(bu 2
6869ebc557 Remove an empty line
.IP \(bu 2
7e06489da9 Remove verbose wrapping
.IP \(bu 2
2131ff04af Standarize zypper call to \(dqrun_all\(dq
.IP \(bu 2
046ef44ca3 Bugfix: version_cmp crashes in CLI if there are versions, that looks like integer or float.
.IP \(bu 2
b869a92eea Change Zypper calls to a single point
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24237\fP: (\fI\%Grokzen\fP) Minion schedule return data missing some fields (refs: \fI\%#33039\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33039\fP: (\fI\%The\-Loeki\fP) Add fun_args to scheduled return data (part of \fI\%#24237\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#12422\fP: (\fI\%creaky\fP) Bug: file.blockreplace inserts additional blank line on multi\-line content (refs: \fI\%#33049\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33049\fP: (\fI\%thatch45\fP) Don\(aqt append a newline when creating new content with blockreplace (refs: \fI\%#33082\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24996\fP: (\fI\%danlsgiga\fP) \-\-failhard option not working as expected (refs: \fI\%#33048\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33048\fP: (\fI\%rallytime\fP) Pass all data to batch.run() call when using \-\-failhard
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32452\fP: (\fI\%nicholascapo\fP) cmd.run_all with \-\-batch  and \-\-failhard gives no output on failure (refs: \fI\%#33050\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33050\fP: (\fI\%rallytime\fP) Display command output when command fails with batch + failhard options
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33041\fP: (\fI\%anitakrueger\fP) boto_elb.present security_groups kwarg is a list \- needs documentation (refs: \fI\%#33053\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33053\fP: (\fI\%rallytime\fP) Allow security_groups kwarg for boto_elb.present to be string or list
.IP \(bu 2
\fBPR\fP \fI\%#33054\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#33056\fP: (\fI\%justinta\fP) File and User test fixes for 2015.8 on Fedora23
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32472\fP: (\fI\%esn89\fP) salt\-minion is stuck in a restart loop with not much info: (refs: \fI\%#33030\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33040\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33030\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#33030\fP: (\fI\%thatch45\fP) When we restart the minion we should show the error that caused it (refs: \fI\%#33040\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32834\fP: (\fI\%beardedeagle\fP) Masterless Minion \- Unable to query job cache (refs: \fI\%#33017\fP, \fI\%#33100\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33017\fP: (\fI\%rallytime\fP) Update the docs for saltutil.find_job to be more clear/accurate
.IP \(bu 2
\fBPR\fP \fI\%#33031\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33002\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#33002\fP: (\fI\%whiteinge\fP) Add saltenv to the cmd.script state function (refs: \fI\%#33031\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33021\fP: (\fI\%UtahDave\fP) Fix syndic regression (refs: \fI\%#33044\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#11801\fP: (\fI\%slai\fP) Salt does not match user names properly under Windows (refs: \fI\%#32674\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32674\fP: (\fI\%twangboy\fP) Compare uid and gid instead of name and group
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32856\fP: (\fI\%DeanScothern\fP) jjid not shown when running the salt command line with \-\-batch\-size  using either \-\-verbose or \-\-show\-jid  with certain salt versions (refs: \fI\%#32996\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#31738\fP: (\fI\%igorwidlinski\fP) salt \-\-show\-jid does not show job id when run in batch mode (refs: \fI\%#32450\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32996\fP: (\fI\%rallytime\fP) Allow batch mode to use verbose option, as well as show_jid.
.IP \(bu 2
\fBPR\fP \fI\%#32450\fP: (\fI\%cachedout\fP) Pass parser options into batch mode (refs: \fI\%#32996\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32954\fP: (\fI\%atengler\fP) glusterfs.peered fails with \(aqNoneType\(aq object is not iterable (refs: \fI\%#32955\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32955\fP: (\fI\%atengler\fP) Fixed glusterfs.peered output
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26011\fP: (\fI\%rodriguezsergio\fP) states.virtualenv != modules.virtualenv (refs: \fI\%#32994\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32994\fP: (\fI\%rallytime\fP) Clarify some arg docs for virtualenv state
.IP \(bu 2
\fBPR\fP \fI\%#32986\fP: (\fI\%justinta\fP) Fix boto_secgroup_test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32777\fP: (\fI\%sjorge\fP) cron.present broken on Solarish systems if user specified (refs: \fI\%#32970\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32970\fP: (\fI\%sjorge\fP) fix user cron on solarish operating systems
.IP \(bu 2
\fBPR\fP \fI\%#32796\fP: (\fI\%jfindlay\fP) salt.log.setup: process user args before format
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32891\fP: (\fI\%guettli\fP) docs: Note \(dq This document represents behavior exhibited by Salt requisites as of version 0.9.7 of Salt.\(dq (refs: \fI\%#32934\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32934\fP: (\fI\%jfindlay\fP) doc.ref.states.ordering: clarify requisite change
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32882\fP: (\fI\%papertigers\fP) carbon_return is missing a default value. (refs: \fI\%#32883\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32928\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32883\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#32883\fP: (\fI\%papertigers\fP) mode should default to \(aqtext\(aq (refs: \fI\%#32928\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32646\fP: (\fI\%deamen\fP) FileClient Class ( client = salt.minion.FileClient(__opts__) )  does not exist (refs: \fI\%#32925\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32925\fP: (\fI\%rallytime\fP) Remove FileClient class references from docs \- it doesn\(aqt exist.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23683\fP: (\fI\%gravyboat\fP) contents_grains should have an example (refs: \fI\%#32922\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32922\fP: (\fI\%rallytime\fP) Update contents_grains option with relevant docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32926\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-04\-28 19:47:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
e60c12640d Merge pull request \fI\%#32926\fP from rallytime/merge\-2015.8
.IP \(bu 2
5a184881be Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
edce22a143 backport PR \fI\%#32732\fP to 2015.5 fixes \fI\%#23714\fP (\fI\%#32848\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32908\fP: (\fI\%Ch3LL\fP) Specify EBS volume tags in profile configuration in aws
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23952\fP: (\fI\%neogenix\fP) iptables state append doesn\(aqt honor position \-1 (refs: \fI\%#32906\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32906\fP: (\fI\%rallytime\fP) Update docs to warn users that \-1 isn\(aqt valid for iptables insert state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32510\fP: (\fI\%Ch3LL\fP) Cannot specify image in provider file when using map file (refs: \fI\%#32900\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32900\fP: (\fI\%rallytime\fP) Allow profile options to be specified in provider file when using maps
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30855\fP: (\fI\%guettli\fP) Docs: does salt.states.service support systemd? (refs: \fI\%#32880\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32880\fP: (\fI\%rallytime\fP) Clarify service state opening docs \- uses \(aqservice\(aq virtualname
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32884\fP: (\fI\%terminalmage\fP) Fix incorrect deprecation notice
@ \fI2016\-04\-27 15:47:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
e1b40b3b76 Merge pull request \fI\%#32884\fP from terminalmage/fix\-incorrect\-deprecation\-notice
.IP \(bu 2
b307c5452a Fix incorrect deprecation notice
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32878\fP: (\fI\%jacobhammons\fP) added note about updating the bootstrap script in salt\-cloud using th…
@ \fI2016\-04\-26 21:09:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
a2921b9da0 Merge pull request \fI\%#32878\fP from jacobhammons/salt\-cloud
.IP \(bu 2
3887938727 added note about updating the bootstrap script in salt\-cloud using the \-u flag, removed the saltconf banner.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32861\fP: (\fI\%bradthurber\fP) Is it master_syndic or syndic_master? (refs: \fI\%#32869\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32869\fP: (\fI\%rallytime\fP) Use correct config setting in cloud syndic docs
@ \fI2016\-04\-26 19:13:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
71db10fd2c Merge pull request \fI\%#32869\fP from rallytime/fix\-32861
.IP \(bu 2
0e73daa126 Use correct config setting in cloud syndic docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32844\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-04\-26 17:38:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
02c681311f Merge pull request \fI\%#32844\fP from rallytime/merge\-2015.8
.IP \(bu 2
1fc9de1d04 Add \(aqfile.source_list\(aq mock to archive state unit tests
.IP \(bu 2
9064d3bbfb Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.INDENT 2.0
.IP \(bu 2
9b5c14c37c \fIsalt\-cloud \-u\fP downloads stable version from bootstrap.saltstack.com by default (\fI\%#32837\fP)
.IP \(bu 2
9725804448 update bootstrap to 2016.04.18 release (\fI\%#32667\fP)
.IP \(bu 2
c842e1e437 Merge pull request \fI\%#32776\fP from rallytime/merge\-2015.5
.INDENT 2.0
.IP \(bu 2
7ecbf9f885 Merge pull request #14 from whiteinge/runner\-async\-low
.INDENT 2.0
.IP \(bu 2
211f7b4af1 Format low data correct for runner_async
.UNINDENT
.IP \(bu 2
ce72851861 Merge branch \(aq2014.7\(aq into \(aq2015.5\(aq
.IP \(bu 2
2775edc176 Saltnado /run fix (\fI\%#32590\fP)
.IP \(bu 2
b19c5a5ce7 Verify auth in saltnado run (\fI\%#32552\fP)
.UNINDENT
.IP \(bu 2
67d0c81184 Support remote sources in a source list (\fI\%#32691\fP)
.IP \(bu 2
bd5442d768 Merge pull request \fI\%#32686\fP from cachedout/issue_32661
.INDENT 2.0
.IP \(bu 2
f704df90bc Fix stacktrace in batch with dup minion ids
.UNINDENT
.IP \(bu 2
3ec9502a86 Update \(dqLow Hanging Fruit\(dq to \(dqHelp Wanted\(dq (\fI\%#32675\fP)
.IP \(bu 2
77bea56b68 Additional documentation on calling exec modules from templates (\fI\%#32657\fP)
.IP \(bu 2
c910b8dd51 Fixing critical bug to remove only the specified Host instead of the entire Host cluster (\fI\%#32639\fP)
.IP \(bu 2
4568565d45 Add _syspaths.py to .gitignore (\fI\%#32638\fP)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32799\fP: (\fI\%belt\fP) ssh_auth.present creates ~/~${USER}/.ssh (refs: \fI\%#32868\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32868\fP: (\fI\%rallytime\fP) Back\-port \fI\%#31139\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#31139\fP: (\fI\%exowaucka\fP) Improve %h and %u handling in SSH module (refs: \fI\%#32868\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23714\fP: (\fI\%naemono\fP) file.copy force ignored during highstate, but not with \(aqsalt\-call state.sls_id\(aq (refs: \fI\%#32732\fP, \fI\%#32847\fP, \fI\%#32848\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32847\fP: (\fI\%lomeroe\fP) backport PR \fI\%#32732\fP for issue \fI\%#23714\fP
.IP \(bu 2
\fBPR\fP \fI\%#32732\fP: (\fI\%lomeroe\fP) correct use of force flag in file.copy \fI\%#23714\fP (refs: \fI\%#32847\fP, \fI\%#32848\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32824\fP: (\fI\%bradthurber\fP) salt\-cloud vmware: wrong pyvmomi installed for RHEL/CentOS 6 (refs: \fI\%#32845\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32845\fP: (\fI\%rallytime\fP) Add pyvmomi version warning to Getting Started with VMware docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25492\fP: (\fI\%hernanc\fP) \(dqdocker\-py mem_limit has been moved to host_config in API version 1.19\(dq error (refs: \fI\%#26518\fP, \fI\%#32818\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32841\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32818\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#32818\fP: (\fI\%mitar\fP) Pass None as memory limit (refs: \fI\%#32841\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26518\fP: (\fI\%krak3n\fP) Fix for \fI\%#25492\fP (refs: \fI\%#32818\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32605\fP: (\fI\%Talkless\fP) pkgrepo.managed with apt does not add comments value later (refs: \fI\%#32813\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32839\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32813\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#32813\fP: (\fI\%abednarik\fP) Add comments as an option for apt in pkgrepo.managed. (refs: \fI\%#32839\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32659\fP: (\fI\%anlutro\fP) Various improvements on cloud deploy script docs
.IP \(bu 2
\fBPR\fP \fI\%#32668\fP: (\fI\%jfindlay\fP) [2015.8] update bootstrap to 2016.04.18 release
.IP \(bu 2
\fBPR\fP \fI\%#32785\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29322\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#29322\fP: (\fI\%mrproper\fP) add http proxy support for tornado (refs: \fI\%#32785\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32710\fP: (\fI\%bradthurber\fP) conf/master missing many gitfs and git_pillar parameters (refs: \fI\%#32722\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32787\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32722\fP to 2015.8
@ \fI2016\-04\-25 15:19:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32722\fP: (\fI\%bradthurber\fP) Catch up the conf/master file to include gitfs/git_pillar parms from … (refs: \fI\%#32787\fP)
.IP \(bu 2
96a3d4e556 Merge pull request \fI\%#32787\fP from rallytime/bp\-32722
.IP \(bu 2
8d7148d41b Catch up the conf/master file to include gitfs/git_pillar parms from recent releases
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32786\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32703\fP to 2015.8
@ \fI2016\-04\-25 15:19:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32703\fP: (\fI\%schancel\fP) Make example top file match templated version (refs: \fI\%#32786\fP)
.IP \(bu 2
36f70f5847 Merge pull request \fI\%#32786\fP from rallytime/bp\-32703
.IP \(bu 2
baa4df25c9 Make example top file match templated version
.IP \(bu 2
227ef4aabb Fix unnecessary capitalization
.IP \(bu 2
73cd9f26c3 Merge branch \(aqgitfs_perremote_doc_updates\(aq of \fI\%https://github.com/l2ol33rt/salt\fP into pr\-32775
.IP \(bu 2
b69d406ada Including name per\-remote config option in example
.IP \(bu 2
\fBPR\fP \fI\%#32779\fP: (\fI\%terminalmage\fP) Improve documentation on pygit2 versions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32609\fP: (\fI\%anlutro\fP) Tornado ioloop fails when master disconnects? (refs: \fI\%#32749\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32749\fP: (\fI\%DmitryKuzmenko\fP) Properly handle minion failback failure.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32144\fP: (\fI\%vutny\fP) Pillar targeting starts to work only after calling \fIsaltutil.refresh_pillar\fP (refs: \fI\%#32643\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32643\fP: (\fI\%vutny\fP) Document pillar cache options
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32705\fP: (\fI\%joakimkarlsson\fP) win_dacl.present: Specifying propagations for a directory fails  (refs: \fI\%#32720\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32720\fP: (\fI\%jfindlay\fP) modules.win_dacl: consistent case of dacl constants
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30761\fP: (\fI\%sjmh\fP) Cannot target subsets of minions when using pillar and external_auth (refs: \fI\%#31598\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#21303\fP: (\fI\%Lothiraldan\fP) Explicit and document ACL rules format (refs: \fI\%#32733\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32733\fP: (\fI\%Lothiraldan\fP) Update external auth documentation to list supported matcher.
.IP \(bu 2
\fBPR\fP \fI\%#31598\fP: (\fI\%terminalmage\fP) Remove limitations on validation types for eauth targets (refs: \fI\%#32733\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32693\fP: (\fI\%techhat\fP) Check dependencies type before appling str operations
.IP \(bu 2
\fBPR\fP \fI\%#32692\fP: (\fI\%garethgreenaway\fP) Handle when beacon not configured and we try to enable/disable them
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32718\fP: (\fI\%garethgreenaway\fP) Fixes to schedule.list in 2015.8
@ \fI2016\-04\-20 19:51:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
f52af5a596 Merge pull request \fI\%#32718\fP from garethgreenaway/2015_8_schedule_list_fix
.IP \(bu 2
7fa5d809d2 backporting a fix from develop where the use of splay would result in seconds=0 in the schedule.list when there was no seconds specified in the origina schedule
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32684\fP: (\fI\%captaininspiration\fP) Fix routes for redhat < 6
@ \fI2016\-04\-19 19:18:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32682\fP: (\fI\%captaininspiration\fP) Fix routes for redhat < 6 (refs: \fI\%#32684\fP)
.IP \(bu 2
f63566e452 Merge pull request \fI\%#32684\fP from captaininspiration/2015.8
.IP \(bu 2
640c7a90da Fix routes for redhat < 6
.IP \(bu 2
\fBPR\fP \fI\%#32683\fP: (\fI\%techhat\fP) Handle a couple of arguments better (Azure)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32523\fP: (\fI\%junster1\fP) network.py/loader.py failing because cfn variable is not defined before use. (refs: \fI\%#32672\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32672\fP: (\fI\%junster1\fP) Fix for issue 32523
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32517\fP: (\fI\%Ch3LL\fP) Minion restarting and erroring when cannot reach the masters in multi\-master failover (refs: \fI\%#32555\fP, \fI\%#32556\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32556\fP: (\fI\%DmitryKuzmenko\fP) Don\(aqt access deprecated Exception.message attribute.
.IP \(bu 2
\fBPR\fP \fI\%#32655\fP: (\fI\%cachedout\fP) Lower log level for pillar cache
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31542\fP: (\fI\%duk3luk3\fP) jinja stringifies dict before passing it to execution module (maybe salt\-ssh specific?) (refs: \fI\%#32588\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32588\fP: (\fI\%anlutro\fP) Fix salt\-ssh module function call argument type juggling by JSON encoding them
@ \fI2016\-04\-18 15:57:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
a6a427463d Merge pull request \fI\%#32588\fP from alprs/fix\-salt_ssh_module_types
.IP \(bu 2
d912f1c3c6 json encode arguments passed to an execution module function call
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32229\fP: (\fI\%seanjnkns\fP) 2015.8.8.2: pkg.installed fails to update packages with epoch (refs: \fI\%#32563\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32563\fP: (\fI\%terminalmage\fP) yumpkg: Ignore epoch in version comparison for explicit versions without an epoch
.IP \(bu 2
\fBPR\fP \fI\%#32640\fP: (\fI\%nmadhok\fP) [2015.8] \- Fixing critical bug to remove only the specified Host instead of the entire Host cluster
.IP \(bu 2
\fBPR\fP \fI\%#32649\fP: (\fI\%mcalmer\fP) align OS grains from older SLES with current one
.IP \(bu 2
\fBPR\fP \fI\%#32652\fP: (\fI\%isbm\fP) Prevent crash if pygit2 package is requesting re\-compilation of the e…
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32614\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-04\-15 19:27:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
05a41a13cd Merge pull request \fI\%#32614\fP from rallytime/merge\-2015.8
.IP \(bu 2
046e401dd8 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.INDENT 2.0
.IP \(bu 2
027b502335 Merge pull request \fI\%#32561\fP from gtmanfred/user_passwords
.INDENT 2.0
.IP \(bu 2
3db5e78d5d redact passwords and hashes from user.present updates
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32616\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32547\fP to 2015.8
@ \fI2016\-04\-15 19:27:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32547\fP: (\fI\%cro\fP) Expand on the open\-source vs open\-core FAQ (refs: \fI\%#32616\fP)
.IP \(bu 2
ef17bde054 Merge pull request \fI\%#32616\fP from rallytime/bp\-32547
.IP \(bu 2
4242bc7399 Language clarification.
.IP \(bu 2
965e3bc1d1 Expand on the open\-source vs open\-core FAQ
.IP \(bu 2
\fBPR\fP \fI\%#32604\fP: (\fI\%Talkless\fP) Fix comments value in salt.states.pkgrepo example
.IP \(bu 2
\fBPR\fP \fI\%#32558\fP: (\fI\%terminalmage\fP) Revert PR \fI\%#32480\fP and apply \fI\%#32314\fP with fixes / documentation
.IP \(bu 2
\fBPR\fP \fI\%#32480\fP: (\fI\%terminalmage\fP) Clear VCS fsbackend and git_pillar locks on master start (refs: \fI\%#32558\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32314\fP: (\fI\%onorua\fP) prevent eternal gitfs lock due to process crash (refs: \fI\%#32480\fP, \fI\%#32558\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32519\fP: (\fI\%Ch3LL\fP) Minion restarting and erroring when cannot reach the master (refs: \fI\%#32576\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32576\fP: (\fI\%DmitryKuzmenko\fP) Better log message on minion restart if master couldn\(aqt be reached.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32517\fP: (\fI\%Ch3LL\fP) Minion restarting and erroring when cannot reach the masters in multi\-master failover (refs: \fI\%#32555\fP, \fI\%#32556\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32555\fP: (\fI\%DmitryKuzmenko\fP) Don\(aqt return None from eval_master
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32536\fP: (\fI\%rallytime\fP) Back\-port \fI\%#31898\fP to 2015.8
@ \fI2016\-04\-13 18:49:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31898\fP: (\fI\%afletch\fP) Ensure rh_service not used on CloudLinux 7 (refs: \fI\%#32536\fP)
.IP \(bu 2
27e91e40cc Merge pull request \fI\%#32536\fP from rallytime/bp\-31898
.IP \(bu 2
60d80c4dee Ensure rh_service not used on CloudLinux 7
.IP \(bu 2
\fBPR\fP \fI\%#32542\fP: (\fI\%twangboy\fP) Fix binary search and replace
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32539\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-04\-13 15:10:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
cce7de76b0 Merge pull request \fI\%#32539\fP from rallytime/merge\-2015.8
.IP \(bu 2
fbaeb165c9 Merge branch \(aq2015.5\(aq into merge\-2015.8
.IP \(bu 2
7307bcb88e Merge pull request \fI\%#32538\fP from rallytime/bp\-32528
.INDENT 2.0
.IP \(bu 2
46a4e8a310 Remove merge conflict line
.IP \(bu 2
e0d947c707 Document \(dqgrains\(dq setting in the minion configuration reference
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32493\fP: (\fI\%bberberov\fP) dockerng.volume_present fails when no volumes already exist on the system (refs: \fI\%#32531\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32531\fP: (\fI\%ticosax\fP) [dockerng] Fix support of dockerng.volume_present when no volume is on present.
@ \fI2016\-04\-13 14:42:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
1834bdefe3 Merge pull request \fI\%#32531\fP from ticosax/support\-no\-volumes
.IP \(bu 2
958b2ec749 Fix support of dockerng.volume_present when no volume is on present.
.IP \(bu 2
\fBPR\fP \fI\%#32475\fP: (\fI\%ticosax\fP) [dockerng] Enhance dockerng.wait() to control success on exit_code and on already stopped containers
.IP \(bu 2
\fBPR\fP \fI\%#32436\fP: (\fI\%isbm\fP) Bugfix: salt\-key crashes if tries to generate keys to the directory w/o write access
.IP \(bu 2
\fBPR\fP \fI\%#32515\fP: (\fI\%terminalmage\fP) Turn on exc_info when logging failed minion startup
.IP \(bu 2
\fBPR\fP \fI\%#32520\fP: (\fI\%terminalmage\fP) Add ignore_epoch option to pkg.installed/removed/purged states
.IP \(bu 2
\fBPR\fP \fI\%#32505\fP: (\fI\%isbm\fP) Isbm zypper list products sles11 crash
.IP \(bu 2
\fBPR\fP \fI\%#32480\fP: (\fI\%terminalmage\fP) Clear VCS fsbackend and git_pillar locks on master start (refs: \fI\%#32558\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32314\fP: (\fI\%onorua\fP) prevent eternal gitfs lock due to process crash (refs: \fI\%#32480\fP, \fI\%#32558\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32327\fP: (\fI\%joakimkarlsson\fP) salt\-minion fails to start on Windows (refs: \fI\%#32491\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32491\fP: (\fI\%twangboy\fP) Use win32api to get Total System Memory
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31927\fP: (\fI\%afletch\fP) pkg.installed compares version including package epoch (pkg.version problem?) (refs: \fI\%#32487\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32487\fP: (\fI\%terminalmage\fP) Add explanation of nonzero epoch requirement to pkg.installed state documentation
@ \fI2016\-04\-11 20:48:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
e335e313fe Merge pull request \fI\%#32487\fP from terminalmage/epoch\-documentation
.IP \(bu 2
e04cf879b6 Document new behavior of pkg.installed for yum/dnf packages with non\-zero epoch
.IP \(bu 2
61e9761224 Add explanation of nonzero epoch requirement to pkg.installed state documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32482\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-04\-11 20:12:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
e8de50ff37 Merge pull request \fI\%#32482\fP from rallytime/merge\-2015.8
.IP \(bu 2
1b04f0ddec Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
29333e533e Add documentation for some master/minion configs (\fI\%#32454\fP)
.IP \(bu 2
100c6e1b25 Merge pull request \fI\%#32458\fP from terminalmage/clarify\-providers\-docs
.INDENT 2.0
.IP \(bu 2
500d3ebbaa Add link to provider override docs to all group providers
.IP \(bu 2
83ca01f620 dd link to provider override docs to all shadow providers
.IP \(bu 2
c5fe38789d Add link to provider override docs to all user providers
.IP \(bu 2
5c1c1dda59 Add link to provider override docs to all service providers
.IP \(bu 2
736f2befc9 Add link to provider override docs to all package providers
.IP \(bu 2
f9306347cc Clarify the scope of the provider param in states.
.IP \(bu 2
af24c82ab0 Add documentation on virtual module provider overrides to the module docs
.IP \(bu 2
0bc6c97a63 Improve docstrings
.IP \(bu 2
1948920674 Add external ref to windows package manager docs
.IP \(bu 2
e7fa21438c Add new doc pages to toctree
.IP \(bu 2
f0de1236ec Move the tables of virtual modules to individual documentation pages
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30183\fP: (\fI\%jakehilton\fP) Minion startup extremely delayed when first master in failover multi master setup is down (refs: \fI\%#31364\fP, \fI\%#31382\fP, \fI\%#32143\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#29643\fP: (\fI\%matthayes\fP) Can\(aqt get batch mode and \-\-failhard to work as expected (refs: \fI\%#31164\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#28569\fP: (\fI\%andrejohansson\fP) Reactor alert on highstate fail (refs: \fI\%#31164\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32474\fP: (\fI\%DmitryKuzmenko\fP) Backport 31164 and 31364
.IP \(bu 2
\fBPR\fP \fI\%#32441\fP: (\fI\%cachedout\fP) Backport 31164 31364 (refs: \fI\%#32474\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31364\fP: (\fI\%DmitryKuzmenko\fP) Don\(aqt send REQ while another one is waiting for response. (refs: \fI\%#32441\fP, \fI\%#32474\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31164\fP: (\fI\%DmitryKuzmenko\fP) Issues/29643 fix invalid retcode (refs: \fI\%#32441\fP, \fI\%#32474\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31738\fP: (\fI\%igorwidlinski\fP) salt \-\-show\-jid does not show job id when run in batch mode (refs: \fI\%#32450\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32450\fP: (\fI\%cachedout\fP) Pass parser options into batch mode (refs: \fI\%#32996\fP)
@ \fI2016\-04\-08 23:03:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
7bf44aea72 Merge pull request \fI\%#32450\fP from cachedout/issue_31738
.IP \(bu 2
74d0fa06b4 Pass parser options into batch mode
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28706\fP: (\fI\%kkaig\fP) user.present:groups vs group.present:members (refs: \fI\%#30824\fP, \fI\%#32448\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32448\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30824\fP to 2015.8
.IP \(bu 2
\fBPR\fP \fI\%#30824\fP: (\fI\%alxf\fP) Issue \fI\%#28706\fP: Fix state user.present behavior. (refs: \fI\%#32448\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31851\fP: (\fI\%rhansen\fP) error using module.run \-> saltutil.runner \-> state.orchestrate: \(dqThe following arguments are missing: _fun\(dq (refs: \fI\%#32445\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32445\fP: (\fI\%rallytime\fP) Argument name in docs should match actual arg name
.IP \(bu 2
\fBPR\fP \fI\%#26676\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26648\fP to 2015.5 (refs: \fI\%#32445\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26648\fP: (\fI\%whiteinge\fP) Free \(aqfun\(aq from the function signature namespace (refs: \fI\%#26676\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32033\fP: (\fI\%timcharper\fP) SaltStack \fImodules.dockerng\fP \fI_compare\fP does not handle docker implicit Domainname properly (issue when using network_mode: host) (refs: \fI\%#32116\fP, \fI\%#32432\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32432\fP: (\fI\%ticosax\fP) [dockerng] Fix Domainname introspection
@ \fI2016\-04\-08 16:12:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
a36f9499fc Merge pull request \fI\%#32432\fP from ticosax/fix\-domainname\-introspection
.IP \(bu 2
505b5b0168 Fix Domainname introspection
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32427\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-04\-08 15:39:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
def911974c Merge pull request \fI\%#32427\fP from rallytime/merge\-2015.8
.IP \(bu 2
9531ea6ef5 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
0809126d8e Merge \fI\%#32293\fP with test fixes (\fI\%#32418\fP)
.IP \(bu 2
bbd8260a42 Ignore Raspbian in service.py __virtual__ (\fI\%#32421\fP)
.IP \(bu 2
690addf0b4 FreeBSD supports packages in format java/openjdk7 so the prior commit broke that functionality. Check freebsd/pkg#1409 for more info.
.IP \(bu 2
a36866d7db Merge pull request \fI\%#32399\fP from amontalban/2015.5
.INDENT 2.0
.IP \(bu 2
e1ffbd615a Fixes \fI\%saltstack/salt#28262\fP for 2015.5 branch
.UNINDENT
.IP \(bu 2
3f03c5fcf9 Merge pull request \fI\%#32374\fP from cachedout/issue_32066
.INDENT 2.0
.IP \(bu 2
62389d1d1a Update proxmox documentation
.UNINDENT
.IP \(bu 2
8578089beb Merge pull request \fI\%#32339\fP from Ch3LL/fix_doc_multi\-master
.INDENT 2.0
.IP \(bu 2
2774da288d remove reference to master_alive_check
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32311\fP: (\fI\%rkgrunt\fP) glusterfs module incorrectly indexes into name of bricks  (refs: \fI\%#32312\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32423\fP: (\fI\%justinta\fP) Update glusterfs_test to be inline with \fI\%#32312\fP
@ \fI2016\-04\-07 21:53:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32312\fP: (\fI\%rkgrunt\fP) Fixed glusterfs module (refs: \fI\%#32423\fP)
.IP \(bu 2
5bc8c326ce Merge pull request \fI\%#32423\fP from jtand/glusterfs_test_fix
.IP \(bu 2
6f98bd50eb Update glusterfs_test to be inline with \fI\%#32312\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31632\fP: (\fI\%zieba88\fP) salt\-cloud map parallel provisioning \-P option failed on 2015.8.5 (refs: \fI\%#32425\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32425\fP: (\fI\%cachedout\fP) Fix salt\-cloud parallel provisioning
@ \fI2016\-04\-07 21:52:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
c07e02bacb Merge pull request \fI\%#32425\fP from cachedout/issue_31632
.IP \(bu 2
127c0829ee Fix salt\-cloud parallel provisioning
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32323\fP: (\fI\%mcalmer\fP) fix sorting by latest version when called with an attribute
@ \fI2016\-04\-07 06:24:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
2cc054bbc0 Merge pull request \fI\%#32323\fP from mcalmer/fix\-ensure\-installed\-latest\-with\-attributes
.IP \(bu 2
cb1f30ee10 fix sorting by latest version when called with an attribute
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#28262\fP: (\fI\%palica\fP) FreeBSD pkgng provider raising error for minion (refs: \fI\%#32376\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#28262\fP: (\fI\%palica\fP) FreeBSD pkgng provider raising error for minion (refs: \fI\%#32376\fP, \fI\%#32399\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32376\fP: (\fI\%amontalban\fP) Fixes \fI\%saltstack/salt#28262\fP (refs: \fI\%#32399\fP)
@ \fI2016\-04\-06 20:30:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
802580ee1a Merge pull request \fI\%#32376\fP from amontalban/2015.8
.IP \(bu 2
823d0c362b Fixes \fI\%saltstack/salt#28262\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32375\fP: (\fI\%truescotw\fP) jinja template copying file but not replacing tags (refs: \fI\%#32393\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32393\fP: (\fI\%jfindlay\fP) modules.win_timezone: don\(aqt list all zones in debug log
@ \fI2016\-04\-06 18:10:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
ad77d76cad Merge pull request \fI\%#32393\fP from jfindlay/win_zone
.IP \(bu 2
c01c1b9da2 modules.win_timezone: don\(aqt list all zones in debug log
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32372\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32358\fP to 2015.8
@ \fI2016\-04\-06 16:35:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32358\fP: (\fI\%arthurlogilab\fP) outputter virt_list does not exist anymore (refs: \fI\%#32372\fP)
.IP \(bu 2
76ae95863d Merge pull request \fI\%#32372\fP from rallytime/bp\-32358
.IP \(bu 2
95e0fe7744 outputter virt_list does not exist anymore
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32392\fP: (\fI\%multani\fP) Fix documentation on boto_asg and boto_elb modules and states
@ \fI2016\-04\-06 16:34:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
c612baa119 Merge pull request \fI\%#32392\fP from multani/2015.8
.IP \(bu 2
77c4772752 Fix documentation on boto_asg and boto_elb modules and states
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32201\fP: (\fI\%boltronics\fP) salt\-minion memory leak waiting on master to accept key (refs: \fI\%#32373\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32373\fP: (\fI\%cachedout\fP) Resolve memory leak in authentication
@ \fI2016\-04\-06 15:19:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
b706d3aa4d Merge pull request \fI\%#32373\fP from cachedout/issue_32201
.IP \(bu 2
d9e4a0f372 Resolve memory leak in authentication
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32126\fP: (\fI\%cro\fP) Add a couple CLI examples for the highstate outputter.
@ \fI2016\-04\-05 17:23:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
097aa7ccfc Merge pull request \fI\%#32126\fP from cro/outputter_terse_docs
.IP \(bu 2
dafe279e60 Lint
.IP \(bu 2
abc2de0119 More clarification.
.IP \(bu 2
85221e515b Expand docs for highstate outputter.  Add CLI examples for when \(aqstate_output: filter\(aq is set.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32353\fP: (\fI\%mcalmer\fP) Prevent metadata download when listing installed products
@ \fI2016\-04\-05 17:02:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
eab3b99be2 Merge pull request \fI\%#32353\fP from mcalmer/prevent\-refresh\-on\-list\-installed\-products
.IP \(bu 2
e32212ad53 Prevent metadata download when listing installed products
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32255\fP: (\fI\%jakosky\fP) Salt\-minion 2015.8.8 should display helpful error when regular file /var/log/salt/minion exists but a directory is expected. (refs: \fI\%#32321\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32321\fP: (\fI\%abednarik\fP) Better message when minion fail to start
@ \fI2016\-04\-05 16:28:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
64abec94e7 Merge pull request \fI\%#32321\fP from abednarik/minion_start_fail_log
.IP \(bu 2
4c72adc03a Better message when minion fail to start
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30147\fP: (\fI\%anandnevase\fP) salt.cloud.CloudClient method create() not working for VMware driver (refs: \fI\%#32344\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32345\fP: (\fI\%nmadhok\fP) [2015.8] Check if profile key exists in vm_ dict
@ \fI2016\-04\-05 16:16:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32344\fP: (\fI\%nmadhok\fP) Check if profile key exists in vm_ dict (refs: \fI\%#32345\fP)
.IP \(bu 2
59aca733ea Merge pull request \fI\%#32345\fP from nmadhok/patch\-4
.IP \(bu 2
42d7a54240 Check if profile key exists in vm_ dict
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32343\fP: (\fI\%Ferbla\fP) Fixed win_wua example documentation
@ \fI2016\-04\-05 16:14:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb033c238d Merge pull request \fI\%#32343\fP from Ferbla/2015.8
.IP \(bu 2
e2f0f16564 Fixed win_wua example documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32354\fP: (\fI\%elsmorian\fP) Incorrect capitalisation when telling users to change hash_type to SHA256 (refs: \fI\%#32360\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32360\fP: (\fI\%rallytime\fP) Make sure hash_type is lowercase in master/minion config files
@ \fI2016\-04\-05 16:10:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
3219a8d176 Merge pull request \fI\%#32360\fP from rallytime/fix\-32354
.IP \(bu 2
8b47c205df Make sure hash_type is lowercase in master/minion config files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32361\fP: (\fI\%cro\fP) SDB is no longer experimental
@ \fI2016\-04\-05 16:10:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb530256f6 Merge pull request \fI\%#32361\fP from cro/remove_sdb_exp_flag
.IP \(bu 2
3bbe284d89 Remove \(aqexperimental\(aq warning from SDB docs.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32336\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28639\fP to 2015.8
@ \fI2016\-04\-04 20:53:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28639\fP: (\fI\%RuriRyan\fP) Fixed handling of the disabled option for yumpkg (refs: \fI\%#32336\fP)
.IP \(bu 2
e1ef4a9d66 Merge pull request \fI\%#32336\fP from rallytime/bp\-28639
.IP \(bu 2
0829143dd1 Fixed handling of the disabled option for yumpkg
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32305\fP: (\fI\%Ch3LL\fP) Receiving NoResponse Errors when running commands that take a longer time (refs: \fI\%#32332\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32332\fP: (\fI\%rallytime\fP) Don\(aqt unsubscribe from open events on the CLI too early on long\-running commands
@ \fI2016\-04\-04 20:39:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32145\fP: (\fI\%paclat\fP) fixes 29817 (refs: \fI\%#32332\fP)
.IP \(bu 2
6ee5a9729c Merge pull request \fI\%#32332\fP from rallytime/fix\-32305
.IP \(bu 2
8dc1161c8a Don\(aqt unsubscribe from open events on the CLI too early on long\-running commands
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32333\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-04\-04 20:06:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
22b296d2fd Merge pull request \fI\%#32333\fP from rallytime/merge\-2015.8
.IP \(bu 2
d7b4b8b081 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
fbdc47cc55 Merge pull request \fI\%#32284\fP from rallytime/config\-audit
.INDENT 2.0
.IP \(bu 2
0491513204 Don\(aqt be so explicit. Just use string_types.
.IP \(bu 2
083c477fd3 Use six.string_types in config default tuples
.IP \(bu 2
7e642b8381 Audit config.py default types and values \- first sweep
.UNINDENT
.IP \(bu 2
0a6d44e57b Merge pull request \fI\%#32302\fP from terminalmage/fix\-missing\-release
.INDENT 2.0
.IP \(bu 2
413c371ccd Properly support packages with blank \(dqRelease\(dq param in pkg.latest_version
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32246\fP: (\fI\%danlsgiga\fP) IMPORTANT: Do not use md5 hashing algorithm! Please set \(dqhash_type\(dq to SHA256 in Salt Minion config! (refs: \fI\%#32289\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32289\fP: (\fI\%rallytime\fP) New salt\-cloud instances should not use old hash_type default.
@ \fI2016\-04\-04 17:52:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31162\fP: (\fI\%isbm\fP) Remove MD5 digest from everywhere and default to SHA256 (refs: \fI\%#32289\fP)
.IP \(bu 2
28cc054244 Merge pull request \fI\%#32289\fP from rallytime/fix\-32246
.IP \(bu 2
66acc00c71 New salt\-cloud instances should not use old hash_type default.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#14277\fP: (\fI\%Sacro\fP) Chocolatey.version doesn\(aqt tell you anything informative. (refs: \fI\%#32291\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32291\fP: (\fI\%twangboy\fP) Fix bad output for chocolatey.version (fixes \fI\%#14277\fP)
@ \fI2016\-04\-04 17:50:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
5fb90a1040 Merge pull request \fI\%#32291\fP from twangboy/fix_14277
.IP \(bu 2
53f6a28297 Fix problem with return on installed packages
.IP \(bu 2
f5bd004ab0 Fix chocolatey.version function
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32183\fP: (\fI\%llamallama\fP) Salt Cloud 2015.8.8 not installing salt minions on new nodes (refs: \fI\%#32295\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32295\fP: (\fI\%rallytime\fP) Test the contents of \(aqdeploy_scripts_search_path\(aq in salt.config.cloud_config
@ \fI2016\-04\-04 17:38:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
edbab99164 Merge pull request \fI\%#32295\fP from rallytime/test\-cloud\-deploy\-dir
.IP \(bu 2
4037476f40 Patch call to os.path.isdir so we know both search paths are in tuple
.IP \(bu 2
49a4eec051 Test the contents of \(aqdeploy_scripts_search_path\(aq in salt.config.cloud_config
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23617\fP: (\fI\%porterjamesj\fP) file.managed with proxy broken in 2015.5 (refs: \fI\%#32315\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32315\fP: (\fI\%ahus1\fP) fixing file.managed with requests lib
@ \fI2016\-04\-04 17:20:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
4389680bc5 Merge pull request \fI\%#32315\fP from ahus1/fix_file_managed_http_requests
.IP \(bu 2
a867d23383 ensure streaming mode (use for example by file.managed) will works for requests backend
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#782\fP: (\fI\%ninjada\fP) Bootstrap and Links & Documentation still broken due to fedoraproject redirect to fedorainfracloud.org (refs: \fI\%#32316\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#742\fP: (\fI\%dennisfoconnor\fP) Non\-Development Script Broken on Amazon Linux (refs: \fI\%#32316\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#695\fP: (\fI\%mtippett\fP) Install Failures With Raspbian Jessie (refs: \fI\%#32316\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32316\fP: (\fI\%vutny\fP) Update Salt Bootstrap tutorial
@ \fI2016\-04\-04 17:18:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
9065201761 Merge pull request \fI\%#32316\fP from vutny/update\-bootstrap\-tutorial
.IP \(bu 2
b9698f015d Update Salt Bootstrap tutorial
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32325\fP: (\fI\%bdrung\fP) Re\-add shebang to ssh\-id\-wrapper shell script
@ \fI2016\-04\-04 17:08:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
352f3c01d1 Merge pull request \fI\%#32325\fP from bdrung/fix\-shebang
.IP \(bu 2
ffe585f078 Re\-add shebang to ssh\-id\-wrapper shell script
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32326\fP: (\fI\%bdrung\fP) Fix typos
@ \fI2016\-04\-04 16:41:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
f16e332b3a Merge pull request \fI\%#32326\fP from bdrung/fix\-typos
.IP \(bu 2
a7db152333 Fix typo of don\(aqt
.IP \(bu 2
d4c037301b Fix typo of mismatch
.IP \(bu 2
70dba70ff0 Fix typo of addition
.IP \(bu 2
68c60903aa Fix typo of multiple
.IP \(bu 2
0f2c779b90 Fix typo of function
.IP \(bu 2
0c9e4c8c80 Fix typo of available
.IP \(bu 2
920abe2ec7 Fix typo of formatted
.IP \(bu 2
e56dd4bb23 Fix typo of omitted
.IP \(bu 2
f99e6f1f13 Fix typo of output
.IP \(bu 2
d3804094f2 Fix typo of whether
.IP \(bu 2
538fb6fae2 Fix typo of performed
.IP \(bu 2
db7af998ee Fix typo of sanitized
.IP \(bu 2
d7af01da2b Fix typo of corresponding
.IP \(bu 2
301e78b5be Fix typo of values
.IP \(bu 2
8cada9573f Fix typos of retrieve
.IP \(bu 2
b484d6f9c9 Fix typo of directories
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32300\fP: (\fI\%twangboy\fP) Add documentation to disable winrepo/winrepo_ng
@ \fI2016\-04\-01 21:23:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
664043d7e7 Merge pull request \fI\%#32300\fP from twangboy/fix_28767
.IP \(bu 2
c971a3b054 Add documentation for disabled the winrepos
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18429\fP: (\fI\%somenick\fP) Pillars passed from command\-line override pillar subtrees instead of merging (refs: \fI\%#32288\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32288\fP: (\fI\%terminalmage\fP) use dictupdate.merge instead of dict.update to merge CLI pillar overrides
@ \fI2016\-04\-01 16:30:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
42a25f6b9d Merge pull request \fI\%#32288\fP from terminalmage/issue18429
.IP \(bu 2
db31732137 use dictupdate.merge instead of dict.update to merge CLI pillar overrides
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32243\fP: (\fI\%isbm\fP) Ensure latest pkg.info_installed ensure latest
@ \fI2016\-03\-31 16:09:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e374e7ec6 Merge pull request \fI\%#32243\fP from isbm/isbm\-zypper\-list\-installed\-ensure\-latest
.IP \(bu 2
fba3d509ac Fix the documentation
.IP \(bu 2
73ad8a2bfc Fix lint
.IP \(bu 2
f07c7ea792 Add lowpkg tests for version comparison
.IP \(bu 2
afdf451d87 Remove tests from the zypper_test that belongs to rpm_test
.IP \(bu 2
3706a21c29 Fix condition from returning None on 0
.IP \(bu 2
0a68ebff16 Remove suse/redhat checks, refactor code.
.IP \(bu 2
30c8f7216b Move \(dqstring to EVR\(dq function to the utilities
.IP \(bu 2
fb014a40b0 Sort installed pkgs data by version_cmp
.IP \(bu 2
b57e439d57 Merge yumpkg\(aqs and zypper\(aqs version_cmp for a common use
.IP \(bu 2
ebd13a283c Remove version_cmp from Zypper module and use just lowpkg alias
.IP \(bu 2
b46d5b526a Remove version_cmp from the yumpkg and use just a lowpkg alias
.IP \(bu 2
f4d9881e61 Force\-sort the RPM output to ensure latest version of the multi\-package on top of the list.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32261\fP: (\fI\%arthurlogilab\fP) dockerng : AttributeError: \(aqmodule\(aq object has no attribute \(aqversion_info\(aq (refs: \fI\%#32262\fP, \fI\%#32268\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32268\fP: (\fI\%ticosax\fP) [dockerng] Improve detection for older versions of docker\-py
@ \fI2016\-03\-31 14:51:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32262\fP: (\fI\%arthurlogilab\fP) Catch Attribute Error when docker.version_info doesn\(aqt exist (refs: \fI\%#32268\fP)
.IP \(bu 2
88fa3c5f71 Merge pull request \fI\%#32268\fP from ticosax/handle\-dockerpy\-old
.IP \(bu 2
05116aaa40 Improve detection for older versions of docker\-py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32258\fP: (\fI\%jacobhammons\fP) Replaces incorrect reference to \fImaster_alive_check\fP
@ \fI2016\-03\-31 14:41:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
a491897a3b Merge pull request \fI\%#32258\fP from jacobhammons/alive\-interval\-docs
.IP \(bu 2
ff8ca5ac2e Replaces incorrect reference to \fImaster_alive_check\fP with \fImaster_alive_interval\fP in docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32254\fP: (\fI\%twangboy\fP) Fix Display Name with spaces in win_servermanager
@ \fI2016\-03\-31 14:38:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
8c68d8ac41 Merge pull request \fI\%#32254\fP from twangboy/fix_31334
.IP \(bu 2
e5f02c52be Fix a pylint error
.IP \(bu 2
5ca4ad6675 Fix unit tests for state
.IP \(bu 2
12d530f8f0 Fix win_servermanager state
.IP \(bu 2
b26cb76abb Fix unit tests
.IP \(bu 2
1d5bcee390 Fix 31344
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32248\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-03\-30 21:10:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
0f5e67de5d Merge pull request \fI\%#32248\fP from rallytime/merge\-2015.8
.IP \(bu 2
d743f8cc4e Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.INDENT 2.0
.IP \(bu 2
5d08db7c92 Merge pull request \fI\%#32162\fP from terminalmage/issue31963
.INDENT 2.0
.IP \(bu 2
5c1bdb812c Fix pkgrepo integration test
.IP \(bu 2
e7fb3095ce Properly handle yum/zypper repositories in pkgrepo.managed
.IP \(bu 2
add2111fec Use six.iteritems instead of dict.items
.IP \(bu 2
6c21881c38 Docstring tweaks
.IP \(bu 2
ecbb78b649 Remove useless function
.IP \(bu 2
06f3309552 Normalize variable naming to match other functions
.IP \(bu 2
690537ca8b Look for apt\-add\-repository in PATH instead of assuming it\(aqs there
.IP \(bu 2
709d80bb1b aptpkg: Accept **kwargs instead of a dict for pkg.expand_repo_def
.UNINDENT
.IP \(bu 2
4fcdaab428 Merge pull request \fI\%#32223\fP from twangboy/fix_31976
.INDENT 2.0
.IP \(bu 2
b7fcae97ce Create minion.d directory, fixes \fI\%#31976\fP
.UNINDENT
.IP \(bu 2
3309ff6a29 Merge pull request \fI\%#32218\fP from cachedout/issue_31501
.INDENT 2.0
.IP \(bu 2
6795d6aef0 Only display error when tty is True in salt\-ssh
.UNINDENT
.IP \(bu 2
6e0cb22c96 Merge pull request \fI\%#32196\fP from jtand/cherrypy_pam_test_lint_fix
.INDENT 2.0
.IP \(bu 2
bd3942e0fd Fixed pylint error in app_pam_test.py
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32169\fP: (\fI\%sknutsonsf\fP) CommandNotFoundError: update\-rc.d during service.enabled on Centos 7 (refs: \fI\%#32230\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32230\fP: (\fI\%terminalmage\fP) systemd.py: Support both update\-rc.d and chkconfig as managers of sysv services
@ \fI2016\-03\-30 21:09:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
6216c37885 Merge pull request \fI\%#32230\fP from terminalmage/issue32169
.IP \(bu 2
45af3e902a systemd.py: Support both update\-rc.d and chkconfig as managers of sysv services
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32249\fP: (\fI\%jacobhammons\fP) Fixes windows download paths to account for patch
@ \fI2016\-03\-30 20:26:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
bde2a1fc98 Merge pull request \fI\%#32249\fP from jacobhammons/dot8
.IP \(bu 2
50d1df2482 Fixes windows download paths to account for patch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32221\fP: (\fI\%dmurphy18\fP) Fix version check, fix extracting Major and Minor versions from __ver…
@ \fI2016\-03\-30 14:50:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
1d9321d043 Merge pull request \fI\%#32221\fP from dmurphy18/fix_version_check
.IP \(bu 2
96cf024e63 Fix version check, fix extracting Major and Minor versions from __version__
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32031\fP: (\fI\%travispaul\fP) Unable to manage Windows services that contain a space in the service name (refs: \fI\%#32227\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32227\fP: (\fI\%twangboy\fP) Remove list2cmdline usage from win_service.py
@ \fI2016\-03\-30 14:43:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
22bd1e6b29 Merge pull request \fI\%#32227\fP from twangboy/fix_32031
.IP \(bu 2
58772b036d Remove list2cmdline usage
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32239\fP: (\fI\%anlutro\fP) Add state file name to warning log line
@ \fI2016\-03\-30 14:37:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
7fce438b67 Merge pull request \fI\%#32239\fP from alprs/fix\-file_log_warning
.IP \(bu 2
72adae3702 add state file name to log line
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31365\fP: (\fI\%cwicklein\fP) osrelease_info broken for CentOS 7 (refs: \fI\%#32215\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32215\fP: (\fI\%DmitryKuzmenko\fP) rhel oscodename
@ \fI2016\-03\-29 19:14:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
3c3028f347 Merge pull request \fI\%#32215\fP from DSRCompany/issues/rhel_oscodename
.IP \(bu 2
dc2a3b81ac Ignore lsb codename from os\-release for newest RHEL
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32217\fP: (\fI\%jacobhammons\fP) 2015.8.8.2 release notes
@ \fI2016\-03\-29 17:53:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf59f06733 Merge pull request \fI\%#32217\fP from jacobhammons/dot8
.IP \(bu 2
596444e2b4 2015.8.8.2 release notes Adds banner notifying user when they are viewing release notes for an old release
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31844\fP: (\fI\%Talkless\fP) slspath is not documented (refs: \fI\%#32197\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32212\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32197\fP to 2015.8
@ \fI2016\-03\-29 15:50:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32197\fP: (\fI\%twellspring\fP) documentation fix issue 31844 (refs: \fI\%#32212\fP)
.IP \(bu 2
ab8b70d985 Merge pull request \fI\%#32212\fP from rallytime/bp\-32197
.IP \(bu 2
5fdd81ace9 documentation fix issue 31844
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31931\fP: (\fI\%gravyboat\fP) Ordering States documentation should note top.sls adheres to this rule (refs: \fI\%#32193\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32211\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32210\fP to 2015.8
@ \fI2016\-03\-29 15:50:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32210\fP: (\fI\%rallytime\fP) Merge \fI\%#32193\fP with pylint fix (refs: \fI\%#32211\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32193\fP: (\fI\%twellspring\fP) Documentation fix 31931 (refs: \fI\%#32210\fP, \fI\%#32211\fP)
.IP \(bu 2
200d82cc3e Merge pull request \fI\%#32211\fP from rallytime/bp\-32210
.IP \(bu 2
7b9c05487c Whitespace fix.
.IP \(bu 2
abd432746c documentation\-fix\-31931
.IP \(bu 2
79086f8f04 service.py documentation update for 32084
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32084\fP: (\fI\%guettli\fP) Docs: Please provide a link from \(dqservice.running\(dq to \(dqwatch\(dq (refs: \fI\%#32192\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32209\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32208\fP to 2015.8
@ \fI2016\-03\-29 15:50:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32208\fP: (\fI\%rallytime\fP) Merge \fI\%#32192\fP with pylint fix (refs: \fI\%#32209\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32192\fP: (\fI\%twellspring\fP) service.py documentation update for 32084 (refs: \fI\%#32208\fP, \fI\%#32209\fP)
.IP \(bu 2
32da8d4c57 Merge pull request \fI\%#32209\fP from rallytime/bp\-32208
.IP \(bu 2
777a2c4e83 Whitespace fix.
.IP \(bu 2
e3db0640ec service.py documentation update for 32084
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31595\fP: (\fI\%dverbeek84\fP) dockerng ports specified in Dockerfile must be in sls file otherwise salt gives an error (refs: \fI\%#32204\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32204\fP: (\fI\%ticosax\fP) [dockerng] Consider labels carried by the image when comparing user defined labels.
@ \fI2016\-03\-29 14:39:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
7154104591 Merge pull request \fI\%#32204\fP from ticosax/label\-from\-image
.IP \(bu 2
c989ae5a7e Merge user defined labels with one carried by the image
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32186\fP: (\fI\%rallytime\fP) Add some \(dqbest practices\(dq information to test documentation
@ \fI2016\-03\-29 00:22:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
5877a19f59 Merge pull request \fI\%#32186\fP from rallytime/testing\-docs
.IP \(bu 2
40d09c822e Add some \(dqbest practices\(dq information to test documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32176\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-03\-28 23:16:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
b44adffc12 Merge pull request \fI\%#32176\fP from rallytime/merge\-2015.8
.IP \(bu 2
e8658697a6 Pylint fix for integration import
.IP \(bu 2
527bc3e491 Pylint fix
.IP \(bu 2
e9abd2d420 Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
6b8b8b51c0 Merge pull request \fI\%#32154\fP from Ch3LL/ch3ll_pam_2015.5
.INDENT 2.0
.IP \(bu 2
ba605b0128 fix more pylint and add ability to close cherrypy engine
.IP \(bu 2
2d4dc4da05 add teardown call
.IP \(bu 2
d115878714 fix pylint error
.IP \(bu 2
4c1ab082b6 add pam salt\-api tests
.UNINDENT
.IP \(bu 2
230443be6c Merge pull request \fI\%#32170\fP from gtmanfred/lxc_cloud_name
.INDENT 2.0
.IP \(bu 2
eb7d82e7be add name for lxc for use with cloud cache
.UNINDENT
.IP \(bu 2
32b0421a34 Merge pull request \fI\%#32164\fP from terminalmage/issue31731\-2015.5
.INDENT 2.0
.IP \(bu 2
18439c4f89 Make __virtual__ for rhservice.py more robust (2015.5 branch)
.UNINDENT
.IP \(bu 2
6212e9aa56 Merge pull request \fI\%#32141\fP from paclat/issue_32108
.INDENT 2.0
.IP \(bu 2
72c5d12d43 fixes 32108
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27605\fP: (\fI\%jmcook1\fP) nacl module documentation/possible bug (refs: \fI\%#32163\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32163\fP: (\fI\%rallytime\fP) Update nacl.config docs to use key value instead of \(aqNone\(aq
@ \fI2016\-03\-28 14:46:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
1afb048801 Merge pull request \fI\%#32163\fP from rallytime/fix\-27605
.IP \(bu 2
e2d09f57dc Update nacl.config docs to use key value instead of \(aqNone\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32166\fP: (\fI\%vutny\fP) \fIsalt.states.file\fP: correct examples with multiline YAML string
@ \fI2016\-03\-28 14:45:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
c08ba3f8a9 Merge pull request \fI\%#32166\fP from vutny/fix\-multiline\-yaml\-string\-example
.IP \(bu 2
34aaea93b4 Another indentation fix in \fIsalt.states.alternatives\fP
.IP \(bu 2
85d0576583 \fIsalt.states.file\fP: correct examples with multiline YAML string
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32168\fP: (\fI\%rallytime\fP) Lint 2015.8
@ \fI2016\-03\-27 18:26:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
f2e986cf65 Merge pull request \fI\%#32168\fP from rallytime/lint\-2015.8
.IP \(bu 2
ba6b19d72c Lint 2015.8
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31731\fP: (\fI\%sjorge\fP) rh_service references osrelease before it is available, also does not return bool (refs: \fI\%#32165\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32165\fP: (\fI\%terminalmage\fP) Make __virtual__ for rhservice.py more robust (refs: \fI\%#32164\fP)
@ \fI2016\-03\-27 18:21:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32164\fP: (\fI\%terminalmage\fP) Make __virtual__ for rhservice.py more robust (2015.5 branch) (refs: \fI\%#32165\fP)
.IP \(bu 2
ae472617af Merge pull request \fI\%#32165\fP from terminalmage/issue31731
.IP \(bu 2
559eb7da52 Make __virtual__ for rhservice.py more robust
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31944\fP: (\fI\%Inveracity\fP) traceback in _determine_beacon_config(...) in beacon/__init__.py line 105 (refs: \fI\%#32160\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32160\fP: (\fI\%cachedout\fP) Fix beacon tutorial docs
@ \fI2016\-03\-25 22:32:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
63c8bf3542 Merge pull request \fI\%#32160\fP from cachedout/issue_31944
.IP \(bu 2
104ada5b6f Fix beacon tutorial docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32145\fP: (\fI\%paclat\fP) fixes 29817 (refs: \fI\%#32332\fP)
@ \fI2016\-03\-25 16:55:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
bff94a5160 Merge pull request \fI\%#32145\fP from paclat/issue_29817
.IP \(bu 2
5d970ca031 fixes 29817
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32133\fP: (\fI\%basepi\fP) Pass eauth user/groups through salt\-api to destination functions
@ \fI2016\-03\-25 16:49:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
245249d347 Merge pull request \fI\%#32133\fP from basepi/api_user_passthrough
.IP \(bu 2
41ba309839 Change the kwarg names to be more specific
.IP \(bu 2
40f7e596d8 Pass eauth user/groups through salt\-api to destination functions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32127\fP: (\fI\%rallytime\fP) Add runners to __salt__ docs
@ \fI2016\-03\-25 15:54:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
a09aa18036 Merge pull request \fI\%#32127\fP from rallytime/dunder\-docs
.IP \(bu 2
482690ef33 Add note to docs about __salt__ referencing runner modules
.IP \(bu 2
a11d2e413a Add runners to __salt__ docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30183\fP: (\fI\%jakehilton\fP) Minion startup extremely delayed when first master in failover multi master setup is down (refs: \fI\%#31364\fP, \fI\%#31382\fP, \fI\%#32143\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32143\fP: (\fI\%DmitryKuzmenko\fP) Set auth retry count to 0 if multimaster mode is failover.
@ \fI2016\-03\-25 15:23:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31382\fP: (\fI\%DmitryKuzmenko\fP) Set auth retry count to 0 if multimaster mode is failover (refs: \fI\%#32143\fP)
.IP \(bu 2
cc224b877a Merge pull request \fI\%#32143\fP from DSRCompany/issues/30183_failover_fix
.IP \(bu 2
93d34a2573 Set auth retry count to 0 if multimaster mode is failover.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32134\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-03\-25 15:22:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
0679a61871 Merge pull request \fI\%#32134\fP from rallytime/merge\-2015.8
.IP \(bu 2
6886681410 Fix test failures
.IP \(bu 2
7554d0f42d Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.INDENT 2.0
.IP \(bu 2
bdd7ea89d5 Merge pull request \fI\%#32129\fP from terminalmage/issue32044
.INDENT 2.0
.IP \(bu 2
34ca1ea12e Change type check errors to debug loglevel
.IP \(bu 2
5462081488 Support multiple valid option types when performing type checks
.UNINDENT
.IP \(bu 2
c42014eb54 Merge pull request \fI\%#32056\fP from bstevenson/fix\-list_absent
.INDENT 2.0
.IP \(bu 2
1500aae027 set deleted value to list
.IP \(bu 2
1dc8f5f289 unit test update
.IP \(bu 2
39adf86fec Fixed negation logic
.IP \(bu 2
be9388173b Removed has_key in lieu of in
.IP \(bu 2
e48593ed81 Comments and Changes output fixes
.IP \(bu 2
b98f5517de Updated to conform to proper ret values
.IP \(bu 2
d18b4be80b remove whitespace end of line 186:q
.IP \(bu 2
d2b89c85ad fix formatting
.IP \(bu 2
103cee9e29 cleaned up formatting
.IP \(bu 2
7a4d7f0bff added whitespace
.IP \(bu 2
8ea5b545b0 Loop through list values in list_absent
.UNINDENT
.IP \(bu 2
848ce5647f Merge pull request \fI\%#32096\fP from rallytime/bp\-32065
.INDENT 2.0
.IP \(bu 2
36a9d6a374 Fix an issue with the minion targeting example
.UNINDENT
.IP \(bu 2
9b332d48b9 Merge pull request \fI\%#32104\fP from jacobhammons/dot10
.INDENT 2.0
.IP \(bu 2
b9fc882a1e One additional known issue for 2015.5.10 release notes
.UNINDENT
.IP \(bu 2
ff51d548e1 Merge pull request \fI\%#32100\fP from jacobhammons/dot10
.INDENT 2.0
.IP \(bu 2
544a1661ce 2015.5.10 release docs
.UNINDENT
.IP \(bu 2
72a20f9799 Merge pull request \fI\%#32038\fP from terminalmage/issue32037
.INDENT 2.0
.IP \(bu 2
8b2d983324 Add reference to state tutorial to state.apply docstring
.IP \(bu 2
9b4fe8443e Move highstate usage details to top of state.apply docstring
.IP \(bu 2
74ee8c54bc Clarify prior role of state.highstate in states tutorial
.IP \(bu 2
1b97e4a3df Improve state module docs, replace references to state.highstate/state.sls with state.apply
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26129\fP: (\fI\%GreatSnoopy\fP) salt yumpkg implementation painfully slow in some circumstances (refs: \fI\%#32091\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32091\fP: (\fI\%clarkperkins\fP) Fixed the regression in 410da78
@ \fI2016\-03\-25 14:53:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
ad924226ca Merge pull request \fI\%#32091\fP from clarkperkins/bugfix/yumpkg\-repoquery
.IP \(bu 2
d2119ea608 Added comment so this issue doesn\(aqt regress again
.IP \(bu 2
1455fab9e3 Fixed the regression in 410da78
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32044\fP: (\fI\%ScoreUnder\fP) Multiple masters throwing warnings? \(dqKey master with value [...] has an invalid type of list, a str is required for this value\(dq (refs: \fI\%#32129\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32135\fP: (\fI\%rallytime\fP) [2015.8] Support multiple valid option types when performing type checks
@ \fI2016\-03\-24 22:42:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32129\fP: (\fI\%terminalmage\fP) Support multiple valid option types when performing type checks (refs: \fI\%#32135\fP, \fI\%#32284\fP)
.IP \(bu 2
b84908d51f Merge pull request \fI\%#32135\fP from rallytime/32129\-to\-2915.8
.IP \(bu 2
7d43bdd721 Change type check errors to debug loglevel
.IP \(bu 2
ed5abf4381 Support multiple valid option types when performing type checks
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31760\fP: (\fI\%sakateka\fP) SMinion need wait future from eval_master
@ \fI2016\-03\-24 22:08:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
b23a08f3f4 Merge pull request \fI\%#31760\fP from sakateka/fix_master_switch
.IP \(bu 2
3d7874029a Run self.eval_master in self.io_loop.run_sync
.IP \(bu 2
3b4425652b SMinion need wait future from eval_master
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32106\fP: (\fI\%jfindlay\fP) update suse master service patch
@ \fI2016\-03\-24 21:34:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
5efe37ddc8 Merge pull request \fI\%#32106\fP from jfindlay/suse_patch
.IP \(bu 2
8de84b4251 update suse master service patch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32130\fP: (\fI\%jacobhammons\fP) Added known issues 32004 and 32044 to 2015.8.8 release notes
@ \fI2016\-03\-24 19:59:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
939c1b17d5 Merge pull request \fI\%#32130\fP from jacobhammons/dot8
.IP \(bu 2
21eee08842 Added known issues 32004 and 32044 to 2015.8.8 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32105\fP: (\fI\%clarkperkins\fP) Fixed invalid deploy_scripts_search_path
@ \fI2016\-03\-24 17:36:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d8abf4717 Merge pull request \fI\%#32105\fP from clarkperkins/bugfix/invalid\-deploy\-script\-path
.IP \(bu 2
5a9f4e947e Fixed invalid deploy_scripts_search_path
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32114\fP: (\fI\%tomlaredo\fP) Wrong validation type for file_ignore_glob key (refs: \fI\%#32117\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32117\fP: (\fI\%tomlaredo\fP) Fixed validation type for file_ignore_glob
@ \fI2016\-03\-24 17:28:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
fe4112d7f9 Merge pull request \fI\%#32117\fP from rodacom/fix_32114
.IP \(bu 2
c6f83ba00b Fixed validation type for file_ignore_glob Fixes \fI\%#32114\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32113\fP: (\fI\%sakateka\fP) Fix log message for AsyncAuth initialization
@ \fI2016\-03\-24 17:27:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
93d86d249c Merge pull request \fI\%#32113\fP from sakateka/correct_log_message
.IP \(bu 2
71148d77ab Fix log message for AsyncAuth initialization
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32033\fP: (\fI\%timcharper\fP) SaltStack \fImodules.dockerng\fP \fI_compare\fP does not handle docker implicit Domainname properly (issue when using network_mode: host) (refs: \fI\%#32116\fP, \fI\%#32432\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32116\fP: (\fI\%ticosax\fP) Obtain default value of \fImemory_swap\fP from the container.
@ \fI2016\-03\-24 15:56:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
294177f428 Merge pull request \fI\%#32116\fP from ticosax/memory_swap\-default\-from\-container
.IP \(bu 2
fe439db4d3 Obtain default value of \fImemory_swap\fP from the container.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32098\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32083\fP to 2015.8
@ \fI2016\-03\-23 21:49:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32083\fP: (\fI\%guettli\fP) \(dqFire Event Notifications\(dq moved down (refs: \fI\%#32098\fP)
.IP \(bu 2
d5bb8f6372 Merge pull request \fI\%#32098\fP from rallytime/bp\-32083
.IP \(bu 2
4a3a6629ce \(dqFire Event Notifications\(dq moved down
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32099\fP: (\fI\%jacobhammons\fP) 2015.8.8 release docs
@ \fI2016\-03\-23 20:02:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
e45107ce96 Merge pull request \fI\%#32099\fP from jacobhammons/dot8
.IP \(bu 2
8ec5d989ad 2015.8.8 release docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32088\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-03\-23 17:52:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
9e11f3aac5 Merge pull request \fI\%#32088\fP from rallytime/merge\-2015.8
.IP \(bu 2
59c3b7e82e Merge branch \(aq2015.5\(aq into \(aq2015.8\(aq
.IP \(bu 2
908a7bf5cd Merge pull request \fI\%#32051\fP from terminalmage/fix\-state\-apply\-output
.INDENT 2.0
.IP \(bu 2
7d7cb45565 Fix outputter for state.apply
.UNINDENT
.IP \(bu 2
0e66f678d4 Merge pull request \fI\%#32002\fP from abednarik/pkg_manjaron_issue31788
.INDENT 2.0
.IP \(bu 2
1b052d0a66 Added Manajro Linux to virtual. List extended with ManajaroLinux in order su load pacman module.
.UNINDENT
.IP \(bu 2
ba5bf62c1a Merge pull request \fI\%#31957\fP from rallytime/merge\-2015.5
.INDENT 2.0
.IP \(bu 2
1b6ec5d445 Merge branch \(aq2014.7\(aq into \(aq2015.5\(aq
.INDENT 2.0
.IP \(bu 2
ba73deee46 Merge pull request \fI\%#31929\fP from twangboy/fix_build_script
.IP \(bu 2
2c5599d2bc Backport build script from 2015.8
.IP \(bu 2
ce74991dd0 Fix nsi script to work with new build process
.UNINDENT
.UNINDENT
.IP \(bu 2
a52e3ad7a1 Merge pull request \fI\%#31972\fP from terminalmage/zh\-584
.INDENT 2.0
.IP \(bu 2
1e5639e495 Make lack of python\-ldap module more explicit when LDAP eauth is enabled
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32074\fP: (\fI\%Xiami2012\fP) Fix code for proto args in modules.iptables
@ \fI2016\-03\-23 16:37:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
bc9a899bc8 Merge pull request \fI\%#32074\fP from Xiami2012/fix_iptables
.IP \(bu 2
aae3af7e49 Fix code for proto args in modules.iptables
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32053\fP: (\fI\%basepi\fP) [2015.8] Fix rabbitmq_user.present tag handling
@ \fI2016\-03\-22 20:33:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e08dd0a93 Merge pull request \fI\%#32053\fP from basepi/fix_rabbitmq
.IP \(bu 2
95c08f55e9 Tear out useless unit test
.IP \(bu 2
bed048e1e7 Remove leftover arg (lint)
.IP \(bu 2
08868cb32a Fix tag handling code for rabbitmq_user.present
.IP \(bu 2
3b6d25b4e9 Remove leading whitespace on tags
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32004\fP: (\fI\%sjorge\fP) win_dacl module stacktrace: NameError: name \(aqntsecuritycon\(aq is not defined (refs: \fI\%#32023\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32023\fP: (\fI\%sbreidba\fP) Move constant declaration into member variable to avoid issues when m…
@ \fI2016\-03\-21 20:18:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
553ecaca25 Merge pull request \fI\%#32023\fP from sbreidba/bugfix_32004
.IP \(bu 2
711a0a9844 Move constant declaration into member variable to avoid issues when modules can\(aqt be loaded.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32026\fP: (\fI\%techhat\fP) Don\(aqt require the decode_out file to already exist
@ \fI2016\-03\-21 20:17:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
65c634d197 Merge pull request \fI\%#32026\fP from techhat/decodeout
.IP \(bu 2
f27da41b71 Don\(aqt require the decode_out file to already exist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32019\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32012\fP to 2015.8
@ \fI2016\-03\-21 15:54:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32012\fP: (\fI\%jfray\fP) There were two identical blocks concerning Windows Deploy Timeouts. This (refs: \fI\%#32019\fP)
.IP \(bu 2
1d4246bfd7 Merge pull request \fI\%#32019\fP from rallytime/bp\-32012
.IP \(bu 2
26eee1505f There were two identical blocks concerning Windows Deploy Timeouts. This pull request removes the extra block of text.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32013\fP: (\fI\%timcharper\fP) SaltStack dockerng.running state ports configuration responding to Docker\(aqs injection of UDP params (refs: \fI\%#32015\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32015\fP: (\fI\%ticosax\fP) [dockerng] Fix ports exposition when protocol is passed.
@ \fI2016\-03\-21 15:22:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
d117db3efb Merge pull request \fI\%#32015\fP from ticosax/fix\-port\-comparison\-udp
.IP \(bu 2
e511864a55 Fix ports exposition when protocol is passed.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31999\fP: (\fI\%jacobhammons\fP) Fixes a doc build exception caused by missing mocks for modules.win_dacl
@ \fI2016\-03\-19 15:49:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
c72ab6a073 Merge pull request \fI\%#31999\fP from jacobhammons/mock\-modules2
.IP \(bu 2
31bb573abc Fixes a doc build exception caused by missing mocks for modules.win_dacl
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31992\fP: (\fI\%notpeter\fP) salt\-cloud: add D2 and G2 EC2 instance types
@ \fI2016\-03\-18 21:37:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
398ab909f0 Merge pull request \fI\%#31992\fP from notpeter/2015.8
.IP \(bu 2
e3854c8569 D2 and G2 EC2 instance types.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31981\fP: (\fI\%lloydoliver\fP) include rotational disks in grains under linux
@ \fI2016\-03\-18 15:54:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
ad8ada7eef Merge pull request \fI\%#31981\fP from lloydoliver/linux\-disk\-grain\-fix
.IP \(bu 2
9c44604438 include rotational disks in grains under linux
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31970\fP: (\fI\%twangboy\fP) Add apply_template_on_contents for windows
@ \fI2016\-03\-18 15:37:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
9be508e8f0 Merge pull request \fI\%#31970\fP from twangboy/fix_win_file
.IP \(bu 2
dfeae191c1 Add apply_template_on_contents for windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31960\fP: (\fI\%aletourneau\fP) fixed ec2 get_console_output
@ \fI2016\-03\-18 15:13:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
810c6dbcbe Merge pull request \fI\%#31960\fP from aletourneau/2015.8_ec2\-getconsoleoutput
.IP \(bu 2
8305978879 fixed ec2 get_console_output
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31958\fP: (\fI\%rallytime\fP) [2015.8] Merge forward from 2015.5 to 2015.8
@ \fI2016\-03\-18 15:12:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
1c7dc364ad Merge pull request \fI\%#31958\fP from rallytime/merge\-2015.8
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31935\fP: (\fI\%twangboy\fP) Back port nullsoft build script from 2015.8
@ \fI2016\-03\-17 14:54:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d1f2a0c2e Merge pull request \fI\%#31935\fP from twangboy/fix_build_script2
.IP \(bu 2
4af8c9dbfc Back port nullsoft build script from 2015.8
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31912\fP: (\fI\%jfindlay\fP) log.mixins: remove extemporaneous .record
@ \fI2016\-03\-16 01:56:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
43240dc566 Merge pull request \fI\%#31912\fP from jfindlay/log_mixin
.IP \(bu 2
9f9c694654 log.mixins: remove extemporaneous .record
.UNINDENT
.UNINDENT
.SS Salt 2015.5.0 Release Notes \- Codename Lithium
.sp
The 2015.5.0 feature release of Salt is focused on hardening Salt and mostly
on improving existing systems. A few major additions are present, primarily
the new Beacon system. Most enhancements have been focused around improving
existing features and interfaces.
.sp
As usual the release notes are not exhaustive and primarily include the most
notable additions and improvements. Hundreds of bugs have been fixed and many
modules have been substantially updated and added.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
In order to fix potential shell injection vulnerabilities in salt modules,
a change has been made to the various \fBcmd\fP module functions. These
functions now default to \fBpython_shell=False\fP, which means that the
commands will not be sent to an actual shell.
.sp
The largest side effect of this change is that \(dqshellisms\(dq, such as pipes,
will not work by default. The modules shipped with salt have been audited
to fix any issues that might have arisen from this change.  Additionally,
the \fBcmd\fP state module has been unaffected, and use of \fBcmd.run\fP in
jinja is also unaffected. \fBcmd.run\fP calls on the CLI will also allow
shellisms.
.sp
However, custom execution modules which use shellisms in \fBcmd\fP calls
will break, unless you pass \fBpython_shell=True\fP to these calls.
.sp
As a temporary workaround, you can set \fBcmd_safe: False\fP in your minion
and master configs. This will revert the default, but is also less secure,
as it will allow shell injection vulnerabilities to be written in custom
code. We recommend you only set this setting for as long as it takes to
resolve these issues in your custom code, then remove the override.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Starting in this version of salt, \fBpillar_opts\fP defaults to False instead
of True. This means that master opts will not be present in minion pillar,
and as a result, \fBconfig.get\fP calls will not include master opts.
.sp
We recommend pillar is used for configuration options which need to make it
to the minion.
.UNINDENT
.UNINDENT
.SS Beacons
.sp
The beacon system allows the minion to hook into system processes and
continually translate external events into the salt event bus. The primary
example of this is the \fI\%inotify\fP beacon. This beacon uses
inotify to watch configured files or directories on the minion for changes,
creation, deletion etc.
.sp
This allows for the changes to be sent up to the master where the reactor can
respond to changes.
.SS Sudo Minion Settings
.sp
It is now possible to run the minion as a non\-root user and for the minion to
execute commands via sudo. Simply add \fIsudo_user: root\fP to the minion config,
run the minion as a non\-root user and grant that user sudo rights to execute
salt\-call.
.SS Lazy Loader
.sp
The Lazy Loader is a significant overhaul of Salt\(aqs module loader system. The
Lazy Loader will lazily load modules on access instead of all on start. In
addition to a major performance improvement, this \(dqsandboxes\(dq modules so a
bad/broken import of a single module will only affect jobs that require
accessing the broken module. (:issue: \fI20274\fP)
.SS Enhanced Active Directory Support
.sp
The eauth system for LDAP has been extended to support Microsoft Active
Directory out of the box. This includes Active Directory and LDAP group support
for eauth.
.SS Salt LXC Enhancements
.sp
The LXC systems have been overhauled to be more consistent and to fix many
bugs.
.sp
This overhaul makes using LXC with Salt much easier and substantially improves
the underlying capabilities of Salt\(aqs LXC integration.
.SS Salt SSH
.INDENT 0.0
.IP \(bu 2
Additional configuration options and command line flags have been added to
configure the scan roster on the fly
.IP \(bu 2
Added support for \fBstate.single\fP in \fBsalt\-ssh\fP
.IP \(bu 2
Added support for \fBpublish.publish\fP, \fBpublish.full_data\fP, and
\fBpublish.runner\fP in \fBsalt\-ssh\fP
.IP \(bu 2
Added support for \fBmine.get\fP in \fBsalt\-ssh\fP
.UNINDENT
.SS New Windows Installer
.sp
The new Windows installer changes how Salt is installed on Windows.
The old installer used bbfreeze to create an isolated python environment to
execute in. This made adding modules and python libraries difficult. The new
installer sets up a more flexible python environment making it easy to manage
the python install and add python modules.
.sp
Instead of frozen packages, a full python implementation resides in the bin
directory (\fBC:\esalt\ebin\fP). By executing pip or easy_install from within the
Scripts directory (\fBC:\esalt\ebin\eScripts\fP) you can install any additional
python modules you may need for your custom environment.
.sp
The .exe\(aqs that once resided at the root of the salt directory (\fBC:\esalt\fP)
have been replaced by .bat files and should function the same way as the .exe\(aqs
in previous versions.
.sp
The new Windows Installer will not replace the minion config file and key if
they already exist on the target system. Only the salt program files will be
replaced. \fBC:\esalt\econf\fP and \fBC:\esalt\evar\fP will remain unchanged.
.SS Removed Requests Dependency
.sp
The hard dependency on the requests library has been removed. Requests is still
required by a number of cloud modules but is no longer required for normal Salt
operations.
.sp
This removal fixes issues that were introduced with requests and salt\-ssh, as
well as issues users experienced from the many different packaging methods used
by requests package maintainers.
.SS Python 3 Updates
.sp
While Salt does not YET run on Python 3 it has been updated to INSTALL on
Python 3, taking us one step closer. What remains is getting the test suite to
the point where it can run on Python 3 so that we can verify compatibility.
.SS RAET Additions
.sp
The RAET support continues to improve. RAET now supports multi\-master and many
bugs and performance issues have been fixed. RAET is much closer to being a
first class citizen.
.SS Modified File Detection
.sp
A number of functions have been added to the RPM\-based package managers to
detect and diff files that are modified from the original package installs.
This can be found in the new pkg.modified functions.
.SS Reactor Update
.sp
Fix an infinite recursion problem for runner/wheel reactor jobs by passing a
\(dquser\(dq (Reactor) to all jobs that the reactor starts. The reactor skips all
events created by that username \-\- thereby only reacting to events not caused
by itself. Because of this, runner and wheel executions from the runner will
have user \(dqReactor\(dq in the job cache.
.SS Misc Fixes/Additions
.INDENT 0.0
.IP \(bu 2
SDB driver for etcd. (:issue: \fI22043\fP)
.IP \(bu 2
Add \fBonly_upgrade\fP argument to apt\-based \fBpkg.install\fP to only install a
package version if the package is already installed. (Great for security
updates!)
.IP \(bu 2
Joyent now requires a \fBkeyname\fP to be specified in the provider
configuration. This change was necessitated upstream by the 7.0+ API.
.IP \(bu 2
Add \fBargs\fP argument to \fBcmd.script_retcode\fP to match \fBcmd.script\fP in
the \fBcmd module\fP\&. (:issue: \fI21122\fP)
.IP \(bu 2
Fixed bug where TCP keepalive was not being sent on the defined interval on
the return port (4506) from minion to master. (:issue: \fI21465\fP)
.IP \(bu 2
LocalClient may now optionally raise SaltClientError exceptions. If using
this class directly, checking for and handling this exception is recommended.
(:issue: \fI21501\fP)
.IP \(bu 2
The SAuth object is now a singleton, meaning authentication state is global
(per master) on each minion. This reduces sign\-ins of minions from 3\->1 per
startup.
.IP \(bu 2
Nested outputter has been optimized, it is now much faster.
.IP \(bu 2
Extensive fileserver backend updates.
.UNINDENT
.SS Deprecations
.INDENT 0.0
.IP \(bu 2
Removed \fBparameter\fP keyword argument from \fBeselect.exec_action\fP execution
module.
.IP \(bu 2
Removed \fBrunas\fP parameter from the following \fBpip\(ga\fP execution module
functions: \fBinstall\fP, \fBuninstall\fP, \fBfreeze\fP, \fBlist_\fP,
\fBlist_upgrades\fP, \fBupgrade_available\fP, \fBupgrade\fP\&. Please migrate to
\fBuser\fP\&.
.IP \(bu 2
Removed \fBrunas\fP parameter from the following \fBpip\fP state module
functions: \fBinstalled\fP, \fBremoved\fP, \fBuptodate\fP . Please migrate to
\fBuser\fP\&.
.IP \(bu 2
Removed \fBquiet\fP option from all functions in \fBcmdmod\fP execution module.
Please use \fBoutput_loglevel=quiet\fP instead.
.IP \(bu 2
Removed \fBparameter\fP argument from \fBeselect.set_\fP state. Please migrate to
\fBmodule_parameter\fP or \fBaction_parameter\fP\&.
.IP \(bu 2
The \fBsalt_events\fP table schema has changed to include an additional field
called \fBmaster_id\fP to distinguish between events flowing into a database
from multiple masters. If \fBevent_return\fP is enabled in the master config,
the database schema must first be updated to add the \fBmaster_id\fP field.
This alteration can be accomplished as follows:
.INDENT 2.0
.INDENT 3.5
\fBALTER TABLE salt_events ADD master_id VARCHAR(255) NOT NULL;\fP
.UNINDENT
.UNINDENT
.UNINDENT
.SS Known Issues
.INDENT 0.0
.IP \(bu 2
In multi\-master mode, a minion may become temporarily unresponsive if modules
or pillars are refreshed at the same time that one or more masters are down.
This can be worked around by setting \(aqauth_timeout\(aq and \(aqauth_tries\(aq down to
shorter periods.
.UNINDENT
.SS Salt 2015.5.1 Release Notes
.INDENT 0.0
.TP
.B release
2015\-05\-20
.UNINDENT
.sp
Version 2015.5.1 is a bugfix release for \fI\%2015.5.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB203\fP
.IP \(bu 2
Total Issue References: \fB30\fP
.IP \(bu 2
Total PR References: \fB177\fP
.IP \(bu 2
Contributors: \fB49\fP (\fI\%Arabus\fP, \fI\%Lothiraldan\fP, \fI\%Snergster\fP, \fI\%TaiSHiNet\fP, \fI\%The\-Loeki\fP,
\fI\%UtahDave\fP, \fI\%aboe76\fP, \fI\%ahus1\fP, \fI\%basepi\fP, \fI\%bastiaanb\fP, \fI\%bradthurber\fP, \fI\%cachedout\fP,
\fI\%cellscape\fP, \fI\%corywright\fP, \fI\%cro\fP, \fI\%dennisjac\fP, \fI\%dmyerscough\fP, \fI\%galet\fP, \fI\%garethgreenaway\fP,
\fI\%gladiatr72\fP, \fI\%gtmanfred\fP, \fI\%iggy\fP, \fI\%ionutbalutoiu\fP, \fI\%jacobhammons\fP, \fI\%jayeshka\fP,
\fI\%jfindlay\fP, \fI\%joejulian\fP, \fI\%jpic\fP, \fI\%justinta\fP, \fI\%kaidokert\fP, \fI\%kaithar\fP, \fI\%kiorky\fP,
\fI\%lisa2lisa\fP, \fI\%msciciel\fP, \fI\%nleib\fP, \fI\%notpeter\fP, \fI\%optix2000\fP, \fI\%rahulhan\fP, \fI\%rallytime\fP,
\fI\%rubic\fP, \fI\%ryan\-lane\fP, \fI\%s0undt3ch\fP, \fI\%slinu3d\fP, \fI\%steverweber\fP, \fI\%techhat\fP, \fI\%terminalmage\fP,
\fI\%ticosax\fP, \fI\%twangboy\fP, \fI\%whiteinge\fP)
.UNINDENT
.SS Cloud Runner Changes
.sp
The \fBfun\fP argument to the \fI\%cloud.action\fP
runner has changed to \fBfunc\fP\&. Please update any calls to this runner.
.SS Changelog for v2015.5.0..v2015.5.1
.sp
\fIGenerated at: 2018\-05\-27 20:58:00 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#23998\fP: (\fI\%rallytime\fP) Update release note for 2015.5.1
@ \fI2015\-05\-20 20:58:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
2422760ebd Merge pull request \fI\%#23998\fP from rallytime/release_notes
.IP \(bu 2
113c6049f5 Update release note for 2015.5.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23989\fP: (\fI\%rallytime\fP) Backport \fI\%#23980\fP to 2015.5
@ \fI2015\-05\-20 19:33:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23980\fP: (\fI\%iggy\fP) template: jinja2 \-> jinja (refs: \fI\%#23989\fP)
.IP \(bu 2
117ecb1fe0 Merge pull request \fI\%#23989\fP from rallytime/bp\-23980
.IP \(bu 2
8f8557c47d template: jinja2 \-> jinja
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23988\fP: (\fI\%rallytime\fP) Backport \fI\%#23977\fP to 2015.5
@ \fI2015\-05\-20 19:13:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23977\fP: (\fI\%ionutbalutoiu\fP) Fixed glance image_create (refs: \fI\%#23988\fP)
.IP \(bu 2
d4f1ba02d7 Merge pull request \fI\%#23988\fP from rallytime/bp\-23977
.IP \(bu 2
46fc7c6b69 Fixed glance image_create
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23986\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-05\-20 18:41:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
9566e7d412 Merge pull request \fI\%#23986\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
0b78156592 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
314e4db512 Merge pull request \fI\%#23965\fP from hvnsweeting/20147\-fix\-gitfs\-gitpython\-exception
.INDENT 2.0
.IP \(bu 2
2576301631 handle all exception gitpython can raise
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23985\fP: (\fI\%UtahDave\fP) Add 2014.7.5\-2 and 2015.5.0\-2 Windows installer download links
@ \fI2015\-05\-20 18:32:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
9d1130ef8e Merge pull request \fI\%#23985\fP from UtahDave/2015.5local
.IP \(bu 2
10338d0c54 Add links to Windows 2015.5.0\-2 install downloads
.IP \(bu 2
b84f9756c5 updated Windows 2014.7.5\-2 installer download link
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23983\fP: (\fI\%rallytime\fP) Versionadded tags for https_user and https_pass args new in 2015.5.0
@ \fI2015\-05\-20 18:05:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca7729d023 Merge pull request \fI\%#23983\fP from rallytime/versionadded_git_options
.IP \(bu 2
14eae22c91 Versionadded tags for https_user and https_pass args new in 2015.5.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23970\fP: (\fI\%jayeshka\fP) adding system unit test case
@ \fI2015\-05\-20 17:12:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
b06df57e03 Merge pull request \fI\%#23970\fP from jayeshka/system\-unit\-test
.IP \(bu 2
89eb00815e adding system unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23967\fP: (\fI\%jayeshka\fP) adding states/memcached unit test case
@ \fI2015\-05\-20 17:12:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
38d5f75756 Merge pull request \fI\%#23967\fP from jayeshka/memcached\-states\-unit\-test
.IP \(bu 2
8ef9240e25 adding states/memcached unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23966\fP: (\fI\%jayeshka\fP) adding states/modjk unit test case
@ \fI2015\-05\-20 17:11:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
868e807d8a Merge pull request \fI\%#23966\fP from jayeshka/modjk\-states\-unit\-test
.IP \(bu 2
422a96497d adding states/modjk unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23942\fP: (\fI\%jacobhammons\fP) Updates to sphinx saltstack2 doc theme
@ \fI2015\-05\-20 15:43:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
63164900bd Merge pull request \fI\%#23942\fP from jacobhammons/2015.5
.IP \(bu 2
31023c8915 Updates to sphinx saltstack2 doc theme
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23872\fP: (\fI\%joejulian\fP) create_ca_signed_cert can error if dereferenced dict is used for args (refs: \fI\%#23874\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23874\fP: (\fI\%joejulian\fP) Validate keyword arguments to be valid
@ \fI2015\-05\-20 04:53:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
587957badc Merge pull request \fI\%#23874\fP from joejulian/2015.5_tls_validate_kwargs
.IP \(bu 2
30102acd04 Fix py3 and ordering inconsistency problems.
.IP \(bu 2
493f7ad5f0 Validate keyword arguments to be valid
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23960\fP: (\fI\%rallytime\fP) Backport \fI\%#22114\fP to 2015.5
@ \fI2015\-05\-20 04:37:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#22114\fP: (\fI\%dmyerscough\fP) Fixing KeyError when there are no additional pages (refs: \fI\%#23960\fP)
.IP \(bu 2
00c5c22867 Merge pull request \fI\%#23960\fP from rallytime/bp\-22114
.IP \(bu 2
f3e1d63fce Catch KeyError
.IP \(bu 2
306b1ea6b8 Fixing KeyError
.IP \(bu 2
6b2cda2861 Fix PEP8 complaint
.IP \(bu 2
239e50f30d Fixing KeyError when there are no additional pages
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23961\fP: (\fI\%rallytime\fP) Backport \fI\%#23944\fP to 2015.5
@ \fI2015\-05\-20 04:35:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23944\fP: (\fI\%ryan\-lane\fP) Add missing loginclass argument to _changes call (refs: \fI\%#23961\fP)
.IP \(bu 2
4648b46e05 Merge pull request \fI\%#23961\fP from rallytime/bp\-23944
.IP \(bu 2
970d19a31e Add missing loginclass argument to _changes call
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23948\fP: (\fI\%jfindlay\fP) augeas.change state now returns changes as a dict
@ \fI2015\-05\-20 04:00:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
0cb5cd3938 Merge pull request \fI\%#23948\fP from jfindlay/augeas_changes
.IP \(bu 2
f09b80a8b5 augeas.change state now returns changes as a dict
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23957\fP: (\fI\%rallytime\fP) Backport \fI\%#23951\fP to 2015.5
@ \fI2015\-05\-20 03:04:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23951\fP: (\fI\%ryan\-lane\fP) Do not check perms in file.copy if preserve (refs: \fI\%#23957\fP)
.IP \(bu 2
2d185f78f7 Merge pull request \fI\%#23957\fP from rallytime/bp\-23951
.IP \(bu 2
996b431252 Update file.py
.IP \(bu 2
85d461f748 Do not check perms in file.copy if preserve
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23839\fP: (\fI\%gladiatr72\fP) wonky loader syndrome (refs: \fI\%#23906\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23373\fP: (\fI\%tnypex\fP) reactor/orchestrate race condition on salt[\(aqpillar.get\(aq] (refs: \fI\%#23906\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23956\fP: (\fI\%rallytime\fP) Backport \fI\%#23906\fP to 2015.5
@ \fI2015\-05\-20 03:04:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23906\fP: (\fI\%gladiatr72\fP) Added exception handler to trap the RuntimeError raised when (refs: \fI\%#23956\fP)
.IP \(bu 2
ebff1ff967 Merge pull request \fI\%#23956\fP from rallytime/bp\-23906
.IP \(bu 2
9d87fd335c add proper marker for format argument
.IP \(bu 2
197688ef0c Added exception handler to trap the RuntimeError raised when Depends.enforce_dependency() class method fires unsuccessfully. There appears to be no synchronization within the Depends decorator class wrt the class global dependency_dict which results in incomplete population of any loader instantiation occurring at the time of one of these exceptions.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19852\fP: (\fI\%TaiSHiNet\fP) DigitalOcean APIv2 can\(aqt delete machines when there is only 1 page (refs: \fI\%#23955\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#19304\fP: (\fI\%TaiSHiNet\fP) DigitalOcean API v2 cannot delete VMs on 2nd page (refs: \fI\%#19305\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23955\fP: (\fI\%rallytime\fP) Backport \fI\%#19305\fP to 2015.5
@ \fI2015\-05\-20 03:03:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#19305\fP: (\fI\%TaiSHiNet\fP) Fixes droplet listing past page 1 (refs: \fI\%#23955\fP)
.IP \(bu 2
da3f9197d3 Merge pull request \fI\%#23955\fP from rallytime/bp\-19305
.IP \(bu 2
bbf2429bce Fixes droplet listing past page 1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23940\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-05\-19 22:37:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
02a78fce3d Merge pull request \fI\%#23940\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
36f0065faf Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
913391207a Merge pull request \fI\%#23939\fP from basepi/v2014.7.6release
.INDENT 2.0
.IP \(bu 2
32b65dc2a9 Add extended changelog to 2014.7.6 release notes
.UNINDENT
.IP \(bu 2
0031ca2631 Merge pull request \fI\%#23881\fP from garethgreenaway/23820_2014_7_schedule_list_issue
.INDENT 2.0
.IP \(bu 2
b207f2a433 Missing continue in the list function when deleting unused attributes.
.UNINDENT
.IP \(bu 2
63bd21ecd2 Merge pull request \fI\%#23887\fP from basepi/salt\-ssh.pillar.get.22131
.INDENT 2.0
.IP \(bu 2
bc84502f46 Bring salt\-ssh pillar.get in line with mainline pillar.get
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23932\fP: (\fI\%rallytime\fP) Backport \fI\%#23908\fP to 2015.5
@ \fI2015\-05\-19 21:41:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23908\fP: (\fI\%nleib\fP) fix connection function to mongo (refs: \fI\%#23932\fP)
.IP \(bu 2
ee4c01bf30 Merge pull request \fI\%#23932\fP from rallytime/bp\-23908
.IP \(bu 2
5d520c9377 fix connection function to mongo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23931\fP: (\fI\%rallytime\fP) Backport \fI\%#23880\fP to 2015.5
@ \fI2015\-05\-19 21:41:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23880\fP: (\fI\%bastiaanb\fP) if setting client_config_dir to \(aq~\(aq, expand path (refs: \fI\%#23931\fP)
.IP \(bu 2
70bd407920 Merge pull request \fI\%#23931\fP from rallytime/bp\-23880
.IP \(bu 2
8ce59a2e16 if setting client_config_dir to \(aq~\(aq, expand path
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23847\fP: (\fI\%kiorky\fP) lxc: systemd containers cant be seeded (refs: \fI\%#23806\fP, \fI\%#23898\fP, \fI\%#23897\fP, \fI\%#23808\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23833\fP: (\fI\%kiorky\fP) lxc.set_dns fails intermittently (refs: \fI\%#23807\fP, \fI\%#23898\fP, \fI\%#23897\fP, \fI\%#23808\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23772\fP: (\fI\%cheuschober\fP) lxc.init fails to bootstrap container (refs: \fI\%#23806\fP, \fI\%#23808\fP, \fI\%#23807\fP, \fI\%#23898\fP, \fI\%#23897\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23658\fP: (\fI\%arthurlogilab\fP) [salt\-cloud lxc] too verbose, shows host: True multiple times when starting (refs: \fI\%#23898\fP, \fI\%#23897\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23657\fP: (\fI\%arthurlogilab\fP) [salt\-cloud lxc] NameError: global name \(aq__salt__\(aq is not defined (refs: \fI\%#23898\fP, \fI\%#23727\fP, \fI\%#23897\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23898\fP: (\fI\%kiorky\fP) Lxc profiles (refs: \fI\%#23897\fP)
@ \fI2015\-05\-19 21:08:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23897\fP: (\fI\%kiorky\fP) Lxc seed and prof ports (refs: \fI\%#23898\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23808\fP: (\fI\%kiorky\fP) Lxc seed and prof ports (refs: \fI\%#23807\fP, \fI\%#23897\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23807\fP: (\fI\%kiorky\fP) Lxc profiles (refs: \fI\%#23898\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23806\fP: (\fI\%kiorky\fP) Lxc seeding (refs: \fI\%#23807\fP)
.IP \(bu 2
5bdbf0af9b Merge pull request \fI\%#23898\fP from makinacorpus/lxc_profiles
.IP \(bu 2
d9051a047a lxc: systemd support
.IP \(bu 2
e8d674fed4 lxc: chroot fallback toggle
.IP \(bu 2
e2887a0d44 lxc: sync func name with develop
.IP \(bu 2
e96e345799 lxc more fixes (lxc.set_dns)
.IP \(bu 2
fdb64245d4 lxc: Fix salt config (no more a kwarg)
.IP \(bu 2
63e63fa527 repair salt cloud lxc api on develop
.IP \(bu 2
80eabe2703 lxc salt cloud doc
.IP \(bu 2
73f229d966 lxc: unificate saltconfig/master/master_port
.IP \(bu 2
0bc1f08a6b lxc: refactor a bit saltcloud/lxc interface
.IP \(bu 2
7a80370da9 lxc: get networkprofile from saltcloud
.IP \(bu 2
47acb2e159 lxc: default net profile has now correct options
.IP \(bu 2
7eadf4863c lxc: select the appropriate default bridge
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23900\fP: (\fI\%hashi825\fP) salt ubuntu network building issue 2015.5.0 (refs: \fI\%#23922\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23922\fP: (\fI\%garethgreenaway\fP) Fixes to debian_ip.py
@ \fI2015\-05\-19 18:50:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
b818f72dce Merge pull request \fI\%#23922\fP from garethgreenaway/23900_2015_5_bonding_interface_fixes
.IP \(bu 2
0bba536d6d Fixing issue reported when using bonded interfaces on Ubuntu.  Attributes should be bond\-, but the code was attempting to split just on bond_.  Fix accounts for both, but the debian_ip.py module will write out bond attributes with bond\-
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23925\fP: (\fI\%jpic\fP) Fixed wrong path in LXC cloud documentation
@ \fI2015\-05\-19 18:23:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23924\fP: (\fI\%jpic\fP) Fixed wrong path in LXC cloud documentation (refs: \fI\%#23925\fP)
.IP \(bu 2
b1c98a38ed Merge pull request \fI\%#23925\fP from jpic/fix/wrong_lxc_path
.IP \(bu 2
a4bcd75171 Fixed wrong path in LXC cloud documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23894\fP: (\fI\%whiteinge\fP) Add __all__ attribute to Mock class for docs
@ \fI2015\-05\-19 17:17:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
7f6a716a8a Merge pull request \fI\%#23894\fP from whiteinge/doc\-mock__all__
.IP \(bu 2
6eeca46158 Add __all__ attribute to Mock class for docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23767\fP: (\fI\%chrimi\fP) Salt system.locale fails on non existent default locale (refs: \fI\%#23884\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23884\fP: (\fI\%jfindlay\fP) Fix locale.set_locale on debian
@ \fI2015\-05\-19 15:51:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
8108a9bd19 Merge pull request \fI\%#23884\fP from jfindlay/fix_locale
.IP \(bu 2
91c2d51400 use append_if_not_found in locale.set_locale
.IP \(bu 2
e63260391c (re)generate /etc/default/locale
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23866\fP: (\fI\%jfindlay\fP) backport \fI\%#23834\fP, change portage.dep.strip_empty to list comprehension
@ \fI2015\-05\-19 15:50:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23834\fP: (\fI\%Arabus\fP) Avoid deprecation warning from  portage.dep.strip_empty() (refs: \fI\%#23866\fP)
.IP \(bu 2
6bae12fa8b Merge pull request \fI\%#23866\fP from jfindlay/flag_strip
.IP \(bu 2
aa032ccfaf replace portage.dep.strip_empty() with list comprehension
.IP \(bu 2
7576872280 Proper replacement for portage.dep.strip_empty() with list comprehension, pep8fix
.IP \(bu 2
2851a5cf13 Switch portage.dep.strip_empty(...) to filter(None,...) to avoid deprecation warning and do essentially the same
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23904\fP: (\fI\%mbrgm\fP) Network config bonding section cannot be parsed when attribute names use dashes (refs: \fI\%#23917\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23917\fP: (\fI\%corywright\fP) Split debian bonding options on dash instead of underscore
@ \fI2015\-05\-19 15:44:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
a67a008913 Merge pull request \fI\%#23917\fP from corywright/issue23904
.IP \(bu 2
c06f8cf831 Split debian bonding options on dash instead of underscore
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23909\fP: (\fI\%jayeshka\fP) \(aqstr\(aq object has no attribute \(aqcapitalized\(aq
@ \fI2015\-05\-19 15:41:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
e8fcd0994d Merge pull request \fI\%#23909\fP from jayeshka/file\-exe\-module
.IP \(bu 2
e422d9d200 \(aqstr\(aq object has no attribute \(aqcapitalized\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23903\fP: (\fI\%garethgreenaway\fP) Adding docs for missing schedule state module parameters.
@ \fI2015\-05\-19 06:29:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
c73bf38927 Merge pull request \fI\%#23903\fP from garethgreenaway/missing_docs_schedule_state
.IP \(bu 2
acd8ab9e1d Adding docs for missing schedule state module parameters.
.IP \(bu 2
a56697bd6e Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into 2015.5
.IP \(bu 2
1c2af5c685 Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into 2015.5
.IP \(bu 2
ef581283fa Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into 2015.5
.IP \(bu 2
8664e8bc8d Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into 2015.5\-2
.IP \(bu 2
46eb2655ee saltstack2 sphinx theme updates
.IP \(bu 2
e7442d3b1e Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into 2015.5
.IP \(bu 2
ee3c1bd4a7 missed one
.IP \(bu 2
3872921dd0 More updates to sphinx2 theme
.IP \(bu 2
fcd48657ef Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into 2015.5
.IP \(bu 2
8c32152be0 removed TOC numbering, additional tweaks to layout.html
.IP \(bu 2
73dfaeff28 Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into 2015.5
.IP \(bu 2
16d8a753ad saltstack2 sphinx theme and build settings
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23847\fP: (\fI\%kiorky\fP) lxc: systemd containers cant be seeded (refs: \fI\%#23806\fP, \fI\%#23898\fP, \fI\%#23897\fP, \fI\%#23808\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23772\fP: (\fI\%cheuschober\fP) lxc.init fails to bootstrap container (refs: \fI\%#23806\fP, \fI\%#23808\fP, \fI\%#23807\fP, \fI\%#23898\fP, \fI\%#23897\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23806\fP: (\fI\%kiorky\fP) Lxc seeding (refs: \fI\%#23807\fP)
@ \fI2015\-05\-18 23:18:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
ff3cc7d331 Merge pull request \fI\%#23806\fP from makinacorpus/lxc_seeding
.IP \(bu 2
61b7aad308 runners/lxc: optim
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23892\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-05\-18 23:07:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
5f1a93d966 Merge pull request \fI\%#23892\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
c2eed77691 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
17c5810c04 Merge pull request \fI\%#23891\fP from basepi/releasenotes
.INDENT 2.0
.IP \(bu 2
dec153bcea Update the release notes index page
.UNINDENT
.IP \(bu 2
a93e58f80f Merge pull request \fI\%#23888\fP from basepi/v2014.7.6release
.INDENT 2.0
.IP \(bu 2
49921b6cb2 Update the 2014.7.6 release notes with CVE details
.UNINDENT
.IP \(bu 2
50730287bb Merge pull request \fI\%#23871\fP from rallytime/bp\-23848
.INDENT 2.0
.IP \(bu 2
379c09c3a5 Updated for SLES 12.
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23875\fP: (\fI\%rallytime\fP) Backport \fI\%#23838\fP to 2015.5
@ \fI2015\-05\-18 22:28:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23838\fP: (\fI\%gtmanfred\fP) add refresh_beacons and sync_beacons (refs: \fI\%#23875\fP)
.IP \(bu 2
66d13356b3 Merge pull request \fI\%#23875\fP from rallytime/bp\-23838
.IP \(bu 2
3174227e8e Add versionadded directives to new beacon saltutil functions
.IP \(bu 2
4a94b2c17b add refresh_beacons and sync_beacons
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23876\fP: (\fI\%rallytime\fP) Switch digital ocean tests to v2 driver
@ \fI2015\-05\-18 22:17:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
d294cf260b Merge pull request \fI\%#23876\fP from rallytime/switch_digital_ocean_tests_v2
.IP \(bu 2
dce9b540a6 Remove extra line
.IP \(bu 2
4acf58e758 Switch digital ocean tests to v2 driver
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23792\fP: (\fI\%neogenix\fP) Salt Scheduler Incorrect Response (True, should be False) (refs: \fI\%#23882\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23882\fP: (\fI\%garethgreenaway\fP) Fixes to scheduler in 2015.5
@ \fI2015\-05\-18 22:09:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
b97a48c7f5 Merge pull request \fI\%#23882\fP from garethgreenaway/23792_2015_5_wrong_return_code
.IP \(bu 2
37dbde6d57 Job already exists in schedule, should return False.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23868\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-05\-18 18:35:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
61c922ea1a Merge pull request \fI\%#23868\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
c9ed23394c Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
aee00c83df Merge pull request \fI\%#23810\fP from rallytime/bp\-23757
.INDENT 2.0
.IP \(bu 2
fb32c32065 use abspath, do not eliminating symlinks
.UNINDENT
.IP \(bu 2
6b3352bb1a Merge pull request \fI\%#23809\fP from rallytime/virt_get_nics_fix
.INDENT 2.0
.IP \(bu 2
0616fb7884 Fix virtualport section of virt.get_nics loop
.UNINDENT
.IP \(bu 2
188f03f567 Merge pull request \fI\%#23823\fP from gtmanfred/2014.7
.INDENT 2.0
.IP \(bu 2
5ef006d59d add link local for ipv6
.UNINDENT
.IP \(bu 2
f3ca682f92 Merge pull request \fI\%#23802\fP from gtmanfred/2014.7
.INDENT 2.0
.IP \(bu 2
2da98b58c8 if it is ipv6 ip_to_int will fail
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23863\fP: (\fI\%rahulhan\fP) Adding states/timezone.py unit test
@ \fI2015\-05\-18 17:02:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
433f87372c Merge pull request \fI\%#23863\fP from rahulhan/states_timezone_unit_test
.IP \(bu 2
72fcabc690 Adding states/timezone.py unit test
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23862\fP: (\fI\%rahulhan\fP) Adding states/tomcat.py unit tests
@ \fI2015\-05\-18 17:02:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
37b3ee5421 Merge pull request \fI\%#23862\fP from rahulhan/states_tomcat_unit_test
.IP \(bu 2
65d7752d2a Adding states/tomcat.py unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23860\fP: (\fI\%rahulhan\fP) Adding states/test.py unit tests
@ \fI2015\-05\-18 17:01:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
dde7207acb Merge pull request \fI\%#23860\fP from rahulhan/states_test_unit_test
.IP \(bu 2
1f4cf86500 Adding states/test.py unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23859\fP: (\fI\%rahulhan\fP) Adding states/sysrc.py unit tests
@ \fI2015\-05\-18 17:01:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
3c9b8139e8 Merge pull request \fI\%#23859\fP from rahulhan/states_sysrc_unit_test
.IP \(bu 2
6a903b054d Adding states/sysrc.py unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23812\fP: (\fI\%rallytime\fP) Backport \fI\%#23790\fP to 2015.5
@ \fI2015\-05\-18 15:30:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23790\fP: (\fI\%aboe76\fP) updated suse spec file to version 2015.5.0 (refs: \fI\%#23812\fP)
.IP \(bu 2
4cf30a7ffa Merge pull request \fI\%#23812\fP from rallytime/bp\-23790
.IP \(bu 2
3f65631cb6 updated suse spec file to version 2015.5.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23811\fP: (\fI\%rallytime\fP) Backport \fI\%#23786\fP to 2015.5
@ \fI2015\-05\-18 15:30:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23786\fP: (\fI\%kaithar\fP) Log the error generated that causes returns.mysql.returner to except. (refs: \fI\%#23811\fP)
.IP \(bu 2
c6f939adfb Merge pull request \fI\%#23811\fP from rallytime/bp\-23786
.IP \(bu 2
346f30bdda Log the error generated that causes returns.mysql.returner to except.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23850\fP: (\fI\%jayeshka\fP) adding sysbench unit test case
@ \fI2015\-05\-18 15:28:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce60582de4 Merge pull request \fI\%#23850\fP from jayeshka/sysbench\-unit\-test
.IP \(bu 2
280abdec7c adding sysbench unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23843\fP: (\fI\%The\-Loeki\fP) Fix erroneous virtual:physical core grain detection
@ \fI2015\-05\-18 15:24:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
060902fefa Merge pull request \fI\%#23843\fP from The\-Loeki/patch\-1
.IP \(bu 2
9e2cf606eb Fix erroneous virtual:physical core grain detection
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23815\fP: (\fI\%Snergster\fP) [beacons] inotify errors on subdir creation (refs: \fI\%#23816\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23685\fP: (\fI\%Snergster\fP) inotify beacon on file. \(aqchange\(aq event to reactor to reset file to known state will cause loop (refs: \fI\%#23816\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23816\fP: (\fI\%Snergster\fP) Doc for \fI\%#23685\fP Added prereq, caution, and additional mask information
@ \fI2015\-05\-18 15:18:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
3257a9bead Merge pull request \fI\%#23816\fP from Snergster/23685\-doc\-fix
.IP \(bu 2
0fca49d52a Added prereq, caution, and additional mask information
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23832\fP: (\fI\%ahus1\fP) make saltify provider use standard boostrap procedure
@ \fI2015\-05\-18 02:18:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23829\fP: (\fI\%ahus1\fP) make saltify provider use standard boostrap procedure (refs: \fI\%#23832\fP)
.IP \(bu 2
3df3b85090 Merge pull request \fI\%#23832\fP from ahus1/ahus1_saltify_bootstrap_2015.5
.IP \(bu 2
f5b1734782 fixing problem in unit test
.IP \(bu 2
cba47f6856 make saltify to use standard boostrap procedure, therefore providing all options like master_sign_pub_file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23791\fP: (\fI\%optix2000\fP) Psutil compat
@ \fI2015\-05\-16 04:05:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
8ec4fb2a73 Merge pull request \fI\%#23791\fP from optix2000/psutil_compat
.IP \(bu 2
5470cf58db Fix pylint errors and sloppy inline comments
.IP \(bu 2
64634b6349 Update psutil.pid_list to use psutil.pids
.IP \(bu 2
5dd6d69192 Fix imports that aren\(aqt in __all__
.IP \(bu 2
8a1da33ada Fix test cases by mocking psutil_compat
.IP \(bu 2
558798df1f Fix net_io_counters deprecation issue
.IP \(bu 2
8140f92ba8 Override unnecessary pylint errors
.IP \(bu 2
7d02ad4f06 Fix some of the mock names for the new API
.IP \(bu 2
9b3023e851 Fix overloaded getters/setters. Fix line lengths
.IP \(bu 2
180eb87a46 Fix whitespace
.IP \(bu 2
f8edf72f98 Use new psutil API in ps module
.IP \(bu 2
e48982ff9c Fix version checking in psutil_compat
.IP \(bu 2
93ee411fd5 Create compatibility psutil. psutil 3.0 drops 1.0 API, but we still support old psutil versions.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23782\fP: (\fI\%terminalmage\fP) Replace \(dqcommand \-v\(dq with \(dqwhich\(dq and get rid of spurious log messages
@ \fI2015\-05\-16 04:03:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
405517be8b Merge pull request \fI\%#23782\fP from terminalmage/issue23772
.IP \(bu 2
0f6f239052 More ignore_retcode to suppress spurious log msgs
.IP \(bu 2
b4c48e62ea Ignore return code in lxc.attachable
.IP \(bu 2
08658c0177 Replace \(dqcommand \-v\(dq with \(dqwhich\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23783\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-05\-15 21:38:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
cb2eb401f3 Merge pull request \fI\%#23783\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
9df51caf28 __opts__.get
.IP \(bu 2
51d23ed9d0 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
d9af0c3e82 Merge pull request \fI\%#23488\fP from cellscape/lxc\-cloud\-fixes
.INDENT 2.0
.IP \(bu 2
64250a67e5 Remove profile from opts after creating LXC container
.IP \(bu 2
c4047d2a71 Set destroy=True in opts when destroying cloud instance
.IP \(bu 2
9e1311a7cd Store instance names in opts when performing cloud action
.IP \(bu 2
934bc57c73 Correctly pass custom env to lxc\-attach
.IP \(bu 2
7fb85f7be1 Preserve test=True option in cloud states
.IP \(bu 2
9771b5a313 Fix detection of absent LXC container in cloud state
.IP \(bu 2
fb24f0cf02 Report failure when failed to create/clone LXC container
.IP \(bu 2
2d9aa2bb97 Avoid shadowing variables in lxc module
.IP \(bu 2
792e1021f2 Allow overriding profile options in lxc.cloud_init_interface
.IP \(bu 2
42bd64b9b3 Return changes on successful lxc.create from salt\-cloud
.IP \(bu 2
4409eabb83 Return correct result when creating cloud LXC container
.IP \(bu 2
377015c881 Issue \fI\%#16424\fP: List all providers when creating salt\-cloud instance without profile
.UNINDENT
.IP \(bu 2
808bbe1cb2 Merge pull request \fI\%#23748\fP from basepi/salt\-ssh.roster.host.check
.INDENT 2.0
.IP \(bu 2
bc53e049e0 Log entire exception for render errors in roster
.IP \(bu 2
753de6a621 Log render errors in roster to error level
.IP \(bu 2
e01a7a90b3 Always let the real YAML error through
.UNINDENT
.IP \(bu 2
72cf360255 Merge pull request \fI\%#23731\fP from twangboy/fix_22959
.INDENT 2.0
.IP \(bu 2
88e5495b2d Fixes \fI\%#22959\fP: Trying to add a directory to an unmapped drive in windows
.UNINDENT
.IP \(bu 2
2610195262 Merge pull request \fI\%#23730\fP from rallytime/bp\-23729
.INDENT 2.0
.IP \(bu 2
1877caecba adding support for nested grains to grains.item
.UNINDENT
.IP \(bu 2
3e9df883d6 Merge pull request \fI\%#23688\fP from twangboy/fix_23415
.INDENT 2.0
.IP \(bu 2
6a91169bae Fixed unused\-import pylint error
.IP \(bu 2
5e25b3f355 fixed pylint errors
.IP \(bu 2
1a9676626f Added inet_pton to utils/validate/net.py for ip.set_static_ip in windows
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23781\fP: (\fI\%jfindlay\fP) fix unit test mock errors on arch
@ \fI2015\-05\-15 19:40:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
982f87316d Merge pull request \fI\%#23781\fP from jfindlay/fix_locale_tests
.IP \(bu 2
14c711eeb3 fix unit test mock errors on arch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23566\fP: (\fI\%rks2286\fP) Salt\-cp corrupting the file after transfer to minion (refs: \fI\%#23740\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23740\fP: (\fI\%jfindlay\fP) Binary write
@ \fI2015\-05\-15 18:10:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
916b1c4f7c Merge pull request \fI\%#23740\fP from jfindlay/binary_write
.IP \(bu 2
626930a4e5 update incorrect comment wording
.IP \(bu 2
a978f5c091 always use binary file write mode on windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23682\fP: (\fI\%chrish42\fP) Pip module requires system pip, even when not used (with env_bin) (refs: \fI\%#23736\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23736\fP: (\fI\%jfindlay\fP) always load pip execution module
@ \fI2015\-05\-15 18:10:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
348645ecd5 Merge pull request \fI\%#23736\fP from jfindlay/fix_pip
.IP \(bu 2
b8867a8c23 update pip tests
.IP \(bu 2
040bbc42d2 only check pip version in one place
.IP \(bu 2
6c453a5a2a check for executable status of bin_env
.IP \(bu 2
3337257833 always load the pip module as pip could be anywhere
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23770\fP: (\fI\%cellscape\fP) Fix cloud LXC container destruction
@ \fI2015\-05\-15 17:38:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
10cedfb174 Merge pull request \fI\%#23770\fP from cellscape/fix\-cloud\-lxc\-destruction
.IP \(bu 2
4f6021c884 Fix cloud LXC container destruction
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23759\fP: (\fI\%lisa2lisa\fP) fixed the problem for not beable to revoke \fI\&.\fP, for more detail https…
@ \fI2015\-05\-15 17:38:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
ddea822b02 Merge pull request \fI\%#23759\fP from lisa2lisa/iss23664
.IP \(bu 2
a29f161a58 fixed the problem for not beable to revoke \fI\&.\fP, for more detail \fI\%https://github.com/saltstack/salt/issues/23201\fP, fixed mysql cannot create user with pure digit password, for more info \fI\%https://github.com/saltstack/salt/issues/23664\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23769\fP: (\fI\%cellscape\fP) Fix file_roots CA lookup in salt.utils.http.get_ca_bundle
@ \fI2015\-05\-15 16:21:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
10615ff5a7 Merge pull request \fI\%#23769\fP from cellscape/utils\-http\-ca\-file\-roots
.IP \(bu 2
8e90f3291b Fix file_roots CA lookup in salt.utils.http.get_ca_bundle
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23765\fP: (\fI\%jayeshka\fP) adding states/makeconf unit test case
@ \fI2015\-05\-15 14:29:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd8a1b797f Merge pull request \fI\%#23765\fP from jayeshka/makeconf_states\-unit\-test
.IP \(bu 2
26e31afa31 adding states/makeconf unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23760\fP: (\fI\%ticosax\fP) [doc] document refresh argument
@ \fI2015\-05\-15 14:23:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
ee13b08027 Merge pull request \fI\%#23760\fP from ticosax/2015.5
.IP \(bu 2
e3ca859ba6 document refresh argument
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23766\fP: (\fI\%jayeshka\fP) adding svn unit test case
@ \fI2015\-05\-15 14:23:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
a017f725a4 Merge pull request \fI\%#23766\fP from jayeshka/svn\-unit\-test
.IP \(bu 2
19939cfa98 adding svn unit test case
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23734\fP: (\fI\%bradthurber\fP) 2015.5.0 modules/archive.py ZipFile instance has no attribute \(aq__exit__\(aq \- only python 2.6? (refs: \fI\%#23737\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23751\fP: (\fI\%rallytime\fP) Backport \fI\%#23737\fP to 2015.5
@ \fI2015\-05\-15 03:58:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23737\fP: (\fI\%bradthurber\fP) fix for 2015.5.0 modules/archive.py ZipFile instance has no attribute… (refs: \fI\%#23751\fP)
.IP \(bu 2
0ed9d45114 Merge pull request \fI\%#23751\fP from rallytime/bp\-23737
.IP \(bu 2
8d1eb326d0 fix for 2015.5.0 modules/archive.py ZipFile instance has no attribute \(aq__exit__\(aq \- only python 2.6? \fI\%#23734\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23709\fP: (\fI\%kiorky\fP) cmdmod: enhancement is really needed for stateful commands (refs: \fI\%#23710\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23710\fP: (\fI\%kiorky\fP) Get more useful output from stateful commands
@ \fI2015\-05\-14 21:58:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
d73984ec9c Merge pull request \fI\%#23710\fP from makinacorpus/i23709
.IP \(bu 2
c70690969e Get more useful output from stateful commands
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23608\fP: (\fI\%kaidokert\fP) salt\-cloud file_map with non\-root user  (refs: \fI\%#23609\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23724\fP: (\fI\%rallytime\fP) Backport \fI\%#23609\fP to 2015.5
@ \fI2015\-05\-14 19:34:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23609\fP: (\fI\%kaidokert\fP) file_map: chown created directories if not root \fI\%#23608\fP (refs: \fI\%#23724\fP)
.IP \(bu 2
cdf421b9ed Merge pull request \fI\%#23724\fP from rallytime/bp\-23609
.IP \(bu 2
fe3a762673 file_map: chmod created directories if not root
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23723\fP: (\fI\%rallytime\fP) Backport \fI\%#23568\fP to 2015.5
@ \fI2015\-05\-14 19:34:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23568\fP: (\fI\%techhat\fP) Allow Salt Cloud to use either SCP or SFTP, as configured (refs: \fI\%#23723\fP)
.IP \(bu 2
94f9099307 Merge pull request \fI\%#23723\fP from rallytime/bp\-23568
.IP \(bu 2
bbec34abd3 Allow Salt Cloud to use either SCP or SFTP, as configured
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23725\fP: (\fI\%rallytime\fP) Backport \fI\%#23691\fP to 2015.5
@ \fI2015\-05\-14 19:32:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23691\fP: (\fI\%dennisjac\fP) add initial configuration documentation for varstack pillar (refs: \fI\%#23725\fP)
.IP \(bu 2
137e5eefd0 Merge pull request \fI\%#23725\fP from rallytime/bp\-23691
.IP \(bu 2
28a846ebe8 add initial configuration documentation for varstack pillar
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23722\fP: (\fI\%rallytime\fP) Backport \fI\%#23472\fP to 2015.5
@ \fI2015\-05\-14 19:31:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23472\fP: (\fI\%techhat\fP) Allow neutron network list to be used as pillar data (refs: \fI\%#23722\fP)
.IP \(bu 2
0c00995dfb Merge pull request \fI\%#23722\fP from rallytime/bp\-23472
.IP \(bu 2
c3d0f39515 Change versionadded tag for backport
.IP \(bu 2
023e88f264 Allow neutron network list to be used as pillar data
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23657\fP: (\fI\%arthurlogilab\fP) [salt\-cloud lxc] NameError: global name \(aq__salt__\(aq is not defined (refs: \fI\%#23898\fP, \fI\%#23727\fP, \fI\%#23897\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23727\fP: (\fI\%jfindlay\fP) fix npm execution module stacktrace
@ \fI2015\-05\-14 18:14:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
cbf4ca8d91 Merge pull request \fI\%#23727\fP from jfindlay/npm_salt
.IP \(bu 2
05392f282e fix npm execution module stacktrace
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23718\fP: (\fI\%rahulhan\fP) Adding states/user.py unit tests
@ \fI2015\-05\-14 17:15:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
ef536d58de Merge pull request \fI\%#23718\fP from rahulhan/states_user_unit_tests
.IP \(bu 2
aad27db513 Adding states/user.py unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23720\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-05\-14 17:13:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
a529d74079 Merge pull request \fI\%#23720\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
06a3ebd9d1 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
1b86460d73 Merge pull request \fI\%#23680\fP from cachedout/issue_23403
.INDENT 2.0
.IP \(bu 2
d5986c21b4 Rename kwarg in cloud runner
.UNINDENT
.IP \(bu 2
cd64af0ce4 Merge pull request \fI\%#23674\fP from cachedout/issue_23548
.INDENT 2.0
.IP \(bu 2
da8a2f5cb3 Handle lists correctly in grains.list_prsesent
.UNINDENT
.IP \(bu 2
d322a19213 Merge pull request \fI\%#23672\fP from twangboy/fix_user_present
.INDENT 2.0
.IP \(bu 2
731e7af3dd Merge branch \(aq2014.7\(aq of \fI\%https://github.com/saltstack/salt\fP into fix_user_present
.IP \(bu 2
d6f70a4545 Fixed user.present to create password in windows
.UNINDENT
.IP \(bu 2
43f7025000 Merge pull request \fI\%#23670\fP from rallytime/bp\-23607
.INDENT 2.0
.IP \(bu 2
ed30dc4642 Fix for \fI\%#23604\fP\&. No error reporting. Exitcode !=0 are ok
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23704\fP: (\fI\%jayeshka\fP) adding states/lvs_server unit test case
@ \fI2015\-05\-14 14:22:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
13facbf077 Merge pull request \fI\%#23704\fP from jayeshka/lvs_server_states\-unit\-test
.IP \(bu 2
da323dab0b adding states/lvs_server unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23703\fP: (\fI\%jayeshka\fP) adding states/lvs_service unit test case
@ \fI2015\-05\-14 14:21:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
f95ca3188f Merge pull request \fI\%#23703\fP from jayeshka/lvs_service_states\-unit\-test
.IP \(bu 2
66717c8133 adding states/lvs_service unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23702\fP: (\fI\%jayeshka\fP) Remove superfluous return statement.
@ \fI2015\-05\-14 14:20:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
07e987e327 Merge pull request \fI\%#23702\fP from jayeshka/fix_lvs_service
.IP \(bu 2
ecff2181e4 fix lvs_service
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23686\fP: (\fI\%jfindlay\fP) remove superfluous return statement
@ \fI2015\-05\-14 14:20:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
39973d4095 Merge pull request \fI\%#23686\fP from jfindlay/fix_lvs_server
.IP \(bu 2
5aaeb73532 remove superfluous return statement
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23690\fP: (\fI\%rallytime\fP) Backport \fI\%#23424\fP to 2015.5
@ \fI2015\-05\-13 23:04:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23424\fP: (\fI\%justinta\fP) Added python_shell=True for refresh_db in pacman.py (refs: \fI\%#23690\fP)
.IP \(bu 2
be7c7ef3fd Merge pull request \fI\%#23690\fP from rallytime/bp\-23424
.IP \(bu 2
94574b7367 Added python_shell=True for refresh_db in pacman.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23681\fP: (\fI\%cachedout\fP) Start on 2015.5.1 release notes
@ \fI2015\-05\-13 19:44:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a0db43097 Merge pull request \fI\%#23681\fP from cachedout/2015_5_1_release_notes
.IP \(bu 2
bdbbfa6ee7 Start on 2015.5.1 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23679\fP: (\fI\%jfindlay\fP) Merge \fI\%#23616\fP
@ \fI2015\-05\-13 19:03:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23616\fP: (\fI\%Snergster\fP) virtual returning none warning fixed in dev but missed in 2015.5 (refs: \fI\%#23679\fP)
.IP \(bu 2
b54075a2ac Merge pull request \fI\%#23679\fP from jfindlay/merge_23616
.IP \(bu 2
6e15e19907 appease pylint\(aqs blank line strictures
.IP \(bu 2
8750680d9e virtual returning none warning fixed in dev but missed in 2015.5
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23675\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-05\-13 18:35:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
e480f13688 Merge pull request \fI\%#23675\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
bd635488ef Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
0f006ac1d8 Merge pull request \fI\%#23661\fP from rallytime/merge\-23640
.INDENT 2.0
.IP \(bu 2
4427f42bb6 Whitespace fix
.IP \(bu 2
dd9115466e Add warning to get_or_set_hash about reserved chars
.UNINDENT
.IP \(bu 2
84e2ef88fc Merge pull request \fI\%#23639\fP from cachedout/issue_23452
.INDENT 2.0
.IP \(bu 2
d418b49a77 Syntax error!
.IP \(bu 2
45b4015d7d Handle exceptions raised by __virtual__
.UNINDENT
.IP \(bu 2
bd9b94ba8c Merge pull request \fI\%#23637\fP from cachedout/issue_23611
.INDENT 2.0
.IP \(bu 2
56cb1f52e3 Fix typo
.IP \(bu 2
f6fcf19a7f Convert str master to list
.UNINDENT
.IP \(bu 2
f20c0e42ce Merge pull request \fI\%#23595\fP from rallytime/bp\-23549
.INDENT 2.0
.IP \(bu 2
6efcac09ad Update __init__.py
.UNINDENT
.IP \(bu 2
1acaf86da7 Merge pull request \fI\%#23594\fP from rallytime/bp\-23496
.INDENT 2.0
.IP \(bu 2
d5ae1d268a Fix for issue \fI\%#23110\fP This resolves issues when the freshly created directory is removed by fileserver.update.
.UNINDENT
.IP \(bu 2
2c221c7332 Merge pull request \fI\%#23593\fP from rallytime/bp\-23442
.INDENT 2.0
.IP \(bu 2
39869a15bd check w/ low[\(aqname\(aq] only
.IP \(bu 2
304cc499e9 another fix for file defined w/ id, but require name
.IP \(bu 2
8814d4180e add directory itself to keep list
.UNINDENT
.IP \(bu 2
fadd1ef63c Merge pull request \fI\%#23606\fP from twangboy/fix_installer
.INDENT 2.0
.IP \(bu 2
038331edab Fixed checkbox for starting service and actually starting it
.UNINDENT
.UNINDENT
.IP \(bu 2
acdd3fc6bd Fix lint
.IP \(bu 2
680e88f058 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
10b3f0f643 Merge pull request \fI\%#23592\fP from rallytime/bp\-23389
.INDENT 2.0
.IP \(bu 2
734cc43801 Correct fail_hard typo
.UNINDENT
.IP \(bu 2
cd34b9b6c4 Merge pull request \fI\%#23573\fP from techhat/novaquery
.INDENT 2.0
.IP \(bu 2
f92db5e92f Linting
.IP \(bu 2
26e00d3ccc Scan all available networks for public and private IPs
.UNINDENT
.IP \(bu 2
2a72cd71c2 Merge pull request \fI\%#23558\fP from jfindlay/fix_ebuild
.INDENT 2.0
.IP \(bu 2
45404fb2a6 reorder emerge command line
.UNINDENT
.IP \(bu 2
a664a3c6fd Merge pull request \fI\%#23530\fP from dr4Ke/fix_salt\-ssh_to_include_pkg_sources
.INDENT 2.0
.IP \(bu 2
5df6a8008c fix pylint warning
.IP \(bu 2
d0549e56ba salt\-ssh state: fix including all salt:// references
.UNINDENT
.IP \(bu 2
55c3869861 Merge pull request \fI\%#23433\fP from twangboy/list_pkgs_fix
.INDENT 2.0
.IP \(bu 2
8ab5b1b86f Fix pylint error
.IP \(bu 2
2d11d6545e Obtain all software from the registry
.UNINDENT
.IP \(bu 2
755bed0abd Merge pull request \fI\%#23554\fP from jleroy/debian\-hostname\-fix
.INDENT 2.0
.IP \(bu 2
5ff749e487 Debian: Hostname always updated
.UNINDENT
.IP \(bu 2
6ec87ce9f5 Merge pull request \fI\%#23551\fP from dr4Ke/grains.append_unit_tests
.INDENT 2.0
.IP \(bu 2
ebff9df5b2 fix pylint errors
.IP \(bu 2
c4954046ad unit tests for grains.append module function
.IP \(bu 2
0c9a32326c use MagickMock
.IP \(bu 2
c838a22377 unit tests for grains.append module function
.UNINDENT
.IP \(bu 2
e96c5c5bf3 Merge pull request \fI\%#23474\fP from dr4Ke/fix_grains.append_nested
.INDENT 2.0
.IP \(bu 2
a01a5bb51e grains.get, parameter delimiter, versionadded: 2014.7.6
.IP \(bu 2
b39f50475d remove debugging output
.IP \(bu 2
b6e15e295c fix grains.append in nested dictionary grains \fI\%#23411\fP
.UNINDENT
.IP \(bu 2
ab7e1aed8e Merge pull request \fI\%#23537\fP from t0rrant/patch\-1
.INDENT 2.0
.IP \(bu 2
8e03cc99d3 Update changelog
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23669\fP: (\fI\%rallytime\fP) Backport \fI\%#23586\fP to 2015.5
@ \fI2015\-05\-13 18:27:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23586\fP: (\fI\%Lothiraldan\fP) Fix salt.state.file._unify_sources_and_hashes when sources is used without sources_hashes (refs: \fI\%#23669\fP)
.IP \(bu 2
0dad6be0fc Merge pull request \fI\%#23669\fP from rallytime/bp\-23586
.IP \(bu 2
ef4c6adae3 Remove another unused import
.IP \(bu 2
73cfda751a Remove unused import
.IP \(bu 2
52b68d695a Use the zip_longest from six module for python 3 compatibility
.IP \(bu 2
18d5ff9a8e Fix salt.state.file._unify_sources_and_hashes when sources is used without sources_hashes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23662\fP: (\fI\%rallytime\fP) Merge \fI\%#23642\fP with pylint fix
@ \fI2015\-05\-13 15:46:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23642\fP: (\fI\%cachedout\fP) Let saltmod handle lower\-level exceptions gracefully (refs: \fI\%#23662\fP)
.IP \(bu 2
fabef759e0 Merge pull request \fI\%#23662\fP from rallytime/merge\-23642
.IP \(bu 2
aa7bbd84fa Remove unused import
.IP \(bu 2
9e66d4c88e Let saltmod handle lower\-level exceptions gracefully
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23622\fP: (\fI\%jfindlay\fP) merge \fI\%#23508\fP
@ \fI2015\-05\-13 15:36:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23508\fP: (\fI\%cro\fP) Port mysql returner to postgres using jsonb datatype (refs: \fI\%#23622\fP)
.IP \(bu 2
072b92733d Merge pull request \fI\%#23622\fP from jfindlay/pgjsonb
.IP \(bu 2
454322c7e4 appease pylint\(aqs proscription on blank line excess
.IP \(bu 2
57c617136d Get time with timezone correct also in job return.
.IP \(bu 2
e109d0f643 Get time with timezone correct.
.IP \(bu 2
21e06b9112 Fix SQL, remove unneeded imports.
.IP \(bu 2
653f360723 Stop making changes in 2 places.
.IP \(bu 2
d6daaa0292 Typo.
.IP \(bu 2
7d748bff75 SSL is handled differently by Pg, so don\(aqt set it here.
.IP \(bu 2
cc7c377bcd Fill alter_time field in salt_events with current time with timezone.
.IP \(bu 2
43defe9b20 Port mysql module to Postgres using jsonb datatypes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23651\fP: (\fI\%jayeshka\fP) adding solr unit test case
@ \fI2015\-05\-13 15:26:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
c1bdd4d377 Merge pull request \fI\%#23651\fP from jayeshka/solr\-unit\-test
.IP \(bu 2
6e05148962 adding solr unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23649\fP: (\fI\%jayeshka\fP) adding states/libvirt unit test case
@ \fI2015\-05\-13 15:24:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
ee43411677 Merge pull request \fI\%#23649\fP from jayeshka/libvirt_states\-unit\-test
.IP \(bu 2
0fb923a283 adding states/libvirt unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23648\fP: (\fI\%jayeshka\fP) adding states/linux_acl unit test case
@ \fI2015\-05\-13 15:24:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
c7fc466f1e Merge pull request \fI\%#23648\fP from jayeshka/linux_acl_states\-unit\-test
.IP \(bu 2
3f0ab29eb0 removed error.
.IP \(bu 2
11081c121c adding states/linux_acl unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23650\fP: (\fI\%jayeshka\fP) adding states/kmod unit test case
@ \fI2015\-05\-13 15:09:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
4cba7ba35c Merge pull request \fI\%#23650\fP from jayeshka/kmod_states\-unit\-test
.IP \(bu 2
1987015033 adding states/kmod unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23633\fP: (\fI\%jayeshka\fP) made changes to test_interfaces function.
@ \fI2015\-05\-13 06:51:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
bc8faf1543 Merge pull request \fI\%#23633\fP from jayeshka/win_network\-2015.5\-unit\-test
.IP \(bu 2
0936e1d386 made changes to test_interfaces function.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23619\fP: (\fI\%jfindlay\fP) fix kmod.present processing of module loading
@ \fI2015\-05\-13 01:16:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
7df3579bbc Merge pull request \fI\%#23619\fP from jfindlay/fix_kmod_state
.IP \(bu 2
73facbfc1f fix kmod.present processing of module loading
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23598\fP: (\fI\%rahulhan\fP) Adding states/win_dns_client.py unit tests
@ \fI2015\-05\-12 21:47:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
d4f30955fa Merge pull request \fI\%#23598\fP from rahulhan/states_win_dns_client_unit_test
.IP \(bu 2
d08d885828 Adding states/win_dns_client.py unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23597\fP: (\fI\%rahulhan\fP) Adding states/vbox_guest.py unit tests
@ \fI2015\-05\-12 21:46:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
811c6a1d89 Merge pull request \fI\%#23597\fP from rahulhan/states_vbox_guest_unit_test
.IP \(bu 2
6a2909eeea Removed errors
.IP \(bu 2
4cde78a58a Adding states/vbox_guest.py unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23615\fP: (\fI\%rallytime\fP) Backport \fI\%#23577\fP to 2015.5
@ \fI2015\-05\-12 21:19:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23577\fP: (\fI\%msciciel\fP) Fix find and remove functions to pass database param (refs: \fI\%#23615\fP)
.IP \(bu 2
029ff1103d Merge pull request \fI\%#23615\fP from rallytime/bp\-23577
.IP \(bu 2
6f74477129 Fix find and remove functions to pass database param
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23603\fP: (\fI\%rahulhan\fP) Adding states/winrepo.py unit tests
@ \fI2015\-05\-12 18:40:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
b8589532d1 Merge pull request \fI\%#23603\fP from rahulhan/states_winrepo_unit_test
.IP \(bu 2
a66e7e7f1f Adding states/winrepo.py unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23602\fP: (\fI\%rahulhan\fP) Adding states/win_path.py unit tests
@ \fI2015\-05\-12 18:39:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
3cbbd6d277 Merge pull request \fI\%#23602\fP from rahulhan/states_win_path_unit_test
.IP \(bu 2
122c29f71a Adding states/win_path.py unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23600\fP: (\fI\%rahulhan\fP) Adding states/win_network.py unit tests
@ \fI2015\-05\-12 18:39:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
3c904e8739 Merge pull request \fI\%#23600\fP from rahulhan/states_win_network_unit_test
.IP \(bu 2
b418404eb7 removed lint error
.IP \(bu 2
1be802300b Adding states/win_network.py unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23599\fP: (\fI\%rahulhan\fP) Adding win_firewall.py unit tests
@ \fI2015\-05\-12 18:37:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
10243a7742 Merge pull request \fI\%#23599\fP from rahulhan/states_win_firewall_unit_test
.IP \(bu 2
6cda890517 Adding win_firewall.py unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23601\fP: (\fI\%basepi\fP) Add versionadded for jboss module/state
@ \fI2015\-05\-12 17:22:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
e73071dbdf Merge pull request \fI\%#23601\fP from basepi/jboss.version.added
.IP \(bu 2
0174c8fe58 Add versionadded for jboss module/state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23469\fP: (\fI\%s0undt3ch\fP) Call the windows specific function not the general one
@ \fI2015\-05\-12 16:47:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
9beb7bc529 Merge pull request \fI\%#23469\fP from s0undt3ch/hotfix/call\-the\-win\-func
.IP \(bu 2
83e88a3eb1 Call the windows specific function not the general one
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23583\fP: (\fI\%jayeshka\fP) adding states/ipset unit test case
@ \fI2015\-05\-12 16:31:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
d2f097584c Merge pull request \fI\%#23583\fP from jayeshka/ipset_states\-unit\-test
.IP \(bu 2
4330cf4a6e adding states/ipset unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23582\fP: (\fI\%jayeshka\fP) adding states/keyboard unit test case
@ \fI2015\-05\-12 16:31:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
82a47e8cbf Merge pull request \fI\%#23582\fP from jayeshka/keyboard_states\-unit\-test
.IP \(bu 2
fa94d7ab5c adding states/keyboard unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23581\fP: (\fI\%jayeshka\fP) adding states/layman unit test case
@ \fI2015\-05\-12 16:30:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
77e5b28566 Merge pull request \fI\%#23581\fP from jayeshka/layman_states\-unit\-test
.IP \(bu 2
297b055b1c adding states/layman unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23580\fP: (\fI\%jayeshka\fP) adding smf unit test case
@ \fI2015\-05\-12 16:29:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
cbe32828ef Merge pull request \fI\%#23580\fP from jayeshka/smf\-unit\-test
.IP \(bu 2
4f9719157b adding smf unit test case
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21603\fP: (\fI\%ipmb\fP) ssh_auth.present fails on key without comment (refs: \fI\%#23572\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23572\fP: (\fI\%The\-Loeki\fP) Fix regression of \fI\%#21355\fP introduced by \fI\%#21603\fP
@ \fI2015\-05\-12 16:28:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#21355\fP: (\fI\%The\-Loeki\fP) Fix for comments containing whitespaces (refs: \fI\%#23572\fP)
.IP \(bu 2
16a333832a Merge pull request \fI\%#23572\fP from The\-Loeki/ssh_auth_fix
.IP \(bu 2
d8248dd368 Fix regression of \fI\%#21355\fP introduced by \fI\%#21603\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23490\fP: (\fI\%lichtamberg\fP)  salt.modules.aptpkg.upgrade should have default \(dqdist_upgrade=False\(dq (refs: \fI\%#23565\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23565\fP: (\fI\%garethgreenaway\fP) fix to aptpkg module
@ \fI2015\-05\-12 16:25:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
f843f89cd7 Merge pull request \fI\%#23565\fP from garethgreenaway/2015_2_aptpkg_upgrade_default_to_upgrade
.IP \(bu 2
97ae514641 aptpkg.upgrade should default to upgrade instead of dist_upgrade.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23473\fP: (\fI\%terminalmage\fP) unit.modules.rh_ip_test.RhipTestCase.test_build_bond is not properly mocked (refs: \fI\%#23550\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23550\fP: (\fI\%jfindlay\fP) additional mock for rh_ip_test test_build_bond
@ \fI2015\-05\-12 15:17:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
c1157cdaee Merge pull request \fI\%#23550\fP from jfindlay/fix_rh_ip_test
.IP \(bu 2
e9b94d36d3 additional mock for rh_ip_test test_build_bond
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23552\fP: (\fI\%garethgreenaway\fP) Fix for an issue caused by a previous pull request
@ \fI2015\-05\-11 21:54:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
b593328176 Merge pull request \fI\%#23552\fP from garethgreenaway/2015_5_returner_fix_broken_previous_pr
.IP \(bu 2
7d70e2b334 Passed argumentes in the call _fetch_profile_opts to were in the wrong order
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23547\fP: (\fI\%slinu3d\fP) Added AWS v4 signature support for 2015.5
@ \fI2015\-05\-11 21:52:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
d0f96825dd Merge pull request \fI\%#23547\fP from slinu3d/2015.5
.IP \(bu 2
f3bfdb561b Fixed urlparse and urlencode calls
.IP \(bu 2
802dbdb965 Added AWS v4 signature support for 2015.5
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23544\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-05\-11 18:02:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
06c6a1f44a Merge pull request \fI\%#23544\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
f8a36bc155 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
b79fed3a92 Merge pull request \fI\%#23538\fP from cro/licupdate
.INDENT 2.0
.IP \(bu 2
345efe25c9 Update date in LICENSE file
.UNINDENT
.IP \(bu 2
a123a36f05 Merge pull request \fI\%#23505\fP from aneeshusa/remove\-unused\-ssh\-config\-validator
.INDENT 2.0
.IP \(bu 2
90af1672ca Remove unused ssh config validator. Fixes \fI\%#23159\fP\&.
.UNINDENT
.IP \(bu 2
ca2c21a63c Merge pull request \fI\%#23467\fP from slinu3d/2014.7
.INDENT 2.0
.IP \(bu 2
0b4081d8f4 Fixed pylint error at line 363
.IP \(bu 2
5be5eb5b14 Fixed pylink errors
.IP \(bu 2
e64f374ffa Fixed lint errors
.IP \(bu 2
b9d1ac4f1f Added AWS v4 signature support
.UNINDENT
.IP \(bu 2
e6f9eec02e Merge pull request \fI\%#23444\fP from techhat/novacreateattach
.INDENT 2.0
.IP \(bu 2
ebdb7eae2d Add create_attach_volume to nova driver
.UNINDENT
.IP \(bu 2
e331463319 Merge pull request \fI\%#23460\fP from s0undt3ch/hotfix/bootstrap\-script\-2014.7
.INDENT 2.0
.IP \(bu 2
edcd0c41f2 Update to latest stable bootstrap script v2015.05.07
.UNINDENT
.IP \(bu 2
7a8ce1a954 Merge pull request \fI\%#23439\fP from techhat/maxtries
.INDENT 2.0
.IP \(bu 2
0ad3ff2c88 Add wait_for_passwd_maxtries variable
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23426\fP: (\fI\%twangboy\fP) Can\(aqt restart salt\-minion on 64 bit windows (2015.5.0) (refs: \fI\%#23470\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23470\fP: (\fI\%twangboy\fP) Fixed service.restart for salt\-minion
@ \fI2015\-05\-11 17:54:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
aa5b896d3e Merge pull request \fI\%#23470\fP from twangboy/fix_svc_restart
.IP \(bu 2
b3f284c517 Fixed tests
.IP \(bu 2
ad44d79f26 Fixed service.restart for salt\-minion
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23539\fP: (\fI\%rahulhan\fP) Adding states/virtualenv_mod.py unit tests
@ \fI2015\-05\-11 17:02:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
67988b21ee Merge pull request \fI\%#23539\fP from rahulhan/states_virtualenv_mod_unit_test
.IP \(bu 2
750bb07d1c Adding states/virtualenv_mod.py unit tests
.IP \(bu 2
c96619653e Merge pull request \fI\%#23423\fP from cachedout/remove_jid_event_from_orch
.INDENT 2.0
.IP \(bu 2
f81aab7627 Remove jid_event from state.orch
.UNINDENT
.IP \(bu 2
2bb09b7ee7 Merge pull request \fI\%#23509\fP from keesbos/Catch_empty_environment
.INDENT 2.0
.IP \(bu 2
6dedeaccd2 Catch the unset (empty/None) environment case
.UNINDENT
.IP \(bu 2
6d42f30271 Merge pull request \fI\%#23245\fP from freimer/issue_23244
.INDENT 2.0
.IP \(bu 2
24cf6ebad5 Add Caller functionality to reactors.
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23513\fP: (\fI\%gladiatr72\fP) short\-circuit auto\-failure of iptables.delete state
@ \fI2015\-05\-11 15:18:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3f03d827d Merge pull request \fI\%#23513\fP from gladiatr72/RFC_stop_iptables.check_from_short\-circuiting_position\-only_delete_rule
.IP \(bu 2
c71714c364 short\-circuit auto\-failure of iptables.delete state if position argument is set without the other accoutrements that check_rule requires.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23534\fP: (\fI\%jayeshka\fP) adding states/ini_manage unit test case
@ \fI2015\-05\-11 14:32:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
4e77f6f8c4 Merge pull request \fI\%#23534\fP from jayeshka/ini_manage_states\-unit\-test
.IP \(bu 2
831223c31c adding states/ini_manage unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23533\fP: (\fI\%jayeshka\fP) adding states/hipchat unit test case
@ \fI2015\-05\-11 14:30:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
11ba9ed99b Merge pull request \fI\%#23533\fP from jayeshka/hipchat\-states\-unit\-test
.IP \(bu 2
41d14b322d adding states/hipchat unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23532\fP: (\fI\%jayeshka\fP) adding states/ipmi unit test case
@ \fI2015\-05\-11 14:28:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
e5421139d3 Merge pull request \fI\%#23532\fP from jayeshka/ipmi\-states\-unit\-test
.IP \(bu 2
fc3e64a8a4 adding states/ipmi unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23531\fP: (\fI\%jayeshka\fP) adding service unit test case
@ \fI2015\-05\-11 14:27:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
9ba85fd31a Merge pull request \fI\%#23531\fP from jayeshka/service\-unit\-test
.IP \(bu 2
3ad5314ee0 adding service unit test case
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23512\fP: (\fI\%mostafahussein\fP) hipchat_returner / slack_returner not work correctly (refs: \fI\%#23517\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23517\fP: (\fI\%garethgreenaway\fP) fix to returners
@ \fI2015\-05\-11 14:20:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
32838cd888 Merge pull request \fI\%#23517\fP from garethgreenaway/23512_2015_5_returners_with_profiles
.IP \(bu 2
81e31e27cf fix for returners that utilize profile attributes.  code in the if else statement was backwards. \fI\%#23512\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23502\fP: (\fI\%rahulhan\fP) Adding states/win_servermanager.py unit tests
@ \fI2015\-05\-08 19:47:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
6be7d8d13b Merge pull request \fI\%#23502\fP from rahulhan/states_win_servermanager_unit_test
.IP \(bu 2
2490074aa2 Adding states/win_servermanager.py unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23495\fP: (\fI\%jayeshka\fP) adding seed unit test case
@ \fI2015\-05\-08 17:30:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
604857811e Merge pull request \fI\%#23495\fP from jayeshka/seed\-unit\-test
.IP \(bu 2
3f134bc573 adding seed unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23494\fP: (\fI\%jayeshka\fP) adding sensors unit test case
@ \fI2015\-05\-08 17:30:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
70bc3c1415 Merge pull request \fI\%#23494\fP from jayeshka/sensors\-unit\-test
.IP \(bu 2
1fb48a31a8 adding sensors unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23493\fP: (\fI\%jayeshka\fP) adding states/incron unit test case
@ \fI2015\-05\-08 17:29:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
b981b20d44 Merge pull request \fI\%#23493\fP from jayeshka/incron\-states\-unit\-test
.IP \(bu 2
cc7bc170f3 adding states/incron unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23492\fP: (\fI\%jayeshka\fP) adding states/influxdb_database unit test case
@ \fI2015\-05\-08 17:29:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
4019c493a1 Merge pull request \fI\%#23492\fP from jayeshka/influxdb_database\-states\-unit\-test
.IP \(bu 2
e1fcac815d adding states/influxdb_database unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23491\fP: (\fI\%jayeshka\fP) adding states/influxdb_user unit test case
@ \fI2015\-05\-08 16:24:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
d317a77afb Merge pull request \fI\%#23491\fP from jayeshka/influxdb_user\-states\-unit\-test
.IP \(bu 2
9d4043f9ff adding states/influxdb_user unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23477\fP: (\fI\%galet\fP) LDAP auth: Escape filter value for group membership search
@ \fI2015\-05\-07 22:04:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
e0b2a73eb4 Merge pull request \fI\%#23477\fP from galet/ldap\-filter\-escaping
.IP \(bu 2
33038b9f86 LDAP auth: Escape filter value for group membership search
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23476\fP: (\fI\%cachedout\fP) Lint becaon
@ \fI2015\-05\-07 19:55:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23431\fP: (\fI\%UtahDave\fP) Beacon fixes (refs: \fI\%#23476\fP)
.IP \(bu 2
e1719fe26b Merge pull request \fI\%#23476\fP from cachedout/lint_23431
.IP \(bu 2
8d1ff209eb Lint becaon
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23431\fP: (\fI\%UtahDave\fP) Beacon fixes (refs: \fI\%#23476\fP)
@ \fI2015\-05\-07 19:53:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
1e299ede4f Merge pull request \fI\%#23431\fP from UtahDave/beacon_fixes
.IP \(bu 2
152f2235c2 remove unused import
.IP \(bu 2
81198f9399 fix interval logic and example
.IP \(bu 2
5504778adf update to proper examples
.IP \(bu 2
6890439d58 fix list for mask
.IP \(bu 2
ee7b579e90 remove custom interval code.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23468\fP: (\fI\%rahulhan\fP) Adding states/win_system.py unit tests
@ \fI2015\-05\-07 19:20:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea55c44bbb Merge pull request \fI\%#23468\fP from rahulhan/states_win_system_unit_test
.IP \(bu 2
33f8c12e9f Adding states/win_system.py unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23466\fP: (\fI\%UtahDave\fP) minor spelling fix
@ \fI2015\-05\-07 19:19:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
e6e11147af Merge pull request \fI\%#23466\fP from UtahDave/2015.5local
.IP \(bu 2
b2c399a137 minor spelling fix
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#529\fP: (\fI\%rubic\fP) run salt in user space (refs: \fI\%#543\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#563\fP: (\fI\%notpeter\fP) Ubuntu alternate ppas (refs: \fI\%#23461\fP, \fI\%#23460\fP)
.IP \(bu 2
\fBPR\fP \fI\%#543\fP: (\fI\%rubic\fP) updated documentation for user, fixed configuration template links (refs: #\(gasaltstack/salt\-bootstrap#563\(ga_)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23461\fP: (\fI\%s0undt3ch\fP) [2015.5] Update to latest stable bootstrap script v2015.05.07
@ \fI2015\-05\-07 19:16:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
4eeb1e627a Merge pull request \fI\%#23461\fP from s0undt3ch/hotfix/bootstrap\-script
.IP \(bu 2
638c63d635 Update to latest stable bootstrap script v2015.05.07
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23450\fP: (\fI\%jayeshka\fP) adding scsi unit test case
@ \fI2015\-05\-07 19:00:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
865127844a Merge pull request \fI\%#23450\fP from jayeshka/scsi\-unit\-test
.IP \(bu 2
e7269ff29b adding scsi unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23449\fP: (\fI\%jayeshka\fP) adding s3 unit test case
@ \fI2015\-05\-07 18:59:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
8b374ae64d Merge pull request \fI\%#23449\fP from jayeshka/s3\-unit\-test
.IP \(bu 2
85786bfe7f adding s3 unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23448\fP: (\fI\%jayeshka\fP) adding states/keystone unit test case
@ \fI2015\-05\-07 18:58:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
49b431c8e4 Merge pull request \fI\%#23448\fP from jayeshka/keystone\-states\-unit\-test
.IP \(bu 2
a3050eb3e2 adding states/keystone unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23447\fP: (\fI\%jayeshka\fP) adding states/grafana unit test case
@ \fI2015\-05\-07 18:58:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
23d7e7ef92 Merge pull request \fI\%#23447\fP from jayeshka/grafana\-states\-unit\-test
.IP \(bu 2
7e90a4aaca adding states/grafana unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23438\fP: (\fI\%techhat\fP) Gate requests import
@ \fI2015\-05\-07 07:22:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
1fd0bc2011 Merge pull request \fI\%#23438\fP from techhat/gaterequests
.IP \(bu 2
d5b15fc6ce Gate requests import
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23429\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-05\-07 05:35:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
3c4f734332 Merge pull request \fI\%#23429\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
7729834d92 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
644eb75fec Merge pull request \fI\%#23422\fP from cro/gce_sh_home
.INDENT 2.0
.IP \(bu 2
4ef9e6ba06 Don\(aqt use $HOME to find user\(aqs directory, some shells don\(aqt set it
.UNINDENT
.IP \(bu 2
ef17ab4b2a Merge pull request \fI\%#23425\fP from basepi/functionwrapper_typo
.INDENT 2.0
.IP \(bu 2
c390737f3e Fix typo in FunctionWrapper
.UNINDENT
.IP \(bu 2
1b13ec04c2 Merge pull request \fI\%#23385\fP from rallytime/bp\-23346
.INDENT 2.0
.IP \(bu 2
9efc13c810 more linting fixes
.IP \(bu 2
cf131c9a5a cleaned up some pylint errors
.IP \(bu 2
f981699c75 added logic to sftp_file and file_map to allow folder uploads using file_map
.UNINDENT
.IP \(bu 2
f8c7a62089 Merge pull request \fI\%#23414\fP from jfindlay/update_branch
.INDENT 2.0
.IP \(bu 2
8074d16d52 2015.2 \-> 2015.5
.UNINDENT
.IP \(bu 2
54b3bd43e4 Merge pull request \fI\%#23404\fP from hvnsweeting/cherrypy\-post\-emptybody\-fix
.INDENT 2.0
.IP \(bu 2
f85f8f954c initialize var when POST body is empty
.UNINDENT
.IP \(bu 2
160f703296 Merge pull request \fI\%#23409\fP from terminalmage/update\-lithium\-docstrings\-2014.7
.INDENT 2.0
.IP \(bu 2
bc97d011ba Fix sphinx typo
.IP \(bu 2
20006b06f6 Update Lithium docstrings in 2014.7 branch
.UNINDENT
.IP \(bu 2
aa5fb0aa46 Merge pull request \fI\%#23397\fP from jfindlay/fix_locale_gen
.INDENT 2.0
.IP \(bu 2
0941fefd2b add more flexible whitespace to locale_gen search
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23396\fP: (\fI\%basepi\fP) [2015.2] Merge forward from 2014.7 to 2015.2
@ \fI2015\-05\-06 21:42:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
1fb84450f4 Merge pull request \fI\%#23396\fP from basepi/merge\-forward\-2015.2
.IP \(bu 2
2766c8cb4b Fix typo in FunctionWrapper
.IP \(bu 2
fd09cdae6f Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.2
.INDENT 2.0
.IP \(bu 2
0c76dd4d8a Merge pull request \fI\%#23368\fP from kaithar/bp\-23367
.INDENT 2.0
.IP \(bu 2
577f41972e Pylint fix
.IP \(bu 2
8d9acd1f89 Put the sed insert statement back in to the output.
.UNINDENT
.IP \(bu 2
3493cc1fca Merge pull request \fI\%#23350\fP from lorengordon/file.replace_assume_line
.INDENT 2.0
.IP \(bu 2
b60e224beb Append/prepend: search for full line
.UNINDENT
.IP \(bu 2
7be5c48ad5 Merge pull request \fI\%#23341\fP from cachedout/issue_23026
.INDENT 2.0
.IP \(bu 2
e98e65e787 Fix tests
.IP \(bu 2
6011b437ca Fix syndic pid and logfile path
.UNINDENT
.IP \(bu 2
ea61abfa68 Merge pull request \fI\%#23272\fP from basepi/salt\-ssh.minion.config.19114
.INDENT 2.0
.IP \(bu 2
c223309bb7 Add versionadded
.IP \(bu 2
be7407feae Lint
.IP \(bu 2
c2c337567e Missing comma
.IP \(bu 2
8e3e8e073a Pass the minion_opts through the FunctionWrapper
.IP \(bu 2
cb69cd07de Match the master config template in the master config reference
.IP \(bu 2
87fc3161f9 Add Salt\-SSH section to master config template
.IP \(bu 2
91dd9dcbdc Add ssh_minion_opts to master config ref
.IP \(bu 2
c273ea14c6 Add minion config to salt\-ssh doc
.IP \(bu 2
a0b6b760c3 Add minion_opts to roster docs
.IP \(bu 2
5212c35260 Accept minion_opts from the target information
.IP \(bu 2
e2099b6e1b Process \fIssh_minion_opts\fP from master config
.IP \(bu 2
3b64214377 Revert \(dqWork around bug in salt\-ssh in config.get for gpg renderer\(dq
.IP \(bu 2
494953a208 Remove the strip (embracing multi\-line YAML dump)
.IP \(bu 2
fe87f0fe39 Dump multi\-line yaml into the SHIM
.IP \(bu 2
b751a7281c Inject local minion config into shim if available
.UNINDENT
.IP \(bu 2
4f760dd9cb Merge pull request \fI\%#23347\fP from basepi/salt\-ssh.functionwrapper.contains.19114
.INDENT 2.0
.IP \(bu 2
30595e3ff7 Backport FunctionWrapper.__contains__
.UNINDENT
.IP \(bu 2
02658b1e60 Merge pull request \fI\%#23344\fP from cachedout/issue_22742
.INDENT 2.0
.IP \(bu 2
5adc96ce7f Explicitly set file_client on master
.UNINDENT
.IP \(bu 2
ba7605d1cb Merge pull request \fI\%#23318\fP from cellscape/honor\-seed\-argument
.INDENT 2.0
.IP \(bu 2
228b1be299 Honor seed argument in LXC container initializaton
.UNINDENT
.IP \(bu 2
4ac4509c57 Merge pull request \fI\%#23307\fP from jfindlay/fix_locale_gen
.INDENT 2.0
.IP \(bu 2
101199ac14 check for /etc/locale.gen
.UNINDENT
.IP \(bu 2
f790f42ed6 Merge pull request \fI\%#23324\fP from s0undt3ch/hotfix/bootstrap\-script\-2014.7
.IP \(bu 2
6643e47ce5 Update to the latest stable release of the bootstrap script v2015.05.04
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23412\fP: (\fI\%rahulhan\fP) Adding states/win_update.py unit tests
@ \fI2015\-05\-06 18:31:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
b3c16720f6 Merge pull request \fI\%#23412\fP from rahulhan/states_win_update_unit_test
.IP \(bu 2
9bc1519ee7 Removed unwanted imports
.IP \(bu 2
f12bfcf248 Adding states/win_update.py unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23413\fP: (\fI\%terminalmage\fP) Update manpages for 2015.2 \-> 2015.5
@ \fI2015\-05\-06 17:12:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
f2d7646a58 Merge pull request \fI\%#23413\fP from terminalmage/update\-manpages
.IP \(bu 2
23fa4402dc Update manpages to reflect 2015.2 rename to 2015.5
.IP \(bu 2
0fdaa73c84 Fix missed docstring updates from 2015.2 \-> 2015.5
.IP \(bu 2
4fea5ba477 Add missing RST file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23410\fP: (\fI\%terminalmage\fP) Update Lithium docstrings in 2015.2 branch
@ \fI2015\-05\-06 15:53:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23409\fP: (\fI\%terminalmage\fP) Update Lithium docstrings in 2014.7 branch (refs: \fI\%#23410\fP)
.IP \(bu 2
bafbea7bc7 Merge pull request \fI\%#23410\fP from terminalmage/update\-lithium\-docstrings\-2015.2
.IP \(bu 2
d395565bf7 Update Lithium docstrings in 2015.2 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23407\fP: (\fI\%jayeshka\fP) adding rsync unit test case
@ \fI2015\-05\-06 15:52:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
02ef41a549 Merge pull request \fI\%#23407\fP from jayeshka/rsync\-unit\-test
.IP \(bu 2
a4dd836125 adding rsync unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23406\fP: (\fI\%jayeshka\fP) adding states/lxc unit test case
@ \fI2015\-05\-06 15:51:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
58ec2a24c1 Merge pull request \fI\%#23406\fP from jayeshka/lxc\-states\-unit\-test
.IP \(bu 2
32a0d03093 adding states/lxc unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23395\fP: (\fI\%basepi\fP) [2015.2] Add note to 2015.2.0 release notes about master opts in pillar
@ \fI2015\-05\-05 22:15:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
8837d0038e Merge pull request \fI\%#23395\fP from basepi/2015.2.0masteropts
.IP \(bu 2
b261c95cd6 Add note to 2015.2.0 release notes about master opts in pillar
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23393\fP: (\fI\%basepi\fP) [2015.2] Add warning about python_shell changes to 2015.2.0 release notes
@ \fI2015\-05\-05 22:12:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
f79aed5fe1 Merge pull request \fI\%#23393\fP from basepi/2015.2.0python_shell
.IP \(bu 2
b2f033f485 Add CLI note
.IP \(bu 2
48e7b3ee4f Add warning about python_shell changes to 2015.2.0 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23380\fP: (\fI\%gladiatr72\fP) Fix for double output with static  salt cli/v2015.2
@ \fI2015\-05\-05 21:44:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
a9777761d8 Merge pull request \fI\%#23380\fP from gladiatr72/fix_for_double_output_with_static__salt_CLI/v2015.2
.IP \(bu 2
c47fdd79c7 Actually removed the \fBstatic\fP bits from below the else: fold this time.
.IP \(bu 2
4ee367956c Fix for incorrect output with salt CLI \-\-static option
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23379\fP: (\fI\%rahulhan\fP) Adding states/rabbitmq_cluster.py
@ \fI2015\-05\-05 21:44:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
5c9543c1d2 Merge pull request \fI\%#23379\fP from rahulhan/states_rabbitmq_cluster_test
.IP \(bu 2
04c22d1acf Adding states/rabbitmq_cluster.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23377\fP: (\fI\%rahulhan\fP) Adding states/xmpp.py unit tests
@ \fI2015\-05\-05 21:43:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
430f080a3a Merge pull request \fI\%#23377\fP from rahulhan/states_xmpp_test
.IP \(bu 2
32923b53c3 Adding states/xmpp.py unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23335\fP: (\fI\%steverweber\fP) 2015.2: include doc in master config for module_dirs
@ \fI2015\-05\-05 21:28:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
8c057e6794 Merge pull request \fI\%#23335\fP from steverweber/2015.2
.IP \(bu 2
5e3bae95d8 help installing python pysphere lib
.IP \(bu 2
97513b060a include module_dirs
.IP \(bu 2
36b1c87dd2 include module_dirs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23362\fP: (\fI\%jayeshka\fP) adding states/zk_concurrency unit test case
@ \fI2015\-05\-05 15:50:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
1648253675 Merge pull request \fI\%#23362\fP from jayeshka/zk_concurrency\-states\-unit\-test
.IP \(bu 2
f60dda4b1d adding states/zk_concurrency unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23363\fP: (\fI\%jayeshka\fP) adding riak unit test case
@ \fI2015\-05\-05 14:23:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
1cdaeed868 Merge pull request \fI\%#23363\fP from jayeshka/riak\-unit\-test
.IP \(bu 2
f9da6db459 adding riak unit test case
.UNINDENT
.UNINDENT
.SS Salt 2015.5.10 Release Notes
.INDENT 0.0
.TP
.B release
2015\-03\-22
.UNINDENT
.sp
Version 2015.5.10 is a bugfix release for \fI\%2015.5.0\fP\&.
.SS Security Fix
.sp
\fBCVE\-2016\-3176\fP Insecure configuration of PAM external authentication service
.sp
This issue affects all Salt versions prior to 2015.8.8/2015.5.10 when PAM
\fI\%external authentication\fP is enabled. This issue involves
passing an alternative PAM authentication service with a command that is sent
to \fI\%LocalClient\fP, enabling the attacker to bypass the
configured authentication service. Thank you to Dylan Frese <\fI\%dmfrese@gmail.com\fP>
for bringing this issue to our attention.
.sp
This update defines the PAM eAuth \fBservice\fP that users authenticate against
in the Salt Master configuration.
.sp
No additional fixes are included in this release.
.SS Read Before Upgrading Debian 8 (Jessie) from Salt Versions Earlier than 2015.5.9
.sp
Salt \fBsystemd\fP service files are missing the following statement in these versions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[Service]
KillMode=process
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This statement must be added to successfully upgrade on these earlier versions
of Salt.
.SS Changelog for v2015.5.9..v2015.5.10
.sp
\fIGenerated at: 2018\-05\-27 22:39:26 UTC\fP
.INDENT 0.0
.IP \(bu 2
69ba1de71d Remove ability of authenticating user to specify pam service
.UNINDENT
.SS Salt 2015.5.11 Release Notes
.INDENT 0.0
.TP
.B release
2015\-07\-22
.UNINDENT
.sp
Version 2015.5.11 is a bugfix release for \fI\%2015.5.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB101\fP
.IP \(bu 2
Total Issue References: \fB73\fP
.IP \(bu 2
Total PR References: \fB162\fP
.IP \(bu 2
Contributors: \fB46\fP (\fI\%AndrewPashkin\fP, \fI\%Ch3LL\fP, \fI\%DmitryKuzmenko\fP, \fI\%TheNullByte\fP, \fI\%UtahDave\fP,
\fI\%abednarik\fP, \fI\%amontalban\fP, \fI\%anlutro\fP, \fI\%attiasr\fP, \fI\%basepi\fP, \fI\%borgstrom\fP, \fI\%brejoc\fP,
\fI\%bstevenson\fP, \fI\%cachedout\fP, \fI\%carlwgeorge\fP, \fI\%efficks\fP, \fI\%gerhardqux\fP, \fI\%gtmanfred\fP, \fI\%heyfife\fP,
\fI\%jacobhammons\fP, \fI\%jfindlay\fP, \fI\%justinta\fP, \fI\%lomeroe\fP, \fI\%lorengordon\fP, \fI\%mtorromeo\fP, \fI\%nmadhok\fP,
\fI\%notpeter\fP, \fI\%paclat\fP, \fI\%pcn\fP, \fI\%phistrom\fP, \fI\%rallytime\fP, \fI\%robgott\fP, \fI\%sacren\fP, \fI\%sastorsl\fP,
\fI\%serge\-p\fP, \fI\%sjmh\fP, \fI\%sjorge\fP, \fI\%techhat\fP, \fI\%terminalmage\fP, \fI\%thatch45\fP, \fI\%thegoodduke\fP,
\fI\%toanju\fP, \fI\%tomwalsh\fP, \fI\%twangboy\fP, \fI\%whiteinge\fP, \fI\%yannis666\fP)
.UNINDENT
.SS Changelog for v2015.5.10..v2015.5.11
.sp
\fIGenerated at: 2018\-05\-27 22:41:56 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#33412\fP: (\fI\%jfindlay\fP) update 2015.5.11 release notes
.IP \(bu 2
\fBPR\fP \fI\%#33405\fP: (\fI\%rallytime\fP) Back\-port \fI\%#33386\fP to 2015.5
.IP \(bu 2
\fBPR\fP \fI\%#33386\fP: (\fI\%terminalmage\fP) Fix traceback in logging for config validation (refs: \fI\%#33405\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#33376\fP: (\fI\%tmehlinger\fP) pip state broken in 2015.8.9 with pip <6.0 (refs: \fI\%#33383\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33383\fP: (\fI\%thatch45\fP) maintain the fallabck because I am totally sick of this crap
@ \fI2016\-05\-20 00:03:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
d15f5e2cef Merge pull request \fI\%#33383\fP from thatch45/2015.5
.IP \(bu 2
f5ebcba21c restore whitespace
.IP \(bu 2
1d8b289db1 blast, put the try/except int he right place
.IP \(bu 2
081e6c5b83 maintain the fallabck because I am totally sick of this crap
.IP \(bu 2
\fBPR\fP \fI\%#33379\fP: (\fI\%cachedout\fP) Improve doc clarity for disable_modules documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26574\fP: (\fI\%jfindlay\fP) minion stacktrace on top file yaml syntax error (refs: \fI\%#33375\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33375\fP: (\fI\%cachedout\fP) Better YAML syntax error handling
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33372\fP: (\fI\%jacobhammons\fP) revved 2015.8 branch to .9 in version selector
@ \fI2016\-05\-19 20:05:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb3e98cad2 Merge pull request \fI\%#33372\fP from jacobhammons/release\-update
.IP \(bu 2
5ce502160b revved 2015.8 branch to .9 in version selector
.IP \(bu 2
\fBPR\fP \fI\%#33341\fP: (\fI\%phistrom\fP) Expanded documentation for boto_elb state and module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32400\fP: (\fI\%rallytime\fP) Document Default Config Values (refs: \fI\%#33286\fP, \fI\%#33292\fP, \fI\%#32538\fP, \fI\%#33287\fP, \fI\%#32454\fP, \fI\%#33282\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33292\fP: (\fI\%rallytime\fP) Added some more docs for master and minion config settings
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23643\fP: (\fI\%falzm\fP) Error in iptables module: argument \-\-match\-set: expected 2 argument(s) (refs: \fI\%#33301\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33301\fP: (\fI\%gerhardqux\fP) Fix iptables \-\-match\-set (\fI\%#23643\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33290\fP: (\fI\%UtahDave\fP) fix \(dqloose\(dq typo
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32400\fP: (\fI\%rallytime\fP) Document Default Config Values (refs: \fI\%#33286\fP, \fI\%#33292\fP, \fI\%#32538\fP, \fI\%#33287\fP, \fI\%#32454\fP, \fI\%#33282\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33287\fP: (\fI\%rallytime\fP) Add auth_tries config option to minion.rst docs
.IP \(bu 2
\fBPR\fP \fI\%#33286\fP: (\fI\%rallytime\fP) Document new master and minion config opts for 2016.3.0 (refs: \fI\%#33287\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33276\fP: (\fI\%sjmh\fP) minion_id_caching has no documentation (refs: \fI\%#33282\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#32400\fP: (\fI\%rallytime\fP) Document Default Config Values (refs: \fI\%#33286\fP, \fI\%#33292\fP, \fI\%#32538\fP, \fI\%#33287\fP, \fI\%#32454\fP, \fI\%#33282\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33282\fP: (\fI\%rallytime\fP) Document minion_id_caching config value
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33118\fP: (\fI\%saltuser\fP) file.replace not working correctly on newer minions (refs: \fI\%#33137\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33137\fP: (\fI\%lorengordon\fP) Clarify file.replace MULTILINE flag interaction with regex anchors
.IP \(bu 2
\fBPR\fP \fI\%#33236\fP: (\fI\%jfindlay\fP) update 2015.5.11 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32250\fP: (\fI\%ikryten\fP) Cannot run salt\-minion as unprivileged user using \(aquser\(aq directive (refs: \fI\%#33211\fP)
.IP \(bu 2
\fBPR\fP \fI\%#33211\fP: (\fI\%cachedout\fP) Don\(aqt try to kill a parent proc if we can\(aqt
@ \fI2016\-05\-12 21:29:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
698f1eb657 Merge pull request \fI\%#33211\fP from cachedout/user_kill
.IP \(bu 2
d4f2e5baa7 Don\(aqt try to kill a parent proc if we can\(aqt
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32198\fP: (\fI\%goatjam\fP) State \(aqpkg.installed\(aq was not found in SLS (refs: \fI\%#33205\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33205\fP: (\fI\%cachedout\fP) Resolve issue with pkg module on Mint Linux
.IP \(bu 2
\fBPR\fP \fI\%#33178\fP: (\fI\%justinta\fP) Add pip installed and removed test
.IP \(bu 2
\fBPR\fP \fI\%#33197\fP: (\fI\%jfindlay\fP) update 2015.5.11 release notes
.IP \(bu 2
\fBPR\fP \fI\%#33181\fP: (\fI\%twangboy\fP) Fix file.managed for Windows
.IP \(bu 2
\fBPR\fP \fI\%#33185\fP: (\fI\%rallytime\fP) [2015.5] Update to latest bootstrap script v2016.05.11
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33163\fP: (\fI\%jaybocc2\fP) Salt 2015.8.5 incompatible with Pip v8.1.2 (refs: \fI\%#33180\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33180\fP: (\fI\%thatch45\fP) Pip fix
.IP \(bu 2
\fBPR\fP \fI\%#33160\fP: (\fI\%jfindlay\fP) add 2015.5.11 release notes
.IP \(bu 2
\fBPR\fP \fI\%#33155\fP: (\fI\%rallytime\fP) [2015.5] Update to latest bootstrap script v2016.05.10
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#33141\fP: (\fI\%justinta\fP) Skipping salt\-call \-\-local test
@ \fI2016\-05\-10 17:05:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
6cd1641840 Merge pull request \fI\%#33141\fP from jtand/disable_local_pkg_install_test
.IP \(bu 2
8b1e34fb17 Skipping salt\-call \-\-local test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33085\fP: (\fI\%fmnisme\fP) salt doc err (refs: \fI\%#33132\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33132\fP: (\fI\%whiteinge\fP) Doc mock decorators
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#33074\fP: (\fI\%robnagler\fP) Critical error in msgpack exposes pillar data (refs: \fI\%#33078\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#33078\fP: (\fI\%cachedout\fP) Lower display of msgpack failure msg to debug
.IP \(bu 2
\fBPR\fP \fI\%#33080\fP: (\fI\%justinta\fP) Use saltstack repo in buildpackage.py on CentOS 5
.IP \(bu 2
\fBPR\fP \fI\%#33025\fP: (\fI\%Ch3LL\fP) add test for installing package while using salt\-call \-\-local
.IP \(bu 2
\fBPR\fP \fI\%#33055\fP: (\fI\%justinta\fP) File and User test fixes for 2015.5 on Fedora23
.IP \(bu 2
\fBPR\fP \fI\%#33060\fP: (\fI\%Ch3LL\fP) Test pillar.items output
.IP \(bu 2
\fBPR\fP \fI\%#33067\fP: (\fI\%sacren\fP) Fix minor document error of test.assertion
.IP \(bu 2
\fBPR\fP \fI\%#33045\fP: (\fI\%Ch3LL\fP) Saltfile with pillar tests
.IP \(bu 2
\fBPR\fP \fI\%#33044\fP: (\fI\%thatch45\fP) Backport \fI\%#33021\fP manually to 2015.5
.IP \(bu 2
\fBPR\fP \fI\%#33021\fP: (\fI\%UtahDave\fP) Fix syndic regression (refs: \fI\%#33044\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22580\fP: (\fI\%ryanwalder\fP) minion runs highstate on start if schedule set in pillar  (refs: \fI\%#32958\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32958\fP: (\fI\%rallytime\fP) Add run_on_start docs to schedule.rst
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23714\fP: (\fI\%naemono\fP) file.copy force ignored during highstate, but not with \(aqsalt\-call state.sls_id\(aq (refs: \fI\%#32732\fP, \fI\%#32848\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32848\fP: (\fI\%lomeroe\fP) backport PR \fI\%#32732\fP to 2015.5 fixes \fI\%#23714\fP
.IP \(bu 2
\fBPR\fP \fI\%#32732\fP: (\fI\%lomeroe\fP) correct use of force flag in file.copy \fI\%#23714\fP (refs: \fI\%#32848\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32837\fP: (\fI\%jfindlay\fP) \fIsalt\-cloud \-u\fP downloads stable version from bootstrap.saltstack.com by default
.IP \(bu 2
\fBPR\fP \fI\%#32667\fP: (\fI\%jfindlay\fP) [2015.5] update bootstrap to 2016.04.18 release
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32776\fP: (\fI\%rallytime\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2016\-04\-25 15:18:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
c842e1e437 Merge pull request \fI\%#32776\fP from rallytime/merge\-2015.5
.IP \(bu 2
7ecbf9f885 Merge pull request \fI\%#14\fP from whiteinge/runner\-async\-low
.INDENT 2.0
.IP \(bu 2
211f7b4af1 Format low data correct for runner_async
.UNINDENT
.IP \(bu 2
ce72851861 Merge branch \(aq2014.7\(aq into \(aq2015.5\(aq
.IP \(bu 2
2775edc176 Saltnado /run fix (\fI\%#32590\fP)
.IP \(bu 2
b19c5a5ce7 Verify auth in saltnado run (\fI\%#32552\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32691\fP: (\fI\%terminalmage\fP) Support remote sources in a source list
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32661\fP: (\fI\%dergrunepunkt\fP) Batch exception w/dulpicated minion IDs (refs: \fI\%#32686\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32686\fP: (\fI\%cachedout\fP) Fix stacktrace in batch with dup minion ids
@ \fI2016\-04\-19 19:18:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd5442d768 Merge pull request \fI\%#32686\fP from cachedout/issue_32661
.IP \(bu 2
f704df90bc Fix stacktrace in batch with dup minion ids
.IP \(bu 2
\fBPR\fP \fI\%#32675\fP: (\fI\%basepi\fP) [2015.5] Update \(dqLow Hanging Fruit\(dq to \(dqHelp Wanted\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32612\fP: (\fI\%oliver\-dungey\fP) Calling Salt Modules from Templates \- more complex examples would be great (refs: \fI\%#32657\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32657\fP: (\fI\%cachedout\fP) Additional documentation on calling exec modules from templates
.IP \(bu 2
\fBPR\fP \fI\%#32639\fP: (\fI\%nmadhok\fP) [2015.5] \- Fixing critical bug to remove only the specified Host instead of the entire Host cluster
.IP \(bu 2
\fBPR\fP \fI\%#32638\fP: (\fI\%nmadhok\fP) [2015.5] Adding _syspaths.py to .gitignore
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32381\fP: (\fI\%tbaker57\fP) user.present state includes shadow hash in return when user updated  (refs: \fI\%#32561\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32561\fP: (\fI\%gtmanfred\fP) redact passwords and hashes from user.present updates
@ \fI2016\-04\-14 15:48:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
027b502335 Merge pull request \fI\%#32561\fP from gtmanfred/user_passwords
.IP \(bu 2
3db5e78d5d redact passwords and hashes from user.present updates
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32400\fP: (\fI\%rallytime\fP) Document Default Config Values (refs: \fI\%#33286\fP, \fI\%#33292\fP, \fI\%#32538\fP, \fI\%#33287\fP, \fI\%#32454\fP, \fI\%#33282\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32538\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32528\fP to 2015.5
@ \fI2016\-04\-13 15:06:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32528\fP: (\fI\%AndrewPashkin\fP) Document \(dqgrains\(dq setting in the minion configuration reference (refs: \fI\%#32538\fP)
.IP \(bu 2
7307bcb88e Merge pull request \fI\%#32538\fP from rallytime/bp\-32528
.IP \(bu 2
46a4e8a310 Remove merge conflict line
.IP \(bu 2
e0d947c707 Document \(dqgrains\(dq setting in the minion configuration reference
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32400\fP: (\fI\%rallytime\fP) Document Default Config Values (refs: \fI\%#33286\fP, \fI\%#33292\fP, \fI\%#32538\fP, \fI\%#33287\fP, \fI\%#32454\fP, \fI\%#33282\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32454\fP: (\fI\%rallytime\fP) Add documentation for some master/minion configs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32413\fP: (\fI\%commutecat\fP) Raspbian detected by both systemd.py and service.py __virtual__ functions (refs: \fI\%#32421\fP, \fI\%#32458\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32458\fP: (\fI\%terminalmage\fP) Improve and clarify docs on provider overrides.
@ \fI2016\-04\-09 14:25:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
100c6e1b25 Merge pull request \fI\%#32458\fP from terminalmage/clarify\-providers\-docs
.IP \(bu 2
500d3ebbaa Add link to provider override docs to all group providers
.IP \(bu 2
83ca01f620 dd link to provider override docs to all shadow providers
.IP \(bu 2
c5fe38789d Add link to provider override docs to all user providers
.IP \(bu 2
5c1c1dda59 Add link to provider override docs to all service providers
.IP \(bu 2
736f2befc9 Add link to provider override docs to all package providers
.IP \(bu 2
f9306347cc Clarify the scope of the provider param in states.
.IP \(bu 2
af24c82ab0 Add documentation on virtual module provider overrides to the module docs
.IP \(bu 2
0bc6c97a63 Improve docstrings
.IP \(bu 2
1948920674 Add external ref to windows package manager docs
.IP \(bu 2
e7fa21438c Add new doc pages to toctree
.IP \(bu 2
f0de1236ec Move the tables of virtual modules to individual documentation pages
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#11497\fP: (\fI\%eeaston\fP) cmd.run cwd should not be checked before preconditions (refs: \fI\%#32293\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32418\fP: (\fI\%rallytime\fP) Merge \fI\%#32293\fP with test fixes
.IP \(bu 2
\fBPR\fP \fI\%#32293\fP: (\fI\%efficks\fP) Fix issue \fI\%#11497\fP (refs: \fI\%#32418\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32413\fP: (\fI\%commutecat\fP) Raspbian detected by both systemd.py and service.py __virtual__ functions (refs: \fI\%#32421\fP, \fI\%#32458\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32421\fP: (\fI\%terminalmage\fP) Ignore Raspbian in service.py __virtual__
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#1409\fP: (\fI\%twinshadow\fP) module/network.py: Interfaces do not list multiple addresses
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#28262\fP: (\fI\%palica\fP) FreeBSD pkgng provider raising error for minion (refs: \fI\%#32376\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#28262\fP: (\fI\%palica\fP) FreeBSD pkgng provider raising error for minion (refs: \fI\%#32399\fP, \fI\%#32376\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32399\fP: (\fI\%amontalban\fP) Backport to fix \fI\%#28262\fP for 2015.5 as requested in PR \fI\%#32376\fP
@ \fI2016\-04\-06 22:48:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32376\fP: (\fI\%amontalban\fP) Fixes \fI\%saltstack/salt#28262\fP (refs: \fI\%#32399\fP)
.IP \(bu 2
a36866d7db Merge pull request \fI\%#32399\fP from amontalban/2015.5
.IP \(bu 2
e1ffbd615a Fixes \fI\%saltstack/salt#28262\fP for 2015.5 branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32066\fP: (\fI\%guettli\fP) Proxmox docs outdated (refs: \fI\%#32374\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32374\fP: (\fI\%cachedout\fP) Update proxmox documentation
@ \fI2016\-04\-05 22:25:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
3f03c5fcf9 Merge pull request \fI\%#32374\fP from cachedout/issue_32066
.IP \(bu 2
62389d1d1a Update proxmox documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32339\fP: (\fI\%Ch3LL\fP) remove reference to master_alive_check in 2015.5
@ \fI2016\-04\-04 20:39:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
8578089beb Merge pull request \fI\%#32339\fP from Ch3LL/fix_doc_multi\-master
.IP \(bu 2
2774da288d remove reference to master_alive_check
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32044\fP: (\fI\%ScoreUnder\fP) Multiple masters throwing warnings? \(dqKey master with value [...] has an invalid type of list, a str is required for this value\(dq (refs: \fI\%#32129\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32284\fP: (\fI\%rallytime\fP) Audit config.py default types and values
@ \fI2016\-04\-02 02:00:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32129\fP: (\fI\%terminalmage\fP) Support multiple valid option types when performing type checks (refs: \fI\%#32284\fP)
.IP \(bu 2
fbdc47cc55 Merge pull request \fI\%#32284\fP from rallytime/config\-audit
.IP \(bu 2
0491513204 Don\(aqt be so explicit. Just use string_types.
.IP \(bu 2
083c477fd3 Use six.string_types in config default tuples
.IP \(bu 2
7e642b8381 Audit config.py default types and values \- first sweep
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32301\fP: (\fI\%terminalmage\fP) pkg.latest_version returns inaccurate version when blank \(dqRelease\(dq param set in package metadata (refs: \fI\%#32302\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32302\fP: (\fI\%terminalmage\fP) Properly support packages with blank \(dqRelease\(dq param in pkg.latest_version
@ \fI2016\-04\-01 22:13:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a6d44e57b Merge pull request \fI\%#32302\fP from terminalmage/fix\-missing\-release
.IP \(bu 2
413c371ccd Properly support packages with blank \(dqRelease\(dq param in pkg.latest_version
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31963\fP: (\fI\%UtahDave\fP) pkgrepo.managed state test=True doesn\(aqt actually test if changes need to be made. (refs: \fI\%#32162\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32162\fP: (\fI\%terminalmage\fP) Properly handle yum/zypper repositories in pkgrepo.managed
@ \fI2016\-03\-30 17:51:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
5d08db7c92 Merge pull request \fI\%#32162\fP from terminalmage/issue31963
.IP \(bu 2
5c1bdb812c Fix pkgrepo integration test
.IP \(bu 2
e7fb3095ce Properly handle yum/zypper repositories in pkgrepo.managed
.IP \(bu 2
add2111fec Use six.iteritems instead of dict.items
.IP \(bu 2
6c21881c38 Docstring tweaks
.IP \(bu 2
ecbb78b649 Remove useless function
.IP \(bu 2
06f3309552 Normalize variable naming to match other functions
.IP \(bu 2
690537ca8b Look for apt\-add\-repository in PATH instead of assuming it\(aqs there
.IP \(bu 2
709d80bb1b aptpkg: Accept **kwargs instead of a dict for pkg.expand_repo_def
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31976\fP: (\fI\%moltob\fP) Schedules not persisted on Windows minion (Installer issue) (refs: \fI\%#32223\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32223\fP: (\fI\%twangboy\fP) Create minion.d directory on install for Windows
@ \fI2016\-03\-30 14:43:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
4fcdaab428 Merge pull request \fI\%#32223\fP from twangboy/fix_31976
.IP \(bu 2
b7fcae97ce Create minion.d directory, fixes \fI\%#31976\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31501\fP: (\fI\%grep4linux\fP) Salt states fail with error  \(aqFailed to return clean data\(aq when using salt\-ssh in Amazon EC2  (refs: \fI\%#32218\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32218\fP: (\fI\%cachedout\fP) Only display error when tty is True in salt\-ssh
@ \fI2016\-03\-29 19:13:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
3309ff6a29 Merge pull request \fI\%#32218\fP from cachedout/issue_31501
.IP \(bu 2
6795d6aef0 Only display error when tty is True in salt\-ssh
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32196\fP: (\fI\%justinta\fP) Fixed pylint error in app_pam_test.py
@ \fI2016\-03\-28 23:59:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
6e0cb22c96 Merge pull request \fI\%#32196\fP from jtand/cherrypy_pam_test_lint_fix
.IP \(bu 2
bd3942e0fd Fixed pylint error in app_pam_test.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32154\fP: (\fI\%Ch3LL\fP) Add integration tests for salt\-api using pam eauth
@ \fI2016\-03\-28 16:06:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31826\fP: (\fI\%gtmanfred\fP) Remove ability of authenticating user to specify pam service (refs: \fI\%#32154\fP)
.IP \(bu 2
6b8b8b51c0 Merge pull request \fI\%#32154\fP from Ch3LL/ch3ll_pam_2015.5
.IP \(bu 2
ba605b0128 fix more pylint and add ability to close cherrypy engine
.IP \(bu 2
2d4dc4da05 add teardown call
.IP \(bu 2
d115878714 fix pylint error
.IP \(bu 2
4c1ab082b6 add pam salt\-api tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32170\fP: (\fI\%gtmanfred\fP) add name for lxc for use with cloud cache
@ \fI2016\-03\-28 14:34:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
230443be6c Merge pull request \fI\%#32170\fP from gtmanfred/lxc_cloud_name
.IP \(bu 2
eb7d82e7be add name for lxc for use with cloud cache
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31731\fP: (\fI\%sjorge\fP) rh_service references osrelease before it is available, also does not return bool (refs: \fI\%#32165\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32165\fP: (\fI\%terminalmage\fP) Make __virtual__ for rhservice.py more robust (refs: \fI\%#32164\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32164\fP: (\fI\%terminalmage\fP) Make __virtual__ for rhservice.py more robust (2015.5 branch) (refs: \fI\%#32165\fP)
@ \fI2016\-03\-27 18:21:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
32b0421a34 Merge pull request \fI\%#32164\fP from terminalmage/issue31731\-2015.5
.IP \(bu 2
18439c4f89 Make __virtual__ for rhservice.py more robust (2015.5 branch)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32141\fP: (\fI\%paclat\fP) fixes 32108
@ \fI2016\-03\-25 16:50:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
6212e9aa56 Merge pull request \fI\%#32141\fP from paclat/issue_32108
.IP \(bu 2
72c5d12d43 fixes 32108
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32044\fP: (\fI\%ScoreUnder\fP) Multiple masters throwing warnings? \(dqKey master with value [...] has an invalid type of list, a str is required for this value\(dq (refs: \fI\%#32129\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32129\fP: (\fI\%terminalmage\fP) Support multiple valid option types when performing type checks (refs: \fI\%#32284\fP)
@ \fI2016\-03\-24 21:16:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
bdd7ea89d5 Merge pull request \fI\%#32129\fP from terminalmage/issue32044
.IP \(bu 2
34ca1ea12e Change type check errors to debug loglevel
.IP \(bu 2
5462081488 Support multiple valid option types when performing type checks
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32052\fP: (\fI\%bstevenson\fP) list_absent function doesn\(aqt loop through list of values (refs: \fI\%#32056\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32056\fP: (\fI\%bstevenson\fP) Fix list absent
@ \fI2016\-03\-24 17:35:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
c42014eb54 Merge pull request \fI\%#32056\fP from bstevenson/fix\-list_absent
.IP \(bu 2
1500aae027 set deleted value to list
.IP \(bu 2
1dc8f5f289 unit test update
.IP \(bu 2
39adf86fec Fixed negation logic
.IP \(bu 2
be9388173b Removed has_key in lieu of in
.IP \(bu 2
e48593ed81 Comments and Changes output fixes
.IP \(bu 2
b98f5517de Updated to conform to proper ret values
.IP \(bu 2
d18b4be80b remove whitespace end of line 186:q
.IP \(bu 2
d2b89c85ad fix formatting
.IP \(bu 2
103cee9e29 cleaned up formatting
.IP \(bu 2
7a4d7f0bff added whitespace
.IP \(bu 2
8ea5b545b0 Loop through list values in list_absent
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32096\fP: (\fI\%rallytime\fP) Back\-port \fI\%#32065\fP to 2015.5
@ \fI2016\-03\-23 22:01:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#32065\fP: (\fI\%TheNullByte\fP) Fix an issue with the minion targeting example in docs (refs: \fI\%#32096\fP)
.IP \(bu 2
848ce5647f Merge pull request \fI\%#32096\fP from rallytime/bp\-32065
.IP \(bu 2
36a9d6a374 Fix an issue with the minion targeting example
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32104\fP: (\fI\%jacobhammons\fP) One additional known issue for 2015.5.10 release notes
@ \fI2016\-03\-23 21:20:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
9b332d48b9 Merge pull request \fI\%#32104\fP from jacobhammons/dot10
.IP \(bu 2
b9fc882a1e One additional known issue for 2015.5.10 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32100\fP: (\fI\%jacobhammons\fP) 2015.5.10 release docs
@ \fI2016\-03\-23 20:05:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
ff51d548e1 Merge pull request \fI\%#32100\fP from jacobhammons/dot10
.IP \(bu 2
544a1661ce 2015.5.10 release docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#32037\fP: (\fI\%terminalmage\fP) Increase the visibility of state.apply in Salt\(aqs documentation (refs: \fI\%#32038\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32038\fP: (\fI\%terminalmage\fP) Improve state module docs, replace references to state.highstate/state.sls with state.apply
@ \fI2016\-03\-23 17:08:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
72a20f9799 Merge pull request \fI\%#32038\fP from terminalmage/issue32037
.IP \(bu 2
8b2d983324 Add reference to state tutorial to state.apply docstring
.IP \(bu 2
9b4fe8443e Move highstate usage details to top of state.apply docstring
.IP \(bu 2
74ee8c54bc Clarify prior role of state.highstate in states tutorial
.IP \(bu 2
1b97e4a3df Improve state module docs, replace references to state.highstate/state.sls with state.apply
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#32051\fP: (\fI\%terminalmage\fP) Fix outputter for state.apply
@ \fI2016\-03\-23 16:42:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
908a7bf5cd Merge pull request \fI\%#32051\fP from terminalmage/fix\-state\-apply\-output
.IP \(bu 2
7d7cb45565 Fix outputter for state.apply
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31788\fP: (\fI\%crocket\fP) pkg.installed doesn\(aqt work on Manjaro. (refs: \fI\%#32002\fP)
.IP \(bu 2
\fBPR\fP \fI\%#32002\fP: (\fI\%abednarik\fP) Added Manajro Linux to virtual.
@ \fI2016\-03\-21 17:55:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
0e66f678d4 Merge pull request \fI\%#32002\fP from abednarik/pkg_manjaron_issue31788
.IP \(bu 2
1b052d0a66 Added Manajro Linux to virtual. List extended with ManajaroLinux in order su load pacman module.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31957\fP: (\fI\%rallytime\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2016\-03\-18 15:12:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
ba5bf62c1a Merge pull request \fI\%#31957\fP from rallytime/merge\-2015.5
.IP \(bu 2
1b6ec5d445 Merge branch \(aq2014.7\(aq into \(aq2015.5\(aq
.INDENT 2.0
.IP \(bu 2
ba73deee46 Merge pull request \fI\%#31929\fP from twangboy/fix_build_script
.INDENT 2.0
.IP \(bu 2
2c5599d2bc Backport build script from 2015.8
.IP \(bu 2
ce74991dd0 Fix nsi script to work with new build process
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31972\fP: (\fI\%terminalmage\fP) Make lack of python\-ldap module more explicit when LDAP eauth is enabled
@ \fI2016\-03\-18 15:11:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
a52e3ad7a1 Merge pull request \fI\%#31972\fP from terminalmage/zh\-584
.IP \(bu 2
1e5639e495 Make lack of python\-ldap module more explicit when LDAP eauth is enabled
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31935\fP: (\fI\%twangboy\fP) Back port nullsoft build script from 2015.8
@ \fI2016\-03\-17 14:54:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d1f2a0c2e Merge pull request \fI\%#31935\fP from twangboy/fix_build_script2
.IP \(bu 2
4af8c9dbfc Back port nullsoft build script from 2015.8
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31912\fP: (\fI\%jfindlay\fP) log.mixins: remove extemporaneous .record
@ \fI2016\-03\-16 01:56:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
43240dc566 Merge pull request \fI\%#31912\fP from jfindlay/log_mixin
.IP \(bu 2
9f9c694654 log.mixins: remove extemporaneous .record
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31825\fP: (\fI\%justinta\fP) Updated .testing.pylintrc to match newer versions of pylint
@ \fI2016\-03\-15 18:12:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
440e0dcbe0 Merge pull request \fI\%#31825\fP from jtand/udpate_pylintrc
.IP \(bu 2
9a14e02766 Updated beacons/sh.py to work with enumerate()
.IP \(bu 2
0ecec691a0 Adjusted beacons to work with enumerate better
.IP \(bu 2
f509b4113e Fixed final lint error
.IP \(bu 2
5945b3f11f Fix and disable pylint errors
.IP \(bu 2
06ae6eaf55 Fixed pylint errors on jboss state and module
.IP \(bu 2
de96db97c8 Fixed more pylint errors, and disabled some more
.IP \(bu 2
c07b0a20b5 Merge branch \(aqlint_fixes\(aq into udpate_pylintrc
.INDENT 2.0
.IP \(bu 2
2e6a152308 Fixed lint error in lxc.py
.IP \(bu 2
908ca1a439 Fixed lint error in ssh_py_shim
.IP \(bu 2
404c1b50f7 Changed range(len()) to enumerate()
.IP \(bu 2
1e13586546 Changed range(len()) to enumerate()
.UNINDENT
.IP \(bu 2
9ccce7a9a5 Added more disables
.IP \(bu 2
9c1aab3b4e Updated .testing.pylintrc to match newer versions of pylint
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31867\fP: (\fI\%damon\-atkins\fP) \(dq __virtual__ returned False\(dq is not a clear error message (refs: \fI\%#31878\fP, \fI\%#31900\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31900\fP: (\fI\%rallytime\fP) Add \(dqpython module\(dq clarification to ps __virtual__ warning.
@ \fI2016\-03\-15 17:59:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
471c9444a3 Merge pull request \fI\%#31900\fP from rallytime/fix\-psutil\-warning
.IP \(bu 2
22403d69ae Add \(dqpython module\(dq clarification to ps __virtual__ warning.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31867\fP: (\fI\%damon\-atkins\fP) \(dq __virtual__ returned False\(dq is not a clear error message (refs: \fI\%#31878\fP, \fI\%#31900\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#19659\fP: (\fI\%wonderslug\fP) state process.absent is failing on Ubuntu 14.04 because psutil is not installed (refs: \fI\%#31878\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31878\fP: (\fI\%rallytime\fP) Make sure __virtual__ error message is helpful when psutil is missing
@ \fI2016\-03\-14 21:31:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
c44c1b5e59 Merge pull request \fI\%#31878\fP from rallytime/fix\-psutil\-warning
.IP \(bu 2
44b29f72a1 Make sure __virtual__ error message is helpful when psutil is missing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31852\fP: (\fI\%rallytime\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2016\-03\-13 02:47:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
5c592b6768 Merge pull request \fI\%#31852\fP from rallytime/merge\-2015.5
.IP \(bu 2
1470de17fa Merge branch \(aq2014.7\(aq into \(aq2015.5\(aq
.IP \(bu 2
218c902091 Merge pull request \fI\%#31834\fP from jfindlay/2014.7
.INDENT 2.0
.IP \(bu 2
358fdad0c8 add 2014.7.8 release notes
.UNINDENT
.IP \(bu 2
a423c6cd04 Merge pull request \fI\%#31833\fP from jfindlay/2014.7
.INDENT 2.0
.IP \(bu 2
6910fcc584 add 2014.7.9 release notes
.UNINDENT
.IP \(bu 2
c5e7c03953 Merge pull request \fI\%#31826\fP from gtmanfred/2014.7
.IP \(bu 2
d73f70ebb2 Remove ability of authenticating user to specify pam service
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31827\fP: (\fI\%gtmanfred\fP) Remove ability of authenticating user to specify pam service
@ \fI2016\-03\-11 20:40:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
0cc1d5db03 Merge pull request \fI\%#31827\fP from gtmanfred/2015.5
.IP \(bu 2
979173b78a Remove ability of authenticating user to specify pam service
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31810\fP: (\fI\%whiteinge\fP) Fix outdated Jinja \(aqenv\(aq variable reference
@ \fI2016\-03\-11 03:52:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
8cf0b9eb3d Merge pull request \fI\%#31810\fP from whiteinge/saltenv\-jinja\-var
.IP \(bu 2
cb72b19240 Fix outdated Jinja \(aqenv\(aq variable reference
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31729\fP: (\fI\%brejoc\fP) Creating VM with salt\-cloud fails for provider Exoscale (Cloudstack) (refs: \fI\%#31744\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31744\fP: (\fI\%brejoc\fP) Fix for AttributeError with libcloud <0.15
@ \fI2016\-03\-10 00:15:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
970ef0e445 Merge pull request \fI\%#31744\fP from brejoc/fix\-attribute\-error\-with\-older\-libcloud/2015.5
.IP \(bu 2
bb29dc2283 Added version to libcloud depends statement
.IP \(bu 2
87f9534fce Added log message with update suggestion for libcloud
.IP \(bu 2
72eab406cd Fix for AttributeError with libcloud <0.15
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31666\fP: (\fI\%sjorge\fP) salt\-call \-\-local pillar.items is overly eager to give data (refs: \fI\%#31740\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31740\fP: (\fI\%terminalmage\fP) Assume pillar_opts is False when not specified in masterless mode
@ \fI2016\-03\-09 22:57:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
df2d23ba5d Merge pull request \fI\%#31740\fP from terminalmage/issue31666
.IP \(bu 2
aeaf5864cd Fall back to False when pillar_opts not set
.IP \(bu 2
fe19d77eb4 Add default value for pillar_opts on minion
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31749\fP: (\fI\%milan\-milo\fP) salt\-cloud spitting out error \(aqAttributeError: \(aqNoneType\(aq object has no attribute \(aqpop\(aq\(aq (refs: \fI\%#31750\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26162\fP: (\fI\%nmadhok\fP) VMware cloud driver create function failing with traceback on latest develop (refs: \fI\%#26170\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31750\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26170\fP to 2015.5
@ \fI2016\-03\-09 17:44:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26170\fP: (\fI\%nmadhok\fP) [Backport] Make sure variable is a dictionary before popping something from it. (refs: \fI\%#31750\fP)
.IP \(bu 2
e22f5c0a26 Merge pull request \fI\%#31750\fP from rallytime/bp\-26170
.IP \(bu 2
3c11234a05 Make sure variable is a dictionary before popping something from it.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30559\fP: (\fI\%kaidokert\fP) module.wait does not fail when called state fails (refs: \fI\%#31689\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31689\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29467\fP to 2015.5
@ \fI2016\-03\-06 19:26:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29467\fP: (\fI\%serge\-p\fP) Update module.py (refs: \fI\%#31689\fP)
.IP \(bu 2
9162925dd0 Merge pull request \fI\%#31689\fP from rallytime/bp\-29467
.IP \(bu 2
1f8f4cb99b Update module.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31687\fP: (\fI\%cachedout\fP) Removed useless GPG tests
@ \fI2016\-03\-05 00:08:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
d7914cdb14 Merge pull request \fI\%#31687\fP from cachedout/rm_gpg_test
.IP \(bu 2
8b00513ebb Removed useless tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31619\fP: (\fI\%alexxannar\fP) 2015.8.7 pkg.installed problem with version parameter (refs: \fI\%#31660\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31660\fP: (\fI\%terminalmage\fP) Remove epoch from version string if present when installing with yum
@ \fI2016\-03\-04 20:49:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd4d12a155 Merge pull request \fI\%#31660\fP from terminalmage/issue31619
.IP \(bu 2
da954d7b92 Add integration test for packages with epoch in version
.IP \(bu 2
4fa7e4defe Move epoch removal
.IP \(bu 2
290192af56 Remove epoch from version string if present when installing with yum
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31683\fP: (\fI\%rallytime\fP) Back\-port \fI\%#31578\fP to 2015.5
@ \fI2016\-03\-04 20:47:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31578\fP: (\fI\%anlutro\fP) Allow queueing of state runs through saltmod (refs: \fI\%#31683\fP)
.IP \(bu 2
e33c1f456a Merge pull request \fI\%#31683\fP from rallytime/bp\-31578
.IP \(bu 2
8fe46789b7 allow queueing of state runs through saltmod
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31671\fP: (\fI\%guettli\fP) Word \(dqJob Cache\(dq does not match (refs: \fI\%#31682\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31682\fP: (\fI\%cachedout\fP) Add definition of job cache to glossary
@ \fI2016\-03\-04 20:07:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
27f443895d Merge pull request \fI\%#31682\fP from cachedout/cache_meaning
.IP \(bu 2
a75e146125 Add definition of job cache to glossary
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31658\fP: (\fI\%rallytime\fP) Add mentioned of Salt\(aqs Coding Style docs to the Contributing docs
@ \fI2016\-03\-03 22:14:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd04c964d1 Merge pull request \fI\%#31658\fP from rallytime/add\-style\-to\-contrib
.IP \(bu 2
6b526b5878 Add mentioned of Salt\(aqs Coding Style docs to the Contributing docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21932\fP: (\fI\%clinta\fP) Salt Coding Style docs should list requirements for salt pylintrc (refs: \fI\%#31655\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31655\fP: (\fI\%rallytime\fP) Make note of pylint dependencies in docs
@ \fI2016\-03\-03 18:37:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
10658dffe6 Merge pull request \fI\%#31655\fP from rallytime/pylint\-docs
.IP \(bu 2
6e0377d376 Make note of pylint dependencies in docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31440\fP: (\fI\%cachedout\fP) Set correct type for master_tops config value
@ \fI2016\-03\-02 21:17:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
6075774a01 Merge pull request \fI\%#31440\fP from cachedout/master_tops_type
.IP \(bu 2
f49cc75049 Set correct type for master_tops config value
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31614\fP: (\fI\%frizzby\fP) salt.utils.http.query() implementation contradicts its documentation. decode arg (refs: \fI\%#31622\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31622\fP: (\fI\%jfindlay\fP) doc/topics/tutorials/http: update query decoding docs
@ \fI2016\-03\-02 18:23:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
6d31b8918f Merge pull request \fI\%#31622\fP from jfindlay/query_doc
.IP \(bu 2
4e48fec806 doc/topics/tutorials/http: update query decoding docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31558\fP: (\fI\%cachedout\fP) Don\(aqt stacktrace if ssh binary is not installed with salt\-ssh
@ \fI2016\-02\-29 22:15:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
dbf6e0786c Merge pull request \fI\%#31558\fP from cachedout/ensure_ssh_installed
.IP \(bu 2
cecc6e0a5f Don\(aqt stacktrace if ssh binary is not installed with salt\-ssh
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31521\fP: (\fI\%terminalmage\fP) salt\-ssh: Fix race condition when caching files to build the thin tarball
@ \fI2016\-02\-29 15:32:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
060a60fd90 Merge pull request \fI\%#31521\fP from terminalmage/issue24753
.IP \(bu 2
0d352bbc16 Add fileclient tests
.IP \(bu 2
d9370a8041 Update cp module salt\-ssh wrapper to use new cachedir param
.IP \(bu 2
0320494b1d Update the SSH state module wrappers to pass an alternate cachedir
.IP \(bu 2
65bdcb3afa Accept and pass through the alternate cachedir when prepping the thin tar
.IP \(bu 2
c3f7a2f2e5 Add ability to specify an alternate base dir for file caching
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31497\fP: (\fI\%rallytime\fP) Remove duplicate \(dqtimeout\(dq definition in Roster docs
@ \fI2016\-02\-26 15:01:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
92f8f89218 Merge pull request \fI\%#31497\fP from rallytime/remove\-timeout\-dup
.IP \(bu 2
83e6480d20 Remove duplicate \(dqtimeout\(dq definition in Roster docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31472\fP: (\fI\%rallytime\fP) Update contributing docs
@ \fI2016\-02\-25 16:05:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
da001bcb49 Merge pull request \fI\%#31472\fP from rallytime/update\-contributing\-docs
.IP \(bu 2
5871e4d1e0 Update contributing docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30183\fP: (\fI\%jakehilton\fP) Minion startup extremely delayed when first master in failover multi master setup is down (refs: \fI\%#31382\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31461\fP: (\fI\%DmitryKuzmenko\fP) Set auth retry count to 0 if multimaster mode is failover.
@ \fI2016\-02\-24 17:15:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31382\fP: (\fI\%DmitryKuzmenko\fP) Set auth retry count to 0 if multimaster mode is failover (refs: \fI\%#31461\fP)
.IP \(bu 2
f35e2dd1d3 Merge pull request \fI\%#31461\fP from DSRCompany/issues/30183_fix_multimaster_failover_2015.5
.IP \(bu 2
3d09c3b7a3 Set auth retry count to 0 if multimaster mode is failover.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31356\fP: (\fI\%sastorsl\fP) file.copy module with recurse=true and non\-existing src dir does not fail and resets dst dir permissions (refs: \fI\%#31442\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31442\fP: (\fI\%sastorsl\fP) Add os.path.exists(src) to file.py, def copy
@ \fI2016\-02\-23 23:40:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
26733ce988 Merge pull request \fI\%#31442\fP from sastorsl/salt\-modules\-file.py\-copy\-check\-src
.IP \(bu 2
0a4132866d removed lint in the exception string
.IP \(bu 2
f8b5d498c3 Add os.path.exists(src) to file.py, def copy
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30739\fP: (\fI\%paclat\fP) manage.present does not work when minion is using localhost (refs: \fI\%#31441\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31441\fP: (\fI\%cachedout\fP) Include localhost minions in presence detection for runner
@ \fI2016\-02\-23 23:36:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
e480727d27 Merge pull request \fI\%#31441\fP from cachedout/issue_30739
.IP \(bu 2
ffcfad1570 Include localhost minions in presence detection for runner
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31416\fP: (\fI\%carlwgeorge\fP) selinux module documentation fix
@ \fI2016\-02\-22 21:49:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
91ff95f093 Merge pull request \fI\%#31416\fP from carlwgeorge/selinux_doc_fix
.IP \(bu 2
0e6846d72e selinux module documentation fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31336\fP: (\fI\%terminalmage\fP) Improve config validation logging
@ \fI2016\-02\-22 19:34:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
7d01979898 Merge pull request \fI\%#31336\fP from terminalmage/config\-validation\-logging
.IP \(bu 2
795008bad1 Improve config validation logging
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31369\fP: (\fI\%sjorge\fP) illumos/solaris/smartos display compacted hwaddrs (refs: \fI\%#31374\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31374\fP: (\fI\%sjorge\fP) fix for \fI\%#31369\fP
@ \fI2016\-02\-22 16:22:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
fed096a29d Merge pull request \fI\%#31374\fP from sjorge/solarish_hwaddr
.IP \(bu 2
bdf2576dfb missed a .format and messed up the join
.IP \(bu 2
bbd2fdc96d fix for illumos/solaris hwaddr
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31339\fP: (\fI\%jacobhammons\fP) changed latest release to 2015.8.7
@ \fI2016\-02\-19 00:30:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
6ee17f905b Merge pull request \fI\%#31339\fP from jacobhammons/dot7prev
.IP \(bu 2
07120a8d48 changed latest release to 2015.8.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31288\fP: (\fI\%notpeter\fP) Improve salt.states.ssh_known_hosts documentation.
@ \fI2016\-02\-17 22:09:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
cd3400e67e Merge pull request \fI\%#31288\fP from notpeter/ssh_known_hosts_docs
.IP \(bu 2
3f573d89a2 Improve salt.states.ssh_known_hosts documentation.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31183\fP: (\fI\%heyfife\fP) Fixed named external_ip reservation/re\-use code in gce driver.
@ \fI2016\-02\-17 19:02:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
875d9925fa Merge pull request \fI\%#31183\fP from heyfife/fix\-gce\-named\-static\-ip\-reservation
.IP \(bu 2
26774e2323 Fixed named external_ip reservation/re\-use code.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31001\fP: (\fI\%toanju\fP) Fedora 23 check installed packages fails (refs: \fI\%#31032\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31032\fP: (\fI\%terminalmage\fP) (2015.5 branch) yumpkg: ensure that dnf\-plugins\-core >= 0.1.15 is installed
@ \fI2016\-02\-17 19:02:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
e56c402c0c Merge pull request \fI\%#31032\fP from terminalmage/issue31001
.IP \(bu 2
42daea4509 yumpkg.py: Remove repoquery usage everywhere but check_db
.IP \(bu 2
50befbc149 backport salt.utils.pkg.rpm to 2015.5
.IP \(bu 2
a1ad14994a Move salt.utils.itersplit() to salt.utils.itertools.split()
.IP \(bu 2
5b8646ce64 Ignore failure to install new enough dnf\-plugins\-core
.IP \(bu 2
defe0859fd Ensure that dnf\-plugins\-core 0.1.15 is installed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#31174\fP: (\fI\%sjorge\fP) salt.states.archive.extacted displays incorrect message: (refs: \fI\%#31176\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31264\fP: (\fI\%sjorge\fP) fix if_missing gets appended to dirs list, take III
@ \fI2016\-02\-17 17:12:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#31250\fP: (\fI\%sjorge\fP) if_missing append to array as far back as 2014.1 (refs: \fI\%#31264\fP)
.IP \(bu 2
\fBPR\fP \fI\%#31176\fP: (\fI\%sjorge\fP) if_missing incorrected appended to directories_created (refs: \fI\%#31250\fP, \fI\%#31264\fP)
.IP \(bu 2
cec69b74f0 Merge pull request \fI\%#31264\fP from sjorge/if_missing\-155\-fix
.IP \(bu 2
545edbf5e1 fix if_missing gets appended to dirs list, take III
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31110\fP: (\fI\%cachedout\fP) Fixup 30730
@ \fI2016\-02\-10 21:37:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
fa3f474de9 Merge pull request \fI\%#31110\fP from cachedout/fixup_30730
.IP \(bu 2
5bf5848e04 Fixup unit test
.IP \(bu 2
f558f68e0a Fixes pylint warnings
.IP \(bu 2
56a975ec43 Attempt to fix pylint warnings
.IP \(bu 2
55d71be057 Make documentation and code examples consistent with code
.IP \(bu 2
1f04fed6f8 Change parameter name from includes to skips
.IP \(bu 2
ccf5e13e7d Adding support for skipHidden in SetInclude
.IP \(bu 2
4f2d4af2e7 Variable names standardization
.IP \(bu 2
f5917ac1e8 Fixes typo
.IP \(bu 2
26e5236073 Invert RebootRequired logic
.IP \(bu 2
8065a7abf6 Add basic documentation and define how the skips parameter works.
.IP \(bu 2
389fea7508 Change parameter name from includes to skips
.IP \(bu 2
30e1fef906 Adding support for skipHidden in SetInclude
.IP \(bu 2
1244eea5be Variable names standardization, consistent if/else logic with states.win_update
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30900\fP: (\fI\%mchugh19\fP) modules/qemu_nbd.py assumes versions of utilities that don\(aqt exist on ubuntu (refs: \fI\%#30949\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30974\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30949\fP to 2015.5
@ \fI2016\-02\-08 16:38:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30949\fP: (\fI\%techhat\fP) Replace cfdisk with sfdisk (refs: \fI\%#30974\fP)
.IP \(bu 2
1c699a1664 Merge pull request \fI\%#30974\fP from rallytime/bp\-30949
.IP \(bu 2
ff6542f593 Replace cfdisk with sfdisk
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28951\fP: (\fI\%ClaudiuPID\fP) CloudLinux 7 changes (refs: \fI\%#30897\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30942\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30897\fP to 2015.5
@ \fI2016\-02\-05 19:00:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30897\fP: (\fI\%mtorromeo\fP) Only remove the word linux from distroname when its not part of the name (refs: \fI\%#30942\fP)
.IP \(bu 2
c7f87cc371 Merge pull request \fI\%#30942\fP from rallytime/bp\-30897
.IP \(bu 2
885e00ba54 Only remove the word linux from distroname when its not part of the name
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30922\fP: (\fI\%jacobhammons\fP) Rev latest version to 2015.8.5
@ \fI2016\-02\-05 01:20:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
35b7f62669 Merge pull request \fI\%#30922\fP from jacobhammons/prev\-rel\-notes
.IP \(bu 2
57c1ec637a Rev latest version to 2015.8.5
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30840\fP: (\fI\%HeathNaylor\fP) Generic Error for SALT.STATES.BOTO_ELB (refs: \fI\%#30865\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30865\fP: (\fI\%abednarik\fP) Better boto elb error message.
@ \fI2016\-02\-04 21:02:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
2488bb902e Merge pull request \fI\%#30865\fP from abednarik/better_boto_elb_error
.IP \(bu 2
3561e8c19b Better boto elb error message.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30831\fP: (\fI\%jacobhammons\fP) Updated readme
@ \fI2016\-02\-02 21:06:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
4da04f82c8 Merge pull request \fI\%#30831\fP from jacobhammons/readme\-update
.IP \(bu 2
01a92f5d98 Updated readme
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30829\fP: (\fI\%jacobhammons\fP) Updated latest version to 2015.8.4
@ \fI2016\-02\-02 20:06:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
90c1ea9f6c Merge pull request \fI\%#30829\fP from jacobhammons/release\-2015.5
.IP \(bu 2
c95bb60148 Version to 2015.8.4
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24575\fP: (\fI\%BrandKNY\fP) raid.present inside mdadm.py triggers IndexError: list index out of range (refs: \fI\%#30784\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23694\fP: (\fI\%gmolight\fP) mdadm.py module (refs: \fI\%#30784\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30784\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24952\fP to 2015.5
@ \fI2016\-02\-01 21:43:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24952\fP: (\fI\%pcn\fP) Don\(aqt split the string on a single line (refs: \fI\%#30784\fP)
.IP \(bu 2
80a36793cb Merge pull request \fI\%#30784\fP from rallytime/bp\-24952
.IP \(bu 2
a07908bdea Don\(aqt split the string on a single line
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30560\fP: (\fI\%terminalmage\fP) yumpkg.py: pkg.unhold fails in yum (refs: \fI\%#30764\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30764\fP: (\fI\%terminalmage\fP) Work around yum versionlock\(aqs inability to remove holds by package name alone
@ \fI2016\-02\-01 18:14:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
e978f5392f Merge pull request \fI\%#30764\fP from terminalmage/issue30560
.IP \(bu 2
39736afcd7 Work around yum versionlock\(aqs inability to remove holds by package name alone
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30760\fP: (\fI\%toanju\fP) Changed output format of arp_ip_target from list to comma delimited...
@ \fI2016\-01\-31 19:05:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27952\fP: (\fI\%tomwalsh\fP) Corrected format of arp_ip_target in network config files and modprobe files (refs: \fI\%#30760\fP)
.IP \(bu 2
6f565c0d76 Merge pull request \fI\%#30760\fP from toanju/2015.5
.IP \(bu 2
dc4256f7df Changed output format of arp_ip_target from list to comma delimited string
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30722\fP: (\fI\%yannis666\fP) mine config is not merged from minion config and pillar (refs: \fI\%#30757\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30757\fP: (\fI\%yannis666\fP) Fix to mine update to merge configuration
@ \fI2016\-01\-31 19:02:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
1c205b4898 Merge pull request \fI\%#30757\fP from yannis666/fix\-for\-mine\-update\-merge
.IP \(bu 2
61bb23e256 Fix to mine update to merge configuration
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28751\fP: (\fI\%olfway\fP) network.system state ignores test=True on debian/ubuntu (refs: \fI\%#30749\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30749\fP: (\fI\%abednarik\fP) Fix Netwotk hostname Module in Debian systems.
@ \fI2016\-01\-29 23:01:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
f9fde8f6a7 Merge pull request \fI\%#30749\fP from abednarik/fix_network_system_test
.IP \(bu 2
1e9e97df59 Fix Netwotk hostname Module in Debian systems.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28438\fP: (\fI\%vakulich\fP) Master failed to save job cache file: \(dqCould not write job invocation cache file: [Errno 2] No such file or directory\(dq (refs: \fI\%#30699\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30699\fP: (\fI\%abednarik\fP) Add Retry to save_load.
@ \fI2016\-01\-29 16:08:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
076268089a Merge pull request \fI\%#30699\fP from abednarik/save_load_retry_time
.IP \(bu 2
186872cf49 Add Retry to save_load.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30565\fP: (\fI\%heaje\fP) scsi.ls fails to run both on CentOS 6 and CentOS 7 (refs: \fI\%#30659\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30659\fP: (\fI\%sjmh\fP) Fix lsscsi issues for certain platforms
@ \fI2016\-01\-28 15:53:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
8d79d1b9c7 Merge pull request \fI\%#30659\fP from sjmh/fix\-scsi
.IP \(bu 2
3544dd995e Fix lsscsi issues for certain platforms
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18980\fP: (\fI\%lrhazi\fP) salt\-cloud: ExtraData: unpack(b) received extra data. (refs: \fI\%#30671\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30671\fP: (\fI\%techhat\fP) Add file locking to cloud index
@ \fI2016\-01\-27 17:14:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
516919525a Merge pull request \fI\%#30671\fP from techhat/lockcloud
.IP \(bu 2
4719f8d4ea Whitespace
.IP \(bu 2
8e7eca23e4 Add file locking to cloud index
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28320\fP: (\fI\%Grokzen\fP) file.comment & file.uncomment changes file permissions on edit (refs: \fI\%#30586\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30586\fP: (\fI\%abednarik\fP) Fix comment_line permissions.
@ \fI2016\-01\-25 23:24:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
643c9c9616 Merge pull request \fI\%#30586\fP from abednarik/fix_comment_line_perms
.IP \(bu 2
8b395a42cb Fix comment_line permissions.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30582\fP: (\fI\%terminalmage\fP) yumpkg.check_db: run separate repoquery commands when multiple names passed
@ \fI2016\-01\-24 17:15:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
a823e21428 Merge pull request \fI\%#30582\fP from terminalmage/dnf\-repoquery\-multiple\-targets
.IP \(bu 2
410da789f9 yumpkg.check_db: run separate repoquery commands when multiple names passed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30548\fP: (\fI\%jacobhammons\fP) Added placeholder release notes for 2015.5.10
@ \fI2016\-01\-22 18:36:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
8e56be7f4c Merge pull request \fI\%#30548\fP from jacobhammons/doc\-fixes
.IP \(bu 2
03c51bb54d Added placeholder release notes for 2015.5.10 Changed old doc links from docs.saltstack.org to docs.saltproject.io
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30530\fP: (\fI\%terminalmage\fP) 2015.5 tweaks from \fI\%#30529\fP
@ \fI2016\-01\-22 16:26:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30529\fP: (\fI\%terminalmage\fP) Merge 2015.5 into 2015.8 (refs: \fI\%#30530\fP)
.IP \(bu 2
1aafd4c5b5 Merge pull request \fI\%#30530\fP from terminalmage/yumpkg\-dnf\-cleanup
.IP \(bu 2
2586f71bcf 2015.5 tweaks from \fI\%#30529\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23553\fP: (\fI\%aboe76\fP) dnf a new package provider for fedora 22 (refs: \fI\%#30484\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30484\fP: (\fI\%terminalmage\fP) Backport DNF support to 2015.5 branch
@ \fI2016\-01\-21 22:14:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
7798d42272 Merge pull request \fI\%#30484\fP from terminalmage/dnf\-yumpkg\-2015.5
.IP \(bu 2
330e26d1da Hide get_locked_packages
.IP \(bu 2
5a637420e8 Backport DNF support to 2015.5 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30512\fP: (\fI\%jfindlay\fP) disable pkgrepo test for ubuntu 15.10+
@ \fI2016\-01\-21 21:32:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
b348f804b1 Merge pull request \fI\%#30512\fP from jfindlay/repo_test
.IP \(bu 2
66f06f2bd3 disable pkgrepo test for ubuntu 15.10+
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30478\fP: (\fI\%justinta\fP) Updated pip_state to work with pip 8.0
@ \fI2016\-01\-21 16:02:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
a9348dfef8 Merge pull request \fI\%#30478\fP from jtand/pip_8_update
.IP \(bu 2
6227368830 Convert version to int, instead of comparing strings to ints
.IP \(bu 2
20384a4810 Added InstallationError to except block
.IP \(bu 2
baa274bca9 Updated pip_state to work with pip 8.0
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30465\fP: (\fI\%alandrees\fP) Nested imports with pyobjects (refs: \fI\%#30482\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30482\fP: (\fI\%borgstrom\fP) Pyobjects recursive import support (for 2015.5)
@ \fI2016\-01\-21 15:54:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
a30147c64f Merge pull request \fI\%#30482\fP from borgstrom/pyobjects_recursive
.IP \(bu 2
2c55a7580b Fixup lint errors
.IP \(bu 2
b46df0e4b5 Allow recursive salt:// imports
.IP \(bu 2
51bfa16173 Add test to prove that recursive imports are currently broken
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30459\fP: (\fI\%jfindlay\fP) modules.pkg: disable repo int test for ubuntu 15.10
@ \fI2016\-01\-20 16:41:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
5c7cc51937 Merge pull request \fI\%#30459\fP from jfindlay/pkg_tests
.IP \(bu 2
fb9972f590 modules.pkg: disable repo int test for ubuntu 15.10
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30443\fP: (\fI\%justinta\fP) Boto uses False for is_default instead of None
@ \fI2016\-01\-19 18:28:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd2ceb4c07 Merge pull request \fI\%#30443\fP from jtand/boto_vpc_5
.IP \(bu 2
2f77152479 Boto uses False for is_default instead of None
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26833\fP: (\fI\%twangboy\fP) salt\-cloud fails to spin up windows minion on 2015.8 Head (refs: \fI\%#26853\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#21256\fP: (\fI\%dhs\-rec\fP) win.exe package for RH 6 (refs: \fI\%#26853\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30420\fP: (\fI\%attiasr\fP) Backport \fI\%#26853\fP
@ \fI2016\-01\-19 17:33:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26853\fP: (\fI\%UtahDave\fP) Fix salt\-cloud on windows (refs: \fI\%#30420\fP)
.IP \(bu 2
62d9dddced Merge pull request \fI\%#30420\fP from attiasr/patch\-1
.IP \(bu 2
4de343c5a1 Backport \fI\%#26853\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#30341\fP: (\fI\%dnd\fP) salt\-cloud linode connection reset by peer (refs: \fI\%#30364\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30364\fP: (\fI\%rallytime\fP) Add TLS version imports and add linode driver documentation notices
@ \fI2016\-01\-14 19:04:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
5a923b3aa9 Merge pull request \fI\%#30364\fP from rallytime/fix\-30341
.IP \(bu 2
79bcf151cb Add TLS version imports and add linode driver documentation notices
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28822\fP: (\fI\%HerrBerg\fP) saltenv url\-parameter not working in file.managed for salt:// sources since 2015.8 (refs: \fI\%#30166\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30184\fP: (\fI\%rallytime\fP) Back\-port \fI\%#30166\fP to 2015.5
@ \fI2016\-01\-13 18:27:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30166\fP: (\fI\%robgott\fP) adding split_env call to cp.hash_file to pick up saltenv in file quer… (refs: \fI\%#30184\fP)
.IP \(bu 2
f037fd9c27 Merge pull request \fI\%#30184\fP from rallytime/bp\-30166
.IP \(bu 2
fa6b1b3022 adding split_env call to cp.hash_file to pick up saltenv in file query parameter
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30291\fP: (\fI\%thegoodduke\fP) ipset: fix test=true & add comment for every entry
@ \fI2016\-01\-12 19:40:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#30170\fP: (\fI\%thegoodduke\fP) ipset: fix comment and test (refs: \fI\%#30291\fP)
.IP \(bu 2
1d8413fd2f Merge pull request \fI\%#30291\fP from thegoodduke/for_fix_ipset
.IP \(bu 2
62d6ccf561 ipset: fix test=true & add comment for every entry
.UNINDENT
.UNINDENT
.SS Salt 2015.5.2 Release Notes
.INDENT 0.0
.TP
.B release
2015\-06\-10
.UNINDENT
.sp
Version 2015.5.2 is a bugfix release for \fI\%2015.5.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB112\fP
.IP \(bu 2
Total Issue References: \fB36\fP
.IP \(bu 2
Total PR References: \fB145\fP
.IP \(bu 2
Contributors: \fB49\fP (\fI\%Sacro\fP, \fI\%The\-Loeki\fP, \fI\%YanChii\fP, \fI\%aboe76\fP, \fI\%anlutro\fP, \fI\%awdrius\fP,
\fI\%basepi\fP, \fI\%cdarwin\fP, \fI\%cedwards\fP, \fI\%clan\fP, \fI\%corywright\fP, \fI\%cro\fP, \fI\%djcrabhat\fP, \fI\%dmyerscough\fP,
\fI\%dr4Ke\fP, \fI\%fayetted\fP, \fI\%galet\fP, \fI\%garethgreenaway\fP, \fI\%ghost\fP, \fI\%hazelesque\fP, \fI\%hvnsweeting\fP,
\fI\%jacksontj\fP, \fI\%jacobhammons\fP, \fI\%jayeshka\fP, \fI\%jbq\fP, \fI\%jfindlay\fP, \fI\%joejulian\fP, \fI\%justinta\fP,
\fI\%kartiksubbarao\fP, \fI\%kiorky\fP, \fI\%merll\fP, \fI\%msteed\fP, \fI\%neogenix\fP, \fI\%nicholascapo\fP, \fI\%nleib\fP,
\fI\%pengyao\fP, \fI\%pruiz\fP, \fI\%rallytime\fP, \fI\%randybias\fP, \fI\%ryan\-lane\fP, \fI\%steverweber\fP, \fI\%swdream\fP,
\fI\%techhat\fP, \fI\%terminalmage\fP, \fI\%thcipriani\fP, \fI\%thusoy\fP, \fI\%trevor\-h\fP, \fI\%twangboy\fP, \fI\%whiteinge\fP)
.UNINDENT
.SS Changelog for v2015.5.1..v2015.5.2
.sp
\fIGenerated at: 2018\-05\-27 21:13:02 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#24372\fP: (\fI\%rallytime\fP) Add 2015.5.2 release notes
@ \fI2015\-06\-03 19:30:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
d71d75e2ec Merge pull request \fI\%#24372\fP from rallytime/release_notes
.IP \(bu 2
f5ec1a1693 Add 2015.5.2 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24346\fP: (\fI\%rallytime\fP) Backport \fI\%#24271\fP to 2015.5
@ \fI2015\-06\-03 18:44:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24271\fP: (\fI\%randybias\fP) Fixed the setup instructions (refs: \fI\%#24346\fP)
.IP \(bu 2
76927c9ea1 Merge pull request \fI\%#24346\fP from rallytime/bp\-24271
.IP \(bu 2
04067b6833 Fixed the setup instructions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24012\fP: (\fI\%jbq\fP) Enabling a service does not create the appropriate rc.d symlinks on Ubuntu (refs: \fI\%#24013\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24345\fP: (\fI\%rallytime\fP) Backport \fI\%#24013\fP to 2015.5
@ \fI2015\-06\-03 18:39:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24013\fP: (\fI\%jbq\fP) Fix enabling a service on Ubuntu \fI\%#24012\fP (refs: \fI\%#24345\fP)
.IP \(bu 2
4afa03d8e3 Merge pull request \fI\%#24345\fP from rallytime/bp\-24013
.IP \(bu 2
16e0732b50 Fix enabling a service on Ubuntu \fI\%#24012\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24365\fP: (\fI\%jacobhammons\fP) Fixes for PDF build errors
@ \fI2015\-06\-03 17:50:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3392c246a Merge pull request \fI\%#24365\fP from jacobhammons/DocFixes
.IP \(bu 2
0fc190267f Fixes for PDF build errors
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22991\fP: (\fI\%nicholascapo\fP) npm.installed ignores test=True (refs: \fI\%#24313\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24313\fP: (\fI\%nicholascapo\fP) Fix \fI\%#22991\fP Correctly set result when test=True
@ \fI2015\-06\-03 14:49:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
ae681a4db1 Merge pull request \fI\%#24313\fP from nicholascapo/fix\-22991\-npm.installed\-test\-true
.IP \(bu 2
ac9644cb19 Fix \fI\%#22991\fP npm.installed correctly set result on test=True
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18966\fP: (\fI\%bechtoldt\fP) file.serialize ignores test=True (refs: \fI\%#24312\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24312\fP: (\fI\%nicholascapo\fP) Fix \fI\%#18966\fP: file.serialize supports test=True
@ \fI2015\-06\-03 14:49:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
d57a9a267c Merge pull request \fI\%#24312\fP from nicholascapo/fix\-18966\-file.serialize\-test\-true
.IP \(bu 2
e7328e7043 Fix \fI\%#18966\fP file.serialize correctly set result on test=True
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24302\fP: (\fI\%jfindlay\fP) fix pkg hold/unhold integration test
@ \fI2015\-06\-03 03:27:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b694e3495 Merge pull request \fI\%#24302\fP from jfindlay/pkg_tests
.IP \(bu 2
c2db0b1758 fix pkg hold/unhold integration test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#14021\fP: (\fI\%emostar\fP) EC2 doc mentions mount_point, but unable to use properly (refs: \fI\%#24349\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24349\fP: (\fI\%rallytime\fP) Remove references to mount_points in ec2 docs
@ \fI2015\-06\-03 01:54:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
aca8447ced Merge pull request \fI\%#24349\fP from rallytime/fix\-14021
.IP \(bu 2
a235b114d7 Remove references to mount_points in ec2 docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24328\fP: (\fI\%dr4Ke\fP) Fix state grains silently fails 2015.5
@ \fI2015\-06\-02 15:18:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
88a997e6ee Merge pull request \fI\%#24328\fP from dr4Ke/fix_state_grains_silently_fails_2015.5
.IP \(bu 2
8a63d1ebbe fix state grains silently fails \fI\%#24319\fP
.IP \(bu 2
ca1af20203 grains state: add some tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#9772\fP: (\fI\%s0undt3ch\fP) Delete VM\(aqs in a map does not delete them all (refs: \fI\%#24310\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24036\fP: (\fI\%arthurlogilab\fP) [salt\-cloud] Protect against passing command line arguments as names for the \-\-destroy command in map files (refs: \fI\%#24310\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24310\fP: (\fI\%techhat\fP) Add warning about destroying maps
@ \fI2015\-06\-02 03:01:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
7dcd9bb5de Merge pull request \fI\%#24310\fP from techhat/mapwarning
.IP \(bu 2
ca535a6ff4 Add warning about destroying maps
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24281\fP: (\fI\%steverweber\fP) Ipmi docfix
@ \fI2015\-06\-01 17:45:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
02bfb254d6 Merge pull request \fI\%#24281\fP from steverweber/ipmi_docfix
.IP \(bu 2
dd36f2c555 yaml formatting
.IP \(bu 2
f6deef3047 include api_kg kwarg in ipmi state
.IP \(bu 2
a7d4e97bb9 doc cleanup
.IP \(bu 2
0ded2fdbef save more cleanup to doc
.IP \(bu 2
08872f2da3 fix name api_key to api_kg
.IP \(bu 2
165a387681 doc fix add api_kg kwargs
.IP \(bu 2
1ec78887e4 cleanup docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24287\fP: (\fI\%jfindlay\fP) fix pkg test on ubuntu 12.04 for realz
@ \fI2015\-06\-01 14:16:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
73cd2cbe1f Merge pull request \fI\%#24287\fP from jfindlay/pkg_test
.IP \(bu 2
98944d8c7f fix pkg test on ubuntu 12.04 for realz
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24279\fP: (\fI\%rallytime\fP) Backport \fI\%#24263\fP to 2015.5
@ \fI2015\-06\-01 04:29:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24263\fP: (\fI\%cdarwin\fP) Correct usage of import_yaml in formula documentation (refs: \fI\%#24279\fP)
.IP \(bu 2
02017a074c Merge pull request \fI\%#24279\fP from rallytime/bp\-24263
.IP \(bu 2
beff7c7785 Correct usage of import_yaml in formula documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24226\fP: (\fI\%c4urself\fP) iptables state needs to keep ordering of flags (refs: \fI\%#24277\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24277\fP: (\fI\%rallytime\fP) Put a space between after_jump commands
@ \fI2015\-06\-01 04:28:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
2ba696d54a Merge pull request \fI\%#24277\fP from rallytime/fix_iptables_jump
.IP \(bu 2
e2d1606b19 Move after_jump split out of loop
.IP \(bu 2
d14f1307b6 Remove extra loop
.IP \(bu 2
42ed5320b6 Put a space between after_jump commands
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24262\fP: (\fI\%basepi\fP) More dictupdate after \fI\%#24142\fP
@ \fI2015\-05\-31 04:09:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24142\fP: (\fI\%basepi\fP) Optimize dictupdate.update and add \fI\%#24097\fP functionality (refs: \fI\%#24262\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24097\fP: (\fI\%kiorky\fP) Optimize dictupdate (refs: \fI\%#24142\fP)
.IP \(bu 2
113eba34ec Merge pull request \fI\%#24262\fP from basepi/dictupdatefix
.IP \(bu 2
0c4832c0d4 Raise a typeerror if non\-dict types
.IP \(bu 2
be21aaa122 Pylint
.IP \(bu 2
bb8a6c6cc9 More optimization
.IP \(bu 2
c933249d1a py3 compat
.IP \(bu 2
ff6b2a781f Further optimize dictupdate.update()
.IP \(bu 2
c73f5ba37c Remove unused valtype
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24269\fP: (\fI\%kiorky\fP) zfs: Fix spurious retcode hijacking in virtual
@ \fI2015\-05\-30 17:47:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
785d5a1bfc Merge pull request \fI\%#24269\fP from makinacorpus/zfs
.IP \(bu 2
0bf23ce701 zfs: Fix spurious retcode hijacking in virtual
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24257\fP: (\fI\%jfindlay\fP) fix pkg mod integration test on ubuntu 12.04
@ \fI2015\-05\-29 23:09:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
3d885c04f0 Merge pull request \fI\%#24257\fP from jfindlay/pkg_tests
.IP \(bu 2
9508924c02 fix pkg mod integration test on ubuntu 12.04
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23883\fP: (\fI\%kaithar\fP) max_event_size seems broken (refs: \fI\%#24001\fP, \fI\%#24065\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23657\fP: (\fI\%arthurlogilab\fP) [salt\-cloud lxc] NameError: global name \(aq__salt__\(aq is not defined (refs: \fI\%#23982\fP, \fI\%#24080\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24260\fP: (\fI\%basepi\fP) Fix some typos from \fI\%#24080\fP
@ \fI2015\-05\-29 22:54:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24080\fP: (\fI\%kiorky\fP) Lxc consistency2 (refs: \fI\%#24066\fP, \fI\%#24260\fP, \fI\%#23982\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24066\fP: (\fI\%kiorky\fP) Merge forward 2015.5 \-> develop (refs: \fI\%#23982\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24065\fP: (\fI\%kiorky\fP) continue to fix \fI\%#23883\fP (refs: \fI\%#24066\fP, \fI\%#24080\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23982\fP: (\fI\%kiorky\fP) lxc: path support (refs: \fI\%#24080\fP)
.IP \(bu 2
08a10755b3 Merge pull request \fI\%#24260\fP from basepi/lxctypos24080
.IP \(bu 2
0fa1ad3977 Fix another lxc typo
.IP \(bu 2
669938f28d s/you ll/you\(aqll/
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23883\fP: (\fI\%kaithar\fP) max_event_size seems broken (refs: \fI\%#24001\fP, \fI\%#24065\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23657\fP: (\fI\%arthurlogilab\fP) [salt\-cloud lxc] NameError: global name \(aq__salt__\(aq is not defined (refs: \fI\%#23982\fP, \fI\%#24080\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24080\fP: (\fI\%kiorky\fP) Lxc consistency2 (refs: \fI\%#24066\fP, \fI\%#24260\fP, \fI\%#23982\fP)
@ \fI2015\-05\-29 22:51:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24066\fP: (\fI\%kiorky\fP) Merge forward 2015.5 \-> develop (refs: \fI\%#23982\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24065\fP: (\fI\%kiorky\fP) continue to fix \fI\%#23883\fP (refs: \fI\%#24066\fP, \fI\%#24080\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23982\fP: (\fI\%kiorky\fP) lxc: path support (refs: \fI\%#24080\fP)
.IP \(bu 2
75590cf490 Merge pull request \fI\%#24080\fP from makinacorpus/lxc_consistency2
.IP \(bu 2
81f80674a2 lxc: fix old lxc test
.IP \(bu 2
458f50617b seed: lint
.IP \(bu 2
96b8d55f14 Fix seed.mkconfig yamldump
.IP \(bu 2
76ddb683f4 lxc/applynet: conservative
.IP \(bu 2
ce7096fdb7 variable collision
.IP \(bu 2
8a8b28d652 lxc: lint
.IP \(bu 2
458b18b7e6 more lxc docs
.IP \(bu 2
ef1f95231a lxc docs: typos
.IP \(bu 2
d67a43dc1f more lxc docs
.IP \(bu 2
608da5ef5d modules/lxc: merge resolution
.IP \(bu 2
27c4689a24 modules/lxc: more consistent comparison
.IP \(bu 2
07c365a23b lxc: merge conflict spotted
.IP \(bu 2
999391551c modules/lxc: rework settings for consistency
.IP \(bu 2
ce11d8352e lxc: Global doc refresh
.IP \(bu 2
61ed2f5e76 clouds/lxc: profile key is conflicting
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24210\fP: (\fI\%damonnk\fP) salt\-cloud vsphere.py should allow key_filename param (refs: \fI\%#24220\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24247\fP: (\fI\%rallytime\fP) Backport \fI\%#24220\fP to 2015.5
@ \fI2015\-05\-29 21:40:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24220\fP: (\fI\%djcrabhat\fP) adding key_filename param to vsphere provider (refs: \fI\%#24247\fP)
.IP \(bu 2
da14f3b976 Merge pull request \fI\%#24247\fP from rallytime/bp\-24220
.IP \(bu 2
0b1041dd72 adding key_filename param to vsphere provider
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24254\fP: (\fI\%rallytime\fP) Add deprecation warning to Digital Ocean v1 Driver
@ \fI2015\-05\-29 21:39:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#22731\fP: (\fI\%dmyerscough\fP) Decommission DigitalOcean APIv1 and have users use the new DigitalOcean APIv2 (refs: \fI\%#24254\fP)
.IP \(bu 2
21d6126c34 Merge pull request \fI\%#24254\fP from rallytime/add_deprecation_warning_digitalocean
.IP \(bu 2
cafe37bdf8 Add note to docs about deprecation
.IP \(bu 2
ea0f1e0921 Add deprecation warning to digital ocean driver to move to digital_ocean_v2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24252\fP: (\fI\%aboe76\fP) Updated suse spec to 2015.5.1
@ \fI2015\-05\-29 21:38:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
dac055dd8b Merge pull request \fI\%#24252\fP from aboe76/opensuse_package
.IP \(bu 2
0ad617df21 Updated suse spec to 2015.5.1
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24251\fP: (\fI\%garethgreenaway\fP) Returners broken in 2015.5
@ \fI2015\-05\-29 21:37:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
49e7fe8a5e Merge pull request \fI\%#24251\fP from garethgreenaway/2015_5_returner_brokenness
.IP \(bu 2
5df6b52568 The code calling cfg as a function vs treating it as a dictionary and using get is currently backwards causing returners to fail when used from the CLI and in scheduled jobs.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21498\fP: (\fI\%rallytime\fP) Clarify Digital Ocean Documentation (refs: \fI\%#24255\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24255\fP: (\fI\%rallytime\fP) Clarify digital ocean documentation and mention v1 driver deprecation
@ \fI2015\-05\-29 21:37:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
bfb946123e Merge pull request \fI\%#24255\fP from rallytime/clarify_digital_ocean_driver_docs
.IP \(bu 2
8d51f75aa5 Clarify digital ocean documentation and mention v1 driver deprecation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24232\fP: (\fI\%rallytime\fP) Backport \fI\%#23308\fP to 2015.5
@ \fI2015\-05\-29 21:36:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23308\fP: (\fI\%thusoy\fP) Don\(aqt merge: Add missing jump arguments to iptables module (refs: \fI\%#24232\fP)
.IP \(bu 2
41f5756f36 Merge pull request \fI\%#24232\fP from rallytime/bp\-23308
.IP \(bu 2
2733f66449 Import string
.IP \(bu 2
9097cca099 Add missing jump arguments to iptables module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24245\fP: (\fI\%Sacro\fP) Unset PYTHONHOME when starting the service
@ \fI2015\-05\-29 20:00:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
a95982c722 Merge pull request \fI\%#24245\fP from Sacro/patch\-2
.IP \(bu 2
6632d06e94 Unset PYTHONHOME when starting the service
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24121\fP: (\fI\%hvnsweeting\fP) deprecate setting user permission in rabbitmq_vhost.present
@ \fI2015\-05\-29 15:55:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
1504c76d3a Merge pull request \fI\%#24121\fP from hvnsweeting/rabbitmq\-host\-deprecate\-set\-permission
.IP \(bu 2
2223158e76 deprecate setting user permission in rabbitmq_host.present
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24179\fP: (\fI\%merll\fP) Changing user and group only possible for existing ids.
@ \fI2015\-05\-29 15:52:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24169\fP: (\fI\%merll\fP) Changing user and group only possible for existing ids. (refs: \fI\%#24179\fP)
.IP \(bu 2
ba02f6509e Merge pull request \fI\%#24179\fP from Precis/fix\-file\-uid\-gid\-2015.0
.IP \(bu 2
ee4c9d59ab Use ids if user or group is not present.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24147\fP: (\fI\%paclat\fP) Syndication issues when using authentication on master of masters.  (refs: \fI\%#24229\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24229\fP: (\fI\%msteed\fP) Fix auth failure on syndic with external_auth
@ \fI2015\-05\-29 15:04:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
9bfb066c2c Merge pull request \fI\%#24229\fP from msteed/issue\-24147
.IP \(bu 2
482d1cfc64 Fix auth failure on syndic with external_auth
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24234\fP: (\fI\%jayeshka\fP) adding states/quota unit test case.
@ \fI2015\-05\-29 14:14:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
19fa43c290 Merge pull request \fI\%#24234\fP from jayeshka/quota\-states\-unit\-test
.IP \(bu 2
c23356500b adding states/quota unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24217\fP: (\fI\%jfindlay\fP) disable intermittently failing tests
@ \fI2015\-05\-29 03:08:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23623\fP: (\fI\%jfindlay\fP) Fix /jobs endpoint\(aqs return (refs: \fI\%#24217\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22857\fP: (\fI\%jacksontj\fP) Fix /jobs endpoint\(aqs return (refs: \fI\%#23623\fP)
.IP \(bu 2
e15142c629 Merge pull request \fI\%#24217\fP from jfindlay/disable_bad_tests
.IP \(bu 2
6b6280442c disable intermittently failing tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24199\fP: (\fI\%ryan\-lane\fP) Various fixes for boto_route53 and boto_elb
@ \fI2015\-05\-29 03:02:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce8e43b774 Merge pull request \fI\%#24199\fP from lyft/route53\-fix\-elb
.IP \(bu 2
d8dc9a7b5b Better unit tests for boto_elb state
.IP \(bu 2
62f214b535 Remove cnames_present test
.IP \(bu 2
7b9ae82951 Lint fix
.IP \(bu 2
b74b0d1413 Various fixes for boto_route53 and boto_elb
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24142\fP: (\fI\%basepi\fP) Optimize dictupdate.update and add \fI\%#24097\fP functionality (refs: \fI\%#24262\fP)
@ \fI2015\-05\-29 03:00:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24097\fP: (\fI\%kiorky\fP) Optimize dictupdate (refs: \fI\%#24142\fP)
.IP \(bu 2
a43465d235 Merge pull request \fI\%#24142\fP from basepi/dictupdate24097
.IP \(bu 2
5c6e210c8b Deepcopy on merge_recurse
.IP \(bu 2
a13c84ade8 Fix None check from \fI\%#21968\fP
.IP \(bu 2
9ef2c64098 Add docstring
.IP \(bu 2
8579429314 Add in recursive_update from \fI\%#24097\fP
.IP \(bu 2
8599143200 if key not in dest, don\(aqt recurse
.IP \(bu 2
d8a84b3017 Rename klass to valtype
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24208\fP: (\fI\%jayeshka\fP) adding states/ports unit test case.
@ \fI2015\-05\-28 23:06:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
526698ba8d Merge pull request \fI\%#24208\fP from jayeshka/ports\-states\-unit\-test
.IP \(bu 2
657b709932 adding states/ports unit test case.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#20635\fP: (\fI\%dennisjac\fP) 2015.2.0rc1: zfs errors in log after update (refs: \fI\%#24219\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24219\fP: (\fI\%jfindlay\fP) find zfs without modinfo
@ \fI2015\-05\-28 21:07:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
d00945fd40 Merge pull request \fI\%#24219\fP from jfindlay/zfs_check
.IP \(bu 2
15d401907c use the salt loader in the zfs mod
.IP \(bu 2
5599b67a46 try to search for zfs if modinfo is unavailable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24190\fP: (\fI\%msteed\fP) Fix issue 23815
@ \fI2015\-05\-28 20:10:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
3dc4b85295 Merge pull request \fI\%#24190\fP from msteed/issue\-23815
.IP \(bu 2
086a1a94e8 lint
.IP \(bu 2
65de62f852 fix \fI\%#23815\fP
.IP \(bu 2
d04e9162de spelling
.IP \(bu 2
db9f6820b8 add inotify beacon unit tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24211\fP: (\fI\%rallytime\fP) Backport \fI\%#24205\fP to 2015.5
@ \fI2015\-05\-28 18:28:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24205\fP: (\fI\%hazelesque\fP) Docstring fix in salt.modules.yumpkg.hold (refs: \fI\%#24211\fP)
.IP \(bu 2
436634b508 Merge pull request \fI\%#24211\fP from rallytime/bp\-24205
.IP \(bu 2
23284b5d47 Docstring fix in salt.modules.yumpkg.hold
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24212\fP: (\fI\%terminalmage\fP) Clarify error in rendering template for top file
@ \fI2015\-05\-28 18:26:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
cc58624c7e Merge pull request \fI\%#24212\fP from terminalmage/clarify\-error\-msg
.IP \(bu 2
ca807fb032 Clarify error in rendering template for top file
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23904\fP: (\fI\%mbrgm\fP) Network config bonding section cannot be parsed when attribute names use dashes (refs: \fI\%#23917\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23900\fP: (\fI\%hashi825\fP) salt ubuntu network building issue 2015.5.0 (refs: \fI\%#23922\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24213\fP: (\fI\%The\-Loeki\fP) ShouldFix _\- troubles in debian_ip
@ \fI2015\-05\-28 18:24:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23922\fP: (\fI\%garethgreenaway\fP) Fixes to debian_ip.py (refs: \fI\%#24213\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23917\fP: (\fI\%corywright\fP) Split debian bonding options on dash instead of underscore (refs: \fI\%#24213\fP)
.IP \(bu 2
9825160b1a Merge pull request \fI\%#24213\fP from The\-Loeki/patch\-3
.IP \(bu 2
a68d515973 ShouldFix _\- troubles in debian_ip
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24214\fP: (\fI\%basepi\fP) 2015.5.1release
@ \fI2015\-05\-28 16:23:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
071751d13f Merge pull request \fI\%#24214\fP from basepi/2015.5.1release
.IP \(bu 2
e5ba31b5b5 2015.5.1 release date
.IP \(bu 2
768494c819 Update latest release in docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24202\fP: (\fI\%rallytime\fP) Backport \fI\%#24186\fP to 2015.5
@ \fI2015\-05\-28 05:16:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24186\fP: (\fI\%thcipriani\fP) Update salt vagrant provisioner info (refs: \fI\%#24202\fP)
.IP \(bu 2
c2f1fdb244 Merge pull request \fI\%#24202\fP from rallytime/bp\-24186
.IP \(bu 2
db793dd0de Update salt vagrant provisioner info
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24192\fP: (\fI\%rallytime\fP) Backport \fI\%#20474\fP to 2015.5
@ \fI2015\-05\-28 05:16:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#20474\fP: (\fI\%djcrabhat\fP) add sudo, sudo_password params to vsphere deploy to allow for non\-root deploys (refs: \fI\%#24192\fP)
.IP \(bu 2
8a085a2592 Merge pull request \fI\%#24192\fP from rallytime/bp\-20474
.IP \(bu 2
fd3c783f3e add sudo, sudo_password params to deploy to allow for non\-root deploys
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24184\fP: (\fI\%rallytime\fP) Backport \fI\%#24129\fP to 2015.5
@ \fI2015\-05\-28 05:15:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24129\fP: (\fI\%pengyao\fP) Wheel client doc (refs: \fI\%#24184\fP)
.IP \(bu 2
7cc535bf4a Merge pull request \fI\%#24184\fP from rallytime/bp\-24129
.IP \(bu 2
722a662479 fixed a typo
.IP \(bu 2
565eb46ff5 Add cmd doc for WheelClient
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24183\fP: (\fI\%rallytime\fP) Backport \fI\%#19320\fP to 2015.5
@ \fI2015\-05\-28 05:14:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#19320\fP: (\fI\%clan\fP) add \(aqstate_output_profile\(aq option for profile output (refs: \fI\%#24183\fP)
.IP \(bu 2
eb0af70e5b Merge pull request \fI\%#24183\fP from rallytime/bp\-19320
.IP \(bu 2
55db1bf8b5 sate_output_profile default to True
.IP \(bu 2
991922703b fix type: statei \-> state
.IP \(bu 2
0549ca6266 add \(aqstate_output_profile\(aq option for profile output
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24201\fP: (\fI\%whiteinge\fP) Add list of client libraries for the rest_cherrypy module to the top\-level documentation
@ \fI2015\-05\-28 02:12:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
1b5bf23187 Merge pull request \fI\%#24201\fP from whiteinge/rest_cherrypy\-client\-libs
.IP \(bu 2
5f718027ca Add list of client libraries for the rest_cherrypy module
.IP \(bu 2
28fc77f6f6 Fix rest_cherrypy config example indentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24195\fP: (\fI\%rallytime\fP) Merge \fI\%#24185\fP with a couple of fixes
@ \fI2015\-05\-27 22:18:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24185\fP: (\fI\%jacobhammons\fP) Fixes for doc build errors (refs: \fI\%#24195\fP)
.IP \(bu 2
3307ec20d9 Merge pull request \fI\%#24195\fP from rallytime/merge\-24185
.IP \(bu 2
d8daa9dcd7 Merge \fI\%#24185\fP with a couple of fixes
.IP \(bu 2
634d56bca0 Fixed pylon error
.IP \(bu 2
0689815d0e Fixes for doc build errors
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24166\fP: (\fI\%jayeshka\fP) adding states/pkgng unit test case.
@ \fI2015\-05\-27 20:27:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
7e400bc3d7 Merge pull request \fI\%#24166\fP from jayeshka/pkgng\-states\-unit\-test
.IP \(bu 2
2234bb0b70 adding states/pkgng unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24189\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-05\-27 20:26:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
9fcda79cd4 Merge pull request \fI\%#24189\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
8839e9c22e Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
9d7331c87d Merge pull request \fI\%#24178\fP from rallytime/bp\-24118
.INDENT 2.0
.IP \(bu 2
e2217a09e8 removed deprecated pymongo usage as no longer functional with pymongo > 3.x
.UNINDENT
.IP \(bu 2
4e8c5031b0 Merge pull request \fI\%#24159\fP from rallytime/keystone_doc_examples
.INDENT 2.0
.IP \(bu 2
dadac8d076 Fill out modules/keystone.py CLI Examples
.UNINDENT
.IP \(bu 2
fc10ee8ed5 Merge pull request \fI\%#24158\fP from rallytime/fix_doc_error
.INDENT 2.0
.IP \(bu 2
49a517e2ca Fix test_valid_docs test for tls module
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24181\fP: (\fI\%justinta\fP) Fixed error where file was evaluated as a symlink in test_absent
@ \fI2015\-05\-27 18:26:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
2303dec0e9 Merge pull request \fI\%#24181\fP from jtand/file_test
.IP \(bu 2
5f0e601589 Fixed error where file was evaluated as a symlink in test_absent
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24180\fP: (\fI\%terminalmage\fP) Skip libvirt tests if not running as root
@ \fI2015\-05\-27 18:18:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
a16276852b Merge pull request \fI\%#24180\fP from terminalmage/fix\-libvirt\-test
.IP \(bu 2
72e7416ad2 Skip libvirt tests if not running as root
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24165\fP: (\fI\%jayeshka\fP) adding states/portage_config unit test case.
@ \fI2015\-05\-27 17:15:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
1fbc5b25e6 Merge pull request \fI\%#24165\fP from jayeshka/portage_config\-states\-unit\-test
.IP \(bu 2
8cf1505392 adding states/portage_config unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24164\fP: (\fI\%jayeshka\fP) adding states/pecl unit test case.
@ \fI2015\-05\-27 17:14:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
4747856411 Merge pull request \fI\%#24164\fP from jayeshka/pecl\-states\-unit\-test
.IP \(bu 2
563a5b3c30 adding states/pecl unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24160\fP: (\fI\%The\-Loeki\fP) small enhancement to data module; pop()
@ \fI2015\-05\-27 17:03:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
cdaaa19324 Merge pull request \fI\%#24160\fP from The\-Loeki/patch\-1
.IP \(bu 2
2175ff3c75 doc & merge fix
.IP \(bu 2
eba382cdda small enhancement to data module; pop()
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24153\fP: (\fI\%techhat\fP) Batch mode sometimes improperly builds lists of minions to process
@ \fI2015\-05\-27 16:21:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
4a8dbc7f13 Merge pull request \fI\%#24153\fP from techhat/batchlist
.IP \(bu 2
467ba64612 Make sure that minion IDs are strings
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24167\fP: (\fI\%jayeshka\fP) adding states/pagerduty unit test case.
@ \fI2015\-05\-27 16:14:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
ed8ccf57a2 Merge pull request \fI\%#24167\fP from jayeshka/pagerduty\-states\-unit\-test
.IP \(bu 2
1af8c8334d adding states/pagerduty unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24156\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-05\-27 15:05:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
b9507d1567 Merge pull request \fI\%#24156\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
e52b5ab2e2 Remove stray >>>>>
.IP \(bu 2
7dfbd929ff Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
c0d32e0b5e Merge pull request \fI\%#24125\fP from hvnsweeting/fix\-rabbitmq\-test\-mode
.INDENT 2.0
.IP \(bu 2
71862c69b9 enhance log
.IP \(bu 2
28e2594162 change according to new output of rabbitmq module functions
.IP \(bu 2
cd0212e8ed processes and returns better output for rabbitmq module
.UNINDENT
.IP \(bu 2
39a8f30f06 Merge pull request \fI\%#24093\fP from msteed/issue\-23464
.INDENT 2.0
.IP \(bu 2
fd35903d75 Fix failing test
.IP \(bu 2
41b344c7d3 Make LocalClient.cmd_iter_no_block() not block
.UNINDENT
.IP \(bu 2
5bffd3045e Merge pull request \fI\%#24008\fP from davidjb/2014.7
.INDENT 2.0
.IP \(bu 2
8b8d0293d4 Correct reST formatting for documentation
.UNINDENT
.IP \(bu 2
1aa0420040 Merge pull request \fI\%#23933\fP from jacobhammons/2014.7
.IP \(bu 2
a3613e68e4 removed numbering from doc TOC
.IP \(bu 2
78b737c5e6 removed 2015.* release from release notes, updated index page to remove PDF/epub links
.IP \(bu 2
e867f7df77 Changed build settings to use saltstack2 theme and update release versions.
.IP \(bu 2
81ed9c9f59 sphinx saltstack2 doc theme
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24102\fP: (\fI\%bormotov\fP) win_update encondig problems (refs: \fI\%#24145\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24145\fP: (\fI\%jfindlay\fP) attempt to decode win update package
@ \fI2015\-05\-26 23:20:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
05745fa931 Merge pull request \fI\%#24145\fP from jfindlay/win_update_encoding
.IP \(bu 2
cc5e17e61f attempt to decode win update package
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24122\fP: (\fI\%kiorky\fP) service.dead is no more stateful: services does not handle correctly enable/disable change state (refs: \fI\%#24123\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24123\fP: (\fI\%kiorky\fP) fix service enable/disable change
@ \fI2015\-05\-26 21:24:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
70247890de Merge pull request \fI\%#24123\fP from makinacorpus/ss
.IP \(bu 2
2e2e1d262d fix service enable/disable change
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24146\fP: (\fI\%rallytime\fP) Fixes the boto_vpc_test failure on CentOS 5 tests
@ \fI2015\-05\-26 20:15:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
51c3cec5d7 Merge pull request \fI\%#24146\fP from rallytime/fix_centos_boto_failure
.IP \(bu 2
ac0f97de51 Fixes the boto_vpc_test failure on CentOS 5 tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24052\fP: (\fI\%twangboy\fP) v2015.5.1 Changes the way it interprets the minion_master.pub file (refs: \fI\%#24144\fP, \fI\%#24089\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23566\fP: (\fI\%rks2286\fP) Salt\-cp corrupting the file after transfer to minion (refs: \fI\%#24144\fP, \fI\%#23740\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24144\fP: (\fI\%twangboy\fP) Compare Keys ignores all newlines and carriage returns
@ \fI2015\-05\-26 19:25:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23740\fP: (\fI\%jfindlay\fP) Binary write (refs: \fI\%#24144\fP)
.IP \(bu 2
1c91a2176f Merge pull request \fI\%#24144\fP from twangboy/fix_24052
.IP \(bu 2
c197b41494 Compare Keys removing all newlines and carriage returns
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24139\fP: (\fI\%rallytime\fP) Backport \fI\%#24118\fP to 2015.5
@ \fI2015\-05\-26 18:24:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24118\fP: (\fI\%trevor\-h\fP) removed deprecated pymongo usage (refs: \fI\%#24178\fP, \fI\%#24139\fP)
.IP \(bu 2
084166747c Merge pull request \fI\%#24139\fP from rallytime/bp\-24118
.IP \(bu 2
4bb519b8da removed deprecated pymongo usage as no longer functional with pymongo > 3.x
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24138\fP: (\fI\%rallytime\fP) Backport \fI\%#24116\fP to 2015.5
@ \fI2015\-05\-26 18:23:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24116\fP: (\fI\%awdrius\fP) Fixed typo in chown username (ending dot) that fails the command. (refs: \fI\%#24138\fP)
.IP \(bu 2
742eca29f7 Merge pull request \fI\%#24138\fP from rallytime/bp\-24116
.IP \(bu 2
7f08641800 Fixed typo in chown username (ending dot) that fails the command.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24137\fP: (\fI\%rallytime\fP) Backport \fI\%#24105\fP to 2015.5
@ \fI2015\-05\-26 18:23:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24105\fP: (\fI\%cedwards\fP) Updated some beacon\-specific documentation formatting (refs: \fI\%#24137\fP)
.IP \(bu 2
e01536d098 Merge pull request \fI\%#24137\fP from rallytime/bp\-24105
.IP \(bu 2
f0778a0a60 Updated some beacon\-specific documentation formatting
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23364\fP: (\fI\%pruiz\fP) Unable to destroy host using proxmox cloud: There was an error destroying machines: 501 Server Error: Method \(aqDELETE /nodes/pmx1/openvz/openvz/100\(aq not implemented (refs: \fI\%#24104\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24136\fP: (\fI\%rallytime\fP) Backport \fI\%#24104\fP to 2015.5
@ \fI2015\-05\-26 15:58:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24104\fP: (\fI\%pruiz\fP) Only try to stop a VM if it\(aqs not already stopped. (fixes \fI\%#23364\fP) (refs: \fI\%#24136\fP)
.IP \(bu 2
89cdf976e1 Merge pull request \fI\%#24136\fP from rallytime/bp\-24104
.IP \(bu 2
c53888415f Only try to stop a VM if it\(aqs not already stopped. (fixes \fI\%#23364\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24135\fP: (\fI\%rallytime\fP) Backport \fI\%#24083\fP to 2015.5
@ \fI2015\-05\-26 15:58:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24083\fP: (\fI\%swdream\fP) fix code block syntax (refs: \fI\%#24135\fP)
.IP \(bu 2
67c4373577 Merge pull request \fI\%#24135\fP from rallytime/bp\-24083
.IP \(bu 2
e1d06f9764 fix code block syntax
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24131\fP: (\fI\%jayeshka\fP) adding states/mysql_user unit test case
@ \fI2015\-05\-26 15:58:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
a83371e0ed Merge pull request \fI\%#24131\fP from jayeshka/mysql_user\-states\-unit\-test
.IP \(bu 2
ed1ef69856 adding states/mysql_user unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24130\fP: (\fI\%jayeshka\fP) adding states/ntp unit test case
@ \fI2015\-05\-26 15:57:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
1dc1d2a6e5 Merge pull request \fI\%#24130\fP from jayeshka/ntp\-states\-unit\-test
.IP \(bu 2
ede4a9f2f1 adding states/ntp unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24128\fP: (\fI\%jayeshka\fP) adding states/openstack_config unit test case
@ \fI2015\-05\-26 15:56:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
39434179a8 Merge pull request \fI\%#24128\fP from jayeshka/openstack_config\-states\-unit\-test
.IP \(bu 2
ca09e0f7c1 adding states/openstack_config unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24127\fP: (\fI\%jayeshka\fP) adding states/npm unit test case
@ \fI2015\-05\-26 15:55:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
23f25c4298 Merge pull request \fI\%#24127\fP from jayeshka/npm\-states\-unit\-test
.IP \(bu 2
c3ecabbae0 adding states/npm unit test case
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24009\fP: (\fI\%hvnsweeting\fP) state_verbose False summary is wrong (refs: \fI\%#24077\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24077\fP: (\fI\%anlutro\fP) Change how state_verbose output is filtered
@ \fI2015\-05\-26 15:41:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
07488a4415 Merge pull request \fI\%#24077\fP from alprs/fix\-outputter_highstate_nonverbose_count
.IP \(bu 2
7790408c3c Change how state_verbose output is filtered
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24119\fP: (\fI\%jfindlay\fP) Update contrib docs
@ \fI2015\-05\-26 15:37:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
224820febf Merge pull request \fI\%#24119\fP from jfindlay/update_contrib_docs
.IP \(bu 2
fa2d411f53 update example release branch in contrib docs
.IP \(bu 2
a0b76b57b3 clarify git rebase instructions
.IP \(bu 2
3517e0095f fix contribution docs link typos
.IP \(bu 2
651629c6a4 backport dev contrib doc updates to 2015.5
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23928\fP: (\fI\%joejulian\fP) Add the ability to replace existing certificates
@ \fI2015\-05\-25 19:47:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
5488c4aaa2 Merge pull request \fI\%#23928\fP from joejulian/2015.5_tls_module_replace_existing
.IP \(bu 2
4a4cbdd266 Add the ability to replace existing certificates
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23221\fP: (\fI\%Reiner030\fP) Debian Jessie: locale.present not working again (refs: \fI\%#24078\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24078\fP: (\fI\%jfindlay\fP) if a charmap is not supplied, set it to the codeset
@ \fI2015\-05\-25 19:39:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd90ef09b9 Merge pull request \fI\%#24078\fP from jfindlay/locale_charmap
.IP \(bu 2
5eb97f0973 if a charmap is not supplied, set it to the codeset
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24088\fP: (\fI\%jfindlay\fP) pkg module integration tests
@ \fI2015\-05\-25 19:39:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
9cec5d3dc9 Merge pull request \fI\%#24088\fP from jfindlay/pkg_tests
.IP \(bu 2
f1bd5ec404 adding pkg module integration tests
.IP \(bu 2
739b2ef3bd rework yumpkg refresh_db so args are not mandatory
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24052\fP: (\fI\%twangboy\fP) v2015.5.1 Changes the way it interprets the minion_master.pub file (refs: \fI\%#24144\fP, \fI\%#24089\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24089\fP: (\fI\%jfindlay\fP) allow override of binary file mode on windows
@ \fI2015\-05\-25 19:38:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
517552caa6 Merge pull request \fI\%#24089\fP from jfindlay/binary_write
.IP \(bu 2
b2259a6370 allow override of binary file mode on windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23973\fP: (\fI\%mschiff\fP) state file.managed: setting contents_pillar to a pillar which is a list throws exception instead giving descriptive error message (refs: \fI\%#24092\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24092\fP: (\fI\%jfindlay\fP) collect scattered contents edits, ensure it\(aqs a str
@ \fI2015\-05\-25 19:38:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
121ab9f857 Merge pull request \fI\%#24092\fP from jfindlay/file_state
.IP \(bu 2
cfa0f1358e collect scattered contents edits, ensure it\(aqs a str
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24112\fP: (\fI\%The\-Loeki\fP) thin_gen breaks when thinver doesn\(aqt exist
@ \fI2015\-05\-25 19:37:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
84e65dece7 Merge pull request \fI\%#24112\fP from The\-Loeki/patch\-1
.IP \(bu 2
34646eae16 thin_gen breaks when thinver doesn\(aqt exist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24108\fP: (\fI\%jayeshka\fP) adding states/mysql_query unit test case
@ \fI2015\-05\-25 12:30:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec509ed272 Merge pull request \fI\%#24108\fP from jayeshka/mysql_query\-states\-unit\-test
.IP \(bu 2
ec50450460 adding states/mysql_query unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24110\fP: (\fI\%jayeshka\fP) adding varnish unit test case
@ \fI2015\-05\-25 12:30:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
f2e5d6c2fd Merge pull request \fI\%#24110\fP from jayeshka/varnish\-unit\-test
.IP \(bu 2
e11988969f adding varnish unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24109\fP: (\fI\%jayeshka\fP) adding states/mysql_grants unit test case
@ \fI2015\-05\-25 12:29:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
4fca2b49e3 Merge pull request \fI\%#24109\fP from jayeshka/mysql_grants\-states\-unit\-test
.IP \(bu 2
11a93cb80c adding states/mysql_grants unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24028\fP: (\fI\%nleib\fP) send a disable message to disable puppet
@ \fI2015\-05\-25 04:02:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b43c9a8cb Merge pull request \fI\%#24028\fP from nleib/2015.5
.IP \(bu 2
15f24b42b2 update format of string in disabled msg
.IP \(bu 2
7690e5b008 remove trailing whitespaces
.IP \(bu 2
56a972034f Update puppet.py
.IP \(bu 2
9686391d81 Update puppet.py
.IP \(bu 2
33f3d68489 send a disable message to disable puppet
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24100\fP: (\fI\%jfindlay\fP) adding states/file unit test case
@ \fI2015\-05\-24 05:17:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23963\fP: (\fI\%jayeshka\fP) adding states/file unit test case (refs: \fI\%#24100\fP)
.IP \(bu 2
52c9acafc2 Merge pull request \fI\%#24100\fP from jfindlay/merge_23963
.IP \(bu 2
7d59deb3d6 adding states/file unit test case
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21446\fP: (\fI\%dpheasant\fP) check for systemd on Oracle Linux (refs: \fI\%#24098\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24098\fP: (\fI\%galet\fP) Systemd not recognized properly on Oracle Linux 7
@ \fI2015\-05\-24 04:07:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
0eb9f15d20 Merge pull request \fI\%#24098\fP from galet/2015.5
.IP \(bu 2
4d6ab21c74 Systemd not recognized properly on Oracle Linux 7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24090\fP: (\fI\%jfindlay\fP) adding states/mount unit test case
@ \fI2015\-05\-22 23:02:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24062\fP: (\fI\%jayeshka\fP) adding states/mount unit test case (refs: \fI\%#24090\fP)
.IP \(bu 2
8e04db76de Merge pull request \fI\%#24090\fP from jfindlay/merge_24062
.IP \(bu 2
a81a9225b8 adding states/mount unit test case
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22574\fP: (\fI\%unicolet\fP) error when which is not available (refs: \fI\%#22806\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24086\fP: (\fI\%rallytime\fP) Backport \fI\%#22806\fP to 2015.5
@ \fI2015\-05\-22 21:18:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#22806\fP: (\fI\%jfindlay\fP) use cmd.run_all instead of cmd.run_stdout (refs: \fI\%#24086\fP)
.IP \(bu 2
c0079f5dc7 Merge pull request \fI\%#24086\fP from rallytime/bp\-22806
.IP \(bu 2
f728f55160 use cmd.run_all instead of cmd.run_stdout
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24024\fP: (\fI\%jayeshka\fP) adding states/mongodb_user unit test case
@ \fI2015\-05\-22 20:53:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
09de253373 Merge pull request \fI\%#24024\fP from jayeshka/mongodb_user\-states\-unit\-test
.IP \(bu 2
f31dc921f5 resolved errors
.IP \(bu 2
d038b1fdbb adding states/mongodb_user unit test case
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23883\fP: (\fI\%kaithar\fP) max_event_size seems broken (refs: \fI\%#24001\fP, \fI\%#24065\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24065\fP: (\fI\%kiorky\fP) continue to fix \fI\%#23883\fP (refs: \fI\%#24066\fP, \fI\%#24080\fP)
@ \fI2015\-05\-22 18:59:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
bfd812c56b Merge pull request \fI\%#24065\fP from makinacorpus/real23883
.IP \(bu 2
028282e01d continue to fix \fI\%#23883\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24017\fP: (\fI\%arthurlogilab\fP) [salt\-cloud openstack] TypeError: unhashable type: \(aqdict\(aq on map creation (refs: \fI\%#24029\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24029\fP: (\fI\%kiorky\fP) Fix providers handling
@ \fI2015\-05\-22 16:56:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
429adfe00a Merge pull request \fI\%#24029\fP from makinacorpus/fixproviders
.IP \(bu 2
412b39b802 Fix providers handling
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23936\fP: (\fI\%jfindlay\fP) remove unreachable returns in file state
@ \fI2015\-05\-22 16:26:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
a42ccccd98 Merge pull request \fI\%#23936\fP from jfindlay/file_state
.IP \(bu 2
ac29c0cdd0 also validate file.recurse source parameter
.IP \(bu 2
57f73887fe remove unreachable returns in file state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24063\fP: (\fI\%jayeshka\fP) removed tuple index error
@ \fI2015\-05\-22 14:58:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
8b69b41a42 Merge pull request \fI\%#24063\fP from jayeshka/mount\-states\-module
.IP \(bu 2
b9745d5c4f removed tuple index error
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24057\fP: (\fI\%rallytime\fP) Backport \fI\%#22572\fP to 2015.5
@ \fI2015\-05\-22 05:36:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#22572\fP: (\fI\%The\-Loeki\fP) Small docfix for GitPillar (refs: \fI\%#24057\fP)
.IP \(bu 2
02ac4aa288 Merge pull request \fI\%#24057\fP from rallytime/bp\-22572
.IP \(bu 2
49aad84b17 Small docfix for GitPillar
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23088\fP: (\fI\%ghost\fP) Segfault when adding a Zypper repo on SLES 11.3 (refs: \fI\%#24027\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24040\fP: (\fI\%rallytime\fP) Backport \fI\%#24027\fP to 2015.5
@ \fI2015\-05\-21 23:43:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24027\fP: (\fI\%ghost\fP) Add baseurl to salt.modules.zypper.mod_repo (refs: \fI\%#24040\fP)
.IP \(bu 2
82de059891 Merge pull request \fI\%#24040\fP from rallytime/bp\-24027
.IP \(bu 2
37d25d8bc6 Added baseurl as alias for url and mirrorlist in salt.modules.zypper.mod_repo.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24039\fP: (\fI\%rallytime\fP) Backport \fI\%#24015\fP to 2015.5
@ \fI2015\-05\-21 23:43:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24015\fP: (\fI\%YanChii\fP) minor improvement of solarisips docs & fix typos (refs: \fI\%#24039\fP)
.IP \(bu 2
d909781d97 Merge pull request \fI\%#24039\fP from rallytime/bp\-24015
.IP \(bu 2
6bfaa94a8c minor improovement of solarisips docs & fix typos
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19598\fP: (\fI\%fayetted\fP) ssh_auth.present test=true incorectly reports changes will be made (refs: \fI\%#19599\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24038\fP: (\fI\%rallytime\fP) Backport \fI\%#19599\fP to 2015.5
@ \fI2015\-05\-21 23:43:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#19599\fP: (\fI\%fayetted\fP) Fix ssh_auth test mode, compare lines not just key (refs: \fI\%#24038\fP)
.IP \(bu 2
4a0f254d22 Merge pull request \fI\%#24038\fP from rallytime/bp\-19599
.IP \(bu 2
ea00d3e786 Fix ssh_auth test mode, compare lines not just key
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24046\fP: (\fI\%rallytime\fP) Remove key management test from digital ocean cloud tests
@ \fI2015\-05\-21 22:32:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
42b87f1049 Merge pull request \fI\%#24046\fP from rallytime/remove_key_test
.IP \(bu 2
1d031caa78 Remove key management test from digital ocean cloud tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24044\fP: (\fI\%cro\fP) Remove spurious log message, fix typo in doc
@ \fI2015\-05\-21 22:31:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
eff54b1c5a Merge pull request \fI\%#24044\fP from cro/pgjsonb
.IP \(bu 2
de0663314a Remove spurious log message, fix typo in doc
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23883\fP: (\fI\%kaithar\fP) max_event_size seems broken (refs: \fI\%#24001\fP, \fI\%#24065\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24001\fP: (\fI\%msteed\fP) issue \fI\%#23883\fP
@ \fI2015\-05\-21 20:32:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
ac32000b5d Merge pull request \fI\%#24001\fP from msteed/issue\-23883
.IP \(bu 2
bea97a8b98 issue \fI\%#23883\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23995\fP: (\fI\%kiorky\fP) Lxc path pre
@ \fI2015\-05\-21 17:26:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
f7fae26059 Merge pull request \fI\%#23995\fP from makinacorpus/lxc_path_pre
.IP \(bu 2
319282af5f lint
.IP \(bu 2
1dc67e5678 lxc: versionadded
.IP \(bu 2
fcad7cb804 lxc: states improvements
.IP \(bu 2
644bd729f7 lxc: more consistence for profiles
.IP \(bu 2
139372c055 lxc: remove merge cruft
.IP \(bu 2
725b0462ca lxc: Repair merge
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#16383\fP: (\fI\%interjection\fP) salt.states.augeas.change example from docs fails with exception (refs: \fI\%#24032\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24032\fP: (\fI\%kartiksubbarao\fP) Update augeas_cfg.py
@ \fI2015\-05\-21 17:03:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
26d6851666 Merge pull request \fI\%#24032\fP from kartiksubbarao/augeas_insert_16383
.IP \(bu 2
3686dcd4c7 Update augeas_cfg.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24025\fP: (\fI\%jayeshka\fP) adding timezone unit test case
@ \fI2015\-05\-21 16:50:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
55c9245075 Merge pull request \fI\%#24025\fP from jayeshka/timezone\-unit\-test
.IP \(bu 2
1ec33e22a7 removed assertion error
.IP \(bu 2
16ecb28950 adding timezone unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24023\fP: (\fI\%jayeshka\fP) adding states/mongodb_database unit test case
@ \fI2015\-05\-21 16:49:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
e243617659 Merge pull request \fI\%#24023\fP from jayeshka/mongodb_database\-states\-unit\-test
.IP \(bu 2
5a9ac7effb adding states/mongodb_database unit test case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24022\fP: (\fI\%jayeshka\fP) adding states/modjk_worker unit test case
@ \fI2015\-05\-21 16:48:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
b377bd93e6 Merge pull request \fI\%#24022\fP from jayeshka/modjk_worker\-states\-unit\-test
.IP \(bu 2
05c0a985db adding states/modjk_worker unit test case
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23776\fP: (\fI\%enblde\fP) Presence change events constantly reporting all minions as new in 2015.5 (refs: \fI\%#24005\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24005\fP: (\fI\%msteed\fP) issue \fI\%#23776\fP
@ \fI2015\-05\-21 01:55:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
701c51ba7a Merge pull request \fI\%#24005\fP from msteed/issue\-23776
.IP \(bu 2
62e67d8ca0 issue \fI\%#23776\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23950\fP: (\fI\%neogenix\fP) iptables state generates a 0 position which is invalid in iptables cli (refs: \fI\%#23996\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23996\fP: (\fI\%neogenix\fP) iptables state generates a 0 position which is invalid in iptables cli \fI\%#23950\fP
@ \fI2015\-05\-20 22:44:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
17b7c0b741 Merge pull request \fI\%#23996\fP from neogenix/2015.5\-23950
.IP \(bu 2
ad417a57c2 fix for \fI\%#23950\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23994\fP: (\fI\%rallytime\fP) Skip the gpodder pkgrepo test for Ubuntu 15 \- they don\(aqt have vivid ppa up yet
@ \fI2015\-05\-20 21:18:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
4cb877307c Merge pull request \fI\%#23994\fP from rallytime/skip_test_ubuntu_15
.IP \(bu 2
9e0ec07d85 Skip the gpodder pkgrepo test \- they don\(aqt have vivid ppa up yet
.UNINDENT
.UNINDENT
.SS Salt 2015.5.3 Release Notes
.INDENT 0.0
.TP
.B release
2015\-07\-07
.UNINDENT
.sp
Version 2015.5.3 is a bugfix release for \fI\%2015.5.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB178\fP
.IP \(bu 2
Total Issue References: \fB69\fP
.IP \(bu 2
Total PR References: \fB207\fP
.IP \(bu 2
Contributors: \fB62\fP (\fI\%CameronNemo\fP, \fI\%Lanzaa\fP, \fI\%Starblade42\fP, \fI\%The\-Loeki\fP, \fI\%TheScriptSage\fP,
\fI\%aboe76\fP, \fI\%ahus1\fP, \fI\%aneeshusa\fP, \fI\%anlutro\fP, \fI\%arthurlogilab\fP, \fI\%basepi\fP, \fI\%borutmrak\fP,
\fI\%cachedout\fP, \fI\%cgtx\fP, \fI\%codertux\fP, \fI\%cro\fP, \fI\%dkiser\fP, \fI\%driskell\fP, \fI\%eliasp\fP,
\fI\%garethgreenaway\fP, \fI\%grischa\fP, \fI\%gthb\fP, \fI\%heewa\fP, \fI\%infestdead\fP, \fI\%jacksontj\fP, \fI\%jacobhammons\fP,
\fI\%jayeshka\fP, \fI\%jeanpralo\fP, \fI\%jfindlay\fP, \fI\%jodv\fP, \fI\%joejulian\fP, \fI\%justinta\fP, \fI\%kartiksubbarao\fP,
\fI\%kev009\fP, \fI\%kiorky\fP, \fI\%lorengordon\fP, \fI\%msciciel\fP, \fI\%msteed\fP, \fI\%nmadhok\fP, \fI\%notpeter\fP,
\fI\%obestwalter\fP, \fI\%pengyao\fP, \fI\%pille\fP, \fI\%porterjamesj\fP, \fI\%pruiz\fP, \fI\%quixoten\fP, \fI\%rallytime\fP,
\fI\%rhertzog\fP, \fI\%ruzarowski\fP, \fI\%ryan\-lane\fP, \fI\%steverweber\fP, \fI\%tankywoo\fP, \fI\%tbaker57\fP, \fI\%techhat\fP,
\fI\%terminalmage\fP, \fI\%thatch45\fP, \fI\%thenewwazoo\fP, \fI\%trevor\-h\fP, \fI\%twangboy\fP, \fI\%variia\fP, \fI\%zefrog\fP,
\fI\%zhujinhe\fP)
.UNINDENT
.SS Changelog for v2015.5.2..v2015.5.3
.sp
\fIGenerated at: 2018\-05\-27 21:20:01 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#25109\fP: (\fI\%jfindlay\fP) add 2015.5.3 release notes
@ \fI2015\-07\-01 19:45:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
f0f512a4da Merge pull request \fI\%#25109\fP from jfindlay/2015.5
.IP \(bu 2
3187d5d5aa add 2015.5.3 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25096\fP: (\fI\%jfindlay\fP) Postgres group test
@ \fI2015\-07\-01 18:48:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24330\fP: (\fI\%jayeshka\fP) adding states/postgres_group unit test case. (refs: \fI\%#25096\fP)
.IP \(bu 2
21709aa483 Merge pull request \fI\%#25096\fP from jfindlay/postgres_group_test
.IP \(bu 2
3c379dc115 declobber postgres state unit test mocking
.IP \(bu 2
a162ffa3d8 adding states/postgres_group unit test case.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25041\fP: (\fI\%wt\fP) REGRESSION: pillar.get of integer fails to render in sls (refs: \fI\%#25085\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25085\fP: (\fI\%jfindlay\fP) accept all sources in the file state
@ \fI2015\-07\-01 18:23:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a846400c6 Merge pull request \fI\%#25085\fP from jfindlay/fix_file
.IP \(bu 2
937a252e16 remove unnecessary file state tests
.IP \(bu 2
6f238e924c integration test file.managed sources
.IP \(bu 2
a5978d30c2 iterate an iterable source othwerise list+str it
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25095\fP: (\fI\%jfindlay\fP) Win groupadd unit tests
@ \fI2015\-07\-01 18:18:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24207\fP: (\fI\%jayeshka\fP) adding win_groupadd unit test case. (refs: \fI\%#25095\fP)
.IP \(bu 2
a98394210e Merge pull request \fI\%#25095\fP from jfindlay/win_groupadd_test
.IP \(bu 2
564dffd14a depend on win libs rather than mocking them
.IP \(bu 2
9b9aeb8628 resolved all errors.
.IP \(bu 2
aaf89354c0 adding win_groupadd unit test case.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21520\fP: (\fI\%jfindlay\fP) sudo.salt_call is broken (refs: \fI\%#25089\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25089\fP: (\fI\%jfindlay\fP) fix minion sudo
@ \fI2015\-07\-01 15:53:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#20226\fP: (\fI\%thatch45\fP) Allow sudo priv escalation (refs: \fI\%#25089\fP)
.IP \(bu 2
7c8d2a8656 Merge pull request \fI\%#25089\fP from jfindlay/fix_sudo
.IP \(bu 2
d8f91d4a19 add some apprehension to the sudo exec module
.IP \(bu 2
a9269c072a adding sudo exec module docs
.IP \(bu 2
e4a40b7bd8 comment whitespace in minion config
.IP \(bu 2
44cb167744 adding sudo_user minion config docs
.IP \(bu 2
d461060efe adding sudo_user minion config to default
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24875\fP: (\fI\%ahammond\fP) ValueError: list.remove(x): x not in list  in   File \(dq/usr/lib/python2.6/site\-packages/salt/cli/batch.py\(dq, line 179, in run active.remove(minion) (refs: \fI\%#25099\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25099\fP: (\fI\%driskell\fP) Fix broken batch results
@ \fI2015\-07\-01 15:51:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
4d6078e5dd Merge pull request \fI\%#25099\fP from driskell/patch\-1
.IP \(bu 2
59b23e5f6e Fix broken batch results
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25083\fP: (\fI\%steverweber\fP) ipmi: get_sensor_data would always fail
@ \fI2015\-06\-30 20:57:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
46350796b6 Merge pull request \fI\%#25083\fP from steverweber/fix_ipmi_stat
.IP \(bu 2
836f48c378 include _ in IpmiCommand
.IP \(bu 2
817e434591 get_sensor_data would always fail
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25067\fP: (\fI\%The\-Loeki\fP) Fix for maxdepth=0 in find
@ \fI2015\-06\-30 20:54:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
15f2a4077c Merge pull request \fI\%#25067\fP from The\-Loeki/patch\-1
.IP \(bu 2
61edad3a80 Fix for maxdepth=0 in find
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25078\fP: (\fI\%terminalmage\fP) Use smaller number for upper limit of mac_user\(aqs _first_avail_uid helper function
@ \fI2015\-06\-30 20:53:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
58d933cfa8 Merge pull request \fI\%#25078\fP from terminalmage/fix\-mac\-uid
.IP \(bu 2
df2ab7ee2b Use smaller number for upper limit of mac_user\(aqs _first_avail_uid helper function
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24521\fP: (\fI\%multani\fP) State network.managed fails on Debian (Jessie) (refs: \fI\%#25045\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25045\fP: (\fI\%garethgreenaway\fP) Fixes to debian_ip.py in 2015.5
@ \fI2015\-06\-30 17:36:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
ebd6cdc412 Merge pull request \fI\%#25045\fP from garethgreenaway/24521_debian_networking
.IP \(bu 2
6f2a6c940b having proto default to static since it\(aqs needed to build the template.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25065\fP: (\fI\%lorengordon\fP) Add download links for 2015.5.1\-3 and 2015.5.2 Windows installers
@ \fI2015\-06\-30 15:29:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
ae31b279cc Merge pull request \fI\%#25065\fP from lorengordon/update\-windows\-installer\-links
.IP \(bu 2
40a0c132d4 Add download links for 2015.5.1\-3 and 2015.5.2, Fixes \fI\%#25057\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25052\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-06\-30 01:05:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
ddaeb0fb8e Merge pull request \fI\%#25052\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
2c5e664a58 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
a7154e7471 Merge pull request \fI\%#25011\fP from notpeter/s3_2014.7_backport
.INDENT 2.0
.IP \(bu 2
8b8af640f6 Add s3 to protocols for remote source_hash
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25038\fP: (\fI\%jfindlay\fP) versionadded
@ \fI2015\-06\-29 19:49:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24747\fP: (\fI\%msciciel\fP) add get_route function to network module (refs: \fI\%#25038\fP)
.IP \(bu 2
c7003d4951 Merge pull request \fI\%#25038\fP from jfindlay/versionadded
.IP \(bu 2
d6dc6f97b5 versionadded
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24747\fP: (\fI\%msciciel\fP) add get_route function to network module (refs: \fI\%#25038\fP)
@ \fI2015\-06\-29 16:51:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
28c87cab17 Merge pull request \fI\%#24747\fP from msciciel/2015.5
.IP \(bu 2
79b4ec2da8 network module lint fix
.IP \(bu 2
0b6ef784b2 network module: fix for ipv6
.IP \(bu 2
f3d184c478 add get_route function to network module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24975\fP: (\fI\%ryan\-lane\fP) Fix update of undefined env var in npm module
@ \fI2015\-06\-29 16:45:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
46a96773aa Merge pull request \fI\%#24975\fP from lyft/npm\-module\-fix
.IP \(bu 2
6fde58182f Try byte literals rather than unicode strings in the env
.IP \(bu 2
c8514de334 Fix update of undefined env var in npm module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24986\fP: (\fI\%heewa\fP) Don\(aqt modify empty change
@ \fI2015\-06\-29 16:44:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
9cf8550cd8 Merge pull request \fI\%#24986\fP from heewa/fix\-pkg\-hold\-when\-errored
.IP \(bu 2
d47a448a80 Don\(aqt modify empty change
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24969\fP: (\fI\%bradthurber\fP) salt\-cloud 2015.5.0: missing azure dependency results in misleading error (refs: \fI\%#24999\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24999\fP: (\fI\%rallytime\fP) Provide a less confusing error when cloud provider is misconfigured
@ \fI2015\-06\-29 16:43:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
ece897d8d6 Merge pull request \fI\%#24999\fP from rallytime/cloud_error_help
.IP \(bu 2
1e81a88625 Clean up
.IP \(bu 2
be19a6730e Provide a less confusing error when cloud provider is misconfigured
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24987\fP: (\fI\%heewa\fP) Don\(aqt try to cache a template when it\(aqs not a file
@ \fI2015\-06\-29 14:02:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
4af15cfb90 Merge pull request \fI\%#24987\fP from heewa/fix\-trying\-to\-cache\-no\-file
.IP \(bu 2
9ae0c78ffc Don\(aqt try to cache a template when it\(aqs not a file
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25022\fP: (\fI\%jfindlay\fP) revise label and milestone documentation
@ \fI2015\-06\-29 13:51:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
8eeaddbff4 Merge pull request \fI\%#25022\fP from jfindlay/label_docs
.IP \(bu 2
8575192cc4 revise label and milestone documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25029\fP: (\fI\%jayeshka\fP) adding redismod unit test case.
@ \fI2015\-06\-29 13:50:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
89c2e01ac1 Merge pull request \fI\%#25029\fP from jayeshka/redismod\-unit\-test
.IP \(bu 2
e3045be5a9 adding redismod unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24995\fP: (\fI\%rallytime\fP) Fix deprecated pymongo usage causing errors in latest pymongo
@ \fI2015\-06\-27 22:28:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24175\fP: (\fI\%trevor\-h\fP) fix deprecated pymongo usage causing errors in latest pymongo (refs: \fI\%#24995\fP)
.IP \(bu 2
642525298c Merge pull request \fI\%#24995\fP from rallytime/tops_mongo
.IP \(bu 2
a3c1063a37 fix deprecated pymongo usage causing errors in latest pymongo
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24862\fP: (\fI\%dkatsanikakis\fP) gpg.import_key returns error after successfully completed (refs: \fI\%#24994\fP, \fI\%#24966\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24994\fP: (\fI\%garethgreenaway\fP) Another Fix to gpg.py in 2015.5
@ \fI2015\-06\-27 22:28:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
e9aaa11b68 Merge pull request \fI\%#24994\fP from garethgreenaway/2015_5_24862_gpg_import_key
.IP \(bu 2
d2f0d8fa96 variable was referenced before assignment.  Just removing the variable and checking the return from distutils.version.LooseVersion directly.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24988\fP: (\fI\%jayeshka\fP) adding states/supervisord unit test case.
@ \fI2015\-06\-27 22:24:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
ebd666e5ee Merge pull request \fI\%#24988\fP from jayeshka/supervisord\-states\-unit\-test
.IP \(bu 2
bb0a6d5625 adding states/supervisord unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25007\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-06\-26 21:28:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
0487c3c59b Merge pull request \fI\%#25007\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
4980fd547b Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
a11e4c6eea Merge pull request \fI\%#24944\fP from techhat/issue24915
.INDENT 2.0
.IP \(bu 2
59c3081e49 Double\-check main_cloud_config
.UNINDENT
.IP \(bu 2
d26a5447ba Merge pull request \fI\%#24936\fP from jtand/psutil
.INDENT 2.0
.IP \(bu 2
bdb7a19c36 Fixed ps module to not use depreciated psutil commands
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25003\fP: (\fI\%jacobhammons\fP) Updated man pages
@ \fI2015\-06\-26 19:13:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
91a60e198e Merge pull request \fI\%#25003\fP from jacobhammons/man\-pages
.IP \(bu 2
cf97a4ab17 Updated man pages
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25002\fP: (\fI\%jacobhammons\fP) sphinx html theme updates
@ \fI2015\-06\-26 18:39:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
a60a2c4222 Merge pull request \fI\%#25002\fP from jacobhammons/doc\-announcements
.IP \(bu 2
f88f344a28 sphinx html theme updates
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24977\fP: (\fI\%rallytime\fP) Only warn about digital ocean deprecation if digital ocean is configured
@ \fI2015\-06\-25 23:54:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
a791b23ff9 Merge pull request \fI\%#24977\fP from rallytime/do_move_warning
.IP \(bu 2
6b544227ab Only warn about digital ocean deprecation if digital ocean is configured
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24862\fP: (\fI\%dkatsanikakis\fP) gpg.import_key returns error after successfully completed (refs: \fI\%#24994\fP, \fI\%#24966\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24966\fP: (\fI\%garethgreenaway\fP) Fixes to gpg.py in 2015.5
@ \fI2015\-06\-25 19:58:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
a71c1b7c8b Merge pull request \fI\%#24966\fP from garethgreenaway/2015_5_24862_gpg_import_key
.IP \(bu 2
55eb73b0c9 fixing unit tests.
.IP \(bu 2
80c24be4fe Fixing an issue with the import_key method.  Different results depending on which gnupg python module is installed.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24846\fP: (\fI\%mavenAtHouzz\fP) Memory leak issue in rest_tornado EventListener (refs: \fI\%#24965\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24965\fP: (\fI\%jacksontj\fP) Fix memory leak in saltnado
@ \fI2015\-06\-25 18:48:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
86221846ac Merge pull request \fI\%#24965\fP from jacksontj/2015.5
.IP \(bu 2
48b5e1653e pylint
.IP \(bu 2
87adca46e0 Fix memory leak in saltnado
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24948\fP: (\fI\%jfindlay\fP) fix some malformed doc links and anchors
@ \fI2015\-06\-25 15:51:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
773c4cf8e4 Merge pull request \fI\%#24948\fP from jfindlay/doc_links
.IP \(bu 2
152a9b2a12 fix some malformed doc links and anchors
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24885\fP: (\fI\%anlutro\fP) Master config \- Directories starting with a dot have the dot stripped when root_dir is . (refs: \fI\%#24886\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24886\fP: (\fI\%anlutro\fP) Be more careful about stripping away root_dir from directory options
@ \fI2015\-06\-25 15:50:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ebc01e662 Merge pull request \fI\%#24886\fP from alprs/fix\-root_dir_bug
.IP \(bu 2
52ccafded3 os.sep is the correct directory separator constant
.IP \(bu 2
0ecbf261ad Be more careful about stripping away root_dir from directory options
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24930\fP: (\fI\%jacksontj\fP) Don\(aqt refetch file templates 100% of the time\-\- Performance optimization for templated files
@ \fI2015\-06\-24 21:22:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
f52f7e1d20 Merge pull request \fI\%#24930\fP from jacksontj/2015.5
.IP \(bu 2
5fb75346ef Only parse the source if we have one
.IP \(bu 2
c03a6fa9d1 Add support for sources of managed files to be local
.IP \(bu 2
4cf78a0a95 pylint
.IP \(bu 2
d70914e473 Don\(aqt refetch the template 100% of the time\-\- Performance optimization for templated files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24935\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-06\-24 18:17:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
925a4d91ba Merge pull request \fI\%#24935\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
8d8bf3476f Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
eeb05a1b10 Merge pull request \fI\%#24918\fP from BretFisher/minion\-start\-smartos\-smf\-fix
.INDENT 2.0
.IP \(bu 2
d7bfb0c7fd Smartos smf minion fix
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24826\fP: (\fI\%rakai93\fP) rh_service.py: \(aqint\(aq object has no attribute \(aqstartswith\(aq (refs: \fI\%#24873\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24873\fP: (\fI\%jfindlay\fP) convert osrelease grain to str before str op
@ \fI2015\-06\-24 16:43:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
4e8ed0d8ed Merge pull request \fI\%#24873\fP from jfindlay/rh_service
.IP \(bu 2
febe6efab7 convert osrelease grain to str before str op
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24923\fP: (\fI\%jayeshka\fP) adding states/status unit test case.
@ \fI2015\-06\-24 15:50:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
90819f9c37 Merge pull request \fI\%#24923\fP from jayeshka/status\-states\-unit\-test
.IP \(bu 2
baec650674 adding states/status unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24902\fP: (\fI\%cro\fP) Fix minion failover, document same
@ \fI2015\-06\-24 15:20:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
2dd24ece71 Merge pull request \fI\%#24902\fP from cro/fixfo2
.IP \(bu 2
90c73ff446 References to documentation.
.IP \(bu 2
f0c9204d8b Add references to failover parameters in conf
.IP \(bu 2
9da96a8b95 Docs
.IP \(bu 2
e2314f0e49 Move comment.
.IP \(bu 2
b9a756ff5f Fix master failover and add documentation for same.  Factor in syndics.  Syndics will not failover (yet).
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24926\fP: (\fI\%rallytime\fP) Back\-port \fI\%#22263\fP to 2015.5
@ \fI2015\-06\-24 15:09:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#22263\fP: (\fI\%cachedout\fP) Prevent a load from being written if one already exists (refs: \fI\%#24926\fP)
.IP \(bu 2
087ee09f46 Merge pull request \fI\%#24926\fP from rallytime/bp\-22263
.IP \(bu 2
8c92d9c677 Prevent a load from being written if one already exists
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24900\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24848\fP to 2015.5
@ \fI2015\-06\-24 15:09:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24848\fP: (\fI\%nmadhok\fP) Correcting bash code blocks (refs: \fI\%#24900\fP)
.IP \(bu 2
b34a74fe89 Merge pull request \fI\%#24900\fP from rallytime/bp\-24848
.IP \(bu 2
d2b5456f5d Correcting bash code blocks
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24899\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24847\fP to 2015.5
@ \fI2015\-06\-24 15:09:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24847\fP: (\fI\%borutmrak\fP) unset size parameter for lxc.create when backing=zfs (refs: \fI\%#24899\fP)
.IP \(bu 2
a546e8e326 Merge pull request \fI\%#24899\fP from rallytime/bp\-24847
.IP \(bu 2
1e4ec7a56b unset size parameter for lxc.create when backing=zfs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24898\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24845\fP to 2015.5
@ \fI2015\-06\-24 15:06:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24845\fP: (\fI\%porterjamesj\fP) fix bug in docker.loaded (refs: \fI\%#24898\fP)
.IP \(bu 2
d4dd8d288d Merge pull request \fI\%#24898\fP from rallytime/bp\-24845
.IP \(bu 2
071049ae7a fix bug in docker.loaded
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24799\fP: (\fI\%infestdead\fP) Forced remount because options changed when no options changed (glusterfs) (refs: \fI\%#24839\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24897\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24839\fP to 2015.5
@ \fI2015\-06\-24 15:05:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24839\fP: (\fI\%infestdead\fP) fix for issue \fI\%#24799\fP (refs: \fI\%#24897\fP)
.IP \(bu 2
693085520f Merge pull request \fI\%#24897\fP from rallytime/bp\-24839
.IP \(bu 2
f3b20d5445 fix for issue \fI\%#24799\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24891\fP: (\fI\%jayeshka\fP) adding states/ssh_known_hosts unit test case.
@ \fI2015\-06\-23 16:46:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
1650233be9 Merge pull request \fI\%#24891\fP from jayeshka/ssh_known_hosts\-states\-unit\-test
.IP \(bu 2
ef1347f2b3 adding states/ssh_known_hosts unit test case.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24870\fP: (\fI\%dkiser\fP) salt\-cloud fails on sudo password prompt when using ssh key to auth (refs: \fI\%#24874\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24874\fP: (\fI\%dkiser\fP) Fix for salt\-cloud when ssh key used to auth and using sudo.
@ \fI2015\-06\-22 23:46:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
c32aae96aa Merge pull request \fI\%#24874\fP from dkiser/salt\-cloud\-24870
.IP \(bu 2
6c31143b22 Fix key error for the PR to fix \fI\%#24870\fP\&.
.IP \(bu 2
bdcf7d88c1 Fix pylint for \fI\%#24874\fP\&.
.IP \(bu 2
8f66d193e0 Fix for salt\-cloud when ssh key used to auth and using sudo.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24871\fP: (\fI\%dkiser\fP) salt\-cloud fails to honor \(aqpassword\(aq in cloud options before raising an exception (refs: \fI\%#24880\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24880\fP: (\fI\%dkiser\fP) Fix to allow password for salt\-cloud to be set outside of a vm specif…
@ \fI2015\-06\-22 23:44:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
ddaa21c0ae Merge pull request \fI\%#24880\fP from dkiser/salt\-cloud\-24871
.IP \(bu 2
4f6c035673 Fix to allow password for salt\-cloud to be set outside of a vm specific context.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24852\fP: (\fI\%pruiz\fP) Fix issue 24851: regular expression so it now matches packages with \(aq.\(aq or \(aq\-\(aq at pkg name
@ \fI2015\-06\-22 20:37:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
3902b162a9 Merge pull request \fI\%#24852\fP from pruiz/issue\-24851
.IP \(bu 2
73adb1df50 Fix regular expression so it now matches packages with \(aq.\(aq or \(aq\-\(aq at pkg name.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24861\fP: (\fI\%jayeshka\fP) adding states/ssh_auth unit test case.
@ \fI2015\-06\-22 16:20:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
6c5b788afd Merge pull request \fI\%#24861\fP from jayeshka/ssh_auth\-states\-unit\-test
.IP \(bu 2
e5d7b0de80 adding states/ssh_auth unit test case.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23478\fP: (\fI\%calvinhp\fP) grains.get virtual reports \(dqphysical\(dq on bhyve FreeBSD VM (refs: \fI\%#24824\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24824\fP: (\fI\%kev009\fP) Detect bhyve virtual type for FreeBSD guests
@ \fI2015\-06\-22 15:24:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
9e3321c18e Merge pull request \fI\%#24824\fP from kev009/grains\-bhyve\-bsd
.IP \(bu 2
a2262097a1 Detect bhyve virtual type for freebsd guests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24746\fP: (\fI\%anlutro\fP) state.apply doesn\(aqt seem to work (refs: \fI\%#24795\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24795\fP: (\fI\%anlutro\fP) Fix state.apply for salt\-ssh
@ \fI2015\-06\-22 15:23:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
7b07ef9f44 Merge pull request \fI\%#24795\fP from alprs/fix\-salt_ssh_state_apply
.IP \(bu 2
905840b1fa Fix state.apply for salt\-ssh
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24832\fP: (\fI\%jacksontj\fP) Don\(aqt incur a \(dq_load_all\(dq of the lazy_loader while looking for mod_init.
@ \fI2015\-06\-22 15:17:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#20540\fP: (\fI\%jacksontj\fP) Loader nomerge: Don\(aqt allow modules to \(dqmerge\(dq (refs: \fI\%#24832\fP)
.IP \(bu 2
\fBPR\fP \fI\%#20481\fP: (\fI\%jacksontj\fP) Add submodule support to LazyLoader (refs: \fI\%#20540\fP)
.IP \(bu 2
\fBPR\fP \fI\%#20473\fP: (\fI\%jacksontj\fP) Add \(dqdisabled\(dq support (refs: \fI\%#20481\fP)
.IP \(bu 2
\fBPR\fP \fI\%#20274\fP: (\fI\%jacksontj\fP) Loader overhaul to LazyLoader (refs: \fI\%#20473\fP)
.IP \(bu 2
\fBPR\fP \fI\%#12327\fP: (\fI\%jacksontj\fP) Add a LazyLoader class which will lazily load modules (with the given lo... (refs: \fI\%#20274\fP)
.IP \(bu 2
31d4c131e9 Merge pull request \fI\%#24832\fP from jacksontj/2015.5
.IP \(bu 2
cfa7c0a699 pylint
.IP \(bu 2
be18439736 Don\(aqt incur a \(dq_load_all\(dq of the lazy_loader while looking for mod_init.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#14666\fP: (\fI\%luciddr34m3r\fP) salt\-cloud GoGrid exception when using map file (refs: \fI\%#24811\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24834\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24811\fP to 2015.5
@ \fI2015\-06\-19 18:43:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24811\fP: (\fI\%rallytime\fP) Add notes to map and gogrid docs \-\- don\(aqt use \-P with map files (refs: \fI\%#24834\fP)
.IP \(bu 2
2d8148fb4d Merge pull request \fI\%#24834\fP from rallytime/bp\-24811
.IP \(bu 2
e2684ecf0b Add notes to map and gogrid docs \-\- don\(aqt use \-P with map files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24790\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24741\fP to 2015.5
@ \fI2015\-06\-19 17:25:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24741\fP: (\fI\%CameronNemo\fP) Improve Upstart enable/disable handling (refs: \fI\%#24790\fP)
.IP \(bu 2
d2edb63cff Merge pull request \fI\%#24790\fP from rallytime/bp\-24741
.IP \(bu 2
a54245f080 Add missing import
.IP \(bu 2
4ce6370d6e salt.modules.upstart: fix lint errors
.IP \(bu 2
aec53ec32a Improve Upstart enable/disable handling
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24789\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24717\fP to 2015.5
@ \fI2015\-06\-19 17:17:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24717\fP: (\fI\%gthb\fP) virtualenv.managed: document user and no_chown (refs: \fI\%#24789\fP)
.IP \(bu 2
645e62a43c Merge pull request \fI\%#24789\fP from rallytime/bp\-24717
.IP \(bu 2
95ac4eba13 virtualenv.managed: document user and no_chown
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24823\fP: (\fI\%jayeshka\fP) adding states/splunk_search unit test case.
@ \fI2015\-06\-19 17:14:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a6c70f062 Merge pull request \fI\%#24823\fP from jayeshka/splunk_search\-states\-unit\-test
.IP \(bu 2
98831a8cb0 adding states/splunk_search unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24809\fP: (\fI\%jodv\fP) Correctly create single item list for failover master type with string value for master opt
@ \fI2015\-06\-19 15:22:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
4c5a708599 Merge pull request \fI\%#24809\fP from jodv/single_item_master_list
.IP \(bu 2
18ceebc77f single item list vs. list of characters
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24802\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-06\-18 20:11:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
ae05e70e94 Merge pull request \fI\%#24802\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
5b7a65d6d9 Merge pull request \fI\%#19\fP from twangboy/merge\-forward\-fixes
.INDENT 2.0
.IP \(bu 2
98e7e90299 Fixed test failures for Colton
.UNINDENT
.IP \(bu 2
b949856ae6 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
4281dfff0b Merge pull request \fI\%#24780\fP from nmadhok/backport\-2014.7\-24777
.INDENT 2.0
.IP \(bu 2
c53b0d9a22 Backporting PR \fI\%#24777\fP to 2014.7 branch
.UNINDENT
.IP \(bu 2
f3c5cb2d41 Merge pull request \fI\%#24769\fP from msteed/issue\-21318
.INDENT 2.0
.IP \(bu 2
f40a9d5cc0 Fix stacktrace in get_cli_returns()
.UNINDENT
.IP \(bu 2
59db24602f Merge pull request \fI\%#24690\fP from twangboy/fix_17041
.INDENT 2.0
.IP \(bu 2
7a015389af Added additional reporting
.IP \(bu 2
d84ad5d519 Fixed capitalization... Failed and Already
.IP \(bu 2
e9552455c4 Merge branch \(aq2014.7\(aq of \fI\%https://github.com/saltstack/salt\fP into fix_17041
.IP \(bu 2
144bff2f67 Report powershell output instead of error
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#24329\fP: (\fI\%jayeshka\fP) adding states/postgres_database unit test case. (refs: \fI\%#24798\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24798\fP: (\fI\%justinta\fP) Revert \(dqadding states/postgres_database unit test case.\(dq
@ \fI2015\-06\-18 17:56:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
daa76c34e4 Merge pull request \fI\%#24798\fP from saltstack/revert\-24329\-postgres_database\-states\-unit\-test
.IP \(bu 2
179ce03d93 Revert \(dqadding states/postgres_database unit test case.\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24791\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24749\fP to 2015.5
@ \fI2015\-06\-18 17:43:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24749\fP: (\fI\%obestwalter\fP) add windows specific default for multiprocessing (refs: \fI\%#24791\fP)
.IP \(bu 2
7073a9f850 Merge pull request \fI\%#24791\fP from rallytime/bp\-24749
.IP \(bu 2
be43b2b394 add windows specific default for multiprocessing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24792\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24757\fP to 2015.5
@ \fI2015\-06\-18 15:58:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24757\fP: (\fI\%cachedout\fP) Fix loader call in pyobjects (refs: \fI\%#24792\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24668\fP: (\fI\%grischa\fP) enable virtual package names in pyobjects renderer (refs: \fI\%#24721\fP, \fI\%#24757\fP)
.IP \(bu 2
1a158e8a3b Merge pull request \fI\%#24792\fP from rallytime/bp\-24757
.IP \(bu 2
6c804f0789 Fix loader call in pyobjects
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24768\fP: (\fI\%jfindlay\fP) fix yum versionlock on RHEL/CentOS 5, disable corresponding test
@ \fI2015\-06\-18 15:13:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
0f9298263b Merge pull request \fI\%#24768\fP from jfindlay/pkg_mod
.IP \(bu 2
7a26c2b5b9 disable pkg.hold test for RHEL/CentOS 5
.IP \(bu 2
4cacd93c22 use correct yum versionlock pkg name on centos 5
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24776\fP: (\fI\%nmadhok\fP) \-\-static option in salt raises ValueError and has been broken for a very long time (refs: \fI\%#24777\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24779\fP: (\fI\%nmadhok\fP) Backporting Changes to 2014.7 branch (refs: \fI\%#24777\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24778\fP: (\fI\%nmadhok\fP) Backporting PR \fI\%#24777\fP to 2015.2 branch (refs: \fI\%#24777\fP)
@ \fI2015\-06\-18 14:53:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24777\fP: (\fI\%nmadhok\fP) Fixing issue where \-\-static option fails with ValueError Fixes \fI\%#24776\fP (refs: \fI\%#24778\fP, \fI\%#24780\fP)
.IP \(bu 2
39f088a74c Merge pull request \fI\%#24778\fP from nmadhok/backport\-2015.2\-24777
.IP \(bu 2
ae3701f639 Backporting PR \fI\%#24777\fP to 2015.2 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24774\fP: (\fI\%zefrog\fP) Fix lxc lvname parameter command
@ \fI2015\-06\-18 14:49:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
2a4f65f3f7 Merge pull request \fI\%#24774\fP from zefrog/fix\-lxc\-lvname\-param
.IP \(bu 2
21e0cd4a5e Fixed typo in lxc module: lvname parameter typo
.IP \(bu 2
283d86ec12 Fixed bug in lxc module: lvname using wrong parameter in cmd
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24782\fP: (\fI\%jayeshka\fP) adding states/slack unit test case.
@ \fI2015\-06\-18 14:33:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd7339014b Merge pull request \fI\%#24782\fP from jayeshka/slack\-states\-unit\-test
.IP \(bu 2
e2b6214764 adding states/slack unit test case.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24770\fP: (\fI\%jacksontj\fP) \fIRequisite\fP and \fIRequisite_in\fP don\(aqt play nice together (refs: \fI\%#24771\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24771\fP: (\fI\%jacksontj\fP) Always extend requisites, instead of replacing them
@ \fI2015\-06\-18 14:29:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
c9c90af512 Merge pull request \fI\%#24771\fP from jacksontj/2015.5
.IP \(bu 2
b1211c5422 Re\-enable tests for complex prereq and prereq_in
.IP \(bu 2
378f6bfc36 Only merge when the merge is of requisites
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24766\fP: (\fI\%msteed\fP) Remove doc references to obsolete minion opt
@ \fI2015\-06\-17 21:36:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
5fe4de8f62 Merge pull request \fI\%#24766\fP from msteed/undoc\-dns_check
.IP \(bu 2
f92a769d35 Remove doc references to obsolete minion opt
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24329\fP: (\fI\%jayeshka\fP) adding states/postgres_database unit test case.
@ \fI2015\-06\-17 19:11:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
a407ab7c51 Merge pull request \fI\%#24329\fP from jayeshka/postgres_database\-states\-unit\-test
.IP \(bu 2
ee06f1ad57 adding states/postgres_database unit test case.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24560\fP: (\fI\%hydrosine\fP) Documentation missing on parameter (refs: \fI\%#24632\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24547\fP: (\fI\%dragonpaw\fP) Artifactory docs say module is \(aqjboss7\(aq.  (refs: \fI\%#24632\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24375\fP: (\fI\%companykitchen\-dev\fP) Custom grain won\(aqt sync under any circumstances (refs: \fI\%#24632\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24275\fP: (\fI\%kartiksubbarao\fP) augeas issue with apache and recognizing changes that have been already made (refs: \fI\%#24632\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24163\fP: (\fI\%tbaker57\fP) enable_gpu_grains default value confusion (refs: \fI\%#24632\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24632\fP: (\fI\%jacobhammons\fP) Doc bug fixes
@ \fI2015\-06\-17 18:40:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ff6eff546 Merge pull request \fI\%#24632\fP from jacobhammons/bug\-fixes
.IP \(bu 2
7c52012e31 Fixed typos
.IP \(bu 2
c7cdd416a2 Doc bug fixes Refs \fI\%#24547\fP Refs \fI\%#24275\fP Refs \fI\%#24375\fP Refs \fI\%#24560\fP Refs \fI\%#24163\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24198\fP: (\fI\%ahammond\fP) salt\-call event.send doesn\(aqt send events from minion (refs: \fI\%#24607\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24607\fP: (\fI\%garethgreenaway\fP) fixes to minion.py
@ \fI2015\-06\-17 18:16:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
9995f64428 Merge pull request \fI\%#24607\fP from garethgreenaway/2015_5_sending_events_multi_master
.IP \(bu 2
8abd3f0ee1 A fix if you have multiple masters configured and try to fire events to the minion.  Currently they fail silently.  Might be the cause of \fI\%#24198\fP\&.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24755\fP: (\fI\%rallytime\fP) Remove SALT_CLOUD_REQS from setup.py
@ \fI2015\-06\-17 17:42:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf2dd94389 Merge pull request \fI\%#24755\fP from rallytime/fix_setup_15
.IP \(bu 2
48769a544d Remove SALT_CLOUD_REQS from setup.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24740\fP: (\fI\%rallytime\fP) Backport \fI\%#24720\fP to 2015.5
@ \fI2015\-06\-17 16:43:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24720\fP: (\fI\%TheScriptSage\fP) Issue 24621 \- AD/LDAP Group Auth Issue (refs: \fI\%#24740\fP)
.IP \(bu 2
3d53d79476 Merge pull request \fI\%#24740\fP from rallytime/bp\-24720
.IP \(bu 2
a9bcdb5b77 Updating master.py to properly check against groups when user is only authed against group.  Tested against unit.auth_test.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24723\fP: (\fI\%rallytime\fP) Back\-port \fI\%#20124\fP to 2015.5
@ \fI2015\-06\-17 16:43:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#20124\fP: (\fI\%cgtx\fP) add init system to default grains (refs: \fI\%#24723\fP)
.IP \(bu 2
ac2851be55 Merge pull request \fI\%#24723\fP from rallytime/bp\-20124
.IP \(bu 2
4d0061b832 fix infinite loop introduced by \fI\%#20124\fP when the init system is not in the supported_inits list
.IP \(bu 2
0c7fa0fca2 Optimizations for \fI\%#20124\fP
.IP \(bu 2
f353454327 add init system to default grains (resolve \fI\%#20124\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24754\fP: (\fI\%anlutro\fP) salt\-cloud documentation \- Add information about linode location
@ \fI2015\-06\-17 16:04:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
78cd09b6e9 Merge pull request \fI\%#24754\fP from alprs/docs\-add_linode_location_option
.IP \(bu 2
d88e071e98 add information about linode location
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24748\fP: (\fI\%jayeshka\fP) adding states/serverdensity_device unit test case.
@ \fI2015\-06\-17 15:39:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
d5554f76ec Merge pull request \fI\%#24748\fP from jayeshka/serverdensity_device\-states\-unit\-test
.IP \(bu 2
1a4c241050 adding states/serverdensity_device unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24739\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24735\fP to 2015.5
@ \fI2015\-06\-17 15:16:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24735\fP: (\fI\%notpeter\fP) Add 2015.5 codename to version numbers docs (refs: \fI\%#24739\fP)
.IP \(bu 2
0b7e7ef879 Merge pull request \fI\%#24739\fP from rallytime/bp\-24735
.IP \(bu 2
64c565d9be Add .0 to version number
.IP \(bu 2
5ed801b98f Add codenames for 2015.5 and future versions. Trailing newline.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24111\fP: (\fI\%yermulnik\fP) cli option \(aq\-\-summary\(aq got broken after upgrade to 2015.5.1 (refs: \fI\%#24732\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24732\fP: (\fI\%msteed\fP) Fix stacktrace when \fI\-\-summary\fP is used
@ \fI2015\-06\-17 03:27:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
c8713f2d00 Merge pull request \fI\%#24732\fP from msteed/issue\-24111
.IP \(bu 2
54b33dd359 Fix stacktrace when \-\-summary is used
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24721\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24668\fP to 2015.5
@ \fI2015\-06\-17 03:23:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24668\fP: (\fI\%grischa\fP) enable virtual package names in pyobjects renderer (refs: \fI\%#24721\fP, \fI\%#24757\fP)
.IP \(bu 2
70d37816bf Merge pull request \fI\%#24721\fP from rallytime/bp\-24668
.IP \(bu 2
68fb5af970 fixing other test
.IP \(bu 2
ba4f262b9c fixing text for virtual support in pyobjects
.IP \(bu 2
b349d91a5f enable virtual package names in pyobjects renderer
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21923\fP: (\fI\%Fluro\fP) Salt cloud not running  provisioning script as root (refs: \fI\%#24718\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#17241\fP: (\fI\%hasues\fP) Salt\-Cloud for vSphere needs additional documentation (refs: \fI\%#24718\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24718\fP: (\fI\%rallytime\fP) Added some missing config documentation to the vsphere driver
@ \fI2015\-06\-17 03:19:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
1b9d6895c7 Merge pull request \fI\%#24718\fP from rallytime/update_vsphere_docs
.IP \(bu 2
bfdebb6e18 Added some missing config documentation to the vsphere driver
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24714\fP: (\fI\%rallytime\fP) Remove cloud\-requirements.txt
@ \fI2015\-06\-17 03:17:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
64857c706d Merge pull request \fI\%#24714\fP from rallytime/remove_cloud_reqs_15
.IP \(bu 2
67b796d01e Remove cloud\-requirements.txt
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24439\fP: (\fI\%bechtoldt\fP) Add tornado version to versions report (refs: \fI\%#24733\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24733\fP: (\fI\%msteed\fP) Include Tornado in versions report
@ \fI2015\-06\-17 03:13:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
f96b1d68cd Merge pull request \fI\%#24733\fP from msteed/issue\-24439
.IP \(bu 2
76cfef05ec Include Tornado in versions report
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24737\fP: (\fI\%jacksontj\fP) Move AES command logging to trace
@ \fI2015\-06\-17 01:48:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
a861fe0f4f Merge pull request \fI\%#24737\fP from jacksontj/2015.5
.IP \(bu 2
a4ed41ae82 Move AES command logging to trace
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24724\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-06\-16 22:46:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d2dc46648 Merge pull request \fI\%#24724\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
4641028464 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
a18dadad71 Merge pull request \fI\%#24646\fP from twangboy/fix_24196
.INDENT 2.0
.IP \(bu 2
a208e1d60f Fixed user.present on existing user
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24701\fP: (\fI\%jayeshka\fP) adding states/selinux unit test case.
@ \fI2015\-06\-16 15:27:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
3d33fe7676 Merge pull request \fI\%#24701\fP from jayeshka/selinux\-states\-unit\-test
.IP \(bu 2
0c136fd9c2 adding states/selinux unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24687\fP: (\fI\%cachedout\fP) Note about minimum worker_threads
@ \fI2015\-06\-15 20:46:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e287a9e33 Merge pull request \fI\%#24687\fP from cachedout/min_worker_threads
.IP \(bu 2
b7bb7eaeb2 Note about minimum worker_threads
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24688\fP: (\fI\%cachedout\fP) Update AUTHORS
@ \fI2015\-06\-15 20:46:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
432478ccb7 Merge pull request \fI\%#24688\fP from cachedout/update_authors
.IP \(bu 2
3f6880e291 Better email
.IP \(bu 2
6c7b773eae Update AUTHORS
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22385\fP: (\fI\%cachedout\fP) States which require unavailable modules should display the reason (refs: \fI\%#24649\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24649\fP: (\fI\%cachedout\fP) Improved error reporting for failed states
@ \fI2015\-06\-15 16:04:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
9a2b50d59f Merge pull request \fI\%#24649\fP from cachedout/issue_22385
.IP \(bu 2
b9fe792534 States will now return the reason behind failure if a module could not be loaded
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24673\fP: (\fI\%jayeshka\fP) adding states/schedule unit test case.
@ \fI2015\-06\-15 15:24:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
66e9e16753 Merge pull request \fI\%#24673\fP from jayeshka/schedule\-states\-unit\-test
.IP \(bu 2
54aaaa5f12 adding states/schedule unit test case.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24661\fP: (\fI\%kartiksubbarao\fP) augeas.change doesn\(aqt support setting empty values (refs: \fI\%#24663\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24663\fP: (\fI\%kartiksubbarao\fP) Update augeas_cfg.py
@ \fI2015\-06\-15 15:18:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
5eb19c4e4d Merge pull request \fI\%#24663\fP from kartiksubbarao/patch\-2
.IP \(bu 2
e18db50e0c Update augeas_cfg.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24583\fP: (\fI\%dkiser\fP) salt\-cloud keyring password referenced before assignment (refs: \fI\%#24667\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24667\fP: (\fI\%dkiser\fP) fix for \fI\%#24583\fP clouds/openstack.py kerying first time succeeds
@ \fI2015\-06\-14 21:58:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
4450432161 Merge pull request \fI\%#24667\fP from dkiser/fix\-cloud\-keyring
.IP \(bu 2
c92c05fac0 fix for \fI\%#24583\fP clouds/openstack.py kerying first time succeeds
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24537\fP: (\fI\%kartiksubbarao\fP) alias.present doesn\(aqt update alias values that are substrings of the existing value (refs: \fI\%#24659\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24659\fP: (\fI\%kartiksubbarao\fP) Update aliases.py
@ \fI2015\-06\-13 17:31:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
4c64ee9d94 Merge pull request \fI\%#24659\fP from kartiksubbarao/patch\-1
.IP \(bu 2
d6834749e2 Update aliases.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24644\fP: (\fI\%cro\fP) Merge forward 2014.7\->2015.5
@ \fI2015\-06\-12 21:31:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
89eb616c29 Merge pull request \fI\%#24644\fP from cro/2014.7\-2015.5\-20150612
.IP \(bu 2
4136dc3160 Merge forward from 2014.7 to 2015.5
.IP \(bu 2
b99484fde2 Merge pull request \fI\%#24643\fP from cro/saltannounce
.INDENT 2.0
.IP \(bu 2
ecb0623d7f Add salt\-announce mailing list.
.UNINDENT
.IP \(bu 2
635121e85d Merge pull request \fI\%#24620\fP from twangboy/fix_24215
.INDENT 2.0
.IP \(bu 2
d7a9999be1 Fixed comment and uncomment functions in file.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#24595\fP: (\fI\%tankywoo\fP) fix target rule, remove unneeded quotation mark (refs: \fI\%#24642\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24642\fP: (\fI\%basepi\fP) Revert \(dqfix target rule, remove unneeded quotation mark\(dq
@ \fI2015\-06\-12 20:14:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
b896a0d0e9 Merge pull request \fI\%#24642\fP from saltstack/revert\-24595\-fix\-iptables\-target
.IP \(bu 2
5ff3224ae1 Revert \(dqfix target rule, remove unneeded quotation mark\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24628\fP: (\fI\%jayeshka\fP) adding states/reg unit test case.
@ \fI2015\-06\-12 17:29:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
01092c2337 Merge pull request \fI\%#24628\fP from jayeshka/reg_states\-unit\-test
.IP \(bu 2
af1bd8f9ff adding states/reg unit test case.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24494\fP: (\fI\%arount\fP) Computed comments in jinja states (refs: \fI\%#24591\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23359\fP: (\fI\%BalintSzigeti\fP) init.sls parsing issue (refs: \fI\%#24591\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#21217\fP: (\fI\%Colstuwjx\fP) Maybe a bug for jinja render? (refs: \fI\%#24591\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24631\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24591\fP to 2015.5
@ \fI2015\-06\-12 16:54:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24591\fP: (\fI\%tbaker57\fP) Add some documentation surrounding Jinja vs yaml comments \-  (refs: \fI\%#24631\fP)
.IP \(bu 2
5f491f911d Merge pull request \fI\%#24631\fP from rallytime/bp\-24591
.IP \(bu 2
f13cd418bc Add extra clarification why jinja comments are needed.
.IP \(bu 2
23749718bb Fix typo
.IP \(bu 2
6a917471d4 Add some documentation surrounding Jinja comments \- refs \fI\%#24492\fP, \fI\%#21217\fP, \fI\%#23359\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24616\fP: (\fI\%garethgreenaway\fP) additional logging in state.py module
@ \fI2015\-06\-12 16:25:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
f23f99ec35 Merge pull request \fI\%#24616\fP from garethgreenaway/2015_5_logging_disabled_states
.IP \(bu 2
4dbf0ef160 Adding some logging statement to give feedback when states, including highstate, are disabled.  Useful when running from scheduler.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24595\fP: (\fI\%tankywoo\fP) fix target rule, remove unneeded quotation mark
@ \fI2015\-06\-12 16:23:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
6dccbb04a1 Merge pull request \fI\%#24595\fP from tankywoo/fix\-iptables\-target
.IP \(bu 2
10a5160d7c fix target rule, remove unneeded quotation mark
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24604\fP: (\fI\%jfindlay\fP) fix pkg module integration tests
@ \fI2015\-06\-12 16:04:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
8ac3d94785 Merge pull request \fI\%#24604\fP from jfindlay/pkg_tests
.IP \(bu 2
d88fb22fdc fix pkg module integration tests on CentOS 5
.IP \(bu 2
fb91b40ba0 fix pkg module integration tests on ubuntu 12
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24600\fP: (\fI\%basepi\fP) [2015.5] Remove __kwarg__ from salt\-ssh keyword args
@ \fI2015\-06\-12 04:21:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
0ff545c549 Merge pull request \fI\%#24600\fP from basepi/salt\-ssh.orchestrate.20615
.IP \(bu 2
9b55683f6a Remove __kwarg__ from salt\-ssh keyword args
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22843\fP: (\fI\%Xiol\fP) salt\-ssh roster doesn\(aqt support integers as host keys (refs: \fI\%#24608\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24608\fP: (\fI\%basepi\fP) [2015.5] Normalize salt\-ssh flat roster minion IDs to strings
@ \fI2015\-06\-11 21:35:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
832916f49f Merge pull request \fI\%#24608\fP from basepi/salt\-ssh.flat.roster.integers.22843
.IP \(bu 2
381820f051 Normalize salt\-ssh flat roster minion IDs to strings
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24605\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-06\-11 19:15:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
4eb5bb253b Merge pull request \fI\%#24605\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
f96c5029bb Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
d83928a7f9 Merge pull request \fI\%#24589\fP from BretFisher/patch\-1
.INDENT 2.0
.IP \(bu 2
65a11336dc Fixed Mine example for jinja code block
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24457\fP: (\fI\%ryan\-lane\fP) When selecting the version of docs on the docs site, it brings you to the homepage (refs: \fI\%#24598\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24250\fP: (\fI\%jfindlay\fP) have version links on docs page link to that version of the current page (refs: \fI\%#24598\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24598\fP: (\fI\%jacobhammons\fP) 2015.5.2 release changes
@ \fI2015\-06\-11 17:24:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
e0bb177823 Merge pull request \fI\%#24598\fP from jacobhammons/doc\-fixes
.IP \(bu 2
f3f34ddff6 2015.5.2 release changes Refs \fI\%#24250\fP Refs \fI\%#24457\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#20615\fP: (\fI\%aurynn\fP) 2014.7.1: salt/states/saltmod using incorrect return dict for orchestrate (refs: \fI\%#24588\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24588\fP: (\fI\%basepi\fP) Fixes for saltmod.function for salt\-ssh
@ \fI2015\-06\-11 16:15:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
26930b45bd Merge pull request \fI\%#24588\fP from basepi/salt\-ssh.orchestrate.20615
.IP \(bu 2
826936ce57 Move documentation into docstring instead of comments
.IP \(bu 2
de052e7135 Assign \(aqreturn\(aq to \(aqret\(aq if necessary in saltmod.function
.IP \(bu 2
34ff989d66 Convert keyword args to key=value strings in salt\-ssh
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24593\fP: (\fI\%jayeshka\fP) adding states/redismod unit test case.
@ \fI2015\-06\-11 15:55:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
5a21ad152e Merge pull request \fI\%#24593\fP from jayeshka/redismod_states\-unit\-test
.IP \(bu 2
3b95744840 adding states/redismod unit test case.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#40\fP: (\fI\%thatch45\fP) Clean up timeouts (refs: \fI\%#22857\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24581\fP: (\fI\%rallytime\fP) Disabled some flaky tests until we can figure out how to make them more reliable
@ \fI2015\-06\-11 15:51:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24217\fP: (\fI\%jfindlay\fP) disable intermittently failing tests (refs: \fI\%#24581\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23623\fP: (\fI\%jfindlay\fP) Fix /jobs endpoint\(aqs return (refs: \fI\%#24217\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22857\fP: (\fI\%jacksontj\fP) Fix /jobs endpoint\(aqs return (refs: \fI\%#23623\fP)
.IP \(bu 2
8ffb86edd0 Merge pull request \fI\%#24581\fP from rallytime/disable_some_flaky_tests
.IP \(bu 2
c82f135d2e Disabled some flaky tests until we can figure out how to make them more reliable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24566\fP: (\fI\%jayeshka\fP) adding states/rdp unit test case.
@ \fI2015\-06\-11 02:14:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
a570d7f967 Merge pull request \fI\%#24566\fP from jayeshka/rdp_states\-unit\-test
.IP \(bu 2
273b994e91 adding states/rdp unit test case.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24480\fP: (\fI\%kiorky\fP) [CRITICAL] [2015.5] tls breaks tzinfo (refs: \fI\%#24551\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24551\fP: (\fI\%joejulian\fP) 2015.5 don\(aqt pollute environment
@ \fI2015\-06\-11 02:13:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
20ada1f8a1 Merge pull request \fI\%#24551\fP from joejulian/2015.5_dont_pollute_environment
.IP \(bu 2
cfc3b43ba2 Don\(aqt pollute the TZ environment variable
.IP \(bu 2
cba8d3f923 pep8
.IP \(bu 2
9cb7015568 Mark keyword version adds
.IP \(bu 2
76e2583265 Merge tls changes from develop
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19901\fP: (\fI\%clinta\fP) State cache is not documented (refs: \fI\%#24574\fP, \fI\%#24468\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24574\fP: (\fI\%jacobhammons\fP) Refs \fI\%#19901\fP
@ \fI2015\-06\-10 20:09:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
bb2fd6a970 Merge pull request \fI\%#24574\fP from jacobhammons/19901
.IP \(bu 2
e2a2946dc7 Refs \fI\%#19901\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24577\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-06\-10 19:46:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
b03166cde3 Merge pull request \fI\%#24577\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
e1d45ccf3b Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
d376390f76 Merge pull request \fI\%#24530\fP from twangboy/fix_24427
.INDENT 2.0
.IP \(bu 2
673e1d809e Added missing panel.bmp for installer
.IP \(bu 2
cc50218b01 Start Minion Service on Silent Install
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24235\fP: (\fI\%tomasfejfar\fP) Difference between running from minion and from master (refs: \fI\%#24571\fP, \fI\%#24468\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24571\fP: (\fI\%jacobhammons\fP) Refs \fI\%#24235\fP
@ \fI2015\-06\-10 17:02:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ec457beef Merge pull request \fI\%#24571\fP from jacobhammons/24235
.IP \(bu 2
8df5d53bb8 Refs \fI\%#24235\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24565\fP: (\fI\%pille\fP) fix backtrace, when listing plugins
@ \fI2015\-06\-10 16:33:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
fe07eb5653 Merge pull request \fI\%#24565\fP from pille/munin\-ignore\-broken\-symlinks
.IP \(bu 2
8511a6c0a6 fix backtrace, when listing plugins
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24554\fP: (\fI\%ryan\-lane\fP) Fix yes usage for pecl defaults
@ \fI2015\-06\-09 23:59:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
251c8f9f5f Merge pull request \fI\%#24554\fP from lyft/pecl\-module\-fix
.IP \(bu 2
56a9cfcf24 Fix yes usage for pecl defaults
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24535\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24518\fP to 2015.5
@ \fI2015\-06\-09 20:06:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24518\fP: (\fI\%rallytime\fP) Merge \fI\%#24448\fP with Pylint Fixes (refs: \fI\%#24535\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24448\fP: (\fI\%codertux\fP) Update modules path for operating systems using systemd (refs: \fI\%#24518\fP)
.IP \(bu 2
dbd49b4acb Merge pull request \fI\%#24535\fP from rallytime/bp\-24518
.IP \(bu 2
fc75197616 Pylint fix
.IP \(bu 2
3e08840988 Update modules path for operating systems using systemd
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24538\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-06\-09 17:27:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
485ed3cff9 Merge pull request \fI\%#24538\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
6a8039d468 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
6ebc476bb3 Merge pull request \fI\%#24513\fP from jquast/2014.7\-bugfix\-iteritem
.INDENT 2.0
.IP \(bu 2
2be0180e5e bugfix use of \(aqiteritem\(aq in 2014.7 branch
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24495\fP: (\fI\%jayeshka\fP) adding states/rabbitmq_vhost unit test case.
@ \fI2015\-06\-09 15:33:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
73e6388acd Merge pull request \fI\%#24495\fP from jayeshka/rabbitmq_vhost_states\-unit\-test
.IP \(bu 2
31889e38eb cosmetic change.
.IP \(bu 2
cf501cf60d resolved error.
.IP \(bu 2
4bb6087722 Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into rabbitmq_vhost_states\-unit\-test
.IP \(bu 2
3ad77143a8 adding states/rabbitmq_vhost unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24445\fP: (\fI\%jayeshka\fP) adding states/pyrax_queues unit test case.
@ \fI2015\-06\-09 15:28:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf1abccebe Merge pull request \fI\%#24445\fP from jayeshka/pyrax_queues_states\-unit\-test
.IP \(bu 2
ea27cefb10 adding states/pyrax_queues unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24490\fP: (\fI\%aneeshusa\fP) Fix pacman.list_upgrades for new python_shell default.
@ \fI2015\-06\-09 15:13:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
0247e8d10d Merge pull request \fI\%#24490\fP from aneeshusa/fix\-pacman\-list\-upgrades
.IP \(bu 2
980e1cb4dc Lint fix.
.IP \(bu 2
dca33f1112 Fix pacman.list_upgrades for new python_shell default.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24517\fP: (\fI\%steverweber\fP) small fixes to the ipmi docs
@ \fI2015\-06\-09 15:10:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
6268ddb43a Merge pull request \fI\%#24517\fP from steverweber/ipmi_doc
.IP \(bu 2
6413712844 lint
.IP \(bu 2
e78aea9b01 more small fixes to the ipmi docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24524\fP: (\fI\%jayeshka\fP) any() takes list oy tuple.
@ \fI2015\-06\-09 13:49:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
3728b3f327 Merge pull request \fI\%#24524\fP from jayeshka/rabbitmq_vhost_states\-module
.IP \(bu 2
01c99ad767 any() takes list oy tuple.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24482\fP: (\fI\%eliasp\fP) \(aqdocker.running\(aq needs now the \(aqimage\(aq param.
@ \fI2015\-06\-09 04:43:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
dd23de885b Merge pull request \fI\%#24482\fP from eliasp/2015.5\-states.dockerio\-docker.running\-doc
.IP \(bu 2
5de741d626 \(aqdocker.running\(aq needs now the \(aqimage\(aq param.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23503\fP: (\fI\%jfindlay\fP) salt\-ssh fails on CentOS 7 when python\-zmq is not installed (refs: \fI\%#24515\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24515\fP: (\fI\%basepi\fP) [2015.5] Add xml library to the salt\-thin
@ \fI2015\-06\-09 04:10:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
2a727c3f55 Merge pull request \fI\%#24515\fP from basepi/susexml23503
.IP \(bu 2
078b33eaaf Add xml library to the thin
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24497\fP: (\fI\%jayeshka\fP) adding states/rbenv unit test case.
@ \fI2015\-06\-09 03:56:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
fce998a58b Merge pull request \fI\%#24497\fP from jayeshka/rbenv_states\-unit\-test
.IP \(bu 2
79d343a62b adding states/rbenv unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24496\fP: (\fI\%jayeshka\fP) adding states/rabbitmq_user unit test case.
@ \fI2015\-06\-09 03:55:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
2bcb4b1eed Merge pull request \fI\%#24496\fP from jayeshka/rabbitmq_user_states\-unit\-test
.IP \(bu 2
7d96f27f91 adding states/rabbitmq_user unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24481\fP: (\fI\%eliasp\fP) Fix typo (licnese → license).
@ \fI2015\-06\-09 03:30:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
02a597bf49 Merge pull request \fI\%#24481\fP from eliasp/2015.5\-salt.states.powerpath\-license_typo
.IP \(bu 2
1280054bce Fix typo (licnese → license).
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24467\fP: (\fI\%thenewwazoo\fP) Fix dockerio bound volumes
@ \fI2015\-06\-09 01:40:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
5ad3db5ffb Merge pull request \fI\%#24467\fP from thenewwazoo/fix\-dockerio\-bound\-volumes
.IP \(bu 2
db4e3dc69b Let\(aqs raise an exception if create fails
.IP \(bu 2
d1d85dd685 Add logging
.IP \(bu 2
ddc63f0f30 Fix volume handling when creating containers
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24504\fP: (\fI\%rallytime\fP) Move vsphere deprecation to 2015.5
@ \fI2015\-06\-08 22:43:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24487\fP: (\fI\%nmadhok\fP) Deprecating vsphere cloud driver in favor of vmware cloud driver (refs: \fI\%#24504\fP)
.IP \(bu 2
d236fbd38f Merge pull request \fI\%#24504\fP from rallytime/move_vsphere_deprecation_2015.5
.IP \(bu 2
d876535d71 Add Getting Started with VSphere doc to 2015.5
.IP \(bu 2
b685ebc104 Add vSphere deprecation warnings to 2015.5
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24506\fP: (\fI\%rallytime\fP) Backport \fI\%#24450\fP to 2015.5
@ \fI2015\-06\-08 22:42:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24450\fP: (\fI\%ruzarowski\fP) Fix salt cli runs with batch\-size set (refs: \fI\%#24506\fP)
.IP \(bu 2
cb5546085c Merge pull request \fI\%#24506\fP from rallytime/bp\-24450
.IP \(bu 2
1c0fca2b9d Backport \fI\%#24450\fP to 2015.5
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24498\fP: (\fI\%rallytime\fP) Added \(dqCLI Example\(dq to make failing test happy on 2015.5
@ \fI2015\-06\-08 15:48:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
3173fd17ad Merge pull request \fI\%#24498\fP from rallytime/fix_doc_failure_fifteen
.IP \(bu 2
d992ef4777 Added \(dqCLI Example\(dq to make failing test happy on 2015.5
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24471\fP: (\fI\%anlutro\fP) Set up salt\-ssh file logging
@ \fI2015\-06\-08 15:26:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
3639e411bd Merge pull request \fI\%#24471\fP from alprs/fix\-salt_ssh_logging
.IP \(bu 2
6a11ec87b8 set up salt\-ssh file logging
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24231\fP: (\fI\%tarwich\fP) npm.bootstrap (refs: \fI\%#24469\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24469\fP: (\fI\%jfindlay\fP) correctly handle user environment info for npm
@ \fI2015\-06\-08 15:26:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
551e70f3fb Merge pull request \fI\%#24469\fP from jfindlay/npm_env
.IP \(bu 2
8140c96949 update npm\(aqs user info envs
.IP \(bu 2
cb572f8c41 add \fIenv\fP parameter to npm.uninstall
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24268\fP: (\fI\%tkent\-xetus\fP) Ability to specify revision for win_gitrepos undocumented (refs: \fI\%#24468\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24235\fP: (\fI\%tomasfejfar\fP) Difference between running from minion and from master (refs: \fI\%#24571\fP, \fI\%#24468\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24193\fP: (\fI\%abng88\fP) Update ext_pillar docs to mention that this feature is supported masterless as well (refs: \fI\%#24468\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24172\fP: (\fI\%zhujinhe\fP) Can lists be passed in the pillar on the command line on version 2015.5.0? (refs: \fI\%#24468\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23211\fP: (\fI\%lloesche\fP) Document that salt://| escapes special characters in filenames (refs: \fI\%#24468\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#19901\fP: (\fI\%clinta\fP) State cache is not documented (refs: \fI\%#24574\fP, \fI\%#24468\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#19801\fP: (\fI\%ksalman\fP) How are grains static? (refs: \fI\%#24468\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24468\fP: (\fI\%jacobhammons\fP) Bug fixes and build errors
@ \fI2015\-06\-08 15:25:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d9e0c2b8c Merge pull request \fI\%#24468\fP from jacobhammons/doc\-fixes
.IP \(bu 2
1035959459 Appended .0 to version added
.IP \(bu 2
d45c4ed11f Bug fixes and build errors Refs \fI\%#23211\fP Refs \fI\%#24268\fP Refs \fI\%#24235\fP Refs \fI\%#24193\fP Refs \fI\%#24172\fP Refs \fI\%#19901\fP Refs \fI\%#19801\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24318\fP: (\fI\%favadi\fP) uncaught exception for pkgrepo.absent for invalid PPA (refs: \fI\%#24465\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24465\fP: (\fI\%jfindlay\fP) catch exception from softwarerepositories
@ \fI2015\-06\-08 15:25:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
be6905a545 Merge pull request \fI\%#24465\fP from jfindlay/unknown_ppa
.IP \(bu 2
19c912866d catch exception from softwarerepositories
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24296\fP: (\fI\%objectx\fP) mount.mount calls file.mkdir with incorrect named argument (refs: \fI\%#24464\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24464\fP: (\fI\%jfindlay\fP) fix typo in modules/mount.py
@ \fI2015\-06\-08 15:25:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
58d1ea8fe8 Merge pull request \fI\%#24464\fP from jfindlay/file_mkdir
.IP \(bu 2
6e8cd44500 fix typo in modules/mount.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24434\fP: (\fI\%dkiser\fP) multimaster failover fails due to logic from issue #23611 (refs: \fI\%#24461\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24461\fP: (\fI\%dkiser\fP) fix for \fI\%#24434\fP
@ \fI2015\-06\-08 15:24:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
4f332a71c6 Merge pull request \fI\%#24461\fP from dkiser/multimaster_minion_fix
.IP \(bu 2
1944a743d7 fix for \fI\%#24434\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24479\fP: (\fI\%ahus1\fP) change \(dqpath\(dq to \(dqname\(dq for \(dqfile\(dq operations
@ \fI2015\-06\-07 17:56:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
8917416d39 Merge pull request \fI\%#24479\fP from ahus1/patch\-1
.IP \(bu 2
7d6b60c79d change \(dqpath\(dq to \(dqname\(dq for \(dqfile\(dq operations
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24475\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24454\fP to 2015.5
@ \fI2015\-06\-07 01:29:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24454\fP: (\fI\%rhertzog\fP) Strip extraneous newline character added in last environment variable (refs: \fI\%#24475\fP)
.IP \(bu 2
8618d5b6ea Merge pull request \fI\%#24475\fP from rallytime/bp\-24454
.IP \(bu 2
a793c192a6 Avoid extraneous newline character added in last environment variable
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24407\fP: (\fI\%aboe76\fP) Please expand salt module random (refs: \fI\%#24420\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24474\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24420\fP to 2015.5
@ \fI2015\-06\-07 01:29:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24420\fP: (\fI\%aboe76\fP) added random integer module to mod_random.py (refs: \fI\%#24474\fP)
.IP \(bu 2
61658ffef7 Merge pull request \fI\%#24474\fP from rallytime/bp\-24420
.IP \(bu 2
4219b404ad Fix lint error and update versionadded to 2015.5.3
.IP \(bu 2
3613cc9659 added random integer module to mod_random.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24233\fP: (\fI\%variia\fP) yumpkg.group_install keeps returning state change
.IP \(bu 2
\fBPR\fP \fI\%#24472\fP: (\fI\%variia\fP) ensure {} output is not treated as change in module.py state, fixes #…
@ \fI2015\-06\-06 14:45:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
508d7ddb91 Merge pull request \fI\%#24472\fP from variia/Fix\-yumpkg_group_install\-return\-change\-\fI\%#24233\fP
.IP \(bu 2
37e8827ce8 ensure {} output is not treated as change in module.py state, fixes \fI\%#24233\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#8585\fP: (\fI\%UtahDave\fP) \(aq#\(aq in single quoted option on cli not making it into the execution module (refs: \fI\%#24466\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#18045\fP: (\fI\%dstokes\fP) Pillar kwargs parse error with # (refs: \fI\%#24466\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24466\fP: (\fI\%basepi\fP) [2015.5] Fix for # in inner strings in yaml arguments
@ \fI2015\-06\-06 14:35:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
0292e67c8a Merge pull request \fI\%#24466\fP from basepi/fixhashinargs18045
.IP \(bu 2
2e0609f09e Fix for # in inner strings in yaml arguments
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24456\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24441\fP to 2015.5
@ \fI2015\-06\-05 22:32:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24441\fP: (\fI\%arthurlogilab\fP) [doc] Alignment fix on external_auth documentation (refs: \fI\%#24456\fP)
.IP \(bu 2
ced558a6e6 Merge pull request \fI\%#24456\fP from rallytime/bp\-24441
.IP \(bu 2
70028553c1 yaml indentations should be 2 spaces
.IP \(bu 2
21b51abf25 [doc] Alignment fix on external_auth documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24397\fP: (\fI\%kiorky\fP) on debian: states.apt should use virtualname as it shadows system apt module (refs: \fI\%#24398\fP, \fI\%#24400\fP, \fI\%#24399\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24399\fP: (\fI\%kiorky\fP) Versionvirtual (refs: \fI\%#24398\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24398\fP: (\fI\%kiorky\fP) VirtualName for states.apt (refs: \fI\%#24399\fP)
@ \fI2015\-06\-05 17:40:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
c0ff4110ab Merge pull request \fI\%#24398\fP from makinacorpus/aptv
.IP \(bu 2
785d27707f VirtualName for states.apt
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24447\fP: (\fI\%jayeshka\fP) adding states/rabbitmq_policy unit test case.
@ \fI2015\-06\-05 15:26:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
36263405be Merge pull request \fI\%#24447\fP from jayeshka/rabbitmq_policy_states\-unit\-test
.IP \(bu 2
9b038abd63 adding states/rabbitmq_policy unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24446\fP: (\fI\%jayeshka\fP) adding states/rabbitmq_plugin unit test case.
@ \fI2015\-06\-05 15:25:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
8445a3f28d Merge pull request \fI\%#24446\fP from jayeshka/rabbitmq_plugin_states\-unit\-test
.IP \(bu 2
cb0c99a012 adding states/rabbitmq_plugin unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24426\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-06\-05 03:59:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
9cc3808758 Merge pull request \fI\%#24426\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
eafa20cdfb Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
83f853b6ea Merge pull request \fI\%#24405\fP from jacksontj/2014.7
.INDENT 2.0
.IP \(bu 2
2c7afaeebf Fix for \fI\%#24276\fP
.UNINDENT
.IP \(bu 2
cef919c602 Merge pull request \fI\%#24395\fP from hvnsweeting/handle\-exception\-get\-file
.INDENT 2.0
.IP \(bu 2
bb798a0224 handle exceptions when received data is not in good shape
.UNINDENT
.IP \(bu 2
efba1a94b4 Merge pull request \fI\%#24305\fP from twangboy/win_path_docs
.IP \(bu 2
36804253e6 Fixed pylint error caused by P... added r
.IP \(bu 2
bc42a4bb11 triple double quotes to triple single quotes
.IP \(bu 2
77cd930bba Added documentation, fixed formatting
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24309\fP: (\fI\%steverweber\fP) missing docs (refs: \fI\%#24429\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24429\fP: (\fI\%jacobhammons\fP) Salt cloud doc updates, build errors and bug fixes
@ \fI2015\-06\-05 00:27:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
5d738b8dab Merge pull request \fI\%#24429\fP from jacobhammons/cloud\-doc\-updates
.IP \(bu 2
1f7a13d6f9 Salt cloud doc updates, build errors and bug fixes Refs \fI\%#24309\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24408\fP: (\fI\%rallytime\fP) Backport \fI\%#24392\fP to 2015.5
@ \fI2015\-06\-04 20:22:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24392\fP: (\fI\%quixoten\fP) Fix \(dqNo such file or directory\(dq in grains/core.py (refs: \fI\%#24408\fP)
.IP \(bu 2
cdffc02cfe Merge pull request \fI\%#24408\fP from rallytime/bp\-24392
.IP \(bu 2
ff7461b3cd Use path found by salt.utils.which
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24380\fP: (\fI\%rallytime\fP) Backport \fI\%#24357\fP to 2015.5
@ \fI2015\-06\-04 20:13:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24357\fP: (\fI\%zhujinhe\fP) fix invoke issues of Jinja Macros example (refs: \fI\%#24380\fP)
.IP \(bu 2
a6a1f87cd9 Merge pull request \fI\%#24380\fP from rallytime/bp\-24357
.IP \(bu 2
f08c875015 fix invoke issues of Jinja Macros example
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24358\fP: (\fI\%pengyao\fP) Netapi SSH client don\(aqt support ssh_user and ssh_passwd arguments (refs: \fI\%#24388\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24388\fP: (\fI\%pengyao\fP) fixes \fI\%#24358\fP
@ \fI2015\-06\-04 20:07:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
86ce9dbbdf Merge pull request \fI\%#24388\fP from pengyao/sshclient\-kwargs
.IP \(bu 2
5c08ca48b4 fixes \fI\%#24358\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22958\fP: (\fI\%highlyunavailable\fP) Weird error when typoing a command (refs: \fI\%#24367\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24367\fP: (\fI\%terminalmage\fP) Improve error message when module does not exist
@ \fI2015\-06\-04 20:07:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
72d2eaeda9 Merge pull request \fI\%#24367\fP from terminalmage/issue22958
.IP \(bu 2
d0d7a5481c Improve error message when module does not exist
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23101\fP: (\fI\%gravyboat\fP) Create a docs page for labels (refs: \fI\%#23387\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24412\fP: (\fI\%jfindlay\fP) backport \fI\%#23387\fP
@ \fI2015\-06\-04 20:06:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23387\fP: (\fI\%rallytime\fP) Add some \(dqWhat are all these labels for?\(dq documentation (refs: \fI\%#24412\fP)
.IP \(bu 2
a628778e3c Merge pull request \fI\%#24412\fP from jfindlay/bp\-23387
.IP \(bu 2
bf85772042 Make sure the parameters are in the correct order
.IP \(bu 2
9f53809cde Add \(dq* Change\(dq label parameters
.IP \(bu 2
b27a15e774 Remove \(dqworkaround\(dq wording
.IP \(bu 2
9fff35a959 Some small fixes
.IP \(bu 2
54a7089fd6 Link the new labels doc in contributing and hacking docs
.IP \(bu 2
375695e696 Add pull request label definitions
.IP \(bu 2
de945638d3 Add Feature Request label definition
.IP \(bu 2
684f291bd4 Add issue definition and augment functional areas section
.IP \(bu 2
2da13dd525 Start a \(dqwhat are all of these labels for?\(dq doc
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24154\fP: (\fI\%ssgward\fP) Exception when running cp.get_url (refs: \fI\%#24336\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24336\fP: (\fI\%twangboy\fP) Added line to give more descriptive error
@ \fI2015\-06\-04 19:56:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
485116c2cc Merge pull request \fI\%#24336\fP from twangboy/fix_cp_get_url
.IP \(bu 2
37b11f931c Added line to give more descriptive error
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24413\fP: (\fI\%techhat\fP) Add more namespaced functions to GoGrid driver
@ \fI2015\-06\-04 19:51:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
b3d39cc0e8 Merge pull request \fI\%#24413\fP from techhat/gogridnamespace
.IP \(bu 2
1b397cb6fe Adding blank line
.IP \(bu 2
da08cc9aac Add more namespaced functions to GoGrid driver
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24397\fP: (\fI\%kiorky\fP) on debian: states.apt should use virtualname as it shadows system apt module (refs: \fI\%#24398\fP, \fI\%#24400\fP, \fI\%#24399\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24399\fP: (\fI\%kiorky\fP) Versionvirtual (refs: \fI\%#24398\fP)
@ \fI2015\-06\-04 18:02:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24398\fP: (\fI\%kiorky\fP) VirtualName for states.apt (refs: \fI\%#24399\fP)
.IP \(bu 2
27f109bd76 Merge pull request \fI\%#24399\fP from makinacorpus/versionvirtual
.IP \(bu 2
235c78ddfe Use apt_pkg.version_compare if available
.IP \(bu 2
1c0cd459f8 reindent block to isolate conflict on merge forward
.IP \(bu 2
699eceab64 use var to isolate conflict on merge forward
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24371\fP: (\fI\%joejulian\fP) 2015.5 tls module tests
@ \fI2015\-06\-04 15:20:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
deaee68b89 Merge pull request \fI\%#24371\fP from joejulian/2015.5_tls_module_tests
.IP \(bu 2
4c5dee1e25 Add @destructiveTest decorator to destructive tests
.IP \(bu 2
274bbd4d43 Accept results from older pyOpenSSL
.IP \(bu 2
161f913522 All cert info should be in UTC always
.IP \(bu 2
9affcca766 See the whole diff if dict compare fails
.IP \(bu 2
94f620857c Ignore extensions for now. Resolve this as part of fixing issue 24338.
.IP \(bu 2
84904d31f1 Mask lint warning for unused imported module
.IP \(bu 2
5675b78459 Do not test if PyOpenSSL is not installed
.IP \(bu 2
563cc66311 Add tls tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24403\fP: (\fI\%jayeshka\fP) adding states/process unit test case.
@ \fI2015\-06\-04 15:19:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
84686ee695 Merge pull request \fI\%#24403\fP from jayeshka/process_states\-unit\-test
.IP \(bu 2
fcb71fb35e adding states/process unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24402\fP: (\fI\%jayeshka\fP) adding states/pyenv unit test case.
@ \fI2015\-06\-04 15:18:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
35de8d72db Merge pull request \fI\%#24402\fP from jayeshka/pyenv_states\-unit\-test
.IP \(bu 2
5f263ab48b adding states/pyenc unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24401\fP: (\fI\%jayeshka\fP) adding states/powerpath unit test case.
@ \fI2015\-06\-04 15:17:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
632f838838 Merge pull request \fI\%#24401\fP from jayeshka/powerpath\-states\-unit\-test
.IP \(bu 2
49ff9272ce adding states/powerpath unit test case.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24397\fP: (\fI\%kiorky\fP) on debian: states.apt should use virtualname as it shadows system apt module (refs: \fI\%#24398\fP, \fI\%#24400\fP, \fI\%#24399\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24400\fP: (\fI\%kiorky\fP) Aptversion
@ \fI2015\-06\-04 15:17:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a6e5e0d96 Merge pull request \fI\%#24400\fP from makinacorpus/aptversion
.IP \(bu 2
e15cb936b5 Use apt_pkg.version_compare if available
.IP \(bu 2
953725a563 Fix too much quoting in apt.version_cmp
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24385\fP: (\fI\%jeanpralo\fP) Fix salt.modules.dockerio.start method
@ \fI2015\-06\-04 15:00:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
a904055d28 Merge pull request \fI\%#24385\fP from jeanpralo/Fix\-binds\-dockerio.start
.IP \(bu 2
a0fed313fa binds dict if not specified should remain to none otherwise docker\-py will try to create a new host config and all volume and ports binds are lost. config should be done at the creation of the container not when we start it
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24381\fP: (\fI\%justinta\fP) Disabled flaky test to review later
@ \fI2015\-06\-04 14:57:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
9890bc4e43 Merge pull request \fI\%#24381\fP from jtand/seed_test
.IP \(bu 2
7570ae9132 Disabled flaky test to review later
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23342\fP: (\fI\%philipsd6\fP) salt\-ssh 2015.2.0rc2 fails when target doesn\(aqt have lspci available (refs: \fI\%#24382\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24382\fP: (\fI\%basepi\fP) [2015.5] Handle CommandExecutionError in grains commands, Fixes \fI\%#23342\fP
@ \fI2015\-06\-04 12:44:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
b3fa8fefcb Merge pull request \fI\%#24382\fP from basepi/grainscommandnotfound23342
.IP \(bu 2
85b91d64cc Handle CommandExecutionError in grains commands
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24379\fP: (\fI\%Starblade42\fP) Fixes an issue where Pagerduty states/modules couldn\(aqt find their profile in the Pillar
@ \fI2015\-06\-04 12:41:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
52587a4fc1 Merge pull request \fI\%#24379\fP from Starblade42/2015.5
.IP \(bu 2
b93dc5ef6c Linting!
.IP \(bu 2
2dd5904119 Fixes an issue where Pagerduty states/modules couldn\(aqt find its profile in the Pillar
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24366\fP: (\fI\%terminalmage\fP) Use yes $\(aq\en\(aq instead of printf \(aq\en\(aq for pecl commands
@ \fI2015\-06\-03 21:28:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
3ca35d1ec3 Merge pull request \fI\%#24366\fP from terminalmage/pecl\-yes
.IP \(bu 2
dcd9ad8b6e Use yes $\(aqn\(aq instead of printf \(aqn\(aq for pecl commands
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24284\fP: (\fI\%kiorky\fP) systemd lxc containers need use_vt=True at lxc\-start stage (refs: \fI\%#24348\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#548\fP: (\fI\%Lanzaa\fP) Salt is now platform dependent. Use get_python_lib(1) (refs: \fI\%#24348\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24348\fP: (\fI\%kiorky\fP) Try to close input pipes before calling lxc\-start
@ \fI2015\-06\-03 19:38:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
86a3b317c6 Merge pull request \fI\%#24348\fP from makinacorpus/lxcpre
.IP \(bu 2
0cb11a2767 lxc: typo
.IP \(bu 2
d71efa6d66 Try to close input pipes before calling lxc\-start
.UNINDENT
.UNINDENT
.SS Salt 2015.5.4 Release Notes
.INDENT 0.0
.TP
.B release
2015\-08\-13
.UNINDENT
.sp
Version 2015.5.4 is a bugfix release for \fI\%2015.5.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB247\fP
.IP \(bu 2
Total Issue References: \fB138\fP
.IP \(bu 2
Total PR References: \fB312\fP
.IP \(bu 2
Contributors: \fB92\fP (\fI\%0xf10e\fP, \fI\%AkhterAli\fP, \fI\%BretFisher\fP, \fI\%DmitryKuzmenko\fP, \fI\%EvaSDK\fP,
\fI\%GideonRed\-zz\fP, \fI\%JohannesEbke\fP, \fI\%Oro\fP, \fI\%TheBigBear\fP, \fI\%TronPaul\fP, \fI\%UtahDave\fP, \fI\%ahus1\fP,
\fI\%alekti\fP, \fI\%alexandrsushko\fP, \fI\%amontalban\fP, \fI\%andre\-luiz\-dos\-santos\fP, \fI\%aneeshusa\fP, \fI\%anlutro\fP,
\fI\%asyncsrc\fP, \fI\%attiasr\fP, \fI\%babilen\fP, \fI\%basepi\fP, \fI\%bbinet\fP, \fI\%bclermont\fP, \fI\%bechtoldt\fP,
\fI\%blackduckx\fP, \fI\%bobrik\fP, \fI\%cachedout\fP, \fI\%colekowalski\fP, \fI\%cro\fP, \fI\%d\-\-j\fP, \fI\%davidjb\fP, \fI\%denmat\fP,
\fI\%derBroBro\fP, \fI\%dkiser\fP, \fI\%driskell\fP, \fI\%egarbi\fP, \fI\%fleaflicker\fP, \fI\%garethgreenaway\fP,
\fI\%gmcwhistler\fP, \fI\%gtmanfred\fP, \fI\%hasues\fP, \fI\%isbm\fP, \fI\%jacksontj\fP, \fI\%jacobhammons\fP, \fI\%jahamn\fP,
\fI\%jarpy\fP, \fI\%jasonkeene\fP, \fI\%jayeshka\fP, \fI\%jfindlay\fP, \fI\%jleroy\fP, \fI\%jmdcal\fP, \fI\%jodv\fP, \fI\%joejulian\fP,
\fI\%jquast\fP, \fI\%justinta\fP, \fI\%kev009\fP, \fI\%klyr\fP, \fI\%l2ol33rt\fP, \fI\%loa\fP, \fI\%lomeroe\fP, \fI\%martinhoefling\fP,
\fI\%mgwilliams\fP, \fI\%nicholascapo\fP, \fI\%niq000\fP, \fI\%nmadhok\fP, \fI\%nyushi\fP, \fI\%oeuftete\fP, \fI\%opdude\fP,
\fI\%pcdummy\fP, \fI\%pcn\fP, \fI\%peterdemin\fP, \fI\%puneetk\fP, \fI\%rallytime\fP, \fI\%rmatulat\fP, \fI\%s0undt3ch\fP,
\fI\%silenius\fP, \fI\%sjorge\fP, \fI\%stanislavb\fP, \fI\%steverweber\fP, \fI\%supertom\fP, \fI\%t0rrant\fP, \fI\%tankywoo\fP,
\fI\%techhat\fP, \fI\%terminalmage\fP, \fI\%thatch45\fP, \fI\%tony\-cocco\fP, \fI\%twangboy\fP, \fI\%uvsmtid\fP, \fI\%vr\-jack\fP,
\fI\%yanatan16\fP, \fI\%zyio\fP)
.UNINDENT
.SS Bug Fixes
.INDENT 0.0
.IP \(bu 2
The \fI\%cron.present\fP state now correctly
defaults to state ID as identifier.
.UNINDENT
.SS Salt\-Cloud Changes
.INDENT 0.0
.IP \(bu 2
When querying for VMs in the \fBdigital_ocean_v2\fP cloud driver, the number of
VMs to include in a page was changed from 20 (default) to 200 to reduce the
number of API calls to Digital Ocean.
.IP \(bu 2
The \fBvmware\fP salt\-cloud driver was back\-ported from the develop branch in
order for installations of Salt that are older than 2015.8.0 to be able to
use the \fBvmware\fP driver without stack\-tracing on various deprecation paths
that were implemented in the 2015.8.0 release.
.UNINDENT
.SS Changelog for v2015.5.3..v2015.5.4
.sp
\fIGenerated at: 2018\-05\-27 21:59:14 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#26292\fP: (\fI\%jquast\fP) Rabbitmq 3.2.4 on Ubuntu has \(dq...done.\(dq, not \(dq...done\(dq
@ \fI2015\-08\-13 19:53:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a5d1307c4 Merge pull request \fI\%#26292\fP from jquast/backport\-ubuntu\-rabbitmq\-fix
.IP \(bu 2
39ef653bc2 Rabbitmq 3.2.4 on Ubuntu has ...done. not ...done, change the if to be more portable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26296\fP: (\fI\%jquast\fP) bugfix missing \(aqrunas=None\(aq for rabbitmqctl cmds (backport to 2015.5)
@ \fI2015\-08\-13 19:52:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
21cc3c3bf6 Merge pull request \fI\%#26296\fP from jquast/bugfix\-runas\-rabbitmqctl\-2015.5
.IP \(bu 2
eb77320786 bugfix missing \(aqrunas=None\(aq for rabbitmqctl cmds
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25618\fP: (\fI\%twangboy\fP) Fix reg.py to work with the registry properly (refs: \fI\%#26268\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26293\fP: (\fI\%jfindlay\fP) Fix \fI\%#26268\fP
@ \fI2015\-08\-13 19:48:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26268\fP: (\fI\%twangboy\fP) Multiple improvements to reg executionmod and state mod (refs: \fI\%#26293\fP)
.IP \(bu 2
ee59d154d7 Merge pull request \fI\%#26293\fP from jfindlay/reggie
.IP \(bu 2
91ea964556 add versionadded to reg exec and state mods
.IP \(bu 2
3348b726c9 fix state/reg unit tests
.IP \(bu 2
3f74a389ce return test results when test=True
.IP \(bu 2
a1274c438d I might have fixed some tests... I might have made them worse
.IP \(bu 2
7393adf5a8 Fixed some lint
.IP \(bu 2
787c88a283 Multiple improvements to reg executionmod and state mod
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25192\fP: (\fI\%deuscapturus\fP) 2015.5.2 boto_cloudwatch_alarm.present not working. (refs: \fI\%#26290\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26290\fP: (\fI\%rallytime\fP) Only call convert_to_arn when action name is provided
@ \fI2015\-08\-13 18:48:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
5dd5ac1198 Merge pull request \fI\%#26290\fP from rallytime/fix\-25192
.IP \(bu 2
a1f90fa070 Only call convert_to_arn when action name is provided
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26288\fP: (\fI\%bbinet\fP) allow deleting grains which value is False
@ \fI2015\-08\-13 18:24:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
c81dc0b62f Merge pull request \fI\%#26288\fP from bbinet/grains\-absent\-fix
.IP \(bu 2
f46722aaeb allow deleting grains which value is False
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24882\fP: (\fI\%nmadhok\fP) salt.states.openstack_config.present and salt.states.openstack_config.absent make changes when test=True (refs: \fI\%#26263\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26263\fP: (\fI\%rallytime\fP) Don\(aqt make changes when test=True for openstack present/absent funcs
@ \fI2015\-08\-13 16:30:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
65ab5aa495 Merge pull request \fI\%#26263\fP from rallytime/fix\-24882
.IP \(bu 2
86b8161d22 Mock test key in __opts__ dict
.IP \(bu 2
298685bbb2 Don\(aqt make changes when test=True for openstack present/absent funcs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24484\fP: (\fI\%bailsman\fP) clouds/ec2.py: create_snapshot throws exception (refs: \fI\%#26265\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26265\fP: (\fI\%rallytime\fP) Don\(aqt stacktrace on query return in ec2.create_snapshot
@ \fI2015\-08\-13 16:28:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
3d1a9cfedd Merge pull request \fI\%#26265\fP from rallytime/fix\-24484
.IP \(bu 2
4975300591 Don\(aqt stacktrace on query return in ec2.create_snapshot
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26285\fP: (\fI\%stanislavb\fP) Remove explicit version from instance identity URL
@ \fI2015\-08\-13 16:25:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
5778cb3f01 Merge pull request \fI\%#26285\fP from stanislavb/2015.5
.IP \(bu 2
1f18f4f91e Remove explicit version from instance identity URL
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26275\fP: (\fI\%cachedout\fP) Re\-init modules on multi\-master reconnect
@ \fI2015\-08\-13 15:52:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
679dc089c0 Merge pull request \fI\%#26275\fP from cachedout/mm_reinit
.IP \(bu 2
1e0473c04a Re\-init modules on multi\-master reconnect
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26273\fP: (\fI\%garethgreenaway\fP) Fixes to schedule module in 2015.5
@ \fI2015\-08\-13 15:34:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
75fff28779 Merge pull request \fI\%#26273\fP from garethgreenaway/2015_5_schedule_list_show_jobs_enabled
.IP \(bu 2
1aad4b1b4f Jobs are enabled by default but schedule.list does not show an enabled jobs as being enabled by default.  This change fixes that.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24483\fP: (\fI\%bailsman\fP) clouds/ec2.py: del_root_vol_on_destroy and del_all_vols_on_destroy not working (refs: \fI\%#26271\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26271\fP: (\fI\%rallytime\fP) Fix del_root_vol_on_destroy and del_all_vols_on_destroy functionality on ec2
@ \fI2015\-08\-12 23:22:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
10af22775a Merge pull request \fI\%#26271\fP from rallytime/fix\-24483
.IP \(bu 2
139fbb93bc Fix del_root_vol_on_destroy and del_all_vols_on_destroy functionality on ec2
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25958\fP: (\fI\%anlutro\fP) Cron identifier does not default to state ID as documented (refs: \fI\%#26219\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26219\fP: (\fI\%anlutro\fP) cron: make identifier default to state ID
@ \fI2015\-08\-12 18:42:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
8e1b5da2e0 Merge pull request \fI\%#26219\fP from alprs/fix\-cron_identifier_default
.IP \(bu 2
1f02e1671b cron: fix a typo in the tests
.IP \(bu 2
a86b1b7f94 add release note about cron state changes
.IP \(bu 2
9511e392ce cron: read full length of multi\-line comments
.IP \(bu 2
9b18cd9050 cron: more descriptive tests, updated to reflect new behavior
.IP \(bu 2
f22ad837c3 cron: change identifier default value to False
.IP \(bu 2
ad444b6e7b cron identifier: default to state id
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26207\fP: (\fI\%fullermd\fP) group members setting fails with obscure error message on FreeBSD (refs: \fI\%#26237\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26257\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26237\fP to 2015.5
@ \fI2015\-08\-12 18:40:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26237\fP: (\fI\%silenius\fP) fix issue \fI\%#26207\fP (refs: \fI\%#26257\fP)
.IP \(bu 2
eebcade533 Merge pull request \fI\%#26257\fP from rallytime/bp\-26237
.IP \(bu 2
d57fdbc6a0 Add versionadded to new members function
.IP \(bu 2
dad1920626 fix issue \fI\%#26207\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26258\fP: (\fI\%nmadhok\fP) Fix permission on tests/runtests.py on 2015.5 branch
@ \fI2015\-08\-12 18:40:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
d7c8169dfb Merge pull request \fI\%#26258\fP from nmadhok/fix\-permission
.IP \(bu 2
d94485d336 Fix permission on tests/runtests.py on 2015.5 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26261\fP: (\fI\%nmadhok\fP) Correct spelling of integration in docs
@ \fI2015\-08\-12 18:14:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
74b70c37b7 Merge pull request \fI\%#26261\fP from nmadhok/doc\-fix\-2015.5
.IP \(bu 2
714f9766e7 Correct spelling of integration in docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26247\fP: (\fI\%nmadhok\fP) Initial commit of unit tests for vmware cloud driver
@ \fI2015\-08\-12 16:58:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
de00c181f8 Merge pull request \fI\%#26247\fP from nmadhok/vmware\-cloud\-test\-2015.5
.IP \(bu 2
6cc5f97e92 Lint Fix
.IP \(bu 2
a8bfe5ec1f Initial commit of unit tests for vmware cloud driver
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26246\fP: (\fI\%nmadhok\fP) Backport additions to VMware cloud driver from develop to 2015.5 branch
@ \fI2015\-08\-12 15:11:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
d14d7b2c0e Merge pull request \fI\%#26246\fP from nmadhok/vmware\-cloud\-driver\-additions\-2015.5
.IP \(bu 2
5227aa94bc Backport additions to VMware cloud driver from develop to 2015.5 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26239\fP: (\fI\%opdude\fP) Fixed documentation to match function name
@ \fI2015\-08\-12 14:48:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
87b300d7b3 Merge pull request \fI\%#26239\fP from Unity\-Technologies/2015.5
.IP \(bu 2
fc18751710 Fixed documentation to match function name
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26232\fP: (\fI\%garethgreenaway\fP) Fix to trust_key in gpg module for 2015.5.
@ \fI2015\-08\-12 04:48:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
a93b96c9ba Merge pull request \fI\%#26232\fP from garethgreenaway/2015_5_gpg_trust_key_fix
.IP \(bu 2
e174c41887 Fix to trust_key in gpg module for 2015.5.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25802\fP: (\fI\%jefftucker\fP) Running module \(dqnpm.list\(dq fails on Windows for masterless minion  (refs: \fI\%#26084\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26084\fP: (\fI\%twangboy\fP) Added python_shell=True, quoted user input
@ \fI2015\-08\-10 21:29:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
b57da552ff Merge pull request \fI\%#26084\fP from twangboy/fix_25802
.IP \(bu 2
4503ed5b34 Fixed but with multiple packages, was causing tests to fail
.IP \(bu 2
f05e3e72a3 Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into fix_25802
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26183\fP: (\fI\%cro\fP) Fix LDAP configuration issue.
@ \fI2015\-08\-10 19:09:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3814137a3 Merge pull request \fI\%#26183\fP from cro/anonldap2
.IP \(bu 2
aa5e9c80b5 Lint roller
.IP \(bu 2
79833e3f8a Cherry pick index.rst change.
.IP \(bu 2
99f2c27399 Documentation update for anonymous bind issue.
.IP \(bu 2
793eed7b96 Cherry pick master.py groups check
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26186\fP: (\fI\%jacobhammons\fP) regenerated man pages
@ \fI2015\-08\-10 19:07:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
3233ed4675 Merge pull request \fI\%#26186\fP from jacobhammons/man\-page\-updates
.IP \(bu 2
bf2dad913f regenerated man pages
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26182\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-08\-10 19:00:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
d48bcf7598 Merge pull request \fI\%#26182\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
32f5345d7d Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
abdf2935c4 Merge pull request \fI\%#26116\fP from corux/fix\-escape\-content
.INDENT 2.0
.IP \(bu 2
fd913ddc36 Append/prepend: search for full line with escaped content
.UNINDENT
.IP \(bu 2
106356d98d Merge pull request \fI\%#26088\fP from jacobhammons/master\-finger
.INDENT 2.0
.IP \(bu 2
133d5f7885 some small changes
.IP \(bu 2
d220c83f77 master_finger configuration docs switch a script to use \fI\%https://\fP instead of \fI\%http://\fP Refs \fI\%#25751\fP
.UNINDENT
.IP \(bu 2
4bd4bc41f2 Merge pull request \fI\%#26047\fP from jacobhammons/win\-downloads
.INDENT 2.0
.IP \(bu 2
7c162d181c Updated windows download links in the docs to \fI\%https://repo.saltstack.com\fP Refs \fI\%#25961\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25998\fP: (\fI\%driskell\fP) Event subsystem discarding required events during \-\-batch breaking it for slow running commands (refs: \fI\%#26000\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26000\fP: (\fI\%driskell\fP) Implement full event caching for subscribed tags
@ \fI2015\-08\-10 18:57:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
f39780f8ce Merge pull request \fI\%#26000\fP from driskell/fix_discarded_events
.IP \(bu 2
65acf975dd Implement full event caching for subscribed tags Require all multitasking contexts to subscribe to their events so one call to get_event for one tag does not discard events that should be saved for a subsequent call to get_event with another tag. Use blocking get_event in batching with very small timeout. Fixes \fI\%#25998\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26175\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26153\fP to 2015.5
@ \fI2015\-08\-10 18:22:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26153\fP: (\fI\%loa\fP) Fix dockerio state documentation typo (refs: \fI\%#26175\fP)
.IP \(bu 2
c01b4cf150 Merge pull request \fI\%#26175\fP from rallytime/bp\-26153
.IP \(bu 2
9a263067e9 Fix dockerio state documentation typo
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26024\fP: (\fI\%jpic\fP) lxc_conf_unset in cloud.profile is ignored (refs: \fI\%#26147\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26177\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26147\fP to 2015.5
@ \fI2015\-08\-10 18:22:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26147\fP: (\fI\%martinhoefling\fP) Fixes \fI\%#26024\fP (refs: \fI\%#26177\fP)
.IP \(bu 2
ca80f33bfd Merge pull request \fI\%#26177\fP from rallytime/bp\-26147
.IP \(bu 2
323c3ab53c Fixes \fI\%#26024\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21082\fP: (\fI\%clinta\fP) master_type failover does not failover on DNS errors (refs: \fI\%#25404\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26179\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25404\fP to 2015.5
@ \fI2015\-08\-10 18:21:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25404\fP: (\fI\%DmitryKuzmenko\fP) Fixed minion failover to next master on DNS errors. (refs: \fI\%#26179\fP)
.IP \(bu 2
1213b8d706 Merge pull request \fI\%#26179\fP from rallytime/bp\-25404
.IP \(bu 2
52ab9fc1fb Fixed minion failover to next master on DNS errors.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26112\fP: (\fI\%wt\fP) state.template fails with unclear error with template with only an include (refs: \fI\%#26180\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26180\fP: (\fI\%jfindlay\fP) fix processing of state.template
@ \fI2015\-08\-10 18:21:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
b319c5ec04 Merge pull request \fI\%#26180\fP from jfindlay/templ_env
.IP \(bu 2
5e46ea4441 check type of matches in render_state before iterating
.IP \(bu 2
c80299b918 insert saltenv to render_state args in state.template
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26162\fP: (\fI\%nmadhok\fP) VMware cloud driver create function failing with traceback on latest develop (refs: \fI\%#26172\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26172\fP: (\fI\%nmadhok\fP) [Backport] Make sure variable is a dictionary before popping something from it.
@ \fI2015\-08\-10 16:42:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
ef5a4a47f6 Merge pull request \fI\%#26172\fP from nmadhok/backport\-cloud\-fix\-26163\-2015.5
.IP \(bu 2
0f2b5f8ac8 Make sure variable is a dictionary before popping something from it.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26098\fP: (\fI\%rdinoff\fP) SALT.STATES.SLACK Doc update (refs: \fI\%#26168\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26168\fP: (\fI\%cachedout\fP) Fix slack docs
@ \fI2015\-08\-10 14:57:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
2545df052a Merge pull request \fI\%#26168\fP from cachedout/fix_slack_docs
.IP \(bu 2
f421a936dc Fix slack docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24106\fP: (\fI\%nvx\fP) fileclient.py#get_url ignores HTTP Auth again (2015.5 regression) (refs: \fI\%#26127\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26127\fP: (\fI\%garethgreenaway\fP) Fixes to salt.utils.http related to cp.get_file_str bug.
@ \fI2015\-08\-10 14:38:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
9e6b0d6165 Merge pull request \fI\%#26127\fP from garethgreenaway/2015_5_24106
.IP \(bu 2
66f640086a one more lint error
.IP \(bu 2
317a8ec75c Disabling pylint for W0633, auth should only ever be a sequence at this location.
.IP \(bu 2
08eaca4fe4 lint fixes.
.IP \(bu 2
7046b84ac8 Fixing a bug where cp.get_file_str would not work if using http(s) URLs with authentication.  The salt.utils.http library in 2015.5 defaults to using urllib instead of requests and there was no authentication support added.  This PR adds authentication support. \fI\%#24106\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26141\fP: (\fI\%nmadhok\fP) salt\-cloud VMware driver fails with error in parsing configuration file (refs: \fI\%#26140\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#25809\fP: (\fI\%o\-sleep\fP) vmware cloud module error message (refs: \fI\%#26140\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#25625\fP: (\fI\%steverweber\fP) cloud vmware driver does not provide mac_address unless vmware tools is running (refs: \fI\%#26137\fP, \fI\%#26140\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26140\fP: (\fI\%nmadhok\fP) VMware cloud driver fixes
@ \fI2015\-08\-10 13:15:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
3b65e1dd91 Merge pull request \fI\%#26140\fP from nmadhok/vmware\-cloud\-fixes
.IP \(bu 2
a1899b436c Correct provider name in profile example
.IP \(bu 2
1f21876d21 Lint fixes
.IP \(bu 2
0bd4fce9c1 Additional fixes to format_instance functions to display more information available
.IP \(bu 2
4ee1b777e9 Change double quotes to single quotes in add_host config example
.IP \(bu 2
e132f06a5c Change double quotes to single quotes in provider configuration example
.IP \(bu 2
ad9895de07 Display error in else condition if connection is unsuccessful and does not have msg attribute. Fixes \fI\%#25809\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25625\fP: (\fI\%steverweber\fP) cloud vmware driver does not provide mac_address unless vmware tools is running (refs: \fI\%#26137\fP, \fI\%#26140\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26137\fP: (\fI\%steverweber\fP) use device mac address if vmtools not active
@ \fI2015\-08\-09 03:05:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
474a250414 Merge pull request \fI\%#26137\fP from steverweber/vmware_macaddress_fix
.IP \(bu 2
2589e389f0 use device mac address if vmtools not active
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26119\fP: (\fI\%jodv\fP) Backport eauth bugfix to 2015.5
@ \fI2015\-08\-09 02:19:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
8a33797737 Merge pull request \fI\%#26119\fP from jodv/backport_eauth_bugfix
.IP \(bu 2
e1a7bb5e7b fix pylint error (unnecessary \(aqfinally\(aq clause may swallow exceptions unintentionally)
.IP \(bu 2
5b5b4d8fe9 Fix issue with mixed user and group eauth perms
.IP \(bu 2
0d2c6a67a5 Return all relevant perms on login
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26135\fP: (\fI\%cro\fP) Fix proxy minions in 2015.5 and significantly update documentation.
@ \fI2015\-08\-09 02:19:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
2b8dcce0ca Merge pull request \fI\%#26135\fP from cro/pm20155_2
.IP \(bu 2
28329fff55 These tests make no sense now that the proxy interface is module based and not object based.
.IP \(bu 2
b17b65d4de Fix lint.
.IP \(bu 2
f4263c8f17 Fix lint.
.IP \(bu 2
6927251c09 Fix lint.
.IP \(bu 2
08f1a43ff0 Fix lint.
.IP \(bu 2
8261158b5a Fix lint.
.IP \(bu 2
b5e643b9cd Whoops...Don\(aqt log the entire proxy dictionary\-\-might have sensitive stuff in it.
.IP \(bu 2
2acf3c5aa3 Remove some debugging statements, change some others to \(aqinfo\(aq level.
.IP \(bu 2
37de6af686 More proxy minion updates
.IP \(bu 2
e79a182108 More proxy minion updates
.IP \(bu 2
3b746ac2f6 Update to reflect refactor to LazyLoader
.IP \(bu 2
5d390d3a5f Updates post meeting with Rick
.IP \(bu 2
d1213ce4a0 Updates post meeting with Rick
.IP \(bu 2
dd0b7c6937 Fix proxyobject confusion, now called proxymodule
.IP \(bu 2
9b1599d436 Update to reflect refactor to LazyLoader
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26132\fP: (\fI\%TheBigBear\fP) minor edit
@ \fI2015\-08\-08 21:05:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
2705b4a36a Merge pull request \fI\%#26132\fP from TheBigBear/patch\-5
.IP \(bu 2
1d624d77bc minor edit
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25915\fP: (\fI\%ari\fP) FreeBSD pkg install fails (refs: \fI\%#26133\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26133\fP: (\fI\%amontalban\fP) Fixed \fI\%#25915\fP in salt/modules/pkgng.py and salt/states/pkg.py
@ \fI2015\-08\-08 21:05:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
3eac28f0f9 Merge pull request \fI\%#26133\fP from amontalban/fix\-bug\-25915
.IP \(bu 2
6b0f4fca05 Fixed \fI\%#25915\fP in salt/modules/pkgng.py and salt/states/pkg.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26111\fP: (\fI\%anlutro\fP) Better error messages when virtualenv creation fails
@ \fI2015\-08\-07 21:42:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
19c42b8b3a Merge pull request \fI\%#26111\fP from alprs/fix\-virtualenv_fail_message
.IP \(bu 2
b2913acc48 virtualenv: better error messages when creation fails
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26093\fP: (\fI\%freedba\fP) archive.tar bug (refs: \fI\%#26110\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26110\fP: (\fI\%jfindlay\fP) check for sources before adding them to cmd str
@ \fI2015\-08\-07 21:33:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
6d2835b464 Merge pull request \fI\%#26110\fP from jfindlay/tar_sources
.IP \(bu 2
1b2f8905eb check for sources before adding them to cmd str
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26106\fP: (\fI\%vr\-jack\fP) Update __init__.py
@ \fI2015\-08\-07 21:15:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d271b3612 Merge pull request \fI\%#26106\fP from vr\-jack/2015.5
.IP \(bu 2
5664de6610 Update __init__.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25983\fP: (\fI\%jmdcal\fP) Trying to get md5 of local zip (refs: \fI\%#25984\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26101\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25984\fP to 2015.5
@ \fI2015\-08\-07 18:56:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25984\fP: (\fI\%jmdcal\fP) Support local files without md5sum (refs: \fI\%#26101\fP)
.IP \(bu 2
40d41741c1 Merge pull request \fI\%#26101\fP from rallytime/bp\-25984
.IP \(bu 2
3d279c0713 Pylint Fix
.IP \(bu 2
cced16a9f4 Support local files without md5sum
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26080\fP: (\fI\%techhat\fP) Fix string checking in s3fs
@ \fI2015\-08\-06 23:36:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
0d3c2d549e Merge pull request \fI\%#26080\fP from techhat/fixlower
.IP \(bu 2
8717a36963 Fix string checking in s3fs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26039\fP: (\fI\%basepi\fP) Update scheduler docs to use orchestrate instead of overstate (refs: \fI\%#26079\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26079\fP: (\fI\%cachedout\fP) Update docs to remove state.over
@ \fI2015\-08\-06 23:35:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
dc9c9b5a34 Merge pull request \fI\%#26079\fP from cachedout/issue_26039
.IP \(bu 2
f03f460af2 Update docs to remove state.over
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
89d8faaeb1 Added python_shell=True, quoted user input
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26058\fP: (\fI\%opdude\fP) Fix choco version on chocolatey versions below 0.9.9
@ \fI2015\-08\-06 18:50:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
aa023f25b8 Merge pull request \fI\%#26058\fP from Unity\-Technologies/hotfix/fix\-choco\-pkg\-version\-2015\-5
.IP \(bu 2
beddb96b2b Fix choco version on chocolatey versions below 0.9.9
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26068\fP: (\fI\%jfindlay\fP) fix autoruns.list looking in wrong directory
@ \fI2015\-08\-06 18:49:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
fbe2584abe Merge pull request \fI\%#26068\fP from jfindlay/auto_fix
.IP \(bu 2
1e9a850e23 fix autoruns.list looking in wrong directory
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#640\fP: (\fI\%Deshke\fP) salt\-minion install bug on ubuntu 14.04 tornado>=4.0 (refs: \fI\%#26065\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#633\fP: (\fI\%neilmb\fP) Bootstrap install fails on python\-requests dependency (refs: \fI\%#26065\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#632\fP: (\fI\%JulianGindi\fP) python\-requests : Depends: python\-urllib3 (>= 1.7.1) but it is not installable (refs: \fI\%#26065\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#631\fP: (\fI\%DavidJFelix\fP) Stable broken in 15.04 even with \-P (refs: \fI\%#26065\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#636\fP: (\fI\%pille\fP)  restict access to salt:// filesystem (refs: #\(gasaltstack/salt\-bootstrap#638\(ga_)
.IP \(bu 2
\fBISSUE\fP \fI\%#613\fP: (\fI\%thatch45\fP) Add timeout option to publish.publish (refs: #\(gasaltstack/salt\-bootstrap#634\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#638\fP: (\fI\%stanislavb\fP) Use prefix /usr for centos git install (refs: \fI\%#26065\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#634\fP: (\fI\%BretFisher\fP) bugfix: exit git root before removing it (refs: \fI\%#26065\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26065\fP: (\fI\%s0undt3ch\fP) [2015.5] Update to latest bootstrap stable release v2015.06.08
@ \fI2015\-08\-06 17:09:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
5570408597 Merge pull request \fI\%#26065\fP from s0undt3ch/hotfix/bootstrap\-script\-2015.5
.IP \(bu 2
a430a62b01 Update to latest bootstrap stable release v2015.06.08
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25994\fP: (\fI\%gmcwhistler\fP) module.ilo tempfile creation in __execute_cmd results in TypeError: cannot concatenate \(aqstr\(aq and \(aqint\(aq objects (refs: \fI\%#26061\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26061\fP: (\fI\%gmcwhistler\fP) Patch for issue \fI\%#25994\fP
@ \fI2015\-08\-06 17:07:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
83a1922196 Merge pull request \fI\%#26061\fP from gmcwhistler/2015.5
.IP \(bu 2
b9e89d0f2d Patch for issue \fI\%#25994\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26063\fP: (\fI\%saltstack\-bot\fP) not working with salt\-cloud shows unknown locale error (refs: \fI\%#26064\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26064\fP: (\fI\%s0undt3ch\fP) Don\(aqt stacktrace when trying to get the default locale.
@ \fI2015\-08\-06 16:11:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
073fb2bdea Merge pull request \fI\%#26064\fP from s0undt3ch/issues/26063\-unknown\-locale
.IP \(bu 2
8c6ab78b1d Don\(aqt stacktrace when trying to get the default locale.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26048\fP: (\fI\%jacobhammons\fP) Updated windows download links in the docs to \fI\%https://repo.saltstack.com\fP
@ \fI2015\-08\-05 22:59:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
0f44761d6e Merge pull request \fI\%#26048\fP from jacobhammons/win\-downloads2
.IP \(bu 2
75243b61cf Updated windows download links in the docs to \fI\%https://repo.saltstack.com\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25616\fP: (\fI\%rallytime\fP) [2015.5] Provisioning Linodes Stacktraces (refs: \fI\%#26044\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26044\fP: (\fI\%rallytime\fP) Make sure the key we\(aqre comparing is also lowercase
@ \fI2015\-08\-05 19:23:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
dedcadc37e Merge pull request \fI\%#26044\fP from rallytime/fix\-25616
.IP \(bu 2
c2e3803810 Make sure the key we\(aqre comparing is also lowercase
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26042\fP: (\fI\%jfindlay\fP) fix test mode logic in state docs
@ \fI2015\-08\-05 19:23:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
f005bdfce6 Merge pull request \fI\%#26042\fP from jfindlay/result
.IP \(bu 2
a83059ca01 fix test mode logic in state docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24460\fP: (\fI\%nicholascapo\fP) Survey runner does not follow \fI\-\-out\fP flag (refs: \fI\%#26036\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26036\fP: (\fI\%nicholascapo\fP) survey.hash: Remove manually printed text
@ \fI2015\-08\-05 19:21:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
51ab6864b7 Merge pull request \fI\%#26036\fP from nicholascapo/survey.hash_follow_out_flag
.IP \(bu 2
439ee9831c survey.hash: Remove manually printed text
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26030\fP: (\fI\%opdude\fP) Fix a bug in choco version that returned odd data
@ \fI2015\-08\-05 16:30:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a4d18eba6 Merge pull request \fI\%#26030\fP from Unity\-Technologies/hotfix/fix\-choco\-pkg\-version\-2015\-5
.IP \(bu 2
3dd96c0638 Fix a bug in choco version that returned odd data
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26032\fP: (\fI\%jfindlay\fP) add test logic to state reult doc
@ \fI2015\-08\-05 16:28:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
c96d3bb55e Merge pull request \fI\%#26032\fP from jfindlay/result
.IP \(bu 2
0fd180e106 add test logic to state reult doc
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23764\fP: (\fI\%es1o\fP) source_hash from local file is not supported. (refs: \fI\%#26031\fP, \fI\%#25750\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26031\fP: (\fI\%alekti\fP) Revert \(dqAdd file as supported protocol for file source_hash. Fixes \fI\%#23764\fP\(dq
@ \fI2015\-08\-05 15:32:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd14d85636 Merge pull request \fI\%#26031\fP from alekti/merge\-pull\-25750\-to\-2015.5
.IP \(bu 2
5a7cab4dcc Revert \(dqAdd file as supported protocol for file source_hash. Fixes \fI\%#23764\fP\&.\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26021\fP: (\fI\%anlutro\fP) Documentation: Specify versionadded for git.present shared argument
@ \fI2015\-08\-05 14:17:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
d55e6e5fe9 Merge pull request \fI\%#26021\fP from alprs/docs\-git_present_shared_versionadded
.IP \(bu 2
8fa678aaa7 specify versionadded for git.present shared argument
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25701\fP: (\fI\%alekti\fP) Issue \fI\%#23764\fP regression (refs: \fI\%#25750\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23764\fP: (\fI\%es1o\fP) source_hash from local file is not supported. (refs: \fI\%#26031\fP, \fI\%#25750\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26020\fP: (\fI\%alekti\fP) Correctly resolve conflict merging pull 25750 to 2015.5
@ \fI2015\-08\-05 14:16:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25750\fP: (\fI\%alekti\fP) Add file as supported protocol for file source_hash. Fixes \fI\%#25701\fP\&. (refs: \fI\%#26020\fP)
.IP \(bu 2
5e17c5d230 Merge pull request \fI\%#26020\fP from alekti/merge\-pull\-25750\-to\-2015.5
.IP \(bu 2
4b9d7426cc Add file as supported protocol for file source_hash. Fixes \fI\%#23764\fP\&.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22241\fP: (\fI\%masterkorp\fP) Salt master not properly generating the map (refs: \fI\%#25358\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26016\fP: (\fI\%basepi\fP) Revert \(dqDeep merge of pillar lists\(dq
@ \fI2015\-08\-05 04:59:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25358\fP: (\fI\%dkiser\fP) Deep merge of pillar lists (refs: \fI\%#26016\fP)
.IP \(bu 2
53f7aadcd7 Merge pull request \fI\%#26016\fP from basepi/revert.25358
.IP \(bu 2
8a0e8e0460 Revert \(dqDeep merge of pillar lists\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#12255\fP: (\fI\%eliasp\fP) \(aqsystem.set_computer_desc\(aq fails with non\-ASCII chars (refs: \fI\%#25992\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25992\fP: (\fI\%twangboy\fP) Refactor win_system.py
@ \fI2015\-08\-05 04:54:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
200bff7538 Merge pull request \fI\%#25992\fP from twangboy/fix_12255
.IP \(bu 2
0502897635 Fixed the lint... again
.IP \(bu 2
6f85d6b9af Fixed some lint
.IP \(bu 2
4195803e56 Merge pull request \fI\%#3\fP from jfindlay/win_sys
.INDENT 2.0
.IP \(bu 2
9156bbd33e update win_system exec mod unit tests
.UNINDENT
.IP \(bu 2
c92add95b5 Gated ctypes import, fixed some lint
.IP \(bu 2
d7670fda0a Refactor win_service.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25948\fP: (\fI\%twangboy\fP) Fix uncomment function to handle spaces (refs: \fI\%#26002\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26002\fP: (\fI\%twangboy\fP) Fixed regex to account for comment character followed by whitespace
@ \fI2015\-08\-04 22:28:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
c168159750 Merge pull request \fI\%#26002\fP from twangboy/fix_25948
.IP \(bu 2
ba1a57e582 Fixed regex to account for comment character followed by whitespace
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25949\fP: (\fI\%godlike64\fP) layman.add does not work with unofficial overlays (refs: \fI\%#25970\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25970\fP: (\fI\%jfindlay\fP) accept addition of layman overlay
@ \fI2015\-08\-04 15:42:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ad2422da1 Merge pull request \fI\%#25970\fP from jfindlay/layman
.IP \(bu 2
237a9e18b3 accept addition of layman overlay
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25971\fP: (\fI\%basepi\fP) [2015.5] salt.modules.reg Add spaces for strings split across multiple lines
@ \fI2015\-08\-04 15:39:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
f136c6c1c0 Merge pull request \fI\%#25971\fP from basepi/reg.typos
.IP \(bu 2
bb001a6c0e Add spaces for strings split across multiple lines
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25990\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25976\fP to 2015.5
@ \fI2015\-08\-04 14:36:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25976\fP: (\fI\%fleaflicker\fP) Typo in help output (refs: \fI\%#25990\fP)
.IP \(bu 2
6383dd8a7d Merge pull request \fI\%#25990\fP from rallytime/bp\-25976
.IP \(bu 2
5f6dc0cc85 Typo in help output
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25996\fP: (\fI\%attiasr\fP) fix msiexec package remove
@ \fI2015\-08\-04 14:36:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
9f8bf75dc0 Merge pull request \fI\%#25996\fP from attiasr/patch\-1
.IP \(bu 2
5fbc5fcd94 fix msiexec package remove
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25863\fP: (\fI\%peterdemin\fP) pkg.installed fails on already installed package if it is in versionlock.list (refs: \fI\%#25864\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25966\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25864\fP to 2015.5
@ \fI2015\-08\-03 18:48:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25864\fP: (\fI\%peterdemin\fP) \fI\%#25863\fP state.pkg.installed fix (refs: \fI\%#25966\fP)
.IP \(bu 2
2dca8d959b Merge pull request \fI\%#25966\fP from rallytime/bp\-25864
.IP \(bu 2
0f7f9637b4 \fI\%#25863\fP fix \- state.pkg: do preflight check only for non\-installed packages
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25967\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25917\fP to 2015.5
@ \fI2015\-08\-03 18:48:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25917\fP: (\fI\%jmdcal\fP) adding missing format string (refs: \fI\%#25967\fP)
.IP \(bu 2
a6d8e541ed Merge pull request \fI\%#25967\fP from rallytime/bp\-25917
.IP \(bu 2
82b7e14a1f adding missing format string
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25895\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-08\-03 17:12:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
87d028b302 Merge pull request \fI\%#25895\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
56e43c8f88 Fix lint
.IP \(bu 2
93a182d9ea Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.INDENT 2.0
.IP \(bu 2
d93eb87c16 Merge pull request \fI\%#25750\fP from alekti/2014.7
.INDENT 2.0
.IP \(bu 2
9ec3ae96d4 Add file as supported protocol for file source_hash. Fixes \fI\%#23764\fP\&.
.UNINDENT
.IP \(bu 2
3a15df22ac Merge pull request \fI\%#25704\fP from cachedout/master_type_2014_7
.INDENT 2.0
.IP \(bu 2
c95886c9a7 Ensure prior alignment with master_type in 2014.7
.UNINDENT
.IP \(bu 2
d1b9362a73 Merge pull request \fI\%#25657\fP from MrCitron/pattern\-carbon\-returner\-2014.7
.INDENT 2.0
.IP \(bu 2
f8b2f8079f Add the ability to specify a base pattern for metrics path used by the carbon returner
.UNINDENT
.IP \(bu 2
9634351fc2 Merge pull request \fI\%#25633\fP from AkhterAli/2014.7
.INDENT 2.0
.IP \(bu 2
29be4bbe11 Update loader.py
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25850\fP: (\fI\%ssgward\fP) Need to add packages to \-\-versions\-report (refs: \fI\%#25941\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25941\fP: (\fI\%jfindlay\fP) add timelib to dependency versions
@ \fI2015\-08\-03 12:23:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
98955057e0 Merge pull request \fI\%#25941\fP from jfindlay/time_lib
.IP \(bu 2
464f7a404c add timelib to dependency versions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25951\fP: (\fI\%garethgreenaway\fP) Log when event.fire and event.fire_master fail.
@ \fI2015\-08\-03 00:19:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
dcc6883b24 Merge pull request \fI\%#25951\fP from garethgreenaway/event_fire_failed_log_why
.IP \(bu 2
7f20454427 If we\(aqre unable to fire an event, log the cause so we know what happened
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25838\fP: (\fI\%grep4linux\fP) docs disable_modules documentation typo (refs: \fI\%#25942\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25942\fP: (\fI\%jfindlay\fP) typo in minion doc
@ \fI2015\-07\-31 23:34:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
4143cec3bf Merge pull request \fI\%#25942\fP from saltstack/lover
.IP \(bu 2
7e121de907 Update minion.rst
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25938\fP: (\fI\%jacobhammons\fP) Doc on using syndic with multimaster
@ \fI2015\-07\-31 23:05:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#14690\fP: (\fI\%jacksontj\fP) Multi syndic (refs: \fI\%#25938\fP)
.IP \(bu 2
1f20c065b8 Merge pull request \fI\%#25938\fP from jacobhammons/syndic\-multimaster
.IP \(bu 2
ac0a8ff711 Doc on using syndic with multimaster
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25839\fP: (\fI\%twangboy\fP) ALLUSERS=\(dq1\(dq should be a default when installing MSI\(aqs (refs: \fI\%#25848\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25848\fP: (\fI\%twangboy\fP) Added allusers=\(dq1\(dq when installing msi
@ \fI2015\-07\-31 20:33:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
18a9e65e1f Merge pull request \fI\%#25848\fP from twangboy/fix_25839
.IP \(bu 2
e797739a1b Removed normalize_name function
.IP \(bu 2
ad7fdda68b Adder allusers=\(dq1\(dq when installing msi
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25898\fP: (\fI\%jfindlay\fP) clarify and expand syndic docs
@ \fI2015\-07\-31 20:01:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
de0a0593c2 Merge pull request \fI\%#25898\fP from jfindlay/syndic_doc
.IP \(bu 2
4795952847 rework syndic doc
.IP \(bu 2
a25d0eabef update syndic doc to conform to style
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25852\fP: (\fI\%UtahDave\fP) Salt loader is not loading Salt vars in reactor python renderer (refs: \fI\%#25927\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25927\fP: (\fI\%jacksontj\fP) Pass actual renderers to the Reactor\(aqs Compiler
@ \fI2015\-07\-31 20:00:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
d1f3da548a Merge pull request \fI\%#25927\fP from jacksontj/2015.5
.IP \(bu 2
cf7479aa0a Pass actual renderers to the Reactor\(aqs Compiler
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25810\fP: (\fI\%nvx\fP) winpkg highstate fails when a new package name contains a unicide character (refs: \fI\%#25921\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25921\fP: (\fI\%cachedout\fP) Handle non\-ascii in state log
@ \fI2015\-07\-31 17:41:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
331fc121a8 Merge pull request \fI\%#25921\fP from cachedout/issue_25810
.IP \(bu 2
8074c545ea Handle non\-ascii in state log
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25919\fP: (\fI\%TheBigBear\fP) Minor update to msi un\-installer info
@ \fI2015\-07\-31 17:39:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
20fb8da8d4 Merge pull request \fI\%#25919\fP from TheBigBear/patch\-4
.IP \(bu 2
c994d22696 Minor update to msi un\-installer info
.IP \(bu 2
\fBPR\fP \fI\%#25982\fP: (\fI\%sjorge\fP) salt.modules.smartos_* limit to global zone only (refs: \fI\%#25905\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25905\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25982\fP to 2015.5
@ \fI2015\-07\-30 23:24:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25892\fP: (\fI\%TheBigBear\fP) Update 7\-zip msi un\-installer instructions (refs: \fI\%#25905\fP)
.IP \(bu 2
9a569da4ee Merge pull request \fI\%#25905\fP from rallytime/bp\-25892
.IP \(bu 2
333fbdde30 Update 7\-zip msi un\-installer instructions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25577\fP: (\fI\%yellow1912\fP) Wrong indentation in document (refs: \fI\%#25696\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25890\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25698\fP to 2015.5
@ \fI2015\-07\-30 23:12:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25698\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25659\fP to 2015.8 (refs: \fI\%#25890\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25696\fP: (\fI\%AkhterAli\fP) Update schedule.py
.IP \(bu 2
\fBPR\fP \fI\%#25659\fP: (\fI\%isbm\fP) Bugfix: crash at getting non\-existing repo (refs: \fI\%#25698\fP)
.IP \(bu 2
6a738c5c41 Merge pull request \fI\%#25890\fP from rallytime/bp\-25696
.IP \(bu 2
7d68e49d98 Update schedule.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25650\fP: (\fI\%jacksontj\fP) state.running documentation is incorrect (refs: \fI\%#25894\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24042\fP: (\fI\%whiteinge\fP) The state_events setting is not documented (refs: \fI\%#25894\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23788\fP: (\fI\%k5jj\fP) functions in drac.py module do not match documentation (refs: \fI\%#25894\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#21296\fP: (\fI\%Lothiraldan\fP) Possible minion enumeration using saltutil.find_job and eauth (refs: \fI\%#25894\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25894\fP: (\fI\%jacobhammons\fP) Minor doc bug fixes
@ \fI2015\-07\-30 23:02:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
8abb21e206 Merge pull request \fI\%#25894\fP from jacobhammons/bug\-fixes
.IP \(bu 2
3f3db4bd8e Additions for \fI\%#24042\fP
.IP \(bu 2
db2129b199 Minor doc bug fixes Refs \fI\%#24042\fP Refs \fI\%#25650\fP Refs \fI\%#21296\fP Refs \fI\%#23788\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24036\fP: (\fI\%arthurlogilab\fP) [salt\-cloud] Protect against passing command line arguments as names for the \-\-destroy command in map files (refs: \fI\%#25877\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25877\fP: (\fI\%rallytime\fP) Protect against passing a map file in addition to VM names with \-\-destroy
@ \fI2015\-07\-30 21:55:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
59e1680182 Merge pull request \fI\%#25877\fP from rallytime/fix\-24036
.IP \(bu 2
0211972fd7 Whitespace fix
.IP \(bu 2
c6715e0404 Protect against passing a map file in addition to VM names with \-\-destroy
.IP \(bu 2
3aa5045138 Clean up stacktrace when referenced map file doesn\(aqt exist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25870\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25824\fP to 2015.5
@ \fI2015\-07\-30 21:54:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25824\fP: (\fI\%klyr\fP) Fix get_managed() in file.py module for local files (refs: \fI\%#25870\fP)
.IP \(bu 2
c4c9e40be6 Merge pull request \fI\%#25870\fP from rallytime/bp\-25824
.IP \(bu 2
1fd4837beb Fix get_managed() in file.py module for local files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25885\fP: (\fI\%t0rrant\fP) Update Debian changelog
@ \fI2015\-07\-30 20:05:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
af2326af68 Merge pull request \fI\%#25885\fP from t0rrant/patch\-3
.IP \(bu 2
3f73900c61 Update Debian changelog
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25478\fP: (\fI\%zyio\fP) salt\-ssh \- Unable to locate current thin version (refs: \fI\%#25862\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#25026\fP: (\fI\%sylvia\-wang\fP) salt\-ssh \(dqFailure deploying thin\(dq when using salt module functions (refs: \fI\%#25862\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25875\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25862\fP to 2015.5
@ \fI2015\-07\-30 17:34:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25862\fP: (\fI\%zyio\fP) Adding SCP_NOT_FOUND exit code (refs: \fI\%#25875\fP)
.IP \(bu 2
6ce0b3e5b8 Merge pull request \fI\%#25875\fP from rallytime/bp\-25862
.IP \(bu 2
d7f448d501 Needed popen.wait().
.IP \(bu 2
25f8042e41 Checking for scp existence. Using command \-v should be POSIX
.IP \(bu 2
6b2100a30b New exitcode for SCP not found Re: \fI\%https://github.com/saltstack/salt/issues/25478\fP and \fI\%https://github.com/saltstack/salt/issues/25026\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25873\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25855\fP to 2015.5
@ \fI2015\-07\-30 17:33:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25855\fP: (\fI\%puneetk\fP) Patch 3 (refs: \fI\%#25873\fP)
.IP \(bu 2
66dcc5525e Merge pull request \fI\%#25873\fP from rallytime/bp\-25855
.IP \(bu 2
f1f7ce25b7 Update saltmod.py
.IP \(bu 2
23a6806008 Update saltmod.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25871\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25829\fP to 2015.5
@ \fI2015\-07\-30 17:33:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25829\fP: (\fI\%peterdemin\fP) Fixed typo in salt.states.saltmod.function doc string (refs: \fI\%#25871\fP)
.IP \(bu 2
bf8bd38da7 Merge pull request \fI\%#25871\fP from rallytime/bp\-25829
.IP \(bu 2
a80c47ee10 Fixed typo in salt.states.saltmod.function doc string
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24002\fP: (\fI\%csakoda\fP) File lock contention on windows minions causing highstate crash (refs: \fI\%#25788\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25869\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25788\fP to 2015.5
@ \fI2015\-07\-30 17:33:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25788\fP: (\fI\%opdude\fP) Catch a hard crash when running highstate on windows (refs: \fI\%#25869\fP)
.IP \(bu 2
f26310ff0b Merge pull request \fI\%#25869\fP from rallytime/bp\-25788
.IP \(bu 2
65b18e3b34 Catch a hard crash when running highstate on windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19532\fP: (\fI\%stolendog\fP) salt\-ssh running git clone with not root user (refs: \fI\%#25853\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25853\fP: (\fI\%davidjb\fP) Make ssh\-id\-wrapper accessible to non\-root users
@ \fI2015\-07\-30 16:49:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
810fbb8bfb Merge pull request \fI\%#25853\fP from davidjb/ssh\-id\-wrapper\-non\-root
.IP \(bu 2
6492bde192 Make ssh\-id\-wrapper accessible to non\-root users
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25447\fP: (\fI\%spo0nman\fP) SaltMaster is crippled with Minion Re\-Authentication  (refs: \fI\%#25856\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25856\fP: (\fI\%jfindlay\fP) expand minion reauth scalability documentation
@ \fI2015\-07\-30 15:33:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
b6805b068a Merge pull request \fI\%#25856\fP from jfindlay/intro_scale
.IP \(bu 2
5921461bb1 style and usage consistency in intro_scale
.IP \(bu 2
51dc7cacfb whitespace adjustments in intro_scale
.IP \(bu 2
39a82467f1 expand minion reauth scalability documentation
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25801\fP: (\fI\%themalkolm\fP) Update docs that salt.states.winrepo requires \fIroles:salt\-master\fP in grains. (refs: \fI\%#25840\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25840\fP: (\fI\%jfindlay\fP) add note to winrepo state docs about required grain
@ \fI2015\-07\-30 14:38:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
423d528b73 Merge pull request \fI\%#25840\fP from jfindlay/winrepo_master
.IP \(bu 2
b6cfd54f3b add note to winrepo state docs about required grain
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25827\fP: (\fI\%0xf10e\fP) \(dqDeprecating Code\(dq doesn\(aqt mention Usage of warn_until() w/ Release Names (refs: \fI\%#25846\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25846\fP: (\fI\%jfindlay\fP) rework deprecation documentation for release names
@ \fI2015\-07\-30 13:26:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
754c8be719 Merge pull request \fI\%#25846\fP from jfindlay/depr_code
.IP \(bu 2
d377f42c48 rework deprecation documentation for release names
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23288\fP: (\fI\%UtahDave\fP) cp.push fails to recreate empty files. (refs: \fI\%#25833\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25833\fP: (\fI\%jahamn\fP) Allows cp.push to recreate empty files
@ \fI2015\-07\-29 16:14:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
d9ab4bb989 Merge pull request \fI\%#25833\fP from jahamn/fix\-cp.push\-not\-recreating\-empty\-files
.IP \(bu 2
eac19fbf33 Allows cp.push to recreate empty files
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#11474\fP: (\fI\%JensRantil\fP) pkgrepo.managed key_url: salt:// always use \fIbase\fP env (refs: \fI\%#25831\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25831\fP: (\fI\%rallytime\fP) Add salt:// to key_url options to docs for pkgrepo.managed
@ \fI2015\-07\-29 15:38:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
6f93d64784 Merge pull request \fI\%#25831\fP from rallytime/fix\-11474
.IP \(bu 2
067ea788e9 Add salt:// to key_url options to docs for pkgrepo.managed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22699\fP: (\fI\%arthurlogilab\fP) salt\-cloud fails on KeyError when given a nonexistent action (refs: \fI\%#25807\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25807\fP: (\fI\%rallytime\fP) Provide helpful error when using actions with a mapfile
@ \fI2015\-07\-29 15:30:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
72b3633383 Merge pull request \fI\%#25807\fP from rallytime/fix\-22699
.IP \(bu 2
3f3005c746 Use handle_exception function in cloud cli.py
.IP \(bu 2
f91edf3a33 Provide helpful error when using actions with a mapfile
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25818\fP: (\fI\%jfindlay\fP) fix autoruns list
@ \fI2015\-07\-29 15:29:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
71497adc0d Merge pull request \fI\%#25818\fP from jfindlay/autoruns_users
.IP \(bu 2
c2dbb65982 fix autoruns list for modern windowsen
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25826\fP: (\fI\%anlutro\fP) Check that \(dqonchanges\(dq is a list
@ \fI2015\-07\-29 15:00:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
98b324c5f8 Merge pull request \fI\%#25826\fP from alprs/fix\-onchanges_type_check
.IP \(bu 2
7992a3f0f4 state.py: check that \(dqonchanges\(dq is a list
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25258\fP: (\fI\%nickw8\fP) windows minion repo not updating (refs: \fI\%#25798\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25798\fP: (\fI\%twangboy\fP) Fixed stacktrace on package name not found
@ \fI2015\-07\-28 22:40:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
ad07dc1e27 Merge pull request \fI\%#25798\fP from twangboy/fix_25258
.IP \(bu 2
aa19c2bf8f Fixed stacktrace on package name not found
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25437\fP: (\fI\%lorengordon\fP) Stacktrace on Windows when running pkg.list_pkgs (refs: \fI\%#25598\fP, \fI\%#25763\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25797\fP: (\fI\%twangboy\fP) Changed repocache back to cached_repo
@ \fI2015\-07\-28 22:39:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25763\fP: (\fI\%twangboy\fP) Fix 25437 (refs: \fI\%#25797\fP)
.IP \(bu 2
4a38d4a606 Merge pull request \fI\%#25797\fP from twangboy/fix_revert_in_25763
.IP \(bu 2
81d5b5ee55 Changed repocache back to cached_repo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25793\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25730\fP to 2015.5
@ \fI2015\-07\-28 19:37:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25730\fP: (\fI\%sjorge\fP) patchelf lives in pkgsrc (refs: \fI\%#25793\fP)
.IP \(bu 2
823f0ce350 Merge pull request \fI\%#25793\fP from rallytime/bp\-25730
.IP \(bu 2
937779eb51 patchelf lives in pkgsrc
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25792\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25688\fP to 2015.5
@ \fI2015\-07\-28 19:37:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25688\fP: (\fI\%bclermont\fP) Don\(aqt acquire lock if there is no formatter (refs: \fI\%#25792\fP)
.IP \(bu 2
4109ae55f9 Merge pull request \fI\%#25792\fP from rallytime/bp\-25688
.IP \(bu 2
0aa1416b6b Don\(aqt acquire lock if there is no formatter
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25796\fP: (\fI\%cachedout\fP) Remove debug from docs
@ \fI2015\-07\-28 17:35:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
737fb1410c Merge pull request \fI\%#25796\fP from cachedout/debug_doc
.IP \(bu 2
33bfdf3b0b Remove debug from docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24920\fP: (\fI\%voileux\fP) module.zpool.create on character device is not possible by salt (refs: \fI\%#25749\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25749\fP: (\fI\%jahamn\fP) Allow zpool.create on character devices
@ \fI2015\-07\-28 16:01:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
a658753eff Merge pull request \fI\%#25749\fP from jahamn/fix\-zpool\-special\-char\-device\-support
.IP \(bu 2
361f6cc23f Allow zpool.create on character devices
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25685\fP: (\fI\%twangboy\fP) Fixed regex issues with comment and uncomment
@ \fI2015\-07\-28 15:29:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
1fae76d53c Merge pull request \fI\%#25685\fP from twangboy/fix_25594
.IP \(bu 2
a904e8329b Fixed another test failure...
.IP \(bu 2
aa077d3a86 Fixed more tests... justin findlay helped me...
.IP \(bu 2
87c8f8dfb5 Fixed some tests... maybe...
.IP \(bu 2
3c1a73f16c Fixed some lint
.IP \(bu 2
b3e44e342c Fixed states to work with comment_line
.IP \(bu 2
b1cedd1153 Fixed regex issues with comment and uncomment
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25437\fP: (\fI\%lorengordon\fP) Stacktrace on Windows when running pkg.list_pkgs (refs: \fI\%#25598\fP, \fI\%#25763\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25763\fP: (\fI\%twangboy\fP) Fix 25437 (refs: \fI\%#25797\fP)
@ \fI2015\-07\-28 15:29:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
0bdb29402a Merge pull request \fI\%#25763\fP from twangboy/fix_25437
.IP \(bu 2
9e70c800b9 The real fix for 25437 that doesn\(aqt break other crap
.IP \(bu 2
d7347e01e5 Revert \(dqFixed problem trying to load file with name of boolean type\(dq
.IP \(bu 2
cf57712eeb Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into fix_25437
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25752\fP: (\fI\%thatch45\fP) State top saltenv
@ \fI2015\-07\-28 01:02:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
c1236595f9 Merge pull request \fI\%#25752\fP from thatch45/state_top_saltenv
.IP \(bu 2
65d6ec0659 don\(aqt override the minion config unless requested
.IP \(bu 2
26c858361c Add state_top_saltenv to the config chain
.IP \(bu 2
36a3b674a7 Add raet support for state_top_saltnev
.IP \(bu 2
f6fa025b13 Add saltenv top file support to salt master_opts
.IP \(bu 2
4a1c53309b Add state_top_saltenv support
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25717\fP: (\fI\%twangboy\fP) Problem with chocolatey module not loading (refs: \fI\%#25755\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25755\fP: (\fI\%twangboy\fP) Fixed problem with dunder functions not being passed
@ \fI2015\-07\-27 19:31:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
f367acb253 Merge pull request \fI\%#25755\fP from twangboy/fix_25717
.IP \(bu 2
10e410504d Fixed problem with dunder functions not being passed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25352\fP: (\fI\%m03\fP) reg.absent reporting incorrect results (refs: \fI\%#25648\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25648\fP: (\fI\%twangboy\fP) Clarified functionality of reg module, fixed state to work with new module
@ \fI2015\-07\-27 19:30:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
f05ae95f9c Merge pull request \fI\%#25648\fP from twangboy/fix_25352
.IP \(bu 2
d6496ce814 Merge pull request \fI\%#1\fP from jfindlay/reg
.INDENT 2.0
.IP \(bu 2
3b0cc6592a fix reg unit tests
.UNINDENT
.IP \(bu 2
b473fb7827 Fixed some tests... maybe...
.IP \(bu 2
ff7296d983 Fixed some more lint
.IP \(bu 2
7a71f5ea6a Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into fix_25352
.IP \(bu 2
f57b2b8e7a Fixed some line, added documentation
.IP \(bu 2
d78fa97a71 Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into fix_25352
.IP \(bu 2
99d9518af8 Clarified functionality of reg module, fixed state to work with new module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25154\fP: (\fI\%uvsmtid\fP) All data mixed on STDOUT together should generate valid JSON output (refs: \fI\%#25722\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#25153\fP: (\fI\%uvsmtid\fP) Multiple results should generate valid JSON output (refs: \fI\%#25722\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25740\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25722\fP to 2015.5
@ \fI2015\-07\-27 16:08:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25722\fP: (\fI\%uvsmtid\fP) Minor docs changes to emphasize JSON output problems without \fI\-\-static\fP option (refs: \fI\%#25740\fP)
.IP \(bu 2
29c66d85a4 Merge pull request \fI\%#25740\fP from rallytime/bp\-25722
.IP \(bu 2
c33eb813ea Change docs for \-\-static option with JSON \- text B
.IP \(bu 2
89dd2ec8fb Change docs for \-\-static option with JSON \- text A
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25739\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25709\fP to 2015.5
@ \fI2015\-07\-27 16:08:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25709\fP: (\fI\%colekowalski\fP) add direct\-io\-mode to mount_invisible_options (refs: \fI\%#25739\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25699\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25660\fP to 2015.5 (refs: \fI\%#25709\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25660\fP: (\fI\%colekowalski\fP) add glusterfs\(aq direct\-io\-mode to mount_invisible_keys (refs: \fI\%#25699\fP, \fI\%#25709\fP)
.IP \(bu 2
135b03e53b Merge pull request \fI\%#25739\fP from rallytime/bp\-25709
.IP \(bu 2
fda2ffa44e add direct\-io\-mode to mount_invisible_options
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25738\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25671\fP to 2015.5
@ \fI2015\-07\-27 16:08:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25671\fP: (\fI\%niq000\fP) added a parameter so verifying SSL is now optional instead of hard\-coded (refs: \fI\%#25738\fP)
.IP \(bu 2
095a923b6e Merge pull request \fI\%#25738\fP from rallytime/bp\-25671
.IP \(bu 2
525cd70589 added a parameter so verifying SSL is now optional instead of hard\-coded
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25229\fP: (\fI\%rmatulat\fP) Module git.latest kills target directory when test=True (refs: \fI\%#25608\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25737\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25608\fP to 2015.5
@ \fI2015\-07\-27 16:08:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25608\fP: (\fI\%rmatulat\fP) Fix: prevent git.latest from removing target (refs: \fI\%#25737\fP)
.IP \(bu 2
05fbfe64e9 Merge pull request \fI\%#25737\fP from rallytime/bp\-25608
.IP \(bu 2
df85d734bc Fix: prevent git.latest from removing target Fixes \fI\%#25229\fP While force=True and test=True git.latest should not remove the target directory.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25733\fP: (\fI\%davidjb\fP) Avoid IndexError when listing mounts if mount output ends in newline
@ \fI2015\-07\-27 16:08:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
9817fc5556 Merge pull request \fI\%#25733\fP from davidjb/mount\-fix
.IP \(bu 2
6d0bce2418 Test length of comps when listing mounts
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22460\fP: (\fI\%onmeac\fP) Command setm is not supported (yet) (refs: \fI\%#25705\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25705\fP: (\fI\%blackduckx\fP) Support for setm augeas command.
@ \fI2015\-07\-27 16:07:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
82ba390b7b Merge pull request \fI\%#25705\fP from blackduckx/augeas\-setm
.IP \(bu 2
cad0f2b46e Augeas: fix pylint and documentation
.IP \(bu 2
ee97896cba Support for setm augeas command.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25703\fP: (\fI\%cachedout\fP) Return to \fIstr\fP for master_type for 2015.5
@ \fI2015\-07\-27 16:06:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
f732be365d Merge pull request \fI\%#25703\fP from cachedout/master_type_2015_5
.IP \(bu 2
0dc28ad3e4 Return to \fIstr\fP for master_type for 2015.5
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25144\fP: (\fI\%johnccfm\fP) user.present on Windows fails to add user to groups if group name contains a space (refs: \fI\%#25702\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25702\fP: (\fI\%twangboy\fP) Fixed win_user module for groups with spaces in the name
@ \fI2015\-07\-27 15:06:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
dea3d31578 Merge pull request \fI\%#25702\fP from twangboy/fix_25144
.IP \(bu 2
d5be7a2fdf Fixed win_user moduele for groups with spaces in the name
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25351\fP: (\fI\%m03\fP) win_servermanager.list_installed failing with \(dqIndexError: list index out of range\(dq (refs: \fI\%#25711\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25711\fP: (\fI\%twangboy\fP) Fixed problem with win_servermanager.list_installed
@ \fI2015\-07\-27 15:05:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
186af9b54d Merge pull request \fI\%#25711\fP from twangboy/fix_25351
.IP \(bu 2
82fa911931 Fixed problem with win_servermanager.list_installed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25435\fP: (\fI\%yee379\fP) progressbar dependency missing (refs: \fI\%#25714\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25714\fP: (\fI\%cachedout\fP) Display warning when progressbar can\(aqt be loaded
@ \fI2015\-07\-25 00:10:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
ad8456eeed Merge pull request \fI\%#25714\fP from cachedout/issue_25435
.IP \(bu 2
44f34684ef Included note in help docs
.IP \(bu 2
4e2fee17cc Display warning when progressbar can\(aqt be loaded
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25699\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25660\fP to 2015.5 (refs: \fI\%#25709\fP)
@ \fI2015\-07\-24 22:11:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25660\fP: (\fI\%colekowalski\fP) add glusterfs\(aq direct\-io\-mode to mount_invisible_keys (refs: \fI\%#25699\fP, \fI\%#25709\fP)
.IP \(bu 2
a0969ff74a Merge pull request \fI\%#25699\fP from rallytime/bp\-25660
.IP \(bu 2
85c636d7a1 add glusterfs\(aq direct\-io\-mode to mount_invisible_keys
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25689\fP: (\fI\%anlutro\fP) Minion log in salt\-ssh (refs: \fI\%#25694\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25694\fP: (\fI\%s0undt3ch\fP) Salt\-SSH fix for \fI\%#25689\fP
@ \fI2015\-07\-24 21:41:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
fe829564f4 Merge pull request \fI\%#25694\fP from s0undt3ch/2015.5
.IP \(bu 2
afba3bde90 Use a relative un\-nested path to the salt\-call logfile.
.IP \(bu 2
6309f22a65 Fix wrong variable assignment
.IP \(bu 2
c312592c81 Have cookie JAR\(aqs respect the configured \fIcachedir\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25250\fP: (\fI\%wipfs\fP) \(aqforce\(aq option in copy state deletes target file (refs: \fI\%#25461\fP, \fI\%#25710\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25710\fP: (\fI\%jahamn\fP) Integration Testcase for Issue 25250
@ \fI2015\-07\-24 20:57:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
fb4744b2f8 Merge pull request \fI\%#25710\fP from jahamn/integration\-test\-for\-issue\-25250
.IP \(bu 2
24f653e963 Integration Test for Issue 25250
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25680\fP: (\fI\%basepi\fP) [2015.5] Move cmd.run jinja aliasing to a wrapper class to prevent side effects
@ \fI2015\-07\-24 19:52:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25049\fP: (\fI\%terminalmage\fP) Fix cmd.run when cross\-called in a state/execution module (refs: \fI\%#25680\fP)
.IP \(bu 2
18c9d5454d Merge pull request \fI\%#25680\fP from basepi/jinja.alias.25049
.IP \(bu 2
e83a0f9b2b Use new\-style classes
.IP \(bu 2
4a50bac1c2 Fix typo
.IP \(bu 2
36410389dc Name the Nitrogen release
.IP \(bu 2
77679596f9 Make ALIASES global
.IP \(bu 2
01c209efd9 Fix some aliases references
.IP \(bu 2
1644641c57 Move cmd.run aliasing to a wrapper class to prevent side effects
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25682\fP: (\fI\%basepi\fP) [2015.5] Fix parsing args with just a hash (#)
@ \fI2015\-07\-24 19:52:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a5c6dcd04 Merge pull request \fI\%#25682\fP from basepi/fix.hash.parsing
.IP \(bu 2
8d75c1b882 Fix parsing args with just a hash (#)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25695\fP: (\fI\%stanislavb\fP) Configurable AWS region & region from IAM metadata
@ \fI2015\-07\-24 19:36:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
d330ef0d81 Merge pull request \fI\%#25695\fP from stanislavb/expose\-aws\-region\-config\-and\-fetch\-region\-from\-metadata
.IP \(bu 2
595da6252e Configurable AWS region & region from IAM metadata
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25645\fP: (\fI\%kev009\fP) Fix pkgng provider to work with a sources list and the underlying pkg…
@ \fI2015\-07\-24 16:33:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea0d295d49 Merge pull request \fI\%#25645\fP from kev009/freebsd\-pkgng\-add
.IP \(bu 2
ee2cbb574a Fix pkgng provider to work with a sources list and the underlying pkg\-add(8)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25677\fP: (\fI\%aneeshusa\fP) Fix pacman.list_upgrades when refresh=True.
@ \fI2015\-07\-24 16:30:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
2cad79c2f0 Merge pull request \fI\%#25677\fP from aneeshusa/fix\-pacman\-list\-upgrades\-when\-refreshing
.IP \(bu 2
7062ae4eae Fix pacman.list_upgrades when refresh=True.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25674\fP: (\fI\%UtahDave\fP) file.managed with contents parameter uses wrong line endings on Windows (refs: \fI\%#25675\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25675\fP: (\fI\%UtahDave\fP) Use OS line endings with contents on file.managed
@ \fI2015\-07\-24 16:29:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
18e739b812 Merge pull request \fI\%#25675\fP from UtahDave/2015.5local
.IP \(bu 2
d0f9d001db Use OS line endings with contents on file.managed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25676\fP: (\fI\%basepi\fP) Update release candidate docs to 2015.8.0rc2
@ \fI2015\-07\-23 20:29:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
7914f51636 Merge pull request \fI\%#25676\fP from basepi/2015.8.0rc2releasedocs
.IP \(bu 2
882d11836b Update release candidate docs to 2015.8.0rc2
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25665\fP: (\fI\%nmadhok\fP) salt\-cloud VMware driver fails with KeyErrors if there\(aqs any existing machine in the VMware infrastructure in (invalid state) (refs: \fI\%#25666\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25666\fP: (\fI\%nmadhok\fP) Check if the properties exist before looping over them causing KeyError
@ \fI2015\-07\-23 17:55:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
c36b714401 Merge pull request \fI\%#25666\fP from nmadhok/vmware\-cloud\-fix_2015.5
.IP \(bu 2
8e812296ef Check if the properties exist before looping over them causing KeyErrors Fixes \fI\%#25665\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25656\fP: (\fI\%anlutro\fP) Fix locale detection in debian/gentoo
@ \fI2015\-07\-23 16:46:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
36d04b2954 Merge pull request \fI\%#25656\fP from alprs/fix\-locale_detection
.IP \(bu 2
a260236942 change variable name
.IP \(bu 2
dd2a188c05 fix tests
.IP \(bu 2
aefd0fb374 code formatting
.IP \(bu 2
e58d222fb0 fix locale detection in debian/gentoo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25661\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25624\fP to 2015.5
@ \fI2015\-07\-23 16:26:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25624\fP: (\fI\%bobrik\fP) Fix typo in get_routes example for debian_ip (refs: \fI\%#25661\fP)
.IP \(bu 2
b1c1735aae Merge pull request \fI\%#25661\fP from rallytime/bp\-25624
.IP \(bu 2
4e1fcfa15e Fix typo in get_routes example for debian_ip
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#15209\fP: (\fI\%hubez\fP) file.manage: source_hash not working with s3:// (2014.7.0rc1) (refs: \fI\%#25638\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25662\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25638\fP to 2015.5
@ \fI2015\-07\-23 16:26:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25638\fP: (\fI\%TronPaul\fP) fix bad merge in 99fc7ec (refs: \fI\%#25662\fP)
.IP \(bu 2
6a2843dee2 Merge pull request \fI\%#25662\fP from rallytime/bp\-25638
.IP \(bu 2
90d833d5dc fix bad merge 99fc7ec
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25413\fP: (\fI\%zizkebab\fP) pillar_opts default behavior is not reflected in the docs (refs: \fI\%#25644\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25644\fP: (\fI\%cachedout\fP) pillar doc fix
@ \fI2015\-07\-22 22:57:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
00f4689fe3 Merge pull request \fI\%#25644\fP from cachedout/issue_25413
.IP \(bu 2
8cef61e6cc pillar doc fix
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25540\fP: (\fI\%dennisjac\fP) salt highstate schedule cannot be removed (refs: \fI\%#25642\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25642\fP: (\fI\%cachedout\fP) Warn on pillar schedule delete
@ \fI2015\-07\-22 22:04:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
aeaeb53ed6 Merge pull request \fI\%#25642\fP from cachedout/issue_25540
.IP \(bu 2
74f6b6930c Warn on pillar schedule delete
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25437\fP: (\fI\%lorengordon\fP) Stacktrace on Windows when running pkg.list_pkgs (refs: \fI\%#25598\fP, \fI\%#25763\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25598\fP: (\fI\%twangboy\fP) Fixed problem trying to load file with name of boolean type
@ \fI2015\-07\-22 17:07:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
7b79e433f1 Merge pull request \fI\%#25598\fP from twangboy/fix_25437
.IP \(bu 2
c53e11d42c Fixed problem trying to load file with name of boolean type
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25323\fP: (\fI\%terminalmage\fP) unit.modules.tls_test fails with older mock (refs: \fI\%#25604\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25604\fP: (\fI\%terminalmage\fP) Move patching of mock_open to within test
@ \fI2015\-07\-22 16:53:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
f4a38a8aee Merge pull request \fI\%#25604\fP from terminalmage/fix\-mock_open
.IP \(bu 2
123b8ee1cb Fix mock_open patch
.IP \(bu 2
af82835f42 Move patching of mock_open to within test
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#630\fP: (\fI\%jf\fP) Ubuntu 12.04 (and maybe 12.x?): apt\-get installing python\-requests causes digital_ocean_v2 to fail with \(dq[ERROR ] Failed to get the output of \(aqdigital_ocean.avail_sizes()\(aq: \(aqResponse\(aq object has no attribute \(aqtext\(aq\(dq (refs: \fI\%#25609\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#627\fP: (\fI\%nyushi\fP) Fix tornado installation on ubuntu (refs: \fI\%#25609\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25609\fP: (\fI\%s0undt3ch\fP) [2015.5] Update the bootstrap script to latest release v2015.07.22
@ \fI2015\-07\-22 16:28:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
224484df7e Merge pull request \fI\%#25609\fP from s0undt3ch/hotfix/bootstrap\-script\-2015.5
.IP \(bu 2
96a8568336 Update the bootstrap script to latest release v2015.07.22
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21912\fP: (\fI\%rvora\fP) pkg.latest not updating the package on CentOS though yum reports an update available (refs: \fI\%#25603\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25603\fP: (\fI\%terminalmage\fP) Add version_cmp function to yumpkg.py
@ \fI2015\-07\-22 15:42:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
07eb78c79f Merge pull request \fI\%#25603\fP from terminalmage/issue21912
.IP \(bu 2
99e532ba74 Add versionadded directive
.IP \(bu 2
8a1765fc6f Add version_cmp function to yumpkg.py
.IP \(bu 2
457e72e273 Fix references to __salt__[\(aqversion_cmp\(aq]
.IP \(bu 2
a19fa2296a Avoid using single\-letter variable
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25560\fP: (\fI\%dennisjac\fP) scheduled highstate runs don\(aqt return results to the job cache (refs: \fI\%#25590\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25590\fP: (\fI\%garethgreenaway\fP) 2015.5 scheduled jobs return data
@ \fI2015\-07\-21 21:57:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
69ef81caba Merge pull request \fI\%#25590\fP from garethgreenaway/25560_2015_5_schedule_return_data
.IP \(bu 2
19ca0c0b40 Switching default in 2015.5 for whether job data in returned to the mater job_cache.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25584\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24054\fP and \fI\%#25576\fP to 2015.5
@ \fI2015\-07\-21 21:16:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25576\fP: (\fI\%pcn\fP) s3fs breaks when fetching files from s3 (refs: \fI\%#25584\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24054\fP: (\fI\%mgwilliams\fP) s3.head: return useful data (refs: \fI\%#25584\fP)
.IP \(bu 2
9ffefc867e Merge pull request \fI\%#25584\fP from rallytime/bp\-24054\-and\-25576
.IP \(bu 2
aa9598e3a5 s3fs breaks when fetching files from s3
.IP \(bu 2
1667d67c3e s3.head: return useful data
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23626\fP: (\fI\%mirko\fP) salt state \(aqssh_known_hosts\(aq doesn\(aqt take \(aqport\(aq into account (refs: \fI\%#25589\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25589\fP: (\fI\%jahamn\fP) Fixes ssh_known_host not taking port into account
@ \fI2015\-07\-21 21:15:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
a966e439d1 Merge pull request \fI\%#25589\fP from jahamn/Fix\-ssh_known_host\-not\-taking\-port\-into\-account
.IP \(bu 2
8db7ada82d Fixed pylint e8303 errors
.IP \(bu 2
6abad29f66 Fixed pylint errors
.IP \(bu 2
8ae6ba1290 Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into Fix\-ssh_known_host\-not\-taking\-port\-into\-account
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25573\fP: (\fI\%EvaSDK\fP) Do not execute bootstrap script twice
@ \fI2015\-07\-21 18:20:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25465\fP: (\fI\%EvaSDK\fP) 2015.5.3 LXC module fixes (refs: \fI\%#25573\fP)
.IP \(bu 2
df74f2c3ad Merge pull request \fI\%#25573\fP from EvaSDK/2015.5.3\-lxc\-fixes
.IP \(bu 2
49cec9f9a1 Use a more persistent tmp directory
.IP \(bu 2
96a672f8e0 Do not execute bootstrap script twice
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25532\fP: (\fI\%attiasr\fP) salt/modules/win_pkg.py list_pkgs is broken (encoding issues) (refs: \fI\%#25580\fP, \fI\%#25556\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25580\fP: (\fI\%attiasr\fP) use explicit utf\-8 decoding (\fI\%#25532\fP)
@ \fI2015\-07\-21 15:40:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
79a809dd79 Merge pull request \fI\%#25580\fP from attiasr/patch\-1
.IP \(bu 2
4b7dc96919 use explicit utf\-8 decoding (\fI\%#25532\fP)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25206\fP: (\fI\%jfindlay\fP) fullname issues with user.add state on windows (refs: \fI\%#25568\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25568\fP: (\fI\%twangboy\fP) Fixed win_useradd module to add fullname
@ \fI2015\-07\-21 14:30:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
6edf196533 Merge pull request \fI\%#25568\fP from twangboy/fix_25206
.IP \(bu 2
fbee445c6d Commented out a pylint error
.IP \(bu 2
4b56dc3893 Fixed win_useradd module to add fullname
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21041\fP: (\fI\%deuscapturus\fP) state module gem.installed not working on Windows. (refs: \fI\%#25430\fP, \fI\%#25561\fP, \fI\%#25428\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25561\fP: (\fI\%twangboy\fP) Fixed the gem module to work on windows... without injection
@ \fI2015\-07\-20 21:12:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25428\fP: (\fI\%twangboy\fP) Fixed the gem module to work on windows (refs: \fI\%#25561\fP)
.IP \(bu 2
3c32b0b669 Merge pull request \fI\%#25561\fP from twangboy/fix_21041_again
.IP \(bu 2
aaf3f3dcd0 Fixed some line and style issues
.IP \(bu 2
e6d0e5cda7 Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into fix_21041_again
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25521\fP: (\fI\%cachedout\fP) Fix outputter for state.orch
@ \fI2015\-07\-20 19:30:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
9e19142c35 Merge pull request \fI\%#25521\fP from cachedout/orch_outputter
.IP \(bu 2
ea40816621 Try/except
.IP \(bu 2
dd609eb440 Fix outputter for state.orch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25563\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-07\-20 19:27:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
2117ac8022 Merge pull request \fI\%#25563\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
3bf2f1a722 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
09ebaceca8 Merge pull request \fI\%#25416\fP from cachedout/str_2014_7
.INDENT 2.0
.IP \(bu 2
cc514938a8 Fix broken keyword
.INDENT 2.0
.IP \(bu 2
d67491bb80 Removed the logger as it\(aqs not used anymore
.IP \(bu 2
5008bfee96 Merge branch \(aq2015.5\(aq of \fI\%https://github.com/saltstack/salt\fP into fix_21041_again
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25559\fP: (\fI\%cachedout\fP) Lint win_pkg
@ \fI2015\-07\-20 17:46:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
50c257b1d5 Merge pull request \fI\%#25559\fP from cachedout/lint_win_pkg
.IP \(bu 2
53a00add99 Lint win_pkg
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25532\fP: (\fI\%attiasr\fP) salt/modules/win_pkg.py list_pkgs is broken (encoding issues) (refs: \fI\%#25580\fP, \fI\%#25556\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25556\fP: (\fI\%attiasr\fP) fix for \fI\%#25532\fP
@ \fI2015\-07\-20 17:45:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
7c7015ccda Merge pull request \fI\%#25556\fP from attiasr/patch\-1
.IP \(bu 2
9b224e8d4e fix for \fI\%#25532\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25538\fP: (\fI\%stanislavb\fP) S3 ext_pillar configuration requires verify_ssl (refs: \fI\%#25554\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25554\fP: (\fI\%jfindlay\fP) verify_ssl=True for s3 ext pillar
@ \fI2015\-07\-20 17:43:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
3c73dab2ce Merge pull request \fI\%#25554\fP from jfindlay/verify_ssl
.IP \(bu 2
ca3ab4e737 verify_ssl=True for s3 ext pillar
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25551\fP: (\fI\%rallytime\fP) Backport \fI\%#25530\fP to 2015.5
@ \fI2015\-07\-20 17:43:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25530\fP: (\fI\%andre\-luiz\-dos\-santos\fP) The variable name must be last (refs: \fI\%#25551\fP)
.IP \(bu 2
e3e2e6718e Merge pull request \fI\%#25551\fP from rallytime/bp\-25530
.IP \(bu 2
df5003d7f9 The variable name must be last
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25533\fP: (\fI\%attiasr\fP) port 445 for windows bootstraping
@ \fI2015\-07\-20 15:13:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e3441937f Merge pull request \fI\%#25533\fP from attiasr/patch\-2
.IP \(bu 2
c7fbf68597 fix windows bootstrapping
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25432\fP: (\fI\%gtmanfred\fP) [2015.5.3][raet] raet error with SaltRaetRoadStackJoiner (refs: \fI\%#25525\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25525\fP: (\fI\%gtmanfred\fP) add make _prepare an alias for postinitio
@ \fI2015\-07\-20 15:12:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
7fc051f56d Merge pull request \fI\%#25525\fP from gtmanfred/2015.5
.IP \(bu 2
43950a5bc5 add make _prepare an alias for postinitio
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25511\fP: (\fI\%rallytime\fP) Make provider \-\-> driver change backward compatible (refs: \fI\%#25519\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23574\fP: (\fI\%CedNantes\fP) Failed to Deploy Salt\-Minion on a Win 2012 R2 using wmware Cloud Driver from Develop branch (refs: \fI\%#25519\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25519\fP: (\fI\%rallytime\fP) Backport vmware driver to 2015.5 branch
@ \fI2015\-07\-20 15:11:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
725d1a40d0 Merge pull request \fI\%#25519\fP from rallytime/backport_vmware
.IP \(bu 2
35e13eef1d Don\(aqt reference driver in older salt versions
.IP \(bu 2
f011890217 Add vmware back\-port change to release notes
.IP \(bu 2
0f4f560b38 Backport vmware driver to 2015.5 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25542\fP: (\fI\%Oro\fP) Fix hipchat.send_message when using API v2
@ \fI2015\-07\-20 15:09:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
2f0d695bc0 Merge pull request \fI\%#25542\fP from Oro/fix\-hipchat\-v2\-sendmessage
.IP \(bu 2
3a9f5b037f Fix hipchat.send_message when using API v2
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25531\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25529\fP to 2015.5
@ \fI2015\-07\-18 19:16:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25529\fP: (\fI\%davidjb\fP) Fix minor typo in best practice example (refs: \fI\%#25531\fP)
.IP \(bu 2
390aa7d28f Merge pull request \fI\%#25531\fP from rallytime/bp\-25529
.IP \(bu 2
3e24381439 Fix minor typo in best practice example
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25528\fP: (\fI\%davidjb\fP) Fix typo in extend declaration doco
@ \fI2015\-07\-18 14:22:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
6e811bfdd2 Merge pull request \fI\%#25528\fP from davidjb/patch\-7
.IP \(bu 2
bfc4f9fd85 Fix typo in extend declaration doco
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25486\fP: (\fI\%whiteinge\fP) Highstate outputter not used for state.apply (refs: \fI\%#25517\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25517\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25486\fP to 2015.5
@ \fI2015\-07\-17 21:49:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25485\fP: (\fI\%attiasr\fP) fix file downloads on windows
.IP \(bu 2
b9abd723a7 Merge pull request \fI\%#25517\fP from rallytime/bp\-25485
.IP \(bu 2
6c2f3180c2 fix file downloads on windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25479\fP: (\fI\%alexandrsushko\fP) multiple mount.mounted of one device (refs: \fI\%#25483\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25516\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25483\fP to 2015.5
@ \fI2015\-07\-17 21:49:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25483\fP: (\fI\%alexandrsushko\fP) Added \(aqnone\(aq to the set of specialFSes (refs: \fI\%#25516\fP)
.IP \(bu 2
9cb436fbae Merge pull request \fI\%#25516\fP from rallytime/bp\-25483
.IP \(bu 2
e0af6e3478 Added \(aqnone\(aq to the set of specialFSes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25493\fP: (\fI\%blackduckx\fP) Issue with job_args on schedule.add command (refs: \fI\%#25513\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25513\fP: (\fI\%garethgreenaway\fP) fixes to schedule.add documentation in 2015.5
@ \fI2015\-07\-17 17:03:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
daf03efb7c Merge pull request \fI\%#25513\fP from garethgreenaway/25493_2015_5_schedule_add_documentation
.IP \(bu 2
bc2414bc4d Fixing documentation for schedule.add when using the job_args parameter, value needs to be be in quotes for the value to be passed in as an array.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25465\fP: (\fI\%EvaSDK\fP) 2015.5.3 LXC module fixes (refs: \fI\%#25573\fP)
@ \fI2015\-07\-17 15:57:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
48050cd287 Merge pull request \fI\%#25465\fP from EvaSDK/2015.5.3\-lxc\-fixes
.IP \(bu 2
170eb52cc4 Fix use of undefined cmd when install of boostrap script fails
.IP \(bu 2
86118f4a7b Install bootstrap script like dns and systemd check scripts in container
.IP \(bu 2
978e6d56e2 Error out if configdir could not be created when preparing LXC container
.IP \(bu 2
41b6c3c2bf Fix typo in redirecting shell output to /dev/null
.IP \(bu 2
456393d4db Fix DNS script cleanup
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#611\fP: (\fI\%BretFisher\fP) SmartOS doesn\(aqt detect missing git, fails install (refs: \fI\%#25506\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#607\fP: (\fI\%bechtoldt\fP) (git install) change source of init scripts for debian based systems (refs: \fI\%#25506\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#602\fP: (\fI\%rallytime\fP) Ubuntu 14.10 Won\(aqt Bootstrap with Latest Stable  (refs: \fI\%#25506\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#598\fP: (\fI\%babilen\fP) Installation fails on Debian 7 due to missing easy_install (refs: \fI\%#25506\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#25456\fP: (\fI\%julienlavergne\fP) [2015.8.0rc1] salt\-bootstrap fails to install salt master (refs: \fI\%#25506\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#25270\fP: (\fI\%iggy\fP) [2015.8.0rc1] salt\-bootstrap fails to properly install a minion (refs: \fI\%#25506\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#619\fP: (\fI\%syphernl\fP) Only send over changed files during state.highstate (refs: #\(gasaltstack/salt\-bootstrap#621\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#625\fP: (\fI\%hasues\fP) Modify bootstrap\-salt.sh unbound error with CONFIG_PROTECT_MASK for Gentoo (refs: \fI\%#25506\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#624\fP: (\fI\%BretFisher\fP) fix config and etc path on SmartOS (refs: \fI\%#25506\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#621\fP: (\fI\%lomeroe\fP) python\-jinja2 has been moved to rhui\-...server\-releases\-optional repo… (refs: \fI\%#25506\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#606\fP: (\fI\%babilen\fP) Switch to httpredir.debian.org as default Debian mirror (refs: \fI\%#25506\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#455\fP: (\fI\%denmat\fP) PR: Issue 394 (refs: \fI\%#25506\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25506\fP: (\fI\%s0undt3ch\fP) [2015.5] Update bootstrap script to latest stable release, v2015.07.17
@ \fI2015\-07\-17 15:40:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
f85f2b49fd Merge pull request \fI\%#25506\fP from s0undt3ch/hotfix/bootstrap\-script
.IP \(bu 2
ab6aaa6e60 Update bootstrap script to latest stable release, v2015.07.17
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25454\fP: (\fI\%mschiff\fP) Regression: salt 2015.5 not working in secure chroot anymore. (refs: \fI\%#25498\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25498\fP: (\fI\%jfindlay\fP) only read /proc/1/cmdline if it exists
@ \fI2015\-07\-17 15:35:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
c8caf406b2 Merge pull request \fI\%#25498\fP from jfindlay/jail_init
.IP \(bu 2
c63a6c206f only read /proc/1/cmdline if it exists
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25487\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25464\fP to 2015.5
@ \fI2015\-07\-16 16:58:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25464\fP: (\fI\%jquast\fP) docfix: \(dqcache_jobs: False\(dq => grains_cache: False\(dq (refs: \fI\%#25487\fP)
.IP \(bu 2
3f695a17cf Merge pull request \fI\%#25487\fP from rallytime/bp\-25464
.IP \(bu 2
e947d8ec5a docfix: \(dqcache_jobs: False\(dq => grains_cache: False\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25482\fP: (\fI\%oeuftete\fP) Fix docker.running detection of running container
@ \fI2015\-07\-16 16:58:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
331808eb7d Merge pull request \fI\%#25482\fP from oeuftete/docker\-running\-is\-running\-fix\-2015\-5
.IP \(bu 2
b69379ba50 Fix docker.running detection of running container
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25384\fP: (\fI\%rickh563\fP) pyopenssl 0.14 requirement in 2015.5.3 does not work in RHEL6 : ZD\-364 (refs: \fI\%#25468\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25468\fP: (\fI\%joejulian\fP) Add support for pyOpenSSL > 0.10
@ \fI2015\-07\-16 15:10:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
7a20ecbf46 Merge pull request \fI\%#25468\fP from joejulian/use_pyopenssl_0_10
.IP \(bu 2
1b7a56aa38 Add support for pyOpenSSL > 0.10
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25467\fP: (\fI\%rallytime\fP) Add lxml dependency to opennebula docs
@ \fI2015\-07\-16 15:09:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
d169905170 Merge pull request \fI\%#25467\fP from rallytime/lxml_dep
.IP \(bu 2
d326f4f686 Add lxml dependency to opennebula docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25250\fP: (\fI\%wipfs\fP) \(aqforce\(aq option in copy state deletes target file (refs: \fI\%#25461\fP, \fI\%#25710\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24647\fP: (\fI\%nmadhok\fP) salt.states.file.copy does not copy the file if it already exists with force=True (refs: \fI\%#25461\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25461\fP: (\fI\%jahamn\fP) Update file, if force option and content not same
@ \fI2015\-07\-15 20:15:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
89649456e0 Merge pull request \fI\%#25461\fP from jahamn/fixed\-file.copy\-force\-option\-deleting\-files\-without\-updating\-them
.IP \(bu 2
32cf1ebbb5 Update file, if force option and content not same
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25431\fP: (\fI\%namcois\fP) Digital Ocean v2 reducing API calls by adding per_page (refs: \fI\%#25438\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25438\fP: (\fI\%rallytime\fP) Reduce digital_ocean_v2 API call frequency
@ \fI2015\-07\-15 19:40:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
146a81b7c3 Merge pull request \fI\%#25438\fP from rallytime/do_v2
.IP \(bu 2
faf49ea2a3 Add page number change release notes
.IP \(bu 2
da6ab82837 Reduce digital_ocean_v2 API call frequency
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25457\fP: (\fI\%jacksontj\fP) Saltnado
@ \fI2015\-07\-15 17:50:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25427\fP: (\fI\%tony\-cocco\fP) Saltnado runner client results in blocking call despite being set\-up as Runner.async (refs: \fI\%#25457\fP)
.IP \(bu 2
cb98d79cdd Merge pull request \fI\%#25457\fP from jacksontj/saltnado
.IP \(bu 2
bc32f66b98 Add runner_async endpoint to salnado
.IP \(bu 2
b043fa9b05 Better name of method process manager is starting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25459\fP: (\fI\%jahamn\fP) Fixed \(aqdefulats\(aq typo in verify.py
@ \fI2015\-07\-15 16:53:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
3f72eb5486 Merge pull request \fI\%#25459\fP from jahamn/fix\-defulats\-typo\-in\-verify.py
.IP \(bu 2
9bafd19f67 Fixed \(aqdefulats\(aq typo in verify.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25426\fP: (\fI\%jquast\fP) bugfix: trailing \(dq...done\(dq in rabbitmq output (backport from \(aqdevelop\(aq to 2015.5)
@ \fI2015\-07\-15 14:48:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
73566188cf Merge pull request \fI\%#25426\fP from jquast/2015.5
.IP \(bu 2
005a7ca2a3 bugfix: trailing \(dq...done\(dq in rabbitmq output
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25433\fP: (\fI\%jleroy\fP) Support for IPv6 addresses scopes in network.interfaces (ifconfig)
@ \fI2015\-07\-15 14:44:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25151\fP: (\fI\%jleroy\fP) Support for IPv6 addresses scopes in network.interfaces (refs: \fI\%#25274\fP, \fI\%#25433\fP)
.IP \(bu 2
cfec990062 Merge pull request \fI\%#25433\fP from jleroy/ipv6\-scope\-support\-ifconfig
.IP \(bu 2
bc36d05c0c Support for IPv6 addresses scopes in network.interfaces (ifconfig)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21041\fP: (\fI\%deuscapturus\fP) state module gem.installed not working on Windows. (refs: \fI\%#25430\fP, \fI\%#25561\fP, \fI\%#25428\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25430\fP: (\fI\%twangboy\fP) Disabled rbenv execution module for Windows
@ \fI2015\-07\-15 14:41:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
a425230c19 Merge pull request \fI\%#25430\fP from twangboy/fix_21041_2
.IP \(bu 2
242fc21765 Disabled rbenv execution module for Windows
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
8b2dc681f9 Fixed the gem module to work on windows... without injection
.IP \(bu 2
c7466e7894 Fixes ssh_known_host to take port into account
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#1846\fP: (\fI\%seanchannel\fP) development dependencies
.IP \(bu 2
\fBPR\fP \fI\%#25420\fP: (\fI\%techhat\fP) Move S3 to use AWS Signature Version 4
@ \fI2015\-07\-14 22:03:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
9313804e27 Merge pull request \fI\%#25420\fP from techhat/s3sig4
.IP \(bu 2
3edf3a14e2 Linting
.IP \(bu 2
c63c2356be Move S3 to use AWS Signature Version 4
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#20441\fP: (\fI\%deuscapturus\fP) State module file.managed returns an error on Windows and test=Test (refs: \fI\%#25418\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25418\fP: (\fI\%twangboy\fP) Fixed problem with file.managed test=True
@ \fI2015\-07\-14 21:26:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
30a41d3f51 Merge pull request \fI\%#25418\fP from twangboy/fix_20441
.IP \(bu 2
d8957856cd Fixed problem with file.managed test=True
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25417\fP: (\fI\%ahus1\fP) extended documentation about dependencies for dig module
@ \fI2015\-07\-14 20:49:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
3805677e93 Merge pull request \fI\%#25417\fP from ahus1/patch\-1
.IP \(bu 2
3cd194ebaf Update dig.py
.IP \(bu 2
287f8f76e3 extended documentation about dependencies
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25411\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-07\-14 17:55:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
4d929071e1 Merge pull request \fI\%#25411\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
33d2451fef Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
2a1dd1113f Merge pull request \fI\%#25375\fP from cachedout/config_fix_2014_7
.INDENT 2.0
.IP \(bu 2
c041f2905f Fix error in config.py for master_type
.UNINDENT
.IP \(bu 2
2590e23d48 Merge pull request \fI\%#25324\fP from jacobhammons/doc\-theme\-updates
.INDENT 2.0
.IP \(bu 2
88f5fcf58d Latest help theme updates
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25406\fP: (\fI\%anlutro\fP) Force arguments to aptpkg.version_cmp into strings
@ \fI2015\-07\-14 16:15:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
81bed62d16 Merge pull request \fI\%#25406\fP from alprs/fix\-apt_version_cmp_types
.IP \(bu 2
d56efd1341 force arguments to apt_pkg.version_compare into strings
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25408\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25399\fP to 2015.5
@ \fI2015\-07\-14 16:09:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25399\fP: (\fI\%jarpy\fP) Demonstrate per\-minion client_acl. (refs: \fI\%#25408\fP)
.IP \(bu 2
cd9ea63ff2 Merge pull request \fI\%#25408\fP from rallytime/bp\-25399
.IP \(bu 2
da9c0eb673 Typo in client_acl ref doc.
.IP \(bu 2
50e0baf270 Demonstrate per\-minion client_acl.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25240\fP: (\fI\%tankywoo\fP) file make os.walk only be called one
@ \fI2015\-07\-14 16:04:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
ef9f6b0ce0 Merge pull request \fI\%#25240\fP from tankywoo/fix\-files\-os\-walk\-multiple\-times
.IP \(bu 2
8044def1c0 file make os.walk only be called one
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25395\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25389\fP to 2015.5
@ \fI2015\-07\-14 03:26:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25389\fP: (\fI\%l2ol33rt\fP) Adding entropy note for gpg renderer (refs: \fI\%#25395\fP)
.IP \(bu 2
d02f388b08 Merge pull request \fI\%#25395\fP from rallytime/bp\-25389
.IP \(bu 2
a086e5ad35 Adding entropy note
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25392\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25256\fP to 2015.5
@ \fI2015\-07\-14 03:25:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25256\fP: (\fI\%yanatan16\fP) Don\(aqt assume source_hash exists (refs: \fI\%#25392\fP)
.IP \(bu 2
008e3295c6 Merge pull request \fI\%#25392\fP from rallytime/bp\-25256
.IP \(bu 2
6b2da4d582 Don\(aqt assume source_hash exists
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25398\fP: (\fI\%twangboy\fP) Fix date
@ \fI2015\-07\-14 03:21:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
3f278963ae Merge pull request \fI\%#25398\fP from twangboy/fix_date
.IP \(bu 2
52824f9602 Added /V1 /Z to remove scheduled task after run
.IP \(bu 2
a055cca79f Changed date of scheduled task to work in other locales
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25397\fP: (\fI\%GideonRed\-zz\fP) Introduce standard error output when cli exits with non\-zero status
@ \fI2015\-07\-14 03:20:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
978d9f7117 Merge pull request \fI\%#25397\fP from GideonRed/2015.5
.IP \(bu 2
ea7ab27f31 Introduce standard error output when cli exits with non\-zero status
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24444\fP: (\fI\%michaelkrupp\fP) file.managed does not handle dead symlinks (refs: \fI\%#25383\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25386\fP: (\fI\%cachedout\fP) Lint \fI\%#25383\fP
@ \fI2015\-07\-13 21:01:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25383\fP: (\fI\%jahamn\fP) Fix manage_file function in salt/modules/file.py to handle broken sym… (refs: \fI\%#25386\fP)
.IP \(bu 2
09442abbde Merge pull request \fI\%#25386\fP from cachedout/lint_25383
.IP \(bu 2
7694299170 Lint \fI\%#25383\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24444\fP: (\fI\%michaelkrupp\fP) file.managed does not handle dead symlinks (refs: \fI\%#25383\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25383\fP: (\fI\%jahamn\fP) Fix manage_file function in salt/modules/file.py to handle broken sym… (refs: \fI\%#25386\fP)
@ \fI2015\-07\-13 20:58:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
47bcc61f55 Merge pull request \fI\%#25383\fP from jahamn/Fix\-file.managed_not_handling_dead_symlinks
.IP \(bu 2
ab17aa160e Fix manage_file function in salt/modules/file.py to handle broken symlinks
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25369\fP: (\fI\%anlutro\fP) Fix aptpkg.version_cmp
@ \fI2015\-07\-13 20:18:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
c9fe10e7aa Merge pull request \fI\%#25369\fP from alprs/fix\-apt_version_cmp
.IP \(bu 2
6391b15b3e fix aptpkg.version_cmp
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25337\fP: (\fI\%eliasp\fP) \fIsalt\-call\fP from non\-existend cwd backtraces (refs: \fI\%#25379\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25379\fP: (\fI\%jfindlay\fP) check for cwd before getting it
@ \fI2015\-07\-13 19:50:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
beb0238392 Merge pull request \fI\%#25379\fP from jfindlay/check_wd
.IP \(bu 2
6e4547ff38 check for cwd before getting it
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25320\fP: (\fI\%podloucky\-init\fP) zypper module list_upgrades broken (2015.5.2) (refs: \fI\%#25334\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25334\fP: (\fI\%jfindlay\fP) return all cmd info back to zypper fcn
@ \fI2015\-07\-13 17:03:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
274622ad9b Merge pull request \fI\%#25334\fP from jfindlay/fix_zyp
.IP \(bu 2
c1e633903e return all cmd info back to zypper fcn
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25339\fP: (\fI\%jfindlay\fP) update orchestration docs
@ \fI2015\-07\-13 16:04:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
71859c6593 Merge pull request \fI\%#25339\fP from jfindlay/orch_doc
.IP \(bu 2
0447808d95 clarify, motivate orchestration docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22241\fP: (\fI\%masterkorp\fP) Salt master not properly generating the map (refs: \fI\%#25358\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25358\fP: (\fI\%dkiser\fP) Deep merge of pillar lists (refs: \fI\%#26016\fP)
@ \fI2015\-07\-13 15:51:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
90a1ca02a3 Merge pull request \fI\%#25358\fP from dkiser/22241_pillar_merge_lists
.IP \(bu 2
d030e289b3 Deep merge of pillar lists
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25281\fP: (\fI\%shinshenjs\fP) Unless usage in Official Doc syntax error? (refs: \fI\%#25346\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25346\fP: (\fI\%bechtoldt\fP) set correct indention in states/requisites.rst (docs), fixes \fI\%#25281\fP
@ \fI2015\-07\-13 15:34:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
66c619fd71 Merge pull request \fI\%#25346\fP from bechtoldt/issue25281
.IP \(bu 2
8eb2ac1dbe set correct indention in states/requisites.rst (docs), fixes \fI\%#25281\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25336\fP: (\fI\%terminalmage\fP) Don\(aqt try to read init binary if it wasn\(aqt found
@ \fI2015\-07\-13 09:45:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
b122ed931d Merge pull request \fI\%#25336\fP from terminalmage/fix\-init\-grain
.IP \(bu 2
f473918a53 Don\(aqt try to read init binary if it wasn\(aqt found
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25350\fP: (\fI\%davidjb\fP) Fix documentation for file.blockreplace
@ \fI2015\-07\-13 03:41:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
1805bafc89 Merge pull request \fI\%#25350\fP from davidjb/patch\-4
.IP \(bu 2
e13a9fd74e Fix documentation for file.blockreplace
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19288\fP: (\fI\%oba11\fP) AssociatePublicIpAddress doesn\(aqt work with salt\-cloud 2014.7.0 (refs: \fI\%#25326\fP, \fI\%#20972\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25326\fP: (\fI\%rallytime\fP) Back\-port \fI\%#20972\fP to 2015.5
@ \fI2015\-07\-10 18:49:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#20972\fP: (\fI\%JohannesEbke\fP) Fix interface cleanup when using AssociatePublicIpAddress in \fI\%#19288\fP (refs: \fI\%#25326\fP)
.IP \(bu 2
b0196fccb7 Merge pull request \fI\%#25326\fP from rallytime/bp\-20972
.IP \(bu 2
51c941f59d Also fix cleanup of interfaces when using AssociatePublicIpAddress in \fI\%#19288\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24433\fP: (\fI\%chrimi\fP) Salt locale state fails, if locale has not been generated (refs: \fI\%#25290\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25327\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25290\fP to 2015.5
@ \fI2015\-07\-10 18:49:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25290\fP: (\fI\%pcdummy\fP) Simple fix for locale.present on Ubuntu. (refs: \fI\%#25327\fP)
.IP \(bu 2
28450d124e Merge pull request \fI\%#25327\fP from rallytime/bp\-25290
.IP \(bu 2
20032c55f3 Simple fix for locale.present on Ubuntu.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24827\fP: (\fI\%yermulnik\fP) locale.present doesn\(aqt generate locales (refs: \fI\%#25309\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25328\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25309\fP to 2015.5
@ \fI2015\-07\-10 17:22:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25309\fP: (\fI\%davidjb\fP) Format /etc/locale.gen correctly in salt.modules.localemod.gen_locale (refs: \fI\%#25328\fP)
.IP \(bu 2
8f666a24f3 Merge pull request \fI\%#25328\fP from rallytime/bp\-25309
.IP \(bu 2
44d44ec574 Format /etc/locale.gen correctly on gen_locale
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25322\fP: (\fI\%jacobhammons\fP) version change to 2015.5.3
@ \fI2015\-07\-10 16:11:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
0a33a1d8bb Merge pull request \fI\%#25322\fP from jacobhammons/release\-2015.5.3
.IP \(bu 2
19f88920fa version change to 2015.5.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25308\fP: (\fI\%jacksontj\fP) Make clear commands trace level logging
@ \fI2015\-07\-10 14:20:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24737\fP: (\fI\%jacksontj\fP) Move AES command logging to trace (refs: \fI\%#25308\fP)
.IP \(bu 2
2f0f59b6cb Merge pull request \fI\%#25308\fP from jacksontj/2015.5
.IP \(bu 2
60fc770ba2 Make clear commands trace level logging
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24520\fP: (\fI\%nvx\fP) Tomcat module fails to extract version number from snapshot builds (2015.5 regression) (refs: \fI\%#24927\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25269\fP: (\fI\%jfindlay\fP) Extract tomcat war version
@ \fI2015\-07\-10 01:28:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24927\fP: (\fI\%egarbi\fP) Tomcat module fails to extract version number from snapshot builds #2… (refs: \fI\%#25269\fP)
.IP \(bu 2
9b6646d578 Merge pull request \fI\%#25269\fP from jfindlay/tomcat
.IP \(bu 2
fd4fca172d consolidate tomcat exec and state version extract
.IP \(bu 2
59dc833567 update tomcat war_deployed state tests
.IP \(bu 2
edca458b6c Fixed 2 blank lines around import re
.IP \(bu 2
7e528d1050 Tomcat module fails to extract version number from snapshot builds \fI\%#24520\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18808\fP: (\fI\%amendlik\fP) Add command line argument to select pillar environment (refs: \fI\%#25238\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25238\fP: (\fI\%DmitryKuzmenko\fP) Pillarenv backport 2015.5
@ \fI2015\-07\-10 01:25:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
0f82ac3e30 Merge pull request \fI\%#25238\fP from DSRCompany/pillarenv_backport_2015.5
.IP \(bu 2
98792eb179 Pillarenv support in minion config, cp and cmdmod modules.
.IP \(bu 2
88ff576f39 Support pillarenv cmdline in state.sls. Backport of PR \fI\%#23719\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#13943\fP: (\fI\%Supermathie\fP) Powershell commands that expect input hang forever (refs: \fI\%#25299\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25299\fP: (\fI\%twangboy\fP) Added \-NonInteractive so powershell doesn\(aqt hang waiting for input
@ \fI2015\-07\-09 21:00:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
219d4cad9c Merge pull request \fI\%#25299\fP from twangboy/fix_13943
.IP \(bu 2
c05889031f Added \-NonInteractive so powershell doesn\(aqt hang waiting for input
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25301\fP: (\fI\%jacobhammons\fP) bug fix for module function display in help
@ \fI2015\-07\-09 20:46:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
1c43892a80 Merge pull request \fI\%#25301\fP from jacobhammons/doc\-bugs
.IP \(bu 2
f6561289af bug fix for module function display in help
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25277\fP: (\fI\%jacobhammons\fP) CherryPy recommended versions (refs: \fI\%#25279\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25279\fP: (\fI\%jacobhammons\fP) Additional docs on external and master job cache, assorted doc fixes
@ \fI2015\-07\-09 16:46:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
68149bc686 Merge pull request \fI\%#25279\fP from jacobhammons/job\-cache\-docs
.IP \(bu 2
57dfa92d5a Fixed typos
.IP \(bu 2
2f9e5b9125 Additional docs on external and master job cache, assorted doc fixes Refs \fI\%#25277\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25268\fP: (\fI\%lichtamberg\fP) Salt not working anymore in 2015.8/develop: ValueError: \(aqscope\(aq is not in list (refs: \fI\%#25274\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25274\fP: (\fI\%jleroy\fP) Fix for issue \fI\%#25268\fP
@ \fI2015\-07\-09 13:36:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25151\fP: (\fI\%jleroy\fP) Support for IPv6 addresses scopes in network.interfaces (refs: \fI\%#25274\fP, \fI\%#25433\fP)
.IP \(bu 2
972fa2fb54 Merge pull request \fI\%#25274\fP from jleroy/25268\-fix
.IP \(bu 2
2c698d204b Fix for issue \fI\%#25268\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25272\fP: (\fI\%twangboy\fP) Fixed problem with service not starting
@ \fI2015\-07\-08 23:29:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
8ebb73df2d Merge pull request \fI\%#25272\fP from twangboy/service
.IP \(bu 2
e61eeba48b Fixed problem with service not starting
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25223\fP: (\fI\%nmadhok\fP) Runner occasionally fails with a RuntimeError when fired by a reactor (refs: \fI\%#25225\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25225\fP: (\fI\%nmadhok\fP) Backporting fix for issue \fI\%#25223\fP on 2015.5 branch
@ \fI2015\-07\-08 15:16:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
c6efd2356c Merge pull request \fI\%#25225\fP from nmadhok/client\-runtime\-fix\-backport\-2015\-2
.IP \(bu 2
391b7d6730 Backporting fix for issue \fI\%#25223\fP on 2015.2 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25214\fP: (\fI\%rallytime\fP) A couple of doc fixes for the http tutorial
@ \fI2015\-07\-07 22:23:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
207fbaeac4 Merge pull request \fI\%#25214\fP from rallytime/http_doc
.IP \(bu 2
d0b61f3fc1 A couple of doc fixes for the http tutorial
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24272\fP: (\fI\%rallytime\fP) Fix boto_vpc_test moto version check (refs: \fI\%#25194\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25194\fP: (\fI\%rallytime\fP) Update moto version check in boto_vpc_test and update min version
@ \fI2015\-07\-07 18:27:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
9dd5cd8a8e Merge pull request \fI\%#25194\fP from rallytime/fix\-24272
.IP \(bu 2
f959e165a1 Clean up imports
.IP \(bu 2
fbc9c0d6bf Fix Pylint
.IP \(bu 2
fe2561f415 Update moto version check in boto_vpc_test and update min version
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25205\fP: (\fI\%basepi\fP) Update releasecandidate docs
@ \fI2015\-07\-07 15:25:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
a3e9486c28 Merge pull request \fI\%#25205\fP from basepi/releasecandidatedocs
.IP \(bu 2
452880d4aa Update releasecandidate docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25187\fP: (\fI\%UtahDave\fP) Doc fixes: Fix misspelling and remove extraneous double spaces
@ \fI2015\-07\-07 01:07:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
fbafd39a46 Merge pull request \fI\%#25187\fP from UtahDave/fix_misspelling
.IP \(bu 2
65abb63003 remove some extraneous double spaces
.IP \(bu 2
c423b62aa5 fix misspelling
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25182\fP: (\fI\%cachedout\fP) Try to re\-pack long floats as strs
@ \fI2015\-07\-07 01:06:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
ddee90ce23 Merge pull request \fI\%#25182\fP from cachedout/pack_long_floats
.IP \(bu 2
a192ecfd74 Try to re\-pack long ints as strs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23822\fP: (\fI\%sidcarter\fP) Zip file extracted permissions are incorrect (refs: \fI\%#25128\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25185\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25128\fP to 2015.5
@ \fI2015\-07\-07 00:58:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25128\fP: (\fI\%stanislavb\fP) Use cmd_unzip to preserve permissions (refs: \fI\%#25185\fP)
.IP \(bu 2
df9982b836 Merge pull request \fI\%#25185\fP from rallytime/bp\-25128
.IP \(bu 2
1726057c8a Use cmd_unzip to preserve permissions
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25181\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25102\fP to 2015.5
@ \fI2015\-07\-07 00:57:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25102\fP: (\fI\%derBroBro\fP) Update win_network.py (refs: \fI\%#25181\fP)
.IP \(bu 2
df0bb8c831 Merge pull request \fI\%#25181\fP from rallytime/bp\-25102
.IP \(bu 2
64d8f14417 Update win_network.py
.IP \(bu 2
6789c5b8e8 Update win_network.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24301\fP: (\fI\%iggy\fP) influxdb_user and influxdb_database states need virtual functions (refs: \fI\%#25059\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25179\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25059\fP to 2015.5
@ \fI2015\-07\-07 00:56:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25059\fP: (\fI\%babilen\fP) Add virtual functions to influxdb state modules (refs: \fI\%#25179\fP)
.IP \(bu 2
04fdd7b0ee Merge pull request \fI\%#25179\fP from rallytime/bp\-25059
.IP \(bu 2
1eeefbd2ab Add virtual functions to influxdb state modules
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18919\fP: (\fI\%giner\fP) Windows: pkg.refresh_db returns false\-positive success (refs: \fI\%#25196\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25196\fP: (\fI\%twangboy\fP) Fixed \fI\%#18919\fP false\-positive on pkg.refresh
@ \fI2015\-07\-07 00:24:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
58b7d0e653 Merge pull request \fI\%#25196\fP from twangboy/pkg_refresh
.IP \(bu 2
12ffcd1062 Fixed \fI\%#18919\fP false\-positive on pkg.refresh
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25180\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25088\fP to 2015.5
@ \fI2015\-07\-06 20:33:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25088\fP: (\fI\%supertom\fP) Update (refs: \fI\%#25180\fP)
.IP \(bu 2
4a406aca45 Merge pull request \fI\%#25180\fP from rallytime/bp\-25088
.IP \(bu 2
4078c8db25 added message recommending JSON file be used if the libcloud version is >= 0.17.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25191\fP: (\fI\%basepi\fP) Add extrndest back to fileclient.is_cached in 2015.5
@ \fI2015\-07\-06 19:35:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25117\fP: (\fI\%basepi\fP) Fix fileclient.is_cached (refs: \fI\%#25191\fP)
.IP \(bu 2
01ed062ca7 Merge pull request \fI\%#25191\fP from basepi/fix.fileclient.is_cached
.IP \(bu 2
5fa74f4408 Add back in the extrndest stuff (which is now in develop)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25016\fP: (\fI\%martinhoefling\fP) salt\-run doc.execution fails with AttributeError (refs: \fI\%#25020\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25175\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25020\fP to 2015.5
@ \fI2015\-07\-06 18:53:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25020\fP: (\fI\%martinhoefling\fP) Fix for issue \fI\%#25016\fP (refs: \fI\%#25175\fP)
.IP \(bu 2
a9404aea5c Merge pull request \fI\%#25175\fP from rallytime/bp\-25020
.IP \(bu 2
da2e1704ea Fix for issue \fI\%#25016\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21879\fP: (\fI\%bechtoldt\fP) Reference pages in documentation are outdated again (refs: \fI\%#25019\fP, \fI\%#21880\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#19262\fP: (\fI\%bechtoldt\fP) salt.pillar.file_tree doesn\(aqt appear in the documentation (refs: \fI\%#25019\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25173\fP: (\fI\%rallytime\fP) Partial back\-port of \fI\%#25019\fP
@ \fI2015\-07\-06 18:52:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25019\fP: (\fI\%bechtoldt\fP) add missing module documentation to references (refs: \fI\%#25173\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24421\fP: (\fI\%bechtoldt\fP) add missing module documentation  (refs: \fI\%#25019\fP)
.IP \(bu 2
\fBPR\fP \fI\%#21880\fP: (\fI\%bechtoldt\fP) update references, fixes \fI\%#21879\fP (refs: \fI\%#25019\fP)
.IP \(bu 2
\fBPR\fP \fI\%#20039\fP: (\fI\%bechtoldt\fP) completing some doc references (refs: \fI\%#25019\fP)
.IP \(bu 2
c70fec65b8 Merge pull request \fI\%#25173\fP from rallytime/partial\-bp\-25019
.IP \(bu 2
c0c2463b64 Partial backport of \fI\%#25019\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25171\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25001\fP to 2015.5
@ \fI2015\-07\-06 18:51:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25001\fP: (\fI\%jasonkeene\fP) Add docs for key arg in ssh_known_hosts.present (refs: \fI\%#25171\fP)
.IP \(bu 2
c5ba9a90ba Merge pull request \fI\%#25171\fP from rallytime/bp\-25001
.IP \(bu 2
a891108793 Add docs for key arg in ssh_known_hosts.present
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25170\fP: (\fI\%rallytime\fP) Back\-port \fI\%#24982\fP to 2015.5
@ \fI2015\-07\-06 16:34:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24982\fP: (\fI\%asyncsrc\fP) ec2 network_interfaces fix (refs: \fI\%#25170\fP)
.IP \(bu 2
3e06602545 Merge pull request \fI\%#25170\fP from rallytime/bp\-24982
.IP \(bu 2
3e6eab3ae9 ec2 network_interfaces fix
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25161\fP: (\fI\%aneeshusa\fP) Allow checking for non\-normalized systemd units.
@ \fI2015\-07\-06 15:15:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
09602808a0 Merge pull request \fI\%#25161\fP from aneeshusa/allow\-checking\-non\-normalized\-systemd\-service\-availability
.IP \(bu 2
b4d544fe70 Allow checking for non\-normalized systemd units.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25151\fP: (\fI\%jleroy\fP) Support for IPv6 addresses scopes in network.interfaces (refs: \fI\%#25274\fP, \fI\%#25433\fP)
@ \fI2015\-07\-06 14:43:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
3599b8abab Merge pull request \fI\%#25151\fP from jleroy/ipv6\-scope\-support
.IP \(bu 2
edce034e6c Support for IPv6 addresses scopes in network.interfaces
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24979\fP: (\fI\%mavenAtHouzz\fP) [Discussion] Support for more than 1 netapi.rest_tornado server process (refs: \fI\%#25149\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25166\fP: (\fI\%cachedout\fP) Lint \fI\%#25149\fP
@ \fI2015\-07\-06 14:40:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25149\fP: (\fI\%jacksontj\fP) Saltnado multiprocess support (refs: \fI\%#25166\fP)
.IP \(bu 2
66d6365a9f Merge pull request \fI\%#25166\fP from cachedout/lint_saltnado
.IP \(bu 2
2fe167edf8 Lint \fI\%#25149\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24979\fP: (\fI\%mavenAtHouzz\fP) [Discussion] Support for more than 1 netapi.rest_tornado server process (refs: \fI\%#25149\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25149\fP: (\fI\%jacksontj\fP) Saltnado multiprocess support (refs: \fI\%#25166\fP)
@ \fI2015\-07\-06 14:38:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
2f1bad1c01 Merge pull request \fI\%#25149\fP from jacksontj/saltnado
.IP \(bu 2
6aa5548e2d Enable multiprocess support in saltnado
.IP \(bu 2
9a1351eada Change print to logger, so we can set a level and log exc_info
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25120\fP: (\fI\%d\-\-j\fP) add missing continue for exception case
@ \fI2015\-07\-02 19:38:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
a723af0f10 Merge pull request \fI\%#25120\fP from d\-\-j/patch\-2
.IP \(bu 2
81d5d15dce add missing continue for error case
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25117\fP: (\fI\%basepi\fP) Fix fileclient.is_cached (refs: \fI\%#25191\fP)
@ \fI2015\-07\-02 19:38:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
6e2222241a Merge pull request \fI\%#25117\fP from basepi/fix.fileclient.is_cached
.IP \(bu 2
38e243fdfb Add fix from merge forward
.IP \(bu 2
52f35f761a Add import
.IP \(bu 2
23c32a7518 Backport develop version of salt.fileclient.is_cached
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25087\fP: (\fI\%0xf10e\fP) Fix execution module for glance \- now based on 2015.5!
@ \fI2015\-07\-02 19:36:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
c80990ba4f Merge pull request \fI\%#25087\fP from 0xf10e/fix_glance_2015.5
.IP \(bu 2
7749cc081c PEP8 W601...
.IP \(bu 2
bbda079fa5 fix pylint E302, E502, E713, E1305
.IP \(bu 2
3baacc72b4 use Glance API v1 for image_create
.IP \(bu 2
c3d6134da1 making pylint marginally happier
.IP \(bu 2
19a20bf228 get valid properties for image_show() from the schema for \(dqimage\(dq
.IP \(bu 2
0c6a61173a add some debugging, fix a few AttributeErrors
.IP \(bu 2
aceca0e20d fix return of glance.image_show()
.IP \(bu 2
a47509e7dd fix return of image_list
.IP \(bu 2
9f923edfab Change confusing \(dqnt_ks\(dq to \(dqg_client\(dq
.IP \(bu 2
fa2bd1a79c bit of docs/comments in image_create()
.IP \(bu 2
5c34d0c494 merge 439b1e42053239b into 2015.5
.IP \(bu 2
7a3cf27948 update attributes for image_show output
.IP \(bu 2
b1bec0f1a1 fix retry w/ user/pass if token fails
.IP \(bu 2
2f4ef6683c update attributes for image_list output
.IP \(bu 2
eef3bc7048 use _auth() from neutron plus keystoneclient,
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25129\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-07\-02 17:37:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
549ee47420 Merge pull request \fI\%#25129\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
187268d879 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
36d53ef59e Merge pull request \fI\%#25093\fP from jaybocc2/2014.7
.INDENT 2.0
.IP \(bu 2
c6a501ebda quick fix for issue \fI\%#18447\fP
.UNINDENT
.IP \(bu 2
38903a94a1 Merge pull request \fI\%#25069\fP from puneetk/patch\-1
.IP \(bu 2
f0b4e600e6 Update Documentation to clarify version added
.IP \(bu 2
f8dc6030e7 Pylint updates , removing whitespace
.IP \(bu 2
532d315dd1 [Code Review update] renamed function to is_enaled from list_enabled
.IP \(bu 2
20b0462289 Update schedule.py
.IP \(bu 2
4f1471d7fb Add a helper module function called list_enabled
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#24798\fP: (\fI\%justinta\fP) Revert \(dqadding states/postgres_database unit test case.\(dq (refs: \fI\%#25114\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#24329\fP: (\fI\%jayeshka\fP) adding states/postgres_database unit test case. (refs: #\(gasaltstack/salt#24798\(ga_)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25114\fP: (\fI\%jfindlay\fP) Revert \(dqRevert \(dqadding states/postgres_database unit test case.\(dq\(dq
@ \fI2015\-07\-02 01:01:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
86f2791fdb Merge pull request \fI\%#25114\fP from saltstack/revert\-24798\-revert\-24329\-postgres_database\-states\-unit\-test
.IP \(bu 2
071ee44d41 Revert \(dqRevert \(dqadding states/postgres_database unit test case.\(dq\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24362\fP: (\fI\%jayeshka\fP) adding states/postgres_user unit test case.
@ \fI2015\-07\-01 21:45:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf8c7e7a9d Merge pull request \fI\%#24362\fP from jayeshka/postgres_user\-states\-unit\-test
.IP \(bu 2
fd1d834688 adding states/postgres_user unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24361\fP: (\fI\%jayeshka\fP) adding states/postgres_schema unit test case.
@ \fI2015\-07\-01 21:44:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
4195cea512 Merge pull request \fI\%#24361\fP from jayeshka/postgres_schema\-states\-unit\-test
.IP \(bu 2
0558b0d744 adding states/postgres_schema unit test case.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24331\fP: (\fI\%jayeshka\fP) adding states/postgres_extension unit test case.
@ \fI2015\-07\-01 21:43:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
ada8fe57d4 Merge pull request \fI\%#24331\fP from jayeshka/postgres_extension\-states\-unit\-test
.IP \(bu 2
3d465a574a adding states/postgres_extension unit test case.
.UNINDENT
.UNINDENT
.SS Salt 2015.5.5 Release Notes
.INDENT 0.0
.TP
.B release
2015\-08\-20
.UNINDENT
.sp
Version 2015.5.5 is a bugfix release for \fI\%2015.5.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB33\fP
.IP \(bu 2
Total Issue References: \fB28\fP
.IP \(bu 2
Total PR References: \fB39\fP
.IP \(bu 2
Contributors: \fB20\fP (\fI\%TheBigBear\fP, \fI\%arthurlogilab\fP, \fI\%basepi\fP, \fI\%bastiaanb\fP, \fI\%cachedout\fP,
\fI\%driskell\fP, \fI\%garethgreenaway\fP, \fI\%jacobhammons\fP, \fI\%jahamn\fP, \fI\%jfindlay\fP, \fI\%rallytime\fP,
\fI\%s0undt3ch\fP, \fI\%scottjpack\fP, \fI\%silenius\fP, \fI\%sixninetynine\fP, \fI\%stanislavb\fP, \fI\%terminalmage\fP,
\fI\%thusoy\fP, \fI\%twangboy\fP, \fI\%vr\-jack\fP)
.UNINDENT
.SS Changelog for v2015.5.4..v2015.5.5
.sp
\fIGenerated at: 2018\-05\-27 22:04:18 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBISSUE\fP \fI\%#26484\fP: (\fI\%thusoy\fP) Git state leaks HTTPS user/pw to log (refs: \fI\%#26486\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26482\fP: (\fI\%thusoy\fP) Git states doesn\(aqt allow user\-only auth (refs: \fI\%#26483\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26486\fP: (\fI\%thusoy\fP) Git: Don\(aqt leak https user/pw to log
@ \fI2015\-08\-20 16:04:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26483\fP: (\fI\%thusoy\fP) Handle user\-only http auth in git module (refs: \fI\%#26486\fP)
.IP \(bu 2
28aa9b1058 Merge pull request \fI\%#26486\fP from thusoy/git\-confidential\-auth
.IP \(bu 2
5289165487 Git: Don\(aqt leak https user/pw to log
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26432\fP: (\fI\%centromere\fP) Documentation incorrectly references salt\-key on the minion (refs: \fI\%#26476\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26403\fP: (\fI\%adelcast\fP) Grains documentation incorrectly states they are static (refs: \fI\%#26476\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26329\fP: (\fI\%cro\fP) Add note to eauth docs indicating default PAM service. (refs: \fI\%#26476\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26264\fP: (\fI\%grep4linux\fP) state trees cannot have \(aqdots\(aq in the name (refs: \fI\%#26476\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26233\fP: (\fI\%dove\-young\fP) pip install salt, then start master failed on Fedora 22 (refs: \fI\%#26476\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26476\fP: (\fI\%jacobhammons\fP) Minor doc bug fixes
@ \fI2015\-08\-19 22:52:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
679ba5ee0a Merge pull request \fI\%#26476\fP from jacobhammons/doc\-bugs
.IP \(bu 2
499bd66378 Minor doc bug fixes Refs \fI\%#26403\fP Refs \fI\%#26432\fP Refs \fI\%#26233\fP Refs \fI\%#26264\fP Refs \fI\%#26329\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26366\fP: (\fI\%GreatSnoopy\fP) The development tree produces hanging, 100%cpu salt\-master processes (refs: \fI\%#26443\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26301\fP: (\fI\%waynew\fP) CPU pegged out running salt\-master (after running command)  (refs: \fI\%#26443\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#25998\fP: (\fI\%driskell\fP) Event subsystem discarding required events during \-\-batch breaking it for slow running commands (refs: \fI\%#26000\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26443\fP: (\fI\%cachedout\fP) Fix connect issue in event init
@ \fI2015\-08\-19 22:50:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26000\fP: (\fI\%driskell\fP) Implement full event caching for subscribed tags (refs: \fI\%#26443\fP)
.IP \(bu 2
42b8c1b3f4 Merge pull request \fI\%#26443\fP from cachedout/fix_event_sub
.IP \(bu 2
560977bc7e Fix connect issue in event init
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26343\fP: (\fI\%jfindlay\fP) batch error when no minions match target (refs: \fI\%#26445\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26445\fP: (\fI\%cachedout\fP) Raise clean error when no minions targeted in batch mode
@ \fI2015\-08\-19 22:50:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
d2df1a86ad Merge pull request \fI\%#26445\fP from cachedout/issue_26343
.IP \(bu 2
1600f3eccd Raise clean error when no minions targeted in batch mode
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26482\fP: (\fI\%thusoy\fP) Git states doesn\(aqt allow user\-only auth (refs: \fI\%#26483\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26483\fP: (\fI\%thusoy\fP) Handle user\-only http auth in git module (refs: \fI\%#26486\fP)
@ \fI2015\-08\-19 22:47:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
a9b28e9577 Merge pull request \fI\%#26483\fP from thusoy/git\-user\-only\-auth
.IP \(bu 2
09fc934acc Handle user\-only http auth in git module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26496\fP: (\fI\%jfindlay\fP) add dateutil dependency reporting
@ \fI2015\-08\-19 22:46:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
edc04930ae Merge pull request \fI\%#26496\fP from jfindlay/dateutil
.IP \(bu 2
cbe330e78b add dateutil dependency reporting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26494\fP: (\fI\%cachedout\fP) Remove unnecessary debug statements
@ \fI2015\-08\-19 20:46:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
4fff53b842 Merge pull request \fI\%#26494\fP from cachedout/remove_debug_statements
.IP \(bu 2
d717a43dcc Remove unnecessary debug statements
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26465\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26457\fP to 2015.5
@ \fI2015\-08\-19 16:08:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26457\fP: (\fI\%arthurlogilab\fP) docstring improvement for network.ping module execution (refs: \fI\%#26465\fP)
.IP \(bu 2
f46a0dab5d Merge pull request \fI\%#26465\fP from rallytime/bp\-26457
.IP \(bu 2
b3f638ff0f docstring improvement for network.ping module execution
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26434\fP: (\fI\%s0undt3ch\fP) Fix missed typo
@ \fI2015\-08\-18 18:14:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
c1458980f3 Merge pull request \fI\%#26434\fP from s0undt3ch/2015.5
.IP \(bu 2
06dcaefcaa Fix missed typo
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26426\fP: (\fI\%alxbse\fP) Private/public IPs are interchanged when listing nova driver cloud nodes (refs: \fI\%#26430\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26430\fP: (\fI\%rallytime\fP) List public and private ips under the correct label
@ \fI2015\-08\-18 16:20:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
0f64be710f Merge pull request \fI\%#26430\fP from rallytime/fix\-26426
.IP \(bu 2
2ba97316c9 List public and private ips under the correct label
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26431\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26417\fP to 2015.5
@ \fI2015\-08\-18 15:41:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26417\fP: (\fI\%scottjpack\fP) Changed t1 \-> t2 micro (refs: \fI\%#26431\fP)
.IP \(bu 2
913451a414 Merge pull request \fI\%#26431\fP from rallytime/bp\-26417
.IP \(bu 2
0254a2e90e Changed t1 \-> t2 micro
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26378\fP: (\fI\%stanislavb\fP) Fix EC2 credentials from IAM roles for s3fs and s3 ext_pillar in 2015.5
@ \fI2015\-08\-18 14:01:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
952da7abaf Merge pull request \fI\%#26378\fP from stanislavb/2015.5
.IP \(bu 2
39ce3127cd Let utils.aws query instance metadata
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26245\fP: (\fI\%bradthurber\fP) salt v2015.5.3 gitfs.py using newer pygit2 feature than required minimum (refs: \fI\%#26420\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26420\fP: (\fI\%terminalmage\fP) Only use pygit2.errors if it exists (2015.5 branch)
@ \fI2015\-08\-18 14:00:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
09e96dce39 Merge pull request \fI\%#26420\fP from terminalmage/issue26245\-2015.5
.IP \(bu 2
19a1149067 Only use pygit2.errors if it exists (2015.5 branch)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26409\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-08\-17 23:19:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
c5eb6bbd3e Merge pull request \fI\%#26409\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
dafed10a9e Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
da8bca09aa Merge pull request \fI\%#26242\fP from cro/anonldap4
.INDENT 2.0
.IP \(bu 2
a0d2ab1eed Remove dead code
.UNINDENT
.IP \(bu 2
1ecf23773e Merge pull request \fI\%#26216\fP from cro/anonldap3
.IP \(bu 2
af132d7b89 Documentation update for anonymous bind issue.
.IP \(bu 2
2ef54b6b13 Documentation update for anonymous bind issue.
.IP \(bu 2
5b1836bb00 Fix issue with LDAP anonymous binds.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26404\fP: (\fI\%ssgward\fP) Syntax error in lvm.vg_absent state causing failure (refs: \fI\%#26406\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26406\fP: (\fI\%jfindlay\fP) fix syntax error in lvm exec module
@ \fI2015\-08\-17 21:18:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
741ca6b4db Merge pull request \fI\%#26406\fP from jfindlay/lvm
.IP \(bu 2
81d351ff8f fix syntax error in lvm exec module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26405\fP: (\fI\%TheBigBear\fP) dependency zip files moved to new site
@ \fI2015\-08\-17 21:17:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
a7e2d30e2a Merge pull request \fI\%#26405\fP from TheBigBear/patch\-8
.IP \(bu 2
8898d64918 dependency zip files moved to new site
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26298\fP: (\fI\%vr\-jack\fP) Keep $HOME from being interpretted by Master shell
@ \fI2015\-08\-17 21:15:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
cf0523a12e Merge pull request \fI\%#26298\fP from vr\-jack/2015.5
.IP \(bu 2
1fd6fc6ce3 Keep $HOME from being interpretted by Master shell
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26324\fP: (\fI\%s0undt3ch\fP) Salt is now pip install\(aqable in windows
@ \fI2015\-08\-17 20:41:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
c0811d3302 Merge pull request \fI\%#26324\fP from s0undt3ch/2015.5
.IP \(bu 2
e7cb3be2a0 Document the added options
.IP \(bu 2
92af1c9572 Fix argument name
.IP \(bu 2
72d2fdb512 Add \fIpypiwin32 >= 219\fP as a windows install requires.
.IP \(bu 2
b1105fc706 Allow mimicking the install setup command for develop/editable installations.
.IP \(bu 2
26246a72ee Allow writing Salt\(aqs _version.py when installing in develop mode.
.IP \(bu 2
71928f2194 Prefer HTTPS, fix url argument
.IP \(bu 2
7b25430cc7 Download the necessary DLLs for windows
.IP \(bu 2
86692a92cd Install PyCrypto from a wheel in repo.saltstack.com under Windows
.IP \(bu 2
915da594c2 Skip M2Crypto in Windows.
.IP \(bu 2
1ea426e299 Move code to properly handle default requirements.
.IP \(bu 2
8fda8c0db3 M2CryptoWin{32,64} should only be installed on Salt < 2015.8.0
.IP \(bu 2
0ff2f19aee Override the develop command in cmdclass
.IP \(bu 2
a5aa752a85 Override the develop command when WITH_SETUPTOOLS is set
.IP \(bu 2
4d6841c761 Install M2CryptoWin{32,64} while installing Salt
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26161\fP: (\fI\%bastiaanb\fP) salt initscripts do not set lock file in /var/lock/subsys as required on RedHat family OSes (refs: \fI\%#26371\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26371\fP: (\fI\%bastiaanb\fP) fix issue \fI\%#26161\fP: on RedHat family systems touch /var/lock/subsys/$SE…
@ \fI2015\-08\-17 20:39:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
87151736c5 Merge pull request \fI\%#26371\fP from bastiaanb/fix/issue\-26161\-salt\-initscripts\-dont\-set\-lockfile
.IP \(bu 2
ec8d4b0470 test whether RETVAL is 0 with \-eq rather than =.
.IP \(bu 2
a83a5de41e fix issue \fI\%#26161\fP: on RedHat family systems touch /var/lock/subsys/$SERVICE to ensure the daemon will be stopped on shutdown.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25801\fP: (\fI\%themalkolm\fP) Update docs that salt.states.winrepo requires \fIroles:salt\-master\fP in grains. (refs: \fI\%#26328\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#25562\fP: (\fI\%jefftucker\fP) winrepo state does not run on masterless minion (refs: \fI\%#26328\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26402\fP: (\fI\%twangboy\fP) Removed documentation no longer required
@ \fI2015\-08\-17 20:35:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26328\fP: (\fI\%twangboy\fP) Removed salt\-master role requirement (refs: \fI\%#26402\fP)
.IP \(bu 2
89602f56ad Merge pull request \fI\%#26402\fP from twangboy/fix_26328
.IP \(bu 2
ad5fa03b76 Removed documentation no longer required
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26392\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26376\fP to 2015.5
@ \fI2015\-08\-17 19:39:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26376\fP: (\fI\%TheBigBear\fP) minor edit spelling (refs: \fI\%#26392\fP)
.IP \(bu 2
eb373e5904 Merge pull request \fI\%#26392\fP from rallytime/bp\-26376
.IP \(bu 2
a013bb5b3d minor edit
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#16049\fP: (\fI\%ryan\-lane\fP) boto_elb.present state requires attributes argument (refs: \fI\%#26342\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26342\fP: (\fI\%rallytime\fP) Don\(aqt call boto_elb._attributes_present if no attributes were provided
@ \fI2015\-08\-17 19:19:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
8bb57d1631 Merge pull request \fI\%#26342\fP from rallytime/fix\-16049
.IP \(bu 2
211f6feaf5 Fix test failures \- get_attributes shouldn\(aqt be called if none are provided
.IP \(bu 2
d8ad023e88 Don\(aqt call boto_elb._attributes_present if no attributes were provided
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26155\fP: (\fI\%silenius\fP) pip availability in states/pip_state (refs: \fI\%#26160\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26389\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26160\fP to 2015.5
@ \fI2015\-08\-17 19:09:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26160\fP: (\fI\%silenius\fP) proposed fix for \fI\%#26155\fP (refs: \fI\%#26389\fP)
.IP \(bu 2
2fd1e06343 Merge pull request \fI\%#26389\fP from rallytime/bp\-26160
.IP \(bu 2
f0bc3765d9 No logging should happen on __virtual__
.IP \(bu 2
ca406eaf3c proposed fix for \fI\%#26155\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26266\fP: (\fI\%o\-sleep\fP) limit pw_user.getent() from returning entire corporate list (refs: \fI\%#26300\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26300\fP: (\fI\%jfindlay\fP) mock pwd function calls in pw_user exec module
@ \fI2015\-08\-17 18:56:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
0046c6cfed Merge pull request \fI\%#26300\fP from jfindlay/pw_test
.IP \(bu 2
7e94989403 mock pwd calls in pw_user exec mod test
.IP \(bu 2
26f5b466f5 check for pwd on linux and BSD user exec mods
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24334\fP: (\fI\%afletch\fP) autosign_timeout not honoured (refs: \fI\%#26386\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26386\fP: (\fI\%jahamn\fP) Fixes autosign_timeout usage in check_autosign_dir
@ \fI2015\-08\-17 18:34:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
709499438b Merge pull request \fI\%#26386\fP from jahamn/fix\-autosign_timeout
.IP \(bu 2
b2fa2ac9d3 Fixes autosign_timeout usage in check_autosign_dir
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25801\fP: (\fI\%themalkolm\fP) Update docs that salt.states.winrepo requires \fIroles:salt\-master\fP in grains. (refs: \fI\%#26328\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#25562\fP: (\fI\%jefftucker\fP) winrepo state does not run on masterless minion (refs: \fI\%#26328\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26328\fP: (\fI\%twangboy\fP) Removed salt\-master role requirement (refs: \fI\%#26402\fP)
@ \fI2015\-08\-17 18:30:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
8d901d7b15 Merge pull request \fI\%#26328\fP from twangboy/fix_25562
.IP \(bu 2
d4ca1dccbf Removed salt\-master role requirement
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26327\fP: (\fI\%bradthurber\fP) mount.mounted opts incorrect \(dqforced unmount and mount because options (tcp) changed\(dq (refs: \fI\%#26362\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26362\fP: (\fI\%garethgreenaway\fP) Fixes to mount state.
@ \fI2015\-08\-17 17:44:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
74558f5743 Merge pull request \fI\%#26362\fP from garethgreenaway/2015_5_26327_more_invisible_mount_options
.IP \(bu 2
cf532d46dd Some mount options are translated to different options once a share has been mounted, eg. when specifying a protocol for NFS as either tcp or udp this option is translated into either proto=tcp or proto=udp.  Change adds a lookup dictionary for these options so that a re\-mount isn\(aqt forced each time.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26379\fP: (\fI\%s0undt3ch\fP) [2015.5] Backport \fI\%#26353\fP
@ \fI2015\-08\-17 17:19:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26353\fP: (\fI\%sixninetynine\fP) fixed a typo in setup.py (refs: \fI\%#26379\fP)
.IP \(bu 2
7dbbd90c98 Merge pull request \fI\%#26379\fP from s0undt3ch/issues/backport\-26353
.IP \(bu 2
33ed315c85 fixed Packaing \-> Packaging typo and added a couple comments on the setuptools/distutils abstract methods
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26240\fP: (\fI\%0xf10e\fP) keystone.user_get raises exception when user is not found (refs: \fI\%#26277\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26277\fP: (\fI\%rallytime\fP) Handle exception when user is not found in keystone.user_get
@ \fI2015\-08\-14 19:41:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
bcca1b4c5a Merge pull request \fI\%#26277\fP from rallytime/fix\-26240
.IP \(bu 2
0b6977335e Clean it up
.IP \(bu 2
5edabfd271 It\(aqs a dict \- git problems...
.IP \(bu 2
39d3eb66f0 Log error and return error \- make returns consistent.
.IP \(bu 2
496474d862 Handle exception when user is not found in keystone.get_user
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24484\fP: (\fI\%bailsman\fP) clouds/ec2.py: create_snapshot throws exception (refs: \fI\%#26326\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26326\fP: (\fI\%rallytime\fP) Make ec2.create_snapshot return less unweildly and more relevant
@ \fI2015\-08\-14 19:40:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
78be3a826f Merge pull request \fI\%#26326\fP from rallytime/create_snapshot_return
.IP \(bu 2
c5395db851 Make ec2.create_snapshot return less unweildly and more relevant
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#16179\fP: (\fI\%UtahDave\fP) Salt Cloud \-l debug includes the entire bootstrap script twice in its output (refs: \fI\%#26306\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26306\fP: (\fI\%rallytime\fP) Move VM creation details dict to log.trace
@ \fI2015\-08\-14 17:39:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
44c9d3063b Merge pull request \fI\%#26306\fP from rallytime/fix\-16179
.IP \(bu 2
670464258f Move VM creation details dict to log.trace
.UNINDENT
.UNINDENT
.SS Salt 2015.5.6 Release Notes
.INDENT 0.0
.TP
.B release
2015\-10\-13
.UNINDENT
.sp
Version 2015.5.6 is a bugfix release for \fI\%2015.5.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB145\fP
.IP \(bu 2
Total Issue References: \fB71\fP
.IP \(bu 2
Total PR References: \fB178\fP
.IP \(bu 2
Contributors: \fB53\fP (\fI\%Arabus\fP, \fI\%JensRantil\fP, \fI\%PierreR\fP, \fI\%SaltyCharles\fP, \fI\%TheBigBear\fP,
\fI\%abh\fP, \fI\%aboe76\fP, \fI\%anlutro\fP, \fI\%arthurlogilab\fP, \fI\%aspyatkin\fP, \fI\%basepi\fP, \fI\%benhosmer\fP,
\fI\%bersace\fP, \fI\%cachedout\fP, \fI\%carlpett\fP, \fI\%damonzheng\fP, \fI\%derphilipp\fP, \fI\%dmyerscough\fP, \fI\%dsumsky\fP,
\fI\%efficks\fP, \fI\%eguven\fP, \fI\%garethgreenaway\fP, \fI\%hexedpackets\fP, \fI\%jacksontj\fP, \fI\%jacobhammons\fP,
\fI\%jfindlay\fP, \fI\%joejulian\fP, \fI\%johanek\fP, \fI\%julianbrost\fP, \fI\%kev009\fP, \fI\%lorengordon\fP, \fI\%madprog\fP,
\fI\%marccardinal\fP, \fI\%netroby\fP, \fI\%nmadhok\fP, \fI\%plastikos\fP, \fI\%rallytime\fP, \fI\%serge\-p\fP, \fI\%spudfkc\fP,
\fI\%stanislavb\fP, \fI\%styro\fP, \fI\%systembell\fP, \fI\%tankywoo\fP, \fI\%techhat\fP, \fI\%terminalmage\fP, \fI\%thatch45\fP,
\fI\%tjstansell\fP, \fI\%twangboy\fP, \fI\%vakulich\fP, \fI\%vtek21\fP, \fI\%whiteinge\fP, \fI\%zmalone\fP, \fI\%zyio\fP)
.UNINDENT
.SS Security Fixes
.sp
\fBCVE\-2015\-6941\fP The Windows \fI\%user\fP module and
\fBsalt\-cloud\fP display passwords in log when log level is set to \fBdebug\fP
or more verbose.
.sp
For the Windows \fI\%user\fP module, the password is
now replaced with the string \fBXXX\-REDACTED\-XXX\fP\&.
.sp
For salt\-cloud, debug logging no longer displays \fBwin_password\fP and
\fBsudo_password\fP authentication credentials.
.sp
\fBCVE\-2015\-6918\fP Git state/execution modules log HTTPS auth credentials when
log level is set to \fBdebug\fP or more verbose.
.sp
These credentials are now replaced with \fBREDACTED\fP in the debug output.
Thanks to Andreas Stieger <\fI\%asteiger@suse.com\fP> for bringing this to our
attention.
.SS Changelog for v2015.5.5..v2015.5.6
.sp
\fIGenerated at: 2018\-05\-27 22:13:00 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#27582\fP: (\fI\%jfindlay\fP) add 2015.5.6 release notes
@ \fI2015\-09\-30 22:33:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
304dc68f7f Merge pull request \fI\%#27582\fP from jfindlay/2015.5
.IP \(bu 2
4f0d55cda6 add 2015.5.6 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27518\fP: (\fI\%srkunze\fP) [Docs] Relationship between Mine and Grains (refs: \fI\%#27557\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27557\fP: (\fI\%jfindlay\fP) add doc motivating mine vs grains
@ \fI2015\-09\-30 17:49:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
7201ce71e4 Merge pull request \fI\%#27557\fP from jfindlay/mine_doc
.IP \(bu 2
3727d79bad edit mine doc for style and markup
.IP \(bu 2
7e037a4666 add doc motivating mine vs grains
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27478\fP: (\fI\%rominf\fP) iptables state fails to save rules  (refs: \fI\%#27515\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27515\fP: (\fI\%jfindlay\fP) save iptables rules on SuSE
@ \fI2015\-09\-30 16:09:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
59c3d5f93e Merge pull request \fI\%#27515\fP from jfindlay/suse_fire
.IP \(bu 2
4460ad2785 save iptables rules on SuSE
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27460\fP: (\fI\%llevar\fP) Orchestrate runner not resolving reference to a built in state (refs: \fI\%#27509\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27509\fP: (\fI\%jfindlay\fP) tell the user why the gluster module does not work
@ \fI2015\-09\-30 15:49:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
9b26357b19 Merge pull request \fI\%#27509\fP from jfindlay/gluster_reason
.IP \(bu 2
1ccda538d2 tell the user why the gluster module does not work
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27372\fP: (\fI\%GregMeno\fP) pip.installed state fails when env_vars is not a dict (refs: \fI\%#27379\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27379\fP: (\fI\%jfindlay\fP) document and check dict type for pip env_vars
@ \fI2015\-09\-30 02:56:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
989733ea86 Merge pull request \fI\%#27379\fP from jfindlay/pip_vars
.IP \(bu 2
aee51ffdef document and check dict type for pip env_vars
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27516\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-09\-29 17:53:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
6d773f66c3 Merge pull request \fI\%#27516\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
a08951f0fa Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
5262f01325 Merge pull request \fI\%#27335\fP from rallytime/cloud\-logging\-7
.INDENT 2.0
.IP \(bu 2
adeb1dcad4 Pylint Fix
.IP \(bu 2
588c13783c Salt\-cloud logging clean up for windows functions
.IP \(bu 2
9b6000135c [2014.7] Fixup salt\-cloud logging
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27447\fP: (\fI\%junster1\fP) Fix mysql table size for salt_events (refs: \fI\%#27472\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27472\fP: (\fI\%cachedout\fP) Change recommended schema for data field in mysql event table
@ \fI2015\-09\-29 15:49:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
68d784c3dd Merge pull request \fI\%#27472\fP from cachedout/fix_27447
.IP \(bu 2
5e745ad6da Change recommended schema for data field in mysql event table
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27468\fP: (\fI\%cachedout\fP) Fix 27351
@ \fI2015\-09\-29 15:35:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27351\fP: (\fI\%SaltyCharles\fP) fix sysctl truncating newline on os x (refs: \fI\%#27468\fP)
.IP \(bu 2
ee6e0ed057 Merge pull request \fI\%#27468\fP from cachedout/fix_27351
.IP \(bu 2
0bc37c0d41 Fix test
.IP \(bu 2
f9a19720de fix sysctl truncating newline on os x
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27438\fP: (\fI\%aboe76\fP) can\(aqt set system locale on OpenSuse SUse (refs: \fI\%#27479\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27479\fP: (\fI\%aboe76\fP) fix locale on opensuse and suse \fI\%#27438\fP
@ \fI2015\-09\-29 15:34:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
a214c7f84e Merge pull request \fI\%#27479\fP from aboe76/fix_locale_suse
.IP \(bu 2
a8f2dad1be fix locale on opensuse and suse \fI\%#27438\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#17103\fP: (\fI\%arthurlogilab\fP) salt is looking for outputters in /var/cache/salt/minion/extmods/output not /var/cache/salt/minion/extmods/outputputters (refs: \fI\%#27483\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27483\fP: (\fI\%rallytime\fP) Outputters should sync to output, not outputters, on the minion.
@ \fI2015\-09\-29 15:33:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
931f593b51 Merge pull request \fI\%#27483\fP from rallytime/fix\-17103
.IP \(bu 2
441241eb90 Change sync_outputters to sync_output for consistency, but alias sync_outputters
.IP \(bu 2
105528720b Outputters should sync to output, not outputters, on the minion.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27484\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27434\fP and \fI\%#27470\fP to 2015.5
@ \fI2015\-09\-29 15:32:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27470\fP: (\fI\%cachedout\fP) Minor doc fixup. (refs: \fI\%#27484\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27434\fP: (\fI\%netroby\fP) Doc: copy key to server via ssh\-copy\-id (refs: \fI\%#27484\fP, \fI\%#27470\fP)
.IP \(bu 2
9c2c028953 Merge pull request \fI\%#27484\fP from rallytime/bp\-27434\-and\-27470
.IP \(bu 2
5de2ee35ab Minor doc fixup.
.IP \(bu 2
af656c7e87 Doc: copy key to server via ssh\-copy\-id
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27433\fP: (\fI\%TheBigBear\fP) winrepo \- drops \(dqtrailing zeroes\(dq from version numbers on un\-install? (refs: \fI\%#27469\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27469\fP: (\fI\%twangboy\fP) Added quotes to version numbers example
@ \fI2015\-09\-28 21:54:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
927874d316 Merge pull request \fI\%#27469\fP from twangboy/fix_27433
.IP \(bu 2
a996ea46e2 Added quotes to version numbers example
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27342\fP: (\fI\%ariscn\fP) File.managed silent fail for contents_pillar (refs: \fI\%#27375\fP, \fI\%#27467\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27467\fP: (\fI\%cachedout\fP) file.managed: check contents_{pillar|grain} result
@ \fI2015\-09\-28 20:22:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27375\fP: (\fI\%jfindlay\fP) file.managed: check contents_{pillar|grain} result (refs: \fI\%#27467\fP)
.IP \(bu 2
382a53403f Merge pull request \fI\%#27467\fP from cachedout/lint_27375
.IP \(bu 2
4e54a98f5e Lint \fI\%#27375\fP
.IP \(bu 2
278ade52d2 file.managed: check contents_{pillar|grain} result
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#9856\fP: (\fI\%jeremyBass\fP) for grant in grants: TypeError: \(aqbool\(aq object is not iterable (refs: \fI\%#27419\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27419\fP: (\fI\%rallytime\fP) Amend error log to include multiple tips for troubleshooting.
@ \fI2015\-09\-28 17:53:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
ed6207a438 Merge pull request \fI\%#27419\fP from rallytime/fix\-9856
.IP \(bu 2
551396564a Amend error log to include multiple tips for troubleshooting.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#16753\fP: (\fI\%johtso\fP) Duplicate selector in top file gives unhelpful traceback (refs: \fI\%#27426\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27426\fP: (\fI\%rallytime\fP) Don\(aqt stacktrace if there are conflicting id errors in highstate
@ \fI2015\-09\-28 14:52:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
73fa89edf7 Merge pull request \fI\%#27426\fP from rallytime/fix\-16753
.IP \(bu 2
f6cbd81e66 Don\(aqt stacktrace if there are conflicting id errors in highstate
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27406\fP: (\fI\%s\-iraheta\fP) salt\-cloud error with Softlayer (Bare Metal Instance): TypeError: \(aqbool\(aq object is not iterable and with \-\-list\-locations: Failed to get the output of \(aqsoftlayer_hw.avail_locations()\(aq: 142776 (refs: \fI\%#27408\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27408\fP: (\fI\%rallytime\fP) Fix avail_locations function for the softlayer_hw driver in 2015.5
@ \fI2015\-09\-25 23:34:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
5dd1b70475 Merge pull request \fI\%#27408\fP from rallytime/fix\-27406\-for\-2015.5
.IP \(bu 2
39a4ae5a6c Remove hdd: 19 refs from SL docs \- no longer available from SoftLayer.
.IP \(bu 2
de2f9234d3 Use correct default for bandwidth
.IP \(bu 2
42d8127f79 Don\(aqt set the optional_products default to a boolean, and then try to loop.
.IP \(bu 2
9d8a3d8303 Fix avail_locations function for the softlayer_hw driver in 2015.5
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27389\fP: (\fI\%ryan\-lane\fP) Docs layout issue (refs: \fI\%#27410\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27410\fP: (\fI\%jacobhammons\fP) Fix css layout Refs \fI\%#27389\fP
@ \fI2015\-09\-25 22:38:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
8f9a3cfbaf Merge pull request \fI\%#27410\fP from jacobhammons/doc\-updates
.IP \(bu 2
a9fdecada1 Fix css layout Refs \fI\%#27389\fP sample typo fix in linux_acl additional module folders listed in dynamic\-modules
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27336\fP: (\fI\%rallytime\fP) [2015.5] Fixup salt\-cloud logging
@ \fI2015\-09\-24 15:02:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
3746085587 Merge pull request \fI\%#27336\fP from rallytime/cloud\-logging\-five
.IP \(bu 2
7956b36076 [2015.5] Fixup salt\-cloud logging
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27356\fP: (\fI\%lorengordon\fP) file.replace fails if \fIrepl\fP contains special regex characters and \fIappend_if_not_found=True\fP (refs: \fI\%#27358\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27358\fP: (\fI\%lorengordon\fP) Escape search replacement text, fixes \fI\%#27356\fP
@ \fI2015\-09\-24 13:52:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
5a3be10a3e Merge pull request \fI\%#27358\fP from lorengordon/escape\-search\-replacement\-text
.IP \(bu 2
88bb1fbfff Escape search replacement text, fixes \fI\%#27356\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19236\fP: (\fI\%bramhg\fP) salt\-cloud : Unable to add SSD disk and unable to auto\-delete disk on instance termination on GCE (refs: \fI\%#27345\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27345\fP: (\fI\%rallytime\fP) Allow use of rst header links by separating options out from yaml example
@ \fI2015\-09\-23 19:48:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
6759f79d6d Merge pull request \fI\%#27345\fP from rallytime/docs\-for\-19236
.IP \(bu 2
1d3925bbfb Added version tag for ex_disk_type option
.IP \(bu 2
f23369300c Allow use of rst header links by separating options out from yaml example
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26903\fP: (\fI\%bersace\fP) Review defaults.get
@ \fI2015\-09\-23 14:52:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
c2efb291e2 Merge pull request \fI\%#26903\fP from bersace/fix\-defaults\-modules
.IP \(bu 2
474d7afc95 fixup! Review defaults loading
.IP \(bu 2
36141d226e fixup! Review defaults loading
.IP \(bu 2
62b6495358 fixup! Review defaults loading
.IP \(bu 2
cf0624e8b8 fixup! Review defaults loading
.IP \(bu 2
2c58bab977 fixup! Review defaults loading
.IP \(bu 2
82c5b1d8fd Review defaults loading
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27316\fP: (\fI\%efficks\fP) Extracted state with zip format failed on Windows (refs: \fI\%#27317\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27317\fP: (\fI\%efficks\fP) State unzip should use unzip command instead of unzip_cmd.
@ \fI2015\-09\-23 14:41:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
a372466922 Merge pull request \fI\%#27317\fP from efficks/fix27316
.IP \(bu 2
bf216c101e State unzip should use unzip command instead of unzip_cmd. Issue \fI\%#27316\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#15514\fP: (\fI\%flyaruu\fP) Calling a boto_route53.present state fails if the record is already there (refs: \fI\%#27309\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27309\fP: (\fI\%rallytime\fP) Change a value list to a comma\-separated string in boto_route53.present
@ \fI2015\-09\-23 14:30:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd3771e80f Merge pull request \fI\%#27309\fP from rallytime/fix\-15514
.IP \(bu 2
9383d91ff8 Change a value list to a comma\-separated string in boto_route53.present
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27297\fP: (\fI\%JensRantil\fP) file.replace documentation improvement (refs: \fI\%#27311\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27311\fP: (\fI\%jfindlay\fP) discuss replacement occurrences in file doc
@ \fI2015\-09\-22 22:23:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
b5fe944875 Merge pull request \fI\%#27311\fP from jfindlay/maxoc
.IP \(bu 2
8ec2e921bd discuss replacement occurrences in file doc
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27310\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-09\-22 21:08:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca4597b93a Merge pull request \fI\%#27310\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
7b75e4aed1 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
e90412d3b8 Merge pull request \fI\%#27252\fP from jfindlay/version.2014.7
.INDENT 2.0
.IP \(bu 2
3d28307a00 2014.7 \-> 2014.7.0
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27307\fP: (\fI\%terminalmage\fP) Regression in yumpkg\(aqs refresh_db function (refs: \fI\%#27308\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27308\fP: (\fI\%terminalmage\fP) Fix refresh_db regression in yumpkg.py
@ \fI2015\-09\-22 21:07:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
982c21c79f Merge pull request \fI\%#27308\fP from terminalmage/fix\-refresh_db\-regression
.IP \(bu 2
77686fb7ce Fix refresh_db regression in yumpkg.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27286\fP: (\fI\%terminalmage\fP) Add a configurable timer for minion return retries
@ \fI2015\-09\-22 16:35:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
775a4f9ad0 Merge pull request \fI\%#27286\fP from terminalmage/return_retry_timer
.IP \(bu 2
540a7dfcf1 Add default values for new minion config options
.IP \(bu 2
453b883820 Add a configurable timer for minion return retries
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27278\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27256\fP to 2015.5
@ \fI2015\-09\-21 19:27:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27256\fP: (\fI\%julianbrost\fP) Fix error handling in salt.modules.file.statvfs (refs: \fI\%#27278\fP)
.IP \(bu 2
02482c0572 Merge pull request \fI\%#27278\fP from rallytime/bp\-27256
.IP \(bu 2
1beddf6311 Fix error handling in salt.modules.file.statvfs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27277\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27230\fP to 2015.5
@ \fI2015\-09\-21 19:06:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27230\fP: (\fI\%benhosmer\fP) Fix typo in AWS doc config (refs: \fI\%#27277\fP)
.IP \(bu 2
e36c019c37 Merge pull request \fI\%#27277\fP from rallytime/bp\-27230
.IP \(bu 2
3ce77db1bc Fix typo in AWS doc config
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27253\fP: (\fI\%jfindlay\fP) 2015.5 \-> 2015.5.0
@ \fI2015\-09\-18 23:44:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
b22286476e Merge pull request \fI\%#27253\fP from jfindlay/version.2015.5
.IP \(bu 2
967e3bb72a 2015.5 \-> 2015.5.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27244\fP: (\fI\%garethgreenaway\fP) Exception in cloud.ec2.create_snapshot
@ \fI2015\-09\-18 21:41:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
51a0193b54 Merge pull request \fI\%#27244\fP from garethgreenaway/ec2_create_snapshot_no_return_data_exception
.IP \(bu 2
820fd576b9 Fixing the cause when the r_data from aws.query is empty and an exception happens when looking for the snapshotID
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27215\fP: (\fI\%wfhu\fP) cron.file override the crontab file even if there\(aqs no change (refs: \fI\%#27231\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27231\fP: (\fI\%jfindlay\fP) only write cron file if it is changed
@ \fI2015\-09\-18 18:23:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
26540f15bc Merge pull request \fI\%#27231\fP from jfindlay/cronchange
.IP \(bu 2
1e335297e2 only write cron file if it is changed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27233\fP: (\fI\%basepi\fP) [2015.5] Add stub release notes for 2015.5.6
@ \fI2015\-09\-18 16:55:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
579f375f74 Merge pull request \fI\%#27233\fP from basepi/release.notes.stubs
.IP \(bu 2
f4563ea9b7 Add stub release notes for 2015.5.6
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25423\fP: (\fI\%tweenk\fP) Impossible to define a file.managed for use only as a template in \(dquse\(dq requisites (refs: \fI\%#27208\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27208\fP: (\fI\%basepi\fP) [2015.5] Add test.nop state
@ \fI2015\-09\-18 16:50:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
f5a322e3f2 Merge pull request \fI\%#27208\fP from basepi/nop.state.25423
.IP \(bu 2
9414b05b2c Add test.nop example
.IP \(bu 2
a84ce67b8f Add test.nop state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27187\fP: (\fI\%SeverinLeonhardt\fP) ssh_known_hosts.present hashes other entries even with hash_hostname: false (refs: \fI\%#27201\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27201\fP: (\fI\%jfindlay\fP) rename hash_hostname to hash_known_hosts
@ \fI2015\-09\-18 15:45:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
59a07cae68 Merge pull request \fI\%#27201\fP from jfindlay/sshhash
.IP \(bu 2
1b620b77cd rename hash_host arg to hash_known_hosts
.IP \(bu 2
12f14ae37c update hash_known_hosts docs in ssh module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27214\fP: (\fI\%jacksontj\fP) Correctly support https, port 443 is not a requirement
@ \fI2015\-09\-18 15:43:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
560545c4c5 Merge pull request \fI\%#27214\fP from jacksontj/2015.5
.IP \(bu 2
e7526bdb44 Correctly support https, port 443 is not a requirement
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18582\fP: (\fI\%mainframe\fP) Allow merging file_roots and pillar_roots from different config files included from master.d (refs: \fI\%#27150\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27172\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27150\fP to 2015.5
@ \fI2015\-09\-17 17:25:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27150\fP: (\fI\%cachedout\fP) Merge config values from master.d/minion.d conf files (refs: \fI\%#27172\fP)
.IP \(bu 2
7a34c7742d Merge pull request \fI\%#27172\fP from rallytime/bp\-27150
.IP \(bu 2
0d7ee4b209 Merge config values from master.d/minion.d conf files
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27194\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27180\fP to 2015.5
@ \fI2015\-09\-17 16:17:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27180\fP: (\fI\%tankywoo\fP) file copy ret result True if no change in test mode (refs: \fI\%#27194\fP)
.IP \(bu 2
e956d88f5f Merge pull request \fI\%#27194\fP from rallytime/bp\-27180
.IP \(bu 2
327d343fef file copy ret result True if no change in test mode
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27176\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-09\-17 15:00:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
a02d043309 Merge pull request \fI\%#27176\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
66f4641be3 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
c186e51764 Merge pull request \fI\%#27117\fP from jacobhammons/release\-docs\-2014.7
.INDENT 2.0
.IP \(bu 2
b69e11e0a4 made 2014.7 an archived release minor doc site updates
.UNINDENT
.IP \(bu 2
69d758ee2b Merge pull request \fI\%#27114\fP from cachedout/warn_on_insecure_log
.INDENT 2.0
.IP \(bu 2
507fb04683 Issue warning that some log levels may contain sensitive data
.UNINDENT
.IP \(bu 2
aa71bae8aa Merge pull request \fI\%#27075\fP from twangboy/fix_password_2014.7
.INDENT 2.0
.IP \(bu 2
c0689e3215 Replaced password with redacted when displayed
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27170\fP: (\fI\%rallytime\fP) Update Getting Started with GCE docs to use cloud.profiles or cloud.profiles.d examples
@ \fI2015\-09\-16 22:23:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
de2027426e Merge pull request \fI\%#27170\fP from rallytime/gce\-docs
.IP \(bu 2
a07db909bd Update Getting Started with GCE docs to use cloud.profiles or cloud.profiles.d examples
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27167\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27148\fP to 2015.5
@ \fI2015\-09\-16 19:56:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27148\fP: (\fI\%hexedpackets\fP) Pass file pointers to the serialize load functions. (refs: \fI\%#27167\fP)
.IP \(bu 2
28cfdfd067 Merge pull request \fI\%#27167\fP from rallytime/bp\-27148
.IP \(bu 2
d12be52355 Pass filepointers to the serialize load functions.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27157\fP: (\fI\%alxbse\fP) salt.util.smb loads even when impacket library is missing (refs: \fI\%#27168\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27168\fP: (\fI\%techhat\fP) Add further gating of impacket library
@ \fI2015\-09\-16 18:55:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
4495f4f4d0 Merge pull request \fI\%#27168\fP from techhat/gateimpacket
.IP \(bu 2
cc448bfdc1 Add further gating of impacket library
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27100\fP: (\fI\%hexedpackets\fP) salt\-cloud \-\-full\-query does nothing when no VM profiles are configured (refs: \fI\%#27166\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27166\fP: (\fI\%rallytime\fP) Allow a full\-query for EC2, even if there are no profiles defined
@ \fI2015\-09\-16 17:41:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e5ef0dc30 Merge pull request \fI\%#27166\fP from rallytime/fix\-27100
.IP \(bu 2
50fb3a489a Allow a full\-query for EC2, even if there are no profiles defined
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27162\fP: (\fI\%rallytime\fP) Be explicit in using \(dqSoftLayer\(dq for service queries in SoftLayer drivers
@ \fI2015\-09\-16 16:43:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
f1c9de7ed9 Merge pull request \fI\%#27162\fP from rallytime/softlayer\-service
.IP \(bu 2
d281068c70 Be explicit in using \(dqSoftLayer\(dq for service queries in SoftLayer drivers
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27133\fP: (\fI\%deniswal\fP) win_path.add causes the value data to be set as the value and vice versa (refs: \fI\%#27149\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27149\fP: (\fI\%twangboy\fP) Fixed problem with add/remove path
@ \fI2015\-09\-16 15:01:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
59e9dfd8de Merge pull request \fI\%#27149\fP from twangboy/fix_27133
.IP \(bu 2
7992b7e20a Fixed some tests...  hopefully...
.IP \(bu 2
d4c8e30f5d Fixed problem with add/remove path
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#11669\fP: (\fI\%jcockhren\fP) salt.cloud is out of date for new google compute engine dashboard and API (refs: \fI\%#27147\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27147\fP: (\fI\%rallytime\fP) Enforce bounds in the GCE Regex
@ \fI2015\-09\-15 21:51:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
097fcd1017 Merge pull request \fI\%#27147\fP from rallytime/fix\-11669
.IP \(bu 2
55312ea03f Provide a more friendly error message.
.IP \(bu 2
36555856c7 Enforce bounds in the GCE Regex
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27128\fP: (\fI\%eguven\fP) don\(aqt show diff for test run if show_diff=False
@ \fI2015\-09\-15 14:11:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
f5c3f157dd Merge pull request \fI\%#27128\fP from eguven/2015.5\-fix\-test\-diff
.IP \(bu 2
ec2d68a84a don\(aqt show diff for test run if show_diff=False
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27116\fP: (\fI\%jacobhammons\fP) Update latest to 2015.8, 2015.5 is now previous
@ \fI2015\-09\-15 07:34:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
088b1dbb3e Merge pull request \fI\%#27116\fP from jacobhammons/release\-docs\-2015.5
.IP \(bu 2
6e323b6dd3 Update latest to 2015.8, 2015.5 is now previous Assorted style and minor updates
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25352\fP: (\fI\%m03\fP) reg.absent reporting incorrect results (refs: \fI\%#27019\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27033\fP: (\fI\%jfindlay\fP) Merge \fI\%#27019\fP
@ \fI2015\-09\-15 07:32:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27019\fP: (\fI\%twangboy\fP) Fixed reg state module for None, 0, and \(aq\(aq values (refs: \fI\%#27033\fP)
.IP \(bu 2
440855b182 Merge pull request \fI\%#27033\fP from jfindlay/n0ne
.IP \(bu 2
3334b9d548 fix comment and unit test for reg state
.IP \(bu 2
391a09d5ac update reg state unit tests
.IP \(bu 2
ebbf2b05ca Fixed reg state module for None, 0, and \(aq\(aq values
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#17088\fP: (\fI\%umireon\fP) state.dockerio.run: docked_onlyif and docked_unless do not work (refs: \fI\%#26942\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26942\fP: (\fI\%Arabus\fP) Fix docker.run
@ \fI2015\-09\-14 18:10:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
35fc74132a Merge pull request \fI\%#26942\fP from Arabus/fix\-docker.run
.IP \(bu 2
e61e1de1f5 Fixes value typo for dockerio.loaded state
.IP \(bu 2
39fa11b696 further linting
.IP \(bu 2
4aec37397c Further Linting to quiet the linter
.IP \(bu 2
7eff8ad070 Code Linting and cmd call fix
.IP \(bu 2
a51676e0eb Fixes  \fI\%#17088\fP olyif and unless should run on the host
.IP \(bu 2
d0c6128b8f Fixes \fI\%#17088\fP retcode now returns True or False based on return status
.IP \(bu 2
8b2e7cc4f5 Syntax clarification
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26977\fP: (\fI\%abh\fP) Add support for PEERNTP network interface configuration
@ \fI2015\-09\-14 17:59:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
59f2a0c7ae Merge pull request \fI\%#26977\fP from abh/2015.5\-ntppeer
.IP \(bu 2
df3d6e817f Add support for PEERNTP network interface configuration on RH derived systems
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27021\fP: (\fI\%SEJeff\fP) webutil.user_exists state does not respect test=true (refs: \fI\%#27023\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#21533\fP: (\fI\%aspyatkin\fP) Add option specifying user to run htpasswd module functions (refs: \fI\%#21649\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27023\fP: (\fI\%jfindlay\fP) add test support for htpasswd state mod
@ \fI2015\-09\-14 17:48:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#21649\fP: (\fI\%aspyatkin\fP) Make enhancements to htpasswd modules (refs: \fI\%#27023\fP)
.IP \(bu 2
e05b1f3951 Merge pull request \fI\%#27023\fP from jfindlay/htwebutilpass
.IP \(bu 2
9f3d7890a6 add test support for htpasswd state mod
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27074\fP: (\fI\%twangboy\fP) Replaced password with redacted when displayed
@ \fI2015\-09\-14 16:27:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
9f999c0027 Merge pull request \fI\%#27074\fP from twangboy/fix_password_2015.5
.IP \(bu 2
fdd3537456 Replaced password with redacted when displayed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27073\fP: (\fI\%rallytime\fP) Remove \(dquse develop branch\(dq warning from LXC tutorial
@ \fI2015\-09\-11 23:51:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
46b44f85ed Merge pull request \fI\%#27073\fP from rallytime/remove\-lxc\-warning
.IP \(bu 2
76c056d02b Remove \(dquse develop branch\(dq warning from LXC tutorial now that 2015.5.0 has been released
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27054\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27029\fP to 2015.5
@ \fI2015\-09\-11 22:29:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27029\fP: (\fI\%spudfkc\fP) Removed check for no package name (refs: \fI\%#27054\fP)
.IP \(bu 2
caab21d99c Merge pull request \fI\%#27054\fP from rallytime/bp\-27029
.IP \(bu 2
0be393be22 Removed check for no package name
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27053\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26992\fP to 2015.5
@ \fI2015\-09\-11 22:29:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26992\fP: (\fI\%plastikos\fP) Summary requires full return information. (refs: \fI\%#27053\fP)
.IP \(bu 2
0227e1cb57 Merge pull request \fI\%#27053\fP from rallytime/bp\-26992
.IP \(bu 2
83798aff3c Do not use full return for documentation.
.IP \(bu 2
d9d5bbaa68 Summary requires full return information.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27052\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26930\fP to 2015.5
@ \fI2015\-09\-11 22:28:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26930\fP: (\fI\%madprog\fP) aptpkg.mod_repo: Raise when key_url doesn\(aqt exist (refs: \fI\%#27052\fP)
.IP \(bu 2
b72a0ef86d Merge pull request \fI\%#27052\fP from rallytime/bp\-26930
.IP \(bu 2
d9787aa318 aptpkg.mod_repo: Raise when key_url doesn\(aqt exist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27049\fP: (\fI\%johanek\fP) Run repoquery less
@ \fI2015\-09\-11 22:26:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
8b554dd16f Merge pull request \fI\%#27049\fP from johanek/repoquery\-dedupe
.IP \(bu 2
c113916a23 When running repoquery to check for available versions of packages, run once for all packages rather than once per package
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27070\fP: (\fI\%stanislavb\fP) Deprecate salt.utils.iam in Carbon
@ \fI2015\-09\-11 22:01:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26561\fP: (\fI\%stanislavb\fP) Leave salt.utils.s3 location fallback to salt.utils.aws (refs: \fI\%#27070\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26446\fP: (\fI\%stanislavb\fP) Fetch AWS region from EC2 instance metadata (refs: \fI\%#26561\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26378\fP: (\fI\%stanislavb\fP) Fix EC2 credentials from IAM roles for s3fs and s3 ext_pillar in 2015.5 (refs: \fI\%#26446\fP)
.IP \(bu 2
cc2cbf9869 Merge pull request \fI\%#27070\fP from stanislavb/2015.5
.IP \(bu 2
1e6e5ddc9c Deprecate salt.utils.iam in Carbon
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27030\fP: (\fI\%jfindlay\fP) Backport \fI\%#26938\fP
@ \fI2015\-09\-11 15:10:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27004\fP: (\fI\%vtek21\fP) Fix \(aqdict\(aq object has no attribute split (refs: \fI\%#27024\fP, \fI\%#27030\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26938\fP: (\fI\%derphilipp\fP) Fixes win_path module, migrates from reg.(set|get)_key to reg.(set|get)_value (refs: \fI\%#27030\fP)
.IP \(bu 2
e23caa8ccf Merge pull request \fI\%#27030\fP from jfindlay/winreg
.IP \(bu 2
120fbe78e0 remove trailing line in win_path exec module
.IP \(bu 2
b36a7107b2 update win_path exec module unit tests
.IP \(bu 2
a2dc6f2dd7 Fixes win_path module, migrates from reg.(set|get)_key to reg.(set|get)_value
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25581\fP: (\fI\%b18\fP) Salt 2015.5.2 \- Could not deserialize msgpack message error. (refs: \fI\%#27025\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27025\fP: (\fI\%cachedout\fP) Better try and error handling for prep_jid
@ \fI2015\-09\-11 07:40:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
843c28b435 Merge pull request \fI\%#27025\fP from cachedout/issue_25581
.IP \(bu 2
ecc09d9b93 Lint
.IP \(bu 2
bfcaab9ef4 Better try and error handling for prep_jid
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27035\fP: (\fI\%terminalmage\fP) useradd.py: Use contextmanager to prevent leaked filehandles
@ \fI2015\-09\-11 07:39:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
b9baa0b39a Merge pull request \fI\%#27035\fP from terminalmage/useradd\-contextmanager
.IP \(bu 2
e430e97f6c Update user states to reflect changes to login class handling
.IP \(bu 2
f24b979c7c useradd.py: Use contextmanager to prevent leaked filehandles
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27034\fP: (\fI\%rallytime\fP) Update softlayer docs for where to find apikey
@ \fI2015\-09\-10 22:29:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
1cdfdf7a92 Merge pull request \fI\%#27034\fP from rallytime/softlayer\-doc\-fix
.IP \(bu 2
cb641f8145 Update softlayer docs for where to find apikey
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27024\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27004\fP to 2015.5
@ \fI2015\-09\-10 21:14:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27004\fP: (\fI\%vtek21\fP) Fix \(aqdict\(aq object has no attribute split (refs: \fI\%#27024\fP, \fI\%#27030\fP)
.IP \(bu 2
9e06d3f01a Merge pull request \fI\%#27024\fP from rallytime/bp\-27004
.IP \(bu 2
54d6fcf4c7 Fix \(aqdict\(aq object has no attribute split
.IP \(bu 2
bb29d73c71 Fix \(aqdict\(aq object has no attribute split
.IP \(bu 2
5f1a9c46aa Fix \(aqdict\(aq object has no attribute split
.IP \(bu 2
2bfdd9724e Fix \(aqdict\(aq object has no attribute split
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27027\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27013\fP to 2015.5
@ \fI2015\-09\-10 21:13:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27013\fP: (\fI\%nmadhok\fP) Remove unwanted debug statement (refs: \fI\%#27027\fP)
.IP \(bu 2
9ab2cae1e4 Merge pull request \fI\%#27027\fP from rallytime/bp\-27013
.IP \(bu 2
19a6e9cb1c Remove unwanted debug statement.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27026\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27011\fP to 2015.5
@ \fI2015\-09\-10 21:13:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27011\fP: (\fI\%whiteinge\fP) Move giant eventlisten.sh example out of the state.event docstring (refs: \fI\%#27026\fP)
.IP \(bu 2
2c8beb238f Merge pull request \fI\%#27026\fP from rallytime/bp\-27011
.IP \(bu 2
f8518d545f Move giant eventlisten.sh example out of the state.event docstring
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#20522\fP: (\fI\%eliasp\fP) \fImodules.win_pkg.install()\fP blindly trusts \fIfileclient.get_url()\fP/unhandled exceptions (refs: \fI\%#26972\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26972\fP: (\fI\%twangboy\fP) Catch the 404 error from fileclient
@ \fI2015\-09\-10 20:53:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
e8cdcc62f7 Merge pull request \fI\%#26972\fP from twangboy/fix_20522
.IP \(bu 2
0110786fa9 Catch the 404 error from fileclient
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26951\fP: (\fI\%terminalmage\fP) Fix timezone module for CentOS
@ \fI2015\-09\-10 20:46:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
fbc95f4685 Merge pull request \fI\%#26951\fP from terminalmage/fix\-timezone
.IP \(bu 2
30a4915762 Update tests to reflect changes to timezone module
.IP \(bu 2
b6f926919f Fix timezone module for CentOS
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26875\fP: (\fI\%marccardinal\fP) LXC gateway provisioned only when IP is provided
@ \fI2015\-09\-10 19:31:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
f2ad3c333c Merge pull request \fI\%#26875\fP from marccardinal/patch\-2
.IP \(bu 2
36d5a62262 LXC gateway provisioned only when IP is provided
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26730\fP: (\fI\%styro\fP) __opts__[\(aquser\(aq] on Windows minion incorrect (eg for file.symlink) (refs: \fI\%#26997\fP, #\(gasaltstack/salt\(ga#26899\(ga_\(ga_, \fI\%#26899\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26997\fP: (\fI\%twangboy\fP) Fixed symlinks for windows (don\(aqt use user root)
@ \fI2015\-09\-10 18:54:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26899\fP: (\fI\%twangboy\fP) file.symlink gets windows account instead of root (refs: \fI\%#26997\fP)
.IP \(bu 2
7b2e7b1b37 Merge pull request \fI\%#26997\fP from twangboy/fix_symlink_windows
.IP \(bu 2
89cc02d4e0 Added \fIversionadded\fP
.IP \(bu 2
835177b0c8 Fixed symlinks for windows (don\(aqt use user root)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27001\fP: (\fI\%twangboy\fP) Added CLI Example for reg.delete_key_recursive
@ \fI2015\-09\-10 17:19:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
5389a85894 Merge pull request \fI\%#27001\fP from twangboy/fix_reg_docs
.IP \(bu 2
2980bbda17 Minor clarification
.IP \(bu 2
4684b2ddd1 Added CLI example for reg.delete_key_recursive
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26996\fP: (\fI\%jacobhammons\fP) Beacon doc updates
@ \fI2015\-09\-10 16:47:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
37814f5dff Merge pull request \fI\%#26996\fP from jacobhammons/beacon\-doc
.IP \(bu 2
e475ea688e Fixed typo
.IP \(bu 2
2401533d9e New content added to beacon docs.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26867\fP: (\fI\%joejulian\fP) lvm pv\(aqs can show as not belonging to their vg if symlink is used (refs: \fI\%#26868\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26868\fP: (\fI\%joejulian\fP) Use the actual device name when checking vgdisplay
@ \fI2015\-09\-10 16:08:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ba7eed711 Merge pull request \fI\%#26868\fP from joejulian/2015.5_lvm_vg_symlink_fix
.IP \(bu 2
3dfb33849a Use the actual device name when checking vgdisplay
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26955\fP: (\fI\%dsumsky\fP) S3 ext_pillar module has broken caching mechanism (backport to 2015.5)
@ \fI2015\-09\-10 14:54:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
1537e945be Merge pull request \fI\%#26955\fP from dsumsky/s3\-pillar\-module\-cache\-fix\-2015.5
.IP \(bu 2
8219acffe7 \- fixed pylint warnings
.IP \(bu 2
a3b10e8ab1  \- fixed broken caching in S3 ext_pillar module (file_md5 was a list)  \- added debugging messages  \- static parameters are available as module parameters now
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26987\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26966\fP to 2015.5
@ \fI2015\-09\-09 18:42:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26966\fP: (\fI\%TheBigBear\fP) URL has changed (refs: \fI\%#26987\fP)
.IP \(bu 2
3e902e86b1 Merge pull request \fI\%#26987\fP from rallytime/bp\-26966
.IP \(bu 2
6a29eac003 URL has changed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26915\fP: (\fI\%rallytime\fP) Update Joyent Cloud Tests
@ \fI2015\-09\-09 15:04:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
eddb532713 Merge pull request \fI\%#26915\fP from rallytime/joyent\-tests
.IP \(bu 2
d4ad42d697 Update Joyent Cloud Tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26971\fP: (\fI\%rallytime\fP) Fix a couple of typos in reactor docs
@ \fI2015\-09\-09 15:03:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
f86814b2a4 Merge pull request \fI\%#26971\fP from rallytime/reactor\-doc\-fix
.IP \(bu 2
0214daad19 Fix a couple of typos in reactor docs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26730\fP: (\fI\%styro\fP) __opts__[\(aquser\(aq] on Windows minion incorrect (eg for file.symlink) (refs: \fI\%#26997\fP, #\(gasaltstack/salt\(ga#26899\(ga_\(ga_, \fI\%#26899\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#26899\fP: (\fI\%twangboy\fP) file.symlink gets windows account instead of root (refs: \fI\%#26976\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26976\fP: (\fI\%thatch45\fP) Revert \(dqfile.symlink gets windows account instead of root\(dq
@ \fI2015\-09\-08 22:44:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
57b1080f94 Merge pull request \fI\%#26976\fP from saltstack/revert\-26899\-fix_26730
.IP \(bu 2
6dd54e6bec Revert \(dqfile.symlink gets windows account instead of root\(dq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26975\fP: (\fI\%whiteinge\fP) Remove mocks from rest_cherrypy integration tests; fix groups check bug
@ \fI2015\-09\-08 22:34:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
67be01f5fe Merge pull request \fI\%#26975\fP from whiteinge/rest_cherrypy\-integration
.IP \(bu 2
9a0989585b Add additional \(aqgroups\(aq check to rest_cherrypy if groups are not used
.IP \(bu 2
d68aefcfde Remove mocks from rest_cherrypy integration tests
.IP \(bu 2
2aa3da8911 Rename the rest_cherrypy tests to conform to our convention
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26730\fP: (\fI\%styro\fP) __opts__[\(aquser\(aq] on Windows minion incorrect (eg for file.symlink) (refs: \fI\%#26997\fP, #\(gasaltstack/salt\(ga#26899\(ga_\(ga_, \fI\%#26899\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26899\fP: (\fI\%twangboy\fP) file.symlink gets windows account instead of root (refs: \fI\%#26997\fP)
@ \fI2015\-09\-08 21:14:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
20a48f7f2e Merge pull request \fI\%#26899\fP from twangboy/fix_26730
.IP \(bu 2
9d9b3bb47a file.symlink gets windows account instead of root
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26960\fP: (\fI\%rallytime\fP) Fix bash code block formatting in CherryPy netapi docs
@ \fI2015\-09\-08 18:14:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
dbc6b862f4 Merge pull request \fI\%#26960\fP from rallytime/cherrypy\-docs
.IP \(bu 2
c1420711db Fix bash code block formatting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26940\fP: (\fI\%rallytime\fP) Fix minor doc typo in client api
@ \fI2015\-09\-08 04:15:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
f733e048c9 Merge pull request \fI\%#26940\fP from rallytime/api\-doc\-fix
.IP \(bu 2
00fe6a225c Fix minor doc typo in client api
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26850\fP: (\fI\%jfindlay\fP) salt\-ssh error on 2015.8 (refs: \fI\%#26852\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26871\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26852\fP to 2015.5
@ \fI2015\-09\-08 03:43:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26852\fP: (\fI\%basepi\fP) [2015.8] Only reference msgpack if it imported successfully (refs: \fI\%#26871\fP)
.IP \(bu 2
de9350466e Merge pull request \fI\%#26871\fP from rallytime/bp\-26852
.IP \(bu 2
5a4c8dd2f5 Only reference msgpack if it imported successfully
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26644\fP: (\fI\%gravyboat\fP) pkgrepo should note that for ubuntu/debian all options should not be used (refs: \fI\%#26800\fP, \fI\%#26851\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26638\fP: (\fI\%WackyOne\fP) Suse install documentation (refs: \fI\%#26800\fP, \fI\%#26851\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26851\fP: (\fI\%jacobhammons\fP) states/pkgrepo examples, suse installation updates
@ \fI2015\-09\-02 18:29:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
a563af29d3 Merge pull request \fI\%#26851\fP from jacobhammons/doc\-bugs
.IP \(bu 2
ac3bd47440 states/pkgrepo examples, suse installation updates Refs \fI\%#26644\fP Refs \fI\%#26638\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26804\fP: (\fI\%lrhazi\fP) gpasswd error on RHEL 5 (refs: \fI\%#26817\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26817\fP: (\fI\%jfindlay\fP) modify groupadd for rhel 5
@ \fI2015\-09\-02 14:52:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
5b1b934192 Merge pull request \fI\%#26817\fP from jfindlay/grouparg
.IP \(bu 2
82d33939f3 modify groupadd for rhel 5
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22724\fP: (\fI\%ty2u\fP) digital_ocean_v2.py doesn\(aqt restore snapshot (refs: \fI\%#26824\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26824\fP: (\fI\%systembell\fP) [salt\-cloud] Fix creating droplet from snapshot in digital_ocean provider
@ \fI2015\-09\-02 05:18:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
cdc0ea2fe3 Merge pull request \fI\%#26824\fP from pravka/fix\-droplet\-creation\-from\-snapshot\-in\-dov2
.IP \(bu 2
00e3192536 removing log
.IP \(bu 2
e4a82d78d9 removing stringification of every value in the image dict
.IP \(bu 2
cdc2b4584a fixing condition for slug check
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26805\fP: (\fI\%joejulian\fP) cur_param referenced before assignment (refs: \fI\%#26823\fP, \fI\%#26820\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26823\fP: (\fI\%joejulian\fP) use dbus instead of localectl
@ \fI2015\-09\-02 00:25:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
4af6951a4c Merge pull request \fI\%#26823\fP from joejulian/ctlfix
.IP \(bu 2
a9928cb143 pep8 fixes
.IP \(bu 2
6108ec4280 Gated dbus for os families that use it
.IP \(bu 2
e154c7b16f remove trailing spaces
.IP \(bu 2
c1c1266cc3 fix indent change
.IP \(bu 2
0a35320aa7 Use dbus directly
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26805\fP: (\fI\%joejulian\fP) cur_param referenced before assignment (refs: \fI\%#26823\fP, \fI\%#26820\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26820\fP: (\fI\%jfindlay\fP) add default param in _parse_localectl in locale mod
@ \fI2015\-09\-01 22:02:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
a1749b76b8 Merge pull request \fI\%#26820\fP from jfindlay/ctlfix
.IP \(bu 2
3a2c0d5fbb add default param in _parse_localectl in locale mod
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26788\fP: (\fI\%ssgward\fP) Windows minion user.rename gives exception (refs: \fI\%#26821\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26821\fP: (\fI\%twangboy\fP) Fixed user.rename function in windows
@ \fI2015\-09\-01 22:01:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
ff733547c4 Merge pull request \fI\%#26821\fP from twangboy/fix_26788
.IP \(bu 2
cf979e4877 Fixed user.rename function in windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26754\fP: (\fI\%jefftucker\fP) MySQLdb\-python package should be included with windows minion installer (refs: \fI\%#26803\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26803\fP: (\fI\%twangboy\fP) Added check for PyMySQL if MySQLdb import fails
@ \fI2015\-09\-01 21:44:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
c892be3255 Merge pull request \fI\%#26803\fP from twangboy/fix_26754
.IP \(bu 2
23576c65eb Added check for PyMySQL if MySQLdb import fails
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26798\fP: (\fI\%jfindlay\fP) stack trace from linode driver (refs: \fI\%#26815\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26815\fP: (\fI\%jfindlay\fP) stringify linode id before performing str actions
@ \fI2015\-09\-01 17:56:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
6edfa36083 Merge pull request \fI\%#26815\fP from jfindlay/linstr
.IP \(bu 2
2ff5823944 stringify linode id before performing str actions
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26644\fP: (\fI\%gravyboat\fP) pkgrepo should note that for ubuntu/debian all options should not be used (refs: \fI\%#26800\fP, \fI\%#26851\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26638\fP: (\fI\%WackyOne\fP) Suse install documentation (refs: \fI\%#26800\fP, \fI\%#26851\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26192\fP: (\fI\%jefftucker\fP) Logging documentation does not exist (refs: \fI\%#26800\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#26108\fP: (\fI\%ahammond\fP) documentation around scheduling and orchestration is unclear (refs: \fI\%#26800\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#24510\fP: (\fI\%ahammond\fP) lack of documentation around Denied Keys (refs: \fI\%#26800\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26800\fP: (\fI\%jacobhammons\fP) Doc bug fixes
@ \fI2015\-09\-01 05:40:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
135a8a64af Merge pull request \fI\%#26800\fP from jacobhammons/doc\-fixes
.IP \(bu 2
5cca52a3c1 Fixed windows installer paths Refs \fI\%#25567\fP
.IP \(bu 2
0ec036350d Updates to salt\-ssh and salt\-key \fI\%#24510\fP
.IP \(bu 2
992edc3bb8 Doc bug fixes Refs \fI\%#26192\fP Refs \fI\%#26638\fP Refs \fI\%#26644\fP Refs \fI\%#26108\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24021\fP: (\fI\%arthurlogilab\fP) [salt\-cloud saltify]  AttributeError: \(aqstr\(aq object has no attribute \(aqsetdefault\(aq (refs: \fI\%#26793\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26793\fP: (\fI\%rallytime\fP) Don\(aqt stacktrace if \(dqname\(dq is specified as a minion id in a map file
@ \fI2015\-08\-31 19:24:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
da161b9516 Merge pull request \fI\%#26793\fP from rallytime/fix\-name\-stacktrace
.IP \(bu 2
8601e4b341 Don\(aqt stacktrace if \(dqname\(dq is specified as a minion id in a map file
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24020\fP: (\fI\%arthurlogilab\fP) [salt\-cloud saltify] cannot use \-\-profile saltify machine{1..3} without a map (refs: \fI\%#26790\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26790\fP: (\fI\%rallytime\fP) Update Saltify docs to be more accurate and helpful
@ \fI2015\-08\-31 18:17:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
7c8d0a09f6 Merge pull request \fI\%#26790\fP from rallytime/saltify_docs
.IP \(bu 2
d53754f2b7 Update Saltify docs to be more accurate and helpful
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26773\fP: (\fI\%styro\fP) salt\-call minor breakage on Windows (refs: \fI\%#26775\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26787\fP: (\fI\%jfindlay\fP) merge \fI\%#26775\fP
@ \fI2015\-08\-31 17:52:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26775\fP: (\fI\%styro\fP) Fix some leftover non portable exitcodes. (refs: \fI\%#26787\fP)
.IP \(bu 2
70d0268c83 Merge pull request \fI\%#26787\fP from jfindlay/imp
.IP \(bu 2
e5bbf59ec7 disable import lint in run.py
.IP \(bu 2
8aef725243 Restore blank lines again.
.IP \(bu 2
1710070f61 Restore blank line.
.IP \(bu 2
59d61a8dea os module no longer required.
.IP \(bu 2
f1b8d0d509 Add missing imports.
.IP \(bu 2
7bd8809e23 Fix some non portable exitcodes. Fixes \fI\%#26773\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26759\fP: (\fI\%terminalmage\fP) Backport PR \fI\%#26726\fP to 2015.5 branch
@ \fI2015\-08\-31 14:39:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26726\fP: (\fI\%terminalmage\fP) Redact HTTPS Basic Auth in states/funcs which deal with git remotes (refs: \fI\%#26759\fP)
.IP \(bu 2
645998dbd3 Merge pull request \fI\%#26759\fP from terminalmage/bp\-26726
.IP \(bu 2
d7f7fca7e5 More cleanup from moving auth redaction to salt.utils.url
.IP \(bu 2
07db5a7038 fix redaction
.IP \(bu 2
399871e6dd Add auth redaction flags to git exec module and use them in git state
.IP \(bu 2
776dc38d73 check for ValueError when adding http basic auth
.IP \(bu 2
d2eb1f4340 Rename arguments in salt.utils.url.add_http_basic_auth
.IP \(bu 2
b45f37a467 Add http basic auth tests
.IP \(bu 2
1ed42ea4fd Remove git unit tests, moving them to salt.utils.url tests
.IP \(bu 2
96a55cdb59 Remove unused imports
.IP \(bu 2
1f25a859bd Redact HTTPS Basic Auth data from remote URLs in comments and changes dict
.IP \(bu 2
eafeb6c7bf Automatically redact HTTPS basic auth
.IP \(bu 2
6be3f8f9e1 Add support for callbacks to influence what information about commands is logged
.IP \(bu 2
c36f240a87 Add HTTPS Basic Auth funcs to salt.utils.url
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26628\fP: (\fI\%MadsRC\fP) state.ipset tries to parse wrong data (refs: \fI\%#26768\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26768\fP: (\fI\%garethgreenaway\fP) Fixes to ipset in 2015.5 for \fI\%#26628\fP
@ \fI2015\-08\-29 03:24:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
46a4bbd0e7 Merge pull request \fI\%#26768\fP from garethgreenaway/26628_2015_5_ipset_fixes
.IP \(bu 2
f0c6090c7e Fixing issue when information returned from ipset isn\(aqt in the format we expect and it causes an exception.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26732\fP: (\fI\%saltstack\-bot\fP) SmartOS pkgsrc dependency (refs: \fI\%#26753\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26753\fP: (\fI\%jfindlay\fP) import elementree from _compat in ilo exec mod
@ \fI2015\-08\-28 20:56:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
7a58878ea8 Merge pull request \fI\%#26753\fP from jfindlay/iloet
.IP \(bu 2
211a02754f import elementree from _compat in ilo exec mod
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21256\fP: (\fI\%dhs\-rec\fP) win.exe package for RH 6 (refs: \fI\%#26736\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26736\fP: (\fI\%twangboy\fP) Changed import from smbconnection to smb3
@ \fI2015\-08\-28 17:23:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
22dbce8d61 Merge pull request \fI\%#26736\fP from twangboy/fix_21256
.IP \(bu 2
86f425c669 Changed import from smbconnection to smb3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26705\fP: (\fI\%Galser\fP) Salt\-Master 2015.5.5\-1 on Scientific Linux 6 fails loading some primitive pillars from YAML (refs: \fI\%#26714\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26714\fP: (\fI\%jfindlay\fP) add exception placeholder for older msgpacks
@ \fI2015\-08\-28 16:02:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
16d4e0350d Merge pull request \fI\%#26714\fP from jfindlay/pack_except
.IP \(bu 2
ebcfaf9050 add exception placeholder for older msgpacks
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26710\fP: (\fI\%rallytime\fP) Update GCE driver to return True, False or a new name in __virtual__()
@ \fI2015\-08\-27 20:08:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
47faa8cc16 Merge pull request \fI\%#26710\fP from rallytime/gce_virtual_return
.IP \(bu 2
e6b74879d7 Remove unused import
.IP \(bu 2
78e31585cf Update GCE driver to return True, False or a new name in __virtual__()
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#14612\fP: (\fI\%cachedout\fP) Catch provider errors in salt cloud (refs: \fI\%#26709\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26709\fP: (\fI\%rallytime\fP) Ensure VM name is valid before trying to create Linode VM
@ \fI2015\-08\-27 20:07:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
cf487cf0f5 Merge pull request \fI\%#26709\fP from rallytime/fix\-14612
.IP \(bu 2
bc21094ea0 versionadded and more efficient checks
.IP \(bu 2
a3ac8e7008 Whitespace fix
.IP \(bu 2
9a4228d906 Added unit tests for new _validate_name function and adjusted regex
.IP \(bu 2
388815112c Ensure VM name is valid before trying to create Linode VM
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#9592\fP: (\fI\%otrempe\fP) pip module fails on Windows because of quoting (refs: \fI\%#26617\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26617\fP: (\fI\%terminalmage\fP) Fix Windows failures in pip module due to raw string formatting
@ \fI2015\-08\-27 19:24:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
c3a6280f8c Merge pull request \fI\%#26617\fP from terminalmage/issue9592
.IP \(bu 2
96c3df1ed5 Don\(aqt accept non\-list input for pkgs arg
.IP \(bu 2
419221535b Lint fix
.IP \(bu 2
ede057eebc Fix tests to reflect args being passed as lists instead of strings
.IP \(bu 2
03250dbd9f Pass command to cmd.run_all as list instead of joining
.IP \(bu 2
1c90cdb07e salt/modules/pip.py: Remove raw string format flags
.IP \(bu 2
cd35df5ff8 Catch TypeErrors in timed_subprocess
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26700\fP: (\fI\%kev009\fP) Ignore the first element of kern.disks split, which is the sysctl name
@ \fI2015\-08\-27 17:48:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
24a4f54f39 Merge pull request \fI\%#26700\fP from kev009/fbsd\-disks\-fix\-2015.5
.IP \(bu 2
3ac97f9de4 Ignore the first element of kern.disks split, which is the sysctl name
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26695\fP: (\fI\%terminalmage\fP) Better HTTPS basic auth redaction for 2015.5 branch
@ \fI2015\-08\-27 15:10:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
58945131b5 Merge pull request \fI\%#26695\fP from terminalmage/better\-https\-auth\-redaction\-2015.5
.IP \(bu 2
752d260209 Use versioninfo tuple for comparison
.IP \(bu 2
b1d253483e Better HTTPS basic auth redaction for 2015.5 branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26694\fP: (\fI\%terminalmage\fP) Backport \fI\%#26693\fP to 2015.5
@ \fI2015\-08\-27 08:16:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26693\fP: (\fI\%serge\-p\fP) Update openbsdpkg.py (refs: \fI\%#26694\fP)
.IP \(bu 2
4040a312f9 Merge pull request \fI\%#26694\fP from terminalmage/bp\-26693
.IP \(bu 2
4aec926476 Update openbsdpkg.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26681\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-08\-26 22:03:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
0b17f80fe9 Merge pull request \fI\%#26681\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
64cad371f0 Remove overmocked test
.IP \(bu 2
40718af1d5 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
c2c7fe06c8 Merge pull request \fI\%#26667\fP from nmadhok/doc\-fix\-2014.7
.INDENT 2.0
.IP \(bu 2
26be189689 Doc fix. Fixes \fI\%#26656\fP
.UNINDENT
.IP \(bu 2
6bd3dccae8 Merge pull request \fI\%#26663\fP from jacobhammons/2014.7\-version
.INDENT 2.0
.IP \(bu 2
b6af538070 version change for latest branch
.UNINDENT
.IP \(bu 2
071a6112e5 Merge pull request \fI\%#26636\fP from rallytime/cloud\-test\-fixes
.INDENT 2.0
.IP \(bu 2
c0d83d558d Don\(aqt use id as variable
.IP \(bu 2
2b4bc1679d Keep ec2 instance creation test the same \- it works better for the ec2 output
.IP \(bu 2
b5b58eb31f Skip digital ocean tests since we can\(aqt use API v1 with v2 tests
.IP \(bu 2
9ae1539c62 Update cloud tests to be more efficient and accurate
.UNINDENT
.IP \(bu 2
304542b4c6 Merge pull request \fI\%#26640\fP from efficks/fixws2014
.INDENT 2.0
.IP \(bu 2
ebe5d9d85c Fix function spacing
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26676\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26648\fP to 2015.5
@ \fI2015\-08\-26 19:46:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26648\fP: (\fI\%whiteinge\fP) Free \(aqfun\(aq from the function signature namespace (refs: \fI\%#26676\fP)
.IP \(bu 2
75675a6ba9 Merge pull request \fI\%#26676\fP from rallytime/bp\-26648
.IP \(bu 2
1af42eed36 Free \(aqfun\(aq from the function signature namespace
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26677\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26653\fP to 2015.5
@ \fI2015\-08\-26 19:45:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26653\fP: (\fI\%dmyerscough\fP) You can provide a X\-Auth\-Token when requesting jobs (refs: \fI\%#26677\fP)
.IP \(bu 2
d7f682cb5b Merge pull request \fI\%#26677\fP from rallytime/bp\-26653
.IP \(bu 2
497ca96039 You can provide a X\-Auth\-Token when requesting jobs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26675\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26631\fP to 2015.5
@ \fI2015\-08\-26 19:44:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26631\fP: (\fI\%PierreR\fP) Fix get_load in postgres returner (refs: \fI\%#26675\fP)
.IP \(bu 2
960dbba7ed Merge pull request \fI\%#26675\fP from rallytime/bp\-26631
.IP \(bu 2
20eecdc7be Fix get_load
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26655\fP: (\fI\%damonzheng\fP) Update win_dns_client.py
@ \fI2015\-08\-26 16:05:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
db30926ac9 Merge pull request \fI\%#26655\fP from cheng0919/2015.5
.IP \(bu 2
fdebc01def Update win_dns_client.py
.IP \(bu 2
1d23d5e797 Update win_dns_client.py
.IP \(bu 2
1a45db0fb7 Update win_dns_client.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26662\fP: (\fI\%jacobhammons\fP) update version to 2015.5
@ \fI2015\-08\-26 13:45:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
a04d243471 Merge pull request \fI\%#26662\fP from jacobhammons/version
.IP \(bu 2
4e5766fdde update version to 2015.5
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26651\fP: (\fI\%jfindlay\fP) add 2015.5.4 notes to 2015.5.5 notes
@ \fI2015\-08\-26 00:25:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
8a9a076ad4 Merge pull request \fI\%#26651\fP from jfindlay/2015.5
.IP \(bu 2
dc5cee5f8f add 2015.5.4 notes to 2015.5.5 notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26497\fP: (\fI\%JensRantil\fP) Feature request: Make salt.states.managed support local file \fIsource\fP (refs: \fI\%#26525\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26525\fP: (\fI\%jfindlay\fP) document check_file_meta args, remove unused arg
@ \fI2015\-08\-25 21:43:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
5bdefdc234 Merge pull request \fI\%#26525\fP from jfindlay/sum
.IP \(bu 2
0297d49aa0 remove unused check_file_meta arg
.IP \(bu 2
6a3cb1c0aa document args to file.check_file_meta exec fcn
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26561\fP: (\fI\%stanislavb\fP) Leave salt.utils.s3 location fallback to salt.utils.aws (refs: \fI\%#27070\fP)
@ \fI2015\-08\-25 21:40:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26446\fP: (\fI\%stanislavb\fP) Fetch AWS region from EC2 instance metadata (refs: \fI\%#26561\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26378\fP: (\fI\%stanislavb\fP) Fix EC2 credentials from IAM roles for s3fs and s3 ext_pillar in 2015.5 (refs: \fI\%#26446\fP)
.IP \(bu 2
84e96458b3 Merge pull request \fI\%#26561\fP from stanislavb/2015.5
.IP \(bu 2
50332895a1 Leave salt.utils.s3 location fallback to salt.utils.aws
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22550\fP: (\fI\%amendlik\fP) Error deleting SSH keys using salt\-cloud \-\-destroy (refs: \fI\%#26573\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26573\fP: (\fI\%rallytime\fP) Don\(aqt stacktrace if using private_ips and delete_sshkeys together
@ \fI2015\-08\-25 20:00:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
1d729734cc Merge pull request \fI\%#26573\fP from rallytime/destroy_ssh_keys_private_ips
.IP \(bu 2
4267509c25 Don\(aqt stacktrace if using private_ips and delete_sshkeys
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#20169\fP: (\fI\%flavianh\fP) [salt\-cloud] Add a meaningful error when /etc/salt/cloud is missing the master\(aqs address (refs: \fI\%#26563\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26563\fP: (\fI\%rallytime\fP) Fix error detection when salt\-cloud config is missing a master\(aqs address
@ \fI2015\-08\-25 20:00:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
000e5a2acf Merge pull request \fI\%#26563\fP from rallytime/fix\-20169
.IP \(bu 2
65b285d02d Only warn if master IP is unset \- must be compatible with masterless minions
.IP \(bu 2
a4c87fcf57 Simplify logic
.IP \(bu 2
593ead08cf Fix error detection when salt\-cloud config is missing a master\(aqs address
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26641\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-08\-25 18:17:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
19c7a6d575 Merge pull request \fI\%#26641\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
a5dafa436c Already fixed on 2015.5
.IP \(bu 2
71c0898fb5 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
4532f98a76 Merge pull request \fI\%#26515\fP from bersace/salt\-env\-local\-sls
.IP \(bu 2
0727af9e3d Defaults to current saltenv in state.sls
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26620\fP: (\fI\%rallytime\fP) Also add \-Z to script args for cloud tests
@ \fI2015\-08\-24 22:03:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
2927859c8a Merge pull request \fI\%#26620\fP from rallytime/more_script_args
.IP \(bu 2
9ae27193d8 Also add \-Z to script args for cloud tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26618\fP: (\fI\%rallytime\fP) Add script_args: \(aq\-P\(aq to Ubuntu 14 profiles for nightly cloud tests
@ \fI2015\-08\-24 21:15:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
ed166ebd4f Merge pull request \fI\%#26618\fP from rallytime/pip\-undate\-cloud\-tests
.IP \(bu 2
5a2c8825ba Extra lines
.IP \(bu 2
d28672b69e Add script_args: \(aq\-P\(aq to Ubuntu 14 profiles for nightly cloud tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26612\fP: (\fI\%rallytime\fP) Use an available image to test against
@ \fI2015\-08\-24 19:09:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
6d3927bed5 Merge pull request \fI\%#26612\fP from rallytime/fix\-do\-list\-images\-test
.IP \(bu 2
1401255287 Use an available image to test against
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#15590\fP: (\fI\%jtratner\fP) salt\-cloud gce configuration check incorrect (refs: \fI\%#26576\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26576\fP: (\fI\%rallytime\fP) Ensure GCE and EC2 configuration checks are correct
@ \fI2015\-08\-23 18:59:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
991bbf63fe Merge pull request \fI\%#26576\fP from rallytime/fix\-14604
.IP \(bu 2
ac67a1d238 Ensure GCE configuration check is correct
.IP \(bu 2
421f1fde1e Ensure EC2 configuration check is correct
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#12225\fP: (\fI\%arthurlogilab\fP) [salt\-cloud] Attribution of floating IPs works partially in parallel mode  (refs: \fI\%#26580\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26580\fP: (\fI\%rallytime\fP) Avoid race condition when assigning floating IPs to new VMs
@ \fI2015\-08\-23 18:58:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
746c0008a9 Merge pull request \fI\%#26580\fP from rallytime/fix\-12225
.IP \(bu 2
e3f7db17cc Avoid race condition when assigning floating IPs to new VMs
.IP \(bu 2
afda31be74 Create _assign_floating_ips function for DRY
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26581\fP: (\fI\%terminalmage\fP) Skip tests that don\(aqt work with older mock
@ \fI2015\-08\-22 23:06:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
965a4ba7cf Merge pull request \fI\%#26581\fP from terminalmage/fix\-tests
.IP \(bu 2
49d8bd1dbe Remove unused import
.IP \(bu 2
81a0d4c915 Skip tests that don\(aqt work with older mock
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25478\fP: (\fI\%zyio\fP) salt\-ssh \- Unable to locate current thin version (refs: \fI\%#25862\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#25026\fP: (\fI\%sylvia\-wang\fP) salt\-ssh \(dqFailure deploying thin\(dq when using salt module functions (refs: \fI\%#25862\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26591\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26554\fP to 2015.5
@ \fI2015\-08\-22 21:19:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26554\fP: (\fI\%tjstansell\fP) /bin/sh is more portable than /bin/bash (refs: \fI\%#26591\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25862\fP: (\fI\%zyio\fP) Adding SCP_NOT_FOUND exit code (refs: \fI\%#26554\fP)
.IP \(bu 2
19992c1450 Merge pull request \fI\%#26591\fP from rallytime/bp\-26554
.IP \(bu 2
6f8bed88cb /bin/sh is more portable than /bin/bash
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26565\fP: (\fI\%cachedout\fP) Fix many errors with __virtual__ in tests
@ \fI2015\-08\-21 21:37:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
2cd36c7ed4 Merge pull request \fI\%#26565\fP from cachedout/fix_virtual_warnings
.IP \(bu 2
41541e4e2b Fix many errors with __virtual__ in tests
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19249\fP: (\fI\%ahetmanski\fP) Cannot create cache_dir salt master exception. (refs: \fI\%#26548\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26553\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26548\fP to 2015.5
@ \fI2015\-08\-21 17:40:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26548\fP: (\fI\%vakulich\fP) Catch OSError during cache directories creation, fixes \fI\%#19249\fP (refs: \fI\%#26553\fP)
.IP \(bu 2
5a32664efd Merge pull request \fI\%#26553\fP from rallytime/bp\-26548
.IP \(bu 2
ec2b2c3e40 Catch OSError during cache directories creation, fixes \fI\%#19249\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26552\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26542\fP to 2015.5
@ \fI2015\-08\-21 17:40:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26542\fP: (\fI\%arthurlogilab\fP) [doc] reactor documentation fix : returners (refs: \fI\%#26552\fP)
.IP \(bu 2
7e67e48656 Merge pull request \fI\%#26552\fP from rallytime/bp\-26542
.IP \(bu 2
0976b1e23b [doc] reactor documentation fix : returners
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26551\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26539\fP to 2015.5
@ \fI2015\-08\-21 17:39:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26539\fP: (\fI\%carlpett\fP) Doc\-fix: Escape backslash in domain\e\eusername (refs: \fI\%#26551\fP)
.IP \(bu 2
bcd462545d Merge pull request \fI\%#26551\fP from rallytime/bp\-26539
.IP \(bu 2
94ff4cff40 Doc\-fix: Escape backslash in domainusername
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26549\fP: (\fI\%rallytime\fP) Back\-port \fI\%#26524\fP to 2015.5
@ \fI2015\-08\-21 17:38:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26524\fP: (\fI\%JensRantil\fP) Gracefully handle package comparison not in (\-1, 0, 1) (refs: \fI\%#26549\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25369\fP: (\fI\%anlutro\fP) Fix aptpkg.version_cmp (refs: \fI\%#26524\fP)
.IP \(bu 2
4dbf61c5af Merge pull request \fI\%#26549\fP from rallytime/bp\-26524
.IP \(bu 2
4763f28725 logging(cmp_version): output assertion
.IP \(bu 2
673b6c683d utils(version_cmp): handle comparison not in (0,1,\-1)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26502\fP: (\fI\%ryan\-lane\fP) Adding a listener with None as ports doesn\(aqt result in an invocation error in boto_elb (refs: \fI\%#26527\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26527\fP: (\fI\%jfindlay\fP) check exists and values in boto_elb listeners
@ \fI2015\-08\-21 15:27:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
1ac8287588 Merge pull request \fI\%#26527\fP from jfindlay/elb
.IP \(bu 2
343e47f00c check exists and values in boto_elb listeners
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26446\fP: (\fI\%stanislavb\fP) Fetch AWS region from EC2 instance metadata (refs: \fI\%#26561\fP)
@ \fI2015\-08\-21 15:11:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26378\fP: (\fI\%stanislavb\fP) Fix EC2 credentials from IAM roles for s3fs and s3 ext_pillar in 2015.5 (refs: \fI\%#26446\fP)
.IP \(bu 2
e4b2534aa8 Merge pull request \fI\%#26446\fP from stanislavb/2015.5\-ec2\-metadata\-region
.IP \(bu 2
57943ff4f7 Fetch AWS region from EC2 instance metadata
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26546\fP: (\fI\%nmadhok\fP) Do not raise KeyError when calling avail_images if VM/template is in disconnected state
@ \fI2015\-08\-21 14:17:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
d721b7b2be Merge pull request \fI\%#26546\fP from nmadhok/vmware\-key\-error\-patch\-2015.5
.IP \(bu 2
1dcf157256 Do not raise KeyError when calling avail_images if VM/template is in disconnected state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25360\fP: (\fI\%BretFisher\fP) file.replace removes line feed if using YAML\(aqs multiline string syntax (refs: \fI\%#26481\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26537\fP: (\fI\%jfindlay\fP) Merge \fI\%#26481\fP
@ \fI2015\-08\-21 05:37:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#26481\fP: (\fI\%TheBigBear\fP) minor note: added (refs: \fI\%#26537\fP)
.IP \(bu 2
7da87fabf1 Merge pull request \fI\%#26537\fP from jfindlay/note
.IP \(bu 2
662e723ae0 fixup note lint in file.replace state mod
.IP \(bu 2
332535f2e6 Update file.py
.IP \(bu 2
598500034f Update file.py
.IP \(bu 2
ec7c7d738d minor note: added
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26528\fP: (\fI\%zmalone\fP) Fixing encrypt to instructions in the 2015.5 branch
@ \fI2015\-08\-20 21:49:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
c6d8e34730 Merge pull request \fI\%#26528\fP from zmalone/2015.5
.IP \(bu 2
39b111c465 Fixing encrypt to instructions in the 2015.5 branch, \-\-homedir is not necessary here.
.UNINDENT
.UNINDENT
.SS Salt 2015.5.7 Release Notes
.INDENT 0.0
.TP
.B release
2015\-10\-13
.UNINDENT
.sp
Version 2015.5.7 is a bugfix release for \fI\%2015.5.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB103\fP
.IP \(bu 2
Total Issue References: \fB66\fP
.IP \(bu 2
Total PR References: \fB135\fP
.IP \(bu 2
Contributors: \fB46\fP (\fI\%0xf10e\fP, \fI\%JaseFace\fP, \fI\%MasterNayru\fP, \fI\%MrCitron\fP, \fI\%Sacro\fP,
\fI\%ajacoutot\fP, \fI\%arthurlogilab\fP, \fI\%basepi\fP, \fI\%belvedere\-trading\fP, \fI\%beverlcl\fP,
\fI\%blast\-hardcheese\fP, \fI\%blueyed\fP, \fI\%bogdanr\fP, \fI\%cachedout\fP, \fI\%cbuechler\fP, \fI\%chrigl\fP,
\fI\%dmyerscough\fP, \fI\%eguven\fP, \fI\%eliasp\fP, \fI\%erchn\fP, \fI\%eyj\fP, \fI\%garethgreenaway\fP, \fI\%gashev\fP,
\fI\%gnubyexample\fP, \fI\%gracinet\fP, \fI\%gravyboat\fP, \fI\%gwaters\fP, \fI\%hedinfaok\fP, \fI\%iggy\fP, \fI\%jacksontj\fP,
\fI\%jacobhammons\fP, \fI\%jfindlay\fP, \fI\%lorengordon\fP, \fI\%mbologna\fP, \fI\%msciciel\fP, \fI\%nmadhok\fP,
\fI\%pass\-by\-value\fP, \fI\%plastikos\fP, \fI\%rallytime\fP, \fI\%rominf\fP, \fI\%s0undt3ch\fP, \fI\%silenius\fP, \fI\%sjmh\fP,
\fI\%stephen144\fP, \fI\%terminalmage\fP, \fI\%twangboy\fP)
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
A significant orchestrate issue (\fI\%issue #29110\fP) was discovered during the
release process of 2015.5.7, so it has not been officially released.
Please use \fI\%2015.5.8\fP instead.
.UNINDENT
.UNINDENT
.SS Changelog for v2015.5.6..v2015.5.7
.sp
\fIGenerated at: 2018\-05\-27 22:16:54 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#28864\fP: (\fI\%jfindlay\fP) add 2015.5.7 release notes
@ \fI2015\-11\-13 17:15:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
ec7fdc539b Merge pull request \fI\%#28864\fP from jfindlay/2015.5
.IP \(bu 2
648b697951 add 2015.5.7 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27392\fP: (\fI\%ahammond\fP) schedule running state.orchestrate fails (refs: \fI\%#28731\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28731\fP: (\fI\%garethgreenaway\fP) Fixes to salt scheduler in 2015.5, ensuring that return_job is only used on minion scheduler
@ \fI2015\-11\-13 16:58:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
bed45f4208 Merge pull request \fI\%#28731\fP from garethgreenaway/27392_2015_5_scheduler_return_job_master
.IP \(bu 2
771e9f7b6f Fixing the salt scheduler so that it only attempts to return the job data to the master if the scheduled job is running from a minion\(aqs scheduler.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28857\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28851\fP to 2015.5
@ \fI2015\-11\-13 13:56:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28851\fP: (\fI\%rominf\fP) [states/schedule] docstring: args, kwargs \-> job_args, job_kwargs (refs: \fI\%#28857\fP)
.IP \(bu 2
06f4932876 Merge pull request \fI\%#28857\fP from rallytime/bp\-28851
.IP \(bu 2
aa4b193f87 [states/schedule] docstring: args, kwargs \-> job_args, job_kwargs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28856\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28853\fP to 2015.5
@ \fI2015\-11\-13 13:46:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28853\fP: (\fI\%eliasp\fP) Typo (with → which) (refs: \fI\%#28856\fP)
.IP \(bu 2
0934a52b34 Merge pull request \fI\%#28856\fP from rallytime/bp\-28853
.IP \(bu 2
37eeab2683 Typo (with → which)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28828\fP: (\fI\%basepi\fP) salt\-ssh doesn\(aqt package tornado\(aqs new deps in the thin (refs: \fI\%#28826\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28832\fP: (\fI\%basepi\fP) [2015.5] Backport \fI\%#28826\fP
@ \fI2015\-11\-12 19:32:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28826\fP: (\fI\%basepi\fP) [2015.8] Add new tornado deps to salt\-ssh thin (refs: \fI\%#28832\fP)
.IP \(bu 2
eb904665dc Merge pull request \fI\%#28832\fP from basepi/backport.28826
.IP \(bu 2
57be72eb91 Add backports_abc and singledispatch_helpers to thin as well
.IP \(bu 2
897cad627b Add singledispatch to the thin
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#8647\fP: (\fI\%Mrten\fP) salt \(aq*\(aq highstate returns \(aqminion did not return\(aq, salt [minion] highstate works (refs: \fI\%#28833\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28833\fP: (\fI\%basepi\fP) [2015.5] Increase the default gather_job_timeout
@ \fI2015\-11\-12 19:31:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
eff811a0ad Merge pull request \fI\%#28833\fP from basepi/increase.gather_job_timeout.8647
.IP \(bu 2
c09243dd01 Increase the default gather_job_timeout
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28829\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-11\-12 18:50:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
e4a036365d Merge pull request \fI\%#28829\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
f8b8441485 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
76e69b4bff Merge pull request \fI\%#28777\fP from rallytime/bp\-28740\-2014.7
.INDENT 2.0
.IP \(bu 2
da5fac2b36 Back\-port \fI\%#28740\fP to 2014.7
.UNINDENT
.IP \(bu 2
45c73ebf2f Merge pull request \fI\%#28716\fP from rallytime/bp\-28705
.INDENT 2.0
.IP \(bu 2
32e7bd3ea0 Account for new headers class in tornado 4.3
.UNINDENT
.IP \(bu 2
f4fe921965 Merge pull request \fI\%#28717\fP from cachedout/umask_note
.INDENT 2.0
.IP \(bu 2
1874300e08 Add note about recommended umask
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25775\fP: (\fI\%trimbleagvendoraccounta\fP) blockdev.formatted formats but fails. Second highstate shows success. (refs: \fI\%#28756\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#20235\fP: (\fI\%joejulian\fP) blockdev.format state can fail even if it succeeds (refs: \fI\%#28756\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28756\fP: (\fI\%MrCitron\fP) Fix \fI\%#25775\fP
@ \fI2015\-11\-12 17:47:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
93562631aa Merge pull request \fI\%#28756\fP from MrCitron/fix\-25775
.IP \(bu 2
82075c809c Add logs and correct pylint error
.IP \(bu 2
e31e22d96a Fix 25775
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28783\fP: (\fI\%chrigl\fP) iptables.get_saved_rules does not handle family=ipv6 (refs: \fI\%#28786\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28786\fP: (\fI\%chrigl\fP) closes \fI\%#28783\fP
@ \fI2015\-11\-11 21:01:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
30cc48e37f Merge pull request \fI\%#28786\fP from chrigl/fix\-28783
.IP \(bu 2
ba6d814553 closes \fI\%#28783\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28776\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28740\fP to 2015.5
@ \fI2015\-11\-11 18:02:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28740\fP: (\fI\%MasterNayru\fP) Add missing S3 module import (refs: \fI\%#28776\fP, \fI\%#28777\fP)
.IP \(bu 2
8f1d0b636e Merge pull request \fI\%#28776\fP from rallytime/bp\-28740\-2015.5
.IP \(bu 2
49256b7d90 Back\-port \fI\%#28740\fP to 2015.5
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28732\fP: (\fI\%dmyerscough\fP) cherrypy API endpoint (refs: \fI\%#28760\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#22452\fP: (\fI\%whiteinge\fP) rest_cherrypy /keys URL returns empty keys for minion IDs that already exist (refs: \fI\%#28760\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#22451\fP: (\fI\%whiteinge\fP) rest_cherrypy /keys URL throws a 500 on the first request (refs: \fI\%#28760\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#22442\fP: (\fI\%allanliu\fP) rest_cherrypy /keys URL does not handle JSON requests (refs: \fI\%#28760\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28760\fP: (\fI\%dmyerscough\fP) Fixing CherryPy key bug
@ \fI2015\-11\-11 15:11:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
77d4b980f1 Merge pull request \fI\%#28760\fP from dmyerscough/28732\-Fix\-cherrypi\-api\-keys\-endpoint
.IP \(bu 2
206d1684b2 Fixing CherryPy key bug
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28714\fP: (\fI\%gravyboat\fP) Salt\-api doesn\(aqt work with post unless data is included. (refs: \fI\%#28718\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28746\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28718\fP to 2015.5
@ \fI2015\-11\-10 18:16:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28718\fP: (\fI\%sjmh\fP) Account for no POST data (refs: \fI\%#28746\fP)
.IP \(bu 2
6f8f04975f Merge pull request \fI\%#28746\fP from rallytime/bp\-28718
.IP \(bu 2
092f441cad Account for no POST data
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28705\fP: (\fI\%cachedout\fP) Account for new headers class in tornado 4.3 (refs: \fI\%#28716\fP)
@ \fI2015\-11\-09 19:24:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
f40c617bad Merge pull request \fI\%#28705\fP from cachedout/tornado_http_headers
.IP \(bu 2
7ac6cde1ee Account for new headers class in tornado 4.3
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28699\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28670\fP to 2015.5
@ \fI2015\-11\-09 18:10:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28670\fP: (\fI\%plastikos\fP) psutil can fail to look\-up a uid and raise a KeyError (refs: \fI\%#28699\fP)
.IP \(bu 2
604a7b4199 Merge pull request \fI\%#28699\fP from rallytime/bp\-28670
.IP \(bu 2
e436b23296 psutil can fail to look\-up a uid and raise a KeyError
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28703\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28690\fP to 2015.5
@ \fI2015\-11\-09 18:01:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28690\fP: (\fI\%MrCitron\fP) Fix 28689 : Check s3 ext pillar cache file before calculating expiration (refs: \fI\%#28703\fP)
.IP \(bu 2
7bd3eb8370 Merge pull request \fI\%#28703\fP from rallytime/bp\-28690
.IP \(bu 2
a0988dab58 Fix 28689 : Check s3 ext pillar cache file before calculating expiration
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#868\fP: (\fI\%cachedout\fP) Always refresh the Arch Linux keyring if needed (refs: \fI\%#28694\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28694\fP: (\fI\%s0undt3ch\fP) [2015.5] Update to latest bootstrap script v2015.11.09
@ \fI2015\-11\-09 17:49:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
2a40f57b93 Merge pull request \fI\%#28694\fP from s0undt3ch/2015.5
.IP \(bu 2
0910c6ffe4 Update to latest bootstrap script v2015.11.09
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26592\fP: (\fI\%centromere\fP) rabbitmq.list_vhosts removes final line from rabbitmqctl output (refs: \fI\%#28669\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28669\fP: (\fI\%rallytime\fP) Use the \-q argument to strip extraneous messages from rabbitmq
@ \fI2015\-11\-08 01:07:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
3249b322e8 Merge pull request \fI\%#28669\fP from rallytime/fix\-26592
.IP \(bu 2
098fb815af Use the \-q argument to strip extraneous messages from rabbitmq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28577\fP: (\fI\%jacksontj\fP) Increase in master CPU usage after upgrading to 2015.8 (refs: \fI\%#28645\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28645\fP: (\fI\%jacksontj\fP) Rework minion return_retry_timer
@ \fI2015\-11\-07 03:40:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27286\fP: (\fI\%terminalmage\fP) Add a configurable timer for minion return retries (refs: \fI\%#28645\fP)
.IP \(bu 2
29e8250d0c Merge pull request \fI\%#28645\fP from jacksontj/2015.5
.IP \(bu 2
f63c2d70a7 Rework minion return_retry_timer
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#15177\fP: (\fI\%baskinomics\fP) system.join_domain() does not join domain on Windows Server 2012 R2 (refs: \fI\%#28668\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28668\fP: (\fI\%twangboy\fP) Fixed join_domain and unjoin_domain for Windows
@ \fI2015\-11\-07 03:40:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
1bbaea8aad Merge pull request \fI\%#28668\fP from twangboy/fix_15177
.IP \(bu 2
745b8f75f6 Fixed some lint
.IP \(bu 2
a43eb53f28 Added version added notes in docs
.IP \(bu 2
6b537c8640 Fixed join_domain and unjoin_domain for Windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#8051\fP: (\fI\%regilero\fP) Problems with fileinput.input inplace editing in salt.states.file.replace (refs: \fI\%#28174\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#7999\fP: (\fI\%regilero\fP) MULTILINE pattern cannot work in file.replace, fileinput always reads line by line. (refs: \fI\%#28174\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28666\fP: (\fI\%jfindlay\fP) define r_data before using it in file module
@ \fI2015\-11\-07 00:46:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28174\fP: (\fI\%lorengordon\fP) Add support for multiline regex in file.replace (refs: \fI\%#28666\fP)
.IP \(bu 2
4ad5056066 Merge pull request \fI\%#28666\fP from jfindlay/r_data
.IP \(bu 2
29228f445f define r_data before using it in file module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24758\fP: (\fI\%zerthimon\fP) salt\-minion uses 100% CPU for periodic status.master task on a server with a lot of TCP connections (a LB). (refs: \fI\%#28662\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28662\fP: (\fI\%cachedout\fP) Add note about disabling master_alive_interval
@ \fI2015\-11\-07 00:38:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
e129e889ad Merge pull request \fI\%#28662\fP from cachedout/issue_24758
.IP \(bu 2
78f4894333 Add note about disabling master_alive_interval
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28627\fP: (\fI\%twangboy\fP) Backport win_useradd
@ \fI2015\-11\-06 16:57:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
df121d0cec Merge pull request \fI\%#28627\fP from twangboy/backport_win_useradd
.IP \(bu 2
87282b6354 Backport win_useradd
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28398\fP: (\fI\%L4rS6\fP) Permissions /var/cache/salt/minion/extmods (refs: \fI\%#28617\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28617\fP: (\fI\%cachedout\fP) Set restrictive umask on module sync
@ \fI2015\-11\-05 23:43:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
64a20228c6 Merge pull request \fI\%#28617\fP from cachedout/umask_module_sync
.IP \(bu 2
227792e158 Set restrictive umask on module sync
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28621\fP: (\fI\%gravyboat\fP) Puppet module documentation should be less insulting (refs: \fI\%#28622\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28622\fP: (\fI\%gravyboat\fP) Update puppet module wording
@ \fI2015\-11\-05 20:34:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
065f8c7fb3 Merge pull request \fI\%#28622\fP from gravyboat/update_puppet_module_docs
.IP \(bu 2
4ea28bed30 Update puppet module wording
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#655\fP: (\fI\%thatch45\fP) Add general command management to service (refs: #\(gasaltstack/salt\-bootstrap#656\(ga_)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#674\fP: (\fI\%jfindlay\fP) add support for repo.saltstack.com (refs: \fI\%#28563\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#665\fP: (\fI\%mbologna\fP) Change to \(aqdnf\(aq as package manager for Fedora 22\-> (refs: \fI\%#28563\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#656\fP: (\fI\%eyj\fP) Add bootstrap \-b flag (don\(aqt install dependencies) (refs: \fI\%#28563\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#654\fP: (\fI\%hedinfaok\fP) Fixes error finding python\-jinja2 in RHEL 7 (refs: \fI\%#28563\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#653\fP: (\fI\%cbuechler\fP) Make bootstrap work with FreeBSD 11\-CURRENT. (refs: \fI\%#28563\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28563\fP: (\fI\%s0undt3ch\fP) [2015.5] Update to latest bootstrap script v2015.11.04
@ \fI2015\-11\-04 15:16:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
08295de5a5 Merge pull request \fI\%#28563\fP from s0undt3ch/2015.5
.IP \(bu 2
16f4db79a0 Update to latest bootstrap script v2015.11.04
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28173\fP: (\fI\%twangboy\fP) system.computer_name does not work in windows (refs: \fI\%#28541\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28541\fP: (\fI\%twangboy\fP) Fixed problem with system.set_computer_name
@ \fI2015\-11\-04 14:48:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
1e09f186ce Merge pull request \fI\%#28541\fP from twangboy/fix_28173
.IP \(bu 2
7edf5ce370 Fixed problem with system.set_computer_name
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28524\fP: (\fI\%bmcorser\fP) UnicodeDecodeError in states.file (refs: \fI\%#28538\fP, \fI\%#28537\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28538\fP: (\fI\%jfindlay\fP) decode path and url to utf\-8 in url.create (refs: \fI\%#28537\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28537\fP: (\fI\%jfindlay\fP) decode filename to utf\-8 in file.recurse state
@ \fI2015\-11\-04 14:48:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
f44ed780b5 Merge pull request \fI\%#28537\fP from jfindlay/decode_state_2015.5
.IP \(bu 2
06e514940c decode filename to utf\-8 in file.recurse state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28272\fP: (\fI\%gravyboat\fP) Update documentation contributing docs to explain how to PR against different releases (refs: \fI\%#28529\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28529\fP: (\fI\%rallytime\fP) Update contributing and documentation pages to recommend submitting against branches
@ \fI2015\-11\-04 14:47:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
6acf87593f Merge pull request \fI\%#28529\fP from rallytime/fix\-28272
.IP \(bu 2
a959681858 Add link to Sending a GH PR to documentation docs
.IP \(bu 2
1c612e2772 Update contributing and documentation pages to recommend submitting against branches
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28511\fP: (\fI\%nghgd\fP) vmware clone task fails instead of waiting to completion (refs: \fI\%#28546\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28548\fP: (\fI\%nmadhok\fP) [Backport] [2015.5] Tasks can be in queued state instead of running
@ \fI2015\-11\-04 04:14:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28546\fP: (\fI\%nmadhok\fP) Tasks can be in queued state instead of running. (refs: \fI\%#28548\fP)
.IP \(bu 2
025bff2bf0 Merge pull request \fI\%#28548\fP from nmadhok/2015.5\-task\-error
.IP \(bu 2
804a0a6537 Tasks can be in queued state instead of running. Fixes \fI\%#28511\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24585\fP: (\fI\%utahcon\fP) No version data for SALT.STATES.VIRTUALENV in wiki (refs: \fI\%#28531\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28531\fP: (\fI\%rallytime\fP) Add versionadded directives to virtualenv_mod state/module
@ \fI2015\-11\-03 21:34:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
63bd3e52b3 Merge pull request \fI\%#28531\fP from rallytime/fix\-24585
.IP \(bu 2
bc577b2531 Add versionadded directives to virtualenv_mod state/module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28508\fP: (\fI\%twangboy\fP) Fixed windows tests
@ \fI2015\-11\-03 19:31:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea3bf972c4 Merge pull request \fI\%#28508\fP from twangboy/fix_unit_tests_windows
.IP \(bu 2
0da6ff7c50 Fixed some logic
.IP \(bu 2
cf1e059be5 Fixed windows tests
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28525\fP: (\fI\%rallytime\fP) Fix spacing in doc examples for boto_route53 state and module
@ \fI2015\-11\-03 19:30:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
73c5735fc1 Merge pull request \fI\%#28525\fP from rallytime/route53_spacing
.IP \(bu 2
6ab2ce615c Fix spacing in doc examples for boto_route53 state and module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28243\fP: (\fI\%guettli\fP) Docs: default value of state_auto_order ? (refs: \fI\%#28517\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28517\fP: (\fI\%rallytime\fP) Add state_auto_order defaults to True note to ordering docs
@ \fI2015\-11\-03 14:04:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
2d7f934f67 Merge pull request \fI\%#28517\fP from rallytime/fix\-28243
.IP \(bu 2
be8f650901 Punctuation.
.IP \(bu 2
fd846822c1 Add state_auto_order defaults to True note to ordering docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28512\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-11\-03 00:38:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
63ce8f78d5 Merge pull request \fI\%#28512\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
61c382133a Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
4bf56cad3f Merge pull request \fI\%#28461\fP from cachedout/issue_28455
.INDENT 2.0
.IP \(bu 2
097838ec0c Wrap all cache calls in state.sls in correct umask
.UNINDENT
.IP \(bu 2
f3e61db045 Merge pull request \fI\%#28407\fP from DSRCompany/issues/24910_token_auth_fix_2014
.INDENT 2.0
.IP \(bu 2
b7b5bec309 Don\(aqt request creds if auth with key.
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28448\fP: (\fI\%gwaters\fP) added a note to the tutorial for redhat derivatives
@ \fI2015\-10\-30 18:49:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
37ceae1e88 Merge pull request \fI\%#28448\fP from gwaters/add\-redhat\-notes
.IP \(bu 2
e70990704a added a note to the tutorial for those that redhat so they can use the state file too.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28406\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28381\fP to 2015.5
@ \fI2015\-10\-29 19:10:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28381\fP: (\fI\%JaseFace\fP) Add FreeBSD detection for VirtualBox (refs: \fI\%#28406\fP)
.IP \(bu 2
5ef50d60cd Merge pull request \fI\%#28406\fP from rallytime/bp\-28381
.IP \(bu 2
e5322d2c44 Add FreeBSD detection for VirtualBox
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28413\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28400\fP to 2015.5
@ \fI2015\-10\-29 18:06:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28400\fP: (\fI\%msciciel\fP) State pkg.installed: do not execute _preflight_check if not_installed list is empty in _find_install_targets (refs: \fI\%#28413\fP)
.IP \(bu 2
30d5f7bbae Merge pull request \fI\%#28413\fP from rallytime/bp\-28400
.IP \(bu 2
ae1921b922 Do not execute _preflight_check if not_installed list is empty in _find_install_targets. Calling with empty list on rhel/centos cause execution of repoquery \-\-whatprovides without pkg list which is memory consumptive task for host and also for red hat satellite server.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28366\fP: (\fI\%erchn\fP) mark repo not enabled when pkgrepo state passes in disable: True
@ \fI2015\-10\-29 15:55:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
045d540aff Merge pull request \fI\%#28366\fP from erchn/fix_yumpkg_mod_repo_disabled
.IP \(bu 2
8187a4ce20 re\-arrange things a bit to have less overall changes
.IP \(bu 2
f1d570ff18 move todelete above disabled check, add comment
.IP \(bu 2
64feec413f also remove disabled key from repo_opts
.IP \(bu 2
2f2ebb7bb6 mark repo not enabled when pkgrepo state passes in disable: True
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28372\fP: (\fI\%beverlcl\fP) use_carrier option for bonding network interfaces are setting invalid values (refs: \fI\%#28373\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28373\fP: (\fI\%beverlcl\fP) Fixing bug \fI\%#28372\fP for use_carrier option on bonding network interfaces.
@ \fI2015\-10\-29 14:45:57 UTC\fP
.INDENT 2.0
.IP \(bu 2
3923f4a569 Merge pull request \fI\%#28373\fP from beverlcl/fix\-use_carrier\-28372
.IP \(bu 2
32cffeceb6 Fixing bug \fI\%#28372\fP for use_carrier option on bonding network interfaces.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28359\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28358\fP to 2015.5
@ \fI2015\-10\-28 20:43:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28358\fP: (\fI\%arthurlogilab\fP) docstring typo fix \- list returners not runners (refs: \fI\%#28359\fP)
.IP \(bu 2
e07e3f257b Merge pull request \fI\%#28359\fP from rallytime/bp\-28358
.IP \(bu 2
9cacbf582b docstring typo fix \- list returners not runners
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28000\fP: (\fI\%hrumph\fP) No option to stop windows minion installer from starting service in silent mode. (refs: \fI\%#28346\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27923\fP: (\fI\%twangboy\fP) Salt Windows Installer fails to grab existing config (refs: \fI\%#28346\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28346\fP: (\fI\%twangboy\fP) Fix installer
@ \fI2015\-10\-28 14:21:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
282be7ba5a Merge pull request \fI\%#28346\fP from twangboy/fix_installer
.IP \(bu 2
f65e3e5275 Updated documentation to reflect the new parameter
.IP \(bu 2
a0c5223554 Fixes \fI\%#27923\fP and \fI\%#28000\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28315\fP: (\fI\%gwaters\fP) Adding a working example of setting pillar data on the cli
@ \fI2015\-10\-27 15:27:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
7858f04ebc Merge pull request \fI\%#28315\fP from gwaters/update\-pillar\-doc
.IP \(bu 2
b15285c0b4 adding a working example of setting pillar data on the cli
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28209\fP: (\fI\%basepi\fP) Legacy git_pillar configs cause duplicate ext_pillar calls (refs: \fI\%#28210\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28211\fP: (\fI\%terminalmage\fP) Fix for ext_pillar being compiled twice in legacy git_pillar code (2015.5 branch)
@ \fI2015\-10\-26 14:14:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28210\fP: (\fI\%terminalmage\fP) Fix for ext_pillar being compiled twice in legacy git_pillar code (refs: \fI\%#28211\fP)
.IP \(bu 2
45305ccf29 Merge pull request \fI\%#28211\fP from terminalmage/legacy_git_pillar\-2015.5
.IP \(bu 2
0d6a4ac115 Remove non\-functional test
.IP \(bu 2
ab991d61d9 Fix for ext_pillar being compiled twice in legacy git_pillar code (2015.5 branch)
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26411\fP: (\fI\%whiteinge\fP) salt\-call cannot send custom events without Minion daemon running (refs: \fI\%#28263\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28263\fP: (\fI\%cachedout\fP) New channel for event.send
@ \fI2015\-10\-26 14:07:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
a6cc84c407 Merge pull request \fI\%#28263\fP from cachedout/issue_26411\-1
.IP \(bu 2
3b880a5f07 New channel for event.fire_master
.IP \(bu 2
29e9533aab Stand up a new channel if using salt\-call
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28293\fP: (\fI\%cachedout\fP) Minor grammar changes
@ \fI2015\-10\-26 12:15:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28271\fP: (\fI\%gwaters\fP) Update tutorial documentation (refs: \fI\%#28293\fP)
.IP \(bu 2
788e1463d8 Merge pull request \fI\%#28293\fP from cachedout/fix_28271
.IP \(bu 2
499ed8519b Minor grammar changes to \fI\%#28271\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28271\fP: (\fI\%gwaters\fP) Update tutorial documentation (refs: \fI\%#28293\fP)
@ \fI2015\-10\-26 12:12:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
e178af0b90 Merge pull request \fI\%#28271\fP from gwaters/update\-tutorial\-documentation
.IP \(bu 2
f96d39483d updated the tutorial with gravyboat\(aqs suggestions
.IP \(bu 2
b1f4a2bdf4 i think i changed the wrong header, updated to fix
.IP \(bu 2
846b3aece1 I found you can not run the cp.push commands until after enabling the feature in the conf, so I wanted to update the docs so others who try these commands won\(aqt bump into the same issue I had.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28248\fP: (\fI\%0xf10e\fP) conventions/formula.rst: \(dqGather external data\(dq suggests unavailable jinja functionality (refs: \fI\%#28280\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28280\fP: (\fI\%0xf10e\fP) Correct Jinja function load_* to import_*
@ \fI2015\-10\-25 04:11:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
e3eff9b909 Merge pull request \fI\%#28280\fP from 0xf10e/patch\-1
.IP \(bu 2
6d4316b0ac Correct Jinja function load_* to import_*
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28255\fP: (\fI\%cachedout\fP) Add __cli opt
@ \fI2015\-10\-23 18:44:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
909fa3dc97 Merge pull request \fI\%#28255\fP from cachedout/cli_opt
.IP \(bu 2
a2408157de Add __cli opt
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27374\fP: (\fI\%mool\fP) boto_route53 state doesn\(aqt create a record (refs: \fI\%#28213\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28213\fP: (\fI\%rallytime\fP) If record returned None, don\(aqt continue with the state. Something went wrong
@ \fI2015\-10\-23 13:54:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
0fa094ae11 Merge pull request \fI\%#28213\fP from rallytime/boto_route53_state
.IP \(bu 2
237d64ff11 If record returned None, don\(aqt continue with the state. Something went wrong.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28217\fP: (\fI\%Ch3LL\fP) Scheduler.present tries to add the scheudler each time (refs: \fI\%#28238\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28238\fP: (\fI\%basepi\fP) [2015.5] Fix schedule.present always diffing
@ \fI2015\-10\-23 13:31:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
1768014705 Merge pull request \fI\%#28238\fP from basepi/fix.schedule.present.28217
.IP \(bu 2
087a8dc3c2 Only insert enabled if it\(aqs a dict
.IP \(bu 2
5b49f41fab Fix schedule comparison to adjust for \(aqenabled\(aq being added in schedule.list
.IP \(bu 2
2dc1226ab8 Build new item with \(aqenabled\(aq if available
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#8051\fP: (\fI\%regilero\fP) Problems with fileinput.input inplace editing in salt.states.file.replace (refs: \fI\%#28174\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#7999\fP: (\fI\%regilero\fP) MULTILINE pattern cannot work in file.replace, fileinput always reads line by line. (refs: \fI\%#28174\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28174\fP: (\fI\%lorengordon\fP) Add support for multiline regex in file.replace (refs: \fI\%#28666\fP)
@ \fI2015\-10\-22 14:02:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
bdd48c92de Merge pull request \fI\%#28174\fP from lorengordon/file\-replace\-multiline
.IP \(bu 2
acdef2da60 Update docstrings with new guidance
.IP \(bu 2
0835b005b7 Use a test that makes the extra file read unnecessary
.IP \(bu 2
6d6121a6e5 Use \fIflags\fP when checking whether content was added previously
.IP \(bu 2
b25e609e9e Set \fIflags=8\fP since now the file is read as a MULTILINE string by default
.IP \(bu 2
89e8dcdffd Use \fIfinally\fP block to ensure mmap object is closed
.IP \(bu 2
5aea6647c9 Add support for multiline regex in file.replace
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19673\fP: (\fI\%holyzhou\fP) partition.mkpart in parted modules doesn\(aqt work (refs: \fI\%#28175\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28175\fP: (\fI\%twangboy\fP) Fixes \fI\%#19673\fP
@ \fI2015\-10\-21 20:48:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
2225925fb5 Merge pull request \fI\%#28175\fP from twangboy/fix_19673
.IP \(bu 2
ae8fbb208f Fixes \fI\%#19673\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28140\fP: (\fI\%rallytime\fP) Add OpenBSD installation documentation to 2015.5 branch
@ \fI2015\-10\-20 16:31:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28103\fP: (\fI\%ajacoutot\fP) OpenBSD salt package: update list of dependencies. (refs: \fI\%#28140\fP)
.IP \(bu 2
ab18dcf637 Merge pull request \fI\%#28140\fP from rallytime/bsd\-installation\-doc
.IP \(bu 2
458a544d83 Add OpenBSD installation documentation to 2015.5 branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28101\fP: (\fI\%bogdanr\fP) salt\-cloud ec2 list\-sizes doesn\(aqt show all available sizes (refs: \fI\%#28138\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28138\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28130\fP EC2 Sizes Only portion to 2015.5
@ \fI2015\-10\-20 16:29:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28130\fP: (\fI\%bogdanr\fP) Ec2 upload public key and updated instances size list (refs: \fI\%#28138\fP)
.IP \(bu 2
fad38eb3c3 Merge pull request \fI\%#28138\fP from rallytime/bp\-28130\-sizes\-only
.IP \(bu 2
6ab31e1886 Pylint
.IP \(bu 2
37e4ed58a9 Added missing comma
.IP \(bu 2
667f5e669f Added a bunch of instance sizes and updated some outdated ones
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26844\fP: (\fI\%double\-yaya\fP) The function \(dqstate.sls\(dq is running as PID XXXX and was started at .... with jid XXXX always shows the current jid (refs: \fI\%#28097\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28097\fP: (\fI\%jacksontj\fP) For all multi\-part messages, check the headers. If the header is not …
@ \fI2015\-10\-20 15:00:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce8f858536 Merge pull request \fI\%#28097\fP from jacksontj/2015.5
.IP \(bu 2
75e04bcbbc For all multi\-part messages, check the headers. If the header is not your minion_id, skip the message
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23655\fP: (\fI\%arthurlogilab\fP) salt\-cloud with lxc should not traceback when minion is unreacheable (refs: \fI\%#28117\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28117\fP: (\fI\%rallytime\fP) Clean up stacktrace when master can\(aqt be reached in lxc cloud driver
@ \fI2015\-10\-20 12:41:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
9cdb970289 Merge pull request \fI\%#28117\fP from rallytime/fix\-23655
.IP \(bu 2
dfb908e405 Clean up stacktrace when master can\(aqt be reached in lxc cloud driver
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28110\fP: (\fI\%terminalmage\fP) Add explanation of file_client: local setting masterless mode
@ \fI2015\-10\-20 12:28:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
bf7ed0a397 Merge pull request \fI\%#28110\fP from terminalmage/masterless\-mode
.IP \(bu 2
ed90103124 Add explanation of file_client: local setting masterless mode
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27940\fP: (\fI\%multani\fP) salt\-cloud creating lxc containers doesn\(aqt fire \(dqsalt/cloud/*/created\(dq event (refs: \fI\%#28109\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28109\fP: (\fI\%rallytime\fP) Add created reactor event to lxc cloud driver
@ \fI2015\-10\-19 20:32:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
a569ef4980 Merge pull request \fI\%#28109\fP from rallytime/fix\-27940
.IP \(bu 2
18b2245611 Add created reactor event to lxc cloud driver
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21845\fP: (\fI\%kitsemets\fP) pip.install: fails in v2015.2.0rc1 when the package is already installed (pip v1.0) (refs: \fI\%#27996\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27996\fP: (\fI\%rallytime\fP) Don\(aqt fail if pip package is already present and pip1 is installed
@ \fI2015\-10\-19 12:59:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
d4604fdb26 Merge pull request \fI\%#27996\fP from rallytime/fix\-21845
.IP \(bu 2
f8380d751e Provide empty string as default stdout instead of None
.IP \(bu 2
f9406b5828 Don\(aqt fail if pip package is already present and pip1 is installed
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28056\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28033\fP to 2015.5
@ \fI2015\-10\-19 12:55:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28033\fP: (\fI\%twangboy\fP) Fixed win_useradd.py (refs: \fI\%#28056\fP)
.IP \(bu 2
28b97c514f Merge pull request \fI\%#28056\fP from rallytime/bp\-28033
.IP \(bu 2
af2c5ab759 Fixed win_useradd.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28059\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28040\fP to 2015.5
@ \fI2015\-10\-18 16:17:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28040\fP: (\fI\%erchn\fP) Swift rackspace fixes (refs: \fI\%#28059\fP)
.IP \(bu 2
dfc3aaec74 Merge pull request \fI\%#28059\fP from rallytime/bp\-28040
.IP \(bu 2
76a0d4937b Revert \(dqAllow passing in auth_version, defaulting to 2.\(dq
.IP \(bu 2
63d5675d34 default auth_version = 2
.IP \(bu 2
8072716888 remove extra spaces
.IP \(bu 2
9770f56f04 cleanup whitespace, default to None to be consistent with profile
.IP \(bu 2
f4adfe98c0 Allow passing in auth_version, defaulting to 2.
.IP \(bu 2
fab1ad39af Rackspace support for switft module.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27534\fP: (\fI\%llevar\fP) file.managed can\(aqt retrieve file via ftp (refs: \fI\%#28047\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28047\fP: (\fI\%cachedout\fP) Restore FTP functionality to file client
@ \fI2015\-10\-18 16:16:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
d1fa036b55 Merge pull request \fI\%#28047\fP from cachedout/issue_27534
.IP \(bu 2
6ea37ddbca Context manager
.IP \(bu 2
4d6f6bb371 Lint
.IP \(bu 2
59018289dc Restore FTP functionality to file client
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28032\fP: (\fI\%twangboy\fP) Fixed win_path.py
@ \fI2015\-10\-17 15:16:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd2ca2df1b Merge pull request \fI\%#28032\fP from twangboy/fix_win_path
.IP \(bu 2
2bcac93314 Fixed win_path.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26336\fP: (\fI\%jfindlay\fP) windows user.present broken (refs: \fI\%#28003\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28037\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28003\fP to 2015.5
@ \fI2015\-10\-16 20:59:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28003\fP: (\fI\%twangboy\fP) Fix \fI\%#26336\fP (refs: \fI\%#28037\fP)
.IP \(bu 2
88c1770be4 Merge pull request \fI\%#28037\fP from rallytime/bp\-28003
.IP \(bu 2
4fcf51fb1e Fix PR \fI\%#26336\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28031\fP: (\fI\%jacobhammons\fP) Updated release notes with additional CVE information
@ \fI2015\-10\-16 16:19:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
de727d8bd2 Merge pull request \fI\%#28031\fP from jacobhammons/relnotes6
.IP \(bu 2
05927bb6f0 Updated release notes with additional CVE information
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27897\fP: (\fI\%Inveracity\fP) request to add \e\er escape character for salt.states.host for windows (refs: \fI\%#28008\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28008\fP: (\fI\%jfindlay\fP) platform independent line endings in hosts mod
@ \fI2015\-10\-16 13:20:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
16c0272849 Merge pull request \fI\%#28008\fP from jfindlay/host_path
.IP \(bu 2
9f7047dd3c platform independent line endings in hosts mod
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28010\fP: (\fI\%vakulich\fP) Error \(dqKeyError: \(aqret\(aq\(dq appeared during salt.state run in orchestrate module if minion had an exception (refs: \fI\%#28012\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28012\fP: (\fI\%rallytime\fP) Clean up stack trace when something goes wrong with minion output
@ \fI2015\-10\-16 12:40:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
d41018fa8e Merge pull request \fI\%#28012\fP from rallytime/fix\-28010
.IP \(bu 2
0d7059e0c2 Clean up stack trace when something goes wrong with minion output
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27995\fP: (\fI\%jacobhammons\fP) added link to grains security FAQ to targeting and pillar topics.
@ \fI2015\-10\-15 21:15:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
f728307001 Merge pull request \fI\%#27995\fP from jacobhammons/pillar\-doc
.IP \(bu 2
2870af2ba3 added link to grains security FAQ to targeting and pillar topics.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27986\fP: (\fI\%jacobhammons\fP) Changed current release to 5.6 and added CVE to release notes
@ \fI2015\-10\-15 17:25:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
efede904a7 Merge pull request \fI\%#27986\fP from jacobhammons/dot6
.IP \(bu 2
bb61c68c11 Changed current release to 5.6 and added CVE to release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27913\fP: (\fI\%pass\-by\-value\fP) Set default
@ \fI2015\-10\-14 14:03:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
831ec680d9 Merge pull request \fI\%#27913\fP from pass\-by\-value/proxmox_verify_ssl
.IP \(bu 2
0b721efe37 Set default
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27876\fP: (\fI\%terminalmage\fP) 2015.5 branch: Fix traceback when 2015.8 git ext_pillar config schema used
@ \fI2015\-10\-13 14:58:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
41cccb3a30 Merge pull request \fI\%#27876\fP from terminalmage/git_pillar\-AttributeError\-2015.5
.IP \(bu 2
07794c837a 2015.5 branch: Fix traceback when 2015.8 git ext_pillar config schema used
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27610\fP: (\fI\%benburkert\fP) PR \fI\%#27201\fP broke ssh_known_hosts with :port (refs: \fI\%#27726\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27187\fP: (\fI\%SeverinLeonhardt\fP) ssh_known_hosts.present hashes other entries even with hash_hostname: false (refs: \fI\%#27201\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27726\fP: (\fI\%jfindlay\fP) deprecate hash_hostname in favor of hash_known_hosts
@ \fI2015\-10\-12 16:19:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27201\fP: (\fI\%jfindlay\fP) rename hash_hostname to hash_known_hosts (refs: \fI\%#27726\fP)
.IP \(bu 2
c9c3b7760e Merge pull request \fI\%#27726\fP from jfindlay/hashhosts
.IP \(bu 2
ebce47de7c add docs to ssh.recv_known_host exec module fcn
.IP \(bu 2
b6ee16b1e5 deprecate hash_hostname in favor of hash_known_hosts
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27735\fP: (\fI\%go8ose\fP) saltutils.find_cached_job doesn\(aqt work (refs: \fI\%#27776\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27776\fP: (\fI\%jfindlay\fP) return message when local jobs_cache not found
@ \fI2015\-10\-12 16:11:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
18e31584b0 Merge pull request \fI\%#27776\fP from jfindlay/local_msg
.IP \(bu 2
03afa3cffa return message when local jobs_cache not found
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27665\fP: (\fI\%ahammond\fP) user.absent should not \(dqfail\(dq if /var/spool/mail/<user> already does not exist. (refs: \fI\%#27766\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27766\fP: (\fI\%jfindlay\fP) better check for debian userdel error
@ \fI2015\-10\-12 15:14:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
86cc7b5537 Merge pull request \fI\%#27766\fP from jfindlay/debmail
.IP \(bu 2
ee78da2c27 better check for debian userdel error
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27756\fP: (\fI\%iggy\fP) syslog returner formats line incorrectly (refs: \fI\%#27758\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27758\fP: (\fI\%iggy\fP) Remove redundant text from syslog returner
@ \fI2015\-10\-12 15:09:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
c224386c9a Merge pull request \fI\%#27758\fP from iggy/patch\-1
.IP \(bu 2
0994fb6a8c Remove redundant text from syslog returner
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27832\fP: (\fI\%viking60\fP) Salt fails to recognize Manjaro (as an Arch derivate) (refs: \fI\%#27841\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27841\fP: (\fI\%terminalmage\fP) Detect Manjaro Linux as Arch derivative
@ \fI2015\-10\-12 14:53:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
34a005041f Merge pull request \fI\%#27841\fP from terminalmage/issue27832
.IP \(bu 2
8e09fbd6a3 Detect Manjaro Linux as Arch derivative
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26538\fP: (\fI\%seanjnkns\fP) salt.states.file.managed generates warning when used in place of salt.states.file.touch (refs: \fI\%#27806\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27852\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27806\fP to 2015.5
@ \fI2015\-10\-12 14:53:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27806\fP: (\fI\%blast\-hardcheese\fP) Empty string is falsy (refs: \fI\%#27852\fP)
.IP \(bu 2
3944a498ad Merge pull request \fI\%#27852\fP from rallytime/bp\-27806
.IP \(bu 2
a84bf18bc4 Empty string is falsy
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27831\fP: (\fI\%basepi\fP) v2015.5.5 highstate outputter stacktracing for jobs.lookup_jid (refs: \fI\%#27838\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27838\fP: (\fI\%basepi\fP) [2015.5] Fix highstate outputter for jobs.lookup_jid
@ \fI2015\-10\-09 22:26:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25521\fP: (\fI\%cachedout\fP) Fix outputter for state.orch (refs: \fI\%#27838\fP)
.IP \(bu 2
7508a1c474 Merge pull request \fI\%#27838\fP from basepi/fix.runner.highstate.outputter.27831
.IP \(bu 2
8ae9b66fd9 Don\(aqt pop \(aqoutputter\(aq, we expect it further down
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27791\fP: (\fI\%eguven\fP) 2015.5 postgres_user groups backport
@ \fI2015\-10\-08 23:59:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
d178315f93 Merge pull request \fI\%#27791\fP from eguven/2015.5\-postgres\-user\-groups\-backport
.IP \(bu 2
2caf1d21d6 fix test
.IP \(bu 2
bc90c5bffe improve change reporting for postgres_user groups
.IP \(bu 2
8712bce91a backport postgres_user groups
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27759\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-10\-07 18:01:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
b2937b6a16 Merge pull request \fI\%#27759\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
792ee084bb Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
d284eb165b Merge pull request \fI\%#27390\fP from JaseFace/schedule\-missing\-enabled
.IP \(bu 2
563db71bfd Ensure we pass on the enable setting if present, or use the default of True if not in build_schedule_item() Prior to this, when schedule.present compares the existing schedule to the one crafted by this function, enabled will actually be removed at each run.  schedule.present sees a modification needs to be made, and invokes schedule.modify, which does so with enabled: True, creating and endless loop of an \(aqenabled\(aq removal and addition.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26673\fP: (\fI\%robkinyon\fP) __virtual__() doesn\(aqt work without __virtualname__ (refs: \fI\%#27732\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27732\fP: (\fI\%jacobhammons\fP) update docs for __virtual__ and __virtualname__
@ \fI2015\-10\-07 17:29:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
4b9128b491 Merge pull request \fI\%#27732\fP from jacobhammons/26673
.IP \(bu 2
75cc07cf10 noted that __virtual__ can return False and an error string
.IP \(bu 2
b928e1afa8 update docs for __virtual__ and __virtualname__ Refs \fI\%#26673\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27747\fP: (\fI\%Sacro\fP) Chocolatey doesn\(aqt have a help command.
@ \fI2015\-10\-07 16:06:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
a130896d1c Merge pull request \fI\%#27747\fP from Sacro/fix\-chocolatey\-version
.IP \(bu 2
8f1fa9e78e Chocolatey doesn\(aqt have a help command.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27733\fP: (\fI\%jacobhammons\fP) hardening topic \- updates to docs.saltproject.io theme
@ \fI2015\-10\-07 01:44:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
4e48651de0 Merge pull request \fI\%#27733\fP from jacobhammons/bug\-fixes
.IP \(bu 2
cbecd4f553 Updated saltstack2 theme to add SaltConf16 banner
.IP \(bu 2
117e0c2bcc Added hardening topic based on the information in Refs \fI\%#27088\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#9051\fP: (\fI\%olenz\fP) Add bash completion to the docs (refs: \fI\%#27706\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#27005\fP: (\fI\%johanek\fP) grains precedence (refs: \fI\%#27706\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#21475\fP: (\fI\%quantonganh\fP) Targeting with pillar should be added in to the main targeting page (refs: \fI\%#27706\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#14876\fP: (\fI\%whiteinge\fP) Create a pre\-Salted tutorial VM (refs: \fI\%#27706\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#13407\fP: (\fI\%gravyboat\fP) Create page explaining how to pass variables on the command line (refs: \fI\%#27706\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27706\fP: (\fI\%jacobhammons\fP) Assorted doc bugs
@ \fI2015\-10\-06 05:35:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
c58da846bf Merge pull request \fI\%#27706\fP from jacobhammons/bug\-fixes
.IP \(bu 2
76dc8de71b Assorted doc bugs Refs \fI\%#9051\fP Refs \fI\%#13407\fP Refs \fI\%#21475\fP Refs \fI\%#14876\fP Refs \fI\%#27005\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27695\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27671\fP to 2015.5
@ \fI2015\-10\-05 21:57:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27671\fP: (\fI\%gashev\fP) Added skip test_ext_pillar_env_mapping if git module does not exist. (refs: \fI\%#27695\fP)
.IP \(bu 2
43fba89865 Merge pull request \fI\%#27695\fP from rallytime/bp\-27671
.IP \(bu 2
2a88028595 Added skip test_ext_pillar_env_mapping if git module does not exist.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27501\fP: (\fI\%yermulnik\fP) [FreeBSD] \(dqpkg search\(dq behavior changed since 1.5 series (refs: \fI\%#27524\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27524\fP: (\fI\%jfindlay\fP) parse pkgng output in quiet mode for >= 1.6.1
@ \fI2015\-10\-05 21:22:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
cb3d92676e Merge pull request \fI\%#27524\fP from jfindlay/pkgng_quiet
.IP \(bu 2
5e9107b970 parse pkgng output in quiet mode for >= 1.6.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27686\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27476\fP to 2015.5
@ \fI2015\-10\-05 21:17:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27476\fP: (\fI\%belvedere\-trading\fP) fix for: \fI\%https://github.com/saltstack/salt/issues/27373\fP (refs: \fI\%#27686\fP)
.IP \(bu 2
5b88c55cc3 Merge pull request \fI\%#27686\fP from rallytime/bp\-27476
.IP \(bu 2
3e08d3de8a fix for: \fI\%https://github.com/saltstack/salt/issues/27373\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27655\fP: (\fI\%gracinet\fP) postgres_local_cache handling of success (refs: \fI\%#27656\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27684\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27656\fP to 2015.5
@ \fI2015\-10\-05 21:17:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27656\fP: (\fI\%gracinet\fP) Fix \fI\%#27655\fP: handling of success in postgres_local_cache (refs: \fI\%#27684\fP)
.IP \(bu 2
f9ddd4647f Merge pull request \fI\%#27684\fP from rallytime/bp\-27656
.IP \(bu 2
d3780cba00 Fix \fI\%#27655\fP: handling of success in postgres_local_cache
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27683\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27659\fP to 2015.5
@ \fI2015\-10\-05 21:17:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27659\fP: (\fI\%gnubyexample\fP) .pub as public key is what we should send to remote (refs: \fI\%#27683\fP)
.IP \(bu 2
7ca6f854ff Merge pull request \fI\%#27683\fP from rallytime/bp\-27659
.IP \(bu 2
84b6ee0c58 .pub as public key is what we should send to remote
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27682\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27566\fP to 2015.5
@ \fI2015\-10\-05 21:17:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27566\fP: (\fI\%blueyed\fP) returners.local_cache: fix endless loop on OSError (refs: \fI\%#27682\fP)
.IP \(bu 2
a0f3e34656 Merge pull request \fI\%#27682\fP from rallytime/bp\-27566
.IP \(bu 2
2a44255748 minor: fix/format doc for returners.local_cache.prep_jid
.IP \(bu 2
fd485e2396 returners.local_cache: fix endless loop on OSError
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25813\fP: (\fI\%whytewolf\fP) debconf.set throwing exception in 2015.8.0rc2 (refs: \fI\%#25928\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27681\fP: (\fI\%rallytime\fP) Back\-port \fI\%#25928\fP to 2015.5
@ \fI2015\-10\-05 21:17:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#25928\fP: (\fI\%cachedout\fP) Fix stacktrace for non\-existant states (refs: \fI\%#27681\fP)
.IP \(bu 2
0b9ba911c4 Merge pull request \fI\%#27681\fP from rallytime/bp\-25928
.IP \(bu 2
17e1ddf137 Fix stacktrace for non\-existant states
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27505\fP: (\fI\%silenius\fP) [FreeBSD] state.service + provider daemontools is broken (refs: \fI\%#27535\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27680\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27535\fP to 2015.5
@ \fI2015\-10\-05 21:17:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27535\fP: (\fI\%silenius\fP) Issue 27505 (refs: \fI\%#27680\fP)
.IP \(bu 2
23da0d316a Merge pull request \fI\%#27680\fP from rallytime/bp\-27535
.IP \(bu 2
04aed5e105 Versionadded change since 2015.5.6 has already been tagged
.IP \(bu 2
579f2646ba .. versionadded:: 2015.5.6
.IP \(bu 2
cbaf46e066 python <2.7 compatibility (pylint issue)
.IP \(bu 2
ecde499478 s/bin/b to avoid confusion with bin()
.IP \(bu 2
4237c5db80 add a __virtual__ to check that daemontools is installed properly
.IP \(bu 2
623935a1bc fix doc
.IP \(bu 2
573de3abd6 fix pylint issue
.IP \(bu 2
5eb6a30d40 fix pep8 issues
.IP \(bu 2
298cf4f5c0 import missing logging module
.IP \(bu 2
fe0ad36609 log was missing
.IP \(bu 2
e457083465 s/systemd/FreeBSD
.IP \(bu 2
3512712e89 forgot service name..
.IP \(bu 2
8f193a7bcc fixes \fI\%#27505\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27442\fP: (\fI\%JaseFace\fP) Ensure we pass on the enable setting if present, or use the default of True if not in build_schedule_item()
@ \fI2015\-10\-05 18:01:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
7d7b97eab6 Merge pull request \fI\%#27442\fP from JaseFace/fix\-27391\-for\-2015.5
.IP \(bu 2
bfbf63e1cc Ensure we pass on the enable setting if present, or use the default of True if not in build_schedule_item() Prior to this, when schedule.present compares the existing schedule to the one crafted by this function, enabled will actually be removed at each run.  schedule.present sees a modification needs to be made, and invokes schedule.modify, which does so with enabled: True, creating and endless loop of an \(aqenabled\(aq removal and addition.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26320\fP: (\fI\%schlagify\fP) pkg & diskusage beacons not sending alerts (refs: \fI\%#27641\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27641\fP: (\fI\%rallytime\fP) Gate the psutil import and add depends doc for diskusage beacon
@ \fI2015\-10\-05 17:00:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
ccbba8656b Merge pull request \fI\%#27641\fP from rallytime/gate\-psutil\-diskusage
.IP \(bu 2
da2d93a3dd Gate the psutil import and add depends doc for diskusage beacon
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27644\fP: (\fI\%rallytime\fP) Back\-port \fI\%#27640\fP to 2015.5
@ \fI2015\-10\-05 14:55:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#27640\fP: (\fI\%stephen144\fP) fix typo in default pillar path (refs: \fI\%#27644\fP)
.IP \(bu 2
09183994f9 Merge pull request \fI\%#27644\fP from rallytime/bp\-27640
.IP \(bu 2
a9063a9745 fix typo in default pillar path
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27609\fP: (\fI\%rallytime\fP) GCE with various external_ip settings cause stacktraces (refs: \fI\%#27612\fP)
.IP \(bu 2
\fBPR\fP \fI\%#27612\fP: (\fI\%rallytime\fP) Fix GCE external_ip stacktraces in 2015.5
@ \fI2015\-10\-02 15:42:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
27fcecccbe Merge pull request \fI\%#27612\fP from rallytime/fix\-27609
.IP \(bu 2
8dc047dc18 If external_up is set to None, don\(aqt stacktrace, just use the private ip.
.IP \(bu 2
2ebf790f9f [salt\-cloud] gce: don\(aqt stacktrace if Ephemeral is given instead of ephemeral
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27568\fP: (\fI\%jacobhammons\fP) regenerated man pages
@ \fI2015\-10\-01 15:39:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
c84a1edc1b Merge pull request \fI\%#27568\fP from jacobhammons/man\-pages\-five
.IP \(bu 2
b59c03d20d regenerated man pages
.UNINDENT
.UNINDENT
.SS Salt 2015.5.8 Release Notes
.INDENT 0.0
.TP
.B release
2015\-12\-01
.UNINDENT
.sp
Version 2015.5.8 is a bugfix release for \fI\%2015.5.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB17\fP
.IP \(bu 2
Total Issue References: \fB12\fP
.IP \(bu 2
Total PR References: \fB27\fP
.IP \(bu 2
Contributors: \fB12\fP (\fI\%MasterNayru\fP, \fI\%TronPaul\fP, \fI\%basepi\fP, \fI\%cachedout\fP, \fI\%cxmcc\fP,
\fI\%jfindlay\fP, \fI\%kevinlondon\fP, \fI\%messa\fP, \fI\%rallytime\fP, \fI\%tehmaspc\fP, \fI\%twangboy\fP, \fI\%whiteinge\fP)
.UNINDENT
.SS Security Fix
.sp
\fBCVE\-2015\-8034\fP Saving \fI\%state.sls\fP cache
data to disk with insecure permissions
.sp
This affects users of the \fI\%state.sls\fP
function. The state run cache on the minion was being created with incorrect
permissions. This file could potentially contain sensitive data that was
inserted via jinja into the state SLS files. The permissions for this file are
now being set correctly. Thanks to \fI\%zmalone\fP for bringing this issue to our
attention.
.SS Changelog for v2015.5.7..v2015.5.8
.sp
\fIGenerated at: 2018\-05\-27 22:25:07 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBISSUE\fP \fI\%#28883\fP: (\fI\%ldelossa\fP) Issues running select states \-  local variable \(aqsalt\(aq referenced before assignment (refs: \fI\%#29113\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29164\fP: (\fI\%jfindlay\fP) Backport \fI\%#29113\fP
@ \fI2015\-11\-24 21:26:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29113\fP: (\fI\%TronPaul\fP) Kill unneeded import (refs: \fI\%#29164\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28740\fP: (\fI\%MasterNayru\fP) Add missing S3 module import (refs: \fI\%#28839\fP, \fI\%#29113\fP)
.IP \(bu 2
a26c10a811 Merge pull request \fI\%#29164\fP from jfindlay/bp\-29113
.IP \(bu 2
50fab35188 kill unneeded import
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29138\fP: (\fI\%jfindlay\fP) add 2015.5.8 release notes
@ \fI2015\-11\-23 23:22:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
4f03196e7d Merge pull request \fI\%#29138\fP from jfindlay/2015.5
.IP \(bu 2
be045f5cb1 add 2015.5.8 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29110\fP: (\fI\%mohshami\fP) 2015.8.2 broke orchestration (refs: \fI\%#29122\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#28010\fP: (\fI\%vakulich\fP) Error \(dqKeyError: \(aqret\(aq\(dq appeared during salt.state run in orchestrate module if minion had an exception (refs: \fI\%#28012\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29128\fP: (\fI\%cachedout\fP) Set a safer default value for ret in saltmod
@ \fI2015\-11\-23 17:07:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29122\fP: (\fI\%cachedout\fP) Fix broken state orchestration (refs: \fI\%#29128\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28012\fP: (\fI\%rallytime\fP) Clean up stack trace when something goes wrong with minion output (refs: \fI\%#29122\fP)
.IP \(bu 2
219367a23d Merge pull request \fI\%#29128\fP from cachedout/tweak_29122
.IP \(bu 2
b08858b040 Missed check
.IP \(bu 2
584efe81ee Set a safer default value for ret in saltmod
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29110\fP: (\fI\%mohshami\fP) 2015.8.2 broke orchestration (refs: \fI\%#29122\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#28010\fP: (\fI\%vakulich\fP) Error \(dqKeyError: \(aqret\(aq\(dq appeared during salt.state run in orchestrate module if minion had an exception (refs: \fI\%#28012\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29122\fP: (\fI\%cachedout\fP) Fix broken state orchestration (refs: \fI\%#29128\fP)
@ \fI2015\-11\-23 16:24:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28012\fP: (\fI\%rallytime\fP) Clean up stack trace when something goes wrong with minion output (refs: \fI\%#29122\fP)
.IP \(bu 2
2250a36647 Merge pull request \fI\%#29122\fP from cachedout/issue_29110
.IP \(bu 2
4b9302d794 Fix broken state orchestration
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29096\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29093\fP to 2015.5
@ \fI2015\-11\-22 17:02:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29093\fP: (\fI\%cxmcc\fP) Compare gem versions as a string. (refs: \fI\%#29096\fP)
.IP \(bu 2
200e771efb Merge pull request \fI\%#29096\fP from rallytime/bp\-29093
.IP \(bu 2
f5734423a4 Compare gem versions as a string.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29084\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29055\fP to 2015.5
@ \fI2015\-11\-20 20:57:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29055\fP: (\fI\%cachedout\fP) Add section to style guide (refs: \fI\%#29084\fP)
.IP \(bu 2
d8a2018bc8 Merge pull request \fI\%#29084\fP from rallytime/bp\-29055
.IP \(bu 2
52e650aed9 Add section to style guide
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29083\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29053\fP to 2015.5
@ \fI2015\-11\-20 20:57:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29053\fP: (\fI\%kevinlondon\fP) Update rabbitmq_user.py (refs: \fI\%#29083\fP)
.IP \(bu 2
b5cff1a351 Merge pull request \fI\%#29083\fP from rallytime/bp\-29053
.IP \(bu 2
f1884de0e7 Update rabbitmq_user.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28928\fP: (\fI\%twangboy\fP) Fix user.present 2015.5 (refs: \fI\%#28932\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28932\fP: (\fI\%twangboy\fP) Fixed user.present / user.absent in windows
@ \fI2015\-11\-18 21:45:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28627\fP: (\fI\%twangboy\fP) Backport win_useradd (refs: \fI\%#28932\fP)
.IP \(bu 2
b3e3bebef0 Merge pull request \fI\%#28932\fP from twangboy/fix_28928
.IP \(bu 2
0653a04887 Fixed user.present / user.absent in windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26911\fP: (\fI\%dsumsky\fP) file.manage state does not work with Amazon S3 URLs on Windows (refs: \fI\%#28630\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#13850\fP: (\fI\%ryan\-lane\fP) s3:// urls in file.managed (and likely elsewhere) require s3.key and s3.keyid to be in minion config (refs: \fI\%#28630\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29011\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28630\fP to 2015.5
@ \fI2015\-11\-18 17:50:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28630\fP: (\fI\%messa\fP) Use S3 credentials from Pillar (refs: \fI\%#29011\fP)
.IP \(bu 2
a2e4a227e0 Merge pull request \fI\%#29011\fP from rallytime/bp\-28630
.IP \(bu 2
7baccc1b05 Lint \- newline before def
.IP \(bu 2
9e5c16d4da Reading S3 credentials from Pillar
.IP \(bu 2
a3216f813d Fixed requests HTTPError handler, it was still in urllib2 style
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28982\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-11\-18 00:49:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a4cd6002f Merge pull request \fI\%#28982\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
bfbb109fbd Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
4b8bdd0afb Merge pull request \fI\%#28839\fP from cachedout/revert_28740
.IP \(bu 2
215b26c06f Revert \fI\%#28740\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28947\fP: (\fI\%dmyerscough\fP) sdb modules are not synced out (refs: \fI\%#28949\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28949\fP: (\fI\%whiteinge\fP) Add sync_sdb execution function
@ \fI2015\-11\-17 15:35:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
edd26d763a Merge pull request \fI\%#28949\fP from whiteinge/sync\-sdb
.IP \(bu 2
b0ec9ab25b Add sync_sdb execution function
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28888\fP: (\fI\%twangboy\fP) Fix file.comment (refs: \fI\%#28930\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28930\fP: (\fI\%twangboy\fP) Added missing import mmap required by file.py
@ \fI2015\-11\-16 23:17:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
43da1bc4ce Merge pull request \fI\%#28930\fP from twangboy/fix_28888
.IP \(bu 2
f5c489eaad Added missing import mmap required by file.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28908\fP: (\fI\%rallytime\fP) A couple of spelling fixes for doc conventions page.
@ \fI2015\-11\-16 02:29:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
2488b873b8 Merge pull request \fI\%#28908\fP from rallytime/doc\-convention\-spelling
.IP \(bu 2
60e6eddb77 A couple of spelling fixes for doc conventions page.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22442\fP: (\fI\%allanliu\fP) rest_cherrypy /keys URL does not handle JSON requests (refs: \fI\%#28902\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28902\fP: (\fI\%whiteinge\fP) Fix missing JSON support for /keys endpoint
@ \fI2015\-11\-15 15:36:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
827a1ae020 Merge pull request \fI\%#28902\fP from whiteinge/json\-keys
.IP \(bu 2
9745903301 Fix missing JSON support for /keys endpoint
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28897\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28873\fP to 2015.5
@ \fI2015\-11\-15 00:43:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28873\fP: (\fI\%tehmaspc\fP) Fix salt\-cloud help output typo (refs: \fI\%#28897\fP)
.IP \(bu 2
d23bd49130 Merge pull request \fI\%#28897\fP from rallytime/bp\-28873
.IP \(bu 2
077e671ead Fix salt\-cloud help output typo
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28870\fP: (\fI\%basepi\fP) mdadm commands failing (refs: \fI\%#28871\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28871\fP: (\fI\%basepi\fP) [2015.5] Fix command generation for mdadm.assemble
@ \fI2015\-11\-13 21:54:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
a9dc8b6ca6 Merge pull request \fI\%#28871\fP from basepi/mdadm.fix.28870
.IP \(bu 2
323bc2d2ac Fix command generation for mdadm.assemble
.UNINDENT
.UNINDENT
.SS Salt 2015.5.9 Release Notes
.INDENT 0.0
.TP
.B release
2016\-01\-11
.UNINDENT
.sp
Version 2015.5.9 is a bugfix release for \fI\%2015.5.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB45\fP
.IP \(bu 2
Total Issue References: \fB21\fP
.IP \(bu 2
Total PR References: \fB48\fP
.IP \(bu 2
Contributors: \fB21\fP (\fI\%abednarik\fP, \fI\%aletourneau\fP, \fI\%attiasr\fP, \fI\%basepi\fP, \fI\%cachedout\fP, \fI\%clan\fP,
\fI\%clarkperkins\fP, \fI\%cro\fP, \fI\%dmyerscough\fP, \fI\%jacobhammons\fP, \fI\%jfindlay\fP, \fI\%jsutton\fP, \fI\%justinta\fP,
\fI\%lorengordon\fP, \fI\%markckimball\fP, \fI\%mpreziuso\fP, \fI\%rallytime\fP, \fI\%terminalmage\fP, \fI\%titilambert\fP,
\fI\%twangboy\fP, \fI\%zmalone\fP)
.UNINDENT
.SS Changelog for v2015.5.8..v2015.5.9
.sp
\fIGenerated at: 2018\-05\-27 22:31:06 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#30248\fP: (\fI\%jfindlay\fP) add 2015.5.9 release notes
@ \fI2016\-01\-08 23:13:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
92889db638 Merge pull request \fI\%#30248\fP from jfindlay/2015.5
.IP \(bu 2
741f7aba31 add 2015.5.9 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30237\fP: (\fI\%jacobhammons\fP) Updated man pages and doc version for 2015.5.9
@ \fI2016\-01\-08 18:10:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
7a329d89d7 Merge pull request \fI\%#30237\fP from jacobhammons/man\-pages\-prev
.IP \(bu 2
2431c4c5c3 Updated man page and doc conf.py copyright year to 2016
.IP \(bu 2
fe3da1c174 Updated man pages and doc version for 2015.5.9
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30207\fP: (\fI\%rallytime\fP) Use correct spacing in rabbitmq state examples
@ \fI2016\-01\-07 18:37:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
2c0b725924 Merge pull request \fI\%#30207\fP from rallytime/rabbitmq_states_doc_fix
.IP \(bu 2
8d48c24182 Use correct spacing in rabbitmq state examples
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30191\fP: (\fI\%jacobhammons\fP) Updated doc site banners
@ \fI2016\-01\-06 22:37:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
b49cf910f4 Merge pull request \fI\%#30191\fP from jacobhammons/banner\-prev
.IP \(bu 2
c3390955b0 Updated doc site banners
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29633\fP: (\fI\%twellspring\fP) user.present does not modify home directory (refs: \fI\%#30125\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30125\fP: (\fI\%abednarik\fP) Update user home event when createhome is set to False
@ \fI2016\-01\-05 18:15:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
9363d6f5b6 Merge pull request \fI\%#30125\fP from abednarik/update_user_home
.IP \(bu 2
56544a77f6 Update user home event when createhome is set to False
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#10155\fP: (\fI\%jhenry82\fP) Option to select a random master in multi\-master mode (refs: \fI\%#30127\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30127\fP: (\fI\%jsutton\fP) Updating documentation and example minion config for random_master/master_shuffle.
@ \fI2016\-01\-04 19:30:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
1a5d585d91 Merge pull request \fI\%#30127\fP from jsutton/clarify\-documentation\-for\-random_master
.IP \(bu 2
01dbf385ef Adding random_master to reference and updating master_shuffle. Adding master_shuffle to the minion example config file as it is needed for multi\-master PKI.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30110\fP: (\fI\%markckimball\fP) Fixed flag sent to salt.utils.http in order for verify_ssl to work correctly
@ \fI2015\-12\-31 21:17:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
28b1bbbe77 Merge pull request \fI\%#30110\fP from markckimball/fix\-verify_ssl\-in\-joyent\-cloud
.IP \(bu 2
e1c08cb269 Fixed flag sent to salt.utils.http in order for verify_ssl to work appropriately.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30093\fP: (\fI\%zmalone\fP) Noting that file_roots and \(dqstate tree\(dq should both be avoided
@ \fI2015\-12\-30 22:40:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
040412b0b1 Merge pull request \fI\%#30093\fP from zmalone/pillar\-notes
.IP \(bu 2
cfbfd58afe Noting that file_roots and \(dqstate tree\(dq should both be avoided, because in some environments, the actual states show up another level down.  Adding notes about why this is undesirable.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28120\fP: (\fI\%jtylers\fP) Clear text passwords (refs: \fI\%#30097\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30097\fP: (\fI\%cachedout\fP) Note concern about cleartext password in docs for shadow.gen_password
@ \fI2015\-12\-30 22:37:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
25edefc93a Merge pull request \fI\%#30097\fP from cachedout/note_on_password_process_list
.IP \(bu 2
58aec884ef Note concern about cleartext password in docs for shadow.gen_password
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30089\fP: (\fI\%mpreziuso\fP) Fixes terminology and adds more accurate details about the algorithms
@ \fI2015\-12\-30 20:02:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
6b1c3a6bf2 Merge pull request \fI\%#30089\fP from mpreziuso/patch\-1
.IP \(bu 2
50533add40 Fixes terminology and adds more accurate details about the algorithms
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29921\fP: (\fI\%anlutro\fP) pygit 0.21 not fully supported? (refs: \fI\%#30086\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30086\fP: (\fI\%cachedout\fP) Document that gitfs needs recent libs
@ \fI2015\-12\-30 19:26:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
200d09385d Merge pull request \fI\%#30086\fP from cachedout/issue_29921
.IP \(bu 2
8c29e2dd6a Document that gitfs needs recent libs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27835\fP: (\fI\%bertjwregeer\fP) [FreeBSD] salt\-ssh hangs forever (refs: \fI\%#30070\fP)
.IP \(bu 2
\fBPR\fP \fI\%#30070\fP: (\fI\%cachedout\fP) Add documentation on debugging salt\-ssh
@ \fI2015\-12\-29 23:00:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
404414bf57 Merge pull request \fI\%#30070\fP from cachedout/issue_27835
.IP \(bu 2
60431e342a Add documentation on debugging salt\-ssh
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30059\fP: (\fI\%mpreziuso\fP) Fixes wrong function scope
@ \fI2015\-12\-29 16:12:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
84db12212d Merge pull request \fI\%#30059\fP from mpreziuso/patch\-1
.IP \(bu 2
1cb1c2da07 Fixes wrong function scope
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#30025\fP: (\fI\%justinta\fP) Skipping some Boto tests until resolved moto issue
@ \fI2015\-12\-28 15:21:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29725\fP: (\fI\%cachedout\fP) Disable some boto tests per resolution of moto issue (refs: \fI\%#30025\fP)
.IP \(bu 2
1c6c9b1a06 Merge pull request \fI\%#30025\fP from jtand/boto_tests
.IP \(bu 2
e706642152 Skipping some Boto tests until resolved moto issue
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28956\fP: (\fI\%racooper\fP) Netscaler module doc enhancements (refs: \fI\%#29949\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29949\fP: (\fI\%aletourneau\fP) Enhanced netscaler docstring
@ \fI2015\-12\-22 20:26:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
0f91021c59 Merge pull request \fI\%#29949\fP from aletourneau/2015.5
.IP \(bu 2
cf855fe262 Fixed trailing white spaces
.IP \(bu 2
864801e002 fixed version
.IP \(bu 2
041d9346c4 Enhanced netscaler docstring
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29941\fP: (\fI\%cachedout\fP) Fix spelling error in boto_vpc
@ \fI2015\-12\-22 15:49:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
229d3eb60b Merge pull request \fI\%#29941\fP from cachedout/boto_spelling
.IP \(bu 2
b11bfd07b8 Fix spelling error in boto_vpc
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29880\fP: (\fI\%githubcdr\fP) Salt pkg.uptodate fails on Arch linux (refs: \fI\%#29908\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29908\fP: (\fI\%cachedout\fP) Allow kwargs to be passed to pacman provide for update func
@ \fI2015\-12\-22 15:04:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
69c5ada636 Merge pull request \fI\%#29908\fP from cachedout/issue_29880
.IP \(bu 2
4cd77b4118 Allow kwargs to be passed to pacman provide for update func
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#27056\fP: (\fI\%oogali\fP) pkgng provider on FreeBSD does not do BATCH=yes (refs: \fI\%#29909\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29909\fP: (\fI\%abednarik\fP) FreeBSD pkgng fix for non\-interactive install.
@ \fI2015\-12\-22 15:03:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
ad0de4d563 Merge pull request \fI\%#29909\fP from abednarik/freebsd_pkgng_non_interactive_fix
.IP \(bu 2
8ac213001a FreeBSD pkgng fix for non\-interactive install.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24698\fP: (\fI\%cmhe\fP) docker.installed not working (salt 2015.5.0, docker 1.6.2, dockerpy 0.5.3) (refs: \fI\%#29730\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29730\fP: (\fI\%rallytime\fP) Update docker\-py version requirement to 0.6.0 for dockerio.py files
@ \fI2015\-12\-16 14:44:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
f43f3d166c Merge pull request \fI\%#29730\fP from rallytime/fix\-24698
.IP \(bu 2
120fd5fdf0 Update docker\-py version requirement to 0.6.0 for dockerio.py files
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23343\fP: (\fI\%micaelbergeron\fP) npm state ignore the requested version (refs: \fI\%#29715\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#18647\fP: (\fI\%hundt\fP) Version number in npm state name does not result in correct version being installed (refs: \fI\%#29715\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29715\fP: (\fI\%rallytime\fP) Install correct package version, if provided, for npm state.
@ \fI2015\-12\-15 23:19:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
c393a4175a Merge pull request \fI\%#29715\fP from rallytime/fix\-23343
.IP \(bu 2
a0ed857c37 Install correct package version, if provided, for npm state.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29721\fP: (\fI\%terminalmage\fP) Fix display of multiline strings when iterating over a list
@ \fI2015\-12\-15 22:16:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
1310afbbc2 Merge pull request \fI\%#29721\fP from terminalmage/nested\-output\-multiline\-fix
.IP \(bu 2
761be9cb93 Fix display of multiline strings when iterating over a list
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29488\fP: (\fI\%Shad0w1nk\fP) salt.cloud.clouds.vmware.revert_to_snapshot crash when using the default value (refs: \fI\%#29646\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29646\fP: (\fI\%rallytime\fP) Don\(aqt stacktrace on kwargs.get if kwargs=None
@ \fI2015\-12\-15 19:02:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
52cc07cec9 Merge pull request \fI\%#29646\fP from rallytime/fix\-29488
.IP \(bu 2
c5fa9e9351 Don\(aqt stacktrace on kwargs.get if kwargs=None
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29661\fP: (\fI\%mosuowhq\fP) bug report when creating VM in /salt/cloud/clouds/nova.py (refs: \fI\%#29673\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29673\fP: (\fI\%rallytime\fP) Default value should be False and not \(aqFalse\(aq
@ \fI2015\-12\-14 18:08:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
f606c23ea8 Merge pull request \fI\%#29673\fP from rallytime/fix\-29661
.IP \(bu 2
e4af7a1157 Default value should be False and not \(aqFalse\(aq
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29527\fP: (\fI\%jfindlay\fP) 2015.5.7 notes: add note about not being released
@ \fI2015\-12\-08 21:08:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
f77c8e7baf Merge pull request \fI\%#29527\fP from jfindlay/2015.5
.IP \(bu 2
1a8044f0c9 2015.5.7 notes: add note about not being released
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29539\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-12\-08 19:14:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
867d550271 Merge pull request \fI\%#29539\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
2c9c4ba430 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
85aa70a6cb Merge pull request \fI\%#29392\fP from jacobhammons/2014.7
.INDENT 2.0
.IP \(bu 2
d7f0db1dd8 updated version number to not reference a specific build from the latest branch
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#12072\fP: (\fI\%vk00226\fP) Passing user\-data when provisioning  ec2 instances (refs: \fI\%#29504\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29504\fP: (\fI\%rallytime\fP) Document userdata_file option for EC2 driver
@ \fI2015\-12\-08 16:54:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
de7f3d5a59 Merge pull request \fI\%#29504\fP from rallytime/fix\-12072
.IP \(bu 2
8357c95dc2 Document userdata_file option for EC2 driver
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29101\fP: (\fI\%jessbreckenridge\fP) Salt\-cloud 2015.8.0 \- del_*_vols_on_destroy does not work according to docs (refs: \fI\%#29507\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29507\fP: (\fI\%rallytime\fP) Switch volumes and del_*_on_destroy example ordering
@ \fI2015\-12\-08 16:50:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
65deba8bb5 Merge pull request \fI\%#29507\fP from rallytime/ec2\-doc\-fix
.IP \(bu 2
90b4823bc2 Switch volumes and del_*_on_destroy example ordering
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28862\fP: (\fI\%trevor\-h\fP) salt\-cloud uppercase timeout options no longer recognized (refs: \fI\%#29469\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29469\fP: (\fI\%abednarik\fP) Added Documentation note in salt cloud.
@ \fI2015\-12\-07 18:27:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
0918c9294f Merge pull request \fI\%#29469\fP from abednarik/doc_note_for_saltcloud_connection_timeout
.IP \(bu 2
8e5c3e366a Added Documentation note in salt cloud.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29461\fP: (\fI\%dmyerscough\fP) Fix resource limits, systemd sets the default too small
@ \fI2015\-12\-05 16:26:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
e43c7c05a6 Merge pull request \fI\%#29461\fP from dmyerscough/fix\-resource\-limits
.IP \(bu 2
85a8a3b033 Fix resource limits, systemd sets the default number of open files to 4096 causing te master to complain about limits when you have a large number of keys
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28526\fP: (\fI\%clarkperkins\fP) yumpkg.installed broken in salt v2015.8.1 on CentOS 6 minions (refs: \fI\%#28656\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29439\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28656\fP to 2015.5
@ \fI2015\-12\-04 22:56:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28656\fP: (\fI\%clarkperkins\fP) \fI\%#28526\fP fixed yumpkg module issue with pkg.installed (refs: \fI\%#29439\fP)
.IP \(bu 2
730f02fbdf Merge pull request \fI\%#29439\fP from rallytime/bp\-28656
.IP \(bu 2
2f11bb021f \fI\%#28526\fP fixed yumpkg module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29418\fP: (\fI\%jacobhammons\fP) Added CVE 2015\-8034 to 2015.5.8 release notes
@ \fI2015\-12\-04 03:02:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
197210d52e Merge pull request \fI\%#29418\fP from jacobhammons/dot8
.IP \(bu 2
4f51a737f9 Added CVE 2015\-8034 to 2015.5.8 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29389\fP: (\fI\%jacobhammons\fP) updated version numbers in documentation
@ \fI2015\-12\-03 16:27:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
b3452f2a1a Merge pull request \fI\%#29389\fP from jacobhammons/2015.5
.IP \(bu 2
824721ff36 updated version numbers
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26898\fP: (\fI\%twangboy\fP) Symlinks in Windows (2015.8) (refs: \fI\%#28191\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28501\fP: (\fI\%twangboy\fP) Requested fixes for 26898
@ \fI2015\-12\-03 01:12:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28420\fP: (\fI\%jfindlay\fP) fix removal of symbolic links on windows in the file state (refs: \fI\%#28501\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28191\fP: (\fI\%twangboy\fP) Fix 26898 (refs: \fI\%#28420\fP, \fI\%#28501\fP)
.IP \(bu 2
6a7a95f28a Merge pull request \fI\%#28501\fP from twangboy/jmoney_26898
.IP \(bu 2
c0cf33332c Fixed some Lint...
.IP \(bu 2
df17fc59d3 Merge pull request \fI\%#6\fP from jfindlay/twang_test
.INDENT 2.0
.IP \(bu 2
bc7e0cfe64 add file.symlink unit tests
.IP \(bu 2
9381dc7215 orthogonalize file.symlink unit tests
.UNINDENT
.IP \(bu 2
8f462ba044 Merge pull request \fI\%#5\fP from cachedout/fix_twangboy_test
.INDENT 2.0
.IP \(bu 2
5293150d25 Fix tests
.UNINDENT
.IP \(bu 2
7d39091c91 Fixed some more lint
.IP \(bu 2
3dbd62af2c Fixed some tests... hopefully
.IP \(bu 2
f187db3288 Removed unnecessary logic
.IP \(bu 2
89ebd268e6 Added file attributes restore on fail
.IP \(bu 2
9ec72ca724 fix file state unit tests for win symlink feature
.IP \(bu 2
69c32a663e Fixed some lint
.IP \(bu 2
638dec5027 Fixed some tests... let\(aqs see if they\(aqre really are
.IP \(bu 2
5ed7a99792 Replaced instances of shutil.rmtree in file state
.IP \(bu 2
2651ce509f Fix file.remove for windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29344\fP: (\fI\%justinta\fP) file.search broken on python 2.6 with empty files (refs: \fI\%#29348\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29348\fP: (\fI\%justinta\fP) Fixes an file.search on python2.6
@ \fI2015\-12\-02 23:26:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
760a521603 Merge pull request \fI\%#29348\fP from jtand/file_search_fix
.IP \(bu 2
04f82bd4fd Fixes an file.search on python2.6
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29206\fP: (\fI\%mschiff\fP) ssh_known_hosts.present creates wrong known_hosts lines (refs: \fI\%#29276\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29336\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29276\fP to 2015.5
@ \fI2015\-12\-02 19:37:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29276\fP: (\fI\%abednarik\fP) Prevent adding port twice when adding entry in known hosts (refs: \fI\%#29336\fP)
.IP \(bu 2
51ea88d489 Merge pull request \fI\%#29336\fP from rallytime/bp\-29276
.IP \(bu 2
3a0e19debb Prevent adding port twice when adding entry in known hosts
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29333\fP: (\fI\%rallytime\fP) Back\-port \fI\%#29280\fP to 2015.5
@ \fI2015\-12\-02 19:37:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#29280\fP: (\fI\%cachedout\fP) [Doc] Add note for SVN state (refs: \fI\%#29333\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29165\fP: (\fI\%titilambert\fP) [Doc] Add note for SVN state (refs: \fI\%#29280\fP, \fI\%#29333\fP)
.IP \(bu 2
28255af52a Merge pull request \fI\%#29333\fP from rallytime/bp\-29280
.IP \(bu 2
722d02ff4a Lint
.IP \(bu 2
4a0040c1b4 [Doc] Add note for SVN state
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29316\fP: (\fI\%basepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5
@ \fI2015\-12\-01 20:20:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
14e94b3593 Merge pull request \fI\%#29316\fP from basepi/merge\-forward\-2015.5
.IP \(bu 2
33f40b3c47 Merge remote\-tracking branch \(aqupstream/2014.7\(aq into merge\-forward\-2015.5
.IP \(bu 2
d2fb2109a3 Merge pull request \fI\%#29296\fP from douardda/patch\-3
.IP \(bu 2
d2885390f4 Use process KillMode on Debian systems also
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29216\fP: (\fI\%clan\fP) size is 0 doesn\(aqt mean no data, e.g, /proc/version
@ \fI2015\-11\-30 20:01:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
6a2ffbfb7c Merge pull request \fI\%#29216\fP from clan/file_search_on_proc_file
.IP \(bu 2
91a20c07a1 try mmap first
.IP \(bu 2
8aa4f2053e remove extra space to fix lint failure
.IP \(bu 2
d34e6b1a9a use read only if has read() method
.IP \(bu 2
3209c1cdb5 size is 0 doesn\(aqt mean no data, e.g, /proc/version
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29261\fP: (\fI\%attiasr\fP) fix incorrect reinstallation of windows pkg
@ \fI2015\-11\-30 18:28:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
d6aaae8d7b Merge pull request \fI\%#29261\fP from attiasr/patch\-1
.IP \(bu 2
7a99b90596 add log and return if pkg already installed
.IP \(bu 2
1843c7ab8e fix incorrect reinstallation of windows pkg
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29214\fP: (\fI\%cro\fP) Doc for salt.utils.http should say verify_ssl not ssl_verify.
@ \fI2015\-11\-25 23:55:38 UTC\fP
.INDENT 2.0
.IP \(bu 2
9236188867 Merge pull request \fI\%#29214\fP from cro/ssl_verify_ssl
.IP \(bu 2
e9c13c561b Doc bug\-\-salt.utils.http takes verify_ssl not ssl_verify.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29202\fP: (\fI\%lorengordon\fP) Broken ca bundle lookup in \fIsalt.utils.http.get_ca_bundle\fP (refs: \fI\%#29204\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29204\fP: (\fI\%lorengordon\fP) Use os.path.join to return full path to ca bundle
@ \fI2015\-11\-25 20:00:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
df7b35a86b Merge pull request \fI\%#29204\fP from lorengordon/fix\-29202
.IP \(bu 2
b1dae5e6fe Use os.path.join to return full path to ca bundle
.UNINDENT
.UNINDENT
.SS Salt 2014.7.0 Release Notes \- Codename Helium
.sp
This release is the largest Salt release ever, with more features and commits
then any previous release of Salt. Everything from the new RAET transport to
major updates in Salt Cloud and the merging of Salt API into the main project.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
The Fedora/RHEL/CentOS \fBsalt\-master\fP package has been modified for this
release. The following components of Salt have been broken out and placed
into their own packages:
.INDENT 0.0
.IP \(bu 2
salt\-syndic
.IP \(bu 2
salt\-cloud
.IP \(bu 2
salt\-ssh
.UNINDENT
.sp
When the \fBsalt\-master\fP package is upgraded, these components will be
removed, and they will need to be manually installed.
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
Compound/pillar matching have been temporarily disabled for the \fBmine\fP
and \fBpublish\fP modules for this release due to the possibility of
inferring pillar data using pillar glob matching. A proper fix is now in
the 2014.7 branch and scheduled for the  2014.7.1 release, and compound
matching and non\-globbing pillar matching will be re\-enabled at that point.
.sp
Compound and pillar matching for normal salt commands are unaffected.
.UNINDENT
.UNINDENT
.SS New Transport!
.SS RAET Transport Option
.sp
This has been a HUGE amount of work, but the beta release of Salt with RAET is
ready to go. RAET is a reliable queuing transport system that has been
developed in partnership with a number of large enterprises to give Salt an
alternative to ZeroMQ and a way to get Salt to scale well beyond tens of
thousands of servers. Unlike ZeroMQ, RAET is completely asynchronous in every
aspect of its operation and has been developed using the flow programming
paradigm. This allows for many new capabilities to be added to Salt in the
upcoming releases.
.sp
Please keep in mind that this is a beta release of RAET and we hope for bugs to
be worked out, performance to be better realized and more in the 2015.5.0
release.
.sp
Simply stated, users running Salt with RAET should expect some hiccups as we
hammer out the update. This is a BETA release of Salt RAET.
.SS Salt SSH Enhancements
.sp
Salt SSH has just entered a new league, with substantial updates and
improvements to make salt\-ssh more reliable and easier then ever! From new
features like the ansible roster and fileserver backends to the new pypi
salt\-ssh installer to lowered deps and a swath of bugfixes, salt\-ssh is
basically reborn!
.SS Install salt\-ssh Using pip
.sp
Salt\-ssh is now pip\-installable!
.sp
\fI\%https://pypi.org/project/salt\-ssh/\fP
.sp
Pip will bring in all of the required deps, and while some deps are compiled,
they all include pure python implementations, meaning that any compile errors
which may be seen can be safely ignored.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install salt\-ssh
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Fileserver Backends
.sp
Salt\-ssh can now use the salt fileserver backend system. This allows for
the gitfs, hgfs, s3, and many more ways to centrally store states to be easily
used with salt\-ssh. This also allows for a distributed team to easily use
a centralized source.
.SS Saltfile Support
.sp
The new saltfile system makes it easy to have a user specific custom extended
configuration.
.SS Ext Pillar
.sp
Salt\-ssh can now use the external pillar system. Making it easier then ever
to use salt\-ssh with teams.
.SS No More sshpass
.sp
Thanks to the enhancements in the salt vt system, salt\-ssh no longer requires
sshpass to send passwords to ssh. This also makes the manipulation of ssh
calls substantially more flexible, allowing for intercepting ssh calls in
a much more fluid way.
.SS Pure Python Shim
.sp
The salt\-ssh call originally used a shell script to discover what version of
python to execute with and determine the state of the ssh code deployment.
This shell script has been replaced with a pure python version making it easy
to increase the capability of the code deployment without causing platform
inconsistency issues with different shell interpreters.
.SS Custom Module Delivery
.sp
Custom modules are now seamlessly delivered. This makes the deployment of
custom grains, states, execution modules and returners a seamless process.
.SS CP Module Support
.sp
Salt\-ssh now makes simple file transfers easier then ever! The \fIcp\fP
module allows for files to be conveniently sent from the salt fileserver
system down to systems.
.SS More Thin Directory Options
.sp
Salt ssh functions by copying a subset of the salt code, or \fIsalt thin\fP down
to the target system. In the past this was always transferred to /tmp/.salt
and cached there for subsequent commands.
.sp
Now, salt thin can be sent to a random directory and removed when the call
is complete with the \fI\-W\fP option. The new \fI\-W\fP option still uses a static
location but will clean up that location when finished.
.sp
The default \fIsalt thin\fP location is now user defined, allowing multiple users
to cleanly access the same systems.
.SS State System Enhancements
.SS New Imperative State Keyword \(dqListen\(dq
.sp
The new \fBlisten\fP and \fBlisten_in\fP keywords allow for completely imperative
states by calling the \fBmod_watch()\fP routine after all states have run instead
of re\-ordering the states.
.SS Mod Aggregate Runtime Manipulator
.sp
The new \fBmod_aggregate\fP system allows for the state system to rewrite the
state data during execution. This allows for state definitions to be aggregated
dynamically at runtime.
.sp
The best example is found in the \fI\%pkg\fP state. If
\fBmod_aggregate\fP is turned on, then when the first pkg state is reached, the
state system will scan all of the other running states for pkg states and take
all other packages set for install and install them all at once in the first
pkg state.
.sp
These runtime modifications make it easy to run groups of states together. In
future versions, we hope to fill out the \fBmod_aggregate\fP system to build in
more and more optimizations.
.sp
For more documentation on \fBmod_aggregate\fP, see \fI\%the documentation\fP\&.
.SS New Requisites: onchanges and onfail
.sp
The new \fBonchanges\fP and \fBonchanges_in\fP requisites make a state apply only if
there are changes in the required state. This is useful to execute post hooks
after changes occur on a system.
.sp
The other new requisites, \fBonfail\fP, and \fBonfail_in\fP, allow for a state to run
in reaction to the failure of another state.
.sp
For more information about these new requisites, see the
\fI\%requisites documentation\fP\&.
.SS Global onlyif and unless
.sp
The \fBonlyif\fP and \fBunless\fP options can now be used for any state declaration.
.SS Use \fBnames\fP to expand and override values
.sp
The \fI\%names declaration\fP in Salt\(aqs state system can now
override or add values to the expanded data structure. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_users:
  user.present:
    \- names:
      \- larry
      \- curly
      \- moe:
        \- shell: /bin/zsh
        \- groups:
          \- wheel
    \- shell: /bin/bash
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Major Features
.SS Scheduler Additions
.sp
The Salt scheduler system has received MAJOR enhancements, allowing for
cron\-like scheduling and much more granular timing routines. See \fI\%here\fP for more info.
.SS Red Hat 7 Family Support
.sp
All the needed additions have been made to run Salt on RHEL 7 and derived OSes
like CentOS and Scientific.
.SS Fileserver Backends in salt\-call
.sp
Fileserver backends like gitfs can now be used without a salt master! Just add
the fileserver backend configuration to the minion config and execute
salt\-call. This has been a much\-requested feature and we are happy to finally
bring it to our users.
.SS Amazon Execution Modules
.sp
An entire family of execution modules further enhancing Salt\(aqs Amazon Cloud
support. They include the following:
.INDENT 0.0
.IP \(bu 2
\fI\%Autoscale Groups\fP (includes \fI\%state support\fP) \-\- related: \fI\%Launch Control\fP states
.IP \(bu 2
\fI\%Cloud Watch\fP (includes \fI\%state support\fP)
.IP \(bu 2
\fI\%Elastic Cache\fP (includes \fI\%state support\fP)
.IP \(bu 2
\fI\%Elastic Load Balancer\fP (includes \fI\%state support\fP)
.IP \(bu 2
\fI\%IAM Identity and Access Management\fP (includes \fI\%state support\fP)
.IP \(bu 2
\fI\%Route53 DNS\fP (includes \fI\%state support\fP)
.IP \(bu 2
\fI\%Security Groups\fP (includes \fI\%state support\fP)
.IP \(bu 2
\fI\%Simple Queue Service\fP (includes \fI\%state support\fP)
.UNINDENT
.SS LXC Runner Enhancements
.sp
BETA
The Salt LXC management system has received a number of enhancements which make
running an LXC cloud entirely from Salt an easy proposition.
.SS Next Gen Docker Management
.sp
The Docker support in Salt has been increased at least ten fold. The Docker API
is now completely exposed and Salt ships with Docker data tracking systems
which make automating Docker deployments very easy.
.SS Peer System Performance Improvements
.sp
The peer system communication routines have been refined to make the peer
system substantially faster.
.SS SDB
.sp
Encryption at rest for configs
.SS GPG Renderer
.sp
Encrypted pillar at rest
.SS OpenStack Expansion
.sp
Lots of new OpenStack stuff
.SS Queues System
.sp
Ran change external queue systems into Salt events
.SS Multi Master Failover Additions
.sp
Connecting to multiple masters is more dynamic then ever
.SS Chef Execution Module
.sp
Managing Chef with Salt just got even easier!
.SS salt\-api Project Merge
.sp
The \fBsalt\-api\fP project has been merged into Salt core and is now available as
part of the regular \fBsalt\-master\fP package install. No API changes were made,
the \fBsalt\-api\fP script and init scripts remain intact.
.sp
\fBsalt\-api\fP has always provided Yet Another Pluggable Interface to Salt (TM)
in the form of \(dqnetapi\(dq modules. These are modules that bind to a port and
start a service. Like many of Salt\(aqs other module types, netapi modules often
have library and configuration dependencies. See the documentation for each
module for instructions.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%The full list of netapi modules.\fP
.UNINDENT
.UNINDENT
.SS Synchronous and Asynchronous Execution of Runner and Wheel Modules
.sp
\fI\%salt.runner.RunnerClient\fP and \fI\%salt.wheel.WheelClient\fP
have both gained complimentary \fBcmd_sync\fP and \fBcmd_async\fP methods allowing
for synchronous and asynchronous execution of any Runner or Wheel module
function, all protected using Salt\(aqs \fI\%external authentication\fP
system. \fBsalt\-api\fP benefits from this addition as well.
.SS \fBrest_cherrypy\fP Additions
.sp
The \fI\%rest_cherrypy\fP netapi module
provides the main REST API for Salt.
.SS Web Hooks
.sp
This release of course includes the Web Hook additions from the most recent
\fBsalt\-api\fP release, which allows external services to signal actions within a
Salt infrastructure. External services such as Amazon SNS, Travis\-CI, or
GitHub, as well as internal services that cannot or should not run a Salt
minion daemon can be used as first\-class components in Salt\(aqs rich
orchestration capabilities.
.sp
The raw HTTP request body is now available in the event data. This is sometimes
required information for checking an HMAC signature in order to verify a HTTP
request. As an example, Amazon or GitHub requests are signed this way.
.SS Generating and Accepting Minion Keys
.sp
The \fI\%/key\fP convenience URL
generates a public and private key for a minion, automatically pre\-accepts the
public key on the Salt Master, and returns both keys as a tarball for download.
.sp
This allows for easily bootstrapping the key on a new minion with a single HTTP
call, such as with a Kickstart script, all using regular shell tools.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-sS http://salt\-api.example.com:8000/keys \e
        \-d mid=jerry \e
        \-d username=kickstart \e
        \-d password=kickstart \e
        \-d eauth=pam \e
        \-o jerry\-salt\-keys.tar
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Fileserver Backend Enhancements
.sp
All of the fileserver backends have been overhauled to be faster, lighter, and
more reliable. The VCS backends (\fI\%gitfs\fP,
\fI\%hgfs\fP, and \fI\%svnfs\fP)
have also received a \fBlot\fP of new features.
.sp
Additionally, most config parameters for the VCS backends can now be configured
on a per\-remote basis, allowing for global config parameters to be overridden
for a specific gitfs/hgfs/svnfs remote.
.SS New \fI\%gitfs\fP Features
.SS Pygit2 and Dulwich
.sp
In addition to supporting GitPython, support for \fI\%pygit2\fP (0.20.3 and newer) and
\fI\%dulwich\fP have been added. Provided a compatible version of \fI\%pygit2\fP is
installed, it will now be the default provider. The config parameter
\fI\%gitfs_provider\fP has been added to allow one to choose a specific
provider for gitfs.
.SS Mountpoints
.sp
Prior to this release, to serve a file from gitfs at a salt fileserver URL of
\fBsalt://foo/bar/baz.txt\fP, it was necessary to ensure that the parent
directories existed in the repository. A new config parameter
\fI\%gitfs_mountpoint\fP allows gitfs remotes to be exposed starting at
a user\-defined \fBsalt://\fP URL.
.SS Environment Whitelisting/Blacklisting
.sp
By default, gitfs will expose all branches and tags as Salt fileserver
environments. Two new config parameters, \fBgitfs_env_whitelist\fP, and
\fBgitfs_env_blacklist\fP, allow more control over which branches and
tags are exposed. More detailed information on how these two options work can
be found in the \fI\%Gitfs Walkthrough\fP\&.
.SS Expanded Authentication Support
.sp
As of \fI\%pygit2\fP 0.20.3, both http(s) and SSH key authentication are supported,
and Salt now also supports both authentication methods when using \fI\%pygit2\fP\&. Keep
in mind that \fI\%pygit2\fP 0.20.3 is not yet available on many platforms, so those
who had been using authenticated git repositories with a passphraseless key
should stick to GitPython if a new enough \fI\%pygit2\fP is not yet available for the
platform on which the master is running.
.sp
A full explanation of how to use authentication can be found in the \fI\%Gitfs
Walkthrough\fP\&.
.SS New \fI\%hgfs\fP Features
.SS Mountpoints
.sp
This feature works exactly like its \fI\%gitfs counterpart\fP\&. The new config parameter is called
\fI\%hgfs_mountpoint\fP\&.
.SS Environment Whitelisting/Blacklisting
.sp
This feature works exactly like its \fI\%gitfs counterpart\fP\&. The new config parameters are called
\fBhgfs_env_whitelist\fP and \fBhgfs_env_blacklist\fP\&.
.SS New \fI\%svnfs\fP Features
.SS Mountpoints
.sp
This feature works exactly like its \fI\%gitfs counterpart\fP\&. The new config parameter is called
\fI\%svnfs_mountpoint\fP\&.
.SS Environment Whitelisting/Blacklisting
.sp
This feature works exactly like its \fI\%gitfs counterpart\fP\&. The new config parameters are called
\fBsvnfs_env_whitelist\fP and \fBsvnfs_env_blacklist\fP\&.
.SS Configurable Trunk/Branches/Tags Paths
.sp
Prior to this release, the paths where trunk, branches, and tags were located
could only be in directories named \(dqtrunk\(dq, \(dqbranches\(dq, and \(dqtags\(dq directly
under the root of the repository. Three new config parameters
(\fI\%svnfs_trunk\fP, \fI\%svnfs_branches\fP, and
\fI\%svnfs_tags\fP) allow SVN repositories which are laid out
differently to be used with svnfs.
.SS New \fI\%minionfs\fP Features
.SS Mountpoint
.sp
This feature works exactly like its \fI\%gitfs counterpart\fP\&. The new config parameter is called
\fI\%minionfs_mountpoint\fP\&. The one major difference is that, as
minionfs doesn\(aqt use multiple remotes (it just serves up files pushed to the
master using \fI\%cp.push\fP) there is no such thing as a
per\-remote configuration for \fI\%minionfs_mountpoint\fP\&.
.SS Changing the Saltenv from Which Files are Served
.sp
A new config parameter (\fI\%minionfs_env\fP) allows minionfs files to
be served from a Salt fileserver environment other than \fBbase\fP\&.
.SS Minion Whitelisting/Blacklisting
.sp
By default, minionfs will expose the pushed files from all minions. Two new
config parameters, \fI\%minionfs_whitelist\fP, and
\fI\%minionfs_blacklist\fP, allow minionfs to be restricted to serve
files from only the desired minions.
.SS Pyobjects Renderer
.sp
Salt now ships with with the \fI\%Pyobjects Renderer\fP that allows for construction of States using pure
Python with an idiomatic object interface.
.SS New Modules
.sp
In addition to the Amazon modules mentioned above, there are also several other
new execution modules:
.INDENT 0.0
.IP \(bu 2
\fI\%Oracle\fP
.IP \(bu 2
\fI\%Random\fP
.IP \(bu 2
\fI\%Redis\fP
.IP \(bu 2
\fI\%Amazon Simple Queue Service\fP
.IP \(bu 2
\fBBlock Device Management\fP
.IP \(bu 2
\fI\%CoreOS etcd\fP
.IP \(bu 2
\fI\%Genesis\fP
.IP \(bu 2
\fBInfluxDB\fP
.IP \(bu 2
\fI\%Server Density\fP
.IP \(bu 2
\fI\%Twilio Notifications\fP
.IP \(bu 2
\fI\%Varnish\fP
.IP \(bu 2
\fI\%ZNC IRC Bouncer\fP
.IP \(bu 2
\fI\%SMTP\fP
.UNINDENT
.SS New Runners
.INDENT 0.0
.IP \(bu 2
\fI\%Map/Reduce Style\fP
.IP \(bu 2
\fI\%Queue\fP
.UNINDENT
.SS New External Pillars
.INDENT 0.0
.IP \(bu 2
\fI\%CoreOS etcd\fP
.UNINDENT
.SS New Salt\-Cloud Providers
.INDENT 0.0
.IP \(bu 2
\fI\%Aliyun ECS Cloud\fP
.IP \(bu 2
\fI\%LXC Containers\fP
.IP \(bu 2
\fI\%Proxmox (OpenVZ containers & KVM)\fP
.UNINDENT
.SS Salt Call Change
.sp
When used with a returner, salt\-call now contacts a master if \fB\-\-local\fP
is not specicified.
.SS Deprecations
.SS \fI\%salt.modules.virtualenv_mod\fP
.INDENT 0.0
.IP \(bu 2
Removed deprecated \fBmemoize\fP function from \fBsalt/utils/__init__.py\fP (deprecated)
.IP \(bu 2
Removed deprecated \fBno_site_packages\fP argument from \fBcreate\fP function (deprecated)
.IP \(bu 2
Removed deprecated \fBcheck_dns\fP argument from \fBminion_config\fP and \fBapply_minion_config\fP functions (deprecated)
.IP \(bu 2
Removed deprecated \fBOutputOptionsWithTextMixIn\fP class from \fBsalt/utils/parsers.py\fP (deprecated)
.IP \(bu 2
Removed the following deprecated functions from \fBsalt/modules/ps.py\fP:
\- \fBphysical_memory_usage\fP (deprecated)
\- \fBvirtual_memory_usage\fP (deprecated)
\- \fBcached_physical_memory\fP (deprecated)
\- \fBphysical_memory_buffers\fP (deprecated)
.IP \(bu 2
Removed deprecated cloud arguments from \fBcloud_config\fP function in \fBsalt/config.py\fP:
\- \fBvm_config\fP (deprecated)
\- \fBvm_config_path\fP (deprecated)
.IP \(bu 2
Removed deprecated \fBlibcloud_version\fP function from \fBsalt/cloud/libcloudfuncs.py\fP (deprecated)
.IP \(bu 2
Removed deprecated \fBCloudConfigMixIn\fP class from \fBsalt/utils/parsers.py\fP (deprecated)
.UNINDENT
.SS Salt 2014.7.1 Release Notes
.INDENT 0.0
.TP
.B release
2015\-01\-12
.UNINDENT
.sp
Version 2014.7.1 is a bugfix release for \fI\%2014.7.0\fP\&.
.sp
The changes include:
.INDENT 0.0
.IP \(bu 2
Fixed gitfs serving symlinks in \fI\%file.recurse\fP states (\fI\%issue 17700\fP)
.IP \(bu 2
Fixed holding of multiple packages (YUM) when combined with version pinning
(\fI\%issue 18468\fP)
.IP \(bu 2
Fixed use of Jinja templates in masterless mode with non\-roots fileserver
backend (\fI\%issue 17963\fP)
.IP \(bu 2
Re\-enabled pillar and compound matching for mine and publish calls. Note that
pillar globbing is still disabled for those modes, for security reasons.
(\fI\%issue 17194\fP)
.IP \(bu 2
Fix for \fBtty: True\fP in salt\-ssh (\fI\%issue 16847\fP)
.IP \(bu 2
Fix for supervisord states when supervisor not installed to system python
(\fI\%issue 18044\fP)
.IP \(bu 2
Fix for logging when \fBlog_level=\(aqquiet\(aq\fP for \fI\%cmd.run\fP (\fI\%issue 19479\fP)
.UNINDENT
.SS Salt 2014.7.2 Release Notes
.INDENT 0.0
.TP
.B release
2015\-02\-09
.UNINDENT
.sp
Version 2014.7.2 is a bugfix release for \fI\%2014.7.0\fP\&.
.sp
The changes include:
.INDENT 0.0
.IP \(bu 2
Fix erroneous warnings for systemd service enabled check (\fI\%issue 19606\fP)
.IP \(bu 2
Fix FreeBSD kernel module loading, listing, and persistence
\fI\%kmod\fP (\fI\%issue 197151\fP, \fI\%issue 19682\fP)
.IP \(bu 2
Allow case\-sensitive npm package names in the \fI\%npm state\fP\&.  This may break behavior for people expecting the state
to lowercase their npm package names for them.  The \fI\%npm module\fP was never affected by mandatory lowercasing.
(\fI\%issue 20329\fP)
.IP \(bu 2
Deprecate the \fBactivate\fP parameter for pip.install for both the
\fI\%module\fP and the \fBstate\fP\&.
If \fBbin_env\fP is given and points to a virtualenv, there is no need to
activate that virtualenv in a shell for pip to install to the virtualenv.
.IP \(bu 2
Fix a file\-locking bug in gitfs (\fI\%issue 18839\fP)
.IP \(bu 2
Deprecated \fBarchive_user\fP in favor of standardized \fBuser\fP parameter in
\fBstate\fP and added \fBgroup\fP parameter.
.UNINDENT
.SS Salt 2014.7.3 Release Notes
.INDENT 0.0
.TP
.B release
2015\-03\-25
.UNINDENT
.sp
Version 2014.7.3 is a bugfix release for \fI\%2014.7.0\fP\&.
.sp
Changes:
.INDENT 0.0
.IP \(bu 2
Multi\-master minions mode no longer route fileclient operations asymetrically.
This fixes the source of many multi\-master bugs where the minion would
become unrepsonsive from one or more masters.
.IP \(bu 2
Fix bug wherein network.iface could produce stack traces.
.IP \(bu 2
net.arp will no longer be made available unless arp is installed on the
system.
.IP \(bu 2
Major performance improvements to Saltnado
.IP \(bu 2
Allow KVM module to operate under KVM itself or VMware Fusion
.IP \(bu 2
Various fixes to the Windows installation scripts
.IP \(bu 2
Fix issue where the syndic would not correctly propagate loads to the master
job cache.
.IP \(bu 2
Improve error handling on invalid /etc/network/interfaces file in salt
networking modules
.IP \(bu 2
Fix bug where a response status was not checked for in fileclient.get_url
.IP \(bu 2
Enable eauth when running salt in batch mode
.IP \(bu 2
Increase timeout in Boto Route53 module
.IP \(bu 2
Fix bugs with Salt\(aqs \(aqtar\(aq module option parsing
.IP \(bu 2
Fix parsing of NTP servers on Windows
.IP \(bu 2
Fix issue with blockdev tuning not reporting changes correctly
.IP \(bu 2
Update to the latest Salt bootstrap script
.IP \(bu 2
Update Linode salt\-cloud driver to use either linode\-python or
apache\-libcloud
.IP \(bu 2
Fix for s3.query function to return correct headers
.IP \(bu 2
Fix for s3.head returning None for files that exist
.IP \(bu 2
Fix the disable function in win_service module so that the service is
disabled correctly
.IP \(bu 2
Fix race condition between master and minion when making a directory when
both daemons are on the same host
.IP \(bu 2
Fix an issue where file.recurse would fail at the root of an svn repo
when the repo has a mountpoint
.IP \(bu 2
Fix an issue where file.recurse would fail at the root of an hgfs repo
when the repo has a mountpoint
.IP \(bu 2
Fix an issue where file.recurse would fail at the root of an gitfs repo
when the repo has a mountpoint
.IP \(bu 2
Add status.master capability for Windows.
.IP \(bu 2
Various fixes to ssh_known_hosts
.IP \(bu 2
Various fixes to states.network bonding for Debian
.IP \(bu 2
The debian_ip.get_interfaces module no longer removes nameservers.
.IP \(bu 2
Better integration between grains.virtual and systemd\-detect\-virt and
virt\-what
.IP \(bu 2
Fix traceback in sysctl.present state output
.IP \(bu 2
Fix for issue where mount.mounted would fail when superopts were not a part
of mount.active (extended=True). Also mount.mounted various fixes for Solaris
and FreeBSD.
.IP \(bu 2
Fix error where datetimes were not correctly safeguarded before being passed
into msgpack.
.IP \(bu 2
Fix file.replace regressions.  If the pattern is not found, and if dry run is False,
and if \fIbackup\fP is False, and if a pre\-existing file exists with extension \fI\&.bak\fP,
then that backup file will be overwritten. This backup behavior is a result of how \fIfileinput\fP
works. Fixing it requires either passing through the file twice (the
first time only to search for content and set a flag), or rewriting
\fIfile.replace\fP so it doesn\(aqt use \fIfileinput\fP
.IP \(bu 2
VCS filreserver fixes/optimizations
.IP \(bu 2
Catch fileserver configuration errors on master start
.IP \(bu 2
Raise errors on invalid gitfs configurations
.IP \(bu 2
set_locale when locale file does not exist (Redhat family)
.IP \(bu 2
Fix to correctly count active devices when created mdadm array with spares
.IP \(bu 2
Fix to correctly target minions in batch mode
.IP \(bu 2
Support \fI\%ssh://\fP urls using the gitfs dulwhich backend
.IP \(bu 2
New fileserver runner
.IP \(bu 2
Fix various bugs with argument parsing to the publish module.
.IP \(bu 2
Fix disk.usage for Synology OS
.IP \(bu 2
Fix issue with tags occurring twice with docker.pulled
.IP \(bu 2
Fix incorrect key error in SMTP returner
.IP \(bu 2
Fix condition which would remount loopback filesystems on every state run
.IP \(bu 2
Remove requsites from listens after they are called in the state system
.IP \(bu 2
Make system implementation of service.running aware of legacy service calls
.IP \(bu 2
Fix issue where publish.publish would not handle duplicate responses gracefully.
.IP \(bu 2
Accept Kali Linux for aptpkg salt execution module
.IP \(bu 2
Fix bug where cmd.which could not handle a dirname as an argument
.IP \(bu 2
Fix issue in ps.pgrep where exceptions were thrown on Windows.
.UNINDENT
.sp
Known issues:
.INDENT 0.0
.IP \(bu 2
In multimaster mode, a minion may become temporarily unresponsive
if modules or pillars are refreshed at the same time that one
or more masters are down. This can be worked around by setting
\(aqauth_timeout\(aq and \(aqauth_tries\(aq down to shorter periods.
.UNINDENT
.SS Salt 2014.7.4 Release Notes
.INDENT 0.0
.TP
.B release
2015\-03\-30
.UNINDENT
.sp
Version 2014.7.4 is a bugfix release for \fI\%2014.7.0\fP\&.
.sp
This is a security release. The security issues fixed have only been present
since 2014.7.0, and only users of the two listed modules are vulnerable. The
following CVEs have been resolved:
.INDENT 0.0
.IP \(bu 2
CVE\-2015\-1838 SaltStack: insecure /tmp file handling in
salt/modules/serverdensity_device.py
.IP \(bu 2
CVE\-2015\-1839 SaltStack: insecure /tmp file handling in salt/modules/chef.py
.UNINDENT
.sp
Changes:
.INDENT 0.0
.IP \(bu 2
Multi\-master minions mode no longer route fileclient operations asymetrically.
This fixes the source of many multi\-master bugs where the minion would
become unrepsonsive from one or more masters.
.IP \(bu 2
Fix bug wherein network.iface could produce stack traces.
.IP \(bu 2
net.arp will no longer be made available unless arp is installed on the
system.
.IP \(bu 2
Major performance improvements to Saltnado
.IP \(bu 2
Allow KVM module to operate under KVM itself or VMware Fusion
.IP \(bu 2
Various fixes to the Windows installation scripts
.IP \(bu 2
Fix issue where the syndic would not correctly propagate loads to the master
job cache.
.IP \(bu 2
Improve error handling on invalid /etc/network/interfaces file in salt
networking modules
.IP \(bu 2
Fix bug where a response status was not checked for in fileclient.get_url
.IP \(bu 2
Enable eauth when running salt in batch mode
.IP \(bu 2
Increase timeout in Boto Route53 module
.IP \(bu 2
Fix bugs with Salt\(aqs \(aqtar\(aq module option parsing
.IP \(bu 2
Fix parsing of NTP servers on Windows
.IP \(bu 2
Fix issue with blockdev tuning not reporting changes correctly
.IP \(bu 2
Update to the latest Salt bootstrap script
.IP \(bu 2
Update Linode salt\-cloud driver to use either linode\-python or
apache\-libcloud
.IP \(bu 2
Fix for s3.query function to return correct headers
.IP \(bu 2
Fix for s3.head returning None for files that exist
.IP \(bu 2
Fix the disable function in win_service module so that the service is
disabled correctly
.IP \(bu 2
Fix race condition between master and minion when making a directory when
both daemons are on the same host
.IP \(bu 2
Fix an issue where file.recurse would fail at the root of an svn repo
when the repo has a mountpoint
.IP \(bu 2
Fix an issue where file.recurse would fail at the root of an hgfs repo
when the repo has a mountpoint
.IP \(bu 2
Fix an issue where file.recurse would fail at the root of an gitfs repo
when the repo has a mountpoint
.IP \(bu 2
Add status.master capability for Windows.
.IP \(bu 2
Various fixes to ssh_known_hosts
.IP \(bu 2
Various fixes to states.network bonding for Debian
.IP \(bu 2
The debian_ip.get_interfaces module no longer removes nameservers.
.IP \(bu 2
Better integration between grains.virtual and systemd\-detect\-virt and
virt\-what
.IP \(bu 2
Fix traceback in sysctl.present state output
.IP \(bu 2
Fix for issue where mount.mounted would fail when superopts were not a part
of mount.active (extended=True). Also mount.mounted various fixes for Solaris
and FreeBSD.
.IP \(bu 2
Fix error where datetimes were not correctly safeguarded before being passed
into msgpack.
.IP \(bu 2
Fix file.replace regressions.  If the pattern is not found, and if dry run is False,
and if \fIbackup\fP is False, and if a pre\-existing file exists with extension \fI\&.bak\fP,
then that backup file will be overwritten. This backup behavior is a result of how \fIfileinput\fP
works. Fixing it requires either passing through the file twice (the
first time only to search for content and set a flag), or rewriting
\fIfile.replace\fP so it doesn\(aqt use \fIfileinput\fP
.IP \(bu 2
VCS filreserver fixes/optimizations
.IP \(bu 2
Catch fileserver configuration errors on master start
.IP \(bu 2
Raise errors on invalid gitfs configurations
.IP \(bu 2
set_locale when locale file does not exist (Redhat family)
.IP \(bu 2
Fix to correctly count active devices when created mdadm array with spares
.IP \(bu 2
Fix to correctly target minions in batch mode
.IP \(bu 2
Support \fI\%ssh://\fP urls using the gitfs dulwhich backend
.IP \(bu 2
New fileserver runner
.IP \(bu 2
Fix various bugs with argument parsing to the publish module.
.IP \(bu 2
Fix disk.usage for Synology OS
.IP \(bu 2
Fix issue with tags occurring twice with docker.pulled
.IP \(bu 2
Fix incorrect key error in SMTP returner
.IP \(bu 2
Fix condition which would remount loopback filesystems on every state run
.IP \(bu 2
Remove requsites from listens after they are called in the state system
.IP \(bu 2
Make system implementation of service.running aware of legacy service calls
.IP \(bu 2
Fix issue where publish.publish would not handle duplicate responses gracefully.
.IP \(bu 2
Accept Kali Linux for aptpkg salt execution module
.IP \(bu 2
Fix bug where cmd.which could not handle a dirname as an argument
.IP \(bu 2
Fix issue in ps.pgrep where exceptions were thrown on Windows.
.UNINDENT
.sp
Known issues:
.INDENT 0.0
.IP \(bu 2
In multimaster mode, a minion may become temporarily unresponsive
if modules or pillars are refreshed at the same time that one
or more masters are down. This can be worked around by setting
\(aqauth_timeout\(aq and \(aqauth_tries\(aq down to shorter periods.
.IP \(bu 2
There are known issues with batch mode operating on the incorrect number of minions.
This bug can be patched with the change in \fI\%Pull Request #22464\fP\&.
.IP \(bu 2
The \fIfun\fP, \fIstate\fP, and \fIunless\fP keywords are missing from the state internals, which
can cause problems running some states. This bug can be patched with the change in
\fI\%Pull Request #22365\fP\&.
.UNINDENT
.SS Salt 2014.7.5 Release Notes
.INDENT 0.0
.TP
.B release
2015\-04\-16
.UNINDENT
.sp
Version 2014.7.5 is a bugfix release for \fI\%2014.7.0\fP\&.
.sp
Changes:
.INDENT 0.0
.IP \(bu 2
Fixed a key error bug in salt\-cloud
.IP \(bu 2
Updated man pages to better match documentation
.IP \(bu 2
Fixed bug concerning high CPU usage with salt\-ssh
.IP \(bu 2
Fixed bugs with remounting cvfs and fuse filesystems
.IP \(bu 2
Fixed bug with alowing requisite tracking of entire sls files
.IP \(bu 2
Fixed bug with aptpkg.mod_repo returning OK even if apt\-add\-repository fails
.IP \(bu 2
Increased frequency of ssh terminal output checking
.IP \(bu 2
Fixed malformed locale string in localmod module
.IP \(bu 2
Fixed checking of available version of package when accept_keywords were changed
.IP \(bu 2
Fixed bug to make git.latest work with empty repositories
.IP \(bu 2
Added **kwargs to service.mod_watch which removes warnings about \fIenable\fP and \fI__reqs__\fP not being supported by the function
.IP \(bu 2
Improved state comments to not grow so quickly on failed requisites
.IP \(bu 2
Added force argument to service to trigger force_reload
.IP \(bu 2
Fixed bug to andle pkgrepo keyids that have been converted to int
.IP \(bu 2
Fixed module.portage_config bug with appending accept_keywords
.IP \(bu 2
Fixed bug to correctly report disk usage on windows minion
.IP \(bu 2
Added the ability to specify key prefix for S3 ext_pillar
.IP \(bu 2
Fixed issues with batch mode operating on the incorrect number of minions
.IP \(bu 2
Fixed a bug with the proxmox cloud provider stacktracing on disk definition
.IP \(bu 2
Fixed a bug with the changes dictionary in the file state
.IP \(bu 2
Fixed the TCP keep alive settings to work better with SREQ caching
.IP \(bu 2
Fixed many bugs within the iptables state and module
.IP \(bu 2
Fixed bug with states by adding \fIfun\fP, \fIstate\fP, and \fIunless\fP to the state runtime internal keywords listing
.IP \(bu 2
Added ability to eAuth against Active Directory
.IP \(bu 2
Fixed some salt\-ssh issues when running on Fedora 21
.IP \(bu 2
Fixed grains.get_or_set_hash to work with multiple entries under same key
.IP \(bu 2
Added better explanations and more examples of how the Reactor calls functions to docs
.IP \(bu 2
Fixed bug to not pass \fIex_config_drive\fP to libcloud unless it\(aqs explicitly enabled
.IP \(bu 2
Fixed bug with pip.install on windows
.IP \(bu 2
Fixed bug where puppet.run always returns a 0 retcode
.IP \(bu 2
Fixed race condition bug with minion scheduling via pillar
.IP \(bu 2
Made efficiency improvements and bug fixes to the windows installer
.IP \(bu 2
Updated environment variables to fix bug with pygit2 when running salt as non\-root user
.IP \(bu 2
Fixed cas behavior on data module \-\- data.cas was not saving changes
.IP \(bu 2
Fixed GPG rendering error
.IP \(bu 2
Fixed strace error in virt.query
.IP \(bu 2
Fixed stacktrace when running chef\-solo command
.IP \(bu 2
Fixed possible bug wherein uncaught exceptions seem to make zmq3 tip over when threading is involved
.IP \(bu 2
Fixed argument passing to the reactor
.IP \(bu 2
Fixed glibc caching to prevent bug where salt\-minion getaddrinfo in dns_check() never got updated nameservers
.UNINDENT
.sp
Known issues:
.INDENT 0.0
.IP \(bu 2
In multimaster mode, a minion may become temporarily unresponsive
if modules or pillars are refreshed at the same time that one
or more masters are down. This can be worked around by setting
\(aqauth_timeout\(aq and \(aqauth_tries\(aq down to shorter periods.
.UNINDENT
.SS Salt 2014.7.6 Release Notes
.INDENT 0.0
.TP
.B release
2015\-05\-18
.UNINDENT
.sp
Version 2014.7.6 is a bugfix release for \fI\%2014.7.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB122\fP
.IP \(bu 2
Total Issue References: \fB66\fP
.IP \(bu 2
Total PR References: \fB166\fP
.IP \(bu 2
Contributors: \fB49\fP (\fI\%0xf10e\fP, \fI\%Azidburn\fP, \fI\%F30\fP, \fI\%JaseFace\fP, \fI\%JohannesEbke\fP,
\fI\%aletourneau\fP, \fI\%aneeshusa\fP, \fI\%basepi\fP, \fI\%bastichelaar\fP, \fI\%bersace\fP, \fI\%cachedout\fP, \fI\%cedwards\fP,
\fI\%cellscape\fP, \fI\%chris\-prince\fP, \fI\%clan\fP, \fI\%clinta\fP, \fI\%cr1st1p\fP, \fI\%cro\fP, \fI\%dr4Ke\fP, \fI\%ericfode\fP,
\fI\%ether42\fP, \fI\%garethgreenaway\fP, \fI\%gtmanfred\fP, \fI\%hvnsweeting\fP, \fI\%jfindlay\fP, \fI\%jleroy\fP,
\fI\%joejulian\fP, \fI\%justinta\fP, \fI\%kaithar\fP, \fI\%lorengordon\fP, \fI\%martinhoefling\fP, \fI\%mguegan\fP, \fI\%multani\fP,
\fI\%notpeter\fP, \fI\%panticz\fP, \fI\%rallytime\fP, \fI\%rominf\fP, \fI\%rubic\fP, \fI\%s0undt3ch\fP, \fI\%skizunov\fP,
\fI\%slinu3d\fP, \fI\%t0rrant\fP, \fI\%techhat\fP, \fI\%teizz\fP, \fI\%terminalmage\fP, \fI\%thatch45\fP, \fI\%twangboy\fP,
\fI\%vdesjardins\fP, \fI\%vr\-jack\fP)
.UNINDENT
.SS Security Fix
.sp
\fBCVE\-2015\-4017\fP Certificates are not verified when connecting to server in
the Aliyun and Proxmox modules
.sp
Only users of the Aliyun or Proxmox cloud modules are at risk. The
vulnerability does not exist in the latest 2015.5.0 release of Salt.
.SS Changelog for v2014.7.5..v2014.7.6
.sp
\fIGenerated at: 2018\-05\-27 20:42:49 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#23810\fP: (\fI\%rallytime\fP) Backport \fI\%#23757\fP to 2014.7
@ \fI2015\-05\-18 15:30:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23757\fP: (\fI\%clan\fP) use abspath, do not eliminating symlinks (refs: \fI\%#23810\fP)
.IP \(bu 2
aee00c83df Merge pull request \fI\%#23810\fP from rallytime/bp\-23757
.IP \(bu 2
fb32c32065 use abspath, do not eliminating symlinks
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#20198\fP: (\fI\%jcftang\fP) virt.get_graphics, virt.get_nics are broken, in turn breaking other things (refs: \fI\%#23809\fP, \fI\%#21469\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23809\fP: (\fI\%rallytime\fP) Fix virtualport section of virt.get_nics loop
@ \fI2015\-05\-18 15:30:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#21487\fP: (\fI\%rallytime\fP) Backport \fI\%#21469\fP to 2014.7 (refs: \fI\%#23809\fP)
.IP \(bu 2
\fBPR\fP \fI\%#21469\fP: (\fI\%vdesjardins\fP) fixes \fI\%#20198\fP: virt.get_graphics and virt.get_nics calls in module virt (refs: \fI\%#21487\fP)
.IP \(bu 2
6b3352bb1a Merge pull request \fI\%#23809\fP from rallytime/virt_get_nics_fix
.IP \(bu 2
0616fb7884 Fix virtualport section of virt.get_nics loop
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23823\fP: (\fI\%gtmanfred\fP) add link local for ipv6
@ \fI2015\-05\-17 12:48:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
188f03f567 Merge pull request \fI\%#23823\fP from gtmanfred/2014.7
.IP \(bu 2
5ef006d59d add link local for ipv6
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23802\fP: (\fI\%gtmanfred\fP) if it is ipv6 ip_to_int will fail
@ \fI2015\-05\-16 04:06:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23573\fP: (\fI\%techhat\fP) Scan all available networks for public and private IPs (refs: \fI\%#23802\fP)
.IP \(bu 2
f3ca682f92 Merge pull request \fI\%#23802\fP from gtmanfred/2014.7
.IP \(bu 2
2da98b58c8 if it is ipv6 ip_to_int will fail
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23488\fP: (\fI\%cellscape\fP) LXC cloud fixes
@ \fI2015\-05\-15 18:09:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
d9af0c3e82 Merge pull request \fI\%#23488\fP from cellscape/lxc\-cloud\-fixes
.IP \(bu 2
64250a67e5 Remove profile from opts after creating LXC container
.IP \(bu 2
c4047d2a71 Set destroy=True in opts when destroying cloud instance
.IP \(bu 2
9e1311a7cd Store instance names in opts when performing cloud action
.IP \(bu 2
934bc57c73 Correctly pass custom env to lxc\-attach
.IP \(bu 2
7fb85f7be1 Preserve test=True option in cloud states
.IP \(bu 2
9771b5a313 Fix detection of absent LXC container in cloud state
.IP \(bu 2
fb24f0cf02 Report failure when failed to create/clone LXC container
.IP \(bu 2
2d9aa2bb97 Avoid shadowing variables in lxc module
.IP \(bu 2
792e1021f2 Allow overriding profile options in lxc.cloud_init_interface
.IP \(bu 2
42bd64b9b3 Return changes on successful lxc.create from salt\-cloud
.IP \(bu 2
4409eabb83 Return correct result when creating cloud LXC container
.IP \(bu 2
377015c881 Issue \fI\%#16424\fP: List all providers when creating salt\-cloud instance without profile
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22332\fP: (\fI\%rallytime\fP) [salt\-ssh] Add a check for host in /etc/salt/roster (refs: \fI\%#23748\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23748\fP: (\fI\%basepi\fP) [2014.7] Log salt\-ssh roster render errors more assertively and verbosely
@ \fI2015\-05\-14 22:38:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
808bbe1cb2 Merge pull request \fI\%#23748\fP from basepi/salt\-ssh.roster.host.check
.IP \(bu 2
bc53e049e0 Log entire exception for render errors in roster
.IP \(bu 2
753de6a621 Log render errors in roster to error level
.IP \(bu 2
e01a7a90b3 Always let the real YAML error through
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22959\fP: (\fI\%highlyunavailable\fP) Windows Salt hangs if file.directory is trying to write to a drive that doesn\(aqt exist (refs: \fI\%#23731\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23731\fP: (\fI\%twangboy\fP) Fixes \fI\%#22959\fP: Trying to add a directory to an unmapped drive in windows
@ \fI2015\-05\-14 21:59:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
72cf360255 Merge pull request \fI\%#23731\fP from twangboy/fix_22959
.IP \(bu 2
88e5495b2d Fixes \fI\%#22959\fP: Trying to add a directory to an unmapped drive in windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23730\fP: (\fI\%rallytime\fP) Backport \fI\%#23729\fP to 2014.7
@ \fI2015\-05\-14 21:58:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23729\fP: (\fI\%rallytime\fP) Partially merge \fI\%#23437\fP (grains fix) (refs: \fI\%#23730\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23437\fP: (\fI\%cedwards\fP) Grains item patch (refs: \fI\%#23729\fP)
.IP \(bu 2
2610195262 Merge pull request \fI\%#23730\fP from rallytime/bp\-23729
.IP \(bu 2
1877caecba adding support for nested grains to grains.item
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23688\fP: (\fI\%twangboy\fP) Added inet_pton to utils/validate/net.py for ip.set_static_ip in windows
@ \fI2015\-05\-14 16:15:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
3e9df883d6 Merge pull request \fI\%#23688\fP from twangboy/fix_23415
.IP \(bu 2
6a91169bae Fixed unused\-import pylint error
.IP \(bu 2
5e25b3f355 fixed pylint errors
.IP \(bu 2
1a9676626f Added inet_pton to utils/validate/net.py for ip.set_static_ip in windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23403\fP: (\fI\%iamfil\fP) salt.runners.cloud.action fun parameter is replaced (refs: \fI\%#23680\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23680\fP: (\fI\%cachedout\fP) Rename kwarg in cloud runner
@ \fI2015\-05\-13 19:44:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
1b86460d73 Merge pull request \fI\%#23680\fP from cachedout/issue_23403
.IP \(bu 2
d5986c21b4 Rename kwarg in cloud runner
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23548\fP: (\fI\%kkaig\fP) grains.list_present produces incorrect (?) output (refs: \fI\%#23674\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23674\fP: (\fI\%cachedout\fP) Handle lists correctly in grains.list_prsesent
@ \fI2015\-05\-13 18:34:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
cd64af0ce4 Merge pull request \fI\%#23674\fP from cachedout/issue_23548
.IP \(bu 2
da8a2f5cb3 Handle lists correctly in grains.list_prsesent
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23672\fP: (\fI\%twangboy\fP) Fix user present
@ \fI2015\-05\-13 18:30:09 UTC\fP
.INDENT 2.0
.IP \(bu 2
d322a19213 Merge pull request \fI\%#23672\fP from twangboy/fix_user_present
.IP \(bu 2
731e7af3dd Merge branch \(aq2014.7\(aq of \fI\%https://github.com/saltstack/salt\fP into fix_user_present
.IP \(bu 2
d6f70a4545 Fixed user.present to create password in windows
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23604\fP: (\fI\%Azidburn\fP) service.dead on systemd Minion create an Error Message (refs: \fI\%#23607\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23670\fP: (\fI\%rallytime\fP) Backport \fI\%#23607\fP to 2014.7
@ \fI2015\-05\-13 18:27:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23607\fP: (\fI\%Azidburn\fP) Fix for \fI\%#23604\fP\&. No error reporting. Exitcode !=0 are ok (refs: \fI\%#23670\fP)
.IP \(bu 2
43f7025000 Merge pull request \fI\%#23670\fP from rallytime/bp\-23607
.IP \(bu 2
ed30dc4642 Fix for \fI\%#23604\fP\&. No error reporting. Exitcode !=0 are ok
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22141\fP: (\fI\%Deshke\fP) grains.get_or_set_hash render error if hash begins with \(dq%\(dq (refs: \fI\%#23640\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23661\fP: (\fI\%rallytime\fP) Merge \fI\%#23640\fP with whitespace fix
@ \fI2015\-05\-13 15:47:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23640\fP: (\fI\%cachedout\fP) Add warning to get_or_set_hash about reserved chars (refs: \fI\%#23661\fP)
.IP \(bu 2
0f006ac1d8 Merge pull request \fI\%#23661\fP from rallytime/merge\-23640
.IP \(bu 2
4427f42bb6 Whitespace fix
.IP \(bu 2
dd9115466e Add warning to get_or_set_hash about reserved chars
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23452\fP: (\fI\%landergate\fP) minion crashed with empty grain (refs: \fI\%#23639\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23639\fP: (\fI\%cachedout\fP) Handle exceptions raised by __virtual__
@ \fI2015\-05\-13 15:11:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
84e2ef88fc Merge pull request \fI\%#23639\fP from cachedout/issue_23452
.IP \(bu 2
d418b49a77 Syntax error!
.IP \(bu 2
45b4015d7d Handle exceptions raised by __virtual__
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23611\fP: (\fI\%hubez\fP) master_type set to \(aqfailover\(aq but \(aqmaster\(aq is not of type list but of type <type \(aqstr\(aq> (refs: \fI\%#23637\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23637\fP: (\fI\%cachedout\fP) Convert str master to list
@ \fI2015\-05\-13 15:08:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
bd9b94ba8c Merge pull request \fI\%#23637\fP from cachedout/issue_23611
.IP \(bu 2
56cb1f52e3 Fix typo
.IP \(bu 2
f6fcf19a7f Convert str master to list
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23595\fP: (\fI\%rallytime\fP) Backport \fI\%#23549\fP to 2014.7
@ \fI2015\-05\-12 21:19:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23549\fP: (\fI\%vr\-jack\fP) Update __init__.py (refs: \fI\%#23595\fP)
.IP \(bu 2
f20c0e42ce Merge pull request \fI\%#23595\fP from rallytime/bp\-23549
.IP \(bu 2
6efcac09ad Update __init__.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23110\fP: (\fI\%martinhoefling\fP) Copying files from gitfs in file.recurse state fails (refs: \fI\%#23496\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23594\fP: (\fI\%rallytime\fP) Backport \fI\%#23496\fP to 2014.7
@ \fI2015\-05\-12 21:19:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23496\fP: (\fI\%martinhoefling\fP) Fix for issue \fI\%#23110\fP (refs: \fI\%#23594\fP)
.IP \(bu 2
1acaf86da7 Merge pull request \fI\%#23594\fP from rallytime/bp\-23496
.IP \(bu 2
d5ae1d268a Fix for issue \fI\%#23110\fP This resolves issues when the freshly created directory is removed by fileserver.update.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23593\fP: (\fI\%rallytime\fP) Backport \fI\%#23442\fP to 2014.7
@ \fI2015\-05\-12 21:19:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23442\fP: (\fI\%clan\fP) add directory itself to keep list (refs: \fI\%#23593\fP)
.IP \(bu 2
2c221c7332 Merge pull request \fI\%#23593\fP from rallytime/bp\-23442
.IP \(bu 2
39869a15bd check w/ low[\(aqname\(aq] only
.IP \(bu 2
304cc499e9 another fix for file defined w/ id, but require name
.IP \(bu 2
8814d4180e add directory itself to keep list
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23606\fP: (\fI\%twangboy\fP) Fixed checkbox for starting service and actually starting it
@ \fI2015\-05\-12 21:18:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
fadd1ef63c Merge pull request \fI\%#23606\fP from twangboy/fix_installer
.IP \(bu 2
038331edab Fixed checkbox for starting service and actually starting it
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22908\fP: (\fI\%karanjad\fP) Add failhard option to salt orchestration (refs: \fI\%#23389\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23592\fP: (\fI\%rallytime\fP) Backport \fI\%#23389\fP to 2014.7
@ \fI2015\-05\-12 16:44:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23389\fP: (\fI\%cachedout\fP) Correct fail_hard typo (refs: \fI\%#23592\fP)
.IP \(bu 2
10b3f0f643 Merge pull request \fI\%#23592\fP from rallytime/bp\-23389
.IP \(bu 2
734cc43801 Correct fail_hard typo
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23573\fP: (\fI\%techhat\fP) Scan all available networks for public and private IPs (refs: \fI\%#23802\fP)
@ \fI2015\-05\-12 15:22:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
cd34b9b6c4 Merge pull request \fI\%#23573\fP from techhat/novaquery
.IP \(bu 2
f92db5e92f Linting
.IP \(bu 2
26e00d3ccc Scan all available networks for public and private IPs
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23479\fP: (\fI\%danielmorlock\fP) Typo in pkg.removed for Gentoo? (refs: \fI\%#23558\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23558\fP: (\fI\%jfindlay\fP) reorder emerge command line
@ \fI2015\-05\-12 15:17:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
2a72cd71c2 Merge pull request \fI\%#23558\fP from jfindlay/fix_ebuild
.IP \(bu 2
45404fb2a6 reorder emerge command line
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23355\fP: (\fI\%dr4Ke\fP) salt\-ssh: \(aqsources: salt://\(aq files from \(aqpkg\(aq state are not included in salt_state.tgz (refs: \fI\%#23530\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23530\fP: (\fI\%dr4Ke\fP) salt\-ssh state: fix including all salt:// references
@ \fI2015\-05\-12 15:13:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
a664a3c6fd Merge pull request \fI\%#23530\fP from dr4Ke/fix_salt\-ssh_to_include_pkg_sources
.IP \(bu 2
5df6a8008c fix pylint warning
.IP \(bu 2
d0549e56ba salt\-ssh state: fix including all salt:// references
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23004\fP: (\fI\%b18\fP) 2014.7.5 \- Windows \- pkg.list_pkgs \- \(dqnxlog\(dq never shows up in output. (refs: \fI\%#23433\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23433\fP: (\fI\%twangboy\fP) Obtain all software from the registry
@ \fI2015\-05\-11 22:47:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
55c3869861 Merge pull request \fI\%#23433\fP from twangboy/list_pkgs_fix
.IP \(bu 2
8ab5b1b86f Fix pylint error
.IP \(bu 2
2d11d6545e Obtain all software from the registry
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23554\fP: (\fI\%jleroy\fP) Debian: Hostname always updated
@ \fI2015\-05\-11 21:57:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
755bed0abd Merge pull request \fI\%#23554\fP from jleroy/debian\-hostname\-fix
.IP \(bu 2
5ff749e487 Debian: Hostname always updated
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23411\fP: (\fI\%dr4Ke\fP) grains.append should work at any level of a grain (refs: \fI\%#23440\fP, \fI\%#23474\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23551\fP: (\fI\%dr4Ke\fP) grains.append unit tests, related to \fI\%#23474\fP
@ \fI2015\-05\-11 21:54:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23474\fP: (\fI\%dr4Ke\fP) Fix grains.append in nested dictionary grains \fI\%#23411\fP (refs: \fI\%#23551\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23440\fP: (\fI\%dr4Ke\fP) fix grains.append in nested dictionary grains \fI\%#23411\fP (refs: \fI\%#23474\fP)
.IP \(bu 2
6ec87ce9f5 Merge pull request \fI\%#23551\fP from dr4Ke/grains.append_unit_tests
.IP \(bu 2
ebff9df5b2 fix pylint errors
.IP \(bu 2
c4954046ad unit tests for grains.append module function
.IP \(bu 2
0c9a32326c use MagickMock
.IP \(bu 2
c838a22377 unit tests for grains.append module function
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23411\fP: (\fI\%dr4Ke\fP) grains.append should work at any level of a grain (refs: \fI\%#23440\fP, \fI\%#23474\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23474\fP: (\fI\%dr4Ke\fP) Fix grains.append in nested dictionary grains \fI\%#23411\fP (refs: \fI\%#23551\fP)
@ \fI2015\-05\-11 18:00:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23440\fP: (\fI\%dr4Ke\fP) fix grains.append in nested dictionary grains \fI\%#23411\fP (refs: \fI\%#23474\fP)
.IP \(bu 2
e96c5c5bf3 Merge pull request \fI\%#23474\fP from dr4Ke/fix_grains.append_nested
.IP \(bu 2
a01a5bb51e grains.get, parameter delimiter, versionadded: 2014.7.6
.IP \(bu 2
b39f50475d remove debugging output
.IP \(bu 2
b6e15e295c fix grains.append in nested dictionary grains \fI\%#23411\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23537\fP: (\fI\%t0rrant\fP) Update changelog
@ \fI2015\-05\-11 17:02:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
ab7e1aed8e Merge pull request \fI\%#23537\fP from t0rrant/patch\-1
.IP \(bu 2
8e03cc99d3 Update changelog
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23538\fP: (\fI\%cro\fP) Update date in LICENSE file
@ \fI2015\-05\-11 15:19:25 UTC\fP
.INDENT 2.0
.IP \(bu 2
b79fed3a92 Merge pull request \fI\%#23538\fP from cro/licupdate
.IP \(bu 2
345efe25c9 Update date in LICENSE file
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23159\fP: (\fI\%aneeshusa\fP) Unused validator (refs: \fI\%#23505\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23505\fP: (\fI\%aneeshusa\fP) Remove unused ssh config validator. Fixes \fI\%#23159\fP\&.
@ \fI2015\-05\-09 13:24:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
a123a36f05 Merge pull request \fI\%#23505\fP from aneeshusa/remove\-unused\-ssh\-config\-validator
.IP \(bu 2
90af1672ca Remove unused ssh config validator. Fixes \fI\%#23159\fP\&.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#20518\fP: (\fI\%ekle\fP) module s3.get does not support eu\-central\-1 (refs: \fI\%#23467\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23467\fP: (\fI\%slinu3d\fP) Added AWS v4 signature support
@ \fI2015\-05\-08 14:36:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
ca2c21a63c Merge pull request \fI\%#23467\fP from slinu3d/2014.7
.IP \(bu 2
0b4081d8f4 Fixed pylint error at line 363
.IP \(bu 2
5be5eb5b14 Fixed pylink errors
.IP \(bu 2
e64f374ffa Fixed lint errors
.IP \(bu 2
b9d1ac4f1f Added AWS v4 signature support
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23444\fP: (\fI\%techhat\fP) Add create_attach_volume to nova driver
@ \fI2015\-05\-07 19:51:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
e6f9eec02e Merge pull request \fI\%#23444\fP from techhat/novacreateattach
.IP \(bu 2
ebdb7eae2d Add create_attach_volume to nova driver
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#529\fP: (\fI\%rubic\fP) run salt in user space (refs: \fI\%#543\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#563\fP: (\fI\%notpeter\fP) Ubuntu alternate ppas (refs: \fI\%#23460\fP)
.IP \(bu 2
\fBPR\fP \fI\%#543\fP: (\fI\%rubic\fP) updated documentation for user, fixed configuration template links (refs: #\(gasaltstack/salt\-bootstrap#563\(ga_)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23460\fP: (\fI\%s0undt3ch\fP) [2014.7] Update to latest stable bootstrap script v2015.05.07
@ \fI2015\-05\-07 19:10:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
e331463319 Merge pull request \fI\%#23460\fP from s0undt3ch/hotfix/bootstrap\-script\-2014.7
.IP \(bu 2
edcd0c41f2 Update to latest stable bootstrap script v2015.05.07
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23439\fP: (\fI\%techhat\fP) Add wait_for_passwd_maxtries variable
@ \fI2015\-05\-07 07:28:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
7a8ce1a954 Merge pull request \fI\%#23439\fP from techhat/maxtries
.IP \(bu 2
0ad3ff2c88 Add wait_for_passwd_maxtries variable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23422\fP: (\fI\%cro\fP) $HOME should not be used, some shells don\(aqt set it.
@ \fI2015\-05\-06 21:02:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
644eb75fec Merge pull request \fI\%#23422\fP from cro/gce_sh_home
.IP \(bu 2
4ef9e6ba06 Don\(aqt use $HOME to find user\(aqs directory, some shells don\(aqt set it
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23425\fP: (\fI\%basepi\fP) [2014.7] Fix typo in FunctionWrapper
@ \fI2015\-05\-06 20:38:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
ef17ab4b2a Merge pull request \fI\%#23425\fP from basepi/functionwrapper_typo
.IP \(bu 2
c390737f3e Fix typo in FunctionWrapper
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23385\fP: (\fI\%rallytime\fP) Backport \fI\%#23346\fP to 2014.7
@ \fI2015\-05\-06 20:12:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23346\fP: (\fI\%ericfode\fP) Allow file_map in salt\-cloud to handle folders. (refs: \fI\%#23385\fP)
.IP \(bu 2
1b13ec04c2 Merge pull request \fI\%#23385\fP from rallytime/bp\-23346
.IP \(bu 2
9efc13c810 more linting fixes
.IP \(bu 2
cf131c9a5a cleaned up some pylint errors
.IP \(bu 2
f981699c75 added logic to sftp_file and file_map to allow folder uploads using file_map
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23414\fP: (\fI\%jfindlay\fP) 2015.2 \-> 2015.5
@ \fI2015\-05\-06 20:04:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
f8c7a62089 Merge pull request \fI\%#23414\fP from jfindlay/update_branch
.IP \(bu 2
8074d16d52 2015.2 \-> 2015.5
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23404\fP: (\fI\%hvnsweeting\fP) saltapi cherrypy: initialize var when POST body is empty
@ \fI2015\-05\-06 17:35:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
54b3bd43e4 Merge pull request \fI\%#23404\fP from hvnsweeting/cherrypy\-post\-emptybody\-fix
.IP \(bu 2
f85f8f954c initialize var when POST body is empty
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23409\fP: (\fI\%terminalmage\fP) Update Lithium docstrings in 2014.7 branch
@ \fI2015\-05\-06 16:20:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
160f703296 Merge pull request \fI\%#23409\fP from terminalmage/update\-lithium\-docstrings\-2014.7
.IP \(bu 2
bc97d011ba Fix sphinx typo
.IP \(bu 2
20006b06f6 Update Lithium docstrings in 2014.7 branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#17245\fP: (\fI\%tomashavlas\fP) localemod does not generate locale for Arch (refs: \fI\%#23397\fP, \fI\%#23307\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23397\fP: (\fI\%jfindlay\fP) add more flexible whitespace to locale_gen search
@ \fI2015\-05\-06 03:44:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
aa5fb0aa46 Merge pull request \fI\%#23397\fP from jfindlay/fix_locale_gen
.IP \(bu 2
0941fefd2b add more flexible whitespace to locale_gen search
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23368\fP: (\fI\%kaithar\fP) Backport \fI\%#23367\fP to 2014.7
@ \fI2015\-05\-05 21:42:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23367\fP: (\fI\%kaithar\fP) Put the sed insert statement back in to the output. (refs: \fI\%#23368\fP)
.IP \(bu 2
\fBPR\fP \fI\%#18368\fP: (\fI\%basepi\fP) Merge forward from 2014.7 to develop (refs: \fI\%#23368\fP, \fI\%#23367\fP)
.IP \(bu 2
0c76dd4d8a Merge pull request \fI\%#23368\fP from kaithar/bp\-23367
.IP \(bu 2
577f41972e Pylint fix
.IP \(bu 2
8d9acd1f89 Put the sed insert statement back in to the output.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23294\fP: (\fI\%variia\fP) file.replace fails to append if repl string partially available (refs: \fI\%#23350\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23350\fP: (\fI\%lorengordon\fP) Append/prepend: search for full line
@ \fI2015\-05\-05 21:42:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
3493cc1fca Merge pull request \fI\%#23350\fP from lorengordon/file.replace_assume_line
.IP \(bu 2
b60e224beb Append/prepend: search for full line
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23026\fP: (\fI\%adelcast\fP) Incorrect salt\-syndic logfile and pidfile locations (refs: \fI\%#23341\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23341\fP: (\fI\%cachedout\fP) Fix syndic pid and logfile path
@ \fI2015\-05\-05 21:29:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
7be5c48ad5 Merge pull request \fI\%#23341\fP from cachedout/issue_23026
.IP \(bu 2
e98e65e787 Fix tests
.IP \(bu 2
6011b437ca Fix syndic pid and logfile path
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19114\fP: (\fI\%pykler\fP) salt\-ssh and gpg pillar renderer (refs: \fI\%#23347\fP, \fI\%#23272\fP, \fI\%#23188\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23272\fP: (\fI\%basepi\fP) [2014.7] Allow salt\-ssh minion config overrides via master config and roster (refs: \fI\%#23347\fP)
@ \fI2015\-05\-05 21:28:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23188\fP: (\fI\%basepi\fP) [2014.7] Work around bug in salt\-ssh in config.get for gpg renderer (refs: \fI\%#23272\fP)
.IP \(bu 2
ea61abfa68 Merge pull request \fI\%#23272\fP from basepi/salt\-ssh.minion.config.19114
.IP \(bu 2
c223309bb7 Add versionadded
.IP \(bu 2
be7407feae Lint
.IP \(bu 2
c2c337567e Missing comma
.IP \(bu 2
8e3e8e073a Pass the minion_opts through the FunctionWrapper
.IP \(bu 2
cb69cd07de Match the master config template in the master config reference
.IP \(bu 2
87fc3161f9 Add Salt\-SSH section to master config template
.IP \(bu 2
91dd9dcbdc Add ssh_minion_opts to master config ref
.IP \(bu 2
c273ea14c6 Add minion config to salt\-ssh doc
.IP \(bu 2
a0b6b760c3 Add minion_opts to roster docs
.IP \(bu 2
5212c35260 Accept minion_opts from the target information
.IP \(bu 2
e2099b6e1b Process \fIssh_minion_opts\fP from master config
.IP \(bu 2
3b64214377 Revert \(dqWork around bug in salt\-ssh in config.get for gpg renderer\(dq
.IP \(bu 2
494953a208 Remove the strip (embracing multi\-line YAML dump)
.IP \(bu 2
fe87f0fe39 Dump multi\-line yaml into the SHIM
.IP \(bu 2
b751a7281c Inject local minion config into shim if available
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19114\fP: (\fI\%pykler\fP) salt\-ssh and gpg pillar renderer (refs: \fI\%#23347\fP, \fI\%#23272\fP, \fI\%#23188\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23347\fP: (\fI\%basepi\fP) [2014.7] Salt\-SSH Backport FunctionWrapper.__contains__
@ \fI2015\-05\-05 14:13:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23272\fP: (\fI\%basepi\fP) [2014.7] Allow salt\-ssh minion config overrides via master config and roster (refs: \fI\%#23347\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23188\fP: (\fI\%basepi\fP) [2014.7] Work around bug in salt\-ssh in config.get for gpg renderer (refs: \fI\%#23272\fP)
.IP \(bu 2
4f760dd9cb Merge pull request \fI\%#23347\fP from basepi/salt\-ssh.functionwrapper.contains.19114
.IP \(bu 2
30595e3ff7 Backport FunctionWrapper.__contains__
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22742\fP: (\fI\%hvnsweeting\fP) salt\-master says: \(dqThis master address: \(aqsalt\(aq was previously resolvable but now fails to resolve!\(dq (refs: \fI\%#23344\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23344\fP: (\fI\%cachedout\fP) Explicitly set file_client on master
@ \fI2015\-05\-04 23:21:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
02658b1e60 Merge pull request \fI\%#23344\fP from cachedout/issue_22742
.IP \(bu 2
5adc96ce7f Explicitly set file_client on master
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23318\fP: (\fI\%cellscape\fP) Honor seed argument in LXC container initializaton
@ \fI2015\-05\-04 20:58:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23311\fP: (\fI\%cellscape\fP) Fix new container initialization in LXC runner (refs: \fI\%#23318\fP)
.IP \(bu 2
ba7605d1cb Merge pull request \fI\%#23318\fP from cellscape/honor\-seed\-argument
.IP \(bu 2
228b1be299 Honor seed argument in LXC container initializaton
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#17245\fP: (\fI\%tomashavlas\fP) localemod does not generate locale for Arch (refs: \fI\%#23397\fP, \fI\%#23307\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23307\fP: (\fI\%jfindlay\fP) check for /etc/locale.gen
@ \fI2015\-05\-04 20:56:32 UTC\fP
.INDENT 2.0
.IP \(bu 2
4ac4509c57 Merge pull request \fI\%#23307\fP from jfindlay/fix_locale_gen
.IP \(bu 2
101199ac14 check for /etc/locale.gen
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#580\fP: (\fI\%bradthurber\fP) git develop broken in centos6/rhel6/others? due to missing python tornado dep  (refs: \fI\%#23324\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#560\fP: (\fI\%bradthurber\fP) param to avoid git install on CentOS/RHEL? (refs: \fI\%#23324\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#552\fP: (\fI\%jhutchins\fP) Support require and watch under the same state dec (refs: \fI\%#23324\fP)
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#589\fP: (\fI\%panticz\fP) Fix Debian Squeeze backports mirror (refs: \fI\%#23324\fP)
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt\-bootstrap#504\fP: (\fI\%rominf\fP) opensuse 13.2: fix installation (refs: \fI\%#23324\fP)
.IP \(bu 2
\fBPR\fP \fI\%#567\fP: (\fI\%bastichelaar\fP) Added upstart module (refs: \fI\%#23324\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23324\fP: (\fI\%s0undt3ch\fP) [2014.7] Update to the latest stable release of the bootstrap script v2015.05.04
@ \fI2015\-05\-04 16:28:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
f790f42ed6 Merge pull request \fI\%#23324\fP from s0undt3ch/hotfix/bootstrap\-script\-2014.7
.IP \(bu 2
6643e47ce5 Update to the latest stable release of the bootstrap script v2015.05.04
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23329\fP: (\fI\%cro\fP) Require requests to verify cert when talking to aliyun and proxmox cloud providers
@ \fI2015\-05\-04 16:18:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
5487367baa Merge pull request \fI\%#23329\fP from cro/cloud_verify_cert
.IP \(bu 2
860d4b7338 Turn on ssl verify for requests.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23311\fP: (\fI\%cellscape\fP) Fix new container initialization in LXC runner (refs: \fI\%#23318\fP)
@ \fI2015\-05\-04 09:55:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
ea2017672d Merge pull request \fI\%#23311\fP from cellscape/fix\-salt\-cloud\-lxc\-init
.IP \(bu 2
76fbb34e7d Fix new container initialization in LXC runner
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18880\fP: (\fI\%johtso\fP) npm installed breaks when a module is missing (refs: \fI\%#23298\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23298\fP: (\fI\%chris\-prince\fP) Fixed issue \fI\%#18880\fP in 2014.7 branch
@ \fI2015\-05\-03 15:49:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
c399b8f568 Merge pull request \fI\%#23298\fP from chris\-prince/2014.7
.IP \(bu 2
0fa25dbb58 Fixed issue \fI\%#18880\fP in 2014.7 branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23148\fP: (\fI\%cr1st1p\fP) virt \- error handling bogus if machine image location is wrong (refs: \fI\%#23151\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23292\fP: (\fI\%rallytime\fP) Merge \fI\%#23151\fP with pylint fixes
@ \fI2015\-05\-02 03:54:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23151\fP: (\fI\%cr1st1p\fP) Fixes \fI\%#23148\fP (refs: \fI\%#23292\fP)
.IP \(bu 2
16ecefd466 Merge pull request \fI\%#23292\fP from rallytime/merge\-23151
.IP \(bu 2
8ff852a23a Merge \fI\%#23151\fP with pylint fixes
.IP \(bu 2
8ffa12e82d Fixes \fI\%#23148\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23274\fP: (\fI\%basepi\fP) [2014.7] Reduce salt\-ssh debug log verbosity
@ \fI2015\-05\-01 20:19:23 UTC\fP
.INDENT 2.0
.IP \(bu 2
ce24315a4b Merge pull request \fI\%#23274\fP from basepi/salt\-ssh.debug.verbosity
.IP \(bu 2
ecee6c68f4 Log stdout and stderr to trace
.IP \(bu 2
08f54d79c6 Log stdout and stderr to trace as well
.IP \(bu 2
9b9c30f5ad Reduce salt\-ssh debug log verbosity
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22605\fP: (\fI\%mavenAtHouzz\fP) Tornado websockets event Handlers registration are incorrect (refs: \fI\%#23261\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23261\fP: (\fI\%rallytime\fP) Fix tornado websocket event handler registration
@ \fI2015\-05\-01 18:20:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
7b55e4310f Merge pull request \fI\%#23261\fP from rallytime/fix\-22605
.IP \(bu 2
4950fbf2b3 Fix tornado websocket event handler registration
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23258\fP: (\fI\%teizz\fP) TCP keepalives on the ret side, Revisited.
@ \fI2015\-05\-01 16:13:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
83ef7cb114 Merge pull request \fI\%#23258\fP from teizz/ret_keepalive_2014_7_5
.IP \(bu 2
0b9fb6f9be The fixes by cachedout which were backported into 2015_2 were missing a single parameter thus not setting up the TCP keepalive for the ZeroMQ Channel by default.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23224\fP: (\fI\%twellspring\fP) iptables.append \-\-log parameters must be after \-\-jump LOG (refs: \fI\%#23241\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23241\fP: (\fI\%techhat\fP) Move iptables log options after the jump
@ \fI2015\-05\-01 01:31:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
8de3c83956 Merge pull request \fI\%#23241\fP from techhat/issue23224
.IP \(bu 2
87f7948c99 Move iptables log options after the jump
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23228\fP: (\fI\%rallytime\fP) Backport \fI\%#23171\fP to 2014.7
@ \fI2015\-04\-30 21:09:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23171\fP: (\fI\%skizunov\fP) Bugfix: \(aqclean_proc_dir\(aq is broken (refs: \fI\%#23228\fP)
.IP \(bu 2
f20210e499 Merge pull request \fI\%#23228\fP from rallytime/bp\-23171
.IP \(bu 2
e670e99506 Bugfix: \(aqclean_proc_dir\(aq is broken
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22703\fP: (\fI\%Xiol\fP) salt\-ssh does not work with list matcher (refs: \fI\%#22808\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23227\fP: (\fI\%rallytime\fP) Backport \fI\%#22808\fP to 2014.7
@ \fI2015\-04\-30 21:09:14 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#22808\fP: (\fI\%basepi\fP) [2015.2] Add list targeting to salt\-ssh flat roster (refs: \fI\%#23227\fP)
.IP \(bu 2
721cc285ee Merge pull request \fI\%#23227\fP from rallytime/bp\-22808
.IP \(bu 2
d208a00b2a Dict, not list
.IP \(bu 2
a3f529e003 It\(aqs already been converted to a list
.IP \(bu 2
dd57f2d1c1 Add list targeting to salt\-ssh flat roster
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22823\fP: (\fI\%hvnsweeting\fP) 22822 file directory clean
@ \fI2015\-04\-30 15:25:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
82c22afacc Merge pull request \fI\%#22823\fP from hvnsweeting/22822\-file\-directory\-clean
.IP \(bu 2
c749c276b4 fix lint \- remove unnecessary parenthesis
.IP \(bu 2
cb3dfee969 refactor
.IP \(bu 2
8924b5a911 refactor: use relpath instead of do it manually
.IP \(bu 2
d3060a51a3 refactor
.IP \(bu 2
5759a0e8f0 bugfix: fix file.directory clean=True when it require parent dir
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#22941\fP: (\fI\%bersace\fP) \fI_pillar\fP func breaks fileserver globals (refs: \fI\%#22942\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#22941\fP: (\fI\%bersace\fP) \fI_pillar\fP func breaks fileserver globals (refs: \fI\%#22977\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22977\fP: (\fI\%bersace\fP) Fix fileserver backends __opts__ overwritten by _pillar
@ \fI2015\-04\-30 15:24:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#22942\fP: (\fI\%bersace\fP) Fix fileserver backends global overwritten by _pillar (refs: \fI\%#22977\fP)
.IP \(bu 2
f6c0728bfb Merge pull request \fI\%#22977\fP from bersace/fix\-fileserver\-backends\-pillar\-side\-effect
.IP \(bu 2
5f451f63cf Fix fileserver backends __opts__ overwritten by _pillar
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23166\fP: (\fI\%claudiupopescu\fP) \(dqError in function _minion_event\(dq resulting in modules not loaded (refs: \fI\%#23180\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23180\fP: (\fI\%jfindlay\fP) fix typos from 36841bdd in masterapi.py
@ \fI2015\-04\-30 15:22:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
34206f7ae3 Merge pull request \fI\%#23180\fP from jfindlay/remote_event
.IP \(bu 2
72066e1073 fix typos from 36841bdd in masterapi.py
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23153\fP: (\fI\%cr1st1p\fP) cmdmod : run_chroot \- broken in 2014.7.5 \- missing kwargs (refs: \fI\%#23176\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23176\fP: (\fI\%jfindlay\fP) copy standard cmd.run* kwargs into cmd.run_chroot
@ \fI2015\-04\-30 15:22:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
b6b82165c8 Merge pull request \fI\%#23176\fP from jfindlay/run_chroot
.IP \(bu 2
7dc3417b44 copy standard cmd.run* kwargs into cmd.run_chroot
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23192\fP: (\fI\%joejulian\fP) supervisord mod_watch does not accept sfun (refs: \fI\%#23193\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23193\fP: (\fI\%joejulian\fP) supervisord.mod_watch should accept sfun
@ \fI2015\-04\-30 04:34:21 UTC\fP
.INDENT 2.0
.IP \(bu 2
effacbe294 Merge pull request \fI\%#23193\fP from joejulian/2014.7_supervisord_accept_sfun
.IP \(bu 2
efb59f9d9d supervisord.mod_watch should accept sfun
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#19114\fP: (\fI\%pykler\fP) salt\-ssh and gpg pillar renderer (refs: \fI\%#23347\fP, \fI\%#23272\fP, \fI\%#23188\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23188\fP: (\fI\%basepi\fP) [2014.7] Work around bug in salt\-ssh in config.get for gpg renderer (refs: \fI\%#23272\fP)
@ \fI2015\-04\-30 04:34:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
72fe88e5c6 Merge pull request \fI\%#23188\fP from basepi/salt\-ssh.function.wrapper.gpg.19114
.IP \(bu 2
d73979ee12 Work around bug in salt\-ssh in config.get for gpg renderer
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21480\fP: (\fI\%msciciel\fP) TypeError: string indices must be integers, not str (refs: \fI\%#23154\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23154\fP: (\fI\%cachedout\fP) Re\-establish channel on interruption in fileclient
@ \fI2015\-04\-29 16:18:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
168508ec2a Merge pull request \fI\%#23154\fP from cachedout/refresh_channel
.IP \(bu 2
9f8dd80c38 Re\-establish channel on interruption in fileclient
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#20647\fP: (\fI\%ryan\-lane\fP) file.serialize fails to serialize due to ordered dicts (refs: \fI\%#20779\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23146\fP: (\fI\%rallytime\fP) Backport \fI\%#20779\fP to 2014.7
@ \fI2015\-04\-28 20:45:06 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#20779\fP: (\fI\%cachedout\fP) Use declared yaml options (refs: \fI\%#23146\fP)
.IP \(bu 2
3b53e04534 Merge pull request \fI\%#23146\fP from rallytime/bp\-20779
.IP \(bu 2
ffd18493e8 compare OrderedDicts in serializer unit test
.IP \(bu 2
a22170627c Just change serialize
.IP \(bu 2
a111798e8e Use declared yaml options
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23145\fP: (\fI\%rallytime\fP) Backport \fI\%#23089\fP to 2014.7
@ \fI2015\-04\-28 20:44:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23089\fP: (\fI\%cachedout\fP) Stringify version number before lstrip (refs: \fI\%#23145\fP)
.IP \(bu 2
8bb4664bf9 Merge pull request \fI\%#23145\fP from rallytime/bp\-23089
.IP \(bu 2
93c41afd23 Stringify version number before lstrip
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#16188\fP: (\fI\%drawks\fP) salt.modules.parted has various functions with bogus input validation. (refs: \fI\%#23124\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23144\fP: (\fI\%rallytime\fP) Backport \fI\%#23124\fP to 2014.7
@ \fI2015\-04\-28 20:44:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23124\fP: (\fI\%ether42\fP) fix parsing the output of parted in parted.list_() (refs: \fI\%#23144\fP)
.IP \(bu 2
c85d36fd29 Merge pull request \fI\%#23144\fP from rallytime/bp\-23124\-2014\-7
.IP \(bu 2
6b64da706c fix parsing the output of parted
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23120\fP: (\fI\%terminalmage\fP) Don\(aqt run os.path.relpath() if repo doesn\(aqt have a \(dqroot\(dq param set
@ \fI2015\-04\-28 15:46:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
a27b158153 Merge pull request \fI\%#23120\fP from terminalmage/fix\-gitfs\-relpath
.IP \(bu 2
1860fffd68 Don\(aqt run os.path.relpath() if repo doesn\(aqt have a \(dqroot\(dq param set
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23132\fP: (\fI\%clinta\fP) Backport b27c176
@ \fI2015\-04\-28 15:00:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
fcba607978 Merge pull request \fI\%#23132\fP from clinta/patch\-2
.IP \(bu 2
a824d727d1 Backport b27c176
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18476\fP: (\fI\%Auha\fP) Upgrading salt on my master caused dependency issues (refs: \fI\%#18610\fP, \fI\%#23114\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23114\fP: (\fI\%rallytime\fP) Adjust ZeroMQ 4 docs to reflect changes to Ubuntu 12 packages
@ \fI2015\-04\-28 03:59:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#18610\fP: (\fI\%rallytime\fP) Make ZMQ 4 installation docs for ubuntu more clear (refs: \fI\%#23114\fP)
.IP \(bu 2
b0f4b28487 Merge pull request \fI\%#23114\fP from rallytime/remove_ubuntu_zmq4_docs
.IP \(bu 2
f6cc7c8f8a Adjust ZeroMQ 4 docs to reflect changes to Ubuntu 12 packages
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23085\fP: (\fI\%xenophonf\fP) Use \(dqs3fs\(dq (not \(dqs3\(dq) in fileserver_roots (refs: \fI\%#23097\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23108\fP: (\fI\%rallytime\fP) Backport \fI\%#23097\fP to 2014.7
@ \fI2015\-04\-28 03:58:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23097\fP: (\fI\%rallytime\fP) Change s3 to s3fs in fileserver_roots docs example (refs: \fI\%#23108\fP)
.IP \(bu 2
399857f20b Merge pull request \fI\%#23108\fP from rallytime/bp\-23097
.IP \(bu 2
fa889845df Change s3 to s3fs in fileserver_roots docs example
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22171\fP: (\fI\%basepi\fP) We should only call returner.save_load once per jid (refs: \fI\%#22199\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23112\fP: (\fI\%basepi\fP) [2014.7] Backport \fI\%#22199\fP to fix mysql returner save_load errors
@ \fI2015\-04\-28 03:55:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#22199\fP: (\fI\%basepi\fP) [2015.2] Put a bandaid on the save_load duplicate issue (mysql returner) (refs: \fI\%#23112\fP)
.IP \(bu 2
5541537c32 Merge pull request \fI\%#23112\fP from basepi/mysql_returner_save_load
.IP \(bu 2
0127012ed3 Put a bandaid on the save_load duplicate issue
.IP \(bu 2
\fBPR\fP \fI\%saltstack/salt#22925\fP: (\fI\%rallytime\fP) Backport \fI\%#22895\fP to 2014.7 (refs: \fI\%#23113\fP)
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23113\fP: (\fI\%rallytime\fP) Revert \(dqBackport \fI\%#22895\fP to 2014.7\(dq
@ \fI2015\-04\-28 03:27:29 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#22895\fP: (\fI\%aletourneau\fP) pam_tally counter was not reset to 0 after a successful login (refs: \fI\%#23113\fP, \fI\%#22925\fP, #saltstack/salt\(ga#22925\(ga_)
.IP \(bu 2
dfe2066b25 Merge pull request \fI\%#23113\fP from saltstack/revert\-22925\-bp\-22895
.IP \(bu 2
b957ea8977 Revert \(dqBackport \fI\%#22895\fP to 2014.7\(dq
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23013\fP: (\fI\%ghost\fP) gitfs regression with authenticated repos (refs: \fI\%#23094\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23094\fP: (\fI\%terminalmage\fP) pygit2: disable cleaning of stale refs for authenticated remotes
@ \fI2015\-04\-27 20:51:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
21515f3c23 Merge pull request \fI\%#23094\fP from terminalmage/issue23013
.IP \(bu 2
aaf7b04f79 pygit2: disable cleaning of stale refs for authenticated remotes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23048\fP: (\fI\%jfindlay\fP) py\-2.6 compat for utils/boto.py ElementTree exception
@ \fI2015\-04\-25 16:56:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
d45aa21dca Merge pull request \fI\%#23048\fP from jfindlay/ET_error
.IP \(bu 2
64c42ccb5f py\-2.6 compat for utils/boto.py ElementTree exception
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22981\fP: (\fI\%syphernl\fP) Locale state throwing traceback when generating not (yet) existing locale (refs: \fI\%#23025\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23025\fP: (\fI\%jfindlay\fP) catch exceptions on bad system locales/encodings
@ \fI2015\-04\-25 16:56:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
d25a5c102f Merge pull request \fI\%#23025\fP from jfindlay/fix_sys_locale
.IP \(bu 2
9c4d62bb00 catch exceptions on bad system locales/encodings
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22932\fP: (\fI\%hvnsweeting\fP) bugfix: also manipulate dir_mode when source not defined
@ \fI2015\-04\-25 16:54:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
5e44b59a14 Merge pull request \fI\%#22932\fP from hvnsweeting/file\-append\-bugfix
.IP \(bu 2
3f368de14a do not use assert in execution module
.IP \(bu 2
9d4fd4a8c8 bugfix: also manipulate dir_mode when source not defined
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23021\fP: (\fI\%ether42\fP) ps.pgrep raises NoSuchProcess (refs: \fI\%#23055\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23055\fP: (\fI\%jfindlay\fP) prevent ps module errors on accessing dead procs
@ \fI2015\-04\-24 22:39:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
c2416a425f Merge pull request \fI\%#23055\fP from jfindlay/fix_ps
.IP \(bu 2
c2dc7adeb1 prevent ps module errors on accessing dead procs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23031\fP: (\fI\%jfindlay\fP) convert exception e.message to just e
@ \fI2015\-04\-24 18:38:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
bfd9158a83 Merge pull request \fI\%#23031\fP from jfindlay/exception
.IP \(bu 2
856bad1c31 convert exception e.message to just e
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23015\fP: (\fI\%hvnsweeting\fP) if status of service is stop, there is not an error with it
@ \fI2015\-04\-24 14:35:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
7747f3342e Merge pull request \fI\%#23015\fP from hvnsweeting/set\-non\-error\-lvl\-for\-service\-status\-log
.IP \(bu 2
92ea163513 if status of service is stop, there is not an error with it
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22993\fP: (\fI\%jetpak\fP) salt\-minion restart causes all spawned daemons to die on centos7 (systemd) (refs: \fI\%#23000\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23000\fP: (\fI\%jfindlay\fP) set systemd service killMode to process for minion
@ \fI2015\-04\-24 03:42:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
2e09789156 Merge pull request \fI\%#23000\fP from jfindlay/systemd_kill
.IP \(bu 2
3d575e29c4 set systemd service killMode to process for minion
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22707\fP: (\fI\%arthurlogilab\fP) retry_dns of master configuration is missing from the  documentation (refs: \fI\%#22999\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22999\fP: (\fI\%justinta\fP) Added retry_dns to minion doc.
@ \fI2015\-04\-24 03:30:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
b5c059ab26 Merge pull request \fI\%#22999\fP from jtand/fix_22707
.IP \(bu 2
8486e17ab3 Added retry_dns to minion doc.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22990\fP: (\fI\%techhat\fP) Use the proper cloud conf variable
@ \fI2015\-04\-23 17:48:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
27dc877bfd Merge pull request \fI\%#22990\fP from techhat/2014.7
.IP \(bu 2
d33bcbc2c1 Use the proper cloud conf variable
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22976\fP: (\fI\%multani\fP) Improve state_output documentation
@ \fI2015\-04\-23 12:24:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
13dff652c6 Merge pull request \fI\%#22976\fP from multani/fix/state\-output\-doc
.IP \(bu 2
19efd419b5 Improve state_output documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22955\fP: (\fI\%terminalmage\fP) Fix regression introduced yesterday in dockerio module
@ \fI2015\-04\-22 18:56:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
89fa18500c Merge pull request \fI\%#22955\fP from terminalmage/dockerio\-run\-fix
.IP \(bu 2
b4472ad1b2 Fix regression introduced yesterday in dockerio module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22954\fP: (\fI\%rallytime\fP) Backport \fI\%#22909\fP to 2014.7
@ \fI2015\-04\-22 18:56:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#22909\fP: (\fI\%mguegan\fP) Fix compatibility with pkgin > 0.7 (refs: \fI\%#22954\fP)
.IP \(bu 2
46ef227911 Merge pull request \fI\%#22954\fP from rallytime/bp\-22909
.IP \(bu 2
70c1cd3969 Fix compatibility with pkgin > 0.7
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18720\fP: (\fI\%Reiner030\fP) timeouts when setting Route53 records (refs: \fI\%#22856\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22856\fP: (\fI\%jfindlay\fP) increase timeout and decrease tries for route53 records
@ \fI2015\-04\-22 16:47:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
c9ae593461 Merge pull request \fI\%#22856\fP from jfindlay/route53_timeout
.IP \(bu 2
ba4a786984 add route53 record sync wait, default=False
.IP \(bu 2
ea2fd50660 increase timeout and tries for route53 records
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22946\fP: (\fI\%s0undt3ch\fP) Test with a more recent pip version to avoid a traceback
@ \fI2015\-04\-22 16:25:17 UTC\fP
.INDENT 2.0
.IP \(bu 2
a178d444b8 Merge pull request \fI\%#22946\fP from s0undt3ch/2014.7
.IP \(bu 2
bc87749e2c Test with a more recent pip version to avoid a traceback
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22571\fP: (\fI\%BoomerB\fP) same error message as on issue #18504 (refs: \fI\%#22945\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22945\fP: (\fI\%garethgreenaway\fP) Fixes to scheduler
@ \fI2015\-04\-22 16:25:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
de339bef0a Merge pull request \fI\%#22945\fP from garethgreenaway/22571_2014_7_schedule_pillar_refresh_seconds_exceptions
.IP \(bu 2
bfa6d25ed8 Fixing a reported issue when using a scheduled job from pillar with splay.  _seconds element that acted as a backup of the actual seconds was being removed when pillar was refreshed and causing exceptions.  This fix moves some splay related code out of the if else condition so it\(aqs checked whether the job is in the job queue or not.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18843\fP: (\fI\%calvinhp\fP) State user.present will fail to create home if user exists and homedir doesn\(aqt (refs: \fI\%#22933\fP, \fI\%#22887\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22887\fP: (\fI\%hvnsweeting\fP) fix \fI\%#18843\fP
@ \fI2015\-04\-22 15:47:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
12d2b91d85 Merge pull request \fI\%#22887\fP from hvnsweeting/18843\-fix\-user\-present\-home
.IP \(bu 2
7fe7b089fd run user.chhome once to avoid any side\-effect when run it twice
.IP \(bu 2
19de9954ee clarify the usage of home arg
.IP \(bu 2
d6dc09af64 enhance doc, as usermod on ubuntu 12.04 will not CREATE home
.IP \(bu 2
0ce4d7feb6 refactor: force to use boolean
.IP \(bu 2
849d19edd7 log debug the creating dir process
.IP \(bu 2
c4e95b9f48 fix \fI\%#18843\fP: usermod won\(aqt create a dir if old home does not exist
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#2417\fP: (\fI\%ffa\fP) Module standards (refs: \fI\%#22829\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#21140\fP: (\fI\%holms\fP) locale.present state executed successfully, although originally fails (refs: \fI\%#22930\fP, \fI\%#22829\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22930\fP: (\fI\%jfindlay\fP) localemod.gen_locale now always returns a boolean
@ \fI2015\-04\-22 15:37:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#22829\fP: (\fI\%F30\fP) Always return a boolean in gen_locale() (refs: \fI\%#22930\fP)
.IP \(bu 2
b7de7bdf47 Merge pull request \fI\%#22930\fP from jfindlay/localegen_bool
.IP \(bu 2
399399f89e localemod.gen_locale now always returns a boolean
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18843\fP: (\fI\%calvinhp\fP) State user.present will fail to create home if user exists and homedir doesn\(aqt (refs: \fI\%#22933\fP, \fI\%#22887\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22933\fP: (\fI\%hvnsweeting\fP) add test for \fI\%#18843\fP
@ \fI2015\-04\-22 15:27:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
11bcf14979 Merge pull request \fI\%#22933\fP from hvnsweeting/18843\-test
.IP \(bu 2
b13db32fde add test for \fI\%#18843\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22925\fP: (\fI\%rallytime\fP) Backport \fI\%#22895\fP to 2014.7
@ \fI2015\-04\-22 02:30:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#22895\fP: (\fI\%aletourneau\fP) pam_tally counter was not reset to 0 after a successful login (refs: \fI\%#23113\fP, \fI\%#22925\fP, #saltstack/salt\(ga#22925\(ga_)
.IP \(bu 2
6890752dd3 Merge pull request \fI\%#22925\fP from rallytime/bp\-22895
.IP \(bu 2
3852d96213 Pylint fix
.IP \(bu 2
90f7829ad3 Fixed pylint issues
.IP \(bu 2
5ebf159554 Cleaned up pull request
.IP \(bu 2
a08ac478f6 pam_tally counter was not reset to 0 after a successful login
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22790\fP: (\fI\%whiteinge\fP) jobs.list_jobs runner tracebacks on \(aqmissing\(aq argument (refs: \fI\%#22914\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22914\fP: (\fI\%cachedout\fP) Call proper returner function in jobs.list_jobs
@ \fI2015\-04\-22 00:49:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
eca37ebc11 Merge pull request \fI\%#22914\fP from cachedout/issue_22790
.IP \(bu 2
d828d6fd58 Call proper returner function in jobs.list_jobs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22918\fP: (\fI\%JaseFace\fP) Add a note to the git_pillar docs stating that GitPython is the only currently supported provider
@ \fI2015\-04\-22 00:48:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
44f3409b01 Merge pull request \fI\%#22918\fP from JaseFace/git\-pillar\-provider\-doc\-note
.IP \(bu 2
0aee5c23d4 Add a note to the git_pillar docs stating that GitPython is the only currently supported provider
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22907\fP: (\fI\%techhat\fP) Properly merge cloud configs to create profiles
@ \fI2015\-04\-21 22:02:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
31c461f573 Merge pull request \fI\%#22907\fP from techhat/cloudconfig
.IP \(bu 2
3bf4e66112 Properly merge cloud configs to create profiles
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22782\fP: (\fI\%0xf10e\fP) Turning everything into OrderedDicts broke states.keystone.user_present() (refs: \fI\%#22894\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22894\fP: (\fI\%0xf10e\fP) Fix issue \fI\%#22782\fP
@ \fI2015\-04\-21 18:55:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
f0939754a0 Merge pull request \fI\%#22894\fP from 0xf10e/2014.7
.IP \(bu 2
58fa24c7fa Clarify doc on kwarg \(aqroles\(aq for user_present().
.IP \(bu 2
f0ae2eb84f Improve readability by renaming tenant_role
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#12003\fP: (\fI\%MarkusMuellerAU\fP) [state.dockerio] docker.run TypeError: run() argument after ** must be a mapping, not str (refs: \fI\%#22902\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22902\fP: (\fI\%rallytime\fP) Change state example to use proper kwarg
@ \fI2015\-04\-21 18:50:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
c802ba7514 Merge pull request \fI\%#22902\fP from rallytime/docker_doc_fix
.IP \(bu 2
8f703461b0 Change state example to use proper kwarg
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22898\fP: (\fI\%terminalmage\fP) dockerio: better error message for native exec driver
@ \fI2015\-04\-21 18:02:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
81771a7769 Merge pull request \fI\%#22898\fP from terminalmage/issue12003
.IP \(bu 2
c375309434 dockerio: better error message for native exec driver
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22825\fP: (\fI\%paolodina\fP) Issue using file.replace in state file (refs: \fI\%#22897\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22897\fP: (\fI\%rallytime\fP) Add param documentation for file.replace state
@ \fI2015\-04\-21 17:31:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
e2ec4ecc55 Merge pull request \fI\%#22897\fP from rallytime/fix\-22825
.IP \(bu 2
9c51630002 Add param documentation for file.replace state
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt#22844\fP: (\fI\%bersace\fP) LocalClient file cache confuse pillar and state files (refs: \fI\%#22850\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22850\fP: (\fI\%bersace\fP) Fix pillar and salt fileserver mixed
@ \fI2015\-04\-21 17:04:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
fd53889f0e Merge pull request \fI\%#22850\fP from bersace/fix\-pillar\-salt\-mixed
.IP \(bu 2
31b98e72eb Initialize state file client after pillar loading
.IP \(bu 2
f6bebb7a31 Use saltenv
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22818\fP: (\fI\%twangboy\fP) Added documentation regarding pip in windows
@ \fI2015\-04\-21 03:58:59 UTC\fP
.INDENT 2.0
.IP \(bu 2
1380fec1b9 Merge pull request \fI\%#22818\fP from twangboy/upd_pip_docs
.IP \(bu 2
cb999c7d70 Update pip.py
.IP \(bu 2
3cc5c970ad Added documentation regarding pip in windows
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22872\fP: (\fI\%rallytime\fP) Prevent stacktrace on os.path.exists in hosts module
@ \fI2015\-04\-21 02:54:40 UTC\fP
.INDENT 2.0
.IP \(bu 2
b2bf17f5d5 Merge pull request \fI\%#22872\fP from rallytime/fix_hosts_stacktrace
.IP \(bu 2
c88a1ea243 Prevent stacktrace on os.path.exists in hosts module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22853\fP: (\fI\%s0undt3ch\fP) Don\(aqt assume package installation order.
@ \fI2015\-04\-21 02:42:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
03af523de9 Merge pull request \fI\%#22853\fP from s0undt3ch/2014.7
.IP \(bu 2
b62df62151 Don\(aqt assume package installation order.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22877\fP: (\fI\%s0undt3ch\fP) Don\(aqt fail on \fImake clean\fP just because the directory does not exist
@ \fI2015\-04\-21 02:40:47 UTC\fP
.INDENT 2.0
.IP \(bu 2
9211e36564 Merge pull request \fI\%#22877\fP from s0undt3ch/hotfix/clean\-docs\-fix
.IP \(bu 2
95d6887949 Don\(aqt fail on \fImake clean\fP just because the directory does not exist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22873\fP: (\fI\%thatch45\fP) Type check the version since it will often be numeric
@ \fI2015\-04\-21 02:38:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
5bdbd08bbd Merge pull request \fI\%#22873\fP from thatch45/type_check
.IP \(bu 2
53b8376626 Type check the version since it will often be numeric
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22870\fP: (\fI\%twangboy\fP) Added ability to send a version with a space in it
@ \fI2015\-04\-20 23:18:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
c965b0a035 Merge pull request \fI\%#22870\fP from twangboy/fix_installer_again
.IP \(bu 2
3f180cfaae Added ability to send a version with a space in it
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22863\fP: (\fI\%rallytime\fP) Backport \fI\%#20974\fP to 2014.7
@ \fI2015\-04\-20 19:29:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#20974\fP: (\fI\%JohannesEbke\fP) Fix expr_match usage in salt.utils.check_whitelist_blacklist (refs: \fI\%#22863\fP)
.IP \(bu 2
2973eb18bc Merge pull request \fI\%#22863\fP from rallytime/bp\-20974
.IP \(bu 2
14913a4cb4 Fix expr_match usage in salt.utils.check_whitelist_blacklist
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22578\fP: (\fI\%hvnsweeting\fP) gracefully handle when salt\-minion cannot decrypt key
@ \fI2015\-04\-20 15:24:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
c45b92bb4b Merge pull request \fI\%#22578\fP from hvnsweeting/2014\-7\-fix\-compile\-pillar
.IP \(bu 2
f75b24ad68 gracefully handle when salt\-minion cannot decrypt key
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21979\fP: (\fI\%yrdevops\fP) gitfs: error message not descriptive enough when libgit2 was compiled without libssh2 (refs: \fI\%#22800\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22800\fP: (\fI\%terminalmage\fP) Improve error logging for pygit2 SSH\-based remotes
@ \fI2015\-04\-18 17:18:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
900c7a510f Merge pull request \fI\%#22800\fP from terminalmage/issue21979
.IP \(bu 2
8f1c0084cd Clarify that for pygit2, receiving 0 objects means repo is up\-to\-date
.IP \(bu 2
98885f71d6 Add information about libssh2 requirement for pygit2 ssh auth
.IP \(bu 2
09468d2607 Fix incorrect log message
.IP \(bu 2
2093bf8d96 Adjust loglevels for gitfs errors
.IP \(bu 2
9d394dfe46 Improve error logging for pygit2 SSH\-based remotes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22813\fP: (\fI\%twangboy\fP) Updated instructions for building salt
@ \fI2015\-04\-18 04:10:07 UTC\fP
.INDENT 2.0
.IP \(bu 2
e99f2fdb28 Merge pull request \fI\%#22813\fP from twangboy/win_doc_fix
.IP \(bu 2
adc421acdd Fixed some formatting issues
.IP \(bu 2
8901b3b5a6 Updated instructions for building salt
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22708\fP: (\fI\%Bilge\fP) salt\-ssh file.accumulated error: NameError: global name \(aqmsgpack\(aq is not defined (refs: \fI\%#22810\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22810\fP: (\fI\%basepi\fP) [2014.7] More msgpack gating for salt\-ssh
@ \fI2015\-04\-17 22:28:24 UTC\fP
.INDENT 2.0
.IP \(bu 2
fe1de89ad7 Merge pull request \fI\%#22810\fP from basepi/salt\-ssh.more.msgpack.gating
.IP \(bu 2
d4da8e66a4 Gate msgpack in salt/modules/saltutil.py
.IP \(bu 2
02303b22ce Gate msgpack in salt/modules/data.py
.IP \(bu 2
d7e8741f02 Gate salt.states.file.py msgpack
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#17144\fP: (\fI\%xpender\fP) salt\-cloud \-m fails with softlayer (refs: \fI\%#22803\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22803\fP: (\fI\%rallytime\fP) Allow map file to work with softlayer
@ \fI2015\-04\-17 20:34:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
11df71e16d Merge pull request \fI\%#22803\fP from rallytime/fix\-17144
.IP \(bu 2
ce88b6ad41 Allow map file to work with softlayer
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22807\fP: (\fI\%rallytime\fP) Add 2014.7.5 links to windows installation docs
@ \fI2015\-04\-17 20:32:13 UTC\fP
.INDENT 2.0
.IP \(bu 2
cd43a95212 Merge pull request \fI\%#22807\fP from rallytime/windows_docs_update
.IP \(bu 2
5931a582d1 Replace all 4s with 5s
.IP \(bu 2
eadaead755 Add 2014.7.5 links to windows installation docs
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22795\fP: (\fI\%rallytime\fP) Added release note for 2014.7.5 release
@ \fI2015\-04\-17 18:05:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
0b295e2c87 Merge pull request \fI\%#22795\fP from rallytime/release_notes
.IP \(bu 2
fde1feed46 Remove extra line
.IP \(bu 2
b19b95d992 Added release note for 2014.7.5 release
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22740\fP: (\fI\%lorengordon\fP) New Windows installer assumes salt is installed to the current directory (refs: \fI\%#22759\fP)
.IP \(bu 2
\fBPR\fP \fI\%#22759\fP: (\fI\%twangboy\fP) Final edits to the batch files for running salt
@ \fI2015\-04\-17 04:31:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#22754\fP: (\fI\%twangboy\fP) Removed redundant \e\e and \(dq (refs: \fI\%#22759\fP)
.IP \(bu 2
3c91459de2 Merge pull request \fI\%#22759\fP from twangboy/fix_bat_one_last_time
.IP \(bu 2
075f82e046 Final edits to the batch files for running salt
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22760\fP: (\fI\%thatch45\fP) Fix issues with the syndic
@ \fI2015\-04\-17 04:30:48 UTC\fP
.INDENT 2.0
.IP \(bu 2
20d3f2bb83 Merge pull request \fI\%#22760\fP from thatch45/syndic_fix
.IP \(bu 2
e2db624b37 Fix issues with the syndic not resolving the master when the interface is set
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#22762\fP: (\fI\%twangboy\fP) Fixed version not showing in Add/Remove Programs
@ \fI2015\-04\-17 04:29:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
54c45845ab Merge pull request \fI\%#22762\fP from twangboy/fix_installer
.IP \(bu 2
4d25af8acf Fixed version not showing in Add/Remove Programs
.UNINDENT
.UNINDENT
.SS Salt 2014.7.7 Release Notes
.INDENT 0.0
.TP
.B release
2015\-10\-13
.UNINDENT
.sp
Version 2014.7.7 is a bugfix release for \fI\%2014.7.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB54\fP
.IP \(bu 2
Total Issue References: \fB20\fP
.IP \(bu 2
Total PR References: \fB60\fP
.IP \(bu 2
Contributors: \fB28\fP (\fI\%AkhterAli\fP, \fI\%BretFisher\fP, \fI\%MrCitron\fP, \fI\%alekti\fP, \fI\%basepi\fP, \fI\%bersace\fP,
\fI\%cachedout\fP, \fI\%corux\fP, \fI\%cro\fP, \fI\%davidjb\fP, \fI\%dumol\fP, \fI\%efficks\fP, \fI\%garethgreenaway\fP,
\fI\%hvnsweeting\fP, \fI\%jacksontj\fP, \fI\%jacobhammons\fP, \fI\%jaybocc2\fP, \fI\%jfindlay\fP, \fI\%jquast\fP, \fI\%justinta\fP,
\fI\%msteed\fP, \fI\%nmadhok\fP, \fI\%notpeter\fP, \fI\%puneetk\fP, \fI\%rallytime\fP, \fI\%techhat\fP, \fI\%trevor\-h\fP,
\fI\%twangboy\fP)
.UNINDENT
.SS Changelog for v2014.7.6..v2014.7.7
.sp
\fIGenerated at: 2018\-05\-27 20:45:04 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#27335\fP: (\fI\%rallytime\fP) [2014.7] Fixup salt\-cloud logging
@ \fI2015\-09\-24 20:33:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
5262f01325 Merge pull request \fI\%#27335\fP from rallytime/cloud\-logging\-7
.IP \(bu 2
adeb1dcad4 Pylint Fix
.IP \(bu 2
588c13783c Salt\-cloud logging clean up for windows functions
.IP \(bu 2
9b6000135c [2014.7] Fixup salt\-cloud logging
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27252\fP: (\fI\%jfindlay\fP) 2014.7 \-> 2014.7.0
@ \fI2015\-09\-18 23:44:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
e90412d3b8 Merge pull request \fI\%#27252\fP from jfindlay/version.2014.7
.IP \(bu 2
3d28307a00 2014.7 \-> 2014.7.0
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27117\fP: (\fI\%jacobhammons\fP) made 2014.7 an archived release
@ \fI2015\-09\-15 07:35:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
c186e51764 Merge pull request \fI\%#27117\fP from jacobhammons/release\-docs\-2014.7
.IP \(bu 2
b69e11e0a4 made 2014.7 an archived release minor doc site updates
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27114\fP: (\fI\%cachedout\fP) Issue warning that some log levels may contain sensitive data
@ \fI2015\-09\-15 07:30:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
69d758ee2b Merge pull request \fI\%#27114\fP from cachedout/warn_on_insecure_log
.IP \(bu 2
507fb04683 Issue warning that some log levels may contain sensitive data
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27075\fP: (\fI\%twangboy\fP) Replaced password with redacted when displayed
@ \fI2015\-09\-14 18:36:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
aa71bae8aa Merge pull request \fI\%#27075\fP from twangboy/fix_password_2014.7
.IP \(bu 2
c0689e3215 Replaced password with redacted when displayed
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26656\fP: (\fI\%ari\fP) [documentation] error in example for salt.runner.pillar (refs: \fI\%#26667\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26667\fP: (\fI\%nmadhok\fP) [doc\-fix] Removing special character from salt.runners.pillar and other changes
@ \fI2015\-08\-26 18:24:37 UTC\fP
.INDENT 2.0
.IP \(bu 2
c2c7fe06c8 Merge pull request \fI\%#26667\fP from nmadhok/doc\-fix\-2014.7
.IP \(bu 2
26be189689 Doc fix. Fixes \fI\%#26656\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26663\fP: (\fI\%jacobhammons\fP) version change for latest branch
@ \fI2015\-08\-26 14:03:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
6bd3dccae8 Merge pull request \fI\%#26663\fP from jacobhammons/2014.7\-version
.IP \(bu 2
b6af538070 version change for latest branch
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26636\fP: (\fI\%rallytime\fP) Refactor cloud provider tests to be more accurate
@ \fI2015\-08\-25 21:28:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
071a6112e5 Merge pull request \fI\%#26636\fP from rallytime/cloud\-test\-fixes
.IP \(bu 2
c0d83d558d Don\(aqt use id as variable
.IP \(bu 2
2b4bc1679d Keep ec2 instance creation test the same \- it works better for the ec2 output
.IP \(bu 2
b5b58eb31f Skip digital ocean tests since we can\(aqt use API v1 with v2 tests
.IP \(bu 2
9ae1539c62 Update cloud tests to be more efficient and accurate
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#26630\fP: (\fI\%efficks\fP) win_service: Function has_powershell does not works on Windows XP (refs: \fI\%#26640\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26640\fP: (\fI\%efficks\fP) Fix function spacing
@ \fI2015\-08\-25 20:01:39 UTC\fP
.INDENT 2.0
.IP \(bu 2
304542b4c6 Merge pull request \fI\%#26640\fP from efficks/fixws2014
.IP \(bu 2
ebe5d9d85c Fix function spacing
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26515\fP: (\fI\%bersace\fP) Defaults to current saltenv in state.sls
@ \fI2015\-08\-25 16:35:50 UTC\fP
.INDENT 2.0
.IP \(bu 2
4532f98a76 Merge pull request \fI\%#26515\fP from bersace/salt\-env\-local\-sls
.IP \(bu 2
0727af9e3d Defaults to current saltenv in state.sls
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26242\fP: (\fI\%cro\fP) Remove dead code
@ \fI2015\-08\-12 15:14:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
da8bca09aa Merge pull request \fI\%#26242\fP from cro/anonldap4
.IP \(bu 2
a0d2ab1eed Remove dead code
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26216\fP: (\fI\%cro\fP) Fix LDAP configuration issue.
@ \fI2015\-08\-11 18:33:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
1ecf23773e Merge pull request \fI\%#26216\fP from cro/anonldap3
.IP \(bu 2
af132d7b89 Documentation update for anonymous bind issue.
.IP \(bu 2
2ef54b6b13 Documentation update for anonymous bind issue.
.IP \(bu 2
5b1836bb00 Fix issue with LDAP anonymous binds.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#26116\fP: (\fI\%corux\fP) file.replace fails if repl string is an invalid regex and append/prepend is used
@ \fI2015\-08\-10 16:44:12 UTC\fP
.INDENT 2.0
.IP \(bu 2
abdf2935c4 Merge pull request \fI\%#26116\fP from corux/fix\-escape\-content
.IP \(bu 2
fd913ddc36 Append/prepend: search for full line with escaped content
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25751\fP: (\fI\%basepi\fP) Document \fImaster_finger\fP more prominently (refs: \fI\%#26088\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26088\fP: (\fI\%jacobhammons\fP) Master finger
@ \fI2015\-08\-07 14:31:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
106356d98d Merge pull request \fI\%#26088\fP from jacobhammons/master\-finger
.IP \(bu 2
133d5f7885 some small changes
.IP \(bu 2
d220c83f77 master_finger configuration docs switch a script to use \fI\%https://\fP instead of \fI\%http://\fP Refs \fI\%#25751\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25961\fP: (\fI\%getabc\fP) [2015.5.3\-2] salt\-winrepo.git/salt\-minion.sls fails certificate \(aq*.wpengine.com\(aq or \(aqwpengine.com\(aq (refs: \fI\%#26047\fP)
.IP \(bu 2
\fBPR\fP \fI\%#26047\fP: (\fI\%jacobhammons\fP) Updated windows download links in the docs to \fI\%https://repo.saltstack.com\fP
@ \fI2015\-08\-05 22:59:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
4bd4bc41f2 Merge pull request \fI\%#26047\fP from jacobhammons/win\-downloads
.IP \(bu 2
7c162d181c Updated windows download links in the docs to \fI\%https://repo.saltstack.com\fP Refs \fI\%#25961\fP
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#25701\fP: (\fI\%alekti\fP) Issue \fI\%#23764\fP regression (refs: \fI\%#25750\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#23764\fP: (\fI\%es1o\fP) source_hash from local file is not supported. (refs: \fI\%#25750\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25750\fP: (\fI\%alekti\fP) Add file as supported protocol for file source_hash. Fixes \fI\%#25701\fP\&.
@ \fI2015\-07\-29 02:31:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
d93eb87c16 Merge pull request \fI\%#25750\fP from alekti/2014.7
.IP \(bu 2
9ec3ae96d4 Add file as supported protocol for file source_hash. Fixes \fI\%#23764\fP\&.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25704\fP: (\fI\%cachedout\fP) Ensure prior alignment with master_type in 2014.7
@ \fI2015\-07\-27 16:06:35 UTC\fP
.INDENT 2.0
.IP \(bu 2
3a15df22ac Merge pull request \fI\%#25704\fP from cachedout/master_type_2014_7
.IP \(bu 2
c95886c9a7 Ensure prior alignment with master_type in 2014.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25657\fP: (\fI\%MrCitron\fP) Add the ability to specify a base pattern for carbon returner
@ \fI2015\-07\-24 16:32:58 UTC\fP
.INDENT 2.0
.IP \(bu 2
d1b9362a73 Merge pull request \fI\%#25657\fP from MrCitron/pattern\-carbon\-returner\-2014.7
.IP \(bu 2
f8b2f8079f Add the ability to specify a base pattern for metrics path used by the carbon returner
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25633\fP: (\fI\%AkhterAli\fP) Update loader.py
@ \fI2015\-07\-22 20:02:41 UTC\fP
.INDENT 2.0
.IP \(bu 2
9634351fc2 Merge pull request \fI\%#25633\fP from AkhterAli/2014.7
.IP \(bu 2
29be4bbe11 Update loader.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25416\fP: (\fI\%cachedout\fP) Fix broken keyword
@ \fI2015\-07\-14 19:47:10 UTC\fP
.INDENT 2.0
.IP \(bu 2
09ebaceca8 Merge pull request \fI\%#25416\fP from cachedout/str_2014_7
.IP \(bu 2
cc514938a8 Fix broken keyword
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25375\fP: (\fI\%cachedout\fP) Fix error in config.py for master_type
@ \fI2015\-07\-13 16:49:27 UTC\fP
.INDENT 2.0
.IP \(bu 2
2a1dd1113f Merge pull request \fI\%#25375\fP from cachedout/config_fix_2014_7
.IP \(bu 2
c041f2905f Fix error in config.py for master_type
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25324\fP: (\fI\%jacobhammons\fP) Latest help theme updates
@ \fI2015\-07\-10 16:11:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
2590e23d48 Merge pull request \fI\%#25324\fP from jacobhammons/doc\-theme\-updates
.IP \(bu 2
88f5fcf58d Latest help theme updates
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#18447\fP: (\fI\%ryan\-lane\fP) Can\(aqt install salt with raet using pip \-e git (refs: \fI\%#25093\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25093\fP: (\fI\%jaybocc2\fP) quick fix for issue \fI\%#18447\fP
@ \fI2015\-07\-01 15:56:53 UTC\fP
.INDENT 2.0
.IP \(bu 2
36d53ef59e Merge pull request \fI\%#25093\fP from jaybocc2/2014.7
.IP \(bu 2
c6a501ebda quick fix for issue \fI\%#18447\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#25069\fP: (\fI\%puneetk\fP) Add a helper module function called list_enabled
@ \fI2015\-06\-30 20:53:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
38903a94a1 Merge pull request \fI\%#25069\fP from puneetk/patch\-1
.IP \(bu 2
f0b4e600e6 Update Documentation to clarify version added
.IP \(bu 2
f8dc6030e7 Pylint updates , removing whitespace
.IP \(bu 2
532d315dd1 [Code Review update] renamed function to is_enaled from list_enabled
.IP \(bu 2
20b0462289 Update schedule.py
.IP \(bu 2
4f1471d7fb Add a helper module function called list_enabled
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#15209\fP: (\fI\%hubez\fP) file.manage: source_hash not working with s3:// (2014.7.0rc1) (refs: \fI\%#25011\fP)
.IP \(bu 2
\fBPR\fP \fI\%#25011\fP: (\fI\%notpeter\fP) Add s3 to protocols for remote source_hash (2014.7 backport)
@ \fI2015\-06\-27 22:35:44 UTC\fP
.INDENT 2.0
.IP \(bu 2
a7154e7471 Merge pull request \fI\%#25011\fP from notpeter/s3_2014.7_backport
.IP \(bu 2
8b8af640f6 Add s3 to protocols for remote source_hash
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24915\fP: (\fI\%justinta\fP) Salt\-cloud not working in 2014.7.6 (refs: \fI\%#24944\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24944\fP: (\fI\%techhat\fP) Double\-check main_cloud_config
@ \fI2015\-06\-25 12:29:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
a11e4c6eea Merge pull request \fI\%#24944\fP from techhat/issue24915
.IP \(bu 2
59c3081e49 Double\-check main_cloud_config
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24936\fP: (\fI\%justinta\fP) Fixed ps module to not use depreciated psutil commands
@ \fI2015\-06\-24 22:38:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
d26a5447ba Merge pull request \fI\%#24936\fP from jtand/psutil
.IP \(bu 2
bdb7a19c36 Fixed ps module to not use depreciated psutil commands
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%saltstack/salt\-bootstrap#473\fP: (\fI\%s1kbr0\fP) salt\-bootstrap.sh [...] git v2014.1.11 on SmartOS base64 is broken (refs: \fI\%#24918\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24918\fP: (\fI\%BretFisher\fP) SmartOS SMF minion startup fix
@ \fI2015\-06\-24 15:44:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
eeb05a1b10 Merge pull request \fI\%#24918\fP from BretFisher/minion\-start\-smartos\-smf\-fix
.IP \(bu 2
d7bfb0c7fd Smartos smf minion fix
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24776\fP: (\fI\%nmadhok\fP) \-\-static option in salt raises ValueError and has been broken for a very long time (refs: \fI\%#24777\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24780\fP: (\fI\%nmadhok\fP) Backporting PR \fI\%#24777\fP to 2014.7 branch
@ \fI2015\-06\-18 14:52:56 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24779\fP: (\fI\%nmadhok\fP) Backporting Changes to 2014.7 branch (refs: \fI\%#24777\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24778\fP: (\fI\%nmadhok\fP) Backporting PR \fI\%#24777\fP to 2015.2 branch (refs: \fI\%#24777\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24777\fP: (\fI\%nmadhok\fP) Fixing issue where \-\-static option fails with ValueError Fixes \fI\%#24776\fP (refs: \fI\%#24778\fP, \fI\%#24780\fP)
.IP \(bu 2
4281dfff0b Merge pull request \fI\%#24780\fP from nmadhok/backport\-2014.7\-24777
.IP \(bu 2
c53b0d9a22 Backporting PR \fI\%#24777\fP to 2014.7 branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#21318\fP: (\fI\%thanatos\fP) get_full_returns raises KeyError (refs: \fI\%#24769\fP)
.IP \(bu 2
\fBISSUE\fP \fI\%#18994\fP: (\fI\%njhartwell\fP) salt.client.get_cli_returns errors when called immediately after run_job (refs: \fI\%#24769\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24769\fP: (\fI\%msteed\fP) Fix stacktrace in get_cli_returns()
@ \fI2015\-06\-18 14:31:46 UTC\fP
.INDENT 2.0
.IP \(bu 2
f3c5cb2d41 Merge pull request \fI\%#24769\fP from msteed/issue\-21318
.IP \(bu 2
f40a9d5cc0 Fix stacktrace in get_cli_returns()
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#17041\fP: (\fI\%xenophonf\fP) Confusing Salt error messages due to limited/incomplete PowerShell command error handling (refs: \fI\%#24690\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24690\fP: (\fI\%twangboy\fP) Report powershell output instead of error
@ \fI2015\-06\-17 16:33:49 UTC\fP
.INDENT 2.0
.IP \(bu 2
59db24602f Merge pull request \fI\%#24690\fP from twangboy/fix_17041
.IP \(bu 2
7a015389af Added additional reporting
.IP \(bu 2
d84ad5d519 Fixed capitalization... Failed and Already
.IP \(bu 2
e9552455c4 Merge branch \(aq2014.7\(aq of \fI\%https://github.com/saltstack/salt\fP into fix_17041
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24196\fP: (\fI\%johnccfm\fP) Exception when using user.present with Windows (refs: \fI\%#24646\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24646\fP: (\fI\%twangboy\fP) Fixed user.present on existing user
@ \fI2015\-06\-15 15:04:43 UTC\fP
.INDENT 2.0
.IP \(bu 2
a18dadad71 Merge pull request \fI\%#24646\fP from twangboy/fix_24196
.IP \(bu 2
a208e1d60f Fixed user.present on existing user
.IP \(bu 2
144bff2f67 Report powershell output instead of error
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24643\fP: (\fI\%cro\fP) Add reference to salt\-announce mailing list
@ \fI2015\-06\-12 20:21:15 UTC\fP
.INDENT 2.0
.IP \(bu 2
b99484fde2 Merge pull request \fI\%#24643\fP from cro/saltannounce
.IP \(bu 2
ecb0623d7f Add salt\-announce mailing list.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24620\fP: (\fI\%twangboy\fP) Fixed comment and uncomment functions in file.py
@ \fI2015\-06\-12 19:36:26 UTC\fP
.INDENT 2.0
.IP \(bu 2
635121e85d Merge pull request \fI\%#24620\fP from twangboy/fix_24215
.IP \(bu 2
d7a9999be1 Fixed comment and uncomment functions in file.py
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24589\fP: (\fI\%BretFisher\fP) Fixed Mine example for jinja code block
@ \fI2015\-06\-11 15:48:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
d83928a7f9 Merge pull request \fI\%#24589\fP from BretFisher/patch\-1
.IP \(bu 2
65a11336dc Fixed Mine example for jinja code block
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24427\fP: (\fI\%fayetted\fP) 2015.5.1\-3 Windows 64Bit Minion fails to start after install (refs: \fI\%#24530\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24530\fP: (\fI\%twangboy\fP) Start Minion Service on Silent Install
@ \fI2015\-06\-09 21:30:08 UTC\fP
.INDENT 2.0
.IP \(bu 2
d376390f76 Merge pull request \fI\%#24530\fP from twangboy/fix_24427
.IP \(bu 2
673e1d809e Added missing panel.bmp for installer
.IP \(bu 2
cc50218b01 Start Minion Service on Silent Install
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24513\fP: (\fI\%jquast\fP) bugfix use of \(aqiteritem\(aq in 2014.7 branch
@ \fI2015\-06\-09 04:06:36 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24511\fP: (\fI\%jquast\fP) bugfix: trailing \(dq...done\(dq in rabbitmq output (refs: \fI\%#24513\fP)
.IP \(bu 2
6ebc476bb3 Merge pull request \fI\%#24513\fP from jquast/2014.7\-bugfix\-iteritem
.IP \(bu 2
2be0180e5e bugfix use of \(aqiteritem\(aq in 2014.7 branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24276\fP: (\fI\%markuskramerIgitt\fP) Live salt\-master Profiling with SIGUSR2 fails  (refs: \fI\%#24405\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24405\fP: (\fI\%jacksontj\fP) Fix for \fI\%#24276\fP
@ \fI2015\-06\-04 20:50:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
83f853b6ea Merge pull request \fI\%#24405\fP from jacksontj/2014.7
.IP \(bu 2
2c7afaeebf Fix for \fI\%#24276\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24395\fP: (\fI\%hvnsweeting\fP) handle exceptions when received data is not in good shape
@ \fI2015\-06\-04 20:08:22 UTC\fP
.INDENT 2.0
.IP \(bu 2
cef919c602 Merge pull request \fI\%#24395\fP from hvnsweeting/handle\-exception\-get\-file
.IP \(bu 2
bb798a0224 handle exceptions when received data is not in good shape
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24305\fP: (\fI\%twangboy\fP) Added documentation, fixed formatting
@ \fI2015\-06\-04 19:40:54 UTC\fP
.INDENT 2.0
.IP \(bu 2
efba1a94b4 Merge pull request \fI\%#24305\fP from twangboy/win_path_docs
.IP \(bu 2
36804253e6 Fixed pylint error caused by P... added r
.IP \(bu 2
bc42a4bb11 triple double quotes to triple single quotes
.IP \(bu 2
77cd930bba Added documentation, fixed formatting
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24178\fP: (\fI\%rallytime\fP) Backport \fI\%#24118\fP to 2014.7, too.
@ \fI2015\-05\-27 17:49:45 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#24118\fP: (\fI\%trevor\-h\fP) removed deprecated pymongo usage (refs: \fI\%#24178\fP)
.IP \(bu 2
9d7331c87d Merge pull request \fI\%#24178\fP from rallytime/bp\-24118
.IP \(bu 2
e2217a09e8 removed deprecated pymongo usage as no longer functional with pymongo > 3.x
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24159\fP: (\fI\%rallytime\fP) Fill out modules/keystone.py CLI Examples
@ \fI2015\-05\-27 15:07:11 UTC\fP
.INDENT 2.0
.IP \(bu 2
4e8c5031b0 Merge pull request \fI\%#24159\fP from rallytime/keystone_doc_examples
.IP \(bu 2
dadac8d076 Fill out modules/keystone.py CLI Examples
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24158\fP: (\fI\%rallytime\fP) Fix test_valid_docs test for tls module
@ \fI2015\-05\-27 15:06:05 UTC\fP
.INDENT 2.0
.IP \(bu 2
fc10ee8ed5 Merge pull request \fI\%#24158\fP from rallytime/fix_doc_error
.IP \(bu 2
49a517e2ca Fix test_valid_docs test for tls module
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24125\fP: (\fI\%hvnsweeting\fP) Fix rabbitmq test mode
@ \fI2015\-05\-26 15:40:18 UTC\fP
.INDENT 2.0
.IP \(bu 2
c0d32e0b5e Merge pull request \fI\%#24125\fP from hvnsweeting/fix\-rabbitmq\-test\-mode
.IP \(bu 2
71862c69b9 enhance log
.IP \(bu 2
28e2594162 change according to new output of rabbitmq module functions
.IP \(bu 2
cd0212e8ed processes and returns better output for rabbitmq module
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23464\fP: (\fI\%tibold\fP) cmd_iter_no_block() blocks (refs: \fI\%#24093\fP)
.IP \(bu 2
\fBPR\fP \fI\%#24093\fP: (\fI\%msteed\fP) Make LocalClient.cmd_iter_no_block() not block
@ \fI2015\-05\-25 15:56:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
39a8f30f06 Merge pull request \fI\%#24093\fP from msteed/issue\-23464
.IP \(bu 2
fd35903d75 Fix failing test
.IP \(bu 2
41b344c7d3 Make LocalClient.cmd_iter_no_block() not block
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#24008\fP: (\fI\%davidjb\fP) Correct reST formatting for states.cmd documentation
@ \fI2015\-05\-21 04:19:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
5bffd3045e Merge pull request \fI\%#24008\fP from davidjb/2014.7
.IP \(bu 2
8b8d0293d4 Correct reST formatting for documentation
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23933\fP: (\fI\%jacobhammons\fP) sphinx saltstack2 doc theme
@ \fI2015\-05\-20 18:19:19 UTC\fP
.INDENT 2.0
.IP \(bu 2
1aa0420040 Merge pull request \fI\%#23933\fP from jacobhammons/2014.7
.IP \(bu 2
a3613e68e4 removed numbering from doc TOC
.IP \(bu 2
78b737c5e6 removed 2015.* release from release notes, updated index page to remove PDF/epub links
.IP \(bu 2
e867f7df77 Changed build settings to use saltstack2 theme and update release versions.
.IP \(bu 2
81ed9c9f59 sphinx saltstack2 doc theme
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23965\fP: (\fI\%hvnsweeting\fP) handle all exceptions gitpython can raise
@ \fI2015\-05\-20 15:08:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
314e4db512 Merge pull request \fI\%#23965\fP from hvnsweeting/20147\-fix\-gitfs\-gitpython\-exception
.IP \(bu 2
2576301631 handle all exception gitpython can raise
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23939\fP: (\fI\%basepi\fP) Add extended changelog to 2014.7.6 release notes
@ \fI2015\-05\-19 21:21:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
913391207a Merge pull request \fI\%#23939\fP from basepi/v2014.7.6release
.IP \(bu 2
32b65dc2a9 Add extended changelog to 2014.7.6 release notes
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#23820\fP: (\fI\%UtahDave\fP) 2014.7.5 schedule error (refs: \fI\%#23881\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23881\fP: (\fI\%garethgreenaway\fP) Fixes to schedule module in 2014.7
@ \fI2015\-05\-19 15:46:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
0031ca2631 Merge pull request \fI\%#23881\fP from garethgreenaway/23820_2014_7_schedule_list_issue
.IP \(bu 2
b207f2a433 Missing continue in the list function when deleting unused attributes.
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#22131\fP: (\fI\%quixoten\fP) \(dqunexpected keyword argument \(aqmerge\(aq\(dq on 2014.7.2 (salt\-ssh) (refs: \fI\%#23887\fP)
.IP \(bu 2
\fBPR\fP \fI\%#23887\fP: (\fI\%basepi\fP) [2014.7] Bring salt\-ssh pillar.get in line with mainline pillar.get
@ \fI2015\-05\-18 23:11:34 UTC\fP
.INDENT 2.0
.IP \(bu 2
63bd21ecd2 Merge pull request \fI\%#23887\fP from basepi/salt\-ssh.pillar.get.22131
.IP \(bu 2
bc84502f46 Bring salt\-ssh pillar.get in line with mainline pillar.get
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23891\fP: (\fI\%basepi\fP) Update the release notes index page
@ \fI2015\-05\-18 23:06:52 UTC\fP
.INDENT 2.0
.IP \(bu 2
17c5810c04 Merge pull request \fI\%#23891\fP from basepi/releasenotes
.IP \(bu 2
dec153bcea Update the release notes index page
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23888\fP: (\fI\%basepi\fP) Update the 2014.7.6 release notes with CVE details
@ \fI2015\-05\-18 22:35:51 UTC\fP
.INDENT 2.0
.IP \(bu 2
a93e58f80f Merge pull request \fI\%#23888\fP from basepi/v2014.7.6release
.IP \(bu 2
49921b6cb2 Update the 2014.7.6 release notes with CVE details
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#23871\fP: (\fI\%rallytime\fP) Backport \fI\%#23848\fP to 2014.7
@ \fI2015\-05\-18 20:34:04 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#23848\fP: (\fI\%dumol\fP) Updated installation docs for SLES 12. (refs: \fI\%#23871\fP)
.IP \(bu 2
50730287bb Merge pull request \fI\%#23871\fP from rallytime/bp\-23848
.IP \(bu 2
379c09c3a5 Updated for SLES 12.
.UNINDENT
.UNINDENT
.SS Salt 2014.7.8 Release Notes
.INDENT 0.0
.TP
.B release
2015\-11\-13
.UNINDENT
.sp
Version 2014.7.8 is a bugfix release for \fI\%2014.7.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB7\fP
.IP \(bu 2
Total Issue References: \fB3\fP
.IP \(bu 2
Total PR References: \fB10\fP
.IP \(bu 2
Contributors: \fB5\fP (\fI\%DmitryKuzmenko\fP, \fI\%JaseFace\fP, \fI\%MasterNayru\fP, \fI\%cachedout\fP, \fI\%rallytime\fP)
.UNINDENT
.SS Changelog for v2014.7.7..v2014.7.8
.sp
\fIGenerated at: 2018\-05\-27 20:47:34 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#28839\fP: (\fI\%cachedout\fP) Revert \fI\%#28740\fP
@ \fI2015\-11\-12 22:54:28 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28740\fP: (\fI\%MasterNayru\fP) Add missing S3 module import (refs: \fI\%#28777\fP, \fI\%#28839\fP)
.IP \(bu 2
4b8bdd0afb Merge pull request \fI\%#28839\fP from cachedout/revert_28740
.IP \(bu 2
215b26c06f Revert \fI\%#28740\fP
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28777\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28740\fP to 2014.7
@ \fI2015\-11\-11 18:00:00 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28740\fP: (\fI\%MasterNayru\fP) Add missing S3 module import (refs: \fI\%#28777\fP, \fI\%#28839\fP)
.IP \(bu 2
76e69b4bff Merge pull request \fI\%#28777\fP from rallytime/bp\-28740\-2014.7
.IP \(bu 2
da5fac2b36 Back\-port \fI\%#28740\fP to 2014.7
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#28716\fP: (\fI\%rallytime\fP) Back\-port \fI\%#28705\fP to 2014.7
@ \fI2015\-11\-10 16:15:03 UTC\fP
.INDENT 2.0
.IP \(bu 2
\fBPR\fP \fI\%#28705\fP: (\fI\%cachedout\fP) Account for new headers class in tornado 4.3 (refs: \fI\%#28716\fP)
.IP \(bu 2
45c73ebf2f Merge pull request \fI\%#28716\fP from rallytime/bp\-28705
.IP \(bu 2
32e7bd3ea0 Account for new headers class in tornado 4.3
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28199\fP: (\fI\%felskrone\fP) Non\-standard umasks might break the master (refs: \fI\%#28717\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28717\fP: (\fI\%cachedout\fP) Add note about recommended umask
@ \fI2015\-11\-09 23:26:20 UTC\fP
.INDENT 2.0
.IP \(bu 2
f4fe921965 Merge pull request \fI\%#28717\fP from cachedout/umask_note
.IP \(bu 2
1874300e08 Add note about recommended umask
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#28455\fP: (\fI\%zmalone\fP) highstate.cache is world readable, and contains secrets (refs: \fI\%#28461\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28461\fP: (\fI\%cachedout\fP) Wrap all cache calls in state.sls in correct umask
@ \fI2015\-11\-02 17:11:02 UTC\fP
.INDENT 2.0
.IP \(bu 2
4bf56cad3f Merge pull request \fI\%#28461\fP from cachedout/issue_28455
.IP \(bu 2
097838ec0c Wrap all cache calls in state.sls in correct umask
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#24910\fP: (\fI\%bocig\fP) \-T, \-\-make\-token flag does NOT work\- LDAP Groups (refs: \fI\%#28407\fP)
.IP \(bu 2
\fBPR\fP \fI\%#28407\fP: (\fI\%DmitryKuzmenko\fP) Don\(aqt request creds if auth with key.
@ \fI2015\-10\-29 16:12:30 UTC\fP
.INDENT 2.0
.IP \(bu 2
f3e61db045 Merge pull request \fI\%#28407\fP from DSRCompany/issues/24910_token_auth_fix_2014
.IP \(bu 2
b7b5bec309 Don\(aqt request creds if auth with key.
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#27390\fP: (\fI\%JaseFace\fP) Ensure we pass on the enable setting if present, or use the default of True if not in build_schedule_item()
@ \fI2015\-10\-05 18:09:33 UTC\fP
.INDENT 2.0
.IP \(bu 2
d284eb165b Merge pull request \fI\%#27390\fP from JaseFace/schedule\-missing\-enabled
.IP \(bu 2
563db71bfd Ensure we pass on the enable setting if present, or use the default of True if not in build_schedule_item() Prior to this, when schedule.present compares the existing schedule to the one crafted by this function, enabled will actually be removed at each run.  schedule.present sees a modification needs to be made, and invokes schedule.modify, which does so with enabled: True, creating and endless loop of an \(aqenabled\(aq removal and addition.
.UNINDENT
.UNINDENT
.SS Salt 2014.7.9 Release Notes
.INDENT 0.0
.TP
.B release
2016\-03\-11
.UNINDENT
.sp
Version 2014.7.9 is a bugfix release for \fI\%2014.7.0\fP\&.
.SS Statistics
.INDENT 0.0
.IP \(bu 2
Total Merges: \fB5\fP
.IP \(bu 2
Total Issue References: \fB1\fP
.IP \(bu 2
Total PR References: \fB5\fP
.IP \(bu 2
Contributors: \fB4\fP (\fI\%douardda\fP, \fI\%gtmanfred\fP, \fI\%jacobhammons\fP, \fI\%jfindlay\fP)
.UNINDENT
.SS Changelog for v2014.7.8..v2014.7.9
.sp
\fIGenerated at: 2018\-05\-27 20:55:35 UTC\fP
.INDENT 0.0
.IP \(bu 2
\fBPR\fP \fI\%#31834\fP: (\fI\%jfindlay\fP) add 2014.7.8 release notes
@ \fI2016\-03\-11 21:35:42 UTC\fP
.INDENT 2.0
.IP \(bu 2
218c902091 Merge pull request \fI\%#31834\fP from jfindlay/2014.7
.IP \(bu 2
358fdad0c8 add 2014.7.8 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31833\fP: (\fI\%jfindlay\fP) add 2014.7.9 release notes
@ \fI2016\-03\-11 21:19:55 UTC\fP
.INDENT 2.0
.IP \(bu 2
a423c6cd04 Merge pull request \fI\%#31833\fP from jfindlay/2014.7
.IP \(bu 2
6910fcc584 add 2014.7.9 release notes
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#31826\fP: (\fI\%gtmanfred\fP) Remove ability of authenticating user to specify pam service
@ \fI2016\-03\-11 20:41:01 UTC\fP
.INDENT 2.0
.IP \(bu 2
c5e7c03953 Merge pull request \fI\%#31826\fP from gtmanfred/2014.7
.IP \(bu 2
d73f70ebb2 Remove ability of authenticating user to specify pam service
.UNINDENT
.IP \(bu 2
\fBPR\fP \fI\%#29392\fP: (\fI\%jacobhammons\fP) updated version number to not reference a specific build from the lat…
@ \fI2015\-12\-03 15:54:31 UTC\fP
.INDENT 2.0
.IP \(bu 2
85aa70a6cb Merge pull request \fI\%#29392\fP from jacobhammons/2014.7
.IP \(bu 2
d7f0db1dd8 updated version number to not reference a specific build from the latest branch
.UNINDENT
.IP \(bu 2
\fBISSUE\fP \fI\%#29295\fP: (\fI\%douardda\fP) systemd\(aqs service file should use the \(aqprocess\(aq KillMode option on Debian also (refs: \fI\%#29296\fP)
.IP \(bu 2
\fBPR\fP \fI\%#29296\fP: (\fI\%douardda\fP) Use process KillMode on Debian systems also
@ \fI2015\-12\-01 16:00:16 UTC\fP
.INDENT 2.0
.IP \(bu 2
d2fb2109a3 Merge pull request \fI\%#29296\fP from douardda/patch\-3
.IP \(bu 2
d2885390f4 Use process KillMode on Debian systems also
.UNINDENT
.UNINDENT
.SS Salt 2014.1.0 Release Notes \- Codename Hydrogen
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Due to a change in master to minion communication, 2014.1.0 minions are not
compatible with older\-version masters.  Please upgrade masters first.
More info on backwards\-compatibility policy \fI\%here\fP, under the \(dqUpgrading Salt\(dq subheading.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
A change in the grammar in the state compiler makes \fBmodule.run\fP in
requisites illegal syntax.  Its use is replaced simply with the word
\fBmodule\fP\&.  In other words you will need to change requisites like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
require:
    module.run: some_module_name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
to:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
require:
    module: some_module_name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is a breaking change.  We apologize for the inconvenience, we needed to
do this to remove some ambiguity in parsing requisites.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B release
2014\-02\-24
.UNINDENT
.sp
The 2014.1.0 release of Salt is a major release which not only increases
stability but also brings new capabilities in virtualization, cloud
integration, and more. This release brings a great focus on the expansion of
testing making roughly double the coverage in the Salt tests, and comes with
many new features.
.sp
2014.1.0 is the first release to follow the new date\-based release naming
system. See the \fI\%version numbers\fP
page for more details.
.SS Major Features
.SS Salt Cloud Merged into Salt
.sp
Salt Cloud is a tool for provisioning salted minions across various cloud
providers. Prior to this release, Salt Cloud was a separate project but this
marks its full integration with the Salt distribution. A Getting Started guide
and additional documentation for Salt Cloud can be found \fI\%here\fP:
.SS Google Compute Engine
.sp
Alongside Salt Cloud comes new support for the Google Compute Engine. Salt Stack
can now deploy and control GCE virtual machines and the application stacks that
they run.
.sp
For more information on Salt Stack and GCE, please see \fI\%this blog post\fP\&.
.sp
Documentation for Salt and GCE can be found \fI\%here\fP\&.
.SS Salt Virt
.sp
Salt Virt is a cloud controller that supports virtual machine deployment,
inspection, migration, and integration with many aspects of Salt.
.sp
Salt Virt has undergone a major overhaul with this release and now supports
many more features and includes a number of critical improvements.
.SS Docker Integration
.sp
Salt now ships with \fBstates\fP and an \fBexecution
module\fP to manage Docker containers.
.SS Substantial Testing Expansion
.sp
Salt continues to increase its unit/regression test coverage. This release
includes over 300 new tests.
.SS BSD Package Management
.sp
BSD package management has been entirely rewritten. FreeBSD 9 and older now
default to using pkg_add, while FreeBSD 10 and newer will use pkgng. FreeBSD 9
can be forced to use pkgng, however, by specifying the following option in the
minion config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
providers:
  pkg: pkgng
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In addition, support for installing software from the ports tree has been
added. See the documentation for the ports \fI\%state\fP and
\fI\%execution module\fP for more information.
.SS Network Management for Debian/Ubuntu
.sp
Initial support for management of network interfaces on Debian\-based distros
has been added. See the documentation for the \fI\%network state\fP and the \fI\%debian_ip\fP for
more information.
.SS IPv6 Support for iptables State/Module
.sp
The iptables \fI\%state\fP and \fI\%module\fP now have IPv6 support. A new parameter \fBfamily\fP has
been added to the states and execution functions, to distinguish between IPv4
and IPv6. The default value for this parameter is \fBipv4\fP, specifying \fBipv6\fP
will use ip6tables to manage firewall rules.
.SS GitFS Improvements
.sp
Several performance improvements have been made to the \fI\%Git fileserver
backend\fP\&. Additionally, file states can now use any
SHA1 commit hash as a fileserver environment:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/httpd/httpd.conf:
  file.managed:
    \- source: salt://webserver/files/httpd.conf
    \- saltenv: 45af879
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This applies to the functions in the \fI\%cp module\fP as
well:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cp.get_file salt://readme.txt /tmp/readme.txt saltenv=45af879
.ft P
.fi
.UNINDENT
.UNINDENT
.SS MinionFS
.sp
This new fileserver backend allows files which have been pushed from the minion
to the master (using \fI\%cp.push\fP) to be served up
from the salt fileserver. The path for these files takes the following format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt://minion\-id/path/to/file
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBminion\-id\fP is the id of the \(dqsource\(dq minion, the one from which the files
were pushed to the master. \fB/path/to/file\fP is the full path of the file.
.sp
The \fI\%MinionFS Walkthrough\fP contains a more
thorough example of how to use this backend.
.SS saltenv
.sp
To distinguish between fileserver environments and execution functions which
deal with environment variables, fileserver environments are now specified
using the \fBsaltenv\fP parameter. \fBenv\fP will continue to work, but is
deprecated and will be removed in a future release.
.SS Grains Caching
.sp
A caching layer has been added to the Grains system, which can help speed up
minion startup. Disabled by default, it can be enabled by setting the minion
config option \fBgrains_cache\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
grains_cache: True

# Seconds before grains cache is considered to be stale.
grains_cache_expiration: 300
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If set to \fBTrue\fP, the grains loader will read from/write to a
msgpack\-serialized file containing the grains data.
.sp
Additional command\-line parameters have been added to salt\-call, mainly for
testing purposes:
.INDENT 0.0
.IP \(bu 2
\fB\-\-skip\-grains\fP will completely bypass the grains loader when salt\-call is
invoked.
.IP \(bu 2
\fB\-\-refresh\-grains\-cache\fP will force the grains loader to bypass the grains
cache and refresh the grains, writing a new grains cache file.
.UNINDENT
.SS Improved Command Logging Control
.sp
When using the \fI\%cmd module\fP, either on the CLI or
when developing Salt execution modules, a new keyword argument
\fBoutput_loglevel\fP allows for greater control over how (or even if) the
command and its output are logged. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq cmd.run \(aqtail /var/log/messages\(aq output_loglevel=debug
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The package management modules (\fBapt\fP, \fByumpkg\fP, etc.) have been updated to
log the copious output generated from these commands at loglevel \fBdebug\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To keep a command from being logged, \fBoutput_loglevel=quiet\fP can be used.
.sp
Prior to this release, this could be done using \fBquiet=True\fP\&. This
argument is still supported, but will be removed in a future Salt release.
.UNINDENT
.UNINDENT
.SS PagerDuty Support
.sp
Initial support for firing events via \fI\%PagerDuty\fP has been added. See the
documentation for the \fI\%pagerduty\fP module.
.SS Virtual Terminal
.sp
Sometimes the subprocess module is not good enough, and, in fact, not even
\fBaskpass\fP is. This virtual terminal is still in its infant childhood, needs
quite some love, and was originally created to replace \fBaskpass\fP, but, while
developing it, it immediately proved that it could do so much more. It\(aqs
currently used by salt\-cloud when bootstrapping salt on clouds which require
the use of a password.
.SS Proxy Minions
.sp
Initial basic support for Proxy Minions is in this release. Documentation can
be found \fI\%here\fP\&.
.sp
Proxy minions are a developing feature in Salt that enables control of devices
that cannot run a minion. Examples include network gear like switches and
routers that run a proprietary OS but offer an API, or \(dqdumb\(dq devices that just
don\(aqt have the horsepower or ability to handle a Python VM.
.sp
Proxy minions can be difficult to write, so a simple REST\-based example proxy
is included. A Python bottle\-based webserver can be found at
\fI\%https://github.com/cro/salt\-proxy\-rest\fP as an endpoint for this proxy.
.sp
This is an ALPHA\-quality feature. There are a number of issues with it
currently, mostly centering around process control, logging, and inability to
work in a masterless configuration.
.SS Additional Bugfixes (Release Candidate Period)
.sp
Below are many of the fixes that were implemented in salt during the release
candidate phase.
.INDENT 0.0
.IP \(bu 2
Fix mount.mounted leaving conflicting entries in fstab (\fI\%issue 7079\fP)
.IP \(bu 2
Fix mysql returner serialization to use json (\fI\%issue 9590\fP)
.IP \(bu 2
Fix \fBZMQError: Operation cannot be accomplished in current state\fP errors (\fI\%issue 6306\fP)
.IP \(bu 2
Rbenv and ruby improvements
.IP \(bu 2
Fix quoting issues with mysql port (\fI\%issue 9568\fP)
.IP \(bu 2
Update mount module/state to support multiple swap partitions (\fI\%issue 9520\fP)
.IP \(bu 2
Fix \fBarchive\fP state to work with \fBbsdtar\fP
.IP \(bu 2
Clarify logs for minion ID caching
.IP \(bu 2
Add numeric revision support to git state (\fI\%issue 9718\fP)
.IP \(bu 2
Update \fBmaster_uri\fP with \fBmaster_ip\fP (\fI\%issue 9694\fP)
.IP \(bu 2
Add comment to Debian \fBmod_repo\fP (\fI\%issue 9923\fP)
.IP \(bu 2
Fix potential undefined loop variable in rabbitmq state (\fI\%issue 8703\fP)
.IP \(bu 2
Fix for salt\-virt runner to delete key on VM deletion
.IP \(bu 2
Fix for \fBsalt\-run \-d\fP to limit results to specific runner or function (\fI\%issue 9975\fP)
.IP \(bu 2
Add tracebacks to jinja renderer when applicable (\fI\%issue 10010\fP)
.IP \(bu 2
Fix parsing in monit module (\fI\%issue 10041\fP)
.IP \(bu 2
Fix highstate output from syndic minions (\fI\%issue 9732\fP)
.IP \(bu 2
Quiet logging when dealing with passwords/hashes (\fI\%issue 10000\fP)
.IP \(bu 2
Fix for multiple remotes in git_pillar (\fI\%issue 9932\fP)
.IP \(bu 2
Fix npm installed command (\fI\%issue 10109\fP)
.IP \(bu 2
Add safeguards for utf8 errors in zcbuildout module
.IP \(bu 2
Fix compound commands (\fI\%issue 9746\fP)
.IP \(bu 2
Add systemd notification when master is started
.IP \(bu 2
Many doc improvements
.UNINDENT
.SS Salt 2014.1.1 Release Notes
.INDENT 0.0
.TP
.B release
2014\-03\-18
.UNINDENT
.sp
Version 2014.1.1 is a bugfix release for \fI\%2014.1.0\fP\&.  The changes include:
.INDENT 0.0
.IP \(bu 2
Various doc fixes, including up\-to\-date Salt Cloud installation documentation.
.IP \(bu 2
Renamed state.sls runner to state.orchestrate, to reduce confusion with the \fI\%state.sls\fP execution function
.IP \(bu 2
Fix various bugs in the \fBdig\fP module (\fI\%issue 10367\fP)
.IP \(bu 2
Add retry for query on certain EC2 status codes (\fI\%issue 10154\fP)
.IP \(bu 2
Fix various bugs in mongodb_user state module (\fI\%issue 10430\fP)
.IP \(bu 2
Fix permissions on \fB~/.salt_token\fP (\fI\%issue 10422\fP)
.IP \(bu 2
Add PyObjects support
.IP \(bu 2
Fix launchctl module crash with missing files
.IP \(bu 2
Fix \fI\%saltutil.find_job\fP for Windows (\fI\%issue 10581\fP)
.IP \(bu 2
Fix OS detection for OpenSolaris (\fI\%issue 10601\fP)
.IP \(bu 2
Fix broken salt\-ssh key_deploy
.IP \(bu 2
Add support for multiline cron comments (\fI\%issue 10721\fP)
.IP \(bu 2
Fix timezone module for Arch (\fI\%issue 10789\fP)
.IP \(bu 2
Fix symlink support for \fBfile.recurse\fP (\fI\%issue 10809\fP)
.IP \(bu 2
Fix multi\-master bugs (\fI\%issue 10732\fP and \fI\%issue 10969\fP)
.IP \(bu 2
Fix file.patch to error when source file is unavailable (\fI\%issue 10380\fP)
.IP \(bu 2
Fix pkg to handle packages set as \fBpurge\fP in \fBpkg.installed\fP (\fI\%issue 10719\fP)
.IP \(bu 2
Add \fBzmqversion\fP grain
.IP \(bu 2
Fix highstate summary for masterless minions (\fI\%issue 10945\fP)
.IP \(bu 2
Fix \fI\%saltutil.find_job\fP for 2014.1 masters talking to 0.17 minions (\fI\%issue 11020\fP)
.IP \(bu 2
Fix \fI\%file.recurse\fP states with trailing slashes in source (\fI\%issue 11002\fP)
.IP \(bu 2
Fix \fI\%pkg states\fP to allow \fBpkgname.x86_64\fP (\fI\%issue 7306\fP)
.IP \(bu 2
Make \fI\%iptables states\fP set a default table for flush (\fI\%issue 11037\fP)
.IP \(bu 2
Added iptables \fB\-\-reject\-with\fP after final iptables call in \fI\%iptables states\fP (issue:\fI10757\fP)
.IP \(bu 2
Fix improper passing of “family” in \fI\%iptables states\fP (\fI\%issue 10774\fP)
.IP \(bu 2
Fix traceback in \fI\%iptables.insert\fP states (\fI\%issue 10988\fP)
.IP \(bu 2
Fix zombie processes (\fI\%issue 10867\fP and others)
.IP \(bu 2
Fix batch mode to obey \fB\-\-return\fP settings (\fI\%issue 9146\fP)
.IP \(bu 2
Fix localclient issue that was causing batch mode breakage (\fI\%issue 11094\fP, \fI\%issue 10470\fP, and others)
.IP \(bu 2
Multiple salt\-ssh fixes
.IP \(bu 2
FreeBSD: look in /usr/local/etc/salt for configuration by default, if installed using \fBpip \-\-editable\fP\&.
.IP \(bu 2
Add a \fBskip_suggestions\fP parameter to pkg.installed states which allows pre\-flight check to be skipped (\fI\%issue 11106\fP)
.IP \(bu 2
Fixed tag\-based gitfs fileserver environments regression (\fI\%issue 10956\fP)
.IP \(bu 2
Yum: fix cache of available pkgs not cleared when repos are changed (\fI\%issue 11001\fP)
.IP \(bu 2
Yum: fix for plugin\-provided repositories (i.e. RHN/Spacewalk) (\fI\%issue 11145\fP)
.IP \(bu 2
Fix regression in \fI\%chocolatey.bootstrap\fP (\fI\%issue 10541\fP)
.IP \(bu 2
Fix fail on unknown target in \fI\%jobs runner\fP (\fI\%issue 11151\fP)
.IP \(bu 2
Don’t log errors for commands which are expected to sometimes exit with non\-zero exit status (\fI\%issue 11154\fP, \fI\%issue 11090\fP)
.IP \(bu 2
Fix \fBtest=True\fP CLI override of config option (\fI\%issue 10877\fP)
.IP \(bu 2
Log sysctl key listing at loglevel TRACE (\fI\%issue 10931\fP)
.UNINDENT
.SS Salt 2014.1.10 Release Notes
.INDENT 0.0
.TP
.B release
2014\-08\-01
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Version 2014.1.9 contained a regression which caused inaccurate Salt version
detection, and thus was never packaged for general release.  This version
contains the version detection fix, but is otherwise identical to 2014.1.9.
.UNINDENT
.UNINDENT
.sp
Version 2014.1.10 is another bugfix release for \fI\%2014.1.0\fP\&.  Changes include:
.INDENT 0.0
.IP \(bu 2
Ensure salt\-ssh will not continue if permissions on a temporary directory are
not correct.
.IP \(bu 2
Use the bootstrap script distributed with Salt instead of relying on an
external resource
.IP \(bu 2
Remove unused testing code
.IP \(bu 2
Ensure salt states are placed into the \fB\&.salt\fP directory in salt\-ssh
.IP \(bu 2
Use a randomized path for temporary files in a salt\-cloud deployment
.IP \(bu 2
Clean any stale directories to ensure a fresh copy of salt\-ssh during a
deployment
.UNINDENT
.sp
Salt 2014.1.10 fixes security issues documented by CVE\-2014\-3563: \(dqInsecure
tmp\-file creation in seed.py, salt\-ssh, and salt\-cloud.\(dq Upgrading is
recommended.
.SS Salt 2014.1.11 Release Notes
.INDENT 0.0
.TP
.B release
2014\-08\-29
.UNINDENT
.sp
Version 2014.1.11 is another bugfix release for \fI\%2014.1.0\fP\&.  Changes include:
.INDENT 0.0
.IP \(bu 2
Fix for minion_id with byte\-order mark (BOM) (\fI\%issue 12296\fP)
.IP \(bu 2
Fix \fBrunas\fP deprecation in \fBat\fP module
.IP \(bu 2
Fix trailing slash befhavior for \fBfile.makedirs_\fP (\fI\%issue 14019\fP)
.IP \(bu 2
Fix chocolatey path (\fI\%issue 13870\fP)
.IP \(bu 2
Fix git_pillar infinite loop issues (\fI\%issue 14671\fP)
.IP \(bu 2
Fix json outputter \fBnull\fP case
.IP \(bu 2
Fix for minion error if one of multiple masters are down (\fI\%issue 14099\fP)
.UNINDENT
.SS Salt 2014.1.12 Release Notes
.INDENT 0.0
.TP
.B release
2014\-10\-08
.UNINDENT
.sp
Version 2014.1.12 is another bugfix release for \fI\%2014.1.0\fP\&.  Changes include:
.INDENT 0.0
.IP \(bu 2
Fix \fBscp_file\fP always failing (which broke salt\-cloud) (\fI\%issue 16437\fP)
.IP \(bu 2
Fix regression in pillar in masterless (\fI\%issue 16210\fP, \fI\%issue 16416\fP,
\fI\%issue 16428\fP)
.UNINDENT
.SS Salt 2014.1.13 Release Notes
.INDENT 0.0
.TP
.B release
2014\-10\-14
.UNINDENT
.sp
Version 2014.1.13 is another bugfix release for \fI\%2014.1.0\fP\&.  Changes include:
.INDENT 0.0
.IP \(bu 2
Fix \fBsftp_file\fP by checking the exit status code of scp (which broke salt\-cloud) (\fI\%issue 16599\fP)
.UNINDENT
.SS Salt 2014.1.2 Release Notes
.INDENT 0.0
.TP
.B release
2014\-04\-15
.UNINDENT
.sp
Version 2014.1.2 is another bugfix release for \fI\%2014.1.0\fP\&. The changes include:
.INDENT 0.0
.IP \(bu 2
Fix username detection when su\(aqed to root on FreeBSD (\fI\%issue 11628\fP)
.IP \(bu 2
Fix minionfs backend for file.recurse states
.IP \(bu 2
Fix 32\-bit packages of different arches than the CPU arch, on 32\-bit
RHEL/CentOS (\fI\%issue 11822\fP)
.IP \(bu 2
Fix bug with specifying alternate home dir on user creation (FreeBSD)
(\fI\%issue 11790\fP)
.IP \(bu 2
Don’t reload \fBsite\fP module on module refresh for MacOS
.IP \(bu 2
Fix regression with running execution functions in Pillar SLS
(\fI\%issue 11453\fP)
.IP \(bu 2
Fix some modules missing from Windows installer
.IP \(bu 2
Don’t log an error for yum commands that return nonzero exit status on
non\-failure (\fI\%issue 11645\fP)
.IP \(bu 2
Fix bug in rabbitmq state (\fI\%issue 8703\fP)
.IP \(bu 2
Fix missing ssh config options (\fI\%issue 10604\fP)
.IP \(bu 2
Fix top.sls ordering (\fI\%issue 10810\fP and \fI\%issue 11691\fP)
.IP \(bu 2
Fix \fBsalt\-key \-\-list all\fP (\fI\%issue 10982\fP)
.IP \(bu 2
Fix win_servermanager install/remove function (\fI\%issue 11038\fP)
.IP \(bu 2
Fix interaction with tokens when running commands as root (\fI\%issue 11223\fP)
.IP \(bu 2
Fix overstate bug with \fBfind_job\fP and \fB**kwargs\fP (\fI\%issue 10503\fP)
.IP \(bu 2
Fix \fBsaltenv\fP for \fBaptpkg.mod_repo\fP from \fBpkgrepo\fP state
.IP \(bu 2
Fix environment issue causing file caching problems (\fI\%issue 11189\fP)
.IP \(bu 2
Fix bug in \fB__parse_key\fP in registry state (\fI\%issue 11408\fP)
.IP \(bu 2
Add minion auth retry on rejection (\fI\%issue 10763\fP)
.IP \(bu 2
Fix publish_session updating the encryption key (\fI\%issue 11493\fP)
.IP \(bu 2
Fix for bad \fBAssertionError\fP raised by GitPython (\fI\%issue 11473\fP)
.IP \(bu 2
Fix \fBdebian_ip\fP to allow disabling and enabling networking on Ubuntu (\fI\%issue 11164\fP)
.IP \(bu 2
Fix potential memory leak caused by saved (and unused) events (\fI\%issue 11582\fP)
.IP \(bu 2
Fix exception handling in the MySQL module (\fI\%issue 11616\fP)
.IP \(bu 2
Fix environment\-related error (\fI\%issue 11534\fP)
.IP \(bu 2
Include \fBpsutil\fP on Windows
.IP \(bu 2
Add \fBfile.replace\fP and \fBfile.search\fP to Windows (\fI\%issue 11471\fP)
.IP \(bu 2
Add additional \fBfile\fP module helpers to Windows (\fI\%issue 11235\fP)
.IP \(bu 2
Add \fBpid\fP to netstat output on Windows (\fI\%issue 10782\fP)
.IP \(bu 2
Fix Windows not caching new versions of installers in winrepo (\fI\%issue 10597\fP)
.IP \(bu 2
Fix hardcoded md5 hashing
.IP \(bu 2
Fix kwargs in salt\-ssh (\fI\%issue 11609\fP)
.IP \(bu 2
Fix file backup timestamps (\fI\%issue 11745\fP)
.IP \(bu 2
Fix stacktrace on \fBsys.doc\fP with invalid eauth (\fI\%issue 11293\fP)
.IP \(bu 2
Fix \fBgit.latest\fP with \fBtest=True\fP (\fI\%issue 11595\fP)
.IP \(bu 2
Fix \fBfile.check_perms\fP hardcoded \fBfollow_symlinks\fP (\fI\%issue 11387\fP)
.IP \(bu 2
Fix certain \fBpkg\fP states for RHEL5/Cent5 machines (\fI\%issue 11719\fP)
.UNINDENT
.SS Salt 2014.1.3 Release Notes
.INDENT 0.0
.TP
.B release
2014\-04\-15
.UNINDENT
.sp
Version 2014.1.3 is another bugfix release for \fI\%2014.1.0\fP\&.  It was created as a hotfix for a regression
found in 2014.1.2, which was not distributed.  The only change made was as
follows:
.INDENT 0.0
.IP \(bu 2
Fix regression that caused \fBsaltutil.find_job\fP to fail, causing premature
terminations of salt CLI commands.
.UNINDENT
.sp
Changes in the not\-distributed 2014.1.2, also included in 2014.1.3:
.INDENT 0.0
.IP \(bu 2
Fix username detection when su\(aqed to root on FreeBSD (\fI\%issue 11628\fP)
.IP \(bu 2
Fix minionfs backend for file.recurse states
.IP \(bu 2
Fix 32\-bit packages of different arches than the CPU arch, on 32\-bit
RHEL/CentOS (\fI\%issue 11822\fP)
.IP \(bu 2
Fix bug with specifying alternate home dir on user creation (FreeBSD)
(\fI\%issue 11790\fP)
.IP \(bu 2
Don’t reload \fBsite\fP module on module refresh for MacOS
.IP \(bu 2
Fix regression with running execution functions in Pillar SLS
(\fI\%issue 11453\fP)
.IP \(bu 2
Fix some modules missing from Windows installer
.IP \(bu 2
Don’t log an error for yum commands that return nonzero exit status on
non\-failure (\fI\%issue 11645\fP)
.IP \(bu 2
Fix bug in rabbitmq state (\fI\%issue 8703\fP)
.IP \(bu 2
Fix missing ssh config options (\fI\%issue 10604\fP)
.IP \(bu 2
Fix top.sls ordering (\fI\%issue 10810\fP and \fI\%issue 11691\fP)
.IP \(bu 2
Fix \fBsalt\-key \-\-list all\fP (\fI\%issue 10982\fP)
.IP \(bu 2
Fix win_servermanager install/remove function (\fI\%issue 11038\fP)
.IP \(bu 2
Fix interaction with tokens when running commands as root (\fI\%issue 11223\fP)
.IP \(bu 2
Fix overstate bug with \fBfind_job\fP and \fB**kwargs\fP (\fI\%issue 10503\fP)
.IP \(bu 2
Fix \fBsaltenv\fP for \fBaptpkg.mod_repo\fP from \fBpkgrepo\fP state
.IP \(bu 2
Fix environment issue causing file caching problems (\fI\%issue 11189\fP)
.IP \(bu 2
Fix bug in \fB__parse_key\fP in registry state (\fI\%issue 11408\fP)
.IP \(bu 2
Add minion auth retry on rejection (\fI\%issue 10763\fP)
.IP \(bu 2
Fix publish_session updating the encryption key (\fI\%issue 11493\fP)
.IP \(bu 2
Fix for bad \fBAssertionError\fP raised by GitPython (\fI\%issue 11473\fP)
.IP \(bu 2
Fix \fBdebian_ip\fP to allow disabling and enabling networking on Ubuntu (\fI\%issue 11164\fP)
.IP \(bu 2
Fix potential memory leak caused by saved (and unused) events (\fI\%issue 11582\fP)
.IP \(bu 2
Fix exception handling in the MySQL module (\fI\%issue 11616\fP)
.IP \(bu 2
Fix environment\-related error (\fI\%issue 11534\fP)
.IP \(bu 2
Include \fBpsutil\fP on Windows
.IP \(bu 2
Add \fBfile.replace\fP and \fBfile.search\fP to Windows (\fI\%issue 11471\fP)
.IP \(bu 2
Add additional \fBfile\fP module helpers to Windows (\fI\%issue 11235\fP)
.IP \(bu 2
Add \fBpid\fP to netstat output on Windows (\fI\%issue 10782\fP)
.IP \(bu 2
Fix Windows not caching new versions of installers in winrepo (\fI\%issue 10597\fP)
.IP \(bu 2
Fix hardcoded md5 hashing
.IP \(bu 2
Fix kwargs in salt\-ssh (\fI\%issue 11609\fP)
.IP \(bu 2
Fix file backup timestamps (\fI\%issue 11745\fP)
.IP \(bu 2
Fix stacktrace on \fBsys.doc\fP with invalid eauth (\fI\%issue 11293\fP)
.IP \(bu 2
Fix \fBgit.latest\fP with \fBtest=True\fP (\fI\%issue 11595\fP)
.IP \(bu 2
Fix \fBfile.check_perms\fP hardcoded \fBfollow_symlinks\fP (\fI\%issue 11387\fP)
.IP \(bu 2
Fix certain \fBpkg\fP states for RHEL5/Cent5 machines (\fI\%issue 11719\fP)
.UNINDENT
.SS Salt 2014.1.4 Release Notes
.INDENT 0.0
.TP
.B release
2014\-05\-05
.UNINDENT
.sp
Version 2014.1.4 is another bugfix release for \fI\%2014.1.0\fP\&.  Changes include:
.INDENT 0.0
.IP \(bu 2
Fix setup.py dependency issue (\fI\%issue 12031\fP)
.IP \(bu 2
Fix handling for IOErrors under certain circumstances (\fI\%issue 11783\fP and
\fI\%issue 11853\fP)
.IP \(bu 2
Fix fatal exception when \fB/proc/1/cgroup\fP is not readable (\fI\%issue 11619\fP)
.IP \(bu 2
Fix os grains for OpenSolaris (\fI\%issue 11907\fP)
.IP \(bu 2
Fix \fBlvs.zero\fP module argument pass\-through (\fI\%issue 9001\fP)
.IP \(bu 2
Fix bug in \fBdebian_ip\fP interaction with \fI\%network.system\fP state (\fI\%issue 11164\fP)
.IP \(bu 2
Remove bad binary package verification code (\fI\%issue 12177\fP)
.IP \(bu 2
Fix traceback in solaris package installation (\fI\%issue 12237\fP)
.IP \(bu 2
Fix \fI\%file.directory\fP state symlink handling
(\fI\%issue 12209\fP)
.IP \(bu 2
Remove \fBexternal_ip\fP grain
.IP \(bu 2
Fix \fI\%file.managed\fP makedirs issues
(\fI\%issue 10446\fP)
.IP \(bu 2
Fix hang on non\-existent Windows drive letter for \fI\%file\fP module (\fI\%issue 9880\fP)
.IP \(bu 2
Fix salt minion caching all users on the server (\fI\%issue 9743\fP)
.IP \(bu 2
Add strftime formatting for \fI\%ps.boot_time\fP
(\fI\%issue 12428\fP)
.UNINDENT
.SS Salt 2014.1.5 Release Notes
.INDENT 0.0
.TP
.B release
2014\-06\-11
.UNINDENT
.sp
Version 2014.1.5 is another bugfix release for \fI\%2014.1.0\fP\&.  Changes include:
.INDENT 0.0
.IP \(bu 2
Add function for finding cached job on the minion
.IP \(bu 2
Fix iptables save file location for Debian (\fI\%issue 11730\fP)
.IP \(bu 2
Fix for minion caching jobs when master is down
.IP \(bu 2
Bump default \fBsyndic_wait\fP to 5 to fix syndic\-related problems
(\fI\%issue 12262\fP)
.IP \(bu 2
Add OpenBSD, FreeBSD, and NetBSD support for \fBnetwork.netstat\fP
(\fI\%issue 12121\fP)
.IP \(bu 2
Fix false positive error in logs for \fBmakeconf\fP state (\fI\%issue 9762\fP)
.IP \(bu 2
Fix for yum \fBfromrepo\fP package installs when repo is disabled by default
(\fI\%issue 12466\fP)
.IP \(bu 2
Fix for extra blank lines in \fBfile.blockreplace\fP (\fI\%issue 12422\fP)
.IP \(bu 2
Fix grain detection for OpenVZ guests (\fI\%issue 11877\fP)
.IP \(bu 2
Fix \fBget_dns_servers\fP function for Windows \fBwin_dns_client\fP
.IP \(bu 2
Use system locale for ports package installations
.IP \(bu 2
Use correct stop/restart procedure for Debian networking in \fBdebian_ip\fP
(\fI\%issue 12614\fP)
.IP \(bu 2
Fix for \fBcmd_iter\fP/\fBcmd_iter_no_block\fP blocking issues (\fI\%issue 12617\fP)
.IP \(bu 2
Fix traceback when syncing custom types (\fI\%issue 12883\fP)
.IP \(bu 2
Fix cleaning directory symlinks in \fBfile.directory\fP
.IP \(bu 2
Add performance optimizations for \fBsaltutil.sync_all\fP and
\fBstate.highstate\fP
.IP \(bu 2
Fix possible error in \fBsaltutil.running\fP
.IP \(bu 2
Fix for kmod modules with dashes (\fI\%issue 13239\fP)
.IP \(bu 2
Fix possible race condition for Windows minions in state module reloading
(\fI\%issue 12370\fP)
.IP \(bu 2
Fix bug with roster for \fBpasswd\fP option that is loaded as a non\-string object
(\fI\%issue 13249\fP)
.IP \(bu 2
Keep duplicate version numbers from showing up in \fBpkg.list_pkgs\fP output
.IP \(bu 2
Fixes for Jinja renderer, timezone \fI\%module\fP/\fI\%state\fP (\fI\%issue 12724\fP)
.IP \(bu 2
Fix timedatectl parsing for systemd>=210 (\fI\%issue 12728\fP)
.IP \(bu 2
Fix \fBsaltenv\fP being written to YUM repo config files (\fI\%issue 12887\fP)
.IP \(bu 2
Removed the deprecated external nodes classifier (originally accessible by
setting a value for external_nodes in the master configuration file).  Note
that this functionality has been marked deprecated for some time and was
replaced by the more general \fI\%master tops\fP
system.
.IP \(bu 2
More robust escaping of ldap filter strings.
.IP \(bu 2
Fix trailing slash in \fI\%gitfs_root\fP causing files not to be
available (\fI\%issue 13185\fP)
.UNINDENT
.SS Salt 2014.1.6 Release Notes
.INDENT 0.0
.TP
.B release
2014\-07\-08
.UNINDENT
.sp
Version 2014.1.6 is another bugfix release for \fI\%2014.1.0\fP\&.  Changes include:
.INDENT 0.0
.IP \(bu 2
Fix extra \fBiptables \-\-help\fP output (Sorry!)  (\fI\%issue 13648\fP,
\fI\%issue 13507\fP, \fI\%issue 13527\fP, \fI\%issue 13607\fP)
.IP \(bu 2
Fix \fBmount.active\fP for Solaris
.IP \(bu 2
Fix support for \fBallow\-hotplug\fP statement in debian_ip network module
.IP \(bu 2
Add sqlite3 to esky builds
.IP \(bu 2
Fix \fBjobs.active\fP output (\fI\%issue 9526\fP)
.IP \(bu 2
Fix the \fBvirtual\fP grain for Xen (\fI\%issue 13534\fP)
.IP \(bu 2
Fix _ext_nodes unavailable on master (\fI\%issue 13535\fP)
.IP \(bu 2
Fix eauth for batch mode (\fI\%issue 9605\fP)
.IP \(bu 2
Fix force\-related issues with \fBtomcat\fP support (\fI\%issue 12889\fP)
.IP \(bu 2
Fix KeyError when cloud mapping
.IP \(bu 2
Fix salt\-minion restart loop in Windows (\fI\%issue 12086\fP)
.IP \(bu 2
Fix detection of \fBservice\fP virtual module on Fedora minions
.IP \(bu 2
Fix traceback with missing ipv4 grain (\fI\%issue 13838\fP)
.IP \(bu 2
Fix issue in roots backend with invalid data in mtime_map (\fI\%issue 13836\fP)
.IP \(bu 2
Fix traceback in \fBjobs.active\fP (\fI\%issue 11151\fP)
.IP \(bu 2
Fix \fBmaster_tops\fP and \fB_ext_nodes\fP issue (\fI\%issue 13535\fP, \fI\%issue 13673\fP)
.UNINDENT
.SS Salt 2014.1.7 Release Notes
.INDENT 0.0
.TP
.B release
2014\-07\-09
.UNINDENT
.sp
Version 2014.1.7 is another bugfix release for \fI\%2014.1.0\fP\&.  Changes include:
.INDENT 0.0
.IP \(bu 2
Fix batch mode regression (\fI\%issue 14046\fP)
.UNINDENT
.sp
This release was a hotfix release for the regression listed above which was
present in the 2014.1.6 release.  The changes included in 2014.1.6 are listed
below:
.INDENT 0.0
.IP \(bu 2
Fix extra \fBiptables \-\-help\fP output (Sorry!)  (\fI\%issue 13648\fP,
\fI\%issue 13507\fP, \fI\%issue 13527\fP, \fI\%issue 13607\fP)
.IP \(bu 2
Fix \fBmount.active\fP for Solaris
.IP \(bu 2
Fix support for \fBallow\-hotplug\fP statement in debian_ip network module
.IP \(bu 2
Add sqlite3 to esky builds
.IP \(bu 2
Fix \fBjobs.active\fP output (\fI\%issue 9526\fP)
.IP \(bu 2
Fix the \fBvirtual\fP grain for Xen (\fI\%issue 13534\fP)
.IP \(bu 2
Fix eauth for batch mode (\fI\%issue 9605\fP)
.IP \(bu 2
Fix force\-related issues with \fBtomcat\fP support (\fI\%issue 12889\fP)
.IP \(bu 2
Fix KeyError when cloud mapping
.IP \(bu 2
Fix salt\-minion restart loop in Windows (\fI\%issue 12086\fP)
.IP \(bu 2
Fix detection of \fBservice\fP virtual module on Fedora minions
.IP \(bu 2
Fix traceback with missing ipv4 grain (\fI\%issue 13838\fP)
.IP \(bu 2
Fix issue in roots backend with invalid data in mtime_map (\fI\%issue 13836\fP)
.IP \(bu 2
Fix traceback in \fBjobs.active\fP (\fI\%issue 11151\fP)
.IP \(bu 2
Fix \fBmaster_tops\fP and \fB_ext_nodes\fP issue (\fI\%issue 13535\fP, \fI\%issue 13673\fP)
.UNINDENT
.SS Salt 2014.1.8 Release Notes
.INDENT 0.0
.TP
.B release
2014\-07\-30
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This release contained a regression which caused inaccurate Salt version
detection, and thus was never packaged for general release.  Please use
version 2014.1.10 instead.
.UNINDENT
.UNINDENT
.sp
Version 2014.1.8 is another bugfix release for \fI\%2014.1.0\fP\&.  Changes include:
.INDENT 0.0
.IP \(bu 2
Ensure salt\-ssh will not continue if permissions on a temporary directory are
not correct.
.IP \(bu 2
Use the bootstrap script distributed with Salt instead of relying on an
external resource
.IP \(bu 2
Remove unused testing code
.IP \(bu 2
Ensure salt states are placed into the \fB\&.salt\fP directory in salt\-ssh
.IP \(bu 2
Use a randomized path for temporary files in a salt\-cloud deployment
.IP \(bu 2
Clean any stale directories to ensure a fresh copy of salt\-ssh during a
deployment
.UNINDENT
.SS Salt 2014.1.9 Release Notes
.INDENT 0.0
.TP
.B release
2014\-07\-31
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This release contained a regression which caused inaccurate Salt version
detection, and thus was never packaged for general release.  Please use
version 2014.1.10 instead.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Version 2014.1.8 contained a regression which caused inaccurate Salt version
detection, and thus was never packaged for general release.  This version
contains the version detection fix, but is otherwise identical to 2014.1.8.
.UNINDENT
.UNINDENT
.sp
Version 2014.1.9 is another bugfix release for \fI\%2014.1.0\fP\&.  Changes include:
.INDENT 0.0
.IP \(bu 2
Ensure salt\-ssh will not continue if permissions on a temporary directory are
not correct.
.IP \(bu 2
Use the bootstrap script distributed with Salt instead of relying on an
external resource
.IP \(bu 2
Remove unused testing code
.IP \(bu 2
Ensure salt states are placed into the \fB\&.salt\fP directory in salt\-ssh
.IP \(bu 2
Use a randomized path for temporary files in a salt\-cloud deployment
.IP \(bu 2
Clean any stale directories to ensure a fresh copy of salt\-ssh during a
deployment
.UNINDENT
.SS Salt 0.10.0 Release Notes
.INDENT 0.0
.TP
.B release
2012\-06\-16
.UNINDENT
.sp
0.10.0 has arrived! This release comes with MANY bug fixes, and new
capabilities which greatly enhance performance and reliability. This
release is primarily a bug fix release with many new tests and many repaired
bugs. This release also introduces a few new key features which were brought
in primarily to repair bugs and some limitations found in some of the
components of the original architecture.
.SS Major Features
.SS Event System
.sp
The Salt Master now comes equipped with a new event system. This event system
has replaced some of the back end of the Salt client and offers the beginning of
a system which will make plugging external applications into Salt. The event
system relies on a local ZeroMQ publish socket and other processes can connect
to this socket and listen for events. The new events can be easily managed via
Salt\(aqs event library.
.SS Unprivileged User Updates
.sp
Some enhancements have been added to Salt for running as a user other than
root. These new additions should make switching the user that the Salt Master
is running as very painless, simply change the \fBuser\fP option in the master
configuration and restart the master, Salt will take care of all of the
particulars for you.
.SS Peer Runner Execution
.sp
Salt has long had the peer communication system used to allow minions to send
commands via the salt master. 0.10.0 adds a new capability here, now the
master can be configured to allow for minions to execute Salt runners via
the \fBpeer_run\fP option in the salt master configuration.
.SS YAML Parsing Updates
.sp
In the past the YAML parser for sls files would return the incorrect numbers
when the file mode was set with a preceding 0. The YAML parser used in Salt
has been modified to no longer convert these number into octal but to keep
them as the correct value so that sls files can be a little cleaner to write.
.SS State Call Data Files
.sp
It was requested that the minion keep a local cache of the most recent executed
state run. This has been added and now with state runs the data is stored in a
msgpack file in the minion\(aqs cachedir.
.SS Turning Off the Job Cache
.sp
A new option has been added to the master configuration file. In previous
releases the Salt client would look over the Salt job cache to read in
the minion return data. With the addition of the event system the Salt client
can now watch for events directly from the master worker processes.
.sp
This means that the job cache is no longer a hard requirement. Keep in mind
though, that turning off the job cache means that historic job execution data
cannot be retrieved.
.SS Test Updates
.SS Minion Swarms Are Faster
.sp
To continue our efforts with testing Salt\(aqs ability to scale the minionswarm
script has been updated. The minionswarm can now start up minions much faster
than it could before and comes with a new feature allowing modules to be
disabled, thus lowering the minion\(aqs footprint when making a swarm. These new
updates have allows us to test
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# python minionswarm.py \-m 20 \-\-master salt\-master
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Many Fixes
.sp
To get a good idea for the number of bugfixes this release offers take a look
at the closed tickets for 0.10.0, this is a very substantial update:
.sp
\fI\%https://github.com/saltstack/salt/issues?milestone=12&state=closed\fP
.SS Master and Minion Stability Fixes
.sp
As Salt deployments grow new ways to break Salt are discovered. 0.10.0 comes
with a number of fixes for the minions and master greatly improving Salt
stability.
.SS Salt 0.10.1 Release Notes
.INDENT 0.0
.TP
.B release
2012\-06\-19
.UNINDENT
.SS Salt 0.10.2 Release Notes
.INDENT 0.0
.TP
.B release
2012\-07\-30
.UNINDENT
.sp
0.10.2 is out! This release comes with enhancements to the pillar interface,
cleaner ways to access the salt\-call capabilities in the API, minion data
caching and the event system has been added to salt minions.
.sp
There have also been updates to the ZeroMQ functions, many more tests
(thanks to sponsors, the code sprint and many contributors) and a swath
of bug fixes.
.SS Major Features
.SS Ext Pillar Modules
.sp
The ranks of available Salt modules directories sees a new member in 0.10.2.
With the popularity of pillar a higher demand has arisen for \fBext_pillar\fP
interfaces to be more like regular Salt module additions. Now ext_pillar
interfaces can be added in the same way as other modules, just drop it into
the pillar directory in the salt source.
.SS Minion Events
.sp
In 0.10.0 an event system was added to the Salt master. 0.10.2 adds the event
system to the minions as well. Now event can be published on a local minion
as well.
.sp
The minions can also send events back up to the master. This means that Salt is
able to communicate individual events from the minions back up to the Master
which are not associated with command.
.SS Minion Data Caching
.sp
When pillar was introduced the landscape for available data was greatly
enhanced. The minion\(aqs began sending grain data back to the master on a
regular basis.
.sp
The new config option on the master called \fBminion_data_cache\fP instructs the
Salt master to maintain a cache of the minion\(aqs grains and pillar data in the
cachedir. This option is turned off by default to avoid hitting the disk more,
but when enabled the cache is used to make grain matching from the salt command
more powerful, since the minions that will match can be predetermined.
.SS Backup Files
.sp
By default all files replaced by the file.managed and file.recurse states we
simply deleted. 0.10.2 adds a new option. By setting the backup option to
\fBminion\fP the files are backed up before they are replaced.
.sp
The backed up files are located in the cachedir under the file_backup
directory. On a default system this will be at:
\fB/var/cache/salt/file_backup\fP
.SS Configuration files
.sp
\fBsalt\-master\fP and \fBsalt\-minion\fP automatically load additional configuration
files from \fBmaster.d/*.conf\fP respective \fBminion.d/*.conf\fP where
\fBmaster.d\fP/\fBminion.d\fP is a directory in the same directory as the main
configuration file.
.SS Salt Key Verification
.sp
A number of users complained that they had inadvertently deleted the wrong salt
authentication keys. 0.10.2 now displays what keys are going to be deleted
and verifies that they are the keys that are intended for deletion.
.SS Key auto\-signing
.sp
If \fBautosign_file\fP is specified in the configuration file incoming keys
will be compared to the list of keynames in \fBautosign_file\fP\&. Regular
expressions as well as globbing is supported.
.sp
The file must only be writable by the user otherwise the file will be
ignored. To relax the permission and allow group write access set the
\fBpermissive_pki_access\fP option.
.SS Module changes
.SS Improved OpenBSD support
.sp
New modules for managing services and packages were provided by Joshua
Elsasser to further improve the support for OpenBSD.
.sp
Existing modules like the \fIdisk\fP module were also improved to support
OpenBSD.
.SS SQL Modules
.sp
The MySQL and PostgreSQL modules have both received a number of additions thanks
to the work of Avi Marcus and Roman Imankulov.
.SS ZFS Support on FreeBSD
.sp
A new ZFS module has been added by Kurtis Velarde for FreeBSD supporting
various ZFS operations like creating, extending or removing zpools.
.SS Augeas
.sp
A new Augeas module by Ulrich Dangel for editing and verifying config files.
.SS Native Debian Service module
.sp
The support for the Debian was further improved with an new service module
for Debian by Ahmad Khayyat supporting \fIdisable\fP and \fIenable\fP\&.
.SS Cassandra
.sp
Cassandra support has been added by Adam Garside. Currently only
status and diagnostic information are supported.
.SS Networking
.sp
The networking support for \fIRHEL\fP has been improved and supports bonding
support as well as zeroconf configuration.
.SS Monit
.sp
Basic monit support by Kurtis Velarde to control services via monit.
.SS nzbget
.sp
Basic support for controlling nzbget by Joseph Hall
.SS Bluetooth
.sp
Baisc \fBbluez\fP support for managing and controlling Bluetooth devices.
Supports scanning as well as pairing/unpairing by Joseph Hall.
.SS Test Updates
.SS Consistency Testing
.sp
Another testing script has been added. A bug was found in pillar when many
minions generated pillar data at the same time. The new \fBconsist.py\fP script
is the tests directory was created to reproduce bugs where data should always
be consistent.
.SS Many Fixes
.sp
To get a good idea for the number of bugfixes this release offers take a look
at the closed tickets for 0.10.2, this is a very substantial update:
.sp
\fI\%https://github.com/saltstack/salt/issues?milestone=24&page=1&state=closed\fP
.SS Master and Minion Stability Fixes
.sp
As Salt deployments grow new ways to break Salt are discovered. 0.10.2 comes
with a number of fixes for the minions and master greatly improving Salt
stability.
.SS Salt 0.10.3 Release Notes
.INDENT 0.0
.TP
.B release
2012\-09\-30
.UNINDENT
.sp
The latest taste of Salt has come, this release has many fixes and feature
additions. Modifications have been made to make ZeroMQ connections more
reliable, the beginning of the ACL system is in place, a new command line
parsing system has been added, dynamic module distribution has become more
environment aware, the new \fImaster_finger\fP option and many more!
.SS Major Features
.SS ACL System
.sp
The new ACL system has been introduced. The ACL system allows for system users
other than root to execute salt commands. Users can be allowed to execute
specific commands in the same way that minions are opened up to the peer
system.
.sp
The configuration value to open up the ACL system is called \fBclient_acl\fP
and is configured like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
client_acl:
  fred:
    \- test..*
    \- pkg.list_pkgs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Where \fIfred\fP is allowed access to functions in the test module and to the
\fBpkg.list_pkgs\fP function.
.SS Master Finger Option
.sp
The \fImaster_finger\fP option has been added to improve the security of minion
provisioning. The \fImaster_finger\fP option allows for the fingerprint of the
master public key to be set in the configuration file to double verify that the
master is valid. This option was added in response to a motivation to
pre\-authenticate the master when provisioning new minions to help prevent
man in the middle attacks in some situations.
.SS Salt Key Fingerprint Generation
.sp
The ability to generate fingerprints of keys used by Salt has been added to
\fBsalt\-key\fP\&. The new option \fIfinger\fP accepts the name of the key to generate
and display a fingerprint for.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key \-F master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Will display the fingerprints for the master public and private keys.
.SS Parsing System
.sp
Pedro Algavio, aka s0undt3ch, has added a substantial update to the command
line parsing system that makes the help message output much cleaner and easier
to search through. Salt parsers now have \fI\-\-versions\-report\fP besides usual
\fI\-\-version\fP info which you can provide when reporting any issues found.
.SS Key Generation
.sp
We have reduced the requirements needed for \fIsalt\-key\fP to generate minion keys.
You\(aqre no longer required to have salt configured and its common directories
created just to generate keys. This might prove useful if you\(aqre batch creating
keys to pre\-load on minions.
.SS Startup States
.sp
A few configuration options have been added which allow for states to be run
when the minion daemon starts. This can be a great advantage when deploying
with Salt because the minion can apply states right when it first runs. To
use startup states set the \fBstartup_states\fP configuration option on the
minion to \fIhighstate\fP\&.
.SS New Exclude Declaration
.sp
Some users have asked about adding the ability to ensure that other sls files
or ids are excluded from a state run. The exclude statement will delete all of
the data loaded from the specified sls file or will delete the specified id:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
exclude:
  \- sls: http
  \- id: /etc/vimrc
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Max Open Files
.sp
While we\(aqre currently unable to properly handle ZeroMQ\(aqs abort signals when the
max open files is reached, due to the way that\(aqs handled on ZeroMQ\(aqs, we have
minimized the chances of this happening without at least warning the user.
.SS More State Output Options
.sp
Some major changes have been made to the state output system. In the past state
return data was printed in a very verbose fashion and only states that failed
or made changes were printed by default. Now two options can be passed to the
master and minion configuration files to change the behavior of the state
output. State output can be set to verbose (default) or non\-verbose with the
\fBstate_verbose\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_verbose: False
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It is noteworthy that the state_verbose option used to be set to \fIFalse\fP by
default but has been changed to \fITrue\fP by default in 0.10.3 due to many
requests for the change.
.sp
Te next option to be aware of new and called \fBstate_output\fP\&. This option
allows for the state output to be set to \fIfull\fP (default) or \fIterse\fP\&.
.sp
The \fIfull\fP output is the standard state output, but the new \fIterse\fP output
will print only one line per state making the output much easier to follow when
executing a large state system.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
state_output: terse
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fIstate.file.append\fP Improvements
.sp
The salt state \fIfile.append()\fP tries \fInot\fP to append existing text. Previously
the matching check was being made line by line. While this kind of check might
be enough for most cases, if the text being appended was multi\-line, the check
would not work properly. This issue is now properly handled, the match is done
as a whole ignoring any white space addition or removal except inside commas.
For those thinking that, in order to properly match over multiple lines, salt
will load the whole file into memory, that\(aqs not true. For most cases this is
not important but an erroneous order to read a 4GB file, if not properly
handled, like salt does, could make salt chew that amount of memory.  Salt has
a buffered file reader which will keep in memory a maximum of 256KB and
iterates over the file in chunks of 32KB to test for the match, more than
enough, if not, explain your usage on a ticket. With this change, also
\fIsalt.modules.file.contains()\fP, \fIsalt.modules.file.contains_regex()\fP,
\fIsalt.modules.file.contains_glob()\fP and \fIsalt.utils.find\fP now do the searching
and/or matching using the buffered chunks approach explained above.
.sp
Two new keyword arguments were also added, \fImakedirs\fP, and \fIsource\fP\&.
The first, \fImakedirs\fP will create the necessary directories in order to append
to the specified file, of course, it only applies if we\(aqre trying to append to
a non\-existing file on a non\-existing directory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/tmp/salttest/file\-append\-makedirs:
    file.append:
        text: foo
        makedirs: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The second, \fIsource\fP, allows one to append the contents of a file instead of
specifying the text.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/tmp/salttest/file\-append\-source:

file.append:
    \- source: salt://testfile
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Security Fix
.sp
A timing vulnerability was uncovered in the code which decrypts the AES
messages sent over the network. This has been fixed and upgrading is
strongly recommended.
.SS Salt 0.10.4 Release Notes
.INDENT 0.0
.TP
.B release
2012\-10\-23
.UNINDENT
.sp
Salt 0.10.4 is a monumental release for the Salt team, with two new module
systems, many additions to allow granular access to Salt, improved platform
support and much more.
.sp
This release is also exciting because we have been able to shorten the release
cycle back to under a month. We are working hard to keep up the aggressive pace
and look forward to having releases happen more frequently!
.sp
This release also includes a serious security fix and all users are very
strongly recommended to upgrade. As usual, upgrade the master first, and then
the minion to ensure that the process is smooth.
.SS Major Features
.SS External Authentication System
.sp
The new external authentication system allows for Salt to pass through
authentication to any authentication system to determine if a user has
permission to execute a Salt command. The Unix PAM system is the first
supported system with more to come!
.sp
The external authentication system allows for specific users to be granted
access to execute specific functions on specific minions. Access is configured
in the master configuration file, and uses the new access control system:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
external_auth:
  pam:
    thatch:
      \- \(aqweb*\(aq:
        \- test.*
        \- network.*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The configuration above allows the user \fIthatch\fP to execute functions in the
test and network modules on minions that match the web* target.
.SS Access Control System
.sp
All Salt systems can now be configured to grant access to non\-administrative
users in a granular way. The old configuration continues to work. Specific
functions can be opened up to specific minions from specific users in the case
of external auth and client ACLs, and for specific minions in the case of the
peer system.
.sp
Access controls are configured like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
client_acl:
  fred:
    \- web\e*:
      \- pkg.list_pkgs
      \- test.*
      \- apache.*
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Target by Network
.sp
A new matcher has been added to the system which allows for minions to be
targeted by network. This new matcher can be called with the \fI\-S\fP flag on the
command line and is available in all places that the matcher system is
available. Using it is simple:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt \-S \(aq192.168.1.0/24\(aq test.ping
$ salt \-S \(aq192.168.1.100\(aq test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Nodegroup Nesting
.sp
Previously a nodegroup was limited by not being able to include another
nodegroup, this restraint has been lifted and now nodegroups will be expanded
within other nodegroups with the \fIN@\fP classifier.
.SS Salt Key Delete by Glob
.sp
The ability to delete minion keys by glob has been added to \fBsalt\-key\fP\&.  To
delete all minion keys whose minion name starts with \(aqweb\(aq:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-key \-d \(aqweb*\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Master Tops System
.sp
The \fIexternal_nodes\fP system has been upgraded to allow for modular subsystems
to be used to generate the top file data for a highstate run.
.sp
The \fIexternal_nodes\fP option still works but will be deprecated in the future in
favor of the new \fImaster_tops\fP option.
.sp
Example of using \fImaster_tops\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
master_tops:
  ext_nodes: cobbler\-external\-nodes
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Next Level Solaris Support
.sp
A lot of work has been put into improved Solaris support by Romeo Theriault.
Packaging modules (pkgadd/pkgrm and pkgutil) and states, cron support and user
and group management have all been added and improved upon. These additions
along with SMF (Service Management Facility) service support and improved
Solaris grain detection in 0.10.3 add up to Salt becoming a great tool
to manage Solaris servers with.
.SS Security
.sp
A vulnerability in the security handshake was found and has been repaired, old
minions should be able to connect to a new master, so as usual, the master
should be updated first and then the minions.
.SS Pillar Updates
.sp
The pillar communication has been updated to add some extra levels of
verification so that the intended minion is the only one allowed to gather the
data. Once all minions and the master are updated to salt 0.10.4 please
activate pillar \fI2\fP by changing the \fIpillar_version\fP in the master config to
\fI2\fP\&. This will be set to \fI2\fP by default in a future release.
.SS Salt 0.10.5 Release Notes
.INDENT 0.0
.TP
.B release
2012\-11\-15
.UNINDENT
.sp
Salt 0.10.5 is ready, and comes with some great new features. A few more
interfaces have been modularized, like the outputter system. The job cache
system has been made more powerful and can now store and retrieve jobs archived
in external databases. The returner system has been extended to allow minions
to easily retrieve data from a returner interface.
.sp
As usual, this is an exciting release, with many noteworthy additions!
.SS Major Features
.SS External Job Cache
.sp
The external job cache is a system which allows for a returner interface to
also act as a job cache. This system is intended to allow users to store
job information in a central location for longer periods of time and to make
the act of looking up information from jobs executed on other minions easier.
.sp
Currently the external job cache is supported via the mongo and redis
returners:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_job_cache: redis
redis.host: salt
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once the external job cache is turned on the new \fIret\fP module can be used on
the minions to retrieve return information from the job cache. This can be a
great way for minions to respond and react to other minions.
.SS OpenStack Additions
.sp
OpenStack integration with Salt has been moving forward at a blistering pace.
The new \fInova\fP, \fIglance\fP, and \fIkeystone\fP modules represent the beginning of
ongoing OpenStack integration.
.sp
The Salt team has had many conversations with core OpenStack developers and
is working on linking to OpenStack in powerful new ways.
.SS Wheel System
.sp
A new API was added to the Salt Master which allows the master to be managed
via an external API. This new system allows Salt API to easily hook into the
Salt Master and manage configs, modify the state tree, manage the pillar and
more. The main motivation for the wheel system is to enable features needed
in the upcoming web UI so users can manage the master just as easily as they
manage minions.
.sp
The wheel system has also been hooked into the external auth system. This
allows specific users to have granular access to manage components of the
Salt Master.
.SS Render Pipes
.sp
Jack Kuan has added a substantial new feature. The render pipes system allows
Salt to treat the render system like unix pipes. This new system enables sls
files to be passed through specific render engines. While the default renderer
is still recommended, different engines can now be more easily merged. So to
pipe the output of Mako used in YAML use this shebang line:
.sp
#!mako|yaml
.SS Salt Key Overhaul
.sp
The Salt Key system was originally developed as only a CLI interface, but as
time went on it was pressed into becoming a clumsy API. This release marks a
complete overhaul of Salt Key. Salt Key has been rewritten to function purely
from an API and to use the outputter system. The benefit here is that the
outputter system works much more cleanly with Salt Key now, and the internals
of Salt Key can be used much more cleanly.
.SS Modular Outputters
.sp
The outputter system is now loaded in a modular way. This means that output
systems can be more easily added by dropping a python file down on the master
that contains the function \fIoutput\fP\&.
.SS Gzip from Fileserver
.sp
Gzip compression has been added as an option to the cp.get_file and cp.get_dir
commands. This will make file transfers more efficient and faster, especially
over slower network links.
.SS Unified Module Configuration
.sp
In past releases of Salt, the minions needed to be configured for certain
modules to function. This was difficult because it required pre\-configuring the
minions. 0.10.5 changes this by making all module configs on minions search the
master config file for values.
.sp
Now if a single database server is needed, then it can be defined in the master
config and all minions will become aware of the configuration value.
.SS Salt Call Enhancements
.sp
The \fBsalt\-call\fP command has been updated in a few ways. Now, \fBsalt\-call\fP
can take the \-\-return option to send the data to a returner. Also,
\fBsalt\-call\fP now reports executions in the minion proc system, this allows the
master to be aware of the operation salt\-call is running.
.SS Death to pub_refresh and sub_timeout
.sp
The old configuration values \fIpub_refresh\fP and \fIsub_timeout\fP have been removed.
These options were in place to alleviate problems found in earlier versions of
ZeroMQ which have since been fixed. The continued use of these options has
proven to cause problems with message passing and have been completely removed.
.SS Git Revision Versions
.sp
When running Salt directly from git (for testing or development, of course)
it has been difficult to know exactly what code is being executed. The new
versioning system will detect the git revision when building and how many
commits have been made since the last release. A release from git will look
like this:
.sp
0.10.4\-736\-gec74d69
.SS Svn Module Addition
.sp
Anthony Cornehl (twinshadow) contributed a module that adds Subversion support
to Salt.  This great addition helps round out Salt\(aqs VCS support.
.SS Noteworthy Changes
.SS Arch Linux Defaults to Systemd
.sp
Arch Linux recently changed to use systemd by default and discontinued support
for init scripts. Salt has followed suit and defaults to systemd now for
managing services in Arch.
.SS Salt, Salt Cloud and Openstack
.sp
With the releases of Salt 0.10.5 and Salt Cloud 0.8.2, OpenStack becomes the
first (non\-OS) piece of software to include support both on the user level
(with Salt Cloud) and the admin level (with Salt). We are excited to continue
to extend support of other platforms at this level.
.SS Salt 0.11.0 Release Notes
.INDENT 0.0
.TP
.B release
2012\-12\-14
.UNINDENT
.sp
Salt 0.11.0 is here, with some highly sought after and exciting features.
These features include the new overstate system, the reactor system, a new
state run scope component called __context__, the beginning of the search
system (still needs a great deal of work), multiple package states, the MySQL
returner and a better system to arbitrarily reference outputters.
.sp
It is also noteworthy that we are changing how we mark release numbers. For the
life of the project we have been pushing every release with features and fixes
as point releases. We will now be releasing point releases for only bug fixes
on a more regular basis and major feature releases on a slightly less regular
basis. This means that the next release will be a bugfix only release with a
version number of 0.11.1. The next feature release will be named 0.12.0 and
will mark the end of life for the 0.11 series.
.SS Major Features
.SS OverState
.sp
The overstate system is a simple way to manage rolling state executions across
many minions. The overstate allows for a state to depend on the successful
completion of another state.
.SS Reactor System
.sp
The new reactor system allows for a reactive logic engine to be created which
can respond to events within a salted environment. The reactor system uses sls
files to match events fired on the master with actions, enabling Salt
to react to problems in an infrastructure.
.sp
Your load\-balanced group of webservers is under extra load? Spin up a new VM
and add it to the group. Your fileserver is filling up? Send a notification to
your sysadmin on call. The possibilities are endless!
.SS Module Context
.sp
A new component has been added to the module loader system. The module context
is a data structure that can hold objects for a given scope within the module.
.sp
This allows for components that are initialized to be stored in a persistent
context which can greatly speed up ongoing connections. Right now the best
example can be found in the \fIcp\fP execution module.
.SS Multiple Package Management
.sp
A long desired feature has been added to package management. By definition Salt
States have always installed packages one at a time. On most platforms this is
not the fastest way to install packages. Erik Johnson, aka terminalmage, has
modified the package modules for many providers and added new capabilities to
install groups of packages. These package groups can be defined as a list of
packages available in repository servers:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python_pkgs:
  pkg.installed:
    \- pkgs:
      \- python\-mako
      \- whoosh
      \- python\-git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or specify based on the location of specific packages:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python_pkgs:
  pkg.installed:
    \- sources:
      \- python\-mako: http://some\-rpms.org/python\-mako.rpm
      \- whoosh: salt://whoosh/whoosh.rpm
      \- python\-git: ftp://companyserver.net/python\-git.rpm
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Search System
.sp
The bones to the search system have been added. This is a very basic interface
that allows for search backends to be added as search modules. The first
supported search module is the whoosh search backend. Right now only the basic
paths for the search system are in place, making this very experimental.
Further development will involve improving the search routines and index
routines for whoosh and other search backends.
.sp
The search system has been made to allow for searching through all of the state
and pillar files, configuration files and all return data from minion
executions.
.SS Notable Changes
.sp
All previous versions of Salt have shared many directories between the master
and minion. The default locations for keys, cached data and sockets has been
shared by master and minion. This has created serious problems with running a
master and a minion on the same systems. 0.11.0 changes the defaults to be
separate directories. Salt will also attempt to migrate all of the old key data
into the correct new directories, but if it is not successful it may need to be
done manually. If your keys exhibit issues after updating make sure that they
have been moved from \fB/etc/salt/pki\fP to \fB/etc/salt/pki/{master,minion}\fP\&.
.sp
The old setup will look like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/salt/pki
|\-\- master.pem
|\-\- master.pub
|\-\- minions
|   \(ga\-\- ragnarok.saltstack.net
|\-\- minions_pre
|\-\- minion.pem
|\-\- minion.pub
|\-\- minion_master.pub
|\-\- minions_pre
\(ga\-\- minions_rejected
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
With the accepted minion keys in \fB/etc/salt/pki/minions\fP, the new setup
places the accepted minion keys in \fB/etc/salt/pki/master/minions\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/salt/pki
|\-\- master
|   |\-\- master.pem
|   |\-\- master.pub
|   |\-\- minions
|   |   \(ga\-\- ragnarok.saltstack.net
|   |\-\- minions_pre
|   \(ga\-\- minions_rejected
|\-\- minion
|   |\-\- minion.pem
|   |\-\- minion.pub
|   \(ga\-\- minion_master.pub
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Salt 0.11.1 Release Notes
.INDENT 0.0
.TP
.B release
2012\-12\-19
.UNINDENT
.SS Salt 0.12.0 Release Notes
.INDENT 0.0
.TP
.B release
2013\-01\-15
.UNINDENT
.sp
Another feature release of Salt is here! Some exciting additions are included
with more ways to make salt modular and even easier management of the salt
file server.
.SS Major Features
.SS Modular Fileserver Backend
.sp
The new modular fileserver backend allows for any external system to be used as
a salt file server. The main benefit here is that it is now possible to tell
the master to directly use a git remote location, or many git remote locations,
automatically mapping git branches and tags to salt environments.
.SS Windows is First Class!
.sp
A new Salt Windows installer is now available! Much work has been put in to
improve Windows support. With this much easier method of getting Salt on your
Windows machines, we hope even more development and progress will occur. Please
file bug reports on the Salt GitHub repo issue tracker so we can continue
improving.
.sp
One thing that is missing on Windows that Salt uses extensively is a software
package manager and a software package repository. The Salt pkg state allows
sys admins to install software across their infrastructure and across operating
systems. Software on Windows can now be managed in the same way. The SaltStack
team built a package manager that interfaces with the standard Salt pkg module
to allow for installing and removing software on Windows. In addition, a
software package repository has been built on top of the Salt fileserver. A
small YAML file provides the information necessary for the package manager to
install and remove software.
.sp
An interesting feature of the new Salt Windows software package repository is
that one or more remote git repositories can supplement the master\(aqs local
repository. The repository can point to software on the master\(aqs fileserver or
on an HTTP, HTTPS, or ftp server.
.SS New Default Outputter
.sp
Salt displays data to the terminal via the outputter system. For a long time
the default outputter for Salt has been the python pretty print library.  While
this has been a generally reasonable outputter, it did have many failings.  The
new default outputter is called \(dqnested\(dq, it recursively scans return data
structures and prints them out cleanly.
.sp
If the result of the new nested outputter is not desired any other outputter
can be used via the \-\-out option, or the output option can be set in the master
and minion configs to change the default outputter.
.SS Internal Scheduler
.sp
The internal Salt scheduler is a new capability which allows for functions to
be executed at given intervals on the minion, and for runners to be executed
at given intervals on the master. The scheduler allows for sequences
such as executing state runs (locally on the minion or remotely via an
overstate) or continually gathering system data to be run at given intervals.
.sp
The configuration is simple, add the schedule option to the master or minion
config and specify jobs to run, this in the master config will execute the
state.over runner every 60 minutes:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  overstate:
    function: state.over
    minutes: 60
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example for the minion configuration will execute a highstate every 30
minutes:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
schedule:
  highstate:
    function: state.highstate
    minutes: 30
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Optional DSL for SLS Formulas
.sp
Jack Kuan, our renderer expert, has created something that is astonishing.
Salt, now comes with an optional Python based DSL, this is a very powerful
interface that makes writing SLS files in pure python easier than it was
with the raw py renderer. As usual this can be used with the renderer shebang
line, so a single sls can be written with the DSL if pure python power is
needed while keeping other sls files simple with YAML.
.SS Set Grains Remotely
.sp
A new execution function and state module have been added that allows for
grains to be set on the minion. Now grains can be set via a remote execution or
via states. Use the \fIgrains.present\fP state or the \fIgrains.setval\fP execution
functions.
.SS Gentoo Additions
.sp
Major additions to Gentoo specific components have been made. The encompasses
executions modules and states ranging from supporting the make.conf file to
tools like layman.
.SS Salt 0.12.1 Release Notes
.INDENT 0.0
.TP
.B release
2013\-01\-21
.UNINDENT
.SS Salt 0.13.0 Release Notes
.INDENT 0.0
.TP
.B release
2013\-02\-12
.UNINDENT
.sp
The lucky number 13 has turned the corner! From CLI notifications when quitting
a salt command, to substantial improvements on Windows, Salt 0.13.0 has
arrived!
.SS Major Features
.SS Improved file.recurse Performance
.sp
The file.recurse system has been deployed and used in a vast array of
situations. Fixes to the file state and module have led towards opening up
new ways of running file.recurse to make it faster. Now the file.recurse
state will download fewer files and will run substantially faster.
.SS Windows Improvements
.sp
Minion stability on Windows has improved. Many file operations, including
file.recurse, have been fixed and improved. The network module works better, to
include network.interfaces. Both 32bit and 64bit installers are now available.
.SS Nodegroup Targeting in Peer System
.sp
In the past, nodegroups were not available for targeting via the peer system.
This has been fixed, allowing the new nodegroup expr_form argument for the
publish.publish function:
.INDENT 0.0
.INDENT 3.5
salt\-call publish.publish group1 test.ping expr_form=nodegroup
.UNINDENT
.UNINDENT
.SS Blacklist Additions
.sp
Additions allowing more granular blacklisting are available in 0.13.0. The
ability to blacklist users and functions in client_acl have been added, as
well as the ability to exclude state formulas from the command line.
.SS Command Line Pillar Embedding
.sp
Pillar data can now be embedded on the command line when calling \fBstate.sls\fP
and \fBstate.highstate\fP\&. This allows for on the fly changes or settings to
pillar and makes parameterizing state formulas even easier. This is done via
the keyword argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.highstate pillar=\(aq{\(dqcheese\(dq: \(dqspam\(dq}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above example will extend the existing pillar to hold the \fBcheese\fP key
with a value of \fBspam\fP\&. If the \fBcheese\fP key is already specified in the
minion\(aqs pillar then it will be overwritten.
.SS CLI Notifications
.sp
In the past hitting ctrl\-C and quitting from the \fBsalt\fP command would just
drop to a shell prompt, this caused confusion with users who expected the
remote executions to also quit. Now a message is displayed showing what
command can be used to track the execution and what the job id is for the
execution.
.SS Version Specification in Multiple\-Package States
.sp
Versions can now be specified within multiple\-package \fI\%pkg.installed\fP states. An example can be found below:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mypkgs:
  pkg.installed:
    \- pkgs:
      \- foo
      \- bar: 1.2.3\-4
      \- baz
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Noteworthy Changes
.sp
The configuration subsystem in Salt has been overhauled to make the \fBopts\fP
dict used by Salt applications more portable, the problem is that this is an
incompatible change with salt\-cloud, and salt\-cloud will need to be updated
to the latest git to work with Salt 0.13.0. Salt Cloud 0.8.5 will also require
Salt 0.13.0 or later to function.
.sp
The SaltStack team is sorry for the inconvenience here, we work hard to make
sure these sorts of things do not happen, but sometimes hard changes get in.
.SS Salt 0.13.1 Release Notes
.INDENT 0.0
.TP
.B release
2013\-02\-15
.UNINDENT
.SS Salt 0.13.2 Release Notes
.INDENT 0.0
.TP
.B release
2013\-03\-13
.UNINDENT
.SS Salt 0.13.3 Release Notes
.INDENT 0.0
.TP
.B release
2013\-03\-18
.UNINDENT
.SS Salt 0.14.0 Release Notes
.INDENT 0.0
.TP
.B release
2013\-03\-23
.UNINDENT
.sp
Salt 0.14.0 is here! This release was held up primarily by PyCon, Scale, and
illness, but has arrived! 0.14.0 comes with many new features and is breaking
ground for Salt in the area of cloud management with the introduction of Salt
providing basic cloud controller functionality.
.SS Major Features
.SS Salt \- As a Cloud Controller
.sp
This is the first primitive inroad to using Salt as a cloud controller is
available in 0.14.0. Be advised that this is alpha, only tested in a few very
small environments.
.sp
The cloud controller is built using kvm and libvirt for the hypervisors.
Hypervisors are autodetected as minions and only need to have libvirt running
and kvm installed to function. The features of the Salt cloud controller are
as follows:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Basic vm discovery and reporting
.IP \(bu 2
Creation of new virtual machines
.IP \(bu 2
Seeding virtual machines with Salt via qemu\-nbd or libguestfs
.IP \(bu 2
Live migration (shared and non shared storage)
.IP \(bu 2
Delete existing VMs
.UNINDENT
.UNINDENT
.UNINDENT
.sp
It is noteworthy that this feature is still Alpha, meaning that all rights
are reserved to change the interface if needs be in future releases!
.SS Libvirt State
.sp
One of the problems with libvirt is management of certificates needed for live
migration and cross communication between hypervisors. The new \fBlibvirt\fP
state makes the Salt Master hold a CA and manage the signing and distribution
of keys onto hypervisors, just add a call to the libvirt state in the sls
formulas used to set up a hypervisor:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
libvirt_keys:
  libvirt.keys
.ft P
.fi
.UNINDENT
.UNINDENT
.SS New get Functions
.sp
An easier way to manage data has been introduced. The pillar, grains, and config
execution modules have been extended with the new \fBget\fP function. This
function works much in the same way as the get method in a python dict, but with
an enhancement, nested dict components can be extracted using a \fI:\fP delimiter.
.sp
If a structure like this is in pillar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
foo:
  bar:
    baz: quo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Extracting it from the raw pillar in an sls formula or file template is done
this way:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ pillar[\(aqfoo\(aq][\(aqbar\(aq][\(aqbaz\(aq] }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now with the new get function the data can be safely gathered and a default
can be set allowing the template to fall back if the value is not available:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ salt[\(aqpillar.get\(aq](\(aqfoo:bar:baz\(aq, \(aqqux\(aq) }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This makes handling nested structures much easier, and defaults can be cleanly
set. This new function is being used extensively in the new formulae repository
of salt sls formulas.
.SS Salt 0.14.1 Release Notes
.INDENT 0.0
.TP
.B release
2013\-04\-13
.UNINDENT
.SS Salt 0.15.0 Release Notes
.INDENT 0.0
.TP
.B release
2013\-05\-03
.UNINDENT
.sp
The many new features of Salt 0.15.0 have arrived! Salt 0.15.0 comes with many
smaller features and a few larger ones.
.sp
These features range from better debugging tools to the new Salt Mine system.
.SS Major Features
.SS The Salt Mine
.sp
First there was the peer system, allowing for commands to be executed from a
minion to other minions to gather data live. Then there was the external job
cache for storing and accessing long term data. Now the middle ground is being
filled in with the Salt Mine. The Salt Mine is a system used to execute
functions on a regular basis on minions and then store only the most recent
data from the functions on the master, then the data is looked up via targets.
.sp
The mine caches data that is public to all minions, so when a minion posts
data to the mine all other minions can see it.
.SS IPV6 Support
.sp
0.13.0 saw the addition of initial IPV6 support but errors were encountered and
it needed to be stripped out. This time the code covers more cases and must be
explicitly enabled. But the support is much more extensive than before.
.SS Copy Files From Minions to the Master
.sp
Minions have long been able to copy files down from the master file server, but
until now files could not be easily copied from the minion up to the master.
.sp
A new function called \fBcp.push\fP can push files from the minions up to the
master server. The uploaded files are then cached on the master in the master
cachedir for each minion.
.SS Better Template Debugging
.sp
Template errors have long been a burden when writing states and pillar. 0.15.0
will now send the compiled template data to the debug log, this makes tracking
down the intermittent stage templates much easier. So running state.sls or
state.highstate with \fI\-l debug\fP will now print out the rendered templates in
the debug information.
.SS State Event Firing
.sp
The state system is now more closely tied to the master\(aqs event bus. Now when
a state fails the failure will be fired on the master event bus so that the
reactor can respond to it.
.SS Major Syndic Updates
.sp
The Syndic system has been basically re\-written. Now it runs in a completely
asynchronous way and functions primarily as an event broker. This means that
the events fired on the syndic are now pushed up to the higher level master
instead of the old method used which waited for the client libraries to
return.
.sp
This makes the syndic much more accurate and powerful, it also means that
all events fired on the syndic master make it up the pipe as well making a
reactor on the higher level master able to react to minions further
downstream.
.SS Peer System Updates
.sp
The Peer System has been updated to run using the client libraries instead
of firing directly over the publish bus. This makes the peer system much more
consistent and reliable.
.SS Minion Key Revocation
.sp
In the past when a minion was decommissioned the key needed to be manually
deleted on the master, but now a function on the minion can be used to revoke
the calling minion\(aqs key:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ salt\-call saltutil.revoke_auth
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Function Return Codes
.sp
Functions can now be assigned numeric return codes to determine if the function
executed successfully. While not all functions have been given return codes,
many have and it is an ongoing effort to fill out all functions that might
return a non\-zero return code.
.SS Functions in Overstate
.sp
The overstate system was originally created to just manage the execution of
states, but with the addition of return codes to functions, requisite logic can
now be used with respect to the overstate. This means that an overstate stage
can now run single functions instead of just state executions.
.SS Pillar Error Reporting
.sp
Previously if errors surfaced in pillar, then the pillar would consist of only
an empty dict. Now all data that was successfully rendered stays in pillar and
the render error is also made available. If errors are found in the pillar,
states will refuse to run.
.SS Using Cached State Data
.sp
Sometimes states are executed purely to maintain a specific state rather than
to update states with new configs. This is grounds for the new cached state
system. By adding \fIcache=True\fP to a state call the state will not be generated
fresh from the master but the last state data to be generated will be used.
If no previous state data is available then fresh data will be generated.
.SS Monitoring States
.sp
The new monitoring states system has been started. This is very young but
allows for states to be used to configure monitoring routines. So far only one
monitoring state is available, the \fBdisk.status\fP state. As more capabilities
are added to Salt UI the monitoring capabilities of Salt will continue to be
expanded.
.SS Salt 0.15.1 Release Notes
.INDENT 0.0
.TP
.B release
2013\-05\-08
.UNINDENT
.sp
The 0.15.1 release has been posted, this release includes fixes to a number of
bugs in 0.15.1 and a three security patches.
.SS Security Updates
.sp
A number of security issues have been resolved via the 0.15.1 release.
.SS Path Injection in Minion IDs
.sp
Salt masters did not properly validate the id of a connecting minion. This can
lead to an attacker uploading files to the master in arbitrary locations.
In particular this can be used to bypass the manual validation of new unknown
minions. Exploiting this vulnerability does not require authentication.
.sp
This issue affects all known versions of Salt.
.sp
This issue was reported by Ronald Volgers.
.SS Patch
.sp
The issue is fixed in Salt 0.15.1. Updated packages are available in the usual
locations.
.sp
Specific commits:
.sp
\fI\%https://github.com/saltstack/salt/commit/5427b9438e452a5a8910d9128c6aafb45d8fd5d3\fP
.sp
\fI\%https://github.com/saltstack/salt/commit/7560908ee62351769c3cd43b03d74c1ca772cc52\fP
.sp
\fI\%https://github.com/saltstack/salt/commit/e200b8a7ff53780124e08d2bdefde7587e52bfca\fP
.SS RSA Key Generation Fault
.sp
RSA key generation was done incorrectly, leading to very insecure keys. It is
recommended to regenerate all RSA keys.
.sp
This issue can be used to impersonate Salt masters or minions, or decrypt any
transferred data.
.sp
This issue can only be exploited by attackers who are able to observe or modify
traffic between Salt minions and the legitimate Salt master.
.sp
A tool was included in 0.15.1 to assist in mass key regeneration, the
manage.regen_keys runner.
.sp
This issue affects all known versions of Salt.
.sp
This issue was reported by Ronald Volgers.
.SS Patch
.sp
The issue is fixed in Salt 0.15.1. Updated packages are available in the usual
locations.
.sp
Specific commits:
.sp
\fI\%https://github.com/saltstack/salt/commit/5dd304276ba5745ec21fc1e6686a0b28da29e6fc\fP
.SS Command Injection Via ext_pillar
.sp
Arbitrary shell commands could be executed on the master by an authenticated
minion through options passed when requesting a pillar.
.sp
Ext pillar options have been restricted to only allow safe external pillars to
be called when prompted by the minion.
.sp
This issue affects Salt versions from 0.14.0 to 0.15.0.
.sp
This issue was reported by Ronald Volgers.
.SS Patch
.sp
The issue is fixed in Salt 0.15.1. Updated packages are available in the usual locations.
.sp
Specific commits:
.sp
\fI\%https://github.com/saltstack/salt/commit/43d8c16bd26159d827d1a945c83ac28159ec5865\fP
.SS Salt 0.15.2 Release Notes
.INDENT 0.0
.TP
.B release
2013\-05\-29
.UNINDENT
.SS Salt 0.15.3 Release Notes
.INDENT 0.0
.TP
.B release
2013\-06\-01
.UNINDENT
.SS Salt 0.16.0 Release Notes
.INDENT 0.0
.TP
.B release
2013\-07\-01
.UNINDENT
.sp
The 0.16.0 release is an exciting one, with new features in master redundancy,
and a new, powerful requisite.
.SS Major Features
.SS Multi\-Master
.sp
This new capability allows for a minion to be actively connected to multiple
salt masters at the same time. This allows for multiple masters to send out commands
to minions and for minions to automatically reconnect to masters that have gone
down. A tutorial is available to help get started here:
.sp
\fI\%Multi Master Tutorial\fP
.SS Prereq, the New Requisite
.sp
The new \fIprereq\fP requisite is very powerful! It allows for states to execute
based on a state that is expected to make changes in the future. This allows
for a change on the system to be preempted by another execution. A good example
is needing to shut down a service before modifying files associated with it,
allowing, for instance, a webserver to be shut down allowing a load balancer to
stop sending requests while server side code is updated. In this case, the
prereq will only run if changes are expected to happen in the prerequired
state, and the prerequired state will always run after the prereq state and
only if the prereq state succeeds.
.SS Peer System Improvements
.sp
The peer system has been revamped to make it more reliable, faster, and like
the rest of Salt, async. The peer calls when an updated minion and master are
used together will be much faster!
.SS Relative Includes
.sp
The ability to include an sls relative to the defined sls has been added, the
new syntax id documented here:
.sp
\fI\%Includes\fP
.SS More State Output Options
.sp
The \fBstate_output\fP option in the past only supported \fIfull\fP and \fIterse\fP,
0.16.0 add the \fImixed\fP and \fIchanges\fP modes further refining how states are sent
to users\(aq eyes.
.SS Improved Windows Support
.sp
Support for Salt on Windows continues to improve. Software management on
Windows has become more seamless with Linux/UNIX/BSD software management.
Installed software is now recognized by the short names defined in the
\fI\%repository SLS\fP\&. This makes it
possible to run \fBsalt \(aq*\(aq pkg.version firefox\fP and get back results from
Windows and non\-Windows minions alike.
.sp
When templating files on Windows, Salt will now correctly use Windows
appropriate line endings. This makes it much easier to edit and consume files
on Windows.
.sp
When using the cmd state the \fBshell\fP option now allows for specifying
Windows Powershell as an alternate shell to execute cmd.run and cmd.script.
This opens up Salt to all the power of Windows Powershell and its advanced
Windows management capabilities.
.sp
Several fixes and optimizations were added for the Windows networking modules,
especially when working with IPv6.
.sp
A system module was added that makes it easy to restart and shutdown Windows
minions.
.sp
The Salt Minion will now look for its config file in \fBc:\esalt\econf\fP by
default. This means that it\(aqs no longer necessary to specify the \fB\-c\fP option
to specify the location of the config file when starting the Salt Minion on
Windows in a terminal.
.SS Multiple Targets for pkg.removed, pkg.purged States
.sp
Both \fI\%pkg.removed\fP and \fI\%pkg.purged\fP now support the \fBpkgs\fP argument, which allow for
multiple packages to be targeted in a single state. This, as in
\fI\%pkg.installed\fP, helps speed up these
states by reducing the number of times that the package management tools (apt,
yum, etc.) need to be run.
.SS Random Times in Cron States
.sp
The temporal parameters in \fI\%cron.present\fP
states (minute, hour, etc.) can now be randomized by using \fBrandom\fP instead
of a specific value. For example, by using the \fBrandom\fP keyword in the
\fBminute\fP parameter of a cron state, the same cron job can be pushed to
hundreds or thousands of hosts, and they would each use a randomly\-generated
minute. This can be helpful when the cron job accesses a network resource, and
it is not desirable for all hosts to run the job concurrently.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/path/to/cron/script:
  cron.present:
    \- user: root
    \- minute: random
    \- hour: 2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Since Salt assumes a value of \fB*\fP for unspecified temporal parameters, adding
a parameter to the state and setting it to \fBrandom\fP will change that value
from \fB*\fP to a randomized numeric value. However, if that field in the cron
entry on the minion already contains a numeric value, then using the \fBrandom\fP
keyword will not modify it.
.SS Confirmation Prompt on Key Acceptance
.sp
When accepting new keys with \fBsalt\-key \-a minion\-id\fP or \fBsalt\-key \-A\fP,
there is now a prompt that will show the affected keys and ask for confirmation
before proceeding. This prompt can be bypassed using the \fB\-y\fP or \fB\-\-yes\fP
command line argument, as with other \fBsalt\-key\fP commands.
.SS Support for Setting Password Hashes on BSD Minions
.sp
FreeBSD, NetBSD, and OpenBSD all now support setting passwords in
\fI\%user.present\fP states.
.SS Salt 0.16.1 Release Notes
.INDENT 0.0
.TP
.B release
2013\-07\-29
.UNINDENT
.SS Salt 0.16.2 Release Notes
.INDENT 0.0
.TP
.B release
2013\-08\-01
.UNINDENT
.sp
Version 0.16.2 is a bugfix release for \fI\%0.16.0\fP,
and contains a number of fixes.
.SS Windows
.INDENT 0.0
.IP \(bu 2
Only allow Administrator\(aqs group and SYSTEM user access to C:\esalt. This
eliminates a race condition where a non\-admin user could modify a template or
managed file before it is executed by the minion (which is running as an
elevated user), thus avoiding a potential escalation of privileges. (\fI\%issue 6361\fP)
.UNINDENT
.SS Grains
.INDENT 0.0
.IP \(bu 2
Fixed detection of \fBvirtual\fP grain on OpenVZ hardware nodes
.IP \(bu 2
Gracefully handle lsb_release data when it is enclosed in quotes
.IP \(bu 2
LSB grains are now prefixed with \fBlsb_distrib_\fP instead of simply \fBlsb_\fP\&.
The old naming is not preserved, so SLS may be affected.
.IP \(bu 2
Improved grains detection on MacOS
.UNINDENT
.SS Pillar
.INDENT 0.0
.IP \(bu 2
Don\(aqt try to load \fI\%git_pillar\fP
if not enabled in master config (\fI\%issue 6052\fP)
.IP \(bu 2
Functions \fI\%pillar.item\fP and
\fI\%pillar.items\fP added for parity with
\fI\%grains.item\fP/\fI\%grains.items\fP\&. The old function \fBpillar.data\fP is preserved
for backwards compatibility.
.IP \(bu 2
Fixed minion traceback when Pillar SLS is malformed (\fI\%issue 5910\fP)
.UNINDENT
.SS Peer Publishing
.INDENT 0.0
.IP \(bu 2
More gracefully handle improperly quoted publish commands (\fI\%issue 5958\fP)
.IP \(bu 2
Fixed traceback when timeout specified via the CLI fo \fI\%publish.publish\fP, \fI\%publish.full_data\fP (\fI\%issue 5959\fP)
.IP \(bu 2
Fixed unintended change in output of \fI\%publish.publish\fP (\fI\%issue 5928\fP)
.UNINDENT
.SS Minion
.INDENT 0.0
.IP \(bu 2
Fixed salt\-key usage in minionswarm script
.IP \(bu 2
Quieted warning about \fBSALT_MINION_CONFIG\fP environment variable on
minion startup and for CLI commands run via \fBsalt\-call\fP (\fI\%issue 5956\fP)
.IP \(bu 2
Added minion config parameter \fI\%random_reauth_delay\fP to stagger
re\-auth attempts when the minion is waiting for the master to approve its
public key. This helps prevent SYN flooding in larger environments.
.UNINDENT
.SS User/Group Management
.INDENT 0.0
.IP \(bu 2
Implement previously\-ignored \fBunique\fP option for \fI\%user.present\fP states in FreeBSD
.IP \(bu 2
Report in state output when a \fI\%group.present\fP state attempts to use a gid in use by another
group
.IP \(bu 2
Fixed regression that prevents a \fI\%user.present\fP state to set the password hash to the system
default (i.e. an unset password)
.IP \(bu 2
Fixed multiple \fI\%group.present\fP states with
the same group (\fI\%issue 6439\fP)
.UNINDENT
.SS File Management
.INDENT 0.0
.IP \(bu 2
Fixed file.mkdir setting incorrect permissions (\fI\%issue 6033\fP)
.IP \(bu 2
Fixed cleanup of source files for templates when \fB/tmp\fP is in file_roots
(\fI\%issue 6118\fP)
.IP \(bu 2
Fixed caching of zero\-byte files when a non\-empty file was previously cached
at the same path
.IP \(bu 2
Added HTTP authentication support to the cp module (\fI\%issue 5641\fP)
.IP \(bu 2
Diffs are now suppressed when binary files are changed
.UNINDENT
.SS Package/Repository Management
.INDENT 0.0
.IP \(bu 2
Fixed traceback when there is only one target for \fI\%pkg.latest\fP states
.IP \(bu 2
Fixed regression in detection of virtual packages (apt)
.IP \(bu 2
Limit number of pkg database refreshes to once per \fI\%state.sls\fP/\fI\%state.highstate\fP
.IP \(bu 2
YUM: Allow 32\-bit packages with arches other than i686 to be managed on
64\-bit systems (\fI\%issue 6299\fP)
.IP \(bu 2
Fixed incorrect reporting in pkgrepo.managed states (\fI\%issue 5517\fP)
.IP \(bu 2
Fixed 32\-bit binary package installs on 64\-bit RHEL\-based distros, and added
proper support for 32\-bit packages on 64\-bit Debian\-based distros
(\fI\%issue 6303\fP)
.IP \(bu 2
Fixed issue where requisites were inadvertently being put into YUM repo files
(\fI\%issue 6471\fP)
.UNINDENT
.SS Service Management
.INDENT 0.0
.IP \(bu 2
Fixed inaccurate reporting of results in \fI\%service.running\fP states when the service fails to start
(\fI\%issue 5894\fP)
.IP \(bu 2
Fixed handling of custom initscripts in RHEL\-based distros so that they are
immediately available, negating the need for a second state run to manage the
service that the initscript controls
.UNINDENT
.SS Networking
.INDENT 0.0
.IP \(bu 2
Function network.hwaddr renamed to \fI\%network.hw_addr\fP to match \fI\%network.ip_addrs\fP and \fI\%network.ip_addrs6\fP\&. All three functions also now work without
the underscore in the name, as well.
.IP \(bu 2
Fixed traceback in \fI\%bridge.show\fP when
interface is not present (\fI\%issue 6326\fP)
.UNINDENT
.SS SSH
.INDENT 0.0
.IP \(bu 2
Fixed incorrect result reporting for some \fI\%ssh_known_hosts.present\fP states
.IP \(bu 2
Fixed inaccurate reporting when \fI\%ssh_auth.present\fP states are run with \fBtest=True\fP, when
rsa/dss is used for the \fBenc\fP param instead of ssh\-rsa/ssh\-dss
(\fI\%issue 5374\fP)
.UNINDENT
.SS pip
.INDENT 0.0
.IP \(bu 2
Properly handle \fB\-f\fP lines in pip freeze output
.IP \(bu 2
Fixed regression in pip.installed states with specifying a requirements file
(\fI\%issue 6003\fP)
.IP \(bu 2
Fixed use of \fBeditable\fP argument in \fBpip.installed\fP states (\fI\%issue 6025\fP)
.IP \(bu 2
Deprecated \fBrunas\fP parameter in execution function calls, in favor of
\fBuser\fP
.UNINDENT
.SS MySQL
.INDENT 0.0
.IP \(bu 2
Allow specification of \fI\%MySQL\fP
connection arguments via the CLI, overriding/bypassing minion config params
.IP \(bu 2
Allow \fI\%mysql_user.present\fP states to
set a passwordless login (\fI\%issue 5550\fP)
.IP \(bu 2
Fixed endless loop when \fI\%mysql.processlist\fP is run (\fI\%issue 6297\fP)
.UNINDENT
.SS PostgreSQL
.INDENT 0.0
.IP \(bu 2
Fixed traceback in \fI\%postgres.user_list\fP (\fI\%issue 6352\fP)
.UNINDENT
.SS Miscellaneous
.INDENT 0.0
.IP \(bu 2
Don\(aqt allow \fI\%npm states\fP to be used if
\fI\%npm module\fP is not available
.IP \(bu 2
Fixed \fI\%alternatives.install\fP states
for which the target is a symlink (\fI\%issue 6162\fP)
.IP \(bu 2
Fixed traceback in \fI\%sysbench module\fP (\fI\%issue 6175\fP)
.IP \(bu 2
Fixed traceback in job cache
.IP \(bu 2
Fixed tempfile cleanup for windows
.IP \(bu 2
Fixed issue where SLS files using the \fI\%pydsl renderer\fP were not being run
.IP \(bu 2
Fixed issue where returners were being passed incorrect information
(\fI\%issue 5518\fP)
.IP \(bu 2
Fixed traceback when numeric args are passed to \fI\%cmd.script\fP states
.IP \(bu 2
Fixed bug causing \fI\%cp.get_dir\fP to return more
directories than expected (\fI\%issue 6048\fP)
.IP \(bu 2
Fixed traceback when \fI\%supervisord.running\fP states are run with \fBtest=True\fP
(\fI\%issue 6053\fP)
.IP \(bu 2
Fixed tracebacks when Salt encounters problems running rbenv (\fI\%issue 5888\fP)
.IP \(bu 2
Only make the \fI\%monit module\fP
available if monit binary is present (\fI\%issue 5871\fP)
.IP \(bu 2
Fixed incorrect behavior of \fBimg.mount_image\fP
.IP \(bu 2
Fixed traceback in \fI\%tomcat.deploy_war\fP
in Windows
.IP \(bu 2
Don\(aqt re\-write /etc/fstab if mount fails
.IP \(bu 2
Fixed tracebacks when Salt encounters problems running gem (\fI\%issue 5886\fP)
.IP \(bu 2
Fixed incorrect behavior of \fI\%selinux.boolean\fP states (\fI\%issue 5912\fP)
.IP \(bu 2
\fI\%RabbitMQ\fP: Quote passwords to
avoid symbols being interpolated by the shell (\fI\%issue 6338\fP)
.IP \(bu 2
Fixed tracebacks in \fI\%extfs.mkfs\fP and
\fI\%extfs.tune\fP (\fI\%issue 6462\fP)
.IP \(bu 2
Fixed a regression with the \fI\%module.run\fP state
where the \fBm_name\fP and \fBm_fun\fP arguments were being ignored (\fI\%issue 6464\fP)
.UNINDENT
.SS Salt 0.16.3 Release Notes
.INDENT 0.0
.TP
.B release
2013\-08\-09
.UNINDENT
.sp
Version 0.16.3 is another bugfix release for \fI\%0.16.0\fP\&. The changes include:
.INDENT 0.0
.IP \(bu 2
Various documentation fixes
.IP \(bu 2
Fix proc directory regression (\fI\%issue 6502\fP)
.IP \(bu 2
Properly detect \fI\%Linaro\fP Linux (\fI\%issue 6496\fP)
.IP \(bu 2
Fix regressions in \fI\%mount.mounted\fP
(\fI\%issue 6522\fP, \fI\%issue 6545\fP)
.IP \(bu 2
Skip malformed state requisites (\fI\%issue 6521\fP)
.IP \(bu 2
Fix regression in gitfs from bad import
.IP \(bu 2
Fix for watching prereq states (including recursive requisite error)
(\fI\%issue 6057\fP)
.IP \(bu 2
Fix mod_watch not overriding prereq (\fI\%issue 6520\fP)
.IP \(bu 2
Don\(aqt allow functions which compile states to be called within states
(\fI\%issue 5623\fP)
.IP \(bu 2
Return error for malformed top.sls (\fI\%issue 6544\fP)
.IP \(bu 2
Fix traceback in \fI\%mysql.query\fP
.IP \(bu 2
Fix regression in binary package installation for 64\-bit packages
on Debian\-based Linux distros (\fI\%issue 6563\fP)
.IP \(bu 2
Fix traceback caused by running \fI\%cp.push\fP without
having set \fI\%file_recv\fP in the master config file
.IP \(bu 2
Fix scheduler configuration in pillar (\fI\%issue 6201\fP)
.UNINDENT
.SS Salt 0.16.4 Release Notes
.INDENT 0.0
.TP
.B release
2013\-09\-07
.UNINDENT
.sp
Version 0.16.4 is another bugfix release for \fI\%0.16.0\fP, likely to be the last before 0.17.0 is released.
The changes include:
.INDENT 0.0
.IP \(bu 2
Multiple documentation improvements/additions
.IP \(bu 2
Added the \fBosfinger\fP and \fBosarch\fP grains
.IP \(bu 2
Properly handle 32\-bit packages for debian32 on x86_64 (\fI\%issue 6607\fP)
.IP \(bu 2
Fix regression in yum package installation in CentOS 5 (\fI\%issue 6677\fP)
.IP \(bu 2
Fix bug in \fI\%hg.latest\fP state that would
erroneously delete directories (\fI\%issue 6661\fP)
.IP \(bu 2
Fix bug related to pid not existing for \fI\%ps.top\fP
(\fI\%issue 6679\fP)
.IP \(bu 2
Fix regression in \fI\%MySQL returner\fP
(\fI\%issue 6695\fP)
.IP \(bu 2
Fix IP addresses grains (\fBipv4\fP and \fBipv6\fP) to include all addresses
(\fI\%issue 6656\fP)
.IP \(bu 2
Fix regression preventing authenticated FTP (\fI\%issue 6733\fP)
.IP \(bu 2
Fix setting password for windows users (\fI\%issue 6824\fP)
.IP \(bu 2
Fix \fI\%file.contains\fP on values YAML parses
as non\-string (\fI\%issue 6817\fP)
.IP \(bu 2
Fix \fI\%file.get_gid\fP, \fI\%file.get_uid\fP, and \fI\%file.chown\fP
for broken symlinks (\fI\%issue 6826\fP)
.IP \(bu 2
Fix comment for service reloads in service state (\fI\%issue 6851\fP)
.UNINDENT
.SS Salt 0.17.0 Release Notes
.INDENT 0.0
.TP
.B release
2013\-09\-26
.UNINDENT
.sp
The 0.17.0 release is a very exciting release of Salt, this brings to Salt
some very powerful new features and advances. The advances range from the
state system to the test suite, covering new transport capabilities and
making states easier and more powerful, to extending Salt Virt and much more!
.sp
The 0.17.0 release will also be the last release of Salt to follow the old
0.XX.X numbering system, the next release of Salt will change the numbering to
be date based following this format:
.sp
<Year>.<Month>.<Minor>
.sp
So if the release happens in November of 2013 the number will be 13.11.0, the
first bugfix release will be 13.11.1 and so forth.
.SS Major Features
.SS Halite
.sp
The new Halite web GUI is now available on PyPI. A great deal of work has
been put into Halite to make it fully event driven and amazingly fast. The
Halite UI can be started from within the Salt Master (after being installed
from PyPI), or standalone, and does not require an external database to run.
It is very lightweight!
.sp
This initial release of Halite is primarily the framework for the UI and the
communication systems, making it easy to extend and build the UI up. It
presently supports watching the event bus and firing commands over Salt.
.sp
At this time, Halite is not available as a package, but installation
documentation is available at:
\fI\%https://docs.saltproject.io/topics/tutorials/halite.html\fP
.sp
Halite is, like the rest of Salt, Open Source!
.sp
Much more will be coming in the future of Halite!
.SS Salt SSH
.sp
The new \fBsalt\-ssh\fP command has been added to Salt. This system allows for
remote execution and states to be run over ssh. The benefit here being, that
salt can run relying only on the ssh agent, rather than requiring a minion
to be deployed.
.sp
The \fBsalt\-ssh\fP system runs states in a compatible way as Salt and states
created and run with salt\-ssh can be moved over to a standard salt deployment
without modification.
.sp
Since this is the initial release of salt\-ssh, there is plenty of room for
improvement, but it is fully operational, not just a bootstrap tool.
.SS Rosters
.sp
Salt is designed to have the minions be aware of the master and the master does
not need to be aware of the location of the minions. The new salt roster system
was created and designed to facilitate listing the targets for salt\-ssh.
.sp
The roster system, like most of Salt, is a plugin system, allowing for the list
of systems to target to be derived from any pluggable backend. The rosters
shipping with 0.17.0 are flat and scan. Flat is a file which is read in via the
salt render system and the scan roster does simple network scanning to discover
ssh servers.
.SS State Auto Order
.sp
This is a major change in how states are evaluated in Salt. State Auto Order
is a new feature that makes states get evaluated and executed in the order in
which they are defined in the sls file. This feature makes it very easy to
see the finite order in which things will be executed, making Salt now, fully
imperative AND fully declarative.
.sp
The requisite system still takes precedence over the order in which states are
defined, so no existing states should break with this change. But this new
feature can be turned off by setting \fBstate_auto_order: False\fP in the master
config, thus reverting to the old lexicographical order.
.SS state.sls Runner
.sp
The \fBstate.sls\fP runner has been created to allow for a more powerful system
for orchestrating state runs and function calls across the salt minions. This
new system uses the state system for organizing executions.
.sp
This allows for states to be defined that are executed on the master to call
states on minions via \fBsalt\-run state.sls\fP\&.
.SS Salt Thin
.sp
Salt Thin is an exciting new component of Salt, this is the ability to execute
Salt routines without any transport mechanisms installed, it is a pure python
subset of Salt.
.sp
Salt Thin does not have any networking capability, but can be dropped into any
system with Python installed and then \fBsalt\-call\fP can be called directly. The
Salt Thin system, is used by the \fBsalt\-ssh\fP command, but can still be used to
just drop salt somewhere for easy use.
.SS Event Namespacing
.sp
Events have been updated to be much more flexible. The tags in events have all
been namespaced allowing easier tracking of event names.
.SS Mercurial Fileserver Backend
.sp
The popular git fileserver backend has been joined by the mercurial fileserver
backend, allowing the state tree to be managed entirely via mercurial.
.SS External Logging Handlers
.sp
The external logging handler system allows for Salt to directly hook into any
external logging system. Currently supported are sentry and logstash.
.SS Jenkins Testing
.sp
The testing systems in Salt have been greatly enhanced, tests for salt are now
executed, via jenkins.saltstack.com, across many supported platforms. Jenkins
calls out to salt\-cloud to create virtual machines on Rackspace, then the
minion on the virtual machine checks into the master running on Jenkins where
a state run is executed that sets up the minion to run tests and executes the
test suite.
.sp
This now automates the sequence of running platform tests and allows for
continuous destructive tests to be run.
.SS Salt Testing Project
.sp
The testing libraries for salt have been moved out of the main salt code base
and into a standalone codebase. This has been done to ease the use of the
testing systems being used in salt based projects other than Salt itself.
.SS StormPath External Authentication
.sp
The external auth system now supports the fantastic Stormpath cloud based
authentication system.
.SS LXC Support
.sp
Extensive additions have been added to Salt for LXC support. This included
the backend libs for managing LXC containers. Addition into the salt\-virt
system is still in the works.
.SS macOS User/Group Support
.sp
Salt is now able to manage users and groups on Minions running macOS.
However, at this time user passwords cannot be managed.
.SS Django ORM External Pillar
.sp
Pillar data can now be derived from Django managed databases.
.SS Fixes from RC to release
.INDENT 0.0
.IP \(bu 2
Multiple documentation fixes
.IP \(bu 2
Add multiple source files + templating for \fI\%file.append\fP (\fI\%issue 6905\fP)
.IP \(bu 2
Support sysctl configuration files in systemd>=207 (\fI\%issue 7351\fP)
.IP \(bu 2
Add \fI\%file.search\fP and \fI\%file.replace\fP
.IP \(bu 2
Fix cross\-calling execution functions in provider overrides
.IP \(bu 2
Fix locale override for postgres (\fI\%issue 4543\fP)
.IP \(bu 2
Fix Raspbian identification for service/pkg support (\fI\%issue 7371\fP)
.IP \(bu 2
Fix \fI\%cp.push\fP file corruption (\fI\%issue 6495\fP)
.IP \(bu 2
Fix ALT Linux password hash specification (\fI\%issue 3474\fP)
.IP \(bu 2
Multiple salt\-ssh\-related fixes and improvements
.UNINDENT
.SS Salt 0.17.1 Release Notes
.INDENT 0.0
.TP
.B release
2013\-10\-17
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
THIS RELEASE IS NOT COMPATIBLE WITH PREVIOUS VERSIONS.  If you update your
master to 0.17.1, you must update your minions as well.  Sorry for the
inconvenience \-\- this is a result of one of the security fixes listed
below.
.UNINDENT
.UNINDENT
.sp
The 0.17.1 release comes with a number of improvements to salt\-ssh, many
bugfixes, and a number of security updates.
.sp
Salt SSH has been improved to be faster, more featureful and more secure.
Since the original release of Salt SSH was primarily a proof of concept, it has
been very exciting to see its rapid adoption. We appreciate the willingness of
security experts to review Salt SSH and help discover oversights and ensure
that security issues only exist for such a tiny window of time.
.SS SSH Enhancements
.SS Shell Improvements
.sp
Improvements to Salt SSH\(aqs communication have been added that improve routine
execution regardless of the target system\(aqs login shell.
.SS Performance
.sp
Deployment of routines is now faster and takes fewer commands to execute.
.SS Security Updates
.sp
Be advised that these security issues all apply to a small subset of Salt
users and mostly apply to Salt SSH.
.SS Insufficient Argument Validation
.sp
This issue allowed for a user with limited privileges to embed executions
inside of routines to execute routines that should be restricted. This applies
to users using external auth or client ACL and opening up specific routines.
.sp
Be advised that these patches address the direct issue. Additional commits have
been applied to help mitigate this issue from resurfacing.
.SS CVE
.sp
CVE\-2013\-4435
.SS Affected Versions
.sp
0.15.0 \- 0.17.0
.SS Patches
.sp
\fI\%https://github.com/saltstack/salt/commit/6d8ef68b605fd63c36bb8ed96122a75ad2e80269\fP
\fI\%https://github.com/saltstack/salt/commit/ebdef37b7e5d2b95a01d34b211c61c61da67e46a\fP
\fI\%https://github.com/saltstack/salt/commit/7f190ff890e47cdd591d9d7cefa5126574660824\fP
\fI\%https://github.com/saltstack/salt/commit/8e5afe59cef6743fe5dbd510dcf463dbdfca1ced\fP
\fI\%https://github.com/saltstack/salt/commit/aca78f314481082862e96d4f0c1b75fa382bb885\fP
\fI\%https://github.com/saltstack/salt/commit/6a9752cdb1e8df2c9505ea910434c79d132eb1e2\fP
\fI\%https://github.com/saltstack/salt/commit/b73677435ba54ecfc93c1c2d840a7f9ba6f53410\fP
\fI\%https://github.com/saltstack/salt/commit/07972eb0a6f985749a55d8d4a2e471596591c80d\fP
\fI\%https://github.com/saltstack/salt/commit/1e3f197726aa13ac5c3f2416000089f477f489b5\fP
.SS Found By
.sp
Feth Arezki, of Majerti
.SS MITM SSH attack in salt\-ssh
.sp
SSH host keys were being accepted by default and not enforced on future SSH
connections. These patches set SSH host key checking by default and can be
overridden by passing the \-i flag to \fIsalt\-ssh\fP\&.
.SS CVE
.sp
CVE\-2013\-4436
.SS Affected Versions
.sp
0.17.0
.SS Found By
.sp
Michael Scherer, Red Hat
.SS Insecure Usage of /tmp in salt\-ssh
.sp
The initial release of salt\-ssh used the /tmp directory in an insecure way.
These patches not only secure usage of files under /tmp in salt\-ssh, but
also add checksum validation for all packages sent into the now secure
locations on target systems.
.SS CVE
.sp
CVE\-2013\-4438
.SS Affected Versions
.sp
0.17.0
.SS Patches
.sp
\fI\%https://github.com/saltstack/salt/commit/aa4bb77ef230758cad84381dde0ec660d2dc340a\fP
\fI\%https://github.com/saltstack/salt/commit/8f92b6b2cb2e4ec3af8783eb6bf4ff06f5a352cf\fP
\fI\%https://github.com/saltstack/salt/commit/c58e56811d5a50c908df0597a0ba0b643b45ebfd\fP
\fI\%https://github.com/saltstack/salt/commit/0359db9b46e47614cff35a66ea6a6a76846885d2\fP
\fI\%https://github.com/saltstack/salt/commit/4348392860e0fd43701c331ac3e681cf1a8c17b0\fP
\fI\%https://github.com/saltstack/salt/commit/664d1a1cac05602fad2693f6f97092d98a72bf61\fP
\fI\%https://github.com/saltstack/salt/commit/bab92775a576e28ff9db262f32db9cf2375bba87\fP
\fI\%https://github.com/saltstack/salt/commit/c6d34f1acf64900a3c87a2d37618ff414e5a704e\fP
.SS Found By
.sp
Michael Scherer, Red Hat
.SS YAML Calling Unsafe Loading Routine
.sp
It has been argued that this is not a valid security issue, as the YAML loading
that was happening was only being called after an initial gateway filter in
Salt has already safely loaded the YAML and would fail if non\-safe routines
were embedded. Nonetheless, the CVE was filed and patches applied.
.SS CVE
.sp
CVE\-2013\-4438
.SS Patches
.sp
\fI\%https://github.com/saltstack/salt/commit/339b0a51befae6b6b218ebcb55daa9cd3329a1c5\fP
.SS Found By
.sp
Michael Scherer, Red Hat
.SS Failure to Drop Supplementary Group on Salt Master
.sp
If a salt master was started as a non\-root user by the root user, root\(aqs
groups would still be applied to the running process. This fix changes the
process to have only the groups of the running user.
.SS CVE
.sp
CVE not considered necessary by submitter.
.SS Affected Versions
.sp
0.11.0 \- 0.17.0
.SS Patches
.sp
\fI\%https://github.com/saltstack/salt/commit/b89fa9135822d029795ab1eecd68cce2d1ced715\fP
.SS Found By
.sp
Michael Scherer, Red Hat
.SS Failure to Validate Minions Posting Data
.sp
This issue allowed a minion to pose as another authorized minion when posting
data such as the mine data. All minions now pass through the id challenge
before posting such data.
.SS CVE
.sp
CVE\-2013\-4439
.SS Affected Versions
.sp
0.15.0 \- 0.17.0
.SS Patches
.sp
\fI\%https://github.com/saltstack/salt/commit/7b850ff3d07ef6782888914ac4556c01e8a1c482\fP
\fI\%https://github.com/saltstack/salt/commit/151759b2a1e1c6ce29277aa81b054219147f80fd\fP
.SS Found By
.sp
David Anderson
.SS Fix Reference
.sp
Version 0.17.1 is the first bugfix release for \fI\%0.17.0\fP\&.  The changes include:
.INDENT 0.0
.IP \(bu 2
Fix symbolic links in thin.tgz (\fI\%issue 7482\fP)
.IP \(bu 2
Pass env through to file.patch state (\fI\%issue 7452\fP)
.IP \(bu 2
Service provider fixes and reporting improvements (\fI\%issue 7361\fP)
.IP \(bu 2
Add \fB\-\-priv\fP option for specifying salt\-ssh private key
.IP \(bu 2
Fix salt\-thin\(aqs salt\-call on setuptools installations (\fI\%issue 7516\fP)
.IP \(bu 2
Fix salt\-ssh to support passwords with spaces (\fI\%issue 7480\fP)
.IP \(bu 2
Fix regression in wildcard includes (\fI\%issue 7455\fP)
.IP \(bu 2
Fix salt\-call outputter regression (\fI\%issue 7456\fP)
.IP \(bu 2
Fix custom returner support for startup states (\fI\%issue 7540\fP)
.IP \(bu 2
Fix value handling in augeas (\fI\%issue 7605\fP)
.IP \(bu 2
Fix regression in apt (\fI\%issue 7624\fP)
.IP \(bu 2
Fix minion ID guessing to use \fBsocket.getfqdn()\fP first (\fI\%issue 7558\fP)
.IP \(bu 2
Add minion ID caching (\fI\%issue 7558\fP)
.IP \(bu 2
Fix salt\-key race condition (\fI\%issue 7304\fP)
.IP \(bu 2
Add \fB\-\-include\-all\fP flag to salt\-key (\fI\%issue 7399\fP)
.IP \(bu 2
Fix custom grains in pillar (part of \fI\%issue 5716\fP, \fI\%issue 6083\fP)
.IP \(bu 2
Fix race condition in salt\-key (\fI\%issue 7304\fP)
.IP \(bu 2
Fix regression in minion ID guessing, prioritize \fBsocket.getfqdn()\fP
(\fI\%issue 7558\fP)
.IP \(bu 2
Cache minion ID on first guess (\fI\%issue 7558\fP)
.IP \(bu 2
Allow trailing slash in \fBfile.directory\fP state
.IP \(bu 2
Fix reporting of file_roots in pillar return (\fI\%issue 5449\fP and
\fI\%issue 5951\fP)
.IP \(bu 2
Remove pillar matching for mine.get (\fI\%issue 7197\fP)
.IP \(bu 2
Sanitize args for multiple execution modules
.IP \(bu 2
Fix yumpkg mod_repo functions to filter hidden args (\fI\%issue 7656\fP)
.IP \(bu 2
Fix conflicting IDs in state includes (\fI\%issue 7526\fP)
.IP \(bu 2
Fix mysql_grants.absent string formatting issue (\fI\%issue 7827\fP)
.IP \(bu 2
Fix postgres.version so it won\(aqt return None (\fI\%issue 7695\fP)
.IP \(bu 2
Fix for trailing slashes in mount.mounted state
.IP \(bu 2
Fix rogue AttributErrors in the outputter system (\fI\%issue 7845\fP)
.IP \(bu 2
Fix for incorrect ssh key encodings resulting in incorrect key added
(\fI\%issue 7718\fP)
.IP \(bu 2
Fix for pillar/grains naming regression in python renderer (\fI\%issue 7693\fP)
.IP \(bu 2
Fix args/kwargs handling in the scheduler (\fI\%issue 7422\fP)
.IP \(bu 2
Fix logfile handling for \fIfile://\fP, \fItcp://\fP, and \fIudp://\fP (\fI\%issue 7754\fP)
.IP \(bu 2
Fix error handling in config file parsing (\fI\%issue 6714\fP)
.IP \(bu 2
Fix RVM using sudo when running as non\-root user (\fI\%issue 2193\fP)
.IP \(bu 2
Fix client ACL and underlying logging bugs (\fI\%issue 7706\fP)
.IP \(bu 2
Fix scheduler bug with returner (\fI\%issue 7367\fP)
.IP \(bu 2
Fix user management bug related to default groups (\fI\%issue 7690\fP)
.IP \(bu 2
Fix various salt\-ssh bugs (\fI\%issue 7528\fP)
.IP \(bu 2
Many various documentation fixes
.UNINDENT
.SS Salt 0.17.2 Release Notes
.INDENT 0.0
.TP
.B release
2013\-11\-14
.UNINDENT
.sp
Version 0.17.2 is another bugfix release for \fI\%0.17.0\fP\&.  The changes include:
.INDENT 0.0
.IP \(bu 2
Add ability to delete key with grains.delval (\fI\%issue 7872\fP)
.IP \(bu 2
Fix possible state compiler stack trace (\fI\%issue 5767\fP)
.IP \(bu 2
Fix architecture regression in yumpkg (\fI\%issue 7813\fP)
.IP \(bu 2
Use correct \fBps\fP on Debian to prevent truncating (\fI\%issue 5646\fP)
.IP \(bu 2
Fix grains targeting for new grains (\fI\%issue 5737\fP)
.IP \(bu 2
Fix bug with merging in git_pillar (\fI\%issue 6992\fP)
.IP \(bu 2
Fix print_jobs duplicate results
.IP \(bu 2
Fix apt version specification for pkg.install
.IP \(bu 2
Fix possible KeyError from ext_job_cache missing option
.IP \(bu 2
Fix auto_order for \fB\- names\fP states (\fI\%issue 7649\fP)
.IP \(bu 2
Fix regression in new gitfs installs (directory not found error)
.IP \(bu 2
Fix escape pipe issue on Windows for file.recurse (\fI\%issue 7967\fP)
.IP \(bu 2
Fix fileclient in case of master restart (\fI\%issue 7987\fP)
.IP \(bu 2
Try to output warning if CLI command malformed (\fI\%issue 6538\fP)
.IP \(bu 2
Fix \fB\-\-out=quiet\fP to actually be quiet (\fI\%issue 8000\fP)
.IP \(bu 2
Fix for state.sls in salt\-ssh (\fI\%issue 7991\fP)
.IP \(bu 2
Fix for MySQL grants ordering issue (\fI\%issue 5817\fP)
.IP \(bu 2
Fix traceback for certain missing CLI args (\fI\%issue 8016\fP)
.IP \(bu 2
Add ability to disable lspci queries on master (\fI\%issue 4906\fP)
.IP \(bu 2
Fail if sls defined in topfile does not exist (\fI\%issue 5998\fP)
.IP \(bu 2
Add ability to downgrade MySQL grants (\fI\%issue 6606\fP)
.IP \(bu 2
Fix ssh_auth.absent traceback (\fI\%issue 8043\fP)
.IP \(bu 2
Add upstart detection for Debian/Raspbian (\fI\%issue 8039\fP)
.IP \(bu 2
Fix ID\-related issues (\fI\%issue 8052\fP, \fI\%issue 8050\fP, and others)
.IP \(bu 2
Fix for jinja rendering issues (\fI\%issue 8066\fP and \fI\%issue 8079\fP)
.IP \(bu 2
Fix argument parsing in salt\-ssh (\fI\%issue 7928\fP)
.IP \(bu 2
Fix some GPU detection instances (\fI\%issue 6945\fP)
.IP \(bu 2
Fix bug preventing includes from other environments in SLS files
.IP \(bu 2
Fix for kwargs with dashes (\fI\%issue 8102\fP)
.IP \(bu 2
Fix salt.utils.which for windows \(aq.exe\(aq (\fI\%issue 7904\fP)
.IP \(bu 2
Fix apache.adduser without apachectl (\fI\%issue 8123\fP)
.IP \(bu 2
Fix issue with evaluating \fBtest\fP kwarg in states (\fI\%issue 7788\fP)
.IP \(bu 2
Fix regression in \fBsalt.client.Caller()\fP (\fI\%issue 8078\fP)
.IP \(bu 2
Fix apt\-key silent failure
.IP \(bu 2
Fix bug where cmd.script would try to run even if caching failed (\fI\%issue 7601\fP)
.IP \(bu 2
Fix apt \fBpkg.latest\fP regression (\fI\%issue 8067\fP)
.IP \(bu 2
Fix for mine data not being updated (\fI\%issue 8144\fP)
.IP \(bu 2
Fix for noarch packages in yum
.IP \(bu 2
Fix a Xen detection edge case (\fI\%issue 7839\fP)
.IP \(bu 2
Fix windows \fB__opts__\fP dictionary persistence (\fI\%issue 7714\fP)
.IP \(bu 2
Fix version generation for when it\(aqs part of another git repo (\fI\%issue 8090\fP)
.IP \(bu 2
Fix _handle_iorder stacktrace so that the real syntax error is shown (\fI\%issue 8114\fP and \fI\%issue 7905\fP)
.IP \(bu 2
Fix \fBgit.latest\fP state when a commit SHA is used (\fI\%issue 8163\fP)
.IP \(bu 2
Fix various small bugs in yumpkg.py (\fI\%issue 8201\fP)
.IP \(bu 2
Fix for specifying identify file in git.latest (\fI\%issue 8094\fP)
.IP \(bu 2
Fix for \fB\-\-output\-file\fP CLI arg (\fI\%issue 8205\fP)
.IP \(bu 2
Add ability to specify shutdown time for system.shutdown (\fI\%issue 7833\fP)
.IP \(bu 2
Fix for salt version using non\-salt git repo info (\fI\%issue 8266\fP)
.IP \(bu 2
Add additional hints at impact of \fBpkgrepo\fP states when \fBtest=True\fP (\fI\%issue 8247\fP)
.IP \(bu 2
Fix for salt\-ssh files not being owned by root (\fI\%issue 8216\fP)
.IP \(bu 2
Fix retry logic and error handling in fileserver (related to \fI\%issue 7755\fP)
.IP \(bu 2
Fix file.replace with \fBtest=True\fP (\fI\%issue 8279\fP)
.IP \(bu 2
Add flag for limiting file traversal in fileserver (\fI\%issue 6928\fP)
.IP \(bu 2
Fix for extra mine processes (\fI\%issue 5729\fP)
.IP \(bu 2
Fix for unloading custom modules (\fI\%issue 7691\fP)
.IP \(bu 2
Fix for salt\-ssh opts (\fI\%issue 8005\fP and \fI\%issue 8271\fP)
.IP \(bu 2
Fix compound matcher for grains (\fI\%issue 7944\fP)
.IP \(bu 2
Improve error reporting in ebuild module (related to \fI\%issue 5393\fP)
.IP \(bu 2
Add \fBdir_mode\fP to \fBfile.managed\fP (\fI\%issue 7860\fP)
.IP \(bu 2
Improve traceroute support for FreeBSD and macOS (\fI\%issue 4927\fP)
.IP \(bu 2
Fix for matching minions under syndics (\fI\%issue 7671\fP)
.IP \(bu 2
Improve exception handling for missing ID (\fI\%issue 8259\fP)
.IP \(bu 2
Fix grain mismatch for ScientificLinux (\fI\%issue 8338\fP)
.IP \(bu 2
Add configuration option for minion_id_caching
.IP \(bu 2
Fix open mode auth errors (\fI\%issue 8402\fP)
.UNINDENT
.SS Salt 0.17.3 Release Notes
.INDENT 0.0
.TP
.B release
2013\-12\-08
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
0.17.3 had some regressions which were promptly fixed in the 0.17.4
release.  Please use 0.17.4 instead.
.UNINDENT
.UNINDENT
.sp
Version 0.17.3 is another bugfix release for \fI\%0.17.0\fP\&.  The changes include:
.INDENT 0.0
.IP \(bu 2
Fix some jinja render errors (\fI\%issue 8418\fP)
.IP \(bu 2
Fix \fBfile.replace\fP state changing file ownership (\fI\%issue 8399\fP)
.IP \(bu 2
Fix state ordering with the PyDSL renderer (\fI\%issue 8446\fP)
.IP \(bu 2
Fix for new npm version (\fI\%issue 8517\fP)
.IP \(bu 2
Fix for pip state requiring \fBname\fP even with requirements file (\fI\%issue 8519\fP)
.IP \(bu 2
Fix yum logging to open terminals (\fI\%issue 3855\fP)
.IP \(bu 2
Add sane maxrunning defaults for scheduler (\fI\%issue 8563\fP)
.IP \(bu 2
Fix states duplicate key detection (\fI\%issue 8053\fP)
.IP \(bu 2
Fix SUSE patch level reporting (\fI\%issue 8428\fP)
.IP \(bu 2
Fix managed file creation umask (\fI\%issue 8590\fP)
.IP \(bu 2
Fix logstash exception (\fI\%issue 8635\fP)
.IP \(bu 2
Improve argument exception handling for salt command (\fI\%issue 8016\fP)
.IP \(bu 2
Fix pecl success reporting (\fI\%issue 8750\fP)
.IP \(bu 2
Fix launchctl module exceptions (\fI\%issue 8759\fP)
.IP \(bu 2
Fix argument order in pw_user module
.IP \(bu 2
Add warnings for failing grains (\fI\%issue 8690\fP)
.IP \(bu 2
Fix hgfs problems caused by connections left open (\fI\%issue 8811\fP and \fI\%issue 8810\fP)
.IP \(bu 2
Add Debian iptables default for iptables\-persistent package (\fI\%issue 8889\fP)
.IP \(bu 2
Fix installation of packages with dots in pkg name (\fI\%issue 8614\fP)
.IP \(bu 2
Fix noarch package installation on CentOS 6 (\fI\%issue 8945\fP)
.IP \(bu 2
Fix portage_config.enforce_nice_config (\fI\%issue 8252\fP)
.IP \(bu 2
Fix salt.util.copyfile umask usage (\fI\%issue 8590\fP)
.IP \(bu 2
Fix rescheduling of failed jobs (\fI\%issue 8941\fP)
.IP \(bu 2
Fix pkg on Amazon Linux (uses yumpkg5 now) (\fI\%issue 8226\fP)
.IP \(bu 2
Fix conflicting options in postgres module (\fI\%issue 8717\fP)
.IP \(bu 2
Fix ps modules for psutil >= 0.3.0 (\fI\%issue 7432\fP)
.IP \(bu 2
Fix postgres module to return False on failure (\fI\%issue 8778\fP)
.IP \(bu 2
Fix argument passing for args with pound signs (\fI\%issue 8585\fP)
.IP \(bu 2
Fix pid of salt CLi command showing in status.pid output (\fI\%issue 8720\fP)
.IP \(bu 2
Fix rvm to run gem as the correct user (\fI\%issue 8951\fP)
.IP \(bu 2
Fix namespace issue in win_file module (\fI\%issue 9060\fP)
.IP \(bu 2
Fix masterless state paths on windows (\fI\%issue 9021\fP)
.IP \(bu 2
Fix timeout option in master config (\fI\%issue 9040\fP)
.UNINDENT
.SS Salt 0.17.4 Release Notes
.INDENT 0.0
.TP
.B release
2013\-12\-10
.UNINDENT
.sp
Version 0.17.4 is another bugfix release for \fI\%0.17.0\fP\&.  The changes include:
.INDENT 0.0
.IP \(bu 2
Fix file.replace bug when replacement str is numeric (\fI\%issue 9101\fP)
.IP \(bu 2
Fix regression in file.managed (\fI\%issue 9131\fP)
.IP \(bu 2
Prevent traceback when job is None. (\fI\%issue 9145\fP)
.UNINDENT
.SS Salt 0.17.5 Release Notes
.INDENT 0.0
.TP
.B release
2014\-01\-27
.UNINDENT
.sp
Version 0.17.5 is another bugfix release for \fI\%0.17.0\fP\&.  The changes include:
.INDENT 0.0
.IP \(bu 2
Fix \fBuser.present\fP states with non\-string fullname (\fI\%issue 9085\fP)
.IP \(bu 2
Fix \fBvirt.init\fP return value on failure (\fI\%issue 6870\fP)
.IP \(bu 2
Fix reporting of \fBfile.blockreplace\fP state when \fBtest=True\fP
.IP \(bu 2
Fix \fBnetwork.interfaces\fP when used in cron (\fI\%issue 7990\fP)
.IP \(bu 2
Fix bug in pkgrepo when switching to/from mirrorlist\-based repo def (\fI\%issue 9121\fP)
.IP \(bu 2
Fix infinite recursion when cache file is corrupted
.IP \(bu 2
Add checking for rev and mirror/bare args in \fBgit.latest\fP (\fI\%issue 9107\fP)
.IP \(bu 2
Add \fBcmd.watch\fP alias (points to \fBcmd.wait\fP) (\fI\%issue 8612\fP)
.IP \(bu 2
Fix stacktrace when prereq is not formed as a list (\fI\%issue 8235\fP)
.IP \(bu 2
Fix stdin issue with lvdisplay command (\fI\%issue 9128\fP)
.IP \(bu 2
Add pre\-check function for range matcher (\fI\%issue 9236\fP)
.IP \(bu 2
Add exception handling for psutil for processes that go missing (\fI\%issue 9274\fP)
.IP \(bu 2
Allow \fB_in\fP requisites to match both on ID and name (\fI\%issue 9061\fP)
.IP \(bu 2
Fix multiple client timeout issues (\fI\%issue 7157\fP and \fI\%issue 9302\fP, probably others)
.IP \(bu 2
Fix \fBZMQError: Operation cannot be accomplished in current state\fP errors (\fI\%issue 6306\fP)
.IP \(bu 2
Multiple optimization in minion auth routines
.IP \(bu 2
Clarify logs for minion ID caching
.UNINDENT
.SS Salt 0.6.0 release notes
.sp
The Salt remote execution manager has reached initial functionality! Salt is a
management application which can be used to execute commands on remote sets of
servers.
.sp
The whole idea behind Salt is to create a system where a group of servers can
be remotely controlled from a single master, not only can commands be executed
on remote systems, but salt can also be used to gather information about your
server environment.
.sp
Unlike similar systems, like Func and MCollective, Salt is extremely simple to
setup and use, the entire application is contained in a single package, and the
master and minion daemons require no running dependencies in the way that Func
requires Certmaster and MCollective requires activeMQ.
.sp
Salt also manages authentication and encryption. Rather than using SSL for
encryption, salt manages encryption on a payload level, so the data sent across
the network is encrypted with fast AES encryption, and authentication uses RSA
keys. This means that Salt is fast, secure, and very efficient.
.sp
Messaging in Salt is executed with ZeroMQ, so the message passing interface is
built into salt and does not require an external ZeroMQ server. This also adds
speed to Salt since there is no additional bloat on the networking layer, and
ZeroMQ has already proven itself as a very fast networking system.
.sp
The remote execution in Salt is \(dqLazy Execution\(dq, in that once the command is
sent the requesting network connection is closed. This makes it easier to
detach the execution from the calling process on the master, it also means that
replies are cached, so that information gathered from historic commands can be
queried in the future.
.sp
Salt also allows users to make execution modules in Python. Writers of these
modules should also be pleased to know that they have access to the impressive
information gathered from PuppetLabs\(aq Facter application, making Salt module
more flexible. In the future I hope to also allow Salt to group servers based
on Facter information as well.
.sp
All in all Salt is fast, efficient, and clean, can be used from a simple command
line client or through an API, uses message queue technology to make network
execution extremely fast, and encryption is handled in a very fast and
efficient manner. Salt is also VERY easy to use and VERY easy to extend.
.sp
You can find the source code for Salt on my GitHub page, I have also set up a
few wiki pages explaining how to use and set up Salt. If you are using Arch
Linux there is a package available in the Arch Linux AUR.
.sp
GitHub page: \fI\%https://github.com/saltstack/salt\fP
.sp
Wiki: \fI\%https://github.com/saltstack/salt/wiki\fP
.sp
Arch Linux Package: \fI\%https://aur.archlinux.org/packages/salt\-git/\fP
.sp
I am very open to contributions, for instance I need packages for more Linux
distributions as well as BSD packages and testers.
.sp
Give Salt a try, this is the initial release and is not a 1.0 quality release,
but it has been working well for me! I am eager to get your feedback!
.SS Salt 0.7.0 release notes
.sp
I am pleased to announce the release of Salt 0.7.0!
.sp
This release marks what is the first stable release of salt, 0.7.0 should be
suitable for general use.
.sp
0.7.0 Brings the following new features to Salt:
.INDENT 0.0
.IP \(bu 2
Integration with Facter data from puppet labs
.IP \(bu 2
Allow for matching minions from the salt client via Facter information
.IP \(bu 2
Minion job threading, many jobs can be executed from the master at once
.IP \(bu 2
Preview of master clustering support \- Still experimental
.IP \(bu 2
Introduce new minion modules for stats, virtualization, service management and more
.IP \(bu 2
Add extensive logging to the master and minion daemons
.IP \(bu 2
Add sys.reload_functions for dynamic function reloading
.IP \(bu 2
Greatly improve authentication
.IP \(bu 2
Introduce the saltkey command for managing public keys
.IP \(bu 2
Begin backend development preparatory to introducing butter
.IP \(bu 2
Addition of man pages for the core commands
.IP \(bu 2
Extended and cleaned configuration
.UNINDENT
.sp
0.7.0 Fixes the following major bugs:
.INDENT 0.0
.IP \(bu 2
Fix crash in minions when matching failed
.IP \(bu 2
Fix configuration file lookups for the local client
.IP \(bu 2
Repair communication bugs in encryption
.IP \(bu 2
Numerous fixes in the minion modules
.UNINDENT
.sp
The next release of Salt should see the following features:
.INDENT 0.0
.IP \(bu 2
Stabilize the cluster support
.IP \(bu 2
Introduce a remote client for salt command tiers
.IP \(bu 2
salt\-ftp system for distributed file copies
.IP \(bu 2
Initial support for \(dqbutter\(dq
.UNINDENT
.sp
Coming up next is a higher level management framework for salt called
Butter. I want salt to stay as a simple and effective communication
framework, and allow for more complicated executions to be managed via
Butter.
.sp
Right now Butter is being developed to act as a cloud controller using salt
as the communication layer, but features like system monitoring and advanced
configuration control (a puppet manager) are also in the pipe.
.sp
Special thanks to Joseph Hall for the status and network modules, and thanks
to Matthias Teege for tracking down some configuration bugs!
.sp
Salt can be downloaded from the following locations;
.sp
Arch Linux Package:
.sp
\fI\%https://aur.archlinux.org/packages/salt\-git/\fP
.sp
Please enjoy the latest Salt release!
.SS Salt 0.8.0 release notes
.sp
Salt 0.8.0 is ready for general consumption!
The source tarball is available on GitHub for download:
.sp
A lot of work has gone into salt since the last release just 2 weeks ago, and
salt has improved a great deal. A swath of new features are here along with
performance and threading improvements!
.sp
The main new features of salt 0.8.0 are:
.sp
Salt\-cp
.sp
Cython minion modules
.sp
Dynamic returners
.sp
Faster return handling
.sp
Lowered required Python version to 2.6
.sp
Advanced minion threading
.sp
Configurable minion modules
.SS Salt\-cp
.sp
The salt\-cp command introduces the ability to copy simple files via salt to
targeted servers. Using salt\-cp is very simple, just call salt\-cp with a target
specification, the source file(s) and where to copy the files on the minions.
For instance:
.sp
# salt\-cp ‘*’ /etc/hosts /etc/hosts
.sp
Will copy the local /etc/hosts file to all of the minions.
.sp
Salt\-cp is very young, in the future more advanced features will be added, and
the functionality will much more closely resemble the cp command.
.SS Cython minion modules
.sp
Cython is an amazing tool used to compile Python modules down to c. This is
arguably the fastest way to run Python code, and since pyzmq requires cython,
adding support to salt for cython adds no new dependencies.
.sp
Cython minion modules allow minion modules to be written in cython and
therefore executed in compiled c. Simply write the salt module in cython and
use the file extension “.pyx” and the minion module will be compiled when
the minion is started. An example cython module is included in the main
distribution called cytest.pyx:
.sp
\fI\%salt/modules/cytest.pyx\fP
.SS Dynamic Returners
.sp
By default salt returns command data back to the salt master, but now salt can
return command data to any system. This is enabled via the new returners
modules feature for salt. The returners modules take the return data and sends
it to a specific module. The returner modules work like minion modules, so any
returner can be added to the minions.
.sp
This means that a custom data returner can be added to communicate the return
data so anything from MySQL, Redis, MongoDB, and more!
.sp
There are 2 simple stock returners in the returners directory:
.sp
\fI\%salt/returners\fP
.sp
The documentation on writing returners will be added to the wiki shortly, and
returners can be written in pure Python, or in cython.
.SS Configurable Minion Modules
.sp
Minion modules may need to be configured, now the options passed to the minion
configuration file can be accessed inside of the minion modules via the __opt__
dict.
.sp
Information on how to use this simple addition has been added to the wiki:
\fI\%Writing modules\fP
.sp
The test module has an example of using the __opts__ dict, and how to set
default options:
.sp
\fI\%salt/modules/test.py\fP
.SS Advanced Minion Threading
.sp
In 0.7.0 the minion would block after receiving a command from the master, now
the minion will spawn a thread or multiprocess. By default Python threads are
used because for general use they have proved to be faster, but the minion can
now be configured to use the Python multiprocessing module instead. Using
multiprocessing will cause executions that are CPU bound or would otherwise
exploit the negative aspects of the Python GIL to run faster and more reliably,
but simple calls will still be faster with Python threading.
The configuration option can be found in the minion configuration file:
.sp
\fI\%conf/minion\fP
.SS Lowered Supported Python to 2.6
.sp
The requirement for Python 2.7 has been removed to support Python 2.6. I have
received requests to take the minimum Python version back to 2.4, but
unfortunately this will not be possible, since the ZeroMQ Python bindings do
not support Python 2.4.
.sp
Salt 0.8.0 is a very major update, it also changes the network protocol slightly
which makes communication with older salt daemons impossible, your master and
minions need to be upgraded together!
.sp
I could use some help bringing salt to the people! Right now I only have
packages for Arch Linux, Fedora 14 and Gentoo. We need packages for Debian and
people willing to help test on more platforms. We also need help writing more
minion modules and returner modules. If you want to contribute to salt please
hop on the mailing list and send in patches, make a fork on GitHub and send in
pull requests! If you want to help but are not sure where you can, please email
me directly or post tot he mailing list!
.sp
I hope you enjoy salt, while it is not yet 1.0 salt is completely viable and
usable!
.sp
\-Thomas S. Hatch
.SS Salt 0.8.7 release notes
.sp
It has been a month since salt 0.8.0, and it has been a long month! But Salt is
still coming along strong. 0.8.7 has a lot of changes and a lot of updates.
This update makes Salt’s ZeroMQ back end better, strips Facter from the
dependencies, and introduces interfaces to handle more capabilities.
.sp
Many of the major updates are in the background, but the changes should shine
through to the surface. A number of the new features are still a little thin,
but the back end to support expansion is in place.
.sp
I also recently gave a presentation to the Utah Python users group in Salt Lake
City, the slides from this presentation are available here:
.sp
The video from this presentation will be available shortly.
.sp
The major new features and changes in Salt 0.8.7 are:
.INDENT 0.0
.IP \(bu 2
Revamp ZeroMQ topology on the master for better scalability
.IP \(bu 2
State enforcement
.IP \(bu 2
Dynamic state enforcement managers
.IP \(bu 2
Extract the module loader into salt.loader
.IP \(bu 2
Make Job ids more granular
.IP \(bu 2
Replace Facter functionality with the new salt grains interface
.IP \(bu 2
Support for “virtual” salt modules
.IP \(bu 2
Introduce the salt\-call command
.IP \(bu 2
Better debugging for minion modules
.UNINDENT
.sp
The new ZeroMQ topology allows for better scalability, this will be required by
the need to execute massive file transfers to multiple machines in parallel and
state management. The new ZeroMQ topology is available in the aforementioned
presentation.
.sp
0.8.7 introduces the capability to declare states, this is similar to the
capabilities of Puppet. States in salt are declared via state data structures.
This system is very young, but the core feature set is available. Salt states
work around rendering files which represent Salt high data. More on the Salt
state system will be documented in the near future.
.sp
The system for loading salt modules has been pulled out of the minion class to
be a standalone module, this has enabled more dynamic loading of Salt modules
and enables many of the updates in 0.8.7 –
.sp
\fI\%salt/loader.py\fP
.sp
Salt Job ids are now microsecond precise, this was needed to repair a race
condition unveiled by the speed improvements in the new ZeroMQ topology.
.sp
The new grains interface replaces the functionality of Facter, the idea behind
grains differs from Facter in that the grains are only used for static system
data, dynamic data needs to be derived from a call to a salt module. This makes
grains much faster to use, since the grains data is generated when the minion
starts.
.sp
Virtual salt modules allows for a salt module to be presented as something
other than its module name. The idea here is that based on information from the
minion decisions about which module should be presented can be made. The best
example is the pacman module. The pacman module will only load on Arch Linux
minions, and will be called pkg. Similarly the yum module will be presented as
pkg when the minion starts on a Fedora/RedHat system.
.sp
The new salt\-call command allows for minion modules to be executed from the
minion. This means that on the minion a salt module can be executed, this is a
great tool for testing Salt modules. The salt\-call command can also be used to
view the grains data.
.sp
In previous releases when a minion module threw an exception very little data
was returned to the master. Now the stack trace from the failure is returned
making debugging of minion modules MUCH easier.
.sp
Salt is nearing the goal of 1.0, where the core feature set and capability is
complete!
.sp
\-Thomas S Hatch
.SS Salt 0.8.8 release notes
.sp
Salt 0.8.8 is here! This release adds a great deal of code and some serious new
features.
.sp
Improved Documentation has been set up for salt using sphinx thanks to the
efforts of Seth House. This new documentation system will act as the back end
to the salt website which is still under heavy development. The new sphinx
documentation system has also been used to greatly clean up the salt manpages.
The salt 7 manpage in particular now contains extensive information which was
previously only in the wiki. The new documentation can be found at:
\fI\%https://docs.saltproject.io/\fP
We still have a lot to add, and when the domain is set up I will post another
announcement.
.sp
More additions have been made to the ZeroMQ setup, particularly in the realm
of file transfers. Salt 0.8.8 introduces a built in, stateless, encrypted file
server which allows salt minions to download files from the salt master using
the same encryption system used for all other salt communications. The main
motivation for the salt file server has been to facilitate the new salt state
system.
.sp
Much of the salt code has been cleaned up and a new cleaner logging system has
been introduced thanks to the efforts of Pedro Algarvio. These additions will
allow for much more flexible logging to be executed by salt, and fixed a great
deal of my poor spelling in the salt docstrings! Pedro Algarvio has also
cleaned up the API, making it easier to embed salt into another application.
.sp
The biggest addition to salt found in 0.8.8 is the new state system. The salt
module system has received a new front end which allows salt to be used as a
configuration management system. The configuration management system allows for
system configuration to be defined in data structures. The configuration
management system, or as it is called in salt, the “salt state system” supports
many of the features found in other configuration managers, but allows for
system states to be written in a far simpler format, executes at blazing speeds,
and operates via the salt minion matching system. The state system also operates
within the normal scope of salt, and requires no additional configuration to
use.
.sp
The salt state system can enforce the following states with many more to come:
Packages
Files
Services
Executing commands
Hosts
.sp
The system used to define the salt states is based on a data structure, the
data structure used to define the salt states has been made to be as easy to
use as possible. The data structure is defined by default using a YAML file
rendered via a Jinja template. This means that the state definition language
supports all of the data structures that YAML supports, and all of the
programming constructs and logic that Jinja supports. If the user does not
like YAML or Jinja the states can be defined in yaml\-mako, json\-jinja, or
json\-mako. The system used to render the states is completely dynamic, and any
rendering system can be added to the capabilities of Salt, this means that a
rendering system that renders XML data in a cheetah template, or whatever you
can imagine, can be easily added to the capabilities of salt.
.sp
The salt state system also supports isolated environments, as well as matching
code from several environments to a single salt minion.
.sp
The feature base for Salt has grown quite a bit since my last serious
documentation push. As we approach 0.9.0 the goals are becoming very clear, and
the documentation needs a lot of work. The main goals for 0.9.0 are to further
refine the state system, fix any bugs we find, get Salt running on as many
platforms as we can, and get the documentation filled out. There is a lot more
to come as Salt moves forward to encapsulate a much larger scope, while
maintaining supreme usability and simplicity.
.sp
If you would like a more complete overview of Salt please watch the Salt
presentation:
Slides:
.sp
\-Thomas S Hatch
.SS Salt 0.8.9 Release Notes
.sp
Salt 0.8.9 has finally arrived! Unfortunately this is much later than I had
hoped to release 0.8.9, life has been very crazy over the last month. But
despite challenges, Salt has moved forward!
.sp
This release, as expected, adds few new features and many refinements. One
of the most exciting aspect of this release is that the development community
for salt has grown a great deal and much of the code is from contributors.
.sp
Also, I have filled out the documentation a great deal. So information on
States is properly documented, and much of the documentation that was out of
date has been filled in.
.SS Download!
.sp
The Salt source can be downloaded from PyPI:
.sp
\fI\%https://pypi.python.org/packages/source/s/salt/salt\-0.8.9.tar.gz\fP
.sp
Here s the md5sum:
.sp
7d5aca4633bc22f59045f59e82f43b56
.sp
For instructions on how to set up Salt please see the \fI\%Installation\fP
instructions.
.SS New Features
.SS Salt Run
.sp
A big feature is the addition of Salt run, the \fBsalt\-run\fP command allows for
master side execution modules to be made that gather specific information or
execute custom routines from the master.
.sp
Documentation for salt\-run can be found \fI\%here\fP
.SS Refined Outputters
.sp
One problem often complained about in salt was the fact that the output was
so messy. Thanks to help from Jeff Schroeder a cleaner interface for the
command output for the Salt CLI has been made. This new interface makes
adding new printout formats easy and additions to the capabilities of minion
modules makes it possible to set the printout mode or \fBoutputter\fP for
functions in minion modules.
.SS Cross Calling Salt Modules
.sp
Salt modules can now call each other, the \fB__salt__\fP dict has been added to
the predefined references in minion modules. This new feature is documented in
the \fI\%modules documentation\fP\&.
.SS Watch Option Added to Salt State System
.sp
Now in Salt states you can set the watch option, this will allow watch enabled
states to change based on a change in the other defined states. This is similar
to subscribe and notify statements in puppet.
.SS Root Dir Option
.sp
Travis Cline has added the ability to define the option \fBroot_dir\fP which
allows the salt minion to operate in a subdir. This is a strong move in
supporting the minion running as an unprivileged user
.SS Config Files Defined in Variables
.sp
Thanks again to Travis Cline, the master and minion configuration file locations
can be defined in environment variables now.
.SS New Modules
.sp
Quite a few new modules, states, returners, and runners have been made.
.SS New Minion Modules
.SS apt
.sp
Support for apt\-get has been added, this adds greatly improved Debian and
Ubuntu support to Salt!
.SS useradd and groupadd
.sp
Support for manipulating users and groups on Unix\-like systems.
.SS moosefs
.sp
Initial support for reporting on aspects of the distributed file system,
MooseFS. For more information on MooseFS please see: \fI\%http://www.moosefs.org\fP
.sp
Thanks to Joseph Hall for his work on MooseFS support.
.SS mount
.sp
Manage mounts and the fstab.
.SS puppet
.sp
Execute puppet on remote systems.
.SS shadow
.sp
Manipulate and manage the user password file.
.SS ssh
.sp
Interact with ssh keys.
.SS New States
.SS user and group
.sp
Support for managing users and groups in Salt States.
.SS mount
.sp
Enforce mounts and the fstab.
.SS New Returners
.SS mongo_return
.sp
Send the return information to a MongoDB server.
.SS New Runners
.SS manage
.sp
Display minions that are up or down.
.SS Salt 0.9.0 Release Notes
.INDENT 0.0
.TP
.B release
2011\-08\-27
.UNINDENT
.sp
Salt 0.9.0 is here. This is an exciting release, 0.9.0 includes the new network
topology features allowing peer salt commands and masters of masters via the
syndic interface.
.sp
0.9.0 also introduces many more modules, improvements to the API and
improvements to the ZeroMQ systems.
.SS Download!
.sp
The Salt source can be downloaded from PyPI:
.sp
\fI\%https://pypi.python.org/packages/source/s/salt/salt\-0.9.0.tar.gz\fP
.sp
Here is the md5sum:
.sp
9a925da04981e65a0f237f2e77ddab37
.sp
For instructions on how to set up Salt please see the \fI\%Installation\fP
instructions.
.SS New Features
.SS Salt Syndic
.sp
The new \fI\%Syndic interface\fP allows a master to be
commanded via another higher level salt master. This is a powerful solution
allowing a master control structure to exist, allowing salt to scale to much
larger levels then before.
.SS Peer Communication
.sp
0.9.0 introduces the capability for a minion to call a publication on the
master and receive the return from another set of minions. This allows salt
to act as a communication channel between minions and as a general
infrastructure message bus.
.sp
Peer communication is turned off by default but can be enabled via the \fBpeer\fP
option in the master configuration file. Documentation on the new \fI\%Peer
interface\fP\&.
.SS Easily Extensible API
.sp
The minion and master classes have been redesigned to allow for specialized
minion and master servers to be easily created. An example on how this is done
for the master can be found in the \fBmaster.py\fP salt module:
.sp
\fI\%salt/master.py\fP
.sp
The \fBMaster\fP class extends the \fBSMaster\fP class and set up the main master
server.
.sp
The minion functions can now also be easily added to another application via
the \fBSMinion\fP class, this class can be found in the \fBminion.py\fP module:
.sp
\fI\%salt/minion.py\fP
.SS Cleaner Key Management
.sp
This release changes some of the key naming to allow for multiple master keys
to be held based on the type of minion gathering the master key.
.sp
The \-d option has also been added to the salt\-key command allowing for easy
removal of accepted public keys.
.sp
The \-\-gen\-keys option is now available as well for salt\-key, this allows
for a salt specific RSA key pair to be easily generated from the command line.
.SS Improved 0MQ Master Workers
.sp
The 0MQ worker system has been further refined to be faster and more robust.
This new system has been able to handle a much larger load than the previous
setup. The new system uses the IPC protocol in 0MQ instead of TCP.
.SS New Modules
.sp
Quite a few new modules have been made.
.SS New Minion Modules
.SS apache
.sp
Work directly with apache servers, great for managing balanced web servers
.SS cron
.sp
Read out the contents of a systems crontabs
.SS mdadm
.sp
Module to manage raid devices in Linux, appears as the \fBraid\fP module
.SS mysql
.sp
Gather simple data from MySQL databases
.SS ps
.sp
Extensive utilities for managing processes
.SS publish
.sp
Used by the peer interface to allow minions to make publications
.SS Salt 0.9.1 Release Notes
.INDENT 0.0
.TP
.B release
2011\-08\-29
.UNINDENT
.SS Salt 0.9.2 Release Notes
.INDENT 0.0
.TP
.B release
2011\-09\-17
.UNINDENT
.sp
Salt 0.9.2 has arrived! 0.9.2 is primarily a bugfix release, the exciting
component in 0.9.2 is greatly improved support for salt states. All of the
salt states interfaces have been more thoroughly tested and the new salt\-states
git repo is growing with example of how to use states.
.sp
This release introduces salt states for early developers and testers to start
helping us clean up the states interface and make it ready for the world!
.sp
0.9.2 also fixes a number of bugs found on Python 2.6.
.SS Download!
.sp
The Salt source can be downloaded from PyPI:
.sp
\fI\%https://pypi.python.org/packages/source/s/salt/salt\-0.9.2.tar.gz\fP
.sp
For instructions on how to set up Salt please see the \fI\%Installation\fP
instructions.
.SS New Features
.SS Salt\-Call Additions
.sp
The salt\-call command has received an overhaul, it now hooks into the outputter
system so command output looks clean, and the logging system has been hooked
into salt\-call, so the \-l option allows the logging output from salt minion
functions to be displayed.
.sp
The end result is that the salt\-call command can execute the state system and
return clean output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt\-call state.highstate
.ft P
.fi
.UNINDENT
.UNINDENT
.SS State System Fixes
.sp
The state system has been tested and better refined. As of this release the
state system is ready for early testers to start playing with. If you are
interested in working with the state system please check out the (still very
small) salt\-states GitHub repo:
.sp
\fI\%https://github.com/SS\-archive/salt\-states\fP
.sp
This git repo is the active development branch for determining how a clean
salt\-state database should look and act. Since the salt state system is still
very young a lot of help is still needed here. Please fork the salt\-states
repo and help us develop a truly large and scalable system for configuration
management!
.SS Notable Bug Fixes
.SS Python 2.6 String Formatting
.sp
Python 2.6 does not support format strings without an index identifier, all of
them have been repaired.
.SS Cython Loading Disabled by Default
.sp
Cython loading requires a development tool chain to be installed on the minion,
requiring this by default can cause problems for most Salt deployments. If
Cython auto loading is desired it will need to be turned on in the minion
config.
.SS Salt 0.9.3 Release Notes
.INDENT 0.0
.TP
.B release
2011\-11\-05
.UNINDENT
.sp
Salt 0.9.3 is finally arrived. This is another big step forward for Salt, new
features range from proper FreeBSD support to fixing issues seen when
attaching a minion to a master over the Internet.
.sp
The biggest improvements in 0.9.3 though can be found in the state system, it
has progressed from something ready for early testers to a system ready to
compete with platforms such as Puppet and Chef. The backbone of the state
system has been greatly refined and many new features are available.
.SS Download!
.sp
The Salt source can be downloaded from PyPI:
.sp
\fI\%https://pypi.python.org/packages/source/s/salt/salt\-0.9.3.tar.gz\fP
.sp
For instructions on how to set up Salt please see the \fI\%Installation\fP
instructions.
.SS New Features
.SS WAN Support
.sp
Recently more people have been testing Salt minions connecting to Salt Masters
over the Internet. It was found that Minions would commonly loose their
connection to the master when working over the internet. The minions can now
detect if the connection has been lost and reconnect to the master, making
WAN connections much more reliable.
.SS State System Fixes
.sp
Substantial testing has gone into the state system and it is ready for real
world usage. A great deal has been added to the documentation for states and
the modules and functions available to states have been cleanly documented.
.sp
A number of State System bugs have also been founds and repaired, the output
from the state system has also been refined to be extremely clear and concise.
.sp
Error reporting has also been introduced, issues found in sls files will now
be clearly reported when executing Salt States.
.SS Extend Declaration
.sp
The Salt States have also gained the \fBextend\fP declaration. This declaration
allows for states to be cleanly modified in a post environment. Simply said,
if there is an apache.sls file that declares the apache service, then another
sls can include apache and then extend it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- apache

extend:
  apache:
    service:
      \- require:
        \- pkg: mod_python

mod_python:
  pkg:
    \- installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The notable behavior with the extend functionality is that it literally extends
or overwrites a declaration set up in another sls module. This means that Salt
will behave as though the modifications were made directly to the apache sls.
This ensures that the apache service in this example is directly tied to all
requirements.
.SS Highstate Structure Specification
.sp
This release comes with a clear specification of the Highstate data structure
that is used to declare Salt States. This specification explains everything
that can be declared in the Salt SLS modules.
.sp
The specification is extremely simple, and illustrates how Salt has been able
to fulfill the requirements of a central configuration manager within a simple
and easy to understand format and specification.
.SS SheBang Renderer Switch
.sp
It came to our attention that having many renderers means that there may be a
situation where more than one State Renderer should be available within a
single State Tree.
.sp
The method chosen to accomplish this was something already familiar to
developers and systems administrators, a SheBang. The Python State Renderer
displays this new capability.
.SS Python State Renderer
.sp
Until now Salt States could only be declared in yaml or json using Jinja or
Mako. A new, very powerful, renderer has been added, making it possible to
write Salt States in pure Python:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!py


def run():
    \(dq\(dq\(dq
    Install the python\-mako package
    \(dq\(dq\(dq
    return {\(dqinclude\(dq: [\(dqpython\(dq], \(dqpython\-mako\(dq: {\(dqpkg\(dq: [\(dqinstalled\(dq]}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This renderer is used by making a run function that returns the Highstate data
structure. Any capabilities of Python can be used in pure Python sls modules.
.sp
This example of a pure Python sls module is the same as this example in yaml:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- python

python\-mako:
  pkg:
    \- installed
.ft P
.fi
.UNINDENT
.UNINDENT
.SS FreeBSD Support
.sp
Additional support has been added for FreeBSD, this is Salt\(aqs first branch out
of the Linux world and proves the viability of Salt on non\-Linux platforms.
.sp
Salt remote execution already worked on FreeBSD, and should work without issue
on any Unix\-like platform. But this support comes in the form of package
management and user support, so Salt States also work on FreeBSD now.
.sp
The new freebsdpkg module provides package management support for FreeBSD
and the new pw_user and pw_group provide user and group management.
.SS Module and State Additions
.SS Cron Support
.sp
Support for managing the system crontab has been added, declaring a cron state
can be done easily:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
date > /tmp/datestamp:
  cron:
    \- present
    \- user: fred
    \- minute: 5
    \- hour: 3
.ft P
.fi
.UNINDENT
.UNINDENT
.SS File State Additions
.sp
The file state has been given a number of new features, primarily the
directory, recurse, symlink, and absent functions.
.INDENT 0.0
.TP
.B file.directory
Make sure that a directory exists and has the right permissions.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/srv/foo:
  file:
    \- directory
    \- user: root
    \- group: root
    \- mode: 1755
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B file.symlink
Make a symlink.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/var/lib/www:
  file:
    \- symlink
    \- target: /srv/www
    \- force: True
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B file.recurse
The recurse state function will recursively download a directory on the
master file server and place it on the minion. Any change in the files on
the master will be pushed to the minion. The recurse function is very
powerful and has been tested by pushing out the full Linux kernel source.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/opt/code:
  file:
    \- recurse
    \- source: salt://linux
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B file.absent
Make sure that the file is not on the system, recursively deletes
directories, files, and symlinks.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/httpd/conf.d/somebogusfile.conf:
  file:
    \- absent
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Sysctl Module and State
.sp
The sysctl module and state allows for sysctl components in the kernel to be
managed easily. the sysctl module contains the following functions:
.INDENT 0.0
.TP
.B sysctl.show
Return a list of sysctl parameters for this minion
.TP
.B sysctl.get
Return a single sysctl parameter for this minion
.TP
.B sysctl.assign
Assign a single sysctl parameter for this minion
.TP
.B sysctl.persist
Assign and persist a simple sysctl parameter for this minion
.UNINDENT
.sp
The sysctl state allows for sysctl parameters to be assigned:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vm.swappiness:
  sysctl:
    \- present
    \- value: 20
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Kernel Module Management
.sp
A module for managing Linux kernel modules has been added. The new functions
are as follows:
.INDENT 0.0
.TP
.B kmod.available
Return a list of all available kernel modules
.TP
.B kmod.check_available
Check to see if the specified kernel module is available
.TP
.B kmod.lsmod
Return a dict containing information about currently loaded modules
.TP
.B kmod.load
Load the specified kernel module
.TP
.B kmod.remove
Unload the specified kernel module
.UNINDENT
.sp
The kmod state can enforce modules be either present or absent:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
kvm_intel:
  kmod:
    \- present
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Ssh Authorized Keys
.sp
The ssh_auth state can distribute ssh authorized keys out to minions. Ssh
authorized keys can be present or absent.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
AAAAB3NzaC1kc3MAAACBAL0sQ9fJ5bYTEyYvlRBsJdDOo49CNfhlWHWXQRqul6rwL4KIuPrhY7hBw0tV7UNC7J9IZRNO4iGod9C+OYutuWGJ2x5YNf7P4uGhH9AhBQGQ4LKOLxhDyT1OrDKXVFw3wgY3rHiJYAbd1PXNuclJHOKL27QZCRFjWSEaSrUOoczvAAAAFQD9d4jp2dCJSIseSkk4Lez3LqFcqQAAAIAmovHIVSrbLbXAXQE8eyPoL9x5C+x2GRpEcA7AeMH6bGx/xw6NtnQZVMcmZIre5Elrw3OKgxcDNomjYFNHuOYaQLBBMosyO++tJe1KTAr3A2zGj2xbWO9JhEzu8xvSdF8jRu0N5SRXPpzSyU4o1WGIPLVZSeSq1VFTHRT4lXB7PQAAAIBXUz6ZO0bregF5xtJRuxUN583HlfQkXvxLqHAGY8WSEVlTnuG/x75wolBDbVzeTlxWxgxhafj7P6Ncdv25Wz9wvc6ko/puww0b3rcLNqK+XCNJlsM/7lB8Q26iK5mRZzNsGeGwGTyzNIMBekGYQ5MRdIcPv5dBIP/1M6fQDEsAXQ==:
  ssh_auth:
    \- present
    \- user: frank
    \- enc: dsa
    \- comment: \(aqFrank\(aqs key\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Salt 0.9.4 Release Notes
.INDENT 0.0
.TP
.B release
2011\-11\-27
.UNINDENT
.sp
Salt 0.9.4 has arrived. This is a critical update that repairs a number of
key bugs found in 0.9.3. But this update is not without feature additions
as well! 0.9.4 adds support for Gentoo portage to the pkg module and state
system. Also there are 2 major new state additions, the failhard option and
the ability to set up finite state ordering with the \fBorder\fP option.
.sp
This release also sees our largest increase in community contributions.
These contributors have and continue to be the life blood of the Salt
project, and the team continues to grow. I want to put out a big thanks to
our new and existing contributors.
.SS Download!
.sp
The Salt source can be downloaded from PyPI:
.sp
\fI\%https://pypi.python.org/packages/source/s/salt/salt\-0.9.4.tar.gz\fP
.sp
For instructions on how to set up Salt please see the \fI\%Installation\fP
instructions.
.SS New Features
.SS Failhard State Option
.sp
Normally, when a state fails Salt continues to execute the remainder of the
defined states and will only refuse to execute states that require the failed
state.
.sp
But the situation may exist, where you would want all state execution to stop
if a single state execution fails. The capability to do this is called
\fBfailing hard\fP\&.
.SS State Level Failhard
.sp
A single state can have a failhard set, this means that if this individual
state fails that all state execution will immediately stop. This is a great
thing to do if there is a state that sets up a critical config file and
setting a require for each state that reads the config would be cumbersome.
A good example of this would be setting up a package manager early on:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/yum.repos.d/company.repo:
  file:
    \- managed
    \- source: salt://company/yumrepo.conf
    \- user: root
    \- group: root
    \- mode: 644
    \- order: 1
    \- failhard: True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this situation, the yum repo is going to be configured before other states,
and if it fails to lay down the config file, than no other states will be
executed.
.SS Global Failhard
.sp
It may be desired to have failhard be applied to every state that is executed,
if this is the case, then failhard can be set in the master configuration
file. Setting failhard in the master configuration file will result in failing
hard when any minion gathering states from the master have a state fail.
.sp
This is NOT the default behavior, normally Salt will only fail states that
require a failed state.
.sp
Using the global failhard is generally not recommended, since it can result
in states not being executed or even checked. It can also be confusing to
see states failhard if an admin is not actively aware that the failhard has
been set.
.sp
To use the global failhard set failhard: True in the master configuration
.SS Finite Ordering of State Execution
.sp
When creating salt sls files, it is often important to ensure that they run in
a specific order. While states will always execute in the same order, that
order is not necessarily defined the way you want it.
.sp
A few tools exist in Salt to set up the correct state ordering, these tools
consist of requisite declarations and order options.
.SS The Order Option
.sp
Before using the order option, remember that the majority of state ordering
should be done with requisite statements, and that a requisite statement
will override an order option.
.sp
The order option is used by adding an order number to a state declaration
with the option \fIorder\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg:
    \- installed
    \- order: 1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By adding the order option to \fI1\fP this ensures that the vim package will be
installed in tandem with any other state declaration set to the order \fI1\fP\&.
.sp
Any state declared without an order option will be executed after all states
with order options are executed.
.sp
But this construct can only handle ordering states from the beginning.
Sometimes you may want to send a state to the end of the line, to do this
set the order to last:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
vim:
  pkg:
    \- installed
    \- order: last
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Substantial testing has gone into the state system and it is ready for real
world usage. A great deal has been added to the documentation for states and
the modules and functions available to states have been cleanly documented.
.sp
A number of State System bugs have also been founds and repaired, the output
from the state system has also been refined to be extremely clear and concise.
.sp
Error reporting has also been introduced, issues found in sls files will now
be clearly reported when executing Salt States.
.SS Gentoo Support
.sp
Additional experimental support has been added for Gentoo. This is found in
the contribution from Doug Renn, aka nestegg.
.SS Salt 0.9.5 Release Notes
.INDENT 0.0
.TP
.B release
2012\-01\-15
.UNINDENT
.sp
Salt 0.9.5 is one of the largest steps forward in the development of Salt.
.sp
0.9.5 comes with many milestones, this release has seen the community of
developers grow out to an international team of 46 code contributors and has
many feature additions, feature enhancements, bug fixes and speed improvements.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Be sure to \fI\%read the upgrade instructions\fP about the
switch to msgpack before upgrading!
.UNINDENT
.UNINDENT
.SS Community
.sp
Nothing has proven to have more value to the development of Salt that the
outstanding community that has been growing at such a great pace around Salt.
This has proven not only that Salt has great value, but also the
expandability of Salt is as exponential as I originally intended.
.sp
0.9.5 has received over 600 additional commits since 0.9.4 with a swath of new
committers. The following individuals have contributed to the development of
0.9.5:
.INDENT 0.0
.IP \(bu 2
Aaron Bull Schaefer
.IP \(bu 2
Antti Kaihola
.IP \(bu 2
Bas Tichelaar
.IP \(bu 2
Brad Barden
.IP \(bu 2
Brian Wagner
.IP \(bu 2
Byron Clark
.IP \(bu 2
Chris Scheller
.IP \(bu 2
Christer Edwards
.IP \(bu 2
Clint Savage
.IP \(bu 2
Corey Quinn
.IP \(bu 2
David Boucha
.IP \(bu 2
Eivind Uggedal
.IP \(bu 2
Eric Poelke
.IP \(bu 2
Evan Borgstrom
.IP \(bu 2
Jed Glazner
.IP \(bu 2
Jeff Schroeder
.IP \(bu 2
Jeffrey C. Ollie
.IP \(bu 2
Jonas Buckner
.IP \(bu 2
Kent Tenney
.IP \(bu 2
Martin Schnabel
.IP \(bu 2
Maxim Burgerhout
.IP \(bu 2
Mitch Anderson
.IP \(bu 2
Nathaniel Whiteinge
.IP \(bu 2
Seth House
.IP \(bu 2
Thomas S Hatch
.IP \(bu 2
Thomas Schreiber
.IP \(bu 2
Tor Hveem
.IP \(bu 2
lzyeval
.IP \(bu 2
syphernl
.UNINDENT
.sp
This makes 21 new developers since 0.9.4 was released!
.sp
To keep up with the growing community follow Salt on Black Duck Open Hub
(\fI\%https://www.openhub.net/p/salt\fP), to join the Salt development community, fork
Salt on GitHub, and get coding (\fI\%https://github.com/saltstack/salt\fP)!
.SS Major Features
.SS SPEED! Pickle to msgpack
.sp
For a few months now we have been talking about moving away from Python
pickles for network serialization, but a preferred serialization format
had not yet been found. After an extensive performance testing period
involving everything from JSON to protocol buffers, a clear winner emerged.
Message Pack (\fI\%https://msgpack.org/\fP) proved to not only be the fastest and most
compact, but also the most \(dqsalt like\(dq. Message Pack is simple, and the code
involved is very small. The msgpack library for Python has been added directly
to Salt.
.sp
This move introduces a few changes to Salt. First off, Salt is no longer a
\(dqnoarch\(dq package, since the msgpack lib is written in C. Salt 0.9.5 will also
have compatibility issues with 0.9.4 with the default configuration.
.sp
We have gone through great lengths to avoid backwards compatibility issues with
Salt, but changing the serialization medium was going to create issues
regardless. Salt 0.9.5 is somewhat backwards compatible with earlier minions. A
0.9.5 master can command older minions, but only if the \fBserial\fP
config value in the master is set to \fBpickle\fP\&. This will tell the master to
publish messages in pickle format and will allow the master to receive messages
in both msgpack and pickle formats.
.sp
Therefore \fBthe suggested methods for upgrading\fP are either to just upgrade
everything at once, or:
.INDENT 0.0
.IP 1. 3
Upgrade the master to 0.9.5
.IP 2. 3
Set \fBserial\fP to \fBpickle\fP in the master config
.IP 3. 3
Upgrade the minions
.IP 4. 3
Remove the \fBserial\fP option from the master config
.UNINDENT
.sp
Since pickles can be used as a security exploit the ability for a master to
accept pickles from minions at all will be removed in a future release.
.SS C Bindings for YAML
.sp
All of the YAML rendering is now done with the YAML C bindings. This speeds up
all of the sls files when running states.
.SS Experimental Windows Support
.sp
David Boucha has worked tirelessly to bring initial support to Salt for
Microsoft Windows operating systems. Right now the Salt Minion can run as a
native Windows service and accept commands.
.sp
In the weeks and months to come Windows will receive the full treatment and
will have support for Salt States and more robust support for managing Windows
systems. This is a big step forward for Salt to move entirely outside of the
Unix world, and proves Salt is a viable cross platform solution. Big Thanks
to Dave for his contribution here!
.SS Dynamic Module Distribution
.sp
Many Salt users have expressed the desire to have Salt distribute in\-house
modules, states, renderers, returners, and grains. This support has been added
in a number of ways:
.SS Modules via States
.sp
Now when salt modules are deployed to a minion via the state system as a file,
then the modules will be automatically loaded into the active running minion
\- no restart required \- and into the active running state. So custom state
modules can be deployed and used in the same state run.
.SS Modules via Module Environment Directories
.sp
Under the file_roots each environment can now have directories that are used
to deploy large groups of modules. These directories sync modules at the
beginning of a state run on the minion, or can be manually synced via the Salt
module \fI\%salt.modules.saltutil.sync_all\fP\&.
.sp
The directories are named:
.INDENT 0.0
.IP \(bu 2
\fB_modules\fP
.IP \(bu 2
\fB_states\fP
.IP \(bu 2
\fB_grains\fP
.IP \(bu 2
\fB_renderers\fP
.IP \(bu 2
\fB_returners\fP
.UNINDENT
.sp
The modules are pushed to their respective scopes on the minions.
.SS Module Reloading
.sp
Modules can now be reloaded without restarting the minion, this is done by
calling the \fBsalt.modules.sys.reload_modules\fP function.
.sp
But wait, there\(aqs more! Now when a salt module of any type is added via
states the modules will be automatically reloaded, allowing for modules to be
laid down with states and then immediately used.
.sp
Finally, all modules are reloaded when modules are dynamically distributed
from the salt master.
.SS Enable / Disable Added to Service
.sp
A great deal of demand has existed for adding the capability to set services
to be started at boot in the service module. This feature also comes with an
overhaul of the service modules and initial systemd support.
.sp
This means that the \fI\%service state\fP can now
accept \fB\- enable: True\fP to make sure a service is enabled at boot, and \fB\-
enable: False\fP to make sure it is disabled.
.SS Compound Target
.sp
A new target type has been added to the lineup, the compound target. In
previous versions the desired minions could only be targeted via a single
specific target type, but now many target specifications can be declared.
.sp
These targets can also be separated by and/or operators, so certain properties
can be used to omit a node:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-C \(aqwebserv* and G@os:Debian or E@db.*\(aq test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
will match all minions with ids starting with webserv via a glob and minions
matching the \fBos:Debian\fP grain. Or minions that match the \fBdb.*\fP regular
expression.
.SS Node Groups
.sp
Often the convenience of having a predefined group of minions to execute
targets on is desired. This can be accomplished with the new nodegroups
feature. Nodegroups allow for predefined compound targets to be declared in
the master configuration file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
nodegroups:
  group1: \(aqL@foo.domain.com,bar.domain.com,baz.domain.com and bl*.domain.com\(aq
  group2: \(aqG@os:Debian and foo.domain.com\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And then used via the \fB\-N\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \-N group1 test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Minion Side Data Store
.sp
The data module introduces the initial approach into storing persistent data on
the minions, specific to the minions. This allows for data to be stored on
minions that can be accessed from the master or from the minion.
.sp
The Minion datastore is young, and will eventually provide an interface similar
to a more mature key/value pair server.
.SS Major Grains Improvement
.sp
The Salt grains have been overhauled to include a massive amount of extra data.
this includes hardware data, os data and salt specific data.
.SS Salt \-Q is Useful Now
.sp
In the past the salt query system, which would display the data from recent
executions would be displayed in pure Python, and it was unreadable.
.sp
0.9.5 has added the outputter system to the \fB\-Q\fP option, thus enabling the
salt query system to return readable output.
.SS Packaging Updates
.sp
Huge strides have been made in packaging Salt for distributions. These
additions are thanks to our wonderful community where the work to set up
packages has proceeded tirelessly.
.SS FreeBSD
.sp
Salt on FreeBSD? There a port for that:
.sp
\fI\%https://svnweb.freebsd.org/ports/head/sysutils/py\-salt/\fP
.sp
This port was developed and added by Christer Edwards. This also marks the
first time Salt has been included in an upstream packaging system!
.SS Fedora and Red Hat Enterprise
.sp
Salt packages have been prepared for inclusion in the Fedora Project and in
EPEL for Red Hat Enterprise 5 and 6. These packages are the result of the
efforts made by Clint Savage (herlo).
.SS Debian/Ubuntu
.sp
A team of many contributors have assisted in developing packages for Debian
and Ubuntu. Salt is still actively seeking inclusion in upstream Debian and
Ubuntu and the package data that has been prepared is being pushed through
the needed channels for inclusion.
.sp
These packages have been prepared with the help of:
.INDENT 0.0
.IP \(bu 2
Corey
.IP \(bu 2
Aaron Toponce
.IP \(bu 2
and\(ga
.UNINDENT
.SS More to Come
.sp
We are actively seeking inclusion in more distributions. Primarily getting
Salt into Gentoo, SUSE, OpenBSD, and preparing Solaris support are all turning
into higher priorities.
.SS Refinement
.sp
Salt continues to be refined into a faster, more stable and more usable
application. 0.9.5 comes with more debug logging, more bug fixes and more
complete support.
.SS More Testing, More BugFixes
.sp
0.9.5 comes with more bugfixes due to more testing than any previous release.
The growing community and the introduction a dedicated QA environment have
unearthed many issues that were hiding under the covers. This has further
refined and cleaned the state interface, taking care of things from minor
visual issues to repairing misleading data.
.SS Custom Exceptions
.sp
A custom exception module has been added to throw salt specific exceptions.
This allows Salt to give much more granular error information.
.SS New Modules
.SS \fI\%data\fP
.sp
The new data module manages a persistent datastore on the minion.
Big thanks to bastichelaar for his help refining this module
.SS \fI\%freebsdkmod\fP
.sp
FreeBSD kernel modules can now be managed in the same way Salt handles Linux
kernel modules.
.sp
This module was contributed thanks to the efforts of Christer Edwards
.SS \fI\%gentoo_service\fP
.sp
Support has been added for managing services in Gentoo. Now Gentoo services
can be started, stopped, restarted, enabled, disabled, and viewed.
.SS \fI\%pip\fP
.sp
The pip module introduces management for pip installed applications.
Thanks goes to whitinge for the addition of the pip module
.SS \fI\%rh_service\fP
.sp
The rh_service module enables Red Hat and Fedora specific service management.
Now Red Hat like systems come with extensive management of the classic init
system used by Red Hat
.SS \fI\%saltutil\fP
.sp
The saltutil module has been added as a place to hold functions used in the
maintenance and management of salt itself. Saltutil is used to salt the salt
minion. The saltutil module is presently used only to sync extension modules
from the master server.
.SS \fBsystemd\fP
.sp
Systemd support has been added to Salt, now systems using this next generation
init system are supported on systems running systemd.
.SS \fBvirtualenv\fP
.sp
The virtualenv module has been added to allow salt to create virtual Python
environments.
Thanks goes to whitinge for the addition of the virtualenv module
.SS \fI\%win_disk\fP
.sp
Support for gathering disk information on Microsoft Windows minions
The windows modules come courtesy of Utah_Dave
.SS \fI\%win_service\fP
.sp
The win_service module adds service support to Salt for Microsoft Windows
services
.SS \fI\%win_useradd\fP
.sp
Salt can now manage local users on Microsoft Windows Systems
.SS \fByumpkg5\fP
.sp
The yumpkg module introduces in 0.9.4 uses the yum API to interact with the
yum package manager. Unfortunately, on Red Hat 5 systems salt does not have
access to the yum API because the yum API is running under Python 2.4 and Salt
needs to run under Python 2.6.
.sp
The yumpkg5 module bypasses this issue by shelling out to yum on systems where
the yum API is not available.
.SS New States
.SS \fI\%mysql_database\fP
.sp
The new mysql_database state adds the ability to systems running a mysql
server to manage the existence of mysql databases.
.sp
The mysql states are thanks to syphernl
.SS \fI\%mysql_user\fP
.sp
The mysql_user state enables mysql user management.
.SS \fBvirtualenv\fP
.sp
The virtualenv state can manage the state of Python virtual environments.
Thanks to Whitinge for the virtualenv state
.SS New Returners
.SS \fBcassandra_returner\fP
.sp
A returner allowing Salt to send data to a cassandra server.
Thanks to Byron Clark for contributing this returner
.SS Salt 0.9.6 Release Notes
.INDENT 0.0
.TP
.B release
2012\-01\-21
.UNINDENT
.sp
Salt 0.9.6 is a release targeting a few bugs and changes. This is primarily
targeting an issue found in the names declaration in the state system. But a
few other bugs were also repaired, like missing support for grains in extmods.
.sp
Due to a conflict in distribution packaging msgpack will no longer be bundled
with Salt, and is required as a dependency.
.SS New Features
.SS HTTP and ftp support in files.managed
.sp
Now under the source option in the file.managed state a HTTP or ftp address
can be used instead of a file located on the salt master.
.SS Allow Multiple Returners
.sp
Now the returner interface can define multiple returners, and will also return
data back to the master, making the process less ambiguous.
.SS Minion Memory Improvements
.sp
A number of modules have been taken out of the minion if the underlying
systems required by said modules are not present on the minion system.
A number of other modules need to be stripped out in this same way which
should continue to make the minion more efficient.
.SS Minions Can Locally Cache Return Data
.sp
A new option, cache_jobs, has been added to the minion to allow for all of the
historically run jobs to cache on the minion, allowing for looking up historic
returns. By default cache_jobs is set to False.
.SS Pure Python Template Support For file.managed
.sp
Templates in the file.managed state can now be defined in a Python script.
This script needs to have a run function that returns the string that needs to
be in the named file.
.SS Salt 0.9.7 Release Notes
.INDENT 0.0
.TP
.B release
2012\-02\-15
.UNINDENT
.sp
Salt 0.9.7 is here! The latest iteration of Salt brings more features and many
fixes. This release is a great refinement over 0.9.6, adding many conveniences
under the hood, as well as some features that make working with Salt much
better.
.sp
A few highlights include the new Job system, refinements to the requisite
system in states, the \fBmod_init\fP interface for states, external node
classification, search path to managed files in the file state, and refinements
and additions to dynamic module loading.
.sp
0.9.7 also introduces the long developed (and oft changed) unit test framework
and the initial unit tests.
.SS Major Features
.SS Salt Jobs Interface
.sp
The new jobs interface makes the management of running executions much cleaner
and more transparent. Building on the existing execution framework the jobs
system allows clear introspection into the active running state of the
running Salt interface.
.sp
The Jobs interface is centered in the new minion side proc system. The
minions now store msgpack serialized files under \fB/var/cache/salt/proc\fP\&.
These files keep track of the active state of processes on the minion.
.SS Functions in the saltutil Module
.sp
A number of functions have been added to the saltutil module to manage and
view the jobs:
.sp
\fBrunning\fP \- Returns the data of all running jobs that are found in the proc
directory.
.sp
\fBfind_job\fP \- Returns specific data about a certain job based on job id.
.sp
\fBsignal_job\fP \- Allows for a given jid to be sent a signal.
.sp
\fBterm_job\fP \- Sends a termination signal (\fBSIGTERM, 15\fP) to the process
controlling the specified job.
.sp
\fBkill_job\fP Sends a kill signal (\fBSIGKILL, 9\fP) to the process controlling the
specified job.
.SS The jobs Runner
.sp
A convenience runner front end and reporting system has been added as well.
The jobs runner contains functions to make viewing data easier and cleaner.
.sp
The jobs runner contains a number of functions...
.SS active
.sp
The active function runs \fBsaltutil.running\fP on all minions and formats the
return data about all running jobs in a much more usable and compact format.
The active function will also compare jobs that have returned and jobs that
are still running, making it easier to see what systems have completed a job
and what systems are still being waited on.
.SS lookup_jid
.sp
When jobs are executed the return data is sent back to the master and cached.
By default is cached for 24 hours, but this can be configured via the
\fBkeep_jobs\fP option in the master configuration.
.sp
Using the \fBlookup_jid\fP runner will display the same return data that the
initial job invocation with the salt command would display.
.SS list_jobs
.sp
Before finding a historic job, it may be required to find the job id.
\fBlist_jobs\fP will parse the cached execution data and display all of the job
data for jobs that have already, or partially returned.
.SS External Node Classification
.sp
Salt can now use external node classifiers like Cobbler\(aqs
\fBcobbler\-ext\-nodes\fP\&.
.sp
Salt uses specific data from the external node classifier. In particular the
classes value denotes which sls modules to run, and the environment value sets
to another environment.
.sp
An external node classification can be set in the master configuration file via
the \fBexternal_nodes\fP option:
\fI\%https://salt.readthedocs.io/en/latest/ref/configuration/master.html#external\-nodes\fP
.sp
External nodes are loaded in addition to the top files. If it is intended to
only use external nodes, do not deploy any top files.
.SS State Mod Init System
.sp
An issue arose with the pkg state. Every time a package was run Salt would
need to refresh the package database. This made systems with slower package
metadata refresh speeds much slower to work with. To alleviate this issue the
\fBmod_init\fP interface has been added to salt states.
.sp
The \fBmod_init\fP interface is a function that can be added to a state file.
This function is called with the first state called. In the case of the pkg
state, the \fBmod_init\fP function sets up a tag which makes the package database
only refresh on the first attempt to install a package.
.sp
In a nutshell, the \fBmod_init\fP interface allows a state to run any command that
only needs to be run once, or can be used to set up an environment for working
with the state.
.SS Source File Search Path
.sp
The file state continues to be refined, adding speed and capabilities. This
release adds the ability to pass a list to the source option. This list is then
iterated over until the source file is found, and the first found file is used.
.sp
The new syntax looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/httpd/conf/httpd.conf:
  file:
    \- managed
    \- source:
      \- salt://httpd/httpd.conf
      \- http://myserver/httpd.conf: md5=8c1fe119e6f1fd96bc06614473509bf1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The source option can take sources in the list from the salt file server
as well as an arbitrary web source. If using an arbitrary web source the
checksum needs to be passed as well for file verification.
.SS Refinements to the Requisite System
.sp
A few discrepancies were still lingering in the requisite system, in
particular, it was not possible to have a \fBrequire\fP and a \fBwatch\fP requisite
declared in the same state declaration.
.sp
This issue has been alleviated, as well as making the requisite system run
more quickly.
.SS Initial Unit Testing Framework
.sp
Because of the module system, and the need to test real scenarios, the
development of a viable unit testing system has been difficult, but unit
testing has finally arrived. Only a small amount of unit testing coverage
has been developed, much more coverage will be in place soon.
.sp
A huge thanks goes out to those who have helped with unit testing, and the
contributions that have been made to get us where we are. Without these
contributions unit tests would still be in the dark.
.SS Compound Targets Expanded
.sp
Originally only support for \fBand\fP and \fBor\fP were available in the compound
target. 0.9.7 adds the capability to negate compound targets with \fBnot\fP\&.
.SS Nodegroups in the Top File
.sp
Previously the nodegroups defined in the master configuration file could not
be used to match nodes for states. The nodegroups support has been expanded
and the nodegroups defined in the master configuration can now be used to
match minions in the top file.
.SS Salt 0.9.8 Release Notes
.INDENT 0.0
.TP
.B release
2012\-03\-21
.UNINDENT
.sp
Salt 0.9.8 is a big step forward, with many additions and enhancements, as
well as a number of precursors to advanced future developments.
.sp
This version of Salt adds much more power to the command line, making the
old hard timeout issues a thing of the past and adds keyword argument
support. These additions are also available in the salt client API, making
the available API tools much more powerful.
.sp
The new pillar system allows for data to be stored on the master and
assigned to minions in a granular way similar to the state system. It also
allows flexibility for users who want to keep data out of their state tree
similar to \(aqexternal lookup\(aq functionality in other tools.
.sp
A new way to extend requisites was added, the \(dqrequisite in\(dq statement.
This makes adding requires or watch statements to external state decs
much easier.
.sp
Additions to requisites making them much more powerful have been added as well
as improved error checking for sls files in the state system. A new provider
system has been added to allow for redirecting what modules run in the
background for individual states.
.sp
Support for openSUSE has been added and support for Solaris has begun
serious development. Windows support has been significantly enhanced as well.
.sp
The matcher and target systems have received a great deal of attention. The
default behavior of grain matching has changed slightly to reflect the rest
of salt and the compound matcher system has been refined.
.sp
A number of impressive features with keyword arguments have been added to both
the CLI and to the state system. This makes states much more powerful and
flexible while maintaining the simple configuration everyone loves.
.sp
The new batch size capability allows for executions to be rolled through a
group of targeted minions a percentage or specific number at a time. This
was added to prevent the \(dqthundering herd\(dq problem when targeting large
numbers of minions for things like service restarts or file downloads.
.SS Upgrade Considerations
.SS Upgrade Issues
.sp
There was a previously missed oversight which could cause a newer minion to
crash an older master. That oversight has been resolved so the version
incompatibility issue will no longer occur. When upgrading to 0.9.8 make
sure to upgrade the master first, followed by the minions.
.SS Debian/Ubuntu Packages
.sp
The original Debian/Ubuntu packages were called salt and included all salt
applications. New packages in the ppa are split by function. If an old salt
package is installed then it should be manually removed and the new split
packages need to be freshly installed.
.sp
On the master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# apt\-get purge salt
# apt\-get install salt\-{master,minion}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
On the minions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# apt\-get purge salt
# apt\-get install salt\-minion
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And on any Syndics:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# apt\-get install salt\-syndic
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The official Salt PPA for Ubuntu is located at:
\fI\%https://launchpad.net/~saltstack/+archive/ubuntu/salt\fP
.SS Major Features
.SS Pillar
.sp
\fI\%Pillar\fP offers an interface to declare variable data on the master that is then
assigned to the minions. The pillar data is made available to all modules,
states, sls files etc. It is compiled on the master and is declared using the
existing renderer system. This means that learning pillar should be fairly
trivial to those already familiar with salt states.
.SS CLI Additions
.sp
The \fBsalt\fP command has received a serious overhaul and is more powerful
than ever. Data is returned to the terminal as it is received, and the salt
command will now wait for all running minions to return data before stopping.
This makes adding very large \fI\-\-timeout\fP arguments completely unnecessary and
gets rid of long running operations returning empty \fB{}\fP when the timeout is
exceeded.
.sp
When calling salt via sudo, the user originally running salt is saved to the
log for auditing purposes. This makes it easy to see who ran what by just
looking through the minion logs.
.sp
The \fIsalt\-key\fP command gained the \fI\-D\fP and \fI\-\-delete\-all\fP arguments for
removing all keys. Be careful with this one!
.SS Running States Without a Master
.sp
The addition of running states without a salt\-master has been added
to 0.9.8. This feature allows for the unmodified salt state tree to be
read locally from a minion. The result is that the UNMODIFIED state tree
has just become portable, allowing minions to have a local copy of states
or to manage states without a master entirely.
.sp
This is accomplished via the new file client interface in Salt that allows
for the \fBsalt://\fP URI to be redirected to custom interfaces. This means that
there are now two interfaces for the salt file server, calling the master
or looking in a local, minion defined \fBfile_roots\fP\&.
.sp
This new feature can be used by modifying the minion config to point to a
local \fBfile_roots\fP and setting the \fBfile_client\fP option to \fBlocal\fP\&.
.SS Keyword Arguments and States
.sp
State modules now accept the \fB**kwargs\fP argument. This results in all data
in a sls file assigned to a state being made available to the state function.
.sp
This passes data in a transparent way back to the modules executing the logic.
In particular, this allows adding arguments to the \fBpkg.install\fP module that
enable more advanced and granular controls with respect to what the state is
capable of.
.sp
An example of this along with the new debconf module for installing ldap
client packages on Debian:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ldap\-client\-packages:
  pkg:
    \- debconf: salt://debconf/ldap\-client.ans
    \- installed
    \- names:
      \- nslcd
      \- libpam\-ldapd
      \- libnss\-ldapd
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Keyword Arguments and the CLI
.sp
In the past it was required that all arguments be passed in the proper order to
the \fIsalt\fP and \fIsalt\-call\fP commands. As of 0.9.8, keyword arguments can be
passed in the form of \fBkwarg=argument\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt \-G \(aqtype:dev\(aq git.clone \e
    repository=https://github.com/saltstack/salt.git cwd=/tmp/salt user=jeff
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Matcher Refinements and Changes
.sp
A number of fixes and changes have been applied to the Matcher system. The
most noteworthy is the change in the grain matcher. The grain matcher used to
use a regular expression to match the passed data to a grain, but now defaults
to a shell glob like the majority of match interfaces in Salt. A new option
is available that still uses the old style regex matching to grain data called
\fBgrain\-pcre\fP\&. To use regex matching in compound matches use the letter \fIP\fP\&.
.sp
For example, this would match any ArchLinux or Fedora minions:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# salt \-\-grain\-pcre \(aqos:(Arch:Fed).*\(aq test.ping
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And the associated compound matcher suitable for \fBtop.sls\fP is \fIP\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
P@os:(Arch|Fed).*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE\fP: Changing the grains matcher from pcre to glob is backwards
incompatible.
.sp
Support has been added for matching minions with Yahoo\(aqs range library. This
is handled by passing range syntax with \fI\-R\fP or \fI\-\-range\fP arguments to salt.
.sp
More information at:
\fI\%https://github.com/ytoolshed/range/wiki/%22yamlfile%22\-module\-file\-spec\fP
.SS Requisite \(dqin\(dq
.sp
A new means to updating requisite statements has been added to make adding
watchers and requires to external states easier. Before 0.9.8 the only way
to extend the states that were watched by a state outside of the sls was to
use an extend statement:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- http
extend:
  apache:
    service:
      \- watch:
        \- pkg: tomcat

tomcat:
  pkg:
    \- installed
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
But the new \fBRequisite in\fP statement allows for easier extends for
requisites:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- http

tomcat:
  pkg:
    \- installed
    \- watch_in:
      \- service: apache
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Requisite in is part of the extend system, so still remember to always include
the sls that is being extended!
.SS Providers
.sp
Salt predetermines what modules should be mapped to what uses based on the
properties of a system. These determinations are generally made for modules
that provide things like package and service management. The apt module
maps to pkg on Debian and the yum module maps to pkg on Fedora for instance.
.sp
Sometimes in states, it may be necessary for a non\-default module to be used
for the desired functionality. For instance, an Arch Linux system may have
been set up with systemd support. Instead of using the default service module
detected for Arch Linux, the systemd module can be used:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
http:
  service:
    \- running
    \- enable: True
    \- provider: systemd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Default providers can also be defined in the minion config file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
providers:
  service: systemd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When default providers are passed in the minion config, then those providers
will be applied to all functionality in Salt, this means that the functions
called by the minion will use these modules, as well as states.
.SS Requisite Glob Matching
.sp
Requisites can now be defined with glob expansion. This means that if there are
many requisites, they can be defined on a single line.
.sp
To watch all files in a directory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
http:
  service:
    \- running
    \- enable: True
    \- watch:
      \- file: /etc/http/conf.d/*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This example will watch all defined files that match the glob
\fB/etc/http/conf.d/*\fP
.SS Batch Size
.sp
The new batch size option allows commands to be executed while maintaining that
only so many hosts are executing the command at one time. This option can
take a percentage or a finite number:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq \-b 10 test.ping

salt \-G \(aqos:RedHat\(aq \-\-batch\-size 25% apache.signal restart
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will only run test.ping on 10 of the targeted minions at a time and then
restart apache on 25% of the minions matching \fBos:RedHat\fP at a time and work
through them all until the task is complete. This makes jobs like rolling web
server restarts behind a load balancer or doing maintenance on BSD firewalls
using carp much easier with salt.
.SS Module Updates
.sp
This is a list of notable, but non\-exhaustive updates with new and existing
modules.
.sp
Windows support has seen a flurry of support this release cycle. We\(aqve gained
all new \fBfile\fP,
\fI\%network\fP, and
\fI\%shadow\fP modules. Please note
that these are still a work in progress.
.sp
For our ruby users, new \fI\%rvm\fP and
\fI\%gem\fP modules have been added along
with the \fI\%associated\fP
\fI\%states\fP
.sp
The \fI\%virt\fP module gained basic Xen support.
.sp
The \fI\%yum\fP module gained
Scientific Linux support.
.sp
The \fI\%pkg\fP module on Debian, Ubuntu,
and derivatives force apt to run in a non\-interactive mode. This prevents
issues when package installation waits for confirmation.
.sp
A \fBpkg\fP module for OpenSUSE\(aqs
zypper was added.
.sp
The \fBservice\fP module on Ubuntu
natively supports upstart.
.sp
A new \fI\%debconf\fP module was
contributed by our community for more advanced control over deb package
deployments on Debian based distributions.
.sp
The \fI\%mysql.user\fP state and
\fI\%mysql\fP module gained a
\fIpassword_hash\fP argument.
.sp
The \fI\%cmd\fP module and state gained
a \fIshell\fP keyword argument for specifying a shell other than \fB/bin/sh\fP on
Linux / Unix systems.
.sp
New \fI\%git\fP and
\fI\%mercurial\fP modules have been added
for fans of distributed version control.
.SS In Progress Development
.SS Master Side State Compiling
.sp
While we feel strongly that the advantages gained with minion side state
compiling are very critical, it does prevent certain features that may be
desired. 0.9.8 has support for initial master side state compiling, but many
more components still need to be developed, it is hoped that these can be
finished for 0.9.9.
.sp
The goal is that states can be compiled on both the master and the minion
allowing for compilation to be split between master and minion. Why will
this be great? It will allow storing sensitive data on the master and sending
it to some minions without all minions having access to it. This will be
good for handling ssl certificates on front\-end web servers for instance.
.SS Solaris Support
.sp
Salt 0.9.8 sees the introduction of basic Solaris support. The daemon runs
well, but grains and more of the modules need updating and testing.
.SS Windows Support
.sp
Salt states on windows are now much more viable thanks to contributions from
our community! States for file, service, local user, and local group management are more fully
fleshed out along with network and disk modules. Windows users can also now manage
registry entries using the new \(dqreg\(dq module.
.SS Salt 0.9.9 Release Notes
.INDENT 0.0
.TP
.B release
2012\-04\-27
.UNINDENT
.sp
0.9.9 is out and comes with some serious bug fixes and even more serious
features. This release is the last major feature release before 1.0.0 and
could be considered the 1.0.0 release candidate.
.sp
A few updates include more advanced kwargs support, the ability for salt
states to more safely configure a running salt minion, better job directory
management and the new state test interface.
.sp
Many new tests have been added as well, including the new minion swarm test
that allows for easier testing of Salt working with large groups of minions.
This means that if you have experienced stability issues with Salt before,
particularly in larger deployments, that these bugs have been tested for,
found, and killed.
.SS Major Features
.SS State Test Interface
.sp
Until 0.9.9 the only option when running states to see what was going to be
changed was to print out the highstate with state.show_highstate and manually
look it over. But now states can be run to discover what is going to be
changed.
.sp
Passing the option \fBtest=True\fP to many of the state functions will now cause
the salt state system to only check for what is going to be changed and report
on those changes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.highstate test=True
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now states that would have made changes report them back in yellow.
.SS State Syntax Update
.sp
A shorthand syntax has been added to sls files, and it will be the default
syntax in documentation going forward. The old syntax is still fully supported
and will not be deprecated, but it is recommended to move to the new syntax in
the future. This change moves the state function up into the state name using
a dot notation. This is in\-line with how state functions are generally referred
to as well:
.sp
The new way:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/sudoers:
  file.present:
    \- source: salt://sudo/sudoers
    \- user: root
    \- mode: 400
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Use and Use_in Requisites
.sp
Two new requisite statements are available in 0.9.9. The use and use_in
requisite and requisite\-in allow for the transparent duplication of data
between states. When a state \(dquses\(dq another state it copies the other state\(aqs
arguments as defaults. This was created in direct response to the new network
state, and allows for many network interfaces to be configured in the same way
easily. A simple example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
root_file:
  file.absent:
    \- name: /tmp/nothing
    \- user: root
    \- mode: 644
    \- group: root
    \- use_in:
      \- file: /etc/vimrc

fred_file:
  file.absent:
    \- name: /tmp/nothing
    \- user: fred
    \- group: marketing
    \- mode: 660

/files/marketing/district7.rst:
  file.present:
    \- source: salt://marketing/district7.rst
    \- template: jinja
    \- use:
      \- file: fred_file

/etc/vimrc:
  file.present:
    \- source: salt://edit/vimrc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This makes the 2 lower state decs inherit the options from their respectively
\(dqused\(dq state decs.
.SS Network State
.sp
The new network state allows for the configuration of network devices via salt
states and the ip salt module. This addition has been given to the project by
Jeff Hutchins and Bret Palsson from Jive Communications.
.sp
Currently the only network configuration backend available is for Red Hat
based systems, like Red Hat Enterprise, CentOS, and Fedora.
.SS Exponential Jobs
.sp
Originally the jobs executed were stored on the master in the format:
\fB<cachedir>/jobs/jid/{minion ids}\fP
But this format restricted the number of jobs in the cache to the number of
subdirectories allowed on the filesystem. Ext3 for instance limits
subdirectories to 32000. To combat this the new format for 0.9.9 is:
\fB<cachedir>/jobs/jid_hash[:2]/jid_hash[2:]/{minion ids}\fP
So that now the number of maximum jobs that can be run before the cleanup
cycle hits the job directory is substantially higher.
.SS ssh_auth Additions
.sp
The original ssh_auth state was limited to accepting only arguments to apply
to a public key, and the key itself. This was restrictive due to the way the
we learned that many people were using the state, so the key section has been
expanded to accept options and arguments to the key that over ride arguments
passed in the state. This gives substantial power to using ssh_auth with names:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sshkeys:
  ssh_auth:
    \- present
    \- user: backup
    \- enc: ssh\-dss
    \- options:
      \- option1=\(dqvalue1\(dq
      \- option2=\(dqvalue2 flag2\(dq
    \- comment: backup
    \- names:
      \- AAAAB3NzaC1yc2EAAAABIwAAAQEAlyE26SMFFVY5YJvnL7AF5CRTPtAigSW1U887ASfBt6FDa7Qr1YdO5ochiLoz8aSiMKd5h4dhB6ymHbmntMPjQena29jQjXAK4AK0500rMShG1Y1HYEjTXjQxIy/SMjq2aycHI+abiVDn3sciQjsLsNW59t48Udivl2RjWG7Eo+LYiB17MKD5M40r5CP2K4B8nuL+r4oAZEHKOJUF3rzA20MZXHRQuki7vVeWcW7ie8JHNBcq8iObVSoruylXav4aKG02d/I4bz/l0UdGh18SpMB8zVnT3YF5nukQQ/ATspmhpU66s4ntMehULC+ljLvZL40ByNmF0TZc2sdSkA0111==
      \- AAAAB3NzaC1yc2EAAAABIwAAAQEAlyE26SMFFVY5YJvnL7AF5CRTPtAigSW1U887ASfBt6FDa7Qr1YdO5ochiLoz8aSiMKd5h4dhB6ymHbmntMPjQena29jQjXAK4AK0500rMShG1Y1HYEjTXjQxIy/SMjq2aycHI+abiVDn3sciQjsLsNW59t48Udivl2RjWG7Eo+LYiB17MKD5M40r5CP2K4B8nuL+r4oAZEHKOJUF3rzA20MZXHRQuki7vVeWcW7ie8JHNBcq8iObVSoruylXav4aKG02d/I4bz/l0UdGh18SpMB8zVnT3YF5nukQQ/ATspmhpU66s4ntMehULC+ljLvZL40ByNmF0TZc2sdSkA0222== override
      \- ssh\-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAlyE26SMFFVY5YJvnL7AF5CRTPtAigSW1U887ASfBt6FDa7Qr1YdO5ochiLoz8aSiMKd5h4dhB6ymHbmntMPjQena29jQjXAK4AK0500rMShG1Y1HYEjTXjQxIy/SMjq2aycHI+abiVDn3sciQjsLsNW59t48Udivl2RjWG7Eo+LYiB17MKD5M40r5CP2K4B8nuL+r4oAZEHKOJUF3rzA20MZXHRQuki7vVeWcW7ie8JHNBcq8iObVSoruylXav4aKG02d/I4bz/l0UdGh18SpMB8zVnT3YF5nukQQ/ATspmhpU66s4ntMehULC+ljLvZL40ByNmF0TZc2sdSkA0333== override
      \- ssh\-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAlyE26SMFFVY5YJvnL7AF5CRTPtAigSW1U887ASfBt6FDa7Qr1YdO5ochiLoz8aSiMKd5h4dhB6ymHbmntMPjQena29jQjXAK4AK0500rMShG1Y1HYEjTXjQxIy/SMjq2aycHI+abiVDn3sciQjsLsNW59t48Udivl2RjWG7Eo+LYiB17MKD5M40r5CP2K4B8nuL+r4oAZEHKOJUF3rzA20MZXHRQuki7vVeWcW7ie8JHNBcq8iObVSoruylXav4aKG02d/I4bz/l0UdGh18SpMB8zVnT3YF5nukQQ/ATspmhpU66s4ntMehULC+ljLvZL40ByNmF0TZc2sdSkA0444==
      \- option3=\(dqvalue3\(dq,option4=\(dqvalue4 flag4\(dq ssh\-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAlyE26SMFFVY5YJvnL7AF5CRTPtAigSW1U887ASfBt6FDa7Qr1YdO5ochiLoz8aSiMKd5h4dhB6ymHbmntMPjQena29jQjXAK4AK0500rMShG1Y1HYEjTXjQxIy/SMjq2aycHI+abiVDn3sciQjsLsNW59t48Udivl2RjWG7Eo+LYiB17MKD5M40r5CP2K4B8nuL+r4oAZEHKOJUF3rzA20MZXHRQuki7vVeWcW7ie8JHNBcq8iObVSoruylXav4aKG02d/I4bz/l0UdGh18SpMB8zVnT3YF5nukQQ/ATspmhpU66s4ntMehULC+ljLvZL40ByNmF0TZc2sdSkA0555== override
      \- option3=\(dqvalue3\(dq ssh\-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAlyE26SMFFVY5YJvnL7AF5CRTPtAigSW1U887ASfBt6FDa7Qr1YdO5ochiLoz8aSiMKd5h4dhB6ymHbmntMPjQena29jQjXAK4AK0500rMShG1Y1HYEjTXjQxIy/SMjq2aycHI+abiVDn3sciQjsLsNW59t48Udivl2RjWG7Eo+LYiB17MKD5M40r5CP2K4B8nuL+r4oAZEHKOJUF3rzA20MZXHRQuki7vVeWcW7ie8JHNBcq8iObVSoruylXav4aKG02d/I4bz/l0UdGh18SpMB8zVnT3YF5nukQQ/ATspmhpU66s4ntMehULC+ljLvZL40ByNmF0TZc2sdSkA0666==
.ft P
.fi
.UNINDENT
.UNINDENT
.SS LocalClient Additions
.sp
To follow up the recent additions in 0.9.8 of additional kwargs support,
0.9.9 also adds the capability to send kwargs into commands via a dict.
This addition to the LocalClient api can be used like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import salt.client

client = salt.client.LocalClient(\(dq/etc/salt/master\(dq)
ret = client.cmd(\(dq*\(dq, \(dqcmd.run\(dq, [\(dqls \-l\(dq], kwarg={\(dqcwd\(dq: \(dq/etc\(dq})
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This update has been added to all cmd methods in the LocalClient class.
.SS Better Self Salting
.sp
One problem faced with running Salt states, is that it has been difficult
to manage the Salt minion via states, this is due to the fact that if the
minion is called to restart while a state run is happening then the state
run would be killed. 0.9.9 slightly changes the process scope of the state
runs, so now when salt is executing states it can safely restart the
salt\-minion daemon.
.sp
In addition to daemonizing the state run, the apt module also daemonizes.
This update makes it possible to cleanly update the salt\-minion package on
Debian/Ubuntu systems without leaving apt in an inconsistent state or killing
the active minion process mid\-execution.
.SS Wildcards for SLS Modules
.sp
Now, when including sls modules in include statements or in the top file,
shell globs can be used. This can greatly simplify listing matched sls
modules in the top file and include statements:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
base:
  \(aq*\(aq:
    \- files*
    \- core*
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include:
  \- users.dev.*
  \- apache.ser*
.ft P
.fi
.UNINDENT
.UNINDENT
.SS External Pillar
.sp
Since the pillar data is just, data, it does not need to come expressly from
the pillar interface. The external pillar system allows for hooks to be added
making it possible to extract pillar data from any arbitrary external
interface. The external pillar interface is configured via the \fBext_pillar\fP
option. Currently interfaces exist to gather external pillar data via hiera
or via a shell command that sends yaml data to the terminal:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- cmd_yaml: cat /etc/salt/ext.yaml
  \- hiera: /etc/hirea.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The initial external pillar interfaces and extra interfaces can be added to
the file salt/pillar.py, it is planned to add more external pillar interfaces.
If the need arises a new module loader interface will be created in the future
to manage external pillar interfaces.
.SS Single State Executions
.sp
The new state.single function allows for single states to be cleanly executed.
This is a great tool for setting up a small group of states on a system or for
testing out the behavior of single states:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.single user.present name=wade uid=2000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The test interface functions here as well, so changes can also be tested
against as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt \(aq*\(aq state.single user.present name=wade uid=2000 test=True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS New Tests
.sp
A few exciting new test interfaces have been added, the minion swarm allows
not only testing of larger loads, but also allows users to see how Salt behaves
with large groups of minions without having to create a large deployment.
.SS Minion Swarm
.sp
The minion swarm test system allows for large groups of minions to be tested
against easily without requiring large numbers of servers or virtual
machines. The minion swarm creates as many minions as a system can handle and
roots them in the /tmp directory and connects them to a master.
.sp
The benefit here is that we were able to replicate issues that happen only
when there are large numbers of minions. A number of elusive bugs which were
causing stability issues in masters and minions have since been hunted down.
Bugs that used to take careful watch by users over several days can now be
reliably replicated in minutes, and fixed in minutes.
.sp
Using the swarm is easy, make sure a master is up for the swarm to connect to,
and then use the minionswarm.py script in the tests directory to spin up
as many minions as you want. Remember, this is a fork bomb, don\(aqt spin up more
than your hardware can handle!
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
python minionswarm.py \-m 20 \-\-master salt\-master
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Shell Tests
.sp
The new Shell testing system allows us to test the behavior of commands
executed from a high level. This allows for the high level testing of salt
runners and commands like salt\-key.
.SS Client Tests
.sp
Tests have been added to test the aspects of the client APIs and ensure that
the client calls work, and that they manage passed data, in a desirable way.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Legacy salt\-cloud release docs\fP
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Legacy salt\-api release docs\fP
.UNINDENT
.UNINDENT
.SH VENAFI TOOLS FOR SALT
.SS Introduction
.sp
First, you need to configure the \fBmaster\fP file. This is because
all module functions require either a configured \fBapi_key\fP (for Cloud) or
\fBa ttp_user\fP with a \fBtpp_password\fP and a \fBbase_url\fP (for Trust Platform).
.sp
For Venafi Cloud:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
venafi:
  api_key: abcdef01\-2345\-6789\-abcd\-ef0123456789
  base_url: \(dqhttps://cloud.venafi.example.com/\(dq    (optional)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you don\(aqt have a Venafi Cloud account, you can sign up for one on the \fI\%enrollment page\fP\&.
.sp
For Venafi Platform:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
venafi:
  base_url: \(dqhttps://tpp.example.com/\(dq
  tpp_user: admin
  tpp_password: \(dqStr0ngPa$$w0rd\(dq
  trust_bundle: \(dq/opt/venafi/bundle.pem\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fIIt is not common for the Venafi Platform\(aqs REST API (WebSDK) to be secured using a certificate issued by a publicly trusted CA, therefore establishing trust for that server certificate is a critical part of your configuration. Ideally this is done by obtaining the root CA certificate in the issuing chain in PEM format and copying that file to your Salt Master (e.g. /opt/venafi/bundle.pem). You then reference that file using the \(aqtrust_bundle\(aq parameter as shown above.\fP
.sp
For the Venafi module to create keys and certificates it is necessary to enable external pillars. This is done by adding the following to the \fB/etc/salt/master\fP file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ext_pillar:
  \- venafi: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Runner Functions
.SS request
.sp
This command is used to enroll a certificate from Venafi Cloud or Venafi Platform.
.INDENT 0.0
.TP
.B \fBminion_id\fP
ID of the minion for which the certificate is being issued. Required.
.TP
.B \fBdns_name\fP
DNS subject name for the certificate. Required if \fBcsr_path\fP is not specified.
.TP
.B \fBcsr_path\fP
Full path name of certificate signing request file to enroll. Required if \fBdns_name\fP is not specified.
.TP
.B \fBzone\fP
Venafi Cloud zone ID or Venafi Platform folder that specify key and certificate policy. Defaults to \(dqDefault\(dq. For Venafi Cloud, the Zone ID can be found in the Zone page for your Venafi Cloud project.
.TP
.B \fBorg_unit\fP
Business Unit, Department, etc. Do not specify if it does not apply.
.TP
.B \fBorg\fP
Exact legal name of your organization. Do not abbreviate.
.TP
.B \fBloc\fP
City/locality where your organization is legally located.
.TP
.B \fBstate\fP
State or province where your organization is legally located. Must not be abbreviated.
.TP
.B \fBcountry\fP
Country where your organization is legally located; two\-letter ISO code.
.TP
.B \fBkey_password\fP
Password for encrypting the private key.
.UNINDENT
.sp
The syntax for requesting a new certificate with private key generation looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run venafi.request minion.example.com dns_name=www.example.com \e
country=US state=California loc=Sacramento org=\(dqCompany Name\(dq org_unit=DevOps \e
zone=Internet key_password=SecretSauce
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
And the syntax for requesting a new certificate using a previously generated CSR looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run venafi.request minion.example.com csr_path=/tmp/minion.req zone=Internet
.ft P
.fi
.UNINDENT
.UNINDENT
.SS show_cert
.sp
This command is used to show last issued certificate for domain.
.INDENT 0.0
.TP
.B \fBdns_name\fP
DNS subject name of the certificate to look up.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run venafi.show_cert www.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.SS list_domain_cache
.sp
This command lists domains that have been cached on this Salt Master.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run venafi.list_domain_cache
.ft P
.fi
.UNINDENT
.UNINDENT
.SS del_cached_domain
.sp
This command deletes a domain from the Salt Master\(aqs cache.
.INDENT 0.0
.TP
.B \fBdomains\fP
A domain name, or a comma\-separated list of domain names, to delete from this master\(aqs cache.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-run venafi.del_cached_domain www.example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Transfer certificate to a minion
.sp
To transfer a cached certificate to a minion, you can use Venafi pillar.
.sp
Example state (SLS) file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
/etc/ssl/cert/www.example.com.crt:
  file.managed:
      \- contents_pillar: venafi:www.example.com:cert
      \- replace: True

/etc/ssl/cert/www.example.com.key:
  file.managed:
      \- contents_pillar: venafi:www.example.com:pkey
      \- replace: True

/etc/ssl/cert/www.example.com\-chain.pem:
  file.managed:
      \- contents_pillar: venafi:www.example.com:chain
      \- replace: True
.ft P
.fi
.UNINDENT
.UNINDENT
.SH GLOSSARY
.INDENT 0.0
.TP
.B Auto\-Order
The evaluation of states in the order that they are defined in a SLS
file. \fISee also\fP: \fI\%ordering\fP\&.
.TP
.B Bootstrap
A stand\-alone Salt project which can download and install a Salt master
and/or a Salt minion onto a host. \fISee also\fP: \fI\%salt\-bootstrap\fP\&.
.TP
.B Compound Matcher
A combination of many target definitions that can be combined with
boolean operators. \fISee also\fP: \fI\%targeting\fP\&.
.TP
.B EAuth
Shorthand for \(aqexternal authentication\(aq. A system for calling to a
system outside of Salt in order to authenticate users and determine if
they are allowed to issue particular commands to Salt. \fISee also\fP:
\fI\%external auth\fP\&.
.TP
.B Environment
A directory tree containing state files which can be applied to
minions. \fISee also\fP: \fI\%top file\fP\&.
.TP
.B Execution Function
A Python function inside an Execution Module that may take arguments
and performs specific system\-management tasks. \fISee also\fP: \fI\%the
list of execution modules\fP\&.
.TP
.B External Job Cache
An external data\-store that can archive information about jobs that
have been run. A default returner. \fISee also\fP:
\fI\%ext_job_cache\fP, \fI\%the list of returners\fP\&.
.TP
.B Execution Module
A Python module that contains execution functions which directly
perform various system\-management tasks on a server. Salt ships with a
number of execution modules but users can also write their own
execution modules to perform specialized tasks. \fISee also\fP: \fI\%the
list of execution modules\fP\&.
.TP
.B External Pillar
A module that accepts arbitrary arguments and returns a dictionary.
The dictionary is automatically added to a pillar for a minion.
.TP
.B Event
A notice emitted onto an event bus. Events are often driven by requests
for actions to occur on a minion or master and the results of those
actions. \fISee also\fP: \fI\%Salt Reactor\fP\&.
.TP
.B File Server
A local or remote location for storing both Salt\-specific files such as
top files or SLS files as well as files that can be distributed to
minions, such as system configuration files. \fISee also\fP: \fI\%Salt\(aqs
file server\fP\&.
.TP
.B Grain
A key\-value pair which contains a fact about a system, such as its
hostname, network addresses. \fISee also\fP: \fI\%targeting with grains\fP\&.
.TP
.B Highdata
The data structure in a SLS file the represents a set of state
declarations. \fISee also\fP: \fI\%state layers\fP\&.
.TP
.B Highstate
The collection of states to be applied to a system. \fISee also\fP:
\fI\%state layers\fP\&.
.TP
.B Idempotent
An action that ensures the system is in a well\-known state regardless
of the system\(aqs state before the action is applied.  A corollary to
this is that applying the action multiple times results in no changes
to the system.  State module functions should be idempotent.  Some
state module functions, such as \fI\%cmd.run\fP
are not idempotent by default but can be made idempotent with the
proper use of requisites such as \fI\%unless\fP
and \fI\%onlyif\fP\&. For more information, \fIsee\fP
\fI\%wikipedia\fP\&.
.TP
.B Jinja
A templating language which allows variables and simple logic to be
dynamically inserted into static text files when they are rendered.
\fISee also\fP: \fI\%Salt\(aqs Jinja documentation\fP\&.
.TP
.B Job
The complete set of tasks to be performed by the execution of a Salt
command are a single job. \fISee also\fP: \fI\%jobs runner\fP\&.
.TP
.B Job Cache
A storage location for job results, which may then be queried by a
salt runner or an external system. May be local to a salt master
or stored externally.
.TP
.B Job ID
A unique identifier to represent a given \fI\%job\fP\&.  This is often
shortened to JID.
.TP
.B Low State
The collection of processed states after requisites and order are
evaluated. \fISee also\fP: \fI\%state layers\fP\&.
.TP
.B Master
A central Salt daemon from which commands can be issued to listening
minions.
.TP
.B Masterless
A minion which does not require a Salt master to operate. All
configuration is local. \fISee also\fP: \fI\%file_client\fP\&.
.TP
.B Master Tops
A system for the master that allows hooks into external systems to
generate top file data.
.TP
.B Mine
A facility to collect arbitrary data from minions and store that data
on the master. This data is then available to all other minions.
(Sometimes referred to as Salt Mine.) \fISee also\fP: \fI\%Salt Mine\fP\&.
.TP
.B Minion
A server running a Salt minion daemon which can listen to commands from
a master and perform the requested tasks. Generally, minions are
servers which are to be controlled using Salt.
.TP
.B Minion ID
A globally unique identifier for a minion. \fISee also\fP:
\fI\%id\fP\&.
.TP
.B Multi\-Master
The ability for a minion to be actively connected to multiple Salt
masters at the same time in high\-availability environments.
.TP
.B Node Group
A pre\-defined group of minions declared in the master configuration
file. \fISee also\fP: \fI\%targeting\fP\&.
.TP
.B Outputter
A formatter for defining the characteristics of output data from a Salt
command. \fISee also\fP: \fI\%list of outputters\fP\&.
.TP
.B Peer Communication
The ability for minions to communicate directly with other minions
instead of brokering commands through the Salt master. \fISee also\fP:
\fI\%peer communication\fP\&.
.TP
.B Pillar
A simple key\-value store for user\-defined data to be made available to
a minion. Often used to store and distribute sensitive data to minions.
\fISee also\fP: \fI\%Pillar\fP, \fI\%list of Pillar
modules\fP\&.
.TP
.B Proxy Minion
A minion which can control devices that are unable to run a Salt minion
locally, such as routers and switches.
.TP
.B PyDSL
A Pythonic domain\-specific\-language used as a Salt renderer. PyDSL can
be used in cases where adding pure Python into SLS files is beneficial.
\fISee also\fP: \fI\%PyDSL\fP\&.
.TP
.B Reactor
An interface for listening to events and defining actions that Salt
should taken upon receipt of given events. \fISee also\fP: \fI\%Reactor\fP\&.
.TP
.B Render Pipe
Allows SLS files to be rendered by multiple renderers, with each
renderer receiving the output of the previous. \fISee also\fP:
\fI\%composing renderers\fP\&.
.TP
.B Renderer
Responsible for translating a given data serialization format such as
YAML or JSON into a Python data structure that can be consumed by Salt.
\fISee also\fP: \fI\%list of renderers\fP\&.
.TP
.B Returner
Allows for the results of a Salt command to be sent to a given
data\-store such as a database or log file for archival. \fISee also\fP:
\fI\%list of returners\fP\&.
.TP
.B Roster
A flat\-file list of target hosts. (Currently only used by salt\-ssh.)
.TP
.B Runner Module
A module containing a set of runner functions. \fISee also\fP: \fI\%list
of runner modules\fP\&.
.TP
.B Runner Function
A function which is called by the \fBsalt\-run\fP command and
executes on the master instead of on a minion. \fISee also\fP:
\fI\%Runner Module\fP\&.
.TP
.B Salt Cloud
A suite of tools used to create and deploy systems on many hosted cloud
providers. \fISee also\fP: \fI\%salt\-cloud\fP\&.
.TP
.B Salt SSH
A configuration management and remote orchestration system that does
not require that any software besides SSH be installed on systems to be
controlled.
.TP
.B Salt Thin
A subset of the normal Salt distribution that does not include any
transport routines. A Salt Thin bundle can be dropped onto a host and
used directly without any requirement that the host be connected to a
network. Used by Salt SSH. \fISee also\fP: \fI\%thin runner\fP\&.
.TP
.B Salt Virt
Used to manage the creation and deployment of virtual machines onto a
set of host machines. Often used to create and deploy private clouds.
\fISee also\fP: \fI\%virt runner\fP\&.
.TP
.B SLS Module
Contains a set of \fI\%state declarations\fP\&.
.TP
.B State Compiler
Translates \fI\%highdata\fP into lowdata.
.TP
.B State Declaration
A data structure which contains a unique ID and describes one or more
states of a system such as ensuring that a package is installed or a
user is defined. \fISee also\fP: \fI\%highstate structure\fP\&.
.TP
.B State Function
A function contained inside a \fI\%state module\fP which
can manages the application of a particular state to a system. State
functions frequently call out to one or more \fI\%execution modules\fP to perform a given task.
.TP
.B State Module
A module which contains a set of state functions. \fISee also\fP:
\fI\%list of state modules\fP\&.
.TP
.B State Run
The application of a set of states on a set of systems.
.TP
.B Syndic
A forwarder which can relay messages between tiered masters. \fBSee
also\fP: \fI\%Syndic\fP\&.
.TP
.B Target
Minion(s) to which a given salt command will apply. \fISee also\fP:
\fI\%targeting\fP\&.
.TP
.B Top File
Determines which SLS files should be applied to various systems and
organizes those groups of systems into environments. \fISee also\fP:
\fI\%top file\fP, \fI\%list of master top modules\fP\&.
.TP
.B __virtual__
A function in a module that is called on module load to determine
whether or not the module should be available to a minion. This
function commonly contains logic to determine if all requirements
for a module are available, such as external libraries.
.TP
.B Worker
A master process which can send notices and receive replies from
minions. \fISee also\fP:
\fI\%worker_threads\fP\&.
.UNINDENT
.SH AUTHOR
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2024
.\" Generated by docutils manpage writer.
.